diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs.md index f7b7fec924..21c2ed4af0 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs ## -description Provides data when an app is activated to add an appointment to the user’s calendar. > **JavaScript** > This type appears as [WebUIAppointmentsProviderAddAppointmentActivatedEventArgs](../windows.ui.webui/webuiappointmentsprovideraddappointmentactivatedeventargs.md). ## -remarks This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.AddAppointment](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_addappointment.md) property. ## -examples ## -see-also [IAppointmentsProviderAddAppointmentActivatedEventArgs](iappointmentsprovideraddappointmentactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs + +## -description +Provides data when an app is activated to add an appointment to the user’s calendar. + + + +> **JavaScript** +> This type appears as [WebUIAppointmentsProviderAddAppointmentActivatedEventArgs](../windows.ui.webui/webuiappointmentsprovideraddappointmentactivatedeventargs.md). + +## -remarks +This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.AddAppointment](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_addappointment.md) property. + +## -examples + +## -see-also +[IAppointmentsProviderAddAppointmentActivatedEventArgs](iappointmentsprovideraddappointmentactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md index 9232934e8c..9a86c161a8 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation ## -description Gets the appointment that is provided to the app when the user tries to add it. ## -property-value The appointment that is added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation + +## -description +Gets the appointment that is provided to the app when the user tries to add it. + +## -property-value +The appointment that is added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_kind.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_kind.md index 86304995aa..548ec9bf24 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_previousexecutionstate.md index 9ef15b9401..34d3405f19 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_splashscreen.md index fc62376b67..8d8d9c70b3 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_user.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_user.md index 05c0d004a5..281acd3649 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_verb.md b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_verb.md index d272f6716e..30778ba252 100644 --- a/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/appointmentsprovideraddappointmentactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Verb ## -description Gets the action to be performed by the appointments provider. ## -property-value The action to be performed by the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderAddAppointmentActivatedEventArgs.Verb + +## -description +Gets the action to be performed by the appointments provider. + +## -property-value +The action to be performed by the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md index e4ae59eab1..c364ceae01 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs ## -description Provides data when an app is activated to remove an appointment from the user’s calendar. > **JavaScript** > This type appears as [WebUIAppointmentsProviderRemoveAppointmentActivatedEventArgs](../windows.ui.webui/webuiappointmentsproviderremoveappointmentactivatedeventargs.md). ## -remarks This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.RemoveAppointment](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_removeappointment.md) property. ## -examples ## -see-also [IAppointmentsProviderRemoveAppointmentActivatedEventArgs](iappointmentsproviderremoveappointmentactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs + +## -description +Provides data when an app is activated to remove an appointment from the user’s calendar. + + + +> **JavaScript** +> This type appears as [WebUIAppointmentsProviderRemoveAppointmentActivatedEventArgs](../windows.ui.webui/webuiappointmentsproviderremoveappointmentactivatedeventargs.md). + +## -remarks +This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.RemoveAppointment](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_removeappointment.md) property. + +## -examples + +## -see-also +[IAppointmentsProviderRemoveAppointmentActivatedEventArgs](iappointmentsproviderremoveappointmentactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_kind.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_kind.md index 532f55952f..e7ed6431d6 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_previousexecutionstate.md index d39d279c20..ca37dfefc6 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md index e7b85ec3df..40bae72510 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation ## -description Gets the appointment that is provided to the app when the user tries to remove it. ## -property-value The appointment that is removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation + +## -description +Gets the appointment that is provided to the app when the user tries to remove it. + +## -property-value +The appointment that is removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_splashscreen.md index e51c189b0b..2f36b2f5d6 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_user.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_user.md index 82a7e3b476..0c09dd8963 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_verb.md b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_verb.md index 479755c626..155566d6f0 100644 --- a/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Verb ## -description Gets the action to be performed by the appointments provider. ## -property-value The action to be performed by the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderRemoveAppointmentActivatedEventArgs.Verb + +## -description +Gets the action to be performed by the appointments provider. + +## -property-value +The action to be performed by the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs.md index d86f967931..c7060c5aae 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs ## -description Provides data when an app is activated to replace an appointment in the user’s calendar. > **JavaScript** > This type appears as [WebUIAppointmentsProviderReplaceAppointmentActivatedEventArgs](../windows.ui.webui/webuiappointmentsproviderreplaceappointmentactivatedeventargs.md). ## -remarks This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.ReplaceAppointment](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_replaceappointment.md) property. ## -examples ## -see-also [IAppointmentsProviderReplaceAppointmentActivatedEventArgs](iappointmentsproviderreplaceappointmentactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs + +## -description +Provides data when an app is activated to replace an appointment in the user’s calendar. + + + +> **JavaScript** +> This type appears as [WebUIAppointmentsProviderReplaceAppointmentActivatedEventArgs](../windows.ui.webui/webuiappointmentsproviderreplaceappointmentactivatedeventargs.md). + +## -remarks +This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.ReplaceAppointment](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_replaceappointment.md) property. + +## -examples + +## -see-also +[IAppointmentsProviderReplaceAppointmentActivatedEventArgs](iappointmentsproviderreplaceappointmentactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_kind.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_kind.md index fd5bd2ae85..3636c1c5ef 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_previousexecutionstate.md index 488b34b365..676df84476 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md index d532cf16e0..242e1e4609 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation ## -description Gets the appointment that is provided to the app when the user tries to replace it. ## -property-value The appointment that is replaced. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation + +## -description +Gets the appointment that is provided to the app when the user tries to replace it. + +## -property-value +The appointment that is replaced. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_splashscreen.md index ce43c27e7f..5f7280323a 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_user.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_user.md index b93e3128a4..612eccd3b3 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_verb.md b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_verb.md index 889afd41d3..00618bdee8 100644 --- a/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/appointmentsproviderreplaceappointmentactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Verb ## -description Gets the action to be performed by the appointments provider. ## -property-value The action to be performed by the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderReplaceAppointmentActivatedEventArgs.Verb + +## -description +Gets the action to be performed by the appointments provider. + +## -property-value +The action to be performed by the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs.md index 6a91462e6b..5bedf96cfd 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs ## -description Provides data when an app is activated to show the details of an appointment. ## -remarks This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.ShowAppointmentDetails](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showappointmentdetails.md) property. ## -examples ## -see-also [IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs](iappointmentsprovidershowappointmentdetailsactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs + +## -description +Provides data when an app is activated to show the details of an appointment. + +## -remarks +This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.ShowAppointmentDetails](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showappointmentdetails.md) property. + +## -examples + +## -see-also +[IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs](iappointmentsprovidershowappointmentdetailsactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md index ac03b6b3ce..ad46eed396 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate ## -description Gets the start date of the appointment instance for which the app should display details. ## -property-value The start date of the appointment instance for which the app should display details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate + +## -description +Gets the start date of the appointment instance for which the app should display details. + +## -property-value +The start date of the appointment instance for which the app should display details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_kind.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_kind.md index ef55054441..2537b366a4 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md index 5c730d1acc..40befbef58 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId ## -description Gets the local identifier of the appointment for which the app should display details. ## -property-value The local identifier of the appointment for which the app should display details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId + +## -description +Gets the local identifier of the appointment for which the app should display details. + +## -property-value +The local identifier of the appointment for which the app should display details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_previousexecutionstate.md index b47caff1a0..43491a3b6c 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value The execution state of the app before it was activated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state of the app before it was activated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md index c7e36d7507..a8fe891eee 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId ## -description Gets the roaming identifier of the appointment for which the app should display details. ## -property-value The roaming identifier of the appointment for which the app should display details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId + +## -description +Gets the roaming identifier of the appointment for which the app should display details. + +## -property-value +The roaming identifier of the appointment for which the app should display details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_splashscreen.md index a8324b82f8..3143377d4f 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_user.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_user.md index 1ff50e3a0c..5dab57c9ba 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_verb.md b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_verb.md index 707f975626..4857571c3f 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowappointmentdetailsactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Verb ## -description Gets the action to be performed by the appointments provider. ## -property-value The action to be performed by the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowAppointmentDetailsActivatedEventArgs.Verb + +## -description +Gets the action to be performed by the appointments provider. + +## -property-value +The action to be performed by the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs.md index 0532ea8c85..453cf3adad 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs ## -description Provides data when an app is activated to show a specified time frame on the user’s calendar. > **JavaScript** > This type appears as [WebUIAppointmentsProviderShowTimeFrameActivatedEventArgs](../windows.ui.webui/webuiappointmentsprovidershowtimeframeactivatedeventargs.md). ## -remarks This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.ShowTimeFrame](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showtimeframe.md) property. ## -examples ## -see-also [IAppointmentsProviderShowTimeFrameActivatedEventArgs](iappointmentsprovidershowtimeframeactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs + +## -description +Provides data when an app is activated to show a specified time frame on the user’s calendar. + + + +> **JavaScript** +> This type appears as [WebUIAppointmentsProviderShowTimeFrameActivatedEventArgs](../windows.ui.webui/webuiappointmentsprovidershowtimeframeactivatedeventargs.md). + +## -remarks +This object is accessed when you override the [OnActivated](../windows.ui.xaml/application_onactivated.md) method, [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **AppointmentsProvider**, and [IAppointmentsProviderActivatedEventArgs.Verb](iappointmentsprovideractivatedeventargs_verb.md) is equal to the value of the [AppointmentsProviderLaunchActionVerbs.ShowTimeFrame](../windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showtimeframe.md) property. + +## -examples + +## -see-also +[IAppointmentsProviderShowTimeFrameActivatedEventArgs](iappointmentsprovidershowtimeframeactivatedeventargs.md), [IAppointmentsProviderActivatedEventArgs](iappointmentsprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_duration.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_duration.md index e26aafa006..d9b1a37773 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_duration.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Duration --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Duration ## -description Gets the duration of the time frame to be shown. ## -property-value The duration of the time frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Duration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Duration + +## -description +Gets the duration of the time frame to be shown. + +## -property-value +The duration of the time frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_kind.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_kind.md index 5f01c6a1c3..ba0048ed5a 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.AppointmentsProvider](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_previousexecutionstate.md index 2e7927de1b..6b5792c7cb 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_splashscreen.md index 2d67dc4344..e0d4e81e7d 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md index 85755a8317..0db61746f9 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow ## -description Gets the starting date and time of the time frame to be shown. ## -property-value The starting date and time of the time frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow + +## -description +Gets the starting date and time of the time frame to be shown. + +## -property-value +The starting date and time of the time frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_user.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_user.md index 56e3b8ec5b..b7500efed1 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_verb.md b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_verb.md index 75e110bcf6..43fad1f853 100644 --- a/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/appointmentsprovidershowtimeframeactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Verb ## -description Gets the action to be performed by the appointments provider. ## -property-value The action to be performed by the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.AppointmentsProviderShowTimeFrameActivatedEventArgs.Verb + +## -description +Gets the action to be performed by the appointments provider. + +## -property-value +The action to be performed by the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/backgroundactivatedeventargs.md b/windows.applicationmodel.activation/backgroundactivatedeventargs.md index 7f421af7cf..f2e1f6256a 100644 --- a/windows.applicationmodel.activation/backgroundactivatedeventargs.md +++ b/windows.applicationmodel.activation/backgroundactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs ## -description Makes all data available from the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method available to your event handler when your app is activated by a background trigger. ## -remarks This object is passed to your background activated event handler. ## -examples ## -see-also [IBackgroundActivatedEventArgs](ibackgroundactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs + +## -description +Makes all data available from the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method available to your event handler when your app is activated by a background trigger. + +## -remarks +This object is passed to your background activated event handler. + +## -examples + +## -see-also +[IBackgroundActivatedEventArgs](ibackgroundactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/backgroundactivatedeventargs_taskinstance.md b/windows.applicationmodel.activation/backgroundactivatedeventargs_taskinstance.md index e07040d580..6e745f135a 100644 --- a/windows.applicationmodel.activation/backgroundactivatedeventargs_taskinstance.md +++ b/windows.applicationmodel.activation/backgroundactivatedeventargs_taskinstance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs.TaskInstance --api-type: winrt property ---- # Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs.TaskInstance ## -description Get the data that was available to the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method that resulted in your app being activated. ## -property-value The [IBackgroundTaskInstance](../windows.applicationmodel.background/ibackgroundtaskinstance.md) that activated your app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs.TaskInstance +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.BackgroundActivatedEventArgs.TaskInstance + +## -description +Get the data that was available to the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method that resulted in your app being activated. + +## -property-value +The [IBackgroundTaskInstance](../windows.applicationmodel.background/ibackgroundtaskinstance.md) that activated your app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_previousexecutionstate.md index f4364beb77..9a8ce5e1bd 100644 --- a/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_user.md b/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_user.md index 87e56014f5..680c5871be 100644 --- a/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_user.md +++ b/windows.applicationmodel.activation/cachedfileupdateractivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CachedFileUpdaterActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_kind.md b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_kind.md index 7d037d66df..301c207734 100644 --- a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_kind.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks If [Kind](camerasettingsactivatedeventargs_kind.md) is **CameraSettings**, the app should open using a flyout. If [Kind](camerasettingsactivatedeventargs_kind.md) is **Launched**, it should open full-screen. > [!NOTE] > Do not declare device capabilities for webcam or location. Those capabilities will cause a prompt for permissions to appear, which will obstruct the UI in your Windows Store app. ## -examples ## -see-also [Windows Store device app for camera sample](http://go.microsoft.com/fwlink/p/?LinkID=249442), [Developing device apps for cameras](http://go.microsoft.com/fwlink/p/?LinkId=226802) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks +If [Kind](camerasettingsactivatedeventargs_kind.md) is **CameraSettings**, the app should open using a flyout. If [Kind](camerasettingsactivatedeventargs_kind.md) is **Launched**, it should open full-screen. + + + +> [!NOTE] +> Do not declare device capabilities for webcam or location. Those capabilities will cause a prompt for permissions to appear, which will obstruct the UI in your Windows Store app. + +## -examples + +## -see-also +[Windows Store device app for camera sample](http://go.microsoft.com/fwlink/p/?LinkID=249442), [Developing device apps for cameras](http://go.microsoft.com/fwlink/p/?LinkId=226802) \ No newline at end of file diff --git a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_previousexecutionstate.md index eb4c5c4090..22efd20c87 100644 --- a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_splashscreen.md index 86d38b4f47..f99079f035 100644 --- a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodevicecontroller.md b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodevicecontroller.md index 76581d5df0..338dfb0461 100644 --- a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodevicecontroller.md +++ b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodevicecontroller.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceController --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceController ## -description Gets the object that controls device settings on the camera. ## -property-value The object that controls device settings on the camera. ## -remarks Do not declare device capabilities for webcam or location. Those capabilities will cause a prompt for permissions to appear, which will obstruct the UI in your Windows Store app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceController +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceController + +## -description +Gets the object that controls device settings on the camera. + +## -property-value +The object that controls device settings on the camera. + +## -remarks +Do not declare device capabilities for webcam or location. Those capabilities will cause a prompt for permissions to appear, which will obstruct the UI in your Windows Store app. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodeviceextension.md b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodeviceextension.md index b8a296d212..21bd2c6684 100644 --- a/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodeviceextension.md +++ b/windows.applicationmodel.activation/camerasettingsactivatedeventargs_videodeviceextension.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceExtension --api-type: winrt property ---- # Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceExtension ## -description Gets the object that implements additional extended settings for the camera. ## -property-value An object implementing extended settings for the camera. ## -remarks Do not declare device capabilities for webcam or location. Those capabilities will cause a prompt for permissions to appear, which will obstruct the UI in your Windows Store app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceExtension +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CameraSettingsActivatedEventArgs.VideoDeviceExtension + +## -description +Gets the object that implements additional extended settings for the camera. + +## -property-value +An object implementing extended settings for the camera. + +## -remarks +Do not declare device capabilities for webcam or location. Those capabilities will cause a prompt for permissions to appear, which will obstruct the UI in your Windows Store app. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs.md b/windows.applicationmodel.activation/contactcallactivatedeventargs.md index 929e282b07..e7fc471a89 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs.md @@ -1,3 +1,125 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs ## -description Provides data when an app is activated to call a contact. > **JavaScript** > This type appears as [WebUIContactCallActivatedEventArgs](../windows.ui.webui/webuicontactcallactivatedeventargs.md). ## -remarks Windows 8.1 allows users to call their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact call activation contract, Windows can launch your app to make calls for the user. To receive call activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "call." You can then specify the "ServiceId" element to specify the type of calling you support. For example, if your app handles standard PSTN calls, you can specify a "ServiceId" of "telephone." If your app handles calling over a web based service, like Skype, you can specify the domain name of that service, for example "skype.com." If multiple apps have registered for this contract, the user can choose one of them as their default for handling calls. > [!NOTE] > To enable a user to set your app as their default calling app for PSTN numbers, your app must also support the “tel” URI scheme. Here is an example for manifest registration: ```xml telephone skype.com ``` After you register in your manifest, your app can be activated for the contact call contract. When your app is activated, you can use the event information to identify the call activation and extract the parameters that help you complete the call for the user. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples Here is an example of the code you need to handle contact call activations for PSTN numbers and Skype Ids: ```csharp protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Contact) { var contactArgs = args as IContactActivatedEventArgs; if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call) { IContactCallActivatedEventArgs callArgs = contactArgs as IContactCallActivatedEventArgs; //get contact display info var contactName = callArgs.Contact.DisplayName; var contactThumbnail = callArgs.Contact.Thumbnail; if (callArgs.ServiceId == "telephone") { var phoneNumber = callArgs.ServiceUserId; //add calling logic for PSTN numbers } else if (callArgs.ServiceId == "skype.com") { var userId = callArgs.ServiceUserId; //add calling logic for Skype Ids } } } } ``` ```cpp void App::OnActivated(IActivatedEventArgs^ args) { if (args->Kind == ActivationKind::Contact) { auto contactArgs = dynamic_cast(args); if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Call) { auto callArgs = dynamic_cast(contactArgs); //get contact display info auto contactName = callArgs->Contact->DisplayName; auto contactThumbnail = callArgs->Contact->Thumbnail; if (callArgs->ServiceId == "telephone") { auto phoneNumber = callArgs->ServiceUserId; //add calling logic for PSTN numbers } else if (callArgs->ServiceId == "skype.com") { auto userId = callArgs->ServiceUserId; //add calling logic for Skype Ids } } } } ``` ## -see-also [IContactCallActivatedEventArgs](icontactcallactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs + +## -description +Provides data when an app is activated to call a contact. + + + +> **JavaScript** +> This type appears as [WebUIContactCallActivatedEventArgs](../windows.ui.webui/webuicontactcallactivatedeventargs.md). + +## -remarks +Windows 8.1 allows users to call their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact call activation contract, Windows can launch your app to make calls for the user. + +To receive call activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "call." You can then specify the "ServiceId" element to specify the type of calling you support. For example, if your app handles standard PSTN calls, you can specify a "ServiceId" of "telephone." If your app handles calling over a web based service, like Skype, you can specify the domain name of that service, for example "skype.com." + +If multiple apps have registered for this contract, the user can choose one of them as their default for handling calls. + + + +> [!NOTE] +> To enable a user to set your app as their default calling app for PSTN numbers, your app must also support the “tel” URI scheme. + + + +Here is an example for manifest registration: + +```xml + + + + + + telephone + skype.com + + + + + +``` + + + +After you register in your manifest, your app can be activated for the contact call contract. When your app is activated, you can use the event information to identify the call activation and extract the parameters that help you complete the call for the user. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples +Here is an example of the code you need to handle contact call activations for PSTN numbers and Skype Ids: + +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ + if (args.Kind == ActivationKind.Contact) + { + var contactArgs = args as IContactActivatedEventArgs; + if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call) + { + IContactCallActivatedEventArgs callArgs = contactArgs as IContactCallActivatedEventArgs; + + //get contact display info + var contactName = callArgs.Contact.DisplayName; + var contactThumbnail = callArgs.Contact.Thumbnail; + + if (callArgs.ServiceId == "telephone") + { + var phoneNumber = callArgs.ServiceUserId; + //add calling logic for PSTN numbers + } + else if (callArgs.ServiceId == "skype.com") + { + var userId = callArgs.ServiceUserId; + //add calling logic for Skype Ids + } + } + + } +} + +``` + +```cpp +void App::OnActivated(IActivatedEventArgs^ args) +{ + if (args->Kind == ActivationKind::Contact) + { + auto contactArgs = dynamic_cast(args); + if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Call) + { + auto callArgs = dynamic_cast(contactArgs); + + //get contact display info +auto contactName = callArgs->Contact->DisplayName; + auto contactThumbnail = callArgs->Contact->Thumbnail; + + + if (callArgs->ServiceId == "telephone") + { + auto phoneNumber = callArgs->ServiceUserId; + //add calling logic for PSTN numbers + } + else if (callArgs->ServiceId == "skype.com") + { + auto userId = callArgs->ServiceUserId; + //add calling logic for Skype Ids + } + } + } +} + +``` + + + +## -see-also +[IContactCallActivatedEventArgs](icontactcallactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_contact.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_contact.md index fa3fd38ac7..e79424026a 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_contact.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Contact ## -description Gets the contact for the call. ## -property-value The contact for the call. ## -remarks Use the [Contact](contactcallactivatedeventargs_contact.md) property to collect additional info about the contact that is being called. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.ServiceName](../windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md) and [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) properties on each service to retrieve alternative services and user ids respectively. Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a call activation: + [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) + [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) + [LastName](../windows.applicationmodel.contacts/contact_lastname.md) + [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) + [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) + [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) + [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) + [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) + [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) + [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) + [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Contact + +## -description +Gets the contact for the call. + +## -property-value +The contact for the call. + +## -remarks +Use the [Contact](contactcallactivatedeventargs_contact.md) property to collect additional info about the contact that is being called. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.ServiceName](../windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md) and [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) properties on each service to retrieve alternative services and user ids respectively. + + +Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a call activation: + ++ [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) ++ [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) ++ [LastName](../windows.applicationmodel.contacts/contact_lastname.md) ++ [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) ++ [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) ++ [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) ++ [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) ++ [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) ++ [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) ++ [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) ++ [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_kind.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_kind.md index 5b1a1e184a..24ace5d63e 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.Contact](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.Contact](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_previousexecutionstate.md index 1e82cd81b1..fc9865b985 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceid.md index 68a85f570e..01f9d42f93 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the call. ## -property-value The identifier of the service used for the call. ## -remarks For PSTN calls, the [ServiceId](contactcallactivatedeventargs_serviceid.md) property is set to "telephone." For web-based services, the [ServiceId](contactcallactivatedeventargs_serviceid.md) property is set to the domain name of the service to be used for calling, for example “skype.com”. Your app will only receive call activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the call. + +## -property-value +The identifier of the service used for the call. + +## -remarks +For PSTN calls, the [ServiceId](contactcallactivatedeventargs_serviceid.md) property is set to "telephone." For web-based services, the [ServiceId](contactcallactivatedeventargs_serviceid.md) property is set to the domain name of the service to be used for calling, for example “skype.com”. Your app will only receive call activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceuserid.md index 89ca29c491..c6c7d2e56d 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_serviceuserid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the call. ## -property-value The user identifier of the service used for the call. ## -remarks For PSTN calls, the [ServiceUserId](contactcallactivatedeventargs_serviceuserid.md) property is set to the PSTN number for the contact. For web-based services, the [ServiceUserId](contactcallactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for that particular service. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the call. + +## -property-value +The user identifier of the service used for the call. + +## -remarks +For PSTN calls, the [ServiceUserId](contactcallactivatedeventargs_serviceuserid.md) property is set to the PSTN number for the contact. For web-based services, the [ServiceUserId](contactcallactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for that particular service. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_splashscreen.md index 5e56dc9d40..9a73441891 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactcallactivatedeventargs_verb.md b/windows.applicationmodel.activation/contactcallactivatedeventargs_verb.md index b16b9652cc..112c66c17f 100644 --- a/windows.applicationmodel.activation/contactcallactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/contactcallactivatedeventargs_verb.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Verb ## -description Gets the action to be performed. ## -property-value The action to be performed. ## -remarks Use the [Verb](contactcallactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For call activations, the [Verb](contactcallactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call](../windows.applicationmodel.contacts/contactlaunchactionverbs_call.md). For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactCallActivatedEventArgs.Verb + +## -description +Gets the action to be performed. + +## -property-value +The action to be performed. + +## -remarks +Use the [Verb](contactcallactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For call activations, the [Verb](contactcallactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call](../windows.applicationmodel.contacts/contactlaunchactionverbs_call.md). + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs.md b/windows.applicationmodel.activation/contactmapactivatedeventargs.md index e97ec516c0..c788f4d240 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs.md @@ -1,3 +1,100 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs ## -description Provides data when an app is activated to map a contact. > **JavaScript** > This type appears as [WebUIContactMapActivatedEventArgs](../windows.ui.webui/webuicontactmapactivatedeventargs.md). ## -remarks Windows 8.1 allows users to map their contacts' locations from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact map activation contract, Windows can launch your app to map locations for the user. To receive map activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "map." If multiple apps have registered for this contract, the user can choose one of them as their default for handling mapping. Here is an example for manifest registration: ```xml ``` After you register in your manifest, your app can be activated for the contact map contract. When your app is activated, you can use the event information to identify the map activation and extract the parameters that help you complete the mapping scenario for the user. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples Here is an example of the code you need to handle contact map activations: ```csharp protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Contact) { var contactArgs = args as IContactActivatedEventArgs; if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map) { IContactMapActivatedEventArgs mapArgs = contactArgs as IContactMapActivatedEventArgs; //get contact display info var contactName = mapArgs.Contact.DisplayName; var contactThumbnail = mapArgs.Contact.Thumbnail; var address = mapArgs.address; //add mapping logic } } } ``` ```cpp void App::OnActivated(IActivatedEventArgs^ args) { if (args->Kind == ActivationKind::Contact) { auto contactArgs = dynamic_cast(args); if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Map) { auto mapArgs = dynamic_cast(contactArgs); //get contact display info auto contactName = mapArgs->Contact->DisplayName; auto contactThumbnail = mapArgs->Contact->Thumbnail; auto address = mapArgs->address; //add mapping logic } } } ``` ## -see-also [IContactMapActivatedEventArgs](icontactmapactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs + +## -description +Provides data when an app is activated to map a contact. + + + +> **JavaScript** +> This type appears as [WebUIContactMapActivatedEventArgs](../windows.ui.webui/webuicontactmapactivatedeventargs.md). + +## -remarks +Windows 8.1 allows users to map their contacts' locations from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact map activation contract, Windows can launch your app to map locations for the user. + +To receive map activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "map." + +If multiple apps have registered for this contract, the user can choose one of them as their default for handling mapping. + + + +Here is an example for manifest registration: + +```xml + + + + + + + + + +``` + + + +After you register in your manifest, your app can be activated for the contact map contract. When your app is activated, you can use the event information to identify the map activation and extract the parameters that help you complete the mapping scenario for the user. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples +Here is an example of the code you need to handle contact map activations: + +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ + if (args.Kind == ActivationKind.Contact) + { + var contactArgs = args as IContactActivatedEventArgs; + if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map) + { + IContactMapActivatedEventArgs mapArgs = contactArgs as IContactMapActivatedEventArgs; + + //get contact display info + var contactName = mapArgs.Contact.DisplayName; + var contactThumbnail = mapArgs.Contact.Thumbnail; + + var address = mapArgs.address; + //add mapping logic + } + + } +} + +``` + +```cpp +void App::OnActivated(IActivatedEventArgs^ args) +{ + if (args->Kind == ActivationKind::Contact) + { + auto contactArgs = dynamic_cast(args); + if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Map) + { + auto mapArgs = dynamic_cast(contactArgs); + + //get contact display info +auto contactName = mapArgs->Contact->DisplayName; + auto contactThumbnail = mapArgs->Contact->Thumbnail; + + auto address = mapArgs->address; + //add mapping logic + } + } +} + +``` + + + +## -see-also +[IContactMapActivatedEventArgs](icontactmapactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs_address.md b/windows.applicationmodel.activation/contactmapactivatedeventargs_address.md index ebce32d564..440e45abe9 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs_address.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs_address.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Address --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Address ## -description Gets the address of a contact for the mapping operation. ## -property-value The address of a contact for the mapping operation. ## -remarks For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Address + +## -description +Gets the address of a contact for the mapping operation. + +## -property-value +The address of a contact for the mapping operation. + +## -remarks +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs_contact.md b/windows.applicationmodel.activation/contactmapactivatedeventargs_contact.md index 9e2af863f9..dd36700fb7 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs_contact.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Contact ## -description Gets the contact for the mapping operation. ## -property-value The contact for the mapping operation. ## -remarks Use the [Contact](contactmapactivatedeventargs_contact.md) property to collect additional info about the contact that is being mapped. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative addresses that can be used. Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a map activation: + [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) + [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) + [LastName](../windows.applicationmodel.contacts/contact_lastname.md) + [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) + [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) + [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) + [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) + [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) + [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) + [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) + [Addresses](../windows.applicationmodel.contacts/contact_addresses.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Contact + +## -description +Gets the contact for the mapping operation. + +## -property-value +The contact for the mapping operation. + +## -remarks +Use the [Contact](contactmapactivatedeventargs_contact.md) property to collect additional info about the contact that is being mapped. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative addresses that can be used. + + +Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a map activation: + ++ [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) ++ [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) ++ [LastName](../windows.applicationmodel.contacts/contact_lastname.md) ++ [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) ++ [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) ++ [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) ++ [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) ++ [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) ++ [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) ++ [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) ++ [Addresses](../windows.applicationmodel.contacts/contact_addresses.md) + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs_kind.md b/windows.applicationmodel.activation/contactmapactivatedeventargs_kind.md index 705a8aca9e..ae1c7ad343 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.Contact](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.Contact](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactmapactivatedeventargs_previousexecutionstate.md index 14e89a22d0..b59c53bf03 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactmapactivatedeventargs_splashscreen.md index 53a949a373..bb863ff06a 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmapactivatedeventargs_verb.md b/windows.applicationmodel.activation/contactmapactivatedeventargs_verb.md index 7908df6dd6..fe76a8cbcb 100644 --- a/windows.applicationmodel.activation/contactmapactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/contactmapactivatedeventargs_verb.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Verb ## -description Gets the action to be performed. ## -property-value The action to be performed. ## -remarks Use the [Verb](contactmapactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For map activations, the [Verb](contactmapactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map](../windows.applicationmodel.contacts/contactlaunchactionverbs_map.md). For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMapActivatedEventArgs.Verb + +## -description +Gets the action to be performed. + +## -property-value +The action to be performed. + +## -remarks +Use the [Verb](contactmapactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For map activations, the [Verb](contactmapactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map](../windows.applicationmodel.contacts/contactlaunchactionverbs_map.md). + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs.md index a0c65158d6..95ff49c213 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs.md @@ -1,3 +1,121 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs ## -description Provides data when an app is activated to send a message to a contact. > **JavaScript** > This type appears as [WebUIContactMessageActivatedEventArgs](../windows.ui.webui/webuicontactmessageactivatedeventargs.md). ## -remarks Windows 8.1 allows users to message their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact message activation contract, Windows can launch your app to send messages for the user. To receive message activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "message." You can then specify the "ServiceId" element to specify the type of messaging you support. For example, if your app handles standard text messages, you can specify a "ServiceId" of "telephone." If your app handles messaging over a web based service, like Skype, you can specify the domain name of that service, for example "skype.com." If multiple apps have registered for this contract, the user can choose one of them as their default for handling messages. Here is an example for manifest registration: ```xml telephone skype.com ``` After you register in your manifest, your app can be activated for the contact message contract. When your app is activated, you can use the event information to identify the message activation and extract the parameters that help you complete the messaging scenario for the user. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples Here is an example of the code you need to handle contact message activations for PSTN numbers and Skype Ids: ```csharp protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Contact) { var contactArgs = args as IContactActivatedEventArgs; if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message) { IContactMessageActivatedEventArgs messageArgs = contactArgs as IContactMessageActivatedEventArgs; //get contact display info var contactName = messageArgs.Contact.DisplayName; var contactThumbnail = messageArgs.Contact.Thumbnail; if (messageArgs.ServiceId == "telephone") { var phoneNumber = messageArgs.ServiceUserId; //add messaging logic for PSTN numbers } else if (messageArgs.ServiceId == "skype.com") { var userId = messageArgs.ServiceUserId; //add messaging logic for Skype Ids } } } } ``` ```cpp void App::OnActivated(IActivatedEventArgs^ args) { if (args->Kind == ActivationKind::Contact) { auto contactArgs = dynamic_cast(args); if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Message) { auto messageArgs = dynamic_cast(contactArgs); //get contact display info auto contactName = messageArgs->Contact->DisplayName; auto contactThumbnail = messageArgs->Contact->Thumbnail; if (messageArgs->ServiceId == "telephone") { auto phoneNumber = messageArgs->ServiceUserId; //add messaging logic for PSTN numbers } else if (messageArgs->ServiceId == "skype.com") { auto userId = messageArgs->ServiceUserId; //add messaging logic for Skype Ids } } } } ``` ## -see-also [IContactMessageActivatedEventArgs](icontactmessageactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs + +## -description +Provides data when an app is activated to send a message to a contact. + + + +> **JavaScript** +> This type appears as [WebUIContactMessageActivatedEventArgs](../windows.ui.webui/webuicontactmessageactivatedeventargs.md). + +## -remarks +Windows 8.1 allows users to message their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact message activation contract, Windows can launch your app to send messages for the user. + +To receive message activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "message." You can then specify the "ServiceId" element to specify the type of messaging you support. For example, if your app handles standard text messages, you can specify a "ServiceId" of "telephone." If your app handles messaging over a web based service, like Skype, you can specify the domain name of that service, for example "skype.com." + +If multiple apps have registered for this contract, the user can choose one of them as their default for handling messages. + + + +Here is an example for manifest registration: + +```xml + + + + + + telephone + + + skype.com + + + + + +``` + + + +After you register in your manifest, your app can be activated for the contact message contract. When your app is activated, you can use the event information to identify the message activation and extract the parameters that help you complete the messaging scenario for the user. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples +Here is an example of the code you need to handle contact message activations for PSTN numbers and Skype Ids: + +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ + if (args.Kind == ActivationKind.Contact) + { + var contactArgs = args as IContactActivatedEventArgs; + if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message) + { + IContactMessageActivatedEventArgs messageArgs = contactArgs as IContactMessageActivatedEventArgs; + + //get contact display info + var contactName = messageArgs.Contact.DisplayName; + var contactThumbnail = messageArgs.Contact.Thumbnail; + + if (messageArgs.ServiceId == "telephone") + { + var phoneNumber = messageArgs.ServiceUserId; + //add messaging logic for PSTN numbers + } + else if (messageArgs.ServiceId == "skype.com") + { + var userId = messageArgs.ServiceUserId; + //add messaging logic for Skype Ids + } + } + + } +} + +``` + +```cpp +void App::OnActivated(IActivatedEventArgs^ args) +{ + if (args->Kind == ActivationKind::Contact) + { + auto contactArgs = dynamic_cast(args); + if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Message) + { + auto messageArgs = dynamic_cast(contactArgs); + + //get contact display info +auto contactName = messageArgs->Contact->DisplayName; + auto contactThumbnail = messageArgs->Contact->Thumbnail; + + if (messageArgs->ServiceId == "telephone") + { + auto phoneNumber = messageArgs->ServiceUserId; + //add messaging logic for PSTN numbers + } + else if (messageArgs->ServiceId == "skype.com") + { + auto userId = messageArgs->ServiceUserId; + //add messaging logic for Skype Ids + } + } + } +} + +``` + + + +## -see-also +[IContactMessageActivatedEventArgs](icontactmessageactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_contact.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_contact.md index 280474441a..87ed5f901b 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_contact.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Contact ## -description Gets the contact for the message. ## -property-value The contact for the message. ## -remarks Use the [Contact](contactmessageactivatedeventargs_contact.md) property to collect additional info about the contact that is being messaged. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.ServiceName](../windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md) and [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) properties on each service to retrieve alternative services and user ids respectively. Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a message activation: + [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) + [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) + [LastName](../windows.applicationmodel.contacts/contact_lastname.md) + [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) + [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) + [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) + [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) + [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) + [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) + [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) + [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Contact + +## -description +Gets the contact for the message. + +## -property-value +The contact for the message. + +## -remarks +Use the [Contact](contactmessageactivatedeventargs_contact.md) property to collect additional info about the contact that is being messaged. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.ServiceName](../windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md) and [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) properties on each service to retrieve alternative services and user ids respectively. + + +Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a message activation: + ++ [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) ++ [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) ++ [LastName](../windows.applicationmodel.contacts/contact_lastname.md) ++ [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) ++ [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) ++ [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) ++ [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) ++ [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) ++ [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) ++ [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) ++ [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_kind.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_kind.md index bca2f2fe36..bc9164951f 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.Contact](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.Contact](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_previousexecutionstate.md index b091e427fe..c02ab1bca3 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceid.md index db9b0de3c2..55e2c56662 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the message. ## -property-value The identifier of the service used for the message. ## -remarks For standard text messages, the [ServiceId](contactmessageactivatedeventargs_serviceid.md) property is set to "telephone." For web service-based messaging, the [ServiceId](contactmessageactivatedeventargs_serviceid.md) property is set to the domain name of the service to be used for messaging, for example “skype.com”. Your app will only receive message activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the message. + +## -property-value +The identifier of the service used for the message. + +## -remarks +For standard text messages, the [ServiceId](contactmessageactivatedeventargs_serviceid.md) property is set to "telephone." For web service-based messaging, the [ServiceId](contactmessageactivatedeventargs_serviceid.md) property is set to the domain name of the service to be used for messaging, for example “skype.com”. Your app will only receive message activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceuserid.md index 32a9cb7656..fdf74785c4 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_serviceuserid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the message. ## -property-value The user identifier of the service used for the message. ## -remarks For standard text messaging, the [ServiceUserId](contactmessageactivatedeventargs_serviceuserid.md) property is set to the mobile number for the contact. For web-based services, the [ServiceUserId](contactmessageactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for that particular service. For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the message. + +## -property-value +The user identifier of the service used for the message. + +## -remarks +For standard text messaging, the [ServiceUserId](contactmessageactivatedeventargs_serviceuserid.md) property is set to the mobile number for the contact. For web-based services, the [ServiceUserId](contactmessageactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for that particular service. + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_splashscreen.md index 94f7935096..b3f6ef5853 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactmessageactivatedeventargs_verb.md b/windows.applicationmodel.activation/contactmessageactivatedeventargs_verb.md index d5c16967e2..54aed6ff90 100644 --- a/windows.applicationmodel.activation/contactmessageactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/contactmessageactivatedeventargs_verb.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Verb ## -description Gets the action to be performed. ## -property-value The action to be performed. ## -remarks Use the [Verb](contactmessageactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For message activations, the [Verb](contactmessageactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message](../windows.applicationmodel.contacts/contactlaunchactionverbs_message.md). For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactMessageActivatedEventArgs.Verb + +## -description +Gets the action to be performed. + +## -property-value +The action to be performed. + +## -remarks +Use the [Verb](contactmessageactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For message activations, the [Verb](contactmessageactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message](../windows.applicationmodel.contacts/contactlaunchactionverbs_message.md). + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactpickeractivatedeventargs_contactpickerui.md b/windows.applicationmodel.activation/contactpickeractivatedeventargs_contactpickerui.md index 49f75cfb96..f70d3b347b 100644 --- a/windows.applicationmodel.activation/contactpickeractivatedeventargs_contactpickerui.md +++ b/windows.applicationmodel.activation/contactpickeractivatedeventargs_contactpickerui.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.ContactPickerUI --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.ContactPickerUI ## -description Gets the letterbox UI of the contact picker that is displayed when the user wants to pick contacts that are provided by the app. ## -property-value Gets the letterbox UI of the contact picker that is displayed when the user wants to pick contacts that are provided by the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.ContactPickerUI +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.ContactPickerUI + +## -description +Gets the letterbox UI of the contact picker that is displayed when the user wants to pick contacts that are provided by the app. + +## -property-value +Gets the letterbox UI of the contact picker that is displayed when the user wants to pick contacts that are provided by the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpickeractivatedeventargs_kind.md b/windows.applicationmodel.activation/contactpickeractivatedeventargs_kind.md index 836566f8f3..8de15d6e7d 100644 --- a/windows.applicationmodel.activation/contactpickeractivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/contactpickeractivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpickeractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactpickeractivatedeventargs_previousexecutionstate.md index 2cb5b1250e..1cc50fb23a 100644 --- a/windows.applicationmodel.activation/contactpickeractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/contactpickeractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpickeractivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactpickeractivatedeventargs_splashscreen.md index 4a7312dd98..cd0bf8c303 100644 --- a/windows.applicationmodel.activation/contactpickeractivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/contactpickeractivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPickerActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs.md b/windows.applicationmodel.activation/contactpostactivatedeventargs.md index 3c2965f82c..be0af322dd 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs.md @@ -1,3 +1,106 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs ## -description Provides data when an app is activated to post a contact. > **JavaScript** > This type appears as [WebUIContactPostActivatedEventArgs](../windows.ui.webui/webuicontactpostactivatedeventargs.md). ## -remarks Windows 8.1 allows users to post to their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact post activation contract, Windows can launch your app to post for the user. To receive post activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "post." You can then specify the "ServiceId" element to specify the domain name of the service that your app can post to, for example "facebook.com." If multiple apps have registered for this contract, the user can choose one of them as their default for handling posting. Here is an example for manifest registration: ```xml facebook.com ``` After you register in your manifest, your app can be activated for the contact post contract. When your app is activated, you can use the event information to identify the post activation and extract the parameters that help you complete the post scenario for the user. ## -examples Here is an example of the code you need to handle contact post activations for Facebook Ids: ```csharp protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Contact) { var contactArgs = args as IContactActivatedEventArgs; if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post) { IContactPostActivatedEventArgs postArgs = contactArgs as IContactPostActivatedEventArgs; //get contact display info var contactName = postArgs.Contact.DisplayName; var contactThumbnail = postArgs.Contact.Thumbnail; if (postArgs.ServiceId == "facebook.com") { var userId = postArgs.ServiceUserId; //add posting logic for Facebook Ids } } } } ``` ```cpp void App::OnActivated(IActivatedEventArgs^ args) { if (args->Kind == ActivationKind::Contact) { auto contactArgs = dynamic_cast(args); if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Post) { auto postArgs = dynamic_cast(contactArgs); //get contact display info auto contactName = postArgs->Contact->DisplayName; auto contactThumbnail = postArgs->Contact->Thumbnail; if (postArgs->ServiceId == "facebook.com") { auto userId = postArgs->ServiceUserId; //add posting logic for Facebook Ids } } } } ``` ## -see-also [IContactPostActivatedEventArgs](icontactpostactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs + +## -description +Provides data when an app is activated to post a contact. + + + +> **JavaScript** +> This type appears as [WebUIContactPostActivatedEventArgs](../windows.ui.webui/webuicontactpostactivatedeventargs.md). + +## -remarks +Windows 8.1 allows users to post to their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact post activation contract, Windows can launch your app to post for the user. + +To receive post activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "post." You can then specify the "ServiceId" element to specify the domain name of the service that your app can post to, for example "facebook.com." + +If multiple apps have registered for this contract, the user can choose one of them as their default for handling posting. + + + +Here is an example for manifest registration: + +```xml + + + + + + facebook.com + + + + + +``` + + + +After you register in your manifest, your app can be activated for the contact post contract. When your app is activated, you can use the event information to identify the post activation and extract the parameters that help you complete the post scenario for the user. + +## -examples +Here is an example of the code you need to handle contact post activations for Facebook Ids: + +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ + if (args.Kind == ActivationKind.Contact) + { + var contactArgs = args as IContactActivatedEventArgs; + if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post) + { + IContactPostActivatedEventArgs postArgs = contactArgs as IContactPostActivatedEventArgs; + + //get contact display info + var contactName = postArgs.Contact.DisplayName; + var contactThumbnail = postArgs.Contact.Thumbnail; + + if (postArgs.ServiceId == "facebook.com") + { + var userId = postArgs.ServiceUserId; + //add posting logic for Facebook Ids + } + } + + } +} + +``` + +```cpp +void App::OnActivated(IActivatedEventArgs^ args) +{ + if (args->Kind == ActivationKind::Contact) + { + auto contactArgs = dynamic_cast(args); + if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Post) + { + auto postArgs = dynamic_cast(contactArgs); + + //get contact display info +auto contactName = postArgs->Contact->DisplayName; + auto contactThumbnail = postArgs->Contact->Thumbnail; + + if (postArgs->ServiceId == "facebook.com") + { + auto userId = postArgs->ServiceUserId; + //add posting logic for Facebook Ids + } + } + } +} + +``` + + + +## -see-also +[IContactPostActivatedEventArgs](icontactpostactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_contact.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_contact.md index 3acd8a50d9..120a57b19a 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_contact.md @@ -1,3 +1,42 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Contact ## -description Gets the contact for the post. ## -property-value The contact for the post. ## -remarks Use the [Contact](contactpostactivatedeventargs_contact.md) property to collect additional info about the contact that is being posted to. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) property on each service to retrieve alternative user ids. > [!NOTE] > For post activations, the [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property is only populated with services that match the primary service that the activation was originally invoked for. Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a post activation: + [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) + [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) + [LastName](../windows.applicationmodel.contacts/contact_lastname.md) + [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) + [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) + [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) + [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) + [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) + [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) + [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) + [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Contact + +## -description +Gets the contact for the post. + +## -property-value +The contact for the post. + +## -remarks +Use the [Contact](contactpostactivatedeventargs_contact.md) property to collect additional info about the contact that is being posted to. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) property on each service to retrieve alternative user ids. + +> [!NOTE] +> For post activations, the [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property is only populated with services that match the primary service that the activation was originally invoked for. + + +Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a post activation: + ++ [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) ++ [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) ++ [LastName](../windows.applicationmodel.contacts/contact_lastname.md) ++ [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) ++ [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) ++ [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) ++ [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) ++ [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) ++ [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) ++ [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) ++ [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_kind.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_kind.md index 60f812c319..1893ffdd00 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.Contact](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.Contact](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_previousexecutionstate.md index 0ec08feb2c..2f26299188 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceid.md index 75eb48dd79..245af00f9b 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the post. ## -property-value The identifier of the service used for the post. ## -remarks Your app will only receive post activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the post. + +## -property-value +The identifier of the service used for the post. + +## -remarks +Your app will only receive post activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceuserid.md index cc32a3589c..e611d9d53f 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_serviceuserid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the post. ## -property-value The user identifier of the service used for the post. ## -remarks The [ServiceUserId](contactpostactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for the service that is being posted to. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the post. + +## -property-value +The user identifier of the service used for the post. + +## -remarks +The [ServiceUserId](contactpostactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for the service that is being posted to. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_splashscreen.md index 4bf74ad253..baa8f94754 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactpostactivatedeventargs_verb.md b/windows.applicationmodel.activation/contactpostactivatedeventargs_verb.md index 0fc6fdb4c6..cffa6ae48f 100644 --- a/windows.applicationmodel.activation/contactpostactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/contactpostactivatedeventargs_verb.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Verb ## -description Gets the action to be performed. ## -property-value The action to be performed. ## -remarks Use the [Verb](contactpostactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For post activations, the [Verb](contactpostactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post](../windows.applicationmodel.contacts/contactlaunchactionverbs_post.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPostActivatedEventArgs.Verb + +## -description +Gets the action to be performed. + +## -property-value +The action to be performed. + +## -remarks +Use the [Verb](contactpostactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For post activations, the [Verb](contactpostactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post](../windows.applicationmodel.contacts/contactlaunchactionverbs_post.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs.md index 57599ea7f3..015a4c6267 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs.md @@ -1,3 +1,106 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs ## -description Provides data when an app is activated to video call a contact. > **JavaScript** > This type appears as [WebUIContactVideoCallActivatedEventArgs](../windows.ui.webui/webuicontactvideocallactivatedeventargs.md). ## -remarks Windows 8.1 allows users to video call their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact video call activation contract, Windows can launch your app to make video calls for the user. To receive video call activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "videoCall." You can then specify the "ServiceId" element to specify the domain name of the service that your app can video call over, for example "skype.com." If multiple apps have registered for this contract, the user can choose one of them as their default for handling video calls. Here is an example for manifest registration: ```xml skype.com ``` After you register in your manifest, your app can be activated for the contact video call contract. When your app is activated, you can use the event information to identify the video call activation and extract the parameters that help you complete the video call for the user. ## -examples Here is an example of the code you need to handle contact video call activations for Skype Ids: ```csharp protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Contact) { var contactArgs = args as IContactActivatedEventArgs; if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall) { IContactVideoCallActivatedEventArgs videoCallArgs = contactArgs as IContactVideoCallActivatedEventArgs; //get contact display info var contactName = videoCallArgs.Contact.DisplayName; var contactThumbnail = videoCallArgs.Contact.Thumbnail; if (videoCallArgs.ServiceId == "skype.com") { var userId = videoCallArgs.ServiceUserId; //add video calling logic for Skype Ids } } } } ``` ```cpp void App::OnActivated(IActivatedEventArgs^ args) { if (args->Kind == ActivationKind::Contact) { auto contactArgs = dynamic_cast(args); if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::VideoCall) { auto videoCallArgs = dynamic_cast(contactArgs); //get contact display info auto contactName = videoCallArgs->Contact->DisplayName; auto contactThumbnail = videoCallArgs->Contact->Thumbnail; if (videoCallArgs->ServiceId == "skype.com") { auto userId = videoCallArgs->ServiceUserId; //add video calling logic for Skype Ids } } } } ``` ## -see-also [IContactVideoCallActivatedEventArgs](icontactvideocallactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs + +## -description +Provides data when an app is activated to video call a contact. + + + +> **JavaScript** +> This type appears as [WebUIContactVideoCallActivatedEventArgs](../windows.ui.webui/webuicontactvideocallactivatedeventargs.md). + +## -remarks +Windows 8.1 allows users to video call their contacts from the [Contact Card](../windows.applicationmodel.contacts/contactmanager_showcontactcard.md) or Windows Search experience. By implementing the contact video call activation contract, Windows can launch your app to make video calls for the user. + +To receive video call activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "videoCall." You can then specify the "ServiceId" element to specify the domain name of the service that your app can video call over, for example "skype.com." + +If multiple apps have registered for this contract, the user can choose one of them as their default for handling video calls. + + + +Here is an example for manifest registration: + +```xml + + + + + + skype.com + + + + + +``` + + + +After you register in your manifest, your app can be activated for the contact video call contract. When your app is activated, you can use the event information to identify the video call activation and extract the parameters that help you complete the video call for the user. + +## -examples +Here is an example of the code you need to handle contact video call activations for Skype Ids: + +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ + if (args.Kind == ActivationKind.Contact) + { + var contactArgs = args as IContactActivatedEventArgs; + if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall) + { + IContactVideoCallActivatedEventArgs videoCallArgs = contactArgs as IContactVideoCallActivatedEventArgs; + + //get contact display info + var contactName = videoCallArgs.Contact.DisplayName; + var contactThumbnail = videoCallArgs.Contact.Thumbnail; + + if (videoCallArgs.ServiceId == "skype.com") + { + var userId = videoCallArgs.ServiceUserId; + //add video calling logic for Skype Ids + } + } + + } +} + +``` + +```cpp +void App::OnActivated(IActivatedEventArgs^ args) +{ + if (args->Kind == ActivationKind::Contact) + { + auto contactArgs = dynamic_cast(args); + if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::VideoCall) + { + auto videoCallArgs = dynamic_cast(contactArgs); + + //get contact display info +auto contactName = videoCallArgs->Contact->DisplayName; + auto contactThumbnail = videoCallArgs->Contact->Thumbnail; + + if (videoCallArgs->ServiceId == "skype.com") + { + auto userId = videoCallArgs->ServiceUserId; + //add video calling logic for Skype Ids + } + } + } +} + +``` + + + +## -see-also +[IContactVideoCallActivatedEventArgs](icontactvideocallactivatedeventargs.md), [IContactActivatedEventArgs](icontactactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_contact.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_contact.md index 9d2ceb9be1..0602896909 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_contact.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Contact ## -description Gets the contact for the video call. ## -property-value The contact for the video call. ## -remarks Use the [Contact](contactvideocallactivatedeventargs_contact.md) property to collect additional info about the contact that is being video called. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.ServiceName](../windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md) and [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) properties on each service to retrieve alternative services and user ids respectively. Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a video call activation: + [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) + [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) + [LastName](../windows.applicationmodel.contacts/contact_lastname.md) + [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) + [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) + [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) + [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) + [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) + [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) + [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) + [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Contact + +## -description +Gets the contact for the video call. + +## -property-value +The contact for the video call. + +## -remarks +Use the [Contact](contactvideocallactivatedeventargs_contact.md) property to collect additional info about the contact that is being video called. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) property contains a list of all services available for the contact. You can use the [ContactConnectedServiceAccount.ServiceName](../windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md) and [ContactConnectedServiceAccount.Id](../windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md) properties on each service to retrieve alternative services and user ids respectively. + + +Here are possible [Contact](../windows.applicationmodel.contacts/contact.md) properties that can be populated during a video call activation: + ++ [DisplayName](../windows.applicationmodel.contacts/contact_displayname.md) ++ [FirstName](../windows.applicationmodel.contacts/contact_firstname.md) ++ [LastName](../windows.applicationmodel.contacts/contact_lastname.md) ++ [MiddleName](../windows.applicationmodel.contacts/contact_middlename.md) ++ [HonorificNamePrefix](../windows.applicationmodel.contacts/contact_honorificnameprefix.md) ++ [HonorificNameSuffix](../windows.applicationmodel.contacts/contact_honorificnamesuffix.md) ++ [YomiDisplayName](../windows.applicationmodel.contacts/contact_yomidisplayname.md) ++ [YomiFamilyName](../windows.applicationmodel.contacts/contact_yomifamilyname.md) ++ [YomiGivenName](../windows.applicationmodel.contacts/contact_yomigivenname.md) ++ [Thumbnail](../windows.applicationmodel.contacts/contact_thumbnail.md) ++ [ConnectedServiceAccounts](../windows.applicationmodel.contacts/contact_connectedserviceaccounts.md) + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_kind.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_kind.md index 443cc1a636..2d8cd19f36 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.Contact](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.Contact](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_previousexecutionstate.md index b0064619e7..a04f7f257e 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceid.md index 97a382a348..06cc717e3e 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the video call. ## -property-value The identifier of the service used for the video call. ## -remarks Your app will only receive video call activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the video call. + +## -property-value +The identifier of the service used for the video call. + +## -remarks +Your app will only receive video call activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceuserid.md index a46cab883a..3671614435 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_serviceuserid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the video call. ## -property-value The user identifier of the service used for the video call. ## -remarks The [ServiceUserId](contactvideocallactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for the service that is being video called over. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the video call. + +## -property-value +The user identifier of the service used for the video call. + +## -remarks +The [ServiceUserId](contactvideocallactivatedeventargs_serviceuserid.md) property is set to the contact’s user id for the service that is being video called over. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_splashscreen.md index 6a97e44c1b..271ca55cdb 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_verb.md b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_verb.md index 7d5b89d6ce..e937d30aba 100644 --- a/windows.applicationmodel.activation/contactvideocallactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/contactvideocallactivatedeventargs_verb.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Verb ## -description Gets the action to be performed. ## -property-value The action to be performed. ## -remarks Use the [Verb](contactvideocallactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For video call activations, the [Verb](contactvideocallactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall](../windows.applicationmodel.contacts/contactlaunchactionverbs_videocall.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactVideoCallActivatedEventArgs.Verb + +## -description +Gets the action to be performed. + +## -property-value +The action to be performed. + +## -remarks +Use the [Verb](contactvideocallactivatedeventargs_verb.md) property to determine the action to perform when your app is activated with [ActivationKind.Contact](activationkind.md). For video call activations, the [Verb](contactvideocallactivatedeventargs_verb.md) property is set to the value of [Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall](../windows.applicationmodel.contacts/contactlaunchactionverbs_videocall.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/deviceactivatedeventargs_currentlyshownapplicationviewid.md index beeab0072f..fbc16e9ce6 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md b/windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md index 35721694d7..31c9c818a3 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.DeviceInformationId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.DeviceInformationId ## -description Gets the device identifier for the device that invoked AutoPlay. ## -property-value The device identifier for the device that invoked AutoPlay. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.DeviceInformationId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.DeviceInformationId + +## -description +Gets the device identifier for the device that invoked AutoPlay. + +## -property-value +The device identifier for the device that invoked AutoPlay. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_kind.md b/windows.applicationmodel.activation/deviceactivatedeventargs_kind.md index 42e13922ee..1ff47b9964 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/deviceactivatedeventargs_previousexecutionstate.md index 0884ab9189..1af38f5f90 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/deviceactivatedeventargs_splashscreen.md index be54a6818e..7645e15129 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_user.md b/windows.applicationmodel.activation/deviceactivatedeventargs_user.md index fb9de08c9c..2b8d2ec110 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_verb.md b/windows.applicationmodel.activation/deviceactivatedeventargs_verb.md index 83eeb46357..02e99e5701 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Verb ## -description Gets the action associated with the activated device. ## -property-value The action associated with the activated device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.Verb + +## -description +Gets the action associated with the activated device. + +## -property-value +The action associated with the activated device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/deviceactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/deviceactivatedeventargs_viewswitcher.md index 98543c62ab..ac3fb57955 100644 --- a/windows.applicationmodel.activation/deviceactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/deviceactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DeviceActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/devicepairingactivatedeventargs.md b/windows.applicationmodel.activation/devicepairingactivatedeventargs.md index 170f057086..d34ab21909 100644 --- a/windows.applicationmodel.activation/devicepairingactivatedeventargs.md +++ b/windows.applicationmodel.activation/devicepairingactivatedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs ## -description Provides information when an app is activated as a result of a device pairing. ## -remarks ## -examples ## -see-also [IDevicePairingActivatedEventArgs](idevicepairingactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs + +## -description +Provides information when an app is activated as a result of a device pairing. + +## -remarks + +## -examples + +## -see-also +[IDevicePairingActivatedEventArgs](idevicepairingactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/devicepairingactivatedeventargs_deviceinformation.md b/windows.applicationmodel.activation/devicepairingactivatedeventargs_deviceinformation.md index bdaefeafc3..6286d26c77 100644 --- a/windows.applicationmodel.activation/devicepairingactivatedeventargs_deviceinformation.md +++ b/windows.applicationmodel.activation/devicepairingactivatedeventargs_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.DeviceInformation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.DeviceInformation ## -description Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the device object that is being paired. ## -property-value The information of the device object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.DeviceInformation + +## -description +Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the device object that is being paired. + +## -property-value +The information of the device object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/devicepairingactivatedeventargs_kind.md b/windows.applicationmodel.activation/devicepairingactivatedeventargs_kind.md index 681128e216..7330b70443 100644 --- a/windows.applicationmodel.activation/devicepairingactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/devicepairingactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/devicepairingactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/devicepairingactivatedeventargs_previousexecutionstate.md index 613a992dee..ee53f819bf 100644 --- a/windows.applicationmodel.activation/devicepairingactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/devicepairingactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/devicepairingactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/devicepairingactivatedeventargs_splashscreen.md index 18d8a7f132..0945f668c1 100644 --- a/windows.applicationmodel.activation/devicepairingactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/devicepairingactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs.md index 1fb6e4d77f..0ede2ebda1 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs ## -description Provides data when an app is activated from another app by using the DIAL protocol. ## -remarks This class is instantiated by the operating system and passed as an argument to an event. ## -examples ## -see-also [IDialReceiverActivatedEventArgs](idialreceiveractivatedeventargs.md), [ILaunchActivatedEventArgs](ilaunchactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [IApplicationViewActivatedEventArgs](iapplicationviewactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs + +## -description +Provides data when an app is activated from another app by using the DIAL protocol. + +## -remarks +This class is instantiated by the operating system and passed as an argument to an event. + +## -examples + +## -see-also +[IDialReceiverActivatedEventArgs](idialreceiveractivatedeventargs.md), [ILaunchActivatedEventArgs](ilaunchactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md), [IApplicationViewActivatedEventArgs](iapplicationviewactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_appname.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_appname.md index 52f55c9997..99387c9ad2 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_appname.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_appname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.AppName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.AppName ## -description Gets the name of the app that invoked the dial receiver app. ## -property-value The name of the app that invoked the dial receiver app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.AppName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.AppName + +## -description +Gets the name of the app that invoked the dial receiver app. + +## -property-value +The name of the app that invoked the dial receiver app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_arguments.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_arguments.md index 75cf7acacf..5a3369b70a 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_arguments.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_arguments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Arguments --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Arguments ## -description Gets the arguments passed by the calling app. ## -property-value The arguments passed by the calling app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Arguments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Arguments + +## -description +Gets the arguments passed by the calling app. + +## -property-value +The arguments passed by the calling app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_currentlyshownapplicationviewid.md index eda4b001a4..a5a0ad9f00 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_kind.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_kind.md index 174fc839d6..97f1967332 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.DialReceiver](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.DialReceiver](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_previousexecutionstate.md index c50e5b1695..d9dbd43890 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value The execution state of the app before it was activated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state of the app before it was activated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_splashscreen.md index 867c0606a2..59c47c6ded 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_tileid.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_tileid.md index 83bdd9c623..8572da45db 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_tileid.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_tileid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.TileId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.TileId ## -description Gets the unique tile identifier for the calling app. ## -property-value The unique tile identifier for the calling app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.TileId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.TileId + +## -description +Gets the unique tile identifier for the calling app. + +## -property-value +The unique tile identifier for the calling app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_viewswitcher.md index d6db1c13ff..c67ed12db8 100644 --- a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_callerpackagefamilyname.md b/windows.applicationmodel.activation/fileactivatedeventargs_callerpackagefamilyname.md index 720391ac12..7a9617b87e 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.CallerPackageFamilyName ## -description The package family name of the app that launched your app. ## -property-value The caller's package family name. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.CallerPackageFamilyName + +## -description +The package family name of the app that launched your app. + +## -property-value +The caller's package family name. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/fileactivatedeventargs_currentlyshownapplicationviewid.md index f9488ebec0..afa50ce5c2 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_files.md b/windows.applicationmodel.activation/fileactivatedeventargs_files.md index 9c3937d2e7..1a9cf6d583 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_files.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_files.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.Files --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.Files ## -description Gets the files for which the app was activated. ## -property-value The [StorageFile](../windows.storage/storagefile.md) objects representing the files being passed to the app. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.Files +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.Files + +## -description +Gets the files for which the app was activated. + +## -property-value +The [StorageFile](../windows.storage/storagefile.md) objects representing the files being passed to the app. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_kind.md b/windows.applicationmodel.activation/fileactivatedeventargs_kind.md index 640ba92eaf..c324915205 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_neighboringfilesquery.md b/windows.applicationmodel.activation/fileactivatedeventargs_neighboringfilesquery.md index 9ac87f27a8..94b5779d59 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_neighboringfilesquery.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_neighboringfilesquery.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.NeighboringFilesQuery --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.NeighboringFilesQuery ## -description Gets the neighboring files of the files for which the app was activated. ## -property-value The [StorageFile](../windows.storage/storagefile.md) objects that represent the neighboring files of the files being passed to the app. ## -remarks Apps that activate to handle file associations get an object that represents the invoked file only. This can be a problem for media gallery apps in which users expect to navigate to neighboring files. Use the [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md) property to get the collection of the files in the surrounding *view*, which is the collection that the invoked file was selected from. Your apps need to declare a library capability to get items of the corresponding type. To get pictures in the [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md), you need the Pictures library capability, and to get music files, you need the Music library capability. The [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md) property is available only when a single file is invoked. If the size of the [Files](fileactivatedeventargs_files.md) collection is more than 1, the value of [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md) is **null**. Also, the query is not always available for all invocations, so you can use it only if present. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.NeighboringFilesQuery +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.NeighboringFilesQuery + +## -description +Gets the neighboring files of the files for which the app was activated. + +## -property-value +The [StorageFile](../windows.storage/storagefile.md) objects that represent the neighboring files of the files being passed to the app. + +## -remarks +Apps that activate to handle file associations get an object that represents the invoked file only. This can be a problem for media gallery apps in which users expect to navigate to neighboring files. Use the [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md) property to get the collection of the files in the surrounding *view*, which is the collection that the invoked file was selected from. + +Your apps need to declare a library capability to get items of the corresponding type. To get pictures in the [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md), you need the Pictures library capability, and to get music files, you need the Music library capability. + +The [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md) property is available only when a single file is invoked. If the size of the [Files](fileactivatedeventargs_files.md) collection is more than 1, the value of [NeighboringFilesQuery](fileactivatedeventargs_neighboringfilesquery.md) is **null**. Also, the query is not always available for all invocations, so you can use it only if present. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/fileactivatedeventargs_previousexecutionstate.md index e0212cc272..d86195c624 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/fileactivatedeventargs_splashscreen.md index 8ccf8946ca..ffb49a86eb 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_splashscreen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_user.md b/windows.applicationmodel.activation/fileactivatedeventargs_user.md index 8c195b1453..672b1af2c0 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_verb.md b/windows.applicationmodel.activation/fileactivatedeventargs_verb.md index 7ecaa21ada..9459995d75 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_verb.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.Verb ## -description Gets the action associated with the activated file. ## -property-value The action. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.Verb + +## -description +Gets the action associated with the activated file. + +## -property-value +The action. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Windows.Storage](../windows.storage/windows_storage.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/fileactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/fileactivatedeventargs_viewswitcher.md index 79b7c08f58..8935af8d1b 100644 --- a/windows.applicationmodel.activation/fileactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/fileactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileActivatedEventArgs.ViewSwitcher ## -description Provides the object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileActivatedEventArgs.ViewSwitcher + +## -description +Provides the object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_callerpackagefamilyname.md b/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_callerpackagefamilyname.md index a6405f9db9..cd4915d1c8 100644 --- a/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.CallerPackageFamilyName ## -description The package family name of the app that launched your app. ## -property-value The caller's package family name. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.CallerPackageFamilyName + +## -description +The package family name of the app that launched your app. + +## -property-value +The caller's package family name. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_previousexecutionstate.md index a1263122ef..6c78495dfb 100644 --- a/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_user.md b/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_user.md index eecb448bd1..e96ecb0042 100644 --- a/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_user.md +++ b/windows.applicationmodel.activation/fileopenpickeractivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs.md index 6236f29fc3..106dfbaed4 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs ## -description Provides information about an activated event that fires after the app was suspended for a file open picker operation. ## -remarks You access a [FileOpenPickerContinuationEventArgs](fileopenpickercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **PickFileContinuation**. For an example that uses the [FileOpenPickerContinuationEventArgs](fileopenpickercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). ## -examples ## -see-also [IFileOpenPickerContinuationEventArgs](ifileopenpickercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs + +## -description +Provides information about an activated event that fires after the app was suspended for a file open picker operation. + +## -remarks +You access a [FileOpenPickerContinuationEventArgs](fileopenpickercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **PickFileContinuation**. + +For an example that uses the [FileOpenPickerContinuationEventArgs](fileopenpickercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). + +## -examples + +## -see-also +[IFileOpenPickerContinuationEventArgs](ifileopenpickercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_continuationdata.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_continuationdata.md index 7d8cb2b0b8..c01fb720b7 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_continuationdata.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_continuationdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.ContinuationData --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.ContinuationData ## -description Gets a set of values populated by the app before a [FileOpenPicker](../windows.storage.pickers/fileopenpicker.md) operation that deactivates the app in order to provide context when the app is activated. ## -property-value A set of values populated by the app before a [FileOpenPicker](../windows.storage.pickers/fileopenpicker.md) operation that deactivates the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.ContinuationData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.ContinuationData + +## -description +Gets a set of values populated by the app before a [FileOpenPicker](../windows.storage.pickers/fileopenpicker.md) operation that deactivates the app in order to provide context when the app is activated. + +## -property-value +A set of values populated by the app before a [FileOpenPicker](../windows.storage.pickers/fileopenpicker.md) operation that deactivates the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_files.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_files.md index f02ecac7ff..e60da3d839 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_files.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_files.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Files --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Files ## -description Gets the list of files selected by the user during the file open picker operation. ## -property-value The list of files selected by the user during the file open picker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Files +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Files + +## -description +Gets the list of files selected by the user during the file open picker operation. + +## -property-value +The list of files selected by the user during the file open picker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_kind.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_kind.md index a20de2ea8d..29500bae16 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_kind.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.ContinueFileOpenPicker](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.ContinueFileOpenPicker](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_previousexecutionstate.md index 8e99da4557..f69a539dd1 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_splashscreen.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_splashscreen.md index 5c86383ae9..99cfc74150 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.SplashScreen ## -description Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.SplashScreen + +## -description +Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_user.md b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_user.md index d669f40a20..3f990f2284 100644 --- a/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_user.md +++ b/windows.applicationmodel.activation/fileopenpickercontinuationeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileOpenPickerContinuationEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_callerpackagefamilyname.md b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_callerpackagefamilyname.md index f689182096..0da05e5a3d 100644 --- a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.CallerPackageFamilyName ## -description The package family name of the app that launched this app. ## -property-value The caller's package family name. ## -remarks *CallerPackageFamilyName* will be empty if the caller is a non-packaged app (such as a Win32 app). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.CallerPackageFamilyName + +## -description +The package family name of the app that launched this app. + +## -property-value +The caller's package family name. + +## -remarks +*CallerPackageFamilyName* will be empty if the caller is a non-packaged app (such as a Win32 app). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_enterpriseid.md b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_enterpriseid.md index c8d2958fdc..1a255a96c4 100644 --- a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_enterpriseid.md +++ b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_enterpriseid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.EnterpriseId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.EnterpriseId ## -description Gets the ID of the enterprise that owns the file. ## -property-value The ID of the enterprise to owns the file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.EnterpriseId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.EnterpriseId + +## -description +Gets the ID of the enterprise that owns the file. + +## -property-value +The ID of the enterprise to owns the file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_kind.md b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_kind.md index 7e800b84bb..3fb4ef2d6a 100644 --- a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.FileSavePicker](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind enumeration](activationkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.FileSavePicker](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind enumeration](activationkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_previousexecutionstate.md index 1223a314a2..5b67e452fc 100644 --- a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_user.md b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_user.md index d1ef439906..f14befd3de 100644 --- a/windows.applicationmodel.activation/filesavepickeractivatedeventargs_user.md +++ b/windows.applicationmodel.activation/filesavepickeractivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs.md index dc9d8eb865..2083f958b8 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs ## -description Provides information about an activated event that fires after the app was suspended for a file save picker operation. ## -remarks You access a [FileSavePickerContinuationEventArgs](filesavepickercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **PickSaveFileContinuation**. For an example that uses the [FileSavePickerContinuationEventArgs](filesavepickercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). ## -examples ## -see-also [IFileSavePickerContinuationEventArgs](ifilesavepickercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs + +## -description +Provides information about an activated event that fires after the app was suspended for a file save picker operation. + +## -remarks +You access a [FileSavePickerContinuationEventArgs](filesavepickercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **PickSaveFileContinuation**. + +For an example that uses the [FileSavePickerContinuationEventArgs](filesavepickercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). + +## -examples + +## -see-also +[IFileSavePickerContinuationEventArgs](ifilesavepickercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_continuationdata.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_continuationdata.md index 84e949cb54..d85b9f7e3c 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_continuationdata.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_continuationdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.ContinuationData --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.ContinuationData ## -description Gets a set of values populated by the app before a [FileSavePicker](../windows.storage.pickers/filesavepicker.md) operation that deactivates the app in order to provide context when the app is activated. ## -property-value A set of values populated by the app before a [FileSavePicker](../windows.storage.pickers/filesavepicker.md) operation that deactivates the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.ContinuationData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.ContinuationData + +## -description +Gets a set of values populated by the app before a [FileSavePicker](../windows.storage.pickers/filesavepicker.md) operation that deactivates the app in order to provide context when the app is activated. + +## -property-value +A set of values populated by the app before a [FileSavePicker](../windows.storage.pickers/filesavepicker.md) operation that deactivates the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_file.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_file.md index b0b6493177..6e1790dddc 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_file.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_file.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.File --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.File ## -description Gets the file selected by the user during the file save picker operation. ## -property-value The file selected by the user during the file save picker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.File +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.File + +## -description +Gets the file selected by the user during the file save picker operation. + +## -property-value +The file selected by the user during the file save picker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_kind.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_kind.md index ef20c04b81..4eec162bd6 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_kind.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.ContinueFileSavePicker](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.ContinueFileSavePicker](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_previousexecutionstate.md index 6fe4ad610d..259cce990d 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_splashscreen.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_splashscreen.md index a4e68f3bc7..427d0679b4 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.SplashScreen ## -description Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.SplashScreen + +## -description +Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_user.md b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_user.md index 3fb60267f7..7aa0db727a 100644 --- a/windows.applicationmodel.activation/filesavepickercontinuationeventargs_user.md +++ b/windows.applicationmodel.activation/filesavepickercontinuationeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FileSavePickerContinuationEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs.md index 85f4929e53..66a777ba03 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs ## -description Provides information about an activated event that fires after the app was suspended for a folder picker operation. ## -remarks You access a [FolderPickerContinuationEventArgs](folderpickercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **PickFolderContinuation**. For an example that uses the [FolderPickerContinuationEventArgs](folderpickercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). ## -examples ## -see-also [IFolderPickerContinuationEventArgs](ifolderpickercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs + +## -description +Provides information about an activated event that fires after the app was suspended for a folder picker operation. + +## -remarks +You access a [FolderPickerContinuationEventArgs](folderpickercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **PickFolderContinuation**. + +For an example that uses the [FolderPickerContinuationEventArgs](folderpickercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). + +## -examples + +## -see-also +[IFolderPickerContinuationEventArgs](ifolderpickercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs_continuationdata.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs_continuationdata.md index 5bf1b96059..5c55c3e66d 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs_continuationdata.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs_continuationdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.ContinuationData --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.ContinuationData ## -description Gets a set of values populated by the app before a [FolderPicker](../windows.storage.pickers/folderpicker.md) operation that deactivates the app in order to provide context when the app is activated. ## -property-value A set of values populated by the app before a [FolderPicker](../windows.storage.pickers/folderpicker.md) operation that deactivates the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.ContinuationData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.ContinuationData + +## -description +Gets a set of values populated by the app before a [FolderPicker](../windows.storage.pickers/folderpicker.md) operation that deactivates the app in order to provide context when the app is activated. + +## -property-value +A set of values populated by the app before a [FolderPicker](../windows.storage.pickers/folderpicker.md) operation that deactivates the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs_folder.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs_folder.md index 7d01b5eaa2..9b1f047b41 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs_folder.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs_folder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Folder --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Folder ## -description Gets the folder selected by the user during the folder picker operation. ## -property-value The folder selected by the user during the folder picker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Folder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Folder + +## -description +Gets the folder selected by the user during the folder picker operation. + +## -property-value +The folder selected by the user during the folder picker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs_kind.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs_kind.md index 84c155fb50..733d50a05f 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs_kind.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.ContinueFolderPicker](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.ContinueFolderPicker](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs_previousexecutionstate.md index 2a3ee7f925..8ca1b8df69 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs_splashscreen.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs_splashscreen.md index 87b519ca62..45abcfda2b 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.SplashScreen ## -description Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.SplashScreen + +## -description +Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/folderpickercontinuationeventargs_user.md b/windows.applicationmodel.activation/folderpickercontinuationeventargs_user.md index fdf84ca2af..d0ad89d9f8 100644 --- a/windows.applicationmodel.activation/folderpickercontinuationeventargs_user.md +++ b/windows.applicationmodel.activation/folderpickercontinuationeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.FolderPickerContinuationEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iactivatedeventargs_kind.md b/windows.applicationmodel.activation/iactivatedeventargs_kind.md index ad595f1847..fd0138a325 100644 --- a/windows.applicationmodel.activation/iactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/iactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IActivatedEventArgs.Kind ## -description Gets the reason that this app is being activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IActivatedEventArgs.Kind + +## -description +Gets the reason that this app is being activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/iactivatedeventargs_previousexecutionstate.md index 259607870b..daecf484ee 100644 --- a/windows.applicationmodel.activation/iactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/iactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before this activation. ## -property-value One of the enumeration values. ## -remarks The app uses this information to determine whether it should restore saved state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before this activation. + +## -property-value +One of the enumeration values. + +## -remarks +The app uses this information to determine whether it should restore saved state. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/iactivatedeventargs_splashscreen.md index ea8cf11a4b..c5676aa0f9 100644 --- a/windows.applicationmodel.activation/iactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/iactivatedeventargs_splashscreen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The splash screen object. ## -remarks This property is only meaningful when the app is activated under a contract that expects a window to be presented. If the contract doesn't require a window or if the app is being activated for a background task, this call will fail. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The splash screen object. + +## -remarks +This property is only meaningful when the app is activated under a contract that expects a window to be presented. If the contract doesn't require a window or if the app is being activated for a background task, this call will fail. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iactivatedeventargswithuser_user.md b/windows.applicationmodel.activation/iactivatedeventargswithuser_user.md index c9ed71ba86..b8f564d0d6 100644 --- a/windows.applicationmodel.activation/iactivatedeventargswithuser_user.md +++ b/windows.applicationmodel.activation/iactivatedeventargswithuser_user.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgsWithUser.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IActivatedEventArgsWithUser.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. ## -remarks Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IActivatedEventArgsWithUser.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IActivatedEventArgsWithUser.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +## -remarks +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iapplicationviewactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/iapplicationviewactivatedeventargs_currentlyshownapplicationviewid.md index 67ac9a0222..b73458d67e 100644 --- a/windows.applicationmodel.activation/iapplicationviewactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/iapplicationviewactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IApplicationViewActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IApplicationViewActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IApplicationViewActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IApplicationViewActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovideractivatedeventargs_verb.md b/windows.applicationmodel.activation/iappointmentsprovideractivatedeventargs_verb.md index 65fdb83fea..15d2485e38 100644 --- a/windows.applicationmodel.activation/iappointmentsprovideractivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/iappointmentsprovideractivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderActivatedEventArgs.Verb ## -description Gets the action to be performed by the appointments provider. ## -property-value The action to be performed by the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderActivatedEventArgs.Verb + +## -description +Gets the action to be performed by the appointments provider. + +## -property-value +The action to be performed by the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md b/windows.applicationmodel.activation/iappointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md index 67d166b649..ec551a173a 100644 --- a/windows.applicationmodel.activation/iappointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md +++ b/windows.applicationmodel.activation/iappointmentsprovideraddappointmentactivatedeventargs_addappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation ## -description Gets the appointment that is provided to the app when the user tries to add it. ## -property-value The appointment that is added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderAddAppointmentActivatedEventArgs.AddAppointmentOperation + +## -description +Gets the appointment that is provided to the app when the user tries to add it. + +## -property-value +The appointment that is added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md b/windows.applicationmodel.activation/iappointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md index 615e1aff84..1eee779298 100644 --- a/windows.applicationmodel.activation/iappointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md +++ b/windows.applicationmodel.activation/iappointmentsproviderremoveappointmentactivatedeventargs_removeappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation ## -description Gets the appointment that is provided to the app when the user tries to remove it. ## -property-value The appointment that is removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderRemoveAppointmentActivatedEventArgs.RemoveAppointmentOperation + +## -description +Gets the appointment that is provided to the app when the user tries to remove it. + +## -property-value +The appointment that is removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md b/windows.applicationmodel.activation/iappointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md index 9460a280d3..c416efd924 100644 --- a/windows.applicationmodel.activation/iappointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md +++ b/windows.applicationmodel.activation/iappointmentsproviderreplaceappointmentactivatedeventargs_replaceappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation ## -description Gets the appointment that is provided to the app when the user tries to replace it. ## -property-value The appointment that is replaced. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderReplaceAppointmentActivatedEventArgs.ReplaceAppointmentOperation + +## -description +Gets the appointment that is provided to the app when the user tries to replace it. + +## -property-value +The appointment that is replaced. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md b/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md index 831da56dad..442633e6d5 100644 --- a/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md +++ b/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_instancestartdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate ## -description Gets the start date of the appointment instance for which the app should display details. ## -property-value The start date of the appointment instance for which the app should display details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.InstanceStartDate + +## -description +Gets the start date of the appointment instance for which the app should display details. + +## -property-value +The start date of the appointment instance for which the app should display details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md b/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md index 9bd21f65fd..25c7f362a0 100644 --- a/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md +++ b/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_localid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId ## -description Ges the local identifier of the appointment for which the app should display details. ## -property-value The local identifier of the appointment for which the app should display details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.LocalId + +## -description +Ges the local identifier of the appointment for which the app should display details. + +## -property-value +The local identifier of the appointment for which the app should display details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md b/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md index 8b9f47ed61..5047f96d76 100644 --- a/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md +++ b/windows.applicationmodel.activation/iappointmentsprovidershowappointmentdetailsactivatedeventargs_roamingid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId ## -description Gets the roaming identifier of the appointment for which the app should display details. ## -property-value The roaming identifier of the appointment for which the app should display details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderShowAppointmentDetailsActivatedEventArgs.RoamingId + +## -description +Gets the roaming identifier of the appointment for which the app should display details. + +## -property-value +The roaming identifier of the appointment for which the app should display details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_duration.md b/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_duration.md index 14c744ef85..2be0c03aae 100644 --- a/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_duration.md +++ b/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.Duration --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.Duration ## -description Gets the duration of the time frame to be shown. ## -property-value The duration of the time frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.Duration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.Duration + +## -description +Gets the duration of the time frame to be shown. + +## -property-value +The duration of the time frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md b/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md index 521fb744f0..73fab9a05c 100644 --- a/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md +++ b/windows.applicationmodel.activation/iappointmentsprovidershowtimeframeactivatedeventargs_timetoshow.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow ## -description Gets the starting date and time of the time frame to be shown. ## -property-value The starting date and time of the time frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IAppointmentsProviderShowTimeFrameActivatedEventArgs.TimeToShow + +## -description +Gets the starting date and time of the time frame to be shown. + +## -property-value +The starting date and time of the time frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ibackgroundactivatedeventargs_taskinstance.md b/windows.applicationmodel.activation/ibackgroundactivatedeventargs_taskinstance.md index 253b1ee843..38c4f3d65f 100644 --- a/windows.applicationmodel.activation/ibackgroundactivatedeventargs_taskinstance.md +++ b/windows.applicationmodel.activation/ibackgroundactivatedeventargs_taskinstance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IBackgroundActivatedEventArgs.TaskInstance --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IBackgroundActivatedEventArgs.TaskInstance ## -description Get the data that was available to the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method that resulted in your app being activated. ## -property-value The data that was available to the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IBackgroundActivatedEventArgs.TaskInstance +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IBackgroundActivatedEventArgs.TaskInstance + +## -description +Get the data that was available to the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method that resulted in your app being activated. + +## -property-value +The data that was available to the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodevicecontroller.md b/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodevicecontroller.md index c624fbb1eb..62e1dd6d16 100644 --- a/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodevicecontroller.md +++ b/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodevicecontroller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceController --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceController ## -description Gets the object that controls device settings on the camera. ## -property-value The object that controls device settings on the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceController +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceController + +## -description +Gets the object that controls device settings on the camera. + +## -property-value +The object that controls device settings on the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodeviceextension.md b/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodeviceextension.md index 2e6df5a9e7..f4dffbbe10 100644 --- a/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodeviceextension.md +++ b/windows.applicationmodel.activation/icamerasettingsactivatedeventargs_videodeviceextension.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceExtension --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceExtension ## -description Gets the object that implements additional extended settings for the camera. ## -property-value An object implementing extended settings for the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceExtension +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs.VideoDeviceExtension + +## -description +Gets the object that implements additional extended settings for the camera. + +## -property-value +An object implementing extended settings for the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactactivatedeventargs_verb.md b/windows.applicationmodel.activation/icontactactivatedeventargs_verb.md index 10d44071fc..944805a431 100644 --- a/windows.applicationmodel.activation/icontactactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/icontactactivatedeventargs_verb.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactActivatedEventArgs.Verb ## -description Gets the action that is associated with the activated contact. ## -property-value The action that is associated with the activated contact. ## -remarks For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactActivatedEventArgs.Verb + +## -description +Gets the action that is associated with the activated contact. + +## -property-value +The action that is associated with the activated contact. + +## -remarks +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/icontactcallactivatedeventargs_contact.md b/windows.applicationmodel.activation/icontactcallactivatedeventargs_contact.md index 87e3915384..110addd372 100644 --- a/windows.applicationmodel.activation/icontactcallactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/icontactcallactivatedeventargs_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.Contact ## -description Gets the contact for the call. ## -property-value The contact for the call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.Contact + +## -description +Gets the contact for the call. + +## -property-value +The contact for the call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceid.md index 885eb7078c..eaf3fd5e26 100644 --- a/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the call. ## -property-value The identifier of the service used for the call. ## -remarks For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the call. + +## -property-value +The identifier of the service used for the call. + +## -remarks +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceuserid.md index ffe45b70dd..38031c59cd 100644 --- a/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/icontactcallactivatedeventargs_serviceuserid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the call. ## -property-value The user identifier of the service used for the call. ## -remarks For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactCallActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the call. + +## -property-value +The user identifier of the service used for the call. + +## -remarks +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.activation/icontactmapactivatedeventargs_address.md b/windows.applicationmodel.activation/icontactmapactivatedeventargs_address.md index 8fdf471a05..e06f8e9884 100644 --- a/windows.applicationmodel.activation/icontactmapactivatedeventargs_address.md +++ b/windows.applicationmodel.activation/icontactmapactivatedeventargs_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Address --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Address ## -description Gets the address of a contact for the mapping operation. ## -property-value Represents the address of a contact for the mapping operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Address + +## -description +Gets the address of a contact for the mapping operation. + +## -property-value +Represents the address of a contact for the mapping operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactmapactivatedeventargs_contact.md b/windows.applicationmodel.activation/icontactmapactivatedeventargs_contact.md index a659856906..a2259062a4 100644 --- a/windows.applicationmodel.activation/icontactmapactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/icontactmapactivatedeventargs_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Contact ## -description Gets the contact for the mapping operation. ## -property-value The contact for the mapping operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactMapActivatedEventArgs.Contact + +## -description +Gets the contact for the mapping operation. + +## -property-value +The contact for the mapping operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactmessageactivatedeventargs_contact.md b/windows.applicationmodel.activation/icontactmessageactivatedeventargs_contact.md index e480579c67..4362a80d63 100644 --- a/windows.applicationmodel.activation/icontactmessageactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/icontactmessageactivatedeventargs_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.Contact ## -description Gets the contact for the message. ## -property-value The contact for the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.Contact + +## -description +Gets the contact for the message. + +## -property-value +The contact for the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceid.md index 6fd4842cda..da3e723981 100644 --- a/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the message. ## -property-value The identifier of the service used for the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the message. + +## -property-value +The identifier of the service used for the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceuserid.md index 01cb940f75..821e25442b 100644 --- a/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/icontactmessageactivatedeventargs_serviceuserid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the message. ## -property-value The user identifier of the service used for the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactMessageActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the message. + +## -property-value +The user identifier of the service used for the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactpickeractivatedeventargs_contactpickerui.md b/windows.applicationmodel.activation/icontactpickeractivatedeventargs_contactpickerui.md index 46cbc72dc9..f88157afc5 100644 --- a/windows.applicationmodel.activation/icontactpickeractivatedeventargs_contactpickerui.md +++ b/windows.applicationmodel.activation/icontactpickeractivatedeventargs_contactpickerui.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactPickerActivatedEventArgs.ContactPickerUI --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactPickerActivatedEventArgs.ContactPickerUI ## -description The letterbox UI of the contact picker that is displayed when the user wants to pick files or folders that are provided by the app. ## -property-value The letterbox UI of the contact picker that is displayed when the user wants to pick files or folders that are provided by the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactPickerActivatedEventArgs.ContactPickerUI +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactPickerActivatedEventArgs.ContactPickerUI + +## -description +The letterbox UI of the contact picker that is displayed when the user wants to pick files or folders that are provided by the app. + +## -property-value +The letterbox UI of the contact picker that is displayed when the user wants to pick files or folders that are provided by the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactpostactivatedeventargs_contact.md b/windows.applicationmodel.activation/icontactpostactivatedeventargs_contact.md index 7a9f410d3e..c9f81307f1 100644 --- a/windows.applicationmodel.activation/icontactpostactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/icontactpostactivatedeventargs_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.Contact ## -description Gets the contact for the post. ## -property-value The contact for the post. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.Contact + +## -description +Gets the contact for the post. + +## -property-value +The contact for the post. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceid.md index 5cb783fb7e..80c1757eee 100644 --- a/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the post. ## -property-value The identifier of the service used for the post. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the post. + +## -property-value +The identifier of the service used for the post. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceuserid.md index 71d876c5b5..4268fa12c4 100644 --- a/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/icontactpostactivatedeventargs_serviceuserid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the post. ## -property-value The user identifier of the service used for the post. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactPostActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the post. + +## -property-value +The user identifier of the service used for the post. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactsprovideractivatedeventargs_verb.md b/windows.applicationmodel.activation/icontactsprovideractivatedeventargs_verb.md index 4871f55b7d..4b3a06fd93 100644 --- a/windows.applicationmodel.activation/icontactsprovideractivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/icontactsprovideractivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactsProviderActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactsProviderActivatedEventArgs.Verb ## -description Gets the action that is associated with the activated contacts provider. ## -property-value The action that is associated with the activated contacts provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactsProviderActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactsProviderActivatedEventArgs.Verb + +## -description +Gets the action that is associated with the activated contacts provider. + +## -property-value +The action that is associated with the activated contacts provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_contact.md b/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_contact.md index b9e532f4e9..703608f617 100644 --- a/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_contact.md +++ b/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.Contact ## -description Gets the contact for the video call. ## -property-value The contact for the video call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.Contact + +## -description +Gets the contact for the video call. + +## -property-value +The contact for the video call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceid.md b/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceid.md index 2bbc501015..625585d1ad 100644 --- a/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceid.md +++ b/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceId ## -description Gets the identifier of the service used for the video call. ## -property-value The identifier of the service used for the video call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceId + +## -description +Gets the identifier of the service used for the video call. + +## -property-value +The identifier of the service used for the video call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceuserid.md b/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceuserid.md index c7649e31c2..209df01447 100644 --- a/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceuserid.md +++ b/windows.applicationmodel.activation/icontactvideocallactivatedeventargs_serviceuserid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceUserId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceUserId ## -description Gets the user identifier of the service used for the video call. ## -property-value The user identifier of the service used for the video call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceUserId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactVideoCallActivatedEventArgs.ServiceUserId + +## -description +Gets the user identifier of the service used for the video call. + +## -property-value +The user identifier of the service used for the video call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/icontinuationactivatedeventargs_continuationdata.md b/windows.applicationmodel.activation/icontinuationactivatedeventargs_continuationdata.md index 0751c80208..f902d4cb52 100644 --- a/windows.applicationmodel.activation/icontinuationactivatedeventargs_continuationdata.md +++ b/windows.applicationmodel.activation/icontinuationactivatedeventargs_continuationdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IContinuationActivatedEventArgs.ContinuationData --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IContinuationActivatedEventArgs.ContinuationData ## -description Gets a set of values populated by the app before an operation that deactivates the app in order to provide context when the app is activated. ## -property-value A set of values populated by the app before an operation that deactivates the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IContinuationActivatedEventArgs.ContinuationData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContinuationActivatedEventArgs.ContinuationData + +## -description +Gets a set of values populated by the app before an operation that deactivates the app in order to provide context when the app is activated. + +## -property-value +A set of values populated by the app before an operation that deactivates the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ideviceactivatedeventargs_deviceinformationid.md b/windows.applicationmodel.activation/ideviceactivatedeventargs_deviceinformationid.md index 266ff5b248..29481c3a15 100644 --- a/windows.applicationmodel.activation/ideviceactivatedeventargs_deviceinformationid.md +++ b/windows.applicationmodel.activation/ideviceactivatedeventargs_deviceinformationid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.DeviceInformationId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.DeviceInformationId ## -description Gets the device identifier for the device that invoked AutoPlay. ## -property-value The device identifier for the device that invoked AutoPlay. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.DeviceInformationId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.DeviceInformationId + +## -description +Gets the device identifier for the device that invoked AutoPlay. + +## -property-value +The device identifier for the device that invoked AutoPlay. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ideviceactivatedeventargs_verb.md b/windows.applicationmodel.activation/ideviceactivatedeventargs_verb.md index 69875d45f6..88098eec1f 100644 --- a/windows.applicationmodel.activation/ideviceactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/ideviceactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.Verb ## -description Gets the action associated with the activated device. ## -property-value The action associated with the activated device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs.Verb + +## -description +Gets the action associated with the activated device. + +## -property-value +The action associated with the activated device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/idevicepairingactivatedeventargs_deviceinformation.md b/windows.applicationmodel.activation/idevicepairingactivatedeventargs_deviceinformation.md index 2cc85599e2..5a0cd0cf9b 100644 --- a/windows.applicationmodel.activation/idevicepairingactivatedeventargs_deviceinformation.md +++ b/windows.applicationmodel.activation/idevicepairingactivatedeventargs_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IDevicePairingActivatedEventArgs.DeviceInformation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IDevicePairingActivatedEventArgs.DeviceInformation ## -description Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the device object that is being paired. ## -property-value The information of the device object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IDevicePairingActivatedEventArgs.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IDevicePairingActivatedEventArgs.DeviceInformation + +## -description +Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the device object that is being paired. + +## -property-value +The information of the device object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/idialreceiveractivatedeventargs_appname.md b/windows.applicationmodel.activation/idialreceiveractivatedeventargs_appname.md index c86389bbdc..b94fc5ca99 100644 --- a/windows.applicationmodel.activation/idialreceiveractivatedeventargs_appname.md +++ b/windows.applicationmodel.activation/idialreceiveractivatedeventargs_appname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IDialReceiverActivatedEventArgs.AppName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IDialReceiverActivatedEventArgs.AppName ## -description Gets the name of the app that invoked the dial receiver app. ## -property-value The name of the app that invoked the dial receiver app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IDialReceiverActivatedEventArgs.AppName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IDialReceiverActivatedEventArgs.AppName + +## -description +Gets the name of the app that invoked the dial receiver app. + +## -property-value +The name of the app that invoked the dial receiver app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifileactivatedeventargs_files.md b/windows.applicationmodel.activation/ifileactivatedeventargs_files.md index 03e1e507ed..f63afd7e4f 100644 --- a/windows.applicationmodel.activation/ifileactivatedeventargs_files.md +++ b/windows.applicationmodel.activation/ifileactivatedeventargs_files.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Files --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Files ## -description Gets the files for which the app was activated. ## -property-value The files. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Files +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Files + +## -description +Gets the files for which the app was activated. + +## -property-value +The files. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifileactivatedeventargs_verb.md b/windows.applicationmodel.activation/ifileactivatedeventargs_verb.md index 64233abc2d..0261cdb77d 100644 --- a/windows.applicationmodel.activation/ifileactivatedeventargs_verb.md +++ b/windows.applicationmodel.activation/ifileactivatedeventargs_verb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Verb --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Verb ## -description Gets the action associated with the activated file. ## -property-value The action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Verb +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileActivatedEventArgs.Verb + +## -description +Gets the action associated with the activated file. + +## -property-value +The action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifileactivatedeventargswithcallerpackagefamilyname_callerpackagefamilyname.md b/windows.applicationmodel.activation/ifileactivatedeventargswithcallerpackagefamilyname_callerpackagefamilyname.md index 34fcb18281..37d35f34bc 100644 --- a/windows.applicationmodel.activation/ifileactivatedeventargswithcallerpackagefamilyname_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/ifileactivatedeventargswithcallerpackagefamilyname_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithCallerPackageFamilyName.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithCallerPackageFamilyName.CallerPackageFamilyName ## -description The package family name of the app that launched this app. ## -property-value The caller's package family name. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithCallerPackageFamilyName.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithCallerPackageFamilyName.CallerPackageFamilyName + +## -description +The package family name of the app that launched this app. + +## -property-value +The caller's package family name. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifileactivatedeventargswithneighboringfiles_neighboringfilesquery.md b/windows.applicationmodel.activation/ifileactivatedeventargswithneighboringfiles_neighboringfilesquery.md index 05920b7ac9..0971fa0e9f 100644 --- a/windows.applicationmodel.activation/ifileactivatedeventargswithneighboringfiles_neighboringfilesquery.md +++ b/windows.applicationmodel.activation/ifileactivatedeventargswithneighboringfiles_neighboringfilesquery.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithNeighboringFiles.NeighboringFilesQuery --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithNeighboringFiles.NeighboringFilesQuery ## -description Gets the neighboring files of the files for which the app was activated. ## -property-value The [StorageFile](../windows.storage/storagefile.md) objects that represent the neighboring files of the files being passed to the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithNeighboringFiles.NeighboringFilesQuery +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileActivatedEventArgsWithNeighboringFiles.NeighboringFilesQuery + +## -description +Gets the neighboring files of the files for which the app was activated. + +## -property-value +The [StorageFile](../windows.storage/storagefile.md) objects that represent the neighboring files of the files being passed to the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifileopenpickeractivatedeventargs2_callerpackagefamilyname.md b/windows.applicationmodel.activation/ifileopenpickeractivatedeventargs2_callerpackagefamilyname.md index e2ce56c71d..183f72d8b0 100644 --- a/windows.applicationmodel.activation/ifileopenpickeractivatedeventargs2_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/ifileopenpickeractivatedeventargs2_callerpackagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileOpenPickerActivatedEventArgs2.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileOpenPickerActivatedEventArgs2.CallerPackageFamilyName ## -description The package family name of the app that launched your app. ## -property-value The caller's package family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileOpenPickerActivatedEventArgs2.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileOpenPickerActivatedEventArgs2.CallerPackageFamilyName + +## -description +The package family name of the app that launched your app. + +## -property-value +The caller's package family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifileopenpickercontinuationeventargs_files.md b/windows.applicationmodel.activation/ifileopenpickercontinuationeventargs_files.md index 4392eec368..ec2d64586e 100644 --- a/windows.applicationmodel.activation/ifileopenpickercontinuationeventargs_files.md +++ b/windows.applicationmodel.activation/ifileopenpickercontinuationeventargs_files.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileOpenPickerContinuationEventArgs.Files --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileOpenPickerContinuationEventArgs.Files ## -description Gets the list of files selected by the user during the file open picker operation. ## -property-value The list of files selected by the user during the file open picker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileOpenPickerContinuationEventArgs.Files +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileOpenPickerContinuationEventArgs.Files + +## -description +Gets the list of files selected by the user during the file open picker operation. + +## -property-value +The list of files selected by the user during the file open picker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_callerpackagefamilyname.md b/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_callerpackagefamilyname.md index 039a3b0c00..fbe70d5beb 100644 --- a/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.CallerPackageFamilyName ## -description The package family name of the app that launched your app. ## -property-value The caller's package family name. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.CallerPackageFamilyName + +## -description +The package family name of the app that launched your app. + +## -property-value +The caller's package family name. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_enterpriseid.md b/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_enterpriseid.md index debf743824..9ed958fbb8 100644 --- a/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_enterpriseid.md +++ b/windows.applicationmodel.activation/ifilesavepickeractivatedeventargs2_enterpriseid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.EnterpriseId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.EnterpriseId ## -description Gets the ID of the enterprise that owns the file. ## -property-value The ID of the enterprise that owns the file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.EnterpriseId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs2.EnterpriseId + +## -description +Gets the ID of the enterprise that owns the file. + +## -property-value +The ID of the enterprise that owns the file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifilesavepickercontinuationeventargs_file.md b/windows.applicationmodel.activation/ifilesavepickercontinuationeventargs_file.md index 7aea97b44a..78a5be753f 100644 --- a/windows.applicationmodel.activation/ifilesavepickercontinuationeventargs_file.md +++ b/windows.applicationmodel.activation/ifilesavepickercontinuationeventargs_file.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFileSavePickerContinuationEventArgs.File --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFileSavePickerContinuationEventArgs.File ## -description Gets the file selected by the user during the file save picker operation. ## -property-value The file selected by the user during the file save picker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFileSavePickerContinuationEventArgs.File +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFileSavePickerContinuationEventArgs.File + +## -description +Gets the file selected by the user during the file save picker operation. + +## -property-value +The file selected by the user during the file save picker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ifolderpickercontinuationeventargs_folder.md b/windows.applicationmodel.activation/ifolderpickercontinuationeventargs_folder.md index 0d29c775d8..cfefb9de6e 100644 --- a/windows.applicationmodel.activation/ifolderpickercontinuationeventargs_folder.md +++ b/windows.applicationmodel.activation/ifolderpickercontinuationeventargs_folder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IFolderPickerContinuationEventArgs.Folder --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IFolderPickerContinuationEventArgs.Folder ## -description Gets the folder selected by the user during the folder picker operation. ## -property-value The folder selected by the user during the folder picker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IFolderPickerContinuationEventArgs.Folder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IFolderPickerContinuationEventArgs.Folder + +## -description +Gets the folder selected by the user during the folder picker operation. + +## -property-value +The folder selected by the user during the folder picker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ilaunchactivatedeventargs2_tileactivatedinfo.md b/windows.applicationmodel.activation/ilaunchactivatedeventargs2_tileactivatedinfo.md index d0b14593d0..95291ded57 100644 --- a/windows.applicationmodel.activation/ilaunchactivatedeventargs2_tileactivatedinfo.md +++ b/windows.applicationmodel.activation/ilaunchactivatedeventargs2_tileactivatedinfo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs2.TileActivatedInfo --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs2.TileActivatedInfo ## -description Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property. ## -property-value Information about the tile that launched the app. ## -remarks You do not have to check for ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs2.TileActivatedInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs2.TileActivatedInfo + +## -description +Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property. + +## -property-value +Information about the tile that launched the app. + +## -remarks +You do not have to check for + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ilaunchactivatedeventargs_arguments.md b/windows.applicationmodel.activation/ilaunchactivatedeventargs_arguments.md index f19ccc643a..d03afee905 100644 --- a/windows.applicationmodel.activation/ilaunchactivatedeventargs_arguments.md +++ b/windows.applicationmodel.activation/ilaunchactivatedeventargs_arguments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.Arguments --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.Arguments ## -description Gets the arguments that are passed to the app during its launch activation. ## -property-value The list of arguments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.Arguments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.Arguments + +## -description +Gets the arguments that are passed to the app during its launch activation. + +## -property-value +The list of arguments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ilaunchactivatedeventargs_tileid.md b/windows.applicationmodel.activation/ilaunchactivatedeventargs_tileid.md index f46016560d..d7160f940b 100644 --- a/windows.applicationmodel.activation/ilaunchactivatedeventargs_tileid.md +++ b/windows.applicationmodel.activation/ilaunchactivatedeventargs_tileid.md @@ -1,3 +1,49 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.TileId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.TileId ## -description Gets the ID of the tile that was invoked to launch the app. ## -property-value The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the [SecondaryTile.TileId](../windows.ui.startscreen/secondarytile_tileid.md) value, assigned to the secondary tile when it was created, is returned. ## -remarks Starting with Windows 10, **TileId** behavior is different for apps that are launched after having been terminated. Previously, the **TileId** always returned the ID of the tile that launched the app. The **TileId** behavior now depends on how the app is reactivated:
How the app is reactivatedBehavior of **TileId**
The user switches to the app by using the task switcher or by using the global back keyReturns the empty string `("")`.
The user taps the app tileReturns the tile ID.
The new behavior makes it possible to differentiate between a switch to the app versus a re-launch of the app. If your app uses tile ID information during activation, handle the `TileId==""` case. For example: ```csharp protected override void OnLaunched(LaunchActivatedEventArgs e) { ... if (e.TileId == "") { // resumed from switch/backstack } else { // resumed from tile launch } ... } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.TileId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs.TileId + +## -description +Gets the ID of the tile that was invoked to launch the app. + +## -property-value +The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the [SecondaryTile.TileId](../windows.ui.startscreen/secondarytile_tileid.md) value, assigned to the secondary tile when it was created, is returned. + +## -remarks +Starting with Windows 10, **TileId** behavior is different for apps that are launched after having been terminated. Previously, the **TileId** always returned the ID of the tile that launched the app. The **TileId** behavior now depends on how the app is reactivated: + + + +
How the app is reactivatedBehavior of **TileId**
The user switches to the app by using the task switcher or by using the global back keyReturns the empty string `("")`.
The user taps the app tileReturns the tile ID.
+ +The new behavior makes it possible to differentiate between a switch to the app versus a re-launch of the app. If your app uses tile ID information during activation, handle the `TileId==""` case. For example: + + + +```csharp +protected override void OnLaunched(LaunchActivatedEventArgs e) +{ +... + if (e.TileId == "") + { + // resumed from switch/backstack + } + else + { + // resumed from tile launch + } +... +} +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ilockscreenactivatedeventargs_info.md b/windows.applicationmodel.activation/ilockscreenactivatedeventargs_info.md index 37cf5cc925..1720539b3e 100644 --- a/windows.applicationmodel.activation/ilockscreenactivatedeventargs_info.md +++ b/windows.applicationmodel.activation/ilockscreenactivatedeventargs_info.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ILockScreenActivatedEventArgs.Info --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ILockScreenActivatedEventArgs.Info ## -description Gets an object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. ## -property-value An object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. ## -remarks ## -examples ## -see-also [LockScreenInfo](../windows.applicationmodel.lockscreen/lockscreeninfo.md), [LockScreenActivatedEventArgs.Info](lockscreenactivatedeventargs_info.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ILockScreenActivatedEventArgs.Info +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ILockScreenActivatedEventArgs.Info + +## -description +Gets an object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. + +## -property-value +An object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. + +## -remarks + +## -examples + +## -see-also +[LockScreenInfo](../windows.applicationmodel.lockscreen/lockscreeninfo.md), [LockScreenActivatedEventArgs.Info](lockscreenactivatedeventargs_info.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/ilockscreencallactivatedeventargs_callui.md b/windows.applicationmodel.activation/ilockscreencallactivatedeventargs_callui.md index 1aa60a7192..04bc5a50ff 100644 --- a/windows.applicationmodel.activation/ilockscreencallactivatedeventargs_callui.md +++ b/windows.applicationmodel.activation/ilockscreencallactivatedeventargs_callui.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ILockScreenCallActivatedEventArgs.CallUI --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ILockScreenCallActivatedEventArgs.CallUI ## -description Gets the UI that handles communication to and from the lock screen. ## -property-value The UI that handles communication to and from the lock screen. ## -remarks ## -examples ## -see-also [LockScreenCallUI](../windows.applicationmodel.calls/lockscreencallui.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ILockScreenCallActivatedEventArgs.CallUI +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ILockScreenCallActivatedEventArgs.CallUI + +## -description +Gets the UI that handles communication to and from the lock screen. + +## -property-value +The UI that handles communication to and from the lock screen. + +## -remarks + +## -examples + +## -see-also +[LockScreenCallUI](../windows.applicationmodel.calls/lockscreencallui.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/ipickerreturnedactivatedeventargs_pickeroperationid.md b/windows.applicationmodel.activation/ipickerreturnedactivatedeventargs_pickeroperationid.md index e5b4fcbb27..40a977fed5 100644 --- a/windows.applicationmodel.activation/ipickerreturnedactivatedeventargs_pickeroperationid.md +++ b/windows.applicationmodel.activation/ipickerreturnedactivatedeventargs_pickeroperationid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IPickerReturnedActivatedEventArgs.PickerOperationId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IPickerReturnedActivatedEventArgs.PickerOperationId ## -description Gets an identifier indicating the type of picker operation that was performed prior to the activation. ## -property-value An identifier indicating the type of picker operation that was performed prior to the activation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IPickerReturnedActivatedEventArgs.PickerOperationId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IPickerReturnedActivatedEventArgs.PickerOperationId + +## -description +Gets an identifier indicating the type of picker operation that was performed prior to the activation. + +## -property-value +An identifier indicating the type of picker operation that was performed prior to the activation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iprelaunchactivatedeventargs_prelaunchactivated.md b/windows.applicationmodel.activation/iprelaunchactivatedeventargs_prelaunchactivated.md index 277506855a..d640cc3b39 100644 --- a/windows.applicationmodel.activation/iprelaunchactivatedeventargs_prelaunchactivated.md +++ b/windows.applicationmodel.activation/iprelaunchactivatedeventargs_prelaunchactivated.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IPrelaunchActivatedEventArgs.PrelaunchActivated --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IPrelaunchActivatedEventArgs.PrelaunchActivated ## -description Gets an indication about whether a pre-launch has been activated. ## -property-value Indicates whether a pre-launch has been activated. **TRUE** indicates activated; otherwise, **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IPrelaunchActivatedEventArgs.PrelaunchActivated +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IPrelaunchActivatedEventArgs.PrelaunchActivated + +## -description +Gets an indication about whether a pre-launch has been activated. + +## -property-value +Indicates whether a pre-launch has been activated. **TRUE** indicates activated; otherwise, **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iprint3dworkflowactivatedeventargs_workflow.md b/windows.applicationmodel.activation/iprint3dworkflowactivatedeventargs_workflow.md index 22c182c89b..f572d38f9c 100644 --- a/windows.applicationmodel.activation/iprint3dworkflowactivatedeventargs_workflow.md +++ b/windows.applicationmodel.activation/iprint3dworkflowactivatedeventargs_workflow.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IPrint3DWorkflowActivatedEventArgs.Workflow --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IPrint3DWorkflowActivatedEventArgs.Workflow ## -description Gets the workflow that the app should use for three-dimensional printing. ## -property-value The workflow that the app should use for three-dimensional printing. ## -remarks ## -examples ## -see-also [Print3DWorkflow](../windows.devices.printers.extensions/print3dworkflow.md), [Print3DWorkflowActivatedEventArgs.Workflow](print3dworkflowactivatedeventargs_workflow.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IPrint3DWorkflowActivatedEventArgs.Workflow +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IPrint3DWorkflowActivatedEventArgs.Workflow + +## -description +Gets the workflow that the app should use for three-dimensional printing. + +## -property-value +The workflow that the app should use for three-dimensional printing. + +## -remarks + +## -examples + +## -see-also +[Print3DWorkflow](../windows.devices.printers.extensions/print3dworkflow.md), [Print3DWorkflowActivatedEventArgs.Workflow](print3dworkflowactivatedeventargs_workflow.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/iprinttasksettingsactivatedeventargs_configuration.md b/windows.applicationmodel.activation/iprinttasksettingsactivatedeventargs_configuration.md index 0993ffb858..016801fa16 100644 --- a/windows.applicationmodel.activation/iprinttasksettingsactivatedeventargs_configuration.md +++ b/windows.applicationmodel.activation/iprinttasksettingsactivatedeventargs_configuration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IPrintTaskSettingsActivatedEventArgs.Configuration --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IPrintTaskSettingsActivatedEventArgs.Configuration ## -description Gets the configuration information for the print task. ## -property-value The print task configuration information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IPrintTaskSettingsActivatedEventArgs.Configuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IPrintTaskSettingsActivatedEventArgs.Configuration + +## -description +Gets the configuration information for the print task. + +## -property-value +The print task configuration information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iprotocolactivatedeventargs_uri.md b/windows.applicationmodel.activation/iprotocolactivatedeventargs_uri.md index 7564d488d7..f25b704dd2 100644 --- a/windows.applicationmodel.activation/iprotocolactivatedeventargs_uri.md +++ b/windows.applicationmodel.activation/iprotocolactivatedeventargs_uri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IProtocolActivatedEventArgs.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IProtocolActivatedEventArgs.Uri ## -description Gets the Uniform Resource Identifier (URI) for which the app was activated. ## -property-value The Uniform Resource Identifier (URI). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IProtocolActivatedEventArgs.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IProtocolActivatedEventArgs.Uri + +## -description +Gets the Uniform Resource Identifier (URI) for which the app was activated. + +## -property-value +The Uniform Resource Identifier (URI). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_callerpackagefamilyname.md b/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_callerpackagefamilyname.md index 0cc86075dd..161c1f5824 100644 --- a/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.CallerPackageFamilyName ## -description Gets the package family name of the application that activated the current application. ## -property-value The package family name of the application that activated the current application. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.CallerPackageFamilyName + +## -description +Gets the package family name of the application that activated the current application. + +## -property-value +The package family name of the application that activated the current application. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_data.md b/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_data.md index 9a57ec6fcf..3bbf69cf0c 100644 --- a/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_data.md +++ b/windows.applicationmodel.activation/iprotocolactivatedeventargswithcallerpackagefamilynameanddata_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.Data --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.Data ## -description Data received from the application that activated the current application. ## -property-value User-defined data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData.Data + +## -description +Data received from the application that activated the current application. + +## -property-value +User-defined data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iprotocolforresultsactivatedeventargs_protocolforresultsoperation.md b/windows.applicationmodel.activation/iprotocolforresultsactivatedeventargs_protocolforresultsoperation.md index ce4ce5bde0..17f1126c2c 100644 --- a/windows.applicationmodel.activation/iprotocolforresultsactivatedeventargs_protocolforresultsoperation.md +++ b/windows.applicationmodel.activation/iprotocolforresultsactivatedeventargs_protocolforresultsoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation ## -description Gets the **ProtocolForResultsOperation** that you can then use to signal that your app is ready to return to the app that launched it for results. ## -property-value The **ProtocolForResultsOperation** object that you can use to signal that your app is ready to return by calling its [ProtocolForResultsOperation.ReportCompleted](../windows.system/protocolforresultsoperation_reportcompleted.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation + +## -description +Gets the **ProtocolForResultsOperation** that you can then use to signal that your app is ready to return to the app that launched it for results. + +## -property-value +The **ProtocolForResultsOperation** object that you can use to signal that your app is ready to return by calling its [ProtocolForResultsOperation.ReportCompleted](../windows.system/protocolforresultsoperation_reportcompleted.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/irestrictedlaunchactivatedeventargs_sharedcontext.md b/windows.applicationmodel.activation/irestrictedlaunchactivatedeventargs_sharedcontext.md index 1c60b676ab..65642eb82f 100644 --- a/windows.applicationmodel.activation/irestrictedlaunchactivatedeventargs_sharedcontext.md +++ b/windows.applicationmodel.activation/irestrictedlaunchactivatedeventargs_sharedcontext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IRestrictedLaunchActivatedEventArgs.SharedContext --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IRestrictedLaunchActivatedEventArgs.SharedContext ## -description Gets information about a shared context for the restricted launch. ## -property-value The object that provides shared context information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IRestrictedLaunchActivatedEventArgs.SharedContext +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IRestrictedLaunchActivatedEventArgs.SharedContext + +## -description +Gets information about a shared context for the restricted launch. + +## -property-value +The object that provides shared context information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/isearchactivatedeventargs_querytext.md b/windows.applicationmodel.activation/isearchactivatedeventargs_querytext.md index 3b5cadcd4a..877a3a6c75 100644 --- a/windows.applicationmodel.activation/isearchactivatedeventargs_querytext.md +++ b/windows.applicationmodel.activation/isearchactivatedeventargs_querytext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ISearchActivatedEventArgs.QueryText --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ISearchActivatedEventArgs.QueryText ## -description The text that the user wants the app to search for. The user entered this text into the search box of the search pane. ## -property-value The text to find. ## -remarks ## -examples ## -see-also [SearchActivatedEventArgs class](searchactivatedeventargs.md), [SearchActivatedEventArgs.QueryText property](searchactivatedeventargs_querytext.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ISearchActivatedEventArgs.QueryText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ISearchActivatedEventArgs.QueryText + +## -description +The text that the user wants the app to search for. The user entered this text into the search box of the search pane. + +## -property-value +The text to find. + +## -remarks + +## -examples + +## -see-also +[SearchActivatedEventArgs class](searchactivatedeventargs.md), [SearchActivatedEventArgs.QueryText property](searchactivatedeventargs_querytext.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/isearchactivatedeventargswithlinguisticdetails_linguisticdetails.md b/windows.applicationmodel.activation/isearchactivatedeventargswithlinguisticdetails_linguisticdetails.md index 5b3db5ee4b..c8f9905883 100644 --- a/windows.applicationmodel.activation/isearchactivatedeventargswithlinguisticdetails_linguisticdetails.md +++ b/windows.applicationmodel.activation/isearchactivatedeventargswithlinguisticdetails_linguisticdetails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ISearchActivatedEventArgsWithLinguisticDetails.LinguisticDetails --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ISearchActivatedEventArgsWithLinguisticDetails.LinguisticDetails ## -description Gets a [SearchPaneQueryLinguisticDetails](../windows.applicationmodel.search/searchpanequerylinguisticdetails.md) object that provides info about query text that the user enters through an Input Method Editor (IME). ## -property-value The object that provides info about query text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ISearchActivatedEventArgsWithLinguisticDetails.LinguisticDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ISearchActivatedEventArgsWithLinguisticDetails.LinguisticDetails + +## -description +Gets a [SearchPaneQueryLinguisticDetails](../windows.applicationmodel.search/searchpanequerylinguisticdetails.md) object that provides info about query text that the user enters through an Input Method Editor (IME). + +## -property-value +The object that provides info about query text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/isharetargetactivatedeventargs_shareoperation.md b/windows.applicationmodel.activation/isharetargetactivatedeventargs_shareoperation.md index 8174ffd046..85ea0c9ee3 100644 --- a/windows.applicationmodel.activation/isharetargetactivatedeventargs_shareoperation.md +++ b/windows.applicationmodel.activation/isharetargetactivatedeventargs_shareoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IShareTargetActivatedEventArgs.ShareOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IShareTargetActivatedEventArgs.ShareOperation ## -description Contains information about data included in a share operation. ## -property-value An object that includes the data included in a send operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IShareTargetActivatedEventArgs.ShareOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IShareTargetActivatedEventArgs.ShareOperation + +## -description +Contains information about data included in a share operation. + +## -property-value +An object that includes the data included in a send operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_argument.md b/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_argument.md index 2aeda8bd8e..7a0258f169 100644 --- a/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_argument.md +++ b/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_argument.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.Argument --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.Argument ## -description Gets the arguments that the app can retrieve after it is activated through an interactive toast notification. ## -property-value The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value: + The **arguments** attribute of the element, if the user performs an action inside the interactive toast notification. + The **launch** attribute of the element, if the user simply clicks the body of the toast notification. ## -remarks ## -examples ## -see-also [ToastNotificationActivatedEventArgs.Argument](toastnotificationactivatedeventargs_argument.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.Argument +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.Argument + +## -description +Gets the arguments that the app can retrieve after it is activated through an interactive toast notification. + +## -property-value +The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value: + + ++ The **arguments** attribute of the element, if the user performs an action inside the interactive toast notification. ++ The **launch** attribute of the element, if the user simply clicks the body of the toast notification. + + +## -remarks + +## -examples + +## -see-also +[ToastNotificationActivatedEventArgs.Argument](toastnotificationactivatedeventargs_argument.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_userinput.md b/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_userinput.md index 818b34aec0..f1f667aea7 100644 --- a/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_userinput.md +++ b/windows.applicationmodel.activation/itoastnotificationactivatedeventargs_userinput.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.UserInput --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.UserInput ## -description Gets a set of values that you can use to obtain the user input from an interactive toast notification. ## -property-value A set of values that you can use to obtain the user input from an interactive toast notification. This information consists of pairs of keys and values, in which the keys are the identifiers for the elements for which the user provided input and the values represent the input from the user. For elements that specify that the type of the input is text, the value is the string that the user specified. For elements that specify that the type of the input is an item that the user selects from a predefined list, the value is the identifier for the item that the user selected. ## -remarks ## -examples ## -see-also [ValueSet](../windows.foundation.collections/valueset.md), [ToastNotificationActivatedEventArgs.UserInput](toastnotificationactivatedeventargs_userinput.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.UserInput +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IToastNotificationActivatedEventArgs.UserInput + +## -description +Gets a set of values that you can use to obtain the user input from an interactive toast notification. + +## -property-value +A set of values that you can use to obtain the user input from an interactive toast notification. + +This information consists of pairs of keys and values, in which the keys are the identifiers for the elements for which the user provided input and the values represent the input from the user. For elements that specify that the type of the input is text, the value is the string that the user specified. For elements that specify that the type of the input is an item that the user selects from a predefined list, the value is the identifier for the item that the user selected. + +## -remarks + +## -examples + +## -see-also +[ValueSet](../windows.foundation.collections/valueset.md), [ToastNotificationActivatedEventArgs.UserInput](toastnotificationactivatedeventargs_userinput.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/iuserdataaccountprovideractivatedeventargs_operation.md b/windows.applicationmodel.activation/iuserdataaccountprovideractivatedeventargs_operation.md index 043cea7910..0cc87bfe08 100644 --- a/windows.applicationmodel.activation/iuserdataaccountprovideractivatedeventargs_operation.md +++ b/windows.applicationmodel.activation/iuserdataaccountprovideractivatedeventargs_operation.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IUserDataAccountProviderActivatedEventArgs.Operation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IUserDataAccountProviderActivatedEventArgs.Operation ## -description Gets the user account management operation. ## -property-value The user account management operation. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IUserDataAccountProviderActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IUserDataAccountProviderActivatedEventArgs.Operation + +## -description +Gets the user account management operation. + +## -property-value +The user account management operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.activation/iviewswitcherprovider_viewswitcher.md b/windows.applicationmodel.activation/iviewswitcherprovider_viewswitcher.md index 572ecb5fbc..ee97dd221f 100644 --- a/windows.applicationmodel.activation/iviewswitcherprovider_viewswitcher.md +++ b/windows.applicationmodel.activation/iviewswitcherprovider_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IViewSwitcherProvider.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IViewSwitcherProvider.ViewSwitcher ## -description Provides the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IViewSwitcherProvider.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IViewSwitcherProvider.ViewSwitcher + +## -description +Provides the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/ivoicecommandactivatedeventargs_result.md b/windows.applicationmodel.activation/ivoicecommandactivatedeventargs_result.md index 2f8daf4800..66b209646d 100644 --- a/windows.applicationmodel.activation/ivoicecommandactivatedeventargs_result.md +++ b/windows.applicationmodel.activation/ivoicecommandactivatedeventargs_result.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IVoiceCommandActivatedEventArgs.Result --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IVoiceCommandActivatedEventArgs.Result ## -description Gets the [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice command that activated the app. ## -property-value The [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice commands that activated the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IVoiceCommandActivatedEventArgs.Result +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IVoiceCommandActivatedEventArgs.Result + +## -description +Gets the [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice command that activated the app. + +## -property-value +The [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice commands that activated the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionid.md b/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionid.md index d9ec653b0e..fc52817205 100644 --- a/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionid.md +++ b/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionId ## -description Gets the ID of the action, such as the id of the verb, transaction and so on. ## -property-value The ID of the action, such as the id of the verb, transaction and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionId + +## -description +Gets the ID of the action, such as the id of the verb, transaction and so on. + +## -property-value +The ID of the action, such as the id of the verb, transaction and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionkind.md b/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionkind.md index 7d38212041..e87d997b34 100644 --- a/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionkind.md +++ b/windows.applicationmodel.activation/iwalletactionactivatedeventargs_actionkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionKind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionKind ## -description Gets the action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -property-value The action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ActionKind + +## -description +Gets the action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -property-value +The action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iwalletactionactivatedeventargs_itemid.md b/windows.applicationmodel.activation/iwalletactionactivatedeventargs_itemid.md index a61b9ab7b3..6aabaf1263 100644 --- a/windows.applicationmodel.activation/iwalletactionactivatedeventargs_itemid.md +++ b/windows.applicationmodel.activation/iwalletactionactivatedeventargs_itemid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ItemId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ItemId ## -description Gets the ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. ## -property-value The ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ItemId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IWalletActionActivatedEventArgs.ItemId + +## -description +Gets the ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. + +## -property-value +The ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iwebaccountprovideractivatedeventargs_operation.md b/windows.applicationmodel.activation/iwebaccountprovideractivatedeventargs_operation.md index 52b8625714..57f5b453ea 100644 --- a/windows.applicationmodel.activation/iwebaccountprovideractivatedeventargs_operation.md +++ b/windows.applicationmodel.activation/iwebaccountprovideractivatedeventargs_operation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IWebAccountProviderActivatedEventArgs.Operation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IWebAccountProviderActivatedEventArgs.Operation ## -description Gets the web account provider operation. ## -property-value The web account provider operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IWebAccountProviderActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IWebAccountProviderActivatedEventArgs.Operation + +## -description +Gets the web account provider operation. + +## -property-value +The web account provider operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/iwebauthenticationbrokercontinuationeventargs_webauthenticationresult.md b/windows.applicationmodel.activation/iwebauthenticationbrokercontinuationeventargs_webauthenticationresult.md index 6ebfb3ba3a..53de68e81d 100644 --- a/windows.applicationmodel.activation/iwebauthenticationbrokercontinuationeventargs_webauthenticationresult.md +++ b/windows.applicationmodel.activation/iwebauthenticationbrokercontinuationeventargs_webauthenticationresult.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.IWebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult --api-type: winrt property ---- # Windows.ApplicationModel.Activation.IWebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult ## -description Gets the [WebAuthenticationResult](../windows.security.authentication.web/webauthenticationresult.md) object returned from the web authentication broker operation. ## -property-value The result of the web authentication broker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.IWebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IWebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult + +## -description +Gets the [WebAuthenticationResult](../windows.security.authentication.web/webauthenticationresult.md) object returned from the web authentication broker operation. + +## -property-value +The result of the web authentication broker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_arguments.md b/windows.applicationmodel.activation/launchactivatedeventargs_arguments.md index 764f72041c..c4096328a2 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_arguments.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_arguments.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Arguments --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Arguments ## -description Gets the arguments that are passed to the app during its launch activation. ## -property-value The list of arguments. This value can be used to control the behavior of the app when it is launched through a secondary tile or through a toast. ## -remarks These arguments provide additional context for this activation. Similar to command-line arguments, this string can be parsed by an app to determine what action it should take in response to this activation. This argument string comes from a property such as [SecondaryTile.Arguments](../windows.ui.startscreen/secondarytile_arguments.md) or a toast's XML payload, through the *launch* attribute of the [toast](XREF:TODO:toast.element_toast) element or the *arguments* attribute of the [command](XREF:TODO:toast.element_command) element. > [!NOTE] > An app should always regard the arguments string as untrusted data and must parse and validate the string carefully before taking action based on its contents. Blindly using the arguments string without examining it first can present a security risk. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Arguments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Arguments + +## -description +Gets the arguments that are passed to the app during its launch activation. + +## -property-value +The list of arguments. This value can be used to control the behavior of the app when it is launched through a secondary tile or through a toast. + +## -remarks +These arguments provide additional context for this activation. Similar to command-line arguments, this string can be parsed by an app to determine what action it should take in response to this activation. This argument string comes from a property such as [SecondaryTile.Arguments](../windows.ui.startscreen/secondarytile_arguments.md) or a toast's XML payload, through the *launch* attribute of the [toast](XREF:TODO:toast.element_toast) element or the *arguments* attribute of the [command](XREF:TODO:toast.element_command) element. + + + +> [!NOTE] +> An app should always regard the arguments string as untrusted data and must parse and validate the string carefully before taking action based on its contents. Blindly using the arguments string without examining it first can present a security risk. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/launchactivatedeventargs_currentlyshownapplicationviewid.md index b74bffa486..909f237689 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_kind.md b/windows.applicationmodel.activation/launchactivatedeventargs_kind.md index 87448a2ab1..cc1597c29d 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Kind ## -description Gets the reason that this app is being activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.Kind + +## -description +Gets the reason that this app is being activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_prelaunchactivated.md b/windows.applicationmodel.activation/launchactivatedeventargs_prelaunchactivated.md index 32cac03c1f..7895734f5f 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_prelaunchactivated.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_prelaunchactivated.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PrelaunchActivated --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PrelaunchActivated ## -description Indicates whether the app was pre-launched. ## -property-value Indicates whether the app was pre-launched. **TRUE** indicates it was; otherwise, **FALSE**. ## -remarks When available system resources allow, the startup performance of Windows Store app is improved by proactively launching the user’s most frequently used apps in the background. See [Handle app prelaunch](http://msdn.microsoft.com/library/a4838ac2-22d7-46ba-9eb2-f3c248e22f52) for details. ## -examples ## -see-also [Handle app prelaunch](http://msdn.microsoft.com/library/a4838ac2-22d7-46ba-9eb2-f3c248e22f52) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PrelaunchActivated +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PrelaunchActivated + +## -description +Indicates whether the app was pre-launched. + +## -property-value +Indicates whether the app was pre-launched. **TRUE** indicates it was; otherwise, **FALSE**. + +## -remarks +When available system resources allow, the startup performance of Windows Store app is improved by proactively launching the user’s most frequently used apps in the background. See [Handle app prelaunch](http://msdn.microsoft.com/library/a4838ac2-22d7-46ba-9eb2-f3c248e22f52) for details. + +## -examples + +## -see-also +[Handle app prelaunch](http://msdn.microsoft.com/library/a4838ac2-22d7-46ba-9eb2-f3c248e22f52) \ No newline at end of file diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/launchactivatedeventargs_previousexecutionstate.md index b6ba5c79e9..52d21db045 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before this activation. ## -property-value One of the enumeration values. ## -remarks The app uses this information to determine whether it should restore saved state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before this activation. + +## -property-value +One of the enumeration values. + +## -remarks +The app uses this information to determine whether it should restore saved state. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/launchactivatedeventargs_splashscreen.md index fe4e65dddb..9746736cb7 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_splashscreen.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks This property is only meaningful when the app is activated under a contract that expects a window to be presented. If the contract doesn't require a window or if the app is being activated for a background task, this call will fail. You can listen for the [SplashScreen.Dismissed](splashscreen_dismissed.md) event to trigger additional loading tasks. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks +This property is only meaningful when the app is activated under a contract that expects a window to be presented. If the contract doesn't require a window or if the app is being activated for a background task, this call will fail. + +You can listen for the [SplashScreen.Dismissed](splashscreen_dismissed.md) event to trigger additional loading tasks. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_tileactivatedinfo.md b/windows.applicationmodel.activation/launchactivatedeventargs_tileactivatedinfo.md index e852689634..2a4a45c942 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_tileactivatedinfo.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_tileactivatedinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileActivatedInfo --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileActivatedInfo ## -description Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property. ## -property-value Information about the tile that launched the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileActivatedInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileActivatedInfo + +## -description +Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property. + +## -property-value +Information about the tile that launched the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_tileid.md b/windows.applicationmodel.activation/launchactivatedeventargs_tileid.md index 66f2b2180d..8f0a26a531 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_tileid.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_tileid.md @@ -1,3 +1,52 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileId ## -description Gets the ID of the tile that was invoked to launch the app. ## -property-value The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the [SecondaryTile.TileId](../windows.ui.startscreen/secondarytile_tileid.md) value, assigned to the secondary tile when it was created, is returned. ## -remarks Starting with Windows 10, **TileId** behavior is different for apps that are launched after having been terminated. Previously, the **TileId** always returned the ID of the tile that launched the app. The **TileId** behavior now depends on how the app is reactivated:
How the app is reactivatedBehavior of **TileId**
The user switches to the app by using the task switcher or by using the global back keyReturns the empty string `("")`.
The user taps the app tileReturns the tile ID.
The new behavior makes it possible to differentiate between a switch to the app versus a re-launch of the app. If your app uses tile ID information during activation, handle the `TileId==""` case. For example: ```csharp protected override void OnLaunched(LaunchActivatedEventArgs e) { ... if (e.TileId == "") { // resumed from switch/backstack } else { // resumed from tile launch } ... } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.TileId + +## -description +Gets the ID of the tile that was invoked to launch the app. + + + + +## -property-value +The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the [SecondaryTile.TileId](../windows.ui.startscreen/secondarytile_tileid.md) value, assigned to the secondary tile when it was created, is returned. + +## -remarks +Starting with Windows 10, **TileId** behavior is different for apps that are launched after having been terminated. Previously, the **TileId** always returned the ID of the tile that launched the app. The **TileId** behavior now depends on how the app is reactivated: + + + +
How the app is reactivatedBehavior of **TileId**
The user switches to the app by using the task switcher or by using the global back keyReturns the empty string `("")`.
The user taps the app tileReturns the tile ID.
+ +The new behavior makes it possible to differentiate between a switch to the app versus a re-launch of the app. If your app uses tile ID information during activation, handle the `TileId==""` case. For example: + + + +```csharp +protected override void OnLaunched(LaunchActivatedEventArgs e) +{ +... + if (e.TileId == "") + { + // resumed from switch/backstack + } + else + { + // resumed from tile launch + } +... +} +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_user.md b/windows.applicationmodel.activation/launchactivatedeventargs_user.md index b43c11828a..d31b3275dc 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/launchactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/launchactivatedeventargs_viewswitcher.md index c48eb4b36a..cefb6e8e37 100644 --- a/windows.applicationmodel.activation/launchactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/launchactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value The view switcher ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LaunchActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +The view switcher + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreenactivatedeventargs.md b/windows.applicationmodel.activation/lockscreenactivatedeventargs.md index fbe255abc3..b2240a9a92 100644 --- a/windows.applicationmodel.activation/lockscreenactivatedeventargs.md +++ b/windows.applicationmodel.activation/lockscreenactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs ## -description Provides information about an event that occurs when the app is activated as the lock screen. ## -remarks [LockScreenActivatedEventArgs](lockscreenactivatedeventargs.md) is passed to the event handler that you implement for the activation event that occurs when the app is activated as the lock screen. ## -examples ## -see-also [ILockScreenActivatedEventArgs](ilockscreenactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs + +## -description +Provides information about an event that occurs when the app is activated as the lock screen. + +## -remarks +[LockScreenActivatedEventArgs](lockscreenactivatedeventargs.md) is passed to the event handler that you implement for the activation event that occurs when the app is activated as the lock screen. + +## -examples + +## -see-also +[ILockScreenActivatedEventArgs](ilockscreenactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreenactivatedeventargs_info.md b/windows.applicationmodel.activation/lockscreenactivatedeventargs_info.md index 5047b84c52..c6b04cadfd 100644 --- a/windows.applicationmodel.activation/lockscreenactivatedeventargs_info.md +++ b/windows.applicationmodel.activation/lockscreenactivatedeventargs_info.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Info --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Info ## -description Gets an object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. ## -property-value An object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. ## -remarks ## -examples ## -see-also [LockScreenInfo](../windows.applicationmodel.lockscreen/lockscreeninfo.md), [ILockScreenActivatedEventArgs.Info](ilockscreenactivatedeventargs_info.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Info +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Info + +## -description +Gets an object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. + +## -property-value +An object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data. + +## -remarks + +## -examples + +## -see-also +[LockScreenInfo](../windows.applicationmodel.lockscreen/lockscreeninfo.md), [ILockScreenActivatedEventArgs.Info](ilockscreenactivatedeventargs_info.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreenactivatedeventargs_kind.md b/windows.applicationmodel.activation/lockscreenactivatedeventargs_kind.md index 3caa1dc0fd..669fb7807b 100644 --- a/windows.applicationmodel.activation/lockscreenactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/lockscreenactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Kind ## -description Gets the reason for the activation of the app for this event. ## -property-value The reason for the activation of the app for this event. For the event that occurs when an app is activated as the lock screen, this value is **ActivationKind.LockScreen**. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md), [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.Kind + +## -description +Gets the reason for the activation of the app for this event. + +## -property-value +The reason for the activation of the app for this event. For the event that occurs when an app is activated as the lock screen, this value is **ActivationKind.LockScreen**. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md), [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreenactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/lockscreenactivatedeventargs_previousexecutionstate.md index 3bce4ce9c0..ef6de39ddf 100644 --- a/windows.applicationmodel.activation/lockscreenactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/lockscreenactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before the app was activated as the lock screen. ## -property-value The execution state of the app before the app was activated as the lock screen. ## -remarks ## -examples ## -see-also [ApplicationExecutionState](applicationexecutionstate.md), [IActivatedEventArgs.PreviousExecutionState](iactivatedeventargs_previousexecutionstate.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before the app was activated as the lock screen. + +## -property-value +The execution state of the app before the app was activated as the lock screen. + +## -remarks + +## -examples + +## -see-also +[ApplicationExecutionState](applicationexecutionstate.md), [IActivatedEventArgs.PreviousExecutionState](iactivatedeventargs_previousexecutionstate.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreenactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/lockscreenactivatedeventargs_splashscreen.md index 440fa403e6..d0ee95a1aa 100644 --- a/windows.applicationmodel.activation/lockscreenactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/lockscreenactivatedeventargs_splashscreen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The splash screen object that provides information about the transition from the splash screen to the activated app. ## -remarks ## -examples ## -see-also [SplashScreen](splashscreen.md), [IActivatedEventArgs.SplashScreen](iactivatedeventargs_splashscreen.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The splash screen object that provides information about the transition from the splash screen to the activated app. + +## -remarks + +## -examples + +## -see-also +[SplashScreen](splashscreen.md), [IActivatedEventArgs.SplashScreen](iactivatedeventargs_splashscreen.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs.md index 8d4203e38b..4e32ca5fb7 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs ## -description Provides event information when communication to and from the lock screen is required. > **JavaScript** > This type appears as [WebUILockScreenCallActivatedEventArgs](../windows.ui.webui/webuilockscreencallactivatedeventargs.md). ## -remarks This object is accessed when you respond to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **LockScreenCall**. ## -examples ## -see-also [ILockScreenCallActivatedEventArgs](ilockscreencallactivatedeventargs.md), [ILaunchActivatedEventArgs](ilaunchactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs + +## -description +Provides event information when communication to and from the lock screen is required. + + + +> **JavaScript** +> This type appears as [WebUILockScreenCallActivatedEventArgs](../windows.ui.webui/webuilockscreencallactivatedeventargs.md). + +## -remarks +This object is accessed when you respond to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **LockScreenCall**. + +## -examples + +## -see-also +[ILockScreenCallActivatedEventArgs](ilockscreencallactivatedeventargs.md), [ILaunchActivatedEventArgs](ilaunchactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_arguments.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_arguments.md index 2fa50b60f1..c797a16e75 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_arguments.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_arguments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Arguments --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Arguments ## -description Gets the arguments that are passed to the app to launch it. ## -property-value The list of arguments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Arguments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Arguments + +## -description +Gets the arguments that are passed to the app to launch it. + +## -property-value +The list of arguments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_callui.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_callui.md index 3776ac79f1..e10fef98a6 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_callui.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_callui.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CallUI --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CallUI ## -description Gets the UI that handles communication to and from the lock screen. ## -property-value The UI that handles communication to and from the lock screen. ## -remarks ## -examples ## -see-also [LockScreenCallUI](../windows.applicationmodel.calls/lockscreencallui.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CallUI +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CallUI + +## -description +Gets the UI that handles communication to and from the lock screen. + +## -property-value +The UI that handles communication to and from the lock screen. + +## -remarks + +## -examples + +## -see-also +[LockScreenCallUI](../windows.applicationmodel.calls/lockscreencallui.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_currentlyshownapplicationviewid.md index c8974150eb..e18fcb4e18 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_kind.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_kind.md index 037a526eb0..241846e7c8 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.LockScreenCall](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.LockScreenCall](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_previousexecutionstate.md index f34a014a4a..df790f1d33 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_splashscreen.md index b28e038e64..56f77045fa 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_tileid.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_tileid.md index df5caebdc6..9205f2d64b 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_tileid.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_tileid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.TileId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.TileId ## -description Gets the identifier of the source that launched the app. ## -property-value The identifier of the tile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.TileId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.TileId + +## -description +Gets the identifier of the source that launched the app. + +## -property-value +The identifier of the tile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_viewswitcher.md index d95b563fcd..95bc4bc0f8 100644 --- a/windows.applicationmodel.activation/lockscreencallactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/lockscreencallactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenCallActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs.md b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs.md index a8809955f8..6147045b7c 100644 --- a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs.md +++ b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs ## -description Provides data for the Activated event when it occurs after a picker returns. ## -remarks ## -examples ## -see-also [IPickerReturnedActivatedEventArgs](ipickerreturnedactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs + +## -description +Provides data for the Activated event when it occurs after a picker returns. + +## -remarks + + +## -examples + +## -see-also +[IPickerReturnedActivatedEventArgs](ipickerreturnedactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_kind.md b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_kind.md index f63b02625e..30882ee206 100644 --- a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.Kind ## -description Gets the reason that this app is being activated. ## -property-value The reason that this app is being activated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.Kind + +## -description +Gets the reason that this app is being activated. + +## -property-value +The reason that this app is being activated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_pickeroperationid.md b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_pickeroperationid.md index 9c4b81425f..08dc6a8bf2 100644 --- a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_pickeroperationid.md +++ b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_pickeroperationid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PickerOperationId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PickerOperationId ## -description Gets an identifier indicating the picker operation that was performed prior to the activation. ## -property-value An application-defined identifier indicating the picker operation that was performed prior to the activation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PickerOperationId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PickerOperationId + +## -description +Gets an identifier indicating the picker operation that was performed prior to the activation. + +## -property-value +An application-defined identifier indicating the picker operation that was performed prior to the activation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_previousexecutionstate.md index 956e242e1b..f861be9f7b 100644 --- a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before this activation. ## -property-value The execution state of the app before this activation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before this activation. + +## -property-value +The execution state of the app before this activation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_splashscreen.md index 019442f9b0..5590f8f173 100644 --- a/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/pickerreturnedactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The splash screen object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PickerReturnedActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The splash screen object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs.md b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs.md index dded3ac52f..fba7925a99 100644 --- a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs.md +++ b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs ## -description Provides information about an event that occurs when the app is launched as a 3D printing workflow. ## -remarks [Print3DWorkflowActivatedEventArgs](print3dworkflowactivatedeventargs.md) is passed to the event handler that you implement for the activation event that occurs when the app is launched as a workflow for three-dimensional printing. ## -examples ## -see-also [IPrint3DWorkflowActivatedEventArgs](iprint3dworkflowactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs + +## -description +Provides information about an event that occurs when the app is launched as a 3D printing workflow. + +## -remarks +[Print3DWorkflowActivatedEventArgs](print3dworkflowactivatedeventargs.md) is passed to the event handler that you implement for the activation event that occurs when the app is launched as a workflow for three-dimensional printing. + +## -examples + +## -see-also +[IPrint3DWorkflowActivatedEventArgs](iprint3dworkflowactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_kind.md b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_kind.md index 81705efebb..21af777fdf 100644 --- a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.Print3DWorkflow](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md), [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.Print3DWorkflow](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md), [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_previousexecutionstate.md index 070d787210..b659f5ee29 100644 --- a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also [ApplicationExecutionState](applicationexecutionstate.md), [IActivatedEventArgs.PreviousExecutionState](iactivatedeventargs_previousexecutionstate.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also +[ApplicationExecutionState](applicationexecutionstate.md), [IActivatedEventArgs.PreviousExecutionState](iactivatedeventargs_previousexecutionstate.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_splashscreen.md index f2f808b3c3..0e75e36118 100644 --- a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_splashscreen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also [SplashScreen](splashscreen.md), [IActivatedEventArgs.SplashScreen](iactivatedeventargs_splashscreen.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also +[SplashScreen](splashscreen.md), [IActivatedEventArgs.SplashScreen](iactivatedeventargs_splashscreen.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_workflow.md b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_workflow.md index 36b0f194a4..ec83c9cc96 100644 --- a/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_workflow.md +++ b/windows.applicationmodel.activation/print3dworkflowactivatedeventargs_workflow.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Workflow --api-type: winrt property ---- # Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Workflow ## -description Gets a customized printing experience for a 3D printer. ## -property-value The customized printing experience for a 3D printer. ## -remarks ## -examples ## -see-also [Print3DWorkflow](../windows.devices.printers.extensions/print3dworkflow.md), [IPrint3DWorkflowActivatedEventArgs.Workflow](iprint3dworkflowactivatedeventargs_workflow.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Workflow +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.Print3DWorkflowActivatedEventArgs.Workflow + +## -description +Gets a customized printing experience for a 3D printer. + +## -property-value +The customized printing experience for a 3D printer. + +## -remarks + +## -examples + +## -see-also +[Print3DWorkflow](../windows.devices.printers.extensions/print3dworkflow.md), [IPrint3DWorkflowActivatedEventArgs.Workflow](iprint3dworkflowactivatedeventargs_workflow.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_configuration.md b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_configuration.md index cee23ac77c..6840ddd992 100644 --- a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_configuration.md +++ b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_configuration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Configuration --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Configuration ## -description Gets the configuration information for the print task. ## -property-value The print task configuration information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Configuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Configuration + +## -description +Gets the configuration information for the print task. + +## -property-value +The print task configuration information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_kind.md b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_kind.md index 200b47440c..4d4a7b3b91 100644 --- a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Kind ## -description Gets the activation type for the print task settings. ## -property-value The type of activation for the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.Kind + +## -description +Gets the activation type for the print task settings. + +## -property-value +The type of activation for the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_previousexecutionstate.md index 1ff1a5d2d7..8d469b014d 100644 --- a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before the settings were activated. ## -property-value The execution state of the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before the settings were activated. + +## -property-value +The execution state of the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_splashscreen.md index 4af31860bc..d5b7777295 100644 --- a/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/printtasksettingsactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintTaskSettingsActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_callerpackagefamilyname.md b/windows.applicationmodel.activation/protocolactivatedeventargs_callerpackagefamilyname.md index ae6afbd3c7..1e08e607d8 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CallerPackageFamilyName ## -description Gets the package family name of the application that activated the current application. ## -property-value The package family name of the application that activated the current application. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CallerPackageFamilyName + +## -description +Gets the package family name of the application that activated the current application. + +## -property-value +The package family name of the application that activated the current application. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/protocolactivatedeventargs_currentlyshownapplicationviewid.md index 0cc0be60ca..a3a0c039fa 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_data.md b/windows.applicationmodel.activation/protocolactivatedeventargs_data.md index 3647e0878c..42520355f5 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_data.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Data --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Data ## -description Data received from the application that activated the current application. ## -property-value User-defined data. May be **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Data + +## -description +Data received from the application that activated the current application. + +## -property-value +User-defined data. May be **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_kind.md b/windows.applicationmodel.activation/protocolactivatedeventargs_kind.md index 0227f6542f..420a04c594 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/protocolactivatedeventargs_previousexecutionstate.md index 1bb8c8c5bc..8f97b302a3 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/protocolactivatedeventargs_splashscreen.md index 32ec3e77ab..5046b19cb6 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_splashscreen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_uri.md b/windows.applicationmodel.activation/protocolactivatedeventargs_uri.md index 6d1034cd9e..50decbf09b 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_uri.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_uri.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Uri ## -description Gets the Uniform Resource Identifier (URI) for which the app was activated. ## -property-value The Uniform Resource Identifier (URI). ## -remarks ## -examples ## -see-also [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f), [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.Uri + +## -description +Gets the Uniform Resource Identifier (URI) for which the app was activated. + +## -property-value +The Uniform Resource Identifier (URI). + +## -remarks + +## -examples + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151), [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be), [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f), [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [Windows.UI.Core.CoreApplicationView.Activated](../windows.applicationmodel.core/coreapplicationview_activated.md), [Windows.UI.Xaml.Application.OnActivated](../windows.ui.xaml/application_onactivated.md), [URI](../windows.foundation/uri.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_user.md b/windows.applicationmodel.activation/protocolactivatedeventargs_user.md index 485668903d..e09cc6ff0c 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/protocolactivatedeventargs_viewswitcher.md index 7677f0ef4d..29ce828fa0 100644 --- a/windows.applicationmodel.activation/protocolactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/protocolactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs.md index b36c7c850e..4d308e5333 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs ## -description Received by an application when it is launched by another application with the expectation that it will return results back to the caller. ## -remarks You access a [ProtocolForResultsActivatedEventArgs](protocolforresultsactivatedeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **ProtocolForResults**. ## -examples ## -see-also [IActivatedEventArgs](iactivatedeventargs.md), [IProtocolActivatedEventArgs](iprotocolactivatedeventargs.md), [IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData](iprotocolactivatedeventargswithcallerpackagefamilynameanddata.md), [IApplicationViewActivatedEventArgs](iapplicationviewactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs + +## -description +Received by an application when it is launched by another application with the expectation that it will return results back to the caller. + +## -remarks +You access a [ProtocolForResultsActivatedEventArgs](protocolforresultsactivatedeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **ProtocolForResults**. + +## -examples + +## -see-also +[IActivatedEventArgs](iactivatedeventargs.md), [IProtocolActivatedEventArgs](iprotocolactivatedeventargs.md), [IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData](iprotocolactivatedeventargswithcallerpackagefamilynameanddata.md), [IApplicationViewActivatedEventArgs](iapplicationviewactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_callerpackagefamilyname.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_callerpackagefamilyname.md index e579d58cf8..c1bc61ab69 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_callerpackagefamilyname.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_callerpackagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CallerPackageFamilyName ## -description Gets the package family name of the application that activated the current application. ## -property-value The package family name of the application that activated the current application. ## -remarks If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CallerPackageFamilyName + +## -description +Gets the package family name of the application that activated the current application. + +## -property-value +The package family name of the application that activated the current application. + +## -remarks +If the caller is a non-packaged app (such as a Win32 app), *CallerPackageFamilyName* will be empty, that is `""`. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_currentlyshownapplicationviewid.md index da2ae93116..00cbc28438 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_data.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_data.md index 0790f923ca..4a780955f7 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_data.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Data --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Data ## -description Data received from the application that activated the current application. ## -property-value User-defined data. May be **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Data + +## -description +Data received from the application that activated the current application. + +## -property-value +User-defined data. May be **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_kind.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_kind.md index c82bfa2caa..8da2f5c045 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value A enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +A enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_previousexecutionstate.md index 0510004b8a..f300903948 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value An [ApplicationExecutionState](applicationexecutionstate.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +An [ApplicationExecutionState](applicationexecutionstate.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_protocolforresultsoperation.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_protocolforresultsoperation.md index fe2f64b501..ff0b41f688 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_protocolforresultsoperation.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_protocolforresultsoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation ## -description Gets the **ProtocolForResultsOperation** that you use to signal that your app is ready to return to the app that launched it for results. ## -property-value The **ProtocolForResultsOperation** object that you can use to signal that your app is ready to return by calling its [ProtocolForResultsOperation.ReportCompleted](../windows.system/protocolforresultsoperation_reportcompleted.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ProtocolForResultsOperation + +## -description +Gets the **ProtocolForResultsOperation** that you use to signal that your app is ready to return to the app that launched it for results. + +## -property-value +The **ProtocolForResultsOperation** object that you can use to signal that your app is ready to return by calling its [ProtocolForResultsOperation.ReportCompleted](../windows.system/protocolforresultsoperation_reportcompleted.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_splashscreen.md index 4a767118d1..4dc49b7d83 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.SplashScreen ## -description Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.SplashScreen + +## -description +Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_uri.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_uri.md index 4850d0a9d6..3a9625b737 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_uri.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_uri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Uri ## -description Gets the Uniform Resource Identifier (URI) used to activate the app. ## -property-value The Uniform Resource Identifier (URI). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.Uri + +## -description +Gets the Uniform Resource Identifier (URI) used to activate the app. + +## -property-value +The Uniform Resource Identifier (URI). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_viewswitcher.md index f92f9a82f3..14075a769b 100644 --- a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs.md b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs.md index 646c67ea7e..c73139cc30 100644 --- a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs.md +++ b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs ## -description Provides event information when a restricted app is launched. > **JavaScript** > This type appears as [WebUIRestrictedLaunchActivatedEventArgs](../windows.ui.webui/webuirestrictedlaunchactivatedeventargs.md). ## -remarks This object is accessed when you respond to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **RestrictedLaunch**. ## -examples ## -see-also [IRestrictedLaunchActivatedEventArgs](irestrictedlaunchactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs + +## -description +Provides event information when a restricted app is launched. + + + +> **JavaScript** +> This type appears as [WebUIRestrictedLaunchActivatedEventArgs](../windows.ui.webui/webuirestrictedlaunchactivatedeventargs.md). + +## -remarks +This object is accessed when you respond to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **RestrictedLaunch**. + +## -examples + +## -see-also +[IRestrictedLaunchActivatedEventArgs](irestrictedlaunchactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_kind.md b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_kind.md index 485b391054..8edf48e620 100644 --- a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.RestrictedLaunch](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.RestrictedLaunch](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_previousexecutionstate.md index a8a423863d..f3b8c12a42 100644 --- a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_sharedcontext.md b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_sharedcontext.md index fad3cfdbc3..0e948120a7 100644 --- a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_sharedcontext.md +++ b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_sharedcontext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SharedContext --api-type: winrt property ---- # Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SharedContext ## -description Gets information about a shared context for the restricted launch. ## -property-value The object that provides shared context information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SharedContext +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SharedContext + +## -description +Gets information about a shared context for the restricted launch. + +## -property-value +The object that provides shared context information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_splashscreen.md index 4bea8dd9d6..0ea2feddf0 100644 --- a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_user.md b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_user.md index a864aa362f..f9d4ae2335 100644 --- a/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/restrictedlaunchactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.RestrictedLaunchActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/searchactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/searchactivatedeventargs_currentlyshownapplicationviewid.md index 5c9def56a0..1a46de3074 100644 --- a/windows.applicationmodel.activation/searchactivatedeventargs_currentlyshownapplicationviewid.md +++ b/windows.applicationmodel.activation/searchactivatedeventargs_currentlyshownapplicationviewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.CurrentlyShownApplicationViewId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.SearchActivatedEventArgs.CurrentlyShownApplicationViewId ## -description Gets the identifier for the currently shown app view. ## -property-value The identifier for the currently shown app view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.SearchActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description +Gets the identifier for the currently shown app view. + +## -property-value +The identifier for the currently shown app view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/searchactivatedeventargs_linguisticdetails.md b/windows.applicationmodel.activation/searchactivatedeventargs_linguisticdetails.md index 7dc5176023..62f1e8de0b 100644 --- a/windows.applicationmodel.activation/searchactivatedeventargs_linguisticdetails.md +++ b/windows.applicationmodel.activation/searchactivatedeventargs_linguisticdetails.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.LinguisticDetails --api-type: winrt property ---- # Windows.ApplicationModel.Activation.SearchActivatedEventArgs.LinguisticDetails ## -description Gets a [SearchPaneQueryLinguisticDetails](../windows.applicationmodel.search/searchpanequerylinguisticdetails.md) object that provides info about query text that the user enters through an Input Method Editor (IME). ## -property-value The object that provides info about query text. ## -remarks ## -examples ## -see-also [SearchPaneQueryLinguisticDetails](../windows.applicationmodel.search/searchpanequerylinguisticdetails.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.LinguisticDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.SearchActivatedEventArgs.LinguisticDetails + +## -description +Gets a [SearchPaneQueryLinguisticDetails](../windows.applicationmodel.search/searchpanequerylinguisticdetails.md) object that provides info about query text that the user enters through an Input Method Editor (IME). + +## -property-value +The object that provides info about query text. + +## -remarks + +## -examples + +## -see-also +[SearchPaneQueryLinguisticDetails](../windows.applicationmodel.search/searchpanequerylinguisticdetails.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/searchactivatedeventargs_user.md b/windows.applicationmodel.activation/searchactivatedeventargs_user.md index 697ddc8ebf..ff7f8e5d96 100644 --- a/windows.applicationmodel.activation/searchactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/searchactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.SearchActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.SearchActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/searchactivatedeventargs_viewswitcher.md b/windows.applicationmodel.activation/searchactivatedeventargs_viewswitcher.md index f70395933e..26b22a672a 100644 --- a/windows.applicationmodel.activation/searchactivatedeventargs_viewswitcher.md +++ b/windows.applicationmodel.activation/searchactivatedeventargs_viewswitcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.ViewSwitcher --api-type: winrt property ---- # Windows.ApplicationModel.Activation.SearchActivatedEventArgs.ViewSwitcher ## -description Gets the view switcher object that allows you to set the view for the application. ## -property-value Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.SearchActivatedEventArgs.ViewSwitcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.SearchActivatedEventArgs.ViewSwitcher + +## -description +Gets the view switcher object that allows you to set the view for the application. + +## -property-value +Use the [ActivationViewSwitcher](../windows.ui.viewmanagement/activationviewswitcher.md) to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/sharetargetactivatedeventargs_kind.md b/windows.applicationmodel.activation/sharetargetactivatedeventargs_kind.md index ad07b1446e..5416b4400b 100644 --- a/windows.applicationmodel.activation/sharetargetactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/sharetargetactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/sharetargetactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/sharetargetactivatedeventargs_previousexecutionstate.md index 210c5bf728..99519e9f1e 100644 --- a/windows.applicationmodel.activation/sharetargetactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/sharetargetactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md b/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md index 65cb1b4945..0b24b7b596 100644 --- a/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md +++ b/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation ## -description Gets information about data included in a share operation. ## -property-value An object that includes the data included in a send operation. ## -remarks You can use the [ShareOperation](XREF:TODO:w_appmod_dataxfer_share.shareoperation) object to get the data that a user wants to send. It also contains methods your app can use to track the progress of the operation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation + +## -description +Gets information about data included in a share operation. + +## -property-value +An object that includes the data included in a send operation. + +## -remarks +You can use the [ShareOperation](XREF:TODO:w_appmod_dataxfer_share.shareoperation) object to get the data that a user wants to send. It also contains methods your app can use to track the progress of the operation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/sharetargetactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/sharetargetactivatedeventargs_splashscreen.md index 34b8000567..a1a2dab9e0 100644 --- a/windows.applicationmodel.activation/sharetargetactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/sharetargetactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/sharetargetactivatedeventargs_user.md b/windows.applicationmodel.activation/sharetargetactivatedeventargs_user.md index 1baa49283b..31a2f04325 100644 --- a/windows.applicationmodel.activation/sharetargetactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/sharetargetactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/tileactivatedinfo_recentlyshownnotifications.md b/windows.applicationmodel.activation/tileactivatedinfo_recentlyshownnotifications.md index cce4d72568..65b9ea4841 100644 --- a/windows.applicationmodel.activation/tileactivatedinfo_recentlyshownnotifications.md +++ b/windows.applicationmodel.activation/tileactivatedinfo_recentlyshownnotifications.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.TileActivatedInfo.RecentlyShownNotifications --api-type: winrt property ---- # Windows.ApplicationModel.Activation.TileActivatedInfo.RecentlyShownNotifications ## -description Gets the notifications that have been shown on the tile that activated your app from most recent to oldest. The first notification represents what was on the tile when the user clicked it. If the tile was blank, the list is empty. ## -property-value The tile notifications that have been shown from most recent to oldest. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.TileActivatedInfo.RecentlyShownNotifications +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.TileActivatedInfo.RecentlyShownNotifications + +## -description +Gets the notifications that have been shown on the tile that activated your app from most recent to oldest. The first notification represents what was on the tile when the user clicked it. If the tile was blank, the list is empty. + +## -property-value +The tile notifications that have been shown from most recent to oldest. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs.md index ec5ee4e937..ddaad76913 100644 --- a/windows.applicationmodel.activation/toastnotificationactivatedeventargs.md +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs ## -description Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. ## -remarks [ToastNotificationActivatedEventArgs](toastnotificationactivatedeventargs.md) is passed to the event handler that you implement for the activation event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. ## -examples ## -see-also [IToastNotificationActivatedEventArgs](itoastnotificationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs + +## -description +Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. + +## -remarks +[ToastNotificationActivatedEventArgs](toastnotificationactivatedeventargs.md) is passed to the event handler that you implement for the activation event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. + +## -examples + +## -see-also +[IToastNotificationActivatedEventArgs](itoastnotificationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_argument.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_argument.md index 3ceb2b6fa1..67ba6f6165 100644 --- a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_argument.md +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_argument.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Argument --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Argument ## -description Gets the arguments that the app can retrieve after it is activated through an interactive toast notification. ## -property-value The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value: + The **arguments** attribute of the element, if the user performs an action inside the interactive toast notification. + The **launch** attribute of the element, if the user simply clicks the body of the toast notification. ## -remarks ## -examples ## -see-also [IToastNotificationActivatedEventArgs.Argument](itoastnotificationactivatedeventargs_argument.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Argument +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Argument + +## -description +Gets the arguments that the app can retrieve after it is activated through an interactive toast notification. + +## -property-value +The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value: + + ++ The **arguments** attribute of the element, if the user performs an action inside the interactive toast notification. ++ The **launch** attribute of the element, if the user simply clicks the body of the toast notification. + + +## -remarks + +## -examples + +## -see-also +[IToastNotificationActivatedEventArgs.Argument](itoastnotificationactivatedeventargs_argument.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_kind.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_kind.md index 4bba316645..7e0dc6c0bd 100644 --- a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Kind ## -description Gets the reason for the activation of the app for this event. ## -property-value The reason for the activation of the app for this event. For the event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification, this value is **ActivationKind.ToastNotification**. ## -remarks ## -examples ## -see-also [ActivationKind](activationkind.md), [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.Kind + +## -description +Gets the reason for the activation of the app for this event. + +## -property-value +The reason for the activation of the app for this event. For the event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification, this value is **ActivationKind.ToastNotification**. + +## -remarks + +## -examples + +## -see-also +[ActivationKind](activationkind.md), [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_previousexecutionstate.md index 467ce48d75..c503526de5 100644 --- a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before the app was activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. ## -property-value The execution state of the app before the app was activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. ## -remarks ## -examples ## -see-also [ApplicationExecutionState](applicationexecutionstate.md), [IActivatedEventArgs.PreviousExecutionState](iactivatedeventargs_previousexecutionstate.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before the app was activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. + +## -property-value +The execution state of the app before the app was activated because a user tapped on the body of a toast notification or performed an action inside a toast notification. + +## -remarks + +## -examples + +## -see-also +[ApplicationExecutionState](applicationexecutionstate.md), [IActivatedEventArgs.PreviousExecutionState](iactivatedeventargs_previousexecutionstate.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_splashscreen.md index e0055d6ea7..c2165966e2 100644 --- a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_splashscreen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.SplashScreen ## -description Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value The splash screen object that provides information about the transition from the splash screen to the activated app. ## -remarks ## -examples ## -see-also [SplashScreen](splashscreen.md), [IActivatedEventArgs.SplashScreen](iactivatedeventargs_splashscreen.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The splash screen object that provides information about the transition from the splash screen to the activated app. + +## -remarks + +## -examples + +## -see-also +[SplashScreen](splashscreen.md), [IActivatedEventArgs.SplashScreen](iactivatedeventargs_splashscreen.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_userinput.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_userinput.md index fe5c2ba97b..d38f21bf6a 100644 --- a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_userinput.md +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_userinput.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.UserInput --api-type: winrt property ---- # Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.UserInput ## -description Gets a set of values that you can use to obtain the user input from an interactive toast notification. ## -property-value A set of values that you can use to obtain the user input from an interactive toast notification. This information consists of pairs of keys and values, in which the keys are the identifiers for the elements for which the user provided input and the values represent the input from the user. For elements that specify that the type of the input is text, the value is the string that the user specified. For elements that specify that the type of the input is an item that the user selects from a predefined list, the value is the identifier for the item that the user selected. ## -remarks ## -examples ## -see-also [ValueSet](../windows.foundation.collections/valueset.md), [IToastNotificationActivatedEventArgs.UserInput](itoastnotificationactivatedeventargs_userinput.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.UserInput +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.UserInput + +## -description +Gets a set of values that you can use to obtain the user input from an interactive toast notification. + +## -property-value +A set of values that you can use to obtain the user input from an interactive toast notification. + +This information consists of pairs of keys and values, in which the keys are the identifiers for the elements for which the user provided input and the values represent the input from the user. For elements that specify that the type of the input is text, the value is the string that the user specified. For elements that specify that the type of the input is an item that the user selects from a predefined list, the value is the identifier for the item that the user selected. + +## -remarks + +## -examples + +## -see-also +[ValueSet](../windows.foundation.collections/valueset.md), [IToastNotificationActivatedEventArgs.UserInput](itoastnotificationactivatedeventargs_userinput.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs.md b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs.md index de14d88eaa..b1dd53c121 100644 --- a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs.md +++ b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs ## -description Provides data when an app is activated to manage user accounts. ## -remarks Access this object by overriding either the Windows Library for JavaScript (WinJS) [onactivated](http://msdn.microsoft.com/library/8b1cf913-a914-47d1-a690-bc3f0931e9d4) event or the Extensible Application Markup Language (XAML) [OnActivated](../windows.ui.xaml/application_onactivated.md) method. ## -examples ## -see-also [IUserDataAccountProviderActivatedEventArgs](iuserdataaccountprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs + +## -description +Provides data when an app is activated to manage user accounts. + +## -remarks +Access this object by overriding either the Windows Library for JavaScript (WinJS) [onactivated](http://msdn.microsoft.com/library/8b1cf913-a914-47d1-a690-bc3f0931e9d4) event or the Extensible Application Markup Language (XAML) [OnActivated](../windows.ui.xaml/application_onactivated.md) method. + +## -examples + +## -see-also +[IUserDataAccountProviderActivatedEventArgs](iuserdataaccountprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_kind.md b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_kind.md index c212e802f0..5a923916d1 100644 --- a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_kind.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The activation type. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The activation type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_operation.md b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_operation.md index e48ef3b256..445e58b953 100644 --- a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_operation.md +++ b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_operation.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Operation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Operation ## -description Gets the user account management operation. ## -property-value The user account management operation. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.Operation + +## -description +Gets the user account management operation. + +## -property-value +The user account management operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_previousexecutionstate.md index 019b2a9d65..5b2058faf9 100644 --- a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value The execution state of the app before it was activated. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state of the app before it was activated. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_splashscreen.md index 7baed8192b..0668058757 100644 --- a/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/userdataaccountprovideractivatedeventargs_splashscreen.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.SplashScreen ## -description Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.UserDataAccountProviderActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.activation/voicecommandactivatedeventargs.md b/windows.applicationmodel.activation/voicecommandactivatedeventargs.md index 2083ca6d9e..89d349146e 100644 --- a/windows.applicationmodel.activation/voicecommandactivatedeventargs.md +++ b/windows.applicationmodel.activation/voicecommandactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs ## -description Contains info for the app's activated event when the app is launched through a voice command. ## -remarks Access this object by overriding either the Windows Library for JavaScript (WinJS) [onactivated](http://msdn.microsoft.com/library/8b1cf913-a914-47d1-a690-bc3f0931e9d4) event or the Extensible Application Markup Language (XAML) [OnActivated](../windows.ui.xaml/application_onactivated.md) method, when the value of [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **VoiceCommand**. ## -examples ## -see-also [IVoiceCommandActivatedEventArgs](ivoicecommandactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs + +## -description +Contains info for the app's activated event when the app is launched through a voice command. + +## -remarks +Access this object by overriding either the Windows Library for JavaScript (WinJS) [onactivated](http://msdn.microsoft.com/library/8b1cf913-a914-47d1-a690-bc3f0931e9d4) event or the Extensible Application Markup Language (XAML) [OnActivated](../windows.ui.xaml/application_onactivated.md) method, when the value of [IActivatedEventArgs.Kind](iactivatedeventargs_kind.md) is **VoiceCommand**. + +## -examples + +## -see-also +[IVoiceCommandActivatedEventArgs](ivoicecommandactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/voicecommandactivatedeventargs_kind.md b/windows.applicationmodel.activation/voicecommandactivatedeventargs_kind.md index 68f59b9822..51e469956c 100644 --- a/windows.applicationmodel.activation/voicecommandactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/voicecommandactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.VoiceCommand](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.VoiceCommand](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/voicecommandactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/voicecommandactivatedeventargs_previousexecutionstate.md index 407e41c7e6..cee1d7c6e6 100644 --- a/windows.applicationmodel.activation/voicecommandactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/voicecommandactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/voicecommandactivatedeventargs_result.md b/windows.applicationmodel.activation/voicecommandactivatedeventargs_result.md index 92d530a016..77cb992f82 100644 --- a/windows.applicationmodel.activation/voicecommandactivatedeventargs_result.md +++ b/windows.applicationmodel.activation/voicecommandactivatedeventargs_result.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Result --api-type: winrt property ---- # Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Result ## -description Gets the [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice command that activated the app. ## -property-value The [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice commands that activated the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Result +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.Result + +## -description +Gets the [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice command that activated the app. + +## -property-value +The [SpeechRecognitionResult](../windows.phone.speech.recognition/speechrecognitionresult.md) object representing the voice commands that activated the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/voicecommandactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/voicecommandactivatedeventargs_splashscreen.md index f257938478..bbd7d3d7ef 100644 --- a/windows.applicationmodel.activation/voicecommandactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/voicecommandactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.SplashScreen ## -description Gets info about the transition from the splash screen to the activated app. ## -property-value The splash screen transition info. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.SplashScreen + +## -description +Gets info about the transition from the splash screen to the activated app. + +## -property-value +The splash screen transition info. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/voicecommandactivatedeventargs_user.md b/windows.applicationmodel.activation/voicecommandactivatedeventargs_user.md index 0147ccb485..7917eebaed 100644 --- a/windows.applicationmodel.activation/voicecommandactivatedeventargs_user.md +++ b/windows.applicationmodel.activation/voicecommandactivatedeventargs_user.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.User --api-type: winrt property ---- # Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.User ## -description Gets the user that the app was activated for. ## -property-value The user that the app was activated for. ## -remarks This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. This property returns **null** when a multi-user application is activated with no specific user context. Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.VoiceCommandActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks +This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for. + +This property returns **null** when a multi-user application is activated with no specific user context. + +Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs.md b/windows.applicationmodel.activation/walletactionactivatedeventargs.md index 4c0cae8f6f..4129dcf5fa 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs ## -description Provides information to an app that was launched as the result of a wallet action. ## -remarks You access a [WalletActionActivatedEventArgs](walletactionactivatedeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **WalletAction**. ## -examples ## -see-also [IWalletActionActivatedEventArgs](iwalletactionactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs + +## -description +Provides information to an app that was launched as the result of a wallet action. + +## -remarks +You access a [WalletActionActivatedEventArgs](walletactionactivatedeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **WalletAction**. + +## -examples + +## -see-also +[IWalletActionActivatedEventArgs](iwalletactionactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs_actionid.md b/windows.applicationmodel.activation/walletactionactivatedeventargs_actionid.md index e6bb40ebd0..87abf84e3b 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs_actionid.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs_actionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionId ## -description Gets the ID of the action, such as the id of the verb, transaction and so on. ## -property-value The ID of the action, such as the id of the verb, transaction and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionId + +## -description +Gets the ID of the action, such as the id of the verb, transaction and so on. + +## -property-value +The ID of the action, such as the id of the verb, transaction and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs_actionkind.md b/windows.applicationmodel.activation/walletactionactivatedeventargs_actionkind.md index 295b1355a3..3852f80df3 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs_actionkind.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs_actionkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionKind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionKind ## -description Gets the action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -property-value Gets the action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ActionKind + +## -description +Gets the action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -property-value +Gets the action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs_itemid.md b/windows.applicationmodel.activation/walletactionactivatedeventargs_itemid.md index 02c905c2e4..1bbe9d16b2 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs_itemid.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs_itemid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ItemId --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ItemId ## -description Gets the ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. ## -property-value The ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ItemId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.ItemId + +## -description +Gets the ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. + +## -property-value +The ID of the [WalletItem](../windows.applicationmodel.wallet/walletitem.md) on which the user performed the action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs_kind.md b/windows.applicationmodel.activation/walletactionactivatedeventargs_kind.md index 78be19d817..87966db3e4 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.Kind ## -description Gets the type of action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -property-value The type of action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.Kind + +## -description +Gets the type of action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -property-value +The type of action that was performed on the [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/walletactionactivatedeventargs_previousexecutionstate.md index 8e28f05254..0c66e28474 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value The execution state of the app before it was activated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state of the app before it was activated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/walletactionactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/walletactionactivatedeventargs_splashscreen.md index 213090502e..d419f2678f 100644 --- a/windows.applicationmodel.activation/walletactionactivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/walletactionactivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The splash screen object which provides information about the transition from the splash screen to the activated app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WalletActionActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The splash screen object which provides information about the transition from the splash screen to the activated app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs.md b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs.md index 0e5f3390fb..8ec02a2d64 100644 --- a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs.md +++ b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs ## -description Provides information to an app activated as a result of a web account provider operation. ## -remarks You access a [WebAccountProviderActivatedEventArgs](webaccountprovideractivatedeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **WebAccountProvider**. ## -examples ## -see-also [IWebAccountProviderActivatedEventArgs](iwebaccountprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs + +## -description +Provides information to an app activated as a result of a web account provider operation. + +## -remarks +You access a [WebAccountProviderActivatedEventArgs](webaccountprovideractivatedeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **WebAccountProvider**. + +## -examples + +## -see-also +[IWebAccountProviderActivatedEventArgs](iwebaccountprovideractivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_kind.md b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_kind.md index b3018885e8..cc50eef371 100644 --- a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_kind.md +++ b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Kind ## -description Gets the kind of web account provider activation. ## -property-value The kind of web account provider activation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Kind + +## -description +Gets the kind of web account provider activation. + +## -property-value +The kind of web account provider activation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_operation.md b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_operation.md index 75f41a99ff..5143248a4c 100644 --- a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_operation.md +++ b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_operation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Operation --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Operation ## -description Gets the web account provider operation. ## -property-value Gets the web account provider operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.Operation + +## -description +Gets the web account provider operation. + +## -property-value +Gets the web account provider operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_previousexecutionstate.md index a2493ba012..edfe6ea253 100644 --- a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value The execution state of the app before it was activated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state of the app before it was activated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_splashscreen.md index 849d531970..e4fcadc42b 100644 --- a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.SplashScreen ## -description Gets the splash screen object which provides information about the transition from the splash screen to the activated app. ## -property-value The splash screen object which provides information about the transition from the splash screen to the activated app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.SplashScreen + +## -description +Gets the splash screen object which provides information about the transition from the splash screen to the activated app. + +## -property-value +The splash screen object which provides information about the transition from the splash screen to the activated app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs.md b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs.md index d628e974a4..b78d67c0d3 100644 --- a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs.md +++ b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs ## -description Provides information to an app that was launched after being suspended for a web authentication broker operation. ## -remarks You access a [WebAuthenticationBrokerContinuationEventArgs](webauthenticationbrokercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **WebAuthenticationBrokerContinuation**. For an example that uses the [WebAuthenticationBrokerContinuationEventArgs](webauthenticationbrokercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). ## -examples ## -see-also [IWebAuthenticationBrokerContinuationEventArgs](iwebauthenticationbrokercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs + +## -description +Provides information to an app that was launched after being suspended for a web authentication broker operation. + +## -remarks +You access a [WebAuthenticationBrokerContinuationEventArgs](webauthenticationbrokercontinuationeventargs.md) object when you implement an event handler that responds to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events when [ActivationKind](activationkind.md) is **WebAuthenticationBrokerContinuation**. + +For an example that uses the [WebAuthenticationBrokerContinuationEventArgs](webauthenticationbrokercontinuationeventargs.md) class, see [How to continue your Windows Phone Store app after calling an AndContinue method](http://msdn.microsoft.com/library/3398d631-ff80-4336-be45-8ee3ea96fbdb). + +## -examples + +## -see-also +[IWebAuthenticationBrokerContinuationEventArgs](iwebauthenticationbrokercontinuationeventargs.md), [IContinuationActivatedEventArgs](icontinuationactivatedeventargs.md), [IActivatedEventArgs](iactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_continuationdata.md b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_continuationdata.md index 136b45e58d..c4c44f9af2 100644 --- a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_continuationdata.md +++ b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_continuationdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.ContinuationData --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.ContinuationData ## -description Gets a set of values populated by the app before a web authentication broker operation that deactivates the app in order to provide context when the app is activated. ## -property-value A set of values populated by the app before a web authentication broker operation that deactivates the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.ContinuationData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.ContinuationData + +## -description +Gets a set of values populated by the app before a web authentication broker operation that deactivates the app in order to provide context when the app is activated. + +## -property-value +A set of values populated by the app before a web authentication broker operation that deactivates the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_kind.md b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_kind.md index 4a315d2dcf..b29e8307dd 100644 --- a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_kind.md +++ b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.Kind ## -description Gets the activation type. ## -property-value The [ActivationKind.WebAuthenticationBrokerContinuation](activationkind.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.Kind + +## -description +Gets the activation type. + +## -property-value +The [ActivationKind.WebAuthenticationBrokerContinuation](activationkind.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_previousexecutionstate.md index d21f48c103..85585ba706 100644 --- a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_previousexecutionstate.md +++ b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_previousexecutionstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.PreviousExecutionState --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.PreviousExecutionState ## -description Gets the execution state of the app before it was activated. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_splashscreen.md b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_splashscreen.md index 54fd2c3623..2e411e4880 100644 --- a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_splashscreen.md +++ b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_splashscreen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.SplashScreen --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.SplashScreen ## -description Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. ## -property-value The object that provides splash screen information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.SplashScreen + +## -description +Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_webauthenticationresult.md b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_webauthenticationresult.md index 297b16b37c..1b7f691b7b 100644 --- a/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_webauthenticationresult.md +++ b/windows.applicationmodel.activation/webauthenticationbrokercontinuationeventargs_webauthenticationresult.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult --api-type: winrt property ---- # Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult ## -description Gets the [WebAuthenticationResult](../windows.security.authentication.web/webauthenticationresult.md) object returned from the web authentication broker operation. ## -property-value The result of the web authentication broker operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAuthenticationBrokerContinuationEventArgs.WebAuthenticationResult + +## -description +Gets the [WebAuthenticationResult](../windows.security.authentication.web/webauthenticationresult.md) object returned from the web authentication broker operation. + +## -property-value +The result of the web authentication broker operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension.md b/windows.applicationmodel.appextensions/appextension.md index f15d632268..3af7bbfecc 100644 --- a/windows.applicationmodel.appextensions/appextension.md +++ b/windows.applicationmodel.appextensions/appextension.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtension --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtension ## -description Provides information about an application extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtension +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension + +## -description +Provides information about an application extension. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_appinfo.md b/windows.applicationmodel.appextensions/appextension_appinfo.md index f9d56c200d..f935b00df5 100644 --- a/windows.applicationmodel.appextensions/appextension_appinfo.md +++ b/windows.applicationmodel.appextensions/appextension_appinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.AppInfo --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtension.AppInfo ## -description Provides information such as the app extension's name, logo, package information, and app identifier, that the host app may choose to show to the user. ## -property-value The application information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.AppInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.AppInfo + +## -description +Provides information such as the app extension's name, logo, package information, and app identifier, that the host app may choose to show to the user. + +## -property-value +The application information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_description.md b/windows.applicationmodel.appextensions/appextension_description.md index 0d2985ccb5..d5699ee6b6 100644 --- a/windows.applicationmodel.appextensions/appextension_description.md +++ b/windows.applicationmodel.appextensions/appextension_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.Description --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtension.Description ## -description Provides the description of this app extension. ## -property-value Description of the extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.Description + +## -description +Provides the description of this app extension. + +## -property-value +Description of the extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_displayname.md b/windows.applicationmodel.appextensions/appextension_displayname.md index 9fe9c67546..dadb3380c7 100644 --- a/windows.applicationmodel.appextensions/appextension_displayname.md +++ b/windows.applicationmodel.appextensions/appextension_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtension.DisplayName ## -description Provides the display name of this extension. ## -property-value The display name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.DisplayName + +## -description +Provides the display name of this extension. + +## -property-value +The display name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_getextensionpropertiesasync_1765535170.md b/windows.applicationmodel.appextensions/appextension_getextensionpropertiesasync_1765535170.md index f2c52a4a42..f53753c45a 100644 --- a/windows.applicationmodel.appextensions/appextension_getextensionpropertiesasync_1765535170.md +++ b/windows.applicationmodel.appextensions/appextension_getextensionpropertiesasync_1765535170.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.AppExtensions.AppExtension.GetExtensionPropertiesAsync --api-type: winrt method ---- # Windows.ApplicationModel.AppExtensions.AppExtension.GetExtensionPropertiesAsync ## -description Used by the extension to specify any extra information that the hosting app can query. ## -returns A collection of key-value pairs. ## -remarks Examples of extra information that could be returned from this property includes authorship information, capability information, and so on. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppExtensions.AppExtension.GetExtensionPropertiesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.GetExtensionPropertiesAsync + +## -description +Used by the extension to specify any extra information that the hosting app can query. + +## -returns +A collection of key-value pairs. + +## -remarks +Examples of extra information that could be returned from this property includes authorship information, capability information, and so on. + + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_getpublicfolderasync_353057648.md b/windows.applicationmodel.appextensions/appextension_getpublicfolderasync_353057648.md index 1c554177b5..9be5cd36c8 100644 --- a/windows.applicationmodel.appextensions/appextension_getpublicfolderasync_353057648.md +++ b/windows.applicationmodel.appextensions/appextension_getpublicfolderasync_353057648.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.AppExtensions.AppExtension.GetPublicFolderAsync --api-type: winrt method ---- # Windows.ApplicationModel.AppExtensions.AppExtension.GetPublicFolderAsync ## -description Gets the readable subfolder in the extension's isolated storage. ## -returns The public sub-folder. ## -remarks An extension can provide a subfolder containing files that hosting apps can read from. Hosts cannot write to the folder. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppExtensions.AppExtension.GetPublicFolderAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.GetPublicFolderAsync + +## -description +Gets the readable subfolder in the extension's isolated storage. + +## -returns +The public sub-folder. + +## -remarks +An extension can provide a subfolder containing files that hosting apps can read from. Hosts cannot write to the folder. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_id.md b/windows.applicationmodel.appextensions/appextension_id.md index b89e784b9a..28bd98118a 100644 --- a/windows.applicationmodel.appextensions/appextension_id.md +++ b/windows.applicationmodel.appextensions/appextension_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.Id --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtension.Id ## -description The extension's instance identifier. ## -property-value Instance identifier. ## -remarks There may be multiple extensions within an extension group. The identifier distinguishes them from each other. For example, a category may contain both a test and shipping extension in the same category and they would have different identifiers so you can tell them apart. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.Id + +## -description +The extension's instance identifier. + +## -property-value +Instance identifier. + +## -remarks +There may be multiple extensions within an extension group. The identifier distinguishes them from each other. For example, a category may contain both a test and shipping extension in the same category and they would have different identifiers so you can tell them apart. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextension_package.md b/windows.applicationmodel.appextensions/appextension_package.md index 2037663bf5..1293cc9e84 100644 --- a/windows.applicationmodel.appextensions/appextension_package.md +++ b/windows.applicationmodel.appextensions/appextension_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.Package --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtension.Package ## -description Gets the package information for the app extension. ## -property-value The package information which includes the package description, logo, display name, and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtension.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtension.Package + +## -description +Gets the package information for the app extension. + +## -property-value +The package information which includes the package description, logo, display name, and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog.md b/windows.applicationmodel.appextensions/appextensioncatalog.md index d1555503eb..f05a512172 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog ## -description Provides information about available extensions within a group . ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog + +## -description +Provides information about available extensions within a group + +. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md b/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md index 685a91095c..6b686ec5b3 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.FindAllAsync --api-type: winrt method ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.FindAllAsync ## -description Provides a list of extensions available within an extension package. ## -returns The list of extensions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.FindAllAsync + +## -description +Provides a list of extensions available within an extension package. + + +## -returns +The list of extensions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md b/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md index d45bcbed03..2659ef889f 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.Open(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.Open ## -description Opens an app package that contains one or more extensions. ## -parameters ### -param appExtensionName The name of the extension. ## -returns Information about the various extensions within an extension group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.Open(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.Open + +## -description +Opens an app package that contains one or more extensions. + +## -parameters +### -param appExtensionName +The name of the extension. + + +## -returns +Information about the various extensions within an extension group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md b/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md index 9adfc04c66..230b6a0e02 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageInstalled --api-type: winrt event ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageInstalled ## -description Event that is fired when an extension package is installed. ## -remarks A host app can listen to this event to be notified when a new extension package is installed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageInstalled +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageInstalled + +## -description +Event that is fired when an extension package is installed. + +## -remarks +A host app can listen to this event to be notified when a new extension package is installed. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md b/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md index 10b4144ba9..fb149d99f7 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageStatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageStatusChanged ## -description Event that is fired when an extension package is installed, removed, or updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageStatusChanged + +## -description +Event that is fired when an extension package is installed, removed, or updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packageuninstalling.md b/windows.applicationmodel.appextensions/appextensioncatalog_packageuninstalling.md index da991e4766..22855421e8 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packageuninstalling.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packageuninstalling.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUninstalling --api-type: winrt event ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUninstalling ## -description Event that is fired when an extension package is being uninstalled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUninstalling +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUninstalling + +## -description +Event that is fired when an extension package is being uninstalled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packageupdated.md b/windows.applicationmodel.appextensions/appextensioncatalog_packageupdated.md index 45618956b5..6817a2625c 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packageupdated.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packageupdated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdated --api-type: winrt event ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdated ## -description Event that is fired when an extension package is updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdated +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdated + +## -description +Event that is fired when an extension package is updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md b/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md index 9a819d2b6d..cc96ad5aaa 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdating --api-type: winrt event ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdating ## -description Event that is fired when an extension package is being updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdating +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.PackageUpdating + +## -description +Event that is fired when an extension package is being updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md b/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md index da119848f0..86e0932d39 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.RequestRemovePackageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.RequestRemovePackageAsync ## -description Removes the specified extension package. ## -parameters ### -param packageFullName The name of the package to remove. ## -returns Returns **true** if the package was successfully removed; otherwise, **false**. ## -remarks The user is prompted to allow or deny the removal of the package. [Desktop Bridge](https://developer.microsoft.com/en-us/windows/bridges/desktop) app extension hosts cannot use this method directly. Desktop Bridge app extension hosts should use their Universal Windows Platform component to manage app extensions. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.RequestRemovePackageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.RequestRemovePackageAsync + +## -description +Removes the specified extension package. + +## -parameters +### -param packageFullName +The name of the package to remove. + + +## -returns +Returns **true** if the package was successfully removed; otherwise, **false**. + +## -remarks +The user is prompted to allow or deny the removal of the package. + +[Desktop Bridge](https://developer.microsoft.com/en-us/windows/bridges/desktop) app extension hosts cannot use this method directly. Desktop Bridge app extension hosts should use their Universal Windows Platform component to manage app extensions. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs.md b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs.md index 9dfd182786..0aad0b1418 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs.md +++ b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs ## -description Provides information for the [AppExtensionCatalog.PackageInstalled](appextensioncatalog_packageinstalled.md) event. ## -remarks Instances of this class are created by the system and passed as event arguments to your handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs + +## -description +Provides information for the [AppExtensionCatalog.PackageInstalled](appextensioncatalog_packageinstalled.md) event. + +## -remarks +Instances of this class are created by the system and passed as event arguments to your handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_appextensionname.md b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_appextensionname.md index 2c1507697a..2c61fb3ccc 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_appextensionname.md +++ b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_appextensionname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.AppExtensionName --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.AppExtensionName ## -description Gets the name of the extension package that was installed. ## -property-value The name of the extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.AppExtensionName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.AppExtensionName + +## -description +Gets the name of the extension package that was installed. + +## -property-value +The name of the extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md index ff856d6c0a..bf2436bced 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md +++ b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Extensions --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Extensions ## -description Provides a list of extensions that are in the extension package that was installed. ## -property-value A list of extensions within the extension package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Extensions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Extensions + +## -description +Provides a list of extensions that are in the extension package that was installed. + +## -property-value +A list of extensions within the extension package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_package.md b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_package.md index 0ec2babab5..83e21412a7 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_package.md +++ b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Package ## -description Gets the package containing the extension that was installed. ## -property-value The extension package that was installed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageInstalledEventArgs.Package + +## -description +Gets the package containing the extension that was installed. + +## -property-value +The extension package that was installed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs.md b/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs.md index e639084a3d..fdbb2a9f70 100644 --- a/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs.md +++ b/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs ## -description Provides information for the [AppExtensionCatalog.PackageStatusChanged](appextensioncatalog_packagestatuschanged.md) event. ## -remarks Instances of this class are created by the system and passed as event arguments to your handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs + +## -description +Provides information for the [AppExtensionCatalog.PackageStatusChanged](appextensioncatalog_packagestatuschanged.md) event. + +## -remarks +Instances of this class are created by the system and passed as event arguments to your handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_appextensionname.md b/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_appextensionname.md index 504cc0db5f..3d4a88ad50 100644 --- a/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_appextensionname.md +++ b/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_appextensionname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.AppExtensionName --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.AppExtensionName ## -description Gets the name of the app extension that has been updated or uninstalled. ## -property-value The name of the app extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.AppExtensionName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.AppExtensionName + +## -description +Gets the name of the app extension that has been updated or uninstalled. + +## -property-value +The name of the app extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_package.md b/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_package.md index 2d028f25aa..005123a26e 100644 --- a/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_package.md +++ b/windows.applicationmodel.appextensions/appextensionpackagestatuschangedeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.Package ## -description Gets the package containing the extension that is being updated or uninstalled. ## -property-value The extension package that changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageStatusChangedEventArgs.Package + +## -description +Gets the package containing the extension that is being updated or uninstalled. + +## -property-value +The extension package that changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs.md b/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs.md index 6366d93928..109b0cd6c1 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs.md +++ b/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs ## -description Provides information for the [AppExtensionCatalog.PackageUninstalling](appextensioncatalog_packageuninstalling.md) event. ## -remarks Instances of this class are created by the system and passed as event arguments to your handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs + +## -description +Provides information for the [AppExtensionCatalog.PackageUninstalling](appextensioncatalog_packageuninstalling.md) event. + +## -remarks +Instances of this class are created by the system and passed as event arguments to your handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_appextensionname.md b/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_appextensionname.md index 37aa483682..a3724fb5bb 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_appextensionname.md +++ b/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_appextensionname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.AppExtensionName --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.AppExtensionName ## -description Gets the name of the app extension that is uninstalling. ## -property-value The name of the app extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.AppExtensionName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.AppExtensionName + +## -description +Gets the name of the app extension that is uninstalling. + +## -property-value +The name of the app extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_package.md b/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_package.md index c7b11cf608..cd5e544176 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_package.md +++ b/windows.applicationmodel.appextensions/appextensionpackageuninstallingeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.Package ## -description Gets the app extension package that is uninstalilng. ## -property-value The app extension package that was uninstalled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUninstallingEventArgs.Package + +## -description +Gets the app extension package that is uninstalilng. + +## -property-value +The app extension package that was uninstalled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs.md b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs.md index fa78924630..1497ca5205 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs ## -description Provides information for the [AppExtensionCatalog.PackageUpdated](appextensioncatalog_packageupdated.md) event. ## -remarks Instances of this class are created by the system and passed as event arguments to your handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs + +## -description +Provides information for the [AppExtensionCatalog.PackageUpdated](appextensioncatalog_packageupdated.md) event. + +## -remarks +Instances of this class are created by the system and passed as event arguments to your handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_appextensionname.md b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_appextensionname.md index 5853b979b3..3f12a807a6 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_appextensionname.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_appextensionname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.AppExtensionName --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.AppExtensionName ## -description Gets the name of the app extension that was updated. ## -property-value The name of the updated app extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.AppExtensionName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.AppExtensionName + +## -description +Gets the name of the app extension that was updated. + +## -property-value +The name of the updated app extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md index a23c15f438..57cf49d70b 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Extensions --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Extensions ## -description Provides a list of extensions that are in the extension package that was updated ## -property-value A list of extensions within the updated extension package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Extensions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Extensions + +## -description +Provides a list of extensions that are in the extension package that was updated + +## -property-value +A list of extensions within the updated extension package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_package.md b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_package.md index df05e4590e..60409461a8 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_package.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Package ## -description Provides the package containing the extension that was updated. ## -property-value The updated app extension package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatedEventArgs.Package + +## -description +Provides the package containing the extension that was updated. + +## -property-value +The updated app extension package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs.md b/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs.md index f01dd56b8a..51b39728bc 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs ## -description Provides information for the [AppExtensionCatalog.PackageUpdating](appextensioncatalog_packageupdating.md) event. ## -remarks Instances of this class are created by the system and passed as event arguments to your handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs + +## -description +Provides information for the [AppExtensionCatalog.PackageUpdating](appextensioncatalog_packageupdating.md) event. + +## -remarks +Instances of this class are created by the system and passed as event arguments to your handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_appextensionname.md b/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_appextensionname.md index cd13473e12..f7e719eff3 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_appextensionname.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_appextensionname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.AppExtensionName --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.AppExtensionName ## -description Gets the name of the app extension that is being updated. ## -property-value The name of the app extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.AppExtensionName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.AppExtensionName + +## -description +Gets the name of the app extension that is being updated. + +## -property-value +The name of the app extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_package.md b/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_package.md index c7efe7b391..5f7ea55172 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_package.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatingeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.Package ## -description Provides the package containing the extension that is updating. ## -property-value The updated app extension package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppExtensions.AppExtensionPackageUpdatingEventArgs.Package + +## -description +Provides the package containing the extension that is updating. + +## -property-value +The updated app extension package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_appointmentinformation.md b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_appointmentinformation.md index 2260ccb532..54cf75f118 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_appointmentinformation.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_appointmentinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.AppointmentInformation --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.AppointmentInformation ## -description Gets the [Appointment](../windows.applicationmodel.appointments/appointment.md) info from the activation request. ## -property-value An instance of the [Appointment](../windows.applicationmodel.appointments/appointment.md) class that represents the specific info for the appointment to add. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.AppointmentInformation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.AppointmentInformation + +## -description +Gets the [Appointment](../windows.applicationmodel.appointments/appointment.md) info from the activation request. + +## -property-value +An instance of the [Appointment](../windows.applicationmodel.appointments/appointment.md) class that represents the specific info for the appointment to add. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_dismissui_451152495.md b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_dismissui_451152495.md index f9e19fa2bc..6679c17743 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_dismissui_451152495.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_dismissui_451152495.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.DismissUI --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.DismissUI ## -description Dismisses the UI for the operation that adds a new appointment. ## -remarks A call to [DismissUI](addappointmentoperation_dismissui.md) is similar to when the user dismisses the appointment provider’s UI by tapping away from it. When the appointment provider’s UI is dismissed, the appointment provider app can continue to save the appointment in the background until the appointment provider app calls [ReportCompleted](addappointmentoperation_reportcompleted.md) or [ReportError](addappointmentoperation_reporterror.md) or up to 15 seconds elapses, which causes the appointments provider app to stop running. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.DismissUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.DismissUI + +## -description +Dismisses the UI for the operation that adds a new appointment. + +## -remarks +A call to [DismissUI](addappointmentoperation_dismissui.md) is similar to when the user dismisses the appointment provider’s UI by tapping away from it. When the appointment provider’s UI is dismissed, the appointment provider app can continue to save the appointment in the background until the appointment provider app calls [ReportCompleted](addappointmentoperation_reportcompleted.md) or [ReportError](addappointmentoperation_reporterror.md) or up to 15 seconds elapses, which causes the appointments provider app to stop running. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcanceled_1921025216.md b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcanceled_1921025216.md index f7a8f230e6..1bd6096ae5 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcanceled_1921025216.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcanceled_1921025216.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCanceled --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCanceled ## -description Call this method to inform the activating app that the operation was canceled by the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCanceled +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCanceled + +## -description +Call this method to inform the activating app that the operation was canceled by the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcompleted_458863373.md b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcompleted_458863373.md index d67399ceb2..41509b81f7 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcompleted_458863373.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reportcompleted_458863373.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCompleted(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCompleted ## -description Call this method to inform the activating app that the operation was completed successfully. Provide a unique appointment ID as the *itemID* parameter. ## -parameters ### -param itemId A unique appointment ID that the activating app can later use to remove this appointment if necessary. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCompleted(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportCompleted + +## -description +Call this method to inform the activating app that the operation was completed successfully. Provide a unique appointment ID as the *itemID* parameter. + +## -parameters +### -param itemId +A unique appointment ID that the activating app can later use to remove this appointment if necessary. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reporterror_1034694985.md b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reporterror_1034694985.md index 5bfd20e439..ea9f5bfb8d 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reporterror_1034694985.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_reporterror_1034694985.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportError(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportError ## -description Informs the activating app that the operation couldn't be completed because of a provider error. ## -parameters ### -param value A string that contains info about the error. ## -remarks This method logs messages about event tracing for Windows (ETW) events. To view these messages, see: ``` Event Viewer\Applications and Services Logs\Microsoft\Windows\Apps\Microsoft-Windows-TWinUI\Operational ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportError(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.ReportError + +## -description +Informs the activating app that the operation couldn't be completed because of a provider error. + +## -parameters +### -param value +A string that contains info about the error. + + +## -remarks +This method logs messages about event tracing for Windows (ETW) events. To view these messages, see: ``` + +Event Viewer\Applications and Services Logs\Microsoft\Windows\Apps\Microsoft-Windows-TWinUI\Operational +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_sourcepackagefamilyname.md b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_sourcepackagefamilyname.md index 0328088ab3..52fb1e2344 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_sourcepackagefamilyname.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_sourcepackagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.SourcePackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.SourcePackageFamilyName ## -description Gets the package family name of the app that is requesting the operation. ## -property-value The package family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.SourcePackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AddAppointmentOperation.SourcePackageFamilyName + +## -description +Gets the package family name of the app that is requesting the operation. + +## -property-value +The package family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs.md b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs.md index 87e5cb09be..6f2e853427 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs ## -description Represents the object associated with retrieving the operation of the appointments provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs + +## -description +Represents the object associated with retrieving the operation of the appointments provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_addappointment.md b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_addappointment.md index 28d0eae758..710a374964 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_addappointment.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_addappointment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.AddAppointment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.AddAppointment ## -description Gets the add-appointment action that the appointments provider performs. ## -property-value The add-appointment action ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.AddAppointment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.AddAppointment + +## -description +Gets the add-appointment action that the appointments provider performs. + +## -property-value +The add-appointment action + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_removeappointment.md b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_removeappointment.md index 98f3e36fb6..b2344875f4 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_removeappointment.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_removeappointment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.RemoveAppointment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.RemoveAppointment ## -description Gets the remove-appointment action that the appointments provider performs. ## -property-value The remove-appointment action ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.RemoveAppointment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.RemoveAppointment + +## -description +Gets the remove-appointment action that the appointments provider performs. + +## -property-value +The remove-appointment action + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_replaceappointment.md b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_replaceappointment.md index 674a6759d4..125d869fe5 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_replaceappointment.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_replaceappointment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ReplaceAppointment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ReplaceAppointment ## -description Gets the replace-appointment action that the appointments provider performs. ## -property-value The replace-appointment action ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ReplaceAppointment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ReplaceAppointment + +## -description +Gets the replace-appointment action that the appointments provider performs. + +## -property-value +The replace-appointment action + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showappointmentdetails.md b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showappointmentdetails.md index fc747deb1b..773c3586bd 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showappointmentdetails.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showappointmentdetails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowAppointmentDetails --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowAppointmentDetails ## -description Gets the show-appointment-details action that the appointments provider performs. ## -property-value The show-appointment-details action ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowAppointmentDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowAppointmentDetails + +## -description +Gets the show-appointment-details action that the appointments provider performs. + +## -property-value +The show-appointment-details action + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showtimeframe.md b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showtimeframe.md index fef77a172d..546a0dd8c3 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showtimeframe.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/appointmentsproviderlaunchactionverbs_showtimeframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowTimeFrame --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowTimeFrame ## -description Gets the show-time-frame action of an appointment that the appointments provider performs. ## -property-value The show-time-frame action of an appointment ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowTimeFrame +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.AppointmentsProviderLaunchActionVerbs.ShowTimeFrame + +## -description +Gets the show-time-frame action of an appointment that the appointments provider performs. + +## -property-value +The show-time-frame action of an appointment + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_appointmentid.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_appointmentid.md index 765efc7f17..c9593493a0 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_appointmentid.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_appointmentid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.AppointmentId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.AppointmentId ## -description Gets the unique identifier of the appointment to remove. ## -property-value The unique identifier of the appointment to remove. ## -remarks The identifier is usually a value the appointment provider app previously returned through an [AddAppointmentOperation.ReportCompleted](addappointmentoperation_reportcompleted.md) call. If the identifier doesn't correspond to any known appointment, the appointment doesn't exist in the user’s calendar. Because the user's intent was to remove the appointment, we recommend that you treat the operation as successful. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.AppointmentId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.AppointmentId + +## -description +Gets the unique identifier of the appointment to remove. + +## -property-value +The unique identifier of the appointment to remove. + +## -remarks +The identifier is usually a value the appointment provider app previously returned through an [AddAppointmentOperation.ReportCompleted](addappointmentoperation_reportcompleted.md) call. If the identifier doesn't correspond to any known appointment, the appointment doesn't exist in the user’s calendar. Because the user's intent was to remove the appointment, we recommend that you treat the operation as successful. + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_dismissui_451152495.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_dismissui_451152495.md index 42806c1f02..18f0e0c56b 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_dismissui_451152495.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_dismissui_451152495.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.DismissUI --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.DismissUI ## -description Dismisses the UI for the operation that removes an appointment. ## -remarks A call to [DismissUI](addappointmentoperation_dismissui.md) is similar to when the user dismisses the appointment provider’s UI by tapping away from it. When the appointment provider’s UI is dismissed, the appointment provider app can continue to save the appointment in the background until the appointment provider app calls [ReportCompleted](addappointmentoperation_reportcompleted.md) or [ReportError](addappointmentoperation_reporterror.md) or up to 15 seconds elapses, which causes the appointments provider app to stop running. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.DismissUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.DismissUI + +## -description +Dismisses the UI for the operation that removes an appointment. + +## -remarks +A call to [DismissUI](addappointmentoperation_dismissui.md) is similar to when the user dismisses the appointment provider’s UI by tapping away from it. When the appointment provider’s UI is dismissed, the appointment provider app can continue to save the appointment in the background until the appointment provider app calls [ReportCompleted](addappointmentoperation_reportcompleted.md) or [ReportError](addappointmentoperation_reporterror.md) or up to 15 seconds elapses, which causes the appointments provider app to stop running. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_instancestartdate.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_instancestartdate.md index 027d9d66a0..d4f1480164 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_instancestartdate.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_instancestartdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.InstanceStartDate --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.InstanceStartDate ## -description Gets the start date and time of the appointment instance to remove. ## -property-value The start date and time of the appointment instance to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.InstanceStartDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.InstanceStartDate + +## -description +Gets the start date and time of the appointment instance to remove. + +## -property-value +The start date and time of the appointment instance to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcanceled_1921025216.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcanceled_1921025216.md index cb8b3f68fe..6c89fb1f02 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcanceled_1921025216.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcanceled_1921025216.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCanceled --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCanceled ## -description Call this method to inform the activating app that the operation was canceled by the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCanceled +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCanceled + +## -description +Call this method to inform the activating app that the operation was canceled by the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcompleted_1121471021.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcompleted_1121471021.md index 5b33d20c72..6fc1190fb6 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcompleted_1121471021.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reportcompleted_1121471021.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCompleted --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCompleted ## -description Informs the activating app that the operation was completed successfully. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCompleted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportCompleted + +## -description +Informs the activating app that the operation was completed successfully. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reporterror_1034694985.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reporterror_1034694985.md index 540661c307..c7f87fa7db 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reporterror_1034694985.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_reporterror_1034694985.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportError(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportError ## -description Informs the activating app that the operation couldn't be completed because of a provider error. ## -parameters ### -param value A string that contains info about the error. ## -remarks This method logs messages about event tracing for Windows (ETW) events. To view these messages, see: ``` Event Viewer\Applications and Services Logs\Microsoft\Windows\Apps\Microsoft-Windows-TWinUI\Operational ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportError(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.ReportError + +## -description +Informs the activating app that the operation couldn't be completed because of a provider error. + +## -parameters +### -param value +A string that contains info about the error. + + +## -remarks +This method logs messages about event tracing for Windows (ETW) events. To view these messages, see: ``` + +Event Viewer\Applications and Services Logs\Microsoft\Windows\Apps\Microsoft-Windows-TWinUI\Operational +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_sourcepackagefamilyname.md b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_sourcepackagefamilyname.md index 5a1c94313e..69df30f1ad 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_sourcepackagefamilyname.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/removeappointmentoperation_sourcepackagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.SourcePackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.SourcePackageFamilyName ## -description Gets the package family name of the app that is requesting the operation. ## -property-value The package family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.SourcePackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.RemoveAppointmentOperation.SourcePackageFamilyName + +## -description +Gets the package family name of the app that is requesting the operation. + +## -property-value +The package family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation.md index 0df5a1c737..874b93578a 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation ## -description Represents the operation object associated with replacing an appointment. Appointments provider apps use this info to perform the operation. ## -remarks This class is used as the value of the [ReplaceAppointmentOperation](replaceappointmentoperation.md) event data property from the [AppointmentsProviderRemoveAppointmentActivatedEventArgs](../windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md) event data class. An appointments provider app typically goes through a series of casts and property checks starting from the [IActivatedEventArgs](../windows.applicationmodel.activation/iactivatedeventargs.md) event data of a general activation event handler. If the activation indicates that it's an **AppointmentsProvider** app activation kind with **Remove** as the verb, then it's appropriate to cast event data to [AppointmentsProviderRemoveAppointmentActivatedEventArgs](../windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md). Providers call methods of [ReplaceAppointmentOperation](replaceappointmentoperation.md) to indicate whether the operation was completed, was canceled, or when a provider error prevented the operation from being completed. Calling these methods influences the async results that the activating app gets back from one of its [ShowReplaceAppointmentAsync](../windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync.md) calls. All of the reporting methods ([ReportCompleted](replaceappointmentoperation_reportcompleted.md), [ReportCanceled](replaceappointmentoperation_reportcanceled.md), [ReportError](replaceappointmentoperation_reporterror.md)) dismiss the Replace Appointment UI. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation + +## -description +Represents the operation object associated with replacing an appointment. Appointments provider apps use this info to perform the operation. + +## -remarks +This class is used as the value of the [ReplaceAppointmentOperation](replaceappointmentoperation.md) event data property from the [AppointmentsProviderRemoveAppointmentActivatedEventArgs](../windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md) event data class. An appointments provider app typically goes through a series of casts and property checks starting from the [IActivatedEventArgs](../windows.applicationmodel.activation/iactivatedeventargs.md) event data of a general activation event handler. If the activation indicates that it's an **AppointmentsProvider** app activation kind with **Remove** as the verb, then it's appropriate to cast event data to [AppointmentsProviderRemoveAppointmentActivatedEventArgs](../windows.applicationmodel.activation/appointmentsproviderremoveappointmentactivatedeventargs.md). + +Providers call methods of [ReplaceAppointmentOperation](replaceappointmentoperation.md) to indicate whether the operation was completed, was canceled, or when a provider error prevented the operation from being completed. Calling these methods influences the async results that the activating app gets back from one of its [ShowReplaceAppointmentAsync](../windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync.md) calls. All of the reporting methods ([ReportCompleted](replaceappointmentoperation_reportcompleted.md), [ReportCanceled](replaceappointmentoperation_reportcanceled.md), [ReportError](replaceappointmentoperation_reporterror.md)) dismiss the Replace Appointment UI. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentid.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentid.md index cae178ee50..f8ea6795cb 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentid.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentId ## -description Gets the unique identifier of the appointment to replace. ## -property-value The unique identifier of the appointment to replace. ## -remarks The identifier is typically a value that the appointments provider app previously returned through an [AddAppointmentOperation.ReportCompleted](addappointmentoperation_reportcompleted.md) call. If the identifier doesn't correspond to any known appointment, the appointment doesn't exist in the user’s calendar. Because the user's intent was to replace the original appointment, we recommend that the appointment provider app create a new appointment and add it to the calendar. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentId + +## -description +Gets the unique identifier of the appointment to replace. + +## -property-value +The unique identifier of the appointment to replace. + +## -remarks +The identifier is typically a value that the appointments provider app previously returned through an [AddAppointmentOperation.ReportCompleted](addappointmentoperation_reportcompleted.md) call. If the identifier doesn't correspond to any known appointment, the appointment doesn't exist in the user’s calendar. Because the user's intent was to replace the original appointment, we recommend that the appointment provider app create a new appointment and add it to the calendar. + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentinformation.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentinformation.md index 020da423f2..c24625354f 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentinformation.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_appointmentinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentInformation --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentInformation ## -description Gets the [Appointment](../windows.applicationmodel.appointments/appointment.md) info from the activation request. ## -property-value An instance of the [Appointment](../windows.applicationmodel.appointments/appointment.md) class that represents the specific info for the appointment to replace the current appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentInformation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.AppointmentInformation + +## -description +Gets the [Appointment](../windows.applicationmodel.appointments/appointment.md) info from the activation request. + +## -property-value +An instance of the [Appointment](../windows.applicationmodel.appointments/appointment.md) class that represents the specific info for the appointment to replace the current appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_dismissui_451152495.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_dismissui_451152495.md index 7b8f6bd3ea..0541c47320 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_dismissui_451152495.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_dismissui_451152495.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.DismissUI --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.DismissUI ## -description Dismisses the UI for the operation that replaces an appointment. ## -remarks A call to [DismissUI](addappointmentoperation_dismissui.md) is similar to when the user dismisses the appointment provider’s UI by tapping away from it. When the appointment provider’s UI is dismissed, the appointment provider app can continue to save the appointment in the background until the appointment provider app calls [ReportCompleted](addappointmentoperation_reportcompleted.md) or [ReportError](addappointmentoperation_reporterror.md) or up to 15 seconds elapses, which causes the appointments provider app to stop running. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.DismissUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.DismissUI + +## -description +Dismisses the UI for the operation that replaces an appointment. + +## -remarks +A call to [DismissUI](addappointmentoperation_dismissui.md) is similar to when the user dismisses the appointment provider’s UI by tapping away from it. When the appointment provider’s UI is dismissed, the appointment provider app can continue to save the appointment in the background until the appointment provider app calls [ReportCompleted](addappointmentoperation_reportcompleted.md) or [ReportError](addappointmentoperation_reporterror.md) or up to 15 seconds elapses, which causes the appointments provider app to stop running. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_instancestartdate.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_instancestartdate.md index 41572327ea..b03d2c73f7 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_instancestartdate.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_instancestartdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.InstanceStartDate --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.InstanceStartDate ## -description Gets the start date and time of the appointment instance to replace. ## -property-value The start date and time of the appointment instance to replace. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.InstanceStartDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.InstanceStartDate + +## -description +Gets the start date and time of the appointment instance to replace. + +## -property-value +The start date and time of the appointment instance to replace. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcanceled_1921025216.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcanceled_1921025216.md index 1b66726806..a93f11c1ee 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcanceled_1921025216.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcanceled_1921025216.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCanceled --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCanceled ## -description Informs the activating app that the operation was canceled by the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCanceled +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCanceled + +## -description +Informs the activating app that the operation was canceled by the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcompleted_458863373.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcompleted_458863373.md index 068b2fbeec..8ab69364b4 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcompleted_458863373.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reportcompleted_458863373.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCompleted(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCompleted ## -description Informs the activating app that the operation was completed successfully. ## -parameters ### -param itemId A unique appointment ID that the activating app can later use to remove this appointment if necessary or to replace it again. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCompleted(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportCompleted + +## -description +Informs the activating app that the operation was completed successfully. + +## -parameters +### -param itemId +A unique appointment ID that the activating app can later use to remove this appointment if necessary or to replace it again. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reporterror_1034694985.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reporterror_1034694985.md index 11a2afda85..7838421334 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reporterror_1034694985.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_reporterror_1034694985.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportError(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportError ## -description Informs the activating app that the operation couldn't be completed because of a provider error. ## -parameters ### -param value A string that contains info about the error. ## -remarks This method logs messages about event tracing for Windows (ETW) events. To view these messages, see: ``` Event Viewer\Applications and Services Logs\Microsoft\Windows\Apps\Microsoft-Windows-TWinUI\Operational ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportError(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.ReportError + +## -description +Informs the activating app that the operation couldn't be completed because of a provider error. + +## -parameters +### -param value +A string that contains info about the error. + + +## -remarks +This method logs messages about event tracing for Windows (ETW) events. To view these messages, see: ``` + +Event Viewer\Applications and Services Logs\Microsoft\Windows\Apps\Microsoft-Windows-TWinUI\Operational +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_sourcepackagefamilyname.md b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_sourcepackagefamilyname.md index 8250759118..7be3f92eb6 100644 --- a/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_sourcepackagefamilyname.md +++ b/windows.applicationmodel.appointments.appointmentsprovider/replaceappointmentoperation_sourcepackagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.SourcePackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.SourcePackageFamilyName ## -description Gets the package family name of the app that is requesting the operation. ## -property-value The package family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.SourcePackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentsProvider.ReplaceAppointmentOperation.SourcePackageFamilyName + +## -description +Gets the package family name of the app that is requesting the operation. + +## -property-value +The package family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest.md index b846c4b6a6..bfcff2c0aa 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest ## -description Represents the user's request to cancel a calendar meeting. ## -remarks The system generates an instance of this class and sets it as a property in the [AppointmentCalendarCancelMeetingRequestEventArgs](appointmentcalendarcancelmeetingrequesteventargs.md) argument of the [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest + +## -description +Represents the user's request to cancel a calendar meeting. + +## -remarks +The system generates an instance of this class and sets it as a property in the [AppointmentCalendarCancelMeetingRequestEventArgs](appointmentcalendarcancelmeetingrequesteventargs.md) argument of the [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md index 910ed55119..97deaca7a9 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentCalendarLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentCalendarLocalId ## -description Gets a string that uniquely identifies the calendar associated with the appointment on the local device. ## -property-value A string that uniquely identifies the calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentCalendarLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentCalendarLocalId + +## -description +Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + +## -property-value +A string that uniquely identifies the calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentlocalid.md index a8366a1d5d..a0fb8b6aaa 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentLocalId ## -description Gets a string that uniquely identifies the appointment on the local device. ## -property-value A string that uniquely identifies the appointment on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentLocalId + +## -description +Gets a string that uniquely identifies the appointment on the local device. + +## -property-value +A string that uniquely identifies the appointment on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentoriginalstarttime.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentoriginalstarttime.md index d332bd01c5..4470ca6bfa 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentoriginalstarttime.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentoriginalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentOriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentOriginalStartTime ## -description Gets the original starting time for a recurring appointment. ## -property-value The original starting time for a recurring appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentOriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentOriginalStartTime + +## -description +Gets the original starting time for a recurring appointment. + +## -property-value +The original starting time for a recurring appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_comment.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_comment.md index 441e04d311..adfda8be2e 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_comment.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Comment ## -description Gets a text comment the user may write regarding the cancellation of the meeting. ## -property-value A text comment by the user regarding the meeting cancellation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Comment + +## -description +Gets a text comment the user may write regarding the cancellation of the meeting. + +## -property-value +A text comment by the user regarding the meeting cancellation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_notifyinvitees.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_notifyinvitees.md index ad0315e997..2f36ac2ad8 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_notifyinvitees.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_notifyinvitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.NotifyInvitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.NotifyInvitees ## -description Gets a Boolean value indicating if invitees should be notified. ## -property-value A Boolean value indicating if invitees should be notified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.NotifyInvitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.NotifyInvitees + +## -description +Gets a Boolean value indicating if invitees should be notified. + +## -property-value +A Boolean value indicating if invitees should be notified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportcompletedasync_1707664681.md index 1902f1ff56..173d050698 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportCompletedAsync ## -description Notifies the system that the task of cancelling a meeting has completed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has successfully pushed a meeting cancellation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportCompletedAsync + +## -description +Notifies the system that the task of cancelling a meeting has completed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has successfully pushed a meeting cancellation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportfailedasync_1210652737.md index 6f76c674a0..70750f25ed 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_reportfailedasync_1210652737.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportFailedAsync ## -description Notifies the system that the task of cancelling a meeting has failed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has failed to push a meeting cancellation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.ReportFailedAsync + +## -description +Notifies the system that the task of cancelling a meeting has failed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has failed to push a meeting cancellation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_subject.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_subject.md index d0573b179e..7cb78e2569 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_subject.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Subject ## -description Gets the subject of the response. ## -property-value The subject of the response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.Subject + +## -description +Gets the subject of the response. + +## -property-value +The subject of the response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs.md index 64b2a8e4d3..e0d99c3dc6 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs ## -description Provides data for a [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs + +## -description +Provides data for a [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_getdeferral_254836512.md index 031bfe4444..0adceea340 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.GetDeferral ## -description Gets the deferral object for the [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. ## -returns The deferral object for the [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.GetDeferral + +## -description +Gets the deferral object for the [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. + +## -returns +The deferral object for the [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_request.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_request.md index 2a63f44d0f..04c10e82b4 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_request.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.Request ## -description Gets the [AppointmentCalendarCancelMeetingRequest](appointmentcalendarcancelmeetingrequest.md) object for the corresponding [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. ## -property-value The [AppointmentCalendarCancelMeetingRequest](appointmentcalendarcancelmeetingrequest.md) object for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequestEventArgs.Request + +## -description +Gets the [AppointmentCalendarCancelMeetingRequest](appointmentcalendarcancelmeetingrequest.md) object for the corresponding [CancelMeetingRequested](appointmentdataproviderconnection_cancelmeetingrequested.md) event. + +## -property-value +The [AppointmentCalendarCancelMeetingRequest](appointmentcalendarcancelmeetingrequest.md) object for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest.md index 3aaac747b6..eac7ef5e29 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest ## -description Represents the user's request to change the response to a calendar meeting. ## -remarks The system generates an instance of this class and sets it as a property in the [AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs](appointmentcalendarcreateorupdateappointmentrequesteventargs.md) argument of the [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest + +## -description +Represents the user's request to change the response to a calendar meeting. + +## -remarks +The system generates an instance of this class and sets it as a property in the [AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs](appointmentcalendarcreateorupdateappointmentrequesteventargs.md) argument of the [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointment.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointment.md index 1c8d92ae8a..310cc741f9 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointment.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.Appointment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.Appointment ## -description Gets the appointment to create or update. ## -property-value The appointment to create or update. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.Appointment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.Appointment + +## -description +Gets the appointment to create or update. + +## -property-value +The appointment to create or update. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointmentcalendarlocalid.md index 2a80a304cd..5176b32c82 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_appointmentcalendarlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.AppointmentCalendarLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.AppointmentCalendarLocalId ## -description Gets a string that uniquely identifies the calendar associated with the appointment on the local device. ## -property-value A string that uniquely identifies the calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.AppointmentCalendarLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.AppointmentCalendarLocalId + +## -description +Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + +## -property-value +A string that uniquely identifies the calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_changedproperties.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_changedproperties.md index a8578ce896..bfd99305cd 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_changedproperties.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_changedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ChangedProperties --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ChangedProperties ## -description Gets a list of properties that the user wished to change or set in an appointment. ## -property-value A list of appointment properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ChangedProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ChangedProperties + +## -description +Gets a list of properties that the user wished to change or set in an appointment. + +## -property-value +A list of appointment properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_notifyinvitees.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_notifyinvitees.md index f0dd46d727..c4b4443d46 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_notifyinvitees.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_notifyinvitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.NotifyInvitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.NotifyInvitees ## -description Gets a Boolean value indicating if invitees should be notified. ## -property-value A Boolean value indicating if invitees should be notified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.NotifyInvitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.NotifyInvitees + +## -description +Gets a Boolean value indicating if invitees should be notified. + +## -property-value +A Boolean value indicating if invitees should be notified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportcompletedasync_679049710.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportcompletedasync_679049710.md index a06d2aef6f..3b2c0687a7 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportcompletedasync_679049710.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportcompletedasync_679049710.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportCompletedAsync(Windows.ApplicationModel.Appointments.Appointment) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportCompletedAsync ## -description Notifies the system that the task of creating or updating an appointment has completed. ## -parameters ### -param createdOrUpdatedAppointment The calendar appointment that has been created or updated. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has successfully created or updated an appointment. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportCompletedAsync(Windows.ApplicationModel.Appointments.Appointment) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportCompletedAsync + +## -description +Notifies the system that the task of creating or updating an appointment has completed. + +## -parameters +### -param createdOrUpdatedAppointment +The calendar appointment that has been created or updated. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has successfully created or updated an appointment. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportfailedasync_1210652737.md index fda4d2dbc1..a759d96c1d 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequest_reportfailedasync_1210652737.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportFailedAsync ## -description Notifies the system that the task of creating or updating an appointment has failed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has failed to create or update an appointment. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequest.ReportFailedAsync + +## -description +Notifies the system that the task of creating or updating an appointment has failed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has failed to create or update an appointment. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs.md index d71a70345b..e47fbe7bff 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs ## -description Provides data for a [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs + +## -description +Provides data for a [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_getdeferral_254836512.md index e6bc0cab92..451e6aaba4 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.GetDeferral ## -description Gets the deferral object for the [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. ## -returns The deferral object for the [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.GetDeferral + +## -description +Gets the deferral object for the [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. + +## -returns +The deferral object for the [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_request.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_request.md index b7ba9bfa65..823e24a641 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_request.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcreateorupdateappointmentrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.Request ## -description Gets the [AppointmentCalendarCreateOrUpdateAppointmentRequest](appointmentcalendarcreateorupdateappointmentrequest.md) object for the corresponding [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. ## -property-value The [AppointmentCalendarCreateOrUpdateAppointmentRequest](appointmentcalendarcreateorupdateappointmentrequest.md) object for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCreateOrUpdateAppointmentRequestEventArgs.Request + +## -description +Gets the [AppointmentCalendarCreateOrUpdateAppointmentRequest](appointmentcalendarcreateorupdateappointmentrequest.md) object for the corresponding [CreateOrUpdateAppointmentRequested](appointmentdataproviderconnection_createorupdateappointmentrequested.md) event. + +## -property-value +The [AppointmentCalendarCreateOrUpdateAppointmentRequest](appointmentcalendarcreateorupdateappointmentrequest.md) object for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest.md index f56f27df58..c449222051 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest ## -description Represents the user's request to forward a calendar meeting. ## -remarks The system generates an instance of this class and sets it as a property in the [AppointmentCalendarForwardMeetingRequestEventArgs](appointmentcalendarforwardmeetingrequesteventargs.md) argument of the [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest + +## -description +Represents the user's request to forward a calendar meeting. + +## -remarks +The system generates an instance of this class and sets it as a property in the [AppointmentCalendarForwardMeetingRequestEventArgs](appointmentcalendarforwardmeetingrequesteventargs.md) argument of the [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentcalendarlocalid.md index 69ba81c368..8b7af53994 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentcalendarlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentCalendarLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentCalendarLocalId ## -description Gets a string that uniquely identifies the calendar associated with the appointment on the local device. ## -property-value A string that uniquely identifies the calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentCalendarLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentCalendarLocalId + +## -description +Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + +## -property-value +A string that uniquely identifies the calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentlocalid.md index 4ca168f7b0..f1dd21a45e 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentLocalId ## -description Gets a string that uniquely identifies the appointment on the local device. ## -property-value A string that uniquely identifies the appointment on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentLocalId + +## -description +Gets a string that uniquely identifies the appointment on the local device. + +## -property-value +A string that uniquely identifies the appointment on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentoriginalstarttime.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentoriginalstarttime.md index 1b619a08c7..9dc3e3be11 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentoriginalstarttime.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_appointmentoriginalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentOriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentOriginalStartTime ## -description Gets the original starting time for a recurring appointment. ## -property-value The original starting time for a recurring appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentOriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.AppointmentOriginalStartTime + +## -description +Gets the original starting time for a recurring appointment. + +## -property-value +The original starting time for a recurring appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_comment.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_comment.md index 2c0108728f..a2b8bb5cc3 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_comment.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Comment ## -description Gets a text comment the user may write regarding the forwarding of the meeting. ## -property-value A text comment by the user regarding the forwarding of the meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Comment + +## -description +Gets a text comment the user may write regarding the forwarding of the meeting. + +## -property-value +A text comment by the user regarding the forwarding of the meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_forwardheader.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_forwardheader.md index 9a0fa94a37..b53ab8f3d8 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_forwardheader.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_forwardheader.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ForwardHeader --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ForwardHeader ## -description Gets the new meeting header that includes the new invitees. ## -property-value The new meeting header for the new invitees. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ForwardHeader +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ForwardHeader + +## -description +Gets the new meeting header that includes the new invitees. + +## -property-value +The new meeting header for the new invitees. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_invitees.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_invitees.md index f39ee43f80..cd6e210edf 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_invitees.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_invitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Invitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Invitees ## -description Gets a list of the new invitees to receive the forwarded meeting. ## -property-value A list of new invitees. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Invitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Invitees + +## -description +Gets a list of the new invitees to receive the forwarded meeting. + +## -property-value +A list of new invitees. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportcompletedasync_1707664681.md index a02a3528d4..80951f1efc 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportCompletedAsync ## -description Notifies the system that the task of forwarding a meeting has completed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has successfully forwarded a meeting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportCompletedAsync + +## -description +Notifies the system that the task of forwarding a meeting has completed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has successfully forwarded a meeting. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportfailedasync_1210652737.md index 64ee5a2fa5..73d54eae35 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_reportfailedasync_1210652737.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportFailedAsync ## -description Notifies the system that the task of forwarding a meeting has failed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has failed to forward a meeting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.ReportFailedAsync + +## -description +Notifies the system that the task of forwarding a meeting has failed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has failed to forward a meeting. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_subject.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_subject.md index 91a2012042..afedab1f60 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_subject.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Subject ## -description Gets the subject of the forwarded meeting invitation. ## -property-value The subject of the forwarded meeting invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequest.Subject + +## -description +Gets the subject of the forwarded meeting invitation. + +## -property-value +The subject of the forwarded meeting invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs.md index 2677ee948c..a7cecd71f4 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs ## -description Provides data for a [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs + +## -description +Provides data for a [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_getdeferral_254836512.md index 604ef67f64..e34b09663d 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.GetDeferral ## -description Gets the deferral object for the [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. ## -returns The deferral object for the [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.GetDeferral + +## -description +Gets the deferral object for the [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. + +## -returns +The deferral object for the [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_request.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_request.md index f53dbf7a35..4b46ba2b71 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_request.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarforwardmeetingrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.Request ## -description Gets the [AppointmentCalendarForwardMeetingRequest](appointmentcalendarforwardmeetingrequest.md) object for the corresponding [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. ## -property-value The [ForwardMeetingRequest](appointmentcalendarforwardmeetingrequest.md) object for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarForwardMeetingRequestEventArgs.Request + +## -description +Gets the [AppointmentCalendarForwardMeetingRequest](appointmentcalendarforwardmeetingrequest.md) object for the corresponding [ForwardMeetingRequested](appointmentdataproviderconnection_forwardmeetingrequested.md) event. + +## -property-value +The [ForwardMeetingRequest](appointmentcalendarforwardmeetingrequest.md) object for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest.md index b0a16d087c..56f03605d6 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest ## -description Represents the user's request to change the time of a calendar meeting. ## -remarks The system generates an instance of this class and sets it as a property in the [AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs](appointmentcalendarproposenewtimeformeetingrequesteventargs.md) argument of the [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest + +## -description +Represents the user's request to change the time of a calendar meeting. + +## -remarks +The system generates an instance of this class and sets it as a property in the [AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs](appointmentcalendarproposenewtimeformeetingrequesteventargs.md) argument of the [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentcalendarlocalid.md index e7a6e3fd06..817cb19f57 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentcalendarlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentCalendarLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentCalendarLocalId ## -description Gets a string that uniquely identifies the calendar associated with the appointment on the local device. ## -property-value A string that uniquely identifies the calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentCalendarLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentCalendarLocalId + +## -description +Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + +## -property-value +A string that uniquely identifies the calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentlocalid.md index a9b4758492..d524bd6de3 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentLocalId ## -description Gets a string that uniquely identifies the appointment on the local device. ## -property-value A string that uniquely identifies the appointment on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentLocalId + +## -description +Gets a string that uniquely identifies the appointment on the local device. + +## -property-value +A string that uniquely identifies the appointment on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentoriginalstarttime.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentoriginalstarttime.md index 7e2395c8e3..c8134f5214 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentoriginalstarttime.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_appointmentoriginalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentOriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentOriginalStartTime ## -description Gets the original starting time for a recurring appointment. ## -property-value The original starting time for a recurring appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentOriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.AppointmentOriginalStartTime + +## -description +Gets the original starting time for a recurring appointment. + +## -property-value +The original starting time for a recurring appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_comment.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_comment.md index 5fdc308202..bca8ae8d69 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_comment.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Comment ## -description Gets a text comment the user may write regarding the change in meeting time. ## -property-value A text comment by the user regarding the change in meeting time ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Comment + +## -description +Gets a text comment the user may write regarding the change in meeting time. + +## -property-value +A text comment by the user regarding the change in meeting time + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newduration.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newduration.md index 80f8fb9ad1..0dab278a49 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newduration.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewDuration --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewDuration ## -description Gets the proposed new duration of the meeting. ## -property-value The proposed new duration of the meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewDuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewDuration + +## -description +Gets the proposed new duration of the meeting. + +## -property-value +The proposed new duration of the meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newstarttime.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newstarttime.md index 5ad1b5a56c..a1969188fa 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newstarttime.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_newstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewStartTime ## -description Gets the proposed new start time of the meeting. ## -property-value The proposed new start time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.NewStartTime + +## -description +Gets the proposed new start time of the meeting. + +## -property-value +The proposed new start time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md index 6754e00e35..79fba2de28 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportCompletedAsync ## -description Notifies the system that the task of updating a meeting's time has completed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has successfully pushed a meeting response update. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportCompletedAsync + +## -description +Notifies the system that the task of updating a meeting's time has completed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has successfully pushed a meeting response update. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportfailedasync_1210652737.md index 7871924aa6..a8969c24e6 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_reportfailedasync_1210652737.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportFailedAsync ## -description Notifies the system that the task of updating a meeting's time has failed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has failed to push a meeting time change. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.ReportFailedAsync + +## -description +Notifies the system that the task of updating a meeting's time has failed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has failed to push a meeting time change. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_subject.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_subject.md index 4a9553491b..f05625d62c 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_subject.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Subject ## -description Gets the subject of the new meeting invitation. ## -property-value The subject of the meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequest.Subject + +## -description +Gets the subject of the new meeting invitation. + +## -property-value +The subject of the meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs.md index 0c0ab5c4ec..5dd532d092 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs ## -description Provides data for an [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs + +## -description +Provides data for an [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md index 319f6a862d..06693574b6 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.GetDeferral ## -description Gets the deferral object for the [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. ## -returns The deferral object for the [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.GetDeferral + +## -description +Gets the deferral object for the [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. + +## -returns +The deferral object for the [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_request.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_request.md index 1c0362cf3c..3b7fc8033f 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_request.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarproposenewtimeformeetingrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.Request ## -description Gets the [AppointmentCalendarProposeNewTimeForMeetingRequest](appointmentcalendarproposenewtimeformeetingrequest.md) object for the corresponding [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. ## -property-value The [AppointmentCalendarProposeNewTimeForMeetingRequest](appointmentcalendarproposenewtimeformeetingrequest.md) object for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarProposeNewTimeForMeetingRequestEventArgs.Request + +## -description +Gets the [AppointmentCalendarProposeNewTimeForMeetingRequest](appointmentcalendarproposenewtimeformeetingrequest.md) object for the corresponding [ProposeNewTimeForMeetingRequested](appointmentdataproviderconnection_proposenewtimeformeetingrequested.md) event. + +## -property-value +The [AppointmentCalendarProposeNewTimeForMeetingRequest](appointmentcalendarproposenewtimeformeetingrequest.md) object for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest.md index 0f2a4a36e7..28c93ba7af 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest ## -description Represents the user's request to sync the calendar. ## -remarks The system generates an instance of this class and sets it as a property in the [AppointmentCalendarSyncManagerSyncRequestEventArgs](appointmentcalendarsyncmanagersyncrequesteventargs.md) argument of the [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest + +## -description +Represents the user's request to sync the calendar. + +## -remarks +The system generates an instance of this class and sets it as a property in the [AppointmentCalendarSyncManagerSyncRequestEventArgs](appointmentcalendarsyncmanagersyncrequesteventargs.md) argument of the [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_appointmentcalendarlocalid.md index d3dcd0f521..d193dbdf9f 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_appointmentcalendarlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.AppointmentCalendarLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.AppointmentCalendarLocalId ## -description Gets a string that uniquely identifies the calendar associated with the appointment on the local device. ## -property-value A string that uniquely identifies the calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.AppointmentCalendarLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.AppointmentCalendarLocalId + +## -description +Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + +## -property-value +A string that uniquely identifies the calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportcompletedasync_1707664681.md index 4453a2daa9..e8bfbabbeb 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportCompletedAsync ## -description Notifies the system that the task of syncing the calendar has completed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has successfully synced the calendar. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportCompletedAsync + +## -description +Notifies the system that the task of syncing the calendar has completed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has successfully synced the calendar. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportfailedasync_1210652737.md index 36125797cc..a633b8c60f 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequest_reportfailedasync_1210652737.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportFailedAsync ## -description Notifies the system that the task of syncing the calendar has failed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has failed to sync the calendar. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequest.ReportFailedAsync + +## -description +Notifies the system that the task of syncing the calendar has failed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has failed to sync the calendar. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs.md index 57162eed61..32d36da1d2 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs ## -description Provides data for a [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs + +## -description +Provides data for a [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_getdeferral_254836512.md index 602e2fb725..127941a311 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.GetDeferral ## -description Gets the deferral object for the [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. ## -returns The deferral object for the [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.GetDeferral + +## -description +Gets the deferral object for the [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. + +## -returns +The deferral object for the [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_request.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_request.md index 98ffe7aa80..7519d6bd4b 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_request.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarsyncmanagersyncrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.Request ## -description Gets the [AppointmentCalendarSyncManagerSyncRequest](appointmentcalendarsyncmanagersyncrequest.md) object for the corresponding [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. ## -property-value The [AppointmentCalendarSyncManagerSyncRequest](appointmentcalendarsyncmanagersyncrequest.md) object for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarSyncManagerSyncRequestEventArgs.Request + +## -description +Gets the [AppointmentCalendarSyncManagerSyncRequest](appointmentcalendarsyncmanagersyncrequest.md) object for the corresponding [SyncRequested](appointmentdataproviderconnection_syncrequested.md) event. + +## -property-value +The [AppointmentCalendarSyncManagerSyncRequest](appointmentcalendarsyncmanagersyncrequest.md) object for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest.md index 9287d9fdb3..e9bcdbaee6 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest ## -description Represents the user's request to change the response to a calendar meeting. ## -remarks The system generates an instance of this class and sets it as a property in the [AppointmentCalendarUpdateMeetingResponseRequestEventArgs](appointmentcalendarupdatemeetingresponserequesteventargs.md) argument of the [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest + +## -description +Represents the user's request to change the response to a calendar meeting. + +## -remarks +The system generates an instance of this class and sets it as a property in the [AppointmentCalendarUpdateMeetingResponseRequestEventArgs](appointmentcalendarupdatemeetingresponserequesteventargs.md) argument of the [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentcalendarlocalid.md index 1b3bb8c9ae..1053d14b4e 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentcalendarlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentCalendarLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentCalendarLocalId ## -description Gets a string that uniquely identifies the calendar associated with the appointment on the local device. ## -property-value A string that uniquely identifies the calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentCalendarLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentCalendarLocalId + +## -description +Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + +## -property-value +A string that uniquely identifies the calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentlocalid.md index 0386a4b952..5fe8340b6b 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentlocalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentLocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentLocalId ## -description Gets a string that uniquely identifies the appointment on the local device. ## -property-value A string that uniquely identifies the appointment on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentLocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentLocalId + +## -description +Gets a string that uniquely identifies the appointment on the local device. + +## -property-value +A string that uniquely identifies the appointment on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentoriginalstarttime.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentoriginalstarttime.md index 238342e356..ba875255fd 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentoriginalstarttime.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_appointmentoriginalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentOriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentOriginalStartTime ## -description Gets the original starting time for a recurring appointment. ## -property-value The original starting time for a recurring appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentOriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.AppointmentOriginalStartTime + +## -description +Gets the original starting time for a recurring appointment. + +## -property-value +The original starting time for a recurring appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_comment.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_comment.md index d5d18b71be..ed8f304873 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_comment.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Comment ## -description Gets a text comment the user may write regarding the change in meeting response. ## -property-value A text comment by the user regarding the change in meeting response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Comment + +## -description +Gets a text comment the user may write regarding the change in meeting response. + +## -property-value +A text comment by the user regarding the change in meeting response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportcompletedasync_1707664681.md index 2e8781a99f..c30d3f209c 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportcompletedasync_1707664681.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportCompletedAsync ## -description Notifies the system that the task of updating a meeting response has completed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has successfully pushed a meeting response update. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportCompletedAsync + +## -description +Notifies the system that the task of updating a meeting response has completed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has successfully pushed a meeting response update. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportfailedasync_1210652737.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportfailedasync_1210652737.md index b34d35ac34..aadcecbd3b 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_reportfailedasync_1210652737.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportFailedAsync ## -description Notifies the system that the task of updating a meeting response has failed. ## -returns An asynchronous operation. ## -remarks This method should be called only if the app has failed to push a meeting response update. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.ReportFailedAsync + +## -description +Notifies the system that the task of updating a meeting response has failed. + +## -returns +An asynchronous operation. + +## -remarks +This method should be called only if the app has failed to push a meeting response update. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_response.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_response.md index 2ce7c85cab..d04548d7ba 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_response.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_response.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Response --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Response ## -description Gets the new response the user wishes to give concerning an appointment invitation. ## -property-value The new response the user wishes to give. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Response +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Response + +## -description +Gets the new response the user wishes to give concerning an appointment invitation. + +## -property-value +The new response the user wishes to give. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_sendupdate.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_sendupdate.md index 733d25c238..de7d11681a 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_sendupdate.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_sendupdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.SendUpdate --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.SendUpdate ## -description Indicates whether the user wishes to send an update to the meeting's organizer. ## -property-value The Boolean value indicating whether or not to send the response to the meeting organizer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.SendUpdate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.SendUpdate + +## -description +Indicates whether the user wishes to send an update to the meeting's organizer. + +## -property-value +The Boolean value indicating whether or not to send the response to the meeting organizer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_subject.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_subject.md index b5d7cc40cc..da93a39a2d 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_subject.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Subject ## -description Gets the subject of the response. ## -property-value The subject of the response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequest.Subject + +## -description +Gets the subject of the response. + +## -property-value +The subject of the response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs.md index 385ff63273..2d7161645d 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs ## -description Provides data for an [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs + +## -description +Provides data for an [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_getdeferral_254836512.md index af8ff04861..553d024822 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.GetDeferral ## -description Gets the deferral object for the [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. ## -returns The deferral object for the [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.GetDeferral + +## -description +Gets the deferral object for the [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. + +## -returns +The deferral object for the [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_request.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_request.md index e881464afb..77d027adba 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_request.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarupdatemeetingresponserequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.Request ## -description Gets the [AppointmentCalendarUpdateMeetingResponseRequest](appointmentcalendarupdatemeetingresponserequest.md) object for the corresponding [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. ## -property-value The [AppointmentCalendarUpdateMeetingResponseRequest](appointmentcalendarupdatemeetingresponserequest.md) object for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarUpdateMeetingResponseRequestEventArgs.Request + +## -description +Gets the [AppointmentCalendarUpdateMeetingResponseRequest](appointmentcalendarupdatemeetingresponserequest.md) object for the corresponding [UpdateMeetingResponseRequested](appointmentdataproviderconnection_updatemeetingresponserequested.md) event. + +## -property-value +The [AppointmentCalendarUpdateMeetingResponseRequest](appointmentcalendarupdatemeetingresponserequest.md) object for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection.md index a6ce2eac7e..89834ae086 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection ## -description Describes a connection between app and system for relaying calendar appointment information. ## -remarks This class is instantiated by getting the [Connection](appointmentdataprovidertriggerdetails_connection.md) property of the [AppointmentDataProviderTriggerDetails](appointmentdataprovidertriggerdetails.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection + +## -description +Describes a connection between app and system for relaying calendar appointment information. + +## -remarks +This class is instantiated by getting the [Connection](appointmentdataprovidertriggerdetails_connection.md) property of the [AppointmentDataProviderTriggerDetails](appointmentdataprovidertriggerdetails.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_cancelmeetingrequested.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_cancelmeetingrequested.md index 19309f1fa0..03e49734ea 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_cancelmeetingrequested.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_cancelmeetingrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CancelMeetingRequested --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CancelMeetingRequested ## -description Raised when the user elects to cancel a meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CancelMeetingRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CancelMeetingRequested + +## -description +Raised when the user elects to cancel a meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_createorupdateappointmentrequested.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_createorupdateappointmentrequested.md index de43b54dc5..f3de3a4379 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_createorupdateappointmentrequested.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_createorupdateappointmentrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CreateOrUpdateAppointmentRequested --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CreateOrUpdateAppointmentRequested ## -description Raised when the user elects to create or update a meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CreateOrUpdateAppointmentRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.CreateOrUpdateAppointmentRequested + +## -description +Raised when the user elects to create or update a meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_forwardmeetingrequested.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_forwardmeetingrequested.md index 64a9f86112..f57f0fb54a 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_forwardmeetingrequested.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_forwardmeetingrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ForwardMeetingRequested --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ForwardMeetingRequested ## -description Raised when the user elects to forward a meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ForwardMeetingRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ForwardMeetingRequested + +## -description +Raised when the user elects to forward a meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_proposenewtimeformeetingrequested.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_proposenewtimeformeetingrequested.md index a0bbd426ec..fb44a5fe0e 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_proposenewtimeformeetingrequested.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_proposenewtimeformeetingrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ProposeNewTimeForMeetingRequested --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ProposeNewTimeForMeetingRequested ## -description Raised when the user elects to change the time of a meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ProposeNewTimeForMeetingRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.ProposeNewTimeForMeetingRequested + +## -description +Raised when the user elects to change the time of a meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_start_1587696324.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_start_1587696324.md index 4deca53037..cfbda74cda 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_start_1587696324.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.Start --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.Start ## -description Starts the connection for transfer of data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.Start +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.Start + +## -description +Starts the connection for transfer of data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_syncrequested.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_syncrequested.md index ab34c66f15..e12bc2ceb8 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_syncrequested.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_syncrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.SyncRequested --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.SyncRequested ## -description Raised when the user elects to sync all calendar appointments with the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.SyncRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.SyncRequested + +## -description +Raised when the user elects to sync all calendar appointments with the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_updatemeetingresponserequested.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_updatemeetingresponserequested.md index c41af5cfce..db350c2671 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_updatemeetingresponserequested.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataproviderconnection_updatemeetingresponserequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.UpdateMeetingResponseRequested --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.UpdateMeetingResponseRequested ## -description Raised when the user elects to change their response to a proposed meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.UpdateMeetingResponseRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderConnection.UpdateMeetingResponseRequested + +## -description +Raised when the user elects to change their response to a proposed meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails.md index 58c3f95a98..cda975cf74 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails ## -description Represents trigger information about the background task in which data will be transferred between the app and its caller. ## -remarks Cast this type from a background task's [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails + +## -description +Represents trigger information about the background task in which data will be transferred between the app and its caller. + +## -remarks +Cast this type from a background task's [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails_connection.md b/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails_connection.md index 8aff2370ef..ee78f9ed07 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails_connection.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentdataprovidertriggerdetails_connection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails.Connection --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails.Connection ## -description Gets the data connection over which appointment data can be transferred. ## -property-value The data connection over which appointment data can be transferred. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails.Connection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.DataProvider.AppointmentDataProviderTriggerDetails.Connection + +## -description +Gets the data connection over which appointment data can be transferred. + +## -property-value +The data connection over which appointment data can be transferred. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment.md b/windows.applicationmodel.appointments/appointment.md index 179b442d4b..ee11ae175f 100644 --- a/windows.applicationmodel.appointments/appointment.md +++ b/windows.applicationmodel.appointments/appointment.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.Appointment --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.Appointment ## -description Represents an appointment in a calendar. This class is used when an app is activated using the **AppointmentsProvider** value for [ActivationKind](../windows.applicationmodel.activation/activationkind.md), as a value for [AppointmentInformation](../windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_appointmentinformation.md) properties. ## -remarks For info about how to manage appointments, see [Managing appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538) and [Quickstart: Managing appointments ](http://msdn.microsoft.com/library/4d7c555e-a707-428e-8ce3-1bd278028fc1). ## -examples ## -see-also [Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.Appointment +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.Appointment + +## -description +Represents an appointment in a calendar. This class is used when an app is activated using the **AppointmentsProvider** value for [ActivationKind](../windows.applicationmodel.activation/activationkind.md), as a value for [AppointmentInformation](../windows.applicationmodel.appointments.appointmentsprovider/addappointmentoperation_appointmentinformation.md) properties. + +## -remarks +For info about how to manage appointments, see [Managing appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538) and [Quickstart: Managing appointments ](http://msdn.microsoft.com/library/4d7c555e-a707-428e-8ce3-1bd278028fc1). + +## -examples + +## -see-also +[Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointment_allday.md b/windows.applicationmodel.appointments/appointment_allday.md index f217f4773f..f4ca7c7c79 100644 --- a/windows.applicationmodel.appointments/appointment_allday.md +++ b/windows.applicationmodel.appointments/appointment_allday.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.AllDay --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.AllDay ## -description Gets or sets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment will last all day. The default is **FALSE** for won't last all day. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment will last all day. **TRUE** indicates that the appointment will last all day; otherwise **FALSE**. ## -remarks When creating an appointment with **AllDay** set to true, you should set the [StartTime](appointment_starttime.md) of the appointment to midnight (00:00:00). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.AllDay +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.AllDay + +## -description +Gets or sets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment will last all day. The default is **FALSE** for won't last all day. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment will last all day. **TRUE** indicates that the appointment will last all day; otherwise **FALSE**. + +## -remarks +When creating an appointment with **AllDay** set to true, you should set the [StartTime](appointment_starttime.md) of the appointment to midnight (00:00:00). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_allownewtimeproposal.md b/windows.applicationmodel.appointments/appointment_allownewtimeproposal.md index 2dde9ce391..f1a0442474 100644 --- a/windows.applicationmodel.appointments/appointment_allownewtimeproposal.md +++ b/windows.applicationmodel.appointments/appointment_allownewtimeproposal.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.AllowNewTimeProposal --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.AllowNewTimeProposal ## -description Gets or sets a value that indicates whether the appointment will allow users to propose a new time. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment will allow users to propose a new time. **TRUE** indicates that the appointment does allow new time proposal; otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.AllowNewTimeProposal +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.AllowNewTimeProposal + +## -description +Gets or sets a value that indicates whether the appointment will allow users to propose a new time. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment will allow users to propose a new time. **TRUE** indicates that the appointment does allow new time proposal; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_appointment_1221375020.md b/windows.applicationmodel.appointments/appointment_appointment_1221375020.md index e34235fa03..79ad22ffb0 100644 --- a/windows.applicationmodel.appointments/appointment_appointment_1221375020.md +++ b/windows.applicationmodel.appointments/appointment_appointment_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.Appointment.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.Appointment.Appointment ## -description Initializes a new instance of the [Appointment](appointment.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.Appointment.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Appointment + +## -description +Initializes a new instance of the [Appointment](appointment.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_busystatus.md b/windows.applicationmodel.appointments/appointment_busystatus.md index 583f003643..80cd8c219f 100644 --- a/windows.applicationmodel.appointments/appointment_busystatus.md +++ b/windows.applicationmodel.appointments/appointment_busystatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.BusyStatus --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.BusyStatus ## -description Gets or sets a [AppointmentBusyStatus](appointmentbusystatus.md)-typed value that indicates the busy status for a participant of an appointment. ## -property-value A [AppointmentBusyStatus](appointmentbusystatus.md)-typed value that indicates the busy status for a participant of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.BusyStatus +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.BusyStatus + +## -description +Gets or sets a [AppointmentBusyStatus](appointmentbusystatus.md)-typed value that indicates the busy status for a participant of an appointment. + +## -property-value +A [AppointmentBusyStatus](appointmentbusystatus.md)-typed value that indicates the busy status for a participant of an appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_calendarid.md b/windows.applicationmodel.appointments/appointment_calendarid.md index 18450f93ec..9f90e63406 100644 --- a/windows.applicationmodel.appointments/appointment_calendarid.md +++ b/windows.applicationmodel.appointments/appointment_calendarid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.CalendarId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.CalendarId ## -description Gets the unique identifier for the calendar associated with the appointment. ## -property-value The unique identifier for the calendar associated with the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.CalendarId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.CalendarId + +## -description +Gets the unique identifier for the calendar associated with the appointment. + +## -property-value +The unique identifier for the calendar associated with the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_changenumber.md b/windows.applicationmodel.appointments/appointment_changenumber.md index e4091759af..ebaaf7e367 100644 --- a/windows.applicationmodel.appointments/appointment_changenumber.md +++ b/windows.applicationmodel.appointments/appointment_changenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.ChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.ChangeNumber ## -description Gets the current change number of the local version of the [Appointment](appointment.md). ## -property-value The current change number of the local version of the [Appointment](appointment.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.ChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.ChangeNumber + +## -description +Gets the current change number of the local version of the [Appointment](appointment.md). + +## -property-value +The current change number of the local version of the [Appointment](appointment.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_details.md b/windows.applicationmodel.appointments/appointment_details.md index 0fff368935..d1ce0969fc 100644 --- a/windows.applicationmodel.appointments/appointment_details.md +++ b/windows.applicationmodel.appointments/appointment_details.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Details --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Details ## -description Gets or sets a string value. The string contains extended details that describe the appointment. [Details](appointment_details.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 1,073,741,823 characters in length, which is the maximum length of a JET database string. ## -property-value The extended details that describe the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Details +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Details + +## -description +Gets or sets a string value. The string contains extended details that describe the appointment. [Details](appointment_details.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 1,073,741,823 characters in length, which is the maximum length of a JET database string. + +## -property-value +The extended details that describe the appointment. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_detailskind.md b/windows.applicationmodel.appointments/appointment_detailskind.md index 49051c78ed..953f39e314 100644 --- a/windows.applicationmodel.appointments/appointment_detailskind.md +++ b/windows.applicationmodel.appointments/appointment_detailskind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.DetailsKind --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.DetailsKind ## -description Gets or sets the type of appointment details, plain text or HTML. ## -property-value The type of appointment details. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.DetailsKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.DetailsKind + +## -description +Gets or sets the type of appointment details, plain text or HTML. + +## -property-value +The type of appointment details. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_duration.md b/windows.applicationmodel.appointments/appointment_duration.md index 249b8ef13a..29ed0c28f5 100644 --- a/windows.applicationmodel.appointments/appointment_duration.md +++ b/windows.applicationmodel.appointments/appointment_duration.md @@ -1,3 +1,36 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Duration --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Duration ## -description Gets or sets a time span that represents the time duration of the appointment. [Duration](appointment_duration.md) is of type [TimeSpan](../windows.foundation/timespan.md) and must be non-negative. ## -property-value A time span that represents the duration of the appointment. The duration can't be a negative value. ## -remarks This property uses a time span value, which is represented differently depending on which language you are programming with. + In JavaScript, set the [Duration](appointment_duration.md) value with a **Number** that represents the time interval. Each unit for a [TimeSpan](../windows.foundation/timespan.md) value represents 1 millisecond. For example, this code sets a [Duration](appointment_duration.md) value to 60 minutes (one hour). ```javascript appointment.duration = (60 * 60 * 1000); // 1 hour in 1-millisecond units ``` + In Visual C++ component extensions (C++/CX), use a [TimeSpan](../windows.foundation/timespan.md) structure value with a **Duration** value. In Visual C++ component extensions (C++/CX), each unit for a **Duration** value represents 100 nanoseconds. + In C# or Microsoft Visual Basic, you use a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) value. You can use utility API of [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) such as [FromSeconds](XREF:TODO:M:System.TimeSpan.FromSeconds(System.Double)) to generate a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) and set the value. > [!NOTE] > In JavaScript, [TimeSpan](../windows.foundation/timespan.md) is accessed as a value, not as an object. For example, use `var a = 10000`, not `var a = { duration: 10000 }`. Also, in JavaScript, [TimeSpan](../windows.foundation/timespan.md) is treated as the number of millisecond intervals, not the number of 100-nanosecond intervals so you can lose precision when you port [TimeSpan](../windows.foundation/timespan.md) values between languages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Duration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Duration + +## -description +Gets or sets a time span that represents the time duration of the appointment. [Duration](appointment_duration.md) is of type [TimeSpan](../windows.foundation/timespan.md) and must be non-negative. + +## -property-value +A time span that represents the duration of the appointment. The duration can't be a negative value. + +## -remarks +This property uses a time span value, which is represented differently depending on which language you are programming with. ++ In JavaScript, set the [Duration](appointment_duration.md) value with a **Number** that represents the time interval. Each unit for a [TimeSpan](../windows.foundation/timespan.md) value represents 1 millisecond. For example, this code sets a [Duration](appointment_duration.md) value to 60 minutes (one hour). ```javascript +appointment.duration = (60 * 60 * 1000); // 1 hour in 1-millisecond units +``` + + ++ In Visual C++ component extensions (C++/CX), use a [TimeSpan](../windows.foundation/timespan.md) structure value with a **Duration** value. In Visual C++ component extensions (C++/CX), each unit for a **Duration** value represents 100 nanoseconds. ++ In C# or Microsoft Visual Basic, you use a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) value. You can use utility API of [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) such as [FromSeconds](XREF:TODO:M:System.TimeSpan.FromSeconds(System.Double)) to generate a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) and set the value. + + + + +> [!NOTE] +> In JavaScript, [TimeSpan](../windows.foundation/timespan.md) is accessed as a value, not as an object. For example, use `var a = 10000`, not `var a = { duration: 10000 }`. Also, in JavaScript, [TimeSpan](../windows.foundation/timespan.md) is treated as the number of millisecond intervals, not the number of 100-nanosecond intervals so you can lose precision when you port [TimeSpan](../windows.foundation/timespan.md) values between languages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_hasinvitees.md b/windows.applicationmodel.appointments/appointment_hasinvitees.md index 46b44fc89d..fdb46ae892 100644 --- a/windows.applicationmodel.appointments/appointment_hasinvitees.md +++ b/windows.applicationmodel.appointments/appointment_hasinvitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.HasInvitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.HasInvitees ## -description Gets a value that indicates whether the appointment has invitees. ## -property-value A value that indicates whether the appointment has invitees. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.HasInvitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.HasInvitees + +## -description +Gets a value that indicates whether the appointment has invitees. + +## -property-value +A value that indicates whether the appointment has invitees. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_invitees.md b/windows.applicationmodel.appointments/appointment_invitees.md index cac60d74ba..10ac65e57e 100644 --- a/windows.applicationmodel.appointments/appointment_invitees.md +++ b/windows.applicationmodel.appointments/appointment_invitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Invitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Invitees ## -description Gets the list of participants for the appointment. [Invitees](appointment_invitees.md) is of type [IVector(AppointmentInvitee)](../windows.foundation.collections/ivector_1.md). If an organizer is set and invitee length is greater than 0, a call to an [AppointmentManager](appointmentmanager.md)API fails with **E_INVALIDARG**. The number of invitees is unlimited. ## -property-value The list of participants for the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Invitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Invitees + +## -description +Gets the list of participants for the appointment. [Invitees](appointment_invitees.md) is of type [IVector(AppointmentInvitee)](../windows.foundation.collections/ivector_1.md). If an organizer is set and invitee length is greater than 0, a call to an [AppointmentManager](appointmentmanager.md)API fails with **E_INVALIDARG**. The number of invitees is unlimited. + +## -property-value +The list of participants for the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_iscanceledmeeting.md b/windows.applicationmodel.appointments/appointment_iscanceledmeeting.md index 173fe85bfd..6b18707a99 100644 --- a/windows.applicationmodel.appointments/appointment_iscanceledmeeting.md +++ b/windows.applicationmodel.appointments/appointment_iscanceledmeeting.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.IsCanceledMeeting --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.IsCanceledMeeting ## -description Gets or sets a value that indicates whether the appointment has been cancelled. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment has been cancelled. **TRUE** indicates that the appointment has been cancelled; otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.IsCanceledMeeting +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.IsCanceledMeeting + +## -description +Gets or sets a value that indicates whether the appointment has been cancelled. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment has been cancelled. **TRUE** indicates that the appointment has been cancelled; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_isorganizedbyuser.md b/windows.applicationmodel.appointments/appointment_isorganizedbyuser.md index c4db2668d9..0f328adc84 100644 --- a/windows.applicationmodel.appointments/appointment_isorganizedbyuser.md +++ b/windows.applicationmodel.appointments/appointment_isorganizedbyuser.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.IsOrganizedByUser --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.IsOrganizedByUser ## -description Gets or sets a value that indicates whether the appointment was organized by the current user. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment was organized by the current user **TRUE** indicates that the appointment was organized by the user; otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.IsOrganizedByUser +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.IsOrganizedByUser + +## -description +Gets or sets a value that indicates whether the appointment was organized by the current user. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the appointment was organized by the current user **TRUE** indicates that the appointment was organized by the user; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_isresponserequested.md b/windows.applicationmodel.appointments/appointment_isresponserequested.md index a4c7b9af90..9468b7f7bf 100644 --- a/windows.applicationmodel.appointments/appointment_isresponserequested.md +++ b/windows.applicationmodel.appointments/appointment_isresponserequested.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.IsResponseRequested --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.IsResponseRequested ## -description Gets or sets a value that indicates whether a response to the appointment invitation is requested. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether a response is requested. **TRUE** indicates that a response is requested; otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.IsResponseRequested +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.IsResponseRequested + +## -description +Gets or sets a value that indicates whether a response to the appointment invitation is requested. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether a response is requested. **TRUE** indicates that a response is requested; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_localid.md b/windows.applicationmodel.appointments/appointment_localid.md index adeb62ec32..b7cc2b5389 100644 --- a/windows.applicationmodel.appointments/appointment_localid.md +++ b/windows.applicationmodel.appointments/appointment_localid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.LocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.LocalId ## -description Gets a string that uniquely identifies the appointment on the local device. ## -property-value A string that uniquely identifies the appointment on the local device. ## -remarks The ID retrieved with this property is guaranteed to be unique on the local device. To associate appointments across devices, use [RoamingId](appointment_roamingid.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.LocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.LocalId + +## -description +Gets a string that uniquely identifies the appointment on the local device. + +## -property-value +A string that uniquely identifies the appointment on the local device. + +## -remarks +The ID retrieved with this property is guaranteed to be unique on the local device. To associate appointments across devices, use [RoamingId](appointment_roamingid.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_location.md b/windows.applicationmodel.appointments/appointment_location.md index 17b4cba292..04741f19b2 100644 --- a/windows.applicationmodel.appointments/appointment_location.md +++ b/windows.applicationmodel.appointments/appointment_location.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Location --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Location ## -description Gets or sets a string that communicates the physical location of the appointment. [Location](appointment_location.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 32,768 characters in length. ## -property-value The location of the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Location +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Location + +## -description +Gets or sets a string that communicates the physical location of the appointment. [Location](appointment_location.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 32,768 characters in length. + +## -property-value +The location of the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_onlinemeetinglink.md b/windows.applicationmodel.appointments/appointment_onlinemeetinglink.md index 998968bec8..504fdfd1a0 100644 --- a/windows.applicationmodel.appointments/appointment_onlinemeetinglink.md +++ b/windows.applicationmodel.appointments/appointment_onlinemeetinglink.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.OnlineMeetingLink --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.OnlineMeetingLink ## -description Gets or sets a string value that is a URL used to join the online meeting for the appointment. ## -property-value A string value that is a URL used to join the online meeting for the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.OnlineMeetingLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.OnlineMeetingLink + +## -description +Gets or sets a string value that is a URL used to join the online meeting for the appointment. + +## -property-value +A string value that is a URL used to join the online meeting for the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_organizer.md b/windows.applicationmodel.appointments/appointment_organizer.md index 8b3aeefb38..9b2ac3c160 100644 --- a/windows.applicationmodel.appointments/appointment_organizer.md +++ b/windows.applicationmodel.appointments/appointment_organizer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Organizer --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Organizer ## -description Gets or sets the organizer of the appointment. [Organizer](appointment_organizer.md) is of type [AppointmentOrganizer](appointmentorganizer.md). If an organizer is set and invitee length is greater than 0, a call to an [AppointmentManager](appointmentmanager.md)API fails with **E_INVALIDARG**. The number of invitees is unlimited. ## -property-value A [AppointmentOrganizer](appointmentorganizer.md) object that indicates the organizer of the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Organizer +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Organizer + +## -description +Gets or sets the organizer of the appointment. [Organizer](appointment_organizer.md) is of type [AppointmentOrganizer](appointmentorganizer.md). If an organizer is set and invitee length is greater than 0, a call to an [AppointmentManager](appointmentmanager.md)API fails with **E_INVALIDARG**. The number of invitees is unlimited. + +## -property-value +A [AppointmentOrganizer](appointmentorganizer.md) object that indicates the organizer of the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_originalstarttime.md b/windows.applicationmodel.appointments/appointment_originalstarttime.md index 1e9db56367..632e01baf1 100644 --- a/windows.applicationmodel.appointments/appointment_originalstarttime.md +++ b/windows.applicationmodel.appointments/appointment_originalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.OriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.OriginalStartTime ## -description Gets the original starting time for a recurring appointment. ## -property-value The original starting time for a recurring appointment.. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.OriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.OriginalStartTime + +## -description +Gets the original starting time for a recurring appointment. + +## -property-value +The original starting time for a recurring appointment.. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_recurrence.md b/windows.applicationmodel.appointments/appointment_recurrence.md index 38bf3a586c..aac55d24f4 100644 --- a/windows.applicationmodel.appointments/appointment_recurrence.md +++ b/windows.applicationmodel.appointments/appointment_recurrence.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Recurrence --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Recurrence ## -description Gets or sets the object that describes when and how often the appointment occurs. [Recurrence](appointment_recurrence.md) is of type [AppointmentRecurrence](appointmentrecurrence.md). ## -property-value A [AppointmentRecurrence](appointmentrecurrence.md) object that describes when and how often the appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Recurrence +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Recurrence + +## -description +Gets or sets the object that describes when and how often the appointment occurs. [Recurrence](appointment_recurrence.md) is of type [AppointmentRecurrence](appointmentrecurrence.md). + +## -property-value +A [AppointmentRecurrence](appointmentrecurrence.md) object that describes when and how often the appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_reminder.md b/windows.applicationmodel.appointments/appointment_reminder.md index 1a01698b86..0cd8ce4269 100644 --- a/windows.applicationmodel.appointments/appointment_reminder.md +++ b/windows.applicationmodel.appointments/appointment_reminder.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Reminder --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Reminder ## -description Gets or sets a time span value. The value declares the amount of time to subtract from the [StartTime](appointment_starttime.md), and that time used as the issue time for a reminder for an appointment. A **null** value indicates that the appointment will not issue a reminder. [Reminder](appointment_reminder.md) is of type [IReference(TimeSpan)](../windows.foundation/ireference_1.md). ## -property-value A time span value, or **null** to issue no reminder. ## -remarks This property uses a time span value, which is represented differently depending on which language you are programming with. For more information about how to use a time span value, see the [Duration](appointment_duration.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Reminder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Reminder + +## -description +Gets or sets a time span value. The value declares the amount of time to subtract from the [StartTime](appointment_starttime.md), and that time used as the issue time for a reminder for an appointment. A **null** value indicates that the appointment will not issue a reminder. [Reminder](appointment_reminder.md) is of type [IReference(TimeSpan)](../windows.foundation/ireference_1.md). + +## -property-value +A time span value, or **null** to issue no reminder. + +## -remarks +This property uses a time span value, which is represented differently depending on which language you are programming with. For more information about how to use a time span value, see the [Duration](appointment_duration.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_remotechangenumber.md b/windows.applicationmodel.appointments/appointment_remotechangenumber.md index 1213bcb59c..032a76e0ec 100644 --- a/windows.applicationmodel.appointments/appointment_remotechangenumber.md +++ b/windows.applicationmodel.appointments/appointment_remotechangenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.RemoteChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.RemoteChangeNumber ## -description Gets or sets the current change number of the server version of the [Appointment](appointment.md). ## -property-value The current change number of the server version of the [Appointment](appointment.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.RemoteChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.RemoteChangeNumber + +## -description +Gets or sets the current change number of the server version of the [Appointment](appointment.md). + +## -property-value +The current change number of the server version of the [Appointment](appointment.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_replytime.md b/windows.applicationmodel.appointments/appointment_replytime.md index d0ffcbd5f6..c487eee544 100644 --- a/windows.applicationmodel.appointments/appointment_replytime.md +++ b/windows.applicationmodel.appointments/appointment_replytime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.ReplyTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.ReplyTime ## -description Gets or sets the date and time that the user responded to the appointment request. ## -property-value The date and time that the user responded to the appointment request. ## -remarks The **ReplyTime** date you provide should be in the local time of the device since 12:01 AM, January 1, 1601 A.D. (C.E.) . ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.ReplyTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.ReplyTime + +## -description +Gets or sets the date and time that the user responded to the appointment request. + +## -property-value +The date and time that the user responded to the appointment request. + +## -remarks +The **ReplyTime** date you provide should be in the local time of the device since 12:01 AM, January 1, 1601 A.D. (C.E.) . + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_roamingid.md b/windows.applicationmodel.appointments/appointment_roamingid.md index cb1dc4120c..7e432384bb 100644 --- a/windows.applicationmodel.appointments/appointment_roamingid.md +++ b/windows.applicationmodel.appointments/appointment_roamingid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.RoamingId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.RoamingId ## -description Gets or sets a string that uniquely identifies an appointment across devices. ## -property-value A string that uniquely identifies an appointment across devices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.RoamingId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.RoamingId + +## -description +Gets or sets a string that uniquely identifies an appointment across devices. + +## -property-value +A string that uniquely identifies an appointment across devices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_sensitivity.md b/windows.applicationmodel.appointments/appointment_sensitivity.md index cc1fee0f11..c2e7be40b8 100644 --- a/windows.applicationmodel.appointments/appointment_sensitivity.md +++ b/windows.applicationmodel.appointments/appointment_sensitivity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Sensitivity --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Sensitivity ## -description Gets or sets a [AppointmentSensitivity](appointmentsensitivity.md)-typed value that indicates the sensitivity of the appointment. ## -property-value A [AppointmentSensitivity](appointmentsensitivity.md)-typed value that indicates the sensitivity of the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Sensitivity +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Sensitivity + +## -description +Gets or sets a [AppointmentSensitivity](appointmentsensitivity.md)-typed value that indicates the sensitivity of the appointment. + +## -property-value +A [AppointmentSensitivity](appointmentsensitivity.md)-typed value that indicates the sensitivity of the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_starttime.md b/windows.applicationmodel.appointments/appointment_starttime.md index f2bf95098d..554ea92ac3 100644 --- a/windows.applicationmodel.appointments/appointment_starttime.md +++ b/windows.applicationmodel.appointments/appointment_starttime.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.StartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.StartTime ## -description Gets or sets the starting time for the appointment. [StartTime](appointment_starttime.md) is of type [DateTime](../windows.foundation/datetime.md). ## -property-value The date and time to use as the starting time for the appointment. ## -remarks This property uses an object representing date and time, and that object is represented differently depending on which language you are programming with. + In JavaScript, set the [StartTime](appointment_starttime.md) value with a **Date** object. For example, this code sets a [StartTime](appointment_starttime.md) value to a specific date and time. ```javascript appointment.startTime = new Date(2015, 9, 10, 9); // October 10th, 2015 at 9:00am ``` + In Visual C++ component extensions (C++/CX), use a [DateTime](../windows.foundation/datetime.md) structure value. + In C# or Microsoft Visual Basic, you use a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) value. You can use utility API of [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) to generate a [DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) from different inputs (local time, parsed strings, and so on) and set the value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.StartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.StartTime + +## -description +Gets or sets the starting time for the appointment. [StartTime](appointment_starttime.md) is of type [DateTime](../windows.foundation/datetime.md). + +## -property-value +The date and time to use as the starting time for the appointment. + +## -remarks +This property uses an object representing date and time, and that object is represented differently depending on which language you are programming with. ++ In JavaScript, set the [StartTime](appointment_starttime.md) value with a **Date** object. For example, this code sets a [StartTime](appointment_starttime.md) value to a specific date and time. ```javascript +appointment.startTime = new Date(2015, 9, 10, 9); // October 10th, 2015 at 9:00am +``` + + ++ In Visual C++ component extensions (C++/CX), use a [DateTime](../windows.foundation/datetime.md) structure value. ++ In C# or Microsoft Visual Basic, you use a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) value. You can use utility API of [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) to generate a [DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) from different inputs (local time, parsed strings, and so on) and set the value. + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_subject.md b/windows.applicationmodel.appointments/appointment_subject.md index 40ba1fa01f..3d4b3f393e 100644 --- a/windows.applicationmodel.appointments/appointment_subject.md +++ b/windows.applicationmodel.appointments/appointment_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Subject ## -description Gets or sets a string that communicates the subject of the appointment. [Subject](appointment_subject.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 255 characters in length. ## -property-value The subject of the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Subject + +## -description +Gets or sets a string that communicates the subject of the appointment. [Subject](appointment_subject.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 255 characters in length. + +## -property-value +The subject of the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_uri.md b/windows.applicationmodel.appointments/appointment_uri.md index 407e56f8db..64f3ef224d 100644 --- a/windows.applicationmodel.appointments/appointment_uri.md +++ b/windows.applicationmodel.appointments/appointment_uri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.Uri ## -description Gets the Uniform Resource Identifier ([Uri](../windows.foundation/uri.md)) for the appointment. Allows the Calendar app to perform an association launch to go back to the source app or other URI that represents this appointment. ## -property-value The URI for the appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.Uri + +## -description +Gets the Uniform Resource Identifier ([Uri](../windows.foundation/uri.md)) for the appointment. Allows the Calendar app to perform an association launch to go back to the source app or other URI that represents this appointment. + +## -property-value +The URI for the appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointment_userresponse.md b/windows.applicationmodel.appointments/appointment_userresponse.md index d621d7eb6b..d97b177878 100644 --- a/windows.applicationmodel.appointments/appointment_userresponse.md +++ b/windows.applicationmodel.appointments/appointment_userresponse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.Appointment.UserResponse --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.Appointment.UserResponse ## -description Gets or sets the user's response to the appointment request. ## -property-value The user's response to the appointment request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.Appointment.UserResponse +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.Appointment.UserResponse + +## -description +Gets or sets the user's response to the appointment request. + +## -property-value +The user's response to the appointment request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar.md b/windows.applicationmodel.appointments/appointmentcalendar.md index 8fe0453ec9..d83930f3f1 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar.md +++ b/windows.applicationmodel.appointments/appointmentcalendar.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentCalendar --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar ## -description Represents a calendar with appointments. ## -remarks Call the [AppointmentStore.CreateAppointmentCalendarAsync](appointmentstore_createappointmentcalendarasync.md), the [AppointmentStore.FindAppointmentCalendarsAsync](appointmentstore_findappointmentcalendarsasync.md), or the [AppointmentStore.GetAppointmentCalendarAsync](appointmentstore_getappointmentcalendarasync.md) method to obtain an instance of this class. ## -examples ## -see-also [Appointment](appointment.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentCalendar +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar + +## -description +Represents a calendar with appointments. + +## -remarks +Call the [AppointmentStore.CreateAppointmentCalendarAsync](appointmentstore_createappointmentcalendarasync.md), the [AppointmentStore.FindAppointmentCalendarsAsync](appointmentstore_findappointmentcalendarsasync.md), or the [AppointmentStore.GetAppointmentCalendarAsync](appointmentstore_getappointmentcalendarasync.md) method to obtain an instance of this class. + +## -examples + +## -see-also +[Appointment](appointment.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_cancancelmeetings.md b/windows.applicationmodel.appointments/appointmentcalendar_cancancelmeetings.md index 4a5c0e7fb7..c52bf45fd3 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_cancancelmeetings.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_cancancelmeetings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCancelMeetings --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCancelMeetings ## -description Gets or sets a Boolean value that indicates if the calendar supports cancelling meetings. ## -property-value Boolean value that indicates if the calendar supports cancelling meetings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCancelMeetings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCancelMeetings + +## -description +Gets or sets a Boolean value that indicates if the calendar supports cancelling meetings. + +## -property-value +Boolean value that indicates if the calendar supports cancelling meetings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_cancreateorupdateappointments.md b/windows.applicationmodel.appointments/appointmentcalendar_cancreateorupdateappointments.md index ee08aa8e8b..612bf87d7c 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_cancreateorupdateappointments.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_cancreateorupdateappointments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCreateOrUpdateAppointments --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCreateOrUpdateAppointments ## -description Gets or sets a Boolean value that indicates if the calendar supports creating or updating appointments. ## -property-value Boolean value that indicates if the calendar supports creating or updating appointments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCreateOrUpdateAppointments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.CanCreateOrUpdateAppointments + +## -description +Gets or sets a Boolean value that indicates if the calendar supports creating or updating appointments. + +## -property-value +Boolean value that indicates if the calendar supports creating or updating appointments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_canforwardmeetings.md b/windows.applicationmodel.appointments/appointmentcalendar_canforwardmeetings.md index 1340402a29..07ff0a4913 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_canforwardmeetings.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_canforwardmeetings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanForwardMeetings --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.CanForwardMeetings ## -description Gets or sets a Boolean value that indicates if the calendar supports forwarding meetings. ## -property-value Boolean value that indicates if the calendar supports forwarding meetings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanForwardMeetings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.CanForwardMeetings + +## -description +Gets or sets a Boolean value that indicates if the calendar supports forwarding meetings. + +## -property-value +Boolean value that indicates if the calendar supports forwarding meetings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_cannotifyinvitees.md b/windows.applicationmodel.appointments/appointmentcalendar_cannotifyinvitees.md index 197d857a68..d5531546a5 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_cannotifyinvitees.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_cannotifyinvitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanNotifyInvitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.CanNotifyInvitees ## -description Gets or sets a Boolean value that indicates if the calendar supports notifying attendees. ## -property-value Boolean value that indicates if the calendar supports notifying attendees. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanNotifyInvitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.CanNotifyInvitees + +## -description +Gets or sets a Boolean value that indicates if the calendar supports notifying attendees. + +## -property-value +Boolean value that indicates if the calendar supports notifying attendees. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_canproposenewtimeformeetings.md b/windows.applicationmodel.appointments/appointmentcalendar_canproposenewtimeformeetings.md index 88e20473ad..ebbe9b8fee 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_canproposenewtimeformeetings.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_canproposenewtimeformeetings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanProposeNewTimeForMeetings --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.CanProposeNewTimeForMeetings ## -description Gets or sets a Boolean value that indicates if the calendar supports proposing new meeting times. ## -property-value Boolean value that indicates if the calendar supports proposing new meeting times. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanProposeNewTimeForMeetings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.CanProposeNewTimeForMeetings + +## -description +Gets or sets a Boolean value that indicates if the calendar supports proposing new meeting times. + +## -property-value +Boolean value that indicates if the calendar supports proposing new meeting times. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_canupdatemeetingresponses.md b/windows.applicationmodel.appointments/appointmentcalendar_canupdatemeetingresponses.md index 35763ed635..34d66ec301 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_canupdatemeetingresponses.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_canupdatemeetingresponses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanUpdateMeetingResponses --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.CanUpdateMeetingResponses ## -description Gets or sets a Boolean value that indicates if the calendar supports updating meeting responses. ## -property-value Boolean value that indicates if the calendar supports updating meeting responses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.CanUpdateMeetingResponses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.CanUpdateMeetingResponses + +## -description +Gets or sets a Boolean value that indicates if the calendar supports updating meeting responses. + +## -property-value +Boolean value that indicates if the calendar supports updating meeting responses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentasync_1952116099.md b/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentasync_1952116099.md index 7902aa46ae..193ce3de91 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentasync_1952116099.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentasync_1952116099.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentAsync ## -description Asynchronously deletes the appointment with the specified ID. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be deleted. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentAsync + +## -description +Asynchronously deletes the appointment with the specified ID. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be deleted. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentinstanceasync_1725169347.md b/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentinstanceasync_1725169347.md index 3744aa3915..9d3d01da9b 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentinstanceasync_1725169347.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_deleteappointmentinstanceasync_1725169347.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentInstanceAsync(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentInstanceAsync ## -description Asynchronously deletes the appointment instance with the specified start time of a master appointment with the specified ID. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the master appointment associated with the appointment instance to be deleted. ### -param instanceStartTime The start time of the appointment instance to be deleted. This must be the original start date of the instance. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentInstanceAsync(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAppointmentInstanceAsync + +## -description +Asynchronously deletes the appointment instance with the specified start time of a master appointment with the specified ID. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the master appointment associated with the appointment instance to be deleted. + +### -param instanceStartTime +The start time of the appointment instance to be deleted. This must be the original start date of the instance. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_deleteasync_1247887881.md b/windows.applicationmodel.appointments/appointmentcalendar_deleteasync_1247887881.md index de6c8a4b83..b5579ed0df 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_deleteasync_1247887881.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_deleteasync_1247887881.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAsync ## -description Asynchronously deletes the appointment calendar. ## -returns An asynchrounous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.DeleteAsync + +## -description +Asynchronously deletes the appointment calendar. + +## -returns +An asynchrounous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_displaycolor.md b/windows.applicationmodel.appointments/appointmentcalendar_displaycolor.md index 26a138abf6..2b37eb9bd9 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_displaycolor.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_displaycolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayColor --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayColor ## -description Gets the color that the built-in calendar app uses for appointments associated with the calendar. ## -property-value An unsigned integer representing the color that the built-in calendar app uses for appointments associated with the calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayColor + +## -description +Gets the color that the built-in calendar app uses for appointments associated with the calendar. + +## -property-value +An unsigned integer representing the color that the built-in calendar app uses for appointments associated with the calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_displayname.md b/windows.applicationmodel.appointments/appointmentcalendar_displayname.md index 1f58763347..33e3aa710e 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_displayname.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayName ## -description Gets a string representing the display name for the [AppointmentCalendar](appointmentcalendar.md). ## -property-value A string representing the display name for the [AppointmentCalendar](appointmentcalendar.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.DisplayName + +## -description +Gets a string representing the display name for the [AppointmentCalendar](appointmentcalendar.md). + +## -property-value +A string representing the display name for the [AppointmentCalendar](appointmentcalendar.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_1216357868.md b/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_1216357868.md index 39babf9fb1..1713a65b32 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_1216357868.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_1216357868.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync(System.String,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.ApplicationModel.Appointments.FindAppointmentsOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync ## -description Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria. ## -parameters ### -param masterLocalId The [LocalId](appointment_localid.md) of the master appointment for which appointment instances are retrieved. ### -param rangeStart The start time of the time window for which appointment instances are retrieved. ### -param rangeLength The length of the time window for which appointment instances are retrieved. ### -param pOptions A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. ## -returns An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. ## -remarks ## -examples ## -see-also [FindAllInstancesAsync(String, DateTime, TimeSpan)](appointmentcalendar_findallinstancesasync_841982484.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync(System.String,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.ApplicationModel.Appointments.FindAppointmentsOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync + +## -description +Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria. + +## -parameters +### -param masterLocalId +The [LocalId](appointment_localid.md) of the master appointment for which appointment instances are retrieved. + +### -param rangeStart +The start time of the time window for which appointment instances are retrieved. + +### -param rangeLength +The length of the time window for which appointment instances are retrieved. + +### -param pOptions +A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. + +## -returns +An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[FindAllInstancesAsync(String, DateTime, TimeSpan)](appointmentcalendar_findallinstancesasync_841982484.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_841982484.md b/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_841982484.md index 6633e23e51..1873b7084e 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_841982484.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findallinstancesasync_841982484.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync(System.String,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync ## -description Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria. ## -parameters ### -param masterLocalId The [LocalId](appointment_localid.md) of the master appointment for which appointment instances are retrieved. ### -param rangeStart The start time of the time window for which appointment instances are retrieved. ### -param rangeLength The length of the time window for which appointment instances are retrieved. ## -returns An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. ## -remarks ## -examples ## -see-also [FindAllInstancesAsync(String, DateTime, TimeSpan, FindAppointmentsOptions)](appointmentcalendar_findallinstancesasync_1216357868.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync(System.String,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAllInstancesAsync + +## -description +Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria. + +## -parameters +### -param masterLocalId +The [LocalId](appointment_localid.md) of the master appointment for which appointment instances are retrieved. + +### -param rangeStart +The start time of the time window for which appointment instances are retrieved. + +### -param rangeLength +The length of the time window for which appointment instances are retrieved. + +## -returns +An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[FindAllInstancesAsync(String, DateTime, TimeSpan, FindAppointmentsOptions)](appointmentcalendar_findallinstancesasync_1216357868.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_1659613836.md b/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_1659613836.md index 298571510b..ac041390e0 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_1659613836.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_1659613836.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync ## -description Asynchronously retrieves a list of appointments belonging to the current [AppointmentCalendar](appointmentcalendar.md) that meet the specified criteria. ## -parameters ### -param rangeStart The start time of the time window for which appointments are retrieved. ### -param rangeLength The length of the time window for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. ## -remarks ## -examples ## -see-also [FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)](appointmentcalendar_findappointmentsasync_541298316.md), [Appointment](appointment.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync + +## -description +Asynchronously retrieves a list of appointments belonging to the current [AppointmentCalendar](appointmentcalendar.md) that meet the specified criteria. + +## -parameters +### -param rangeStart +The start time of the time window for which appointments are retrieved. + +### -param rangeLength +The length of the time window for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. + +## -remarks + +## -examples + +## -see-also +[FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)](appointmentcalendar_findappointmentsasync_541298316.md), [Appointment](appointment.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_541298316.md b/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_541298316.md index fdc42bc3e0..edea7d7993 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_541298316.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findappointmentsasync_541298316.md @@ -1,3 +1,55 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.ApplicationModel.Appointments.FindAppointmentsOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync ## -description Asynchronously retrieves a list of appointments belonging to the current [AppointmentCalendar](appointmentcalendar.md) that meet the specified criteria. ## -parameters ### -param rangeStart The start time of the time window for which appointments are retrieved. ### -param rangeLength The length of the time window for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. ### -param options A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. You must set the *options* parameter to specify the values to retrieve. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. ## -remarks > [!IMPORTANT] > For performance reasons, [FindAppointmentsAsync](appointmentcalendar_findappointmentsasync.md) will not load most properties. To load specific properties, add values to the [FindAppointmentsOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) member in the *options* parameter. ## -examples Set [FindAppointmentOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) to specify the values to retrieve. ```csharp AppointmentStore calendar = await AppointmentManager.RequestStoreAsync(AppointmentStoreAccessType.AllCalendarsReadOnly); // Specify which values to retrieve FindAppointmentsOptions options = new FindAppointmentsOptions(); options.FetchProperties.Add(AppointmentProperties.Subject); options.FetchProperties.Add(AppointmentProperties.Details); options.FetchProperties.Add(AppointmentProperties.DetailsKind); var iteratingAppointments = await calendar.FindAppointmentsAsync(DateTimeOffset.Now, TimeSpan.FromDays(31), options); foreach (var i in iteratingAppointments) { // do stuff with each appointment } ``` ## -see-also [FindAppointmentsAsync(DateTime, TimeSpan)](appointmentcalendar_findappointmentsasync_1659613836.md), [Appointment](appointment.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.ApplicationModel.Appointments.FindAppointmentsOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindAppointmentsAsync + +## -description +Asynchronously retrieves a list of appointments belonging to the current [AppointmentCalendar](appointmentcalendar.md) that meet the specified criteria. + +## -parameters +### -param rangeStart +The start time of the time window for which appointments are retrieved. + +### -param rangeLength +The length of the time window for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. + +### -param options +A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. You must set the *options* parameter to specify the values to retrieve. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. + +## -remarks +> [!IMPORTANT] +> For performance reasons, [FindAppointmentsAsync](appointmentcalendar_findappointmentsasync.md) will not load most properties. To load specific properties, add values to the [FindAppointmentsOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) member in the *options* parameter. + +## -examples +Set [FindAppointmentOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) to specify the values to retrieve. + +```csharp +AppointmentStore calendar = await AppointmentManager.RequestStoreAsync(AppointmentStoreAccessType.AllCalendarsReadOnly); + +// Specify which values to retrieve +FindAppointmentsOptions options = new FindAppointmentsOptions(); +options.FetchProperties.Add(AppointmentProperties.Subject); +options.FetchProperties.Add(AppointmentProperties.Details); +options.FetchProperties.Add(AppointmentProperties.DetailsKind); + +var iteratingAppointments = await calendar.FindAppointmentsAsync(DateTimeOffset.Now, TimeSpan.FromDays(31), options); + +foreach (var i in iteratingAppointments) +{ + // do stuff with each appointment +} +``` + + + +## -see-also +[FindAppointmentsAsync(DateTime, TimeSpan)](appointmentcalendar_findappointmentsasync_1659613836.md), [Appointment](appointment.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findexceptionsfrommasterasync_44953172.md b/windows.applicationmodel.appointments/appointmentcalendar_findexceptionsfrommasterasync_44953172.md index 6a042d0770..14cf3fdf14 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findexceptionsfrommasterasync_44953172.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findexceptionsfrommasterasync_44953172.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindExceptionsFromMasterAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindExceptionsFromMasterAsync ## -description Asynchronously retrieves a list of appointment instances that are exceptions from the specified master appointment. ## -parameters ### -param masterLocalId The [LocalId](appointment_localid.md) of the master appointment for which exceptional appointment instances are retrieved. ## -returns An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindExceptionsFromMasterAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindExceptionsFromMasterAsync + +## -description +Asynchronously retrieves a list of appointment instances that are exceptions from the specified master appointment. + +## -parameters +### -param masterLocalId +The [LocalId](appointment_localid.md) of the master appointment for which exceptional appointment instances are retrieved. + +## -returns +An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_139541599.md b/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_139541599.md index f5f0c6a0e5..0aea1844c5 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_139541599.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_139541599.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync(Windows.ApplicationModel.Appointments.FindAppointmentsOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync ## -description Asynchronously retrieves a list of appointments that meet the specified criteria. ## -parameters ### -param options A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. ## -returns An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. ## -remarks ## -examples ## -see-also [FindUnexpandedAppointmentsAsync](appointmentcalendar_findunexpandedappointmentsasync_419115871.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync(Windows.ApplicationModel.Appointments.FindAppointmentsOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync + +## -description +Asynchronously retrieves a list of appointments that meet the specified criteria. + +## -parameters +### -param options +A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. + +## -returns +An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[FindUnexpandedAppointmentsAsync](appointmentcalendar_findunexpandedappointmentsasync_419115871.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_419115871.md b/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_419115871.md index 2149caa6cf..8e637d91a6 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_419115871.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_findunexpandedappointmentsasync_419115871.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync ## -description Asynchronously retrieves a list of appointments that meet the specified criteria. ## -returns An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. ## -remarks ## -examples ## -see-also [FindUnexpandedAppointmentsAsync(FindAppointmentsOptions)](appointmentcalendar_findunexpandedappointmentsasync_139541599.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.FindUnexpandedAppointmentsAsync + +## -description +Asynchronously retrieves a list of appointments that meet the specified criteria. + +## -returns +An asynchronous operation that returns [IVectorView](../windows.foundation.collections/ivectorview_1.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[FindUnexpandedAppointmentsAsync(FindAppointmentsOptions)](appointmentcalendar_findunexpandedappointmentsasync_139541599.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentcalendar_getappointmentasync_126051655.md b/windows.applicationmodel.appointments/appointmentcalendar_getappointmentasync_126051655.md index d35a6d7b8c..cd115e0fdf 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_getappointmentasync_126051655.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_getappointmentasync_126051655.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentAsync ## -description Asynchronously retrieves the [Appointment](appointment.md) with the specified ID. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be retrieved. ## -returns An asynchronous operation that returns [Appointment](appointment.md) on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentAsync + +## -description +Asynchronously retrieves the [Appointment](appointment.md) with the specified ID. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be retrieved. + +## -returns +An asynchronous operation that returns [Appointment](appointment.md) on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_getappointmentinstanceasync_367104527.md b/windows.applicationmodel.appointments/appointmentcalendar_getappointmentinstanceasync_367104527.md index c905257c3e..7b266441f4 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_getappointmentinstanceasync_367104527.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_getappointmentinstanceasync_367104527.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentInstanceAsync(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentInstanceAsync ## -description Asynchronously retrieves the appointment instance of the specified master appointment that has the specified start time. ## -parameters ### -param localId The ID of the master appointment to which the retrieved appointment instance belongs. ### -param instanceStartTime The start time of the appointment instance to be retrieved. ## -returns An asynchronous operation that returns [Appointment](appointment.md) on successful completion. ## -remarks The *instanceStartTime* parameter must be the original start date of the instance. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentInstanceAsync(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.GetAppointmentInstanceAsync + +## -description +Asynchronously retrieves the appointment instance of the specified master appointment that has the specified start time. + +## -parameters +### -param localId +The ID of the master appointment to which the retrieved appointment instance belongs. + +### -param instanceStartTime +The start time of the appointment instance to be retrieved. + +## -returns +An asynchronous operation that returns [Appointment](appointment.md) on successful completion. + +## -remarks +The *instanceStartTime* parameter must be the original start date of the instance. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_ishidden.md b/windows.applicationmodel.appointments/appointmentcalendar_ishidden.md index c6cddfd408..f7f97f0ad8 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_ishidden.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_ishidden.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.IsHidden --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.IsHidden ## -description Gets whether the [AppointmentCalendar](appointmentcalendar.md) is hidden in the device's built-in calendar UI. ## -property-value A boolean value indicating whether the [AppointmentCalendar](appointmentcalendar.md) is hidden in the device's built-in calendar UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.IsHidden +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.IsHidden + +## -description +Gets whether the [AppointmentCalendar](appointmentcalendar.md) is hidden in the device's built-in calendar UI. + +## -property-value +A boolean value indicating whether the [AppointmentCalendar](appointmentcalendar.md) is hidden in the device's built-in calendar UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_localid.md b/windows.applicationmodel.appointments/appointmentcalendar_localid.md index 95c35c33a2..6866447e63 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_localid.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_localid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.LocalId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.LocalId ## -description Gets a string that uniquely identifies the appointment calendar on the local device. ## -property-value A string that uniquely identifies the appointment calendar on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.LocalId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.LocalId + +## -description +Gets a string that uniquely identifies the appointment calendar on the local device. + +## -property-value +A string that uniquely identifies the appointment calendar on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_mustnofityinvitees.md b/windows.applicationmodel.appointments/appointmentcalendar_mustnofityinvitees.md index 72cc9b561a..bd33cfd7ad 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_mustnofityinvitees.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_mustnofityinvitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.MustNofityInvitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.MustNofityInvitees ## -description Gets or sets a Boolean value that indicates if invitees must be sent notifications. ## -property-value A Boolean value that indicates if invitees must be sent notifications. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.MustNofityInvitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.MustNofityInvitees + +## -description +Gets or sets a Boolean value that indicates if invitees must be sent notifications. + +## -property-value +A Boolean value that indicates if invitees must be sent notifications. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_otherappreadaccess.md b/windows.applicationmodel.appointments/appointmentcalendar_otherappreadaccess.md index b5e4dfada8..c4e0da0d52 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_otherappreadaccess.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_otherappreadaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppReadAccess --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppReadAccess ## -description Gets or sets a boolean value indicating whether other apps on the device have read access to the appointment calendar. ## -property-value A boolean value indicating whether other apps on the device have read access to the appointment calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppReadAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppReadAccess + +## -description +Gets or sets a boolean value indicating whether other apps on the device have read access to the appointment calendar. + +## -property-value +A boolean value indicating whether other apps on the device have read access to the appointment calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_otherappwriteaccess.md b/windows.applicationmodel.appointments/appointmentcalendar_otherappwriteaccess.md index d9e046833c..ea98f7bdd6 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_otherappwriteaccess.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_otherappwriteaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppWriteAccess --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppWriteAccess ## -description Gets or sets a boolean value indicating whether other apps on the device have write access to the appointment calendar. ## -property-value A boolean value indicating whether other apps on the device have write access to the appointment calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppWriteAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.OtherAppWriteAccess + +## -description +Gets or sets a boolean value indicating whether other apps on the device have write access to the appointment calendar. + +## -property-value +A boolean value indicating whether other apps on the device have write access to the appointment calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_registersyncmanagerasync_1214558325.md b/windows.applicationmodel.appointments/appointmentcalendar_registersyncmanagerasync_1214558325.md index 1a035bbff9..7892e72207 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_registersyncmanagerasync_1214558325.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_registersyncmanagerasync_1214558325.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.RegisterSyncManagerAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.RegisterSyncManagerAsync ## -description Registers the [AppointmentCalendar](appointmentcalendar.md) as a sync provider. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.RegisterSyncManagerAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.RegisterSyncManagerAsync + +## -description +Registers the [AppointmentCalendar](appointmentcalendar.md) as a sync provider. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_remoteid.md b/windows.applicationmodel.appointments/appointmentcalendar_remoteid.md index 83edd62b45..6a84bde3b1 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_remoteid.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.RemoteId ## -description Gets the remote ID for the [AppointmentCalendar](appointmentcalendar.md). ## -property-value The remote ID for the [AppointmentCalendar](appointmentcalendar.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.RemoteId + +## -description +Gets the remote ID for the [AppointmentCalendar](appointmentcalendar.md). + +## -property-value +The remote ID for the [AppointmentCalendar](appointmentcalendar.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_saveappointmentasync_2133776957.md b/windows.applicationmodel.appointments/appointmentcalendar_saveappointmentasync_2133776957.md index 9d2ff0a8b3..9c3a6a940b 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_saveappointmentasync_2133776957.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_saveappointmentasync_2133776957.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAppointmentAsync ## -description Asynchronously saves the provided appointment to the calendar. ## -parameters ### -param pAppointment The appointment to be saved. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAppointmentAsync + +## -description +Asynchronously saves the provided appointment to the calendar. + +## -parameters +### -param pAppointment +The appointment to be saved. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_saveasync_2143735121.md b/windows.applicationmodel.appointments/appointmentcalendar_saveasync_2143735121.md index 8653ee5266..4f58268ffb 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_saveasync_2143735121.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_saveasync_2143735121.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAsync ## -description Asynchronously saves changes to the appointment calendar. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.SaveAsync + +## -description +Asynchronously saves changes to the appointment calendar. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_sourcedisplayname.md b/windows.applicationmodel.appointments/appointmentcalendar_sourcedisplayname.md index 6ca51c5210..2e0c9dbd53 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_sourcedisplayname.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_sourcedisplayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.SourceDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.SourceDisplayName ## -description Gets a string that describes the provider for the appointment calendar. ## -property-value A string that describes the provider for the appointment calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.SourceDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.SourceDisplayName + +## -description +Gets a string that describes the provider for the appointment calendar. + +## -property-value +A string that describes the provider for the appointment calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_summarycardview.md b/windows.applicationmodel.appointments/appointmentcalendar_summarycardview.md index 523ad104cf..9887f0db1f 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_summarycardview.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_summarycardview.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.SummaryCardView --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.SummaryCardView ## -description Gets or sets how the summary card for the calendar's appointments are displayed. ## -property-value An [AppointmentSummaryCardView](appointmentsummarycardview.md) value indicating how the summary card for the calendar's appointments are displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.SummaryCardView +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.SummaryCardView + +## -description +Gets or sets how the summary card for the calendar's appointments are displayed. + +## -property-value +An [AppointmentSummaryCardView](appointmentsummarycardview.md) value indicating how the summary card for the calendar's appointments are displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_syncmanager.md b/windows.applicationmodel.appointments/appointmentcalendar_syncmanager.md index 8c39acb602..7e007215fb 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_syncmanager.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_syncmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.SyncManager --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.SyncManager ## -description Gets the [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md) which can be used to sync with the remote server. ## -property-value The [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md) which can be used to sync with the remote server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.SyncManager +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.SyncManager + +## -description +Gets the [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md) which can be used to sync with the remote server. + +## -property-value +The [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md) which can be used to sync with the remote server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_trycancelmeetingasync_186402442.md b/windows.applicationmodel.appointments/appointmentcalendar_trycancelmeetingasync_186402442.md index b31e95fcd6..5c1812dce7 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_trycancelmeetingasync_186402442.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_trycancelmeetingasync_186402442.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCancelMeetingAsync(Windows.ApplicationModel.Appointments.Appointment,System.String,System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCancelMeetingAsync ## -description Asynchronously attempts to cancel a meeting. ## -parameters ### -param meeting The meeting to cancel. ### -param subject The subject for the cancellation notification. ### -param comment The body of the cancellation notification. ### -param notifyInvitees A Boolean value indicating if invitees should be notified. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCancelMeetingAsync(Windows.ApplicationModel.Appointments.Appointment,System.String,System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCancelMeetingAsync + +## -description +Asynchronously attempts to cancel a meeting. + +## -parameters +### -param meeting +The meeting to cancel. + +### -param subject +The subject for the cancellation notification. + +### -param comment +The body of the cancellation notification. + +### -param notifyInvitees +A Boolean value indicating if invitees should be notified. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_trycreateorupdateappointmentasync_1106281775.md b/windows.applicationmodel.appointments/appointmentcalendar_trycreateorupdateappointmentasync_1106281775.md index 209d87c833..7c731f08b9 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_trycreateorupdateappointmentasync_1106281775.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_trycreateorupdateappointmentasync_1106281775.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCreateOrUpdateAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCreateOrUpdateAppointmentAsync ## -description Asynchronously attempts to create or update a meeting. ## -parameters ### -param appointment The meeting to create or update. ### -param notifyInvitees A Boolean value indicating if invitees should be notified. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCreateOrUpdateAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.TryCreateOrUpdateAppointmentAsync + +## -description +Asynchronously attempts to create or update a meeting. + +## -parameters +### -param appointment +The meeting to create or update. + +### -param notifyInvitees +A Boolean value indicating if invitees should be notified. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_tryforwardmeetingasync_834107969.md b/windows.applicationmodel.appointments/appointmentcalendar_tryforwardmeetingasync_834107969.md index ae2a62525d..d1f2818149 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_tryforwardmeetingasync_834107969.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_tryforwardmeetingasync_834107969.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryForwardMeetingAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Appointments.AppointmentInvitee},System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.TryForwardMeetingAsync ## -description Asynchronously attempts to forward a meeting. ## -parameters ### -param meeting The meeting to forward. ### -param invitees A list of new invitees to receive the forwarded meeting. ### -param subject The subject of the meeting invitation. ### -param forwardHeader A new meeting header that includes the new invitees. ### -param comment The body of the forwarded meeting invitation. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryForwardMeetingAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Appointments.AppointmentInvitee},System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.TryForwardMeetingAsync + +## -description +Asynchronously attempts to forward a meeting. + +## -parameters +### -param meeting +The meeting to forward. + +### -param invitees +A list of new invitees to receive the forwarded meeting. + +### -param subject +The subject of the meeting invitation. + +### -param forwardHeader +A new meeting header that includes the new invitees. + +### -param comment +The body of the forwarded meeting invitation. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_tryproposenewtimeformeetingasync_877908500.md b/windows.applicationmodel.appointments/appointmentcalendar_tryproposenewtimeformeetingasync_877908500.md index 9fc3a51834..0da2e3e15b 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_tryproposenewtimeformeetingasync_877908500.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_tryproposenewtimeformeetingasync_877908500.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryProposeNewTimeForMeetingAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.TryProposeNewTimeForMeetingAsync ## -description Asynchronously attempts to propose a new meeting time. ## -parameters ### -param meeting The meeting to update. ### -param newStartTime The proposed new start time. ### -param newDuration A new duration for the meeting. ### -param subject The subject of the meeting invitation. ### -param comment The body of the meeting invitation. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryProposeNewTimeForMeetingAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.TryProposeNewTimeForMeetingAsync + +## -description +Asynchronously attempts to propose a new meeting time. + +## -parameters +### -param meeting +The meeting to update. + +### -param newStartTime +The proposed new start time. + +### -param newDuration +A new duration for the meeting. + +### -param subject +The subject of the meeting invitation. + +### -param comment +The body of the meeting invitation. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_tryupdatemeetingresponseasync_1551045509.md b/windows.applicationmodel.appointments/appointmentcalendar_tryupdatemeetingresponseasync_1551045509.md index f8330550cd..17c2bdee4b 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_tryupdatemeetingresponseasync_1551045509.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_tryupdatemeetingresponseasync_1551045509.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryUpdateMeetingResponseAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.ApplicationModel.Appointments.AppointmentParticipantResponse,System.String,System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.TryUpdateMeetingResponseAsync ## -description Asynchronously attempts to update the response to a meeting invitation. ## -parameters ### -param meeting The meeting to update. ### -param response The response to the meeting invitation, such as accept, tentative or decline. ### -param subject The subject of the response. ### -param comment The body of the response. ### -param sendUpdate A Boolean value indicating whether or not to send the response to the meeting organizer. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendar.TryUpdateMeetingResponseAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.ApplicationModel.Appointments.AppointmentParticipantResponse,System.String,System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.TryUpdateMeetingResponseAsync + +## -description +Asynchronously attempts to update the response to a meeting invitation. + +## -parameters +### -param meeting +The meeting to update. + +### -param response +The response to the meeting invitation, such as accept, tentative or decline. + +### -param subject +The subject of the response. + +### -param comment +The body of the response. + +### -param sendUpdate +A Boolean value indicating whether or not to send the response to the meeting organizer. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendar_userdataaccountid.md b/windows.applicationmodel.appointments/appointmentcalendar_userdataaccountid.md index 1b529d2088..3ade944e0e 100644 --- a/windows.applicationmodel.appointments/appointmentcalendar_userdataaccountid.md +++ b/windows.applicationmodel.appointments/appointmentcalendar_userdataaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.UserDataAccountId --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendar.UserDataAccountId ## -description Get the identifier of the user account data for the [AppointmentCalendar](appointmentcalendar.md). ## -property-value The identifier of the user account data for the [AppointmentCalendar](appointmentcalendar.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendar.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendar.UserDataAccountId + +## -description +Get the identifier of the user account data for the [AppointmentCalendar](appointmentcalendar.md). + +## -property-value +The identifier of the user account data for the [AppointmentCalendar](appointmentcalendar.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager.md b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager.md index 59278741a8..6798d4caa0 100644 --- a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager.md +++ b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager ## -description Provides access to sync functionality for an [AppointmentCalendar](appointmentcalendar.md) object. ## -remarks [AppointmentCalendar.SyncManager](appointmentcalendar_syncmanager.md) provides access to an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager + +## -description +Provides access to sync functionality for an [AppointmentCalendar](appointmentcalendar.md) object. + +## -remarks +[AppointmentCalendar.SyncManager](appointmentcalendar_syncmanager.md) provides access to an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastattemptedsynctime.md b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastattemptedsynctime.md index f68f9c98b7..80a413f06a 100644 --- a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastattemptedsynctime.md +++ b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastattemptedsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastAttemptedSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastAttemptedSyncTime ## -description Gets or sets the last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was attempted. ## -property-value The last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was attempted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastAttemptedSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastAttemptedSyncTime + +## -description +Gets or sets the last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was attempted. + +## -property-value +The last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was attempted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastsuccessfulsynctime.md b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastsuccessfulsynctime.md index bb8b27b04d..6bcec060e2 100644 --- a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastsuccessfulsynctime.md +++ b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_lastsuccessfulsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastSuccessfulSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastSuccessfulSyncTime ## -description Gets or sets the last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was successful. ## -property-value The last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastSuccessfulSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.LastSuccessfulSyncTime + +## -description +Gets or sets the last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was successful. + +## -property-value +The last date and time that a sync with the [AppointmentCalendar](appointmentcalendar.md) server was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_status.md b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_status.md index e00c28178a..02757f14ea 100644 --- a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_status.md +++ b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.Status --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.Status ## -description Gets or sets the current status of the [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md). ## -property-value The current status of the [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.Status + +## -description +Gets or sets the current status of the [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md). + +## -property-value +The current status of the [AppointmentCalendarSyncManager](appointmentcalendarsyncmanager.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncasync_2144191352.md b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncasync_2144191352.md index 60722a5b77..9f29c23783 100644 --- a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncasync_2144191352.md +++ b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncasync_2144191352.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncAsync ## -description Initiates a sync operation on the [AppointmentCalendar](appointmentcalendar.md). ## -returns A Boolean value indicating if the sync was successfully initiated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncAsync + +## -description +Initiates a sync operation on the [AppointmentCalendar](appointmentcalendar.md). + +## -returns +A Boolean value indicating if the sync was successfully initiated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncstatuschanged.md b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncstatuschanged.md index 7f19633e37..6d499e49fa 100644 --- a/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncstatuschanged.md +++ b/windows.applicationmodel.appointments/appointmentcalendarsyncmanager_syncstatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncStatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncStatusChanged ## -description Occurs when the status of an [AppointmentCalendar](appointmentcalendar.md) sync operation changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentCalendarSyncManager.SyncStatusChanged + +## -description +Occurs when the status of an [AppointmentCalendar](appointmentcalendar.md) sync operation changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentconflictresult.md b/windows.applicationmodel.appointments/appointmentconflictresult.md index 7df27836df..52306e81f5 100644 --- a/windows.applicationmodel.appointments/appointmentconflictresult.md +++ b/windows.applicationmodel.appointments/appointmentconflictresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentConflictResult --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentConflictResult ## -description Represents a conflict between appointments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentConflictResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentConflictResult + +## -description +Represents a conflict between appointments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentconflictresult_date.md b/windows.applicationmodel.appointments/appointmentconflictresult_date.md index 3049f6200a..e6684e0a83 100644 --- a/windows.applicationmodel.appointments/appointmentconflictresult_date.md +++ b/windows.applicationmodel.appointments/appointmentconflictresult_date.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentConflictResult.Date --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentConflictResult.Date ## -description Gets the date of the appointment conflict. ## -property-value The date of the appointment conflict. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentConflictResult.Date +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentConflictResult.Date + +## -description +Gets the date of the appointment conflict. + +## -property-value +The date of the appointment conflict. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentconflictresult_type.md b/windows.applicationmodel.appointments/appointmentconflictresult_type.md index fd90c9e9ff..6473bbe033 100644 --- a/windows.applicationmodel.appointments/appointmentconflictresult_type.md +++ b/windows.applicationmodel.appointments/appointmentconflictresult_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentConflictResult.Type --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentConflictResult.Type ## -description Gets a value indicating the type of appointment conflict. ## -property-value A value indicating the type of appointment conflict. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentConflictResult.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentConflictResult.Type + +## -description +Gets a value indicating the type of appointment conflict. + +## -property-value +A value indicating the type of appointment conflict. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentexception.md b/windows.applicationmodel.appointments/appointmentexception.md index 3c372ae5d5..5fb35e1588 100644 --- a/windows.applicationmodel.appointments/appointmentexception.md +++ b/windows.applicationmodel.appointments/appointmentexception.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentException --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentException ## -description Represents an appointment instance that is an exception from the master appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentException +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentException + +## -description +Represents an appointment instance that is an exception from the master appointment. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentexception_appointment.md b/windows.applicationmodel.appointments/appointmentexception_appointment.md index 4dc99bef7d..97b08ad76b 100644 --- a/windows.applicationmodel.appointments/appointmentexception_appointment.md +++ b/windows.applicationmodel.appointments/appointmentexception_appointment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentException.Appointment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentException.Appointment ## -description Gets the appointment that is an exception from the master appointment. ## -property-value The appointment that is an exception from the master appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentException.Appointment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentException.Appointment + +## -description +Gets the appointment that is an exception from the master appointment. + +## -property-value +The appointment that is an exception from the master appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentexception_exceptionproperties.md b/windows.applicationmodel.appointments/appointmentexception_exceptionproperties.md index bc76caef9c..b27adf717b 100644 --- a/windows.applicationmodel.appointments/appointmentexception_exceptionproperties.md +++ b/windows.applicationmodel.appointments/appointmentexception_exceptionproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentException.ExceptionProperties --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentException.ExceptionProperties ## -description Gets a list of the names of the appointment properties for which an exception was found. ## -property-value A list of the names of the appointment properties for which an exception was found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentException.ExceptionProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentException.ExceptionProperties + +## -description +Gets a list of the names of the appointment properties for which an exception was found. + +## -property-value +A list of the names of the appointment properties for which an exception was found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentexception_isdeleted.md b/windows.applicationmodel.appointments/appointmentexception_isdeleted.md index 921ae37fe5..92c827b00c 100644 --- a/windows.applicationmodel.appointments/appointmentexception_isdeleted.md +++ b/windows.applicationmodel.appointments/appointmentexception_isdeleted.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentException.IsDeleted --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentException.IsDeleted ## -description Gets a value indicating whether the exception is that the appointment instance has been deleted. ## -property-value A value indicating whether the exception is that the appointment instance has been deleted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentException.IsDeleted +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentException.IsDeleted + +## -description +Gets a value indicating whether the exception is that the appointment instance has been deleted. + +## -property-value +A value indicating whether the exception is that the appointment instance has been deleted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentinvitee.md b/windows.applicationmodel.appointments/appointmentinvitee.md index e4f5d25a48..3ca99574cc 100644 --- a/windows.applicationmodel.appointments/appointmentinvitee.md +++ b/windows.applicationmodel.appointments/appointmentinvitee.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentInvitee --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentInvitee ## -description Represents a participant of an appointment in a calendar. ## -remarks ## -examples ## -see-also [IAppointmentParticipant](iappointmentparticipant.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentInvitee +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentInvitee + +## -description +Represents a participant of an appointment in a calendar. + +## -remarks + +## -examples + +## -see-also +[IAppointmentParticipant](iappointmentparticipant.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentinvitee_address.md b/windows.applicationmodel.appointments/appointmentinvitee_address.md index 338e6a8a92..b3069f2ece 100644 --- a/windows.applicationmodel.appointments/appointmentinvitee_address.md +++ b/windows.applicationmodel.appointments/appointmentinvitee_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.Address --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentInvitee.Address ## -description Gets or sets a string that communicates the address of a participant of an appointment. The address is inherited from [IAppointmentParticipant](iappointmentparticipant.md) and is a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type [String](https://msdn.microsoft.com/library/system.string.aspx) and between 1 and 321 characters in length (non-empty). ## -property-value The address of a participant of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentInvitee.Address + +## -description +Gets or sets a string that communicates the address of a participant of an appointment. The address is inherited from [IAppointmentParticipant](iappointmentparticipant.md) and is a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type [String](https://msdn.microsoft.com/library/system.string.aspx) and between 1 and 321 characters in length (non-empty). + +## -property-value +The address of a participant of an appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentinvitee_appointmentinvitee_1221375020.md b/windows.applicationmodel.appointments/appointmentinvitee_appointmentinvitee_1221375020.md index ffeb8ca0bf..1feec0662e 100644 --- a/windows.applicationmodel.appointments/appointmentinvitee_appointmentinvitee_1221375020.md +++ b/windows.applicationmodel.appointments/appointmentinvitee_appointmentinvitee_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentInvitee.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentInvitee.AppointmentInvitee ## -description Initializes a new instance of the [AppointmentInvitee](appointmentinvitee.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentInvitee.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentInvitee.AppointmentInvitee + +## -description +Initializes a new instance of the [AppointmentInvitee](appointmentinvitee.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentinvitee_displayname.md b/windows.applicationmodel.appointments/appointmentinvitee_displayname.md index 21497162ab..838bbcb8ab 100644 --- a/windows.applicationmodel.appointments/appointmentinvitee_displayname.md +++ b/windows.applicationmodel.appointments/appointmentinvitee_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentInvitee.DisplayName ## -description Gets or sets a string that communicates the display name of a participant of an appointment. The display name is inherited from [IAppointmentParticipant](iappointmentparticipant.md), of type [String](https://msdn.microsoft.com/library/system.string.aspx), and a maximum of 256 characters in length. ## -property-value The display name of a participant of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentInvitee.DisplayName + +## -description +Gets or sets a string that communicates the display name of a participant of an appointment. The display name is inherited from [IAppointmentParticipant](iappointmentparticipant.md), of type [String](https://msdn.microsoft.com/library/system.string.aspx), and a maximum of 256 characters in length. + +## -property-value +The display name of a participant of an appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentinvitee_response.md b/windows.applicationmodel.appointments/appointmentinvitee_response.md index 52b249f5c2..472710b183 100644 --- a/windows.applicationmodel.appointments/appointmentinvitee_response.md +++ b/windows.applicationmodel.appointments/appointmentinvitee_response.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.Response --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentInvitee.Response ## -description Gets or sets a [AppointmentParticipantResponse](appointmentparticipantresponse.md)-typed value that indicates the response from a participant concerning an appointment invitation. ## -property-value A [AppointmentParticipantResponse](appointmentparticipantresponse.md)-typed value that indicates the response from a participant concerning an appointment invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.Response +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentInvitee.Response + +## -description +Gets or sets a [AppointmentParticipantResponse](appointmentparticipantresponse.md)-typed value that indicates the response from a participant concerning an appointment invitation. + +## -property-value +A [AppointmentParticipantResponse](appointmentparticipantresponse.md)-typed value that indicates the response from a participant concerning an appointment invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentinvitee_role.md b/windows.applicationmodel.appointments/appointmentinvitee_role.md index 4756017f99..fef1c5fbfa 100644 --- a/windows.applicationmodel.appointments/appointmentinvitee_role.md +++ b/windows.applicationmodel.appointments/appointmentinvitee_role.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.Role --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentInvitee.Role ## -description Gets or sets a [AppointmentParticipantRole](appointmentparticipantrole.md)-typed value that indicates the role of a participant concerning an appointment invitation. ## -property-value A [AppointmentParticipantRole](appointmentparticipantrole.md)-typed value that indicates the role of a participant concerning an appointment invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentInvitee.Role +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentInvitee.Role + +## -description +Gets or sets a [AppointmentParticipantRole](appointmentparticipantrole.md)-typed value that indicates the role of a participant concerning an appointment invitation. + +## -property-value +A [AppointmentParticipantRole](appointmentparticipantrole.md)-typed value that indicates the role of a participant concerning an appointment invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanager.md b/windows.applicationmodel.appointments/appointmentmanager.md index 32d4151807..4aca1589b7 100644 --- a/windows.applicationmodel.appointments/appointmentmanager.md +++ b/windows.applicationmodel.appointments/appointmentmanager.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentManager --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentManager ## -description Provides API to interact with the user’s Appointments provider app (for example, the Calendar app). Call static methods to display provider-specific UI so that the user can perform tasks. ## -remarks For info about how to manage appointments, see [Managing appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538) and [Quickstart: Managing appointments ](http://msdn.microsoft.com/library/4d7c555e-a707-428e-8ce3-1bd278028fc1). ## -examples ## -see-also [Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager + +## -description +Provides API to interact with the user’s Appointments provider app (for example, the Calendar app). Call static methods to display provider-specific UI so that the user can perform tasks. + +## -remarks +For info about how to manage appointments, see [Managing appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538) and [Quickstart: Managing appointments ](http://msdn.microsoft.com/library/4d7c555e-a707-428e-8ce3-1bd278028fc1). + +## -examples + +## -see-also +[Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_getforuser_2058550280.md b/windows.applicationmodel.appointments/appointmentmanager_getforuser_2058550280.md index ada0887eea..1e435bd3c0 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_getforuser_2058550280.md +++ b/windows.applicationmodel.appointments/appointmentmanager_getforuser_2058550280.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.GetForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.GetForUser ## -description Gets the [AppointmentManagerForUser](appointmentmanagerforuser.md) object for the specified user. ## -parameters ### -param user The user account to use to get the [AppointmentManagerForUser](appointmentmanagerforuser.md) object. ## -returns Returns the appointment manager for the account specified by the *user* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.GetForUser + +## -description +Gets the [AppointmentManagerForUser](appointmentmanagerforuser.md) object for the specified user. + +## -parameters +### -param user +The user account to use to get the [AppointmentManagerForUser](appointmentmanagerforuser.md) object. + +## -returns +Returns the appointment manager for the account specified by the *user* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanager_requeststoreasync_1071227961.md b/windows.applicationmodel.appointments/appointmentmanager_requeststoreasync_1071227961.md index 1c7edb1d77..5712c21546 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_requeststoreasync_1071227961.md +++ b/windows.applicationmodel.appointments/appointmentmanager_requeststoreasync_1071227961.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.RequestStoreAsync(Windows.ApplicationModel.Appointments.AppointmentStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.RequestStoreAsync ## -description Requests the [AppointmentStore](appointmentstore.md) object associated with the calling application. ## -parameters ### -param options An [AppointmentStoreAccessType](appointmentstoreaccesstype.md) value indicating the level of access the returned appointment store will have. ## -returns An asynchronous operation that returns an [AppointmentStore](appointmentstore.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.RequestStoreAsync(Windows.ApplicationModel.Appointments.AppointmentStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.RequestStoreAsync + +## -description +Requests the [AppointmentStore](appointmentstore.md) object associated with the calling application. + +## -parameters +### -param options +An [AppointmentStoreAccessType](appointmentstoreaccesstype.md) value indicating the level of access the returned appointment store will have. + +## -returns +An asynchronous operation that returns an [AppointmentStore](appointmentstore.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_253292089.md b/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_253292089.md index 2ba5ab4504..8fb8c91353 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_253292089.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_253292089.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. ## -parameters ### -param appointment The object representing the information for the appointment to add. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Add Appointment UI. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. ## -remarks See the remarks in the following overload: [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync_92599717.md). ## -examples ## -see-also [ShowAddAppointmentAsync(Appointment, Rect)](appointmentmanager_showaddappointmentasync_92599717.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. + +## -parameters +### -param appointment +The object representing the information for the appointment to add. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Add Appointment UI. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. + +## -remarks +See the remarks in the following overload: [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync_92599717.md). + +## -examples + +## -see-also +[ShowAddAppointmentAsync(Appointment, Rect)](appointmentmanager_showaddappointmentasync_92599717.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_92599717.md b/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_92599717.md index e4787288fe..5a328fb213 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_92599717.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showaddappointmentasync_92599717.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. ## -parameters ### -param appointment The object representing the information for the appointment to add. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. > On Windows Phone, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanager_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). ## -examples ## -see-also [ShowAddAppointmentAsync(Appointment, Rect, Placement)](appointmentmanager_showaddappointmentasync_253292089.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowAddAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. + +## -parameters +### -param appointment +The object representing the information for the appointment to add. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +> On Windows Phone, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanager_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. + +For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). + +## -examples + +## -see-also +[ShowAddAppointmentAsync(Appointment, Rect, Placement)](appointmentmanager_showaddappointmentasync_253292089.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_1792084630.md b/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_1792084630.md index efecee8d12..7823ba8ad9 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_1792084630.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_1792084630.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync ## -description Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. ## -parameters ### -param appointmentId The [LocalId](appointment_localid.md) of the appointment to be displayed. ## -returns When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. ## -remarks ## -examples ## -see-also [ShowAppointmentDetailsAsync(String, DateTime)](appointmentmanager_showappointmentdetailsasync_190736264.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync + +## -description +Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. + +## -parameters +### -param appointmentId +The [LocalId](appointment_localid.md) of the appointment to be displayed. + +## -returns +When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. + +## -remarks + +## -examples + +## -see-also +[ShowAppointmentDetailsAsync(String, DateTime)](appointmentmanager_showappointmentdetailsasync_190736264.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_190736264.md b/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_190736264.md index 8ffc8d1f34..23664f9911 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_190736264.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showappointmentdetailsasync_190736264.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync ## -description Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. ## -parameters ### -param appointmentId The [LocalId](appointment_localid.md) of the appointment to be displayed. ### -param instanceStartDate A [DateTime](../windows.foundation/datetime.md) object with the start time of the appointment instance to be displayed. ## -returns When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. ## -remarks ## -examples ## -see-also [ShowAppointmentDetailsAsync(String)](appointmentmanager_showappointmentdetailsasync_1792084630.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowAppointmentDetailsAsync + +## -description +Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. + +## -parameters +### -param appointmentId +The [LocalId](appointment_localid.md) of the appointment to be displayed. + +### -param instanceStartDate +A [DateTime](../windows.foundation/datetime.md) object with the start time of the appointment instance to be displayed. + +## -returns +When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. + +## -remarks + +## -examples + +## -see-also +[ShowAppointmentDetailsAsync(String)](appointmentmanager_showappointmentdetailsasync_1792084630.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showeditnewappointmentasync_372535555.md b/windows.applicationmodel.appointments/appointmentmanager_showeditnewappointmentasync_372535555.md index 2c688bf394..341370c123 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showeditnewappointmentasync_372535555.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showeditnewappointmentasync_372535555.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowEditNewAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowEditNewAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment. ## -parameters ### -param appointment The appointment to be added. ## -returns An asynchronous operation that returns a string containing an appointment ID upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowEditNewAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowEditNewAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment. + +## -parameters +### -param appointment +The appointment to be added. + +## -returns +An asynchronous operation that returns a string containing an appointment ID upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1734575458.md b/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1734575458.md index f65de41f57..10a66ffeb3 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1734575458.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1734575458.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param appointmentId The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) call. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. This method may return false, even when the appointment was successfully removed. For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanager_showremoveappointmentasync_1845468926.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanager_showremoveappointmentasync_339596666.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param appointmentId +The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) call. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +This method may return false, even when the appointment was successfully removed. + +For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). + + + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanager_showremoveappointmentasync_1845468926.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanager_showremoveappointmentasync_339596666.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1845468926.md b/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1845468926.md index 89982fc6dd..5b7ce4ea4f 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1845468926.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_1845468926.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param appointmentId The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) call. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks See the remarks section of this overload: [ShowRemoveAppointmentAsync](appointmentmanager_showremoveappointmentasync_1734575458.md). ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect)](appointmentmanager_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanager_showremoveappointmentasync_339596666.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param appointmentId +The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) call. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks +See the remarks section of this overload: [ShowRemoveAppointmentAsync](appointmentmanager_showremoveappointmentasync_1734575458.md). + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect)](appointmentmanager_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanager_showremoveappointmentasync_339596666.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_339596666.md b/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_339596666.md index 30661e4440..e24a3524d5 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_339596666.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showremoveappointmentasync_339596666.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param appointmentId The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) call. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. ### -param instanceStartDate The start date and time of the appointment instance to remove. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks See the remarks section of this overload: [ShowRemoveAppointmentAsync](appointmentmanager_showremoveappointmentasync_1734575458.md). ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect)](appointmentmanager_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanager_showremoveappointmentasync_1845468926.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param appointmentId +The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) call. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. + +### -param instanceStartDate +The start date and time of the appointment instance to remove. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks +See the remarks section of this overload: [ShowRemoveAppointmentAsync](appointmentmanager_showremoveappointmentasync_1734575458.md). + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect)](appointmentmanager_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanager_showremoveappointmentasync_1845468926.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1336777815.md b/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1336777815.md index 50fa91c066..ea1ac4c44d 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1336777815.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1336777815.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param appointmentId The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanager_showreplaceappointmentasync.md) call. ### -param appointment The object representing the information for the appointment to replace the current appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanager_showreplaceappointmentasync_1519758191.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanager_showreplaceappointmentasync_1458488223.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param appointmentId +The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanager_showreplaceappointmentasync.md) call. + +### -param appointment +The object representing the information for the appointment to replace the current appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanager_showreplaceappointmentasync_1519758191.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanager_showreplaceappointmentasync_1458488223.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1458488223.md b/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1458488223.md index 2eb88edc2c..c43a210c7d 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1458488223.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1458488223.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param appointmentId The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanager_showreplaceappointmentasync.md) call. ### -param appointment The object representing the information for the appointment to replace the current appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. ### -param instanceStartDate The start date and time of the appointment instance to replace. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanager_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanager_showreplaceappointmentasync_1519758191.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param appointmentId +The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanager_showreplaceappointmentasync.md) call. + +### -param appointment +The object representing the information for the appointment to replace the current appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. + +### -param instanceStartDate +The start date and time of the appointment instance to replace. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanager_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanager_showreplaceappointmentasync_1519758191.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1519758191.md b/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1519758191.md index 071316e394..40bd307091 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1519758191.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showreplaceappointmentasync_1519758191.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param appointmentId The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanager_showreplaceappointmentasync.md) call. ### -param appointment The object representing the information for the appointment to replace the current appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanager_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanager_showreplaceappointmentasync_1458488223.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param appointmentId +The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanager_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanager_showreplaceappointmentasync.md) call. + +### -param appointment +The object representing the information for the appointment to replace the current appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanager_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanager_showreplaceappointmentasync_1458488223.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanager_showtimeframeasync_1558661698.md b/windows.applicationmodel.appointments/appointmentmanager_showtimeframeasync_1558661698.md index 831de41f2b..1df1bbcb3e 100644 --- a/windows.applicationmodel.appointments/appointmentmanager_showtimeframeasync_1558661698.md +++ b/windows.applicationmodel.appointments/appointmentmanager_showtimeframeasync_1558661698.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowTimeFrameAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManager.ShowTimeFrameAsync ## -description Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar. ## -parameters ### -param timeToShow A date and time object that specifies the beginning of the time frame that the Appointments provider app should display. ### -param duration A timespan that hints to the Appointments provider app how long the time frame shown should be. ## -returns When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. ## -remarks This method uses parameter values representing date-time and timespan that are represented differently depending on which language you are programming with. + In JavaScript, set the *timeToShow* value with a **Date** object. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. + In Visual C++ component extensions (C++/CX), set the *timeToShow* value with a [DateTime](../windows.foundation/datetime.md) structure. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. + In C#, use a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) value for *timeToShow*, and a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) value for *duration*. You can use utility API of these structures to declare the values. For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). ## -examples ## -see-also [Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836), [Appointment](appointment.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManager.ShowTimeFrameAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManager.ShowTimeFrameAsync + +## -description +Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar. + +## -parameters +### -param timeToShow +A date and time object that specifies the beginning of the time frame that the Appointments provider app should display. + +### -param duration +A timespan that hints to the Appointments provider app how long the time frame shown should be. + +## -returns +When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. + +## -remarks +This method uses parameter values representing date-time and timespan that are represented differently depending on which language you are programming with. ++ In JavaScript, set the *timeToShow* value with a **Date** object. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. ++ In Visual C++ component extensions (C++/CX), set the *timeToShow* value with a [DateTime](../windows.foundation/datetime.md) structure. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. ++ In C#, use a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) value for *timeToShow*, and a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) value for *duration*. You can use utility API of these structures to declare the values. + + +For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). + +## -examples + +## -see-also +[Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836), [Appointment](appointment.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser.md b/windows.applicationmodel.appointments/appointmentmanagerforuser.md index 5f1ab67363..5cb461cd4a 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentManagerForUser --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser ## -description Represents an appointment manager for a specific user. ## -remarks Call the [AppointmentManager.GetForUser](appointmentmanager_getforuser.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentManagerForUser +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser + +## -description +Represents an appointment manager for a specific user. + +## -remarks +Call the [AppointmentManager.GetForUser](appointmentmanager_getforuser.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_requeststoreasync_1071227961.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_requeststoreasync_1071227961.md index 499a203a6d..74dbef68b6 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_requeststoreasync_1071227961.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_requeststoreasync_1071227961.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Appointments.AppointmentStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.RequestStoreAsync ## -description Retrieves an [AppointmentStore](appointmentstore.md) object that enables searching or retrieving appointments on the device. ## -parameters ### -param options Specifies the type of read/write access requested. ## -returns An asynchronous operation that returns an [AppointmentStore](appointmentstore.md) object upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Appointments.AppointmentStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.RequestStoreAsync + +## -description +Retrieves an [AppointmentStore](appointmentstore.md) object that enables searching or retrieving appointments on the device. + +## -parameters +### -param options +Specifies the type of read/write access requested. + +## -returns +An asynchronous operation that returns an [AppointmentStore](appointmentstore.md) object upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_253292089.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_253292089.md index b0ebc5eb86..307f624adf 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_253292089.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_253292089.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. ## -parameters ### -param appointment The object representing the information for the appointment to add. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Add Appointment UI. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. > On Windows Phone, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanagerforuser_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. ## -examples ## -see-also [ShowAddAppointmentAsync(Appointment, Rect)](appointmentmanagerforuser_showaddappointmentasync_92599717.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. + +## -parameters +### -param appointment +The object representing the information for the appointment to add. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Add Appointment UI. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +> On Windows Phone, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanagerforuser_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. + +## -examples + +## -see-also +[ShowAddAppointmentAsync(Appointment, Rect)](appointmentmanagerforuser_showaddappointmentasync_92599717.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_92599717.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_92599717.md index cc205d9db0..9b5f9d0b72 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_92599717.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showaddappointmentasync_92599717.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. ## -parameters ### -param appointment The object representing the information for the appointment to add. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. > On Windows Phone, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanagerforuser_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. ## -examples ## -see-also [ShowAddAppointmentAsync(Appointment, Rect, Placement)](appointmentmanagerforuser_showaddappointmentasync_253292089.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAddAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. + +## -parameters +### -param appointment +The object representing the information for the appointment to add. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +> On Windows Phone, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanagerforuser_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. + +## -examples + +## -see-also +[ShowAddAppointmentAsync(Appointment, Rect, Placement)](appointmentmanagerforuser_showaddappointmentasync_253292089.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_1792084630.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_1792084630.md index 6ddb529a01..61dfb5ccee 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_1792084630.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_1792084630.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync ## -description Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. ## -parameters ### -param appointmentId The [LocalId](appointment_localid.md) of the appointment to be displayed. ## -returns When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. ## -remarks ## -examples ## -see-also [ShowAppointmentDetailsAsync(String, DateTime)](appointmentmanagerforuser_showappointmentdetailsasync_190736264.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync + +## -description +Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. + +## -parameters +### -param appointmentId +The [LocalId](appointment_localid.md) of the appointment to be displayed. + +## -returns +When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. + +## -remarks + +## -examples + +## -see-also +[ShowAppointmentDetailsAsync(String, DateTime)](appointmentmanagerforuser_showappointmentdetailsasync_190736264.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_190736264.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_190736264.md index da3178f93d..2ffa93d71c 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_190736264.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showappointmentdetailsasync_190736264.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync ## -description Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. ## -parameters ### -param appointmentId The [LocalId](appointment_localid.md) of the appointment to be displayed. ### -param instanceStartDate A [DateTime](../windows.foundation/datetime.md) object with the start time of the appointment instance to be displayed. ## -returns When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. ## -remarks ## -examples ## -see-also [ShowAppointmentDetailsAsync(String)](appointmentmanagerforuser_showappointmentdetailsasync_1792084630.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowAppointmentDetailsAsync + +## -description +Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. + +## -parameters +### -param appointmentId +The [LocalId](appointment_localid.md) of the appointment to be displayed. + +### -param instanceStartDate +A [DateTime](../windows.foundation/datetime.md) object with the start time of the appointment instance to be displayed. + +## -returns +When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. + +## -remarks + +## -examples + +## -see-also +[ShowAppointmentDetailsAsync(String)](appointmentmanagerforuser_showappointmentdetailsasync_1792084630.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showeditnewappointmentasync_372535555.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showeditnewappointmentasync_372535555.md index 64892ec9a0..6b7c5f781a 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showeditnewappointmentasync_372535555.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showeditnewappointmentasync_372535555.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowEditNewAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowEditNewAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment. ## -parameters ### -param appointment The new appointment to be added. ## -returns An asynchronous operation that returns a string containing an appointment ID upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowEditNewAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowEditNewAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment. + +## -parameters +### -param appointment +The new appointment to be added. + +## -returns +An asynchronous operation that returns a string containing an appointment ID upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1734575458.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1734575458.md index a0246a0938..7dc2b0dc3a 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1734575458.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1734575458.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param appointmentId The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) call. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. This method may return false, even when the appointment was successfully removed. ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanagerforuser_showremoveappointmentasync_1845468926.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanagerforuser_showremoveappointmentasync_339596666.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param appointmentId +The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) call. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +This method may return false, even when the appointment was successfully removed. + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanagerforuser_showremoveappointmentasync_1845468926.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanagerforuser_showremoveappointmentasync_339596666.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1845468926.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1845468926.md index f70983eff3..c9f6e7bed0 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1845468926.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_1845468926.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param appointmentId The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) call. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. This method may return false, even when the appointment was successfully removed. ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect)](appointmentmanagerforuser_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanagerforuser_showremoveappointmentasync_339596666.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param appointmentId +The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) call. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +This method may return false, even when the appointment was successfully removed. + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect)](appointmentmanagerforuser_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentmanagerforuser_showremoveappointmentasync_339596666.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_339596666.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_339596666.md index 07d00618e4..5131f82d8b 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_339596666.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showremoveappointmentasync_339596666.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param appointmentId The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) call. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. ### -param instanceStartDate The start date and time of the appointment instance to remove. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. This method may return false, even when the appointment was successfully removed. ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect)](appointmentmanagerforuser_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanagerforuser_showremoveappointmentasync_1845468926.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param appointmentId +The appointment identifier. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) call. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. + +### -param instanceStartDate +The start date and time of the appointment instance to remove. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks +When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app. + +This method may return false, even when the appointment was successfully removed. + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect)](appointmentmanagerforuser_showremoveappointmentasync_1734575458.md), [ShowRemoveAppointmentAsync(String, Rect, Placement)](appointmentmanagerforuser_showremoveappointmentasync_1845468926.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md index 0ce8893e6f..209284d977 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param appointmentId The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanagerforuser_showreplaceappointmentasync.md) call. ### -param appointment The object representing the information for the appointment to replace the current appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param appointmentId +The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanagerforuser_showreplaceappointmentasync.md) call. + +### -param appointment +The object representing the information for the appointment to replace the current appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md index 0c04447e33..c409344ef8 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param appointmentId The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanagerforuser_showreplaceappointmentasync.md) call. ### -param appointment The object representing the information for the appointment to replace the current appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. ### -param instanceStartDate The start date and time of the appointment instance to replace. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param appointmentId +The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanagerforuser_showreplaceappointmentasync.md) call. + +### -param appointment +The object representing the information for the appointment to replace the current appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. + +### -param instanceStartDate +The start date and time of the appointment instance to replace. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)](appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md index 97b4547e03..109a3c097e 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showreplaceappointmentasync_1519758191.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param appointmentId The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanagerforuser_showreplaceappointmentasync.md) call. ### -param appointment The object representing the information for the appointment to replace the current appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. ## -returns When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param appointmentId +The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous [ShowAddAppointmentAsync](appointmentmanagerforuser_showaddappointmentasync.md) or [ShowReplaceAppointmentAsync](appointmentmanagerforuser_showreplaceappointmentasync.md) call. + +### -param appointment +The object representing the information for the appointment to replace the current appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. + +## -returns +When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentmanagerforuser_showreplaceappointmentasync_1336777815.md), [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentmanagerforuser_showreplaceappointmentasync_1458488223.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_showtimeframeasync_1558661698.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_showtimeframeasync_1558661698.md index 4e65eef272..2d51e3b9ec 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_showtimeframeasync_1558661698.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_showtimeframeasync_1558661698.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowTimeFrameAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowTimeFrameAsync ## -description Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar. ## -parameters ### -param timeToShow A date and time object that specifies the beginning of the time frame that the Appointments provider app should display. ### -param duration A timespan that hints to the Appointments provider app how long the time frame shown should be. ## -returns When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. ## -remarks This method uses parameter values representing date-time and timespan that are represented differently depending on which language you are programming with. + In JavaScript, set the *timeToShow* value with a **Date** object. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. + In Visual C++ component extensions (C++/CX), set the *timeToShow* value with a [DateTime](../windows.foundation/datetime.md) structure. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. + In C#, use a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) value for *timeToShow*, and a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) value for *duration*. You can use utility API of these structures to declare the values. For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowTimeFrameAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.ShowTimeFrameAsync + +## -description +Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar. + +## -parameters +### -param timeToShow +A date and time object that specifies the beginning of the time frame that the Appointments provider app should display. + +### -param duration +A timespan that hints to the Appointments provider app how long the time frame shown should be. + +## -returns +When this method returns, it does not return a result. On completion, the [AsyncActionCompletedHandler ](../windows.foundation/asyncactioncompletedhandler.md) specified by [get_Completed](http://msdn.microsoft.com/library/5050bf84-f9e0-4b3e-9252-6c5c1060826e) / [Completed](http://msdn.microsoft.com/library/eda29981-0c24-409a-8fb9-2dc2eb96d108) is invoked. + +## -remarks +This method uses parameter values representing date-time and timespan that are represented differently depending on which language you are programming with. ++ In JavaScript, set the *timeToShow* value with a **Date** object. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. ++ In Visual C++ component extensions (C++/CX), set the *timeToShow* value with a [DateTime](../windows.foundation/datetime.md) structure. Set the *duration* value with a [TimeSpan](../windows.foundation/timespan.md) representing a time span in 100-nanosecond units. ++ In C#, use a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) value for *timeToShow*, and a [System.TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) value for *duration*. You can use utility API of these structures to declare the values. + + +For info about how to manage appointments, see [Manage appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentmanagerforuser_user.md b/windows.applicationmodel.appointments/appointmentmanagerforuser_user.md index ee41d6a593..1d0ea7de0d 100644 --- a/windows.applicationmodel.appointments/appointmentmanagerforuser_user.md +++ b/windows.applicationmodel.appointments/appointmentmanagerforuser_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.User --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentManagerForUser.User ## -description Gets the [User](../windows.system/user.md) represented by this appointment manager. ## -property-value The [User](../windows.system/user.md) represented by this appointment manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentManagerForUser.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentManagerForUser.User + +## -description +Gets the [User](../windows.system/user.md) represented by this appointment manager. + +## -property-value +The [User](../windows.system/user.md) represented by this appointment manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentorganizer.md b/windows.applicationmodel.appointments/appointmentorganizer.md index d7005110f5..944d5e8617 100644 --- a/windows.applicationmodel.appointments/appointmentorganizer.md +++ b/windows.applicationmodel.appointments/appointmentorganizer.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentOrganizer --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentOrganizer ## -description Represents the organizer of an appointment in a calendar. ## -remarks ## -examples ## -see-also [IAppointmentParticipant](iappointmentparticipant.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentOrganizer +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentOrganizer + +## -description +Represents the organizer of an appointment in a calendar. + +## -remarks + +## -examples + +## -see-also +[IAppointmentParticipant](iappointmentparticipant.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentorganizer_address.md b/windows.applicationmodel.appointments/appointmentorganizer_address.md index d9946a9903..774d7f775d 100644 --- a/windows.applicationmodel.appointments/appointmentorganizer_address.md +++ b/windows.applicationmodel.appointments/appointmentorganizer_address.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentOrganizer.Address --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentOrganizer.Address ## -description Gets or sets a string that communicates the address of the organizer of an appointment. The address is required, inherited from [IAppointmentParticipant](iappointmentparticipant.md), and a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type [String](https://msdn.microsoft.com/library/system.string.aspx) and between 1 and 321 characters in length (non-empty). ## -property-value The address of the organizer of an appointment. ## -remarks When saving an appointment that has an [AppointmentOrganizer](appointmentorganizer.md) with an email address, if the address contains one of the characters listed in the table below, which are not allowed for this property, the address will be saved incorrectly and an exception won’t be thrown: ‘<’, ‘>’, ‘:’, ‘;’, ‘\’. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentOrganizer.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentOrganizer.Address + +## -description +Gets or sets a string that communicates the address of the organizer of an appointment. The address is required, inherited from [IAppointmentParticipant](iappointmentparticipant.md), and a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type [String](https://msdn.microsoft.com/library/system.string.aspx) and between 1 and 321 characters in length (non-empty). + +## -property-value +The address of the organizer of an appointment. + +## -remarks +When saving an appointment that has an [AppointmentOrganizer](appointmentorganizer.md) with an email address, if the address contains one of the characters listed in the table below, which are not allowed for this property, the address will be saved incorrectly and an exception won’t be thrown: ‘<’, ‘>’, ‘:’, ‘;’, ‘\’. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentorganizer_appointmentorganizer_1221375020.md b/windows.applicationmodel.appointments/appointmentorganizer_appointmentorganizer_1221375020.md index 4e31fa56b8..0ba88be0f5 100644 --- a/windows.applicationmodel.appointments/appointmentorganizer_appointmentorganizer_1221375020.md +++ b/windows.applicationmodel.appointments/appointmentorganizer_appointmentorganizer_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentOrganizer.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentOrganizer.AppointmentOrganizer ## -description Initializes a new instance of the [AppointmentOrganizer](appointmentorganizer.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentOrganizer.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentOrganizer.AppointmentOrganizer + +## -description +Initializes a new instance of the [AppointmentOrganizer](appointmentorganizer.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentorganizer_displayname.md b/windows.applicationmodel.appointments/appointmentorganizer_displayname.md index a3b3753284..dd9d837763 100644 --- a/windows.applicationmodel.appointments/appointmentorganizer_displayname.md +++ b/windows.applicationmodel.appointments/appointmentorganizer_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentOrganizer.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentOrganizer.DisplayName ## -description Gets or sets a string that communicates the display name of the organizer of an appointment. The display name is optional, inherited from [IAppointmentParticipant](iappointmentparticipant.md), of type [String](https://msdn.microsoft.com/library/system.string.aspx), and a maximum of 256 characters in length. ## -property-value The display name of the organizer of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentOrganizer.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentOrganizer.DisplayName + +## -description +Gets or sets a string that communicates the display name of the organizer of an appointment. The display name is optional, inherited from [IAppointmentParticipant](iappointmentparticipant.md), of type [String](https://msdn.microsoft.com/library/system.string.aspx), and a maximum of 256 characters in length. + +## -property-value +The display name of the organizer of an appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties.md b/windows.applicationmodel.appointments/appointmentproperties.md index 53630cc371..76cd78e744 100644 --- a/windows.applicationmodel.appointments/appointmentproperties.md +++ b/windows.applicationmodel.appointments/appointmentproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentProperties --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentProperties ## -description Provides strings that identify the properties of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentProperties +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties + +## -description +Provides strings that identify the properties of an appointment. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_allday.md b/windows.applicationmodel.appointments/appointmentproperties_allday.md index 6ec067f649..b67bf64b24 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_allday.md +++ b/windows.applicationmodel.appointments/appointmentproperties_allday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.AllDay --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.AllDay ## -description Gets the name of the [AllDay](appointment_allday.md) property. ## -property-value The name of the [AllDay](appointment_allday.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.AllDay +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.AllDay + +## -description +Gets the name of the [AllDay](appointment_allday.md) property. + +## -property-value +The name of the [AllDay](appointment_allday.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_allownewtimeproposal.md b/windows.applicationmodel.appointments/appointmentproperties_allownewtimeproposal.md index cebb71cc01..f014b355dc 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_allownewtimeproposal.md +++ b/windows.applicationmodel.appointments/appointmentproperties_allownewtimeproposal.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.AllowNewTimeProposal --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.AllowNewTimeProposal ## -description Gets the name of [AllowNewTimeProposal](appointment_allownewtimeproposal.md) the property. ## -property-value The name of [AllowNewTimeProposal](appointment_allownewtimeproposal.md) the property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.AllowNewTimeProposal +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.AllowNewTimeProposal + +## -description +Gets the name of [AllowNewTimeProposal](appointment_allownewtimeproposal.md) the property. + +## -property-value +The name of [AllowNewTimeProposal](appointment_allownewtimeproposal.md) the property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_busystatus.md b/windows.applicationmodel.appointments/appointmentproperties_busystatus.md index 4a662906d3..b4c588057d 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_busystatus.md +++ b/windows.applicationmodel.appointments/appointmentproperties_busystatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.BusyStatus --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.BusyStatus ## -description Gets the name of the [BusyStatus](appointment_busystatus.md) property. ## -property-value The name of the [BusyStatus](appointment_busystatus.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.BusyStatus +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.BusyStatus + +## -description +Gets the name of the [BusyStatus](appointment_busystatus.md) property. + +## -property-value +The name of the [BusyStatus](appointment_busystatus.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_changenumber.md b/windows.applicationmodel.appointments/appointmentproperties_changenumber.md index 5f4f6c7ca8..c4db47a179 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_changenumber.md +++ b/windows.applicationmodel.appointments/appointmentproperties_changenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.ChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.ChangeNumber ## -description Gets the current change number of the local version of the [Appointment](appointment.md). ## -property-value The current change number of the local version of the [Appointment](appointment.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.ChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.ChangeNumber + +## -description +Gets the current change number of the local version of the [Appointment](appointment.md). + +## -property-value +The current change number of the local version of the [Appointment](appointment.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_defaultproperties.md b/windows.applicationmodel.appointments/appointmentproperties_defaultproperties.md index b19c6f050c..e6512410ce 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_defaultproperties.md +++ b/windows.applicationmodel.appointments/appointmentproperties_defaultproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.DefaultProperties --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.DefaultProperties ## -description Gets a list of names for the default appointment properties. ## -property-value A list of names for the default appointment properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.DefaultProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.DefaultProperties + +## -description +Gets a list of names for the default appointment properties. + +## -property-value +A list of names for the default appointment properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_details.md b/windows.applicationmodel.appointments/appointmentproperties_details.md index e017a2a6f6..84337b3a13 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_details.md +++ b/windows.applicationmodel.appointments/appointmentproperties_details.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Details --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Details ## -description Gets the name of the [Details](appointment_details.md) property. ## -property-value The name of the [Details](appointment_details.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Details +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Details + +## -description +Gets the name of the [Details](appointment_details.md) property. + +## -property-value +The name of the [Details](appointment_details.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_detailskind.md b/windows.applicationmodel.appointments/appointmentproperties_detailskind.md index 3896fcf345..40d32c8a92 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_detailskind.md +++ b/windows.applicationmodel.appointments/appointmentproperties_detailskind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.DetailsKind --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.DetailsKind ## -description Gets the format of the appointment details, plain text or HTML. ## -property-value The format of the appointment details, plain text or HTML. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.DetailsKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.DetailsKind + +## -description +Gets the format of the appointment details, plain text or HTML. + +## -property-value +The format of the appointment details, plain text or HTML. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_duration.md b/windows.applicationmodel.appointments/appointmentproperties_duration.md index 21cfdfd7ef..18b1cf1076 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_duration.md +++ b/windows.applicationmodel.appointments/appointmentproperties_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Duration --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Duration ## -description Gets the name of the [Duration](appointment_duration.md) property. ## -property-value The name of the [Duration](appointment_duration.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Duration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Duration + +## -description +Gets the name of the [Duration](appointment_duration.md) property. + +## -property-value +The name of the [Duration](appointment_duration.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_hasinvitees.md b/windows.applicationmodel.appointments/appointmentproperties_hasinvitees.md index a8abc3b0c2..f42992fb14 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_hasinvitees.md +++ b/windows.applicationmodel.appointments/appointmentproperties_hasinvitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.HasInvitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.HasInvitees ## -description Gets the name of the [HasInvitees](appointment_hasinvitees.md) property. ## -property-value The name of the [HasInvitees](appointment_hasinvitees.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.HasInvitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.HasInvitees + +## -description +Gets the name of the [HasInvitees](appointment_hasinvitees.md) property. + +## -property-value +The name of the [HasInvitees](appointment_hasinvitees.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_invitees.md b/windows.applicationmodel.appointments/appointmentproperties_invitees.md index 0f54f89302..f1f1a1a050 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_invitees.md +++ b/windows.applicationmodel.appointments/appointmentproperties_invitees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Invitees --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Invitees ## -description Gets the name of the [Invitees](appointment_invitees.md) property. ## -property-value The name of the [Invitees](appointment_invitees.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Invitees +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Invitees + +## -description +Gets the name of the [Invitees](appointment_invitees.md) property. + +## -property-value +The name of the [Invitees](appointment_invitees.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_iscanceledmeeting.md b/windows.applicationmodel.appointments/appointmentproperties_iscanceledmeeting.md index e18ab782d4..9817cf3509 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_iscanceledmeeting.md +++ b/windows.applicationmodel.appointments/appointmentproperties_iscanceledmeeting.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.IsCanceledMeeting --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.IsCanceledMeeting ## -description Gets the name of the [IsCanceledMeeting](appointment_iscanceledmeeting.md) property. ## -property-value The name of the [IsCanceledMeeting](appointment_iscanceledmeeting.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.IsCanceledMeeting +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.IsCanceledMeeting + +## -description +Gets the name of the [IsCanceledMeeting](appointment_iscanceledmeeting.md) property. + +## -property-value +The name of the [IsCanceledMeeting](appointment_iscanceledmeeting.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_isorganizedbyuser.md b/windows.applicationmodel.appointments/appointmentproperties_isorganizedbyuser.md index 8776d98c0d..d0b8e9ea5c 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_isorganizedbyuser.md +++ b/windows.applicationmodel.appointments/appointmentproperties_isorganizedbyuser.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.IsOrganizedByUser --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.IsOrganizedByUser ## -description Gets the name of the [IsOrganizedByUser](appointment_isorganizedbyuser.md) property. ## -property-value The name of the [IsOrganizedByUser](appointment_isorganizedbyuser.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.IsOrganizedByUser +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.IsOrganizedByUser + +## -description +Gets the name of the [IsOrganizedByUser](appointment_isorganizedbyuser.md) property. + +## -property-value +The name of the [IsOrganizedByUser](appointment_isorganizedbyuser.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_isresponserequested.md b/windows.applicationmodel.appointments/appointmentproperties_isresponserequested.md index 31303b6bd9..147db578de 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_isresponserequested.md +++ b/windows.applicationmodel.appointments/appointmentproperties_isresponserequested.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.IsResponseRequested --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.IsResponseRequested ## -description Gets the name of the [IsResponseRequested](appointment_isresponserequested.md) property. ## -property-value The name of the [IsResponseRequested](appointment_isresponserequested.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.IsResponseRequested +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.IsResponseRequested + +## -description +Gets the name of the [IsResponseRequested](appointment_isresponserequested.md) property. + +## -property-value +The name of the [IsResponseRequested](appointment_isresponserequested.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_location.md b/windows.applicationmodel.appointments/appointmentproperties_location.md index 6aed6e8d32..3a2028227e 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_location.md +++ b/windows.applicationmodel.appointments/appointmentproperties_location.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Location --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Location ## -description Gets the name of the [Location](appointment_location.md) property. ## -property-value The name of the [Location](appointment_location.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Location +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Location + +## -description +Gets the name of the [Location](appointment_location.md) property. + +## -property-value +The name of the [Location](appointment_location.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_onlinemeetinglink.md b/windows.applicationmodel.appointments/appointmentproperties_onlinemeetinglink.md index 14d7f63e02..beaaef55bb 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_onlinemeetinglink.md +++ b/windows.applicationmodel.appointments/appointmentproperties_onlinemeetinglink.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.OnlineMeetingLink --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.OnlineMeetingLink ## -description Gets the name of the [OnlineMeetingLink](appointment_onlinemeetinglink.md) property. ## -property-value The name of the [OnlineMeetingLink](appointment_onlinemeetinglink.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.OnlineMeetingLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.OnlineMeetingLink + +## -description +Gets the name of the [OnlineMeetingLink](appointment_onlinemeetinglink.md) property. + +## -property-value +The name of the [OnlineMeetingLink](appointment_onlinemeetinglink.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_organizer.md b/windows.applicationmodel.appointments/appointmentproperties_organizer.md index ea4fbd102b..3c3724d90d 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_organizer.md +++ b/windows.applicationmodel.appointments/appointmentproperties_organizer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Organizer --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Organizer ## -description Gets the name of the [Organizer](appointment_organizer.md) property. ## -property-value The name of the [Organizer](appointment_organizer.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Organizer +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Organizer + +## -description +Gets the name of the [Organizer](appointment_organizer.md) property. + +## -property-value +The name of the [Organizer](appointment_organizer.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_originalstarttime.md b/windows.applicationmodel.appointments/appointmentproperties_originalstarttime.md index a2df578d3a..7e815e25a5 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_originalstarttime.md +++ b/windows.applicationmodel.appointments/appointmentproperties_originalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.OriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.OriginalStartTime ## -description Gets the name of the [OriginalStartTime](appointment_originalstarttime.md) property. ## -property-value The name of the [OriginalStartTime](appointment_originalstarttime.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.OriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.OriginalStartTime + +## -description +Gets the name of the [OriginalStartTime](appointment_originalstarttime.md) property. + +## -property-value +The name of the [OriginalStartTime](appointment_originalstarttime.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_recurrence.md b/windows.applicationmodel.appointments/appointmentproperties_recurrence.md index 0e753e04fa..d5391a3c71 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_recurrence.md +++ b/windows.applicationmodel.appointments/appointmentproperties_recurrence.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Recurrence --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Recurrence ## -description Gets the name of the [Recurrence](appointment_recurrence.md) property. ## -property-value The name of the [Recurrence](appointment_recurrence.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Recurrence +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Recurrence + +## -description +Gets the name of the [Recurrence](appointment_recurrence.md) property. + +## -property-value +The name of the [Recurrence](appointment_recurrence.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_reminder.md b/windows.applicationmodel.appointments/appointmentproperties_reminder.md index 9c842a423d..0d0b8fe0f4 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_reminder.md +++ b/windows.applicationmodel.appointments/appointmentproperties_reminder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Reminder --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Reminder ## -description Gets the name of the [Reminder](appointment_reminder.md) property. ## -property-value The name of the [Reminder](appointment_reminder.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Reminder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Reminder + +## -description +Gets the name of the [Reminder](appointment_reminder.md) property. + +## -property-value +The name of the [Reminder](appointment_reminder.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_remotechangenumber.md b/windows.applicationmodel.appointments/appointmentproperties_remotechangenumber.md index fa4aa4eadb..68f490e8ec 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_remotechangenumber.md +++ b/windows.applicationmodel.appointments/appointmentproperties_remotechangenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.RemoteChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.RemoteChangeNumber ## -description Gets or sets the current change number of the server version of the [Appointment](appointment.md). ## -property-value The current change number of the server version of the [Appointment](appointment.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.RemoteChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.RemoteChangeNumber + +## -description +Gets or sets the current change number of the server version of the [Appointment](appointment.md). + +## -property-value +The current change number of the server version of the [Appointment](appointment.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_replytime.md b/windows.applicationmodel.appointments/appointmentproperties_replytime.md index 5b37758d69..30e82e423e 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_replytime.md +++ b/windows.applicationmodel.appointments/appointmentproperties_replytime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.ReplyTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.ReplyTime ## -description Gets the name of the [ReplyTime](appointment_replytime.md) property. ## -property-value The name of the [ReplyTime](appointment_replytime.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.ReplyTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.ReplyTime + +## -description +Gets the name of the [ReplyTime](appointment_replytime.md) property. + +## -property-value +The name of the [ReplyTime](appointment_replytime.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_sensitivity.md b/windows.applicationmodel.appointments/appointmentproperties_sensitivity.md index c4776845d3..25869dbe6e 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_sensitivity.md +++ b/windows.applicationmodel.appointments/appointmentproperties_sensitivity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Sensitivity --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Sensitivity ## -description Gets the name of the [Sensitivity](appointment_sensitivity.md) property. ## -property-value The name of the [Sensitivity](appointment_sensitivity.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Sensitivity +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Sensitivity + +## -description +Gets the name of the [Sensitivity](appointment_sensitivity.md) property. + +## -property-value +The name of the [Sensitivity](appointment_sensitivity.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_starttime.md b/windows.applicationmodel.appointments/appointmentproperties_starttime.md index ce03da6350..1b92acc094 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_starttime.md +++ b/windows.applicationmodel.appointments/appointmentproperties_starttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.StartTime --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.StartTime ## -description Gets the name of the [StartTime](appointment_starttime.md) property. ## -property-value The name of the [StartTime](appointment_starttime.md) property ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.StartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.StartTime + +## -description +Gets the name of the [StartTime](appointment_starttime.md) property. + +## -property-value +The name of the [StartTime](appointment_starttime.md) property + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_subject.md b/windows.applicationmodel.appointments/appointmentproperties_subject.md index 8171513a1a..68fc05533e 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_subject.md +++ b/windows.applicationmodel.appointments/appointmentproperties_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Subject ## -description Gets the name of the [Subject](appointment_subject.md) property. ## -property-value The name of the [Subject](appointment_subject.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Subject + +## -description +Gets the name of the [Subject](appointment_subject.md) property. + +## -property-value +The name of the [Subject](appointment_subject.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_uri.md b/windows.applicationmodel.appointments/appointmentproperties_uri.md index 6b0006b0f4..c749bfc2d9 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_uri.md +++ b/windows.applicationmodel.appointments/appointmentproperties_uri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.Uri ## -description Gets the name of the [Uri](appointment_uri.md) property. ## -property-value The name of the [Uri](appointment_uri.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.Uri + +## -description +Gets the name of the [Uri](appointment_uri.md) property. + +## -property-value +The name of the [Uri](appointment_uri.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentproperties_userresponse.md b/windows.applicationmodel.appointments/appointmentproperties_userresponse.md index 7e884b4958..696689ebf8 100644 --- a/windows.applicationmodel.appointments/appointmentproperties_userresponse.md +++ b/windows.applicationmodel.appointments/appointmentproperties_userresponse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.UserResponse --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentProperties.UserResponse ## -description Gets the name of the [UserResponse](appointment_userresponse.md) property. ## -property-value The name of the [UserResponse](appointment_userresponse.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentProperties.UserResponse +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentProperties.UserResponse + +## -description +Gets the name of the [UserResponse](appointment_userresponse.md) property. + +## -property-value +The name of the [UserResponse](appointment_userresponse.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence.md b/windows.applicationmodel.appointments/appointmentrecurrence.md index ef0a356f87..5649a18f0a 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentRecurrence --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence ## -description Represents when and how often an appointment occurs. ## -remarks For info about how to manage appointments, see [Managing appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538) and [Quickstart: Managing appointments ](http://msdn.microsoft.com/library/4d7c555e-a707-428e-8ce3-1bd278028fc1). ## -examples ## -see-also [Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentRecurrence +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence + +## -description +Represents when and how often an appointment occurs. + +## -remarks +For info about how to manage appointments, see [Managing appointments](http://msdn.microsoft.com/library/292e9249-07c3-4791-b32c-6ec153c2b538) and [Quickstart: Managing appointments ](http://msdn.microsoft.com/library/4d7c555e-a707-428e-8ce3-1bd278028fc1). + +## -examples + +## -see-also +[Appointments API sample](http://go.microsoft.com/fwlink/p/?linkid=309836) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_appointmentrecurrence_1221375020.md b/windows.applicationmodel.appointments/appointmentrecurrence_appointmentrecurrence_1221375020.md index 3d0cbf193e..f69c65c2ed 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_appointmentrecurrence_1221375020.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_appointmentrecurrence_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentRecurrence.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.AppointmentRecurrence ## -description Initializes a new instance of the [AppointmentRecurrence](appointmentrecurrence.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentRecurrence.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.AppointmentRecurrence + +## -description +Initializes a new instance of the [AppointmentRecurrence](appointmentrecurrence.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_calendaridentifier.md b/windows.applicationmodel.appointments/appointmentrecurrence_calendaridentifier.md index 54cdd74919..4992938d68 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_calendaridentifier.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_calendaridentifier.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.CalendarIdentifier --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.CalendarIdentifier ## -description Gets a string that identifies the type of the calendar as represented by [CalendarIdentifiers](../windows.globalization/calendaridentifiers.md). ## -property-value A string that identifies the type of the calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.CalendarIdentifier +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.CalendarIdentifier + +## -description +Gets a string that identifies the type of the calendar as represented by [CalendarIdentifiers](../windows.globalization/calendaridentifiers.md). + +## -property-value +A string that identifies the type of the calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_day.md b/windows.applicationmodel.appointments/appointmentrecurrence_day.md index 0a46c681b9..d0c86c1b19 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_day.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_day.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Day --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.Day ## -description Gets or sets the day on which an appointment occurs. [Day](appointmentrecurrence_day.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx), has a default value of 1, and can be a value from 1 to 31. ## -property-value The day on which an appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Day +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.Day + +## -description +Gets or sets the day on which an appointment occurs. [Day](appointmentrecurrence_day.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx), has a default value of 1, and can be a value from 1 to 31. + +## -property-value +The day on which an appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_daysofweek.md b/windows.applicationmodel.appointments/appointmentrecurrence_daysofweek.md index 01d7f196c5..54ec9039bb 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_daysofweek.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_daysofweek.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.DaysOfWeek --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.DaysOfWeek ## -description Gets or sets a combination of [AppointmentDaysOfWeek](appointmentdaysofweek.md)-typed values for all the days of the week on which an appointment occurs. ## -property-value A combination of [AppointmentDaysOfWeek](appointmentdaysofweek.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies all the days of the week on which an appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.DaysOfWeek +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.DaysOfWeek + +## -description +Gets or sets a combination of [AppointmentDaysOfWeek](appointmentdaysofweek.md)-typed values for all the days of the week on which an appointment occurs. + +## -property-value +A combination of [AppointmentDaysOfWeek](appointmentdaysofweek.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies all the days of the week on which an appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_interval.md b/windows.applicationmodel.appointments/appointmentrecurrence_interval.md index ce83b6f4e9..ee2bbe3cea 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_interval.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_interval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Interval --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.Interval ## -description Gets or sets the interval between occurrences of an appointment. [Interval](appointmentrecurrence_interval.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx) and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on. ## -property-value The interval on which an appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Interval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.Interval + +## -description +Gets or sets the interval between occurrences of an appointment. [Interval](appointmentrecurrence_interval.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx) and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on. + +## -property-value +The interval on which an appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_month.md b/windows.applicationmodel.appointments/appointmentrecurrence_month.md index 6e9818653c..b685fc25c7 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_month.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_month.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Month --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.Month ## -description Gets or sets the month on which an appointment occurs. [Month](appointmentrecurrence_month.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx), has a default value of 1, and can be a value from 1 to 12. ## -property-value The month on which an appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Month +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.Month + +## -description +Gets or sets the month on which an appointment occurs. [Month](appointmentrecurrence_month.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx), has a default value of 1, and can be a value from 1 to 12. + +## -property-value +The month on which an appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_occurrences.md b/windows.applicationmodel.appointments/appointmentrecurrence_occurrences.md index f44679652c..d8dbd972eb 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_occurrences.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_occurrences.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Occurrences --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.Occurrences ## -description Gets or sets the number of times an appointment recurs. [Occurrences](appointmentrecurrence_occurrences.md) is of type [IReference(UInt32)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Occurrences](appointmentrecurrence_occurrences.md) is mutually exclusive with [Until](appointmentrecurrence_until.md). ## -property-value The number of times an appointment recurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Occurrences +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.Occurrences + +## -description +Gets or sets the number of times an appointment recurs. [Occurrences](appointmentrecurrence_occurrences.md) is of type [IReference(UInt32)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Occurrences](appointmentrecurrence_occurrences.md) is mutually exclusive with [Until](appointmentrecurrence_until.md). + +## -property-value +The number of times an appointment recurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_recurrencetype.md b/windows.applicationmodel.appointments/appointmentrecurrence_recurrencetype.md index 9527c6942e..11f261a703 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_recurrencetype.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_recurrencetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.RecurrenceType --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.RecurrenceType ## -description Gets a value indicating what type of recurrence applies to the associated appointment. ## -property-value A value indicating what type of recurrence applies to the associated appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.RecurrenceType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.RecurrenceType + +## -description +Gets a value indicating what type of recurrence applies to the associated appointment. + +## -property-value +A value indicating what type of recurrence applies to the associated appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_timezone.md b/windows.applicationmodel.appointments/appointmentrecurrence_timezone.md index cd95012e04..b9d6fac937 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_timezone.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_timezone.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.TimeZone --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.TimeZone ## -description Gets or sets the time zone for the recurrence. ## -property-value The time zone for the recurrence. ## -remarks [StartTime](appointment_starttime.md) is projected to type **DateTimeOffset** in C# and JavaScript and DateTime in C++. Because these types represents absolute point in time, setting the **TimeZone** of the recurrence will not change what time the appointment occurs. This field can be used by your app's UI to simply show the time zone value or to localize the appointment time to the time zone. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.TimeZone +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.TimeZone + +## -description +Gets or sets the time zone for the recurrence. + +## -property-value +The time zone for the recurrence. + +## -remarks +[StartTime](appointment_starttime.md) is projected to type **DateTimeOffset** in C# and JavaScript and DateTime in C++. Because these types represents absolute point in time, setting the **TimeZone** of the recurrence will not change what time the appointment occurs. This field can be used by your app's UI to simply show the time zone value or to localize the appointment time to the time zone. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_unit.md b/windows.applicationmodel.appointments/appointmentrecurrence_unit.md index 070627575d..8ead459d3f 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_unit.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_unit.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Unit --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.Unit ## -description Gets or sets a [AppointmentRecurrenceUnit](appointmentrecurrenceunit.md)-typed value that indicates the frequency for which the appointment occurs. ## -property-value A [AppointmentRecurrenceUnit](appointmentrecurrenceunit.md)-typed value that indicates the frequency for which the appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Unit +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.Unit + +## -description +Gets or sets a [AppointmentRecurrenceUnit](appointmentrecurrenceunit.md)-typed value that indicates the frequency for which the appointment occurs. + +## -property-value +A [AppointmentRecurrenceUnit](appointmentrecurrenceunit.md)-typed value that indicates the frequency for which the appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_until.md b/windows.applicationmodel.appointments/appointmentrecurrence_until.md index 340aae49bf..2424746e2b 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_until.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_until.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Until --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.Until ## -description Gets or sets the date and time until which an appointment is valid. [Until](appointmentrecurrence_until.md) is of type [IReference(DateTime)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Until](appointmentrecurrence_until.md) is mutually exclusive with [Occurrences](appointmentrecurrence_occurrences.md). ## -property-value The date and time until which an appointment is valid. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.Until +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.Until + +## -description +Gets or sets the date and time until which an appointment is valid. [Until](appointmentrecurrence_until.md) is of type [IReference(DateTime)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Until](appointmentrecurrence_until.md) is mutually exclusive with [Occurrences](appointmentrecurrence_occurrences.md). + +## -property-value +The date and time until which an appointment is valid. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentrecurrence_weekofmonth.md b/windows.applicationmodel.appointments/appointmentrecurrence_weekofmonth.md index 6b2898360f..b52bb3f3e9 100644 --- a/windows.applicationmodel.appointments/appointmentrecurrence_weekofmonth.md +++ b/windows.applicationmodel.appointments/appointmentrecurrence_weekofmonth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.WeekOfMonth --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentRecurrence.WeekOfMonth ## -description Gets or sets a [AppointmentWeekOfMonth](appointmentweekofmonth.md)-typed value that indicates the week of the month for which the appointment occurs. The first week is the default. ## -property-value A [AppointmentWeekOfMonth](appointmentweekofmonth.md)-typed value that indicates the week of the month for which the appointment occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentRecurrence.WeekOfMonth +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentRecurrence.WeekOfMonth + +## -description +Gets or sets a [AppointmentWeekOfMonth](appointmentweekofmonth.md)-typed value that indicates the week of the month for which the appointment occurs. The first week is the default. + +## -property-value +A [AppointmentWeekOfMonth](appointmentweekofmonth.md)-typed value that indicates the week of the month for which the appointment occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore.md b/windows.applicationmodel.appointments/appointmentstore.md index 643c7deca7..88f31a7c25 100644 --- a/windows.applicationmodel.appointments/appointmentstore.md +++ b/windows.applicationmodel.appointments/appointmentstore.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStore --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStore ## -description Represents a store that contains appointments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore + +## -description +Represents a store that contains appointments. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_changetracker.md b/windows.applicationmodel.appointments/appointmentstore_changetracker.md index abb9cf45eb..4e9a0b2652 100644 --- a/windows.applicationmodel.appointments/appointmentstore_changetracker.md +++ b/windows.applicationmodel.appointments/appointmentstore_changetracker.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentStore.ChangeTracker --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ChangeTracker ## -description Returns the [AppointmentStoreChangeTracker](appointmentstorechangetracker.md) associated with the appointment store. ## -property-value The [AppointmentStoreChangeTracker](appointmentstorechangetracker.md) associated with the appointment store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentStore.ChangeTracker +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ChangeTracker + +## -description +Returns the [AppointmentStoreChangeTracker](appointmentstorechangetracker.md) associated with the appointment store. + +## -property-value +The [AppointmentStoreChangeTracker](appointmentstorechangetracker.md) associated with the appointment store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_2027049901.md b/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_2027049901.md index d1d5494a7f..ac0ea84431 100644 --- a/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_2027049901.md +++ b/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_2027049901.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync ## -description Asynchronously creates a new [AppointmentCalendar](appointmentcalendar.md) within the appointment store using the specified parameters. ## -parameters ### -param name The name for the new [AppointmentCalendar](appointmentcalendar.md). ## -returns An async operation that provides access to the newly created [AppointmentCalendar](appointmentcalendar.md). ## -remarks ## -examples ## -see-also [CreateAppointmentCalendarAsync(String, String)](appointmentstore_createappointmentcalendarasync_875453971.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync + +## -description +Asynchronously creates a new [AppointmentCalendar](appointmentcalendar.md) within the appointment store using the specified parameters. + +## -parameters +### -param name +The name for the new [AppointmentCalendar](appointmentcalendar.md). + +## -returns +An async operation that provides access to the newly created [AppointmentCalendar](appointmentcalendar.md). + +## -remarks + +## -examples + +## -see-also +[CreateAppointmentCalendarAsync(String, String)](appointmentstore_createappointmentcalendarasync_875453971.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_875453971.md b/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_875453971.md index 16542556a9..6a8d6db5b4 100644 --- a/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_875453971.md +++ b/windows.applicationmodel.appointments/appointmentstore_createappointmentcalendarasync_875453971.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync ## -description Asynchronously creates a new [AppointmentCalendar](appointmentcalendar.md) within the appointment store with the specified name and user data account ID. ## -parameters ### -param name The name for the new [AppointmentCalendar](appointmentcalendar.md). ### -param userDataAccountId The identifier for the user data account used to create the [AppointmentCalendar](appointmentcalendar.md). ## -returns An async operation that provides access to the newly created [AppointmentCalendar](appointmentcalendar.md). ## -remarks ## -examples ## -see-also [CreateAppointmentCalendarAsync(String)](appointmentstore_createappointmentcalendarasync_2027049901.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.CreateAppointmentCalendarAsync + +## -description +Asynchronously creates a new [AppointmentCalendar](appointmentcalendar.md) within the appointment store with the specified name and user data account ID. + +## -parameters +### -param name +The name for the new [AppointmentCalendar](appointmentcalendar.md). + +### -param userDataAccountId +The identifier for the user data account used to create the [AppointmentCalendar](appointmentcalendar.md). + +## -returns +An async operation that provides access to the newly created [AppointmentCalendar](appointmentcalendar.md). + +## -remarks + +## -examples + +## -see-also +[CreateAppointmentCalendarAsync(String)](appointmentstore_createappointmentcalendarasync_2027049901.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_2097897582.md b/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_2097897582.md index 5a34091c3d..99b83defe1 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_2097897582.md +++ b/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_2097897582.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync(Windows.ApplicationModel.Appointments.FindAppointmentCalendarsOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync ## -description Retrieves a list of appointment calendars in the appointment store that meet the criteria specified by the supplied [FindAppointmentCalendarsOptions](findappointmentcalendarsoptions.md) object.. ## -parameters ### -param options The object that specifies the criteria that determines which appointment calendars are returned. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. ## -remarks ## -examples ## -see-also [FindAppointmentCalendarsAsync](appointmentstore_findappointmentcalendarsasync_336289890.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync(Windows.ApplicationModel.Appointments.FindAppointmentCalendarsOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync + +## -description +Retrieves a list of appointment calendars in the appointment store that meet the criteria specified by the supplied [FindAppointmentCalendarsOptions](findappointmentcalendarsoptions.md) object.. + +## -parameters +### -param options +The object that specifies the criteria that determines which appointment calendars are returned. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also +[FindAppointmentCalendarsAsync](appointmentstore_findappointmentcalendarsasync_336289890.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_336289890.md b/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_336289890.md index a1b4e6d3ec..a6b2670c7d 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_336289890.md +++ b/windows.applicationmodel.appointments/appointmentstore_findappointmentcalendarsasync_336289890.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync ## -description Retrieves a list of all of the appointment calendars in the appointment store. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. ## -remarks ## -examples ## -see-also [FindAppointmentCalendarsAsync(FindAppointmentCalendarsOptions)](appointmentstore_findappointmentcalendarsasync_2097897582.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentCalendarsAsync + +## -description +Retrieves a list of all of the appointment calendars in the appointment store. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also +[FindAppointmentCalendarsAsync(FindAppointmentCalendarsOptions)](appointmentstore_findappointmentcalendarsasync_2097897582.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_1659613836.md b/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_1659613836.md index 8aa6cbee9c..a4cdafc934 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_1659613836.md +++ b/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_1659613836.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync ## -description Retrieves a list of appointments in the appointment calendar that fall within the specified date range. ## -parameters ### -param rangeStart The start of the date range for which appointments are retrieved. ### -param rangeLength The length of the date range for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. ## -remarks ## -examples ## -see-also [FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)](appointmentstore_findappointmentsasync_541298316.md), [Appointment](appointment.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync + +## -description +Retrieves a list of appointments in the appointment calendar that fall within the specified date range. + +## -parameters +### -param rangeStart +The start of the date range for which appointments are retrieved. + +### -param rangeLength +The length of the date range for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. + +## -remarks + +## -examples + +## -see-also +[FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)](appointmentstore_findappointmentsasync_541298316.md), [Appointment](appointment.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_541298316.md b/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_541298316.md index 08c6a7ccc9..f5e4ec603a 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_541298316.md +++ b/windows.applicationmodel.appointments/appointmentstore_findappointmentsasync_541298316.md @@ -1,3 +1,55 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.ApplicationModel.Appointments.FindAppointmentsOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync ## -description Retrieves a list of appointments in the appointment calendar that fall within the specified date range and meet the criteria specified by the supplied [FindAppointmentsOptions](findappointmentsoptions.md) object.. ## -parameters ### -param rangeStart The start of the date range for which appointments are retrieved. ### -param rangeLength The length of the date range for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. ### -param options A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. You must set the *options* parameter to specify the values to retrieve. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. ## -remarks > [!IMPORTANT] > For performance reasons, [FindAppointmentsAsync](appointmentstore_findappointmentsasync.md) will not load most properties. To load specific properties, add values to the [FindAppointmentsOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) member in the *options* parameter. See the example below for more info. ## -examples Set [FindAppointmentOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) to specify the values to retrieve. ```csharp AppointmentStore calendar = await AppointmentManager.RequestStoreAsync(AppointmentStoreAccessType.AllCalendarsReadOnly); // Specify which values to retrieve FindAppointmentsOptions options = new FindAppointmentsOptions(); options.FetchProperties.Add(AppointmentProperties.Subject); options.FetchProperties.Add(AppointmentProperties.Details); options.FetchProperties.Add(AppointmentProperties.DetailsKind); var iteratingAppointments = await calendar.FindAppointmentsAsync(DateTimeOffset.Now, TimeSpan.FromDays(31), options); foreach (var i in iteratingAppointments) { // do stuff with each appointment } ``` ## -see-also [FindAppointmentsAsync(DateTime, TimeSpan)](appointmentstore_findappointmentsasync_1659613836.md), [Appointment](appointment.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.ApplicationModel.Appointments.FindAppointmentsOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindAppointmentsAsync + +## -description +Retrieves a list of appointments in the appointment calendar that fall within the specified date range and meet the criteria specified by the supplied [FindAppointmentsOptions](findappointmentsoptions.md) object.. + +## -parameters +### -param rangeStart +The start of the date range for which appointments are retrieved. + +### -param rangeLength +The length of the date range for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a [StartTime](appointment_starttime.md) that is exactly the same as the *rangeStart* value, the returned list will be empty. + +### -param options +A [FindAppointmentsOptions](findappointmentsoptions.md) object that is used to specify more options for this operation. You must set the *options* parameter to specify the values to retrieve. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) list of [Appointment](appointment.md) objects upon successful completion. + +## -remarks +> [!IMPORTANT] +> For performance reasons, [FindAppointmentsAsync](appointmentstore_findappointmentsasync.md) will not load most properties. To load specific properties, add values to the [FindAppointmentsOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) member in the *options* parameter. See the example below for more info. + +## -examples +Set [FindAppointmentOptions.FetchProperties](findappointmentsoptions_fetchproperties.md) to specify the values to retrieve. + +```csharp +AppointmentStore calendar = await AppointmentManager.RequestStoreAsync(AppointmentStoreAccessType.AllCalendarsReadOnly); + +// Specify which values to retrieve +FindAppointmentsOptions options = new FindAppointmentsOptions(); +options.FetchProperties.Add(AppointmentProperties.Subject); +options.FetchProperties.Add(AppointmentProperties.Details); +options.FetchProperties.Add(AppointmentProperties.DetailsKind); + +var iteratingAppointments = await calendar.FindAppointmentsAsync(DateTimeOffset.Now, TimeSpan.FromDays(31), options); + +foreach (var i in iteratingAppointments) +{ + // do stuff with each appointment +} +``` + + + +## -see-also +[FindAppointmentsAsync(DateTime, TimeSpan)](appointmentstore_findappointmentsasync_1659613836.md), [Appointment](appointment.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findconflictasync_1246034138.md b/windows.applicationmodel.appointments/appointmentstore_findconflictasync_1246034138.md index 4ef07cf1e8..79c667cec4 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findconflictasync_1246034138.md +++ b/windows.applicationmodel.appointments/appointmentstore_findconflictasync_1246034138.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync ## -description Returns an [AppointmentConflictResult](appointmentconflictresult.md) representing a conflict between the specified appointment and an existing appointment instance in the appointment store. ## -parameters ### -param appointment The appointment for which a conflict is sought. ### -param instanceStartTime The start time of the appointment instance for which a conflict is sought. ## -returns An asynchronous operation that returns an [AppointmentConflictResult](appointmentconflictresult.md) upon successful completion. For conflicts that are in the past, the returned [AppointmentConflictResult](appointmentconflictresult.md) object will have a [Type](appointmentconflictresult_type.md) of [AppointmentConflictType.None](appointmentconflicttype.md). ## -remarks ## -examples ## -see-also [FindConflictAsync(Appointment)](appointmentstore_findconflictasync_734762440.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync + +## -description +Returns an [AppointmentConflictResult](appointmentconflictresult.md) representing a conflict between the specified appointment and an existing appointment instance in the appointment store. + +## -parameters +### -param appointment +The appointment for which a conflict is sought. + +### -param instanceStartTime +The start time of the appointment instance for which a conflict is sought. + +## -returns +An asynchronous operation that returns an [AppointmentConflictResult](appointmentconflictresult.md) upon successful completion. For conflicts that are in the past, the returned [AppointmentConflictResult](appointmentconflictresult.md) object will have a [Type](appointmentconflictresult_type.md) of [AppointmentConflictType.None](appointmentconflicttype.md). + +## -remarks + +## -examples + +## -see-also +[FindConflictAsync(Appointment)](appointmentstore_findconflictasync_734762440.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findconflictasync_734762440.md b/windows.applicationmodel.appointments/appointmentstore_findconflictasync_734762440.md index 78a2d4dc51..5911ce0e53 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findconflictasync_734762440.md +++ b/windows.applicationmodel.appointments/appointmentstore_findconflictasync_734762440.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync(Windows.ApplicationModel.Appointments.Appointment) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync ## -description Returns an [AppointmentConflictResult](appointmentconflictresult.md) representing a conflict between the specified appointment and an existing appointment in the appointment store. ## -parameters ### -param appointment The appointment for which a conflict is sought. ## -returns An asynchronous operation that returns an [AppointmentConflictResult](appointmentconflictresult.md) upon successful completion. For conflicts that are in the past, the returned [AppointmentConflictResult](appointmentconflictresult.md) object will have a [Type](appointmentconflictresult_type.md) of [AppointmentConflictType.None](appointmentconflicttype.md). ## -remarks ## -examples ## -see-also [FindConflictAsync(Appointment, DateTime)](appointmentstore_findconflictasync_1246034138.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync(Windows.ApplicationModel.Appointments.Appointment) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindConflictAsync + +## -description +Returns an [AppointmentConflictResult](appointmentconflictresult.md) representing a conflict between the specified appointment and an existing appointment in the appointment store. + +## -parameters +### -param appointment +The appointment for which a conflict is sought. + +## -returns +An asynchronous operation that returns an [AppointmentConflictResult](appointmentconflictresult.md) upon successful completion. For conflicts that are in the past, the returned [AppointmentConflictResult](appointmentconflictresult.md) object will have a [Type](appointmentconflictresult_type.md) of [AppointmentConflictType.None](appointmentconflicttype.md). + +## -remarks + +## -examples + +## -see-also +[FindConflictAsync(Appointment, DateTime)](appointmentstore_findconflictasync_1246034138.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_findlocalidsfromroamingidasync_1948033566.md b/windows.applicationmodel.appointments/appointmentstore_findlocalidsfromroamingidasync_1948033566.md index 2f5876bf3a..f017f4cdcf 100644 --- a/windows.applicationmodel.appointments/appointmentstore_findlocalidsfromroamingidasync_1948033566.md +++ b/windows.applicationmodel.appointments/appointmentstore_findlocalidsfromroamingidasync_1948033566.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindLocalIdsFromRoamingIdAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.FindLocalIdsFromRoamingIdAsync ## -description Returns a list of [LocalId](appointment_localid.md) values for appointment instances with the specified [RoamingId](appointment_roamingid.md) value. ## -parameters ### -param roamingId The [RoamingId](appointment_roamingid.md) value for which local ID values are sought. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.FindLocalIdsFromRoamingIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.FindLocalIdsFromRoamingIdAsync + +## -description +Returns a list of [LocalId](appointment_localid.md) values for appointment instances with the specified [RoamingId](appointment_roamingid.md) value. + +## -parameters +### -param roamingId +The [RoamingId](appointment_roamingid.md) value for which local ID values are sought. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_getappointmentasync_126051655.md b/windows.applicationmodel.appointments/appointmentstore_getappointmentasync_126051655.md index 89e5e4da4b..ebb5c81abc 100644 --- a/windows.applicationmodel.appointments/appointmentstore_getappointmentasync_126051655.md +++ b/windows.applicationmodel.appointments/appointmentstore_getappointmentasync_126051655.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentAsync ## -description Retrieves the [Appointment](appointment.md) with the specified [LocalId](appointment_localid.md). ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be retrieved. ## -returns An asynchronous operation that returns an [Appointment](appointment.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentAsync + +## -description +Retrieves the [Appointment](appointment.md) with the specified [LocalId](appointment_localid.md). + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be retrieved. + +## -returns +An asynchronous operation that returns an [Appointment](appointment.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_getappointmentcalendarasync_1959042536.md b/windows.applicationmodel.appointments/appointmentstore_getappointmentcalendarasync_1959042536.md index 43e457277c..e1ad32ab4d 100644 --- a/windows.applicationmodel.appointments/appointmentstore_getappointmentcalendarasync_1959042536.md +++ b/windows.applicationmodel.appointments/appointmentstore_getappointmentcalendarasync_1959042536.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentCalendarAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentCalendarAsync ## -description Retrieves the [AppointmentCalendar](appointmentcalendar.md) with the specified [LocalId](appointmentcalendar_localid.md). ## -parameters ### -param calendarId The [LocalId](appointmentcalendar_localid.md) of the [AppointmentCalendar](appointmentcalendar.md) to be retrieved. ## -returns An asynchronous operation that returns an [AppointmentCalendar](appointmentcalendar.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentCalendarAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentCalendarAsync + +## -description +Retrieves the [AppointmentCalendar](appointmentcalendar.md) with the specified [LocalId](appointmentcalendar_localid.md). + +## -parameters +### -param calendarId +The [LocalId](appointmentcalendar_localid.md) of the [AppointmentCalendar](appointmentcalendar.md) to be retrieved. + +## -returns +An asynchronous operation that returns an [AppointmentCalendar](appointmentcalendar.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_getappointmentinstanceasync_367104527.md b/windows.applicationmodel.appointments/appointmentstore_getappointmentinstanceasync_367104527.md index 292f4a8ab2..6514c0edf3 100644 --- a/windows.applicationmodel.appointments/appointmentstore_getappointmentinstanceasync_367104527.md +++ b/windows.applicationmodel.appointments/appointmentstore_getappointmentinstanceasync_367104527.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentInstanceAsync(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentInstanceAsync ## -description Retrieves the instance of the [Appointment](appointment.md) with the specified [LocalId](appointment_localid.md) and the specified start time. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment instance to be retrieved. ### -param instanceStartTime The start time of the appointment instance to be retrieved. The value of this parameter must be the original start date of the instance. ## -returns An asynchronous operation that returns an [Appointment](appointment.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentInstanceAsync(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.GetAppointmentInstanceAsync + +## -description +Retrieves the instance of the [Appointment](appointment.md) with the specified [LocalId](appointment_localid.md) and the specified start time. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment instance to be retrieved. + +### -param instanceStartTime +The start time of the appointment instance to be retrieved. The value of this parameter must be the original start date of the instance. + +## -returns +An asynchronous operation that returns an [Appointment](appointment.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_moveappointmentasync_794093595.md b/windows.applicationmodel.appointments/appointmentstore_moveappointmentasync_794093595.md index e5266de83d..cf5a1310c5 100644 --- a/windows.applicationmodel.appointments/appointmentstore_moveappointmentasync_794093595.md +++ b/windows.applicationmodel.appointments/appointmentstore_moveappointmentasync_794093595.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.MoveAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.ApplicationModel.Appointments.AppointmentCalendar) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.MoveAppointmentAsync ## -description Moves the specified [Appointment](appointment.md) object to the specified [AppointmentCalendar](appointmentcalendar.md). ## -parameters ### -param appointment The appointment to be moved. ### -param destinationCalendar The appointment calendar to which the appointment is moved. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.MoveAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.ApplicationModel.Appointments.AppointmentCalendar) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.MoveAppointmentAsync + +## -description +Moves the specified [Appointment](appointment.md) object to the specified [AppointmentCalendar](appointmentcalendar.md). + +## -parameters +### -param appointment +The appointment to be moved. + +### -param destinationCalendar +The appointment calendar to which the appointment is moved. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_showaddappointmentasync_92599717.md b/windows.applicationmodel.appointments/appointmentstore_showaddappointmentasync_92599717.md index 62c5c34bd8..35b42495f4 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showaddappointmentasync_92599717.md +++ b/windows.applicationmodel.appointments/appointmentstore_showaddappointmentasync_92599717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowAddAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. ## -parameters ### -param appointment The object representing the information for the appointment to add. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. ## -remarks > For Windows Phone Store app, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanager_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowAddAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowAddAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment. + +## -parameters +### -param appointment +The object representing the information for the appointment to add. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Add Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. + +## -remarks +> For Windows Phone Store app, this method behaves the same as [ShowEditNewAppointmentAsync](appointmentmanager_showeditnewappointmentasync.md), in that the fields in the Add Appointment UI are editable by the user. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_1792084630.md b/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_1792084630.md index ab7b91e9b3..2e14ce2e12 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_1792084630.md +++ b/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_1792084630.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync ## -description Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be displayed. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also [ShowAppointmentDetailsAsync(String, DateTime)](appointmentstore_showappointmentdetailsasync_190736264.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync + +## -description +Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be displayed. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also +[ShowAppointmentDetailsAsync(String, DateTime)](appointmentstore_showappointmentdetailsasync_190736264.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_190736264.md b/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_190736264.md index 1117d9859f..44a49a62ef 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_190736264.md +++ b/windows.applicationmodel.appointments/appointmentstore_showappointmentdetailsasync_190736264.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync ## -description Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be displayed. ### -param instanceStartDate A [DateTime](../windows.foundation/datetime.md) object with the start time of the appointment instance to be displayed. This parameter must be the original start date of the instance. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also [ShowAppointmentDetailsAsync(String)](appointmentstore_showappointmentdetailsasync_1792084630.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowAppointmentDetailsAsync + +## -description +Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be displayed. + +### -param instanceStartDate +A [DateTime](../windows.foundation/datetime.md) object with the start time of the appointment instance to be displayed. This parameter must be the original start date of the instance. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also +[ShowAppointmentDetailsAsync(String)](appointmentstore_showappointmentdetailsasync_1792084630.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_showeditnewappointmentasync_372535555.md b/windows.applicationmodel.appointments/appointmentstore_showeditnewappointmentasync_372535555.md index 725c465832..44d3252611 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showeditnewappointmentasync_372535555.md +++ b/windows.applicationmodel.appointments/appointmentstore_showeditnewappointmentasync_372535555.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowEditNewAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowEditNewAppointmentAsync ## -description Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment. ## -parameters ### -param appointment The appointment to be added. ## -returns When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowEditNewAppointmentAsync(Windows.ApplicationModel.Appointments.Appointment) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowEditNewAppointmentAsync + +## -description +Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment. + +## -parameters +### -param appointment +The appointment to be added. + +## -returns +When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_1734575458.md b/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_1734575458.md index 6bc4e8afec..f9a8bf1c35 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_1734575458.md +++ b/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_1734575458.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be removed. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentstore_showremoveappointmentasync_339596666.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be removed. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)](appointmentstore_showremoveappointmentasync_339596666.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_339596666.md b/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_339596666.md index a5266b1a62..81e214e28f 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_339596666.md +++ b/windows.applicationmodel.appointments/appointmentstore_showremoveappointmentasync_339596666.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync ## -description Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be removed. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. ### -param instanceStartDate The start date and time of the appointment instance to remove. This parameter must be the original start date of the instance. ## -returns When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. ## -remarks ## -examples ## -see-also [ShowRemoveAppointmentAsync(String, Rect)](appointmentstore_showremoveappointmentasync_1734575458.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync(System.String,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowRemoveAppointmentAsync + +## -description +Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be removed. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Remove Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Remove Appointment UI. + +### -param instanceStartDate +The start date and time of the appointment instance to remove. This parameter must be the original start date of the instance. + +## -returns +When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment. + +## -remarks + +## -examples + +## -see-also +[ShowRemoveAppointmentAsync(String, Rect)](appointmentstore_showremoveappointmentasync_1734575458.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1336777815.md b/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1336777815.md index 9706821c92..042a0d3860 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1336777815.md +++ b/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1336777815.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be replaced. ### -param appointment The object representing the appointment to replace the existing appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ## -returns When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment that replaced the existing appointment. ## -remarks ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentstore_showreplaceappointmentasync_1458488223.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be replaced. + +### -param appointment +The object representing the appointment to replace the existing appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +## -returns +When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment that replaced the existing appointment. + +## -remarks + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)](appointmentstore_showreplaceappointmentasync_1458488223.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1458488223.md b/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1458488223.md index e00a3c2f93..2573c34024 100644 --- a/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1458488223.md +++ b/windows.applicationmodel.appointments/appointmentstore_showreplaceappointmentasync_1458488223.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync ## -description Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. ## -parameters ### -param localId The [LocalId](appointment_localid.md) of the appointment to be replaced. ### -param appointment The object representing the appointment to replace the existing appointment. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. ### -param instanceStartDate The start date and time of the appointment instance to replace. ## -returns When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment that replaced the existing appointment. ## -remarks The instanceStartTime parameter must be the original start date of the instance. ## -examples ## -see-also [ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentstore_showreplaceappointmentasync_1336777815.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync(System.String,Windows.ApplicationModel.Appointments.Appointment,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.ShowReplaceAppointmentAsync + +## -description +Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment. + +## -parameters +### -param localId +The [LocalId](appointment_localid.md) of the appointment to be replaced. + +### -param appointment +The object representing the appointment to replace the existing appointment. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the [Rect](../windows.foundation/rect.md), pass the [Rect](../windows.foundation/rect.md) of the button so the Replace Appointment UI displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the Replace Appointment UI. + +### -param instanceStartDate +The start date and time of the appointment instance to replace. + +## -returns +When this method completes, it returns a **String** object that represents the [RoamingId](appointment_roamingid.md) of the appointment that replaced the existing appointment. + +## -remarks +The instanceStartTime parameter must be the original start date of the instance. + +## -examples + +## -see-also +[ShowReplaceAppointmentAsync(String, Appointment, Rect)](appointmentstore_showreplaceappointmentasync_1336777815.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/appointmentstore_storechanged.md b/windows.applicationmodel.appointments/appointmentstore_storechanged.md index 5697da6977..8f33f7ba5d 100644 --- a/windows.applicationmodel.appointments/appointmentstore_storechanged.md +++ b/windows.applicationmodel.appointments/appointmentstore_storechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Appointments.AppointmentStore.StoreChanged --api-type: winrt event ---- # Windows.ApplicationModel.Appointments.AppointmentStore.StoreChanged ## -description Occurs when the [AppointmentStore](appointmentstore.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Appointments.AppointmentStore.StoreChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.StoreChanged + +## -description +Occurs when the [AppointmentStore](appointmentstore.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechange.md b/windows.applicationmodel.appointments/appointmentstorechange.md index 86a24e1fff..e36f291734 100644 --- a/windows.applicationmodel.appointments/appointmentstorechange.md +++ b/windows.applicationmodel.appointments/appointmentstorechange.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChange --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChange ## -description Represents a change that has occurred in an appointment store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChange +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChange + +## -description +Represents a change that has occurred in an appointment store. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechange_appointment.md b/windows.applicationmodel.appointments/appointmentstorechange_appointment.md index e80443a54d..33fe6adb2e 100644 --- a/windows.applicationmodel.appointments/appointmentstorechange_appointment.md +++ b/windows.applicationmodel.appointments/appointmentstorechange_appointment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChange.Appointment --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChange.Appointment ## -description Gets the [Appointment](appointment.md) associated with the change. ## -property-value The [Appointment](appointment.md) associated with the change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChange.Appointment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChange.Appointment + +## -description +Gets the [Appointment](appointment.md) associated with the change. + +## -property-value +The [Appointment](appointment.md) associated with the change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechange_appointmentcalendar.md b/windows.applicationmodel.appointments/appointmentstorechange_appointmentcalendar.md index a947fc3318..3a7351f289 100644 --- a/windows.applicationmodel.appointments/appointmentstorechange_appointmentcalendar.md +++ b/windows.applicationmodel.appointments/appointmentstorechange_appointmentcalendar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChange.AppointmentCalendar --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChange.AppointmentCalendar ## -description Gets the [AppointmentCalendar](appointmentcalendar.md) in which the change occurred. ## -property-value The [AppointmentCalendar](appointmentcalendar.md) in which the change occurred. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChange.AppointmentCalendar +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChange.AppointmentCalendar + +## -description +Gets the [AppointmentCalendar](appointmentcalendar.md) in which the change occurred. + +## -property-value +The [AppointmentCalendar](appointmentcalendar.md) in which the change occurred. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechange_changetype.md b/windows.applicationmodel.appointments/appointmentstorechange_changetype.md index 200fe598c4..13b0dc91e1 100644 --- a/windows.applicationmodel.appointments/appointmentstorechange_changetype.md +++ b/windows.applicationmodel.appointments/appointmentstorechange_changetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChange.ChangeType --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChange.ChangeType ## -description Gets an [AppointmentStoreChangeType](appointmentstorechangetype.md) value indicating the type of change represented by the object. ## -property-value An [AppointmentStoreChangeType](appointmentstorechangetype.md) value indicating the type of change represented by the object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChange.ChangeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChange.ChangeType + +## -description +Gets an [AppointmentStoreChangeType](appointmentstorechangetype.md) value indicating the type of change represented by the object. + +## -property-value +An [AppointmentStoreChangeType](appointmentstorechangetype.md) value indicating the type of change represented by the object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangeddeferral.md b/windows.applicationmodel.appointments/appointmentstorechangeddeferral.md index 52ac85501c..783f729a74 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangeddeferral.md +++ b/windows.applicationmodel.appointments/appointmentstorechangeddeferral.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral ## -description Represents a background task deferral returned by the [AppointmentStoreChangedEventArgs.GetDeferral](appointmentstorechangedeventargs_getdeferral.md) method. ## -remarks Returned by the [AppointmentStoreChangedEventArgs.GetDeferral](appointmentstorechangedeventargs_getdeferral.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral + +## -description +Represents a background task deferral returned by the [AppointmentStoreChangedEventArgs.GetDeferral](appointmentstorechangedeventargs_getdeferral.md) method. + +## -remarks +Returned by the [AppointmentStoreChangedEventArgs.GetDeferral](appointmentstorechangedeventargs_getdeferral.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangeddeferral_complete_1807836922.md b/windows.applicationmodel.appointments/appointmentstorechangeddeferral_complete_1807836922.md index fe77e9dde7..70905825da 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangeddeferral_complete_1807836922.md +++ b/windows.applicationmodel.appointments/appointmentstorechangeddeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral.Complete ## -description Informs the system that an asynchronous operation associated with an [AppointmentStore](appointmentstore.md) has finished. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangedDeferral.Complete + +## -description +Informs the system that an asynchronous operation associated with an [AppointmentStore](appointmentstore.md) has finished. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangedeventargs.md b/windows.applicationmodel.appointments/appointmentstorechangedeventargs.md index cd0422f8c4..7285599aae 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangedeventargs.md +++ b/windows.applicationmodel.appointments/appointmentstorechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs ## -description Provides data for a [StoreChanged](appointmentstore_storechanged.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [StoreChanged](appointmentstore_storechanged.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs + +## -description +Provides data for a [StoreChanged](appointmentstore_storechanged.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [StoreChanged](appointmentstore_storechanged.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangedeventargs_getdeferral_254836512.md b/windows.applicationmodel.appointments/appointmentstorechangedeventargs_getdeferral_254836512.md index bd4f8dc072..d0b590f2b0 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appointments/appointmentstorechangedeventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs.GetDeferral ## -description Gets the deferral object for the [StoreChanged](appointmentstore_storechanged.md) event. ## -returns The deferral object for the [StoreChanged](appointmentstore_storechanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangedEventArgs.GetDeferral + +## -description +Gets the deferral object for the [StoreChanged](appointmentstore_storechanged.md) event. + +## -returns +The deferral object for the [StoreChanged](appointmentstore_storechanged.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangereader.md b/windows.applicationmodel.appointments/appointmentstorechangereader.md index 77942a900d..61764192a4 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangereader.md +++ b/windows.applicationmodel.appointments/appointmentstorechangereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader ## -description Enables the calling app to read through the changes to appointments in its appointment store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader + +## -description +Enables the calling app to read through the changes to appointments in its appointment store. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchanges_143129490.md b/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchanges_143129490.md index ed7165cab1..bdb6ef66c2 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchanges_143129490.md +++ b/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchanges_143129490.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChanges --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChanges ## -description Tells the system that all of the changes to appointments returned by the call to [ReadBatchAsync](appointmentstorechangereader_readbatchasync.md) have been addressed by the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChanges +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChanges + +## -description +Tells the system that all of the changes to appointments returned by the call to [ReadBatchAsync](appointmentstorechangereader_readbatchasync.md) have been addressed by the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchangesthrough_1764096661.md b/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchangesthrough_1764096661.md index ea5696900d..dc82c9f64f 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchangesthrough_1764096661.md +++ b/windows.applicationmodel.appointments/appointmentstorechangereader_acceptchangesthrough_1764096661.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Appointments.AppointmentStoreChange) --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChangesThrough ## -description Tells the system that all of the changes to appointments returned by the call to [ReadBatchAsync](appointmentstorechangereader_readbatchasync.md), up to the specified [AppointmentStoreChange](appointmentstorechange.md), have been addressed by the app. ## -parameters ### -param lastChangeToAccept The [AppointmentStoreChange](appointmentstorechange.md) object indicating the latest change that has been addressed by the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Appointments.AppointmentStoreChange) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.AcceptChangesThrough + +## -description +Tells the system that all of the changes to appointments returned by the call to [ReadBatchAsync](appointmentstorechangereader_readbatchasync.md), up to the specified [AppointmentStoreChange](appointmentstorechange.md), have been addressed by the app. + +## -parameters +### -param lastChangeToAccept +The [AppointmentStoreChange](appointmentstorechange.md) object indicating the latest change that has been addressed by the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangereader_readbatchasync_888788553.md b/windows.applicationmodel.appointments/appointmentstorechangereader_readbatchasync_888788553.md index bff802d708..df6fdddf1c 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangereader_readbatchasync_888788553.md +++ b/windows.applicationmodel.appointments/appointmentstorechangereader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.ReadBatchAsync ## -description Returns a list of the changes that have occurred in the appointment store that have not yet been accepted by the calling app. ## -returns An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeReader.ReadBatchAsync + +## -description +Returns a list of the changes that have occurred in the appointment store that have not yet been accepted by the calling app. + +## -returns +An asynchronous operation that returns an [IVectorView](../windows.foundation.collections/ivectorview_1.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangetracker.md b/windows.applicationmodel.appointments/appointmentstorechangetracker.md index 647c0c88ab..be001b4e47 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangetracker.md +++ b/windows.applicationmodel.appointments/appointmentstorechangetracker.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker ## -description Provides APIs for managing change tracking for appointments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker + +## -description +Provides APIs for managing change tracking for appointments. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangetracker_enable_366433390.md b/windows.applicationmodel.appointments/appointmentstorechangetracker_enable_366433390.md index f02ceda9b0..0b4d383a0d 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangetracker_enable_366433390.md +++ b/windows.applicationmodel.appointments/appointmentstorechangetracker_enable_366433390.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Enable --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Enable ## -description Enables change tracking for the appointment store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Enable +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Enable + +## -description +Enables change tracking for the appointment store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangetracker_getchangereader_1364424875.md b/windows.applicationmodel.appointments/appointmentstorechangetracker_getchangereader_1364424875.md index cbdbcaab5e..f952254b52 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangetracker_getchangereader_1364424875.md +++ b/windows.applicationmodel.appointments/appointmentstorechangetracker_getchangereader_1364424875.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.GetChangeReader --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.GetChangeReader ## -description Retrieves an [AppointmentStoreChangeReader](appointmentstorechangereader.md) that enables the app to iterate through the list of changes and mark changes as accepted. ## -returns The returned change reader. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.GetChangeReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.GetChangeReader + +## -description +Retrieves an [AppointmentStoreChangeReader](appointmentstorechangereader.md) that enables the app to iterate through the list of changes and mark changes as accepted. + +## -returns +The returned change reader. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorechangetracker_reset_1636126115.md b/windows.applicationmodel.appointments/appointmentstorechangetracker_reset_1636126115.md index 832bda1230..3666503d72 100644 --- a/windows.applicationmodel.appointments/appointmentstorechangetracker_reset_1636126115.md +++ b/windows.applicationmodel.appointments/appointmentstorechangetracker_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Reset --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Reset ## -description Resets change tracking for the appointment store, deleting existing change tracking data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Reset +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.Reset + +## -description +Resets change tracking for the appointment store, deleting existing change tracking data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/appointmentstorenotificationtriggerdetails.md b/windows.applicationmodel.appointments/appointmentstorenotificationtriggerdetails.md index 3a63bd04a3..02ec59bf82 100644 --- a/windows.applicationmodel.appointments/appointmentstorenotificationtriggerdetails.md +++ b/windows.applicationmodel.appointments/appointmentstorenotificationtriggerdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreNotificationTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.AppointmentStoreNotificationTriggerDetails ## -description Passed to a background task to indicate that the task was invoked by an [AppointmentStore](appointmentstore.md). ## -remarks This object is received as an argument to an [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.AppointmentStoreNotificationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreNotificationTriggerDetails + +## -description +Passed to a background task to indicate that the task was invoked by an [AppointmentStore](appointmentstore.md). + +## -remarks +This object is received as an argument to an [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/findappointmentsoptions.md b/windows.applicationmodel.appointments/findappointmentsoptions.md index 6da50cf041..6c7a9c8022 100644 --- a/windows.applicationmodel.appointments/findappointmentsoptions.md +++ b/windows.applicationmodel.appointments/findappointmentsoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Appointments.FindAppointmentsOptions --api-type: winrt class ---- # Windows.ApplicationModel.Appointments.FindAppointmentsOptions ## -description Represents a set of options that modifies a query for appointments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Appointments.FindAppointmentsOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Appointments.FindAppointmentsOptions + +## -description +Represents a set of options that modifies a query for appointments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/findappointmentsoptions_calendarids.md b/windows.applicationmodel.appointments/findappointmentsoptions_calendarids.md index 460646f0ae..f620ccaa0f 100644 --- a/windows.applicationmodel.appointments/findappointmentsoptions_calendarids.md +++ b/windows.applicationmodel.appointments/findappointmentsoptions_calendarids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.CalendarIds --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.FindAppointmentsOptions.CalendarIds ## -description Gets the list of calendar IDs that will be included in the find appointments query. If this list is empty, then appointments will be returned from all calendars. ## -property-value A list of calendar IDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.CalendarIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.FindAppointmentsOptions.CalendarIds + +## -description +Gets the list of calendar IDs that will be included in the find appointments query. If this list is empty, then appointments will be returned from all calendars. + +## -property-value +A list of calendar IDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/findappointmentsoptions_fetchproperties.md b/windows.applicationmodel.appointments/findappointmentsoptions_fetchproperties.md index d7bac186fb..b954de92da 100644 --- a/windows.applicationmodel.appointments/findappointmentsoptions_fetchproperties.md +++ b/windows.applicationmodel.appointments/findappointmentsoptions_fetchproperties.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.FetchProperties --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.FindAppointmentsOptions.FetchProperties ## -description Gets the list of appointment property names that will be populated with data in the find appointment query results. ## -property-value A list of appointment property names. ## -remarks The following properties are always returned from a find appointment query, even if they are not explicitly specified in the **FetchProperties** list. + [CalendarId](appointment_calendarid.md) + [LocalId](appointment_localid.md) + [OriginalStartTime](appointment_originalstarttime.md) + [Recurrence](appointment_recurrence.md) + [RoamingId](appointment_roamingid.md) The list of valid properties is documented in the [AppointmentProperties](appointmentproperties.md) class. ## -examples ## -see-also [AppointmentProperties](appointmentproperties.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.FetchProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.FindAppointmentsOptions.FetchProperties + +## -description +Gets the list of appointment property names that will be populated with data in the find appointment query results. + +## -property-value +A list of appointment property names. + +## -remarks +The following properties are always returned from a find appointment query, even if they are not explicitly specified in the **FetchProperties** list. + + ++ [CalendarId](appointment_calendarid.md) ++ [LocalId](appointment_localid.md) ++ [OriginalStartTime](appointment_originalstarttime.md) ++ [Recurrence](appointment_recurrence.md) ++ [RoamingId](appointment_roamingid.md) + + +The list of valid properties is documented in the [AppointmentProperties](appointmentproperties.md) class. + +## -examples + +## -see-also +[AppointmentProperties](appointmentproperties.md) \ No newline at end of file diff --git a/windows.applicationmodel.appointments/findappointmentsoptions_findappointmentsoptions_1221375020.md b/windows.applicationmodel.appointments/findappointmentsoptions_findappointmentsoptions_1221375020.md index 76f8b26031..702d897b18 100644 --- a/windows.applicationmodel.appointments/findappointmentsoptions_findappointmentsoptions_1221375020.md +++ b/windows.applicationmodel.appointments/findappointmentsoptions_findappointmentsoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Appointments.FindAppointmentsOptions.FindAppointmentsOptions ## -description Creates a new instance of the [FindAppointmentsOptions](findappointmentsoptions.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.FindAppointmentsOptions.FindAppointmentsOptions + +## -description +Creates a new instance of the [FindAppointmentsOptions](findappointmentsoptions.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/findappointmentsoptions_includehidden.md b/windows.applicationmodel.appointments/findappointmentsoptions_includehidden.md index 071e1a8225..ffd0ff294d 100644 --- a/windows.applicationmodel.appointments/findappointmentsoptions_includehidden.md +++ b/windows.applicationmodel.appointments/findappointmentsoptions_includehidden.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.IncludeHidden --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.FindAppointmentsOptions.IncludeHidden ## -description Gets or sets a value indicating whether appointments belonging to hidden calendars will be included in the find appointments query result. ## -property-value A value indicating whether appointments belonging to hidden calendars will be included in the find appointments query result. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.IncludeHidden +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.FindAppointmentsOptions.IncludeHidden + +## -description +Gets or sets a value indicating whether appointments belonging to hidden calendars will be included in the find appointments query result. + +## -property-value +A value indicating whether appointments belonging to hidden calendars will be included in the find appointments query result. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/findappointmentsoptions_maxcount.md b/windows.applicationmodel.appointments/findappointmentsoptions_maxcount.md index 775db05ef1..fe2af14f4b 100644 --- a/windows.applicationmodel.appointments/findappointmentsoptions_maxcount.md +++ b/windows.applicationmodel.appointments/findappointmentsoptions_maxcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.MaxCount --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.FindAppointmentsOptions.MaxCount ## -description Gets or sets the maximum number of appointments that should be included in the find appointments query result. ## -property-value The maximum number of appointments that should be included in the find appointments query result. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.FindAppointmentsOptions.MaxCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.FindAppointmentsOptions.MaxCount + +## -description +Gets or sets the maximum number of appointments that should be included in the find appointments query result. + +## -property-value +The maximum number of appointments that should be included in the find appointments query result. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/iappointmentparticipant_address.md b/windows.applicationmodel.appointments/iappointmentparticipant_address.md index cdb83ae92b..445a3f1bf2 100644 --- a/windows.applicationmodel.appointments/iappointmentparticipant_address.md +++ b/windows.applicationmodel.appointments/iappointmentparticipant_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.IAppointmentParticipant.Address --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.IAppointmentParticipant.Address ## -description Gets or sets a string that communicates the address of a participant of an appointment. The address is required and is a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type [String](https://msdn.microsoft.com/library/system.string.aspx) and between 1 and 321 characters in length (non-empty). ## -property-value The address of a participant of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.IAppointmentParticipant.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.IAppointmentParticipant.Address + +## -description +Gets or sets a string that communicates the address of a participant of an appointment. The address is required and is a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type [String](https://msdn.microsoft.com/library/system.string.aspx) and between 1 and 321 characters in length (non-empty). + +## -property-value +The address of a participant of an appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appointments/iappointmentparticipant_displayname.md b/windows.applicationmodel.appointments/iappointmentparticipant_displayname.md index 1e6fc9d10f..590f561667 100644 --- a/windows.applicationmodel.appointments/iappointmentparticipant_displayname.md +++ b/windows.applicationmodel.appointments/iappointmentparticipant_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Appointments.IAppointmentParticipant.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Appointments.IAppointmentParticipant.DisplayName ## -description Gets or sets a string that communicates the display name of a participant of an appointment. The display name is optional, of type [String](https://msdn.microsoft.com/library/system.string.aspx), and a maximum of 256 characters in length. ## -property-value The display name of a participant of an appointment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Appointments.IAppointmentParticipant.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.IAppointmentParticipant.DisplayName + +## -description +Gets or sets a string that communicates the display name of a participant of an appointment. The display name is optional, of type [String](https://msdn.microsoft.com/library/system.string.aspx), and a maximum of 256 characters in length. + +## -property-value +The display name of a participant of an appointment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicecatalog_findappserviceprovidersasync_1441051450.md b/windows.applicationmodel.appservice/appservicecatalog_findappserviceprovidersasync_1441051450.md index 018addcf4a..c495ae1e58 100644 --- a/windows.applicationmodel.appservice/appservicecatalog_findappserviceprovidersasync_1441051450.md +++ b/windows.applicationmodel.appservice/appservicecatalog_findappserviceprovidersasync_1441051450.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceCatalog.FindAppServiceProvidersAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceCatalog.FindAppServiceProvidersAsync ## -description Returns the list of app service providers that match a specific app service name on the device. ## -parameters ### -param appServiceName The name of the app service to find. ## -returns A list of [AppInfo](../windows.applicationmodel/appinfo.md) s for the app service provider(s) that are available for the specified app service name. > [!TIP] > In C++, the return value is [IAsyncOperation<IVectorView<AppInfo>>](../windows.foundation/iasyncoperation_1.md) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceCatalog.FindAppServiceProvidersAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceCatalog.FindAppServiceProvidersAsync + +## -description +Returns the list of app service providers that match a specific app service name on the device. + +## -parameters +### -param appServiceName +The name of the app service to find. + +## -returns +A list of [AppInfo](../windows.applicationmodel/appinfo.md) s for the app service provider(s) that are available for the specified app service name. + +> [!TIP] +> In C++, the return value is [IAsyncOperation<IVectorView<AppInfo>>](../windows.foundation/iasyncoperation_1.md) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appserviceclosedeventargs.md b/windows.applicationmodel.appservice/appserviceclosedeventargs.md index 3a4ecf6afe..e79b70bfa2 100644 --- a/windows.applicationmodel.appservice/appserviceclosedeventargs.md +++ b/windows.applicationmodel.appservice/appserviceclosedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.AppService.AppServiceClosedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppService.AppServiceClosedEventArgs ## -description Provides data for the [AppServiceConnection.ServiceClosed](appserviceconnection_serviceclosed.md) event that occurs when the other endpoint closes connection to the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. ## -remarks An instance of this class is passed to the event handler that you implement for the [AppServiceConnection.ServiceClosed](appserviceconnection_serviceclosed.md) event. ## -examples ## -see-also [AppServiceConnection.ServiceClosed](appserviceconnection_serviceclosed.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppService.AppServiceClosedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppService.AppServiceClosedEventArgs + +## -description +Provides data for the [AppServiceConnection.ServiceClosed](appserviceconnection_serviceclosed.md) event that occurs when the other endpoint closes connection to the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. + +## -remarks +An instance of this class is passed to the event handler that you implement for the [AppServiceConnection.ServiceClosed](appserviceconnection_serviceclosed.md) event. + +## -examples + +## -see-also +[AppServiceConnection.ServiceClosed](appserviceconnection_serviceclosed.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceclosedeventargs_status.md b/windows.applicationmodel.appservice/appserviceclosedeventargs_status.md index 2a78eb849f..6b84f90352 100644 --- a/windows.applicationmodel.appservice/appserviceclosedeventargs_status.md +++ b/windows.applicationmodel.appservice/appserviceclosedeventargs_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceClosedEventArgs.Status --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceClosedEventArgs.Status ## -description Gets the status that was set when the endpoint for the app service was closed. ## -property-value The status that was set when the endpoint for the app service was closed. ## -remarks ## -examples ## -see-also [AppServiceClosedStatus](appserviceclosedstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceClosedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceClosedEventArgs.Status + +## -description +Gets the status that was set when the endpoint for the app service was closed. + +## -property-value +The status that was set when the endpoint for the app service was closed. + +## -remarks + +## -examples + +## -see-also +[AppServiceClosedStatus](appserviceclosedstatus.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection.md b/windows.applicationmodel.appservice/appserviceconnection.md index 2ca34fc05b..4fede08c1f 100644 --- a/windows.applicationmodel.appservice/appserviceconnection.md +++ b/windows.applicationmodel.appservice/appserviceconnection.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppService.AppServiceConnection --api-type: winrt class ---- # Windows.ApplicationModel.AppService.AppServiceConnection ## -description Represents a connection to the endpoint for an app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [App services sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620489) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppService.AppServiceConnection +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection + +## -description +Represents a connection to the endpoint for an app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [App services sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620489) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection_appserviceconnection_1221375020.md b/windows.applicationmodel.appservice/appserviceconnection_appserviceconnection_1221375020.md index 167bb7edf3..25d46f06ab 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_appserviceconnection_1221375020.md +++ b/windows.applicationmodel.appservice/appserviceconnection_appserviceconnection_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceConnection.AppServiceConnection ## -description Creates and initializes a new instance of the [AppServiceConnection](appserviceconnection.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.AppServiceConnection + +## -description +Creates and initializes a new instance of the [AppServiceConnection](appserviceconnection.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appserviceconnection_appservicename.md b/windows.applicationmodel.appservice/appserviceconnection_appservicename.md index bb2ada2e88..9eb7c9c736 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_appservicename.md +++ b/windows.applicationmodel.appservice/appserviceconnection_appservicename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceConnection.AppServiceName --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceConnection.AppServiceName ## -description Gets or sets the name of the app service to which you want to connect. ## -property-value The name of the app service to which you want to connect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceConnection.AppServiceName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.AppServiceName + +## -description +Gets or sets the name of the app service to which you want to connect. + +## -property-value +The name of the app service to which you want to connect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appserviceconnection_close_811482585.md b/windows.applicationmodel.appservice/appserviceconnection_close_811482585.md index 6af721f72f..6859124f4f 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_close_811482585.md +++ b/windows.applicationmodel.appservice/appserviceconnection_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.Close --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceConnection.Close ## -description Closes the connection to the app service. ## -remarks You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.Close +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.Close + +## -description +Closes the connection to the app service. + +## -remarks +You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appserviceconnection_openasync_171309613.md b/windows.applicationmodel.appservice/appserviceconnection_openasync_171309613.md index 7cbbb02c10..aa2d3f801c 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_openasync_171309613.md +++ b/windows.applicationmodel.appservice/appserviceconnection_openasync_171309613.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.OpenAsync --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceConnection.OpenAsync ## -description Opens a connection to the endpoint for the app service. ## -returns An asynchronous operation to open a connection to the endpoint for the app service. ## -remarks ## -examples ## -see-also [AppServiceConnectionStatus](appserviceconnectionstatus.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.OpenAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.OpenAsync + +## -description +Opens a connection to the endpoint for the app service. + +## -returns +An asynchronous operation to open a connection to the endpoint for the app service. + +## -remarks + +## -examples + +## -see-also +[AppServiceConnectionStatus](appserviceconnectionstatus.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection_openremoteasync_1754731669.md b/windows.applicationmodel.appservice/appserviceconnection_openremoteasync_1754731669.md index 1fea5f3d05..b16ba1128b 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_openremoteasync_1754731669.md +++ b/windows.applicationmodel.appservice/appserviceconnection_openremoteasync_1754731669.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.OpenRemoteAsync(Windows.System.RemoteSystems.RemoteSystemConnectionRequest) --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceConnection.OpenRemoteAsync ## -description Opens a connection to the endpoint on another device for the app service. ## -parameters ### -param remoteSystemConnectionRequest Specifies the connection preferences for the [AppServiceConnection](appserviceconnection.md), such as transport preferences (cloud/proximal/any) as well as the target [System.RemoteSystems](../windows.system.remotesystems/windows_system_remotesystems.md) object. ## -returns An asynchronous operation to open a connection to the endpoint for the app service on another device. ## -remarks ## -examples ## -see-also ## -capabilities remoteSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.OpenRemoteAsync(Windows.System.RemoteSystems.RemoteSystemConnectionRequest) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.OpenRemoteAsync + +## -description +Opens a connection to the endpoint on another device for the app service. + +## -parameters +### -param remoteSystemConnectionRequest +Specifies the connection preferences for the [AppServiceConnection](appserviceconnection.md), such as transport preferences (cloud/proximal/any) as well as the target [System.RemoteSystems](../windows.system.remotesystems/windows_system_remotesystems.md) object. + +## -returns +An asynchronous operation to open a connection to the endpoint for the app service on another device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +remoteSystem \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection_packagefamilyname.md b/windows.applicationmodel.appservice/appserviceconnection_packagefamilyname.md index f997c15e1b..5f0430b0cd 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_packagefamilyname.md +++ b/windows.applicationmodel.appservice/appserviceconnection_packagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceConnection.PackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceConnection.PackageFamilyName ## -description Gets or sets the package family name for the package that contains the endpoint for the app service. ## -property-value The package family name for the package that contains the endpoint for the app service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceConnection.PackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.PackageFamilyName + +## -description +Gets or sets the package family name for the package that contains the endpoint for the app service. + +## -property-value +The package family name for the package that contains the endpoint for the app service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appserviceconnection_requestreceived.md b/windows.applicationmodel.appservice/appserviceconnection_requestreceived.md index 6961373abf..b3a1ade5cf 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_requestreceived.md +++ b/windows.applicationmodel.appservice/appserviceconnection_requestreceived.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.AppService.AppServiceConnection.RequestReceived --api-type: winrt event ---- # Windows.ApplicationModel.AppService.AppServiceConnection.RequestReceived ## -description Occurs when a message arrives from the other endpoint of the app service connection. ## -remarks ## -examples ## -see-also [AppServiceRequestReceivedEventArgs](appservicerequestreceivedeventargs.md), [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppService.AppServiceConnection.RequestReceived +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.RequestReceived + +## -description +Occurs when a message arrives from the other endpoint of the app service connection. + +## -remarks + +## -examples + +## -see-also +[AppServiceRequestReceivedEventArgs](appservicerequestreceivedeventargs.md), [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection_sendmessageasync_1777128850.md b/windows.applicationmodel.appservice/appserviceconnection_sendmessageasync_1777128850.md index a9ea35cfbf..e0103aa7d0 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_sendmessageasync_1777128850.md +++ b/windows.applicationmodel.appservice/appserviceconnection_sendmessageasync_1777128850.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.SendMessageAsync(Windows.Foundation.Collections.ValueSet) --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceConnection.SendMessageAsync ## -description Sends a message to the other endpoint of the app service connection. ## -parameters ### -param message The message that you want to send. ## -returns An asynchronous operation to send the message that optionally returns a response message when complete. ## -remarks ## -examples ## -see-also [ValueSet](../windows.foundation.collections/valueset.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md), [AppServiceResponse](appserviceresponse.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceConnection.SendMessageAsync(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.SendMessageAsync + +## -description +Sends a message to the other endpoint of the app service connection. + +## -parameters +### -param message +The message that you want to send. + +## -returns +An asynchronous operation to send the message that optionally returns a response message when complete. + +## -remarks + +## -examples + +## -see-also +[ValueSet](../windows.foundation.collections/valueset.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md), [AppServiceResponse](appserviceresponse.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection_serviceclosed.md b/windows.applicationmodel.appservice/appserviceconnection_serviceclosed.md index ac95c7587a..3d9e4100c9 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_serviceclosed.md +++ b/windows.applicationmodel.appservice/appserviceconnection_serviceclosed.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.AppService.AppServiceConnection.ServiceClosed --api-type: winrt event ---- # Windows.ApplicationModel.AppService.AppServiceConnection.ServiceClosed ## -description Occurs when the other endpoint closes the connection to the app service. ## -remarks ## -examples ## -see-also [AppServiceClosedEventArgs](appserviceclosedeventargs.md), [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.AppService.AppServiceConnection.ServiceClosed +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.ServiceClosed + +## -description +Occurs when the other endpoint closes the connection to the app service. + +## -remarks + +## -examples + +## -see-also +[AppServiceClosedEventArgs](appserviceclosedeventargs.md), [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceconnection_user.md b/windows.applicationmodel.appservice/appserviceconnection_user.md index 61ec978f76..f5735b6714 100644 --- a/windows.applicationmodel.appservice/appserviceconnection_user.md +++ b/windows.applicationmodel.appservice/appserviceconnection_user.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceConnection.User --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceConnection.User ## -description Gets/sets the user context. This property returns **null** if the caller did not specify a user. ## -property-value The user of the app service. ## -remarks This property is set by the caller. Callers that have the multi-user manifest entry must set this property even if the app is not running on a multi-user platform. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceConnection.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceConnection.User + +## -description +Gets/sets the user context. This property returns **null** if the caller did not specify a user. + +## -property-value +The user of the app service. + +## -remarks +This property is set by the caller. Callers that have the multi-user manifest entry must set this property even if the app is not running on a multi-user platform. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicedeferral.md b/windows.applicationmodel.appservice/appservicedeferral.md index 43ebab965c..c89780c7a7 100644 --- a/windows.applicationmodel.appservice/appservicedeferral.md +++ b/windows.applicationmodel.appservice/appservicedeferral.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.AppService.AppServiceDeferral --api-type: winrt class ---- # Windows.ApplicationModel.AppService.AppServiceDeferral ## -description Enables the background task for an app service to get a deferral so that the app service can respond to subsequent requests. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume. ## -remarks Use [AppServiceRequestReceivedEventArgs.GetDeferral](appservicerequestreceivedeventargs_getdeferral.md) to get this deferral. ## -examples ## -see-also [AppServiceRequestReceivedEventArgs.GetDeferral](appservicerequestreceivedeventargs_getdeferral.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppService.AppServiceDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppService.AppServiceDeferral + +## -description +Enables the background task for an app service to get a deferral so that the app service can respond to subsequent requests. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume. + +## -remarks +Use [AppServiceRequestReceivedEventArgs.GetDeferral](appservicerequestreceivedeventargs_getdeferral.md) to get this deferral. + +## -examples + +## -see-also +[AppServiceRequestReceivedEventArgs.GetDeferral](appservicerequestreceivedeventargs_getdeferral.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appservicedeferral_complete_1807836922.md b/windows.applicationmodel.appservice/appservicedeferral_complete_1807836922.md index 517aff7ce8..e2849888c1 100644 --- a/windows.applicationmodel.appservice/appservicedeferral_complete_1807836922.md +++ b/windows.applicationmodel.appservice/appservicedeferral_complete_1807836922.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceDeferral.Complete ## -description Indicates that the content for an asynchronous handler for the [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) event is ready, or that an error occurred. ## -remarks ## -examples ## -see-also [AppServiceRequestReceivedEventArgs.GetDeferral](appservicerequestreceivedeventargs_getdeferral.md), [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceDeferral.Complete + +## -description +Indicates that the content for an asynchronous handler for the [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) event is ready, or that an error occurred. + +## -remarks + +## -examples + +## -see-also +[AppServiceRequestReceivedEventArgs.GetDeferral](appservicerequestreceivedeventargs_getdeferral.md), [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appservicerequest_message.md b/windows.applicationmodel.appservice/appservicerequest_message.md index d3290da45f..2eb5824b27 100644 --- a/windows.applicationmodel.appservice/appservicerequest_message.md +++ b/windows.applicationmodel.appservice/appservicerequest_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceRequest.Message --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceRequest.Message ## -description Gets the message that request from the app service contains. ## -property-value The message that request from the app service contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceRequest.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceRequest.Message + +## -description +Gets the message that request from the app service contains. + +## -property-value +The message that request from the app service contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicerequest_sendresponseasync_1698036998.md b/windows.applicationmodel.appservice/appservicerequest_sendresponseasync_1698036998.md index 546ca674c0..69a55ea356 100644 --- a/windows.applicationmodel.appservice/appservicerequest_sendresponseasync_1698036998.md +++ b/windows.applicationmodel.appservice/appservicerequest_sendresponseasync_1698036998.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceRequest.SendResponseAsync(Windows.Foundation.Collections.ValueSet) --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceRequest.SendResponseAsync ## -description Sends a response to a received request. ## -parameters ### -param message The message that you want to include in the response. ## -returns An asynchronous operation to send the response. ## -remarks Calling [AppServiceRequest](appservicerequest.md) is optional. An endpoint for an app service does not have to return a response to a request. ## -examples ## -see-also [AppServiceResponseStatus](appserviceresponsestatus.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceRequest.SendResponseAsync(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceRequest.SendResponseAsync + +## -description +Sends a response to a received request. + +## -parameters +### -param message +The message that you want to include in the response. + +## -returns +An asynchronous operation to send the response. + +## -remarks +Calling [AppServiceRequest](appservicerequest.md) is optional. An endpoint for an app service does not have to return a response to a request. + +## -examples + +## -see-also +[AppServiceResponseStatus](appserviceresponsestatus.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appservicerequestreceivedeventargs.md b/windows.applicationmodel.appservice/appservicerequestreceivedeventargs.md index 51a34fb1a3..38ba641037 100644 --- a/windows.applicationmodel.appservice/appservicerequestreceivedeventargs.md +++ b/windows.applicationmodel.appservice/appservicerequestreceivedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs ## -description Provides data for the [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) event that occurs when a message arrives from the other endpoint of the app service connection. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. ## -remarks An instance of this class is passed to the event handler that you implement for the [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) event. ## -examples ## -see-also [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs + +## -description +Provides data for the [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) event that occurs when a message arrives from the other endpoint of the app service connection. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. + +## -remarks +An instance of this class is passed to the event handler that you implement for the [AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) event. + +## -examples + +## -see-also +[AppServiceConnection.RequestReceived](appserviceconnection_requestreceived.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_getdeferral_254836512.md b/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_getdeferral_254836512.md index ec94b9d4c3..966033ffcb 100644 --- a/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.GetDeferral ## -description Informs the system that the event handler might continue to perform work after the event handler returns. ## -returns The deferral. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.GetDeferral + +## -description +Informs the system that the event handler might continue to perform work after the event handler returns. + +## -returns +The deferral. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_request.md b/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_request.md index cb7ea2f5cf..f82d0a8189 100644 --- a/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_request.md +++ b/windows.applicationmodel.appservice/appservicerequestreceivedeventargs_request.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.Request ## -description Gets the request that was received from the app service. ## -property-value The request that was received from the app service. ## -remarks ## -examples ## -see-also [AppServiceRequest](appservicerequest.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceRequestReceivedEventArgs.Request + +## -description +Gets the request that was received from the app service. + +## -property-value +The request that was received from the app service. + +## -remarks + +## -examples + +## -see-also +[AppServiceRequest](appservicerequest.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appserviceresponse_message.md b/windows.applicationmodel.appservice/appserviceresponse_message.md index 59e271636e..4fcc86387b 100644 --- a/windows.applicationmodel.appservice/appserviceresponse_message.md +++ b/windows.applicationmodel.appservice/appserviceresponse_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceResponse.Message --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceResponse.Message ## -description Gets the message that the response from the app service contains. ## -property-value The message that the response from the app service contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceResponse.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceResponse.Message + +## -description +Gets the message that the response from the app service contains. + +## -property-value +The message that the response from the app service contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appserviceresponse_status.md b/windows.applicationmodel.appservice/appserviceresponse_status.md index 658e1b17a3..10f2ab736a 100644 --- a/windows.applicationmodel.appservice/appserviceresponse_status.md +++ b/windows.applicationmodel.appservice/appserviceresponse_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceResponse.Status --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceResponse.Status ## -description Gets the status for the response from the app service. ## -property-value The status for the response from the app service. ## -remarks ## -examples ## -see-also [AppServiceResponseStatus](appserviceresponsestatus.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceResponse.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceResponse.Status + +## -description +Gets the status for the response from the app service. + +## -property-value +The status for the response from the app service. + +## -remarks + +## -examples + +## -see-also +[AppServiceResponseStatus](appserviceresponsestatus.md) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appservicetriggerdetails.md b/windows.applicationmodel.appservice/appservicetriggerdetails.md index 6115cb300c..bd0f6751d6 100644 --- a/windows.applicationmodel.appservice/appservicetriggerdetails.md +++ b/windows.applicationmodel.appservice/appservicetriggerdetails.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.AppService.AppServiceTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.AppService.AppServiceTriggerDetails ## -description Represents details associated with the background task for the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. ## -remarks To get the [AppServiceTriggerDetails](appservicetriggerdetails.md) for an app service, use the [IBackgroundTaskInstance.TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property. ## -examples ## -see-also [IBackgroundTaskInstance.TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md), [App services sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620489) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppService.AppServiceTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppService.AppServiceTriggerDetails + +## -description +Represents details associated with the background task for the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app. + +## -remarks +To get the [AppServiceTriggerDetails](appservicetriggerdetails.md) for an app service, use the [IBackgroundTaskInstance.TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property. + +## -examples + +## -see-also +[IBackgroundTaskInstance.TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md), [App services sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620489) \ No newline at end of file diff --git a/windows.applicationmodel.appservice/appservicetriggerdetails_appserviceconnection.md b/windows.applicationmodel.appservice/appservicetriggerdetails_appserviceconnection.md index 9c85781e24..d04b2054d7 100644 --- a/windows.applicationmodel.appservice/appservicetriggerdetails_appserviceconnection.md +++ b/windows.applicationmodel.appservice/appservicetriggerdetails_appserviceconnection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.AppServiceConnection --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceTriggerDetails.AppServiceConnection ## -description Gets the connection to the endpoint of the other app service. ## -property-value The connection to the endpoint of the other app service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.AppServiceConnection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceTriggerDetails.AppServiceConnection + +## -description +Gets the connection to the endpoint of the other app service. + +## -property-value +The connection to the endpoint of the other app service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicetriggerdetails_callerpackagefamilyname.md b/windows.applicationmodel.appservice/appservicetriggerdetails_callerpackagefamilyname.md index fdfd52a1ee..141300f66b 100644 --- a/windows.applicationmodel.appservice/appservicetriggerdetails_callerpackagefamilyname.md +++ b/windows.applicationmodel.appservice/appservicetriggerdetails_callerpackagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.CallerPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceTriggerDetails.CallerPackageFamilyName ## -description Gets the name of the package family for the client app that called the background task for the app service. ## -property-value The name of the package family for the client app that called the background task for the app service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.CallerPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceTriggerDetails.CallerPackageFamilyName + +## -description +Gets the name of the package family for the client app that called the background task for the app service. + +## -property-value +The name of the package family for the client app that called the background task for the app service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicetriggerdetails_isremotesystemconnection.md b/windows.applicationmodel.appservice/appservicetriggerdetails_isremotesystemconnection.md index 0a7b0936e5..564bb00df5 100644 --- a/windows.applicationmodel.appservice/appservicetriggerdetails_isremotesystemconnection.md +++ b/windows.applicationmodel.appservice/appservicetriggerdetails_isremotesystemconnection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.IsRemoteSystemConnection --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceTriggerDetails.IsRemoteSystemConnection ## -description Gets whether the client app that called the background task for the app service is on another device. ## -property-value Returns **true** if the client app is calling from another device; **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.IsRemoteSystemConnection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceTriggerDetails.IsRemoteSystemConnection + +## -description +Gets whether the client app that called the background task for the app service is on another device. + +## -property-value +Returns **true** if the client app is calling from another device; **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.appservice/appservicetriggerdetails_name.md b/windows.applicationmodel.appservice/appservicetriggerdetails_name.md index 7738272f6c..66db79ea33 100644 --- a/windows.applicationmodel.appservice/appservicetriggerdetails_name.md +++ b/windows.applicationmodel.appservice/appservicetriggerdetails_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.Name --api-type: winrt property ---- # Windows.ApplicationModel.AppService.AppServiceTriggerDetails.Name ## -description Gets the name of the app service. ## -property-value The name of the app service. ## -remarks ## -examples ## -see-also [AppServiceConnection.AppServiceName](appserviceconnection_appservicename.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppService.AppServiceTriggerDetails.Name + +## -description +Gets the name of the app service. + +## -property-value +The name of the app service. + +## -remarks + +## -examples + +## -see-also +[AppServiceConnection.AppServiceName](appserviceconnection_appservicename.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/activitysensortrigger.md b/windows.applicationmodel.background/activitysensortrigger.md index 0f281e56d1..61adc04adf 100644 --- a/windows.applicationmodel.background/activitysensortrigger.md +++ b/windows.applicationmodel.background/activitysensortrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ActivitySensorTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ActivitySensorTrigger ## -description Represents a trigger that is activated when the [ActivitySensor](../windows.devices.sensors/activitysensor.md) receives input. This is used when your application needs to respond to the activity sensor. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ActivitySensorTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger + +## -description +Represents a trigger that is activated when the [ActivitySensor](../windows.devices.sensors/activitysensor.md) receives input. This is used when your application needs to respond to the activity sensor. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/activitysensortrigger_activitysensortrigger_885572907.md b/windows.applicationmodel.background/activitysensortrigger_activitysensortrigger_885572907.md index 15743e643a..00083bc01f 100644 --- a/windows.applicationmodel.background/activitysensortrigger_activitysensortrigger_885572907.md +++ b/windows.applicationmodel.background/activitysensortrigger_activitysensortrigger_885572907.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ActivitySensorTrigger.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Background.ActivitySensorTrigger.ActivitySensorTrigger ## -description Creates an instance of the [ActivitySensorTrigger](activitysensortrigger.md) class with an initial [MinimumReportInterval](activitysensortrigger_minimumreportinterval.md). ## -parameters ### -param reportIntervalInMilliseconds The initial report interval to use for [MinimumReportInterval](activitysensortrigger_minimumreportinterval.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ActivitySensorTrigger.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger.ActivitySensorTrigger + +## -description +Creates an instance of the [ActivitySensorTrigger](activitysensortrigger.md) class with an initial [MinimumReportInterval](activitysensortrigger_minimumreportinterval.md). + +## -parameters +### -param reportIntervalInMilliseconds +The initial report interval to use for [MinimumReportInterval](activitysensortrigger_minimumreportinterval.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/activitysensortrigger_minimumreportinterval.md b/windows.applicationmodel.background/activitysensortrigger_minimumreportinterval.md index b0ddfd2922..a7a0528b41 100644 --- a/windows.applicationmodel.background/activitysensortrigger_minimumreportinterval.md +++ b/windows.applicationmodel.background/activitysensortrigger_minimumreportinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.MinimumReportInterval --api-type: winrt property ---- # Windows.ApplicationModel.Background.ActivitySensorTrigger.MinimumReportInterval ## -description Gets the minimum supported report interval for the sensor trigger. ## -property-value The minimum supported interval in milliseconds. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger.MinimumReportInterval + +## -description +Gets the minimum supported report interval for the sensor trigger. + +## -property-value +The minimum supported interval in milliseconds. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/activitysensortrigger_reportinterval.md b/windows.applicationmodel.background/activitysensortrigger_reportinterval.md index ff6bf9b276..d16cca3eb0 100644 --- a/windows.applicationmodel.background/activitysensortrigger_reportinterval.md +++ b/windows.applicationmodel.background/activitysensortrigger_reportinterval.md @@ -1,4 +1,22 @@ ---- --api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval --api-type: winrt property ---- # Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval ## -description Gets the report interval for the trigger. ## -property-value The current report interval for the trigger in milliseconds. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval + +## -description +Gets the report interval for the trigger. + +## -property-value +The current report interval for the trigger in milliseconds. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.background/activitysensortrigger_subscribedactivities.md b/windows.applicationmodel.background/activitysensortrigger_subscribedactivities.md index f3e5f31df6..ad65392c3c 100644 --- a/windows.applicationmodel.background/activitysensortrigger_subscribedactivities.md +++ b/windows.applicationmodel.background/activitysensortrigger_subscribedactivities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.SubscribedActivities --api-type: winrt property ---- # Windows.ApplicationModel.Background.ActivitySensorTrigger.SubscribedActivities ## -description Gets or sets the list of activities your trigger is subscribed to. ## -property-value The list of subscribed activities. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.SubscribedActivities +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger.SubscribedActivities + +## -description +Gets or sets the list of activities your trigger is subscribed to. + +## -property-value +The list of subscribed activities. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/activitysensortrigger_supportedactivities.md b/windows.applicationmodel.background/activitysensortrigger_supportedactivities.md index 22469ac4aa..5391487b96 100644 --- a/windows.applicationmodel.background/activitysensortrigger_supportedactivities.md +++ b/windows.applicationmodel.background/activitysensortrigger_supportedactivities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.SupportedActivities --api-type: winrt property ---- # Windows.ApplicationModel.Background.ActivitySensorTrigger.SupportedActivities ## -description Gets the list of supported activities you can subscribe to. ## -property-value The list of supported activities for subscription. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.SupportedActivities +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger.SupportedActivities + +## -description +Gets the list of supported activities you can subscribe to. + +## -property-value +The list of supported activities for subscription. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/alarmapplicationmanager.md b/windows.applicationmodel.background/alarmapplicationmanager.md index 2b4b2a7cbb..e5dfe70e80 100644 --- a/windows.applicationmodel.background/alarmapplicationmanager.md +++ b/windows.applicationmodel.background/alarmapplicationmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Background.AlarmApplicationManager --api-type: winrt class ---- # Windows.ApplicationModel.Background.AlarmApplicationManager ## -description Requests permission from the user to set alarms, and retrieves the status of user permission for the app to set alarms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.AlarmApplicationManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.AlarmApplicationManager + +## -description +Requests permission from the user to set alarms, and retrieves the status of user permission for the app to set alarms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/alarmapplicationmanager_getaccessstatus_125212976.md b/windows.applicationmodel.background/alarmapplicationmanager_getaccessstatus_125212976.md index 499bb484a2..37942a125d 100644 --- a/windows.applicationmodel.background/alarmapplicationmanager_getaccessstatus_125212976.md +++ b/windows.applicationmodel.background/alarmapplicationmanager_getaccessstatus_125212976.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Background.AlarmApplicationManager.GetAccessStatus --api-type: winrt method ---- # Windows.ApplicationModel.Background.AlarmApplicationManager.GetAccessStatus ## -description Retrieves the status of user permission for the app to set alarms. ## -returns Indicates whether the user has granted permission to set alarms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.AlarmApplicationManager.GetAccessStatus +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.AlarmApplicationManager.GetAccessStatus + +## -description +Retrieves the status of user permission for the app to set alarms. + +## -returns +Indicates whether the user has granted permission to set alarms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/alarmapplicationmanager_requestaccessasync_380675631.md b/windows.applicationmodel.background/alarmapplicationmanager_requestaccessasync_380675631.md index c007341b37..eab4ce1d6c 100644 --- a/windows.applicationmodel.background/alarmapplicationmanager_requestaccessasync_380675631.md +++ b/windows.applicationmodel.background/alarmapplicationmanager_requestaccessasync_380675631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Background.AlarmApplicationManager.RequestAccessAsync --api-type: winrt method ---- # Windows.ApplicationModel.Background.AlarmApplicationManager.RequestAccessAsync ## -description Requests permission from the user to set alarms. ## -returns This method returns an [AlarmAccessStatus](alarmaccessstatus.md) value when it completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.AlarmApplicationManager.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.AlarmApplicationManager.RequestAccessAsync + +## -description +Requests permission from the user to set alarms. + +## -returns +This method returns an [AlarmAccessStatus](alarmaccessstatus.md) value when it completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/applicationtrigger.md b/windows.applicationmodel.background/applicationtrigger.md index 61d9c75745..2a09543e0b 100644 --- a/windows.applicationmodel.background/applicationtrigger.md +++ b/windows.applicationmodel.background/applicationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ApplicationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ApplicationTrigger ## -description This allows you to programmatically trigger a background tasks from within your application. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ApplicationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ApplicationTrigger + +## -description +This allows you to programmatically trigger a background tasks from within your application. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/applicationtrigger_applicationtrigger_1221375020.md b/windows.applicationmodel.background/applicationtrigger_applicationtrigger_1221375020.md index 1a71c4f681..2a6a4fac08 100644 --- a/windows.applicationmodel.background/applicationtrigger_applicationtrigger_1221375020.md +++ b/windows.applicationmodel.background/applicationtrigger_applicationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ApplicationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ApplicationTrigger.ApplicationTrigger ## -description Creates a new [ApplicationTrigger](applicationtrigger.md) class ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ApplicationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ApplicationTrigger.ApplicationTrigger + +## -description +Creates a new [ApplicationTrigger](applicationtrigger.md) class + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/applicationtrigger_requestasync_1089362155.md b/windows.applicationmodel.background/applicationtrigger_requestasync_1089362155.md index 731ceff9c5..400f05c026 100644 --- a/windows.applicationmodel.background/applicationtrigger_requestasync_1089362155.md +++ b/windows.applicationmodel.background/applicationtrigger_requestasync_1089362155.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync(Windows.Foundation.Collections.ValueSet) --api-type: winrt method ---- # Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync ## -description This method attempts to set the trigger and start the registered background task with specified arguments. ## -parameters ### -param arguments The serialized arguments that are passed to the background task. ## -returns Returns an [ApplicationTriggerResult](applicationtriggerresult.md) enumeration that indicates whether the user provided the necessary consent for the operation or the system policies didn't reject the request to trigger a background task. ## -remarks ## -examples ## -see-also [RequestAsync](applicationtrigger_requestasync_1234533424.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync + +## -description +This method attempts to set the trigger and start the registered background task with specified arguments. + +## -parameters +### -param arguments +The serialized arguments that are passed to the background task. + +## -returns +Returns an [ApplicationTriggerResult](applicationtriggerresult.md) enumeration that indicates whether the user provided the necessary consent for the operation or the system policies didn't reject the request to trigger a background task. + +## -remarks + +## -examples + +## -see-also +[RequestAsync](applicationtrigger_requestasync_1234533424.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/applicationtrigger_requestasync_1234533424.md b/windows.applicationmodel.background/applicationtrigger_requestasync_1234533424.md index 6cd0789a75..1a62d6862a 100644 --- a/windows.applicationmodel.background/applicationtrigger_requestasync_1234533424.md +++ b/windows.applicationmodel.background/applicationtrigger_requestasync_1234533424.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync --api-type: winrt method ---- # Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync ## -description This method attempts to set the trigger and start the registered background task. ## -returns Returns an [ApplicationTriggerResult](applicationtriggerresult.md) enumeration that indicates whether the user provided the necessary consent for the operation or the system policies didn't reject the request to trigger a background task. ## -remarks ## -examples ## -see-also [RequestAsync(ValueSet)](applicationtrigger_requestasync_1089362155.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ApplicationTrigger.RequestAsync + +## -description +This method attempts to set the trigger and start the registered background task. + +## -returns +Returns an [ApplicationTriggerResult](applicationtriggerresult.md) enumeration that indicates whether the user provided the necessary consent for the operation or the system policies didn't reject the request to trigger a background task. + +## -remarks + +## -examples + +## -see-also +[RequestAsync(ValueSet)](applicationtrigger_requestasync_1089362155.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/applicationtriggerdetails.md b/windows.applicationmodel.background/applicationtriggerdetails.md index 524aa9528e..0e85233005 100644 --- a/windows.applicationmodel.background/applicationtriggerdetails.md +++ b/windows.applicationmodel.background/applicationtriggerdetails.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ApplicationTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Background.ApplicationTriggerDetails ## -description The details of an [ApplicationTrigger](applicationtrigger.md). ## -remarks An instance of this class is passed to the background task in its [Run](ibackgroundtask_run.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ApplicationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ApplicationTriggerDetails + +## -description +The details of an [ApplicationTrigger](applicationtrigger.md). + +## -remarks + +An instance of this class is passed to the background task in its [Run](ibackgroundtask_run.md) method. + +## -examples + +## -see-also + diff --git a/windows.applicationmodel.background/applicationtriggerdetails_arguments.md b/windows.applicationmodel.background/applicationtriggerdetails_arguments.md index c0950f6bb9..b9a7a3b300 100644 --- a/windows.applicationmodel.background/applicationtriggerdetails_arguments.md +++ b/windows.applicationmodel.background/applicationtriggerdetails_arguments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.ApplicationTriggerDetails.Arguments --api-type: winrt property ---- # Windows.ApplicationModel.Background.ApplicationTriggerDetails.Arguments ## -description The arguments that were passed to the background task using the [ApplicationTrigger.RequestAsync(ValueSet)](applicationtrigger_requestasync_1089362155.md) method. ## -property-value The serialized arguments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ApplicationTriggerDetails.Arguments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ApplicationTriggerDetails.Arguments + +## -description +The arguments that were passed to the background task using the [ApplicationTrigger.RequestAsync(ValueSet)](applicationtrigger_requestasync_1089362155.md) method. + +## -property-value +The serialized arguments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/appointmentstorenotificationtrigger.md b/windows.applicationmodel.background/appointmentstorenotificationtrigger.md index 29797140ec..5fe156e3ab 100644 --- a/windows.applicationmodel.background/appointmentstorenotificationtrigger.md +++ b/windows.applicationmodel.background/appointmentstorenotificationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger ## -description Represents a trigger that launches a background task for processing changes to the appointment store. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger + +## -description +Represents a trigger that launches a background task for processing changes to the appointment store. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/appointmentstorenotificationtrigger_appointmentstorenotificationtrigger_1221375020.md b/windows.applicationmodel.background/appointmentstorenotificationtrigger_appointmentstorenotificationtrigger_1221375020.md index 9b6252f862..887684fea4 100644 --- a/windows.applicationmodel.background/appointmentstorenotificationtrigger_appointmentstorenotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/appointmentstorenotificationtrigger_appointmentstorenotificationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger.AppointmentStoreNotificationTrigger ## -description Initializes a new instance of the [AppointmentStoreNotificationTrigger](appointmentstorenotificationtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.AppointmentStoreNotificationTrigger.AppointmentStoreNotificationTrigger + +## -description +Initializes a new instance of the [AppointmentStoreNotificationTrigger](appointmentstorenotificationtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_125212976.md b/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_125212976.md index 9412ff70c5..c203f3fdbe 100644 --- a/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_125212976.md +++ b/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_125212976.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus ## -description Gets the app's background task execution capability. ## -returns An enumeration value that specifies the app's background capabilities. ## -remarks ## -examples ## -see-also [GetAccessStatus(String)](backgroundexecutionmanager_getaccessstatus_1593270288.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus + +## -description +Gets the app's background task execution capability. + +## -returns +An enumeration value that specifies the app's background capabilities. + +## -remarks + +## -examples + +## -see-also +[GetAccessStatus(String)](backgroundexecutionmanager_getaccessstatus_1593270288.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_1593270288.md b/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_1593270288.md index 97bf9ff5ee..8d342cbd4f 100644 --- a/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_1593270288.md +++ b/windows.applicationmodel.background/backgroundexecutionmanager_getaccessstatus_1593270288.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus ## -description Gets the specified app's background task execution capability. ## -parameters ### -param applicationId The Package Relative Application ID (PRAID) of the app whose capabilities are being retrieved. The specified app must be in the same package as the calling app. ## -returns An enumeration value that specifies the app's background capabilities. ## -remarks ## -examples ## -see-also [GetAccessStatus](backgroundexecutionmanager_getaccessstatus_125212976.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundExecutionManager.GetAccessStatus + +## -description +Gets the specified app's background task execution capability. + +## -parameters +### -param applicationId +The Package Relative Application ID (PRAID) of the app whose capabilities are being retrieved. The specified app must be in the same package as the calling app. + +## -returns +An enumeration value that specifies the app's background capabilities. + +## -remarks + +## -examples + +## -see-also +[GetAccessStatus](backgroundexecutionmanager_getaccessstatus_125212976.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_1873661382.md b/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_1873661382.md index 4e0481719d..0944183718 100644 --- a/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_1873661382.md +++ b/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_1873661382.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess ## -description Removes the calling app from the list of apps that may run background tasks. ## -remarks ## -examples ## -see-also [RemoveAccess(String)](backgroundexecutionmanager_removeaccess_908866790.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess + +## -description +Removes the calling app from the list of apps that may run background tasks. + +## -remarks + +## -examples + +## -see-also +[RemoveAccess(String)](backgroundexecutionmanager_removeaccess_908866790.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_908866790.md b/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_908866790.md index 0ed5c926a2..442f998bd9 100644 --- a/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_908866790.md +++ b/windows.applicationmodel.background/backgroundexecutionmanager_removeaccess_908866790.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess ## -description Removes a specific app from the list of apps that may run background tasks. ## -parameters ### -param applicationId The Package Relative Application ID (PRAID) of the app to be removed from the list of apps that may run background tasks. The specified app must be in the same package as the calling app. ## -remarks ## -examples ## -see-also [RemoveAccess](backgroundexecutionmanager_removeaccess_1873661382.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundExecutionManager.RemoveAccess + +## -description +Removes a specific app from the list of apps that may run background tasks. + +## -parameters +### -param applicationId +The Package Relative Application ID (PRAID) of the app to be removed from the list of apps that may run background tasks. The specified app must be in the same package as the calling app. + +## -remarks + +## -examples + +## -see-also +[RemoveAccess](backgroundexecutionmanager_removeaccess_1873661382.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_1328635663.md b/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_1328635663.md index c5e43e5dc2..5eeae9a522 100644 --- a/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_1328635663.md +++ b/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_1328635663.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync ## -description Requests that the app be permitted to run background tasks. ## -parameters ### -param applicationId The Package Relative Application ID (PRAID) of the app to be permitted to run background tasks. The specified app must be in the same package as the calling app. ## -returns When the operation completes, it returns a member of the [BackgroundAccessStatus](backgroundaccessstatus.md) enumeration that specifies the outcome. ## -remarks
VersionBehavior
Windows 8/Windows 8.1Prompts the user with a dialog box that requests that an app be added to the lock screen. Must be called before registering any background tasks.
Windows Phone 8.1Does not prompt the user, but must be called before registering any background tasks.
Windows 10Does not prompt the user, but must be called before registering any background tasks. You do not need to add the app to the lock screen in order to use background tasks in Windows 10, but you still need to call [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync.md) to request background access.
> [!TIP] > Starting with Windows 10, it is no longer necessary to call this method from the UI thread. ## -examples ## -see-also [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync_380675631.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync + +## -description +Requests that the app be permitted to run background tasks. + +## -parameters +### -param applicationId +The Package Relative Application ID (PRAID) of the app to be permitted to run background tasks. The specified app must be in the same package as the calling app. + +## -returns +When the operation completes, it returns a member of the [BackgroundAccessStatus](backgroundaccessstatus.md) enumeration that specifies the outcome. + +## -remarks + + + + + +
VersionBehavior
Windows 8/Windows 8.1Prompts the user with a dialog box that requests that an app be added to the lock screen. Must be called before registering any background tasks.
Windows Phone 8.1Does not prompt the user, but must be called before registering any background tasks.
Windows 10Does not prompt the user, but must be called before registering any background tasks. You do not need to add the app to the lock screen in order to use background tasks in Windows 10, but you still need to call [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync.md) to request background access.
+ + + +> [!TIP] +> Starting with Windows 10, it is no longer necessary to call this method from the UI thread. + +## -examples + +## -see-also +[RequestAccessAsync](backgroundexecutionmanager_requestaccessasync_380675631.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_380675631.md b/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_380675631.md index a794ab684f..2f98162670 100644 --- a/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_380675631.md +++ b/windows.applicationmodel.background/backgroundexecutionmanager_requestaccessasync_380675631.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync ## -description Requests that the app be permitted to run background tasks. ## -returns When the operation completes, it returns a member of the [BackgroundAccessStatus](backgroundaccessstatus.md) enumeration that specifies the outcome. ## -remarks
VersionBehavior
Windows 8/Windows 8.1Prompts the user with a dialog box that requests that an app be added to the lock screen. Must be called before registering any background tasks.
Windows Phone 8.1Does not prompt the user, but must be called before registering any background tasks.
Windows 10Does not prompt the user, but must be called before registering any background tasks. You do not need to add the app to the lock screen in order to use background tasks in Windows 10, but you still need to call [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync.md) to request background access.
> [!TIP] > Starting with Windows 10, it is no longer necessary to call this method from the UI thread. ## -examples ## -see-also [RequestAccessAsync(String)](backgroundexecutionmanager_requestaccessasync_1328635663.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundExecutionManager.RequestAccessAsync + +## -description +Requests that the app be permitted to run background tasks. + +## -returns +When the operation completes, it returns a member of the [BackgroundAccessStatus](backgroundaccessstatus.md) enumeration that specifies the outcome. + +## -remarks + + + + + +
VersionBehavior
Windows 8/Windows 8.1Prompts the user with a dialog box that requests that an app be added to the lock screen. Must be called before registering any background tasks.
Windows Phone 8.1Does not prompt the user, but must be called before registering any background tasks.
Windows 10Does not prompt the user, but must be called before registering any background tasks. You do not need to add the app to the lock screen in order to use background tasks in Windows 10, but you still need to call [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync.md) to request background access.
+ + + +> [!TIP] +> Starting with Windows 10, it is no longer necessary to call this method from the UI thread. + +## -examples + +## -see-also +[RequestAccessAsync(String)](backgroundexecutionmanager_requestaccessasync_1328635663.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_addcondition_1258521593.md b/windows.applicationmodel.background/backgroundtaskbuilder_addcondition_1258521593.md index a7ec56c773..ee0262f13a 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_addcondition_1258521593.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_addcondition_1258521593.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.AddCondition(Windows.ApplicationModel.Background.IBackgroundCondition) --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.AddCondition ## -description Adds a condition to a background task. ## -parameters ### -param condition An instance of a [SystemCondition](systemcondition.md) object. ## -remarks [AddCondition](backgroundtaskbuilder_addcondition.md) can be called more than once to specify more than one condition for a background task. All specified conditions must be met before the system will schedule the task. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.AddCondition(Windows.ApplicationModel.Background.IBackgroundCondition) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.AddCondition + +## -description +Adds a condition to a background task. + +## -parameters +### -param condition +An instance of a [SystemCondition](systemcondition.md) object. + +## -remarks +[AddCondition](backgroundtaskbuilder_addcondition.md) can be called more than once to specify more than one condition for a background task. All specified conditions must be met before the system will schedule the task. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_backgroundtaskbuilder_1221375020.md b/windows.applicationmodel.background/backgroundtaskbuilder_backgroundtaskbuilder_1221375020.md index 103bd0b02f..110c3f8817 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_backgroundtaskbuilder_1221375020.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_backgroundtaskbuilder_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.BackgroundTaskBuilder ## -description Creates an instance of the [BackgroundTaskBuilder](backgroundtaskbuilder.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.BackgroundTaskBuilder + +## -description +Creates an instance of the [BackgroundTaskBuilder](backgroundtaskbuilder.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_cancelonconditionloss.md b/windows.applicationmodel.background/backgroundtaskbuilder_cancelonconditionloss.md index b039906e93..0adf206bfa 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_cancelonconditionloss.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_cancelonconditionloss.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.CancelOnConditionLoss --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.CancelOnConditionLoss ## -description Indicates whether the background task will be canceled if at least one of its required conditions is no longer met. ## -property-value Whether or not the background task will be canceled if at least one of its required conditions is no longer met. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.CancelOnConditionLoss +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.CancelOnConditionLoss + +## -description +Indicates whether the background task will be canceled if at least one of its required conditions is no longer met. + +## -property-value +Whether or not the background task will be canceled if at least one of its required conditions is no longer met. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_isnetworkrequested.md b/windows.applicationmodel.background/backgroundtaskbuilder_isnetworkrequested.md index c1403de1b2..8b92eaff31 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_isnetworkrequested.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_isnetworkrequested.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.IsNetworkRequested --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.IsNetworkRequested ## -description Indicates whether the background task requires network connectivity in order to run. [SocketActivityTrigger](socketactivitytrigger.md) and [ControlChannelTrigger](../windows.networking.sockets/controlchanneltrigger.md) are designed for apps that maintain long-lived network connections, even when they run in the background. Apps requiring short-lived network interactions as part of their background task’s logic (for example, sending out one HTTP request) may call directly into the core networking APIs ( [HttpClient](../windows.web.http/httpclient.md), [StreamSocket](../windows.networking.sockets/streamsocket.md), [DatagramSocket](../windows.networking.sockets/datagramsocket.md), etc.) as long as they use the **InternetAvailable** condition with their background task or use the **IsNetworkRequested** flag on their background task registration. This tells the Background Tasks infrastructure to keep the network up while the task is executing, even if the device has entered Connected Standby mode. If your background task does not use **InternetAvailable** or **IsNetworkRequested** as described here, then your background task will not be able to access the network when in Connected Standby mode (for example, when a phone's screen is turned off.) ## -property-value A value indicating whether network connectivity is requested. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.IsNetworkRequested +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.IsNetworkRequested + +## -description +Indicates whether the background task requires network connectivity in order to run. + +[SocketActivityTrigger](socketactivitytrigger.md) and [ControlChannelTrigger](../windows.networking.sockets/controlchanneltrigger.md) are designed for apps that maintain long-lived network connections, even when they run in the background. Apps requiring short-lived network interactions as part of their background task’s logic (for example, sending out one HTTP request) may call directly into the core networking APIs ( [HttpClient](../windows.web.http/httpclient.md), [StreamSocket](../windows.networking.sockets/streamsocket.md), [DatagramSocket](../windows.networking.sockets/datagramsocket.md), etc.) as long as they use the **InternetAvailable** condition with their background task or use the **IsNetworkRequested** flag on their background task registration. This tells the Background Tasks infrastructure to keep the network up while the task is executing, even if the device has entered Connected Standby mode. + +If your background task does not use **InternetAvailable** or **IsNetworkRequested** as described here, then your background task will not be able to access the network when in Connected Standby mode (for example, when a phone's screen is turned off.) + +## -property-value +A value indicating whether network connectivity is requested. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_name.md b/windows.applicationmodel.background/backgroundtaskbuilder_name.md index 38086df79b..b009b90f2f 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_name.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.Name --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.Name ## -description Gets or sets the name of a background task. ## -property-value A description of the background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.Name + +## -description +Gets or sets the name of a background task. + +## -property-value +A description of the background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md b/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md index 2bc890cb11..14df5e30cf 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.Register --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.Register ## -description Registers a background task with the system. ## -returns An instance of a [BackgroundTaskRegistration](backgroundtaskregistration.md) object. ## -remarks The task must have an event trigger and a task entry point for the [Register](backgroundtaskbuilder_register.md) method to succeed. The system schedules the background task when its trigger event occurs and all of its conditions have been met. ### Background task parameter validatio n > **Windows 8** > Windows 8 does not validate the parameters set on the [BackgroundTaskBuilder](backgroundtaskbuilder.md) object until the system tries to run the background task. If the parameters aren't valid, the background task can't start and an event log entry is created. > **Windows 8.1** > Starting in Windows 8.1, the parameters used to register the background task are validated at the time of registration. An error is returned if the background task registration fails, allowing the app to determine whether or not the background task is valid. For C# and Visual Basic, task registration errors typically result in specific .NET exceptions being thrown. These exceptions are thrown as first-chance exceptions and should be corrected while you're still developing your code.Existing Windows 8 apps running on Windows 8.1 are subject to this new system behavior, which can cause the app to crash if it can't handle a failed background task registration. (An event log entry will still be generated for the failed background task registration.) As a result, Windows 8 apps that register invalid background tasks should be rewritten to register background tasks correctly and to handle failed background task registration as a caught exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.Register +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.Register + +## -description +Registers a background task with the system. + +## -returns +An instance of a [BackgroundTaskRegistration](backgroundtaskregistration.md) object. + +## -remarks +The task must have an event trigger and a task entry point for the [Register](backgroundtaskbuilder_register.md) method to succeed. The system schedules the background task when its trigger event occurs and all of its conditions have been met. + +### Background task parameter validatio +n + + +> **Windows 8** +> Windows 8 does not validate the parameters set on the [BackgroundTaskBuilder](backgroundtaskbuilder.md) object until the system tries to run the background task. If the parameters aren't valid, the background task can't start and an event log entry is created. + +> **Windows 8.1** +> Starting in Windows 8.1, the parameters used to register the background task are validated at the time of registration. An error is returned if the background task registration fails, allowing the app to determine whether or not the background task is valid. For C# and Visual Basic, task registration errors typically result in specific .NET exceptions being thrown. These exceptions are thrown as first-chance exceptions and should be corrected while you're still developing your code.Existing Windows 8 apps running on Windows 8.1 are subject to this new system behavior, which can cause the app to crash if it can't handle a failed background task registration. (An event log entry will still be generated for the failed background task registration.) As a result, Windows 8 apps that register invalid background tasks should be rewritten to register background tasks correctly and to handle failed background task registration as a caught exception. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_settrigger_2125876510.md b/windows.applicationmodel.background/backgroundtaskbuilder_settrigger_2125876510.md index 766be561ec..4bb36e576a 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_settrigger_2125876510.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_settrigger_2125876510.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.SetTrigger(Windows.ApplicationModel.Background.IBackgroundTrigger) --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.SetTrigger ## -description Sets the event trigger for a background task. ## -parameters ### -param trigger An instance of an event trigger object such as a [SystemTrigger](systemtrigger.md), [TimeTrigger](timetrigger.md), or [NetworkOperatorNotificationTrigger](networkoperatornotificationtrigger.md). ## -remarks In addition to specifying the type of event trigger for a background task, an application must also enable background tasks that use the event trigger type in the `` section of its manifest. Valid types include the following: + `` + `` + `` + `` + `` If the background task type is not specified or specified incorrectly in the manifest, calls that attempt to use that kind of background task will fail. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskBuilder.SetTrigger(Windows.ApplicationModel.Background.IBackgroundTrigger) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.SetTrigger + +## -description +Sets the event trigger for a background task. + +## -parameters +### -param trigger +An instance of an event trigger object such as a [SystemTrigger](systemtrigger.md), [TimeTrigger](timetrigger.md), or [NetworkOperatorNotificationTrigger](networkoperatornotificationtrigger.md). + +## -remarks +In addition to specifying the type of event trigger for a background task, an application must also enable background tasks that use the event trigger type in the `` section of its manifest. Valid types include the following: ++ `` ++ `` ++ `` ++ `` ++ `` + + +If the background task type is not specified or specified incorrectly in the manifest, calls that attempt to use that kind of background task will fail. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md b/windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md index 29e8554aff..f5d121120c 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskEntryPoint --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskEntryPoint ## -description Gets or sets the class that performs the work of a background task. ## -property-value The name of an application-defined class that performs the work of a background task. ## -remarks > **Windows Store app using C++, C#, or Visual Basic** > The task entry point class must implement the [IBackgroundTask](ibackgroundtask.md) interface. The system calls [IBackgroundTask::Run ](ibackgroundtask_run.md) when the background task is triggered. In addition, the class must be specified in the `` section of the application's manifest as ``.The task entry point class can be implemented in the same process as the application's foreground component (in-proc); however, it cannot run on any of the application's foreground threads because the application might be suspended when the background task is triggered. For best results, implement the class in a separate process (out-of-proc) to decouple it from the application's foreground components and allow the system to manage the application's processes more efficiently. > **Windows Store app using JavaScript** > The entry point for a JavaScript background task is a JavaScript start page. See [WebUIBackgroundTaskInstance.current](../windows.ui.webui/webuibackgroundtaskinstance_current.md) for more information.Note that JavaScript background tasks must call [close()](XREF:TODO:ie10devguide.web_workers) to terminate when they are done, so they don't continue to consume the user's memory and battery. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskEntryPoint +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskEntryPoint + +## -description +Gets or sets the class that performs the work of a background task. + +## -property-value +The name of an application-defined class that performs the work of a background task. + +## -remarks +> **Windows Store app using C++, C#, or Visual Basic** +> The task entry point class must implement the [IBackgroundTask](ibackgroundtask.md) interface. The system calls [IBackgroundTask::Run ](ibackgroundtask_run.md) when the background task is triggered. In addition, the class must be specified in the `` section of the application's manifest as ``.The task entry point class can be implemented in the same process as the application's foreground component (in-proc); however, it cannot run on any of the application's foreground threads because the application might be suspended when the background task is triggered. For best results, implement the class in a separate process (out-of-proc) to decouple it from the application's foreground components and allow the system to manage the application's processes more efficiently. + +> **Windows Store app using JavaScript** +> The entry point for a JavaScript background task is a JavaScript start page. See [WebUIBackgroundTaskInstance.current](../windows.ui.webui/webuibackgroundtaskinstance_current.md) for more information.Note that JavaScript background tasks must call [close()](XREF:TODO:ie10devguide.web_workers) to terminate when they are done, so they don't continue to consume the user's memory and battery. + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskcompletedeventargs_checkresult_301563999.md b/windows.applicationmodel.background/backgroundtaskcompletedeventargs_checkresult_301563999.md index 395b6f8fda..d9f84e27b1 100644 --- a/windows.applicationmodel.background/backgroundtaskcompletedeventargs_checkresult_301563999.md +++ b/windows.applicationmodel.background/backgroundtaskcompletedeventargs_checkresult_301563999.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.CheckResult --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.CheckResult ## -description Throws an exception if the background task completed event has reported an error. ## -remarks This method should be called from within a **try** block. If the background task completed event reported an error, it will be caught as an exception in the subsequent **catch** clause. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.CheckResult +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.CheckResult + +## -description +Throws an exception if the background task completed event has reported an error. + +## -remarks +This method should be called from within a **try** block. If the background task completed event reported an error, it will be caught as an exception in the subsequent **catch** clause. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskcompletedeventargs_instanceid.md b/windows.applicationmodel.background/backgroundtaskcompletedeventargs_instanceid.md index 2c0923ea9d..f605aad12a 100644 --- a/windows.applicationmodel.background/backgroundtaskcompletedeventargs_instanceid.md +++ b/windows.applicationmodel.background/backgroundtaskcompletedeventargs_instanceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.InstanceId --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.InstanceId ## -description Gets the identifier of the background task instance for this completion status notification. ## -property-value A unique identifier generated by the system when it creates the background task instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.InstanceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs.InstanceId + +## -description +Gets the identifier of the background task instance for this completion status notification. + +## -property-value +A unique identifier generated by the system when it creates the background task instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskdeferral_complete_1807836922.md b/windows.applicationmodel.background/backgroundtaskdeferral_complete_1807836922.md index 361f4db255..31f9c18adb 100644 --- a/windows.applicationmodel.background/backgroundtaskdeferral_complete_1807836922.md +++ b/windows.applicationmodel.background/backgroundtaskdeferral_complete_1807836922.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskDeferral.Complete ## -description Informs the system that an asynchronous operation associated with a background task has finished. ## -remarks If a background task uses an asynchronous operation, it is possible for the [Run](ibackgroundtask_run.md) method to return before the background task has completed its work. As soon as the [Run](ibackgroundtask_run.md) method returns, the system might suspend or terminate the background task host process, which could prevent completion of asynchronous operations started by the background task. To keep the host process from being suspended or terminated while the background task is running, use the [GetDeferral](ibackgroundtaskinstance_getdeferral.md) method to get a background task deferral for each asynchronous operation initiated. Then, when the asynchronous operation is finished, call the [BackgroundTaskDeferral.Complete](backgroundtaskdeferral_complete.md) method. Ensure that you complete all background task deferrals. Most background tasks have a timeout after which the app will be suspended or terminated regardless of whether there are any pending deferrals. However, leaving outstanding background task deferrals interferes with the system's ability to manage process lifetimes in a timely way. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskDeferral.Complete + +## -description +Informs the system that an asynchronous operation associated with a background task has finished. + +## -remarks +If a background task uses an asynchronous operation, it is possible for the [Run](ibackgroundtask_run.md) method to return before the background task has completed its work. As soon as the [Run](ibackgroundtask_run.md) method returns, the system might suspend or terminate the background task host process, which could prevent completion of asynchronous operations started by the background task. + +To keep the host process from being suspended or terminated while the background task is running, use the [GetDeferral](ibackgroundtaskinstance_getdeferral.md) method to get a background task deferral for each asynchronous operation initiated. Then, when the asynchronous operation is finished, call the [BackgroundTaskDeferral.Complete](backgroundtaskdeferral_complete.md) method. + +Ensure that you complete all background task deferrals. Most background tasks have a timeout after which the app will be suspended or terminated regardless of whether there are any pending deferrals. However, leaving outstanding background task deferrals interferes with the system's ability to manage process lifetimes in a timely way. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskprogresseventargs_instanceid.md b/windows.applicationmodel.background/backgroundtaskprogresseventargs_instanceid.md index ad94f60a0c..36e02af336 100644 --- a/windows.applicationmodel.background/backgroundtaskprogresseventargs_instanceid.md +++ b/windows.applicationmodel.background/backgroundtaskprogresseventargs_instanceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.InstanceId --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.InstanceId ## -description Gets the identifier of the background task instance for this progress status notification. ## -property-value A unique identifier generated by the system when it creates the background task instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.InstanceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.InstanceId + +## -description +Gets the identifier of the background task instance for this progress status notification. + +## -property-value +A unique identifier generated by the system when it creates the background task instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskprogresseventargs_progress.md b/windows.applicationmodel.background/backgroundtaskprogresseventargs_progress.md index e965b0f48b..cd9e1ae4f7 100644 --- a/windows.applicationmodel.background/backgroundtaskprogresseventargs_progress.md +++ b/windows.applicationmodel.background/backgroundtaskprogresseventargs_progress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.Progress --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.Progress ## -description Gets progress status for a background task instance. ## -property-value A value defined by the application to indicate the task's progress. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs.Progress + +## -description +Gets progress status for a background task instance. + +## -property-value +A value defined by the application to indicate the task's progress. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md b/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md index a33c0bdc97..e9634cf4e9 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md @@ -1,3 +1,43 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks ## -description Enumerates an application's registered background tasks. ## -property-value A view into a map of registered background tasks consisting of the task ID and an [IBackgroundTaskRegistration](ibackgroundtaskregistration.md) interface. ## -remarks ## -examples The following example shows how to use the [AllTasks](backgroundtaskregistration_alltasks.md) property of the [BackgroundTaskRegistration](backgroundtaskregistration.md) class to retrieve the existing background task registration object for your app's background task (if the task is currently registered). ```csharp // The name of the background task for your app. string name = "ExampleTaskName"; // Get a list of all background tasks. The list is returned as // a dictionary of IBackgroundTaskRegistration objects. foreach (var cur in BackgroundTaskRegistration.AllTasks) { if (cur.Value.Name == name) { // Take some action based on finding the background task. // // For example, unregister the task: cur.Value.Unregister(true); // Or, set a global variable indicating that the task is already registered } } ``` ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks + +## -description +Enumerates an application's registered background tasks. + +## -property-value +A view into a map of registered background tasks consisting of the task ID and an [IBackgroundTaskRegistration](ibackgroundtaskregistration.md) interface. + +## -remarks + +## -examples +The following example shows how to use the [AllTasks](backgroundtaskregistration_alltasks.md) property of the [BackgroundTaskRegistration](backgroundtaskregistration.md) class to retrieve the existing background task registration object for your app's background task (if the task is currently registered). + +```csharp +// The name of the background task for your app. +string name = "ExampleTaskName"; + +// Get a list of all background tasks. The list is returned as +// a dictionary of IBackgroundTaskRegistration objects. +foreach (var cur in BackgroundTaskRegistration.AllTasks) +{ + if (cur.Value.Name == name) + { + // Take some action based on finding the background task. + // + // For example, unregister the task: cur.Value.Unregister(true); + // Or, set a global variable indicating that the task is already registered + } +} +``` + + + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_completed.md b/windows.applicationmodel.background/backgroundtaskregistration_completed.md index c2d42c0a30..a5ab54033b 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_completed.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_completed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Completed --api-type: winrt event ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.Completed ## -description Attaches a completed event handler to the registered background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Completed +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.Completed + +## -description +Attaches a completed event handler to the registered background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_name.md b/windows.applicationmodel.background/backgroundtaskregistration_name.md index 12a2bb4536..0ec301b531 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_name.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Name --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.Name ## -description Gets the name of a registered background task. ## -property-value The description specified with [BackgroundTaskBuilder::Name](backgroundtaskbuilder_name.md) when the task was created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.Name + +## -description +Gets the name of a registered background task. + +## -property-value +The description specified with [BackgroundTaskBuilder::Name](backgroundtaskbuilder_name.md) when the task was created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_progress.md b/windows.applicationmodel.background/backgroundtaskregistration_progress.md index 6362e4a419..604993335d 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_progress.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_progress.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Progress --api-type: winrt event ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.Progress ## -description Attaches a progress event handler to the registered background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Progress +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.Progress + +## -description +Attaches a progress event handler to the registered background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_taskid.md b/windows.applicationmodel.background/backgroundtaskregistration_taskid.md index 1e20669b0f..1673f8715f 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_taskid.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_taskid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.TaskId --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.TaskId ## -description Gets the identifier of a registered background task. ## -property-value The unique identifier for the task. This identifier is generated by the system when the task is registered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.TaskId + +## -description +Gets the identifier of a registered background task. + +## -property-value +The unique identifier for the task. This identifier is generated by the system when the task is registered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_trigger.md b/windows.applicationmodel.background/backgroundtaskregistration_trigger.md index 3f680a33b1..a5e88f8e9a 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_trigger.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_trigger.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Trigger --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.Trigger ## -description This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null. ## -property-value This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Trigger +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.Trigger + +## -description +This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null. + +## -property-value +This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_unregister_1795204141.md b/windows.applicationmodel.background/backgroundtaskregistration_unregister_1795204141.md index 3b2756edac..36e62ee0b7 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_unregister_1795204141.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_unregister_1795204141.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Unregister(System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.BackgroundTaskRegistration.Unregister ## -description Cancels the registration of a registered background task. ## -parameters ### -param cancelTask True if currently running instances of this background task should be canceled. If this parameter is false, currently running instances are allowed to finish. Canceled instances receive a Canceled event with a cancellation reason of **Abort**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskRegistration.Unregister(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.Unregister + +## -description +Cancels the registration of a registered background task. + +## -parameters +### -param cancelTask +True if currently running instances of this background task should be canceled. If this parameter is false, currently running instances are allowed to finish. Canceled instances receive a Canceled event with a cancellation reason of **Abort**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundworkcost_currentbackgroundworkcost.md b/windows.applicationmodel.background/backgroundworkcost_currentbackgroundworkcost.md index 4981aa5ac0..c1059486ce 100644 --- a/windows.applicationmodel.background/backgroundworkcost_currentbackgroundworkcost.md +++ b/windows.applicationmodel.background/backgroundworkcost_currentbackgroundworkcost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BackgroundWorkCost.CurrentBackgroundWorkCost --api-type: winrt property ---- # Windows.ApplicationModel.Background.BackgroundWorkCost.CurrentBackgroundWorkCost ## -description Retrieves a hint about resource availability for background tasks. ## -property-value A hint about background resource availability. A background task can use this hint to decide how much work to do when it is activated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundWorkCost.CurrentBackgroundWorkCost +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundWorkCost.CurrentBackgroundWorkCost + +## -description +Retrieves a hint about resource availability for background tasks. + +## -property-value +A hint about background resource availability. A background task can use this hint to decide how much work to do when it is activated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger.md b/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger.md index 4d5f392dbc..aa163407ed 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger.md @@ -1,3 +1,66 @@ ---- -api-id: T:Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger ## -description Represents a trigger that is registered to advertise a Bluetooth LE advertisement in the background. ## -remarks A background task is launched when the status of the background publisher changes. This trigger works similarly to the BluetoothAdvertisementPublisher class with the exception that it has more restrictions as it allows the app to maintain advertising in the background. Once registered, the background publisher is serviced in a best effort manner. A background task will be launched to notify the App on the status of the publisher. Right after registration, the status is expected to be either Started or Waiting (if the trigger cannot be serviced at the moment). The app is also notified of failures or interruption of the background publisher through the trigger details provided in the background task context. To stop advertising, the background task associated with this trigger must be unregistered. The local advertisement resource is limited at the protocol layer. Usage of this resource is best suited for controlled scenarios such as enterprise use cases. Other apps may compete for this limited resource and regular broadcast of advertisements for any specific use case cannot be guaranteed. The following advertisement types are allowed: + Manufacturer Specific Information (0xFF) + Any non-standard type not reserved by the system, as shown in the list below. For more information on non-standard types, see [this page](https://www.bluetooth.org/specification/assigned-numbers/generic-access-profile) from the Bluetooth specification. The following advertisement types are system-reserved and are not allowed: + Flags (0x01) + Incomplete List of 16-bit Service UUIDs (0x02) + Complete List of 16-bit Service UUIDs (0x03) + Incomplete List of 32-bit Service UUIDs (0x04) + Complete List of 32-bit Service UUIDs (0x05) + Incomplete List of 128-bit Service UUIDs (0x06) + Complete List of 128-bit Service UUIDs (0x07) + Shortened Local Name (0x08) + Complete Local Name (0x09) + Tx Power Level (0x0A) + Class of Device (0x0D) + Simple Pairing Hash C192 (0x0E) + Simple Pairing Randomizer R192 (0x0F) + Security Manager TK Values (0x10) + Security Manager Out-of-Band Flags (0x11) + Slave Connection Interval Range (0x12) + List of 16-bit Service Solicitation UUIDs (0x14) + List of 32-bit Service Solicitation UUIDs (0x1F) + List of 128-bit Service Solicitation UUIDs (0x15) + Service Data 16-bit UUID (0x16) + Service Data 32-bit UUID (0x20) + Service Data 128-bit UUID (0x21) + Public Target Address (0x17) + Random Target Address (0x18) + Appearance (0x19) + Advertising Interval (0x1A) + LE Bluetooth Device Address (0x1B) + LE Role (0x1C) + Simple Pairing Hash C256 (0x1D) + Simple Pairing Randomizer R256 (0x1E) + 3D Information Data (0x3D) ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger + +## -description +Represents a trigger that is registered to advertise a Bluetooth LE advertisement in the background. + +## -remarks +A background task is launched when the status of the background publisher changes. + +This trigger works similarly to the BluetoothAdvertisementPublisher class with the exception that it has more restrictions as it allows the app to maintain advertising in the background. Once registered, the background publisher is serviced in a best effort manner. A background task will be launched to notify the App on the status of the publisher. Right after registration, the status is expected to be either Started or Waiting (if the trigger cannot be serviced at the moment). The app is also notified of failures or interruption of the background publisher through the trigger details provided in the background task context. To stop advertising, the background task associated with this trigger must be unregistered. + +The local advertisement resource is limited at the protocol layer. Usage of this resource is best suited for controlled scenarios such as enterprise use cases. Other apps may compete for this limited resource and regular broadcast of advertisements for any specific use case cannot be guaranteed. + + +The following advertisement types are allowed: + ++ Manufacturer Specific Information (0xFF) ++ Any non-standard type not reserved by the system, as shown in the list below. For more information on non-standard types, see [this page](https://www.bluetooth.org/specification/assigned-numbers/generic-access-profile) from the Bluetooth specification. + +The following advertisement types are system-reserved and are not allowed: + ++ Flags (0x01) ++ Incomplete List of 16-bit Service UUIDs (0x02) ++ Complete List of 16-bit Service UUIDs (0x03) ++ Incomplete List of 32-bit Service UUIDs (0x04) ++ Complete List of 32-bit Service UUIDs (0x05) ++ Incomplete List of 128-bit Service UUIDs (0x06) ++ Complete List of 128-bit Service UUIDs (0x07) ++ Shortened Local Name (0x08) ++ Complete Local Name (0x09) ++ Tx Power Level (0x0A) ++ Class of Device (0x0D) ++ Simple Pairing Hash C192 (0x0E) ++ Simple Pairing Randomizer R192 (0x0F) ++ Security Manager TK Values (0x10) ++ Security Manager Out-of-Band Flags (0x11) ++ Slave Connection Interval Range (0x12) ++ List of 16-bit Service Solicitation UUIDs (0x14) ++ List of 32-bit Service Solicitation UUIDs (0x1F) ++ List of 128-bit Service Solicitation UUIDs (0x15) ++ Service Data 16-bit UUID (0x16) ++ Service Data 32-bit UUID (0x20) ++ Service Data 128-bit UUID (0x21) ++ Public Target Address (0x17) ++ Random Target Address (0x18) ++ Appearance (0x19) ++ Advertising Interval (0x1A) ++ LE Bluetooth Device Address (0x1B) ++ LE Role (0x1C) ++ Simple Pairing Hash C256 (0x1D) ++ Simple Pairing Randomizer R256 (0x1E) ++ 3D Information Data (0x3D) + + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_advertisement.md b/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_advertisement.md index 6a7f188e35..efe6b6bb11 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_advertisement.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_advertisement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.Advertisement --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.Advertisement ## -description Gets the Bluetooth LE advertisement to configure and publish in the background. ## -property-value The Bluetooth LE advertisement to configure and publish in the background. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.Advertisement +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.Advertisement + +## -description +Gets the Bluetooth LE advertisement to configure and publish in the background. + +## -property-value +The Bluetooth LE advertisement to configure and publish in the background. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_bluetoothleadvertisementpublishertrigger_1221375020.md b/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_bluetoothleadvertisementpublishertrigger_1221375020.md index 6c1cba83cb..bac52442d0 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_bluetoothleadvertisementpublishertrigger_1221375020.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementpublishertrigger_bluetoothleadvertisementpublishertrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.BluetoothLEAdvertisementPublisherTrigger ## -description Creates a new instance of the [BluetoothLEAdvertisementPublisherTrigger](bluetoothleadvertisementpublishertrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementPublisherTrigger.BluetoothLEAdvertisementPublisherTrigger + +## -description +Creates a new instance of the [BluetoothLEAdvertisementPublisherTrigger](bluetoothleadvertisementpublishertrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger.md index a89cb62f8f..06bf58f50d 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger.md @@ -1,3 +1,41 @@ ---- -api-id: T:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger ## -description Represents a trigger that is registered to scan for Bluetooth LE advertisement in the background. ## -remarks A background task is launched when an advertisement is received. This trigger works similarly to the [BluetoothAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md) class, with the exception that it has more restrictions as it allows the app to receive advertisements in the background. Notably, exactly a single filter pattern is accepted in the background (not more, not less). Once registered, the background watcher is serviced in a best effort manner. A background task will be launched to notify the app when an advertisement matching the filter configured through trigger is received. The app is also notified of failures or interruption of the background watcher through the trigger details provided in the background task context. To stop receiving the advertisements, the background task associated with this trigger must be unregistered. The following advertisement types are not allowed to be filtered for in the background due to their generic nature + Flags (0x01) + Class of Device (0x0D) + Security Manager Out-of-Band Flags (0x11) + Appearance (0x19) + LE Role (0x1C) A background filter for a raw section of type manufacturer specific data (0xFF) that only matches for the second byte of the section with 0x00 will be rejected, as it corresponds to the most significant byte of the company identifier field. All SIG-assigned company identifiers currently have this byte set to 0x00 and performing a partial match with only a single byte can potentially result in an excess of received advertisements when in presence of multiple advertisers. This could significantly impact the battery life of the system. Use of a [BluetoothLEAdvertisementWatcherTrigger](bluetoothleadvertisementwatchertrigger.md) is limited by the hardware offload resources available. New Windows devices with [HCI Extensions](XREF:TODO:bltooth.bluetooth_microsoft-defined_hci_extensions) support in the local Bluetooth radio provide lower power advertisement scanning, improving battery life for long term scenarios such as beacons. The amount of hardware resources available is dependent on the radio and current system-wide usage, and attempts to register for this trigger will return [BluetoothError.ResourceInUse](../windows.devices.bluetooth/bluetootherror.md) when no more resources are available. Apps should use these resources sparingly to provide a focused, power efficient scenario in watching for the unique advertisement data for only the specific remote advertisers which are needed. While many new Windows devices have HCI Extensions support, some may not, especially in cases of upgrades on older devices from older Windows versions. In these cases, Windows will emulate the hardware filtering in software, providing a maximum of 20 trigger conditions per device, across all apps on the system. When using this software emulation, attempts to register for trigger resources once the maximum has been reached will cause an exception to be thrown, with error **ERROR_NO_SYSTEM_RESOURCES (0x800705AA)**. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger + +## -description +Represents a trigger that is registered to scan for Bluetooth LE advertisement in the background. + +## -remarks +A background task is launched when an advertisement is received. + +This trigger works similarly to the [BluetoothAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md) class, with the exception that it has more restrictions as it allows the app to receive advertisements in the background. Notably, exactly a single filter pattern is accepted in the background (not more, not less). + +Once registered, the background watcher is serviced in a best effort manner. A background task will be launched to notify the app when an advertisement matching the filter configured through trigger is received. The app is also notified of failures or interruption of the background watcher through the trigger details provided in the background task context. To stop receiving the advertisements, the background task associated with this trigger must be unregistered. + + +The following advertisement types are not allowed to be filtered for in the background due to their generic nature + ++ Flags (0x01) ++ Class of Device (0x0D) ++ Security Manager Out-of-Band Flags (0x11) ++ Appearance (0x19) ++ LE Role (0x1C) + + +A background filter for a raw section of type manufacturer specific data (0xFF) that only matches for the second byte of the section with 0x00 will be rejected, as it corresponds to the most significant byte of the company identifier field. All SIG-assigned company identifiers currently have this byte set to 0x00 and performing a partial match with only a single byte can potentially result in an excess of received advertisements when in presence of multiple advertisers. This could significantly impact the battery life of the system. + +Use of a [BluetoothLEAdvertisementWatcherTrigger](bluetoothleadvertisementwatchertrigger.md) is limited by the hardware offload resources available. New Windows devices with [HCI Extensions](XREF:TODO:bltooth.bluetooth_microsoft-defined_hci_extensions) support in the local Bluetooth radio provide lower power advertisement scanning, improving battery life for long term scenarios such as beacons. The amount of hardware resources available is dependent on the radio and current system-wide usage, and attempts to register for this trigger will return [BluetoothError.ResourceInUse](../windows.devices.bluetooth/bluetootherror.md) when no more resources are available. Apps should use these resources sparingly to provide a focused, power efficient scenario in watching for the unique advertisement data for only the specific remote advertisers which are needed. + +While many new Windows devices have HCI Extensions support, some may not, especially in cases of upgrades on older devices from older Windows versions. In these cases, Windows will emulate the hardware filtering in software, providing a maximum of 20 trigger conditions per device, across all apps on the system. When using this software emulation, attempts to register for trigger resources once the maximum has been reached will cause an exception to be thrown, with error **ERROR_NO_SYSTEM_RESOURCES (0x800705AA)**. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_advertisementfilter.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_advertisementfilter.md index cc48d3b2da..ef58641103 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_advertisementfilter.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_advertisementfilter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.AdvertisementFilter --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.AdvertisementFilter ## -description Gets or sets the configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. ## -property-value The configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.AdvertisementFilter +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.AdvertisementFilter + +## -description +Gets or sets the configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. + +## -property-value +The configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_bluetoothleadvertisementwatchertrigger_1221375020.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_bluetoothleadvertisementwatchertrigger_1221375020.md index a3f5db1d4d..5d40ef6dae 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_bluetoothleadvertisementwatchertrigger_1221375020.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_bluetoothleadvertisementwatchertrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.BluetoothLEAdvertisementWatcherTrigger ## -description Creates a new instance of the [BluetoothLEAdvertisementWatcherTrigger](bluetoothleadvertisementwatchertrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.BluetoothLEAdvertisementWatcherTrigger + +## -description +Creates a new instance of the [BluetoothLEAdvertisementWatcherTrigger](bluetoothleadvertisementwatchertrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxoutofrangetimeout.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxoutofrangetimeout.md index 5d31ca3b88..698b83838f 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxoutofrangetimeout.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxoutofrangetimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxOutOfRangeTimeout --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxOutOfRangeTimeout ## -description Gets the maximum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. ## -property-value The maximum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxOutOfRangeTimeout +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxOutOfRangeTimeout + +## -description +Gets the maximum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. + +## -property-value +The maximum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxsamplinginterval.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxsamplinginterval.md index ea80dcd05a..fa31b8d06b 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxsamplinginterval.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_maxsamplinginterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxSamplingInterval --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxSamplingInterval ## -description Gets the maximum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. The maximum sampling interval is used to deactivate the sampling filter and only trigger received events based on the device coming in and out of range. ## -property-value The maximum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxSamplingInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MaxSamplingInterval + +## -description +Gets the maximum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. The maximum sampling interval is used to deactivate the sampling filter and only trigger received events based on the device coming in and out of range. + +## -property-value +The maximum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minoutofrangetimeout.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minoutofrangetimeout.md index 9b01e746ce..fe7fb1fb2c 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minoutofrangetimeout.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minoutofrangetimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinOutOfRangeTimeout --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinOutOfRangeTimeout ## -description Gets the minimum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. ## -property-value The minimum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinOutOfRangeTimeout +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinOutOfRangeTimeout + +## -description +Gets the minimum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. + +## -property-value +The minimum out of range timeout supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minsamplinginterval.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minsamplinginterval.md index 0e7eeb0d78..c24e40b743 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minsamplinginterval.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_minsamplinginterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinSamplingInterval --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinSamplingInterval ## -description Gets the minimum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. The minimum sampling interval for the background watcher cannot be zero unlike its foreground counterpart. ## -property-value Gets the minimum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinSamplingInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.MinSamplingInterval + +## -description +Gets the minimum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. The minimum sampling interval for the background watcher cannot be zero unlike its foreground counterpart. + +## -property-value +Gets the minimum sampling interval supported for the [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) property of this trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md index 35f16e98f6..4b81982af0 100644 --- a/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md +++ b/windows.applicationmodel.background/bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.SignalStrengthFilter --api-type: winrt property ---- # Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.SignalStrengthFilter ## -description Gets or sets the configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. ## -property-value The configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. ## -remarks The [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) has additional limitations on its properties when used by the [BluetoothLEAdvertisementWatcherTrigger](bluetoothleadvertisementwatchertrigger.md) class. The trigger will fail to register if it contains parameters outside of the valid range. If the properties are left as `NULL`, a default value is selected. The additional restrictions and default values are as follows: + **InRangeThresholdInDBm**: The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for Bluetooth LE is -127 (default when NULL is -127). + **OutOfRangeThresholdInDBm**: The maximum value for RSSI for Bluetooth LE is +20. The maximim value for RSSI for Bluetooth LE is -127 (default when NULL is -127). + **OutOfRangeTimeout**: Equal or greater than 1 second and less than or equal to 60 seconds (default when NULL is 60 seconds). + **SamplingInterval**: Equal or greater than 1 second. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. For more information about the behavior of the RSSI filtering, refer to [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md). Additional restrictions are in place such that a filter with **OutOfRangeThresholdInDBm** higher than **InRangeThresholdInDBm** will be rejected for example. Some of these limits are obtainable programmatically through the [MinSamplingInterval](bluetoothleadvertisementwatchertrigger_minsamplinginterval.md), [MaxSamplingInterval](bluetoothleadvertisementwatchertrigger_maxsamplinginterval.md), [MinOutOfRangeTimeout](bluetoothleadvertisementwatchertrigger_minoutofrangetimeout.md) and [MaxOutOfRangeTimeout](bluetoothleadvertisementwatchertrigger_maxoutofrangetimeout.md) properties. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.SignalStrengthFilter +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BluetoothLEAdvertisementWatcherTrigger.SignalStrengthFilter + +## -description +Gets or sets the configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. + +## -property-value +The configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. + +## -remarks +The [SignalStrengthFilter](bluetoothleadvertisementwatchertrigger_signalstrengthfilter.md) has additional limitations on its properties when used by the [BluetoothLEAdvertisementWatcherTrigger](bluetoothleadvertisementwatchertrigger.md) class. The trigger will fail to register if it contains parameters outside of the valid range. If the properties are left as `NULL`, a default value is selected. + + +The additional restrictions and default values are as follows: + ++ **InRangeThresholdInDBm**: The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for Bluetooth LE is -127 (default when NULL is -127). ++ **OutOfRangeThresholdInDBm**: The maximum value for RSSI for Bluetooth LE is +20. The maximim value for RSSI for Bluetooth LE is -127 (default when NULL is -127). ++ **OutOfRangeTimeout**: Equal or greater than 1 second and less than or equal to 60 seconds (default when NULL is 60 seconds). ++ **SamplingInterval**: Equal or greater than 1 second. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. For more information about the behavior of the RSSI filtering, refer to [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md). + + +Additional restrictions are in place such that a filter with **OutOfRangeThresholdInDBm** higher than **InRangeThresholdInDBm** will be rejected for example. Some of these limits are obtainable programmatically through the [MinSamplingInterval](bluetoothleadvertisementwatchertrigger_minsamplinginterval.md), [MaxSamplingInterval](bluetoothleadvertisementwatchertrigger_maxsamplinginterval.md), [MinOutOfRangeTimeout](bluetoothleadvertisementwatchertrigger_minoutofrangetimeout.md) and [MaxOutOfRangeTimeout](bluetoothleadvertisementwatchertrigger_maxoutofrangetimeout.md) properties. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/cachedfileupdatertrigger.md b/windows.applicationmodel.background/cachedfileupdatertrigger.md index 1b10194e93..6e84286a49 100644 --- a/windows.applicationmodel.background/cachedfileupdatertrigger.md +++ b/windows.applicationmodel.background/cachedfileupdatertrigger.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Background.CachedFileUpdaterTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.CachedFileUpdaterTrigger ## -description Represents a trigger that launches a background task to enable the Cached File Updater contract. ## -remarks On the phone form factor, apps can't be launched without showing UI. This class enables phone apps to use a background task to update cached files. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.CachedFileUpdaterTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.CachedFileUpdaterTrigger + +## -description +Represents a trigger that launches a background task to enable the Cached File Updater contract. + +## -remarks +On the phone form factor, apps can't be launched without showing UI. This class enables phone apps to use a background task to update cached files. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/cachedfileupdatertrigger_cachedfileupdatertrigger_1221375020.md b/windows.applicationmodel.background/cachedfileupdatertrigger_cachedfileupdatertrigger_1221375020.md index 85e319fed5..7aa1e360f6 100644 --- a/windows.applicationmodel.background/cachedfileupdatertrigger_cachedfileupdatertrigger_1221375020.md +++ b/windows.applicationmodel.background/cachedfileupdatertrigger_cachedfileupdatertrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.CachedFileUpdaterTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.CachedFileUpdaterTrigger.CachedFileUpdaterTrigger ## -description Initializes a new instance of the [CachedFileUpdaterTrigger](cachedfileupdatertrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.CachedFileUpdaterTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.CachedFileUpdaterTrigger.CachedFileUpdaterTrigger + +## -description +Initializes a new instance of the [CachedFileUpdaterTrigger](cachedfileupdatertrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/cachedfileupdatertriggerdetails.md b/windows.applicationmodel.background/cachedfileupdatertriggerdetails.md index 690bd5d666..94586eef78 100644 --- a/windows.applicationmodel.background/cachedfileupdatertriggerdetails.md +++ b/windows.applicationmodel.background/cachedfileupdatertriggerdetails.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails ## -description Provides details about the cached file operation that invoked the trigger. ## -remarks > [!NOTE] > Obtain an instance of this class from an object that implements [Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails + +## -description +Provides details about the cached file operation that invoked the trigger. + +## -remarks +> [!NOTE] +> Obtain an instance of this class from an object that implements [Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/cachedfileupdatertriggerdetails_canrequestuserinput.md b/windows.applicationmodel.background/cachedfileupdatertriggerdetails_canrequestuserinput.md index efd4e4b978..a87b731c33 100644 --- a/windows.applicationmodel.background/cachedfileupdatertriggerdetails_canrequestuserinput.md +++ b/windows.applicationmodel.background/cachedfileupdatertriggerdetails_canrequestuserinput.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.CanRequestUserInput --api-type: winrt property ---- # Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.CanRequestUserInput ## -description Gets whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger. ## -property-value Whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger. ## -remarks The Cached File Updater pattern allows the provider app to specify that user input is needed to complete the cached file update by setting the [Status](../windows.storage.provider/fileupdaterequest_status.md) property of the associated [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) to [UserInputNeeded](../windows.storage.provider/fileupdaterequest_userinputneededmessage.md). It is possible that the system may not be able to show UI to the user during the background task, if the app that updated the file is not currently running in the foreground, for example. In this case, [CanRequestUserInput](cachedfileupdatertriggerdetails_canrequestuserinput.md) will be false. So, you should check this value before requesting for the system to show UI. Setting the [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) status to [UserInputNeeded](../windows.storage.provider/fileupdaterequest_userinputneededmessage.md) will throw an exception if [CanRequestUserInput](cachedfileupdatertriggerdetails_canrequestuserinput.md) is false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.CanRequestUserInput +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.CanRequestUserInput + +## -description +Gets whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger. + +## -property-value +Whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger. + +## -remarks +The Cached File Updater pattern allows the provider app to specify that user input is needed to complete the cached file update by setting the [Status](../windows.storage.provider/fileupdaterequest_status.md) property of the associated [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) to [UserInputNeeded](../windows.storage.provider/fileupdaterequest_userinputneededmessage.md). It is possible that the system may not be able to show UI to the user during the background task, if the app that updated the file is not currently running in the foreground, for example. In this case, [CanRequestUserInput](cachedfileupdatertriggerdetails_canrequestuserinput.md) will be false. So, you should check this value before requesting for the system to show UI. Setting the [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) status to [UserInputNeeded](../windows.storage.provider/fileupdaterequest_userinputneededmessage.md) will throw an exception if [CanRequestUserInput](cachedfileupdatertriggerdetails_canrequestuserinput.md) is false. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updaterequest.md b/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updaterequest.md index c5c6352d4e..fa2c1ff02c 100644 --- a/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updaterequest.md +++ b/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updaterequest.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateRequest --api-type: winrt property ---- # Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateRequest ## -description Gets the [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) object associated with the cached file update. ## -property-value The [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) object associated with the cached file update. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateRequest +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateRequest + +## -description +Gets the [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) object associated with the cached file update. + +## -property-value +The [FileUpdateRequest](../windows.storage.provider/fileupdaterequest.md) object associated with the cached file update. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updatetarget.md b/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updatetarget.md index 3ff382d153..73d0463533 100644 --- a/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updatetarget.md +++ b/windows.applicationmodel.background/cachedfileupdatertriggerdetails_updatetarget.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateTarget --api-type: winrt property ---- # Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateTarget ## -description Gets the [CachedFileTarget](../windows.storage.provider/cachedfiletarget.md) object associated with cached file update that indicates whether the local or remote file should be updated. ## -property-value The [CachedFileTarget](../windows.storage.provider/cachedfiletarget.md) object associated with cached file update that indicates whether the local or remote file should be updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateTarget +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.CachedFileUpdaterTriggerDetails.UpdateTarget + +## -description +Gets the [CachedFileTarget](../windows.storage.provider/cachedfiletarget.md) object associated with cached file update that indicates whether the local or remote file should be updated. + +## -property-value +The [CachedFileTarget](../windows.storage.provider/cachedfiletarget.md) object associated with cached file update that indicates whether the local or remote file should be updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/chatmessagenotificationtrigger.md b/windows.applicationmodel.background/chatmessagenotificationtrigger.md index 49506b4260..635b8f0335 100644 --- a/windows.applicationmodel.background/chatmessagenotificationtrigger.md +++ b/windows.applicationmodel.background/chatmessagenotificationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ChatMessageNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ChatMessageNotificationTrigger ## -description Represents a trigger that is activated when there is a notification for a text message. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ChatMessageNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ChatMessageNotificationTrigger + +## -description +Represents a trigger that is activated when there is a notification for a text message. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file diff --git a/windows.applicationmodel.background/chatmessagenotificationtrigger_chatmessagenotificationtrigger_1221375020.md b/windows.applicationmodel.background/chatmessagenotificationtrigger_chatmessagenotificationtrigger_1221375020.md index 1d22c4d14d..05b775a160 100644 --- a/windows.applicationmodel.background/chatmessagenotificationtrigger_chatmessagenotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/chatmessagenotificationtrigger_chatmessagenotificationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ChatMessageNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ChatMessageNotificationTrigger.ChatMessageNotificationTrigger ## -description Represents a trigger that is activated when there is a notification for a text message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ChatMessageNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ChatMessageNotificationTrigger.ChatMessageNotificationTrigger + +## -description +Represents a trigger that is activated when there is a notification for a text message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/chatmessagereceivednotificationtrigger.md b/windows.applicationmodel.background/chatmessagereceivednotificationtrigger.md index dfb91c84ce..cd692272e1 100644 --- a/windows.applicationmodel.background/chatmessagereceivednotificationtrigger.md +++ b/windows.applicationmodel.background/chatmessagereceivednotificationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger ## -description Represents a trigger that launches a background task that handles any incoming message that might need to be filtered according to its content. For more information about filtering messages, see [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md). ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger + +## -description +Represents a trigger that launches a background task that handles any incoming message that might need to be filtered according to its content. For more information about filtering messages, see [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md). + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file diff --git a/windows.applicationmodel.background/chatmessagereceivednotificationtrigger_chatmessagereceivednotificationtrigger_1221375020.md b/windows.applicationmodel.background/chatmessagereceivednotificationtrigger_chatmessagereceivednotificationtrigger_1221375020.md index 207e8e74d8..644def4a4a 100644 --- a/windows.applicationmodel.background/chatmessagereceivednotificationtrigger_chatmessagereceivednotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/chatmessagereceivednotificationtrigger_chatmessagereceivednotificationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger.ChatMessageReceivedNotificationTrigger ## -description Initializes a new instance of the [ChatMessageReceivedNotificationTrigger](chatmessagereceivednotificationtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ChatMessageReceivedNotificationTrigger.ChatMessageReceivedNotificationTrigger + +## -description +Initializes a new instance of the [ChatMessageReceivedNotificationTrigger](chatmessagereceivednotificationtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/communicationblockingappsetasactivetrigger.md b/windows.applicationmodel.background/communicationblockingappsetasactivetrigger.md index 3a406a25c9..adb681152b 100644 --- a/windows.applicationmodel.background/communicationblockingappsetasactivetrigger.md +++ b/windows.applicationmodel.background/communicationblockingappsetasactivetrigger.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger ## -description Represents a trigger to activate a communication blocking application when it is selected as the preferred blocking app. A user can have multiple communication blocking applications installed at one time. This trigger is used to let an application know that it has been selected as the active communication blocking application. For more information about the communication blocking API, see [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md). ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger + +## -description +Represents a trigger to activate a communication blocking application when it is selected as the preferred blocking app. + +A user can have multiple communication blocking applications installed at one time. This trigger is used to let an application know that it has been selected as the active communication blocking application. For more information about the communication blocking API, see [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md). + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file diff --git a/windows.applicationmodel.background/communicationblockingappsetasactivetrigger_communicationblockingappsetasactivetrigger_1221375020.md b/windows.applicationmodel.background/communicationblockingappsetasactivetrigger_communicationblockingappsetasactivetrigger_1221375020.md index d266ca8dc0..cca5512ac6 100644 --- a/windows.applicationmodel.background/communicationblockingappsetasactivetrigger_communicationblockingappsetasactivetrigger_1221375020.md +++ b/windows.applicationmodel.background/communicationblockingappsetasactivetrigger_communicationblockingappsetasactivetrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger.CommunicationBlockingAppSetAsActiveTrigger ## -description Initializes a new instance of the [CommunicationBlockingAppSetAsActiveTrigger](communicationblockingappsetasactivetrigger.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.CommunicationBlockingAppSetAsActiveTrigger.CommunicationBlockingAppSetAsActiveTrigger + +## -description +Initializes a new instance of the [CommunicationBlockingAppSetAsActiveTrigger](communicationblockingappsetasactivetrigger.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/contactstorenotificationtrigger.md b/windows.applicationmodel.background/contactstorenotificationtrigger.md index b872446735..18c27e8aeb 100644 --- a/windows.applicationmodel.background/contactstorenotificationtrigger.md +++ b/windows.applicationmodel.background/contactstorenotificationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ContactStoreNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ContactStoreNotificationTrigger ## -description Represents a trigger that launches a background task for processing changes to the contacts store. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ContactStoreNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ContactStoreNotificationTrigger + +## -description +Represents a trigger that launches a background task for processing changes to the contacts store. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/contactstorenotificationtrigger_contactstorenotificationtrigger_1221375020.md b/windows.applicationmodel.background/contactstorenotificationtrigger_contactstorenotificationtrigger_1221375020.md index e6ef6d3136..ad12e87b8b 100644 --- a/windows.applicationmodel.background/contactstorenotificationtrigger_contactstorenotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/contactstorenotificationtrigger_contactstorenotificationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ContactStoreNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ContactStoreNotificationTrigger.ContactStoreNotificationTrigger ## -description Initializes a new instance of the [ContactStoreNotificationTrigger](contactstorenotificationtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ContactStoreNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ContactStoreNotificationTrigger.ContactStoreNotificationTrigger + +## -description +Initializes a new instance of the [ContactStoreNotificationTrigger](contactstorenotificationtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/contentprefetchtrigger.md b/windows.applicationmodel.background/contentprefetchtrigger.md index f03583d653..f60c93c952 100644 --- a/windows.applicationmodel.background/contentprefetchtrigger.md +++ b/windows.applicationmodel.background/contentprefetchtrigger.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ContentPrefetchTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ContentPrefetchTrigger ## -description Provides the ability to run custom handlers when prefetching web resources. ## -remarks Developers can attach a handler to preload and cache web content so an app can launch and have its content refreshed and up to date. Accessing cached content helps reduce app activation time by not having to queue costly web requests. In addition to custom tasks, the existing [ContentPrefetcher](../windows.networking.backgroundtransfer/contentprefetcher.md) API is still available and can be used instead of the custom task when the prerequisite work only involves preloading and caching content from a fixed or dynamic set of URIs. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ContentPrefetchTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ContentPrefetchTrigger + +## -description +Provides the ability to run custom handlers when prefetching web resources. + +## -remarks +Developers can attach a handler to preload and cache web content so an app can launch and have its content refreshed and up to date. Accessing cached content helps reduce app activation time by not having to queue costly web requests. + +In addition to custom tasks, the existing [ContentPrefetcher](../windows.networking.backgroundtransfer/contentprefetcher.md) API is still available and can be used instead of the custom task when the prerequisite work only involves preloading and caching content from a fixed or dynamic set of URIs. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_1221375020.md b/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_1221375020.md index 216e66dbc8..cdf5a4e28a 100644 --- a/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_1221375020.md +++ b/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ContentPrefetchTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ContentPrefetchTrigger.ContentPrefetchTrigger ## -description Initializes a new instance of the [ContentPrefetchTrigger](contentprefetchtrigger.md) class. ## -remarks ## -examples ## -see-also [ContentPrefetchTrigger(TimeSpan)](contentprefetchtrigger_contentprefetchtrigger_39915104.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ContentPrefetchTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ContentPrefetchTrigger.ContentPrefetchTrigger + +## -description +Initializes a new instance of the [ContentPrefetchTrigger](contentprefetchtrigger.md) class. + +## -remarks + +## -examples + +## -see-also +[ContentPrefetchTrigger(TimeSpan)](contentprefetchtrigger_contentprefetchtrigger_39915104.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_39915104.md b/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_39915104.md index 0e28e88758..60910b27f0 100644 --- a/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_39915104.md +++ b/windows.applicationmodel.background/contentprefetchtrigger_contentprefetchtrigger_39915104.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ContentPrefetchTrigger.#ctor(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Background.ContentPrefetchTrigger.ContentPrefetchTrigger ## -description Initializes a new instance of the [ContentPrefetchTrigger](contentprefetchtrigger.md) class using a specified time interval. ## -parameters ### -param waitInterval Interval before next allowed content prefetch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ContentPrefetchTrigger.#ctor(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ContentPrefetchTrigger.ContentPrefetchTrigger + +## -description +Initializes a new instance of the [ContentPrefetchTrigger](contentprefetchtrigger.md) class using a specified time interval. + +## -parameters +### -param waitInterval +Interval before next allowed content prefetch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/contentprefetchtrigger_waitinterval.md b/windows.applicationmodel.background/contentprefetchtrigger_waitinterval.md index d006164a5d..3fa1a65498 100644 --- a/windows.applicationmodel.background/contentprefetchtrigger_waitinterval.md +++ b/windows.applicationmodel.background/contentprefetchtrigger_waitinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.ContentPrefetchTrigger.WaitInterval --api-type: winrt property ---- # Windows.ApplicationModel.Background.ContentPrefetchTrigger.WaitInterval ## -description Retrieves the time interval for prefetching web content. ## -property-value The time interval set for refreshing web content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ContentPrefetchTrigger.WaitInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ContentPrefetchTrigger.WaitInterval + +## -description +Retrieves the time interval for prefetching web content. + +## -property-value +The time interval set for refreshing web content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceconnectionchangetrigger.md b/windows.applicationmodel.background/deviceconnectionchangetrigger.md index f1d2637e19..1d42ed52de 100644 --- a/windows.applicationmodel.background/deviceconnectionchangetrigger.md +++ b/windows.applicationmodel.background/deviceconnectionchangetrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger ## -description Represents a trigger that launches a background task when the connection status of a device changes. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger + +## -description +Represents a trigger that launches a background task when the connection status of a device changes. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/deviceconnectionchangetrigger_canmaintainconnection.md b/windows.applicationmodel.background/deviceconnectionchangetrigger_canmaintainconnection.md index deb23f5c4d..d06c38a3df 100644 --- a/windows.applicationmodel.background/deviceconnectionchangetrigger_canmaintainconnection.md +++ b/windows.applicationmodel.background/deviceconnectionchangetrigger_canmaintainconnection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.CanMaintainConnection --api-type: winrt property ---- # Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.CanMaintainConnection ## -description Gets whether the system can maintain a connection to the specified device. ## -property-value True if the system can maintain a connection to the specified device; Otherwise, false. If false, an attempt to register a trigger with [MaintainConnection](deviceconnectionchangetrigger_maintainconnection.md) = true will throw an exception. The default value of this property is true for Bluetooth LE devices and false for all other device types. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.CanMaintainConnection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.CanMaintainConnection + +## -description +Gets whether the system can maintain a connection to the specified device. + +## -property-value +True if the system can maintain a connection to the specified device; Otherwise, false. If false, an attempt to register a trigger with [MaintainConnection](deviceconnectionchangetrigger_maintainconnection.md) = true will throw an exception. The default value of this property is true for Bluetooth LE devices and false for all other device types. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceconnectionchangetrigger_deviceid.md b/windows.applicationmodel.background/deviceconnectionchangetrigger_deviceid.md index e1ef629649..ce0c9057b1 100644 --- a/windows.applicationmodel.background/deviceconnectionchangetrigger_deviceid.md +++ b/windows.applicationmodel.background/deviceconnectionchangetrigger_deviceid.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.DeviceId --api-type: winrt property ---- # Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.DeviceId ## -description Gets the device Id associated with the device. ## -property-value The device Id associated with the device. ## -remarks When monitoring Bluetooth LE devices, the DeviceId must reference an interface on the Bluetooth LE device object. The device Id in this case can be the values returned by the [GetDeviceSelector](../windows.devices.bluetooth/bluetoothledevice_getdeviceselector.md). Alternatively, the DeviceId can reference an interface on a [GattDeviceService](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md) object and valid values for the device Id is any value returned by [GetDeviceSelectorFromShortId](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromshortid.md) or [GetDeviceSelectorFromUuid](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromuuid.md). When monitoring other Bluetooth devices, the device Id can be any value returned by the GetDeviceSelector on RfCommDeviceService or BluetoothDevice. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.DeviceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.DeviceId + +## -description +Gets the device Id associated with the device. + +## -property-value +The device Id associated with the device. + +## -remarks +When monitoring Bluetooth LE devices, the DeviceId must reference an interface on the Bluetooth LE device object. The device Id in this case can be the values returned by the [GetDeviceSelector](../windows.devices.bluetooth/bluetoothledevice_getdeviceselector.md). Alternatively, the DeviceId can reference an interface on a [GattDeviceService](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md) object and valid values for the device Id is any value returned by [GetDeviceSelectorFromShortId](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromshortid.md) or [GetDeviceSelectorFromUuid](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromuuid.md). + +When monitoring other Bluetooth devices, the device Id can be any value returned by the GetDeviceSelector on RfCommDeviceService or BluetoothDevice. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceconnectionchangetrigger_fromidasync_1322863552.md b/windows.applicationmodel.background/deviceconnectionchangetrigger_fromidasync_1322863552.md index 1c8c336b96..cc704059fa 100644 --- a/windows.applicationmodel.background/deviceconnectionchangetrigger_fromidasync_1322863552.md +++ b/windows.applicationmodel.background/deviceconnectionchangetrigger_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.FromIdAsync ## -description Begins an asynchronous operation to get the [DeviceConnectionChangeTrigger](deviceconnectionchangetrigger.md) associated with the specified Id. ## -parameters ### -param deviceId The device Id with which to find the associated trigger. ## -returns The DeviceConnectionChangeTrigger object associated with the specified device Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.FromIdAsync + +## -description +Begins an asynchronous operation to get the [DeviceConnectionChangeTrigger](deviceconnectionchangetrigger.md) associated with the specified Id. + +## -parameters +### -param deviceId +The device Id with which to find the associated trigger. + +## -returns +The DeviceConnectionChangeTrigger object associated with the specified device Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceconnectionchangetrigger_maintainconnection.md b/windows.applicationmodel.background/deviceconnectionchangetrigger_maintainconnection.md index 8e68da9c33..a97c71b3ad 100644 --- a/windows.applicationmodel.background/deviceconnectionchangetrigger_maintainconnection.md +++ b/windows.applicationmodel.background/deviceconnectionchangetrigger_maintainconnection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.MaintainConnection --api-type: winrt property ---- # Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.MaintainConnection ## -description Gets or sets whether the system should automatically attempt to keep the referenced device connected. ## -property-value True of the system should try to keep the device connected; Otherwise, false. Default is false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.MaintainConnection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.DeviceConnectionChangeTrigger.MaintainConnection + +## -description +Gets or sets whether the system should automatically attempt to keep the referenced device connected. + +## -property-value +True of the system should try to keep the device connected; Otherwise, false. Default is false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/devicemanufacturernotificationtrigger.md b/windows.applicationmodel.background/devicemanufacturernotificationtrigger.md index ca45fe4f7f..f996d25b4c 100644 --- a/windows.applicationmodel.background/devicemanufacturernotificationtrigger.md +++ b/windows.applicationmodel.background/devicemanufacturernotificationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger ## -description Represents a trigger that launches a background task to enable device manufacturer operations. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger + +## -description +Represents a trigger that launches a background task to enable device manufacturer operations. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/devicemanufacturernotificationtrigger_devicemanufacturernotificationtrigger_215188748.md b/windows.applicationmodel.background/devicemanufacturernotificationtrigger_devicemanufacturernotificationtrigger_215188748.md index dcbfa4ba18..1366375786 100644 --- a/windows.applicationmodel.background/devicemanufacturernotificationtrigger_devicemanufacturernotificationtrigger_215188748.md +++ b/windows.applicationmodel.background/devicemanufacturernotificationtrigger_devicemanufacturernotificationtrigger_215188748.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.#ctor(System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.DeviceManufacturerNotificationTrigger ## -description Initializes a new instance of the [DeviceManufacturerNotificationTrigger](devicemanufacturernotificationtrigger.md) class. ## -parameters ### -param triggerQualifier An app-defined string that qualifies the trigger. ### -param oneShot Whether the trigger is used only once. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.#ctor(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.DeviceManufacturerNotificationTrigger + +## -description +Initializes a new instance of the [DeviceManufacturerNotificationTrigger](devicemanufacturernotificationtrigger.md) class. + +## -parameters +### -param triggerQualifier +An app-defined string that qualifies the trigger. + +### -param oneShot +Whether the trigger is used only once. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/devicemanufacturernotificationtrigger_oneshot.md b/windows.applicationmodel.background/devicemanufacturernotificationtrigger_oneshot.md index c1f9c8485e..747218a5da 100644 --- a/windows.applicationmodel.background/devicemanufacturernotificationtrigger_oneshot.md +++ b/windows.applicationmodel.background/devicemanufacturernotificationtrigger_oneshot.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.OneShot --api-type: winrt property ---- # Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.OneShot ## -description Gets whether the trigger is used only once. ## -property-value True if the trigger is used only once. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.OneShot +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.OneShot + +## -description +Gets whether the trigger is used only once. + +## -property-value +True if the trigger is used only once. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/devicemanufacturernotificationtrigger_triggerqualifier.md b/windows.applicationmodel.background/devicemanufacturernotificationtrigger_triggerqualifier.md index 82c5b2bea1..38d13866eb 100644 --- a/windows.applicationmodel.background/devicemanufacturernotificationtrigger_triggerqualifier.md +++ b/windows.applicationmodel.background/devicemanufacturernotificationtrigger_triggerqualifier.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.TriggerQualifier --api-type: winrt property ---- # Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.TriggerQualifier ## -description Gets an app-defined string that qualifies the trigger. ## -property-value An app-defined string that qualifies the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.TriggerQualifier +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.DeviceManufacturerNotificationTrigger.TriggerQualifier + +## -description +Gets an app-defined string that qualifies the trigger. + +## -property-value +An app-defined string that qualifies the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceservicingtrigger.md b/windows.applicationmodel.background/deviceservicingtrigger.md index c51d068310..cf83279a59 100644 --- a/windows.applicationmodel.background/deviceservicingtrigger.md +++ b/windows.applicationmodel.background/deviceservicingtrigger.md @@ -1,3 +1,44 @@ ---- -api-id: T:Windows.ApplicationModel.Background.DeviceServicingTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.DeviceServicingTrigger ## -description Represents an event that an application can trigger to initiate a long-running update (firmware or settings) of a device. Windows 8.1 enables you to develop Windows Store app for your peripheral devices that communicate over USB, HID, and Bluetooth. For example, a user might need to sync content on a PC to or from the device, or perform a long-running update to the device itself like settings or firmware updates. Windows 8.1 provides two background tasks and corresponding APIs that allow your device to sync and update in the background: [DeviceServicingTrigger](deviceservicingtrigger.md) and [DeviceUseTrigger](deviceusetrigger.md). This topic provides API reference information for [DeviceServicingTrigger](deviceservicingtrigger.md) - for info on using this trigger in the context of a device app, see [Device sync and update for Windows Store device apps](http://go.microsoft.com/fwlink/p/?LinkId=306619 ). The [DeviceServicingTrigger](deviceservicingtrigger.md) background task allows your Windows Store app that interacts with your peripheral device to perform long running device updates while your app is suspended, for example settings transfers or firmware updates. Updating your device in the background requires user approval each time the background task is used. Unlike the [DeviceUseTrigger](deviceusetrigger.md) background task, the [DeviceServicingTrigger](deviceservicingtrigger.md) background task allows for device reboot and disconnect and allows a maximum of 30 minutes of background activity. + More detail on the policy requirements of the [DeviceServicingTrigger](deviceservicingtrigger.md) background task can be found in the section of this page. + For info about using the [DeviceServicingTrigger](deviceservicingtrigger.md), see [Device sync and update for Windows Store device apps](http://go.microsoft.com/fwlink/p/?LinkId=306619 ). + For info about using the [DeviceUseTrigger](deviceusetrigger.md), see [Accessing sensors and devices from a background task](http://msdn.microsoft.com/library/ccde8565-8dae-44fc-aded-3a0fee759930). > [!IMPORTANT] > This trigger cannot be used with single-process background tasks. ## -remarks Certain policies are enforced by Windows to ensure user consent when updating their peripheral devices. Additional polices are enforced to preserve user battery life when syncing and updating peripheral devices. The [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task is subject to the following policies: + The [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task requires user consent every time it's triggered. + Your device must be connected or paired with the PC and available when requesting the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md). + Your app is allowed a maximum of 30 minutes (wall clock) of background activity for device updates with [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) + Your app is not allowed to request a [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task while your app is not in the foreground. + Your app can only run one [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) at a time. Attempting to create a second [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) will raise an exception. + The PC's battery must have more than 33% capacity remaining, or the PC must be on A/C power. + [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background tasks may be canceled by Windows when these policy requirements are no longer met, including a maximum amount of wall clock background time. > [!NOTE] > Windows Store app that intend to use the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task must also be a privileged app for the device. App privilege is specified in the device metadata for a peripheral device by the device manufacturer. When a Windows Store app attempts to trigger the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task, Windows will validate that the calling app is the privileged app for the device it is attempting to update. If the app is not privileged for the device then Windows will not allow the background task to launch. For detailed information about app privilege and the policy checks enforced by Windows for the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task see [Device sync and update for Windows Store device apps](http://go.microsoft.com/fwlink/p/?LinkId=306619 ). ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.DeviceServicingTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.DeviceServicingTrigger + +## -description +Represents an event that an application can trigger to initiate a long-running update (firmware or settings) of a device. + +Windows 8.1 enables you to develop Windows Store app for your peripheral devices that communicate over USB, HID, and Bluetooth. For example, a user might need to sync content on a PC to or from the device, or perform a long-running update to the device itself like settings or firmware updates. Windows 8.1 provides two background tasks and corresponding APIs that allow your device to sync and update in the background: [DeviceServicingTrigger](deviceservicingtrigger.md) and [DeviceUseTrigger](deviceusetrigger.md). This topic provides API reference information for [DeviceServicingTrigger](deviceservicingtrigger.md) - for info on using this trigger in the context of a device app, see [Device sync and update for Windows Store device apps](http://go.microsoft.com/fwlink/p/?LinkId=306619 ). + +The [DeviceServicingTrigger](deviceservicingtrigger.md) background task allows your Windows Store app that interacts with your peripheral device to perform long running device updates while your app is suspended, for example settings transfers or firmware updates. Updating your device in the background requires user approval each time the background task is used. Unlike the [DeviceUseTrigger](deviceusetrigger.md) background task, the [DeviceServicingTrigger](deviceservicingtrigger.md) background task allows for device reboot and disconnect and allows a maximum of 30 minutes of background activity. + + ++ More detail on the policy requirements of the [DeviceServicingTrigger](deviceservicingtrigger.md) background task can be found in the section of this page. ++ For info about using the [DeviceServicingTrigger](deviceservicingtrigger.md), see [Device sync and update for Windows Store device apps](http://go.microsoft.com/fwlink/p/?LinkId=306619 ). ++ For info about using the [DeviceUseTrigger](deviceusetrigger.md), see [Accessing sensors and devices from a background task](http://msdn.microsoft.com/library/ccde8565-8dae-44fc-aded-3a0fee759930). +> [!IMPORTANT] +> This trigger cannot be used with single-process background tasks. + +## -remarks +Certain policies are enforced by Windows to ensure user consent when updating their peripheral devices. Additional polices are enforced to preserve user battery life when syncing and updating peripheral devices. The [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task is subject to the following policies: + ++ The [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task requires user consent every time it's triggered. ++ Your device must be connected or paired with the PC and available when requesting the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md). ++ Your app is allowed a maximum of 30 minutes (wall clock) of background activity for device updates with [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) ++ Your app is not allowed to request a [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task while your app is not in the foreground. ++ Your app can only run one [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) at a time. Attempting to create a second [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) will raise an exception. ++ The PC's battery must have more than 33% capacity remaining, or the PC must be on A/C power. ++ [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background tasks may be canceled by Windows when these policy requirements are no longer met, including a maximum amount of wall clock background time. +> [!NOTE] +> Windows Store app that intend to use the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task must also be a privileged app for the device. App privilege is specified in the device metadata for a peripheral device by the device manufacturer. When a Windows Store app attempts to trigger the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task, Windows will validate that the calling app is the privileged app for the device it is attempting to update. If the app is not privileged for the device then Windows will not allow the background task to launch. + +For detailed information about app privilege and the policy checks enforced by Windows for the [DeviceServicingTrigger](deviceservicingtrigger_deviceservicingtrigger.md) background task see [Device sync and update for Windows Store device apps](http://go.microsoft.com/fwlink/p/?LinkId=306619 ). + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/deviceservicingtrigger_deviceservicingtrigger_1221375020.md b/windows.applicationmodel.background/deviceservicingtrigger_deviceservicingtrigger_1221375020.md index cae732325c..03a2d7cddb 100644 --- a/windows.applicationmodel.background/deviceservicingtrigger_deviceservicingtrigger_1221375020.md +++ b/windows.applicationmodel.background/deviceservicingtrigger_deviceservicingtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceServicingTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceServicingTrigger.DeviceServicingTrigger ## -description Constructor for [DeviceServicingTrigger](deviceservicingtrigger.md). Takes no parameters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceServicingTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceServicingTrigger.DeviceServicingTrigger + +## -description +Constructor for [DeviceServicingTrigger](deviceservicingtrigger.md). Takes no parameters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceservicingtrigger_requestasync_2058358296.md b/windows.applicationmodel.background/deviceservicingtrigger_requestasync_2058358296.md index 64261a55e3..8c826ffd1f 100644 --- a/windows.applicationmodel.background/deviceservicingtrigger_requestasync_2058358296.md +++ b/windows.applicationmodel.background/deviceservicingtrigger_requestasync_2058358296.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync(System.String,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync ## -description Triggers the background task (settings or firmware update) and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* string and an optional estimated time the background task will run. If your app cannot determine an appropriate time estimate, provide zero as the estimated time. ## -parameters ### -param deviceId The *DeviceInformation.ID* of the device the background task will access. The device path must match the device that will perform the background operation and is used by Windows to ensure that policy requirements are met. ### -param expectedDuration Optional value. The expected duration of the background settings update or background firmware update. If provided, it will be displayed to the user in the system consent dialog when the task is triggered by your app. Set this value to zero if an appropriate time estimate cannot be determined. ## -returns This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. ## -remarks ## -examples ## -see-also [RequestAsync(String, TimeSpan, String)](deviceservicingtrigger_requestasync_481815192.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync(System.String,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync + +## -description +Triggers the background task (settings or firmware update) and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* string and an optional estimated time the background task will run. If your app cannot determine an appropriate time estimate, provide zero as the estimated time. + +## -parameters +### -param deviceId +The *DeviceInformation.ID* of the device the background task will access. The device path must match the device that will perform the background operation and is used by Windows to ensure that policy requirements are met. + +### -param expectedDuration +Optional value. The expected duration of the background settings update or background firmware update. If provided, it will be displayed to the user in the system consent dialog when the task is triggered by your app. Set this value to zero if an appropriate time estimate cannot be determined. + +## -returns +This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. + +## -remarks + +## -examples + +## -see-also +[RequestAsync(String, TimeSpan, String)](deviceservicingtrigger_requestasync_481815192.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/deviceservicingtrigger_requestasync_481815192.md b/windows.applicationmodel.background/deviceservicingtrigger_requestasync_481815192.md index d01ea13f1c..982bb659e4 100644 --- a/windows.applicationmodel.background/deviceservicingtrigger_requestasync_481815192.md +++ b/windows.applicationmodel.background/deviceservicingtrigger_requestasync_481815192.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync(System.String,Windows.Foundation.TimeSpan,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync ## -description Triggers the background task (settings or firmware update) and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* string, an optional estimated time the background task will run, and an optional app-specific string passed to the background task identifying which device operation to perform. If your app cannot determine an appropriate time estimate, provide zero as the estimated time. ## -parameters ### -param deviceId The *DeviceInformation.ID* of the device the background task will access. The device path must match the device that will perform the background operation and is used by Windows to ensure that policy requirements are met. ### -param expectedDuration Optional value. The expected duration of the background settings update or background firmware update. If provided, it will be displayed to the user in the system consent dialog when the task is triggered by your app. Set this value to zero if an appropriate time estimate cannot be determined. ### -param arguments Optional value. An app-specific string passed to the background task identifying which device operation to perform. ## -returns This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. ## -remarks ## -examples ## -see-also [RequestAsync(String, TimeSpan)](deviceservicingtrigger_requestasync_2058358296.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync(System.String,Windows.Foundation.TimeSpan,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceServicingTrigger.RequestAsync + +## -description +Triggers the background task (settings or firmware update) and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* string, an optional estimated time the background task will run, and an optional app-specific string passed to the background task identifying which device operation to perform. If your app cannot determine an appropriate time estimate, provide zero as the estimated time. + +## -parameters +### -param deviceId +The *DeviceInformation.ID* of the device the background task will access. The device path must match the device that will perform the background operation and is used by Windows to ensure that policy requirements are met. + +### -param expectedDuration +Optional value. The expected duration of the background settings update or background firmware update. If provided, it will be displayed to the user in the system consent dialog when the task is triggered by your app. Set this value to zero if an appropriate time estimate cannot be determined. + +### -param arguments +Optional value. An app-specific string passed to the background task identifying which device operation to perform. + +## -returns +This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. + +## -remarks + +## -examples + +## -see-also +[RequestAsync(String, TimeSpan)](deviceservicingtrigger_requestasync_2058358296.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/deviceusetrigger_deviceusetrigger_1221375020.md b/windows.applicationmodel.background/deviceusetrigger_deviceusetrigger_1221375020.md index c254ef306a..30c7acf83f 100644 --- a/windows.applicationmodel.background/deviceusetrigger_deviceusetrigger_1221375020.md +++ b/windows.applicationmodel.background/deviceusetrigger_deviceusetrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceUseTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceUseTrigger.DeviceUseTrigger ## -description Constructor for [DeviceUseTrigger](deviceusetrigger.md). Takes no parameters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceUseTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceUseTrigger.DeviceUseTrigger + +## -description +Constructor for [DeviceUseTrigger](deviceusetrigger.md). Takes no parameters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/deviceusetrigger_requestasync_1558743216.md b/windows.applicationmodel.background/deviceusetrigger_requestasync_1558743216.md index fb667c9434..bc6ac69594 100644 --- a/windows.applicationmodel.background/deviceusetrigger_requestasync_1558743216.md +++ b/windows.applicationmodel.background/deviceusetrigger_requestasync_1558743216.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync ## -description Triggers the background task and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* of the device or sensor that the background task will access, and an optional app-specific string passed to the background task identifying which operation to perform. ## -parameters ### -param deviceId The *DeviceInformation.ID* of the device or sensor that the background task will access. It must match the device or sensor that will perform the background operation. It is used by Windows to ensure that policy requirements are met. ### -param arguments Optional value. A string specified by your app and passed to the background task, identifying which operation to perform. ## -returns This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. ## -remarks ## -examples ## -see-also [RequestAsync(String)](deviceusetrigger_requestasync_269780240.md), [Accessing sensors and devices from a background task](http://msdn.microsoft.com/library/ccde8565-8dae-44fc-aded-3a0fee759930) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync + +## -description +Triggers the background task and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* of the device or sensor that the background task will access, and an optional app-specific string passed to the background task identifying which operation to perform. + +## -parameters +### -param deviceId +The *DeviceInformation.ID* of the device or sensor that the background task will access. It must match the device or sensor that will perform the background operation. It is used by Windows to ensure that policy requirements are met. + +### -param arguments +Optional value. A string specified by your app and passed to the background task, identifying which operation to perform. + +## -returns +This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. + +## -remarks + +## -examples + +## -see-also +[RequestAsync(String)](deviceusetrigger_requestasync_269780240.md), [Accessing sensors and devices from a background task](http://msdn.microsoft.com/library/ccde8565-8dae-44fc-aded-3a0fee759930) \ No newline at end of file diff --git a/windows.applicationmodel.background/deviceusetrigger_requestasync_269780240.md b/windows.applicationmodel.background/deviceusetrigger_requestasync_269780240.md index c0c49ad96d..1a1a6f4dbe 100644 --- a/windows.applicationmodel.background/deviceusetrigger_requestasync_269780240.md +++ b/windows.applicationmodel.background/deviceusetrigger_requestasync_269780240.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync ## -description Triggers the background task and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* of the device or sensor that the background task will access. ## -parameters ### -param deviceId The *DeviceInformation.ID* of the device or sensor that the background task will access. It must match the device or sensor that will perform the background operation. It is used by Windows to ensure that policy requirements are met. ## -returns This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. ## -remarks ## -examples ## -see-also [RequestAsync(String, String)](deviceusetrigger_requestasync_1558743216.md), [Accessing sensors and devices from a background task](http://msdn.microsoft.com/library/ccde8565-8dae-44fc-aded-3a0fee759930) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.DeviceUseTrigger.RequestAsync + +## -description +Triggers the background task and returns a [DeviceTriggerResult](devicetriggerresult.md) indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* of the device or sensor that the background task will access. + +## -parameters +### -param deviceId +The *DeviceInformation.ID* of the device or sensor that the background task will access. It must match the device or sensor that will perform the background operation. It is used by Windows to ensure that policy requirements are met. + +## -returns +This method returns a [DeviceTriggerResult](devicetriggerresult.md) when it completes asynchronously. + +## -remarks + +## -examples + +## -see-also +[RequestAsync(String, String)](deviceusetrigger_requestasync_1558743216.md), [Accessing sensors and devices from a background task](http://msdn.microsoft.com/library/ccde8565-8dae-44fc-aded-3a0fee759930) \ No newline at end of file diff --git a/windows.applicationmodel.background/emailstorenotificationtrigger.md b/windows.applicationmodel.background/emailstorenotificationtrigger.md index 764d1a8454..b3bfe30d29 100644 --- a/windows.applicationmodel.background/emailstorenotificationtrigger.md +++ b/windows.applicationmodel.background/emailstorenotificationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.EmailStoreNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.EmailStoreNotificationTrigger ## -description Represents a trigger that enables notification of changes to the email store. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.EmailStoreNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.EmailStoreNotificationTrigger + +## -description +Represents a trigger that enables notification of changes to the email store. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/emailstorenotificationtrigger_emailstorenotificationtrigger_1221375020.md b/windows.applicationmodel.background/emailstorenotificationtrigger_emailstorenotificationtrigger_1221375020.md index ffc4748551..a65c47161c 100644 --- a/windows.applicationmodel.background/emailstorenotificationtrigger_emailstorenotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/emailstorenotificationtrigger_emailstorenotificationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.EmailStoreNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.EmailStoreNotificationTrigger.EmailStoreNotificationTrigger ## -description Initializes a new instance of the [EmailStoreNotificationTrigger](emailstorenotificationtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.EmailStoreNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.EmailStoreNotificationTrigger.EmailStoreNotificationTrigger + +## -description +Initializes a new instance of the [EmailStoreNotificationTrigger](emailstorenotificationtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_characteristic.md b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_characteristic.md index 5a16a9f986..6cb44658af 100644 --- a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_characteristic.md +++ b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_characteristic.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.Characteristic --api-type: winrt property ---- # Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.Characteristic ## -description Gets the GATT characteristic for which value change notifications are desired. ## -property-value The GATT characteristic for which value change notifications are desired. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.Characteristic +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.Characteristic + +## -description +Gets the GATT characteristic for which value change notifications are desired. + +## -property-value +The GATT characteristic for which value change notifications are desired. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_507705716.md b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_507705716.md index 4236f29e90..3f641ae2cc 100644 --- a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_507705716.md +++ b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_507705716.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.#ctor(Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic) --api-type: winrt method ---- # Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.GattCharacteristicNotificationTrigger ## -description Initializes a new instance of the [GattCharacteristicNotificationTrigger](gattcharacteristicnotificationtrigger.md) class. ## -parameters ### -param characteristic The GATT characteristic for which value change notifications are desired. ## -remarks To register for notifications when the value of a GATT characteristic changes, an app does the following: 1. Create an instance of the [GattCharacteristicNotificationTrigger](gattcharacteristicnotificationtrigger.md) object. 2. Create an instance of the [BackgroundTaskBuilder](backgroundtaskbuilder.md) object, and call [SetTrigger](backgroundtaskbuilder_settrigger.md) to attach the GattCharacteristicNotificationTrigger. 3. Call [Register](backgroundtaskbuilder_register.md) on the BackgroundTaskBuilder object. Note that this can only be done for Bluetooth LE devices, and only for characteristics for which the device is willing to generate notifications or indications. The system will attempt to keep the specified Bluetooth LE device in a connected state as long as at least one of the notification triggers is outstanding. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.#ctor(Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.GattCharacteristicNotificationTrigger + +## -description +Initializes a new instance of the [GattCharacteristicNotificationTrigger](gattcharacteristicnotificationtrigger.md) class. + +## -parameters +### -param characteristic +The GATT characteristic for which value change notifications are desired. + +## -remarks +To register for notifications when the value of a GATT characteristic changes, an app does the following: + +1. Create an instance of the [GattCharacteristicNotificationTrigger](gattcharacteristicnotificationtrigger.md) object. + +2. Create an instance of the [BackgroundTaskBuilder](backgroundtaskbuilder.md) object, and call [SetTrigger](backgroundtaskbuilder_settrigger.md) to attach the GattCharacteristicNotificationTrigger. + +3. Call [Register](backgroundtaskbuilder_register.md) on the BackgroundTaskBuilder object. + +Note that this can only be done for Bluetooth LE devices, and only for characteristics for which the device is willing to generate notifications or indications. The system will attempt to keep the specified Bluetooth LE device in a connected state as long as at least one of the notification triggers is outstanding. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtask_run.md b/windows.applicationmodel.background/ibackgroundtask_run.md index fbe40316ce..ec9735a375 100644 --- a/windows.applicationmodel.background/ibackgroundtask_run.md +++ b/windows.applicationmodel.background/ibackgroundtask_run.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.IBackgroundTask.Run(Windows.ApplicationModel.Background.IBackgroundTaskInstance) --api-type: winrt method ---- # Windows.ApplicationModel.Background.IBackgroundTask.Run ## -description Performs the work of a background task. The system calls this method when the associated background task has been triggered. ## -parameters ### -param taskInstance An interface to an instance of the background task. The system creates this instance when the task has been triggered to run. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.IBackgroundTask.Run(Windows.ApplicationModel.Background.IBackgroundTaskInstance) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTask.Run + +## -description +Performs the work of a background task. The system calls this method when the associated background task has been triggered. + +## -parameters +### -param taskInstance +An interface to an instance of the background task. The system creates this instance when the task has been triggered to run. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance2_getthrottlecount.md b/windows.applicationmodel.background/ibackgroundtaskinstance2_getthrottlecount.md index 728366452f..459c649f24 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance2_getthrottlecount.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance2_getthrottlecount.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Background.IBackgroundTaskInstance2.GetThrottleCount(Windows.ApplicationModel.Background.BackgroundTaskThrottleCounter) --api-type: winrt method ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance2.GetThrottleCount ## -description Retrieves the number of times the background task has been suspended for using too many resources. ## -parameters ### -param counter Indicates the type of resource to include in the throttle count: network, CPU, or both. ## -returns This method returns the number of times the background task has been suspended for exceeding its quota of the indicated resource type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.IBackgroundTaskInstance2.GetThrottleCount(Windows.ApplicationModel.Background.BackgroundTaskThrottleCounter) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance2.GetThrottleCount + +## -description +Retrieves the number of times the background task has been suspended for using too many resources. + +## -parameters +### -param counter +Indicates the type of resource to include in the throttle count: network, CPU, or both. + +## -returns +This method returns the number of times the background task has been suspended for exceeding its quota of the indicated resource type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance4_user.md b/windows.applicationmodel.background/ibackgroundtaskinstance4_user.md index ea3dc01237..2194cbc8c2 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance4_user.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance4_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance4.User --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance4.User ## -description Gets the user context for the background task. [AppServiceConnection.User](../windows.applicationmodel.appservice/appserviceconnection_user.md) is used by the calling app to pass the user context. The app service can retrieve that user context with this property. ## -property-value The user context. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance4.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance4.User + +## -description +Gets the user context for the background task. [AppServiceConnection.User](../windows.applicationmodel.appservice/appserviceconnection_user.md) is used by the calling app to pass the user context. The app service can retrieve that user context with this property. + +## -property-value +The user context. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_canceled.md b/windows.applicationmodel.background/ibackgroundtaskinstance_canceled.md index c183303be5..850fd7bfda 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_canceled.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_canceled.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.ApplicationModel.Background.IBackgroundTaskInstance.Canceled --api-type: winrt event ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.Canceled ## -description Attaches a cancellation event handler to the background task instance. > For Windows Phone Store app, if the device becomes low on memory, background tasks may be terminated without any warning and without raising the OnCanceled event. This helps to ensure the user experience of the app in the foreground. Your background task should be designed to handle this scenario. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Background.IBackgroundTaskInstance.Canceled +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.Canceled + +## -description +Attaches a cancellation event handler to the background task instance. + + + +> For Windows Phone Store app, if the device becomes low on memory, background tasks may be terminated without any warning and without raising the OnCanceled event. This helps to ensure the user experience of the app in the foreground. Your background task should be designed to handle this scenario. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_getdeferral.md b/windows.applicationmodel.background/ibackgroundtaskinstance_getdeferral.md index 91dd33822f..253839bbde 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_getdeferral.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_getdeferral.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Background.IBackgroundTaskInstance.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.GetDeferral ## -description Informs the system that the background task might continue to perform work after the [IBackgroundTask.Run](ibackgroundtask_run.md) method returns. ## -returns A background task deferral. ## -remarks If a background task uses an asynchronous operation, it is possible for the [Run](ibackgroundtask_run.md) method to return before the background task has completed its work. As soon as the [Run](ibackgroundtask_run.md) method returns, the system might suspend or terminate the background task host process, which could prevent completion of asynchronous operations started by the background task. To keep the host process from being suspended or terminated while the background task is running, use the [GetDeferral](ibackgroundtaskinstance_getdeferral.md) method to get a background task deferral for each asynchronous operation initiated. Then, when the asynchronous operation is finished, call the [BackgroundTaskDeferral.Complete](backgroundtaskdeferral_complete.md) method. Ensure that you complete all background task deferrals. Most background tasks have a timeout after which the app will be suspended or terminated regardless of whether there are any pending deferrals. However, leaving outstanding background task deferrals interferes with the system's ability to manage process lifetimes in a timely way. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.IBackgroundTaskInstance.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.GetDeferral + +## -description +Informs the system that the background task might continue to perform work after the [IBackgroundTask.Run](ibackgroundtask_run.md) method returns. + +## -returns +A background task deferral. + +## -remarks +If a background task uses an asynchronous operation, it is possible for the [Run](ibackgroundtask_run.md) method to return before the background task has completed its work. As soon as the [Run](ibackgroundtask_run.md) method returns, the system might suspend or terminate the background task host process, which could prevent completion of asynchronous operations started by the background task. + +To keep the host process from being suspended or terminated while the background task is running, use the [GetDeferral](ibackgroundtaskinstance_getdeferral.md) method to get a background task deferral for each asynchronous operation initiated. Then, when the asynchronous operation is finished, call the [BackgroundTaskDeferral.Complete](backgroundtaskdeferral_complete.md) method. + +Ensure that you complete all background task deferrals. Most background tasks have a timeout after which the app will be suspended or terminated regardless of whether there are any pending deferrals. However, leaving outstanding background task deferrals interferes with the system's ability to manage process lifetimes in a timely way. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_instanceid.md b/windows.applicationmodel.background/ibackgroundtaskinstance_instanceid.md index 14f9bd7a91..7948a1bd80 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_instanceid.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_instanceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.InstanceId --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.InstanceId ## -description Gets the instance ID of the background task instance. ## -property-value A unique identifier for the background task instance. This identifier is generated by the system when the instance is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.InstanceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.InstanceId + +## -description +Gets the instance ID of the background task instance. + +## -property-value +A unique identifier for the background task instance. This identifier is generated by the system when the instance is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_progress.md b/windows.applicationmodel.background/ibackgroundtaskinstance_progress.md index d962e76b9d..104d5ecf08 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_progress.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_progress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.Progress --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.Progress ## -description Gets or sets progress status for a background task instance. ## -property-value A value defined by the application to indicate the task's progress. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.Progress + +## -description +Gets or sets progress status for a background task instance. + +## -property-value +A value defined by the application to indicate the task's progress. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_suspendedcount.md b/windows.applicationmodel.background/ibackgroundtaskinstance_suspendedcount.md index d040a91eff..09999c7892 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_suspendedcount.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_suspendedcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.SuspendedCount --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.SuspendedCount ## -description Gets the number of times resource management policy caused the background task to be suspended. ## -property-value The number of times the background task has been suspended. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.SuspendedCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.SuspendedCount + +## -description +Gets the number of times resource management policy caused the background task to be suspended. + +## -property-value +The number of times the background task has been suspended. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_task.md b/windows.applicationmodel.background/ibackgroundtaskinstance_task.md index 2e9814713b..0dd740f206 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_task.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_task.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.Task --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.Task ## -description Gets access to the registered background task for this background task instance. ## -property-value An interface that provides access to the registered background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.Task +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.Task + +## -description +Gets access to the registered background task for this background task instance. + +## -property-value +An interface that provides access to the registered background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md b/windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md index 10afbcb0db..cecff88ff6 100644 --- a/windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md +++ b/windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails ## -description Gets additional information associated with a background task instance. ## -property-value Represents additional information for the background task. If the background task is triggered by a mobile network operator notification, this property is an instance of a [NetworkOperatorNotificationEventDetails](../windows.networking.networkoperators/networkoperatornotificationeventdetails.md) class. If the background task is triggered by a system event or time event, this property is not used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskInstance.TriggerDetails + +## -description +Gets additional information associated with a background task instance. + +## -property-value +Represents additional information for the background task. If the background task is triggered by a mobile network operator notification, this property is an instance of a [NetworkOperatorNotificationEventDetails](../windows.networking.networkoperators/networkoperatornotificationeventdetails.md) class. If the background task is triggered by a system event or time event, this property is not used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration2_trigger.md b/windows.applicationmodel.background/ibackgroundtaskregistration2_trigger.md index fcfeb05783..489e5b352b 100644 --- a/windows.applicationmodel.background/ibackgroundtaskregistration2_trigger.md +++ b/windows.applicationmodel.background/ibackgroundtaskregistration2_trigger.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration2.Trigger --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskRegistration2.Trigger ## -description Gets the trigger associated with the background task. ## -property-value The trigger associated with the background task. ## -remarks For all unsupported trigger types, this property returns null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration2.Trigger +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration2.Trigger + +## -description +Gets the trigger associated with the background task. + +## -property-value +The trigger associated with the background task. + +## -remarks +For all unsupported trigger types, this property returns null. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration_completed.md b/windows.applicationmodel.background/ibackgroundtaskregistration_completed.md index eb8b77ad8f..8a3282b496 100644 --- a/windows.applicationmodel.background/ibackgroundtaskregistration_completed.md +++ b/windows.applicationmodel.background/ibackgroundtaskregistration_completed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Completed --api-type: winrt event ---- # Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Completed ## -description Attaches a completed event handler to the registered background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Completed +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Completed + +## -description +Attaches a completed event handler to the registered background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration_name.md b/windows.applicationmodel.background/ibackgroundtaskregistration_name.md index 1963be907f..86aa3c19d1 100644 --- a/windows.applicationmodel.background/ibackgroundtaskregistration_name.md +++ b/windows.applicationmodel.background/ibackgroundtaskregistration_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Name --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Name ## -description Gets the name of a registered background task. ## -property-value The description specified with [BackgroundTaskBuilder.Name](backgroundtaskbuilder_name.md) when the task was created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Name + +## -description +Gets the name of a registered background task. + +## -property-value +The description specified with [BackgroundTaskBuilder.Name](backgroundtaskbuilder_name.md) when the task was created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration_progress.md b/windows.applicationmodel.background/ibackgroundtaskregistration_progress.md index ab1fa6eeaa..3da7d071f0 100644 --- a/windows.applicationmodel.background/ibackgroundtaskregistration_progress.md +++ b/windows.applicationmodel.background/ibackgroundtaskregistration_progress.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Progress --api-type: winrt event ---- # Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Progress ## -description Attaches a progress event handler to the registered background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Progress +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Progress + +## -description +Attaches a progress event handler to the registered background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration_taskid.md b/windows.applicationmodel.background/ibackgroundtaskregistration_taskid.md index d7d1c9f733..4bb807b8d5 100644 --- a/windows.applicationmodel.background/ibackgroundtaskregistration_taskid.md +++ b/windows.applicationmodel.background/ibackgroundtaskregistration_taskid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.TaskId --api-type: winrt property ---- # Windows.ApplicationModel.Background.IBackgroundTaskRegistration.TaskId ## -description Gets the identifier of a registered background task. ## -property-value The unique identifier for the task. This identifier is generated by the system when the task is registered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration.TaskId + +## -description +Gets the identifier of a registered background task. + +## -property-value +The unique identifier for the task. This identifier is generated by the system when the task is registered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration_unregister.md b/windows.applicationmodel.background/ibackgroundtaskregistration_unregister.md index c0177729bb..21db4f7557 100644 --- a/windows.applicationmodel.background/ibackgroundtaskregistration_unregister.md +++ b/windows.applicationmodel.background/ibackgroundtaskregistration_unregister.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Unregister(System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Unregister ## -description Unregisters a registered background task. ## -parameters ### -param cancelTask True if currently running instances of this background task should be canceled. If this parameter is false, currently running instances of this background task should be allowed to finish. Canceled instances receive a Canceled event with a [BackgroundTaskCancellationReason](backgroundtaskcancellationreason.md) of **Abort**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Unregister(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration.Unregister + +## -description + +Unregisters a registered background task. + +## -parameters +### -param cancelTask +True if currently running instances of this background task should be canceled. If this parameter is false, currently running instances of this background task should be allowed to finish. Canceled instances receive a Canceled event with a [BackgroundTaskCancellationReason](backgroundtaskcancellationreason.md) of **Abort**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/locationtrigger.md b/windows.applicationmodel.background/locationtrigger.md index df1a0f580d..320c9d0b7d 100644 --- a/windows.applicationmodel.background/locationtrigger.md +++ b/windows.applicationmodel.background/locationtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.LocationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.LocationTrigger ## -description Represents a location event that triggers a background task. This is used for Geofencing. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md), [Windows.Devices.Geolocation.Geofencing](../windows.devices.geolocation.geofencing/windows_devices_geolocation_geofencing.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.LocationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.LocationTrigger + +## -description +Represents a location event that triggers a background task. This is used for Geofencing. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md), [Windows.Devices.Geolocation.Geofencing](../windows.devices.geolocation.geofencing/windows_devices_geolocation_geofencing.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/locationtrigger_locationtrigger_146170757.md b/windows.applicationmodel.background/locationtrigger_locationtrigger_146170757.md index 3eed8e8f6f..7a7c5ebf99 100644 --- a/windows.applicationmodel.background/locationtrigger_locationtrigger_146170757.md +++ b/windows.applicationmodel.background/locationtrigger_locationtrigger_146170757.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.LocationTrigger.#ctor(Windows.ApplicationModel.Background.LocationTriggerType) --api-type: winrt method ---- # Windows.ApplicationModel.Background.LocationTrigger.LocationTrigger ## -description Initializes a new instance of a location event trigger. ## -parameters ### -param triggerType The type of location event for this trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.LocationTrigger.#ctor(Windows.ApplicationModel.Background.LocationTriggerType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.LocationTrigger.LocationTrigger + +## -description +Initializes a new instance of a location event trigger. + +## -parameters +### -param triggerType +The type of location event for this trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/locationtrigger_triggertype.md b/windows.applicationmodel.background/locationtrigger_triggertype.md index ae2b35d246..c09f851f46 100644 --- a/windows.applicationmodel.background/locationtrigger_triggertype.md +++ b/windows.applicationmodel.background/locationtrigger_triggertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.LocationTrigger.TriggerType --api-type: winrt property ---- # Windows.ApplicationModel.Background.LocationTrigger.TriggerType ## -description The type of location event for this trigger. ## -property-value The type of location event for this trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.LocationTrigger.TriggerType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.LocationTrigger.TriggerType + +## -description +The type of location event for this trigger. + +## -property-value +The type of location event for this trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/maintenancetrigger_freshnesstime.md b/windows.applicationmodel.background/maintenancetrigger_freshnesstime.md index 8d81e08117..1e64efc03c 100644 --- a/windows.applicationmodel.background/maintenancetrigger_freshnesstime.md +++ b/windows.applicationmodel.background/maintenancetrigger_freshnesstime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.MaintenanceTrigger.FreshnessTime --api-type: winrt property ---- # Windows.ApplicationModel.Background.MaintenanceTrigger.FreshnessTime ## -description Gets the interval of a maintenance trigger. ## -property-value The number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after [FreshnessTime](timetrigger_freshnesstime.md) elapses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.MaintenanceTrigger.FreshnessTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.MaintenanceTrigger.FreshnessTime + +## -description +Gets the interval of a maintenance trigger. + +## -property-value +The number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after [FreshnessTime](timetrigger_freshnesstime.md) elapses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/maintenancetrigger_maintenancetrigger_693505325.md b/windows.applicationmodel.background/maintenancetrigger_maintenancetrigger_693505325.md index d6901f4198..5bc84fab3f 100644 --- a/windows.applicationmodel.background/maintenancetrigger_maintenancetrigger_693505325.md +++ b/windows.applicationmodel.background/maintenancetrigger_maintenancetrigger_693505325.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MaintenanceTrigger.#ctor(System.UInt32,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.MaintenanceTrigger.MaintenanceTrigger ## -description Initializes a new instance of a maintenance trigger. ## -parameters ### -param freshnessTime The number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after *freshnessTime* elapses. ### -param oneShot True if the maintenance trigger is used once; false if it is used each time the *freshnessTime* interval elapses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MaintenanceTrigger.#ctor(System.UInt32,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MaintenanceTrigger.MaintenanceTrigger + +## -description +Initializes a new instance of a maintenance trigger. + +## -parameters +### -param freshnessTime +The number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after *freshnessTime* elapses. + +### -param oneShot +True if the maintenance trigger is used once; false if it is used each time the *freshnessTime* interval elapses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/maintenancetrigger_oneshot.md b/windows.applicationmodel.background/maintenancetrigger_oneshot.md index fe3fd25518..4f1d79cc61 100644 --- a/windows.applicationmodel.background/maintenancetrigger_oneshot.md +++ b/windows.applicationmodel.background/maintenancetrigger_oneshot.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.MaintenanceTrigger.OneShot --api-type: winrt property ---- # Windows.ApplicationModel.Background.MaintenanceTrigger.OneShot ## -description Gets whether the maintenance trigger is used only once or each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. ## -property-value True if the maintenance trigger is used once; false if it is used each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.MaintenanceTrigger.OneShot +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.MaintenanceTrigger.OneShot + +## -description +Gets whether the maintenance trigger is used only once or each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. + +## -property-value +True if the maintenance trigger is used once; false if it is used each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/mediaprocessingtrigger.md b/windows.applicationmodel.background/mediaprocessingtrigger.md index bccf4fda73..22c37e6ad7 100644 --- a/windows.applicationmodel.background/mediaprocessingtrigger.md +++ b/windows.applicationmodel.background/mediaprocessingtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.MediaProcessingTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.MediaProcessingTrigger ## -description Represents a trigger that launches a background task for performing media processing. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.MediaProcessingTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.MediaProcessingTrigger + +## -description +Represents a trigger that launches a background task for performing media processing. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mediaprocessingtrigger_mediaprocessingtrigger_1221375020.md b/windows.applicationmodel.background/mediaprocessingtrigger_mediaprocessingtrigger_1221375020.md index 8579c927f7..fce1060ea1 100644 --- a/windows.applicationmodel.background/mediaprocessingtrigger_mediaprocessingtrigger_1221375020.md +++ b/windows.applicationmodel.background/mediaprocessingtrigger_mediaprocessingtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MediaProcessingTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.MediaProcessingTrigger.MediaProcessingTrigger ## -description Initializes a new instance of the [MediaProcessingTrigger](mediaprocessingtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MediaProcessingTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MediaProcessingTrigger.MediaProcessingTrigger + +## -description +Initializes a new instance of the [MediaProcessingTrigger](mediaprocessingtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1089362155.md b/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1089362155.md index 8c3588ba22..09093b6f78 100644 --- a/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1089362155.md +++ b/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1089362155.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync(Windows.Foundation.Collections.ValueSet) --api-type: winrt method ---- # Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync ## -description Triggers the background task with the provided collection of arguments and returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) indicating success or failure of the trigger request. ## -parameters ### -param arguments A collection of arguments that will be passed to the media processing background task. ## -returns An asynchronous operation that returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) upon completion. ## -remarks ## -examples ## -see-also [RequestAsync](mediaprocessingtrigger_requestasync_1234533424.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync + +## -description +Triggers the background task with the provided collection of arguments and returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) indicating success or failure of the trigger request. + +## -parameters +### -param arguments +A collection of arguments that will be passed to the media processing background task. + +## -returns +An asynchronous operation that returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) upon completion. + +## -remarks + +## -examples + +## -see-also +[RequestAsync](mediaprocessingtrigger_requestasync_1234533424.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1234533424.md b/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1234533424.md index 62bb2d852f..e5d6b16f61 100644 --- a/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1234533424.md +++ b/windows.applicationmodel.background/mediaprocessingtrigger_requestasync_1234533424.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync --api-type: winrt method ---- # Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync ## -description Triggers the background task and returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) indicating success or failure of the trigger request. ## -returns An asynchronous operation that returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) upon completion. ## -remarks ## -examples ## -see-also [RequestAsync(ValueSet)](mediaprocessingtrigger_requestasync_1089362155.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MediaProcessingTrigger.RequestAsync + +## -description +Triggers the background task and returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) indicating success or failure of the trigger request. + +## -returns +An asynchronous operation that returns a [MediaProcessingTriggerResult](mediaprocessingtriggerresult.md) upon completion. + +## -remarks + +## -examples + +## -see-also +[RequestAsync(ValueSet)](mediaprocessingtrigger_requestasync_1089362155.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger.md b/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger.md index bc6501b978..19b5b30f00 100644 --- a/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger.md +++ b/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger ## -description Represents a trigger that activates when the network sends SIM tool commands. Apps receiving this notification then process the SIM tool commands. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandDeviceServiceTriggerDetails](../windows.networking.networkoperators/mobilebroadbanddeviceservicetriggerdetails.md) instance. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger + +## -description +Represents a trigger that activates when the network sends SIM tool commands. Apps receiving this notification then process the SIM tool commands. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandDeviceServiceTriggerDetails](../windows.networking.networkoperators/mobilebroadbanddeviceservicetriggerdetails.md) instance. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger_mobilebroadbanddeviceservicenotificationtrigger_1221375020.md b/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger_mobilebroadbanddeviceservicenotificationtrigger_1221375020.md index e1e8aceb27..11c95b6c41 100644 --- a/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger_mobilebroadbanddeviceservicenotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/mobilebroadbanddeviceservicenotificationtrigger_mobilebroadbanddeviceservicenotificationtrigger_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger.MobileBroadbandDeviceServiceNotificationTrigger ## -description Constructs a MobileBroadbandDeviceServiceNotificationTrigger object. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandDeviceServiceNotificationTrigger.MobileBroadbandDeviceServiceNotificationTrigger + +## -description +Constructs a MobileBroadbandDeviceServiceNotificationTrigger object. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger.md b/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger.md index a753a4de7b..19aba05208 100644 --- a/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger.md +++ b/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger ## -description Represents a trigger that indicates when the SIM PIN lock state has changed. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandPinLockStateChangeTriggerDetails](../windows.networking.networkoperators/mobilebroadbandpinlockstatechangetriggerdetails.md) instance. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger + +## -description +Represents a trigger that indicates when the SIM PIN lock state has changed. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandPinLockStateChangeTriggerDetails](../windows.networking.networkoperators/mobilebroadbandpinlockstatechangetriggerdetails.md) instance. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger_mobilebroadbandpinlockstatechangetrigger_1221375020.md b/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger_mobilebroadbandpinlockstatechangetrigger_1221375020.md index 86968f47b4..cc94bb850e 100644 --- a/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger_mobilebroadbandpinlockstatechangetrigger_1221375020.md +++ b/windows.applicationmodel.background/mobilebroadbandpinlockstatechangetrigger_mobilebroadbandpinlockstatechangetrigger_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger.MobileBroadbandPinLockStateChangeTrigger ## -description Constructs a MobileBroadbandPinLockStateChangeTrigger object. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandPinLockStateChangeTrigger.MobileBroadbandPinLockStateChangeTrigger + +## -description +Constructs a MobileBroadbandPinLockStateChangeTrigger object. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger.md b/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger.md index fa13be8c34..87b0c22757 100644 --- a/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger.md +++ b/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger ## -description Represents a trigger that indicates when mobile broadband radio state has changed. For example, this trigger activates when a mobile device transitions to or from airplane mode. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandRadioStateChangeTriggerDetails](../windows.networking.networkoperators/mobilebroadbandradiostatechangetriggerdetails.md) instance. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger + +## -description +Represents a trigger that indicates when mobile broadband radio state has changed. For example, this trigger activates when a mobile device transitions to or from airplane mode. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandRadioStateChangeTriggerDetails](../windows.networking.networkoperators/mobilebroadbandradiostatechangetriggerdetails.md) instance. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger_mobilebroadbandradiostatechangetrigger_1221375020.md b/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger_mobilebroadbandradiostatechangetrigger_1221375020.md index 06aa0e3fb4..436d737e4d 100644 --- a/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger_mobilebroadbandradiostatechangetrigger_1221375020.md +++ b/windows.applicationmodel.background/mobilebroadbandradiostatechangetrigger_mobilebroadbandradiostatechangetrigger_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger.MobileBroadbandRadioStateChangeTrigger ## -description Constructs a MobileBroadbandRadioStateChangeTrigger object. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandRadioStateChangeTrigger.MobileBroadbandRadioStateChangeTrigger + +## -description +Constructs a MobileBroadbandRadioStateChangeTrigger object. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger.md b/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger.md index b7b003b88a..24a4ad4943 100644 --- a/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger.md +++ b/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger ## -description Represents a trigger that indicates when mobile broadband registration state has changed. For example, this trigger activates when a mobile device transitions to or from Roaming. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandNetworkRegistrationStateChangeTriggerDetails](../windows.networking.networkoperators/mobilebroadbandnetworkregistrationstatechangetriggerdetails.md) instance. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger + +## -description +Represents a trigger that indicates when mobile broadband registration state has changed. For example, this trigger activates when a mobile device transitions to or from Roaming. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +When this trigger activates, the [IBackgroundTaskInstance.TriggerDetails](ibackgroundtaskinstance_triggerdetails.md) for the background task is a [MobileBroadbandNetworkRegistrationStateChangeTriggerDetails](../windows.networking.networkoperators/mobilebroadbandnetworkregistrationstatechangetriggerdetails.md) instance. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger_mobilebroadbandregistrationstatechangetrigger_1221375020.md b/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger_mobilebroadbandregistrationstatechangetrigger_1221375020.md index e2ab2636fb..342b41f1d5 100644 --- a/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger_mobilebroadbandregistrationstatechangetrigger_1221375020.md +++ b/windows.applicationmodel.background/mobilebroadbandregistrationstatechangetrigger_mobilebroadbandregistrationstatechangetrigger_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger.MobileBroadbandRegistrationStateChangeTrigger ## -description Creates a MobileBroadbandRegistrationStateChangeTrigger object. This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.MobileBroadbandRegistrationStateChangeTrigger.MobileBroadbandRegistrationStateChangeTrigger + +## -description +Creates a MobileBroadbandRegistrationStateChangeTrigger object. + +This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. For more information, see [Mobile Broadband: ](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/networkoperatorhotspotauthenticationtrigger_networkoperatorhotspotauthenticationtrigger_1221375020.md b/windows.applicationmodel.background/networkoperatorhotspotauthenticationtrigger_networkoperatorhotspotauthenticationtrigger_1221375020.md index 78a9cfe206..7b4a93d0c3 100644 --- a/windows.applicationmodel.background/networkoperatorhotspotauthenticationtrigger_networkoperatorhotspotauthenticationtrigger_1221375020.md +++ b/windows.applicationmodel.background/networkoperatorhotspotauthenticationtrigger_networkoperatorhotspotauthenticationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.NetworkOperatorHotspotAuthenticationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.NetworkOperatorHotspotAuthenticationTrigger.NetworkOperatorHotspotAuthenticationTrigger ## -description Initializes a new instance of a mobile network operator hotspot authentication trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.NetworkOperatorHotspotAuthenticationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.NetworkOperatorHotspotAuthenticationTrigger.NetworkOperatorHotspotAuthenticationTrigger + +## -description +Initializes a new instance of a mobile network operator hotspot authentication trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/networkoperatornotificationtrigger_networkaccountid.md b/windows.applicationmodel.background/networkoperatornotificationtrigger_networkaccountid.md index bee822e205..82d987f4e7 100644 --- a/windows.applicationmodel.background/networkoperatornotificationtrigger_networkaccountid.md +++ b/windows.applicationmodel.background/networkoperatornotificationtrigger_networkaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.NetworkAccountId --api-type: winrt property ---- # Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.NetworkAccountId ## -description Gets the account identifier for the mobile network operator notification trigger. ## -property-value A unique identifier for the mobile broadband account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.NetworkAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.NetworkAccountId + +## -description +Gets the account identifier for the mobile network operator notification trigger. + +## -property-value +A unique identifier for the mobile broadband account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/networkoperatornotificationtrigger_networkoperatornotificationtrigger_290278668.md b/windows.applicationmodel.background/networkoperatornotificationtrigger_networkoperatornotificationtrigger_290278668.md index 82d2d0d7aa..f2bd42b3ad 100644 --- a/windows.applicationmodel.background/networkoperatornotificationtrigger_networkoperatornotificationtrigger_290278668.md +++ b/windows.applicationmodel.background/networkoperatornotificationtrigger_networkoperatornotificationtrigger_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.NetworkOperatorNotificationTrigger ## -description Initializes a new instance of a mobile network operator notification. ## -parameters ### -param networkAccountId Specifies the unique identifier of the mobile broadband account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger.NetworkOperatorNotificationTrigger + +## -description +Initializes a new instance of a mobile network operator notification. + +## -parameters +### -param networkAccountId +Specifies the unique identifier of the mobile broadband account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/phonetrigger.md b/windows.applicationmodel.background/phonetrigger.md index f39a021cc0..a8001e6ecc 100644 --- a/windows.applicationmodel.background/phonetrigger.md +++ b/windows.applicationmodel.background/phonetrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.PhoneTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.PhoneTrigger ## -description Represents a phone event that triggers a background task. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.PhoneTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.PhoneTrigger + +## -description +Represents a phone event that triggers a background task. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file diff --git a/windows.applicationmodel.background/phonetrigger_oneshot.md b/windows.applicationmodel.background/phonetrigger_oneshot.md index 86912100ef..ba8dc47441 100644 --- a/windows.applicationmodel.background/phonetrigger_oneshot.md +++ b/windows.applicationmodel.background/phonetrigger_oneshot.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Background.PhoneTrigger.OneShot --api-type: winrt property ---- # Windows.ApplicationModel.Background.PhoneTrigger.OneShot ## -description Gets a Boolean value indicating if the trigger is a one-shot notification. ## -property-value A Boolean value indicating if the trigger is a one-shot notification. ## -remarks If you weren't subscribed when a one-shot notification was sent, you get nothing. If you weren't connected when you fired a one-shot notification, nothing happens. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.PhoneTrigger.OneShot +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.PhoneTrigger.OneShot + +## -description +Gets a Boolean value indicating if the trigger is a one-shot notification. + +## -property-value +A Boolean value indicating if the trigger is a one-shot notification. + +## -remarks +If you weren't subscribed when a one-shot notification was sent, you get nothing. If you weren't connected when you fired a one-shot notification, nothing happens. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/phonetrigger_phonetrigger_1524374098.md b/windows.applicationmodel.background/phonetrigger_phonetrigger_1524374098.md index 5135e6de04..fe8d0b9196 100644 --- a/windows.applicationmodel.background/phonetrigger_phonetrigger_1524374098.md +++ b/windows.applicationmodel.background/phonetrigger_phonetrigger_1524374098.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Background.PhoneTrigger.#ctor(Windows.ApplicationModel.Calls.Background.PhoneTriggerType,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.PhoneTrigger.PhoneTrigger ## -description Initializes a new instance of the [PhoneTrigger](phonetrigger.md) class. ## -parameters ### -param type Specifies the type of phone event. ### -param oneShot Indicates if the trigger is a one-shot notification. If you weren't subscribed when a one-shot notification was sent, you get nothing. If you weren't connected when you fired a one-shot notification, nothing happens. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.PhoneTrigger.#ctor(Windows.ApplicationModel.Calls.Background.PhoneTriggerType,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.PhoneTrigger.PhoneTrigger + +## -description +Initializes a new instance of the [PhoneTrigger](phonetrigger.md) class. + +## -parameters +### -param type +Specifies the type of phone event. + +### -param oneShot +Indicates if the trigger is a one-shot notification. If you weren't subscribed when a one-shot notification was sent, you get nothing. If you weren't connected when you fired a one-shot notification, nothing happens. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/phonetrigger_triggertype.md b/windows.applicationmodel.background/phonetrigger_triggertype.md index aeeee6ffa3..d80d82a0ef 100644 --- a/windows.applicationmodel.background/phonetrigger_triggertype.md +++ b/windows.applicationmodel.background/phonetrigger_triggertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.PhoneTrigger.TriggerType --api-type: winrt property ---- # Windows.ApplicationModel.Background.PhoneTrigger.TriggerType ## -description Gets the type of phone event indicated by the trigger. ## -property-value The type of phone event indicated by the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.PhoneTrigger.TriggerType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.PhoneTrigger.TriggerType + +## -description +Gets the type of phone event indicated by the trigger. + +## -property-value +The type of phone event indicated by the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_1221375020.md b/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_1221375020.md index d2d2d11e18..5b1b4aaa85 100644 --- a/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_1221375020.md +++ b/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Background.PushNotificationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.PushNotificationTrigger.PushNotificationTrigger ## -description Invokes a background work item on the app in response to the receipt of a [raw notification](../windows.networking.pushnotifications/rawnotification.md). ## -remarks ## -examples ## -see-also [PushNotificationTrigger(String)](pushnotificationtrigger_pushnotificationtrigger_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.PushNotificationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.PushNotificationTrigger.PushNotificationTrigger + +## -description +Invokes a background work item on the app in response to the receipt of a [raw notification](../windows.networking.pushnotifications/rawnotification.md). + +## -remarks + +## -examples + +## -see-also +[PushNotificationTrigger(String)](pushnotificationtrigger_pushnotificationtrigger_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_290278668.md b/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_290278668.md index 9bd124f6a9..7ecf219b88 100644 --- a/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_290278668.md +++ b/windows.applicationmodel.background/pushnotificationtrigger_pushnotificationtrigger_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.PushNotificationTrigger.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.PushNotificationTrigger.PushNotificationTrigger ## -description Invokes a background work item on a specified app in response to the receipt of a [raw notification](../windows.networking.pushnotifications/rawnotification.md). ## -parameters ### -param applicationId The app's Package Relative Application ID (PRAID). The specified app must be in the same package as the calling app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.PushNotificationTrigger.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.PushNotificationTrigger.PushNotificationTrigger + +## -description +Invokes a background work item on a specified app in response to the receipt of a [raw notification](../windows.networking.pushnotifications/rawnotification.md). + +## -parameters +### -param applicationId +The app's Package Relative Application ID (PRAID). The specified app must be in the same package as the calling app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rcsendusermessageavailabletrigger.md b/windows.applicationmodel.background/rcsendusermessageavailabletrigger.md index 419996c769..3e0b101499 100644 --- a/windows.applicationmodel.background/rcsendusermessageavailabletrigger.md +++ b/windows.applicationmodel.background/rcsendusermessageavailabletrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger ## -description Represents a trigger that launches a background task when a new Rich Communication Services (RCS) message is available. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger + +## -description +Represents a trigger that launches a background task when a new Rich Communication Services (RCS) message is available. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/rcsendusermessageavailabletrigger_rcsendusermessageavailabletrigger_1221375020.md b/windows.applicationmodel.background/rcsendusermessageavailabletrigger_rcsendusermessageavailabletrigger_1221375020.md index 36566b0626..4d296a56d4 100644 --- a/windows.applicationmodel.background/rcsendusermessageavailabletrigger_rcsendusermessageavailabletrigger_1221375020.md +++ b/windows.applicationmodel.background/rcsendusermessageavailabletrigger_rcsendusermessageavailabletrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger.RcsEndUserMessageAvailableTrigger ## -description Initializes a new instance of the [RcsEndUserMessageAvailableTrigger](rcsendusermessageavailabletrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.RcsEndUserMessageAvailableTrigger.RcsEndUserMessageAvailableTrigger + +## -description +Initializes a new instance of the [RcsEndUserMessageAvailableTrigger](rcsendusermessageavailabletrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger.md b/windows.applicationmodel.background/rfcommconnectiontrigger.md index 7f91b914e1..a1b4f7ef29 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.RfcommConnectionTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger ## -description Represents a trigger that launches a background task when an RFCOMM inbound or outbound connections are established. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.RfcommConnectionTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger + +## -description +Represents a trigger that launches a background task when an RFCOMM inbound or outbound connections are established. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_allowmultipleconnections.md b/windows.applicationmodel.background/rfcommconnectiontrigger_allowmultipleconnections.md index 030d8023e5..437dfbd582 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_allowmultipleconnections.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_allowmultipleconnections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.AllowMultipleConnections --api-type: winrt property ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger.AllowMultipleConnections ## -description Gets or sets whether the app wants to handle multiple connections at a time. ## -property-value True if the app wants to handle multiple connections at a time; Otherwise False. The default is False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.AllowMultipleConnections +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger.AllowMultipleConnections + +## -description +Gets or sets whether the app wants to handle multiple connections at a time. + +## -property-value +True if the app wants to handle multiple connections at a time; Otherwise False. The default is False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md b/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md index 51cd1b43f8..71717b1f41 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.InboundConnection --api-type: winrt property ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger.InboundConnection ## -description Gets or sets the [RfcommInboundConnectionInformation](rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. ## -property-value The [RfcommInboundConnectionInformation](rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. The default is null. ## -remarks If this property is null, the system will not listen for incoming connections. At least one of the [InboundConnection](rfcommconnectiontrigger_inboundconnection.md) and [OutboundConnection](rfcommconnectiontrigger_outboundconnection.md) properties must be non-null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.InboundConnection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger.InboundConnection + +## -description +Gets or sets the [RfcommInboundConnectionInformation](rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. + +## -property-value +The [RfcommInboundConnectionInformation](rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. The default is null. + +## -remarks +If this property is null, the system will not listen for incoming connections. + +At least one of the [InboundConnection](rfcommconnectiontrigger_inboundconnection.md) and [OutboundConnection](rfcommconnectiontrigger_outboundconnection.md) properties must be non-null. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md b/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md index d3fe6823f4..f0cae8f6bb 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.OutboundConnection --api-type: winrt property ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger.OutboundConnection ## -description Gets or sets the [RfcommOutboundConnectionInformation](rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. ## -property-value The [RfcommOutboundConnectionInformation](rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. The default is null. ## -remarks If this property is null, the system will not create outgoing connections. At least one of the [InboundConnection](rfcommconnectiontrigger_inboundconnection.md) and [OutboundConnection](rfcommconnectiontrigger_outboundconnection.md) properties must be non-null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.OutboundConnection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger.OutboundConnection + +## -description +Gets or sets the [RfcommOutboundConnectionInformation](rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. + +## -property-value +The [RfcommOutboundConnectionInformation](rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. The default is null. + +## -remarks +If this property is null, the system will not create outgoing connections. + +At least one of the [InboundConnection](rfcommconnectiontrigger_inboundconnection.md) and [OutboundConnection](rfcommconnectiontrigger_outboundconnection.md) properties must be non-null. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_protectionlevel.md b/windows.applicationmodel.background/rfcommconnectiontrigger_protectionlevel.md index 02ca9b63f7..d0e9d8eee2 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_protectionlevel.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_protectionlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.ProtectionLevel --api-type: winrt property ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger.ProtectionLevel ## -description Gets or sets the minimum protection level required for connections that are created or accepted on behalf of the app. ## -property-value The minimum protection level required for connections that are created or accepted on behalf of the app. The default is BluetoothEncryptionWithAuthentication. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.ProtectionLevel +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger.ProtectionLevel + +## -description +Gets or sets the minimum protection level required for connections that are created or accepted on behalf of the app. + +## -property-value +The minimum protection level required for connections that are created or accepted on behalf of the app. The default is BluetoothEncryptionWithAuthentication. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_remotehostname.md b/windows.applicationmodel.background/rfcommconnectiontrigger_remotehostname.md index fa7fbe12a6..5e73eaf7ef 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_remotehostname.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_remotehostname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.RemoteHostName --api-type: winrt property ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger.RemoteHostName ## -description Gets or sets specific remote Bluetooth device the system will connect to, or accept connections from, on behalf of the app. ## -property-value Gets or sets specific remote Bluetooth device the system will connect to, or accept connections from, on behalf of the app. If this property is not set, the system will connect to and/or accept connections from any paired Bluetooth device that supports the relevant service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.RfcommConnectionTrigger.RemoteHostName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger.RemoteHostName + +## -description +Gets or sets specific remote Bluetooth device the system will connect to, or accept connections from, on behalf of the app. + +## -property-value +Gets or sets specific remote Bluetooth device the system will connect to, or accept connections from, on behalf of the app. If this property is not set, the system will connect to and/or accept connections from any paired Bluetooth device that supports the relevant service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_rfcommconnectiontrigger_1221375020.md b/windows.applicationmodel.background/rfcommconnectiontrigger_rfcommconnectiontrigger_1221375020.md index 64eae9919c..445c58e7cb 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_rfcommconnectiontrigger_1221375020.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_rfcommconnectiontrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.RfcommConnectionTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.RfcommConnectionTrigger.RfcommConnectionTrigger ## -description Initializes a new instance of the RfcommConnectionTrigger class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.RfcommConnectionTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.RfcommConnectionTrigger.RfcommConnectionTrigger + +## -description +Initializes a new instance of the RfcommConnectionTrigger class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger.md b/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger.md index d60884b79c..c15c93c41d 100644 --- a/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger.md +++ b/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger ## -description Represents a trigger that launches a background task on behalf of a companion device. ## -remarks A companion device acts in conjunction with your Windows 10 for desktop editions (Home, Pro, Enterprise, and Education) or Windows 10 Mobile device to enhance the user authentication experience. For instance, a user may attach their companion device to PC via USB, touch the fingerprint reader on the companion device, which automatically unlocks their PC. When the companion device app registers the first companion device, it should also register its background task component which will pass authentication information between device and companion device authentication service. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger + +## -description +Represents a trigger that launches a background task on behalf of a companion device. + +## -remarks +A companion device acts in conjunction with your Windows 10 for desktop editions (Home, Pro, Enterprise, and Education) or Windows 10 Mobile device to enhance the user authentication experience. For instance, a user may attach their companion device to PC via USB, touch the fingerprint reader on the companion device, which automatically unlocks their PC. + +When the companion device app registers the first companion device, it should also register its background task component which will pass authentication information between device and companion device authentication service. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger_secondaryauthenticationfactorauthenticationtrigger_1221375020.md b/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger_secondaryauthenticationfactorauthenticationtrigger_1221375020.md index 7695b47181..0cb09d3eaf 100644 --- a/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger_secondaryauthenticationfactorauthenticationtrigger_1221375020.md +++ b/windows.applicationmodel.background/secondaryauthenticationfactorauthenticationtrigger_secondaryauthenticationfactorauthenticationtrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger.SecondaryAuthenticationFactorAuthenticationTrigger ## -description Initializes a new instance of the [SecondaryAuthenticationFactorAuthenticationTrigger](secondaryauthenticationfactorauthenticationtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SecondaryAuthenticationFactorAuthenticationTrigger.SecondaryAuthenticationFactorAuthenticationTrigger + +## -description +Initializes a new instance of the [SecondaryAuthenticationFactorAuthenticationTrigger](secondaryauthenticationfactorauthenticationtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/sensordatathresholdtrigger.md b/windows.applicationmodel.background/sensordatathresholdtrigger.md index 25660f69f8..b682d540c8 100644 --- a/windows.applicationmodel.background/sensordatathresholdtrigger.md +++ b/windows.applicationmodel.background/sensordatathresholdtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.SensorDataThresholdTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.SensorDataThresholdTrigger ## -description Represents a trigger that responds when a threshold limit for a sensor is crossed. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.SensorDataThresholdTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.SensorDataThresholdTrigger + +## -description +Represents a trigger that responds when a threshold limit for a sensor is crossed. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/sensordatathresholdtrigger_sensordatathresholdtrigger_347632786.md b/windows.applicationmodel.background/sensordatathresholdtrigger_sensordatathresholdtrigger_347632786.md index b6ed70b37c..905920a249 100644 --- a/windows.applicationmodel.background/sensordatathresholdtrigger_sensordatathresholdtrigger_347632786.md +++ b/windows.applicationmodel.background/sensordatathresholdtrigger_sensordatathresholdtrigger_347632786.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SensorDataThresholdTrigger.#ctor(Windows.Devices.Sensors.ISensorDataThreshold) --api-type: winrt method ---- # Windows.ApplicationModel.Background.SensorDataThresholdTrigger.SensorDataThresholdTrigger ## -description Initializes a new instance of the [SensorDataThresholdTrigger](sensordatathresholdtrigger.md) class. ## -parameters ### -param threshold The threshold for a sensor that indicates when it should be triggered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SensorDataThresholdTrigger.#ctor(Windows.Devices.Sensors.ISensorDataThreshold) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SensorDataThresholdTrigger.SensorDataThresholdTrigger + +## -description +Initializes a new instance of the [SensorDataThresholdTrigger](sensordatathresholdtrigger.md) class. + +## -parameters +### -param threshold +The threshold for a sensor that indicates when it should be triggered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/smartcardtrigger.md b/windows.applicationmodel.background/smartcardtrigger.md index 4b7b3565c5..a2d7b965d2 100644 --- a/windows.applicationmodel.background/smartcardtrigger.md +++ b/windows.applicationmodel.background/smartcardtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.SmartCardTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.SmartCardTrigger ## -description Represents an event triggered by a smart card. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.SmartCardTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.SmartCardTrigger + +## -description +Represents an event triggered by a smart card. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/smartcardtrigger_smartcardtrigger_2104100515.md b/windows.applicationmodel.background/smartcardtrigger_smartcardtrigger_2104100515.md index 1be190a692..925f9f098e 100644 --- a/windows.applicationmodel.background/smartcardtrigger_smartcardtrigger_2104100515.md +++ b/windows.applicationmodel.background/smartcardtrigger_smartcardtrigger_2104100515.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SmartCardTrigger.#ctor(Windows.Devices.SmartCards.SmartCardTriggerType) --api-type: winrt method ---- # Windows.ApplicationModel.Background.SmartCardTrigger.SmartCardTrigger ## -description Initializes a new instance of a SmartCardTrigger ## -parameters ### -param triggerType The trigger type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SmartCardTrigger.#ctor(Windows.Devices.SmartCards.SmartCardTriggerType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SmartCardTrigger.SmartCardTrigger + +## -description +Initializes a new instance of a SmartCardTrigger + +## -parameters +### -param triggerType +The trigger type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/smartcardtrigger_triggertype.md b/windows.applicationmodel.background/smartcardtrigger_triggertype.md index dd666c58bc..0151df8cf0 100644 --- a/windows.applicationmodel.background/smartcardtrigger_triggertype.md +++ b/windows.applicationmodel.background/smartcardtrigger_triggertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.SmartCardTrigger.TriggerType --api-type: winrt property ---- # Windows.ApplicationModel.Background.SmartCardTrigger.TriggerType ## -description Gets the trigger type of a smart card trigger. ## -property-value A SmartCardTriggerType. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.SmartCardTrigger.TriggerType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.SmartCardTrigger.TriggerType + +## -description +Gets the trigger type of a smart card trigger. + +## -property-value +A SmartCardTriggerType. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/smsmessagereceivedtrigger.md b/windows.applicationmodel.background/smsmessagereceivedtrigger.md index 676572bf1d..00ec031a64 100644 --- a/windows.applicationmodel.background/smsmessagereceivedtrigger.md +++ b/windows.applicationmodel.background/smsmessagereceivedtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.SmsMessageReceivedTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.SmsMessageReceivedTrigger ## -description Represents a trigger that is raised when an SMS message has arrived. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.SmsMessageReceivedTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.SmsMessageReceivedTrigger + +## -description +Represents a trigger that is raised when an SMS message has arrived. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/smsmessagereceivedtrigger_smsmessagereceivedtrigger_1069873048.md b/windows.applicationmodel.background/smsmessagereceivedtrigger_smsmessagereceivedtrigger_1069873048.md index 35106ff94a..a0eae320a3 100644 --- a/windows.applicationmodel.background/smsmessagereceivedtrigger_smsmessagereceivedtrigger_1069873048.md +++ b/windows.applicationmodel.background/smsmessagereceivedtrigger_smsmessagereceivedtrigger_1069873048.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SmsMessageReceivedTrigger.#ctor(Windows.Devices.Sms.SmsFilterRules) --api-type: winrt method ---- # Windows.ApplicationModel.Background.SmsMessageReceivedTrigger.SmsMessageReceivedTrigger ## -description Initializes a new instance of an SMS message received trigger. ## -parameters ### -param filterRules Filter rules to be applied to incoming SMS messages. Only messages that pass through the filter rules raise the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SmsMessageReceivedTrigger.#ctor(Windows.Devices.Sms.SmsFilterRules) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SmsMessageReceivedTrigger.SmsMessageReceivedTrigger + +## -description +Initializes a new instance of an SMS message received trigger. + +## -parameters +### -param filterRules +Filter rules to be applied to incoming SMS messages. Only messages that pass through the filter rules raise the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/socketactivitytrigger.md b/windows.applicationmodel.background/socketactivitytrigger.md index 910f453e7b..90ed8829f8 100644 --- a/windows.applicationmodel.background/socketactivitytrigger.md +++ b/windows.applicationmodel.background/socketactivitytrigger.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Background.SocketActivityTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.SocketActivityTrigger ## -description Represents a trigger that launches a background task for handling socket activity. ## -remarks For information about how to use this event and the socket broker with your app, see [Network communications in the background](https://msdn.microsoft.com/en-us/windows/uwp/networking/network-communications-in-the-background). ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md), [DatagramSocket sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620534), [StreamSocket sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620609) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.SocketActivityTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.SocketActivityTrigger + +## -description +Represents a trigger that launches a background task for handling socket activity. + +## -remarks +For information about how to use this event and the socket broker with your app, see [Network communications in the background](https://msdn.microsoft.com/en-us/windows/uwp/networking/network-communications-in-the-background). + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md), [DatagramSocket sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620534), [StreamSocket sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620609) \ No newline at end of file diff --git a/windows.applicationmodel.background/socketactivitytrigger_iswakefromlowpowersupported.md b/windows.applicationmodel.background/socketactivitytrigger_iswakefromlowpowersupported.md index 23e3bf8ab2..f6ab297341 100644 --- a/windows.applicationmodel.background/socketactivitytrigger_iswakefromlowpowersupported.md +++ b/windows.applicationmodel.background/socketactivitytrigger_iswakefromlowpowersupported.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Background.SocketActivityTrigger.IsWakeFromLowPowerSupported --api-type: winrt property ---- # Windows.ApplicationModel.Background.SocketActivityTrigger.IsWakeFromLowPowerSupported ## -description Gets whether a [SocketActivityTrigger](socketactivitytrigger.md) can wake the machine from a low power state. ## -property-value **True** indicates that this trigger can wake the machine from a low power state; **false** otherwise. ## -remarks This trigger is registered such that when there is new data available on the socket it will wake the device and activate the background task. On devices that don't support always on, always connected (AOAC), the device will not be awakened to trigger the background task. Devices that support AOAC can be put into standby mode without fully powering down. In this mode it can maintain network connectivity. On these devices, a trigger can wake up the device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.SocketActivityTrigger.IsWakeFromLowPowerSupported +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.SocketActivityTrigger.IsWakeFromLowPowerSupported + +## -description +Gets whether a [SocketActivityTrigger](socketactivitytrigger.md) can wake the machine from a low power state. + +## -property-value +**True** indicates that this trigger can wake the machine from a low power state; **false** otherwise. + +## -remarks +This trigger is registered such that when there is new data available on the socket it will wake the device and activate the background task. On devices that don't support always on, always connected (AOAC), the device will not be awakened to trigger the background task. + +Devices that support AOAC can be put into standby mode without fully powering down. In this mode it can maintain network connectivity. On these devices, a trigger can wake up the device. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/socketactivitytrigger_socketactivitytrigger_1221375020.md b/windows.applicationmodel.background/socketactivitytrigger_socketactivitytrigger_1221375020.md index d555d09f20..6cd24167df 100644 --- a/windows.applicationmodel.background/socketactivitytrigger_socketactivitytrigger_1221375020.md +++ b/windows.applicationmodel.background/socketactivitytrigger_socketactivitytrigger_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SocketActivityTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.SocketActivityTrigger.SocketActivityTrigger ## -description Initializes a new instance of a socket activity trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SocketActivityTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SocketActivityTrigger.SocketActivityTrigger + +## -description +Initializes a new instance of a socket activity trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/storagelibrarycontentchangedtrigger.md b/windows.applicationmodel.background/storagelibrarycontentchangedtrigger.md index d887b7ca32..cbecfa06ef 100644 --- a/windows.applicationmodel.background/storagelibrarycontentchangedtrigger.md +++ b/windows.applicationmodel.background/storagelibrarycontentchangedtrigger.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger ## -description Creates a trigger that will fire when a file is changed in a specified library. ## -remarks Once you create a trigger, register it with a background task ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger + +## -description +Creates a trigger that will fire when a file is changed in a specified library. + +## -remarks +Once you create a trigger, register it with a background task + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_create_1791269264.md b/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_create_1791269264.md index 5503371cda..6832d9039b 100644 --- a/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_create_1791269264.md +++ b/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_create_1791269264.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.Create(Windows.Storage.StorageLibrary) --api-type: winrt method ---- # Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.Create ## -description Creates a trigger that will fire when a file is changed in the specified library. ## -parameters ### -param storageLibrary The location that the trigger monitors such as the music library or documents library. ## -returns A trigger that monitors the specified location. ## -remarks ## -examples ```csharp //Get access to the library that you want to monitor StorageLibrary picturesLibrary = await StorageLibrary.GetLibraryAsync(KnownLibraryId.Pictures); var trigger = StorageLibraryContentChangedTrigger.Create(picturesLibrary); ``` ## -see-also [GetLibraryAsync](../windows.storage/storagelibrary_getlibraryasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.Create(Windows.Storage.StorageLibrary) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.Create + +## -description +Creates a trigger that will fire when a file is changed in the specified library. + +## -parameters +### -param storageLibrary +The location that the trigger monitors such as the music library or documents library. + +## -returns +A trigger that monitors the specified location. + +## -remarks + +## -examples +```csharp +//Get access to the library that you want to monitor +StorageLibrary picturesLibrary = await StorageLibrary.GetLibraryAsync(KnownLibraryId.Pictures); +var trigger = StorageLibraryContentChangedTrigger.Create(picturesLibrary); +``` + + + +## -see-also +[GetLibraryAsync](../windows.storage/storagelibrary_getlibraryasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_createfromlibraries_1376661184.md b/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_createfromlibraries_1376661184.md index e3b9f037b1..b52d3549c4 100644 --- a/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_createfromlibraries_1376661184.md +++ b/windows.applicationmodel.background/storagelibrarycontentchangedtrigger_createfromlibraries_1376661184.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.CreateFromLibraries(Windows.Foundation.Collections.IIterable{Windows.Storage.StorageLibrary}) --api-type: winrt method ---- # Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.CreateFromLibraries ## -description Creates a trigger that will fire when a file is changed in any of the specified libraries. ## -parameters ### -param storageLibraries The list of libraries that the trigger will monitor. ## -returns A trigger that monitors the specified location(s). ## -remarks ## -examples ## -see-also [GetLibraryAsync](../windows.storage/storagelibrary_getlibraryasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.CreateFromLibraries(Windows.Foundation.Collections.IIterable{Windows.Storage.StorageLibrary}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.StorageLibraryContentChangedTrigger.CreateFromLibraries + +## -description +Creates a trigger that will fire when a file is changed in any of the specified libraries. + +## -parameters +### -param storageLibraries +The list of libraries that the trigger will monitor. + +## -returns +A trigger that monitors the specified location(s). + +## -remarks + +## -examples + +## -see-also +[GetLibraryAsync](../windows.storage/storagelibrary_getlibraryasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/systemcondition_conditiontype.md b/windows.applicationmodel.background/systemcondition_conditiontype.md index 083a6454c9..9d8b60c51f 100644 --- a/windows.applicationmodel.background/systemcondition_conditiontype.md +++ b/windows.applicationmodel.background/systemcondition_conditiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.SystemCondition.ConditionType --api-type: winrt property ---- # Windows.ApplicationModel.Background.SystemCondition.ConditionType ## -description Gets the condition type of a system condition. ## -property-value The condition that must be in effect for the background task to run. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.SystemCondition.ConditionType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.SystemCondition.ConditionType + +## -description +Gets the condition type of a system condition. + +## -property-value +The condition that must be in effect for the background task to run. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/systemcondition_systemcondition_651624867.md b/windows.applicationmodel.background/systemcondition_systemcondition_651624867.md index 4bb6e1eb49..050e1787d0 100644 --- a/windows.applicationmodel.background/systemcondition_systemcondition_651624867.md +++ b/windows.applicationmodel.background/systemcondition_systemcondition_651624867.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SystemCondition.#ctor(Windows.ApplicationModel.Background.SystemConditionType) --api-type: winrt method ---- # Windows.ApplicationModel.Background.SystemCondition.SystemCondition ## -description Initializes a new instance of a system condition. ## -parameters ### -param conditionType Specifies the condition type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SystemCondition.#ctor(Windows.ApplicationModel.Background.SystemConditionType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SystemCondition.SystemCondition + +## -description +Initializes a new instance of a system condition. + +## -parameters +### -param conditionType +Specifies the condition type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/systemtrigger_oneshot.md b/windows.applicationmodel.background/systemtrigger_oneshot.md index 13d7467311..91a42c6ac3 100644 --- a/windows.applicationmodel.background/systemtrigger_oneshot.md +++ b/windows.applicationmodel.background/systemtrigger_oneshot.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.SystemTrigger.OneShot --api-type: winrt property ---- # Windows.ApplicationModel.Background.SystemTrigger.OneShot ## -description Gets whether a system event trigger will be used only once. ## -property-value True if the system event trigger will be used only once; false if it will be used every time the event occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.SystemTrigger.OneShot +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.SystemTrigger.OneShot + +## -description +Gets whether a system event trigger will be used only once. + +## -property-value +True if the system event trigger will be used only once; false if it will be used every time the event occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/systemtrigger_systemtrigger_1157162657.md b/windows.applicationmodel.background/systemtrigger_systemtrigger_1157162657.md index 514de2fe50..df9ccd7327 100644 --- a/windows.applicationmodel.background/systemtrigger_systemtrigger_1157162657.md +++ b/windows.applicationmodel.background/systemtrigger_systemtrigger_1157162657.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Background.SystemTrigger.#ctor(Windows.ApplicationModel.Background.SystemTriggerType,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.SystemTrigger.SystemTrigger ## -description Initializes a new instance of a system event trigger. ## -parameters ### -param triggerType Specifies the system event type. ### -param oneShot True if the system event trigger will be used once; false if it will be used every time the event occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.SystemTrigger.#ctor(Windows.ApplicationModel.Background.SystemTriggerType,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.SystemTrigger.SystemTrigger + +## -description +Initializes a new instance of a system event trigger. + +## -parameters +### -param triggerType +Specifies the system event type. + +### -param oneShot +True if the system event trigger will be used once; false if it will be used every time the event occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/systemtrigger_triggertype.md b/windows.applicationmodel.background/systemtrigger_triggertype.md index 599f2e94e4..69a9ec282e 100644 --- a/windows.applicationmodel.background/systemtrigger_triggertype.md +++ b/windows.applicationmodel.background/systemtrigger_triggertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.SystemTrigger.TriggerType --api-type: winrt property ---- # Windows.ApplicationModel.Background.SystemTrigger.TriggerType ## -description Gets the system event type of a system event trigger. ## -property-value A system event type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.SystemTrigger.TriggerType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.SystemTrigger.TriggerType + +## -description +Gets the system event type of a system event trigger. + +## -property-value +A system event type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/timetrigger_freshnesstime.md b/windows.applicationmodel.background/timetrigger_freshnesstime.md index 89deb3c7ff..f83b764afc 100644 --- a/windows.applicationmodel.background/timetrigger_freshnesstime.md +++ b/windows.applicationmodel.background/timetrigger_freshnesstime.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Background.TimeTrigger.FreshnessTime --api-type: winrt property ---- # Windows.ApplicationModel.Background.TimeTrigger.FreshnessTime ## -description Gets the interval of a time event trigger. ## -property-value Specifies the number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after [FreshnessTime](timetrigger_freshnesstime.md) elapses. ## -remarks The system uses a 15-minute tick frequency for timer requests. A time-triggered background task is scheduled on the next tick after [FreshnessTime](timetrigger_freshnesstime.md) elapses. If the [OneShot](timetrigger_oneshot.md) property is false, [FreshnessTime](timetrigger_freshnesstime.md) specifies the interval for a recurring task. > [!NOTE] > If *FreshnessTime* is set to less than 15 minutes, an exception is thrown when attempting to register the background task. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.TimeTrigger.FreshnessTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.TimeTrigger.FreshnessTime + +## -description +Gets the interval of a time event trigger. + +## -property-value +Specifies the number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after [FreshnessTime](timetrigger_freshnesstime.md) elapses. + +## -remarks +The system uses a 15-minute tick frequency for timer requests. A time-triggered background task is scheduled on the next tick after [FreshnessTime](timetrigger_freshnesstime.md) elapses. If the [OneShot](timetrigger_oneshot.md) property is false, [FreshnessTime](timetrigger_freshnesstime.md) specifies the interval for a recurring task. + + + +> [!NOTE] +> If *FreshnessTime* is set to less than 15 minutes, an exception is thrown when attempting to register the background task. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/timetrigger_oneshot.md b/windows.applicationmodel.background/timetrigger_oneshot.md index fb11500f7f..515226b667 100644 --- a/windows.applicationmodel.background/timetrigger_oneshot.md +++ b/windows.applicationmodel.background/timetrigger_oneshot.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Background.TimeTrigger.OneShot --api-type: winrt property ---- # Windows.ApplicationModel.Background.TimeTrigger.OneShot ## -description Gets whether the time event trigger will be used only once or each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. ## -property-value True if the time event trigger will be used once; false if it will be used each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.TimeTrigger.OneShot +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.TimeTrigger.OneShot + +## -description +Gets whether the time event trigger will be used only once or each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. + +## -property-value +True if the time event trigger will be used once; false if it will be used each time the [FreshnessTime](timetrigger_freshnesstime.md) interval elapses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/timetrigger_timetrigger_693505325.md b/windows.applicationmodel.background/timetrigger_timetrigger_693505325.md index 807da4fc5f..95f03ff7f6 100644 --- a/windows.applicationmodel.background/timetrigger_timetrigger_693505325.md +++ b/windows.applicationmodel.background/timetrigger_timetrigger_693505325.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Background.TimeTrigger.#ctor(System.UInt32,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Background.TimeTrigger.TimeTrigger ## -description Initializes a new instance of a time event trigger. ## -parameters ### -param freshnessTime Specifies the number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after *freshnessTime* elapses. If the [OneShot](timetrigger_oneshot.md) property is false, *freshnessTime* specifies the interval between recurring tasks. > [!NOTE] > If *FreshnessTime* is set to less than 15 minutes, an exception is thrown when attempting to register the background task. ### -param oneShot True if the time event trigger will be used once; false if it will be used each time *freshnessTime* elapses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.TimeTrigger.#ctor(System.UInt32,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.TimeTrigger.TimeTrigger + +## -description +Initializes a new instance of a time event trigger. + +## -parameters +### -param freshnessTime +Specifies the number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after *freshnessTime* elapses. If the [OneShot](timetrigger_oneshot.md) property is false, *freshnessTime* specifies the interval between recurring tasks. + +> [!NOTE] +> If *FreshnessTime* is set to less than 15 minutes, an exception is thrown when attempting to register the background task. + +### -param oneShot +True if the time event trigger will be used once; false if it will be used each time *freshnessTime* elapses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/toastnotificationactiontrigger.md b/windows.applicationmodel.background/toastnotificationactiontrigger.md index fd6358cd1f..1194c82cee 100644 --- a/windows.applicationmodel.background/toastnotificationactiontrigger.md +++ b/windows.applicationmodel.background/toastnotificationactiontrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ToastNotificationActionTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ToastNotificationActionTrigger ## -description Represents an event that causes a background task to run when the user performs an action on an interactive toast notification. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ToastNotificationActionTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ToastNotificationActionTrigger + +## -description +Represents an event that causes a background task to run when the user performs an action on an interactive toast notification. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_1221375020.md b/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_1221375020.md index c653b70ede..1fd3e6ce7c 100644 --- a/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_1221375020.md +++ b/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ToastNotificationActionTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ToastNotificationActionTrigger.ToastNotificationActionTrigger ## -description Creates and initializes a new instance of the [ToastNotificationActionTrigger](toastnotificationactiontrigger.md) class. ## -remarks ## -examples ## -see-also [ToastNotificationActionTrigger(String)](toastnotificationactiontrigger_toastnotificationactiontrigger_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ToastNotificationActionTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ToastNotificationActionTrigger.ToastNotificationActionTrigger + +## -description +Creates and initializes a new instance of the [ToastNotificationActionTrigger](toastnotificationactiontrigger.md) class. + +## -remarks + +## -examples + +## -see-also +[ToastNotificationActionTrigger(String)](toastnotificationactiontrigger_toastnotificationactiontrigger_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_290278668.md b/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_290278668.md index 9d55b08a13..b296171f80 100644 --- a/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_290278668.md +++ b/windows.applicationmodel.background/toastnotificationactiontrigger_toastnotificationactiontrigger_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ToastNotificationActionTrigger.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.ToastNotificationActionTrigger.ToastNotificationActionTrigger ## -description Creates and initializes a new instance of the [ToastNotificationActionTrigger](toastnotificationactiontrigger.md) class for the app with the specified identifier. ## -parameters ### -param applicationId The identifier of the app for which you want to create an instance of the [ToastNotificationActionTrigger](toastnotificationactiontrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ToastNotificationActionTrigger.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ToastNotificationActionTrigger.ToastNotificationActionTrigger + +## -description +Creates and initializes a new instance of the [ToastNotificationActionTrigger](toastnotificationactiontrigger.md) class for the app with the specified identifier. + +## -parameters +### -param applicationId +The identifier of the app for which you want to create an instance of the [ToastNotificationActionTrigger](toastnotificationactiontrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/toastnotificationhistorychangedtrigger.md b/windows.applicationmodel.background/toastnotificationhistorychangedtrigger.md index 8351e063b3..c7afb0bfda 100644 --- a/windows.applicationmodel.background/toastnotificationhistorychangedtrigger.md +++ b/windows.applicationmodel.background/toastnotificationhistorychangedtrigger.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger ## -description Represents an event that causes a background task to run when the history of toast notifications for the app is cleared, when one or more toast notifications are added to or removed from the notification history for the app, or when one or more toast notifications for the app expire and are removed from the notification history. ## -remarks ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger + +## -description +Represents an event that causes a background task to run when the history of toast notifications for the app is cleared, when one or more toast notifications are added to or removed from the notification history for the app, or when one or more toast notifications for the app expire and are removed from the notification history. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_1221375020.md b/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_1221375020.md index 08b3ce0283..38c1b06023 100644 --- a/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_1221375020.md +++ b/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.ToastNotificationHistoryChangedTrigger ## -description Creates and initializes a new instance of the [ToastNotificationHistoryChangedTrigger](toastnotificationhistorychangedtrigger.md) class. ## -remarks ## -examples ## -see-also [ToastNotificationHistoryChangedTrigger(String)](toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.ToastNotificationHistoryChangedTrigger + +## -description +Creates and initializes a new instance of the [ToastNotificationHistoryChangedTrigger](toastnotificationhistorychangedtrigger.md) class. + +## -remarks + +## -examples + +## -see-also +[ToastNotificationHistoryChangedTrigger(String)](toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_290278668.md b/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_290278668.md index 42070eb15b..0f71c13454 100644 --- a/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_290278668.md +++ b/windows.applicationmodel.background/toastnotificationhistorychangedtrigger_toastnotificationhistorychangedtrigger_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.ToastNotificationHistoryChangedTrigger ## -description Creates and initializes a new instance of the [ToastNotificationHistoryChangedTrigger](toastnotificationhistorychangedtrigger.md) class for the app with the specified identifier. ## -parameters ### -param applicationId The identifier of the app for which you want to create an instance of the [ToastNotificationHistoryChangedTrigger](toastnotificationhistorychangedtrigger.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.ToastNotificationHistoryChangedTrigger.ToastNotificationHistoryChangedTrigger + +## -description +Creates and initializes a new instance of the [ToastNotificationHistoryChangedTrigger](toastnotificationhistorychangedtrigger.md) class for the app with the specified identifier. + +## -parameters +### -param applicationId +The identifier of the app for which you want to create an instance of the [ToastNotificationHistoryChangedTrigger](toastnotificationhistorychangedtrigger.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/usernotificationchangedtrigger.md b/windows.applicationmodel.background/usernotificationchangedtrigger.md index a47a648d9a..a54ebf4892 100644 --- a/windows.applicationmodel.background/usernotificationchangedtrigger.md +++ b/windows.applicationmodel.background/usernotificationchangedtrigger.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Background.UserNotificationChangedTrigger --api-type: winrt class ---- # Windows.ApplicationModel.Background.UserNotificationChangedTrigger ## -description Represents a trigger that fires when a [UserNotification](../windows.ui.notifications/usernotification.md) is added or removed. ## -remarks The user notification listener requires that explicit user permission be granted before it may be used. Call [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync.md) from the UI thread before attempting to access notifications. ## -examples ## -see-also [IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Background.UserNotificationChangedTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.UserNotificationChangedTrigger + +## -description +Represents a trigger that fires when a [UserNotification](../windows.ui.notifications/usernotification.md) is added or removed. + +## -remarks +The user notification listener requires that explicit user permission be granted before it may be used. Call [RequestAccessAsync](backgroundexecutionmanager_requestaccessasync.md) from the UI thread before attempting to access notifications. + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/usernotificationchangedtrigger_usernotificationchangedtrigger_1840734356.md b/windows.applicationmodel.background/usernotificationchangedtrigger_usernotificationchangedtrigger_1840734356.md index 6bdf167001..82fa99689e 100644 --- a/windows.applicationmodel.background/usernotificationchangedtrigger_usernotificationchangedtrigger_1840734356.md +++ b/windows.applicationmodel.background/usernotificationchangedtrigger_usernotificationchangedtrigger_1840734356.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Background.UserNotificationChangedTrigger.#ctor(Windows.UI.Notifications.NotificationKinds) --api-type: winrt method ---- # Windows.ApplicationModel.Background.UserNotificationChangedTrigger.UserNotificationChangedTrigger ## -description Initializes a new instance of the [UserNotificationChangedTrigger](usernotificationchangedtrigger.md) class. ## -parameters ### -param notificationKinds The kind of notification trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Background.UserNotificationChangedTrigger.#ctor(Windows.UI.Notifications.NotificationKinds) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.UserNotificationChangedTrigger.UserNotificationChangedTrigger + +## -description +Initializes a new instance of the [UserNotificationChangedTrigger](usernotificationchangedtrigger.md) class. + +## -parameters +### -param notificationKinds +The kind of notification trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails.md b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails.md index 9bc028915d..9f236479b3 100644 --- a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails.md +++ b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails ## -description Used to provide the details about a call that was just blocked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails + +## -description +Used to provide the details about a call that was just blocked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_callblockedreason.md b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_callblockedreason.md index 1f54b8b85e..7cebae9887 100644 --- a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_callblockedreason.md +++ b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_callblockedreason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.CallBlockedReason --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.CallBlockedReason ## -description Gets the reason why a phone call was blocked. ## -property-value The reason for blocking the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.CallBlockedReason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.CallBlockedReason + +## -description +Gets the reason why a phone call was blocked. + +## -property-value +The reason for blocking the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_lineid.md b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_lineid.md index 8bd19372ca..cf75381555 100644 --- a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_lineid.md +++ b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_lineid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.LineId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.LineId ## -description Gets the ID of the phone call that was just blocked. ## -property-value The ID of the blocked phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.LineId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.LineId + +## -description +Gets the ID of the phone call that was just blocked. + +## -property-value +The ID of the blocked phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_phonenumber.md b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_phonenumber.md index 952abca261..5c08499392 100644 --- a/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_phonenumber.md +++ b/windows.applicationmodel.calls.background/phonecallblockedtriggerdetails_phonenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.PhoneNumber --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.PhoneNumber ## -description Gets the phone number of the blocked call. ## -property-value The phone number of the call that was blocked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.PhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallBlockedTriggerDetails.PhoneNumber + +## -description +Gets the phone number of the blocked call. + +## -property-value +The phone number of the call that was blocked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md b/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md index 1f04c248a6..6473b26c2e 100644 --- a/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md +++ b/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails ## -description Used to provide the origin details of the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails + +## -description +Used to provide the origin details of the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_phonenumber.md b/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_phonenumber.md index 4058bd7a3e..3461a19079 100644 --- a/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_phonenumber.md +++ b/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_phonenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.PhoneNumber --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.PhoneNumber ## -description Gets the phone number for the origin of the phone call. ## -property-value The phone number of the phone call origin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.PhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.PhoneNumber + +## -description +Gets the phone number for the origin of the phone call. + +## -property-value +The phone number of the phone call origin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_requestid.md b/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_requestid.md index 687ce2e3dc..be46517ae8 100644 --- a/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_requestid.md +++ b/windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails_requestid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.RequestId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.RequestId ## -description Gets the unique identifier for this phone call. ## -property-value The unique identifier for this phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.RequestId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneCallOriginDataRequestTriggerDetails.RequestId + +## -description +Gets the unique identifier for this phone call. + +## -property-value +The unique identifier for this phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails.md b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails.md index 25c96101ae..1cd5d78f72 100644 --- a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails.md +++ b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails ## -description Used to provide the details about a change to the properties of a phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails + +## -description +Used to provide the details about a change to the properties of a phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_changetype.md b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_changetype.md index 01ccd28bdd..13d9fb3089 100644 --- a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_changetype.md +++ b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_changetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.ChangeType --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.ChangeType ## -description Gets a [PhoneLineChangeKind](phonelinechangekind.md) value that indicates if the phone line was added, removed, or changed. ## -property-value A [PhoneLineChangeKind](phonelinechangekind.md) value that indicates if the phone line was added, removed, or changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.ChangeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.ChangeType + +## -description +Gets a [PhoneLineChangeKind](phonelinechangekind.md) value that indicates if the phone line was added, removed, or changed. + +## -property-value +A [PhoneLineChangeKind](phonelinechangekind.md) value that indicates if the phone line was added, removed, or changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_haslinepropertychanged_721990375.md b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_haslinepropertychanged_721990375.md index a9e2f7bf63..58c6262e3a 100644 --- a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_haslinepropertychanged_721990375.md +++ b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_haslinepropertychanged_721990375.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.HasLinePropertyChanged(Windows.ApplicationModel.Calls.Background.PhoneLineProperties) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.HasLinePropertyChanged ## -description Checks a phone line against a set of flags to see if any of the specified properties of the phone line have changed. ## -parameters ### -param lineProperty A set of flags which indicate the phone line properties to query for changes. ## -returns Returns true if any of the properties indicated by the *lineProperty* parameter have changed on the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.HasLinePropertyChanged(Windows.ApplicationModel.Calls.Background.PhoneLineProperties) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.HasLinePropertyChanged + +## -description +Checks a phone line against a set of flags to see if any of the specified properties of the phone line have changed. + +## -parameters +### -param lineProperty +A set of flags which indicate the phone line properties to query for changes. + +## -returns +Returns true if any of the properties indicated by the *lineProperty* parameter have changed on the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_lineid.md b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_lineid.md index 0108f09d8a..59c10d56a8 100644 --- a/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_lineid.md +++ b/windows.applicationmodel.calls.background/phonelinechangedtriggerdetails_lineid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.LineId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.LineId ## -description Gets the ID of the phone line that was added, removed, or changed. ## -property-value The ID of the phone line that was added, removed, or changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.LineId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneLineChangedTriggerDetails.LineId + +## -description +Gets the ID of the phone line that was added, removed, or changed. + +## -property-value +The ID of the phone line that was added, removed, or changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails.md b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails.md index 6eb2731755..49ed7eec3d 100644 --- a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails.md +++ b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails ## -description Used to provide the details about a new voice mail message on a phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails + +## -description +Used to provide the details about a new voice mail message on a phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_lineid.md b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_lineid.md index 6223250bd3..d974388925 100644 --- a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_lineid.md +++ b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_lineid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.LineId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.LineId ## -description Gets the ID of the phone line for which the new voice mail arrived. ## -property-value The ID of the phone line for the new voice mail. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.LineId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.LineId + +## -description +Gets the ID of the phone line for which the new voice mail arrived. + +## -property-value +The ID of the phone line for the new voice mail. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_operatormessage.md b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_operatormessage.md index ed8a0c2c52..c268f4e180 100644 --- a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_operatormessage.md +++ b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_operatormessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.OperatorMessage --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.OperatorMessage ## -description Gets the optional voice mail changed message set by an operator when they send a voice mail changed SMS. ## -property-value The optional voice mail changed message set by an operator when they send a voice mail changed SMS. If the message exists, it is displayed on the voice mail toast if the toast is displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.OperatorMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.OperatorMessage + +## -description +Gets the optional voice mail changed message set by an operator when they send a voice mail changed SMS. + +## -property-value +The optional voice mail changed message set by an operator when they send a voice mail changed SMS. If the message exists, it is displayed on the voice mail toast if the toast is displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_voicemailcount.md b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_voicemailcount.md index 76b2a59619..6ff36c0e8c 100644 --- a/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_voicemailcount.md +++ b/windows.applicationmodel.calls.background/phonenewvoicemailmessagetriggerdetails_voicemailcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.VoicemailCount --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.VoicemailCount ## -description Gets the new count of voice mail messages for the phone line. ## -property-value The current count of voice mail messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.VoicemailCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Background.PhoneNewVoicemailMessageTriggerDetails.VoicemailCount + +## -description +Gets the new count of voice mail messages for the phone line. + +## -property-value +The current count of voice mail messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin.md b/windows.applicationmodel.calls.provider/phonecallorigin.md index 267d7e1fdb..c43cecadc6 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin --api-type: winrt class ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin ## -description A collection of information about the origin of a phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin + +## -description +A collection of information about the origin of a phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin_category.md b/windows.applicationmodel.calls.provider/phonecallorigin_category.md index d9e3c30912..76f2a9cbf8 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin_category.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin_category.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Category --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Category ## -description Gets or sets the category for the caller. ## -property-value The caller's category. A couple of examples include "house agent" or "financial service." ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Category +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Category + +## -description +Gets or sets the category for the caller. + +## -property-value +The caller's category. A couple of examples include "house agent" or "financial service." + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin_categorydescription.md b/windows.applicationmodel.calls.provider/phonecallorigin_categorydescription.md index c8750c736b..786e27eff1 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin_categorydescription.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin_categorydescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.CategoryDescription --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.CategoryDescription ## -description Gets or sets the description of the caller's [Category](phonecallorigin_category.md). ## -property-value The description of the caller's specific [Category](phonecallorigin_category.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.CategoryDescription +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.CategoryDescription + +## -description +Gets or sets the description of the caller's [Category](phonecallorigin_category.md). + +## -property-value +The description of the caller's specific [Category](phonecallorigin_category.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin_displayname.md b/windows.applicationmodel.calls.provider/phonecallorigin_displayname.md index fe73bc3d68..41dd541ffb 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin_displayname.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayName ## -description Gets or sets the display name for the [PhoneCallOriginManager](phonecalloriginmanager.md) object. ## -property-value The display name for the call origin manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayName + +## -description +Gets or sets the display name for the [PhoneCallOriginManager](phonecalloriginmanager.md) object. + +## -property-value +The display name for the call origin manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin_displaypicture.md b/windows.applicationmodel.calls.provider/phonecallorigin_displaypicture.md index 5d0730dc81..9b24373204 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin_displaypicture.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin_displaypicture.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayPicture --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayPicture ## -description Gets or sets the display picture for the [PhoneCallOriginManager](phonecalloriginmanager.md) object. ## -property-value The display picture for the caller's origin. This picture is displayed on the incoming call UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayPicture +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.DisplayPicture + +## -description +Gets or sets the display picture for the [PhoneCallOriginManager](phonecalloriginmanager.md) object. + +## -property-value +The display picture for the caller's origin. This picture is displayed on the incoming call UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin_location.md b/windows.applicationmodel.calls.provider/phonecallorigin_location.md index 0f9236fa51..cf91d0d3b8 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin_location.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin_location.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Location --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Location ## -description Gets or sets the location of the caller. ## -property-value The caller's location. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Location +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.Location + +## -description +Gets or sets the location of the caller. + +## -property-value +The caller's location. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecallorigin_phonecallorigin_1221375020.md b/windows.applicationmodel.calls.provider/phonecallorigin_phonecallorigin_1221375020.md index b48c59c233..e99cc5ebe6 100644 --- a/windows.applicationmodel.calls.provider/phonecallorigin_phonecallorigin_1221375020.md +++ b/windows.applicationmodel.calls.provider/phonecallorigin_phonecallorigin_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.PhoneCallOrigin ## -description Creates a new [PhoneCallOrigin](phonecallorigin.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin.PhoneCallOrigin + +## -description +Creates a new [PhoneCallOrigin](phonecallorigin.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecalloriginmanager.md b/windows.applicationmodel.calls.provider/phonecalloriginmanager.md index f6762ebf7f..1869fa0b1a 100644 --- a/windows.applicationmodel.calls.provider/phonecalloriginmanager.md +++ b/windows.applicationmodel.calls.provider/phonecalloriginmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager --api-type: winrt class ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager ## -description Controls which application is responsible for determining the origin of incoming calls and sets the [PhoneCallOrigin](phonecallorigin.md) information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager + +## -description +Controls which application is responsible for determining the origin of incoming calls and sets the [PhoneCallOrigin](phonecallorigin.md) information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecalloriginmanager_iscurrentappactivecalloriginapp.md b/windows.applicationmodel.calls.provider/phonecalloriginmanager_iscurrentappactivecalloriginapp.md index 5f41d51af3..e428dc21d8 100644 --- a/windows.applicationmodel.calls.provider/phonecalloriginmanager_iscurrentappactivecalloriginapp.md +++ b/windows.applicationmodel.calls.provider/phonecalloriginmanager_iscurrentappactivecalloriginapp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.IsCurrentAppActiveCallOriginApp --api-type: winrt property ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.IsCurrentAppActiveCallOriginApp ## -description Checks to see if the current application is set as the default call origin application. ## -property-value **True** if the current application is the default call origin application, otherwise **false**. ## -remarks A user can have multiple phone call origin applications installed on a phone. However, only one of the applications can be the default application and respond to incoming calls. This method determines whether the current application is the active phone call origin application. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.IsCurrentAppActiveCallOriginApp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.IsCurrentAppActiveCallOriginApp + +## -description +Checks to see if the current application is set as the default call origin application. + +## -property-value +**True** if the current application is the default call origin application, otherwise **false**. + +## -remarks +A user can have multiple phone call origin applications installed on a phone. However, only one of the applications can be the default application and respond to incoming calls. This method determines whether the current application is the active phone call origin application. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecalloriginmanager_requestsetasactivecalloriginappasync_1169731209.md b/windows.applicationmodel.calls.provider/phonecalloriginmanager_requestsetasactivecalloriginappasync_1169731209.md index 6ca7cf524a..a55e55dea8 100644 --- a/windows.applicationmodel.calls.provider/phonecalloriginmanager_requestsetasactivecalloriginappasync_1169731209.md +++ b/windows.applicationmodel.calls.provider/phonecalloriginmanager_requestsetasactivecalloriginappasync_1169731209.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.RequestSetAsActiveCallOriginAppAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.RequestSetAsActiveCallOriginAppAsync ## -description Calls a dialog to set the current app as the default phone origin app. ## -returns Indicates whether the app was set as the default phone origin application. ## -remarks In order to use this API, your application needs to be registered as a phone call origin provider. If the application is not appropriately registered, this API will throw an exception. See [Windows.ApplicationModel.Calls.Provider](windows_applicationmodel_calls_provider.md) for more information about how to register as a phone call origin provider. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.RequestSetAsActiveCallOriginAppAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.RequestSetAsActiveCallOriginAppAsync + +## -description +Calls a dialog to set the current app as the default phone origin app. + +## -returns +Indicates whether the app was set as the default phone origin application. + +## -remarks +In order to use this API, your application needs to be registered as a phone call origin provider. If the application is not appropriately registered, this API will throw an exception. See [Windows.ApplicationModel.Calls.Provider](windows_applicationmodel_calls_provider.md) for more information about how to register as a phone call origin provider. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecalloriginmanager_setcallorigin_742485117.md b/windows.applicationmodel.calls.provider/phonecalloriginmanager_setcallorigin_742485117.md index a0b2e4e964..205be737f6 100644 --- a/windows.applicationmodel.calls.provider/phonecalloriginmanager_setcallorigin_742485117.md +++ b/windows.applicationmodel.calls.provider/phonecalloriginmanager_setcallorigin_742485117.md @@ -1,44 +1,44 @@ ---- --api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.SetCallOrigin(System.Guid,Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.SetCallOrigin - -## -description -Sets the call origin when a phone call comes in. - -## -parameters -### -param requestId -The unique identifier for this phone call. This is retrieved from the *targetId* of the [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md) - -### -param callOrigin -The call information for the incoming call. - -## -remarks -Before attempting to call this method, make sure of the following. -+ You declare the **PhoneCall** capability in your app manifest file as follows: `` -+ Your application has a background task that binds the [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md) trigger. -+ Your application is the active call origin application. You can use [IsCurrentAppActiveCallOriginApp](phonecalloriginmanager_iscurrentappactivecalloriginapp.md) to determine if this is true. If your app is not the currently active application, you can use [ShowPhoneCallOriginSettingsUI](phonecalloriginmanager_showphonecalloriginsettingsui.md) to display a window to the user enabling them to change the currently active origin app. - - -If any of these are not true, [SetCallOrigin](phonecalloriginmanager_setcallorigin.md) will return an access denied error. - -> [!IMPORTANT] -> If your application uses the **phoneCall** capability, you must request a waiver if you want to publish your application in China. Contact your premier support representative if you need the waiver. - -This method should be invoked in the background when the application is triggered by the [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md). - -The following example shows how to set the location of the origin in response to a trigger. - - - -[!code-cs[ShowCallLocation](../windows.applicationmodel.calls.provider/code/CallProvider/cs/Scenario1.xaml.cs#SnippetShowCallLocation)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.SetCallOrigin(System.Guid,Windows.ApplicationModel.Calls.Provider.PhoneCallOrigin) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.SetCallOrigin + +## -description +Sets the call origin when a phone call comes in. + +## -parameters +### -param requestId +The unique identifier for this phone call. This is retrieved from the *targetId* of the [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md) + +### -param callOrigin +The call information for the incoming call. + +## -remarks +Before attempting to call this method, make sure of the following. ++ You declare the **PhoneCall** capability in your app manifest file as follows: `` ++ Your application has a background task that binds the [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md) trigger. ++ Your application is the active call origin application. You can use [IsCurrentAppActiveCallOriginApp](phonecalloriginmanager_iscurrentappactivecalloriginapp.md) to determine if this is true. If your app is not the currently active application, you can use [ShowPhoneCallOriginSettingsUI](phonecalloriginmanager_showphonecalloriginsettingsui.md) to display a window to the user enabling them to change the currently active origin app. + + +If any of these are not true, [SetCallOrigin](phonecalloriginmanager_setcallorigin.md) will return an access denied error. + +> [!IMPORTANT] +> If your application uses the **phoneCall** capability, you must request a waiver if you want to publish your application in China. Contact your premier support representative if you need the waiver. + +This method should be invoked in the background when the application is triggered by the [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md). + +The following example shows how to set the location of the origin in response to a trigger. + + + +[!code-cs[ShowCallLocation](../windows.applicationmodel.calls.provider/code/CallProvider/cs/Scenario1.xaml.cs#SnippetShowCallLocation)] + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls.provider/phonecalloriginmanager_showphonecalloriginsettingsui_1617140504.md b/windows.applicationmodel.calls.provider/phonecalloriginmanager_showphonecalloriginsettingsui_1617140504.md index cf6bf42d3c..c9826aa380 100644 --- a/windows.applicationmodel.calls.provider/phonecalloriginmanager_showphonecalloriginsettingsui_1617140504.md +++ b/windows.applicationmodel.calls.provider/phonecalloriginmanager_showphonecalloriginsettingsui_1617140504.md @@ -1,45 +1,45 @@ ---- --api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.ShowPhoneCallOriginSettingsUI --api-type: winrt method ---- - - - -# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.ShowPhoneCallOriginSettingsUI - -## -description -Opens the interface that enables the user to select the call origin application. - -## -remarks -A user can have multiple phone call origin applications installed on a phone. However, only one of the applications can be the default application and respond to incoming calls. Calling this method opens the user interface to let the user select which phone call origin application is used. - -An app must meet certain requirements in order to be show in the list of possible applications for managing call origin. -+ The application must include `` in the app manifest. -+ The application much register the trigger [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md). - - -To successfully build a package to deploy a custom app, your app needs to have **mobile** as a value for the **IgnorableNamespaces** attribute of the **Package**. Here is a sample **Package** element for a custom app. - -``` - -``` - - - -The following example shows how to pull up the phone call origins application UI so the user can select the appropriate app. - - - -[!code-cs[SelectOriginApp](../windows.applicationmodel.calls.provider/code/CallProvider/cs/Scenario1.xaml.cs#SnippetSelectOriginApp)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.ShowPhoneCallOriginSettingsUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.Provider.PhoneCallOriginManager.ShowPhoneCallOriginSettingsUI + +## -description +Opens the interface that enables the user to select the call origin application. + +## -remarks +A user can have multiple phone call origin applications installed on a phone. However, only one of the applications can be the default application and respond to incoming calls. Calling this method opens the user interface to let the user select which phone call origin application is used. + +An app must meet certain requirements in order to be show in the list of possible applications for managing call origin. ++ The application must include `` in the app manifest. ++ The application much register the trigger [PhoneCallOriginDataRequestTriggerDetails](../windows.applicationmodel.calls.background/phonecallorigindatarequesttriggerdetails.md). + + +To successfully build a package to deploy a custom app, your app needs to have **mobile** as a value for the **IgnorableNamespaces** attribute of the **Package**. Here is a sample **Package** element for a custom app. + +``` + +``` + + + +The following example shows how to pull up the phone call origins application UI so the user can select the appropriate app. + + + +[!code-cs[SelectOriginApp](../windows.applicationmodel.calls.provider/code/CallProvider/cs/Scenario1.xaml.cs#SnippetSelectOriginApp)] + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/callanswereventargs.md b/windows.applicationmodel.calls/callanswereventargs.md index 0d39503261..e81f94bc95 100644 --- a/windows.applicationmodel.calls/callanswereventargs.md +++ b/windows.applicationmodel.calls/callanswereventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.CallAnswerEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Calls.CallAnswerEventArgs ## -description Supports the [AnswerRequested](voipphonecall_answerrequested.md) event of the [VoipPhoneCall](voipphonecall.md) class. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.CallAnswerEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.CallAnswerEventArgs + +## -description +Supports the [AnswerRequested](voipphonecall_answerrequested.md) event of the [VoipPhoneCall](voipphonecall.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/callanswereventargs_acceptedmedia.md b/windows.applicationmodel.calls/callanswereventargs_acceptedmedia.md index 8f9a5a23c6..084d09fbe2 100644 --- a/windows.applicationmodel.calls/callanswereventargs_acceptedmedia.md +++ b/windows.applicationmodel.calls/callanswereventargs_acceptedmedia.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.CallAnswerEventArgs.AcceptedMedia --api-type: winrt property ---- # Windows.ApplicationModel.Calls.CallAnswerEventArgs.AcceptedMedia ## -description Gets the media types that the user selected when answering the call. ## -property-value The media types that the user selected when answering the call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.CallAnswerEventArgs.AcceptedMedia +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.CallAnswerEventArgs.AcceptedMedia + +## -description +Gets the media types that the user selected when answering the call. + +## -property-value +The media types that the user selected when answering the call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/callrejecteventargs.md b/windows.applicationmodel.calls/callrejecteventargs.md index 83ae6292f2..1c1dd59697 100644 --- a/windows.applicationmodel.calls/callrejecteventargs.md +++ b/windows.applicationmodel.calls/callrejecteventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.CallRejectEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Calls.CallRejectEventArgs ## -description Supports the [RejectRequested](voipphonecall_rejectrequested.md) event of the [VoipPhoneCall](voipphonecall.md) class. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.CallRejectEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.CallRejectEventArgs + +## -description +Supports the [RejectRequested](voipphonecall_rejectrequested.md) event of the [VoipPhoneCall](voipphonecall.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/callrejecteventargs_rejectreason.md b/windows.applicationmodel.calls/callrejecteventargs_rejectreason.md index c7fe14bb99..976aef78f6 100644 --- a/windows.applicationmodel.calls/callrejecteventargs_rejectreason.md +++ b/windows.applicationmodel.calls/callrejecteventargs_rejectreason.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.CallRejectEventArgs.RejectReason --api-type: winrt property ---- # Windows.ApplicationModel.Calls.CallRejectEventArgs.RejectReason ## -description Gets the reason the incoming call was rejected. ## -property-value The reason the incoming call was rejected. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.CallRejectEventArgs.RejectReason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.CallRejectEventArgs.RejectReason + +## -description +Gets the reason the incoming call was rejected. + +## -property-value +The reason the incoming call was rejected. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/callstatechangeeventargs.md b/windows.applicationmodel.calls/callstatechangeeventargs.md index 36cd5d4758..c3c0f2b2d1 100644 --- a/windows.applicationmodel.calls/callstatechangeeventargs.md +++ b/windows.applicationmodel.calls/callstatechangeeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.CallStateChangeEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Calls.CallStateChangeEventArgs ## -description Supports the [EndRequested](voipphonecall_endrequested.md), [HoldRequested](voipphonecall_holdrequested.md), and [ResumeRequested](voipphonecall_resumerequested.md) events of the [VoipPhoneCall](voipphonecall.md) class. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.CallStateChangeEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.CallStateChangeEventArgs + +## -description +Supports the [EndRequested](voipphonecall_endrequested.md), [HoldRequested](voipphonecall_holdrequested.md), and [ResumeRequested](voipphonecall_resumerequested.md) events of the [VoipPhoneCall](voipphonecall.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/callstatechangeeventargs_state.md b/windows.applicationmodel.calls/callstatechangeeventargs_state.md index c753b2086d..d8a3e6bd3e 100644 --- a/windows.applicationmodel.calls/callstatechangeeventargs_state.md +++ b/windows.applicationmodel.calls/callstatechangeeventargs_state.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.CallStateChangeEventArgs.State --api-type: winrt property ---- # Windows.ApplicationModel.Calls.CallStateChangeEventArgs.State ## -description Gets the current state of the VoIP call. ## -property-value The current state of the VOIP call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.CallStateChangeEventArgs.State +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.CallStateChangeEventArgs.State + +## -description +Gets the current state of the VoIP call. + +## -property-value +The current state of the VOIP call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/lockscreencallendcalldeferral.md b/windows.applicationmodel.calls/lockscreencallendcalldeferral.md index eea65ed6ec..8c71dd47c4 100644 --- a/windows.applicationmodel.calls/lockscreencallendcalldeferral.md +++ b/windows.applicationmodel.calls/lockscreencallendcalldeferral.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral --api-type: winrt class ---- # Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral ## -description The [LockScreenCallEndCallDeferral](lockscreencallendcalldeferral.md) object signals when the app no longer needs to defer the removal of itself from the lock screen. ## -remarks An app gets a [LockScreenCallEndCallDeferral](lockscreencallendcalldeferral.md) object when it calls the [LockScreenCallEndRequestedEventArgs.GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) method to defer the default behavior of removing the app from the lock screen. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral + +## -description +The [LockScreenCallEndCallDeferral](lockscreencallendcalldeferral.md) object signals when the app no longer needs to defer the removal of itself from the lock screen. + +## -remarks +An app gets a [LockScreenCallEndCallDeferral](lockscreencallendcalldeferral.md) object when it calls the [LockScreenCallEndRequestedEventArgs.GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) method to defer the default behavior of removing the app from the lock screen. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallendcalldeferral_complete_1807836922.md b/windows.applicationmodel.calls/lockscreencallendcalldeferral_complete_1807836922.md index 3499abbdab..80a63623ab 100644 --- a/windows.applicationmodel.calls/lockscreencallendcalldeferral_complete_1807836922.md +++ b/windows.applicationmodel.calls/lockscreencallendcalldeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral.Complete ## -description Completes the deferral of the removal of the app from the lock screen, which causes the app to be removed from the lock screen if it hasn't already been removed by other means. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallEndCallDeferral.Complete + +## -description +Completes the deferral of the removal of the app from the lock screen, which causes the app to be removed from the lock screen if it hasn't already been removed by other means. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallendrequestedeventargs.md b/windows.applicationmodel.calls/lockscreencallendrequestedeventargs.md index 0f7e68c52d..4de89b9a10 100644 --- a/windows.applicationmodel.calls/lockscreencallendrequestedeventargs.md +++ b/windows.applicationmodel.calls/lockscreencallendrequestedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs ## -description Controls the removal of an app from the lock screen. ## -remarks If the app doesn't call [GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) to request a deferral, the app is removed from the lock screen as soon as the [LockScreenCallUI.EndRequested](lockscreencallui_endrequested.md) event handler returns. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs + +## -description +Controls the removal of an app from the lock screen. + +## -remarks + +If the app doesn't call [GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) to request a deferral, the app is removed from the lock screen as soon as the [LockScreenCallUI.EndRequested](lockscreencallui_endrequested.md) event handler returns. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_deadline.md b/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_deadline.md index c7563ac75d..9214fcd994 100644 --- a/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_deadline.md +++ b/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_deadline.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.Deadline --api-type: winrt property ---- # Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.Deadline ## -description Gets the deadline by which the app must complete the deferral. ## -property-value The deadline by which the app must complete the deferral. ## -remarks If the deadline passes and the app hasn't called [Complete](lockscreencallendcalldeferral_complete.md), the operating system acts as if the deferral completed. The current deadline is 5 seconds after the user initiates the action that triggers the [LockScreenCallUI.EndRequested](lockscreencallui_endrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.Deadline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.Deadline + +## -description +Gets the deadline by which the app must complete the deferral. + +## -property-value +The deadline by which the app must complete the deferral. + +## -remarks +If the deadline passes and the app hasn't called [Complete](lockscreencallendcalldeferral_complete.md), the operating system acts as if the deferral completed. + +The current deadline is 5 seconds after the user initiates the action that triggers the [LockScreenCallUI.EndRequested](lockscreencallui_endrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_getdeferral_254836512.md b/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_getdeferral_254836512.md index c4be73fdf0..59092f19d5 100644 --- a/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.calls/lockscreencallendrequestedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.GetDeferral ## -description Requests to defer the default behavior of removing the app from the lock screen. ## -returns When this method completes, it returns a [LockScreenCallEndCallDeferral](lockscreencallendcalldeferral.md) object that signals when the app no longer needs to defer the removal of itself from the lock screen. ## -remarks An app can extend its time on the lock screen by calling [GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) to request a deferral. If the app requested a deferral, the app is removed from the lock screen when the deferral completes or the deadline passes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallEndRequestedEventArgs.GetDeferral + +## -description +Requests to defer the default behavior of removing the app from the lock screen. + +## -returns +When this method completes, it returns a [LockScreenCallEndCallDeferral](lockscreencallendcalldeferral.md) object that signals when the app no longer needs to defer the removal of itself from the lock screen. + +## -remarks +An app can extend its time on the lock screen by calling [GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) to request a deferral. If the app requested a deferral, the app is removed from the lock screen when the deferral completes or the deadline passes. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallui.md b/windows.applicationmodel.calls/lockscreencallui.md index bfcc935607..8d48da1f40 100644 --- a/windows.applicationmodel.calls/lockscreencallui.md +++ b/windows.applicationmodel.calls/lockscreencallui.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.LockScreenCallUI --api-type: winrt class ---- # Windows.ApplicationModel.Calls.LockScreenCallUI ## -description Handles communication to and from the lock screen. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.LockScreenCallUI +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallUI + +## -description +Handles communication to and from the lock screen. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallui_calltitle.md b/windows.applicationmodel.calls/lockscreencallui_calltitle.md index c665a79078..ccf5a25c68 100644 --- a/windows.applicationmodel.calls/lockscreencallui_calltitle.md +++ b/windows.applicationmodel.calls/lockscreencallui_calltitle.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.LockScreenCallUI.CallTitle --api-type: winrt property ---- # Windows.ApplicationModel.Calls.LockScreenCallUI.CallTitle ## -description Gets and sets a brief description of the nature of the call. This brief description is also called the call's accessible name; its form is "Video call with Jane Doe." ## -property-value A brief description of the nature of the call, for example, "Video call with Jane Doe." ## -remarks An app can use the [CallTitle](lockscreencallui_calltitle.md) property to briefly describe the call. This call description is also called the accessible name and is provided to screen readers to describe your app when it runs on the lock screen. Don't include the name of your app in the accessible name; the operating system automatically includes the name of your app in the accessible name and provides that to the screen reader. The recommended form of the accessible name includes the mode of communication (video or audio) and the name of the other party. Here are some examples: + Video call with Jane Doe + Audio call with Jane Doe + Video call with Jane Doe and three others ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.LockScreenCallUI.CallTitle +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallUI.CallTitle + +## -description +Gets and sets a brief description of the nature of the call. This brief description is also called the call's accessible name; its form is "Video call with Jane Doe." + +## -property-value +A brief description of the nature of the call, for example, "Video call with Jane Doe." + +## -remarks + +An app can use the [CallTitle](lockscreencallui_calltitle.md) property to briefly describe the call. This call description is also called the accessible name and is provided to screen readers to describe your app when it runs on the lock screen. Don't include the name of your app in the accessible name; the operating system automatically includes the name of your app in the accessible name and provides that to the screen reader. The recommended form of the accessible name includes the mode of communication (video or audio) and the name of the other party. Here are some examples: + ++ Video call with Jane Doe ++ Audio call with Jane Doe ++ Video call with Jane Doe and three others + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallui_closed.md b/windows.applicationmodel.calls/lockscreencallui_closed.md index 9e1e1a6dcc..8ccb9fb613 100644 --- a/windows.applicationmodel.calls/lockscreencallui_closed.md +++ b/windows.applicationmodel.calls/lockscreencallui_closed.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.LockScreenCallUI.Closed --api-type: winrt event ---- # Windows.ApplicationModel.Calls.LockScreenCallUI.Closed ## -description Occurs when the lock screen interaction is complete. ## -remarks The [Closed](lockscreencallui_closed.md) event fires when the app is removed from the lock screen by any means. After this event fires, the [LockScreenCallUI](lockscreencallui.md) object is no longer valid. Any further attempt to use the [LockScreenCallUI](lockscreencallui.md) object can either silently fail or explicitly fail with RPC_E_DISCONNECTED. The [Closed](lockscreencallui_closed.md) event doesn't use the object parameter passed to it. The object parameter exists only because event handlers require it. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.LockScreenCallUI.Closed +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallUI.Closed + +## -description +Occurs when the lock screen interaction is complete. + +## -remarks +The [Closed](lockscreencallui_closed.md) event fires when the app is removed from the lock screen by any means. After this event fires, the [LockScreenCallUI](lockscreencallui.md) object is no longer valid. Any further attempt to use the [LockScreenCallUI](lockscreencallui.md) object can either silently fail or explicitly fail with RPC_E_DISCONNECTED. + +The [Closed](lockscreencallui_closed.md) event doesn't use the object parameter passed to it. The object parameter exists only because event handlers require it. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallui_dismiss_1198609459.md b/windows.applicationmodel.calls/lockscreencallui_dismiss_1198609459.md index 3122153ba3..1bcdea93e1 100644 --- a/windows.applicationmodel.calls/lockscreencallui_dismiss_1198609459.md +++ b/windows.applicationmodel.calls/lockscreencallui_dismiss_1198609459.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.LockScreenCallUI.Dismiss --api-type: winrt method ---- # Windows.ApplicationModel.Calls.LockScreenCallUI.Dismiss ## -description Removes the app from the lock screen UI. ## -remarks An app calls [Dismiss](lockscreencallui_dismiss.md) to remove itself when the call is dropped, for example, the other party hangs up. When [Dismiss](lockscreencallui_dismiss.md) returns, the lock screen no longer shows the app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.LockScreenCallUI.Dismiss +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallUI.Dismiss + +## -description +Removes the app from the lock screen UI. + +## -remarks +An app calls [Dismiss](lockscreencallui_dismiss.md) to remove itself when the call is dropped, for example, the other party hangs up. When [Dismiss](lockscreencallui_dismiss.md) returns, the lock screen no longer shows the app. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/lockscreencallui_endrequested.md b/windows.applicationmodel.calls/lockscreencallui_endrequested.md index 84e15559d4..b0a470e082 100644 --- a/windows.applicationmodel.calls/lockscreencallui_endrequested.md +++ b/windows.applicationmodel.calls/lockscreencallui_endrequested.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.LockScreenCallUI.EndRequested --api-type: winrt event ---- # Windows.ApplicationModel.Calls.LockScreenCallUI.EndRequested ## -description Occurs when the lock screen wants to end the call. ## -remarks The [EndRequested](lockscreencallui_endrequested.md) event typically happens when the user taps the “End call” button on the lock screen, but the event can also happen under other conditions. For example, suppose a call comes in while a call is already active on the lock screen. By accepting the new call on the lock screen, the previous call ends. When the [EndRequested](lockscreencallui_endrequested.md) event handler returns, the app is removed from the lock screen. An app can extend its time on the lock screen by calling [LockScreenCallEndRequestedEventArgs.GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) to request a deferral. If the app requested a deferral, the app is removed from the lock screen when the deferral completes or the deadline passes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.LockScreenCallUI.EndRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.LockScreenCallUI.EndRequested + +## -description +Occurs when the lock screen wants to end the call. + +## -remarks +The [EndRequested](lockscreencallui_endrequested.md) event typically happens when the user taps the “End call” button on the lock screen, but the event can also happen under other conditions. For example, suppose a call comes in while a call is already active on the lock screen. By accepting the new call on the lock screen, the previous call ends. + +When the [EndRequested](lockscreencallui_endrequested.md) event handler returns, the app is removed from the lock screen. An app can extend its time on the lock screen by calling [LockScreenCallEndRequestedEventArgs.GetDeferral](lockscreencallendrequestedeventargs_getdeferral.md) to request a deferral. If the app requested a deferral, the app is removed from the lock screen when the deferral completes or the deadline passes. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/mutechangeeventargs.md b/windows.applicationmodel.calls/mutechangeeventargs.md index 397ee1141e..0b706a84ef 100644 --- a/windows.applicationmodel.calls/mutechangeeventargs.md +++ b/windows.applicationmodel.calls/mutechangeeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.MuteChangeEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Calls.MuteChangeEventArgs ## -description Supports the [NotifyMuted](voipcallcoordinator_notifymuted.md) and [NotifyUnmuted](voipcallcoordinator_notifyunmuted.md) events. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.MuteChangeEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.MuteChangeEventArgs + +## -description +Supports the [NotifyMuted](voipcallcoordinator_notifymuted.md) and [NotifyUnmuted](voipcallcoordinator_notifyunmuted.md) events. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/mutechangeeventargs_muted.md b/windows.applicationmodel.calls/mutechangeeventargs_muted.md index 6e49d91655..84ad686523 100644 --- a/windows.applicationmodel.calls/mutechangeeventargs_muted.md +++ b/windows.applicationmodel.calls/mutechangeeventargs_muted.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.MuteChangeEventArgs.Muted --api-type: winrt property ---- # Windows.ApplicationModel.Calls.MuteChangeEventArgs.Muted ## -description Gets whether the call is currently muted. ## -property-value Whether the call is currently muted. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.MuteChangeEventArgs.Muted +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.MuteChangeEventArgs.Muted + +## -description +Gets whether the call is currently muted. + +## -property-value +Whether the call is currently muted. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallblocking.md b/windows.applicationmodel.calls/phonecallblocking.md index 74f95ab0fa..d109142fcb 100644 --- a/windows.applicationmodel.calls/phonecallblocking.md +++ b/windows.applicationmodel.calls/phonecallblocking.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallBlocking --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallBlocking ## -description Controls the blocking of phone numbers as they are received. ## -remarks For more information about how communication blocking works, and how to implement it in your application, see [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md). ## -examples ## -see-also [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallBlocking +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallBlocking + +## -description +Controls the blocking of phone numbers as they are received. + +## -remarks +For more information about how communication blocking works, and how to implement it in your application, see [Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md). + +## -examples + +## -see-also +[Windows.ApplicationModel.CommunicationBlocking](../windows.applicationmodel.communicationblocking/windows_applicationmodel_communicationblocking.md), [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallblocking_blockprivatenumbers.md b/windows.applicationmodel.calls/phonecallblocking_blockprivatenumbers.md index fa1f72da5c..6ee18a48d1 100644 --- a/windows.applicationmodel.calls/phonecallblocking_blockprivatenumbers.md +++ b/windows.applicationmodel.calls/phonecallblocking_blockprivatenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockPrivateNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockPrivateNumbers ## -description Gets or sets whether the [PhoneCallBlocking](phonecallblocking.md) instance should block private numbers. ## -property-value **True** if the [PhoneCallBlocking](phonecallblocking.md) instance should block private numbers, **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockPrivateNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockPrivateNumbers + +## -description +Gets or sets whether the [PhoneCallBlocking](phonecallblocking.md) instance should block private numbers. + +## -property-value +**True** if the [PhoneCallBlocking](phonecallblocking.md) instance should block private numbers, **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallblocking_blockunknownnumbers.md b/windows.applicationmodel.calls/phonecallblocking_blockunknownnumbers.md index a33d87ead1..6f59d33f2c 100644 --- a/windows.applicationmodel.calls/phonecallblocking_blockunknownnumbers.md +++ b/windows.applicationmodel.calls/phonecallblocking_blockunknownnumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockUnknownNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockUnknownNumbers ## -description Gets or sets whether the [PhoneCallBlocking](phonecallblocking.md) instance should block unknown numbers. ## -property-value **True** if the [PhoneCallBlocking](phonecallblocking.md) instance should block unknown numbers, **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockUnknownNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallBlocking.BlockUnknownNumbers + +## -description +Gets or sets whether the [PhoneCallBlocking](phonecallblocking.md) instance should block unknown numbers. + +## -property-value +**True** if the [PhoneCallBlocking](phonecallblocking.md) instance should block unknown numbers, **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallblocking_setcallblockinglistasync_844018619.md b/windows.applicationmodel.calls/phonecallblocking_setcallblockinglistasync_844018619.md index 4de18c0cce..123823a2bb 100644 --- a/windows.applicationmodel.calls/phonecallblocking_setcallblockinglistasync_844018619.md +++ b/windows.applicationmodel.calls/phonecallblocking_setcallblockinglistasync_844018619.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallBlocking.SetCallBlockingListAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallBlocking.SetCallBlockingListAsync ## -description Sets the list of numbers that should be blocked. ## -parameters ### -param phoneNumberList A list of numbers that should be blocked. ## -returns **True** if the operation was successful, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallBlocking.SetCallBlockingListAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallBlocking.SetCallBlockingListAsync + +## -description +Sets the list of numbers that should be blocked. + +## -parameters +### -param phoneNumberList +A list of numbers that should be blocked. + +## -returns +**True** if the operation was successful, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry.md b/windows.applicationmodel.calls/phonecallhistoryentry.md index fe6b78346d..8c2d409fd6 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry ## -description A collection of information about a phone call for the call history. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry + +## -description +A collection of information about a phone call for the call history. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_address.md b/windows.applicationmodel.calls/phonecallhistoryentry_address.md index 3b25b45b23..85eab0139a 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_address.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Address --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Address ## -description Gets or sets the address book information for this phone call. ## -property-value The address book information for the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Address + +## -description +Gets or sets the address book information for this phone call. + +## -property-value +The address book information for the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_duration.md b/windows.applicationmodel.calls/phonecallhistoryentry_duration.md index 31b11d55d4..886e25b34b 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_duration.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Duration --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Duration ## -description Gets or sets the duration of the call. ## -property-value The duration of the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Duration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Duration + +## -description +Gets or sets the duration of the call. + +## -property-value +The duration of the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_id.md b/windows.applicationmodel.calls/phonecallhistoryentry_id.md index 87e39e5f2d..63f507be93 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_id.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Id --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Id ## -description Gets the unique identifier for this log entry. ## -property-value The unique identifier for the [PhoneCallHistoryEntry](phonecallhistoryentry.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Id + +## -description +Gets the unique identifier for this log entry. + +## -property-value +The unique identifier for the [PhoneCallHistoryEntry](phonecallhistoryentry.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_iscalleridblocked.md b/windows.applicationmodel.calls/phonecallhistoryentry_iscalleridblocked.md index 689a6b45d8..caa1e8a0a5 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_iscalleridblocked.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_iscalleridblocked.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsCallerIdBlocked --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsCallerIdBlocked ## -description Gets or sets a value determining whether the caller ID is blocked for this phone call. ## -property-value Indicates whether the caller ID is blocked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsCallerIdBlocked +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsCallerIdBlocked + +## -description +Gets or sets a value determining whether the caller ID is blocked for this phone call. + +## -property-value +Indicates whether the caller ID is blocked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_isemergency.md b/windows.applicationmodel.calls/phonecallhistoryentry_isemergency.md index e23baf94af..8d2fbe52ba 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_isemergency.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_isemergency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsEmergency --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsEmergency ## -description Gets or sets a value that determines whether the call is classified as an emergency. ## -property-value Indicates whether the call is an emergency phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsEmergency +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsEmergency + +## -description +Gets or sets a value that determines whether the call is classified as an emergency. + +## -property-value +Indicates whether the call is an emergency phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_isincoming.md b/windows.applicationmodel.calls/phonecallhistoryentry_isincoming.md index 6f6405f275..10c55ef14c 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_isincoming.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_isincoming.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsIncoming --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsIncoming ## -description Gets or sets whether a call is an incoming call. ## -property-value **True** if the call was an incoming call, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsIncoming +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsIncoming + +## -description +Gets or sets whether a call is an incoming call. + +## -property-value +**True** if the call was an incoming call, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_ismissed.md b/windows.applicationmodel.calls/phonecallhistoryentry_ismissed.md index 96481a482e..6ba48d9ffa 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_ismissed.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_ismissed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsMissed --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsMissed ## -description Gets or sets whether a phone call was missed. ## -property-value **True** if the phone call was missed, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsMissed +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsMissed + +## -description +Gets or sets whether a phone call was missed. + +## -property-value +**True** if the phone call was missed, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_isringing.md b/windows.applicationmodel.calls/phonecallhistoryentry_isringing.md index 86550cbd3a..5acf00d055 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_isringing.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_isringing.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsRinging --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsRinging ## -description Gets or sets whether a call is currently ringing. ## -property-value **True** if the call is currently ringing, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsRinging +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsRinging + +## -description +Gets or sets whether a call is currently ringing. + +## -property-value +**True** if the call is currently ringing, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_isseen.md b/windows.applicationmodel.calls/phonecallhistoryentry_isseen.md index bbadb30dbf..f10a3c5931 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_isseen.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_isseen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSeen --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSeen ## -description Gets or sets a whether a phone call is seen. ## -property-value **True** if the call is seen, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSeen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSeen + +## -description +Gets or sets a whether a phone call is seen. + +## -property-value +**True** if the call is seen, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_issuppressed.md b/windows.applicationmodel.calls/phonecallhistoryentry_issuppressed.md index 585640862e..a6e2279e0b 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_issuppressed.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_issuppressed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSuppressed --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSuppressed ## -description Gets or sets whether this entry is suppressed. ## -property-value **True** if the entry is suppressed, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSuppressed +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsSuppressed + +## -description +Gets or sets whether this entry is suppressed. + +## -property-value +**True** if the entry is suppressed, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_isvoicemail.md b/windows.applicationmodel.calls/phonecallhistoryentry_isvoicemail.md index 67b2e4caa8..d0e541c10f 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_isvoicemail.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_isvoicemail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsVoicemail --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsVoicemail ## -description Gets or sets whether the phone call entry is a voicemail message. ## -property-value **True** if the entry is a voicemail message, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsVoicemail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.IsVoicemail + +## -description +Gets or sets whether the phone call entry is a voicemail message. + +## -property-value +**True** if the entry is a voicemail message, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_media.md b/windows.applicationmodel.calls/phonecallhistoryentry_media.md index 7f9c8e8ce4..4895224719 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_media.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_media.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Media --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Media ## -description Gets or sets the type of media associated with a call. ## -property-value The media associated with a call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Media +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.Media + +## -description +Gets or sets the type of media associated with a call. + +## -property-value +The media associated with a call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_otherappreadaccess.md b/windows.applicationmodel.calls/phonecallhistoryentry_otherappreadaccess.md index bdd9e99009..579b409415 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_otherappreadaccess.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_otherappreadaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.OtherAppReadAccess --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.OtherAppReadAccess ## -description Gets or sets the level of access provided to other applications. ## -property-value The level of access that other applications have with respect to this [PhoneCallHistoryEntry](phonecallhistoryentry.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.OtherAppReadAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.OtherAppReadAccess + +## -description +Gets or sets the level of access provided to other applications. + +## -property-value +The level of access that other applications have with respect to this [PhoneCallHistoryEntry](phonecallhistoryentry.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_phonecallhistoryentry_1221375020.md b/windows.applicationmodel.calls/phonecallhistoryentry_phonecallhistoryentry_1221375020.md index 535d73940b..15e80df21f 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_phonecallhistoryentry_1221375020.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_phonecallhistoryentry_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.PhoneCallHistoryEntry ## -description Creates a new [PhoneCallHistoryEntry](phonecallhistoryentry.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.PhoneCallHistoryEntry + +## -description +Creates a new [PhoneCallHistoryEntry](phonecallhistoryentry.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_remoteid.md b/windows.applicationmodel.calls/phonecallhistoryentry_remoteid.md index 3a95fcacf1..82f01cec38 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_remoteid.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.RemoteId ## -description Gets or sets the remote id for the entry. ## -property-value The remote id for the [PhoneCallHistoryEntry](phonecallhistoryentry.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.RemoteId + +## -description +Gets or sets the remote id for the entry. + +## -property-value +The remote id for the [PhoneCallHistoryEntry](phonecallhistoryentry.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_sourcedisplayname.md b/windows.applicationmodel.calls/phonecallhistoryentry_sourcedisplayname.md index da1d893ff4..3e4ab58a81 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_sourcedisplayname.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_sourcedisplayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceDisplayName ## -description Gets the display name for the source of the phone call. ## -property-value The display string for the source of the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceDisplayName + +## -description +Gets the display name for the source of the phone call. + +## -property-value +The display string for the source of the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_sourceid.md b/windows.applicationmodel.calls/phonecallhistoryentry_sourceid.md index 6928a881d7..b6bb5b0825 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_sourceid.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_sourceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceId ## -description Gets or sets the identifier for the source of the phone call. ## -property-value The identifier for the source of the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceId + +## -description +Gets or sets the identifier for the source of the phone call. + +## -property-value +The identifier for the source of the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_sourceidkind.md b/windows.applicationmodel.calls/phonecallhistoryentry_sourceidkind.md index 6af3ffa20c..7503f654de 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_sourceidkind.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_sourceidkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceIdKind --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceIdKind ## -description Gets or sets a value that indicates what type of identifier the [SourceId](phonecallhistoryentry_sourceid.md) is. ## -property-value The type of identifier that the [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) is. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceIdKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.SourceIdKind + +## -description +Gets or sets a value that indicates what type of identifier the [SourceId](phonecallhistoryentry_sourceid.md) is. + +## -property-value +The type of identifier that the [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) is. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentry_starttime.md b/windows.applicationmodel.calls/phonecallhistoryentry_starttime.md index 9afcaaabad..9245ffd079 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentry_starttime.md +++ b/windows.applicationmodel.calls/phonecallhistoryentry_starttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.StartTime --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.StartTime ## -description Gets or sets the start time for this history entry. ## -property-value The time that this entry started. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.StartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntry.StartTime + +## -description +Gets or sets the start time for this history entry. + +## -property-value +The time that this entry started. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress.md index 9438543930..feffdd37c8 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress ## -description Address book information for a contact used by [PhoneCallHistoryEntry](phonecallhistoryentry.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress + +## -description +Address book information for a contact used by [PhoneCallHistoryEntry](phonecallhistoryentry.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress_contactid.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress_contactid.md index 47b015c737..ff8c19aaf8 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress_contactid.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress_contactid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.ContactId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.ContactId ## -description Gets or sets the unique identifier for this contact. ## -property-value The unique identifier for this address book entry. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.ContactId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.ContactId + +## -description +Gets or sets the unique identifier for this contact. + +## -property-value +The unique identifier for this address book entry. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress_displayname.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress_displayname.md index a959e13fae..ee2812df3a 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress_displayname.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.DisplayName ## -description Get or sets the display name for this entry. ## -property-value The display name for this contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.DisplayName + +## -description +Get or sets the display name for this entry. + +## -property-value +The display name for this contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1221375020.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1221375020.md index 6a54166870..018f1083b7 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1221375020.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.PhoneCallHistoryEntryAddress ## -description Creates a new empty [PhoneCallHistoryEntryAddress](phonecallhistoryentryaddress.md) object. ## -remarks ## -examples ## -see-also [PhoneCallHistoryEntryAddress(String, PhoneCallHistoryEntryRawAddressKind)](phonecallhistoryentryaddress_phonecallhistoryentryaddress_1841259974.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.PhoneCallHistoryEntryAddress + +## -description +Creates a new empty [PhoneCallHistoryEntryAddress](phonecallhistoryentryaddress.md) object. + +## -remarks + +## -examples + +## -see-also +[PhoneCallHistoryEntryAddress(String, PhoneCallHistoryEntryRawAddressKind)](phonecallhistoryentryaddress_phonecallhistoryentryaddress_1841259974.md) \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1841259974.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1841259974.md index a5a9219cf8..01e637985c 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1841259974.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress_phonecallhistoryentryaddress_1841259974.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.#ctor(System.String,Windows.ApplicationModel.Calls.PhoneCallHistoryEntryRawAddressKind) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.PhoneCallHistoryEntryAddress ## -description Creates a new [PhoneCallHistoryEntryAddress](phonecallhistoryentryaddress.md) object with an initial address. ## -parameters ### -param rawAddress The address to initiailize to the [RawAddress](phonecallhistoryentryaddress_rawaddress.md) property. ### -param rawAddressKind The type of address represented by *rawAddress*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.#ctor(System.String,Windows.ApplicationModel.Calls.PhoneCallHistoryEntryRawAddressKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.PhoneCallHistoryEntryAddress + +## -description +Creates a new [PhoneCallHistoryEntryAddress](phonecallhistoryentryaddress.md) object with an initial address. + +## -parameters +### -param rawAddress +The address to initiailize to the [RawAddress](phonecallhistoryentryaddress_rawaddress.md) property. + +### -param rawAddressKind +The type of address represented by *rawAddress*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddress.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddress.md index 8374b0ba9e..8fb963d518 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddress.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddress --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddress ## -description Gets or sets the address information for this contact. ## -property-value The address information for this contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddress + +## -description +Gets or sets the address information for this contact. + +## -property-value +The address information for this contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddresskind.md b/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddresskind.md index b0a8b48238..264846e57d 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddresskind.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryaddress_rawaddresskind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddressKind --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddressKind ## -description Gets or sets the type of address indicated by [RawAddress](phonecallhistoryentryaddress_rawaddress.md). ## -property-value The type of address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddressKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryAddress.RawAddressKind + +## -description +Gets or sets the type of address indicated by [RawAddress](phonecallhistoryentryaddress_rawaddress.md). + +## -property-value +The type of address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions.md b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions.md index 81892a38ad..af90c0ef1f 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions ## -description Options for querying the phone call entries. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions + +## -description +Options for querying the phone call entries. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_desiredmedia.md b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_desiredmedia.md index b243628dbf..2bf334c2ef 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_desiredmedia.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_desiredmedia.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.DesiredMedia --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.DesiredMedia ## -description Gets or sets the query filter based on the type of media. ## -property-value The type of media that is included in the filter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.DesiredMedia +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.DesiredMedia + +## -description +Gets or sets the query filter based on the type of media. + +## -property-value +The type of media that is included in the filter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_phonecallhistoryentryqueryoptions_1221375020.md b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_phonecallhistoryentryqueryoptions_1221375020.md index 27051a0b07..4865e1247a 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_phonecallhistoryentryqueryoptions_1221375020.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_phonecallhistoryentryqueryoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.PhoneCallHistoryEntryQueryOptions ## -description Creates a new [PhoneCallHistoryEntryQueryOptions](phonecallhistoryentryqueryoptions.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.PhoneCallHistoryEntryQueryOptions + +## -description +Creates a new [PhoneCallHistoryEntryQueryOptions](phonecallhistoryentryqueryoptions.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_sourceids.md b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_sourceids.md index 8e64789e51..877a8edf56 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_sourceids.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryqueryoptions_sourceids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.SourceIds --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.SourceIds ## -description Get the query filter based on the source ID of the phone call entry. ## -property-value The list of [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) that are part of the filter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.SourceIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions.SourceIds + +## -description +Get the query filter based on the source ID of the phone call entry. + +## -property-value +The list of [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) that are part of the filter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryreader.md b/windows.applicationmodel.calls/phonecallhistoryentryreader.md index a99f6ae0ce..853a69cd76 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryreader.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryreader.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader ## -description Enables the calling app to read through the phone call history entries. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader + +## -description +Enables the calling app to read through the phone call history entries. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistoryentryreader_readbatchasync_888788553.md b/windows.applicationmodel.calls/phonecallhistoryentryreader_readbatchasync_888788553.md index 2b330dbd50..b4f44bbf2f 100644 --- a/windows.applicationmodel.calls/phonecallhistoryentryreader_readbatchasync_888788553.md +++ b/windows.applicationmodel.calls/phonecallhistoryentryreader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader.ReadBatchAsync ## -description Returns a list of the [PhoneCallHistoryEntry](phonecallhistoryentry.md) objects. ## -returns An asynchronous operation that returns an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryEntryReader.ReadBatchAsync + +## -description +Returns a list of the [PhoneCallHistoryEntry](phonecallhistoryentry.md) objects. + +## -returns +An asynchronous operation that returns an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorymanager.md b/windows.applicationmodel.calls/phonecallhistorymanager.md index 299ef52587..3006b927aa 100644 --- a/windows.applicationmodel.calls/phonecallhistorymanager.md +++ b/windows.applicationmodel.calls/phonecallhistorymanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryManager --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryManager ## -description Provides APIs for the application to get access to the [PhoneCallHistoryStore](phonecallhistorystore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryManager + +## -description +Provides APIs for the application to get access to the [PhoneCallHistoryStore](phonecallhistorystore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorymanager_getforuser_2058550280.md b/windows.applicationmodel.calls/phonecallhistorymanager_getforuser_2058550280.md index 19fc55f310..93ee0d0fb4 100644 --- a/windows.applicationmodel.calls/phonecallhistorymanager_getforuser_2058550280.md +++ b/windows.applicationmodel.calls/phonecallhistorymanager_getforuser_2058550280.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryManager.GetForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryManager.GetForUser ## -description Gets the [PhoneCallHistoryManagerForUser](phonecallhistorymanagerforuser.md) object for a specific user which provides access to the [PhoneCallHistoryStore](phonecallhistorystore.md) for a specific user. ## -parameters ### -param user The user that you are interested in. ## -returns The [PhoneCallHistoryManagerForUser](phonecallhistorymanagerforuser.md) object that enables you to gain access to the [PhoneCallHistoryStore](phonecallhistorystore.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryManager.GetForUser + +## -description +Gets the [PhoneCallHistoryManagerForUser](phonecallhistorymanagerforuser.md) object for a specific user which provides access to the [PhoneCallHistoryStore](phonecallhistorystore.md) for a specific user. + +## -parameters +### -param user +The user that you are interested in. + +## -returns +The [PhoneCallHistoryManagerForUser](phonecallhistorymanagerforuser.md) object that enables you to gain access to the [PhoneCallHistoryStore](phonecallhistorystore.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorymanager_requeststoreasync_146849622.md b/windows.applicationmodel.calls/phonecallhistorymanager_requeststoreasync_146849622.md index 8de4653386..9e6bb0d178 100644 --- a/windows.applicationmodel.calls/phonecallhistorymanager_requeststoreasync_146849622.md +++ b/windows.applicationmodel.calls/phonecallhistorymanager_requeststoreasync_146849622.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryManager.RequestStoreAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryManager.RequestStoreAsync ## -description Requests the [PhoneCallHistoryStore](phonecallhistorystore.md) associated with the calling application. ## -parameters ### -param accessType The type of access requested for the [PhoneCallHistoryStore](phonecallhistorystore.md) object. ## -returns An asynchronous operation that returns a [PhoneCallHistoryStore](phonecallhistorystore.md) object on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryManager.RequestStoreAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryManager.RequestStoreAsync + +## -description +Requests the [PhoneCallHistoryStore](phonecallhistorystore.md) associated with the calling application. + +## -parameters +### -param accessType +The type of access requested for the [PhoneCallHistoryStore](phonecallhistorystore.md) object. + +## -returns +An asynchronous operation that returns a [PhoneCallHistoryStore](phonecallhistorystore.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorymanagerforuser.md b/windows.applicationmodel.calls/phonecallhistorymanagerforuser.md index 5e0a442f81..215904133b 100644 --- a/windows.applicationmodel.calls/phonecallhistorymanagerforuser.md +++ b/windows.applicationmodel.calls/phonecallhistorymanagerforuser.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser ## -description Provides APIs for the application to get access to the [PhoneCallHistoryStore](phonecallhistorystore.md) for a specific user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser + +## -description +Provides APIs for the application to get access to the [PhoneCallHistoryStore](phonecallhistorystore.md) for a specific user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorymanagerforuser_requeststoreasync_146849622.md b/windows.applicationmodel.calls/phonecallhistorymanagerforuser_requeststoreasync_146849622.md index e52c88be81..d905c82db5 100644 --- a/windows.applicationmodel.calls/phonecallhistorymanagerforuser_requeststoreasync_146849622.md +++ b/windows.applicationmodel.calls/phonecallhistorymanagerforuser_requeststoreasync_146849622.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.RequestStoreAsync ## -description Requests the [PhoneCallHistoryStore](phonecallhistorystore.md) associated with the associated user and the calling application. ## -parameters ### -param accessType The type of access requested for the [PhoneCallHistoryStore](phonecallhistorystore.md) object. ## -returns An asynchronous operation that returns a [PhoneCallHistoryStore](phonecallhistorystore.md) object on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.RequestStoreAsync + +## -description +Requests the [PhoneCallHistoryStore](phonecallhistorystore.md) associated with the associated user and the calling application. + +## -parameters +### -param accessType +The type of access requested for the [PhoneCallHistoryStore](phonecallhistorystore.md) object. + +## -returns +An asynchronous operation that returns a [PhoneCallHistoryStore](phonecallhistorystore.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorymanagerforuser_user.md b/windows.applicationmodel.calls/phonecallhistorymanagerforuser_user.md index 3036d1448b..3d5672844f 100644 --- a/windows.applicationmodel.calls/phonecallhistorymanagerforuser_user.md +++ b/windows.applicationmodel.calls/phonecallhistorymanagerforuser_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.User --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.User ## -description Gets the user of an app. ## -property-value The user object that enables you to retrieve a [PhoneCallHistoryStore](phonecallhistorystore.md) for a specific user of an app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryManagerForUser.User + +## -description +Gets the user of an app. + +## -property-value +The user object that enables you to retrieve a [PhoneCallHistoryStore](phonecallhistorystore.md) for a specific user of an app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallhistorystore.md b/windows.applicationmodel.calls/phonecallhistorystore.md index 09fd62b144..b85dddcf91 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore.md +++ b/windows.applicationmodel.calls/phonecallhistorystore.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryStore --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore ## -description A collection of phone call history entries. ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallHistoryStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore + +## -description +A collection of phone call history entries. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_deleteentriesasync_1008096923.md b/windows.applicationmodel.calls/phonecallhistorystore_deleteentriesasync_1008096923.md index 45ebfb1fb5..5a8b03e71f 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_deleteentriesasync_1008096923.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_deleteentriesasync_1008096923.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntriesAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Calls.PhoneCallHistoryEntry}) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntriesAsync ## -description Deletes entries in the store. ## -parameters ### -param callHistoryEntries The entries to delete. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntriesAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Calls.PhoneCallHistoryEntry}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntriesAsync + +## -description +Deletes entries in the store. + +## -parameters +### -param callHistoryEntries +The entries to delete. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_deleteentryasync_1527821087.md b/windows.applicationmodel.calls/phonecallhistorystore_deleteentryasync_1527821087.md index 0b6688f175..19fe58a239 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_deleteentryasync_1527821087.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_deleteentryasync_1527821087.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntryAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryEntry) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntryAsync ## -description Delete an entry from the store. ## -parameters ### -param callHistoryEntry The entry to delete. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntryAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryEntry) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.DeleteEntryAsync + +## -description +Delete an entry from the store. + +## -parameters +### -param callHistoryEntry +The entry to delete. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_getentryasync_376892664.md b/windows.applicationmodel.calls/phonecallhistorystore_getentryasync_376892664.md index 34e2d8837e..007aef0381 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_getentryasync_376892664.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_getentryasync_376892664.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryAsync ## -description Gets an entry from the store based on the entry id. ## -parameters ### -param callHistoryEntryId The [PhoneCallHistoryEntryt.Id](phonecallhistoryentry_id.md) of the relevant entry. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryAsync + +## -description +Gets an entry from the store based on the entry id. + +## -parameters +### -param callHistoryEntryId +The [PhoneCallHistoryEntryt.Id](phonecallhistoryentry_id.md) of the relevant entry. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_499466667.md b/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_499466667.md index 1e55604817..e2bf402915 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_499466667.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_499466667.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader(Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader ## -description Retrieves an entry reader based on provided filters. ## -parameters ### -param queryOptions The options used to create a filtered entry reader. ## -returns A reader that can be used to go through the phone call log entries. ## -remarks Use *queryOptions* to create a reader that will only read the specified entries. If you want a reader that accesses all log entries, you can use [GetEntryReader](phonecallhistorystore_getentryreader_641155997.md). ## -examples ## -see-also [GetEntryReader](phonecallhistorystore_getentryreader_641155997.md) ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader(Windows.ApplicationModel.Calls.PhoneCallHistoryEntryQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader + +## -description +Retrieves an entry reader based on provided filters. + +## -parameters +### -param queryOptions +The options used to create a filtered entry reader. + +## -returns +A reader that can be used to go through the phone call log entries. + +## -remarks +Use *queryOptions* to create a reader that will only read the specified entries. If you want a reader that accesses all log entries, you can use [GetEntryReader](phonecallhistorystore_getentryreader_641155997.md). + +## -examples + +## -see-also +[GetEntryReader](phonecallhistorystore_getentryreader_641155997.md) + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_641155997.md b/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_641155997.md index 427197e626..594c355367 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_641155997.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_getentryreader_641155997.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader ## -description Retrieves a default phone call history entry that reads all entries. ## -returns A reader that can be used to go through the phone call log entries. ## -remarks Use [GetEntryReader](phonecallhistorystore_getentryreader_499466667.md) if you want to retrieve a reader for a limited subset of entries based on some query filters. ## -examples ## -see-also [GetEntryReader(PhoneCallHistoryEntryQueryOptions)](phonecallhistorystore_getentryreader_499466667.md) ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetEntryReader + +## -description +Retrieves a default phone call history entry that reads all entries. + +## -returns +A reader that can be used to go through the phone call log entries. + +## -remarks +Use [GetEntryReader](phonecallhistorystore_getentryreader_499466667.md) if you want to retrieve a reader for a limited subset of entries based on some query filters. + +## -examples + +## -see-also +[GetEntryReader(PhoneCallHistoryEntryQueryOptions)](phonecallhistorystore_getentryreader_499466667.md) + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_getsourcesunseencountasync_682993055.md b/windows.applicationmodel.calls/phonecallhistorystore_getsourcesunseencountasync_682993055.md index 47dce7546e..9125128dea 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_getsourcesunseencountasync_682993055.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_getsourcesunseencountasync_682993055.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetSourcesUnseenCountAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetSourcesUnseenCountAsync ## -description Gets the number of unseen log entries for the provided sources. ## -parameters ### -param sourceIds The identifiers that need to match [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) in order for that entry to be considered. ## -returns The total number of unseen entries matching all of the identifiers provided by *sourceIds*. ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetSourcesUnseenCountAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetSourcesUnseenCountAsync + +## -description +Gets the number of unseen log entries for the provided sources. + +## -parameters +### -param sourceIds +The identifiers that need to match [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) in order for that entry to be considered. + +## -returns +The total number of unseen entries matching all of the identifiers provided by *sourceIds*. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_getunseencountasync_88302786.md b/windows.applicationmodel.calls/phonecallhistorystore_getunseencountasync_88302786.md index 21aaf92afb..03403577cb 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_getunseencountasync_88302786.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_getunseencountasync_88302786.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetUnseenCountAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetUnseenCountAsync ## -description Gets the number of unseen entries. ## -returns The number of unseen entries. ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetUnseenCountAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.GetUnseenCountAsync + +## -description +Gets the number of unseen entries. + +## -returns +The number of unseen entries. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_markallasseenasync_1608452496.md b/windows.applicationmodel.calls/phonecallhistorystore_markallasseenasync_1608452496.md index f496dd2c79..03395f9f5d 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_markallasseenasync_1608452496.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_markallasseenasync_1608452496.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkAllAsSeenAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkAllAsSeenAsync ## -description Update all the entries to indicate they have all been seen by the user. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkAllAsSeenAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkAllAsSeenAsync + +## -description +Update all the entries to indicate they have all been seen by the user. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_markentriesasseenasync_653461298.md b/windows.applicationmodel.calls/phonecallhistorystore_markentriesasseenasync_653461298.md index 5395792c67..9213281ec0 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_markentriesasseenasync_653461298.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_markentriesasseenasync_653461298.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntriesAsSeenAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Calls.PhoneCallHistoryEntry}) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntriesAsSeenAsync ## -description Updates entries to indicate they have been seen by the user. ## -parameters ### -param callHistoryEntries The entries to mark as seen. This updates the [PhoneCallHistoryEntry.IsSeen](phonecallhistoryentry_isseen.md) property. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntriesAsSeenAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Calls.PhoneCallHistoryEntry}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntriesAsSeenAsync + +## -description +Updates entries to indicate they have been seen by the user. + +## -parameters +### -param callHistoryEntries +The entries to mark as seen. This updates the [PhoneCallHistoryEntry.IsSeen](phonecallhistoryentry_isseen.md) property. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_markentryasseenasync_740105152.md b/windows.applicationmodel.calls/phonecallhistorystore_markentryasseenasync_740105152.md index 3cadd98d56..85e47bccda 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_markentryasseenasync_740105152.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_markentryasseenasync_740105152.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntryAsSeenAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryEntry) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntryAsSeenAsync ## -description Updates an entry to indicate it has been seen. ## -parameters ### -param callHistoryEntry The entry to update. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntryAsSeenAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryEntry) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkEntryAsSeenAsync + +## -description +Updates an entry to indicate it has been seen. + +## -parameters +### -param callHistoryEntry +The entry to update. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_marksourcesasseenasync_1519447235.md b/windows.applicationmodel.calls/phonecallhistorystore_marksourcesasseenasync_1519447235.md index 82f6e52817..fd25d77888 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_marksourcesasseenasync_1519447235.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_marksourcesasseenasync_1519447235.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkSourcesAsSeenAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkSourcesAsSeenAsync ## -description Marks all entries from the specified sources as seen. ## -parameters ### -param sourceIds The list of source identifiers to mark as seen. Only entries that match [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) will be updated. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkSourcesAsSeenAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.MarkSourcesAsSeenAsync + +## -description +Marks all entries from the specified sources as seen. + +## -parameters +### -param sourceIds +The list of source identifiers to mark as seen. Only entries that match [PhoneCallHistoryEntry.SourceId](phonecallhistoryentry_sourceid.md) will be updated. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallhistorystore_saveentryasync_247852981.md b/windows.applicationmodel.calls/phonecallhistorystore_saveentryasync_247852981.md index 751020af65..c3778e7a56 100644 --- a/windows.applicationmodel.calls/phonecallhistorystore_saveentryasync_247852981.md +++ b/windows.applicationmodel.calls/phonecallhistorystore_saveentryasync_247852981.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.SaveEntryAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryEntry) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallHistoryStore.SaveEntryAsync ## -description Saves an entry to the store. ## -parameters ### -param callHistoryEntry The entry to save. ## -returns ## -remarks ## -examples ## -see-also ## -capabilities phoneCallHistoryPublic \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallHistoryStore.SaveEntryAsync(Windows.ApplicationModel.Calls.PhoneCallHistoryEntry) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallHistoryStore.SaveEntryAsync + +## -description +Saves an entry to the store. + +## -parameters +### -param callHistoryEntry +The entry to save. + +## -returns + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +phoneCallHistoryPublic \ No newline at end of file diff --git a/windows.applicationmodel.calls/phonecallmanager.md b/windows.applicationmodel.calls/phonecallmanager.md index 3efb7c35e2..e5d2768a72 100644 --- a/windows.applicationmodel.calls/phonecallmanager.md +++ b/windows.applicationmodel.calls/phonecallmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallManager --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallManager ## -description Provides the ability to query the call status and launch phone calls. ## -remarks Most of the methods of this API can be used even if your application is not responsible for placing phone calls. You can do this if you want to determine the status of phone calls. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager + +## -description +Provides the ability to query the call status and launch phone calls. + +## -remarks +Most of the methods of this API can be used even if your application is not responsible for placing phone calls. You can do this if you want to determine the status of phone calls. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallmanager_callstatechanged.md b/windows.applicationmodel.calls/phonecallmanager_callstatechanged.md index ec1cd6fa6a..4beb49476f 100644 --- a/windows.applicationmodel.calls/phonecallmanager_callstatechanged.md +++ b/windows.applicationmodel.calls/phonecallmanager_callstatechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.PhoneCallManager.CallStateChanged --api-type: winrt event ---- # Windows.ApplicationModel.Calls.PhoneCallManager.CallStateChanged ## -description Occurs when the basic call state of the device changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneCallManager.CallStateChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager.CallStateChanged + +## -description +Occurs when the basic call state of the device changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallmanager_iscallactive.md b/windows.applicationmodel.calls/phonecallmanager_iscallactive.md index eea3d70e44..6db5beb151 100644 --- a/windows.applicationmodel.calls/phonecallmanager_iscallactive.md +++ b/windows.applicationmodel.calls/phonecallmanager_iscallactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallManager.IsCallActive --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallManager.IsCallActive ## -description Gets a value that indicates whether an active call is in progress on the device. ## -property-value True if an active call is in progress on the device; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallManager.IsCallActive +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager.IsCallActive + +## -description +Gets a value that indicates whether an active call is in progress on the device. + +## -property-value +True if an active call is in progress on the device; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallmanager_iscallincoming.md b/windows.applicationmodel.calls/phonecallmanager_iscallincoming.md index 0f35754a26..4891a0d4d2 100644 --- a/windows.applicationmodel.calls/phonecallmanager_iscallincoming.md +++ b/windows.applicationmodel.calls/phonecallmanager_iscallincoming.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallManager.IsCallIncoming --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallManager.IsCallIncoming ## -description Gets a value that indicates if a call is incoming on the device. ## -property-value True if a call is incoming on the device; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallManager.IsCallIncoming +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager.IsCallIncoming + +## -description +Gets a value that indicates if a call is incoming on the device. + +## -property-value +True if a call is incoming on the device; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallmanager_requeststoreasync_428591920.md b/windows.applicationmodel.calls/phonecallmanager_requeststoreasync_428591920.md index 64368d775a..1a5fcb3f39 100644 --- a/windows.applicationmodel.calls/phonecallmanager_requeststoreasync_428591920.md +++ b/windows.applicationmodel.calls/phonecallmanager_requeststoreasync_428591920.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallManager.RequestStoreAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallManager.RequestStoreAsync ## -description Retrieves a [PhoneCallStore](phonecallstore.md). ## -returns A [PhoneCallStore](phonecallstore.md) object that contains information about the phone lines available on the device. ## -remarks In order to use this method, you need to have the **phoneCall** capability in your app manifest file. ``` ``` > [!IMPORTANT] > If your application uses the **phoneCall** capability, you must request a waiver if you want to publish your application in China. Contact your premier support representative if you need the waiver. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallManager.RequestStoreAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager.RequestStoreAsync + +## -description +Retrieves a [PhoneCallStore](phonecallstore.md). + +## -returns +A [PhoneCallStore](phonecallstore.md) object that contains information about the phone lines available on the device. + +## -remarks +In order to use this method, you need to have the **phoneCall** capability in your app manifest file. + +``` + +``` + + + +> [!IMPORTANT] +> If your application uses the **phoneCall** capability, you must request a waiver if you want to publish your application in China. Contact your premier support representative if you need the waiver. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallmanager_showphonecallsettingsui_2019649825.md b/windows.applicationmodel.calls/phonecallmanager_showphonecallsettingsui_2019649825.md index 56e39bd34e..ee874272f5 100644 --- a/windows.applicationmodel.calls/phonecallmanager_showphonecallsettingsui_2019649825.md +++ b/windows.applicationmodel.calls/phonecallmanager_showphonecallsettingsui_2019649825.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallSettingsUI --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallSettingsUI ## -description Launches the call settings UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallSettingsUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallSettingsUI + +## -description +Launches the call settings UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallmanager_showphonecallui_1710386604.md b/windows.applicationmodel.calls/phonecallmanager_showphonecallui_1710386604.md index 5839d59477..09681fda98 100644 --- a/windows.applicationmodel.calls/phonecallmanager_showphonecallui_1710386604.md +++ b/windows.applicationmodel.calls/phonecallmanager_showphonecallui_1710386604.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallUI(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallUI ## -description Launches the built-in phone call UI with the specified phone number and display name. ## -parameters ### -param phoneNumber A phone number. ### -param displayName A display name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallUI(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallUI + +## -description +Launches the built-in phone call UI with the specified phone number and display name. + +## -parameters +### -param phoneNumber +A phone number. + +### -param displayName +A display name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallstore.md b/windows.applicationmodel.calls/phonecallstore.md index df94bffbc4..eef36b60cc 100644 --- a/windows.applicationmodel.calls/phonecallstore.md +++ b/windows.applicationmodel.calls/phonecallstore.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallStore --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallStore ## -description Represents a collection of information about the phone lines available on a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallStore + +## -description +Represents a collection of information about the phone lines available on a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallstore_getdefaultlineasync_734264741.md b/windows.applicationmodel.calls/phonecallstore_getdefaultlineasync_734264741.md index 0eb76d0986..372f7df914 100644 --- a/windows.applicationmodel.calls/phonecallstore_getdefaultlineasync_734264741.md +++ b/windows.applicationmodel.calls/phonecallstore_getdefaultlineasync_734264741.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallStore.GetDefaultLineAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallStore.GetDefaultLineAsync ## -description Gets the line ID for the current default phone line. ## -returns An asynchronous operation that returns the line ID upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallStore.GetDefaultLineAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallStore.GetDefaultLineAsync + +## -description +Gets the line ID for the current default phone line. + +## -returns +An asynchronous operation that returns the line ID upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallstore_isemergencyphonenumberasync_1775169491.md b/windows.applicationmodel.calls/phonecallstore_isemergencyphonenumberasync_1775169491.md index 4545f37b6e..fa0b280be5 100644 --- a/windows.applicationmodel.calls/phonecallstore_isemergencyphonenumberasync_1775169491.md +++ b/windows.applicationmodel.calls/phonecallstore_isemergencyphonenumberasync_1775169491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallStore.IsEmergencyPhoneNumberAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallStore.IsEmergencyPhoneNumberAsync ## -description Checks to see if a phone number connects to a known emergency services provider. ## -parameters ### -param number The phone number to check to see if it is a known emergency number. ## -returns An asynchronous operation that returns a boolean on successful completion . True indicates that the phone number connects to a known emergency services provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallStore.IsEmergencyPhoneNumberAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallStore.IsEmergencyPhoneNumberAsync + +## -description +Checks to see if a phone number connects to a known emergency services provider. + +## -parameters +### -param number +The phone number to check to see if it is a known emergency number. + +## -returns +An asynchronous operation that returns a boolean on successful completion . True indicates that the phone number connects to a known emergency services provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallstore_requestlinewatcher_489228512.md b/windows.applicationmodel.calls/phonecallstore_requestlinewatcher_489228512.md index 4b3fee8e63..a2cfec9424 100644 --- a/windows.applicationmodel.calls/phonecallstore_requestlinewatcher_489228512.md +++ b/windows.applicationmodel.calls/phonecallstore_requestlinewatcher_489228512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallStore.RequestLineWatcher --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallStore.RequestLineWatcher ## -description Retrieves an instance of the [PhoneLineWatcher](phonelinewatcher.md) class for the device. ## -returns An instance of the [PhoneLineWatcher](phonelinewatcher.md) class for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallStore.RequestLineWatcher +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallStore.RequestLineWatcher + +## -description +Retrieves an instance of the [PhoneLineWatcher](phonelinewatcher.md) class for the device. + +## -returns +An instance of the [PhoneLineWatcher](phonelinewatcher.md) class for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallvideocapabilities.md b/windows.applicationmodel.calls/phonecallvideocapabilities.md index a11566143d..66eebe2b0e 100644 --- a/windows.applicationmodel.calls/phonecallvideocapabilities.md +++ b/windows.applicationmodel.calls/phonecallvideocapabilities.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities ## -description Provides access to the video call capabilities for a [PhoneLine](phoneline.md) instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities + +## -description +Provides access to the video call capabilities for a [PhoneLine](phoneline.md) instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallvideocapabilities_isvideocallingcapable.md b/windows.applicationmodel.calls/phonecallvideocapabilities_isvideocallingcapable.md index 62e21a7ccd..a9d2a4a302 100644 --- a/windows.applicationmodel.calls/phonecallvideocapabilities_isvideocallingcapable.md +++ b/windows.applicationmodel.calls/phonecallvideocapabilities_isvideocallingcapable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities.IsVideoCallingCapable --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities.IsVideoCallingCapable ## -description Gets whether this [PhoneLine](phoneline.md) instance supports video calls. ## -property-value **True** if the [PhoneLine](phoneline.md) instance supports video calls, **false** if it does not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities.IsVideoCallingCapable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallVideoCapabilities.IsVideoCallingCapable + +## -description +Gets whether this [PhoneLine](phoneline.md) instance supports video calls. + +## -property-value +**True** if the [PhoneLine](phoneline.md) instance supports video calls, **false** if it does not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager.md b/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager.md index 09bf7f7d01..268cc82253 100644 --- a/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager.md +++ b/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager ## -description Enables an application to get the [PhoneCallVideoCapabilities](phonecallvideocapabilities.md) for a [PhoneLine](phoneline.md) instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager + +## -description +Enables an application to get the [PhoneCallVideoCapabilities](phonecallvideocapabilities.md) for a [PhoneLine](phoneline.md) instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager_getcapabilitiesasync_742129822.md b/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager_getcapabilitiesasync_742129822.md index f14a1f8723..d9bd993dd0 100644 --- a/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager_getcapabilitiesasync_742129822.md +++ b/windows.applicationmodel.calls/phonecallvideocapabilitiesmanager_getcapabilitiesasync_742129822.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager.GetCapabilitiesAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager.GetCapabilitiesAsync ## -description Asynchronously gets the video capabilities for a [PhoneLine](phoneline.md) instance. ## -parameters ### -param phoneNumber The [PhoneLine](phoneline.md) instance to query. ## -returns The [PhoneCallVideoCapabilities](phonecallvideocapabilities.md) for the [PhoneLine](phoneline.md) instance queried. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager.GetCapabilitiesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneCallVideoCapabilitiesManager.GetCapabilitiesAsync + +## -description +Asynchronously gets the video capabilities for a [PhoneLine](phoneline.md) instance. + +## -parameters +### -param phoneNumber +The [PhoneLine](phoneline.md) instance to query. + +## -returns +The [PhoneCallVideoCapabilities](phonecallvideocapabilities.md) for the [PhoneLine](phoneline.md) instance queried. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions.md b/windows.applicationmodel.calls/phonedialoptions.md index d136fb35a1..2ca1906d29 100644 --- a/windows.applicationmodel.calls/phonedialoptions.md +++ b/windows.applicationmodel.calls/phonedialoptions.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneDialOptions --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneDialOptions ## -description Represents options for dialing a call. ## -remarks If you are supplying an [IContact](http://go.microsoft.com/fwlink/p/?linkid=618320) as the [Contact](phonedialoptions_contact.md), then you need to make sure it is a component contact and not an aggregate contact. This will make sure that the correct contact is reached when you attempt to place a call using these [PhoneDialOptions](phonedialoptions.md). Otherwise, the additional information in the contact will be lost and a lookup will be performed using only the number. This might result in the incorrect contact being selected if multiple contacts share the same number but have different metadata. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneDialOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions + +## -description +Represents options for dialing a call. + +## -remarks +If you are supplying an [IContact](http://go.microsoft.com/fwlink/p/?linkid=618320) as the [Contact](phonedialoptions_contact.md), then you need to make sure it is a component contact and not an aggregate contact. This will make sure that the correct contact is reached when you attempt to place a call using these [PhoneDialOptions](phonedialoptions.md). Otherwise, the additional information in the contact will be lost and a lookup will be performed using only the number. This might result in the incorrect contact being selected if multiple contacts share the same number but have different metadata. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_audioendpoint.md b/windows.applicationmodel.calls/phonedialoptions_audioendpoint.md index ffb00e51ad..b5e3bee550 100644 --- a/windows.applicationmodel.calls/phonedialoptions_audioendpoint.md +++ b/windows.applicationmodel.calls/phonedialoptions_audioendpoint.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.AudioEndpoint --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.AudioEndpoint ## -description Gets or sets the audio endpoint requested for a dial. ## -property-value The audio endpoint requested for a dial. ## -remarks The audio endpoint specified by the application is provided as a hint to the system. The system might ignore this information if, for example, the current audio routing policies don't support the specified endpoint. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.AudioEndpoint +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.AudioEndpoint + +## -description +Gets or sets the audio endpoint requested for a dial. + +## -property-value +The audio endpoint requested for a dial. + +## -remarks +The audio endpoint specified by the application is provided as a hint to the system. The system might ignore this information if, for example, the current audio routing policies don't support the specified endpoint. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_contact.md b/windows.applicationmodel.calls/phonedialoptions_contact.md index 85a1f590fb..577a1c5803 100644 --- a/windows.applicationmodel.calls/phonedialoptions_contact.md +++ b/windows.applicationmodel.calls/phonedialoptions_contact.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.Contact ## -description Gets or sets the address book contact associated with a dial request. ## -property-value The address book contact associated with a dial request. ## -remarks If you are supplying an [IContact](http://go.microsoft.com/fwlink/p/?linkid=618320) as the [Contact](phonedialoptions_contact.md), then you need to make sure it is a component contact and not an aggregate contact. This will make sure that the correct contact is reached when you attempt to place a call using these [PhoneDialOptions](phonedialoptions.md). Otherwise, the additional information in the contact will be lost and a lookup will be performed using only the number. This might result in the incorrect contact being selected if multiple contacts share the same number but have different metadata. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.Contact + +## -description +Gets or sets the address book contact associated with a dial request. + +## -property-value +The address book contact associated with a dial request. + +## -remarks +If you are supplying an [IContact](http://go.microsoft.com/fwlink/p/?linkid=618320) as the [Contact](phonedialoptions_contact.md), then you need to make sure it is a component contact and not an aggregate contact. This will make sure that the correct contact is reached when you attempt to place a call using these [PhoneDialOptions](phonedialoptions.md). Otherwise, the additional information in the contact will be lost and a lookup will be performed using only the number. This might result in the incorrect contact being selected if multiple contacts share the same number but have different metadata. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_contactphone.md b/windows.applicationmodel.calls/phonedialoptions_contactphone.md index a879f1500a..06d95d2ab0 100644 --- a/windows.applicationmodel.calls/phonedialoptions_contactphone.md +++ b/windows.applicationmodel.calls/phonedialoptions_contactphone.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.ContactPhone --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.ContactPhone ## -description Gets or sets the phone number property of the address book contact that is associated with the dial request. ## -property-value The phone number property of the address book contact associated with the dial request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.ContactPhone +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.ContactPhone + +## -description +Gets or sets the phone number property of the address book contact that is associated with the dial request. + +## -property-value +The phone number property of the address book contact associated with the dial request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_displayname.md b/windows.applicationmodel.calls/phonedialoptions_displayname.md index 48bced1500..6124a6ec03 100644 --- a/windows.applicationmodel.calls/phonedialoptions_displayname.md +++ b/windows.applicationmodel.calls/phonedialoptions_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.DisplayName ## -description Gets or sets the name of the party being dialed. This value is displayed if the number being dialed does not have a party name with a matching number in the user's address book. ## -property-value The name of the party being dialed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.DisplayName + +## -description +Gets or sets the name of the party being dialed. This value is displayed if the number being dialed does not have a party name with a matching number in the user's address book. + +## -property-value +The name of the party being dialed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_media.md b/windows.applicationmodel.calls/phonedialoptions_media.md index 147ae57bd5..e644f6ada8 100644 --- a/windows.applicationmodel.calls/phonedialoptions_media.md +++ b/windows.applicationmodel.calls/phonedialoptions_media.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.Media --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.Media ## -description Gets or Sets the type or types of media requested for a dial. ## -property-value The type or types of media requested for a dial. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.Media +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.Media + +## -description +Gets or Sets the type or types of media requested for a dial. + +## -property-value +The type or types of media requested for a dial. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_number.md b/windows.applicationmodel.calls/phonedialoptions_number.md index af6f8895cf..d6a5ef1415 100644 --- a/windows.applicationmodel.calls/phonedialoptions_number.md +++ b/windows.applicationmodel.calls/phonedialoptions_number.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.Number --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.Number ## -description Gets or sets the phone number to dial. ## -property-value The phone number to dial. ## -remarks If no number is specified in this property, the system will attempt to get the number automatically from the associated [ContactPhone](phonedialoptions_contactphone.md) instance. Otherwise, this [Number](phonedialoptions_number.md) will take precedence. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneDialOptions.Number +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.Number + +## -description +Gets or sets the phone number to dial. + +## -property-value +The phone number to dial. + +## -remarks +If no number is specified in this property, the system will attempt to get the number automatically from the associated [ContactPhone](phonedialoptions_contactphone.md) instance. Otherwise, this [Number](phonedialoptions_number.md) will take precedence. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonedialoptions_phonedialoptions_1221375020.md b/windows.applicationmodel.calls/phonedialoptions_phonedialoptions_1221375020.md index d666f3e171..258dbb0fb1 100644 --- a/windows.applicationmodel.calls/phonedialoptions_phonedialoptions_1221375020.md +++ b/windows.applicationmodel.calls/phonedialoptions_phonedialoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneDialOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneDialOptions.PhoneDialOptions ## -description Creates a new instance of the class ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneDialOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneDialOptions.PhoneDialOptions + +## -description +Creates a new instance of the class + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline.md b/windows.applicationmodel.calls/phoneline.md index b1f590d9de..1dab1d9c52 100644 --- a/windows.applicationmodel.calls/phoneline.md +++ b/windows.applicationmodel.calls/phoneline.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneLine --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneLine ## -description Represents a phone line. ## -remarks A phone line is a line on a device that can either receive incoming calls or place outgoing calls, depending on whether the line is configured to support dialing out. For example, a single SIM device has 1 cellular line while a dual SIM device has 2 cellular lines. The system will automatically create new lines for VoIP applications that allow initiating an outgoing call. Each [PhoneLine](phoneline.md) instance has properties specific to that line. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneLine +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine + +## -description +Represents a phone line. + +## -remarks +A phone line is a line on a device that can either receive incoming calls or place outgoing calls, depending on whether the line is configured to support dialing out. For example, a single SIM device has 1 cellular line while a dual SIM device has 2 cellular lines. The system will automatically create new lines for VoIP applications that allow initiating an outgoing call. + +Each [PhoneLine](phoneline.md) instance has properties specific to that line. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_candial.md b/windows.applicationmodel.calls/phoneline_candial.md index 8892329b93..4c3c95f397 100644 --- a/windows.applicationmodel.calls/phoneline_candial.md +++ b/windows.applicationmodel.calls/phoneline_candial.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.CanDial --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.CanDial ## -description Gets a boolean value which indicates if the phone line can be used to place outgoing calls. ## -property-value True if the phone line can place outgoing calls; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.CanDial +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.CanDial + +## -description +Gets a boolean value which indicates if the phone line can be used to place outgoing calls. + +## -property-value +True if the phone line can place outgoing calls; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_cellulardetails.md b/windows.applicationmodel.calls/phoneline_cellulardetails.md index 18a7f6aa7b..a24b45acd3 100644 --- a/windows.applicationmodel.calls/phoneline_cellulardetails.md +++ b/windows.applicationmodel.calls/phoneline_cellulardetails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.CellularDetails --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.CellularDetails ## -description Gets details for the cellular component specific components for the [PhoneLine](phoneline.md) instance. This property is NULL for VoIP phone lines. ## -property-value Details for the [PhoneLine](phoneline.md) instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.CellularDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.CellularDetails + +## -description +Gets details for the cellular component specific components for the [PhoneLine](phoneline.md) instance. This property is NULL for VoIP phone lines. + +## -property-value +Details for the [PhoneLine](phoneline.md) instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_dial_1636965279.md b/windows.applicationmodel.calls/phoneline_dial_1636965279.md index 6ecbe3e1d5..107759c1a5 100644 --- a/windows.applicationmodel.calls/phoneline_dial_1636965279.md +++ b/windows.applicationmodel.calls/phoneline_dial_1636965279.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneLine.Dial(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneLine.Dial ## -description Place a phone call on the phone line. The caller must be in the foreground. ## -parameters ### -param number The number to dial. ### -param displayName The display name of the party receiving the phone call. This parameter is optional. ## -remarks In order to use this method, the [PhoneLine](phoneline.md) instance needs to support outbound calls. Use [CanDial](phoneline_candial.md) to verify whether or not that is supported. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLine.Dial(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.Dial + +## -description +Place a phone call on the phone line. The caller must be in the foreground. + +## -parameters +### -param number +The number to dial. + +### -param displayName +The display name of the party receiving the phone call. This parameter is optional. + +## -remarks +In order to use this method, the [PhoneLine](phoneline.md) instance needs to support outbound calls. Use [CanDial](phoneline_candial.md) to verify whether or not that is supported. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_dialwithoptions_990714211.md b/windows.applicationmodel.calls/phoneline_dialwithoptions_990714211.md index a716acccf3..6b0d61015c 100644 --- a/windows.applicationmodel.calls/phoneline_dialwithoptions_990714211.md +++ b/windows.applicationmodel.calls/phoneline_dialwithoptions_990714211.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneLine.DialWithOptions(Windows.ApplicationModel.Calls.PhoneDialOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneLine.DialWithOptions ## -description Place a phone call on the phone line, allowing the caller to specify additional dial options. The caller must be in the foreground. ## -parameters ### -param options The additional dial options for the phone call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLine.DialWithOptions(Windows.ApplicationModel.Calls.PhoneDialOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.DialWithOptions + +## -description +Place a phone call on the phone line, allowing the caller to specify additional dial options. The caller must be in the foreground. + +## -parameters +### -param options +The additional dial options for the phone call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_displaycolor.md b/windows.applicationmodel.calls/phoneline_displaycolor.md index 5dee2e346f..8df78f754e 100644 --- a/windows.applicationmodel.calls/phoneline_displaycolor.md +++ b/windows.applicationmodel.calls/phoneline_displaycolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.DisplayColor --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.DisplayColor ## -description Gets the preferred display color of the phone line. ## -property-value The preferred display color of the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.DisplayColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.DisplayColor + +## -description +Gets the preferred display color of the phone line. + +## -property-value +The preferred display color of the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_displayname.md b/windows.applicationmodel.calls/phoneline_displayname.md index da51832300..df4308c678 100644 --- a/windows.applicationmodel.calls/phoneline_displayname.md +++ b/windows.applicationmodel.calls/phoneline_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.DisplayName ## -description Gets the user assigned friendly name for the phone line. ## -property-value The user assigned friendly name for the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.DisplayName + +## -description +Gets the user assigned friendly name for the phone line. + +## -property-value +The user assigned friendly name for the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_fromidasync_1092273110.md b/windows.applicationmodel.calls/phoneline_fromidasync_1092273110.md index 713f96dd0c..6bf46b3eee 100644 --- a/windows.applicationmodel.calls/phoneline_fromidasync_1092273110.md +++ b/windows.applicationmodel.calls/phoneline_fromidasync_1092273110.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.ApplicationModel.Calls.PhoneLine.FromIdAsync(System.Guid) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.Calls.PhoneLine.FromIdAsync - -## -description -This static method asynchronously retrieves a [PhoneLine](phoneline.md) object that represents a specific phone line on the device based on the line ID. - -## -parameters -### -param lineId -The line ID of the phone line to retrieve. - -## -returns -An asynchronous operation that returns a [PhoneLine](phoneline.md) object that represents a specific phone line on the device based on the line ID. - -## -remarks -The following example shows how to get the default [PhoneLine](phoneline.md). - - - -[!code-cs[GetDefaultLine](../windows.applicationmodel.calls/code/ApplicationModel.Calls/cs/Scenario1.cs#SnippetGetDefaultLine)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLine.FromIdAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.FromIdAsync + +## -description +This static method asynchronously retrieves a [PhoneLine](phoneline.md) object that represents a specific phone line on the device based on the line ID. + +## -parameters +### -param lineId +The line ID of the phone line to retrieve. + +## -returns +An asynchronous operation that returns a [PhoneLine](phoneline.md) object that represents a specific phone line on the device based on the line ID. + +## -remarks +The following example shows how to get the default [PhoneLine](phoneline.md). + + + +[!code-cs[GetDefaultLine](../windows.applicationmodel.calls/code/ApplicationModel.Calls/cs/Scenario1.cs#SnippetGetDefaultLine)] + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_id.md b/windows.applicationmodel.calls/phoneline_id.md index 4dd74174e9..ed48885d4d 100644 --- a/windows.applicationmodel.calls/phoneline_id.md +++ b/windows.applicationmodel.calls/phoneline_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.Id --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.Id ## -description Gets the ID of the phone line. The ID is persistent across devices and reboots. ## -property-value The ID of the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.Id + +## -description +Gets the ID of the phone line. The ID is persistent across devices and reboots. + +## -property-value +The ID of the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_isimmediatedialnumberasync_1694610295.md b/windows.applicationmodel.calls/phoneline_isimmediatedialnumberasync_1694610295.md index 5eeec213a3..2cd215bceb 100644 --- a/windows.applicationmodel.calls/phoneline_isimmediatedialnumberasync_1694610295.md +++ b/windows.applicationmodel.calls/phoneline_isimmediatedialnumberasync_1694610295.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneLine.IsImmediateDialNumberAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneLine.IsImmediateDialNumberAsync ## -description Check if a number should be dialed immediately from the dialer without requiring the user to press the call button. ## -parameters ### -param number The phone number to check for immediate dialing. ## -returns An asynchronous boolean response. True indicates that the number should be dialed immediately. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLine.IsImmediateDialNumberAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.IsImmediateDialNumberAsync + +## -description +Check if a number should be dialed immediately from the dialer without requiring the user to press the call button. + +## -parameters +### -param number +The phone number to check for immediate dialing. + +## -returns +An asynchronous boolean response. True indicates that the number should be dialed immediately. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_linechanged.md b/windows.applicationmodel.calls/phoneline_linechanged.md index 378d4dd550..e9b47f3e43 100644 --- a/windows.applicationmodel.calls/phoneline_linechanged.md +++ b/windows.applicationmodel.calls/phoneline_linechanged.md @@ -1,24 +1,24 @@ ---- --api-id: E:Windows.ApplicationModel.Calls.PhoneLine.LineChanged --api-type: winrt event ---- - - - -# Windows.ApplicationModel.Calls.PhoneLine.LineChanged - -## -description -Occurs when and properties for the associated [PhoneLine](phoneline.md) instance change. This can occur when meta data changes like the voice mail count, the network state, or the cellular details. - -## -remarks -The following example demonstrates how to monitor for and update the network state. - - - -[!code-cs[MonitorLineChanges](../windows.applicationmodel.calls/code/ApplicationModel.Calls/cs/Scenario1.cs#SnippetMonitorLineChanges)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneLine.LineChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.LineChanged + +## -description +Occurs when and properties for the associated [PhoneLine](phoneline.md) instance change. This can occur when meta data changes like the voice mail count, the network state, or the cellular details. + +## -remarks +The following example demonstrates how to monitor for and update the network state. + + + +[!code-cs[MonitorLineChanges](../windows.applicationmodel.calls/code/ApplicationModel.Calls/cs/Scenario1.cs#SnippetMonitorLineChanges)] + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_lineconfiguration.md b/windows.applicationmodel.calls/phoneline_lineconfiguration.md index 5f9de89a8b..ded021314f 100644 --- a/windows.applicationmodel.calls/phoneline_lineconfiguration.md +++ b/windows.applicationmodel.calls/phoneline_lineconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.LineConfiguration --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.LineConfiguration ## -description Gets extra configuration information about this [PhoneLine](phoneline.md) instance. ## -property-value The extra information for this phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.LineConfiguration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.LineConfiguration + +## -description +Gets extra configuration information about this [PhoneLine](phoneline.md) instance. + +## -property-value +The extra information for this phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_networkname.md b/windows.applicationmodel.calls/phoneline_networkname.md index ffac347ba1..e977803966 100644 --- a/windows.applicationmodel.calls/phoneline_networkname.md +++ b/windows.applicationmodel.calls/phoneline_networkname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.NetworkName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.NetworkName ## -description Gets the name of the current network that is being used by the phone line. ## -property-value The name of the current network that is being used by the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.NetworkName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.NetworkName + +## -description +Gets the name of the current network that is being used by the phone line. + +## -property-value +The name of the current network that is being used by the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_networkstate.md b/windows.applicationmodel.calls/phoneline_networkstate.md index 5e62c0bdcd..7e8c2d98cc 100644 --- a/windows.applicationmodel.calls/phoneline_networkstate.md +++ b/windows.applicationmodel.calls/phoneline_networkstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.NetworkState --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.NetworkState ## -description Gets the current network status of the phone line. ## -property-value The current network status of the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.NetworkState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.NetworkState + +## -description +Gets the current network status of the phone line. + +## -property-value +The current network status of the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_supportstile.md b/windows.applicationmodel.calls/phoneline_supportstile.md index 1708bc813b..988d259b75 100644 --- a/windows.applicationmodel.calls/phoneline_supportstile.md +++ b/windows.applicationmodel.calls/phoneline_supportstile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.SupportsTile --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.SupportsTile ## -description Gets a value that indicates if the phone line supports being pinned as a live tile. ## -property-value True if the phone line supports being pinned as a live tile; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.SupportsTile +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.SupportsTile + +## -description +Gets a value that indicates if the phone line supports being pinned as a live tile. + +## -property-value +True if the phone line supports being pinned as a live tile; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_transport.md b/windows.applicationmodel.calls/phoneline_transport.md index 79e3f7de45..ac6e2f696a 100644 --- a/windows.applicationmodel.calls/phoneline_transport.md +++ b/windows.applicationmodel.calls/phoneline_transport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.Transport --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.Transport ## -description Gets the transport for the phone line. ## -property-value The transport for the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.Transport +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.Transport + +## -description +Gets the transport for the phone line. + +## -property-value +The transport for the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_videocallingcapabilities.md b/windows.applicationmodel.calls/phoneline_videocallingcapabilities.md index 54ec2d6b4d..758cffda80 100644 --- a/windows.applicationmodel.calls/phoneline_videocallingcapabilities.md +++ b/windows.applicationmodel.calls/phoneline_videocallingcapabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.VideoCallingCapabilities --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.VideoCallingCapabilities ## -description Gets whether video calling is supported over this phone line. ## -property-value **True** if video calling is supported, **false** if it is not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.VideoCallingCapabilities +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.VideoCallingCapabilities + +## -description +Gets whether video calling is supported over this phone line. + +## -property-value +**True** if video calling is supported, **false** if it is not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phoneline_voicemail.md b/windows.applicationmodel.calls/phoneline_voicemail.md index 533f8a4907..51e950ec62 100644 --- a/windows.applicationmodel.calls/phoneline_voicemail.md +++ b/windows.applicationmodel.calls/phoneline_voicemail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLine.Voicemail --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLine.Voicemail ## -description Gets the voice mail data associated with the [PhoneLine](phoneline.md) instance. ## -property-value The voice mail data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLine.Voicemail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLine.Voicemail + +## -description +Gets the voice mail data associated with the [PhoneLine](phoneline.md) instance. + +## -property-value +The voice mail data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinecellulardetails.md b/windows.applicationmodel.calls/phonelinecellulardetails.md index 8b7010b66f..3711b1f7f5 100644 --- a/windows.applicationmodel.calls/phonelinecellulardetails.md +++ b/windows.applicationmodel.calls/phonelinecellulardetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneLineCellularDetails --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneLineCellularDetails ## -description Provides detailed interaction with the cellular components of a phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneLineCellularDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineCellularDetails + +## -description +Provides detailed interaction with the cellular components of a phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinecellulardetails_getnetworkoperatordisplaytext_866231028.md b/windows.applicationmodel.calls/phonelinecellulardetails_getnetworkoperatordisplaytext_866231028.md index 634db40148..97281b2227 100644 --- a/windows.applicationmodel.calls/phonelinecellulardetails_getnetworkoperatordisplaytext_866231028.md +++ b/windows.applicationmodel.calls/phonelinecellulardetails_getnetworkoperatordisplaytext_866231028.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.GetNetworkOperatorDisplayText(Windows.ApplicationModel.Calls.PhoneLineNetworkOperatorDisplayTextLocation) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneLineCellularDetails.GetNetworkOperatorDisplayText ## -description Retrieves the appropriate connection string to display to the user. ## -parameters ### -param location The location where the text string is needed. This affects the format of the returned string. ## -returns The text string to display in the given location. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.GetNetworkOperatorDisplayText(Windows.ApplicationModel.Calls.PhoneLineNetworkOperatorDisplayTextLocation) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineCellularDetails.GetNetworkOperatorDisplayText + +## -description +Retrieves the appropriate connection string to display to the user. + +## -parameters +### -param location +The location where the text string is needed. This affects the format of the returned string. + +## -returns +The text string to display in the given location. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinecellulardetails_ismodemon.md b/windows.applicationmodel.calls/phonelinecellulardetails_ismodemon.md index 678891d86f..d381096571 100644 --- a/windows.applicationmodel.calls/phonelinecellulardetails_ismodemon.md +++ b/windows.applicationmodel.calls/phonelinecellulardetails_ismodemon.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.IsModemOn --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineCellularDetails.IsModemOn ## -description Indicates if the modem for this phone line is on. ## -property-value True if the modem is on; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.IsModemOn +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineCellularDetails.IsModemOn + +## -description +Indicates if the modem for this phone line is on. + +## -property-value +True if the modem is on; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinecellulardetails_registrationrejectcode.md b/windows.applicationmodel.calls/phonelinecellulardetails_registrationrejectcode.md index da624cdd7b..3cde6af1af 100644 --- a/windows.applicationmodel.calls/phonelinecellulardetails_registrationrejectcode.md +++ b/windows.applicationmodel.calls/phonelinecellulardetails_registrationrejectcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.RegistrationRejectCode --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineCellularDetails.RegistrationRejectCode ## -description Gets the registration reject code for the phone line. ## -property-value The registration reject code for the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.RegistrationRejectCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineCellularDetails.RegistrationRejectCode + +## -description +Gets the registration reject code for the phone line. + +## -property-value +The registration reject code for the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinecellulardetails_simslotindex.md b/windows.applicationmodel.calls/phonelinecellulardetails_simslotindex.md index 1228cc38b7..e38a603f4d 100644 --- a/windows.applicationmodel.calls/phonelinecellulardetails_simslotindex.md +++ b/windows.applicationmodel.calls/phonelinecellulardetails_simslotindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimSlotIndex --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimSlotIndex ## -description Get the slot index of the SIM card associated with a cellular phone line. ## -property-value The slot index of the SIM card associated with a cellular phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimSlotIndex +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimSlotIndex + +## -description +Get the slot index of the SIM card associated with a cellular phone line. + +## -property-value +The slot index of the SIM card associated with a cellular phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinecellulardetails_simstate.md b/windows.applicationmodel.calls/phonelinecellulardetails_simstate.md index df026b0be5..c0e1c51a9c 100644 --- a/windows.applicationmodel.calls/phonelinecellulardetails_simstate.md +++ b/windows.applicationmodel.calls/phonelinecellulardetails_simstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimState --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimState ## -description Gets the state of the SIM card associated with a cellular phone line. ## -property-value The state of the SIM card associated with a cellular phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineCellularDetails.SimState + +## -description +Gets the state of the SIM card associated with a cellular phone line. + +## -property-value +The state of the SIM card associated with a cellular phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelineconfiguration.md b/windows.applicationmodel.calls/phonelineconfiguration.md index dbc74fb028..09d34516a5 100644 --- a/windows.applicationmodel.calls/phonelineconfiguration.md +++ b/windows.applicationmodel.calls/phonelineconfiguration.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneLineConfiguration --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneLineConfiguration ## -description A collection of properties providing information about a phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneLineConfiguration +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineConfiguration + +## -description +A collection of properties providing information about a phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelineconfiguration_extendedproperties.md b/windows.applicationmodel.calls/phonelineconfiguration_extendedproperties.md index fe58ad5ba5..9ce23e873b 100644 --- a/windows.applicationmodel.calls/phonelineconfiguration_extendedproperties.md +++ b/windows.applicationmodel.calls/phonelineconfiguration_extendedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineConfiguration.ExtendedProperties --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineConfiguration.ExtendedProperties ## -description Gets the extended properties for this phone line. ## -property-value A map of key-value pairs containing the extended properties of the phone line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineConfiguration.ExtendedProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineConfiguration.ExtendedProperties + +## -description +Gets the extended properties for this phone line. + +## -property-value +A map of key-value pairs containing the extended properties of the phone line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelineconfiguration_isvideocallingenabled.md b/windows.applicationmodel.calls/phonelineconfiguration_isvideocallingenabled.md index 06e3e7b2c0..4a193feff6 100644 --- a/windows.applicationmodel.calls/phonelineconfiguration_isvideocallingenabled.md +++ b/windows.applicationmodel.calls/phonelineconfiguration_isvideocallingenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineConfiguration.IsVideoCallingEnabled --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineConfiguration.IsVideoCallingEnabled ## -description Gets whether video calls are enabled over this phone line. ## -property-value **True** if video calls are supported, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineConfiguration.IsVideoCallingEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineConfiguration.IsVideoCallingEnabled + +## -description +Gets whether video calls are enabled over this phone line. + +## -property-value +**True** if video calls are supported, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher.md b/windows.applicationmodel.calls/phonelinewatcher.md index 86f01aad2d..9366484811 100644 --- a/windows.applicationmodel.calls/phonelinewatcher.md +++ b/windows.applicationmodel.calls/phonelinewatcher.md @@ -1,32 +1,32 @@ ---- --api-id: T:Windows.ApplicationModel.Calls.PhoneLineWatcher --api-type: winrt class ---- - - - -# Windows.ApplicationModel.Calls.PhoneLineWatcher - -## -description -Represents a class that monitors for new/removed/updated phone lines on the device and notifies listeners about any changes. - -## -remarks -A phone line is a line that a user can use to either receive inbound or place outbound phone calls. A single device can have multiple lines. For example, the system creates a separate line specifically for VoIP applications that enables initiating an outbound call. - -The system automatically detects the available lines on boot and then dynamically detects lines as lines are created or changed. The [PhoneLineWatcher](phonelinewatcher.md) class provides a mechanism for applications to receive events as new phone lines are detected and react to the changes. - -This class implements the watcher pattern. - -You can retrieve an instance of this class by calling [RequestLineWatcher](phonecallstore_requestlinewatcher.md). - -The following example shows how to enumerate through all the current phone lines. - - - -[!code-cs[GetLinesCS](../windows.applicationmodel.calls/code/ApplicationModel.Calls/cs/Scenario1.cs#SnippetGetLinesCS)] - -## -examples - -## -see-also +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneLineWatcher +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher + +## -description +Represents a class that monitors for new/removed/updated phone lines on the device and notifies listeners about any changes. + +## -remarks +A phone line is a line that a user can use to either receive inbound or place outbound phone calls. A single device can have multiple lines. For example, the system creates a separate line specifically for VoIP applications that enables initiating an outbound call. + +The system automatically detects the available lines on boot and then dynamically detects lines as lines are created or changed. The [PhoneLineWatcher](phonelinewatcher.md) class provides a mechanism for applications to receive events as new phone lines are detected and react to the changes. + +This class implements the watcher pattern. + +You can retrieve an instance of this class by calling [RequestLineWatcher](phonecallstore_requestlinewatcher.md). + +The following example shows how to enumerate through all the current phone lines. + + + +[!code-cs[GetLinesCS](../windows.applicationmodel.calls/code/ApplicationModel.Calls/cs/Scenario1.cs#SnippetGetLinesCS)] + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_enumerationcompleted.md b/windows.applicationmodel.calls/phonelinewatcher_enumerationcompleted.md index cb8d82d5c5..9f9f8a88cf 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_enumerationcompleted.md +++ b/windows.applicationmodel.calls/phonelinewatcher_enumerationcompleted.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.EnumerationCompleted --api-type: winrt event ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.EnumerationCompleted ## -description Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance completes an enumeration of all the phone lines on the device. ## -remarks Phone lines can be added, removed, or updated to a device at any time. This event only indicates that an enumeration of the phone lines has been completed at a given point in time. This event is only generated once per [PhoneLineWatcher](phonelinewatcher.md) instance. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.EnumerationCompleted + +## -description +Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance completes an enumeration of all the phone lines on the device. + +## -remarks +Phone lines can be added, removed, or updated to a device at any time. This event only indicates that an enumeration of the phone lines has been completed at a given point in time. + +This event is only generated once per [PhoneLineWatcher](phonelinewatcher.md) instance. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_lineadded.md b/windows.applicationmodel.calls/phonelinewatcher_lineadded.md index 47fab78b58..018712805b 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_lineadded.md +++ b/windows.applicationmodel.calls/phonelinewatcher_lineadded.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.LineAdded --api-type: winrt event ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.LineAdded ## -description Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance detects a new phone line on the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.LineAdded +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.LineAdded + +## -description +Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance detects a new phone line on the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_lineremoved.md b/windows.applicationmodel.calls/phonelinewatcher_lineremoved.md index 11b31f084d..15f7e392c8 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_lineremoved.md +++ b/windows.applicationmodel.calls/phonelinewatcher_lineremoved.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.LineRemoved --api-type: winrt event ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.LineRemoved ## -description Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance detects that a phone line has been removed from the device. ## -remarks In general, cellular lines can never be removed. This event is more likely to occur when a VoIP line is removed, which typically happens when the associated applications is uninstalled. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.LineRemoved +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.LineRemoved + +## -description +Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance detects that a phone line has been removed from the device. + +## -remarks +In general, cellular lines can never be removed. This event is more likely to occur when a VoIP line is removed, which typically happens when the associated applications is uninstalled. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_lineupdated.md b/windows.applicationmodel.calls/phonelinewatcher_lineupdated.md index c2bfd69c36..2de483241d 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_lineupdated.md +++ b/windows.applicationmodel.calls/phonelinewatcher_lineupdated.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.LineUpdated --api-type: winrt event ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.LineUpdated ## -description Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance detects that a phone line has been updated on the device. ## -remarks Cases where a phone line is updated include when the metadata for a phone line changes, such as with voice mail count or registration status. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.LineUpdated +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.LineUpdated + +## -description +Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance detects that a phone line has been updated on the device. + +## -remarks +Cases where a phone line is updated include when the metadata for a phone line changes, such as with voice mail count or registration status. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_start_1587696324.md b/windows.applicationmodel.calls/phonelinewatcher_start_1587696324.md index 78ce6bf976..8a83e345ce 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_start_1587696324.md +++ b/windows.applicationmodel.calls/phonelinewatcher_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneLineWatcher.Start --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.Start ## -description Starts listening for changes to the phone lines on the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLineWatcher.Start +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.Start + +## -description +Starts listening for changes to the phone lines on the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_status.md b/windows.applicationmodel.calls/phonelinewatcher_status.md index 2606b8b073..4b56e4e718 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_status.md +++ b/windows.applicationmodel.calls/phonelinewatcher_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineWatcher.Status --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.Status ## -description Get the current status of the [PhoneLineWatcher](phonelinewatcher.md) instance. ## -property-value The current status of the [PhoneLineWatcher](phonelinewatcher.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineWatcher.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.Status + +## -description +Get the current status of the [PhoneLineWatcher](phonelinewatcher.md) instance. + +## -property-value +The current status of the [PhoneLineWatcher](phonelinewatcher.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_stop_1201535524.md b/windows.applicationmodel.calls/phonelinewatcher_stop_1201535524.md index e5ea2735bf..cb05ef6341 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_stop_1201535524.md +++ b/windows.applicationmodel.calls/phonelinewatcher_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneLineWatcher.Stop --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.Stop ## -description Stops listening for changes to the phone lines on the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneLineWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.Stop + +## -description +Stops listening for changes to the phone lines on the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatcher_stopped.md b/windows.applicationmodel.calls/phonelinewatcher_stopped.md index 3002b58910..4e527fa066 100644 --- a/windows.applicationmodel.calls/phonelinewatcher_stopped.md +++ b/windows.applicationmodel.calls/phonelinewatcher_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.Stopped --api-type: winrt event ---- # Windows.ApplicationModel.Calls.PhoneLineWatcher.Stopped ## -description Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance stops monitoring the device for changes to the phone lines. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.PhoneLineWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcher.Stopped + +## -description +Occurs when the [PhoneLineWatcher](phonelinewatcher.md) instance stops monitoring the device for changes to the phone lines. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatchereventargs.md b/windows.applicationmodel.calls/phonelinewatchereventargs.md index 779e5ff1ee..ff153950b7 100644 --- a/windows.applicationmodel.calls/phonelinewatchereventargs.md +++ b/windows.applicationmodel.calls/phonelinewatchereventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs ## -description Represents a class that contains the information about which phone line was added, removed, or updated. ## -remarks This class is used in the event arguments for the events raised by the [PhoneLineWatcher](phonelinewatcher.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs + +## -description +Represents a class that contains the information about which phone line was added, removed, or updated. + +## -remarks +This class is used in the event arguments for the events raised by the [PhoneLineWatcher](phonelinewatcher.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonelinewatchereventargs_lineid.md b/windows.applicationmodel.calls/phonelinewatchereventargs_lineid.md index 3ba4e5ab0a..a5cb3477dc 100644 --- a/windows.applicationmodel.calls/phonelinewatchereventargs_lineid.md +++ b/windows.applicationmodel.calls/phonelinewatchereventargs_lineid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs.LineId --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs.LineId ## -description Gets the ID of the phone line that triggered the [LineAdded](phonelinewatcher_lineadded.md), [LineRemoved](phonelinewatcher_lineremoved.md), or [LineUpdated](phonelinewatcher_lineupdated.md) event. ## -property-value The ID of the phone line that triggered the [LineAdded](phonelinewatcher_lineadded.md), [LineRemoved](phonelinewatcher_lineremoved.md), or [LineUpdated](phonelinewatcher_lineupdated.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs.LineId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneLineWatcherEventArgs.LineId + +## -description +Gets the ID of the phone line that triggered the [LineAdded](phonelinewatcher_lineadded.md), [LineRemoved](phonelinewatcher_lineremoved.md), or [LineUpdated](phonelinewatcher_lineupdated.md) event. + +## -property-value +The ID of the phone line that triggered the [LineAdded](phonelinewatcher_lineadded.md), [LineRemoved](phonelinewatcher_lineremoved.md), or [LineUpdated](phonelinewatcher_lineupdated.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonevoicemail.md b/windows.applicationmodel.calls/phonevoicemail.md index ee8d65d9cf..8ae430e772 100644 --- a/windows.applicationmodel.calls/phonevoicemail.md +++ b/windows.applicationmodel.calls/phonevoicemail.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.PhoneVoicemail --api-type: winrt class ---- # Windows.ApplicationModel.Calls.PhoneVoicemail ## -description Represents the voice mail data associated with a [PhoneLine](phoneline.md) instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.PhoneVoicemail +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.PhoneVoicemail + +## -description +Represents the voice mail data associated with a [PhoneLine](phoneline.md) instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonevoicemail_dialvoicemailasync_900301559.md b/windows.applicationmodel.calls/phonevoicemail_dialvoicemailasync_900301559.md index 0632202145..36691a8876 100644 --- a/windows.applicationmodel.calls/phonevoicemail_dialvoicemailasync_900301559.md +++ b/windows.applicationmodel.calls/phonevoicemail_dialvoicemailasync_900301559.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.PhoneVoicemail.DialVoicemailAsync --api-type: winrt method ---- # Windows.ApplicationModel.Calls.PhoneVoicemail.DialVoicemailAsync ## -description Dials a call to the voice mail access number. ## -returns An asynchronous dial operation. ## -remarks In order to use this method, the calling application needs to be in the foreground. In addition, the [PhoneLine](phoneline.md) instance needs to support outbound calls. Use [CanDial](phoneline_candial.md) to verify whether or not that is supported. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.PhoneVoicemail.DialVoicemailAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.PhoneVoicemail.DialVoicemailAsync + +## -description +Dials a call to the voice mail access number. + +## -returns +An asynchronous dial operation. + +## -remarks +In order to use this method, the calling application needs to be in the foreground. In addition, the [PhoneLine](phoneline.md) instance needs to support outbound calls. Use [CanDial](phoneline_candial.md) to verify whether or not that is supported. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonevoicemail_messagecount.md b/windows.applicationmodel.calls/phonevoicemail_messagecount.md index 6498b0b49e..8be8fd7fe2 100644 --- a/windows.applicationmodel.calls/phonevoicemail_messagecount.md +++ b/windows.applicationmodel.calls/phonevoicemail_messagecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneVoicemail.MessageCount --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneVoicemail.MessageCount ## -description Get the current count of voice mail messages associated with the [PhoneLine](phoneline.md) instance. A value of -1 indicates an "indeterminate" number of messages. ## -property-value The current count of voice mail messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneVoicemail.MessageCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneVoicemail.MessageCount + +## -description +Get the current count of voice mail messages associated with the [PhoneLine](phoneline.md) instance. A value of -1 indicates an "indeterminate" number of messages. + +## -property-value +The current count of voice mail messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonevoicemail_number.md b/windows.applicationmodel.calls/phonevoicemail_number.md index 32e27c9f15..514c964432 100644 --- a/windows.applicationmodel.calls/phonevoicemail_number.md +++ b/windows.applicationmodel.calls/phonevoicemail_number.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneVoicemail.Number --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneVoicemail.Number ## -description Gets the access number for the voice mail associated with the [PhoneLine](phoneline.md) instance. The phone user can dial the access number to access the voice mail account. ## -property-value The access number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneVoicemail.Number +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneVoicemail.Number + +## -description +Gets the access number for the voice mail associated with the [PhoneLine](phoneline.md) instance. The phone user can dial the access number to access the voice mail account. + +## -property-value +The access number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/phonevoicemail_type.md b/windows.applicationmodel.calls/phonevoicemail_type.md index bec9400773..bfcc27aed5 100644 --- a/windows.applicationmodel.calls/phonevoicemail_type.md +++ b/windows.applicationmodel.calls/phonevoicemail_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.PhoneVoicemail.Type --api-type: winrt property ---- # Windows.ApplicationModel.Calls.PhoneVoicemail.Type ## -description Get the type of the voice mail associated with the [PhoneLine](phoneline.md) instance. ## -property-value The type of the voice mail account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.PhoneVoicemail.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.PhoneVoicemail.Type + +## -description +Get the type of the voice mail associated with the [PhoneLine](phoneline.md) instance. + +## -property-value +The type of the voice mail account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.calls/voipcallcoordinator.md b/windows.applicationmodel.calls/voipcallcoordinator.md index 1497265e4e..11cb9c4496 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator.md +++ b/windows.applicationmodel.calls/voipcallcoordinator.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.VoipCallCoordinator --api-type: winrt class ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator ## -description Allows an application to manage VoIP calls. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.VoipCallCoordinator +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator + +## -description +Allows an application to manage VoIP calls. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_cancelupgrade_1383369175.md b/windows.applicationmodel.calls/voipcallcoordinator_cancelupgrade_1383369175.md index b952883f83..d104ad3762 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_cancelupgrade_1383369175.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_cancelupgrade_1383369175.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.CancelUpgrade(System.Guid) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.CancelUpgrade ## -description Cancels the upgrade to a VoIP call. ## -parameters ### -param callUpgradeGuid The GUID for the VoIP call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.CancelUpgrade(System.Guid) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.CancelUpgrade + +## -description +Cancels the upgrade to a VoIP call. + +## -parameters +### -param callUpgradeGuid +The GUID for the VoIP call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_getdefault_846721868.md b/windows.applicationmodel.calls/voipcallcoordinator_getdefault_846721868.md index 70ca7a3822..1b9a0788b6 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_getdefault_846721868.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_getdefault_846721868.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.GetDefault --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.GetDefault ## -description Retrieves the default instance of the [VoipCallCoordinator](voipcallcoordinator.md) class. ## -returns The default call coordinator. ## -remarks You can use this method to get the default instance of the [VoipCallCoordinator](voipcallcoordinator.md) class even if you do not define the required capability below. However, you will not be able to use the other methods of the [VoipCallCoordinator](voipcallcoordinator.md) object without defining the capability. The capability protects the service from running on the platform. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.GetDefault +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.GetDefault + +## -description +Retrieves the default instance of the [VoipCallCoordinator](voipcallcoordinator.md) class. + +## -returns +The default call coordinator. + +## -remarks +You can use this method to get the default instance of the [VoipCallCoordinator](voipcallcoordinator.md) class even if you do not define the required capability below. However, you will not be able to use the other methods of the [VoipCallCoordinator](voipcallcoordinator.md) object without defining the capability. The capability protects the service from running on the platform. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_mutestatechanged.md b/windows.applicationmodel.calls/voipcallcoordinator_mutestatechanged.md index d1d0d47aa9..f2d6505a49 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_mutestatechanged.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_mutestatechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.VoipCallCoordinator.MuteStateChanged --api-type: winrt event ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.MuteStateChanged ## -description Raised when the mute status for the phone call changes. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.VoipCallCoordinator.MuteStateChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.MuteStateChanged + +## -description +Raised when the mute status for the phone call changes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_notifymuted_910830725.md b/windows.applicationmodel.calls/voipcallcoordinator_notifymuted_910830725.md index 26436990ca..37f3e2cbeb 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_notifymuted_910830725.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_notifymuted_910830725.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyMuted --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyMuted ## -description Notifies the system that the user has muted the call using the VoIP app's UI. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyMuted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyMuted + +## -description +Notifies the system that the user has muted the call using the VoIP app's UI. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_notifyunmuted_41225160.md b/windows.applicationmodel.calls/voipcallcoordinator_notifyunmuted_41225160.md index 9df5383ed5..14dbc9cd0b 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_notifyunmuted_41225160.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_notifyunmuted_41225160.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyUnmuted --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyUnmuted ## -description Notifies the system that the user has unmuted the call using the VoIP app's UI. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyUnmuted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.NotifyUnmuted + +## -description +Notifies the system that the user has unmuted the call using the VoIP app's UI. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_requestincomingupgradetovideocall_963274044.md b/windows.applicationmodel.calls/voipcallcoordinator_requestincomingupgradetovideocall_963274044.md index fcdc4c5bc3..7f77c18a69 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_requestincomingupgradetovideocall_963274044.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_requestincomingupgradetovideocall_963274044.md @@ -1,3 +1,54 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestIncomingUpgradeToVideoCall(System.String,System.String,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestIncomingUpgradeToVideoCall ## -description Makes a request to the system for an incoming video call that will replace an existing call. ## -parameters ### -param context A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file. ### -param contactName The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. ### -param contactNumber The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. ### -param contactImage The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1 MB. ### -param serviceName The name of the VoIP service or application. The maximum length is 128 characters. ### -param brandingImage The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128 KB. ### -param callDetails A string indicating who the call is on behalf of. The maximum length is 128 characters. ### -param ringtone The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1 MB. ### -param ringTimeout The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds. ## -returns The object representing the new incoming call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestIncomingUpgradeToVideoCall(System.String,System.String,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestIncomingUpgradeToVideoCall + +## -description +Makes a request to the system for an incoming video call that will replace an existing call. + +## -parameters +### -param context +A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file. + +### -param contactName +The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactNumber +The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactImage +The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1 MB. + +### -param serviceName +The name of the VoIP service or application. The maximum length is 128 characters. + +### -param brandingImage +The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128 KB. + +### -param callDetails +A string indicating who the call is on behalf of. The maximum length is 128 characters. + +### -param ringtone +The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1 MB. + +### -param ringTimeout +The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds. + +## -returns +The object representing the new incoming call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_requestnewincomingcall_402033120.md b/windows.applicationmodel.calls/voipcallcoordinator_requestnewincomingcall_402033120.md index 9779368e0b..6055ce11ac 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_requestnewincomingcall_402033120.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_requestnewincomingcall_402033120.md @@ -1,3 +1,57 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewIncomingCall(System.String,System.String,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,Windows.ApplicationModel.Calls.VoipPhoneCallMedia,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewIncomingCall ## -description Makes a request to the system for a new incoming call. ## -parameters ### -param context A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null. ### -param contactName The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. ### -param contactNumber The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. ### -param contactImage The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1MB. ### -param serviceName The name of the VoIP service or application. The maximum length is 128 characters. ### -param brandingImage The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128KB. ### -param callDetails A string indicating who the call is on behalf of. The maximum length is 128 characters. ### -param ringtone The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1MB. ### -param media The media types of the new incoming call. ### -param ringTimeout The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds. ## -returns The object representing the new incoming call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewIncomingCall(System.String,System.String,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,Windows.ApplicationModel.Calls.VoipPhoneCallMedia,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewIncomingCall + +## -description +Makes a request to the system for a new incoming call. + +## -parameters +### -param context +A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null. + +### -param contactName +The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactNumber +The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactImage +The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1MB. + +### -param serviceName +The name of the VoIP service or application. The maximum length is 128 characters. + +### -param brandingImage +The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128KB. + +### -param callDetails +A string indicating who the call is on behalf of. The maximum length is 128 characters. + +### -param ringtone +The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1MB. + +### -param media +The media types of the new incoming call. + +### -param ringTimeout +The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds. + +## -returns +The object representing the new incoming call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_requestnewoutgoingcall_1560251997.md b/windows.applicationmodel.calls/voipcallcoordinator_requestnewoutgoingcall_1560251997.md index 9742b0686d..7a604caf2c 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_requestnewoutgoingcall_1560251997.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_requestnewoutgoingcall_1560251997.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewOutgoingCall(System.String,System.String,System.String,Windows.ApplicationModel.Calls.VoipPhoneCallMedia) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewOutgoingCall ## -description Makes a request to the system for a new outgoing call. ## -parameters ### -param context A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null. ### -param contactName The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters. ### -param serviceName The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters. ### -param media The object representing the new outgoing call. ## -returns The object representing the new incoming call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewOutgoingCall(System.String,System.String,System.String,Windows.ApplicationModel.Calls.VoipPhoneCallMedia) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestNewOutgoingCall + +## -description +Makes a request to the system for a new outgoing call. + +## -parameters +### -param context +A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null. + +### -param contactName +The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param serviceName +The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param media +The object representing the new outgoing call. + +## -returns +The object representing the new incoming call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_requestoutgoingupgradetovideocall_1504679370.md b/windows.applicationmodel.calls/voipcallcoordinator_requestoutgoingupgradetovideocall_1504679370.md index 6601b8b96e..f97d05c075 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_requestoutgoingupgradetovideocall_1504679370.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_requestoutgoingupgradetovideocall_1504679370.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestOutgoingUpgradeToVideoCall(System.Guid,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestOutgoingUpgradeToVideoCall ## -description Makes a request of the system to create an outgoing video call that will replace an existing cellular call. ## -parameters ### -param callUpgradeGuid The GUID of the call. ### -param context A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file. ### -param contactName The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters. ### -param serviceName The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters. ## -returns The object representing the new outgoing call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestOutgoingUpgradeToVideoCall(System.Guid,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.RequestOutgoingUpgradeToVideoCall + +## -description +Makes a request of the system to create an outgoing video call that will replace an existing cellular call. + +## -parameters +### -param callUpgradeGuid +The GUID of the call. + +### -param context +A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file. + +### -param contactName +The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param serviceName +The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +## -returns +The object representing the new outgoing call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_reservecallresourcesasync_2108134884.md b/windows.applicationmodel.calls/voipcallcoordinator_reservecallresourcesasync_2108134884.md index af0759fad0..515fcf823b 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_reservecallresourcesasync_2108134884.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_reservecallresourcesasync_2108134884.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.ReserveCallResourcesAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.ReserveCallResourcesAsync ## -description Reserves the resources necessary for a VoIP call. ## -parameters ### -param taskEntryPoint The name of an application-defined class that performs the work of a background task. For more information, see [TaskEntryPoint](../windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md). ## -returns The result of the reservation action. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.ReserveCallResourcesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.ReserveCallResourcesAsync + +## -description +Reserves the resources necessary for a VoIP call. + +## -parameters +### -param taskEntryPoint +The name of an application-defined class that performs the work of a background task. For more information, see [TaskEntryPoint](../windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md). + +## -returns +The result of the reservation action. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipcallcoordinator_terminatecellularcall_1709744724.md b/windows.applicationmodel.calls/voipcallcoordinator_terminatecellularcall_1709744724.md index 831aaf5ab3..776e91971e 100644 --- a/windows.applicationmodel.calls/voipcallcoordinator_terminatecellularcall_1709744724.md +++ b/windows.applicationmodel.calls/voipcallcoordinator_terminatecellularcall_1709744724.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.TerminateCellularCall(System.Guid) --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipCallCoordinator.TerminateCellularCall ## -description Terminates a cellular call in order to upgrade to a VoIP call. ## -parameters ### -param callUpgradeGuid The GUID for the VoIP call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.TerminateCellularCall(System.Guid) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.TerminateCellularCall + +## -description +Terminates a cellular call in order to upgrade to a VoIP call. + +## -parameters +### -param callUpgradeGuid +The GUID for the VoIP call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall.md b/windows.applicationmodel.calls/voipphonecall.md index fd161b6ea2..6f1c85245b 100644 --- a/windows.applicationmodel.calls/voipphonecall.md +++ b/windows.applicationmodel.calls/voipphonecall.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Calls.VoipPhoneCall --api-type: winrt class ---- # Windows.ApplicationModel.Calls.VoipPhoneCall ## -description Represents a VoIP phone call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Calls.VoipPhoneCall +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall + +## -description +Represents a VoIP phone call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_answerrequested.md b/windows.applicationmodel.calls/voipphonecall_answerrequested.md index 91f237b30a..560af5c95e 100644 --- a/windows.applicationmodel.calls/voipphonecall_answerrequested.md +++ b/windows.applicationmodel.calls/voipphonecall_answerrequested.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.AnswerRequested --api-type: winrt event ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.AnswerRequested ## -description Raised when the user answers an incoming call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.AnswerRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.AnswerRequested + +## -description +Raised when the user answers an incoming call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_callmedia.md b/windows.applicationmodel.calls/voipphonecall_callmedia.md index 37a4a1d2b3..179e236b39 100644 --- a/windows.applicationmodel.calls/voipphonecall_callmedia.md +++ b/windows.applicationmodel.calls/voipphonecall_callmedia.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.VoipPhoneCall.CallMedia --api-type: winrt property ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.CallMedia ## -description Gets the media types used by the call. ## -property-value The media types used by the call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.VoipPhoneCall.CallMedia +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.CallMedia + +## -description +Gets the media types used by the call. + +## -property-value +The media types used by the call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_contactname.md b/windows.applicationmodel.calls/voipphonecall_contactname.md index 0b56835a2e..dd5f90182c 100644 --- a/windows.applicationmodel.calls/voipphonecall_contactname.md +++ b/windows.applicationmodel.calls/voipphonecall_contactname.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.VoipPhoneCall.ContactName --api-type: winrt property ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.ContactName ## -description Gets or sets contact name associated with the VoIP call. ## -property-value The contact name associated with the VoIP call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.VoipPhoneCall.ContactName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.ContactName + +## -description +Gets or sets contact name associated with the VoIP call. + +## -property-value +The contact name associated with the VoIP call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_endrequested.md b/windows.applicationmodel.calls/voipphonecall_endrequested.md index 6de807ff4a..38b18d79e0 100644 --- a/windows.applicationmodel.calls/voipphonecall_endrequested.md +++ b/windows.applicationmodel.calls/voipphonecall_endrequested.md @@ -1,3 +1,24 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.EndRequested --api-type: winrt event ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.EndRequested ## -description Raised to alert the VoIP app that the call should be ended. ## -remarks After this event has been raised, the application is required to call [NotifyCallEnded](voipphonecall_notifycallended.md) within 5 seconds. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.EndRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.EndRequested + +## -description +Raised to alert the VoIP app that the call should be ended. + +## -remarks +After this event has been raised, the application is required to call [NotifyCallEnded](voipphonecall_notifycallended.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_holdrequested.md b/windows.applicationmodel.calls/voipphonecall_holdrequested.md index e6a391303e..bbdc64fbf5 100644 --- a/windows.applicationmodel.calls/voipphonecall_holdrequested.md +++ b/windows.applicationmodel.calls/voipphonecall_holdrequested.md @@ -1,3 +1,24 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.HoldRequested --api-type: winrt event ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.HoldRequested ## -description Raised to alert the VoIP app that the call should be placed on hold. ## -remarks After this event is raised, the application is required to call [NotifyCallHeld](voipphonecall_notifycallheld.md) within 5 seconds. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.HoldRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.HoldRequested + +## -description +Raised to alert the VoIP app that the call should be placed on hold. + +## -remarks +After this event is raised, the application is required to call [NotifyCallHeld](voipphonecall_notifycallheld.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_notifycallactive_97340177.md b/windows.applicationmodel.calls/voipphonecall_notifycallactive_97340177.md index 564c2b39f4..2386286610 100644 --- a/windows.applicationmodel.calls/voipphonecall_notifycallactive_97340177.md +++ b/windows.applicationmodel.calls/voipphonecall_notifycallactive_97340177.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallActive --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallActive ## -description Notifies the system that the VoIP call is active. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallActive +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallActive + +## -description +Notifies the system that the VoIP call is active. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_notifycallended_1962259325.md b/windows.applicationmodel.calls/voipphonecall_notifycallended_1962259325.md index 149f9a4c93..9da7d7bc85 100644 --- a/windows.applicationmodel.calls/voipphonecall_notifycallended_1962259325.md +++ b/windows.applicationmodel.calls/voipphonecall_notifycallended_1962259325.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallEnded --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallEnded ## -description Notifies the system that the call has ended. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallEnded +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallEnded + +## -description +Notifies the system that the call has ended. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_notifycallheld_666131143.md b/windows.applicationmodel.calls/voipphonecall_notifycallheld_666131143.md index 96147ef148..bfd96d4317 100644 --- a/windows.applicationmodel.calls/voipphonecall_notifycallheld_666131143.md +++ b/windows.applicationmodel.calls/voipphonecall_notifycallheld_666131143.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallHeld --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallHeld ## -description Notifies the system that the call is currently on hold. ## -remarks Apps must call this method before calling [NotifyCallActive](voipphonecall_notifycallactive.md) on another VoIP call. Only one call can be active at a time. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallHeld +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallHeld + +## -description +Notifies the system that the call is currently on hold. + +## -remarks +Apps must call this method before calling [NotifyCallActive](voipphonecall_notifycallactive.md) on another VoIP call. Only one call can be active at a time. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_notifycallready_1838502474.md b/windows.applicationmodel.calls/voipphonecall_notifycallready_1838502474.md index c6673784db..60255f4e4c 100644 --- a/windows.applicationmodel.calls/voipphonecall_notifycallready_1838502474.md +++ b/windows.applicationmodel.calls/voipphonecall_notifycallready_1838502474.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallReady --api-type: winrt method ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallReady ## -description When upgrading a call from cellular to video, notifies the system that the app is done setting up the audio and video streams for the video call so that the system can end the existing cellular call. ## -remarks ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallReady +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.NotifyCallReady + +## -description +When upgrading a call from cellular to video, notifies the system that the app is done setting up the audio and video streams for the video call so that the system can end the existing cellular call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_rejectrequested.md b/windows.applicationmodel.calls/voipphonecall_rejectrequested.md index b7948e88a1..7e4f6b0c26 100644 --- a/windows.applicationmodel.calls/voipphonecall_rejectrequested.md +++ b/windows.applicationmodel.calls/voipphonecall_rejectrequested.md @@ -1,3 +1,24 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.RejectRequested --api-type: winrt event ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.RejectRequested ## -description Raised when a call has been rejected. ## -remarks After this event is raised, the application must call [NotifyCallEnded](voipphonecall_notifycallended.md) within 5 seconds. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.RejectRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.RejectRequested + +## -description +Raised when a call has been rejected. + +## -remarks +After this event is raised, the application must call [NotifyCallEnded](voipphonecall_notifycallended.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_resumerequested.md b/windows.applicationmodel.calls/voipphonecall_resumerequested.md index d6e28062a7..7f676fd2d8 100644 --- a/windows.applicationmodel.calls/voipphonecall_resumerequested.md +++ b/windows.applicationmodel.calls/voipphonecall_resumerequested.md @@ -1,3 +1,24 @@ ---- -api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.ResumeRequested --api-type: winrt event ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.ResumeRequested ## -description Raised to indicate that a previously held VoIP call should be made active. ## -remarks After this event has been raised, the application must call [NotifyCallActive](voipphonecall_notifycallactive.md) within 5 seconds. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Calls.VoipPhoneCall.ResumeRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.ResumeRequested + +## -description +Raised to indicate that a previously held VoIP call should be made active. + +## -remarks +After this event has been raised, the application must call [NotifyCallActive](voipphonecall_notifycallactive.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.calls/voipphonecall_starttime.md b/windows.applicationmodel.calls/voipphonecall_starttime.md index 9e913184f4..d813eac892 100644 --- a/windows.applicationmodel.calls/voipphonecall_starttime.md +++ b/windows.applicationmodel.calls/voipphonecall_starttime.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Calls.VoipPhoneCall.StartTime --api-type: winrt property ---- # Windows.ApplicationModel.Calls.VoipPhoneCall.StartTime ## -description Gets or sets the start time associated with the VoIP call. ## -property-value The start time associated with the call. ## -remarks Apps can set the start time for the given call to match their conventions for when calls begin. The value can be queried to allow the foreground VoIP application to display the same current call duration shown in the minimized call UI. ## -examples ## -see-also ## -capabilities voipCall \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Calls.VoipPhoneCall.StartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.StartTime + +## -description +Gets or sets the start time associated with the VoIP call. + +## -property-value +The start time associated with the call. + +## -remarks +Apps can set the start time for the given call to match their conventions for when calls begin. The value can be queried to allow the foreground VoIP application to display the same current call duration shown in the minimized call UI. + +## -examples + +## -see-also + + +## -capabilities +voipCall \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatcapabilities.md b/windows.applicationmodel.chat/chatcapabilities.md index 254cd6704b..bbfba1a74a 100644 --- a/windows.applicationmodel.chat/chatcapabilities.md +++ b/windows.applicationmodel.chat/chatcapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatCapabilities --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatCapabilities ## -description Represents the Rich Communication Services (RCS) chat capabilities of a phone number. ## -remarks Call [ChatCapabilitiesManager.GetCachedCapabilitiesAsync](chatcapabilitiesmanager_getcachedcapabilitiesasync.md) or [ChatCapabilitiesManager.GetCapabilitiesFromNetworkAsync](chatcapabilitiesmanager_getcapabilitiesfromnetworkasync.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatCapabilities +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilities + +## -description +Represents the Rich Communication Services (RCS) chat capabilities of a phone number. + +## -remarks +Call [ChatCapabilitiesManager.GetCachedCapabilitiesAsync](chatcapabilitiesmanager_getcachedcapabilitiesasync.md) or [ChatCapabilitiesManager.GetCapabilitiesFromNetworkAsync](chatcapabilitiesmanager_getcapabilitiesfromnetworkasync.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilities_ischatcapable.md b/windows.applicationmodel.chat/chatcapabilities_ischatcapable.md index 122adb013a..3ad68e07ec 100644 --- a/windows.applicationmodel.chat/chatcapabilities_ischatcapable.md +++ b/windows.applicationmodel.chat/chatcapabilities_ischatcapable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsChatCapable --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatCapabilities.IsChatCapable ## -description Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) chat. ## -property-value A Boolean value indicating of the app supports chat. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsChatCapable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilities.IsChatCapable + +## -description +Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) chat. + +## -property-value +A Boolean value indicating of the app supports chat. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilities_isfiletransfercapable.md b/windows.applicationmodel.chat/chatcapabilities_isfiletransfercapable.md index 8ed70bcabe..a0a955e1df 100644 --- a/windows.applicationmodel.chat/chatcapabilities_isfiletransfercapable.md +++ b/windows.applicationmodel.chat/chatcapabilities_isfiletransfercapable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsFileTransferCapable --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatCapabilities.IsFileTransferCapable ## -description Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) file transfer. ## -property-value A Boolean value indicating if a phone number supports Rich Communication Services (RCS) file transfer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsFileTransferCapable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilities.IsFileTransferCapable + +## -description +Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) file transfer. + +## -property-value +A Boolean value indicating if a phone number supports Rich Communication Services (RCS) file transfer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilities_isgeolocationpushcapable.md b/windows.applicationmodel.chat/chatcapabilities_isgeolocationpushcapable.md index 60cd1d2e82..4604b2bbf2 100644 --- a/windows.applicationmodel.chat/chatcapabilities_isgeolocationpushcapable.md +++ b/windows.applicationmodel.chat/chatcapabilities_isgeolocationpushcapable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsGeoLocationPushCapable --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatCapabilities.IsGeoLocationPushCapable ## -description Gets a Boolean value indicating if a phone number is capable of pushing Rich Communication Services (RCS) geolocation. ## -property-value A Boolean value indicating if a phone number is capable of pushing Rich Communication Services (RCS) geolocation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsGeoLocationPushCapable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilities.IsGeoLocationPushCapable + +## -description +Gets a Boolean value indicating if a phone number is capable of pushing Rich Communication Services (RCS) geolocation. + +## -property-value +A Boolean value indicating if a phone number is capable of pushing Rich Communication Services (RCS) geolocation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilities_isintegratedmessagingcapable.md b/windows.applicationmodel.chat/chatcapabilities_isintegratedmessagingcapable.md index 576a227da0..eee179888a 100644 --- a/windows.applicationmodel.chat/chatcapabilities_isintegratedmessagingcapable.md +++ b/windows.applicationmodel.chat/chatcapabilities_isintegratedmessagingcapable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsIntegratedMessagingCapable --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatCapabilities.IsIntegratedMessagingCapable ## -description Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) integrated messaging. ## -property-value A Boolean value indicating if a phone number supports Rich Communication Services (RCS) integrated messaging. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsIntegratedMessagingCapable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilities.IsIntegratedMessagingCapable + +## -description +Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) integrated messaging. + +## -property-value +A Boolean value indicating if a phone number supports Rich Communication Services (RCS) integrated messaging. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilities_isonline.md b/windows.applicationmodel.chat/chatcapabilities_isonline.md index 0f0b33075a..b7f6d7d8c0 100644 --- a/windows.applicationmodel.chat/chatcapabilities_isonline.md +++ b/windows.applicationmodel.chat/chatcapabilities_isonline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsOnline --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatCapabilities.IsOnline ## -description Gets a Boolean value indicating if an Rich Communication Services (RCS) capable phone number is online. ## -property-value A Boolean value indicating if an Rich Communication Services (RCS) capable phone number is online. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatCapabilities.IsOnline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilities.IsOnline + +## -description +Gets a Boolean value indicating if an Rich Communication Services (RCS) capable phone number is online. + +## -property-value +A Boolean value indicating if an Rich Communication Services (RCS) capable phone number is online. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilitiesmanager.md b/windows.applicationmodel.chat/chatcapabilitiesmanager.md index 4a5e206a5e..33196c27d5 100644 --- a/windows.applicationmodel.chat/chatcapabilitiesmanager.md +++ b/windows.applicationmodel.chat/chatcapabilitiesmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatCapabilitiesManager --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatCapabilitiesManager ## -description Provides functionality for getting chat capabilities. ## -remarks Call the [GetCachedCapabilitiesAsync](chatcapabilitiesmanager_getcachedcapabilitiesasync.md) or [GetCapabilitiesFromNetworkAsync](chatcapabilitiesmanager_getcapabilitiesfromnetworkasync.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatCapabilitiesManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilitiesManager + +## -description +Provides functionality for getting chat capabilities. + +## -remarks +Call the [GetCachedCapabilitiesAsync](chatcapabilitiesmanager_getcachedcapabilitiesasync.md) or [GetCapabilitiesFromNetworkAsync](chatcapabilitiesmanager_getcapabilitiesfromnetworkasync.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilitiesmanager_getcachedcapabilitiesasync_1447428004.md b/windows.applicationmodel.chat/chatcapabilitiesmanager_getcachedcapabilitiesasync_1447428004.md index abece4799e..63626eb1d3 100644 --- a/windows.applicationmodel.chat/chatcapabilitiesmanager_getcachedcapabilitiesasync_1447428004.md +++ b/windows.applicationmodel.chat/chatcapabilitiesmanager_getcachedcapabilitiesasync_1447428004.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCachedCapabilitiesAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCachedCapabilitiesAsync ## -description Asynchronously gets the locally cached Rich Communication Services (RCS) chat capabilities for the specified phone number. ## -parameters ### -param address The phone number for which to get the Rich Communication Services (RCS) chat capabilites ## -returns The locally cached Rich Communication Services (RCS) chat capabilities. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCachedCapabilitiesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCachedCapabilitiesAsync + +## -description +Asynchronously gets the locally cached Rich Communication Services (RCS) chat capabilities for the specified phone number. + +## -parameters +### -param address +The phone number for which to get the Rich Communication Services (RCS) chat capabilites + +## -returns +The locally cached Rich Communication Services (RCS) chat capabilities. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatcapabilitiesmanager_getcapabilitiesfromnetworkasync_886100284.md b/windows.applicationmodel.chat/chatcapabilitiesmanager_getcapabilitiesfromnetworkasync_886100284.md index fe2ff01d85..f1495e5b34 100644 --- a/windows.applicationmodel.chat/chatcapabilitiesmanager_getcapabilitiesfromnetworkasync_886100284.md +++ b/windows.applicationmodel.chat/chatcapabilitiesmanager_getcapabilitiesfromnetworkasync_886100284.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCapabilitiesFromNetworkAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCapabilitiesFromNetworkAsync ## -description Asynchronously gets the Rich Communication Services (RCS) chat capabilities for the specified phone number from the service provider. ## -parameters ### -param address The phone number for which to get the Rich Communication Services (RCS) chat capabilities. ## -returns The Rich Communication Services (RCS) chat capabilities from the service provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCapabilitiesFromNetworkAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatCapabilitiesManager.GetCapabilitiesFromNetworkAsync + +## -description +Asynchronously gets the Rich Communication Services (RCS) chat capabilities for the specified phone number from the service provider. + +## -parameters +### -param address +The phone number for which to get the Rich Communication Services (RCS) chat capabilities. + +## -returns +The Rich Communication Services (RCS) chat capabilities from the service provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation.md b/windows.applicationmodel.chat/chatconversation.md index 793c932f41..87a58d0933 100644 --- a/windows.applicationmodel.chat/chatconversation.md +++ b/windows.applicationmodel.chat/chatconversation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatConversation --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatConversation ## -description Represents a conversation in a chat client. ## -remarks Call the [ChatMessageStore.GetConversationAsync](chatmessagestore_getconversationasync.md) or [ChatMessageStore.GetConversationFromThreadingInfoAsync](chatmessagestore_getconversationfromthreadinginfoasync.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatConversation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation + +## -description +Represents a conversation in a chat client. + +## -remarks +Call the [ChatMessageStore.GetConversationAsync](chatmessagestore_getconversationasync.md) or [ChatMessageStore.GetConversationFromThreadingInfoAsync](chatmessagestore_getconversationfromthreadinginfoasync.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_canmodifyparticipants.md b/windows.applicationmodel.chat/chatconversation_canmodifyparticipants.md index 17e2012ba5..094fd746af 100644 --- a/windows.applicationmodel.chat/chatconversation_canmodifyparticipants.md +++ b/windows.applicationmodel.chat/chatconversation_canmodifyparticipants.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.CanModifyParticipants --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.CanModifyParticipants ## -description Gets or sets a boolean that indicates whether participants can be modified or not. ## -property-value A boolean that indicates whether participants can be modified or not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.CanModifyParticipants +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.CanModifyParticipants + +## -description +Gets or sets a boolean that indicates whether participants can be modified or not. + +## -property-value +A boolean that indicates whether participants can be modified or not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_deleteasync_1247887881.md b/windows.applicationmodel.chat/chatconversation_deleteasync_1247887881.md index 7710f179d8..b9d9fb181e 100644 --- a/windows.applicationmodel.chat/chatconversation_deleteasync_1247887881.md +++ b/windows.applicationmodel.chat/chatconversation_deleteasync_1247887881.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.DeleteAsync ## -description Asynchronously deletes all of the messages in the [ChatConversation](chatconversation.md) and the conversation itself. ## -returns An async action that indicates when the delete has completed. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.DeleteAsync + +## -description +Asynchronously deletes all of the messages in the [ChatConversation](chatconversation.md) and the conversation itself. + +## -returns +An async action that indicates when the delete has completed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversation_getmessagereader_1198599356.md b/windows.applicationmodel.chat/chatconversation_getmessagereader_1198599356.md index bcba999ce7..ea3aed5658 100644 --- a/windows.applicationmodel.chat/chatconversation_getmessagereader_1198599356.md +++ b/windows.applicationmodel.chat/chatconversation_getmessagereader_1198599356.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.GetMessageReader --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.GetMessageReader ## -description Gets the [ChatMessageReader](chatmessagereader.md) for this [ChatConversation](chatconversation.md). ## -returns The [ChatMessageReader](chatmessagereader.md) for this [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.GetMessageReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.GetMessageReader + +## -description +Gets the [ChatMessageReader](chatmessagereader.md) for this [ChatConversation](chatconversation.md). + +## -returns +The [ChatMessageReader](chatmessagereader.md) for this [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_hasunreadmessages.md b/windows.applicationmodel.chat/chatconversation_hasunreadmessages.md index b121654469..2abcd67e1f 100644 --- a/windows.applicationmodel.chat/chatconversation_hasunreadmessages.md +++ b/windows.applicationmodel.chat/chatconversation_hasunreadmessages.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.HasUnreadMessages --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.HasUnreadMessages ## -description Gets a Boolean value indicating if there are unread messages in the [ChatConversation](chatconversation.md). ## -property-value A Boolean value indicating if there are unread messages in the [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.HasUnreadMessages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.HasUnreadMessages + +## -description +Gets a Boolean value indicating if there are unread messages in the [ChatConversation](chatconversation.md). + +## -property-value +A Boolean value indicating if there are unread messages in the [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_id.md b/windows.applicationmodel.chat/chatconversation_id.md index 2c8df07a3d..aaa77a12e3 100644 --- a/windows.applicationmodel.chat/chatconversation_id.md +++ b/windows.applicationmodel.chat/chatconversation_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.Id --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.Id ## -description Gets the unique identifier for the [ChatConversation](chatconversation.md). ## -property-value The unique identifier for the [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.Id + +## -description +Gets the unique identifier for the [ChatConversation](chatconversation.md). + +## -property-value +The unique identifier for the [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_isconversationmuted.md b/windows.applicationmodel.chat/chatconversation_isconversationmuted.md index 0b64d9cfb2..262f576888 100644 --- a/windows.applicationmodel.chat/chatconversation_isconversationmuted.md +++ b/windows.applicationmodel.chat/chatconversation_isconversationmuted.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.IsConversationMuted --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.IsConversationMuted ## -description Gets or sets a Boolean value indicating if the [ChatConversation](chatconversation.md) is muted. ## -property-value A Boolean value indicating if the [ChatConversation](chatconversation.md) is muted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.IsConversationMuted +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.IsConversationMuted + +## -description +Gets or sets a Boolean value indicating if the [ChatConversation](chatconversation.md) is muted. + +## -property-value +A Boolean value indicating if the [ChatConversation](chatconversation.md) is muted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_itemkind.md b/windows.applicationmodel.chat/chatconversation_itemkind.md index 4357e337ff..7096fbe537 100644 --- a/windows.applicationmodel.chat/chatconversation_itemkind.md +++ b/windows.applicationmodel.chat/chatconversation_itemkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.ItemKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.ItemKind ## -description Gets the item kind. ## -property-value The item kind. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.ItemKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.ItemKind + +## -description +Gets the item kind. + +## -property-value +The item kind. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_2121795134.md b/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_2121795134.md index 0b41b03efd..e29fd2b2f5 100644 --- a/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_2121795134.md +++ b/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_2121795134.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync ## -description Asynchronously marks all the messages in the conversation before the specified [DateTime](../windows.foundation/datetime.md) as read. ## -parameters ### -param value Mark all messages before this [DateTime](../windows.foundation/datetime.md) as read. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also [MarkMessagesAsReadAsync](chatconversation_markmessagesasreadasync_826298191.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync + +## -description +Asynchronously marks all the messages in the conversation before the specified [DateTime](../windows.foundation/datetime.md) as read. + +## -parameters +### -param value +Mark all messages before this [DateTime](../windows.foundation/datetime.md) as read. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also +[MarkMessagesAsReadAsync](chatconversation_markmessagesasreadasync_826298191.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_826298191.md b/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_826298191.md index 0af1303614..0f94dabbe1 100644 --- a/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_826298191.md +++ b/windows.applicationmodel.chat/chatconversation_markmessagesasreadasync_826298191.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync ## -description Asynchronously marks all the messages in the conversation as read. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also [MarkMessagesAsReadAsync(DateTime)](chatconversation_markmessagesasreadasync_2121795134.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.MarkMessagesAsReadAsync + +## -description +Asynchronously marks all the messages in the conversation as read. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also +[MarkMessagesAsReadAsync(DateTime)](chatconversation_markmessagesasreadasync_2121795134.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversation_mostrecentmessageid.md b/windows.applicationmodel.chat/chatconversation_mostrecentmessageid.md index a96970b113..88f439736a 100644 --- a/windows.applicationmodel.chat/chatconversation_mostrecentmessageid.md +++ b/windows.applicationmodel.chat/chatconversation_mostrecentmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.MostRecentMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.MostRecentMessageId ## -description Gets the ID of the most recent message in the conversation. ## -property-value The ID of the most recent message in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.MostRecentMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.MostRecentMessageId + +## -description +Gets the ID of the most recent message in the conversation. + +## -property-value +The ID of the most recent message in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_notifylocalparticipantcomposing_1030664523.md b/windows.applicationmodel.chat/chatconversation_notifylocalparticipantcomposing_1030664523.md index 1b85a2a898..3175e8f5d8 100644 --- a/windows.applicationmodel.chat/chatconversation_notifylocalparticipantcomposing_1030664523.md +++ b/windows.applicationmodel.chat/chatconversation_notifylocalparticipantcomposing_1030664523.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.NotifyLocalParticipantComposing(System.String,System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.NotifyLocalParticipantComposing ## -description Call this to indicate that the local participant has started or has completed typing. ## -parameters ### -param transportId Specifies the [ChatMessageTransport](chatmessagetransport.md) to use. ### -param participantAddress The address of the remote participant. ### -param isComposing TRUE if the local participant is typing, otherwise FALSE. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.NotifyLocalParticipantComposing(System.String,System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.NotifyLocalParticipantComposing + +## -description +Call this to indicate that the local participant has started or has completed typing. + +## -parameters +### -param transportId +Specifies the [ChatMessageTransport](chatmessagetransport.md) to use. + +### -param participantAddress +The address of the remote participant. + +### -param isComposing +TRUE if the local participant is typing, otherwise FALSE. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_notifyremoteparticipantcomposing_1775292933.md b/windows.applicationmodel.chat/chatconversation_notifyremoteparticipantcomposing_1775292933.md index 6ca2d9b565..54fe9d7b20 100644 --- a/windows.applicationmodel.chat/chatconversation_notifyremoteparticipantcomposing_1775292933.md +++ b/windows.applicationmodel.chat/chatconversation_notifyremoteparticipantcomposing_1775292933.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.NotifyRemoteParticipantComposing(System.String,System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.NotifyRemoteParticipantComposing ## -description Locally triggers the event that indicates that a remote participant is typing. ## -parameters ### -param transportId Specifies the [ChatMessageTransport](chatmessagetransport.md) to use. ### -param participantAddress The address of the remote participant. ### -param isComposing TRUE if the remote participant is typing, otherwise FALSE. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.NotifyRemoteParticipantComposing(System.String,System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.NotifyRemoteParticipantComposing + +## -description +Locally triggers the event that indicates that a remote participant is typing. + +## -parameters +### -param transportId +Specifies the [ChatMessageTransport](chatmessagetransport.md) to use. + +### -param participantAddress +The address of the remote participant. + +### -param isComposing +TRUE if the remote participant is typing, otherwise FALSE. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_participants.md b/windows.applicationmodel.chat/chatconversation_participants.md index 5211715649..24917b9ac7 100644 --- a/windows.applicationmodel.chat/chatconversation_participants.md +++ b/windows.applicationmodel.chat/chatconversation_participants.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.Participants --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.Participants ## -description Gets a list of all the participants in the conversation. ## -property-value A list of all the participants in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.Participants +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.Participants + +## -description +Gets a list of all the participants in the conversation. + +## -property-value +A list of all the participants in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_remoteparticipantcomposingchanged.md b/windows.applicationmodel.chat/chatconversation_remoteparticipantcomposingchanged.md index 7a8d52e9e7..07fabc9d90 100644 --- a/windows.applicationmodel.chat/chatconversation_remoteparticipantcomposingchanged.md +++ b/windows.applicationmodel.chat/chatconversation_remoteparticipantcomposingchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Chat.ChatConversation.RemoteParticipantComposingChanged --api-type: winrt event ---- # Windows.ApplicationModel.Chat.ChatConversation.RemoteParticipantComposingChanged ## -description Occurs when the remote user has started or finished typing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Chat.ChatConversation.RemoteParticipantComposingChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.RemoteParticipantComposingChanged + +## -description +Occurs when the remote user has started or finished typing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_saveasync_2143735121.md b/windows.applicationmodel.chat/chatconversation_saveasync_2143735121.md index 5caec52064..2d5bd807d2 100644 --- a/windows.applicationmodel.chat/chatconversation_saveasync_2143735121.md +++ b/windows.applicationmodel.chat/chatconversation_saveasync_2143735121.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversation.SaveAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversation.SaveAsync ## -description Asynchronously saves the [ChatConversation](chatconversation.md). ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversation.SaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.SaveAsync + +## -description +Asynchronously saves the [ChatConversation](chatconversation.md). + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversation_subject.md b/windows.applicationmodel.chat/chatconversation_subject.md index 6c537797df..a7484d5b59 100644 --- a/windows.applicationmodel.chat/chatconversation_subject.md +++ b/windows.applicationmodel.chat/chatconversation_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.Subject ## -description Gets or sets the subject of a group conversation. ## -property-value The subject of a group conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.Subject + +## -description +Gets or sets the subject of a group conversation. + +## -property-value +The subject of a group conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversation_threadinginfo.md b/windows.applicationmodel.chat/chatconversation_threadinginfo.md index d82e60bb7b..563730f5b6 100644 --- a/windows.applicationmodel.chat/chatconversation_threadinginfo.md +++ b/windows.applicationmodel.chat/chatconversation_threadinginfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversation.ThreadingInfo --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversation.ThreadingInfo ## -description Gets the threading info for the [ChatConversation](chatconversation.md). ## -property-value The threading info for the [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversation.ThreadingInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversation.ThreadingInfo + +## -description +Gets the threading info for the [ChatConversation](chatconversation.md). + +## -property-value +The threading info for the [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationreader.md b/windows.applicationmodel.chat/chatconversationreader.md index 027b008d07..954d5789da 100644 --- a/windows.applicationmodel.chat/chatconversationreader.md +++ b/windows.applicationmodel.chat/chatconversationreader.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatConversationReader --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatConversationReader ## -description Provides functionality for reading batches of conversations from the [ChatMessageStore](chatmessagestore.md). ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatConversationReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationReader + +## -description +Provides functionality for reading batches of conversations from the [ChatMessageStore](chatmessagestore.md). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversationreader_readbatchasync_1346490639.md b/windows.applicationmodel.chat/chatconversationreader_readbatchasync_1346490639.md index be9c286a4d..a1ba8469c1 100644 --- a/windows.applicationmodel.chat/chatconversationreader_readbatchasync_1346490639.md +++ b/windows.applicationmodel.chat/chatconversationreader_readbatchasync_1346490639.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync(System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync ## -description Asynchronously reads batches of conversations from the [ChatMessageStore](chatmessagestore.md). ## -parameters ### -param count Specifies the size of the batch to read. ## -returns The list of conversations. ## -remarks ## -examples ## -see-also [ReadBatchAsync](chatconversationreader_readbatchasync_888788553.md) ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync(System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync + +## -description +Asynchronously reads batches of conversations from the [ChatMessageStore](chatmessagestore.md). + +## -parameters +### -param count +Specifies the size of the batch to read. + +## -returns +The list of conversations. + +## -remarks + +## -examples + +## -see-also +[ReadBatchAsync](chatconversationreader_readbatchasync_888788553.md) + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversationreader_readbatchasync_888788553.md b/windows.applicationmodel.chat/chatconversationreader_readbatchasync_888788553.md index b8d77da3ee..f4173e1ef4 100644 --- a/windows.applicationmodel.chat/chatconversationreader_readbatchasync_888788553.md +++ b/windows.applicationmodel.chat/chatconversationreader_readbatchasync_888788553.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync ## -description Asynchronously reads batches of conversations from the [ChatMessageStore](chatmessagestore.md). ## -returns The list of conversations. ## -remarks ## -examples ## -see-also [ReadBatchAsync(Int32)](chatconversationreader_readbatchasync_1346490639.md) ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationReader.ReadBatchAsync + +## -description +Asynchronously reads batches of conversations from the [ChatMessageStore](chatmessagestore.md). + +## -returns +The list of conversations. + +## -remarks + +## -examples + +## -see-also +[ReadBatchAsync(Int32)](chatconversationreader_readbatchasync_1346490639.md) + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo.md b/windows.applicationmodel.chat/chatconversationthreadinginfo.md index 3f170b3690..aa194827ce 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo ## -description Provides threading info for a [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo + +## -description +Provides threading info for a [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo_chatconversationthreadinginfo_1221375020.md b/windows.applicationmodel.chat/chatconversationthreadinginfo_chatconversationthreadinginfo_1221375020.md index d04c6092ad..f7731cdb8b 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo_chatconversationthreadinginfo_1221375020.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo_chatconversationthreadinginfo_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ChatConversationThreadingInfo ## -description Initializes a new instance of the [ChatConversationThreadingInfo](chatconversationthreadinginfo.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ChatConversationThreadingInfo + +## -description +Initializes a new instance of the [ChatConversationThreadingInfo](chatconversationthreadinginfo.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo_contactid.md b/windows.applicationmodel.chat/chatconversationthreadinginfo_contactid.md index daa183f22f..62837d1741 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo_contactid.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo_contactid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ContactId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ContactId ## -description Gets or sets the [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) for the remote participant. ## -property-value The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) for the remote participant. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ContactId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ContactId + +## -description +Gets or sets the [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) for the remote participant. + +## -property-value +The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) for the remote participant. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo_conversationid.md b/windows.applicationmodel.chat/chatconversationthreadinginfo_conversationid.md index 9e0c1a4ead..7323c1307c 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo_conversationid.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo_conversationid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ConversationId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ConversationId ## -description Gets or sets the ID of the [ChatConversation](chatconversation.md). ## -property-value The ID of the [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ConversationId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.ConversationId + +## -description +Gets or sets the ID of the [ChatConversation](chatconversation.md). + +## -property-value +The ID of the [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo_custom.md b/windows.applicationmodel.chat/chatconversationthreadinginfo_custom.md index 0d14316a35..12c9e7440a 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo_custom.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo_custom.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Custom --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Custom ## -description Gets or sets a string where you can store your own custom threading info. ## -property-value A string where you can store your own custom threading info. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Custom +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Custom + +## -description +Gets or sets a string where you can store your own custom threading info. + +## -property-value +A string where you can store your own custom threading info. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo_kind.md b/windows.applicationmodel.chat/chatconversationthreadinginfo_kind.md index 993d29cc4d..1f12e6f6cb 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo_kind.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Kind ## -description Gets or sets a value that indicates the type of threading info, such as participant, contact ID, conversation ID, and so on. ## -property-value A value that indicates the type of threading info. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Kind + +## -description +Gets or sets a value that indicates the type of threading info, such as participant, contact ID, conversation ID, and so on. + +## -property-value +A value that indicates the type of threading info. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatconversationthreadinginfo_participants.md b/windows.applicationmodel.chat/chatconversationthreadinginfo_participants.md index c66e22d229..a6c7027c8b 100644 --- a/windows.applicationmodel.chat/chatconversationthreadinginfo_participants.md +++ b/windows.applicationmodel.chat/chatconversationthreadinginfo_participants.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Participants --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Participants ## -description Gets the list of participants in the [ChatConversation](chatconversation.md). ## -property-value The list of participants in the [ChatConversation](chatconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Participants +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatConversationThreadingInfo.Participants + +## -description +Gets the list of participants in the [ChatConversation](chatconversation.md). + +## -property-value +The list of participants in the [ChatConversation](chatconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage.md b/windows.applicationmodel.chat/chatmessage.md index 5b1083ae2f..e1478c8c4f 100644 --- a/windows.applicationmodel.chat/chatmessage.md +++ b/windows.applicationmodel.chat/chatmessage.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessage --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessage ## -description Represents a chat message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessage +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage + +## -description +Represents a chat message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_attachments.md b/windows.applicationmodel.chat/chatmessage_attachments.md index 1f0d27a224..885dd26866 100644 --- a/windows.applicationmodel.chat/chatmessage_attachments.md +++ b/windows.applicationmodel.chat/chatmessage_attachments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Attachments --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.Attachments ## -description Gets a list of chat message attachments. ## -property-value A list of chat message attachments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Attachments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.Attachments + +## -description +Gets a list of chat message attachments. + +## -property-value +A list of chat message attachments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_body.md b/windows.applicationmodel.chat/chatmessage_body.md index 0d71e25aac..f6e1503d9d 100644 --- a/windows.applicationmodel.chat/chatmessage_body.md +++ b/windows.applicationmodel.chat/chatmessage_body.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Body --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.Body ## -description Gets or sets the body of the chat message. ## -property-value The body of the chat message. ## -remarks When an application invokes the compose task, the [Body](chatmessage_body.md) property can contain an initialized string value to appear when the compose task is launched. If a message has more than one recipient and group text is enabled, the default case, the message is sent as an MMS message. In this situation, the message text is included as the first attachment and not in the [Body](chatmessage_body.md). For a message with a single recipient, the [Body](chatmessage_body.md) is used for an SMS message and [Subject](chatmessage_subject.md) property is valid for an MMS message. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Body +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.Body + +## -description +Gets or sets the body of the chat message. + +## -property-value +The body of the chat message. + +## -remarks +When an application invokes the compose task, the [Body](chatmessage_body.md) property can contain an initialized string value to appear when the compose task is launched. + +If a message has more than one recipient and group text is enabled, the default case, the message is sent as an MMS message. In this situation, the message text is included as the first attachment and not in the [Body](chatmessage_body.md). For a message with a single recipient, the [Body](chatmessage_body.md) is used for an SMS message and [Subject](chatmessage_subject.md) property is valid for an MMS message. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_chatmessage_1221375020.md b/windows.applicationmodel.chat/chatmessage_chatmessage_1221375020.md index f460f96f90..e065f4059b 100644 --- a/windows.applicationmodel.chat/chatmessage_chatmessage_1221375020.md +++ b/windows.applicationmodel.chat/chatmessage_chatmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessage.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessage.ChatMessage ## -description Creates a new instance of the [ChatMessage](chatmessage.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.ChatMessage + +## -description +Creates a new instance of the [ChatMessage](chatmessage.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_estimateddownloadsize.md b/windows.applicationmodel.chat/chatmessage_estimateddownloadsize.md index 0cd2d4c7bc..245620d184 100644 --- a/windows.applicationmodel.chat/chatmessage_estimateddownloadsize.md +++ b/windows.applicationmodel.chat/chatmessage_estimateddownloadsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.EstimatedDownloadSize --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.EstimatedDownloadSize ## -description Gets or sets the estimated size of a file to be sent or received. ## -property-value The estimated size of a file to be sent or received. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.EstimatedDownloadSize +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.EstimatedDownloadSize + +## -description +Gets or sets the estimated size of a file to be sent or received. + +## -property-value +The estimated size of a file to be sent or received. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_from.md b/windows.applicationmodel.chat/chatmessage_from.md index 299e752438..56a5ac22e0 100644 --- a/windows.applicationmodel.chat/chatmessage_from.md +++ b/windows.applicationmodel.chat/chatmessage_from.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.From --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.From ## -description Gets the identifier or address of the sender of the message. ## -property-value The sender of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.From +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.From + +## -description +Gets the identifier or address of the sender of the message. + +## -property-value +The sender of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_id.md b/windows.applicationmodel.chat/chatmessage_id.md index 357c43ab3d..dd556b43ff 100644 --- a/windows.applicationmodel.chat/chatmessage_id.md +++ b/windows.applicationmodel.chat/chatmessage_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Id --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.Id ## -description Gets the identifier of the message. ## -property-value The ID of the chat message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.Id + +## -description +Gets the identifier of the message. + +## -property-value +The ID of the chat message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isautoreply.md b/windows.applicationmodel.chat/chatmessage_isautoreply.md index f8cd97816b..8a412adc9e 100644 --- a/windows.applicationmodel.chat/chatmessage_isautoreply.md +++ b/windows.applicationmodel.chat/chatmessage_isautoreply.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsAutoReply --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsAutoReply ## -description Gets or sets a Boolean value indicating if the message is an auto-reply. ## -property-value A Boolean value indicating if the message is an auto-reply. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsAutoReply +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsAutoReply + +## -description +Gets or sets a Boolean value indicating if the message is an auto-reply. + +## -property-value +A Boolean value indicating if the message is an auto-reply. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isforwardingdisabled.md b/windows.applicationmodel.chat/chatmessage_isforwardingdisabled.md index 9160f3f9e1..bb8ee1d2fc 100644 --- a/windows.applicationmodel.chat/chatmessage_isforwardingdisabled.md +++ b/windows.applicationmodel.chat/chatmessage_isforwardingdisabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsForwardingDisabled --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsForwardingDisabled ## -description Gets a Boolean value indicating if forwarding is disabled. ## -property-value A Boolean value indicating if forwarding is disabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsForwardingDisabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsForwardingDisabled + +## -description +Gets a Boolean value indicating if forwarding is disabled. + +## -property-value +A Boolean value indicating if forwarding is disabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isincoming.md b/windows.applicationmodel.chat/chatmessage_isincoming.md index 9b535470c5..4855796d65 100644 --- a/windows.applicationmodel.chat/chatmessage_isincoming.md +++ b/windows.applicationmodel.chat/chatmessage_isincoming.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsIncoming --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsIncoming ## -description Gets Boolean a value indicating if the message is incoming or outgoing. ## -property-value A Boolean value indicating if the message is incoming or outgoing. TRUE indicates incoming, FALSE indicates outgoing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsIncoming +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsIncoming + +## -description +Gets Boolean a value indicating if the message is incoming or outgoing. + +## -property-value +A Boolean value indicating if the message is incoming or outgoing. TRUE indicates incoming, FALSE indicates outgoing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isread.md b/windows.applicationmodel.chat/chatmessage_isread.md index 2c21cd7bec..a9a5a46329 100644 --- a/windows.applicationmodel.chat/chatmessage_isread.md +++ b/windows.applicationmodel.chat/chatmessage_isread.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsRead --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsRead ## -description Gets a Boolean value indicating if the message has been read. ## -property-value A Boolean value indicating if the message has been read. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsRead +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsRead + +## -description +Gets a Boolean value indicating if the message has been read. + +## -property-value +A Boolean value indicating if the message has been read. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isreceivedduringquiethours.md b/windows.applicationmodel.chat/chatmessage_isreceivedduringquiethours.md index 72ef0b916c..bbd13baa11 100644 --- a/windows.applicationmodel.chat/chatmessage_isreceivedduringquiethours.md +++ b/windows.applicationmodel.chat/chatmessage_isreceivedduringquiethours.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsReceivedDuringQuietHours --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsReceivedDuringQuietHours ## -description Gets or sets a Boolean value indicating if the message was received during user specified quiet hours. ## -property-value A Boolean value indicating if the message was received during user specified quiet hours. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsReceivedDuringQuietHours +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsReceivedDuringQuietHours + +## -description +Gets or sets a Boolean value indicating if the message was received during user specified quiet hours. + +## -property-value +A Boolean value indicating if the message was received during user specified quiet hours. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isreplydisabled.md b/windows.applicationmodel.chat/chatmessage_isreplydisabled.md index c89aa43e0e..9d1eab9f15 100644 --- a/windows.applicationmodel.chat/chatmessage_isreplydisabled.md +++ b/windows.applicationmodel.chat/chatmessage_isreplydisabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsReplyDisabled --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsReplyDisabled ## -description Gets a Boolean value indicating if reply is disabled on the [ChatMessage](chatmessage.md). ## -property-value A Boolean value indicating if reply is disabled on the [ChatMessage](chatmessage.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsReplyDisabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsReplyDisabled + +## -description +Gets a Boolean value indicating if reply is disabled on the [ChatMessage](chatmessage.md). + +## -property-value +A Boolean value indicating if reply is disabled on the [ChatMessage](chatmessage.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_isseen.md b/windows.applicationmodel.chat/chatmessage_isseen.md index 3420068ab3..19fe5d6a11 100644 --- a/windows.applicationmodel.chat/chatmessage_isseen.md +++ b/windows.applicationmodel.chat/chatmessage_isseen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsSeen --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsSeen ## -description Gets or sets a Boolean value indicating if the message has been seen. ## -property-value A Boolean value indicating if the message has been seen. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsSeen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsSeen + +## -description +Gets or sets a Boolean value indicating if the message has been seen. + +## -property-value +A Boolean value indicating if the message has been seen. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_issimmessage.md b/windows.applicationmodel.chat/chatmessage_issimmessage.md index 14928b4873..bdf4d2687b 100644 --- a/windows.applicationmodel.chat/chatmessage_issimmessage.md +++ b/windows.applicationmodel.chat/chatmessage_issimmessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsSimMessage --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.IsSimMessage ## -description Gets a Boolean value indicating if the message is stored on a SIM card. ## -property-value A Boolean value indicating if the message is stored on a SIM card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.IsSimMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.IsSimMessage + +## -description +Gets a Boolean value indicating if the message is stored on a SIM card. + +## -property-value +A Boolean value indicating if the message is stored on a SIM card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_itemkind.md b/windows.applicationmodel.chat/chatmessage_itemkind.md index b6c308b1f5..86460d0c39 100644 --- a/windows.applicationmodel.chat/chatmessage_itemkind.md +++ b/windows.applicationmodel.chat/chatmessage_itemkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.ItemKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.ItemKind ## -description Gets the item kind. ## -property-value The item kind. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.ItemKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.ItemKind + +## -description +Gets the item kind. + +## -property-value +The item kind. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_localtimestamp.md b/windows.applicationmodel.chat/chatmessage_localtimestamp.md index 506d882599..94f118151b 100644 --- a/windows.applicationmodel.chat/chatmessage_localtimestamp.md +++ b/windows.applicationmodel.chat/chatmessage_localtimestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.LocalTimestamp --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.LocalTimestamp ## -description Gets the local timestamp of the message. ## -property-value The local timestamp of the message. ## -remarks The value for [LocalTimestamp](chatmessage_localtimestamp.md) is the local time of the device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.LocalTimestamp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.LocalTimestamp + +## -description +Gets the local timestamp of the message. + +## -property-value +The local timestamp of the message. + +## -remarks +The value for [LocalTimestamp](chatmessage_localtimestamp.md) is the local time of the device. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_messagekind.md b/windows.applicationmodel.chat/chatmessage_messagekind.md index 72c6ab23ef..3bcb2898e6 100644 --- a/windows.applicationmodel.chat/chatmessage_messagekind.md +++ b/windows.applicationmodel.chat/chatmessage_messagekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.MessageKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.MessageKind ## -description Gets or sets the type of the [ChatMessage](chatmessage.md). ## -property-value The type of message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.MessageKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.MessageKind + +## -description +Gets or sets the type of the [ChatMessage](chatmessage.md). + +## -property-value +The type of message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_messageoperatorkind.md b/windows.applicationmodel.chat/chatmessage_messageoperatorkind.md index 9232fa8d4f..82ea239df3 100644 --- a/windows.applicationmodel.chat/chatmessage_messageoperatorkind.md +++ b/windows.applicationmodel.chat/chatmessage_messageoperatorkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.MessageOperatorKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.MessageOperatorKind ## -description Gets or sets a value indicating the type of message operator, such as SMS, MMS, or RCS. ## -property-value The type of message operator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.MessageOperatorKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.MessageOperatorKind + +## -description +Gets or sets a value indicating the type of message operator, such as SMS, MMS, or RCS. + +## -property-value +The type of message operator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_networktimestamp.md b/windows.applicationmodel.chat/chatmessage_networktimestamp.md index e1851022d6..bb9c362b5b 100644 --- a/windows.applicationmodel.chat/chatmessage_networktimestamp.md +++ b/windows.applicationmodel.chat/chatmessage_networktimestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.NetworkTimestamp --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.NetworkTimestamp ## -description Gets the network timestamp of the message. ## -property-value The network timestamp of the message. ## -remarks The value for [NetworkTimestamp](chatmessage_networktimestamp.md) is the phone network based time for the message. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.NetworkTimestamp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.NetworkTimestamp + +## -description +Gets the network timestamp of the message. + +## -property-value +The network timestamp of the message. + +## -remarks +The value for [NetworkTimestamp](chatmessage_networktimestamp.md) is the phone network based time for the message. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_recipients.md b/windows.applicationmodel.chat/chatmessage_recipients.md index cdc57cb956..6ec6cc4c83 100644 --- a/windows.applicationmodel.chat/chatmessage_recipients.md +++ b/windows.applicationmodel.chat/chatmessage_recipients.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Recipients --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.Recipients ## -description Gets the list of recipients of the message. ## -property-value The list of recipients of the message. ## -remarks The recipient strings in the list can be either contact names, addresses, or phone numbers. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Recipients +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.Recipients + +## -description +Gets the list of recipients of the message. + +## -property-value +The list of recipients of the message. + +## -remarks +The recipient strings in the list can be either contact names, addresses, or phone numbers. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_recipientsdeliveryinfos.md b/windows.applicationmodel.chat/chatmessage_recipientsdeliveryinfos.md index 3db9ac1a52..b4a78a73e6 100644 --- a/windows.applicationmodel.chat/chatmessage_recipientsdeliveryinfos.md +++ b/windows.applicationmodel.chat/chatmessage_recipientsdeliveryinfos.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.RecipientsDeliveryInfos --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.RecipientsDeliveryInfos ## -description Gets the delivery info for each of the recipients of the [ChatMessage](chatmessage.md). ## -property-value The delivery info for the recipients of the [ChatMessage](chatmessage.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.RecipientsDeliveryInfos +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.RecipientsDeliveryInfos + +## -description +Gets the delivery info for each of the recipients of the [ChatMessage](chatmessage.md). + +## -property-value +The delivery info for the recipients of the [ChatMessage](chatmessage.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_recipientsendstatuses.md b/windows.applicationmodel.chat/chatmessage_recipientsendstatuses.md index 84b4dbdee0..e11388027b 100644 --- a/windows.applicationmodel.chat/chatmessage_recipientsendstatuses.md +++ b/windows.applicationmodel.chat/chatmessage_recipientsendstatuses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.RecipientSendStatuses --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.RecipientSendStatuses ## -description Gets the list of send statuses for the message. ## -property-value The recipient send statuses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.RecipientSendStatuses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.RecipientSendStatuses + +## -description +Gets the list of send statuses for the message. + +## -property-value +The recipient send statuses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_remoteid.md b/windows.applicationmodel.chat/chatmessage_remoteid.md index 314dcc2377..0da6b8b025 100644 --- a/windows.applicationmodel.chat/chatmessage_remoteid.md +++ b/windows.applicationmodel.chat/chatmessage_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.RemoteId ## -description Gets or sets the remote ID for the [ChatMessage](chatmessage.md). ## -property-value The remote ID for the [ChatMessage](chatmessage.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.RemoteId + +## -description +Gets or sets the remote ID for the [ChatMessage](chatmessage.md). + +## -property-value +The remote ID for the [ChatMessage](chatmessage.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_shouldsuppressnotification.md b/windows.applicationmodel.chat/chatmessage_shouldsuppressnotification.md index 1b8dcb0fd4..d2f9c9bc9e 100644 --- a/windows.applicationmodel.chat/chatmessage_shouldsuppressnotification.md +++ b/windows.applicationmodel.chat/chatmessage_shouldsuppressnotification.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.ShouldSuppressNotification --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.ShouldSuppressNotification ## -description Gets or sets a Boolean value indicating if notification of receiving the [ChatMessage](chatmessage.md) should be suppressed. ## -property-value A Boolean value indicating if notification of receiving the [ChatMessage](chatmessage.md) should be suppressed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.ShouldSuppressNotification +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.ShouldSuppressNotification + +## -description +Gets or sets a Boolean value indicating if notification of receiving the [ChatMessage](chatmessage.md) should be suppressed. + +## -property-value +A Boolean value indicating if notification of receiving the [ChatMessage](chatmessage.md) should be suppressed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_status.md b/windows.applicationmodel.chat/chatmessage_status.md index 9f951aa441..0b04c7b75f 100644 --- a/windows.applicationmodel.chat/chatmessage_status.md +++ b/windows.applicationmodel.chat/chatmessage_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Status --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.Status ## -description Gets the status of the message. Typical states include draft, sent, received, deleted, etc. ## -property-value The status of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.Status + +## -description +Gets the status of the message. Typical states include draft, sent, received, deleted, etc. + +## -property-value +The status of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_subject.md b/windows.applicationmodel.chat/chatmessage_subject.md index d8ebf83de9..5948c6be60 100644 --- a/windows.applicationmodel.chat/chatmessage_subject.md +++ b/windows.applicationmodel.chat/chatmessage_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.Subject ## -description Gets the subject of the message. ## -property-value The subject of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.Subject + +## -description +Gets the subject of the message. + +## -property-value +The subject of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_syncid.md b/windows.applicationmodel.chat/chatmessage_syncid.md index 8bb6a9145e..b3159a8fef 100644 --- a/windows.applicationmodel.chat/chatmessage_syncid.md +++ b/windows.applicationmodel.chat/chatmessage_syncid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.SyncId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.SyncId ## -description The ID used to identify a message across devices. This ID is generated on creation for all messages. Clients that copy messages between devices also need to copy this ID in order to uniquely identify the same message on different devices ## -property-value Gets and sets the sync ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.SyncId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.SyncId + +## -description +The ID used to identify a message across devices. This ID is generated on creation for all messages. Clients that copy messages between devices also need to copy this ID in order to uniquely identify the same message on different devices + +## -property-value +Gets and sets the sync ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_threadinginfo.md b/windows.applicationmodel.chat/chatmessage_threadinginfo.md index 1ef57af65d..52e9f79d9b 100644 --- a/windows.applicationmodel.chat/chatmessage_threadinginfo.md +++ b/windows.applicationmodel.chat/chatmessage_threadinginfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.ThreadingInfo --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.ThreadingInfo ## -description Gets or sets the conversation threading info for the [ChatMessage](chatmessage.md). ## -property-value The conversation threading info for the [ChatMessage](chatmessage.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.ThreadingInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.ThreadingInfo + +## -description +Gets or sets the conversation threading info for the [ChatMessage](chatmessage.md). + +## -property-value +The conversation threading info for the [ChatMessage](chatmessage.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_transportfriendlyname.md b/windows.applicationmodel.chat/chatmessage_transportfriendlyname.md index 4550ea1abc..49e9ac437c 100644 --- a/windows.applicationmodel.chat/chatmessage_transportfriendlyname.md +++ b/windows.applicationmodel.chat/chatmessage_transportfriendlyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.TransportFriendlyName --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.TransportFriendlyName ## -description Gets the transport friendly name of the message. ## -property-value The transport friendly name of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.TransportFriendlyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.TransportFriendlyName + +## -description +Gets the transport friendly name of the message. + +## -property-value +The transport friendly name of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessage_transportid.md b/windows.applicationmodel.chat/chatmessage_transportid.md index 640a98e7f5..fce1a4a995 100644 --- a/windows.applicationmodel.chat/chatmessage_transportid.md +++ b/windows.applicationmodel.chat/chatmessage_transportid.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessage.TransportId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessage.TransportId ## -description Gets or sets the transport ID of the message. ## -property-value The transport ID of the message. ## -remarks Setting this property assigns the transport, SIM slot, to use for sending the chat message. Querying this property will identify the transport that the message was received on or is currently set for sending. The value for [TransportId](chatmessage_transportid.md) is the string representation of the SIM slot number. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessage.TransportId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessage.TransportId + +## -description +Gets or sets the transport ID of the message. + +## -property-value +The transport ID of the message. + +## -remarks +Setting this property assigns the transport, SIM slot, to use for sending the chat message. Querying this property will identify the transport that the message was received on or is currently set for sending. + +The value for [TransportId](chatmessage_transportid.md) is the string representation of the SIM slot number. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment.md b/windows.applicationmodel.chat/chatmessageattachment.md index fc087f080c..8eb18496da 100644 --- a/windows.applicationmodel.chat/chatmessageattachment.md +++ b/windows.applicationmodel.chat/chatmessageattachment.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageAttachment --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment ## -description Represents an attachment to a chat message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageAttachment +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment + +## -description +Represents an attachment to a chat message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_chatmessageattachment_1759667898.md b/windows.applicationmodel.chat/chatmessageattachment_chatmessageattachment_1759667898.md index fc7a534989..4724766bc6 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_chatmessageattachment_1759667898.md +++ b/windows.applicationmodel.chat/chatmessageattachment_chatmessageattachment_1759667898.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageAttachment.#ctor(System.String,Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.ChatMessageAttachment ## -description Initializes a new instance of the [ChatMessageAttachment](chatmessageattachment.md) class. ## -parameters ### -param mimeType The MIME type of the attachment. ### -param dataStreamReference A stream containing the attachment data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageAttachment.#ctor(System.String,Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.ChatMessageAttachment + +## -description +Initializes a new instance of the [ChatMessageAttachment](chatmessageattachment.md) class. + +## -parameters +### -param mimeType +The MIME type of the attachment. + +### -param dataStreamReference +A stream containing the attachment data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_datastreamreference.md b/windows.applicationmodel.chat/chatmessageattachment_datastreamreference.md index 5855c418bb..81fa03bbf3 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_datastreamreference.md +++ b/windows.applicationmodel.chat/chatmessageattachment_datastreamreference.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.DataStreamReference --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.DataStreamReference ## -description Gets or sets a stream reference for a message attachment. ## -property-value The data stream for the attachment. ## -remarks The data source for an attachment is accessed through a [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) interface. The [DataStreamReference](chatmessageattachment_datastreamreference.md) property is set to the stream reference that encapsulates the attachment data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.DataStreamReference +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.DataStreamReference + +## -description +Gets or sets a stream reference for a message attachment. + +## -property-value +The data stream for the attachment. + +## -remarks +The data source for an attachment is accessed through a [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) interface. The [DataStreamReference](chatmessageattachment_datastreamreference.md) property is set to the stream reference that encapsulates the attachment data. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_groupid.md b/windows.applicationmodel.chat/chatmessageattachment_groupid.md index a86b7c250f..855062c186 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_groupid.md +++ b/windows.applicationmodel.chat/chatmessageattachment_groupid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.GroupId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.GroupId ## -description Gets or sets the identifier for the attachment group to which this attachment belongs. ## -property-value The group ID of the attachment. ## -remarks Attachment groups contain one or more attachments. All attachments belonging to a message are part of the same group. The [GroupId](chatmessageattachment_groupid.md) identifies the attachments associated with a particular message. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.GroupId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.GroupId + +## -description +Gets or sets the identifier for the attachment group to which this attachment belongs. + +## -property-value +The group ID of the attachment. + +## -remarks +Attachment groups contain one or more attachments. All attachments belonging to a message are part of the same group. The [GroupId](chatmessageattachment_groupid.md) identifies the attachments associated with a particular message. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_mimetype.md b/windows.applicationmodel.chat/chatmessageattachment_mimetype.md index 66c8187fd3..ef4158ac27 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_mimetype.md +++ b/windows.applicationmodel.chat/chatmessageattachment_mimetype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.MimeType --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.MimeType ## -description Gets or sets the MIME type of the attachment. ## -property-value The MIME type of the attachment. ## -remarks A chat application handles an attachment based on the MIME type set in this property. Attachments for outgoing messages have [MimeType](chatmessageattachment_mimetype.md) set to a type string for recipient handling, such as “image/jpeg”. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.MimeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.MimeType + +## -description +Gets or sets the MIME type of the attachment. + +## -property-value +The MIME type of the attachment. + +## -remarks +A chat application handles an attachment based on the MIME type set in this property. Attachments for outgoing messages have [MimeType](chatmessageattachment_mimetype.md) set to a type string for recipient handling, such as “image/jpeg”. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_originalfilename.md b/windows.applicationmodel.chat/chatmessageattachment_originalfilename.md index 3c1b9c0438..f64c29e9e6 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_originalfilename.md +++ b/windows.applicationmodel.chat/chatmessageattachment_originalfilename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.OriginalFileName --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.OriginalFileName ## -description Gets or sets the original file name of the attachment. ## -property-value The original file name of the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.OriginalFileName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.OriginalFileName + +## -description +Gets or sets the original file name of the attachment. + +## -property-value +The original file name of the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_text.md b/windows.applicationmodel.chat/chatmessageattachment_text.md index 021b6e99ec..b3c69ea90a 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_text.md +++ b/windows.applicationmodel.chat/chatmessageattachment_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.Text --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.Text ## -description Gets or sets the text encoded representation of the attachment object. ## -property-value The text of the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.Text + +## -description +Gets or sets the text encoded representation of the attachment object. + +## -property-value +The text of the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_thumbnail.md b/windows.applicationmodel.chat/chatmessageattachment_thumbnail.md index 9d7643d43c..df62107e57 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_thumbnail.md +++ b/windows.applicationmodel.chat/chatmessageattachment_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.Thumbnail --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.Thumbnail ## -description Gets or sets the thumbnail image for the attachment. ## -property-value The thumbnail image for the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.Thumbnail + +## -description +Gets or sets the thumbnail image for the attachment. + +## -property-value +The thumbnail image for the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageattachment_transferprogress.md b/windows.applicationmodel.chat/chatmessageattachment_transferprogress.md index 7a65a7d166..1bedf64b60 100644 --- a/windows.applicationmodel.chat/chatmessageattachment_transferprogress.md +++ b/windows.applicationmodel.chat/chatmessageattachment_transferprogress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.TransferProgress --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageAttachment.TransferProgress ## -description Gets or sets the progress of transferring the attachment. ## -property-value The progress of transferring the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageAttachment.TransferProgress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageAttachment.TransferProgress + +## -description +Gets or sets the progress of transferring the attachment. + +## -property-value +The progress of transferring the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageblocking.md b/windows.applicationmodel.chat/chatmessageblocking.md index aa19410638..4fb08a56d4 100644 --- a/windows.applicationmodel.chat/chatmessageblocking.md +++ b/windows.applicationmodel.chat/chatmessageblocking.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageBlocking --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageBlocking ## -description Provides functionality for blocking messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageBlocking +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageBlocking + +## -description +Provides functionality for blocking messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessageblocking_markmessageasblockedasync_935225079.md b/windows.applicationmodel.chat/chatmessageblocking_markmessageasblockedasync_935225079.md index 6a07665c3a..dd5d82ddcb 100644 --- a/windows.applicationmodel.chat/chatmessageblocking_markmessageasblockedasync_935225079.md +++ b/windows.applicationmodel.chat/chatmessageblocking_markmessageasblockedasync_935225079.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageBlocking.MarkMessageAsBlockedAsync(System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageBlocking.MarkMessageAsBlockedAsync ## -description Asynchronously marks a message as blocked or unblocked. ## -parameters ### -param localChatMessageId The ID of the message to block. ### -param blocked TRUE if the message should be blocked, FALSE if it should be unblocked. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageBlocking.MarkMessageAsBlockedAsync(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageBlocking.MarkMessageAsBlockedAsync + +## -description +Asynchronously marks a message as blocked or unblocked. + +## -parameters +### -param localChatMessageId +The ID of the message to block. + +### -param blocked +TRUE if the message should be blocked, FALSE if it should be unblocked. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechange.md b/windows.applicationmodel.chat/chatmessagechange.md index 09da6b5d35..4ef71cf37c 100644 --- a/windows.applicationmodel.chat/chatmessagechange.md +++ b/windows.applicationmodel.chat/chatmessagechange.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageChange --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageChange ## -description Represents a revision to a chat message. ## -remarks Obtain an instance of this class by calling [ReadBatchAsync](chatmessagechangereader_readbatchasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageChange +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChange + +## -description +Represents a revision to a chat message. + +## -remarks +Obtain an instance of this class by calling [ReadBatchAsync](chatmessagechangereader_readbatchasync.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechange_changetype.md b/windows.applicationmodel.chat/chatmessagechange_changetype.md index c0f85ce8bb..a7cd3312b4 100644 --- a/windows.applicationmodel.chat/chatmessagechange_changetype.md +++ b/windows.applicationmodel.chat/chatmessagechange_changetype.md @@ -1,3 +1,43 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageChange.ChangeType --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageChange.ChangeType ## -description Gets the type of change made to a chat message, such as created, modified, etc. ## -property-value The type of change represented by the object. ## -remarks An application can check the change type when deciding to accept message changes or to update its private message store. The following example checks for acceptable changes. ``` switch (messageChange.ChangeType) { case ChatMessageChangeType.MessageCreated: case ChatMessageChangeType.MessageDeleted: case ChatMessageChangeType.MessageModified: messageStore.ChangeTracker.GetChangeReader.AcceptChanges(); break; case ChatMessageChangeType.ChangeTrackingLost: messageStore.ChangeTracker.Reset(); break; default: break } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageChange.ChangeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChange.ChangeType + +## -description +Gets the type of change made to a chat message, such as created, modified, etc. + +## -property-value +The type of change represented by the object. + +## -remarks +An application can check the change type when deciding to accept message changes or to update its private message store. The following example checks for acceptable changes. + +``` +switch (messageChange.ChangeType) +{ + case ChatMessageChangeType.MessageCreated: + case ChatMessageChangeType.MessageDeleted: + case ChatMessageChangeType.MessageModified: + messageStore.ChangeTracker.GetChangeReader.AcceptChanges(); + break; + case ChatMessageChangeType.ChangeTrackingLost: + messageStore.ChangeTracker.Reset(); + break; + default: + break +} + + +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechange_message.md b/windows.applicationmodel.chat/chatmessagechange_message.md index a0e1bfc8d1..7e549fd060 100644 --- a/windows.applicationmodel.chat/chatmessagechange_message.md +++ b/windows.applicationmodel.chat/chatmessagechange_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageChange.Message --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageChange.Message ## -description Gets the updated message text. ## -property-value The chat message associated with the change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageChange.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChange.Message + +## -description +Gets the updated message text. + +## -property-value +The chat message associated with the change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechangeddeferral.md b/windows.applicationmodel.chat/chatmessagechangeddeferral.md index 4be3326115..8fbb7f697f 100644 --- a/windows.applicationmodel.chat/chatmessagechangeddeferral.md +++ b/windows.applicationmodel.chat/chatmessagechangeddeferral.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangedDeferral --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageChangedDeferral ## -description Represents a deferred asynchronous change request. ## -remarks Obtain an instance of this class by calling [GetDeferral](chatmessagechangedeventargs_getdeferral.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangedDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangedDeferral + +## -description +Represents a deferred asynchronous change request. + +## -remarks +Obtain an instance of this class by calling [GetDeferral](chatmessagechangedeventargs_getdeferral.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechangeddeferral_complete_1807836922.md b/windows.applicationmodel.chat/chatmessagechangeddeferral_complete_1807836922.md index d5b163adf3..ce855dc7ef 100644 --- a/windows.applicationmodel.chat/chatmessagechangeddeferral_complete_1807836922.md +++ b/windows.applicationmodel.chat/chatmessagechangeddeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangedDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangedDeferral.Complete ## -description Fires to indicate that the deferred change request has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangedDeferral.Complete + +## -description +Fires to indicate that the deferred change request has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechangedeventargs.md b/windows.applicationmodel.chat/chatmessagechangedeventargs.md index 80131231e9..7dccf07748 100644 --- a/windows.applicationmodel.chat/chatmessagechangedeventargs.md +++ b/windows.applicationmodel.chat/chatmessagechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs ## -description Represents event parameters used by the event handler that processes message change events. ## -remarks Obtain an instance of this object in the handler to the [MessageChanged](chatmessagestore_messagechanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs + +## -description +Represents event parameters used by the event handler that processes message change events. + +## -remarks +Obtain an instance of this object in the handler to the [MessageChanged](chatmessagestore_messagechanged.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechangedeventargs_getdeferral_254836512.md b/windows.applicationmodel.chat/chatmessagechangedeventargs_getdeferral_254836512.md index 8dedee20bd..4897c3fdd0 100644 --- a/windows.applicationmodel.chat/chatmessagechangedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.chat/chatmessagechangedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs.GetDeferral ## -description The message changed event handler that an application registers with the message store receives a deferral object in the event parameters. The [GetDeferral](chatmessagechangedeventargs_getdeferral.md) method registers a change deferral and allows an application to take action related to the change before the message store completes the change. ## -returns Gets a deferral for the [MessageChanged](chatmessagestore_messagechanged.md) event. ## -remarks The chat application receives a [ChatMessageChangedDeferral class](chatmessagechangeddeferral.md) object when requested by [GetDeferral](chatmessagechangedeventargs_getdeferral.md). Deferrals are only available if the application has a change event handler added to the [MessageChanged](chatmessagestore_messagechanged.md) event of the [ChatMessageStore class](chatmessagestore.md). The [ChatMessageChangedDeferral class](chatmessagechangeddeferral.md) received in the parameters for the event handler is retained for later use to notify the message store that actions related to the changer are complete. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangedEventArgs.GetDeferral + +## -description +The message changed event handler that an application registers with the message store receives a deferral object in the event parameters. The [GetDeferral](chatmessagechangedeventargs_getdeferral.md) method registers a change deferral and allows an application to take action related to the change before the message store completes the change. + +## -returns +Gets a deferral for the [MessageChanged](chatmessagestore_messagechanged.md) event. + +## -remarks +The chat application receives a [ChatMessageChangedDeferral class](chatmessagechangeddeferral.md) object when requested by [GetDeferral](chatmessagechangedeventargs_getdeferral.md). Deferrals are only available if the application has a change event handler added to the [MessageChanged](chatmessagestore_messagechanged.md) event of the [ChatMessageStore class](chatmessagestore.md). The [ChatMessageChangedDeferral class](chatmessagechangeddeferral.md) received in the parameters for the event handler is retained for later use to notify the message store that actions related to the changer are complete. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagechangereader.md b/windows.applicationmodel.chat/chatmessagechangereader.md index 4af389abb6..e9ca19d37d 100644 --- a/windows.applicationmodel.chat/chatmessagechangereader.md +++ b/windows.applicationmodel.chat/chatmessagechangereader.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangeReader --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageChangeReader ## -description Provides methods for reading and accepting message change revisions. ## -remarks Obtain an instance of this class by calling [GetChangeReader](chatmessagechangetracker_getchangereader.md). ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangeReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeReader + +## -description +Provides methods for reading and accepting message change revisions. + +## -remarks +Obtain an instance of this class by calling [GetChangeReader](chatmessagechangetracker_getchangereader.md). + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangereader_acceptchanges_143129490.md b/windows.applicationmodel.chat/chatmessagechangereader_acceptchanges_143129490.md index 2a3bd417ca..c5d37b9cea 100644 --- a/windows.applicationmodel.chat/chatmessagechangereader_acceptchanges_143129490.md +++ b/windows.applicationmodel.chat/chatmessagechangereader_acceptchanges_143129490.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChanges --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChanges ## -description Accepts all the changes up to and including the latest change to the message. ## -remarks The [AcceptChanges](chatmessagechangereader_acceptchanges.md) method accepts all the message changes currently tracked by the change tracker. Calling [AcceptChanges](chatmessagechangereader_acceptchanges.md) will cause change tracking to reset and tracking will begin again with the next message change. ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChanges +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChanges + +## -description +Accepts all the changes up to and including the latest change to the message. + +## -remarks +The [AcceptChanges](chatmessagechangereader_acceptchanges.md) method accepts all the message changes currently tracked by the change tracker. Calling [AcceptChanges](chatmessagechangereader_acceptchanges.md) will cause change tracking to reset and tracking will begin again with the next message change. + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangereader_acceptchangesthrough_1048366948.md b/windows.applicationmodel.chat/chatmessagechangereader_acceptchangesthrough_1048366948.md index 1e7e926516..a69a7e06cc 100644 --- a/windows.applicationmodel.chat/chatmessagechangereader_acceptchangesthrough_1048366948.md +++ b/windows.applicationmodel.chat/chatmessagechangereader_acceptchangesthrough_1048366948.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Chat.ChatMessageChange) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChangesThrough ## -description Accepts all the changes up to and including a specified change. ## -parameters ### -param lastChangeToAcknowledge The last change to acknowledge. ## -remarks The [AcceptChangesThrough](chatmessagechangereader_acceptchangesthrough.md) method accepts all the message changes currently tracked up to and including the change specified in *lastChangeToAcknowledge*. Calling [AcceptChangesThrough](chatmessagechangereader_acceptchangesthrough.md) will cause change tracking to reset and tracking will begin again with the next message change. ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Chat.ChatMessageChange) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeReader.AcceptChangesThrough + +## -description +Accepts all the changes up to and including a specified change. + +## -parameters +### -param lastChangeToAcknowledge +The last change to acknowledge. + +## -remarks +The [AcceptChangesThrough](chatmessagechangereader_acceptchangesthrough.md) method accepts all the message changes currently tracked up to and including the change specified in *lastChangeToAcknowledge*. Calling [AcceptChangesThrough](chatmessagechangereader_acceptchangesthrough.md) will cause change tracking to reset and tracking will begin again with the next message change. + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangereader_readbatchasync_888788553.md b/windows.applicationmodel.chat/chatmessagechangereader_readbatchasync_888788553.md index 40835398e7..33fa7152a0 100644 --- a/windows.applicationmodel.chat/chatmessagechangereader_readbatchasync_888788553.md +++ b/windows.applicationmodel.chat/chatmessagechangereader_readbatchasync_888788553.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangeReader.ReadBatchAsync ## -description Returns a batch list of chat message change objects from the message store’s change tracker. ## -returns An asynchronous operation that returns a list of changes. ## -remarks This method returns an IReadOnlyList of [ChatMessageChange class](chatmessagechange.md) objects. The method is invoked as an [IAsyncOperation](http://msdn.microsoft.com/library/a20e6057-c46a-4dbf-88b0-5dc954dc0362) as shown in the following example: ``` ChatMessageChangeTracker tracker = messageStore.ChangeTracker; IReadOnlyList changeList = await tracker.GetChangeReader.ReadBatchAsync(); ``` ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeReader.ReadBatchAsync + +## -description +Returns a batch list of chat message change objects from the message store’s change tracker. + +## -returns +An asynchronous operation that returns a list of changes. + +## -remarks +This method returns an IReadOnlyList of [ChatMessageChange class](chatmessagechange.md) objects. The method is invoked as an [IAsyncOperation](http://msdn.microsoft.com/library/a20e6057-c46a-4dbf-88b0-5dc954dc0362) as shown in the following example: + +``` +ChatMessageChangeTracker tracker = messageStore.ChangeTracker; +IReadOnlyList changeList = await tracker.GetChangeReader.ReadBatchAsync(); + +``` + + + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangetracker.md b/windows.applicationmodel.chat/chatmessagechangetracker.md index 8d1ede6a20..8698c00578 100644 --- a/windows.applicationmodel.chat/chatmessagechangetracker.md +++ b/windows.applicationmodel.chat/chatmessagechangetracker.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangeTracker --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageChangeTracker ## -description Provides methods to enable and retrieve message change revisions. ## -remarks Get an instance of this class by referencing the [ChangeTracker](chatmessagestore_changetracker.md) property of the [ChatMessageStore](chatmessagestore.md) object. ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageChangeTracker +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeTracker + +## -description +Provides methods to enable and retrieve message change revisions. + +## -remarks +Get an instance of this class by referencing the [ChangeTracker](chatmessagestore_changetracker.md) property of the [ChatMessageStore](chatmessagestore.md) object. + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangetracker_enable_366433390.md b/windows.applicationmodel.chat/chatmessagechangetracker_enable_366433390.md index cb00b7cf1f..adc639abac 100644 --- a/windows.applicationmodel.chat/chatmessagechangetracker_enable_366433390.md +++ b/windows.applicationmodel.chat/chatmessagechangetracker_enable_366433390.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Enable --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Enable ## -description Enables change tracking for the messages in the message store. ## -remarks Change tracking for messages in the message store is enabled from the [ChangeTracker](chatmessagestore_changetracker.md) property of the [ChatMessageStore](chatmessagestore.md) object. This is accomplished as shown in the following example: ``` void TurnOnChangeTracking(ChatMessageStore messageStore) { messageStore.ChangeTracker.Enable(); } ``` ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Enable +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Enable + +## -description +Enables change tracking for the messages in the message store. + +## -remarks +Change tracking for messages in the message store is enabled from the [ChangeTracker](chatmessagestore_changetracker.md) property of the [ChatMessageStore](chatmessagestore.md) object. This is accomplished as shown in the following example: + +``` +void TurnOnChangeTracking(ChatMessageStore messageStore) +{ + messageStore.ChangeTracker.Enable(); +} + + +``` + + + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangetracker_getchangereader_1364424875.md b/windows.applicationmodel.chat/chatmessagechangetracker_getchangereader_1364424875.md index 8db80d0e17..dfb7ad7262 100644 --- a/windows.applicationmodel.chat/chatmessagechangetracker_getchangereader_1364424875.md +++ b/windows.applicationmodel.chat/chatmessagechangetracker_getchangereader_1364424875.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeTracker.GetChangeReader --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangeTracker.GetChangeReader ## -description Returns a [ChatMessageChangeReader class](chatmessagechangereader.md) object which provides a collection of message revisions from the message store. ## -returns The change reader associated with the change tracker. ## -remarks The following example uses the message change reader to find the message revision total: ``` async int GetMessageRevisionCount(ChatMesssage messageStore) { ChatMessageChangeTracker tracker = messageStore.ChangeTracker; IReadOnlyList changeList = await tracker.GetChangeReader().ReadBatchAsync(); return changeList.Count; } ``` ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeTracker.GetChangeReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeTracker.GetChangeReader + +## -description +Returns a [ChatMessageChangeReader class](chatmessagechangereader.md) object which provides a collection of message revisions from the message store. + +## -returns +The change reader associated with the change tracker. + +## -remarks +The following example uses the message change reader to find the message revision total: + +``` +async int GetMessageRevisionCount(ChatMesssage messageStore) +{ + ChatMessageChangeTracker tracker = messageStore.ChangeTracker; + IReadOnlyList changeList = await tracker.GetChangeReader().ReadBatchAsync(); + + return changeList.Count; +} + +``` + + + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagechangetracker_reset_1636126115.md b/windows.applicationmodel.chat/chatmessagechangetracker_reset_1636126115.md index 08e8e4cc2d..442c87b953 100644 --- a/windows.applicationmodel.chat/chatmessagechangetracker_reset_1636126115.md +++ b/windows.applicationmodel.chat/chatmessagechangetracker_reset_1636126115.md @@ -1,3 +1,44 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Reset --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Reset ## -description Resets change tracking for the messages in the message store. The first revision begins with the next message change. ## -remarks The following example resets change tracking when the revision change type indicates [ChatMessageChangeType](chatmessagechangetype.md).ChangeTrackingLost: ``` switch (messageChange.ChangeType) { case ChatMessageChangeType.MessageCreated: case ChatMessageChangeType.MessageDeleted: case ChatMessageChangeType.MessageModified: messageStore.ChangeTracker.GetChangeReader.AcceptChanges(); break; case ChatMessageChangeType.ChangeTrackingLost: messageStore.ChangeTracker.Reset(); break; default: break } ``` ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Reset +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageChangeTracker.Reset + +## -description +Resets change tracking for the messages in the message store. The first revision begins with the next message change. + +## -remarks +The following example resets change tracking when the revision change type indicates [ChatMessageChangeType](chatmessagechangetype.md).ChangeTrackingLost: + +``` +switch (messageChange.ChangeType) +{ + case ChatMessageChangeType.MessageCreated: + case ChatMessageChangeType.MessageDeleted: + case ChatMessageChangeType.MessageModified: + messageStore.ChangeTracker.GetChangeReader.AcceptChanges(); + break; + case ChatMessageChangeType.ChangeTrackingLost: + messageStore.ChangeTracker.Reset(); + break; + default: + break +} + + +``` + + + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagemanager.md b/windows.applicationmodel.chat/chatmessagemanager.md index dc1d480fc6..b495738a57 100644 --- a/windows.applicationmodel.chat/chatmessagemanager.md +++ b/windows.applicationmodel.chat/chatmessagemanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageManager --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageManager ## -description Provides access to message transports and the message store. Also provides a method to display the UI to compose messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager + +## -description +Provides access to message transports and the message store. Also provides a method to display the UI to compose messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagemanager_gettransportasync_455003223.md b/windows.applicationmodel.chat/chatmessagemanager_gettransportasync_455003223.md index c1f2530077..47a9d4a4d2 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_gettransportasync_455003223.md +++ b/windows.applicationmodel.chat/chatmessagemanager_gettransportasync_455003223.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportAsync ## -description Asynchronously gets the[ChatMessageTransport](chatmessagetransport.md). ## -parameters ### -param transportId The locally unique identifier for the message transport. ## -returns The message transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportAsync + +## -description +Asynchronously gets the[ChatMessageTransport](chatmessagetransport.md). + +## -parameters +### -param transportId +The locally unique identifier for the message transport. + +## -returns +The message transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagemanager_gettransportsasync_998895362.md b/windows.applicationmodel.chat/chatmessagemanager_gettransportsasync_998895362.md index 9e245f6e3d..2082913955 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_gettransportsasync_998895362.md +++ b/windows.applicationmodel.chat/chatmessagemanager_gettransportsasync_998895362.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportsAsync ## -description Asynchronously gets the chat message transports available on the device. ## -returns An asynchronous operation that returns a list of transports on successful completion. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.GetTransportsAsync + +## -description +Asynchronously gets the chat message transports available on the device. + +## -returns +An asynchronous operation that returns a list of transports on successful completion. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagemanager_registertransportasync_1918501714.md b/windows.applicationmodel.chat/chatmessagemanager_registertransportasync_1918501714.md index 8542539e87..5369cacdca 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_registertransportasync_1918501714.md +++ b/windows.applicationmodel.chat/chatmessagemanager_registertransportasync_1918501714.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.RegisterTransportAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.RegisterTransportAsync ## -description Asynchronously registers the app as a [ChatMessageTransport](chatmessagetransport.md) in order to post messages to the [ChatMessageStore](chatmessagestore.md). ## -returns The transport ID for the newly registered [ChatMessageTransport](chatmessagetransport.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.RegisterTransportAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.RegisterTransportAsync + +## -description +Asynchronously registers the app as a [ChatMessageTransport](chatmessagetransport.md) in order to post messages to the [ChatMessageStore](chatmessagestore.md). + +## -returns +The transport ID for the newly registered [ChatMessageTransport](chatmessagetransport.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagemanager_requeststoreasync_428591920.md b/windows.applicationmodel.chat/chatmessagemanager_requeststoreasync_428591920.md index 750cd5be4b..7aa8726519 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_requeststoreasync_428591920.md +++ b/windows.applicationmodel.chat/chatmessagemanager_requeststoreasync_428591920.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.RequestStoreAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.RequestStoreAsync ## -description Returns the SMS messaging store for the phone. ## -returns An asynchronous operation that returns a [ChatMessageStore](chatmessagestore.md) on successful completion. ## -remarks This method returns an [IReadOnlyList](https://msdn.microsoft.com/library/hh192385.aspx) of [ChatMessageStore class](chatmessagestore.md) objects. The method is invoked as an [IAsyncOperation](http://msdn.microsoft.com/library/a20e6057-c46a-4dbf-88b0-5dc954dc0362) as shown in the following example: ``` ChatMessageStore store = await ChatMessageManager.RequestStoreAsync(); ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.RequestStoreAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.RequestStoreAsync + +## -description +Returns the SMS messaging store for the phone. + +## -returns +An asynchronous operation that returns a [ChatMessageStore](chatmessagestore.md) on successful completion. + +## -remarks +This method returns an [IReadOnlyList](https://msdn.microsoft.com/library/hh192385.aspx) of [ChatMessageStore class](chatmessagestore.md) objects. The method is invoked as an [IAsyncOperation](http://msdn.microsoft.com/library/a20e6057-c46a-4dbf-88b0-5dc954dc0362) as shown in the following example: + +``` +ChatMessageStore store = await ChatMessageManager.RequestStoreAsync(); + +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagemanager_requestsyncmanagerasync_1572900658.md b/windows.applicationmodel.chat/chatmessagemanager_requestsyncmanagerasync_1572900658.md index 5957ea04c7..0a64261dca 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_requestsyncmanagerasync_1572900658.md +++ b/windows.applicationmodel.chat/chatmessagemanager_requestsyncmanagerasync_1572900658.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.RequestSyncManagerAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.RequestSyncManagerAsync ## -description Gets the [ChatSyncManager](chatsyncmanager.md) instance. ## -returns When the asynchronous operation completes, a [ChatSyncManager](chatsyncmanager.md) object is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.RequestSyncManagerAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.RequestSyncManagerAsync + +## -description +Gets the [ChatSyncManager](chatsyncmanager.md) instance. + +## -returns +When the asynchronous operation completes, a [ChatSyncManager](chatsyncmanager.md) object is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagemanager_showcomposesmsmessageasync_1632642119.md b/windows.applicationmodel.chat/chatmessagemanager_showcomposesmsmessageasync_1632642119.md index fd412cd4b5..52eaf01097 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_showcomposesmsmessageasync_1632642119.md +++ b/windows.applicationmodel.chat/chatmessagemanager_showcomposesmsmessageasync_1632642119.md @@ -1,3 +1,42 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.ShowComposeSmsMessageAsync(Windows.ApplicationModel.Chat.ChatMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.ShowComposeSmsMessageAsync ## -description Shows the compose SMS dialog, pre-populated with data from the supplied [ChatMessage](chatmessage.md) object, allowing the user to send an SMS message. ## -parameters ### -param message The chat message. ## -returns An asynchronous action. ## -remarks The [TransportId](chatmessage_transportid.md) property of the message is set to the desired outgoing transport. The [ChatMessage.Body](chatmessage_body.md) property is optionally set to any initial text. The following example shows a call to [ShowComposeSmsMessageAsync](chatmessagemanager_showcomposesmsmessageasync.md) with the transport and initial text for a message: ``` async void ComposeMessage() { ChatMessage message; message.Body = "Sent from *SpiffyChat*: How’s your morning going?"; message.TransportId = "0"; message.Recipients.Add("+12065551234"); await ChatMessageManager.ShowComposeSmsMessageAsync(message); } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.ShowComposeSmsMessageAsync(Windows.ApplicationModel.Chat.ChatMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.ShowComposeSmsMessageAsync + +## -description +Shows the compose SMS dialog, pre-populated with data from the supplied [ChatMessage](chatmessage.md) object, allowing the user to send an SMS message. + +## -parameters +### -param message +The chat message. + +## -returns +An asynchronous action. + +## -remarks +The [TransportId](chatmessage_transportid.md) property of the message is set to the desired outgoing transport. The [ChatMessage.Body](chatmessage_body.md) property is optionally set to any initial text. The following example shows a call to [ShowComposeSmsMessageAsync](chatmessagemanager_showcomposesmsmessageasync.md) with the transport and initial text for a message: + +``` +async void ComposeMessage() +{ + ChatMessage message; + message.Body = "Sent from *SpiffyChat*: How’s your morning going?"; + message.TransportId = "0"; + message.Recipients.Add("+12065551234"); + + await ChatMessageManager.ShowComposeSmsMessageAsync(message); +} + +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagemanager_showsmssettings_2145529262.md b/windows.applicationmodel.chat/chatmessagemanager_showsmssettings_2145529262.md index 4cf8ce94b2..e6ce341b8b 100644 --- a/windows.applicationmodel.chat/chatmessagemanager_showsmssettings_2145529262.md +++ b/windows.applicationmodel.chat/chatmessagemanager_showsmssettings_2145529262.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.ShowSmsSettings --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageManager.ShowSmsSettings ## -description Launches the device's SMS settings app. ## -remarks The [ShowSmsSettings](chatmessagemanager_showsmssettings.md) method allows a chat application to launch the SMS settings pane attached to the current UI thread. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageManager.ShowSmsSettings +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageManager.ShowSmsSettings + +## -description +Launches the device's SMS settings app. + +## -remarks +The [ShowSmsSettings](chatmessagemanager_showsmssettings.md) method allows a chat application to launch the SMS settings pane attached to the current UI thread. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails.md b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails.md index 35115a37a3..be79f51211 100644 --- a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails.md +++ b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails.md @@ -1,3 +1,51 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails ## -description Represents the message notification triggered from a registered background task. A chat app can receive notifications of incoming messages or send events by setting a task trigger and task entry point. ## -remarks A chat app must register a background task to process notifications in order to serve as the default handler for incoming messages. In order to register a background task, the app manifest must contain a background task extension like the following example. ``` ``` The background task’s [Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method receives a task instance with the notification trigger details. The [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property is cast to a [ChatMessageNotificationTriggerDetails](chatmessagenotificationtriggerdetails.md) object. The trigger details for a chat message are obtained as shown in the following example. ``` public void Run(IBackgroundTaskInstance taskInstance) { BackgroundTaskDeferral deferral = taskInstance.GetDeferral(); ChatMessageNotificationTriggerDetails triggerDetails = (ChatMessageNotificationTriggerDetails) taskInstance.TriggerDetails; if (triggerDetails != null) { SendToast(triggerDetails.ChatMessage); } } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails + +## -description +Represents the message notification triggered from a registered background task. A chat app can receive notifications of incoming messages or send events by setting a task trigger and task entry point. + +## -remarks +A chat app must register a background task to process notifications in order to serve as the default handler for incoming messages. In order to register a background task, the app manifest must contain a background task extension like the following example. + +``` +” + + + + + + +``` + +The background task’s [Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method receives a task instance with the notification trigger details. The [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property is cast to a [ChatMessageNotificationTriggerDetails](chatmessagenotificationtriggerdetails.md) object. The trigger details for a chat message are obtained as shown in the following example. + +``` +public void Run(IBackgroundTaskInstance taskInstance) +{ + BackgroundTaskDeferral deferral = taskInstance.GetDeferral(); + ChatMessageNotificationTriggerDetails triggerDetails = + (ChatMessageNotificationTriggerDetails) taskInstance.TriggerDetails; + + if (triggerDetails != null) + { + SendToast(triggerDetails.ChatMessage); + } +} + +``` + + + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_chatmessage.md b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_chatmessage.md index 522f7c554f..0fd8242967 100644 --- a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_chatmessage.md +++ b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_chatmessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ChatMessage --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ChatMessage ## -description Gets the message associated with the notification. This is either an incoming message or an outgoing message with a send status event. ## -property-value The chat message associated with the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ChatMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ChatMessage + +## -description +Gets the message associated with the notification. This is either an incoming message or an outgoing message with a send status event. + +## -property-value +The chat message associated with the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shoulddisplaytoast.md b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shoulddisplaytoast.md index 8c282276de..6ba6f4854e 100644 --- a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shoulddisplaytoast.md +++ b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shoulddisplaytoast.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldDisplayToast --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldDisplayToast ## -description Gets a Boolean value indicating if the background task should issue a toast notification for the message. ## -property-value A Boolean value indicating if the background task should issue a toast notification for the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldDisplayToast +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldDisplayToast + +## -description +Gets a Boolean value indicating if the background task should issue a toast notification for the message. + +## -property-value +A Boolean value indicating if the background task should issue a toast notification for the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdateactioncenter.md b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdateactioncenter.md index d57b615d12..7325eb507c 100644 --- a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdateactioncenter.md +++ b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdateactioncenter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateActionCenter --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateActionCenter ## -description Gets a Boolean value indicating if the Windows Action Center should be updated with the message. ## -property-value A Boolean value indicating if the Windows Action Center should be updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateActionCenter +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateActionCenter + +## -description +Gets a Boolean value indicating if the Windows Action Center should be updated with the message. + +## -property-value +A Boolean value indicating if the Windows Action Center should be updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatebadge.md b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatebadge.md index 72e71d1e2d..d4d97d05c6 100644 --- a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatebadge.md +++ b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatebadge.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateBadge --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateBadge ## -description Gets a Boolean value indicating if the background task should update the app’s lock screen count. ## -property-value A Boolean value indicating if the background task should update the app’s lock screen count. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateBadge +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateBadge + +## -description +Gets a Boolean value indicating if the background task should update the app’s lock screen count. + +## -property-value +A Boolean value indicating if the background task should update the app’s lock screen count. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatedetailtext.md b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatedetailtext.md index 88350350c4..b832a76c00 100644 --- a/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatedetailtext.md +++ b/windows.applicationmodel.chat/chatmessagenotificationtriggerdetails_shouldupdatedetailtext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateDetailText --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateDetailText ## -description Gets a Boolean value indicating that the background task should update the app's tile count for the message. ## -property-value A Boolean value indicating that the background task should update the app's tile count for the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateDetailText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageNotificationTriggerDetails.ShouldUpdateDetailText + +## -description +Gets a Boolean value indicating that the background task should update the app's tile count for the message. + +## -property-value +A Boolean value indicating that the background task should update the app's tile count for the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagereader.md b/windows.applicationmodel.chat/chatmessagereader.md index cd13b1da75..824b684501 100644 --- a/windows.applicationmodel.chat/chatmessagereader.md +++ b/windows.applicationmodel.chat/chatmessagereader.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageReader --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageReader ## -description Provides methods for reading messages from the message store. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageReader + +## -description +Provides methods for reading messages from the message store. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagereader_readbatchasync_1346490639.md b/windows.applicationmodel.chat/chatmessagereader_readbatchasync_1346490639.md index 8dd308bac5..7017caf3a3 100644 --- a/windows.applicationmodel.chat/chatmessagereader_readbatchasync_1346490639.md +++ b/windows.applicationmodel.chat/chatmessagereader_readbatchasync_1346490639.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync(System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync ## -description Returns a batch list of chat messages from the message store limited to the specified size. ## -parameters ### -param count The size of the batch to read. ## -returns An asynchronous operation that returns a list of chat messages upon successful completion. ## -remarks ## -examples ## -see-also [ReadBatchAsync](chatmessagereader_readbatchasync_888788553.md) ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync(System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync + +## -description +Returns a batch list of chat messages from the message store limited to the specified size. + +## -parameters +### -param count +The size of the batch to read. + +## -returns +An asynchronous operation that returns a list of chat messages upon successful completion. + +## -remarks + +## -examples + +## -see-also +[ReadBatchAsync](chatmessagereader_readbatchasync_888788553.md) + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagereader_readbatchasync_888788553.md b/windows.applicationmodel.chat/chatmessagereader_readbatchasync_888788553.md index 18452d52fb..a6ed8c4f5b 100644 --- a/windows.applicationmodel.chat/chatmessagereader_readbatchasync_888788553.md +++ b/windows.applicationmodel.chat/chatmessagereader_readbatchasync_888788553.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync ## -description Returns a batch list of chat messages from the message store. ## -returns An asynchronous operation that returns a list of chat messages upon successful completion. ## -remarks This method returns an [IReadOnlyList](https://msdn.microsoft.com/library/hh192385.aspx) of [ChatMessage class](chatmessage.md) objects. The method is invoked as an [IAsyncOperation](http://msdn.microsoft.com/library/a20e6057-c46a-4dbf-88b0-5dc954dc0362) as shown in the following example: ``` IReadOnlyList msgList = await messageStore.GetMessageReader.ReadBatchAsync(); ``` ## -examples ## -see-also [ReadBatchAsync(Int32)](chatmessagereader_readbatchasync_1346490639.md) ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageReader.ReadBatchAsync + +## -description +Returns a batch list of chat messages from the message store. + +## -returns +An asynchronous operation that returns a list of chat messages upon successful completion. + +## -remarks +This method returns an [IReadOnlyList](https://msdn.microsoft.com/library/hh192385.aspx) of [ChatMessage class](chatmessage.md) objects. The method is invoked as an [IAsyncOperation](http://msdn.microsoft.com/library/a20e6057-c46a-4dbf-88b0-5dc954dc0362) as shown in the following example: + +``` +IReadOnlyList msgList = await messageStore.GetMessageReader.ReadBatchAsync(); + +``` + + + +## -examples + +## -see-also +[ReadBatchAsync(Int32)](chatmessagereader_readbatchasync_1346490639.md) + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore.md b/windows.applicationmodel.chat/chatmessagestore.md index 6ebbde0b55..46a6cea08d 100644 --- a/windows.applicationmodel.chat/chatmessagestore.md +++ b/windows.applicationmodel.chat/chatmessagestore.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageStore --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageStore ## -description Provides the methods and properties to read, manage and send messages. An application gets access to the message store using the static [ChatMessageManager class](chatmessagemanager.md). ## -remarks Obtain an instance of this class by calling [RequestStoreAsync](chatmessagemanager_requeststoreasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore + +## -description +Provides the methods and properties to read, manage and send messages. An application gets access to the message store using the static [ChatMessageManager class](chatmessagemanager.md). + +## -remarks +Obtain an instance of this class by calling [RequestStoreAsync](chatmessagemanager_requeststoreasync.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_changetracker.md b/windows.applicationmodel.chat/chatmessagestore_changetracker.md index eb7f9348ce..599e1be56d 100644 --- a/windows.applicationmodel.chat/chatmessagestore_changetracker.md +++ b/windows.applicationmodel.chat/chatmessagestore_changetracker.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageStore.ChangeTracker --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageStore.ChangeTracker ## -description Gets a [ChatMessageChangeTracker class](chatmessagechangetracker.md) object for the message store. A message change tracker allows an application to monitor changes to messages in the message store. ## -property-value The chat message change tracker for the store. ## -remarks An application can enable change tracking by accessing this [ChatMessageChangeTracker](chatmessagechangetracker.md) object. The following example shows how to enable message change tracking. ``` // Enable message change tracking void SetTrackingOn(ChatMessageStore store) { store.ChangeTracker.Enable(); } ``` The chat application receives notifications of message changes in its message change event handler which is registered to the [MessageChanged](chatmessagestore_messagechanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageStore.ChangeTracker +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.ChangeTracker + +## -description +Gets a [ChatMessageChangeTracker class](chatmessagechangetracker.md) object for the message store. A message change tracker allows an application to monitor changes to messages in the message store. + +## -property-value +The chat message change tracker for the store. + +## -remarks +An application can enable change tracking by accessing this [ChatMessageChangeTracker](chatmessagechangetracker.md) object. The following example shows how to enable message change tracking. + +``` +// Enable message change tracking +void SetTrackingOn(ChatMessageStore store) +{ + store.ChangeTracker.Enable(); +} +``` + +The chat application receives notifications of message changes in its message change event handler which is registered to the [MessageChanged](chatmessagestore_messagechanged.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_deletemessageasync_1226730004.md b/windows.applicationmodel.chat/chatmessagestore_deletemessageasync_1226730004.md index c0d5538890..c473d139ac 100644 --- a/windows.applicationmodel.chat/chatmessagestore_deletemessageasync_1226730004.md +++ b/windows.applicationmodel.chat/chatmessagestore_deletemessageasync_1226730004.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.DeleteMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.DeleteMessageAsync ## -description Deletes a message from the chat message store. ## -parameters ### -param localMessageId The local ID of the message to be deleted. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.DeleteMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.DeleteMessageAsync + +## -description +Deletes a message from the chat message store. + +## -parameters +### -param localMessageId +The local ID of the message to be deleted. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_downloadmessageasync_242041271.md b/windows.applicationmodel.chat/chatmessagestore_downloadmessageasync_242041271.md index 39055570a5..54d0f6e6ad 100644 --- a/windows.applicationmodel.chat/chatmessagestore_downloadmessageasync_242041271.md +++ b/windows.applicationmodel.chat/chatmessagestore_downloadmessageasync_242041271.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.DownloadMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.DownloadMessageAsync ## -description Downloads a message specified by the identifier to the message store. ## -parameters ### -param localChatMessageId The local ID of the message to be downloaded. ## -returns An asynchronous action. ## -remarks The message contents including its attachments are downloaded. An application will call this method when the message status is [ChatMessageStatus](chatmessagestatus.md).ReceiveDownloadNeeded. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.DownloadMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.DownloadMessageAsync + +## -description +Downloads a message specified by the identifier to the message store. + +## -parameters +### -param localChatMessageId +The local ID of the message to be downloaded. + +## -returns +An asynchronous action. + +## -remarks +The message contents including its attachments are downloaded. An application will call this method when the message status is [ChatMessageStatus](chatmessagestatus.md).ReceiveDownloadNeeded. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_forwardmessageasync_1556787166.md b/windows.applicationmodel.chat/chatmessagestore_forwardmessageasync_1556787166.md index f4580f9904..54cf6eb58a 100644 --- a/windows.applicationmodel.chat/chatmessagestore_forwardmessageasync_1556787166.md +++ b/windows.applicationmodel.chat/chatmessagestore_forwardmessageasync_1556787166.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.ForwardMessageAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.ForwardMessageAsync ## -description Asynchronously forwards the specified message to new recipients. ## -parameters ### -param localChatMessageId The ID of the message to forward. ### -param addresses The addresses of the new recipients of the forwarded message. ## -returns A copy of the forwarded message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.ForwardMessageAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.ForwardMessageAsync + +## -description +Asynchronously forwards the specified message to new recipients. + +## -parameters +### -param localChatMessageId +The ID of the message to forward. + +### -param addresses +The addresses of the new recipients of the forwarded message. + +## -returns +A copy of the forwarded message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_getconversationasync_1734316845.md b/windows.applicationmodel.chat/chatmessagestore_getconversationasync_1734316845.md index c217b45063..4e54863e9c 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getconversationasync_1734316845.md +++ b/windows.applicationmodel.chat/chatmessagestore_getconversationasync_1734316845.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync ## -description Asynchronously gets a [ChatConversation](chatconversation.md) by ID using the specified transports. ## -parameters ### -param conversationId The ID of the conversation to retrieve. ### -param transportIds The IDs of the transports to use to retrieve the [ChatConversation](chatconversation.md). ## -returns The [ChatConversation](chatconversation.md) specified by the *conversationId* parameter. ## -remarks ## -examples ## -see-also [GetConversationAsync(String)](chatmessagestore_getconversationasync_2049140047.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync + +## -description +Asynchronously gets a [ChatConversation](chatconversation.md) by ID using the specified transports. + +## -parameters +### -param conversationId +The ID of the conversation to retrieve. + +### -param transportIds +The IDs of the transports to use to retrieve the [ChatConversation](chatconversation.md). + +## -returns +The [ChatConversation](chatconversation.md) specified by the *conversationId* parameter. + +## -remarks + +## -examples + +## -see-also +[GetConversationAsync(String)](chatmessagestore_getconversationasync_2049140047.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getconversationasync_2049140047.md b/windows.applicationmodel.chat/chatmessagestore_getconversationasync_2049140047.md index 657519a5d9..4a93567831 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getconversationasync_2049140047.md +++ b/windows.applicationmodel.chat/chatmessagestore_getconversationasync_2049140047.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync ## -description Asynchronously gets a [ChatConversation](chatconversation.md) by ID. ## -parameters ### -param conversationId The ID of the conversation to retrieve. ## -returns The [ChatConversation](chatconversation.md) specified by the *conversationId* parameter. ## -remarks ## -examples ## -see-also [GetConversationAsync(String, IIterable(String))](chatmessagestore_getconversationasync_1734316845.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationAsync + +## -description +Asynchronously gets a [ChatConversation](chatconversation.md) by ID. + +## -parameters +### -param conversationId +The ID of the conversation to retrieve. + +## -returns +The [ChatConversation](chatconversation.md) specified by the *conversationId* parameter. + +## -remarks + +## -examples + +## -see-also +[GetConversationAsync(String, IIterable(String))](chatmessagestore_getconversationasync_1734316845.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getconversationfromthreadinginfoasync_896256404.md b/windows.applicationmodel.chat/chatmessagestore_getconversationfromthreadinginfoasync_896256404.md index f45234421e..d143c2289b 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getconversationfromthreadinginfoasync_896256404.md +++ b/windows.applicationmodel.chat/chatmessagestore_getconversationfromthreadinginfoasync_896256404.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationFromThreadingInfoAsync(Windows.ApplicationModel.Chat.ChatConversationThreadingInfo) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationFromThreadingInfoAsync ## -description Asynchronously gets a conversation based on a threading info object. ## -parameters ### -param threadingInfo The threading info that identifies the conversation. ## -returns The conversation identified by the *threadingInfo* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationFromThreadingInfoAsync(Windows.ApplicationModel.Chat.ChatConversationThreadingInfo) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationFromThreadingInfoAsync + +## -description +Asynchronously gets a conversation based on a threading info object. + +## -parameters +### -param threadingInfo +The threading info that identifies the conversation. + +## -returns +The conversation identified by the *threadingInfo* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_getconversationreader_388570943.md b/windows.applicationmodel.chat/chatmessagestore_getconversationreader_388570943.md index bbf8dfdbd0..c5dce7e111 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getconversationreader_388570943.md +++ b/windows.applicationmodel.chat/chatmessagestore_getconversationreader_388570943.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader ## -description Gets a new or existing [ChatConversationReader](chatconversationreader.md) for the message store. ## -returns The new or existing [ChatConversationReader](chatconversationreader.md). ## -remarks ## -examples ## -see-also [GetConversationReader(IIterable(String))](chatmessagestore_getconversationreader_429351951.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader + +## -description +Gets a new or existing [ChatConversationReader](chatconversationreader.md) for the message store. + +## -returns +The new or existing [ChatConversationReader](chatconversationreader.md). + +## -remarks + +## -examples + +## -see-also +[GetConversationReader(IIterable(String))](chatmessagestore_getconversationreader_429351951.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getconversationreader_429351951.md b/windows.applicationmodel.chat/chatmessagestore_getconversationreader_429351951.md index 416c066d1d..b01ea03526 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getconversationreader_429351951.md +++ b/windows.applicationmodel.chat/chatmessagestore_getconversationreader_429351951.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader ## -description Gets a new or existing [ChatConversationReader](chatconversationreader.md) for the message store using the specified transports. ## -parameters ### -param transportIds The IDs for the transports to use to retrieve the [ChatConversationReader](chatconversationreader.md). ## -returns The new or existing [ChatConversationReader](chatconversationreader.md). ## -remarks ## -examples ## -see-also [GetConversationReader](chatmessagestore_getconversationreader_388570943.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetConversationReader + +## -description +Gets a new or existing [ChatConversationReader](chatconversationreader.md) for the message store using the specified transports. + +## -parameters +### -param transportIds +The IDs for the transports to use to retrieve the [ChatConversationReader](chatconversationreader.md). + +## -returns +The new or existing [ChatConversationReader](chatconversationreader.md). + +## -remarks + +## -examples + +## -see-also +[GetConversationReader](chatmessagestore_getconversationreader_388570943.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getmessageasync_151244055.md b/windows.applicationmodel.chat/chatmessagestore_getmessageasync_151244055.md index 0490c04478..1f369eb3b0 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getmessageasync_151244055.md +++ b/windows.applicationmodel.chat/chatmessagestore_getmessageasync_151244055.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageAsync ## -description Retrieves a message specified by an identifier from the message store. ## -parameters ### -param localChatMessageId The local ID of the chat message to be retrieved. ## -returns An asynchronous operation that returns a chat message upon successful completion. ## -remarks The message corresponding to the specified identifier is returned. An application can use this method to display a message or store messages in its own private cache. ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageAsync + +## -description +Retrieves a message specified by an identifier from the message store. + +## -parameters +### -param localChatMessageId +The local ID of the chat message to be retrieved. + +## -returns +An asynchronous operation that returns a chat message upon successful completion. + +## -remarks +The message corresponding to the specified identifier is returned. An application can use this method to display a message or store messages in its own private cache. + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getmessagebyremoteidasync_1248384003.md b/windows.applicationmodel.chat/chatmessagestore_getmessagebyremoteidasync_1248384003.md index 92d85ddada..7cb4e1b301 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getmessagebyremoteidasync_1248384003.md +++ b/windows.applicationmodel.chat/chatmessagestore_getmessagebyremoteidasync_1248384003.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageByRemoteIdAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageByRemoteIdAsync ## -description Gets a message by its remote ID. ## -parameters ### -param transportId The [TransportId](chatmessage_transportid.md) to use to get the [ChatMessage](chatmessage.md). ### -param remoteId The [RemoteId](chatmessage_remoteid.md) of the [ChatMessage](chatmessage.md) to retrieve. ## -returns The message. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageByRemoteIdAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageByRemoteIdAsync + +## -description +Gets a message by its remote ID. + +## -parameters +### -param transportId +The [TransportId](chatmessage_transportid.md) to use to get the [ChatMessage](chatmessage.md). + +### -param remoteId +The [RemoteId](chatmessage_remoteid.md) of the [ChatMessage](chatmessage.md) to retrieve. + +## -returns +The message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getmessagebysyncidasync_1932815351.md b/windows.applicationmodel.chat/chatmessagestore_getmessagebysyncidasync_1932815351.md index bb2c15c25f..233b53a3e0 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getmessagebysyncidasync_1932815351.md +++ b/windows.applicationmodel.chat/chatmessagestore_getmessagebysyncidasync_1932815351.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageBySyncIdAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageBySyncIdAsync ## -description Gets a message by the sync ID. ## -parameters ### -param syncId The sync ID of the message. ## -returns When the asynchronous operation completes, a [ChatMessage](chatmessage.md) object is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageBySyncIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageBySyncIdAsync + +## -description +Gets a message by the sync ID. + +## -parameters +### -param syncId +The sync ID of the message. + +## -returns +When the asynchronous operation completes, a [ChatMessage](chatmessage.md) object is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_getmessagereader_1198599356.md b/windows.applicationmodel.chat/chatmessagestore_getmessagereader_1198599356.md index 271cf6f48b..2d9b9eb1ae 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getmessagereader_1198599356.md +++ b/windows.applicationmodel.chat/chatmessagestore_getmessagereader_1198599356.md @@ -1,3 +1,46 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader ## -description Gets a [ChatMessageReader class](chatmessagereader.md) object which provides a message collection from the message store. ## -returns The chat message reader. ## -remarks The following example uses the message reader to find the first message that has a subject containing a simple search string: ``` async ChatMessage SearchMessagesBySubject(ChatMesssage store, string searchItem) { ChatMessage foundMessage = null; IReadOnlyList messageList = await store.GetMessageReader().ReadBatchAsync(); if (messageList.Count > 0) { foreach(ChatMessage message in messageList) { If (message.Subject.Contains(searchItem)) { foundMessage = message;{ break; } } } return foundMessage; } ``` ## -examples ## -see-also [GetMessageReader(TimeSpan)](chatmessagestore_getmessagereader_232560328.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader + +## -description +Gets a [ChatMessageReader class](chatmessagereader.md) object which provides a message collection from the message store. + +## -returns +The chat message reader. + +## -remarks +The following example uses the message reader to find the first message that has a subject containing a simple search string: + +``` +async ChatMessage SearchMessagesBySubject(ChatMesssage store, string searchItem) +{ + ChatMessage foundMessage = null; + IReadOnlyList messageList = await store.GetMessageReader().ReadBatchAsync(); + if (messageList.Count > 0) + { + foreach(ChatMessage message in messageList) + { + If (message.Subject.Contains(searchItem)) + { + foundMessage = message;{ + break; + } + } + } + return foundMessage; +} +``` + + + +## -examples + +## -see-also +[GetMessageReader(TimeSpan)](chatmessagestore_getmessagereader_232560328.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getmessagereader_232560328.md b/windows.applicationmodel.chat/chatmessagestore_getmessagereader_232560328.md index 00094b9c38..c3fb226636 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getmessagereader_232560328.md +++ b/windows.applicationmodel.chat/chatmessagestore_getmessagereader_232560328.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader ## -description Gets a [ChatMessageReader class](chatmessagereader.md) object which provides a message collection from the message store. The collection of messages is limited to the time span provided. ## -parameters ### -param recentTimeLimit The time window for the retrieved reader. ## -returns The chat message reader. ## -remarks ## -examples ## -see-also [GetMessageReader](chatmessagestore_getmessagereader_1198599356.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetMessageReader + +## -description +Gets a [ChatMessageReader class](chatmessagereader.md) object which provides a message collection from the message store. The collection of messages is limited to the time span provided. + +## -parameters +### -param recentTimeLimit +The time window for the retrieved reader. + +## -returns +The chat message reader. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader](chatmessagestore_getmessagereader_1198599356.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getsearchreader_1103843978.md b/windows.applicationmodel.chat/chatmessagestore_getsearchreader_1103843978.md index a9be44095a..9ff69eb905 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getsearchreader_1103843978.md +++ b/windows.applicationmodel.chat/chatmessagestore_getsearchreader_1103843978.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetSearchReader(Windows.ApplicationModel.Chat.ChatQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetSearchReader ## -description Gets a new or existing [ChatSearchReader](chatsearchreader.md) to be used to search for messages. ## -parameters ### -param value The query options that the search reader will use when looking for matching messages. ## -returns The new or existing search reader. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetSearchReader(Windows.ApplicationModel.Chat.ChatQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetSearchReader + +## -description +Gets a new or existing [ChatSearchReader](chatsearchreader.md) to be used to search for messages. + +## -parameters +### -param value +The query options that the search reader will use when looking for matching messages. + +## -returns +The new or existing search reader. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_201138164.md b/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_201138164.md index 2a5f80e4fe..7b33035634 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_201138164.md +++ b/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_201138164.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync ## -description Asynchronously gets the number of unread chat messages using the specified transports. ## -parameters ### -param transportIds The IDs of the chat transports to use to get the unseen messages count. ## -returns The number of unread chat messages. ## -remarks ## -examples ## -see-also [GetUnseenCountAsync](chatmessagestore_getunseencountasync_88302786.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync + +## -description +Asynchronously gets the number of unread chat messages using the specified transports. + +## -parameters +### -param transportIds +The IDs of the chat transports to use to get the unseen messages count. + +## -returns +The number of unread chat messages. + +## -remarks + +## -examples + +## -see-also +[GetUnseenCountAsync](chatmessagestore_getunseencountasync_88302786.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_88302786.md b/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_88302786.md index 6584897f72..01a305a5c5 100644 --- a/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_88302786.md +++ b/windows.applicationmodel.chat/chatmessagestore_getunseencountasync_88302786.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync ## -description Asynchronously gets the number of unread chat messages. ## -returns The number of unread chat messages. ## -remarks ## -examples ## -see-also [GetUnseenCountAsync(IIterable(String))](chatmessagestore_getunseencountasync_201138164.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.GetUnseenCountAsync + +## -description +Asynchronously gets the number of unread chat messages. + +## -returns +The number of unread chat messages. + +## -remarks + +## -examples + +## -see-also +[GetUnseenCountAsync(IIterable(String))](chatmessagestore_getunseencountasync_201138164.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1185002275.md b/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1185002275.md index 2994554374..ce7627486e 100644 --- a/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1185002275.md +++ b/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1185002275.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync ## -description Asynchronously marks all transport messages as seen. ## -parameters ### -param transportIds The IDs of the transports for which to mark all messages as seen. ## -returns An async action indicating that the operation has finished. ## -remarks ## -examples ## -see-also [MarkAsSeenAsync](chatmessagestore_markasseenasync_1210042387.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync + +## -description +Asynchronously marks all transport messages as seen. + +## -parameters +### -param transportIds +The IDs of the transports for which to mark all messages as seen. + +## -returns +An async action indicating that the operation has finished. + +## -remarks + +## -examples + +## -see-also +[MarkAsSeenAsync](chatmessagestore_markasseenasync_1210042387.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1210042387.md b/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1210042387.md index 3f7ce37e38..f19a3dbab6 100644 --- a/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1210042387.md +++ b/windows.applicationmodel.chat/chatmessagestore_markasseenasync_1210042387.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync ## -description Asynchronously marks all transport messages as seen. ## -returns An async action indicating that the operation has finished. ## -remarks ## -examples ## -see-also [MarkAsSeenAsync(IIterable(String))](chatmessagestore_markasseenasync_1185002275.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.MarkAsSeenAsync + +## -description +Asynchronously marks all transport messages as seen. + +## -returns +An async action indicating that the operation has finished. + +## -remarks + +## -examples + +## -see-also +[MarkAsSeenAsync(IIterable(String))](chatmessagestore_markasseenasync_1185002275.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_markmessagereadasync_24341770.md b/windows.applicationmodel.chat/chatmessagestore_markmessagereadasync_24341770.md index b012373838..05ee2b880d 100644 --- a/windows.applicationmodel.chat/chatmessagestore_markmessagereadasync_24341770.md +++ b/windows.applicationmodel.chat/chatmessagestore_markmessagereadasync_24341770.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.MarkMessageReadAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.MarkMessageReadAsync ## -description Marks a specified message in the store as already read. ## -parameters ### -param localChatMessageId The local ID of the message to be marked as read. ## -returns An asynchronous action. ## -remarks The [IsRead](chatmessage_isread.md) property of the [ChatMessage class](chatmessage.md) matching the *localMessageId* parameter is set to "true" when this method completes. ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.MarkMessageReadAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.MarkMessageReadAsync + +## -description +Marks a specified message in the store as already read. + +## -parameters +### -param localChatMessageId +The local ID of the message to be marked as read. + +## -returns +An asynchronous action. + +## -remarks +The [IsRead](chatmessage_isread.md) property of the [ChatMessage class](chatmessage.md) matching the *localMessageId* parameter is set to "true" when this method completes. + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_messagechanged.md b/windows.applicationmodel.chat/chatmessagestore_messagechanged.md index c810600dc7..e8b6eb84fb 100644 --- a/windows.applicationmodel.chat/chatmessagestore_messagechanged.md +++ b/windows.applicationmodel.chat/chatmessagestore_messagechanged.md @@ -1,3 +1,39 @@ ---- -api-id: E:Windows.ApplicationModel.Chat.ChatMessageStore.MessageChanged --api-type: winrt event ---- # Windows.ApplicationModel.Chat.ChatMessageStore.MessageChanged ## -description An event that occurs when a message in the message store is changed. ## -remarks The following simple example demonstrates how to declare and enable change tracking for message changes. ``` void ChatMessageStore_MessageChanged(ChatMessageStore store, ChatMessageChangedEventArgs changeArgs) { // Act on the event… } void SetStoreProperties(ChatMessageStore store) { store.MessageChanged += ChatMessageStore_MessageChanged; store.ChangeTracker.Enable(); } ``` ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Chat.ChatMessageStore.MessageChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.MessageChanged + +## -description +An event that occurs when a message in the message store is changed. + +## -remarks +The following simple example demonstrates how to declare and enable change tracking for message changes. + +``` +void ChatMessageStore_MessageChanged(ChatMessageStore store, ChatMessageChangedEventArgs changeArgs) +{ + // Act on the event… +} + +void SetStoreProperties(ChatMessageStore store) +{ + store.MessageChanged += ChatMessageStore_MessageChanged; + store.ChangeTracker.Enable(); +} +``` + + + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_retrysendmessageasync_1122758369.md b/windows.applicationmodel.chat/chatmessagestore_retrysendmessageasync_1122758369.md index 3f2b0dde79..9925152640 100644 --- a/windows.applicationmodel.chat/chatmessagestore_retrysendmessageasync_1122758369.md +++ b/windows.applicationmodel.chat/chatmessagestore_retrysendmessageasync_1122758369.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.RetrySendMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.RetrySendMessageAsync ## -description Attempts a retry of sending a specified message from the message store. ## -parameters ### -param localChatMessageId The local ID of the message to be retried. ## -returns An asynchronous action. ## -remarks The message contents including its attachments are downloaded. An application will call this method it if it chooses to retry sending the message when the message status is [ChatMessageStatus](chatmessagestatus.md).SendFailed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.RetrySendMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.RetrySendMessageAsync + +## -description +Attempts a retry of sending a specified message from the message store. + +## -parameters +### -param localChatMessageId +The local ID of the message to be retried. + +## -returns +An asynchronous action. + +## -remarks +The message contents including its attachments are downloaded. An application will call this method it if it chooses to retry sending the message when the message status is [ChatMessageStatus](chatmessagestatus.md).SendFailed. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_savemessageasync_55733415.md b/windows.applicationmodel.chat/chatmessagestore_savemessageasync_55733415.md index 6e4c558ade..82d8d00cc4 100644 --- a/windows.applicationmodel.chat/chatmessagestore_savemessageasync_55733415.md +++ b/windows.applicationmodel.chat/chatmessagestore_savemessageasync_55733415.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.SaveMessageAsync(Windows.ApplicationModel.Chat.ChatMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.SaveMessageAsync ## -description Asynchronously saves a message to the [ChatMessageStore](chatmessagestore.md). ## -parameters ### -param chatMessage The message to save. ## -returns An async action indicating that the operation has finished. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.SaveMessageAsync(Windows.ApplicationModel.Chat.ChatMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.SaveMessageAsync + +## -description +Asynchronously saves a message to the [ChatMessageStore](chatmessagestore.md). + +## -parameters +### -param chatMessage +The message to save. + +## -returns +An async action indicating that the operation has finished. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_sendmessageasync_1780707466.md b/windows.applicationmodel.chat/chatmessagestore_sendmessageasync_1780707466.md index a9f95f3f42..cdd191fa9b 100644 --- a/windows.applicationmodel.chat/chatmessagestore_sendmessageasync_1780707466.md +++ b/windows.applicationmodel.chat/chatmessagestore_sendmessageasync_1780707466.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.SendMessageAsync(Windows.ApplicationModel.Chat.ChatMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.SendMessageAsync ## -description Attempts to send a chat message. The message is saved to the message store as part of the send operation. ## -parameters ### -param chatMessage The chat message to be sent. ## -returns An asynchronous action. ## -remarks Once the send is attempted, the message is assigned an identifier and the [Id](chatmessage_id.md) property is set to this value. If the send operation fails, the application can try sending the message again later with [RetrySendMessageAsync](chatmessagestore_retrysendmessageasync.md) method using the assigned identifier. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.SendMessageAsync(Windows.ApplicationModel.Chat.ChatMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.SendMessageAsync + +## -description +Attempts to send a chat message. The message is saved to the message store as part of the send operation. + +## -parameters +### -param chatMessage +The chat message to be sent. + +## -returns +An asynchronous action. + +## -remarks +Once the send is attempted, the message is assigned an identifier and the [Id](chatmessage_id.md) property is set to this value. If the send operation fails, the application can try sending the message again later with [RetrySendMessageAsync](chatmessagestore_retrysendmessageasync.md) method using the assigned identifier. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_storechanged.md b/windows.applicationmodel.chat/chatmessagestore_storechanged.md index 9b315a8b18..bbe5d0a626 100644 --- a/windows.applicationmodel.chat/chatmessagestore_storechanged.md +++ b/windows.applicationmodel.chat/chatmessagestore_storechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.ApplicationModel.Chat.ChatMessageStore.StoreChanged --api-type: winrt event ---- # Windows.ApplicationModel.Chat.ChatMessageStore.StoreChanged ## -description Occurs when something in the [ChatMessageStore](chatmessagestore.md) has changed. ## -remarks ## -examples ## -see-also ## -capabilities blockedChatMessages \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Chat.ChatMessageStore.StoreChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.StoreChanged + +## -description +Occurs when something in the [ChatMessageStore](chatmessagestore.md) has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +blockedChatMessages \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatmessagestore_trycanceldownloadmessageasync_1200668765.md b/windows.applicationmodel.chat/chatmessagestore_trycanceldownloadmessageasync_1200668765.md index 8e088374ed..b980ada408 100644 --- a/windows.applicationmodel.chat/chatmessagestore_trycanceldownloadmessageasync_1200668765.md +++ b/windows.applicationmodel.chat/chatmessagestore_trycanceldownloadmessageasync_1200668765.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelDownloadMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelDownloadMessageAsync ## -description Asynchronously attempts to cancel downloading the specified message. ## -parameters ### -param localChatMessageId The ID of the message to stop downloading. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelDownloadMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelDownloadMessageAsync + +## -description +Asynchronously attempts to cancel downloading the specified message. + +## -parameters +### -param localChatMessageId +The ID of the message to stop downloading. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_trycancelsendmessageasync_40585240.md b/windows.applicationmodel.chat/chatmessagestore_trycancelsendmessageasync_40585240.md index e89cfe51de..e69073e03a 100644 --- a/windows.applicationmodel.chat/chatmessagestore_trycancelsendmessageasync_40585240.md +++ b/windows.applicationmodel.chat/chatmessagestore_trycancelsendmessageasync_40585240.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelSendMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelSendMessageAsync ## -description Asynchronously attempts to cancel sending the specified message. ## -parameters ### -param localChatMessageId The ID of the message to stop sending. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelSendMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.TryCancelSendMessageAsync + +## -description +Asynchronously attempts to cancel sending the specified message. + +## -parameters +### -param localChatMessageId +The ID of the message to stop sending. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestore_validatemessage_660151262.md b/windows.applicationmodel.chat/chatmessagestore_validatemessage_660151262.md index c432bf4265..158116ce03 100644 --- a/windows.applicationmodel.chat/chatmessagestore_validatemessage_660151262.md +++ b/windows.applicationmodel.chat/chatmessagestore_validatemessage_660151262.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.ValidateMessage(Windows.ApplicationModel.Chat.ChatMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageStore.ValidateMessage ## -description Checks if a chat message is valid and returns the validation result. ## -parameters ### -param chatMessage The chat message to validate. ## -returns The validation result. ## -remarks Message validation will check the properties of the message for proper format, valid transport selected, attachment count, recipient count, and valid recipients. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageStore.ValidateMessage(Windows.ApplicationModel.Chat.ChatMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStore.ValidateMessage + +## -description +Checks if a chat message is valid and returns the validation result. + +## -parameters +### -param chatMessage +The chat message to validate. + +## -returns +The validation result. + +## -remarks +Message validation will check the properties of the message for proper format, valid transport selected, attachment count, recipient count, and valid recipients. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestorechangedeventargs.md b/windows.applicationmodel.chat/chatmessagestorechangedeventargs.md index 4bb98e4f13..1b0a47fcb9 100644 --- a/windows.applicationmodel.chat/chatmessagestorechangedeventargs.md +++ b/windows.applicationmodel.chat/chatmessagestorechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs ## -description Provides the data for the [ChatMessageStoreChanged](chatmessagestorechangedeventargs.md) event. ## -remarks An instance of this class is created by the system and passed as an argument to the [ChatMessageStoreChanged](chatmessagestorechangedeventargs.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs + +## -description +Provides the data for the [ChatMessageStoreChanged](chatmessagestorechangedeventargs.md) event. + +## -remarks +An instance of this class is created by the system and passed as an argument to the [ChatMessageStoreChanged](chatmessagestorechangedeventargs.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestorechangedeventargs_id.md b/windows.applicationmodel.chat/chatmessagestorechangedeventargs_id.md index 2b492ffaa8..112d4fc4fa 100644 --- a/windows.applicationmodel.chat/chatmessagestorechangedeventargs_id.md +++ b/windows.applicationmodel.chat/chatmessagestorechangedeventargs_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Id --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Id ## -description Gets the ID of the object that changed. ## -property-value The ID of the object that changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Id + +## -description +Gets the ID of the object that changed. + +## -property-value +The ID of the object that changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagestorechangedeventargs_kind.md b/windows.applicationmodel.chat/chatmessagestorechangedeventargs_kind.md index cf2cf558d3..dd5a1e39e7 100644 --- a/windows.applicationmodel.chat/chatmessagestorechangedeventargs_kind.md +++ b/windows.applicationmodel.chat/chatmessagestorechangedeventargs_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Kind ## -description Gets the type of change that happened. ## -property-value The type of change that happened. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageStoreChangedEventArgs.Kind + +## -description +Gets the type of change that happened. + +## -property-value +The type of change that happened. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport.md b/windows.applicationmodel.chat/chatmessagetransport.md index a46458db01..bd24a547d4 100644 --- a/windows.applicationmodel.chat/chatmessagetransport.md +++ b/windows.applicationmodel.chat/chatmessagetransport.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageTransport --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageTransport ## -description Represents the identity of a transport for sending and receiving messages. Physically, a chat message transport is a SIM slot on the phone. ## -remarks Obtain an instance of this class by calling [GetTransportsAsync](chatmessagemanager_gettransportsasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageTransport +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport + +## -description +Represents the identity of a transport for sending and receiving messages. Physically, a chat message transport is a SIM slot on the phone. + +## -remarks +Obtain an instance of this class by calling [GetTransportsAsync](chatmessagemanager_gettransportsasync.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_configuration.md b/windows.applicationmodel.chat/chatmessagetransport_configuration.md index cd6cccfce7..91178cafea 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_configuration.md +++ b/windows.applicationmodel.chat/chatmessagetransport_configuration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.Configuration --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.Configuration ## -description Gets the configuration of the message transport. ## -property-value The configuration of the message transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.Configuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.Configuration + +## -description +Gets the configuration of the message transport. + +## -property-value +The configuration of the message transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_isactive.md b/windows.applicationmodel.chat/chatmessagetransport_isactive.md index 8845fb51ab..6edf0d753e 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_isactive.md +++ b/windows.applicationmodel.chat/chatmessagetransport_isactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.IsActive --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.IsActive ## -description Gets a Boolean value that indicates whether the messaging transport is active. ## -property-value A value indicating if the transport is active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.IsActive +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.IsActive + +## -description +Gets a Boolean value that indicates whether the messaging transport is active. + +## -property-value +A value indicating if the transport is active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_isappsetasnotificationprovider.md b/windows.applicationmodel.chat/chatmessagetransport_isappsetasnotificationprovider.md index 49cb2267bb..bbb46eb2ab 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_isappsetasnotificationprovider.md +++ b/windows.applicationmodel.chat/chatmessagetransport_isappsetasnotificationprovider.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.IsAppSetAsNotificationProvider --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.IsAppSetAsNotificationProvider ## -description Gets a Boolean value that indicates whether the current application is set as the messaging notification provider. ## -property-value A value indicating if the app is set as a notification provider. ## -remarks **True** if the application is set as the notification provider for the transport, otherwise **False**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.IsAppSetAsNotificationProvider +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.IsAppSetAsNotificationProvider + +## -description +Gets a Boolean value that indicates whether the current application is set as the messaging notification provider. + +## -property-value +A value indicating if the app is set as a notification provider. + +## -remarks +**True** if the application is set as the notification provider for the transport, otherwise **False**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_requestsetasnotificationproviderasync_45963751.md b/windows.applicationmodel.chat/chatmessagetransport_requestsetasnotificationproviderasync_45963751.md index 4033bf9dcc..b99ce0f841 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_requestsetasnotificationproviderasync_45963751.md +++ b/windows.applicationmodel.chat/chatmessagetransport_requestsetasnotificationproviderasync_45963751.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatMessageTransport.RequestSetAsNotificationProviderAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.RequestSetAsNotificationProviderAsync ## -description Sets the current application to handle messaging notifications. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatMessageTransport.RequestSetAsNotificationProviderAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.RequestSetAsNotificationProviderAsync + +## -description +Sets the current application to handle messaging notifications. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_transportfriendlyname.md b/windows.applicationmodel.chat/chatmessagetransport_transportfriendlyname.md index c6e2c2cbc5..1e111d47e3 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_transportfriendlyname.md +++ b/windows.applicationmodel.chat/chatmessagetransport_transportfriendlyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.TransportFriendlyName --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.TransportFriendlyName ## -description Gets a descriptive name identifying the messaging transport. ## -property-value The friendly name for the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.TransportFriendlyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.TransportFriendlyName + +## -description +Gets a descriptive name identifying the messaging transport. + +## -property-value +The friendly name for the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_transportid.md b/windows.applicationmodel.chat/chatmessagetransport_transportid.md index e52741abdc..67ea4dd747 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_transportid.md +++ b/windows.applicationmodel.chat/chatmessagetransport_transportid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.TransportId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.TransportId ## -description Gets the messaging transport’s identifier. ## -property-value The ID of the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.TransportId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.TransportId + +## -description +Gets the messaging transport’s identifier. + +## -property-value +The ID of the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransport_transportkind.md b/windows.applicationmodel.chat/chatmessagetransport_transportkind.md index 17a5beb3f3..b2a9db57ca 100644 --- a/windows.applicationmodel.chat/chatmessagetransport_transportkind.md +++ b/windows.applicationmodel.chat/chatmessagetransport_transportkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.TransportKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransport.TransportKind ## -description Gets the type of the message transport. ## -property-value The type of the message transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransport.TransportKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransport.TransportKind + +## -description +Gets the type of the message transport. + +## -property-value +The type of the message transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransportconfiguration.md b/windows.applicationmodel.chat/chatmessagetransportconfiguration.md index d8c5258c86..d1fed76609 100644 --- a/windows.applicationmodel.chat/chatmessagetransportconfiguration.md +++ b/windows.applicationmodel.chat/chatmessagetransportconfiguration.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration ## -description Represents data about the chat message transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration + +## -description +Represents data about the chat message transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransportconfiguration_extendedproperties.md b/windows.applicationmodel.chat/chatmessagetransportconfiguration_extendedproperties.md index 7ec8cb88c3..e8ef20679a 100644 --- a/windows.applicationmodel.chat/chatmessagetransportconfiguration_extendedproperties.md +++ b/windows.applicationmodel.chat/chatmessagetransportconfiguration_extendedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.ExtendedProperties --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.ExtendedProperties ## -description Gets the extended properties of the transport. ## -property-value The extended properties of the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.ExtendedProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.ExtendedProperties + +## -description +Gets the extended properties of the transport. + +## -property-value +The extended properties of the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxattachmentcount.md b/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxattachmentcount.md index f24ad02f48..63de5688ea 100644 --- a/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxattachmentcount.md +++ b/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxattachmentcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxAttachmentCount --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxAttachmentCount ## -description Gets the maximum attachment limit for a message on the transport. ## -property-value The maximum attachment limit for a message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxAttachmentCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxAttachmentCount + +## -description +Gets the maximum attachment limit for a message on the transport. + +## -property-value +The maximum attachment limit for a message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxmessagesizeinkilobytes.md b/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxmessagesizeinkilobytes.md index 03c3508897..45c6ee6290 100644 --- a/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxmessagesizeinkilobytes.md +++ b/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxmessagesizeinkilobytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxMessageSizeInKilobytes --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxMessageSizeInKilobytes ## -description Gets the maximum size of an attachment for the transport. ## -property-value The maximum size of an attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxMessageSizeInKilobytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxMessageSizeInKilobytes + +## -description +Gets the maximum size of an attachment for the transport. + +## -property-value +The maximum size of an attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxrecipientcount.md b/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxrecipientcount.md index 0bf808cc63..2928bb7ad2 100644 --- a/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxrecipientcount.md +++ b/windows.applicationmodel.chat/chatmessagetransportconfiguration_maxrecipientcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxRecipientCount --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxRecipientCount ## -description Gets the maximum number of recipients for the transport. ## -property-value The maximum number of recipients. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxRecipientCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.MaxRecipientCount + +## -description +Gets the maximum number of recipients for the transport. + +## -property-value +The maximum number of recipients. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagetransportconfiguration_supportedvideoformat.md b/windows.applicationmodel.chat/chatmessagetransportconfiguration_supportedvideoformat.md index e962e5eb0c..e324f4b4f3 100644 --- a/windows.applicationmodel.chat/chatmessagetransportconfiguration_supportedvideoformat.md +++ b/windows.applicationmodel.chat/chatmessagetransportconfiguration_supportedvideoformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.SupportedVideoFormat --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.SupportedVideoFormat ## -description Gets the supported video encoding format for the transport. ## -property-value The supported video encoding format for the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.SupportedVideoFormat +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageTransportConfiguration.SupportedVideoFormat + +## -description +Gets the supported video encoding format for the transport. + +## -property-value +The supported video encoding format for the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagevalidationresult.md b/windows.applicationmodel.chat/chatmessagevalidationresult.md index 54586bdf6f..920d2d5ba2 100644 --- a/windows.applicationmodel.chat/chatmessagevalidationresult.md +++ b/windows.applicationmodel.chat/chatmessagevalidationresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatMessageValidationResult --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatMessageValidationResult ## -description Provides results for validation of chat messages. ## -remarks Obtain an instance of this class by calling [ValidateMessage](chatmessagestore_validatemessage.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatMessageValidationResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageValidationResult + +## -description +Provides results for validation of chat messages. + +## -remarks +Obtain an instance of this class by calling [ValidateMessage](chatmessagestore_validatemessage.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagevalidationresult_maxpartcount.md b/windows.applicationmodel.chat/chatmessagevalidationresult_maxpartcount.md index 534c41c158..7e8eedb43b 100644 --- a/windows.applicationmodel.chat/chatmessagevalidationresult_maxpartcount.md +++ b/windows.applicationmodel.chat/chatmessagevalidationresult_maxpartcount.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.MaxPartCount --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageValidationResult.MaxPartCount ## -description Gets the maximum number of text fragments allowed for a message. This value has meaning when the SMS text portion of a message is validated. ## -property-value The maximum number of parts. ## -remarks The SMS text portion of a message is divided into multiple parts if necessary. The [MaxPartCount](chatmessagevalidationresult_maxpartcount.md) value is the total count of parts allowed for any message. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.MaxPartCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageValidationResult.MaxPartCount + +## -description +Gets the maximum number of text fragments allowed for a message. This value has meaning when the SMS text portion of a message is validated. + +## -property-value +The maximum number of parts. + +## -remarks +The SMS text portion of a message is divided into multiple parts if necessary. The [MaxPartCount](chatmessagevalidationresult_maxpartcount.md) value is the total count of parts allowed for any message. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagevalidationresult_partcount.md b/windows.applicationmodel.chat/chatmessagevalidationresult_partcount.md index 0c3ac021cd..8583558375 100644 --- a/windows.applicationmodel.chat/chatmessagevalidationresult_partcount.md +++ b/windows.applicationmodel.chat/chatmessagevalidationresult_partcount.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.PartCount --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageValidationResult.PartCount ## -description Gets the total number of text fragments needed for this message. This value has meaning when the SMS text portion of a message is validated. ## -property-value The number of parts. ## -remarks The SMS text portion of a message is divided into multiple parts if necessary. The [PartCount](chatmessagevalidationresult_partcount.md) value is the total count of parts required to contain this message. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.PartCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageValidationResult.PartCount + +## -description +Gets the total number of text fragments needed for this message. This value has meaning when the SMS text portion of a message is validated. + +## -property-value +The number of parts. + +## -remarks +The SMS text portion of a message is divided into multiple parts if necessary. The [PartCount](chatmessagevalidationresult_partcount.md) value is the total count of parts required to contain this message. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagevalidationresult_remainingcharactercountinpart.md b/windows.applicationmodel.chat/chatmessagevalidationresult_remainingcharactercountinpart.md index 797d0fc11c..cd94eedb2c 100644 --- a/windows.applicationmodel.chat/chatmessagevalidationresult_remainingcharactercountinpart.md +++ b/windows.applicationmodel.chat/chatmessagevalidationresult_remainingcharactercountinpart.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.RemainingCharacterCountInPart --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageValidationResult.RemainingCharacterCountInPart ## -description Gets the number of characters not used in the final message fragments. This value has meaning when the SMS text portion of a message is validated. ## -property-value The remaining characters in the part. ## -remarks The SMS text portion of a message is divided in to multiple parts if necessary. The [RemainingCharacterCountInPart](chatmessagevalidationresult_remainingcharactercountinpart.md) value is the number of character positions that remain unused in the final message fragment. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.RemainingCharacterCountInPart +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageValidationResult.RemainingCharacterCountInPart + +## -description +Gets the number of characters not used in the final message fragments. This value has meaning when the SMS text portion of a message is validated. + +## -property-value +The remaining characters in the part. + +## -remarks +The SMS text portion of a message is divided in to multiple parts if necessary. The [RemainingCharacterCountInPart](chatmessagevalidationresult_remainingcharactercountinpart.md) value is the number of character positions that remain unused in the final message fragment. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatmessagevalidationresult_status.md b/windows.applicationmodel.chat/chatmessagevalidationresult_status.md index 3a91669e03..6f5f63383f 100644 --- a/windows.applicationmodel.chat/chatmessagevalidationresult_status.md +++ b/windows.applicationmodel.chat/chatmessagevalidationresult_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.Status --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatMessageValidationResult.Status ## -description Gets the message validation status code. ## -property-value The status of the validation. ## -remarks When [Status](chatmessagevalidationresult_status.md) is not [ChatMessageValidationStatus](chatmessagevalidationstatus.md).Valid, the status result indicates the first error condition found. A message may have additional errors, and a second validation will return the next error found if the previous error is resolved. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatMessageValidationResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatMessageValidationResult.Status + +## -description +Gets the message validation status code. + +## -property-value +The status of the validation. + +## -remarks +When [Status](chatmessagevalidationresult_status.md) is not [ChatMessageValidationStatus](chatmessagevalidationstatus.md).Valid, the status result indicates the first error condition found. A message may have additional errors, and a second validation will return the next error found if the previous error is resolved. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatqueryoptions.md b/windows.applicationmodel.chat/chatqueryoptions.md index 9f33231227..aa12d556f1 100644 --- a/windows.applicationmodel.chat/chatqueryoptions.md +++ b/windows.applicationmodel.chat/chatqueryoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatQueryOptions --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatQueryOptions ## -description Represents the criteria for finding chat messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatQueryOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatQueryOptions + +## -description +Represents the criteria for finding chat messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatqueryoptions_chatqueryoptions_1221375020.md b/windows.applicationmodel.chat/chatqueryoptions_chatqueryoptions_1221375020.md index c56cc088f5..bd32e49faf 100644 --- a/windows.applicationmodel.chat/chatqueryoptions_chatqueryoptions_1221375020.md +++ b/windows.applicationmodel.chat/chatqueryoptions_chatqueryoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatQueryOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatQueryOptions.ChatQueryOptions ## -description Initializes a new instance of the [ChatQueryOptions](chatqueryoptions.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatQueryOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatQueryOptions.ChatQueryOptions + +## -description +Initializes a new instance of the [ChatQueryOptions](chatqueryoptions.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatqueryoptions_searchstring.md b/windows.applicationmodel.chat/chatqueryoptions_searchstring.md index 464333cf9a..9d3b575bdf 100644 --- a/windows.applicationmodel.chat/chatqueryoptions_searchstring.md +++ b/windows.applicationmodel.chat/chatqueryoptions_searchstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatQueryOptions.SearchString --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatQueryOptions.SearchString ## -description Gets or sets the string to search for the in [ChatMessageStore](chatmessagestore.md). ## -property-value The string to search for the in [ChatMessageStore](chatmessagestore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatQueryOptions.SearchString +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatQueryOptions.SearchString + +## -description +Gets or sets the string to search for the in [ChatMessageStore](chatmessagestore.md). + +## -property-value +The string to search for the in [ChatMessageStore](chatmessagestore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo.md index 76d740ad8c..667f42796b 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo ## -description Represent the delivery info about a chat recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo + +## -description +Represent the delivery info about a chat recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_chatrecipientdeliveryinfo_1221375020.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_chatrecipientdeliveryinfo_1221375020.md index dfa871a36f..8514189dc9 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_chatrecipientdeliveryinfo_1221375020.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_chatrecipientdeliveryinfo_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.ChatRecipientDeliveryInfo ## -description Initializes a new instance of the [ChatRecipientDeliveryInfo](chatrecipientdeliveryinfo.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.ChatRecipientDeliveryInfo + +## -description +Initializes a new instance of the [ChatRecipientDeliveryInfo](chatrecipientdeliveryinfo.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_deliverytime.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_deliverytime.md index 04e5a2dd9b..be1b4cdfc1 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_deliverytime.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_deliverytime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.DeliveryTime --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.DeliveryTime ## -description Gets or sets the time the message was sent to the recipient. ## -property-value The time the message was sent to the recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.DeliveryTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.DeliveryTime + +## -description +Gets or sets the time the message was sent to the recipient. + +## -property-value +The time the message was sent to the recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_iserrorpermanent.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_iserrorpermanent.md index 230b81310b..5ddac510c0 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_iserrorpermanent.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_iserrorpermanent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.IsErrorPermanent --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.IsErrorPermanent ## -description Gets a Boolean value indicating whether the error for the message that was sent to the recipient is permanent. ## -property-value A Boolean value indicating whether the error for the message that was sent to the recipient is permanent. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.IsErrorPermanent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.IsErrorPermanent + +## -description +Gets a Boolean value indicating whether the error for the message that was sent to the recipient is permanent. + +## -property-value +A Boolean value indicating whether the error for the message that was sent to the recipient is permanent. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_readtime.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_readtime.md index 08a546163d..a7839fc75f 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_readtime.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_readtime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.ReadTime --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.ReadTime ## -description Gets or sets the time the recipient read the message. ## -property-value The time the recipient read the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.ReadTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.ReadTime + +## -description +Gets or sets the time the recipient read the message. + +## -property-value +The time the recipient read the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_status.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_status.md index c04ec6c9c7..53bb7f85e1 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_status.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.Status --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.Status ## -description Gets the status of the message. ## -property-value The status of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.Status + +## -description +Gets the status of the message. + +## -property-value +The status of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportaddress.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportaddress.md index d882390e01..129246a00e 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportaddress.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportAddress --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportAddress ## -description Gets or sets the transport address of the recipient. ## -property-value The transport address of the recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportAddress + +## -description +Gets or sets the transport address of the recipient. + +## -property-value +The transport address of the recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcode.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcode.md index 809037c4a0..79b003b613 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcode.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCode ## -description Get the transport error code. ## -property-value The transport error code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCode + +## -description +Get the transport error code. + +## -property-value +The transport error code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcodecategory.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcodecategory.md index f629556094..81a7f08050 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcodecategory.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transporterrorcodecategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCodeCategory --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCodeCategory ## -description Gets the category for the [TransportErrorCode](chatrecipientdeliveryinfo_transporterrorcode.md). ## -property-value The category for the [TransportErrorCode](chatrecipientdeliveryinfo_transporterrorcode.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCodeCategory +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportErrorCodeCategory + +## -description +Gets the category for the [TransportErrorCode](chatrecipientdeliveryinfo_transporterrorcode.md). + +## -property-value +The category for the [TransportErrorCode](chatrecipientdeliveryinfo_transporterrorcode.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportinterpretederrorcode.md b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportinterpretederrorcode.md index 6a0fbb2f3b..4e18d4d786 100644 --- a/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportinterpretederrorcode.md +++ b/windows.applicationmodel.chat/chatrecipientdeliveryinfo_transportinterpretederrorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportInterpretedErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportInterpretedErrorCode ## -description Gets the interpreted error code for the transport. ## -property-value The interpreted error code for the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportInterpretedErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatRecipientDeliveryInfo.TransportInterpretedErrorCode + +## -description +Gets the interpreted error code for the transport. + +## -property-value +The interpreted error code for the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsearchreader.md b/windows.applicationmodel.chat/chatsearchreader.md index f5f6a0e59e..1f29353398 100644 --- a/windows.applicationmodel.chat/chatsearchreader.md +++ b/windows.applicationmodel.chat/chatsearchreader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatSearchReader --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatSearchReader ## -description Provides functionality to search for chat messages in the [ChatMessageStore](chatmessagestore.md). ## -remarks Call the [ChatMessageStore.GetSearchReader](chatmessagestore_getsearchreader.md) method to obtain an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatSearchReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatSearchReader + +## -description +Provides functionality to search for chat messages in the [ChatMessageStore](chatmessagestore.md). + +## -remarks +Call the [ChatMessageStore.GetSearchReader](chatmessagestore_getsearchreader.md) method to obtain an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsearchreader_readbatchasync_1346490639.md b/windows.applicationmodel.chat/chatsearchreader_readbatchasync_1346490639.md index 00e52bd08d..aa1bff39fc 100644 --- a/windows.applicationmodel.chat/chatsearchreader_readbatchasync_1346490639.md +++ b/windows.applicationmodel.chat/chatsearchreader_readbatchasync_1346490639.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync(System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync ## -description Returns a batch of found items matching the search criteria. ## -parameters ### -param count The maximum number of items to return. ## -returns A list of items matching the search criteria. ## -remarks ## -examples ## -see-also [ReadBatchAsync](chatsearchreader_readbatchasync_888788553.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync(System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync + +## -description +Returns a batch of found items matching the search criteria. + +## -parameters +### -param count +The maximum number of items to return. + +## -returns +A list of items matching the search criteria. + +## -remarks + +## -examples + +## -see-also +[ReadBatchAsync](chatsearchreader_readbatchasync_888788553.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatsearchreader_readbatchasync_888788553.md b/windows.applicationmodel.chat/chatsearchreader_readbatchasync_888788553.md index f6dd70d941..2fd126798d 100644 --- a/windows.applicationmodel.chat/chatsearchreader_readbatchasync_888788553.md +++ b/windows.applicationmodel.chat/chatsearchreader_readbatchasync_888788553.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync ## -description Returns a batch of found items matching the search criteria. ## -returns A list of items matching the search criteria. ## -remarks ## -examples ## -see-also [ReadBatchAsync(Int32)](chatsearchreader_readbatchasync_1346490639.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSearchReader.ReadBatchAsync + +## -description +Returns a batch of found items matching the search criteria. + +## -returns +A list of items matching the search criteria. + +## -remarks + +## -examples + +## -see-also +[ReadBatchAsync(Int32)](chatsearchreader_readbatchasync_1346490639.md) \ No newline at end of file diff --git a/windows.applicationmodel.chat/chatsyncconfiguration.md b/windows.applicationmodel.chat/chatsyncconfiguration.md index 7d64e37a44..0b3294311c 100644 --- a/windows.applicationmodel.chat/chatsyncconfiguration.md +++ b/windows.applicationmodel.chat/chatsyncconfiguration.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatSyncConfiguration --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatSyncConfiguration ## -description The chat messages sync configurations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatSyncConfiguration +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncConfiguration + +## -description +The chat messages sync configurations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncconfiguration_issyncenabled.md b/windows.applicationmodel.chat/chatsyncconfiguration_issyncenabled.md index a1f20b289d..f9fa3eb78f 100644 --- a/windows.applicationmodel.chat/chatsyncconfiguration_issyncenabled.md +++ b/windows.applicationmodel.chat/chatsyncconfiguration_issyncenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatSyncConfiguration.IsSyncEnabled --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatSyncConfiguration.IsSyncEnabled ## -description Gets or sets a boolean that indicates whether sync is enabled. ## -property-value The boolean that indicates whether sync is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatSyncConfiguration.IsSyncEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncConfiguration.IsSyncEnabled + +## -description +Gets or sets a boolean that indicates whether sync is enabled. + +## -property-value +The boolean that indicates whether sync is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncconfiguration_restorehistoryspan.md b/windows.applicationmodel.chat/chatsyncconfiguration_restorehistoryspan.md index f3ed140800..39fb80b945 100644 --- a/windows.applicationmodel.chat/chatsyncconfiguration_restorehistoryspan.md +++ b/windows.applicationmodel.chat/chatsyncconfiguration_restorehistoryspan.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatSyncConfiguration.RestoreHistorySpan --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatSyncConfiguration.RestoreHistorySpan ## -description Gets or sets the time span for which messages will be restored. ## -property-value The time span for which messages will be restored. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatSyncConfiguration.RestoreHistorySpan +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncConfiguration.RestoreHistorySpan + +## -description +Gets or sets the time span for which messages will be restored. + +## -property-value +The time span for which messages will be restored. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager.md b/windows.applicationmodel.chat/chatsyncmanager.md index 3ba57ffde2..4c8d585fc8 100644 --- a/windows.applicationmodel.chat/chatsyncmanager.md +++ b/windows.applicationmodel.chat/chatsyncmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.ChatSyncManager --api-type: winrt class ---- # Windows.ApplicationModel.Chat.ChatSyncManager ## -description Manages the syncing of chat messages. ## -remarks This class is retrieved by calling [RequestSyncManagerAsync](chatmessagemanager_requestsyncmanagerasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.ChatSyncManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager + +## -description +Manages the syncing of chat messages. + +## -remarks +This class is retrieved by calling [RequestSyncManagerAsync](chatmessagemanager_requestsyncmanagerasync.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager_associateaccountasync_556835696.md b/windows.applicationmodel.chat/chatsyncmanager_associateaccountasync_556835696.md index d0e965b95e..e6cd41a7c7 100644 --- a/windows.applicationmodel.chat/chatsyncmanager_associateaccountasync_556835696.md +++ b/windows.applicationmodel.chat/chatsyncmanager_associateaccountasync_556835696.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.AssociateAccountAsync(Windows.Security.Credentials.WebAccount) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSyncManager.AssociateAccountAsync ## -description Sets the [WebAccount](../windows.security.credentials/webaccount.md), which will be used by the sync manager to sync messages. ## -parameters ### -param webAccount The web account. ## -returns An asynchronous action that doesn't return anything. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.AssociateAccountAsync(Windows.Security.Credentials.WebAccount) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager.AssociateAccountAsync + +## -description +Sets the [WebAccount](../windows.security.credentials/webaccount.md), which will be used by the sync manager to sync messages. + +## -parameters +### -param webAccount +The web account. + +## -returns +An asynchronous action that doesn't return anything. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager_configuration.md b/windows.applicationmodel.chat/chatsyncmanager_configuration.md index 73b6bf0909..fa304c90f6 100644 --- a/windows.applicationmodel.chat/chatsyncmanager_configuration.md +++ b/windows.applicationmodel.chat/chatsyncmanager_configuration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.ChatSyncManager.Configuration --api-type: winrt property ---- # Windows.ApplicationModel.Chat.ChatSyncManager.Configuration ## -description The configuration properties of the sync manager. ## -property-value Gets the configuration properties of the sync manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.ChatSyncManager.Configuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager.Configuration + +## -description +The configuration properties of the sync manager. + +## -property-value +Gets the configuration properties of the sync manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager_isaccountassociated_455060545.md b/windows.applicationmodel.chat/chatsyncmanager_isaccountassociated_455060545.md index 58581f6ddf..0cd39dc889 100644 --- a/windows.applicationmodel.chat/chatsyncmanager_isaccountassociated_455060545.md +++ b/windows.applicationmodel.chat/chatsyncmanager_isaccountassociated_455060545.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.IsAccountAssociated(Windows.Security.Credentials.WebAccount) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSyncManager.IsAccountAssociated ## -description Checks if a specific [WebAccount](../windows.security.credentials/webaccount.md) is the account used by the sync manager to sync messages. ## -parameters ### -param webAccount The web account. ## -returns True if the [WebAccount](../windows.security.credentials/webaccount.md) is the account used by the sync manager to sync message, false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.IsAccountAssociated(Windows.Security.Credentials.WebAccount) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager.IsAccountAssociated + +## -description +Checks if a specific [WebAccount](../windows.security.credentials/webaccount.md) is the account used by the sync manager to sync messages. + +## -parameters +### -param webAccount +The web account. + +## -returns +True if the [WebAccount](../windows.security.credentials/webaccount.md) is the account used by the sync manager to sync message, false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager_setconfigurationasync_891998558.md b/windows.applicationmodel.chat/chatsyncmanager_setconfigurationasync_891998558.md index 0f737e906d..372cc7d794 100644 --- a/windows.applicationmodel.chat/chatsyncmanager_setconfigurationasync_891998558.md +++ b/windows.applicationmodel.chat/chatsyncmanager_setconfigurationasync_891998558.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.SetConfigurationAsync(Windows.ApplicationModel.Chat.ChatSyncConfiguration) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSyncManager.SetConfigurationAsync ## -description Sets the configuration properties of the sync manager. ## -parameters ### -param configuration The configuration. ## -returns An asynchronous action that doesn't return anything. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.SetConfigurationAsync(Windows.ApplicationModel.Chat.ChatSyncConfiguration) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager.SetConfigurationAsync + +## -description +Sets the configuration properties of the sync manager. + +## -parameters +### -param configuration +The configuration. + +## -returns +An asynchronous action that doesn't return anything. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager_startsync_1861085560.md b/windows.applicationmodel.chat/chatsyncmanager_startsync_1861085560.md index 1b66922f0e..19d1c2a635 100644 --- a/windows.applicationmodel.chat/chatsyncmanager_startsync_1861085560.md +++ b/windows.applicationmodel.chat/chatsyncmanager_startsync_1861085560.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.StartSync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSyncManager.StartSync ## -description Starts a new sync operation without waiting for the sync to finish. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.StartSync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager.StartSync + +## -description +Starts a new sync operation without waiting for the sync to finish. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/chatsyncmanager_unassociateaccountasync_926886162.md b/windows.applicationmodel.chat/chatsyncmanager_unassociateaccountasync_926886162.md index 67617ce4b9..4590fbef95 100644 --- a/windows.applicationmodel.chat/chatsyncmanager_unassociateaccountasync_926886162.md +++ b/windows.applicationmodel.chat/chatsyncmanager_unassociateaccountasync_926886162.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.UnassociateAccountAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.ChatSyncManager.UnassociateAccountAsync ## -description Clears the account information and stops the sync manager from syncing messages. This will trigger a message deletion operation. ## -returns An asynchronous action that doesn't return anything. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.ChatSyncManager.UnassociateAccountAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.ChatSyncManager.UnassociateAccountAsync + +## -description +Clears the account information and stops the sync manager from syncing messages. This will trigger a message deletion operation. + +## -returns +An asynchronous action that doesn't return anything. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/ichatitem_itemkind.md b/windows.applicationmodel.chat/ichatitem_itemkind.md index 4cc0d2def2..ef15118117 100644 --- a/windows.applicationmodel.chat/ichatitem_itemkind.md +++ b/windows.applicationmodel.chat/ichatitem_itemkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.IChatItem.ItemKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.IChatItem.ItemKind ## -description Gets the type of the chat item, such as message or conversation. ## -property-value The type of the chat item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.IChatItem.ItemKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.IChatItem.ItemKind + +## -description +Gets the type of the chat item, such as message or conversation. + +## -property-value +The type of the chat item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage.md b/windows.applicationmodel.chat/rcsendusermessage.md index 9c0c5f75a2..4bb0b72604 100644 --- a/windows.applicationmodel.chat/rcsendusermessage.md +++ b/windows.applicationmodel.chat/rcsendusermessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessage --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage ## -description Represents a Rich Communication Services (RCS) end user message. ## -remarks Call [RcsEndUserMessageAvailableEventArgs.Message](rcsendusermessageavailableeventargs_message.md) to instantiate this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessage +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage + +## -description +Represents a Rich Communication Services (RCS) end user message. + +## -remarks +Call [RcsEndUserMessageAvailableEventArgs.Message](rcsendusermessageavailableeventargs_message.md) to instantiate this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_actions.md b/windows.applicationmodel.chat/rcsendusermessage_actions.md index 1d07d9b2d9..4a0404ace7 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_actions.md +++ b/windows.applicationmodel.chat/rcsendusermessage_actions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.Actions --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.Actions ## -description Gets the actions to which the user can respond. ## -property-value The actions to which the user can respond. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.Actions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.Actions + +## -description +Gets the actions to which the user can respond. + +## -property-value +The actions to which the user can respond. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_ispinrequired.md b/windows.applicationmodel.chat/rcsendusermessage_ispinrequired.md index e72b28bb57..cbd0c2abbd 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_ispinrequired.md +++ b/windows.applicationmodel.chat/rcsendusermessage_ispinrequired.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.IsPinRequired --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.IsPinRequired ## -description Gets a Boolean value that specifies whether a PIN is required to be sent back with the response. ## -property-value A Boolean value that specifies whether a PIN is required to be sent back with the response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.IsPinRequired +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.IsPinRequired + +## -description +Gets a Boolean value that specifies whether a PIN is required to be sent back with the response. + +## -property-value +A Boolean value that specifies whether a PIN is required to be sent back with the response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_sendresponseasync_913801158.md b/windows.applicationmodel.chat/rcsendusermessage_sendresponseasync_913801158.md index 77223b4362..4ddc138bcb 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_sendresponseasync_913801158.md +++ b/windows.applicationmodel.chat/rcsendusermessage_sendresponseasync_913801158.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseAsync(Windows.ApplicationModel.Chat.RcsEndUserMessageAction) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseAsync ## -description Asynchronously sends the user's selection back. ## -parameters ### -param action Specifies the label of the action. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseAsync(Windows.ApplicationModel.Chat.RcsEndUserMessageAction) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseAsync + +## -description +Asynchronously sends the user's selection back. + +## -parameters +### -param action +Specifies the label of the action. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_sendresponsewithpinasync_1088845936.md b/windows.applicationmodel.chat/rcsendusermessage_sendresponsewithpinasync_1088845936.md index 00627700eb..f0da56c64c 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_sendresponsewithpinasync_1088845936.md +++ b/windows.applicationmodel.chat/rcsendusermessage_sendresponsewithpinasync_1088845936.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseWithPinAsync(Windows.ApplicationModel.Chat.RcsEndUserMessageAction,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseWithPinAsync ## -description Asynchronously sends the user's selection back with the specified PIN. ## -parameters ### -param action Specifies the label of the action. ### -param pin The PIN to send. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseWithPinAsync(Windows.ApplicationModel.Chat.RcsEndUserMessageAction,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.SendResponseWithPinAsync + +## -description +Asynchronously sends the user's selection back with the specified PIN. + +## -parameters +### -param action +Specifies the label of the action. + +### -param pin +The PIN to send. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_text.md b/windows.applicationmodel.chat/rcsendusermessage_text.md index 4ce71a5636..040e797604 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_text.md +++ b/windows.applicationmodel.chat/rcsendusermessage_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.Text --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.Text ## -description Gets the contents of the message. ## -property-value The contents of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.Text + +## -description +Gets the contents of the message. + +## -property-value +The contents of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_title.md b/windows.applicationmodel.chat/rcsendusermessage_title.md index fd9614c9ec..918a6f70a3 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_title.md +++ b/windows.applicationmodel.chat/rcsendusermessage_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.Title --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.Title ## -description Gets the title of the message. ## -property-value The title of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.Title + +## -description +Gets the title of the message. + +## -property-value +The title of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessage_transportid.md b/windows.applicationmodel.chat/rcsendusermessage_transportid.md index 9d879f0622..0644fc75f9 100644 --- a/windows.applicationmodel.chat/rcsendusermessage_transportid.md +++ b/windows.applicationmodel.chat/rcsendusermessage_transportid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.TransportId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessage.TransportId ## -description Gets the ID of the transport where this message originated. ## -property-value The ID of the transport where this message originated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessage.TransportId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessage.TransportId + +## -description +Gets the ID of the transport where this message originated. + +## -property-value +The ID of the transport where this message originated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageaction.md b/windows.applicationmodel.chat/rcsendusermessageaction.md index eadf297386..bdf84e3a6d 100644 --- a/windows.applicationmodel.chat/rcsendusermessageaction.md +++ b/windows.applicationmodel.chat/rcsendusermessageaction.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageAction --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAction ## -description Represents the actions to which the user can respond. ## -remarks Call [RcsEndUserMessage.Actions](rcsendusermessage_actions.md) to instantiate this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageAction +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAction + +## -description +Represents the actions to which the user can respond. + +## -remarks +Call [RcsEndUserMessage.Actions](rcsendusermessage_actions.md) to instantiate this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageaction_label.md b/windows.applicationmodel.chat/rcsendusermessageaction_label.md index 0d4e634f18..de83635caa 100644 --- a/windows.applicationmodel.chat/rcsendusermessageaction_label.md +++ b/windows.applicationmodel.chat/rcsendusermessageaction_label.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAction.Label --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAction.Label ## -description Gets the label of the action. ## -property-value The label of the action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAction.Label +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAction.Label + +## -description +Gets the label of the action. + +## -property-value +The label of the action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageavailableeventargs.md b/windows.applicationmodel.chat/rcsendusermessageavailableeventargs.md index b985159002..e02b5a5a1e 100644 --- a/windows.applicationmodel.chat/rcsendusermessageavailableeventargs.md +++ b/windows.applicationmodel.chat/rcsendusermessageavailableeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs ## -description Provides the data for a [MessageAvailableChanged](rcsendusermessagemanager_messageavailablechanged.md) event. ## -remarks The system creates an instance of this class and passes it as an argument to the [MessageAvailableChanged](rcsendusermessagemanager_messageavailablechanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs + +## -description +Provides the data for a [MessageAvailableChanged](rcsendusermessagemanager_messageavailablechanged.md) event. + +## -remarks +The system creates an instance of this class and passes it as an argument to the [MessageAvailableChanged](rcsendusermessagemanager_messageavailablechanged.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_ismessageavailable.md b/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_ismessageavailable.md index 32e4a87986..35260eb7f5 100644 --- a/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_ismessageavailable.md +++ b/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_ismessageavailable.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.IsMessageAvailable --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.IsMessageAvailable ## -description Gets a Boolean value indicating if a new message is available. ## -property-value A Boolean value indicating if a new message is available. ## -remarks There could be more than one message to be displayed. The service controls how many and the order in which to display them. You should block all Rich Communication Services (RCS) functionality while the service is displaying these messages, until a notification with this flag set to FALSE arrives. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.IsMessageAvailable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.IsMessageAvailable + +## -description +Gets a Boolean value indicating if a new message is available. + +## -property-value +A Boolean value indicating if a new message is available. + +## -remarks +There could be more than one message to be displayed. The service controls how many and the order in which to display them. You should block all Rich Communication Services (RCS) functionality while the service is displaying these messages, until a notification with this flag set to FALSE arrives. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_message.md b/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_message.md index 0b0ad91870..f696f60e90 100644 --- a/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_message.md +++ b/windows.applicationmodel.chat/rcsendusermessageavailableeventargs_message.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.Message --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.Message ## -description Gets the actual message to display, or empty if [IsMessageAvailable](rcsendusermessageavailableeventargs_ismessageavailable.md) is FALSE. ## -property-value The actual message to display. ## -remarks If[IsMessageAvailable](rcsendusermessageavailableeventargs_ismessageavailable.md) is **True**, then this will contain the message to display. If [IsMessageAvailable](rcsendusermessageavailableeventargs_ismessageavailable.md) is **False**, then this will be an empty string. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableEventArgs.Message + +## -description +Gets the actual message to display, or empty if [IsMessageAvailable](rcsendusermessageavailableeventargs_ismessageavailable.md) is FALSE. + +## -property-value +The actual message to display. + +## -remarks +If[IsMessageAvailable](rcsendusermessageavailableeventargs_ismessageavailable.md) is **True**, then this will contain the message to display. If [IsMessageAvailable](rcsendusermessageavailableeventargs_ismessageavailable.md) is **False**, then this will be an empty string. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails.md b/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails.md index 99a840624a..d53166ef77 100644 --- a/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails.md +++ b/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails ## -description Provides data to the background task about a new message. ## -remarks An instance of this class is created by the system. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails + +## -description +Provides data to the background task about a new message. + +## -remarks +An instance of this class is created by the system. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_text.md b/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_text.md index ef1fdc9d7e..72f579c7c1 100644 --- a/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_text.md +++ b/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Text --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Text ## -description Gets the text of the new message. ## -property-value The text of the new message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Text + +## -description +Gets the text of the new message. + +## -property-value +The text of the new message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_title.md b/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_title.md index 561743b709..7b41e3ac96 100644 --- a/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_title.md +++ b/windows.applicationmodel.chat/rcsendusermessageavailabletriggerdetails_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Title --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Title ## -description Gets the title of the new message. ## -property-value The title of the new message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageAvailableTriggerDetails.Title + +## -description +Gets the title of the new message. + +## -property-value +The title of the new message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessagemanager.md b/windows.applicationmodel.chat/rcsendusermessagemanager.md index a7557de932..c6389a682d 100644 --- a/windows.applicationmodel.chat/rcsendusermessagemanager.md +++ b/windows.applicationmodel.chat/rcsendusermessagemanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageManager --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageManager ## -description Provides functionality for handling message events. ## -remarks Call the [RcsManager.GetEndUserMessageManager](rcsmanager_getendusermessagemanager.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsEndUserMessageManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageManager + +## -description +Provides functionality for handling message events. + +## -remarks +Call the [RcsManager.GetEndUserMessageManager](rcsmanager_getendusermessagemanager.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsendusermessagemanager_messageavailablechanged.md b/windows.applicationmodel.chat/rcsendusermessagemanager_messageavailablechanged.md index dec35fab4e..f04ea2192c 100644 --- a/windows.applicationmodel.chat/rcsendusermessagemanager_messageavailablechanged.md +++ b/windows.applicationmodel.chat/rcsendusermessagemanager_messageavailablechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Chat.RcsEndUserMessageManager.MessageAvailableChanged --api-type: winrt event ---- # Windows.ApplicationModel.Chat.RcsEndUserMessageManager.MessageAvailableChanged ## -description Occurs when a new message is available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Chat.RcsEndUserMessageManager.MessageAvailableChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Chat.RcsEndUserMessageManager.MessageAvailableChanged + +## -description +Occurs when a new message is available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsmanager.md b/windows.applicationmodel.chat/rcsmanager.md index 3bd2cdb60c..e6de5ecc4e 100644 --- a/windows.applicationmodel.chat/rcsmanager.md +++ b/windows.applicationmodel.chat/rcsmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsManager --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsManager ## -description Provides access to APIs for handling Rich Communication Services (RCS) messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsManager + +## -description +Provides access to APIs for handling Rich Communication Services (RCS) messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsmanager_getendusermessagemanager_1380387568.md b/windows.applicationmodel.chat/rcsmanager_getendusermessagemanager_1380387568.md index fc1761415d..013fe9cf69 100644 --- a/windows.applicationmodel.chat/rcsmanager_getendusermessagemanager_1380387568.md +++ b/windows.applicationmodel.chat/rcsmanager_getendusermessagemanager_1380387568.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsManager.GetEndUserMessageManager --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsManager.GetEndUserMessageManager ## -description Gets the [RcsEndUserMessageManager](rcsendusermessagemanager.md). ## -returns The end user message manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsManager.GetEndUserMessageManager +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsManager.GetEndUserMessageManager + +## -description +Gets the [RcsEndUserMessageManager](rcsendusermessagemanager.md). + +## -returns +The end user message manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsmanager_gettransportasync_455003223.md b/windows.applicationmodel.chat/rcsmanager_gettransportasync_455003223.md index e04623826e..135053eabc 100644 --- a/windows.applicationmodel.chat/rcsmanager_gettransportasync_455003223.md +++ b/windows.applicationmodel.chat/rcsmanager_gettransportasync_455003223.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsManager.GetTransportAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsManager.GetTransportAsync ## -description Gets an instance of [RcsTransport](rcstransport.md) for the specified transport ID. ## -parameters ### -param transportId The ID of the transport to retrieve. ## -returns An instance of the transport specified by the *transportId* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsManager.GetTransportAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsManager.GetTransportAsync + +## -description +Gets an instance of [RcsTransport](rcstransport.md) for the specified transport ID. + +## -parameters +### -param transportId +The ID of the transport to retrieve. + +## -returns +An instance of the transport specified by the *transportId* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsmanager_gettransportsasync_998895362.md b/windows.applicationmodel.chat/rcsmanager_gettransportsasync_998895362.md index 09cd56e5c5..c40ccdb620 100644 --- a/windows.applicationmodel.chat/rcsmanager_gettransportsasync_998895362.md +++ b/windows.applicationmodel.chat/rcsmanager_gettransportsasync_998895362.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsManager.GetTransportsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsManager.GetTransportsAsync ## -description Gets all instances of [RcsTransport](rcstransport.md). ## -returns A list of [RcsTransport](rcstransport.md) instances. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsManager.GetTransportsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsManager.GetTransportsAsync + +## -description +Gets all instances of [RcsTransport](rcstransport.md). + +## -returns +A list of [RcsTransport](rcstransport.md) instances. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsmanager_leaveconversationasync_628207572.md b/windows.applicationmodel.chat/rcsmanager_leaveconversationasync_628207572.md index 0537ee3cd0..45e13d479e 100644 --- a/windows.applicationmodel.chat/rcsmanager_leaveconversationasync_628207572.md +++ b/windows.applicationmodel.chat/rcsmanager_leaveconversationasync_628207572.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsManager.LeaveConversationAsync(Windows.ApplicationModel.Chat.ChatConversation) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsManager.LeaveConversationAsync ## -description Asynchronously allows a user to leave a particular conversation. ## -parameters ### -param conversation The conversation to leave. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsManager.LeaveConversationAsync(Windows.ApplicationModel.Chat.ChatConversation) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsManager.LeaveConversationAsync + +## -description +Asynchronously allows a user to leave a particular conversation. + +## -parameters +### -param conversation +The conversation to leave. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs.md b/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs.md index ceb74de535..38cce8e1f7 100644 --- a/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs.md +++ b/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs ## -description Provides data for the [ServiceKindSupportedChanged](rcstransport_servicekindsupportedchanged.md) event. ## -remarks An instance of this class is created by the system and passed as an argument to the [ServiceKindSupportedChanged](rcstransport_servicekindsupportedchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs + +## -description +Provides data for the [ServiceKindSupportedChanged](rcstransport_servicekindsupportedchanged.md) event. + +## -remarks +An instance of this class is created by the system and passed as an argument to the [ServiceKindSupportedChanged](rcstransport_servicekindsupportedchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs_servicekind.md b/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs_servicekind.md index e0575d9d6d..eed6e57a96 100644 --- a/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs_servicekind.md +++ b/windows.applicationmodel.chat/rcsservicekindsupportedchangedeventargs_servicekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs.ServiceKind --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs.ServiceKind ## -description Gets the type of the Rich Communication Services (RCS) service. ## -property-value The type of the Rich Communication Services (RCS) service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs.ServiceKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsServiceKindSupportedChangedEventArgs.ServiceKind + +## -description +Gets the type of the Rich Communication Services (RCS) service. + +## -property-value +The type of the Rich Communication Services (RCS) service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport.md b/windows.applicationmodel.chat/rcstransport.md index d796d597fb..821f92548e 100644 --- a/windows.applicationmodel.chat/rcstransport.md +++ b/windows.applicationmodel.chat/rcstransport.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsTransport --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsTransport ## -description Provides functionality for accessing the Rich Communication Services (RCS) transport. ## -remarks Call [RcsManager.GetTransportAsync](rcsmanager_gettransportasync.md) or [RcsManager.GetTransportsAsync](rcsmanager_gettransportsasync.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsTransport +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport + +## -description +Provides functionality for accessing the Rich Communication Services (RCS) transport. + +## -remarks +Call [RcsManager.GetTransportAsync](rcsmanager_gettransportasync.md) or [RcsManager.GetTransportsAsync](rcsmanager_gettransportsasync.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_configuration.md b/windows.applicationmodel.chat/rcstransport_configuration.md index 6897b42b89..169e95a49a 100644 --- a/windows.applicationmodel.chat/rcstransport_configuration.md +++ b/windows.applicationmodel.chat/rcstransport_configuration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransport.Configuration --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransport.Configuration ## -description Gets a configuration object that describes the transport settings. ## -property-value A configuration object that describes the transport settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransport.Configuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.Configuration + +## -description +Gets a configuration object that describes the transport settings. + +## -property-value +A configuration object that describes the transport settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_extendedproperties.md b/windows.applicationmodel.chat/rcstransport_extendedproperties.md index d25c283ec4..ac37db3d5b 100644 --- a/windows.applicationmodel.chat/rcstransport_extendedproperties.md +++ b/windows.applicationmodel.chat/rcstransport_extendedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransport.ExtendedProperties --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransport.ExtendedProperties ## -description Gets a name-value pair for extensibility of service provider configuration values. ## -property-value A name-value pair for extensibility of service provider configuration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransport.ExtendedProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.ExtendedProperties + +## -description +Gets a name-value pair for extensibility of service provider configuration values. + +## -property-value +A name-value pair for extensibility of service provider configuration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_isactive.md b/windows.applicationmodel.chat/rcstransport_isactive.md index b53e90f88a..7a6bad957b 100644 --- a/windows.applicationmodel.chat/rcstransport_isactive.md +++ b/windows.applicationmodel.chat/rcstransport_isactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransport.IsActive --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransport.IsActive ## -description Gets a Boolean value indicating if the transport is active. ## -property-value A Boolean value indicating if the transport is active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransport.IsActive +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.IsActive + +## -description +Gets a Boolean value indicating if the transport is active. + +## -property-value +A Boolean value indicating if the transport is active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_isservicekindsupported_393358476.md b/windows.applicationmodel.chat/rcstransport_isservicekindsupported_393358476.md index 4b95822cb7..467a40caa1 100644 --- a/windows.applicationmodel.chat/rcstransport_isservicekindsupported_393358476.md +++ b/windows.applicationmodel.chat/rcstransport_isservicekindsupported_393358476.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsTransport.IsServiceKindSupported(Windows.ApplicationModel.Chat.RcsServiceKind) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsTransport.IsServiceKindSupported ## -description Gets a Boolean value indicating if the specified service kind is supported, such as chat, group chat, file transfer, and so on. ## -parameters ### -param serviceKind The service kind to verify. ## -returns TRUE if the [RcsServiceKind](rcsservicekind.md) specified in the *serviceKind* parameter is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsTransport.IsServiceKindSupported(Windows.ApplicationModel.Chat.RcsServiceKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.IsServiceKindSupported + +## -description +Gets a Boolean value indicating if the specified service kind is supported, such as chat, group chat, file transfer, and so on. + +## -parameters +### -param serviceKind +The service kind to verify. + +## -returns +TRUE if the [RcsServiceKind](rcsservicekind.md) specified in the *serviceKind* parameter is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_isstoreandforwardenabled_455689638.md b/windows.applicationmodel.chat/rcstransport_isstoreandforwardenabled_455689638.md index 54b4faeafe..b4a3daf897 100644 --- a/windows.applicationmodel.chat/rcstransport_isstoreandforwardenabled_455689638.md +++ b/windows.applicationmodel.chat/rcstransport_isstoreandforwardenabled_455689638.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Chat.RcsTransport.IsStoreAndForwardEnabled(Windows.ApplicationModel.Chat.RcsServiceKind) --api-type: winrt method ---- # Windows.ApplicationModel.Chat.RcsTransport.IsStoreAndForwardEnabled ## -description Gets a Boolean value indicating if the specified service kind supports store and forward functionality. ## -parameters ### -param serviceKind The service kind to check for store and forward functionality. ## -returns A Boolean value indicating if the *serviceKind * supports store and forward. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Chat.RcsTransport.IsStoreAndForwardEnabled(Windows.ApplicationModel.Chat.RcsServiceKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.IsStoreAndForwardEnabled + +## -description +Gets a Boolean value indicating if the specified service kind supports store and forward functionality. + +## -parameters +### -param serviceKind +The service kind to check for store and forward functionality. + +## -returns +A Boolean value indicating if the *serviceKind * supports store and forward. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_servicekindsupportedchanged.md b/windows.applicationmodel.chat/rcstransport_servicekindsupportedchanged.md index 3f0ed563a2..0db9c8971c 100644 --- a/windows.applicationmodel.chat/rcstransport_servicekindsupportedchanged.md +++ b/windows.applicationmodel.chat/rcstransport_servicekindsupportedchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Chat.RcsTransport.ServiceKindSupportedChanged --api-type: winrt event ---- # Windows.ApplicationModel.Chat.RcsTransport.ServiceKindSupportedChanged ## -description Occurs when the service capabilities change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Chat.RcsTransport.ServiceKindSupportedChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.ServiceKindSupportedChanged + +## -description +Occurs when the service capabilities change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_transportfriendlyname.md b/windows.applicationmodel.chat/rcstransport_transportfriendlyname.md index 3257ba2ed0..0d98c4d455 100644 --- a/windows.applicationmodel.chat/rcstransport_transportfriendlyname.md +++ b/windows.applicationmodel.chat/rcstransport_transportfriendlyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransport.TransportFriendlyName --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransport.TransportFriendlyName ## -description Gets the friendly name of the transport. ## -property-value The friendly name of the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransport.TransportFriendlyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.TransportFriendlyName + +## -description +Gets the friendly name of the transport. + +## -property-value +The friendly name of the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransport_transportid.md b/windows.applicationmodel.chat/rcstransport_transportid.md index 6bb60f05c1..c03e8c94cc 100644 --- a/windows.applicationmodel.chat/rcstransport_transportid.md +++ b/windows.applicationmodel.chat/rcstransport_transportid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransport.TransportId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransport.TransportId ## -description Gets the ID for the transport that is unique on the device. ## -property-value The ID for the transport that is unique on the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransport.TransportId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransport.TransportId + +## -description +Gets the ID for the transport that is unique on the device. + +## -property-value +The ID for the transport that is unique on the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration.md b/windows.applicationmodel.chat/rcstransportconfiguration.md index bb10a12a6a..1f49c50daf 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RcsTransportConfiguration --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration ## -description Provides data about the configuration of a Rich Communication Services (RCS) transport. ## -remarks The [Configuration](rcstransport_configuration.md) property of the [RcsTransport](rcstransport.md) class references an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RcsTransportConfiguration +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration + +## -description +Provides data about the configuration of a Rich Communication Services (RCS) transport. + +## -remarks +The [Configuration](rcstransport_configuration.md) property of the [RcsTransport](rcstransport.md) class references an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration_maxattachmentcount.md b/windows.applicationmodel.chat/rcstransportconfiguration_maxattachmentcount.md index 77dca4a138..66bd7d4299 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration_maxattachmentcount.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration_maxattachmentcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxAttachmentCount --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxAttachmentCount ## -description Gets the maximum number of attachments supported by the transport. ## -property-value The maximum number of attachments supported by the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxAttachmentCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxAttachmentCount + +## -description +Gets the maximum number of attachments supported by the transport. + +## -property-value +The maximum number of attachments supported by the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration_maxfilesizeinkilobytes.md b/windows.applicationmodel.chat/rcstransportconfiguration_maxfilesizeinkilobytes.md index a736ec7c3b..12ab2996fe 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration_maxfilesizeinkilobytes.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration_maxfilesizeinkilobytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxFileSizeInKilobytes --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxFileSizeInKilobytes ## -description Gets the maximum size of a file that can be sent using the transport. ## -property-value The maximum size of a file that can be sent using the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxFileSizeInKilobytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxFileSizeInKilobytes + +## -description +Gets the maximum size of a file that can be sent using the transport. + +## -property-value +The maximum size of a file that can be sent using the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration_maxgroupmessagesizeinkilobytes.md b/windows.applicationmodel.chat/rcstransportconfiguration_maxgroupmessagesizeinkilobytes.md index bbb84741ce..e6617320e0 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration_maxgroupmessagesizeinkilobytes.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration_maxgroupmessagesizeinkilobytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxGroupMessageSizeInKilobytes --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxGroupMessageSizeInKilobytes ## -description Gets the maximum size of a group chat message supported by the transport. ## -property-value The maximum size of a group chat message supported by the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxGroupMessageSizeInKilobytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxGroupMessageSizeInKilobytes + +## -description +Gets the maximum size of a group chat message supported by the transport. + +## -property-value +The maximum size of a group chat message supported by the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration_maxmessagesizeinkilobytes.md b/windows.applicationmodel.chat/rcstransportconfiguration_maxmessagesizeinkilobytes.md index 16fe8d7356..f4d2c45ea7 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration_maxmessagesizeinkilobytes.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration_maxmessagesizeinkilobytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxMessageSizeInKilobytes --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxMessageSizeInKilobytes ## -description Gets the maximum size of a chat message supported by the transport. ## -property-value The maximum size of a chat message supported by the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxMessageSizeInKilobytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxMessageSizeInKilobytes + +## -description +Gets the maximum size of a chat message supported by the transport. + +## -property-value +The maximum size of a chat message supported by the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration_maxrecipientcount.md b/windows.applicationmodel.chat/rcstransportconfiguration_maxrecipientcount.md index 756d9c218e..c03583b950 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration_maxrecipientcount.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration_maxrecipientcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxRecipientCount --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxRecipientCount ## -description Gets the maximum number of recipients supported for a group chat. ## -property-value The maximum number of recipients supported for a group chat. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxRecipientCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration.MaxRecipientCount + +## -description +Gets the maximum number of recipients supported for a group chat. + +## -property-value +The maximum number of recipients supported for a group chat. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/rcstransportconfiguration_warningfilesizeinkilobytes.md b/windows.applicationmodel.chat/rcstransportconfiguration_warningfilesizeinkilobytes.md index 40e201bd5a..0ca656c473 100644 --- a/windows.applicationmodel.chat/rcstransportconfiguration_warningfilesizeinkilobytes.md +++ b/windows.applicationmodel.chat/rcstransportconfiguration_warningfilesizeinkilobytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.WarningFileSizeInKilobytes --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RcsTransportConfiguration.WarningFileSizeInKilobytes ## -description Gets the size at which the user should be warned that they are attaching a large file for the transport. ## -property-value The size at which the user should be warned that they are attaching a large file for the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RcsTransportConfiguration.WarningFileSizeInKilobytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RcsTransportConfiguration.WarningFileSizeInKilobytes + +## -description +Gets the size at which the user should be warned that they are attaching a large file for the transport. + +## -property-value +The size at which the user should be warned that they are attaching a large file for the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs.md b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs.md index 4caed65757..4dd8c2e625 100644 --- a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs.md +++ b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs ## -description Provides data to the [RemoteParticipantComposingChanged](chatconversation_remoteparticipantcomposingchanged.md) event. ## -remarks An instance of this class is created by the system and passed as an argument to the [RemoteParticipantComposingChanged](chatconversation_remoteparticipantcomposingchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs + +## -description +Provides data to the [RemoteParticipantComposingChanged](chatconversation_remoteparticipantcomposingchanged.md) event. + +## -remarks +An instance of this class is created by the system and passed as an argument to the [RemoteParticipantComposingChanged](chatconversation_remoteparticipantcomposingchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_iscomposing.md b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_iscomposing.md index 46f2c7378b..8c97621f0b 100644 --- a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_iscomposing.md +++ b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_iscomposing.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.IsComposing --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.IsComposing ## -description Gets a Boolean value indicating if the remote participant is currently composing a message. ## -property-value A Boolean value indicating if the remote participant is currently composing a message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.IsComposing +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.IsComposing + +## -description +Gets a Boolean value indicating if the remote participant is currently composing a message. + +## -property-value +A Boolean value indicating if the remote participant is currently composing a message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_participantaddress.md b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_participantaddress.md index 6d97597ce3..876906a79b 100644 --- a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_participantaddress.md +++ b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_participantaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.ParticipantAddress --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.ParticipantAddress ## -description Gets the address of the remote chat participant. ## -property-value The address of the remote chat participant. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.ParticipantAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.ParticipantAddress + +## -description +Gets the address of the remote chat participant. + +## -property-value +The address of the remote chat participant. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_transportid.md b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_transportid.md index e9371a7e06..83beff7787 100644 --- a/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_transportid.md +++ b/windows.applicationmodel.chat/remoteparticipantcomposingchangedeventargs_transportid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.TransportId --api-type: winrt property ---- # Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.TransportId ## -description Gets the ID for the message transport. ## -property-value The ID for the transport. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.TransportId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Chat.RemoteParticipantComposingChangedEventArgs.TransportId + +## -description +Gets the ID for the message transport. + +## -property-value +The ID for the transport. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager.md index 4d50d3b041..243361e121 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager --api-type: winrt class ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager ## -description The manager responsible for keeping track of blocked numbers and displaying the appropriate blocking user interfaces. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager + +## -description +The manager responsible for keeping track of blocked numbers and displaying the appropriate blocking user interfaces. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockednumberasync_235938679.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockednumberasync_235938679.md index 0d366fb72b..a4d8566af2 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockednumberasync_235938679.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockednumberasync_235938679.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockedNumberAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockedNumberAsync ## -description An asynchronous operation that returns whether or not a number is on the block list. ## -parameters ### -param number The number to check. ## -returns Asynchronously returns whether or not the number is blocked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockedNumberAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockedNumberAsync + +## -description +An asynchronous operation that returns whether or not a number is on the block list. + +## -parameters +### -param number +The number to check. + +## -returns +Asynchronously returns whether or not the number is blocked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockingactive.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockingactive.md index 6fbd34dc02..3cb423ade4 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockingactive.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_isblockingactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockingActive --api-type: winrt property ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockingActive ## -description Gets whether or not blocking is currently enabled. ## -property-value Determines if blocking is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockingActive +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.IsBlockingActive + +## -description +Gets whether or not blocking is currently enabled. + +## -property-value +Determines if blocking is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedcallsui_2114856335.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedcallsui_2114856335.md index ba0e2cb941..2d66c2052f 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedcallsui_2114856335.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedcallsui_2114856335.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedCallsUI --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedCallsUI ## -description Displays the list of blocked calls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedCallsUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedCallsUI + +## -description +Displays the list of blocked calls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedmessagesui_1863625846.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedmessagesui_1863625846.md index ca07f5d82c..d1a2b873a0 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedmessagesui_1863625846.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblockedmessagesui_1863625846.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedMessagesUI --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedMessagesUI ## -description Displays the list of blocked messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedMessagesUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockedMessagesUI + +## -description +Displays the list of blocked messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblocknumbersui_1417531973.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblocknumbersui_1417531973.md index 3f74a2ec65..2340f218d3 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblocknumbersui_1417531973.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showblocknumbersui_1417531973.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockNumbersUI(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockNumbersUI ## -description Launches a UI to block numbers if there as an active blocking app. ## -parameters ### -param phoneNumbers The list of numbers to add to the block list. ## -returns Returns **true** if the active blocking app is launched, otherwise returns **false**. ## -remarks This method creates and displays a user interface to enable the user to block the provided *phoneNumbers*. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockNumbersUI(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowBlockNumbersUI + +## -description +Launches a UI to block numbers if there as an active blocking app. + +## -parameters +### -param phoneNumbers +The list of numbers to add to the block list. + +## -returns +Returns **true** if the active blocking app is launched, otherwise returns **false**. + +## -remarks +This method creates and displays a user interface to enable the user to block the provided *phoneNumbers*. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showunblocknumbersui_889951624.md b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showunblocknumbersui_889951624.md index d68caa5c73..7e44cc3bf6 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showunblocknumbersui_889951624.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingaccessmanager_showunblocknumbersui_889951624.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowUnblockNumbersUI(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowUnblockNumbersUI ## -description Launches the app to unblock numbers if there as an active blocking app. ## -parameters ### -param phoneNumbers The list of numbers to remove from the block list. ## -returns Returns **true** if the active blocking app is launched, otherwise returns **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowUnblockNumbersUI(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAccessManager.ShowUnblockNumbersUI + +## -description +Launches the app to unblock numbers if there as an active blocking app. + +## -parameters +### -param phoneNumbers +The list of numbers to remove from the block list. + +## -returns +Returns **true** if the active blocking app is launched, otherwise returns **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingappmanager.md b/windows.applicationmodel.communicationblocking/communicationblockingappmanager.md index c800ab44aa..7d0e402ce6 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingappmanager.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingappmanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager --api-type: winrt class ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager ## -description Determines the application to use as a blocking application. ## -remarks A user can install multiple applications that are capable of filtering messages and calls. However, only one of these blocking applications can be active at a time. This class is used to determine the active blocking application. When an application is selected to be the active call blocking app, it will be notified by [CommunicationBlockingAppSetAsActiveTrigger](../windows.applicationmodel.background/communicationblockingappsetasactivetrigger.md) ## -examples ## -see-also [Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager + +## -description +Determines the application to use as a blocking application. + +## -remarks +A user can install multiple applications that are capable of filtering messages and calls. However, only one of these blocking applications can be active at a time. This class is used to determine the active blocking application. + +When an application is selected to be the active call blocking app, it will be notified by [CommunicationBlockingAppSetAsActiveTrigger](../windows.applicationmodel.background/communicationblockingappsetasactivetrigger.md) + +## -examples + +## -see-also +[Communication blocking and filtering sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624164) \ No newline at end of file diff --git a/windows.applicationmodel.communicationblocking/communicationblockingappmanager_iscurrentappactiveblockingapp.md b/windows.applicationmodel.communicationblocking/communicationblockingappmanager_iscurrentappactiveblockingapp.md index 23781fa70f..7a344e74dd 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingappmanager_iscurrentappactiveblockingapp.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingappmanager_iscurrentappactiveblockingapp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.IsCurrentAppActiveBlockingApp --api-type: winrt property ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.IsCurrentAppActiveBlockingApp ## -description Indicates whether the current application is the active blocking application. ## -property-value Value that tells whether the current application is the active blocking app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.IsCurrentAppActiveBlockingApp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.IsCurrentAppActiveBlockingApp + +## -description +Indicates whether the current application is the active blocking application. + +## -property-value +Value that tells whether the current application is the active blocking app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingappmanager_requestsetasactiveblockingappasync_1223905556.md b/windows.applicationmodel.communicationblocking/communicationblockingappmanager_requestsetasactiveblockingappasync_1223905556.md index 6546a7a304..7d100cbfc6 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingappmanager_requestsetasactiveblockingappasync_1223905556.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingappmanager_requestsetasactiveblockingappasync_1223905556.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.RequestSetAsActiveBlockingAppAsync --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.RequestSetAsActiveBlockingAppAsync ## -description Calls a dialog to set the current app as the default phone communication blocking application. ## -returns Indicates whether the app was set as the default phone origin application. ## -remarks In order to use this API, your application needs to be registered as a communication blocking provider. If the application is not appropriately registered, this API will throw an exception. See [Windows.ApplicationModel.CommunicationBlocking](windows_applicationmodel_communicationblocking.md) for more information about how to register as a phone call origin provider. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.RequestSetAsActiveBlockingAppAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.RequestSetAsActiveBlockingAppAsync + +## -description +Calls a dialog to set the current app as the default phone communication blocking application. + +## -returns +Indicates whether the app was set as the default phone origin application. + +## -remarks +In order to use this API, your application needs to be registered as a communication blocking provider. If the application is not appropriately registered, this API will throw an exception. See [Windows.ApplicationModel.CommunicationBlocking](windows_applicationmodel_communicationblocking.md) for more information about how to register as a phone call origin provider. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.communicationblocking/communicationblockingappmanager_showcommunicationblockingsettingsui_684721843.md b/windows.applicationmodel.communicationblocking/communicationblockingappmanager_showcommunicationblockingsettingsui_684721843.md index 9f8f64ec97..f07f2b75dc 100644 --- a/windows.applicationmodel.communicationblocking/communicationblockingappmanager_showcommunicationblockingsettingsui_684721843.md +++ b/windows.applicationmodel.communicationblocking/communicationblockingappmanager_showcommunicationblockingsettingsui_684721843.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.ShowCommunicationBlockingSettingsUI --api-type: winrt method ---- # Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.ShowCommunicationBlockingSettingsUI ## -description Displays the UI to select the currently active blocking application. ## -remarks Multiple call blocking applications can be installed on a single device. However, only one of these apps can be active at a time. The only way to switch the currently active app is to call [ShowCommunicationBlockingSettingsUI](communicationblockingappmanager_showcommunicationblockingsettingsui.md) and let the user select which app should be active. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.ShowCommunicationBlockingSettingsUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CommunicationBlocking.CommunicationBlockingAppManager.ShowCommunicationBlockingSettingsUI + +## -description +Displays the UI to select the currently active blocking application. + +## -remarks +Multiple call blocking applications can be installed on a single device. However, only one of these apps can be active at a time. The only way to switch the currently active app is to call [ShowCommunicationBlockingSettingsUI](communicationblockingappmanager_showcommunicationblockingsettingsui.md) and let the user select which app should be active. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection.md b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection.md index c50007e7a6..88cc64c514 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection.md +++ b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection ## -description Represents a connection to a data provider client. ## -remarks Use the instance of this class provided by the [Connection](contactdataprovidertriggerdetails_connection.md) property of the [ContactDataProviderTriggerDetails](contactdataprovidertriggerdetails.md) object passed to your background task on activation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection + +## -description +Represents a connection to a data provider client. + +## -remarks +Use the instance of this class provided by the [Connection](contactdataprovidertriggerdetails_connection.md) property of the [ContactDataProviderTriggerDetails](contactdataprovidertriggerdetails.md) object passed to your background task on activation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_serversearchreadbatchrequested.md b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_serversearchreadbatchrequested.md index 9a4da9661c..db5a9cec84 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_serversearchreadbatchrequested.md +++ b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_serversearchreadbatchrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.ServerSearchReadBatchRequested --api-type: winrt event ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.ServerSearchReadBatchRequested ## -description Occurs when the contact data client has requested a batch of server-side search results. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.ServerSearchReadBatchRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.ServerSearchReadBatchRequested + +## -description +Occurs when the contact data client has requested a batch of server-side search results. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_start_1587696324.md b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_start_1587696324.md index 6cae09d70c..8d8d86d8af 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_start_1587696324.md +++ b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.Start --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.Start ## -description Call this method to indicate that all event handlers have been set and the data provider is ready to start handling requests. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.Start +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.Start + +## -description +Call this method to indicate that all event handlers have been set and the data provider is ready to start handling requests. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_syncrequested.md b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_syncrequested.md index 7532589ec5..12148ad482 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_syncrequested.md +++ b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_syncrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.SyncRequested --api-type: winrt event ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.SyncRequested ## -description Occurs when the contact data client has requested to sync a contact list with the server.. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.SyncRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.SyncRequested + +## -description +Occurs when the contact data client has requested to sync a contact list with the server.. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails.md b/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails.md index b6d28f73d8..2cf8d0f20d 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails.md +++ b/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails ## -description Contains details about the event that triggered your contact data provider background task. This event is triggered when a contact data client app has instantiated the background task that runs your contact data provider. Your code should respond to this event by using the Connection property to register event handlers for contact provider request events. ## -remarks Your background task code is passed an instance of this class in the [IBackgroundTaskInstance.TriggerDetails](XREF:TODO:windows.applicationmodel.background.ibackgroundtaskinstance.triggerdetails) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails + +## -description +Contains details about the event that triggered your contact data provider background task. + +This event is triggered when a contact data client app has instantiated the background task that runs your contact data provider. Your code should respond to this event by using the Connection property to register event handlers for contact provider request events. + +## -remarks +Your background task code is passed an instance of this class in the [IBackgroundTaskInstance.TriggerDetails](XREF:TODO:windows.applicationmodel.background.ibackgroundtaskinstance.triggerdetails) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails_connection.md b/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails_connection.md index 47ea2574e9..78d20fe215 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails_connection.md +++ b/windows.applicationmodel.contacts.dataprovider/contactdataprovidertriggerdetails_connection.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails.Connection --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails.Connection ## -description Gets the [ContactDataProviderConnection](contactdataproviderconnection.md) object instance used to provide contact data to a client app. This event is triggered when a contact data client app has instantiated the background task that runs your contact data provider. Your code should respond to this event my using the connection to register event handlers for data provider request events. ## -property-value The [ContactDataProviderConnection](contactdataproviderconnection.md) object your contact data provider uses to communicate with a client app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails.Connection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderTriggerDetails.Connection + +## -description +Gets the [ContactDataProviderConnection](contactdataproviderconnection.md) object instance used to provide contact data to a client app. + +This event is triggered when a contact data client app has instantiated the background task that runs your contact data provider. Your code should respond to this event my using the connection to register event handlers for data provider request events. + +## -property-value +The [ContactDataProviderConnection](contactdataproviderconnection.md) object your contact data provider uses to communicate with a client app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest.md index 51fa1cfd4a..343ee3c8ca 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest ## -description Details of a request to read a batch of server-side search results. ## -remarks Used in your [ServerSearchReadBatchRequested](contactdataproviderconnection_serversearchreadbatchrequested.md) event handler. Use the instance of this class that's returned by the [ContactListServerSearchReadBatchRequestEventArgs.Request](contactlistserversearchreadbatchrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest + +## -description +Details of a request to read a batch of server-side search results. + +## -remarks +Used in your [ServerSearchReadBatchRequested](contactdataproviderconnection_serversearchreadbatchrequested.md) event handler. Use the instance of this class that's returned by the [ContactListServerSearchReadBatchRequestEventArgs.Request](contactlistserversearchreadbatchrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_contactlistid.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_contactlistid.md index f6a0b45db3..e298c99f73 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_contactlistid.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_contactlistid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ContactListId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ContactListId ## -description Gets the contact list ID of the contact list to be searched. ## -property-value A contact list ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ContactListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ContactListId + +## -description +Gets the contact list ID of the contact list to be searched. + +## -property-value +A contact list ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_options.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_options.md index f1827196a8..ae344ed39b 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_options.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_options.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.Options --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.Options ## -description Gets the search options to be applied in this search. ## -property-value A [ContactQueryOptions](../windows.applicationmodel.contacts/contactqueryoptions.md) object specifying search options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.Options +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.Options + +## -description +Gets the search options to be applied in this search. + +## -property-value +A [ContactQueryOptions](../windows.applicationmodel.contacts/contactqueryoptions.md) object specifying search options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportcompletedasync_1707664681.md index 3fa6f6abf0..39d3b08621 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportCompletedAsync ## -description Informs the client app that the request was processed successfully. ## -returns An asynchronous batch read request operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -returns +An asynchronous batch read request operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportfailedasync_610967269.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportfailedasync_610967269.md index c49c07c0d6..50733d79ac 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportfailedasync_610967269.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_reportfailedasync_610967269.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportFailedAsync(Windows.ApplicationModel.Contacts.ContactBatchStatus) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -parameters ### -param batchStatus A [ContactBatchStatus](../windows.applicationmodel.contacts/contactbatchstatus.md) value describing the reason for the failure. ## -returns An asynchronous batch read request operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportFailedAsync(Windows.ApplicationModel.Contacts.ContactBatchStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -parameters +### -param batchStatus +A [ContactBatchStatus](../windows.applicationmodel.contacts/contactbatchstatus.md) value describing the reason for the failure. + +## -returns +An asynchronous batch read request operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_savecontactasync_64942310.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_savecontactasync_64942310.md index 9d7e40a416..c22a8f39d8 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_savecontactasync_64942310.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_savecontactasync_64942310.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SaveContactAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SaveContactAsync ## -description Asynchronously saves a contact that meets server-side search criteria. When a server-side search is requested, the data provider performs the search, calls [SaveContactAsync](contactlistserversearchreadbatchrequest_savecontactasync.md) on each contact found, and then calls [ReportCompletedAsync.](contactlistserversearchreadbatchrequest_reportcompletedasync.md) ## -parameters ### -param contact A [Contact](../windows.applicationmodel.contacts/contact.md) that meets the search criteria. ## -returns An asynchronous contact save operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SaveContactAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SaveContactAsync + +## -description +Asynchronously saves a contact that meets server-side search criteria. + +When a server-side search is requested, the data provider performs the search, calls [SaveContactAsync](contactlistserversearchreadbatchrequest_savecontactasync.md) on each contact found, and then calls [ReportCompletedAsync.](contactlistserversearchreadbatchrequest_reportcompletedasync.md) + +## -parameters +### -param contact +A [Contact](../windows.applicationmodel.contacts/contact.md) that meets the search criteria. + +## -returns +An asynchronous contact save operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_sessionid.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_sessionid.md index 831e0367c0..acdd5a8096 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_sessionid.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_sessionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SessionId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SessionId ## -description Gets the search session ID of this batch read request. ## -property-value A search session ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SessionId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SessionId + +## -description +Gets the search session ID of this batch read request. + +## -property-value +A search session ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_suggestedbatchsize.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_suggestedbatchsize.md index 6d9692c5ed..650a4588d1 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_suggestedbatchsize.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequest_suggestedbatchsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SuggestedBatchSize --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SuggestedBatchSize ## -description Gets the suggested batch size for the server-side search batch read. ## -property-value The suggested number of contacts in a batch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SuggestedBatchSize +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequest.SuggestedBatchSize + +## -description +Gets the suggested batch size for the server-side search batch read. + +## -property-value +The suggested number of contacts in a batch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs.md index db755db065..ba0d7c2d85 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs ## -description Encapsulates information about a request to read a batch of results from a server-side search. ## -remarks Use the instance of this class that's passed as an argument to your [ServerSearchReadBatchRequested](contactdataproviderconnection_serversearchreadbatchrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs + +## -description +Encapsulates information about a request to read a batch of results from a server-side search. + +## -remarks +Use the instance of this class that's passed as an argument to your [ServerSearchReadBatchRequested](contactdataproviderconnection_serversearchreadbatchrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_getdeferral_254836512.md index 6eadab4618..4c53dec0bf 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_request.md b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_request.md index 7791f51df8..c5c3f73c51 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_request.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistserversearchreadbatchrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.Request ## -description Gets the [ContactListServerSearchReadBatchRequest](contactlistserversearchreadbatchrequest.md) object associated with this request. ## -property-value A [ContactListServerSearchReadBatchRequest](contactlistserversearchreadbatchrequest.md) object describing the request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListServerSearchReadBatchRequestEventArgs.Request + +## -description +Gets the [ContactListServerSearchReadBatchRequest](contactlistserversearchreadbatchrequest.md) object associated with this request. + +## -property-value +A [ContactListServerSearchReadBatchRequest](contactlistserversearchreadbatchrequest.md) object describing the request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest.md index 04096011d6..a045eeff3a 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest ## -description Details of a request from a client to sync a contact list. ## -remarks Used in your [SyncRequested](contactdataproviderconnection_syncrequested.md) event handler. Use the instance of this class that's returned by the [ContactListSyncManagerSyncRequestEventArgs.Request](contactlistsyncmanagersyncrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest + +## -description +Details of a request from a client to sync a contact list. + +## -remarks +Used in your [SyncRequested](contactdataproviderconnection_syncrequested.md) event handler. Use the instance of this class that's returned by the [ContactListSyncManagerSyncRequestEventArgs.Request](contactlistsyncmanagersyncrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_contactlistid.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_contactlistid.md index 7afc025aa6..9068cfaa58 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_contactlistid.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_contactlistid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ContactListId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ContactListId ## -description Gets the contact list ID of the contact list to be synched. ## -property-value A contact list ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ContactListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ContactListId + +## -description +Gets the contact list ID of the contact list to be synched. + +## -property-value +A contact list ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportcompletedasync_1707664681.md index d247225719..4da6d7ae40 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportCompletedAsync ## -description Informs the client app that the request was processed successfully. ## -returns An asynchronous sync operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -returns +An asynchronous sync operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportfailedasync_1210652737.md index 223d69a9a3..569592b955 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous sync operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous sync operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs.md index 32a3c6b08d..7ffd88782f 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs ## -description Encapsulates information about a request to sync a contact list. ## -remarks Use the instance of this class that's passed as an argument to your [SyncRequested](contactdataproviderconnection_syncrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs + +## -description +Encapsulates information about a request to sync a contact list. + +## -remarks +Use the instance of this class that's passed as an argument to your [SyncRequested](contactdataproviderconnection_syncrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_getdeferral_254836512.md index aae59aa3ed..16bd68b106 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_request.md b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_request.md index 1b043e0ddf..abee7a4d3a 100644 --- a/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_request.md +++ b/windows.applicationmodel.contacts.dataprovider/contactlistsyncmanagersyncrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.Request ## -description Gets the [ContactListSyncManagerSyncRequest](contactlistsyncmanagersyncrequest.md) object associated with this request. ## -property-value A [ContactListSyncManagerSyncRequest](contactlistsyncmanagersyncrequest.md) object describing the sync request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListSyncManagerSyncRequestEventArgs.Request + +## -description +Gets the [ContactListSyncManagerSyncRequest](contactlistsyncmanagersyncrequest.md) object associated with this request. + +## -property-value +A [ContactListSyncManagerSyncRequest](contactlistsyncmanagersyncrequest.md) object describing the sync request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_1063676932.md b/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_1063676932.md index 5dab552241..fb9355e79b 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_1063676932.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_1063676932.md @@ -1,3 +1,62 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact(System.String,Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact ## -description > [!NOTE] > [AddContact](contactpickerui_addcontact_1063676932.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [AddContact](contactpickerui_addcontact_79336216.md) without the ID. Adds a [Contact](../windows.applicationmodel.contacts/contact.md). ## -parameters ### -param id The ID for the contact. ### -param contact An object that contains the contact's information. ## -returns An [AddContactResult](addcontactresult.md)-typed value that indicates whether the contact was added successfully. ## -remarks ## -examples This example code adds a contact to the contact picker. ```javascript function addContact (sampleContact) { // Generate the Contact object to be added var contact = createContactForBasket(sampleContact); // Add the Contact object to the basket var statusMessage = document.getElementById("statusMessage"); switch (contactPickerUI.addContact(contact)) { case Windows.ApplicationModel.Contacts.Provider.AddContactResult.added: // Notify user that the contact was added to the basket statusMessage.innerText = contact.displayName + " was added to the basket"; break; case Windows.ApplicationModel.Contacts.Provider.AddContactResult.alreadyAdded: // Notify the user that the contact is already in the basket statusMessage.innerText = contact.displayName + " is already in the basket"; break; case Windows.ApplicationModel.Contacts.Provider.AddContactResult.unavailable: default: // Notify the user that the basket is not currently available statusMessage.innerText = contact.displayName + " could not be added to the basket"; break; } } ``` ## -see-also [AddContact(Contact)](contactpickerui_addcontact_79336216.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact(System.String,Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact + +## -description +> [!NOTE] +> [AddContact](contactpickerui_addcontact_1063676932.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [AddContact](contactpickerui_addcontact_79336216.md) without the ID. + +Adds a [Contact](../windows.applicationmodel.contacts/contact.md). + +## -parameters +### -param id +The ID for the contact. + +### -param contact +An object that contains the contact's information. + +## -returns +An [AddContactResult](addcontactresult.md)-typed value that indicates whether the contact was added successfully. + +## -remarks + +## -examples +This example code adds a contact to the contact picker. + +```javascript +function addContact (sampleContact) { +// Generate the Contact object to be added +var contact = createContactForBasket(sampleContact); + +// Add the Contact object to the basket +var statusMessage = document.getElementById("statusMessage"); + switch (contactPickerUI.addContact(contact)) { + case Windows.ApplicationModel.Contacts.Provider.AddContactResult.added: + // Notify user that the contact was added to the basket + statusMessage.innerText = contact.displayName + " was added to the basket"; + break; + case Windows.ApplicationModel.Contacts.Provider.AddContactResult.alreadyAdded: + // Notify the user that the contact is already in the basket + statusMessage.innerText = contact.displayName + " is already in the basket"; + break; + case Windows.ApplicationModel.Contacts.Provider.AddContactResult.unavailable: + default: + // Notify the user that the basket is not currently available + statusMessage.innerText = contact.displayName + " could not be added to the basket"; + break; + } +} + +``` + + + +## -see-also +[AddContact(Contact)](contactpickerui_addcontact_79336216.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md b/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md index 37e0cba09a..c8b161c171 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact ## -description Adds a [Contact](../windows.applicationmodel.contacts/contact.md). > [!NOTE] > The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) property must be set when you call [AddContact](contactpickerui_addcontact_79336216.md). If [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) isn't set, your app will fail. ## -parameters ### -param contact An object that contains the contact's information. ## -returns An [AddContactResult](addcontactresult.md)-typed value that indicates whether the contact was added successfully. ## -remarks ## -examples ## -see-also [AddContact(String, Contact)](contactpickerui_addcontact_1063676932.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.AddContact + +## -description +Adds a [Contact](../windows.applicationmodel.contacts/contact.md). + +> [!NOTE] +> The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) property must be set when you call [AddContact](contactpickerui_addcontact_79336216.md). If [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) isn't set, your app will fail. + +## -parameters +### -param contact +An object that contains the contact's information. + +## -returns +An [AddContactResult](addcontactresult.md)-typed value that indicates whether the contact was added successfully. + +## -remarks + +## -examples + +## -see-also +[AddContact(String, Contact)](contactpickerui_addcontact_1063676932.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_contactremoved.md b/windows.applicationmodel.contacts.provider/contactpickerui_contactremoved.md index 403f4ccd2a..c0774b9570 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_contactremoved.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_contactremoved.md @@ -1,3 +1,42 @@ ---- -api-id: E:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContactRemoved --api-type: winrt event ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContactRemoved ## -description Occurs when the user deselects or removes the contact. ## -remarks ## -examples ```javascript var contactPickerUI = null; function activatedHandler(ev) { if (ev.detail[0].kind == Windows.ApplicationModel.Activation.ActivationKind.contactPicker) { contactPickerUI = ev.detail[0].contactPickerUI; contactPickerUI.addEventListener("contactremoved", onContactRemoved); } } function onContactRemoved(e) { var contactId = e.id; // TODO: Respond to removal of this contact. } ``` ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContactRemoved +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContactRemoved + +## -description +Occurs when the user deselects or removes the contact. + +## -remarks + + +## -examples + + +```javascript + +var contactPickerUI = null; + +function activatedHandler(ev) { + if (ev.detail[0].kind == Windows.ApplicationModel.Activation.ActivationKind.contactPicker) { + contactPickerUI = ev.detail[0].contactPickerUI; + contactPickerUI.addEventListener("contactremoved", onContactRemoved); + } +} + +function onContactRemoved(e) { + var contactId = e.id; + + // TODO: Respond to removal of this contact. + +} +``` + + + +## -see-also diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_containscontact_2082214775.md b/windows.applicationmodel.contacts.provider/contactpickerui_containscontact_2082214775.md index f6e022a26f..92df90cb99 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_containscontact_2082214775.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_containscontact_2082214775.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContainsContact(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContainsContact ## -description Checks to see whether the contact was already selected by the user. > [!NOTE] > The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) property must be set when you call [ContainsContact](contactpickerui_containscontact.md). If [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) isn't set, your app won't be able to find the contact. ## -parameters ### -param id The ID of the contact. ## -returns True if the contact has already been selected; otherwise, false. ## -remarks ## -examples ## -see-also [Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContainsContact(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.ContainsContact + +## -description +Checks to see whether the contact was already selected by the user. + +> [!NOTE] +> The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) property must be set when you call [ContainsContact](contactpickerui_containscontact.md). If [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) isn't set, your app won't be able to find the contact. + +## -parameters +### -param id +The ID of the contact. + +## -returns +True if the contact has already been selected; otherwise, false. + +## -remarks + + +## -examples + +## -see-also +[Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_desiredfields.md b/windows.applicationmodel.contacts.provider/contactpickerui_desiredfields.md index 32920cdda0..21642de907 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_desiredfields.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_desiredfields.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFields --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFields ## -description > [!NOTE] > [DesiredFields](contactpickerui_desiredfields.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DesiredFieldsWithContactFieldType](contactpickerui_desiredfieldswithcontactfieldtype.md). Specifies the fields that you want returned after the user selects one or more contacts. ## -property-value A collection of fields that you want returned. You can specify which fields you want through the [KnownContactField](../windows.applicationmodel.contacts/knowncontactfield.md) class. ## -remarks To see an example of how to use this property, check out our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231575). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFields + +## -description +> [!NOTE] +> [DesiredFields](contactpickerui_desiredfields.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DesiredFieldsWithContactFieldType](contactpickerui_desiredfieldswithcontactfieldtype.md). + +Specifies the fields that you want returned after the user selects one or more contacts. + +## -property-value +A collection of fields that you want returned. You can specify which fields you want through the [KnownContactField](../windows.applicationmodel.contacts/knowncontactfield.md) class. + +## -remarks +To see an example of how to use this property, check out our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231575). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_desiredfieldswithcontactfieldtype.md b/windows.applicationmodel.contacts.provider/contactpickerui_desiredfieldswithcontactfieldtype.md index d55f262d5c..7985fd8b1c 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_desiredfieldswithcontactfieldtype.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_desiredfieldswithcontactfieldtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFieldsWithContactFieldType --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFieldsWithContactFieldType ## -description Gets the fields with contact field type that you want returned after the user selects one or more contacts. ## -property-value A collection of fields of contact field type that you want returned. The [ContactFieldType](../windows.applicationmodel.contacts/contactfieldtype.md) values specify which fields you want. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFieldsWithContactFieldType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.DesiredFieldsWithContactFieldType + +## -description +Gets the fields with contact field type that you want returned after the user selects one or more contacts. + +## -property-value +A collection of fields of contact field type that you want returned. The [ContactFieldType](../windows.applicationmodel.contacts/contactfieldtype.md) values specify which fields you want. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_removecontact_591776620.md b/windows.applicationmodel.contacts.provider/contactpickerui_removecontact_591776620.md index 6e730b6a0a..f03eeebdd7 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_removecontact_591776620.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_removecontact_591776620.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.RemoveContact(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.RemoveContact ## -description Removes a contact. > [!NOTE] > The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) property must be set when you call [RemoveContact](contactpickerui_removecontact.md). If [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) isn't set, your app won't be able to remove the contact. ## -parameters ### -param id The ID of the contact to remove. ## -remarks ## -examples ## -see-also [Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.RemoveContact(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.RemoveContact + +## -description +Removes a contact. + +> [!NOTE] +> The [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) property must be set when you call [RemoveContact](contactpickerui_removecontact.md). If [Contact.Id](../windows.applicationmodel.contacts/contact_id.md) isn't set, your app won't be able to remove the contact. + +## -parameters +### -param id +The ID of the contact to remove. + +## -remarks + + +## -examples + +## -see-also +[Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file diff --git a/windows.applicationmodel.contacts.provider/contactpickerui_selectionmode.md b/windows.applicationmodel.contacts.provider/contactpickerui_selectionmode.md index 90e8a24481..319b4448cb 100644 --- a/windows.applicationmodel.contacts.provider/contactpickerui_selectionmode.md +++ b/windows.applicationmodel.contacts.provider/contactpickerui_selectionmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.SelectionMode --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.SelectionMode ## -description Determines the selection mode for the contact picker. The most common options are [PickSingleContactAsync](../windows.applicationmodel.contacts/contactpicker_picksinglecontactasync.md) or [PickMultipleContactsAsync](../windows.applicationmodel.contacts/contactpicker_pickmultiplecontactsasync.md). ## -property-value Specifies the selection mode that you want to use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.SelectionMode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactPickerUI.SelectionMode + +## -description +Determines the selection mode for the contact picker. The most common options are [PickSingleContactAsync](../windows.applicationmodel.contacts/contactpicker_picksinglecontactasync.md) or [PickMultipleContactsAsync](../windows.applicationmodel.contacts/contactpicker_pickmultiplecontactsasync.md). + +## -property-value +Specifies the selection mode that you want to use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts.provider/contactremovedeventargs_id.md b/windows.applicationmodel.contacts.provider/contactremovedeventargs_id.md index faf3b3aea3..009b0b4ab3 100644 --- a/windows.applicationmodel.contacts.provider/contactremovedeventargs_id.md +++ b/windows.applicationmodel.contacts.provider/contactremovedeventargs_id.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactRemovedEventArgs.Id --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.Provider.ContactRemovedEventArgs.Id - -## -description -Contains a unique identifier for the contact. - -## -property-value -A unique identifier for the contact. - -## -remarks -When you work with contacts, you must supply an ID property for each contact. The value of this property can be whatever makes the most sense for your app, but it must enable you to uniquely identify each contact. Actions like removing a contact depend on this ID value to ensure that the correct contact is removed. For a complete example, see our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231575). - -## -examples -The following example shows one way to use the [Id](contactremovedeventargs_id.md) property of the [ContactRemovedEventArgs](contactremovedeventargs.md) class. - - - -[!code-js[ContactPickerBasketContactRemoved](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketContactRemoved)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.Provider.ContactRemovedEventArgs.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Provider.ContactRemovedEventArgs.Id + +## -description +Contains a unique identifier for the contact. + +## -property-value +A unique identifier for the contact. + +## -remarks +When you work with contacts, you must supply an ID property for each contact. The value of this property can be whatever makes the most sense for your app, but it must enable you to uniquely identify each contact. Actions like removing a contact depend on this ID value to ensure that the correct contact is removed. For a complete example, see our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231575). + +## -examples +The following example shows one way to use the [Id](contactremovedeventargs_id.md) property of the [ContactRemovedEventArgs](contactremovedeventargs.md) class. + + + +[!code-js[ContactPickerBasketContactRemoved](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketContactRemoved)] + +## -see-also diff --git a/windows.applicationmodel.contacts/aggregatecontactmanager.md b/windows.applicationmodel.contacts/aggregatecontactmanager.md index a2bcee1c9a..3e6296bb22 100644 --- a/windows.applicationmodel.contacts/aggregatecontactmanager.md +++ b/windows.applicationmodel.contacts/aggregatecontactmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.AggregateContactManager --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.AggregateContactManager ## -description Provides functionality for linking individual (raw) contacts across services together into a single aggregate contact. ## -remarks All relevant methods of this class are static methods. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.AggregateContactManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.AggregateContactManager + +## -description +Provides functionality for linking individual (raw) contacts across services together into a single aggregate contact. + +## -remarks +All relevant methods of this class are static methods. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/aggregatecontactmanager_findrawcontactsasync_1729134772.md b/windows.applicationmodel.contacts/aggregatecontactmanager_findrawcontactsasync_1729134772.md index 438da1808a..1eaf8cf89f 100644 --- a/windows.applicationmodel.contacts/aggregatecontactmanager_findrawcontactsasync_1729134772.md +++ b/windows.applicationmodel.contacts/aggregatecontactmanager_findrawcontactsasync_1729134772.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.FindRawContactsAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.AggregateContactManager.FindRawContactsAsync ## -description Returns the list of individual (raw) contacts from the specified aggregate contact. ## -parameters ### -param contact The aggregate contact from which to extract the list of raw contacts. ## -returns The list of individual (raw) contacts from the specified aggregate contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.FindRawContactsAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.AggregateContactManager.FindRawContactsAsync + +## -description +Returns the list of individual (raw) contacts from the specified aggregate contact. + +## -parameters +### -param contact +The aggregate contact from which to extract the list of raw contacts. + +## -returns +The list of individual (raw) contacts from the specified aggregate contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/aggregatecontactmanager_setremoteidentificationinformationasync_1848043711.md b/windows.applicationmodel.contacts/aggregatecontactmanager_setremoteidentificationinformationasync_1848043711.md index 411a53314b..721417a68c 100644 --- a/windows.applicationmodel.contacts/aggregatecontactmanager_setremoteidentificationinformationasync_1848043711.md +++ b/windows.applicationmodel.contacts/aggregatecontactmanager_setremoteidentificationinformationasync_1848043711.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.SetRemoteIdentificationInformationAsync(System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.AggregateContactManager.SetRemoteIdentificationInformationAsync ## -description Sets the identifier that specifies the remote contacts to link together with the contact data on your device. ## -parameters ### -param contactListId The remote contact list identifier. ### -param remoteSourceId The identifier for the remote service, for example, “EXCH” for exchange accounts. ### -param accountId The unique roaming identifier of the account for the network. ## -returns The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.SetRemoteIdentificationInformationAsync(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.AggregateContactManager.SetRemoteIdentificationInformationAsync + +## -description +Sets the identifier that specifies the remote contacts to link together with the contact data on your device. + +## -parameters +### -param contactListId +The remote contact list identifier. + +### -param remoteSourceId +The identifier for the remote service, for example, “EXCH” for exchange accounts. + +### -param accountId +The unique roaming identifier of the account for the network. + +## -returns +The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/aggregatecontactmanager_trylinkcontactsasync_395713788.md b/windows.applicationmodel.contacts/aggregatecontactmanager_trylinkcontactsasync_395713788.md index 82e4d71939..910dd55f35 100644 --- a/windows.applicationmodel.contacts/aggregatecontactmanager_trylinkcontactsasync_395713788.md +++ b/windows.applicationmodel.contacts/aggregatecontactmanager_trylinkcontactsasync_395713788.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.TryLinkContactsAsync(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.AggregateContactManager.TryLinkContactsAsync ## -description Asynchronously attempts to link contacts together to make an aggregate contact. ## -parameters ### -param primaryContact The first contact to link. ### -param secondaryContact The second contact to link to the *primaryContact*. ## -returns The newly created aggregate contact. ## -remarks The *primaryContact* and *secondaryContact* objects can be any combination of raw and aggregate contacts. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.TryLinkContactsAsync(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.AggregateContactManager.TryLinkContactsAsync + +## -description +Asynchronously attempts to link contacts together to make an aggregate contact. + +## -parameters +### -param primaryContact +The first contact to link. + +### -param secondaryContact +The second contact to link to the *primaryContact*. + +## -returns +The newly created aggregate contact. + +## -remarks +The *primaryContact* and *secondaryContact* objects can be any combination of raw and aggregate contacts. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/aggregatecontactmanager_trysetpreferredsourceforpictureasync_1920042851.md b/windows.applicationmodel.contacts/aggregatecontactmanager_trysetpreferredsourceforpictureasync_1920042851.md index e8d5a09608..a6de92d1a2 100644 --- a/windows.applicationmodel.contacts/aggregatecontactmanager_trysetpreferredsourceforpictureasync_1920042851.md +++ b/windows.applicationmodel.contacts/aggregatecontactmanager_trysetpreferredsourceforpictureasync_1920042851.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.TrySetPreferredSourceForPictureAsync(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.AggregateContactManager.TrySetPreferredSourceForPictureAsync ## -description Chooses which of the raw contacts provides the main display picture for the aggregate. ## -parameters ### -param aggregateContact The aggregate contact on which to set the picture. ### -param rawContact The raw contact that provides the picture for the aggregate. ## -returns True if successful, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.TrySetPreferredSourceForPictureAsync(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.AggregateContactManager.TrySetPreferredSourceForPictureAsync + +## -description +Chooses which of the raw contacts provides the main display picture for the aggregate. + +## -parameters +### -param aggregateContact +The aggregate contact on which to set the picture. + +### -param rawContact +The raw contact that provides the picture for the aggregate. + +## -returns +True if successful, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/aggregatecontactmanager_unlinkrawcontactasync_72612403.md b/windows.applicationmodel.contacts/aggregatecontactmanager_unlinkrawcontactasync_72612403.md index 1a497663a2..213d526833 100644 --- a/windows.applicationmodel.contacts/aggregatecontactmanager_unlinkrawcontactasync_72612403.md +++ b/windows.applicationmodel.contacts/aggregatecontactmanager_unlinkrawcontactasync_72612403.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.UnlinkRawContactAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.AggregateContactManager.UnlinkRawContactAsync ## -description Asynchronously unlinks a raw contact from the parent aggregate contact. ## -parameters ### -param contact The raw contact to remove from the aggregate. ## -returns An async action that indicates the operation is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.AggregateContactManager.UnlinkRawContactAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.AggregateContactManager.UnlinkRawContactAsync + +## -description +Asynchronously unlinks a raw contact from the parent aggregate contact. + +## -parameters +### -param contact +The raw contact to remove from the aggregate. + +## -returns +An async action that indicates the operation is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_addresses.md b/windows.applicationmodel.contacts/contact_addresses.md index 17558bd5ec..e4811071dd 100644 --- a/windows.applicationmodel.contacts/contact_addresses.md +++ b/windows.applicationmodel.contacts/contact_addresses.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Addresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Addresses ## -description Gets the contact addresses for a contact. ## -property-value An array of contact addresses for a contact. ## -remarks ## -examples ## -see-also [ContactAddress](contactaddress.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Addresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Addresses + +## -description +Gets the contact addresses for a contact. + +## -property-value +An array of contact addresses for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactAddress](contactaddress.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_aggregateid.md b/windows.applicationmodel.contacts/contact_aggregateid.md index 808e87dd59..9818a5b3da 100644 --- a/windows.applicationmodel.contacts/contact_aggregateid.md +++ b/windows.applicationmodel.contacts/contact_aggregateid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.AggregateId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.AggregateId ## -description If this is a raw contact that is part of an aggregate contact, then this property identifies the parent aggregate. ## -property-value String value that identifies the parent aggregate contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.AggregateId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.AggregateId + +## -description +If this is a raw contact that is part of an aggregate contact, then this property identifies the parent aggregate. + +## -property-value +String value that identifies the parent aggregate contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_connectedserviceaccounts.md b/windows.applicationmodel.contacts/contact_connectedserviceaccounts.md index 2749ecf7a4..46737e20e1 100644 --- a/windows.applicationmodel.contacts/contact_connectedserviceaccounts.md +++ b/windows.applicationmodel.contacts/contact_connectedserviceaccounts.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.ConnectedServiceAccounts --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.ConnectedServiceAccounts ## -description Gets the connected service accounts for a contact. ## -property-value An array of connected service accounts for a contact. ## -remarks ## -examples ## -see-also [ContactConnectedServiceAccount](contactconnectedserviceaccount.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.ConnectedServiceAccounts +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.ConnectedServiceAccounts + +## -description +Gets the connected service accounts for a contact. + +## -property-value +An array of connected service accounts for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactConnectedServiceAccount](contactconnectedserviceaccount.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_contact_1221375020.md b/windows.applicationmodel.contacts/contact_contact_1221375020.md index bde0374e31..cd7d2ab450 100644 --- a/windows.applicationmodel.contacts/contact_contact_1221375020.md +++ b/windows.applicationmodel.contacts/contact_contact_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.Contact.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.Contact.Contact ## -description Creates a new instance of the [Contact](contact.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.Contact.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Contact + +## -description +Creates a new instance of the [Contact](contact.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_contactlistid.md b/windows.applicationmodel.contacts/contact_contactlistid.md index 3f12bfcd7d..04ccd6e973 100644 --- a/windows.applicationmodel.contacts/contact_contactlistid.md +++ b/windows.applicationmodel.contacts/contact_contactlistid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.ContactListId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.ContactListId ## -description Gets a string that identifies the [ContactList](contactlist.md) to which this contact is a member. ## -property-value A string that identifies the [ContactList](contactlist.md) to which this contact is a member. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.ContactListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.ContactListId + +## -description +Gets a string that identifies the [ContactList](contactlist.md) to which this contact is a member. + +## -property-value +A string that identifies the [ContactList](contactlist.md) to which this contact is a member. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_datasuppliers.md b/windows.applicationmodel.contacts/contact_datasuppliers.md index 1677336e93..ac229ef8db 100644 --- a/windows.applicationmodel.contacts/contact_datasuppliers.md +++ b/windows.applicationmodel.contacts/contact_datasuppliers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.DataSuppliers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.DataSuppliers ## -description Gets the data suppliers for a contact. The maximum string length for each data supplier is 50 characters. ## -property-value An array of data suppliers for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.DataSuppliers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.DataSuppliers + +## -description +Gets the data suppliers for a contact. The maximum string length for each data supplier is 50 characters. + +## -property-value +An array of data suppliers for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_displayname.md b/windows.applicationmodel.contacts/contact_displayname.md index 606ab1b6c6..4ed7b1d3b2 100644 --- a/windows.applicationmodel.contacts/contact_displayname.md +++ b/windows.applicationmodel.contacts/contact_displayname.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.DisplayName ## -description Gets the display name for a contact. > [!NOTE] > You can only access this property from a UI thread. ## -property-value The display name for a contact. ## -remarks Windows calculates the [DisplayName](contact_displayname.md) property by using the values from the [FirstName](contact_firstname.md), [MiddleName](contact_middlename.md), and [LastName](contact_lastname.md) properties if any are specified. If these values aren't available, Windows uses the Yomi (phonetic Japanese equivalent) name values ([YomiGivenName](contact_yomigivenname.md) and [YomiFamilyName](contact_yomifamilyname.md)). The calculation for [DisplayName](contact_displayname.md) takes into account different locale hints such as script of the text in the names, resource context, and default user locale to determine the proper formatting template for the name. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.DisplayName + +## -description +Gets the display name for a contact. + +> [!NOTE] +> You can only access this property from a UI thread. + +## -property-value +The display name for a contact. + +## -remarks +Windows calculates the [DisplayName](contact_displayname.md) property by using the values from the [FirstName](contact_firstname.md), [MiddleName](contact_middlename.md), and [LastName](contact_lastname.md) properties if any are specified. If these values aren't available, Windows uses the Yomi (phonetic Japanese equivalent) name values ([YomiGivenName](contact_yomigivenname.md) and [YomiFamilyName](contact_yomifamilyname.md)). The calculation for [DisplayName](contact_displayname.md) takes into account different locale hints such as script of the text in the names, resource context, and default user locale to determine the proper formatting template for the name. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_displaynameoverride.md b/windows.applicationmodel.contacts/contact_displaynameoverride.md index bfe5537505..e0dbefca1e 100644 --- a/windows.applicationmodel.contacts/contact_displaynameoverride.md +++ b/windows.applicationmodel.contacts/contact_displaynameoverride.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.DisplayNameOverride --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.DisplayNameOverride ## -description Gets or sets the display that was manually entered by the user. ## -property-value The display that was manually entered by the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.DisplayNameOverride +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.DisplayNameOverride + +## -description +Gets or sets the display that was manually entered by the user. + +## -property-value +The display that was manually entered by the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_displaypictureuserupdatetime.md b/windows.applicationmodel.contacts/contact_displaypictureuserupdatetime.md index e09bcf42cd..be15c8c234 100644 --- a/windows.applicationmodel.contacts/contact_displaypictureuserupdatetime.md +++ b/windows.applicationmodel.contacts/contact_displaypictureuserupdatetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.DisplayPictureUserUpdateTime --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.DisplayPictureUserUpdateTime ## -description Gets or sets the last time the user updated their display picture. ## -property-value The last time the user updated their display picture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.DisplayPictureUserUpdateTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.DisplayPictureUserUpdateTime + +## -description +Gets or sets the last time the user updated their display picture. + +## -property-value +The last time the user updated their display picture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_emails.md b/windows.applicationmodel.contacts/contact_emails.md index 7a87d11bf7..72c8276d87 100644 --- a/windows.applicationmodel.contacts/contact_emails.md +++ b/windows.applicationmodel.contacts/contact_emails.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Emails --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Emails ## -description Gets the email addresses for a contact. ## -property-value An array of email addresses for a contact. ## -remarks ## -examples ## -see-also [ContactEmail](contactemail.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Emails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Emails + +## -description +Gets the email addresses for a contact. + +## -property-value +An array of email addresses for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactEmail](contactemail.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_fields.md b/windows.applicationmodel.contacts/contact_fields.md index 3ea7535fcc..a6efdd759c 100644 --- a/windows.applicationmodel.contacts/contact_fields.md +++ b/windows.applicationmodel.contacts/contact_fields.md @@ -1,37 +1,37 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.Contact.Fields --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.Contact.Fields - -## -description -> [!NOTE] -> [Fields](contact_fields.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Phones](contact_phones.md), [Emails](contact_emails.md), [Addresses](contact_addresses.md), or [ConnectedServiceAccounts](contact_connectedserviceaccounts.md). - -Sets the fields that contain information about a contact. - -## -property-value -An array of fields containing information about a contact. - -## -remarks -The [ContactFieldCategory](contactfieldcategory.md) and [ContactFieldType](contactfieldtype.md) classes provide information about what kind of information you can put into a field. - -## -examples -These functions show how you can add different fields to a [Contact](contact.md) object. - - - -[!code-js[ContactPickerBasketAppendField](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendField)] - -[!code-js[ContactPickerBasketAppendEmail](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendEmail)] - -[!code-js[ContactPickerBasketAppendPhoneNumber](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendPhoneNumber)] - -[!code-js[ContactPickerBasketAppendAddress](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendAddress)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Fields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Fields + +## -description +> [!NOTE] +> [Fields](contact_fields.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Phones](contact_phones.md), [Emails](contact_emails.md), [Addresses](contact_addresses.md), or [ConnectedServiceAccounts](contact_connectedserviceaccounts.md). + +Sets the fields that contain information about a contact. + +## -property-value +An array of fields containing information about a contact. + +## -remarks +The [ContactFieldCategory](contactfieldcategory.md) and [ContactFieldType](contactfieldtype.md) classes provide information about what kind of information you can put into a field. + +## -examples +These functions show how you can add different fields to a [Contact](contact.md) object. + + + +[!code-js[ContactPickerBasketAppendField](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendField)] + +[!code-js[ContactPickerBasketAppendEmail](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendEmail)] + +[!code-js[ContactPickerBasketAppendPhoneNumber](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendPhoneNumber)] + +[!code-js[ContactPickerBasketAppendAddress](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contactpicker.js#SnippetContactPickerBasketAppendAddress)] + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_firstname.md b/windows.applicationmodel.contacts/contact_firstname.md index 3258513eb5..f3cbf4fdd4 100644 --- a/windows.applicationmodel.contacts/contact_firstname.md +++ b/windows.applicationmodel.contacts/contact_firstname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.FirstName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.FirstName ## -description Gets and sets the first name for a contact. The maximum string length for the first name is 64 characters. ## -property-value The first name for a contact. ## -remarks ## -examples ## -see-also [Name](contact_name.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.FirstName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.FirstName + +## -description +Gets and sets the first name for a contact. The maximum string length for the first name is 64 characters. + +## -property-value +The first name for a contact. + +## -remarks + +## -examples + +## -see-also +[Name](contact_name.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_fullname.md b/windows.applicationmodel.contacts/contact_fullname.md index 81defaebdc..faf1530593 100644 --- a/windows.applicationmodel.contacts/contact_fullname.md +++ b/windows.applicationmodel.contacts/contact_fullname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.FullName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.FullName ## -description Gets the full name of the [Contact](contact.md). ## -property-value The full name of the [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.FullName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.FullName + +## -description +Gets the full name of the [Contact](contact.md). + +## -property-value +The full name of the [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_honorificnameprefix.md b/windows.applicationmodel.contacts/contact_honorificnameprefix.md index efd79e70ef..9e7d6e6777 100644 --- a/windows.applicationmodel.contacts/contact_honorificnameprefix.md +++ b/windows.applicationmodel.contacts/contact_honorificnameprefix.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.HonorificNamePrefix --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.HonorificNamePrefix ## -description Gets and sets the honorific prefix for the name for a contact. The maximum string length for the honorific prefix is 32 characters. ## -property-value The honorific prefix for the name for a contact. ## -remarks Common name prefixes are Ms, Miss, Mrs, Mr, Dr, and so on. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.HonorificNamePrefix +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.HonorificNamePrefix + +## -description +Gets and sets the honorific prefix for the name for a contact. The maximum string length for the honorific prefix is 32 characters. + +## -property-value +The honorific prefix for the name for a contact. + +## -remarks +Common name prefixes are Ms, Miss, Mrs, Mr, Dr, and so on. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_honorificnamesuffix.md b/windows.applicationmodel.contacts/contact_honorificnamesuffix.md index fcece10de2..4144b18e30 100644 --- a/windows.applicationmodel.contacts/contact_honorificnamesuffix.md +++ b/windows.applicationmodel.contacts/contact_honorificnamesuffix.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.HonorificNameSuffix --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.HonorificNameSuffix ## -description Gets and sets the honorific suffix for the name for a contact. The maximum string length for the honorific suffix is 32 characters. ## -property-value The honorific suffix for the name for a contact. ## -remarks A suffix follows the contact's name and provides additional info about the contact, like an academic degree (M.D. for medical doctor). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.HonorificNameSuffix +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.HonorificNameSuffix + +## -description +Gets and sets the honorific suffix for the name for a contact. The maximum string length for the honorific suffix is 32 characters. + +## -property-value +The honorific suffix for the name for a contact. + +## -remarks +A suffix follows the contact's name and provides additional info about the contact, like an academic degree (M.D. for medical doctor). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_id.md b/windows.applicationmodel.contacts/contact_id.md index 0871756a96..a31cbdc345 100644 --- a/windows.applicationmodel.contacts/contact_id.md +++ b/windows.applicationmodel.contacts/contact_id.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Id --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Id ## -description Gets and sets the identifier for a contact. The maximum string length for the identifier is 256 characters. > [!NOTE] > The [Id](contact_id.md) property must be set when you call [AddContact](../windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md), [ContainsContact](../windows.applicationmodel.contacts.provider/contactpickerui_containscontact.md), or [RemoveContact](../windows.applicationmodel.contacts.provider/contactpickerui_removecontact.md). If [Id](contact_id.md) isn't set when you call [AddContact](../windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md), your app will fail. If [Id](contact_id.md) isn't set when you call [ContainsContact](../windows.applicationmodel.contacts.provider/contactpickerui_containscontact.md) or [RemoveContact](../windows.applicationmodel.contacts.provider/contactpickerui_removecontact.md), your app won't be able to find or remove the contact. ## -property-value The identifier for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Id + +## -description +Gets and sets the identifier for a contact. The maximum string length for the identifier is 256 characters. + +> [!NOTE] +> The [Id](contact_id.md) property must be set when you call [AddContact](../windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md), [ContainsContact](../windows.applicationmodel.contacts.provider/contactpickerui_containscontact.md), or [RemoveContact](../windows.applicationmodel.contacts.provider/contactpickerui_removecontact.md). If [Id](contact_id.md) isn't set when you call [AddContact](../windows.applicationmodel.contacts.provider/contactpickerui_addcontact_79336216.md), your app will fail. If [Id](contact_id.md) isn't set when you call [ContainsContact](../windows.applicationmodel.contacts.provider/contactpickerui_containscontact.md) or [RemoveContact](../windows.applicationmodel.contacts.provider/contactpickerui_removecontact.md), your app won't be able to find or remove the contact. + +## -property-value +The identifier for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_importantdates.md b/windows.applicationmodel.contacts/contact_importantdates.md index c7a3ca3549..30fa9bb165 100644 --- a/windows.applicationmodel.contacts/contact_importantdates.md +++ b/windows.applicationmodel.contacts/contact_importantdates.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.ImportantDates --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.ImportantDates ## -description Gets the important dates for a contact. ## -property-value An array of important dates for a contact. ## -remarks ## -examples ## -see-also [ContactDate](contactdate.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.ImportantDates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.ImportantDates + +## -description +Gets the important dates for a contact. + +## -property-value +An array of important dates for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactDate](contactdate.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_isaggregate.md b/windows.applicationmodel.contacts/contact_isaggregate.md index e08dd106fd..645cf850d2 100644 --- a/windows.applicationmodel.contacts/contact_isaggregate.md +++ b/windows.applicationmodel.contacts/contact_isaggregate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.IsAggregate --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.IsAggregate ## -description Gets a Boolean value indicating of this is an aggregate [Contact](contact.md). ## -property-value Boolean value indicating of this is an aggregate [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.IsAggregate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.IsAggregate + +## -description +Gets a Boolean value indicating of this is an aggregate [Contact](contact.md). + +## -property-value +Boolean value indicating of this is an aggregate [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_isdisplaypicturemanuallyset.md b/windows.applicationmodel.contacts/contact_isdisplaypicturemanuallyset.md index 516c127865..54445faa15 100644 --- a/windows.applicationmodel.contacts/contact_isdisplaypicturemanuallyset.md +++ b/windows.applicationmodel.contacts/contact_isdisplaypicturemanuallyset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.IsDisplayPictureManuallySet --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.IsDisplayPictureManuallySet ## -description Gets a Boolean value indicating if the user manually set the picture for the [Contact](contact.md). ## -property-value True if the user manually set the picture, false if this is an aggregate contact and the picture was chosen from one of the raw child contacts. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.IsDisplayPictureManuallySet +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.IsDisplayPictureManuallySet + +## -description +Gets a Boolean value indicating if the user manually set the picture for the [Contact](contact.md). + +## -property-value +True if the user manually set the picture, false if this is an aggregate contact and the picture was chosen from one of the raw child contacts. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_isme.md b/windows.applicationmodel.contacts/contact_isme.md index 9ae92f7b5c..42ce25abc8 100644 --- a/windows.applicationmodel.contacts/contact_isme.md +++ b/windows.applicationmodel.contacts/contact_isme.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.IsMe --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.IsMe ## -description Gets a Boolean value indicating if this [Contact](contact.md) represents the user logged into the device. ## -property-value Boolean value indicating if this [Contact](contact.md) represents the user logged into the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.IsMe +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.IsMe + +## -description +Gets a Boolean value indicating if this [Contact](contact.md) represents the user logged into the device. + +## -property-value +Boolean value indicating if this [Contact](contact.md) represents the user logged into the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_jobinfo.md b/windows.applicationmodel.contacts/contact_jobinfo.md index db9778ccee..e4fa6415b6 100644 --- a/windows.applicationmodel.contacts/contact_jobinfo.md +++ b/windows.applicationmodel.contacts/contact_jobinfo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.JobInfo --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.JobInfo ## -description Gets the job info items for a contact. ## -property-value An array of job info items for a contact. ## -remarks ## -examples ## -see-also [ContactJobInfo](contactjobinfo.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.JobInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.JobInfo + +## -description +Gets the job info items for a contact. + +## -property-value +An array of job info items for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactJobInfo](contactjobinfo.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_largedisplaypicture.md b/windows.applicationmodel.contacts/contact_largedisplaypicture.md index faa43867a0..2eef9ca275 100644 --- a/windows.applicationmodel.contacts/contact_largedisplaypicture.md +++ b/windows.applicationmodel.contacts/contact_largedisplaypicture.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.LargeDisplayPicture --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.LargeDisplayPicture ## -description Gets a large version of the display picture for the [Contact](contact.md). ## -property-value A large version of the display picture for the [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.LargeDisplayPicture +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.LargeDisplayPicture + +## -description +Gets a large version of the display picture for the [Contact](contact.md). + +## -property-value +A large version of the display picture for the [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_lastname.md b/windows.applicationmodel.contacts/contact_lastname.md index 465c7a6fba..6c3097af51 100644 --- a/windows.applicationmodel.contacts/contact_lastname.md +++ b/windows.applicationmodel.contacts/contact_lastname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.LastName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.LastName ## -description Gets and sets the last name for a contact. The maximum string length for the last name is 64 characters. ## -property-value The last name for a contact. ## -remarks ## -examples ## -see-also [Name](contact_name.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.LastName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.LastName + +## -description +Gets and sets the last name for a contact. The maximum string length for the last name is 64 characters. + +## -property-value +The last name for a contact. + +## -remarks + +## -examples + +## -see-also +[Name](contact_name.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_middlename.md b/windows.applicationmodel.contacts/contact_middlename.md index d92aebac61..e603893322 100644 --- a/windows.applicationmodel.contacts/contact_middlename.md +++ b/windows.applicationmodel.contacts/contact_middlename.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.MiddleName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.MiddleName ## -description Gets and sets the middle name for a contact. The maximum string length for the middle name is 64 characters. ## -property-value The middle name for a contact. ## -remarks ## -examples ## -see-also [Name](contact_name.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.MiddleName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.MiddleName + +## -description +Gets and sets the middle name for a contact. The maximum string length for the middle name is 64 characters. + +## -property-value +The middle name for a contact. + +## -remarks + +## -examples + +## -see-also +[Name](contact_name.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_name.md b/windows.applicationmodel.contacts/contact_name.md index 838cf969b5..52aefcd84c 100644 --- a/windows.applicationmodel.contacts/contact_name.md +++ b/windows.applicationmodel.contacts/contact_name.md @@ -1,31 +1,31 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.Contact.Name --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.Contact.Name - -## -description -> [!NOTE] -> [Name](contact_name.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [FirstName](contact_firstname.md). - -Sets and gets the name of the contact. - -## -property-value -The name of the contact. - -## -remarks -An app can set the [name](contact_name.md) property to any value that matches the name of a contact. We recommend that you set this value to contain both the first and last names of the contact, if that information is available. - -## -examples -This example shows a function taking the [name](contact_name.md) property and returning the first and last names of the contact. - - - -[!code-js[ContactsNameProperty](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsNameProperty)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Name + +## -description +> [!NOTE] +> [Name](contact_name.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [FirstName](contact_firstname.md). + +Sets and gets the name of the contact. + +## -property-value +The name of the contact. + +## -remarks +An app can set the [name](contact_name.md) property to any value that matches the name of a contact. We recommend that you set this value to contain both the first and last names of the contact, if that information is available. + +## -examples +This example shows a function taking the [name](contact_name.md) property and returning the first and last names of the contact. + + + +[!code-js[ContactsNameProperty](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsNameProperty)] + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_nickname.md b/windows.applicationmodel.contacts/contact_nickname.md index 69d3dd452d..76468041d7 100644 --- a/windows.applicationmodel.contacts/contact_nickname.md +++ b/windows.applicationmodel.contacts/contact_nickname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Nickname --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Nickname ## -description Gets or sets the nickname for the [Contact](contact.md). ## -property-value The nickname for the [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Nickname +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Nickname + +## -description +Gets or sets the nickname for the [Contact](contact.md). + +## -property-value +The nickname for the [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_notes.md b/windows.applicationmodel.contacts/contact_notes.md index e4ab42ad9e..49d560054d 100644 --- a/windows.applicationmodel.contacts/contact_notes.md +++ b/windows.applicationmodel.contacts/contact_notes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Notes --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Notes ## -description Gets and sets notes for a contact. The maximum string length for notes is 4096 characters. ## -property-value A string that contains notes for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Notes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Notes + +## -description +Gets and sets notes for a contact. The maximum string length for notes is 4096 characters. + +## -property-value +A string that contains notes for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_phones.md b/windows.applicationmodel.contacts/contact_phones.md index 6e3e91dd58..5259cdd426 100644 --- a/windows.applicationmodel.contacts/contact_phones.md +++ b/windows.applicationmodel.contacts/contact_phones.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Phones --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Phones ## -description Gets info about the phones for a contact. ## -property-value An array of items that describe the phones for a contact. ## -remarks ## -examples ## -see-also [ContactPhone](contactphone.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Phones +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Phones + +## -description +Gets info about the phones for a contact. + +## -property-value +An array of items that describe the phones for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactPhone](contactphone.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_providerproperties.md b/windows.applicationmodel.contacts/contact_providerproperties.md index 26676b0938..9f6b62c3bd 100644 --- a/windows.applicationmodel.contacts/contact_providerproperties.md +++ b/windows.applicationmodel.contacts/contact_providerproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.ProviderProperties --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.ProviderProperties ## -description Gets the property set object for the contact. ## -property-value The [IPropertySet](../windows.foundation.collections/ipropertyset.md) interface for the property set object for the contact. ## -remarks ## -examples ## -see-also [IPropertySet](../windows.foundation.collections/ipropertyset.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.ProviderProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.ProviderProperties + +## -description +Gets the property set object for the contact. + +## -property-value +The [IPropertySet](../windows.foundation.collections/ipropertyset.md) interface for the property set object for the contact. + +## -remarks + +## -examples + +## -see-also +[IPropertySet](../windows.foundation.collections/ipropertyset.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_remoteid.md b/windows.applicationmodel.contacts/contact_remoteid.md index 6ca9fd752f..b7cf85bf45 100644 --- a/windows.applicationmodel.contacts/contact_remoteid.md +++ b/windows.applicationmodel.contacts/contact_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.RemoteId ## -description Gets or sets an ID that can be used by a service provider to access the [Contact](contact.md) in their remote system. ## -property-value An ID that can be used by a service provider to access the [Contact](contact.md) in their remote system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.RemoteId + +## -description +Gets or sets an ID that can be used by a service provider to access the [Contact](contact.md) in their remote system. + +## -property-value +An ID that can be used by a service provider to access the [Contact](contact.md) in their remote system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_ringtonetoken.md b/windows.applicationmodel.contacts/contact_ringtonetoken.md index 1443a4d111..1b6d38a69c 100644 --- a/windows.applicationmodel.contacts/contact_ringtonetoken.md +++ b/windows.applicationmodel.contacts/contact_ringtonetoken.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.RingToneToken --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.RingToneToken ## -description Gets or puts the path to the ringtone file for the [Contact](contact.md). ## -property-value The path to the ringtone file for the [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.RingToneToken +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.RingToneToken + +## -description +Gets or puts the path to the ringtone file for the [Contact](contact.md). + +## -property-value +The path to the ringtone file for the [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_significantothers.md b/windows.applicationmodel.contacts/contact_significantothers.md index ce09c8367e..061fb18ed9 100644 --- a/windows.applicationmodel.contacts/contact_significantothers.md +++ b/windows.applicationmodel.contacts/contact_significantothers.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.SignificantOthers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.SignificantOthers ## -description Gets the significant others for a contact. ## -property-value An array of significant others for a contact. ## -remarks ## -examples ## -see-also [ContactSignificantOther](contactsignificantother.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.SignificantOthers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.SignificantOthers + +## -description +Gets the significant others for a contact. + +## -property-value +An array of significant others for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactSignificantOther](contactsignificantother.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_smalldisplaypicture.md b/windows.applicationmodel.contacts/contact_smalldisplaypicture.md index 965a2fef78..f7ed065040 100644 --- a/windows.applicationmodel.contacts/contact_smalldisplaypicture.md +++ b/windows.applicationmodel.contacts/contact_smalldisplaypicture.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.SmallDisplayPicture --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.SmallDisplayPicture ## -description Gets a small version of the display picture for the [Contact](contact.md). ## -property-value A small version of the display picture for the [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.SmallDisplayPicture +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.SmallDisplayPicture + +## -description +Gets a small version of the display picture for the [Contact](contact.md). + +## -property-value +A small version of the display picture for the [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_sortname.md b/windows.applicationmodel.contacts/contact_sortname.md index 53544cf7f8..ffeffe13a6 100644 --- a/windows.applicationmodel.contacts/contact_sortname.md +++ b/windows.applicationmodel.contacts/contact_sortname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.SortName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.SortName ## -description Gets the name used to sort the contact. ## -property-value The name used to sort the contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.SortName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.SortName + +## -description +Gets the name used to sort the contact. + +## -property-value +The name used to sort the contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_sourcedisplaypicture.md b/windows.applicationmodel.contacts/contact_sourcedisplaypicture.md index 57a9d799cf..f27f374ec2 100644 --- a/windows.applicationmodel.contacts/contact_sourcedisplaypicture.md +++ b/windows.applicationmodel.contacts/contact_sourcedisplaypicture.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.SourceDisplayPicture --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.SourceDisplayPicture ## -description Gets or sets the display picture for the [Contact](contact.md) in its original size. ## -property-value The display picture for the [Contact](contact.md) in its original size. ## -remarks The [SmallDisplayPicture](contact_smalldisplaypicture.md), [LargeDisplayPicture](contact_largedisplaypicture.md) and [Thumbnail](contact_thumbnail.md) are generated from this picture. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.SourceDisplayPicture +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.SourceDisplayPicture + +## -description +Gets or sets the display picture for the [Contact](contact.md) in its original size. + +## -property-value +The display picture for the [Contact](contact.md) in its original size. + +## -remarks +The [SmallDisplayPicture](contact_smalldisplaypicture.md), [LargeDisplayPicture](contact_largedisplaypicture.md) and [Thumbnail](contact_thumbnail.md) are generated from this picture. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_texttonetoken.md b/windows.applicationmodel.contacts/contact_texttonetoken.md index 040915fe1a..5e9d3a6e19 100644 --- a/windows.applicationmodel.contacts/contact_texttonetoken.md +++ b/windows.applicationmodel.contacts/contact_texttonetoken.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.TextToneToken --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.TextToneToken ## -description Gets or puts the path to the audio file to play when an SMS/MMS message is received from the [Contact](contact.md). ## -property-value The path to the audio file to play when an SMS/MMS message is received from the [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.TextToneToken +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.TextToneToken + +## -description +Gets or puts the path to the audio file to play when an SMS/MMS message is received from the [Contact](contact.md). + +## -property-value +The path to the audio file to play when an SMS/MMS message is received from the [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_thumbnail.md b/windows.applicationmodel.contacts/contact_thumbnail.md index a602cf2bec..0cb1519add 100644 --- a/windows.applicationmodel.contacts/contact_thumbnail.md +++ b/windows.applicationmodel.contacts/contact_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Thumbnail --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Thumbnail ## -description Gets or sets a thumbnail image that represents this contact. ## -property-value The thumbnail image for the contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Thumbnail + +## -description +Gets or sets a thumbnail image that represents this contact. + +## -property-value +The thumbnail image for the contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_websites.md b/windows.applicationmodel.contacts/contact_websites.md index a3c5f23a5f..7149b17779 100644 --- a/windows.applicationmodel.contacts/contact_websites.md +++ b/windows.applicationmodel.contacts/contact_websites.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.Websites --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.Websites ## -description Gets the Web sites for a contact. ## -property-value An array of Web sites for a contact. ## -remarks ## -examples ## -see-also [ContactWebsite](contactwebsite.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.Websites +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.Websites + +## -description +Gets the Web sites for a contact. + +## -property-value +An array of Web sites for a contact. + +## -remarks + +## -examples + +## -see-also +[ContactWebsite](contactwebsite.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contact_yomidisplayname.md b/windows.applicationmodel.contacts/contact_yomidisplayname.md index 8198c68390..38c3e222f9 100644 --- a/windows.applicationmodel.contacts/contact_yomidisplayname.md +++ b/windows.applicationmodel.contacts/contact_yomidisplayname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.YomiDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.YomiDisplayName ## -description Gets the Yomi (phonetic Japanese equivalent) display name for a contact. ## -property-value The Yomi display name for a contact. ## -remarks Windows calculates the [YomiDisplayName](contact_yomidisplayname.md) property by using the values from the [YomiGivenName](contact_yomigivenname.md) and [YomiFamilyName](contact_yomifamilyname.md) properties. The calculation for [YomiDisplayName](contact_yomidisplayname.md) takes into account different locale hints such as script of the text in the names, resource context, and default user locale to determine the proper formatting template for the name. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.YomiDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.YomiDisplayName + +## -description +Gets the Yomi (phonetic Japanese equivalent) display name for a contact. + +## -property-value +The Yomi display name for a contact. + +## -remarks +Windows calculates the [YomiDisplayName](contact_yomidisplayname.md) property by using the values from the [YomiGivenName](contact_yomigivenname.md) and [YomiFamilyName](contact_yomifamilyname.md) properties. The calculation for [YomiDisplayName](contact_yomidisplayname.md) takes into account different locale hints such as script of the text in the names, resource context, and default user locale to determine the proper formatting template for the name. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_yomifamilyname.md b/windows.applicationmodel.contacts/contact_yomifamilyname.md index b96e56f774..828ea8c03c 100644 --- a/windows.applicationmodel.contacts/contact_yomifamilyname.md +++ b/windows.applicationmodel.contacts/contact_yomifamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.YomiFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.YomiFamilyName ## -description Gets the Yomi (phonetic Japanese equivalent) family name for a contact. The maximum string length for the Yomi family name is 120 characters. ## -property-value The Yomi family name for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.YomiFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.YomiFamilyName + +## -description +Gets the Yomi (phonetic Japanese equivalent) family name for a contact. The maximum string length for the Yomi family name is 120 characters. + +## -property-value +The Yomi family name for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contact_yomigivenname.md b/windows.applicationmodel.contacts/contact_yomigivenname.md index 5e3090d413..2fb9786c7c 100644 --- a/windows.applicationmodel.contacts/contact_yomigivenname.md +++ b/windows.applicationmodel.contacts/contact_yomigivenname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.Contact.YomiGivenName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.Contact.YomiGivenName ## -description Gets the Yomi (phonetic Japanese equivalent) given name for a contact. The maximum string length for the Yomi given name is 120 characters. ## -property-value The Yomi given name for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.Contact.YomiGivenName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.Contact.YomiGivenName + +## -description +Gets the Yomi (phonetic Japanese equivalent) given name for a contact. The maximum string length for the Yomi given name is 120 characters. + +## -property-value +The Yomi given name for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress.md b/windows.applicationmodel.contacts/contactaddress.md index d12341ba5c..dbedfa5240 100644 --- a/windows.applicationmodel.contacts/contactaddress.md +++ b/windows.applicationmodel.contacts/contactaddress.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactAddress --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactAddress ## -description Represents the address of a contact. ## -remarks For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151), [Addresses](contact_addresses.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactAddress +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress + +## -description +Represents the address of a contact. + +## -remarks +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151), [Addresses](contact_addresses.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactaddress_contactaddress_1221375020.md b/windows.applicationmodel.contacts/contactaddress_contactaddress_1221375020.md index de4faba806..eb1713db23 100644 --- a/windows.applicationmodel.contacts/contactaddress_contactaddress_1221375020.md +++ b/windows.applicationmodel.contacts/contactaddress_contactaddress_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAddress.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAddress.ContactAddress ## -description Initializes a new instance of a [ContactAddress](contactaddress.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAddress.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.ContactAddress + +## -description +Initializes a new instance of a [ContactAddress](contactaddress.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_country.md b/windows.applicationmodel.contacts/contactaddress_country.md index d8c5e1e0ce..a8d8b626a6 100644 --- a/windows.applicationmodel.contacts/contactaddress_country.md +++ b/windows.applicationmodel.contacts/contactaddress_country.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Country --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.Country ## -description Gets and sets the country of a contact address. The maximum string length for the country is 1024 characters. ## -property-value The country of a contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Country +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.Country + +## -description +Gets and sets the country of a contact address. The maximum string length for the country is 1024 characters. + +## -property-value +The country of a contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_description.md b/windows.applicationmodel.contacts/contactaddress_description.md index d4a4dad3f4..a9a14496a8 100644 --- a/windows.applicationmodel.contacts/contactaddress_description.md +++ b/windows.applicationmodel.contacts/contactaddress_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.Description ## -description Gets and sets the description of a contact address. The maximum string length for the description is 512 characters. ## -property-value The description of a contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.Description + +## -description +Gets and sets the description of a contact address. The maximum string length for the description is 512 characters. + +## -property-value +The description of a contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_kind.md b/windows.applicationmodel.contacts/contactaddress_kind.md index b14b89a60a..10ee5d5745 100644 --- a/windows.applicationmodel.contacts/contactaddress_kind.md +++ b/windows.applicationmodel.contacts/contactaddress_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.Kind ## -description Gets and sets the kind of contact address. ## -property-value A [ContactAddressKind](contactaddresskind.md)-typed value that indicates the type of contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.Kind + +## -description +Gets and sets the kind of contact address. + +## -property-value +A [ContactAddressKind](contactaddresskind.md)-typed value that indicates the type of contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_locality.md b/windows.applicationmodel.contacts/contactaddress_locality.md index af736d2908..2b9eee0fda 100644 --- a/windows.applicationmodel.contacts/contactaddress_locality.md +++ b/windows.applicationmodel.contacts/contactaddress_locality.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Locality --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.Locality ## -description Gets and sets the locality of a contact address. The maximum string length for the locality is 1024 characters. ## -property-value The locality of a contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Locality +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.Locality + +## -description +Gets and sets the locality of a contact address. The maximum string length for the locality is 1024 characters. + +## -property-value +The locality of a contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_postalcode.md b/windows.applicationmodel.contacts/contactaddress_postalcode.md index 5452dd88f8..f8ffa8c2f9 100644 --- a/windows.applicationmodel.contacts/contactaddress_postalcode.md +++ b/windows.applicationmodel.contacts/contactaddress_postalcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.PostalCode --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.PostalCode ## -description Gets and sets the postal code of a contact address. The maximum string length for the postal code is 1024 characters. ## -property-value The postal code of a contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.PostalCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.PostalCode + +## -description +Gets and sets the postal code of a contact address. The maximum string length for the postal code is 1024 characters. + +## -property-value +The postal code of a contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_region.md b/windows.applicationmodel.contacts/contactaddress_region.md index 6d74015064..bd8aca078c 100644 --- a/windows.applicationmodel.contacts/contactaddress_region.md +++ b/windows.applicationmodel.contacts/contactaddress_region.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Region --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.Region ## -description Gets and sets the region of a contact address. The maximum string length for the region is 1024 characters. ## -property-value The region of a contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.Region +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.Region + +## -description +Gets and sets the region of a contact address. The maximum string length for the region is 1024 characters. + +## -property-value +The region of a contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactaddress_streetaddress.md b/windows.applicationmodel.contacts/contactaddress_streetaddress.md index 7972269884..d220913209 100644 --- a/windows.applicationmodel.contacts/contactaddress_streetaddress.md +++ b/windows.applicationmodel.contacts/contactaddress_streetaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.StreetAddress --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAddress.StreetAddress ## -description Gets and sets the street address of a contact address. The maximum string length for the street address is 1024 characters. ## -property-value The street address of a contact address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAddress.StreetAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAddress.StreetAddress + +## -description +Gets and sets the street address of a contact address. The maximum string length for the street address is 1024 characters. + +## -property-value +The street address of a contact address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation.md b/windows.applicationmodel.contacts/contactannotation.md index 4f7649d3f9..fb15311783 100644 --- a/windows.applicationmodel.contacts/contactannotation.md +++ b/windows.applicationmodel.contacts/contactannotation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactAnnotation --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactAnnotation ## -description Provides a way to tag existing user contacts with additional information, specifying that your app can perform some [SupportedOperations](contactannotation_supportedoperations.md) for this particular contact. ## -remarks ## -examples ## -see-also [Contact Card integration sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703783) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactAnnotation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation + +## -description +Provides a way to tag existing user contacts with additional information, specifying that your app can perform some [SupportedOperations](contactannotation_supportedoperations.md) for this particular contact. + +## -remarks + +## -examples + +## -see-also +[Contact Card integration sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703783) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactannotation_annotationlistid.md b/windows.applicationmodel.contacts/contactannotation_annotationlistid.md index d13356136e..33df3443df 100644 --- a/windows.applicationmodel.contacts/contactannotation_annotationlistid.md +++ b/windows.applicationmodel.contacts/contactannotation_annotationlistid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.AnnotationListId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.AnnotationListId ## -description Gets the ID for the parent [ContactAnnotationList](contactannotationlist.md) that this [ContactAnnotation](contactannotation.md) is contained within. ## -property-value The ID for the parent [ContactAnnotationList](contactannotationlist.md) that this [ContactAnnotation](contactannotation.md) is contained within. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.AnnotationListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.AnnotationListId + +## -description +Gets the ID for the parent [ContactAnnotationList](contactannotationlist.md) that this [ContactAnnotation](contactannotation.md) is contained within. + +## -property-value +The ID for the parent [ContactAnnotationList](contactannotationlist.md) that this [ContactAnnotation](contactannotation.md) is contained within. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_contactannotation_1221375020.md b/windows.applicationmodel.contacts/contactannotation_contactannotation_1221375020.md index ba2ed3c629..b0a61b5d69 100644 --- a/windows.applicationmodel.contacts/contactannotation_contactannotation_1221375020.md +++ b/windows.applicationmodel.contacts/contactannotation_contactannotation_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotation.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.ContactAnnotation ## -description Initializes a new instance of the [ContactAnnotation](contactannotation.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotation.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.ContactAnnotation + +## -description +Initializes a new instance of the [ContactAnnotation](contactannotation.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_contactid.md b/windows.applicationmodel.contacts/contactannotation_contactid.md index c596ee806f..1fc0f60d93 100644 --- a/windows.applicationmodel.contacts/contactannotation_contactid.md +++ b/windows.applicationmodel.contacts/contactannotation_contactid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.ContactId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.ContactId ## -description Gets or set the ID for the [Contact](contact.md) to which this [ContactAnnotation](contactannotation.md) applies. ## -property-value The ID for the [Contact](contact.md) to which this [ContactAnnotation](contactannotation.md) applies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.ContactId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.ContactId + +## -description +Gets or set the ID for the [Contact](contact.md) to which this [ContactAnnotation](contactannotation.md) applies. + +## -property-value +The ID for the [Contact](contact.md) to which this [ContactAnnotation](contactannotation.md) applies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_id.md b/windows.applicationmodel.contacts/contactannotation_id.md index 7e7c6a7300..1da21269b1 100644 --- a/windows.applicationmodel.contacts/contactannotation_id.md +++ b/windows.applicationmodel.contacts/contactannotation_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.Id --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.Id ## -description Gets the ID for this [ContactAnnotation](contactannotation.md). ## -property-value The ID for this [ContactAnnotation](contactannotation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.Id + +## -description +Gets the ID for this [ContactAnnotation](contactannotation.md). + +## -property-value +The ID for this [ContactAnnotation](contactannotation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_isdisabled.md b/windows.applicationmodel.contacts/contactannotation_isdisabled.md index d4a9f53ac2..310855206c 100644 --- a/windows.applicationmodel.contacts/contactannotation_isdisabled.md +++ b/windows.applicationmodel.contacts/contactannotation_isdisabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.IsDisabled --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.IsDisabled ## -description Gets a Boolean value indicating if this [ContactAnnotation](contactannotation.md) has been disabled by the user. ## -property-value Boolean value indicating if this [ContactAnnotation](contactannotation.md) has been disabled by the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.IsDisabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.IsDisabled + +## -description +Gets a Boolean value indicating if this [ContactAnnotation](contactannotation.md) has been disabled by the user. + +## -property-value +Boolean value indicating if this [ContactAnnotation](contactannotation.md) has been disabled by the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_providerproperties.md b/windows.applicationmodel.contacts/contactannotation_providerproperties.md index fc4cd4f9b8..5f9cd089eb 100644 --- a/windows.applicationmodel.contacts/contactannotation_providerproperties.md +++ b/windows.applicationmodel.contacts/contactannotation_providerproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.ProviderProperties --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.ProviderProperties ## -description Provides a place to store data to be used by the app when interacting with a service provider. ## -property-value Data to be used by the app when interacting with a service provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.ProviderProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.ProviderProperties + +## -description +Provides a place to store data to be used by the app when interacting with a service provider. + +## -property-value +Data to be used by the app when interacting with a service provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_remoteid.md b/windows.applicationmodel.contacts/contactannotation_remoteid.md index ecef4d6944..ca8477282b 100644 --- a/windows.applicationmodel.contacts/contactannotation_remoteid.md +++ b/windows.applicationmodel.contacts/contactannotation_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.RemoteId ## -description Gets or sets an ID that can be used by a service provider to access the corresponding entity in their remote system. ## -property-value An ID that can be used by a service provider to access the corresponding entity in their remote system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.RemoteId + +## -description +Gets or sets an ID that can be used by a service provider to access the corresponding entity in their remote system. + +## -property-value +An ID that can be used by a service provider to access the corresponding entity in their remote system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotation_supportedoperations.md b/windows.applicationmodel.contacts/contactannotation_supportedoperations.md index 82ea0dcf68..26a2a3d740 100644 --- a/windows.applicationmodel.contacts/contactannotation_supportedoperations.md +++ b/windows.applicationmodel.contacts/contactannotation_supportedoperations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.SupportedOperations --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotation.SupportedOperations ## -description Gets or sets the group of [ContactAnnotationOperations](contactannotationoperations.md) supported by this [ContactAnnotation](contactannotation.md). ## -property-value The group of [ContactAnnotationOperations](contactannotationoperations.md) supported by this [ContactAnnotation](contactannotation.md). ## -remarks [ContactAnnotationOperations](contactannotationoperations.md) values can be combined into a single value by using the OR operator to make a list of supported operations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.SupportedOperations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.SupportedOperations + +## -description +Gets or sets the group of [ContactAnnotationOperations](contactannotationoperations.md) supported by this [ContactAnnotation](contactannotation.md). + +## -property-value +The group of [ContactAnnotationOperations](contactannotationoperations.md) supported by this [ContactAnnotation](contactannotation.md). + +## -remarks +[ContactAnnotationOperations](contactannotationoperations.md) values can be combined into a single value by using the OR operator to make a list of supported operations. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist.md b/windows.applicationmodel.contacts/contactannotationlist.md index ae553ba8b6..0be0f5ceb2 100644 --- a/windows.applicationmodel.contacts/contactannotationlist.md +++ b/windows.applicationmodel.contacts/contactannotationlist.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactAnnotationList --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList ## -description Represents a list of [ContactAnnotation](contactannotation.md) objects. ## -remarks Call one of the following methods to create or get an existing [ContactAnnotationList](contactannotationlist.md): + [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync_777171367.md) + [CreateAnnotationListAsync(String)](contactannotationstore_createannotationlistasync_2010335367.md) + [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md) + [FindAnnotationListsAsync](contactannotationstore_findannotationlistsasync.md) ## -examples ## -see-also [Contact Card integration sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703783) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactAnnotationList +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList + +## -description +Represents a list of [ContactAnnotation](contactannotation.md) objects. + +## -remarks +Call one of the following methods to create or get an existing [ContactAnnotationList](contactannotationlist.md): + + ++ [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync_777171367.md) ++ [CreateAnnotationListAsync(String)](contactannotationstore_createannotationlistasync_2010335367.md) ++ [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md) ++ [FindAnnotationListsAsync](contactannotationstore_findannotationlistsasync.md) + + +## -examples + +## -see-also +[Contact Card integration sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703783) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactannotationlist_deleteannotationasync_860175916.md b/windows.applicationmodel.contacts/contactannotationlist_deleteannotationasync_860175916.md index ab82eb3397..4988e6da03 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_deleteannotationasync_860175916.md +++ b/windows.applicationmodel.contacts/contactannotationlist_deleteannotationasync_860175916.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAnnotationAsync(Windows.ApplicationModel.Contacts.ContactAnnotation) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAnnotationAsync ## -description Asynchronously deletes the specified [ContactAnnotation](contactannotation.md) from the list. ## -parameters ### -param annotation The annotation to delete from the list. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAnnotationAsync(Windows.ApplicationModel.Contacts.ContactAnnotation) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAnnotationAsync + +## -description +Asynchronously deletes the specified [ContactAnnotation](contactannotation.md) from the list. + +## -parameters +### -param annotation +The annotation to delete from the list. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_deleteasync_1247887881.md b/windows.applicationmodel.contacts/contactannotationlist_deleteasync_1247887881.md index f0463aaa75..6daed88c2c 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_deleteasync_1247887881.md +++ b/windows.applicationmodel.contacts/contactannotationlist_deleteasync_1247887881.md @@ -1,3 +1,95 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAsync ## -description Asynchronously deletes this [ContactAnnotationList](contactannotationlist.md) from the [ContactAnnotationStore](contactannotationstore.md). ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. ```csharp public async Task CreateAnnotationList() { // Get the data store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Create a new list. ContactAnnotationList list = await store.CreateAnnotationListAsync(); // Find the list to verify it was created. IReadOnlyList lists = await store.FindAnnotationListsAsync(); for (int i = 0; i < lists.Count; i++) { // Do the IDs match? if (list.Id == lists[i].Id) { // Found it! Return the new list. return(list); } } // List not created, return null. return(null); } public async Task DeleteAnnotationList(string listId) { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Find the list. ContactAnnotationList list = await store.GetAnnotationListAsync(listId); // Make sure we got it. if (list.Id == listId) { // Delete the list. await list.DeleteAsync(); return true; } return false; } public async Task DeleteAllAnnotationLists() { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); IReadOnlyList lists = await store.FindAnnotationListsAsync(); // Make sure at least one annotation list exists. if (lists.Count > 0) { // Find the list. for (int i = 0; i < lists.Count; i++) { await lists[i].DeleteAsync(); } return true; } return false; } ``` ## -see-also [RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationStore](contactannotationstore.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.DeleteAsync + +## -description +Asynchronously deletes this [ContactAnnotationList](contactannotationlist.md) from the [ContactAnnotationStore](contactannotationstore.md). + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples +The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. + +```csharp +public async Task CreateAnnotationList() +{ + // Get the data store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Create a new list. + ContactAnnotationList list = await store.CreateAnnotationListAsync(); + + // Find the list to verify it was created. + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + for (int i = 0; i < lists.Count; i++) + { + // Do the IDs match? + if (list.Id == lists[i].Id) + { + // Found it! Return the new list. + return(list); + } + } + + // List not created, return null. + return(null); +} + +public async Task DeleteAnnotationList(string listId) +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Find the list. + ContactAnnotationList list = await store.GetAnnotationListAsync(listId); + + // Make sure we got it. + if (list.Id == listId) + { + // Delete the list. + await list.DeleteAsync(); + return true; + } + + return false; +} + +public async Task DeleteAllAnnotationLists() +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + // Make sure at least one annotation list exists. + if (lists.Count > 0) + { + // Find the list. + for (int i = 0; i < lists.Count; i++) + { + await lists[i].DeleteAsync(); + } + + return true; + } + + return false; +} + +``` + + + +## -see-also +[RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationStore](contactannotationstore.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactannotationlist_findannotationsasync_1241474254.md b/windows.applicationmodel.contacts/contactannotationlist_findannotationsasync_1241474254.md index f2116a3ef7..fd84937ca7 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_findannotationsasync_1241474254.md +++ b/windows.applicationmodel.contacts/contactannotationlist_findannotationsasync_1241474254.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsAsync ## -description Asynchronously gets the list of [ContactAnnotation](contactannotation.md) objects. ## -returns The list of [ContactAnnotation](contactannotation.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsAsync + +## -description +Asynchronously gets the list of [ContactAnnotation](contactannotation.md) objects. + +## -returns +The list of [ContactAnnotation](contactannotation.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_findannotationsbyremoteidasync_1286010238.md b/windows.applicationmodel.contacts/contactannotationlist_findannotationsbyremoteidasync_1286010238.md index c2f3de8186..0f4ae103a8 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_findannotationsbyremoteidasync_1286010238.md +++ b/windows.applicationmodel.contacts/contactannotationlist_findannotationsbyremoteidasync_1286010238.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsByRemoteIdAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsByRemoteIdAsync ## -description Gets the list of [ContactAnnotation](contactannotation.md) objects containing the specified remote ID property. ## -parameters ### -param remoteId The remote ID used to find the [ContactAnnotation](contactannotation.md) objects. ## -returns The list of [ContactAnnotation](contactannotation.md) objects containing the specified remote ID property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsByRemoteIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.FindAnnotationsByRemoteIdAsync + +## -description +Gets the list of [ContactAnnotation](contactannotation.md) objects containing the specified remote ID property. + +## -parameters +### -param remoteId +The remote ID used to find the [ContactAnnotation](contactannotation.md) objects. + +## -returns +The list of [ContactAnnotation](contactannotation.md) objects containing the specified remote ID property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_getannotationasync_111601735.md b/windows.applicationmodel.contacts/contactannotationlist_getannotationasync_111601735.md index d7fc0dece8..a305407c96 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_getannotationasync_111601735.md +++ b/windows.applicationmodel.contacts/contactannotationlist_getannotationasync_111601735.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.GetAnnotationAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.GetAnnotationAsync ## -description Gets the [ContactAnnotation](contactannotation.md) with the specified [Id](contactannotation_id.md). ## -parameters ### -param annotationId The [ContactAnnotation.Id](contactannotation_id.md) used to identify the [ContactAnnotation](contactannotation.md). ## -returns The [ContactAnnotation](contactannotation.md) with the specified ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.GetAnnotationAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.GetAnnotationAsync + +## -description +Gets the [ContactAnnotation](contactannotation.md) with the specified [Id](contactannotation_id.md). + +## -parameters +### -param annotationId +The [ContactAnnotation.Id](contactannotation_id.md) used to identify the [ContactAnnotation](contactannotation.md). + +## -returns +The [ContactAnnotation](contactannotation.md) with the specified ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_id.md b/windows.applicationmodel.contacts/contactannotationlist_id.md index 3ede1fea8f..a908bee40b 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_id.md +++ b/windows.applicationmodel.contacts/contactannotationlist_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotationList.Id --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.Id ## -description Gets the ID for this [ContactAnnotationList](contactannotationlist.md). ## -property-value The ID for this [ContactAnnotationList](contactannotationlist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotationList.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.Id + +## -description +Gets the ID for this [ContactAnnotationList](contactannotationlist.md). + +## -property-value +The ID for this [ContactAnnotationList](contactannotationlist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_providerpackagefamilyname.md b/windows.applicationmodel.contacts/contactannotationlist_providerpackagefamilyname.md index 825cf83354..a24fc505a6 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_providerpackagefamilyname.md +++ b/windows.applicationmodel.contacts/contactannotationlist_providerpackagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotationList.ProviderPackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.ProviderPackageFamilyName ## -description Gets the unique identifier for the app package that created the [ContactAnnotationList](contactannotationlist.md). ## -property-value The unique identifier for the app package that created the [ContactAnnotationList](contactannotationlist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotationList.ProviderPackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.ProviderPackageFamilyName + +## -description +Gets the unique identifier for the app package that created the [ContactAnnotationList](contactannotationlist.md). + +## -property-value +The unique identifier for the app package that created the [ContactAnnotationList](contactannotationlist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_trysaveannotationasync_1332937891.md b/windows.applicationmodel.contacts/contactannotationlist_trysaveannotationasync_1332937891.md index e39a90aebb..1efd9567f7 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_trysaveannotationasync_1332937891.md +++ b/windows.applicationmodel.contacts/contactannotationlist_trysaveannotationasync_1332937891.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.TrySaveAnnotationAsync(Windows.ApplicationModel.Contacts.ContactAnnotation) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.TrySaveAnnotationAsync ## -description Asynchronously attempts to save the [ContactAnnotation](contactannotation.md) to the [ContactAnnotationList](contactannotationlist.md). ## -parameters ### -param annotation The annotation to save to the list. ## -returns True if the save was successful, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationList.TrySaveAnnotationAsync(Windows.ApplicationModel.Contacts.ContactAnnotation) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.TrySaveAnnotationAsync + +## -description +Asynchronously attempts to save the [ContactAnnotation](contactannotation.md) to the [ContactAnnotationList](contactannotationlist.md). + +## -parameters +### -param annotation +The annotation to save to the list. + +## -returns +True if the save was successful, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationlist_userdataaccountid.md b/windows.applicationmodel.contacts/contactannotationlist_userdataaccountid.md index 7868303230..3669b0b515 100644 --- a/windows.applicationmodel.contacts/contactannotationlist_userdataaccountid.md +++ b/windows.applicationmodel.contacts/contactannotationlist_userdataaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotationList.UserDataAccountId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactAnnotationList.UserDataAccountId ## -description Gets the ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) used by the app. ## -property-value The ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) used by the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotationList.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationList.UserDataAccountId + +## -description +Gets the ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) used by the app. + +## -property-value +The ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) used by the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationstore.md b/windows.applicationmodel.contacts/contactannotationstore.md index 10218f288e..79e25ab427 100644 --- a/windows.applicationmodel.contacts/contactannotationstore.md +++ b/windows.applicationmodel.contacts/contactannotationstore.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactAnnotationStore --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore ## -description Represents a data store that contains contact annotations. ## -remarks Call [ContactManager.RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md) to get an instance of [ContactAnnotationStore](contactannotationstore.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactAnnotationStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore + +## -description +Represents a data store that contains contact annotations. + +## -remarks +Call [ContactManager.RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md) to get an instance of [ContactAnnotationStore](contactannotationstore.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_2010335367.md b/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_2010335367.md index f2ce5f7a55..8b0f5a4805 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_2010335367.md +++ b/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_2010335367.md @@ -1,3 +1,100 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync ## -description Asynchronously creates a [ContactAnnotationList](contactannotationlist.md) and associates it with the specified user data account ID. ## -parameters ### -param userDataAccountId The ID for the user data account with which to associate the new [ContactAnnotationList](contactannotationlist.md). The user data account must be owned by this app. ## -returns The newly created [ContactAnnotationList](contactannotationlist.md). ## -remarks The user data account specified in *userDataAccountId* must be owned this app. ## -examples The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. ```csharp public async Task CreateAnnotationList() { // Get the data store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Create a new list. ContactAnnotationList list = await store.CreateAnnotationListAsync(); // Find the list to verify it was created. IReadOnlyList lists = await store.FindAnnotationListsAsync(); for (int i = 0; i < lists.Count; i++) { // Do the IDs match? if (list.Id == lists[i].Id) { // Found it! Return the new list. return(list); } } // List not created, return null. return(null); } public async Task DeleteAnnotationList(string listId) { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Find the list. ContactAnnotationList list = await store.GetAnnotationListAsync(listId); // Make sure we got it. if (list.Id == listId) { // Delete the list. await list.DeleteAsync(); return true; } return false; } public async Task DeleteAllAnnotationLists() { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); IReadOnlyList lists = await store.FindAnnotationListsAsync(); // Make sure at least one annotation list exists. if (lists.Count > 0) { // Find the list. for (int i = 0; i < lists.Count; i++) { await lists[i].DeleteAsync(); } return true; } return false; } ``` ## -see-also [RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync_777171367.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md), [FindAnnotationListsAsync](contactannotationstore_findannotationlistsasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync + +## -description +Asynchronously creates a [ContactAnnotationList](contactannotationlist.md) and associates it with the specified user data account ID. + +## -parameters +### -param userDataAccountId +The ID for the user data account with which to associate the new [ContactAnnotationList](contactannotationlist.md). The user data account must be owned by this app. + +## -returns +The newly created [ContactAnnotationList](contactannotationlist.md). + +## -remarks +The user data account specified in *userDataAccountId* must be owned this app. + +## -examples +The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. + +```csharp +public async Task CreateAnnotationList() +{ + // Get the data store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Create a new list. + ContactAnnotationList list = await store.CreateAnnotationListAsync(); + + // Find the list to verify it was created. + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + for (int i = 0; i < lists.Count; i++) + { + // Do the IDs match? + if (list.Id == lists[i].Id) + { + // Found it! Return the new list. + return(list); + } + } + + // List not created, return null. + return(null); +} + +public async Task DeleteAnnotationList(string listId) +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Find the list. + ContactAnnotationList list = await store.GetAnnotationListAsync(listId); + + // Make sure we got it. + if (list.Id == listId) + { + // Delete the list. + await list.DeleteAsync(); + return true; + } + + return false; +} + +public async Task DeleteAllAnnotationLists() +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + // Make sure at least one annotation list exists. + if (lists.Count > 0) + { + // Find the list. + for (int i = 0; i < lists.Count; i++) + { + await lists[i].DeleteAsync(); + } + + return true; + } + + return false; +} + +``` + + + +## -see-also +[RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync_777171367.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md), [FindAnnotationListsAsync](contactannotationstore_findannotationlistsasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_777171367.md b/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_777171367.md index 3409231b5f..516a4cfa8e 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_777171367.md +++ b/windows.applicationmodel.contacts/contactannotationstore_createannotationlistasync_777171367.md @@ -1,3 +1,95 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync ## -description Asynchronously creates a [ContactAnnotationList](contactannotationlist.md). ## -returns The newly created [ContactAnnotationList](contactannotationlist.md). ## -remarks ## -examples The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. ```csharp public async Task CreateAnnotationList() { // Get the data store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Create a new list. ContactAnnotationList list = await store.CreateAnnotationListAsync(); // Find the list to verify it was created. IReadOnlyList lists = await store.FindAnnotationListsAsync(); for (int i = 0; i < lists.Count; i++) { // Do the IDs match? if (list.Id == lists[i].Id) { // Found it! Return the new list. return(list); } } // List not created, return null. return(null); } public async Task DeleteAnnotationList(string listId) { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Find the list. ContactAnnotationList list = await store.GetAnnotationListAsync(listId); // Make sure we got it. if (list.Id == listId) { // Delete the list. await list.DeleteAsync(); return true; } return false; } public async Task DeleteAllAnnotationLists() { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); IReadOnlyList lists = await store.FindAnnotationListsAsync(); // Make sure at least one annotation list exists. if (lists.Count > 0) { // Find the list. for (int i = 0; i < lists.Count; i++) { await lists[i].DeleteAsync(); } return true; } return false; } ``` ## -see-also [RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync(String)](contactannotationstore_createannotationlistasync_2010335367.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md), [FindAnnotationListsAsync](contactannotationstore_findannotationlistsasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.CreateAnnotationListAsync + +## -description +Asynchronously creates a [ContactAnnotationList](contactannotationlist.md). + +## -returns +The newly created [ContactAnnotationList](contactannotationlist.md). + +## -remarks + +## -examples +The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. + +```csharp +public async Task CreateAnnotationList() +{ + // Get the data store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Create a new list. + ContactAnnotationList list = await store.CreateAnnotationListAsync(); + + // Find the list to verify it was created. + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + for (int i = 0; i < lists.Count; i++) + { + // Do the IDs match? + if (list.Id == lists[i].Id) + { + // Found it! Return the new list. + return(list); + } + } + + // List not created, return null. + return(null); +} + +public async Task DeleteAnnotationList(string listId) +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Find the list. + ContactAnnotationList list = await store.GetAnnotationListAsync(listId); + + // Make sure we got it. + if (list.Id == listId) + { + // Delete the list. + await list.DeleteAsync(); + return true; + } + + return false; +} + +public async Task DeleteAllAnnotationLists() +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + // Make sure at least one annotation list exists. + if (lists.Count > 0) + { + // Find the list. + for (int i = 0; i < lists.Count; i++) + { + await lists[i].DeleteAsync(); + } + + return true; + } + + return false; +} + +``` + + + +## -see-also +[RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync(String)](contactannotationstore_createannotationlistasync_2010335367.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md), [FindAnnotationListsAsync](contactannotationstore_findannotationlistsasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactannotationstore_disableannotationasync_1912370886.md b/windows.applicationmodel.contacts/contactannotationstore_disableannotationasync_1912370886.md index 3ef3b7df4c..371c13325b 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_disableannotationasync_1912370886.md +++ b/windows.applicationmodel.contacts/contactannotationstore_disableannotationasync_1912370886.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.DisableAnnotationAsync(Windows.ApplicationModel.Contacts.ContactAnnotation) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.DisableAnnotationAsync ## -description Asynchronously disables the specified [ContactAnnotation](contactannotation.md), usually as a result of user input. ## -parameters ### -param annotation The annotation to disable. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.DisableAnnotationAsync(Windows.ApplicationModel.Contacts.ContactAnnotation) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.DisableAnnotationAsync + +## -description +Asynchronously disables the specified [ContactAnnotation](contactannotation.md), usually as a result of user input. + +## -parameters +### -param annotation +The annotation to disable. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationstore_findannotationlistsasync_660284737.md b/windows.applicationmodel.contacts/contactannotationstore_findannotationlistsasync_660284737.md index 65b28bd248..46e0875a5d 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_findannotationlistsasync_660284737.md +++ b/windows.applicationmodel.contacts/contactannotationstore_findannotationlistsasync_660284737.md @@ -1,3 +1,95 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationListsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationListsAsync ## -description Asynchronously gets the list of [ContactAnnotationList](contactannotationlist.md) objects for the app. ## -returns The list of [ContactAnnotationList](contactannotationlist.md) objects. ## -remarks ## -examples The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. ```csharp public async Task CreateAnnotationList() { // Get the data store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Create a new list. ContactAnnotationList list = await store.CreateAnnotationListAsync(); // Find the list to verify it was created. IReadOnlyList lists = await store.FindAnnotationListsAsync(); for (int i = 0; i < lists.Count; i++) { // Do the IDs match? if (list.Id == lists[i].Id) { // Found it! Return the new list. return(list); } } // List not created, return null. return(null); } public async Task DeleteAnnotationList(string listId) { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Find the list. ContactAnnotationList list = await store.GetAnnotationListAsync(listId); // Make sure we got it. if (list.Id == listId) { // Delete the list. await list.DeleteAsync(); return true; } return false; } public async Task DeleteAllAnnotationLists() { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); IReadOnlyList lists = await store.FindAnnotationListsAsync(); // Make sure at least one annotation list exists. if (lists.Count > 0) { // Find the list. for (int i = 0; i < lists.Count; i++) { await lists[i].DeleteAsync(); } return true; } return false; } ``` ## -see-also [RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationListsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationListsAsync + +## -description +Asynchronously gets the list of [ContactAnnotationList](contactannotationlist.md) objects for the app. + +## -returns +The list of [ContactAnnotationList](contactannotationlist.md) objects. + +## -remarks + +## -examples +The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. + +```csharp +public async Task CreateAnnotationList() +{ + // Get the data store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Create a new list. + ContactAnnotationList list = await store.CreateAnnotationListAsync(); + + // Find the list to verify it was created. + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + for (int i = 0; i < lists.Count; i++) + { + // Do the IDs match? + if (list.Id == lists[i].Id) + { + // Found it! Return the new list. + return(list); + } + } + + // List not created, return null. + return(null); +} + +public async Task DeleteAnnotationList(string listId) +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Find the list. + ContactAnnotationList list = await store.GetAnnotationListAsync(listId); + + // Make sure we got it. + if (list.Id == listId) + { + // Delete the list. + await list.DeleteAsync(); + return true; + } + + return false; +} + +public async Task DeleteAllAnnotationLists() +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + // Make sure at least one annotation list exists. + if (lists.Count > 0) + { + // Find the list. + for (int i = 0; i < lists.Count; i++) + { + await lists[i].DeleteAsync(); + } + + return true; + } + + return false; +} + +``` + + + +## -see-also +[RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync.md), [GetAnnotationListAsync](contactannotationstore_getannotationlistasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactasync_2103647613.md b/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactasync_2103647613.md index a8105d820b..2ee0706f38 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactasync_2103647613.md +++ b/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactasync_2103647613.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationsForContactAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationsForContactAsync ## -description Get the annotations for the specified [Contact](contact.md). ## -parameters ### -param contact The [Contact](contact.md) for which to retrieve annotations. ## -returns The list of [ContactAnnotation](contactannotation.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationsForContactAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationsForContactAsync + +## -description +Get the annotations for the specified [Contact](contact.md). + +## -parameters +### -param contact +The [Contact](contact.md) for which to retrieve annotations. + +## -returns +The list of [ContactAnnotation](contactannotation.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyemailasync_827552050.md b/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyemailasync_827552050.md index 454d6cc333..f6cd342bf5 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyemailasync_827552050.md +++ b/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyemailasync_827552050.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByEmailAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByEmailAsync ## -description Gets a list of [Id](contact_id.md) values based on [Contact](contact.md) objects with a specified email address. ## -parameters ### -param emailAddress The email address used to find the contact [Id](contact_id.md) values. ## -returns The list of [Contact](contact.md) objects containing the specified *emailAddress*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByEmailAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByEmailAsync + +## -description +Gets a list of [Id](contact_id.md) values based on [Contact](contact.md) objects with a specified email address. + +## -parameters +### -param emailAddress +The email address used to find the contact [Id](contact_id.md) values. + +## -returns +The list of [Contact](contact.md) objects containing the specified *emailAddress*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyphonenumberasync_776522506.md b/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyphonenumberasync_776522506.md index c78b549829..8f2cf34ef3 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyphonenumberasync_776522506.md +++ b/windows.applicationmodel.contacts/contactannotationstore_findcontactidsbyphonenumberasync_776522506.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByPhoneNumberAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByPhoneNumberAsync ## -description Gets a list of [Id](contact_id.md) values based on [Contact](contact.md) objects with a specified phone number. ## -parameters ### -param phoneNumber The phone number used to find the contact [Id](contact_id.md) values. ## -returns The list of [Contact](contact.md) objects containing the specified *phoneNumber*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByPhoneNumberAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindContactIdsByPhoneNumberAsync + +## -description +Gets a list of [Id](contact_id.md) values based on [Contact](contact.md) objects with a specified phone number. + +## -parameters +### -param phoneNumber +The phone number used to find the contact [Id](contact_id.md) values. + +## -returns +The list of [Contact](contact.md) objects containing the specified *phoneNumber*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactannotationstore_getannotationlistasync_1462689163.md b/windows.applicationmodel.contacts/contactannotationstore_getannotationlistasync_1462689163.md index b7ebaff038..996bb10156 100644 --- a/windows.applicationmodel.contacts/contactannotationstore_getannotationlistasync_1462689163.md +++ b/windows.applicationmodel.contacts/contactannotationstore_getannotationlistasync_1462689163.md @@ -1,3 +1,99 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.GetAnnotationListAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactAnnotationStore.GetAnnotationListAsync ## -description Asynchronously gets the [ContactAnnotationList](contactannotationlist.md) with the specified ID. ## -parameters ### -param annotationListId The ID of the [ContactAnnotationList](contactannotationlist.md) to get. ## -returns The [ContactAnnotationList](contactannotationlist.md) with the ID specified in *annotationListId*. ## -remarks ## -examples The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. ```csharp public async Task CreateAnnotationList() { // Get the data store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Create a new list. ContactAnnotationList list = await store.CreateAnnotationListAsync(); // Find the list to verify it was created. IReadOnlyList lists = await store.FindAnnotationListsAsync(); for (int i = 0; i < lists.Count; i++) { // Do the IDs match? if (list.Id == lists[i].Id) { // Found it! Return the new list. return(list); } } // List not created, return null. return(null); } public async Task DeleteAnnotationList(string listId) { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); // Find the list. ContactAnnotationList list = await store.GetAnnotationListAsync(listId); // Make sure we got it. if (list.Id == listId) { // Delete the list. await list.DeleteAsync(); return true; } return false; } public async Task DeleteAllAnnotationLists() { // Get the store. ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); IReadOnlyList lists = await store.FindAnnotationListsAsync(); // Make sure at least one annotation list exists. if (lists.Count > 0) { // Find the list. for (int i = 0; i < lists.Count; i++) { await lists[i].DeleteAsync(); } return true; } return false; } ``` ## -see-also [RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.GetAnnotationListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.GetAnnotationListAsync + +## -description +Asynchronously gets the [ContactAnnotationList](contactannotationlist.md) with the specified ID. + +## -parameters +### -param annotationListId +The ID of the [ContactAnnotationList](contactannotationlist.md) to get. + +## -returns +The [ContactAnnotationList](contactannotationlist.md) with the ID specified in *annotationListId*. + +## -remarks + +## -examples +The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store. + +```csharp +public async Task CreateAnnotationList() +{ + // Get the data store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Create a new list. + ContactAnnotationList list = await store.CreateAnnotationListAsync(); + + // Find the list to verify it was created. + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + for (int i = 0; i < lists.Count; i++) + { + // Do the IDs match? + if (list.Id == lists[i].Id) + { + // Found it! Return the new list. + return(list); + } + } + + // List not created, return null. + return(null); +} + +public async Task DeleteAnnotationList(string listId) +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + // Find the list. + ContactAnnotationList list = await store.GetAnnotationListAsync(listId); + + // Make sure we got it. + if (list.Id == listId) + { + // Delete the list. + await list.DeleteAsync(); + return true; + } + + return false; +} + +public async Task DeleteAllAnnotationLists() +{ + // Get the store. + ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite); + + IReadOnlyList lists = await store.FindAnnotationListsAsync(); + + // Make sure at least one annotation list exists. + if (lists.Count > 0) + { + // Find the list. + for (int i = 0; i < lists.Count; i++) + { + await lists[i].DeleteAsync(); + } + + return true; + } + + return false; +} + +``` + + + +## -see-also +[RequestAnnotationStoreAsync](contactmanager_requestannotationstoreasync.md), [ContactAnnotationList](contactannotationlist.md), [CreateAnnotationListAsync](contactannotationstore_createannotationlistasync.md), [DeleteAsync](contactannotationlist_deleteasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactbatch.md b/windows.applicationmodel.contacts/contactbatch.md index c63c9f730a..da04b20dad 100644 --- a/windows.applicationmodel.contacts/contactbatch.md +++ b/windows.applicationmodel.contacts/contactbatch.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactBatch --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactBatch ## -description Represents a group of [Contact](contact.md) objects and server search status. ## -remarks If you are searching local contacts, keep processing until you get a [ContactBatch](contactbatch.md) that has an empty list of [Contacts](contactbatch_contacts.md). If you are searching on a server and you get an empty [Contacts](contactbatch_contacts.md) list, check the [Status](contactbatch_status.md) to make sure there wasn't a server error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactBatch +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactBatch + +## -description +Represents a group of [Contact](contact.md) objects and server search status. + +## -remarks +If you are searching local contacts, keep processing until you get a [ContactBatch](contactbatch.md) that has an empty list of [Contacts](contactbatch_contacts.md). If you are searching on a server and you get an empty [Contacts](contactbatch_contacts.md) list, check the [Status](contactbatch_status.md) to make sure there wasn't a server error. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactbatch_contacts.md b/windows.applicationmodel.contacts/contactbatch_contacts.md index ed8d351915..7e145a99ea 100644 --- a/windows.applicationmodel.contacts/contactbatch_contacts.md +++ b/windows.applicationmodel.contacts/contactbatch_contacts.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactBatch.Contacts --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactBatch.Contacts ## -description Gets the list of [Contact](contact.md) objects returned by a search operation. ## -property-value The list of contacts returned by a search operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactBatch.Contacts +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactBatch.Contacts + +## -description +Gets the list of [Contact](contact.md) objects returned by a search operation. + +## -property-value +The list of contacts returned by a search operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactbatch_status.md b/windows.applicationmodel.contacts/contactbatch_status.md index e74048349e..809a878460 100644 --- a/windows.applicationmodel.contacts/contactbatch_status.md +++ b/windows.applicationmodel.contacts/contactbatch_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactBatch.Status --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactBatch.Status ## -description Gets a [ContactBatchStatus](contactbatchstatus.md) value that indicates if a search was successful or if there was a server error. ## -property-value A [ContactBatchStatus](contactbatchstatus.md) value that indicates if a search was successful or if there was a server error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactBatch.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactBatch.Status + +## -description +Gets a [ContactBatchStatus](contactbatchstatus.md) value that indicates if a search was successful or if there was a server error. + +## -property-value +A [ContactBatchStatus](contactbatchstatus.md) value that indicates if a search was successful or if there was a server error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactcarddelayeddataloader.md b/windows.applicationmodel.contacts/contactcarddelayeddataloader.md index 226dbd0e47..b3b5898472 100644 --- a/windows.applicationmodel.contacts/contactcarddelayeddataloader.md +++ b/windows.applicationmodel.contacts/contactcarddelayeddataloader.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader ## -description Represents a delayed data loader for a contact card. ## -remarks Call [ContactManager.ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) to show a contact card with delayed data loader. For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). ## -examples ## -see-also [Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [IClosable](../windows.foundation/iclosable.md), [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md), [Contact cards sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624040) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader + +## -description +Represents a delayed data loader for a contact card. + +## -remarks +Call [ContactManager.ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) to show a contact card with delayed data loader. + +For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). + +## -examples + +## -see-also +[Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [IClosable](../windows.foundation/iclosable.md), [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md), [Contact cards sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624040) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactcarddelayeddataloader_close_811482585.md b/windows.applicationmodel.contacts/contactcarddelayeddataloader_close_811482585.md index ae06b8edf4..1d64bf8210 100644 --- a/windows.applicationmodel.contacts/contactcarddelayeddataloader_close_811482585.md +++ b/windows.applicationmodel.contacts/contactcarddelayeddataloader_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.Close --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.Close ## -description Closes the delayed data loader. This informs the contact card to complete the UI (for example, remove any progress indications, like the progress bar) because no more updates to the contact card UI will be requested. The user then can determine that the contact data shown in the UI is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.Close +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.Close + +## -description +Closes the delayed data loader. This informs the contact card to complete the UI (for example, remove any progress indications, like the progress bar) because no more updates to the contact card UI will be requested. The user then can determine that the contact data shown in the UI is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactcarddelayeddataloader_setdata_1176099425.md b/windows.applicationmodel.contacts/contactcarddelayeddataloader_setdata_1176099425.md index 4fa3f69819..950b684137 100644 --- a/windows.applicationmodel.contacts/contactcarddelayeddataloader_setdata_1176099425.md +++ b/windows.applicationmodel.contacts/contactcarddelayeddataloader_setdata_1176099425.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.SetData(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.SetData ## -description Updates the contact card with the [Contact](contact.md) object and completes the contact card UI. ## -parameters ### -param contact The contact to update the contact card with. ## -remarks > [!NOTE] > The contact card will time out within four seconds after [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) returns. So, if [SetData](contactcarddelayeddataloader_setdata.md) isn't called within this four second interval, the contact card UI becomes final, and no more updates can be applied. You can call [SetData](contactcarddelayeddataloader_setdata.md) only once and before you call [Close](contactcarddelayeddataloader_close.md). If you call [SetData](contactcarddelayeddataloader_setdata.md) twice or after [Close](contactcarddelayeddataloader_close.md), [SetData](contactcarddelayeddataloader_setdata.md) fails with an exception; the **HRESULT** error code is **HRESULT_FROM_WIN32(ERROR_INVALID_STATE)**. For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). ## -examples ## -see-also [Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.SetData(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardDelayedDataLoader.SetData + +## -description +Updates the contact card with the [Contact](contact.md) object and completes the contact card UI. + +## -parameters +### -param contact +The contact to update the contact card with. + +## -remarks +> [!NOTE] +> The contact card will time out within four seconds after [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) returns. So, if [SetData](contactcarddelayeddataloader_setdata.md) isn't called within this four second interval, the contact card UI becomes final, and no more updates can be applied. You can call [SetData](contactcarddelayeddataloader_setdata.md) only once and before you call [Close](contactcarddelayeddataloader_close.md). If you call [SetData](contactcarddelayeddataloader_setdata.md) twice or after [Close](contactcarddelayeddataloader_close.md), [SetData](contactcarddelayeddataloader_setdata.md) fails with an exception; the **HRESULT** error code is **HRESULT_FROM_WIN32(ERROR_INVALID_STATE)**. + +For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). + +## -examples + +## -see-also +[Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactcardoptions.md b/windows.applicationmodel.contacts/contactcardoptions.md index 61b30d2abc..77ca9aad33 100644 --- a/windows.applicationmodel.contacts/contactcardoptions.md +++ b/windows.applicationmodel.contacts/contactcardoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactCardOptions --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactCardOptions ## -description Represents data about how to display a mini contact card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactCardOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardOptions + +## -description +Represents data about how to display a mini contact card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactcardoptions_contactcardoptions_1221375020.md b/windows.applicationmodel.contacts/contactcardoptions_contactcardoptions_1221375020.md index b78912c434..1ba73e77ba 100644 --- a/windows.applicationmodel.contacts/contactcardoptions_contactcardoptions_1221375020.md +++ b/windows.applicationmodel.contacts/contactcardoptions_contactcardoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactCardOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactCardOptions.ContactCardOptions ## -description Initializes a new instance of the [ContactCardOptions](contactcardoptions.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactCardOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardOptions.ContactCardOptions + +## -description +Initializes a new instance of the [ContactCardOptions](contactcardoptions.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactcardoptions_headerkind.md b/windows.applicationmodel.contacts/contactcardoptions_headerkind.md index fddb544940..41903646da 100644 --- a/windows.applicationmodel.contacts/contactcardoptions_headerkind.md +++ b/windows.applicationmodel.contacts/contactcardoptions_headerkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactCardOptions.HeaderKind --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactCardOptions.HeaderKind ## -description Gets or sets a value that specifies the type of header to display on the contact card. ## -property-value The type of header to display on the contact card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactCardOptions.HeaderKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardOptions.HeaderKind + +## -description +Gets or sets a value that specifies the type of header to display on the contact card. + +## -property-value +The type of header to display on the contact card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactcardoptions_initialtabkind.md b/windows.applicationmodel.contacts/contactcardoptions_initialtabkind.md index 1ff14ee2a0..9883593f3e 100644 --- a/windows.applicationmodel.contacts/contactcardoptions_initialtabkind.md +++ b/windows.applicationmodel.contacts/contactcardoptions_initialtabkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactCardOptions.InitialTabKind --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactCardOptions.InitialTabKind ## -description Gets or sets a value that indicates which tab to display first on a mini contact card. ## -property-value A value that indicates which tab to display first on a mini contact card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactCardOptions.InitialTabKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardOptions.InitialTabKind + +## -description +Gets or sets a value that indicates which tab to display first on a mini contact card. + +## -property-value +A value that indicates which tab to display first on a mini contact card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactcardoptions_serversearchcontactlistids.md b/windows.applicationmodel.contacts/contactcardoptions_serversearchcontactlistids.md index 9a8d725742..845057605e 100644 --- a/windows.applicationmodel.contacts/contactcardoptions_serversearchcontactlistids.md +++ b/windows.applicationmodel.contacts/contactcardoptions_serversearchcontactlistids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactCardOptions.ServerSearchContactListIds --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactCardOptions.ServerSearchContactListIds ## -description Gets a list to which you can add [ContactList.Id](contactlist_id.md) values to search for on the server. ## -property-value A list to which you can add [ContactList.Id](contactlist_id.md) values to search for on the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactCardOptions.ServerSearchContactListIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactCardOptions.ServerSearchContactListIds + +## -description +Gets a list to which you can add [ContactList.Id](contactlist_id.md) values to search for on the server. + +## -property-value +A list to which you can add [ContactList.Id](contactlist_id.md) values to search for on the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchange.md b/windows.applicationmodel.contacts/contactchange.md index 640a7c59db..56f86032f3 100644 --- a/windows.applicationmodel.contacts/contactchange.md +++ b/windows.applicationmodel.contacts/contactchange.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactChange --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactChange ## -description Represents a change to a [Contact](contact.md). ## -remarks Call [ContactChangeReader.ReadBatchAsync](contactchangereader_readbatchasync.md) to get a list of [ContactChange](contactchange.md) objects. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactChange +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactChange + +## -description +Represents a change to a [Contact](contact.md). + +## -remarks +Call [ContactChangeReader.ReadBatchAsync](contactchangereader_readbatchasync.md) to get a list of [ContactChange](contactchange.md) objects. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchange_changetype.md b/windows.applicationmodel.contacts/contactchange_changetype.md index 3bc43542be..09e538db86 100644 --- a/windows.applicationmodel.contacts/contactchange_changetype.md +++ b/windows.applicationmodel.contacts/contactchange_changetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactChange.ChangeType --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactChange.ChangeType ## -description Gets a value that indicates the type of change that occurred. ## -property-value The type of change that occurred. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactChange.ChangeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactChange.ChangeType + +## -description +Gets a value that indicates the type of change that occurred. + +## -property-value +The type of change that occurred. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchange_contact.md b/windows.applicationmodel.contacts/contactchange_contact.md index dbe12a4d8c..cb188f7408 100644 --- a/windows.applicationmodel.contacts/contactchange_contact.md +++ b/windows.applicationmodel.contacts/contactchange_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactChange.Contact --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactChange.Contact ## -description Gets the [Contact](contact.md) object that changed. ## -property-value The [Contact](contact.md) object that changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactChange.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactChange.Contact + +## -description +Gets the [Contact](contact.md) object that changed. + +## -property-value +The [Contact](contact.md) object that changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangeddeferral.md b/windows.applicationmodel.contacts/contactchangeddeferral.md index d32ad3de6d..25a5c227a3 100644 --- a/windows.applicationmodel.contacts/contactchangeddeferral.md +++ b/windows.applicationmodel.contacts/contactchangeddeferral.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactChangedDeferral --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactChangedDeferral ## -description The deferral object to use while asynchronously processing [ContactChanged](contactstore_contactchanged.md) events. ## -remarks Call [GetDeferral](contactchangedeventargs_getdeferral.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactChangedDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangedDeferral + +## -description +The deferral object to use while asynchronously processing [ContactChanged](contactstore_contactchanged.md) events. + +## -remarks +Call [GetDeferral](contactchangedeventargs_getdeferral.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangeddeferral_complete_1807836922.md b/windows.applicationmodel.contacts/contactchangeddeferral_complete_1807836922.md index 276b188dad..0b031049f0 100644 --- a/windows.applicationmodel.contacts/contactchangeddeferral_complete_1807836922.md +++ b/windows.applicationmodel.contacts/contactchangeddeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangedDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangedDeferral.Complete ## -description Call this method in order to release the deferral object when all asynchronous processing has finished. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangedDeferral.Complete + +## -description +Call this method in order to release the deferral object when all asynchronous processing has finished. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangedeventargs.md b/windows.applicationmodel.contacts/contactchangedeventargs.md index 167efb04c0..c933fa7a55 100644 --- a/windows.applicationmodel.contacts/contactchangedeventargs.md +++ b/windows.applicationmodel.contacts/contactchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactChangedEventArgs ## -description Provides data for the [ContactChanged](contactstore_contactchanged.md) event. ## -remarks This class is instantiated by the system and passed as an argument to the [ContactChanged](contactstore_contactchanged.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangedEventArgs + +## -description +Provides data for the [ContactChanged](contactstore_contactchanged.md) event. + +## -remarks +This class is instantiated by the system and passed as an argument to the [ContactChanged](contactstore_contactchanged.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangedeventargs_getdeferral_254836512.md b/windows.applicationmodel.contacts/contactchangedeventargs_getdeferral_254836512.md index 8a740e67cf..3e4d89ee80 100644 --- a/windows.applicationmodel.contacts/contactchangedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.contacts/contactchangedeventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangedEventArgs.GetDeferral ## -description Gets the [ContactChangedDeferral](contactchangeddeferral.md) object to use for asynchronous operations. ## -returns The deferral object to use for asynchronous operations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangedEventArgs.GetDeferral + +## -description +Gets the [ContactChangedDeferral](contactchangeddeferral.md) object to use for asynchronous operations. + +## -returns +The deferral object to use for asynchronous operations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangereader.md b/windows.applicationmodel.contacts/contactchangereader.md index c1b863a482..df1cad7dca 100644 --- a/windows.applicationmodel.contacts/contactchangereader.md +++ b/windows.applicationmodel.contacts/contactchangereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactChangeReader --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactChangeReader ## -description Provides a way to monitor and react to changes to contacts. ## -remarks Call the [GetChangeReader](contactchangetracker_getchangereader.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactChangeReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeReader + +## -description +Provides a way to monitor and react to changes to contacts. + +## -remarks +Call the [GetChangeReader](contactchangetracker_getchangereader.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangereader_acceptchanges_143129490.md b/windows.applicationmodel.contacts/contactchangereader_acceptchanges_143129490.md index 7aaa1cfef6..980f2bbd2d 100644 --- a/windows.applicationmodel.contacts/contactchangereader_acceptchanges_143129490.md +++ b/windows.applicationmodel.contacts/contactchangereader_acceptchanges_143129490.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChanges --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChanges ## -description Call this method to indicate that you have processed and accepted all changes and you don't want the system to show them to you again. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChanges +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChanges + +## -description +Call this method to indicate that you have processed and accepted all changes and you don't want the system to show them to you again. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangereader_acceptchangesthrough_1775774394.md b/windows.applicationmodel.contacts/contactchangereader_acceptchangesthrough_1775774394.md index 5a22857f08..d2460f71c9 100644 --- a/windows.applicationmodel.contacts/contactchangereader_acceptchangesthrough_1775774394.md +++ b/windows.applicationmodel.contacts/contactchangereader_acceptchangesthrough_1775774394.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Contacts.ContactChange) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChangesThrough ## -description Call this method to indicate that you have processed and accepted up through the specified change. ## -parameters ### -param lastChangeToAccept The last change that you want to system to track as accepted by your app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Contacts.ContactChange) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeReader.AcceptChangesThrough + +## -description +Call this method to indicate that you have processed and accepted up through the specified change. + +## -parameters +### -param lastChangeToAccept +The last change that you want to system to track as accepted by your app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangereader_readbatchasync_888788553.md b/windows.applicationmodel.contacts/contactchangereader_readbatchasync_888788553.md index 1f71655657..d90903b1c7 100644 --- a/windows.applicationmodel.contacts/contactchangereader_readbatchasync_888788553.md +++ b/windows.applicationmodel.contacts/contactchangereader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangeReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangeReader.ReadBatchAsync ## -description Asynchronously gets a list of [ContactChange](contactchange.md) objects. ## -returns A list of [ContactChange](contactchange.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangeReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeReader.ReadBatchAsync + +## -description +Asynchronously gets a list of [ContactChange](contactchange.md) objects. + +## -returns +A list of [ContactChange](contactchange.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangetracker.md b/windows.applicationmodel.contacts/contactchangetracker.md index b1087dd429..37999810f7 100644 --- a/windows.applicationmodel.contacts/contactchangetracker.md +++ b/windows.applicationmodel.contacts/contactchangetracker.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactChangeTracker --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactChangeTracker ## -description Provides functionality for monitoring changes to [Contact](contact.md) objects in the [ContactStore](contactstore.md). ## -remarks Use [ContactStore.ChangeTracker](contactstore_changetracker.md) or [ContactList.ChangeTracker](contactlist_changetracker.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactChangeTracker +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeTracker + +## -description +Provides functionality for monitoring changes to [Contact](contact.md) objects in the [ContactStore](contactstore.md). + +## -remarks +Use [ContactStore.ChangeTracker](contactstore_changetracker.md) or [ContactList.ChangeTracker](contactlist_changetracker.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangetracker_enable_366433390.md b/windows.applicationmodel.contacts/contactchangetracker_enable_366433390.md index 146f87593a..20b10d32d6 100644 --- a/windows.applicationmodel.contacts/contactchangetracker_enable_366433390.md +++ b/windows.applicationmodel.contacts/contactchangetracker_enable_366433390.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangeTracker.Enable --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangeTracker.Enable ## -description Call this method to enable change tracking. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangeTracker.Enable +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeTracker.Enable + +## -description +Call this method to enable change tracking. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangetracker_getchangereader_1364424875.md b/windows.applicationmodel.contacts/contactchangetracker_getchangereader_1364424875.md index cc0a2938fc..bdac5e70fe 100644 --- a/windows.applicationmodel.contacts/contactchangetracker_getchangereader_1364424875.md +++ b/windows.applicationmodel.contacts/contactchangetracker_getchangereader_1364424875.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangeTracker.GetChangeReader --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangeTracker.GetChangeReader ## -description Gets a [ContactChangeReader](contactchangereader.md) that can be used to process changes. ## -returns A [ContactChangeReader](contactchangereader.md) that can be used to process changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangeTracker.GetChangeReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeTracker.GetChangeReader + +## -description +Gets a [ContactChangeReader](contactchangereader.md) that can be used to process changes. + +## -returns +A [ContactChangeReader](contactchangereader.md) that can be used to process changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactchangetracker_reset_1636126115.md b/windows.applicationmodel.contacts/contactchangetracker_reset_1636126115.md index 141a4faaf8..e63476982f 100644 --- a/windows.applicationmodel.contacts/contactchangetracker_reset_1636126115.md +++ b/windows.applicationmodel.contacts/contactchangetracker_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactChangeTracker.Reset --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactChangeTracker.Reset ## -description Call this method to reset the change tracker if your app receives [ContactChangeType.ChangeTrackingLost](contactchangetype.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactChangeTracker.Reset +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeTracker.Reset + +## -description +Call this method to reset the change tracker if your app receives [ContactChangeType.ChangeTrackingLost](contactchangetype.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactconnectedserviceaccount.md b/windows.applicationmodel.contacts/contactconnectedserviceaccount.md index e0017398e8..da30c9955d 100644 --- a/windows.applicationmodel.contacts/contactconnectedserviceaccount.md +++ b/windows.applicationmodel.contacts/contactconnectedserviceaccount.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount ## -description Represents a connected service account for a contact. ## -remarks ## -examples ## -see-also [ConnectedServiceAccounts](contact_connectedserviceaccounts.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount + +## -description +Represents a connected service account for a contact. + +## -remarks + +## -examples + +## -see-also +[ConnectedServiceAccounts](contact_connectedserviceaccounts.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactconnectedserviceaccount_contactconnectedserviceaccount_1221375020.md b/windows.applicationmodel.contacts/contactconnectedserviceaccount_contactconnectedserviceaccount_1221375020.md index 8a4afb7a78..94214f916d 100644 --- a/windows.applicationmodel.contacts/contactconnectedserviceaccount_contactconnectedserviceaccount_1221375020.md +++ b/windows.applicationmodel.contacts/contactconnectedserviceaccount_contactconnectedserviceaccount_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.ContactConnectedServiceAccount ## -description Initializes a new instance of a [ContactConnectedServiceAccount](contactconnectedserviceaccount.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.ContactConnectedServiceAccount + +## -description +Initializes a new instance of a [ContactConnectedServiceAccount](contactconnectedserviceaccount.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md b/windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md index 70ef515e4b..67100b1bcc 100644 --- a/windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md +++ b/windows.applicationmodel.contacts/contactconnectedserviceaccount_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.Id --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.Id ## -description Gets and sets the identifier of a connected service account for a contact. The maximum string length for the identifier is 321 characters. ## -property-value The identifier of a connected service account for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.Id + +## -description +Gets and sets the identifier of a connected service account for a contact. The maximum string length for the identifier is 321 characters. + +## -property-value +The identifier of a connected service account for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md b/windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md index 1837af0549..129ca821f1 100644 --- a/windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md +++ b/windows.applicationmodel.contacts/contactconnectedserviceaccount_servicename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.ServiceName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.ServiceName ## -description Gets and sets the service name of a connected service account for a contact. The maximum string length for the service name is 256 characters. ## -property-value The service name of a connected service account for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.ServiceName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactConnectedServiceAccount.ServiceName + +## -description +Gets and sets the service name of a connected service account for a contact. The maximum string length for the service name is 256 characters. + +## -property-value +The service name of a connected service account for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactdate.md b/windows.applicationmodel.contacts/contactdate.md index af1ef0c185..31380432fe 100644 --- a/windows.applicationmodel.contacts/contactdate.md +++ b/windows.applicationmodel.contacts/contactdate.md @@ -1,3 +1,39 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactDate --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactDate ## -description Represents an important date for a contact. ## -remarks Here is how to use the [ContactDate](contactdate.md) properties to format date strings. ### Insert sentinel values 1. Construct a [Windows.Globalization.Calendar](../windows.globalization/calendar.md). 1. If year has a value, set year to that value, else set year to 2004 (a leap year so every day is valid). 1. If month has a value, set month to that value, else set month to 1 (a month with every day valid). 1. if day has a value, set day to that value (day will be set to some value automatically and we don't really care what it is so no need to explicitly set it). 1. Get the [Windows.Foundation.DateTime](../windows.foundation/datetime.md) from the Calendar. ### Build up a template to format 1. If year has a value, append "year " to the template. 1. If month has a value, append "month " to the template. 1. If day has a value, append "day " to the template. 1. Construct a [Windows.Globalization.DateTimeFormatting.DateTimeFormatter](../windows.globalization.datetimeformatting/datetimeformatter.md) with the template. 1. Format by using the date time formatter and the [Windows.Foundation.DateTime](../windows.foundation/datetime.md) retrieved from the Calendar. ## -examples ## -see-also [ImportantDates](contact_importantdates.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactDate +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate + +## -description +Represents an important date for a contact. + +## -remarks +Here is how to use the [ContactDate](contactdate.md) properties to format date strings. + + +### Insert sentinel values + +1. Construct a [Windows.Globalization.Calendar](../windows.globalization/calendar.md). +1. If year has a value, set year to that value, else set year to 2004 (a leap year so every day is valid). +1. If month has a value, set month to that value, else set month to 1 (a month with every day valid). +1. if day has a value, set day to that value (day will be set to some value automatically and we don't really care what it is so no need to explicitly set it). +1. Get the [Windows.Foundation.DateTime](../windows.foundation/datetime.md) from the Calendar. + +### Build up a template to format + +1. If year has a value, append "year " to the template. +1. If month has a value, append "month " to the template. +1. If day has a value, append "day " to the template. +1. Construct a [Windows.Globalization.DateTimeFormatting.DateTimeFormatter](../windows.globalization.datetimeformatting/datetimeformatter.md) with the template. +1. Format by using the date time formatter and the [Windows.Foundation.DateTime](../windows.foundation/datetime.md) retrieved from the Calendar. + + +## -examples + +## -see-also +[ImportantDates](contact_importantdates.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactdate_contactdate_1221375020.md b/windows.applicationmodel.contacts/contactdate_contactdate_1221375020.md index ba1def49c5..dc52a611e9 100644 --- a/windows.applicationmodel.contacts/contactdate_contactdate_1221375020.md +++ b/windows.applicationmodel.contacts/contactdate_contactdate_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactDate.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactDate.ContactDate ## -description Initializes a new instance of a [ContactDate](contactdate.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactDate.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate.ContactDate + +## -description +Initializes a new instance of a [ContactDate](contactdate.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactdate_day.md b/windows.applicationmodel.contacts/contactdate_day.md index 2b1da49988..1db60bf580 100644 --- a/windows.applicationmodel.contacts/contactdate_day.md +++ b/windows.applicationmodel.contacts/contactdate_day.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Day --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactDate.Day ## -description Gets and sets the day for an important date for a contact. ## -property-value The day for an important date for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Day +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate.Day + +## -description +Gets and sets the day for an important date for a contact. + +## -property-value +The day for an important date for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactdate_description.md b/windows.applicationmodel.contacts/contactdate_description.md index feb0018292..8f705bb786 100644 --- a/windows.applicationmodel.contacts/contactdate_description.md +++ b/windows.applicationmodel.contacts/contactdate_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactDate.Description ## -description Gets and sets the description for an important date for a contact. The maximum string length for the description is 512 characters. ## -property-value The description for an important date for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate.Description + +## -description +Gets and sets the description for an important date for a contact. The maximum string length for the description is 512 characters. + +## -property-value +The description for an important date for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactdate_kind.md b/windows.applicationmodel.contacts/contactdate_kind.md index aae3f58f0f..8103f51775 100644 --- a/windows.applicationmodel.contacts/contactdate_kind.md +++ b/windows.applicationmodel.contacts/contactdate_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactDate.Kind ## -description Gets and sets the kind of important date for a contact. ## -property-value A [ContactDateKind](contactdatekind.md)-typed value that indicates the type of important date for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate.Kind + +## -description +Gets and sets the kind of important date for a contact. + +## -property-value +A [ContactDateKind](contactdatekind.md)-typed value that indicates the type of important date for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactdate_month.md b/windows.applicationmodel.contacts/contactdate_month.md index c4e37b2ddb..98b3a4ce69 100644 --- a/windows.applicationmodel.contacts/contactdate_month.md +++ b/windows.applicationmodel.contacts/contactdate_month.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Month --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactDate.Month ## -description Gets and sets the month for an important date for a contact. ## -property-value The month for an important date for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Month +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate.Month + +## -description +Gets and sets the month for an important date for a contact. + +## -property-value +The month for an important date for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactdate_year.md b/windows.applicationmodel.contacts/contactdate_year.md index b11250c2c5..74445fd1cf 100644 --- a/windows.applicationmodel.contacts/contactdate_year.md +++ b/windows.applicationmodel.contacts/contactdate_year.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Year --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactDate.Year ## -description Gets and sets the year for an important date for a contact. This value must be convertible to a [FILETIME](XREF:TODO:base.filetime_str) structure. ## -property-value The year for an important date for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactDate.Year +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactDate.Year + +## -description +Gets and sets the year for an important date for a contact. This value must be convertible to a [FILETIME](XREF:TODO:base.filetime_str) structure. + +## -property-value +The year for an important date for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactemail.md b/windows.applicationmodel.contacts/contactemail.md index a08800b257..6f98577b19 100644 --- a/windows.applicationmodel.contacts/contactemail.md +++ b/windows.applicationmodel.contacts/contactemail.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactEmail --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactEmail ## -description Represents an email address of a contact. ## -remarks For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). ## -examples ## -see-also [Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [Emails](contact_emails.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactEmail +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactEmail + +## -description +Represents an email address of a contact. + +## -remarks +For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). + +## -examples + +## -see-also +[Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [Emails](contact_emails.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactemail_address.md b/windows.applicationmodel.contacts/contactemail_address.md index 4f1123f350..02b9ec9d5a 100644 --- a/windows.applicationmodel.contacts/contactemail_address.md +++ b/windows.applicationmodel.contacts/contactemail_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactEmail.Address --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactEmail.Address ## -description Gets and sets the email address of a contact. The maximum string length for the description is 321 characters. ## -property-value The email address of a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactEmail.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactEmail.Address + +## -description +Gets and sets the email address of a contact. The maximum string length for the description is 321 characters. + +## -property-value +The email address of a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactemail_contactemail_1221375020.md b/windows.applicationmodel.contacts/contactemail_contactemail_1221375020.md index 365ae6f849..52c275d7d8 100644 --- a/windows.applicationmodel.contacts/contactemail_contactemail_1221375020.md +++ b/windows.applicationmodel.contacts/contactemail_contactemail_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactEmail.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactEmail.ContactEmail ## -description Initializes a new instance of a [ContactEmail](contactemail.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactEmail.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactEmail.ContactEmail + +## -description +Initializes a new instance of a [ContactEmail](contactemail.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactemail_description.md b/windows.applicationmodel.contacts/contactemail_description.md index ef6dd9946c..02a6ebcd22 100644 --- a/windows.applicationmodel.contacts/contactemail_description.md +++ b/windows.applicationmodel.contacts/contactemail_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactEmail.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactEmail.Description ## -description Gets and sets the description of an email address of a contact. The maximum string length for the description is 512 characters. ## -property-value The description of an email address of a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactEmail.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactEmail.Description + +## -description +Gets and sets the description of an email address of a contact. The maximum string length for the description is 512 characters. + +## -property-value +The description of an email address of a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactemail_kind.md b/windows.applicationmodel.contacts/contactemail_kind.md index b31e03ab08..65c801675d 100644 --- a/windows.applicationmodel.contacts/contactemail_kind.md +++ b/windows.applicationmodel.contacts/contactemail_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactEmail.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactEmail.Kind ## -description Gets and sets the kind of email address of a contact. ## -property-value A [ContactEmailKind](contactemailkind.md)-typed value that indicates the type of email address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactEmail.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactEmail.Kind + +## -description +Gets and sets the kind of email address of a contact. + +## -property-value +A [ContactEmailKind](contactemailkind.md)-typed value that indicates the type of email address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactfield_category.md b/windows.applicationmodel.contacts/contactfield_category.md index 2564c759cb..54ccc7e494 100644 --- a/windows.applicationmodel.contacts/contactfield_category.md +++ b/windows.applicationmodel.contacts/contactfield_category.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactField.Category --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactField.Category ## -description > [!NOTE] > [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the category for the contact data. ## -property-value The category for the contact data. ## -remarks To see what types of categories you can assign to a [ContactField](contactfield.md), see [ContactFieldCategory](contactfieldcategory.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactField.Category +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.Category + +## -description +> [!NOTE] +> [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the category for the contact data. + +## -property-value +The category for the contact data. + +## -remarks +To see what types of categories you can assign to a [ContactField](contactfield.md), see [ContactFieldCategory](contactfieldcategory.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactfield_contactfield_1768314280.md b/windows.applicationmodel.contacts/contactfield_contactfield_1768314280.md index 204a517746..b4d877360e 100644 --- a/windows.applicationmodel.contacts/contactfield_contactfield_1768314280.md +++ b/windows.applicationmodel.contacts/contactfield_contactfield_1768314280.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactField.#ctor(System.String,System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactField.ContactField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a new [ContactField](contactfield.md)object. ## -parameters ### -param name The name of the field. ### -param value The value the field contains. ### -param type The type of field. ### -param category The category the field belongs to. ## -remarks ## -examples ## -see-also [ContactField(String, ContactFieldType)](contactfield_contactfield_2065220202.md), [ContactField(String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_187090822.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactField.#ctor(System.String,System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.ContactField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a new [ContactField](contactfield.md)object. + +## -parameters +### -param name +The name of the field. + +### -param value +The value the field contains. + +### -param type +The type of field. + +### -param category +The category the field belongs to. + +## -remarks + +## -examples + +## -see-also +[ContactField(String, ContactFieldType)](contactfield_contactfield_2065220202.md), [ContactField(String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_187090822.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfield_contactfield_187090822.md b/windows.applicationmodel.contacts/contactfield_contactfield_187090822.md index 4ba521c3c6..9ac28a2821 100644 --- a/windows.applicationmodel.contacts/contactfield_contactfield_187090822.md +++ b/windows.applicationmodel.contacts/contactfield_contactfield_187090822.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactField.ContactField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a new [ContactField](contactfield.md)object. ## -parameters ### -param value The value for the contact field. ### -param type The type of contact data. ### -param category The category that the contact belongs to. ## -remarks ## -examples ## -see-also [ContactField(String, ContactFieldType)](contactfield_contactfield_2065220202.md), [ContactField(String, String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_1768314280.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.ContactField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a new [ContactField](contactfield.md)object. + +## -parameters +### -param value +The value for the contact field. + +### -param type +The type of contact data. + +### -param category +The category that the contact belongs to. + +## -remarks + +## -examples + +## -see-also +[ContactField(String, ContactFieldType)](contactfield_contactfield_2065220202.md), [ContactField(String, String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_1768314280.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfield_contactfield_2065220202.md b/windows.applicationmodel.contacts/contactfield_contactfield_2065220202.md index a2e194daae..d575764543 100644 --- a/windows.applicationmodel.contacts/contactfield_contactfield_2065220202.md +++ b/windows.applicationmodel.contacts/contactfield_contactfield_2065220202.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactField.ContactField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a new [ContactField](contactfield.md)object. ## -parameters ### -param value The value that the field contains. ### -param type The type of contact data. ## -remarks ## -examples ## -see-also [ContactField(String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_187090822.md), [ContactField(String, String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_1768314280.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.ContactField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a new [ContactField](contactfield.md)object. + +## -parameters +### -param value +The value that the field contains. + +### -param type +The type of contact data. + +## -remarks + +## -examples + +## -see-also +[ContactField(String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_187090822.md), [ContactField(String, String, ContactFieldType, ContactFieldCategory)](contactfield_contactfield_1768314280.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfield_name.md b/windows.applicationmodel.contacts/contactfield_name.md index 25445103a2..cb298d8dcb 100644 --- a/windows.applicationmodel.contacts/contactfield_name.md +++ b/windows.applicationmodel.contacts/contactfield_name.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactField.Name --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactField.Name ## -description > [!NOTE] > [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the name of the field. ## -property-value The name of the field. ## -remarks If the [ContactField](contactfield.md) was created using a [ContactFieldType](contactfieldtype.md) enumeration, then the [Name](contactfield_name.md) property is the same as the [ContactFieldType](contactfieldtype.md) value (such as Email or PhoneNumber). If the [ContactField](contactfield.md) contains a custom field, the [Name](contactfield_name.md) property is the name of the field. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactField.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.Name + +## -description +> [!NOTE] +> [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the name of the field. + +## -property-value +The name of the field. + +## -remarks +If the [ContactField](contactfield.md) was created using a [ContactFieldType](contactfieldtype.md) enumeration, then the [Name](contactfield_name.md) property is the same as the [ContactFieldType](contactfieldtype.md) value (such as Email or PhoneNumber). If the [ContactField](contactfield.md) contains a custom field, the [Name](contactfield_name.md) property is the name of the field. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactfield_type.md b/windows.applicationmodel.contacts/contactfield_type.md index 070fed1b32..56e5c62a1d 100644 --- a/windows.applicationmodel.contacts/contactfield_type.md +++ b/windows.applicationmodel.contacts/contactfield_type.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactField.Type --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactField.Type ## -description > [!NOTE] > [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the contact field type for the data. ## -property-value The type of data. ## -remarks To see what types you can assign to a [ContactField](contactfield.md), see [ContactFieldType](contactfieldtype.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactField.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.Type + +## -description +> [!NOTE] +> [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the contact field type for the data. + + +## -property-value +The type of data. + +## -remarks +To see what types you can assign to a [ContactField](contactfield.md), see [ContactFieldType](contactfieldtype.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactfield_value.md b/windows.applicationmodel.contacts/contactfield_value.md index bab63e4548..a88a80cd9f 100644 --- a/windows.applicationmodel.contacts/contactfield_value.md +++ b/windows.applicationmodel.contacts/contactfield_value.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactField.Value --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactField.Value ## -description > [!NOTE] > [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the value of the contact data. ## -property-value The value of the contact data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactField.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactField.Value + +## -description +> [!NOTE] +> [ContactField](contactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the value of the contact data. + +## -property-value +The value of the contact data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactfieldfactory_contactfieldfactory_1221375020.md b/windows.applicationmodel.contacts/contactfieldfactory_contactfieldfactory_1221375020.md index eedada1eb8..c5acf5ce51 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_contactfieldfactory_1221375020.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_contactfieldfactory_1221375020.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.ContactFieldFactory ## -description > [!NOTE] > [ContactFieldFactory](contactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Creates an instance of the [ContactFieldFactory](contactfieldfactory.md)class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.ContactFieldFactory + +## -description +> [!NOTE] +> [ContactFieldFactory](contactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Creates an instance of the [ContactFieldFactory](contactfieldfactory.md)class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createfield_1723791966.md b/windows.applicationmodel.contacts/contactfieldfactory_createfield_1723791966.md index 24a6d04cd1..ba56900e5c 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createfield_1723791966.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createfield_1723791966.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a field to contain information about a contact. ## -parameters ### -param value The value for the field. ### -param type The type of field. ## -returns Contains a field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateField(String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_377552818.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_1958768016.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a field to contain information about a contact. + +## -parameters +### -param value +The value for the field. + +### -param type +The type of field. + +## -returns +Contains a field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateField(String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_377552818.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_1958768016.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createfield_1958768016.md b/windows.applicationmodel.contacts/contactfieldfactory_createfield_1958768016.md index 50610f633d..cc4b15b83b 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createfield_1958768016.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createfield_1958768016.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField(System.String,System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a field to contain information about a contact. ## -parameters ### -param name The name of the field. ### -param value The value of the field. ### -param type The type of field. ### -param category The category the field belongs to. ## -returns Contains a field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateField(String, ContactFieldType)](contactfieldfactory_createfield_1723791966.md), [CreateField(String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_377552818.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField(System.String,System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a field to contain information about a contact. + +## -parameters +### -param name +The name of the field. + +### -param value +The value of the field. + +### -param type +The type of field. + +### -param category +The category the field belongs to. + +## -returns +Contains a field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateField(String, ContactFieldType)](contactfieldfactory_createfield_1723791966.md), [CreateField(String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_377552818.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createfield_377552818.md b/windows.applicationmodel.contacts/contactfieldfactory_createfield_377552818.md index 575c0bf0c0..0235d8e5cb 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createfield_377552818.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createfield_377552818.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a field to contain information about a contact. ## -parameters ### -param value The value for the field. ### -param type The type of field. ### -param category The category the field belongs to. ## -returns Contains a field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateField(String, ContactFieldType)](contactfieldfactory_createfield_1723791966.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_1958768016.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a field to contain information about a contact. + +## -parameters +### -param value +The value for the field. + +### -param type +The type of field. + +### -param category +The category the field belongs to. + +## -returns +Contains a field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateField(String, ContactFieldType)](contactfieldfactory_createfield_1723791966.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](contactfieldfactory_createfield_1958768016.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1039910149.md b/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1039910149.md index 9af0e3cb54..2706fededb 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1039910149.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1039910149.md @@ -1,3 +1,42 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a field to contain information about a contact's instant messaging account. ## -parameters ### -param userName The user name of the instant messaging account. ### -param category The category the field belongs to. ### -param service The name of the instant messaging service. ### -param displayText The text to display to prompt an instant messaging conversation. ### -param verb The Uniform Resource Identifier (URI) that starts an instant messaging conversation. ## -returns Contains an instant messaging field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateInstantMessage(String)](contactfieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory)](contactfieldfactory_createinstantmessage_1064293083.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a field to contain information about a contact's instant messaging account. + +## -parameters +### -param userName +The user name of the instant messaging account. + +### -param category +The category the field belongs to. + +### -param service +The name of the instant messaging service. + +### -param displayText +The text to display to prompt an instant messaging conversation. + +### -param verb +The Uniform Resource Identifier (URI) that starts an instant messaging conversation. + +## -returns +Contains an instant messaging field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateInstantMessage(String)](contactfieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory)](contactfieldfactory_createinstantmessage_1064293083.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1064293083.md b/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1064293083.md index 95178b6770..9cb7fb62e0 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1064293083.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_1064293083.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a field to contain information about a contact's instant messaging account. ## -parameters ### -param userName The user name for the instant messaging account. ### -param category The category the field belongs to. ## -returns Contains an instant messaging field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateInstantMessage(String)](contactfieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](contactfieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a field to contain information about a contact's instant messaging account. + +## -parameters +### -param userName +The user name for the instant messaging account. + +### -param category +The category the field belongs to. + +## -returns +Contains an instant messaging field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateInstantMessage(String)](contactfieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](contactfieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_2022649811.md b/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_2022649811.md index 5e9f3fbc69..2f72783695 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_2022649811.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createinstantmessage_2022649811.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a field to contain information about a contact's instant messaging account. ## -parameters ### -param userName The user name for the instant messaging account. ## -returns Contains an instant messaging field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateInstantMessage(String, ContactFieldCategory)](contactfieldfactory_createinstantmessage_1064293083.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](contactfieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateInstantMessage + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a field to contain information about a contact's instant messaging account. + +## -parameters +### -param userName +The user name for the instant messaging account. + +## -returns +Contains an instant messaging field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateInstantMessage(String, ContactFieldCategory)](contactfieldfactory_createinstantmessage_1064293083.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](contactfieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createlocation_1542951776.md b/windows.applicationmodel.contacts/contactfieldfactory_createlocation_1542951776.md index 6e99f011d5..52fc527be2 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createlocation_1542951776.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createlocation_1542951776.md @@ -1,3 +1,48 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a field to contain information about a contact's location. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ### -param category The category the field belongs to. ### -param street The street address for the address. ### -param city The name of the city for the address. ### -param region The name of the region for the address. ### -param country The name of the country for the address. ### -param postalCode The postal code for the address. ## -returns Contains a location field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateLocation(String)](contactfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory)](contactfieldfactory_createlocation_966869216.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a field to contain information about a contact's location. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +### -param category +The category the field belongs to. + +### -param street +The street address for the address. + +### -param city +The name of the city for the address. + +### -param region +The name of the region for the address. + +### -param country +The name of the country for the address. + +### -param postalCode +The postal code for the address. + +## -returns +Contains a location field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateLocation(String)](contactfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory)](contactfieldfactory_createlocation_966869216.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createlocation_2118237656.md b/windows.applicationmodel.contacts/contactfieldfactory_createlocation_2118237656.md index ea56dc8747..1cddf8d48d 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createlocation_2118237656.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createlocation_2118237656.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a field to contain information about a contact's location. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ## -returns Contains a location field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateLocation(String, ContactFieldCategory)](contactfieldfactory_createlocation_966869216.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](contactfieldfactory_createlocation_1542951776.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a field to contain information about a contact's location. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +## -returns +Contains a location field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateLocation(String, ContactFieldCategory)](contactfieldfactory_createlocation_966869216.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](contactfieldfactory_createlocation_1542951776.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactfieldfactory_createlocation_966869216.md b/windows.applicationmodel.contacts/contactfieldfactory_createlocation_966869216.md index 0d331f5b79..12978fd955 100644 --- a/windows.applicationmodel.contacts/contactfieldfactory_createlocation_966869216.md +++ b/windows.applicationmodel.contacts/contactfieldfactory_createlocation_966869216.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a field to contain information about a contact's location. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ### -param category The category the field belongs to. ## -returns Contains a location field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateLocation(String)](contactfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](contactfieldfactory_createlocation_1542951776.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactFieldFactory.CreateLocation + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a field to contain information about a contact's location. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +### -param category +The category the field belongs to. + +## -returns +Contains a location field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateLocation(String)](contactfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](contactfieldfactory_createlocation_1542951776.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactinformation_customfields.md b/windows.applicationmodel.contacts/contactinformation_customfields.md index c9911f8f6a..2fdace52f9 100644 --- a/windows.applicationmodel.contacts/contactinformation_customfields.md +++ b/windows.applicationmodel.contacts/contactinformation_customfields.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.CustomFields --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInformation.CustomFields ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). A read-only list of the custom fields stored with the contact. ## -property-value A read-only list of custom fields. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.CustomFields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.CustomFields + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +A read-only list of the custom fields stored with the contact. + +## -property-value +A read-only list of custom fields. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_emails.md b/windows.applicationmodel.contacts/contactinformation_emails.md index cef360129f..4b974f5bf8 100644 --- a/windows.applicationmodel.contacts/contactinformation_emails.md +++ b/windows.applicationmodel.contacts/contactinformation_emails.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.Emails --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInformation.Emails ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). A read-only list of email addresses stored with the contact. ## -property-value A read-only list of email addresses. ## -remarks Use the [Emails](contactinformation_emails.md) property to access a contact's email addresses from a [ContactInformation](contactinformation.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.Emails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.Emails + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +A read-only list of email addresses stored with the contact. + +## -property-value +A read-only list of email addresses. + +## -remarks +Use the [Emails](contactinformation_emails.md) property to access a contact's email addresses from a [ContactInformation](contactinformation.md) object. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_getthumbnailasync_241227233.md b/windows.applicationmodel.contacts/contactinformation_getthumbnailasync_241227233.md index a9ceddfc62..ceeceaa6a2 100644 --- a/windows.applicationmodel.contacts/contactinformation_getthumbnailasync_241227233.md +++ b/windows.applicationmodel.contacts/contactinformation_getthumbnailasync_241227233.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactInformation.GetThumbnailAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactInformation.GetThumbnailAsync ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). Gets the thumbnail image for the contact. ## -returns An object that provides access to the thumbnail image. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactInformation.GetThumbnailAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.GetThumbnailAsync + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +Gets the thumbnail image for the contact. + +## -returns +An object that provides access to the thumbnail image. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_instantmessages.md b/windows.applicationmodel.contacts/contactinformation_instantmessages.md index 667ea434b7..15af740bfe 100644 --- a/windows.applicationmodel.contacts/contactinformation_instantmessages.md +++ b/windows.applicationmodel.contacts/contactinformation_instantmessages.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.InstantMessages --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInformation.InstantMessages ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). A read-only list of instant messaging accounts stored with the contact. ## -property-value A read-only list of instant messaging accounts. ## -remarks Use the [InstantMessages](contactinformation_instantmessages.md) property to access a contact's instant messaging user names from a [ContactInformation](contactinformation.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.InstantMessages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.InstantMessages + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +A read-only list of instant messaging accounts stored with the contact. + +## -property-value +A read-only list of instant messaging accounts. + +## -remarks +Use the [InstantMessages](contactinformation_instantmessages.md) property to access a contact's instant messaging user names from a [ContactInformation](contactinformation.md) object. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_locations.md b/windows.applicationmodel.contacts/contactinformation_locations.md index ac85ce0fe1..0279163dc6 100644 --- a/windows.applicationmodel.contacts/contactinformation_locations.md +++ b/windows.applicationmodel.contacts/contactinformation_locations.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.Locations --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInformation.Locations ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). A read-only list of locations stored with the contact. ## -property-value A read-only list of locations. ## -remarks Use the [Locations](contactinformation_locations.md) property to access a contact's address and other information from a [ContactInformation](contactinformation.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.Locations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.Locations + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +A read-only list of locations stored with the contact. + +## -property-value +A read-only list of locations. + +## -remarks +Use the [Locations](contactinformation_locations.md) property to access a contact's address and other information from a [ContactInformation](contactinformation.md) object. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_name.md b/windows.applicationmodel.contacts/contactinformation_name.md index 2dce6d19e1..ea4797c00b 100644 --- a/windows.applicationmodel.contacts/contactinformation_name.md +++ b/windows.applicationmodel.contacts/contactinformation_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.Name --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInformation.Name ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). The name of the contact. ## -property-value The name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.Name + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +The name of the contact. + +## -property-value +The name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_phonenumbers.md b/windows.applicationmodel.contacts/contactinformation_phonenumbers.md index cbe0d7b26a..b540a9584d 100644 --- a/windows.applicationmodel.contacts/contactinformation_phonenumbers.md +++ b/windows.applicationmodel.contacts/contactinformation_phonenumbers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.PhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInformation.PhoneNumbers ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). A read-only list of phone numbers stored with the contact. ## -property-value A read-only list of phone numbers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInformation.PhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.PhoneNumbers + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +A read-only list of phone numbers stored with the contact. + +## -property-value +A read-only list of phone numbers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinformation_querycustomfields_1549778009.md b/windows.applicationmodel.contacts/contactinformation_querycustomfields_1549778009.md index f26d7ad0e4..ddc7de4bc8 100644 --- a/windows.applicationmodel.contacts/contactinformation_querycustomfields_1549778009.md +++ b/windows.applicationmodel.contacts/contactinformation_querycustomfields_1549778009.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactInformation.QueryCustomFields(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactInformation.QueryCustomFields ## -description > [!NOTE] > [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). Enables you to get the value for a custom field that is stored with a contact. ## -parameters ### -param customName The name of the field. ## -returns The value of the field. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactInformation.QueryCustomFields(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactInformation.QueryCustomFields + +## -description +> [!NOTE] +> [ContactInformation](contactinformation.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [Contact](contact.md). + +Enables you to get the value for a custom field that is stored with a contact. + +## -parameters +### -param customName +The name of the field. + +## -returns +The value of the field. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_category.md b/windows.applicationmodel.contacts/contactinstantmessagefield_category.md index afb86f0a56..e6a8c6e9d8 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_category.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_category.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Category --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.Category ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the category for the contact data. ## -property-value The category for the contact data. ## -remarks See the [ContactFieldCategory](contactfieldcategory.md) class for more info on the available values for this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Category +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.Category + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the category for the contact data. + +## -property-value +The category for the contact data. + +## -remarks +See the [ContactFieldCategory](contactfieldcategory.md) class for more info on the available values for this property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1413064668.md b/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1413064668.md index 6ce7478064..1a0f68598d 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1413064668.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1413064668.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactInstantMessageField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.ContactInstantMessageField ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a new [ContactInstantMessageField](contactinstantmessagefield.md)object. ## -parameters ### -param userName The user's name. ### -param category The category of the contact data. ### -param service The name of the instant messaging service. ### -param displayText The display text used with the instant messaging Uniform Resource Identifier (URI). ### -param verb The Uniform Resource Identifier (URI) that starts an instant message. ## -remarks ## -examples ## -see-also [ContactInstantMessageField(String)](contactinstantmessagefield_contactinstantmessagefield_290278668.md), [ContactInstantMessageField(String, ContactFieldCategory)](contactinstantmessagefield_contactinstantmessagefield_1454223364.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactInstantMessageField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.ContactInstantMessageField + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a new [ContactInstantMessageField](contactinstantmessagefield.md)object. + +## -parameters +### -param userName +The user's name. + +### -param category +The category of the contact data. + +### -param service +The name of the instant messaging service. + +### -param displayText +The display text used with the instant messaging Uniform Resource Identifier (URI). + +### -param verb +The Uniform Resource Identifier (URI) that starts an instant message. + +## -remarks + +## -examples + +## -see-also +[ContactInstantMessageField(String)](contactinstantmessagefield_contactinstantmessagefield_290278668.md), [ContactInstantMessageField(String, ContactFieldCategory)](contactinstantmessagefield_contactinstantmessagefield_1454223364.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1454223364.md b/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1454223364.md index 046338ee17..a18ca71695 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1454223364.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_1454223364.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactInstantMessageField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.ContactInstantMessageField ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a new [ContactInstantMessageField](contactinstantmessagefield.md)object. ## -parameters ### -param userName The user's name. ### -param category The category of contact data. ## -remarks ## -examples ## -see-also [ContactInstantMessageField(String)](contactinstantmessagefield_contactinstantmessagefield_290278668.md), [ContactInstantMessageField(String, ContactFieldCategory, String, String, Uri)](contactinstantmessagefield_contactinstantmessagefield_1413064668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactInstantMessageField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.ContactInstantMessageField + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a new [ContactInstantMessageField](contactinstantmessagefield.md)object. + +## -parameters +### -param userName +The user's name. + +### -param category +The category of contact data. + +## -remarks + +## -examples + +## -see-also +[ContactInstantMessageField(String)](contactinstantmessagefield_contactinstantmessagefield_290278668.md), [ContactInstantMessageField(String, ContactFieldCategory, String, String, Uri)](contactinstantmessagefield_contactinstantmessagefield_1413064668.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_290278668.md b/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_290278668.md index 97e890ff5b..f402556f64 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_290278668.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_contactinstantmessagefield_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactInstantMessageField.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.ContactInstantMessageField ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a new [ContactInstantMessageField](contactinstantmessagefield.md)object. ## -parameters ### -param userName The user's name. ## -remarks ## -examples ## -see-also [ContactInstantMessageField(String, ContactFieldCategory)](contactinstantmessagefield_contactinstantmessagefield_1454223364.md), [ContactInstantMessageField(String, ContactFieldCategory, String, String, Uri)](contactinstantmessagefield_contactinstantmessagefield_1413064668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactInstantMessageField.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.ContactInstantMessageField + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a new [ContactInstantMessageField](contactinstantmessagefield.md)object. + +## -parameters +### -param userName +The user's name. + +## -remarks + +## -examples + +## -see-also +[ContactInstantMessageField(String, ContactFieldCategory)](contactinstantmessagefield_contactinstantmessagefield_1454223364.md), [ContactInstantMessageField(String, ContactFieldCategory, String, String, Uri)](contactinstantmessagefield_contactinstantmessagefield_1413064668.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_displaytext.md b/windows.applicationmodel.contacts/contactinstantmessagefield_displaytext.md index 3e63c9115d..88c6ab4877 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_displaytext.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_displaytext.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.DisplayText --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.DisplayText ## -description > [!NOTE] > [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Gets the display text for the Uniform Resource Identifier (URI)that starts an instant message. ## -property-value The display text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.DisplayText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.DisplayText + +## -description +> [!NOTE] +> [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Gets the display text for the Uniform Resource Identifier (URI)that starts an instant message. + +## -property-value +The display text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_launchuri.md b/windows.applicationmodel.contacts/contactinstantmessagefield_launchuri.md index dda10bf6fc..a280f38b43 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_launchuri.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_launchuri.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.LaunchUri --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.LaunchUri ## -description > [!NOTE] > [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Gets the Uniform Resource Identifier (URI)that can start an instant message. ## -property-value The Uniform Resource Identifier (URI). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.LaunchUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.LaunchUri + +## -description +> [!NOTE] +> [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Gets the Uniform Resource Identifier (URI)that can start an instant message. + +## -property-value +The Uniform Resource Identifier (URI). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_name.md b/windows.applicationmodel.contacts/contactinstantmessagefield_name.md index 159b30fd20..5505407888 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_name.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Name --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.Name ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the name of the field. ## -property-value The name of the field. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.Name + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the name of the field. + +## -property-value +The name of the field. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_service.md b/windows.applicationmodel.contacts/contactinstantmessagefield_service.md index f28d4d5d58..f8b207dcfd 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_service.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_service.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Service --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.Service ## -description > [!NOTE] > [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Gets the name of the service used for sending instant messages. ## -property-value The service name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Service +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.Service + +## -description +> [!NOTE] +> [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Gets the name of the service used for sending instant messages. + +## -property-value +The service name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_type.md b/windows.applicationmodel.contacts/contactinstantmessagefield_type.md index d97cfa1f67..0c7bc366db 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_type.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_type.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Type --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.Type ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the contact field type for the data. ## -property-value The type of data. ## -remarks See the [ContactFieldType](contactfieldtype.md) class for more info on the available values for this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.Type + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the contact field type for the data. + +## -property-value +The type of data. + +## -remarks +See the [ContactFieldType](contactfieldtype.md) class for more info on the available values for this property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_username.md b/windows.applicationmodel.contacts/contactinstantmessagefield_username.md index bc26e90ba6..10ef254b79 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_username.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_username.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.UserName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.UserName ## -description > [!NOTE] > [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Gets the user's name. ## -property-value The user's name. ## -remarks Remember that the user's name for an instant message account is not always the same as his or her actual name. If you want a user's actual name, use the [ContactInformation.name](contactinformation_name.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.UserName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.UserName + +## -description +> [!NOTE] +> [ContactInstantMessageField](contactinstantmessagefield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Gets the user's name. + +## -property-value +The user's name. + +## -remarks +Remember that the user's name for an instant message account is not always the same as his or her actual name. If you want a user's actual name, use the [ContactInformation.name](contactinformation_name.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactinstantmessagefield_value.md b/windows.applicationmodel.contacts/contactinstantmessagefield_value.md index 1f51b27d70..ad28ab6909 100644 --- a/windows.applicationmodel.contacts/contactinstantmessagefield_value.md +++ b/windows.applicationmodel.contacts/contactinstantmessagefield_value.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Value --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactInstantMessageField.Value ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the value of the contact data. ## -property-value The value of the contact data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactInstantMessageField.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactInstantMessageField.Value + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the value of the contact data. + +## -property-value +The value of the contact data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo.md b/windows.applicationmodel.contacts/contactjobinfo.md index 70781700cb..4aac154c1d 100644 --- a/windows.applicationmodel.contacts/contactjobinfo.md +++ b/windows.applicationmodel.contacts/contactjobinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactJobInfo --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactJobInfo ## -description Represents job info for a contact. ## -remarks ## -examples ## -see-also [JobInfo](contact_jobinfo.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactJobInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo + +## -description +Represents job info for a contact. + +## -remarks + +## -examples + +## -see-also +[JobInfo](contact_jobinfo.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactjobinfo_companyaddress.md b/windows.applicationmodel.contacts/contactjobinfo_companyaddress.md index cc290b9d76..1ae79864ce 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_companyaddress.md +++ b/windows.applicationmodel.contacts/contactjobinfo_companyaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyAddress --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyAddress ## -description Gets and sets the company address of the job info for a contact. The maximum string length for the company address is 1024 characters. ## -property-value The company address of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyAddress + +## -description +Gets and sets the company address of the job info for a contact. The maximum string length for the company address is 1024 characters. + +## -property-value +The company address of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_companyname.md b/windows.applicationmodel.contacts/contactjobinfo_companyname.md index c341d0f6c3..a3981c0442 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_companyname.md +++ b/windows.applicationmodel.contacts/contactjobinfo_companyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyName ## -description Gets and sets the company name of the job info for a contact. The maximum string length for the company name is 64 characters. ## -property-value The company name of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyName + +## -description +Gets and sets the company name of the job info for a contact. The maximum string length for the company name is 64 characters. + +## -property-value +The company name of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_companyyominame.md b/windows.applicationmodel.contacts/contactjobinfo_companyyominame.md index f5b17b028a..f3a7e22961 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_companyyominame.md +++ b/windows.applicationmodel.contacts/contactjobinfo_companyyominame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyYomiName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyYomiName ## -description Gets and sets the company Yomi (phonetic Japanese equivalent) name of the job info for a contact. The maximum string length for the company Yomi name is 200 characters. ## -property-value The company Yomi (phonetic Japanese equivalent) name of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyYomiName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.CompanyYomiName + +## -description +Gets and sets the company Yomi (phonetic Japanese equivalent) name of the job info for a contact. The maximum string length for the company Yomi name is 200 characters. + +## -property-value +The company Yomi (phonetic Japanese equivalent) name of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_contactjobinfo_1221375020.md b/windows.applicationmodel.contacts/contactjobinfo_contactjobinfo_1221375020.md index 4092762070..7a8525ebdc 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_contactjobinfo_1221375020.md +++ b/windows.applicationmodel.contacts/contactjobinfo_contactjobinfo_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactJobInfo.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.ContactJobInfo ## -description Initializes a new instance of a [ContactJobInfo](contactjobinfo.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactJobInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.ContactJobInfo + +## -description +Initializes a new instance of a [ContactJobInfo](contactjobinfo.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_department.md b/windows.applicationmodel.contacts/contactjobinfo_department.md index fca5493669..9096c33a07 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_department.md +++ b/windows.applicationmodel.contacts/contactjobinfo_department.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Department --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.Department ## -description Gets and sets the department of the job info for a contact. The maximum string length for the department is 100 characters. ## -property-value The department of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Department +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.Department + +## -description +Gets and sets the department of the job info for a contact. The maximum string length for the department is 100 characters. + +## -property-value +The department of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_description.md b/windows.applicationmodel.contacts/contactjobinfo_description.md index d3b92af4ae..6d92752988 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_description.md +++ b/windows.applicationmodel.contacts/contactjobinfo_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.Description ## -description Gets and sets the description of the job info for a contact. The maximum string length for the description is 512 characters. ## -property-value The description of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.Description + +## -description +Gets and sets the description of the job info for a contact. The maximum string length for the description is 512 characters. + +## -property-value +The description of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_manager.md b/windows.applicationmodel.contacts/contactjobinfo_manager.md index eb4ae9800a..c6afba761d 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_manager.md +++ b/windows.applicationmodel.contacts/contactjobinfo_manager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Manager --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.Manager ## -description Gets and sets the manager of the job info for a contact. The maximum string length for the manager is 1024 characters. ## -property-value The manager of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Manager +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.Manager + +## -description +Gets and sets the manager of the job info for a contact. The maximum string length for the manager is 1024 characters. + +## -property-value +The manager of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_office.md b/windows.applicationmodel.contacts/contactjobinfo_office.md index c4812f132f..3eac1bfbdf 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_office.md +++ b/windows.applicationmodel.contacts/contactjobinfo_office.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Office --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.Office ## -description Gets and sets the office of the job info for a contact. The maximum string length for the office is 40 characters. ## -property-value The office of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Office +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.Office + +## -description +Gets and sets the office of the job info for a contact. The maximum string length for the office is 40 characters. + +## -property-value +The office of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactjobinfo_title.md b/windows.applicationmodel.contacts/contactjobinfo_title.md index dd5b5fc850..523396e138 100644 --- a/windows.applicationmodel.contacts/contactjobinfo_title.md +++ b/windows.applicationmodel.contacts/contactjobinfo_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Title --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactJobInfo.Title ## -description Gets and sets the title of the job info for a contact. The maximum string length for the title is 1024 characters. ## -property-value The title of the job info for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactJobInfo.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactJobInfo.Title + +## -description +Gets and sets the title of the job info for a contact. The maximum string length for the title is 1024 characters. + +## -property-value +The title of the job info for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlaunchactionverbs.md b/windows.applicationmodel.contacts/contactlaunchactionverbs.md index 85c474760c..f2e4b59587 100644 --- a/windows.applicationmodel.contacts/contactlaunchactionverbs.md +++ b/windows.applicationmodel.contacts/contactlaunchactionverbs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs ## -description Provides data when an app is launched to perform an action to a contact. ## -remarks Use the [ContactLaunchActionVerbs](contactlaunchactionverbs.md) 's properties to determine the value of the "Verb" property when your app is activated with [ActivationKind.Contact](../windows.applicationmodel.activation/activationkind.md). These properties represent all possible string values of the "Verb" property. For example, the [ContactMapActivatedEventArgs.Verb](../windows.applicationmodel.activation/contactmapactivatedeventargs_verb.md) property is set to the value of [Map](contactlaunchactionverbs_map.md). For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs + +## -description +Provides data when an app is launched to perform an action to a contact. + +## -remarks +Use the [ContactLaunchActionVerbs](contactlaunchactionverbs.md) 's properties to determine the value of the "Verb" property when your app is activated with [ActivationKind.Contact](../windows.applicationmodel.activation/activationkind.md). These properties represent all possible string values of the "Verb" property. For example, the [ContactMapActivatedEventArgs.Verb](../windows.applicationmodel.activation/contactmapactivatedeventargs_verb.md) property is set to the value of [Map](contactlaunchactionverbs_map.md). + +For info about how to handle app activation through contact actions, see [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/397d8b2a-6255-4f37-8556-449a3be2ef3f) and [Quickstart: Handling contact actions ](http://msdn.microsoft.com/library/61bacc8a-24c9-4b3d-b77b-e0822467700c). + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlaunchactionverbs_call.md b/windows.applicationmodel.contacts/contactlaunchactionverbs_call.md index e95450615f..c65df30bd6 100644 --- a/windows.applicationmodel.contacts/contactlaunchactionverbs_call.md +++ b/windows.applicationmodel.contacts/contactlaunchactionverbs_call.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call ## -description Gets the call contact action. ## -property-value The call contact action. ## -remarks ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call + +## -description +Gets the call contact action. + +## -property-value +The call contact action. + +## -remarks + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlaunchactionverbs_map.md b/windows.applicationmodel.contacts/contactlaunchactionverbs_map.md index d293f3b817..55f8e79217 100644 --- a/windows.applicationmodel.contacts/contactlaunchactionverbs_map.md +++ b/windows.applicationmodel.contacts/contactlaunchactionverbs_map.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map ## -description Gets the map contact action. ## -property-value The map contact action. ## -remarks ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map + +## -description +Gets the map contact action. + +## -property-value +The map contact action. + +## -remarks + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlaunchactionverbs_message.md b/windows.applicationmodel.contacts/contactlaunchactionverbs_message.md index 6660d25a1b..dd03361609 100644 --- a/windows.applicationmodel.contacts/contactlaunchactionverbs_message.md +++ b/windows.applicationmodel.contacts/contactlaunchactionverbs_message.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message ## -description Gets the send message to a contact action. ## -property-value The send message to a contact action. ## -remarks ## -examples ## -see-also [Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message + +## -description +Gets the send message to a contact action. + +## -property-value +The send message to a contact action. + +## -remarks + +## -examples + +## -see-also +[Handling Contact Actions sample](http://go.microsoft.com/fwlink/p/?LinkID=320151) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlaunchactionverbs_post.md b/windows.applicationmodel.contacts/contactlaunchactionverbs_post.md index 4da225c348..ac72e64352 100644 --- a/windows.applicationmodel.contacts/contactlaunchactionverbs_post.md +++ b/windows.applicationmodel.contacts/contactlaunchactionverbs_post.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post ## -description Gets the post to a contact action. ## -property-value The post to a contact action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Post + +## -description +Gets the post to a contact action. + +## -property-value +The post to a contact action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlaunchactionverbs_videocall.md b/windows.applicationmodel.contacts/contactlaunchactionverbs_videocall.md index 860af01344..4213394de5 100644 --- a/windows.applicationmodel.contacts/contactlaunchactionverbs_videocall.md +++ b/windows.applicationmodel.contacts/contactlaunchactionverbs_videocall.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall ## -description Gets the video call contact action. ## -property-value The video call contact action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.VideoCall + +## -description +Gets the video call contact action. + +## -property-value +The video call contact action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist.md b/windows.applicationmodel.contacts/contactlist.md index 1984f11823..05689ec156 100644 --- a/windows.applicationmodel.contacts/contactlist.md +++ b/windows.applicationmodel.contacts/contactlist.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactList --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactList ## -description Represents a list of [Contact](contact.md) objects. ## -remarks Call [ContactStore.CreateContactListAsync](contactstore_createcontactlistasync_1732290999.md) to create a new instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactList +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactList + +## -description +Represents a list of [Contact](contact.md) objects. + +## -remarks +Call [ContactStore.CreateContactListAsync](contactstore_createcontactlistasync_1732290999.md) to create a new instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_changetracker.md b/windows.applicationmodel.contacts/contactlist_changetracker.md index 668c9984fe..50ef90f88d 100644 --- a/windows.applicationmodel.contacts/contactlist_changetracker.md +++ b/windows.applicationmodel.contacts/contactlist_changetracker.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.ChangeTracker --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.ChangeTracker ## -description Gets the app's [ContactChangeTracker](contactchangetracker.md) for this [ContactList](contactlist.md). ## -property-value The app's [ContactChangeTracker](contactchangetracker.md) for this [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.ChangeTracker +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.ChangeTracker + +## -description +Gets the app's [ContactChangeTracker](contactchangetracker.md) for this [ContactList](contactlist.md). + +## -property-value +The app's [ContactChangeTracker](contactchangetracker.md) for this [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_contactchanged.md b/windows.applicationmodel.contacts/contactlist_contactchanged.md index c38ed893cb..2a9958ba48 100644 --- a/windows.applicationmodel.contacts/contactlist_contactchanged.md +++ b/windows.applicationmodel.contacts/contactlist_contactchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Contacts.ContactList.ContactChanged --api-type: winrt event ---- # Windows.ApplicationModel.Contacts.ContactList.ContactChanged ## -description Occurs when a [Contact](contact.md) in this [ContactList](contactlist.md) has been changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Contacts.ContactList.ContactChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.ContactChanged + +## -description +Occurs when a [Contact](contact.md) in this [ContactList](contactlist.md) has been changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_deleteasync_1247887881.md b/windows.applicationmodel.contacts/contactlist_deleteasync_1247887881.md index a300b7952a..bf98800184 100644 --- a/windows.applicationmodel.contacts/contactlist_deleteasync_1247887881.md +++ b/windows.applicationmodel.contacts/contactlist_deleteasync_1247887881.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.DeleteAsync ## -description Asynchronously deletes this [ContactList](contactlist.md), including all [Contact](contact.md) objects in the [ContactStore](contactstore.md). ## -returns An async action indicating that the method is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.DeleteAsync + +## -description +Asynchronously deletes this [ContactList](contactlist.md), including all [Contact](contact.md) objects in the [ContactStore](contactstore.md). + +## -returns +An async action indicating that the method is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_deletecontactasync_426490896.md b/windows.applicationmodel.contacts/contactlist_deletecontactasync_426490896.md index 224831c720..61930e2dcb 100644 --- a/windows.applicationmodel.contacts/contactlist_deletecontactasync_426490896.md +++ b/windows.applicationmodel.contacts/contactlist_deletecontactasync_426490896.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.DeleteContactAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.DeleteContactAsync ## -description Asynchronously deletes and individual [Contact](contact.md) from this [ContactList](contactlist.md) and the [ContactStore](contactstore.md). ## -parameters ### -param contact The [Contact](contact.md) to delete. ## -returns An async action indicating that the method is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.DeleteContactAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.DeleteContactAsync + +## -description +Asynchronously deletes and individual [Contact](contact.md) from this [ContactList](contactlist.md) and the [ContactStore](contactstore.md). + +## -parameters +### -param contact +The [Contact](contact.md) to delete. + +## -returns +An async action indicating that the method is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_displayname.md b/windows.applicationmodel.contacts/contactlist_displayname.md index cbe04fb9cc..fa5fce50cf 100644 --- a/windows.applicationmodel.contacts/contactlist_displayname.md +++ b/windows.applicationmodel.contacts/contactlist_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.DisplayName ## -description Gets or puts the name of the [ContactList](contactlist.md), suitable for display in the user interface. ## -property-value The name of the [ContactList](contactlist.md), suitable for display in the user interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.DisplayName + +## -description +Gets or puts the name of the [ContactList](contactlist.md), suitable for display in the user interface. + +## -property-value +The name of the [ContactList](contactlist.md), suitable for display in the user interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_getcontactasync_1631734332.md b/windows.applicationmodel.contacts/contactlist_getcontactasync_1631734332.md index 34752b2281..926a524070 100644 --- a/windows.applicationmodel.contacts/contactlist_getcontactasync_1631734332.md +++ b/windows.applicationmodel.contacts/contactlist_getcontactasync_1631734332.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.GetContactAsync ## -description Asynchronously retrieves the specified [Contact](contact.md) object from the [ContactList](contactlist.md). ## -parameters ### -param contactId The string that identifies the [Contact](contact.md) to return. ## -returns The [Contact](contact.md) identified by the *contactId* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.GetContactAsync + +## -description +Asynchronously retrieves the specified [Contact](contact.md) object from the [ContactList](contactlist.md). + +## -parameters +### -param contactId +The string that identifies the [Contact](contact.md) to return. + +## -returns +The [Contact](contact.md) identified by the *contactId* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_getcontactfromremoteidasync_246930772.md b/windows.applicationmodel.contacts/contactlist_getcontactfromremoteidasync_246930772.md index 94487e1799..62ea0a5e53 100644 --- a/windows.applicationmodel.contacts/contactlist_getcontactfromremoteidasync_246930772.md +++ b/windows.applicationmodel.contacts/contactlist_getcontactfromremoteidasync_246930772.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactFromRemoteIdAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.GetContactFromRemoteIdAsync ## -description Asynchronously gets the [Contact](contact.md) identified by the specified [RemoteId](contact_remoteid.md). ## -parameters ### -param remoteId An ID that can be used by a service provider to access the [Contact](contact.md) in their remote system. ## -returns The [Contact](contact.md) identified by the *remoteId* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactFromRemoteIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.GetContactFromRemoteIdAsync + +## -description +Asynchronously gets the [Contact](contact.md) identified by the specified [RemoteId](contact_remoteid.md). + +## -parameters +### -param remoteId +An ID that can be used by a service provider to access the [Contact](contact.md) in their remote system. + +## -returns +The [Contact](contact.md) identified by the *remoteId* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_getcontactreader_1032732501.md b/windows.applicationmodel.contacts/contactlist_getcontactreader_1032732501.md index d510d96fdb..8f849bbdd9 100644 --- a/windows.applicationmodel.contacts/contactlist_getcontactreader_1032732501.md +++ b/windows.applicationmodel.contacts/contactlist_getcontactreader_1032732501.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactReader(Windows.ApplicationModel.Contacts.ContactQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.GetContactReader ## -description Gets a [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md) and using the specified [ContactQueryOptions](contactqueryoptions.md). ## -parameters ### -param options The [ContactQueryOptions](contactqueryoptions.md) to use when creating the [ContactReader](contactreader.md). ## -returns A [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also [GetContactReader](contactlist_getcontactreader_1793921473.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactReader(Windows.ApplicationModel.Contacts.ContactQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.GetContactReader + +## -description +Gets a [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md) and using the specified [ContactQueryOptions](contactqueryoptions.md). + +## -parameters +### -param options +The [ContactQueryOptions](contactqueryoptions.md) to use when creating the [ContactReader](contactreader.md). + +## -returns +A [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also +[GetContactReader](contactlist_getcontactreader_1793921473.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlist_getcontactreader_1793921473.md b/windows.applicationmodel.contacts/contactlist_getcontactreader_1793921473.md index 3e63938276..d492399387 100644 --- a/windows.applicationmodel.contacts/contactlist_getcontactreader_1793921473.md +++ b/windows.applicationmodel.contacts/contactlist_getcontactreader_1793921473.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactReader --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.GetContactReader ## -description Gets a [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md). ## -returns A [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also [GetContactReader(ContactQueryOptions)](contactlist_getcontactreader_1032732501.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetContactReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.GetContactReader + +## -description +Gets a [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md). + +## -returns +A [ContactReader](contactreader.md) object associated with this [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also +[GetContactReader(ContactQueryOptions)](contactlist_getcontactreader_1032732501.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlist_getmecontactasync_559171710.md b/windows.applicationmodel.contacts/contactlist_getmecontactasync_559171710.md index 331f45550a..cc774774dd 100644 --- a/windows.applicationmodel.contacts/contactlist_getmecontactasync_559171710.md +++ b/windows.applicationmodel.contacts/contactlist_getmecontactasync_559171710.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetMeContactAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.GetMeContactAsync ## -description Asynchronously gets the [Contact](contact.md) object for the current user. ## -returns The [Contact](contact.md) object for the current user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetMeContactAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.GetMeContactAsync + +## -description +Asynchronously gets the [Contact](contact.md) object for the current user. + +## -returns +The [Contact](contact.md) object for the current user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_id.md b/windows.applicationmodel.contacts/contactlist_id.md index c7932b58f7..474e9d3386 100644 --- a/windows.applicationmodel.contacts/contactlist_id.md +++ b/windows.applicationmodel.contacts/contactlist_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.Id --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.Id ## -description Gets the locally unique identifier for this [ContactList](contactlist.md). ## -property-value The locally unique identifier for this [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.Id + +## -description +Gets the locally unique identifier for this [ContactList](contactlist.md). + +## -property-value +The locally unique identifier for this [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_ishidden.md b/windows.applicationmodel.contacts/contactlist_ishidden.md index 297c535de9..8be34f4679 100644 --- a/windows.applicationmodel.contacts/contactlist_ishidden.md +++ b/windows.applicationmodel.contacts/contactlist_ishidden.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.IsHidden --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.IsHidden ## -description Gets or puts a Boolean value indicating of the [ContactList](contactlist.md) is hidden in the user interface. ## -property-value A Boolean value indicating of the [ContactList](contactlist.md) is hidden in the user interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.IsHidden +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.IsHidden + +## -description +Gets or puts a Boolean value indicating of the [ContactList](contactlist.md) is hidden in the user interface. + +## -property-value +A Boolean value indicating of the [ContactList](contactlist.md) is hidden in the user interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_otherappreadaccess.md b/windows.applicationmodel.contacts/contactlist_otherappreadaccess.md index d04c562dae..2a3c2e0f85 100644 --- a/windows.applicationmodel.contacts/contactlist_otherappreadaccess.md +++ b/windows.applicationmodel.contacts/contactlist_otherappreadaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.OtherAppReadAccess --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.OtherAppReadAccess ## -description Gets or puts a value indicating the read access level to this [ContactList](contactlist.md) for other apps on the system. ## -property-value A value indicating the read access level to this [ContactList](contactlist.md) for other apps on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.OtherAppReadAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.OtherAppReadAccess + +## -description +Gets or puts a value indicating the read access level to this [ContactList](contactlist.md) for other apps on the system. + +## -property-value +A value indicating the read access level to this [ContactList](contactlist.md) for other apps on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_otherappwriteaccess.md b/windows.applicationmodel.contacts/contactlist_otherappwriteaccess.md index 8468428f1b..6d70fa27aa 100644 --- a/windows.applicationmodel.contacts/contactlist_otherappwriteaccess.md +++ b/windows.applicationmodel.contacts/contactlist_otherappwriteaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.OtherAppWriteAccess --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.OtherAppWriteAccess ## -description Gets or puts a value indicating the write access level to this [ContactList](contactlist.md) for other apps on the system. ## -property-value A value indicating the write access level to this [ContactList](contactlist.md) for other apps on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.OtherAppWriteAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.OtherAppWriteAccess + +## -description +Gets or puts a value indicating the write access level to this [ContactList](contactlist.md) for other apps on the system. + +## -property-value +A value indicating the write access level to this [ContactList](contactlist.md) for other apps on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_registersyncmanagerasync_1214558325.md b/windows.applicationmodel.contacts/contactlist_registersyncmanagerasync_1214558325.md index c09b848e20..46697b8b6b 100644 --- a/windows.applicationmodel.contacts/contactlist_registersyncmanagerasync_1214558325.md +++ b/windows.applicationmodel.contacts/contactlist_registersyncmanagerasync_1214558325.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.RegisterSyncManagerAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.RegisterSyncManagerAsync ## -description Adds a [SyncManager ](contactlistsyncmanager.md) to the [ContactList](contactlist.md). ## -returns An asynchronous registration operation that you can await. ## -remarks The [SyncManager](contactlistsyncmanager.md) provides an entry point for other apps to call [ContactList.SyncManager.SyncAsync](contactlistsyncmanager_syncasync.md). Calling [ContactList.SyncManager.SyncAsync](contactlistsyncmanager_syncasync.md) will launch the provider app as a background task and fire a [IContactDataProviderConnection.SyncRequested](../windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_syncrequested.md) event. An app should only call this method if they are set up as contact provider. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.RegisterSyncManagerAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.RegisterSyncManagerAsync + +## -description +Adds a [SyncManager ](contactlistsyncmanager.md) to the [ContactList](contactlist.md). + +## -returns +An asynchronous registration operation that you can await. + +## -remarks +The [SyncManager](contactlistsyncmanager.md) provides an entry point for other apps to call [ContactList.SyncManager.SyncAsync](contactlistsyncmanager_syncasync.md). Calling [ContactList.SyncManager.SyncAsync](contactlistsyncmanager_syncasync.md) will launch the provider app as a background task and fire a [IContactDataProviderConnection.SyncRequested](../windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_syncrequested.md) event. An app should only call this method if they are set up as contact provider. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_saveasync_2143735121.md b/windows.applicationmodel.contacts/contactlist_saveasync_2143735121.md index e8dcc6914b..5d5d639267 100644 --- a/windows.applicationmodel.contacts/contactlist_saveasync_2143735121.md +++ b/windows.applicationmodel.contacts/contactlist_saveasync_2143735121.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.SaveAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.SaveAsync ## -description Asynchronously saves this [ContactList](contactlist.md). ## -returns An async action indicating that the method has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.SaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.SaveAsync + +## -description +Asynchronously saves this [ContactList](contactlist.md). + +## -returns +An async action indicating that the method has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_savecontactasync_64942310.md b/windows.applicationmodel.contacts/contactlist_savecontactasync_64942310.md index 8894dcdae3..c07e1c6fb7 100644 --- a/windows.applicationmodel.contacts/contactlist_savecontactasync_64942310.md +++ b/windows.applicationmodel.contacts/contactlist_savecontactasync_64942310.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactList.SaveContactAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactList.SaveContactAsync ## -description Asynchronously saves the specified [Contact](contact.md) to the [ContactStore](contactstore.md). ## -parameters ### -param contact The contact to save. ## -returns An async action indicating that the method has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.SaveContactAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.SaveContactAsync + +## -description +Asynchronously saves the specified [Contact](contact.md) to the [ContactStore](contactstore.md). + +## -parameters +### -param contact +The contact to save. + +## -returns +An async action indicating that the method has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_sourcedisplayname.md b/windows.applicationmodel.contacts/contactlist_sourcedisplayname.md index 735155f246..58a94d8c7b 100644 --- a/windows.applicationmodel.contacts/contactlist_sourcedisplayname.md +++ b/windows.applicationmodel.contacts/contactlist_sourcedisplayname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.SourceDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.SourceDisplayName ## -description Gets the name of the source of the [ContactList](contactlist.md), suitable for display in the user interface. ## -property-value The name of the source of the [ContactList](contactlist.md), suitable for display in the user interface. ## -remarks This is usually the name of the app or service from which the contacts originate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.SourceDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.SourceDisplayName + +## -description +Gets the name of the source of the [ContactList](contactlist.md), suitable for display in the user interface. + +## -property-value +The name of the source of the [ContactList](contactlist.md), suitable for display in the user interface. + +## -remarks +This is usually the name of the app or service from which the contacts originate. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_supportsserversearch.md b/windows.applicationmodel.contacts/contactlist_supportsserversearch.md index fa4b130024..23c487506d 100644 --- a/windows.applicationmodel.contacts/contactlist_supportsserversearch.md +++ b/windows.applicationmodel.contacts/contactlist_supportsserversearch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.SupportsServerSearch --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.SupportsServerSearch ## -description Gets or sets a Boolean value indicating if you can search the remote server with this [ContactList](contactlist.md). ## -property-value A Boolean value indicating if you can search the remote server with this [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.SupportsServerSearch +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.SupportsServerSearch + +## -description +Gets or sets a Boolean value indicating if you can search the remote server with this [ContactList](contactlist.md). + +## -property-value +A Boolean value indicating if you can search the remote server with this [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_syncconstraints.md b/windows.applicationmodel.contacts/contactlist_syncconstraints.md index 6cfc8eeabd..36fe663a16 100644 --- a/windows.applicationmodel.contacts/contactlist_syncconstraints.md +++ b/windows.applicationmodel.contacts/contactlist_syncconstraints.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.SyncConstraints --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.SyncConstraints ## -description Gets the [ContactListSyncConstraints](contactlistsyncconstraints.md) which indicates the maximum amount of contact list data that can be synchronized. ## -property-value The [ContactListSyncConstraints](contactlistsyncconstraints.md) for this contact list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.SyncConstraints +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.SyncConstraints + +## -description +Gets the [ContactListSyncConstraints](contactlistsyncconstraints.md) which indicates the maximum amount of contact list data that can be synchronized. + +## -property-value +The [ContactListSyncConstraints](contactlistsyncconstraints.md) for this contact list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_syncmanager.md b/windows.applicationmodel.contacts/contactlist_syncmanager.md index d0844d2c98..9b09f5faa6 100644 --- a/windows.applicationmodel.contacts/contactlist_syncmanager.md +++ b/windows.applicationmodel.contacts/contactlist_syncmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.SyncManager --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.SyncManager ## -description Gets the [ContactListSyncManager](contactlistsyncmanager.md) used to communicate with the server. ## -property-value The [ContactListSyncManager](contactlistsyncmanager.md) used to communicate with the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.SyncManager +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.SyncManager + +## -description +Gets the [ContactListSyncManager](contactlistsyncmanager.md) used to communicate with the server. + +## -property-value +The [ContactListSyncManager](contactlistsyncmanager.md) used to communicate with the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlist_userdataaccountid.md b/windows.applicationmodel.contacts/contactlist_userdataaccountid.md index 45bc683e0a..790c2d60f6 100644 --- a/windows.applicationmodel.contacts/contactlist_userdataaccountid.md +++ b/windows.applicationmodel.contacts/contactlist_userdataaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactList.UserDataAccountId --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactList.UserDataAccountId ## -description Gets a string that represents the ID of the user data account for this [ContactList](contactlist.md). ## -property-value A string that represents the ID of the user data account for this [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.UserDataAccountId + +## -description +Gets a string that represents the ID of the user data account for this [ContactList](contactlist.md). + +## -property-value +A string that represents the ID of the user data account for this [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints.md b/windows.applicationmodel.contacts/contactlistsyncconstraints.md index 9fe4a37bec..8dd7311165 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactListSyncConstraints --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints ## -description Specifies limits on how much contact list data can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactListSyncConstraints +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints + +## -description +Specifies limits on how much contact list data can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_cansyncdescriptions.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_cansyncdescriptions.md index 4ca2f34ca0..cdec6bebbd 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_cansyncdescriptions.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_cansyncdescriptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.CanSyncDescriptions --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.CanSyncDescriptions ## -description Gets or sets a Boolean value that indicates whether to synchronize contact descriptions. ## -property-value **True** indicates that contact descriptions will be synchronized; **false**, otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.CanSyncDescriptions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.CanSyncDescriptions + +## -description +Gets or sets a Boolean value that indicates whether to synchronize contact descriptions. + +## -property-value +**True** indicates that contact descriptions will be synchronized; **false**, otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxanniversarydates.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxanniversarydates.md index 0114612e03..f11219df81 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxanniversarydates.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxanniversarydates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAnniversaryDates --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAnniversaryDates ## -description Gets or sets the maximum number of anniversary dates that can be synchronized. ## -property-value The maximum number of anniversary dates that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAnniversaryDates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAnniversaryDates + +## -description +Gets or sets the maximum number of anniversary dates that can be synchronized. + +## -property-value +The maximum number of anniversary dates that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxassistantphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxassistantphonenumbers.md index de112884a0..5384bb057f 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxassistantphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxassistantphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAssistantPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAssistantPhoneNumbers ## -description Gets or sets the maximum number of assistant phone numbers that can be synchronized. ## -property-value The maximum number of assistant phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAssistantPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxAssistantPhoneNumbers + +## -description +Gets or sets the maximum number of assistant phone numbers that can be synchronized. + +## -property-value +The maximum number of assistant phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbirthdaydates.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbirthdaydates.md index 06674ccb46..53f480e20c 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbirthdaydates.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbirthdaydates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBirthdayDates --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBirthdayDates ## -description Gets or sets the maximum number of birthday dates that can be synchronized. ## -property-value The maximum number of birthday dates that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBirthdayDates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBirthdayDates + +## -description +Gets or sets the maximum number of birthday dates that can be synchronized. + +## -property-value +The maximum number of birthday dates that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbusinessfaxphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbusinessfaxphonenumbers.md index 39c5f321df..d5b7026a7d 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbusinessfaxphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxbusinessfaxphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBusinessFaxPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBusinessFaxPhoneNumbers ## -description Gets or sets the maximum number of business fax numbers that can be synchronized. ## -property-value The maximum number of business fax numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBusinessFaxPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxBusinessFaxPhoneNumbers + +## -description +Gets or sets the maximum number of business fax numbers that can be synchronized. + +## -property-value +The maximum number of business fax numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxchildrelationships.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxchildrelationships.md index 82efa48402..257fbbd2a9 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxchildrelationships.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxchildrelationships.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxChildRelationships --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxChildRelationships ## -description Gets or sets the maximum number of child relationships that can be synchronized. ## -property-value The maximum number of child relationships that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxChildRelationships +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxChildRelationships + +## -description +Gets or sets the maximum number of child relationships that can be synchronized. + +## -property-value +The maximum number of child relationships that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxcompanyphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxcompanyphonenumbers.md index bbd9076b28..52ac532656 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxcompanyphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxcompanyphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxCompanyPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxCompanyPhoneNumbers ## -description Gets or sets the maximum number of company phone numbers that can be synchronized. ## -property-value The maximum number of company phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxCompanyPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxCompanyPhoneNumbers + +## -description +Gets or sets the maximum number of company phone numbers that can be synchronized. + +## -property-value +The maximum number of company phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomeaddresses.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomeaddresses.md index 8dd7b50b6f..0b91601b1d 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomeaddresses.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomeaddresses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeAddresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeAddresses ## -description Gets or sets the maximum number of home addresses that can be synchronized. ## -property-value The maximum number of home addresses that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeAddresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeAddresses + +## -description +Gets or sets the maximum number of home addresses that can be synchronized. + +## -property-value +The maximum number of home addresses that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomefaxphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomefaxphonenumbers.md index 711d29ae67..57c5c90432 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomefaxphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomefaxphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeFaxPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeFaxPhoneNumbers ## -description Gets or sets the maximum number of home fax phone numbers that can be synchronized. ## -property-value The maximum number of home fax phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeFaxPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomeFaxPhoneNumbers + +## -description +Gets or sets the maximum number of home fax phone numbers that can be synchronized. + +## -property-value +The maximum number of home fax phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomephonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomephonenumbers.md index 3552048449..0abf59a50a 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomephonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxhomephonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomePhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomePhoneNumbers ## -description Gets or sets the maximum number of home phone numbers that can be synchronized. ## -property-value The maximum number of home phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomePhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxHomePhoneNumbers + +## -description +Gets or sets the maximum number of home phone numbers that can be synchronized. + +## -property-value +The maximum number of home phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxjobinfo.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxjobinfo.md index 57870bb66a..03342a923a 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxjobinfo.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxjobinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxJobInfo --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxJobInfo ## -description Gets or sets the maximum number of job info entries that can be synchronized. ## -property-value The maximum number of job info entries that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxJobInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxJobInfo + +## -description +Gets or sets the maximum number of job info entries that can be synchronized. + +## -property-value +The maximum number of job info entries that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxmobilephonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxmobilephonenumbers.md index 3f479c9873..306952a4bb 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxmobilephonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxmobilephonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxMobilePhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxMobilePhoneNumbers ## -description Gets or sets the maximum number of mobile phone numbers that can be synchronized. ## -property-value The maximum number of mobile phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxMobilePhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxMobilePhoneNumbers + +## -description +Gets or sets the maximum number of mobile phone numbers that can be synchronized. + +## -property-value +The maximum number of mobile phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheraddresses.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheraddresses.md index f6e290f1b9..cc3ec86ef4 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheraddresses.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheraddresses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherAddresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherAddresses ## -description Gets or sets the maximum number of 'other address' entries that can be synchronized. ## -property-value The maximum number of 'other address' entries that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherAddresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherAddresses + +## -description +Gets or sets the maximum number of 'other address' entries that can be synchronized. + +## -property-value +The maximum number of 'other address' entries that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherdates.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherdates.md index 674093be56..b2e121298b 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherdates.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherdates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherDates --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherDates ## -description Gets or sets the maximum number of 'other dates' that can be synchronized. ## -property-value The maximum number of 'other dates' that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherDates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherDates + +## -description +Gets or sets the maximum number of 'other dates' that can be synchronized. + +## -property-value +The maximum number of 'other dates' that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheremailaddresses.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheremailaddresses.md index c5a183440b..18553bb3e0 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheremailaddresses.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotheremailaddresses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherEmailAddresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherEmailAddresses ## -description Gets or sets the maximum number of 'other email' addresses that can be synchronized. ## -property-value The maximum number of 'other email' addresses that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherEmailAddresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherEmailAddresses + +## -description +Gets or sets the maximum number of 'other email' addresses that can be synchronized. + +## -property-value +The maximum number of 'other email' addresses that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherphonenumbers.md index e93e6a0dd7..9dd2cff075 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherPhoneNumbers ## -description Gets or sets the maximum number of 'other phone' numbers that can be synchronized. ## -property-value The maximum number of 'other phone' numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherPhoneNumbers + +## -description +Gets or sets the maximum number of 'other phone' numbers that can be synchronized. + +## -property-value +The maximum number of 'other phone' numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherrelationships.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherrelationships.md index 0d0f3f99db..a74579ddac 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherrelationships.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxotherrelationships.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherRelationships --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherRelationships ## -description Gets or sets the maximum number of 'other relationship' entries that can be synchronized. ## -property-value The maximum number of 'other relationship' entries that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherRelationships +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxOtherRelationships + +## -description +Gets or sets the maximum number of 'other relationship' entries that can be synchronized. + +## -property-value +The maximum number of 'other relationship' entries that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpagerphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpagerphonenumbers.md index 047de42526..874701f0ac 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpagerphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpagerphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPagerPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPagerPhoneNumbers ## -description Gets or sets the maximum number of page phone numbers that can be synchronized. ## -property-value The maximum number of page phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPagerPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPagerPhoneNumbers + +## -description +Gets or sets the maximum number of page phone numbers that can be synchronized. + +## -property-value +The maximum number of page phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxparentrelationships.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxparentrelationships.md index 77c710009d..4e302e8166 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxparentrelationships.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxparentrelationships.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxParentRelationships --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxParentRelationships ## -description Gets or sets the maximum number of parent relationships that can be synchronized. ## -property-value The maximum number of parent relationships that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxParentRelationships +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxParentRelationships + +## -description +Gets or sets the maximum number of parent relationships that can be synchronized. + +## -property-value +The maximum number of parent relationships that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpartnerrelationships.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpartnerrelationships.md index 3fe238f5ce..47d1fc1646 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpartnerrelationships.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpartnerrelationships.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPartnerRelationships --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPartnerRelationships ## -description Gets or sets the maximum number of partner relationships that can be synchronized. ## -property-value The maximum number of partner relationships that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPartnerRelationships +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPartnerRelationships + +## -description +Gets or sets the maximum number of partner relationships that can be synchronized. + +## -property-value +The maximum number of partner relationships that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpersonalemailaddresses.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpersonalemailaddresses.md index 8aef829ec3..2ed2746030 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpersonalemailaddresses.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxpersonalemailaddresses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPersonalEmailAddresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPersonalEmailAddresses ## -description Gets or sets the maximum number of personal email addresses that can be synchronized. ## -property-value The maximum number of personal email addresses that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPersonalEmailAddresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxPersonalEmailAddresses + +## -description +Gets or sets the maximum number of personal email addresses that can be synchronized. + +## -property-value +The maximum number of personal email addresses that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxradiophonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxradiophonenumbers.md index ce63a6b7f3..d947c019d3 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxradiophonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxradiophonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxRadioPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxRadioPhoneNumbers ## -description Gets or sets the maximum number of radio phone numbers that can be synchronized. ## -property-value The maximum number of radio phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxRadioPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxRadioPhoneNumbers + +## -description +Gets or sets the maximum number of radio phone numbers that can be synchronized. + +## -property-value +The maximum number of radio phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxsiblingrelationships.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxsiblingrelationships.md index 6f40442bd8..37d02f737c 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxsiblingrelationships.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxsiblingrelationships.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSiblingRelationships --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSiblingRelationships ## -description Gets or sets the maximum number of sibling relationships that can be synchronized. ## -property-value The maximum number of sibling relationships that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSiblingRelationships +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSiblingRelationships + +## -description +Gets or sets the maximum number of sibling relationships that can be synchronized. + +## -property-value +The maximum number of sibling relationships that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxspouserelationships.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxspouserelationships.md index 2957ae71df..e385da5115 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxspouserelationships.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxspouserelationships.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSpouseRelationships --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSpouseRelationships ## -description Gets or sets the maximum number of spouse relationships that can be synchronized. ## -property-value The maximum number of spouse relationships that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSpouseRelationships +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxSpouseRelationships + +## -description +Gets or sets the maximum number of spouse relationships that can be synchronized. + +## -property-value +The maximum number of spouse relationships that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxwebsites.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxwebsites.md index 24f0a3b204..5646c09e16 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxwebsites.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxwebsites.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWebsites --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWebsites ## -description Gets or sets the maximum number of website entries that can be synchronized. ## -property-value The maximum number of website entries that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWebsites +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWebsites + +## -description +Gets or sets the maximum number of website entries that can be synchronized. + +## -property-value +The maximum number of website entries that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkaddresses.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkaddresses.md index da9c89e331..457a452676 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkaddresses.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkaddresses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkAddresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkAddresses ## -description Gets or sets the maximum number of work addresses that can be synchronized. ## -property-value The maximum number of work addresses that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkAddresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkAddresses + +## -description +Gets or sets the maximum number of work addresses that can be synchronized. + +## -property-value +The maximum number of work addresses that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkemailaddresses.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkemailaddresses.md index c85e2d828a..54eeaaf8af 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkemailaddresses.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkemailaddresses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkEmailAddresses --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkEmailAddresses ## -description Gets or sets the maximum number of work email addresses that can be synchronized. ## -property-value The maximum number of work email addresses that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkEmailAddresses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkEmailAddresses + +## -description +Gets or sets the maximum number of work email addresses that can be synchronized. + +## -property-value +The maximum number of work email addresses that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkphonenumbers.md b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkphonenumbers.md index 5ab5228f0b..9d20c2ec32 100644 --- a/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkphonenumbers.md +++ b/windows.applicationmodel.contacts/contactlistsyncconstraints_maxworkphonenumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkPhoneNumbers --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkPhoneNumbers ## -description Gets or sets the maximum number of work phone numbers that can be synchronized. ## -property-value The maximum number of work phone numbers that can be synchronized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkPhoneNumbers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncConstraints.MaxWorkPhoneNumbers + +## -description +Gets or sets the maximum number of work phone numbers that can be synchronized. + +## -property-value +The maximum number of work phone numbers that can be synchronized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncmanager.md b/windows.applicationmodel.contacts/contactlistsyncmanager.md index 7715c5cb27..c438f002a5 100644 --- a/windows.applicationmodel.contacts/contactlistsyncmanager.md +++ b/windows.applicationmodel.contacts/contactlistsyncmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactListSyncManager --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactListSyncManager ## -description Provides functionality for syncing contact information with the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactListSyncManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncManager + +## -description +Provides functionality for syncing contact information with the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncmanager_lastattemptedsynctime.md b/windows.applicationmodel.contacts/contactlistsyncmanager_lastattemptedsynctime.md index 4effd8118a..7b72f4f1cf 100644 --- a/windows.applicationmodel.contacts/contactlistsyncmanager_lastattemptedsynctime.md +++ b/windows.applicationmodel.contacts/contactlistsyncmanager_lastattemptedsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncManager.LastAttemptedSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncManager.LastAttemptedSyncTime ## -description Gets or sets the last time a sync was attempted with the server. ## -property-value The last time a sync was attempted with the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncManager.LastAttemptedSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncManager.LastAttemptedSyncTime + +## -description +Gets or sets the last time a sync was attempted with the server. + +## -property-value +The last time a sync was attempted with the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncmanager_lastsuccessfulsynctime.md b/windows.applicationmodel.contacts/contactlistsyncmanager_lastsuccessfulsynctime.md index 2f063c5a58..761777c2a9 100644 --- a/windows.applicationmodel.contacts/contactlistsyncmanager_lastsuccessfulsynctime.md +++ b/windows.applicationmodel.contacts/contactlistsyncmanager_lastsuccessfulsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncManager.LastSuccessfulSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncManager.LastSuccessfulSyncTime ## -description Gets or sets the last time the [ContactList](contactlist.md) was successfully synced with the server. ## -property-value The last time the [ContactList](contactlist.md) was successfully synced with the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncManager.LastSuccessfulSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncManager.LastSuccessfulSyncTime + +## -description +Gets or sets the last time the [ContactList](contactlist.md) was successfully synced with the server. + +## -property-value +The last time the [ContactList](contactlist.md) was successfully synced with the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncmanager_status.md b/windows.applicationmodel.contacts/contactlistsyncmanager_status.md index fa6c9a2cbe..368f60784f 100644 --- a/windows.applicationmodel.contacts/contactlistsyncmanager_status.md +++ b/windows.applicationmodel.contacts/contactlistsyncmanager_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncManager.Status --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactListSyncManager.Status ## -description Gets or sets the [ContactListSyncStatus](contactlistsyncstatus.md). ## -property-value The [ContactListSyncStatus](contactlistsyncstatus.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactListSyncManager.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncManager.Status + +## -description +Gets or sets the [ContactListSyncStatus](contactlistsyncstatus.md). + +## -property-value +The [ContactListSyncStatus](contactlistsyncstatus.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncmanager_syncasync_2144191352.md b/windows.applicationmodel.contacts/contactlistsyncmanager_syncasync_2144191352.md index 689846e20a..61f45ef597 100644 --- a/windows.applicationmodel.contacts/contactlistsyncmanager_syncasync_2144191352.md +++ b/windows.applicationmodel.contacts/contactlistsyncmanager_syncasync_2144191352.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncAsync ## -description Asynchronously attempts to sync with the contacts server. ## -returns A Boolean value indicating if the sync was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncAsync + +## -description +Asynchronously attempts to sync with the contacts server. + +## -returns +A Boolean value indicating if the sync was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlistsyncmanager_syncstatuschanged.md b/windows.applicationmodel.contacts/contactlistsyncmanager_syncstatuschanged.md index d56ce8dbd6..eea6c6db1f 100644 --- a/windows.applicationmodel.contacts/contactlistsyncmanager_syncstatuschanged.md +++ b/windows.applicationmodel.contacts/contactlistsyncmanager_syncstatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncStatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncStatusChanged ## -description Occurs when the sync status with the server has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.ContactListSyncManager.SyncStatusChanged + +## -description +Occurs when the sync status with the server has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_category.md b/windows.applicationmodel.contacts/contactlocationfield_category.md index 222cad25c1..5ab834681d 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_category.md +++ b/windows.applicationmodel.contacts/contactlocationfield_category.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Category --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Category ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the category for the contact data. ## -property-value The category for the contact data. ## -remarks See the [ContactFieldCategory](contactfieldcategory.md) class for more info on the available values for this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Category +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Category + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the category for the contact data. + +## -property-value +The category for the contact data. + +## -remarks +See the [ContactFieldCategory](contactfieldcategory.md) class for more info on the available values for this property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_city.md b/windows.applicationmodel.contacts/contactlocationfield_city.md index fad6a22249..1bc0d17f85 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_city.md +++ b/windows.applicationmodel.contacts/contactlocationfield_city.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.City --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.City ## -description > [!NOTE] > [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Gets the contact's city. ## -property-value The contact's city. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.City +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.City + +## -description +> [!NOTE] +> [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Gets the contact's city. + +## -property-value +The contact's city. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_1454223364.md b/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_1454223364.md index ee36189478..32d77ee2d2 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_1454223364.md +++ b/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_1454223364.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactLocationField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactLocationField.ContactLocationField ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a new [ContactLocationField](contactlocationfield.md)object. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ### -param category The category the field belongs to. ## -remarks ## -examples ## -see-also [ContactLocationField(String)](contactlocationfield_contactlocationfield_290278668.md), [ContactLocationField(String, ContactFieldCategory, String, String, String, String, String)](contactlocationfield_contactlocationfield_888890244.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactLocationField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.ContactLocationField + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a new [ContactLocationField](contactlocationfield.md)object. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +### -param category +The category the field belongs to. + +## -remarks + +## -examples + +## -see-also +[ContactLocationField(String)](contactlocationfield_contactlocationfield_290278668.md), [ContactLocationField(String, ContactFieldCategory, String, String, String, String, String)](contactlocationfield_contactlocationfield_888890244.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_290278668.md b/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_290278668.md index 871b6a2bff..e4e9afe072 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_290278668.md +++ b/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactLocationField.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactLocationField.ContactLocationField ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a new [ContactLocationField](contactlocationfield.md)object. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ## -remarks ## -examples ## -see-also [ContactLocationField(String, ContactFieldCategory)](contactlocationfield_contactlocationfield_1454223364.md), [ContactLocationField(String, ContactFieldCategory, String, String, String, String, String)](contactlocationfield_contactlocationfield_888890244.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactLocationField.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.ContactLocationField + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a new [ContactLocationField](contactlocationfield.md)object. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +## -remarks + +## -examples + +## -see-also +[ContactLocationField(String, ContactFieldCategory)](contactlocationfield_contactlocationfield_1454223364.md), [ContactLocationField(String, ContactFieldCategory, String, String, String, String, String)](contactlocationfield_contactlocationfield_888890244.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_888890244.md b/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_888890244.md index 519203ea15..8542e3037f 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_888890244.md +++ b/windows.applicationmodel.contacts/contactlocationfield_contactlocationfield_888890244.md @@ -1,3 +1,45 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactLocationField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactLocationField.ContactLocationField ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a new [ContactLocationField](contactlocationfield.md)object. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ### -param category The category for the contact data. ### -param street The street address of the contact. ### -param city The name of the city for this contact's address. ### -param region The name of the region for this contact's address. ### -param country The name of the country for this contact's address. ### -param postalCode The postal code for this contact's address. ## -remarks ## -examples ## -see-also [ContactLocationField(String)](contactlocationfield_contactlocationfield_290278668.md), [ContactLocationField(String, ContactFieldCategory)](contactlocationfield_contactlocationfield_1454223364.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactLocationField.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.ContactLocationField + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a new [ContactLocationField](contactlocationfield.md)object. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +### -param category +The category for the contact data. + +### -param street +The street address of the contact. + +### -param city +The name of the city for this contact's address. + +### -param region +The name of the region for this contact's address. + +### -param country +The name of the country for this contact's address. + +### -param postalCode +The postal code for this contact's address. + +## -remarks + +## -examples + +## -see-also +[ContactLocationField(String)](contactlocationfield_contactlocationfield_290278668.md), [ContactLocationField(String, ContactFieldCategory)](contactlocationfield_contactlocationfield_1454223364.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactlocationfield_country.md b/windows.applicationmodel.contacts/contactlocationfield_country.md index 7e262b63d0..66428eb9ff 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_country.md +++ b/windows.applicationmodel.contacts/contactlocationfield_country.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Country --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Country ## -description > [!NOTE] > [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Gets the contact's country. ## -property-value The contact's country. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Country +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Country + +## -description +> [!NOTE] +> [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Gets the contact's country. + +## -property-value +The contact's country. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_name.md b/windows.applicationmodel.contacts/contactlocationfield_name.md index 6d8e4f2da5..bda37c0c26 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_name.md +++ b/windows.applicationmodel.contacts/contactlocationfield_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Name --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Name ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the name of the field. ## -property-value The name of the field. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Name + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the name of the field. + +## -property-value +The name of the field. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_postalcode.md b/windows.applicationmodel.contacts/contactlocationfield_postalcode.md index 255770e823..f0f644c6a4 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_postalcode.md +++ b/windows.applicationmodel.contacts/contactlocationfield_postalcode.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.PostalCode --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.PostalCode ## -description > [!NOTE] > [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Gets the contact's postal code. ## -property-value The contact's postal code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.PostalCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.PostalCode + +## -description +> [!NOTE] +> [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Gets the contact's postal code. + +## -property-value +The contact's postal code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_region.md b/windows.applicationmodel.contacts/contactlocationfield_region.md index a38d32ae23..353ef999d0 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_region.md +++ b/windows.applicationmodel.contacts/contactlocationfield_region.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Region --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Region ## -description > [!NOTE] > [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Gets the contact's region. ## -property-value The contact's region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Region +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Region + +## -description +> [!NOTE] +> [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Gets the contact's region. + +## -property-value +The contact's region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_street.md b/windows.applicationmodel.contacts/contactlocationfield_street.md index de9f346e45..afd7717fb7 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_street.md +++ b/windows.applicationmodel.contacts/contactlocationfield_street.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Street --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Street ## -description > [!NOTE] > [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Gets the contact's street. ## -property-value The contact's street. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Street +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Street + +## -description +> [!NOTE] +> [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Gets the contact's street. + +## -property-value +The contact's street. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_type.md b/windows.applicationmodel.contacts/contactlocationfield_type.md index e20c03ef19..a81bddd501 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_type.md +++ b/windows.applicationmodel.contacts/contactlocationfield_type.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Type --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Type ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the contact field type for the data. ## -property-value The type of data. ## -remarks See the [ContactFieldType](contactfieldtype.md) class for more info on the available values for this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Type + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the contact field type for the data. + +## -property-value +The type of data. + +## -remarks +See the [ContactFieldType](contactfieldtype.md) class for more info on the available values for this property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_unstructuredaddress.md b/windows.applicationmodel.contacts/contactlocationfield_unstructuredaddress.md index a3ded101e8..8380e1e995 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_unstructuredaddress.md +++ b/windows.applicationmodel.contacts/contactlocationfield_unstructuredaddress.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.UnstructuredAddress --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.UnstructuredAddress ## -description > [!NOTE] > [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Gets a string that represents an unstructured address. ## -property-value The address of the contact in an unstructured format. ## -remarks If the contact-providing application includes an address, but doesn't specify elements such as [PostalCode](contactlocationfield_postalcode.md) or [City](contactlocationfield_city.md), the data is put in the [UnstructuredAddress](contactlocationfield_unstructuredaddress.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.UnstructuredAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.UnstructuredAddress + +## -description +> [!NOTE] +> [ContactLocationField](contactlocationfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Gets a string that represents an unstructured address. + +## -property-value +The address of the contact in an unstructured format. + +## -remarks +If the contact-providing application includes an address, but doesn't specify elements such as [PostalCode](contactlocationfield_postalcode.md) or [City](contactlocationfield_city.md), the data is put in the [UnstructuredAddress](contactlocationfield_unstructuredaddress.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactlocationfield_value.md b/windows.applicationmodel.contacts/contactlocationfield_value.md index 55b72f6e34..937be7fc35 100644 --- a/windows.applicationmodel.contacts/contactlocationfield_value.md +++ b/windows.applicationmodel.contacts/contactlocationfield_value.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Value --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactLocationField.Value ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the value of the contact data. ## -property-value The value of the contact data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactLocationField.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactLocationField.Value + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the value of the contact data. + +## -property-value +The value of the contact data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager.md b/windows.applicationmodel.contacts/contactmanager.md index dcb75944cc..6004175ce1 100644 --- a/windows.applicationmodel.contacts/contactmanager.md +++ b/windows.applicationmodel.contacts/contactmanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactManager --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactManager ## -description Represents a service that source apps can call to access contact data. ## -remarks All relevant methods of this class are static methods. For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). ## -examples ## -see-also [Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [IContactManagerInterop](http://msdn.microsoft.com/library/49328e9c-895c-4f8a-8f1c-0e2a08c291e5), [Contact cards sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624040) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager + +## -description +Represents a service that source apps can call to access contact data. + +## -remarks +All relevant methods of this class are static methods. + +For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). + +## -examples + +## -see-also +[Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [IContactManagerInterop](http://msdn.microsoft.com/library/49328e9c-895c-4f8a-8f1c-0e2a08c291e5), [Contact cards sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624040) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1509087447.md b/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1509087447.md index f97d23d294..589107f1e4 100644 --- a/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1509087447.md +++ b/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1509087447.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync ## -description Asynchronously converts a [Contact](contact.md) to a vCard. ## -parameters ### -param contact The [Contact](contact.md) to convert. ## -returns A stream containing the vCard data. ## -remarks ## -examples ## -see-also [ConvertContactToVCardAsync(Contact, UInt32)](contactmanager_convertcontacttovcardasync_1577436453.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync + +## -description +Asynchronously converts a [Contact](contact.md) to a vCard. + +## -parameters +### -param contact +The [Contact](contact.md) to convert. + +## -returns +A stream containing the vCard data. + +## -remarks + +## -examples + +## -see-also +[ConvertContactToVCardAsync(Contact, UInt32)](contactmanager_convertcontacttovcardasync_1577436453.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1577436453.md b/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1577436453.md index 41df886e97..e381786aca 100644 --- a/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1577436453.md +++ b/windows.applicationmodel.contacts/contactmanager_convertcontacttovcardasync_1577436453.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact,System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync ## -description Asynchronously converts a [Contact](contact.md) to a vCard. ## -parameters ### -param contact The [Contact](contact.md) to convert. ### -param maxBytes The maximum size for the vCard in bytes. ## -returns A stream containing the vCard data. ## -remarks ## -examples ## -see-also [ConvertContactToVCardAsync(Contact)](contactmanager_convertcontacttovcardasync_1509087447.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ConvertContactToVCardAsync + +## -description +Asynchronously converts a [Contact](contact.md) to a vCard. + +## -parameters +### -param contact +The [Contact](contact.md) to convert. + +### -param maxBytes +The maximum size for the vCard in bytes. + +## -returns +A stream containing the vCard data. + +## -remarks + +## -examples + +## -see-also +[ConvertContactToVCardAsync(Contact)](contactmanager_convertcontacttovcardasync_1509087447.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_convertvcardtocontactasync_1237609127.md b/windows.applicationmodel.contacts/contactmanager_convertvcardtocontactasync_1237609127.md index 24dd7b7c05..aa50dd8008 100644 --- a/windows.applicationmodel.contacts/contactmanager_convertvcardtocontactasync_1237609127.md +++ b/windows.applicationmodel.contacts/contactmanager_convertvcardtocontactasync_1237609127.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ConvertVCardToContactAsync(Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ConvertVCardToContactAsync ## -description Asynchronously converts a vCard to a [Contact](contact.md). ## -parameters ### -param vCard A stream containing the vCard data. ## -returns The converted [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ConvertVCardToContactAsync(Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ConvertVCardToContactAsync + +## -description +Asynchronously converts a vCard to a [Contact](contact.md). + +## -parameters +### -param vCard +A stream containing the vCard data. + +## -returns +The converted [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager_getforuser_2058550280.md b/windows.applicationmodel.contacts/contactmanager_getforuser_2058550280.md index a1355e7291..c585dae307 100644 --- a/windows.applicationmodel.contacts/contactmanager_getforuser_2058550280.md +++ b/windows.applicationmodel.contacts/contactmanager_getforuser_2058550280.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.GetForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.GetForUser ## -description Gets the [ContactManagerForUser](contactmanagerforuser.md) object for the specified user. ## -parameters ### -param user The user account to use to get the [ContactManagerForUser](contactmanagerforuser.md) object. ## -returns Returns the contact manager for the account specified by the *user* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.GetForUser + +## -description +Gets the [ContactManagerForUser](contactmanagerforuser.md) object for the specified user. + +## -parameters +### -param user +The user account to use to get the [ContactManagerForUser](contactmanagerforuser.md) object. + +## -returns +Returns the contact manager for the account specified by the *user* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager_isshowcontactcardsupported_503438519.md b/windows.applicationmodel.contacts/contactmanager_isshowcontactcardsupported_503438519.md index 9a88e99131..6f1665c07c 100644 --- a/windows.applicationmodel.contacts/contactmanager_isshowcontactcardsupported_503438519.md +++ b/windows.applicationmodel.contacts/contactmanager_isshowcontactcardsupported_503438519.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.IsShowContactCardSupported --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.IsShowContactCardSupported ## -description Gets a Boolean value indicating if the [ShowContactCard](contactmanager_showcontactcard.md) method is supported on the current platform. ## -returns A Boolean value indicating if the [ShowContactCard](contactmanager_showcontactcard.md) method is supported on the current platform. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.IsShowContactCardSupported +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.IsShowContactCardSupported + +## -description +Gets a Boolean value indicating if the [ShowContactCard](contactmanager_showcontactcard.md) method is supported on the current platform. + +## -returns +A Boolean value indicating if the [ShowContactCard](contactmanager_showcontactcard.md) method is supported on the current platform. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager_isshowdelayloadedcontactcardsupported_1618133440.md b/windows.applicationmodel.contacts/contactmanager_isshowdelayloadedcontactcardsupported_1618133440.md index 9710ce1f7b..019c706bf8 100644 --- a/windows.applicationmodel.contacts/contactmanager_isshowdelayloadedcontactcardsupported_1618133440.md +++ b/windows.applicationmodel.contacts/contactmanager_isshowdelayloadedcontactcardsupported_1618133440.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.IsShowDelayLoadedContactCardSupported --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.IsShowDelayLoadedContactCardSupported ## -description Gets a Boolean value indicating if the [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) method is supported on the current platform. ## -returns A Boolean value indicating if the [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) method is supported on the current platform. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.IsShowDelayLoadedContactCardSupported +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.IsShowDelayLoadedContactCardSupported + +## -description +Gets a Boolean value indicating if the [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) method is supported on the current platform. + +## -returns +A Boolean value indicating if the [ShowDelayLoadedContactCard](contactmanager_showdelayloadedcontactcard.md) method is supported on the current platform. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager_requestannotationstoreasync_2147083254.md b/windows.applicationmodel.contacts/contactmanager_requestannotationstoreasync_2147083254.md index a688a097a5..0a561a698d 100644 --- a/windows.applicationmodel.contacts/contactmanager_requestannotationstoreasync_2147083254.md +++ b/windows.applicationmodel.contacts/contactmanager_requestannotationstoreasync_2147083254.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.RequestAnnotationStoreAsync(Windows.ApplicationModel.Contacts.ContactAnnotationStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.RequestAnnotationStoreAsync ## -description Asynchronously requests access to the [ContactAnnotationStore](contactannotationstore.md). ## -parameters ### -param accessType Specifies the type of access request, app contact annotations or all annotations. ## -returns The requested [ContactAnnotationStore](contactannotationstore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.RequestAnnotationStoreAsync(Windows.ApplicationModel.Contacts.ContactAnnotationStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.RequestAnnotationStoreAsync + +## -description +Asynchronously requests access to the [ContactAnnotationStore](contactannotationstore.md). + +## -parameters +### -param accessType +Specifies the type of access request, app contact annotations or all annotations. + +## -returns +The requested [ContactAnnotationStore](contactannotationstore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager_requeststoreasync_112705385.md b/windows.applicationmodel.contacts/contactmanager_requeststoreasync_112705385.md index 1d27bbae41..2261e699ca 100644 --- a/windows.applicationmodel.contacts/contactmanager_requeststoreasync_112705385.md +++ b/windows.applicationmodel.contacts/contactmanager_requeststoreasync_112705385.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync(Windows.ApplicationModel.Contacts.ContactStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync ## -description Retrieves a [ContactStore](contactstore.md) object that enables searching or retrieving contacts on the device. ## -parameters ### -param accessType Specifies the type of read/write access requested. ## -returns An asynchronous operation that returns a [ContactStore](contactstore.md) object on successful completion. ## -remarks ## -examples ## -see-also [RequestStoreAsync](contactmanager_requeststoreasync_428591920.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync(Windows.ApplicationModel.Contacts.ContactStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync + +## -description +Retrieves a [ContactStore](contactstore.md) object that enables searching or retrieving contacts on the device. + +## -parameters +### -param accessType +Specifies the type of read/write access requested. + +## -returns +An asynchronous operation that returns a [ContactStore](contactstore.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also +[RequestStoreAsync](contactmanager_requeststoreasync_428591920.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_requeststoreasync_428591920.md b/windows.applicationmodel.contacts/contactmanager_requeststoreasync_428591920.md index 432da9af72..6c345b6a2f 100644 --- a/windows.applicationmodel.contacts/contactmanager_requeststoreasync_428591920.md +++ b/windows.applicationmodel.contacts/contactmanager_requeststoreasync_428591920.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync ## -description Retrieves a [ContactStore](contactstore.md) object that enables searching or retrieving contacts on the device. ## -returns An asynchronous operation that returns a [ContactStore](contactstore.md) object on successful completion. ## -remarks This method requests [AllContactsReadOnly](contactstoreaccesstype.md) access to the contact store. If you require a different level of access, call the [RequestStoreAsync(ContactStoreAccessType)](contactmanager_requeststoreasync_112705385.md) method instead. ## -examples ## -see-also [RequestStoreAsync(ContactStoreAccessType)](contactmanager_requeststoreasync_112705385.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.RequestStoreAsync + +## -description +Retrieves a [ContactStore](contactstore.md) object that enables searching or retrieving contacts on the device. + +## -returns +An asynchronous operation that returns a [ContactStore](contactstore.md) object on successful completion. + +## -remarks +This method requests [AllContactsReadOnly](contactstoreaccesstype.md) access to the contact store. If you require a different level of access, call the [RequestStoreAsync(ContactStoreAccessType)](contactmanager_requeststoreasync_112705385.md) method instead. + +## -examples + +## -see-also +[RequestStoreAsync(ContactStoreAccessType)](contactmanager_requeststoreasync_112705385.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_showcontactcard_1968125937.md b/windows.applicationmodel.contacts/contactmanager_showcontactcard_1968125937.md index 3aafa83022..4153ee7509 100644 --- a/windows.applicationmodel.contacts/contactmanager_showcontactcard_1968125937.md +++ b/windows.applicationmodel.contacts/contactmanager_showcontactcard_1968125937.md @@ -1,3 +1,48 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard ## -description Queries the operating system for a user’s contact and shows the contact data in a contact card. ## -parameters ### -param contact The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. ## -remarks > [!NOTE] > Source apps must be running in the foreground to call this method. An app that runs in the background will get an "Access Denied" exception if it calls this method. Most typical operations will result in displaying a UI. + **If there is one exact match for the requested contact:** Shows the contact card UI with information from the contacts store in the operating system. + **If there are multiple matches:** Shows the contact card UI for the first matching contact found. + **If there is no match:** Shows the contact card UI, where the contact info comes from the input *contact* object. If there's an error, such as an invalid input for the *contact* parameter, no UI is displayed. For querying purposes, phone numbers support characters 0-9 and a-z/A-Z. If you put any other characters in a phone number, they are ignored when you query the contact. For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). For querying purposes, phone numbers support characters 0-9 and a-z/A-Z. If you put any other characters in a phone number, they are ignored when you query the contact. ## -examples ## -see-also [ShowContactCard(Contact, Rect, Placement)](contactmanager_showcontactcard_2144545901.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard + +## -description +Queries the operating system for a user’s contact and shows the contact data in a contact card. + +## -parameters +### -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. + +## -remarks +> [!NOTE] +> Source apps must be running in the foreground to call this method. An app that runs in the background will get an "Access Denied" exception if it calls this method. + +Most typical operations will result in displaying a UI. ++ **If there is one exact match for the requested contact:** Shows the contact card UI with information from the contacts store in the operating system. + ++ **If there are multiple matches:** Shows the contact card UI for the first matching contact found. ++ **If there is no match:** Shows the contact card UI, where the contact info comes from the input *contact* object. + + +If there's an error, such as an invalid input for the *contact* parameter, no UI is displayed. + +For querying purposes, phone numbers support characters 0-9 and a-z/A-Z. If you put any other characters in a phone number, they are ignored when you query the contact. + +For info about how to manage contacts, see [Managing contact cards ](http://msdn.microsoft.com/library/a0667d13-a274-4cb2-982a-5bfabb0488c2) and [Managing contact cards ](http://msdn.microsoft.com/library/364d763b-adf6-410e-a892-ba4af3799b93). + +For querying purposes, phone numbers support characters 0-9 and a-z/A-Z. If you put any other characters in a phone number, they are ignored when you query the contact. + + + +## -examples + +## -see-also +[ShowContactCard(Contact, Rect, Placement)](contactmanager_showcontactcard_2144545901.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_showcontactcard_2144545901.md b/windows.applicationmodel.contacts/contactmanager_showcontactcard_2144545901.md index 2a6d523a4c..593a2c2dc0 100644 --- a/windows.applicationmodel.contacts/contactmanager_showcontactcard_2144545901.md +++ b/windows.applicationmodel.contacts/contactmanager_showcontactcard_2144545901.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard ## -description Queries the operating system for a user’s contact and shows the contact data in a contact card. ## -parameters ### -param contact The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. ## -remarks See the remarks section of this overload: [ShowContactCard](contactmanager_showcontactcard_1968125937.md). ## -examples ## -see-also [Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [IContactManagerInterop::ShowContactCardForWindow](http://msdn.microsoft.com/library/4bf4a5a4-9bf0-4bf0-bc2b-04c4c0c25c36), [ShowContactCard(Contact, Rect)](contactmanager_showcontactcard_1968125937.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard + +## -description +Queries the operating system for a user’s contact and shows the contact data in a contact card. + +## -parameters +### -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. + +## -remarks +See the remarks section of this overload: [ShowContactCard](contactmanager_showcontactcard_1968125937.md). + +## -examples + +## -see-also +[Contact manager API sample](http://go.microsoft.com/fwlink/p/?LinkID=310079), [IContactManagerInterop::ShowContactCardForWindow](http://msdn.microsoft.com/library/4bf4a5a4-9bf0-4bf0-bc2b-04c4c0c25c36), [ShowContactCard(Contact, Rect)](contactmanager_showcontactcard_1968125937.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_showcontactcard_924390565.md b/windows.applicationmodel.contacts/contactmanager_showcontactcard_924390565.md index 6f22135244..d827a588ff 100644 --- a/windows.applicationmodel.contacts/contactmanager_showcontactcard_924390565.md +++ b/windows.applicationmodel.contacts/contactmanager_showcontactcard_924390565.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.ApplicationModel.Contacts.ContactCardOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard ## -description Shows a contact card with the specified parameters. ## -parameters ### -param contact The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. ### -param contactCardOptions Specifies how to display the contact card, such as which tab to start on when displaying a mini contact card. ## -remarks See the remarks section of this overload: [ShowContactCard](contactmanager_showcontactcard_1968125937.md). ## -examples ## -see-also [ShowContactCard(Contact, Rect)](contactmanager_showcontactcard_1968125937.md), [ShowContactCard(Contact, Rect, Placement)](contactmanager_showcontactcard_2144545901.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.ApplicationModel.Contacts.ContactCardOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ShowContactCard + +## -description +Shows a contact card with the specified parameters. + +## -parameters +### -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. + +### -param contactCardOptions +Specifies how to display the contact card, such as which tab to start on when displaying a mini contact card. + +## -remarks +See the remarks section of this overload: [ShowContactCard](contactmanager_showcontactcard_1968125937.md). + +## -examples + +## -see-also +[ShowContactCard(Contact, Rect)](contactmanager_showcontactcard_1968125937.md), [ShowContactCard(Contact, Rect, Placement)](contactmanager_showcontactcard_2144545901.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_1685487355.md b/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_1685487355.md index 02f66a23c5..5c4984f2ee 100644 --- a/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_1685487355.md +++ b/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_1685487355.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.ApplicationModel.Contacts.ContactCardOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard ## -description Shows a contact card that can be updated later if the contact does not exist in the user’s contact database. ## -parameters ### -param contact The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. ### -param contactCardOptions Specifies how to display the contact card, such as which tab to start on if you are displaying a mini contact card, or what header type to use if you are showing a full contact card. ## -returns Returns the [ContactCardDelayedDataLoader](contactcarddelayeddataloader.md) object that can be used to update the contact card. ## -remarks ## -examples ## -see-also [ShowDelayLoadedContactCard(Contact, Rect, Placement)](contactmanager_showdelayloadedcontactcard_750536243.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement,Windows.ApplicationModel.Contacts.ContactCardOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard + +## -description +Shows a contact card that can be updated later if the contact does not exist in the user’s contact database. + +## -parameters +### -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. + +### -param contactCardOptions +Specifies how to display the contact card, such as which tab to start on if you are displaying a mini contact card, or what header type to use if you are showing a full contact card. + +## -returns +Returns the [ContactCardDelayedDataLoader](contactcarddelayeddataloader.md) object that can be used to update the contact card. + +## -remarks + +## -examples + +## -see-also +[ShowDelayLoadedContactCard(Contact, Rect, Placement)](contactmanager_showdelayloadedcontactcard_750536243.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_750536243.md b/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_750536243.md index fb4333ff8b..38eac5895f 100644 --- a/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_750536243.md +++ b/windows.applicationmodel.contacts/contactmanager_showdelayloadedcontactcard_750536243.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard ## -description Shows a contact card that can be updated later if the contact does not exist in the user’s contact database. ## -parameters ### -param contact The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. ### -param selection The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. ### -param preferredPlacement The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. ## -returns Returns the [ContactCardDelayedDataLoader](contactcarddelayeddataloader.md) object that can be used to update the contact card. ## -remarks ## -examples ## -see-also [ShowDelayLoadedContactCard(Contact, Rect, Placement, ContactCardOptions)](contactmanager_showdelayloadedcontactcard_1685487355.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ShowDelayLoadedContactCard + +## -description +Shows a contact card that can be updated later if the contact does not exist in the user’s contact database. + +## -parameters +### -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. + +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the [Rect](../windows.foundation/rect.md) of the button so the contact card displays around the button, not overlapping it. + +### -param preferredPlacement +The [Placement](../windows.ui.popups/placement.md) that describes the preferred placement of the contact card. + +## -returns +Returns the [ContactCardDelayedDataLoader](contactcarddelayeddataloader.md) object that can be used to update the contact card. + +## -remarks + +## -examples + +## -see-also +[ShowDelayLoadedContactCard(Contact, Rect, Placement, ContactCardOptions)](contactmanager_showdelayloadedcontactcard_1685487355.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanager_systemdisplaynameorder.md b/windows.applicationmodel.contacts/contactmanager_systemdisplaynameorder.md index 44683983e3..424c6983fa 100644 --- a/windows.applicationmodel.contacts/contactmanager_systemdisplaynameorder.md +++ b/windows.applicationmodel.contacts/contactmanager_systemdisplaynameorder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactManager.SystemDisplayNameOrder --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactManager.SystemDisplayNameOrder ## -description Gets or puts the display name order. ## -property-value Specifies the display name order. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactManager.SystemDisplayNameOrder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.SystemDisplayNameOrder + +## -description +Gets or puts the display name order. + +## -property-value +Specifies the display name order. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanager_systemsortorder.md b/windows.applicationmodel.contacts/contactmanager_systemsortorder.md index 540f83c6dd..849b328d33 100644 --- a/windows.applicationmodel.contacts/contactmanager_systemsortorder.md +++ b/windows.applicationmodel.contacts/contactmanager_systemsortorder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactManager.SystemSortOrder --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactManager.SystemSortOrder ## -description Gets or puts the sort order. ## -property-value Specifies the sort order. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactManager.SystemSortOrder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.SystemSortOrder + +## -description +Gets or puts the sort order. + +## -property-value +Specifies the sort order. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser.md b/windows.applicationmodel.contacts/contactmanagerforuser.md index 1537d49ec6..d0894fc906 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactManagerForUser --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser ## -description Represents a service that source apps can call to access contact data for a specific user. ## -remarks Call the [ContactManager.GetForUser](contactmanager_getforuser.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactManagerForUser +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser + +## -description +Represents a service that source apps can call to access contact data for a specific user. + +## -remarks +Call the [ContactManager.GetForUser](contactmanager_getforuser.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1509087447.md b/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1509087447.md index f45e9acb2b..2c249df6c5 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1509087447.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1509087447.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync ## -description Asynchronously converts a [Contact](contact.md) to a vCard. ## -parameters ### -param contact The [Contact](contact.md) to convert. ## -returns A stream containing the vCard data. ## -remarks ## -examples ## -see-also [ConvertContactToVCardAsync(Contact, UInt32)](contactmanagerforuser_convertcontacttovcardasync_1577436453.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync + +## -description +Asynchronously converts a [Contact](contact.md) to a vCard. + +## -parameters +### -param contact +The [Contact](contact.md) to convert. + +## -returns +A stream containing the vCard data. + +## -remarks + +## -examples + +## -see-also +[ConvertContactToVCardAsync(Contact, UInt32)](contactmanagerforuser_convertcontacttovcardasync_1577436453.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1577436453.md b/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1577436453.md index df4e3b7ac4..3dad7e364d 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1577436453.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_convertcontacttovcardasync_1577436453.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact,System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync ## -description Asynchronously converts a [Contact](contact.md) to a vCard. ## -parameters ### -param contact The [Contact](contact.md) to convert. ### -param maxBytes The maximum size for the vCard in bytes. ## -returns A stream containing the vCard data. ## -remarks ## -examples ## -see-also [ConvertContactToVCardAsync(Contact)](contactmanagerforuser_convertcontacttovcardasync_1509087447.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync(Windows.ApplicationModel.Contacts.Contact,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertContactToVCardAsync + +## -description +Asynchronously converts a [Contact](contact.md) to a vCard. + +## -parameters +### -param contact +The [Contact](contact.md) to convert. + +### -param maxBytes +The maximum size for the vCard in bytes. + +## -returns +A stream containing the vCard data. + +## -remarks + +## -examples + +## -see-also +[ConvertContactToVCardAsync(Contact)](contactmanagerforuser_convertcontacttovcardasync_1509087447.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_convertvcardtocontactasync_1237609127.md b/windows.applicationmodel.contacts/contactmanagerforuser_convertvcardtocontactasync_1237609127.md index 672e74166c..94ca920288 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_convertvcardtocontactasync_1237609127.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_convertvcardtocontactasync_1237609127.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertVCardToContactAsync(Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertVCardToContactAsync ## -description Asynchronously converts a vCard to a [Contact](contact.md). ## -parameters ### -param vCard A stream containing the vCard data. ## -returns The converted [Contact](contact.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertVCardToContactAsync(Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.ConvertVCardToContactAsync + +## -description +Asynchronously converts a vCard to a [Contact](contact.md). + +## -parameters +### -param vCard +A stream containing the vCard data. + +## -returns +The converted [Contact](contact.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_requestannotationstoreasync_2147083254.md b/windows.applicationmodel.contacts/contactmanagerforuser_requestannotationstoreasync_2147083254.md index 99b556dce7..306c313c6f 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_requestannotationstoreasync_2147083254.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_requestannotationstoreasync_2147083254.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestAnnotationStoreAsync(Windows.ApplicationModel.Contacts.ContactAnnotationStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestAnnotationStoreAsync ## -description Asynchronously returns the [ContactAnnotationStore](contactannotationstore.md) from the system. ## -parameters ### -param accessType Specifies the access type, such as **AllAnnotationsReadWrite** for all annotations or **AppAnnotationsReadWrite** for the calling app's annotations. ## -returns Returns the [ContactAnnotationStore](contactannotationstore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestAnnotationStoreAsync(Windows.ApplicationModel.Contacts.ContactAnnotationStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestAnnotationStoreAsync + +## -description +Asynchronously returns the [ContactAnnotationStore](contactannotationstore.md) from the system. + +## -parameters +### -param accessType +Specifies the access type, such as **AllAnnotationsReadWrite** for all annotations or **AppAnnotationsReadWrite** for the calling app's annotations. + +## -returns +Returns the [ContactAnnotationStore](contactannotationstore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_requeststoreasync_112705385.md b/windows.applicationmodel.contacts/contactmanagerforuser_requeststoreasync_112705385.md index 1196f0882d..913fa511ff 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_requeststoreasync_112705385.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_requeststoreasync_112705385.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Contacts.ContactStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestStoreAsync ## -description Asynchronously returns the [ContactStore](contactstore.md) from the system. ## -parameters ### -param accessType Specifies the access type, such as **AllContactsReadOnly** for all accounts or **AppContactsReadWrite** for the calling app's accounts. ## -returns Returns the [ContactStore](contactstore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Contacts.ContactStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.RequestStoreAsync + +## -description +Asynchronously returns the [ContactStore](contactstore.md) from the system. + +## -parameters +### -param accessType +Specifies the access type, such as **AllContactsReadOnly** for all accounts or **AppContactsReadWrite** for the calling app's accounts. + +## -returns +Returns the [ContactStore](contactstore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_systemdisplaynameorder.md b/windows.applicationmodel.contacts/contactmanagerforuser_systemdisplaynameorder.md index 153329d04f..3d4f299613 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_systemdisplaynameorder.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_systemdisplaynameorder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemDisplayNameOrder --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemDisplayNameOrder ## -description Gets or sets the display name order for contacts. ## -property-value The display name order for contacts. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemDisplayNameOrder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemDisplayNameOrder + +## -description +Gets or sets the display name order for contacts. + +## -property-value +The display name order for contacts. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_systemsortorder.md b/windows.applicationmodel.contacts/contactmanagerforuser_systemsortorder.md index c15db29f21..89bf278b9a 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_systemsortorder.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_systemsortorder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemSortOrder --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemSortOrder ## -description Gets or sets the sort order for contacts. For example, sort by last name or first name. ## -property-value The sort order. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemSortOrder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.SystemSortOrder + +## -description +Gets or sets the sort order for contacts. For example, sort by last name or first name. + +## -property-value +The sort order. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_user.md b/windows.applicationmodel.contacts/contactmanagerforuser_user.md index 76ffc7b847..785a22183b 100644 --- a/windows.applicationmodel.contacts/contactmanagerforuser_user.md +++ b/windows.applicationmodel.contacts/contactmanagerforuser_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactManagerForUser.User --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactManagerForUser.User ## -description Gets the [User](../windows.system/user.md) represented by this contact manager. ## -property-value The [User](../windows.system/user.md) represented by this contact manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactManagerForUser.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.User + +## -description +Gets the [User](../windows.system/user.md) represented by this contact manager. + +## -property-value +The [User](../windows.system/user.md) represented by this contact manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmatchreason.md b/windows.applicationmodel.contacts/contactmatchreason.md index a42df0aa34..93ca5fdaa6 100644 --- a/windows.applicationmodel.contacts/contactmatchreason.md +++ b/windows.applicationmodel.contacts/contactmatchreason.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactMatchReason --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactMatchReason ## -description Provides details about why search results matched the query parameters. ## -remarks Call [ContactReader.GetMatchingPropertiesWithMatchReason](contactreader_getmatchingpropertieswithmatchreason.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactMatchReason +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactMatchReason + +## -description +Provides details about why search results matched the query parameters. + +## -remarks +Call [ContactReader.GetMatchingPropertiesWithMatchReason](contactreader_getmatchingpropertieswithmatchreason.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmatchreason_field.md b/windows.applicationmodel.contacts/contactmatchreason_field.md index 96c55e66ed..f9dde96e7a 100644 --- a/windows.applicationmodel.contacts/contactmatchreason_field.md +++ b/windows.applicationmodel.contacts/contactmatchreason_field.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactMatchReason.Field --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactMatchReason.Field ## -description Gets the contact field type that matched the search, such as name, phone number, email address and so on. ## -property-value The contact field type that matched the search, such as name, phone number, email address and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactMatchReason.Field +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactMatchReason.Field + +## -description +Gets the contact field type that matched the search, such as name, phone number, email address and so on. + +## -property-value +The contact field type that matched the search, such as name, phone number, email address and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmatchreason_segments.md b/windows.applicationmodel.contacts/contactmatchreason_segments.md index 4d6f7db2b4..fb2ff23bcd 100644 --- a/windows.applicationmodel.contacts/contactmatchreason_segments.md +++ b/windows.applicationmodel.contacts/contactmatchreason_segments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactMatchReason.Segments --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactMatchReason.Segments ## -description Gets a list of matching [TextSegment](../windows.data.text/textsegment.md) objects which tells you what to highlight in your view as the result of a contact search. ## -property-value The list of matching [TextSegment](../windows.data.text/textsegment.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactMatchReason.Segments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactMatchReason.Segments + +## -description +Gets a list of matching [TextSegment](../windows.data.text/textsegment.md) objects which tells you what to highlight in your view as the result of a contact search. + +## -property-value +The list of matching [TextSegment](../windows.data.text/textsegment.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactmatchreason_text.md b/windows.applicationmodel.contacts/contactmatchreason_text.md index f584bf3df2..99a37086f0 100644 --- a/windows.applicationmodel.contacts/contactmatchreason_text.md +++ b/windows.applicationmodel.contacts/contactmatchreason_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactMatchReason.Text --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactMatchReason.Text ## -description Gets the matching text result from a contact search. ## -property-value The matching text result from a contact search. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactMatchReason.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactMatchReason.Text + +## -description +Gets the matching text result from a contact search. + +## -property-value +The matching text result from a contact search. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactphone_contactphone_1221375020.md b/windows.applicationmodel.contacts/contactphone_contactphone_1221375020.md index e364bf65fc..cdf8d933c2 100644 --- a/windows.applicationmodel.contacts/contactphone_contactphone_1221375020.md +++ b/windows.applicationmodel.contacts/contactphone_contactphone_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactPhone.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactPhone.ContactPhone ## -description Initializes a new instance of a [ContactPhone](contactphone.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPhone.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPhone.ContactPhone + +## -description +Initializes a new instance of a [ContactPhone](contactphone.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactphone_description.md b/windows.applicationmodel.contacts/contactphone_description.md index 83687b4df7..f20f2f962b 100644 --- a/windows.applicationmodel.contacts/contactphone_description.md +++ b/windows.applicationmodel.contacts/contactphone_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPhone.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPhone.Description ## -description Gets and sets the description of the phone for a contact. The maximum string length for the description is 512 characters. ## -property-value The description of the phone for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPhone.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPhone.Description + +## -description +Gets and sets the description of the phone for a contact. The maximum string length for the description is 512 characters. + +## -property-value +The description of the phone for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactphone_kind.md b/windows.applicationmodel.contacts/contactphone_kind.md index 0122e27fcd..045da39e47 100644 --- a/windows.applicationmodel.contacts/contactphone_kind.md +++ b/windows.applicationmodel.contacts/contactphone_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPhone.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPhone.Kind ## -description Gets and sets the kind of phone for a contact. ## -property-value A [ContactPhoneKind](contactphonekind.md)-typed value that indicates the kind of phone. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPhone.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPhone.Kind + +## -description +Gets and sets the kind of phone for a contact. + +## -property-value +A [ContactPhoneKind](contactphonekind.md)-typed value that indicates the kind of phone. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactphone_number.md b/windows.applicationmodel.contacts/contactphone_number.md index c19ce75b5d..5babd7d01a 100644 --- a/windows.applicationmodel.contacts/contactphone_number.md +++ b/windows.applicationmodel.contacts/contactphone_number.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPhone.Number --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPhone.Number ## -description Gets and sets the phone number of a phone for a contact. The maximum string length for the phone number is 50 characters. ## -property-value The phone number of a phone for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPhone.Number +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPhone.Number + +## -description +Gets and sets the phone number of a phone for a contact. The maximum string length for the phone number is 50 characters. + +## -property-value +The phone number of a phone for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactpicker_commitbuttontext.md b/windows.applicationmodel.contacts/contactpicker_commitbuttontext.md index 66f767efa5..6771f7a622 100644 --- a/windows.applicationmodel.contacts/contactpicker_commitbuttontext.md +++ b/windows.applicationmodel.contacts/contactpicker_commitbuttontext.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.CommitButtonText --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPicker.CommitButtonText ## -description Sets the text for the confirmation button in the Contact Picker user interface. > [!NOTE] > This property is no longer available starting with Windows 10. ## -property-value The text of the button. ## -remarks We recommend you set [CommitButtonText](contactpicker_commitbuttontext.md) to provide an indication to the user that they have selected a contact or set of contacts. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.CommitButtonText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.CommitButtonText + +## -description +Sets the text for the confirmation button in the Contact Picker user interface. + +> [!NOTE] +> This property is no longer available starting with Windows 10. + +## -property-value +The text of the button. + +## -remarks +We recommend you set [CommitButtonText](contactpicker_commitbuttontext.md) to provide an indication to the user that they have selected a contact or set of contacts. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactpicker_contactpicker_1221375020.md b/windows.applicationmodel.contacts/contactpicker_contactpicker_1221375020.md index 8350c5048a..3c0a25275d 100644 --- a/windows.applicationmodel.contacts/contactpicker_contactpicker_1221375020.md +++ b/windows.applicationmodel.contacts/contactpicker_contactpicker_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactPicker.ContactPicker ## -description Creates a new instance of the [ContactPicker](contactpicker.md) class. ## -remarks To select contacts, create an instance of this class and then use either the [PickSingleContactAsync](contactpicker_picksinglecontactasync.md) or [PickMultipleContactsAsync](contactpicker_pickmultiplecontactsasync.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.ContactPicker + +## -description +Creates a new instance of the [ContactPicker](contactpicker.md) class. + +## -remarks +To select contacts, create an instance of this class and then use either the [PickSingleContactAsync](contactpicker_picksinglecontactasync.md) or [PickMultipleContactsAsync](contactpicker_pickmultiplecontactsasync.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactpicker_desiredfields.md b/windows.applicationmodel.contacts/contactpicker_desiredfields.md index d349b366e4..2cb9f3ce36 100644 --- a/windows.applicationmodel.contacts/contactpicker_desiredfields.md +++ b/windows.applicationmodel.contacts/contactpicker_desiredfields.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.DesiredFields --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPicker.DesiredFields ## -description Sets the contact fields your app is interested in. > [!NOTE] > This property is no longer available starting with Windows 10. ## -property-value An array of strings that represent the field names your app is interested in. ## -remarks If you choose only one field with this method, a contact is considered a match if it has that field. If you choose multiple fields, a contact is considered a match if it has any of the fields. When selecting fields, list them in order of preference. For example, if you want both phone numbers and email addresses, but prefer phone numbers, put the PhoneNumber field before the Email field. To specify a specific field, use the [KnownContactField](knowncontactfield.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.DesiredFields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.DesiredFields + +## -description +Sets the contact fields your app is interested in. + +> [!NOTE] +> This property is no longer available starting with Windows 10. + +## -property-value +An array of strings that represent the field names your app is interested in. + +## -remarks +If you choose only one field with this method, a contact is considered a match if it has that field. If you choose multiple fields, a contact is considered a match if it has any of the fields. + +When selecting fields, list them in order of preference. For example, if you want both phone numbers and email addresses, but prefer phone numbers, put the PhoneNumber field before the Email field. + +To specify a specific field, use the [KnownContactField](knowncontactfield.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactpicker_desiredfieldswithcontactfieldtype.md b/windows.applicationmodel.contacts/contactpicker_desiredfieldswithcontactfieldtype.md index 3060f28fe7..c8cc8e48ab 100644 --- a/windows.applicationmodel.contacts/contactpicker_desiredfieldswithcontactfieldtype.md +++ b/windows.applicationmodel.contacts/contactpicker_desiredfieldswithcontactfieldtype.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.DesiredFieldsWithContactFieldType --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPicker.DesiredFieldsWithContactFieldType ## -description Gets the ways to connect with a contact. ## -property-value An array of [ContactFieldType](contactfieldtype.md)-typed values for a contact. ## -remarks For info about how to select contacts, see [Selecting contacts](http://msdn.microsoft.com/library/35fedee6-2b0e-4391-84ba-5e9191d4e442) and [Quickstart: Selecting user contacts ](http://msdn.microsoft.com/library/1330470e-efd2-41e1-934e-08ec081ba3c2). ## -examples ## -see-also [Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.DesiredFieldsWithContactFieldType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.DesiredFieldsWithContactFieldType + +## -description +Gets the ways to connect with a contact. + +## -property-value +An array of [ContactFieldType](contactfieldtype.md)-typed values for a contact. + +## -remarks +For info about how to select contacts, see [Selecting contacts](http://msdn.microsoft.com/library/35fedee6-2b0e-4391-84ba-5e9191d4e442) and [Quickstart: Selecting user contacts ](http://msdn.microsoft.com/library/1330470e-efd2-41e1-934e-08ec081ba3c2). + +## -examples + + +## -see-also +[Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactpicker_pickcontactasync_1323728873.md b/windows.applicationmodel.contacts/contactpicker_pickcontactasync_1323728873.md index 32be8c48af..6f762d49e8 100644 --- a/windows.applicationmodel.contacts/contactpicker_pickcontactasync_1323728873.md +++ b/windows.applicationmodel.contacts/contactpicker_pickcontactasync_1323728873.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickContactAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactPicker.PickContactAsync ## -description Launches the Contact Picker to select a single contact. ## -returns The operation that launches the Contact Picker. ## -remarks To pick multiple contacts at once, use [PickContactsAsync](contactpicker_pickcontactsasync.md). For info about how to select contacts, see [Selecting contacts](http://msdn.microsoft.com/library/35fedee6-2b0e-4391-84ba-5e9191d4e442) and [Quickstart: Selecting user contacts ](http://msdn.microsoft.com/library/1330470e-efd2-41e1-934e-08ec081ba3c2). ## -examples ## -see-also [Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickContactAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.PickContactAsync + +## -description +Launches the Contact Picker to select a single contact. + +## -returns +The operation that launches the Contact Picker. + +## -remarks +To pick multiple contacts at once, use [PickContactsAsync](contactpicker_pickcontactsasync.md). + +For info about how to select contacts, see [Selecting contacts](http://msdn.microsoft.com/library/35fedee6-2b0e-4391-84ba-5e9191d4e442) and [Quickstart: Selecting user contacts ](http://msdn.microsoft.com/library/1330470e-efd2-41e1-934e-08ec081ba3c2). + +## -examples + +## -see-also +[Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactpicker_pickcontactsasync_540067144.md b/windows.applicationmodel.contacts/contactpicker_pickcontactsasync_540067144.md index 9aa3cb9922..c5ebd61797 100644 --- a/windows.applicationmodel.contacts/contactpicker_pickcontactsasync_540067144.md +++ b/windows.applicationmodel.contacts/contactpicker_pickcontactsasync_540067144.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickContactsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactPicker.PickContactsAsync ## -description Launches the Contact Picker for selecting multiple contacts. ## -returns The operation that launches the contact picker. ## -remarks To pick only a single contact, use [PickContactAsync](contactpicker_pickcontactasync.md). For info about how to select contacts, see [Selecting contacts](http://msdn.microsoft.com/library/35fedee6-2b0e-4391-84ba-5e9191d4e442) and [Quickstart: Selecting user contacts ](http://msdn.microsoft.com/library/1330470e-efd2-41e1-934e-08ec081ba3c2). ## -examples ## -see-also [Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickContactsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.PickContactsAsync + +## -description +Launches the Contact Picker for selecting multiple contacts. + +## -returns +The operation that launches the contact picker. + +## -remarks +To pick only a single contact, use [PickContactAsync](contactpicker_pickcontactasync.md). + +For info about how to select contacts, see [Selecting contacts](http://msdn.microsoft.com/library/35fedee6-2b0e-4391-84ba-5e9191d4e442) and [Quickstart: Selecting user contacts ](http://msdn.microsoft.com/library/1330470e-efd2-41e1-934e-08ec081ba3c2). + +## -examples + +## -see-also +[Contact Picker app sample](http://go.microsoft.com/fwlink/p/?linkid=231575) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactpicker_pickmultiplecontactsasync_1630502573.md b/windows.applicationmodel.contacts/contactpicker_pickmultiplecontactsasync_1630502573.md index ddf82803d3..ce290ee6f5 100644 --- a/windows.applicationmodel.contacts/contactpicker_pickmultiplecontactsasync_1630502573.md +++ b/windows.applicationmodel.contacts/contactpicker_pickmultiplecontactsasync_1630502573.md @@ -1,34 +1,34 @@ ---- --api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickMultipleContactsAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.Contacts.ContactPicker.PickMultipleContactsAsync - -## -description -Launches the Contact Picker for selecting multiple contacts. - -> [!NOTE] -> This method is no longer available starting with Windows 10. - -## -returns -The operation that launches the contact picker. - -## -remarks -To pick only a single contact, use [PickSingleContactAsync](contactpicker_picksinglecontactasync.md). - -Use the [SelectionMode](contactpicker_selectionmode.md) property to control whether your app receives all of a contact's information, or just specific fields. - -## -examples -This example demonstrates how to use [PickMultipleContactsAsync](contactpicker_pickmultiplecontactsasync.md) to get multiple contacts. - - - -[!code-js[ContactsMultiPicker](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsMultiPicker)] - -## -see-also -[PickContactsAsync](contactpicker_pickcontactsasync.md) +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickMultipleContactsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.PickMultipleContactsAsync + +## -description +Launches the Contact Picker for selecting multiple contacts. + +> [!NOTE] +> This method is no longer available starting with Windows 10. + +## -returns +The operation that launches the contact picker. + +## -remarks +To pick only a single contact, use [PickSingleContactAsync](contactpicker_picksinglecontactasync.md). + +Use the [SelectionMode](contactpicker_selectionmode.md) property to control whether your app receives all of a contact's information, or just specific fields. + +## -examples +This example demonstrates how to use [PickMultipleContactsAsync](contactpicker_pickmultiplecontactsasync.md) to get multiple contacts. + + + +[!code-js[ContactsMultiPicker](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsMultiPicker)] + +## -see-also +[PickContactsAsync](contactpicker_pickcontactsasync.md) diff --git a/windows.applicationmodel.contacts/contactpicker_picksinglecontactasync_2033050338.md b/windows.applicationmodel.contacts/contactpicker_picksinglecontactasync_2033050338.md index f2165fcdfa..bd361ad96b 100644 --- a/windows.applicationmodel.contacts/contactpicker_picksinglecontactasync_2033050338.md +++ b/windows.applicationmodel.contacts/contactpicker_picksinglecontactasync_2033050338.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickSingleContactAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactPicker.PickSingleContactAsync ## -description Launches the Contact Picker for selecting a single contact. > [!NOTE] > This method is no longer available starting with Windows 10. ## -returns The operation that launches the Contact Picker. ## -remarks To pick multiple contacts at once, use [PickMultipleContactsAsync](contactpicker_pickmultiplecontactsasync.md). Use the [SelectionMode](contactpicker_selectionmode.md) property to control whether your app receives all of a contact's information, or just specific fields. ## -examples ## -see-also [PickContactAsync](contactpicker_pickcontactasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.PickSingleContactAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.PickSingleContactAsync + +## -description +Launches the Contact Picker for selecting a single contact. + +> [!NOTE] +> This method is no longer available starting with Windows 10. + +## -returns +The operation that launches the Contact Picker. + +## -remarks +To pick multiple contacts at once, use [PickMultipleContactsAsync](contactpicker_pickmultiplecontactsasync.md). + +Use the [SelectionMode](contactpicker_selectionmode.md) property to control whether your app receives all of a contact's information, or just specific fields. + +## -examples + + +## -see-also +[PickContactAsync](contactpicker_pickcontactasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactpicker_selectionmode.md b/windows.applicationmodel.contacts/contactpicker_selectionmode.md index d332c74dc5..78d626302c 100644 --- a/windows.applicationmodel.contacts/contactpicker_selectionmode.md +++ b/windows.applicationmodel.contacts/contactpicker_selectionmode.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.SelectionMode --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactPicker.SelectionMode ## -description Controls whether the Contact Picker shows contacts as a complete entity or as a collection of fields. > [!NOTE] > This property is no longer available starting with Windows 10. ## -property-value The mode for the Contact Picker user interface. You can set this to **Contacts** or **Fields**. ## -remarks A contact can contain a lot of information. If you want all of this information, set the [SelectionMode](contactpicker_selectionmode.md) property to return the entire contact. If you are only interested in specific fields, set this property to return only a selection of fields, then use the [DesiredFields](contactpicker_desiredfields.md) property to specify which fields you want. Use the [ContactSelectionMode](contactselectionmode.md) enumeration to set the value of this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.SelectionMode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.SelectionMode + +## -description +Controls whether the Contact Picker shows contacts as a complete entity or as a collection of fields. + +> [!NOTE] +> This property is no longer available starting with Windows 10. + +## -property-value +The mode for the Contact Picker user interface. You can set this to **Contacts** or **Fields**. + +## -remarks +A contact can contain a lot of information. If you want all of this information, set the [SelectionMode](contactpicker_selectionmode.md) property to return the entire contact. If you are only interested in specific fields, set this property to return only a selection of fields, then use the [DesiredFields](contactpicker_desiredfields.md) property to specify which fields you want. + +Use the [ContactSelectionMode](contactselectionmode.md) enumeration to set the value of this property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions.md b/windows.applicationmodel.contacts/contactqueryoptions.md index 0927bc1194..57c9f5b28d 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions.md +++ b/windows.applicationmodel.contacts/contactqueryoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactQueryOptions --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions ## -description Used to specify the query options when searching for contacts. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactQueryOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions + +## -description +Used to specify the query options when searching for contacts. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions_annotationlistids.md b/windows.applicationmodel.contacts/contactqueryoptions_annotationlistids.md index 82fc4573aa..99c1fde889 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_annotationlistids.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_annotationlistids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.AnnotationListIds --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.AnnotationListIds ## -description Gets a list to which you can add [ContactAnnotationList.Id](contactannotationlist_id.md) values for which to search. ## -property-value A list to which you can add [ContactAnnotationList.Id](contactannotationlist_id.md) values for which to search. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.AnnotationListIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.AnnotationListIds + +## -description +Gets a list to which you can add [ContactAnnotationList.Id](contactannotationlist_id.md) values for which to search. + +## -property-value +A list to which you can add [ContactAnnotationList.Id](contactannotationlist_id.md) values for which to search. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions_contactlistids.md b/windows.applicationmodel.contacts/contactqueryoptions_contactlistids.md index afa52da535..88b47f3817 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_contactlistids.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_contactlistids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactListIds --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactListIds ## -description Gets a list to which you can add [ContactList.Id](contactlist_id.md) values for which to search. ## -property-value A list to which you can add [ContactList.Id](contactlist_id.md) values for which to search. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactListIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactListIds + +## -description +Gets a list to which you can add [ContactList.Id](contactlist_id.md) values for which to search. + +## -property-value +A list to which you can add [ContactList.Id](contactlist_id.md) values for which to search. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_1221375020.md b/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_1221375020.md index 26ce777cfa..128461de39 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_1221375020.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactQueryOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactQueryOptions ## -description Initializes a new instance of the [ContactQueryOptions](contactqueryoptions.md) class. ## -remarks ## -examples ## -see-also [ContactQueryOptions(String)](contactqueryoptions_contactqueryoptions_290278668.md), [ContactQueryOptions(String, ContactQuerySearchFields)](contactqueryoptions_contactqueryoptions_130232662.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactQueryOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactQueryOptions + +## -description +Initializes a new instance of the [ContactQueryOptions](contactqueryoptions.md) class. + +## -remarks + +## -examples + +## -see-also +[ContactQueryOptions(String)](contactqueryoptions_contactqueryoptions_290278668.md), [ContactQueryOptions(String, ContactQuerySearchFields)](contactqueryoptions_contactqueryoptions_130232662.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_130232662.md b/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_130232662.md index b0db966fd7..96e0a1dea2 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_130232662.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_130232662.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactQueryOptions.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactQuerySearchFields) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactQueryOptions ## -description Initializes a new instance of the [ContactQueryOptions](contactqueryoptions.md) class. ## -parameters ### -param text The text to match in the search operation. ### -param fields Specifies which contact fields to search for a match. ## -remarks ## -examples ## -see-also [ContactQueryOptions(String)](contactqueryoptions_contactqueryoptions_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactQueryOptions.#ctor(System.String,Windows.ApplicationModel.Contacts.ContactQuerySearchFields) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactQueryOptions + +## -description +Initializes a new instance of the [ContactQueryOptions](contactqueryoptions.md) class. + +## -parameters +### -param text +The text to match in the search operation. + +### -param fields +Specifies which contact fields to search for a match. + +## -remarks + +## -examples + +## -see-also +[ContactQueryOptions(String)](contactqueryoptions_contactqueryoptions_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_290278668.md b/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_290278668.md index 66d1333256..237e6f52a3 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_290278668.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_contactqueryoptions_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactQueryOptions.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactQueryOptions ## -description Initializes a new instance of the [ContactQueryOptions](contactqueryoptions.md) class. ## -parameters ### -param text The text to match in the search operation. ## -remarks ## -examples ## -see-also [ContactQueryOptions(String, ContactQuerySearchFields)](contactqueryoptions_contactqueryoptions_130232662.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactQueryOptions.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.ContactQueryOptions + +## -description +Initializes a new instance of the [ContactQueryOptions](contactqueryoptions.md) class. + +## -parameters +### -param text +The text to match in the search operation. + +## -remarks + +## -examples + +## -see-also +[ContactQueryOptions(String, ContactQuerySearchFields)](contactqueryoptions_contactqueryoptions_130232662.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactqueryoptions_desiredfields.md b/windows.applicationmodel.contacts/contactqueryoptions_desiredfields.md index e57ea65534..5739b50854 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_desiredfields.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_desiredfields.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredFields --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredFields ## -description Gets or sets the desired fields a contact must have to match the query. ## -property-value The desired fields a contact must have to match the query. ## -remarks You can specify multiple fields by using the OR operator to combine values from the [ContactQueryDesiredFields](contactquerydesiredfields.md) enum. The query results will return contacts that contain one or more of the desired fields. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredFields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredFields + +## -description +Gets or sets the desired fields a contact must have to match the query. + +## -property-value +The desired fields a contact must have to match the query. + +## -remarks +You can specify multiple fields by using the OR operator to combine values from the [ContactQueryDesiredFields](contactquerydesiredfields.md) enum. The query results will return contacts that contain one or more of the desired fields. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions_desiredoperations.md b/windows.applicationmodel.contacts/contactqueryoptions_desiredoperations.md index 3791bd01c5..248ce28d78 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_desiredoperations.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_desiredoperations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredOperations --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredOperations ## -description Gets or sets the desired annotation operations a contact must have to match the query. ## -property-value The desired annotation operations a contact must have to match the query. ## -remarks You can specify multiple operations by using the OR operator to combine values from the [ContactAnnotationOperations](contactannotationoperations.md) enum. The query results will return contacts that contain one or more of the desired operations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredOperations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.DesiredOperations + +## -description +Gets or sets the desired annotation operations a contact must have to match the query. + +## -property-value +The desired annotation operations a contact must have to match the query. + +## -remarks +You can specify multiple operations by using the OR operator to combine values from the [ContactAnnotationOperations](contactannotationoperations.md) enum. The query results will return contacts that contain one or more of the desired operations. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions_includecontactsfromhiddenlists.md b/windows.applicationmodel.contacts/contactqueryoptions_includecontactsfromhiddenlists.md index 9b9618ef34..2df963a4d2 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_includecontactsfromhiddenlists.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_includecontactsfromhiddenlists.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.IncludeContactsFromHiddenLists --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.IncludeContactsFromHiddenLists ## -description Gets or sets a Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface. ## -property-value A Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.IncludeContactsFromHiddenLists +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.IncludeContactsFromHiddenLists + +## -description +Gets or sets a Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface. + +## -property-value +A Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactqueryoptions_textsearch.md b/windows.applicationmodel.contacts/contactqueryoptions_textsearch.md index 2534da12e9..e4478eb131 100644 --- a/windows.applicationmodel.contacts/contactqueryoptions_textsearch.md +++ b/windows.applicationmodel.contacts/contactqueryoptions_textsearch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.TextSearch --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryOptions.TextSearch ## -description Gets a [ContactQueryTextSearch](contactquerytextsearch.md) object that can be used for text searches. ## -property-value A [ContactQueryTextSearch](contactquerytextsearch.md) object that can be used for text searches. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryOptions.TextSearch +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryOptions.TextSearch + +## -description +Gets a [ContactQueryTextSearch](contactquerytextsearch.md) object that can be used for text searches. + +## -property-value +A [ContactQueryTextSearch](contactquerytextsearch.md) object that can be used for text searches. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactquerytextsearch.md b/windows.applicationmodel.contacts/contactquerytextsearch.md index 4049c47400..dd6ab03c0c 100644 --- a/windows.applicationmodel.contacts/contactquerytextsearch.md +++ b/windows.applicationmodel.contacts/contactquerytextsearch.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactQueryTextSearch --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactQueryTextSearch ## -description Specifies parameters to use in a text search of [Contact](contact.md) objects. ## -remarks Use [TextSearch](contactqueryoptions_textsearch.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactQueryTextSearch +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryTextSearch + +## -description +Specifies parameters to use in a text search of [Contact](contact.md) objects. + +## -remarks +Use [TextSearch](contactqueryoptions_textsearch.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactquerytextsearch_fields.md b/windows.applicationmodel.contacts/contactquerytextsearch_fields.md index 1cc0986bec..58f20ea516 100644 --- a/windows.applicationmodel.contacts/contactquerytextsearch_fields.md +++ b/windows.applicationmodel.contacts/contactquerytextsearch_fields.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Fields --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Fields ## -description Gets or sets which contact fields to search for a text match. ## -property-value Specifies which contact fields to search for a text match. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Fields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Fields + +## -description +Gets or sets which contact fields to search for a text match. + +## -property-value +Specifies which contact fields to search for a text match. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactquerytextsearch_searchscope.md b/windows.applicationmodel.contacts/contactquerytextsearch_searchscope.md index 64ec04e48e..353b9e3fb2 100644 --- a/windows.applicationmodel.contacts/contactquerytextsearch_searchscope.md +++ b/windows.applicationmodel.contacts/contactquerytextsearch_searchscope.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryTextSearch.SearchScope --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryTextSearch.SearchScope ## -description Gets or sets a value that specifies either a local or server search. ## -property-value A value that specifies either a local or server search. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryTextSearch.SearchScope +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryTextSearch.SearchScope + +## -description +Gets or sets a value that specifies either a local or server search. + +## -property-value +A value that specifies either a local or server search. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactquerytextsearch_text.md b/windows.applicationmodel.contacts/contactquerytextsearch_text.md index 3f385e2d25..a34f81f8a9 100644 --- a/windows.applicationmodel.contacts/contactquerytextsearch_text.md +++ b/windows.applicationmodel.contacts/contactquerytextsearch_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Text --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Text ## -description Gets or sets the text for which to search. ## -property-value The text for which to search. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactQueryTextSearch.Text + +## -description +Gets or sets the text for which to search. + +## -property-value +The text for which to search. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactreader.md b/windows.applicationmodel.contacts/contactreader.md index 311e47c393..06856a74ef 100644 --- a/windows.applicationmodel.contacts/contactreader.md +++ b/windows.applicationmodel.contacts/contactreader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactReader --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactReader ## -description Used to read [Contact](contact.md) objects in batches from the [ContactStore](contactstore.md) which may be local or remotely located. ## -remarks Use [GetContactReader](contactstore_getcontactreader_1793921473.md) or [GetContactReader(ContactQueryOptions)](contactstore_getcontactreader_1032732501.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactReader + +## -description +Used to read [Contact](contact.md) objects in batches from the [ContactStore](contactstore.md) which may be local or remotely located. + +## -remarks +Use [GetContactReader](contactstore_getcontactreader_1793921473.md) or [GetContactReader(ContactQueryOptions)](contactstore_getcontactreader_1032732501.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactreader_getmatchingpropertieswithmatchreason_951039830.md b/windows.applicationmodel.contacts/contactreader_getmatchingpropertieswithmatchreason_951039830.md index cf4232623c..1542164d4e 100644 --- a/windows.applicationmodel.contacts/contactreader_getmatchingpropertieswithmatchreason_951039830.md +++ b/windows.applicationmodel.contacts/contactreader_getmatchingpropertieswithmatchreason_951039830.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactReader.GetMatchingPropertiesWithMatchReason(Windows.ApplicationModel.Contacts.Contact) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactReader.GetMatchingPropertiesWithMatchReason ## -description Gets the reason a [Contact](contact.md) matched the search query. Returns the properties and substrings that match. ## -parameters ### -param contact The [Contact](contact.md) for which to get the matching properties. ## -returns The list of matching properties and match reasons. ## -remarks These results can be used for hit highlighting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactReader.GetMatchingPropertiesWithMatchReason(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactReader.GetMatchingPropertiesWithMatchReason + +## -description +Gets the reason a [Contact](contact.md) matched the search query. Returns the properties and substrings that match. + +## -parameters +### -param contact +The [Contact](contact.md) for which to get the matching properties. + +## -returns +The list of matching properties and match reasons. + +## -remarks +These results can be used for hit highlighting. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactreader_readbatchasync_888788553.md b/windows.applicationmodel.contacts/contactreader_readbatchasync_888788553.md index 95e8f647f7..15f01d6a74 100644 --- a/windows.applicationmodel.contacts/contactreader_readbatchasync_888788553.md +++ b/windows.applicationmodel.contacts/contactreader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactReader.ReadBatchAsync ## -description Asynchronously reads a batch of [Contact](contact.md) objects from the [ContactStore](contactstore.md). ## -returns The batch of contacts read from the [ContactStore](contactstore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactReader.ReadBatchAsync + +## -description +Asynchronously reads a batch of [Contact](contact.md) objects from the [ContactStore](contactstore.md). + +## -returns +The batch of contacts read from the [ContactStore](contactstore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactsignificantother.md b/windows.applicationmodel.contacts/contactsignificantother.md index 99da98a8cb..7395916176 100644 --- a/windows.applicationmodel.contacts/contactsignificantother.md +++ b/windows.applicationmodel.contacts/contactsignificantother.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactSignificantOther --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactSignificantOther ## -description Represents the info about a significant other for a contact. ## -remarks ## -examples ## -see-also [SignificantOthers](contact_significantothers.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactSignificantOther +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactSignificantOther + +## -description +Represents the info about a significant other for a contact. + +## -remarks + +## -examples + +## -see-also +[SignificantOthers](contact_significantothers.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactsignificantother_contactsignificantother_1221375020.md b/windows.applicationmodel.contacts/contactsignificantother_contactsignificantother_1221375020.md index 5158900193..6d35200ac7 100644 --- a/windows.applicationmodel.contacts/contactsignificantother_contactsignificantother_1221375020.md +++ b/windows.applicationmodel.contacts/contactsignificantother_contactsignificantother_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactSignificantOther.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactSignificantOther.ContactSignificantOther ## -description Initializes a new instance of a [ContactSignificantOther](contactsignificantother.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactSignificantOther.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactSignificantOther.ContactSignificantOther + +## -description +Initializes a new instance of a [ContactSignificantOther](contactsignificantother.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactsignificantother_description.md b/windows.applicationmodel.contacts/contactsignificantother_description.md index b8bf041890..2edc98b69a 100644 --- a/windows.applicationmodel.contacts/contactsignificantother_description.md +++ b/windows.applicationmodel.contacts/contactsignificantother_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactSignificantOther.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactSignificantOther.Description ## -description Gets and sets the description of a significant other for a contact. The maximum string length for the description is 512 characters. ## -property-value The description of a significant other for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactSignificantOther.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactSignificantOther.Description + +## -description +Gets and sets the description of a significant other for a contact. The maximum string length for the description is 512 characters. + +## -property-value +The description of a significant other for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactsignificantother_name.md b/windows.applicationmodel.contacts/contactsignificantother_name.md index 0fecc7fbca..2d0ae633bc 100644 --- a/windows.applicationmodel.contacts/contactsignificantother_name.md +++ b/windows.applicationmodel.contacts/contactsignificantother_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactSignificantOther.Name --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactSignificantOther.Name ## -description Gets and sets the name of a significant other for a contact. The maximum string length for the name is 256 characters. ## -property-value The name of a significant other for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactSignificantOther.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactSignificantOther.Name + +## -description +Gets and sets the name of a significant other for a contact. The maximum string length for the name is 256 characters. + +## -property-value +The name of a significant other for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactsignificantother_relationship.md b/windows.applicationmodel.contacts/contactsignificantother_relationship.md index 22c9c7fcc9..42c7697d00 100644 --- a/windows.applicationmodel.contacts/contactsignificantother_relationship.md +++ b/windows.applicationmodel.contacts/contactsignificantother_relationship.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactSignificantOther.Relationship --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactSignificantOther.Relationship ## -description Gets or puts a value that indicates the nature of the relationship, such as spouse, partner, sibling, parent and so on. ## -property-value A value that indicates the nature of the relationship, such as spouse, partner, sibling, parent and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactSignificantOther.Relationship +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactSignificantOther.Relationship + +## -description +Gets or puts a value that indicates the nature of the relationship, such as spouse, partner, sibling, parent and so on. + +## -property-value +A value that indicates the nature of the relationship, such as spouse, partner, sibling, parent and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_aggregatecontactmanager.md b/windows.applicationmodel.contacts/contactstore_aggregatecontactmanager.md index 01b409dc1d..b4ed36d968 100644 --- a/windows.applicationmodel.contacts/contactstore_aggregatecontactmanager.md +++ b/windows.applicationmodel.contacts/contactstore_aggregatecontactmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactStore.AggregateContactManager --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactStore.AggregateContactManager ## -description Gets a contact manager that provides functionality for linking individual (raw) contacts across services together into a single aggregate contact. ## -property-value A contact manager that provides functionality for linking individual (raw) contacts across services together into a single aggregate contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactStore.AggregateContactManager +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.AggregateContactManager + +## -description +Gets a contact manager that provides functionality for linking individual (raw) contacts across services together into a single aggregate contact. + +## -property-value +A contact manager that provides functionality for linking individual (raw) contacts across services together into a single aggregate contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_changetracker.md b/windows.applicationmodel.contacts/contactstore_changetracker.md index a2d2ebf3eb..c9861736bb 100644 --- a/windows.applicationmodel.contacts/contactstore_changetracker.md +++ b/windows.applicationmodel.contacts/contactstore_changetracker.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactStore.ChangeTracker --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactStore.ChangeTracker ## -description Gets the [ContactChangeTracker](contactchangetracker.md) which provides functionality for monitoring changes to [Contact](contact.md) objects in the [ContactStore](contactstore.md). ## -property-value The [ContactChangeTracker](contactchangetracker.md) which provides functionality for monitoring changes to [Contact](contact.md) objects in the [ContactStore](contactstore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactStore.ChangeTracker +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.ChangeTracker + +## -description +Gets the [ContactChangeTracker](contactchangetracker.md) which provides functionality for monitoring changes to [Contact](contact.md) objects in the [ContactStore](contactstore.md). + +## -property-value +The [ContactChangeTracker](contactchangetracker.md) which provides functionality for monitoring changes to [Contact](contact.md) objects in the [ContactStore](contactstore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_contactchanged.md b/windows.applicationmodel.contacts/contactstore_contactchanged.md index 4864cece79..96688b5cd6 100644 --- a/windows.applicationmodel.contacts/contactstore_contactchanged.md +++ b/windows.applicationmodel.contacts/contactstore_contactchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Contacts.ContactStore.ContactChanged --api-type: winrt event ---- # Windows.ApplicationModel.Contacts.ContactStore.ContactChanged ## -description Occurs when a [Contact](contact.md) in the [ContactStore](contactstore.md) has been changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Contacts.ContactStore.ContactChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.ContactChanged + +## -description +Occurs when a [Contact](contact.md) in the [ContactStore](contactstore.md) has been changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_createcontactlistasync_1732290999.md b/windows.applicationmodel.contacts/contactstore_createcontactlistasync_1732290999.md index 8a2a9c4205..639baf502c 100644 --- a/windows.applicationmodel.contacts/contactstore_createcontactlistasync_1732290999.md +++ b/windows.applicationmodel.contacts/contactstore_createcontactlistasync_1732290999.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync ## -description Asynchronously creates a [ContactList](contactlist.md) with the specified display name and user account. ## -parameters ### -param displayName A name for the new [ContactList](contactlist.md), suitable for displaying in the user interface. ### -param userDataAccountId The ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) to use when creating the [ContactList](contactlist.md). ## -returns The newly created [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also [CreateContactListAsync(String)](contactstore_createcontactlistasync_733783049.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync + +## -description +Asynchronously creates a [ContactList](contactlist.md) with the specified display name and user account. + +## -parameters +### -param displayName +A name for the new [ContactList](contactlist.md), suitable for displaying in the user interface. + +### -param userDataAccountId +The ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) to use when creating the [ContactList](contactlist.md). + +## -returns +The newly created [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also +[CreateContactListAsync(String)](contactstore_createcontactlistasync_733783049.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_createcontactlistasync_733783049.md b/windows.applicationmodel.contacts/contactstore_createcontactlistasync_733783049.md index 785fed738c..d0ef483549 100644 --- a/windows.applicationmodel.contacts/contactstore_createcontactlistasync_733783049.md +++ b/windows.applicationmodel.contacts/contactstore_createcontactlistasync_733783049.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync ## -description Asynchronously creates a [ContactList](contactlist.md) with the specified display name. ## -parameters ### -param displayName A name for the new [ContactList](contactlist.md), suitable for displaying in the user interface. ## -returns The newly created [ContactList](contactlist.md). ## -remarks ## -examples ## -see-also [CreateContactListAsync(String, String)](contactstore_createcontactlistasync_1732290999.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.CreateContactListAsync + +## -description +Asynchronously creates a [ContactList](contactlist.md) with the specified display name. + +## -parameters +### -param displayName +A name for the new [ContactList](contactlist.md), suitable for displaying in the user interface. + +## -returns +The newly created [ContactList](contactlist.md). + +## -remarks + +## -examples + +## -see-also +[CreateContactListAsync(String, String)](contactstore_createcontactlistasync_1732290999.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_findcontactlistsasync_2053274900.md b/windows.applicationmodel.contacts/contactstore_findcontactlistsasync_2053274900.md index e9ba757225..eb3361d6ef 100644 --- a/windows.applicationmodel.contacts/contactstore_findcontactlistsasync_2053274900.md +++ b/windows.applicationmodel.contacts/contactstore_findcontactlistsasync_2053274900.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.FindContactListsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.FindContactListsAsync ## -description Asynchronously returns the list of [ContactList](contactlist.md) objects. ## -returns The list of [ContactList](contactlist.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.FindContactListsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.FindContactListsAsync + +## -description +Asynchronously returns the list of [ContactList](contactlist.md) objects. + +## -returns +The list of [ContactList](contactlist.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_findcontactsasync_1406591676.md b/windows.applicationmodel.contacts/contactstore_findcontactsasync_1406591676.md index 10b117354b..aa0168801d 100644 --- a/windows.applicationmodel.contacts/contactstore_findcontactsasync_1406591676.md +++ b/windows.applicationmodel.contacts/contactstore_findcontactsasync_1406591676.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync ## -description Retrieves a list of [Contact](contact.md) objects based on the supplied search text. ## -parameters ### -param searchText The search string for the operation. The query will attempt to match the name ([Name](contact_name.md)), email address ([Emails](contact_emails.md) values), or phone number ([Phones](contact_phones.md) values) of a contact. ## -returns An asynchronous operation that returns a search-filtered list of contacts on successful completion. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [Contact](contact.md) items. (You can use APIs of [IVectorView<Contact>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<Contact>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) ## -remarks ## -examples ## -see-also [FindContactsAsync](contactstore_findcontactsasync_173480860.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync + +## -description +Retrieves a list of [Contact](contact.md) objects based on the supplied search text. + +## -parameters +### -param searchText +The search string for the operation. The query will attempt to match the name ([Name](contact_name.md)), email address ([Emails](contact_emails.md) values), or phone number ([Phones](contact_phones.md) values) of a contact. + +## -returns +An asynchronous operation that returns a search-filtered list of contacts on successful completion. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [Contact](contact.md) items. (You can use APIs of [IVectorView<Contact>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<Contact>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) + +## -remarks + +## -examples + +## -see-also +[FindContactsAsync](contactstore_findcontactsasync_173480860.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_findcontactsasync_173480860.md b/windows.applicationmodel.contacts/contactstore_findcontactsasync_173480860.md index 6abdcd72bd..85fd531dd4 100644 --- a/windows.applicationmodel.contacts/contactstore_findcontactsasync_173480860.md +++ b/windows.applicationmodel.contacts/contactstore_findcontactsasync_173480860.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync ## -description Retrieves the list of all contacts in the contact store. ## -returns An asynchronous operation that returns a list of all [Contact](contact.md) objects in the contact store. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [Contact](contact.md) items. (You can use APIs of [IVectorView<Contact>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<Contact>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) ## -remarks ## -examples ## -see-also [Contact](contact.md), [FindContactsAsync(String)](contactstore_findcontactsasync_1406591676.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.FindContactsAsync + +## -description +Retrieves the list of all contacts in the contact store. + +## -returns +An asynchronous operation that returns a list of all [Contact](contact.md) objects in the contact store. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [Contact](contact.md) items. (You can use APIs of [IVectorView<Contact>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<Contact>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) + +## -remarks + +## -examples + +## -see-also +[Contact](contact.md), [FindContactsAsync(String)](contactstore_findcontactsasync_1406591676.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_getcontactasync_1631734332.md b/windows.applicationmodel.contacts/contactstore_getcontactasync_1631734332.md index 5979011f80..fadb21f7de 100644 --- a/windows.applicationmodel.contacts/contactstore_getcontactasync_1631734332.md +++ b/windows.applicationmodel.contacts/contactstore_getcontactasync_1631734332.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.GetContactAsync ## -description Retrieves a [Contact](contact.md) object representing the contact with the specified [Id](contact_id.md) value. ## -parameters ### -param contactId The [Id](contact_id.md) of the contact to be retrieved. ## -returns An asynchronous operation that returns a [Contact](contact.md) object on successful completion. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [Contact](contact.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.GetContactAsync + +## -description +Retrieves a [Contact](contact.md) object representing the contact with the specified [Id](contact_id.md) value. + +## -parameters +### -param contactId +The [Id](contact_id.md) of the contact to be retrieved. + +## -returns +An asynchronous operation that returns a [Contact](contact.md) object on successful completion. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[Contact](contact.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_getcontactlistasync_427411044.md b/windows.applicationmodel.contacts/contactstore_getcontactlistasync_427411044.md index 72e23f29b2..cf93bf93b1 100644 --- a/windows.applicationmodel.contacts/contactstore_getcontactlistasync_427411044.md +++ b/windows.applicationmodel.contacts/contactstore_getcontactlistasync_427411044.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactListAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.GetContactListAsync ## -description Asynchronously gets the [ContactList](contactlist.md) with the specified ID. ## -parameters ### -param contactListId The ID of the [ContactList](contactlist.md) to retrieve. ## -returns The [ContactList](contactlist.md) with the specified ID or null if the list is not found. ## -remarks This method throws an invalid argument exception if the *contactListId* is malformed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.GetContactListAsync + +## -description +Asynchronously gets the [ContactList](contactlist.md) with the specified ID. + +## -parameters +### -param contactListId +The ID of the [ContactList](contactlist.md) to retrieve. + +## -returns +The [ContactList](contactlist.md) with the specified ID or null if the list is not found. + +## -remarks +This method throws an invalid argument exception if the *contactListId* is malformed. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_getcontactreader_1032732501.md b/windows.applicationmodel.contacts/contactstore_getcontactreader_1032732501.md index 13e85bdc65..cb3bcfb4bb 100644 --- a/windows.applicationmodel.contacts/contactstore_getcontactreader_1032732501.md +++ b/windows.applicationmodel.contacts/contactstore_getcontactreader_1032732501.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactReader(Windows.ApplicationModel.Contacts.ContactQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.GetContactReader ## -description Creates and returns a [ContactReader](contactreader.md) for the [ContactStore](contactstore.md) with the specified [ContactQueryOptions](contactqueryoptions.md). ## -parameters ### -param options The query options to use when creating the new [ContactReader](contactreader.md). ## -returns The newly created [ContactReader](contactreader.md) for the [ContactStore](contactstore.md). ## -remarks ## -examples ## -see-also [GetContactReader](contactstore_getcontactreader_1793921473.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactReader(Windows.ApplicationModel.Contacts.ContactQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.GetContactReader + +## -description +Creates and returns a [ContactReader](contactreader.md) for the [ContactStore](contactstore.md) with the specified [ContactQueryOptions](contactqueryoptions.md). + +## -parameters +### -param options +The query options to use when creating the new [ContactReader](contactreader.md). + +## -returns +The newly created [ContactReader](contactreader.md) for the [ContactStore](contactstore.md). + +## -remarks + +## -examples + +## -see-also +[GetContactReader](contactstore_getcontactreader_1793921473.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_getcontactreader_1793921473.md b/windows.applicationmodel.contacts/contactstore_getcontactreader_1793921473.md index d388520a22..ef63e43f6c 100644 --- a/windows.applicationmodel.contacts/contactstore_getcontactreader_1793921473.md +++ b/windows.applicationmodel.contacts/contactstore_getcontactreader_1793921473.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactReader --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.GetContactReader ## -description Creates and returns a [ContactReader](contactreader.md) for the [ContactStore](contactstore.md). ## -returns The newly created [ContactReader](contactreader.md) for the [ContactStore](contactstore.md). ## -remarks ## -examples ## -see-also [GetContactReader(ContactQueryOptions)](contactstore_getcontactreader_1032732501.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetContactReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.GetContactReader + +## -description +Creates and returns a [ContactReader](contactreader.md) for the [ContactStore](contactstore.md). + +## -returns +The newly created [ContactReader](contactreader.md) for the [ContactStore](contactstore.md). + +## -remarks + +## -examples + +## -see-also +[GetContactReader(ContactQueryOptions)](contactstore_getcontactreader_1032732501.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactstore_getmecontactasync_559171710.md b/windows.applicationmodel.contacts/contactstore_getmecontactasync_559171710.md index fc761c1e95..55338b0664 100644 --- a/windows.applicationmodel.contacts/contactstore_getmecontactasync_559171710.md +++ b/windows.applicationmodel.contacts/contactstore_getmecontactasync_559171710.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetMeContactAsync --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactStore.GetMeContactAsync ## -description Get the [Contact](contact.md) object for the current user. ## -returns The [Contact](contact.md) object for the current user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetMeContactAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.GetMeContactAsync + +## -description +Get the [Contact](contact.md) object for the current user. + +## -returns +The [Contact](contact.md) object for the current user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactstorenotificationtriggerdetails.md b/windows.applicationmodel.contacts/contactstorenotificationtriggerdetails.md index 2c6beb5171..a6b276c14d 100644 --- a/windows.applicationmodel.contacts/contactstorenotificationtriggerdetails.md +++ b/windows.applicationmodel.contacts/contactstorenotificationtriggerdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactStoreNotificationTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactStoreNotificationTriggerDetails ## -description Reserved for future use. ## -remarks Reserved for future use. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactStoreNotificationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactStoreNotificationTriggerDetails + +## -description +Reserved for future use. + +## -remarks +Reserved for future use. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactwebsite.md b/windows.applicationmodel.contacts/contactwebsite.md index c610750b1c..1dc2a3b6cf 100644 --- a/windows.applicationmodel.contacts/contactwebsite.md +++ b/windows.applicationmodel.contacts/contactwebsite.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.ContactWebsite --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.ContactWebsite ## -description Represents the info about a Web site for a contact. ## -remarks ## -examples ## -see-also [Websites](contact_websites.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactWebsite +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactWebsite + +## -description +Represents the info about a Web site for a contact. + +## -remarks + +## -examples + +## -see-also +[Websites](contact_websites.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactwebsite_contactwebsite_1221375020.md b/windows.applicationmodel.contacts/contactwebsite_contactwebsite_1221375020.md index 71ff920843..c0c11b3e7c 100644 --- a/windows.applicationmodel.contacts/contactwebsite_contactwebsite_1221375020.md +++ b/windows.applicationmodel.contacts/contactwebsite_contactwebsite_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.ContactWebsite.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.ContactWebsite.ContactWebsite ## -description Initializes a new instance of a [ContactWebsite](contactwebsite.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactWebsite.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactWebsite.ContactWebsite + +## -description +Initializes a new instance of a [ContactWebsite](contactwebsite.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactwebsite_description.md b/windows.applicationmodel.contacts/contactwebsite_description.md index eeda21b41f..58ccfe535c 100644 --- a/windows.applicationmodel.contacts/contactwebsite_description.md +++ b/windows.applicationmodel.contacts/contactwebsite_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactWebsite.Description --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactWebsite.Description ## -description Gets and sets the description of a Web site for a contact. The maximum string length for the description is 512 characters. ## -property-value The description of a Web site for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactWebsite.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactWebsite.Description + +## -description +Gets and sets the description of a Web site for a contact. The maximum string length for the description is 512 characters. + +## -property-value +The description of a Web site for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactwebsite_rawvalue.md b/windows.applicationmodel.contacts/contactwebsite_rawvalue.md index 3cb5e1ada3..77758ff1eb 100644 --- a/windows.applicationmodel.contacts/contactwebsite_rawvalue.md +++ b/windows.applicationmodel.contacts/contactwebsite_rawvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactWebsite.RawValue --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactWebsite.RawValue ## -description Gets or sets the raw website address for the contact. This address is not checked for valid URI formatting. ## -property-value The raw website address for the contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactWebsite.RawValue +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactWebsite.RawValue + +## -description +Gets or sets the raw website address for the contact. This address is not checked for valid URI formatting. + +## -property-value +The raw website address for the contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/contactwebsite_uri.md b/windows.applicationmodel.contacts/contactwebsite_uri.md index f8680dd1d1..420cdcaf8c 100644 --- a/windows.applicationmodel.contacts/contactwebsite_uri.md +++ b/windows.applicationmodel.contacts/contactwebsite_uri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.ContactWebsite.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.ContactWebsite.Uri ## -description Gets and sets the Uniform Resource Identifier (URI) of a Web site for a contact. ## -property-value The Uniform Resource Identifier (URI) of a Web site for a contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactWebsite.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactWebsite.Uri + +## -description +Gets and sets the Uniform Resource Identifier (URI) of a Web site for a contact. + +## -property-value +The Uniform Resource Identifier (URI) of a Web site for a contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/fullcontactcardoptions.md b/windows.applicationmodel.contacts/fullcontactcardoptions.md index 5e47698dff..b2ada45c07 100644 --- a/windows.applicationmodel.contacts/fullcontactcardoptions.md +++ b/windows.applicationmodel.contacts/fullcontactcardoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Contacts.FullContactCardOptions --api-type: winrt class ---- # Windows.ApplicationModel.Contacts.FullContactCardOptions ## -description Specifies the options for displaying the full contact card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Contacts.FullContactCardOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.FullContactCardOptions + +## -description +Specifies the options for displaying the full contact card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/fullcontactcardoptions_desiredremainingview.md b/windows.applicationmodel.contacts/fullcontactcardoptions_desiredremainingview.md index 8d977fc235..70ec903caa 100644 --- a/windows.applicationmodel.contacts/fullcontactcardoptions_desiredremainingview.md +++ b/windows.applicationmodel.contacts/fullcontactcardoptions_desiredremainingview.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.FullContactCardOptions.DesiredRemainingView --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.FullContactCardOptions.DesiredRemainingView ## -description Gets or sets a value that describes the desired view size for the full contact card. ## -property-value A value that describes the desired view size for the full contact card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.FullContactCardOptions.DesiredRemainingView +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.FullContactCardOptions.DesiredRemainingView + +## -description +Gets or sets a value that describes the desired view size for the full contact card. + +## -property-value +A value that describes the desired view size for the full contact card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/fullcontactcardoptions_fullcontactcardoptions_1221375020.md b/windows.applicationmodel.contacts/fullcontactcardoptions_fullcontactcardoptions_1221375020.md index 6105e0f327..346c727c54 100644 --- a/windows.applicationmodel.contacts/fullcontactcardoptions_fullcontactcardoptions_1221375020.md +++ b/windows.applicationmodel.contacts/fullcontactcardoptions_fullcontactcardoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.FullContactCardOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.FullContactCardOptions.FullContactCardOptions ## -description Initializes a new instance of the [FullContactCardOptions](fullcontactcardoptions.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.FullContactCardOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.FullContactCardOptions.FullContactCardOptions + +## -description +Initializes a new instance of the [FullContactCardOptions](fullcontactcardoptions.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/icontactfield_category.md b/windows.applicationmodel.contacts/icontactfield_category.md index 45f01c44ef..a3bcc2d230 100644 --- a/windows.applicationmodel.contacts/icontactfield_category.md +++ b/windows.applicationmodel.contacts/icontactfield_category.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.IContactField.Category --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.IContactField.Category ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the category for the contact data. ## -property-value The category for the contact data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.IContactField.Category +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.IContactField.Category + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the category for the contact data. + +## -property-value +The category for the contact data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/icontactfield_name.md b/windows.applicationmodel.contacts/icontactfield_name.md index 05f4fbb064..a5e7d10c0f 100644 --- a/windows.applicationmodel.contacts/icontactfield_name.md +++ b/windows.applicationmodel.contacts/icontactfield_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.IContactField.Name --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.IContactField.Name ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the name of the field. ## -property-value The name of the field. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.IContactField.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.IContactField.Name + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the name of the field. + +## -property-value +The name of the field. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/icontactfield_type.md b/windows.applicationmodel.contacts/icontactfield_type.md index c36593a129..4e3071888d 100644 --- a/windows.applicationmodel.contacts/icontactfield_type.md +++ b/windows.applicationmodel.contacts/icontactfield_type.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.IContactField.Type --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.IContactField.Type ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the contact field type for the data. ## -property-value The type of data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.IContactField.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.IContactField.Type + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the contact field type for the data. + +## -property-value +The type of data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/icontactfield_value.md b/windows.applicationmodel.contacts/icontactfield_value.md index 000fa7c8c5..d9e2babd95 100644 --- a/windows.applicationmodel.contacts/icontactfield_value.md +++ b/windows.applicationmodel.contacts/icontactfield_value.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Contacts.IContactField.Value --api-type: winrt property ---- # Windows.ApplicationModel.Contacts.IContactField.Value ## -description > [!NOTE] > [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). Gets the value of the contact data. ## -property-value The value of the contact data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Contacts.IContactField.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.IContactField.Value + +## -description +> [!NOTE] +> [IContactField](icontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactSignificantOther](contactsignificantother.md), [Contact](contact.md), [ContactEmail](contactemail.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), [ContactWebsite](contactwebsite.md), [ContactJobInfo](contactjobinfo.md), or [ContactDate](contactdate.md). + +Gets the value of the contact data. + +## -property-value +The value of the contact data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1723791966.md b/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1723791966.md index d81e2bc783..2fff9bdbf5 100644 --- a/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1723791966.md +++ b/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1723791966.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a field to contain information about a contact. ## -parameters ### -param value The value for the field. ### -param type The type of field. ## -returns A field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateField(String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_377552818.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_1958768016.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a field to contain information about a contact. + +## -parameters +### -param value +The value for the field. + +### -param type +The type of field. + +## -returns +A field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateField(String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_377552818.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_1958768016.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1958768016.md b/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1958768016.md index 24b3a0d053..d365e8f218 100644 --- a/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1958768016.md +++ b/windows.applicationmodel.contacts/icontactfieldfactory_createfield_1958768016.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField(System.String,System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a field to contain information about a contact. ## -parameters ### -param name The name of the field. ### -param value The value the field contains. ### -param type The type of field. ### -param category The category the field belongs to. ## -returns A field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateField(String, ContactFieldType)](icontactfieldfactory_createfield_1723791966.md), [CreateField(String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_377552818.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField(System.String,System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a field to contain information about a contact. + +## -parameters +### -param name +The name of the field. + +### -param value +The value the field contains. + +### -param type +The type of field. + +### -param category +The category the field belongs to. + +## -returns +A field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateField(String, ContactFieldType)](icontactfieldfactory_createfield_1723791966.md), [CreateField(String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_377552818.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactfieldfactory_createfield_377552818.md b/windows.applicationmodel.contacts/icontactfieldfactory_createfield_377552818.md index 93277fb1a1..52abe809b3 100644 --- a/windows.applicationmodel.contacts/icontactfieldfactory_createfield_377552818.md +++ b/windows.applicationmodel.contacts/icontactfieldfactory_createfield_377552818.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField ## -description > [!NOTE] > [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). Creates a field to contain information about a contact. ## -parameters ### -param value The value of the field. ### -param type The type of field. ### -param category The category the field belongs to. ## -returns A field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateField(String, ContactFieldType)](icontactfieldfactory_createfield_1723791966.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_1958768016.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField(System.String,Windows.ApplicationModel.Contacts.ContactFieldType,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactFieldFactory.CreateField + +## -description +> [!NOTE] +> [IContactFieldFactory](icontactfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactPhone](contactphone.md) or [ContactEmail](contactemail.md). + +Creates a field to contain information about a contact. + +## -parameters +### -param value +The value of the field. + +### -param type +The type of field. + +### -param category +The category the field belongs to. + +## -returns +A field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateField(String, ContactFieldType)](icontactfieldfactory_createfield_1723791966.md), [CreateField(String, String, ContactFieldType, ContactFieldCategory)](icontactfieldfactory_createfield_1958768016.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md b/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md index 769979194a..1d6e3e8283 100644 --- a/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md +++ b/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md @@ -1,3 +1,42 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a field containing information about a contact's instant messaging account. ## -parameters ### -param userName The user name for the instant messaging account. ### -param category The category the field belongs to. ### -param service The name of the instant messaging service. ### -param displayText The text to display to prompt an instant messaging conversation. ### -param verb The Uniform Resource Identifier (URI) that starts an instant messaging conversation. ## -returns An instant messaging field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateInstantMessage(String)](icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory)](icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a field containing information about a contact's instant messaging account. + +## -parameters +### -param userName +The user name for the instant messaging account. + +### -param category +The category the field belongs to. + +### -param service +The name of the instant messaging service. + +### -param displayText +The text to display to prompt an instant messaging conversation. + +### -param verb +The Uniform Resource Identifier (URI) that starts an instant messaging conversation. + +## -returns +An instant messaging field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateInstantMessage(String)](icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory)](icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md b/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md index 8db3b1d4bc..7b554c759d 100644 --- a/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md +++ b/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a field containing information about a contact's instant messaging account. ## -parameters ### -param userName The user name for the instant messaging account. ### -param category The category the field belongs to. ## -returns An instant messaging field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateInstantMessage(String)](icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a field containing information about a contact's instant messaging account. + +## -parameters +### -param userName +The user name for the instant messaging account. + +### -param category +The category the field belongs to. + +## -returns +An instant messaging field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateInstantMessage(String)](icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md b/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md index d27b8353dd..b9f226d51e 100644 --- a/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md +++ b/windows.applicationmodel.contacts/icontactinstantmessagefieldfactory_createinstantmessage_2022649811.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage ## -description > [!NOTE] > [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). Creates a field containing information about a contact's instant messaging account. ## -parameters ### -param userName The user name of the instant messaging account. ## -returns An instant messaging field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateInstantMessage(String, ContactFieldCategory)](icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory.CreateInstantMessage + +## -description +> [!NOTE] +> [IContactInstantMessageFieldFactory](icontactinstantmessagefieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactConnectedServiceAccount](contactconnectedserviceaccount.md). + +Creates a field containing information about a contact's instant messaging account. + +## -parameters +### -param userName +The user name of the instant messaging account. + +## -returns +An instant messaging field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateInstantMessage(String, ContactFieldCategory)](icontactinstantmessagefieldfactory_createinstantmessage_1064293083.md), [CreateInstantMessage(String, ContactFieldCategory, String, String, Uri)](icontactinstantmessagefieldfactory_createinstantmessage_1039910149.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_1542951776.md b/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_1542951776.md index c988a12f96..0cd4bb63f1 100644 --- a/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_1542951776.md +++ b/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_1542951776.md @@ -1,3 +1,48 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a field to contain information about a contact's location. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ### -param category The category the field belongs to. ### -param street The street address. ### -param city The name of the city for the address. ### -param region The name of the region for the address. ### -param country The name of the country for the address. ### -param postalCode The postal code for the address. ## -returns A location field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateLocation(String)](icontactlocationfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory)](icontactlocationfieldfactory_createlocation_966869216.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory,System.String,System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a field to contain information about a contact's location. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +### -param category +The category the field belongs to. + +### -param street +The street address. + +### -param city +The name of the city for the address. + +### -param region +The name of the region for the address. + +### -param country +The name of the country for the address. + +### -param postalCode +The postal code for the address. + +## -returns +A location field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateLocation(String)](icontactlocationfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory)](icontactlocationfieldfactory_createlocation_966869216.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_2118237656.md b/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_2118237656.md index 6d8be50eba..f255a723d0 100644 --- a/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_2118237656.md +++ b/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_2118237656.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a field to contain information about a contact's location. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ## -returns A location field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateLocation(String, ContactFieldCategory)](icontactlocationfieldfactory_createlocation_966869216.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](icontactlocationfieldfactory_createlocation_1542951776.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a field to contain information about a contact's location. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +## -returns +A location field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateLocation(String, ContactFieldCategory)](icontactlocationfieldfactory_createlocation_966869216.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](icontactlocationfieldfactory_createlocation_1542951776.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_966869216.md b/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_966869216.md index 7130980e4f..d7bfbb3c23 100644 --- a/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_966869216.md +++ b/windows.applicationmodel.contacts/icontactlocationfieldfactory_createlocation_966869216.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation ## -description > [!NOTE] > [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). Creates a field to contain information about a contact's location. ## -parameters ### -param unstructuredAddress The address of the contact in an unstructured format. ### -param category The category the field belongs to. ## -returns A location field that you can add to a [Contact](contact.md) object. ## -remarks ## -examples ## -see-also [CreateLocation(String)](icontactlocationfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](icontactlocationfieldfactory_createlocation_1542951776.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation(System.String,Windows.ApplicationModel.Contacts.ContactFieldCategory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.IContactLocationFieldFactory.CreateLocation + +## -description +> [!NOTE] +> [IContactLocationFieldFactory](icontactlocationfieldfactory.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md). + +Creates a field to contain information about a contact's location. + +## -parameters +### -param unstructuredAddress +The address of the contact in an unstructured format. + +### -param category +The category the field belongs to. + +## -returns +A location field that you can add to a [Contact](contact.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateLocation(String)](icontactlocationfieldfactory_createlocation_2118237656.md), [CreateLocation(String, ContactFieldCategory, String, String, String, String, String)](icontactlocationfieldfactory_createlocation_1542951776.md) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/knowncontactfield_convertnametotype_1192350864.md b/windows.applicationmodel.contacts/knowncontactfield_convertnametotype_1192350864.md index 26cb9ba2ef..20c738d661 100644 --- a/windows.applicationmodel.contacts/knowncontactfield_convertnametotype_1192350864.md +++ b/windows.applicationmodel.contacts/knowncontactfield_convertnametotype_1192350864.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.KnownContactField.ConvertNameToType(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.KnownContactField.ConvertNameToType ## -description > [!NOTE] > [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). Converts a string representing the name of a field to its corresponding type. ## -parameters ### -param name The name of the field. ## -returns The type of field. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.KnownContactField.ConvertNameToType(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.KnownContactField.ConvertNameToType + +## -description +> [!NOTE] +> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). + +Converts a string representing the name of a field to its corresponding type. + +## -parameters +### -param name +The name of the field. + +## -returns +The type of field. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/knowncontactfield_converttypetoname_1668756787.md b/windows.applicationmodel.contacts/knowncontactfield_converttypetoname_1668756787.md index 6b0e0dfed8..752775483e 100644 --- a/windows.applicationmodel.contacts/knowncontactfield_converttypetoname_1668756787.md +++ b/windows.applicationmodel.contacts/knowncontactfield_converttypetoname_1668756787.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Contacts.KnownContactField.ConvertTypeToName(Windows.ApplicationModel.Contacts.ContactFieldType) --api-type: winrt method ---- # Windows.ApplicationModel.Contacts.KnownContactField.ConvertTypeToName ## -description > [!NOTE] > [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). Converts the type of a field to its corresponding string name. ## -parameters ### -param type The type of field. ## -returns The name of the field. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Contacts.KnownContactField.ConvertTypeToName(Windows.ApplicationModel.Contacts.ContactFieldType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.KnownContactField.ConvertTypeToName + +## -description +> [!NOTE] +> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). + +Converts the type of a field to its corresponding string name. + +## -parameters +### -param type +The type of field. + +## -returns +The name of the field. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.contacts/knowncontactfield_email.md b/windows.applicationmodel.contacts/knowncontactfield_email.md index 35df0579c0..9ba942350b 100644 --- a/windows.applicationmodel.contacts/knowncontactfield_email.md +++ b/windows.applicationmodel.contacts/knowncontactfield_email.md @@ -1,31 +1,31 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.Email --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.KnownContactField.Email - -## -description -> [!NOTE] -> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). - -Contains the name of the field used for email addresses. - -## -property-value -The name of the field. - -## -remarks -Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the email addresses of a contact. - -## -examples -This code demonstrates how to get an email address of a contact. - - - -[!code-js[ContactsKnownFields_Email](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_Email)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.Email +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.KnownContactField.Email + +## -description +> [!NOTE] +> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). + +Contains the name of the field used for email addresses. + +## -property-value +The name of the field. + +## -remarks +Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the email addresses of a contact. + +## -examples +This code demonstrates how to get an email address of a contact. + + + +[!code-js[ContactsKnownFields_Email](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_Email)] + +## -see-also diff --git a/windows.applicationmodel.contacts/knowncontactfield_instantmessage.md b/windows.applicationmodel.contacts/knowncontactfield_instantmessage.md index c816c4a76f..6ca154470c 100644 --- a/windows.applicationmodel.contacts/knowncontactfield_instantmessage.md +++ b/windows.applicationmodel.contacts/knowncontactfield_instantmessage.md @@ -1,31 +1,31 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.InstantMessage --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.KnownContactField.InstantMessage - -## -description -> [!NOTE] -> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). - -Contains the name of the field used for instant messaging accounts. - -## -property-value -The name of the field. - -## -remarks -Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the instant messaging names that a contact uses. - -## -examples -This code demonstrates how to get a contact's instant messaging information. - - - -[!code-js[ContactsKnownFields_IM](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_IM)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.InstantMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.KnownContactField.InstantMessage + +## -description +> [!NOTE] +> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). + +Contains the name of the field used for instant messaging accounts. + +## -property-value +The name of the field. + +## -remarks +Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the instant messaging names that a contact uses. + +## -examples +This code demonstrates how to get a contact's instant messaging information. + + + +[!code-js[ContactsKnownFields_IM](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_IM)] + +## -see-also diff --git a/windows.applicationmodel.contacts/knowncontactfield_location.md b/windows.applicationmodel.contacts/knowncontactfield_location.md index 7c9b068709..e62575f387 100644 --- a/windows.applicationmodel.contacts/knowncontactfield_location.md +++ b/windows.applicationmodel.contacts/knowncontactfield_location.md @@ -1,31 +1,31 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.Location --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.KnownContactField.Location - -## -description -> [!NOTE] -> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). - -Contains the name of the field used for the contact's location. - -## -property-value -The name of the field. - -## -remarks -Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the location of a contact. - -## -examples -This code demonstrates how to get the location of a contact. - - - -[!code-js[ContactsKnownFields_location](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_location)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.Location +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.KnownContactField.Location + +## -description +> [!NOTE] +> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). + +Contains the name of the field used for the contact's location. + +## -property-value +The name of the field. + +## -remarks +Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the location of a contact. + +## -examples +This code demonstrates how to get the location of a contact. + + + +[!code-js[ContactsKnownFields_location](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_location)] + +## -see-also diff --git a/windows.applicationmodel.contacts/knowncontactfield_phonenumber.md b/windows.applicationmodel.contacts/knowncontactfield_phonenumber.md index 4976be573d..27654a42a3 100644 --- a/windows.applicationmodel.contacts/knowncontactfield_phonenumber.md +++ b/windows.applicationmodel.contacts/knowncontactfield_phonenumber.md @@ -1,31 +1,31 @@ ---- --api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.PhoneNumber --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Contacts.KnownContactField.PhoneNumber - -## -description -> [!NOTE] -> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). - -Contains the name of the field used for phone numbers. - -## -property-value -The name of the field. - -## -remarks -Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the phone numbers of a contact. - -## -examples -This code demonstrates how to get a phone number of a contact. - - - -[!code-js[ContactsKnownFields_phone](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_phone)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Contacts.KnownContactField.PhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.KnownContactField.PhoneNumber + +## -description +> [!NOTE] +> [KnownContactField](knowncontactfield.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ContactAddress](contactaddress.md), [ContactPhone](contactphone.md), [ContactConnectedServiceAccount](contactconnectedserviceaccount.md), or [ContactEmail](contactemail.md). + +Contains the name of the field used for phone numbers. + +## -property-value +The name of the field. + +## -remarks +Use this property with the [ContactPicker.DesiredFields](contactpicker_desiredfields.md) property to specify that you want to get the phone numbers of a contact. + +## -examples +This code demonstrates how to get a phone number of a contact. + + + +[!code-js[ContactsKnownFields_phone](../windows.applicationmodel.contacts.provider/code/ContactsMain/javascript/js/contacts.js#SnippetContactsKnownFields_phone)] + +## -see-also diff --git a/windows.applicationmodel.core/applistentry.md b/windows.applicationmodel.core/applistentry.md index d3efa6ae8b..8c46746409 100644 --- a/windows.applicationmodel.core/applistentry.md +++ b/windows.applicationmodel.core/applistentry.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Core.AppListEntry --api-type: winrt class ---- # Windows.ApplicationModel.Core.AppListEntry ## -description Provides an app's display info such as its display name and description, and a method to launch the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Core.AppListEntry +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Core.AppListEntry + +## -description +Provides an app's display info such as its display name and description, and a method to launch the app. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/applistentry_displayinfo.md b/windows.applicationmodel.core/applistentry_displayinfo.md index 5a546969d6..34d77c2090 100644 --- a/windows.applicationmodel.core/applistentry_displayinfo.md +++ b/windows.applicationmodel.core/applistentry_displayinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.AppListEntry.DisplayInfo --api-type: winrt property ---- # Windows.ApplicationModel.Core.AppListEntry.DisplayInfo ## -description Provides an app's display name, description, and logo. ## -property-value An object representing the app's display name, description, and logo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.AppListEntry.DisplayInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.AppListEntry.DisplayInfo + +## -description +Provides an app's display name, description, and logo. + +## -property-value +An object representing the app's display name, description, and logo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/applistentry_launchasync_79233887.md b/windows.applicationmodel.core/applistentry_launchasync_79233887.md index 484fd5572b..b65a1f406d 100644 --- a/windows.applicationmodel.core/applistentry_launchasync_79233887.md +++ b/windows.applicationmodel.core/applistentry_launchasync_79233887.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Core.AppListEntry.LaunchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Core.AppListEntry.LaunchAsync ## -description Launches the app associated with this [AppListEntry](applistentry.md) ## -returns If the launch fails for any reason, the Boolean value is **false** ## -remarks The app is launched without passing parameters. It is launched in the same way as if the user clicked on the entry in the app list. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.AppListEntry.LaunchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.AppListEntry.LaunchAsync + +## -description +Launches the app associated with this [AppListEntry](applistentry.md) + +## -returns +If the launch fails for any reason, the Boolean value is **false** + +## -remarks +The app is launched without passing parameters. It is launched in the same way as if the user clicked on the entry in the app list. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_backgroundactivated.md b/windows.applicationmodel.core/coreapplication_backgroundactivated.md index 8e5c39f2be..f0bc121814 100644 --- a/windows.applicationmodel.core/coreapplication_backgroundactivated.md +++ b/windows.applicationmodel.core/coreapplication_backgroundactivated.md @@ -1,3 +1,26 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.BackgroundActivated --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.BackgroundActivated ## -description Fired when your app is activated by a background trigger. ## -remarks Register your background triggers with [BackgroundTaskBuilder](../windows.applicationmodel.background/backgroundtaskbuilder.md), but do not set the [TaskEntryPoint](../windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md). This will enable this event to fire when your trigger is signaled. The event handler has a [BackgroundActivatedEventArgs](../windows.applicationmodel.activation/backgroundactivatedeventargs.md) parameter which contains everything that the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method delivers. > [!TIP] > By the time an app enters the background state, none of its UI is visible. ## -examples ## -see-also [BackgroundActivatedEventArgs](../windows.applicationmodel.activation/backgroundactivatedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.BackgroundActivated +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.BackgroundActivated + +## -description +Fired when your app is activated by a background trigger. + +## -remarks +Register your background triggers with [BackgroundTaskBuilder](../windows.applicationmodel.background/backgroundtaskbuilder.md), but do not set the [TaskEntryPoint](../windows.applicationmodel.background/backgroundtaskbuilder_taskentrypoint.md). This will enable this event to fire when your trigger is signaled. The event handler has a [BackgroundActivatedEventArgs](../windows.applicationmodel.activation/backgroundactivatedeventargs.md) parameter which contains everything that the [IBackgroundTask.Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method delivers. + + + +> [!TIP] +> By the time an app enters the background state, none of its UI is visible. + +## -examples + +## -see-also +[BackgroundActivatedEventArgs](../windows.applicationmodel.activation/backgroundactivatedeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_createnewview_1643095864.md b/windows.applicationmodel.core/coreapplication_createnewview_1643095864.md index 3e835d43c0..053e0861e4 100644 --- a/windows.applicationmodel.core/coreapplication_createnewview_1643095864.md +++ b/windows.applicationmodel.core/coreapplication_createnewview_1643095864.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.CreateNewView(Windows.ApplicationModel.Core.IFrameworkViewSource) --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.CreateNewView ## -description Creates a new view for the app. ## -parameters ### -param viewSource The view provider for the new view. ## -returns The view. ## -remarks ## -examples ## -see-also [CreateNewView](coreapplication_createnewview_888060163.md), [CreateNewView(String, String)](coreapplication_createnewview_563301789.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.CreateNewView(Windows.ApplicationModel.Core.IFrameworkViewSource) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.CreateNewView + +## -description +Creates a new view for the app. + +## -parameters +### -param viewSource +The view provider for the new view. + +## -returns +The view. + +## -remarks + +## -examples + +## -see-also +[CreateNewView](coreapplication_createnewview_888060163.md), [CreateNewView(String, String)](coreapplication_createnewview_563301789.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_createnewview_563301789.md b/windows.applicationmodel.core/coreapplication_createnewview_563301789.md index ac29e24919..82932a8409 100644 --- a/windows.applicationmodel.core/coreapplication_createnewview_563301789.md +++ b/windows.applicationmodel.core/coreapplication_createnewview_563301789.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.CreateNewView(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.CreateNewView ## -description Creates a new view for the app. ## -parameters ### -param runtimeType The class ID of the view provider for the new view. If this parameter is null, use the current view provider. ### -param entryPoint Additional info about the view, such as its class name in the app code. ## -returns The view. ## -remarks ## -examples ## -see-also [CreateNewView](coreapplication_createnewview_888060163.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.CreateNewView(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.CreateNewView + +## -description +Creates a new view for the app. + +## -parameters +### -param runtimeType +The class ID of the view provider for the new view. If this parameter is null, use the current view provider. + +### -param entryPoint +Additional info about the view, such as its class name in the app code. + +## -returns +The view. + +## -remarks + +## -examples + +## -see-also +[CreateNewView](coreapplication_createnewview_888060163.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_createnewview_888060163.md b/windows.applicationmodel.core/coreapplication_createnewview_888060163.md index 395bc758a5..06fcb05300 100644 --- a/windows.applicationmodel.core/coreapplication_createnewview_888060163.md +++ b/windows.applicationmodel.core/coreapplication_createnewview_888060163.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.CreateNewView --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.CreateNewView ## -description Creates a new view for the app. ## -returns The view. ## -remarks ## -examples ## -see-also [CreateNewView(String, String)](coreapplication_createnewview_563301789.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.CreateNewView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.CreateNewView + +## -description +Creates a new view for the app. + +## -returns +The view. + +## -remarks + +## -examples + +## -see-also +[CreateNewView(String, String)](coreapplication_createnewview_563301789.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_decrementapplicationusecount_653340570.md b/windows.applicationmodel.core/coreapplication_decrementapplicationusecount_653340570.md index ea99173037..3dbe3acb36 100644 --- a/windows.applicationmodel.core/coreapplication_decrementapplicationusecount_653340570.md +++ b/windows.applicationmodel.core/coreapplication_decrementapplicationusecount_653340570.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.DecrementApplicationUseCount --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.DecrementApplicationUseCount ## -description Decrements the total count of running app instances that use this [CoreApplication](coreapplication.md) instance. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.DecrementApplicationUseCount +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.DecrementApplicationUseCount + +## -description +Decrements the total count of running app instances that use this [CoreApplication](coreapplication.md) instance. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_enableprelaunch_198591978.md b/windows.applicationmodel.core/coreapplication_enableprelaunch_198591978.md index e6f40cdece..d625518dc2 100644 --- a/windows.applicationmodel.core/coreapplication_enableprelaunch_198591978.md +++ b/windows.applicationmodel.core/coreapplication_enableprelaunch_198591978.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.EnablePrelaunch(System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.EnablePrelaunch ## -description Enable or disable the operating system's ability to prelaunch your app. ## -parameters ### -param value **True** to enable prelaunch for your app; **false**, otherwise. ## -remarks When available system resources allow, the startup performance of Windows Store apps is improved by proactively launching the user’s most frequently used Windows Store apps in the background. A prelaunched app is put into the suspended state shortly after it is launched. When the user invokes the app, the app is resumed by bringing it from the suspended state to the running state--which is faster than launching the app cold. Windows 10 automatically prelaunched Windows Store apps. In Windows 10, version 1607, Windows Store apps must opt-in to be prelaunched. You will typically make this call during the first run of your app although you may call the function multiple times and with different values without harm. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.EnablePrelaunch(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.EnablePrelaunch + +## -description +Enable or disable the operating system's ability to prelaunch your app. + +## -parameters +### -param value +**True** to enable prelaunch for your app; **false**, otherwise. + +## -remarks +When available system resources allow, the startup performance of Windows Store apps is improved by proactively launching the user’s most frequently used Windows Store apps in the background. A prelaunched app is put into the suspended state shortly after it is launched. When the user invokes the app, the app is resumed by bringing it from the suspended state to the running state--which is faster than launching the app cold. + +Windows 10 automatically prelaunched Windows Store apps. In Windows 10, version 1607, Windows Store apps must opt-in to be prelaunched. You will typically make this call during the first run of your app although you may call the function multiple times and with different values without harm. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_enteredbackground.md b/windows.applicationmodel.core/coreapplication_enteredbackground.md index 1428e4361e..e5b28226eb 100644 --- a/windows.applicationmodel.core/coreapplication_enteredbackground.md +++ b/windows.applicationmodel.core/coreapplication_enteredbackground.md @@ -1,3 +1,25 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.EnteredBackground --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.EnteredBackground ## -description Fired when the app enters the running in the background state. ## -remarks This event is fired when your app is no longer visible in the foreground. Previously your suspending callback was the best place to save state after a user finished a session with your app. However, now an application may continue running in the background and then move back to the foreground due to trigger activity without ever reaching the suspended state. The best place to save data after a user session is in your entered background event handler. Memory limits also change as an app moves into the background. It is best to check the [MemoryManager](../windows.system/memorymanager.md) and release memory if needed to ensure your app does not get terminated. ## -examples ## -see-also [EnteredBackgroundEventArgs](../windows.applicationmodel/enteredbackgroundeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.EnteredBackground +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.EnteredBackground + +## -description +Fired when the app enters the running in the background state. + +## -remarks +This event is fired when your app is no longer visible in the foreground. + +Previously your suspending callback was the best place to save state after a user finished a session with your app. However, now an application may continue running in the background and then move back to the foreground due to trigger activity without ever reaching the suspended state. The best place to save data after a user session is in your entered background event handler. + +Memory limits also change as an app moves into the background. It is best to check the [MemoryManager](../windows.system/memorymanager.md) and release memory if needed to ensure your app does not get terminated. + +## -examples + +## -see-also +[EnteredBackgroundEventArgs](../windows.applicationmodel/enteredbackgroundeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_exit_1158854104.md b/windows.applicationmodel.core/coreapplication_exit_1158854104.md index 4640c40f51..e52a6c93f7 100644 --- a/windows.applicationmodel.core/coreapplication_exit_1158854104.md +++ b/windows.applicationmodel.core/coreapplication_exit_1158854104.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.Exit --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.Exit ## -description Shuts down the app. ## -remarks Starting with Windows 10, calling this method is no longer is treated as an app crash. Don't call this method from within an activation event handler. ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.Exit +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Exit + +## -description +Shuts down the app. + +## -remarks +Starting with Windows 10, calling this method is no longer is treated as an app crash. + +Don't call this method from within an activation event handler. + +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_exiting.md b/windows.applicationmodel.core/coreapplication_exiting.md index 34827a9756..90cc46806b 100644 --- a/windows.applicationmodel.core/coreapplication_exiting.md +++ b/windows.applicationmodel.core/coreapplication_exiting.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.Exiting --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.Exiting ## -description Occurs when the app is shutting down. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.Exiting +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Exiting + +## -description +Occurs when the app is shutting down. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_getcurrentview_176591067.md b/windows.applicationmodel.core/coreapplication_getcurrentview_176591067.md index 2b2902e13d..5114f0803b 100644 --- a/windows.applicationmodel.core/coreapplication_getcurrentview_176591067.md +++ b/windows.applicationmodel.core/coreapplication_getcurrentview_176591067.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.GetCurrentView --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.GetCurrentView ## -description Gets the active view for the app. ## -returns The active view. ## -remarks A [CoreApplicationView](coreapplicationview.md) is an app window and its thread. ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.GetCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.GetCurrentView + +## -description +Gets the active view for the app. + +## -returns +The active view. + +## -remarks +A [CoreApplicationView](coreapplicationview.md) is an app window and its thread. + +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_id.md b/windows.applicationmodel.core/coreapplication_id.md index 411a7f589c..7080312600 100644 --- a/windows.applicationmodel.core/coreapplication_id.md +++ b/windows.applicationmodel.core/coreapplication_id.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplication.Id --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplication.Id ## -description Gets the package-relative app identifier for the process. ## -property-value The package-relative app identifier for the process. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplication.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Id + +## -description +Gets the package-relative app identifier for the process. + +## -property-value +The package-relative app identifier for the process. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_incrementapplicationusecount_2136897499.md b/windows.applicationmodel.core/coreapplication_incrementapplicationusecount_2136897499.md index a68e4c8bbb..16a6c70645 100644 --- a/windows.applicationmodel.core/coreapplication_incrementapplicationusecount_2136897499.md +++ b/windows.applicationmodel.core/coreapplication_incrementapplicationusecount_2136897499.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.IncrementApplicationUseCount --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.IncrementApplicationUseCount ## -description Increments the total count of running app instances that use this [CoreApplication](coreapplication.md) instance. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.IncrementApplicationUseCount +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.IncrementApplicationUseCount + +## -description +Increments the total count of running app instances that use this [CoreApplication](coreapplication.md) instance. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_leavingbackground.md b/windows.applicationmodel.core/coreapplication_leavingbackground.md index ed954e5d0b..f1d8804dd1 100644 --- a/windows.applicationmodel.core/coreapplication_leavingbackground.md +++ b/windows.applicationmodel.core/coreapplication_leavingbackground.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.LeavingBackground --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.LeavingBackground ## -description Fired just before application UI becomes visible. ## -remarks Previously the best location to load UI was in your activated or resuming event handler. Now your handler for the [LeavingBackground](coreapplication_leavingbackground.md) event is the best place to do your final checks to ensure that the UI is ready for presentation. It is important to check that visual assets are ready by this time because this is the last opportunity to do work before your application is visible to the user. ## -examples ## -see-also [LeavingBackgroundEventArgs](../windows.applicationmodel/leavingbackgroundeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.LeavingBackground +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.LeavingBackground + +## -description +Fired just before application UI becomes visible. + +## -remarks +Previously the best location to load UI was in your activated or resuming event handler. Now your handler for the [LeavingBackground](coreapplication_leavingbackground.md) event is the best place to do your final checks to ensure that the UI is ready for presentation. It is important to check that visual assets are ready by this time because this is the last opportunity to do work before your application is visible to the user. + +## -examples + +## -see-also +[LeavingBackgroundEventArgs](../windows.applicationmodel/leavingbackgroundeventargs.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_mainview.md b/windows.applicationmodel.core/coreapplication_mainview.md index 5e45713a1a..bc82124bb4 100644 --- a/windows.applicationmodel.core/coreapplication_mainview.md +++ b/windows.applicationmodel.core/coreapplication_mainview.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplication.MainView --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplication.MainView ## -description Gets the main [CoreApplicationView](coreapplicationview.md) instance for all running apps that use this [CoreApplication](coreapplication.md) instance. ## -property-value The main view for this [CoreApplication](coreapplication.md) instance. ## -remarks A [CoreApplicationView](coreapplicationview.md) is the app window and its thread. ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplication.MainView +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.MainView + +## -description +Gets the main [CoreApplicationView](coreapplicationview.md) instance for all running apps that use this [CoreApplication](coreapplication.md) instance. + +## -property-value +The main view for this [CoreApplication](coreapplication.md) instance. + +## -remarks +A [CoreApplicationView](coreapplicationview.md) is the app window and its thread. + +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_properties.md b/windows.applicationmodel.core/coreapplication_properties.md index cda755b340..a585636315 100644 --- a/windows.applicationmodel.core/coreapplication_properties.md +++ b/windows.applicationmodel.core/coreapplication_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplication.Properties --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplication.Properties ## -description Gets a property set that the app and UI frameworks can use to store info while the process is running. ## -property-value The property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplication.Properties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Properties + +## -description +Gets a property set that the app and UI frameworks can use to store info while the process is running. + +## -property-value +The property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_resuming.md b/windows.applicationmodel.core/coreapplication_resuming.md index fde75c1a3c..79cf0e7ee7 100644 --- a/windows.applicationmodel.core/coreapplication_resuming.md +++ b/windows.applicationmodel.core/coreapplication_resuming.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.Resuming --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.Resuming ## -description Occurs when an app is resuming. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.Resuming +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Resuming + +## -description +Occurs when an app is resuming. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_run_1480028297.md b/windows.applicationmodel.core/coreapplication_run_1480028297.md index 924bca17f5..8e197c128b 100644 --- a/windows.applicationmodel.core/coreapplication_run_1480028297.md +++ b/windows.applicationmodel.core/coreapplication_run_1480028297.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.Run(Windows.ApplicationModel.Core.IFrameworkViewSource) --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.Run ## -description Runs an external view provider factory to obtain a view provider. ## -parameters ### -param viewSource An implementation of a view provider factory. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also [CoreApplication::RunWithActivationFactories](coreapplication_runwithactivationfactories.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.Run(Windows.ApplicationModel.Core.IFrameworkViewSource) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Run + +## -description +Runs an external view provider factory to obtain a view provider. + +## -parameters +### -param viewSource +An implementation of a view provider factory. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also +[CoreApplication::RunWithActivationFactories](coreapplication_runwithactivationfactories.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_runwithactivationfactories_672867736.md b/windows.applicationmodel.core/coreapplication_runwithactivationfactories_672867736.md index beb8d78f36..e6b6f33879 100644 --- a/windows.applicationmodel.core/coreapplication_runwithactivationfactories_672867736.md +++ b/windows.applicationmodel.core/coreapplication_runwithactivationfactories_672867736.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Core.CoreApplication.RunWithActivationFactories(Windows.Foundation.IGetActivationFactory) --api-type: winrt method ---- # Windows.ApplicationModel.Core.CoreApplication.RunWithActivationFactories ## -description Runs an activatable type factory to obtain an external activatable type. ## -parameters ### -param activationFactoryCallback An implementation of an activatable type factory. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also [CoreApplication::Run](coreapplication_run.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.CoreApplication.RunWithActivationFactories(Windows.Foundation.IGetActivationFactory) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.RunWithActivationFactories + +## -description +Runs an activatable type factory to obtain an external activatable type. + +## -parameters +### -param activationFactoryCallback +An implementation of an activatable type factory. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also +[CoreApplication::Run](coreapplication_run.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplication_suspending.md b/windows.applicationmodel.core/coreapplication_suspending.md index b07b0b84b2..a58a13fdd6 100644 --- a/windows.applicationmodel.core/coreapplication_suspending.md +++ b/windows.applicationmodel.core/coreapplication_suspending.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.Suspending --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.Suspending ## -description Occurs when the app is suspending. ## -remarks ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.Suspending +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Suspending + +## -description +Occurs when the app is suspending. + +## -remarks +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_unhandlederrordetected.md b/windows.applicationmodel.core/coreapplication_unhandlederrordetected.md index a73db7f899..e8dfb2f0a4 100644 --- a/windows.applicationmodel.core/coreapplication_unhandlederrordetected.md +++ b/windows.applicationmodel.core/coreapplication_unhandlederrordetected.md @@ -1,3 +1,33 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplication.UnhandledErrorDetected --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplication.UnhandledErrorDetected ## -description Occurs when there is an underlying error that is routed to the [CoreApplication](coreapplication.md) instance, as part of global error handling logic. ## -remarks As part of an app's life cycle management code, developers can inspect error data ([UnhandledError](unhandlederror.md)) from an **UnhandledErrorDetected** event, and choose whether to mark the error as handled. If the error is marked handled in the event data, then execution can continue. If the error is not marked handled, the app and its process will be terminated. Errors that can fire **UnhandledErrorDetected** include errors that are thrown by code within an async completed handler. **UnhandledErrorDetected** will occur if an app-code event handler throws an error, but the reason that the handler was executed was that system code (not app code) raised the event. App code doesn't always see that error or see that the handler executed. Returning a failure from any delegate clears the handled state of the error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplication.UnhandledErrorDetected +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.UnhandledErrorDetected + +## -description +Occurs when there is an underlying error that is routed to the [CoreApplication](coreapplication.md) instance, as part of global error handling logic. + +## -remarks +As part of an app's life cycle management code, developers can inspect error data ([UnhandledError](unhandlederror.md)) from an **UnhandledErrorDetected** event, and choose whether to mark the error as handled. If the error is marked handled in the event data, then execution can continue. If the error is not marked handled, the app and its process will be terminated. + +Errors that can fire **UnhandledErrorDetected** include errors that are thrown by code within an async completed handler. + +**UnhandledErrorDetected** will occur if an app-code event handler throws an error, but the reason that the handler was executed was that system code (not app code) raised the event. App code doesn't always see that error or see that the handler executed. + +Returning a failure from any delegate clears the handled state of the error. + + + + + + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplication_views.md b/windows.applicationmodel.core/coreapplication_views.md index 32c4c76ef4..9561a0701d 100644 --- a/windows.applicationmodel.core/coreapplication_views.md +++ b/windows.applicationmodel.core/coreapplication_views.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplication.Views --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplication.Views ## -description Gets all views for the app. ## -property-value All of the app's views. ## -remarks A view is an app window and its thread. ### Windows Phone 8 This API is supported in native apps only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplication.Views +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplication.Views + +## -description +Gets all views for the app. + +## -property-value +All of the app's views. + +## -remarks +A view is an app window and its thread. + +### Windows Phone 8 + +This API is supported in native apps only. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationview_activated.md b/windows.applicationmodel.core/coreapplicationview_activated.md index 522c935f18..3c79adf2e7 100644 --- a/windows.applicationmodel.core/coreapplicationview_activated.md +++ b/windows.applicationmodel.core/coreapplicationview_activated.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplicationView.Activated --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplicationView.Activated ## -description Occurs when the view is activated. ## -remarks ## -examples ## -see-also [Splash screen sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620608) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplicationView.Activated +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.Activated + +## -description +Occurs when the view is activated. + +## -remarks + +## -examples + +## -see-also +[Splash screen sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620608) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplicationview_corewindow.md b/windows.applicationmodel.core/coreapplicationview_corewindow.md index d6cfff9574..af8ac8ff9f 100644 --- a/windows.applicationmodel.core/coreapplicationview_corewindow.md +++ b/windows.applicationmodel.core/coreapplicationview_corewindow.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.CoreWindow --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationView.CoreWindow ## -description Gets the app window associated with the current view. ## -property-value The app window. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.CoreWindow +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.CoreWindow + +## -description +Gets the app window associated with the current view. + +## -property-value +The app window. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationview_dispatcher.md b/windows.applicationmodel.core/coreapplicationview_dispatcher.md index dda9f3e8af..b17f453df2 100644 --- a/windows.applicationmodel.core/coreapplicationview_dispatcher.md +++ b/windows.applicationmodel.core/coreapplicationview_dispatcher.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.Dispatcher --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationView.Dispatcher ## -description Gets the event message dispatcher associated with the current view. ## -property-value The event message dispatcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.Dispatcher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.Dispatcher + +## -description +Gets the event message dispatcher associated with the current view. + +## -property-value +The event message dispatcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationview_hostedviewclosing.md b/windows.applicationmodel.core/coreapplicationview_hostedviewclosing.md index 8256615aa8..086a03708e 100644 --- a/windows.applicationmodel.core/coreapplicationview_hostedviewclosing.md +++ b/windows.applicationmodel.core/coreapplicationview_hostedviewclosing.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplicationView.HostedViewClosing --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplicationView.HostedViewClosing ## -description Indicates that the hosted view is closing. Provides an opportunity for hosted window scenarios to defer the tear down of the hosted view. ## -remarks Handling this event provides an opportunity to perform cleanup tasks such as closing files, flushing buffers to disk, and so on. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplicationView.HostedViewClosing +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.HostedViewClosing + +## -description +Indicates that the hosted view is closing. Provides an opportunity for hosted window scenarios to defer the tear down of the hosted view. + +## -remarks +Handling this event provides an opportunity to perform cleanup tasks such as closing files, flushing buffers to disk, and so on. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationview_iscomponent.md b/windows.applicationmodel.core/coreapplicationview_iscomponent.md index f7ed5072ce..840f498871 100644 --- a/windows.applicationmodel.core/coreapplicationview_iscomponent.md +++ b/windows.applicationmodel.core/coreapplicationview_iscomponent.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.IsComponent --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationView.IsComponent ## -description Gets whether the app was launched as a component that is embedded in another app by calling the [LaunchAsync](restrictedappcontainer_launchasync.md) method. This property is reserved for internal use and is not intended to be used in your code. ## -property-value True if the app was launched as a component that is embedded in another app; false if the app was not launch as a component that is embedded in another app. ## -remarks ## -examples ## -see-also [LaunchAsync](restrictedappcontainer_launchasync.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.IsComponent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.IsComponent + +## -description +Gets whether the app was launched as a component that is embedded in another app by calling the [LaunchAsync](restrictedappcontainer_launchasync.md) method. + +This property is reserved for internal use and is not intended to be used in your code. + +## -property-value +True if the app was launched as a component that is embedded in another app; false if the app was not launch as a component that is embedded in another app. + +## -remarks + +## -examples + +## -see-also +[LaunchAsync](restrictedappcontainer_launchasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplicationview_ishosted.md b/windows.applicationmodel.core/coreapplicationview_ishosted.md index 45b18972f3..33a34ec3e6 100644 --- a/windows.applicationmodel.core/coreapplicationview_ishosted.md +++ b/windows.applicationmodel.core/coreapplicationview_ishosted.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.IsHosted --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationView.IsHosted ## -description Gets the value that indicates whether this app view is hosted or not. ## -property-value If **true**, this app view is hosted; if **false**, it is not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.IsHosted +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.IsHosted + +## -description +Gets the value that indicates whether this app view is hosted or not. + +## -property-value +If **true**, this app view is hosted; if **false**, it is not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationview_ismain.md b/windows.applicationmodel.core/coreapplicationview_ismain.md index 8c4c68fc14..2d511569ae 100644 --- a/windows.applicationmodel.core/coreapplicationview_ismain.md +++ b/windows.applicationmodel.core/coreapplicationview_ismain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.IsMain --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationView.IsMain ## -description Gets a value that indicates whether this app view is the main app view or not. ## -property-value If **true**, this app view is the main; if **false**, it is not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.IsMain +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.IsMain + +## -description +Gets a value that indicates whether this app view is the main app view or not. + +## -property-value +If **true**, this app view is the main; if **false**, it is not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationview_titlebar.md b/windows.applicationmodel.core/coreapplicationview_titlebar.md index 413fee264e..92b5464183 100644 --- a/windows.applicationmodel.core/coreapplicationview_titlebar.md +++ b/windows.applicationmodel.core/coreapplicationview_titlebar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.TitleBar --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationView.TitleBar ## -description Gets the title bar associated with the current view. ## -property-value The title bar associated with the current view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.TitleBar +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.TitleBar + +## -description +Gets the title bar associated with the current view. + +## -property-value +The title bar associated with the current view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar.md b/windows.applicationmodel.core/coreapplicationviewtitlebar.md index 66a458625e..c4e18bfa6d 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar --api-type: winrt class ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar ## -description Enables an app to define a custom title bar that displays in the app's window. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar + +## -description +Enables an app to define a custom title bar that displays in the app's window. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_extendviewintotitlebar.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_extendviewintotitlebar.md index 6f0a4744cb..af768bfc3f 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_extendviewintotitlebar.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_extendviewintotitlebar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.ExtendViewIntoTitleBar --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.ExtendViewIntoTitleBar ## -description Gets or sets a value that specifies whether this title bar should replace the default window title bar. ## -property-value Set to **true** to replace the default window title bar; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.ExtendViewIntoTitleBar +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.ExtendViewIntoTitleBar + +## -description +Gets or sets a value that specifies whether this title bar should replace the default window title bar. + +## -property-value +Set to **true** to replace the default window title bar; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_height.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_height.md index 36bc36a373..8a357a7f4c 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_height.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.Height --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.Height ## -description Gets or sets the height of the title bar. ## -property-value The height of the custom title bar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.Height +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.Height + +## -description +Gets or sets the height of the title bar. + +## -property-value +The height of the custom title bar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisible.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisible.md index 7142a63ff6..5638bfb30a 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisible.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisible.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisible --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisible ## -description Gets a value that specifies whether this title bar is visible. ## -property-value **true** if this title bar is visible; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisible +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisible + +## -description +Gets a value that specifies whether this title bar is visible. + +## -property-value +**true** if this title bar is visible; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisiblechanged.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisiblechanged.md index adc3a55ff8..a6592eec60 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisiblechanged.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_isvisiblechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisibleChanged --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisibleChanged ## -description Occurs when the visibility of the title bar (indicated by the [IsVisible](coreapplicationviewtitlebar_isvisible.md) property) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisibleChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.IsVisibleChanged + +## -description +Occurs when the visibility of the title bar (indicated by the [IsVisible](coreapplicationviewtitlebar_isvisible.md) property) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_layoutmetricschanged.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_layoutmetricschanged.md index 49755f7d4a..5c4d83c119 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_layoutmetricschanged.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_layoutmetricschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.LayoutMetricsChanged --api-type: winrt event ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.LayoutMetricsChanged ## -description Occurs when the title bar needs to respond to size changes. The most common trigger for this event is when the app window moves to a screen that has a different DPI. Use this event to verify and update the positioning of UI elements that depend on the title bar's size. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.LayoutMetricsChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.LayoutMetricsChanged + +## -description +Occurs when the title bar needs to respond to size changes. The most common trigger for this event is when the app window moves to a screen that has a different DPI. Use this event to verify and update the positioning of UI elements that depend on the title bar's size. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayleftinset.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayleftinset.md index ff733959a4..a83a056c12 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayleftinset.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayleftinset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayLeftInset --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayLeftInset ## -description Gets the width of the system-reserved region of the upper-left corner of the app window. This region is reserved when the current language is a right-to-left language. ## -property-value The width of the system-reserved region of the upper-left corner of the app window ## -remarks For applications with custom title bars, the system reserves the option to have system UI drawn in the upper-left or upper-right corner of the app window. The system draws caption buttons in the upper-right for left-to-right languages and the upper-left for right-to-left languages. The width of the reserved region on each side is given by [SystemOverlayLeftInset](coreapplicationviewtitlebar_systemoverlayleftinset.md) or [SystemOverlayRightInset](coreapplicationviewtitlebar_systemoverlayrightinset.md), and its height is given by [CoreApplicationViewTitleBar.Height](coreapplicationviewtitlebar_height.md). In the areas described by these regions, apps should not put any UI which they expect the user to be able to interact with. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayLeftInset +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayLeftInset + +## -description +Gets the width of the system-reserved region of the upper-left corner of the app window. This region is reserved when the current language is a right-to-left language. + +## -property-value +The width of the system-reserved region of the upper-left corner of the app window + +## -remarks +For applications with custom title bars, the system reserves the option to have system UI drawn in the upper-left or upper-right corner of the app window. The system draws caption buttons in the upper-right for left-to-right languages and the upper-left for right-to-left languages. The width of the reserved region on each side is given by [SystemOverlayLeftInset](coreapplicationviewtitlebar_systemoverlayleftinset.md) or [SystemOverlayRightInset](coreapplicationviewtitlebar_systemoverlayrightinset.md), and its height is given by [CoreApplicationViewTitleBar.Height](coreapplicationviewtitlebar_height.md). In the areas described by these regions, apps should not put any UI which they expect the user to be able to interact with. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayrightinset.md b/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayrightinset.md index df9c04ed4f..9be3356233 100644 --- a/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayrightinset.md +++ b/windows.applicationmodel.core/coreapplicationviewtitlebar_systemoverlayrightinset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayRightInset --api-type: winrt property ---- # Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayRightInset ## -description Gets the width of the system-reserved region of the upper-right corner of the app window. This region is reserved when the current language is a left-to-right language. ## -property-value The width of the system-reserved region of the upper-right corner of the app window. ## -remarks For applications with custom title bars, the system reserves the option to have system UI drawn in the upper-left or upper-right corner of the app window. The system draws caption buttons in the upper-right for left-to-right languages and the upper-left for right-to-left languages. The width of the reserved region on each side is given by [SystemOverlayLeftInset](coreapplicationviewtitlebar_systemoverlayleftinset.md) or [SystemOverlayRightInset](coreapplicationviewtitlebar_systemoverlayrightinset.md), and its height is given by [CoreApplicationViewTitleBar.Height](coreapplicationviewtitlebar_height.md). In the areas described by these regions, apps should not put any UI which they expect the user to be able to interact with. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayRightInset +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationViewTitleBar.SystemOverlayRightInset + +## -description +Gets the width of the system-reserved region of the upper-right corner of the app window. This region is reserved when the current language is a left-to-right language. + +## -property-value +The width of the system-reserved region of the upper-right corner of the app window. + +## -remarks +For applications with custom title bars, the system reserves the option to have system UI drawn in the upper-left or upper-right corner of the app window. The system draws caption buttons in the upper-right for left-to-right languages and the upper-left for right-to-left languages. The width of the reserved region on each side is given by [SystemOverlayLeftInset](coreapplicationviewtitlebar_systemoverlayleftinset.md) or [SystemOverlayRightInset](coreapplicationviewtitlebar_systemoverlayrightinset.md), and its height is given by [CoreApplicationViewTitleBar.Height](coreapplicationviewtitlebar_height.md). In the areas described by these regions, apps should not put any UI which they expect the user to be able to interact with. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/hostedviewclosingeventargs.md b/windows.applicationmodel.core/hostedviewclosingeventargs.md index f71241b423..ba29c43157 100644 --- a/windows.applicationmodel.core/hostedviewclosingeventargs.md +++ b/windows.applicationmodel.core/hostedviewclosingeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Core.HostedViewClosingEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Core.HostedViewClosingEventArgs ## -description Provides a [Deferral](../windows.foundation/deferral.md) you can call when the [HostedViewClosing](coreapplicationview_hostedviewclosing.md) event fires to defer the tear down of the hosted view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Core.HostedViewClosingEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Core.HostedViewClosingEventArgs + +## -description +Provides a [Deferral](../windows.foundation/deferral.md) you can call when the [HostedViewClosing](coreapplicationview_hostedviewclosing.md) event fires to defer the tear down of the hosted view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/hostedviewclosingeventargs_getdeferral_254836512.md b/windows.applicationmodel.core/hostedviewclosingeventargs_getdeferral_254836512.md index be678c0b59..7e24a84a62 100644 --- a/windows.applicationmodel.core/hostedviewclosingeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.core/hostedviewclosingeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Core.HostedViewClosingEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Core.HostedViewClosingEventArgs.GetDeferral ## -description Provides an opportunity for hosted window scenarios to defer the tear down of the window, dispatcher, and Application Single-Threaded Apartment (ASTA) thread of the hosted view. ## -returns The deferral you can call to defer the tear down of the hosted view. ## -remarks If the deferral is taken, the hosted view's window, dispatcher, and Application Single-Threaded Apartment (ASTA) thread will not be torn down until the deferral is completed or a timeout value expires. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.HostedViewClosingEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.HostedViewClosingEventArgs.GetDeferral + +## -description +Provides an opportunity for hosted window scenarios to defer the tear down of the window, dispatcher, and Application Single-Threaded Apartment (ASTA) thread of the hosted view. + +## -returns +The deferral you can call to defer the tear down of the hosted view. + +## -remarks +If the deferral is taken, the hosted view's window, dispatcher, and Application Single-Threaded Apartment (ASTA) thread will not be torn down until the deferral is completed or a timeout value expires. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/icoreapplicationunhandlederror_unhandlederrordetected.md b/windows.applicationmodel.core/icoreapplicationunhandlederror_unhandlederrordetected.md index 4c1d841208..f9f5293022 100644 --- a/windows.applicationmodel.core/icoreapplicationunhandlederror_unhandlederrordetected.md +++ b/windows.applicationmodel.core/icoreapplicationunhandlederror_unhandlederrordetected.md @@ -1,3 +1,48 @@ ---- -api-id: E:Windows.ApplicationModel.Core.ICoreApplicationUnhandledError.UnhandledErrorDetected --api-type: winrt event ---- # Windows.ApplicationModel.Core.ICoreApplicationUnhandledError.UnhandledErrorDetected ## -description Occurs when there is an error in an async completion or event handler that wasn't otherwise handled by system or app code. ## -remarks This event is raised whenever there is an error in an async completion or event handler that reaches top of stack without being handled by system or app code. Your app can inspect the error and choose whether to mark the error as handled (using the [Handled](unhandlederror_handled.md) property in event data). If the error is marked [Handled](unhandlederror_handled.md), execution will continue. If the error is not marked [Handled](unhandlederror_handled.md), the process will be terminated. ```cpp CoreApplication::UnhandledErrorDetected += ref new EventHandler ( [](Platform::Object^ sender, UnhandledErrorDetectedEventArgs^ ea) -> { if(!ea->UnhandledError->Handled) { try { // Take the failure HRESULT and wrap it in a language specific exception ea->UnhandledError->Propagate(); } catch (Platform::Exception^ e) { MyLogger::Log(e->Message); // Since UnhandledError.Propagate marks the error as Handled, rethrow in order to only Log and not Handle throw e; } } }); ``` ## -examples ## -see-also [UnhandledException](../windows.ui.xaml/application_unhandledexception.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Core.ICoreApplicationUnhandledError.UnhandledErrorDetected +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Core.ICoreApplicationUnhandledError.UnhandledErrorDetected + +## -description +Occurs when there is an error in an async completion or event handler that wasn't otherwise handled by system or app code. + +## -remarks +This event is raised whenever there is an error in an async completion or event handler that reaches top of stack without being handled by system or app code. Your app can inspect the error and choose whether to mark the error as handled (using the [Handled](unhandlederror_handled.md) property in event data). If the error is marked [Handled](unhandlederror_handled.md), execution will continue. If the error is not marked [Handled](unhandlederror_handled.md), the process will be terminated. + + + + + +```cpp +CoreApplication::UnhandledErrorDetected += ref new EventHandler ( + [](Platform::Object^ sender, UnhandledErrorDetectedEventArgs^ ea) -> + { + if(!ea->UnhandledError->Handled) + { + try + { + // Take the failure HRESULT and wrap it in a language specific exception + ea->UnhandledError->Propagate(); + } + catch (Platform::Exception^ e) + { + MyLogger::Log(e->Message); + // Since UnhandledError.Propagate marks the error as Handled, rethrow in order to only Log and not Handle + throw e; + } + } + }); +``` + + + +## -examples + +## -see-also +[UnhandledException](../windows.ui.xaml/application_unhandledexception.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/iframeworkview_initialize.md b/windows.applicationmodel.core/iframeworkview_initialize.md index 268cfebea8..33d12dce0a 100644 --- a/windows.applicationmodel.core/iframeworkview_initialize.md +++ b/windows.applicationmodel.core/iframeworkview_initialize.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Initialize(Windows.ApplicationModel.Core.CoreApplicationView) --api-type: winrt method ---- # Windows.ApplicationModel.Core.IFrameworkView.Initialize ## -description Initializes the app view. Called when an app object is launched. ## -parameters ### -param applicationView The default view provided by the app object. You can use this instance in your implementation to obtain the [CoreWindow](coreapplicationview_corewindow.md) created by the app object, and register callbacks for the [Activated](coreapplicationview_activated.md) event. ## -remarks This method is called by [CoreApplication.Run](coreapplication_run.md) on the view object that implements this interface. It is the first method called on the view implementation when the app object is activated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Initialize(Windows.ApplicationModel.Core.CoreApplicationView) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.IFrameworkView.Initialize + +## -description +Initializes the app view. Called when an app object is launched. + +## -parameters +### -param applicationView +The default view provided by the app object. You can use this instance in your implementation to obtain the [CoreWindow](coreapplicationview_corewindow.md) created by the app object, and register callbacks for the [Activated](coreapplicationview_activated.md) event. + +## -remarks +This method is called by [CoreApplication.Run](coreapplication_run.md) on the view object that implements this interface. It is the first method called on the view implementation when the app object is activated. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/iframeworkview_load.md b/windows.applicationmodel.core/iframeworkview_load.md index 0c2cb74564..b20971cb50 100644 --- a/windows.applicationmodel.core/iframeworkview_load.md +++ b/windows.applicationmodel.core/iframeworkview_load.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Load(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Core.IFrameworkView.Load ## -description Loads or activates any external resources used by the app view before [Run](coreapplication_run.md) is called. ## -parameters ### -param entryPoint The name of the entry point method for the activated type. ## -remarks If you are implementing a DirectX view provider, in this method you create DirectX-specific resources for your view, like the render target surface and the attached swap chain. If you are activating an out-of-process Windows Runtime type, the app object supplies the name of the entry point method for that type. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Load(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.IFrameworkView.Load + +## -description +Loads or activates any external resources used by the app view before [Run](coreapplication_run.md) is called. + +## -parameters +### -param entryPoint +The name of the entry point method for the activated type. + +## -remarks +If you are implementing a DirectX view provider, in this method you create DirectX-specific resources for your view, like the render target surface and the attached swap chain. If you are activating an out-of-process Windows Runtime type, the app object supplies the name of the entry point method for that type. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/iframeworkview_run.md b/windows.applicationmodel.core/iframeworkview_run.md index a95d085440..73d0f17002 100644 --- a/windows.applicationmodel.core/iframeworkview_run.md +++ b/windows.applicationmodel.core/iframeworkview_run.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Run --api-type: winrt method ---- # Windows.ApplicationModel.Core.IFrameworkView.Run ## -description Starts the app view. ## -remarks Your implementation of this method must at least activate the [CoreWindow](../windows.ui.core/corewindow.md) instance associated with the view, and start the event dispatcher for this window by calling [ProcessEvents](../windows.ui.core/coredispatcher_processevents.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Run +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.IFrameworkView.Run + +## -description +Starts the app view. + +## -remarks +Your implementation of this method must at least activate the [CoreWindow](../windows.ui.core/corewindow.md) instance associated with the view, and start the event dispatcher for this window by calling [ProcessEvents](../windows.ui.core/coredispatcher_processevents.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/iframeworkview_setwindow.md b/windows.applicationmodel.core/iframeworkview_setwindow.md index 70d945fa11..bffc1efd11 100644 --- a/windows.applicationmodel.core/iframeworkview_setwindow.md +++ b/windows.applicationmodel.core/iframeworkview_setwindow.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Core.IFrameworkView.SetWindow(Windows.UI.Core.CoreWindow) --api-type: winrt method ---- # Windows.ApplicationModel.Core.IFrameworkView.SetWindow ## -description Sets the current window for the app object's view. ## -parameters ### -param window The current window for the app object. ## -remarks The app object calls your implementation of this method whenever it needs to set the current window, represented as a [CoreWindow](../windows.ui.core/corewindow.md) instance, for the associated view. Your implementation must at least assign the provided window to the view and register for any view and window events. ## -examples ## -see-also [CoreWindow](../windows.ui.core/corewindow.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.IFrameworkView.SetWindow(Windows.UI.Core.CoreWindow) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.IFrameworkView.SetWindow + +## -description +Sets the current window for the app object's view. + +## -parameters +### -param window +The current window for the app object. + +## -remarks +The app object calls your implementation of this method whenever it needs to set the current window, represented as a [CoreWindow](../windows.ui.core/corewindow.md) instance, for the associated view. Your implementation must at least assign the provided window to the view and register for any view and window events. + +## -examples + +## -see-also +[CoreWindow](../windows.ui.core/corewindow.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/iframeworkview_uninitialize.md b/windows.applicationmodel.core/iframeworkview_uninitialize.md index 7666351697..dd8c78478f 100644 --- a/windows.applicationmodel.core/iframeworkview_uninitialize.md +++ b/windows.applicationmodel.core/iframeworkview_uninitialize.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Uninitialize --api-type: winrt method ---- # Windows.ApplicationModel.Core.IFrameworkView.Uninitialize ## -description Uninitializes the app view and releases external resources. ## -remarks Your implementation of this method should clean up any external resources created during the previous call to [Load](iframeworkview_load.md) when you created the app view. ### Windows Phone 8 You should not use [Uninitialize](iframeworkview_uninitialize.md) to exit an app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.IFrameworkView.Uninitialize +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.IFrameworkView.Uninitialize + +## -description +Uninitializes the app view and releases external resources. + +## -remarks +Your implementation of this method should clean up any external resources created during the previous call to [Load](iframeworkview_load.md) when you created the app view. + +### Windows Phone 8 + +You should not use [Uninitialize](iframeworkview_uninitialize.md) to exit an app. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/iframeworkviewsource_createview.md b/windows.applicationmodel.core/iframeworkviewsource_createview.md index 57cae0d717..16a25d5f1c 100644 --- a/windows.applicationmodel.core/iframeworkviewsource_createview.md +++ b/windows.applicationmodel.core/iframeworkviewsource_createview.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Core.IFrameworkViewSource.CreateView --api-type: winrt method ---- # Windows.ApplicationModel.Core.IFrameworkViewSource.CreateView ## -description Returns a view provider object. ## -returns An object that implements a view provider. ## -remarks ## -examples ## -see-also [IFrameworkView](iframeworkview.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.IFrameworkViewSource.CreateView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.IFrameworkViewSource.CreateView + +## -description +Returns a view provider object. + +## -returns +An object that implements a view provider. + +## -remarks + +## -examples + +## -see-also +[IFrameworkView](iframeworkview.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/unhandlederror_handled.md b/windows.applicationmodel.core/unhandlederror_handled.md index dea27b2acb..d838405963 100644 --- a/windows.applicationmodel.core/unhandlederror_handled.md +++ b/windows.applicationmodel.core/unhandlederror_handled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.UnhandledError.Handled --api-type: winrt property ---- # Windows.ApplicationModel.Core.UnhandledError.Handled ## -description Gets a value that indicates whether the error has been handled. ## -property-value **true** if the error has been handled. A value of **true** permits the app to continue. **false** if the error has not been handled. A value of **false** can result in the app being terminated once this event propagates to the Windows Runtime system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.UnhandledError.Handled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.UnhandledError.Handled + +## -description +Gets a value that indicates whether the error has been handled. + +## -property-value +**true** if the error has been handled. A value of **true** permits the app to continue. **false** if the error has not been handled. A value of **false** can result in the app being terminated once this event propagates to the Windows Runtime system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/unhandlederror_propagate_1640160602.md b/windows.applicationmodel.core/unhandlederror_propagate_1640160602.md index 7f0b9a8b5f..1fff885f3c 100644 --- a/windows.applicationmodel.core/unhandlederror_propagate_1640160602.md +++ b/windows.applicationmodel.core/unhandlederror_propagate_1640160602.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Core.UnhandledError.Propagate --api-type: winrt method ---- # Windows.ApplicationModel.Core.UnhandledError.Propagate ## -description Wraps the underlying error info in a language specific exception, and throws the error. ## -remarks In addition to throwing the language-specific wrapped error, calling this method marks the error as handled (sets [Handled](unhandlederror_handled.md) to **true**). However, if an error is returned from a delegate, the handled state is set to **false**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Core.UnhandledError.Propagate +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Core.UnhandledError.Propagate + +## -description +Wraps the underlying error info in a language specific exception, and throws the error. + +## -remarks +In addition to throwing the language-specific wrapped error, calling this method marks the error as handled (sets [Handled](unhandlederror_handled.md) to **true**). However, if an error is returned from a delegate, the handled state is set to **false**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.core/unhandlederrordetectedeventargs_unhandlederror.md b/windows.applicationmodel.core/unhandlederrordetectedeventargs_unhandlederror.md index 41f8c9758f..05d0a4efa1 100644 --- a/windows.applicationmodel.core/unhandlederrordetectedeventargs_unhandlederror.md +++ b/windows.applicationmodel.core/unhandlederrordetectedeventargs_unhandlederror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Core.UnhandledErrorDetectedEventArgs.UnhandledError --api-type: winrt property ---- # Windows.ApplicationModel.Core.UnhandledErrorDetectedEventArgs.UnhandledError ## -description Gets the error info object that can be used to handle the event or propagate the error through a language-specific error. ## -property-value An object that represents the unhandled error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Core.UnhandledErrorDetectedEventArgs.UnhandledError +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.UnhandledErrorDetectedEventArgs.UnhandledError + +## -description +Gets the error info object that can be used to handle the event or propagate the error through a language-specific error. + +## -property-value +An object that represents the unhandled error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager.md index 739f26be18..63a61ea6af 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager.md @@ -1,3 +1,41 @@ ---- -api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager --api-type: winrt class ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager ## -description Manages access for drag and drop within and between apps. ## -remarks ## -examples ```csharp public sealed partial class MainPage : Page { private void DropOperationTargetRequested(CoreDragDropManager sender, CoreDropOperationTargetRequestedEventArgs evtArgs) { // Create a target (see above for more implementation details) var target = new DropTarget (); evtArgs.SetTarget(target); } public MainPage() { InitializeComponents(); var dragDropManager = DragDropManager.GetForCurrentView(); dragDropManager.DropOperationTargetRequested += DropOperationTargetRequested; } } ``` ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager + +## -description +Manages access for drag and drop within and between apps. + +## -remarks + +## -examples +```csharp +public sealed partial class MainPage : Page +{ + private void DropOperationTargetRequested(CoreDragDropManager sender, + CoreDropOperationTargetRequestedEventArgs evtArgs) + { + // Create a target (see above for more implementation details) + var target = new DropTarget (); + evtArgs.SetTarget(target); + } + + public MainPage() + { + InitializeComponents(); + var dragDropManager = DragDropManager.GetForCurrentView(); + dragDropManager.DropOperationTargetRequested += DropOperationTargetRequested; + } +} + +``` + + + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_areconcurrentoperationsenabled.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_areconcurrentoperationsenabled.md index 319ad4b49f..9bb42bae5b 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_areconcurrentoperationsenabled.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_areconcurrentoperationsenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.AreConcurrentOperationsEnabled --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.AreConcurrentOperationsEnabled ## -description Gets or sets whether concurrent drag and drop operations are enabled. ## -property-value True if concurrent drag and drop operations are enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.AreConcurrentOperationsEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.AreConcurrentOperationsEnabled + +## -description +Gets or sets whether concurrent drag and drop operations are enabled. + +## -property-value +True if concurrent drag and drop operations are enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_getforcurrentview_1363600702.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_getforcurrentview_1363600702.md index 81ae0c9a95..a3405f39fd 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_getforcurrentview_1363600702.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_getforcurrentview_1363600702.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.GetForCurrentView --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.GetForCurrentView ## -description Gets the core drag and drop manager associated with the currently visible application window. ## -returns The core drag and drop manager associated with the currently visible application window. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.GetForCurrentView + +## -description +Gets the core drag and drop manager associated with the currently visible application window. + +## -returns +The core drag and drop manager associated with the currently visible application window. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_targetrequested.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_targetrequested.md index 7c14615901..262377cd12 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_targetrequested.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragdropmanager_targetrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.TargetRequested --api-type: winrt event ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.TargetRequested ## -description Occurs when a drag and drop target is requested. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.TargetRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragDropManager.TargetRequested + +## -description +Occurs when a drag and drop target is requested. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo.md index e065243864..18e3a2be81 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo --api-type: winrt class ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo ## -description Gets information about an item being dragged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo + +## -description +Gets information about an item being dragged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md index 003d8444cb..b4811b01a2 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.AllowedOperations --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.AllowedOperations ## -description Gets the allowed [DataPackageOperations](../windows.applicationmodel.datatransfer/datapackageoperation.md) (none, move, copy, and/or link) for the drag and drop operation. ## -property-value The allowed operations. ## -remarks This property specifies the complete set of operations the source app wishes to allow in drag and drop scenarios. There can be zero or more flags. To get the requested default operation, use the [DataPackage.RequestedOperation](../windows.applicationmodel.datatransfer/datapackage_requestedoperation.md) property. Users can override this choices by using **SHIFT** and **CTRL** keys. In this case, inspect the key state to determine the operation the user selected. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.AllowedOperations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.AllowedOperations + +## -description +Gets the allowed [DataPackageOperations](../windows.applicationmodel.datatransfer/datapackageoperation.md) (none, move, copy, and/or link) for the drag and drop operation. + +## -property-value +The allowed operations. + +## -remarks +This property specifies the complete set of operations the source app wishes to allow in drag and drop scenarios. There can be zero or more flags. To get the requested default operation, use the [DataPackage.RequestedOperation](../windows.applicationmodel.datatransfer/datapackage_requestedoperation.md) property. + +Users can override this choices by using **SHIFT** and **CTRL** keys. In this case, inspect the key state to determine the operation the user selected. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_data.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_data.md index 4d64c494ed..46b6cef4d9 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_data.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Data --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Data ## -description Gets the [DataPackageView](../windows.applicationmodel.datatransfer/datapackageview.md) for the item being dragged. ## -property-value The [DataPackageView](../windows.applicationmodel.datatransfer/datapackageview.md) for the item being dragged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Data + +## -description +Gets the [DataPackageView](../windows.applicationmodel.datatransfer/datapackageview.md) for the item being dragged. + +## -property-value +The [DataPackageView](../windows.applicationmodel.datatransfer/datapackageview.md) for the item being dragged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_modifiers.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_modifiers.md index d6f5847853..bc7332dd27 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_modifiers.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_modifiers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Modifiers --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Modifiers ## -description Gets the modifiers for the item being dragged. ## -property-value The modifiers for the item being dragged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Modifiers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Modifiers + +## -description +Gets the modifiers for the item being dragged. + +## -property-value +The modifiers for the item being dragged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_position.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_position.md index 1bd6c086cf..27944d8b62 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_position.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Position --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Position ## -description Gets the position of the item being dragged. ## -property-value The position of the item being dragged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Position +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo.Position + +## -description +Gets the position of the item being dragged. + +## -property-value +The position of the item being dragged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation.md index 40d73b832f..e78eaff04c 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation --api-type: winrt class ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation ## -description Handles a drag and drop operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation + +## -description +Handles a drag and drop operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_allowedoperations.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_allowedoperations.md index 647e8890e5..299b243039 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_allowedoperations.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_allowedoperations.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.AllowedOperations --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.AllowedOperations ## -description Gets or sets the allowed [DataPackageOperations](../windows.applicationmodel.datatransfer/datapackageoperation.md) (none, move, copy, and/or link) for the drag and drop operation. ## -property-value The allowed operations. The default is **Copy** | **Move** | **Link**. ## -remarks Use this property to set the complete set of operations the source app wishes to allow in drag and drop scenarios. You can specify zero or more flags. To set a desired default operation, use the [DataPackage.RequestedOperation](../windows.applicationmodel.datatransfer/datapackage_requestedoperation.md) property. Users can override this choices by using **SHIFT** and **CTRL** keys. In this case, the target app must inspect the key state to determine the operation the user selected. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.AllowedOperations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.AllowedOperations + +## -description +Gets or sets the allowed [DataPackageOperations](../windows.applicationmodel.datatransfer/datapackageoperation.md) (none, move, copy, and/or link) for the drag and drop operation. + +## -property-value +The allowed operations. The default is **Copy** | **Move** | **Link**. + +## -remarks +Use this property to set the complete set of operations the source app wishes to allow in drag and drop scenarios. You can specify zero or more flags. To set a desired default operation, use the [DataPackage.RequestedOperation](../windows.applicationmodel.datatransfer/datapackage_requestedoperation.md) property. + +Users can override this choices by using **SHIFT** and **CTRL** keys. In this case, the target app must inspect the key state to determine the operation the user selected. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_coredragoperation_1221375020.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_coredragoperation_1221375020.md index 04b2ef7cdf..a53c9e19f1 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_coredragoperation_1221375020.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_coredragoperation_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.CoreDragOperation ## -description Initializes a new instance of the [CoreDragOperation](coredragoperation.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.CoreDragOperation + +## -description +Initializes a new instance of the [CoreDragOperation](coredragoperation.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_data.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_data.md index f4f8cf19bf..34d489e751 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_data.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.Data --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.Data ## -description Gets the [DataPackage](../windows.applicationmodel.datatransfer/datapackage.md) for the drag and drop operation. ## -property-value The [DataPackage](../windows.applicationmodel.datatransfer/datapackage.md) for the drag and drop operation ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.Data + +## -description +Gets the [DataPackage](../windows.applicationmodel.datatransfer/datapackage.md) for the drag and drop operation. + +## -property-value +The [DataPackage](../windows.applicationmodel.datatransfer/datapackage.md) for the drag and drop operation + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_draguicontentmode.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_draguicontentmode.md index d3e6f04ed0..4d6f0aa65b 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_draguicontentmode.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_draguicontentmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.DragUIContentMode --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.DragUIContentMode ## -description Gets or sets the content mode for the drag UI. ## -property-value The content mode for the drag UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.DragUIContentMode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.DragUIContentMode + +## -description +Gets or sets the content mode for the drag UI. + +## -property-value +The content mode for the drag UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_1812485985.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_1812485985.md index 93db3aa289..154015a23e 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_1812485985.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_1812485985.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Foundation.Point) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap ## -description Sets custom drag UI content using a software bitmap. ## -parameters ### -param softwareBitmap The custom UI drag content. ### -param anchorPoint The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50). ## -remarks ## -examples ## -see-also [SetDragUIContentFromSoftwareBitmap(SoftwareBitmap)](coredragoperation_setdraguicontentfromsoftwarebitmap_439174637.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap + +## -description +Sets custom drag UI content using a software bitmap. + +## -parameters +### -param softwareBitmap +The custom UI drag content. + +### -param anchorPoint +The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50). + +## -remarks + +## -examples + +## -see-also +[SetDragUIContentFromSoftwareBitmap(SoftwareBitmap)](coredragoperation_setdraguicontentfromsoftwarebitmap_439174637.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_439174637.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_439174637.md index 54e5d902c6..99be3ba0a2 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_439174637.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setdraguicontentfromsoftwarebitmap_439174637.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap ## -description Sets custom drag UI content using a software bitmap. ## -parameters ### -param softwareBitmap The custom UI drag content. ## -remarks ## -examples ## -see-also [SetDragUIContentFromSoftwareBitmap(SoftwareBitmap, Point)](coredragoperation_setdraguicontentfromsoftwarebitmap_1812485985.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetDragUIContentFromSoftwareBitmap + +## -description +Sets custom drag UI content using a software bitmap. + +## -parameters +### -param softwareBitmap +The custom UI drag content. + +## -remarks + +## -examples + +## -see-also +[SetDragUIContentFromSoftwareBitmap(SoftwareBitmap, Point)](coredragoperation_setdraguicontentfromsoftwarebitmap_1812485985.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setpointerid_923486150.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setpointerid_923486150.md index 86cbb66a4a..ce1b485f35 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setpointerid_923486150.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_setpointerid_923486150.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetPointerId(System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetPointerId ## -description Sets the pointer Id. ## -parameters ### -param pointerId The pointer Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetPointerId(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.SetPointerId + +## -description +Sets the pointer Id. + +## -parameters +### -param pointerId +The pointer Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_startasync_1931900819.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_startasync_1931900819.md index 3ff8f2278f..fe8df5eb6f 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_startasync_1931900819.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredragoperation_startasync_1931900819.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.StartAsync --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.StartAsync ## -description Starts the drag and drop operation. ## -returns The data package operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.StartAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragOperation.StartAsync + +## -description +Starts the drag and drop operation. + +## -returns +The data package operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride.md index f020b965c0..08ee88f8dc 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride --api-type: winrt class ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride ## -description Contains methods and properties for customizing the drag and drop UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride + +## -description +Contains methods and properties for customizing the drag and drop UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_caption.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_caption.md index 854ea7b994..06dbb4abd9 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_caption.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_caption.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Caption --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Caption ## -description Gets or sets the caption for the drag UI. ## -property-value The caption for the drag UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Caption +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Caption + +## -description +Gets or sets the caption for the drag UI. + +## -property-value +The caption for the drag UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_clear_556466.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_clear_556466.md index 9fa1090016..aff8d18fe3 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_clear_556466.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Clear --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Clear ## -description Clears all existing custom UI overrides. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Clear +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.Clear + +## -description +Clears all existing custom UI overrides. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscaptionvisible.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscaptionvisible.md index 590a83d671..aba03cdbd1 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscaptionvisible.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscaptionvisible.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsCaptionVisible --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsCaptionVisible ## -description Gets or sets if the caption for the drag UI is visible. ## -property-value True if the caption is visible; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsCaptionVisible +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsCaptionVisible + +## -description +Gets or sets if the caption for the drag UI is visible. + +## -property-value +True if the caption is visible; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscontentvisible.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscontentvisible.md index 2b81cbd789..720ceabdcd 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscontentvisible.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_iscontentvisible.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsContentVisible --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsContentVisible ## -description Gets or sets whether the drag content is visible. ## -property-value True if the drag content is visible; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsContentVisible +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsContentVisible + +## -description +Gets or sets whether the drag content is visible. + +## -property-value +True if the drag content is visible; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_isglyphvisible.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_isglyphvisible.md index 11af6974a0..9f8da74fd2 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_isglyphvisible.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_isglyphvisible.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsGlyphVisible --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsGlyphVisible ## -description Gets or sets whether the glyph is visible. ## -property-value True if the glyph is visible; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsGlyphVisible +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.IsGlyphVisible + +## -description +Gets or sets whether the glyph is visible. + +## -property-value +True if the glyph is visible; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_1475637163.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_1475637163.md index a369406872..becbb4cf88 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_1475637163.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_1475637163.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap ## -description Sets custom drag UI content using a software bitmap. ## -parameters ### -param softwareBitmap The custom drag UI content. ## -remarks ## -examples ## -see-also [SetContentFromSoftwareBitmap(SoftwareBitmap, Point)](coredraguioverride_setcontentfromsoftwarebitmap_567377191.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap + +## -description +Sets custom drag UI content using a software bitmap. + +## -parameters +### -param softwareBitmap +The custom drag UI content. + +## -remarks + +## -examples + +## -see-also +[SetContentFromSoftwareBitmap(SoftwareBitmap, Point)](coredraguioverride_setcontentfromsoftwarebitmap_567377191.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_567377191.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_567377191.md index ba1a864d81..f6c04653ea 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_567377191.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredraguioverride_setcontentfromsoftwarebitmap_567377191.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Foundation.Point) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap ## -description Sets custom drag UI content using a software bitmap. ## -parameters ### -param softwareBitmap The custom UI drag content. ### -param anchorPoint The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50). ## -remarks ## -examples ## -see-also [SetContentFromSoftwareBitmap(SoftwareBitmap)](coredraguioverride_setcontentfromsoftwarebitmap_1475637163.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride.SetContentFromSoftwareBitmap + +## -description +Sets custom drag UI content using a software bitmap. + +## -parameters +### -param softwareBitmap +The custom UI drag content. + +### -param anchorPoint +The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50). + +## -remarks + +## -examples + +## -see-also +[SetContentFromSoftwareBitmap(SoftwareBitmap)](coredraguioverride_setcontentfromsoftwarebitmap_1475637163.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs.md index bc658827a3..e31ea149c3 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs ## -description Provides the ability to set the target of a drag and drop operation when a target is requested. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs + +## -description +Provides the ability to set the target of a drag and drop operation when a target is requested. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs_settarget_349302165.md b/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs_settarget_349302165.md index 7e03110780..7b7f90608f 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs_settarget_349302165.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/coredropoperationtargetrequestedeventargs_settarget_349302165.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs.SetTarget(Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs.SetTarget ## -description Sets the target of the drag and drop operation. ## -parameters ### -param target The target of the drag and drop operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs.SetTarget(Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDropOperationTargetRequestedEventArgs.SetTarget + +## -description +Sets the target of the drag and drop operation. + +## -parameters +### -param target +The target of the drag and drop operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_dropasync.md b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_dropasync.md index 498e6f010a..cd5dd1746b 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_dropasync.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_dropasync.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.DropAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.DropAsync ## -description Called when a dragged item is dropped. ## -parameters ### -param dragInfo The core drag information. ## -returns The data package operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.DropAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.DropAsync + +## -description +Called when a dragged item is dropped. + +## -parameters +### -param dragInfo +The core drag information. + +## -returns +The data package operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_enterasync.md b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_enterasync.md index 2d58404594..9a938a90c4 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_enterasync.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_enterasync.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.EnterAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo,Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.EnterAsync ## -description Called when the dragged item enters the drop area. ## -parameters ### -param dragInfo The core drag information. ### -param dragUIOverride Overrides to default the drag UI. ## -returns When this method completes, it returns the data package operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.EnterAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo,Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.EnterAsync + +## -description +Called when the dragged item enters the drop area. + +## -parameters +### -param dragInfo +The core drag information. + +### -param dragUIOverride +Overrides to default the drag UI. + +## -returns +When this method completes, it returns the data package operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_leaveasync.md b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_leaveasync.md index 077ab6acd9..8d544d9f24 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_leaveasync.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_leaveasync.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.LeaveAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.LeaveAsync ## -description Called when a dragged item leaves the target drop area. ## -parameters ### -param dragInfo The core drag information. ## -returns This method does not return an object or value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.LeaveAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.LeaveAsync + +## -description +Called when a dragged item leaves the target drop area. + +## -parameters +### -param dragInfo +The core drag information. + +## -returns +This method does not return an object or value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_overasync.md b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_overasync.md index e1f13c6588..a870a1d17e 100644 --- a/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_overasync.md +++ b/windows.applicationmodel.datatransfer.dragdrop.core/icoredropoperationtarget_overasync.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.OverAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo,Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.OverAsync ## -description Called when the dragged item is over the drop area. ## -parameters ### -param dragInfo The core drag information. ### -param dragUIOverride Overrides to default the drag UI. ## -returns When this method completes, it returns the data package operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.OverAsync(Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragInfo,Windows.ApplicationModel.DataTransfer.DragDrop.Core.CoreDragUIOverride) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DragDrop.Core.ICoreDropOperationTarget.OverAsync + +## -description +Called when the dragged item is over the drop area. + +## -parameters +### -param dragInfo +The core drag information. + +### -param dragUIOverride +Overrides to default the drag UI. + +## -returns +When this method completes, it returns the data package operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/quicklink_id.md b/windows.applicationmodel.datatransfer.sharetarget/quicklink_id.md index 35fe7818ae..068026356d 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/quicklink_id.md +++ b/windows.applicationmodel.datatransfer.sharetarget/quicklink_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Id --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Id ## -description Specifies an ID for the QuickLink. Your app receives this ID when the user selects its QuickLink. You can use this ID to further customize the sharing process for the user. ## -property-value Specifies the ID for the QuickLink. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Id + +## -description +Specifies an ID for the QuickLink. Your app receives this ID when the user selects its QuickLink. You can use this ID to further customize the sharing process for the user. + +## -property-value +Specifies the ID for the QuickLink. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/quicklink_quicklink_1221375020.md b/windows.applicationmodel.datatransfer.sharetarget/quicklink_quicklink_1221375020.md index 9fc1c84be4..438ff35438 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/quicklink_quicklink_1221375020.md +++ b/windows.applicationmodel.datatransfer.sharetarget/quicklink_quicklink_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.QuickLink ## -description Creates a new instance of a QuickLink object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.QuickLink + +## -description +Creates a new instance of a QuickLink object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/quicklink_supporteddataformats.md b/windows.applicationmodel.datatransfer.sharetarget/quicklink_supporteddataformats.md index 7130eaf6de..6bbf70f16e 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/quicklink_supporteddataformats.md +++ b/windows.applicationmodel.datatransfer.sharetarget/quicklink_supporteddataformats.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedDataFormats --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedDataFormats ## -description An array of strings that specify the data formats supported by the QuickLink app. The system shows the QuickLink only when the data that a user wants to share matches a format in this array. ## -property-value An array of format ids that specify the data formats supported by the QuickLink app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedDataFormats +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedDataFormats + +## -description +An array of strings that specify the data formats supported by the QuickLink app. The system shows the QuickLink only when the data that a user wants to share matches a format in this array. + +## -property-value +An array of format ids that specify the data formats supported by the QuickLink app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/quicklink_supportedfiletypes.md b/windows.applicationmodel.datatransfer.sharetarget/quicklink_supportedfiletypes.md index 03d1f556a5..37f4f89066 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/quicklink_supportedfiletypes.md +++ b/windows.applicationmodel.datatransfer.sharetarget/quicklink_supportedfiletypes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedFileTypes --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedFileTypes ## -description An array of strings that specify the file types supported by a QuickLink app. The system shows the QuickLink only when the data that a user wants to share contains file items, and the file extensions for those file items match a file type in this array. ## -property-value An array of file extensions that specify the file types supported by the QuickLinks app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedFileTypes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.SupportedFileTypes + +## -description +An array of strings that specify the file types supported by a QuickLink app. The system shows the QuickLink only when the data that a user wants to share contains file items, and the file extensions for those file items match a file type in this array. + +## -property-value +An array of file extensions that specify the file types supported by the QuickLinks app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/quicklink_thumbnail.md b/windows.applicationmodel.datatransfer.sharetarget/quicklink_thumbnail.md index 645764272e..9e26f50d20 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/quicklink_thumbnail.md +++ b/windows.applicationmodel.datatransfer.sharetarget/quicklink_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Thumbnail --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Thumbnail ## -description Specifies a thumbnail image for the QuickLink. The system displays this image when the user is presented with a list of possible apps to share content with. ## -property-value Contains the thumbnail image to use with the QuickLink. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Thumbnail + +## -description +Specifies a thumbnail image for the QuickLink. The system displays this image when the user is presented with a list of possible apps to share content with. + +## -property-value +Contains the thumbnail image to use with the QuickLink. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/quicklink_title.md b/windows.applicationmodel.datatransfer.sharetarget/quicklink_title.md index 74dacff0c2..587a4a0888 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/quicklink_title.md +++ b/windows.applicationmodel.datatransfer.sharetarget/quicklink_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Title --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Title ## -description Specifies the title of a QuickLink. The system displays this info when the user is presented with a list of possible apps to share content with. ## -property-value Specifies the title of the QuickLink. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink.Title + +## -description +Specifies the title of a QuickLink. The system displays this info when the user is presented with a list of possible apps to share content with. + +## -property-value +Specifies the title of the QuickLink. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_data.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_data.md index 8591c6b3e2..ffc90222e5 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_data.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_data.md @@ -1,27 +1,27 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Data --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Data - -## -description -Contains a DataPackage object with the data that the user wants to share. - -## -property-value -Contains the data that the user wants to share. - -## -remarks - -## -examples -The following example shows how to get the [DataPackageView](../windows.applicationmodel.datatransfer/datapackageview.md) object from the **data** property. To use the code in this example, add event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -[!code-js[ShareTargetBasic](../windows.applicationmodel.datatransfer.sharetarget/code/ShareMain/javascript/ShareMain/ShareMain/js/target.js#SnippetShareTargetBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Data + +## -description +Contains a DataPackage object with the data that the user wants to share. + +## -property-value +Contains the data that the user wants to share. + +## -remarks + +## -examples +The following example shows how to get the [DataPackageView](../windows.applicationmodel.datatransfer/datapackageview.md) object from the **data** property. To use the code in this example, add event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +[!code-js[ShareTargetBasic](../windows.applicationmodel.datatransfer.sharetarget/code/ShareMain/javascript/ShareMain/ShareMain/js/target.js#SnippetShareTargetBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_dismissui_451152495.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_dismissui_451152495.md index cf098e1e70..d9d78b979d 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_dismissui_451152495.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_dismissui_451152495.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.DismissUI --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.DismissUI ## -description Closes the share pane. ## -remarks Call the [DismissUI](shareoperation_dismissui.md) method to dismiss the share pane programmatically. Calling [DismissUI](shareoperation_dismissui.md) is similar to the user dismissing the share pane by tapping away from it. If the share operation takes a long time, the app continues to run in the background. If the operation isn't long-running, it has 10 seconds to run before being terminated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.DismissUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.DismissUI + +## -description +Closes the share pane. + +## -remarks +Call the [DismissUI](shareoperation_dismissui.md) method to dismiss the share pane programmatically. Calling [DismissUI](shareoperation_dismissui.md) is similar to the user dismissing the share pane by tapping away from it. If the share operation takes a long time, the app continues to run in the background. If the operation isn't long-running, it has 10 seconds to run before being terminated. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_quicklinkid.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_quicklinkid.md index 2a70c0413d..e1a2d3cba7 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_quicklinkid.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_quicklinkid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.QuickLinkId --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.QuickLinkId ## -description A string that contains the ID of a QuickLink. ## -property-value The ID of the QuickLink. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.QuickLinkId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.QuickLinkId + +## -description +A string that contains the ID of a QuickLink. + +## -property-value +The ID of the QuickLink. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_removethisquicklink_233095702.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_removethisquicklink_233095702.md index 4b9588f3c7..f1c70d21e5 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_removethisquicklink_233095702.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_removethisquicklink_233095702.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.RemoveThisQuickLink --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.RemoveThisQuickLink ## -description Removes the QuickLink from the list of QuickLinks that are available to the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.RemoveThisQuickLink +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.RemoveThisQuickLink + +## -description +Removes the QuickLink from the list of QuickLinks that are available to the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_1121471021.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_1121471021.md index 0fe39e89a9..a054c11b94 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_1121471021.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_1121471021.md @@ -1,26 +1,26 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted - -## -description -Specifies that the sharing operation is complete. - -## -remarks -When your app acts as a target for a share operation, it should call **reportComplete** after it has processed the data being shared. This method closes the app window and returns the user to the source app. - -## -examples -The following example shows how a target app might respond to a share operation. Notice the use of **reportComplete** when the target app has finished processing the data. - - - -[!code-js[ShareTargetBasic](../windows.applicationmodel.datatransfer.sharetarget/code/ShareMain/javascript/ShareMain/ShareMain/js/target.js#SnippetShareTargetBasic)] - -## -see-also -[ReportCompleted(QuickLink)](shareoperation_reportcompleted_840474235.md) +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted + +## -description +Specifies that the sharing operation is complete. + +## -remarks +When your app acts as a target for a share operation, it should call **reportComplete** after it has processed the data being shared. This method closes the app window and returns the user to the source app. + +## -examples +The following example shows how a target app might respond to a share operation. Notice the use of **reportComplete** when the target app has finished processing the data. + + + +[!code-js[ShareTargetBasic](../windows.applicationmodel.datatransfer.sharetarget/code/ShareMain/javascript/ShareMain/ShareMain/js/target.js#SnippetShareTargetBasic)] + +## -see-also +[ReportCompleted(QuickLink)](shareoperation_reportcompleted_840474235.md) diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_840474235.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_840474235.md index b1c2a8b9ad..5d60f5e597 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_840474235.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportcompleted_840474235.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted(Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted ## -description Specifies that the sharing operation is complete. A QuickLink that the system can save as a shortcut for future sharing operations is included. ## -parameters ### -param quicklink A QuickLink object that the system saves as a shortcut for future sharing operations. ## -remarks ## -examples ## -see-also [ReportCompleted](shareoperation_reportcompleted_1121471021.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted(Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportCompleted + +## -description +Specifies that the sharing operation is complete. A QuickLink that the system can save as a shortcut for future sharing operations is included. + +## -parameters +### -param quicklink +A QuickLink object that the system saves as a shortcut for future sharing operations. + +## -remarks + +## -examples + +## -see-also +[ReportCompleted](shareoperation_reportcompleted_1121471021.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportdataretrieved_1712059569.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportdataretrieved_1712059569.md index e0ea6ddba5..b494918d49 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportdataretrieved_1712059569.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportdataretrieved_1712059569.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportDataRetrieved --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportDataRetrieved ## -description Specifies that the app has acquired the content that the user wants to share. ## -remarks > This method does nothing when called on Windows Phone 8.1. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportDataRetrieved +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportDataRetrieved + +## -description +Specifies that the app has acquired the content that the user wants to share. + +## -remarks +> This method does nothing when called on Windows Phone 8.1. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reporterror_1034694985.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reporterror_1034694985.md index 43d6f8c2b8..75db21a1ff 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reporterror_1034694985.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reporterror_1034694985.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportError(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportError ## -description Specifies that an error occurred during the sharing operation. ## -parameters ### -param value Specifies the error message. The system displays this message to the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportError(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportError + +## -description +Specifies that an error occurred during the sharing operation. + +## -parameters +### -param value +Specifies the error message. The system displays this message to the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportstarted_1768591963.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportstarted_1768591963.md index 11c2e92b7d..6c9c504e30 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportstarted_1768591963.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportstarted_1768591963.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportStarted --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportStarted ## -description Specifies that the app has started to acquire the content that the user wants to share. ## -remarks > [!NOTE] > This method does nothing when called on Windows Phone 8.1. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportStarted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportStarted + +## -description +Specifies that the app has started to acquire the content that the user wants to share. + +## -remarks +> [!NOTE] +> This method does nothing when called on Windows Phone 8.1. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportsubmittedbackgroundtask_1441769795.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportsubmittedbackgroundtask_1441769795.md index fe15c577f8..095d3894fb 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportsubmittedbackgroundtask_1441769795.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_reportsubmittedbackgroundtask_1441769795.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportSubmittedBackgroundTask --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportSubmittedBackgroundTask ## -description Specifies that the app has requested that the system allow the sharing operation to run as a background task. ## -remarks > [!NOTE] > This method does nothing when called on Windows Phone 8.1. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportSubmittedBackgroundTask +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.ReportSubmittedBackgroundTask + +## -description +Specifies that the app has requested that the system allow the sharing operation to run as a background task. + +## -remarks +> [!NOTE] +> This method does nothing when called on Windows Phone 8.1. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/clipboard_clear_556466.md b/windows.applicationmodel.datatransfer/clipboard_clear_556466.md index fa0ed71259..305c9bf40b 100644 --- a/windows.applicationmodel.datatransfer/clipboard_clear_556466.md +++ b/windows.applicationmodel.datatransfer/clipboard_clear_556466.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.Clear --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.Clipboard.Clear ## -description Removes all data from the Clipboard. ## -remarks Use the [Clear](clipboard_clear.md) method when you want to cancel an action that put data on the Clipboard. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.Clear +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.Clipboard.Clear + +## -description +Removes all data from the Clipboard. + +## -remarks +Use the [Clear](clipboard_clear.md) method when you want to cancel an action that put data on the Clipboard. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/clipboard_contentchanged.md b/windows.applicationmodel.datatransfer/clipboard_contentchanged.md index d367ec8003..83896158c3 100644 --- a/windows.applicationmodel.datatransfer/clipboard_contentchanged.md +++ b/windows.applicationmodel.datatransfer/clipboard_contentchanged.md @@ -1,27 +1,27 @@ ---- --api-id: E:Windows.ApplicationModel.DataTransfer.Clipboard.ContentChanged --api-type: winrt event ---- - - - -# Windows.ApplicationModel.DataTransfer.Clipboard.ContentChanged - -## -description -Occurs when the data stored in the Clipboard changes. - -## -remarks -This event is helpful in situations when your app contains logic that varies depending on the contents on the clipboard. For example, your app might include a **Paste** button, which is disabled unless the Clipboard contains content. - -## -examples -The following example shows how to track changes to the [Clipboard](clipboard.md). The first code snippet registers a handler for the [ContentChanged](clipboard_contentchanged.md) event. The second code snippet shows the event handler, which enables the app's paste command if the [Clipboard](clipboard.md) contains a bitmap. - - - -[!code-js[TrackClipboardChanges1](../windows.applicationmodel.datatransfer/code/ClipBoardBeta/js/default.js#SnippetTrackClipboardChanges1)] - -[!code-js[TrackClipboardChanges2](../windows.applicationmodel.datatransfer/code/ClipBoardBeta/js/default.js#SnippetTrackClipboardChanges2)] - -## -see-also +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.Clipboard.ContentChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.Clipboard.ContentChanged + +## -description +Occurs when the data stored in the Clipboard changes. + +## -remarks +This event is helpful in situations when your app contains logic that varies depending on the contents on the clipboard. For example, your app might include a **Paste** button, which is disabled unless the Clipboard contains content. + +## -examples +The following example shows how to track changes to the [Clipboard](clipboard.md). The first code snippet registers a handler for the [ContentChanged](clipboard_contentchanged.md) event. The second code snippet shows the event handler, which enables the app's paste command if the [Clipboard](clipboard.md) contains a bitmap. + + + +[!code-js[TrackClipboardChanges1](../windows.applicationmodel.datatransfer/code/ClipBoardBeta/js/default.js#SnippetTrackClipboardChanges1)] + +[!code-js[TrackClipboardChanges2](../windows.applicationmodel.datatransfer/code/ClipBoardBeta/js/default.js#SnippetTrackClipboardChanges2)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/clipboard_flush_1964454777.md b/windows.applicationmodel.datatransfer/clipboard_flush_1964454777.md index defcc09733..6dadbb3269 100644 --- a/windows.applicationmodel.datatransfer/clipboard_flush_1964454777.md +++ b/windows.applicationmodel.datatransfer/clipboard_flush_1964454777.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.Flush --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.Clipboard.Flush ## -description Adds the content to the Clipboard and releases the [DataPackage](datapackage.md) object from the source app. This method allows the content to remain available after the application shuts down. ## -remarks When you call the [Flush](clipboard_flush.md) method, the content of the [DataPackage](datapackage.md) is added to the Clipboard and then released from the source app. This action makes the content available on the Clipboard even after the source app is no longer available. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.Flush +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.Clipboard.Flush + +## -description +Adds the content to the Clipboard and releases the [DataPackage](datapackage.md) object from the source app. This method allows the content to remain available after the application shuts down. + +## -remarks +When you call the [Flush](clipboard_flush.md) method, the content of the [DataPackage](datapackage.md) is added to the Clipboard and then released from the source app. This action makes the content available on the Clipboard even after the source app is no longer available. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/clipboard_getcontent_856587321.md b/windows.applicationmodel.datatransfer/clipboard_getcontent_856587321.md index 4eeff9985a..90681751f0 100644 --- a/windows.applicationmodel.datatransfer/clipboard_getcontent_856587321.md +++ b/windows.applicationmodel.datatransfer/clipboard_getcontent_856587321.md @@ -1,26 +1,26 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.GetContent --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.Clipboard.GetContent - -## -description -Gets the current content that is stored in the clipboard object. - -## -returns -Contains the content of the Clipboard. - -## -remarks -If the **GetContent** call is successful, you can use the [DataPackageView](datapackageview.md) it returns to get information such as the file types it supports and any properties that the source app assigned through the [DataPackagePropertySet](datapackagepropertyset.md) class. - -## -examples - - -[!code-js[GetClipboardContent](../windows.applicationmodel.datatransfer/code/ClipBoardBeta/js/default.js#SnippetGetClipboardContent)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.GetContent +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.Clipboard.GetContent + +## -description +Gets the current content that is stored in the clipboard object. + +## -returns +Contains the content of the Clipboard. + +## -remarks +If the **GetContent** call is successful, you can use the [DataPackageView](datapackageview.md) it returns to get information such as the file types it supports and any properties that the source app assigned through the [DataPackagePropertySet](datapackagepropertyset.md) class. + +## -examples + + +[!code-js[GetClipboardContent](../windows.applicationmodel.datatransfer/code/ClipBoardBeta/js/default.js#SnippetGetClipboardContent)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/clipboard_setcontent_1209662052.md b/windows.applicationmodel.datatransfer/clipboard_setcontent_1209662052.md index ae73286989..ae8c3a27a4 100644 --- a/windows.applicationmodel.datatransfer/clipboard_setcontent_1209662052.md +++ b/windows.applicationmodel.datatransfer/clipboard_setcontent_1209662052.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.SetContent(Windows.ApplicationModel.DataTransfer.DataPackage) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.Clipboard.SetContent ## -description Sets the current content that is stored in the clipboard object. ## -parameters ### -param content Contains the content of the clipboard. If **NULL**, the clipboard is emptied. ## -remarks Use this method after creating and defining a [DataPackage](datapackage.md) with the data you want to put on the clipboard. Call this method only when the application is in the foreground, or when a debugger is attached. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.Clipboard.SetContent(Windows.ApplicationModel.DataTransfer.DataPackage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.Clipboard.SetContent + +## -description +Sets the current content that is stored in the clipboard object. + +## -parameters +### -param content +Contains the content of the clipboard. If **NULL**, the clipboard is emptied. + +## -remarks +Use this method after creating and defining a [DataPackage](datapackage.md) with the data you want to put on the clipboard. Call this method only when the application is in the foreground, or when a debugger is attached. + +## -examples + + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_datapackage_1221375020.md b/windows.applicationmodel.datatransfer/datapackage_datapackage_1221375020.md index 710817ae14..8006a5e87d 100644 --- a/windows.applicationmodel.datatransfer/datapackage_datapackage_1221375020.md +++ b/windows.applicationmodel.datatransfer/datapackage_datapackage_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.DataPackage ## -description Constructor that creates a new [DataPackage](datapackage.md). ## -remarks In general, the system handles the destruction of a [DataPackage](datapackage.md) object. Your app should not have to handle this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.DataPackage + +## -description +Constructor that creates a new [DataPackage](datapackage.md). + +## -remarks +In general, the system handles the destruction of a [DataPackage](datapackage.md) object. Your app should not have to handle this event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_destroyed.md b/windows.applicationmodel.datatransfer/datapackage_destroyed.md index 717b8c22b7..d127be0591 100644 --- a/windows.applicationmodel.datatransfer/datapackage_destroyed.md +++ b/windows.applicationmodel.datatransfer/datapackage_destroyed.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.DataTransfer.DataPackage.Destroyed --api-type: winrt event ---- # Windows.ApplicationModel.DataTransfer.DataPackage.Destroyed ## -description Occurs when the [DataPackage](datapackage.md) is destroyed. ## -remarks In general, the system handles the destruction of a [DataPackage](datapackage.md) object. Your app should not have to handle this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataPackage.Destroyed +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.Destroyed + +## -description +Occurs when the [DataPackage](datapackage.md) is destroyed. + +## -remarks +In general, the system handles the destruction of a [DataPackage](datapackage.md) object. Your app should not have to handle this event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_getview_37498667.md b/windows.applicationmodel.datatransfer/datapackage_getview_37498667.md index cf64f8ac6e..f8542d723a 100644 --- a/windows.applicationmodel.datatransfer/datapackage_getview_37498667.md +++ b/windows.applicationmodel.datatransfer/datapackage_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.GetView --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.GetView ## -description Returns a [DataPackageView](datapackageview.md) object. This object is a read-only copy of the [DataPackage](datapackage.md) object. ## -returns The object that is a read-only copy of the [DataPackage](datapackage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.GetView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.GetView + +## -description +Returns a [DataPackageView](datapackageview.md) object. This object is a read-only copy of the [DataPackage](datapackage.md) object. + +## -returns +The object that is a read-only copy of the [DataPackage](datapackage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_operationcompleted.md b/windows.applicationmodel.datatransfer/datapackage_operationcompleted.md index 7a4c6cd581..8b23ea5993 100644 --- a/windows.applicationmodel.datatransfer/datapackage_operationcompleted.md +++ b/windows.applicationmodel.datatransfer/datapackage_operationcompleted.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.DataTransfer.DataPackage.OperationCompleted --api-type: winrt event ---- # Windows.ApplicationModel.DataTransfer.DataPackage.OperationCompleted ## -description Occurs when a paste operation is completed. ## -remarks This event occurs when a user or program pastes content from the Clipboard. If your app is using the [DataPackage](datapackage.md) for share operations, you do not have to handle this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataPackage.OperationCompleted +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.OperationCompleted + +## -description +Occurs when a paste operation is completed. + +## -remarks +This event occurs when a user or program pastes content from the Clipboard. If your app is using the [DataPackage](datapackage.md) for share operations, you do not have to handle this event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_properties.md b/windows.applicationmodel.datatransfer/datapackage_properties.md index 9233969e83..9efe5d5aa4 100644 --- a/windows.applicationmodel.datatransfer/datapackage_properties.md +++ b/windows.applicationmodel.datatransfer/datapackage_properties.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.Properties --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackage.Properties ## -description Allows you to get and set properties like the title of the content being shared. ## -property-value A collection of properties that describe the data contained in a [DataPackage.](datapackage.md) ## -remarks In addition to the content being shared, each instance of a [DataPackage](datapackage.md) object supports a set of properties. Target apps can use these properties to learn more about the content of the [DataPackage](datapackage.md). Examples of common properties include [thumbnail](datapackagepropertyset_thumbnail.md) images, [title](datapackagepropertyset_title.md), and [file types](datapackagepropertyset_filetypes.md). This property contains an instance of the [DataPackagePropertySet](datapackagepropertyset.md) class. This class supports several properties by default. This class also supports custom properties through its [Insert](datapackagepropertyset_insert.md) and [Lookup](datapackagepropertyset_lookup.md) methods. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.Properties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.Properties + +## -description +Allows you to get and set properties like the title of the content being shared. + +## -property-value +A collection of properties that describe the data contained in a [DataPackage.](datapackage.md) + +## -remarks +In addition to the content being shared, each instance of a [DataPackage](datapackage.md) object supports a set of properties. Target apps can use these properties to learn more about the content of the [DataPackage](datapackage.md). Examples of common properties include [thumbnail](datapackagepropertyset_thumbnail.md) images, [title](datapackagepropertyset_title.md), and [file types](datapackagepropertyset_filetypes.md). + +This property contains an instance of the [DataPackagePropertySet](datapackagepropertyset.md) class. This class supports several properties by default. This class also supports custom properties through its [Insert](datapackagepropertyset_insert.md) and [Lookup](datapackagepropertyset_lookup.md) methods. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_requestedoperation.md b/windows.applicationmodel.datatransfer/datapackage_requestedoperation.md index efb45ba195..df91bab02b 100644 --- a/windows.applicationmodel.datatransfer/datapackage_requestedoperation.md +++ b/windows.applicationmodel.datatransfer/datapackage_requestedoperation.md @@ -1,3 +1,52 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.RequestedOperation --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackage.RequestedOperation ## -description Specifies the [DataPackageOperation](datapackageoperation.md) (none, move, copy, or link) for the operation. ## -property-value The operation requested by the source app. ## -remarks This property specifies the operation the consumer of a data package should perform in clipboard or drag and drop scenarios. The supported options are specified in the [DataPackageOperation](datapackageoperation.md) enumeration. When implementing clipboard functionality, [DataPackageOperation.Move](datapackageoperation.md) corresponds to the "Cut" command and [DataPackageOperation.Copy](datapackageoperation.md) to "Copy" command. It is the target of the operation's responsibility to respect this value and report that they performed a cut or copy by calling [DataPackageView.ReportOperationComplete](datapackageview_reportoperationcompleted.md) with the appropriate value. In drag and drop scenarios, [CoreDragOperation.AllowedOperations](../windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md) should specify the complete set of operations the source allows, and [DataPackage.RequestedOperation](datapackage_requestedoperation.md) should specify the source's desired default. Users can override this choices by using **SHIFT** and **CTRL** keys. Target apps must inspect the key state to determine the operation the user has selected. > [!NOTE] > [CoreDragOperation.AllowedOperations](../windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md) is not supported in XAML. To specify more than one allowed operation in XAML, pass multiple flags to the [DataPackage.RequestedOperation](datapackage_requestedoperation.md) property instead. If you do, you should not set [CoreDragOperation.AllowedOperations](../windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md) elsewhere. Doing so will throw an exception and reset the specified flags of [DataPackage.RequestedOperation](datapackage_requestedoperation.md) to one. Normally, [DataPackage.RequestedOperation](datapackage_requestedoperation.md) property should specify only a single operation. However, in some interop scenarios (such as copying between a Universal Windows Platform (UWP) app and File Explorer), it can contain more. In this case, the target app should select the best operation (assuming keyboard modifiers have not overridden that choice). You do not need this property for sharing operations. ## -examples ```csharp // Request a copy operation datapackage.RequestedOperation = DataPackageOperation.Copy; // find what the requested operation is DataPackageOperation operation = dataPackageView.RequestedOperation; ``` ```javascript // find out what the requested operation is var operation = dataPackage.requestedOperation; // Request a copy operation from targets that support different file operations, like Windows Explorer dataPackage.requestedOperation = Windows.ApplicationModel.DataTransfer.DataPackageOperation.copy; ``` ## -see-also [DataPackageOperation](datapackageoperation.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.RequestedOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.RequestedOperation + +## -description +Specifies the [DataPackageOperation](datapackageoperation.md) (none, move, copy, or link) for the operation. + +## -property-value +The operation requested by the source app. + +## -remarks +This property specifies the operation the consumer of a data package should perform in clipboard or drag and drop scenarios. The supported options are specified in the [DataPackageOperation](datapackageoperation.md) enumeration. + +When implementing clipboard functionality, [DataPackageOperation.Move](datapackageoperation.md) corresponds to the "Cut" command and [DataPackageOperation.Copy](datapackageoperation.md) to "Copy" command. It is the target of the operation's responsibility to respect this value and report that they performed a cut or copy by calling [DataPackageView.ReportOperationComplete](datapackageview_reportoperationcompleted.md) with the appropriate value. + +In drag and drop scenarios, [CoreDragOperation.AllowedOperations](../windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md) should specify the complete set of operations the source allows, and [DataPackage.RequestedOperation](datapackage_requestedoperation.md) should specify the source's desired default. Users can override this choices by using **SHIFT** and **CTRL** keys. Target apps must inspect the key state to determine the operation the user has selected. + +> [!NOTE] +> [CoreDragOperation.AllowedOperations](../windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md) is not supported in XAML. To specify more than one allowed operation in XAML, pass multiple flags to the [DataPackage.RequestedOperation](datapackage_requestedoperation.md) property instead. If you do, you should not set [CoreDragOperation.AllowedOperations](../windows.applicationmodel.datatransfer.dragdrop.core/coredraginfo_allowedoperations.md) elsewhere. Doing so will throw an exception and reset the specified flags of [DataPackage.RequestedOperation](datapackage_requestedoperation.md) to one. + +Normally, [DataPackage.RequestedOperation](datapackage_requestedoperation.md) property should specify only a single operation. However, in some interop scenarios (such as copying between a Universal Windows Platform (UWP) app and File Explorer), it can contain more. In this case, the target app should select the best operation (assuming keyboard modifiers have not overridden that choice). + +You do not need this property for sharing operations. + +## -examples +```csharp +// Request a copy operation +datapackage.RequestedOperation = DataPackageOperation.Copy; + +// find what the requested operation is +DataPackageOperation operation = dataPackageView.RequestedOperation; +``` + +```javascript +// find out what the requested operation is +var operation = dataPackage.requestedOperation; + +// Request a copy operation from targets that support different file operations, like Windows Explorer +dataPackage.requestedOperation = Windows.ApplicationModel.DataTransfer.DataPackageOperation.copy; +``` + + + +## -see-also +[DataPackageOperation](datapackageoperation.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackage_resourcemap.md b/windows.applicationmodel.datatransfer/datapackage_resourcemap.md index d1d30bfe5e..875c589473 100644 --- a/windows.applicationmodel.datatransfer/datapackage_resourcemap.md +++ b/windows.applicationmodel.datatransfer/datapackage_resourcemap.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap - -## -description -Maps a URI to a file. Used to ensure that referenced content (such as an image) in HTML content is added to the [DataPackage](datapackage.md). - -## -property-value -Specifies a name/value pair that specifies the an HTML path with a corresponding [StreamReference](../windows.storage.streams/randomaccessstreamreference.md) object. - -## -remarks -HTML content often contains references to other files. The most common example is an img tag that refers to a specific file. To ensure that the image is sent with the rest of the HTML content, you need to use `ResourceMap`, which maps the URI string to the actual data. You can learn more about this in [How to share HTML](http://msdn.microsoft.com/library/95a3d2a1-e188-4bd9-bace-d401d2d14ca2). - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap + +## -description +Maps a URI to a file. Used to ensure that referenced content (such as an image) in HTML content is added to the [DataPackage](datapackage.md). + +## -property-value +Specifies a name/value pair that specifies the an HTML path with a corresponding [StreamReference](../windows.storage.streams/randomaccessstreamreference.md) object. + +## -remarks +HTML content often contains references to other files. The most common example is an img tag that refers to a specific file. To ensure that the image is sent with the rest of the HTML content, you need to use `ResourceMap`, which maps the URI string to the actual data. You can learn more about this in [How to share HTML](http://msdn.microsoft.com/library/95a3d2a1-e188-4bd9-bace-d401d2d14ca2). + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setapplicationlink_1143215413.md b/windows.applicationmodel.datatransfer/datapackage_setapplicationlink_1143215413.md index 021ec5b97a..8addb644ce 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setapplicationlink_1143215413.md +++ b/windows.applicationmodel.datatransfer/datapackage_setapplicationlink_1143215413.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetApplicationLink(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.SetApplicationLink ## -description Sets the application link that a [DataPackage](datapackage.md) contains. ## -parameters ### -param value A Uniform Resource Identifier (URI) with a scheme that isn't **http** or **https** that's handled by the source app. ## -remarks Whenever possible, you should set this property. This Uniform Resource Identifier (URI) represents a deep link that takes the user back to the currently displayed content. A source app provides a value for this property, and a target app reads the value. Use this property to indicate the source of the shared content. The scheme of this Uniform Resource Identifier (URI) must not be **http** or **https**. The app sharing this Uniform Resource Identifier (URI) must be capable of being the default handler, although it may not be set as the default handler. ## -examples ## -see-also [GetApplicationLinkAsync](datapackageview_getapplicationlinkasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetApplicationLink(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetApplicationLink + +## -description +Sets the application link that a [DataPackage](datapackage.md) contains. + +## -parameters +### -param value +A Uniform Resource Identifier (URI) with a scheme that isn't **http** or **https** that's handled by the source app. + +## -remarks +Whenever possible, you should set this property. This Uniform Resource Identifier (URI) represents a deep link that takes the user back to the currently displayed content. A source app provides a value for this property, and a target app reads the value. Use this property to indicate the source of the shared content. + +The scheme of this Uniform Resource Identifier (URI) must not be **http** or **https**. The app sharing this Uniform Resource Identifier (URI) must be capable of being the default handler, although it may not be set as the default handler. + +## -examples + +## -see-also +[GetApplicationLinkAsync](datapackageview_getapplicationlinkasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md b/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md index 147f1c14b5..c1e0d310b4 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md +++ b/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap(Windows.Storage.Streams.RandomAccessStreamReference) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap - -## -description -Sets the bitmap image contained in the [DataPackage](datapackage.md). - -## -parameters -### -param value -A stream that contains the bitmap image. - -## -remarks -This method sets the value for [StandardFormats.Bitmap](standarddataformats_bitmap.md). - -Bitmap is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. - -## -examples -The following example uses the **setBitmap** method to share an image with a target app. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap(Windows.Storage.Streams.RandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap + +## -description +Sets the bitmap image contained in the [DataPackage](datapackage.md). + +## -parameters +### -param value +A stream that contains the bitmap image. + +## -remarks +This method sets the value for [StandardFormats.Bitmap](standarddataformats_bitmap.md). + +Bitmap is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. + +## -examples +The following example uses the **setBitmap** method to share an image with a target app. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setdata_2074524277.md b/windows.applicationmodel.datatransfer/datapackage_setdata_2074524277.md index 8ea1f508f9..44aa63cd9e 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setdata_2074524277.md +++ b/windows.applicationmodel.datatransfer/datapackage_setdata_2074524277.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetData(System.String,System.Object) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.SetData ## -description Sets the data contained in the [DataPackage](datapackage.md) in a [RandomAccessStream](../windows.storage.streams/randomaccessstream.md) format. ## -parameters ### -param formatId Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. ### -param value Specifies the content that the [DataPackage](datapackage.md) contains. ## -remarks To add data using this method, your app must convert the data into an object. You must also specify a *formatId* that target apps can use to request the data. Note that the target app can request this data only if it knows the *formatId*. This method is often used when you use a delegate function to share data. For more information, see [How to support pull operations](http://msdn.microsoft.com/library/3f11f42f-d23b-4750-beab-bce05badbac8). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetData(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetData + +## -description +Sets the data contained in the [DataPackage](datapackage.md) in a [RandomAccessStream](../windows.storage.streams/randomaccessstream.md) format. + +## -parameters +### -param formatId +Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. + +### -param value +Specifies the content that the [DataPackage](datapackage.md) contains. + +## -remarks +To add data using this method, your app must convert the data into an object. You must also specify a *formatId* that target apps can use to request the data. Note that the target app can request this data only if it knows the *formatId*. + +This method is often used when you use a delegate function to share data. For more information, see [How to support pull operations](http://msdn.microsoft.com/library/3f11f42f-d23b-4750-beab-bce05badbac8). + +## -examples + + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md b/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md index cc8171798a..8191a38af5 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md +++ b/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md @@ -1,38 +1,38 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider(System.String,Windows.ApplicationModel.DataTransfer.DataProviderHandler) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider - -## -description -Sets a delegate to handle requests from the target app. - -## -parameters -### -param formatId -Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. - -### -param delayRenderer -A delegate that is responsible for processing requests from a target app. - -## -remarks -Use the **SetDataProvider** method when your app supports a specific format, but does not want to supply the data until the target app requests it. We encourage you to use this method if your app shares content that can require significant processing time; for example, sharing a selection of photos, videos, or files. - -When you use this method, you need to specify a format and a function. You can specify the format by using the [StandardDataFormats](standarddataformats.md) class, or you can use a string value for a custom format. The function must put data in the [DataPackage](datapackage.md) by using a method like [SetData](datapackage_setdata.md). - -You must specify the extension of the [StorageItems](standarddataformats_storageitems.md) being passed to the Share Target. - -The **SetDataProvider** method is different from the [GetDeferral](datarequest_getdeferral.md) method of the [DataRequest](datarequest.md) class. With [GetDeferral](datarequest_getdeferral.md), a source app can call a function that immediately puts the data in the [DataPackage](datapackage.md) object. The **SetDataProvider** method is for more complex share operations where packaging the data to be shared is more time-intensive or resource-intensive. - - - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles)][!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider(System.String,Windows.ApplicationModel.DataTransfer.DataProviderHandler) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider + +## -description +Sets a delegate to handle requests from the target app. + +## -parameters +### -param formatId +Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. + +### -param delayRenderer +A delegate that is responsible for processing requests from a target app. + +## -remarks +Use the **SetDataProvider** method when your app supports a specific format, but does not want to supply the data until the target app requests it. We encourage you to use this method if your app shares content that can require significant processing time; for example, sharing a selection of photos, videos, or files. + +When you use this method, you need to specify a format and a function. You can specify the format by using the [StandardDataFormats](standarddataformats.md) class, or you can use a string value for a custom format. The function must put data in the [DataPackage](datapackage.md) by using a method like [SetData](datapackage_setdata.md). + +You must specify the extension of the [StorageItems](standarddataformats_storageitems.md) being passed to the Share Target. + +The **SetDataProvider** method is different from the [GetDeferral](datarequest_getdeferral.md) method of the [DataRequest](datarequest.md) class. With [GetDeferral](datarequest_getdeferral.md), a source app can call a function that immediately puts the data in the [DataPackage](datapackage.md) object. The **SetDataProvider** method is for more complex share operations where packaging the data to be shared is more time-intensive or resource-intensive. + + + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles)][!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md b/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md index 4d5fce6846..901668a922 100644 --- a/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md +++ b/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat - -## -description -Adds HTML content to the [DataPackage](datapackage.md). - -## -parameters -### -param value -The HTML content. - -## -remarks -To ensure that a target app can process the HTML content, use [HtmlFormatHelper.CreateHtmlFormat](htmlformathelper_createhtmlformat.md). It adds the required headers and other information the string containing the HTML. - -If your app supports selection or copying/pasting of HTML content that contains [img](XREF:TODO:wwa.IMG_Element_IMG_Object) elements, be sure that the **src** attributes specify fully-qualified absolute paths to the images, not relative paths. - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat + +## -description +Adds HTML content to the [DataPackage](datapackage.md). + +## -parameters +### -param value +The HTML content. + +## -remarks +To ensure that a target app can process the HTML content, use [HtmlFormatHelper.CreateHtmlFormat](htmlformathelper_createhtmlformat.md). It adds the required headers and other information the string containing the HTML. + +If your app supports selection or copying/pasting of HTML content that contains [img](XREF:TODO:wwa.IMG_Element_IMG_Object) elements, be sure that the **src** attributes specify fully-qualified absolute paths to the images, not relative paths. + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setrtf_1875888003.md b/windows.applicationmodel.datatransfer/datapackage_setrtf_1875888003.md index d023d655d9..83fef53124 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setrtf_1875888003.md +++ b/windows.applicationmodel.datatransfer/datapackage_setrtf_1875888003.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetRtf(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.SetRtf ## -description Sets the Rich Text Format (RTF) content that is contained in a [DataPackage](datapackage.md). ## -parameters ### -param value Specifies the Rich Text Format (RTF) content for the [DataPackage](datapackage.md). ## -remarks This method sets the value for [StandardFormats.Rtf](standarddataformats_rtf.md). Rich Text Format (RTF) is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for info on other supported data types. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetRtf(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetRtf + +## -description +Sets the Rich Text Format (RTF) content that is contained in a [DataPackage](datapackage.md). + +## -parameters +### -param value +Specifies the Rich Text Format (RTF) content for the [DataPackage](datapackage.md). + +## -remarks +This method sets the value for [StandardFormats.Rtf](standarddataformats_rtf.md). + +Rich Text Format (RTF) is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for info on other supported data types. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setstorageitems_1050978414.md b/windows.applicationmodel.datatransfer/datapackage_setstorageitems_1050978414.md index e657fb9a4c..db2ad3cfb7 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setstorageitems_1050978414.md +++ b/windows.applicationmodel.datatransfer/datapackage_setstorageitems_1050978414.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem},System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems ## -description Adds files and folders to a [DataPackage](datapackage.md). ## -parameters ### -param value The files and folders to be added to the [DataPackage](datapackage.md). ### -param readOnly Specify true if the files are read-only; false otherwise. ## -remarks ## -examples ## -see-also [SetStorageItems(IIterable(IStorageItem))](datapackage_setstorageitems_591028330.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem},System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems + +## -description +Adds files and folders to a [DataPackage](datapackage.md). + +## -parameters +### -param value +The files and folders to be added to the [DataPackage](datapackage.md). + +### -param readOnly +Specify true if the files are read-only; false otherwise. + +## -remarks + +## -examples + +## -see-also +[SetStorageItems(IIterable(IStorageItem))](datapackage_setstorageitems_591028330.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackage_setstorageitems_591028330.md b/windows.applicationmodel.datatransfer/datapackage_setstorageitems_591028330.md index 7504c86b2c..2ed84cdba3 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setstorageitems_591028330.md +++ b/windows.applicationmodel.datatransfer/datapackage_setstorageitems_591028330.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem}) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems ## -description Sets the files and folders contained in a [DataPackage](datapackage.md). ## -parameters ### -param value The files and folders to be added to the [DataPackage](datapackage.md). ## -remarks ## -examples ## -see-also [SetStorageItems(IIterable(IStorageItem), Boolean)](datapackage_setstorageitems_1050978414.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetStorageItems + +## -description +Sets the files and folders contained in a [DataPackage](datapackage.md). + +## -parameters +### -param value +The files and folders to be added to the [DataPackage](datapackage.md). + +## -remarks + +## -examples + +## -see-also +[SetStorageItems(IIterable(IStorageItem), Boolean)](datapackage_setstorageitems_1050978414.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md b/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md index aac454e611..f6e5236d3b 100644 --- a/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md +++ b/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetText(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetText - -## -description -Sets the text that a [DataPackage](datapackage.md) contains. - -## -parameters -### -param value -The text. - -## -remarks -This method sets the text value for [StandardDataFormats.Text](standarddataformats_text.md). It's the equivalent of calling `dataPackage.setText(StandardDataFormats.Text)`. - -Text is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetText(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetText + +## -description +Sets the text that a [DataPackage](datapackage.md) contains. + +## -parameters +### -param value +The text. + +## -remarks +This method sets the text value for [StandardDataFormats.Text](standarddataformats_text.md). It's the equivalent of calling `dataPackage.setText(StandardDataFormats.Text)`. + +Text is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_seturi_1576665843.md b/windows.applicationmodel.datatransfer/datapackage_seturi_1576665843.md index 483bbc86b7..eb749a1c2c 100644 --- a/windows.applicationmodel.datatransfer/datapackage_seturi_1576665843.md +++ b/windows.applicationmodel.datatransfer/datapackage_seturi_1576665843.md @@ -1,34 +1,34 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetUri(Windows.Foundation.Uri) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetUri - -## -description -> [!NOTE] -> [SetUri](datapackage_seturi.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ApplicationLink](datapackage_setapplicationlink.md) or [WebLink](datapackage_setweblink.md). - -Sets the Uniform Resource Identifier (URI) that is contained in the [DataPackage](datapackage.md). - -## -parameters -### -param value -The Uniform Resource Identifier (URI) that is contained in the [DataPackage](datapackage.md). - -## -remarks -This method sets the value for [StandardFormats.Uri](standarddataformats_uri.md). - -Uniform Resource Identifier (URI) is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. - -## -examples -The following code sample demonstrates how an app can set the URI on a [DataPackage](datapackage.md) object. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareLinks.xaml.cs#SnippetHowToShareLink)][!code-js[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareLink.js#SnippetHowToShareLink)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetUri(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetUri + +## -description +> [!NOTE] +> [SetUri](datapackage_seturi.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ApplicationLink](datapackage_setapplicationlink.md) or [WebLink](datapackage_setweblink.md). + +Sets the Uniform Resource Identifier (URI) that is contained in the [DataPackage](datapackage.md). + +## -parameters +### -param value +The Uniform Resource Identifier (URI) that is contained in the [DataPackage](datapackage.md). + +## -remarks +This method sets the value for [StandardFormats.Uri](standarddataformats_uri.md). + +Uniform Resource Identifier (URI) is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. + +## -examples +The following code sample demonstrates how an app can set the URI on a [DataPackage](datapackage.md) object. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareLinks.xaml.cs#SnippetHowToShareLink)][!code-js[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareLink.js#SnippetHowToShareLink)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setweblink_224257999.md b/windows.applicationmodel.datatransfer/datapackage_setweblink_224257999.md index cf37ca4a45..64c9b5d320 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setweblink_224257999.md +++ b/windows.applicationmodel.datatransfer/datapackage_setweblink_224257999.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetWebLink(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackage.SetWebLink ## -description Sets the web link that a [DataPackage](datapackage.md) contains. ## -parameters ### -param value A Uniform Resource Identifier (URI) with an **http** or **https** scheme that corresponds to the content being displayed to the user. ## -remarks Whenever possible, you should set this property. A source app provides a value for this property, and a target app reads the value. Use this property to indicate the source of the shared content. ## -examples ## -see-also [WebLink](standarddataformats_weblink.md), [GetWebLink](datapackageview_getweblinkasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetWebLink(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetWebLink + +## -description +Sets the web link that a [DataPackage](datapackage.md) contains. + +## -parameters +### -param value +A Uniform Resource Identifier (URI) with an **http** or **https** scheme that corresponds to the content being displayed to the user. + +## -remarks +Whenever possible, you should set this property. A source app provides a value for this property, and a target app reads the value. Use this property to indicate the source of the shared content. + +## -examples + +## -see-also +[WebLink](standarddataformats_weblink.md), [GetWebLink](datapackageview_getweblinkasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationlistinguri.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationlistinguri.md index 1270c7c3fa..d17a21f318 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationlistinguri.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationlistinguri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationListingUri --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationListingUri ## -description Gets or sets the Uniform Resource Identifier (URI) of the app's location in the Windows Store. ## -property-value The Uniform Resource Identifier (URI) of the app in the Windows Store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationListingUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationListingUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) of the app's location in the Windows Store. + +## -property-value +The Uniform Resource Identifier (URI) of the app in the Windows Store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationname.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationname.md index 02b3e5b10c..4053480228 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationname.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_applicationname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationName --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationName ## -description Gets or sets the name of the app that created the [DataPackage](datapackage.md) object. ## -property-value Specifies the name of the app that created the [DataPackage](datapackage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ApplicationName + +## -description + Gets or sets the name of the app that created the [DataPackage](datapackage.md) object. + +## -property-value +Specifies the name of the app that created the [DataPackage](datapackage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_clear_556466.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_clear_556466.md index 29b8fe70ae..201f018cd8 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_clear_556466.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_clear_556466.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Clear --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Clear ## -description Removes all items from the property set. ## -remarks Use this method in situations where you want to remove all of the properties in a [DataPackagePropertySet](datapackagepropertyset.md) at the same time. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Clear +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Clear + +## -description +Removes all items from the property set. + +## -remarks +Use this method in situations where you want to remove all of the properties in a [DataPackagePropertySet](datapackagepropertyset.md) at the same time. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceapplicationlink.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceapplicationlink.md index 8cb69df073..38f0e3858f 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceapplicationlink.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceapplicationlink.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceApplicationLink --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceApplicationLink ## -description Gets or sets the application link to the content from the source app. ## -property-value The Uniform Resource Identifier (URI) of the application link to shared content. ## -remarks [ContentSourceApplicationLink](datapackagepropertyset_contentsourceapplicationlink.md) is a companion property that you use to attribute shared content. It's shared when the app finds it meaningful for the user to return to the content that's currently displayed in the app. When the user makes a selection, the [ApplicationLink](standarddataformats_applicationlink.md) format isn't populated, because the value for [ApplicationLink](standarddataformats_applicationlink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the deep link into the app represents the user's selection, only that the content comes from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceApplicationLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceApplicationLink + +## -description +Gets or sets the application link to the content from the source app. + +## -property-value +The Uniform Resource Identifier (URI) of the application link to shared content. + +## -remarks +[ContentSourceApplicationLink](datapackagepropertyset_contentsourceapplicationlink.md) is a companion property that you use to attribute shared content. It's shared when the app finds it meaningful for the user to return to the content that's currently displayed in the app. When the user makes a selection, the [ApplicationLink](standarddataformats_applicationlink.md) format isn't populated, because the value for [ApplicationLink](standarddataformats_applicationlink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the deep link into the app represents the user's selection, only that the content comes from there. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceweblink.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceweblink.md index 5c5b383c4e..4f09895906 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceweblink.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_contentsourceweblink.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceWebLink --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceWebLink ## -description Provides a web link to shared content that's currently displayed in the app. ## -property-value The Uniform Resource Identifier (URI) of the web link to shared content. ## -remarks [ContentSourceWebLink](datapackagepropertyset_contentsourceweblink.md) is a companion property that you use to attribute shared content. It's shared when the app provides a web link to the content being shared. When the user makes an explicit selection, the [WebLink](standarddataformats_weblink.md) format isn't populated, because the value for the [WebLink](standarddataformats_weblink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the web page is the user's selection, only that the content comes from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceWebLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.ContentSourceWebLink + +## -description +Provides a web link to shared content that's currently displayed in the app. + +## -property-value +The Uniform Resource Identifier (URI) of the web link to shared content. + +## -remarks +[ContentSourceWebLink](datapackagepropertyset_contentsourceweblink.md) is a companion property that you use to attribute shared content. It's shared when the app provides a web link to the content being shared. When the user makes an explicit selection, the [WebLink](standarddataformats_weblink.md) format isn't populated, because the value for the [WebLink](standarddataformats_weblink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the web page is the user's selection, only that the content comes from there. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md index ab2976a9f9..5ac6723e9b 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description - -## -description -Gets or sets text that describes the contents of the [DataPackage](datapackage.md). - -## -property-value -Text that describes the contents of the [DataPackage](datapackage.md). - -## -remarks -We recommend adding a description to a [DataPackage](datapackage.md) object if you can. Target apps can use this description to help users identify what content they're sharing. - -## -examples -The following example shows how you can set the description for the content in a [DataPackage](datapackage.md). - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description + +## -description +Gets or sets text that describes the contents of the [DataPackage](datapackage.md). + +## -property-value +Text that describes the contents of the [DataPackage](datapackage.md). + +## -remarks +We recommend adding a description to a [DataPackage](datapackage.md) object if you can. Target apps can use this description to help users identify what content they're sharing. + +## -examples +The following example shows how you can set the description for the content in a [DataPackage](datapackage.md). + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_enterpriseid.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_enterpriseid.md index 3e602d618b..697eb810a8 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_enterpriseid.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_enterpriseid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.EnterpriseId --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.EnterpriseId ## -description Gets or sets the enterprise identity (see [Enterprise data protection](XREF:TODO:dev_enterprise.edp_hub.xml)). ## -property-value The enterprise Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.EnterpriseId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.EnterpriseId + +## -description +Gets or sets the enterprise identity (see [Enterprise data protection](XREF:TODO:dev_enterprise.edp_hub.xml)). + +## -property-value +The enterprise Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_filetypes.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_filetypes.md index eb36e87d24..f77e6ddf19 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_filetypes.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_filetypes.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.FileTypes --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.FileTypes ## -description Specifies a vector object that contains the types of files stored in the [DataPackage](datapackage.md) object. ## -property-value Contains the types of files stored in the [DataPackage](datapackage.md) object. ## -remarks Many target apps accept a number of different file formats. Even so, they might prefer one format over another. By adding the file types supported in a [DataPackage](datapackage.md) to the **FileTypes** property, you can help those target apps select the most appropriate file format for a given operation. If your app shares content using one of the formats that the [DataPackage](datapackage.md) object supports directly, such as [text](standarddataformats_text.md) or [Html](standarddataformats_html.md), you should use the [StandardDataFormats](standarddataformats.md) class when adding file types to this property. If your app supports a custom data format, you can add that format using a string. In cases where your app uses a delegate to add content to the [DataPackage](datapackage.md), you must ensure that the string you use in the **FileTypes** property matches the value of the *formatId* parameter of the [SetDataProvider](datapackage_setdataprovider.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.FileTypes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.FileTypes + +## -description +Specifies a vector object that contains the types of files stored in the [DataPackage](datapackage.md) object. + +## -property-value +Contains the types of files stored in the [DataPackage](datapackage.md) object. + +## -remarks +Many target apps accept a number of different file formats. Even so, they might prefer one format over another. By adding the file types supported in a [DataPackage](datapackage.md) to the **FileTypes** property, you can help those target apps select the most appropriate file format for a given operation. + +If your app shares content using one of the formats that the [DataPackage](datapackage.md) object supports directly, such as [text](standarddataformats_text.md) or [Html](standarddataformats_html.md), you should use the [StandardDataFormats](standarddataformats.md) class when adding file types to this property. If your app supports a custom data format, you can add that format using a string. In cases where your app uses a delegate to add content to the [DataPackage](datapackage.md), you must ensure that the string you use in the **FileTypes** property matches the value of the *formatId* parameter of the [SetDataProvider](datapackage_setdataprovider.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_first_1920739956.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_first_1920739956.md index 44037b428e..89d1385b45 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_first_1920739956.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_first_1920739956.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.First --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.First ## -description Returns an iterator to enumerate the items in the property set. ## -returns The first item in the [DataPackage](datapackage.md) object. ## -remarks For more info, see [IIterable(IKeyValuePair)](../windows.foundation.collections/iiterable_1.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.First + +## -description +Returns an iterator to enumerate the items in the property set. + +## -returns +The first item in the [DataPackage](datapackage.md) object. + +## -remarks +For more info, see [IIterable(IKeyValuePair)](../windows.foundation.collections/iiterable_1.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_getview_37498667.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_getview_37498667.md index 4669b0edd3..ff57af5f7d 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_getview_37498667.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_getview_37498667.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.GetView --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.GetView ## -description Gets an immutable view of the property set. ## -returns The immutable view. ## -remarks Returns a [DataPackagePropertySetView](datapackagepropertysetview.md) object, which is an immutable view of the [DataPackagePropertySet](datapackagepropertyset.md) object. For more info, see [IMap(String, Object)](../windows.foundation.collections/imap_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.GetView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.GetView + +## -description +Gets an immutable view of the property set. + +## -returns +The immutable view. + +## -remarks +Returns a [DataPackagePropertySetView](datapackagepropertysetview.md) object, which is an immutable view of the [DataPackagePropertySet](datapackagepropertyset.md) object. For more info, see [IMap(String, Object)](../windows.foundation.collections/imap_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_haskey_425964900.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_haskey_425964900.md index 2a0586e8ab..0de631b9f0 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_haskey_425964900.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_haskey_425964900.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.HasKey(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.HasKey ## -description Indicates whether the [DataPackagePropertySet](datapackagepropertyset.md) object contains a specific property. ## -parameters ### -param key The key. ## -returns True if the property set has an item with the specified key; otherwise false. ## -remarks With the [DataPackagePropertySet](datapackagepropertyset.md) class, use **HasKey** as a way to see whether the object contains a specific property. This is useful in situations where your app requires a custom property that the [DataPackagePropertySet](datapackagepropertyset.md) object doesn't directly support. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.HasKey + +## -description +Indicates whether the [DataPackagePropertySet](datapackagepropertyset.md) object contains a specific property. + +## -parameters +### -param key +The key. + +## -returns +True if the property set has an item with the specified key; otherwise false. + +## -remarks +With the [DataPackagePropertySet](datapackagepropertyset.md) class, use **HasKey** as a way to see whether the object contains a specific property. This is useful in situations where your app requires a custom property that the [DataPackagePropertySet](datapackagepropertyset.md) object doesn't directly support. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_insert_2123640444.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_insert_2123640444.md index bca026ef9e..ac5031efa2 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_insert_2123640444.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_insert_2123640444.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Insert(System.String,System.Object) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Insert ## -description Adds a property to the [DataPackagePropertySet](datapackagepropertyset.md) object. ## -parameters ### -param key The key to insert. ### -param value The value to insert. ## -returns True if the method replaced a value that already existed for the key; false if this is a new key. ## -remarks Use this method if your app needs to add a custom property to the [DataPackagePropertySet](datapackagepropertyset.md) object. A custom property is any property that you can't define by using an existing property of the object. For example, [title](datapackagepropertyset_title.md) is a property that the object supports directly, but if you wanted a subtitle property, you would need to use **Insert** to add it. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Insert(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Insert + +## -description +Adds a property to the [DataPackagePropertySet](datapackagepropertyset.md) object. + +## -parameters +### -param key +The key to insert. + +### -param value +The value to insert. + +## -returns +True if the method replaced a value that already existed for the key; false if this is a new key. + +## -remarks +Use this method if your app needs to add a custom property to the [DataPackagePropertySet](datapackagepropertyset.md) object. A custom property is any property that you can't define by using an existing property of the object. For example, [title](datapackagepropertyset_title.md) is a property that the object supports directly, but if you wanted a subtitle property, you would need to use **Insert** to add it. + +For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_logobackgroundcolor.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_logobackgroundcolor.md index 1ccf9f4c3d..e5d044299a 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_logobackgroundcolor.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_logobackgroundcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.LogoBackgroundColor --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.LogoBackgroundColor ## -description Gets or sets a background color for the sharing app's [Square30x30Logo](datapackagepropertyset_square30x30logo.md). ## -property-value The color of the logo's background. ## -remarks ## -examples ## -see-also [Square30x30Logo](datapackagepropertyset_square30x30logo.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.LogoBackgroundColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.LogoBackgroundColor + +## -description +Gets or sets a background color for the sharing app's [Square30x30Logo](datapackagepropertyset_square30x30logo.md). + +## -property-value +The color of the logo's background. + +## -remarks + +## -examples + +## -see-also +[Square30x30Logo](datapackagepropertyset_square30x30logo.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_lookup_711408188.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_lookup_711408188.md index e341b7dc1f..a28ace542a 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_lookup_711408188.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_lookup_711408188.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Lookup(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Lookup ## -description Retrieves the value of a specific property. ## -parameters ### -param key The key. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks With the **LookUp** method, you specify the name of the property that you want. This name can be a property that the object supports directly, such as title, or a custom property defined by the source app. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Lookup + +## -description +Retrieves the value of a specific property. + +## -parameters +### -param key +The key. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks +With the **LookUp** method, you specify the name of the property that you want. This name can be a property that the object supports directly, such as title, or a custom property defined by the source app. + +For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_packagefamilyname.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_packagefamilyname.md index be325a879b..841e8d3251 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_packagefamilyname.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_packagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.PackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.PackageFamilyName ## -description Gets or sets the package family name of the source app. ## -property-value The package family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.PackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.PackageFamilyName + +## -description +Gets or sets the package family name of the source app. + +## -property-value +The package family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_remove_1498489487.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_remove_1498489487.md index 0359baab3a..915c3b0b8a 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_remove_1498489487.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_remove_1498489487.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Remove(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Remove ## -description Removes an item from the property set. ## -parameters ### -param key The key. ## -remarks Use **Remove** if you need to delete a property from the [DataPackagePropertySet](datapackagepropertyset.md) object. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). For the C# and Microsoft Visual Basic version of the **Remove(String)** method, see [Remove](datapackagepropertyset_remove_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Remove + +## -description +Removes an item from the property set. + +## -parameters +### -param key +The key. + +## -remarks +Use **Remove** if you need to delete a property from the [DataPackagePropertySet](datapackagepropertyset.md) object. + +For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +For the C# and Microsoft Visual Basic version of the **Remove(String)** method, see [Remove](datapackagepropertyset_remove_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_size.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_size.md index b6bf8dbea9..24c183a975 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_size.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Size --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Size ## -description Gets the number of items that are contained in the property set. ## -property-value The number of elements in the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Size + +## -description +Gets the number of items that are contained in the property set. + +## -property-value +The number of elements in the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_square30x30logo.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_square30x30logo.md index 50daadbc9a..d084ba6522 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_square30x30logo.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_square30x30logo.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Square30x30Logo --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Square30x30Logo ## -description Gets or sets the source app's logo. ## -property-value The logo's bitmap. ## -remarks The logo is padded with the color in [LogoBackgroundColor](datapackagepropertyset_logobackgroundcolor.md). The source app should provide the logo that's appropriate for the current plateau level of the share UI. ## -examples ## -see-also [LogoBackgroundColor](datapackagepropertyset_logobackgroundcolor.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Square30x30Logo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Square30x30Logo + +## -description +Gets or sets the source app's logo. + +## -property-value +The logo's bitmap. + +## -remarks +The logo is padded with the color in [LogoBackgroundColor](datapackagepropertyset_logobackgroundcolor.md). + +The source app should provide the logo that's appropriate for the current plateau level of the share UI. + +## -examples + +## -see-also +[LogoBackgroundColor](datapackagepropertyset_logobackgroundcolor.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md index 85081a2d14..3359db7a43 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md @@ -1,32 +1,32 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail - -## -description -Gets or sets a thumbnail image for the [DataPackage](datapackage.md). - -## -property-value -The [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) that represents the thumbnail image. - -## -remarks -We recommend that any time you create a [DataPackage](datapackage.md) that contains images, you also assign a thumbnail image. Doing so gives target apps the opportunity to display a visual representation of the images being shared to the user while the share operation completes. - -The minimum recommended size is 80x80. The maximum size is 240x160. These sizes are in device-independent pixels, so if the system plateau setting is other than 1.0, appropriate multiplier should be used. For example, minimum recommended size for 1.4 plateau would be 80*1.4x80*1.4=112x112 physical pixels. If you're writing a target app, remember that while we recommend a minimum and maximum size, there is no enforcement of these sizes. Your app should have code to handle thumbnails that are an unexpected size—such as to scale them up or down as needed. Take care, however, not to alter the aspect ratio of the image. - -You can use any data format (JPG, GIF, and so on) for a thumbnail. You also have the option of loading the thumbnail from the disk, or creating it on the fly. - -## -examples -This example shows how you can add a thumbnail image to a [DataPackage](datapackage.md) when sharing an image with a target app. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail + +## -description +Gets or sets a thumbnail image for the [DataPackage](datapackage.md). + +## -property-value +The [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) that represents the thumbnail image. + +## -remarks +We recommend that any time you create a [DataPackage](datapackage.md) that contains images, you also assign a thumbnail image. Doing so gives target apps the opportunity to display a visual representation of the images being shared to the user while the share operation completes. + +The minimum recommended size is 80x80. The maximum size is 240x160. These sizes are in device-independent pixels, so if the system plateau setting is other than 1.0, appropriate multiplier should be used. For example, minimum recommended size for 1.4 plateau would be 80*1.4x80*1.4=112x112 physical pixels. If you're writing a target app, remember that while we recommend a minimum and maximum size, there is no enforcement of these sizes. Your app should have code to handle thumbnails that are an unexpected size—such as to scale them up or down as needed. Take care, however, not to alter the aspect ratio of the image. + +You can use any data format (JPG, GIF, and so on) for a thumbnail. You also have the option of loading the thumbnail from the disk, or creating it on the fly. + +## -examples +This example shows how you can add a thumbnail image to a [DataPackage](datapackage.md) when sharing an image with a target app. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md index e621ea08da..d858010792 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title - -## -description -Gets or sets the text that displays as a title for the contents of the [DataPackage](datapackage.md) object. - -## -property-value -The text that displays as a title for the contents of the [DataPackage](datapackage.md) object. - -## -remarks -Setting this property is mandatory. Without it, any share operations involving the [DataPackage](datapackage.md) will fail. - -## -examples -This example shows how you can set the title for the content in a [DataPackage.](datapackage.md) - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title + +## -description +Gets or sets the text that displays as a title for the contents of the [DataPackage](datapackage.md) object. + +## -property-value +The text that displays as a title for the contents of the [DataPackage](datapackage.md) object. + +## -remarks +Setting this property is mandatory. Without it, any share operations involving the [DataPackage](datapackage.md) will fail. + +## -examples +This example shows how you can set the title for the content in a [DataPackage.](datapackage.md) + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationlistinguri.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationlistinguri.md index 14a419639a..8150caab8c 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationlistinguri.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationlistinguri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationListingUri --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationListingUri ## -description Gets the Uniform Resource Identifier (URI) of the app's location in the Windows Store. ## -property-value The Uniform Resource Identifier (URI) of the app in the Windows Store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationListingUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationListingUri + +## -description +Gets the Uniform Resource Identifier (URI) of the app's location in the Windows Store. + +## -property-value +The Uniform Resource Identifier (URI) of the app in the Windows Store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationname.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationname.md index 668dd20a95..b276a80cc3 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationname.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_applicationname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationName --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationName ## -description Gets the name of the app that created the [DataPackage](datapackage.md) object. ## -property-value The name of the app that created the [DataPackage](datapackage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ApplicationName + +## -description + Gets the name of the app that created the [DataPackage](datapackage.md) object. + +## -property-value +The name of the app that created the [DataPackage](datapackage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceapplicationlink.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceapplicationlink.md index 4981a493a4..2fcabfb785 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceapplicationlink.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceapplicationlink.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceApplicationLink --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceApplicationLink ## -description Gets the application link to the content from the source app. ## -property-value The Uniform Resource Identifier (URI) of the application link to shared content. ## -remarks [ContentSourceApplicationLink](datapackagepropertysetview_contentsourceapplicationlink.md) is a companion property that you use to attribute shared content. It's shared when the app finds it meaningful for the user to return to the content that's currently displayed in the app. When the user makes a selection, the [ApplicationLink](standarddataformats_applicationlink.md) format isn't populated, because the value for [ApplicationLink](standarddataformats_applicationlink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the deep link into the app represents the user's selection, only that the content comes from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceApplicationLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceApplicationLink + +## -description +Gets the application link to the content from the source app. + +## -property-value +The Uniform Resource Identifier (URI) of the application link to shared content. + +## -remarks +[ContentSourceApplicationLink](datapackagepropertysetview_contentsourceapplicationlink.md) is a companion property that you use to attribute shared content. It's shared when the app finds it meaningful for the user to return to the content that's currently displayed in the app. When the user makes a selection, the [ApplicationLink](standarddataformats_applicationlink.md) format isn't populated, because the value for [ApplicationLink](standarddataformats_applicationlink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the deep link into the app represents the user's selection, only that the content comes from there. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceweblink.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceweblink.md index 714066a577..b36c0f99ef 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceweblink.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_contentsourceweblink.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceWebLink --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceWebLink ## -description Gets a web link to shared content that's currently displayed in the app. ## -property-value The Uniform Resource Identifier (URI) of the web link to shared content. ## -remarks [ContentSourceWebLink](datapackagepropertysetview_contentsourceweblink.md) is a companion property that you use to attribute shared content. It's shared when the app provides a web link to the content being shared. When the user makes an explicit selection, the [WebLink](standarddataformats_weblink.md) format isn't populated, because the value for the [WebLink](standarddataformats_weblink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the web page is the user's selection, only that the content comes from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceWebLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.ContentSourceWebLink + +## -description +Gets a web link to shared content that's currently displayed in the app. + +## -property-value +The Uniform Resource Identifier (URI) of the web link to shared content. + +## -remarks +[ContentSourceWebLink](datapackagepropertysetview_contentsourceweblink.md) is a companion property that you use to attribute shared content. It's shared when the app provides a web link to the content being shared. When the user makes an explicit selection, the [WebLink](standarddataformats_weblink.md) format isn't populated, because the value for the [WebLink](standarddataformats_weblink.md) format isn't the same as the user's selection. Populating this info doesn't mean that the web page is the user's selection, only that the content comes from there. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_description.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_description.md index db38305ba8..ef1a01c42d 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_description.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Description --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Description ## -description Gets the text that describes the contents of the [DataPackage](datapackage.md). ## -property-value Text that describes the contents of the [DataPackage](datapackage.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Description + +## -description +Gets the text that describes the contents of the [DataPackage](datapackage.md). + +## -property-value +Text that describes the contents of the [DataPackage](datapackage.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_enterpriseid.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_enterpriseid.md index f9bf06f8b6..aafabe58f9 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_enterpriseid.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_enterpriseid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.EnterpriseId --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.EnterpriseId ## -description Gets or sets the enterprise Id. ## -property-value The enterprise Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.EnterpriseId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.EnterpriseId + +## -description +Gets or sets the enterprise Id. + +## -property-value +The enterprise Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_filetypes.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_filetypes.md index d6e2cab6be..6dd7695d53 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_filetypes.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_filetypes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.FileTypes --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.FileTypes ## -description Gets a vector object that contains the types of files stored in the [DataPackage](datapackage.md) object. ## -property-value Contains the types of files stored in the [DataPackage](datapackage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.FileTypes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.FileTypes + +## -description +Gets a vector object that contains the types of files stored in the [DataPackage](datapackage.md) object. + +## -property-value +Contains the types of files stored in the [DataPackage](datapackage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_first_1920739956.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_first_1920739956.md index c70685ec17..7ec8dbbec6 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_first_1920739956.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_first_1920739956.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.First --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.First ## -description Returns an iterator to enumerate the items in the property set. ## -returns The first item in the [DataPackage](datapackage.md) object. ## -remarks For more info, see [IIterable(IKeyValuePair)](../windows.foundation.collections/iiterable_1.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.First + +## -description +Returns an iterator to enumerate the items in the property set. + +## -returns +The first item in the [DataPackage](datapackage.md) object. + +## -remarks +For more info, see [IIterable(IKeyValuePair)](../windows.foundation.collections/iiterable_1.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_haskey_425964900.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_haskey_425964900.md index 6af50e02d8..6bff894054 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_haskey_425964900.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_haskey_425964900.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.HasKey(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.HasKey ## -description Indicates whether the [DataPackagePropertySetView](datapackagepropertysetview.md) object contains a specific property. ## -parameters ### -param key The key. ## -returns True if the property set has an item with the specified key; otherwise false. ## -remarks With the [DataPackagePropertySetView](datapackagepropertysetview.md) class, use **HasKey** as a way to see whether the object contains a specific property. This is useful in situations where your app requires a custom property that the [DataPackagePropertySetView](datapackagepropertysetview.md) object doesn't directly support. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.HasKey + +## -description +Indicates whether the [DataPackagePropertySetView](datapackagepropertysetview.md) object contains a specific property. + +## -parameters +### -param key +The key. + +## -returns +True if the property set has an item with the specified key; otherwise false. + +## -remarks +With the [DataPackagePropertySetView](datapackagepropertysetview.md) class, use **HasKey** as a way to see whether the object contains a specific property. This is useful in situations where your app requires a custom property that the [DataPackagePropertySetView](datapackagepropertysetview.md) object doesn't directly support. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_logobackgroundcolor.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_logobackgroundcolor.md index 665a7e0435..555094b8aa 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_logobackgroundcolor.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_logobackgroundcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.LogoBackgroundColor --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.LogoBackgroundColor ## -description Gets a background color for the sharing app's [Square30x30Logo](datapackagepropertysetview_square30x30logo.md). ## -property-value The background color for the sharing app's [Square30x30Logo](datapackagepropertysetview_square30x30logo.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.LogoBackgroundColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.LogoBackgroundColor + +## -description +Gets a background color for the sharing app's [Square30x30Logo](datapackagepropertysetview_square30x30logo.md). + +## -property-value +The background color for the sharing app's [Square30x30Logo](datapackagepropertysetview_square30x30logo.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_lookup_711408188.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_lookup_711408188.md index 5cdcbbb6a4..0d5c8105a5 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_lookup_711408188.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_lookup_711408188.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Lookup(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Lookup ## -description Retrieves the value of a specific property. ## -parameters ### -param key The key. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks With the **LookUp** method, you specify the name of the property that you want. This name can be a property that the object supports directly, such as title, or a custom property defined by the source app. For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Lookup + +## -description +Retrieves the value of a specific property. + +## -parameters +### -param key +The key. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks +With the **LookUp** method, you specify the name of the property that you want. This name can be a property that the object supports directly, such as title, or a custom property defined by the source app. + +For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_packagefamilyname.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_packagefamilyname.md index c3b31179f2..431d2a7783 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_packagefamilyname.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_packagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.PackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.PackageFamilyName ## -description Gets the package family name of the source app. ## -property-value The package family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.PackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.PackageFamilyName + +## -description +Gets the package family name of the source app. + +## -property-value +The package family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_size.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_size.md index 454bf33568..bba6fd6295 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_size.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_size.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Size --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Size ## -description Gets the number of items that are contained in the property set. ## -property-value The number of elements in the property set. ## -remarks For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Size + +## -description +Gets the number of items that are contained in the property set. + +## -property-value +The number of elements in the property set. + +## -remarks +For more info, see [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_split_1519102654.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_split_1519102654.md index 4c61790da0..a87336cf83 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_split_1519102654.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_split_1519102654.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Split(Windows.Foundation.Collections.IMapView{System.String,System.Object}@,Windows.Foundation.Collections.IMapView{System.String,System.Object}@) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Split ## -description Divides the object into two views ## -parameters ### -param first The first half of the object. ### -param second The second half of the object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Split(Windows.Foundation.Collections.IMapView{System.String,System.Object}@,Windows.Foundation.Collections.IMapView{System.String,System.Object}@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Split + +## -description +Divides the object into two views + +## -parameters +### -param first +The first half of the object. + +### -param second +The second half of the object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_square30x30logo.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_square30x30logo.md index b3936aeb42..480cc4e23d 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_square30x30logo.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_square30x30logo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Square30x30Logo --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Square30x30Logo ## -description Gets the source app's logo. ## -property-value The logo's bitmap. ## -remarks The logo is padded with the color in [LogoBackgroundColor](datapackagepropertyset_logobackgroundcolor.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Square30x30Logo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Square30x30Logo + +## -description +Gets the source app's logo. + +## -property-value +The logo's bitmap. + +## -remarks +The logo is padded with the color in [LogoBackgroundColor](datapackagepropertyset_logobackgroundcolor.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_thumbnail.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_thumbnail.md index 7eea6c93c5..9ed022294d 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_thumbnail.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_thumbnail.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Thumbnail --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Thumbnail - -## -description -Gets the thumbnail image for the [DataPackageView](datapackageview.md). - -## -property-value -The [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) that represents the thumbnail image. - -## -remarks -We recommend that any time you get a [DataPackageView](datapackageview.md) that contains an image, you also check for thumbnail image. Doing so gives allows your app to display a visual representation of the images being shared to the user while the share operation completes. - -## -examples -This example shows how you can get a thumbnail image from a [DataPackageView](datapackageview.md). - - - -[!code-js[GetThumbnail](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedImage.js#SnippetGetThumbnail)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Thumbnail + +## -description +Gets the thumbnail image for the [DataPackageView](datapackageview.md). + +## -property-value +The [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) that represents the thumbnail image. + +## -remarks +We recommend that any time you get a [DataPackageView](datapackageview.md) that contains an image, you also check for thumbnail image. Doing so gives allows your app to display a visual representation of the images being shared to the user while the share operation completes. + +## -examples +This example shows how you can get a thumbnail image from a [DataPackageView](datapackageview.md). + + + +[!code-js[GetThumbnail](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedImage.js#SnippetGetThumbnail)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertysetview_title.md b/windows.applicationmodel.datatransfer/datapackagepropertysetview_title.md index f0fdbc05ce..c33d3099b1 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertysetview_title.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertysetview_title.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Title --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Title ## -description Gets the text that displays as a title for the contents of the [DataPackagePropertySetView](datapackagepropertysetview.md) object. ## -property-value The text that displays as a title for the contents of the [DataPackagePropertySetView](datapackagepropertysetview.md) object. ## -remarks We recommend you get and display the title when processing a [DataPackagePropertySetView](datapackagepropertysetview.md) object. It can help users distinguish between one share operation and another. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView.Title + +## -description +Gets the text that displays as a title for the contents of the [DataPackagePropertySetView](datapackagepropertysetview.md) object. + +## -property-value +The text that displays as a title for the contents of the [DataPackagePropertySetView](datapackagepropertysetview.md) object. + +## -remarks +We recommend you get and display the title when processing a [DataPackagePropertySetView](datapackagepropertysetview.md) object. It can help users distinguish between one share operation and another. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_availableformats.md b/windows.applicationmodel.datatransfer/datapackageview_availableformats.md index 76ba9840fd..966af84c41 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_availableformats.md +++ b/windows.applicationmodel.datatransfer/datapackageview_availableformats.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackageView.AvailableFormats --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.AvailableFormats ## -description Returns the formats the [DataPackageView](datapackageview.md) contains. ## -property-value The formats the [DataPackageView](datapackageview.md) contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackageView.AvailableFormats +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.AvailableFormats + +## -description +Returns the formats the [DataPackageView](datapackageview.md) contains. + +## -property-value +The formats the [DataPackageView](datapackageview.md) contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_contains_1741733936.md b/windows.applicationmodel.datatransfer/datapackageview_contains_1741733936.md index 4429056021..2d9554d984 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_contains_1741733936.md +++ b/windows.applicationmodel.datatransfer/datapackageview_contains_1741733936.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.Contains(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.Contains ## -description Checks to see if the [DataPackageView](datapackageview.md) contains a specific data format. ## -parameters ### -param formatId The name of the format. ## -returns True if the [DataPackageView](datapackageview.md) contains the format; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.Contains(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.Contains + +## -description +Checks to see if the [DataPackageView](datapackageview.md) contains a specific data format. + +## -parameters +### -param formatId +The name of the format. + +## -returns +True if the [DataPackageView](datapackageview.md) contains the format; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_getapplicationlinkasync_832271692.md b/windows.applicationmodel.datatransfer/datapackageview_getapplicationlinkasync_832271692.md index 77181f3a44..78f4c2d515 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getapplicationlinkasync_832271692.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getapplicationlinkasync_832271692.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetApplicationLinkAsync --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.GetApplicationLinkAsync ## -description Gets the application link in the [DataPackageView](datapackageview.md) object. ## -returns The application link. ## -remarks ## -examples ## -see-also [ApplicationLink](standarddataformats_applicationlink.md), [SetApplicationLink](datapackage_setapplicationlink.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetApplicationLinkAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetApplicationLinkAsync + +## -description +Gets the application link in the [DataPackageView](datapackageview.md) object. + +## -returns +The application link. + +## -remarks + +## -examples + +## -see-also +[ApplicationLink](standarddataformats_applicationlink.md), [SetApplicationLink](datapackage_setapplicationlink.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackageview_getbitmapasync_816703378.md b/windows.applicationmodel.datatransfer/datapackageview_getbitmapasync_816703378.md index ae6c25ae28..6e9d2f47ca 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getbitmapasync_816703378.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getbitmapasync_816703378.md @@ -1,25 +1,25 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetBitmapAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackageView.GetBitmapAsync - -## -description -Gets the bitmap image contained in the [DataPackageView](datapackageview.md) - -## -returns -A stream containing the bitmap image. - -## -remarks - -## -examples - - -[!code-js[HowToReceiveImage](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedImage.js#SnippetHowToReceiveImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetBitmapAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetBitmapAsync + +## -description +Gets the bitmap image contained in the [DataPackageView](datapackageview.md) + +## -returns +A stream containing the bitmap image. + +## -remarks + +## -examples + + +[!code-js[HowToReceiveImage](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedImage.js#SnippetHowToReceiveImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_getdataasync_225712847.md b/windows.applicationmodel.datatransfer/datapackageview_getdataasync_225712847.md index eb118b4fac..42ae9a8a70 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getdataasync_225712847.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getdataasync_225712847.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetDataAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.GetDataAsync ## -description Gets the data contained in the [DataPackageView](datapackageview.md). ## -parameters ### -param formatId Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. ## -returns The data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetDataAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetDataAsync + +## -description +Gets the data contained in the [DataPackageView](datapackageview.md). + +## -parameters +### -param formatId +Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. + +## -returns +The data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_gethtmlformatasync_468147349.md b/windows.applicationmodel.datatransfer/datapackageview_gethtmlformatasync_468147349.md index 014e1a586b..1109dc2712 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_gethtmlformatasync_468147349.md +++ b/windows.applicationmodel.datatransfer/datapackageview_gethtmlformatasync_468147349.md @@ -1,25 +1,25 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetHtmlFormatAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackageView.GetHtmlFormatAsync - -## -description -Gets the HTML stored in the [DataPackageView](datapackageview.md) object. - -## -returns -The HTML. - -## -remarks - -## -examples - - -[!code-js[HowToReceiveSharedHtml](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceiveSharedHtml.js#SnippetHowToReceiveSharedHtml)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetHtmlFormatAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetHtmlFormatAsync + +## -description +Gets the HTML stored in the [DataPackageView](datapackageview.md) object. + +## -returns +The HTML. + +## -remarks + +## -examples + + +[!code-js[HowToReceiveSharedHtml](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceiveSharedHtml.js#SnippetHowToReceiveSharedHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_getresourcemapasync_1262107685.md b/windows.applicationmodel.datatransfer/datapackageview_getresourcemapasync_1262107685.md index b6f12d714d..c58f5e0ae1 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getresourcemapasync_1262107685.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getresourcemapasync_1262107685.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetResourceMapAsync --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.GetResourceMapAsync ## -description Gets the data (such as an image) referenced in HTML content. ## -returns The data referenced in the HTML content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetResourceMapAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetResourceMapAsync + +## -description +Gets the data (such as an image) referenced in HTML content. + +## -returns +The data referenced in the HTML content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_getrtfasync_305685983.md b/windows.applicationmodel.datatransfer/datapackageview_getrtfasync_305685983.md index feb06ef75d..4e3f5bb66f 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getrtfasync_305685983.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getrtfasync_305685983.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetRtfAsync --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.GetRtfAsync ## -description Gets the rich text formatted (RTF) content contained in a [DataPackageView](datapackageview.md). ## -returns The rich text formatted content for the DataPackage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetRtfAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetRtfAsync + +## -description +Gets the rich text formatted (RTF) content contained in a [DataPackageView](datapackageview.md). + +## -returns +The rich text formatted content for the DataPackage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_getstorageitemsasync_265545393.md b/windows.applicationmodel.datatransfer/datapackageview_getstorageitemsasync_265545393.md index 11e6ff1832..6ceecd0ac7 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getstorageitemsasync_265545393.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getstorageitemsasync_265545393.md @@ -1,25 +1,25 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetStorageItemsAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackageView.GetStorageItemsAsync - -## -description -Gets the files and folders stored in a [DataPackageView](datapackageview.md) object. - -## -returns -An array of files and folders stored in a [DataPackageView](datapackageview.md). - -## -remarks - -## -examples - - -[!code-js[HowToReceiveFiles](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedSharedFiles.js#SnippetHowToReceiveFiles)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetStorageItemsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetStorageItemsAsync + +## -description +Gets the files and folders stored in a [DataPackageView](datapackageview.md) object. + +## -returns +An array of files and folders stored in a [DataPackageView](datapackageview.md). + +## -remarks + +## -examples + + +[!code-js[HowToReceiveFiles](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedSharedFiles.js#SnippetHowToReceiveFiles)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md b/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md index f2c80fd86b..e6bf359174 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md +++ b/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md @@ -1,26 +1,26 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync - -## -description -Gets the text in the [DataPackageView](datapackageview.md) object. - -## -returns -The text. - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)][!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)] - -## -see-also -[GetTextAsync(String)](datapackageview_gettextasync_160262668.md) +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync + +## -description +Gets the text in the [DataPackageView](datapackageview.md) object. + +## -returns +The text. + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)][!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)] + +## -see-also +[GetTextAsync(String)](datapackageview_gettextasync_160262668.md) diff --git a/windows.applicationmodel.datatransfer/datapackageview_gettextasync_160262668.md b/windows.applicationmodel.datatransfer/datapackageview_gettextasync_160262668.md index fe608c5413..9bc3203483 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_gettextasync_160262668.md +++ b/windows.applicationmodel.datatransfer/datapackageview_gettextasync_160262668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync ## -description Gets the text in the [DataPackageView](datapackageview.md) object. ## -parameters ### -param formatId A string that represents the data format. Usually [StandardDataFormats.text](standarddataformats_text.md). ## -returns The text. ## -remarks ## -examples ## -see-also [GetTextAsync](datapackageview_gettextasync_1343001388.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync + +## -description +Gets the text in the [DataPackageView](datapackageview.md) object. + +## -parameters +### -param formatId +A string that represents the data format. Usually [StandardDataFormats.text](standarddataformats_text.md). + +## -returns +The text. + +## -remarks + +## -examples + +## -see-also +[GetTextAsync](datapackageview_gettextasync_1343001388.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackageview_geturiasync_890005137.md b/windows.applicationmodel.datatransfer/datapackageview_geturiasync_890005137.md index 8a26b1ae30..d3691c4d80 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_geturiasync_890005137.md +++ b/windows.applicationmodel.datatransfer/datapackageview_geturiasync_890005137.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetUriAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackageView.GetUriAsync - -## -description -> [!NOTE] -> [GetUriAsync](datapackageview_geturiasync.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [GetApplicationLink](datapackageview_getapplicationlinkasync.md) or [GetWebLink](datapackageview_getweblinkasync.md). - -Gets the URI contained in the [DataPackageView](datapackageview.md). - -## -returns -The Uri. - -## -remarks - -## -examples - - -[!code-js[HowToReceiveSharedLink](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedSharedUri.js#SnippetHowToReceiveSharedLink)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetUriAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetUriAsync + +## -description +> [!NOTE] +> [GetUriAsync](datapackageview_geturiasync.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [GetApplicationLink](datapackageview_getapplicationlinkasync.md) or [GetWebLink](datapackageview_getweblinkasync.md). + +Gets the URI contained in the [DataPackageView](datapackageview.md). + +## -returns +The Uri. + +## -remarks + +## -examples + + +[!code-js[HowToReceiveSharedLink](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedSharedUri.js#SnippetHowToReceiveSharedLink)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_getweblinkasync_1792258175.md b/windows.applicationmodel.datatransfer/datapackageview_getweblinkasync_1792258175.md index 7cd2ccbab0..04b0348c0d 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_getweblinkasync_1792258175.md +++ b/windows.applicationmodel.datatransfer/datapackageview_getweblinkasync_1792258175.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetWebLinkAsync --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.GetWebLinkAsync ## -description Gets the web link in the [DataPackageView](datapackageview.md) object. ## -returns The web link. ## -remarks ## -examples ## -see-also [WebLink](standarddataformats_weblink.md), [SetWebLink](datapackage_setweblink.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetWebLinkAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetWebLinkAsync + +## -description +Gets the web link in the [DataPackageView](datapackageview.md) object. + +## -returns +The web link. + +## -remarks + +## -examples + +## -see-also +[WebLink](standarddataformats_weblink.md), [SetWebLink](datapackage_setweblink.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackageview_properties.md b/windows.applicationmodel.datatransfer/datapackageview_properties.md index 666be25689..1d7f7cf166 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_properties.md +++ b/windows.applicationmodel.datatransfer/datapackageview_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackageView.Properties --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.Properties ## -description Gets a [DataPackagePropertySetView](datapackagepropertysetview.md) object, which contains a read-only set of properties for the data in the [DataPackageView](datapackageview.md) object. ## -property-value The object that contains a read-only set of properties for the data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackageView.Properties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.Properties + +## -description +Gets a [DataPackagePropertySetView](datapackagepropertysetview.md) object, which contains a read-only set of properties for the data in the [DataPackageView](datapackageview.md) object. + +## -property-value +The object that contains a read-only set of properties for the data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_reportoperationcompleted_467480582.md b/windows.applicationmodel.datatransfer/datapackageview_reportoperationcompleted_467480582.md index ca5c23b569..818c232eb6 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_reportoperationcompleted_467480582.md +++ b/windows.applicationmodel.datatransfer/datapackageview_reportoperationcompleted_467480582.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.ReportOperationCompleted(Windows.ApplicationModel.DataTransfer.DataPackageOperation) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.ReportOperationCompleted ## -description Informs the system that your app is finished using the [DataPackageView](datapackageview.md) object. Primarily used for Clipboard operations. ## -parameters ### -param value An enumeration that states what operation (such as copy or move) was completed. At most one operation flag can be set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.ReportOperationCompleted(Windows.ApplicationModel.DataTransfer.DataPackageOperation) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.ReportOperationCompleted + +## -description +Informs the system that your app is finished using the [DataPackageView](datapackageview.md) object. Primarily used for Clipboard operations. + +## -parameters +### -param value +An enumeration that states what operation (such as copy or move) was completed. At most one operation flag can be set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_1328635663.md b/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_1328635663.md index 4a165a5261..51b548afb8 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_1328635663.md +++ b/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_1328635663.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync ## -description Requests permission to unlock and access a data package that is secured with a protection policy. ## -parameters ### -param enterpriseId The enterprise Id. ## -returns When this method completes, it returns the results of the protection policy evaluation, which indicates whether or not the data is accessible. ## -remarks ## -examples ## -see-also [RequestAccessAsync](datapackageview_requestaccessasync_380675631.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync + +## -description +Requests permission to unlock and access a data package that is secured with a protection policy. + +## -parameters +### -param enterpriseId +The enterprise Id. + +## -returns +When this method completes, it returns the results of the protection policy evaluation, which indicates whether or not the data is accessible. + +## -remarks + +## -examples + +## -see-also +[RequestAccessAsync](datapackageview_requestaccessasync_380675631.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_380675631.md b/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_380675631.md index 45fec616ad..1ade48d3e5 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_380675631.md +++ b/windows.applicationmodel.datatransfer/datapackageview_requestaccessasync_380675631.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync ## -description Requests permission to unlock and access a data package that is secured with a protection policy. ## -returns When this method completes, it returns the results of the protection policy evaluation, which indicates whether or not the data is accessible. ## -remarks ## -examples ## -see-also [RequestAccessAsync(String)](datapackageview_requestaccessasync_1328635663.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.RequestAccessAsync + +## -description +Requests permission to unlock and access a data package that is secured with a protection policy. + +## -returns +When this method completes, it returns the results of the protection policy evaluation, which indicates whether or not the data is accessible. + +## -remarks + +## -examples + +## -see-also +[RequestAccessAsync(String)](datapackageview_requestaccessasync_1328635663.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/datapackageview_requestedoperation.md b/windows.applicationmodel.datatransfer/datapackageview_requestedoperation.md index 8b02a8446f..e9da0c75d5 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_requestedoperation.md +++ b/windows.applicationmodel.datatransfer/datapackageview_requestedoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataPackageView.RequestedOperation --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.RequestedOperation ## -description Gets the requested operation (such as copy or move). Primarily used for Clipboard actions. ## -property-value An enumeration that states what operation (such as copy or move) was completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackageView.RequestedOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.RequestedOperation + +## -description +Gets the requested operation (such as copy or move). Primarily used for Clipboard actions. + +## -property-value +An enumeration that states what operation (such as copy or move) was completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_setacceptedformatid_2028468240.md b/windows.applicationmodel.datatransfer/datapackageview_setacceptedformatid_2028468240.md index e63481a953..b034acb826 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_setacceptedformatid_2028468240.md +++ b/windows.applicationmodel.datatransfer/datapackageview_setacceptedformatid_2028468240.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.SetAcceptedFormatId(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.SetAcceptedFormatId ## -description Sets the accepted format Id. ## -parameters ### -param formatId The format Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.SetAcceptedFormatId(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.SetAcceptedFormatId + +## -description +Sets the accepted format Id. + +## -parameters +### -param formatId +The format Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_unlockandassumeenterpriseidentity_1652708962.md b/windows.applicationmodel.datatransfer/datapackageview_unlockandassumeenterpriseidentity_1652708962.md index 8ba89272ff..a737fecf59 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_unlockandassumeenterpriseidentity_1652708962.md +++ b/windows.applicationmodel.datatransfer/datapackageview_unlockandassumeenterpriseidentity_1652708962.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.UnlockAndAssumeEnterpriseIdentity --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataPackageView.UnlockAndAssumeEnterpriseIdentity ## -description Unlocks a data package and assumes an enterprise identity for it. ## -returns When this method completes, it returns the results of the protection policy evaluation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.UnlockAndAssumeEnterpriseIdentity +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.UnlockAndAssumeEnterpriseIdentity + +## -description +Unlocks a data package and assumes an enterprise identity for it. + +## -returns +When this method completes, it returns the results of the protection policy evaluation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/dataproviderdeferral_complete_1807836922.md b/windows.applicationmodel.datatransfer/dataproviderdeferral_complete_1807836922.md index a40a25395a..16873aec9a 100644 --- a/windows.applicationmodel.datatransfer/dataproviderdeferral_complete_1807836922.md +++ b/windows.applicationmodel.datatransfer/dataproviderdeferral_complete_1807836922.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataProviderDeferral.Complete ## -description Informs a [DataPackage](datapackage.md) that it is ready for processing. ## -remarks For clipboard scenarios, your app must call [Complete](dataproviderdeferral_complete.md) within 30 seconds of getting a deferral. For share scenarios, your app must call [Complete](dataproviderdeferral_complete.md) within 6 minutes. Be careful not to confuse this method with the [DataRequestDeferral.Complete](datarequestdeferral_complete.md) method that is used in share scenarios. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataProviderDeferral.Complete + +## -description +Informs a [DataPackage](datapackage.md) that it is ready for processing. + +## -remarks +For clipboard scenarios, your app must call [Complete](dataproviderdeferral_complete.md) within 30 seconds of getting a deferral. For share scenarios, your app must call [Complete](dataproviderdeferral_complete.md) within 6 minutes. + +Be careful not to confuse this method with the [DataRequestDeferral.Complete](datarequestdeferral_complete.md) method that is used in share scenarios. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/dataproviderrequest_deadline.md b/windows.applicationmodel.datatransfer/dataproviderrequest_deadline.md index e0ba8088b1..7765dbdcc1 100644 --- a/windows.applicationmodel.datatransfer/dataproviderrequest_deadline.md +++ b/windows.applicationmodel.datatransfer/dataproviderrequest_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataProviderRequest.Deadline --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataProviderRequest.Deadline ## -description Gets the deadline for finishing a delayed rendering operation. If execution goes beyond that deadline, the results of delayed rendering are ignored. ## -property-value The deadline for the delayed rendering operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataProviderRequest.Deadline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataProviderRequest.Deadline + +## -description +Gets the deadline for finishing a delayed rendering operation. If execution goes beyond that deadline, the results of delayed rendering are ignored. + +## -property-value +The deadline for the delayed rendering operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/dataproviderrequest_formatid.md b/windows.applicationmodel.datatransfer/dataproviderrequest_formatid.md index 1137c554a8..f77921e82e 100644 --- a/windows.applicationmodel.datatransfer/dataproviderrequest_formatid.md +++ b/windows.applicationmodel.datatransfer/dataproviderrequest_formatid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataProviderRequest.FormatId --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataProviderRequest.FormatId ## -description Specifies the format id. ## -property-value The format id. See [StandardDataFormats](standarddataformats.md) for more information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataProviderRequest.FormatId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataProviderRequest.FormatId + +## -description +Specifies the format id. + +## -property-value +The format id. See [StandardDataFormats](standarddataformats.md) for more information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md b/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md index 051b8a270e..088b19c959 100644 --- a/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md +++ b/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderRequest.GetDeferral --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataProviderRequest.GetDeferral - -## -description -Returns a [DataProviderDeferral](dataproviderdeferral.md) object. - -## -returns -An data provider deferral object. - -## -remarks -To learn more, check out [How to produce requested data asynchronously](http://msdn.microsoft.com/library/34c8bda2-807c-4142-a0fc-d80e62d9b6b2). - - - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cs[ShareFileFunction](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareEssentials1.xaml.cs#SnippetShareFileFunction)][!code-js[ShareFileFunction](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetShareFileFunction)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataProviderRequest.GetDeferral + +## -description +Returns a [DataProviderDeferral](dataproviderdeferral.md) object. + +## -returns +An data provider deferral object. + +## -remarks +To learn more, check out [How to produce requested data asynchronously](http://msdn.microsoft.com/library/34c8bda2-807c-4142-a0fc-d80e62d9b6b2). + + + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cs[ShareFileFunction](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareEssentials1.xaml.cs#SnippetShareFileFunction)][!code-js[ShareFileFunction](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetShareFileFunction)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/dataproviderrequest_setdata_987228704.md b/windows.applicationmodel.datatransfer/dataproviderrequest_setdata_987228704.md index e4f7e3fedc..bb3d6f298a 100644 --- a/windows.applicationmodel.datatransfer/dataproviderrequest_setdata_987228704.md +++ b/windows.applicationmodel.datatransfer/dataproviderrequest_setdata_987228704.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderRequest.SetData(System.Object) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataProviderRequest.SetData ## -description Sets the content of the [DataPackage](datapackage.md) to be shared with a target app. ## -parameters ### -param value The object associated with a particular format in the [DataPackage](datapackage.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderRequest.SetData(System.Object) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataProviderRequest.SetData + +## -description +Sets the content of the [DataPackage](datapackage.md) to be shared with a target app. + +## -parameters +### -param value +The object associated with a particular format in the [DataPackage](datapackage.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequest_data.md b/windows.applicationmodel.datatransfer/datarequest_data.md index 37841dc90b..9c6eda1008 100644 --- a/windows.applicationmodel.datatransfer/datarequest_data.md +++ b/windows.applicationmodel.datatransfer/datarequest_data.md @@ -1,32 +1,32 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataRequest.Data --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataRequest.Data - -## -description -Sets or gets a [DataPackage](datapackage.md) object that contains the content a user wants to share. - -## -property-value -Contains the content a user wants to share. - -## -remarks -The [Data](datarequest_data.md) property enables your app to supply data to a target app. Your app must supply this data by using a [DataPackage](datapackage.md) object. - -Use this property when your app has the content immediately available that the user wants to share. If you need to call a function to generate the [DataPackage](datapackage.md), use the [GetDeferral](datarequest_getdeferral.md) method. - -When your app cannot supply a [DataPackage](datapackage.md) object, use the [FailWithDisplayText](datarequest_failwithdisplaytext.md) method to cancel the share and provide a message that the target app can display to the user. - -## -examples -The following code shows how to get a [DataPackage](datapackage.md) object from the [Data](datarequest_data.md) property as part of setting the data on a [DataPackage](datapackage.md) to share with another app. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataRequest.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequest.Data + +## -description +Sets or gets a [DataPackage](datapackage.md) object that contains the content a user wants to share. + +## -property-value +Contains the content a user wants to share. + +## -remarks +The [Data](datarequest_data.md) property enables your app to supply data to a target app. Your app must supply this data by using a [DataPackage](datapackage.md) object. + +Use this property when your app has the content immediately available that the user wants to share. If you need to call a function to generate the [DataPackage](datapackage.md), use the [GetDeferral](datarequest_getdeferral.md) method. + +When your app cannot supply a [DataPackage](datapackage.md) object, use the [FailWithDisplayText](datarequest_failwithdisplaytext.md) method to cancel the share and provide a message that the target app can display to the user. + +## -examples +The following code shows how to get a [DataPackage](datapackage.md) object from the [Data](datarequest_data.md) property as part of setting the data on a [DataPackage](datapackage.md) to share with another app. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequest_deadline.md b/windows.applicationmodel.datatransfer/datarequest_deadline.md index ff18f9ad96..d4ffbf7eb5 100644 --- a/windows.applicationmodel.datatransfer/datarequest_deadline.md +++ b/windows.applicationmodel.datatransfer/datarequest_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataRequest.Deadline --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataRequest.Deadline ## -description Gets the deadline for finishing a delayed rendering operation. If execution goes beyond that deadline, the results of delayed rendering are ignored. ## -property-value The deadline for the delayed rendering operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataRequest.Deadline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequest.Deadline + +## -description +Gets the deadline for finishing a delayed rendering operation. If execution goes beyond that deadline, the results of delayed rendering are ignored. + +## -property-value +The deadline for the delayed rendering operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequest_failwithdisplaytext_760676443.md b/windows.applicationmodel.datatransfer/datarequest_failwithdisplaytext_760676443.md index 9ee730afa1..868976a0e3 100644 --- a/windows.applicationmodel.datatransfer/datarequest_failwithdisplaytext_760676443.md +++ b/windows.applicationmodel.datatransfer/datarequest_failwithdisplaytext_760676443.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.DataRequest.FailWithDisplayText(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.DataRequest.FailWithDisplayText ## -description Cancels the sharing operation and supplies an error string to display to the user. ## -parameters ### -param value The text to display to the user. ## -remarks Use the **FailWithDisplayText** method when your app is unable to supply a [DataPackage](datapackage.md) to a target app. This method cancels the share operation and supplies a text message to the target app. The target app can then display this text to the user to explain why the share operation failed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataRequest.FailWithDisplayText(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequest.FailWithDisplayText + +## -description +Cancels the sharing operation and supplies an error string to display to the user. + +## -parameters +### -param value +The text to display to the user. + +## -remarks +Use the **FailWithDisplayText** method when your app is unable to supply a [DataPackage](datapackage.md) to a target app. This method cancels the share operation and supplies a text message to the target app. The target app can then display this text to the user to explain why the share operation failed. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md b/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md index 2ef2efa30a..d9e64eae74 100644 --- a/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md +++ b/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md @@ -1,30 +1,30 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral - -## -description -Supports asynchronous sharing operations by creating and returning a [DataRequestDeferral](datarequestdeferral.md) object. - -## -returns -An object that allows you to share or send content asynchronously. - -## -remarks -The **GetDeferral** method allows your app to call a function during a share operation, so that your app can asynchronously generate the [DataPackage](datapackage.md) object for the target app. - -Use this method when you want to use an asynchronous function call to generate the [DataPackage](datapackage.md) during a share operation. This function must return a [DataPackage](datapackage.md) object within 200ms to prevent the operation from timing out. If your app shares content that takes more time to package, such as a collection of files or photos, don't use this method. Instead, use the [SetDataProvider](datapackage_setdataprovider.md) method to assign a delegate to a [DataPackage](datapackage.md) and return that [DataPackage](datapackage.md) to the target app. - -## -examples -The following sample shows how to get a [DataRequestDeferral](datarequestdeferral.md) object by using the **GetDeferral** method. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral + +## -description +Supports asynchronous sharing operations by creating and returning a [DataRequestDeferral](datarequestdeferral.md) object. + +## -returns +An object that allows you to share or send content asynchronously. + +## -remarks +The **GetDeferral** method allows your app to call a function during a share operation, so that your app can asynchronously generate the [DataPackage](datapackage.md) object for the target app. + +Use this method when you want to use an asynchronous function call to generate the [DataPackage](datapackage.md) during a share operation. This function must return a [DataPackage](datapackage.md) object within 200ms to prevent the operation from timing out. If your app shares content that takes more time to package, such as a collection of files or photos, don't use this method. Instead, use the [SetDataProvider](datapackage_setdataprovider.md) method to assign a delegate to a [DataPackage](datapackage.md) and return that [DataPackage](datapackage.md) to the target app. + +## -examples +The following sample shows how to get a [DataRequestDeferral](datarequestdeferral.md) object by using the **GetDeferral** method. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md b/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md index 483c5552bb..120453d282 100644 --- a/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md +++ b/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md @@ -1,25 +1,25 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete - -## -description -Indicates that the content for an asynchronous share is ready for a target app, or that an error in the sharing operation occurred. - -## -remarks -Your app must call the **complete** method when its finished adding data to a [DataPackage](datapackage.md). - -## -examples -This example shows how to call the **complete** method after getting a [DataRequestDeferral](datarequestdeferral.md) object. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete + +## -description +Indicates that the content for an asynchronous share is ready for a target app, or that an error in the sharing operation occurred. + +## -remarks +Your app must call the **complete** method when its finished adding data to a [DataPackage](datapackage.md). + +## -examples +This example shows how to call the **complete** method after getting a [DataRequestDeferral](datarequestdeferral.md) object. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequestedeventargs_request.md b/windows.applicationmodel.datatransfer/datarequestedeventargs_request.md index e7c99851a6..022b3a0478 100644 --- a/windows.applicationmodel.datatransfer/datarequestedeventargs_request.md +++ b/windows.applicationmodel.datatransfer/datarequestedeventargs_request.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.DataRequestedEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.DataRequestedEventArgs.Request ## -description Enables you to get the [DataRequest](datarequest.md) object and either give it data or a failure message. ## -property-value The object used to manage content as part of a share operation. ## -remarks When a user invokes the Share UI to share content, the system fires a [datarequested](datatransfermanager_datarequested.md) event. The **request** property of the event contains a [DataRequest](datarequest.md) object, which lets your app supply the information the user wants to share. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequestedEventArgs.Request + +## -description +Enables you to get the [DataRequest](datarequest.md) object and either give it data or a failure message. + +## -property-value +The object used to manage content as part of a share operation. + +## -remarks +When a user invokes the Share UI to share content, the system fires a [datarequested](datatransfermanager_datarequested.md) event. The **request** property of the event contains a [DataRequest](datarequest.md) object, which lets your app supply the information the user wants to share. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md b/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md index f02110ef16..7d28002356 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md @@ -1,29 +1,29 @@ ---- --api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested --api-type: winrt event ---- - - - -# Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested - -## -description -Occurs when a share operation starts. - -## -remarks -This event is fired when a sharing operation starts— typically when the user taps the Share charm, although it is also fired if your app starts a share operation programmatically. To handle this event, you need to add an event listener to the [DataTransferManager](datatransfermanager.md) object for the active window. You can get this object through the [GetForCurrentView](datatransfermanager_getforcurrentview.md) method. - -When handling a **datarequested** event, the most important property you need to be aware of is its [request](datarequestedeventargs_request.md) property. This property contains a [DataRequest](datarequest.md) object. Your app uses this object to provide the data that the user wants to share with a selected target app. - - - -## -examples -This example uses an inline function to handle a **datarequested** event. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested + +## -description +Occurs when a share operation starts. + +## -remarks +This event is fired when a sharing operation starts— typically when the user taps the Share charm, although it is also fired if your app starts a share operation programmatically. To handle this event, you need to add an event listener to the [DataTransferManager](datatransfermanager.md) object for the active window. You can get this object through the [GetForCurrentView](datatransfermanager_getforcurrentview.md) method. + +When handling a **datarequested** event, the most important property you need to be aware of is its [request](datarequestedeventargs_request.md) property. This property contains a [DataRequest](datarequest.md) object. Your app uses this object to provide the data that the user wants to share with a selected target app. + + + +## -examples +This example uses an inline function to handle a **datarequested** event. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md b/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md index 6e5ff72c09..5e5536dc2e 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView - -## -description -Returns the [DataTransferManager](datatransfermanager.md) object associated with the current window. - -## -returns -The [DataTransferManager](datatransfermanager.md) object associated with the current window. - -## -remarks -Each window has a [DataTransferManager](datatransfermanager.md) object associated with it. When sharing content, you use the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object that is associated with the active window. After you have the appropriate [DataTransferManager](datatransfermanager.md) object, you can add an event listener to it to handle the [DataRequested](datatransfermanager_datarequested.md) event, which the system fires when a share operation is initiated. Your app uses the [DataRequest](datarequest.md) object returned with this event to set the data that the user wants to share with a target app. - -## -examples -This example calls the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object associated with the active window for the app. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView + +## -description +Returns the [DataTransferManager](datatransfermanager.md) object associated with the current window. + +## -returns +The [DataTransferManager](datatransfermanager.md) object associated with the current window. + +## -remarks +Each window has a [DataTransferManager](datatransfermanager.md) object associated with it. When sharing content, you use the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object that is associated with the active window. After you have the appropriate [DataTransferManager](datatransfermanager.md) object, you can add an event listener to it to handle the [DataRequested](datatransfermanager_datarequested.md) event, which the system fires when a share operation is initiated. Your app uses the [DataRequest](datarequest.md) object returned with this event to set the data that the user wants to share with a target app. + +## -examples +This example calls the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object associated with the active window for the app. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_1578854276.md b/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_1578854276.md index 37f2cc9fd2..61dbc268a5 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_1578854276.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_1578854276.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI - -## -description -Programmatically initiates the user interface for sharing content with another app. - -## -remarks -We recommend that you use this method only when absolutely necessary. Users expect to launch the Share user interface through the Share charm. Launching the user interface programmatically can create a confusing user experience. - -As a general rule, use this method only when it isn't obvious to a user that some content is shareable. For example, if a user gets a high score in a game, it may not be obvious that they can share that high score with their friends. In this situation, it makes sense to use the **showShareUI** method. - -A [DataPackage](datapackage.md) must have its [Title](datapackagepropertyset_title.md) set in order to be shared. Ensure [Title](datapackagepropertyset_title.md) is set before calling this method. - -## -examples -This example demonstrates how to call the **ShowShareUI** method to launch the Share user interface. Notice that this example only launches the interface— it does not add any content to share with another app. - - - -[!code-js[DataTransferManager_3](../windows.applicationmodel.datatransfer/code/DataTransferManagerSample/javascript/DataTransferClassSample/js/default.js#SnippetDataTransferManager_3)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI + +## -description +Programmatically initiates the user interface for sharing content with another app. + +## -remarks +We recommend that you use this method only when absolutely necessary. Users expect to launch the Share user interface through the Share charm. Launching the user interface programmatically can create a confusing user experience. + +As a general rule, use this method only when it isn't obvious to a user that some content is shareable. For example, if a user gets a high score in a game, it may not be obvious that they can share that high score with their friends. In this situation, it makes sense to use the **showShareUI** method. + +A [DataPackage](datapackage.md) must have its [Title](datapackagepropertyset_title.md) set in order to be shared. Ensure [Title](datapackagepropertyset_title.md) is set before calling this method. + +## -examples +This example demonstrates how to call the **ShowShareUI** method to launch the Share user interface. Notice that this example only launches the interface— it does not add any content to share with another app. + + + +[!code-js[DataTransferManager_3](../windows.applicationmodel.datatransfer/code/DataTransferManagerSample/javascript/DataTransferClassSample/js/default.js#SnippetDataTransferManager_3)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_targetapplicationchosen.md b/windows.applicationmodel.datatransfer/datatransfermanager_targetapplicationchosen.md index 3b6dcd864b..24a9c3818c 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_targetapplicationchosen.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_targetapplicationchosen.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.TargetApplicationChosen --api-type: winrt event ---- # Windows.ApplicationModel.DataTransfer.DataTransferManager.TargetApplicationChosen ## -description Occurs when the user chooses a target app in the Share charm. ## -remarks When the user chooses a target app to share content with, the system fires a **TargetApplicationChosen** event. The app receiving the event can use this event to record information about the target app for business intelligence. A common use of this event is to record which applications are used to complete different sharing actions, which in turn can help the source app create better experiences for the user. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.TargetApplicationChosen +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.TargetApplicationChosen + +## -description +Occurs when the user chooses a target app in the Share charm. + +## -remarks +When the user chooses a target app to share content with, the system fires a **TargetApplicationChosen** event. The app receiving the event can use this event to record information about the target app for business intelligence. A common use of this event is to record which applications are used to complete different sharing actions, which in turn can help the source app create better experiences for the user. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md b/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md index 80ecb82feb..c61299e6a7 100644 --- a/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md +++ b/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat - -## -description -Takes a string that represents HTML content and adds the necessary headers to ensure it is formatted correctly for share and Clipboard operations. - -## -parameters -### -param htmlFragment -A string representing the HTML content. - -## -returns -A string representing the formatted HTML. - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat + +## -description +Takes a string that represents HTML content and adds the necessary headers to ensure it is formatted correctly for share and Clipboard operations. + +## -parameters +### -param htmlFragment +A string representing the HTML content. + +## -returns +A string representing the formatted HTML. + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/htmlformathelper_getstaticfragment_614198372.md b/windows.applicationmodel.datatransfer/htmlformathelper_getstaticfragment_614198372.md index ba5f1aa841..ea4c74f4a7 100644 --- a/windows.applicationmodel.datatransfer/htmlformathelper_getstaticfragment_614198372.md +++ b/windows.applicationmodel.datatransfer/htmlformathelper_getstaticfragment_614198372.md @@ -1,30 +1,30 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.GetStaticFragment(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.GetStaticFragment - -## -description -Gets a string that represents an HTML fragment. - -## -parameters -### -param htmlFormat -The formatted HTML. - -## -returns -An HTML fragment based on the formatted HTML. - -## -remarks -As a security precaution, you shouldn't display HTML unless you're sure it doesn't have any dynamic content. You can use the `GetStaticFragment` method to get shared HTML content without any dynamic elements such as script tags. - -## -examples - - -[!code-js[HowToReceiveSharedHtml](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceiveSharedHtml.js#SnippetHowToReceiveSharedHtml)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.GetStaticFragment(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.GetStaticFragment + +## -description +Gets a string that represents an HTML fragment. + +## -parameters +### -param htmlFormat +The formatted HTML. + +## -returns +An HTML fragment based on the formatted HTML. + +## -remarks +As a security precaution, you shouldn't display HTML unless you're sure it doesn't have any dynamic content. You can use the `GetStaticFragment` method to get shared HTML content without any dynamic elements such as script tags. + +## -examples + + +[!code-js[HowToReceiveSharedHtml](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceiveSharedHtml.js#SnippetHowToReceiveSharedHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/operationcompletedeventargs_acceptedformatid.md b/windows.applicationmodel.datatransfer/operationcompletedeventargs_acceptedformatid.md index c0315b7a1d..592cbf9306 100644 --- a/windows.applicationmodel.datatransfer/operationcompletedeventargs_acceptedformatid.md +++ b/windows.applicationmodel.datatransfer/operationcompletedeventargs_acceptedformatid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.AcceptedFormatId --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.AcceptedFormatId ## -description Gets the accepted format Id. ## -property-value The accepted format Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.AcceptedFormatId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.AcceptedFormatId + +## -description +Gets the accepted format Id. + +## -property-value +The accepted format Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/operationcompletedeventargs_operation.md b/windows.applicationmodel.datatransfer/operationcompletedeventargs_operation.md index 249c79aea3..b8f507195c 100644 --- a/windows.applicationmodel.datatransfer/operationcompletedeventargs_operation.md +++ b/windows.applicationmodel.datatransfer/operationcompletedeventargs_operation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.Operation --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.Operation ## -description Specifies the operation that the target app completed. ## -property-value An enumeration that specifies what operation (such as copy or move) was completed. At most one operation flag can be set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.OperationCompletedEventArgs.Operation + +## -description +Specifies the operation that the target app completed. + +## -property-value +An enumeration that specifies what operation (such as copy or move) was completed. At most one operation flag can be set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager.md b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager.md index 7cfa2b7175..b504659373 100644 --- a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager.md +++ b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager.md @@ -1,3 +1,82 @@ ---- -api-id: T:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager --api-type: winrt class ---- # Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager ## -description Enables an app to share a file with another app by passing a token via Uri activation, app service, REST API, etc. The target app redeems the token to get the file shared by the source app. ## -remarks Here is the sequence of steps that enables an app to share a file with another app by passing a token as part of a Uri activation, for example. + The source app calls the [AddFile](sharedstorageaccessmanager_addfile.md) method to get the sharing token that it passes to the target app, which it launches with a Uri. + The target app calls the [RedeemTokenForFileAsync](sharedstorageaccessmanager_redeemtokenforfileasync.md) method to get the shared file. + Optionally, the source app can call the [RemoveFile](sharedstorageaccessmanager_removefile.md) method to revoke a token that it obtained previously by calling the [AddFile](sharedstorageaccessmanager_addfile.md) method. For more info about Uri activation, see [Launch the default app for a URI](http://msdn.microsoft.com/library/7b0d0af5-d89e-4db0-9b79-90201d79974f). The use of the [SharedStorageAccessManager](sharedstorageaccessmanager.md) class and of sharing tokens is subject to the following requirements and restrictions. + A sharing token can only be redeemed one time. After that, the token is no longer valid. + A sharing token expires after 14 days and is no longer valid. + The source app cannot get more than one thousand sharing tokens. After a token is redeemed, removed, or expires, however, it no longer counts against the quota of the source app. ## -examples In the following example, a source app launches a mapping app and provides a .gpx file that contains driving directions to be displayed by the target app. First, the source app gets a token for the .gpx file and uses protocol activation to launch the target app. ```csharp public async void ShareMostRecentDirections() { // Get the most recently opened .gpx file // from the recently used file list. StorageItemMostRecentlyUsedList mostRecent = StorageApplicationPermissions.MostRecentlyUsedList; String mruToken = mostRecent.Entries.FirstOrDefault().Token; StorageFile file = await mostRecent.GetFileAsync(mruToken); // Get the token to share access to the updated .gpx file. String sharingToken = SharedStorageAccessManager.AddFile(file); //Launch the driving application . Uri driveTo = new Uri("nokia-drive-to:?Gpxfile=" + sharingToken); var launch = await Launcher.LaunchURIAsync(driveTo); } ``` Next, the target app gets the .gpx file by providing the token received from the source app. ```csharp protected override async void OnActivated(IActivatedEventArgs args) { var protocolArgs = args as ProtocolActivatedEventArgs; // Get the token from the URI. var queryStrings = new WwwFormUrlDecoder(protocolArgs.Uri.Query); string gpxFileToken = queryStrings.GetFirstValueByName("GpxFile"); // Get the .gpx file and call a custom method // to display driving directions. if (!string.IsNullOrEmpty(gpxFileToken)) { PlotGpxFile(await SharedStorageAccessManager.RedeemTokenForFileAsync(gpxFileToken)); } } ``` ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager + +## -description +Enables an app to share a file with another app by passing a token via Uri activation, app service, REST API, etc. The target app redeems the token to get the file shared by the source app. + +## -remarks +Here is the sequence of steps that enables an app to share a file with another app by passing a token as part of a Uri activation, for example. + + ++ The source app calls the [AddFile](sharedstorageaccessmanager_addfile.md) method to get the sharing token that it passes to the target app, which it launches with a Uri. ++ The target app calls the [RedeemTokenForFileAsync](sharedstorageaccessmanager_redeemtokenforfileasync.md) method to get the shared file. ++ Optionally, the source app can call the [RemoveFile](sharedstorageaccessmanager_removefile.md) method to revoke a token that it obtained previously by calling the [AddFile](sharedstorageaccessmanager_addfile.md) method. +For more info about Uri activation, see [Launch the default app for a URI](http://msdn.microsoft.com/library/7b0d0af5-d89e-4db0-9b79-90201d79974f). + +The use of the [SharedStorageAccessManager](sharedstorageaccessmanager.md) class and of sharing tokens is subject to the following requirements and restrictions. + + ++ A sharing token can only be redeemed one time. After that, the token is no longer valid. ++ A sharing token expires after 14 days and is no longer valid. ++ The source app cannot get more than one thousand sharing tokens. After a token is redeemed, removed, or expires, however, it no longer counts against the quota of the source app. + + +## -examples +In the following example, a source app launches a mapping app and provides a .gpx file that contains driving directions to be displayed by the target app. + +First, the source app gets a token for the .gpx file and uses protocol activation to launch the target app. + +```csharp +public async void ShareMostRecentDirections() +{ + // Get the most recently opened .gpx file + // from the recently used file list. + StorageItemMostRecentlyUsedList mostRecent = + StorageApplicationPermissions.MostRecentlyUsedList; + + String mruToken = mostRecent.Entries.FirstOrDefault().Token; + StorageFile file = await mostRecent.GetFileAsync(mruToken); + + // Get the token to share access to the updated .gpx file. + String sharingToken = SharedStorageAccessManager.AddFile(file); + + //Launch the driving application . + Uri driveTo = new Uri("nokia-drive-to:?Gpxfile=" + sharingToken); + var launch = await Launcher.LaunchURIAsync(driveTo); +} + +``` + +Next, the target app gets the .gpx file by providing the token received from the source app. + +```csharp +protected override async void OnActivated(IActivatedEventArgs args) +{ + var protocolArgs = args as ProtocolActivatedEventArgs; + + // Get the token from the URI. + var queryStrings = new WwwFormUrlDecoder(protocolArgs.Uri.Query); + string gpxFileToken = queryStrings.GetFirstValueByName("GpxFile"); + + // Get the .gpx file and call a custom method + // to display driving directions. + if (!string.IsNullOrEmpty(gpxFileToken)) + { + PlotGpxFile(await + SharedStorageAccessManager.RedeemTokenForFileAsync(gpxFileToken)); + } +} + +``` + + + +## -see-also diff --git a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_addfile_731286892.md b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_addfile_731286892.md index ce6542a56c..6c621e8481 100644 --- a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_addfile_731286892.md +++ b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_addfile_731286892.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.AddFile(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.AddFile ## -description Gets the sharing token that enables an app to share the specified file with another app. ## -parameters ### -param file The file to share with the target app. ## -returns The sharing token to provide to the target app . ## -remarks When a source app shares a file with a target app, the source app calls the [AddFile](sharedstorageaccessmanager_addfile.md) method to get the sharing token that it passes to the target app. For a code sample, see [SharedStorageAccessManager](sharedstorageaccessmanager.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.AddFile(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.AddFile + +## -description +Gets the sharing token that enables an app to share the specified file with another app. + +## -parameters +### -param file +The file to share with the target app. + +## -returns +The sharing token to provide to the target app . + +## -remarks +When a source app shares a file with a target app, the source app calls the [AddFile](sharedstorageaccessmanager_addfile.md) method to get the sharing token that it passes to the target app. + +For a code sample, see [SharedStorageAccessManager](sharedstorageaccessmanager.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_redeemtokenforfileasync_2095026872.md b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_redeemtokenforfileasync_2095026872.md index 2ee6cbbb2a..af3703673a 100644 --- a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_redeemtokenforfileasync_2095026872.md +++ b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_redeemtokenforfileasync_2095026872.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RedeemTokenForFileAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RedeemTokenForFileAsync ## -description Gets a file shared by another app by providing the sharing token received from the source app. ## -parameters ### -param token The sharing token for the shared file. ## -returns A wrapper object that contains the shared file. ## -remarks When a source app shares a file with a target app, the target app calls the [RedeemTokenForFileAsync](sharedstorageaccessmanager_redeemtokenforfileasync.md) method to get the shared file. For a code sample, see [SharedStorageAccessManager](sharedstorageaccessmanager.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RedeemTokenForFileAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RedeemTokenForFileAsync + +## -description +Gets a file shared by another app by providing the sharing token received from the source app. + +## -parameters +### -param token +The sharing token for the shared file. + +## -returns +A wrapper object that contains the shared file. + +## -remarks +When a source app shares a file with a target app, the target app calls the [RedeemTokenForFileAsync](sharedstorageaccessmanager_redeemtokenforfileasync.md) method to get the shared file. + +For a code sample, see [SharedStorageAccessManager](sharedstorageaccessmanager.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_removefile_245169084.md b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_removefile_245169084.md index 0161f43430..8c51f2b3c2 100644 --- a/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_removefile_245169084.md +++ b/windows.applicationmodel.datatransfer/sharedstorageaccessmanager_removefile_245169084.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RemoveFile(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RemoveFile ## -description Revokes an existing sharing token. ## -parameters ### -param token The sharing token to revoke. ## -remarks The source app can optionally call the [RemoveFile](sharedstorageaccessmanager_removefile.md) method to revoke a token that it obtained previously by calling the [AddFile](sharedstorageaccessmanager_addfile.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RemoveFile(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.SharedStorageAccessManager.RemoveFile + +## -description +Revokes an existing sharing token. + +## -parameters +### -param token +The sharing token to revoke. + +## -remarks +The source app can optionally call the [RemoveFile](sharedstorageaccessmanager_removefile.md) method to revoke a token that it obtained previously by calling the [AddFile](sharedstorageaccessmanager_addfile.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_applicationlink.md b/windows.applicationmodel.datatransfer/standarddataformats_applicationlink.md index 9f670e7d75..dad4e5055e 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_applicationlink.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_applicationlink.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.ApplicationLink --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.StandardDataFormats.ApplicationLink ## -description A read-only property that returns the format ID string value corresponding to the activation link format. ## -property-value The format ID string value corresponding to the application link format. ## -remarks An application link represents a Uniform Resource Identifier (URI) with a scheme that isn't **http** or **https** that can be handled by a Windows Store app. The referenced app must be capable of being the default handler for the Uniform Resource Identifier (URI) scheme, although it may not be set as the default handler. ## -examples ## -see-also [SetApplicationLink](datapackage_setapplicationlink.md), [GetApplicationLinkAsync](datapackageview_getapplicationlinkasync.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.ApplicationLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.ApplicationLink + +## -description +A read-only property that returns the format ID string value corresponding to the activation link format. + +## -property-value +The format ID string value corresponding to the application link format. + +## -remarks +An application link represents a Uniform Resource Identifier (URI) with a scheme that isn't **http** or **https** that can be handled by a Windows Store app. The referenced app must be capable of being the default handler for the Uniform Resource Identifier (URI) scheme, although it may not be set as the default handler. + +## -examples + +## -see-also +[SetApplicationLink](datapackage_setapplicationlink.md), [GetApplicationLinkAsync](datapackageview_getapplicationlinkasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md b/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md index 2d39208c7b..02d2eade17 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md @@ -1,27 +1,27 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap - -## -description -A read-only property that returns the format ID string value corresponding to the Bitmap format. - -## -property-value -The format ID string value corresponding to the Bitmap format. - -## -remarks - -## -examples -This example demonstrates the use of the **Bitmap** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap + +## -description +A read-only property that returns the format ID string value corresponding to the Bitmap format. + +## -property-value +The format ID string value corresponding to the Bitmap format. + +## -remarks + +## -examples +This example demonstrates the use of the **Bitmap** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)][!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_html.md b/windows.applicationmodel.datatransfer/standarddataformats_html.md index 33c9ad3985..25fcd724cd 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_html.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_html.md @@ -1,27 +1,27 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Html --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Html - -## -description -A read-only property that returns the format ID string value corresponding to the HTML format. - -## -property-value -The format ID string value corresponding to the HTML format. - -## -remarks - -## -examples -This example demonstrates the use of the **Html** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Html +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Html + +## -description +A read-only property that returns the format ID string value corresponding to the HTML format. + +## -property-value +The format ID string value corresponding to the HTML format. + +## -remarks + +## -examples +This example demonstrates the use of the **Html** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)][!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_rtf.md b/windows.applicationmodel.datatransfer/standarddataformats_rtf.md index ec669a1499..5ce179bafe 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_rtf.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_rtf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Rtf --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.StandardDataFormats.Rtf ## -description A read-only property that returns the format ID string value corresponding to the Rich Text Format (RTF). ## -property-value The format ID string value corresponding to the Rich Text Format (RTF) format. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Rtf +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Rtf + +## -description + A read-only property that returns the format ID string value corresponding to the Rich Text Format (RTF). + +## -property-value +The format ID string value corresponding to the Rich Text Format (RTF) format. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md b/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md index b87f813c3d..b032e043c7 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md @@ -1,27 +1,27 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems - -## -description -A read-only property that returns the format ID string value corresponding to the StorageItem format. - -## -property-value -The format ID string value corresponding to the StorageItem format. - -## -remarks - -## -examples -This example demonstrates the use of the **StorageItems** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles)][!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems + +## -description +A read-only property that returns the format ID string value corresponding to the StorageItem format. + +## -property-value +The format ID string value corresponding to the StorageItem format. + +## -remarks + +## -examples +This example demonstrates the use of the **StorageItems** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles)][!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_text.md b/windows.applicationmodel.datatransfer/standarddataformats_text.md index bf92d35b80..0ae19955f8 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_text.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_text.md @@ -1,27 +1,27 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text - -## -description -A read-only property that returns the format ID string value corresponding to the Text format. - -## -property-value -The format ID string value corresponding to the Text format. - -## -remarks - -## -examples -This example demonstrates the use of the **Text** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text + +## -description +A read-only property that returns the format ID string value corresponding to the Text format. + +## -property-value +The format ID string value corresponding to the Text format. + +## -remarks + +## -examples +This example demonstrates the use of the **Text** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)][!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_uri.md b/windows.applicationmodel.datatransfer/standarddataformats_uri.md index f57e64bca5..b043999278 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_uri.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_uri.md @@ -1,30 +1,30 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Uri --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Uri - -## -description -> [!NOTE] -> [Uri](standarddataformats_uri.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ApplicationLink](standarddataformats_applicationlink.md) or [WebLink](standarddataformats_weblink.md). - -A read-only property that returns the format ID string value corresponding to the Uniform Resource Identifier (URI) format. - -## -property-value -The format ID string value corresponding to the Uniform Resource Identifier (URI) format. - -## -remarks - -## -examples -This example demonstrates the use of the **Uri** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareLinks.xaml.cs#SnippetHowToShareLink)][!code-js[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareLink.js#SnippetHowToShareLink)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Uri + +## -description +> [!NOTE] +> [Uri](standarddataformats_uri.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [ApplicationLink](standarddataformats_applicationlink.md) or [WebLink](standarddataformats_weblink.md). + +A read-only property that returns the format ID string value corresponding to the Uniform Resource Identifier (URI) format. + +## -property-value +The format ID string value corresponding to the Uniform Resource Identifier (URI) format. + +## -remarks + +## -examples +This example demonstrates the use of the **Uri** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +> [!div class="tabbedCodeSnippets"][!code-cs[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareLinks.xaml.cs#SnippetHowToShareLink)][!code-js[HowToShareLink](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareLink.js#SnippetHowToShareLink)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_weblink.md b/windows.applicationmodel.datatransfer/standarddataformats_weblink.md index 7b966b643c..3dbf0eef65 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_weblink.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_weblink.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.WebLink --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.StandardDataFormats.WebLink ## -description A read-only property that returns the format ID string value corresponding to the web link format. ## -property-value The format ID string value corresponding to the web link format. ## -remarks A web link represents a Uniform Resource Identifier (URI) with a scheme of **http** or **https**. These schemes are handled by a user's default web browser. ## -examples ## -see-also [SetWebLink](datapackage_setweblink.md), [GetWebLinkAsync](datapackageview_getweblinkasync.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.WebLink +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.WebLink + +## -description +A read-only property that returns the format ID string value corresponding to the web link format. + +## -property-value +The format ID string value corresponding to the web link format. + +## -remarks +A web link represents a Uniform Resource Identifier (URI) with a scheme of **http** or **https**. These schemes are handled by a user's default web browser. + +## -examples + +## -see-also +[SetWebLink](datapackage_setweblink.md), [GetWebLinkAsync](datapackageview_getweblinkasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.datatransfer/targetapplicationchoseneventargs_applicationname.md b/windows.applicationmodel.datatransfer/targetapplicationchoseneventargs_applicationname.md index 17b5f27765..5e84fc8d3a 100644 --- a/windows.applicationmodel.datatransfer/targetapplicationchoseneventargs_applicationname.md +++ b/windows.applicationmodel.datatransfer/targetapplicationchoseneventargs_applicationname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.DataTransfer.TargetApplicationChosenEventArgs.ApplicationName --api-type: winrt property ---- # Windows.ApplicationModel.DataTransfer.TargetApplicationChosenEventArgs.ApplicationName ## -description Contains the name of the app that the user chose to share content with. ## -property-value The name of the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.TargetApplicationChosenEventArgs.ApplicationName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.TargetApplicationChosenEventArgs.ApplicationName + +## -description +Contains the name of the app that the user chose to share content with. + +## -property-value +The name of the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection.md index 1d52bd6d11..7615a7ea5a 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection ## -description Represents a connection to a data provider client. ## -remarks Use the instance of this class provided by the [Connection](emaildataprovidertriggerdetails_connection.md) property of the [EmailDataProviderTriggerDetails](emaildataprovidertriggerdetails.md) object passed to your background task on activation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection + +## -description +Represents a connection to a data provider client. + +## -remarks +Use the instance of this class provided by the [Connection](emaildataprovidertriggerdetails_connection.md) property of the [EmailDataProviderTriggerDetails](emaildataprovidertriggerdetails.md) object passed to your background task on activation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_createfolderrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_createfolderrequested.md index 0e21c92605..fb41ba4444 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_createfolderrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_createfolderrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.CreateFolderRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.CreateFolderRequested ## -description Occurs when the email client has requested that a folder be created on the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.CreateFolderRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.CreateFolderRequested + +## -description +Occurs when the email client has requested that a folder be created on the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_deletefolderrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_deletefolderrequested.md index c6beb29ccc..c2fc24ac19 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_deletefolderrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_deletefolderrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DeleteFolderRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DeleteFolderRequested ## -description Occurs when the email client has requested that a folder be deleted on the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DeleteFolderRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DeleteFolderRequested + +## -description +Occurs when the email client has requested that a folder be deleted on the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadattachmentrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadattachmentrequested.md index 7abfe495df..0775b4493a 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadattachmentrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadattachmentrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadAttachmentRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadAttachmentRequested ## -description Occurs when the email client has requested to download an attachment from the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadAttachmentRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadAttachmentRequested + +## -description +Occurs when the email client has requested to download an attachment from the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadmessagerequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadmessagerequested.md index 985f8880a7..6db86ab389 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadmessagerequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_downloadmessagerequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadMessageRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadMessageRequested ## -description Occurs when the email client has requested to download a message from the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadMessageRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.DownloadMessageRequested + +## -description +Occurs when the email client has requested to download a message from the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_emptyfolderrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_emptyfolderrequested.md index 8ccf63deb7..a2216f1afc 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_emptyfolderrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_emptyfolderrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.EmptyFolderRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.EmptyFolderRequested ## -description Occurs when the email client has requested that a folder be emptied the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.EmptyFolderRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.EmptyFolderRequested + +## -description +Occurs when the email client has requested that a folder be emptied the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_forwardmeetingrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_forwardmeetingrequested.md index d24bdd4e53..153deeff78 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_forwardmeetingrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_forwardmeetingrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ForwardMeetingRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ForwardMeetingRequested ## -description Occurs when the email client has requested to forward a meeting request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ForwardMeetingRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ForwardMeetingRequested + +## -description +Occurs when the email client has requested to forward a meeting request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_getautoreplysettingsrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_getautoreplysettingsrequested.md index 78cdedd1d6..3ceed1a4ae 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_getautoreplysettingsrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_getautoreplysettingsrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.GetAutoReplySettingsRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.GetAutoReplySettingsRequested ## -description Occurs when the email client has requested the auto reply settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.GetAutoReplySettingsRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.GetAutoReplySettingsRequested + +## -description +Occurs when the email client has requested the auto reply settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_mailboxsyncrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_mailboxsyncrequested.md index 1046d1e63f..8afa10c5a6 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_mailboxsyncrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_mailboxsyncrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MailboxSyncRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MailboxSyncRequested ## -description Occurs when the email client has requested to sync with the mailbox on the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MailboxSyncRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MailboxSyncRequested + +## -description +Occurs when the email client has requested to sync with the mailbox on the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_movefolderrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_movefolderrequested.md index 854fb66058..a1a7851667 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_movefolderrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_movefolderrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MoveFolderRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MoveFolderRequested ## -description Occurs when the email client has requested that a folder be moved on the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MoveFolderRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.MoveFolderRequested + +## -description +Occurs when the email client has requested that a folder be moved on the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_proposenewtimeformeetingrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_proposenewtimeformeetingrequested.md index 66e4e0755d..e96df9b7b8 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_proposenewtimeformeetingrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_proposenewtimeformeetingrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ProposeNewTimeForMeetingRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ProposeNewTimeForMeetingRequested ## -description Occurs when the email client has requested that a new meeting time be proposed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ProposeNewTimeForMeetingRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ProposeNewTimeForMeetingRequested + +## -description +Occurs when the email client has requested that a new meeting time be proposed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_resolverecipientsrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_resolverecipientsrequested.md index 8e6be31618..09864ad4b6 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_resolverecipientsrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_resolverecipientsrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ResolveRecipientsRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ResolveRecipientsRequested ## -description Occurs when the email client has requested that the recipients of a message be resolved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ResolveRecipientsRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ResolveRecipientsRequested + +## -description +Occurs when the email client has requested that the recipients of a message be resolved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_serversearchreadbatchrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_serversearchreadbatchrequested.md index f28cf6b007..72bf4a5615 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_serversearchreadbatchrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_serversearchreadbatchrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ServerSearchReadBatchRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ServerSearchReadBatchRequested ## -description Occurs when the email client has requested a batch of server-side search results. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ServerSearchReadBatchRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ServerSearchReadBatchRequested + +## -description +Occurs when the email client has requested a batch of server-side search results. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_setautoreplysettingsrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_setautoreplysettingsrequested.md index 89654bb12d..f6cab3dfc4 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_setautoreplysettingsrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_setautoreplysettingsrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.SetAutoReplySettingsRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.SetAutoReplySettingsRequested ## -description Occurs when the email client has requested to set auto reply settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.SetAutoReplySettingsRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.SetAutoReplySettingsRequested + +## -description +Occurs when the email client has requested to set auto reply settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_start_1587696324.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_start_1587696324.md index 7d0a9597a2..bb73dece3e 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_start_1587696324.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.Start --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.Start ## -description Call this method to indicate that all event handlers have been set, and the data provider is ready to start handling requests. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.Start +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.Start + +## -description +Call this method to indicate that all event handlers have been set, and the data provider is ready to start handling requests. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_updatemeetingresponserequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_updatemeetingresponserequested.md index 669f7f0d99..907b94b04f 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_updatemeetingresponserequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_updatemeetingresponserequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.UpdateMeetingResponseRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.UpdateMeetingResponseRequested ## -description Occurs when the email client has requested that a meeting response be updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.UpdateMeetingResponseRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.UpdateMeetingResponseRequested + +## -description +Occurs when the email client has requested that a meeting response be updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_validatecertificatesrequested.md b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_validatecertificatesrequested.md index 468a06d5c5..8094cbede2 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_validatecertificatesrequested.md +++ b/windows.applicationmodel.email.dataprovider/emaildataproviderconnection_validatecertificatesrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ValidateCertificatesRequested --api-type: winrt event ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ValidateCertificatesRequested ## -description Occurs when the email client has requested that certificates be validated with respect to a particular mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ValidateCertificatesRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderConnection.ValidateCertificatesRequested + +## -description +Occurs when the email client has requested that certificates be validated with respect to a particular mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails.md b/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails.md index db8616194a..77a386e986 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails.md +++ b/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails ## -description Contains details about the event that triggered your email data provider background task. This event is triggered when an email data client app has instantiated the background task that runs your email data provider. Your code should respond to this event by using the connection to register event handlers for data provider request events. ## -remarks Your background task code is passed an instance of this class in the [IBackgroundTaskInstance.TriggerDetails](XREF:TODO:windows.applicationmodel.background.ibackgroundtaskinstance.triggerdetails) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails + +## -description +Contains details about the event that triggered your email data provider background task. + +This event is triggered when an email data client app has instantiated the background task that runs your email data provider. Your code should respond to this event by using the connection to register event handlers for data provider request events. + +## -remarks +Your background task code is passed an instance of this class in the [IBackgroundTaskInstance.TriggerDetails](XREF:TODO:windows.applicationmodel.background.ibackgroundtaskinstance.triggerdetails) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails_connection.md b/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails_connection.md index cae00b3172..667196bad7 100644 --- a/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails_connection.md +++ b/windows.applicationmodel.email.dataprovider/emaildataprovidertriggerdetails_connection.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails.Connection --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails.Connection ## -description Gets the [EmailDataProviderConnection](emaildataproviderconnection.md) to be used to communicate with an email client app. This event is triggered when an email data client app has instantiated the background task that runs your email data provider. Your code should respond to this event by using the connection to register an event handler for data provider request events. ## -property-value The connection your email data provider uses to communicate with an email client app. When you handler is triggered, your code should register event handlers on this connection for the email data provider events included in the [EmailDataProviderConnection](emaildataproviderconnection.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails.Connection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailDataProviderTriggerDetails.Connection + +## -description +Gets the [EmailDataProviderConnection](emaildataproviderconnection.md) to be used to communicate with an email client app. + +This event is triggered when an email data client app has instantiated the background task that runs your email data provider. Your code should respond to this event by using the connection to register an event handler for data provider request events. + +## -property-value +The connection your email data provider uses to communicate with an email client app. When you handler is triggered, your code should register event handlers on this connection for the email data provider events included in the [EmailDataProviderConnection](emaildataproviderconnection.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest.md index e1566050d4..259bab8458 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest ## -description Details of a request to create a folder. ## -remarks Used in your [CreateFolderRequested](emaildataproviderconnection_createfolderrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxCreateFolderRequestEventArgs.Request](emailmailboxcreatefolderrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest + +## -description +Details of a request to create a folder. + +## -remarks +Used in your [CreateFolderRequested](emaildataproviderconnection_createfolderrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxCreateFolderRequestEventArgs.Request](emailmailboxcreatefolderrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_emailmailboxid.md index 1fa03ae76a..4094912f8f 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.EmailMailboxId ## -description Gets the mailbox identifier for the mailbox where the new folder should be created. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.EmailMailboxId + +## -description +Gets the mailbox identifier for the mailbox where the new folder should be created. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_name.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_name.md index aacac58aa5..e7032b17a7 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_name.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.Name --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.Name ## -description Gets the name of the folder to be created. ## -property-value A folder name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.Name + +## -description +Gets the name of the folder to be created. + +## -property-value +A folder name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_parentfolderid.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_parentfolderid.md index 76bdc61b2d..200c9eaaf8 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_parentfolderid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_parentfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ParentFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ParentFolderId ## -description Gets the folder ID of the parent folder for the created folder. ## -property-value A folder ID. Get the parent folder's ID from its [EmailFolder.Id](../windows.applicationmodel.email/emailfolder_id.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ParentFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ParentFolderId + +## -description +Gets the folder ID of the parent folder for the created folder. + +## -property-value +A folder ID. Get the parent folder's ID from its [EmailFolder.Id](../windows.applicationmodel.email/emailfolder_id.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportcompletedasync_1734473677.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportcompletedasync_1734473677.md index dd5cebe172..32c0b0dfc8 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportcompletedasync_1734473677.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportcompletedasync_1734473677.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportCompletedAsync(Windows.ApplicationModel.Email.EmailFolder) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportCompletedAsync ## -description Informs the client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the folder was created successfully. ## -parameters ### -param folder An [EmailFolder](../windows.applicationmodel.email/emailfolder.md) representing the created folder. ## -returns An asynchronous create operation on an [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportCompletedAsync(Windows.ApplicationModel.Email.EmailFolder) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportCompletedAsync + +## -description +Informs the client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the folder was created successfully. + +## -parameters +### -param folder +An [EmailFolder](../windows.applicationmodel.email/emailfolder.md) representing the created folder. + +## -returns +An asynchronous create operation on an [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportfailedasync_192534692.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportfailedasync_192534692.md index bdd6d3d37b..6f78d056cb 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportfailedasync_192534692.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequest_reportfailedasync_192534692.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailMailboxCreateFolderStatus) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. Successful completion of the asynchronous action indicates that the status parameter's value reports the reason for failure. ## -parameters ### -param status An [EmailMailboxCreateFolderStatus](../windows.applicationmodel.email/emailmailboxcreatefolderstatus.md) value indicating why the operation failed. ## -returns An asynchronous create operation on an [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailMailboxCreateFolderStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +Successful completion of the asynchronous action indicates that the status parameter's value reports the reason for failure. + +## -parameters +### -param status +An [EmailMailboxCreateFolderStatus](../windows.applicationmodel.email/emailmailboxcreatefolderstatus.md) value indicating why the operation failed. + +## -returns +An asynchronous create operation on an [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs.md index be880abbba..a5a033488c 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs ## -description Encapsulates information about a folder creation request event. ## -remarks Use the instance of this class that is passed as an argument to your [CreateFolderRequested](emaildataproviderconnection_createfolderrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs + +## -description +Encapsulates information about a folder creation request event. + +## -remarks +Use the instance of this class that is passed as an argument to your [CreateFolderRequested](emaildataproviderconnection_createfolderrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_getdeferral_254836512.md index 30ea9f2315..dedfb654a5 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_request.md index d0ae4328ae..498746ec98 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxcreatefolderrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.Request ## -description Gets the [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object that describes the details of this request. ## -property-value A [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object that describes the folder creation operation to be performed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxCreateFolderRequestEventArgs.Request + +## -description +Gets the [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object that describes the details of this request. + +## -property-value +A [EmailMailboxCreateFolderRequest](emailmailboxcreatefolderrequest.md) object that describes the folder creation operation to be performed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest.md index fcc32fb6a0..5dce491922 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest ## -description Details of a request to delete a folder. ## -remarks Used in your [DeleteFolderRequested](emaildataproviderconnection_deletefolderrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxDeleteFolderRequestEventArgs.Request](emailmailboxdownloadmessagerequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest + +## -description +Details of a request to delete a folder. + +## -remarks +Used in your [DeleteFolderRequested](emaildataproviderconnection_deletefolderrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxDeleteFolderRequestEventArgs.Request](emailmailboxdownloadmessagerequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailfolderid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailfolderid.md index 96e1ed8e27..76718f4da2 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailfolderid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailFolderId ## -description Gets the folder ID of the folder to be deleted. ## -property-value The folder ID of the folder to be deleted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailFolderId + +## -description +Gets the folder ID of the folder to be deleted. + +## -property-value +The folder ID of the folder to be deleted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailmailboxid.md index c7729e303e..575501a66a 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailMailboxId ## -description Gets the mailbox identifier for the mailbox where the folder will be deleted. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.EmailMailboxId + +## -description +Gets the mailbox identifier for the mailbox where the folder will be deleted. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportcompletedasync_1707664681.md index d41bb273d6..cf3fb122d8 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the folder was deleted successfully. ## -returns An asynchronous delete operation on an [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the folder was deleted successfully. + +## -returns +An asynchronous delete operation on an [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportfailedasync_81082908.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportfailedasync_81082908.md index 58a96efd2b..0f7510ac53 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportfailedasync_81082908.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequest_reportfailedasync_81082908.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailMailboxDeleteFolderStatus) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. Successful completion of the asynchronous action indicates that the status parameter's value reports the reason for failure. ## -parameters ### -param status A [EmailMailboxDeleteFolderStatus](../windows.applicationmodel.email/emailmailboxdeletefolderstatus.md) value indicating why the operation failed. ## -returns An asynchronous delete operation on an [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailMailboxDeleteFolderStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +Successful completion of the asynchronous action indicates that the status parameter's value reports the reason for failure. + +## -parameters +### -param status +A [EmailMailboxDeleteFolderStatus](../windows.applicationmodel.email/emailmailboxdeletefolderstatus.md) value indicating why the operation failed. + +## -returns +An asynchronous delete operation on an [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs.md index 92285de7bb..fe320bf61d 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs ## -description Encapusulates information about a folder deletion request event. ## -remarks Use the instance of this class that is passed as an argument to your [DeleteFolderRequested](emaildataproviderconnection_deletefolderrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs + +## -description +Encapusulates information about a folder deletion request event. + +## -remarks +Use the instance of this class that is passed as an argument to your [DeleteFolderRequested](emaildataproviderconnection_deletefolderrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_getdeferral_254836512.md index 1bf723036a..0dceae5f3d 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_request.md index 1aad2e2344..004ebe019b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdeletefolderrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.Request ## -description Gets the [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object that describes the details of this request. ## -property-value An [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object that describes the folder deletion operation to be performed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDeleteFolderRequestEventArgs.Request + +## -description +Gets the [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object that describes the details of this request. + +## -property-value +An [EmailMailboxDeleteFolderRequest](emailmailboxdeletefolderrequest.md) object that describes the folder deletion operation to be performed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest.md index 07be51a827..f5655de1a4 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest ## -description Details of a request to download an attachment. ## -remarks Used in your [DownloadAttachmentRequest](emaildataproviderconnection_downloadattachmentrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxDownloadAttachmentRequestEventArgs.Request](emailmailboxdownloadattachmentrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest + +## -description +Details of a request to download an attachment. + +## -remarks +Used in your [DownloadAttachmentRequest](emaildataproviderconnection_downloadattachmentrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxDownloadAttachmentRequestEventArgs.Request](emailmailboxdownloadattachmentrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailattachmentid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailattachmentid.md index 3b944493b1..fc66b65aa2 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailattachmentid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailattachmentid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailAttachmentId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailAttachmentId ## -description Gets the attachment ID of the attachment to be downloaded. ## -property-value The ID of the attachment. Use the [EmailAttachment.Id](../windows.applicationmodel.email/emailattachment_id.md) value for the attachment you want to download. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailAttachmentId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailAttachmentId + +## -description +Gets the attachment ID of the attachment to be downloaded. + +## -property-value +The ID of the attachment. Use the [EmailAttachment.Id](../windows.applicationmodel.email/emailattachment_id.md) value for the attachment you want to download. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmailboxid.md index c3e64c9c5a..7b92ad1b3e 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMailboxId ## -description Gets the email mailbox ID. ## -property-value The mailbox ID of the mailbox that holds the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMailboxId + +## -description +Gets the email mailbox ID. + +## -property-value +The mailbox ID of the mailbox that holds the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmessageid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmessageid.md index ec86979884..e26c5ad45c 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmessageid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_emailmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMessageId ## -description Gets the email message ID of the message associated with the attachment. ## -property-value The email message ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.EmailMessageId + +## -description +Gets the email message ID of the message associated with the attachment. + +## -property-value +The email message ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportcompletedasync_1707664681.md index ab093b8c54..2108b3b4dc 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the attachment was downloaded successfully. ## -returns An asynchronous download operation on an [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the attachment was downloaded successfully. + +## -returns +An asynchronous download operation on an [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportfailedasync_1210652737.md index b6e10f13d5..8ad6bf49fb 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous download operation on an [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous download operation on an [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs.md index 9ee88205fc..b445241292 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs ## -description Encapsulates information about a request to download an attachment. ## -remarks Use the instance of this class that is passed as an argument to your [DownloadAttachmentRequested](emaildataproviderconnection_downloadattachmentrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs + +## -description +Encapsulates information about a request to download an attachment. + +## -remarks +Use the instance of this class that is passed as an argument to your [DownloadAttachmentRequested](emaildataproviderconnection_downloadattachmentrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_getdeferral_254836512.md index 4a667821b1..028bb88daa 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_request.md index e7be84edeb..9dfbe727d2 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadattachmentrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.Request ## -description Gets the [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md) object associated with this request. ## -property-value A [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md) object describing the attachment to be downloaded. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadAttachmentRequestEventArgs.Request + +## -description +Gets the [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md) object associated with this request. + +## -property-value +A [EmailMailboxDownloadAttachmentRequest](emailmailboxdownloadattachmentrequest.md) object describing the attachment to be downloaded. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest.md index 01373b70ff..9cbfc93319 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest ## -description Details of a request to download an email message. ## -remarks Used in your [DownloadMessageRequest](emaildataproviderconnection_downloadmessagerequested.md) event handler. Use the instance of this class returned by the [EmailMailboxDownloadMessageRequestEventArgs.Request](emailmailboxdownloadmessagerequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest + +## -description +Details of a request to download an email message. + +## -remarks +Used in your [DownloadMessageRequest](emaildataproviderconnection_downloadmessagerequested.md) event handler. Use the instance of this class returned by the [EmailMailboxDownloadMessageRequestEventArgs.Request](emailmailboxdownloadmessagerequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmailboxid.md index d82cce46e2..31c41ae4bc 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMailboxId ## -description Gets the mailbox ID for the mailbox that holds the message to be downloaded. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMailboxId + +## -description +Gets the mailbox ID for the mailbox that holds the message to be downloaded. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmessageid.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmessageid.md index e84d80f0c9..160c7044c8 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmessageid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_emailmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMessageId ## -description Gets the message ID of the message to be downloaded. ## -property-value A message ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.EmailMessageId + +## -description +Gets the message ID of the message to be downloaded. + +## -property-value +A message ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportcompletedasync_1707664681.md index c992e1890a..f38dbbdb90 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the message was downloaded successfully. ## -returns An asynchronous download operation on an [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the message was downloaded successfully. + +## -returns +An asynchronous download operation on an [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportfailedasync_1210652737.md index 0be54fbb97..5822c9f2f4 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous download operation on an [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous download operation on an [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs.md index ec6f0bd273..c8bf783247 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs ## -description Encapsulates information about a request to download an email message. ## -remarks Use the instance of this class that is passed as an argument to your [DownloadMessageRequested](emaildataproviderconnection_downloadmessagerequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs + +## -description +Encapsulates information about a request to download an email message. + +## -remarks +Use the instance of this class that is passed as an argument to your [DownloadMessageRequested](emaildataproviderconnection_downloadmessagerequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_getdeferral_254836512.md index 4b114a0169..12cf0aaad1 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_request.md index a57d61a078..ec40803c50 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxdownloadmessagerequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.Request ## -description Gets the [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md) object associated with this request. ## -property-value An [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md) object describing the email message to be downloaded. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxDownloadMessageRequestEventArgs.Request + +## -description +Gets the [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md) object associated with this request. + +## -property-value +An [EmailMailboxDownloadMessageRequest](emailmailboxdownloadmessagerequest.md) object describing the email message to be downloaded. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest.md index 85927233f5..a17d88963e 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest ## -description Details of a request to download an email message. ## -remarks Used in your [EmptyFolderRequested](emaildataproviderconnection_emptyfolderrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxEmptyFolderRequestEventArgs.Request](emailmailboxemptyfolderrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest + +## -description +Details of a request to download an email message. + +## -remarks +Used in your [EmptyFolderRequested](emaildataproviderconnection_emptyfolderrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxEmptyFolderRequestEventArgs.Request](emailmailboxemptyfolderrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailfolderid.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailfolderid.md index d0721fc426..3d32e313ef 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailfolderid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailFolderId ## -description Gets the folder ID of the folder to be emptied. ## -property-value The folder ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailFolderId + +## -description +Gets the folder ID of the folder to be emptied. + +## -property-value +The folder ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailmailboxid.md index dfefafa8e8..2f646c7044 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailMailboxId ## -description Gets the mailbox ID of the mailbox that holds the folder. ## -property-value The mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.EmailMailboxId + +## -description +Gets the mailbox ID of the mailbox that holds the folder. + +## -property-value +The mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportcompletedasync_1707664681.md index 5c32a32982..773dc54987 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the folder was emptied successfully. ## -returns An asynchronous empty operation on an [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the folder was emptied successfully. + +## -returns +An asynchronous empty operation on an [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportfailedasync_1702917546.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportfailedasync_1702917546.md index b2829a5614..2d5267043f 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportfailedasync_1702917546.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequest_reportfailedasync_1702917546.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailMailboxEmptyFolderStatus) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. On the successful completion of the async operation, the status parameter is set to the current status of the folder in question. ## -parameters ### -param status The status of the folder, following the failed attempt to empty it. ## -returns An asynchronous empty operation on an [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailMailboxEmptyFolderStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +On the successful completion of the async operation, the status parameter is set to the current status of the folder in question. + +## -parameters +### -param status +The status of the folder, following the failed attempt to empty it. + +## -returns +An asynchronous empty operation on an [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs.md index 01d3bb540a..935c663fb4 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs ## -description Encapsulates information about a request to empty a folder. ## -remarks Use the instance of this class that is passed as an argument to your [EmptyFolderRequested](emaildataproviderconnection_emptyfolderrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs + +## -description +Encapsulates information about a request to empty a folder. + +## -remarks +Use the instance of this class that is passed as an argument to your [EmptyFolderRequested](emaildataproviderconnection_emptyfolderrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_getdeferral_254836512.md index 1313c5c05e..141e74957b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_request.md index fc508044ee..e1a3f2ec7d 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxemptyfolderrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.Request ## -description Gets the [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md) object associated with this request. ## -property-value An [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md) object describing the folder to be emptied. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxEmptyFolderRequestEventArgs.Request + +## -description +Gets the [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxEmptyFolderRequest](emailmailboxemptyfolderrequest.md) object describing the folder to be emptied. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest.md index 5b7307bf0e..fc2125cf9b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest ## -description Details of a request to forward a meeting invitation. ## -remarks Used in your [ForwardMeetingRequested](emaildataproviderconnection_forwardmeetingrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxForwardMeetingRequestEventArgs.Request](emailmailboxforwardmeetingrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest + +## -description +Details of a request to forward a meeting invitation. + +## -remarks +Used in your [ForwardMeetingRequested](emaildataproviderconnection_forwardmeetingrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxForwardMeetingRequestEventArgs.Request](emailmailboxforwardmeetingrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_comment.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_comment.md index b05d0175a5..e94a8aed78 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_comment.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Comment ## -description Gets the comment to be added to the forwarded meeting invitation. When a data provider forwards an invitation as an email message, the comment appears between the forward header and the body of the forwarded invitation. ## -property-value The comment to be added to the meeting invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Comment + +## -description +Gets the comment to be added to the forwarded meeting invitation. When a data provider forwards an invitation as an email message, the comment appears between the forward header and the body of the forwarded invitation. + +## -property-value +The comment to be added to the meeting invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmailboxid.md index 724a5a2b5a..67a5cae82d 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMailboxId ## -description Gets the mailbox ID for the meeting invitation to be forwarded. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMailboxId + +## -description +Gets the mailbox ID for the meeting invitation to be forwarded. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmessageid.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmessageid.md index 7d062f9c54..4491fc36bd 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmessageid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_emailmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMessageId ## -description The message ID of the meeting invitation to be forwarded. ## -property-value A message ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.EmailMessageId + +## -description +The message ID of the meeting invitation to be forwarded. + +## -property-value +A message ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheader.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheader.md index 5ed51dc1dd..2ef3920964 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheader.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheader.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeader --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeader ## -description Gets the forward header for the forwarded invitation. The forward header is the set of message headers that appear at the beginning of the email message that holds the invitation. It is only used by data providers that generate emails when forwarding invitations. ## -property-value The forwarding header. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeader +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeader + +## -description +Gets the forward header for the forwarded invitation. The forward header is the set of message headers that appear at the beginning of the email message that holds the invitation. It is only used by data providers that generate emails when forwarding invitations. + +## -property-value +The forwarding header. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheadertype.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheadertype.md index 38f4d3caa0..0a8bd0f7ad 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheadertype.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_forwardheadertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeaderType --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeaderType ## -description Gets the forward header type. ## -property-value An [EmailMessageBodyKind](../windows.applicationmodel.email/emailmessagebodykind.md) value describing the [ForwardHeader](emailmailboxforwardmeetingrequest_forwardheader.md) content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeaderType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ForwardHeaderType + +## -description +Gets the forward header type. + +## -property-value +An [EmailMessageBodyKind](../windows.applicationmodel.email/emailmessagebodykind.md) value describing the [ForwardHeader](emailmailboxforwardmeetingrequest_forwardheader.md) content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_recipients.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_recipients.md index 3cc5f2dd1a..14ae4c5424 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_recipients.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_recipients.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Recipients --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Recipients ## -description Gets the list of recipients for the forwarded meeting invitation. ## -property-value A list of [EmailRecipient](../windows.applicationmodel.email/emailrecipient.md) objects specifying the recipients of the forwarded invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Recipients +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Recipients + +## -description +Gets the list of recipients for the forwarded meeting invitation. + +## -property-value +A list of [EmailRecipient](../windows.applicationmodel.email/emailrecipient.md) objects specifying the recipients of the forwarded invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportcompletedasync_1707664681.md index aa26b3a3b6..4f43887056 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the meeting invitation was forwarded successfully. ## -returns An asynchronous forward operation on an [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the meeting invitation was forwarded successfully. + +## -returns +An asynchronous forward operation on an [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportfailedasync_1210652737.md index 4a33a0c15e..fd3c1b1bbd 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous forward operation on an [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous forward operation on an [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_subject.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_subject.md index e2ef271e8f..e2517f7d23 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_subject.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Subject ## -description Gets the subject of the forwarded meeting invitation. ## -property-value The subject line of the forwarded invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequest.Subject + +## -description +Gets the subject of the forwarded meeting invitation. + +## -property-value +The subject line of the forwarded invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs.md index 5bdaa3ae2f..c0c6f0d328 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs ## -description Encapsulates information about a request to forward a meeting invitation. ## -remarks Use the instance of the class that is passed as an argument to your [ForwardMeetingRequested](emaildataproviderconnection_forwardmeetingrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs + +## -description +Encapsulates information about a request to forward a meeting invitation. + +## -remarks +Use the instance of the class that is passed as an argument to your [ForwardMeetingRequested](emaildataproviderconnection_forwardmeetingrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_getdeferral_254836512.md index 0b9d90e20d..df413e052b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_request.md index dec0ddcd88..cc20f32b45 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxforwardmeetingrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.Request ## -description Gets the [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md) object associated with this request. ## -property-value An [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md) object describing the request to forward a meeting invitation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxForwardMeetingRequestEventArgs.Request + +## -description +Gets the [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxForwardMeetingRequest](emailmailboxforwardmeetingrequest.md) object describing the request to forward a meeting invitation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest.md index 1eb8d9e79e..785f99e709 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest ## -description Details of a request to get auto-reply settings. ## -remarks Used in your [GetAutoReplySettingsRequested](emaildataproviderconnection_getautoreplysettingsrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxGetAutoReplySettingsRequestEventArgs.Request](emailmailboxgetautoreplysettingsrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest + +## -description +Details of a request to get auto-reply settings. + +## -remarks +Used in your [GetAutoReplySettingsRequested](emaildataproviderconnection_getautoreplysettingsrequested.md) event handler. Use the instance of this class returned by the [EmailMailboxGetAutoReplySettingsRequestEventArgs.Request](emailmailboxgetautoreplysettingsrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_emailmailboxid.md index 6713e6c4be..8a269911cc 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.EmailMailboxId ## -description Gets the email box ID of the mailbox whose settings are being retrieved. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.EmailMailboxId + +## -description +Gets the email box ID of the mailbox whose settings are being retrieved. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportcompletedasync_2127589739.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportcompletedasync_2127589739.md index 6198f38c6d..311564814b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportcompletedasync_2127589739.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportcompletedasync_2127589739.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportCompletedAsync(Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the *autoReplySettings* parameter contains the retrieved auto-reply settings. ## -parameters ### -param autoReplySettings The requested settings, in the requested format. ## -returns An asynchronous get operation on an [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportCompletedAsync(Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the *autoReplySettings* parameter contains the retrieved auto-reply settings. + +## -parameters +### -param autoReplySettings +The requested settings, in the requested format. + +## -returns +An asynchronous get operation on an [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportfailedasync_1210652737.md index a96264075a..08dccf4359 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous get operation on an [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous get operation on an [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_requestedformat.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_requestedformat.md index 9f4bbf9c8a..0dd4ed750f 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_requestedformat.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequest_requestedformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.RequestedFormat --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.RequestedFormat ## -description Gets the requested format of the auto-reply settings. ## -property-value An [EmailMailboxAutoReplyMessageResponseKind](../windows.applicationmodel.email/emailmailboxautoreplymessageresponsekind.md) value representing the requested format of the returned settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.RequestedFormat +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequest.RequestedFormat + +## -description +Gets the requested format of the auto-reply settings. + +## -property-value +An [EmailMailboxAutoReplyMessageResponseKind](../windows.applicationmodel.email/emailmailboxautoreplymessageresponsekind.md) value representing the requested format of the returned settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs.md index 1049f6a62e..b1308f4901 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs ## -description Encapsulates information about a request to get auto-reply settings. ## -remarks Use the instance of this class that is passed as an argument to your [GetAutoReplySettingsRequested](emaildataproviderconnection_getautoreplysettingsrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs + +## -description +Encapsulates information about a request to get auto-reply settings. + +## -remarks +Use the instance of this class that is passed as an argument to your [GetAutoReplySettingsRequested](emaildataproviderconnection_getautoreplysettingsrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_getdeferral_254836512.md index aa9b83369d..1860d90a79 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_request.md index 077d7f1a3a..a48a0f7a50 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxgetautoreplysettingsrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.Request ## -description Gets the [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md) object associated with this request. ## -property-value An [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md) object describing the request to get auto-reply settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxGetAutoReplySettingsRequestEventArgs.Request + +## -description +Gets the [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxGetAutoReplySettingsRequest](emailmailboxgetautoreplysettingsrequest.md) object describing the request to get auto-reply settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest.md index dfc8e2e5da..8d35e0944c 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest ## -description Details of a request to move a folder. ## -remarks Used in your [MoveFolderRequested](emaildataproviderconnection_movefolderrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxMoveFolderRequestEventArgs.Request](emailmailboxmovefolderrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest + +## -description +Details of a request to move a folder. + +## -remarks +Used in your [MoveFolderRequested](emaildataproviderconnection_movefolderrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxMoveFolderRequestEventArgs.Request](emailmailboxmovefolderrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailfolderid.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailfolderid.md index 778c4b961d..9b49d114e5 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailfolderid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailFolderId ## -description Gets the folder ID of the folder to be moved. ## -property-value A folder ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailFolderId + +## -description +Gets the folder ID of the folder to be moved. + +## -property-value +A folder ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailmailboxid.md index e7648a6908..e8fa06ae48 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailMailboxId ## -description Gets the mailbox ID of the mailbox containing the folder to be moved. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.EmailMailboxId + +## -description +Gets the mailbox ID of the mailbox containing the folder to be moved. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newfoldername.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newfoldername.md index 007b43436d..0aec6cae2e 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newfoldername.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newfoldername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewFolderName --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewFolderName ## -description Gets the new folder name of the file to be moved. ## -property-value The new folder name. Note that you rename a folder by requesting a move to the current parent folder, but with a new name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewFolderName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewFolderName + +## -description +Gets the new folder name of the file to be moved. + +## -property-value +The new folder name. Note that you rename a folder by requesting a move to the current parent folder, but with a new name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newparentfolderid.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newparentfolderid.md index ee98e4ddf9..18d07d610e 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newparentfolderid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_newparentfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewParentFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewParentFolderId ## -description Gets the parent folder ID of the new parent folder. ## -property-value A folder ID. Note that you rename a folder by requesting a move to the current parent folder, but with a new name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewParentFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.NewParentFolderId + +## -description +Gets the parent folder ID of the new parent folder. + +## -property-value +A folder ID. Note that you rename a folder by requesting a move to the current parent folder, but with a new name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportcompletedasync_1707664681.md index c1fbd10a67..dbd85ffea7 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the folder was moved successfully. ## -returns An asynchronous move operation on an [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the folder was moved successfully. + +## -returns +An asynchronous move operation on an [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportfailedasync_1210652737.md index d4c17f75b2..d190999ef2 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous move operation on an [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous move operation on an [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs.md index 1750f8ac4d..15f288f750 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs ## -description Encapsulates information about a request to move a folder. ## -remarks Use the instance of this class that's passed as an argument to your [MoveFolderRequested](emaildataproviderconnection_movefolderrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs + +## -description +Encapsulates information about a request to move a folder. + +## -remarks +Use the instance of this class that's passed as an argument to your [MoveFolderRequested](emaildataproviderconnection_movefolderrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_getdeferral_254836512.md index 9c5744bda1..52800d31eb 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_request.md index 2504edff7a..f0beb0a330 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxmovefolderrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.Request ## -description Gets the [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md) object associated with this request. ## -property-value An [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md) object describing the request to move a folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxMoveFolderRequestEventArgs.Request + +## -description +Gets the [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxMoveFolderRequest](emailmailboxmovefolderrequest.md) object describing the request to move a folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest.md index e494e77e13..647b6bd1ad 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest ## -description Details of a request to propose a new time for a meeting. ## -remarks Used in your [ProposeNewTimeForMeetingRequested](emaildataproviderconnection_proposenewtimeformeetingrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxProposeNewTimeForMeetingRequestEventArgs.Request](emailmailboxproposenewtimeformeetingrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest + +## -description +Details of a request to propose a new time for a meeting. + +## -remarks +Used in your [ProposeNewTimeForMeetingRequested](emaildataproviderconnection_proposenewtimeformeetingrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxProposeNewTimeForMeetingRequestEventArgs.Request](emailmailboxproposenewtimeformeetingrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_comment.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_comment.md index e92e39a855..86637f3bad 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_comment.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Comment ## -description Gets the comment to be added to the proposal for a new meeting time. ## -property-value The comment, as text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Comment + +## -description +Gets the comment to be added to the proposal for a new meeting time. + +## -property-value +The comment, as text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmailboxid.md index dd6aae5686..55bb2d6c5f 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMailboxId ## -description Gets the mailbox ID to use to send the proposed new meeting time. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMailboxId + +## -description +Gets the mailbox ID to use to send the proposed new meeting time. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmessageid.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmessageid.md index 9b08c7cfc2..8b12fee467 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmessageid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_emailmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMessageId ## -description Gets the message ID of the meeting invitation for which a new time is being proposed. ## -property-value A message ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.EmailMessageId + +## -description +Gets the message ID of the meeting invitation for which a new time is being proposed. + +## -property-value +A message ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newduration.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newduration.md index 0527f727bc..a1939db5a0 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newduration.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewDuration --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewDuration ## -description Gets the proposed new duration of the meeting. ## -property-value The new duration of the meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewDuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewDuration + +## -description +Gets the proposed new duration of the meeting. + +## -property-value +The new duration of the meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newstarttime.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newstarttime.md index 15823b9ad5..29a59f1227 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newstarttime.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_newstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewStartTime ## -description Gets the proposed new start time for the meeting. ## -property-value The new start time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.NewStartTime + +## -description +Gets the proposed new start time for the meeting. + +## -property-value +The new start time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md index 846b278249..ad18def2a8 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the proposal was sent successfully. ## -returns An asynchronous move operation on an [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the proposal was sent successfully. + +## -returns +An asynchronous move operation on an [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportfailedasync_1210652737.md index 2cd303d5de..26522419b2 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous proposal operation on an [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous proposal operation on an [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_subject.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_subject.md index e24a9a8ea0..ba38d15e15 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_subject.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Subject ## -description Gets the subject of the proposal for a new meeting time. ## -property-value A subject line. Data providers that use email use this value for the Subject of the email. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequest.Subject + +## -description +Gets the subject of the proposal for a new meeting time. + +## -property-value +A subject line. Data providers that use email use this value for the Subject of the email. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs.md index a205715d94..c5673d1622 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs ## -description Encapsulates information about a request to propose a new time for a meeting. ## -remarks Use the instance of this class that's passed as an argument to your [ProposeNewTimeForMeetingRequested](emaildataproviderconnection_proposenewtimeformeetingrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs + +## -description +Encapsulates information about a request to propose a new time for a meeting. + +## -remarks +Use the instance of this class that's passed as an argument to your [ProposeNewTimeForMeetingRequested](emaildataproviderconnection_proposenewtimeformeetingrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md index c113a50614..56a8d32c36 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_request.md index 35c14d3f03..be8fc3b4ba 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxproposenewtimeformeetingrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.Request ## -description Gets [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md) the object associated with this request. ## -property-value An [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md) object describing the request to propose a new meeting time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxProposeNewTimeForMeetingRequestEventArgs.Request + +## -description +Gets [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md) the object associated with this request. + +## -property-value +An [EmailMailboxProposeNewTimeForMeetingRequest](emailmailboxproposenewtimeformeetingrequest.md) object describing the request to propose a new meeting time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest.md index d234b4eb03..3f5d484708 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest ## -description Details of a request to resolve a list of recipients. ## -remarks Used in your [ResolveRecipientsRequested](emaildataproviderconnection_resolverecipientsrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxResolveRecipientesRequestEventArgs.Request](emailmailboxresolverecipientsrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest + +## -description +Details of a request to resolve a list of recipients. + +## -remarks +Used in your [ResolveRecipientsRequested](emaildataproviderconnection_resolverecipientsrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxResolveRecipientesRequestEventArgs.Request](emailmailboxresolverecipientsrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_emailmailboxid.md index 4a4820bf8b..397e622424 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.EmailMailboxId ## -description Gets the mailbox ID where the recipients should be resolved. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.EmailMailboxId + +## -description +Gets the mailbox ID where the recipients should be resolved. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_recipients.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_recipients.md index 6ecfe4def7..1ad3d9c96e 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_recipients.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_recipients.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.Recipients --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.Recipients ## -description Gets the list of recipients to be resolved. ## -property-value A list of recipients. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.Recipients +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.Recipients + +## -description +Gets the list of recipients to be resolved. + +## -property-value +A list of recipients. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportcompletedasync_1028965796.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportcompletedasync_1028965796.md index be624632cf..76a8862893 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportcompletedasync_1028965796.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportcompletedasync_1028965796.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportCompletedAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Email.EmailRecipientResolutionResult}) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Successful completion of the asynchronous operation indicates that the recipient list was processed successfully. Note, though, that this does not mean that all of the names have been successfully resolved. Your code must check the status of each [EmailRecipientResolutionResult](../windows.applicationmodel.email/emailrecipientresolutionresult.md) item in the *resolutionResults* list to determine whether all of the names have been successfully resolved.. ## -parameters ### -param resolutionResults A list of [EmailRecipientResolutionResult](../windows.applicationmodel.email/emailrecipientresolutionresult.md) objects with details about resolution results. ## -returns An asynchronous resolve operation on an [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportCompletedAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Email.EmailRecipientResolutionResult}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +Successful completion of the asynchronous operation indicates that the recipient list was processed successfully. Note, though, that this does not mean that all of the names have been successfully resolved. Your code must check the status of each [EmailRecipientResolutionResult](../windows.applicationmodel.email/emailrecipientresolutionresult.md) item in the *resolutionResults* list to determine whether all of the names have been successfully resolved.. + +## -parameters +### -param resolutionResults +A list of [EmailRecipientResolutionResult](../windows.applicationmodel.email/emailrecipientresolutionresult.md) objects with details about resolution results. + +## -returns +An asynchronous resolve operation on an [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportfailedasync_1210652737.md index c1eefc90db..85b52bb5a0 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. Note that this means the operation failed to execute properly, and does not indicate anything about the recipients. See [ReportCompletedAsync](emailmailboxresolverecipientsrequest_reportcompletedasync.md) to understand how success or failure of resolution for individual recipients is reported. ## -returns An asynchronous resolve operation on an [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. Note that this means the operation failed to execute properly, and does not indicate anything about the recipients. See [ReportCompletedAsync](emailmailboxresolverecipientsrequest_reportcompletedasync.md) to understand how success or failure of resolution for individual recipients is reported. + +## -returns +An asynchronous resolve operation on an [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs.md index e31197f5a8..be621401a0 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs ## -description Encapsulates information about a request to resolve a list of recipients. ## -remarks Use the instance of this class that's passed as an argument to your [ResolveRecipientsRequested](emaildataproviderconnection_resolverecipientsrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs + +## -description +Encapsulates information about a request to resolve a list of recipients. + +## -remarks +Use the instance of this class that's passed as an argument to your [ResolveRecipientsRequested](emaildataproviderconnection_resolverecipientsrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_getdeferral_254836512.md index 421daf9757..4aff25c373 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_request.md index ea743f7166..b53abab207 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxresolverecipientsrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.Request ## -description Gets the [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md) object associated with this request. ## -property-value An [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md) object describing the request to resolve a list of recipients. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxResolveRecipientsRequestEventArgs.Request + +## -description +Gets the [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxResolveRecipientsRequest](emailmailboxresolverecipientsrequest.md) object describing the request to resolve a list of recipients. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest.md index ad1edc66e9..240ac1a000 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest ## -description Details of a request to read a batch of server-side search results. ## -remarks Used in your [ServerSearchReadBatchRequested](emaildataproviderconnection_serversearchreadbatchrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxSeverSearchReadBatchRequestEventArgs.Request](emailmailboxserversearchreadbatchrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest + +## -description +Details of a request to read a batch of server-side search results. + +## -remarks +Used in your [ServerSearchReadBatchRequested](emaildataproviderconnection_serversearchreadbatchrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxSeverSearchReadBatchRequestEventArgs.Request](emailmailboxserversearchreadbatchrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailfolderid.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailfolderid.md index d4d8b78b46..444994c838 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailfolderid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailFolderId ## -description Gets the folder ID of the folder where the search is to be performed. ## -property-value A folder ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailFolderId + +## -description +Gets the folder ID of the folder where the search is to be performed. + +## -property-value +A folder ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailmailboxid.md index 32b980ec53..a2a42b4021 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailMailboxId ## -description Gets the mailbox ID of the mailbox where the search is to be performed. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.EmailMailboxId + +## -description +Gets the mailbox ID of the mailbox where the search is to be performed. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_options.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_options.md index 0b321a0829..da2ac3cfb6 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_options.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_options.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.Options --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.Options ## -description Gets the search options to be applied to this search. ## -property-value An [EmailQueryOptions](../windows.applicationmodel.email/emailqueryoptions.md) object specifying the search options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.Options +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.Options + +## -description +Gets the search options to be applied to this search. + +## -property-value +An [EmailQueryOptions](../windows.applicationmodel.email/emailqueryoptions.md) object specifying the search options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportcompletedasync_1707664681.md index d80b9f2c55..4d9745dc8f 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. ## -returns An asynchronous batch read request operation on an [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +## -returns +An asynchronous batch read request operation on an [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportfailedasync_173385560.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportfailedasync_173385560.md index 34dd848d64..1b778f12e5 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportfailedasync_173385560.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_reportfailedasync_173385560.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailBatchStatus) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -parameters ### -param batchStatus An [EmailBatchStatus](../windows.applicationmodel.email/emailbatchstatus.md) value describing the current status of the batch. ## -returns An asynchronous batch read request operation on an [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportFailedAsync(Windows.ApplicationModel.Email.EmailBatchStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -parameters +### -param batchStatus +An [EmailBatchStatus](../windows.applicationmodel.email/emailbatchstatus.md) value describing the current status of the batch. + +## -returns +An asynchronous batch read request operation on an [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_savemessageasync_1316266452.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_savemessageasync_1316266452.md index f3e1ab856d..f3dae12bac 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_savemessageasync_1316266452.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_savemessageasync_1316266452.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SaveMessageAsync(Windows.ApplicationModel.Email.EmailMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SaveMessageAsync ## -description Saves a message that meets server-side search criteria. ## -parameters ### -param message A message that matches the search criteria of a server-side batch read request. ## -returns An asynchronous message save operation on an [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SaveMessageAsync(Windows.ApplicationModel.Email.EmailMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SaveMessageAsync + +## -description +Saves a message that meets server-side search criteria. + +## -parameters +### -param message +A message that matches the search criteria of a server-side batch read request. + +## -returns +An asynchronous message save operation on an [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_sessionid.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_sessionid.md index 7ba12cfc25..03353ae9fa 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_sessionid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_sessionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SessionId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SessionId ## -description Gets the search session ID of this server-side batch read request. ## -property-value A search session ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SessionId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SessionId + +## -description +Gets the search session ID of this server-side batch read request. + +## -property-value +A search session ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_suggestedbatchsize.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_suggestedbatchsize.md index ebdea8aad4..82bfeee730 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_suggestedbatchsize.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequest_suggestedbatchsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SuggestedBatchSize --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SuggestedBatchSize ## -description Gets the suggested batch size for the server-side search batch read. ## -property-value The suggested number of messages in a batch. Clients suggest a batch size based on client-side criteria such as screen real estate, storage capacity, or bandwidth. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SuggestedBatchSize +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequest.SuggestedBatchSize + +## -description +Gets the suggested batch size for the server-side search batch read. + +## -property-value +The suggested number of messages in a batch. Clients suggest a batch size based on client-side criteria such as screen real estate, storage capacity, or bandwidth. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs.md index 51f6b65c31..aec434315a 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs ## -description Encapsulates information about a request to read a batch of results from a server-side search. ## -remarks Use the instance of this class that's passed as an argument to your [ServerSearchReadBatchRequested](emaildataproviderconnection_serversearchreadbatchrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs + +## -description +Encapsulates information about a request to read a batch of results from a server-side search. + +## -remarks +Use the instance of this class that's passed as an argument to your [ServerSearchReadBatchRequested](emaildataproviderconnection_serversearchreadbatchrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_getdeferral_254836512.md index 84d617f9d9..a9249d95ef 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_request.md index abf943a8e1..8ecd87b9cd 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxserversearchreadbatchrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.Request ## -description Gets the [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md) object associated with this request. ## -property-value An [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md) object describing the request to read a batch of server-side search results. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxServerSearchReadBatchRequestEventArgs.Request + +## -description +Gets the [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxServerSearchReadBatchRequest](emailmailboxserversearchreadbatchrequest.md) object describing the request to read a batch of server-side search results. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest.md index 8c25b854e5..12ad98b996 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest ## -description Details of a request to set auto-reply settings. ## -remarks Used in your [SetAutoReplySettingsRequested](emaildataproviderconnection_setautoreplysettingsrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxSetAutoReplySettingsRequestedEventArgs.Request](emailmailboxsetautoreplysettingsrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest + +## -description +Details of a request to set auto-reply settings. + +## -remarks +Used in your [SetAutoReplySettingsRequested](emaildataproviderconnection_setautoreplysettingsrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxSetAutoReplySettingsRequestedEventArgs.Request](emailmailboxsetautoreplysettingsrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_autoreplysettings.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_autoreplysettings.md index 7ff14a5204..5b0499f0d3 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_autoreplysettings.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_autoreplysettings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.AutoReplySettings --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.AutoReplySettings ## -description Gets the new settings. ## -property-value An [EmailMailboxAutoReplySettings](../windows.applicationmodel.email/emailmailboxautoreplysettings.md) object describing the new auto-reply settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.AutoReplySettings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.AutoReplySettings + +## -description +Gets the new settings. + +## -property-value +An [EmailMailboxAutoReplySettings](../windows.applicationmodel.email/emailmailboxautoreplysettings.md) object describing the new auto-reply settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_emailmailboxid.md index 99a71ce57f..e2bc9e90f6 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.EmailMailboxId ## -description Gets the mailbox ID whose auto-reply settings are being set. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.EmailMailboxId + +## -description +Gets the mailbox ID whose auto-reply settings are being set. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportcompletedasync_1707664681.md index cbfabb0e1c..4bfe89b0b3 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. ## -returns An asynchronous set operation on an [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +## -returns +An asynchronous set operation on an [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportfailedasync_1210652737.md index 95cad7cbc9..818b4352fc 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous set operation on an [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous set operation on an [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs.md index 75fbb38852..91cc4e27b7 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs ## -description Encapsulates information about a request to set auto-reply settings. ## -remarks Use the instance of this class that's passed as an argument to your [SetAutoReplySettingsRequested](emaildataproviderconnection_setautoreplysettingsrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs + +## -description +Encapsulates information about a request to set auto-reply settings. + +## -remarks +Use the instance of this class that's passed as an argument to your [SetAutoReplySettingsRequested](emaildataproviderconnection_setautoreplysettingsrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_getdeferral_254836512.md index c2086781a4..2b4df2ec64 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_request.md index 4c09d4c6f4..30d98dd6a5 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsetautoreplysettingsrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.Request ## -description Gets the [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md) object associated with this request. ## -property-value An [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md) object describing the request to set auto-reply settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSetAutoReplySettingsRequestEventArgs.Request + +## -description +Gets the [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxSetAutoReplySettingsRequest](emailmailboxsetautoreplysettingsrequest.md) object describing the request to set auto-reply settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest.md index 4e35ce35f2..d5f72fb693 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest ## -description Details of a request from a client to sync a mailbox. ## -remarks Used in your [MailboxSyncRequested](emaildataproviderconnection_mailboxsyncrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxSyncManagerSyncRequestedEventArgs.Request](emailmailboxsyncmanagersyncrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest + +## -description +Details of a request from a client to sync a mailbox. + +## -remarks +Used in your [MailboxSyncRequested](emaildataproviderconnection_mailboxsyncrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxSyncManagerSyncRequestedEventArgs.Request](emailmailboxsyncmanagersyncrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_emailmailboxid.md index 333971465c..42eed354d7 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.EmailMailboxId ## -description Gets the mailbox ID of the mailbox to synchronize. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.EmailMailboxId + +## -description +Gets the mailbox ID of the mailbox to synchronize. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportcompletedasync_1707664681.md index 1836eca8de..cf01215d65 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportcompletedasync_1707664681.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. ## -returns An asynchronous sync operation on an [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +## -returns +An asynchronous sync operation on an [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportfailedasync_1210652737.md index eb9b032357..52b69160d9 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous sync operation on an [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous sync operation on an [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs.md index 4673f748af..6bdff213e2 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs ## -description Encapsulates information about a request to sync a mailbox. ## -remarks Use the instance of this class that's passed as an argument to your [MailboxSyncRequested](emaildataproviderconnection_mailboxsyncrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs + +## -description +Encapsulates information about a request to sync a mailbox. + +## -remarks +Use the instance of this class that's passed as an argument to your [MailboxSyncRequested](emaildataproviderconnection_mailboxsyncrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_getdeferral_254836512.md index 2a56e9601c..a3f5093074 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_request.md index d92a931d37..528120406b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxsyncmanagersyncrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.Request ## -description Gets the [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md) object associated with this request. ## -property-value An [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md) object describing the sync request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxSyncManagerSyncRequestEventArgs.Request + +## -description +Gets the [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxSyncManagerSyncRequest](emailmailboxsyncmanagersyncrequest.md) object describing the sync request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest.md index 7f0f9f7344..5836f5292c 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest ## -description Details of a request from a client to update a meeting response. ## -remarks Used in your [UpdateMeetingResponseRequested](emaildataproviderconnection_updatemeetingresponserequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxUpdateMeetingResponseRequestEventArgs.Request](emailmailboxupdatemeetingresponserequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest + +## -description +Details of a request from a client to update a meeting response. + +## -remarks +Used in your [UpdateMeetingResponseRequested](emaildataproviderconnection_updatemeetingresponserequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxUpdateMeetingResponseRequestEventArgs.Request](emailmailboxupdatemeetingresponserequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_comment.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_comment.md index b71ffe4442..e2e4071961 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_comment.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_comment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Comment --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Comment ## -description Gets the comment to be used in updating the meeting response. ## -property-value The comment text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Comment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Comment + +## -description +Gets the comment to be used in updating the meeting response. + +## -property-value +The comment text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmailboxid.md index b53ff4750a..05d26ce2bb 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMailboxId ## -description Gets the mailbox ID of the mailbox that holds the meeting response to be updated. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMailboxId + +## -description +Gets the mailbox ID of the mailbox that holds the meeting response to be updated. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmessageid.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmessageid.md index 8183cbef18..6ace587ff7 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmessageid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_emailmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMessageId ## -description Gets the message ID of the meeting response to be updated. ## -property-value A message ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.EmailMessageId + +## -description +Gets the message ID of the meeting response to be updated. + +## -property-value +A message ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportcompletedasync_1707664681.md index 5f6ae43810..c9a7b09376 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportcompletedasync_1707664681.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportcompletedasync_1707664681.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportCompletedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. ## -returns An asynchronous update operation on an [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. + +## -returns +An asynchronous update operation on an [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportfailedasync_1210652737.md index cc32f76711..d16870e28e 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. ## -returns An asynchronous update operation on an [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous update operation on an [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_response.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_response.md index 2fa48dfe62..3b7ccd04b8 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_response.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_response.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Response --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Response ## -description Gets the response value to be used in updating the meeting response. ## -property-value An [EmailMeetingResponseType](../windows.applicationmodel.email/emailmeetingresponsetype.md) value specifying the new response in the updated meeting response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Response +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Response + +## -description +Gets the response value to be used in updating the meeting response. + +## -property-value +An [EmailMeetingResponseType](../windows.applicationmodel.email/emailmeetingresponsetype.md) value specifying the new response in the updated meeting response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_sendupdate.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_sendupdate.md index 24d0b6e97d..493d8b1c6b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_sendupdate.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_sendupdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.SendUpdate --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.SendUpdate ## -description Gets a value that indicates whether an update should be sent to the meeting owner when the meeting response is updated. ## -property-value When true, notify the owner that the meeting response has been updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.SendUpdate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.SendUpdate + +## -description +Gets a value that indicates whether an update should be sent to the meeting owner when the meeting response is updated. + +## -property-value +When true, notify the owner that the meeting response has been updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_subject.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_subject.md index f8b950993f..1689775ab0 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_subject.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequest_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Subject ## -description Gets the subject to be used on the updated meeting response. ## -property-value The subject, as text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequest.Subject + +## -description +Gets the subject to be used on the updated meeting response. + +## -property-value +The subject, as text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs.md index c1340ed9b4..72c02e396d 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs ## -description Encapsulates information about a request to update a meeting response. ## -remarks Use the instance of this class that's passed as an argument to your [UpdateMeetingResponseRequested](emaildataproviderconnection_updatemeetingresponserequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs + +## -description +Encapsulates information about a request to update a meeting response. + +## -remarks +Use the instance of this class that's passed as an argument to your [UpdateMeetingResponseRequested](emaildataproviderconnection_updatemeetingresponserequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_getdeferral_254836512.md index 4c8d4c2f34..3c2c98878d 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_request.md index 8864121927..9f6e67f508 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxupdatemeetingresponserequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.Request ## -description Gets the [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md) object associated with this request. ## -property-value An [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md) object describing the meeting response update request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxUpdateMeetingResponseRequestEventArgs.Request + +## -description +Gets the [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md) object associated with this request. + +## -property-value +An [EmailMailboxUpdateMeetingResponseRequest](emailmailboxupdatemeetingresponserequest.md) object describing the meeting response update request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest.md index 420d0a2a6e..1a365e3e42 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest ## -description Details of a request to validate certificates. ## -remarks Used in your [ValidateCertificatesRequested](emaildataproviderconnection_validatecertificatesrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxValidateCertificatesRequestEventArgs.Request](emailmailboxvalidatecertificatesrequesteventargs_request.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest + +## -description +Details of a request to validate certificates. + +## -remarks +Used in your [ValidateCertificatesRequested](emaildataproviderconnection_validatecertificatesrequested.md) event handler. Use the instance of this class that's returned by the [EmailMailboxValidateCertificatesRequestEventArgs.Request](emailmailboxvalidatecertificatesrequesteventargs_request.md) property. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_certificates.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_certificates.md index 540cd1684c..dd8b26a96a 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_certificates.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_certificates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.Certificates --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.Certificates ## -description Gets the list of certificates to be validated. ## -property-value A list of certificates to be validated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.Certificates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.Certificates + +## -description +Gets the list of certificates to be validated. + +## -property-value +A list of certificates to be validated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_emailmailboxid.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_emailmailboxid.md index e95340696b..6d5976ed0b 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_emailmailboxid.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_emailmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.EmailMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.EmailMailboxId ## -description Gets the mailbox ID against which the certificates are to be validated. ## -property-value A mailbox ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.EmailMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.EmailMailboxId + +## -description +Gets the mailbox ID against which the certificates are to be validated. + +## -property-value +A mailbox ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportcompletedasync_1949034813.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportcompletedasync_1949034813.md index c1414191d0..adab5f9fc9 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportcompletedasync_1949034813.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportcompletedasync_1949034813.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportCompletedAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Email.EmailCertificateValidationStatus}) --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportCompletedAsync ## -description Informs the email client that the request was processed successfully. Note that success does not mean that all certificates validated successfully. Rather, it means that all certificates' validation status was assessed. ## -parameters ### -param validationStatuses A list of [EmailCertificateValidationStatus](../windows.applicationmodel.email/emailcertificatevalidationstatus.md) values. The first status value in this list is the status of the first certificate in the [Certificates](emailmailboxvalidatecertificatesrequest_certificates.md) property of the original request. ## -returns An asynchronous validation operation on an [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportCompletedAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Email.EmailCertificateValidationStatus}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportCompletedAsync + +## -description +Informs the email client that the request was processed successfully. Note that success does not mean that all certificates validated successfully. Rather, it means that all certificates' validation status was assessed. + +## -parameters +### -param validationStatuses +A list of [EmailCertificateValidationStatus](../windows.applicationmodel.email/emailcertificatevalidationstatus.md) values. The first status value in this list is the status of the first certificate in the [Certificates](emailmailboxvalidatecertificatesrequest_certificates.md) property of the original request. + +## -returns +An asynchronous validation operation on an [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportfailedasync_1210652737.md index a2dd1cd646..c7dd3ed272 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportfailedasync_1210652737.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequest_reportfailedasync_1210652737.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportFailedAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportFailedAsync ## -description Informs the client that the request was not processed successfully. Specifically, not all of the certificates' validation state was assessed successfully. ## -returns An asynchronous validation operation on an [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. Specifically, not all of the certificates' validation state was assessed successfully. + +## -returns +An asynchronous validation operation on an [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs.md index b4fd2d21ce..6293d20c88 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs ## -description Encapsulates information about a request to validate certificates. ## -remarks Use the instance of this class that's passed as an argument to your [ValidateCertificatesRequested](emaildataproviderconnection_validatecertificatesrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs + +## -description +Encapsulates information about a request to validate certificates. + +## -remarks +Use the instance of this class that's passed as an argument to your [ValidateCertificatesRequested](emaildataproviderconnection_validatecertificatesrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_getdeferral_254836512.md index d014e61b3d..1dd833bc36 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.GetDeferral ## -description Gets a deferral object for this operation. ## -returns A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_request.md b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_request.md index 5571dca4af..6cf57ba09a 100644 --- a/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_request.md +++ b/windows.applicationmodel.email.dataprovider/emailmailboxvalidatecertificatesrequesteventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.Request ## -description Gets the [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md) object associated with this request. ## -property-value An [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md) object describing the certificate validation request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.DataProvider.EmailMailboxValidateCertificatesRequestEventArgs.Request + +## -description +Gets the [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md) object associated with this request. + +## -property-value +An [EmailMailboxValidateCertificatesRequest](emailmailboxvalidatecertificatesrequest.md) object describing the certificate validation request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_contentid.md b/windows.applicationmodel.email/emailattachment_contentid.md index bead0aa50c..9a57f66953 100644 --- a/windows.applicationmodel.email/emailattachment_contentid.md +++ b/windows.applicationmodel.email/emailattachment_contentid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.ContentId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.ContentId ## -description Gets or sets a value that identifies the content of the attachment on a remote system. ## -property-value A value that identifies the content of the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.ContentId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.ContentId + +## -description +Gets or sets a value that identifies the content of the attachment on a remote system. + +## -property-value +A value that identifies the content of the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_contentlocation.md b/windows.applicationmodel.email/emailattachment_contentlocation.md index 03a6fd98b8..8609fb7ff3 100644 --- a/windows.applicationmodel.email/emailattachment_contentlocation.md +++ b/windows.applicationmodel.email/emailattachment_contentlocation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.ContentLocation --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.ContentLocation ## -description Gets or sets the location of an email attachment as a Uniform Resource Identifier (URI). ## -property-value The location of an email attachment as a Uniform Resource Identifier (URI). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.ContentLocation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.ContentLocation + +## -description +Gets or sets the location of an email attachment as a Uniform Resource Identifier (URI). + +## -property-value +The location of an email attachment as a Uniform Resource Identifier (URI). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_data.md b/windows.applicationmodel.email/emailattachment_data.md index 7af1a523ef..61219a44d8 100644 --- a/windows.applicationmodel.email/emailattachment_data.md +++ b/windows.applicationmodel.email/emailattachment_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.Data --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.Data ## -description Gets or sets the email attachment's data. ## -property-value The email attachment data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.Data + +## -description +Gets or sets the email attachment's data. + +## -property-value +The email attachment data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_downloadstate.md b/windows.applicationmodel.email/emailattachment_downloadstate.md index 62864bdd75..766fe74d16 100644 --- a/windows.applicationmodel.email/emailattachment_downloadstate.md +++ b/windows.applicationmodel.email/emailattachment_downloadstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.DownloadState --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.DownloadState ## -description Gets or sets the download state of the email attachment. ## -property-value The download state of the email attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.DownloadState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.DownloadState + +## -description +Gets or sets the download state of the email attachment. + +## -property-value +The download state of the email attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_emailattachment_1221375020.md b/windows.applicationmodel.email/emailattachment_emailattachment_1221375020.md index 3f6db92f38..4fa37eb932 100644 --- a/windows.applicationmodel.email/emailattachment_emailattachment_1221375020.md +++ b/windows.applicationmodel.email/emailattachment_emailattachment_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailAttachment.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailAttachment.EmailAttachment ## -description Initializes a new instance of the [EmailAttachment](emailattachment.md) class. ## -remarks ## -examples ## -see-also [EmailAttachment(String, IRandomAccessStreamReference)](emailattachment_emailattachment_1759667898.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailAttachment.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.EmailAttachment + +## -description +Initializes a new instance of the [EmailAttachment](emailattachment.md) class. + +## -remarks + +## -examples + +## -see-also +[EmailAttachment(String, IRandomAccessStreamReference)](emailattachment_emailattachment_1759667898.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailattachment_emailattachment_1759667898.md b/windows.applicationmodel.email/emailattachment_emailattachment_1759667898.md index 891f2f9557..d55d466608 100644 --- a/windows.applicationmodel.email/emailattachment_emailattachment_1759667898.md +++ b/windows.applicationmodel.email/emailattachment_emailattachment_1759667898.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailAttachment.#ctor(System.String,Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailAttachment.EmailAttachment ## -description Initializes a new instance of the [EmailAttachment](emailattachment.md) class with the specified random access stream. ## -parameters ### -param fileName The file name to use for the attachment. ### -param data A random access stream containing the data for the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailAttachment.#ctor(System.String,Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.EmailAttachment + +## -description +Initializes a new instance of the [EmailAttachment](emailattachment.md) class with the specified random access stream. + +## -parameters +### -param fileName +The file name to use for the attachment. + +### -param data +A random access stream containing the data for the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_emailattachment_249922106.md b/windows.applicationmodel.email/emailattachment_emailattachment_249922106.md index 08c3470ea3..6064485e0d 100644 --- a/windows.applicationmodel.email/emailattachment_emailattachment_249922106.md +++ b/windows.applicationmodel.email/emailattachment_emailattachment_249922106.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailAttachment.#ctor(System.String,Windows.Storage.Streams.IRandomAccessStreamReference,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailAttachment.EmailAttachment ## -description Initializes a new instance of the [EmailAttachment](emailattachment.md) class. ## -parameters ### -param fileName The filename of the attachment. ### -param data The stream to use to download the attachment. ### -param mimeType The MIME type of the attachment. ## -remarks ## -examples ## -see-also [EmailAttachment(String, IRandomAccessStreamReference)](emailattachment_emailattachment_1759667898.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailAttachment.#ctor(System.String,Windows.Storage.Streams.IRandomAccessStreamReference,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.EmailAttachment + +## -description +Initializes a new instance of the [EmailAttachment](emailattachment.md) class. + +## -parameters +### -param fileName +The filename of the attachment. + +### -param data +The stream to use to download the attachment. + +### -param mimeType +The MIME type of the attachment. + +## -remarks + +## -examples + +## -see-also +[EmailAttachment(String, IRandomAccessStreamReference)](emailattachment_emailattachment_1759667898.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailattachment_estimateddownloadsizeinbytes.md b/windows.applicationmodel.email/emailattachment_estimateddownloadsizeinbytes.md index 70161586a2..4ca619a1c6 100644 --- a/windows.applicationmodel.email/emailattachment_estimateddownloadsizeinbytes.md +++ b/windows.applicationmodel.email/emailattachment_estimateddownloadsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.EstimatedDownloadSizeInBytes --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.EstimatedDownloadSizeInBytes ## -description Gets or sets the estimated download size of the attachment. ## -property-value The estimated download size of the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.EstimatedDownloadSizeInBytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.EstimatedDownloadSizeInBytes + +## -description +Gets or sets the estimated download size of the attachment. + +## -property-value +The estimated download size of the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_filename.md b/windows.applicationmodel.email/emailattachment_filename.md index 52c80a13ac..f6b2a60f11 100644 --- a/windows.applicationmodel.email/emailattachment_filename.md +++ b/windows.applicationmodel.email/emailattachment_filename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.FileName --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.FileName ## -description Gets or sets the displayed file name for the email attachment. ## -property-value The displayed file name for the email attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.FileName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.FileName + +## -description +Gets or sets the displayed file name for the email attachment. + +## -property-value +The displayed file name for the email attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_id.md b/windows.applicationmodel.email/emailattachment_id.md index 0dcd55c844..b3863a9d67 100644 --- a/windows.applicationmodel.email/emailattachment_id.md +++ b/windows.applicationmodel.email/emailattachment_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.Id --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.Id ## -description Gets the locally unique ID for the email attachment. ## -property-value The locally unique ID for the email attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.Id + +## -description +Gets the locally unique ID for the email attachment. + +## -property-value +The locally unique ID for the email attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_isfrombasemessage.md b/windows.applicationmodel.email/emailattachment_isfrombasemessage.md index ff8a800187..2a52614508 100644 --- a/windows.applicationmodel.email/emailattachment_isfrombasemessage.md +++ b/windows.applicationmodel.email/emailattachment_isfrombasemessage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.IsFromBaseMessage --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.IsFromBaseMessage ## -description Gets a Boolean value indicating if the attachment came from the base message. ## -property-value A Boolean value indicating if the attachment came from the base message. ## -remarks If you remove a base attachment, you cannot use smart-send. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.IsFromBaseMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.IsFromBaseMessage + +## -description +Gets a Boolean value indicating if the attachment came from the base message. + +## -property-value +A Boolean value indicating if the attachment came from the base message. + +## -remarks +If you remove a base attachment, you cannot use smart-send. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_isinline.md b/windows.applicationmodel.email/emailattachment_isinline.md index 1856ec65da..487e18062e 100644 --- a/windows.applicationmodel.email/emailattachment_isinline.md +++ b/windows.applicationmodel.email/emailattachment_isinline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.IsInline --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.IsInline ## -description Gets or sets a Boolean property indicating if the attachment is included inline, in the body of the message. ## -property-value A Boolean property indicating if the attachment is included inline. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.IsInline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.IsInline + +## -description +Gets or sets a Boolean property indicating if the attachment is included inline, in the body of the message. + +## -property-value +A Boolean property indicating if the attachment is included inline. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailattachment_mimetype.md b/windows.applicationmodel.email/emailattachment_mimetype.md index ca6cb03a33..c628cd392d 100644 --- a/windows.applicationmodel.email/emailattachment_mimetype.md +++ b/windows.applicationmodel.email/emailattachment_mimetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailAttachment.MimeType --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailAttachment.MimeType ## -description Gets or sets the MIME type of the attachment. ## -property-value The MIME type of the attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailAttachment.MimeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailAttachment.MimeType + +## -description +Gets or sets the MIME type of the attachment. + +## -property-value +The MIME type of the attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation.md b/windows.applicationmodel.email/emailconversation.md index d8396f0990..cf35c3f333 100644 --- a/windows.applicationmodel.email/emailconversation.md +++ b/windows.applicationmodel.email/emailconversation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailConversation --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailConversation ## -description Represents an email conversation. ## -remarks Obtain an instance of this class by calling [EmailConversationReader.ReadBatchAsync](emailconversationreader_readbatchasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailConversation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailConversation + +## -description +Represents an email conversation. + +## -remarks +Obtain an instance of this class by calling [EmailConversationReader.ReadBatchAsync](emailconversationreader_readbatchasync.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_findmessagesasync_1306641635.md b/windows.applicationmodel.email/emailconversation_findmessagesasync_1306641635.md index 75e1238392..3ba3c3e098 100644 --- a/windows.applicationmodel.email/emailconversation_findmessagesasync_1306641635.md +++ b/windows.applicationmodel.email/emailconversation_findmessagesasync_1306641635.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync(System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync ## -description Asynchronously gets a batch of messages in the conversation. ## -parameters ### -param count The size of the batch of messages to retrieve. ## -returns The batch of messages. ## -remarks ## -examples ## -see-also [FindMessagesAsync](emailconversation_findmessagesasync_837137892.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync + +## -description +Asynchronously gets a batch of messages in the conversation. + +## -parameters +### -param count +The size of the batch of messages to retrieve. + +## -returns +The batch of messages. + +## -remarks + +## -examples + +## -see-also +[FindMessagesAsync](emailconversation_findmessagesasync_837137892.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailconversation_findmessagesasync_837137892.md b/windows.applicationmodel.email/emailconversation_findmessagesasync_837137892.md index b897c07a5c..753d97f2c1 100644 --- a/windows.applicationmodel.email/emailconversation_findmessagesasync_837137892.md +++ b/windows.applicationmodel.email/emailconversation_findmessagesasync_837137892.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync ## -description Asynchronously gets a batch of messages in the conversation. ## -returns The batch of messages. ## -remarks ## -examples ## -see-also [FindMessagesAsync(UInt32)](emailconversation_findmessagesasync_1306641635.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.FindMessagesAsync + +## -description +Asynchronously gets a batch of messages in the conversation. + +## -returns +The batch of messages. + +## -remarks + +## -examples + +## -see-also +[FindMessagesAsync(UInt32)](emailconversation_findmessagesasync_1306641635.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailconversation_flagstate.md b/windows.applicationmodel.email/emailconversation_flagstate.md index 774a9565b0..aebd17eee1 100644 --- a/windows.applicationmodel.email/emailconversation_flagstate.md +++ b/windows.applicationmodel.email/emailconversation_flagstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.FlagState --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.FlagState ## -description Gets the [EmailFlagState](emailflagstate.md) for the conversation. ## -property-value The [EmailFlagState](emailflagstate.md) for the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.FlagState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.FlagState + +## -description +Gets the [EmailFlagState](emailflagstate.md) for the conversation. + +## -property-value +The [EmailFlagState](emailflagstate.md) for the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_hasattachment.md b/windows.applicationmodel.email/emailconversation_hasattachment.md index 95a9290c75..4fca473445 100644 --- a/windows.applicationmodel.email/emailconversation_hasattachment.md +++ b/windows.applicationmodel.email/emailconversation_hasattachment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.HasAttachment --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.HasAttachment ## -description Gets a Boolean value indicating if the conversation has an attachment. ## -property-value A Boolean value indicating if the conversation has an attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.HasAttachment +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.HasAttachment + +## -description +Gets a Boolean value indicating if the conversation has an attachment. + +## -property-value +A Boolean value indicating if the conversation has an attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_id.md b/windows.applicationmodel.email/emailconversation_id.md index 084538ee6b..6417057085 100644 --- a/windows.applicationmodel.email/emailconversation_id.md +++ b/windows.applicationmodel.email/emailconversation_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.Id --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.Id ## -description Gets the unique identifier for the [EmailConversation](emailconversation.md). ## -property-value The unique identifier for the [EmailConversation](emailconversation.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.Id + +## -description +Gets the unique identifier for the [EmailConversation](emailconversation.md). + +## -property-value +The unique identifier for the [EmailConversation](emailconversation.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_importance.md b/windows.applicationmodel.email/emailconversation_importance.md index 95071f8d8d..1da8b4e895 100644 --- a/windows.applicationmodel.email/emailconversation_importance.md +++ b/windows.applicationmodel.email/emailconversation_importance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.Importance --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.Importance ## -description Gets the value that specifies the importance of the conversation; normal, high or low. ## -property-value The value that specifies the importance of the conversation; normal, high or low. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.Importance +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.Importance + +## -description +Gets the value that specifies the importance of the conversation; normal, high or low. + +## -property-value +The value that specifies the importance of the conversation; normal, high or low. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_lastemailresponsekind.md b/windows.applicationmodel.email/emailconversation_lastemailresponsekind.md index e3c36186c0..2912c53476 100644 --- a/windows.applicationmodel.email/emailconversation_lastemailresponsekind.md +++ b/windows.applicationmodel.email/emailconversation_lastemailresponsekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.LastEmailResponseKind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.LastEmailResponseKind ## -description Gets the last [EmailMessageResponseKind](emailmessageresponsekind.md) for the conversation. ## -property-value The last [EmailMessageResponseKind](emailmessageresponsekind.md) for the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.LastEmailResponseKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.LastEmailResponseKind + +## -description +Gets the last [EmailMessageResponseKind](emailmessageresponsekind.md) for the conversation. + +## -property-value +The last [EmailMessageResponseKind](emailmessageresponsekind.md) for the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_latestsender.md b/windows.applicationmodel.email/emailconversation_latestsender.md index 5ad497e546..656de215d9 100644 --- a/windows.applicationmodel.email/emailconversation_latestsender.md +++ b/windows.applicationmodel.email/emailconversation_latestsender.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.LatestSender --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.LatestSender ## -description Gets the latest sender in the conversation. ## -property-value The latest sender in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.LatestSender +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.LatestSender + +## -description +Gets the latest sender in the conversation. + +## -property-value +The latest sender in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_mailboxid.md b/windows.applicationmodel.email/emailconversation_mailboxid.md index 9fe4015bff..d6e17ffd11 100644 --- a/windows.applicationmodel.email/emailconversation_mailboxid.md +++ b/windows.applicationmodel.email/emailconversation_mailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.MailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.MailboxId ## -description Gets the ID for the mailbox. ## -property-value The ID for the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.MailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.MailboxId + +## -description +Gets the ID for the mailbox. + +## -property-value +The ID for the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_messagecount.md b/windows.applicationmodel.email/emailconversation_messagecount.md index b2400af26c..199f2d0822 100644 --- a/windows.applicationmodel.email/emailconversation_messagecount.md +++ b/windows.applicationmodel.email/emailconversation_messagecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.MessageCount --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.MessageCount ## -description Gets the number of messages in the conversation. ## -property-value The number of messages in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.MessageCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.MessageCount + +## -description +Gets the number of messages in the conversation. + +## -property-value +The number of messages in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_mostrecentmessageid.md b/windows.applicationmodel.email/emailconversation_mostrecentmessageid.md index d4a12fd65e..8ace01dfac 100644 --- a/windows.applicationmodel.email/emailconversation_mostrecentmessageid.md +++ b/windows.applicationmodel.email/emailconversation_mostrecentmessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageId ## -description Gets the ID of the most recent message in the conversation. ## -property-value The ID of the most recent message in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageId + +## -description +Gets the ID of the most recent message in the conversation. + +## -property-value +The ID of the most recent message in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_mostrecentmessagetime.md b/windows.applicationmodel.email/emailconversation_mostrecentmessagetime.md index 2c4d7852ad..9396296f4b 100644 --- a/windows.applicationmodel.email/emailconversation_mostrecentmessagetime.md +++ b/windows.applicationmodel.email/emailconversation_mostrecentmessagetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageTime ## -description Gets the time of the most recent message in the conversation. ## -property-value The time of the most recent message in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.MostRecentMessageTime + +## -description +Gets the time of the most recent message in the conversation. + +## -property-value +The time of the most recent message in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_preview.md b/windows.applicationmodel.email/emailconversation_preview.md index 51292816f2..855517a2a4 100644 --- a/windows.applicationmodel.email/emailconversation_preview.md +++ b/windows.applicationmodel.email/emailconversation_preview.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.Preview --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.Preview ## -description Gets a preview of the latest message in the conversation. ## -property-value A preview of the latest message in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.Preview +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.Preview + +## -description +Gets a preview of the latest message in the conversation. + +## -property-value +A preview of the latest message in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_subject.md b/windows.applicationmodel.email/emailconversation_subject.md index b1be6bfa7a..0b70e8f6d0 100644 --- a/windows.applicationmodel.email/emailconversation_subject.md +++ b/windows.applicationmodel.email/emailconversation_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.Subject ## -description Gets the subject of the latest message in the conversation. ## -property-value The subject of the latest message in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.Subject + +## -description +Gets the subject of the latest message in the conversation. + +## -property-value +The subject of the latest message in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversation_unreadmessagecount.md b/windows.applicationmodel.email/emailconversation_unreadmessagecount.md index e99e8b0fca..0d74cb7d46 100644 --- a/windows.applicationmodel.email/emailconversation_unreadmessagecount.md +++ b/windows.applicationmodel.email/emailconversation_unreadmessagecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversation.UnreadMessageCount --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversation.UnreadMessageCount ## -description Gets the number of unread messages in the conversation. ## -property-value The number of unread messages in the conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversation.UnreadMessageCount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversation.UnreadMessageCount + +## -description +Gets the number of unread messages in the conversation. + +## -property-value +The number of unread messages in the conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversationbatch.md b/windows.applicationmodel.email/emailconversationbatch.md index f7faa7bd9e..328d866ea0 100644 --- a/windows.applicationmodel.email/emailconversationbatch.md +++ b/windows.applicationmodel.email/emailconversationbatch.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailConversationBatch --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailConversationBatch ## -description Represents a group of [EmailConversation](emailconversation.md) objects for batch processing. ## -remarks Obtain an instance of this class by calling [EmailConversationReader.ReadBatchAsync](emailconversationreader_readbatchasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailConversationBatch +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailConversationBatch + +## -description +Represents a group of [EmailConversation](emailconversation.md) objects for batch processing. + +## -remarks +Obtain an instance of this class by calling [EmailConversationReader.ReadBatchAsync](emailconversationreader_readbatchasync.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversationbatch_conversations.md b/windows.applicationmodel.email/emailconversationbatch_conversations.md index f156fa1231..99022075be 100644 --- a/windows.applicationmodel.email/emailconversationbatch_conversations.md +++ b/windows.applicationmodel.email/emailconversationbatch_conversations.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversationBatch.Conversations --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversationBatch.Conversations ## -description Gets a list of [EmailConversation](emailconversation.md) objects to use for batch processing. ## -property-value A list of [EmailConversation](emailconversation.md) objects to use for batch processing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversationBatch.Conversations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversationBatch.Conversations + +## -description +Gets a list of [EmailConversation](emailconversation.md) objects to use for batch processing. + +## -property-value +A list of [EmailConversation](emailconversation.md) objects to use for batch processing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversationbatch_status.md b/windows.applicationmodel.email/emailconversationbatch_status.md index ec6bf25264..79ff809149 100644 --- a/windows.applicationmodel.email/emailconversationbatch_status.md +++ b/windows.applicationmodel.email/emailconversationbatch_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailConversationBatch.Status --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailConversationBatch.Status ## -description Gets the status of the last batch processing operation. ## -property-value The status of the last batch processing operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailConversationBatch.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailConversationBatch.Status + +## -description +Gets the status of the last batch processing operation. + +## -property-value +The status of the last batch processing operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversationreader.md b/windows.applicationmodel.email/emailconversationreader.md index 5e1410eda7..8959fde2f3 100644 --- a/windows.applicationmodel.email/emailconversationreader.md +++ b/windows.applicationmodel.email/emailconversationreader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailConversationReader --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailConversationReader ## -description Reads a batch of email conversations. ## -remarks Call [GetConversationReader](emailstore_getconversationreader_388570943.md) or [GetConversationReader(EmailQueryOptions)](emailstore_getconversationreader_964157301.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailConversationReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailConversationReader + +## -description +Reads a batch of email conversations. + +## -remarks +Call [GetConversationReader](emailstore_getconversationreader_388570943.md) or [GetConversationReader(EmailQueryOptions)](emailstore_getconversationreader_964157301.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailconversationreader_readbatchasync_888788553.md b/windows.applicationmodel.email/emailconversationreader_readbatchasync_888788553.md index c4e3f12b63..53254ef429 100644 --- a/windows.applicationmodel.email/emailconversationreader_readbatchasync_888788553.md +++ b/windows.applicationmodel.email/emailconversationreader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailConversationReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailConversationReader.ReadBatchAsync ## -description Asynchronously reads a batch of email conversations. ## -returns Returns a batch of email conversations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailConversationReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailConversationReader.ReadBatchAsync + +## -description +Asynchronously reads a batch of email conversations. + +## -returns +Returns a batch of email conversations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder.md b/windows.applicationmodel.email/emailfolder.md index c711acd419..77ab65a92a 100644 --- a/windows.applicationmodel.email/emailfolder.md +++ b/windows.applicationmodel.email/emailfolder.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailFolder --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailFolder ## -description Represents an email folder. ## -remarks The [Folder](emailmailboxchange_folder.md) property returns an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailFolder +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailFolder + +## -description +Represents an email folder. + +## -remarks +The [Folder](emailmailboxchange_folder.md) property returns an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_createfolderasync_660577586.md b/windows.applicationmodel.email/emailfolder_createfolderasync_660577586.md index f59d425a47..d3e6073da7 100644 --- a/windows.applicationmodel.email/emailfolder_createfolderasync_660577586.md +++ b/windows.applicationmodel.email/emailfolder_createfolderasync_660577586.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.CreateFolderAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.CreateFolderAsync ## -description Asynchronously creates a new folder. ## -parameters ### -param name The name for the new folder. ## -returns Returns the newly created folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.CreateFolderAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.CreateFolderAsync + +## -description +Asynchronously creates a new folder. + +## -parameters +### -param name +The name for the new folder. + +## -returns +Returns the newly created folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_deleteasync_1247887881.md b/windows.applicationmodel.email/emailfolder_deleteasync_1247887881.md index a2c6ba6caf..ed683590d0 100644 --- a/windows.applicationmodel.email/emailfolder_deleteasync_1247887881.md +++ b/windows.applicationmodel.email/emailfolder_deleteasync_1247887881.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.DeleteAsync ## -description Asynchronously deletes this folder. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.DeleteAsync + +## -description +Asynchronously deletes this folder. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_displayname.md b/windows.applicationmodel.email/emailfolder_displayname.md index cda9266eb2..037ed97efb 100644 --- a/windows.applicationmodel.email/emailfolder_displayname.md +++ b/windows.applicationmodel.email/emailfolder_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.DisplayName ## -description Gets or sets the display name for the folder. ## -property-value The display name for the folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.DisplayName + +## -description +Gets or sets the display name for the folder. + +## -property-value +The display name for the folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_findchildfoldersasync_158889090.md b/windows.applicationmodel.email/emailfolder_findchildfoldersasync_158889090.md index 21aa5f6148..89d400d3a4 100644 --- a/windows.applicationmodel.email/emailfolder_findchildfoldersasync_158889090.md +++ b/windows.applicationmodel.email/emailfolder_findchildfoldersasync_158889090.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.FindChildFoldersAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.FindChildFoldersAsync ## -description Asynchronously finds the child folders of this folder. ## -returns The list of child folders. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.FindChildFoldersAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.FindChildFoldersAsync + +## -description +Asynchronously finds the child folders of this folder. + +## -returns +The list of child folders. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_getconversationreader_388570943.md b/windows.applicationmodel.email/emailfolder_getconversationreader_388570943.md index c33775ae04..c60d7e55b6 100644 --- a/windows.applicationmodel.email/emailfolder_getconversationreader_388570943.md +++ b/windows.applicationmodel.email/emailfolder_getconversationreader_388570943.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetConversationReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.GetConversationReader ## -description Gets an instance of the [EmailConversationReader](emailconversationreader.md) class. ## -returns The conversation reader. ## -remarks ## -examples ## -see-also [GetConversationReader(EmailQueryOptions)](emailfolder_getconversationreader_964157301.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetConversationReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.GetConversationReader + +## -description +Gets an instance of the [EmailConversationReader](emailconversationreader.md) class. + +## -returns +The conversation reader. + +## -remarks + +## -examples + +## -see-also +[GetConversationReader(EmailQueryOptions)](emailfolder_getconversationreader_964157301.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailfolder_getconversationreader_964157301.md b/windows.applicationmodel.email/emailfolder_getconversationreader_964157301.md index 9b6065d021..8b8401ca6a 100644 --- a/windows.applicationmodel.email/emailfolder_getconversationreader_964157301.md +++ b/windows.applicationmodel.email/emailfolder_getconversationreader_964157301.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetConversationReader(Windows.ApplicationModel.Email.EmailQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.GetConversationReader ## -description Gets an instance of the [EmailConversationReader](emailconversationreader.md) class using the specified query options. ## -parameters ### -param options The query options to use when finding the conversation reader. ## -returns The conversation reader that matches the query options. ## -remarks ## -examples ## -see-also [GetConversationReader](emailfolder_getconversationreader_388570943.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetConversationReader(Windows.ApplicationModel.Email.EmailQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.GetConversationReader + +## -description +Gets an instance of the [EmailConversationReader](emailconversationreader.md) class using the specified query options. + +## -parameters +### -param options +The query options to use when finding the conversation reader. + +## -returns +The conversation reader that matches the query options. + +## -remarks + +## -examples + +## -see-also +[GetConversationReader](emailfolder_getconversationreader_388570943.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailfolder_getmessageasync_151244055.md b/windows.applicationmodel.email/emailfolder_getmessageasync_151244055.md index bb8a7306c8..3ff7df87f3 100644 --- a/windows.applicationmodel.email/emailfolder_getmessageasync_151244055.md +++ b/windows.applicationmodel.email/emailfolder_getmessageasync_151244055.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.GetMessageAsync ## -description Asynchronously gets the specified message from the folder. ## -parameters ### -param id The ID of the message to retrieve. ## -returns The message specified in the *id* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.GetMessageAsync + +## -description +Asynchronously gets the specified message from the folder. + +## -parameters +### -param id +The ID of the message to retrieve. + +## -returns +The message specified in the *id* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_getmessagecountsasync_309486554.md b/windows.applicationmodel.email/emailfolder_getmessagecountsasync_309486554.md index db792d8454..6e3b90f2f9 100644 --- a/windows.applicationmodel.email/emailfolder_getmessagecountsasync_309486554.md +++ b/windows.applicationmodel.email/emailfolder_getmessagecountsasync_309486554.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageCountsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.GetMessageCountsAsync ## -description Asynchronously gets the counts of email items such as flagged emails, important emails, unread emails, total emails, and so on. ## -returns An [EmailItemCounts](emailitemcounts.md) object containing the counts of email items such as flagged emails, important emails, unread emails, total emails, and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageCountsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.GetMessageCountsAsync + +## -description +Asynchronously gets the counts of email items such as flagged emails, important emails, unread emails, total emails, and so on. + +## -returns +An [EmailItemCounts](emailitemcounts.md) object containing the counts of email items such as flagged emails, important emails, unread emails, total emails, and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_getmessagereader_1198599356.md b/windows.applicationmodel.email/emailfolder_getmessagereader_1198599356.md index 902ff074cc..07ca8ec0bf 100644 --- a/windows.applicationmodel.email/emailfolder_getmessagereader_1198599356.md +++ b/windows.applicationmodel.email/emailfolder_getmessagereader_1198599356.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.GetMessageReader ## -description Gets an instance of the [EmailMessageReader](emailmessagereader.md) class. ## -returns The message reader. ## -remarks ## -examples ## -see-also [GetMessageReader(EmailQueryOptions)](emailfolder_getmessagereader_1764748530.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.GetMessageReader + +## -description +Gets an instance of the [EmailMessageReader](emailmessagereader.md) class. + +## -returns +The message reader. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader(EmailQueryOptions)](emailfolder_getmessagereader_1764748530.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailfolder_getmessagereader_1764748530.md b/windows.applicationmodel.email/emailfolder_getmessagereader_1764748530.md index a1a38f4f53..905cdc20b1 100644 --- a/windows.applicationmodel.email/emailfolder_getmessagereader_1764748530.md +++ b/windows.applicationmodel.email/emailfolder_getmessagereader_1764748530.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageReader(Windows.ApplicationModel.Email.EmailQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.GetMessageReader ## -description Gets an instance of the [EmailMessageReader](emailmessagereader.md) class using the specified query options. ## -parameters ### -param options The query options to use when finding the message reader. ## -returns The message reader that matches the query options. ## -remarks ## -examples ## -see-also [GetMessageReader](emailfolder_getmessagereader_1198599356.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.GetMessageReader(Windows.ApplicationModel.Email.EmailQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.GetMessageReader + +## -description +Gets an instance of the [EmailMessageReader](emailmessagereader.md) class using the specified query options. + +## -parameters +### -param options +The query options to use when finding the message reader. + +## -returns +The message reader that matches the query options. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader](emailfolder_getmessagereader_1198599356.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailfolder_id.md b/windows.applicationmodel.email/emailfolder_id.md index f6e6adf53d..a39e916768 100644 --- a/windows.applicationmodel.email/emailfolder_id.md +++ b/windows.applicationmodel.email/emailfolder_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.Id --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.Id ## -description Gets the ID of the email folder. ## -property-value The ID of the email folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.Id + +## -description +Gets the ID of the email folder. + +## -property-value +The ID of the email folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_issyncenabled.md b/windows.applicationmodel.email/emailfolder_issyncenabled.md index 131f815899..02117a7f45 100644 --- a/windows.applicationmodel.email/emailfolder_issyncenabled.md +++ b/windows.applicationmodel.email/emailfolder_issyncenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.IsSyncEnabled --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.IsSyncEnabled ## -description Gets or sets a Boolean value indicating if the folder is sync enabled. ## -property-value A Boolean value indicating if the folder is sync enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.IsSyncEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.IsSyncEnabled + +## -description +Gets or sets a Boolean value indicating if the folder is sync enabled. + +## -property-value +A Boolean value indicating if the folder is sync enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_kind.md b/windows.applicationmodel.email/emailfolder_kind.md index 112f8b2802..aca6d544cd 100644 --- a/windows.applicationmodel.email/emailfolder_kind.md +++ b/windows.applicationmodel.email/emailfolder_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.Kind ## -description Gets the type of the folder such as inbox, outbox, drafts, sent, and so on. ## -property-value The type of the folder such as inbox, outbox, drafts, sent, and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.Kind + +## -description +Gets the type of the folder such as inbox, outbox, drafts, sent, and so on. + +## -property-value +The type of the folder such as inbox, outbox, drafts, sent, and so on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_lastsuccessfulsynctime.md b/windows.applicationmodel.email/emailfolder_lastsuccessfulsynctime.md index 3db954ff01..4e22156803 100644 --- a/windows.applicationmodel.email/emailfolder_lastsuccessfulsynctime.md +++ b/windows.applicationmodel.email/emailfolder_lastsuccessfulsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.LastSuccessfulSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.LastSuccessfulSyncTime ## -description Gets or sets the last time the folder was successfully synced with the server. ## -property-value The last time the folder was successfully synced with the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.LastSuccessfulSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.LastSuccessfulSyncTime + +## -description +Gets or sets the last time the folder was successfully synced with the server. + +## -property-value +The last time the folder was successfully synced with the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_mailboxid.md b/windows.applicationmodel.email/emailfolder_mailboxid.md index f8f422b9d1..6e91f53507 100644 --- a/windows.applicationmodel.email/emailfolder_mailboxid.md +++ b/windows.applicationmodel.email/emailfolder_mailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.MailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.MailboxId ## -description Gets the ID of the mailbox that contains this folder. ## -property-value The ID of the mailbox that contains this folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.MailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.MailboxId + +## -description +Gets the ID of the mailbox that contains this folder. + +## -property-value +The ID of the mailbox that contains this folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_parentfolderid.md b/windows.applicationmodel.email/emailfolder_parentfolderid.md index efc94fc08e..4b2c1e4322 100644 --- a/windows.applicationmodel.email/emailfolder_parentfolderid.md +++ b/windows.applicationmodel.email/emailfolder_parentfolderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.ParentFolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.ParentFolderId ## -description Gets the ID of this folder's parent folder. ## -property-value The ID of this folder's parent folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.ParentFolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.ParentFolderId + +## -description +Gets the ID of this folder's parent folder. + +## -property-value +The ID of this folder's parent folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_remoteid.md b/windows.applicationmodel.email/emailfolder_remoteid.md index 1203487dce..0ed567bf1f 100644 --- a/windows.applicationmodel.email/emailfolder_remoteid.md +++ b/windows.applicationmodel.email/emailfolder_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailFolder.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailFolder.RemoteId ## -description Gets or sets the remote ID of the corresponding folder on the server. ## -property-value The remote ID of the corresponding folder on the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailFolder.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.RemoteId + +## -description +Gets or sets the remote ID of the corresponding folder on the server. + +## -property-value +The remote ID of the corresponding folder on the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_savemessageasync_1316266452.md b/windows.applicationmodel.email/emailfolder_savemessageasync_1316266452.md index 8a13919ec1..c1d52e0476 100644 --- a/windows.applicationmodel.email/emailfolder_savemessageasync_1316266452.md +++ b/windows.applicationmodel.email/emailfolder_savemessageasync_1316266452.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.SaveMessageAsync(Windows.ApplicationModel.Email.EmailMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.SaveMessageAsync ## -description Asynchronously saves the specified email message to the folder. ## -parameters ### -param message The email message to save. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.SaveMessageAsync(Windows.ApplicationModel.Email.EmailMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.SaveMessageAsync + +## -description +Asynchronously saves the specified email message to the folder. + +## -parameters +### -param message +The email message to save. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailfolder_trymoveasync_1068819194.md b/windows.applicationmodel.email/emailfolder_trymoveasync_1068819194.md index 4d16642373..90a6ae1f14 100644 --- a/windows.applicationmodel.email/emailfolder_trymoveasync_1068819194.md +++ b/windows.applicationmodel.email/emailfolder_trymoveasync_1068819194.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync(Windows.ApplicationModel.Email.EmailFolder) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync ## -description Asynchronously attempts to move this folder to the specified folder. ## -parameters ### -param newParentFolder The new location for this folder. ## -returns A Boolean value indicating if the move was successful. ## -remarks ## -examples ## -see-also [TryMoveAsync(EmailFolder, String)](emailfolder_trymoveasync_1934159686.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync(Windows.ApplicationModel.Email.EmailFolder) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync + +## -description +Asynchronously attempts to move this folder to the specified folder. + +## -parameters +### -param newParentFolder +The new location for this folder. + +## -returns +A Boolean value indicating if the move was successful. + +## -remarks + +## -examples + +## -see-also +[TryMoveAsync(EmailFolder, String)](emailfolder_trymoveasync_1934159686.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailfolder_trymoveasync_1934159686.md b/windows.applicationmodel.email/emailfolder_trymoveasync_1934159686.md index 179a2dcac0..7c5a9f4fcb 100644 --- a/windows.applicationmodel.email/emailfolder_trymoveasync_1934159686.md +++ b/windows.applicationmodel.email/emailfolder_trymoveasync_1934159686.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync(Windows.ApplicationModel.Email.EmailFolder,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync ## -description Asynchronously attempts to move this folder to the specified folder and rename it in the process. ## -parameters ### -param newParentFolder The new location for this folder. ### -param newFolderName The name for the folder in the new location. ## -returns A Boolean value indicating if the move was successful. ## -remarks ## -examples ## -see-also [TryMoveAsync(EmailFolder)](emailfolder_trymoveasync_1068819194.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync(Windows.ApplicationModel.Email.EmailFolder,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.TryMoveAsync + +## -description +Asynchronously attempts to move this folder to the specified folder and rename it in the process. + +## -parameters +### -param newParentFolder +The new location for this folder. + +### -param newFolderName +The name for the folder in the new location. + +## -returns +A Boolean value indicating if the move was successful. + +## -remarks + +## -examples + +## -see-also +[TryMoveAsync(EmailFolder)](emailfolder_trymoveasync_1068819194.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailfolder_trysaveasync_597946586.md b/windows.applicationmodel.email/emailfolder_trysaveasync_597946586.md index 32d3bcdc5f..0e4e44a9a5 100644 --- a/windows.applicationmodel.email/emailfolder_trysaveasync_597946586.md +++ b/windows.applicationmodel.email/emailfolder_trysaveasync_597946586.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailFolder.TrySaveAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailFolder.TrySaveAsync ## -description Asynchronously attempts to save changes to the folder. ## -returns A Boolean value indicating if the save was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailFolder.TrySaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailFolder.TrySaveAsync + +## -description +Asynchronously attempts to save changes to the folder. + +## -returns +A Boolean value indicating if the save was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo.md b/windows.applicationmodel.email/emailirminfo.md index e7882333c0..09f910ec34 100644 --- a/windows.applicationmodel.email/emailirminfo.md +++ b/windows.applicationmodel.email/emailirminfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailIrmInfo --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailIrmInfo ## -description Represents email information rights management (IRM) info. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailIrmInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo + +## -description +Represents email information rights management (IRM) info. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canedit.md b/windows.applicationmodel.email/emailirminfo_canedit.md index 0bd68afeec..ef47a349f6 100644 --- a/windows.applicationmodel.email/emailirminfo_canedit.md +++ b/windows.applicationmodel.email/emailirminfo_canedit.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanEdit --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanEdit ## -description Gets or sets a Boolean value that indicates if an email message is allowed to be edited. ## -property-value A Boolean value that indicates if an email message is allowed to be edited. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanEdit +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanEdit + +## -description +Gets or sets a Boolean value that indicates if an email message is allowed to be edited. + +## -property-value +A Boolean value that indicates if an email message is allowed to be edited. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canextractdata.md b/windows.applicationmodel.email/emailirminfo_canextractdata.md index 83aeb7e3a2..d561df7632 100644 --- a/windows.applicationmodel.email/emailirminfo_canextractdata.md +++ b/windows.applicationmodel.email/emailirminfo_canextractdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanExtractData --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanExtractData ## -description Gets or sets a Boolean value that indicates if the user can copy the contents of an email message to the clipboard. ## -property-value A Boolean value that indicates if the user can copy the contents of an email message to the clipboard. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanExtractData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanExtractData + +## -description +Gets or sets a Boolean value that indicates if the user can copy the contents of an email message to the clipboard. + +## -property-value +A Boolean value that indicates if the user can copy the contents of an email message to the clipboard. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canforward.md b/windows.applicationmodel.email/emailirminfo_canforward.md index b078031d08..0a48851a11 100644 --- a/windows.applicationmodel.email/emailirminfo_canforward.md +++ b/windows.applicationmodel.email/emailirminfo_canforward.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanForward --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanForward ## -description Gets or sets a Boolean value that indicates if the email message is allowed to be forwarded. ## -property-value A Boolean value that indicates if the email message is allowed to be forwarded. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanForward +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanForward + +## -description +Gets or sets a Boolean value that indicates if the email message is allowed to be forwarded. + +## -property-value +A Boolean value that indicates if the email message is allowed to be forwarded. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canmodifyrecipientsonresponse.md b/windows.applicationmodel.email/emailirminfo_canmodifyrecipientsonresponse.md index 47c592aa63..29aabd080f 100644 --- a/windows.applicationmodel.email/emailirminfo_canmodifyrecipientsonresponse.md +++ b/windows.applicationmodel.email/emailirminfo_canmodifyrecipientsonresponse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanModifyRecipientsOnResponse --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanModifyRecipientsOnResponse ## -description Gets or sets a Boolean value that indicates if the user is allowed to change any of the email recipients when responding. ## -property-value A Boolean value that indicates if the user is allowed to change any of the email recipients when responding. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanModifyRecipientsOnResponse +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanModifyRecipientsOnResponse + +## -description +Gets or sets a Boolean value that indicates if the user is allowed to change any of the email recipients when responding. + +## -property-value +A Boolean value that indicates if the user is allowed to change any of the email recipients when responding. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canprintdata.md b/windows.applicationmodel.email/emailirminfo_canprintdata.md index 691dc40ae5..41b51a82a0 100644 --- a/windows.applicationmodel.email/emailirminfo_canprintdata.md +++ b/windows.applicationmodel.email/emailirminfo_canprintdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanPrintData --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanPrintData ## -description Gets or sets a Boolean value that indicates if the user is allowed to print the contents of the email message or any attachments. ## -property-value A Boolean value that indicates if the user is allowed to print the contents of the email message or any attachments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanPrintData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanPrintData + +## -description +Gets or sets a Boolean value that indicates if the user is allowed to print the contents of the email message or any attachments. + +## -property-value +A Boolean value that indicates if the user is allowed to print the contents of the email message or any attachments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canremoveirmonresponse.md b/windows.applicationmodel.email/emailirminfo_canremoveirmonresponse.md index 006b979127..1fe00bebf5 100644 --- a/windows.applicationmodel.email/emailirminfo_canremoveirmonresponse.md +++ b/windows.applicationmodel.email/emailirminfo_canremoveirmonresponse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanRemoveIrmOnResponse --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanRemoveIrmOnResponse ## -description Gets or sets a Boolean value that indicates if the recipient is allowed to remove information rights management (IRM) when responding. ## -property-value A Boolean value that indicates if the recipient is allowed to remove IRM when responding. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanRemoveIrmOnResponse +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanRemoveIrmOnResponse + +## -description +Gets or sets a Boolean value that indicates if the recipient is allowed to remove information rights management (IRM) when responding. + +## -property-value +A Boolean value that indicates if the recipient is allowed to remove IRM when responding. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canreply.md b/windows.applicationmodel.email/emailirminfo_canreply.md index 73a3dcc96f..bb6e870b39 100644 --- a/windows.applicationmodel.email/emailirminfo_canreply.md +++ b/windows.applicationmodel.email/emailirminfo_canreply.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanReply --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanReply ## -description Gets or sets a Boolean value that indicates if the recipient is allowed to reply to the email message. ## -property-value A Boolean value that indicates if the recipient is allowed to reply to the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanReply +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanReply + +## -description +Gets or sets a Boolean value that indicates if the recipient is allowed to reply to the email message. + +## -property-value +A Boolean value that indicates if the recipient is allowed to reply to the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_canreplyall.md b/windows.applicationmodel.email/emailirminfo_canreplyall.md index a87ed297cd..1e445b56b6 100644 --- a/windows.applicationmodel.email/emailirminfo_canreplyall.md +++ b/windows.applicationmodel.email/emailirminfo_canreplyall.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanReplyAll --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.CanReplyAll ## -description Gets or sets a Boolean value that indicates if the recipient is allowed to reply all to the email message. ## -property-value A Boolean value that indicates if the recipient is allowed to reply all to the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.CanReplyAll +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.CanReplyAll + +## -description +Gets or sets a Boolean value that indicates if the recipient is allowed to reply all to the email message. + +## -property-value +A Boolean value that indicates if the recipient is allowed to reply all to the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_emailirminfo_1221375020.md b/windows.applicationmodel.email/emailirminfo_emailirminfo_1221375020.md index 94bee48198..7209795494 100644 --- a/windows.applicationmodel.email/emailirminfo_emailirminfo_1221375020.md +++ b/windows.applicationmodel.email/emailirminfo_emailirminfo_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailIrmInfo.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailIrmInfo.EmailIrmInfo ## -description Initializes a new instance of the [EmailIrmInfo](emailirminfo.md) class. ## -remarks ## -examples ## -see-also [EmailIrmInfo(DateTime, EmailIrmTemplate)](emailirminfo_emailirminfo_1624415405.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailIrmInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.EmailIrmInfo + +## -description +Initializes a new instance of the [EmailIrmInfo](emailirminfo.md) class. + +## -remarks + +## -examples + +## -see-also +[EmailIrmInfo(DateTime, EmailIrmTemplate)](emailirminfo_emailirminfo_1624415405.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailirminfo_emailirminfo_1624415405.md b/windows.applicationmodel.email/emailirminfo_emailirminfo_1624415405.md index 23a72cb609..efa5fd7bea 100644 --- a/windows.applicationmodel.email/emailirminfo_emailirminfo_1624415405.md +++ b/windows.applicationmodel.email/emailirminfo_emailirminfo_1624415405.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailIrmInfo.#ctor(Windows.Foundation.DateTime,Windows.ApplicationModel.Email.EmailIrmTemplate) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailIrmInfo.EmailIrmInfo ## -description Initializes a new instance of the [EmailIrmInfo](emailirminfo.md) class using the specified IRM expiration time and template. ## -parameters ### -param expiration The time when the information rights management (IRM) permissions expire. ### -param irmTemplate The IRM template to apply to the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailIrmInfo.#ctor(Windows.Foundation.DateTime,Windows.ApplicationModel.Email.EmailIrmTemplate) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.EmailIrmInfo + +## -description +Initializes a new instance of the [EmailIrmInfo](emailirminfo.md) class using the specified IRM expiration time and template. + +## -parameters +### -param expiration +The time when the information rights management (IRM) permissions expire. + +### -param irmTemplate +The IRM template to apply to the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_expirationdate.md b/windows.applicationmodel.email/emailirminfo_expirationdate.md index 6ac3a85b55..b7969aeccd 100644 --- a/windows.applicationmodel.email/emailirminfo_expirationdate.md +++ b/windows.applicationmodel.email/emailirminfo_expirationdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.ExpirationDate --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.ExpirationDate ## -description Gets or sets the expiration date for the information rights management (IRM) permissions. ## -property-value The expiration date for the IRM permissions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.ExpirationDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.ExpirationDate + +## -description +Gets or sets the expiration date for the information rights management (IRM) permissions. + +## -property-value +The expiration date for the IRM permissions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_isirmoriginator.md b/windows.applicationmodel.email/emailirminfo_isirmoriginator.md index c7a18d3938..ef8d4d5666 100644 --- a/windows.applicationmodel.email/emailirminfo_isirmoriginator.md +++ b/windows.applicationmodel.email/emailirminfo_isirmoriginator.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.IsIrmOriginator --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.IsIrmOriginator ## -description Gets or sets a Boolean value that indicates if the sender is the information rights management (IRM) originator. ## -property-value A Boolean value that indicates if the sender is the information rights management (IRM) originator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.IsIrmOriginator +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.IsIrmOriginator + +## -description +Gets or sets a Boolean value that indicates if the sender is the information rights management (IRM) originator. + +## -property-value +A Boolean value that indicates if the sender is the information rights management (IRM) originator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_isprogramaticaccessallowed.md b/windows.applicationmodel.email/emailirminfo_isprogramaticaccessallowed.md index 74aa0bfb52..567bd1a4cd 100644 --- a/windows.applicationmodel.email/emailirminfo_isprogramaticaccessallowed.md +++ b/windows.applicationmodel.email/emailirminfo_isprogramaticaccessallowed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.IsProgramaticAccessAllowed --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.IsProgramaticAccessAllowed ## -description Gets or sets a Boolean value that indicates if programmatic access to the message is allowed. ## -property-value A Boolean value that indicates if programmatic access to the message is allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.IsProgramaticAccessAllowed +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.IsProgramaticAccessAllowed + +## -description +Gets or sets a Boolean value that indicates if programmatic access to the message is allowed. + +## -property-value +A Boolean value that indicates if programmatic access to the message is allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirminfo_template.md b/windows.applicationmodel.email/emailirminfo_template.md index c12bd795f0..98051c4f72 100644 --- a/windows.applicationmodel.email/emailirminfo_template.md +++ b/windows.applicationmodel.email/emailirminfo_template.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.Template --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmInfo.Template ## -description Gets or sets the [EmailIrmTemplate](emailirmtemplate.md) used to create the information rights management (IRM) info. ## -property-value The [EmailIrmTemplate](emailirmtemplate.md) used to create the information rights management (IRM) info. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmInfo.Template +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmInfo.Template + +## -description +Gets or sets the [EmailIrmTemplate](emailirmtemplate.md) used to create the information rights management (IRM) info. + +## -property-value +The [EmailIrmTemplate](emailirmtemplate.md) used to create the information rights management (IRM) info. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirmtemplate.md b/windows.applicationmodel.email/emailirmtemplate.md index 105f09d80d..92fb7a72f5 100644 --- a/windows.applicationmodel.email/emailirmtemplate.md +++ b/windows.applicationmodel.email/emailirmtemplate.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailIrmTemplate --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailIrmTemplate ## -description Represents a template that can be used to create new [EmailIrmInfo](emailirminfo.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailIrmTemplate +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailIrmTemplate + +## -description +Represents a template that can be used to create new [EmailIrmInfo](emailirminfo.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirmtemplate_description.md b/windows.applicationmodel.email/emailirmtemplate_description.md index 6a07f71bc1..e46b27f977 100644 --- a/windows.applicationmodel.email/emailirmtemplate_description.md +++ b/windows.applicationmodel.email/emailirmtemplate_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmTemplate.Description --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmTemplate.Description ## -description Gets or sets the description of the template. ## -property-value The description of the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmTemplate.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmTemplate.Description + +## -description +Gets or sets the description of the template. + +## -property-value +The description of the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1001825332.md b/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1001825332.md index 84d9eeec0f..a0190db1a4 100644 --- a/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1001825332.md +++ b/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1001825332.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailIrmTemplate.#ctor(System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailIrmTemplate.EmailIrmTemplate ## -description Creates a new instance of the [EmailIrmTemplate](emailirmtemplate.md) class with the specified ID, name and description. ## -parameters ### -param id The ID for the new template. ### -param name The name of the new template. ### -param description The description of the new template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailIrmTemplate.#ctor(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailIrmTemplate.EmailIrmTemplate + +## -description +Creates a new instance of the [EmailIrmTemplate](emailirmtemplate.md) class with the specified ID, name and description. + +## -parameters +### -param id +The ID for the new template. + +### -param name +The name of the new template. + +### -param description +The description of the new template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1221375020.md b/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1221375020.md index ea5d63d196..46f44ca90c 100644 --- a/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1221375020.md +++ b/windows.applicationmodel.email/emailirmtemplate_emailirmtemplate_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailIrmTemplate.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailIrmTemplate.EmailIrmTemplate ## -description Creates a new instance of the [EmailIrmTemplate](emailirmtemplate.md) class. ## -remarks ## -examples ## -see-also [EmailIrmTemplate(String, String, String)](emailirmtemplate_emailirmtemplate_1001825332.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailIrmTemplate.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailIrmTemplate.EmailIrmTemplate + +## -description +Creates a new instance of the [EmailIrmTemplate](emailirmtemplate.md) class. + +## -remarks + +## -examples + +## -see-also +[EmailIrmTemplate(String, String, String)](emailirmtemplate_emailirmtemplate_1001825332.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailirmtemplate_id.md b/windows.applicationmodel.email/emailirmtemplate_id.md index 8b339a20da..8487a00c8a 100644 --- a/windows.applicationmodel.email/emailirmtemplate_id.md +++ b/windows.applicationmodel.email/emailirmtemplate_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmTemplate.Id --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmTemplate.Id ## -description Gets or sets the ID for the template. ## -property-value The ID for the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmTemplate.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmTemplate.Id + +## -description +Gets or sets the ID for the template. + +## -property-value +The ID for the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailirmtemplate_name.md b/windows.applicationmodel.email/emailirmtemplate_name.md index 23499a6b1a..b904c412c8 100644 --- a/windows.applicationmodel.email/emailirmtemplate_name.md +++ b/windows.applicationmodel.email/emailirmtemplate_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailIrmTemplate.Name --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailIrmTemplate.Name ## -description Gets or sets the name for the template. ## -property-value The name for the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailIrmTemplate.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailIrmTemplate.Name + +## -description +Gets or sets the name for the template. + +## -property-value +The name for the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailitemcounts.md b/windows.applicationmodel.email/emailitemcounts.md index 5304d06983..c11ab945e0 100644 --- a/windows.applicationmodel.email/emailitemcounts.md +++ b/windows.applicationmodel.email/emailitemcounts.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailItemCounts --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailItemCounts ## -description Represents the counts for various email message attributes such as flagged, important, unread, and so on. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailItemCounts +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailItemCounts + +## -description +Represents the counts for various email message attributes such as flagged, important, unread, and so on. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailitemcounts_flagged.md b/windows.applicationmodel.email/emailitemcounts_flagged.md index e922fe757a..3e5744b8eb 100644 --- a/windows.applicationmodel.email/emailitemcounts_flagged.md +++ b/windows.applicationmodel.email/emailitemcounts_flagged.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Flagged --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailItemCounts.Flagged ## -description Gets the number of flagged email messages. ## -property-value The number of flagged email messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Flagged +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailItemCounts.Flagged + +## -description +Gets the number of flagged email messages. + +## -property-value +The number of flagged email messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailitemcounts_important.md b/windows.applicationmodel.email/emailitemcounts_important.md index 0be7c75944..c740aad7fa 100644 --- a/windows.applicationmodel.email/emailitemcounts_important.md +++ b/windows.applicationmodel.email/emailitemcounts_important.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Important --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailItemCounts.Important ## -description Gets the number of important email messages. ## -property-value The number of important email messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Important +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailItemCounts.Important + +## -description +Gets the number of important email messages. + +## -property-value +The number of important email messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailitemcounts_total.md b/windows.applicationmodel.email/emailitemcounts_total.md index 644c1c6893..012893e2db 100644 --- a/windows.applicationmodel.email/emailitemcounts_total.md +++ b/windows.applicationmodel.email/emailitemcounts_total.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Total --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailItemCounts.Total ## -description Gets the total number of email messages ## -property-value The total number of email messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Total +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailItemCounts.Total + +## -description +Gets the total number of email messages + +## -property-value +The total number of email messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailitemcounts_unread.md b/windows.applicationmodel.email/emailitemcounts_unread.md index a17027b707..425f8af9bf 100644 --- a/windows.applicationmodel.email/emailitemcounts_unread.md +++ b/windows.applicationmodel.email/emailitemcounts_unread.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Unread --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailItemCounts.Unread ## -description Gets the number of unread email messages. ## -property-value The number of unread email messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailItemCounts.Unread +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailItemCounts.Unread + +## -description +Gets the number of unread email messages. + +## -property-value +The number of unread email messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox.md b/windows.applicationmodel.email/emailmailbox.md index 302bd33b7e..0c282013a8 100644 --- a/windows.applicationmodel.email/emailmailbox.md +++ b/windows.applicationmodel.email/emailmailbox.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailbox --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailbox ## -description Represents an email mailbox located on a remote email server. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailbox +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox + +## -description +Represents an email mailbox located on a remote email server. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_capabilities.md b/windows.applicationmodel.email/emailmailbox_capabilities.md index 39ff65100e..41018d8afc 100644 --- a/windows.applicationmodel.email/emailmailbox_capabilities.md +++ b/windows.applicationmodel.email/emailmailbox_capabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.Capabilities --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.Capabilities ## -description Gets the capabilities associated with the mailbox. ## -property-value The capabilities associated with the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.Capabilities +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.Capabilities + +## -description +Gets the capabilities associated with the mailbox. + +## -property-value +The capabilities associated with the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_changemessageflagstateasync_1418897785.md b/windows.applicationmodel.email/emailmailbox_changemessageflagstateasync_1418897785.md index cc2bb82be4..ee44ff7761 100644 --- a/windows.applicationmodel.email/emailmailbox_changemessageflagstateasync_1418897785.md +++ b/windows.applicationmodel.email/emailmailbox_changemessageflagstateasync_1418897785.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.ChangeMessageFlagStateAsync(System.String,Windows.ApplicationModel.Email.EmailFlagState) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.ChangeMessageFlagStateAsync ## -description Asynchronously changes the flag state of an email message. ## -parameters ### -param messageId The ID of the email message to change. ### -param flagState The new email flag state. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.ChangeMessageFlagStateAsync(System.String,Windows.ApplicationModel.Email.EmailFlagState) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.ChangeMessageFlagStateAsync + +## -description +Asynchronously changes the flag state of an email message. + +## -parameters +### -param messageId +The ID of the email message to change. + +### -param flagState +The new email flag state. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_changetracker.md b/windows.applicationmodel.email/emailmailbox_changetracker.md index 855b1e489b..6c873b2058 100644 --- a/windows.applicationmodel.email/emailmailbox_changetracker.md +++ b/windows.applicationmodel.email/emailmailbox_changetracker.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.ChangeTracker --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.ChangeTracker ## -description Gets the [EmailMailboxChangeTracker](emailmailboxchangetracker.md) for this mailbox. ## -property-value The change tracker for this mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.ChangeTracker +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.ChangeTracker + +## -description +Gets the [EmailMailboxChangeTracker](emailmailboxchangetracker.md) for this mailbox. + +## -property-value +The change tracker for this mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_createresponsemessageasync_1507631927.md b/windows.applicationmodel.email/emailmailbox_createresponsemessageasync_1507631927.md index a421201cf9..da3eef15da 100644 --- a/windows.applicationmodel.email/emailmailbox_createresponsemessageasync_1507631927.md +++ b/windows.applicationmodel.email/emailmailbox_createresponsemessageasync_1507631927.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.CreateResponseMessageAsync(System.String,Windows.ApplicationModel.Email.EmailMessageResponseKind,System.String,Windows.ApplicationModel.Email.EmailMessageBodyKind,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.CreateResponseMessageAsync ## -description Creates a new response email such as Reply, Reply All, Forward, and so on. ## -parameters ### -param messageId The ID of the message to which to respond. ### -param responseType The type of response such as Reply, Reply All, Forward, and so on. ### -param subject The subject for the response message. ### -param responseHeaderType The format of the email body such as plain text or HTML. ### -param responseHeader The header for the response message. ## -returns The newly created response email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.CreateResponseMessageAsync(System.String,Windows.ApplicationModel.Email.EmailMessageResponseKind,System.String,Windows.ApplicationModel.Email.EmailMessageBodyKind,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.CreateResponseMessageAsync + +## -description +Creates a new response email such as Reply, Reply All, Forward, and so on. + +## -parameters +### -param messageId +The ID of the message to which to respond. + +### -param responseType +The type of response such as Reply, Reply All, Forward, and so on. + +### -param subject +The subject for the response message. + +### -param responseHeaderType +The format of the email body such as plain text or HTML. + +### -param responseHeader +The header for the response message. + +## -returns +The newly created response email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_deleteasync_1247887881.md b/windows.applicationmodel.email/emailmailbox_deleteasync_1247887881.md index 3a4826004b..1bb06c35ce 100644 --- a/windows.applicationmodel.email/emailmailbox_deleteasync_1247887881.md +++ b/windows.applicationmodel.email/emailmailbox_deleteasync_1247887881.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.DeleteAsync ## -description Asynchronously deletes the mailbox. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.DeleteAsync + +## -description +Asynchronously deletes the mailbox. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_deletemessageasync_1226730004.md b/windows.applicationmodel.email/emailmailbox_deletemessageasync_1226730004.md index b74ea55bf9..7b2796c0a1 100644 --- a/windows.applicationmodel.email/emailmailbox_deletemessageasync_1226730004.md +++ b/windows.applicationmodel.email/emailmailbox_deletemessageasync_1226730004.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DeleteMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.DeleteMessageAsync ## -description Asynchronously deletes an email message from the mailbox. ## -parameters ### -param messageId The ID of the email message to delete. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DeleteMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.DeleteMessageAsync + +## -description +Asynchronously deletes an email message from the mailbox. + +## -parameters +### -param messageId +The ID of the email message to delete. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_displayname.md b/windows.applicationmodel.email/emailmailbox_displayname.md index f6fd07ff97..987e24d021 100644 --- a/windows.applicationmodel.email/emailmailbox_displayname.md +++ b/windows.applicationmodel.email/emailmailbox_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.DisplayName ## -description Gets or sets the name for this mailbox that is suitable for displaying. ## -property-value The name for this mailbox that is suitable for displaying. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.DisplayName + +## -description +Gets or sets the name for this mailbox that is suitable for displaying. + +## -property-value +The name for this mailbox that is suitable for displaying. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_downloadattachmentasync_797165234.md b/windows.applicationmodel.email/emailmailbox_downloadattachmentasync_797165234.md index 1d5da6aa8d..5727bd471b 100644 --- a/windows.applicationmodel.email/emailmailbox_downloadattachmentasync_797165234.md +++ b/windows.applicationmodel.email/emailmailbox_downloadattachmentasync_797165234.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DownloadAttachmentAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.DownloadAttachmentAsync ## -description Asynchronously downloads an email attachment. ## -parameters ### -param attachmentId The ID of the attachment to download. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DownloadAttachmentAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.DownloadAttachmentAsync + +## -description +Asynchronously downloads an email attachment. + +## -parameters +### -param attachmentId +The ID of the attachment to download. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_downloadmessageasync_242041271.md b/windows.applicationmodel.email/emailmailbox_downloadmessageasync_242041271.md index 014a2ba80b..bb8e587f48 100644 --- a/windows.applicationmodel.email/emailmailbox_downloadmessageasync_242041271.md +++ b/windows.applicationmodel.email/emailmailbox_downloadmessageasync_242041271.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DownloadMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.DownloadMessageAsync ## -description Asynchronously downloads the specified email message. ## -parameters ### -param messageId The ID of the message to download. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.DownloadMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.DownloadMessageAsync + +## -description +Asynchronously downloads the specified email message. + +## -parameters +### -param messageId +The ID of the message to download. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_getconversationasync_2049140047.md b/windows.applicationmodel.email/emailmailbox_getconversationasync_2049140047.md index c9a8393c19..e9a1d79c52 100644 --- a/windows.applicationmodel.email/emailmailbox_getconversationasync_2049140047.md +++ b/windows.applicationmodel.email/emailmailbox_getconversationasync_2049140047.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetConversationAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetConversationAsync ## -description Asynchronously gets the specified email conversation. ## -parameters ### -param id The ID of the email conversation to retrieve. ## -returns Returns the email conversation specified by the *id* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetConversationAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetConversationAsync + +## -description +Asynchronously gets the specified email conversation. + +## -parameters +### -param id +The ID of the email conversation to retrieve. + +## -returns +Returns the email conversation specified by the *id* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_getconversationreader_388570943.md b/windows.applicationmodel.email/emailmailbox_getconversationreader_388570943.md index 744b66bdb7..1488cd738b 100644 --- a/windows.applicationmodel.email/emailmailbox_getconversationreader_388570943.md +++ b/windows.applicationmodel.email/emailmailbox_getconversationreader_388570943.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader ## -description Gets or creates an email conversation reader for this mailbox if one does not already exist. ## -returns The email conversation reader. ## -remarks ## -examples ## -see-also [GetConversationReader(EmailQueryOptions)](emailmailbox_getconversationreader_964157301.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader + +## -description +Gets or creates an email conversation reader for this mailbox if one does not already exist. + +## -returns +The email conversation reader. + +## -remarks + +## -examples + +## -see-also +[GetConversationReader(EmailQueryOptions)](emailmailbox_getconversationreader_964157301.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_getconversationreader_964157301.md b/windows.applicationmodel.email/emailmailbox_getconversationreader_964157301.md index 4feed9463b..ae1ddaa21c 100644 --- a/windows.applicationmodel.email/emailmailbox_getconversationreader_964157301.md +++ b/windows.applicationmodel.email/emailmailbox_getconversationreader_964157301.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader(Windows.ApplicationModel.Email.EmailQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader ## -description Gets or creates an email conversation reader for this mailbox using the specified query options. ## -parameters ### -param options The email query options to use when creating the conversation reader. ## -returns The new or existing conversation reader. ## -remarks ## -examples ## -see-also [GetConversationReader](emailmailbox_getconversationreader_388570943.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader(Windows.ApplicationModel.Email.EmailQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetConversationReader + +## -description +Gets or creates an email conversation reader for this mailbox using the specified query options. + +## -parameters +### -param options +The email query options to use when creating the conversation reader. + +## -returns +The new or existing conversation reader. + +## -remarks + +## -examples + +## -see-also +[GetConversationReader](emailmailbox_getconversationreader_388570943.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_getfolderasync_761626819.md b/windows.applicationmodel.email/emailmailbox_getfolderasync_761626819.md index adfce8475f..3d4530f185 100644 --- a/windows.applicationmodel.email/emailmailbox_getfolderasync_761626819.md +++ b/windows.applicationmodel.email/emailmailbox_getfolderasync_761626819.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetFolderAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetFolderAsync ## -description Asynchronously gets the specified email folder. ## -parameters ### -param id The ID of the folder to retrieve. ## -returns The email folder specified in the *id* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetFolderAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetFolderAsync + +## -description +Asynchronously gets the specified email folder. + +## -parameters +### -param id +The ID of the folder to retrieve. + +## -returns +The email folder specified in the *id* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_getmessageasync_151244055.md b/windows.applicationmodel.email/emailmailbox_getmessageasync_151244055.md index cafe03e38d..c8e0740f65 100644 --- a/windows.applicationmodel.email/emailmailbox_getmessageasync_151244055.md +++ b/windows.applicationmodel.email/emailmailbox_getmessageasync_151244055.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetMessageAsync ## -description Asynchronously gets the specified email message. ## -parameters ### -param id The ID of the message to retrieve. ## -returns The email message specified in the *id* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetMessageAsync + +## -description +Asynchronously gets the specified email message. + +## -parameters +### -param id +The ID of the message to retrieve. + +## -returns +The email message specified in the *id* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_getmessagereader_1198599356.md b/windows.applicationmodel.email/emailmailbox_getmessagereader_1198599356.md index 78edf91c05..2068a33cf1 100644 --- a/windows.applicationmodel.email/emailmailbox_getmessagereader_1198599356.md +++ b/windows.applicationmodel.email/emailmailbox_getmessagereader_1198599356.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader ## -description Gets or creates an email message reader for this mailbox if one does not already exist. ## -returns The new or existing email message reader. ## -remarks ## -examples ## -see-also [GetMessageReader(EmailQueryOptions)](emailmailbox_getmessagereader_1764748530.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader + +## -description +Gets or creates an email message reader for this mailbox if one does not already exist. + +## -returns +The new or existing email message reader. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader(EmailQueryOptions)](emailmailbox_getmessagereader_1764748530.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_getmessagereader_1764748530.md b/windows.applicationmodel.email/emailmailbox_getmessagereader_1764748530.md index a6cd623105..aa82327dd4 100644 --- a/windows.applicationmodel.email/emailmailbox_getmessagereader_1764748530.md +++ b/windows.applicationmodel.email/emailmailbox_getmessagereader_1764748530.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader(Windows.ApplicationModel.Email.EmailQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader ## -description Gets or creates an email conversation reader for this mailbox using the specified query options. ## -parameters ### -param options The email query options to use when creating the message reader. ## -returns The new or existing email message reader. ## -remarks ## -examples ## -see-also [GetMessageReader](emailmailbox_getmessagereader_1198599356.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader(Windows.ApplicationModel.Email.EmailQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetMessageReader + +## -description +Gets or creates an email conversation reader for this mailbox using the specified query options. + +## -parameters +### -param options +The email query options to use when creating the message reader. + +## -returns +The new or existing email message reader. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader](emailmailbox_getmessagereader_1198599356.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_getspecialfolderasync_1729558602.md b/windows.applicationmodel.email/emailmailbox_getspecialfolderasync_1729558602.md index ab07604034..dacd3c7f9e 100644 --- a/windows.applicationmodel.email/emailmailbox_getspecialfolderasync_1729558602.md +++ b/windows.applicationmodel.email/emailmailbox_getspecialfolderasync_1729558602.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetSpecialFolderAsync(Windows.ApplicationModel.Email.EmailSpecialFolderKind) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.GetSpecialFolderAsync ## -description Asynchronously get a special email folder such as Inbox, Outbox, Drafts and so on. ## -parameters ### -param folderType The type of folder to retrieve. ## -returns The matching special email folder in this mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetSpecialFolderAsync(Windows.ApplicationModel.Email.EmailSpecialFolderKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetSpecialFolderAsync + +## -description +Asynchronously get a special email folder such as Inbox, Outbox, Drafts and so on. + +## -parameters +### -param folderType +The type of folder to retrieve. + +## -returns +The matching special email folder in this mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_id.md b/windows.applicationmodel.email/emailmailbox_id.md index 3e957d1249..4dc4fe03cc 100644 --- a/windows.applicationmodel.email/emailmailbox_id.md +++ b/windows.applicationmodel.email/emailmailbox_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.Id --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.Id ## -description Gets the ID for this mailbox. ## -property-value The ID for this mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.Id + +## -description +Gets the ID for this mailbox. + +## -property-value +The ID for this mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_isdataencryptedunderlock.md b/windows.applicationmodel.email/emailmailbox_isdataencryptedunderlock.md index 89eb0634e4..8dfbca9b37 100644 --- a/windows.applicationmodel.email/emailmailbox_isdataencryptedunderlock.md +++ b/windows.applicationmodel.email/emailmailbox_isdataencryptedunderlock.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.IsDataEncryptedUnderLock --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.IsDataEncryptedUnderLock ## -description Gets a Boolean value that indicates if email data is encrypted when the device is locked. ## -property-value Boolean value that indicates if email data is encrypted when the device is locked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.IsDataEncryptedUnderLock +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.IsDataEncryptedUnderLock + +## -description +Gets a Boolean value that indicates if email data is encrypted when the device is locked. + +## -property-value +Boolean value that indicates if email data is encrypted when the device is locked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_isownedbycurrentapp.md b/windows.applicationmodel.email/emailmailbox_isownedbycurrentapp.md index 537ce990ba..1a7abd06dc 100644 --- a/windows.applicationmodel.email/emailmailbox_isownedbycurrentapp.md +++ b/windows.applicationmodel.email/emailmailbox_isownedbycurrentapp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.IsOwnedByCurrentApp --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.IsOwnedByCurrentApp ## -description Gets a Boolean value that indicates if this mailbox is owned by the current app. ## -property-value Boolean value that indicates if this mailbox is owned by the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.IsOwnedByCurrentApp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.IsOwnedByCurrentApp + +## -description +Gets a Boolean value that indicates if this mailbox is owned by the current app. + +## -property-value +Boolean value that indicates if this mailbox is owned by the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_linkedmailboxid.md b/windows.applicationmodel.email/emailmailbox_linkedmailboxid.md index 622055e74d..d331c61662 100644 --- a/windows.applicationmodel.email/emailmailbox_linkedmailboxid.md +++ b/windows.applicationmodel.email/emailmailbox_linkedmailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.LinkedMailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.LinkedMailboxId ## -description Gets the identifier for a mailbox linked to this one. ## -property-value The identifier for a mailbox linked to this one. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.LinkedMailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.LinkedMailboxId + +## -description +Gets the identifier for a mailbox linked to this one. + +## -property-value +The identifier for a mailbox linked to this one. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_mailaddress.md b/windows.applicationmodel.email/emailmailbox_mailaddress.md index 51aceda4ff..d86eac35d8 100644 --- a/windows.applicationmodel.email/emailmailbox_mailaddress.md +++ b/windows.applicationmodel.email/emailmailbox_mailaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.MailAddress --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.MailAddress ## -description Gets or sets the email address for the mailbox. ## -property-value The email address for the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.MailAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MailAddress + +## -description +Gets or sets the email address for the mailbox. + +## -property-value +The email address for the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_mailaddressaliases.md b/windows.applicationmodel.email/emailmailbox_mailaddressaliases.md index e921288dae..6b9fa20e7b 100644 --- a/windows.applicationmodel.email/emailmailbox_mailaddressaliases.md +++ b/windows.applicationmodel.email/emailmailbox_mailaddressaliases.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.MailAddressAliases --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.MailAddressAliases ## -description Gets the list of email aliases associated with this mailbox. ## -property-value The list of email aliases associated with this mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.MailAddressAliases +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MailAddressAliases + +## -description +Gets the list of email aliases associated with this mailbox. + +## -property-value +The list of email aliases associated with this mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_mailboxchanged.md b/windows.applicationmodel.email/emailmailbox_mailboxchanged.md index 294c934425..6c76d42d9f 100644 --- a/windows.applicationmodel.email/emailmailbox_mailboxchanged.md +++ b/windows.applicationmodel.email/emailmailbox_mailboxchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.EmailMailbox.MailboxChanged --api-type: winrt event ---- # Windows.ApplicationModel.Email.EmailMailbox.MailboxChanged ## -description Occurs when the mailbox has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.EmailMailbox.MailboxChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MailboxChanged + +## -description +Occurs when the mailbox has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_markfolderasseenasync_1954019652.md b/windows.applicationmodel.email/emailmailbox_markfolderasseenasync_1954019652.md index a9fa87280e..56f50bf82e 100644 --- a/windows.applicationmodel.email/emailmailbox_markfolderasseenasync_1954019652.md +++ b/windows.applicationmodel.email/emailmailbox_markfolderasseenasync_1954019652.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkFolderAsSeenAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.MarkFolderAsSeenAsync ## -description Asynchronously marks all the messages in a folder as seen. ## -parameters ### -param folderId The ID of the folder to mark as seen. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkFolderAsSeenAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MarkFolderAsSeenAsync + +## -description +Asynchronously marks all the messages in a folder as seen. + +## -parameters +### -param folderId +The ID of the folder to mark as seen. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_markfoldersyncenabledasync_51982407.md b/windows.applicationmodel.email/emailmailbox_markfoldersyncenabledasync_51982407.md index 0d280c6c65..031f1954c8 100644 --- a/windows.applicationmodel.email/emailmailbox_markfoldersyncenabledasync_51982407.md +++ b/windows.applicationmodel.email/emailmailbox_markfoldersyncenabledasync_51982407.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkFolderSyncEnabledAsync(System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.MarkFolderSyncEnabledAsync ## -description Asynchronously marks a folder as sync enabled or disabled. ## -parameters ### -param folderId The ID of the folder to mark. ### -param isSyncEnabled True to enable to syncing with the server, false to disable syncing. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkFolderSyncEnabledAsync(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MarkFolderSyncEnabledAsync + +## -description +Asynchronously marks a folder as sync enabled or disabled. + +## -parameters +### -param folderId +The ID of the folder to mark. + +### -param isSyncEnabled +True to enable to syncing with the server, false to disable syncing. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_markmessageasseenasync_1925480979.md b/windows.applicationmodel.email/emailmailbox_markmessageasseenasync_1925480979.md index 5f86338d7b..dd36f3eb9c 100644 --- a/windows.applicationmodel.email/emailmailbox_markmessageasseenasync_1925480979.md +++ b/windows.applicationmodel.email/emailmailbox_markmessageasseenasync_1925480979.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkMessageAsSeenAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.MarkMessageAsSeenAsync ## -description Asynchronously marks an email message as seen. ## -parameters ### -param messageId The ID of the message to mark as seen. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkMessageAsSeenAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MarkMessageAsSeenAsync + +## -description +Asynchronously marks an email message as seen. + +## -parameters +### -param messageId +The ID of the message to mark as seen. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_markmessagereadasync_485336334.md b/windows.applicationmodel.email/emailmailbox_markmessagereadasync_485336334.md index e81f9f98ee..1472f05f0e 100644 --- a/windows.applicationmodel.email/emailmailbox_markmessagereadasync_485336334.md +++ b/windows.applicationmodel.email/emailmailbox_markmessagereadasync_485336334.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkMessageReadAsync(System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.MarkMessageReadAsync ## -description Asynchronously marks an email message as read or unread. ## -parameters ### -param messageId The ID of the message to mark. ### -param isRead True to mark the message as read, false to mark it as unread. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.MarkMessageReadAsync(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.MarkMessageReadAsync + +## -description +Asynchronously marks an email message as read or unread. + +## -parameters +### -param messageId +The ID of the message to mark. + +### -param isRead +True to mark the message as read, false to mark it as unread. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_networkaccountid.md b/windows.applicationmodel.email/emailmailbox_networkaccountid.md index a145f62b5e..4d9adea1f1 100644 --- a/windows.applicationmodel.email/emailmailbox_networkaccountid.md +++ b/windows.applicationmodel.email/emailmailbox_networkaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.NetworkAccountId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.NetworkAccountId ## -description Gets the identifier of the email mailbox account within its network. ## -property-value The identifier of the email mailbox account within its network. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.NetworkAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.NetworkAccountId + +## -description +Gets the identifier of the email mailbox account within its network. + +## -property-value +The identifier of the email mailbox account within its network. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_networkid.md b/windows.applicationmodel.email/emailmailbox_networkid.md index 989534df06..de0495881c 100644 --- a/windows.applicationmodel.email/emailmailbox_networkid.md +++ b/windows.applicationmodel.email/emailmailbox_networkid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.NetworkId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.NetworkId ## -description Gets the identifier of the network associated with this email mailbox. ## -property-value The identifier of the network associated with this email mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.NetworkId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.NetworkId + +## -description +Gets the identifier of the network associated with this email mailbox. + +## -property-value +The identifier of the network associated with this email mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_otherappreadaccess.md b/windows.applicationmodel.email/emailmailbox_otherappreadaccess.md index 7af83e1df6..007369c3f5 100644 --- a/windows.applicationmodel.email/emailmailbox_otherappreadaccess.md +++ b/windows.applicationmodel.email/emailmailbox_otherappreadaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.OtherAppReadAccess --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.OtherAppReadAccess ## -description Gets or sets the read access level to this mailbox for other apps. ## -property-value The read access level to this mailbox for other apps. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.OtherAppReadAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.OtherAppReadAccess + +## -description +Gets or sets the read access level to this mailbox for other apps. + +## -property-value +The read access level to this mailbox for other apps. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_otherappwriteaccess.md b/windows.applicationmodel.email/emailmailbox_otherappwriteaccess.md index 45b9d5ecf6..a370a65d10 100644 --- a/windows.applicationmodel.email/emailmailbox_otherappwriteaccess.md +++ b/windows.applicationmodel.email/emailmailbox_otherappwriteaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.OtherAppWriteAccess --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.OtherAppWriteAccess ## -description Gets or sets the write access level to this mailbox for other apps. ## -property-value The write access level to this mailbox for other apps. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.OtherAppWriteAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.OtherAppWriteAccess + +## -description +Gets or sets the write access level to this mailbox for other apps. + +## -property-value +The write access level to this mailbox for other apps. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_policies.md b/windows.applicationmodel.email/emailmailbox_policies.md index dd6f22048f..0b029a63fb 100644 --- a/windows.applicationmodel.email/emailmailbox_policies.md +++ b/windows.applicationmodel.email/emailmailbox_policies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.Policies --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.Policies ## -description Gets the security policies for attachments in this mailbox. ## -property-value The security policies for attachments in this mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.Policies +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.Policies + +## -description +Gets the security policies for attachments in this mailbox. + +## -property-value +The security policies for attachments in this mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_registersyncmanagerasync_1214558325.md b/windows.applicationmodel.email/emailmailbox_registersyncmanagerasync_1214558325.md index 0d84fdf4f2..547fa8448f 100644 --- a/windows.applicationmodel.email/emailmailbox_registersyncmanagerasync_1214558325.md +++ b/windows.applicationmodel.email/emailmailbox_registersyncmanagerasync_1214558325.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.RegisterSyncManagerAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.RegisterSyncManagerAsync ## -description Asynchronously registers this mailbox as a sync provider. ## -returns An asynchronous registration operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.RegisterSyncManagerAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.RegisterSyncManagerAsync + +## -description +Asynchronously registers this mailbox as a sync provider. + +## -returns +An asynchronous registration operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_resolverecipientsasync_1555064140.md b/windows.applicationmodel.email/emailmailbox_resolverecipientsasync_1555064140.md index e513ace07c..21e4a44357 100644 --- a/windows.applicationmodel.email/emailmailbox_resolverecipientsasync_1555064140.md +++ b/windows.applicationmodel.email/emailmailbox_resolverecipientsasync_1555064140.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.ResolveRecipientsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.ResolveRecipientsAsync ## -description Resolves a list of one or more email addresses. ## -parameters ### -param recipients The list of email addresses. ## -returns A list of resolution results. The result list will be in the same order as the input list. See [EmailRecipientResolutionResult](emailrecipientresolutionresult.md) for more information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.ResolveRecipientsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.ResolveRecipientsAsync + +## -description +Resolves a list of one or more email addresses. + +## -parameters +### -param recipients +The list of email addresses. + +## -returns +A list of resolution results. The result list will be in the same order as the input list. See [EmailRecipientResolutionResult](emailrecipientresolutionresult.md) for more information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_saveasync_2143735121.md b/windows.applicationmodel.email/emailmailbox_saveasync_2143735121.md index 8be5858cf8..2db1d3ab48 100644 --- a/windows.applicationmodel.email/emailmailbox_saveasync_2143735121.md +++ b/windows.applicationmodel.email/emailmailbox_saveasync_2143735121.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SaveAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.SaveAsync ## -description Asynchronously saves the mailbox to the email store. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.SaveAsync + +## -description +Asynchronously saves the mailbox to the email store. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_savedraftasync_1577597724.md b/windows.applicationmodel.email/emailmailbox_savedraftasync_1577597724.md index 10c6f1e2ce..c3087ce0c9 100644 --- a/windows.applicationmodel.email/emailmailbox_savedraftasync_1577597724.md +++ b/windows.applicationmodel.email/emailmailbox_savedraftasync_1577597724.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SaveDraftAsync(Windows.ApplicationModel.Email.EmailMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.SaveDraftAsync ## -description Asynchronously saves a draft email message. ## -parameters ### -param message The draft email message to save. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SaveDraftAsync(Windows.ApplicationModel.Email.EmailMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.SaveDraftAsync + +## -description +Asynchronously saves a draft email message. + +## -parameters +### -param message +The draft email message to save. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_sendmessageasync_654687737.md b/windows.applicationmodel.email/emailmailbox_sendmessageasync_654687737.md index 29fb1c69cb..151ccdbd88 100644 --- a/windows.applicationmodel.email/emailmailbox_sendmessageasync_654687737.md +++ b/windows.applicationmodel.email/emailmailbox_sendmessageasync_654687737.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync(Windows.ApplicationModel.Email.EmailMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync ## -description Asynchronously sends the specified email message. ## -parameters ### -param message The email message to send. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also [SendMessageAsync(EmailMessage, Boolean)](emailmailbox_sendmessageasync_983266815.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync(Windows.ApplicationModel.Email.EmailMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync + +## -description +Asynchronously sends the specified email message. + +## -parameters +### -param message +The email message to send. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also +[SendMessageAsync(EmailMessage, Boolean)](emailmailbox_sendmessageasync_983266815.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_sendmessageasync_983266815.md b/windows.applicationmodel.email/emailmailbox_sendmessageasync_983266815.md index 73b0f467a2..9701a07647 100644 --- a/windows.applicationmodel.email/emailmailbox_sendmessageasync_983266815.md +++ b/windows.applicationmodel.email/emailmailbox_sendmessageasync_983266815.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync(Windows.ApplicationModel.Email.EmailMessage,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync ## -description Asynchronously sends the specified email message. ## -parameters ### -param message The email message to send. ### -param smartSend True to send only the updated text, false to include the full message thread. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also [SendMessageAsync(EmailMessage)](emailmailbox_sendmessageasync_654687737.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync(Windows.ApplicationModel.Email.EmailMessage,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.SendMessageAsync + +## -description +Asynchronously sends the specified email message. + +## -parameters +### -param message +The email message to send. + +### -param smartSend +True to send only the updated text, false to include the full message thread. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also +[SendMessageAsync(EmailMessage)](emailmailbox_sendmessageasync_654687737.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_sourcedisplayname.md b/windows.applicationmodel.email/emailmailbox_sourcedisplayname.md index 69c28996b4..bdd00fe059 100644 --- a/windows.applicationmodel.email/emailmailbox_sourcedisplayname.md +++ b/windows.applicationmodel.email/emailmailbox_sourcedisplayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.SourceDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.SourceDisplayName ## -description Gets the display name of the source mailbox. ## -property-value The display name of the source mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.SourceDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.SourceDisplayName + +## -description +Gets the display name of the source mailbox. + +## -property-value +The display name of the source mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_syncmanager.md b/windows.applicationmodel.email/emailmailbox_syncmanager.md index 4b5e56aa4d..f0f7580319 100644 --- a/windows.applicationmodel.email/emailmailbox_syncmanager.md +++ b/windows.applicationmodel.email/emailmailbox_syncmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.SyncManager --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.SyncManager ## -description Gets the sync manager for the mailbox. ## -property-value The sync manager for the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.SyncManager +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.SyncManager + +## -description +Gets the sync manager for the mailbox. + +## -property-value +The sync manager for the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_trycreatefolderasync_142768409.md b/windows.applicationmodel.email/emailmailbox_trycreatefolderasync_142768409.md index 015d5aa061..92e98b58fe 100644 --- a/windows.applicationmodel.email/emailmailbox_trycreatefolderasync_142768409.md +++ b/windows.applicationmodel.email/emailmailbox_trycreatefolderasync_142768409.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryCreateFolderAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryCreateFolderAsync ## -description Asynchronously attempts to create a new email folder. ## -parameters ### -param parentFolderId The [Id](emailfolder_id.md) of the parent email folder. ### -param name The name for the new folder. ## -returns An async operation with an [EmailMailboxCreateFolderResult](emailmailboxcreatefolderresult.md) containing the newly created folder and the status of the create operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryCreateFolderAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryCreateFolderAsync + +## -description +Asynchronously attempts to create a new email folder. + +## -parameters +### -param parentFolderId +The [Id](emailfolder_id.md) of the parent email folder. + +### -param name +The name for the new folder. + +## -returns +An async operation with an [EmailMailboxCreateFolderResult](emailmailboxcreatefolderresult.md) containing the newly created folder and the status of the create operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_trydeletefolderasync_1435582098.md b/windows.applicationmodel.email/emailmailbox_trydeletefolderasync_1435582098.md index f78a2a57ec..7210282d28 100644 --- a/windows.applicationmodel.email/emailmailbox_trydeletefolderasync_1435582098.md +++ b/windows.applicationmodel.email/emailmailbox_trydeletefolderasync_1435582098.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryDeleteFolderAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryDeleteFolderAsync ## -description Asynchronously attempts to delete an email folder. ## -parameters ### -param folderId The [Id](emailfolder_id.md) of the folder to delete. ## -returns An async operation with an [EmailMailboxDeleteFolderStatus](emailmailboxdeletefolderstatus.md) value representing the status of the delete operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryDeleteFolderAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryDeleteFolderAsync + +## -description +Asynchronously attempts to delete an email folder. + +## -parameters +### -param folderId +The [Id](emailfolder_id.md) of the folder to delete. + +## -returns +An async operation with an [EmailMailboxDeleteFolderStatus](emailmailboxdeletefolderstatus.md) value representing the status of the delete operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_tryemptyfolderasync_1505533787.md b/windows.applicationmodel.email/emailmailbox_tryemptyfolderasync_1505533787.md index 3a330263cf..24c1f095c5 100644 --- a/windows.applicationmodel.email/emailmailbox_tryemptyfolderasync_1505533787.md +++ b/windows.applicationmodel.email/emailmailbox_tryemptyfolderasync_1505533787.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryEmptyFolderAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryEmptyFolderAsync ## -description Asynchronously attempt to delete the contents of an email folder. ## -parameters ### -param folderId The [Id](emailfolder_id.md) of the folder to empty. ## -returns An async operation with an [EmailMailboxEmptyFolderStatus](emailmailboxemptyfolderstatus.md) value representing the status of the delete operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryEmptyFolderAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryEmptyFolderAsync + +## -description +Asynchronously attempt to delete the contents of an email folder. + +## -parameters +### -param folderId +The [Id](emailfolder_id.md) of the folder to empty. + +## -returns +An async operation with an [EmailMailboxEmptyFolderStatus](emailmailboxemptyfolderstatus.md) value representing the status of the delete operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_tryforwardmeetingasync_1202181496.md b/windows.applicationmodel.email/emailmailbox_tryforwardmeetingasync_1202181496.md index c0785b9609..ff01fb5471 100644 --- a/windows.applicationmodel.email/emailmailbox_tryforwardmeetingasync_1202181496.md +++ b/windows.applicationmodel.email/emailmailbox_tryforwardmeetingasync_1202181496.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryForwardMeetingAsync(Windows.ApplicationModel.Email.EmailMessage,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Email.EmailRecipient},System.String,Windows.ApplicationModel.Email.EmailMessageBodyKind,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryForwardMeetingAsync ## -description Asynchronously attempts to forward a meeting request. ## -parameters ### -param meeting The meeting to forward. ### -param recipients The list of new recipients. ### -param subject The subject of the email. ### -param forwardHeaderType The email message format, HTML or plain text. ### -param forwardHeader The email forward header. ### -param comment The body of the message. ## -returns A Boolean value indicating if the meeting was successfully forwarded. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryForwardMeetingAsync(Windows.ApplicationModel.Email.EmailMessage,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Email.EmailRecipient},System.String,Windows.ApplicationModel.Email.EmailMessageBodyKind,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryForwardMeetingAsync + +## -description +Asynchronously attempts to forward a meeting request. + +## -parameters +### -param meeting +The meeting to forward. + +### -param recipients +The list of new recipients. + +### -param subject +The subject of the email. + +### -param forwardHeaderType +The email message format, HTML or plain text. + +### -param forwardHeader +The email forward header. + +### -param comment +The body of the message. + +## -returns +A Boolean value indicating if the meeting was successfully forwarded. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_trygetautoreplysettingsasync_183929792.md b/windows.applicationmodel.email/emailmailbox_trygetautoreplysettingsasync_183929792.md index 297220e9d1..8116929396 100644 --- a/windows.applicationmodel.email/emailmailbox_trygetautoreplysettingsasync_183929792.md +++ b/windows.applicationmodel.email/emailmailbox_trygetautoreplysettingsasync_183929792.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryGetAutoReplySettingsAsync(Windows.ApplicationModel.Email.EmailMailboxAutoReplyMessageResponseKind) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryGetAutoReplySettingsAsync ## -description Asynchronously attempts to get the auto-reply settings for the mailbox. ## -parameters ### -param requestedFormat The requested text format of the auto-reply message, HTML or plain text. ## -returns The auto-reply settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryGetAutoReplySettingsAsync(Windows.ApplicationModel.Email.EmailMailboxAutoReplyMessageResponseKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryGetAutoReplySettingsAsync + +## -description +Asynchronously attempts to get the auto-reply settings for the mailbox. + +## -parameters +### -param requestedFormat +The requested text format of the auto-reply message, HTML or plain text. + +## -returns +The auto-reply settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_trymovefolderasync_2010564867.md b/windows.applicationmodel.email/emailmailbox_trymovefolderasync_2010564867.md index 5b9b40d4e7..4c7734dfcd 100644 --- a/windows.applicationmodel.email/emailmailbox_trymovefolderasync_2010564867.md +++ b/windows.applicationmodel.email/emailmailbox_trymovefolderasync_2010564867.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync ## -description Asynchronously attempts to move the specified email folder. ## -parameters ### -param folderId The folder to move. ### -param newParentFolderId The new parent for the folder specified in the *folderId* parameter. ## -returns A Boolean value indicating if the move was successful. ## -remarks ## -examples ## -see-also [TryMoveFolderAsync(String, String, String)](emailmailbox_trymovefolderasync_298921347.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync + +## -description +Asynchronously attempts to move the specified email folder. + +## -parameters +### -param folderId +The folder to move. + +### -param newParentFolderId +The new parent for the folder specified in the *folderId* parameter. + +## -returns +A Boolean value indicating if the move was successful. + +## -remarks + +## -examples + +## -see-also +[TryMoveFolderAsync(String, String, String)](emailmailbox_trymovefolderasync_298921347.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_trymovefolderasync_298921347.md b/windows.applicationmodel.email/emailmailbox_trymovefolderasync_298921347.md index 77896d22d6..d6b46537a9 100644 --- a/windows.applicationmodel.email/emailmailbox_trymovefolderasync_298921347.md +++ b/windows.applicationmodel.email/emailmailbox_trymovefolderasync_298921347.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync(System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync ## -description Asynchronously attempts to move the specified email folder and rename it in the process. ## -parameters ### -param folderId The folder to move. ### -param newParentFolderId The new parent for the folder specified in the *folderId* parameter. ### -param newFolderName The name for the folder in the new location. ## -returns A Boolean value indicating if the move was successful. ## -remarks ## -examples ## -see-also [TryMoveFolderAsync(String, String)](emailmailbox_trymovefolderasync_2010564867.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryMoveFolderAsync + +## -description +Asynchronously attempts to move the specified email folder and rename it in the process. + +## -parameters +### -param folderId +The folder to move. + +### -param newParentFolderId +The new parent for the folder specified in the *folderId* parameter. + +### -param newFolderName +The name for the folder in the new location. + +## -returns +A Boolean value indicating if the move was successful. + +## -remarks + +## -examples + +## -see-also +[TryMoveFolderAsync(String, String)](emailmailbox_trymovefolderasync_2010564867.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmailbox_trymovemessageasync_270424893.md b/windows.applicationmodel.email/emailmailbox_trymovemessageasync_270424893.md index b13ce11216..a63dcaaaea 100644 --- a/windows.applicationmodel.email/emailmailbox_trymovemessageasync_270424893.md +++ b/windows.applicationmodel.email/emailmailbox_trymovemessageasync_270424893.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryMoveMessageAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryMoveMessageAsync ## -description Asynchronously attempts to move the specified email message. ## -parameters ### -param messageId The ID of the email message to move. ### -param newParentFolderId The ID of the new folder where the email message should reside. ## -returns A Boolean value indicating if the move was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryMoveMessageAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryMoveMessageAsync + +## -description +Asynchronously attempts to move the specified email message. + +## -parameters +### -param messageId +The ID of the email message to move. + +### -param newParentFolderId +The ID of the new folder where the email message should reside. + +## -returns +A Boolean value indicating if the move was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_tryproposenewtimeformeetingasync_1047528063.md b/windows.applicationmodel.email/emailmailbox_tryproposenewtimeformeetingasync_1047528063.md index e478fbc2e3..8619b4071c 100644 --- a/windows.applicationmodel.email/emailmailbox_tryproposenewtimeformeetingasync_1047528063.md +++ b/windows.applicationmodel.email/emailmailbox_tryproposenewtimeformeetingasync_1047528063.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryProposeNewTimeForMeetingAsync(Windows.ApplicationModel.Email.EmailMessage,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryProposeNewTimeForMeetingAsync ## -description Asynchronously attempts to send a meeting request proposing a new time. ## -parameters ### -param meeting The meeting for which to propose a new time. ### -param newStartTime The proposed new time for the meeting to start. ### -param newDuration The proposed duration of the meeting. ### -param subject The subject of the meeting email. ### -param comment The body of the message. ## -returns A Boolean value indicating if the proposed meeting message was successfully sent. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryProposeNewTimeForMeetingAsync(Windows.ApplicationModel.Email.EmailMessage,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryProposeNewTimeForMeetingAsync + +## -description +Asynchronously attempts to send a meeting request proposing a new time. + +## -parameters +### -param meeting +The meeting for which to propose a new time. + +### -param newStartTime +The proposed new time for the meeting to start. + +### -param newDuration +The proposed duration of the meeting. + +### -param subject +The subject of the meeting email. + +### -param comment +The body of the message. + +## -returns +A Boolean value indicating if the proposed meeting message was successfully sent. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_trysetautoreplysettingsasync_869577214.md b/windows.applicationmodel.email/emailmailbox_trysetautoreplysettingsasync_869577214.md index 32767cbab7..aae5645a40 100644 --- a/windows.applicationmodel.email/emailmailbox_trysetautoreplysettingsasync_869577214.md +++ b/windows.applicationmodel.email/emailmailbox_trysetautoreplysettingsasync_869577214.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TrySetAutoReplySettingsAsync(Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TrySetAutoReplySettingsAsync ## -description Asynchronously attempts to set the auto-reply settings for the mailbox. ## -parameters ### -param autoReplySettings The new auto-reply settings. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TrySetAutoReplySettingsAsync(Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TrySetAutoReplySettingsAsync + +## -description +Asynchronously attempts to set the auto-reply settings for the mailbox. + +## -parameters +### -param autoReplySettings +The new auto-reply settings. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_tryupdatemeetingresponseasync_1801280318.md b/windows.applicationmodel.email/emailmailbox_tryupdatemeetingresponseasync_1801280318.md index 0087fcdfb0..9a9f9a77db 100644 --- a/windows.applicationmodel.email/emailmailbox_tryupdatemeetingresponseasync_1801280318.md +++ b/windows.applicationmodel.email/emailmailbox_tryupdatemeetingresponseasync_1801280318.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryUpdateMeetingResponseAsync(Windows.ApplicationModel.Email.EmailMessage,Windows.ApplicationModel.Email.EmailMeetingResponseType,System.String,System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.TryUpdateMeetingResponseAsync ## -description Asynchronously attempts to respond to a meeting request. ## -parameters ### -param meeting The meeting request. ### -param response The response to the meeting request, accept, decline, or tentative. ### -param subject The subject of the response email message. ### -param comment The body of the response email message. ### -param sendUpdate A Boolean indicating whether or not to send a response to the meeting originator. ## -returns A Boolean value indicating if the response was sent successfully. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.TryUpdateMeetingResponseAsync(Windows.ApplicationModel.Email.EmailMessage,Windows.ApplicationModel.Email.EmailMeetingResponseType,System.String,System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.TryUpdateMeetingResponseAsync + +## -description +Asynchronously attempts to respond to a meeting request. + +## -parameters +### -param meeting +The meeting request. + +### -param response +The response to the meeting request, accept, decline, or tentative. + +### -param subject +The subject of the response email message. + +### -param comment +The body of the response email message. + +### -param sendUpdate +A Boolean indicating whether or not to send a response to the meeting originator. + +## -returns +A Boolean value indicating if the response was sent successfully. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_userdataaccountid.md b/windows.applicationmodel.email/emailmailbox_userdataaccountid.md index e3b0a7fc63..2e2edcf58b 100644 --- a/windows.applicationmodel.email/emailmailbox_userdataaccountid.md +++ b/windows.applicationmodel.email/emailmailbox_userdataaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailbox.UserDataAccountId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailbox.UserDataAccountId ## -description Gets the ID of the user data account for the mailbox. ## -property-value The ID of the user data account for the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailbox.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.UserDataAccountId + +## -description +Gets the ID of the user data account for the mailbox. + +## -property-value +The ID of the user data account for the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailbox_validatecertificatesasync_554772493.md b/windows.applicationmodel.email/emailmailbox_validatecertificatesasync_554772493.md index 87f63a8b39..6984c9418f 100644 --- a/windows.applicationmodel.email/emailmailbox_validatecertificatesasync_554772493.md +++ b/windows.applicationmodel.email/emailmailbox_validatecertificatesasync_554772493.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailbox.ValidateCertificatesAsync(Windows.Foundation.Collections.IIterable{Windows.Security.Cryptography.Certificates.Certificate}) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailbox.ValidateCertificatesAsync ## -description Validates the certificate against the sync provider service. ## -parameters ### -param certificates The certificate to validate. ## -returns The confirmation that the certificate is valid. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.ValidateCertificatesAsync(Windows.Foundation.Collections.IIterable{Windows.Security.Cryptography.Certificates.Certificate}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.ValidateCertificatesAsync + +## -description +Validates the certificate against the sync provider service. + +## -parameters +### -param certificates +The certificate to validate. + +## -returns +The confirmation that the certificate is valid. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxaction.md b/windows.applicationmodel.email/emailmailboxaction.md index 587d887c6c..b985149fbb 100644 --- a/windows.applicationmodel.email/emailmailboxaction.md +++ b/windows.applicationmodel.email/emailmailboxaction.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxAction --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxAction ## -description Provides data about a change that occurred to a mailbox. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxAction +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAction + +## -description +Provides data about a change that occurred to a mailbox. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxaction_changenumber.md b/windows.applicationmodel.email/emailmailboxaction_changenumber.md index fe978b11e4..efea92da29 100644 --- a/windows.applicationmodel.email/emailmailboxaction_changenumber.md +++ b/windows.applicationmodel.email/emailmailboxaction_changenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAction.ChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAction.ChangeNumber ## -description Gets the number that identifies the change that happened to the mailbox. ## -property-value The number that identifies the change that occurred to the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAction.ChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAction.ChangeNumber + +## -description +Gets the number that identifies the change that happened to the mailbox. + +## -property-value +The number that identifies the change that occurred to the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxaction_kind.md b/windows.applicationmodel.email/emailmailboxaction_kind.md index e6774e0cab..c9ac34161c 100644 --- a/windows.applicationmodel.email/emailmailboxaction_kind.md +++ b/windows.applicationmodel.email/emailmailboxaction_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAction.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAction.Kind ## -description Gets the value that represents the kind of change that happened to the mailbox. ## -property-value The kind of change that happened to the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAction.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAction.Kind + +## -description +Gets the value that represents the kind of change that happened to the mailbox. + +## -property-value +The kind of change that happened to the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreply.md b/windows.applicationmodel.email/emailmailboxautoreply.md index d4c2824740..2382814889 100644 --- a/windows.applicationmodel.email/emailmailboxautoreply.md +++ b/windows.applicationmodel.email/emailmailboxautoreply.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxAutoReply --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReply ## -description Represents an auto-reply message set on a mailbox. ## -remarks Call **InternalReply** or **KnownExternalReply** or **UnknownExternalReply** to get an instance of this class. The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxAutoReply +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReply + +## -description +Represents an auto-reply message set on a mailbox. + +## -remarks +Call **InternalReply** or **KnownExternalReply** or **UnknownExternalReply** to get an instance of this class. + +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreply_isenabled.md b/windows.applicationmodel.email/emailmailboxautoreply_isenabled.md index daa9f662d9..51ad524c32 100644 --- a/windows.applicationmodel.email/emailmailboxautoreply_isenabled.md +++ b/windows.applicationmodel.email/emailmailboxautoreply_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReply.IsEnabled --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReply.IsEnabled ## -description Gets or sets a Boolean value that indicates if the auto-reply message is enabled. ## -property-value A Boolean value that indicates if the auto-reply message is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReply.IsEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReply.IsEnabled + +## -description +Gets or sets a Boolean value that indicates if the auto-reply message is enabled. + +## -property-value +A Boolean value that indicates if the auto-reply message is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreply_response.md b/windows.applicationmodel.email/emailmailboxautoreply_response.md index 78294ac003..9c942a5ea2 100644 --- a/windows.applicationmodel.email/emailmailboxautoreply_response.md +++ b/windows.applicationmodel.email/emailmailboxautoreply_response.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReply.Response --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReply.Response ## -description Gets or sets the auto-reply response text. ## -property-value The auto-reply response text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReply.Response +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReply.Response + +## -description +Gets or sets the auto-reply response text. + +## -property-value +The auto-reply response text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings.md b/windows.applicationmodel.email/emailmailboxautoreplysettings.md index 9c764a2fae..a6d2d89668 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings ## -description Represents the settings for the automatic reply functionality of an email account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings + +## -description +Represents the settings for the automatic reply functionality of an email account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_emailmailboxautoreplysettings_1221375020.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_emailmailboxautoreplysettings_1221375020.md index ea12be931d..69f0990c86 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_emailmailboxautoreplysettings_1221375020.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_emailmailboxautoreplysettings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.EmailMailboxAutoReplySettings ## -description Initializes a new instance of an object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.EmailMailboxAutoReplySettings + +## -description +Initializes a new instance of an object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_endtime.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_endtime.md index acab74c27c..b7a3247439 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_endtime.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_endtime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.EndTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.EndTime ## -description Represents the end time for the automated reply period. ## -property-value The end time for the automated reply period. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.EndTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.EndTime + +## -description +Represents the end time for the automated reply period. + +## -property-value +The end time for the automated reply period. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_internalreply.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_internalreply.md index 1cedd3945b..452f3848ff 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_internalreply.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_internalreply.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.InternalReply --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.InternalReply ## -description Gets the automatic reply message intended for an email message from an internal sender. ## -property-value The automatic reply message intended for an email message from an internal sender. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.InternalReply +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.InternalReply + +## -description +Gets the automatic reply message intended for an email message from an internal sender. + +## -property-value +The automatic reply message intended for an email message from an internal sender. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_isenabled.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_isenabled.md index 0a5dbce6ac..b6512902a8 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_isenabled.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.IsEnabled --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.IsEnabled ## -description Gets a Boolean value indicating whether automatic replies are enabled. ## -property-value A Boolean value indicating whether automatic replies are enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.IsEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.IsEnabled + +## -description +Gets a Boolean value indicating whether automatic replies are enabled. + +## -property-value +A Boolean value indicating whether automatic replies are enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_knownexternalreply.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_knownexternalreply.md index ff80f5902e..1a6f70480c 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_knownexternalreply.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_knownexternalreply.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.KnownExternalReply --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.KnownExternalReply ## -description Gets the automatic reply message intended for an email message from a known external sender. ## -property-value The automatic reply message intended for an email message from a known external sender. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.KnownExternalReply +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.KnownExternalReply + +## -description +Gets the automatic reply message intended for an email message from a known external sender. + +## -property-value +The automatic reply message intended for an email message from a known external sender. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_responsekind.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_responsekind.md index 5360a18eb5..90f1f9c950 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_responsekind.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_responsekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.ResponseKind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.ResponseKind ## -description Gets or sets whether the automated response email message is encoded as HTML or plain text. ## -property-value The encoding schema for an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.ResponseKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.ResponseKind + +## -description +Gets or sets whether the automated response email message is encoded as HTML or plain text. + +## -property-value +The encoding schema for an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_starttime.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_starttime.md index 97cc6a78c9..22fd3208ce 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_starttime.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_starttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.StartTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.StartTime ## -description Represents the start time for the automated reply period. ## -property-value The start time for the automated reply period. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.StartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.StartTime + +## -description +Represents the start time for the automated reply period. + +## -property-value +The start time for the automated reply period. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxautoreplysettings_unknownexternalreply.md b/windows.applicationmodel.email/emailmailboxautoreplysettings_unknownexternalreply.md index 6b7dd6ba66..19cdc1875a 100644 --- a/windows.applicationmodel.email/emailmailboxautoreplysettings_unknownexternalreply.md +++ b/windows.applicationmodel.email/emailmailboxautoreplysettings_unknownexternalreply.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.UnknownExternalReply --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.UnknownExternalReply ## -description Gets the automatic reply message intended for an email message from an unknown external sender. ## -property-value The automatic reply message intended for an email message from an unknown external sender. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.UnknownExternalReply +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxAutoReplySettings.UnknownExternalReply + +## -description +Gets the automatic reply message intended for an email message from an unknown external sender. + +## -property-value +The automatic reply message intended for an email message from an unknown external sender. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities.md b/windows.applicationmodel.email/emailmailboxcapabilities.md index 83a70bb566..79c4cf465a 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxCapabilities --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities ## -description Represents the capabilities associated with an email mailbox. ## -remarks The **Capabilities** property provides access to this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxCapabilities +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities + +## -description +Represents the capabilities associated with an email mailbox. + +## -remarks +The **Capabilities** property provides access to this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_cancreatefolder.md b/windows.applicationmodel.email/emailmailboxcapabilities_cancreatefolder.md index ec01d6e119..bfabe4d635 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_cancreatefolder.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_cancreatefolder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanCreateFolder --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanCreateFolder ## -description Gets or sets a Boolean value indicating if folders can be created in the mailbox. ## -property-value A Boolean value indicating if folders can be created in the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanCreateFolder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanCreateFolder + +## -description +Gets or sets a Boolean value indicating if folders can be created in the mailbox. + +## -property-value +A Boolean value indicating if folders can be created in the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_candeletefolder.md b/windows.applicationmodel.email/emailmailboxcapabilities_candeletefolder.md index 416aa5d2d8..25ca7c487e 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_candeletefolder.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_candeletefolder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanDeleteFolder --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanDeleteFolder ## -description Gets or sets a Boolean value indicating if folders can be deleted from the mailbox. ## -property-value A Boolean value indicating if folders can be deleted from the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanDeleteFolder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanDeleteFolder + +## -description +Gets or sets a Boolean value indicating if folders can be deleted from the mailbox. + +## -property-value +A Boolean value indicating if folders can be deleted from the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canemptyfolder.md b/windows.applicationmodel.email/emailmailboxcapabilities_canemptyfolder.md index 70a0d56b57..8093b8adaa 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canemptyfolder.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canemptyfolder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanEmptyFolder --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanEmptyFolder ## -description Gets or sets a Boolean value indicating if folders in the mailbox can be emptied. ## -property-value A Boolean value indicating if folders in the mailbox can be emptied. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanEmptyFolder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanEmptyFolder + +## -description +Gets or sets a Boolean value indicating if folders in the mailbox can be emptied. + +## -property-value +A Boolean value indicating if folders in the mailbox can be emptied. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canforwardmeetings.md b/windows.applicationmodel.email/emailmailboxcapabilities_canforwardmeetings.md index 4ddc7f3fa1..c317e4c7a4 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canforwardmeetings.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canforwardmeetings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanForwardMeetings --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanForwardMeetings ## -description Gets or sets a Boolean value indicating whether an account is allowed to forward meeting requests. ## -property-value A Boolean value indicating whether an account is allowed to forward meeting requests. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanForwardMeetings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanForwardMeetings + +## -description +Gets or sets a Boolean value indicating whether an account is allowed to forward meeting requests. + +## -property-value +A Boolean value indicating whether an account is allowed to forward meeting requests. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetexternalautoreplies.md b/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetexternalautoreplies.md index 2742cd4a6a..0213444f50 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetexternalautoreplies.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetexternalautoreplies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetExternalAutoReplies --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetExternalAutoReplies ## -description Gets or sets a Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for external audiences. ## -property-value A Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for external audiences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetExternalAutoReplies +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetExternalAutoReplies + +## -description +Gets or sets a Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for external audiences. + +## -property-value +A Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for external audiences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetinternalautoreplies.md b/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetinternalautoreplies.md index 8a04312e89..27c1cfbd48 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetinternalautoreplies.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_cangetandsetinternalautoreplies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetInternalAutoReplies --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetInternalAutoReplies ## -description Gets or sets a Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for internal audiences. ## -property-value A Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for internal audiences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetInternalAutoReplies +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanGetAndSetInternalAutoReplies + +## -description +Gets or sets a Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for internal audiences. + +## -property-value +A Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for internal audiences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canmovefolder.md b/windows.applicationmodel.email/emailmailboxcapabilities_canmovefolder.md index 51ca496c41..864aded6de 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canmovefolder.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canmovefolder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanMoveFolder --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanMoveFolder ## -description Gets or sets a Boolean value indicating if folders in the mailbox can be moved. ## -property-value A Boolean value indicating if folders in the mailbox can be moved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanMoveFolder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanMoveFolder + +## -description +Gets or sets a Boolean value indicating if folders in the mailbox can be moved. + +## -property-value +A Boolean value indicating if folders in the mailbox can be moved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canproposenewtimeformeetings.md b/windows.applicationmodel.email/emailmailboxcapabilities_canproposenewtimeformeetings.md index 8f75bf640b..0ed8949185 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canproposenewtimeformeetings.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canproposenewtimeformeetings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanProposeNewTimeForMeetings --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanProposeNewTimeForMeetings ## -description Gets or sets a Boolean value indicating whether an account is allowed to propose a new meeting time. ## -property-value A Boolean value indicating whether an account is allowed to propose a new meeting time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanProposeNewTimeForMeetings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanProposeNewTimeForMeetings + +## -description +Gets or sets a Boolean value indicating whether an account is allowed to propose a new meeting time. + +## -property-value +A Boolean value indicating whether an account is allowed to propose a new meeting time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canresolverecipients.md b/windows.applicationmodel.email/emailmailboxcapabilities_canresolverecipients.md index 3bdad3e485..8874109b71 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canresolverecipients.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canresolverecipients.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanResolveRecipients --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanResolveRecipients ## -description Gets or sets a Boolean value that indicates whether the email mailbox is capable of resolving recipients. ## -property-value The Boolean value that indicates whether the email mailbox is capable of resolving recipients. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanResolveRecipients +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanResolveRecipients + +## -description +Gets or sets a Boolean value that indicates whether the email mailbox is capable of resolving recipients. + +## -property-value +The Boolean value that indicates whether the email mailbox is capable of resolving recipients. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchfolders.md b/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchfolders.md index 13194c7ba1..9d5efb4cbc 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchfolders.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchfolders.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchFolders --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchFolders ## -description Gets or sets a Boolean value indicating whether a search of specific folders on the server can be initiated from this email mailbox. ## -property-value The Boolean value indicating whether a search of specific folders on the server can be initiated from this email mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchFolders +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchFolders + +## -description +Gets or sets a Boolean value indicating whether a search of specific folders on the server can be initiated from this email mailbox. + +## -property-value +The Boolean value indicating whether a search of specific folders on the server can be initiated from this email mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchmailbox.md b/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchmailbox.md index 27cdbd882c..1699e65d8c 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchmailbox.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canserversearchmailbox.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchMailbox --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchMailbox ## -description Gets or sets a Boolean value indicating whether a search of the server can be initiated from this email mailbox. ## -property-value The Boolean value indicating whether a search of the server can be initiated from this email mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchMailbox +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanServerSearchMailbox + +## -description +Gets or sets a Boolean value indicating whether a search of the server can be initiated from this email mailbox. + +## -property-value +The Boolean value indicating whether a search of the server can be initiated from this email mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_cansmartsend.md b/windows.applicationmodel.email/emailmailboxcapabilities_cansmartsend.md index c0f1f410fd..6a0fb549f8 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_cansmartsend.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_cansmartsend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanSmartSend --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanSmartSend ## -description Gets or sets a Boolean value indicating whether the email mailbox is allowed to attempt smart send. ## -property-value The Boolean value indicating whether the email mailbox is allowed to attempt smart send. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanSmartSend +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanSmartSend + +## -description +Gets or sets a Boolean value indicating whether the email mailbox is allowed to attempt smart send. + +## -property-value +The Boolean value indicating whether the email mailbox is allowed to attempt smart send. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canupdatemeetingresponses.md b/windows.applicationmodel.email/emailmailboxcapabilities_canupdatemeetingresponses.md index 3f7ac5c9b9..aa76e7c1a7 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canupdatemeetingresponses.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canupdatemeetingresponses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanUpdateMeetingResponses --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanUpdateMeetingResponses ## -description Gets or sets a Boolean value indicating whether the email mailbox is allowed to update meeting responses. ## -property-value The Boolean value indicating whether the email mailbox is allowed to update meeting responses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanUpdateMeetingResponses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanUpdateMeetingResponses + +## -description +Gets or sets a Boolean value indicating whether the email mailbox is allowed to update meeting responses. + +## -property-value +The Boolean value indicating whether the email mailbox is allowed to update meeting responses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcapabilities_canvalidatecertificates.md b/windows.applicationmodel.email/emailmailboxcapabilities_canvalidatecertificates.md index 194ba829b6..36c4cf1af0 100644 --- a/windows.applicationmodel.email/emailmailboxcapabilities_canvalidatecertificates.md +++ b/windows.applicationmodel.email/emailmailboxcapabilities_canvalidatecertificates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanValidateCertificates --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanValidateCertificates ## -description Gets or sets a Boolean value that indicates whether the email mailbox is capable of validating certificates. ## -property-value The Boolean value that indicates whether the email mailbox is capable of validating certificates. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanValidateCertificates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCapabilities.CanValidateCertificates + +## -description +Gets or sets a Boolean value that indicates whether the email mailbox is capable of validating certificates. + +## -property-value +The Boolean value that indicates whether the email mailbox is capable of validating certificates. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchange.md b/windows.applicationmodel.email/emailmailboxchange.md index f32f202279..696deef17d 100644 --- a/windows.applicationmodel.email/emailmailboxchange.md +++ b/windows.applicationmodel.email/emailmailboxchange.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxChange --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxChange ## -description The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxChange +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChange + +## -description +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchange_changetype.md b/windows.applicationmodel.email/emailmailboxchange_changetype.md index ff61551477..bcfe377374 100644 --- a/windows.applicationmodel.email/emailmailboxchange_changetype.md +++ b/windows.applicationmodel.email/emailmailboxchange_changetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.ChangeType --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxChange.ChangeType ## -description Gets the type of change that was made to the mailbox. This includes whether it was a folder or message that was changed and whether the item was created, deleted, or modified, or if change tracking was lost for this change. ## -property-value The type of change that was made to the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.ChangeType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChange.ChangeType + +## -description +Gets the type of change that was made to the mailbox. This includes whether it was a folder or message that was changed and whether the item was created, deleted, or modified, or if change tracking was lost for this change. + +## -property-value +The type of change that was made to the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchange_folder.md b/windows.applicationmodel.email/emailmailboxchange_folder.md index 2c0615f192..c02524fb77 100644 --- a/windows.applicationmodel.email/emailmailboxchange_folder.md +++ b/windows.applicationmodel.email/emailmailboxchange_folder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.Folder --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxChange.Folder ## -description Gets the folder to which the change applies. ## -property-value The folder to which the change applies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.Folder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChange.Folder + +## -description +Gets the folder to which the change applies. + +## -property-value +The folder to which the change applies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchange_mailboxactions.md b/windows.applicationmodel.email/emailmailboxchange_mailboxactions.md index d78ffe9a30..efce9da793 100644 --- a/windows.applicationmodel.email/emailmailboxchange_mailboxactions.md +++ b/windows.applicationmodel.email/emailmailboxchange_mailboxactions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.MailboxActions --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxChange.MailboxActions ## -description Gets the flags that indicate what actions have been affected on the mailbox. ## -property-value The flags that indicate what actions have been affected on the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.MailboxActions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChange.MailboxActions + +## -description +Gets the flags that indicate what actions have been affected on the mailbox. + +## -property-value +The flags that indicate what actions have been affected on the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchange_message.md b/windows.applicationmodel.email/emailmailboxchange_message.md index 0ece5caeee..4f4b432d54 100644 --- a/windows.applicationmodel.email/emailmailboxchange_message.md +++ b/windows.applicationmodel.email/emailmailboxchange_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.Message --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxChange.Message ## -description Gets the message to which the change applies. ## -property-value The message to which the change applies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxChange.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChange.Message + +## -description +Gets the message to which the change applies. + +## -property-value +The message to which the change applies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangeddeferral.md b/windows.applicationmodel.email/emailmailboxchangeddeferral.md index f4a6606c02..91d9f3df2b 100644 --- a/windows.applicationmodel.email/emailmailboxchangeddeferral.md +++ b/windows.applicationmodel.email/emailmailboxchangeddeferral.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangedDeferral --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxChangedDeferral ## -description Represents a deferred process that will halt a thread until the deferral is complete. ## -remarks Call the **GetDeferral** method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangedDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangedDeferral + +## -description +Represents a deferred process that will halt a thread until the deferral is complete. + +## -remarks +Call the **GetDeferral** method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangeddeferral_complete_1807836922.md b/windows.applicationmodel.email/emailmailboxchangeddeferral_complete_1807836922.md index 2b52288bb1..fd5ca96458 100644 --- a/windows.applicationmodel.email/emailmailboxchangeddeferral_complete_1807836922.md +++ b/windows.applicationmodel.email/emailmailboxchangeddeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangedDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangedDeferral.Complete ## -description Indicates to waiting processes that the deferral is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangedDeferral.Complete + +## -description +Indicates to waiting processes that the deferral is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangedeventargs.md b/windows.applicationmodel.email/emailmailboxchangedeventargs.md index 44437318ed..a198f3bbc7 100644 --- a/windows.applicationmodel.email/emailmailboxchangedeventargs.md +++ b/windows.applicationmodel.email/emailmailboxchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs ## -description Represents the deferral process. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs + +## -description +Represents the deferral process. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangedeventargs_getdeferral_254836512.md b/windows.applicationmodel.email/emailmailboxchangedeventargs_getdeferral_254836512.md index e5dbe3954c..e013487c98 100644 --- a/windows.applicationmodel.email/emailmailboxchangedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.email/emailmailboxchangedeventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs.GetDeferral ## -description Gets the deferral object. ## -returns The deferral object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangedEventArgs.GetDeferral + +## -description +Gets the deferral object. + +## -returns +The deferral object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangereader.md b/windows.applicationmodel.email/emailmailboxchangereader.md index 5d60b2055d..f65a5695f8 100644 --- a/windows.applicationmodel.email/emailmailboxchangereader.md +++ b/windows.applicationmodel.email/emailmailboxchangereader.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangeReader --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxChangeReader ## -description The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -remarks Call **GetChangeReader** to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangeReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeReader + +## -description +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -remarks +Call **GetChangeReader** to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangereader_acceptchanges_143129490.md b/windows.applicationmodel.email/emailmailboxchangereader_acceptchanges_143129490.md index 2b93b21f54..e1b7dfb3fa 100644 --- a/windows.applicationmodel.email/emailmailboxchangereader_acceptchanges_143129490.md +++ b/windows.applicationmodel.email/emailmailboxchangereader_acceptchanges_143129490.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChanges --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChanges ## -description Accepts all changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChanges +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChanges + +## -description +Accepts all changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangereader_acceptchangesthrough_1691308781.md b/windows.applicationmodel.email/emailmailboxchangereader_acceptchangesthrough_1691308781.md index b12e770045..0d93a7e6e6 100644 --- a/windows.applicationmodel.email/emailmailboxchangereader_acceptchangesthrough_1691308781.md +++ b/windows.applicationmodel.email/emailmailboxchangereader_acceptchangesthrough_1691308781.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Email.EmailMailboxChange) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChangesThrough ## -description Accepts all changes through the current change. ## -parameters ### -param lastChangeToAcknowledge The current change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChangesThrough(Windows.ApplicationModel.Email.EmailMailboxChange) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeReader.AcceptChangesThrough + +## -description +Accepts all changes through the current change. + +## -parameters +### -param lastChangeToAcknowledge +The current change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangereader_readbatchasync_888788553.md b/windows.applicationmodel.email/emailmailboxchangereader_readbatchasync_888788553.md index cdc49c0b4d..e5682adda2 100644 --- a/windows.applicationmodel.email/emailmailboxchangereader_readbatchasync_888788553.md +++ b/windows.applicationmodel.email/emailmailboxchangereader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangeReader.ReadBatchAsync ## -description Reads a collection of changes. ## -returns A batch of changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeReader.ReadBatchAsync + +## -description +Reads a collection of changes. + +## -returns +A batch of changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangetracker.md b/windows.applicationmodel.email/emailmailboxchangetracker.md index b67996ce54..477a3d7b33 100644 --- a/windows.applicationmodel.email/emailmailboxchangetracker.md +++ b/windows.applicationmodel.email/emailmailboxchangetracker.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangeTracker --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxChangeTracker ## -description The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -remarks Call **ChangeTracker** to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxChangeTracker +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeTracker + +## -description +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -remarks +Call **ChangeTracker** to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangetracker_enable_366433390.md b/windows.applicationmodel.email/emailmailboxchangetracker_enable_366433390.md index a7f2e5bfc0..f14c514c55 100644 --- a/windows.applicationmodel.email/emailmailboxchangetracker_enable_366433390.md +++ b/windows.applicationmodel.email/emailmailboxchangetracker_enable_366433390.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Enable --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Enable ## -description Enables change tracking on a mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Enable +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Enable + +## -description +Enables change tracking on a mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangetracker_getchangereader_1364424875.md b/windows.applicationmodel.email/emailmailboxchangetracker_getchangereader_1364424875.md index 90e1638651..ea24a0f3f0 100644 --- a/windows.applicationmodel.email/emailmailboxchangetracker_getchangereader_1364424875.md +++ b/windows.applicationmodel.email/emailmailboxchangetracker_getchangereader_1364424875.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.GetChangeReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangeTracker.GetChangeReader ## -description Gets a reader that will read a batch of changes. ## -returns A reader that will read a batch of changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.GetChangeReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeTracker.GetChangeReader + +## -description +Gets a reader that will read a batch of changes. + +## -returns +A reader that will read a batch of changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangetracker_istracking.md b/windows.applicationmodel.email/emailmailboxchangetracker_istracking.md index 62c9511e54..dea94706c2 100644 --- a/windows.applicationmodel.email/emailmailboxchangetracker_istracking.md +++ b/windows.applicationmodel.email/emailmailboxchangetracker_istracking.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.IsTracking --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxChangeTracker.IsTracking ## -description Gets a Boolean value indicating whether change tracking is active. ## -property-value The Boolean value indicating whether change tracking is active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.IsTracking +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeTracker.IsTracking + +## -description +Gets a Boolean value indicating whether change tracking is active. + +## -property-value +The Boolean value indicating whether change tracking is active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxchangetracker_reset_1636126115.md b/windows.applicationmodel.email/emailmailboxchangetracker_reset_1636126115.md index dcc2c831e7..e6b0d9fedb 100644 --- a/windows.applicationmodel.email/emailmailboxchangetracker_reset_1636126115.md +++ b/windows.applicationmodel.email/emailmailboxchangetracker_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Reset --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Reset ## -description Moves the change tracking cursor to now. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Reset +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxChangeTracker.Reset + +## -description +Moves the change tracking cursor to now. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcreatefolderresult.md b/windows.applicationmodel.email/emailmailboxcreatefolderresult.md index d95d71ccea..d42c334149 100644 --- a/windows.applicationmodel.email/emailmailboxcreatefolderresult.md +++ b/windows.applicationmodel.email/emailmailboxcreatefolderresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult ## -description Represents the result of a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. ## -remarks An instance of this class is returned to the [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult + +## -description +Represents the result of a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. + +## -remarks +An instance of this class is returned to the [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcreatefolderresult_folder.md b/windows.applicationmodel.email/emailmailboxcreatefolderresult_folder.md index cd25465b55..2ca8c4a087 100644 --- a/windows.applicationmodel.email/emailmailboxcreatefolderresult_folder.md +++ b/windows.applicationmodel.email/emailmailboxcreatefolderresult_folder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Folder --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Folder ## -description Get the newly created folder after a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. ## -property-value The newly created folder after a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Folder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Folder + +## -description +Get the newly created folder after a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. + +## -property-value +The newly created folder after a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxcreatefolderresult_status.md b/windows.applicationmodel.email/emailmailboxcreatefolderresult_status.md index 82b1fb11df..bf09ba22c8 100644 --- a/windows.applicationmodel.email/emailmailboxcreatefolderresult_status.md +++ b/windows.applicationmodel.email/emailmailboxcreatefolderresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Status --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Status ## -description Gets the status of a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. ## -property-value The status of a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxCreateFolderResult.Status + +## -description +Gets the status of a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. + +## -property-value +The status of a [TryCreateFolderAsync](emailmailbox_trycreatefolderasync.md) operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies.md b/windows.applicationmodel.email/emailmailboxpolicies.md index 5a45dec1f6..cd5f919367 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies.md +++ b/windows.applicationmodel.email/emailmailboxpolicies.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxPolicies --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies ## -description Represents the encryption and signing policies associates with an email mailbox. ## -remarks The **Policies ** property provides access to an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxPolicies +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies + +## -description +Represents the encryption and signing policies associates with an email mailbox. + +## -remarks +The **Policies ** property provides access to an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies_allowedsmimeencryptionalgorithmnegotiation.md b/windows.applicationmodel.email/emailmailboxpolicies_allowedsmimeencryptionalgorithmnegotiation.md index 5b7e66b6f2..da1f372efd 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies_allowedsmimeencryptionalgorithmnegotiation.md +++ b/windows.applicationmodel.email/emailmailboxpolicies_allowedsmimeencryptionalgorithmnegotiation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowedSmimeEncryptionAlgorithmNegotiation --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowedSmimeEncryptionAlgorithmNegotiation ## -description Gets or sets the allowable SMIME encryption algorithms for the purpose of negotiating with an app. ## -property-value The allowable SMIME encryption algorithms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowedSmimeEncryptionAlgorithmNegotiation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowedSmimeEncryptionAlgorithmNegotiation + +## -description +Gets or sets the allowable SMIME encryption algorithms for the purpose of negotiating with an app. + +## -property-value +The allowable SMIME encryption algorithms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies_allowsmimesoftcertificates.md b/windows.applicationmodel.email/emailmailboxpolicies_allowsmimesoftcertificates.md index c4a119eff3..df9f5e78f5 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies_allowsmimesoftcertificates.md +++ b/windows.applicationmodel.email/emailmailboxpolicies_allowsmimesoftcertificates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowSmimeSoftCertificates --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowSmimeSoftCertificates ## -description Gets or sets a Boolean value that indicates whether software certificates are allowed. ## -property-value A Boolean value that indicates whether software certificates are allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowSmimeSoftCertificates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies.AllowSmimeSoftCertificates + +## -description +Gets or sets a Boolean value that indicates whether software certificates are allowed. + +## -property-value +A Boolean value that indicates whether software certificates are allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies_mustencryptsmimemessages.md b/windows.applicationmodel.email/emailmailboxpolicies_mustencryptsmimemessages.md index 55fd475ede..0800eefc6f 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies_mustencryptsmimemessages.md +++ b/windows.applicationmodel.email/emailmailboxpolicies_mustencryptsmimemessages.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.MustEncryptSmimeMessages --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies.MustEncryptSmimeMessages ## -description Gets or sets a Boolean value that indicates whether the sync provider that represents the email mailbox only accepts encrypted messages. ## -property-value The Boolean value that indicates whether the sync provider that represents the email mailbox only accepts encrypted messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.MustEncryptSmimeMessages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies.MustEncryptSmimeMessages + +## -description +Gets or sets a Boolean value that indicates whether the sync provider that represents the email mailbox only accepts encrypted messages. + +## -property-value +The Boolean value that indicates whether the sync provider that represents the email mailbox only accepts encrypted messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies_mustsignsmimemessages.md b/windows.applicationmodel.email/emailmailboxpolicies_mustsignsmimemessages.md index 1c83a6112c..50c99abb95 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies_mustsignsmimemessages.md +++ b/windows.applicationmodel.email/emailmailboxpolicies_mustsignsmimemessages.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.MustSignSmimeMessages --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies.MustSignSmimeMessages ## -description Gets or sets a Boolean value that indicates whether the sync provider that represents the email mailbox only accepts signed messages. ## -property-value The Boolean value that indicates whether the sync provider that represents the email mailbox only accepts signed messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.MustSignSmimeMessages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies.MustSignSmimeMessages + +## -description +Gets or sets a Boolean value that indicates whether the sync provider that represents the email mailbox only accepts signed messages. + +## -property-value +The Boolean value that indicates whether the sync provider that represents the email mailbox only accepts signed messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimeencryptionalgorithm.md b/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimeencryptionalgorithm.md index 0ae627ce35..7f8165440b 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimeencryptionalgorithm.md +++ b/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimeencryptionalgorithm.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeEncryptionAlgorithm --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeEncryptionAlgorithm ## -description Gets or sets the required SMIME encryption algorithm. ## -property-value The required SMIME encryption algorithm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeEncryptionAlgorithm +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeEncryptionAlgorithm + +## -description +Gets or sets the required SMIME encryption algorithm. + +## -property-value +The required SMIME encryption algorithm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimesigningalgorithm.md b/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimesigningalgorithm.md index 07e932ade6..87f0ec1f2c 100644 --- a/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimesigningalgorithm.md +++ b/windows.applicationmodel.email/emailmailboxpolicies_requiredsmimesigningalgorithm.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeSigningAlgorithm --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeSigningAlgorithm ## -description Gets or sets the required SMIME signing algorithm. ## -property-value The required SMIME signing algorithm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeSigningAlgorithm +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxPolicies.RequiredSmimeSigningAlgorithm + +## -description +Gets or sets the required SMIME signing algorithm. + +## -property-value +The required SMIME signing algorithm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxsyncmanager.md b/windows.applicationmodel.email/emailmailboxsyncmanager.md index 56de1f47ca..f835ae24ec 100644 --- a/windows.applicationmodel.email/emailmailboxsyncmanager.md +++ b/windows.applicationmodel.email/emailmailboxsyncmanager.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMailboxSyncManager --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMailboxSyncManager ## -description The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -remarks The **SyncManager** property provides access to an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMailboxSyncManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxSyncManager + +## -description +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -remarks +The **SyncManager** property provides access to an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxsyncmanager_lastattemptedsynctime.md b/windows.applicationmodel.email/emailmailboxsyncmanager_lastattemptedsynctime.md index eb98f4bada..fd1ddc8615 100644 --- a/windows.applicationmodel.email/emailmailboxsyncmanager_lastattemptedsynctime.md +++ b/windows.applicationmodel.email/emailmailboxsyncmanager_lastattemptedsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastAttemptedSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastAttemptedSyncTime ## -description Gets or sets the last time the mailbox attempted to sync. ## -property-value The last time the mailbox attempted to sync. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastAttemptedSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastAttemptedSyncTime + +## -description +Gets or sets the last time the mailbox attempted to sync. + +## -property-value +The last time the mailbox attempted to sync. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxsyncmanager_lastsuccessfulsynctime.md b/windows.applicationmodel.email/emailmailboxsyncmanager_lastsuccessfulsynctime.md index 7a422e9be7..88dd9b213c 100644 --- a/windows.applicationmodel.email/emailmailboxsyncmanager_lastsuccessfulsynctime.md +++ b/windows.applicationmodel.email/emailmailboxsyncmanager_lastsuccessfulsynctime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastSuccessfulSyncTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastSuccessfulSyncTime ## -description Gets or sets the last time the mailbox was successfully synced. ## -property-value The last time the mailbox was successfully synced. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastSuccessfulSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxSyncManager.LastSuccessfulSyncTime + +## -description +Gets or sets the last time the mailbox was successfully synced. + +## -property-value +The last time the mailbox was successfully synced. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxsyncmanager_status.md b/windows.applicationmodel.email/emailmailboxsyncmanager_status.md index 0a7aed11b1..b8c1e82c7b 100644 --- a/windows.applicationmodel.email/emailmailboxsyncmanager_status.md +++ b/windows.applicationmodel.email/emailmailboxsyncmanager_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMailboxSyncManager.Status --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMailboxSyncManager.Status ## -description Gets or sets the sync state of the mailbox. ## -property-value The sync state of the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMailboxSyncManager.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxSyncManager.Status + +## -description +Gets or sets the sync state of the mailbox. + +## -property-value +The sync state of the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxsyncmanager_syncasync_2144191352.md b/windows.applicationmodel.email/emailmailboxsyncmanager_syncasync_2144191352.md index 21bd408b78..ef66f1d749 100644 --- a/windows.applicationmodel.email/emailmailboxsyncmanager_syncasync_2144191352.md +++ b/windows.applicationmodel.email/emailmailboxsyncmanager_syncasync_2144191352.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncAsync ## -description Initiates a sync of this mailbox. ## -returns A Boolean value indicating success. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncAsync + +## -description +Initiates a sync of this mailbox. + +## -returns +A Boolean value indicating success. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmailboxsyncmanager_syncstatuschanged.md b/windows.applicationmodel.email/emailmailboxsyncmanager_syncstatuschanged.md index eaa7967882..16d8847fcf 100644 --- a/windows.applicationmodel.email/emailmailboxsyncmanager_syncstatuschanged.md +++ b/windows.applicationmodel.email/emailmailboxsyncmanager_syncstatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncStatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncStatusChanged ## -description Fires whenever a mailbox's sync status changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Email.EmailMailboxSyncManager.SyncStatusChanged + +## -description +Fires whenever a mailbox's sync status changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanager.md b/windows.applicationmodel.email/emailmanager.md index 7060be5270..8a8a4c6cac 100644 --- a/windows.applicationmodel.email/emailmanager.md +++ b/windows.applicationmodel.email/emailmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailManager --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailManager ## -description Allows an application to launch the email application with a new message displayed. Use this to allow users to send email from your application. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailManager + +## -description +Allows an application to launch the email application with a new message displayed. Use this to allow users to send email from your application. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanager_getforuser_2058550280.md b/windows.applicationmodel.email/emailmanager_getforuser_2058550280.md index 0e40b9c7c9..5e1225e6d8 100644 --- a/windows.applicationmodel.email/emailmanager_getforuser_2058550280.md +++ b/windows.applicationmodel.email/emailmanager_getforuser_2058550280.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailManager.GetForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailManager.GetForUser ## -description Gets the [EmailManagerForUser](emailmanagerforuser.md) object for the specified user. ## -parameters ### -param user The user account to use to get the [EmailManagerForUser](emailmanagerforuser.md) object. ## -returns Returns the email manager for the account specified by the *user* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailManager.GetForUser + +## -description +Gets the [EmailManagerForUser](emailmanagerforuser.md) object for the specified user. + +## -parameters +### -param user +The user account to use to get the [EmailManagerForUser](emailmanagerforuser.md) object. + +## -returns +Returns the email manager for the account specified by the *user* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanager_requeststoreasync_1434709006.md b/windows.applicationmodel.email/emailmanager_requeststoreasync_1434709006.md index a35a84da56..30f5d95b96 100644 --- a/windows.applicationmodel.email/emailmanager_requeststoreasync_1434709006.md +++ b/windows.applicationmodel.email/emailmanager_requeststoreasync_1434709006.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailManager.RequestStoreAsync(Windows.ApplicationModel.Email.EmailStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailManager.RequestStoreAsync ## -description Gets an email store that is within the specified scope. ## -parameters ### -param accessType The enumerator of scope. ## -returns The requested email store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailManager.RequestStoreAsync(Windows.ApplicationModel.Email.EmailStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailManager.RequestStoreAsync + +## -description +Gets an email store that is within the specified scope. + +## -parameters +### -param accessType +The enumerator of scope. + +## -returns +The requested email store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanager_showcomposenewemailasync_1879015237.md b/windows.applicationmodel.email/emailmanager_showcomposenewemailasync_1879015237.md index ec59bf6ed5..8e4229781b 100644 --- a/windows.applicationmodel.email/emailmanager_showcomposenewemailasync_1879015237.md +++ b/windows.applicationmodel.email/emailmanager_showcomposenewemailasync_1879015237.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailManager.ShowComposeNewEmailAsync(Windows.ApplicationModel.Email.EmailMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailManager.ShowComposeNewEmailAsync ## -description Launches the email application with a new message displayed. ## -parameters ### -param message The email message that is displayed when the email application is launched. ## -returns An asynchronous action used to indicate when the operation has completed. ## -remarks Call this method from the main UI thread. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailManager.ShowComposeNewEmailAsync(Windows.ApplicationModel.Email.EmailMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailManager.ShowComposeNewEmailAsync + +## -description +Launches the email application with a new message displayed. + +## -parameters +### -param message +The email message that is displayed when the email application is launched. + +## -returns +An asynchronous action used to indicate when the operation has completed. + +## -remarks +Call this method from the main UI thread. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanagerforuser.md b/windows.applicationmodel.email/emailmanagerforuser.md index 66e1c7d40e..c93a07e787 100644 --- a/windows.applicationmodel.email/emailmanagerforuser.md +++ b/windows.applicationmodel.email/emailmanagerforuser.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailManagerForUser --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailManagerForUser ## -description Represents a service that source apps can call to access email data for a specific user. ## -remarks Call the [EmailManager.GetForUser](emailmanager_getforuser.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailManagerForUser +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailManagerForUser + +## -description +Represents a service that source apps can call to access email data for a specific user. + +## -remarks +Call the [EmailManager.GetForUser](emailmanager_getforuser.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanagerforuser_requeststoreasync_1434709006.md b/windows.applicationmodel.email/emailmanagerforuser_requeststoreasync_1434709006.md index d390322619..de9bce125c 100644 --- a/windows.applicationmodel.email/emailmanagerforuser_requeststoreasync_1434709006.md +++ b/windows.applicationmodel.email/emailmanagerforuser_requeststoreasync_1434709006.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Email.EmailStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailManagerForUser.RequestStoreAsync ## -description Asynchronously returns the [EmailStore](emailstore.md) from the system. ## -parameters ### -param accessType Specifies the access type, such as **AllMailboxesLimitedReadWrite** for all mailboxes or **AppMailboxesReadWrite** for the calling app's mailboxes. ## -returns Returns the [EmailStore](emailstore.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailManagerForUser.RequestStoreAsync(Windows.ApplicationModel.Email.EmailStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailManagerForUser.RequestStoreAsync + +## -description +Asynchronously returns the [EmailStore](emailstore.md) from the system. + +## -parameters +### -param accessType +Specifies the access type, such as **AllMailboxesLimitedReadWrite** for all mailboxes or **AppMailboxesReadWrite** for the calling app's mailboxes. + +## -returns +Returns the [EmailStore](emailstore.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanagerforuser_showcomposenewemailasync_1879015237.md b/windows.applicationmodel.email/emailmanagerforuser_showcomposenewemailasync_1879015237.md index 9aa15a882a..95a9741abf 100644 --- a/windows.applicationmodel.email/emailmanagerforuser_showcomposenewemailasync_1879015237.md +++ b/windows.applicationmodel.email/emailmanagerforuser_showcomposenewemailasync_1879015237.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailManagerForUser.ShowComposeNewEmailAsync(Windows.ApplicationModel.Email.EmailMessage) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailManagerForUser.ShowComposeNewEmailAsync ## -description Launches the email application with a new message displayed. ## -parameters ### -param message The email message that is displayed when the email application is launched. ## -returns An asynchronous action used to indicate when the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailManagerForUser.ShowComposeNewEmailAsync(Windows.ApplicationModel.Email.EmailMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailManagerForUser.ShowComposeNewEmailAsync + +## -description +Launches the email application with a new message displayed. + +## -parameters +### -param message +The email message that is displayed when the email application is launched. + +## -returns +An asynchronous action used to indicate when the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmanagerforuser_user.md b/windows.applicationmodel.email/emailmanagerforuser_user.md index 19ee2a300c..84402d10f1 100644 --- a/windows.applicationmodel.email/emailmanagerforuser_user.md +++ b/windows.applicationmodel.email/emailmanagerforuser_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailManagerForUser.User --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailManagerForUser.User ## -description Gets the [User](../windows.system/user.md) represented by this email manager. ## -property-value The [User](../windows.system/user.md) represented by this email manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailManagerForUser.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailManagerForUser.User + +## -description +Gets the [User](../windows.system/user.md) represented by this email manager. + +## -property-value +The [User](../windows.system/user.md) represented by this email manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo.md b/windows.applicationmodel.email/emailmeetinginfo.md index 99fc4d2ae1..a30b66eb1f 100644 --- a/windows.applicationmodel.email/emailmeetinginfo.md +++ b/windows.applicationmodel.email/emailmeetinginfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMeetingInfo --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMeetingInfo ## -description Represents the information associated with a meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMeetingInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo + +## -description +Represents the information associated with a meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_allownewtimeproposal.md b/windows.applicationmodel.email/emailmeetinginfo_allownewtimeproposal.md index 128b7f4486..3464e85747 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_allownewtimeproposal.md +++ b/windows.applicationmodel.email/emailmeetinginfo_allownewtimeproposal.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.AllowNewTimeProposal --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.AllowNewTimeProposal ## -description Gets or sets a Boolean value indicating whether the proposal of a new time is allowed. ## -property-value A Boolean value indicating whether the proposal of a new time is allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.AllowNewTimeProposal +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.AllowNewTimeProposal + +## -description +Gets or sets a Boolean value indicating whether the proposal of a new time is allowed. + +## -property-value +A Boolean value indicating whether the proposal of a new time is allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_appointmentoriginalstarttime.md b/windows.applicationmodel.email/emailmeetinginfo_appointmentoriginalstarttime.md index 95ba80424c..ddd1e271bf 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_appointmentoriginalstarttime.md +++ b/windows.applicationmodel.email/emailmeetinginfo_appointmentoriginalstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentOriginalStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentOriginalStartTime ## -description Gets or sets the start time for a meeting. ## -property-value The start time for a meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentOriginalStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentOriginalStartTime + +## -description +Gets or sets the start time for a meeting. + +## -property-value +The start time for a meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_appointmentroamingid.md b/windows.applicationmodel.email/emailmeetinginfo_appointmentroamingid.md index 2e38f6d1af..f0376a0266 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_appointmentroamingid.md +++ b/windows.applicationmodel.email/emailmeetinginfo_appointmentroamingid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentRoamingId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentRoamingId ## -description Gets or sets the server identifier for the appointment associated with an email message. ## -property-value The server identifier for the appointment associated with an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentRoamingId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.AppointmentRoamingId + +## -description +Gets or sets the server identifier for the appointment associated with an email message. + +## -property-value +The server identifier for the appointment associated with an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_duration.md b/windows.applicationmodel.email/emailmeetinginfo_duration.md index d56f58d253..8a71e64a2f 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_duration.md +++ b/windows.applicationmodel.email/emailmeetinginfo_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.Duration --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.Duration ## -description Gets or sets the duration of the meeting. ## -property-value The duration of the meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.Duration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.Duration + +## -description +Gets or sets the duration of the meeting. + +## -property-value +The duration of the meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_emailmeetinginfo_1221375020.md b/windows.applicationmodel.email/emailmeetinginfo_emailmeetinginfo_1221375020.md index ebb2d5c29d..4b935d9ebb 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_emailmeetinginfo_1221375020.md +++ b/windows.applicationmodel.email/emailmeetinginfo_emailmeetinginfo_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMeetingInfo.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.EmailMeetingInfo ## -description Initializes a new instance of the class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMeetingInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.EmailMeetingInfo + +## -description +Initializes a new instance of the class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_isallday.md b/windows.applicationmodel.email/emailmeetinginfo_isallday.md index 97f9f1c471..ee192a7376 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_isallday.md +++ b/windows.applicationmodel.email/emailmeetinginfo_isallday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.IsAllDay --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.IsAllDay ## -description Gets or sets a Boolean value indicating whether the meeting is an all day event. ## -property-value A Boolean value indicating whether the meeting is an all day event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.IsAllDay +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.IsAllDay + +## -description +Gets or sets a Boolean value indicating whether the meeting is an all day event. + +## -property-value +A Boolean value indicating whether the meeting is an all day event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_isreportedoutofdatebyserver.md b/windows.applicationmodel.email/emailmeetinginfo_isreportedoutofdatebyserver.md index 174c7a5416..34e763670c 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_isreportedoutofdatebyserver.md +++ b/windows.applicationmodel.email/emailmeetinginfo_isreportedoutofdatebyserver.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.IsReportedOutOfDateByServer --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.IsReportedOutOfDateByServer ## -description Gets a Boolean value indicating if the meeting is reported as out of date by the server. ## -property-value A Boolean value indicating if the meeting is reported as out of date by the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.IsReportedOutOfDateByServer +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.IsReportedOutOfDateByServer + +## -description +Gets a Boolean value indicating if the meeting is reported as out of date by the server. + +## -property-value +A Boolean value indicating if the meeting is reported as out of date by the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_isresponserequested.md b/windows.applicationmodel.email/emailmeetinginfo_isresponserequested.md index c9acb5f55b..624e51783b 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_isresponserequested.md +++ b/windows.applicationmodel.email/emailmeetinginfo_isresponserequested.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.IsResponseRequested --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.IsResponseRequested ## -description Gets or sets a Boolean value indicating whether a response to the meeting request is required. ## -property-value A Boolean value indicating whether a response to the meeting request is required. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.IsResponseRequested +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.IsResponseRequested + +## -description +Gets or sets a Boolean value indicating whether a response to the meeting request is required. + +## -property-value +A Boolean value indicating whether a response to the meeting request is required. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_location.md b/windows.applicationmodel.email/emailmeetinginfo_location.md index 020641e105..e1a0cba234 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_location.md +++ b/windows.applicationmodel.email/emailmeetinginfo_location.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.Location --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.Location ## -description Gets or sets the meeting location. ## -property-value The meeting location. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.Location +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.Location + +## -description +Gets or sets the meeting location. + +## -property-value +The meeting location. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_proposedduration.md b/windows.applicationmodel.email/emailmeetinginfo_proposedduration.md index deeeb805f8..77d7832b41 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_proposedduration.md +++ b/windows.applicationmodel.email/emailmeetinginfo_proposedduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedDuration --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedDuration ## -description Gets or sets the proposed duration for the proposed meeting change. ## -property-value The proposed duration for the proposed meeting change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedDuration +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedDuration + +## -description +Gets or sets the proposed duration for the proposed meeting change. + +## -property-value +The proposed duration for the proposed meeting change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_proposedstarttime.md b/windows.applicationmodel.email/emailmeetinginfo_proposedstarttime.md index 16ef254eb3..57d4cf267d 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_proposedstarttime.md +++ b/windows.applicationmodel.email/emailmeetinginfo_proposedstarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedStartTime ## -description Gets or sets the proposed start time for the proposed meeting change. ## -property-value The proposed start time for the proposed meeting change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.ProposedStartTime + +## -description +Gets or sets the proposed start time for the proposed meeting change. + +## -property-value +The proposed start time for the proposed meeting change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_recurrence.md b/windows.applicationmodel.email/emailmeetinginfo_recurrence.md index e62beb31a7..fe17557cc0 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_recurrence.md +++ b/windows.applicationmodel.email/emailmeetinginfo_recurrence.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.Recurrence --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.Recurrence ## -description Gets or sets the recurrence parameters. ## -property-value The recurrence parameters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.Recurrence +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.Recurrence + +## -description +Gets or sets the recurrence parameters. + +## -property-value +The recurrence parameters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_recurrencestarttime.md b/windows.applicationmodel.email/emailmeetinginfo_recurrencestarttime.md index 08bb1ef847..37f84f644d 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_recurrencestarttime.md +++ b/windows.applicationmodel.email/emailmeetinginfo_recurrencestarttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.RecurrenceStartTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.RecurrenceStartTime ## -description Gets or sets the first instance of the recurrence pattern. ## -property-value The first instance of the recurrence pattern. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.RecurrenceStartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.RecurrenceStartTime + +## -description +Gets or sets the first instance of the recurrence pattern. + +## -property-value +The first instance of the recurrence pattern. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_remotechangenumber.md b/windows.applicationmodel.email/emailmeetinginfo_remotechangenumber.md index 09bc86aa12..0c467703b7 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_remotechangenumber.md +++ b/windows.applicationmodel.email/emailmeetinginfo_remotechangenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.RemoteChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.RemoteChangeNumber ## -description Gets or sets the change number on the server that identifies the meeting email change number. ## -property-value The change number on the server that identifies the meeting email change number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.RemoteChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.RemoteChangeNumber + +## -description +Gets or sets the change number on the server that identifies the meeting email change number. + +## -property-value +The change number on the server that identifies the meeting email change number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmeetinginfo_starttime.md b/windows.applicationmodel.email/emailmeetinginfo_starttime.md index fe37e77379..55309fb731 100644 --- a/windows.applicationmodel.email/emailmeetinginfo_starttime.md +++ b/windows.applicationmodel.email/emailmeetinginfo_starttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.StartTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMeetingInfo.StartTime ## -description Gets or sets the start time for the meeting. ## -property-value The start time for the meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMeetingInfo.StartTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMeetingInfo.StartTime + +## -description +Gets or sets the start time for the meeting. + +## -property-value +The start time for the meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage.md b/windows.applicationmodel.email/emailmessage.md index b1a9de89db..ff1a1baa01 100644 --- a/windows.applicationmodel.email/emailmessage.md +++ b/windows.applicationmodel.email/emailmessage.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMessage --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMessage ## -description Represents an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMessage +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMessage + +## -description +Represents an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_allowinternetimages.md b/windows.applicationmodel.email/emailmessage_allowinternetimages.md index 433823ef0a..6c56066786 100644 --- a/windows.applicationmodel.email/emailmessage_allowinternetimages.md +++ b/windows.applicationmodel.email/emailmessage_allowinternetimages.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.AllowInternetImages --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.AllowInternetImages ## -description Gets or sets a Boolean value indicating whether images may be embedded in the html encoded email message. ## -property-value A Boolean value indicating whether images may be embedded in the html encoded email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.AllowInternetImages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.AllowInternetImages + +## -description +Gets or sets a Boolean value indicating whether images may be embedded in the html encoded email message. + +## -property-value +A Boolean value indicating whether images may be embedded in the html encoded email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_attachments.md b/windows.applicationmodel.email/emailmessage_attachments.md index 31f28f903b..f8f26ac86a 100644 --- a/windows.applicationmodel.email/emailmessage_attachments.md +++ b/windows.applicationmodel.email/emailmessage_attachments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Attachments --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Attachments ## -description Gets the attachments of the email message. ## -property-value The attachments to the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Attachments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Attachments + +## -description +Gets the attachments of the email message. + +## -property-value +The attachments to the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_bcc.md b/windows.applicationmodel.email/emailmessage_bcc.md index c4f80540ac..9f9ee6e5cc 100644 --- a/windows.applicationmodel.email/emailmessage_bcc.md +++ b/windows.applicationmodel.email/emailmessage_bcc.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Bcc --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Bcc ## -description Gets the recipients BCC'd to the email message. ## -property-value The recipients BCC'd to the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Bcc +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Bcc + +## -description +Gets the recipients BCC'd to the email message. + +## -property-value +The recipients BCC'd to the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_body.md b/windows.applicationmodel.email/emailmessage_body.md index dbad32bfe9..cad0603613 100644 --- a/windows.applicationmodel.email/emailmessage_body.md +++ b/windows.applicationmodel.email/emailmessage_body.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Body --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Body ## -description Gets or sets the body of the email message. ## -property-value The body of the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Body +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Body + +## -description +Gets or sets the body of the email message. + +## -property-value +The body of the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_cc.md b/windows.applicationmodel.email/emailmessage_cc.md index 1b94dc5a5e..bd1f0a570e 100644 --- a/windows.applicationmodel.email/emailmessage_cc.md +++ b/windows.applicationmodel.email/emailmessage_cc.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.CC --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.CC ## -description Gets the recipients CC'd to the email message. ## -property-value The recipients CC'd to the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.CC +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.CC + +## -description +Gets the recipients CC'd to the email message. + +## -property-value +The recipients CC'd to the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_changenumber.md b/windows.applicationmodel.email/emailmessage_changenumber.md index 22a67b9225..dd47b429d4 100644 --- a/windows.applicationmodel.email/emailmessage_changenumber.md +++ b/windows.applicationmodel.email/emailmessage_changenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.ChangeNumber --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.ChangeNumber ## -description Gets the current change number which is incremented for each change made to an email message. ## -property-value The current change number . ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.ChangeNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.ChangeNumber + +## -description +Gets the current change number which is incremented for each change made to an email message. + +## -property-value +The current change number . + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_conversationid.md b/windows.applicationmodel.email/emailmessage_conversationid.md index bab2b58d7b..e4595e4630 100644 --- a/windows.applicationmodel.email/emailmessage_conversationid.md +++ b/windows.applicationmodel.email/emailmessage_conversationid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.ConversationId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.ConversationId ## -description Gets the identifier for a conversation. ## -property-value The identifier for a conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.ConversationId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.ConversationId + +## -description +Gets the identifier for a conversation. + +## -property-value +The identifier for a conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_downloadstate.md b/windows.applicationmodel.email/emailmessage_downloadstate.md index 5c2fd35bfa..0c7605e9d2 100644 --- a/windows.applicationmodel.email/emailmessage_downloadstate.md +++ b/windows.applicationmodel.email/emailmessage_downloadstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.DownloadState --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.DownloadState ## -description Gets or sets the download status of an email message. ## -property-value The download status of an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.DownloadState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.DownloadState + +## -description +Gets or sets the download status of an email message. + +## -property-value +The download status of an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_emailmessage_1221375020.md b/windows.applicationmodel.email/emailmessage_emailmessage_1221375020.md index b5738babba..399d093ced 100644 --- a/windows.applicationmodel.email/emailmessage_emailmessage_1221375020.md +++ b/windows.applicationmodel.email/emailmessage_emailmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMessage.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMessage.EmailMessage ## -description Creates an instance of the [EmailMessage](emailmessage.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.EmailMessage + +## -description +Creates an instance of the [EmailMessage](emailmessage.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_estimateddownloadsizeinbytes.md b/windows.applicationmodel.email/emailmessage_estimateddownloadsizeinbytes.md index 35c97e25f3..cb597dc961 100644 --- a/windows.applicationmodel.email/emailmessage_estimateddownloadsizeinbytes.md +++ b/windows.applicationmodel.email/emailmessage_estimateddownloadsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.EstimatedDownloadSizeInBytes --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.EstimatedDownloadSizeInBytes ## -description Gets or sets the estimated size, in bytes, of an email message download. ## -property-value The estimated size, in bytes, of an email message download. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.EstimatedDownloadSizeInBytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.EstimatedDownloadSizeInBytes + +## -description +Gets or sets the estimated size, in bytes, of an email message download. + +## -property-value +The estimated size, in bytes, of an email message download. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_flagstate.md b/windows.applicationmodel.email/emailmessage_flagstate.md index fcd61bc5c1..3ea7a395ab 100644 --- a/windows.applicationmodel.email/emailmessage_flagstate.md +++ b/windows.applicationmodel.email/emailmessage_flagstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.FlagState --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.FlagState ## -description Represents the flag status of an email message. ## -property-value The flag status of an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.FlagState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.FlagState + +## -description +Represents the flag status of an email message. + +## -property-value +The flag status of an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_folderid.md b/windows.applicationmodel.email/emailmessage_folderid.md index 57cd420131..69c8b6e4ad 100644 --- a/windows.applicationmodel.email/emailmessage_folderid.md +++ b/windows.applicationmodel.email/emailmessage_folderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.FolderId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.FolderId ## -description Gets the identifier of a folder in the inbox. ## -property-value The identifier of a folder in the inbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.FolderId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.FolderId + +## -description +Gets the identifier of a folder in the inbox. + +## -property-value +The identifier of a folder in the inbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_getbodystream_143833399.md b/windows.applicationmodel.email/emailmessage_getbodystream_143833399.md index ebc91de19d..f35eee365e 100644 --- a/windows.applicationmodel.email/emailmessage_getbodystream_143833399.md +++ b/windows.applicationmodel.email/emailmessage_getbodystream_143833399.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMessage.GetBodyStream(Windows.ApplicationModel.Email.EmailMessageBodyKind) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMessage.GetBodyStream ## -description Gets the requested email stream such as plain text or HTML. ## -parameters ### -param type The kind of message body; plain text or HTML. ## -returns The selected body stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMessage.GetBodyStream(Windows.ApplicationModel.Email.EmailMessageBodyKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.GetBodyStream + +## -description +Gets the requested email stream such as plain text or HTML. + +## -parameters +### -param type +The kind of message body; plain text or HTML. + +## -returns +The selected body stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_haspartialbodies.md b/windows.applicationmodel.email/emailmessage_haspartialbodies.md index f3f3fe1f78..54086b5425 100644 --- a/windows.applicationmodel.email/emailmessage_haspartialbodies.md +++ b/windows.applicationmodel.email/emailmessage_haspartialbodies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.HasPartialBodies --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.HasPartialBodies ## -description Gets a Boolean value indicating whether this email message contains partial bodies. ## -property-value The Boolean value indicating whether this email message contains partial bodies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.HasPartialBodies +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.HasPartialBodies + +## -description +Gets a Boolean value indicating whether this email message contains partial bodies. + +## -property-value +The Boolean value indicating whether this email message contains partial bodies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_id.md b/windows.applicationmodel.email/emailmessage_id.md index 1b4996b003..63e960e67a 100644 --- a/windows.applicationmodel.email/emailmessage_id.md +++ b/windows.applicationmodel.email/emailmessage_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Id --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Id ## -description Gets the identifier of an email message. ## -property-value The identifier of an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Id + +## -description +Gets the identifier of an email message. + +## -property-value +The identifier of an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_importance.md b/windows.applicationmodel.email/emailmessage_importance.md index 400f25262a..4db0dbbd60 100644 --- a/windows.applicationmodel.email/emailmessage_importance.md +++ b/windows.applicationmodel.email/emailmessage_importance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Importance --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Importance ## -description Gets the importance of an email message. ## -property-value The importance of an email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Importance +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Importance + +## -description +Gets the importance of an email message. + +## -property-value +The importance of an email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_inresponsetomessageid.md b/windows.applicationmodel.email/emailmessage_inresponsetomessageid.md index 2d730b77c1..d0ec0a936a 100644 --- a/windows.applicationmodel.email/emailmessage_inresponsetomessageid.md +++ b/windows.applicationmodel.email/emailmessage_inresponsetomessageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.InResponseToMessageId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.InResponseToMessageId ## -description Gets the identifier for the email message to which this message is a response. ## -property-value The identifier for the email message to which this message is a response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.InResponseToMessageId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.InResponseToMessageId + +## -description +Gets the identifier for the email message to which this message is a response. + +## -property-value +The identifier for the email message to which this message is a response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_irminfo.md b/windows.applicationmodel.email/emailmessage_irminfo.md index 4aa0053e02..3d885bd610 100644 --- a/windows.applicationmodel.email/emailmessage_irminfo.md +++ b/windows.applicationmodel.email/emailmessage_irminfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.IrmInfo --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.IrmInfo ## -description Gets or sets the Information Rights Management (IRM) information for this email message. ## -property-value The Information Rights Management (IRM) information for this email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.IrmInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.IrmInfo + +## -description +Gets or sets the Information Rights Management (IRM) information for this email message. + +## -property-value +The Information Rights Management (IRM) information for this email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_isdraftmessage.md b/windows.applicationmodel.email/emailmessage_isdraftmessage.md index 3c0de56830..6cc5f8d3d1 100644 --- a/windows.applicationmodel.email/emailmessage_isdraftmessage.md +++ b/windows.applicationmodel.email/emailmessage_isdraftmessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsDraftMessage --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.IsDraftMessage ## -description Gets a Boolean value indicating whether this message is a draft. ## -property-value A Boolean value indicating whether this message is a draft. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsDraftMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.IsDraftMessage + +## -description +Gets a Boolean value indicating whether this message is a draft. + +## -property-value +A Boolean value indicating whether this message is a draft. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_isread.md b/windows.applicationmodel.email/emailmessage_isread.md index fd49c26a27..55aef401d4 100644 --- a/windows.applicationmodel.email/emailmessage_isread.md +++ b/windows.applicationmodel.email/emailmessage_isread.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsRead --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.IsRead ## -description Gets a Boolean value indicating whether the email message has been read. ## -property-value A Boolean value indicating whether the email message has been read. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsRead +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.IsRead + +## -description +Gets a Boolean value indicating whether the email message has been read. + +## -property-value +A Boolean value indicating whether the email message has been read. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_isseen.md b/windows.applicationmodel.email/emailmessage_isseen.md index 331b2cb0fd..1d865dadf9 100644 --- a/windows.applicationmodel.email/emailmessage_isseen.md +++ b/windows.applicationmodel.email/emailmessage_isseen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsSeen --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.IsSeen ## -description Gets a Boolean value indicating whether the email message has been seen. ## -property-value A Boolean value indicating whether the email message has been seen. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsSeen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.IsSeen + +## -description +Gets a Boolean value indicating whether the email message has been seen. + +## -property-value +A Boolean value indicating whether the email message has been seen. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_isserversearchmessage.md b/windows.applicationmodel.email/emailmessage_isserversearchmessage.md index 46e5774344..c4d987d3d7 100644 --- a/windows.applicationmodel.email/emailmessage_isserversearchmessage.md +++ b/windows.applicationmodel.email/emailmessage_isserversearchmessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsServerSearchMessage --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.IsServerSearchMessage ## -description Gets a Boolean value indicating whether the email message is a temporary server search message. ## -property-value The Boolean value indicating whether the email message is a temporary server search message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsServerSearchMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.IsServerSearchMessage + +## -description +Gets a Boolean value indicating whether the email message is a temporary server search message. + +## -property-value +The Boolean value indicating whether the email message is a temporary server search message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_issmartsendable.md b/windows.applicationmodel.email/emailmessage_issmartsendable.md index 278ae221ee..2fe975029c 100644 --- a/windows.applicationmodel.email/emailmessage_issmartsendable.md +++ b/windows.applicationmodel.email/emailmessage_issmartsendable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsSmartSendable --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.IsSmartSendable ## -description Gets a Boolean value indicating whether the response email message is allowed to attempt a smart send, only sending that portion of the email message that has changed. ## -property-value A Boolean value indicating whether the response email message is allowed to attempt a smart send. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.IsSmartSendable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.IsSmartSendable + +## -description +Gets a Boolean value indicating whether the response email message is allowed to attempt a smart send, only sending that portion of the email message that has changed. + +## -property-value +A Boolean value indicating whether the response email message is allowed to attempt a smart send. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_lastresponsekind.md b/windows.applicationmodel.email/emailmessage_lastresponsekind.md index 95dc5fe4c1..eed763e101 100644 --- a/windows.applicationmodel.email/emailmessage_lastresponsekind.md +++ b/windows.applicationmodel.email/emailmessage_lastresponsekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.LastResponseKind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.LastResponseKind ## -description Gets the last kind of response sent in reference to this email message. ## -property-value The last kind of response sent in reference to this email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.LastResponseKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.LastResponseKind + +## -description +Gets the last kind of response sent in reference to this email message. + +## -property-value +The last kind of response sent in reference to this email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_mailboxid.md b/windows.applicationmodel.email/emailmessage_mailboxid.md index edff108981..d9d5acd151 100644 --- a/windows.applicationmodel.email/emailmessage_mailboxid.md +++ b/windows.applicationmodel.email/emailmessage_mailboxid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.MailboxId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.MailboxId ## -description Gets the identifier of the mailbox. ## -property-value The identifier of the mailbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.MailboxId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.MailboxId + +## -description +Gets the identifier of the mailbox. + +## -property-value +The identifier of the mailbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_meetinginfo.md b/windows.applicationmodel.email/emailmessage_meetinginfo.md index 32f476f656..d16bb704d1 100644 --- a/windows.applicationmodel.email/emailmessage_meetinginfo.md +++ b/windows.applicationmodel.email/emailmessage_meetinginfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.MeetingInfo --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.MeetingInfo ## -description Gets the information associated with this meeting. ## -property-value The information associated with this meeting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.MeetingInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.MeetingInfo + +## -description +Gets the information associated with this meeting. + +## -property-value +The information associated with this meeting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_messageclass.md b/windows.applicationmodel.email/emailmessage_messageclass.md index b48928ee4b..ac2cca892c 100644 --- a/windows.applicationmodel.email/emailmessage_messageclass.md +++ b/windows.applicationmodel.email/emailmessage_messageclass.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.MessageClass --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.MessageClass ## -description Gets or sets a string that indicates the class of the message. ## -property-value The string that indicates the class of the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.MessageClass + +## -description +Gets or sets a string that indicates the class of the message. + +## -property-value +The string that indicates the class of the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_normalizedsubject.md b/windows.applicationmodel.email/emailmessage_normalizedsubject.md index 72d64850eb..6a32374dfd 100644 --- a/windows.applicationmodel.email/emailmessage_normalizedsubject.md +++ b/windows.applicationmodel.email/emailmessage_normalizedsubject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.NormalizedSubject --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.NormalizedSubject ## -description Gets the subject line of an email message stripped of additional prefixes such as fwd: and re: ## -property-value The subject line of an email message stripped of additional prefixes such as fwd: and re: ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.NormalizedSubject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.NormalizedSubject + +## -description +Gets the subject line of an email message stripped of additional prefixes such as fwd: and re: + +## -property-value +The subject line of an email message stripped of additional prefixes such as fwd: and re: + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_originalcodepage.md b/windows.applicationmodel.email/emailmessage_originalcodepage.md index 62e81725b7..5b57ddd7aa 100644 --- a/windows.applicationmodel.email/emailmessage_originalcodepage.md +++ b/windows.applicationmodel.email/emailmessage_originalcodepage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.OriginalCodePage --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.OriginalCodePage ## -description Gets or sets the integer that identifies the original flavor of the character set used so that when the email message is condensed from wide character format (16-bit) to ASCII or other 8-bit encoding, in cases of later encoding questions, this integer can be used to recreate the original character set. ## -property-value The integer that identifies the original flavor of the character set used ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.OriginalCodePage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.OriginalCodePage + +## -description +Gets or sets the integer that identifies the original flavor of the character set used so that when the email message is condensed from wide character format (16-bit) to ASCII or other 8-bit encoding, in cases of later encoding questions, this integer can be used to recreate the original character set. + +## -property-value +The integer that identifies the original flavor of the character set used + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_preview.md b/windows.applicationmodel.email/emailmessage_preview.md index b138ea67f7..c89ee3f670 100644 --- a/windows.applicationmodel.email/emailmessage_preview.md +++ b/windows.applicationmodel.email/emailmessage_preview.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Preview --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Preview ## -description Gets or sets the short preview string that represents the longer email message in the list view of emails. ## -property-value The short preview string that represents the longer email message in the list view of emails. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Preview +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Preview + +## -description +Gets or sets the short preview string that represents the longer email message in the list view of emails. + +## -property-value +The short preview string that represents the longer email message in the list view of emails. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_remoteid.md b/windows.applicationmodel.email/emailmessage_remoteid.md index 8f91b4e996..7dc7504c19 100644 --- a/windows.applicationmodel.email/emailmessage_remoteid.md +++ b/windows.applicationmodel.email/emailmessage_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.RemoteId ## -description Gets or sets the identifier that can be used by a service provider to access the email message on the client machine. ## -property-value The identifier that can be used by a service provider to access the email message on the client machine. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.RemoteId + +## -description +Gets or sets the identifier that can be used by a service provider to access the email message on the client machine. + +## -property-value +The identifier that can be used by a service provider to access the email message on the client machine. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_sender.md b/windows.applicationmodel.email/emailmessage_sender.md index a85fdd228d..c8e21554c3 100644 --- a/windows.applicationmodel.email/emailmessage_sender.md +++ b/windows.applicationmodel.email/emailmessage_sender.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Sender --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Sender ## -description Gets or sets the mailbox from which the email message was sent. ## -property-value The mailbox from which the email message was sent. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Sender +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Sender + +## -description +Gets or sets the mailbox from which the email message was sent. + +## -property-value +The mailbox from which the email message was sent. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_senttime.md b/windows.applicationmodel.email/emailmessage_senttime.md index a821a26020..00e1aa1595 100644 --- a/windows.applicationmodel.email/emailmessage_senttime.md +++ b/windows.applicationmodel.email/emailmessage_senttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.SentTime --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.SentTime ## -description Gets or sets the time an email was sent. ## -property-value The time an email was sent. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.SentTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.SentTime + +## -description +Gets or sets the time an email was sent. + +## -property-value +The time an email was sent. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_setbodystream_1899478623.md b/windows.applicationmodel.email/emailmessage_setbodystream_1899478623.md index aa3682c618..2c33075832 100644 --- a/windows.applicationmodel.email/emailmessage_setbodystream_1899478623.md +++ b/windows.applicationmodel.email/emailmessage_setbodystream_1899478623.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMessage.SetBodyStream(Windows.ApplicationModel.Email.EmailMessageBodyKind,Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMessage.SetBodyStream ## -description Sets the value of the specified body stream in an email message. ## -parameters ### -param type Indicates which body stream, plain text or HTML. ### -param stream The message for the specified body stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMessage.SetBodyStream(Windows.ApplicationModel.Email.EmailMessageBodyKind,Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.SetBodyStream + +## -description +Sets the value of the specified body stream in an email message. + +## -parameters +### -param type +Indicates which body stream, plain text or HTML. + +### -param stream +The message for the specified body stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_smimedata.md b/windows.applicationmodel.email/emailmessage_smimedata.md index b3cd5a8036..f80bfea423 100644 --- a/windows.applicationmodel.email/emailmessage_smimedata.md +++ b/windows.applicationmodel.email/emailmessage_smimedata.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.SmimeData --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.SmimeData ## -description Gets or sets the S/MIME data associated with an email message. For more information, see the [Certificate class](https://msdn.microsoft.com/en-us/library/windows/apps/windows.security.cryptography.certificates.certificate). ## -property-value The MIME data associated with an email message. ## -remarks For more information about S/MIME encryption and certificates, see [Secure/Multipurpose Internet Mail Extensions (S/MIME) Version 3.2 Message Specification.](https://tools.ietf.org/html/rfc5751 ) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.SmimeData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.SmimeData + +## -description +Gets or sets the S/MIME data associated with an email message. For more information, see the [Certificate class](https://msdn.microsoft.com/en-us/library/windows/apps/windows.security.cryptography.certificates.certificate). + +## -property-value +The MIME data associated with an email message. + +## -remarks +For more information about S/MIME encryption and certificates, see [Secure/Multipurpose Internet Mail Extensions (S/MIME) Version 3.2 + + Message Specification.](https://tools.ietf.org/html/rfc5751 ) + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_smimekind.md b/windows.applicationmodel.email/emailmessage_smimekind.md index ac5acc549a..0bd43efa83 100644 --- a/windows.applicationmodel.email/emailmessage_smimekind.md +++ b/windows.applicationmodel.email/emailmessage_smimekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.SmimeKind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.SmimeKind ## -description Gets or sets the type of S/MIME encryption/signature for the email message. ## -property-value The type of S/MIME encryption/signature for the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.SmimeKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.SmimeKind + +## -description +Gets or sets the type of S/MIME encryption/signature for the email message. + +## -property-value +The type of S/MIME encryption/signature for the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_subject.md b/windows.applicationmodel.email/emailmessage_subject.md index 3ef3f4f6da..d34bb6bad4 100644 --- a/windows.applicationmodel.email/emailmessage_subject.md +++ b/windows.applicationmodel.email/emailmessage_subject.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.Subject --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.Subject ## -description Gets or sets the subject of the email message. ## -property-value The subject of the email. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.Subject + +## -description +Gets or sets the subject of the email message. + +## -property-value +The subject of the email. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessage_to.md b/windows.applicationmodel.email/emailmessage_to.md index 406eeace17..b313c2bddc 100644 --- a/windows.applicationmodel.email/emailmessage_to.md +++ b/windows.applicationmodel.email/emailmessage_to.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessage.To --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessage.To ## -description Gets the direct recipients of the email message. ## -property-value The recipients of the email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.To +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.To + +## -description +Gets the direct recipients of the email message. + +## -property-value +The recipients of the email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessagebatch.md b/windows.applicationmodel.email/emailmessagebatch.md index 6b066d2286..5b4cce1d4a 100644 --- a/windows.applicationmodel.email/emailmessagebatch.md +++ b/windows.applicationmodel.email/emailmessagebatch.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMessageBatch --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMessageBatch ## -description Represents a collection of email messages. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMessageBatch +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMessageBatch + +## -description +Represents a collection of email messages. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessagebatch_messages.md b/windows.applicationmodel.email/emailmessagebatch_messages.md index c21f91e14d..1b0ee3051f 100644 --- a/windows.applicationmodel.email/emailmessagebatch_messages.md +++ b/windows.applicationmodel.email/emailmessagebatch_messages.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessageBatch.Messages --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessageBatch.Messages ## -description Gets a batch of email messages. ## -property-value A batch of email messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessageBatch.Messages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessageBatch.Messages + +## -description +Gets a batch of email messages. + +## -property-value +A batch of email messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessagebatch_status.md b/windows.applicationmodel.email/emailmessagebatch_status.md index 03a11c6ee5..10bcc536b7 100644 --- a/windows.applicationmodel.email/emailmessagebatch_status.md +++ b/windows.applicationmodel.email/emailmessagebatch_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailMessageBatch.Status --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailMessageBatch.Status ## -description Gets the status of the email batch read. ## -property-value The status of the email batch read. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessageBatch.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessageBatch.Status + +## -description +Gets the status of the email batch read. + +## -property-value +The status of the email batch read. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessagereader.md b/windows.applicationmodel.email/emailmessagereader.md index cd13c874b9..a6f02597fa 100644 --- a/windows.applicationmodel.email/emailmessagereader.md +++ b/windows.applicationmodel.email/emailmessagereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailMessageReader --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailMessageReader ## -description Gets a batch of email messages. ## -remarks Call **GetMessageReader** or **GetMessageReader(EmailQueryOptions)** to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailMessageReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailMessageReader + +## -description +Gets a batch of email messages. + +## -remarks +Call **GetMessageReader** or **GetMessageReader(EmailQueryOptions)** to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailmessagereader_readbatchasync_888788553.md b/windows.applicationmodel.email/emailmessagereader_readbatchasync_888788553.md index de39fc9985..d2540adf1f 100644 --- a/windows.applicationmodel.email/emailmessagereader_readbatchasync_888788553.md +++ b/windows.applicationmodel.email/emailmessagereader_readbatchasync_888788553.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailMessageReader.ReadBatchAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailMessageReader.ReadBatchAsync ## -description Reads a collection of email messages. ## -returns A batch of email messages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMessageReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMessageReader.ReadBatchAsync + +## -description +Reads a collection of email messages. + +## -returns +A batch of email messages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailqueryoptions.md b/windows.applicationmodel.email/emailqueryoptions.md index dc1fd3b07b..ca9288afb2 100644 --- a/windows.applicationmodel.email/emailqueryoptions.md +++ b/windows.applicationmodel.email/emailqueryoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailQueryOptions --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailQueryOptions ## -description Represents the options selected for an email mailbox query. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailQueryOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions + +## -description +Represents the options selected for an email mailbox query. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_1221375020.md b/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_1221375020.md index 5dabd8ba99..ad0587bff8 100644 --- a/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_1221375020.md +++ b/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailQueryOptions.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailQueryOptions.EmailQueryOptions ## -description Instantiates a new instance of the class. ## -remarks ## -examples ## -see-also [EmailQueryOptions(String)](emailqueryoptions_emailqueryoptions_290278668.md), [EmailQueryOptions(String, EmailQuerySearchFields)](emailqueryoptions_emailqueryoptions_235139876.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailQueryOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.EmailQueryOptions + +## -description +Instantiates a new instance of the class. + +## -remarks + +## -examples + +## -see-also +[EmailQueryOptions(String)](emailqueryoptions_emailqueryoptions_290278668.md), [EmailQueryOptions(String, EmailQuerySearchFields)](emailqueryoptions_emailqueryoptions_235139876.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_235139876.md b/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_235139876.md index bfd78f1e50..604d0d6b2e 100644 --- a/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_235139876.md +++ b/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_235139876.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailQueryOptions.#ctor(System.String,Windows.ApplicationModel.Email.EmailQuerySearchFields) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailQueryOptions.EmailQueryOptions ## -description Instantiates a new instance of the class. ## -parameters ### -param text The text for which to search. ### -param fields The fields against which to search. ## -remarks ## -examples ## -see-also [EmailQueryOptions(String)](emailqueryoptions_emailqueryoptions_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailQueryOptions.#ctor(System.String,Windows.ApplicationModel.Email.EmailQuerySearchFields) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.EmailQueryOptions + +## -description +Instantiates a new instance of the class. + +## -parameters +### -param text +The text for which to search. + +### -param fields +The fields against which to search. + +## -remarks + +## -examples + +## -see-also +[EmailQueryOptions(String)](emailqueryoptions_emailqueryoptions_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_290278668.md b/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_290278668.md index e4f4174cab..b45bef867b 100644 --- a/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_290278668.md +++ b/windows.applicationmodel.email/emailqueryoptions_emailqueryoptions_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailQueryOptions.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailQueryOptions.EmailQueryOptions ## -description Instantiates a new instance of the class. ## -parameters ### -param text The text for which to search. ## -remarks ## -examples ## -see-also [EmailQueryOptions(String, EmailQuerySearchFields)](emailqueryoptions_emailqueryoptions_235139876.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailQueryOptions.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.EmailQueryOptions + +## -description +Instantiates a new instance of the class. + +## -parameters +### -param text +The text for which to search. + +## -remarks + +## -examples + +## -see-also +[EmailQueryOptions(String, EmailQuerySearchFields)](emailqueryoptions_emailqueryoptions_235139876.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailqueryoptions_folderids.md b/windows.applicationmodel.email/emailqueryoptions_folderids.md index 5fb78ee4da..3ca6ada892 100644 --- a/windows.applicationmodel.email/emailqueryoptions_folderids.md +++ b/windows.applicationmodel.email/emailqueryoptions_folderids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.FolderIds --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryOptions.FolderIds ## -description Gets the identifiers for the folders in which to search. ## -property-value The identifiers for the folders in which to search. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.FolderIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.FolderIds + +## -description +Gets the identifiers for the folders in which to search. + +## -property-value +The identifiers for the folders in which to search. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailqueryoptions_kind.md b/windows.applicationmodel.email/emailqueryoptions_kind.md index d5b3c6c4f9..ed6f57433f 100644 --- a/windows.applicationmodel.email/emailqueryoptions_kind.md +++ b/windows.applicationmodel.email/emailqueryoptions_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryOptions.Kind ## -description Gets or sets the kind of emails for which to query. ## -property-value The kind of emails for which to query. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.Kind + +## -description +Gets or sets the kind of emails for which to query. + +## -property-value +The kind of emails for which to query. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailqueryoptions_sortdirection.md b/windows.applicationmodel.email/emailqueryoptions_sortdirection.md index 7c4e1dd58e..d607a3f849 100644 --- a/windows.applicationmodel.email/emailqueryoptions_sortdirection.md +++ b/windows.applicationmodel.email/emailqueryoptions_sortdirection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.SortDirection --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryOptions.SortDirection ## -description Gets or sets the direction of the sort for the query results. ## -property-value The direction of the sort for the query results. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.SortDirection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.SortDirection + +## -description +Gets or sets the direction of the sort for the query results. + +## -property-value +The direction of the sort for the query results. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailqueryoptions_sortproperty.md b/windows.applicationmodel.email/emailqueryoptions_sortproperty.md index d36d3828bf..5c26b4c680 100644 --- a/windows.applicationmodel.email/emailqueryoptions_sortproperty.md +++ b/windows.applicationmodel.email/emailqueryoptions_sortproperty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.SortProperty --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryOptions.SortProperty ## -description Gets or sets a Boolean value indicating whether the query results should be sorted. ## -property-value A Boolean value indicating whether the query results should be sorted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.SortProperty +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.SortProperty + +## -description +Gets or sets a Boolean value indicating whether the query results should be sorted. + +## -property-value +A Boolean value indicating whether the query results should be sorted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailqueryoptions_textsearch.md b/windows.applicationmodel.email/emailqueryoptions_textsearch.md index 91ece91148..00417fb95e 100644 --- a/windows.applicationmodel.email/emailqueryoptions_textsearch.md +++ b/windows.applicationmodel.email/emailqueryoptions_textsearch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.TextSearch --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryOptions.TextSearch ## -description Gets the text to search for. ## -property-value The text to search for. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryOptions.TextSearch +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryOptions.TextSearch + +## -description +Gets the text to search for. + +## -property-value +The text to search for. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailquerytextsearch.md b/windows.applicationmodel.email/emailquerytextsearch.md index a8e69bde88..11202811b6 100644 --- a/windows.applicationmodel.email/emailquerytextsearch.md +++ b/windows.applicationmodel.email/emailquerytextsearch.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailQueryTextSearch --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailQueryTextSearch ## -description Represents a text search query in an email mailbox. ## -remarks The **TextSearch** property provides access to an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailQueryTextSearch +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailQueryTextSearch + +## -description +Represents a text search query in an email mailbox. + +## -remarks +The **TextSearch** property provides access to an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailquerytextsearch_fields.md b/windows.applicationmodel.email/emailquerytextsearch_fields.md index 9516b8ef5b..f323690dcc 100644 --- a/windows.applicationmodel.email/emailquerytextsearch_fields.md +++ b/windows.applicationmodel.email/emailquerytextsearch_fields.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryTextSearch.Fields --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryTextSearch.Fields ## -description Gets or sets the fields for an email text search query. ## -property-value The fields for an email text search query. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryTextSearch.Fields +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryTextSearch.Fields + +## -description +Gets or sets the fields for an email text search query. + +## -property-value +The fields for an email text search query. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailquerytextsearch_searchscope.md b/windows.applicationmodel.email/emailquerytextsearch_searchscope.md index 081b2e1619..f1decebd7e 100644 --- a/windows.applicationmodel.email/emailquerytextsearch_searchscope.md +++ b/windows.applicationmodel.email/emailquerytextsearch_searchscope.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryTextSearch.SearchScope --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryTextSearch.SearchScope ## -description Gets or sets the scope for an email text search query. ## -property-value The scope for an email text search query. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryTextSearch.SearchScope +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryTextSearch.SearchScope + +## -description +Gets or sets the scope for an email text search query. + +## -property-value +The scope for an email text search query. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailquerytextsearch_text.md b/windows.applicationmodel.email/emailquerytextsearch_text.md index 39be10eabb..de0f6a8b63 100644 --- a/windows.applicationmodel.email/emailquerytextsearch_text.md +++ b/windows.applicationmodel.email/emailquerytextsearch_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailQueryTextSearch.Text --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailQueryTextSearch.Text ## -description Gets or sets the text string for an email text search query. ## -property-value The text string for an email text search query. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailQueryTextSearch.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailQueryTextSearch.Text + +## -description +Gets or sets the text string for an email text search query. + +## -property-value +The text string for an email text search query. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipient.md b/windows.applicationmodel.email/emailrecipient.md index 81dec1a9ba..ab17597daf 100644 --- a/windows.applicationmodel.email/emailrecipient.md +++ b/windows.applicationmodel.email/emailrecipient.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailRecipient --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailRecipient ## -description Represents an email recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailRecipient +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailRecipient + +## -description +Represents an email recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipient_address.md b/windows.applicationmodel.email/emailrecipient_address.md index faeffec20a..384d3a755e 100644 --- a/windows.applicationmodel.email/emailrecipient_address.md +++ b/windows.applicationmodel.email/emailrecipient_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailRecipient.Address --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailRecipient.Address ## -description Gets or sets the address of the email recipient. ## -property-value The address of the email recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailRecipient.Address +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailRecipient.Address + +## -description +Gets or sets the address of the email recipient. + +## -property-value +The address of the email recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipient_emailrecipient_1221375020.md b/windows.applicationmodel.email/emailrecipient_emailrecipient_1221375020.md index ef879f8df2..eaa58370ef 100644 --- a/windows.applicationmodel.email/emailrecipient_emailrecipient_1221375020.md +++ b/windows.applicationmodel.email/emailrecipient_emailrecipient_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailRecipient.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailRecipient.EmailRecipient ## -description Initializes an instance of the [EmailRecipient](emailrecipient.md) class. ## -remarks ## -examples ## -see-also [EmailRecipient(String)](emailrecipient_emailrecipient_290278668.md), [EmailRecipient(String, String)](emailrecipient_emailrecipient_1571897524.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailRecipient.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailRecipient.EmailRecipient + +## -description +Initializes an instance of the [EmailRecipient](emailrecipient.md) class. + +## -remarks + +## -examples + +## -see-also +[EmailRecipient(String)](emailrecipient_emailrecipient_290278668.md), [EmailRecipient(String, String)](emailrecipient_emailrecipient_1571897524.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailrecipient_emailrecipient_1571897524.md b/windows.applicationmodel.email/emailrecipient_emailrecipient_1571897524.md index a716364d61..f131436bae 100644 --- a/windows.applicationmodel.email/emailrecipient_emailrecipient_1571897524.md +++ b/windows.applicationmodel.email/emailrecipient_emailrecipient_1571897524.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailRecipient.#ctor(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailRecipient.EmailRecipient ## -description Initializes an instance of the [EmailRecipient](emailrecipient.md) class. ## -parameters ### -param address The address of the recipient. ### -param name The name of the recipient. ## -remarks ## -examples ## -see-also [EmailRecipient(String)](emailrecipient_emailrecipient_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailRecipient.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailRecipient.EmailRecipient + +## -description +Initializes an instance of the [EmailRecipient](emailrecipient.md) class. + +## -parameters +### -param address +The address of the recipient. + +### -param name +The name of the recipient. + +## -remarks + +## -examples + +## -see-also +[EmailRecipient(String)](emailrecipient_emailrecipient_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailrecipient_emailrecipient_290278668.md b/windows.applicationmodel.email/emailrecipient_emailrecipient_290278668.md index e44ad23c52..a29fb91b9a 100644 --- a/windows.applicationmodel.email/emailrecipient_emailrecipient_290278668.md +++ b/windows.applicationmodel.email/emailrecipient_emailrecipient_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailRecipient.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailRecipient.EmailRecipient ## -description Initializes an instance of the [EmailRecipient](emailrecipient.md) class. ## -parameters ### -param address The address of the recipient. ## -remarks ## -examples ## -see-also [EmailRecipient(String, String)](emailrecipient_emailrecipient_1571897524.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailRecipient.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailRecipient.EmailRecipient + +## -description +Initializes an instance of the [EmailRecipient](emailrecipient.md) class. + +## -parameters +### -param address +The address of the recipient. + +## -remarks + +## -examples + +## -see-also +[EmailRecipient(String, String)](emailrecipient_emailrecipient_1571897524.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailrecipient_name.md b/windows.applicationmodel.email/emailrecipient_name.md index 80709f5105..6398a22c75 100644 --- a/windows.applicationmodel.email/emailrecipient_name.md +++ b/windows.applicationmodel.email/emailrecipient_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailRecipient.Name --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailRecipient.Name ## -description Gets or sets the name of the email recipient. ## -property-value The name of the email recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailRecipient.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailRecipient.Name + +## -description +Gets or sets the name of the email recipient. + +## -property-value +The name of the email recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipientresolutionresult.md b/windows.applicationmodel.email/emailrecipientresolutionresult.md index c424ccc499..d57b15afdd 100644 --- a/windows.applicationmodel.email/emailrecipientresolutionresult.md +++ b/windows.applicationmodel.email/emailrecipientresolutionresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailRecipientResolutionResult --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailRecipientResolutionResult ## -description Represents the result of an attempt to resolve an email recipient. ## -remarks Call [ResolveRecipientsAsync](emailmailbox_resolverecipientsasync.md) to retrieve an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailRecipientResolutionResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailRecipientResolutionResult + +## -description +Represents the result of an attempt to resolve an email recipient. + +## -remarks +Call [ResolveRecipientsAsync](emailmailbox_resolverecipientsasync.md) to retrieve an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipientresolutionresult_emailrecipientresolutionresult_1221375020.md b/windows.applicationmodel.email/emailrecipientresolutionresult_emailrecipientresolutionresult_1221375020.md index 1d3f3f1ba2..8010d453ac 100644 --- a/windows.applicationmodel.email/emailrecipientresolutionresult_emailrecipientresolutionresult_1221375020.md +++ b/windows.applicationmodel.email/emailrecipientresolutionresult_emailrecipientresolutionresult_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailRecipientResolutionResult.EmailRecipientResolutionResult ## -description Instantiates a new instance of the [EmailRecipientResolutionResult](emailrecipientresolutionresult.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailRecipientResolutionResult.EmailRecipientResolutionResult + +## -description +Instantiates a new instance of the [EmailRecipientResolutionResult](emailrecipientresolutionresult.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipientresolutionresult_publickeys.md b/windows.applicationmodel.email/emailrecipientresolutionresult_publickeys.md index 973864424d..c4f64d8367 100644 --- a/windows.applicationmodel.email/emailrecipientresolutionresult_publickeys.md +++ b/windows.applicationmodel.email/emailrecipientresolutionresult_publickeys.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.PublicKeys --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailRecipientResolutionResult.PublicKeys ## -description Gets the public key for an email recipient. ## -property-value The public key for an email recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.PublicKeys +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailRecipientResolutionResult.PublicKeys + +## -description +Gets the public key for an email recipient. + +## -property-value +The public key for an email recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipientresolutionresult_setpublickeys_870408309.md b/windows.applicationmodel.email/emailrecipientresolutionresult_setpublickeys_870408309.md index 21232ec258..2ea6d733c5 100644 --- a/windows.applicationmodel.email/emailrecipientresolutionresult_setpublickeys_870408309.md +++ b/windows.applicationmodel.email/emailrecipientresolutionresult_setpublickeys_870408309.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.SetPublicKeys(Windows.Foundation.Collections.IIterable{Windows.Security.Cryptography.Certificates.Certificate}) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailRecipientResolutionResult.SetPublicKeys ## -description Sets the public keys for an email recipient. ## -parameters ### -param value An iterable collection of certificates. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.SetPublicKeys(Windows.Foundation.Collections.IIterable{Windows.Security.Cryptography.Certificates.Certificate}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailRecipientResolutionResult.SetPublicKeys + +## -description +Sets the public keys for an email recipient. + +## -parameters +### -param value +An iterable collection of certificates. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailrecipientresolutionresult_status.md b/windows.applicationmodel.email/emailrecipientresolutionresult_status.md index 2220e6bd86..7994cf75e2 100644 --- a/windows.applicationmodel.email/emailrecipientresolutionresult_status.md +++ b/windows.applicationmodel.email/emailrecipientresolutionresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.Status --api-type: winrt property ---- # Windows.ApplicationModel.Email.EmailRecipientResolutionResult.Status ## -description Gets or sets the state of an attempt to resolve an email recipient. ## -property-value The state of an attempt to resolve an email recipient. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Email.EmailRecipientResolutionResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailRecipientResolutionResult.Status + +## -description +Gets or sets the state of an attempt to resolve an email recipient. + +## -property-value +The state of an attempt to resolve an email recipient. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore.md b/windows.applicationmodel.email/emailstore.md index 16dabdb2fd..e1d733fb61 100644 --- a/windows.applicationmodel.email/emailstore.md +++ b/windows.applicationmodel.email/emailstore.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailStore --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailStore ## -description The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailStore + +## -description +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore_createmailboxasync_100209417.md b/windows.applicationmodel.email/emailstore_createmailboxasync_100209417.md index df84298f43..1b982362ac 100644 --- a/windows.applicationmodel.email/emailstore_createmailboxasync_100209417.md +++ b/windows.applicationmodel.email/emailstore_createmailboxasync_100209417.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync ## -description Allows an app to create an email account from an account name and an email address. ## -parameters ### -param accountName The name of the account. ### -param accountAddress The email address associated with the account. ## -returns An email mailbox. ## -remarks ## -examples ## -see-also [CreateMailboxAsync(String, String, String)](emailstore_createmailboxasync_1677653897.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync + +## -description +Allows an app to create an email account from an account name and an email address. + +## -parameters +### -param accountName +The name of the account. + +### -param accountAddress +The email address associated with the account. + +## -returns +An email mailbox. + +## -remarks + +## -examples + +## -see-also +[CreateMailboxAsync(String, String, String)](emailstore_createmailboxasync_1677653897.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailstore_createmailboxasync_1677653897.md b/windows.applicationmodel.email/emailstore_createmailboxasync_1677653897.md index 72f6352060..6ce5014f9b 100644 --- a/windows.applicationmodel.email/emailstore_createmailboxasync_1677653897.md +++ b/windows.applicationmodel.email/emailstore_createmailboxasync_1677653897.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync(System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync ## -description Allows an app to create an email account from an account name, an email address, and the user data account in which the mailbox will reside. ## -parameters ### -param accountName The name of the account. ### -param accountAddress The email address associated with the account. ### -param userDataAccountId The user data account identifier associated with this user. ## -returns An email mailbox. ## -remarks ## -examples ## -see-also [CreateMailboxAsync(String, String)](emailstore_createmailboxasync_100209417.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.CreateMailboxAsync + +## -description +Allows an app to create an email account from an account name, an email address, and the user data account in which the mailbox will reside. + +## -parameters +### -param accountName +The name of the account. + +### -param accountAddress +The email address associated with the account. + +### -param userDataAccountId +The user data account identifier associated with this user. + +## -returns +An email mailbox. + +## -remarks + +## -examples + +## -see-also +[CreateMailboxAsync(String, String)](emailstore_createmailboxasync_100209417.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailstore_findmailboxesasync_244916843.md b/windows.applicationmodel.email/emailstore_findmailboxesasync_244916843.md index 1ce4200229..1bae0740f6 100644 --- a/windows.applicationmodel.email/emailstore_findmailboxesasync_244916843.md +++ b/windows.applicationmodel.email/emailstore_findmailboxesasync_244916843.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.FindMailboxesAsync --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.FindMailboxesAsync ## -description Gets all mailboxes within the current scope. ## -returns A collection of mailboxes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.FindMailboxesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.FindMailboxesAsync + +## -description +Gets all mailboxes within the current scope. + +## -returns +A collection of mailboxes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore_getconversationasync_2049140047.md b/windows.applicationmodel.email/emailstore_getconversationasync_2049140047.md index 4b9412e853..957dd500d4 100644 --- a/windows.applicationmodel.email/emailstore_getconversationasync_2049140047.md +++ b/windows.applicationmodel.email/emailstore_getconversationasync_2049140047.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetConversationAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetConversationAsync ## -description Gets an email conversation from the provided identifier. ## -parameters ### -param id The identifier of the conversation. ## -returns An email conversation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetConversationAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetConversationAsync + +## -description +Gets an email conversation from the provided identifier. + +## -parameters +### -param id +The identifier of the conversation. + +## -returns +An email conversation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore_getconversationreader_388570943.md b/windows.applicationmodel.email/emailstore_getconversationreader_388570943.md index d0e446cc61..c5dbf05368 100644 --- a/windows.applicationmodel.email/emailstore_getconversationreader_388570943.md +++ b/windows.applicationmodel.email/emailstore_getconversationreader_388570943.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetConversationReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetConversationReader ## -description Gets a batch of email conversations. ## -returns A batch of email conversations. ## -remarks ## -examples ## -see-also [GetConversationReader(EmailQueryOptions)](emailstore_getconversationreader_964157301.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetConversationReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetConversationReader + +## -description +Gets a batch of email conversations. + +## -returns +A batch of email conversations. + +## -remarks + +## -examples + +## -see-also +[GetConversationReader(EmailQueryOptions)](emailstore_getconversationreader_964157301.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailstore_getconversationreader_964157301.md b/windows.applicationmodel.email/emailstore_getconversationreader_964157301.md index 599b1aed78..fc61fca313 100644 --- a/windows.applicationmodel.email/emailstore_getconversationreader_964157301.md +++ b/windows.applicationmodel.email/emailstore_getconversationreader_964157301.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetConversationReader(Windows.ApplicationModel.Email.EmailQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetConversationReader ## -description Gets a batch of email conversations using the specified email query options. ## -parameters ### -param options The email query options. ## -returns A batch of email conversations. ## -remarks ## -examples ## -see-also [GetConversationReader](emailstore_getconversationreader_388570943.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetConversationReader(Windows.ApplicationModel.Email.EmailQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetConversationReader + +## -description +Gets a batch of email conversations using the specified email query options. + +## -parameters +### -param options +The email query options. + +## -returns +A batch of email conversations. + +## -remarks + +## -examples + +## -see-also +[GetConversationReader](emailstore_getconversationreader_388570943.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailstore_getfolderasync_761626819.md b/windows.applicationmodel.email/emailstore_getfolderasync_761626819.md index f25a4f2eba..ff10d5cdbf 100644 --- a/windows.applicationmodel.email/emailstore_getfolderasync_761626819.md +++ b/windows.applicationmodel.email/emailstore_getfolderasync_761626819.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetFolderAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetFolderAsync ## -description Gets an email folder from an identifier. ## -parameters ### -param id The identifier for the email folder. ## -returns The folder described by the identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetFolderAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetFolderAsync + +## -description +Gets an email folder from an identifier. + +## -parameters +### -param id +The identifier for the email folder. + +## -returns +The folder described by the identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore_getmailboxasync_156458134.md b/windows.applicationmodel.email/emailstore_getmailboxasync_156458134.md index d1468843d7..22c27edac2 100644 --- a/windows.applicationmodel.email/emailstore_getmailboxasync_156458134.md +++ b/windows.applicationmodel.email/emailstore_getmailboxasync_156458134.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMailboxAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetMailboxAsync ## -description Gets a mailbox from an identifier. ## -parameters ### -param id The identifier for the mailbox. ## -returns The mailbox described by the identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMailboxAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetMailboxAsync + +## -description +Gets a mailbox from an identifier. + +## -parameters +### -param id +The identifier for the mailbox. + +## -returns +The mailbox described by the identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore_getmessageasync_151244055.md b/windows.applicationmodel.email/emailstore_getmessageasync_151244055.md index c0e55009d1..65a13641b8 100644 --- a/windows.applicationmodel.email/emailstore_getmessageasync_151244055.md +++ b/windows.applicationmodel.email/emailstore_getmessageasync_151244055.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMessageAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetMessageAsync ## -description Gets the specified email message. ## -parameters ### -param id The identifier for the email message. ## -returns The specified email message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMessageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetMessageAsync + +## -description +Gets the specified email message. + +## -parameters +### -param id +The identifier for the email message. + +## -returns +The specified email message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.email/emailstore_getmessagereader_1198599356.md b/windows.applicationmodel.email/emailstore_getmessagereader_1198599356.md index b39daf40cf..fa30ea1481 100644 --- a/windows.applicationmodel.email/emailstore_getmessagereader_1198599356.md +++ b/windows.applicationmodel.email/emailstore_getmessagereader_1198599356.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMessageReader --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetMessageReader ## -description Gets a message reader. ## -returns The email message reader. ## -remarks ## -examples ## -see-also [GetMessageReader(EmailQueryOptions)](emailstore_getmessagereader_1764748530.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMessageReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetMessageReader + +## -description +Gets a message reader. + +## -returns +The email message reader. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader(EmailQueryOptions)](emailstore_getmessagereader_1764748530.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailstore_getmessagereader_1764748530.md b/windows.applicationmodel.email/emailstore_getmessagereader_1764748530.md index e60ecb0819..fe23ff893e 100644 --- a/windows.applicationmodel.email/emailstore_getmessagereader_1764748530.md +++ b/windows.applicationmodel.email/emailstore_getmessagereader_1764748530.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMessageReader(Windows.ApplicationModel.Email.EmailQueryOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Email.EmailStore.GetMessageReader ## -description Gets a message reader using the specified query options. ## -parameters ### -param options Specified query options. ## -returns An email message reader. ## -remarks ## -examples ## -see-also [GetMessageReader](emailstore_getmessagereader_1198599356.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Email.EmailStore.GetMessageReader(Windows.ApplicationModel.Email.EmailQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailStore.GetMessageReader + +## -description +Gets a message reader using the specified query options. + +## -parameters +### -param options +Specified query options. + +## -returns +An email message reader. + +## -remarks + +## -examples + +## -see-also +[GetMessageReader](emailstore_getmessagereader_1198599356.md) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailstorenotificationtriggerdetails.md b/windows.applicationmodel.email/emailstorenotificationtriggerdetails.md index 7000322a90..84603f83de 100644 --- a/windows.applicationmodel.email/emailstorenotificationtriggerdetails.md +++ b/windows.applicationmodel.email/emailstorenotificationtriggerdetails.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Email.EmailStoreNotificationTriggerDetails --api-type: winrt class ---- # Windows.ApplicationModel.Email.EmailStoreNotificationTriggerDetails ## -description The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. ## -remarks The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Email.EmailStoreNotificationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Email.EmailStoreNotificationTriggerDetails + +## -description +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +For more information about the [Windows.ApplicationModel.Email](windows_applicationmodel_email.md) namespace, please work with your Microsoft Account Team representative. + +## -remarks +The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundrevokedeventargs_reason.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundrevokedeventargs_reason.md index 4fee3d5ef5..3abb275a54 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundrevokedeventargs_reason.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundrevokedeventargs_reason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundRevokedEventArgs.Reason --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundRevokedEventArgs.Reason ## -description Gets the reason extended execution was revoked. ## -property-value The reason extended execution was revoked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundRevokedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundRevokedEventArgs.Reason + +## -description +Gets the reason extended execution was revoked. + +## -property-value +The reason extended execution was revoked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession.md index 1164be0f5d..14e46707e4 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession --api-type: winrt class ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession ## -description Supports managing a request for extended foreground execution. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession + +## -description +Supports managing a request for extended foreground execution. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_close_811482585.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_close_811482585.md index 5e5bba3807..43ba082fca 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_close_811482585.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Close --api-type: winrt method ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Close ## -description Closes the session and removes the application's extended execution capability. ## -remarks ## -examples ## -see-also ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Close +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Close + +## -description +Closes the session and removes the application's extended execution capability. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_description.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_description.md index b5368301dc..cbc25f0ccf 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_description.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_description.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Description --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Description ## -description Gets or sets a string to display in the shell. ## -property-value A string to display in the shell. ## -remarks ## -examples ## -see-also ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Description + +## -description +Gets or sets a string to display in the shell. + +## -property-value +A string to display in the shell. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_extendedexecutionforegroundsession_1221375020.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_extendedexecutionforegroundsession_1221375020.md index 27a86ef2d7..404febc81f 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_extendedexecutionforegroundsession_1221375020.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_extendedexecutionforegroundsession_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.ExtendedExecutionForegroundSession ## -description Creates an [ExtendedExecutionForegroundSession](extendedexecutionforegroundsession.md) object ## -remarks ## -examples ## -see-also ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.ExtendedExecutionForegroundSession + +## -description +Creates an [ExtendedExecutionForegroundSession](extendedexecutionforegroundsession.md) object + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_reason.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_reason.md index 75fa4a6f35..83dec741a4 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_reason.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_reason.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Reason --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Reason ## -description Gets or sets the reason for the extended execution request. ## -property-value The reason for the for the extended execution request. ## -remarks ## -examples ## -see-also ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Reason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Reason + +## -description +Gets or sets the reason for the extended execution request. + +## -property-value +The reason for the for the extended execution request. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_requestextensionasync_935610333.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_requestextensionasync_935610333.md index 9b3e05d462..185f1e09f4 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_requestextensionasync_935610333.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_requestextensionasync_935610333.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.RequestExtensionAsync --api-type: winrt method ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.RequestExtensionAsync ## -description Requests extended execution ## -returns The result of the request. ## -remarks ## -examples ## -see-also ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.RequestExtensionAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.RequestExtensionAsync + +## -description +Requests extended execution + +## -returns +The result of the request. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_revoked.md b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_revoked.md index a536cf9a93..49bfbd9eaa 100644 --- a/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_revoked.md +++ b/windows.applicationmodel.extendedexecution.foreground/extendedexecutionforegroundsession_revoked.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Revoked --api-type: winrt event ---- # Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Revoked ## -description This event occurs when the system revokes extended execution. ## -remarks ## -examples ## -see-also ## -capabilities extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Revoked +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.ExtendedExecution.Foreground.ExtendedExecutionForegroundSession.Revoked + +## -description +This event occurs when the system revokes extended execution. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +extendedExecutionBackgroundAudio, extendedExecutionCritical, extendedExecutionUnconstrained \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionrevokedeventargs_reason.md b/windows.applicationmodel.extendedexecution/extendedexecutionrevokedeventargs_reason.md index 25b6c9800e..3d440014bd 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionrevokedeventargs_reason.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionrevokedeventargs_reason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionRevokedEventArgs.Reason --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionRevokedEventArgs.Reason ## -description Gets the reason background execution was revoked. ## -property-value The reason background execution was revoked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionRevokedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionRevokedEventArgs.Reason + +## -description +Gets the reason background execution was revoked. + +## -property-value +The reason background execution was revoked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession.md index 39e4fefc09..7d74dcaf16 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession --api-type: winrt class ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession ## -description Supports managing a request for background execution. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession + +## -description +Supports managing a request for background execution. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_close_811482585.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_close_811482585.md index ae75ac9363..88aa0a4adb 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_close_811482585.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Close --api-type: winrt method ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Close ## -description Closes the session and removes the application's capability to run in the background. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Close +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Close + +## -description +Closes the session and removes the application's capability to run in the background. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_description.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_description.md index 8e8fd98fa7..c4011d4877 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_description.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Description --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Description ## -description Gets or sets a string to display in the shell. ## -property-value A string to display in the shell. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Description + +## -description +Gets or sets a string to display in the shell. + +## -property-value +A string to display in the shell. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_extendedexecutionsession_1221375020.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_extendedexecutionsession_1221375020.md index c664ec7214..bd8f4b7542 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_extendedexecutionsession_1221375020.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_extendedexecutionsession_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.ExtendedExecutionSession ## -description Creates an **ExtendedExecutionSession** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.ExtendedExecutionSession + +## -description +Creates an **ExtendedExecutionSession** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_percentprogress.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_percentprogress.md index c7bc6dd6de..19bdf840e1 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_percentprogress.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_percentprogress.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.PercentProgress --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.PercentProgress ## -description Gets or sets a value to show progress in the shell. ## -property-value A value to show progress in the shell. ## -remarks The default value is 0. The range of this value is 0–100. This should be populated to show the progress in the shell. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.PercentProgress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.PercentProgress + +## -description +Gets or sets a value to show progress in the shell. + +## -property-value +A value to show progress in the shell. + +## -remarks +The default value is 0. The range of this value is 0–100. This should be populated to show the progress in the shell. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_reason.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_reason.md index 13f84db5e8..a436bd6ccb 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_reason.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_reason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Reason --api-type: winrt property ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Reason ## -description Gets or sets the reason for the for the background execution request. ## -property-value The reason for the for the background execution request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Reason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Reason + +## -description +Gets or sets the reason for the for the background execution request. + +## -property-value +The reason for the for the background execution request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_requestextensionasync_935610333.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_requestextensionasync_935610333.md index a2d003fecd..14248a9d7f 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_requestextensionasync_935610333.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_requestextensionasync_935610333.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.RequestExtensionAsync --api-type: winrt method ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.RequestExtensionAsync ## -description Requests background execution. ## -returns The result of the request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.RequestExtensionAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.RequestExtensionAsync + +## -description +Requests background execution. + +## -returns +The result of the request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.extendedexecution/extendedexecutionsession_revoked.md b/windows.applicationmodel.extendedexecution/extendedexecutionsession_revoked.md index f0ce4fd284..841b6a7d0c 100644 --- a/windows.applicationmodel.extendedexecution/extendedexecutionsession_revoked.md +++ b/windows.applicationmodel.extendedexecution/extendedexecutionsession_revoked.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Revoked --api-type: winrt event ---- # Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Revoked ## -description The **Revoked** event occurs when the system revokes background execution. ## -remarks The sender (**object**) is **null ** for this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Revoked +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.ExtendedExecution.ExtendedExecutionSession.Revoked + +## -description +The **Revoked** event occurs when the system revokes background execution. + +## -remarks +The sender (**object**) is **null ** for this event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockapplicationhost.md b/windows.applicationmodel.lockscreen/lockapplicationhost.md index 8328b858f0..dc22e31160 100644 --- a/windows.applicationmodel.lockscreen/lockapplicationhost.md +++ b/windows.applicationmodel.lockscreen/lockapplicationhost.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.LockScreen.LockApplicationHost --api-type: winrt class ---- # Windows.ApplicationModel.LockScreen.LockApplicationHost ## -description Allows the lock screen app to request that the device unlocks, and allows the app to register to be notified when the device begins to unlock. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.LockScreen.LockApplicationHost +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.LockScreen.LockApplicationHost + +## -description +Allows the lock screen app to request that the device unlocks, and allows the app to register to be notified when the device begins to unlock. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockapplicationhost_getforcurrentview_1363600702.md b/windows.applicationmodel.lockscreen/lockapplicationhost_getforcurrentview_1363600702.md index 297febc4b6..c1c94cdfd8 100644 --- a/windows.applicationmodel.lockscreen/lockapplicationhost_getforcurrentview_1363600702.md +++ b/windows.applicationmodel.lockscreen/lockapplicationhost_getforcurrentview_1363600702.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.LockScreen.LockApplicationHost.GetForCurrentView --api-type: winrt method ---- # Windows.ApplicationModel.LockScreen.LockApplicationHost.GetForCurrentView ## -description Gets a [LockApplicationHost](lockapplicationhost.md) object. ## -returns A LockApplicationHost object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.LockScreen.LockApplicationHost.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.LockScreen.LockApplicationHost.GetForCurrentView + +## -description +Gets a [LockApplicationHost](lockapplicationhost.md) object. + +## -returns +A LockApplicationHost object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockapplicationhost_requestunlock_2057202052.md b/windows.applicationmodel.lockscreen/lockapplicationhost_requestunlock_2057202052.md index 0e775541d8..970eb27257 100644 --- a/windows.applicationmodel.lockscreen/lockapplicationhost_requestunlock_2057202052.md +++ b/windows.applicationmodel.lockscreen/lockapplicationhost_requestunlock_2057202052.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.LockScreen.LockApplicationHost.RequestUnlock --api-type: winrt method ---- # Windows.ApplicationModel.LockScreen.LockApplicationHost.RequestUnlock ## -description Requests that the device unlocks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.LockScreen.LockApplicationHost.RequestUnlock +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.LockScreen.LockApplicationHost.RequestUnlock + +## -description +Requests that the device unlocks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockapplicationhost_unlocking.md b/windows.applicationmodel.lockscreen/lockapplicationhost_unlocking.md index 38d725df89..3ff56611fc 100644 --- a/windows.applicationmodel.lockscreen/lockapplicationhost_unlocking.md +++ b/windows.applicationmodel.lockscreen/lockapplicationhost_unlocking.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.LockScreen.LockApplicationHost.Unlocking --api-type: winrt event ---- # Windows.ApplicationModel.LockScreen.LockApplicationHost.Unlocking ## -description Indicates the device is unlocking. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.LockScreen.LockApplicationHost.Unlocking +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.LockScreen.LockApplicationHost.Unlocking + +## -description +Indicates the device is unlocking. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenbadge.md b/windows.applicationmodel.lockscreen/lockscreenbadge.md index 389a9cb578..e9d91dc472 100644 --- a/windows.applicationmodel.lockscreen/lockscreenbadge.md +++ b/windows.applicationmodel.lockscreen/lockscreenbadge.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.LockScreen.LockScreenBadge --api-type: winrt class ---- # Windows.ApplicationModel.LockScreen.LockScreenBadge ## -description Represents a lock screen badge for an app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.LockScreen.LockScreenBadge +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenBadge + +## -description +Represents a lock screen badge for an app. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenbadge_automationname.md b/windows.applicationmodel.lockscreen/lockscreenbadge_automationname.md index 094afebc56..36e1fa6dfa 100644 --- a/windows.applicationmodel.lockscreen/lockscreenbadge_automationname.md +++ b/windows.applicationmodel.lockscreen/lockscreenbadge_automationname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.AutomationName --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenBadge.AutomationName ## -description Gets the name. ## -property-value The name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.AutomationName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenBadge.AutomationName + +## -description +Gets the name. + +## -property-value +The name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenbadge_glyph.md b/windows.applicationmodel.lockscreen/lockscreenbadge_glyph.md index 0cc8654f8d..12445b9dc3 100644 --- a/windows.applicationmodel.lockscreen/lockscreenbadge_glyph.md +++ b/windows.applicationmodel.lockscreen/lockscreenbadge_glyph.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.Glyph --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenBadge.Glyph ## -description Gets the glyph to display. ## -property-value The glyph. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.Glyph +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenBadge.Glyph + +## -description +Gets the glyph to display. + +## -property-value +The glyph. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenbadge_launchapp_1880082156.md b/windows.applicationmodel.lockscreen/lockscreenbadge_launchapp_1880082156.md index 38178f2075..92e5961a48 100644 --- a/windows.applicationmodel.lockscreen/lockscreenbadge_launchapp_1880082156.md +++ b/windows.applicationmodel.lockscreen/lockscreenbadge_launchapp_1880082156.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.LockScreen.LockScreenBadge.LaunchApp --api-type: winrt method ---- # Windows.ApplicationModel.LockScreen.LockScreenBadge.LaunchApp ## -description Launches the app corresponding to the badge. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.LockScreen.LockScreenBadge.LaunchApp +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenBadge.LaunchApp + +## -description +Launches the app corresponding to the badge. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenbadge_logo.md b/windows.applicationmodel.lockscreen/lockscreenbadge_logo.md index 209eef0049..df41fa95b6 100644 --- a/windows.applicationmodel.lockscreen/lockscreenbadge_logo.md +++ b/windows.applicationmodel.lockscreen/lockscreenbadge_logo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.Logo --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenBadge.Logo ## -description Gets the logo to display with the badge. ## -property-value The logo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.Logo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenBadge.Logo + +## -description +Gets the logo to display with the badge. + +## -property-value +The logo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenbadge_number.md b/windows.applicationmodel.lockscreen/lockscreenbadge_number.md index fea5b6681d..3c12fe7f15 100644 --- a/windows.applicationmodel.lockscreen/lockscreenbadge_number.md +++ b/windows.applicationmodel.lockscreen/lockscreenbadge_number.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.Number --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenBadge.Number ## -description Gets the number to display with the badge. ## -property-value The number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenBadge.Number +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenBadge.Number + +## -description +Gets the number to display with the badge. + +## -property-value +The number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo.md b/windows.applicationmodel.lockscreen/lockscreeninfo.md index 26689a8507..2e970b0d4a 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.LockScreen.LockScreenInfo --api-type: winrt class ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo ## -description Provides access to the same data that the default lock screen has access to, such as wallpaper, badges, and so on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.LockScreen.LockScreenInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo + +## -description +Provides access to the same data that the default lock screen has access to, such as wallpaper, badges, and so on. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_alarmicon.md b/windows.applicationmodel.lockscreen/lockscreeninfo_alarmicon.md index 73abc82e12..6db2d4839d 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_alarmicon.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_alarmicon.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIcon --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIcon ## -description Gets the alarm icon to display. ## -property-value The alarm icon. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIcon +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIcon + +## -description +Gets the alarm icon to display. + +## -property-value +The alarm icon. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_alarmiconchanged.md b/windows.applicationmodel.lockscreen/lockscreeninfo_alarmiconchanged.md index 871d0c2e84..479cf27918 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_alarmiconchanged.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_alarmiconchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIconChanged --api-type: winrt event ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIconChanged ## -description Indicates the alarm icon has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIconChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.AlarmIconChanged + +## -description +Indicates the alarm icon has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_badges.md b/windows.applicationmodel.lockscreen/lockscreeninfo_badges.md index 121237623f..8f0dbdb4a0 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_badges.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_badges.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.Badges --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.Badges ## -description Gets the badges to display. ## -property-value The badges. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.Badges +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.Badges + +## -description +Gets the badges to display. + +## -property-value +The badges. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_badgeschanged.md b/windows.applicationmodel.lockscreen/lockscreeninfo_badgeschanged.md index 645b5874b9..9839f6fd34 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_badgeschanged.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_badgeschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.BadgesChanged --api-type: winrt event ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.BadgesChanged ## -description Indicates the badges have changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.BadgesChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.BadgesChanged + +## -description +Indicates the badges have changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_detailtext.md b/windows.applicationmodel.lockscreen/lockscreeninfo_detailtext.md index 4db492c9ec..2a539e94c6 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_detailtext.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_detailtext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailText --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailText ## -description Gets the detail text to display. ## -property-value The text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailText + +## -description +Gets the detail text to display. + +## -property-value +The text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_detailtextchanged.md b/windows.applicationmodel.lockscreen/lockscreeninfo_detailtextchanged.md index a6dc9abb57..69200c8973 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_detailtextchanged.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_detailtextchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailTextChanged --api-type: winrt event ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailTextChanged ## -description Indicates the detail text has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailTextChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.DetailTextChanged + +## -description +Indicates the detail text has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimage.md b/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimage.md index e8d2b3f0de..f4ebdb880e 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimage.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImage --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImage ## -description Gets the image to display on the lock screen. ## -property-value The image to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImage + +## -description +Gets the image to display on the lock screen. + +## -property-value +The image to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimagechanged.md b/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimagechanged.md index fe82b0822e..7081c7bbca 100644 --- a/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimagechanged.md +++ b/windows.applicationmodel.lockscreen/lockscreeninfo_lockscreenimagechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImageChanged --api-type: winrt event ---- # Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImageChanged ## -description Indicates the lock screen image has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImageChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenInfo.LockScreenImageChanged + +## -description +Indicates the lock screen image has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral.md b/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral.md index d7611a2d47..9830fcc540 100644 --- a/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral.md +++ b/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral --api-type: winrt class ---- # Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral ## -description Represents an unlock deferral. To show an unlock animation, your lock screen app must: + Register to be notified of unlocking via the [Unlocking](lockapplicationhost_unlocking.md) event. + In the Unlocking event handler, call [GetDeferral](lockscreenunlockingeventargs_getdeferral.md). + Kick off an animation.+ When that animation completes, call [Complete](lockscreenunlockingdeferral_complete.md) on the deferral to end the deferral. + Note: If the animation takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral + +## -description +Represents an unlock deferral. +To show an unlock animation, your lock screen app must: + ++ Register to be notified of unlocking via the [Unlocking](lockapplicationhost_unlocking.md) event. ++ In the Unlocking event handler, call [GetDeferral](lockscreenunlockingeventargs_getdeferral.md). ++ Kick off an animation.+ When that animation completes, call [Complete](lockscreenunlockingdeferral_complete.md) on the deferral to end the deferral. ++ Note: If the animation takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. + + + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral_complete_1807836922.md b/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral_complete_1807836922.md index 365fccadf8..e2204467aa 100644 --- a/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral_complete_1807836922.md +++ b/windows.applicationmodel.lockscreen/lockscreenunlockingdeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral.Complete ## -description Notifies the system that your deferral is complete. If your deferral takes too long to complete, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenUnlockingDeferral.Complete + +## -description +Notifies the system that your deferral is complete. If your deferral takes too long to complete, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs.md b/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs.md index adc1b54cf1..70914e07e0 100644 --- a/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs.md +++ b/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs ## -description Represents the lock screen unlocking events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs + +## -description +Represents the lock screen unlocking events. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_deadline.md b/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_deadline.md index 3a2fbacedb..f6028d727d 100644 --- a/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_deadline.md +++ b/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.Deadline --api-type: winrt property ---- # Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.Deadline ## -description Gets the deadline by which the lock screen app must unlock the device. If your unlocking deferral takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. ## -property-value The deadline by which your app must unlock the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.Deadline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.Deadline + +## -description +Gets the deadline by which the lock screen app must unlock the device. If your unlocking deferral takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. + +## -property-value +The deadline by which your app must unlock the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_getdeferral_254836512.md b/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_getdeferral_254836512.md index 5a1c388e79..f6adfec4b3 100644 --- a/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.lockscreen/lockscreenunlockingeventargs_getdeferral_254836512.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.GetDeferral ## -description Gets a [LockScreenUnlockingDeferral](lockscreenunlockingdeferral.md), which defers the unlocking of the device. To show an unlock animation, your lock screen app must: + Register to be notified of unlocking via the [Unlocking](lockapplicationhost_unlocking.md) event. + In the Unlocking event handler, call [GetDeferral](lockscreenunlockingeventargs_getdeferral.md). + Kick off an animation. + When that animation completes, call [Complete](lockscreenunlockingdeferral_complete.md) on the deferral to end the deferral. + Note: If the animation takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. ## -returns An unlock deferral. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.LockScreen.LockScreenUnlockingEventArgs.GetDeferral + +## -description +Gets a [LockScreenUnlockingDeferral](lockscreenunlockingdeferral.md), which defers the unlocking of the device. +To show an unlock animation, your lock screen app must: + ++ Register to be notified of unlocking via the [Unlocking](lockapplicationhost_unlocking.md) event. ++ In the Unlocking event handler, call [GetDeferral](lockscreenunlockingeventargs_getdeferral.md). ++ Kick off an animation. + When that animation completes, call [Complete](lockscreenunlockingdeferral_complete.md) on the deferral to end the deferral. + + Note: If the animation takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app. + + + +## -returns +An unlock deferral. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs.md b/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs.md index 694f10fc1f..cbb4de5ddf 100644 --- a/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs.md +++ b/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs ## -description Represents information about the [NotePlacementChanged](noteswindowmanagerpreview_noteplacementchanged.md) event. ## -remarks This class is instantiated automatically when the [NotePlacementChanged](noteswindowmanagerpreview_noteplacementchanged.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs + +## -description +Represents information about the [NotePlacementChanged](noteswindowmanagerpreview_noteplacementchanged.md) event. + +## -remarks +This class is instantiated automatically when the [NotePlacementChanged](noteswindowmanagerpreview_noteplacementchanged.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs_viewid.md b/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs_viewid.md index 8789387c93..cf2952aefa 100644 --- a/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs_viewid.md +++ b/windows.applicationmodel.preview.notes/noteplacementchangedprevieweventargs_viewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs.ViewId --api-type: winrt property ---- # Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs.ViewId ## -description The unique identifier of the note for which the [NotePlacementChanged](noteswindowmanagerpreview_noteplacementchanged.md) event was raised. ## -property-value The note Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs.ViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotePlacementChangedPreviewEventArgs.ViewId + +## -description +The unique identifier of the note for which the [NotePlacementChanged](noteswindowmanagerpreview_noteplacementchanged.md) event was raised. + +## -property-value +The note Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview.md index ba1cb39249..694dfd9820 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview --api-type: winrt class ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview ## -description This class owns much of the functionality of the **Preview Notes** application feature (see Remarks). ## -remarks The **Preview Notes** feature allows a Universal Windows app to utilize the **Windows Ink Workspace** in order to provide a tailored note-taking experience on desktop devices. Apps that are recognized as such will operate with a number of behavioral changes meant to make the note-taking process faster and more convenient. For example, note-taking apps will open without a splash screen, will appear in the "Sticky Notes" section of the **Windows Ink Workspace**, will have their own configurable view-switching mechanism, and can display notes on a locked screen. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview + +## -description +This class owns much of the functionality of the **Preview Notes** application feature (see Remarks). + +## -remarks +The **Preview Notes** feature allows a Universal Windows app to utilize the **Windows Ink Workspace** in order to provide a tailored note-taking experience on desktop devices. Apps that are recognized as such will operate with a number of behavioral changes meant to make the note-taking process faster and more convenient. For example, note-taking apps will open without a splash screen, will appear in the "Sticky Notes" section of the **Windows Ink Workspace**, will have their own configurable view-switching mechanism, and can display notes on a locked screen. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_getnoteplacement_639894587.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_getnoteplacement_639894587.md index fb397f977c..fb6660e135 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_getnoteplacement_639894587.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_getnoteplacement_639894587.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.GetNotePlacement(System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.GetNotePlacement ## -description Gets the view placement of a given note, to be stored in program memory or on disk storage and then restored by the application at a later time. ## -parameters ### -param noteViewId The unique identifier of the note whose placement is to be retrieved. ## -returns An array of bytes holding note placement data. ## -remarks [GetNotePlacement](noteswindowmanagerpreview_getnoteplacement.md) and [ShowNoteWithPlacement](noteswindowmanagerpreview_shownotewithplacement.md) can be used together to store the placement of a note (say, while the application is exiting) and then restore the note to its previous placement on the screen (when the application is opened again). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.GetNotePlacement(System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.GetNotePlacement + +## -description +Gets the view placement of a given note, to be stored in program memory or on disk storage and then restored by the application at a later time. + +## -parameters +### -param noteViewId +The unique identifier of the note whose placement is to be retrieved. + +## -returns +An array of bytes holding note placement data. + +## -remarks +[GetNotePlacement](noteswindowmanagerpreview_getnoteplacement.md) and [ShowNoteWithPlacement](noteswindowmanagerpreview_shownotewithplacement.md) can be used together to store the placement of a note (say, while the application is exiting) and then restore the note to its previous placement on the screen (when the application is opened again). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_hidenote_1106719948.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_hidenote_1106719948.md index c6c39b1b7f..a6a00765f5 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_hidenote_1106719948.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_hidenote_1106719948.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.HideNote(System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.HideNote ## -description Sets a note's view to invisible and moves the focus to the next visible note view (window) or to the Windows Ink Workspace (see Remarks). The views are selected in a cyclic, system-determined order. > [!NOTE] > Even though the note disappears from the screen, its [CoreWindow](../windows.ui.core/corewindow.md) object remains until the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event is raised and the handling method closes the note's with the [Close](../windows.ui.core/corewindow_close.md) method. ## -parameters ### -param noteViewId The unique identifier of the note to be hidden. ## -remarks When the notes app is loaded from the Windows Ink Workspace, this method will switch focus to the Windows Ink Workspace if it is next in the order. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.HideNote(System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.HideNote + +## -description +Sets a note's view to invisible and moves the focus to the next visible note view (window) or to the Windows Ink Workspace (see Remarks). The views are selected in a cyclic, system-determined order. + +> [!NOTE] +> Even though the note disappears from the screen, its [CoreWindow](../windows.ui.core/corewindow.md) object remains until the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event is raised and the handling method closes the note's with the [Close](../windows.ui.core/corewindow_close.md) method. + +## -parameters +### -param noteViewId +The unique identifier of the note to be hidden. + +## -remarks +When the notes app is loaded from the Windows Ink Workspace, this method will switch focus to the Windows Ink Workspace if it is next in the order. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_isscreenlocked.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_isscreenlocked.md index a9a4c94343..8c7f95c7c1 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_isscreenlocked.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_isscreenlocked.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.IsScreenLocked --api-type: winrt property ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.IsScreenLocked ## -description Gets a value indicating whether the device's screen is currently locked. ## -property-value **true** if screen is locked, **false** if unlocked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.IsScreenLocked +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.IsScreenLocked + +## -description +Gets a value indicating whether the device's screen is currently locked. + +## -property-value +**true** if screen is locked, **false** if unlocked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_noteplacementchanged.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_noteplacementchanged.md index 5b39fd2139..1eb74aa6d4 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_noteplacementchanged.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_noteplacementchanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NotePlacementChanged --api-type: winrt event ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NotePlacementChanged ## -description Indicates that a note's placement (dimensions and location) has changed. > [!NOTE] > When this event is raised, the application should call [GetNotePlacement](noteswindowmanagerpreview_getnoteplacement.md) to update its record with the note's new placement. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NotePlacementChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NotePlacementChanged + +## -description +Indicates that a note's placement (dimensions and location) has changed. + +> [!NOTE] +> When this event is raised, the application should call [GetNotePlacement](noteswindowmanagerpreview_getnoteplacement.md) to update its record with the note's new placement. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_notevisibilitychanged.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_notevisibilitychanged.md index 32a7e6ff7a..f8ff1dce11 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_notevisibilitychanged.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_notevisibilitychanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NoteVisibilityChanged --api-type: winrt event ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NoteVisibilityChanged ## -description Indicates that a note's visibility state has changed. > [!NOTE] > When this event is raised, its handler must determine whether the given view was hidden or shown (according to the [isVisible](notevisibilitychangedprevieweventargs_isvisible.md) property in [NoteVisibilityChangedPreviewEventArgs](notevisibilitychangedprevieweventargs.md) class). If hidden, the note's [CoreWindow](../windows.ui.core/corewindow.md) object must be closed (with the [Close](../windows.ui.core/corewindow_close.md) method) within the event handler. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NoteVisibilityChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.NoteVisibilityChanged + +## -description +Indicates that a note's visibility state has changed. + +> [!NOTE] +> When this event is raised, its handler must determine whether the given view was hidden or shown (according to the [isVisible](notevisibilitychangedprevieweventargs_isvisible.md) property in [NoteVisibilityChangedPreviewEventArgs](notevisibilitychangedprevieweventargs.md) class). If hidden, the note's [CoreWindow](../windows.ui.core/corewindow.md) object must be closed (with the [Close](../windows.ui.core/corewindow_close.md) method) within the event handler. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustonextview_437152119.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustonextview_437152119.md index c858d1ec75..f7c35d8051 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustonextview_437152119.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustonextview_437152119.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetFocusToNextView --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetFocusToNextView ## -description Switches focus to the next visible note view (window) or to the Windows Ink Workspace (see Remarks). The views are selected in a cyclic, system-determined order. ## -remarks When the notes app is loaded from the Windows Ink Workspace, this method also switches focus to the Windows Ink Workspace and then back to views within the notes app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetFocusToNextView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetFocusToNextView + +## -description +Switches focus to the next visible note view (window) or to the Windows Ink Workspace (see Remarks). The views are selected in a cyclic, system-determined order. + +## -remarks +When the notes app is loaded from the Windows Ink Workspace, this method also switches focus to the Windows Ink Workspace and then back to views within the notes app. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setnotesthumbnailasync_281830069.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setnotesthumbnailasync_281830069.md index 3c64dd9c92..9b264e4388 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setnotesthumbnailasync_281830069.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setnotesthumbnailasync_281830069.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetNotesThumbnailAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetNotesThumbnailAsync ## -description Sets the thumbnail image for this application as it appears in the Windows Ink Workspace, in the Alt+TAB task switcher, or on hovering in the taskbar. ## -parameters ### -param thumbnail A byte array describing the thumbnail image and usage (see Remarks). ## -returns This method does not return a value. ## -remarks The *thumbnail* byte array must adhere to the following format in order to describe a thumbnail image: Bytes 0-3: thumbnail type – a string value of either "NTPW" (for Ink Workspace appearance) or "NTTS" (for Alt+TAB switching and taskbar hover). Bytes 4-7: Image width in pixels – an integer value. Bytes 8-11: Image height in pixels – an integer value. The final section must contain 4 * **image width** * **image height** number of bytes. Every 4-byte integer of this section corresponds to the BGRA color data of one pixel. > [!NOTE] > If the size of the image used (in pixels) exceeds the size of the primary monitor, an InvalidArgumentException will be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetNotesThumbnailAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetNotesThumbnailAsync + +## -description +Sets the thumbnail image for this application as it appears in the Windows Ink Workspace, in the Alt+TAB task switcher, or on hovering in the taskbar. + +## -parameters +### -param thumbnail +A byte array describing the thumbnail image and usage (see Remarks). + +## -returns +This method does not return a value. + +## -remarks +The *thumbnail* byte array must adhere to the following format in order to describe a thumbnail image: Bytes 0-3: thumbnail type – a string value of either "NTPW" (for Ink Workspace appearance) or "NTTS" (for Alt+TAB switching and taskbar hover). + +Bytes 4-7: Image width in pixels – an integer value. + +Bytes 8-11: Image height in pixels – an integer value. + +The final section must contain 4 * **image width** * **image height** number of bytes. Every 4-byte integer of this section corresponds to the BGRA color data of one pixel. + +> [!NOTE] +> If the size of the image used (in pixels) exceeds the size of the primary monitor, an InvalidArgumentException will be thrown. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownote_754003822.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownote_754003822.md index 8fff3d080a..dd424705dd 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownote_754003822.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownote_754003822.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNote(System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNote ## -description Makes a note visible on the device screen. > [!NOTE] > This method should only be called on a note that has been hidden with [HideNote](noteswindowmanagerpreview_hidenote.md). ## -parameters ### -param noteViewId The unique identifier of the note to be shown. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNote(System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNote + +## -description +Makes a note visible on the device screen. + +> [!NOTE] +> This method should only be called on a note that has been hidden with [HideNote](noteswindowmanagerpreview_hidenote.md). + +## -parameters +### -param noteViewId +The unique identifier of the note to be shown. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_552825174.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_552825174.md index be343377e5..02e1c1b514 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_552825174.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_552825174.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteRelativeTo(System.Int32,System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteRelativeTo ## -description Makes a note visible and places it adjacent to a specified "anchor" view. ## -parameters ### -param noteViewId The unique identifier of the note to be shown. ### -param anchorNoteViewId The Id of the "anchor" view. If this value is 0 (not assigned to any view), the note will appear at the center of the screen. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteRelativeTo(System.Int32,System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteRelativeTo + +## -description +Makes a note visible and places it adjacent to a specified "anchor" view. + +## -parameters +### -param noteViewId +The unique identifier of the note to be shown. + +### -param anchorNoteViewId +The Id of the "anchor" view. If this value is 0 (not assigned to any view), the note will appear at the center of the screen. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_771187235.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_771187235.md index 5bd5112396..edd3e60b6a 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_771187235.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_771187235.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteWithPlacement(System.Int32,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteWithPlacement ## -description Makes a note visible and sets its placement data (dimensions and location) as specified. ## -parameters ### -param noteViewId The unique identifier of the note to be shown. ### -param data An array of bytes holding note placement data. ## -remarks [GetNotePlacement](noteswindowmanagerpreview_getnoteplacement.md) and [ShowNoteWithPlacement](noteswindowmanagerpreview_shownotewithplacement.md) can be used together to store the placement of a note (say, while the application is exiting) and then restore the note to its previous placement on the screen (when the application is opened again). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteWithPlacement(System.Int32,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteWithPlacement + +## -description +Makes a note visible and sets its placement data (dimensions and location) as specified. + +## -parameters +### -param noteViewId +The unique identifier of the note to be shown. + +### -param data +An array of bytes holding note placement data. + +## -remarks +[GetNotePlacement](noteswindowmanagerpreview_getnoteplacement.md) and [ShowNoteWithPlacement](noteswindowmanagerpreview_shownotewithplacement.md) can be used together to store the placement of a note (say, while the application is exiting) and then restore the note to its previous placement on the screen (when the application is opened again). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_systemlockstatechanged.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_systemlockstatechanged.md index 6698942f2d..20eefcbc7e 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_systemlockstatechanged.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_systemlockstatechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SystemLockStateChanged --api-type: winrt event ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SystemLockStateChanged ## -description Indicates that the device's screen lock state has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SystemLockStateChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SystemLockStateChanged + +## -description +Indicates that the device's screen lock state has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_trysetnotesize_190063679.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_trysetnotesize_190063679.md index 46aafe26ce..fa23381c9b 100644 --- a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_trysetnotesize_190063679.md +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_trysetnotesize_190063679.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.TrySetNoteSize(System.Int32,Windows.Foundation.Size) --api-type: winrt method ---- # Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.TrySetNoteSize ## -description Resizes the specified note to the desired dimensions. If the given size is not recommended due to screen size/space issues, the note's size will not be changed. ## -parameters ### -param noteViewId The unique identifier of the note to be resized. ### -param size The desired dimensions of the note (use raw pixels when constructing). ## -returns **true** if the note was resized, **false** if it was not resized due to screen restrictions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.TrySetNoteSize(System.Int32,Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.TrySetNoteSize + +## -description +Resizes the specified note to the desired dimensions. If the given size is not recommended due to screen size/space issues, the note's size will not be changed. + +## -parameters +### -param noteViewId +The unique identifier of the note to be resized. + +### -param size +The desired dimensions of the note (use raw pixels when constructing). + +## -returns +**true** if the note was resized, **false** if it was not resized due to screen restrictions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs.md b/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs.md index 0fef38c2bd..5cc5225e0c 100644 --- a/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs.md +++ b/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs ## -description Represents information about the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event. ## -remarks This class is instantiated automatically when the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs + +## -description +Represents information about the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event. + +## -remarks +This class is instantiated automatically when the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_isvisible.md b/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_isvisible.md index 461bccdded..cd20b9adbc 100644 --- a/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_isvisible.md +++ b/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_isvisible.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.IsVisible --api-type: winrt property ---- # Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.IsVisible ## -description Indicates whether the note (specified by [ViewId](notevisibilitychangedprevieweventargs_viewid.md) property) is visible on the device screen. ## -property-value **true** if note is visible, **false** if note is hidden. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.IsVisible +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.IsVisible + +## -description +Indicates whether the note (specified by [ViewId](notevisibilitychangedprevieweventargs_viewid.md) property) is visible on the device screen. + +## -property-value +**true** if note is visible, **false** if note is hidden. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_viewid.md b/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_viewid.md index 72efa572f4..0472ba3b83 100644 --- a/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_viewid.md +++ b/windows.applicationmodel.preview.notes/notevisibilitychangedprevieweventargs_viewid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.ViewId --api-type: winrt property ---- # Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.ViewId ## -description The unique identifier of the note for which the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event was raised. ## -property-value The note Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.ViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Preview.Notes.NoteVisibilityChangedPreviewEventArgs.ViewId + +## -description +The unique identifier of the note for which the [NoteVisibilityChanged](noteswindowmanagerpreview_notevisibilitychanged.md) event was raised. + +## -property-value +The note Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/namedresource_candidates.md b/windows.applicationmodel.resources.core/namedresource_candidates.md index 45ff077eba..b49e62f691 100644 --- a/windows.applicationmodel.resources.core/namedresource_candidates.md +++ b/windows.applicationmodel.resources.core/namedresource_candidates.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.NamedResource.Candidates --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.NamedResource.Candidates ## -description Gets all possible candidate values for this named resource. ## -property-value A set of [ResourceCandidate](resourcecandidate.md) objects, each of which describes one possible value for this named resource and the qualifiers under which it applies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.NamedResource.Candidates +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.NamedResource.Candidates + +## -description +Gets all possible candidate values for this named resource. + +## -property-value +A set of [ResourceCandidate](resourcecandidate.md) objects, each of which describes one possible value for this named resource and the qualifiers under which it applies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/namedresource_resolve_302177783.md b/windows.applicationmodel.resources.core/namedresource_resolve_302177783.md index 440a68cd73..21adebcbe3 100644 --- a/windows.applicationmodel.resources.core/namedresource_resolve_302177783.md +++ b/windows.applicationmodel.resources.core/namedresource_resolve_302177783.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.Resolve(Windows.ApplicationModel.Resources.Core.ResourceContext) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.NamedResource.Resolve ## -description Resolves this [NamedResource](namedresource.md) object against a supplied context and returns the most appropriate candidate. ## -parameters ### -param resourceContext The context against which the [NamedResource](namedresource.md) should be resolved. ## -returns The most appropriate candidate for the specified context. ## -remarks The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. Since the [Resolve](namedresource_resolve_302177783.md) method selects the best candidate for a [NamedResource](namedresource.md) in relation to a runtime context, and since the scale qualifier of a [ResourceContext](resourcecontext.md) depends on the associated view, the [Resolve](namedresource_resolve_302177783.md) should always be called passing a [ResourceContext](resourcecontext.md) object obtained from the view in which the resource will be used. See the [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) method. ## -examples ## -see-also [ResourceContext](resourcecontext.md), [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.Resolve(Windows.ApplicationModel.Resources.Core.ResourceContext) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.NamedResource.Resolve + +## -description +Resolves this [NamedResource](namedresource.md) object against a supplied context and returns the most appropriate candidate. + +## -parameters +### -param resourceContext +The context against which the [NamedResource](namedresource.md) should be resolved. + +## -returns +The most appropriate candidate for the specified context. + +## -remarks +The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. + +Since the [Resolve](namedresource_resolve_302177783.md) method selects the best candidate for a [NamedResource](namedresource.md) in relation to a runtime context, and since the scale qualifier of a [ResourceContext](resourcecontext.md) depends on the associated view, the [Resolve](namedresource_resolve_302177783.md) should always be called passing a [ResourceContext](resourcecontext.md) object obtained from the view in which the resource will be used. + +See the [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) method. + +## -examples + +## -see-also +[ResourceContext](resourcecontext.md), [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/namedresource_resolve_564673650.md b/windows.applicationmodel.resources.core/namedresource_resolve_564673650.md index b1656cefc5..5c944340f3 100644 --- a/windows.applicationmodel.resources.core/namedresource_resolve_564673650.md +++ b/windows.applicationmodel.resources.core/namedresource_resolve_564673650.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.Resolve --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.NamedResource.Resolve ## -description > [!NOTE] > Resolve may be altered or unavailable for releases after Windows 8.1. Instead, use [Resolve(ResourceContext)](namedresource_resolve_302177783.md). Resolves this [NamedResource](namedresource.md) object against the default context and returns the most appropriate candidate. ## -returns The most appropriate candidate for the default context. ## -remarks ## -examples ## -see-also [Resolve(ResourceContext)](namedresource_resolve_302177783.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.Resolve +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.NamedResource.Resolve + +## -description +> [!NOTE] +> Resolve may be altered or unavailable for releases after Windows 8.1. Instead, use [Resolve(ResourceContext)](namedresource_resolve_302177783.md). + +Resolves this [NamedResource](namedresource.md) object against the default context and returns the most appropriate candidate. + +## -returns +The most appropriate candidate for the default context. + +## -remarks + +## -examples + +## -see-also +[Resolve(ResourceContext)](namedresource_resolve_302177783.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/namedresource_resolveall_1183893306.md b/windows.applicationmodel.resources.core/namedresource_resolveall_1183893306.md index 6fa0f34efd..fa38ce2cf9 100644 --- a/windows.applicationmodel.resources.core/namedresource_resolveall_1183893306.md +++ b/windows.applicationmodel.resources.core/namedresource_resolveall_1183893306.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll(Windows.ApplicationModel.Resources.Core.ResourceContext) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll ## -description Resolves this [NamedResource](namedresource.md) object against a supplied context and returns a list of all possible candidates in preference order. ## -parameters ### -param resourceContext The context against which the [NamedResource](namedresource.md) should be resolved. ## -returns A list of [ResourceCandidate](resourcecandidate.md) objects, in order of preference. The object in first position in the list is the most appropriate candidate for the corresponding context, and the object in last position is the least appropriate. ## -remarks The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. Since the [ResolveAll](namedresource_resolveall_1183893306.md) method returns all candidates for a [NamedResource](namedresource.md) in relation to a runtime context, and since the scale qualifier of a [ResourceContext](resourcecontext.md) depends on the associated view, the [ResolveAll](namedresource_resolveall_1183893306.md) should always be called passing a [ResourceContext](resourcecontext.md) object obtained from the view in which the resource will be used. See the [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) method. ## -examples ## -see-also [ResourceContext](resourcecontext.md), [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll(Windows.ApplicationModel.Resources.Core.ResourceContext) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll + +## -description +Resolves this [NamedResource](namedresource.md) object against a supplied context and returns a list of all possible candidates in preference order. + +## -parameters +### -param resourceContext +The context against which the [NamedResource](namedresource.md) should be resolved. + +## -returns +A list of [ResourceCandidate](resourcecandidate.md) objects, in order of preference. The object in first position in the list is the most appropriate candidate for the corresponding context, and the object in last position is the least appropriate. + +## -remarks +The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. + +Since the [ResolveAll](namedresource_resolveall_1183893306.md) method returns all candidates for a [NamedResource](namedresource.md) in relation to a runtime context, and since the scale qualifier of a [ResourceContext](resourcecontext.md) depends on the associated view, the [ResolveAll](namedresource_resolveall_1183893306.md) should always be called passing a [ResourceContext](resourcecontext.md) object obtained from the view in which the resource will be used. + +See the [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) method. + +## -examples + +## -see-also +[ResourceContext](resourcecontext.md), [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/namedresource_resolveall_1966745277.md b/windows.applicationmodel.resources.core/namedresource_resolveall_1966745277.md index 958b781c0e..1e792e5c2a 100644 --- a/windows.applicationmodel.resources.core/namedresource_resolveall_1966745277.md +++ b/windows.applicationmodel.resources.core/namedresource_resolveall_1966745277.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll ## -description > [!NOTE] > ResolveAll may be altered or unavailable for releases after Windows 8.1. Instead, use [ResolveAll(ResourceContext)](namedresource_resolveall_1183893306.md). Resolves this [NamedResource](namedresource.md) object against the default context and returns a list of all possible candidates in preference order. ## -returns A list of [ResourceCandidate](resourcecandidate.md) objects, in order of preference. The object in first position in the list is the most appropriate candidate for the corresponding context, and the object in last position is the least appropriate. ## -remarks ## -examples ## -see-also [ResolveAll(ResourceContext)](namedresource_resolveall_1183893306.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.NamedResource.ResolveAll + +## -description +> [!NOTE] +> ResolveAll may be altered or unavailable for releases after Windows 8.1. Instead, use [ResolveAll(ResourceContext)](namedresource_resolveall_1183893306.md). + +Resolves this [NamedResource](namedresource.md) object against the default context and returns a list of all possible candidates in preference order. + +## -returns +A list of [ResourceCandidate](resourcecandidate.md) objects, in order of preference. The object in first position in the list is the most appropriate candidate for the corresponding context, and the object in last position is the least appropriate. + +## -remarks + +## -examples + +## -see-also +[ResolveAll(ResourceContext)](namedresource_resolveall_1183893306.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/namedresource_uri.md b/windows.applicationmodel.resources.core/namedresource_uri.md index 74b460f864..0e7b61ef0e 100644 --- a/windows.applicationmodel.resources.core/namedresource_uri.md +++ b/windows.applicationmodel.resources.core/namedresource_uri.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.NamedResource.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.NamedResource.Uri ## -description Gets a URI that can be used to refer to this named resource. ## -property-value A URI that can be used to refer to this named resource. See [URI schemes](http://msdn.microsoft.com/library/f3b3ae74-aaea-4f00-8f0a-4c231b8745af) for information on identifying resources. ## -remarks ## -examples ## -see-also [URI schemes](http://msdn.microsoft.com/library/f3b3ae74-aaea-4f00-8f0a-4c231b8745af) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.NamedResource.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.NamedResource.Uri + +## -description +Gets a URI that can be used to refer to this named resource. + +## -property-value +A URI that can be used to refer to this named resource. See [URI schemes](http://msdn.microsoft.com/library/f3b3ae74-aaea-4f00-8f0a-4c231b8745af) for information on identifying resources. + +## -remarks + +## -examples + +## -see-also +[URI schemes](http://msdn.microsoft.com/library/f3b3ae74-aaea-4f00-8f0a-4c231b8745af) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecandidate_getqualifiervalue_1263542058.md b/windows.applicationmodel.resources.core/resourcecandidate_getqualifiervalue_1263542058.md index ce2be26444..a2a6aaa1c2 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_getqualifiervalue_1263542058.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_getqualifiervalue_1263542058.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetQualifierValue(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetQualifierValue ## -description Returns the value of a qualifier, given its name. ## -parameters ### -param qualifierName The name of the qualifier. ## -returns The value of the qualifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetQualifierValue(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetQualifierValue + +## -description +Returns the value of a qualifier, given its name. + +## -parameters +### -param qualifierName +The name of the qualifier. + +## -returns +The value of the qualifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidate_getvalueasfileasync_905212143.md b/windows.applicationmodel.resources.core/resourcecandidate_getvalueasfileasync_905212143.md index 4a6582993e..f4ce401450 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_getvalueasfileasync_905212143.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_getvalueasfileasync_905212143.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsFileAsync --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsFileAsync ## -description Asynchronously returns a [StorageFile](../windows.storage/storagefile.md) that accesses the value of this [ResourceCandidate](resourcecandidate.md). This only works on certain types of [ResourceCandidate](resourcecandidate.md) s that are files. ## -returns An asynchronous operation to return the requested [StorageFile](../windows.storage/storagefile.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsFileAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsFileAsync + +## -description +Asynchronously returns a [StorageFile](../windows.storage/storagefile.md) that accesses the value of this [ResourceCandidate](resourcecandidate.md). This only works on certain types of [ResourceCandidate](resourcecandidate.md) s that are files. + +## -returns +An asynchronous operation to return the requested [StorageFile](../windows.storage/storagefile.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidate_getvalueasstreamasync_456308579.md b/windows.applicationmodel.resources.core/resourcecandidate_getvalueasstreamasync_456308579.md index ac0379d8e5..b534252318 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_getvalueasstreamasync_456308579.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_getvalueasstreamasync_456308579.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsStreamAsync --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsStreamAsync ## -description Asynchronously returns an [IRandomAccessStream](http://msdn.microsoft.com/library/d2eceb3d-d13e-44c1-bfe2-1aa57f7432c6) that accesses the value of this [ResourceCandidate](resourcecandidate.md). ## -returns An asynchronous operation to return the requested [IRandomAccessStream](http://msdn.microsoft.com/library/d2eceb3d-d13e-44c1-bfe2-1aa57f7432c6). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsStreamAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.GetValueAsStreamAsync + +## -description +Asynchronously returns an [IRandomAccessStream](http://msdn.microsoft.com/library/d2eceb3d-d13e-44c1-bfe2-1aa57f7432c6) that accesses the value of this [ResourceCandidate](resourcecandidate.md). + +## -returns +An asynchronous operation to return the requested [IRandomAccessStream](http://msdn.microsoft.com/library/d2eceb3d-d13e-44c1-bfe2-1aa57f7432c6). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidate_isdefault.md b/windows.applicationmodel.resources.core/resourcecandidate_isdefault.md index 42cb157ca7..9de006db68 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_isdefault.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_isdefault.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsDefault --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsDefault ## -description Indicates whether this [ResourceCandidate](resourcecandidate.md) can be used as a default fallback value for any context. ## -property-value **TRUE** if this candidate can be used as a default fallback value for any context, **FALSE** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsDefault +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsDefault + +## -description +Indicates whether this [ResourceCandidate](resourcecandidate.md) can be used as a default fallback value for any context. + +## -property-value +**TRUE** if this candidate can be used as a default fallback value for any context, **FALSE** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidate_ismatch.md b/windows.applicationmodel.resources.core/resourcecandidate_ismatch.md index e3cbad785c..016c84a161 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_ismatch.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_ismatch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatch --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatch ## -description Indicates whether this [ResourceCandidate](resourcecandidate.md) matched the [ResourceContext](resourcecontext.md) against which it was evaluated. ## -property-value **TRUE** if the [ResourceCandidate](resourcecandidate.md) matched the context, **FALSE** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatch +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatch + +## -description +Indicates whether this [ResourceCandidate](resourcecandidate.md) matched the [ResourceContext](resourcecontext.md) against which it was evaluated. + +## -property-value +**TRUE** if the [ResourceCandidate](resourcecandidate.md) matched the context, **FALSE** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidate_ismatchasdefault.md b/windows.applicationmodel.resources.core/resourcecandidate_ismatchasdefault.md index 61d3dd7ac4..e6e4b1428d 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_ismatchasdefault.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_ismatchasdefault.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatchAsDefault --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatchAsDefault ## -description Indicates whether this [ResourceCandidate](resourcecandidate.md) matched the [ResourceContext](resourcecontext.md) against which it was evaluated as a result of being a true match, a default fallback value, or a mixed match with default fallback (that is, a match in relation to some qualifiers but using default fallback values for other qualifiers). ## -property-value **TRUE** if this candidate is an acceptable default fallback value, **FALSE** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatchAsDefault +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.IsMatchAsDefault + +## -description +Indicates whether this [ResourceCandidate](resourcecandidate.md) matched the [ResourceContext](resourcecontext.md) against which it was evaluated as a result of being a true match, a default fallback value, or a mixed match with default fallback (that is, a match in relation to some qualifiers but using default fallback values for other qualifiers). + +## -property-value +**TRUE** if this candidate is an acceptable default fallback value, **FALSE** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidate_qualifiers.md b/windows.applicationmodel.resources.core/resourcecandidate_qualifiers.md index 7ff7e7eeb5..72f3a9c6ad 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_qualifiers.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_qualifiers.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.Qualifiers --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.Qualifiers ## -description Gets the qualifiers associated with this [ResourceCandidate](resourcecandidate.md). ## -property-value The [ResourceQualifier](resourcequalifier.md) s associated with this [ResourceCandidate](resourcecandidate.md). ## -remarks ## -examples ## -see-also [ResourceQualifier](resourcequalifier.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.Qualifiers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.Qualifiers + +## -description +Gets the qualifiers associated with this [ResourceCandidate](resourcecandidate.md). + +## -property-value +The [ResourceQualifier](resourcequalifier.md) s associated with this [ResourceCandidate](resourcecandidate.md). + +## -remarks + +## -examples + +## -see-also +[ResourceQualifier](resourcequalifier.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecandidate_valueasstring.md b/windows.applicationmodel.resources.core/resourcecandidate_valueasstring.md index eadfc63c5f..20c5278bad 100644 --- a/windows.applicationmodel.resources.core/resourcecandidate_valueasstring.md +++ b/windows.applicationmodel.resources.core/resourcecandidate_valueasstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.ValueAsString --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidate.ValueAsString ## -description Gets the value of this [ResourceCandidate](resourcecandidate.md), expressed as a string. ## -property-value The string value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidate.ValueAsString +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidate.ValueAsString + +## -description +Gets the value of this [ResourceCandidate](resourcecandidate.md), expressed as a string. + +## -property-value +The string value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidatevectorview_first_1920739956.md b/windows.applicationmodel.resources.core/resourcecandidatevectorview_first_1920739956.md index c21a3e76f8..7fedd424ed 100644 --- a/windows.applicationmodel.resources.core/resourcecandidatevectorview_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcecandidatevectorview_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.First ## -description Returns an iterator to enumerate the items in the set of [ResourceCandidate](resourcecandidate.md) objects. ## -returns The iterator. The current position of the iterator is index 0, or the end of the set if the set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.First + +## -description +Returns an iterator to enumerate the items in the set of [ResourceCandidate](resourcecandidate.md) objects. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the set if the set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidatevectorview_getat_496709656.md b/windows.applicationmodel.resources.core/resourcecandidatevectorview_getat_496709656.md index 820ad34521..4c5d46826c 100644 --- a/windows.applicationmodel.resources.core/resourcecandidatevectorview_getat_496709656.md +++ b/windows.applicationmodel.resources.core/resourcecandidatevectorview_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetAt ## -description Returns the [ResourceCandidate](resourcecandidate.md) at the specified index in the set. ## -parameters ### -param index The zero-based index of the [ResourceCandidate](resourcecandidate.md) in the set to return. ## -returns The [ResourceCandidate](resourcecandidate.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetAt + +## -description +Returns the [ResourceCandidate](resourcecandidate.md) at the specified index in the set. + +## -parameters +### -param index +The zero-based index of the [ResourceCandidate](resourcecandidate.md) in the set to return. + +## -returns +The [ResourceCandidate](resourcecandidate.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidatevectorview_getmany_1029781480.md b/windows.applicationmodel.resources.core/resourcecandidatevectorview_getmany_1029781480.md index cbfd350e0f..f9f9bbff6c 100644 --- a/windows.applicationmodel.resources.core/resourcecandidatevectorview_getmany_1029781480.md +++ b/windows.applicationmodel.resources.core/resourcecandidatevectorview_getmany_1029781480.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetMany(System.UInt32,Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetMany ## -description Returns the [ResourceCandidate](resourcecandidate.md) objects that start at the specified index in the set. ## -parameters ### -param startIndex The zero-based index of the start of the [ResourceCandidate](resourcecandidate.md) objects in the set to return. ### -param items The [ResourceCandidate](resourcecandidate.md) objects in the set that start at *startIndex*. ## -returns The number of [ResourceCandidate](resourcecandidate.md) objects returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetMany(System.UInt32,Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.GetMany + +## -description +Returns the [ResourceCandidate](resourcecandidate.md) objects that start at the specified index in the set. + +## -parameters +### -param startIndex +The zero-based index of the start of the [ResourceCandidate](resourcecandidate.md) objects in the set to return. + +### -param items +The [ResourceCandidate](resourcecandidate.md) objects in the set that start at *startIndex*. + +## -returns +The number of [ResourceCandidate](resourcecandidate.md) objects returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidatevectorview_indexof_1267044811.md b/windows.applicationmodel.resources.core/resourcecandidatevectorview_indexof_1267044811.md index cd209000b6..195fe211ec 100644 --- a/windows.applicationmodel.resources.core/resourcecandidatevectorview_indexof_1267044811.md +++ b/windows.applicationmodel.resources.core/resourcecandidatevectorview_indexof_1267044811.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.IndexOf(Windows.ApplicationModel.Resources.Core.ResourceCandidate,System.UInt32@) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.IndexOf ## -description Returns the index of a specified [ResourceCandidate](resourcecandidate.md) in the set. ## -parameters ### -param value The [ResourceCandidate](resourcecandidate.md) to find in the set. ### -param index The zero-based index of the [ResourceCandidate](resourcecandidate.md), if the item is found. The method returns zero if the item is not found. ## -returns A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) that is **TRUE** if the [ResourceCandidate](resourcecandidate.md) is found, otherwise **FALSE** if the item is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.IndexOf(Windows.ApplicationModel.Resources.Core.ResourceCandidate,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.IndexOf + +## -description +Returns the index of a specified [ResourceCandidate](resourcecandidate.md) in the set. + +## -parameters +### -param value +The [ResourceCandidate](resourcecandidate.md) to find in the set. + +### -param index +The zero-based index of the [ResourceCandidate](resourcecandidate.md), if the item is found. The method returns zero if the item is not found. + +## -returns +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) that is **TRUE** if the [ResourceCandidate](resourcecandidate.md) is found, otherwise **FALSE** if the item is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecandidatevectorview_size.md b/windows.applicationmodel.resources.core/resourcecandidatevectorview_size.md index 9bdf3cbe78..381ef4406b 100644 --- a/windows.applicationmodel.resources.core/resourcecandidatevectorview_size.md +++ b/windows.applicationmodel.resources.core/resourcecandidatevectorview_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.Size ## -description Gets the number of [ResourceCandidate](resourcecandidate.md) objects in the set. ## -property-value The number of [ResourceCandidate](resourcecandidate.md) objects in the set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceCandidateVectorView.Size + +## -description +Gets the number of [ResourceCandidate](resourcecandidate.md) objects in the set. + +## -property-value +The number of [ResourceCandidate](resourcecandidate.md) objects in the set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_clone_766852569.md b/windows.applicationmodel.resources.core/resourcecontext_clone_766852569.md index 9b64034701..c8529d96d8 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_clone_766852569.md +++ b/windows.applicationmodel.resources.core/resourcecontext_clone_766852569.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.Clone --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.Clone ## -description Creates a clone of this [ResourceContext](resourcecontext.md), with identical qualifiers. ## -returns A new, cloned [ResourceContext](resourcecontext.md). ## -remarks By default, a cloned context has the same qualifier values as the default context from which it was derived. If a qualifier value in the default context changes, the changes are reflected in the cloned context as well. However, if a qualifier value is programmatically overridden on the cloned context, the linkage to the default context for that qualifier is removed— changes to that qualifier value in the cloned context do not affect the default context, and vice versa. This linkage can be restored using the [Reset](resourcecontext_reset.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.Clone +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.Clone + +## -description +Creates a clone of this [ResourceContext](resourcecontext.md), with identical qualifiers. + +## -returns +A new, cloned [ResourceContext](resourcecontext.md). + +## -remarks +By default, a cloned context has the same qualifier values as the default context from which it was derived. If a qualifier value in the default context changes, the changes are reflected in the cloned context as well. However, if a qualifier value is programmatically overridden on the cloned context, the linkage to the default context for that qualifier is removed— changes to that qualifier value in the cloned context do not affect the default context, and vice versa. This linkage can be restored using the [Reset](resourcecontext_reset.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_creatematchingcontext_548608309.md b/windows.applicationmodel.resources.core/resourcecontext_creatematchingcontext_548608309.md index 3d2006c193..9a6062606e 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_creatematchingcontext_548608309.md +++ b/windows.applicationmodel.resources.core/resourcecontext_creatematchingcontext_548608309.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.CreateMatchingContext(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Resources.Core.ResourceQualifier}) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.CreateMatchingContext ## -description > [!NOTE] > CreateMatchingContext may be altered or unavailable for releases after Windows 8.1. Instead, use [ResourceContext.GetForCurrentView.OverrideToMatch](resourcecontext_overridetomatch.md). Creates a new [ResourceContext](resourcecontext.md) that matches a supplied set of qualifiers. ## -parameters ### -param result The list of qualifiers to be matched. ## -returns The new [ResourceContext](resourcecontext.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.CreateMatchingContext(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Resources.Core.ResourceQualifier}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.CreateMatchingContext + +## -description +> [!NOTE] +> CreateMatchingContext may be altered or unavailable for releases after Windows 8.1. Instead, use [ResourceContext.GetForCurrentView.OverrideToMatch](resourcecontext_overridetomatch.md). + +Creates a new [ResourceContext](resourcecontext.md) that matches a supplied set of qualifiers. + +## -parameters +### -param result +The list of qualifiers to be matched. + +## -returns +The new [ResourceContext](resourcecontext.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_getforcurrentview_1363600702.md b/windows.applicationmodel.resources.core/resourcecontext_getforcurrentview_1363600702.md index 46ac5df5ff..b1c15bc476 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_getforcurrentview_1363600702.md +++ b/windows.applicationmodel.resources.core/resourcecontext_getforcurrentview_1363600702.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.GetForCurrentView --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.GetForCurrentView ## -description Gets a default [ResourceContext](resourcecontext.md) associated with the current view for the currently running application. ## -returns The default context associated with the current view. ## -remarks This method fails if it is called in a windowless thread. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.GetForCurrentView + +## -description +Gets a default [ResourceContext](resourcecontext.md) associated with the current view for the currently running application. + +## -returns +The default context associated with the current view. + +## -remarks +This method fails if it is called in a windowless thread. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_getforviewindependentuse_386169056.md b/windows.applicationmodel.resources.core/resourcecontext_getforviewindependentuse_386169056.md index b2b8ce165f..613da97969 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_getforviewindependentuse_386169056.md +++ b/windows.applicationmodel.resources.core/resourcecontext_getforviewindependentuse_386169056.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.GetForViewIndependentUse --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.GetForViewIndependentUse ## -description Gets a default [ResourceContext](resourcecontext.md) not associated with any view. ## -returns A default [ResourceContext](resourcecontext.md) not associated with any view. ## -remarks By default, no scale qualifier value is set in the [ResourceContext](resourcecontext.md) returned by this method. Unless and until a scale qualifier value is set programmatically, the returned [ResourceContext](resourcecontext.md) does not support any operations that involve the scale qualifier, including reading the scale qualifier value or resolving resource candidates that are qualified for scale. This method fails if it is called in a windowless thread. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.GetForViewIndependentUse +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.GetForViewIndependentUse + +## -description +Gets a default [ResourceContext](resourcecontext.md) not associated with any view. + +## -returns +A default [ResourceContext](resourcecontext.md) not associated with any view. + +## -remarks +By default, no scale qualifier value is set in the [ResourceContext](resourcecontext.md) returned by this method. Unless and until a scale qualifier value is set programmatically, the returned [ResourceContext](resourcecontext.md) does not support any operations that involve the scale qualifier, including reading the scale qualifier value or resolving resource candidates that are qualified for scale. + +This method fails if it is called in a windowless thread. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_languages.md b/windows.applicationmodel.resources.core/resourcecontext_languages.md index 64a1cd8a5d..b048378c7b 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_languages.md +++ b/windows.applicationmodel.resources.core/resourcecontext_languages.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceContext.Languages --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.Languages ## -description Gets or sets the language qualifier for this context. ## -property-value A collection of [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tags. ## -remarks The language qualifier is a list of valid [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) tags. The default value for the language qualifier is drawn from the app-specific language setting and the user language profile. The language qualifier value is represented as a string containing a semicolon-delimited list. The [Languages](resourcecontext_languages.md) property wraps it in a container for convenience. ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceContext.Languages +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.Languages + +## -description +Gets or sets the language qualifier for this context. + +## -property-value +A collection of [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tags. + +## -remarks +The language qualifier is a list of valid [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) tags. The default value for the language qualifier is drawn from the app-specific language setting and the user language profile. + +The language qualifier value is represented as a string containing a semicolon-delimited list. The [Languages](resourcecontext_languages.md) property wraps it in a container for convenience. + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_overridetomatch_438819547.md b/windows.applicationmodel.resources.core/resourcecontext_overridetomatch_438819547.md index 16f8985122..73f36a413f 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_overridetomatch_438819547.md +++ b/windows.applicationmodel.resources.core/resourcecontext_overridetomatch_438819547.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.OverrideToMatch(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Resources.Core.ResourceQualifier}) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.OverrideToMatch ## -description Overrides the qualifier values supplied by this context to match a specified list of resolved [ResourceQualifier](resourcequalifier.md) s. Typically the resolved [ResourceQualifier](resourcequalifier.md) s are associated with a resource that was looked up earlier. ## -parameters ### -param result The [ResourceQualifier](resourcequalifier.md) s to be applied to the context. ## -remarks ## -examples ## -see-also [ResourceQualifier](resourcequalifier.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.OverrideToMatch(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Resources.Core.ResourceQualifier}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.OverrideToMatch + +## -description + Overrides the qualifier values supplied by this context to match a specified list of resolved [ResourceQualifier](resourcequalifier.md) s. Typically the resolved [ResourceQualifier](resourcequalifier.md) s are associated with a resource that was looked up earlier. + +## -parameters +### -param result +The [ResourceQualifier](resourcequalifier.md) s to be applied to the context. + +## -remarks + +## -examples + +## -see-also +[ResourceQualifier](resourcequalifier.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_qualifiervalues.md b/windows.applicationmodel.resources.core/resourcecontext_qualifiervalues.md index 593fdb13ef..682170a8e5 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_qualifiervalues.md +++ b/windows.applicationmodel.resources.core/resourcecontext_qualifiervalues.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceContext.QualifierValues --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.QualifierValues ## -description Gets a writable, observable map of all supported qualifiers, indexed by name. ## -property-value The map of qualifiers. Here are the possible string qualifier names that you can map to string qualifier values. "Language"This qualifier name can be mapped to a string value that represents the language, such as, "en-us" for United States English."Contrast"This qualifier name can be mapped to one of these values:"standard""high""black""white""Scale"This qualifier name can be mapped to one of these values for scale of the display as a percentage:"80""100""120""125" (Windows 10 only)"140""150" (Windows 10 only)"160""175" (Windows 10 only)"180""200""225" (Windows 10 only)"250" (Windows 10 only)"300" (Windows 10 only)"350" (Windows 10 only)"400" (Windows 10 only)"450" (Windows 10 only)"DeviceFamily"This qualifier name can be mapped to a string value that represents the device family of the device that your app is currently running on, such as, "Desktop", "Mobile", and the names of the other device families. You can use the "DeviceFamily" qualifier name in your markup or Resource.resw filenames. For example, when your app is running on the mobile device family device family, the UI element `` will use the text and foreground resources defined in your Resources.DeviceFamily-Mobile.resw file if it contains: `RedMobile device`."HomeRegion"This qualifier name can be mapped to a string value that represents the region, such as, "021" for North America."TargetSize"This qualifier name can be mapped to a string value that represents the size of the target, such as, "256"."LayoutDirection"This qualifier name can be mapped to one of these values:"LTR"Layout direction is left to right."RTL"Layout direction is right to left."TTBLTR"Layout direction is top to bottom and left to right."TTBRTL"Layout direction is top to bottom and right to left."Configuration"This qualifier name can be mapped to a string value that represents the configuration."AlternateForm"This qualifier name can be mapped to a string value that represents the alternate form."DXFeatureLevel"This qualifier name can be mapped to one of these values for the [DirectX feature level](http://msdn.microsoft.com/library/5ad0525c-249f-452d-950b-df8fa2addde2):"DX9"Targets features supported by Direct3D 9.x."DX10"Targets features supported by Direct3D 10.x."DX11"Targets features supported by Direct3D 11.x. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceContext.QualifierValues +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.QualifierValues + +## -description +Gets a writable, observable map of all supported qualifiers, indexed by name. + +## -property-value +The map of qualifiers. Here are the possible string qualifier names that you can map to string qualifier values. "Language"This qualifier name can be mapped to a string value that represents the language, such as, "en-us" for United States English."Contrast"This qualifier name can be mapped to one of these values:"standard""high""black""white""Scale"This qualifier name can be mapped to one of these values for scale of the display as a percentage:"80""100""120""125" (Windows 10 only)"140""150" (Windows 10 only)"160""175" (Windows 10 only)"180""200""225" (Windows 10 only)"250" (Windows 10 only)"300" (Windows 10 only)"350" (Windows 10 only)"400" (Windows 10 only)"450" (Windows 10 only)"DeviceFamily"This qualifier name can be mapped to a string value that represents the device family of the device that your app is currently running on, such as, "Desktop", "Mobile", and the names of the other device families. You can use the "DeviceFamily" qualifier name in your markup or Resource.resw filenames. For example, when your app is running on the mobile device family device family, the UI element `` will use the text and foreground resources defined in your Resources.DeviceFamily-Mobile.resw file if it contains: `RedMobile device`."HomeRegion"This qualifier name can be mapped to a string value that represents the region, such as, "021" for North America."TargetSize"This qualifier name can be mapped to a string value that represents the size of the target, such as, "256"."LayoutDirection"This qualifier name can be mapped to one of these values:"LTR"Layout direction is left to right."RTL"Layout direction is right to left."TTBLTR"Layout direction is top to bottom and left to right."TTBRTL"Layout direction is top to bottom and right to left."Configuration"This qualifier name can be mapped to a string value that represents the configuration."AlternateForm"This qualifier name can be mapped to a string value that represents the alternate form."DXFeatureLevel"This qualifier name can be mapped to one of these values for the [DirectX feature level](http://msdn.microsoft.com/library/5ad0525c-249f-452d-950b-df8fa2addde2):"DX9"Targets features supported by Direct3D 9.x."DX10"Targets features supported by Direct3D 10.x."DX11"Targets features supported by Direct3D 11.x. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_reset_1636126115.md b/windows.applicationmodel.resources.core/resourcecontext_reset_1636126115.md index 9f49db664e..16e4f8dce7 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_reset_1636126115.md +++ b/windows.applicationmodel.resources.core/resourcecontext_reset_1636126115.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.Reset --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.Reset ## -description Resets the overridden values for all qualifiers on the given [ResourceContext](resourcecontext.md) instance. ## -remarks ## -examples ## -see-also [Reset(IIterable(String))](resourcecontext_reset_1866151571.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.Reset +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.Reset + +## -description +Resets the overridden values for all qualifiers on the given [ResourceContext](resourcecontext.md) instance. + +## -remarks + +## -examples + +## -see-also +[Reset(IIterable(String))](resourcecontext_reset_1866151571.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_reset_1866151571.md b/windows.applicationmodel.resources.core/resourcecontext_reset_1866151571.md index 30ae554b69..5308600f18 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_reset_1866151571.md +++ b/windows.applicationmodel.resources.core/resourcecontext_reset_1866151571.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.Reset(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.Reset ## -description Resets the overridden values for the specified qualifiers on the given [ResourceContext](resourcecontext.md) instance. ## -parameters ### -param qualifierNames The names of the qualifiers to be reset. ## -remarks ## -examples ## -see-also [Reset](resourcecontext_reset_1636126115.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.Reset(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.Reset + +## -description +Resets the overridden values for the specified qualifiers on the given [ResourceContext](resourcecontext.md) instance. + +## -parameters +### -param qualifierNames +The names of the qualifiers to be reset. + +## -remarks + +## -examples + +## -see-also +[Reset](resourcecontext_reset_1636126115.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1096704102.md b/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1096704102.md index 7bba79c954..ec06d996dc 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1096704102.md +++ b/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1096704102.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues ## -description Removes any qualifier overrides from default contexts of all views across the app. ## -remarks ## -examples ## -see-also [ResetGlobalQualifierValues(IIterable(String))](resourcecontext_resetglobalqualifiervalues_1340087124.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues + +## -description +Removes any qualifier overrides from default contexts of all views across the app. + +## -remarks + +## -examples + +## -see-also +[ResetGlobalQualifierValues(IIterable(String))](resourcecontext_resetglobalqualifiervalues_1340087124.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1340087124.md b/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1340087124.md index ea28c942a2..5373060ba1 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1340087124.md +++ b/windows.applicationmodel.resources.core/resourcecontext_resetglobalqualifiervalues_1340087124.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues ## -description Removes qualifier overrides for the specified qualifiers from default contexts of all views across the app. ## -parameters ### -param qualifierNames The names of the qualifiers to be reset. ## -remarks This method fails with an exception if any of the qualifier names specified are invalid. ## -examples ## -see-also [ResetGlobalQualifierValues](resourcecontext_resetglobalqualifiervalues_1096704102.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.ResetGlobalQualifierValues + +## -description +Removes qualifier overrides for the specified qualifiers from default contexts of all views across the app. + +## -parameters +### -param qualifierNames +The names of the qualifiers to be reset. + +## -remarks +This method fails with an exception if any of the qualifier names specified are invalid. + +## -examples + +## -see-also +[ResetGlobalQualifierValues](resourcecontext_resetglobalqualifiervalues_1096704102.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_resourcecontext_1221375020.md b/windows.applicationmodel.resources.core/resourcecontext_resourcecontext_1221375020.md index 0fbebde8f6..0433f032d3 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_resourcecontext_1221375020.md +++ b/windows.applicationmodel.resources.core/resourcecontext_resourcecontext_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.ResourceContext ## -description > [!NOTE] > ResourceContext constructor may be altered or unavailable for releases after Windows 8.1. Instead, use [GetForCurrentView](resourcecontext_getforcurrentview.md). Creates a cloned [ResourceContext](resourcecontext.md) object. ## -remarks In general, resources can be sensitive to scale. For that reason, a [ResourceContext](resourcecontext.md) is generally associated with a specific view, and should be obtained using [GetForCurrentView](resourcecontext_getforcurrentview.md). (A view-independent [ResourceContext](resourcecontext.md) can also be obtained using [GetForViewIndependentUse](resourcecontext_getforviewindependentuse.md).) If a [ResourceContext](resourcecontext.md) is obtained using this constructor, it will be have scale associated with an arbitrary view. Do not make any assumptions in your app regarding this behavior. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.ResourceContext + +## -description +> [!NOTE] +> ResourceContext constructor may be altered or unavailable for releases after Windows 8.1. Instead, use [GetForCurrentView](resourcecontext_getforcurrentview.md). + +Creates a cloned [ResourceContext](resourcecontext.md) object. + +## -remarks +In general, resources can be sensitive to scale. For that reason, a [ResourceContext](resourcecontext.md) is generally associated with a specific view, and should be obtained using [GetForCurrentView](resourcecontext_getforcurrentview.md). (A view-independent [ResourceContext](resourcecontext.md) can also be obtained using [GetForViewIndependentUse](resourcecontext_getforviewindependentuse.md).) If a [ResourceContext](resourcecontext.md) is obtained using this constructor, it will be have scale associated with an arbitrary view. Do not make any assumptions in your app regarding this behavior. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_1619866205.md b/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_1619866205.md index 9dc50126c6..13c8e66a2a 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_1619866205.md +++ b/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_1619866205.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue(System.String,System.String,Windows.ApplicationModel.Resources.Core.ResourceQualifierPersistence) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue ## -description Applies a single qualifier value override to default contexts of all views for the current app, and specifies the persistence of the override. ## -parameters ### -param key The name of the qualifier to override. ### -param value The override value to set. ### -param persistence The persistence of the override value. ## -remarks This method fails with an exception if *key* or *value* are invalid. ## -examples ## -see-also [SetGlobalQualifierValue(String, String)](resourcecontext_setglobalqualifiervalue.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue(System.String,System.String,Windows.ApplicationModel.Resources.Core.ResourceQualifierPersistence) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue + +## -description +Applies a single qualifier value override to default contexts of all views for the current app, and specifies the persistence of the override. + +## -parameters +### -param key +The name of the qualifier to override. + +### -param value +The override value to set. + +### -param persistence +The persistence of the override value. + +## -remarks +This method fails with an exception if *key* or *value* are invalid. + +## -examples + +## -see-also +[SetGlobalQualifierValue(String, String)](resourcecontext_setglobalqualifiervalue.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_665193653.md b/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_665193653.md index 4cd316213c..f5288e471b 100644 --- a/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_665193653.md +++ b/windows.applicationmodel.resources.core/resourcecontext_setglobalqualifiervalue_665193653.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue ## -description Applies a single qualifier value override to default contexts of all views for the current app. ## -parameters ### -param key The name of the qualifier to override. ### -param value The override value to set. ## -remarks This method fails with an exception if *key* or *value* are invalid. ## -examples ## -see-also [SetGlobalQualifierValue(String, String, ResourceQualifierPersistence)](resourcecontext_setglobalqualifiervalue_1619866205.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContext.SetGlobalQualifierValue + +## -description +Applies a single qualifier value override to default contexts of all views for the current app. + +## -parameters +### -param key +The name of the qualifier to override. + +### -param value +The override value to set. + +## -remarks +This method fails with an exception if *key* or *value* are invalid. + +## -examples + +## -see-also +[SetGlobalQualifierValue(String, String, ResourceQualifierPersistence)](resourcecontext_setglobalqualifiervalue_1619866205.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_first_1920739956.md b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_first_1920739956.md index 47bf17c2c6..b9d7b4d242 100644 --- a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.First ## -description Returns an iterator to enumerate the items in the set of [ResourceContext](resourcecontext.md) language qualifiers. ## -returns The iterator. The current position of the iterator is index 0, or the end of the set if the set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.First + +## -description +Returns an iterator to enumerate the items in the set of [ResourceContext](resourcecontext.md) language qualifiers. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the set if the set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getat_496709656.md b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getat_496709656.md index 77edf3fb7a..2b4fcbaf29 100644 --- a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getat_496709656.md +++ b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetAt ## -description Returns the [ResourceContext](resourcecontext.md) language qualifier at the specified index in the set. ## -parameters ### -param index The zero-based index of the [ResourceContext](resourcecontext.md) language qualifier in the set to return. ## -returns The [ResourceContext](resourcecontext.md) language qualifier at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetAt + +## -description +Returns the [ResourceContext](resourcecontext.md) language qualifier at the specified index in the set. + +## -parameters +### -param index +The zero-based index of the [ResourceContext](resourcecontext.md) language qualifier in the set to return. + +## -returns +The [ResourceContext](resourcecontext.md) language qualifier at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getmany_162584452.md b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getmany_162584452.md index c4d020a59d..66c53558e5 100644 --- a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getmany_162584452.md +++ b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_getmany_162584452.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetMany(System.UInt32,System.String[]) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetMany ## -description Returns the [ResourceContext](resourcecontext.md) language qualifiers that start at the specified index in the set. ## -parameters ### -param startIndex The zero-based index of the start of the [ResourceContext](resourcecontext.md) language qualifiers in the set to return. ### -param items The [ResourceContext](resourcecontext.md) language qualifiers in the set that start at *startIndex*. ## -returns The number of [ResourceContext](resourcecontext.md) language qualifiers returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetMany(System.UInt32,System.String[]) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.GetMany + +## -description +Returns the [ResourceContext](resourcecontext.md) language qualifiers that start at the specified index in the set. + +## -parameters +### -param startIndex +The zero-based index of the start of the [ResourceContext](resourcecontext.md) language qualifiers in the set to return. + +### -param items +The [ResourceContext](resourcecontext.md) language qualifiers in the set that start at *startIndex*. + +## -returns +The number of [ResourceContext](resourcecontext.md) language qualifiers returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_indexof_1831476187.md b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_indexof_1831476187.md index dad3bdf150..5733ef4b61 100644 --- a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_indexof_1831476187.md +++ b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_indexof_1831476187.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.IndexOf(System.String,System.UInt32@) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.IndexOf ## -description Returns the index of a specified [ResourceContext](resourcecontext.md) language qualifier in the set. ## -parameters ### -param value The [ResourceContext](resourcecontext.md) language qualifier to find in the set. ### -param index The zero-based index of the [ResourceContext](resourcecontext.md) language qualifier, if the item is found. The method returns zero if the item is not found. ## -returns A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) that is **TRUE** if the [ResourceContext](resourcecontext.md) language qualifier is found; otherwise, **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.IndexOf(System.String,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.IndexOf + +## -description +Returns the index of a specified [ResourceContext](resourcecontext.md) language qualifier in the set. + +## -parameters +### -param value +The [ResourceContext](resourcecontext.md) language qualifier to find in the set. + +### -param index +The zero-based index of the [ResourceContext](resourcecontext.md) language qualifier, if the item is found. The method returns zero if the item is not found. + +## -returns +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) that is **TRUE** if the [ResourceContext](resourcecontext.md) language qualifier is found; otherwise, **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_size.md b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_size.md index 048dbc3d19..e566b3a778 100644 --- a/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_size.md +++ b/windows.applicationmodel.resources.core/resourcecontextlanguagesvectorview_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.Size ## -description Gets the number of [ResourceContext](resourcecontext.md) language qualifiers in the set. ## -property-value The number of [ResourceContext](resourcecontext.md) language qualifiers in the set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceContextLanguagesVectorView.Size + +## -description +Gets the number of [ResourceContext](resourcecontext.md) language qualifiers in the set. + +## -property-value +The number of [ResourceContext](resourcecontext.md) language qualifiers in the set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_allresourcemaps.md b/windows.applicationmodel.resources.core/resourcemanager_allresourcemaps.md index bdffcb1789..dfaf3c413f 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_allresourcemaps.md +++ b/windows.applicationmodel.resources.core/resourcemanager_allresourcemaps.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.AllResourceMaps --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.AllResourceMaps ## -description Gets a map of [ResourceMap](resourcemap.md) objects typically associated with the app packages, indexed by package name. ## -property-value Contains all default resource maps for all packages used by the app, as well as any resource maps that have been loaded explicitly. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.AllResourceMaps +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.AllResourceMaps + +## -description +Gets a map of [ResourceMap](resourcemap.md) objects typically associated with the app packages, indexed by package name. + +## -property-value +Contains all default resource maps for all packages used by the app, as well as any resource maps that have been loaded explicitly. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_current.md b/windows.applicationmodel.resources.core/resourcemanager_current.md index 409b66fa13..81e2b3eabc 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_current.md +++ b/windows.applicationmodel.resources.core/resourcemanager_current.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.Current --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.Current ## -description Gets the [ResourceManager](resourcemanager.md) for the currently running application. ## -property-value The application default [ResourceManager](resourcemanager.md), initialized with the resources for all of the packages in the package graph. ## -remarks Returns ERROR_MRM_INVALID_PRI_FILE if one of the packages contains a malformed PRI file. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.Current +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.Current + +## -description +Gets the [ResourceManager](resourcemanager.md) for the currently running application. + +## -property-value +The application default [ResourceManager](resourcemanager.md), initialized with the resources for all of the packages in the package graph. + +## -remarks +Returns ERROR_MRM_INVALID_PRI_FILE if one of the packages contains a malformed PRI file. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_defaultcontext.md b/windows.applicationmodel.resources.core/resourcemanager_defaultcontext.md index 43e943d3c9..3616a215c6 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_defaultcontext.md +++ b/windows.applicationmodel.resources.core/resourcemanager_defaultcontext.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext ## -description > [!NOTE] > DefaultContext may be altered or unavailable for releases after Windows 8.1. Instead, use [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md). Gets the default [ResourceContext](resourcecontext.md) for the currently running application. Unless explicitly overridden, the default [ResourceContext](resourcecontext.md) is used to determine the most appropriate representation of any given named resource. ## -property-value The resource context. ## -remarks ## -examples ## -see-also [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext + +## -description +> [!NOTE] +> DefaultContext may be altered or unavailable for releases after Windows 8.1. Instead, use [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md). + +Gets the default [ResourceContext](resourcecontext.md) for the currently running application. Unless explicitly overridden, the default [ResourceContext](resourcecontext.md) is used to determine the most appropriate representation of any given named resource. + +## -property-value +The resource context. + +## -remarks + +## -examples + +## -see-also +[ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcemanager_getallnamedresourcesforpackage_1711295302.md b/windows.applicationmodel.resources.core/resourcemanager_getallnamedresourcesforpackage_1711295302.md index f77141ce75..fc0c8b497f 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_getallnamedresourcesforpackage_1711295302.md +++ b/windows.applicationmodel.resources.core/resourcemanager_getallnamedresourcesforpackage_1711295302.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllNamedResourcesForPackage(System.String,Windows.ApplicationModel.Resources.Core.ResourceLayoutInfo) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllNamedResourcesForPackage ## -description Gets a list of all named resources for an app package. ## -parameters ### -param packageName The name of the app package. ### -param resourceLayoutInfo Specifies the resource version and the named resource count. ## -returns A list of [NamedResource](namedresource.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllNamedResourcesForPackage(System.String,Windows.ApplicationModel.Resources.Core.ResourceLayoutInfo) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllNamedResourcesForPackage + +## -description +Gets a list of all named resources for an app package. + +## -parameters +### -param packageName +The name of the app package. + +### -param resourceLayoutInfo +Specifies the resource version and the named resource count. + +## -returns +A list of [NamedResource](namedresource.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_getallsubtreesforpackage_1404611295.md b/windows.applicationmodel.resources.core/resourcemanager_getallsubtreesforpackage_1404611295.md index 2391fda82d..423b752166 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_getallsubtreesforpackage_1404611295.md +++ b/windows.applicationmodel.resources.core/resourcemanager_getallsubtreesforpackage_1404611295.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllSubtreesForPackage(System.String,Windows.ApplicationModel.Resources.Core.ResourceLayoutInfo) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllSubtreesForPackage ## -description Gets a list of all collections of resource subtrees for an app package. ## -parameters ### -param packageName The name of the app package. ### -param resourceLayoutInfo Specifies the resource version and the resource subtree count. ## -returns A list of resource subtrees ([ResourceMap](resourcemap.md) objects). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllSubtreesForPackage(System.String,Windows.ApplicationModel.Resources.Core.ResourceLayoutInfo) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.GetAllSubtreesForPackage + +## -description +Gets a list of all collections of resource subtrees for an app package. + +## -parameters +### -param packageName +The name of the app package. + +### -param resourceLayoutInfo +Specifies the resource version and the resource subtree count. + +## -returns +A list of resource subtrees ([ResourceMap](resourcemap.md) objects). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_isresourcereference_1386817006.md b/windows.applicationmodel.resources.core/resourcemanager_isresourcereference_1386817006.md index 24fdbb886e..8adeddeca7 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_isresourcereference_1386817006.md +++ b/windows.applicationmodel.resources.core/resourcemanager_isresourcereference_1386817006.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.IsResourceReference(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.IsResourceReference ## -description Determines whether a supplied string matches the resource reference format (an ms-resource string URI identifier). ## -parameters ### -param resourceReference The string you want to match. ## -returns **TRUE** if the string matches. ## -remarks An example of matching an ms-resource string URI identifier format: `isResourceReference('ms-resource:Hello')` returns **true**, but `isResourceReference('Hello')` returns **false**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.IsResourceReference(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.IsResourceReference + +## -description +Determines whether a supplied string matches the resource reference format (an ms-resource string URI identifier). + + +## -parameters +### -param resourceReference +The string you want to match. + +## -returns +**TRUE** if the string matches. + +## -remarks +An example of matching an ms-resource string URI identifier format: `isResourceReference('ms-resource:Hello')` returns **true**, but `isResourceReference('Hello')` returns **false**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_loadprifiles_414575616.md b/windows.applicationmodel.resources.core/resourcemanager_loadprifiles_414575616.md index 445284beeb..3461bfe439 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_loadprifiles_414575616.md +++ b/windows.applicationmodel.resources.core/resourcemanager_loadprifiles_414575616.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.LoadPriFiles(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageFile}) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.LoadPriFiles ## -description Loads one or more resource index ("PRI") files and adds their contents to the default resource manager. ## -parameters ### -param files The files you want to add. ## -remarks The [LoadPRIFiles](resourcemanager_loadprifiles.md) method accepts files only from inside the app package or dependent packages. See [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96). If resource packs are used by an app, this method will always fail. ## -examples ## -see-also [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.LoadPriFiles(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageFile}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.LoadPriFiles + +## -description +Loads one or more resource index ("PRI") files and adds their contents to the default resource manager. + +## -parameters +### -param files +The files you want to add. + +## -remarks +The [LoadPRIFiles](resourcemanager_loadprifiles.md) method accepts files only from inside the app package or dependent packages. See [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96). + +If resource packs are used by an app, this method will always fail. + +## -examples + +## -see-also +[How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcemanager_mainresourcemap.md b/windows.applicationmodel.resources.core/resourcemanager_mainresourcemap.md index 402635910e..a4d60ff4b4 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_mainresourcemap.md +++ b/windows.applicationmodel.resources.core/resourcemanager_mainresourcemap.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.MainResourceMap --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.MainResourceMap ## -description Gets the [ResourceMap](resourcemap.md) that is associated with the main package of the currently running application. ## -property-value The resource map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceManager.MainResourceMap +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.MainResourceMap + +## -description + Gets the [ResourceMap](resourcemap.md) that is associated with the main package of the currently running application. + +## -property-value +The resource map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemanager_unloadprifiles_796684504.md b/windows.applicationmodel.resources.core/resourcemanager_unloadprifiles_796684504.md index f0091e5c13..9bb22ee239 100644 --- a/windows.applicationmodel.resources.core/resourcemanager_unloadprifiles_796684504.md +++ b/windows.applicationmodel.resources.core/resourcemanager_unloadprifiles_796684504.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.UnloadPriFiles(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageFile}) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceManager.UnloadPriFiles ## -description Unloads one or more resource index ("PRI") files. ## -parameters ### -param files The files you want unloaded. ## -remarks If resource packs are used by an app, this method will always fail. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceManager.UnloadPriFiles(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageFile}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceManager.UnloadPriFiles + +## -description +Unloads one or more resource index ("PRI") files. + + + + +## -parameters +### -param files +The files you want unloaded. + +## -remarks +If resource packs are used by an app, this method will always fail. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_first_1920739956.md b/windows.applicationmodel.resources.core/resourcemap_first_1920739956.md index da5bbb7f2c..301c5b8d31 100644 --- a/windows.applicationmodel.resources.core/resourcemap_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcemap_first_1920739956.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.First ## -description Returns an iterator to enumerate the items in the map. ## -returns The iterator. The current position of the iterator is index 0, or the end of the set if the map is empty. + The set is all [NamedResource](namedresource.md) s contained within this map and all of its child maps. + The key is a string representing the minimally qualified resource identifier, relative to this resource map. + The value is the [NamedResource](namedresource.md) corresponding to the key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.First + +## -description +Returns an iterator to enumerate the items in the map. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the set if the map is empty. + + ++ The set is all [NamedResource](namedresource.md) s contained within this map and all of its child maps. ++ The key is a string representing the minimally qualified resource identifier, relative to this resource map. ++ The value is the [NamedResource](namedresource.md) corresponding to the key. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_getsubtree_1701937926.md b/windows.applicationmodel.resources.core/resourcemap_getsubtree_1701937926.md index 1cee0aee4d..4a6fe85a42 100644 --- a/windows.applicationmodel.resources.core/resourcemap_getsubtree_1701937926.md +++ b/windows.applicationmodel.resources.core/resourcemap_getsubtree_1701937926.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.GetSubtree(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.GetSubtree ## -description Returns a [ResourceMap](resourcemap.md) that represents a part of another [ResourceMap](resourcemap.md), typically used to access a particular resource file within an app package. This method finds subtree, ancestor, sibling and cousin maps to this resource map, as well as top-level maps. It returns the resource map represented by a given resource map identifier, relative to this resource map. This method is typically used to make simpler references to a particular subset of resources, such as a single resource file, or a directory of files. ## -parameters ### -param reference A resource map identifier that identifies the root of the new subtree. For details, see the remarks for [ResourceMap](resourcemap.md) class. ## -returns The subtree [ResourceMap](resourcemap.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.GetSubtree(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.GetSubtree + +## -description +Returns a [ResourceMap](resourcemap.md) that represents a part of another [ResourceMap](resourcemap.md), typically used to access a particular resource file within an app package. + +This method finds subtree, ancestor, sibling and cousin maps to this resource map, as well as top-level maps. It returns the resource map represented by a given resource map identifier, relative to this resource map. This method is typically used to make simpler references to a particular subset of resources, such as a single resource file, or a directory of files. + +## -parameters +### -param reference +A resource map identifier that identifies the root of the new subtree. For details, see the remarks for [ResourceMap](resourcemap.md) class. + +## -returns +The subtree [ResourceMap](resourcemap.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_getvalue_1450213417.md b/windows.applicationmodel.resources.core/resourcemap_getvalue_1450213417.md index e3c2ced77c..05b4839347 100644 --- a/windows.applicationmodel.resources.core/resourcemap_getvalue_1450213417.md +++ b/windows.applicationmodel.resources.core/resourcemap_getvalue_1450213417.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue(System.String,Windows.ApplicationModel.Resources.Core.ResourceContext) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue ## -description Returns the most appropriate candidate for a resource that is specified by a resource identifier for the supplied context. ## -parameters ### -param resource A resource specified as a name or reference. For details, see the remarks for [ResourceMap](resourcemap.md) class. ### -param context The context for which to select the most appropriate candidate. ## -returns A [ResourceCandidate](resourcecandidate.md) that describes the most appropriate candidate. ## -remarks Some resources are loaded according to the scale of the view where they will be displayed, and different views within an app might be displayed on different devices with different scales. Scale is a per-view characteristic. Since the [GetValue](resourcemap_getvalue_1450213417.md) method selects the best candidate for the specified resource in relation to a runtime context, and since the scale qualifier of a [ResourceContext](resourcecontext.md) depends on the associated view, [GetValue](resourcemap_getvalue_1450213417.md) should always be called with a [ResourceContext](resourcecontext.md) object obtained from the view in which the resource will be used. Call [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) to retrieve the appropriate [ResourceContext](resourcecontext.md). ## -examples ## -see-also [ResourceContext](resourcecontext.md), [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue(System.String,Windows.ApplicationModel.Resources.Core.ResourceContext) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue + +## -description +Returns the most appropriate candidate for a resource that is specified by a resource identifier for the supplied context. + + + + +## -parameters +### -param resource +A resource specified as a name or reference. For details, see the remarks for [ResourceMap](resourcemap.md) class. + +### -param context +The context for which to select the most appropriate candidate. + +## -returns +A [ResourceCandidate](resourcecandidate.md) that describes the most appropriate candidate. + +## -remarks +Some resources are loaded according to the scale of the view where they will be displayed, and different views within an app might be displayed on different devices with different scales. Scale is a per-view characteristic. + +Since the [GetValue](resourcemap_getvalue_1450213417.md) method selects the best candidate for the specified resource in relation to a runtime context, and since the scale qualifier of a [ResourceContext](resourcecontext.md) depends on the associated view, [GetValue](resourcemap_getvalue_1450213417.md) should always be called with a [ResourceContext](resourcecontext.md) object obtained from the view in which the resource will be used. Call [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) to retrieve the appropriate [ResourceContext](resourcecontext.md). + +## -examples + +## -see-also +[ResourceContext](resourcecontext.md), [ResourceContext.GetForCurrentView](resourcecontext_getforcurrentview.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcemap_getvalue_824525603.md b/windows.applicationmodel.resources.core/resourcemap_getvalue_824525603.md index 2128b37e91..ce9e1bf636 100644 --- a/windows.applicationmodel.resources.core/resourcemap_getvalue_824525603.md +++ b/windows.applicationmodel.resources.core/resourcemap_getvalue_824525603.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue ## -description > [!NOTE] > [GetValue(String)](resourcemap_getvalue_824525603.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [GetValue(String, ResourceContext)](resourcemap_getvalue_1450213417.md). Returns the most appropriate candidate for a resource that is specified by a resource identifier within the default context. ## -parameters ### -param resource A resource identifier specified as a name or reference. For details, see the remarks for [ResourceMap](resourcemap.md) class. ## -returns A [ResourceCandidate](resourcecandidate.md) that describes the most appropriate candidate. ## -remarks ## -examples ## -see-also [GetValue(String, ResourceContext)](resourcemap_getvalue_1450213417.md), [ResourceContext.QualifierValues](resourcecontext_qualifiervalues.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.GetValue + +## -description +> [!NOTE] +> [GetValue(String)](resourcemap_getvalue_824525603.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [GetValue(String, ResourceContext)](resourcemap_getvalue_1450213417.md). + +Returns the most appropriate candidate for a resource that is specified by a resource identifier within the default context. + +## -parameters +### -param resource +A resource identifier specified as a name or reference. For details, see the remarks for [ResourceMap](resourcemap.md) class. + +## -returns +A [ResourceCandidate](resourcecandidate.md) that describes the most appropriate candidate. + +## -remarks + +## -examples + +## -see-also +[GetValue(String, ResourceContext)](resourcemap_getvalue_1450213417.md), [ResourceContext.QualifierValues](resourcecontext_qualifiervalues.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.core/resourcemap_haskey_425964900.md b/windows.applicationmodel.resources.core/resourcemap_haskey_425964900.md index 481c54dfef..ee5fbcd2b6 100644 --- a/windows.applicationmodel.resources.core/resourcemap_haskey_425964900.md +++ b/windows.applicationmodel.resources.core/resourcemap_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.HasKey(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.HasKey ## -description Determines whether the map can retrieve a resource with the specified resource identifier. ## -parameters ### -param key The resource identifier to locate in the map. For syntax details, see the remarks for [ResourceMap](resourcemap.md) class. ## -returns **TRUE** if the key is found, otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.HasKey + +## -description +Determines whether the map can retrieve a resource with the specified resource identifier. + +## -parameters +### -param key +The resource identifier to locate in the map. For syntax details, see the remarks for [ResourceMap](resourcemap.md) class. + +## -returns + **TRUE** if the key is found, otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_lookup_711408188.md b/windows.applicationmodel.resources.core/resourcemap_lookup_711408188.md index 75e78ed0ac..649e6af2e8 100644 --- a/windows.applicationmodel.resources.core/resourcemap_lookup_711408188.md +++ b/windows.applicationmodel.resources.core/resourcemap_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.Lookup(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.Lookup ## -description Returns the [NamedResource](namedresource.md) at the specified resource identifier in the map. ## -parameters ### -param key The resource identifier to use to locate the resource in the map. For syntax details, see the remarks for [ResourceMap](resourcemap.md) class. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.Lookup + +## -description +Returns the [NamedResource](namedresource.md) at the specified resource identifier in the map. + +## -parameters +### -param key +The resource identifier to use to locate the resource in the map. For syntax details, see the remarks for [ResourceMap](resourcemap.md) class. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_size.md b/windows.applicationmodel.resources.core/resourcemap_size.md index b017acb65e..b8ec9d3927 100644 --- a/windows.applicationmodel.resources.core/resourcemap_size.md +++ b/windows.applicationmodel.resources.core/resourcemap_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMap.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.Size ## -description Gets the number of resources in the map. ## -property-value The number of resources in the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMap.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.Size + +## -description +Gets the number of resources in the map. + +## -property-value +The number of resources in the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_split_2146906504.md b/windows.applicationmodel.resources.core/resourcemap_split_2146906504.md index 52d9883260..af36062183 100644 --- a/windows.applicationmodel.resources.core/resourcemap_split_2146906504.md +++ b/windows.applicationmodel.resources.core/resourcemap_split_2146906504.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.Split(Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.NamedResource}@,Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.NamedResource}@) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.Split ## -description Splits the map view into two views. ## -parameters ### -param first One half of the original map. ### -param second The second half of the original map. ## -remarks The two views that result from the split operation might not contain the same number of items. The two views do not overlap. If a view can't be split, then both the first and second parameter are **NULL**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMap.Split(Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.NamedResource}@,Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.NamedResource}@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.Split + +## -description +Splits the map view into two views. + +## -parameters +### -param first +One half of the original map. + +### -param second +The second half of the original map. + +## -remarks +The two views that result from the split operation might not contain the same number of items. The two views do not overlap. + +If a view can't be split, then both the first and second parameter are **NULL**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemap_uri.md b/windows.applicationmodel.resources.core/resourcemap_uri.md index 30760e0d46..616eafbb33 100644 --- a/windows.applicationmodel.resources.core/resourcemap_uri.md +++ b/windows.applicationmodel.resources.core/resourcemap_uri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMap.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMap.Uri ## -description Gets a URI that can be used to refer to this [ResourceMap](resourcemap.md). ## -property-value The URI that refers to this [ResourceMap](resourcemap.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMap.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMap.Uri + +## -description +Gets a URI that can be used to refer to this [ResourceMap](resourcemap.md). + +## -property-value +The URI that refers to this [ResourceMap](resourcemap.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapiterator_current.md b/windows.applicationmodel.resources.core/resourcemapiterator_current.md index 78ecdac5d1..6c14afe8c5 100644 --- a/windows.applicationmodel.resources.core/resourcemapiterator_current.md +++ b/windows.applicationmodel.resources.core/resourcemapiterator_current.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.Current --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMapIterator.Current ## -description Gets the current item in the [ResourceMap](resourcemap.md). ## -property-value The key and [NamedResource](namedresource.md) key-value pair for the current item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.Current +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapIterator.Current + +## -description +Gets the current item in the [ResourceMap](resourcemap.md). + +## -property-value +The key and [NamedResource](namedresource.md) key-value pair for the current item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapiterator_getmany_1824066844.md b/windows.applicationmodel.resources.core/resourcemapiterator_getmany_1824066844.md index fd04abff86..263d210b25 100644 --- a/windows.applicationmodel.resources.core/resourcemapiterator_getmany_1824066844.md +++ b/windows.applicationmodel.resources.core/resourcemapiterator_getmany_1824066844.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.GetMany(Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.ApplicationModel.Resources.Core.NamedResource}[]) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapIterator.GetMany ## -description Returns all the items in the [ResourceMap](resourcemap.md). ## -parameters ### -param items The items in the map. ## -returns The number of items in the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.GetMany(Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.ApplicationModel.Resources.Core.NamedResource}[]) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapIterator.GetMany + +## -description +Returns all the items in the [ResourceMap](resourcemap.md). + +## -parameters +### -param items +The items in the map. + +## -returns +The number of items in the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapiterator_hascurrent.md b/windows.applicationmodel.resources.core/resourcemapiterator_hascurrent.md index 3b2ca738e2..8115aaf9e3 100644 --- a/windows.applicationmodel.resources.core/resourcemapiterator_hascurrent.md +++ b/windows.applicationmodel.resources.core/resourcemapiterator_hascurrent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.HasCurrent --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMapIterator.HasCurrent ## -description Gets a value that indicates whether there is a current item, or whether the iterator is at the end of the [ResourceMap](resourcemap.md). ## -property-value **TRUE** if the iterator refers to a valid item that is in the map, and otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.HasCurrent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapIterator.HasCurrent + +## -description +Gets a value that indicates whether there is a current item, or whether the iterator is at the end of the [ResourceMap](resourcemap.md). + +## -property-value + **TRUE** if the iterator refers to a valid item that is in the map, and otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapiterator_movenext_1926573527.md b/windows.applicationmodel.resources.core/resourcemapiterator_movenext_1926573527.md index f741971bc3..a522c7dbdd 100644 --- a/windows.applicationmodel.resources.core/resourcemapiterator_movenext_1926573527.md +++ b/windows.applicationmodel.resources.core/resourcemapiterator_movenext_1926573527.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.MoveNext --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapIterator.MoveNext ## -description Moves the iterator forward to the next item and returns [HasCurrent](resourcemapiterator_hascurrent.md). ## -returns **TRUE** if the iterator refers to a valid item that is in the map, and otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapIterator.MoveNext +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapIterator.MoveNext + +## -description +Moves the iterator forward to the next item and returns [HasCurrent](resourcemapiterator_hascurrent.md). + +## -returns + **TRUE** if the iterator refers to a valid item that is in the map, and otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapview_first_1920739956.md b/windows.applicationmodel.resources.core/resourcemapmapview_first_1920739956.md index bc7f2f82bb..ab0140b78e 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapview_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcemapmapview_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapView.First ## -description Returns an iterator to enumerate the items in the map view. ## -returns The iterator. The current position of the iterator is index 0, or the end of the map if the map is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapView.First + +## -description +Returns an iterator to enumerate the items in the map view. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the map if the map is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapview_haskey_425964900.md b/windows.applicationmodel.resources.core/resourcemapmapview_haskey_425964900.md index 0d261c088f..6440991e66 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapview_haskey_425964900.md +++ b/windows.applicationmodel.resources.core/resourcemapmapview_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.HasKey(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapView.HasKey ## -description Determines whether the map view contains the specified key. ## -parameters ### -param key The key to locate in the map view. ## -returns **TRUE** if the key is found, otherwise **FALSE** if it is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapView.HasKey + +## -description +Determines whether the map view contains the specified key. + +## -parameters +### -param key +The key to locate in the map view. + +## -returns + **TRUE** if the key is found, otherwise **FALSE** if it is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapview_lookup_711408188.md b/windows.applicationmodel.resources.core/resourcemapmapview_lookup_711408188.md index 309a6cb7c1..c4626b4bab 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapview_lookup_711408188.md +++ b/windows.applicationmodel.resources.core/resourcemapmapview_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Lookup(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Lookup ## -description Returns the [ResourceMap](resourcemap.md) at the specified key in the map view. ## -parameters ### -param key The key to locate in the map view. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Lookup + +## -description +Returns the [ResourceMap](resourcemap.md) at the specified key in the map view. + +## -parameters +### -param key +The key to locate in the map view. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapview_size.md b/windows.applicationmodel.resources.core/resourcemapmapview_size.md index ad8ad05135..12b0bc4665 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapview_size.md +++ b/windows.applicationmodel.resources.core/resourcemapmapview_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Size ## -description Gets the number of [ResourceMap](resourcemap.md) objects in the map. ## -property-value The number of [ResourceMap](resourcemap.md) objects in the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Size + +## -description +Gets the number of [ResourceMap](resourcemap.md) objects in the map. + +## -property-value +The number of [ResourceMap](resourcemap.md) objects in the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapview_split_1683756140.md b/windows.applicationmodel.resources.core/resourcemapmapview_split_1683756140.md index 39a231af65..a22adf63a3 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapview_split_1683756140.md +++ b/windows.applicationmodel.resources.core/resourcemapmapview_split_1683756140.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Split(Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.ResourceMap}@,Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.ResourceMap}@) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Split ## -description Splits the map view into two views. ## -parameters ### -param first One half of the original map. ### -param second The second half of the original map. ## -remarks The two views that result from the split operation might not contain the same number of items. The two views do not overlap. If a view can't be split, then both the first and second parameter are **NULL**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Split(Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.ResourceMap}@,Windows.Foundation.Collections.IMapView{System.String,Windows.ApplicationModel.Resources.Core.ResourceMap}@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapView.Split + +## -description +Splits the map view into two views. + +## -parameters +### -param first +One half of the original map. + +### -param second +The second half of the original map. + +## -remarks +The two views that result from the split operation might not contain the same number of items. The two views do not overlap. + +If a view can't be split, then both the first and second parameter are **NULL**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_current.md b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_current.md index 3dbd86e7d8..555c61be72 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_current.md +++ b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_current.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.Current --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.Current ## -description Gets the current item in the [ResourceMapMapView](resourcemapmapview.md). ## -property-value The key and [ResourceMap](resourcemap.md) key-value pair for the current item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.Current +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.Current + +## -description +Gets the current item in the [ResourceMapMapView](resourcemapmapview.md). + +## -property-value +The key and [ResourceMap](resourcemap.md) key-value pair for the current item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_getmany_837095832.md b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_getmany_837095832.md index 5e8ab2a9a9..ec51aeea98 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_getmany_837095832.md +++ b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_getmany_837095832.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.GetMany(Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.ApplicationModel.Resources.Core.ResourceMap}[]) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.GetMany ## -description Returns all the items in the [ResourceMapMapView](resourcemapmapview.md). ## -parameters ### -param items The items in the map view. ## -returns The number of items in the map view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.GetMany(Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.ApplicationModel.Resources.Core.ResourceMap}[]) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.GetMany + +## -description +Returns all the items in the [ResourceMapMapView](resourcemapmapview.md). + +## -parameters +### -param items +The items in the map view. + +## -returns +The number of items in the map view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_hascurrent.md b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_hascurrent.md index 1253fb3c48..8eae0dfdd9 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_hascurrent.md +++ b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_hascurrent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.HasCurrent --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.HasCurrent ## -description Gets a value that indicates whether there is a current item, or whether the iterator is at the end of the [ResourceMapMapView](resourcemapmapview.md). ## -property-value **TRUE** if the iterator refers to a valid item that is in the map view, and otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.HasCurrent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.HasCurrent + +## -description +Gets a value that indicates whether there is a current item, or whether the iterator is at the end of the [ResourceMapMapView](resourcemapmapview.md). + +## -property-value + **TRUE** if the iterator refers to a valid item that is in the map view, and otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_movenext_1926573527.md b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_movenext_1926573527.md index 9ac4b53b5a..31c77e1c03 100644 --- a/windows.applicationmodel.resources.core/resourcemapmapviewiterator_movenext_1926573527.md +++ b/windows.applicationmodel.resources.core/resourcemapmapviewiterator_movenext_1926573527.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.MoveNext --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.MoveNext ## -description Moves the iterator forward to the next item and returns [HasCurrent](resourcemapmapviewiterator_hascurrent.md). ## -returns **TRUE** if the iterator refers to a valid item that is in the map view, and otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.MoveNext +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceMapMapViewIterator.MoveNext + +## -description +Moves the iterator forward to the next item and returns [HasCurrent](resourcemapmapviewiterator_hascurrent.md). + +## -returns + **TRUE** if the iterator refers to a valid item that is in the map view, and otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifier_isdefault.md b/windows.applicationmodel.resources.core/resourcequalifier_isdefault.md index 34daaee51f..75ebd0945d 100644 --- a/windows.applicationmodel.resources.core/resourcequalifier_isdefault.md +++ b/windows.applicationmodel.resources.core/resourcequalifier_isdefault.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsDefault --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsDefault ## -description Indicates whether this qualifier should be considered as a default match when no match is found. ## -property-value **TRUE** if this candidate can be used as a default fallback value for any context; otherwise, **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsDefault +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsDefault + +## -description +Indicates whether this qualifier should be considered as a default match when no match is found. + +## -property-value +**TRUE** if this candidate can be used as a default fallback value for any context; otherwise, **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifier_ismatch.md b/windows.applicationmodel.resources.core/resourcequalifier_ismatch.md index 285dafde7c..fd3442331f 100644 --- a/windows.applicationmodel.resources.core/resourcequalifier_ismatch.md +++ b/windows.applicationmodel.resources.core/resourcequalifier_ismatch.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsMatch --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsMatch ## -description Indicates whether a given qualifier for a given candidate matched the context when a named resource is resolved to a candidate for some given context. ## -property-value **TRUE** if this qualifier matched the environment against which it was evaluated; otherwise, **FALSE**. ## -remarks If a [ResourceQualifier](resourcequalifier.md) is obtained in a scenario that does not involve resolving a named resource for some context, the value is **FALSE**. (For example, when all candidates are enumerated for a named resource and their qualifiers are inspected.) After resolving a named resource for some context, [IsMatch](resourcequalifier_ismatch.md) is **TRUE** if the qualifier matches the context on a non-default basis (that is, the qualifier value is not designated as the default value for that qualifier). The score is non-zero, and [IsDefault](resourcequalifier_isdefault.md) is **FALSE**. After resolving a named resource for some context, [IsMatch](resourcequalifier_ismatch.md) is **FALSE** if the qualifier does not match the context on a non-default basis. (The qualifier value may or may not be the default value for that qualifier. The score may or may not be zero, according to whether the qualifier is the default value.) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsMatch +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifier.IsMatch + +## -description +Indicates whether a given qualifier for a given candidate matched the context when a named resource is resolved to a candidate for some given context. + +## -property-value +**TRUE** if this qualifier matched the environment against which it was evaluated; otherwise, **FALSE**. + +## -remarks +If a [ResourceQualifier](resourcequalifier.md) is obtained in a scenario that does not involve resolving a named resource for some context, the value is **FALSE**. (For example, when all candidates are enumerated for a named resource and their qualifiers are inspected.) + +After resolving a named resource for some context, [IsMatch](resourcequalifier_ismatch.md) is **TRUE** if the qualifier matches the context on a non-default basis (that is, the qualifier value is not designated as the default value for that qualifier). The score is non-zero, and [IsDefault](resourcequalifier_isdefault.md) is **FALSE**. + +After resolving a named resource for some context, [IsMatch](resourcequalifier_ismatch.md) is **FALSE** if the qualifier does not match the context on a non-default basis. (The qualifier value may or may not be the default value for that qualifier. The score may or may not be zero, according to whether the qualifier is the default value.) + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifier_qualifiername.md b/windows.applicationmodel.resources.core/resourcequalifier_qualifiername.md index 831da40fde..1db4725d9b 100644 --- a/windows.applicationmodel.resources.core/resourcequalifier_qualifiername.md +++ b/windows.applicationmodel.resources.core/resourcequalifier_qualifiername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierName --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierName ## -description The name of the qualifier. ## -property-value The name of the qualifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierName + +## -description +The name of the qualifier. + +## -property-value +The name of the qualifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifier_qualifiervalue.md b/windows.applicationmodel.resources.core/resourcequalifier_qualifiervalue.md index bf68381dbf..e25201d323 100644 --- a/windows.applicationmodel.resources.core/resourcequalifier_qualifiervalue.md +++ b/windows.applicationmodel.resources.core/resourcequalifier_qualifiervalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierValue --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierValue ## -description The value of the qualifier. ## -property-value The value of the qualifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierValue +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifier.QualifierValue + +## -description +The value of the qualifier. + +## -property-value +The value of the qualifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifier_score.md b/windows.applicationmodel.resources.core/resourcequalifier_score.md index 7614a93bb7..d1549e0686 100644 --- a/windows.applicationmodel.resources.core/resourcequalifier_score.md +++ b/windows.applicationmodel.resources.core/resourcequalifier_score.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.Score --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifier.Score ## -description A score that indicates how well the qualifier matched the context against which it was resolved. ## -property-value A score in the range 0.0– 1.0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifier.Score +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifier.Score + +## -description +A score that indicates how well the qualifier matched the context against which it was resolved. + +## -property-value +A score in the range 0.0– 1.0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiermapview_first_1920739956.md b/windows.applicationmodel.resources.core/resourcequalifiermapview_first_1920739956.md index cea5b52ef6..df98a5dd7e 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiermapview_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcequalifiermapview_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.First ## -description Returns an iterator to enumerate the items in the map view. ## -returns The iterator. The current position of the iterator is index 0, or the end of the map view if the map view is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.First + +## -description +Returns an iterator to enumerate the items in the map view. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the map view if the map view is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiermapview_haskey_425964900.md b/windows.applicationmodel.resources.core/resourcequalifiermapview_haskey_425964900.md index d7ad62deaa..dce3817997 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiermapview_haskey_425964900.md +++ b/windows.applicationmodel.resources.core/resourcequalifiermapview_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.HasKey(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.HasKey ## -description Determines whether the map view contains the specified key. ## -parameters ### -param key The key to locate in the map view. ## -returns **TRUE** if the key is found, otherwise **FALSE** if it is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.HasKey + +## -description +Determines whether the map view contains the specified key. + +## -parameters +### -param key +The key to locate in the map view. + +## -returns + **TRUE** if the key is found, otherwise **FALSE** if it is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiermapview_lookup_711408188.md b/windows.applicationmodel.resources.core/resourcequalifiermapview_lookup_711408188.md index 705c49e327..9f443b862c 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiermapview_lookup_711408188.md +++ b/windows.applicationmodel.resources.core/resourcequalifiermapview_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Lookup(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Lookup ## -description Returns the qualifier name at the specified key in the map view. ## -parameters ### -param key The key to locate in the map view. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Lookup + +## -description +Returns the qualifier name at the specified key in the map view. + +## -parameters +### -param key +The key to locate in the map view. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiermapview_size.md b/windows.applicationmodel.resources.core/resourcequalifiermapview_size.md index efee18aaac..59613575df 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiermapview_size.md +++ b/windows.applicationmodel.resources.core/resourcequalifiermapview_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Size ## -description Gets the number of [ResourceQualifier](resourcequalifier.md) objects in the map. ## -property-value The number of [ResourceQualifier](resourcequalifier.md) objects in the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Size + +## -description +Gets the number of [ResourceQualifier](resourcequalifier.md) objects in the map. + +## -property-value +The number of [ResourceQualifier](resourcequalifier.md) objects in the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiermapview_split_943498527.md b/windows.applicationmodel.resources.core/resourcequalifiermapview_split_943498527.md index 3d5bb7bbb9..8653efef11 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiermapview_split_943498527.md +++ b/windows.applicationmodel.resources.core/resourcequalifiermapview_split_943498527.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Split(Windows.Foundation.Collections.IMapView{System.String,System.String}@,Windows.Foundation.Collections.IMapView{System.String,System.String}@) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Split ## -description Splits the map view into two views. ## -parameters ### -param first One half of the original map. ### -param second The second half of the original map. ## -remarks The two views that result from the split operation might not contain the same number of items. The two views do not overlap. If a view can't be split, then both the first and second parameter are **NULL**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Split(Windows.Foundation.Collections.IMapView{System.String,System.String}@,Windows.Foundation.Collections.IMapView{System.String,System.String}@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierMapView.Split + +## -description +Splits the map view into two views. + +## -parameters +### -param first +One half of the original map. + +### -param second +The second half of the original map. + +## -remarks +The two views that result from the split operation might not contain the same number of items. The two views do not overlap. + +If a view can't be split, then both the first and second parameter are **NULL**. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_clear_556466.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_clear_556466.md index 11d0e62f30..f4a359095d 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_clear_556466.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Clear --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Clear ## -description Removes all items from the observable map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Clear +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Clear + +## -description +Removes all items from the observable map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_first_1920739956.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_first_1920739956.md index 6f1f5f7bd7..61aef029e2 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.First ## -description Returns an iterator to enumerate the items in the observable map. ## -returns The iterator. The current position of the iterator is index 0, or the end of the observable map if the observable map is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.First + +## -description +Returns an iterator to enumerate the items in the observable map. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the observable map if the observable map is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_getview_37498667.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_getview_37498667.md index 0effce31e9..6e1e797b25 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_getview_37498667.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.GetView --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.GetView ## -description Returns an unchangeable view of the observable map. ## -returns The view of the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.GetView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.GetView + +## -description +Returns an unchangeable view of the observable map. + +## -returns +The view of the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_haskey_425964900.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_haskey_425964900.md index 4082c30572..72cbf77a14 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_haskey_425964900.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.HasKey(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.HasKey ## -description Determines whether the observable map contains the specified key. ## -parameters ### -param key The key to locate in the observable map. ## -returns **TRUE** if the key is found, otherwise **FALSE** if it is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.HasKey + +## -description +Determines whether the observable map contains the specified key. + +## -parameters +### -param key +The key to locate in the observable map. + +## -returns + **TRUE** if the key is found, otherwise **FALSE** if it is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_insert_2006825190.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_insert_2006825190.md index ca8e39b02f..10cc66fd13 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_insert_2006825190.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_insert_2006825190.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Insert(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Insert ## -description Inserts or replaces an item in the observable map. ## -parameters ### -param key The key associated with the item to insert. ### -param value The item to insert. ## -returns **TRUE** if an item with the specified key is an existing item and was replaced, otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Insert(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Insert + +## -description +Inserts or replaces an item in the observable map. + +## -parameters +### -param key +The key associated with the item to insert. + +### -param value +The item to insert. + +## -returns + **TRUE** if an item with the specified key is an existing item and was replaced, otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_lookup_711408188.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_lookup_711408188.md index cc7be0eec8..0db50a7e08 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_lookup_711408188.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Lookup(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Lookup ## -description Returns the qualifier name at the specified key in the observable map. ## -parameters ### -param key The key to locate in the observable map. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Lookup + +## -description +Returns the qualifier name at the specified key in the observable map. + +## -parameters +### -param key +The key to locate in the observable map. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_mapchanged.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_mapchanged.md index c13a4c1904..f0a5552a37 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_mapchanged.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_mapchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.MapChanged --api-type: winrt event ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.MapChanged ## -description Occurs when the map changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.MapChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.MapChanged + +## -description +Occurs when the map changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_remove_1498489487.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_remove_1498489487.md index 808743b6c8..dd5c855c14 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_remove_1498489487.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_remove_1498489487.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Remove(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Remove ## -description Removes an item from the observable map. ## -parameters ### -param key The key associated with the item to remove. ## -remarks For the C# and Microsoft Visual Basic version of the **Remove(String)** method, see [Remove](resourcequalifierobservablemap_remove_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Remove + +## -description +Removes an item from the observable map. + +## -parameters +### -param key +The key associated with the item to remove. + +## -remarks +For the C# and Microsoft Visual Basic version of the **Remove(String)** method, see [Remove](resourcequalifierobservablemap_remove_2.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_size.md b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_size.md index 1fe817c35d..516377c1cc 100644 --- a/windows.applicationmodel.resources.core/resourcequalifierobservablemap_size.md +++ b/windows.applicationmodel.resources.core/resourcequalifierobservablemap_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Size ## -description Gets the number of [ResourceQualifier](resourcequalifier.md) objects in the observable map. ## -property-value The number of [ResourceQualifier](resourcequalifier.md) objects in the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierObservableMap.Size + +## -description +Gets the number of [ResourceQualifier](resourcequalifier.md) objects in the observable map. + +## -property-value +The number of [ResourceQualifier](resourcequalifier.md) objects in the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiervectorview_first_1920739956.md b/windows.applicationmodel.resources.core/resourcequalifiervectorview_first_1920739956.md index 9396d6d9cc..d8b1cee060 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiervectorview_first_1920739956.md +++ b/windows.applicationmodel.resources.core/resourcequalifiervectorview_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.First --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.First ## -description Returns an iterator to enumerate the items in the view. ## -returns The iterator. The current position of the iterator is index 0, or the end of the view if the view is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.First +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.First + +## -description +Returns an iterator to enumerate the items in the view. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the view if the view is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiervectorview_getat_496709656.md b/windows.applicationmodel.resources.core/resourcequalifiervectorview_getat_496709656.md index bfa656f8dd..f5c11176da 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiervectorview_getat_496709656.md +++ b/windows.applicationmodel.resources.core/resourcequalifiervectorview_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetAt ## -description Returns the [ResourceQualifier](resourcequalifier.md) at the specified index in the view. ## -parameters ### -param index The zero-based index of the [ResourceQualifier](resourcequalifier.md) in the view to return. ## -returns The [ResourceQualifier](resourcequalifier.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetAt + +## -description +Returns the [ResourceQualifier](resourcequalifier.md) at the specified index in the view. + +## -parameters +### -param index +The zero-based index of the [ResourceQualifier](resourcequalifier.md) in the view to return. + +## -returns +The [ResourceQualifier](resourcequalifier.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiervectorview_getmany_53076972.md b/windows.applicationmodel.resources.core/resourcequalifiervectorview_getmany_53076972.md index 44f3f37438..e280d2e9c4 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiervectorview_getmany_53076972.md +++ b/windows.applicationmodel.resources.core/resourcequalifiervectorview_getmany_53076972.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetMany(System.UInt32,Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetMany ## -description Returns the [ResourceQualifier](resourcequalifier.md) objects that start at the specified index in the view. ## -parameters ### -param startIndex The zero-based index of the start of the objects in the view to return. ### -param items The objects in the view that start at *startIndex*. ## -returns The number of objects returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetMany(System.UInt32,Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.GetMany + +## -description +Returns the [ResourceQualifier](resourcequalifier.md) objects that start at the specified index in the view. + +## -parameters +### -param startIndex +The zero-based index of the start of the objects in the view to return. + +### -param items +The objects in the view that start at *startIndex*. + +## -returns +The number of objects returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiervectorview_indexof_1848059625.md b/windows.applicationmodel.resources.core/resourcequalifiervectorview_indexof_1848059625.md index 10ea4d9227..28e1f94c5d 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiervectorview_indexof_1848059625.md +++ b/windows.applicationmodel.resources.core/resourcequalifiervectorview_indexof_1848059625.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.IndexOf(Windows.ApplicationModel.Resources.Core.ResourceQualifier,System.UInt32@) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.IndexOf ## -description Returns the index of a specified [ResourceQualifier](resourcequalifier.md) in the view. ## -parameters ### -param value The [ResourceQualifier](resourcequalifier.md) to find in the set. ### -param index The zero-based index of the object, if found. The method returns zero if the object is not found. ## -returns A Boolean that is **TRUE** if the object is found, otherwise **FALSE** if the object is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.IndexOf(Windows.ApplicationModel.Resources.Core.ResourceQualifier,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.IndexOf + +## -description +Returns the index of a specified [ResourceQualifier](resourcequalifier.md) in the view. + +## -parameters +### -param value +The [ResourceQualifier](resourcequalifier.md) to find in the set. + +### -param index +The zero-based index of the object, if found. The method returns zero if the object is not found. + +## -returns +A Boolean that is **TRUE** if the object is found, otherwise **FALSE** if the object is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.core/resourcequalifiervectorview_size.md b/windows.applicationmodel.resources.core/resourcequalifiervectorview_size.md index bcc6422fec..e3bc3ea3dd 100644 --- a/windows.applicationmodel.resources.core/resourcequalifiervectorview_size.md +++ b/windows.applicationmodel.resources.core/resourcequalifiervectorview_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.Size --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.Size ## -description Gets the number of [ResourceQualifier](resourcequalifier.md) objects in the view. ## -property-value The number of objects in the view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.Size +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Core.ResourceQualifierVectorView.Size + +## -description +Gets the number of [ResourceQualifier](resourcequalifier.md) objects in the view. + +## -property-value +The number of objects in the view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate.md b/windows.applicationmodel.resources.management/indexedresourcecandidate.md index b39061b3c2..d5f7392dec 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate --api-type: winrt class ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate ## -description Represents a single possible value for a given resource, and the qualifiers associated with that resource. > [!IMPORTANT] > You can't use this class in a Windows Store app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate + +## -description +Represents a single possible value for a given resource, and the qualifiers associated with that resource. + +> [!IMPORTANT] +> You can't use this class in a Windows Store app. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate_getqualifiervalue_1263542058.md b/windows.applicationmodel.resources.management/indexedresourcecandidate_getqualifiervalue_1263542058.md index a480384b44..1ca58098e7 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate_getqualifiervalue_1263542058.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate_getqualifiervalue_1263542058.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.GetQualifierValue(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.GetQualifierValue ## -description Returns the value of a qualifier, given its name. ## -parameters ### -param qualifierName The name of the qualifier. ## -returns The value of the qualifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.GetQualifierValue(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.GetQualifierValue + +## -description +Returns the value of a qualifier, given its name. + +## -parameters +### -param qualifierName +The name of the qualifier. + +## -returns +The value of the qualifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate_metadata.md b/windows.applicationmodel.resources.management/indexedresourcecandidate_metadata.md index 0fcbad7c0a..50d511dd07 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate_metadata.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate_metadata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Metadata --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Metadata ## -description Gets the list of metadata name value pairs. ## -property-value A list of string pairs, each containing the name of an [IndexedResourceQualifier](indexedresourcequalifier.md) and its value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Metadata +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Metadata + +## -description +Gets the list of metadata name value pairs. + +## -property-value +A list of string pairs, each containing the name of an [IndexedResourceQualifier](indexedresourcequalifier.md) and its value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate_qualifiers.md b/windows.applicationmodel.resources.management/indexedresourcecandidate_qualifiers.md index ce8a7db2f2..00e16414d4 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate_qualifiers.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate_qualifiers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Qualifiers --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Qualifiers ## -description Gets the list of [IndexedResourceQualifier](indexedresourcequalifier.md) s. ## -property-value A list of [IndexedResourceQualifier](indexedresourcequalifier.md) s. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Qualifiers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Qualifiers + +## -description +Gets the list of [IndexedResourceQualifier](indexedresourcequalifier.md) s. + +## -property-value +A list of [IndexedResourceQualifier](indexedresourcequalifier.md) s. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate_type.md b/windows.applicationmodel.resources.management/indexedresourcecandidate_type.md index fe084ff2e1..1bac3e673c 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate_type.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Type --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Type ## -description Gets the type property that determines whether the resource is a file or a string. ## -property-value A value from the [IndexedResourceType](indexedresourcetype.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Type +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Type + +## -description +Gets the type property that determines whether the resource is a file or a string. + +## -property-value +A value from the [IndexedResourceType](indexedresourcetype.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate_uri.md b/windows.applicationmodel.resources.management/indexedresourcecandidate_uri.md index 69092d048c..8639ec2fe4 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate_uri.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate_uri.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Uri --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Uri ## -description Gets the named resource [Uri](../windows.foundation/uri.md). ## -property-value The named resource [Uri](../windows.foundation/uri.md). ## -remarks *Uri* is an ms-resource: URI representing the named resource for the candidate, where the authority of the URI or the resource map is empty (for example, ms-resource:///Resources/String1 or ms-resource:///Files/images/logo.png). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.Uri + +## -description +Gets the named resource [Uri](../windows.foundation/uri.md). + +## -property-value +The named resource [Uri](../windows.foundation/uri.md). + +## -remarks +*Uri* is an ms-resource: URI representing the named resource for the candidate, where the authority of the URI or the resource map is empty (for example, ms-resource:///Resources/String1 or ms-resource:///Files/images/logo.png). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcecandidate_valueasstring.md b/windows.applicationmodel.resources.management/indexedresourcecandidate_valueasstring.md index 04938ff466..8b176b26c1 100644 --- a/windows.applicationmodel.resources.management/indexedresourcecandidate_valueasstring.md +++ b/windows.applicationmodel.resources.management/indexedresourcecandidate_valueasstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.ValueAsString --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.ValueAsString ## -description Gets the value of the candidate as a [String](https://msdn.microsoft.com/library/system.string.aspx). ## -property-value If the candidate is a file, the value is a file path (such as "images\logo.scale-100.png") relative to the project root passed to the [ResourceIndexer constructor](resourceindexer_resourceindexer.md). If the candidate is a string, the value is the actual string (such as "Hello World"). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.ValueAsString +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate.ValueAsString + +## -description +Gets the value of the candidate as a [String](https://msdn.microsoft.com/library/system.string.aspx). + +## -property-value +If the candidate is a file, the value is a file path (such as "images\logo.scale-100.png") relative to the project root passed to the [ResourceIndexer constructor](resourceindexer_resourceindexer.md). If the candidate is a string, the value is the actual string (such as "Hello World"). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcequalifier.md b/windows.applicationmodel.resources.management/indexedresourcequalifier.md index 793067a182..31f3972468 100644 --- a/windows.applicationmodel.resources.management/indexedresourcequalifier.md +++ b/windows.applicationmodel.resources.management/indexedresourcequalifier.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier --api-type: winrt class ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier ## -description Represents an object that declares under what context a resource is appropriate. > [!IMPORTANT] > You can't use this class in a Windows Store app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier + +## -description +Represents an object that declares under what context a resource is appropriate. + +> [!IMPORTANT] +> You can't use this class in a Windows Store app. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiername.md b/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiername.md index e980209838..f36122b8c0 100644 --- a/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiername.md +++ b/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierName --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierName ## -description Gets the name of the qualifier. ## -property-value The name of the qualifier, such as "language", "contrast", or "scale". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierName + +## -description +Gets the name of the qualifier. + +## -property-value +The name of the qualifier, such as "language", "contrast", or "scale". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiervalue.md b/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiervalue.md index 169bbec5ac..04076d40bd 100644 --- a/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiervalue.md +++ b/windows.applicationmodel.resources.management/indexedresourcequalifier_qualifiervalue.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierValue --api-type: winrt property ---- # Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierValue ## -description Gets the value of the qualifier. ## -property-value The value of the qualifier. The case of the qualifier value should be preserved from the first instance of the qualifier discovered during indexing. Examples of the qualifier value are: + "100", "140", or "180" for scale. + "fr-FR" for language. + "high" for contrast. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierValue +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Resources.Management.IndexedResourceQualifier.QualifierValue + +## -description +Gets the value of the qualifier. + +## -property-value +The value of the qualifier. The case of the qualifier value should be preserved from the first instance of the qualifier discovered during indexing. + + +Examples of the qualifier value are: + ++ "100", "140", or "180" for scale. ++ "fr-FR" for language. ++ "high" for contrast. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/resourceindexer.md b/windows.applicationmodel.resources.management/resourceindexer.md index 8f9caf58e7..01a5ee8470 100644 --- a/windows.applicationmodel.resources.management/resourceindexer.md +++ b/windows.applicationmodel.resources.management/resourceindexer.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Resources.Management.ResourceIndexer --api-type: winrt class ---- # Windows.ApplicationModel.Resources.Management.ResourceIndexer ## -description Indexes source resource files or containers, and generates named resource candidates using particular file and folder naming conventions. > [!IMPORTANT] > You can't use this class in a Windows Store app. ## -remarks [ResourceIndexer](resourceindexer.md) does not guarantee parity of discovered resource candidates with MakePRI.exe because MakePRI may have arbitrary configurations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Resources.Management.ResourceIndexer +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Resources.Management.ResourceIndexer + +## -description +Indexes source resource files or containers, and generates named resource candidates using particular file and folder naming conventions. + +> [!IMPORTANT] +> You can't use this class in a Windows Store app. + +## -remarks +[ResourceIndexer](resourceindexer.md) does not guarantee parity of discovered resource candidates with MakePRI.exe because MakePRI may have arbitrary configurations. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/resourceindexer_indexfilecontentsasync_1153863711.md b/windows.applicationmodel.resources.management/resourceindexer_indexfilecontentsasync_1153863711.md index 59f90183db..ffdae0fa34 100644 --- a/windows.applicationmodel.resources.management/resourceindexer_indexfilecontentsasync_1153863711.md +++ b/windows.applicationmodel.resources.management/resourceindexer_indexfilecontentsasync_1153863711.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFileContentsAsync(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFileContentsAsync ## -description Indexes a ResW, ResJSON, PRI, or PRI XML dump file path for file and folder naming conventions, and applies the qualifiers to the resources found within the contents of the file. ## -parameters ### -param file The file to be indexed (file:// URI). The path must be an absolute path with the drive letter specified. The [Uri](../windows.foundation/uri.md) can also provide an empty authority which is assumed to be the local file system. Long file paths are not supported. ## -returns A list of [IndexedResourceCandidate](indexedresourcecandidate.md) objects found within *file*. This is an empty list if nothing is found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFileContentsAsync(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFileContentsAsync + +## -description +Indexes a ResW, ResJSON, PRI, or PRI XML dump file path for file and folder naming conventions, and applies the qualifiers to the resources found within the contents of the file. + +## -parameters +### -param file +The file to be indexed (file:// URI). The path must be an absolute path with the drive letter specified. The [Uri](../windows.foundation/uri.md) can also provide an empty authority which is assumed to be the local file system. Long file paths are not supported. + +## -returns +A list of [IndexedResourceCandidate](indexedresourcecandidate.md) objects found within *file*. This is an empty list if nothing is found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/resourceindexer_indexfilepath_1122402385.md b/windows.applicationmodel.resources.management/resourceindexer_indexfilepath_1122402385.md index 9e63ac8795..919cd35830 100644 --- a/windows.applicationmodel.resources.management/resourceindexer_indexfilepath_1122402385.md +++ b/windows.applicationmodel.resources.management/resourceindexer_indexfilepath_1122402385.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFilePath(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFilePath ## -description Indexes a file path for file and folder naming conventions. ## -parameters ### -param filePath The file to be indexed (file:// URI). The path must be an absolute path with the drive letter specified. The [Uri](../windows.foundation/uri.md) can also provide an empty authority which is assumed to be the local file system. Long file paths are not supported. ## -returns An [IndexedResourceCandidate](indexedresourcecandidate.md) object that represents the indexed file resource. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFilePath(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Management.ResourceIndexer.IndexFilePath + +## -description +Indexes a file path for file and folder naming conventions. + +## -parameters +### -param filePath +The file to be indexed (file:// URI). The path must be an absolute path with the drive letter specified. The [Uri](../windows.foundation/uri.md) can also provide an empty authority which is assumed to be the local file system. Long file paths are not supported. + +## -returns +An [IndexedResourceCandidate](indexedresourcecandidate.md) object that represents the indexed file resource. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_843413386.md b/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_843413386.md index 0bed3b1bbf..9e6e50941f 100644 --- a/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_843413386.md +++ b/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_843413386.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.#ctor(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Management.ResourceIndexer.ResourceIndexer ## -description Creates a new [ResourceIndexer](resourceindexer.md) specifying the root of the project files. ## -parameters ### -param projectRoot The project root folder (file:// URI). ## -remarks The parameter *projectRoot* represents the root of the project for the files to be produced. This is used to determine file paths relative to the package that will contain them. The path must be an absolute path with the drive letter specified. Long file paths are not supported. Example: ```csharp var idxr = new Windows.ApplicationModel.Resources.Management.ResourceIndexer( new Uri("file:///C:\MyApp\")); ``` ## -examples ## -see-also [ResourceIndexer(Uri, Uri)](resourceindexer_resourceindexer_950603582.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.#ctor(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Management.ResourceIndexer.ResourceIndexer + +## -description +Creates a new [ResourceIndexer](resourceindexer.md) specifying the root of the project files. + +## -parameters +### -param projectRoot +The project root folder (file:// URI). + + + +## -remarks +The parameter *projectRoot* represents the root of the project for the files to be produced. This is used to determine file paths relative to the package that will contain them. + +The path must be an absolute path with the drive letter specified. Long file paths are not supported. + + + +Example: + +```csharp +var idxr = new Windows.ApplicationModel.Resources.Management.ResourceIndexer( + new Uri("file:///C:\MyApp\")); + +``` + + + +## -examples + +## -see-also +[ResourceIndexer(Uri, Uri)](resourceindexer_resourceindexer_950603582.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_950603582.md b/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_950603582.md index c2c90ca11f..b0338ae38d 100644 --- a/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_950603582.md +++ b/windows.applicationmodel.resources.management/resourceindexer_resourceindexer_950603582.md @@ -1,3 +1,45 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.#ctor(Windows.Foundation.Uri,Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.Management.ResourceIndexer.ResourceIndexer ## -description Creates a new [ResourceIndexer](resourceindexer.md) specifying the root of the project files and an extension DLL. ## -parameters ### -param projectRoot The project root folder (file:// URI). ### -param extensionDllPath The extension DLL path (file:// URI). ## -remarks The parameter *projectRoot* represents the root of the project for the files to be produced. This is used to determine file paths relative to the package that will contain them. The parameter *extensionDllPath* represents a full path to an extension DLL that is Microsoft-signed and implements the ext-ms-win-mrmcorer-environment-l1 API set. This determines the file path from where the MRT environment extension DLL will be loaded. The paths must be absolute paths with the drive letter specified. Long file paths are not supported. This example shows the constructor used to index source assets intended for a Windows Phone project: ```csharp var idxr = new Windows.ApplicationModel.Resources.Management.ResourceIndexer( new Uri("file:///C:\MyApp\"), new Uri("file:///C:\WPSDKPATH\bin\MrmEnvironmentExtDl.dll")); ``` ## -examples ## -see-also [ResourceIndexer(Uri)](resourceindexer_resourceindexer_843413386.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.Management.ResourceIndexer.#ctor(Windows.Foundation.Uri,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.Management.ResourceIndexer.ResourceIndexer + +## -description +Creates a new [ResourceIndexer](resourceindexer.md) specifying the root of the project files and an extension DLL. + +## -parameters +### -param projectRoot +The project root folder (file:// URI). + +### -param extensionDllPath +The extension DLL path (file:// URI). + +## -remarks +The parameter *projectRoot* represents the root of the project for the files to be produced. This is used to determine file paths relative to the package that will contain them. + +The parameter *extensionDllPath* represents a full path to an extension DLL that is Microsoft-signed and implements the ext-ms-win-mrmcorer-environment-l1 API set. This determines the file path from where the MRT environment extension DLL will be loaded. + +The paths must be absolute paths with the drive letter specified. Long file paths are not supported. + + + +This example shows the constructor used to index source assets intended for a Windows Phone project: + +```csharp +var idxr = new Windows.ApplicationModel.Resources.Management.ResourceIndexer( + new Uri("file:///C:\MyApp\"), + new Uri("file:///C:\WPSDKPATH\bin\MrmEnvironmentExtDl.dll")); + +``` + + + +## -examples + +## -see-also +[ResourceIndexer(Uri)](resourceindexer_resourceindexer_843413386.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getforcurrentview_1363600702.md b/windows.applicationmodel.resources/resourceloader_getforcurrentview_1363600702.md index 6a05ce53da..4267de3bb5 100644 --- a/windows.applicationmodel.resources/resourceloader_getforcurrentview_1363600702.md +++ b/windows.applicationmodel.resources/resourceloader_getforcurrentview_1363600702.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView ## -description Gets a [ResourceLoader](resourceloader.md) object for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context associated with the current view. ## -returns A resource loader for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). ## -remarks This method allows access relative to a resource file named "resources" (resources.resjson or resources.resw). The [ResourceLoader](resourceloader.md) that is returned uses a default context associated with the current view. The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. A [ResourceLoader](resourceloader.md) has an implicit context that is used when [ResourceLoader](resourceloader.md) methods are used to retrieve a resource. Since a [ResourceLoader](resourceloader.md) has an implicit context, and since the scale qualifier of contexts is dependent on an associated view, a [ResourceLoader](resourceloader.md) must be associated with a particular view. ### Errors This method fails with an exception if it is called in a windowless thread, or if the main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) does not have a "resources" subtree. ## -examples ## -see-also [GetForCurrentView(String)](resourceloader_getforcurrentview_147266590.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView + +## -description +Gets a [ResourceLoader](resourceloader.md) object for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context associated with the current view. + +## -returns +A resource loader for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). + +## -remarks +This method allows access relative to a resource file named "resources" (resources.resjson or resources.resw). The [ResourceLoader](resourceloader.md) that is returned uses a default context associated with the current view. + +The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. + +A [ResourceLoader](resourceloader.md) has an implicit context that is used when [ResourceLoader](resourceloader.md) methods are used to retrieve a resource. Since a [ResourceLoader](resourceloader.md) has an implicit context, and since the scale qualifier of contexts is dependent on an associated view, a [ResourceLoader](resourceloader.md) must be associated with a particular view. + +### Errors + +This method fails with an exception if it is called in a windowless thread, or if the main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) does not have a "resources" subtree. + +## -examples + +## -see-also +[GetForCurrentView(String)](resourceloader_getforcurrentview_147266590.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getforcurrentview_147266590.md b/windows.applicationmodel.resources/resourceloader_getforcurrentview_147266590.md index 32de9ec399..0dcc64ce5f 100644 --- a/windows.applicationmodel.resources/resourceloader_getforcurrentview_147266590.md +++ b/windows.applicationmodel.resources/resourceloader_getforcurrentview_147266590.md @@ -1,3 +1,43 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView ## -description Gets a [ResourceLoader](resourceloader.md) object for the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context associated with the current view. ## -parameters ### -param name The resource identifier of the [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) that the new resource loader uses for unqualified resource references. The loader can then retrieve resources relative to those references. > [!NOTE] > The resource identifier is treated as a Uniform Resource Identifier (URI) fragment, subject to Uniform Resource Identifier (URI) semantics. For example, "Caption%20" is treated as "Caption ". Do not use "?" or "#" in resource identifiers, as they terminate the named resource path. For example, "Foo?3" is treated as "Foo". ## -returns A resource loader for the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). ## -remarks This method is typically used to access resources relative to a resource file with the specified resource identifier. For example, `GetForCurrentView('Errors');` is relative to errors.resjson or errors.resw. To construct a resource loader for resources from a library package, a resource reference Uniform Resource Identifier (URI) is used. The [ResourceLoader](resourceloader.md) that is returned uses a default context associated with the current view. The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. A [ResourceLoader](resourceloader.md) has an implicit context that is used when [ResourceLoader](resourceloader.md) methods are used to retrieve a resource. Since a [ResourceLoader](resourceloader.md) has an implicit context, and since the scale qualifier of contexts is dependent on an associated view, a [ResourceLoader](resourceloader.md) must be associated with a particular view. ### Errors This method fails with an exception if it is called in a windowless thread, or if the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) cannot be found. ## -examples ## -see-also [GetForCurrentView](resourceloader_getforcurrentview_1363600702.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetForCurrentView + +## -description +Gets a [ResourceLoader](resourceloader.md) object for the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context associated with the current view. + +## -parameters +### -param name +The resource identifier of the [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) that the new resource loader uses for unqualified resource references. The loader can then retrieve resources relative to those references. + +> [!NOTE] +> The resource identifier is treated as a Uniform Resource Identifier (URI) fragment, subject to Uniform Resource Identifier (URI) semantics. For example, "Caption%20" is treated as "Caption ". Do not use "?" or "#" in resource identifiers, as they terminate the named resource path. For example, "Foo?3" is treated as "Foo". + +## -returns +A resource loader for the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). + +## -remarks +This method is typically used to access resources relative to a resource file with the specified resource identifier. For example, `GetForCurrentView('Errors');` is relative to errors.resjson or errors.resw. + +To construct a resource loader for resources from a library package, a resource reference Uniform Resource Identifier (URI) is used. + +The [ResourceLoader](resourceloader.md) that is returned uses a default context associated with the current view. + +The resource management system for Windows Store app supports the tailoring of resources for scale. Starting in Windows 8.1, different views owned by an app are able to display simultaneously on different display devices that may use different scales. In this way, scale is a per-view characteristic. + +A [ResourceLoader](resourceloader.md) has an implicit context that is used when [ResourceLoader](resourceloader.md) methods are used to retrieve a resource. Since a [ResourceLoader](resourceloader.md) has an implicit context, and since the scale qualifier of contexts is dependent on an associated view, a [ResourceLoader](resourceloader.md) must be associated with a particular view. + +### Errors + +This method fails with an exception if it is called in a windowless thread, or if the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) cannot be found. + +## -examples + +## -see-also +[GetForCurrentView](resourceloader_getforcurrentview_1363600702.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_1317372352.md b/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_1317372352.md index ba31a450dd..383d8caf39 100644 --- a/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_1317372352.md +++ b/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_1317372352.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse ## -description Gets a [ResourceLoader](resourceloader.md) object for the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. ## -parameters ### -param name The resource identifier of the [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) that the new resource loader uses for unqualified resource references. The loader can then retrieve resources relative to those references. > [!NOTE] > The resource identifier is treated as a Uniform Resource Identifier (URI) fragment, subject to Uniform Resource Identifier (URI) semantics. For example, "Caption%20" is treated as "Caption ". Do not use "?" or "#" in resource identifiers, as they terminate the named resource path. For example, "Foo?3" is treated as "Foo". ## -returns A resource loader for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. You can't use this [ResourceLoader](resourceloader.md) to retrieve any resource that has resource candidates qualified for scale. ## -remarks ## -examples ## -see-also [GetForViewIndependentUse](resourceloader_getforviewindependentuse_386169056.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse + +## -description +Gets a [ResourceLoader](resourceloader.md) object for the specified [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. + +## -parameters +### -param name +The resource identifier of the [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md) that the new resource loader uses for unqualified resource references. The loader can then retrieve resources relative to those references. + +> [!NOTE] +> The resource identifier is treated as a Uniform Resource Identifier (URI) fragment, subject to Uniform Resource Identifier (URI) semantics. For example, "Caption%20" is treated as "Caption ". Do not use "?" or "#" in resource identifiers, as they terminate the named resource path. For example, "Foo?3" is treated as "Foo". + +## -returns +A resource loader for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. You can't use this [ResourceLoader](resourceloader.md) to retrieve any resource that has resource candidates qualified for scale. + +## -remarks + +## -examples + +## -see-also +[GetForViewIndependentUse](resourceloader_getforviewindependentuse_386169056.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_386169056.md b/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_386169056.md index 6b7cd70c75..3999567c58 100644 --- a/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_386169056.md +++ b/windows.applicationmodel.resources/resourceloader_getforviewindependentuse_386169056.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse ## -description Gets a [ResourceLoader](resourceloader.md) object for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. ## -returns A resource loader for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. You can't use this [ResourceLoader](resourceloader.md) to retrieve any resource that has resource candidates qualified for scale. ## -remarks ## -examples ## -see-also [GetForViewIndependentUse(String)](resourceloader_getforviewindependentuse_1317372352.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse + +## -description +Gets a [ResourceLoader](resourceloader.md) object for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. + +## -returns +A resource loader for the [Resources subtree](../windows.applicationmodel.resources.core/resourcemap_getsubtree.md) of the currently running app's main [ResourceMap](../windows.applicationmodel.resources.core/resourcemap.md). This [ResourceLoader](resourceloader.md) uses a default context that's not associated with any view. You can't use this [ResourceLoader](resourceloader.md) to retrieve any resource that has resource candidates qualified for scale. + +## -remarks + +## -examples + +## -see-also +[GetForViewIndependentUse(String)](resourceloader_getforviewindependentuse_1317372352.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getstring_1647290392.md b/windows.applicationmodel.resources/resourceloader_getstring_1647290392.md index 581ba35954..8ee42c5a7e 100644 --- a/windows.applicationmodel.resources/resourceloader_getstring_1647290392.md +++ b/windows.applicationmodel.resources/resourceloader_getstring_1647290392.md @@ -1,3 +1,43 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetString(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetString ## -description Returns the most appropriate string value of a resource, specified by resource identifier, for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) of the view in which the [ResourceLoader](resourceloader.md) was obtained using [ResourceLoader.GetForCurrentView](resourceloader_getforcurrentview.md). ## -parameters ### -param resource The resource identifier of the resource to be resolved. > [!NOTE] > The resource identifier is treated as a Uniform Resource Identifier (URI) fragment, subject to Uniform Resource Identifier (URI) semantics. For example, **getString** ("Caption%20") is treated as **getString** ("Caption "). Do not use "?" or "#" in resource identifiers, as they terminate the named resource path. For example, "Foo?3" is treated as "Foo". ## -returns The most appropriate string value of the specified resource for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md). ## -remarks Example: ```javascript var string = resourceLoader.getString('Header1'); ``` ## -examples ## -see-also [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetString(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetString + +## -description +Returns the most appropriate string value of a resource, specified by resource identifier, for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) of the view in which the [ResourceLoader](resourceloader.md) was obtained using [ResourceLoader.GetForCurrentView](resourceloader_getforcurrentview.md). + + + + +## -parameters +### -param resource +The resource identifier of the resource to be resolved. + +> [!NOTE] +> The resource identifier is treated as a Uniform Resource Identifier (URI) fragment, subject to Uniform Resource Identifier (URI) semantics. For example, **getString** ("Caption%20") is treated as **getString** ("Caption "). Do not use "?" or "#" in resource identifiers, as they terminate the named resource path. For example, "Foo?3" is treated as "Foo". + +## -returns +The most appropriate string value of the specified resource for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md). + +## -remarks + + + +Example: + +```javascript +var string = resourceLoader.getString('Header1'); +``` + + + +## -examples + +## -see-also +[ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getstringforreference_421352214.md b/windows.applicationmodel.resources/resourceloader_getstringforreference_421352214.md index 9a60ff28d1..c6d50773ee 100644 --- a/windows.applicationmodel.resources/resourceloader_getstringforreference_421352214.md +++ b/windows.applicationmodel.resources/resourceloader_getstringforreference_421352214.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetStringForReference(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetStringForReference ## -description > [!NOTE] > GetStringForReference may be altered or unavailable for releases after Windows 8.1. Instead, use [GetStringForUri](resourceloader_getstringforuri.md). Returns the most appropriate string value of a resource, specified as a [Uri](../windows.foundation/uri.md) for a resource identifier, for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) of the currently running app. ## -parameters ### -param uri A [Uri](../windows.foundation/uri.md) that represents the resource to be retrieved. ## -returns The most appropriate string value of the specified resource for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md). ## -remarks [Uri](../windows.foundation/uri.md) objects require a scheme to be identified. In this context, the ms-resource scheme must be specified in the [Uri](../windows.foundation/uri.md) passed to the method. See [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96). ## -examples ## -see-also [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md), [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetStringForReference(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetStringForReference + +## -description +> [!NOTE] +> GetStringForReference may be altered or unavailable for releases after Windows 8.1. Instead, use [GetStringForUri](resourceloader_getstringforuri.md). + +Returns the most appropriate string value of a resource, specified as a [Uri](../windows.foundation/uri.md) for a resource identifier, for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) of the currently running app. + +## -parameters +### -param uri +A [Uri](../windows.foundation/uri.md) that represents the resource to be retrieved. + +## -returns +The most appropriate string value of the specified resource for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md). + +## -remarks +[Uri](../windows.foundation/uri.md) objects require a scheme to be identified. In this context, the ms-resource scheme must be specified in the [Uri](../windows.foundation/uri.md) passed to the method. See [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96). + +## -examples + +## -see-also +[ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md), [How to load string resources](http://msdn.microsoft.com/library/849f5bbf-6d85-4760-8832-75d3eff9bd96) \ No newline at end of file diff --git a/windows.applicationmodel.resources/resourceloader_getstringforuri_449569482.md b/windows.applicationmodel.resources/resourceloader_getstringforuri_449569482.md index 10cbb523a3..8e25a7ba42 100644 --- a/windows.applicationmodel.resources/resourceloader_getstringforuri_449569482.md +++ b/windows.applicationmodel.resources/resourceloader_getstringforuri_449569482.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetStringForUri(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.ApplicationModel.Resources.ResourceLoader.GetStringForUri ## -description Returns the most appropriate string value of a resource, specified by a Uniform Resource Identifier (URI) resource identifier, for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) of the currently running app. ## -parameters ### -param uri A Uniform Resource Identifier (URI) that represents the resource to be retrieved. ## -returns The most appropriate string value of the specified resource for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md). ## -remarks Uniform Resource Identifier (URI) objects require a scheme to be identified. In this context, the ms-resource scheme must be specified in the Uniform Resource Identifier (URI) passed to the method. ### Errors This method fails with an exception if the supplied Uniform Resource Identifier (URI) is for some other protocol, if the requested resource is not found, or if the requested resource is not a string. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Resources.ResourceLoader.GetStringForUri(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Resources.ResourceLoader.GetStringForUri + +## -description +Returns the most appropriate string value of a resource, specified by a Uniform Resource Identifier (URI) resource identifier, for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md) of the currently running app. + +## -parameters +### -param uri +A Uniform Resource Identifier (URI) that represents the resource to be retrieved. + +## -returns +The most appropriate string value of the specified resource for the default [ResourceContext](../windows.applicationmodel.resources.core/resourcecontext.md). + +## -remarks +Uniform Resource Identifier (URI) objects require a scheme to be identified. In this context, the ms-resource scheme must be specified in the Uniform Resource Identifier (URI) passed to the method. + +### Errors + +This method fails with an exception if the supplied Uniform Resource Identifier (URI) is for some other protocol, if the requested resource is not found, or if the requested resource is not a string. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search.core/requestingfocusonkeyboardinputeventargs.md b/windows.applicationmodel.search.core/requestingfocusonkeyboardinputeventargs.md index b984bb583b..d383c4bff1 100644 --- a/windows.applicationmodel.search.core/requestingfocusonkeyboardinputeventargs.md +++ b/windows.applicationmodel.search.core/requestingfocusonkeyboardinputeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Search.Core.RequestingFocusOnKeyboardInputEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Search.Core.RequestingFocusOnKeyboardInputEventArgs ## -description Provides data for the [RequestingFocusOnKeyboardInput](searchsuggestionmanager_requestingfocusonkeyboardinput.md) event. ## -remarks ## -examples ## -see-also [RequestingFocusOnKeyboardInput](searchsuggestionmanager_requestingfocusonkeyboardinput.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.Core.RequestingFocusOnKeyboardInputEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.Core.RequestingFocusOnKeyboardInputEventArgs + +## -description +Provides data for the [RequestingFocusOnKeyboardInput](searchsuggestionmanager_requestingfocusonkeyboardinput.md) event. + +## -remarks + +## -examples + +## -see-also +[RequestingFocusOnKeyboardInput](searchsuggestionmanager_requestingfocusonkeyboardinput.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion.md b/windows.applicationmodel.search.core/searchsuggestion.md index f2f3131395..b980340161 100644 --- a/windows.applicationmodel.search.core/searchsuggestion.md +++ b/windows.applicationmodel.search.core/searchsuggestion.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Search.Core.SearchSuggestion --api-type: winrt class ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion ## -description Enables access to the search suggestions that the [SearchSuggestionManager](searchsuggestionmanager.md) provides. ## -remarks ## -examples ## -see-also [SearchSuggestionManager](searchsuggestionmanager.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.Core.SearchSuggestion +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion + +## -description +Enables access to the search suggestions that the [SearchSuggestionManager](searchsuggestionmanager.md) provides. + +## -remarks + +## -examples + +## -see-also +[SearchSuggestionManager](searchsuggestionmanager.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion_detailtext.md b/windows.applicationmodel.search.core/searchsuggestion_detailtext.md index a086021e77..6d31628bd3 100644 --- a/windows.applicationmodel.search.core/searchsuggestion_detailtext.md +++ b/windows.applicationmodel.search.core/searchsuggestion_detailtext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.DetailText --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion.DetailText ## -description Gets the value that was passed to the *detailText* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. ## -property-value The detail text, or **null** if the search suggestion is not a **Result**. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.DetailText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion.DetailText + +## -description +Gets the value that was passed to the *detailText* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. + +## -property-value +The detail text, or **null** if the search suggestion is not a **Result**. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion_image.md b/windows.applicationmodel.search.core/searchsuggestion_image.md index 723fe72bad..6a95b8f4bb 100644 --- a/windows.applicationmodel.search.core/searchsuggestion_image.md +++ b/windows.applicationmodel.search.core/searchsuggestion_image.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Image --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion.Image ## -description Gets the value that was passed to the *image* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. ## -property-value The image, or **null** if the search suggestion is not a **Result**. ## -remarks ## -examples ## -see-also [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Image +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion.Image + +## -description +Gets the value that was passed to the *image* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. + +## -property-value +The image, or **null** if the search suggestion is not a **Result**. + +## -remarks + +## -examples + +## -see-also +[AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion_imagealternatetext.md b/windows.applicationmodel.search.core/searchsuggestion_imagealternatetext.md index e1060b103e..276a05f548 100644 --- a/windows.applicationmodel.search.core/searchsuggestion_imagealternatetext.md +++ b/windows.applicationmodel.search.core/searchsuggestion_imagealternatetext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.ImageAlternateText --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion.ImageAlternateText ## -description Gets the value that was passed to the *imageAlternateText* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. ## -property-value The alternate text for [Image](searchsuggestion_image.md), or **null** if the search suggestion is not a **Result**. ## -remarks ## -examples ## -see-also [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md), [Image](searchsuggestion_image.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.ImageAlternateText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion.ImageAlternateText + +## -description +Gets the value that was passed to the *imageAlternateText* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. + +## -property-value +The alternate text for [Image](searchsuggestion_image.md), or **null** if the search suggestion is not a **Result**. + +## -remarks + +## -examples + +## -see-also +[AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md), [Image](searchsuggestion_image.md), [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion_kind.md b/windows.applicationmodel.search.core/searchsuggestion_kind.md index f3db89d713..f9dfc8b124 100644 --- a/windows.applicationmodel.search.core/searchsuggestion_kind.md +++ b/windows.applicationmodel.search.core/searchsuggestion_kind.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion.Kind ## -description Gets the type of suggestion. ## -property-value The type of suggestion. ## -remarks If the suggestion was supplied by the system, it has a [SearchSuggestionKind](searchsuggestionkind.md) of **Query**. If the suggestion was supplied by the application, in response to a [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event, the kind is determined by the method of [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md) that was used to add the suggestion.
SearchSuggestionCollection methodSearchSuggestionKind
[AppendQuerySuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendquerysuggestion.md)**Query**
[AppendQuerySuggestions](../windows.applicationmodel.search/searchsuggestioncollection_appendquerysuggestions.md)**Query**
[AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md)**Result**
[AppendSearchSeparator](../windows.applicationmodel.search/searchsuggestioncollection_appendsearchseparator.md)**Separator**
[AppendStorageFile](../windows.applicationmodel.search/searchsuggestioncollection_appendstoragefilesuggestion.md)**StorageFile**
## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md), [SearchSuggestionKind](searchsuggestionkind.md), [SearchSuggestionManager](searchsuggestionmanager.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion.Kind + +## -description +Gets the type of suggestion. + +## -property-value +The type of suggestion. + +## -remarks +If the suggestion was supplied by the system, it has a [SearchSuggestionKind](searchsuggestionkind.md) of **Query**. If the suggestion was supplied by the application, in response to a [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event, the kind is determined by the method of [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md) that was used to add the suggestion. + + + + + + + + +
SearchSuggestionCollection methodSearchSuggestionKind
[AppendQuerySuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendquerysuggestion.md)**Query**
[AppendQuerySuggestions](../windows.applicationmodel.search/searchsuggestioncollection_appendquerysuggestions.md)**Query**
[AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md)**Result**
[AppendSearchSeparator](../windows.applicationmodel.search/searchsuggestioncollection_appendsearchseparator.md)**Separator**
[AppendStorageFile](../windows.applicationmodel.search/searchsuggestioncollection_appendstoragefilesuggestion.md)**StorageFile**
+ +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md), [SearchSuggestionKind](searchsuggestionkind.md), [SearchSuggestionManager](searchsuggestionmanager.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion_tag.md b/windows.applicationmodel.search.core/searchsuggestion_tag.md index d394c3411b..3b82dab3e4 100644 --- a/windows.applicationmodel.search.core/searchsuggestion_tag.md +++ b/windows.applicationmodel.search.core/searchsuggestion_tag.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Tag --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion.Tag ## -description Gets the value that was passed to the *tag* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. ## -property-value The tag, or **null** if the search suggestion is not a **Result**. ## -remarks The [Tag](searchsuggestion_tag.md) property is an opaque value that the app uses to identify the result suggestions that it has added when the user selects a suggestion in the UI. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Tag +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion.Tag + +## -description +Gets the value that was passed to the *tag* parameter of the [AppendResultSuggestion](../windows.applicationmodel.search/searchsuggestioncollection_appendresultsuggestion.md) method. + +## -property-value +The tag, or **null** if the search suggestion is not a **Result**. + +## -remarks +The [Tag](searchsuggestion_tag.md) property is an opaque value that the app uses to identify the result suggestions that it has added when the user selects a suggestion in the UI. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestion_text.md b/windows.applicationmodel.search.core/searchsuggestion_text.md index 6ebb8d1959..bc2e197aa7 100644 --- a/windows.applicationmodel.search.core/searchsuggestion_text.md +++ b/windows.applicationmodel.search.core/searchsuggestion_text.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Text --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestion.Text ## -description Gets the localized text of the suggestion for display in the search suggestions UI. ## -property-value The text to display. ## -remarks This property is set for all kinds of suggestions, including **Separator**. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestion.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestion.Text + +## -description +Gets the localized text of the suggestion for display in the search suggestions UI. + +## -property-value +The text to display. + +## -remarks +This property is set for all kinds of suggestions, including **Separator**. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager.md b/windows.applicationmodel.search.core/searchsuggestionmanager.md index 68bcdfbce5..afe8dab6f8 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Search.Core.SearchSuggestionManager --api-type: winrt class ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager ## -description Manages access to search suggestions for the in-app [SearchBox](../windows.ui.xaml.controls/searchbox.md) control. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.Core.SearchSuggestionManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager + +## -description +Manages access to search suggestions for the in-app [SearchBox](../windows.ui.xaml.controls/searchbox.md) control. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_2021265072.md b/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_2021265072.md index e00df608b9..65beaa318a 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_2021265072.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_2021265072.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory ## -description Stores the specified query and input language in the search history. ## -parameters ### -param queryText The query. ### -param language The input language. The input language ensures that the query string is displayed in the search history for the correct language. ## -remarks The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [AddToHistory](searchsuggestionmanager_addtohistory.md) method when the query entry is committed, to add it to the current history context. Calling the [AddToHistory](searchsuggestionmanager_addtohistory.md) method doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [AddToHistory(String)](searchsuggestionmanager_addtohistory_881197840.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory + +## -description +Stores the specified query and input language in the search history. + +## -parameters +### -param queryText +The query. + +### -param language +The input language. The input language ensures that the query string is displayed in the search history for the correct language. + +## -remarks +The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [AddToHistory](searchsuggestionmanager_addtohistory.md) method when the query entry is committed, to add it to the current history context. + +Calling the [AddToHistory](searchsuggestionmanager_addtohistory.md) method doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [AddToHistory(String)](searchsuggestionmanager_addtohistory_881197840.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_881197840.md b/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_881197840.md index d6f37576fb..f97c445215 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_881197840.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_addtohistory_881197840.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory ## -description Stores the specified query in the search history. ## -parameters ### -param queryText The query. ## -remarks The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [AddToHistory](searchsuggestionmanager_addtohistory.md) method when the query entry is committed, to add it to the current history context. Calling the [AddToHistory](searchsuggestionmanager_addtohistory.md) method doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [AddToHistory(String, String)](searchsuggestionmanager_addtohistory_2021265072.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.AddToHistory + +## -description +Stores the specified query in the search history. + +## -parameters +### -param queryText +The query. + +## -remarks +The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [AddToHistory](searchsuggestionmanager_addtohistory.md) method when the query entry is committed, to add it to the current history context. + +Calling the [AddToHistory](searchsuggestionmanager_addtohistory.md) method doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [AddToHistory(String, String)](searchsuggestionmanager_addtohistory_2021265072.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_clearhistory_1402927427.md b/windows.applicationmodel.search.core/searchsuggestionmanager_clearhistory_1402927427.md index 7d9f9351fc..8d79e4fd5d 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_clearhistory_1402927427.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_clearhistory_1402927427.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.ClearHistory --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.ClearHistory ## -description Clears all search history contexts for the current app. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.ClearHistory +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.ClearHistory + +## -description +Clears all search history contexts for the current app. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_requestingfocusonkeyboardinput.md b/windows.applicationmodel.search.core/searchsuggestionmanager_requestingfocusonkeyboardinput.md index 2850ebe74e..7bf6cf4ba7 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_requestingfocusonkeyboardinput.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_requestingfocusonkeyboardinput.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.RequestingFocusOnKeyboardInput --api-type: winrt event ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.RequestingFocusOnKeyboardInput ## -description Raised when the user presses a key that initiates type-to-search. ## -remarks The app's UI handles this event by setting focus to the search box control so that subsequent keystrokes result in entering a search query. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.RequestingFocusOnKeyboardInput +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.RequestingFocusOnKeyboardInput + +## -description +Raised when the user presses a key that initiates type-to-search. + +## -remarks +The app's UI handles this event by setting focus to the search box control so that subsequent keystrokes result in entering a search query. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistorycontext.md b/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistorycontext.md index 6cc14e6cc7..882c88568c 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistorycontext.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistorycontext.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryContext --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryContext ## -description Identifies the context of the search and is used to store the user's search history with the app. ## -property-value The search history context string. ## -remarks The search history context string is used as a secondary key for storing search history. The primary key is the AppId. An app can use the search history context string to store different search histories based on the context of the application. Changing the value of the [SearchHistoryContext](searchsuggestionmanager_searchhistorycontext.md) property doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. If you don't set this property, Windows assumes that all searches in your app occur in the same context. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryContext +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryContext + +## -description +Identifies the context of the search and is used to store the user's search history with the app. + +## -property-value +The search history context string. + +## -remarks +The search history context string is used as a secondary key for storing search history. The primary key is the AppId. An app can use the search history context string to store different search histories based on the context of the application. + +Changing the value of the [SearchHistoryContext](searchsuggestionmanager_searchhistorycontext.md) property doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. + +If you don't set this property, Windows assumes that all searches in your app occur in the same context. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistoryenabled.md b/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistoryenabled.md index acec28ff40..cae1c031cd 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistoryenabled.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_searchhistoryenabled.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryEnabled --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryEnabled ## -description Indicates whether the user's previous searches with the app are automatically tracked and used to provide suggestions. ## -property-value **True** if the user's search history is automatically tracked and used to provide suggestions; otherwise **false**. The default value is **true**. ## -remarks Set the [SearchHistoryEnabled](searchsuggestionmanager_searchhistoryenabled.md) property to **false** to opt out of automatic suggestions, so your app can optionally provide its own suggestions instead. If you decide to have your app track its own search history, you should also give the user some control over their history through the Settings charm, like the ability to clear the history. Changing the value of the [SearchHistoryEnabled](searchsuggestionmanager_searchhistoryenabled.md) property doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchHistoryEnabled + +## -description +Indicates whether the user's previous searches with the app are automatically tracked and used to provide suggestions. + +## -property-value +**True** if the user's search history is automatically tracked and used to provide suggestions; otherwise **false**. The default value is **true**. + +## -remarks +Set the [SearchHistoryEnabled](searchsuggestionmanager_searchhistoryenabled.md) property to **false** to opt out of automatic suggestions, so your app can optionally provide its own suggestions instead. If you decide to have your app track its own search history, you should also give the user some control over their history through the Settings charm, like the ability to clear the history. + +Changing the value of the [SearchHistoryEnabled](searchsuggestionmanager_searchhistoryenabled.md) property doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. + + + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_searchsuggestionmanager_1221375020.md b/windows.applicationmodel.search.core/searchsuggestionmanager_searchsuggestionmanager_1221375020.md index 6bf623f15e..0633eb0e21 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_searchsuggestionmanager_1221375020.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_searchsuggestionmanager_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchSuggestionManager ## -description Initializes a new instance of the [SearchSuggestionManager](searchsuggestionmanager.md) class. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SearchSuggestionManager + +## -description +Initializes a new instance of the [SearchSuggestionManager](searchsuggestionmanager.md) class. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_setlocalcontentsuggestionsettings_156524340.md b/windows.applicationmodel.search.core/searchsuggestionmanager_setlocalcontentsuggestionsettings_156524340.md index cec28f7e2b..71e467d65f 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_setlocalcontentsuggestionsettings_156524340.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_setlocalcontentsuggestionsettings_156524340.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetLocalContentSuggestionSettings(Windows.ApplicationModel.Search.LocalContentSuggestionSettings) --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetLocalContentSuggestionSettings ## -description Specifies whether suggestions based on local files are added automatically to the [Suggestions](searchsuggestionmanager_suggestions.md) collection, and defines the criteria that Windows uses to locate and filter these suggestions. ## -parameters ### -param settings The new settings for local content suggestions. ## -remarks When local content suggestions are enabled, Windows provides search suggestions from the user's local files as the user enters query text. For example, a picture application can configure local content suggestions so that search suggestions come only from a particular kind of image file that is stored in the user's picture library. Changing the value of the [SetLocalContentSuggestionSettings](searchsuggestionmanager_setlocalcontentsuggestionsettings.md) property doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetLocalContentSuggestionSettings(Windows.ApplicationModel.Search.LocalContentSuggestionSettings) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetLocalContentSuggestionSettings + +## -description +Specifies whether suggestions based on local files are added automatically to the [Suggestions](searchsuggestionmanager_suggestions.md) collection, and defines the criteria that Windows uses to locate and filter these suggestions. + +## -parameters +### -param settings +The new settings for local content suggestions. + +## -remarks +When local content suggestions are enabled, Windows provides search suggestions from the user's local files as the user enters query text. For example, a picture application can configure local content suggestions so that search suggestions come only from a particular kind of image file that is stored in the user's picture library. + +Changing the value of the [SetLocalContentSuggestionSettings](searchsuggestionmanager_setlocalcontentsuggestionsettings.md) property doesn't immediately update the suggestions in the [Suggestions](searchsuggestionmanager_suggestions.md) property. Call [SetQuery](searchsuggestionmanager_setquery.md) to update the [Suggestions](searchsuggestionmanager_suggestions.md) property. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_1931070342.md b/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_1931070342.md index 65cd1186f6..491ce53a0d 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_1931070342.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_1931070342.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery(System.String,System.String,Windows.ApplicationModel.Search.SearchQueryLinguisticDetails) --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery ## -description Assigns the current search query with the specified input language and Input Method Editor (IME) info. ## -parameters ### -param queryText The query. ### -param language The input language. ### -param linguisticDetails Info about the query text that the user enters through an Input Method Editor (IME). ## -remarks The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [SetQuery](searchsuggestionmanager_setquery.md) method when the query text changes. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [SetQuery(String)](searchsuggestionmanager_setquery_2037893158.md), [SetQuery(String, String)](searchsuggestionmanager_setquery_898352538.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery(System.String,System.String,Windows.ApplicationModel.Search.SearchQueryLinguisticDetails) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery + +## -description +Assigns the current search query with the specified input language and Input Method Editor (IME) info. + +## -parameters +### -param queryText +The query. + +### -param language +The input language. + +### -param linguisticDetails +Info about the query text that the user enters through an Input Method Editor (IME). + +## -remarks +The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [SetQuery](searchsuggestionmanager_setquery.md) method when the query text changes. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [SetQuery(String)](searchsuggestionmanager_setquery_2037893158.md), [SetQuery(String, String)](searchsuggestionmanager_setquery_898352538.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_2037893158.md b/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_2037893158.md index ba54e2e9b0..db96395ec5 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_2037893158.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_2037893158.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery ## -description Assigns the current search query. ## -parameters ### -param queryText The query. ## -remarks The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [SetQuery](searchsuggestionmanager_setquery.md) method when the query text changes. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [SetQuery(String, String)](searchsuggestionmanager_setquery_898352538.md), [SetQuery(String, String, SearchQueryLinguisticDetails)](searchsuggestionmanager_setquery_1931070342.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery + +## -description +Assigns the current search query. + +## -parameters +### -param queryText +The query. + +## -remarks +The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [SetQuery](searchsuggestionmanager_setquery.md) method when the query text changes. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [SetQuery(String, String)](searchsuggestionmanager_setquery_898352538.md), [SetQuery(String, String, SearchQueryLinguisticDetails)](searchsuggestionmanager_setquery_1931070342.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_898352538.md b/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_898352538.md index ad56bdf750..fa88d6cd57 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_898352538.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_setquery_898352538.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery ## -description Assigns the current search query with the specified input language. ## -parameters ### -param queryText The query. ### -param language The input language. ## -remarks The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [SetQuery](searchsuggestionmanager_setquery.md) method when the query text changes. ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [SetQuery(String)](searchsuggestionmanager_setquery_2037893158.md), [SetQuery(String, String, SearchQueryLinguisticDetails)](searchsuggestionmanager_setquery_1931070342.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SetQuery + +## -description +Assigns the current search query with the specified input language. + +## -parameters +### -param queryText +The query. + +### -param language +The input language. + +## -remarks +The [SearchBox](../windows.ui.xaml.controls/searchbox.md) control calls the [SetQuery](searchsuggestionmanager_setquery.md) method when the query text changes. + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [SetQuery(String)](searchsuggestionmanager_setquery_2037893158.md), [SetQuery(String, String, SearchQueryLinguisticDetails)](searchsuggestionmanager_setquery_1931070342.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_suggestions.md b/windows.applicationmodel.search.core/searchsuggestionmanager_suggestions.md index 4e70d8588f..ddb4fa39b9 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_suggestions.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_suggestions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.Suggestions --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.Suggestions ## -description Gets the search suggestions for the current search query. ## -property-value The search suggestions. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.Suggestions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.Suggestions + +## -description +Gets the search suggestions for the current search query. + +## -property-value +The search suggestions. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionmanager_suggestionsrequested.md b/windows.applicationmodel.search.core/searchsuggestionmanager_suggestionsrequested.md index 4bacbf05bc..29089a05f9 100644 --- a/windows.applicationmodel.search.core/searchsuggestionmanager_suggestionsrequested.md +++ b/windows.applicationmodel.search.core/searchsuggestionmanager_suggestionsrequested.md @@ -1,3 +1,53 @@ ---- -api-id: E:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SuggestionsRequested --api-type: winrt event ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SuggestionsRequested ## -description Raised when the user's query text changes and the app needs to provide new suggestions to display in the search box. ## -remarks Suggestions can come from three sources: search history, local files, or from a source specified by the app. Suggestions are grouped by their source and display in the following order in the search pane: search history, local files, and then app-specified sources. If your app participates in the Search contract and you want your app to display suggestions from sources that you specify, you must register a handler to respond when this event fires. In your [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event handler, respond by obtaining suggestions and populating the [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md) based on the user's [QueryText](searchsuggestionsrequestedeventargs_querytext.md). > [!NOTE] > If you want to respond to this event asynchronously, you must get a deferral from the [Request](searchsuggestionsrequestedeventargs_request.md) property. Suggestions can't be provided for an empty search box, so this event isn't raised when the user updates the search box to be empty. ### Types of search suggestions There are two types of suggestions your app can display: suggestions that help users refine a query (query suggestions), and suggestions that are actual results of a query (result suggestions). You may choose to display either or both types of suggestions. If you provide query suggestions and the user selects one, your app should respond by displaying results for the selected, refined query in your app's search results page. If you provide result suggestions, you must also register a [ResultSuggestionChosen](../windows.ui.xaml.controls/searchbox_resultsuggestionchosen.md) event handler so that you can respond when the user selects one of your result suggestions and you can display the result to the user. ### Obtaining suggestions Here are a few examples of sources your app can use to obtain suggestions: + From an app-defined, static, local list + From a URL that supports suggestions in [OpenSearch format](http://go.microsoft.com/fwlink/p/?linkid=251110) + From a URL that supports suggestions in [XML search suggestions format](XREF:TODO:inet_opensearch_xmlformat) ### Displaying app-provided suggestions in the search box control After you obtain suggestions, you display them in the search pane by adding them to the [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md) of the [Request](searchsuggestionsrequestedeventargs_request.md). If you choose to display both query suggestions and result suggestions, you should group the suggestions by suggestion type (query or result) and separate the groups using [AppendSearchSeparator](../windows.applicationmodel.search/searchsuggestioncollection_appendsearchseparator.md). Each separator takes the place of a suggestion and must be followed by at least one suggestion, decreasing the number of suggestions that you can display. To learn more about using suggestions to create a good search experience for your users in [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39). ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SuggestionsRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionManager.SuggestionsRequested + +## -description +Raised when the user's query text changes and the app needs to provide new suggestions to display in the search box. + +## -remarks +Suggestions can come from three sources: search history, local files, or from a source specified by the app. Suggestions are grouped by their source and display in the following order in the search pane: search history, local files, and then app-specified sources. + +If your app participates in the Search contract and you want your app to display suggestions from sources that you specify, you must register a handler to respond when this event fires. In your [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event handler, respond by obtaining suggestions and populating the [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md) based on the user's [QueryText](searchsuggestionsrequestedeventargs_querytext.md). + +> [!NOTE] +> If you want to respond to this event asynchronously, you must get a deferral from the [Request](searchsuggestionsrequestedeventargs_request.md) property. + +Suggestions can't be provided for an empty search box, so this event isn't raised when the user updates the search box to be empty. + +### Types of search suggestions + +There are two types of suggestions your app can display: suggestions that help users refine a query (query suggestions), and suggestions that are actual results of a query (result suggestions). You may choose to display either or both types of suggestions. + +If you provide query suggestions and the user selects one, your app should respond by displaying results for the selected, refined query in your app's search results page. + +If you provide result suggestions, you must also register a [ResultSuggestionChosen](../windows.ui.xaml.controls/searchbox_resultsuggestionchosen.md) event handler so that you can respond when the user selects one of your result suggestions and you can display the result to the user. + +### Obtaining suggestions + +Here are a few examples of sources your app can use to obtain suggestions: + ++ From an app-defined, static, local list ++ From a URL that supports suggestions in [OpenSearch format](http://go.microsoft.com/fwlink/p/?linkid=251110) ++ From a URL that supports suggestions in [XML search suggestions format](XREF:TODO:inet_opensearch_xmlformat) + + +### Displaying app-provided suggestions in the search box control + +After you obtain suggestions, you display them in the search pane by adding them to the [SearchSuggestionCollection](../windows.applicationmodel.search/searchsuggestioncollection.md) of the [Request](searchsuggestionsrequestedeventargs_request.md). + +If you choose to display both query suggestions and result suggestions, you should group the suggestions by suggestion type (query or result) and separate the groups using [AppendSearchSeparator](../windows.applicationmodel.search/searchsuggestioncollection_appendsearchseparator.md). Each separator takes the place of a suggestion and must be followed by at least one suggestion, decreasing the number of suggestions that you can display. + +To learn more about using suggestions to create a good search experience for your users in [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39). + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs.md b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs.md index c2cd5b3e44..d3cbea9db5 100644 --- a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs.md +++ b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs.md @@ -1,3 +1,30 @@ ---- -api-id: T:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs ## -description Provides data for the [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event. ## -remarks This object is passed to an app's [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event handler. ### Use your app to provide suggestions There are a few different ways you can get suggestions for your app to provide: + From an app-defined, static, local list + From a URL that supports suggestions in OpenSearch format + From a URL that supports suggestions in XML format ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md), [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs + +## -description +Provides data for the [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event. + +## -remarks +This object is passed to an app's [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event handler. + +### Use your app to provide suggestions + +There are a few different ways you can get suggestions for your app to provide: + ++ From an app-defined, static, local list ++ From a URL that supports suggestions in OpenSearch format ++ From a URL that supports suggestions in XML format + + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md), [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_language.md b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_language.md index 245d932be6..e942e7c615 100644 --- a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_language.md +++ b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_language.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Language --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Language ## -description Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device. ## -property-value The Internet Engineering Task Force (IETF) BCP 47 standard language tag. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Language +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Language + +## -description +Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device. + +## -property-value +The Internet Engineering Task Force (IETF) BCP 47 standard language tag. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_linguisticdetails.md b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_linguisticdetails.md index 51b0e1b1a6..3aa6ae4102 100644 --- a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_linguisticdetails.md +++ b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_linguisticdetails.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.LinguisticDetails --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.LinguisticDetails ## -description Gets an object that provides linguistic information about query text that the user is entering through an Input Method Editor (IME). ## -property-value An object that provides linguistic information about the query text. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.LinguisticDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.LinguisticDetails + +## -description +Gets an object that provides linguistic information about query text that the user is entering through an Input Method Editor (IME). + +## -property-value +An object that provides linguistic information about the query text. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_querytext.md b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_querytext.md index 860d536b06..aae28c9f93 100644 --- a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_querytext.md +++ b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_querytext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.QueryText --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.QueryText ## -description The text that the app should provide suggestions for and that was in the search box when the [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event was raised. ## -property-value The query text that the app should provide suggestions for. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.QueryText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.QueryText + +## -description +The text that the app should provide suggestions for and that was in the search box when the [SuggestionsRequested](searchsuggestionmanager_suggestionsrequested.md) event was raised. + +## -property-value +The query text that the app should provide suggestions for. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_request.md b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_request.md index 06874f5f4e..390d002ee4 100644 --- a/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_request.md +++ b/windows.applicationmodel.search.core/searchsuggestionsrequestedeventargs_request.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Request --api-type: winrt property ---- # Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Request ## -description Gets an object that stores suggestions and information about the request. ## -property-value The object that stores suggestions and information about the request. ## -remarks ## -examples ## -see-also [SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.Core.SearchSuggestionsRequestedEventArgs.Request + +## -description +Gets an object that stores suggestions and information about the request. + +## -property-value +The object that stores suggestions and information about the request. + +## -remarks + +## -examples + +## -see-also +[SearchBox](../windows.ui.xaml.controls/searchbox.md) \ No newline at end of file diff --git a/windows.applicationmodel.search/searchpane_hidethisapplication_1686398840.md b/windows.applicationmodel.search/searchpane_hidethisapplication_1686398840.md index 303e2797e2..7c56b5f2e1 100644 --- a/windows.applicationmodel.search/searchpane_hidethisapplication_1686398840.md +++ b/windows.applicationmodel.search/searchpane_hidethisapplication_1686398840.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.ApplicationModel.Search.SearchPane.HideThisApplication --api-type: winrt method ---- # Windows.ApplicationModel.Search.SearchPane.HideThisApplication ## -description Hides the current app's UI. ## -remarks > [!NOTE] > An app can't use both the search box ([Windows.UI.Xaml.Controls.SearchBox](../windows.ui.xaml.controls/searchbox.md) for Windows Store app using C++, C#, or Visual Basic, [WinJS.UI.SearchBox](http://msdn.microsoft.com/library/58f5cea3-a19b-48a8-abcc-17f38d8fa886) for Windows app using JavaScript) and the [SearchPane](searchpane.md). Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'" ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.SearchPane.HideThisApplication +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.SearchPane.HideThisApplication + +## -description +Hides the current app's UI. + +## -remarks +> [!NOTE] +> An app can't use both the search box ([Windows.UI.Xaml.Controls.SearchBox](../windows.ui.xaml.controls/searchbox.md) for Windows Store app using C++, C#, or Visual Basic, [WinJS.UI.SearchBox](http://msdn.microsoft.com/library/58f5cea3-a19b-48a8-abcc-17f38d8fa886) for Windows app using JavaScript) and the [SearchPane](searchpane.md). Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'" + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchpane_showonkeyboardinput.md b/windows.applicationmodel.search/searchpane_showonkeyboardinput.md index 1f2320904e..53cceb470d 100644 --- a/windows.applicationmodel.search/searchpane_showonkeyboardinput.md +++ b/windows.applicationmodel.search/searchpane_showonkeyboardinput.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchPane.ShowOnKeyboardInput --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchPane.ShowOnKeyboardInput ## -description Gets or sets whether the user can open the search pane by typing. ## -property-value True if the user can type to search. Otherwise, false. ## -remarks > [!NOTE] > An app can't use both the search box ([Windows.UI.Xaml.Controls.SearchBox](../windows.ui.xaml.controls/searchbox.md) for Windows Store app using C++, C#, or Visual Basic, [WinJS.UI.SearchBox](http://msdn.microsoft.com/library/58f5cea3-a19b-48a8-abcc-17f38d8fa886) for Windows app using JavaScript) and the [SearchPane](searchpane.md). Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'" To learn more about when you should let users type to search, see [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchPane.ShowOnKeyboardInput +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchPane.ShowOnKeyboardInput + +## -description +Gets or sets whether the user can open the search pane by typing. + +## -property-value +True if the user can type to search. Otherwise, false. + +## -remarks +> [!NOTE] +> An app can't use both the search box ([Windows.UI.Xaml.Controls.SearchBox](../windows.ui.xaml.controls/searchbox.md) for Windows Store app using C++, C#, or Visual Basic, [WinJS.UI.SearchBox](http://msdn.microsoft.com/library/58f5cea3-a19b-48a8-abcc-17f38d8fa886) for Windows app using JavaScript) and the [SearchPane](searchpane.md). Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'" + +To learn more about when you should let users type to search, see [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchpane_trysetquerytext_813732812.md b/windows.applicationmodel.search/searchpane_trysetquerytext_813732812.md index da94cdfe45..7d13d1d180 100644 --- a/windows.applicationmodel.search/searchpane_trysetquerytext_813732812.md +++ b/windows.applicationmodel.search/searchpane_trysetquerytext_813732812.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Search.SearchPane.TrySetQueryText(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Search.SearchPane.TrySetQueryText ## -description Attempts to set the text in the search box of the search pane. ## -parameters ### -param query The query text to show in the search pane's search box. ## -returns True if the search box text was set successfully. Otherwise, false. ## -remarks > [!NOTE] > An app can't use both the search box ([Windows.UI.Xaml.Controls.SearchBox](../windows.ui.xaml.controls/searchbox.md) for Windows Store app using C++, C#, or Visual Basic, [WinJS.UI.SearchBox](http://msdn.microsoft.com/library/58f5cea3-a19b-48a8-abcc-17f38d8fa886) for Windows app using JavaScript) and the [SearchPane](searchpane.md). Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'" If you have an in-app search box, use this method to maintain consistency between the search pane and your search box. Most apps should reply on the search pane instead of using in-app search UI. To learn more, see [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.SearchPane.TrySetQueryText(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.SearchPane.TrySetQueryText + +## -description +Attempts to set the text in the search box of the search pane. + +## -parameters +### -param query +The query text to show in the search pane's search box. + +## -returns +True if the search box text was set successfully. Otherwise, false. + +## -remarks +> [!NOTE] +> An app can't use both the search box ([Windows.UI.Xaml.Controls.SearchBox](../windows.ui.xaml.controls/searchbox.md) for Windows Store app using C++, C#, or Visual Basic, [WinJS.UI.SearchBox](http://msdn.microsoft.com/library/58f5cea3-a19b-48a8-abcc-17f38d8fa886) for Windows app using JavaScript) and the [SearchPane](searchpane.md). Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'" + +If you have an in-app search box, use this method to maintain consistency between the search pane and your search box. Most apps should reply on the search pane instead of using in-app search UI. To learn more, see [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchpanequerysubmittedeventargs_linguisticdetails.md b/windows.applicationmodel.search/searchpanequerysubmittedeventargs_linguisticdetails.md index 379dace1b4..d98ac30f26 100644 --- a/windows.applicationmodel.search/searchpanequerysubmittedeventargs_linguisticdetails.md +++ b/windows.applicationmodel.search/searchpanequerysubmittedeventargs_linguisticdetails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchPaneQuerySubmittedEventArgs.LinguisticDetails --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchPaneQuerySubmittedEventArgs.LinguisticDetails ## -description An object that provides linguistic information about query text that the user is entering through an Input Method Editor (IME). ## -property-value An object that provides linguistic information about the query text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchPaneQuerySubmittedEventArgs.LinguisticDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchPaneQuerySubmittedEventArgs.LinguisticDetails + +## -description +An object that provides linguistic information about query text that the user is entering through an Input Method Editor (IME). + +## -property-value +An object that provides linguistic information about the query text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchquerylinguisticdetails.md b/windows.applicationmodel.search/searchquerylinguisticdetails.md index a6736ebec5..79d4a6f32c 100644 --- a/windows.applicationmodel.search/searchquerylinguisticdetails.md +++ b/windows.applicationmodel.search/searchquerylinguisticdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails --api-type: winrt class ---- # Windows.ApplicationModel.Search.SearchQueryLinguisticDetails ## -description Provides information about query text that the user enters through an Input Method Editor (IME). ## -remarks Get this object through the [LinguisticDetails](../windows.ui.xaml.controls/searchboxquerychangedeventargs_linguisticdetails.md) property while handling a [QueryChanged](../windows.ui.xaml.controls/searchbox_querychanged.md) event or through the [LinguisticDetails](../windows.ui.xaml.controls/searchboxsuggestionsrequestedeventargs_linguisticdetails.md) property while handling a [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.SearchQueryLinguisticDetails + +## -description +Provides information about query text that the user enters through an Input Method Editor (IME). + +## -remarks +Get this object through the [LinguisticDetails](../windows.ui.xaml.controls/searchboxquerychangedeventargs_linguisticdetails.md) property while handling a [QueryChanged](../windows.ui.xaml.controls/searchbox_querychanged.md) event or through the [LinguisticDetails](../windows.ui.xaml.controls/searchboxsuggestionsrequestedeventargs_linguisticdetails.md) property while handling a [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchquerylinguisticdetails_querytextalternatives.md b/windows.applicationmodel.search/searchquerylinguisticdetails_querytextalternatives.md index cf8b151e17..0774f9dd9c 100644 --- a/windows.applicationmodel.search/searchquerylinguisticdetails_querytextalternatives.md +++ b/windows.applicationmodel.search/searchquerylinguisticdetails_querytextalternatives.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextAlternatives --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextAlternatives ## -description A list of the text alternatives for the current query text. These alternatives account for uncomposed text the user is entering in an IME. ## -property-value A list of the text alternatives for the query text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextAlternatives +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextAlternatives + +## -description +A list of the text alternatives for the current query text. These alternatives account for uncomposed text the user is entering in an IME. + +## -property-value +A list of the text alternatives for the query text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionlength.md b/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionlength.md index 26083caa42..f46bffd246 100644 --- a/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionlength.md +++ b/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionlength.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionLength --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionLength ## -description The length of the portion of the query text that the user is composing with an Input Method Editor (IME). ## -property-value The length of the portion of the query text that the user is composing with an Input Method Editor (IME). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionLength +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionLength + +## -description +The length of the portion of the query text that the user is composing with an Input Method Editor (IME). + +## -property-value +The length of the portion of the query text that the user is composing with an Input Method Editor (IME). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionstart.md b/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionstart.md index cb56c7cdae..d96ebb52dd 100644 --- a/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionstart.md +++ b/windows.applicationmodel.search/searchquerylinguisticdetails_querytextcompositionstart.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionStart --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionStart ## -description The starting location of the text that the user is composing with an Input Method Editor (IME). ## -property-value The starting location of the query text that the user is composing with an Input Method Editor (IME). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionStart +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.QueryTextCompositionStart + +## -description +The starting location of the text that the user is composing with an Input Method Editor (IME). + +## -property-value +The starting location of the query text that the user is composing with an Input Method Editor (IME). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchquerylinguisticdetails_searchquerylinguisticdetails_1315694860.md b/windows.applicationmodel.search/searchquerylinguisticdetails_searchquerylinguisticdetails_1315694860.md index 0a3e37273e..6b5d2c2cd2 100644 --- a/windows.applicationmodel.search/searchquerylinguisticdetails_searchquerylinguisticdetails_1315694860.md +++ b/windows.applicationmodel.search/searchquerylinguisticdetails_searchquerylinguisticdetails_1315694860.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.SearchQueryLinguisticDetails ## -description Initializes a new instance of the [SearchQueryLinguisticDetails](searchquerylinguisticdetails.md) class. ## -parameters ### -param queryTextAlternatives A list of the text alternatives for the current query text. ### -param queryTextCompositionStart The starting location of the text that the user is composing with an Input Method Editor (IME). ### -param queryTextCompositionLength The length of the portion of the query text that the user is composing with an Input Method Editor (IME). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.SearchQueryLinguisticDetails.SearchQueryLinguisticDetails + +## -description +Initializes a new instance of the [SearchQueryLinguisticDetails](searchquerylinguisticdetails.md) class. + +## -parameters +### -param queryTextAlternatives +A list of the text alternatives for the current query text. + +### -param queryTextCompositionStart +The starting location of the text that the user is composing with an Input Method Editor (IME). + +### -param queryTextCompositionLength +The length of the portion of the query text that the user is composing with an Input Method Editor (IME). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchsuggestionsrequest.md b/windows.applicationmodel.search/searchsuggestionsrequest.md index 81e08f4a2d..836aeba597 100644 --- a/windows.applicationmodel.search/searchsuggestionsrequest.md +++ b/windows.applicationmodel.search/searchsuggestionsrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Search.SearchSuggestionsRequest --api-type: winrt class ---- # Windows.ApplicationModel.Search.SearchSuggestionsRequest ## -description Stores suggestions and information about the request for suggestions. ## -remarks If your app provides its own suggestions to display in the search pane or in-app search box, use the [SearchSuggestionCollection](searchsuggestionsrequest_searchsuggestioncollection.md) property to add your app's suggestions to the collection of suggestions to display. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.SearchSuggestionsRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.SearchSuggestionsRequest + +## -description +Stores suggestions and information about the request for suggestions. + +## -remarks +If your app provides its own suggestions to display in the search pane or in-app search box, use the [SearchSuggestionCollection](searchsuggestionsrequest_searchsuggestioncollection.md) property to add your app's suggestions to the collection of suggestions to display. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchsuggestionsrequest_getdeferral_254836512.md b/windows.applicationmodel.search/searchsuggestionsrequest_getdeferral_254836512.md index a6c3601523..7d05068e97 100644 --- a/windows.applicationmodel.search/searchsuggestionsrequest_getdeferral_254836512.md +++ b/windows.applicationmodel.search/searchsuggestionsrequest_getdeferral_254836512.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Search.SearchSuggestionsRequest.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.Search.SearchSuggestionsRequest.GetDeferral ## -description Gets an object that lets an app respond to a request for suggestions asynchronously. ## -returns An object that lets an app signal when it has fulfilled the request for search suggestions. ## -remarks Your app should respond asynchronously to a request for search suggestions if fulfilling the request will take a significant amount of time, such as fetching suggestions from a web service. Call the [Complete](searchsuggestionsrequestdeferral_complete.md) method to signal when your app has fulfilled the request. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.SearchSuggestionsRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.SearchSuggestionsRequest.GetDeferral + +## -description +Gets an object that lets an app respond to a request for suggestions asynchronously. + +## -returns +An object that lets an app signal when it has fulfilled the request for search suggestions. + +## -remarks +Your app should respond asynchronously to a request for search suggestions if fulfilling the request will take a significant amount of time, such as fetching suggestions from a web service. + +Call the [Complete](searchsuggestionsrequestdeferral_complete.md) method to signal when your app has fulfilled the request. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchsuggestionsrequest_iscanceled.md b/windows.applicationmodel.search/searchsuggestionsrequest_iscanceled.md index 3ae50f8603..715d2b53b6 100644 --- a/windows.applicationmodel.search/searchsuggestionsrequest_iscanceled.md +++ b/windows.applicationmodel.search/searchsuggestionsrequest_iscanceled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchSuggestionsRequest.IsCanceled --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchSuggestionsRequest.IsCanceled ## -description Indicates whether the request for suggestions to display is canceled. ## -property-value **True** if the request was canceled, otherwise **false**. The default value is **false**. ## -remarks A request for search pane or in-app search box suggestions is valid if it's still tied to the most recent [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event, which means that the user hasn't changed the search query. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchSuggestionsRequest.IsCanceled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchSuggestionsRequest.IsCanceled + +## -description +Indicates whether the request for suggestions to display is canceled. + +## -property-value +**True** if the request was canceled, otherwise **false**. The default value is **false**. + +## -remarks +A request for search pane or in-app search box suggestions is valid if it's still tied to the most recent [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event, which means that the user hasn't changed the search query. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchsuggestionsrequest_searchsuggestioncollection.md b/windows.applicationmodel.search/searchsuggestionsrequest_searchsuggestioncollection.md index 6187d99a82..71f5ecd849 100644 --- a/windows.applicationmodel.search/searchsuggestionsrequest_searchsuggestioncollection.md +++ b/windows.applicationmodel.search/searchsuggestionsrequest_searchsuggestioncollection.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Search.SearchSuggestionsRequest.SearchSuggestionCollection --api-type: winrt property ---- # Windows.ApplicationModel.Search.SearchSuggestionsRequest.SearchSuggestionCollection ## -description The suggestions to display in the search pane or in-app search box for the current query. Apps provide suggestions to display by appending them to this [SearchSuggestionCollection](searchsuggestioncollection.md) object. ## -property-value The suggestions to display. Apps provide suggestions by appending them to this [SearchSuggestionCollection](searchsuggestioncollection.md) object. ## -remarks Use the [SearchSuggestionCollection](searchsuggestioncollection.md) object to append app-provided suggestions and search separators to display in the search pane or in-app search box. When the request for suggestions is completed, either by returning from the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event handler or by calling [Complete](searchsuggestionsrequestdeferral_complete.md), the search pane or in-app search box displays the suggestions in the [SearchSuggestionCollection](searchsuggestioncollection.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Search.SearchSuggestionsRequest.SearchSuggestionCollection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Search.SearchSuggestionsRequest.SearchSuggestionCollection + +## -description +The suggestions to display in the search pane or in-app search box for the current query. Apps provide suggestions to display by appending them to this [SearchSuggestionCollection](searchsuggestioncollection.md) object. + +## -property-value +The suggestions to display. Apps provide suggestions by appending them to this [SearchSuggestionCollection](searchsuggestioncollection.md) object. + +## -remarks +Use the [SearchSuggestionCollection](searchsuggestioncollection.md) object to append app-provided suggestions and search separators to display in the search pane or in-app search box. + +When the request for suggestions is completed, either by returning from the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event handler or by calling [Complete](searchsuggestionsrequestdeferral_complete.md), the search pane or in-app search box displays the suggestions in the [SearchSuggestionCollection](searchsuggestioncollection.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchsuggestionsrequestdeferral.md b/windows.applicationmodel.search/searchsuggestionsrequestdeferral.md index 8c697fbdcc..5946f45849 100644 --- a/windows.applicationmodel.search/searchsuggestionsrequestdeferral.md +++ b/windows.applicationmodel.search/searchsuggestionsrequestdeferral.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral --api-type: winrt class ---- # Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral ## -description Enables the app to signal when it has finished populating a [SearchSuggestionCollection](searchsuggestioncollection.md) object while handling the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. Use a deferral if and only if your app needs to respond to a request for suggestions asynchronously. ## -remarks Your app should respond asynchronously to a request for suggestions if fulfilling the request will take a significant amount of time, such as fetching suggestions from a web service. Use the [Complete](searchsuggestionsrequestdeferral_complete.md) method to signal when your app has fulfilled the request. Retrieve this object by calling the [GetDeferral](searchsuggestionsrequest_getdeferral.md) method while handling the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral + +## -description +Enables the app to signal when it has finished populating a [SearchSuggestionCollection](searchsuggestioncollection.md) object while handling the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. Use a deferral if and only if your app needs to respond to a request for suggestions asynchronously. + +## -remarks +Your app should respond asynchronously to a request for suggestions if fulfilling the request will take a significant amount of time, such as fetching suggestions from a web service. + +Use the [Complete](searchsuggestionsrequestdeferral_complete.md) method to signal when your app has fulfilled the request. Retrieve this object by calling the [GetDeferral](searchsuggestionsrequest_getdeferral.md) method while handling the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.search/searchsuggestionsrequestdeferral_complete_1807836922.md b/windows.applicationmodel.search/searchsuggestionsrequestdeferral_complete_1807836922.md index aa5b014d3a..e7804a3ca9 100644 --- a/windows.applicationmodel.search/searchsuggestionsrequestdeferral_complete_1807836922.md +++ b/windows.applicationmodel.search/searchsuggestionsrequestdeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral.Complete ## -description Signals that the app has finished populating a [SearchSuggestionCollection](searchsuggestioncollection.md) object while handling the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Search.SearchSuggestionsRequestDeferral.Complete + +## -description +Signals that the app has finished populating a [SearchSuggestionCollection](searchsuggestioncollection.md) object while handling the [SuggestionsRequested](../windows.ui.xaml.controls/searchbox_suggestionsrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater.md index dbdcab3501..0f41f6822e 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater ## -description Represents a task that can update dashboard items. ## -remarks Call [SocialInfoProviderManager.CreateDashboardItemUpdaterAsync](socialinfoprovidermanager_createdashboarditemupdaterasync.md) to create an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater + +## -description +Represents a task that can update dashboard items. + +## -remarks +Call [SocialInfoProviderManager.CreateDashboardItemUpdaterAsync](socialinfoprovidermanager_createdashboarditemupdaterasync.md) to create an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_commitasync_1433804794.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_commitasync_1433804794.md index 5f23e88c1d..869c5a2df4 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_commitasync_1433804794.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_commitasync_1433804794.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.CommitAsync --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.CommitAsync ## -description Asynchronously submits the update after all the properties have been set. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.CommitAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.CommitAsync + +## -description +Asynchronously submits the update after all the properties have been set. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_content.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_content.md index 8083ff6c21..930a6c29f0 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_content.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_content.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Content --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Content ## -description Gets a [SocialFeedContent](../windows.applicationmodel.socialinfo/socialfeedcontent.md) object which can be updated. ## -property-value A [SocialFeedContent](../windows.applicationmodel.socialinfo/socialfeedcontent.md) object which can be updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Content +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Content + +## -description +Gets a [SocialFeedContent](../windows.applicationmodel.socialinfo/socialfeedcontent.md) object which can be updated. + +## -property-value +A [SocialFeedContent](../windows.applicationmodel.socialinfo/socialfeedcontent.md) object which can be updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_ownerremoteid.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_ownerremoteid.md index e73c2a61a9..4ccc3ffe63 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_ownerremoteid.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_ownerremoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.OwnerRemoteId --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.OwnerRemoteId ## -description Gets the ID that identifies the user on the provider's system. ## -property-value The ID that identifies the user on the provider's system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.OwnerRemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.OwnerRemoteId + +## -description +Gets the ID that identifies the user on the provider's system. + +## -property-value +The ID that identifies the user on the provider's system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_targeturi.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_targeturi.md index fcf4804ad8..86f762fd5a 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_targeturi.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.TargetUri ## -description Gets or sets the uniform resource identifier (URI) that is navigated to when the user taps the item. ## -property-value The URI that is navigated to when the user taps the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.TargetUri + +## -description +Gets or sets the uniform resource identifier (URI) that is navigated to when the user taps the item. + +## -property-value +The URI that is navigated to when the user taps the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_thumbnail.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_thumbnail.md index e644cd02da..8c88779669 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_thumbnail.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Thumbnail --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Thumbnail ## -description Gets or sets the thumbnail image for the dashboard item. ## -property-value The thumbnail image for the dashboard item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Thumbnail + +## -description +Gets or sets the thumbnail image for the dashboard item. + +## -property-value +The thumbnail image for the dashboard item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_timestamp.md b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_timestamp.md index 5a6eea7316..d553b24e61 100644 --- a/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_timestamp.md +++ b/windows.applicationmodel.socialinfo.provider/socialdashboarditemupdater_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Timestamp --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Timestamp ## -description Gets or sets the timestamp for the update. ## -property-value The timestamp for the update. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Timestamp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialDashboardItemUpdater.Timestamp + +## -description +Gets or sets the timestamp for the update. + +## -property-value +The timestamp for the update. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialfeedupdater.md b/windows.applicationmodel.socialinfo.provider/socialfeedupdater.md index b3e86871ad..815bb4b46e 100644 --- a/windows.applicationmodel.socialinfo.provider/socialfeedupdater.md +++ b/windows.applicationmodel.socialinfo.provider/socialfeedupdater.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater ## -description Represents a task the can be used to update a social media feed. ## -remarks Call [SocialInfoProviderManager.CreateSocialFeedUpdaterAsync](socialinfoprovidermanager_createsocialfeedupdaterasync.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater + +## -description +Represents a task the can be used to update a social media feed. + +## -remarks +Call [SocialInfoProviderManager.CreateSocialFeedUpdaterAsync](socialinfoprovidermanager_createsocialfeedupdaterasync.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_commitasync_1433804794.md b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_commitasync_1433804794.md index 5a467f8e19..890148402e 100644 --- a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_commitasync_1433804794.md +++ b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_commitasync_1433804794.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.CommitAsync --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.CommitAsync ## -description Asynchronously submits the update after all the properties have been set. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.CommitAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.CommitAsync + +## -description +Asynchronously submits the update after all the properties have been set. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_items.md b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_items.md index 699707f620..8e5cef8d34 100644 --- a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_items.md +++ b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Items --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Items ## -description Gets the list of social media feed items. ## -property-value The list of social media feed items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Items +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Items + +## -description +Gets the list of social media feed items. + +## -property-value +The list of social media feed items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_kind.md b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_kind.md index a6458b7f2c..5268fd013d 100644 --- a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_kind.md +++ b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Kind --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Kind ## -description Gets the type of the social media feed. ## -property-value The type of the social media feed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.Kind + +## -description +Gets the type of the social media feed. + +## -property-value +The type of the social media feed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_ownerremoteid.md b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_ownerremoteid.md index 63b69f4477..450d89f1c7 100644 --- a/windows.applicationmodel.socialinfo.provider/socialfeedupdater_ownerremoteid.md +++ b/windows.applicationmodel.socialinfo.provider/socialfeedupdater_ownerremoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.OwnerRemoteId --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.OwnerRemoteId ## -description Gets the ID that identifies the user on the provider's system. ## -property-value The ID that identifies the user on the provider's system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.OwnerRemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialFeedUpdater.OwnerRemoteId + +## -description +Gets the ID that identifies the user on the provider's system. + +## -property-value +The ID that identifies the user on the provider's system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager.md index cf0c5e10bd..86ff145a24 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager ## -description Provides functionality for an app to use social media extensibility. ## -remarks This is a static class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager + +## -description +Provides functionality for an app to use social media extensibility. + +## -remarks +This is a static class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createdashboarditemupdaterasync_1728882678.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createdashboarditemupdaterasync_1728882678.md index 73bf247949..7fab30ec18 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createdashboarditemupdaterasync_1728882678.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createdashboarditemupdaterasync_1728882678.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateDashboardItemUpdaterAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateDashboardItemUpdaterAsync ## -description Creates a new [SocialDashboardItemUpdater](socialdashboarditemupdater.md) object that can be used as a task. ## -parameters ### -param ownerRemoteId The ID that identifies the user on the provider's system. ## -returns The newly created [SocialDashboardItemUpdater](socialdashboarditemupdater.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateDashboardItemUpdaterAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateDashboardItemUpdaterAsync + +## -description +Creates a new [SocialDashboardItemUpdater](socialdashboarditemupdater.md) object that can be used as a task. + +## -parameters +### -param ownerRemoteId +The ID that identifies the user on the provider's system. + +## -returns +The newly created [SocialDashboardItemUpdater](socialdashboarditemupdater.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createsocialfeedupdaterasync_990295011.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createsocialfeedupdaterasync_990295011.md index 873ab03c17..766e510a26 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createsocialfeedupdaterasync_990295011.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_createsocialfeedupdaterasync_990295011.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateSocialFeedUpdaterAsync(Windows.ApplicationModel.SocialInfo.SocialFeedKind,Windows.ApplicationModel.SocialInfo.SocialFeedUpdateMode,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateSocialFeedUpdaterAsync ## -description Creates a new [SocialFeedUpdater](socialfeedupdater.md) object that can be used as a task. ## -parameters ### -param kind The type of the social media feed to create. ### -param mode Specifies append or replace mode. ### -param ownerRemoteId The ID that identifies the user on the provider's system. ## -returns The newly created [SocialFeedUpdater](socialfeedupdater.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateSocialFeedUpdaterAsync(Windows.ApplicationModel.SocialInfo.SocialFeedKind,Windows.ApplicationModel.SocialInfo.SocialFeedUpdateMode,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.CreateSocialFeedUpdaterAsync + +## -description +Creates a new [SocialFeedUpdater](socialfeedupdater.md) object that can be used as a task. + +## -parameters +### -param kind +The type of the social media feed to create. + +### -param mode +Specifies append or replace mode. + +### -param ownerRemoteId +The ID that identifies the user on the provider's system. + +## -returns +The newly created [SocialFeedUpdater](socialfeedupdater.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_deprovisionasync_1380410018.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_deprovisionasync_1380410018.md index e85e21aaac..e99d854187 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_deprovisionasync_1380410018.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_deprovisionasync_1380410018.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.DeprovisionAsync --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.DeprovisionAsync ## -description Deprovisions an app from using social media extensibility. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.DeprovisionAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.DeprovisionAsync + +## -description +Deprovisions an app from using social media extensibility. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_provisionasync_1979573394.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_provisionasync_1979573394.md index 47cb5f695e..7b1ade91df 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_provisionasync_1979573394.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_provisionasync_1979573394.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ProvisionAsync --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ProvisionAsync ## -description Provisions the app to use social media extensibility. ## -returns A Boolean value indicating if the operation was successful. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ProvisionAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ProvisionAsync + +## -description +Provisions the app to use social media extensibility. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_reportnewcontentavailable_1035635261.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_reportnewcontentavailable_1035635261.md index 73cbc29e9b..8e0c71ff06 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_reportnewcontentavailable_1035635261.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_reportnewcontentavailable_1035635261.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ReportNewContentAvailable(System.String,Windows.ApplicationModel.SocialInfo.SocialFeedKind) --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ReportNewContentAvailable ## -description Alerts the system that new social media content is available from this app. ## -parameters ### -param contactRemoteId The ID that identifies the user on the provider's system. ### -param kind The type of the social media feed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ReportNewContentAvailable(System.String,Windows.ApplicationModel.SocialInfo.SocialFeedKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.ReportNewContentAvailable + +## -description +Alerts the system that new social media content is available from this app. + +## -parameters +### -param contactRemoteId +The ID that identifies the user on the provider's system. + +### -param kind +The type of the social media feed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_updatebadgecountvalue_1650390549.md b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_updatebadgecountvalue_1650390549.md index 68605068b2..cf10a6e113 100644 --- a/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_updatebadgecountvalue_1650390549.md +++ b/windows.applicationmodel.socialinfo.provider/socialinfoprovidermanager_updatebadgecountvalue_1650390549.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.UpdateBadgeCountValue(System.String,System.Int32) --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.UpdateBadgeCountValue ## -description Updates the count value on the lock screen badge. ## -parameters ### -param itemRemoteId Identifies the contact on the provider's system. ### -param newCount The new count value to display on the badge. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.UpdateBadgeCountValue(System.String,System.Int32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.Provider.SocialInfoProviderManager.UpdateBadgeCountValue + +## -description +Updates the count value on the lock screen badge. + +## -parameters +### -param itemRemoteId +Identifies the contact on the provider's system. + +### -param newCount +The new count value to display on the badge. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem.md b/windows.applicationmodel.socialinfo/socialfeedchilditem.md index b5fa24304b..e3eb9fe151 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem ## -description Represents the child item of a [SocialFeedItem](socialfeeditem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem + +## -description +Represents the child item of a [SocialFeedItem](socialfeeditem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_author.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_author.md index 46159ff895..a94f0df625 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_author.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_author.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Author --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Author ## -description Gets the author of the child item. ## -property-value The author of the child item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Author +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Author + +## -description +Gets the author of the child item. + +## -property-value +The author of the child item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_primarycontent.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_primarycontent.md index 9d21924fa3..19eb0f7c0a 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_primarycontent.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_primarycontent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.PrimaryContent --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.PrimaryContent ## -description Gets the primary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. ## -property-value The primary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.PrimaryContent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.PrimaryContent + +## -description +Gets the primary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. + +## -property-value +The primary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_secondarycontent.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_secondarycontent.md index e7e2dd889a..5cfc074a8d 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_secondarycontent.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_secondarycontent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SecondaryContent --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SecondaryContent ## -description Gets the secondary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. ## -property-value The secondary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SecondaryContent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SecondaryContent + +## -description +Gets the secondary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. + +## -property-value +The secondary [SocialFeedContent](socialfeedcontent.md) object associated with the child item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_shareditem.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_shareditem.md index 9f447b49e9..2bbddcf226 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_shareditem.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_shareditem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SharedItem --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SharedItem ## -description Gets a social media item that was shared with the user by another user of the service. ## -property-value A social media item that was shared with the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SharedItem +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SharedItem + +## -description +Gets a social media item that was shared with the user by another user of the service. + +## -property-value +A social media item that was shared with the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_socialfeedchilditem_1221375020.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_socialfeedchilditem_1221375020.md index 4ca5b1643c..027b577812 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_socialfeedchilditem_1221375020.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_socialfeedchilditem_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SocialFeedChildItem ## -description Initializes a new instance of the [SocialFeedChildItem](socialfeedchilditem.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.SocialFeedChildItem + +## -description +Initializes a new instance of the [SocialFeedChildItem](socialfeedchilditem.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_targeturi.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_targeturi.md index fbf92317d4..77b745533b 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_targeturi.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.TargetUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this child item. ## -property-value The Uniform Resource Identifier (URI) associated with the child item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.TargetUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this child item. + +## -property-value +The Uniform Resource Identifier (URI) associated with the child item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_thumbnails.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_thumbnails.md index 8effa90db1..62296bdaef 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_thumbnails.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_thumbnails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Thumbnails --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Thumbnails ## -description Gets a list of thumbnail images associated with the child item. ## -property-value A list of thumbnail images associated with the child item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Thumbnails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Thumbnails + +## -description +Gets a list of thumbnail images associated with the child item. + +## -property-value +A list of thumbnail images associated with the child item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedchilditem_timestamp.md b/windows.applicationmodel.socialinfo/socialfeedchilditem_timestamp.md index 33a7ed5f1b..be89c2b813 100644 --- a/windows.applicationmodel.socialinfo/socialfeedchilditem_timestamp.md +++ b/windows.applicationmodel.socialinfo/socialfeedchilditem_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Timestamp --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Timestamp ## -description Gets or sets the timestamp for the child item. ## -property-value The timestamp for the child item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Timestamp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedChildItem.Timestamp + +## -description +Gets or sets the timestamp for the child item. + +## -property-value +The timestamp for the child item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedcontent.md b/windows.applicationmodel.socialinfo/socialfeedcontent.md index a791f5c769..9df0e26bb1 100644 --- a/windows.applicationmodel.socialinfo/socialfeedcontent.md +++ b/windows.applicationmodel.socialinfo/socialfeedcontent.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedContent --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.SocialFeedContent ## -description Represents a social media message. ## -remarks The [SocialFeedSharedItem.Content](socialfeedshareditem_content.md), [SocialFeedChildItem.PrimaryContent](socialfeedchilditem_primarycontent.md) and [SocialFeedChildItem.SecondaryContent](socialfeedchilditem_secondarycontent.md) properties provide access to instances of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedContent +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedContent + +## -description +Represents a social media message. + +## -remarks +The [SocialFeedSharedItem.Content](socialfeedshareditem_content.md), [SocialFeedChildItem.PrimaryContent](socialfeedchilditem_primarycontent.md) and [SocialFeedChildItem.SecondaryContent](socialfeedchilditem_secondarycontent.md) properties provide access to instances of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedcontent_message.md b/windows.applicationmodel.socialinfo/socialfeedcontent_message.md index 5491792ffe..e612dd3335 100644 --- a/windows.applicationmodel.socialinfo/socialfeedcontent_message.md +++ b/windows.applicationmodel.socialinfo/socialfeedcontent_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedContent.Message --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedContent.Message ## -description Gets or sets the social media message. ## -property-value The social media message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedContent.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedContent.Message + +## -description +Gets or sets the social media message. + +## -property-value +The social media message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedcontent_targeturi.md b/windows.applicationmodel.socialinfo/socialfeedcontent_targeturi.md index 556ebac929..7f894dbca4 100644 --- a/windows.applicationmodel.socialinfo/socialfeedcontent_targeturi.md +++ b/windows.applicationmodel.socialinfo/socialfeedcontent_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedContent.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedContent.TargetUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the target of the content. ## -property-value The Uniform Resource Identifier (URI) of the content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedContent.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedContent.TargetUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the target of the content. + +## -property-value +The Uniform Resource Identifier (URI) of the content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedcontent_title.md b/windows.applicationmodel.socialinfo/socialfeedcontent_title.md index 79ee4a3c2f..2049c1b340 100644 --- a/windows.applicationmodel.socialinfo/socialfeedcontent_title.md +++ b/windows.applicationmodel.socialinfo/socialfeedcontent_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedContent.Title --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedContent.Title ## -description Gets or sets the title of the content. ## -property-value The title of the content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedContent.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedContent.Title + +## -description +Gets or sets the title of the content. + +## -property-value +The title of the content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem.md b/windows.applicationmodel.socialinfo/socialfeeditem.md index b980432902..445adcaf54 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedItem --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem ## -description Represents a social media feed item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedItem +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem + +## -description +Represents a social media feed item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_author.md b/windows.applicationmodel.socialinfo/socialfeeditem_author.md index f81cc25b46..9da5838a94 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_author.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_author.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Author --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.Author ## -description Gets the author of the social media feed item. ## -property-value The author of the social media feed item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Author +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.Author + +## -description +Gets the author of the social media feed item. + +## -property-value +The author of the social media feed item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_badgecountvalue.md b/windows.applicationmodel.socialinfo/socialfeeditem_badgecountvalue.md index 1b366a8ba4..6b76078592 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_badgecountvalue.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_badgecountvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeCountValue --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeCountValue ## -description Gets or sets the number of unseen items displayed on the app badge. ## -property-value The number of unseen items displayed on the app badge. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeCountValue +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeCountValue + +## -description +Gets or sets the number of unseen items displayed on the app badge. + +## -property-value +The number of unseen items displayed on the app badge. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_badgestyle.md b/windows.applicationmodel.socialinfo/socialfeeditem_badgestyle.md index 9af34b248f..559a308bf7 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_badgestyle.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_badgestyle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeStyle --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeStyle ## -description Gets or sets the badge style for the app. ## -property-value The badge style for the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeStyle +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.BadgeStyle + +## -description +Gets or sets the badge style for the app. + +## -property-value +The badge style for the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_childitem.md b/windows.applicationmodel.socialinfo/socialfeeditem_childitem.md index 21ebd9c145..b07221d2f1 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_childitem.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_childitem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.ChildItem --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.ChildItem ## -description Gets or sets the child item associated with this social feed item. ## -property-value The child item associated with this social feed item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.ChildItem +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.ChildItem + +## -description +Gets or sets the child item associated with this social feed item. + +## -property-value +The child item associated with this social feed item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_primarycontent.md b/windows.applicationmodel.socialinfo/socialfeeditem_primarycontent.md index 550c62e504..4dff3fcdcc 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_primarycontent.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_primarycontent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.PrimaryContent --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.PrimaryContent ## -description Gets the primary [SocialFeedContent](socialfeedcontent.md) object associated with the item. ## -property-value The primary [SocialFeedContent](socialfeedcontent.md) object associated with the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.PrimaryContent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.PrimaryContent + +## -description +Gets the primary [SocialFeedContent](socialfeedcontent.md) object associated with the item. + +## -property-value +The primary [SocialFeedContent](socialfeedcontent.md) object associated with the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_remoteid.md b/windows.applicationmodel.socialinfo/socialfeeditem_remoteid.md index 02aec4ed27..087a315118 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_remoteid.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.RemoteId ## -description Gets or sets the value used to identify this item on the provider's system. ## -property-value The value used to identify this item on the provider's system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.RemoteId + +## -description +Gets or sets the value used to identify this item on the provider's system. + +## -property-value +The value used to identify this item on the provider's system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_secondarycontent.md b/windows.applicationmodel.socialinfo/socialfeeditem_secondarycontent.md index 6c84e3b28d..ac17fc0cf2 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_secondarycontent.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_secondarycontent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.SecondaryContent --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.SecondaryContent ## -description Gets the secondary [SocialFeedContent](socialfeedcontent.md) object associated with this item. ## -property-value The secondary [SocialFeedContent](socialfeedcontent.md) object associated with this item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.SecondaryContent +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.SecondaryContent + +## -description +Gets the secondary [SocialFeedContent](socialfeedcontent.md) object associated with this item. + +## -property-value +The secondary [SocialFeedContent](socialfeedcontent.md) object associated with this item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_shareditem.md b/windows.applicationmodel.socialinfo/socialfeeditem_shareditem.md index 3d99f46d15..6ed2d357ae 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_shareditem.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_shareditem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.SharedItem --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.SharedItem ## -description Gets a social media item that was shared with the user by another user of the service. ## -property-value A social media item that was shared with the user by another user of the service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.SharedItem +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.SharedItem + +## -description +Gets a social media item that was shared with the user by another user of the service. + +## -property-value +A social media item that was shared with the user by another user of the service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_socialfeeditem_1221375020.md b/windows.applicationmodel.socialinfo/socialfeeditem_socialfeeditem_1221375020.md index 9d73de64fd..d67ed033e1 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_socialfeeditem_1221375020.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_socialfeeditem_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.SocialFeedItem.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.SocialFeedItem ## -description Initializes a new instance of the [SocialFeedItem](socialfeeditem.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.SocialFeedItem.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.SocialFeedItem + +## -description +Initializes a new instance of the [SocialFeedItem](socialfeeditem.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_style.md b/windows.applicationmodel.socialinfo/socialfeeditem_style.md index 6de5630692..dfc30582c8 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_style.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_style.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Style --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.Style ## -description Gets or set the style of this item, such as photo or default. ## -property-value The style of this item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Style +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.Style + +## -description +Gets or set the style of this item, such as photo or default. + +## -property-value +The style of this item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_targeturi.md b/windows.applicationmodel.socialinfo/socialfeeditem_targeturi.md index 07676a6257..31c1847abc 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_targeturi.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.TargetUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this item. ## -property-value The Uniform Resource Identifier (URI) associated with this item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.TargetUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this item. + +## -property-value +The Uniform Resource Identifier (URI) associated with this item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_thumbnails.md b/windows.applicationmodel.socialinfo/socialfeeditem_thumbnails.md index c3bf6e8806..38f5fc57ef 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_thumbnails.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_thumbnails.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Thumbnails --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.Thumbnails ## -description Gets a list of thumbnail images associated with this item. ## -property-value A list of thumbnail images associated with this item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Thumbnails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.Thumbnails + +## -description +Gets a list of thumbnail images associated with this item. + +## -property-value +A list of thumbnail images associated with this item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeeditem_timestamp.md b/windows.applicationmodel.socialinfo/socialfeeditem_timestamp.md index 254e6f314f..3c86414c88 100644 --- a/windows.applicationmodel.socialinfo/socialfeeditem_timestamp.md +++ b/windows.applicationmodel.socialinfo/socialfeeditem_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Timestamp --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedItem.Timestamp ## -description Gets or sets the timestamp for this item. ## -property-value The timestamp for this item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedItem.Timestamp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedItem.Timestamp + +## -description +Gets or sets the timestamp for this item. + +## -property-value +The timestamp for this item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem.md b/windows.applicationmodel.socialinfo/socialfeedshareditem.md index 9574c4fb91..ecde7c4d27 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem ## -description Represents a social media item that was shared with the user by another user of the service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem + +## -description +Represents a social media item that was shared with the user by another user of the service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem_content.md b/windows.applicationmodel.socialinfo/socialfeedshareditem_content.md index 39c0d793e1..d8f21032e5 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem_content.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem_content.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Content --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Content ## -description Gets the [SocialFeedContent](socialfeedcontent.md) object associated with the shared item. ## -property-value The [SocialFeedContent](socialfeedcontent.md) object associated with the shared item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Content +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Content + +## -description +Gets the [SocialFeedContent](socialfeedcontent.md) object associated with the shared item. + +## -property-value +The [SocialFeedContent](socialfeedcontent.md) object associated with the shared item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem_originalsource.md b/windows.applicationmodel.socialinfo/socialfeedshareditem_originalsource.md index b3dac0fd6b..508832d3c0 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem_originalsource.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem_originalsource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.OriginalSource --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.OriginalSource ## -description Gets or sets the original Uniform Resource Identifier (URI) of the shared item. ## -property-value The original Uniform Resource Identifier (URI) of the shared item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.OriginalSource +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.OriginalSource + +## -description +Gets or sets the original Uniform Resource Identifier (URI) of the shared item. + +## -property-value +The original Uniform Resource Identifier (URI) of the shared item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem_socialfeedshareditem_1221375020.md b/windows.applicationmodel.socialinfo/socialfeedshareditem_socialfeedshareditem_1221375020.md index 8087cb2328..bec40fee10 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem_socialfeedshareditem_1221375020.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem_socialfeedshareditem_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.SocialFeedSharedItem ## -description Initializes a new instance of the [SocialFeedSharedItem](socialfeedshareditem.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.SocialFeedSharedItem + +## -description +Initializes a new instance of the [SocialFeedSharedItem](socialfeedshareditem.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem_targeturi.md b/windows.applicationmodel.socialinfo/socialfeedshareditem_targeturi.md index fdb02bd6f3..e9d9f56a03 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem_targeturi.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.TargetUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this shared item. ## -property-value The Uniform Resource Identifier (URI) associated with the shared item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.TargetUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this shared item. + +## -property-value +The Uniform Resource Identifier (URI) associated with the shared item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem_thumbnail.md b/windows.applicationmodel.socialinfo/socialfeedshareditem_thumbnail.md index 7fb729f1f4..971f667304 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem_thumbnail.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Thumbnail --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Thumbnail ## -description Gets or sets a thumbnail image associated with this shared item. ## -property-value A thumbnail image associated with this shared item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Thumbnail + +## -description +Gets or sets a thumbnail image associated with this shared item. + +## -property-value +A thumbnail image associated with this shared item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialfeedshareditem_timestamp.md b/windows.applicationmodel.socialinfo/socialfeedshareditem_timestamp.md index 43b4bfd44b..dd3a148a0a 100644 --- a/windows.applicationmodel.socialinfo/socialfeedshareditem_timestamp.md +++ b/windows.applicationmodel.socialinfo/socialfeedshareditem_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Timestamp --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Timestamp ## -description Gets or sets the timestamp for this shared item. ## -property-value The timestamp for this shared item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Timestamp +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialFeedSharedItem.Timestamp + +## -description +Gets or sets the timestamp for this shared item. + +## -property-value +The timestamp for this shared item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialitemthumbnail.md b/windows.applicationmodel.socialinfo/socialitemthumbnail.md index 7e46d27a8e..a34782fd29 100644 --- a/windows.applicationmodel.socialinfo/socialitemthumbnail.md +++ b/windows.applicationmodel.socialinfo/socialitemthumbnail.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.SocialItemThumbnail ## -description Represents a thumbnail image associated with a social media feed item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialItemThumbnail + +## -description +Represents a thumbnail image associated with a social media feed item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialitemthumbnail_bitmapsize.md b/windows.applicationmodel.socialinfo/socialitemthumbnail_bitmapsize.md index 48f764386a..03207290ac 100644 --- a/windows.applicationmodel.socialinfo/socialitemthumbnail_bitmapsize.md +++ b/windows.applicationmodel.socialinfo/socialitemthumbnail_bitmapsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.BitmapSize --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.BitmapSize ## -description Gets or sets the size of the thumbnail bitmap image. ## -property-value The size of the thumbnail bitmap image. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.BitmapSize +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.BitmapSize + +## -description +Gets or sets the size of the thumbnail bitmap image. + +## -property-value +The size of the thumbnail bitmap image. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialitemthumbnail_imageuri.md b/windows.applicationmodel.socialinfo/socialitemthumbnail_imageuri.md index 2c008e5fb6..4c9d196d07 100644 --- a/windows.applicationmodel.socialinfo/socialitemthumbnail_imageuri.md +++ b/windows.applicationmodel.socialinfo/socialitemthumbnail_imageuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.ImageUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.ImageUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the image file for this thumbnail. ## -property-value The Uniform Resource Identifier (URI) to the image file for this thumbnail. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.ImageUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.ImageUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the image file for this thumbnail. + +## -property-value +The Uniform Resource Identifier (URI) to the image file for this thumbnail. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialitemthumbnail_setimageasync_124493182.md b/windows.applicationmodel.socialinfo/socialitemthumbnail_setimageasync_124493182.md index b7391abbc3..830189f9a6 100644 --- a/windows.applicationmodel.socialinfo/socialitemthumbnail_setimageasync_124493182.md +++ b/windows.applicationmodel.socialinfo/socialitemthumbnail_setimageasync_124493182.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.SetImageAsync(Windows.Storage.Streams.IInputStream) --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.SetImageAsync ## -description Asynchronously sets the image for this thumbnail from a local stream. ## -parameters ### -param image The image stream. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.SetImageAsync(Windows.Storage.Streams.IInputStream) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.SetImageAsync + +## -description +Asynchronously sets the image for this thumbnail from a local stream. + +## -parameters +### -param image +The image stream. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialitemthumbnail_socialitemthumbnail_1221375020.md b/windows.applicationmodel.socialinfo/socialitemthumbnail_socialitemthumbnail_1221375020.md index 233c467360..65ed61dd06 100644 --- a/windows.applicationmodel.socialinfo/socialitemthumbnail_socialitemthumbnail_1221375020.md +++ b/windows.applicationmodel.socialinfo/socialitemthumbnail_socialitemthumbnail_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.SocialItemThumbnail ## -description Initializes a new instance of the [SocialItemThumbnail](socialitemthumbnail.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.SocialItemThumbnail + +## -description +Initializes a new instance of the [SocialItemThumbnail](socialitemthumbnail.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialitemthumbnail_targeturi.md b/windows.applicationmodel.socialinfo/socialitemthumbnail_targeturi.md index a3feb4a857..44575e55cc 100644 --- a/windows.applicationmodel.socialinfo/socialitemthumbnail_targeturi.md +++ b/windows.applicationmodel.socialinfo/socialitemthumbnail_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.TargetUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this thumbnail. ## -property-value The Uniform Resource Identifier (URI) to the target item associated with this thumbnail. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialItemThumbnail.TargetUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the target item associated with this thumbnail. + +## -property-value +The Uniform Resource Identifier (URI) to the target item associated with this thumbnail. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialuserinfo.md b/windows.applicationmodel.socialinfo/socialuserinfo.md index e14855fac8..02d476ce99 100644 --- a/windows.applicationmodel.socialinfo/socialuserinfo.md +++ b/windows.applicationmodel.socialinfo/socialuserinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.SocialInfo.SocialUserInfo --api-type: winrt class ---- # Windows.ApplicationModel.SocialInfo.SocialUserInfo ## -description Represents a user of a social media provider service. ## -remarks The [SocialFeedChildItem.Author](socialfeedchilditem_author.md) property provides access to an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.SocialInfo.SocialUserInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialUserInfo + +## -description +Represents a user of a social media provider service. + +## -remarks +The [SocialFeedChildItem.Author](socialfeedchilditem_author.md) property provides access to an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialuserinfo_displayname.md b/windows.applicationmodel.socialinfo/socialuserinfo_displayname.md index c1f2a28219..fc50ac1edd 100644 --- a/windows.applicationmodel.socialinfo/socialuserinfo_displayname.md +++ b/windows.applicationmodel.socialinfo/socialuserinfo_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialUserInfo.DisplayName ## -description Gets or sets the name of the social media user, suitable for display. ## -property-value The name of the social media user, suitable for display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialUserInfo.DisplayName + +## -description +Gets or sets the name of the social media user, suitable for display. + +## -property-value +The name of the social media user, suitable for display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialuserinfo_remoteid.md b/windows.applicationmodel.socialinfo/socialuserinfo_remoteid.md index 379666095b..0828493d36 100644 --- a/windows.applicationmodel.socialinfo/socialuserinfo_remoteid.md +++ b/windows.applicationmodel.socialinfo/socialuserinfo_remoteid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.RemoteId --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialUserInfo.RemoteId ## -description Gets or sets a value that identifies the user on the social media service. ## -property-value A value that identifies the user on the social media service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialUserInfo.RemoteId + +## -description +Gets or sets a value that identifies the user on the social media service. + +## -property-value +A value that identifies the user on the social media service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialuserinfo_targeturi.md b/windows.applicationmodel.socialinfo/socialuserinfo_targeturi.md index fd914b05ec..2c50637559 100644 --- a/windows.applicationmodel.socialinfo/socialuserinfo_targeturi.md +++ b/windows.applicationmodel.socialinfo/socialuserinfo_targeturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.TargetUri --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialUserInfo.TargetUri ## -description Gets or sets the Uniform Resource Identifier (URI) to the user on the social media system. ## -property-value The Uniform Resource Identifier (URI) to the user on the social media system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.TargetUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialUserInfo.TargetUri + +## -description +Gets or sets the Uniform Resource Identifier (URI) to the user on the social media system. + +## -property-value +The Uniform Resource Identifier (URI) to the user on the social media system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.socialinfo/socialuserinfo_username.md b/windows.applicationmodel.socialinfo/socialuserinfo_username.md index 03ceb8bf6c..30b6d32dcb 100644 --- a/windows.applicationmodel.socialinfo/socialuserinfo_username.md +++ b/windows.applicationmodel.socialinfo/socialuserinfo_username.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.UserName --api-type: winrt property ---- # Windows.ApplicationModel.SocialInfo.SocialUserInfo.UserName ## -description Gets or sets the username for the user on the social media service. ## -property-value The username for the user on the social media service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SocialInfo.SocialUserInfo.UserName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SocialInfo.SocialUserInfo.UserName + +## -description +Gets or sets the username for the user on the social media service. + +## -property-value +The username for the user on the social media service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensemanager.md b/windows.applicationmodel.store.licensemanagement/licensemanager.md index 3525d59dc1..c5417a534f 100644 --- a/windows.applicationmodel.store.licensemanagement/licensemanager.md +++ b/windows.applicationmodel.store.licensemanagement/licensemanager.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager --api-type: winrt class ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseManager ## -description Provides members for managing license info for apps. ## -remarks ## -examples ## -see-also ## -capabilities storeLicenseManagement \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseManager + +## -description +Provides members for managing license info for apps. + +## -remarks + + +## -examples + +## -see-also + + +## -capabilities +storeLicenseManagement \ No newline at end of file diff --git a/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md b/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md index b10fbea247..00f480876b 100644 --- a/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md +++ b/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.AddLicenseAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.AddLicenseAsync ## -description Installs the specified app license. > [!NOTE] > This member requires the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). ## -parameters ### -param license The contents of the license to install. ## -returns An object that represents the installation operation. ## -remarks ## -examples ## -see-also ## -capabilities storeLicenseManagement \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.AddLicenseAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.AddLicenseAsync + +## -description +Installs the specified app license. + +> [!NOTE] +> This member requires the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). + +## -parameters +### -param license +The contents of the license to install. + +## -returns +An object that represents the installation operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +storeLicenseManagement diff --git a/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md b/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md index f59e6f49b7..135b26aab2 100644 --- a/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md +++ b/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.GetSatisfactionInfosAsync(Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.GetSatisfactionInfosAsync ## -description Gets license entitlement info for the specified products. > [!NOTE] > This member requires the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). ## -parameters ### -param contentIds The content IDs of the products for which to get license entitlement info. ### -param keyIds The key IDs of the products for which to get license entitlement info. ## -returns An asynchronous operation that, on successful completion, returns a [LicenseSatisfactionResult](licensesatisfactionresult.md) object that provides license entitlement info for the specified products. ## -remarks ## -examples ## -see-also ## -capabilities storeLicenseManagement \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.GetSatisfactionInfosAsync(Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.GetSatisfactionInfosAsync + +## -description +Gets license entitlement info for the specified products. + +> [!NOTE] +> This member requires the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). + +## -parameters +### -param contentIds +The content IDs of the products for which to get license entitlement info. + +### -param keyIds +The key IDs of the products for which to get license entitlement info. + +## -returns +An asynchronous operation that, on successful completion, returns a [LicenseSatisfactionResult](licensesatisfactionresult.md) object that provides license entitlement info for the specified products. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +storeLicenseManagement \ No newline at end of file diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo.md index 49a72fa323..1726ec7a13 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo --api-type: winrt class ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo ## -description Contains license entitlement info for a product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo + +## -description +Contains license entitlement info for a product. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_issatisfied.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_issatisfied.md index 96af34bdc3..08690c7f3d 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_issatisfied.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_issatisfied.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.IsSatisfied --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.IsSatisfied ## -description Gets a value that indicates whether a license entitlement exists for the product. ## -property-value True if a license entitlement exists for the product; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.IsSatisfied +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.IsSatisfied + +## -description +Gets a value that indicates whether a license entitlement exists for the product. + +## -property-value +True if a license entitlement exists for the product; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbydevice.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbydevice.md index a890e9e110..44b96328d3 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbydevice.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbydevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByDevice --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByDevice ## -description Gets a value that indicates whether the license entitlement is associated with the current device. ## -property-value True if the license entitlement is associated with the current device; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByDevice +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByDevice + +## -description +Gets a value that indicates whether the license entitlement is associated with the current device. + +## -property-value +True if the license entitlement is associated with the current device; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyinstallmedia.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyinstallmedia.md index 6b9bb752df..14759e62b6 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyinstallmedia.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyinstallmedia.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByInstallMedia --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByInstallMedia ## -description Gets a value that indicates whether the license entitlement is associated with installation media. ## -property-value True if the license entitlement is associated with installation media; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByInstallMedia +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByInstallMedia + +## -description +Gets a value that indicates whether the license entitlement is associated with installation media. + +## -property-value +True if the license entitlement is associated with installation media; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyopenlicense.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyopenlicense.md index 3ce3a0a723..821f898609 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyopenlicense.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbyopenlicense.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByOpenLicense --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByOpenLicense ## -description Gets a value that indicates whether the license entitlement is associated with an open license. ## -property-value True if the license entitlement is associated with an open license; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByOpenLicense +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByOpenLicense + +## -description +Gets a value that indicates whether the license entitlement is associated with an open license. + +## -property-value +True if the license entitlement is associated with an open license; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbypass.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbypass.md index 9c9fa202ad..1e06f1eefe 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbypass.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbypass.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByPass --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByPass ## -description Gets a value that indicates whether the license entitlement is associated with a pass. ## -property-value True if the license entitlement is associated with a pass; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByPass +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByPass + +## -description +Gets a value that indicates whether the license entitlement is associated with a pass. + +## -property-value +True if the license entitlement is associated with a pass; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbysignedinuser.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbysignedinuser.md index da3b367ab3..a8f51929f1 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbysignedinuser.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbysignedinuser.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedBySignedInUser --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedBySignedInUser ## -description Gets a value that indicates whether the license entitlement is associated with the current signed in user. ## -property-value True if the license entitlement is associated with the current signed in user; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedBySignedInUser +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedBySignedInUser + +## -description +Gets a value that indicates whether the license entitlement is associated with the current signed in user. + +## -property-value +True if the license entitlement is associated with the current signed in user; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbytrial.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbytrial.md index d229816770..aebb3c737c 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbytrial.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactioninfo_satisfiedbytrial.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByTrial --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByTrial ## -description Gets a value that indicates whether the license entitlement is associated with a trial. ## -property-value True if the license entitlement is associated with a trial; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByTrial +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionInfo.SatisfiedByTrial + +## -description +Gets a value that indicates whether the license entitlement is associated with a trial. + +## -property-value +True if the license entitlement is associated with a trial; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult.md index 11823c14d8..46bd800136 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult --api-type: winrt class ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult ## -description Provides license entitlement information that is returned by the [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md) method for the specified products. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult + +## -description +Provides license entitlement information that is returned by the [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md) method for the specified products. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_extendederror.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_extendederror.md index 6a48d76e8f..d8ca9a3745 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_extendederror.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_extendederror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.ExtendedError --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.ExtendedError ## -description Contains the error code that was returned by [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md). ## -property-value The error code that was returned by [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.ExtendedError + +## -description +Contains the error code that was returned by [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md). + +## -property-value +The error code that was returned by [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_licensesatisfactioninfos.md b/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_licensesatisfactioninfos.md index 3128bcfbe8..a6890b6566 100644 --- a/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_licensesatisfactioninfos.md +++ b/windows.applicationmodel.store.licensemanagement/licensesatisfactionresult_licensesatisfactioninfos.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.LicenseSatisfactionInfos --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.LicenseSatisfactionInfos ## -description Provides access to entitlement info that is returned by the [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md) method. ## -property-value A map of key and value pairs that represent entitlement info for the specified products. In each pair, the key is a content ID that you passed to [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md), and the value is a [LicenseSatisfactionInfo](licensesatisfactioninfo.md) object that provides entitlement info for the corresponding product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.LicenseSatisfactionInfos +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseSatisfactionResult.LicenseSatisfactionInfos + +## -description +Provides access to entitlement info that is returned by the [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md) method. + +## -property-value +A map of key and value pairs that represent entitlement info for the specified products. In each pair, the key is a content ID that you passed to [GetSatisfactionInfosAsync](licensemanager_getsatisfactioninfosasync.md), and the value is a [LicenseSatisfactionInfo](licensesatisfactioninfo.md) object that provides entitlement info for the corresponding product. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md index 0216a4e6ec..799be141f2 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem ## -description Represents an app that is in the installation queue. > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. ## -remarks Use the [AppInstallManager.AppInstallItems](appinstallmanager_appinstallitems.md) property to retrieve a vector view of [AppInstallItem](appinstallitem.md) objects. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem + +## -description +Represents an app that is in the installation queue. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks +Use the [AppInstallManager.AppInstallItems](appinstallmanager_appinstallitems.md) property to retrieve a vector view of [AppInstallItem](appinstallitem.md) objects. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_1985564044.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_1985564044.md index 277d37c0a8..380f1dcc08 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_1985564044.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_1985564044.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel ## -description Cancels the installation of the current app. ## -remarks ## -examples ## -see-also [Cancel(String)](appinstallitem_cancel_802731180.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel + +## -description +Cancels the installation of the current app. + +## -remarks + +## -examples + +## -see-also +[Cancel(String)](appinstallitem_cancel_802731180.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_802731180.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_802731180.md index f7260d7329..a872f09de0 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_802731180.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_cancel_802731180.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel ## -description Cancels the installation of the current app, with the option to generate telemetry data. ## -parameters ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also [Cancel](appinstallitem_cancel_1985564044.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Cancel + +## -description +Cancels the installation of the current app, with the option to generate telemetry data. + +## -parameters +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also +[Cancel](appinstallitem_cancel_1985564044.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_completed.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_completed.md index 89e4430e3c..bb6a139aa1 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_completed.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_completed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Completed --api-type: winrt event ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Completed ## -description Occurs when the installation of the current app has finished. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Completed +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Completed + +## -description +Occurs when the installation of the current app has finished. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_getcurrentstatus_1536936899.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_getcurrentstatus_1536936899.md index ea5f9a509f..00eeb54455 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_getcurrentstatus_1536936899.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_getcurrentstatus_1536936899.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.GetCurrentStatus --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.GetCurrentStatus ## -description Gets the installation status of the current app. ## -returns A value that specifies the installation status of the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.GetCurrentStatus +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.GetCurrentStatus + +## -description +Gets the installation status of the current app. + +## -returns +A value that specifies the installation status of the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_installtype.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_installtype.md index 95e0100eb4..fe39e7b6db 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_installtype.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_installtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.InstallType --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.InstallType ## -description Gets the type of the current app install. ## -property-value A value that indicates whether the app is being installed, updated, or repaired. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.InstallType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.InstallType + +## -description +Gets the type of the current app install. + +## -property-value +A value that indicates whether the app is being installed, updated, or repaired. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_isuserinitiated.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_isuserinitiated.md index d0246ba3eb..02901f4cef 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_isuserinitiated.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_isuserinitiated.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.IsUserInitiated --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.IsUserInitiated ## -description Indicates whether the current app install was initiated by the user. ## -property-value True if the current app install was initiated by the user; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.IsUserInitiated +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.IsUserInitiated + +## -description +Indicates whether the current app install was initiated by the user. + +## -property-value +True if the current app install was initiated by the user; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_packagefamilyname.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_packagefamilyname.md index 9da428c8a3..74e2a0022f 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_packagefamilyname.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_packagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.PackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.PackageFamilyName ## -description Gets the package family name for the current app. ## -property-value The package family name for the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.PackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.PackageFamilyName + +## -description +Gets the package family name for the current app. + +## -property-value +The package family name for the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_1953642114.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_1953642114.md index 4cac33d27d..d12e3fb5da 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_1953642114.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_1953642114.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause ## -description Pauses the installation of the current app. ## -remarks ## -examples ## -see-also [Pause(String)](appinstallitem_pause_770953122.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause + +## -description +Pauses the installation of the current app. + +## -remarks + +## -examples + +## -see-also +[Pause(String)](appinstallitem_pause_770953122.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_770953122.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_770953122.md index 0fa8f96f66..5f8392653e 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_770953122.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_pause_770953122.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause ## -description Pauses the installation of the current app, with the option to generate telemetry data. ## -parameters ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also [Pause](appinstallitem_pause_1953642114.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Pause + +## -description +Pauses the installation of the current app, with the option to generate telemetry data. + +## -parameters +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also +[Pause](appinstallitem_pause_1953642114.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_productid.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_productid.md index 5c51722fc7..f8d09c035d 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_productid.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_productid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.ProductId ## -description Gets the product ID for the current app. ## -property-value The product ID for the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.ProductId + +## -description +Gets the product ID for the current app. + +## -property-value +The product ID for the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_1108043616.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_1108043616.md index ae5301c3bd..bb3770df8e 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_1108043616.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_1108043616.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart ## -description Restarts the installation of the current app. ## -remarks ## -examples ## -see-also [Restart(String)](appinstallitem_restart_462069312.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart + +## -description +Restarts the installation of the current app. + +## -remarks + +## -examples + +## -see-also +[Restart(String)](appinstallitem_restart_462069312.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_462069312.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_462069312.md index 12872c5630..2ed7eeaec9 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_462069312.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_restart_462069312.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart ## -description Restarts the installation of the current app, with the option to generate telemetry data. ## -parameters ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also [Restart](appinstallitem_restart_1108043616.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Restart + +## -description +Restarts the installation of the current app, with the option to generate telemetry data. + +## -parameters +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also +[Restart](appinstallitem_restart_1108043616.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_statuschanged.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_statuschanged.md index 8656f00e99..5a1a564611 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_statuschanged.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_statuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.StatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.StatusChanged ## -description Occurs when the installation status of the current app has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.StatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.StatusChanged + +## -description +Occurs when the installation status of the current app has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md index 97bfbd3716..ab499a207e 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager ## -description Provides members for programmatically installing apps, including the ability to start an app install and get a list of app installs currently in progress. > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager + +## -description +Provides members for programmatically installing apps, including the ability to start an app install and get a list of app installs currently in progress. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_acquisitionidentity.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_acquisitionidentity.md index d9902d188d..d5ce388bf3 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_acquisitionidentity.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_acquisitionidentity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AcquisitionIdentity --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AcquisitionIdentity ## -description Gets or sets the user identity associated with the app installs. ## -property-value The user identity associated with the app installs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AcquisitionIdentity +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AcquisitionIdentity + +## -description +Gets or sets the user identity associated with the app installs. + +## -property-value +The user identity associated with the app installs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitems.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitems.md index 05e8b97a27..6d4af3603c 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitems.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitems.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallItems --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallItems ## -description Retrieves information about all apps that are currently in the installation queue. ## -property-value A collection of [AppInstallItem](appinstallitem.md) objects that represent all apps that are currently in the installation queue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallItems +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallItems + +## -description +Retrieves information about all apps that are currently in the installation queue. + +## -property-value +A collection of [AppInstallItem](appinstallitem.md) objects that represent all apps that are currently in the installation queue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallmanager_1221375020.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallmanager_1221375020.md index 1b5dfd6db1..4318726ffa 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallmanager_1221375020.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallmanager_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallManager ## -description Creates and initializes a new instance of the [AppInstallManager](appinstallmanager.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallManager + +## -description +Creates and initializes a new instance of the [AppInstallManager](appinstallmanager.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_autoupdatesetting.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_autoupdatesetting.md index c6979769b5..88e9a3d244 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_autoupdatesetting.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_autoupdatesetting.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AutoUpdateSetting --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AutoUpdateSetting ## -description Gets or sets the auto update setting for apps on the current computer or device. ## -property-value A value that specifies the auto update setting for apps on the current computer or device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AutoUpdateSetting +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AutoUpdateSetting + +## -description +Gets or sets the auto update setting for apps on the current computer or device. + +## -property-value +A value that specifies the auto update setting for apps on the current computer or device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_1663351060.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_1663351060.md index 9ecae9d29d..7ee08550fc 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_1663351060.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_1663351060.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel ## -description Cancels the installation of the specified app, with the option to generate telemetry data. ## -parameters ### -param productId The product ID of the app whose installation should be canceled. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also [Cancel(String)](appinstallmanager_cancel_802731180.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel + +## -description +Cancels the installation of the specified app, with the option to generate telemetry data. + +## -parameters +### -param productId +The product ID of the app whose installation should be canceled. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also +[Cancel(String)](appinstallmanager_cancel_802731180.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_802731180.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_802731180.md index 776c3590cc..cae96fd135 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_802731180.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_cancel_802731180.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel ## -description Cancels the installation of the specified app. ## -parameters ### -param productId The product ID of the app whose installation should be canceled. ## -remarks ## -examples ## -see-also [Cancel(String, String)](appinstallmanager_cancel_1663351060.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Cancel + +## -description +Cancels the installation of the specified app. + +## -parameters +### -param productId +The product ID of the app whose installation should be canceled. + +## -remarks + +## -examples + +## -see-also +[Cancel(String, String)](appinstallmanager_cancel_1663351060.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_714292356.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_714292356.md index e7addeb13c..7ea0865ec7 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_714292356.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_714292356.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync ## -description Determines whether the specified app has permission to install on the current computer or device. ## -parameters ### -param productId The product ID of the app that this method will check to determine if it has permission to be installed. ## -returns An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false. ## -remarks ## -examples ## -see-also [GetIsAppAllowedToInstallAsync(String, String, String, String)](appinstallmanager_getisappallowedtoinstallasync_865657668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync + +## -description +Determines whether the specified app has permission to install on the current computer or device. + +## -parameters +### -param productId +The product ID of the app that this method will check to determine if it has permission to be installed. + +## -returns +An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false. + +## -remarks + +## -examples + +## -see-also +[GetIsAppAllowedToInstallAsync(String, String, String, String)](appinstallmanager_getisappallowedtoinstallasync_865657668.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_865657668.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_865657668.md index 9ddd41536b..f26c7d85d2 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_865657668.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallasync_865657668.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync(System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync ## -description Determines whether the specified app has permission to install on the current computer or device, with the option to generate telemetry data. ## -parameters ### -param productId The product ID of the app that this method will check to determine if it has permission to be installed. ### -param skuId The SKU ID of the app that this method will check to determine if it has permission to be installed. ### -param catalogId The catalog ID of the app that this method will check to determine if it has permission to be installed. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false. ## -remarks ## -examples ## -see-also [GetIsAppAllowedToInstallAsync(String)](appinstallmanager_getisappallowedtoinstallasync_714292356.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync(System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallAsync + +## -description +Determines whether the specified app has permission to install on the current computer or device, with the option to generate telemetry data. + +## -parameters +### -param productId +The product ID of the app that this method will check to determine if it has permission to be installed. + +### -param skuId +The SKU ID of the app that this method will check to determine if it has permission to be installed. + +### -param catalogId +The catalog ID of the app that this method will check to determine if it has permission to be installed. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false. + +## -remarks + +## -examples + +## -see-also +[GetIsAppAllowedToInstallAsync(String)](appinstallmanager_getisappallowedtoinstallasync_714292356.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallforuserasync_1746033436.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallforuserasync_1746033436.md index 108e1593bb..bbd8675fb3 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallforuserasync_1746033436.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisappallowedtoinstallforuserasync_1746033436.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallForUserAsync(Windows.System.User,System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallForUserAsync ## -description Determines whether the specified app has permission to install on the current computer or device for the specified user, with the option to generate telemetry data. ## -parameters ### -param user An object that identifies the user to specify for this operation. ### -param productId The product ID of the app that this method will check to determine if it has permission to be installed. ### -param skuId The SKU ID of the app that this method will check to determine if it has permission to be installed. ### -param catalogId The catalog ID of the app that this method will check to determine if it has permission to be installed. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallForUserAsync(Windows.System.User,System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsAppAllowedToInstallForUserAsync + +## -description +Determines whether the specified app has permission to install on the current computer or device for the specified user, with the option to generate telemetry data. + +## -parameters +### -param user +An object that identifies the user to specify for this operation. + +### -param productId +The product ID of the app that this method will check to determine if it has permission to be installed. + +### -param skuId +The SKU ID of the app that this method will check to determine if it has permission to be installed. + +### -param catalogId +The catalog ID of the app that this method will check to determine if it has permission to be installed. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableasync_762892324.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableasync_762892324.md index ea2e2cef81..a14fce883b 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableasync_762892324.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableasync_762892324.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableAsync ## -description Determines whether the specified app can be installed on the current computer or device. ## -parameters ### -param productId The product ID of the app that this method will check to determine if it can be installed. ### -param skuId The SKU ID of the app that this method will check to determine if it can be installed. ## -returns An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableAsync + +## -description +Determines whether the specified app can be installed on the current computer or device. + +## -parameters +### -param productId +The product ID of the app that this method will check to determine if it can be installed. + +### -param skuId +The SKU ID of the app that this method will check to determine if it can be installed. + +## -returns +An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableforuserasync_1032207738.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableforuserasync_1032207738.md index 9963e7e2e2..28a3a07ad0 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableforuserasync_1032207738.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getisapplicableforuserasync_1032207738.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableForUserAsync(Windows.System.User,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableForUserAsync ## -description Determines whether the specified app can be installed on the current computer or device for the specified user. ## -parameters ### -param user An object that identifies the user to specify for this operation. ### -param productId The product ID of the app that this method will check to determine if it can be installed. ### -param skuId The SKU ID of the app that this method will check to determine if it can be installed. ## -returns An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableForUserAsync(Windows.System.User,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetIsApplicableForUserAsync + +## -description +Determines whether the specified app can be installed on the current computer or device for the specified user. + +## -parameters +### -param user +An object that identifies the user to specify for this operation. + +### -param productId +The product ID of the app that this method will check to determine if it can be installed. + +### -param skuId +The SKU ID of the app that this method will check to determine if it can be installed. + +## -returns +An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_isstoreblockedbypolicyasync_386900415.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_isstoreblockedbypolicyasync_386900415.md index 25db06265f..2fc14e68db 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_isstoreblockedbypolicyasync_386900415.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_isstoreblockedbypolicyasync_386900415.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.IsStoreBlockedByPolicyAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.IsStoreBlockedByPolicyAsync ## -description Determines whether the specified app is blocked by policy on the current computer or device. ## -parameters ### -param storeClientName The name of the app that this method will check to determine if is blocked by policy. ### -param storeClientPublisher The publisher name of the app that this method will check to determine if is blocked by policy. ## -returns An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.IsStoreBlockedByPolicyAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.IsStoreBlockedByPolicyAsync + +## -description +Determines whether the specified app is blocked by policy on the current computer or device. + +## -parameters +### -param storeClientName +The name of the app that this method will check to determine if is blocked by policy. + +### -param storeClientPublisher +The publisher name of the app that this method will check to determine if is blocked by policy. + +## -returns +An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemcompleted.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemcompleted.md index ef8af0b038..e3c2d6f6df 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemcompleted.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemCompleted --api-type: winrt event ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemCompleted ## -description Occurs when an app has finished installing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemCompleted +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemCompleted + +## -description +Occurs when an app has finished installing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemstatuschanged.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemstatuschanged.md index c6fa9873f3..e257db6f9c 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemstatuschanged.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_itemstatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemStatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemStatusChanged ## -description Occurs when the status of an app in the installation queue has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.ItemStatusChanged + +## -description +Occurs when the status of an app in the installation queue has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_movetofrontofdownloadqueue_258566692.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_movetofrontofdownloadqueue_258566692.md index bee0658f24..e5ad15610b 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_movetofrontofdownloadqueue_258566692.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_movetofrontofdownloadqueue_258566692.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.MoveToFrontOfDownloadQueue(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.MoveToFrontOfDownloadQueue ## -description Moves the specified app to the front of the download queue. ## -parameters ### -param productId The product ID of the app to move to the front of the download queue. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.MoveToFrontOfDownloadQueue(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.MoveToFrontOfDownloadQueue + +## -description +Moves the specified app to the front of the download queue. + +## -parameters +### -param productId +The product ID of the app to move to the front of the download queue. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_1628422686.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_1628422686.md index 1417c465d9..c99ba9b69b 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_1628422686.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_1628422686.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause ## -description Pauses the installation of the specified app, with the option to generate telemetry data. ## -parameters ### -param productId The product ID of the app whose installation should be paused. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also [Pause(String)](appinstallmanager_pause_770953122.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause + +## -description +Pauses the installation of the specified app, with the option to generate telemetry data. + +## -parameters +### -param productId +The product ID of the app whose installation should be paused. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also +[Pause(String)](appinstallmanager_pause_770953122.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_770953122.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_770953122.md index a228c47157..38616d4db6 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_770953122.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_pause_770953122.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause ## -description Pauses the installation of the specified app. ## -parameters ### -param productId The product ID of the app whose installation should be paused. ## -remarks ## -examples ## -see-also [Pause(String, String)](appinstallmanager_pause_1628422686.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Pause + +## -description +Pauses the installation of the specified app. + +## -parameters +### -param productId +The product ID of the app whose installation should be paused. + +## -remarks + +## -examples + +## -see-also +[Pause(String, String)](appinstallmanager_pause_1628422686.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_1467388928.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_1467388928.md index 79d9c3883c..fb0656e2c9 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_1467388928.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_1467388928.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart ## -description Restarts the installation of the specified app, with the option to generate telemetry data. ## -parameters ### -param productId The product ID of the app whose installation should be restarted. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -remarks ## -examples ## -see-also [Restart(String)](appinstallmanager_restart_462069312.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart + +## -description +Restarts the installation of the specified app, with the option to generate telemetry data. + +## -parameters +### -param productId +The product ID of the app whose installation should be restarted. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -remarks + +## -examples + +## -see-also +[Restart(String)](appinstallmanager_restart_462069312.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_462069312.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_462069312.md index 40f51e977b..4dadc0cc98 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_462069312.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_restart_462069312.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart ## -description Restarts the installation of the specified app. ## -parameters ### -param productId The product ID of the app whose installation should be restarted. ## -remarks ## -examples ## -see-also [Restart(String, String)](appinstallmanager_restart_1467388928.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.Restart + +## -description +Restarts the installation of the specified app. + +## -parameters +### -param productId +The product ID of the app whose installation should be restarted. + +## -remarks + +## -examples + +## -see-also +[Restart(String, String)](appinstallmanager_restart_1467388928.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_1093998542.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_1093998542.md index d4c2160ae8..02a5274d7f 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_1093998542.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_1093998542.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync ## -description Searches for all available updates to apps installed on the current computer or device. ## -returns An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also [SearchForAllUpdatesAsync(String)](appinstallmanager_searchforallupdatesasync_414510830.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync + +## -description +Searches for all available updates to apps installed on the current computer or device. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also +[SearchForAllUpdatesAsync(String)](appinstallmanager_searchforallupdatesasync_414510830.md) diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_414510830.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_414510830.md index ad2b5bb897..6fa44dd692 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_414510830.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesasync_414510830.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync ## -description Searches for all available updates to apps installed on the current computer or device, with the option to generate telemetry data. ## -parameters ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also [SearchForAllUpdatesAsync](appinstallmanager_searchforallupdatesasync_1093998542.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesAsync + +## -description +Searches for all available updates to apps installed on the current computer or device, with the option to generate telemetry data. + +## -parameters +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also +[SearchForAllUpdatesAsync](appinstallmanager_searchforallupdatesasync_1093998542.md) diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesforuserasync_1181961.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesforuserasync_1181961.md index de0708828a..8c3fb8d135 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesforuserasync_1181961.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforallupdatesforuserasync_1181961.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesForUserAsync(Windows.System.User,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesForUserAsync ## -description Searches for all available updates to apps installed on the current computer or device for the specified user, with the option to generate telemetry data. ## -parameters ### -param user An object that identifies the user to specify for this operation. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesForUserAsync(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForAllUpdatesForUserAsync + +## -description +Searches for all available updates to apps installed on the current computer or device for the specified user, with the option to generate telemetry data. + +## -parameters +### -param user +An object that identifies the user to specify for this operation. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_1943061489.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_1943061489.md index 75a31e7c5e..f22f565652 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_1943061489.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_1943061489.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync ## -description Searches for updates for the specified app. ## -parameters ### -param productId The product ID of the app to be queried for updates. ### -param skuId The SKU to be queried for updates. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the available update. ## -remarks ## -examples ## -see-also [SearchForUpdatesAsync(String, String, String, String)](appinstallmanager_searchforupdatesasync_640094607.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync + +## -description +Searches for updates for the specified app. + +## -parameters +### -param productId +The product ID of the app to be queried for updates. + +### -param skuId +The SKU to be queried for updates. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the available update. + +## -remarks + +## -examples + +## -see-also +[SearchForUpdatesAsync(String, String, String, String)](appinstallmanager_searchforupdatesasync_640094607.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_640094607.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_640094607.md index 2220ad9353..522891e2bd 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_640094607.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesasync_640094607.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync(System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync ## -description Searches for updates for the specified app, with the option to generate telemetry data. ## -parameters ### -param productId The product ID of the app to be queried for updates. ### -param skuId The SKU ID of the app to be queried for updates. ### -param catalogId The catalog ID of the app to be queried for updates. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the available update. ## -remarks ## -examples ## -see-also [SearchForUpdatesAsync(String, String)](appinstallmanager_searchforupdatesasync_1943061489.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync(System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesAsync + +## -description +Searches for updates for the specified app, with the option to generate telemetry data. + +## -parameters +### -param productId +The product ID of the app to be queried for updates. + +### -param skuId +The SKU ID of the app to be queried for updates. + +### -param catalogId +The catalog ID of the app to be queried for updates. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the available update. + +## -remarks + +## -examples + +## -see-also +[SearchForUpdatesAsync(String, String)](appinstallmanager_searchforupdatesasync_1943061489.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesforuserasync_1776746151.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesforuserasync_1776746151.md index d756888532..e2ccd9a8cf 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesforuserasync_1776746151.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_searchforupdatesforuserasync_1776746151.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesForUserAsync(Windows.System.User,System.String,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesForUserAsync ## -description Searches for updates for the specified app and user, with the option to generate telemetry data. ## -parameters ### -param user An object that identifies the user to specify for this operation. ### -param productId The product ID of the app to be queried for updates. ### -param skuId The SKU ID of the app to be queried for updates. ### -param catalogId The catalog ID of the app to be queried for updates. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the available update. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesForUserAsync(Windows.System.User,System.String,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.SearchForUpdatesForUserAsync + +## -description +Searches for updates for the specified app and user, with the option to generate telemetry data. + +## -parameters +### -param user +An object that identifies the user to specify for this operation. + +### -param productId +The product ID of the app to be queried for updates. + +### -param skuId +The SKU ID of the app to be queried for updates. + +### -param catalogId +The catalog ID of the app to be queried for updates. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the available update. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1608657462.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1608657462.md index b60db79a3d..1f8bfe2d31 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1608657462.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1608657462.md @@ -1,3 +1,46 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync(System.String,System.String,System.Boolean,System.Boolean,System.String,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync ## -description Starts the installation of the specified app, with the option to generate telemetry data. ## -parameters ### -param productId The product ID of the app to install. ### -param skuId The SKU ID of the app to install. ### -param repair True to attempt to repair the installation of an app that is already installed; otherwise, false. ### -param forceUseOfNonRemovableStorage True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. ### -param catalogId The catalog ID of the app to install. ### -param bundleId The bundle ID of the app to install. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app that was added to the installation queue. ## -remarks The remarks for [StartAppInstallAsync(String, String, Boolean, Boolean)](appinstallmanager_startappinstallasync_1749232586.md) also apply to this method. ## -examples ## -see-also [StartAppInstallAsync(String, String, Boolean, Boolean)](appinstallmanager_startappinstallasync_1749232586.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync(System.String,System.String,System.Boolean,System.Boolean,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync + +## -description +Starts the installation of the specified app, with the option to generate telemetry data. + +## -parameters +### -param productId +The product ID of the app to install. + +### -param skuId +The SKU ID of the app to install. + +### -param repair +True to attempt to repair the installation of an app that is already installed; otherwise, false. + +### -param forceUseOfNonRemovableStorage +True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. + +### -param catalogId +The catalog ID of the app to install. + +### -param bundleId +The bundle ID of the app to install. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app that was added to the installation queue. + +## -remarks +The remarks for [StartAppInstallAsync(String, String, Boolean, Boolean)](appinstallmanager_startappinstallasync_1749232586.md) also apply to this method. + +## -examples + +## -see-also +[StartAppInstallAsync(String, String, Boolean, Boolean)](appinstallmanager_startappinstallasync_1749232586.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1749232586.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1749232586.md index 2ef4ac4947..29c1c7f303 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1749232586.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startappinstallasync_1749232586.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync(System.String,System.String,System.Boolean,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync ## -description Starts the installation of the specified app. ## -parameters ### -param productId The product ID of the app to install. ### -param skuId The SKU ID of the app to install. ### -param repair True to attempt to repair the installation of an app that is already installed; otherwise, false. ### -param forceUseOfNonRemovableStorage True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app that was added to the installation queue. ## -remarks When this method successfully returns, the app has been added to the installation queue; it does not necessarily mean that the app has finished installed. To determine the installation status, check the [GetCurrentStatus](appinstallitem_getcurrentstatus.md) method of the [AppInstallItem](appinstallitem.md) return value. ## -examples ## -see-also [StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String)](appinstallmanager_startappinstallasync_1608657462.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync(System.String,System.String,System.Boolean,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartAppInstallAsync + +## -description +Starts the installation of the specified app. + +## -parameters +### -param productId +The product ID of the app to install. + +### -param skuId +The SKU ID of the app to install. + +### -param repair +True to attempt to repair the installation of an app that is already installed; otherwise, false. + +### -param forceUseOfNonRemovableStorage +True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app that was added to the installation queue. + +## -remarks +When this method successfully returns, the app has been added to the installation queue; it does not necessarily mean that the app has finished installed. To determine the installation status, check the [GetCurrentStatus](appinstallitem_getcurrentstatus.md) method of the [AppInstallItem](appinstallitem.md) return value. + +## -examples + +## -see-also +[StartAppInstallAsync(String, String, Boolean, Boolean, String, String, String)](appinstallmanager_startappinstallasync_1608657462.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallasync_114054218.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallasync_114054218.md index 1f8dbe7be4..a24ee0110a 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallasync_114054218.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallasync_114054218.md @@ -1,3 +1,47 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallAsync(System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallAsync ## -description Starts the installation of the specified app or app bundle. ## -parameters ### -param productId The product ID of the app to install. ### -param catalogId The catalog ID of the app to install. ### -param flightId The bundle to install. ### -param clientId The ID of the caller. ### -param repair True to attempt to repair the installation of an app that is already installed; otherwise, false. ### -param forceUseOfNonRemovableStorage True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ### -param targetVolume The package storage volume where the app or app bundle will be installed. ## -returns An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallAsync(System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallAsync + +## -description +Starts the installation of the specified app or app bundle. + +## -parameters +### -param productId +The product ID of the app to install. + +### -param catalogId +The catalog ID of the app to install. + +### -param flightId +The bundle to install. + +### -param clientId +The ID of the caller. + +### -param repair +True to attempt to repair the installation of an app that is already installed; otherwise, false. + +### -param forceUseOfNonRemovableStorage +True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +### -param targetVolume +The package storage volume where the app or app bundle will be installed. + +## -returns +An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallforuserasync_17648756.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallforuserasync_17648756.md index 7b30955654..4e55de2659 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallforuserasync_17648756.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_startproductinstallforuserasync_17648756.md @@ -1,3 +1,50 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallForUserAsync(Windows.System.User,System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallForUserAsync ## -description Starts the installation of the specified app or app bundle for the specified user. ## -parameters ### -param user An object that identifies the user to specify for this operation. ### -param productId The product ID of the app to install. ### -param catalogId The catalog ID of the app to install. ### -param flightId The bundle to install. ### -param clientId The ID of the caller. ### -param repair True to attempt to repair the installation of an app that is already installed; otherwise, false. ### -param forceUseOfNonRemovableStorage True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ### -param targetVolume The package storage volume where the app or app bundle will be installed. ## -returns An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallForUserAsync(Windows.System.User,System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.StartProductInstallForUserAsync + +## -description +Starts the installation of the specified app or app bundle for the specified user. + +## -parameters +### -param user +An object that identifies the user to specify for this operation. + +### -param productId +The product ID of the app to install. + +### -param catalogId +The catalog ID of the app to install. + +### -param flightId +The bundle to install. + +### -param clientId +The ID of the caller. + +### -param repair +True to attempt to repair the installation of an app that is already installed; otherwise, false. + +### -param forceUseOfNonRemovableStorage +True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +### -param targetVolume +The package storage volume where the app or app bundle will be installed. + +## -returns +An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [AppInstallItem](appinstallitem.md) items. (You can use APIs of [IVectorView<AppInstallItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<AppInstallItem>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_2125212473.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_2125212473.md index 35e0f354de..76b5630ef7 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_2125212473.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_2125212473.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync ## -description Starts the update of an app specified by the package family name. ## -parameters ### -param packageFamilyName The package family name of the app to update. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app update that was added to the installation queue. ## -remarks ## -examples ## -see-also [UpdateAppByPackageFamilyNameAsync(String, String)](appinstallmanager_updateappbypackagefamilynameasync_844113543.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync + +## -description +Starts the update of an app specified by the package family name. + +## -parameters +### -param packageFamilyName +The package family name of the app to update. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app update that was added to the installation queue. + +## -remarks + +## -examples + +## -see-also +[UpdateAppByPackageFamilyNameAsync(String, String)](appinstallmanager_updateappbypackagefamilynameasync_844113543.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_844113543.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_844113543.md index 617a5539b9..0a61c2d953 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_844113543.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameasync_844113543.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync ## -description Starts the update of an app specified by the package family name, with the option to generate telemetry data. ## -parameters ### -param packageFamilyName The package family name of the app to update. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app update that was added to the installation queue. ## -remarks ## -examples ## -see-also [UpdateAppByPackageFamilyNameAsync(String)](appinstallmanager_updateappbypackagefamilynameasync_2125212473.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameAsync + +## -description +Starts the update of an app specified by the package family name, with the option to generate telemetry data. + +## -parameters +### -param packageFamilyName +The package family name of the app to update. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app update that was added to the installation queue. + +## -remarks + +## -examples + +## -see-also +[UpdateAppByPackageFamilyNameAsync(String)](appinstallmanager_updateappbypackagefamilynameasync_2125212473.md) \ No newline at end of file diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameforuserasync_2066347922.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameforuserasync_2066347922.md index 8a3a927e57..ff83a2b941 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameforuserasync_2066347922.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_updateappbypackagefamilynameforuserasync_2066347922.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameForUserAsync(Windows.System.User,System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameForUserAsync ## -description Starts the update of an app for a given user specified by the package family name, with the option to generate telemetry data. ## -parameters ### -param user An object that identifies the user to specify for this operation. ### -param packageFamilyName The package family name of the app to update. ### -param correlationVector A correlation vector string that can be used to generate telemetry data. ## -returns An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app update that was added to the installation queue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameForUserAsync(Windows.System.User,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.UpdateAppByPackageFamilyNameForUserAsync + +## -description +Starts the update of an app for a given user specified by the package family name, with the option to generate telemetry data. + +## -parameters +### -param user +An object that identifies the user to specify for this operation. + +### -param packageFamilyName +The package family name of the app to update. + +### -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns an [AppInstallItem](appinstallitem.md) that represents the app update that was added to the installation queue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md index fad41624d0..a23fe80d28 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs ## -description Provides data for the [ItemCompleted](appinstallmanager_itemcompleted.md) and [ItemStatusChanged](appinstallmanager_itemstatuschanged.md) events. > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. ## -remarks An instance of this class is passed to the event handler that you implement for the [AppInstallManager.ItemCompleted](appinstallmanager_itemcompleted.md) and [AppInstallManager.ItemStatusChanged](appinstallmanager_itemstatuschanged.md) events. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs + +## -description +Provides data for the [ItemCompleted](appinstallmanager_itemcompleted.md) and [ItemStatusChanged](appinstallmanager_itemstatuschanged.md) events. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks +An instance of this class is passed to the event handler that you implement for the [AppInstallManager.ItemCompleted](appinstallmanager_itemcompleted.md) and [AppInstallManager.ItemStatusChanged](appinstallmanager_itemstatuschanged.md) events. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs_item.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs_item.md index 9ae3cd01cc..15015ee090 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs_item.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs_item.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs.Item --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs.Item ## -description Gets an object that describes the app that has finished installing (for the [ItemCompleted](appinstallmanager_itemcompleted.md) event) or whose installation status has changed (for the [ItemStatusChanged](appinstallmanager_itemstatuschanged.md) event). ## -property-value An object that describes the app that has finished installing or whose installation status has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs.Item +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManagerItemEventArgs.Item + +## -description +Gets an object that describes the app that has finished installing (for the [ItemCompleted](appinstallmanager_itemcompleted.md) event) or whose installation status has changed (for the [ItemStatusChanged](appinstallmanager_itemstatuschanged.md) event). + +## -property-value +An object that describes the app that has finished installing or whose installation status has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md index 6f6deaef6f..1799d64b4d 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus ## -description Describes the status of an app that is in the installation queue. > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. ## -remarks To retrieve an instance of this class, use the [GetCurrentStatus](appinstallitem_getcurrentstatus.md) method of the [AppInstallItem](appinstallitem.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus + +## -description +Describes the status of an app that is in the installation queue. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks +To retrieve an instance of this class, use the [GetCurrentStatus](appinstallitem_getcurrentstatus.md) method of the [AppInstallItem](appinstallitem.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_bytesdownloaded.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_bytesdownloaded.md index 4b216137b0..fc1da0b0a1 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_bytesdownloaded.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_bytesdownloaded.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.BytesDownloaded --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.BytesDownloaded ## -description Gets the number of bytes that have been downloaded for the current app. ## -property-value The number of bytes that have been downloaded for the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.BytesDownloaded +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.BytesDownloaded + +## -description +Gets the number of bytes that have been downloaded for the current app. + +## -property-value +The number of bytes that have been downloaded for the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_downloadsizeinbytes.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_downloadsizeinbytes.md index 1d04cc6282..b319d5b1d0 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_downloadsizeinbytes.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_downloadsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.DownloadSizeInBytes --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.DownloadSizeInBytes ## -description Gets the download size in bytes for the current app. ## -property-value The download size in bytes for the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.DownloadSizeInBytes +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.DownloadSizeInBytes + +## -description +Gets the download size in bytes for the current app. + +## -property-value +The download size in bytes for the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_errorcode.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_errorcode.md index 18d0fc803c..2803683964 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_errorcode.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_errorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ErrorCode ## -description Gets the error code for an app that has encountered an installation failure. ## -property-value The error code for an app that has encountered an installation failure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ErrorCode + +## -description +Gets the error code for an app that has encountered an installation failure. + +## -property-value +The error code for an app that has encountered an installation failure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_installstate.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_installstate.md index a0c9b9c17d..133b8b47e8 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_installstate.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_installstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.InstallState --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.InstallState ## -description Gets the installation state of the current app. ## -property-value A value that specifies the installation state of the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.InstallState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.InstallState + +## -description +Gets the installation state of the current app. + +## -property-value +A value that specifies the installation state of the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_percentcomplete.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_percentcomplete.md index 131356e1ca..5a2eced5ea 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_percentcomplete.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_percentcomplete.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.PercentComplete --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.PercentComplete ## -description Gets the completion percentage for the installation of the current app. ## -property-value The completion percentage for the installation of the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.PercentComplete +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.PercentComplete + +## -description +Gets the completion percentage for the installation of the current app. + +## -property-value +The completion percentage for the installation of the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_readyforlaunch.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_readyforlaunch.md index 9b703ebf80..580bb954ee 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_readyforlaunch.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_readyforlaunch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ReadyForLaunch --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ReadyForLaunch ## -description Gets a value that indicates whether the app can be launched, even if the app has not yet finished installing. ## -property-value True if the app can be launched; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ReadyForLaunch +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.ReadyForLaunch + +## -description +Gets a value that indicates whether the app can be launched, even if the app has not yet finished installing. + +## -property-value +True if the app can be launched; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_user.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_user.md index 1a768618e0..890cdb0510 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_user.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.User --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.User ## -description Gets an object that identifies the user for which the app is being installed. ## -property-value An object that identifies the user for which the app is being installed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallStatus.User + +## -description +Gets an object that identifies the user for which the app is being installed. + +## -property-value +An object that identifies the user for which the app is being installed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration.md b/windows.applicationmodel.store.preview/storeconfiguration.md index 53483ab943..fc7d8c733e 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration.md +++ b/windows.applicationmodel.store.preview/storeconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.StoreConfiguration --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration ## -description Defines static methods and properties for accessing information about the device hardware and configuring information about the system, the mobile operator, and the active user account. These members are used in various Windows Store scenarios. > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.StoreConfiguration +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration + +## -description +Defines static methods and properties for accessing information about the device hardware and configuring information about the system, the mobile operator, and the active user account. These members are used in various Windows Store scenarios. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_filterunsupportedsystemfeaturesasync_1497477694.md b/windows.applicationmodel.store.preview/storeconfiguration_filterunsupportedsystemfeaturesasync_1497477694.md index 1ff915b5cd..8a1c06b76e 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_filterunsupportedsystemfeaturesasync_1497477694.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_filterunsupportedsystemfeaturesasync_1497477694.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.FilterUnsupportedSystemFeaturesAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Store.Preview.StoreSystemFeature}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.FilterUnsupportedSystemFeaturesAsync ## -description Given a list of hardware features, this method returns a modified list that contains only the hardware features that are supported on the current device. ## -parameters ### -param systemFeatures A list of [StoreSystemFeature](storesystemfeature.md) objects that represent the hardware features to be queried on the current device. ## -returns An asynchronous operation that, on successful completion, returns a list of hardware features that are supported on the current device. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [StoreSystemFeature](storesystemfeature.md) items. (You can use APIs of [IVectorView<StoreSystemFeature>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<StoreSystemFeature>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.FilterUnsupportedSystemFeaturesAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Store.Preview.StoreSystemFeature}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.FilterUnsupportedSystemFeaturesAsync + +## -description +Given a list of hardware features, this method returns a modified list that contains only the hardware features that are supported on the current device. + +## -parameters +### -param systemFeatures +A list of [StoreSystemFeature](storesystemfeature.md) objects that represent the hardware features to be queried on the current device. + +## -returns +An asynchronous operation that, on successful completion, returns a list of hardware features that are supported on the current device. If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [StoreSystemFeature](storesystemfeature.md) items. (You can use APIs of [IVectorView<StoreSystemFeature>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<StoreSystemFeature>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_getpurchasepromptingpolicyforuser_1650154556.md b/windows.applicationmodel.store.preview/storeconfiguration_getpurchasepromptingpolicyforuser_1650154556.md index 297fdd20d7..55cf55e480 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_getpurchasepromptingpolicyforuser_1650154556.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_getpurchasepromptingpolicyforuser_1650154556.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetPurchasePromptingPolicyForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetPurchasePromptingPolicyForUser ## -description Gets a value that indicates whether the Windows Store prompts the specified user before making a purchase. ## -parameters ### -param user An object that identifies the user for which to query. ## -returns A **UInt32** value that indicates whether the Windows Store prompts the specified user before making a purchase.
ValueDescription
**1**The Windows Store prompts the specified user before making a purchase.
**0**The Windows Store does not prompt the specified user before making a purchase.
## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetPurchasePromptingPolicyForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetPurchasePromptingPolicyForUser + +## -description +Gets a value that indicates whether the Windows Store prompts the specified user before making a purchase. + +## -parameters +### -param user +An object that identifies the user for which to query. + +## -returns +A **UInt32** value that indicates whether the Windows Store prompts the specified user before making a purchase. + + + +
ValueDescription
**1**The Windows Store prompts the specified user before making a purchase.
**0**The Windows Store does not prompt the specified user before making a purchase.
+ +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_getstorelogdataasync_165112752.md b/windows.applicationmodel.store.preview/storeconfiguration_getstorelogdataasync_165112752.md index 5269b76304..d746198cf9 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_getstorelogdataasync_165112752.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_getstorelogdataasync_165112752.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreLogDataAsync(Windows.ApplicationModel.Store.Preview.StoreLogOptions) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreLogDataAsync ## -description Gets Windows Store log data for the current device. ## -parameters ### -param options A value that specifies options for the log data request. ## -returns An asynchronous operation that, on successful completion, returns an [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) object that contains the log data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreLogDataAsync(Windows.ApplicationModel.Store.Preview.StoreLogOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreLogDataAsync + +## -description +Gets Windows Store log data for the current device. + +## -parameters +### -param options +A value that specifies options for the log data request. + +## -returns +An asynchronous operation that, on successful completion, returns an [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) object that contains the log data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_hardwaremanufacturerinfo.md b/windows.applicationmodel.store.preview/storeconfiguration_hardwaremanufacturerinfo.md index 223964b4db..439f8cda58 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_hardwaremanufacturerinfo.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_hardwaremanufacturerinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StoreConfiguration.HardwareManufacturerInfo --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.HardwareManufacturerInfo ## -description Gets hardware manufacturer information for the current device. ## -property-value An object that provides information about the hardware manufacturer of the current device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StoreConfiguration.HardwareManufacturerInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.HardwareManufacturerInfo + +## -description +Gets hardware manufacturer information for the current device. + +## -property-value +An object that provides information about the hardware manufacturer of the current device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccount_145149390.md b/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccount_145149390.md index 91b7269d55..ccddf85aec 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccount_145149390.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccount_145149390.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccount --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccount ## -description Determines whether the current user has a Windows Store account. ## -returns True if the current user has a Windows Store account; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccount +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccount + +## -description +Determines whether the current user has a Windows Store account. + +## -returns +True if the current user has a Windows Store account; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccountforuser_117935305.md b/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccountforuser_117935305.md index 023614cab0..94a04803f6 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccountforuser_117935305.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_hasstorewebaccountforuser_117935305.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccountForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccountForUser ## -description Determines whether the specified user has a Windows Store account. ## -parameters ### -param user An object that identifies the user for which to query. ## -returns True if the specified userhas a Windows Store account; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccountForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.HasStoreWebAccountForUser + +## -description +Determines whether the specified user has a Windows Store account. + + + +## -parameters +### -param user +An object that identifies the user for which to query. + +## -returns +True if the specified userhas a Windows Store account; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountid_1989833487.md b/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountid_1989833487.md index be6067cf1f..35c74229fe 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountid_1989833487.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountid_1989833487.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountId(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountId ## -description Determines whether the specified user ID is also being used to sign in to the Windows Store on the device. ## -parameters ### -param webAccountId The user ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to check. ## -returns True if the user account specified by *webAccountId* is the same account that is signed in to the Windows Store; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountId(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountId + +## -description +Determines whether the specified user ID is also being used to sign in to the Windows Store on the device. + +## -parameters +### -param webAccountId +The user ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to check. + +## -returns +True if the user account specified by *webAccountId* is the same account that is signed in to the Windows Store; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountidforuser_126563483.md b/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountidforuser_126563483.md index 62138ec921..42571ad77b 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountidforuser_126563483.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_isstorewebaccountidforuser_126563483.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountIdForUser(Windows.System.User,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountIdForUser ## -description Determines whether the specified user and user ID is also being used to sign in to the Windows Store on the device. ## -parameters ### -param user An object that identifies the user for which to query. ### -param webAccountId The user ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to check. ## -returns True if the user account specified by *webAccountId* is the same account that is signed in to the Windows Store; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountIdForUser(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.IsStoreWebAccountIdForUser + +## -description +Determines whether the specified user and user ID is also being used to sign in to the Windows Store on the device. + +## -parameters +### -param user +An object that identifies the user for which to query. + +### -param webAccountId +The user ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to check. + +## -returns +True if the user account specified by *webAccountId* is the same account that is signed in to the Windows Store; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_purchasepromptingpolicy.md b/windows.applicationmodel.store.preview/storeconfiguration_purchasepromptingpolicy.md index 0ccd72e631..cbde374e50 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_purchasepromptingpolicy.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_purchasepromptingpolicy.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StoreConfiguration.PurchasePromptingPolicy --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.PurchasePromptingPolicy ## -description Gets or sets a value that indicates whether the Windows Store prompts the user before making a purchase. ## -property-value A **UInt32** value that indicates whether the Windows Store prompts the user before making a purchase.
ValueDescription
**1**The Windows Store prompts the end user before making a purchase.
**0**The Windows Store does not prompt the end user before making a purchase.
## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StoreConfiguration.PurchasePromptingPolicy +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.PurchasePromptingPolicy + +## -description +Gets or sets a value that indicates whether the Windows Store prompts the user before making a purchase. + +## -property-value +A **UInt32** value that indicates whether the Windows Store prompts the user before making a purchase. + + + +
ValueDescription
**1**The Windows Store prompts the end user before making a purchase.
**0**The Windows Store does not prompt the end user before making a purchase.
+ +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setmobileoperatorconfiguration_1493870147.md b/windows.applicationmodel.store.preview/storeconfiguration_setmobileoperatorconfiguration_1493870147.md index 2003872e37..1606bf8706 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_setmobileoperatorconfiguration_1493870147.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_setmobileoperatorconfiguration_1493870147.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetMobileOperatorConfiguration(System.String,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetMobileOperatorConfiguration ## -description Configures mobile operator information for the device. ## -parameters ### -param mobileOperatorId The mobile operator ID. ### -param appDownloadLimitInMegabytes The maximum app download size defined by the mobile operator, in MB. ### -param updateDownloadLimitInMegabytes The maximum OS update download size defined by the mobile operator, in MB. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetMobileOperatorConfiguration(System.String,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetMobileOperatorConfiguration + +## -description +Configures mobile operator information for the device. + +## -parameters +### -param mobileOperatorId +The mobile operator ID. + +### -param appDownloadLimitInMegabytes +The maximum app download size defined by the mobile operator, in MB. + +### -param updateDownloadLimitInMegabytes +The maximum OS update download size defined by the mobile operator, in MB. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setpurchasepromptingpolicyforuser_1980317307.md b/windows.applicationmodel.store.preview/storeconfiguration_setpurchasepromptingpolicyforuser_1980317307.md index a06175af75..5026ef9c3c 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_setpurchasepromptingpolicyforuser_1980317307.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_setpurchasepromptingpolicyforuser_1980317307.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetPurchasePromptingPolicyForUser(Windows.System.User,Windows.Foundation.IReference{System.UInt32}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetPurchasePromptingPolicyForUser ## -description Sets a value that indicates whether the Windows Store prompts the user before making a purchase. ## -parameters ### -param user An object that identifies the user for which to perform this operation. ### -param value ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetPurchasePromptingPolicyForUser(Windows.System.User,Windows.Foundation.IReference{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetPurchasePromptingPolicyForUser + +## -description +Sets a value that indicates whether the Windows Store prompts the user before making a purchase. + +## -parameters +### -param user +An object that identifies the user for which to perform this operation. + +### -param value + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountid_968220529.md b/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountid_968220529.md index d419ec0b11..6fd63d08f3 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountid_968220529.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountid_968220529.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountId(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountId ## -description Sets the Store user account ID for the current user who is signed in to the Store so that other apps can query against this ID. ## -parameters ### -param webAccountId The Store user account ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to set for the user who is currently signed in to the Store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountId(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountId + +## -description +Sets the Store user account ID for the current user who is signed in to the Store so that other apps can query against this ID. + +## -parameters +### -param webAccountId +The Store user account ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to set for the user who is currently signed in to the Store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountidforuser_1852888627.md b/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountidforuser_1852888627.md index cb2cabbacb..cc0649de4b 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountidforuser_1852888627.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_setstorewebaccountidforuser_1852888627.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountIdForUser(Windows.System.User,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountIdForUser ## -description Sets the Store user account ID for the specified user so that other apps can query against this ID. ## -parameters ### -param user A [Windows.System.User](../windows.system/user.md) object that identifies the user whose Store user account ID you want to set. ### -param webAccountId The Store user account ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to set for the specified user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountIdForUser(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetStoreWebAccountIdForUser + +## -description +Sets the Store user account ID for the specified user so that other apps can query against this ID. + +## -parameters +### -param user +A [Windows.System.User](../windows.system/user.md) object that identifies the user whose Store user account ID you want to set. + +### -param webAccountId +The Store user account ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to set for the specified user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setsystemconfiguration_592309617.md b/windows.applicationmodel.store.preview/storeconfiguration_setsystemconfiguration_592309617.md index 97dec8c295..cfe9fae873 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration_setsystemconfiguration_592309617.md +++ b/windows.applicationmodel.store.preview/storeconfiguration_setsystemconfiguration_592309617.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetSystemConfiguration(System.String,System.String,Windows.Foundation.DateTime,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetSystemConfiguration ## -description Configures miscellaneous system information for the device. ## -parameters ### -param catalogHardwareManufacturerId The ID of the hardware manufacturer. ### -param catalogStoreContentModifierId The ID of the Windows Store content modifier. ### -param systemConfigurationExpiration The expiration date for the system configuration. ### -param catalogHardwareDescriptor A descriptor string that specifies the hardware components supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetSystemConfiguration(System.String,System.String,Windows.Foundation.DateTime,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetSystemConfiguration + +## -description +Configures miscellaneous system information for the device. + +## -parameters +### -param catalogHardwareManufacturerId +The ID of the hardware manufacturer. + +### -param catalogStoreContentModifierId +The ID of the Windows Store content modifier. + +### -param systemConfigurationExpiration +The expiration date for the system configuration. + +### -param catalogHardwareDescriptor +A descriptor string that specifies the hardware components supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md index d58743ebaa..73c3da3494 100644 --- a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md +++ b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo ## -description Provides information about the manufacturer for the current device. > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. ## -remarks To retrieve an instance of this class, use the [HardwareManufacturerInfo](storeconfiguration_hardwaremanufacturerinfo.md) property of the [StoreConfiguration](storeconfiguration.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo + +## -description +Provides information about the manufacturer for the current device. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks +To retrieve an instance of this class, use the [HardwareManufacturerInfo](storeconfiguration_hardwaremanufacturerinfo.md) property of the [StoreConfiguration](storeconfiguration.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_hardwaremanufacturerid.md b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_hardwaremanufacturerid.md index f1289874df..11980bc468 100644 --- a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_hardwaremanufacturerid.md +++ b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_hardwaremanufacturerid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.HardwareManufacturerId --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.HardwareManufacturerId ## -description Gets the hardware manufacture ID for the current device. ## -property-value The hardware manufacture ID for the current device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.HardwareManufacturerId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.HardwareManufacturerId + +## -description +Gets the hardware manufacture ID for the current device. + +## -property-value +The hardware manufacture ID for the current device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_manufacturername.md b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_manufacturername.md index 41418f0332..11ecc23460 100644 --- a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_manufacturername.md +++ b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_manufacturername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ManufacturerName --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ManufacturerName ## -description Gets the name of the hardware manufacturer for the current device. ## -property-value The name of the hardware manufacturer for the current device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ManufacturerName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ManufacturerName + +## -description +Gets the name of the hardware manufacturer for the current device. + +## -property-value +The name of the hardware manufacturer for the current device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_modelname.md b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_modelname.md index 6f945d5e87..bbe7f0b979 100644 --- a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_modelname.md +++ b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_modelname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ModelName --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ModelName ## -description Gets the model name for the current device. ## -property-value The model name for the current device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ModelName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.ModelName + +## -description +Gets the model name for the current device. + +## -property-value +The model name for the current device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_storecontentmodifierid.md b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_storecontentmodifierid.md index 5af1f2d2bb..ac6dda07a6 100644 --- a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_storecontentmodifierid.md +++ b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo_storecontentmodifierid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.StoreContentModifierId --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.StoreContentModifierId ## -description Gets the ID of the Windows Store content modifier. ## -property-value The ID of the Windows Store content modifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.StoreContentModifierId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreHardwareManufacturerInfo.StoreContentModifierId + +## -description +Gets the ID of the Windows Store content modifier. + +## -property-value +The ID of the Windows Store content modifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreview.md b/windows.applicationmodel.store.preview/storepreview.md index 44b7990f36..9ef6893596 100644 --- a/windows.applicationmodel.store.preview/storepreview.md +++ b/windows.applicationmodel.store.preview/storepreview.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.StorePreview --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.StorePreview ## -description Defines static methods for retrieving the in-app product SKUs available for the current app and requesting the purchase of an in-app product SKU for the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.StorePreview +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreview + +## -description +Defines static methods for retrieving the in-app product SKUs available for the current app and requesting the purchase of an in-app product SKU for the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md b/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md index a2e165b22d..deea2fdb6b 100644 --- a/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md +++ b/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StorePreview.LoadAddOnProductInfosAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StorePreview.LoadAddOnProductInfosAsync ## -description Retrieves the in-app products available for the current app asynchronously, including the available SKUs for each product. ## -returns An asynchronous operation that, on successful completion, returns the collection of in-app products for the current app (including the available SKUs for each product). If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [StorePreviewProductInfo](storepreviewproductinfo.md) items. (You can use APIs of [IVectorView<StorePreviewProductInfo>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<StorePreviewProductInfo>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StorePreview.LoadAddOnProductInfosAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreview.LoadAddOnProductInfosAsync + +## -description +Retrieves the in-app products available for the current app asynchronously, including the available SKUs for each product. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of in-app products for the current app (including the available SKUs for each product). If you use [Asynchronous programming](https://msdn.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the result type is a read-only list/vector of [StorePreviewProductInfo](storepreviewproductinfo.md) items. (You can use APIs of [IVectorView<StorePreviewProductInfo>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<StorePreviewProductInfo>](https://msdn.microsoft.com/library/hh192385.aspx) for .NET.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreview_requestproductpurchasebyproductidandskuidasync_423925263.md b/windows.applicationmodel.store.preview/storepreview_requestproductpurchasebyproductidandskuidasync_423925263.md index 405d989612..7888aa1433 100644 --- a/windows.applicationmodel.store.preview/storepreview_requestproductpurchasebyproductidandskuidasync_423925263.md +++ b/windows.applicationmodel.store.preview/storepreview_requestproductpurchasebyproductidandskuidasync_423925263.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.ApplicationModel.Store.Preview.StorePreview.RequestProductPurchaseByProductIdAndSkuIdAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.Preview.StorePreview.RequestProductPurchaseByProductIdAndSkuIdAsync ## -description Requests the purchase of a SKU for an in-app product that is associated with the current app. Calling this method displays the UI that is used to complete the transaction via the Windows Store. ## -parameters ### -param productId Specifies the ID of the in-app product. This corresponds to the [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) value and the [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) values for all SKUs of the in-app product. ### -param skuId Specifies the ID of the SKU for the in-app product. This corresponds to the [StorePreviewSkuInfo.SkuId](storepreviewskuinfo_skuid.md) value. ## -returns An asynchronous operation that, on successful completion, returns a [StorePreviewPurchaseResults](storepreviewpurchaseresults.md) that contains the results of the in-app product purchase request. ## -remarks The [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) and [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) values are not the same as the [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) value. [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) is specified by the developer as they create an in-app product on the Dev Center dashboard. The [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) and [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) values are generated by Microsoft. ## -examples ## -see-also [StorePreviewPurchaseResults](storepreviewpurchaseresults.md) ## -capabilities previewStore \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StorePreview.RequestProductPurchaseByProductIdAndSkuIdAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreview.RequestProductPurchaseByProductIdAndSkuIdAsync + +## -description +Requests the purchase of a SKU for an in-app product that is associated with the current app. Calling this method displays the UI that is used to complete the transaction via the Windows Store. + +## -parameters +### -param productId +Specifies the ID of the in-app product. This corresponds to the [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) value and the [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) values for all SKUs of the in-app product. + +### -param skuId +Specifies the ID of the SKU for the in-app product. This corresponds to the [StorePreviewSkuInfo.SkuId](storepreviewskuinfo_skuid.md) value. + +## -returns +An asynchronous operation that, on successful completion, returns a [StorePreviewPurchaseResults](storepreviewpurchaseresults.md) that contains the results of the in-app product purchase request. + +## -remarks +The [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) and [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) values are not the same as the [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) value. [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) is specified by the developer as they create an in-app product on the Dev Center dashboard. The [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) and [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) values are generated by Microsoft. + +## -examples + +## -see-also +[StorePreviewPurchaseResults](storepreviewpurchaseresults.md) + +## -capabilities +previewStore \ No newline at end of file diff --git a/windows.applicationmodel.store.preview/storepreviewproductinfo.md b/windows.applicationmodel.store.preview/storepreviewproductinfo.md index 5f3aed9176..44e4193046 100644 --- a/windows.applicationmodel.store.preview/storepreviewproductinfo.md +++ b/windows.applicationmodel.store.preview/storepreviewproductinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo ## -description Provides information about an in-app product, including details about available SKUs. ## -remarks To retrieve an instance of this class for the current app, use the [LoadAddOnProductInfosAsync](storepreview_loadaddonproductinfosasync.md) method of the [StorePreview](storepreview.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo + +## -description +Provides information about an in-app product, including details about available SKUs. + +## -remarks +To retrieve an instance of this class for the current app, use the [LoadAddOnProductInfosAsync](storepreview_loadaddonproductinfosasync.md) method of the [StorePreview](storepreview.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewproductinfo_description.md b/windows.applicationmodel.store.preview/storepreviewproductinfo_description.md index f9146dbd7a..42e12e1056 100644 --- a/windows.applicationmodel.store.preview/storepreviewproductinfo_description.md +++ b/windows.applicationmodel.store.preview/storepreviewproductinfo_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Description --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Description ## -description Gets the description of the in-app product. ## -property-value The description for the in-app product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Description + +## -description +Gets the description of the in-app product. + +## -property-value +The description for the in-app product. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewproductinfo_productid.md b/windows.applicationmodel.store.preview/storepreviewproductinfo_productid.md index bdf27c6672..185f22ac4d 100644 --- a/windows.applicationmodel.store.preview/storepreviewproductinfo_productid.md +++ b/windows.applicationmodel.store.preview/storepreviewproductinfo_productid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductId ## -description Gets the ID of the in-app product. ## -property-value The ID of the in-app product. This corresponds to the [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) value for all SKUs of the in-app product. ## -remarks This property value is not the same as the [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) value. [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) is specified by the developer as they create an in-app product on the Dev Center dashboard. The [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) value is generated by Microsoft. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductId + +## -description +Gets the ID of the in-app product. + +## -property-value +The ID of the in-app product. This corresponds to the [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) value for all SKUs of the in-app product. + +## -remarks +This property value is not the same as the [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) value. [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) is specified by the developer as they create an in-app product on the Dev Center dashboard. The [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) value is generated by Microsoft. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewproductinfo_producttype.md b/windows.applicationmodel.store.preview/storepreviewproductinfo_producttype.md index 051d4e0731..6c0d0d2f96 100644 --- a/windows.applicationmodel.store.preview/storepreviewproductinfo_producttype.md +++ b/windows.applicationmodel.store.preview/storepreviewproductinfo_producttype.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductType --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductType ## -description Gets the type of the in-app product. ## -property-value One of the following strings that specifies the type of the in-app product.
StringDescription
**Durable**A durable product.
**Consumable**A consumable product.
**Unknown**The product type is unknown.
## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductType + +## -description +Gets the type of the in-app product. + +## -property-value +One of the following strings that specifies the type of the in-app product. + + + + +
StringDescription
**Durable**A durable product.
**Consumable**A consumable product.
**Unknown**The product type is unknown.
+ +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewproductinfo_skuinfolist.md b/windows.applicationmodel.store.preview/storepreviewproductinfo_skuinfolist.md index 981066d0ac..0b18e0bfce 100644 --- a/windows.applicationmodel.store.preview/storepreviewproductinfo_skuinfolist.md +++ b/windows.applicationmodel.store.preview/storepreviewproductinfo_skuinfolist.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.SkuInfoList --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.SkuInfoList ## -description Gets information about the available SKUs for the in-app product. ## -property-value A list of [StorePreviewSkuInfo](storepreviewskuinfo.md) objects that provide information about the available SKUs for the in-app product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.SkuInfoList +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.SkuInfoList + +## -description +Gets information about the available SKUs for the in-app product. + +## -property-value +A list of [StorePreviewSkuInfo](storepreviewskuinfo.md) objects that provide information about the available SKUs for the in-app product. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewproductinfo_title.md b/windows.applicationmodel.store.preview/storepreviewproductinfo_title.md index 5796dbaa02..9cba841092 100644 --- a/windows.applicationmodel.store.preview/storepreviewproductinfo_title.md +++ b/windows.applicationmodel.store.preview/storepreviewproductinfo_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Title --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Title ## -description Gets the name of the in-app product that is displayed to customers. ## -property-value The name of the in-app product that is displayed to customers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.Title + +## -description +Gets the name of the in-app product that is displayed to customers. + +## -property-value +The name of the in-app product that is displayed to customers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewpurchaseresults.md b/windows.applicationmodel.store.preview/storepreviewpurchaseresults.md index 2cbd642939..94ffaf5f12 100644 --- a/windows.applicationmodel.store.preview/storepreviewpurchaseresults.md +++ b/windows.applicationmodel.store.preview/storepreviewpurchaseresults.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults ## -description Contains information about the results of a purchase transaction for an in-app product SKU that was purchased by using the [RequestProductPurchaseByProductIdAndSkuIdAsync](storepreview_requestproductpurchasebyproductidandskuidasync.md) method. ## -remarks The [RequestProductPurchaseByProductIdAndSkuIdAsync](storepreview_requestproductpurchasebyproductidandskuidasync.md) method returns an instance of this class to provide the results of the purchase transaction for the in-app product. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults + +## -description +Contains information about the results of a purchase transaction for an in-app product SKU that was purchased by using the [RequestProductPurchaseByProductIdAndSkuIdAsync](storepreview_requestproductpurchasebyproductidandskuidasync.md) method. + +## -remarks +The [RequestProductPurchaseByProductIdAndSkuIdAsync](storepreview_requestproductpurchasebyproductidandskuidasync.md) method returns an instance of this class to provide the results of the purchase transaction for the in-app product. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewpurchaseresults_productpurchasestatus.md b/windows.applicationmodel.store.preview/storepreviewpurchaseresults_productpurchasestatus.md index f7d28d28e9..64cbe93aa3 100644 --- a/windows.applicationmodel.store.preview/storepreviewpurchaseresults_productpurchasestatus.md +++ b/windows.applicationmodel.store.preview/storepreviewpurchaseresults_productpurchasestatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults.ProductPurchaseStatus --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults.ProductPurchaseStatus ## -description Gets the current state of the purchase transaction for an in-app product SKU that was purchased by using the [RequestProductPurchaseByProductIdAndSkuIdAsync](storepreview_requestproductpurchasebyproductidandskuidasync.md) method. ## -property-value The status of the purchase transaction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults.ProductPurchaseStatus +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewPurchaseResults.ProductPurchaseStatus + +## -description +Gets the current state of the purchase transaction for an in-app product SKU that was purchased by using the [RequestProductPurchaseByProductIdAndSkuIdAsync](storepreview_requestproductpurchasebyproductidandskuidasync.md) method. + +## -property-value +The status of the purchase transaction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo.md b/windows.applicationmodel.store.preview/storepreviewskuinfo.md index 7e2d40d74b..7fe179a97a 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo --api-type: winrt class ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo ## -description Provides information about the available SKUs for an in-app product. ## -remarks The [SkuInfoList](storepreviewproductinfo_skuinfolist.md) property of the [StorePreviewProductInfo](storepreviewproductinfo.md) class returns a list of [StorePreviewSkuInfo](storepreviewskuinfo.md) objects that provide information about the available SKUs for the in-app product. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo + +## -description +Provides information about the available SKUs for an in-app product. + +## -remarks +The [SkuInfoList](storepreviewproductinfo_skuinfolist.md) property of the [StorePreviewProductInfo](storepreviewproductinfo.md) class returns a list of [StorePreviewSkuInfo](storepreviewskuinfo.md) objects that provide information about the available SKUs for the in-app product. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_currencycode.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_currencycode.md index dad5b737d1..e10d425cfa 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_currencycode.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_currencycode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CurrencyCode --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CurrencyCode ## -description Gets the currency code for the current market. ## -property-value The currency code for the current market. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CurrencyCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CurrencyCode + +## -description +Gets the currency code for the current market. + +## -property-value +The currency code for the current market. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_customdeveloperdata.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_customdeveloperdata.md index 12c5c5b8d2..39db5f591d 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_customdeveloperdata.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_customdeveloperdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CustomDeveloperData --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CustomDeveloperData ## -description Gets custom developer data for the current SKU. ## -property-value Custom developer data for the current SKU. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CustomDeveloperData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.CustomDeveloperData + +## -description +Gets custom developer data for the current SKU. + +## -property-value +Custom developer data for the current SKU. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_description.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_description.md index b5cbb71b61..a5e290d425 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_description.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Description --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Description ## -description Gets the description for the current SKU. ## -property-value The description for the current SKU. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Description + +## -description +Gets the description for the current SKU. + +## -property-value +The description for the current SKU. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_extendeddata.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_extendeddata.md index eb43d5c59a..8393036590 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_extendeddata.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_extendeddata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ExtendedData --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ExtendedData ## -description Gets extended data for the current SKU. ## -property-value Extended data for the current SKU. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ExtendedData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ExtendedData + +## -description +Gets extended data for the current SKU. + +## -property-value +Extended data for the current SKU. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_formattedlistprice.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_formattedlistprice.md index 361ee006e8..5324e6b6a4 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_formattedlistprice.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_formattedlistprice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.FormattedListPrice --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.FormattedListPrice ## -description Gets the current SKU's purchase price with the appropriate formatting for the current market. ## -property-value The current SKU's purchase price with the appropriate formatting for the current market. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.FormattedListPrice +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.FormattedListPrice + +## -description +Gets the current SKU's purchase price with the appropriate formatting for the current market. + +## -property-value +The current SKU's purchase price with the appropriate formatting for the current market. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_productid.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_productid.md index 3d0a80ba99..3402ce3aea 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_productid.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_productid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ProductId ## -description Gets the ID of the product that this SKU is associated with. ## -property-value The ID of the product that this SKU is associated with. This corresponds to the [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) value. ## -remarks This property value is not the same as the [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) value. [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) is specified by the developer as they create an in-app product on the Dev Center dashboard. The [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) value is generated by Microsoft. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.ProductId + +## -description +Gets the ID of the product that this SKU is associated with. + +## -property-value +The ID of the product that this SKU is associated with. This corresponds to the [StorePreviewProductInfo.ProductId](storepreviewproductinfo_productid.md) value. + +## -remarks +This property value is not the same as the [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) value. [Windows.ApplicationModel.Store.ProductListing.ProductId](../windows.applicationmodel.store/productlisting_productid.md) is specified by the developer as they create an in-app product on the Dev Center dashboard. The [StorePreviewSkuInfo.ProductId](storepreviewskuinfo_productid.md) value is generated by Microsoft. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_skuid.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_skuid.md index a9bed1da80..38f4d651dd 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_skuid.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_skuid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuId --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuId ## -description Gets the ID of this SKU. ## -property-value The ID of this SKU. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuId + +## -description +Gets the ID of this SKU. + +## -property-value +The ID of this SKU. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_skutype.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_skutype.md index 0c6449667c..27143a325c 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_skutype.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_skutype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuType --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuType ## -description Gets a string that specifies the type of the in-app product SKU. ## -property-value A string that specifies the type of the in-app product SKU. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.SkuType + +## -description +Gets a string that specifies the type of the in-app product SKU. + +## -property-value +A string that specifies the type of the in-app product SKU. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store.preview/storepreviewskuinfo_title.md b/windows.applicationmodel.store.preview/storepreviewskuinfo_title.md index f582a11bd0..d825fd74d5 100644 --- a/windows.applicationmodel.store.preview/storepreviewskuinfo_title.md +++ b/windows.applicationmodel.store.preview/storepreviewskuinfo_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Title --api-type: winrt property ---- # Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Title ## -description Gets the name of the in-app product SKU that is displayed to customers. ## -property-value The name of the in-app product SKU that is displayed to customers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.StorePreviewSkuInfo.Title + +## -description +Gets the name of the in-app product SKU that is displayed to customers. + +## -property-value +The name of the in-app product SKU that is displayed to customers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_appid.md b/windows.applicationmodel.store/currentapp_appid.md index 19806e2277..91ca75666d 100644 --- a/windows.applicationmodel.store/currentapp_appid.md +++ b/windows.applicationmodel.store/currentapp_appid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Store.CurrentApp.AppId --api-type: winrt property ---- # Windows.ApplicationModel.Store.CurrentApp.AppId ## -description Gets the GUID generated by the Windows Store when your app has been certified for listing in the Windows Store. > [!NOTE] > Once your app is in the Windows Store, future app updates or changes to the app description will not result in a change to the [CurrentApp.AppId](currentapp_appid.md). ## -property-value The GUID that identifies the app in the Windows Store. ## -remarks To get a link to your app within the Windows Store, which references the same GUID, use [LinkUri](currentapp_linkuri.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.CurrentApp.AppId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.AppId + +## -description +Gets the GUID generated by the Windows Store when your app has been certified for listing in the Windows Store. + +> [!NOTE] +> Once your app is in the Windows Store, future app updates or changes to the app description will not result in a change to the [CurrentApp.AppId](currentapp_appid.md). + +## -property-value +The GUID that identifies the app in the Windows Store. + +## -remarks +To get a link to your app within the Windows Store, which references the same GUID, use [LinkUri](currentapp_linkuri.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_getapppurchasecampaignidasync_1846408128.md b/windows.applicationmodel.store/currentapp_getapppurchasecampaignidasync_1846408128.md index a0dc75c4f6..398b9de3f2 100644 --- a/windows.applicationmodel.store/currentapp_getapppurchasecampaignidasync_1846408128.md +++ b/windows.applicationmodel.store/currentapp_getapppurchasecampaignidasync_1846408128.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetAppPurchaseCampaignIdAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.GetAppPurchaseCampaignIdAsync ## -description Retrieves the promotion campaign ID for the current app. ## -returns The advertising campaign ID for your app. ## -remarks Starting in Windows 10, you can seed the installation URL for your app with an ID that represents a custom promotion campaign. This enables you to publicize the installation URL in different locations and use the campaign ID to determine which location the customer clicked on the installation URL. Use the [GetAppPurchaseCampaignIdAsync](currentapp_getapppurchasecampaignidasync.md) method to retrieve the campaign ID for the current app. For more information about custom app promotion campaigns, see [Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign). ## -examples ## -see-also [Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetAppPurchaseCampaignIdAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.GetAppPurchaseCampaignIdAsync + +## -description +Retrieves the promotion campaign ID for the current app. + +## -returns +The advertising campaign ID for your app. + +## -remarks +Starting in Windows 10, you can seed the installation URL for your app with an ID that represents a custom promotion campaign. This enables you to publicize the installation URL in different locations and use the campaign ID to determine which location the customer clicked on the installation URL. Use the [GetAppPurchaseCampaignIdAsync](currentapp_getapppurchasecampaignidasync.md) method to retrieve the campaign ID for the current app. For more information about custom app promotion campaigns, see [Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign). + +## -examples + +## -see-also +[Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign) diff --git a/windows.applicationmodel.store/currentapp_getappreceiptasync_1708241350.md b/windows.applicationmodel.store/currentapp_getappreceiptasync_1708241350.md index 221f19ad2e..e8c412d37e 100644 --- a/windows.applicationmodel.store/currentapp_getappreceiptasync_1708241350.md +++ b/windows.applicationmodel.store/currentapp_getappreceiptasync_1708241350.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetAppReceiptAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.GetAppReceiptAsync ## -description Requests all receipts for the purchase of the app and any in-app products. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -returns An XML-formatted string that contains all receipt information for the purchase of the app and any in-app products. ## -remarks For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetAppReceiptAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.GetAppReceiptAsync + +## -description +Requests all receipts for the purchase of the app and any in-app products. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -returns +An XML-formatted string that contains all receipt information for the purchase of the app and any in-app products. + +## -remarks +For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_getcustomercollectionsidasync_912228658.md b/windows.applicationmodel.store/currentapp_getcustomercollectionsidasync_912228658.md index 52ec4d8fe7..392dbb14c4 100644 --- a/windows.applicationmodel.store/currentapp_getcustomercollectionsidasync_912228658.md +++ b/windows.applicationmodel.store/currentapp_getcustomercollectionsidasync_912228658.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetCustomerCollectionsIdAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.GetCustomerCollectionsIdAsync ## -description Retrieves a Windows Store collections ID key that can be used to query for product entitlements or to consume product entitlements that are owned by the current user. ## -parameters ### -param serviceTicket An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). ### -param publisherUserId An anonymous ID that identifies the current user in the context of services that are managed by the publisher of the current app. If the publisher maintains anonymous user IDs for use in their services, they can use this parameter to correlate these user IDs with the calls they make to Windows Store services. This parameter is optional. ## -returns The collections ID key for the current user. This key is valid for 90 days. ## -remarks Publishers with catalogs of in-app purchases can use the collections ID key in service-to-service calls to the Windows Store collections API to query for product entitlements or to consume product entitlements that are owned by the current user. An *entitlement* represents the customer's right to use an app or in-app product (IAP) that is published through the Windows Store. For more information, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). ## -examples ## -see-also [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetCustomerCollectionsIdAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.GetCustomerCollectionsIdAsync + +## -description +Retrieves a Windows Store collections ID key that can be used to query for product entitlements or to consume product entitlements that are owned by the current user. + +## -parameters +### -param serviceTicket +An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). + +### -param publisherUserId +An anonymous ID that identifies the current user in the context of services that are managed by the publisher of the current app. If the publisher maintains anonymous user IDs for use in their services, they can use this parameter to correlate these user IDs with the calls they make to Windows Store services. This parameter is optional. + +## -returns +The collections ID key for the current user. This key is valid for 90 days. + +## -remarks +Publishers with catalogs of in-app purchases can use the collections ID key in service-to-service calls to the Windows Store collections API to query for product entitlements or to consume product entitlements that are owned by the current user. An *entitlement* represents the customer's right to use an app or in-app product (IAP) that is published through the Windows Store. For more information, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). + +## -examples + +## -see-also +[Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service) diff --git a/windows.applicationmodel.store/currentapp_getcustomerpurchaseidasync_530605295.md b/windows.applicationmodel.store/currentapp_getcustomerpurchaseidasync_530605295.md index c0ea12be8b..380a1331dc 100644 --- a/windows.applicationmodel.store/currentapp_getcustomerpurchaseidasync_530605295.md +++ b/windows.applicationmodel.store/currentapp_getcustomerpurchaseidasync_530605295.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetCustomerPurchaseIdAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.GetCustomerPurchaseIdAsync ## -description Retrieves a Windows Store purchase ID key that can be used to grant entitlements for free products on behalf of the current user. ## -parameters ### -param serviceTicket An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). ### -param publisherUserId An anonymous ID that identifies the current user in the context of services that are managed by the publisher of the current app. If the publisher maintains anonymous user IDs for use in their services, they can use this parameter to correlate these user IDs with the calls they make to Windows Store services. This parameter is optional. ## -returns The purchase ID key for the current user. This key is valid for 90 days. ## -remarks Publishers with catalogs of in-app purchases can use the collections ID key in service-to-service calls to the Windows Store purchase API to grant entitlements for free products on behalf of the current user. An *entitlement* represents the customer's right to use an app or in-app product (IAP) that is published through the Windows Store. For more information, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). ## -examples ## -see-also [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetCustomerPurchaseIdAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.GetCustomerPurchaseIdAsync + +## -description +Retrieves a Windows Store purchase ID key that can be used to grant entitlements for free products on behalf of the current user. + +## -parameters +### -param serviceTicket +An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). + +### -param publisherUserId +An anonymous ID that identifies the current user in the context of services that are managed by the publisher of the current app. If the publisher maintains anonymous user IDs for use in their services, they can use this parameter to correlate these user IDs with the calls they make to Windows Store services. This parameter is optional. + +## -returns +The purchase ID key for the current user. This key is valid for 90 days. + +## -remarks +Publishers with catalogs of in-app purchases can use the collections ID key in service-to-service calls to the Windows Store purchase API to grant entitlements for free products on behalf of the current user. An *entitlement* represents the customer's right to use an app or in-app product (IAP) that is published through the Windows Store. For more information, see [Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service). + +## -examples + +## -see-also +[Manage product entitlements from a service](https://msdn.microsoft.com/windows/uwp/monetize/view-and-grant-products-from-a-service) diff --git a/windows.applicationmodel.store/currentapp_getproductreceiptasync_1023308114.md b/windows.applicationmodel.store/currentapp_getproductreceiptasync_1023308114.md index 824f198108..2a9c7f45cc 100644 --- a/windows.applicationmodel.store/currentapp_getproductreceiptasync_1023308114.md +++ b/windows.applicationmodel.store/currentapp_getproductreceiptasync_1023308114.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetProductReceiptAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.GetProductReceiptAsync ## -description Requests the receipt for the specified product ID. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -parameters ### -param productId The unique identifier for the product that you specified this identifier when you submitted the app to the Windows Store ## -returns An XML-formatted string that contains the receipt for the specified *productId.* ## -remarks For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetProductReceiptAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.GetProductReceiptAsync + +## -description +Requests the receipt for the specified product ID. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -parameters +### -param productId +The unique identifier for the product that you specified this identifier when you submitted the app to the Windows Store + +## -returns +An XML-formatted string that contains the receipt for the specified *productId.* + +## -remarks +For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_getunfulfilledconsumablesasync_87854091.md b/windows.applicationmodel.store/currentapp_getunfulfilledconsumablesasync_87854091.md index 782183e54e..f16c0f3a1e 100644 --- a/windows.applicationmodel.store/currentapp_getunfulfilledconsumablesasync_87854091.md +++ b/windows.applicationmodel.store/currentapp_getunfulfilledconsumablesasync_87854091.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetUnfulfilledConsumablesAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.GetUnfulfilledConsumablesAsync ## -description Returns a list of purchased consumable in-app products that have not been reported to the Windows Store as fulfilled. ## -returns When the operation completes, a list of consumable in-app products not yet reported as fulfilled is returned ([UnfulfilledConsumable](unfulfilledconsumable.md) objects). Each item of this list provides the product ID, offer ID, and transaction ID associated with a product. ## -remarks ## -examples ## -see-also [UnfulfilledConsumable](unfulfilledconsumable.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.GetUnfulfilledConsumablesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.GetUnfulfilledConsumablesAsync + +## -description +Returns a list of purchased consumable in-app products that have not been reported to the Windows Store as fulfilled. + +## -returns +When the operation completes, a list of consumable in-app products not yet reported as fulfilled is returned ([UnfulfilledConsumable](unfulfilledconsumable.md) objects). Each item of this list provides the product ID, offer ID, and transaction ID associated with a product. + +## -remarks + +## -examples + +## -see-also +[UnfulfilledConsumable](unfulfilledconsumable.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentapp_licenseinformation.md b/windows.applicationmodel.store/currentapp_licenseinformation.md index 87989d31d9..ebb573ad5c 100644 --- a/windows.applicationmodel.store/currentapp_licenseinformation.md +++ b/windows.applicationmodel.store/currentapp_licenseinformation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.CurrentApp.LicenseInformation --api-type: winrt property ---- # Windows.ApplicationModel.Store.CurrentApp.LicenseInformation ## -description Gets the license metadata for the current app. ## -property-value The license metadata for the current app. ## -remarks This API does not require a network connection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.CurrentApp.LicenseInformation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.LicenseInformation + +## -description +Gets the license metadata for the current app. + +## -property-value +The license metadata for the current app. + +## -remarks +This API does not require a network connection. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_linkuri.md b/windows.applicationmodel.store/currentapp_linkuri.md index 69a982f03c..50ae70ffb1 100644 --- a/windows.applicationmodel.store/currentapp_linkuri.md +++ b/windows.applicationmodel.store/currentapp_linkuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.CurrentApp.LinkUri --api-type: winrt property ---- # Windows.ApplicationModel.Store.CurrentApp.LinkUri ## -description Gets the Uniform Resource Identifier (URI) of the app's listing page in the web catalog of the Windows Store. ## -property-value The Uniform Resource Identifier (URI) of the app's listing page in the Windows Store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.CurrentApp.LinkUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.LinkUri + +## -description + Gets the Uniform Resource Identifier (URI) of the app's listing page in the web catalog of the Windows Store. + +## -property-value +The Uniform Resource Identifier (URI) of the app's listing page in the Windows Store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_loadlistinginformationasync_1372253086.md b/windows.applicationmodel.store/currentapp_loadlistinginformationasync_1372253086.md index 1bc96e83df..a516461be0 100644 --- a/windows.applicationmodel.store/currentapp_loadlistinginformationasync_1372253086.md +++ b/windows.applicationmodel.store/currentapp_loadlistinginformationasync_1372253086.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationAsync ## -description Loads the app's listing information asynchronously. The returned [ListingInformation](currentapp_loadlistinginformationasync.md) object contains listing information (e.g. name, price, age rating) specific to the market the user currently resides in. Additionally, the listing information for available in-app products is also provided. ## -returns The apps' listing information. If the method fails, it returns an **HRESULT** error code. ## -remarks Calling this method requires an internet connection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationAsync + +## -description +Loads the app's listing information asynchronously. + +The returned [ListingInformation](currentapp_loadlistinginformationasync.md) object contains listing information (e.g. name, price, age rating) specific to the market the user currently resides in. Additionally, the listing information for available in-app products is also provided. + +## -returns +The apps' listing information. If the method fails, it returns an **HRESULT** error code. + +## -remarks +Calling this method requires an internet connection. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_loadlistinginformationbykeywordsasync_2044666377.md b/windows.applicationmodel.store/currentapp_loadlistinginformationbykeywordsasync_2044666377.md index c25d525345..c0cf372f29 100644 --- a/windows.applicationmodel.store/currentapp_loadlistinginformationbykeywordsasync_2044666377.md +++ b/windows.applicationmodel.store/currentapp_loadlistinginformationbykeywordsasync_2044666377.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByKeywordsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByKeywordsAsync ## -description Loads the app listing information asynchronously, returning features and products in the [ProductListings](listinginformation_productlistings.md) collection that match all supplied keywords. ## -parameters ### -param keywords The list of keywords by which to filter the [ProductListings](listinginformation_productlistings.md) collection that is returned in the [ListingInformation](listinginformation.md) object. ## -returns The app's listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by keywords. If the method fails, it returns an **HRESULT** error code. If no products or features are found that match all of the given keywords, the ProductListings collection will be empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByKeywordsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByKeywordsAsync + +## -description +Loads the app listing information asynchronously, returning features and products in the [ProductListings](listinginformation_productlistings.md) collection that match all supplied keywords. + +## -parameters +### -param keywords +The list of keywords by which to filter the [ProductListings](listinginformation_productlistings.md) collection that is returned in the [ListingInformation](listinginformation.md) object. + +## -returns +The app's listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by keywords. If the method fails, it returns an **HRESULT** error code. If no products or features are found that match all of the given keywords, the ProductListings collection will be empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_loadlistinginformationbyproductidsasync_1735757731.md b/windows.applicationmodel.store/currentapp_loadlistinginformationbyproductidsasync_1735757731.md index a0b0a0ca80..d82407abd0 100644 --- a/windows.applicationmodel.store/currentapp_loadlistinginformationbyproductidsasync_1735757731.md +++ b/windows.applicationmodel.store/currentapp_loadlistinginformationbyproductidsasync_1735757731.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByProductIdsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByProductIdsAsync ## -description Loads the app listing information asynchronously, returning features and products in the [ProductListings](listinginformation_productlistings.md) collection that match any of the given products IDs. ## -parameters ### -param productIds The list of product IDs by which to filter the [ProductListings](listinginformation_productlistings.md) collection. ## -returns The app's listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by product IDs. If the method fails, it returns an **HRESULT** error code. If no products or features are found that match the given product IDs, the ProductListings collection will be empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByProductIdsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.LoadListingInformationByProductIdsAsync + +## -description +Loads the app listing information asynchronously, returning features and products in the [ProductListings](listinginformation_productlistings.md) collection that match any of the given products IDs. + +## -parameters +### -param productIds +The list of product IDs by which to filter the [ProductListings](listinginformation_productlistings.md) collection. + +## -returns +The app's listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by product IDs. If the method fails, it returns an **HRESULT** error code. If no products or features are found that match the given product IDs, the ProductListings collection will be empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_reportconsumablefulfillmentasync_2121095554.md b/windows.applicationmodel.store/currentapp_reportconsumablefulfillmentasync_2121095554.md index 15209d5303..ef2ffb0f84 100644 --- a/windows.applicationmodel.store/currentapp_reportconsumablefulfillmentasync_2121095554.md +++ b/windows.applicationmodel.store/currentapp_reportconsumablefulfillmentasync_2121095554.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.ReportConsumableFulfillmentAsync(System.String,System.Guid) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.ReportConsumableFulfillmentAsync ## -description Notifies the Windows Store that the purchase of a consumable is fulfilled and that the user has the right to access the content. ## -parameters ### -param productId Identifies the consumable. ### -param transactionId Identifies a transaction that includes the purchase of the consumable (*productId*). ## -returns A value that indicates the status of fulfillment for a consumable in-app product. Possible values are defined by the [FulfillmentResult](fulfillmentresult.md) enumeration. ## -remarks A unique ID is required for each instance of a consumable product that has been purchased more than once. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.ReportConsumableFulfillmentAsync(System.String,System.Guid) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.ReportConsumableFulfillmentAsync + +## -description +Notifies the Windows Store that the purchase of a consumable is fulfilled and that the user has the right to access the content. + +## -parameters +### -param productId +Identifies the consumable. + +### -param transactionId +Identifies a transaction that includes the purchase of the consumable (*productId*). + +## -returns +A value that indicates the status of fulfillment for a consumable in-app product. Possible values are defined by the [FulfillmentResult](fulfillmentresult.md) enumeration. + +## -remarks +A unique ID is required for each instance of a consumable product that has been purchased more than once. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_reportproductfulfillment_69464170.md b/windows.applicationmodel.store/currentapp_reportproductfulfillment_69464170.md index 4f36f075d3..ec6a7b560a 100644 --- a/windows.applicationmodel.store/currentapp_reportproductfulfillment_69464170.md +++ b/windows.applicationmodel.store/currentapp_reportproductfulfillment_69464170.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.ReportProductFulfillment(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.ReportProductFulfillment ## -description Notifies the Windows Store that the application has fulfilled the in-app product. This product cannot be re-purchased until the app has confirmed fulfillment using this method. ## -parameters ### -param productId The ID of the product that has been delivered to the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.ReportProductFulfillment(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.ReportProductFulfillment + +## -description +Notifies the Windows Store that the application has fulfilled the in-app product. This product cannot be re-purchased until the app has confirmed fulfillment using this method. + +## -parameters +### -param productId +The ID of the product that has been delivered to the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_requestapppurchaseasync_2023276791.md b/windows.applicationmodel.store/currentapp_requestapppurchaseasync_2023276791.md index 24ccaf50ea..c48f20ff65 100644 --- a/windows.applicationmodel.store/currentapp_requestapppurchaseasync_2023276791.md +++ b/windows.applicationmodel.store/currentapp_requestapppurchaseasync_2023276791.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestAppPurchaseAsync(System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.RequestAppPurchaseAsync ## -description Requests the purchase of a full app license. ## -parameters ### -param includeReceipt Determines if this method should return the receipts for this app. ## -returns If the *includeReceipt* parameter is set to true, this string contains XML that represents all receipts for the app and any in-app purchases. If *includeReceipt* is set to false, this string is empty. ## -remarks This method returns a success value even if: + No network connection is available. + The user cancels out of the dialog. + The user's authentication fails. You should treat a success result as indicating the async process completed without errors. To ensure that the transaction itself was successful, check the **LicenseInformation** element in the returned receipt. For information about the contents of the receipt returned by this method, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestAppPurchaseAsync(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.RequestAppPurchaseAsync + +## -description +Requests the purchase of a full app license. + +## -parameters +### -param includeReceipt +Determines if this method should return the receipts for this app. + +## -returns +If the *includeReceipt* parameter is set to true, this string contains XML that represents all receipts for the app and any in-app purchases. If *includeReceipt* is set to false, this string is empty. + +## -remarks +This method returns a success value even if: + ++ No network connection is available. ++ The user cancels out of the dialog. ++ The user's authentication fails. + +You should treat a success result as indicating the async process completed without errors. To ensure that the transaction itself was successful, check the **LicenseInformation** element in the returned receipt. + +For information about the contents of the receipt returned by this method, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1631257175.md b/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1631257175.md index 5f4dec63a1..766c603798 100644 --- a/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1631257175.md +++ b/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1631257175.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync(System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync ## -description > [!NOTE] > [RequestProductPurchaseAsync(String, Boolean)](currentapp_requestproductpurchaseasync_1631257175.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md). Requests the purchase of an in-app product. Additionally, calling this method displays the UI that is used to complete the transaction via the Windows Store. ## -parameters ### -param productId Specifies the id of the in-app product. ### -param includeReceipt Determines if the method should return the receipts for the specified *productId.* ## -returns A string providing in-app transaction details for the provided *productId*. If *includeReceipt* is set **true**, the returned string will include a full receipt xml. ## -remarks ## -examples ## -see-also [RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync + +## -description +> [!NOTE] +> [RequestProductPurchaseAsync(String, Boolean)](currentapp_requestproductpurchaseasync_1631257175.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md). + +Requests the purchase of an in-app product. Additionally, calling this method displays the UI that is used to complete the transaction via the Windows Store. + +## -parameters +### -param productId +Specifies the id of the in-app product. + +### -param includeReceipt +Determines if the method should return the receipts for the specified *productId.* + +## -returns +A string providing in-app transaction details for the provided *productId*. If *includeReceipt* is set **true**, the returned string will include a full receipt xml. + +## -remarks + +## -examples + +## -see-also +[RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1934617021.md b/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1934617021.md index c58b9a0aab..74f32c75d0 100644 --- a/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1934617021.md +++ b/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_1934617021.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync(System.String,System.String,Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync ## -description Requests the purchase of an in-app product. Additionally, calling this method displays the UI that is used to complete the transaction via the Windows Store.The resulting [RequestProductPurchaseAsync](currentapp_requestproductpurchaseasync.md) object includes the parameters required to display details for a specific offer within a large catalog of in-app purchases that is represented by a single product entry in the Store. ## -parameters ### -param productId Specifies the id of the in-app product. ### -param offerId The specific in-app feature or content within the large purchase catalog represented on the Windows Store by the *productId.* This value correlates with the content your app is responsible for fulfilling. The Windows Store only uses this value to itemize the [PurchaseResults](purchaseresults.md). ### -param displayProperties The name of the app feature or content offer that is displayed to the user at time of purchase. ## -returns The results of the in-app product purchase request. ## -remarks The remarks for [RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md) also apply to this method. ## -examples ## -see-also [RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md), [RequestProductPurchaseAsync(String, Boolean)](currentapp_requestproductpurchaseasync_1631257175.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync(System.String,System.String,Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync + +## -description +Requests the purchase of an in-app product. Additionally, calling this method displays the UI that is used to complete the transaction via the Windows Store.The resulting [RequestProductPurchaseAsync](currentapp_requestproductpurchaseasync.md) object includes the parameters required to display details for a specific offer within a large catalog of in-app purchases that is represented by a single product entry in the Store. + + + +## -parameters +### -param productId +Specifies the id of the in-app product. + +### -param offerId +The specific in-app feature or content within the large purchase catalog represented on the Windows Store by the *productId.* This value correlates with the content your app is responsible for fulfilling. The Windows Store only uses this value to itemize the [PurchaseResults](purchaseresults.md). + +### -param displayProperties +The name of the app feature or content offer that is displayed to the user at time of purchase. + +## -returns +The results of the in-app product purchase request. + +## -remarks +The remarks for [RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md) also apply to this method. + +## -examples + +## -see-also +[RequestProductPurchaseAsync(String)](currentapp_requestproductpurchaseasync_2091240017.md), [RequestProductPurchaseAsync(String, Boolean)](currentapp_requestproductpurchaseasync_1631257175.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_2091240017.md b/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_2091240017.md index 0244407f64..54ba0cfc4d 100644 --- a/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_2091240017.md +++ b/windows.applicationmodel.store/currentapp_requestproductpurchaseasync_2091240017.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync ## -description Requests the purchase of an in-app product. Additionally, calling this method displays the UI that is used to complete the transaction via the Windows Store. ## -parameters ### -param productId Specifies the id of the in-app product. ## -returns The results of the in-app product purchase request. ## -remarks Use the [LicenseInformation.IsActive](licenseinformation_isactive.md) property to confirm that a product license is active after a successful [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) call. > [!NOTE] > This method of confirming a successful purchase is only applicable to the [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) overloads that don't return a [PurchaseResults](purchaseresults.md) object. You can see an example of how to use this method in our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231569). ## -examples ## -see-also [RequestProductPurchaseAsync(String, Boolean)](currentapp_requestproductpurchaseasync_1631257175.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentApp.RequestProductPurchaseAsync + +## -description +Requests the purchase of an in-app product. Additionally, calling this method displays the UI that is used to complete the transaction via the Windows Store. + +## -parameters +### -param productId +Specifies the id of the in-app product. + +## -returns +The results of the in-app product purchase request. + +## -remarks +Use the [LicenseInformation.IsActive](licenseinformation_isactive.md) property to confirm that a product license is active after a successful [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) call. + +> [!NOTE] +> This method of confirming a successful purchase is only applicable to the [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) overloads that don't return a [PurchaseResults](purchaseresults.md) object. + +You can see an example of how to use this method in our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231569). + + + +## -examples + +## -see-also +[RequestProductPurchaseAsync(String, Boolean)](currentapp_requestproductpurchaseasync_1631257175.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentappsimulator_appid.md b/windows.applicationmodel.store/currentappsimulator_appid.md index c3bbf83b27..e8f8c0a878 100644 --- a/windows.applicationmodel.store/currentappsimulator_appid.md +++ b/windows.applicationmodel.store/currentappsimulator_appid.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.Store.CurrentAppSimulator.AppId --api-type: winrt property ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.AppId ## -description Gets a simulated app ID. Since [CurrentAppSimulator](currentappsimulator.md) is intended only for testing during app development, the returned [CurrentAppSimulator.AppId](currentappsimulator_appid.md) will contain only 0's. Once your app is listed on the Windows Store, [CurrentApp.AppId](currentapp_appid.md) will get the GUID generated during app on-boarding and used to list your app within the Windows Store catalog. > [!NOTE] > App updates or changes to the app description will not result in a change to the [CurrentApp.AppId](currentapp_appid.md). ## -property-value The GUID that identifies the app in the Windows Store. ## -remarks Uses the **AppId** element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.CurrentAppSimulator.AppId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.AppId + +## -description +Gets a simulated app ID. Since [CurrentAppSimulator](currentappsimulator.md) is intended only for testing during app development, the returned [CurrentAppSimulator.AppId](currentappsimulator_appid.md) will contain only 0's. + +Once your app is listed on the Windows Store, [CurrentApp.AppId](currentapp_appid.md) will get the GUID generated during app on-boarding and used to list your app within the Windows Store catalog. + +> [!NOTE] +> App updates or changes to the app description will not result in a change to the [CurrentApp.AppId](currentapp_appid.md). + +## -property-value +The GUID that identifies the app in the Windows Store. + +## -remarks +Uses the **AppId** element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_getapppurchasecampaignidasync_1846408128.md b/windows.applicationmodel.store/currentappsimulator_getapppurchasecampaignidasync_1846408128.md index 55ac7be288..a24918d8a6 100644 --- a/windows.applicationmodel.store/currentappsimulator_getapppurchasecampaignidasync_1846408128.md +++ b/windows.applicationmodel.store/currentappsimulator_getapppurchasecampaignidasync_1846408128.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppPurchaseCampaignIdAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppPurchaseCampaignIdAsync ## -description Retrieves the promotion campaign ID for the current app. ## -returns The advertising campaign ID for your app. ## -remarks Starting in Windows 10, you can seed the installation URL for your app with an ID that represents a custom promotion campaign. This enables you to publicize the installation URL in different locations and use the campaign ID to determine which location the customer clicked on the installation URL. Use the [GetAppPurchaseCampaignIdAsync](currentappsimulator_getapppurchasecampaignidasync.md) method to retrieve the campaign ID for the current app. For more information about custom app promotion campaigns, see [Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign). ## -examples ## -see-also [Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppPurchaseCampaignIdAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppPurchaseCampaignIdAsync + +## -description +Retrieves the promotion campaign ID for the current app. + +## -returns +The advertising campaign ID for your app. + +## -remarks +Starting in Windows 10, you can seed the installation URL for your app with an ID that represents a custom promotion campaign. This enables you to publicize the installation URL in different locations and use the campaign ID to determine which location the customer clicked on the installation URL. Use the [GetAppPurchaseCampaignIdAsync](currentappsimulator_getapppurchasecampaignidasync.md) method to retrieve the campaign ID for the current app. For more information about custom app promotion campaigns, see [Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign). + +## -examples + +## -see-also +[Create a custom app promotion campaign](https://msdn.microsoft.com/windows/uwp/publish/create-a-custom-app-promotion-campaign) diff --git a/windows.applicationmodel.store/currentappsimulator_getappreceiptasync_1708241350.md b/windows.applicationmodel.store/currentappsimulator_getappreceiptasync_1708241350.md index 42b854e4b0..b387e488d7 100644 --- a/windows.applicationmodel.store/currentappsimulator_getappreceiptasync_1708241350.md +++ b/windows.applicationmodel.store/currentappsimulator_getappreceiptasync_1708241350.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppReceiptAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppReceiptAsync ## -description Creates the async operation that the user can use to simulate requesting all receipts for this app and any in-app product purchases. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -returns An XML-formatted string that contains all receipts for this app and any in-app product purchases. ## -remarks For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppReceiptAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.GetAppReceiptAsync + +## -description +Creates the async operation that the user can use to simulate requesting all receipts for this app and any in-app product purchases. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -returns +An XML-formatted string that contains all receipts for this app and any in-app product purchases. + +## -remarks +For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_getproductreceiptasync_1023308114.md b/windows.applicationmodel.store/currentappsimulator_getproductreceiptasync_1023308114.md index 5893aa7833..5bb5d29340 100644 --- a/windows.applicationmodel.store/currentappsimulator_getproductreceiptasync_1023308114.md +++ b/windows.applicationmodel.store/currentappsimulator_getproductreceiptasync_1023308114.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetProductReceiptAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.GetProductReceiptAsync ## -description Creates the async operation that the user can use to simulate requesting the receipt for the specified product ID. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -parameters ### -param productId The unique identifier for the product. This ID is that was specified when the product was submitted for the app to the Store. ## -returns An XML-formatted string that contains the receipt for the specified product ID. ## -remarks For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetProductReceiptAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.GetProductReceiptAsync + +## -description +Creates the async operation that the user can use to simulate requesting the receipt for the specified product ID. For examples of how receipt information can be used, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -parameters +### -param productId +The unique identifier for the product. This ID is that was specified when the product was submitted for the app to the Store. + +## -returns +An XML-formatted string that contains the receipt for the specified product ID. + +## -remarks +For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_getunfulfilledconsumablesasync_87854091.md b/windows.applicationmodel.store/currentappsimulator_getunfulfilledconsumablesasync_87854091.md index 356124b462..86b223d54f 100644 --- a/windows.applicationmodel.store/currentappsimulator_getunfulfilledconsumablesasync_87854091.md +++ b/windows.applicationmodel.store/currentappsimulator_getunfulfilledconsumablesasync_87854091.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetUnfulfilledConsumablesAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.GetUnfulfilledConsumablesAsync ## -description Returns a list of purchased consumable in-app products that have not been fulfilled locally. ## -returns When the operation completes, a list of unfulfilled consumable in-app products ([UnfulfilledConsumable](unfulfilledconsumable.md) objects) is returned. Each item in this list provides the product ID, offer ID, and transaction ID associated with a product. ## -remarks ## -examples ## -see-also [UnfulfilledConsumable](unfulfilledconsumable.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.GetUnfulfilledConsumablesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.GetUnfulfilledConsumablesAsync + +## -description +Returns a list of purchased consumable in-app products that have not been fulfilled locally. + +## -returns +When the operation completes, a list of unfulfilled consumable in-app products ([UnfulfilledConsumable](unfulfilledconsumable.md) objects) is returned. Each item in this list provides the product ID, offer ID, and transaction ID associated with a product. + +## -remarks + +## -examples + +## -see-also +[UnfulfilledConsumable](unfulfilledconsumable.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentappsimulator_licenseinformation.md b/windows.applicationmodel.store/currentappsimulator_licenseinformation.md index 9042dd4555..4e3a08e82c 100644 --- a/windows.applicationmodel.store/currentappsimulator_licenseinformation.md +++ b/windows.applicationmodel.store/currentappsimulator_licenseinformation.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Store.CurrentAppSimulator.LicenseInformation --api-type: winrt property ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.LicenseInformation ## -description Gets the simulated license metadata for the current app as provided by the simulation. ## -property-value The license metadata for the current app as provided by the simulation. ## -remarks Uses the **LicenseInformation** element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). This API does not require a network connection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.CurrentAppSimulator.LicenseInformation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.LicenseInformation + +## -description +Gets the simulated license metadata for the current app as provided by the simulation. + +## -property-value +The license metadata for the current app as provided by the simulation. + +## -remarks +Uses the **LicenseInformation** element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +This API does not require a network connection. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_linkuri.md b/windows.applicationmodel.store/currentappsimulator_linkuri.md index c9f8745bb3..bf806688be 100644 --- a/windows.applicationmodel.store/currentappsimulator_linkuri.md +++ b/windows.applicationmodel.store/currentappsimulator_linkuri.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.CurrentAppSimulator.LinkUri --api-type: winrt property ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.LinkUri ## -description Gets the simulated Uniform Resource Identifier (URI) that represents a Windows Store listing page for the current app. ## -property-value The Uniform Resource Identifier (URI) of the Windows Store listing page for the current app as defined by the simulation. ## -remarks Gets the value of the **LinkUri** element in the WindowsStoreProxy.xml file. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.CurrentAppSimulator.LinkUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.LinkUri + +## -description +Gets the simulated Uniform Resource Identifier (URI) that represents a Windows Store listing page for the current app. + +## -property-value +The Uniform Resource Identifier (URI) of the Windows Store listing page for the current app as defined by the simulation. + +## -remarks +Gets the value of the **LinkUri** element in the WindowsStoreProxy.xml file. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_loadlistinginformationasync_1372253086.md b/windows.applicationmodel.store/currentappsimulator_loadlistinginformationasync_1372253086.md index 29cb59e3e7..42f5a51f00 100644 --- a/windows.applicationmodel.store/currentappsimulator_loadlistinginformationasync_1372253086.md +++ b/windows.applicationmodel.store/currentappsimulator_loadlistinginformationasync_1372253086.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationAsync --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationAsync ## -description Loads the simulated app listing information asynchronously. The returned [ListingInformation](currentappsimulator_loadlistinginformationasync.md) object contains listing information (e.g. name, price, age rating) specific to the market the user currently resides in. Additionally, listing information for products available via in-app products is also provided. > [!NOTE] > For simulation purposes, this method uses the element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more info, see the code examples in [CurrentAppSimulator](currentappsimulator.md). ## -returns The app listing information as defined by the simulation. If the method fails, it returns an **HRESULT** error code. ## -remarks Calling this method requires an internet connection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationAsync + +## -description +Loads the simulated app listing information asynchronously. + +The returned [ListingInformation](currentappsimulator_loadlistinginformationasync.md) object contains listing information (e.g. name, price, age rating) specific to the market the user currently resides in. Additionally, listing information for products available via in-app products is also provided. + +> [!NOTE] +> For simulation purposes, this method uses the element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more info, see the code examples in [CurrentAppSimulator](currentappsimulator.md). + +## -returns +The app listing information as defined by the simulation. If the method fails, it returns an **HRESULT** error code. + +## -remarks +Calling this method requires an internet connection. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbykeywordsasync_2044666377.md b/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbykeywordsasync_2044666377.md index f6b0247c64..c9a6fc8003 100644 --- a/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbykeywordsasync_2044666377.md +++ b/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbykeywordsasync_2044666377.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByKeywordsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByKeywordsAsync ## -description Loads the simulated app listing information asynchronously, returning in-app products in the [ProductListings](listinginformation_productlistings.md) collection that match all supplied keywords. ## -parameters ### -param keywords The list of keywords by which to filter the [ProductListings](listinginformation_productlistings.md) collection that is returned in the [ListingInformation](listinginformation.md) object. ## -returns The simulated app listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by keywords. If the method fails, it returns an **HRESULT** error code. If no in-app products are found that match all of the given keywords, the ProductListings collection will be empty. ## -remarks Uses the **ListingInformation** element in the WindowsStoreProxy.xml file as the data source for the members of the returned objects. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). Calling this method requires an internet connection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByKeywordsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByKeywordsAsync + +## -description +Loads the simulated app listing information asynchronously, returning in-app products in the [ProductListings](listinginformation_productlistings.md) collection that match all supplied keywords. + +## -parameters +### -param keywords +The list of keywords by which to filter the [ProductListings](listinginformation_productlistings.md) collection that is returned in the [ListingInformation](listinginformation.md) object. + +## -returns +The simulated app listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by keywords. If the method fails, it returns an **HRESULT** error code. If no in-app products are found that match all of the given keywords, the ProductListings collection will be empty. + +## -remarks +Uses the **ListingInformation** element in the WindowsStoreProxy.xml file as the data source for the members of the returned objects. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +Calling this method requires an internet connection. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbyproductidsasync_1735757731.md b/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbyproductidsasync_1735757731.md index e527c37d34..fe65a6fcf5 100644 --- a/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbyproductidsasync_1735757731.md +++ b/windows.applicationmodel.store/currentappsimulator_loadlistinginformationbyproductidsasync_1735757731.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByProductIdsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByProductIdsAsync ## -description Loads the simulated app listing information asynchronously, returning available in-app products in the [ProductListings](listinginformation_productlistings.md) collection that match any of the given products IDs. ## -parameters ### -param productIds The list of product IDs by which to filter the [ProductListings](listinginformation_productlistings.md) collection. ## -returns The simulated app listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by product IDs. If the method fails, it returns an **HRESULT** error code. If no in-app products are found that match the given product IDs, the ProductListings collection will be empty. ## -remarks Uses the **ListingInformation** element in the WindowsStoreProxy.xml file as the data source for the members of the returned objects. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). Calling this method requires an internet connection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByProductIdsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.LoadListingInformationByProductIdsAsync + +## -description +Loads the simulated app listing information asynchronously, returning available in-app products in the [ProductListings](listinginformation_productlistings.md) collection that match any of the given products IDs. + +## -parameters +### -param productIds +The list of product IDs by which to filter the [ProductListings](listinginformation_productlistings.md) collection. + +## -returns +The simulated app listing information, with [ProductListings](listinginformation_productlistings.md) collection filtered by product IDs. If the method fails, it returns an **HRESULT** error code. If no in-app products are found that match the given product IDs, the ProductListings collection will be empty. + +## -remarks +Uses the **ListingInformation** element in the WindowsStoreProxy.xml file as the data source for the members of the returned objects. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +Calling this method requires an internet connection. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_reloadsimulatorasync_1595510388.md b/windows.applicationmodel.store/currentappsimulator_reloadsimulatorasync_1595510388.md index 4fe6ba7dda..b8f1c83353 100644 --- a/windows.applicationmodel.store/currentappsimulator_reloadsimulatorasync_1595510388.md +++ b/windows.applicationmodel.store/currentappsimulator_reloadsimulatorasync_1595510388.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.ReloadSimulatorAsync(Windows.Storage.StorageFile) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.ReloadSimulatorAsync ## -description Reloads the simulator using a [StorageFile](../windows.storage/storagefile.md) containing the **WindowsStoreProxy.xml** file. If you do not call this method to load your own file, the simulator will create/load (but not overwrite) a **WindowsStoreProxy.xml** file containing a set of default values. ## -parameters ### -param simulatorSettingsFile The WindowsStoreProxy.xml file that the simulator uses. ## -returns The async operation that reloads the simulator. ## -remarks For more information about using this method, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.ReloadSimulatorAsync(Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.ReloadSimulatorAsync + +## -description +Reloads the simulator using a [StorageFile](../windows.storage/storagefile.md) containing the **WindowsStoreProxy.xml** file. + +If you do not call this method to load your own file, the simulator will create/load (but not overwrite) a **WindowsStoreProxy.xml** file containing a set of default values. + +## -parameters +### -param simulatorSettingsFile +The WindowsStoreProxy.xml file that the simulator uses. + +## -returns +The async operation that reloads the simulator. + +## -remarks +For more information about using this method, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_reportconsumablefulfillmentasync_2121095554.md b/windows.applicationmodel.store/currentappsimulator_reportconsumablefulfillmentasync_2121095554.md index 73e97b3b0f..27730e596e 100644 --- a/windows.applicationmodel.store/currentappsimulator_reportconsumablefulfillmentasync_2121095554.md +++ b/windows.applicationmodel.store/currentappsimulator_reportconsumablefulfillmentasync_2121095554.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.ReportConsumableFulfillmentAsync(System.String,System.Guid) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.ReportConsumableFulfillmentAsync ## -description Simulates notifying the Windows Store that the purchase of a consumable in-app product is fulfilled and that the user has the right to access the content. ## -parameters ### -param productId Identifies the consumable in-app product. ### -param transactionId Identifies a simulated transaction that includes the purchase of the consumable in-app product (*productId*). ## -returns A value that indicates the status of fulfillment for a simulated consumable in-app product purchase. ## -remarks A unique ID is required for each instance of a consumable that has been purchased more than once. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.ReportConsumableFulfillmentAsync(System.String,System.Guid) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.ReportConsumableFulfillmentAsync + +## -description +Simulates notifying the Windows Store that the purchase of a consumable in-app product is fulfilled and that the user has the right to access the content. + +## -parameters +### -param productId +Identifies the consumable in-app product. + +### -param transactionId +Identifies a simulated transaction that includes the purchase of the consumable in-app product (*productId*). + +## -returns +A value that indicates the status of fulfillment for a simulated consumable in-app product purchase. + +## -remarks +A unique ID is required for each instance of a consumable that has been purchased more than once. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_requestapppurchaseasync_2023276791.md b/windows.applicationmodel.store/currentappsimulator_requestapppurchaseasync_2023276791.md index 78d7e7c069..1e7d99a308 100644 --- a/windows.applicationmodel.store/currentappsimulator_requestapppurchaseasync_2023276791.md +++ b/windows.applicationmodel.store/currentappsimulator_requestapppurchaseasync_2023276791.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestAppPurchaseAsync(System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.RequestAppPurchaseAsync ## -description Creates the async operation that simulates a user request to buy a full license for the current app. ## -parameters ### -param includeReceipt Determines if the method should return the receipts for this app. ## -returns If the *includeReceipt* parameter is set to true, this string contains XML that represents all receipts for the app and any in-app product purchases. If *includeReceipt* is set to false, this string is empty. ## -remarks This method returns a success value even if: + No network connection is available. + The user cancels out of the dialog. + The user's authentication fails. You should treat a success result as indicating the async process completed without errors. To ensure that the transaction itself was successful, check the **LicenseInformation** element in the returned receipt. For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestAppPurchaseAsync(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.RequestAppPurchaseAsync + +## -description +Creates the async operation that simulates a user request to buy a full license for the current app. + +## -parameters +### -param includeReceipt +Determines if the method should return the receipts for this app. + +## -returns +If the *includeReceipt* parameter is set to true, this string contains XML that represents all receipts for the app and any in-app product purchases. If *includeReceipt* is set to false, this string is empty. + +## -remarks +This method returns a success value even if: ++ No network connection is available. ++ The user cancels out of the dialog. ++ The user's authentication fails. + You should treat a success result as indicating the async process completed without errors. To ensure that the transaction itself was successful, check the **LicenseInformation** element in the returned receipt. + +For more information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1631257175.md b/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1631257175.md index cc6419290d..51dfaf4d81 100644 --- a/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1631257175.md +++ b/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1631257175.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync(System.String,System.Boolean) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync ## -description > [!NOTE] > [RequestProductPurchaseAsync(String, Boolean)](currentappsimulator_requestproductpurchaseasync_1631257175.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [RequestProductPurchaseAsync(String)](currentappsimulator_requestproductpurchaseasync_2091240017.md). Creates the async operation that displays the UI that is used to simulate the purchase of an in-app product from the Windows Store. ## -parameters ### -param productId Specifies the id, as defined by the simulation, of the in-app product to buy. ### -param includeReceipt Determines if the method should return the receipts for the specified *productId.* ## -returns A string providing in-app product purchase details for the provided *productId*. If *includeReceipt* is set **true**, the returned string will include a full receipt xml. ## -remarks Uses the **CurrentApp/ListingInformation/Product** element in the WindowsStoreProxy.xml file with the **ProductId** attribute that matches *ProductId* as the data source for the members of the returned object. If the purchase transaction succeeds, the license state is updated only in memory. The contents of WindowsStoreProxy.xml are not changed. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). Use the [LicenseInformation.IsActive](licenseinformation_isactive.md) property to confirm that a product license is active after a successful [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) call. > [!NOTE] > This method of confirming a successful purchase is only applicable to the [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) overloads that don't return a [PurchaseResults](purchaseresults.md) object. You can see an example of how to use this method in our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231569). ## -examples ## -see-also [RequestProductPurchaseAsync(String)](currentappsimulator_requestproductpurchaseasync_2091240017.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync + +## -description +> [!NOTE] +> [RequestProductPurchaseAsync(String, Boolean)](currentappsimulator_requestproductpurchaseasync_1631257175.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [RequestProductPurchaseAsync(String)](currentappsimulator_requestproductpurchaseasync_2091240017.md). + +Creates the async operation that displays the UI that is used to simulate the purchase of an in-app product from the Windows Store. + +## -parameters +### -param productId +Specifies the id, as defined by the simulation, of the in-app product to buy. + +### -param includeReceipt +Determines if the method should return the receipts for the specified *productId.* + +## -returns +A string providing in-app product purchase details for the provided *productId*. If *includeReceipt* is set **true**, the returned string will include a full receipt xml. + +## -remarks +Uses the **CurrentApp/ListingInformation/Product** element in the WindowsStoreProxy.xml file with the **ProductId** attribute that matches *ProductId* as the data source for the members of the returned object. If the purchase transaction succeeds, the license state is updated only in memory. The contents of WindowsStoreProxy.xml are not changed. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +Use the [LicenseInformation.IsActive](licenseinformation_isactive.md) property to confirm that a product license is active after a successful [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) call. + +> [!NOTE] +> This method of confirming a successful purchase is only applicable to the [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) overloads that don't return a [PurchaseResults](purchaseresults.md) object. + +You can see an example of how to use this method in our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231569). + +## -examples + +## -see-also +[RequestProductPurchaseAsync(String)](currentappsimulator_requestproductpurchaseasync_2091240017.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1934617021.md b/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1934617021.md index 279d96a3c6..e1f5db643d 100644 --- a/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1934617021.md +++ b/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_1934617021.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync(System.String,System.String,Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync ## -description Creates the async operation that displays the UI that is used to simulate the purchase of an in-app product from the Windows Store. The resulting [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) object includes the parameters required to display details for a specific offer within a large catalog of in-app products that is represented by a single entry in the Windows Store. ## -parameters ### -param productId The product ID used for listing in the Windows Store. ### -param offerId The specific in-app product within the large purchase catalog represented on the Windows Store by the *productId.* This value correlates with the content your app is responsible for fulfilling. The Windows Store only uses this parameter value to itemize the [PurchaseResults](purchaseresults.md). ### -param displayProperties The name of the in-app product that is displayed to the user at time of purchase. ## -returns The results of the in-app product purchase. ## -remarks ## -examples ## -see-also [RequestProductPurchaseAsync(String)](currentappsimulator_requestproductpurchaseasync_2091240017.md), [RequestProductPurchaseAsync(String, Boolean)](currentappsimulator_requestproductpurchaseasync_1631257175.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync(System.String,System.String,Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync + +## -description +Creates the async operation that displays the UI that is used to simulate the purchase of an in-app product from the Windows Store. + +The resulting [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) object includes the parameters required to display details for a specific offer within a large catalog of in-app products that is represented by a single entry in the Windows Store. + +## -parameters +### -param productId +The product ID used for listing in the Windows Store. + +### -param offerId +The specific in-app product within the large purchase catalog represented on the Windows Store by the *productId.* This value correlates with the content your app is responsible for fulfilling. The Windows Store only uses this parameter value to itemize the [PurchaseResults](purchaseresults.md). + +### -param displayProperties +The name of the in-app product that is displayed to the user at time of purchase. + +## -returns +The results of the in-app product purchase. + +## -remarks + +## -examples + +## -see-also +[RequestProductPurchaseAsync(String)](currentappsimulator_requestproductpurchaseasync_2091240017.md), [RequestProductPurchaseAsync(String, Boolean)](currentappsimulator_requestproductpurchaseasync_1631257175.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_2091240017.md b/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_2091240017.md index ffbd681092..0012b1ad3a 100644 --- a/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_2091240017.md +++ b/windows.applicationmodel.store/currentappsimulator_requestproductpurchaseasync_2091240017.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync ## -description Creates the async operation that displays the UI that is used to simulate the purchase of in-app product from the Windows Store. ## -parameters ### -param productId Specifies the id, as defined by the simulation, of the in-app product to buy. ## -returns A [PurchaseResults](purchaseresults.md) object containing transaction details for the provided *productId*. ## -remarks Uses the **CurrentApp/ListingInformation/Product** element in the WindowsStoreProxy.xml file with the **ProductId** attribute that matches *ProductId* as the data source for the members of the returned object. If the purchase succeeds, the license state is updated only in memory. The contents of WindowsStoreProxy.xml are not changed. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). Use the [LicenseInformation.IsActive](licenseinformation_isactive.md) property to confirm that a product license is active after a successful [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) call. > [!NOTE] > This method of confirming a successful purchase is only applicable to the [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) overloads that don't return a [PurchaseResults](purchaseresults.md) object. You can see an example of how to use this method in our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231569). ## -examples ## -see-also [RequestProductPurchaseAsync(String, Boolean)](currentappsimulator_requestproductpurchaseasync_1631257175.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.CurrentAppSimulator.RequestProductPurchaseAsync + +## -description +Creates the async operation that displays the UI that is used to simulate the purchase of in-app product from the Windows Store. + +## -parameters +### -param productId +Specifies the id, as defined by the simulation, of the in-app product to buy. + +## -returns +A [PurchaseResults](purchaseresults.md) object containing transaction details for the provided *productId*. + +## -remarks +Uses the **CurrentApp/ListingInformation/Product** element in the WindowsStoreProxy.xml file with the **ProductId** attribute that matches *ProductId* as the data source for the members of the returned object. If the purchase succeeds, the license state is updated only in memory. The contents of WindowsStoreProxy.xml are not changed. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). + +Use the [LicenseInformation.IsActive](licenseinformation_isactive.md) property to confirm that a product license is active after a successful [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) call. + +> [!NOTE] +> This method of confirming a successful purchase is only applicable to the [RequestProductPurchaseAsync](currentappsimulator_requestproductpurchaseasync.md) overloads that don't return a [PurchaseResults](purchaseresults.md) object. + +You can see an example of how to use this method in our [code sample](http://go.microsoft.com/fwlink/p/?linkid=231569). + +## -examples + +## -see-also +[RequestProductPurchaseAsync(String, Boolean)](currentappsimulator_requestproductpurchaseasync_1631257175.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/licenseinformation_expirationdate.md b/windows.applicationmodel.store/licenseinformation_expirationdate.md index 89de36d559..55533a5469 100644 --- a/windows.applicationmodel.store/licenseinformation_expirationdate.md +++ b/windows.applicationmodel.store/licenseinformation_expirationdate.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseInformation.ExpirationDate --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseInformation.ExpirationDate ## -description Gets the license expiration date and time relative to the system clock. ## -property-value The date and time that the app's trial license will expire. ## -remarks ### Windows Phone 8 This API always returns 9999 – 12 – 31 (ETERNITY_FILETIME_TIME). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseInformation.ExpirationDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseInformation.ExpirationDate + +## -description +Gets the license expiration date and time relative to the system clock. + +## -property-value +The date and time that the app's trial license will expire. + +## -remarks +### Windows Phone 8 + +This API always returns 9999 – 12 – 31 (ETERNITY_FILETIME_TIME). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/licenseinformation_isactive.md b/windows.applicationmodel.store/licenseinformation_isactive.md index 73371103bf..6e38565e78 100644 --- a/windows.applicationmodel.store/licenseinformation_isactive.md +++ b/windows.applicationmodel.store/licenseinformation_isactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseInformation.IsActive --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseInformation.IsActive ## -description Gets a value that indicates whether the license is active. ## -property-value Returns true if the license is active, and otherwise false. Returns false if the license is missing, expired, or revoked. See the remarks in [IsTrial](licenseinformation_istrial.md) for more info. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseInformation.IsActive +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseInformation.IsActive + +## -description +Gets a value that indicates whether the license is active. + +## -property-value +Returns true if the license is active, and otherwise false. Returns false if the license is missing, expired, or revoked. See the remarks in [IsTrial](licenseinformation_istrial.md) for more info. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/licenseinformation_istrial.md b/windows.applicationmodel.store/licenseinformation_istrial.md index 503d9761c9..fc4880df39 100644 --- a/windows.applicationmodel.store/licenseinformation_istrial.md +++ b/windows.applicationmodel.store/licenseinformation_istrial.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseInformation.IsTrial --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseInformation.IsTrial ## -description Gets a value that indicates whether the license is a trial license. ## -property-value Returns true if the license is a trial license, and otherwise false. ## -remarks For a trial experience with a trial period, there are some special considerations for interpreting the value of [IsTrial](licenseinformation_istrial.md). [IsTrial](licenseinformation_istrial.md) returns **true** even after the trial period ends, because a trial license is logically considered to be a trial license both during and after the trial period. After purchase, when the license becomes full, [IsTrial](licenseinformation_istrial.md) returns **false**. While [IsTrial](licenseinformation_istrial.md) returns **true**, there are two ways to tell whether the trial period has expired. If you want to take action the moment the trial period expires then compare the current Coordinated Universal Time (or Zulu time) with [ExpirationDate](licenseinformation_expirationdate.md). Otherwise, you can check [IsActive](licenseinformation_isactive.md), which returns **true** during the trial period and **false** some time after the trial period ends. > [!NOTE] > Be aware that, for an app installed from the Windows Store, it can take some hours after the trial period ends for [IsActive](licenseinformation_isactive.md) to begin returning a value of **false**. When testing your app with [CurrentAppSimulator](currentappsimulator.md), [IsActive](licenseinformation_isactive.md) will return **false** at the exact datetime set in the configuration file. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseInformation.IsTrial +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseInformation.IsTrial + +## -description +Gets a value that indicates whether the license is a trial license. + +## -property-value +Returns true if the license is a trial license, and otherwise false. + +## -remarks +For a trial experience with a trial period, there are some special considerations for interpreting the value of [IsTrial](licenseinformation_istrial.md). [IsTrial](licenseinformation_istrial.md) returns **true** even after the trial period ends, because a trial license is logically considered to be a trial license both during and after the trial period. After purchase, when the license becomes full, [IsTrial](licenseinformation_istrial.md) returns **false**. While [IsTrial](licenseinformation_istrial.md) returns **true**, there are two ways to tell whether the trial period has expired. If you want to take action the moment the trial period expires then compare the current Coordinated Universal Time (or Zulu time) with [ExpirationDate](licenseinformation_expirationdate.md). Otherwise, you can check [IsActive](licenseinformation_isactive.md), which returns **true** during the trial period and **false** some time after the trial period ends. + +> [!NOTE] +> Be aware that, for an app installed from the Windows Store, it can take some hours after the trial period ends for [IsActive](licenseinformation_isactive.md) to begin returning a value of **false**. When testing your app with [CurrentAppSimulator](currentappsimulator.md), [IsActive](licenseinformation_isactive.md) will return **false** at the exact datetime set in the configuration file. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/licenseinformation_licensechanged.md b/windows.applicationmodel.store/licenseinformation_licensechanged.md index 19d7a193c3..803e230791 100644 --- a/windows.applicationmodel.store/licenseinformation_licensechanged.md +++ b/windows.applicationmodel.store/licenseinformation_licensechanged.md @@ -1,3 +1,24 @@ ---- -api-id: E:Windows.ApplicationModel.Store.LicenseInformation.LicenseChanged --api-type: winrt event ---- # Windows.ApplicationModel.Store.LicenseInformation.LicenseChanged ## -description Raises a notification event when the status of the app's license changes. ## -remarks [LicenseChanged](licenseinformation_licensechanged.md) events aren't always immediate. If you’ve registered for the event, the event should fire within an hour; if not, it should occur within 6 hours. Generally, it's recommended to wait up to 6 hours when testing with [CurrentApp](currentapp.md), knowing that it will most likely take less time if the app has registered the event. ### Windows Phone 8 This event is not raised on Windows Phone 8. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Store.LicenseInformation.LicenseChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Store.LicenseInformation.LicenseChanged + +## -description +Raises a notification event when the status of the app's license changes. + +## -remarks +[LicenseChanged](licenseinformation_licensechanged.md) events aren't always immediate. If you’ve registered for the event, the event should fire within an hour; if not, it should occur within 6 hours. Generally, it's recommended to wait up to 6 hours when testing with [CurrentApp](currentapp.md), knowing that it will most likely take less time if the app has registered the event. + +### Windows Phone 8 + +This event is not raised on Windows Phone 8. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/licenseinformation_productlicenses.md b/windows.applicationmodel.store/licenseinformation_productlicenses.md index f661c10847..f66cb26b5e 100644 --- a/windows.applicationmodel.store/licenseinformation_productlicenses.md +++ b/windows.applicationmodel.store/licenseinformation_productlicenses.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.Store.LicenseInformation.ProductLicenses --api-type: winrt property ---- # Windows.ApplicationModel.Store.LicenseInformation.ProductLicenses ## -description Gets the associative list of licenses for in-app products that a user is currently entitled to. > [!IMPORTANT] > The returned list of [ProductLicense](productlicense.md) objects will always represent all in-app products that a user is currently entitled to (**isActive = true**). However, this list may or may not also contain [ProductLicense](productlicense.md) objects for products that a user is not currently entitled to (**isActive = false**). Call [ProductLicense.isActive](productlicense_isactive.md) to determine if a user is entitled to an in-app product. ## -property-value The associative list of feature licenses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.LicenseInformation.ProductLicenses +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.LicenseInformation.ProductLicenses + +## -description +Gets the associative list of licenses for in-app products that a user is currently entitled to. + +> [!IMPORTANT] +> The returned list of [ProductLicense](productlicense.md) objects will always represent all in-app products that a user is currently entitled to (**isActive = true**). However, this list may or may not also contain [ProductLicense](productlicense.md) objects for products that a user is not currently entitled to (**isActive = false**). + +Call [ProductLicense.isActive](productlicense_isactive.md) to determine if a user is entitled to an in-app product. + +## -property-value +The associative list of feature licenses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/listinginformation_agerating.md b/windows.applicationmodel.store/listinginformation_agerating.md index 7b6367d3fa..9f10e6fcad 100644 --- a/windows.applicationmodel.store/listinginformation_agerating.md +++ b/windows.applicationmodel.store/listinginformation_agerating.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.AgeRating --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.AgeRating ## -description Gets the age rating for the app. ## -property-value The age rating. ## -remarks ## -examples ## -see-also [Age ratings](https://msdn.microsoft.com/windows/uwp/publish/age-ratings) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.AgeRating +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.AgeRating + +## -description +Gets the age rating for the app. + +## -property-value +The age rating. + +## -remarks + +## -examples + +## -see-also +[Age ratings](https://msdn.microsoft.com/windows/uwp/publish/age-ratings) diff --git a/windows.applicationmodel.store/listinginformation_currencycode.md b/windows.applicationmodel.store/listinginformation_currencycode.md index d6cf68be6a..b38d831f57 100644 --- a/windows.applicationmodel.store/listinginformation_currencycode.md +++ b/windows.applicationmodel.store/listinginformation_currencycode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.CurrencyCode --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.CurrencyCode ## -description Gets the currency code associated with the user's market, such as **USD** or **CAD**. ## -property-value The currency code associated with the user's market, such as **USD** or **CAD**. ## -remarks The currency code string returned by this property conforms to ISO 4217. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.CurrencyCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.CurrencyCode + +## -description +Gets the currency code associated with the user's market, such as **USD** or **CAD**. + +## -property-value +The currency code associated with the user's market, such as **USD** or **CAD**. + +## -remarks +The currency code string returned by this property conforms to ISO 4217. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/listinginformation_currentmarket.md b/windows.applicationmodel.store/listinginformation_currentmarket.md index 822f25308a..23b9c7cd29 100644 --- a/windows.applicationmodel.store/listinginformation_currentmarket.md +++ b/windows.applicationmodel.store/listinginformation_currentmarket.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.CurrentMarket --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.CurrentMarket ## -description Gets the country code associated with the user's location, such as **US** or **CA**, that is used to identify their market for transactions in the current session. ## -property-value The country code associated with the user's location, such as **US** or **CA**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.CurrentMarket +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.CurrentMarket + +## -description +Gets the country code associated with the user's location, such as **US** or **CA**, that is used to identify their market for transactions in the current session. + +## -property-value +The country code associated with the user's location, such as **US** or **CA**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/listinginformation_description.md b/windows.applicationmodel.store/listinginformation_description.md index 9153d7d095..ff1f443bc2 100644 --- a/windows.applicationmodel.store/listinginformation_description.md +++ b/windows.applicationmodel.store/listinginformation_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.Description --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.Description ## -description Gets the app's description in the current market. ## -property-value The app's description in the current market. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.Description + +## -description +Gets the app's description in the current market. + +## -property-value +The app's description in the current market. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/listinginformation_formattedbaseprice.md b/windows.applicationmodel.store/listinginformation_formattedbaseprice.md index 0057547ebd..5100fdd970 100644 --- a/windows.applicationmodel.store/listinginformation_formattedbaseprice.md +++ b/windows.applicationmodel.store/listinginformation_formattedbaseprice.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.FormattedBasePrice --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.FormattedBasePrice ## -description Gets the app's base price formatted for the current market and currency. ## -property-value The app's base price with the appropriate formatting for the current market and currency. ## -remarks The base price is the default price for the app. If the app is on sale in the current market, use the [FormattedPrice](listinginformation_formattedprice.md) property to get the sale price. If the app is not on sale, [FormattedBasePrice](listinginformation_formattedbaseprice.md) and [FormattedPrice](listinginformation_formattedprice.md) return the same value. ## -examples ## -see-also [Put apps on sale](m_selling.put_apps_and_iaps_on_sale) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.FormattedBasePrice +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.FormattedBasePrice + +## -description +Gets the app's base price formatted for the current market and currency. + +## -property-value +The app's base price with the appropriate formatting for the current market and currency. + +## -remarks +The base price is the default price for the app. If the app is on sale in the current market, use the [FormattedPrice](listinginformation_formattedprice.md) property to get the sale price. If the app is not on sale, [FormattedBasePrice](listinginformation_formattedbaseprice.md) and [FormattedPrice](listinginformation_formattedprice.md) return the same value. + +## -examples + +## -see-also +[Put apps on sale](m_selling.put_apps_and_iaps_on_sale) \ No newline at end of file diff --git a/windows.applicationmodel.store/listinginformation_formattedprice.md b/windows.applicationmodel.store/listinginformation_formattedprice.md index 7fd4111188..58908d48d1 100644 --- a/windows.applicationmodel.store/listinginformation_formattedprice.md +++ b/windows.applicationmodel.store/listinginformation_formattedprice.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.FormattedPrice --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.FormattedPrice ## -description Gets the app's purchase price formatted for the current market and currency. ## -property-value The app's purchase price with the appropriate formatting for the current market and currency. ## -remarks If the app is on sale in the current market, the [FormattedPrice](listinginformation_formattedprice.md) property returns the sale price. Use the [FormattedBasePrice](listinginformation_formattedbaseprice.md) property to get the default price. If the app is not on sale, [FormattedBasePrice](listinginformation_formattedbaseprice.md) and [FormattedPrice](listinginformation_formattedprice.md) return the same value. ## -examples ## -see-also [Put apps on sale](m_selling.put_apps_and_iaps_on_sale) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.FormattedPrice +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.FormattedPrice + +## -description +Gets the app's purchase price formatted for the current market and currency. + +## -property-value +The app's purchase price with the appropriate formatting for the current market and currency. + +## -remarks +If the app is on sale in the current market, the [FormattedPrice](listinginformation_formattedprice.md) property returns the sale price. Use the [FormattedBasePrice](listinginformation_formattedbaseprice.md) property to get the default price. If the app is not on sale, [FormattedBasePrice](listinginformation_formattedbaseprice.md) and [FormattedPrice](listinginformation_formattedprice.md) return the same value. + +## -examples + +## -see-also +[Put apps on sale](m_selling.put_apps_and_iaps_on_sale) \ No newline at end of file diff --git a/windows.applicationmodel.store/listinginformation_isonsale.md b/windows.applicationmodel.store/listinginformation_isonsale.md index 1fdffb4af1..70d0d1f6d3 100644 --- a/windows.applicationmodel.store/listinginformation_isonsale.md +++ b/windows.applicationmodel.store/listinginformation_isonsale.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.IsOnSale --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.IsOnSale ## -description Gets a value that indicates whether the app is on sale. ## -property-value Returns true if the app is on sale, and otherwise false. ## -remarks For information about putting apps on sale, see [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale). ## -examples ## -see-also [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.IsOnSale +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.IsOnSale + +## -description +Gets a value that indicates whether the app is on sale. + +## -property-value +Returns true if the app is on sale, and otherwise false. + +## -remarks +For information about putting apps on sale, see [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale). + +## -examples + +## -see-also +[Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file diff --git a/windows.applicationmodel.store/listinginformation_name.md b/windows.applicationmodel.store/listinginformation_name.md index 4b8b149b38..2822d6c96e 100644 --- a/windows.applicationmodel.store/listinginformation_name.md +++ b/windows.applicationmodel.store/listinginformation_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.Name --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.Name ## -description Gets the app's name in the current market. ## -property-value The app's name in the current market. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.Name + +## -description +Gets the app's name in the current market. + +## -property-value +The app's name in the current market. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/listinginformation_productlistings.md b/windows.applicationmodel.store/listinginformation_productlistings.md index 2c3489ba61..a63c984a3c 100644 --- a/windows.applicationmodel.store/listinginformation_productlistings.md +++ b/windows.applicationmodel.store/listinginformation_productlistings.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.ProductListings --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.ProductListings ## -description Gets information about add-ons (also called in-app products or IAPs) available for purchase. ## -property-value The array of [ProductListing](productlisting.md) objects that describes the app's add-ons. ## -remarks ## -examples ## -see-also [ProductListing](productlisting.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.ProductListings +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.ProductListings + +## -description +Gets information about add-ons (also called in-app products or IAPs) available for purchase. + +## -property-value +The array of [ProductListing](productlisting.md) objects that describes the app's add-ons. + +## -remarks + +## -examples + +## -see-also +[ProductListing](productlisting.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/listinginformation_saleenddate.md b/windows.applicationmodel.store/listinginformation_saleenddate.md index 1b956325a7..936dc60fd3 100644 --- a/windows.applicationmodel.store/listinginformation_saleenddate.md +++ b/windows.applicationmodel.store/listinginformation_saleenddate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ListingInformation.SaleEndDate --api-type: winrt property ---- # Windows.ApplicationModel.Store.ListingInformation.SaleEndDate ## -description Gets the end date of the sale period for the app. ## -property-value The date and time that the app's sale period will end. ## -remarks ## -examples ## -see-also [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ListingInformation.SaleEndDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ListingInformation.SaleEndDate + +## -description +Gets the end date of the sale period for the app. + +## -property-value +The date and time that the app's sale period will end. + +## -remarks + +## -examples + +## -see-also +[Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file diff --git a/windows.applicationmodel.store/productlicense_expirationdate.md b/windows.applicationmodel.store/productlicense_expirationdate.md index cb43127fc9..c7e70606eb 100644 --- a/windows.applicationmodel.store/productlicense_expirationdate.md +++ b/windows.applicationmodel.store/productlicense_expirationdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductLicense.ExpirationDate --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductLicense.ExpirationDate ## -description Gets the current expiration date and time of the add-on (also called an in-app product or IAP) license. ## -property-value The date and time indicating when the add-on license expires. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductLicense.ExpirationDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductLicense.ExpirationDate + +## -description +Gets the current expiration date and time of the add-on (also called an in-app product or IAP) license. + +## -property-value +The date and time indicating when the add-on license expires. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlicense_isactive.md b/windows.applicationmodel.store/productlicense_isactive.md index 6dd1c59327..6f88af4970 100644 --- a/windows.applicationmodel.store/productlicense_isactive.md +++ b/windows.applicationmodel.store/productlicense_isactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductLicense.IsActive --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductLicense.IsActive ## -description Indicates if the add-on (also called an in-app product or IAP) license is currently active. ## -property-value Returns **true** if the add-on's license is active, and otherwise **false**. This property can return **false** if the license is missing, expired, or revoked. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductLicense.IsActive +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductLicense.IsActive + +## -description +Indicates if the add-on (also called an in-app product or IAP) license is currently active. + +## -property-value +Returns **true** if the add-on's license is active, and otherwise **false**. This property can return **false** if the license is missing, expired, or revoked. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlicense_isconsumable.md b/windows.applicationmodel.store/productlicense_isconsumable.md index 124b045313..fa9be0c88a 100644 --- a/windows.applicationmodel.store/productlicense_isconsumable.md +++ b/windows.applicationmodel.store/productlicense_isconsumable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductLicense.IsConsumable --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductLicense.IsConsumable ## -description Indicates if the add-on (also called an in-app product or IAP) is consumable. A consumable add-on can be purchased, used, and purchased again. ## -property-value **true** if the add-on is a consumable add-on; Otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductLicense.IsConsumable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductLicense.IsConsumable + +## -description +Indicates if the add-on (also called an in-app product or IAP) is consumable. A consumable add-on can be purchased, used, and purchased again. + +## -property-value +**true** if the add-on is a consumable add-on; Otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlicense_productid.md b/windows.applicationmodel.store/productlicense_productid.md index f5677661e0..0a34bf51b3 100644 --- a/windows.applicationmodel.store/productlicense_productid.md +++ b/windows.applicationmodel.store/productlicense_productid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductLicense.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductLicense.ProductId ## -description Gets the ID of an add-on (also called an in-app product or IAP). This ID is used by the app to get info about the product or feature that is enabled when the customer buys it through an in-app purchase. ## -property-value The ID specified in the Windows Dev Center dashboard to identify this add-on. ## -remarks The product ID is the string that the app uses to identify the add-on. You enter the product ID when [submitting your add-on](https://msdn.microsoft.com/windows/uwp/publish/set-your-add-on-product-id) in the Windows Dev Center dashboard, where it is associated with the description, price tier and lifetime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductLicense.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductLicense.ProductId + +## -description +Gets the ID of an add-on (also called an in-app product or IAP). This ID is used by the app to get info about the product or feature that is enabled when the customer buys it through an in-app purchase. + +## -property-value +The ID specified in the Windows Dev Center dashboard to identify this add-on. + +## -remarks +The product ID is the string that the app uses to identify the add-on. You enter the product ID when [submitting your add-on](https://msdn.microsoft.com/windows/uwp/publish/set-your-add-on-product-id) in the Windows Dev Center dashboard, where it is associated with the description, price tier and lifetime. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_currencycode.md b/windows.applicationmodel.store/productlisting_currencycode.md index e43b2dab41..deb805ef20 100644 --- a/windows.applicationmodel.store/productlisting_currencycode.md +++ b/windows.applicationmodel.store/productlisting_currencycode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.CurrencyCode --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.CurrencyCode ## -description Gets the currency code associated with the user's market, such as **USD** or **CAD**. ## -property-value The currency code associated with the user's market, such as **USD** or **CAD**. ## -remarks The currency code string returned by this property conforms to ISO 4217. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.CurrencyCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.CurrencyCode + +## -description +Gets the currency code associated with the user's market, such as **USD** or **CAD**. + +## -property-value +The currency code associated with the user's market, such as **USD** or **CAD**. + +## -remarks +The currency code string returned by this property conforms to ISO 4217. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_description.md b/windows.applicationmodel.store/productlisting_description.md index eea7c7c47f..fff22f896c 100644 --- a/windows.applicationmodel.store/productlisting_description.md +++ b/windows.applicationmodel.store/productlisting_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.Description --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.Description ## -description Gets the description for the add-on (also called an in-app product or IAP). ## -property-value The description for the product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.Description + +## -description +Gets the description for the add-on (also called an in-app product or IAP). + +## -property-value +The description for the product. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_formattedbaseprice.md b/windows.applicationmodel.store/productlisting_formattedbaseprice.md index 387bf5dba4..c1f220b2ef 100644 --- a/windows.applicationmodel.store/productlisting_formattedbaseprice.md +++ b/windows.applicationmodel.store/productlisting_formattedbaseprice.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.FormattedBasePrice --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.FormattedBasePrice ## -description Gets the base price for the add-on (also called an in-app product or IAP) with the appropriate formatting for the current market. ## -property-value The base price for the add-on with the appropriate formatting for the current market. ## -remarks The base price is the default price for the add-on. If the add-on is on sale in the current market, use the [FormattedPrice](productlisting_formattedprice.md) property to get the sale price. If the add-on is not on sale, [FormattedBasePrice](productlisting_formattedbaseprice.md) and [FormattedPrice](productlisting_formattedprice.md) return the same value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.FormattedBasePrice +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.FormattedBasePrice + +## -description +Gets the base price for the add-on (also called an in-app product or IAP) with the appropriate formatting for the current market. + +## -property-value +The base price for the add-on with the appropriate formatting for the current market. + +## -remarks +The base price is the default price for the add-on. If the add-on is on sale in the current market, use the [FormattedPrice](productlisting_formattedprice.md) property to get the sale price. If the add-on is not on sale, [FormattedBasePrice](productlisting_formattedbaseprice.md) and [FormattedPrice](productlisting_formattedprice.md) return the same value. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_formattedprice.md b/windows.applicationmodel.store/productlisting_formattedprice.md index d434bb33b7..8dde017077 100644 --- a/windows.applicationmodel.store/productlisting_formattedprice.md +++ b/windows.applicationmodel.store/productlisting_formattedprice.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.FormattedPrice --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.FormattedPrice ## -description Gets the purchase price for the in-app product with the appropriate formatting for the current market. ## -property-value The purchase price with the appropriate formatting for the current market. ## -remarks If the in-app product is on sale in the current market, the [FormattedPrice](productlisting_formattedprice.md) property returns the sale price. Use the [FormattedBasePrice](productlisting_formattedbaseprice.md) property to get the default price. If the in-app product is not on sale, [FormattedBasePrice](productlisting_formattedbaseprice.md) and [FormattedPrice](productlisting_formattedprice.md) return the same value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.FormattedPrice +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.FormattedPrice + +## -description +Gets the purchase price for the in-app product with the appropriate formatting for the current market. + +## -property-value +The purchase price with the appropriate formatting for the current market. + +## -remarks +If the in-app product is on sale in the current market, the [FormattedPrice](productlisting_formattedprice.md) property returns the sale price. Use the [FormattedBasePrice](productlisting_formattedbaseprice.md) property to get the default price. If the in-app product is not on sale, [FormattedBasePrice](productlisting_formattedbaseprice.md) and [FormattedPrice](productlisting_formattedprice.md) return the same value. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_imageuri.md b/windows.applicationmodel.store/productlisting_imageuri.md index f3f247b27d..93c9755a02 100644 --- a/windows.applicationmodel.store/productlisting_imageuri.md +++ b/windows.applicationmodel.store/productlisting_imageuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.ImageUri --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.ImageUri ## -description Gets the URI of the image associated with the add-on (also called an in-app product or IAP). ## -property-value The URI to the image associated with the add-on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.ImageUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.ImageUri + +## -description +Gets the URI of the image associated with the add-on (also called an in-app product or IAP). + +## -property-value +The URI to the image associated with the add-on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_isonsale.md b/windows.applicationmodel.store/productlisting_isonsale.md index ae6fc05d10..781d94d861 100644 --- a/windows.applicationmodel.store/productlisting_isonsale.md +++ b/windows.applicationmodel.store/productlisting_isonsale.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.IsOnSale --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.IsOnSale ## -description Gets a value that indicates whether the add-on (also called an in-app product or IAP) is on sale. ## -property-value Returns true if the in-app product is on sale, and otherwise false. ## -remarks For information about putting add-ons on sale, see [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale). ## -examples ## -see-also [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.IsOnSale +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.IsOnSale + +## -description +Gets a value that indicates whether the add-on (also called an in-app product or IAP) is on sale. + +## -property-value +Returns true if the in-app product is on sale, and otherwise false. + +## -remarks +For information about putting add-ons on sale, see [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale). + +## -examples + +## -see-also +[Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file diff --git a/windows.applicationmodel.store/productlisting_keywords.md b/windows.applicationmodel.store/productlisting_keywords.md index 987609eadf..cac5be41d6 100644 --- a/windows.applicationmodel.store/productlisting_keywords.md +++ b/windows.applicationmodel.store/productlisting_keywords.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.Keywords --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.Keywords ## -description Gets the list of keywords associated with the add-on (also called an in-app product or IAP). These keywords are useful for filtering product lists by keyword, for example, when calling [LoadListingInformationByKeywordsAsync](currentapp_loadlistinginformationbykeywordsasync.md). ## -property-value The keywords associated with the in-app product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.Keywords +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.Keywords + +## -description +Gets the list of keywords associated with the add-on (also called an in-app product or IAP). These keywords are useful for filtering product lists by keyword, for example, when calling [LoadListingInformationByKeywordsAsync](currentapp_loadlistinginformationbykeywordsasync.md). + +## -property-value +The keywords associated with the in-app product. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_name.md b/windows.applicationmodel.store/productlisting_name.md index c5e31c9139..ebe5e7c584 100644 --- a/windows.applicationmodel.store/productlisting_name.md +++ b/windows.applicationmodel.store/productlisting_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.Name --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.Name ## -description Gets the descriptive name of the add-on (also called an in-app product or IAP) that is displayed customers in the current market. ## -property-value The add-on's descriptive name as it is seen by customers in the current market. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.Name + +## -description +Gets the descriptive name of the add-on (also called an in-app product or IAP) that is displayed customers in the current market. + +## -property-value +The add-on's descriptive name as it is seen by customers in the current market. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_productid.md b/windows.applicationmodel.store/productlisting_productid.md index d5d92bce8d..80cdc67e90 100644 --- a/windows.applicationmodel.store/productlisting_productid.md +++ b/windows.applicationmodel.store/productlisting_productid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.ProductId ## -description Gets the product ID for the add-on (also called an in-app product or IAP). ## -property-value The product ID for the add-on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.ProductId + +## -description +Gets the product ID for the add-on (also called an in-app product or IAP). + +## -property-value +The product ID for the add-on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productlisting_producttype.md b/windows.applicationmodel.store/productlisting_producttype.md index 63643846ef..0c7341ed72 100644 --- a/windows.applicationmodel.store/productlisting_producttype.md +++ b/windows.applicationmodel.store/productlisting_producttype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.ProductType --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.ProductType ## -description Gets the type of this add-on (also called an in-app product or IAP). Possible values are defined by [ProductType](producttype.md). ## -property-value The product type. Possible values include **Consumable** and **Durable**. ## -remarks ## -examples ## -see-also [ProductType](producttype.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.ProductType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.ProductType + +## -description +Gets the type of this add-on (also called an in-app product or IAP). Possible values are defined by [ProductType](producttype.md). + +## -property-value +The product type. Possible values include **Consumable** and **Durable**. + +## -remarks + +## -examples + +## -see-also +[ProductType](producttype.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/productlisting_saleenddate.md b/windows.applicationmodel.store/productlisting_saleenddate.md index bf56ce350b..5e992b7732 100644 --- a/windows.applicationmodel.store/productlisting_saleenddate.md +++ b/windows.applicationmodel.store/productlisting_saleenddate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.SaleEndDate --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.SaleEndDate ## -description Gets the end date of the sale period for the add-on (also called an in-app product or IAP). ## -property-value The date and time that the add-on's sale period will end. ## -remarks ## -examples ## -see-also [Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.SaleEndDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.SaleEndDate + +## -description +Gets the end date of the sale period for the add-on (also called an in-app product or IAP). + +## -property-value +The date and time that the add-on's sale period will end. + +## -remarks + +## -examples + +## -see-also +[Put apps and add-ons on sale](https://msdn.microsoft.com/windows/uwp/publish/put-apps-and-add-ons-on-sale) \ No newline at end of file diff --git a/windows.applicationmodel.store/productlisting_tag.md b/windows.applicationmodel.store/productlisting_tag.md index f5f7e2ec3e..afccaacc47 100644 --- a/windows.applicationmodel.store/productlisting_tag.md +++ b/windows.applicationmodel.store/productlisting_tag.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductListing.Tag --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductListing.Tag ## -description Gets the custom developer data string (also called a tag) that contains custom information about an add-on (also called an in-app product or IAP). This string corresponds to the value of the **Custom developer data** field in the properties page for the add-on in the Windows Dev Center dashboard. ## -property-value The custom developer data for the add-on. ## -remarks The custom developer data provides a way for developers to associate custom contextual information with an add-on. For more information about setting this value for an add-on, see [Enter add-on properties](https://msdn.microsoft.com/windows/uwp/publish/enter-add-on-properties#custom-developer-data). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductListing.Tag +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductListing.Tag + +## -description +Gets the custom developer data string (also called a tag) that contains custom information about an add-on (also called an in-app product or IAP). This string corresponds to the value of the **Custom developer data** field in the properties page for the add-on in the Windows Dev Center dashboard. + +## -property-value +The custom developer data for the add-on. + +## -remarks +The custom developer data provides a way for developers to associate custom contextual information with an add-on. For more information about setting this value for an add-on, see [Enter add-on properties](https://msdn.microsoft.com/windows/uwp/publish/enter-add-on-properties#custom-developer-data). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productpurchasedisplayproperties.md b/windows.applicationmodel.store/productpurchasedisplayproperties.md index 3894dce81a..f23fcb1fbc 100644 --- a/windows.applicationmodel.store/productpurchasedisplayproperties.md +++ b/windows.applicationmodel.store/productpurchasedisplayproperties.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties --api-type: winrt class ---- # Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties ## -description Used to provide the product name that is displayed to the user at time of purchase. This class is used in the creation of a [RequestProductPurchaseAsync](currentapp_requestproductpurchaseasync.md) operation to visually represent a specific offer within a large catalog of in-app products, which is represented by a single product entry in the Windows Store. > [!NOTE] > Windows Phone 8 developers can also display an image associated with the product by providing a URI with *image* for display and an internally consumed *description*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties + +## -description +Used to provide the product name that is displayed to the user at time of purchase. This class is used in the creation of a [RequestProductPurchaseAsync](currentapp_requestproductpurchaseasync.md) operation to visually represent a specific offer within a large catalog of in-app products, which is represented by a single product entry in the Windows Store. + +> [!NOTE] +> Windows Phone 8 developers can also display an image associated with the product by providing a URI with *image* for display and an internally consumed *description*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productpurchasedisplayproperties_description.md b/windows.applicationmodel.store/productpurchasedisplayproperties_description.md index abeb91d0df..b6dad259a6 100644 --- a/windows.applicationmodel.store/productpurchasedisplayproperties_description.md +++ b/windows.applicationmodel.store/productpurchasedisplayproperties_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Description --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Description ## -description Windows Phone only. This is an internal product description. ## -property-value Internal product description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Description + +## -description +Windows Phone only. This is an internal product description. + +## -property-value +Internal product description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productpurchasedisplayproperties_image.md b/windows.applicationmodel.store/productpurchasedisplayproperties_image.md index 074807fec9..11107c4d2d 100644 --- a/windows.applicationmodel.store/productpurchasedisplayproperties_image.md +++ b/windows.applicationmodel.store/productpurchasedisplayproperties_image.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Image --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Image ## -description Windows Phone only. Gets or sets the location of an image used to represent the product at time of purchase. ## -property-value The image location. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Image +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Image + +## -description +Windows Phone only. Gets or sets the location of an image used to represent the product at time of purchase. + +## -property-value +The image location. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productpurchasedisplayproperties_name.md b/windows.applicationmodel.store/productpurchasedisplayproperties_name.md index 17efb93bb4..0d2314b90a 100644 --- a/windows.applicationmodel.store/productpurchasedisplayproperties_name.md +++ b/windows.applicationmodel.store/productpurchasedisplayproperties_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Name --api-type: winrt property ---- # Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Name ## -description Gets or sets the product name that is displayed to the user at time of purchase. ## -property-value The product name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.Name + +## -description +Gets or sets the product name that is displayed to the user at time of purchase. + +## -property-value +The product name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_1221375020.md b/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_1221375020.md index 79846d2392..113bf33780 100644 --- a/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_1221375020.md +++ b/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.ProductPurchaseDisplayProperties ## -description Creates an instance of [ProductPurchaseDisplayProperties](productpurchasedisplayproperties.md). ## -remarks ## -examples ## -see-also [ProductPurchaseDisplayProperties(String)](productpurchasedisplayproperties_productpurchasedisplayproperties_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.ProductPurchaseDisplayProperties + +## -description +Creates an instance of [ProductPurchaseDisplayProperties](productpurchasedisplayproperties.md). + +## -remarks + +## -examples + +## -see-also +[ProductPurchaseDisplayProperties(String)](productpurchasedisplayproperties_productpurchasedisplayproperties_290278668.md) \ No newline at end of file diff --git a/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_290278668.md b/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_290278668.md index 7bad90093a..449bd3b601 100644 --- a/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_290278668.md +++ b/windows.applicationmodel.store/productpurchasedisplayproperties_productpurchasedisplayproperties_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.ProductPurchaseDisplayProperties ## -description Creates an instance of [ProductPurchaseDisplayProperties](productpurchasedisplayproperties.md) that includes the specified product name to display to the user. ## -parameters ### -param name The product name displayed to the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.ProductPurchaseDisplayProperties.ProductPurchaseDisplayProperties + +## -description +Creates an instance of [ProductPurchaseDisplayProperties](productpurchasedisplayproperties.md) that includes the specified product name to display to the user. + +## -parameters +### -param name +The product name displayed to the user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/purchaseresults.md b/windows.applicationmodel.store/purchaseresults.md index 2b9b2ba4c9..066f22c69b 100644 --- a/windows.applicationmodel.store/purchaseresults.md +++ b/windows.applicationmodel.store/purchaseresults.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Store.PurchaseResults --api-type: winrt class ---- # Windows.ApplicationModel.Store.PurchaseResults ## -description Contains information detailing the results of an in-app product purchase transaction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.PurchaseResults +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.PurchaseResults + +## -description +Contains information detailing the results of an in-app product purchase transaction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/purchaseresults_offerid.md b/windows.applicationmodel.store/purchaseresults_offerid.md index 6a6f1a4953..fbc67e5393 100644 --- a/windows.applicationmodel.store/purchaseresults_offerid.md +++ b/windows.applicationmodel.store/purchaseresults_offerid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.PurchaseResults.OfferId --api-type: winrt property ---- # Windows.ApplicationModel.Store.PurchaseResults.OfferId ## -description A unique ID used to identify a specific in-app product within a large catalog. ## -property-value Unique string used to identify a particular in-app product with a large catalog. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.PurchaseResults.OfferId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.PurchaseResults.OfferId + +## -description +A unique ID used to identify a specific in-app product within a large catalog. + +## -property-value +Unique string used to identify a particular in-app product with a large catalog. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/purchaseresults_receiptxml.md b/windows.applicationmodel.store/purchaseresults_receiptxml.md index 683adf23be..533d4d522d 100644 --- a/windows.applicationmodel.store/purchaseresults_receiptxml.md +++ b/windows.applicationmodel.store/purchaseresults_receiptxml.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Store.PurchaseResults.ReceiptXml --api-type: winrt property ---- # Windows.ApplicationModel.Store.PurchaseResults.ReceiptXml ## -description A full receipt that provides a transaction history for the purchase of an in-app product. ## -property-value An XML-formatted string. ## -remarks For information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.PurchaseResults.ReceiptXml +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.PurchaseResults.ReceiptXml + +## -description +A full receipt that provides a transaction history for the purchase of an in-app product. + +## -property-value +An XML-formatted string. + +## -remarks +For information about the contents of the receipt, see [Using receipts to verify product purchases](https://msdn.microsoft.com/windows/uwp/monetize/use-receipts-to-verify-product-purchases). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/purchaseresults_status.md b/windows.applicationmodel.store/purchaseresults_status.md index 461608fa63..168881064b 100644 --- a/windows.applicationmodel.store/purchaseresults_status.md +++ b/windows.applicationmodel.store/purchaseresults_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.PurchaseResults.Status --api-type: winrt property ---- # Windows.ApplicationModel.Store.PurchaseResults.Status ## -description The current state of the purchase transaction for an in-app product. ## -property-value A purchase state value defined by the [ProductPurchaseStatus](productpurchasestatus.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.PurchaseResults.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.PurchaseResults.Status + +## -description +The current state of the purchase transaction for an in-app product. + +## -property-value +A purchase state value defined by the [ProductPurchaseStatus](productpurchasestatus.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/purchaseresults_transactionid.md b/windows.applicationmodel.store/purchaseresults_transactionid.md index c4572c875b..5231453b7b 100644 --- a/windows.applicationmodel.store/purchaseresults_transactionid.md +++ b/windows.applicationmodel.store/purchaseresults_transactionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.PurchaseResults.TransactionId --api-type: winrt property ---- # Windows.ApplicationModel.Store.PurchaseResults.TransactionId ## -description A unique transaction ID associated with the purchase of a consumable in-app product. ## -property-value A unique ID associated with a transaction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.PurchaseResults.TransactionId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.PurchaseResults.TransactionId + +## -description +A unique transaction ID associated with the purchase of a consumable in-app product. + +## -property-value +A unique ID associated with a transaction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/unfulfilledconsumable.md b/windows.applicationmodel.store/unfulfilledconsumable.md index 301fecc8a9..4b9d93505b 100644 --- a/windows.applicationmodel.store/unfulfilledconsumable.md +++ b/windows.applicationmodel.store/unfulfilledconsumable.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.Store.UnfulfilledConsumable --api-type: winrt class ---- # Windows.ApplicationModel.Store.UnfulfilledConsumable ## -description Contains purchase and product information for an unfulfilled consumable in-app product. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Store.UnfulfilledConsumable +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.UnfulfilledConsumable + +## -description +Contains purchase and product information for an unfulfilled consumable in-app product. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/unfulfilledconsumable_offerid.md b/windows.applicationmodel.store/unfulfilledconsumable_offerid.md index b5fc898b9f..03f15e40be 100644 --- a/windows.applicationmodel.store/unfulfilledconsumable_offerid.md +++ b/windows.applicationmodel.store/unfulfilledconsumable_offerid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.UnfulfilledConsumable.OfferId --api-type: winrt property ---- # Windows.ApplicationModel.Store.UnfulfilledConsumable.OfferId ## -description A unique ID used to identify a consumable in-app product within a large purchase catalog. ## -property-value The offer ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.UnfulfilledConsumable.OfferId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.UnfulfilledConsumable.OfferId + +## -description +A unique ID used to identify a consumable in-app product within a large purchase catalog. + +## -property-value +The offer ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/unfulfilledconsumable_productid.md b/windows.applicationmodel.store/unfulfilledconsumable_productid.md index 5f72f18d13..f03e99fc41 100644 --- a/windows.applicationmodel.store/unfulfilledconsumable_productid.md +++ b/windows.applicationmodel.store/unfulfilledconsumable_productid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.UnfulfilledConsumable.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.Store.UnfulfilledConsumable.ProductId ## -description A unique ID used to identify a consumable in-app product. This ID is used by the app to get info about the product or feature that is enabled when the customer buys it through an in-app purchase. ## -property-value The product ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.UnfulfilledConsumable.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.UnfulfilledConsumable.ProductId + +## -description +A unique ID used to identify a consumable in-app product. This ID is used by the app to get info about the product or feature that is enabled when the customer buys it through an in-app purchase. + +## -property-value +The product ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.store/unfulfilledconsumable_transactionid.md b/windows.applicationmodel.store/unfulfilledconsumable_transactionid.md index 4008e56877..cacf9e54a5 100644 --- a/windows.applicationmodel.store/unfulfilledconsumable_transactionid.md +++ b/windows.applicationmodel.store/unfulfilledconsumable_transactionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Store.UnfulfilledConsumable.TransactionId --api-type: winrt property ---- # Windows.ApplicationModel.Store.UnfulfilledConsumable.TransactionId ## -description A unique ID used to identify the transaction that included the purchase of a consumable in-app product. ## -property-value The transaction ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Store.UnfulfilledConsumable.TransactionId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.UnfulfilledConsumable.TransactionId + +## -description +A unique ID used to identify the transaction that included the purchase of a consumable in-app product. + +## -property-value +The transaction ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/iuserdataaccountprovideroperation_kind.md b/windows.applicationmodel.userdataaccounts.provider/iuserdataaccountprovideroperation_kind.md index ef6f863626..975da55bb3 100644 --- a/windows.applicationmodel.userdataaccounts.provider/iuserdataaccountprovideroperation_kind.md +++ b/windows.applicationmodel.userdataaccounts.provider/iuserdataaccountprovideroperation_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.IUserDataAccountProviderOperation.Kind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.IUserDataAccountProviderOperation.Kind ## -description Gets the type of account operation, such as adding an account or updating settings. ## -property-value The type of account operation, such as adding an account or updating settings. ## -remarks A Universal Windows Platform (UWP) app displays UI appropriate to the requested operation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.IUserDataAccountProviderOperation.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.IUserDataAccountProviderOperation.Kind + +## -description +Gets the type of account operation, such as adding an account or updating settings. + +## -property-value +The type of account operation, such as adding an account or updating settings. + +## -remarks +A Universal Windows Platform (UWP) app displays UI appropriate to the requested operation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo.md index 45a85b64ae..1a0f893e7d 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo ## -description Represents data about an account for partner service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo + +## -description +Represents data about an account for partner service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_accountkind.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_accountkind.md index 45e8ef3751..67c607496d 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_accountkind.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_accountkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.AccountKind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.AccountKind ## -description Gets the type of this user account. ## -property-value The type of this user account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.AccountKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.AccountKind + +## -description +Gets the type of this user account. + +## -property-value +The type of this user account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_displayname.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_displayname.md index 64e0cef1bd..17d1621608 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_displayname.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.DisplayName ## -description Gets the human readable display name for this user account. ## -property-value The human readable display name for this user account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.DisplayName + +## -description +Gets the human readable display name for this user account. + +## -property-value +The human readable display name for this user account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_priority.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_priority.md index bb3ade7f5f..c01ff00140 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_priority.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountpartneraccountinfo_priority.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.Priority --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.Priority ## -description Gets the priority for the service that uses this kind of user account. ## -property-value The priority for the service that uses this kind of user account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.Priority +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountPartnerAccountInfo.Priority + +## -description +Gets the priority for the service that uses this kind of user account. + +## -property-value +The priority for the service that uses this kind of user account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation.md index cb7ef08655..cd4283b93a 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation ## -description Provides the data for adding a new user account. ## -remarks ## -examples ## -see-also [IUserDataAccountProviderOperation](iuserdataaccountprovideroperation.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation + +## -description +Provides the data for adding a new user account. + +## -remarks + +## -examples + +## -see-also +[IUserDataAccountProviderOperation](iuserdataaccountprovideroperation.md) \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_contentkinds.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_contentkinds.md index 85843d8f11..6a44d94903 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_contentkinds.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_contentkinds.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ContentKinds --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ContentKinds ## -description Gets the types of content supported by the user account, such as email, contacts, and appointments. ## -property-value The types of content supported by the user account, such as email, contacts, and appointments. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ContentKinds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ContentKinds + +## -description +Gets the types of content supported by the user account, such as email, contacts, and appointments. + +## -property-value +The types of content supported by the user account, such as email, contacts, and appointments. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_kind.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_kind.md index 25d8e7024e..944da63298 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_kind.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.Kind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.Kind ## -description Gets the type of this account operation. ## -property-value The type of this account operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.Kind + +## -description +Gets the type of this account operation. + +## -property-value +The type of this account operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_partneraccountinfos.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_partneraccountinfos.md index 4e69a56a86..e95f304fc6 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_partneraccountinfos.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_partneraccountinfos.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.PartnerAccountInfos --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.PartnerAccountInfos ## -description Gets a list of [UserDataAccountPartnerAccountInfo](userdataaccountpartneraccountinfo.md) objects for this operation. ## -property-value A list of [UserDataAccountPartnerAccountInfo](userdataaccountpartneraccountinfo.md) objects for this operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.PartnerAccountInfos +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.PartnerAccountInfos + +## -description +Gets a list of [UserDataAccountPartnerAccountInfo](userdataaccountpartneraccountinfo.md) objects for this operation. + +## -property-value +A list of [UserDataAccountPartnerAccountInfo](userdataaccountpartneraccountinfo.md) objects for this operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_reportcompleted_458863373.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_reportcompleted_458863373.md index 8f43a4588d..aa575b3242 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_reportcompleted_458863373.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovideraddaccountoperation_reportcompleted_458863373.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ReportCompleted(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ReportCompleted ## -description Reports back to the calling app that the operation is complete. ## -parameters ### -param userDataAccountId The identifier for the user account upon which the operation completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ReportCompleted(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderAddAccountOperation.ReportCompleted + +## -description +Reports back to the calling app that the operation is complete. + +## -parameters +### -param userDataAccountId +The identifier for the user account upon which the operation completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation.md index 30dfc03f56..3f70ad8ebd 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation ## -description Provides the data for a "resolve errors" account operation. ## -remarks The operating system invokes the "resolve errors" action on the app that set up the account. If no app was used to set up the account, then the operating system shows a dialog that asks the user to re-enter their password for the account and optionally change mail server configuration. ## -examples ## -see-also [IUserDataAccountProviderOperation](iuserdataaccountprovideroperation.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation + +## -description +Provides the data for a "resolve errors" account operation. + +## -remarks +The operating system invokes the "resolve errors" action on the app that set up the account. If no app was used to set up the account, then the operating system shows a dialog that asks the user to re-enter their password for the account and optionally change mail server configuration. + +## -examples + +## -see-also +[IUserDataAccountProviderOperation](iuserdataaccountprovideroperation.md) \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_kind.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_kind.md index a04ca1a409..d22c4dae33 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_kind.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.Kind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.Kind ## -description Gets the type of this account operation. ## -property-value The type of this account operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.Kind + +## -description +Gets the type of this account operation. + +## -property-value +The type of this account operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_reportcompleted_1121471021.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_reportcompleted_1121471021.md index 9d2f5a1786..36f1686dce 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_reportcompleted_1121471021.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_reportcompleted_1121471021.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.ReportCompleted --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.ReportCompleted ## -description Reports back to the calling app that the operation is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.ReportCompleted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.ReportCompleted + +## -description +Reports back to the calling app that the operation is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_userdataaccountid.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_userdataaccountid.md index a9e287dad3..46fc5f5893 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_userdataaccountid.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountproviderresolveerrorsoperation_userdataaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.UserDataAccountId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.UserDataAccountId ## -description Gets the user account ID for this "resolve errors" operation. ## -property-value The user account ID for this "resolve errors" operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderResolveErrorsOperation.UserDataAccountId + +## -description +Gets the user account ID for this "resolve errors" operation. + +## -property-value +The user account ID for this "resolve errors" operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation.md index bdeae673cd..153ac0e080 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation ## -description Provides the data for an account settings operation. ## -remarks The operating system invokes the settings action on the app that set up the account. If no app was used to set up the account, then the operating system shows a generic account settings dialog. ## -examples ## -see-also [IUserDataAccountProviderOperation](iuserdataaccountprovideroperation.md) \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation + +## -description +Provides the data for an account settings operation. + +## -remarks +The operating system invokes the settings action on the app that set up the account. If no app was used to set up the account, then the operating system shows a generic account settings dialog. + +## -examples + +## -see-also +[IUserDataAccountProviderOperation](iuserdataaccountprovideroperation.md) \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_kind.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_kind.md index 8768d381a3..65061bf78d 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_kind.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.Kind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.Kind ## -description Gets the type of this account operation. ## -property-value The type of this account operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.Kind + +## -description +Gets the type of this account operation. + +## -property-value +The type of this account operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_reportcompleted_1121471021.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_reportcompleted_1121471021.md index 90d5e3979d..f436223a58 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_reportcompleted_1121471021.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_reportcompleted_1121471021.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.ReportCompleted --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.ReportCompleted ## -description Reports back to the calling app that the operation is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.ReportCompleted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.ReportCompleted + +## -description +Reports back to the calling app that the operation is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_userdataaccountid.md b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_userdataaccountid.md index d097faeffc..a2267e3566 100644 --- a/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_userdataaccountid.md +++ b/windows.applicationmodel.userdataaccounts.provider/userdataaccountprovidersettingsoperation_userdataaccountid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.UserDataAccountId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.UserDataAccountId ## -description Gets the user account ID for this settings operation. ## -property-value The user account ID for this settings operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.Provider.UserDataAccountProviderSettingsOperation.UserDataAccountId + +## -description +Gets the user account ID for this settings operation. + +## -property-value +The user account ID for this settings operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration.md index cfe2e4b3df..103c597e45 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration ## -description Represents device settings for app sync relationships. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration + +## -description +Represents device settings for app sync relationships. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accounticonid.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accounticonid.md index ac65cec990..2bd43b1d18 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accounticonid.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accounticonid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountIconId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountIconId ## -description Gets or sets the identifier for the device account icon. ## -property-value The identifier for the device account icon. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountIconId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountIconId + +## -description +Gets or sets the identifier for the device account icon. + +## -property-value +The identifier for the device account icon. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accountname.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accountname.md index 8792e7f4b0..3805aed97e 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accountname.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_accountname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountName --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountName ## -description Gets or sets the name that identifies the device account. ## -property-value The name that identifies the device account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AccountName + +## -description +Gets or sets the name that identifies the device account. + +## -property-value +The name that identifies the device account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_alwaysdownloadfullmessage.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_alwaysdownloadfullmessage.md index e7f130e5f2..22ccb65062 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_alwaysdownloadfullmessage.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_alwaysdownloadfullmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AlwaysDownloadFullMessage --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AlwaysDownloadFullMessage ## -description Gets or sets a Boolean value indicating if the full email message should always be downloaded as opposed to only header information. ## -property-value A Boolean value indicating if the full email message should always be downloaded. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AlwaysDownloadFullMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AlwaysDownloadFullMessage + +## -description +Gets or sets a Boolean value indicating if the full email message should always be downloaded as opposed to only header information. + +## -property-value +A Boolean value indicating if the full email message should always be downloaded. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationcertificateid.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationcertificateid.md index e287765e7a..83937762f3 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationcertificateid.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationcertificateid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationCertificateId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationCertificateId ## -description Gets or sets the identifier for the authentication certificate for this account. ## -property-value The identifier for the authentication certificate for this account. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationCertificateId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationCertificateId + +## -description +Gets or sets the identifier for the authentication certificate for this account. + +## -property-value +The identifier for the authentication certificate for this account. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationtype.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationtype.md index d09024f66c..a9650f1214 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationtype.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_authenticationtype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationType --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationType ## -description Gets or sets the [DeviceAccountAuthenticationType](deviceaccountauthenticationtype.md) for this account. ## -property-value The [DeviceAccountAuthenticationType](deviceaccountauthenticationtype.md) for this account. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AuthenticationType + +## -description +Gets or sets the [DeviceAccountAuthenticationType](deviceaccountauthenticationtype.md) for this account. + +## -property-value +The [DeviceAccountAuthenticationType](deviceaccountauthenticationtype.md) for this account. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_autoselectauthenticationcertificate.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_autoselectauthenticationcertificate.md index 2e8410f83c..d13cd724c7 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_autoselectauthenticationcertificate.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_autoselectauthenticationcertificate.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AutoSelectAuthenticationCertificate --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AutoSelectAuthenticationCertificate ## -description Gets or sets a Boolean value that indicates if the authentication certificate should be automatically selected. ## -property-value A Boolean value that indicates if the authentication certificate should be automatically selected. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AutoSelectAuthenticationCertificate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.AutoSelectAuthenticationCertificate + +## -description +Gets or sets a Boolean value that indicates if the authentication certificate should be automatically selected. + +## -property-value +A Boolean value that indicates if the authentication certificate should be automatically selected. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavrequiresssl.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavrequiresssl.md index bbcdaa4dfd..9a3dadafbd 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavrequiresssl.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavrequiresssl.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavRequiresSsl --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavRequiresSsl ## -description Gets or sets a Boolean value that indicates if the CalDav server requires an SSL connection. ## -property-value A Boolean value that indicates if the CalDav server requires an SSL connection. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavRequiresSsl +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavRequiresSsl + +## -description +Gets or sets a Boolean value that indicates if the CalDav server requires an SSL connection. + +## -property-value +A Boolean value that indicates if the CalDav server requires an SSL connection. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavserverurl.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavserverurl.md index 36c450c78f..c20360ed6c 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavserverurl.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavserverurl.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavServerUrl --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavServerUrl ## -description Gets or sets the address of the CalDav server. ## -property-value The address of the CalDav server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavServerUrl +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavServerUrl + +## -description +Gets or sets the address of the CalDav server. + +## -property-value +The address of the CalDav server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavsyncschedulekind.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavsyncschedulekind.md index aef7b659de..79c9b78631 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavsyncschedulekind.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_caldavsyncschedulekind.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavSyncScheduleKind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavSyncScheduleKind ## -description Gets or sets an enum value that specifies how often the account is synced. ## -property-value An enum value that specifies how often the account is synced. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavSyncScheduleKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalDavSyncScheduleKind + +## -description +Gets or sets an enum value that specifies how often the account is synced. + +## -property-value +An enum value that specifies how often the account is synced. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_calendarsyncenabled.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_calendarsyncenabled.md index e42f74f813..530b2e9b21 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_calendarsyncenabled.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_calendarsyncenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalendarSyncEnabled --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalendarSyncEnabled ## -description Gets or sets a Boolean value indicating if calendar syncing is enabled. ## -property-value A Boolean value indicating if calendar syncing is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalendarSyncEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CalendarSyncEnabled + +## -description +Gets or sets a Boolean value indicating if calendar syncing is enabled. + +## -property-value +A Boolean value indicating if calendar syncing is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavrequiresssl.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavrequiresssl.md index d896753985..7e7e1b07c6 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavrequiresssl.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavrequiresssl.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavRequiresSsl --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavRequiresSsl ## -description Gets or sets a Boolean value that indicates if the CardDav server requires an SSL connection. ## -property-value A Boolean value that indicates if the CardDav server requires an SSL connection. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavRequiresSsl +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavRequiresSsl + +## -description +Gets or sets a Boolean value that indicates if the CardDav server requires an SSL connection. + +## -property-value +A Boolean value that indicates if the CardDav server requires an SSL connection. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavserverurl.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavserverurl.md index 2abd4b325b..f48274b7d7 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavserverurl.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavserverurl.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavServerUrl --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavServerUrl ## -description Gets or sets the address of the CardDav server. ## -property-value The address of the CardDav server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavServerUrl +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavServerUrl + +## -description +Gets or sets the address of the CardDav server. + +## -property-value +The address of the CardDav server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavsyncschedulekind.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavsyncschedulekind.md index 968282d968..8d9a9d01de 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavsyncschedulekind.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_carddavsyncschedulekind.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavSyncScheduleKind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavSyncScheduleKind ## -description Gets or sets an enum value that specifies how often the account is synced. ## -property-value An enum value that specifies how often the account is synced. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavSyncScheduleKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.CardDavSyncScheduleKind + +## -description +Gets or sets an enum value that specifies how often the account is synced. + +## -property-value +An enum value that specifies how often the account is synced. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_contactssyncenabled.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_contactssyncenabled.md index 42006c0f7d..a0fc4a16d7 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_contactssyncenabled.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_contactssyncenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ContactsSyncEnabled --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ContactsSyncEnabled ## -description Gets or sets a Boolean value indicating if contacts syncing is enabled. ## -property-value A Boolean value indicating if contacts syncing is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ContactsSyncEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ContactsSyncEnabled + +## -description +Gets or sets a Boolean value indicating if contacts syncing is enabled. + +## -property-value +A Boolean value indicating if contacts syncing is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccountconfiguration_1221375020.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccountconfiguration_1221375020.md index 2151943141..3d7a72e065 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccountconfiguration_1221375020.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccountconfiguration_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DeviceAccountConfiguration ## -description Initializes a new instance of the [DeviceAccountConfiguration](deviceaccountconfiguration.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DeviceAccountConfiguration + +## -description +Initializes a new instance of the [DeviceAccountConfiguration](deviceaccountconfiguration.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccounttypeid.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccounttypeid.md index 97ca7f6b2f..1d80cd6e54 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccounttypeid.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_deviceaccounttypeid.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DeviceAccountTypeId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DeviceAccountTypeId ## -description Gets or sets the value that identifies the device account type. ## -property-value The value that identifies the device account type. ## -remarks Valid values for this property are:
Account typeID
Exchange Active Sync6833942B-ABDA-4C20-9757-4F9252396BD4
Google via Exchange Active SyncE288529A-1917-4985-897F-34D8121EBFC3
Internet Mail (Pop/IMAP)DC23EAD7-BBF2-44D7-A791-6B2B7580F0C2
Google via IMAP/CardDAV/CalDAV0A95CDAA-C7EB-4133-9793-75E13089F082
iCloud via IMAP/CardDAV/CalDAV45157403-77C9-4E68-9485-6DD9A79D534A
Other values may be added in the future, so you should have a default case to handle unknown values. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DeviceAccountTypeId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DeviceAccountTypeId + +## -description +Gets or sets the value that identifies the device account type. + +## -property-value +The value that identifies the device account type. + +## -remarks +Valid values for this property are: + + + + + + + + +
Account typeID
Exchange Active Sync6833942B-ABDA-4C20-9757-4F9252396BD4
Google via Exchange Active SyncE288529A-1917-4985-897F-34D8121EBFC3
Internet Mail (Pop/IMAP)DC23EAD7-BBF2-44D7-A791-6B2B7580F0C2
Google via IMAP/CardDAV/CalDAV0A95CDAA-C7EB-4133-9793-75E13089F082
iCloud via IMAP/CardDAV/CalDAV45157403-77C9-4E68-9485-6DD9A79D534A
+ +Other values may be added in the future, so you should have a default case to handle unknown values. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_doespolicyallowmailsync.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_doespolicyallowmailsync.md index c860fe2a06..50420cfbf7 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_doespolicyallowmailsync.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_doespolicyallowmailsync.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DoesPolicyAllowMailSync --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DoesPolicyAllowMailSync ## -description Gets a Boolean value that indicates if this device is allowed to sync with the email server. ## -property-value A Boolean value that indicates if this device is allowed to sync with the email server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DoesPolicyAllowMailSync +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.DoesPolicyAllowMailSync + +## -description +Gets a Boolean value that indicates if this device is allowed to sync with the email server. + +## -property-value +A Boolean value that indicates if this device is allowed to sync with the email server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_domain.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_domain.md index c8df0be690..aec946225e 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_domain.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_domain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.Domain --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.Domain ## -description Gets or sets the network domain of the device. ## -property-value The network domain of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.Domain +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.Domain + +## -description +Gets or sets the network domain of the device. + +## -property-value +The network domain of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailaddress.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailaddress.md index a6d97f98a6..51eb350b4b 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailaddress.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailAddress --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailAddress ## -description Gets or sets the email address of the current user. ## -property-value The email address of the current user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailAddress + +## -description +Gets or sets the email address of the current user. + +## -property-value +The email address of the current user. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailsyncenabled.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailsyncenabled.md index bc676e65ec..03f613fd75 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailsyncenabled.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_emailsyncenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailSyncEnabled --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailSyncEnabled ## -description Gets or sets a Boolean value indicating if email syncing is enabled. ## -property-value A Boolean value indicating if email syncing is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailSyncEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.EmailSyncEnabled + +## -description +Gets or sets a Boolean value indicating if email syncing is enabled. + +## -property-value +A Boolean value indicating if email syncing is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserveraddress.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserveraddress.md index ce239d9a0b..fcc3d08017 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserveraddress.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserveraddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerAddress --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerAddress ## -description Gets or sets the incoming email server address. ## -property-value The incoming email server address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerAddress + +## -description +Gets or sets the incoming email server address. + +## -property-value +The incoming email server address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercertificatehash.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercertificatehash.md index 5f64741e17..5584f58481 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercertificatehash.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercertificatehash.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCertificateHash --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCertificateHash ## -description Gets or sets the incoming mail server's encryption certificate hash. ## -property-value The incoming mail server's encryption certificate hash. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCertificateHash +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCertificateHash + +## -description +Gets or sets the incoming mail server's encryption certificate hash. + +## -property-value +The incoming mail server's encryption certificate hash. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercredential.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercredential.md index 56d3620e8c..283f5d927d 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercredential.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingservercredential.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCredential --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCredential ## -description Gets or sets the incoming mail server's password. ## -property-value The incoming mail server's password. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCredential +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerCredential + +## -description +Gets or sets the incoming mail server's password. + +## -property-value +The incoming mail server's password. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverport.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverport.md index 48e0450064..4a3dba0ea4 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverport.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerPort --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerPort ## -description Gets or sets the port number to use to connect to the incoming email server. ## -property-value The port number to use to connect to the incoming email server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerPort +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerPort + +## -description +Gets or sets the port number to use to connect to the incoming email server. + +## -property-value +The port number to use to connect to the incoming email server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverrequiresssl.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverrequiresssl.md index 794e3db24f..768d451b51 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverrequiresssl.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverrequiresssl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerRequiresSsl --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerRequiresSsl ## -description Gets or sets a Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the incoming email server. ## -property-value A Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the incoming email server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerRequiresSsl +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerRequiresSsl + +## -description +Gets or sets a Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the incoming email server. + +## -property-value +A Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the incoming email server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverusername.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverusername.md index c4bd564f45..d8bfc34d75 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverusername.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_incomingserverusername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerUsername --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerUsername ## -description Gets or sets the username to use when connecting to the incoming email server. ## -property-value The username to use when connecting to the incoming email server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerUsername +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IncomingServerUsername + +## -description +Gets or sets the username to use when connecting to the incoming email server. + +## -property-value +The username to use when connecting to the incoming email server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isclientauthenticationcertificaterequired.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isclientauthenticationcertificaterequired.md index dc68266252..1e2b021181 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isclientauthenticationcertificaterequired.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isclientauthenticationcertificaterequired.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsClientAuthenticationCertificateRequired --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsClientAuthenticationCertificateRequired ## -description Gets or sets a Boolean value indicating if a client authentication certificate is required by the server. ## -property-value A Boolean value indicating if a client authentication certificate is required by the server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsClientAuthenticationCertificateRequired +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsClientAuthenticationCertificateRequired + +## -description +Gets or sets a Boolean value indicating if a client authentication certificate is required by the server. + +## -property-value +A Boolean value indicating if a client authentication certificate is required by the server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isexternallymanaged.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isexternallymanaged.md index b1d51b0a3e..76f1cb7d1d 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isexternallymanaged.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isexternallymanaged.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsExternallyManaged --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsExternallyManaged ## -description Gets or sets a Boolean value that indicates if the device account is managed outside the organization. ## -property-value A Boolean value that indicates if the device account is managed outside the organization. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsExternallyManaged +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsExternallyManaged + +## -description +Gets or sets a Boolean value that indicates if the device account is managed outside the organization. + +## -property-value +A Boolean value that indicates if the device account is managed outside the organization. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationenabled.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationenabled.md index c7e3c8198b..c8868710c2 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationenabled.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationenabled.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationEnabled --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationEnabled ## -description Gets or sets a Boolean value indicating if authentication is enabled for the outgoing mail server. ## -property-value A Boolean value indicating if authentication is enabled for the outgoing mail server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationEnabled + +## -description +Gets or sets a Boolean value indicating if authentication is enabled for the outgoing mail server. + +## -property-value +A Boolean value indicating if authentication is enabled for the outgoing mail server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationrequired.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationrequired.md index bed14d61de..f3a6dbbbec 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationrequired.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isoutgoingserverauthenticationrequired.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationRequired --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationRequired ## -description Gets or sets a Boolean value indicating if authentication is required by the outgoing mail server. ## -property-value A Boolean value indicating if authentication is required by the outgoing mail server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationRequired +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsOutgoingServerAuthenticationRequired + +## -description +Gets or sets a Boolean value indicating if authentication is required by the outgoing mail server. + +## -property-value +A Boolean value indicating if authentication is required by the outgoing mail server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isssoauthenticationsupported.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isssoauthenticationsupported.md index 2d1fa0bfd3..6949696218 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isssoauthenticationsupported.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_isssoauthenticationsupported.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSsoAuthenticationSupported --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSsoAuthenticationSupported ## -description Gets or sets a Boolean value indicating if single sign on (SSO) authentication is supported by the server. ## -property-value A Boolean value indicating if single sign on (SSO) authentication is supported by the server. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSsoAuthenticationSupported +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSsoAuthenticationSupported + +## -description +Gets or sets a Boolean value indicating if single sign on (SSO) authentication is supported by the server. + +## -property-value +A Boolean value indicating if single sign on (SSO) authentication is supported by the server. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_issyncschedulemanagedbysystem.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_issyncschedulemanagedbysystem.md index c45dcfd3c4..a469091534 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_issyncschedulemanagedbysystem.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_issyncschedulemanagedbysystem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSyncScheduleManagedBySystem --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSyncScheduleManagedBySystem ## -description Gets a Boolean value that indicates if the sync schedule is managed by the system as opposed to the app. ## -property-value A Boolean value that indicates if the sync schedule is managed by the system as opposed to the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSyncScheduleManagedBySystem +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.IsSyncScheduleManagedBySystem + +## -description +Gets a Boolean value that indicates if the sync schedule is managed by the system as opposed to the app. + +## -property-value +A Boolean value that indicates if the sync schedule is managed by the system as opposed to the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_mailagefilter.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_mailagefilter.md index bdbaa57fd5..95510b00ec 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_mailagefilter.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_mailagefilter.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.MailAgeFilter --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.MailAgeFilter ## -description Gets or sets an enum value that indicates how many days of email to keep on the client. ## -property-value An enum value that indicates how many days of email to keep on the client. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.MailAgeFilter +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.MailAgeFilter + +## -description +Gets or sets an enum value that indicates how many days of email to keep on the client. + +## -property-value +An enum value that indicates how many days of email to keep on the client. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_oauthrefreshtoken.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_oauthrefreshtoken.md index 60b4e5b51d..1b7ae47a72 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_oauthrefreshtoken.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_oauthrefreshtoken.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OAuthRefreshToken --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OAuthRefreshToken ## -description Gets or sets the OAuth refresh token used to create a new access token. ## -property-value The OAuth refresh token used to create a new access token. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OAuthRefreshToken +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OAuthRefreshToken + +## -description +Gets or sets the OAuth refresh token used to create a new access token. + +## -property-value +The OAuth refresh token used to create a new access token. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserveraddress.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserveraddress.md index 0eeb4f7132..450907e79d 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserveraddress.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserveraddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerAddress --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerAddress ## -description Gets or sets the outgoing email server address. ## -property-value The outgoing email server address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerAddress + +## -description +Gets or sets the outgoing email server address. + +## -property-value +The outgoing email server address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercertificatehash.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercertificatehash.md index d1d7a6076e..ff62a7fa9a 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercertificatehash.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercertificatehash.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCertificateHash --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCertificateHash ## -description Gets or sets the outgoing mail server's encryption certificate hash. ## -property-value The outgoing mail server's encryption certificate hash. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCertificateHash +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCertificateHash + +## -description +Gets or sets the outgoing mail server's encryption certificate hash. + +## -property-value +The outgoing mail server's encryption certificate hash. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercredential.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercredential.md index 2604302c9c..e48adcc03b 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercredential.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingservercredential.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCredential --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCredential ## -description Gets or sets the outgoing mail server's password. ## -property-value The outgoing mail server's password. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCredential +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerCredential + +## -description +Gets or sets the outgoing mail server's password. + +## -property-value +The outgoing mail server's password. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverport.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverport.md index 376fb73ff7..9df84d4a1f 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverport.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerPort --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerPort ## -description Gets or sets the port number to use to connect to the outgoing email server. ## -property-value The port number to use to connect to the outgoing email server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerPort +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerPort + +## -description +Gets or sets the port number to use to connect to the outgoing email server. + +## -property-value +The port number to use to connect to the outgoing email server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverrequiresssl.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverrequiresssl.md index d786957331..e31aac4ca1 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverrequiresssl.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverrequiresssl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerRequiresSsl --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerRequiresSsl ## -description Gets or sets a Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the outgoing email server. ## -property-value A Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the outgoing email server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerRequiresSsl +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerRequiresSsl + +## -description +Gets or sets a Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the outgoing email server. + +## -property-value +A Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the outgoing email server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverusername.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverusername.md index 6b4a5d5a09..74dc9ccc57 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverusername.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_outgoingserverusername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerUsername --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerUsername ## -description Gets or sets the username to use when connecting to the outgoing email server. ## -property-value The username to use when connecting to the outgoing email server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerUsername +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.OutgoingServerUsername + +## -description +Gets or sets the username to use when connecting to the outgoing email server. + +## -property-value +The username to use when connecting to the outgoing email server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_servertype.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_servertype.md index b15fa03302..effe90d6c2 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_servertype.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_servertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ServerType --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ServerType ## -description Gets or sets a value indicating the type of the server. ## -property-value Enum value indicating the type of the server. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ServerType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.ServerType + +## -description +Gets or sets a value indicating the type of the server. + +## -property-value +Enum value indicating the type of the server. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_ssoaccountid.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_ssoaccountid.md index 8e7b43e4f0..2b016e4418 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_ssoaccountid.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_ssoaccountid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SsoAccountId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SsoAccountId ## -description Gets or sets the single sign on account ID. ## -property-value The single sign on account ID. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SsoAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SsoAccountId + +## -description +Gets or sets the single sign on account ID. + +## -property-value +The single sign on account ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_syncschedulekind.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_syncschedulekind.md index 15db33097d..4d7904bc88 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_syncschedulekind.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_syncschedulekind.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SyncScheduleKind --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SyncScheduleKind ## -description Gets or sets an enum value that specifies how often the account is synced. ## -property-value An enum value that specifies how often the account is synced. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SyncScheduleKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.SyncScheduleKind + +## -description +Gets or sets an enum value that specifies how often the account is synced. + +## -property-value +An enum value that specifies how often the account is synced. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasincomingservercertificatehashconfirmed.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasincomingservercertificatehashconfirmed.md index 36f2b1ee24..5de1467f06 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasincomingservercertificatehashconfirmed.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasincomingservercertificatehashconfirmed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasIncomingServerCertificateHashConfirmed --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasIncomingServerCertificateHashConfirmed ## -description Gets or sets a Boolean value indicating if the incoming server's certificate hash has been confirmed. ## -property-value A Boolean value indicating if the incoming server's certificate hash has been confirmed. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasIncomingServerCertificateHashConfirmed +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasIncomingServerCertificateHashConfirmed + +## -description +Gets or sets a Boolean value indicating if the incoming server's certificate hash has been confirmed. + +## -property-value +A Boolean value indicating if the incoming server's certificate hash has been confirmed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasmodifiedbyuser.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasmodifiedbyuser.md index de9f4211ad..fe82ff8328 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasmodifiedbyuser.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasmodifiedbyuser.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasModifiedByUser --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasModifiedByUser ## -description Gets or sets a Boolean value that indicates if the account has been modified by the user. ## -property-value A Boolean value that indicates if the account has been modified by the user. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasModifiedByUser +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasModifiedByUser + +## -description +Gets or sets a Boolean value that indicates if the account has been modified by the user. + +## -property-value +A Boolean value that indicates if the account has been modified by the user. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasoutgoingservercertificatehashconfirmed.md b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasoutgoingservercertificatehashconfirmed.md index 91eb3805e9..c9521499ad 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasoutgoingservercertificatehashconfirmed.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/deviceaccountconfiguration_wasoutgoingservercertificatehashconfirmed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasOutgoingServerCertificateHashConfirmed --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasOutgoingServerCertificateHashConfirmed ## -description Gets or sets a Boolean value indicating if the outgoing server's certificate hash has been confirmed. ## -property-value A Boolean value indicating if the outgoing server's certificate hash has been confirmed. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasOutgoingServerCertificateHashConfirmed +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration.WasOutgoingServerCertificateHashConfirmed + +## -description +Gets or sets a Boolean value indicating if the outgoing server's certificate hash has been confirmed. + +## -property-value +A Boolean value indicating if the outgoing server's certificate hash has been confirmed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager.md b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager.md index f72a09f146..2b6108b97b 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager ## -description Provides the ability to display the system UI for managing sync relationships. ## -remarks This is a static class. ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager + +## -description +Provides the ability to display the system UI for managing sync relationships. + +## -remarks +This is a static class. + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_addandshowdeviceaccountsasync_1370447480.md b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_addandshowdeviceaccountsasync_1370447480.md index e8e071d0c8..7f24d314f0 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_addandshowdeviceaccountsasync_1370447480.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_addandshowdeviceaccountsasync_1370447480.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.AddAndShowDeviceAccountsAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration}) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.AddAndShowDeviceAccountsAsync ## -description Asynchronously displays the system UI to manage the sync relationships for the specified accounts. ## -parameters ### -param accounts The list of accounts to manage in the system UI. ## -returns Returns an updated list of accounts. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.AddAndShowDeviceAccountsAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.AddAndShowDeviceAccountsAsync + +## -description +Asynchronously displays the system UI to manage the sync relationships for the specified accounts. + +## -parameters +### -param accounts +The list of accounts to manage in the system UI. + +## -returns +Returns an updated list of accounts. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_createdeviceaccountasync_1997035612.md b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_createdeviceaccountasync_1997035612.md index eb6ef48293..e4c656c433 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_createdeviceaccountasync_1997035612.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_createdeviceaccountasync_1997035612.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.CreateDeviceAccountAsync(Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.CreateDeviceAccountAsync ## -description Asynchronously creates a device account using the specified [DeviceAccountConfiguration](deviceaccountconfiguration.md). ## -parameters ### -param account The configuration to use when creating the account. ## -returns Returns a string with the newly created device account ID. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.CreateDeviceAccountAsync(Windows.ApplicationModel.UserDataAccounts.SystemAccess.DeviceAccountConfiguration) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.CreateDeviceAccountAsync + +## -description +Asynchronously creates a device account using the specified [DeviceAccountConfiguration](deviceaccountconfiguration.md). + +## -parameters +### -param account +The configuration to use when creating the account. + +## -returns +Returns a string with the newly created device account ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_deletedeviceaccountasync_206729051.md b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_deletedeviceaccountasync_206729051.md index be50d4caeb..88021aeea5 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_deletedeviceaccountasync_206729051.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_deletedeviceaccountasync_206729051.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.DeleteDeviceAccountAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.DeleteDeviceAccountAsync ## -description Asynchronously deletes the specified device account. ## -parameters ### -param accountId The ID of the device account to delete. ## -returns Returns an async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.DeleteDeviceAccountAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.DeleteDeviceAccountAsync + +## -description +Asynchronously deletes the specified device account. + +## -parameters +### -param accountId +The ID of the device account to delete. + +## -returns +Returns an async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_getdeviceaccountconfigurationasync_175993005.md b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_getdeviceaccountconfigurationasync_175993005.md index cc294b7d79..80493686dd 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_getdeviceaccountconfigurationasync_175993005.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_getdeviceaccountconfigurationasync_175993005.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.GetDeviceAccountConfigurationAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.GetDeviceAccountConfigurationAsync ## -description Asynchronously gets the [DeviceAccountConfiguration](deviceaccountconfiguration.md) for the specified device account. ## -parameters ### -param accountId The ID for the device account. ## -returns Reutrns the [DeviceAccountConfiguration](deviceaccountconfiguration.md) for the device account specified by the *accountId* parameter. ## -remarks ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.GetDeviceAccountConfigurationAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.GetDeviceAccountConfigurationAsync + +## -description +Asynchronously gets the [DeviceAccountConfiguration](deviceaccountconfiguration.md) for the specified device account. + +## -parameters +### -param accountId +The ID for the device account. + +## -returns +Reutrns the [DeviceAccountConfiguration](deviceaccountconfiguration.md) for the device account specified by the *accountId* parameter. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_suppresslocalaccountwithaccountasync_134392621.md b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_suppresslocalaccountwithaccountasync_134392621.md index 21fd79cf51..b0fc0e3b4d 100644 --- a/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_suppresslocalaccountwithaccountasync_134392621.md +++ b/windows.applicationmodel.userdataaccounts.systemaccess/userdataaccountsystemaccessmanager_suppresslocalaccountwithaccountasync_134392621.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.SuppressLocalAccountWithAccountAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.SuppressLocalAccountWithAccountAsync ## -description Asynchronously, and temporarily, replaces the default local account by using the specified account. ## -parameters ### -param userDataAccountId The user ID of the account used to temporarily replace the default local account. ## -returns Returns an async action indicating that the operation has completed. ## -remarks The default local account is suppressed while the new account, referenced by *userDataAccountId*, is present on the device. When that new account is deleted, the local account pops back into the system. ## -examples ## -see-also ## -capabilities userDataAccountsProvider \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.SuppressLocalAccountWithAccountAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.SystemAccess.UserDataAccountSystemAccessManager.SuppressLocalAccountWithAccountAsync + +## -description +Asynchronously, and temporarily, replaces the default local account by using the specified account. + +## -parameters +### -param userDataAccountId +The user ID of the account used to temporarily replace the default local account. + +## -returns +Returns an async action indicating that the operation has completed. + +## -remarks +The default local account is suppressed while the new account, referenced by *userDataAccountId*, is present on the device. When that new account is deleted, the local account pops back into the system. + +## -examples + +## -see-also + + +## -capabilities +userDataAccountsProvider \ No newline at end of file diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount.md b/windows.applicationmodel.userdataaccounts/userdataaccount.md index 0619727987..67a6efc932 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccount --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount ## -description Represents a user data account used to access email, contacts, calendars, and so on. ## -remarks Call [UserDataAccountStore.GetAccountAsync](userdataaccountstore_getaccountasync.md) to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccount +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount + +## -description +Represents a user data account used to access email, contacts, calendars, and so on. + +## -remarks +Call [UserDataAccountStore.GetAccountAsync](userdataaccountstore_getaccountasync.md) to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_deleteasync_1247887881.md b/windows.applicationmodel.userdataaccounts/userdataaccount_deleteasync_1247887881.md index 1f42139537..26c232c665 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_deleteasync_1247887881.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_deleteasync_1247887881.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeleteAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeleteAsync ## -description Asynchronously deletes all the contact, calendar and email data associated with the account. ## -returns An async action indicating success or failure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeleteAsync + +## -description +Asynchronously deletes all the contact, calendar and email data associated with the account. + +## -returns +An async action indicating success or failure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_deviceaccounttypeid.md b/windows.applicationmodel.userdataaccounts/userdataaccount_deviceaccounttypeid.md index cd173f237a..eeb0a3ef15 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_deviceaccounttypeid.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_deviceaccounttypeid.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeviceAccountTypeId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeviceAccountTypeId ## -description Gets the unique identifier for the type of the account. ## -property-value The unique identifier for the type of the account such as Exchange, Google, Pop/IMAP and so on. ## -remarks Valid values for this property are:
Account typeID
Exchange Active Sync6833942B-ABDA-4C20-9757-4F9252396BD4
Google via Exchange Active SyncE288529A-1917-4985-897F-34D8121EBFC3
Internet Mail (Pop/IMAP)DC23EAD7-BBF2-44D7-A791-6B2B7580F0C2
Google via IMAP/CardDAV/CalDAV0A95CDAA-C7EB-4133-9793-75E13089F082
iCloud via IMAP/CardDAV/CalDAV45157403-77C9-4E68-9485-6DD9A79D534A
Other values may be added in the future, so you should have a default case to handle unknown values. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeviceAccountTypeId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DeviceAccountTypeId + +## -description +Gets the unique identifier for the type of the account. + +## -property-value +The unique identifier for the type of the account such as Exchange, Google, Pop/IMAP and so on. + +## -remarks +Valid values for this property are: + + + + + + + + +
Account typeID
Exchange Active Sync6833942B-ABDA-4C20-9757-4F9252396BD4
Google via Exchange Active SyncE288529A-1917-4985-897F-34D8121EBFC3
Internet Mail (Pop/IMAP)DC23EAD7-BBF2-44D7-A791-6B2B7580F0C2
Google via IMAP/CardDAV/CalDAV0A95CDAA-C7EB-4133-9793-75E13089F082
iCloud via IMAP/CardDAV/CalDAV45157403-77C9-4E68-9485-6DD9A79D534A
+ +Other values may be added in the future, so you should have a default case to handle unknown values. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_displayname.md b/windows.applicationmodel.userdataaccounts/userdataaccount_displayname.md index 29211c7957..aefa57e91a 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_displayname.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DisplayName ## -description Gets or sets the human readable display name for the user data account. ## -property-value The human readable display name for the user data account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.DisplayName + +## -description +Gets or sets the human readable display name for the user data account. + +## -property-value +The human readable display name for the user data account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_enterpriseid.md b/windows.applicationmodel.userdataaccounts/userdataaccount_enterpriseid.md index 14d7d7dc3b..7808953a85 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_enterpriseid.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_enterpriseid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.EnterpriseId --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.EnterpriseId ## -description Gets the enterprise identity associated with the user account. ## -property-value The enterprise identity associated with the user account. ## -remarks The [EnterpriseId](userdataaccount_enterpriseid.md) is often a corporate email address and is used when encrypting or decrypting corporate data. > [!IMPORTANT] > If the [EnterpriseId](userdataaccount_enterpriseid.md) is **null** or empty then the account is not enterprise protected. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.EnterpriseId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.EnterpriseId + +## -description +Gets the enterprise identity associated with the user account. + +## -property-value +The enterprise identity associated with the user account. + +## -remarks +The [EnterpriseId](userdataaccount_enterpriseid.md) is often a corporate email address and is used when encrypting or decrypting corporate data. + +> [!IMPORTANT] +> If the [EnterpriseId](userdataaccount_enterpriseid.md) is **null** or empty then the account is not enterprise protected. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_explictreadaccesspackagefamilynames.md b/windows.applicationmodel.userdataaccounts/userdataaccount_explictreadaccesspackagefamilynames.md index 42e6d60282..165b8b3cd4 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_explictreadaccesspackagefamilynames.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_explictreadaccesspackagefamilynames.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.ExplictReadAccessPackageFamilyNames --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.ExplictReadAccessPackageFamilyNames ## -description Gets a list of package family names for apps that have explicit read access even if they don't have the system capability. ## -property-value A list of package family names for apps that have explicit read access even if they don't have the system capability. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.ExplictReadAccessPackageFamilyNames +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.ExplictReadAccessPackageFamilyNames + +## -description +Gets a list of package family names for apps that have explicit read access even if they don't have the system capability. + +## -property-value +A list of package family names for apps that have explicit read access even if they don't have the system capability. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_findappointmentcalendarsasync_336289890.md b/windows.applicationmodel.userdataaccounts/userdataaccount_findappointmentcalendarsasync_336289890.md index 8591591d61..f679c6d9d4 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_findappointmentcalendarsasync_336289890.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_findappointmentcalendarsasync_336289890.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindAppointmentCalendarsAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindAppointmentCalendarsAsync ## -description Returns a collection of [AppointmentCalendar](../windows.applicationmodel.appointments/appointmentcalendar.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -returns A collection of [AppointmentCalendar](../windows.applicationmodel.appointments/appointmentcalendar.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindAppointmentCalendarsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindAppointmentCalendarsAsync + +## -description +Returns a collection of [AppointmentCalendar](../windows.applicationmodel.appointments/appointmentcalendar.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -returns +A collection of [AppointmentCalendar](../windows.applicationmodel.appointments/appointmentcalendar.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactannotationlistsasync_964118964.md b/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactannotationlistsasync_964118964.md index 3829dfaa9b..f7e1651c63 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactannotationlistsasync_964118964.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactannotationlistsasync_964118964.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactAnnotationListsAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactAnnotationListsAsync ## -description Returns a collection of [ContactAnnotationList](../windows.applicationmodel.contacts/contactannotationlist.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -returns A collection of [ContactAnnotationList](../windows.applicationmodel.contacts/contactannotationlist.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactAnnotationListsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactAnnotationListsAsync + +## -description +Returns a collection of [ContactAnnotationList](../windows.applicationmodel.contacts/contactannotationlist.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -returns +A collection of [ContactAnnotationList](../windows.applicationmodel.contacts/contactannotationlist.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactlistsasync_2053274900.md b/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactlistsasync_2053274900.md index 9606addd75..31e36010bd 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactlistsasync_2053274900.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactlistsasync_2053274900.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactListsAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactListsAsync ## -description Returns a collection of [ContactList](../windows.applicationmodel.contacts/contactlist.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -returns A collection of [ContactList](../windows.applicationmodel.contacts/contactlist.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactListsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactListsAsync + +## -description +Returns a collection of [ContactList](../windows.applicationmodel.contacts/contactlist.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -returns +A collection of [ContactList](../windows.applicationmodel.contacts/contactlist.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_findemailmailboxesasync_361299551.md b/windows.applicationmodel.userdataaccounts/userdataaccount_findemailmailboxesasync_361299551.md index 7db05679bd..f0d82a939c 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_findemailmailboxesasync_361299551.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_findemailmailboxesasync_361299551.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindEmailMailboxesAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindEmailMailboxesAsync ## -description Returns a collection of [EmailMailbox](../windows.applicationmodel.email/emailmailbox.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -returns A collection of [EmailMailbox](../windows.applicationmodel.email/emailmailbox.md) instances associated with the [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindEmailMailboxesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindEmailMailboxesAsync + +## -description +Returns a collection of [EmailMailbox](../windows.applicationmodel.email/emailmailbox.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -returns +A collection of [EmailMailbox](../windows.applicationmodel.email/emailmailbox.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_icon.md b/windows.applicationmodel.userdataaccounts/userdataaccount_icon.md index 31abeabcae..12518a382d 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_icon.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_icon.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Icon --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Icon ## -description Gets the icon associated with the [UserDataAccount](userdataaccount.md). ## -property-value The icon associated with the [UserDataAccount](userdataaccount.md). ## -remarks This property is only valid for device user data accounts. It will return **null** for app user data accounts. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Icon +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Icon + +## -description +Gets the icon associated with the [UserDataAccount](userdataaccount.md). + +## -property-value +The icon associated with the [UserDataAccount](userdataaccount.md). + +## -remarks +This property is only valid for device user data accounts. It will return **null** for app user data accounts. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_id.md b/windows.applicationmodel.userdataaccounts/userdataaccount_id.md index a230a36fb1..85b27861df 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_id.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Id --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Id ## -description Gets a string that uniquely identifies the [UserDataAccount](userdataaccount.md) on the local device. ## -property-value A string that uniquely identifies the [UserDataAccount](userdataaccount.md) on the local device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.Id + +## -description +Gets a string that uniquely identifies the [UserDataAccount](userdataaccount.md) on the local device. + +## -property-value +A string that uniquely identifies the [UserDataAccount](userdataaccount.md) on the local device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_isprotectedunderlock.md b/windows.applicationmodel.userdataaccounts/userdataaccount_isprotectedunderlock.md index 8bf2340c3d..2f0b59d6e8 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_isprotectedunderlock.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_isprotectedunderlock.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.IsProtectedUnderLock --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.IsProtectedUnderLock ## -description Gets a Boolean value indicating if the user account data is encrypted when the device becomes locked. ## -property-value A Boolean value indicating if the user account data is encrypted when the device becomes locked. ## -remarks Encrypted data will return as empty value sets during a locked state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.IsProtectedUnderLock +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.IsProtectedUnderLock + +## -description +Gets a Boolean value indicating if the user account data is encrypted when the device becomes locked. + +## -property-value +A Boolean value indicating if the user account data is encrypted when the device becomes locked. + +## -remarks +Encrypted data will return as empty value sets during a locked state. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_otherappreadaccess.md b/windows.applicationmodel.userdataaccounts/userdataaccount_otherappreadaccess.md index 01a3c0bc70..a0295c4457 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_otherappreadaccess.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_otherappreadaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.OtherAppReadAccess --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.OtherAppReadAccess ## -description Gets or sets a value indicating whether other apps on the device have read access to the [UserDataAccount](userdataaccount.md). ## -property-value Value indicating whether other apps on the device have read access to the [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.OtherAppReadAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.OtherAppReadAccess + +## -description +Gets or sets a value indicating whether other apps on the device have read access to the [UserDataAccount](userdataaccount.md). + +## -property-value +Value indicating whether other apps on the device have read access to the [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_packagefamilyname.md b/windows.applicationmodel.userdataaccounts/userdataaccount_packagefamilyname.md index a9256583db..f10a9fe435 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_packagefamilyname.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_packagefamilyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.PackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.PackageFamilyName ## -description Gets the unique identifier for the app package that created the [UserDataAccount](userdataaccount.md). ## -property-value The unique identifier for the app package that created the [UserDataAccount](userdataaccount.md). ## -remarks This value will be **null** for device user data accounts. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.PackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.PackageFamilyName + +## -description +Gets the unique identifier for the app package that created the [UserDataAccount](userdataaccount.md). + +## -property-value +The unique identifier for the app package that created the [UserDataAccount](userdataaccount.md). + +## -remarks +This value will be **null** for device user data accounts. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_saveasync_2143735121.md b/windows.applicationmodel.userdataaccounts/userdataaccount_saveasync_2143735121.md index 6a56d8b6f5..96af9790af 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_saveasync_2143735121.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_saveasync_2143735121.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.SaveAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.SaveAsync ## -description Asynchronously persists the [UserDataAccount](userdataaccount.md) to the database. ## -returns Async action that indicates completion of the save operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.SaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.SaveAsync + +## -description +Asynchronously persists the [UserDataAccount](userdataaccount.md) to the database. + +## -returns +Async action that indicates completion of the save operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_userdisplayname.md b/windows.applicationmodel.userdataaccounts/userdataaccount_userdisplayname.md index 54ab18e353..77248fc490 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccount_userdisplayname.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_userdisplayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.UserDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccount.UserDisplayName ## -description Gets or sets a user name associated with the [UserDataAccount](userdataaccount.md) that is suitable for displaying. ## -property-value A user name associated with the [UserDataAccount](userdataaccount.md) that is suitable for displaying. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.UserDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.UserDisplayName + +## -description +Gets or sets a user name associated with the [UserDataAccount](userdataaccount.md) that is suitable for displaying. + +## -property-value +A user name associated with the [UserDataAccount](userdataaccount.md) that is suitable for displaying. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanager.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanager.md index 32e3afc1ba..ca7d18e5ee 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanager.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager ## -description Provides APIs to interact with the user’s data accounts including those implemented by the operating system. ## -remarks Call static methods to display UI so that the user can perform tasks including adding and deleting accounts. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager + +## -description +Provides APIs to interact with the user’s data accounts including those implemented by the operating system. + +## -remarks +Call static methods to display UI so that the user can perform tasks including adding and deleting accounts. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_getforuser_2058550280.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_getforuser_2058550280.md index 11d4b25aa7..0362ce7eb7 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_getforuser_2058550280.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_getforuser_2058550280.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.GetForUser(Windows.System.User) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.GetForUser ## -description Gets the [UserDataAccountManagerForUser](userdataaccountmanagerforuser.md) object for the specified user. ## -parameters ### -param user The user account to use to get the [UserDataAccountManagerForUser](userdataaccountmanagerforuser.md) object. ## -returns Returns the data account manager for the account specified by the *user* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.GetForUser + +## -description +Gets the [UserDataAccountManagerForUser](userdataaccountmanagerforuser.md) object for the specified user. + +## -parameters +### -param user +The user account to use to get the [UserDataAccountManagerForUser](userdataaccountmanagerforuser.md) object. + +## -returns +Returns the data account manager for the account specified by the *user* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_requeststoreasync_1031356348.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_requeststoreasync_1031356348.md index 11cfc3f139..1d5546da91 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_requeststoreasync_1031356348.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_requeststoreasync_1031356348.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.RequestStoreAsync(Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.RequestStoreAsync ## -description Asynchronously returns the [UserDataAccountStore](userdataaccountstore.md) from the system. ## -parameters ### -param storeAccessType Specifies the access type, such as read-only for all accounts or read/write for the calling app's accounts. ## -returns Returns the [UserDataAccountStore](userdataaccountstore.md). ## -remarks In order to gain access to the [UserDataAccountStore](userdataaccountstore.md), your app must declare at least one of the following capabilities: + contacts + appointments + email If none of these capabilities are declared, [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md) will throw an **AccessDeniedException**. If [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md) returns **null** it means that the user has turned off access in their privacy settings. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.RequestStoreAsync(Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.RequestStoreAsync + +## -description +Asynchronously returns the [UserDataAccountStore](userdataaccountstore.md) from the system. + +## -parameters +### -param storeAccessType +Specifies the access type, such as read-only for all accounts or read/write for the calling app's accounts. + +## -returns +Returns the [UserDataAccountStore](userdataaccountstore.md). + +## -remarks +In order to gain access to the [UserDataAccountStore](userdataaccountstore.md), your app must declare at least one of the following capabilities: + + ++ contacts ++ appointments ++ email +If none of these capabilities are declared, [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md) will throw an **AccessDeniedException**. + +If [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md) returns **null** it means that the user has turned off access in their privacy settings. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccounterrorresolverasync_34633836.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccounterrorresolverasync_34633836.md index 34136b0ec8..31ad58ed0e 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccounterrorresolverasync_34633836.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccounterrorresolverasync_34633836.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountErrorResolverAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountErrorResolverAsync ## -description This method shows the resolve message for an account error. ## -parameters ### -param id The user data account ID. ## -returns An async action indicating success or failure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountErrorResolverAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountErrorResolverAsync + +## -description +This method shows the resolve message for an account error. + +## -parameters +### -param id +The user data account ID. + +## -returns +An async action indicating success or failure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccountsettingsasync_88197196.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccountsettingsasync_88197196.md index e4336d18c8..cc15f7092e 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccountsettingsasync_88197196.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaccountsettingsasync_88197196.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountSettingsAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountSettingsAsync ## -description This method shows the account settings. ## -parameters ### -param id The user data account ID. ## -returns An async action indicating success or failure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountSettingsAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAccountSettingsAsync + +## -description +This method shows the account settings. + +## -parameters +### -param id +The user data account ID. + +## -returns +An async action indicating success or failure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaddaccountasync_2083174161.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaddaccountasync_2083174161.md index 453f91e35f..d8a5c14aea 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaddaccountasync_2083174161.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanager_showaddaccountasync_2083174161.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAddAccountAsync(Windows.ApplicationModel.UserDataAccounts.UserDataAccountContentKinds) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAddAccountAsync ## -description Shows the add account UI. ## -parameters ### -param contentKinds The type of user data content. ## -returns Returns the newly added or already existing account. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAddAccountAsync(Windows.ApplicationModel.UserDataAccounts.UserDataAccountContentKinds) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManager.ShowAddAccountAsync + +## -description +Shows the add account UI. + +## -parameters +### -param contentKinds +The type of user data content. + +## -returns +Returns the newly added or already existing account. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser.md index 86da4c3add..e74c2afa91 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser ## -description Represents a user data account manager for a specific user. ## -remarks Call the [UserDataAccountManager.GetForUser](userdataaccountmanager_getforuser.md) method to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser + +## -description +Represents a user data account manager for a specific user. + +## -remarks +Call the [UserDataAccountManager.GetForUser](userdataaccountmanager_getforuser.md) method to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_requeststoreasync_1031356348.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_requeststoreasync_1031356348.md index 9b6163af43..0707854881 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_requeststoreasync_1031356348.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_requeststoreasync_1031356348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.RequestStoreAsync(Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreAccessType) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.RequestStoreAsync ## -description Retrieves a [UserDataAccountStore](userdataaccountstore.md) object that enables searching or retrieving user data accounts on the device. ## -parameters ### -param storeAccessType Specifies the type of read/write access requested. ## -returns An asynchronous operation that returns a [UserDataAccountStore](userdataaccountstore.md) object upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.RequestStoreAsync(Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.RequestStoreAsync + +## -description +Retrieves a [UserDataAccountStore](userdataaccountstore.md) object that enables searching or retrieving user data accounts on the device. + +## -parameters +### -param storeAccessType +Specifies the type of read/write access requested. + +## -returns +An asynchronous operation that returns a [UserDataAccountStore](userdataaccountstore.md) object upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_user.md b/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_user.md index 4c9a9264d5..ac1ff7f11e 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_user.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountmanagerforuser_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.User --api-type: winrt property ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.User ## -description Gets the [User](../windows.system/user.md) represented by this data account manager. ## -property-value The [User](../windows.system/user.md) represented by this data account manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountManagerForUser.User + +## -description +Gets the [User](../windows.system/user.md) represented by this data account manager. + +## -property-value +The [User](../windows.system/user.md) represented by this data account manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore.md index 50bd487161..4528bca56f 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstore.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore ## -description Represents a data store that contains user accounts. ## -remarks Call [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md) to get an instance of [UserDataAccountStore](userdataaccountstore.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore + +## -description +Represents a data store that contains user accounts. + +## -remarks +Call [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md) to get an instance of [UserDataAccountStore](userdataaccountstore.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1955614316.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1955614316.md index 2a4027cc29..ec7da99978 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1955614316.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1955614316.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync ## -description Asynchronously creates a user data account, specifying a displayable user name. ## -parameters ### -param userDisplayName A string containing the user name that is suitable for display. ## -returns Returns the newly created [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also [CreateAccountAsync(String, String)](userdataaccountstore_createaccountasync_946619348.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync + +## -description +Asynchronously creates a user data account, specifying a displayable user name. + +## -parameters + +### -param userDisplayName +A string containing the user name that is suitable for display. + +## -returns +Returns the newly created [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also +[CreateAccountAsync(String, String)](userdataaccountstore_createaccountasync_946619348.md) diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_946619348.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_946619348.md index 693e84962c..758cbf6912 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_946619348.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_946619348.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync ## -description Asynchronously creates a user data account, specifying a displayable user name and a GUID that identifies the app in the Windows Store. ## -parameters ### -param userDisplayName A string containing the user name that is suitable for display. ### -param packageRelativeAppId The GUID that identifies the app in the Windows Store. ## -returns Returns the newly created [UserDataAccount](userdataaccount.md). ## -remarks ## -examples ## -see-also [CreateAccountAsync(String)](userdataaccountstore_createaccountasync_1955614316.md), [CreateAccountAsync(String, String)](userdataaccountstore_findaccountsasync_2001360321.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync + +## -description +Asynchronously creates a user data account, specifying a displayable user name and a GUID that identifies the app in the Windows Store. + +## -parameters +### -param userDisplayName +A string containing the user name that is suitable for display. + +### -param packageRelativeAppId +The GUID that identifies the app in the Windows Store. + +## -returns +Returns the newly created [UserDataAccount](userdataaccount.md). + +## -remarks + +## -examples + +## -see-also +[CreateAccountAsync(String)](userdataaccountstore_createaccountasync_1955614316.md), [CreateAccountAsync(String, String)](userdataaccountstore_findaccountsasync_2001360321.md) diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore_findaccountsasync_2001360321.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore_findaccountsasync_2001360321.md index 192792861e..bfb406e90a 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstore_findaccountsasync_2001360321.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore_findaccountsasync_2001360321.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.FindAccountsAsync --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.FindAccountsAsync ## -description Returns a collection of [UserDataAccount](userdataaccount.md) objects from the store based on the [UserDataAccountStoreAccessType](userdataaccountstoreaccesstype.md) value passed into [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md). ## -returns Returns the collection of user data accounts, scoped by access request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.FindAccountsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.FindAccountsAsync + +## -description +Returns a collection of [UserDataAccount](userdataaccount.md) objects from the store based on the [UserDataAccountStoreAccessType](userdataaccountstoreaccesstype.md) value passed into [RequestStoreAsync](userdataaccountmanager_requeststoreasync.md). + +## -returns +Returns the collection of user data accounts, scoped by access request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore_getaccountasync_446150997.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore_getaccountasync_446150997.md index 4f1e1443bd..1c59af9778 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstore_getaccountasync_446150997.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore_getaccountasync_446150997.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.GetAccountAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.GetAccountAsync ## -description Asynchronously gets the specified account. ## -parameters ### -param id The [Id](userdataaccount_id.md) string identifying the account. ## -returns Returns the [UserDataAccount](userdataaccount.md) identified by the *id* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.GetAccountAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.GetAccountAsync + +## -description +Asynchronously gets the specified account. + +## -parameters +### -param id +The [Id](userdataaccount_id.md) string identifying the account. + +## -returns +Returns the [UserDataAccount](userdataaccount.md) identified by the *id* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore_storechanged.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore_storechanged.md index 3707ad8430..8347f2fe81 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstore_storechanged.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore_storechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.StoreChanged --api-type: winrt event ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.StoreChanged ## -description Occurs when the [UserDataAccountStore](userdataaccountstore.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.StoreChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.StoreChanged + +## -description +Occurs when the [UserDataAccountStore](userdataaccountstore.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs.md b/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs.md index 6716a8f5ae..ba88858fed 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs --api-type: winrt class ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs ## -description Provides data for the [StoreChanged](userdataaccountstore_storechanged.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [StoreChanged](userdataaccountstore_storechanged.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs + +## -description +Provides data for the [StoreChanged](userdataaccountstore_storechanged.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [StoreChanged](userdataaccountstore_storechanged.md) event handler. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs_getdeferral_254836512.md b/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs_getdeferral_254836512.md index d5aa9deb1d..72f2018617 100644 --- a/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstorechangedeventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs.GetDeferral ## -description Gets the deferral object for the [StoreChanged](userdataaccountstore_storechanged.md) event. ## -returns The deferral object for the [StoreChanged](userdataaccountstore_storechanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStoreChangedEventArgs.GetDeferral + +## -description +Gets the deferral object for the [StoreChanged](userdataaccountstore_storechanged.md) event. + +## -returns +The deferral object for the [StoreChanged](userdataaccountstore_storechanged.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.voicecommands/voicecommand_commandname.md b/windows.applicationmodel.voicecommands/voicecommand_commandname.md index 5e986d1eeb..cb397b21f2 100644 --- a/windows.applicationmodel.voicecommands/voicecommand_commandname.md +++ b/windows.applicationmodel.voicecommands/voicecommand_commandname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommand.CommandName --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommand.CommandName ## -description Gets the value of the **Name** attribute for the **Command** element declared in the Voice Command Definition (VCD) file. ## -property-value The command name. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommand.CommandName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommand.CommandName + +## -description +Gets the value of the **Name** attribute for the **Command** element declared in the Voice Command Definition (VCD) file. + +## -property-value +The command name. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommand_properties.md b/windows.applicationmodel.voicecommands/voicecommand_properties.md index dcb0fafd1a..8ab8195331 100644 --- a/windows.applicationmodel.voicecommands/voicecommand_properties.md +++ b/windows.applicationmodel.voicecommands/voicecommand_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommand.Properties --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommand.Properties ## -description Gets a dictionary containing the semantic properties of the recognized phrase in the voice command. ## -property-value The semantic properties recognized in the voice command. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommand.Properties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommand.Properties + +## -description +Gets a dictionary containing the semantic properties of the recognized phrase in the voice command. + +## -property-value +The semantic properties recognized in the voice command. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md b/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md index b868f29915..7da479d1f6 100644 --- a/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md +++ b/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommand.SpeechRecognitionResult --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommand.SpeechRecognitionResult ## -description Gets the [SpeechRecognitionResult](../windows.media.speechrecognition/speechrecognitionresult.md) object representing the results returned by the voice command. ## -property-value The result of a speech recognition session. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommand.SpeechRecognitionResult +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommand.SpeechRecognitionResult + +## -description +Gets the [SpeechRecognitionResult](../windows.media.speechrecognition/speechrecognitionresult.md) object representing the results returned by the voice command. + +## -property-value +The result of a speech recognition session. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md b/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md index 5a41195f5d..65f288269f 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md +++ b/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandCompletedEventArgs.Reason --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandCompletedEventArgs.Reason ## -description The reason the voice command completed. ## -property-value The reason the voice command completed. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandCompletedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandCompletedEventArgs.Reason + +## -description +The reason the voice command completed. + +## -property-value +The reason the voice command completed. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md b/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md index 9b9074cde7..966ec7b0e8 100644 --- a/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md +++ b/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandConfirmationResult.Confirmed --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandConfirmationResult.Confirmed ## -description Gets the response to the question specified by the background app and shown on the **Cortana** confirmation screen. ## -property-value **true** when the user responds with "Yes", **false** when the user responds with "No". ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandConfirmationResult.Confirmed +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandConfirmationResult.Confirmed + +## -description +Gets the response to the question specified by the background app and shown on the **Cortana** confirmation screen. + +## -property-value +**true** when the user responds with "Yes", **false** when the user responds with "No". + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md index 828ee6e145..2bc4ef0315 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppContext --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppContext ## -description Gets or sets supplementary information the background app service can associate with the content tile. This information is not used by **Cortana**. ## -property-value Supplementary information associated with the content tile. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppContext +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppContext + +## -description +Gets or sets supplementary information the background app service can associate with the content tile. This information is not used by **Cortana**. + +## -property-value +Supplementary information associated with the content tile. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md index 5ce09b893f..92a11c9efd 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppLaunchArgument --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppLaunchArgument ## -description Gets or sets a string as a launch parameter that can be associated with the response by the background app service. [AppLaunchArgument](voicecommandresponse_applaunchargument.md) is used to specify the state or context of the foreground app when launched through a deep link in **Cortana**. ## -property-value The key/value pair. ## -remarks To enable deep linking to an app, declare the `windows.personalAssistantLaunch` extension in the Package.appxmanifest file of the app project. An app is launched to the foreground through Uniform Resource Identifier (URI) activation using a [Protocol](../windows.applicationmodel.activation/activationkind.md) contract. The app must override the [OnActivated](../windows.ui.xaml/application_onactivated.md) event and check for an [ActivationKind](../windows.applicationmodel.activation/activationkind.md) of [Protocol](../windows.applicationmodel.activation/activationkind.md). See [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be) for more info. ## -examples ## -see-also [Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppLaunchArgument +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.AppLaunchArgument + +## -description +Gets or sets a string as a launch parameter that can be associated with the response by the background app service. + +[AppLaunchArgument](voicecommandresponse_applaunchargument.md) is used to specify the state or context of the foreground app when launched through a deep link in **Cortana**. + +## -property-value +The key/value pair. + +## -remarks +To enable deep linking to an app, declare the `windows.personalAssistantLaunch` extension in the Package.appxmanifest file of the app project. + +An app is launched to the foreground through Uniform Resource Identifier (URI) activation using a [Protocol](../windows.applicationmodel.activation/activationkind.md) contract. The app must override the [OnActivated](../windows.ui.xaml/application_onactivated.md) event and check for an [ActivationKind](../windows.applicationmodel.activation/activationkind.md) of [Protocol](../windows.applicationmodel.activation/activationkind.md). See [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be) for more info. + +## -examples + +## -see-also +[Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md index 9613472319..5f7cf06bd3 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.ContentTileType --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.ContentTileType ## -description Gets or sets the layout template used for the content tiles on the **Cortana** canvas. > [!NOTE] > All content tiles on a **Cortana** feedback screen must use the same template. ## -property-value The content tile template. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.ContentTileType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.ContentTileType + +## -description +Gets or sets the layout template used for the content tiles on the **Cortana** canvas. + +> [!NOTE] +> All content tiles on a **Cortana** feedback screen must use the same template. + +## -property-value +The content tile template. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md index 660f3243ce..a8e8c39911 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Image --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Image ## -description Gets or sets the image used on the content tile. Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. ## -property-value The image associated with the content tile. ## -remarks ## -examples ## -see-also [ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Image +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Image + +## -description +Gets or sets the image used on the content tile. + +Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. + +## -property-value +The image associated with the content tile. + +## -remarks + +## -examples + +## -see-also +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md index 0227ae3a06..21a277cbea 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine1 --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine1 ## -description Gets or sets the first line of text used on the content tile. Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. ## -property-value The first line of text associated with the content tile. ## -remarks ## -examples ## -see-also [ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine1 +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine1 + +## -description +Gets or sets the first line of text used on the content tile. + +Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. + +## -property-value +The first line of text associated with the content tile. + +## -remarks + +## -examples + +## -see-also +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md index 71bb1d87ea..e633661e88 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine2 --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine2 ## -description Gets or sets the second line of text used on the content tile. Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. ## -property-value The second line of text associated with the content tile. ## -remarks ## -examples ## -see-also [ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine2 +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine2 + +## -description +Gets or sets the second line of text used on the content tile. + +Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. + +## -property-value +The second line of text associated with the content tile. + +## -remarks + +## -examples + +## -see-also +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md index 877d426187..8d7f94128f 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine3 --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine3 ## -description Gets or sets the third line of text used on the content tile. Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. ## -property-value The third line of text associated with the content tile. ## -remarks ## -examples ## -see-also [ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine3 +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.TextLine3 + +## -description +Gets or sets the third line of text used on the content tile. + +Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. + +## -property-value +The third line of text associated with the content tile. + +## -remarks + +## -examples + +## -see-also +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md index ea68f3bf73..92b76b402e 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Title --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Title ## -description Gets or sets the title used on the content tile. Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. ## -property-value The title associated with the content tile. ## -remarks ## -examples ## -see-also [ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.Title + +## -description +Gets or sets the title used on the content tile. + +Specify the tile layout template with the [ContentTileType](voicecommandcontenttile_contenttiletype.md) property. + +## -property-value +The title associated with the content tile. + +## -remarks + +## -examples + +## -see-also +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md index 0a1cfebd8d..9af23e6645 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.VoiceCommandContentTile ## -description Creates an instance of the [VoiceCommandContentTile](voicecommandcontenttile.md) class. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile.VoiceCommandContentTile + +## -description +Creates an instance of the [VoiceCommandContentTile](voicecommandcontenttile.md) class. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommanddefinition_language.md b/windows.applicationmodel.voicecommands/voicecommanddefinition_language.md index b74902d288..71036a67ac 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddefinition_language.md +++ b/windows.applicationmodel.voicecommands/voicecommanddefinition_language.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Language --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Language ## -description Gets the language ([xml:lang](../windows.media.speechrecognition/voice_command_elements_and_attributes.md)) value of the `CommandSet` element in the Voice Command Definition (VCD) file. ## -property-value The language (`xml:lang`) of the command set. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Language +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Language + +## -description +Gets the language ([xml:lang](../windows.media.speechrecognition/voice_command_elements_and_attributes.md)) value of the `CommandSet` element in the Voice Command Definition (VCD) file. + +## -property-value +The language (`xml:lang`) of the command set. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommanddefinition_name.md b/windows.applicationmodel.voicecommands/voicecommanddefinition_name.md index d41e96823e..ed58aea324 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddefinition_name.md +++ b/windows.applicationmodel.voicecommands/voicecommanddefinition_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Name --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Name ## -description Gets the `Name` attribute value of the `CommandSet` element in the Voice Command Definition (VCD) file. ## -property-value The Name attribute value of the `CommandSet` element. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.Name + +## -description +Gets the `Name` attribute value of the `CommandSet` element in the Voice Command Definition (VCD) file. + +## -property-value +The Name attribute value of the `CommandSet` element. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommanddefinition_setphraselistasync_1434476529.md b/windows.applicationmodel.voicecommands/voicecommanddefinition_setphraselistasync_1434476529.md index b6d46b77ea..21945cf85d 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddefinition_setphraselistasync_1434476529.md +++ b/windows.applicationmodel.voicecommands/voicecommanddefinition_setphraselistasync_1434476529.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.SetPhraseListAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.SetPhraseListAsync ## -description Populates a `PhraseList` element with an array of `Item` elements. ## -parameters ### -param phraseListName The string that corresponds to the label attribute of the `PhraseList` element. ### -param phraseList A string array of values that will be added to the `PhraseList` element as `Item` elements. ## -returns A string array of values that will be added to the [PhraseList](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) element as [Item](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) elements. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.SetPhraseListAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinition.SetPhraseListAsync + +## -description +Populates a `PhraseList` element with an array of `Item` elements. + +## -parameters +### -param phraseListName +The string that corresponds to the label attribute of the `PhraseList` element. + +### -param phraseList +A string array of values that will be added to the `PhraseList` element as `Item` elements. + +## -returns +A string array of values that will be added to the [PhraseList](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) element as [Item](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) elements. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installcommanddefinitionsfromstoragefileasync_2113496984.md b/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installcommanddefinitionsfromstoragefileasync_2113496984.md index 0d727cac8b..78675c4190 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installcommanddefinitionsfromstoragefileasync_2113496984.md +++ b/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installcommanddefinitionsfromstoragefileasync_2113496984.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstallCommandDefinitionsFromStorageFileAsync(Windows.Storage.StorageFile) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstallCommandDefinitionsFromStorageFileAsync ## -description Installs the [CommandSet](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) elements in a Voice Command Definition (VCD) file. ## -parameters ### -param file An object representing a Voice Command Definition (VCD) file. ## -returns An asynchronous handler called when the operation is complete. ## -remarks Call this method only from your [OnLaunched](../windows.ui.xaml/application_onlaunched.md) override, or a [Resuming](../windows.applicationmodel.core/coreapplication_resuming.md) event handler. Do not call this method from a [Suspending](../windows.applicationmodel.core/coreapplication_suspending.md) event handler as the action might take longer than the time allotted by the system for app suspension. ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstallCommandDefinitionsFromStorageFileAsync(Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstallCommandDefinitionsFromStorageFileAsync + +## -description +Installs the [CommandSet](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) elements in a Voice Command Definition (VCD) file. + +## -parameters +### -param file +An object representing a Voice Command Definition (VCD) file. + +## -returns +An asynchronous handler called when the operation is complete. + +## -remarks +Call this method only from your [OnLaunched](../windows.ui.xaml/application_onlaunched.md) override, or a [Resuming](../windows.applicationmodel.core/coreapplication_resuming.md) event handler. + +Do not call this method from a [Suspending](../windows.applicationmodel.core/coreapplication_suspending.md) event handler as the action might take longer than the time allotted by the system for app suspension. + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installedcommanddefinitions.md b/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installedcommanddefinitions.md index 68918a1ec2..3b1a5ccc23 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installedcommanddefinitions.md +++ b/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager_installedcommanddefinitions.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstalledCommandDefinitions --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstalledCommandDefinitions ## -description A dictionary that contains all installed command sets that have a [Name](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) attribute set in the Voice Command Definition (VCD) file. > [!NOTE] > Opening an app service connection can be resource intensive. Avoid accessing this property during time-sensitive operations, especially from the UI thread or when [Suspending](../windows.ui.xaml/application_suspending.md). ## -property-value The dictionary of installed command sets that have a Name attribute set in the Voice Command Definition (VCD) file. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstalledCommandDefinitions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager.InstalledCommandDefinitions + +## -description +A dictionary that contains all installed command sets that have a [Name](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) attribute set in the Voice Command Definition (VCD) file. + +> [!NOTE] +> Opening an app service connection can be resource intensive. Avoid accessing this property during time-sensitive operations, especially from the UI thread or when [Suspending](../windows.ui.xaml/application_suspending.md). + +## -property-value +The dictionary of installed command sets that have a Name attribute set in the Voice Command Definition (VCD) file. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommanddisambiguationresult_selecteditem.md b/windows.applicationmodel.voicecommands/voicecommanddisambiguationresult_selecteditem.md index f3eb270a03..ef2fb4f099 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddisambiguationresult_selecteditem.md +++ b/windows.applicationmodel.voicecommands/voicecommanddisambiguationresult_selecteditem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDisambiguationResult.SelectedItem --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandDisambiguationResult.SelectedItem ## -description The item selected from the list of items displayed on the **Cortana** disambiguation screen. ## -property-value An asset, containing image and text data, provided by the background app service for display on the **Cortana** canvas. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandDisambiguationResult.SelectedItem +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandDisambiguationResult.SelectedItem + +## -description +The item selected from the list of items displayed on the **Cortana** disambiguation screen. + +## -property-value +An asset, containing image and text data, provided by the background app service for display on the **Cortana** canvas. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_applaunchargument.md b/windows.applicationmodel.voicecommands/voicecommandresponse_applaunchargument.md index 2d61c76226..1579ce0957 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_applaunchargument.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_applaunchargument.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.AppLaunchArgument --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.AppLaunchArgument ## -description Gets or sets a string as a launch parameter that can be associated with the response by the background app service. [AppLaunchArgument](voicecommandresponse_applaunchargument.md) is used to specify the state or context of the foreground app when launched through a deep link in **Cortana**. ## -property-value The string used as a launch parameter. ## -remarks To enable deep linking to an app, declare the `windows.personalAssistantLaunch` extension in the Package.appxmanifest file of the app project. An app is launched to the foreground through Uniform Resource Identifier (URI) activation using a [Protocol](../windows.applicationmodel.activation/activationkind.md) contract. The app must override the [OnActivated](../windows.ui.xaml/application_onactivated.md) event and check for an [ActivationKind](../windows.applicationmodel.activation/activationkind.md) of [Protocol](../windows.applicationmodel.activation/activationkind.md). See [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be) for more info. ## -examples ## -see-also [Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.AppLaunchArgument +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.AppLaunchArgument + +## -description +Gets or sets a string as a launch parameter that can be associated with the response by the background app service. + +[AppLaunchArgument](voicecommandresponse_applaunchargument.md) is used to specify the state or context of the foreground app when launched through a deep link in **Cortana**. + +## -property-value +The string used as a launch parameter. + +## -remarks +To enable deep linking to an app, declare the `windows.personalAssistantLaunch` extension in the Package.appxmanifest file of the app project. + +An app is launched to the foreground through Uniform Resource Identifier (URI) activation using a [Protocol](../windows.applicationmodel.activation/activationkind.md) contract. The app must override the [OnActivated](../windows.ui.xaml/application_onactivated.md) event and check for an [ActivationKind](../windows.applicationmodel.activation/activationkind.md) of [Protocol](../windows.applicationmodel.activation/activationkind.md). See [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be) for more info. + +## -examples + +## -see-also +[Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_493218068.md b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_493218068.md index 9dfd31fd50..000fd2b8a9 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_493218068.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_493218068.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile}) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse ## -description Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md) or [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md). ## -parameters ### -param message The message that is spoken by **Cortana** and shown on the **Cortana** canvas. This message should be: + An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ### -param contentTiles The collection of [VoiceCommandContentTile](voicecommandcontenttile.md) objects, containing image and text data, shown as result cards on the **Cortana** canvas. ## -returns The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. ## -remarks ## -examples ## -see-also [CreateResponse(VoiceCommandUserMessage)](voicecommandresponse_createresponse_707865524.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse + +## -description +Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md) or [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md). + +## -parameters +### -param message +The message that is spoken by **Cortana** and shown on the **Cortana** canvas. +This message should be: + ++ An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +### -param contentTiles +The collection of [VoiceCommandContentTile](voicecommandcontenttile.md) objects, containing image and text data, shown as result cards on the **Cortana** canvas. + +## -returns +The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. + +## -remarks + +## -examples + +## -see-also +[CreateResponse(VoiceCommandUserMessage)](voicecommandresponse_createresponse_707865524.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_707865524.md b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_707865524.md index 3e9d705f2a..38d8972e36 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_707865524.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponse_707865524.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse ## -description Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md) or [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md). ## -parameters ### -param userMessage The message that is spoken by **Cortana** and shown on the **Cortana** canvas. This message should be: + An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ## -returns The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. ## -remarks ## -examples ## -see-also [CreateResponse(VoiceCommandUserMessage, IIterable(VoiceCommandContentTile))](voicecommandresponse_createresponse_493218068.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponse + +## -description +Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md) or [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md). + +## -parameters +### -param userMessage +The message that is spoken by **Cortana** and shown on the **Cortana** canvas. +This message should be: + ++ An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +## -returns +The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. + +## -remarks + +## -examples + +## -see-also +[CreateResponse(VoiceCommandUserMessage, IIterable(VoiceCommandContentTile))](voicecommandresponse_createresponse_493218068.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_1964297975.md b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_1964297975.md index 2102bd0e78..6f08326dc1 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_1964297975.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_1964297975.md @@ -1,3 +1,43 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile}) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt ## -description Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md) or [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md). ## -parameters ### -param message The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. This message should be one of the following: + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ### -param repeatMessage The secondary message that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. This message should be both a variation of the first message and one of the following: + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ### -param contentTiles The collection of assets, containing image and text data, shown on the **Cortana** canvas. ## -returns The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. ## -remarks ## -examples ## -see-also [CreateResponseForPrompt(VoiceCommandUserMessage, VoiceCommandUserMessage)](voicecommandresponse_createresponseforprompt_465390519.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.VoiceCommands.VoiceCommandContentTile}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt + +## -description +Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md) or [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md). + +## -parameters +### -param message +The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. +This message should be one of the following: + ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +### -param repeatMessage +The secondary message that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. +This message should be both a variation of the first message and one of the following: + ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +### -param contentTiles +The collection of assets, containing image and text data, shown on the **Cortana** canvas. + +## -returns +The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. + +## -remarks + +## -examples + +## -see-also +[CreateResponseForPrompt(VoiceCommandUserMessage, VoiceCommandUserMessage)](voicecommandresponse_createresponseforprompt_465390519.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_465390519.md b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_465390519.md index dfeda1c844..1518b57d00 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_465390519.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_createresponseforprompt_465390519.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt ## -description Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md) or [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md). ## -parameters ### -param message The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. This message should be one of the following: + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ### -param repeatMessage The secondary message that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. This message should be both a variation of the first message and one of the following: + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ## -returns The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. ## -remarks ## -examples ## -see-also [CreateResponseForPrompt(VoiceCommandUserMessage, VoiceCommandUserMessage, IIterable(VoiceCommandContentTile))](voicecommandresponse_createresponseforprompt_1964297975.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt(Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage,Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.CreateResponseForPrompt + +## -description +Creates a [VoiceCommandResponse](voicecommandresponse.md) object used in calls to [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md) or [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md). + +## -parameters +### -param message +The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. +This message should be one of the following: + ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +### -param repeatMessage +The secondary message that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. +This message should be both a variation of the first message and one of the following: + ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +## -returns +The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas. + +## -remarks + +## -examples + +## -see-also +[CreateResponseForPrompt(VoiceCommandUserMessage, VoiceCommandUserMessage, IIterable(VoiceCommandContentTile))](voicecommandresponse_createresponseforprompt_1964297975.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_maxsupportedvoicecommandcontenttiles.md b/windows.applicationmodel.voicecommands/voicecommandresponse_maxsupportedvoicecommandcontenttiles.md index 9dda73851f..d1837a05d5 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_maxsupportedvoicecommandcontenttiles.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_maxsupportedvoicecommandcontenttiles.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.MaxSupportedVoiceCommandContentTiles --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.MaxSupportedVoiceCommandContentTiles ## -description Gets the maximum number of content tiles the background app service can display on the **Cortana** canvas. ## -property-value The maximum number of content tiles. ## -remarks The maximum number of tiles that can be displayed depends on the feedback screen being shown. One item when the [VoiceCommandResponse](voicecommandresponse.md) is created for [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md) or [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md), and more than one item when the [VoiceCommandResponse](voicecommandresponse.md) is created for [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md). ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.MaxSupportedVoiceCommandContentTiles +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.MaxSupportedVoiceCommandContentTiles + +## -description +Gets the maximum number of content tiles the background app service can display on the **Cortana** canvas. + +## -property-value +The maximum number of content tiles. + +## -remarks +The maximum number of tiles that can be displayed depends on the feedback screen being shown. One item when the [VoiceCommandResponse](voicecommandresponse.md) is created for [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md) or [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md), and more than one item when the [VoiceCommandResponse](voicecommandresponse.md) is created for [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md). + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_message.md b/windows.applicationmodel.voicecommands/voicecommandresponse_message.md index 1b55738c72..be93ce81f4 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_message.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_message.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.Message --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.Message ## -description The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. This message should be: + An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ## -property-value The message that is spoken or shown by **Cortana**. ## -remarks ## -examples ## -see-also [VoiceCommandContentTiles](voicecommandresponse_voicecommandcontenttiles.md), [RepeatMessage](voicecommandresponse_repeatmessage.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.Message + +## -description +The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. + + +This message should be: + ++ An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +## -property-value +The message that is spoken or shown by **Cortana**. + +## -remarks + +## -examples + +## -see-also +[VoiceCommandContentTiles](voicecommandresponse_voicecommandcontenttiles.md), [RepeatMessage](voicecommandresponse_repeatmessage.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_repeatmessage.md b/windows.applicationmodel.voicecommands/voicecommandresponse_repeatmessage.md index d68cddb30e..5acc705b3a 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_repeatmessage.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_repeatmessage.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.RepeatMessage --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.RepeatMessage ## -description The secondary message (for disambiguation and confirmation screens only) that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. This message should be both a variation of the first message and one of the following: + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ## -property-value The message that is spoken or shown by **Cortana**. ## -remarks ## -examples ## -see-also [VoiceCommandContentTiles](voicecommandresponse_voicecommandcontenttiles.md), [Message](voicecommandresponse_message.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.RepeatMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.RepeatMessage + +## -description +The secondary message (for disambiguation and confirmation screens only) that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. + + +This message should be both a variation of the first message and one of the following: + ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +## -property-value +The message that is spoken or shown by **Cortana**. + +## -remarks + +## -examples + +## -see-also +[VoiceCommandContentTiles](voicecommandresponse_voicecommandcontenttiles.md), [Message](voicecommandresponse_message.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandresponse_voicecommandcontenttiles.md b/windows.applicationmodel.voicecommands/voicecommandresponse_voicecommandcontenttiles.md index 0c14a5a3eb..2f7ac50a62 100644 --- a/windows.applicationmodel.voicecommands/voicecommandresponse_voicecommandcontenttiles.md +++ b/windows.applicationmodel.voicecommands/voicecommandresponse_voicecommandcontenttiles.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.VoiceCommandContentTiles --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.VoiceCommandContentTiles ## -description The collection of assets, containing image and text data, provided by the background app service for display on the **Cortana** canvas. ## -property-value The collection of assets. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.VoiceCommandContentTiles +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse.VoiceCommandContentTiles + +## -description +The collection of assets, containing image and text data, provided by the background app service for display on the **Cortana** canvas. + +## -property-value +The collection of assets. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_fromappservicetriggerdetails_1819022590.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_fromappservicetriggerdetails_1819022590.md index 86b4ddab41..ee7802df7a 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_fromappservicetriggerdetails_1819022590.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_fromappservicetriggerdetails_1819022590.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.FromAppServiceTriggerDetails(Windows.ApplicationModel.AppService.AppServiceTriggerDetails) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.FromAppServiceTriggerDetails ## -description Retrieves a [VoiceCommandServiceConnection](voicecommandserviceconnection.md) object from the [AppServiceTriggerDetails](../windows.applicationmodel.appservice/appservicetriggerdetails.md) that contains info associated with the background task for the app service. ## -parameters ### -param triggerDetails Contains info associated with the background task for the app service. ## -returns The background app service connection to **Cortana**. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.FromAppServiceTriggerDetails(Windows.ApplicationModel.AppService.AppServiceTriggerDetails) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.FromAppServiceTriggerDetails + +## -description +Retrieves a [VoiceCommandServiceConnection](voicecommandserviceconnection.md) object from the [AppServiceTriggerDetails](../windows.applicationmodel.appservice/appservicetriggerdetails.md) that contains info associated with the background task for the app service. + +## -parameters +### -param triggerDetails +Contains info associated with the background task for the app service. + +## -returns +The background app service connection to **Cortana**. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_getvoicecommandasync_1073619361.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_getvoicecommandasync_1073619361.md index 933344b345..e268c45bc1 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_getvoicecommandasync_1073619361.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_getvoicecommandasync_1073619361.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.GetVoiceCommandAsync --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.GetVoiceCommandAsync ## -description Retrieves the voice command that the user submitted to **Cortana** by voice or text. ## -returns The [VoiceCommand](voicecommand.md). ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.GetVoiceCommandAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.GetVoiceCommandAsync + +## -description +Retrieves the voice command that the user submitted to **Cortana** by voice or text. + +## -returns +The [VoiceCommand](voicecommand.md). + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_language.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_language.md index 6245aaf9b7..336254f7a2 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_language.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_language.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.Language --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.Language ## -description Gets the locale for the voice command. ## -property-value The locale for the voice command. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.Language +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.Language + +## -description +Gets the locale for the voice command. + +## -property-value +The locale for the voice command. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportfailureasync_1581497711.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportfailureasync_1581497711.md index 332f8367cc..01f27033e8 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportfailureasync_1581497711.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportfailureasync_1581497711.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportFailureAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportFailureAsync ## -description Sends a response to **Cortana** indicating the voice command has failed. ## -parameters ### -param response The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. ## -returns An asynchronous handler called when the operation is complete. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportFailureAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportFailureAsync + +## -description +Sends a response to **Cortana** indicating the voice command has failed. + +## -parameters +### -param response +The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. + +## -returns +An asynchronous handler called when the operation is complete. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportprogressasync_197749011.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportprogressasync_197749011.md index 0e0dc8d37b..561c687bd9 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportprogressasync_197749011.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportprogressasync_197749011.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportProgressAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportProgressAsync ## -description Sends a response to **Cortana** indicating voice command is being processed. ## -parameters ### -param response The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. ## -returns An asynchronous handler called when the operation is complete. ## -remarks **Cortana** presents the progress screen to the user for up to 5 seconds. The background app service send another progress message by calling [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md) again, or move to the next screen in the interaction flow (confirmation, disambiguation, or completion). ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportProgressAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportProgressAsync + +## -description +Sends a response to **Cortana** indicating voice command is being processed. + +## -parameters +### -param response +The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. + +## -returns +An asynchronous handler called when the operation is complete. + +## -remarks +**Cortana** presents the progress screen to the user for up to 5 seconds. The background app service send another progress message by calling [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md) again, or move to the next screen in the interaction flow (confirmation, disambiguation, or completion). + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportsuccessasync_2126991650.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportsuccessasync_2126991650.md index 26aa925dd1..f00db2491e 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportsuccessasync_2126991650.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_reportsuccessasync_2126991650.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportSuccessAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportSuccessAsync ## -description Sends a response to **Cortana** indicating the voice command has succeeded. ## -parameters ### -param response The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. ## -returns An asynchronous handler called when the operation is complete. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportSuccessAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.ReportSuccessAsync + +## -description +Sends a response to **Cortana** indicating the voice command has succeeded. + +## -parameters +### -param response +The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. + +## -returns +An asynchronous handler called when the operation is complete. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestapplaunchasync_1419235493.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestapplaunchasync_1419235493.md index 4a1bcfda1f..2baa29531e 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestapplaunchasync_1419235493.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestapplaunchasync_1419235493.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestAppLaunchAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestAppLaunchAsync ## -description Sends a response to **Cortana** indicating the command should be handled by the app in the foreground. ## -parameters ### -param response The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. ## -returns An asynchronous handler called when the operation is complete. ## -remarks To enable deep linking to an app, declare the `windows.personalAssistantLaunch` extension in the Package.appxmanifest file of the app project. An app is launched to the foreground through Uniform Resource Identifier (URI) activation using a [Protocol](../windows.applicationmodel.activation/activationkind.md) contract. The app must override the [OnActivated](../windows.ui.xaml/application_onactivated.md) event and check for an [ActivationKind](../windows.applicationmodel.activation/activationkind.md) of [Protocol](../windows.applicationmodel.activation/activationkind.md). See [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be) for more info. **Cortana** terminates the background app service and launches the app in foreground with the launch parameter provided by the app. ## -examples ## -see-also [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestAppLaunchAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestAppLaunchAsync + +## -description +Sends a response to **Cortana** indicating the command should be handled by the app in the foreground. + +## -parameters +### -param response +The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. + +## -returns +An asynchronous handler called when the operation is complete. + +## -remarks +To enable deep linking to an app, declare the `windows.personalAssistantLaunch` extension in the Package.appxmanifest file of the app project. + +An app is launched to the foreground through Uniform Resource Identifier (URI) activation using a [Protocol](../windows.applicationmodel.activation/activationkind.md) contract. The app must override the [OnActivated](../windows.ui.xaml/application_onactivated.md) event and check for an [ActivationKind](../windows.applicationmodel.activation/activationkind.md) of [Protocol](../windows.applicationmodel.activation/activationkind.md). See [Handle URI activation](http://msdn.microsoft.com/library/92d06f3e-c8f3-42e0-a476-7e94fd14b2be) for more info. + +**Cortana** terminates the background app service and launches the app in foreground with the launch parameter provided by the app. + +## -examples + +## -see-also +[Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestconfirmationasync_1656186355.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestconfirmationasync_1656186355.md index 625997515c..0b1cb2d028 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestconfirmationasync_1656186355.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestconfirmationasync_1656186355.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestConfirmationAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestConfirmationAsync ## -description Sends a response to **Cortana** indicating the voice command requires confirmation. ## -parameters ### -param response The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. ## -returns The [VoiceCommandConfirmationResult](voicecommandconfirmationresult.md) object with the user's response. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestConfirmationAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestConfirmationAsync + +## -description +Sends a response to **Cortana** indicating the voice command requires confirmation. + +## -parameters +### -param response +The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. + +## -returns +The [VoiceCommandConfirmationResult](voicecommandconfirmationresult.md) object with the user's response. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestdisambiguationasync_117243970.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestdisambiguationasync_117243970.md index 02d29c0f80..ddcaca0521 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestdisambiguationasync_117243970.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_requestdisambiguationasync_117243970.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestDisambiguationAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestDisambiguationAsync ## -description Sends a response to **Cortana** indicating the voice command returned more than one result and requires the user to select one. ## -parameters ### -param response The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. ## -returns The [VoiceCommandDisambiguationResult](voicecommanddisambiguationresult.md) object with the user's response. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestDisambiguationAsync(Windows.ApplicationModel.VoiceCommands.VoiceCommandResponse) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.RequestDisambiguationAsync + +## -description +Sends a response to **Cortana** indicating the voice command returned more than one result and requires the user to select one. + +## -parameters +### -param response +The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. + +## -returns +The [VoiceCommandDisambiguationResult](voicecommanddisambiguationresult.md) object with the user's response. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_voicecommandcompleted.md b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_voicecommandcompleted.md index 8ac11bc8b1..6939a451b2 100644 --- a/windows.applicationmodel.voicecommands/voicecommandserviceconnection_voicecommandcompleted.md +++ b/windows.applicationmodel.voicecommands/voicecommandserviceconnection_voicecommandcompleted.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.VoiceCommandCompleted --api-type: winrt event ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.VoiceCommandCompleted ## -description Event raised when the voice command is completed and the background app service is about to be terminated. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.VoiceCommandCompleted +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandServiceConnection.VoiceCommandCompleted + +## -description +Event raised when the voice command is completed and the background app service is about to be terminated. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandusermessage_displaymessage.md b/windows.applicationmodel.voicecommands/voicecommandusermessage_displaymessage.md index d0cd0ed459..df0a308166 100644 --- a/windows.applicationmodel.voicecommands/voicecommandusermessage_displaymessage.md +++ b/windows.applicationmodel.voicecommands/voicecommandusermessage_displaymessage.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.DisplayMessage --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.DisplayMessage ## -description Gets or sets the message that is shown on the **Cortana** canvas. ## -property-value + An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.DisplayMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.DisplayMessage + +## -description +Gets or sets the message that is shown on the **Cortana** canvas. + +## -property-value + ++ An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandusermessage_spokenmessage.md b/windows.applicationmodel.voicecommands/voicecommandusermessage_spokenmessage.md index 506c1513d9..a1fbd111d0 100644 --- a/windows.applicationmodel.voicecommands/voicecommandusermessage_spokenmessage.md +++ b/windows.applicationmodel.voicecommands/voicecommandusermessage_spokenmessage.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.SpokenMessage --api-type: winrt property ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.SpokenMessage ## -description The message that is spoken by **Cortana**. ## -property-value + An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). + An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). + A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.SpokenMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.SpokenMessage + +## -description +The message that is spoken by **Cortana**. + +## -property-value + ++ An informative statement on progress, completion, and error screens (see [ReportProgressAsync](voicecommandserviceconnection_reportprogressasync.md), [ReportSuccessAsync](voicecommandserviceconnection_reportsuccessasync.md), [ReportFailureAsync](voicecommandserviceconnection_reportfailureasync.md)). ++ An unambiguous question that can be answered with either yes or no on confirmation screens (see [RequestConfirmationAsync](voicecommandserviceconnection_requestconfirmationasync.md)). ++ A request for the user to select from the list of choices presented on disambiguation screens (see [RequestDisambiguationAsync](voicecommandserviceconnection_requestdisambiguationasync.md)). + + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandusermessage_voicecommandusermessage_1221375020.md b/windows.applicationmodel.voicecommands/voicecommandusermessage_voicecommandusermessage_1221375020.md index 56b8200d8c..63da383942 100644 --- a/windows.applicationmodel.voicecommands/voicecommandusermessage_voicecommandusermessage_1221375020.md +++ b/windows.applicationmodel.voicecommands/voicecommandusermessage_voicecommandusermessage_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.VoiceCommandUserMessage ## -description Creates an instance of the [VoiceCommandUserMessage](voicecommandusermessage.md) class. ## -remarks ## -examples ## -see-also [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.VoiceCommands.VoiceCommandUserMessage.VoiceCommandUserMessage + +## -description +Creates an instance of the [VoiceCommandUserMessage](voicecommandusermessage.md) class. + +## -remarks + +## -examples + +## -see-also +[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore.md b/windows.applicationmodel.wallet.system/walletitemsystemstore.md index ec0cbfadb4..7f710ad78c 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore --api-type: winrt class ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore ## -description Defines a set of asynchronous actions and operations that manage the wallet items in the system wallet database. These can be used to read the existing items, or to add and remove items. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. Call the [WalletManagerSystem.RequestStoreAsync](walletmanagersystem_requeststoreasync.md)method to obtain an instance of this class. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore + +## -description +Defines a set of asynchronous actions and operations that manage the wallet items in the system wallet database. These can be used to read the existing items, or to add and remove items. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +Call the [WalletManagerSystem.RequestStoreAsync](walletmanagersystem_requeststoreasync.md)method to obtain an instance of this class. + +## -remarks + + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore_deleteasync_569939873.md b/windows.applicationmodel.wallet.system/walletitemsystemstore_deleteasync_569939873.md index bfdb584149..d0c2f6ecce 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore_deleteasync_569939873.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore_deleteasync_569939873.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.DeleteAsync(Windows.ApplicationModel.Wallet.WalletItem) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.DeleteAsync ## -description Asynchronously removes a specific wallet item with the given ID from the wallet system data store. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param item The ID of the wallet item to remove from the system data store. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.DeleteAsync(Windows.ApplicationModel.Wallet.WalletItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.DeleteAsync + +## -description +Asynchronously removes a specific wallet item with the given ID from the wallet system data store. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param item +The ID of the wallet item to remove from the system data store. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore_getappstatusforitem_1214253302.md b/windows.applicationmodel.wallet.system/walletitemsystemstore_getappstatusforitem_1214253302.md index c2ef96b1d8..1c48687eee 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore_getappstatusforitem_1214253302.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore_getappstatusforitem_1214253302.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetAppStatusForItem(Windows.ApplicationModel.Wallet.WalletItem) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetAppStatusForItem ## -description Gets a [WalletItemAppAssociation](walletitemappassociation.md) value indicating if an app is installed for the specified [WalletItem](../windows.applicationmodel.wallet/walletitem.md). > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param item The item for which to retrieve the status. ## -returns The [WalletItemAppAssociation](walletitemappassociation.md) value indicating if an app is installed for the specified [WalletItem](../windows.applicationmodel.wallet/walletitem.md) specified by the *item* parameter. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetAppStatusForItem(Windows.ApplicationModel.Wallet.WalletItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetAppStatusForItem + +## -description +Gets a [WalletItemAppAssociation](walletitemappassociation.md) value indicating if an app is installed for the specified [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param item +The item for which to retrieve the status. + +## -returns +The [WalletItemAppAssociation](walletitemappassociation.md) value indicating if an app is installed for the specified [WalletItem](../windows.applicationmodel.wallet/walletitem.md) specified by the *item* parameter. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore_getitemsasync_1518547059.md b/windows.applicationmodel.wallet.system/walletitemsystemstore_getitemsasync_1518547059.md index 7ee90b0362..7665f7e678 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore_getitemsasync_1518547059.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore_getitemsasync_1518547059.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetItemsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetItemsAsync ## -description Returns the collection of all system wallet items owned by this app. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns An asynchronous operation that, on successful completion, returns the collection of wallet items accessible by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [WalletItem](../windows.applicationmodel.wallet/walletitem.md) items. (You can use APIs of [IVectorView<WalletItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<WalletItem>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetItemsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.GetItemsAsync + +## -description +Returns the collection of all system wallet items owned by this app. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of wallet items accessible by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [WalletItem](../windows.applicationmodel.wallet/walletitem.md) items. (You can use APIs of [IVectorView<WalletItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<WalletItem>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore_importitemasync_245701098.md b/windows.applicationmodel.wallet.system/walletitemsystemstore_importitemasync_245701098.md index b4cda4a523..eef1a63331 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore_importitemasync_245701098.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore_importitemasync_245701098.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ImportItemAsync(Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ImportItemAsync ## -description Imports data from a ".mswallet" XML file into the system wallet store. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param stream The ".mswallet" file to import. ## -returns An asynchronous operation that, on successful completion, returns the wallet item that was imported into the wallet. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type on successful completion is a single [WalletItem](../windows.applicationmodel.wallet/walletitem.md). ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ImportItemAsync(Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ImportItemAsync + +## -description +Imports data from a ".mswallet" XML file into the system wallet store. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param stream +The ".mswallet" file to import. + +## -returns +An asynchronous operation that, on successful completion, returns the wallet item that was imported into the wallet. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type on successful completion is a single [WalletItem](../windows.applicationmodel.wallet/walletitem.md). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore_itemschanged.md b/windows.applicationmodel.wallet.system/walletitemsystemstore_itemschanged.md index 01c285172d..7468241828 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore_itemschanged.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore_itemschanged.md @@ -1,3 +1,26 @@ ---- -api-id: E:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ItemsChanged --api-type: winrt event ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ItemsChanged ## -description Occurs when items in the [WalletItemSystemStore](walletitemsystemstore.md) have changed. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ItemsChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.ItemsChanged + +## -description +Occurs when items in the [WalletItemSystemStore](walletitemsystemstore.md) have changed. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletitemsystemstore_launchappforitemasync_188933313.md b/windows.applicationmodel.wallet.system/walletitemsystemstore_launchappforitemasync_188933313.md index b2b078aab7..3e95d3b19f 100644 --- a/windows.applicationmodel.wallet.system/walletitemsystemstore_launchappforitemasync_188933313.md +++ b/windows.applicationmodel.wallet.system/walletitemsystemstore_launchappforitemasync_188933313.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.LaunchAppForItemAsync(Windows.ApplicationModel.Wallet.WalletItem) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.LaunchAppForItemAsync ## -description Launches the app that is associated with the given wallet item. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param item The wallet item to launch an app for. ## -returns An async action indicating that the operation has completed. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.LaunchAppForItemAsync(Windows.ApplicationModel.Wallet.WalletItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletItemSystemStore.LaunchAppForItemAsync + +## -description +Launches the app that is associated with the given wallet item. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param item +The wallet item to launch an app for. + +## -returns +An async action indicating that the operation has completed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletmanagersystem.md b/windows.applicationmodel.wallet.system/walletmanagersystem.md index 279ba516b6..919b3c4d63 100644 --- a/windows.applicationmodel.wallet.system/walletmanagersystem.md +++ b/windows.applicationmodel.wallet.system/walletmanagersystem.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.ApplicationModel.Wallet.System.WalletManagerSystem --api-type: winrt class ---- # Windows.ApplicationModel.Wallet.System.WalletManagerSystem ## -description Provides a static method to get an instance of the system wallet store for this app. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.Wallet.System.WalletManagerSystem +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletManagerSystem + +## -description +Provides a static method to get an instance of the system wallet store for this app. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet.system/walletmanagersystem_requeststoreasync_428591920.md b/windows.applicationmodel.wallet.system/walletmanagersystem_requeststoreasync_428591920.md index 4210c32d26..13e1b8c69a 100644 --- a/windows.applicationmodel.wallet.system/walletmanagersystem_requeststoreasync_428591920.md +++ b/windows.applicationmodel.wallet.system/walletmanagersystem_requeststoreasync_428591920.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.System.WalletManagerSystem.RequestStoreAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.System.WalletManagerSystem.RequestStoreAsync ## -description Requests an instance of the system wallet store for the app. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns An asynchronous operation that, on successful completion, returns an instance of the default wallet store. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [WalletItemSystemStore](walletitemsystemstore.md) object. ## -remarks ## -examples ## -see-also ## -capabilities walletSystem \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.System.WalletManagerSystem.RequestStoreAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.System.WalletManagerSystem.RequestStoreAsync + +## -description +Requests an instance of the system wallet store for the app. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +An asynchronous operation that, on successful completion, returns an instance of the default wallet store. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [WalletItemSystemStore](walletitemsystemstore.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +walletSystem \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletbarcode_getimageasync_1312294964.md b/windows.applicationmodel.wallet/walletbarcode_getimageasync_1312294964.md index 058753b4f3..cba81b0994 100644 --- a/windows.applicationmodel.wallet/walletbarcode_getimageasync_1312294964.md +++ b/windows.applicationmodel.wallet/walletbarcode_getimageasync_1312294964.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletBarcode.GetImageAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletBarcode.GetImageAsync ## -description Creates and returns a bitmap image stream for the barcode (or returns the custom image used during instantiation). ## -returns An asynchronous operation. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type on successful completion is an [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) instance. This can be assigned as the source for an image (with some additional code). ## -remarks If the [WalletBarcode](walletbarcode.md) object was instantiated using the [WalletBarcode](walletbarcode_walletbarcode_199548425.md) constructor that takes a custom image as a parameter, that custom image is returned on completion. Otherwise, an image of the system-defined barcode is created and then returned. This method doesn't literally return an image object that's ready for UI, it returns a stream that defines a bitmap image. To actually set an image in JavaScript, you can use code similar to this:```javascript var awns = Windows.ApplicationModel.Wallet; var wbc = new awns.WalletBarcode(awns.WalletBarcodeSymbology.qr, "123123123123"); wbc.getImageAsync().done(function (img) { if (img) { var img1 = document.getElementById("img1"); //existing tag in this script's scope img.openReadAsync().done(function (blob) { var stream = MSApp.createStreamFromInputStream("image/bmp", blob); img1.src = URL.createObjectURL(stream); }) } }); ``` ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Asynchronous programming in JavaScript](http://msdn.microsoft.com/library/b1544667-77f5-4269-8d58-ad81d3ca5dcf) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletBarcode.GetImageAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletBarcode.GetImageAsync + +## -description +Creates and returns a bitmap image stream for the barcode (or returns the custom image used during instantiation). + +## -returns +An asynchronous operation. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type on successful completion is an [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) instance. This can be assigned as the source for an image (with some additional code). + +## -remarks +If the [WalletBarcode](walletbarcode.md) object was instantiated using the [WalletBarcode](walletbarcode_walletbarcode_199548425.md) constructor that takes a custom image as a parameter, that custom image is returned on completion. Otherwise, an image of the system-defined barcode is created and then returned. + +This method doesn't literally return an image object that's ready for UI, it returns a stream that defines a bitmap image. To actually set an image in JavaScript, you can use code similar to this:```javascript +var awns = Windows.ApplicationModel.Wallet; +var wbc = new awns.WalletBarcode(awns.WalletBarcodeSymbology.qr, "123123123123"); +wbc.getImageAsync().done(function (img) { + if (img) { + var img1 = document.getElementById("img1"); //existing tag in this script's scope + img.openReadAsync().done(function (blob) { + var stream = MSApp.createStreamFromInputStream("image/bmp", blob); + img1.src = URL.createObjectURL(stream); + }) + } +}); +``` + + + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Asynchronous programming in JavaScript](http://msdn.microsoft.com/library/b1544667-77f5-4269-8d58-ad81d3ca5dcf) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletbarcode_symbology.md b/windows.applicationmodel.wallet/walletbarcode_symbology.md index 324a2ad16c..0ff3f3a066 100644 --- a/windows.applicationmodel.wallet/walletbarcode_symbology.md +++ b/windows.applicationmodel.wallet/walletbarcode_symbology.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletBarcode.Symbology --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletBarcode.Symbology ## -description Gets the [symbology](walletbarcodesymbology.md) used by the bar code. ## -property-value The bar code's symbology. ## -remarks A *symbology* is the convention that defines the mapping between barcodes and the messages they represent. Barcodes for wallet items support several of the most common barcode symbologies, as defined by the values in [WalletBarcodeSymbology](walletbarcodesymbology.md). For other symbologies, you can provide your own barcode image (construct using [WalletBarcode(IRandomAccessStreamReference)](walletbarcode_walletbarcode_199548425.md)). ## -examples ## -see-also [WalletItem.Barcode](walletitem_barcode.md), [WalletBarcodeSymbology](walletbarcodesymbology.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletBarcode.Symbology +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletBarcode.Symbology + +## -description +Gets the [symbology](walletbarcodesymbology.md) used by the bar code. + +## -property-value +The bar code's symbology. + +## -remarks +A *symbology* is the convention that defines the mapping between barcodes and the messages they represent. Barcodes for wallet items support several of the most common barcode symbologies, as defined by the values in [WalletBarcodeSymbology](walletbarcodesymbology.md). For other symbologies, you can provide your own barcode image (construct using [WalletBarcode(IRandomAccessStreamReference)](walletbarcode_walletbarcode_199548425.md)). + + +## -examples + +## -see-also +[WalletItem.Barcode](walletitem_barcode.md), [WalletBarcodeSymbology](walletbarcodesymbology.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletbarcode_value.md b/windows.applicationmodel.wallet/walletbarcode_value.md index 2a9b585085..5730f44c3e 100644 --- a/windows.applicationmodel.wallet/walletbarcode_value.md +++ b/windows.applicationmodel.wallet/walletbarcode_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletBarcode.Value --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletBarcode.Value ## -description Gets a string representation of the barcode (its message). ## -property-value The string representation of the barcode, which is the data message that the barcode represents. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletBarcode.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletBarcode.Value + +## -description +Gets a string representation of the barcode (its message). + +## -property-value +The string representation of the barcode, which is the data message that the barcode represents. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletbarcode_walletbarcode_199548425.md b/windows.applicationmodel.wallet/walletbarcode_walletbarcode_199548425.md index 48ce1d6d74..d3e1c7978b 100644 --- a/windows.applicationmodel.wallet/walletbarcode_walletbarcode_199548425.md +++ b/windows.applicationmodel.wallet/walletbarcode_walletbarcode_199548425.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletBarcode.#ctor(Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletBarcode.WalletBarcode ## -description Initializes a new instance of the [WalletBarcode](walletbarcode.md) class. ## -parameters ### -param streamToBarcodeImage A stream representing the bar code image. ## -remarks ## -examples ## -see-also [WalletBarcode(WalletBarcodeSymbology, String)](walletbarcode_walletbarcode_30902746.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletBarcode.#ctor(Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletBarcode.WalletBarcode + +## -description +Initializes a new instance of the [WalletBarcode](walletbarcode.md) class. + +## -parameters +### -param streamToBarcodeImage +A stream representing the bar code image. + +## -remarks + +## -examples + +## -see-also +[WalletBarcode(WalletBarcodeSymbology, String)](walletbarcode_walletbarcode_30902746.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletbarcode_walletbarcode_30902746.md b/windows.applicationmodel.wallet/walletbarcode_walletbarcode_30902746.md index f6b88903ef..2d054817aa 100644 --- a/windows.applicationmodel.wallet/walletbarcode_walletbarcode_30902746.md +++ b/windows.applicationmodel.wallet/walletbarcode_walletbarcode_30902746.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletBarcode.#ctor(Windows.ApplicationModel.Wallet.WalletBarcodeSymbology,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletBarcode.WalletBarcode ## -description Initializes a new instance of the [WalletBarcode](walletbarcode.md) class. ## -parameters ### -param symbology The symbology type for this barcode. Use one of the supported symbologies, such as **Upca**. Don't set to **Invalid** or **Custom**. ### -param value The message ([Value](walletbarcode_value.md)) that the barcode represents. ## -remarks ## -examples ## -see-also [WalletBarcode(IRandomAccessStreamReference)](walletbarcode_walletbarcode_199548425.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletBarcode.#ctor(Windows.ApplicationModel.Wallet.WalletBarcodeSymbology,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletBarcode.WalletBarcode + +## -description +Initializes a new instance of the [WalletBarcode](walletbarcode.md) class. + +## -parameters +### -param symbology +The symbology type for this barcode. Use one of the supported symbologies, such as **Upca**. Don't set to **Invalid** or **Custom**. + +### -param value +The message ([Value](walletbarcode_value.md)) that the barcode represents. + +## -remarks + +## -examples + +## -see-also +[WalletBarcode(IRandomAccessStreamReference)](walletbarcode_walletbarcode_199548425.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_barcode.md b/windows.applicationmodel.wallet/walletitem_barcode.md index bef08d00d6..f8a623fc01 100644 --- a/windows.applicationmodel.wallet/walletitem_barcode.md +++ b/windows.applicationmodel.wallet/walletitem_barcode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Barcode --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Barcode ## -description Gets or sets the barcode that's representative of the wallet item. ## -property-value The barcode of the item. ## -remarks ## -examples ## -see-also [WalletBarcode](walletbarcode.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Barcode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Barcode + +## -description +Gets or sets the barcode that's representative of the wallet item. + +## -property-value +The barcode of the item. + +## -remarks + +## -examples + +## -see-also +[WalletBarcode](walletbarcode.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_bodybackgroundimage.md b/windows.applicationmodel.wallet/walletitem_bodybackgroundimage.md index 6674d21a08..ad96bd8666 100644 --- a/windows.applicationmodel.wallet/walletitem_bodybackgroundimage.md +++ b/windows.applicationmodel.wallet/walletitem_bodybackgroundimage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.BodyBackgroundImage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.BodyBackgroundImage ## -description Gets or sets the background image of the body of the wallet item (uses a stream). ## -property-value The background image of the body of the wallet item. This is a stream that contains the bitmap image. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.BodyBackgroundImage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.BodyBackgroundImage + +## -description +Gets or sets the background image of the body of the wallet item (uses a stream). + +## -property-value +The background image of the body of the wallet item. This is a stream that contains the bitmap image. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_bodycolor.md b/windows.applicationmodel.wallet/walletitem_bodycolor.md index 01c7979c99..8137d625ef 100644 --- a/windows.applicationmodel.wallet/walletitem_bodycolor.md +++ b/windows.applicationmodel.wallet/walletitem_bodycolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.BodyColor --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.BodyColor ## -description Gets or sets the body color of the wallet item. ## -property-value The body color of the item. ## -remarks ## -examples ## -see-also [Color](../windows.ui/color.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.BodyColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.BodyColor + +## -description +Gets or sets the body color of the wallet item. + +## -property-value +The body color of the item. + +## -remarks + +## -examples + +## -see-also +[Color](../windows.ui/color.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_bodyfontcolor.md b/windows.applicationmodel.wallet/walletitem_bodyfontcolor.md index 0cb3d58cad..8b49ad5488 100644 --- a/windows.applicationmodel.wallet/walletitem_bodyfontcolor.md +++ b/windows.applicationmodel.wallet/walletitem_bodyfontcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.BodyFontColor --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.BodyFontColor ## -description Gets or sets the body font color of the wallet item. ## -property-value The body font color of the item. ## -remarks ## -examples ## -see-also [Color](../windows.ui/color.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.BodyFontColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.BodyFontColor + +## -description +Gets or sets the body font color of the wallet item. + +## -property-value +The body font color of the item. + +## -remarks + +## -examples + +## -see-also +[Color](../windows.ui/color.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_displaymessage.md b/windows.applicationmodel.wallet/walletitem_displaymessage.md index f3bf8a97c1..583744a6d0 100644 --- a/windows.applicationmodel.wallet/walletitem_displaymessage.md +++ b/windows.applicationmodel.wallet/walletitem_displaymessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.DisplayMessage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.DisplayMessage ## -description Gets or sets a string that appears next to the app name in **About** info. ## -property-value A string that appears next to the app name in the **About** info associated with a wallet item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.DisplayMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.DisplayMessage + +## -description +Gets or sets a string that appears next to the app name in **About** info. + +## -property-value +A string that appears next to the app name in the **About** info associated with a wallet item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_displayname.md b/windows.applicationmodel.wallet/walletitem_displayname.md index 71ad00023c..fdea66047c 100644 --- a/windows.applicationmodel.wallet/walletitem_displayname.md +++ b/windows.applicationmodel.wallet/walletitem_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.DisplayName ## -description Gets or sets the name or title to be displayed to the user. ## -property-value The display name of the wallet item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.DisplayName + +## -description +Gets or sets the name or title to be displayed to the user. + +## -property-value +The display name of the wallet item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_displayproperties.md b/windows.applicationmodel.wallet/walletitem_displayproperties.md index ec3d95678d..0a92bbe2a6 100644 --- a/windows.applicationmodel.wallet/walletitem_displayproperties.md +++ b/windows.applicationmodel.wallet/walletitem_displayproperties.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.DisplayProperties --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.DisplayProperties ## -description Gets the collection of [WalletItemCustomProperty](walletitemcustomproperty.md) objects associated with the wallet item. ## -property-value The collection of [WalletItemCustomProperty](walletitemcustomproperty.md) objects associated with the wallet item. ## -remarks The key for the [DisplayProperties](walletitem_displayproperties.md) map is typically not used for the user UI. It's a programming identifier that you use to distinguish the individual custom properties. That identifier isn't part of the construction of a [WalletItemCustomProperty](walletitemcustomproperty.md); you choose it when you add one of the custom properties to the [DisplayProperties](walletitem_displayproperties.md) collection. ## -examples ## -see-also [WalletItemCustomProperty](walletitemcustomproperty.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.DisplayProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.DisplayProperties + +## -description +Gets the collection of [WalletItemCustomProperty](walletitemcustomproperty.md) objects associated with the wallet item. + +## -property-value +The collection of [WalletItemCustomProperty](walletitemcustomproperty.md) objects associated with the wallet item. + +## -remarks +The key for the [DisplayProperties](walletitem_displayproperties.md) map is typically not used for the user UI. It's a programming identifier that you use to distinguish the individual custom properties. That identifier isn't part of the construction of a [WalletItemCustomProperty](walletitemcustomproperty.md); you choose it when you add one of the custom properties to the [DisplayProperties](walletitem_displayproperties.md) collection. + +## -examples + +## -see-also +[WalletItemCustomProperty](walletitemcustomproperty.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_expirationdate.md b/windows.applicationmodel.wallet/walletitem_expirationdate.md index a2bf438e65..f7d4952a4c 100644 --- a/windows.applicationmodel.wallet/walletitem_expirationdate.md +++ b/windows.applicationmodel.wallet/walletitem_expirationdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.ExpirationDate --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.ExpirationDate ## -description Gets or sets the expiration date of the wallet item. ## -property-value The expiration date of the item. Can be **null** (the default). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.ExpirationDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.ExpirationDate + +## -description +Gets or sets the expiration date of the wallet item. + +## -property-value +The expiration date of the item. Can be **null** (the default). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_headerbackgroundimage.md b/windows.applicationmodel.wallet/walletitem_headerbackgroundimage.md index bab560603a..34c9a08324 100644 --- a/windows.applicationmodel.wallet/walletitem_headerbackgroundimage.md +++ b/windows.applicationmodel.wallet/walletitem_headerbackgroundimage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.HeaderBackgroundImage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.HeaderBackgroundImage ## -description Gets or sets the header background image of the wallet item. ## -property-value The header background image of the item. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.HeaderBackgroundImage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.HeaderBackgroundImage + +## -description +Gets or sets the header background image of the wallet item. + +## -property-value +The header background image of the item. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_headercolor.md b/windows.applicationmodel.wallet/walletitem_headercolor.md index 0bc07fcce5..3200267244 100644 --- a/windows.applicationmodel.wallet/walletitem_headercolor.md +++ b/windows.applicationmodel.wallet/walletitem_headercolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.HeaderColor --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.HeaderColor ## -description Gets or sets the header color of the wallet item. ## -property-value The header color of the item. ## -remarks ## -examples ## -see-also [Color](../windows.ui/color.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.HeaderColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.HeaderColor + +## -description +Gets or sets the header color of the wallet item. + +## -property-value +The header color of the item. + +## -remarks + +## -examples + +## -see-also +[Color](../windows.ui/color.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_headerfontcolor.md b/windows.applicationmodel.wallet/walletitem_headerfontcolor.md index 0da0836969..e28895e7c5 100644 --- a/windows.applicationmodel.wallet/walletitem_headerfontcolor.md +++ b/windows.applicationmodel.wallet/walletitem_headerfontcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.HeaderFontColor --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.HeaderFontColor ## -description Gets or sets the header font color of the wallet item. ## -property-value The header font color of the item. ## -remarks ## -examples ## -see-also [Color](../windows.ui/color.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.HeaderFontColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.HeaderFontColor + +## -description +Gets or sets the header font color of the wallet item. + +## -property-value +The header font color of the item. + +## -remarks + +## -examples + +## -see-also +[Color](../windows.ui/color.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_id.md b/windows.applicationmodel.wallet/walletitem_id.md index c1a2399590..2a273b964f 100644 --- a/windows.applicationmodel.wallet/walletitem_id.md +++ b/windows.applicationmodel.wallet/walletitem_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Id --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Id ## -description Gets the unique identifier of the wallet item. ## -property-value The unique identifier of the wallet item. This usually isn't displayed in UI. This might be the same value as was used for the [Value](walletbarcode_value.md) of the [Barcode](walletitem_barcode.md), but that's up to the implementation (yours or the wallet item provider). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Id + +## -description +Gets the unique identifier of the wallet item. + +## -property-value +The unique identifier of the wallet item. This usually isn't displayed in UI. This might be the same value as was used for the [Value](walletbarcode_value.md) of the [Barcode](walletitem_barcode.md), but that's up to the implementation (yours or the wallet item provider). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_isacknowledged.md b/windows.applicationmodel.wallet/walletitem_isacknowledged.md index 35005f9bc8..0193272ed5 100644 --- a/windows.applicationmodel.wallet/walletitem_isacknowledged.md +++ b/windows.applicationmodel.wallet/walletitem_isacknowledged.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IsAcknowledged --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.IsAcknowledged ## -description Gets or sets whether this item is acknowledged by the app. ## -property-value **false** if the item is new to the app (the default); Otherwise, **true**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IsAcknowledged +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.IsAcknowledged + +## -description +Gets or sets whether this item is acknowledged by the app. + +## -property-value +**false** if the item is new to the app (the default); Otherwise, **true**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_isdisplaymessagelaunchable.md b/windows.applicationmodel.wallet/walletitem_isdisplaymessagelaunchable.md index 79909665c5..4ea5495078 100644 --- a/windows.applicationmodel.wallet/walletitem_isdisplaymessagelaunchable.md +++ b/windows.applicationmodel.wallet/walletitem_isdisplaymessagelaunchable.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IsDisplayMessageLaunchable --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.IsDisplayMessageLaunchable ## -description Gets or sets whether to launch your app when the user taps on the [DisplayMessage](walletitem_displaymessage.md). ## -property-value **true** if your app should launch when the users taps on the display message; Otherwise, **false**; ## -remarks ## -examples ## -see-also [WalletActionActivatedEventArgs](../windows.applicationmodel.activation/walletactionactivatedeventargs.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IsDisplayMessageLaunchable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.IsDisplayMessageLaunchable + +## -description +Gets or sets whether to launch your app when the user taps on the [DisplayMessage](walletitem_displaymessage.md). + +## -property-value +**true** if your app should launch when the users taps on the display message; Otherwise, **false**; + +## -remarks + +## -examples + +## -see-also +[WalletActionActivatedEventArgs](../windows.applicationmodel.activation/walletactionactivatedeventargs.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_ismoretransactionhistorylaunchable.md b/windows.applicationmodel.wallet/walletitem_ismoretransactionhistorylaunchable.md index de3597c4cb..9a54be4149 100644 --- a/windows.applicationmodel.wallet/walletitem_ismoretransactionhistorylaunchable.md +++ b/windows.applicationmodel.wallet/walletitem_ismoretransactionhistorylaunchable.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IsMoreTransactionHistoryLaunchable --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.IsMoreTransactionHistoryLaunchable ## -description Gets or sets whether your app should be launched when the user taps "see more transaction history". ## -property-value **true** if your app should be launched when the user taps on "see more transaction history", Otherwise, **false**. ## -remarks For more info on using **Wallet** activation, see the "Handling app activation by Wallet " section of [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7). ## -examples ## -see-also [WalletActionActivatedEventArgs](../windows.applicationmodel.activation/walletactionactivatedeventargs.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IsMoreTransactionHistoryLaunchable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.IsMoreTransactionHistoryLaunchable + +## -description +Gets or sets whether your app should be launched when the user taps "see more transaction history". + +## -property-value +**true** if your app should be launched when the user taps on "see more transaction history", Otherwise, **false**. + +## -remarks +For more info on using **Wallet** activation, see the "Handling app activation by Wallet " section of [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7). + +## -examples + +## -see-also +[WalletActionActivatedEventArgs](../windows.applicationmodel.activation/walletactionactivatedeventargs.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_issuerdisplayname.md b/windows.applicationmodel.wallet/walletitem_issuerdisplayname.md index 8a46040f2f..69edb46504 100644 --- a/windows.applicationmodel.wallet/walletitem_issuerdisplayname.md +++ b/windows.applicationmodel.wallet/walletitem_issuerdisplayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IssuerDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.IssuerDisplayName ## -description Gets or sets the issuer name of the wallet item. ## -property-value The issuer name of the wallet item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.IssuerDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.IssuerDisplayName + +## -description +Gets or sets the issuer name of the wallet item. + +## -property-value +The issuer name of the wallet item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_kind.md b/windows.applicationmodel.wallet/walletitem_kind.md index aa238e21ce..01323b69ba 100644 --- a/windows.applicationmodel.wallet/walletitem_kind.md +++ b/windows.applicationmodel.wallet/walletitem_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Kind --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Kind ## -description Gets the type of the wallet item. ## -property-value The type of the item, as a value of the enumeration. ## -remarks ## -examples ## -see-also [WalletItemKind](walletitemkind.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Kind + +## -description +Gets the type of the wallet item. + +## -property-value +The type of the item, as a value of the enumeration. + +## -remarks + +## -examples + +## -see-also +[WalletItemKind](walletitemkind.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_lastupdated.md b/windows.applicationmodel.wallet/walletitem_lastupdated.md index fe21a66311..0e46fd18ba 100644 --- a/windows.applicationmodel.wallet/walletitem_lastupdated.md +++ b/windows.applicationmodel.wallet/walletitem_lastupdated.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.LastUpdated --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.LastUpdated ## -description Gets or sets the date and time the data for this item was last updated. ## -property-value The date and time the data for this item was last updated. Can be **null** (the default). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.LastUpdated +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.LastUpdated + +## -description +Gets or sets the date and time the data for this item was last updated. + +## -property-value +The date and time the data for this item was last updated. Can be **null** (the default). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_logo159x159.md b/windows.applicationmodel.wallet/walletitem_logo159x159.md index bf44a63ed8..2915282d0c 100644 --- a/windows.applicationmodel.wallet/walletitem_logo159x159.md +++ b/windows.applicationmodel.wallet/walletitem_logo159x159.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Logo159x159 --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Logo159x159 ## -description Gets or sets the medium (159 x 159) logo image of the wallet item. ## -property-value The medium logo of the item, represented as a stream. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Logo159x159 +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Logo159x159 + +## -description +Gets or sets the medium (159 x 159) logo image of the wallet item. + +## -property-value +The medium logo of the item, represented as a stream. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_logo336x336.md b/windows.applicationmodel.wallet/walletitem_logo336x336.md index 6e488d574e..e3990f1575 100644 --- a/windows.applicationmodel.wallet/walletitem_logo336x336.md +++ b/windows.applicationmodel.wallet/walletitem_logo336x336.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Logo336x336 --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Logo336x336 ## -description Gets or sets the large (336 x 336) logo image of the wallet item. ## -property-value The large logo of the item, represented as a stream. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Logo336x336 +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Logo336x336 + +## -description +Gets or sets the large (336 x 336) logo image of the wallet item. + +## -property-value +The large logo of the item, represented as a stream. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_logo99x99.md b/windows.applicationmodel.wallet/walletitem_logo99x99.md index 8878cb654b..6869d24584 100644 --- a/windows.applicationmodel.wallet/walletitem_logo99x99.md +++ b/windows.applicationmodel.wallet/walletitem_logo99x99.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Logo99x99 --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Logo99x99 ## -description Gets or sets the small (99 x 99) logo image of the wallet item. ## -property-value The small logo image of the item, represented as a stream. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Logo99x99 +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Logo99x99 + +## -description +Gets or sets the small (99 x 99) logo image of the wallet item. + +## -property-value +The small logo image of the item, represented as a stream. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_logoimage.md b/windows.applicationmodel.wallet/walletitem_logoimage.md index 53133c2cf3..5646991c40 100644 --- a/windows.applicationmodel.wallet/walletitem_logoimage.md +++ b/windows.applicationmodel.wallet/walletitem_logoimage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.LogoImage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.LogoImage ## -description Gets or sets the logo image of the wallet item. Use this property for a logo that doesn't have a specified size. ## -property-value The logo image of the wallet item, represented as a stream. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.LogoImage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.LogoImage + +## -description +Gets or sets the logo image of the wallet item. Use this property for a logo that doesn't have a specified size. + +## -property-value +The logo image of the wallet item, represented as a stream. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_logotext.md b/windows.applicationmodel.wallet/walletitem_logotext.md index bd53a64767..33a9e7b131 100644 --- a/windows.applicationmodel.wallet/walletitem_logotext.md +++ b/windows.applicationmodel.wallet/walletitem_logotext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.LogoText --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.LogoText ## -description Gets or sets the logo text of the wallet item. ## -property-value The logo text of the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.LogoText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.LogoText + +## -description +Gets or sets the logo text of the wallet item. + +## -property-value +The logo text of the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_promotionalimage.md b/windows.applicationmodel.wallet/walletitem_promotionalimage.md index 506bf70c95..91c8212b2c 100644 --- a/windows.applicationmodel.wallet/walletitem_promotionalimage.md +++ b/windows.applicationmodel.wallet/walletitem_promotionalimage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.PromotionalImage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.PromotionalImage ## -description Gets or sets the promotional image of the wallet item. ## -property-value The promotional image of the wallet item that will be displayed on back of the card, as a stream. ## -remarks ## -examples ## -see-also [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.PromotionalImage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.PromotionalImage + +## -description +Gets or sets the promotional image of the wallet item. + +## -property-value +The promotional image of the wallet item that will be displayed on back of the card, as a stream. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md), [StorageFile.GetFileFromApplicationUriAsync](../windows.storage/storagefile_getfilefromapplicationuriasync.md), [RandomAccessStreamReference.CreateFromUri](../windows.storage.streams/randomaccessstreamreference_createfromuri.md), [RandomAccessStreamReference.CreateFromFile](../windows.storage.streams/randomaccessstreamreference_createfromfile.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_relevantdate.md b/windows.applicationmodel.wallet/walletitem_relevantdate.md index b49f8e6669..ccfed25aa3 100644 --- a/windows.applicationmodel.wallet/walletitem_relevantdate.md +++ b/windows.applicationmodel.wallet/walletitem_relevantdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.RelevantDate --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.RelevantDate ## -description Gets or sets the date on which the item is valid. ## -property-value The date on which the item is valid. Can be **null** (the default). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.RelevantDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.RelevantDate + +## -description +Gets or sets the date on which the item is valid. + +## -property-value +The date on which the item is valid. Can be **null** (the default). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_relevantdatedisplaymessage.md b/windows.applicationmodel.wallet/walletitem_relevantdatedisplaymessage.md index f33d3de459..b9d41d98c3 100644 --- a/windows.applicationmodel.wallet/walletitem_relevantdatedisplaymessage.md +++ b/windows.applicationmodel.wallet/walletitem_relevantdatedisplaymessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.RelevantDateDisplayMessage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.RelevantDateDisplayMessage ## -description Gets or sets the description of the relevant date of the wallet item. ## -property-value The description of the relevant date of the wallet item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.RelevantDateDisplayMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.RelevantDateDisplayMessage + +## -description +Gets or sets the description of the relevant date of the wallet item. + +## -property-value +The description of the relevant date of the wallet item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitem_relevantlocations.md b/windows.applicationmodel.wallet/walletitem_relevantlocations.md index a709929ca4..f438cb65a4 100644 --- a/windows.applicationmodel.wallet/walletitem_relevantlocations.md +++ b/windows.applicationmodel.wallet/walletitem_relevantlocations.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.RelevantLocations --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.RelevantLocations ## -description Gets a collection of all relevant locations for the wallet item. ## -property-value A collection of all relevant locations for the wallet item ## -remarks The string key for items in this collection is usually a programmatic identifier that isn't intended for user UI. Data within a [WalletRelevantLocation](walletrelevantlocation.md) value is sometimes intended for UI. Each [WalletRelevantLocation](walletrelevantlocation.md) value has a [Position](walletrelevantlocation_position.md) property to capture a [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) value, and associates each position with a position-specific display message. You can see example code for this in [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7). ## -examples ## -see-also [WalletRelevantLocation](walletrelevantlocation.md), [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.RelevantLocations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.RelevantLocations + +## -description +Gets a collection of all relevant locations for the wallet item. + +## -property-value +A collection of all relevant locations for the wallet item + +## -remarks +The string key for items in this collection is usually a programmatic identifier that isn't intended for user UI. Data within a [WalletRelevantLocation](walletrelevantlocation.md) value is sometimes intended for UI. + +Each [WalletRelevantLocation](walletrelevantlocation.md) value has a [Position](walletrelevantlocation_position.md) property to capture a [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) value, and associates each position with a position-specific display message. You can see example code for this in [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7). + +## -examples + +## -see-also +[WalletRelevantLocation](walletrelevantlocation.md), [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_transactionhistory.md b/windows.applicationmodel.wallet/walletitem_transactionhistory.md index 93b2283c4f..5f70ca90a5 100644 --- a/windows.applicationmodel.wallet/walletitem_transactionhistory.md +++ b/windows.applicationmodel.wallet/walletitem_transactionhistory.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.TransactionHistory --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.TransactionHistory ## -description Gets the transaction history collection of the wallet item. ## -property-value The transaction history collection of the item. This is a keyed map of [WalletTransaction](wallettransaction.md) items. ## -remarks ## -examples ## -see-also [WalletTransaction](wallettransaction.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.TransactionHistory +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.TransactionHistory + +## -description +Gets the transaction history collection of the wallet item. + +## -property-value +The transaction history collection of the item. This is a keyed map of [WalletTransaction](wallettransaction.md) items. + +## -remarks + +## -examples + +## -see-also +[WalletTransaction](wallettransaction.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_verbs.md b/windows.applicationmodel.wallet/walletitem_verbs.md index cd2247445f..30dc2fc120 100644 --- a/windows.applicationmodel.wallet/walletitem_verbs.md +++ b/windows.applicationmodel.wallet/walletitem_verbs.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Verbs --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItem.Verbs ## -description Gets the collection of [WalletVerb](walletverb.md) objects associated with the wallet item. ## -property-value The collection of [WalletVerb](walletverb.md) objects associated with the wallet item. ## -remarks ## -examples ## -see-also [WalletVerb](walletverb.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItem.Verbs +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.Verbs + +## -description +Gets the collection of [WalletVerb](walletverb.md) objects associated with the wallet item. + +## -property-value +The collection of [WalletVerb](walletverb.md) objects associated with the wallet item. + +## -remarks + +## -examples + +## -see-also +[WalletVerb](walletverb.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitem_walletitem_1121193137.md b/windows.applicationmodel.wallet/walletitem_walletitem_1121193137.md index 9921c90b4b..f1d07a030c 100644 --- a/windows.applicationmodel.wallet/walletitem_walletitem_1121193137.md +++ b/windows.applicationmodel.wallet/walletitem_walletitem_1121193137.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItem.#ctor(Windows.ApplicationModel.Wallet.WalletItemKind,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItem.WalletItem ## -description Initializes a new instance of the [WalletItem](walletitem.md) class. ## -parameters ### -param kind The type of wallet item. ### -param displayName The display name of the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItem.#ctor(Windows.ApplicationModel.Wallet.WalletItemKind,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItem.WalletItem + +## -description +Initializes a new instance of the [WalletItem](walletitem.md) class. + +## -parameters +### -param kind +The type of wallet item. + +### -param displayName +The display name of the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitemcustomproperty_autodetectlinks.md b/windows.applicationmodel.wallet/walletitemcustomproperty_autodetectlinks.md index 9e585f3b72..80468f1568 100644 --- a/windows.applicationmodel.wallet/walletitemcustomproperty_autodetectlinks.md +++ b/windows.applicationmodel.wallet/walletitemcustomproperty_autodetectlinks.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.AutoDetectLinks --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItemCustomProperty.AutoDetectLinks ## -description Gets or sets whether this [WalletItemCustomProperty](walletitemcustomproperty.md) is entity-extracted and actionable upon display. ## -property-value **true** if the [WalletItemCustomProperty](walletitemcustomproperty.md) is entity-extracted and actionable upon display; Otherwise, **false**. ## -remarks *Entity-extracted* is a term for the automatic behavior that can match strings in data to certain patterns, and automatically generate an appropriate action/behavior for that item in the UI. This technique is commonly used in e-mail applications, and is also used here for the UI logic of a wallet item display. For example, a 10-digit string where each character is a number 0-9 can be entity-extracted to represent a phone number, and the action associated is to initiate a call to that number. Because there can be false matches to the patterns, the default value is **false**, but if you know what the data and matching behavior is in your [WalletItemCustomProperty](walletitemcustomproperty.md) and you want entity-extracted behavior, set this property **true**. ## -examples ## -see-also [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.AutoDetectLinks +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemCustomProperty.AutoDetectLinks + +## -description +Gets or sets whether this [WalletItemCustomProperty](walletitemcustomproperty.md) is entity-extracted and actionable upon display. + +## -property-value +**true** if the [WalletItemCustomProperty](walletitemcustomproperty.md) is entity-extracted and actionable upon display; Otherwise, **false**. + +## -remarks +*Entity-extracted* is a term for the automatic behavior that can match strings in data to certain patterns, and automatically generate an appropriate action/behavior for that item in the UI. This technique is commonly used in e-mail applications, and is also used here for the UI logic of a wallet item display. For example, a 10-digit string where each character is a number 0-9 can be entity-extracted to represent a phone number, and the action associated is to initiate a call to that number. Because there can be false matches to the patterns, the default value is **false**, but if you know what the data and matching behavior is in your [WalletItemCustomProperty](walletitemcustomproperty.md) and you want entity-extracted behavior, set this property **true**. + +## -examples + +## -see-also +[Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemcustomproperty_detailviewposition.md b/windows.applicationmodel.wallet/walletitemcustomproperty_detailviewposition.md index faf1a479fd..7766216968 100644 --- a/windows.applicationmodel.wallet/walletitemcustomproperty_detailviewposition.md +++ b/windows.applicationmodel.wallet/walletitemcustomproperty_detailviewposition.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.DetailViewPosition --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItemCustomProperty.DetailViewPosition ## -description Gets or sets the optional position of this property when shown in the wallet item's detail view. ## -property-value The optional position of this property when shown in the wallet item's detail view, as a value of the enumeration. The default is **Hidden**. ## -remarks ## -examples ## -see-also [WalletDetailViewPosition](walletdetailviewposition.md), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.DetailViewPosition +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemCustomProperty.DetailViewPosition + +## -description +Gets or sets the optional position of this property when shown in the wallet item's detail view. + +## -property-value +The optional position of this property when shown in the wallet item's detail view, as a value of the enumeration. The default is **Hidden**. + +## -remarks + +## -examples + +## -see-also +[WalletDetailViewPosition](walletdetailviewposition.md), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemcustomproperty_name.md b/windows.applicationmodel.wallet/walletitemcustomproperty_name.md index ab3ad93aa7..b78a1abf48 100644 --- a/windows.applicationmodel.wallet/walletitemcustomproperty_name.md +++ b/windows.applicationmodel.wallet/walletitemcustomproperty_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Name --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Name ## -description Gets or sets the custom property label. ## -property-value The custom property label. ## -remarks Unlike the key for the [DisplayProperties](walletitem_displayproperties.md) collection, the [Name](walletitemcustomproperty_name.md) value of a [WalletItemCustomProperty](walletitemcustomproperty.md) object is intended for user UI. Setting the value that's reported by [Name](walletitemcustomproperty_name.md) is a required parameter when you construct a new [WalletItemCustomProperty](walletitemcustomproperty.md) (see [WalletItemCustomProperty constructor](walletitemcustomproperty_walletitemcustomproperty.md)). In most cases you won't be setting the [Name](walletitemcustomproperty_name.md) property of an existing [WalletItemCustomProperty](walletitemcustomproperty.md), as opposed to constructing a new one. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Name + +## -description +Gets or sets the custom property label. + +## -property-value +The custom property label. + +## -remarks +Unlike the key for the [DisplayProperties](walletitem_displayproperties.md) collection, the [Name](walletitemcustomproperty_name.md) value of a [WalletItemCustomProperty](walletitemcustomproperty.md) object is intended for user UI. Setting the value that's reported by [Name](walletitemcustomproperty_name.md) is a required parameter when you construct a new [WalletItemCustomProperty](walletitemcustomproperty.md) (see [WalletItemCustomProperty constructor](walletitemcustomproperty_walletitemcustomproperty.md)). In most cases you won't be setting the [Name](walletitemcustomproperty_name.md) property of an existing [WalletItemCustomProperty](walletitemcustomproperty.md), as opposed to constructing a new one. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitemcustomproperty_summaryviewposition.md b/windows.applicationmodel.wallet/walletitemcustomproperty_summaryviewposition.md index 6e4dd43b3e..6e93c2f080 100644 --- a/windows.applicationmodel.wallet/walletitemcustomproperty_summaryviewposition.md +++ b/windows.applicationmodel.wallet/walletitemcustomproperty_summaryviewposition.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.SummaryViewPosition --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItemCustomProperty.SummaryViewPosition ## -description Gets or sets the optional position of this property when shown in the summary view for a wallet item. ## -property-value The optional position of this property when shown in the summary view for a wallet item, as a value of the enumeration. The default is **Hidden**. ## -remarks ## -examples ## -see-also [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.SummaryViewPosition +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemCustomProperty.SummaryViewPosition + +## -description +Gets or sets the optional position of this property when shown in the summary view for a wallet item. + +## -property-value +The optional position of this property when shown in the summary view for a wallet item, as a value of the enumeration. The default is **Hidden**. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemcustomproperty_value.md b/windows.applicationmodel.wallet/walletitemcustomproperty_value.md index e074e92ad8..d65b288935 100644 --- a/windows.applicationmodel.wallet/walletitemcustomproperty_value.md +++ b/windows.applicationmodel.wallet/walletitemcustomproperty_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Value --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Value ## -description Gets or sets the custom property value. ## -property-value The custom property value. ## -remarks Setting the value that's reported by [Value](walletitemcustomproperty_value.md) is a required parameter when you construct a new [WalletItemCustomProperty](walletitemcustomproperty.md) (see [WalletItemCustomProperty constructor](walletitemcustomproperty_walletitemcustomproperty.md)). In most cases you won't be setting the [Value](walletitemcustomproperty_value.md) property of an existing [WalletItemCustomProperty](walletitemcustomproperty.md), as opposed to constructing a new one. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemCustomProperty.Value + +## -description +Gets or sets the custom property value. + +## -property-value +The custom property value. + +## -remarks +Setting the value that's reported by [Value](walletitemcustomproperty_value.md) is a required parameter when you construct a new [WalletItemCustomProperty](walletitemcustomproperty.md) (see [WalletItemCustomProperty constructor](walletitemcustomproperty_walletitemcustomproperty.md)). In most cases you won't be setting the [Value](walletitemcustomproperty_value.md) property of an existing [WalletItemCustomProperty](walletitemcustomproperty.md), as opposed to constructing a new one. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitemcustomproperty_walletitemcustomproperty_1571897524.md b/windows.applicationmodel.wallet/walletitemcustomproperty_walletitemcustomproperty_1571897524.md index 978bb75c05..b79535b853 100644 --- a/windows.applicationmodel.wallet/walletitemcustomproperty_walletitemcustomproperty_1571897524.md +++ b/windows.applicationmodel.wallet/walletitemcustomproperty_walletitemcustomproperty_1571897524.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.#ctor(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemCustomProperty.WalletItemCustomProperty ## -description Initializes a new instance of the [WalletItemCustomProperty](walletitemcustomproperty.md) class. ## -parameters ### -param name The custom property label. Sets the initial [Name](walletitemcustomproperty_name.md) value. ### -param value The value of the property. Sets the initial [Value](walletitemcustomproperty_value.md) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemCustomProperty.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemCustomProperty.WalletItemCustomProperty + +## -description +Initializes a new instance of the [WalletItemCustomProperty](walletitemcustomproperty.md) class. + +## -parameters +### -param name +The custom property label. Sets the initial [Name](walletitemcustomproperty_name.md) value. + +### -param value +The value of the property. Sets the initial [Value](walletitemcustomproperty_value.md) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletitemstore_addasync_928380562.md b/windows.applicationmodel.wallet/walletitemstore_addasync_928380562.md index 6ab8846e64..e651519d59 100644 --- a/windows.applicationmodel.wallet/walletitemstore_addasync_928380562.md +++ b/windows.applicationmodel.wallet/walletitemstore_addasync_928380562.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.AddAsync(System.String,Windows.ApplicationModel.Wallet.WalletItem) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.AddAsync ## -description Adds a new wallet item to the wallet. ## -parameters ### -param id The identifier of the wallet item. This value must be unique. This sets the initial [WalletItem.Id](walletitem_id.md) value (the identifier is for the [WalletItemStore](walletitemstore.md) store, and isn't part of the initialization of a [WalletItem](walletitem.md) object. ### -param item The wallet item to add to the wallet. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the return type is **void**. ## -remarks If the *id* value passed in to this method is not unique, or if the item has already been added to the wallet, an exception is thrown. How to handle errors/exceptions varies by programming language, particularly so when calling asynchronous methods. See [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e). Remember that when you call this method, the item is added to the wallet item store, which is owned by the device not the app. While you're still developing, the store persists across app sessions, and so attempting to add the same item again when running another debug session can throw an exception because the item's already there. Consider adding a call to [ClearAsync](walletitemstore_clearasync.md) before you attempt to add any items and you've run your code more than once, at least while you're still developing and testing your code. ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.AddAsync(System.String,Windows.ApplicationModel.Wallet.WalletItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.AddAsync + +## -description +Adds a new wallet item to the wallet. + +## -parameters +### -param id +The identifier of the wallet item. This value must be unique. This sets the initial [WalletItem.Id](walletitem_id.md) value (the identifier is for the [WalletItemStore](walletitemstore.md) store, and isn't part of the initialization of a [WalletItem](walletitem.md) object. + +### -param item +The wallet item to add to the wallet. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the return type is **void**. + +## -remarks +If the *id* value passed in to this method is not unique, or if the item has already been added to the wallet, an exception is thrown. How to handle errors/exceptions varies by programming language, particularly so when calling asynchronous methods. See [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e). + +Remember that when you call this method, the item is added to the wallet item store, which is owned by the device not the app. While you're still developing, the store persists across app sessions, and so attempting to add the same item again when running another debug session can throw an exception because the item's already there. Consider adding a call to [ClearAsync](walletitemstore_clearasync.md) before you attempt to add any items and you've run your code more than once, at least while you're still developing and testing your code. + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_clearasync_1031039026.md b/windows.applicationmodel.wallet/walletitemstore_clearasync_1031039026.md index 7ada8546a4..83618af28a 100644 --- a/windows.applicationmodel.wallet/walletitemstore_clearasync_1031039026.md +++ b/windows.applicationmodel.wallet/walletitemstore_clearasync_1031039026.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ClearAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.ClearAsync ## -description Clears all app-owned wallet items from the wallet data store. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. ## -remarks ## -examples ## -see-also [WalletItem](walletitem.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ClearAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.ClearAsync + +## -description +Clears all app-owned wallet items from the wallet data store. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. + +## -remarks + +## -examples + +## -see-also +[WalletItem](walletitem.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_deleteasync_333495081.md b/windows.applicationmodel.wallet/walletitemstore_deleteasync_333495081.md index a5829d8635..abc7582211 100644 --- a/windows.applicationmodel.wallet/walletitemstore_deleteasync_333495081.md +++ b/windows.applicationmodel.wallet/walletitemstore_deleteasync_333495081.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.DeleteAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.DeleteAsync ## -description Removes a specific wallet item with the given ID from the wallet data store. ## -parameters ### -param id The ID of the wallet item to remove from the data store. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. ## -remarks ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.DeleteAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.DeleteAsync + +## -description +Removes a specific wallet item with the given ID from the wallet data store. + +## -parameters +### -param id +The ID of the wallet item to remove from the data store. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. + +## -remarks + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_getitemsasync_1518547059.md b/windows.applicationmodel.wallet/walletitemstore_getitemsasync_1518547059.md index 31fab6d952..26d233630f 100644 --- a/windows.applicationmodel.wallet/walletitemstore_getitemsasync_1518547059.md +++ b/windows.applicationmodel.wallet/walletitemstore_getitemsasync_1518547059.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync ## -description Returns the collection of all wallet items owned by this app. ## -returns An asynchronous operation that, on successful completion, returns the collection of wallet items accessible by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [WalletItem](walletitem.md) items. (You can use APIs of [IVectorView<WalletItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<WalletItem>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) ## -remarks ## -examples ## -see-also [WalletItem](walletitem.md), [GetItemsAsync(WalletItemKind)](walletitemstore_getitemsasync_476546386.md), [IVectorView<T>](../windows.foundation.collections/ivectorview_1.md), [IReadOnlyList<T>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync + +## -description +Returns the collection of all wallet items owned by this app. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of wallet items accessible by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [WalletItem](walletitem.md) items. (You can use APIs of [IVectorView<WalletItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<WalletItem>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) + +## -remarks + +## -examples + +## -see-also +[WalletItem](walletitem.md), [GetItemsAsync(WalletItemKind)](walletitemstore_getitemsasync_476546386.md), [IVectorView<T>](../windows.foundation.collections/ivectorview_1.md), [IReadOnlyList<T>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_getitemsasync_476546386.md b/windows.applicationmodel.wallet/walletitemstore_getitemsasync_476546386.md index b772354100..5ad2b86635 100644 --- a/windows.applicationmodel.wallet/walletitemstore_getitemsasync_476546386.md +++ b/windows.applicationmodel.wallet/walletitemstore_getitemsasync_476546386.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync(Windows.ApplicationModel.Wallet.WalletItemKind) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync ## -description Returns the collection of wallet items of the given type that are owned by this app. ## -parameters ### -param kind The type of wallet item to retrieve. ## -returns An asynchronous operation that, on successful completion, returns the collection of wallet items of the specified type that are accessible by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [WalletItem](walletitem.md) items. (You can use APIs of [IVectorView<WalletItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<WalletItem>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) ## -remarks ## -examples ## -see-also [GetItemsAsync()](walletitemstore_getitemsasync_1518547059.md), [WalletItem](walletitem.md), [GetItemsAsync(WalletItemKind)](walletitemstore_getitemsasync_476546386.md), [IVectorView<T>](../windows.foundation.collections/ivectorview_1.md), [IReadOnlyList<T>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync(Windows.ApplicationModel.Wallet.WalletItemKind) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.GetItemsAsync + +## -description +Returns the collection of wallet items of the given type that are owned by this app. + +## -parameters +### -param kind +The type of wallet item to retrieve. + +## -returns +An asynchronous operation that, on successful completion, returns the collection of wallet items of the specified type that are accessible by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a read-only list/vector of [WalletItem](walletitem.md) items. (You can use APIs of [IVectorView<WalletItem>](../windows.foundation.collections/ivectorview_1.md) for C++ or JavaScript, APIs of [IReadOnlyList<WalletItem>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) for .NET.) + +## -remarks + +## -examples + +## -see-also +[GetItemsAsync()](walletitemstore_getitemsasync_1518547059.md), [WalletItem](walletitem.md), [GetItemsAsync(WalletItemKind)](walletitemstore_getitemsasync_476546386.md), [IVectorView<T>](../windows.foundation.collections/ivectorview_1.md), [IReadOnlyList<T>](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_getwalletitemasync_998830941.md b/windows.applicationmodel.wallet/walletitemstore_getwalletitemasync_998830941.md index ac460ec15a..a5ca96509e 100644 --- a/windows.applicationmodel.wallet/walletitemstore_getwalletitemasync_998830941.md +++ b/windows.applicationmodel.wallet/walletitemstore_getwalletitemasync_998830941.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.GetWalletItemAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.GetWalletItemAsync ## -description Gets an individual wallet item with the given ID from the wallet database. The item requested must be owned by this app. ## -parameters ### -param id The ID of the wallet item. ## -returns An asynchronous operation that, on successful completion, returns the wallet item with the specified ID that is owned by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [WalletItem](walletitem.md). If an item with the specified ID cannot be found for this app in the current [WalletItemStore](walletitemstore.md) or if the item isn't owned by this app, the result is **null**. ## -remarks ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.GetWalletItemAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.GetWalletItemAsync + +## -description +Gets an individual wallet item with the given ID from the wallet database. The item requested must be owned by this app. + +## -parameters +### -param id +The ID of the wallet item. + +## -returns +An asynchronous operation that, on successful completion, returns the wallet item with the specified ID that is owned by this app. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [WalletItem](walletitem.md). If an item with the specified ID cannot be found for this app in the current [WalletItemStore](walletitemstore.md) or if the item isn't owned by this app, the result is **null**. + +## -remarks + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_importitemasync_245701098.md b/windows.applicationmodel.wallet/walletitemstore_importitemasync_245701098.md index 3b6c5efb40..81ba9171d3 100644 --- a/windows.applicationmodel.wallet/walletitemstore_importitemasync_245701098.md +++ b/windows.applicationmodel.wallet/walletitemstore_importitemasync_245701098.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ImportItemAsync(Windows.Storage.Streams.IRandomAccessStreamReference) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.ImportItemAsync ## -description Imports data from a ".mswallet" XML file into the wallet store.".mswallet" is an XML serialization format for wallet item info. For a guide to the ".mswallet" format (and a link to schema in XSD), see [Quickstart: Creating and distributing .mswallet files](http://msdn.microsoft.com/library/44575995-b45d-4458-b0ac-36dc0df373aa). ## -parameters ### -param stream The ".mswallet" file to import. ## -returns An asynchronous operation that, on successful completion, returns the wallet item that was imported into the wallet. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type on successful completion is a single [WalletItem](walletitem.md). ## -remarks ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Quickstart: Creating and distributing .mswallet files](http://msdn.microsoft.com/library/44575995-b45d-4458-b0ac-36dc0df373aa), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ImportItemAsync(Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.ImportItemAsync + +## -description +Imports data from a ".mswallet" XML file into the wallet store.".mswallet" is an XML serialization format for wallet item info. For a guide to the ".mswallet" format (and a link to schema in XSD), see [Quickstart: Creating and distributing .mswallet files](http://msdn.microsoft.com/library/44575995-b45d-4458-b0ac-36dc0df373aa). + +## -parameters +### -param stream +The ".mswallet" file to import. + +## -returns +An asynchronous operation that, on successful completion, returns the wallet item that was imported into the wallet. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type on successful completion is a single [WalletItem](walletitem.md). + +## -remarks + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), [Quickstart: Creating and distributing .mswallet files](http://msdn.microsoft.com/library/44575995-b45d-4458-b0ac-36dc0df373aa), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_showasync_1068188254.md b/windows.applicationmodel.wallet/walletitemstore_showasync_1068188254.md index 33062c9525..bac07e471e 100644 --- a/windows.applicationmodel.wallet/walletitemstore_showasync_1068188254.md +++ b/windows.applicationmodel.wallet/walletitemstore_showasync_1068188254.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync ## -description Displays the item with the given ID in the Wallet UI. ## -parameters ### -param id The ID of the item to display. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. ## -remarks ## -examples ## -see-also [ShowAsync](walletitemstore_showasync_1714076542.md), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync + +## -description +Displays the item with the given ID in the Wallet UI. + +## -parameters +### -param id +The ID of the item to display. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. + +## -remarks + +## -examples + +## -see-also +[ShowAsync](walletitemstore_showasync_1714076542.md), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_showasync_1714076542.md b/windows.applicationmodel.wallet/walletitemstore_showasync_1714076542.md index 72ea055310..1e7e4db91f 100644 --- a/windows.applicationmodel.wallet/walletitemstore_showasync_1714076542.md +++ b/windows.applicationmodel.wallet/walletitemstore_showasync_1714076542.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync ## -description Displays the Wallet UI. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. ## -remarks ## -examples ## -see-also [ShowAsync(String)](walletitemstore_showasync_1068188254.md), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.ShowAsync + +## -description +Displays the Wallet UI. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. + +## -remarks + +## -examples + +## -see-also +[ShowAsync(String)](walletitemstore_showasync_1068188254.md), [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletitemstore_updateasync_1403447975.md b/windows.applicationmodel.wallet/walletitemstore_updateasync_1403447975.md index 671febfbab..1763be1752 100644 --- a/windows.applicationmodel.wallet/walletitemstore_updateasync_1403447975.md +++ b/windows.applicationmodel.wallet/walletitemstore_updateasync_1403447975.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.UpdateAsync(Windows.ApplicationModel.Wallet.WalletItem) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletItemStore.UpdateAsync ## -description Updates a wallet item in the shared store, based on the changed values in the [WalletItem](walletitem.md) object provided. ## -parameters ### -param item The updated data for the wallet item. ## -returns An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. ## -remarks An exception is thrown if the item doesn't already exist in the wallet. How to handle errors/exceptions varies by programming language, particularly so when calling asynchronous methods. See [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e). Most of the APIs for this class can be seen in example usages in the [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) topic. ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletItemStore.UpdateAsync(Windows.ApplicationModel.Wallet.WalletItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletItemStore.UpdateAsync + +## -description +Updates a wallet item in the shared store, based on the changed values in the [WalletItem](walletitem.md) object provided. + +## -parameters +### -param item +The updated data for the wallet item. + +## -returns +An asynchronous action. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is **void**. + +## -remarks +An exception is thrown if the item doesn't already exist in the wallet. How to handle errors/exceptions varies by programming language, particularly so when calling asynchronous methods. See [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e). + +Most of the APIs for this class can be seen in example usages in the [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) topic. + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletmanager_requeststoreasync_428591920.md b/windows.applicationmodel.wallet/walletmanager_requeststoreasync_428591920.md index cd4cb52e72..8d660bcfea 100644 --- a/windows.applicationmodel.wallet/walletmanager_requeststoreasync_428591920.md +++ b/windows.applicationmodel.wallet/walletmanager_requeststoreasync_428591920.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletManager.RequestStoreAsync --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletManager.RequestStoreAsync ## -description Requests an instance of the default wallet store for the app. ## -returns An asynchronous operation that, on successful completion, returns an instance of the default wallet store. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [WalletItemStore](walletitemstore.md) object. ## -remarks ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletManager.RequestStoreAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletManager.RequestStoreAsync + +## -description +Requests an instance of the default wallet store for the app. + +## -returns +An asynchronous operation that, on successful completion, returns an instance of the default wallet store. If you use [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), the result type is a single [WalletItemStore](walletitemstore.md) object. + +## -remarks + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletrelevantlocation_displaymessage.md b/windows.applicationmodel.wallet/walletrelevantlocation_displaymessage.md index 61acd1c042..8be0569537 100644 --- a/windows.applicationmodel.wallet/walletrelevantlocation_displaymessage.md +++ b/windows.applicationmodel.wallet/walletrelevantlocation_displaymessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletRelevantLocation.DisplayMessage --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletRelevantLocation.DisplayMessage ## -description Gets or sets the message associated with a relevant location. ## -property-value The message associated with a relevant location. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletRelevantLocation.DisplayMessage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletRelevantLocation.DisplayMessage + +## -description +Gets or sets the message associated with a relevant location. + +## -property-value +The message associated with a relevant location. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletrelevantlocation_position.md b/windows.applicationmodel.wallet/walletrelevantlocation_position.md index 185568e9a6..7b3a8511b3 100644 --- a/windows.applicationmodel.wallet/walletrelevantlocation_position.md +++ b/windows.applicationmodel.wallet/walletrelevantlocation_position.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletRelevantLocation.Position --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletRelevantLocation.Position ## -description Gets or sets the basic geographic position information of the location. ## -property-value The basic geographic position of the location. [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) is a structure, so use field syntax to set the **Latitude** and **Longitude** data. ## -remarks ## -examples ## -see-also [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletRelevantLocation.Position +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletRelevantLocation.Position + +## -description +Gets or sets the basic geographic position information of the location. + +## -property-value +The basic geographic position of the location. [BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) is a structure, so use field syntax to set the **Latitude** and **Longitude** data. + +## -remarks + +## -examples + +## -see-also +[BasicGeoposition](../windows.devices.geolocation/basicgeoposition.md) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/walletrelevantlocation_walletrelevantlocation_1221375020.md b/windows.applicationmodel.wallet/walletrelevantlocation_walletrelevantlocation_1221375020.md index fb270c89a1..5544c683e1 100644 --- a/windows.applicationmodel.wallet/walletrelevantlocation_walletrelevantlocation_1221375020.md +++ b/windows.applicationmodel.wallet/walletrelevantlocation_walletrelevantlocation_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletRelevantLocation.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletRelevantLocation.WalletRelevantLocation ## -description Initializes a new instance of the [WalletRelevantLocation](walletrelevantlocation.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletRelevantLocation.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletRelevantLocation.WalletRelevantLocation + +## -description +Initializes a new instance of the [WalletRelevantLocation](walletrelevantlocation.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/wallettransaction_description.md b/windows.applicationmodel.wallet/wallettransaction_description.md index 12a3e59165..a371f09316 100644 --- a/windows.applicationmodel.wallet/wallettransaction_description.md +++ b/windows.applicationmodel.wallet/wallettransaction_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.Description --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletTransaction.Description ## -description Gets or sets the summary description (suitable for user UI) of the transaction. ## -property-value The transaction description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.Description + +## -description +Gets or sets the summary description (suitable for user UI) of the transaction. + +## -property-value +The transaction description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/wallettransaction_displayamount.md b/windows.applicationmodel.wallet/wallettransaction_displayamount.md index 392454d594..9d7e4ca2b6 100644 --- a/windows.applicationmodel.wallet/wallettransaction_displayamount.md +++ b/windows.applicationmodel.wallet/wallettransaction_displayamount.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.DisplayAmount --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletTransaction.DisplayAmount ## -description Gets or sets the transaction amount. ## -property-value The transaction amount. ## -remarks This is a string, not a number, and the entity that writes data to the [WalletTransaction](wallettransaction.md) is responsible for currency symbols, decimal forms, other localization considerations and so on. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.DisplayAmount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.DisplayAmount + +## -description +Gets or sets the transaction amount. + +## -property-value +The transaction amount. + +## -remarks +This is a string, not a number, and the entity that writes data to the [WalletTransaction](wallettransaction.md) is responsible for currency symbols, decimal forms, other localization considerations and so on. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/wallettransaction_displaylocation.md b/windows.applicationmodel.wallet/wallettransaction_displaylocation.md index ae502c473d..8e58d28a65 100644 --- a/windows.applicationmodel.wallet/wallettransaction_displaylocation.md +++ b/windows.applicationmodel.wallet/wallettransaction_displaylocation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.DisplayLocation --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletTransaction.DisplayLocation ## -description Gets or sets a description (suitable for user UI) of the transaction location. ## -property-value The text description of the transaction location. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.DisplayLocation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.DisplayLocation + +## -description +Gets or sets a description (suitable for user UI) of the transaction location. + +## -property-value +The text description of the transaction location. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/wallettransaction_ignoretimeofday.md b/windows.applicationmodel.wallet/wallettransaction_ignoretimeofday.md index b4dcfc06ea..83add21a4e 100644 --- a/windows.applicationmodel.wallet/wallettransaction_ignoretimeofday.md +++ b/windows.applicationmodel.wallet/wallettransaction_ignoretimeofday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.IgnoreTimeOfDay --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletTransaction.IgnoreTimeOfDay ## -description Gets or sets whether to display the time of the transaction. ## -property-value **true** if the time of the transaction should be displayed; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.IgnoreTimeOfDay +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.IgnoreTimeOfDay + +## -description +Gets or sets whether to display the time of the transaction. + +## -property-value +**true** if the time of the transaction should be displayed; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/wallettransaction_islaunchable.md b/windows.applicationmodel.wallet/wallettransaction_islaunchable.md index e5c000e4f6..bd4144b234 100644 --- a/windows.applicationmodel.wallet/wallettransaction_islaunchable.md +++ b/windows.applicationmodel.wallet/wallettransaction_islaunchable.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.IsLaunchable --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletTransaction.IsLaunchable ## -description Gets or sets whether to launch your app when the user taps "see more transaction history". ## -property-value **true** if your app should be launched when the user taps "see more transaction history"; otherwise, **false**. ## -remarks ## -examples ## -see-also [Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.IsLaunchable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.IsLaunchable + +## -description +Gets or sets whether to launch your app when the user taps "see more transaction history". + +## -property-value +**true** if your app should be launched when the user taps "see more transaction history"; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Using the APIs](http://msdn.microsoft.com/library/4312628c-37a3-48a7-b41f-14605d478cf7) \ No newline at end of file diff --git a/windows.applicationmodel.wallet/wallettransaction_transactiondate.md b/windows.applicationmodel.wallet/wallettransaction_transactiondate.md index edadeca0a7..0e04499746 100644 --- a/windows.applicationmodel.wallet/wallettransaction_transactiondate.md +++ b/windows.applicationmodel.wallet/wallettransaction_transactiondate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.TransactionDate --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletTransaction.TransactionDate ## -description Gets or sets the date and time of the transaction. ## -property-value The date and time of the transaction. Can be **null** (the default), but for this particular property it's uncommon for the value to remain **null** when you're viewing an existing transaction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletTransaction.TransactionDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.TransactionDate + +## -description +Gets or sets the date and time of the transaction. + +## -property-value +The date and time of the transaction. Can be **null** (the default), but for this particular property it's uncommon for the value to remain **null** when you're viewing an existing transaction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/wallettransaction_wallettransaction_1221375020.md b/windows.applicationmodel.wallet/wallettransaction_wallettransaction_1221375020.md index b3b3239baf..7075273a91 100644 --- a/windows.applicationmodel.wallet/wallettransaction_wallettransaction_1221375020.md +++ b/windows.applicationmodel.wallet/wallettransaction_wallettransaction_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletTransaction.#ctor --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletTransaction.WalletTransaction ## -description Initializes a new instance of the [WalletTransaction](wallettransaction.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletTransaction.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletTransaction.WalletTransaction + +## -description +Initializes a new instance of the [WalletTransaction](wallettransaction.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletverb_name.md b/windows.applicationmodel.wallet/walletverb_name.md index 973bef2241..45839b12e2 100644 --- a/windows.applicationmodel.wallet/walletverb_name.md +++ b/windows.applicationmodel.wallet/walletverb_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Wallet.WalletVerb.Name --api-type: winrt property ---- # Windows.ApplicationModel.Wallet.WalletVerb.Name ## -description Gets or sets the custom verb name. ## -property-value The name of the custom verb. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Wallet.WalletVerb.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Wallet.WalletVerb.Name + +## -description +Gets or sets the custom verb name. + +## -property-value +The name of the custom verb. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.wallet/walletverb_walletverb_290278668.md b/windows.applicationmodel.wallet/walletverb_walletverb_290278668.md index 46d6a303fd..66fa326951 100644 --- a/windows.applicationmodel.wallet/walletverb_walletverb_290278668.md +++ b/windows.applicationmodel.wallet/walletverb_walletverb_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Wallet.WalletVerb.#ctor(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Wallet.WalletVerb.WalletVerb ## -description Initializes a new instance of the [WalletVerb](walletverb.md) class. ## -parameters ### -param name The name of the custom verb. Sets the value of the [Name](walletverb_name.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Wallet.WalletVerb.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Wallet.WalletVerb.WalletVerb + +## -description +Initializes a new instance of the [WalletVerb](walletverb.md) class. + +## -parameters +### -param name +The name of the custom verb. Sets the value of the [Name](walletverb_name.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appdisplayinfo.md b/windows.applicationmodel/appdisplayinfo.md index 699de8529e..ae3fae475f 100644 --- a/windows.applicationmodel/appdisplayinfo.md +++ b/windows.applicationmodel/appdisplayinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.AppDisplayInfo --api-type: winrt class ---- # Windows.ApplicationModel.AppDisplayInfo ## -description Provides an application's name, description, and logo. ## -remarks This class can be used to get information about applications that are registered as protocol handlers. You can get an instance of this class from [AppInfo.DisplayInfo](appinfo_displayinfo.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppDisplayInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppDisplayInfo + +## -description +Provides an application's name, description, and logo. + +## -remarks +This class can be used to get information about applications that are registered as protocol handlers. You can get an instance of this class from [AppInfo.DisplayInfo](appinfo_displayinfo.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appdisplayinfo_description.md b/windows.applicationmodel/appdisplayinfo_description.md index f4525688e5..40611c4f9b 100644 --- a/windows.applicationmodel/appdisplayinfo_description.md +++ b/windows.applicationmodel/appdisplayinfo_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppDisplayInfo.Description --api-type: winrt property ---- # Windows.ApplicationModel.AppDisplayInfo.Description ## -description Gets the application's description. ## -property-value The description of the application as defined in the package manifest (Package.appxmanifest). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppDisplayInfo.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppDisplayInfo.Description + +## -description +Gets the application's description. + +## -property-value +The description of the application as defined in the package manifest (Package.appxmanifest). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appdisplayinfo_displayname.md b/windows.applicationmodel/appdisplayinfo_displayname.md index 870e4b74c9..92e7c7c3bf 100644 --- a/windows.applicationmodel/appdisplayinfo_displayname.md +++ b/windows.applicationmodel/appdisplayinfo_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppDisplayInfo.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.AppDisplayInfo.DisplayName ## -description Gets the application's display name. ## -property-value The display name of the application as defined in the package manifest (Package.appxmanifest). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppDisplayInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppDisplayInfo.DisplayName + +## -description +Gets the application's display name. + +## -property-value +The display name of the application as defined in the package manifest (Package.appxmanifest). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appdisplayinfo_getlogo_14227883.md b/windows.applicationmodel/appdisplayinfo_getlogo_14227883.md index 5a7cc9aaa2..f39065c18d 100644 --- a/windows.applicationmodel/appdisplayinfo_getlogo_14227883.md +++ b/windows.applicationmodel/appdisplayinfo_getlogo_14227883.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.AppDisplayInfo.GetLogo(Windows.Foundation.Size) --api-type: winrt method ---- # Windows.ApplicationModel.AppDisplayInfo.GetLogo ## -description Get the application's logo. ## -parameters ### -param size The size of the rectangle in which the logo must fit. ## -returns The largest logo in your Package.appxmanifest file that will fit in the specified *Size*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.AppDisplayInfo.GetLogo(Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppDisplayInfo.GetLogo + +## -description +Get the application's logo. + +## -parameters +### -param size +The size of the rectangle in which the logo must fit. + +## -returns +The largest logo in your Package.appxmanifest file that will fit in the specified *Size*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appinfo.md b/windows.applicationmodel/appinfo.md index c500962219..c041df748e 100644 --- a/windows.applicationmodel/appinfo.md +++ b/windows.applicationmodel/appinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.AppInfo --api-type: winrt class ---- # Windows.ApplicationModel.AppInfo ## -description Provides information about an application such as it name, logo, package information, ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.AppInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.AppInfo + +## -description +Provides information about an application such as it name, logo, package information, ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appinfo_appusermodelid.md b/windows.applicationmodel/appinfo_appusermodelid.md index aa35f58b49..a99c94890a 100644 --- a/windows.applicationmodel/appinfo_appusermodelid.md +++ b/windows.applicationmodel/appinfo_appusermodelid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.AppInfo.AppUserModelId --api-type: winrt property ---- # Windows.ApplicationModel.AppInfo.AppUserModelId ## -description An identifier that uniquely identifies the app. ## -property-value The application user model ID for the application. ## -remarks An application user model identifier is used to associate processes, files, and windows with a particular application. See [Application User Model IDs](http://msdn.microsoft.com/library/ebce2d99-6f20-4545-9f12-d79cd8d0828f) for more details. ## -examples ## -see-also [System.AppUserModel.ID](XREF:TODO:properties.props_System_AppUserModel_Id) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppInfo.AppUserModelId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppInfo.AppUserModelId + +## -description +An identifier that uniquely identifies the app. + +## -property-value +The application user model ID for the application. + +## -remarks +An application user model identifier is used to associate processes, files, and windows with a particular application. See [Application User Model IDs](http://msdn.microsoft.com/library/ebce2d99-6f20-4545-9f12-d79cd8d0828f) for more details. + +## -examples + +## -see-also +[System.AppUserModel.ID](XREF:TODO:properties.props_System_AppUserModel_Id) \ No newline at end of file diff --git a/windows.applicationmodel/appinfo_displayinfo.md b/windows.applicationmodel/appinfo_displayinfo.md index 06acb3ed47..bdef45bb3a 100644 --- a/windows.applicationmodel/appinfo_displayinfo.md +++ b/windows.applicationmodel/appinfo_displayinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppInfo.DisplayInfo --api-type: winrt property ---- # Windows.ApplicationModel.AppInfo.DisplayInfo ## -description Gets information that describes the application. ## -property-value An object containing information about the app's name, description, and logo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppInfo.DisplayInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppInfo.DisplayInfo + +## -description +Gets information that describes the application. + +## -property-value +An object containing information about the app's name, description, and logo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appinfo_id.md b/windows.applicationmodel/appinfo_id.md index e66809fb65..958d341ad8 100644 --- a/windows.applicationmodel/appinfo_id.md +++ b/windows.applicationmodel/appinfo_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppInfo.Id --api-type: winrt property ---- # Windows.ApplicationModel.AppInfo.Id ## -description Gets the app identifier. ## -property-value The id of the app as defined by the package name in the Package.appxmanifest file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppInfo.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppInfo.Id + +## -description +Gets the app identifier. + +## -property-value +The id of the app as defined by the package name in the Package.appxmanifest file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/appinfo_packagefamilyname.md b/windows.applicationmodel/appinfo_packagefamilyname.md index 90823e3d19..e1eb821e00 100644 --- a/windows.applicationmodel/appinfo_packagefamilyname.md +++ b/windows.applicationmodel/appinfo_packagefamilyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.AppInfo.PackageFamilyName --api-type: winrt property ---- # Windows.ApplicationModel.AppInfo.PackageFamilyName ## -description An identifier that uniquely identifies the app's package. ## -property-value The package family name ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.AppInfo.PackageFamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.AppInfo.PackageFamilyName + +## -description +An identifier that uniquely identifies the app's package. + +## -property-value +The package family name + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/cameraapplicationmanager.md b/windows.applicationmodel/cameraapplicationmanager.md index 0339101780..31c42bfecb 100644 --- a/windows.applicationmodel/cameraapplicationmanager.md +++ b/windows.applicationmodel/cameraapplicationmanager.md @@ -1,19 +1,19 @@ ---- --api-id: T:Windows.ApplicationModel.CameraApplicationManager --api-type: winrt class ---- - - - -# Windows.ApplicationModel.CameraApplicationManager - -## -description -Enables an app to launch a dialog that displays all of the lens apps installed on the device and allows the user to quickly switch between them. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.ApplicationModel.CameraApplicationManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.CameraApplicationManager + +## -description +Enables an app to launch a dialog that displays all of the lens apps installed on the device and allows the user to quickly switch between them. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/cameraapplicationmanager_showinstalledapplicationsui_1010868973.md b/windows.applicationmodel/cameraapplicationmanager_showinstalledapplicationsui_1010868973.md index 333ec6c299..0075dd748a 100644 --- a/windows.applicationmodel/cameraapplicationmanager_showinstalledapplicationsui_1010868973.md +++ b/windows.applicationmodel/cameraapplicationmanager_showinstalledapplicationsui_1010868973.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.CameraApplicationManager.ShowInstalledApplicationsUI --api-type: winrt method ---- # Windows.ApplicationModel.CameraApplicationManager.ShowInstalledApplicationsUI ## -description Launches a dialog that displays all of the lens apps installed on the device and allows the user to quickly switch between them. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.CameraApplicationManager.ShowInstalledApplicationsUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.CameraApplicationManager.ShowInstalledApplicationsUI + +## -description +Launches a dialog that displays all of the lens apps installed on the device and allows the user to quickly switch between them. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/designmode_designmodeenabled.md b/windows.applicationmodel/designmode_designmodeenabled.md index b840cc36f0..312b266a23 100644 --- a/windows.applicationmodel/designmode_designmodeenabled.md +++ b/windows.applicationmodel/designmode_designmodeenabled.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.ApplicationModel.DesignMode.DesignModeEnabled --api-type: winrt property ---- # Windows.ApplicationModel.DesignMode.DesignModeEnabled ## -description Gets a value that indicates whether the process is running in design mode. ## -property-value True if the process is running in design mode; otherwise false. ## -remarks Use the [DesignModeEnabled](designmode_designmodeenabled.md) property when your custom types require special logic when running in a visual designer. For example, a Windows Library for JavaScript control can query the [DesignModeEnabled](designmode_designmodeenabled.md) property to determine whether to display placeholder data instead of live data from a web service. Your in-process custom types can check the design mode setting of the current process. Also, internal custom types that are activated in another process can check whether their caller is in design mode. > [!NOTE] > The [DesignModeEnabled](designmode_designmodeenabled.md) property is available only in the presence of a developer certificate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.DesignMode.DesignModeEnabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DesignMode.DesignModeEnabled + +## -description +Gets a value that indicates whether the process is running in design mode. + +## -property-value +True if the process is running in design mode; otherwise false. + +## -remarks +Use the [DesignModeEnabled](designmode_designmodeenabled.md) property when your custom types require special logic when running in a visual designer. For example, a Windows Library for JavaScript control can query the [DesignModeEnabled](designmode_designmodeenabled.md) property to determine whether to display placeholder data instead of live data from a web service. + +Your in-process custom types can check the design mode setting of the current process. Also, internal custom types that are activated in another process can check whether their caller is in design mode. + + + +> [!NOTE] +> The [DesignModeEnabled](designmode_designmodeenabled.md) property is available only in the presence of a developer certificate. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/enteredbackgroundeventargs_getdeferral_254836512.md b/windows.applicationmodel/enteredbackgroundeventargs_getdeferral_254836512.md index 420d75f5dc..c9f638e9a8 100644 --- a/windows.applicationmodel/enteredbackgroundeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel/enteredbackgroundeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.EnteredBackgroundEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.EnteredBackgroundEventArgs.GetDeferral ## -description Gets the deferral object which delays the transition from running in the background state to the suspended state until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. ## -returns The deferral object you will use to indicate when your processing is complete. ## -remarks Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which could happen before your asynchronous method has finished. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.EnteredBackgroundEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.EnteredBackgroundEventArgs.GetDeferral + +## -description +Gets the deferral object which delays the transition from running in the background state to the suspended state until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. + +## -returns +The deferral object you will use to indicate when your processing is complete. + +## -remarks +Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which could happen before your asynchronous method has finished. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/fulltrustprocesslauncher.md b/windows.applicationmodel/fulltrustprocesslauncher.md index 5e84e2bfd1..6920299711 100644 --- a/windows.applicationmodel/fulltrustprocesslauncher.md +++ b/windows.applicationmodel/fulltrustprocesslauncher.md @@ -1,3 +1,48 @@ ---- -api-id: T:Windows.ApplicationModel.FullTrustProcessLauncher --api-type: winrt class ---- # Windows.ApplicationModel.FullTrustProcessLauncher ## -description Activate the full-trust Win32 component of an application from a Universal Windows app component in the same application package. ## -remarks The methods in this class may only be called by packages that have the **runFullTrust** capability: ```xml ... ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.FullTrustProcessLauncher +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.FullTrustProcessLauncher + +## -description +Activate the full-trust Win32 component of an application from a Universal Windows app component in the same application package. + +## -remarks +The methods in this class may only be called by packages that have the **runFullTrust** capability: + +```xml + + ... + + + + + … + + + + + + + + + + + + +``` + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_1528646566.md b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_1528646566.md index 4f61981d5d..3af09e9c54 100644 --- a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_1528646566.md +++ b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_1528646566.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync ## -description Launch the full-trust process for the specified application ID. ## -parameters ### -param fullTrustPackageRelativeAppId The process relative application identifier of the app whose full trust process component the caller wants to launch. The full-trust process can parse this to determine which app invoked it. ## -returns The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. ## -remarks ## -examples ## -see-also [LaunchFullTrustProcessForAppAsync(String, String)](fulltrustprocesslauncher_launchfulltrustprocessforappasync_400639514.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync + +## -description +Launch the full-trust process for the specified application ID. + +## -parameters +### -param fullTrustPackageRelativeAppId +The process relative application identifier of the app whose full trust process component the caller wants to launch. The full-trust process can parse this to determine which app invoked it. + +## -returns +The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. + +## -remarks + +## -examples + +## -see-also +[LaunchFullTrustProcessForAppAsync(String, String)](fulltrustprocesslauncher_launchfulltrustprocessforappasync_400639514.md) \ No newline at end of file diff --git a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_400639514.md b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_400639514.md index 8db65fd7a3..41ad552f7c 100644 --- a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_400639514.md +++ b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforappasync_400639514.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync(System.String,System.String) --api-type: winrt method ---- # Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync ## -description Launch the full-trust process for the specified application ID, with parameters. ## -parameters ### -param fullTrustPackageRelativeAppId The process relative application identifier of the app whose full trust process component the caller wants to launch. The full-trust process can parse this to determine which app invoked it. ### -param parameterGroupId The parameter group ID for the parameters that will be passed to the launched process. ## -returns The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. ## -remarks ## -examples ## -see-also [LaunchFullTrustProcessForAppAsync(String)](fulltrustprocesslauncher_launchfulltrustprocessforappasync_1528646566.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForAppAsync + +## -description +Launch the full-trust process for the specified application ID, with parameters. + +## -parameters +### -param fullTrustPackageRelativeAppId +The process relative application identifier of the app whose full trust process component the caller wants to launch. The full-trust process can parse this to determine which app invoked it. + +### -param parameterGroupId +The parameter group ID for the parameters that will be passed to the launched process. + +## -returns +The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. + +## -remarks + +## -examples + +## -see-also +[LaunchFullTrustProcessForAppAsync(String)](fulltrustprocesslauncher_launchfulltrustprocessforappasync_1528646566.md) \ No newline at end of file diff --git a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_1980378844.md b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_1980378844.md index 66f0ad3c15..ad0f892b22 100644 --- a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_1980378844.md +++ b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_1980378844.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync ## -description Launch the full-trust process for the current application ID, with parameters. ## -parameters ### -param parameterGroupId The parameter group ID for the parameters that will be passed to the launched process. ## -returns The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. ## -remarks ## -examples ## -see-also [LaunchFullTrustProcessForCurrentAppAsync](fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_797693948.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync + +## -description +Launch the full-trust process for the current application ID, with parameters. + +## -parameters +### -param parameterGroupId +The parameter group ID for the parameters that will be passed to the launched process. + +## -returns +The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. + +## -remarks + +## -examples + +## -see-also +[LaunchFullTrustProcessForCurrentAppAsync](fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_797693948.md) \ No newline at end of file diff --git a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_797693948.md b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_797693948.md index c1a9c6632b..9aa6e15c49 100644 --- a/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_797693948.md +++ b/windows.applicationmodel/fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_797693948.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync --api-type: winrt method ---- # Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync ## -description Launch the full-trust process for the current application ID. ## -returns The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. ## -remarks ## -examples ## -see-also [LaunchFullTrustProcessForCurrentAppAsync(String)](fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_1980378844.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.FullTrustProcessLauncher.LaunchFullTrustProcessForCurrentAppAsync + +## -description +Launch the full-trust process for the current application ID. + +## -returns +The [IAsyncAction](../windows.foundation/iasyncaction.md) to await. + +## -remarks + +## -examples + +## -see-also +[LaunchFullTrustProcessForCurrentAppAsync(String)](fulltrustprocesslauncher_launchfulltrustprocessforcurrentappasync_1980378844.md) \ No newline at end of file diff --git a/windows.applicationmodel/ienteredbackgroundeventargs_getdeferral.md b/windows.applicationmodel/ienteredbackgroundeventargs_getdeferral.md index 2519fbf1de..0093ebff23 100644 --- a/windows.applicationmodel/ienteredbackgroundeventargs_getdeferral.md +++ b/windows.applicationmodel/ienteredbackgroundeventargs_getdeferral.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.IEnteredBackgroundEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.IEnteredBackgroundEventArgs.GetDeferral ## -description Gets the deferral object which delays the transition from running in the background state to the suspended state until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. ## -returns The deferral object you will use to indicate when your processing is complete. ## -remarks Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which could happen before your asynchronous method has finished. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.IEnteredBackgroundEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.IEnteredBackgroundEventArgs.GetDeferral + +## -description +Gets the deferral object which delays the transition from running in the background state to the suspended state until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. + +## -returns +The deferral object you will use to indicate when your processing is complete. + +## -remarks +Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which could happen before your asynchronous method has finished. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/ileavingbackgroundeventargs_getdeferral.md b/windows.applicationmodel/ileavingbackgroundeventargs_getdeferral.md index d067aea73c..6d04cce4c3 100644 --- a/windows.applicationmodel/ileavingbackgroundeventargs_getdeferral.md +++ b/windows.applicationmodel/ileavingbackgroundeventargs_getdeferral.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.ILeavingBackgroundEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.ILeavingBackgroundEventArgs.GetDeferral ## -description Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. ## -returns The deferral object you will use to indicate that your processing is complete. ## -remarks Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which may happen before your asynchronous method has finished. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ILeavingBackgroundEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ILeavingBackgroundEventArgs.GetDeferral + +## -description +Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. + +## -returns +The deferral object you will use to indicate that your processing is complete. + +## -remarks +Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which may happen before your asynchronous method has finished. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/isuspendingdeferral_complete.md b/windows.applicationmodel/isuspendingdeferral_complete.md index 923fd71b84..b9e3cbc775 100644 --- a/windows.applicationmodel/isuspendingdeferral_complete.md +++ b/windows.applicationmodel/isuspendingdeferral_complete.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.ISuspendingDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.ISuspendingDeferral.Complete ## -description Notifies the system that the app has saved its data and is ready to be suspended. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ISuspendingDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ISuspendingDeferral.Complete + +## -description +Notifies the system that the app has saved its data and is ready to be suspended. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/isuspendingeventargs_suspendingoperation.md b/windows.applicationmodel/isuspendingeventargs_suspendingoperation.md index 602f9410a7..c047bc6293 100644 --- a/windows.applicationmodel/isuspendingeventargs_suspendingoperation.md +++ b/windows.applicationmodel/isuspendingeventargs_suspendingoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.ISuspendingEventArgs.SuspendingOperation --api-type: winrt property ---- # Windows.ApplicationModel.ISuspendingEventArgs.SuspendingOperation ## -description Gets the app suspending operation. ## -property-value The suspending operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ISuspendingEventArgs.SuspendingOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ISuspendingEventArgs.SuspendingOperation + +## -description +Gets the app suspending operation. + +## -property-value +The suspending operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/isuspendingoperation_deadline.md b/windows.applicationmodel/isuspendingoperation_deadline.md index 84bea659e1..d0705b3742 100644 --- a/windows.applicationmodel/isuspendingoperation_deadline.md +++ b/windows.applicationmodel/isuspendingoperation_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.ISuspendingOperation.Deadline --api-type: winrt property ---- # Windows.ApplicationModel.ISuspendingOperation.Deadline ## -description Gets the time remaining before a delayed app suspending operation continues. ## -property-value The time remaining. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.ISuspendingOperation.Deadline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.ISuspendingOperation.Deadline + +## -description +Gets the time remaining before a delayed app suspending operation continues. + +## -property-value +The time remaining. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/isuspendingoperation_getdeferral.md b/windows.applicationmodel/isuspendingoperation_getdeferral.md index 47f9ffdb8c..96e9abbb39 100644 --- a/windows.applicationmodel/isuspendingoperation_getdeferral.md +++ b/windows.applicationmodel/isuspendingoperation_getdeferral.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.ISuspendingOperation.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.ISuspendingOperation.GetDeferral ## -description Requests that the app suspending operation be delayed. ## -returns The suspension deferral. ## -remarks App suspension is delayed until the app calls the [ISuspendingDeferral.Complete](isuspendingdeferral_complete.md) method or the deadline for suspension has passed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.ISuspendingOperation.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.ISuspendingOperation.GetDeferral + +## -description +Requests that the app suspending operation be delayed. + +## -returns +The suspension deferral. + +## -remarks +App suspension is delayed until the app calls the [ISuspendingDeferral.Complete](isuspendingdeferral_complete.md) method or the deadline for suspension has passed. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/leavingbackgroundeventargs_getdeferral_254836512.md b/windows.applicationmodel/leavingbackgroundeventargs_getdeferral_254836512.md index d9b994cdc4..70c9773857 100644 --- a/windows.applicationmodel/leavingbackgroundeventargs_getdeferral_254836512.md +++ b/windows.applicationmodel/leavingbackgroundeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.LeavingBackgroundEventArgs.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.LeavingBackgroundEventArgs.GetDeferral ## -description Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. ## -returns The deferral object you will use to indicate that your processing is done. ## -remarks Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which may happen before your asynchronous method has finished. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.LeavingBackgroundEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.LeavingBackgroundEventArgs.GetDeferral + +## -description +Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls [Deferral.Complete](../windows.foundation/deferral_complete.md) or the deadline for navigation has passed. + +## -returns +The deferral object you will use to indicate that your processing is done. + +## -remarks +Deferrals are important if you call asynchronous methods from your event handler. Without the deferral, the app transitions to the next state when the event handler returns— which may happen before your asynchronous method has finished. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_current.md b/windows.applicationmodel/package_current.md index 794646e9a1..571680c604 100644 --- a/windows.applicationmodel/package_current.md +++ b/windows.applicationmodel/package_current.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Package.Current --api-type: winrt property ---- # Windows.ApplicationModel.Package.Current ## -description Gets the package for the current app. ## -property-value The package. ## -remarks > [!IMPORTANT] > Although [Package](package.md) is supported in desktop apps, this member is supported only in Windows Store app. To access a package object from a desktop app, use [Windows.Management.Deployment.PackageManager](../windows.management.deployment/packagemanager.md). ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.Current +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.Current + +## -description +Gets the package for the current app. + +## -property-value +The package. + +## -remarks +> [!IMPORTANT] +> Although [Package](package.md) is supported in desktop apps, this member is supported only in Windows Store app. To access a package object from a desktop app, use [Windows.Management.Deployment.PackageManager](../windows.management.deployment/packagemanager.md). + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file diff --git a/windows.applicationmodel/package_dependencies.md b/windows.applicationmodel/package_dependencies.md index 55139e871d..2a9d148e1f 100644 --- a/windows.applicationmodel/package_dependencies.md +++ b/windows.applicationmodel/package_dependencies.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Package.Dependencies --api-type: winrt property ---- # Windows.ApplicationModel.Package.Dependencies ## -description Gets the packages on which the current package depends. ## -property-value The packages on which the current package depends. ## -remarks > [!IMPORTANT] > Although Package is supported in desktop apps, this member is supported only in Windows Store app. To access a package's dependencies from a desktop app, use [GetPackageInfo](http://msdn.microsoft.com/library/28f45b3b-a61f-44d3-b606-6966ad5866fa). ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.Dependencies +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.Dependencies + +## -description +Gets the packages on which the current package depends. + +## -property-value +The packages on which the current package depends. + +## -remarks +> [!IMPORTANT] +> Although Package is supported in desktop apps, this member is supported only in Windows Store app. To access a package's dependencies from a desktop app, use [GetPackageInfo](http://msdn.microsoft.com/library/28f45b3b-a61f-44d3-b606-6966ad5866fa). + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_description.md b/windows.applicationmodel/package_description.md index 381d3f893f..0c553793c7 100644 --- a/windows.applicationmodel/package_description.md +++ b/windows.applicationmodel/package_description.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Package.Description --api-type: winrt property ---- # Windows.ApplicationModel.Package.Description ## -description Gets the description of the package. ## -property-value The description of the package. ## -remarks > [!IMPORTANT] > This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property returns an empty string (""). ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.Description + +## -description +Gets the description of the package. + +## -property-value +The description of the package. + +## -remarks +> [!IMPORTANT] +> This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property returns an empty string (""). + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_displayname.md b/windows.applicationmodel/package_displayname.md index c9431f1351..960a41869c 100644 --- a/windows.applicationmodel/package_displayname.md +++ b/windows.applicationmodel/package_displayname.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Package.DisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Package.DisplayName ## -description Gets the display name of the package. ## -property-value The display name. ## -remarks > [!IMPORTANT] > This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property returns an empty string (""). ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.DisplayName + +## -description +Gets the display name of the package. + +## -property-value +The display name. + +## -remarks +> [!IMPORTANT] +> This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property returns an empty string (""). + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_getapplistentriesasync_364802562.md b/windows.applicationmodel/package_getapplistentriesasync_364802562.md index d60bd753c8..edf32a93eb 100644 --- a/windows.applicationmodel/package_getapplistentriesasync_364802562.md +++ b/windows.applicationmodel/package_getapplistentriesasync_364802562.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Package.GetAppListEntriesAsync --api-type: winrt method ---- # Windows.ApplicationModel.Package.GetAppListEntriesAsync ## -description Enumerates the packaged apps on the device. Only packaged apps that are registered to the current user are returned. ## -returns A list of packaged apps along with their display name, description, and logo. ## -remarks ## -examples ## -see-also [AppListEntry](../windows.applicationmodel.core/applistentry.md) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Package.GetAppListEntriesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.GetAppListEntriesAsync + +## -description +Enumerates the packaged apps on the device. Only packaged apps that are registered to the current user are returned. + +## -returns +A list of packaged apps along with their display name, description, and logo. + +## -remarks + +## -examples + +## -see-also +[AppListEntry](../windows.applicationmodel.core/applistentry.md) \ No newline at end of file diff --git a/windows.applicationmodel/package_getthumbnailtoken_1529848989.md b/windows.applicationmodel/package_getthumbnailtoken_1529848989.md index 8a82c61b9a..68f1f4c175 100644 --- a/windows.applicationmodel/package_getthumbnailtoken_1529848989.md +++ b/windows.applicationmodel/package_getthumbnailtoken_1529848989.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Package.GetThumbnailToken --api-type: winrt method ---- # Windows.ApplicationModel.Package.GetThumbnailToken ## -description Windows Phone only. Returns a token that can be used to retrieve the thumbnail image associated with this application package. ## -returns A token that can be used to retrieve the thumbnail image associated with this application package. ## -remarks Use the [GetSharedFileName](XREF:TODO:wp_storage_shared.sharedstorageaccessmanager_getsharedfilename) method passing the token returned by this method to retrieve the thumbnail image associated with this application package. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Package.GetThumbnailToken +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.GetThumbnailToken + +## -description +Windows Phone only. Returns a token that can be used to retrieve the thumbnail image associated with this application package. + +## -returns +A token that can be used to retrieve the thumbnail image associated with this application package. + +## -remarks +Use the [GetSharedFileName](XREF:TODO:wp_storage_shared.sharedstorageaccessmanager_getsharedfilename) method passing the token returned by this method to retrieve the thumbnail image associated with this application package. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_id.md b/windows.applicationmodel/package_id.md index 8530730d59..7ff773bb88 100644 --- a/windows.applicationmodel/package_id.md +++ b/windows.applicationmodel/package_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.Id --api-type: winrt property ---- # Windows.ApplicationModel.Package.Id ## -description Gets the package identity of the current package. ## -property-value The package identity. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId](packageid.md), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.Id + +## -description +Gets the package identity of the current package. + +## -property-value +The package identity. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId](packageid.md), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_installdate.md b/windows.applicationmodel/package_installdate.md index e967f26a08..6775f793e0 100644 --- a/windows.applicationmodel/package_installdate.md +++ b/windows.applicationmodel/package_installdate.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.ApplicationModel.Package.InstallDate --api-type: winrt property ---- # Windows.ApplicationModel.Package.InstallDate ## -description Windows Phone only. Gets the date the application package was installed on the user's phone. ## -property-value The date the application package was installed on the user's phone. ## -remarks ### Windows Phone 8 If you acquire the [Package](package.md) instance by using the [Windows.ApplicationModel.Package.Current](package_current.md) property, getting the [InstallDate](package_installdate.md) property raises an InvalidCastException. If you want to get the [InstallDate](package_installdate.md) property, acquire the [Package](package.md) instance by using the [Windows.Phone.Management.Deployment.InstallationManager.FindPackagesForCurrentPublisher](../windows.phone.management.deployment/installationmanager_findpackagesforcurrentpublisher.md) method. ```csharp using Windows.ApplicationModel; IEnumerable packages = Windows.Phone.Management.Deployment.InstallationManager.FindPackagesForCurrentPublisher(); Package package = packages.First(); DateTimeOffset packageInstallDate = package.InstallDate; ``` ### Windows 10 This API is not implemented and will throw an exception if called. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.InstallDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.InstallDate + +## -description +Windows Phone only. Gets the date the application package was installed on the user's phone. + +## -property-value +The date the application package was installed on the user's phone. + +## -remarks +### Windows Phone 8 + +If you acquire the [Package](package.md) instance by using the [Windows.ApplicationModel.Package.Current](package_current.md) property, getting the [InstallDate](package_installdate.md) property raises an InvalidCastException. If you want to get the [InstallDate](package_installdate.md) property, acquire the [Package](package.md) instance by using the [Windows.Phone.Management.Deployment.InstallationManager.FindPackagesForCurrentPublisher](../windows.phone.management.deployment/installationmanager_findpackagesforcurrentpublisher.md) method. + +```csharp + +using Windows.ApplicationModel; + +IEnumerable packages = Windows.Phone.Management.Deployment.InstallationManager.FindPackagesForCurrentPublisher(); +Package package = packages.First(); +DateTimeOffset packageInstallDate = package.InstallDate; + +``` + + + +### Windows 10 + +This API is not implemented and will throw an exception if called. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_installeddate.md b/windows.applicationmodel/package_installeddate.md index 02eb82a61e..502b78b24e 100644 --- a/windows.applicationmodel/package_installeddate.md +++ b/windows.applicationmodel/package_installeddate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.InstalledDate --api-type: winrt property ---- # Windows.ApplicationModel.Package.InstalledDate ## -description Gets the date on which the application package was installed or last updated. ## -property-value The date on which the application package was installed or last updated. ## -remarks ## -examples ## -see-also [Package.InstallDate](package_installdate.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.InstalledDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.InstalledDate + +## -description +Gets the date on which the application package was installed or last updated. + +## -property-value +The date on which the application package was installed or last updated. + +## -remarks + +## -examples + +## -see-also +[Package.InstallDate](package_installdate.md) \ No newline at end of file diff --git a/windows.applicationmodel/package_installedlocation.md b/windows.applicationmodel/package_installedlocation.md index 940de3d06a..1ee6d053c1 100644 --- a/windows.applicationmodel/package_installedlocation.md +++ b/windows.applicationmodel/package_installedlocation.md @@ -1,3 +1,32 @@ ---- -api-id: P:Windows.ApplicationModel.Package.InstalledLocation --api-type: winrt property ---- # Windows.ApplicationModel.Package.InstalledLocation ## -description Gets the location of the installed package. ## -property-value The location of the installed package. ## -remarks There are several other ways to refer to the a file in a package. + You can just begin a URI with a "/" to refer to the package root. For example: `` + You can use the "ms-appx:///" protocol. For example:`` + You can also omit the package name to let the system fill in the domain, as shown here: `` For more info about how to refer to files in an app's package, see [How to load file resources](http://msdn.microsoft.com/library/2fc07702-7022-44b7-8471-8d477a105fc5). ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.InstalledLocation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.InstalledLocation + +## -description +Gets the location of the installed package. + +## -property-value +The location of the installed package. + +## -remarks +There are several other ways to refer to the a file in a package. + + ++ You can just begin a URI with a "/" to refer to the package root. For example: `` ++ You can use the "ms-appx:///" protocol. For example:`` ++ You can also omit the package name to let the system fill in the domain, as shown here: + +`` +For more info about how to refer to files in an app's package, see [How to load file resources](http://msdn.microsoft.com/library/2fc07702-7022-44b7-8471-8d477a105fc5). + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_isbundle.md b/windows.applicationmodel/package_isbundle.md index 1a5898d090..0e29195352 100644 --- a/windows.applicationmodel/package_isbundle.md +++ b/windows.applicationmodel/package_isbundle.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.IsBundle --api-type: winrt property ---- # Windows.ApplicationModel.Package.IsBundle ## -description Indicates whether the package is a bundle package. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the package is a bundle package. **TRUE** indicates that the package is a bundle package; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.IsBundle +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.IsBundle + +## -description +Indicates whether the package is a bundle package. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the package is a bundle package. **TRUE** indicates that the package is a bundle package; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_isdevelopmentmode.md b/windows.applicationmodel/package_isdevelopmentmode.md index d6c5110e64..64845aff77 100644 --- a/windows.applicationmodel/package_isdevelopmentmode.md +++ b/windows.applicationmodel/package_isdevelopmentmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.IsDevelopmentMode --api-type: winrt property ---- # Windows.ApplicationModel.Package.IsDevelopmentMode ## -description Indicates whether the package is installed in development mode. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the package is installed in development mode. **TRUE** indicates that the package is installed in development mode; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.IsDevelopmentMode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.IsDevelopmentMode + +## -description +Indicates whether the package is installed in development mode. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the package is installed in development mode. **TRUE** indicates that the package is installed in development mode; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_isframework.md b/windows.applicationmodel/package_isframework.md index 720ce460c1..0a9f901057 100644 --- a/windows.applicationmodel/package_isframework.md +++ b/windows.applicationmodel/package_isframework.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.IsFramework --api-type: winrt property ---- # Windows.ApplicationModel.Package.IsFramework ## -description Indicates whether other packages can declare a dependency on this package. ## -property-value True if other packages can declare a dependency on this package; otherwise false. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.IsFramework +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.IsFramework + +## -description +Indicates whether other packages can declare a dependency on this package. + +## -property-value +True if other packages can declare a dependency on this package; otherwise false. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file diff --git a/windows.applicationmodel/package_isoptional.md b/windows.applicationmodel/package_isoptional.md index e5da877af0..5ad744f1b2 100644 --- a/windows.applicationmodel/package_isoptional.md +++ b/windows.applicationmodel/package_isoptional.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.IsOptional --api-type: winrt property ---- # Windows.ApplicationModel.Package.IsOptional ## -description Indicates whether the package is optional. ## -property-value Returns **true** if the package is optional; **false** otherwise. ## -remarks Optional packages are dependent on another package that must be installed first. For example a map application may have optional geographic area packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.IsOptional +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.IsOptional + +## -description +Indicates whether the package is optional. + +## -property-value +Returns **true** if the package is optional; **false** otherwise. + +## -remarks +Optional packages are dependent on another package that must be installed first. For example a map application may have optional geographic area packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_isresourcepackage.md b/windows.applicationmodel/package_isresourcepackage.md index f1e5b12e56..9b31d07dbd 100644 --- a/windows.applicationmodel/package_isresourcepackage.md +++ b/windows.applicationmodel/package_isresourcepackage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.IsResourcePackage --api-type: winrt property ---- # Windows.ApplicationModel.Package.IsResourcePackage ## -description Indicates whether the package is a resource package. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the package is a resource package. **TRUE** indicates that the package is a resource package; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.IsResourcePackage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.IsResourcePackage + +## -description +Indicates whether the package is a resource package. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that indicates whether the package is a resource package. **TRUE** indicates that the package is a resource package; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_launch_787664348.md b/windows.applicationmodel/package_launch_787664348.md index 42bec6a624..8317180a7f 100644 --- a/windows.applicationmodel/package_launch_787664348.md +++ b/windows.applicationmodel/package_launch_787664348.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.ApplicationModel.Package.Launch(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.Package.Launch ## -description Windows Phone only. Launches the specified application. ## -parameters ### -param parameters The navigation URI that specifies the page to launch and optional parameters. Use an empty string to specify the default page for the app. ## -remarks The Launch parameter has the same format as the **NavigationUri** format. The following table shows some examples:
ScenarioLaunch parameterExample
You just want to launch the app with the default page.Specify an empty string.`pkg.Launch("");`
You want to launch to a particular XAML page.Start with a forward slash (/) followed by the XAML page name.`pkg.Launch("/Page1.xaml");`
You want to pass parameters to the default page.Start with a question mark (?) followed by name/value pairs. Use an equal sign (=) between the name and value. Separate multiple name/value pairs with an ampersand (&).`pkg.Launch("?content=1234¶m2=test");`
You want to launch to a particular XAML page and pass in parameters.Use a combination of the previous two examples.`pkg.Launch("/Page1.xaml?content=1234¶m2=test ");`
> [!IMPORTANT] > The [Launch](package_launch.md) method only works if it is called from a Windows Phone Silverlight app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Package.Launch(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.Launch + +## -description +Windows Phone only. Launches the specified application. + +## -parameters +### -param parameters +The navigation URI that specifies the page to launch and optional parameters. Use an empty string to specify the default page for the app. + +## -remarks +The Launch parameter has the same format as the **NavigationUri** format. The following table shows some examples: + + + + + + + +
ScenarioLaunch parameterExample
You just want to launch the app with the default page.Specify an empty string.`pkg.Launch("");`
You want to launch to a particular XAML page.Start with a forward slash (/) followed by the XAML page name.`pkg.Launch("/Page1.xaml");`
You want to pass parameters to the default page.Start with a question mark (?) followed by name/value pairs. Use an equal sign (=) between the name and value. Separate multiple name/value pairs with an ampersand (&).`pkg.Launch("?content=1234¶m2=test");`
You want to launch to a particular XAML page and pass in parameters.Use a combination of the previous two examples.`pkg.Launch("/Page1.xaml?content=1234¶m2=test ");`
+ + + +> [!IMPORTANT] +> The [Launch](package_launch.md) method only works if it is called from a Windows Phone Silverlight app. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_logo.md b/windows.applicationmodel/package_logo.md index 0fbc66fbcf..43f4df7034 100644 --- a/windows.applicationmodel/package_logo.md +++ b/windows.applicationmodel/package_logo.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Package.Logo --api-type: winrt property ---- # Windows.ApplicationModel.Package.Logo ## -description Gets the logo of the package. ## -property-value The logo of the package. ## -remarks > [!IMPORTANT] > This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property will throw an exception. ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.Logo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.Logo + +## -description +Gets the logo of the package. + +## -property-value +The logo of the package. + +## -remarks +> [!IMPORTANT] +> This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property will throw an exception. + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_publisherdisplayname.md b/windows.applicationmodel/package_publisherdisplayname.md index 1754b0d20e..9ef0d88e2f 100644 --- a/windows.applicationmodel/package_publisherdisplayname.md +++ b/windows.applicationmodel/package_publisherdisplayname.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.Package.PublisherDisplayName --api-type: winrt property ---- # Windows.ApplicationModel.Package.PublisherDisplayName ## -description Gets the publisher display name of the package. ## -property-value The publisher display name. ## -remarks > [!IMPORTANT] > This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property returns an empty string (""). ## -examples ## -see-also [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.PublisherDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.PublisherDisplayName + +## -description +Gets the publisher display name of the package. + +## -property-value +The publisher display name. + +## -remarks +> [!IMPORTANT] +> This property is only supported for Windows Store app. If you call this property on an instance of a package that was created by any mechanism other than [Package.Current](package_current.md), this property returns an empty string (""). + +## -examples + +## -see-also +[App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel/package_signaturekind.md b/windows.applicationmodel/package_signaturekind.md index 4c6c247ed3..8099aba6a1 100644 --- a/windows.applicationmodel/package_signaturekind.md +++ b/windows.applicationmodel/package_signaturekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.Package.SignatureKind --api-type: winrt property ---- # Windows.ApplicationModel.Package.SignatureKind ## -description How the app package is signed. ## -property-value The signature kind. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.SignatureKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.SignatureKind + +## -description +How the app package is signed. + +## -property-value +The signature kind. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_status.md b/windows.applicationmodel/package_status.md index 3c61ede71f..aa792a7130 100644 --- a/windows.applicationmodel/package_status.md +++ b/windows.applicationmodel/package_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.Package.Status --api-type: winrt property ---- # Windows.ApplicationModel.Package.Status ## -description Get the current status of the package for the user. ## -property-value The current status of the package for the user. ## -remarks ## -examples ## -see-also [PackageStatus](packagestatus.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Package.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Package.Status + +## -description +Get the current status of the package for the user. + +## -property-value +The current status of the package for the user. + +## -remarks + +## -examples + +## -see-also +[PackageStatus](packagestatus.md) \ No newline at end of file diff --git a/windows.applicationmodel/package_verifycontentintegrityasync_258900139.md b/windows.applicationmodel/package_verifycontentintegrityasync_258900139.md index 1686216cca..346bd81f67 100644 --- a/windows.applicationmodel/package_verifycontentintegrityasync_258900139.md +++ b/windows.applicationmodel/package_verifycontentintegrityasync_258900139.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.Package.VerifyContentIntegrityAsync --api-type: winrt method ---- # Windows.ApplicationModel.Package.VerifyContentIntegrityAsync ## -description Ensures that the package has not been modified or tampered with before being loaded. ## -returns **true** - the package has not been modified; **false** otherwise. ## -remarks This function only verifies that the package's contents have not been modified. It does not verify the package's status, origin, and so on. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.Package.VerifyContentIntegrityAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.VerifyContentIntegrityAsync + +## -description +Ensures that the package has not been modified or tampered with before being loaded. + +## -returns +**true** - the package has not been modified; **false** otherwise. + +## -remarks +This function only verifies that the package's contents have not been modified. It does not verify the package's status, origin, and so on. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagecatalog_openforcurrentpackage_1766019189.md b/windows.applicationmodel/packagecatalog_openforcurrentpackage_1766019189.md index 3a9fc41007..e0f7874bd8 100644 --- a/windows.applicationmodel/packagecatalog_openforcurrentpackage_1766019189.md +++ b/windows.applicationmodel/packagecatalog_openforcurrentpackage_1766019189.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.ApplicationModel.PackageCatalog.OpenForCurrentPackage --api-type: winrt method ---- # Windows.ApplicationModel.PackageCatalog.OpenForCurrentPackage ## -description Opens the catalog of packages for the main package. ## -returns The package catalog for the main package. ## -remarks Use [Package.Dependencies](package_dependencies.md) to get the list of optional packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.PackageCatalog.OpenForCurrentPackage +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.PackageCatalog.OpenForCurrentPackage + +## -description +Opens the catalog of packages for the main package. + +## -returns +The package catalog for the main package. + +## -remarks +Use [Package.Dependencies](package_dependencies.md) to get the list of optional packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md b/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md index 7b8d6398ce..76fa18b8b1 100644 --- a/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md +++ b/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.PackageCatalog.OpenForCurrentUser --api-type: winrt method ---- # Windows.ApplicationModel.PackageCatalog.OpenForCurrentUser ## -description Opens the catalog of appx packages on the device that are available to the current user. ## -returns The catalog of packages for the current user. ## -remarks ## -examples ## -see-also [PackageManager.FindPackages](../windows.management.deployment/packagemanager_findpackages.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.PackageCatalog.OpenForCurrentUser +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.PackageCatalog.OpenForCurrentUser + +## -description +Opens the catalog of appx packages on the device that are available to the current user. + +## -returns +The catalog of packages for the current user. + +## -remarks + +## -examples + +## -see-also +[PackageManager.FindPackages](../windows.management.deployment/packagemanager_findpackages.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.applicationmodel/packagecatalog_packageinstalling.md b/windows.applicationmodel/packagecatalog_packageinstalling.md index e58e579a52..e867dc3b73 100644 --- a/windows.applicationmodel/packagecatalog_packageinstalling.md +++ b/windows.applicationmodel/packagecatalog_packageinstalling.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.PackageCatalog.PackageInstalling --api-type: winrt event ---- # Windows.ApplicationModel.PackageCatalog.PackageInstalling ## -description Indicates that an optional appx package is installing. ## -remarks Apps only receive package events for their optional packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.PackageCatalog.PackageInstalling +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.PackageCatalog.PackageInstalling + +## -description +Indicates that an optional appx package is installing. + +## -remarks +Apps only receive package events for their optional packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagecatalog_packagestaging.md b/windows.applicationmodel/packagecatalog_packagestaging.md index 32552898b0..bd15eef4c8 100644 --- a/windows.applicationmodel/packagecatalog_packagestaging.md +++ b/windows.applicationmodel/packagecatalog_packagestaging.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.ApplicationModel.PackageCatalog.PackageStaging --api-type: winrt event ---- # Windows.ApplicationModel.PackageCatalog.PackageStaging ## -description Indicates that an optional appx package is staging. ## -remarks An appx package is staged when it is added to the device but is not yet registered. Apps only receive package events for their optional packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.PackageCatalog.PackageStaging +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.PackageCatalog.PackageStaging + +## -description +Indicates that an optional appx package is staging. + +## -remarks +An appx package is staged when it is added to the device but is not yet registered. + +Apps only receive package events for their optional packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagecatalog_packagestatuschanged.md b/windows.applicationmodel/packagecatalog_packagestatuschanged.md index 200466dd56..37e0ee0cd6 100644 --- a/windows.applicationmodel/packagecatalog_packagestatuschanged.md +++ b/windows.applicationmodel/packagecatalog_packagestatuschanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.PackageCatalog.PackageStatusChanged --api-type: winrt event ---- # Windows.ApplicationModel.PackageCatalog.PackageStatusChanged ## -description Indicates that an optional package has been removed or updated ## -remarks Apps only receive package events for their optional packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.PackageCatalog.PackageStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.PackageCatalog.PackageStatusChanged + +## -description +Indicates that an optional package has been removed or updated + +## -remarks +Apps only receive package events for their optional packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagecatalog_packageuninstalling.md b/windows.applicationmodel/packagecatalog_packageuninstalling.md index eff46a0b9a..4cf5536400 100644 --- a/windows.applicationmodel/packagecatalog_packageuninstalling.md +++ b/windows.applicationmodel/packagecatalog_packageuninstalling.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.PackageCatalog.PackageUninstalling --api-type: winrt event ---- # Windows.ApplicationModel.PackageCatalog.PackageUninstalling ## -description Indicates that an optional appx package is uninstalling. ## -remarks Apps only receive package events for their optional packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.PackageCatalog.PackageUninstalling +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.PackageCatalog.PackageUninstalling + +## -description +Indicates that an optional appx package is uninstalling. + +## -remarks +Apps only receive package events for their optional packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagecatalog_packageupdating.md b/windows.applicationmodel/packagecatalog_packageupdating.md index 6f63cc998c..d121ec292a 100644 --- a/windows.applicationmodel/packagecatalog_packageupdating.md +++ b/windows.applicationmodel/packagecatalog_packageupdating.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.ApplicationModel.PackageCatalog.PackageUpdating --api-type: winrt event ---- # Windows.ApplicationModel.PackageCatalog.PackageUpdating ## -description Indicates that an optional appx package is being updated. ## -remarks Apps only receive package events for their optional packages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.ApplicationModel.PackageCatalog.PackageUpdating +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.PackageCatalog.PackageUpdating + +## -description +Indicates that an optional appx package is being updated. + +## -remarks +Apps only receive package events for their optional packages. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageid_architecture.md b/windows.applicationmodel/packageid_architecture.md index 12a2590e56..d5dc90488f 100644 --- a/windows.applicationmodel/packageid_architecture.md +++ b/windows.applicationmodel/packageid_architecture.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.Architecture --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.Architecture ## -description Gets the processor architecture for which the package was created. ## -property-value The processor architecture. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.Architecture +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.Architecture + +## -description +Gets the processor architecture for which the package was created. + +## -property-value +The processor architecture. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_author.md b/windows.applicationmodel/packageid_author.md index e6cfa08932..5a2f08a271 100644 --- a/windows.applicationmodel/packageid_author.md +++ b/windows.applicationmodel/packageid_author.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.Author --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.Author ## -description Windows Phone only. Gets the value of the Author attribute for the specified application package. ## -property-value The value of the Author attribute the specified application package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.Author +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.Author + +## -description +Windows Phone only. Gets the value of the Author attribute for the specified application package. + +## -property-value +The value of the Author attribute the specified application package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageid_familyname.md b/windows.applicationmodel/packageid_familyname.md index a9bf6ab257..2c053b5052 100644 --- a/windows.applicationmodel/packageid_familyname.md +++ b/windows.applicationmodel/packageid_familyname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.FamilyName --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.FamilyName ## -description Gets the family name of the package. ## -property-value The family name. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.FullName](packageid_fullname.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.FamilyName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.FamilyName + +## -description +Gets the family name of the package. + +## -property-value +The family name. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.FullName](packageid_fullname.md) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_fullname.md b/windows.applicationmodel/packageid_fullname.md index e76629a2ad..c7390ab356 100644 --- a/windows.applicationmodel/packageid_fullname.md +++ b/windows.applicationmodel/packageid_fullname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.FullName --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.FullName ## -description Gets the full name of the package. ## -property-value The full name. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.FamilyName](packageid_familyname.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.FullName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.FullName + +## -description +Gets the full name of the package. + +## -property-value +The full name. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.FamilyName](packageid_familyname.md) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_name.md b/windows.applicationmodel/packageid_name.md index bee91665be..57eee286e6 100644 --- a/windows.applicationmodel/packageid_name.md +++ b/windows.applicationmodel/packageid_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.Name --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.Name ## -description Gets the name of the package. ## -property-value The package name. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.Name + +## -description +Gets the name of the package. + +## -property-value +The package name. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_productid.md b/windows.applicationmodel/packageid_productid.md index b50495e3c1..9d26fb9ee5 100644 --- a/windows.applicationmodel/packageid_productid.md +++ b/windows.applicationmodel/packageid_productid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.ProductId --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.ProductId ## -description Windows Phone only. Gets the value of the ProductID attribute associated with this application package. ## -property-value The value of the ProductID attribute associated with this application package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.ProductId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.ProductId + +## -description +Windows Phone only. Gets the value of the ProductID attribute associated with this application package. + +## -property-value +The value of the ProductID attribute associated with this application package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageid_publisher.md b/windows.applicationmodel/packageid_publisher.md index 6591a43b04..d2153a9e72 100644 --- a/windows.applicationmodel/packageid_publisher.md +++ b/windows.applicationmodel/packageid_publisher.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.Publisher --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.Publisher ## -description Gets the publisher of the package. ## -property-value The publisher. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.PublisherId](packageid_publisherid.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.Publisher +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.Publisher + +## -description +Gets the publisher of the package. + +## -property-value +The publisher. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.PublisherId](packageid_publisherid.md) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_publisherid.md b/windows.applicationmodel/packageid_publisherid.md index 3abb1951b2..933590b6f5 100644 --- a/windows.applicationmodel/packageid_publisherid.md +++ b/windows.applicationmodel/packageid_publisherid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.PublisherId --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.PublisherId ## -description Gets the publisher ID of the package. ## -property-value The publisher ID. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.Publisher](packageid_publisher.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.PublisherId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.PublisherId + +## -description +Gets the publisher ID of the package. + +## -property-value +The publisher ID. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageId.Publisher](packageid_publisher.md) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_resourceid.md b/windows.applicationmodel/packageid_resourceid.md index 2ee50b8b80..2b51fd3e55 100644 --- a/windows.applicationmodel/packageid_resourceid.md +++ b/windows.applicationmodel/packageid_resourceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.ResourceId --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.ResourceId ## -description Gets the resource ID of the package. ## -property-value The resource ID. If there is no resource ID for the package, this property is null. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.ResourceId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.ResourceId + +## -description +Gets the resource ID of the package. + +## -property-value +The resource ID. If there is no resource ID for the package, this property is null. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file diff --git a/windows.applicationmodel/packageid_version.md b/windows.applicationmodel/packageid_version.md index 5013ecbcc4..21c88ff35b 100644 --- a/windows.applicationmodel/packageid_version.md +++ b/windows.applicationmodel/packageid_version.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageId.Version --api-type: winrt property ---- # Windows.ApplicationModel.PackageId.Version ## -description Gets the package version info. ## -property-value The package version information. ## -remarks ## -examples ## -see-also [App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageVersion](packageversion.md) \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageId.Version +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageId.Version + +## -description +Gets the package version info. + +## -property-value +The package version information. + +## -remarks + +## -examples + +## -see-also +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa), [PackageVersion](packageversion.md) \ No newline at end of file diff --git a/windows.applicationmodel/packageinstallingeventargs_activityid.md b/windows.applicationmodel/packageinstallingeventargs_activityid.md index a875bfbf32..e1038743f0 100644 --- a/windows.applicationmodel/packageinstallingeventargs_activityid.md +++ b/windows.applicationmodel/packageinstallingeventargs_activityid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.ActivityId --api-type: winrt property ---- # Windows.ApplicationModel.PackageInstallingEventArgs.ActivityId ## -description Gets the id for the install operation. ## -property-value A unique value that an app can use to correlate events that relate to a single deployment operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.ActivityId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageInstallingEventArgs.ActivityId + +## -description +Gets the id for the install operation. + +## -property-value +A unique value that an app can use to correlate events that relate to a single deployment operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageinstallingeventargs_errorcode.md b/windows.applicationmodel/packageinstallingeventargs_errorcode.md index 46930e4839..1b0513e923 100644 --- a/windows.applicationmodel/packageinstallingeventargs_errorcode.md +++ b/windows.applicationmodel/packageinstallingeventargs_errorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.ErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.PackageInstallingEventArgs.ErrorCode ## -description Gets the result of the package installation operation. ## -property-value The code for the error. **S_OK** if no error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageInstallingEventArgs.ErrorCode + +## -description +Gets the result of the package installation operation. + +## -property-value +The code for the error. **S_OK** if no error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageinstallingeventargs_iscomplete.md b/windows.applicationmodel/packageinstallingeventargs_iscomplete.md index a47b4d4a9b..81f912dd78 100644 --- a/windows.applicationmodel/packageinstallingeventargs_iscomplete.md +++ b/windows.applicationmodel/packageinstallingeventargs_iscomplete.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.IsComplete --api-type: winrt property ---- # Windows.ApplicationModel.PackageInstallingEventArgs.IsComplete ## -description Indicates whether the appx package is done installing. ## -property-value **True** indicates that the appx package is done installing; **false**, otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.IsComplete +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageInstallingEventArgs.IsComplete + +## -description +Indicates whether the appx package is done installing. + +## -property-value +**True** indicates that the appx package is done installing; **false**, otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageinstallingeventargs_package.md b/windows.applicationmodel/packageinstallingeventargs_package.md index c992db17c7..859e9d7e39 100644 --- a/windows.applicationmodel/packageinstallingeventargs_package.md +++ b/windows.applicationmodel/packageinstallingeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.PackageInstallingEventArgs.Package ## -description Gets the package that is installing. ## -property-value The incoming package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageInstallingEventArgs.Package + +## -description +Gets the package that is installing. + +## -property-value +The incoming package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageinstallingeventargs_progress.md b/windows.applicationmodel/packageinstallingeventargs_progress.md index f1c8ddf1b2..783208f24a 100644 --- a/windows.applicationmodel/packageinstallingeventargs_progress.md +++ b/windows.applicationmodel/packageinstallingeventargs_progress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.Progress --api-type: winrt property ---- # Windows.ApplicationModel.PackageInstallingEventArgs.Progress ## -description Gets an approximation of the package's installation progress. ## -property-value A value in the range of 0 through 1.0 which represents approximately how far along the package is in the installation process. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageInstallingEventArgs.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageInstallingEventArgs.Progress + +## -description +Gets an approximation of the package's installation progress. + +## -property-value +A value in the range of 0 through 1.0 which represents approximately how far along the package is in the installation process. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestagingeventargs_activityid.md b/windows.applicationmodel/packagestagingeventargs_activityid.md index b4b327f813..8cc132073e 100644 --- a/windows.applicationmodel/packagestagingeventargs_activityid.md +++ b/windows.applicationmodel/packagestagingeventargs_activityid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.ActivityId --api-type: winrt property ---- # Windows.ApplicationModel.PackageStagingEventArgs.ActivityId ## -description Gets the id for the staging operation. ## -property-value A unique value that an app can use to correlate events that relate to a single deployment operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.ActivityId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStagingEventArgs.ActivityId + +## -description +Gets the id for the staging operation. + + + +## -property-value +A unique value that an app can use to correlate events that relate to a single deployment operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestagingeventargs_errorcode.md b/windows.applicationmodel/packagestagingeventargs_errorcode.md index 15efed9cfc..88626a7839 100644 --- a/windows.applicationmodel/packagestagingeventargs_errorcode.md +++ b/windows.applicationmodel/packagestagingeventargs_errorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.ErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.PackageStagingEventArgs.ErrorCode ## -description Gets the result of the package staging operation. ## -property-value The code for the error. **S_OK** if no error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStagingEventArgs.ErrorCode + +## -description +Gets the result of the package staging operation. + +## -property-value +The code for the error. **S_OK** if no error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestagingeventargs_iscomplete.md b/windows.applicationmodel/packagestagingeventargs_iscomplete.md index ac39a7381c..9e571462bc 100644 --- a/windows.applicationmodel/packagestagingeventargs_iscomplete.md +++ b/windows.applicationmodel/packagestagingeventargs_iscomplete.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.IsComplete --api-type: winrt property ---- # Windows.ApplicationModel.PackageStagingEventArgs.IsComplete ## -description Indicates whether the appx package is done staging. ## -property-value **True** indicates that the appx package is done staging; **false**, otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.IsComplete +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStagingEventArgs.IsComplete + +## -description +Indicates whether the appx package is done staging. + +## -property-value +**True** indicates that the appx package is done staging; **false**, otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestagingeventargs_package.md b/windows.applicationmodel/packagestagingeventargs_package.md index 2025f46da3..64aec20fcd 100644 --- a/windows.applicationmodel/packagestagingeventargs_package.md +++ b/windows.applicationmodel/packagestagingeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.PackageStagingEventArgs.Package ## -description Gets the package that is staging. ## -property-value The package being staged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStagingEventArgs.Package + +## -description +Gets the package that is staging. + +## -property-value +The package being staged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestagingeventargs_progress.md b/windows.applicationmodel/packagestagingeventargs_progress.md index fccd19751e..dab2fdd654 100644 --- a/windows.applicationmodel/packagestagingeventargs_progress.md +++ b/windows.applicationmodel/packagestagingeventargs_progress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.Progress --api-type: winrt property ---- # Windows.ApplicationModel.PackageStagingEventArgs.Progress ## -description Gets an approximation of the package's staging progress. ## -property-value A value in the range of 0 through 1.0 which represents approximately how far along the package is in the staging process. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStagingEventArgs.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStagingEventArgs.Progress + +## -description +Gets an approximation of the package's staging progress. + +## -property-value +A value in the range of 0 through 1.0 which represents approximately how far along the package is in the staging process. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus.md b/windows.applicationmodel/packagestatus.md index e85f4e31b3..6d3ca9490f 100644 --- a/windows.applicationmodel/packagestatus.md +++ b/windows.applicationmodel/packagestatus.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.ApplicationModel.PackageStatus --api-type: winrt class ---- # Windows.ApplicationModel.PackageStatus ## -description Provides the status of the package. ## -remarks Use the [Package.Status](package_status.md) property to get the [PackageStatus](packagestatus.md). The [Package.Status](package_status.md) and all of the properties of the [PackageStatus](packagestatus.md) class are read-only, so you cannot change their values. To get updated information about the status of the package, access the [Package.Status](package_status.md) property again to get a new instance of the [PackageStatus](packagestatus.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.PackageStatus +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.PackageStatus + +## -description +Provides the status of the package. + +## -remarks +Use the [Package.Status](package_status.md) property to get the [PackageStatus](packagestatus.md). The [Package.Status](package_status.md) and all of the properties of the [PackageStatus](packagestatus.md) class are read-only, so you cannot change their values. To get updated information about the status of the package, access the [Package.Status](package_status.md) property again to get a new instance of the [PackageStatus](packagestatus.md) class. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_dataoffline.md b/windows.applicationmodel/packagestatus_dataoffline.md index c10eeed0e1..6c73a3dd66 100644 --- a/windows.applicationmodel/packagestatus_dataoffline.md +++ b/windows.applicationmodel/packagestatus_dataoffline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.DataOffline --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.DataOffline ## -description Indicates whether the data for the package is offline. ## -property-value **TRUE** indicates that the data for the package is installed on a volume which is currently offline or cannot be accessed; otherwise **FALSE**. ## -remarks One reason that the data could be offline is that it is stored on removable media that has been removed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.DataOffline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.DataOffline + +## -description +Indicates whether the data for the package is offline. + +## -property-value +**TRUE** indicates that the data for the package is installed on a volume which is currently offline or cannot be accessed; otherwise **FALSE**. + +## -remarks +One reason that the data could be offline is that it is stored on removable media that has been removed. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_dependencyissue.md b/windows.applicationmodel/packagestatus_dependencyissue.md index 8a410175a2..be1691c49e 100644 --- a/windows.applicationmodel/packagestatus_dependencyissue.md +++ b/windows.applicationmodel/packagestatus_dependencyissue.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.DependencyIssue --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.DependencyIssue ## -description Indicates whether this package depends on a package that can't be used. ## -property-value **TRUE** indicates that there is a problem with a package that this package depends on; otherwise **FALSE**. ## -remarks The issue with the package that this package depends on must be resolved before this package can be used. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.DependencyIssue +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.DependencyIssue + +## -description +Indicates whether this package depends on a package that can't be used. + +## -property-value +**TRUE** indicates that there is a problem with a package that this package depends on; otherwise **FALSE**. + +## -remarks +The issue with the package that this package depends on must be resolved before this package can be used. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_deploymentinprogress.md b/windows.applicationmodel/packagestatus_deploymentinprogress.md index 6570219d24..f7eb9332df 100644 --- a/windows.applicationmodel/packagestatus_deploymentinprogress.md +++ b/windows.applicationmodel/packagestatus_deploymentinprogress.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.DeploymentInProgress --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.DeploymentInProgress ## -description Indicates whether the package is being serviced. ## -property-value **TRUE** indicates that the package is being serviced and consequently cannot be used; otherwise **FALSE**. ## -remarks A package that is in the process of being updated is an example of a package being serviced. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.DeploymentInProgress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.DeploymentInProgress + +## -description +Indicates whether the package is being serviced. + +## -property-value +**TRUE** indicates that the package is being serviced and consequently cannot be used; otherwise **FALSE**. + +## -remarks +A package that is in the process of being updated is an example of a package being serviced. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_disabled.md b/windows.applicationmodel/packagestatus_disabled.md index 62083e6c05..409088f76e 100644 --- a/windows.applicationmodel/packagestatus_disabled.md +++ b/windows.applicationmodel/packagestatus_disabled.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.Disabled --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.Disabled ## -description Indicates whether the package has been disabled. ## -property-value **TRUE** indicates that the package is disabled; otherwise **FALSE**. ## -remarks Disabled packages must be enabled before they can be used. Packages are disabled by using [PackageManager.SetPackageStatus](../windows.management.deployment/packagemanager_setpackagestatus.md) and enabled by using [PackageManager.ClearPackageStatus](../windows.management.deployment/packagemanager_clearpackagestatus.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.Disabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.Disabled + +## -description +Indicates whether the package has been disabled. + +## -property-value +**TRUE** indicates that the package is disabled; otherwise **FALSE**. + +## -remarks +Disabled packages must be enabled before they can be used. + +Packages are disabled by using [PackageManager.SetPackageStatus](../windows.management.deployment/packagemanager_setpackagestatus.md) and enabled by using [PackageManager.ClearPackageStatus](../windows.management.deployment/packagemanager_clearpackagestatus.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_licenseissue.md b/windows.applicationmodel/packagestatus_licenseissue.md index d3b01a5d8e..354f4234dd 100644 --- a/windows.applicationmodel/packagestatus_licenseissue.md +++ b/windows.applicationmodel/packagestatus_licenseissue.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.LicenseIssue --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.LicenseIssue ## -description Indicates whether there is a problem with the license for this package. ## -property-value **TRUE** indicates that there is a problem with the license for this package; otherwise **FALSE**. ## -remarks Examples of license problems include missing and expired licenses. License problems must be resolved before the package can be used. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.LicenseIssue +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.LicenseIssue + +## -description +Indicates whether there is a problem with the license for this package. + +## -property-value +**TRUE** indicates that there is a problem with the license for this package; otherwise **FALSE**. + +## -remarks +Examples of license problems include missing and expired licenses. License problems must be resolved before the package can be used. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_modified.md b/windows.applicationmodel/packagestatus_modified.md index 41a724bc87..9160d79cba 100644 --- a/windows.applicationmodel/packagestatus_modified.md +++ b/windows.applicationmodel/packagestatus_modified.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.Modified --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.Modified ## -description Indicates whether the package is missing files, system information, etc. ## -property-value **TRUE** indicates that there is a problem with the package such as missing files; otherwise **FALSE**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.Modified +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.Modified + +## -description +Indicates whether the package is missing files, system information, etc. + +## -property-value +**TRUE** indicates that there is a problem with the package such as missing files; otherwise **FALSE**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_needsremediation.md b/windows.applicationmodel/packagestatus_needsremediation.md index 17830f54c9..c0283b194d 100644 --- a/windows.applicationmodel/packagestatus_needsremediation.md +++ b/windows.applicationmodel/packagestatus_needsremediation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.NeedsRemediation --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.NeedsRemediation ## -description Indicates whether the package is unusable. ## -property-value **FALSE** indicates that the package is in a usable state; otherwise **TRUE**. ## -remarks This property reflects a set of properties that you would otherwise have to query individually to determine if the package is usable. For example this property reflects whether one or more of [NotAvailable](packagestatus_notavailable.md), [LicenseIssue](packagestatus_licenseissue.md), [Modified](packagestatus_modified.md), or [Tampered](packagestatus_tampered.md) are set. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.NeedsRemediation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.NeedsRemediation + +## -description +Indicates whether the package is unusable. + +## -property-value +**FALSE** indicates that the package is in a usable state; otherwise **TRUE**. + +## -remarks +This property reflects a set of properties that you would otherwise have to query individually to determine if the package is usable. For example this property reflects whether one or more of [NotAvailable](packagestatus_notavailable.md), [LicenseIssue](packagestatus_licenseissue.md), [Modified](packagestatus_modified.md), or [Tampered](packagestatus_tampered.md) are set. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_notavailable.md b/windows.applicationmodel/packagestatus_notavailable.md index 55ecb9f759..495857e9f1 100644 --- a/windows.applicationmodel/packagestatus_notavailable.md +++ b/windows.applicationmodel/packagestatus_notavailable.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.NotAvailable --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.NotAvailable ## -description Indicates whether the package is available. ## -property-value **TRUE** indicates that the package is not available; otherwise **FALSE**. ## -remarks A package may be unavailable for multiple reasons. This property reflects a set of properties that you would otherwise have to query individually to determine if the package is unavailable. For example this property reflects whether one or more of [DataOffline](packagestatus_dataoffline.md), [Disabled](packagestatus_disabled.md), or [PackageOffline](packagestatus_packageoffline.md) is set. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.NotAvailable +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.NotAvailable + +## -description +Indicates whether the package is available. + +## -property-value +**TRUE** indicates that the package is not available; otherwise **FALSE**. + +## -remarks +A package may be unavailable for multiple reasons. This property reflects a set of properties that you would otherwise have to query individually to determine if the package is unavailable. For example this property reflects whether one or more of [DataOffline](packagestatus_dataoffline.md), [Disabled](packagestatus_disabled.md), or [PackageOffline](packagestatus_packageoffline.md) is set. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_packageoffline.md b/windows.applicationmodel/packagestatus_packageoffline.md index 73f7873eeb..c06033a9cd 100644 --- a/windows.applicationmodel/packagestatus_packageoffline.md +++ b/windows.applicationmodel/packagestatus_packageoffline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.PackageOffline --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.PackageOffline ## -description Indicates whether the package is offline and cannot be used. ## -property-value **TRUE** indicates that the package is offline; otherwise **FALSE**. ## -remarks A package is offline if any of the package's files are installed on a volume that is currently offline or cannot be accessed. For example, the package's files may have been installed on removable media that is no longer online. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.PackageOffline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.PackageOffline + +## -description +Indicates whether the package is offline and cannot be used. + +## -property-value +**TRUE** indicates that the package is offline; otherwise **FALSE**. + +## -remarks +A package is offline if any of the package's files are installed on a volume that is currently offline or cannot be accessed. For example, the package's files may have been installed on removable media that is no longer online. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_servicing.md b/windows.applicationmodel/packagestatus_servicing.md index 1c821b1f8c..3b548d85d1 100644 --- a/windows.applicationmodel/packagestatus_servicing.md +++ b/windows.applicationmodel/packagestatus_servicing.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.Servicing --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.Servicing ## -description Indicates whether the package is being serviced. ## -property-value **TRUE** indicates that the package is being serviced; otherwise **FALSE**. ## -remarks This property reflects whether any of the reasons that a package may be serviced are currently true such as [DeploymentInProgress](packagestatus_deploymentinprogress.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.Servicing +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.Servicing + +## -description +Indicates whether the package is being serviced. + +## -property-value +**TRUE** indicates that the package is being serviced; otherwise **FALSE**. + +## -remarks +This property reflects whether any of the reasons that a package may be serviced are currently true such as [DeploymentInProgress](packagestatus_deploymentinprogress.md). + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_tampered.md b/windows.applicationmodel/packagestatus_tampered.md index dff9823fb8..fc5ebcee68 100644 --- a/windows.applicationmodel/packagestatus_tampered.md +++ b/windows.applicationmodel/packagestatus_tampered.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatus.Tampered --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatus.Tampered ## -description Indicates whether the package may have been tampered with. ## -property-value **TRUE** indicates that the package has been tampered with; otherwise **FALSE**. ## -remarks One reason a package may return **TRUE** for this property is if 3rd party anti-malware software flags the package as malware. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.Tampered +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.Tampered + +## -description +Indicates whether the package may have been tampered with. + +## -property-value +**TRUE** indicates that the package has been tampered with; otherwise **FALSE**. + +## -remarks +One reason a package may return **TRUE** for this property is if 3rd party anti-malware software flags the package as malware. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatus_verifyisok_1370442709.md b/windows.applicationmodel/packagestatus_verifyisok_1370442709.md index fb7bc8ab4c..b2cee61ea9 100644 --- a/windows.applicationmodel/packagestatus_verifyisok_1370442709.md +++ b/windows.applicationmodel/packagestatus_verifyisok_1370442709.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.ApplicationModel.PackageStatus.VerifyIsOK --api-type: winrt method ---- # Windows.ApplicationModel.PackageStatus.VerifyIsOK ## -description Indicates whether the package is in good condition and may be used. ## -returns **TRUE** indicates that the package is in good condition; otherwise **FALSE**. ## -remarks This property reflects a set of properties that you would otherwise have to query individually to determine if the package is in good condition and is usable. For example this property reflects whether [NotAvailable](packagestatus_notavailable.md), [LicenseIssue](packagestatus_licenseissue.md), [Modified](packagestatus_modified.md), [Tampered ](packagestatus_tampered.md) are not set. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.PackageStatus.VerifyIsOK +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.PackageStatus.VerifyIsOK + +## -description +Indicates whether the package is in good condition and may be used. + +## -returns +**TRUE** indicates that the package is in good condition; otherwise **FALSE**. + +## -remarks +This property reflects a set of properties that you would otherwise have to query individually to determine if the package is in good condition and is usable. For example this property reflects whether [NotAvailable](packagestatus_notavailable.md), [LicenseIssue](packagestatus_licenseissue.md), [Modified](packagestatus_modified.md), [Tampered ](packagestatus_tampered.md) are not set. + + + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packagestatuschangedeventargs_package.md b/windows.applicationmodel/packagestatuschangedeventargs_package.md index a3090b7483..b21bfe914f 100644 --- a/windows.applicationmodel/packagestatuschangedeventargs_package.md +++ b/windows.applicationmodel/packagestatuschangedeventargs_package.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageStatusChangedEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.PackageStatusChangedEventArgs.Package ## -description The package that has changed. ## -property-value The package that has changed. A package is changed when it is installed, uninstalled, or updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageStatusChangedEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatusChangedEventArgs.Package + +## -description +The package that has changed. + +## -property-value +The package that has changed. A package is changed when it is installed, uninstalled, or updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageuninstallingeventargs_activityid.md b/windows.applicationmodel/packageuninstallingeventargs_activityid.md index 3a7c43bb76..b0f27f7d3d 100644 --- a/windows.applicationmodel/packageuninstallingeventargs_activityid.md +++ b/windows.applicationmodel/packageuninstallingeventargs_activityid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.ActivityId --api-type: winrt property ---- # Windows.ApplicationModel.PackageUninstallingEventArgs.ActivityId ## -description Gets the id for the uninstall operation. ## -property-value A unique value that an app can use to correlate events that relate to a single deployment operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.ActivityId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUninstallingEventArgs.ActivityId + +## -description +Gets the id for the uninstall operation. + +## -property-value +A unique value that an app can use to correlate events that relate to a single deployment operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageuninstallingeventargs_errorcode.md b/windows.applicationmodel/packageuninstallingeventargs_errorcode.md index 487bb1deae..0da907b869 100644 --- a/windows.applicationmodel/packageuninstallingeventargs_errorcode.md +++ b/windows.applicationmodel/packageuninstallingeventargs_errorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.ErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.PackageUninstallingEventArgs.ErrorCode ## -description Gets the result of the package uninstall operation. ## -property-value The result of the package uninstall operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUninstallingEventArgs.ErrorCode + +## -description +Gets the result of the package uninstall operation. + +## -property-value +The result of the package uninstall operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md b/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md index 20f80d4070..f757de4239 100644 --- a/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md +++ b/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.IsComplete --api-type: winrt property ---- # Windows.ApplicationModel.PackageUninstallingEventArgs.IsComplete ## -description Indicates whether the appx package is done uninstalling. ## -property-value **True** indicates that the appx package is done uninstalling; **false**, otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.IsComplete +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUninstallingEventArgs.IsComplete + +## -description +Indicates whether the appx package is done uninstalling. + +## -property-value +**True** indicates that the appx package is done uninstalling; **false**, otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageuninstallingeventargs_package.md b/windows.applicationmodel/packageuninstallingeventargs_package.md index ba86becf43..a5b48dbe9c 100644 --- a/windows.applicationmodel/packageuninstallingeventargs_package.md +++ b/windows.applicationmodel/packageuninstallingeventargs_package.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.Package --api-type: winrt property ---- # Windows.ApplicationModel.PackageUninstallingEventArgs.Package ## -description Gets the package that is uninstalling. ## -property-value The package being uninstalled. ## -remarks Certain members of this package object may not be available (such as [Package.InstalledLocation](package_installedlocation.md)) while the package is being uninstalled. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUninstallingEventArgs.Package + +## -description +Gets the package that is uninstalling. + +## -property-value +The package being uninstalled. + +## -remarks +Certain members of this package object may not be available (such as [Package.InstalledLocation](package_installedlocation.md)) while the package is being uninstalled. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageuninstallingeventargs_progress.md b/windows.applicationmodel/packageuninstallingeventargs_progress.md index 8e01eaf9b9..0e27196101 100644 --- a/windows.applicationmodel/packageuninstallingeventargs_progress.md +++ b/windows.applicationmodel/packageuninstallingeventargs_progress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.Progress --api-type: winrt property ---- # Windows.ApplicationModel.PackageUninstallingEventArgs.Progress ## -description Gets an approximation of the package's uninstall progress. ## -property-value A value in the range of 0 through 1.0 which represents approximately how far along the package is in the uninstall process. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUninstallingEventArgs.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUninstallingEventArgs.Progress + +## -description +Gets an approximation of the package's uninstall progress. + +## -property-value +A value in the range of 0 through 1.0 which represents approximately how far along the package is in the uninstall process. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageupdatingeventargs_activityid.md b/windows.applicationmodel/packageupdatingeventargs_activityid.md index a83fe6d251..43a4b45af6 100644 --- a/windows.applicationmodel/packageupdatingeventargs_activityid.md +++ b/windows.applicationmodel/packageupdatingeventargs_activityid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.ActivityId --api-type: winrt property ---- # Windows.ApplicationModel.PackageUpdatingEventArgs.ActivityId ## -description Gets the id for the update operation. ## -property-value A unique value that an app can use to correlate events that relate to a single deployment operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.ActivityId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUpdatingEventArgs.ActivityId + +## -description +Gets the id for the update operation. + +## -property-value +A unique value that an app can use to correlate events that relate to a single deployment operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageupdatingeventargs_errorcode.md b/windows.applicationmodel/packageupdatingeventargs_errorcode.md index 3458e4a38f..1001f79588 100644 --- a/windows.applicationmodel/packageupdatingeventargs_errorcode.md +++ b/windows.applicationmodel/packageupdatingeventargs_errorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.ErrorCode --api-type: winrt property ---- # Windows.ApplicationModel.PackageUpdatingEventArgs.ErrorCode ## -description Gets the result of the package uninstall operation. ## -property-value The result of the package uninstall operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUpdatingEventArgs.ErrorCode + +## -description +Gets the result of the package uninstall operation. + +## -property-value +The result of the package uninstall operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageupdatingeventargs_iscomplete.md b/windows.applicationmodel/packageupdatingeventargs_iscomplete.md index 225a8fc427..412eb62d5d 100644 --- a/windows.applicationmodel/packageupdatingeventargs_iscomplete.md +++ b/windows.applicationmodel/packageupdatingeventargs_iscomplete.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.IsComplete --api-type: winrt property ---- # Windows.ApplicationModel.PackageUpdatingEventArgs.IsComplete ## -description Indicates whether the appx package is done updating. ## -property-value **True** if the appx package is done updating; **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.IsComplete +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUpdatingEventArgs.IsComplete + +## -description +Indicates whether the appx package is done updating. + +## -property-value +**True** if the appx package is done updating; **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageupdatingeventargs_progress.md b/windows.applicationmodel/packageupdatingeventargs_progress.md index 46292eb55b..12efd0c321 100644 --- a/windows.applicationmodel/packageupdatingeventargs_progress.md +++ b/windows.applicationmodel/packageupdatingeventargs_progress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.Progress --api-type: winrt property ---- # Windows.ApplicationModel.PackageUpdatingEventArgs.Progress ## -description Gets an approximation of the package's update progress. ## -property-value A value in the range of 0 through 1.0 which represents approximately how far along the package is in the update process. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUpdatingEventArgs.Progress + +## -description +Gets an approximation of the package's update progress. + +## -property-value +A value in the range of 0 through 1.0 which represents approximately how far along the package is in the update process. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageupdatingeventargs_sourcepackage.md b/windows.applicationmodel/packageupdatingeventargs_sourcepackage.md index a5beb81a9a..034ee6c7fd 100644 --- a/windows.applicationmodel/packageupdatingeventargs_sourcepackage.md +++ b/windows.applicationmodel/packageupdatingeventargs_sourcepackage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.SourcePackage --api-type: winrt property ---- # Windows.ApplicationModel.PackageUpdatingEventArgs.SourcePackage ## -description Gets the package that is being updated. ## -property-value The package being updated. This is the original package that was on the machine that is now being updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.SourcePackage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUpdatingEventArgs.SourcePackage + +## -description +Gets the package that is being updated. + +## -property-value +The package being updated. This is the original package that was on the machine that is now being updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/packageupdatingeventargs_targetpackage.md b/windows.applicationmodel/packageupdatingeventargs_targetpackage.md index deb1540944..8e7b41d05a 100644 --- a/windows.applicationmodel/packageupdatingeventargs_targetpackage.md +++ b/windows.applicationmodel/packageupdatingeventargs_targetpackage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.TargetPackage --api-type: winrt property ---- # Windows.ApplicationModel.PackageUpdatingEventArgs.TargetPackage ## -description Gets the updated package. ## -property-value This is the new package that is an update to the old package on the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.PackageUpdatingEventArgs.TargetPackage +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageUpdatingEventArgs.TargetPackage + +## -description +Gets the updated package. + +## -property-value +This is the new package that is an update to the old package on the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask.md b/windows.applicationmodel/startuptask.md index 73daaa1bec..ae457adb6a 100644 --- a/windows.applicationmodel/startuptask.md +++ b/windows.applicationmodel/startuptask.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.ApplicationModel.StartupTask --api-type: winrt class ---- # Windows.ApplicationModel.StartupTask ## -description Represents a background task that runs automatically whenever the user logs on to their device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.ApplicationModel.StartupTask +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.StartupTask + +## -description +Represents a background task that runs automatically whenever the user logs on to their device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask_disable_855128550.md b/windows.applicationmodel/startuptask_disable_855128550.md index f47088d4d6..8225f26830 100644 --- a/windows.applicationmodel/startuptask_disable_855128550.md +++ b/windows.applicationmodel/startuptask_disable_855128550.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.ApplicationModel.StartupTask.Disable --api-type: winrt method ---- # Windows.ApplicationModel.StartupTask.Disable ## -description Disables the startup task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.StartupTask.Disable +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.StartupTask.Disable + +## -description +Disables the startup task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask_getasync_1291799672.md b/windows.applicationmodel/startuptask_getasync_1291799672.md index 8624ae6d8f..61aa0381c1 100644 --- a/windows.applicationmodel/startuptask_getasync_1291799672.md +++ b/windows.applicationmodel/startuptask_getasync_1291799672.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.ApplicationModel.StartupTask.GetAsync(System.String) --api-type: winrt method ---- # Windows.ApplicationModel.StartupTask.GetAsync ## -description Gets a startup task by Id. ## -parameters ### -param taskId The Id of the startup task to get. ## -returns When this method completes, it returns the startup task with the given Id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.StartupTask.GetAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.StartupTask.GetAsync + +## -description +Gets a startup task by Id. + +## -parameters +### -param taskId +The Id of the startup task to get. + +## -returns +When this method completes, it returns the startup task with the given Id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask_getforcurrentpackageasync_892382072.md b/windows.applicationmodel/startuptask_getforcurrentpackageasync_892382072.md index 69ee8abaa6..40231c25af 100644 --- a/windows.applicationmodel/startuptask_getforcurrentpackageasync_892382072.md +++ b/windows.applicationmodel/startuptask_getforcurrentpackageasync_892382072.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.StartupTask.GetForCurrentPackageAsync --api-type: winrt method ---- # Windows.ApplicationModel.StartupTask.GetForCurrentPackageAsync ## -description Gets all startup tasks for the current app package. ## -returns When this method completes, it returns all startup tasks for the current app package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.StartupTask.GetForCurrentPackageAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.StartupTask.GetForCurrentPackageAsync + +## -description +Gets all startup tasks for the current app package. + +## -returns +When this method completes, it returns all startup tasks for the current app package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask_requestenableasync_1565937345.md b/windows.applicationmodel/startuptask_requestenableasync_1565937345.md index 1400539958..1fc2840e36 100644 --- a/windows.applicationmodel/startuptask_requestenableasync_1565937345.md +++ b/windows.applicationmodel/startuptask_requestenableasync_1565937345.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.ApplicationModel.StartupTask.RequestEnableAsync --api-type: winrt method ---- # Windows.ApplicationModel.StartupTask.RequestEnableAsync ## -description Requests enabling of the startup task. If the task was disabled by the user using Task Manager, this method will not override their choice; the user must re-enable your task manually. ## -returns When this method completes, it returns the state of the startup task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.StartupTask.RequestEnableAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.StartupTask.RequestEnableAsync + +## -description +Requests enabling of the startup task. If the task was disabled by the user using Task Manager, this method will not override their choice; the user must re-enable your task manually. + +## -returns +When this method completes, it returns the state of the startup task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask_state.md b/windows.applicationmodel/startuptask_state.md index a04f8c1bd4..bc1858d9aa 100644 --- a/windows.applicationmodel/startuptask_state.md +++ b/windows.applicationmodel/startuptask_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.StartupTask.State --api-type: winrt property ---- # Windows.ApplicationModel.StartupTask.State ## -description Gets the state (enabled, disabled, or disabled by user) of the startup task. ## -property-value The state of the startup task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.StartupTask.State +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.StartupTask.State + +## -description +Gets the state (enabled, disabled, or disabled by user) of the startup task. + +## -property-value +The state of the startup task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/startuptask_taskid.md b/windows.applicationmodel/startuptask_taskid.md index 9e53a9c327..db09bc231c 100644 --- a/windows.applicationmodel/startuptask_taskid.md +++ b/windows.applicationmodel/startuptask_taskid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.StartupTask.TaskId --api-type: winrt property ---- # Windows.ApplicationModel.StartupTask.TaskId ## -description Gets the Id of the startup task. ## -property-value The Id of the startup task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.StartupTask.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.StartupTask.TaskId + +## -description +Gets the Id of the startup task. + +## -property-value +The Id of the startup task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/suspendingdeferral_complete_1807836922.md b/windows.applicationmodel/suspendingdeferral_complete_1807836922.md index aceaba38aa..cf26e5ce70 100644 --- a/windows.applicationmodel/suspendingdeferral_complete_1807836922.md +++ b/windows.applicationmodel/suspendingdeferral_complete_1807836922.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.ApplicationModel.SuspendingDeferral.Complete --api-type: winrt method ---- # Windows.ApplicationModel.SuspendingDeferral.Complete ## -description Notifies the operating system that the app has saved its data and is ready to be suspended. ## -remarks ## -examples ## -see-also [UX guidelines for launch, suspend, and resume](http://msdn.microsoft.com/library/90770735-c2c5-4d3a-a21f-48a59e2a0ba9), [SuspendingEventArgs](suspendingeventargs.md), [SuspendingOperation](suspendingoperation.md), [SuspendingOperation.GetDeferral](suspendingoperation_getdeferral.md), [Handle app suspend](http://msdn.microsoft.com/library/f84f1512-24b9-45ec-bf23-a09e0ac985b0), [suspendingEventArgs](../windows.ui.webui/suspendingeventargs.md), [suspendingOperation](../windows.ui.webui/suspendingoperation.md), [suspendingOperation.getDeferral](../windows.ui.webui/suspendingoperation_getdeferral.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SuspendingDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SuspendingDeferral.Complete + +## -description +Notifies the operating system that the app has saved its data and is ready to be suspended. + +## -remarks + +## -examples + +## -see-also +[UX guidelines for launch, suspend, and resume](http://msdn.microsoft.com/library/90770735-c2c5-4d3a-a21f-48a59e2a0ba9), [SuspendingEventArgs](suspendingeventargs.md), [SuspendingOperation](suspendingoperation.md), [SuspendingOperation.GetDeferral](suspendingoperation_getdeferral.md), [Handle app suspend](http://msdn.microsoft.com/library/f84f1512-24b9-45ec-bf23-a09e0ac985b0), [suspendingEventArgs](../windows.ui.webui/suspendingeventargs.md), [suspendingOperation](../windows.ui.webui/suspendingoperation.md), [suspendingOperation.getDeferral](../windows.ui.webui/suspendingoperation_getdeferral.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10) \ No newline at end of file diff --git a/windows.applicationmodel/suspendingeventargs_suspendingoperation.md b/windows.applicationmodel/suspendingeventargs_suspendingoperation.md index dd15e91689..c49e0251ec 100644 --- a/windows.applicationmodel/suspendingeventargs_suspendingoperation.md +++ b/windows.applicationmodel/suspendingeventargs_suspendingoperation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SuspendingEventArgs.SuspendingOperation --api-type: winrt property ---- # Windows.ApplicationModel.SuspendingEventArgs.SuspendingOperation ## -description Gets the app suspending operation. ## -property-value The suspending operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SuspendingEventArgs.SuspendingOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SuspendingEventArgs.SuspendingOperation + +## -description +Gets the app suspending operation. + +## -property-value +The suspending operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/suspendingoperation_deadline.md b/windows.applicationmodel/suspendingoperation_deadline.md index 7999c2389b..c2aff853b4 100644 --- a/windows.applicationmodel/suspendingoperation_deadline.md +++ b/windows.applicationmodel/suspendingoperation_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.ApplicationModel.SuspendingOperation.Deadline --api-type: winrt property ---- # Windows.ApplicationModel.SuspendingOperation.Deadline ## -description Gets the time remaining before a delayed app suspending operation continues. ## -property-value The time remaining. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.SuspendingOperation.Deadline +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.SuspendingOperation.Deadline + +## -description +Gets the time remaining before a delayed app suspending operation continues. + +## -property-value +The time remaining. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel/suspendingoperation_getdeferral_254836512.md b/windows.applicationmodel/suspendingoperation_getdeferral_254836512.md index ab4bca2e25..428264a19b 100644 --- a/windows.applicationmodel/suspendingoperation_getdeferral_254836512.md +++ b/windows.applicationmodel/suspendingoperation_getdeferral_254836512.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.ApplicationModel.SuspendingOperation.GetDeferral --api-type: winrt method ---- # Windows.ApplicationModel.SuspendingOperation.GetDeferral ## -description Requests that the app suspending operation be delayed. ## -returns The suspension deferral. ## -remarks App suspension is delayed until the app calls the [SuspendingDeferral.Complete](suspendingdeferral_complete.md) method or the deadline for suspension has passed. ## -examples ## -see-also [UX guidelines for launch, suspend, and resume](http://msdn.microsoft.com/library/90770735-c2c5-4d3a-a21f-48a59e2a0ba9), [SuspendingEventArgs](suspendingeventargs.md), [SuspendingOperation.GetDeferral](suspendingoperation_getdeferral.md), [Handle app suspend](http://msdn.microsoft.com/library/f84f1512-24b9-45ec-bf23-a09e0ac985b0), [suspendingEventArgs](../windows.ui.webui/suspendingeventargs.md), [suspendingOperation.getDeferral](../windows.ui.webui/suspendingoperation_getdeferral.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10) \ No newline at end of file +--- +-api-id: M:Windows.ApplicationModel.SuspendingOperation.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.SuspendingOperation.GetDeferral + +## -description +Requests that the app suspending operation be delayed. + +## -returns +The suspension deferral. + +## -remarks +App suspension is delayed until the app calls the [SuspendingDeferral.Complete](suspendingdeferral_complete.md) method or the deadline for suspension has passed. + +## -examples + +## -see-also +[UX guidelines for launch, suspend, and resume](http://msdn.microsoft.com/library/90770735-c2c5-4d3a-a21f-48a59e2a0ba9), [SuspendingEventArgs](suspendingeventargs.md), [SuspendingOperation.GetDeferral](suspendingoperation_getdeferral.md), [Handle app suspend](http://msdn.microsoft.com/library/f84f1512-24b9-45ec-bf23-a09e0ac985b0), [suspendingEventArgs](../windows.ui.webui/suspendingeventargs.md), [suspendingOperation.getDeferral](../windows.ui.webui/suspendingoperation_getdeferral.md), [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10) \ No newline at end of file diff --git a/windows.data.html/htmlutilities_converttotext_787832085.md b/windows.data.html/htmlutilities_converttotext_787832085.md index 7c4081c5d0..801520a2eb 100644 --- a/windows.data.html/htmlutilities_converttotext_787832085.md +++ b/windows.data.html/htmlutilities_converttotext_787832085.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Html.HtmlUtilities.ConvertToText(System.String) --api-type: winrt method ---- # Windows.Data.Html.HtmlUtilities.ConvertToText ## -description Converts HTML-formatted data to a string that contains the text content extracted from the HTML. ## -parameters ### -param html A [String](https://msdn.microsoft.com/library/system.string.aspx) containing HTML-formatted data. ## -returns A [String](https://msdn.microsoft.com/library/system.string.aspx) of text content. ## -remarks The [ConvertToText](htmlutilities_converttotext.md) method is used to convert HTML-formatted data to a text string. The HTML-formatted data could represent an HTML document or an HTML fragment. When the [ConvertToText](htmlutilities_converttotext.md) method parses the HTML-formatted data, no scripts are run and no secondary downloads occur (scripts, images, and stylesheets, for example). The [ConvertToText](htmlutilities_converttotext.md) method will only parse HTML-formatted data to extract the text. If the *html* parameter contains a non-HTML string (XML or SVG, for example), then the return value will contain an empty string. If the *html* parameter contains a string that represents an HTML Frameset document, then the return value will contain an empty string. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Html.HtmlUtilities.ConvertToText(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Html.HtmlUtilities.ConvertToText + +## -description +Converts HTML-formatted data to a string that contains the text content extracted from the HTML. + +## -parameters +### -param html +A [String](https://msdn.microsoft.com/library/system.string.aspx) containing HTML-formatted data. + +## -returns +A [String](https://msdn.microsoft.com/library/system.string.aspx) of text content. + +## -remarks +The [ConvertToText](htmlutilities_converttotext.md) method is used to convert HTML-formatted data to a text string. The HTML-formatted data could represent an HTML document or an HTML fragment. When the [ConvertToText](htmlutilities_converttotext.md) method parses the HTML-formatted data, no scripts are run and no secondary downloads occur (scripts, images, and stylesheets, for example). + +The [ConvertToText](htmlutilities_converttotext.md) method will only parse HTML-formatted data to extract the text. If the *html* parameter contains a non-HTML string (XML or SVG, for example), then the return value will contain an empty string. If the *html* parameter contains a string that represents an HTML Frameset document, then the return value will contain an empty string. + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_getarray.md b/windows.data.json/ijsonvalue_getarray.md index 5caa21843b..0b3bcf1f45 100644 --- a/windows.data.json/ijsonvalue_getarray.md +++ b/windows.data.json/ijsonvalue_getarray.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.IJsonValue.GetArray --api-type: winrt method ---- # Windows.Data.Json.IJsonValue.GetArray ## -description Returns a pointer to the array if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. If it is not, an exception is thrown. ## -returns A pointer to the encapsulated array. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.IJsonValue.GetArray +-api-type: winrt method +--- + + + +# Windows.Data.Json.IJsonValue.GetArray + +## -description +Returns a pointer to the array if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. If it is not, an exception is thrown. + +## -returns +A pointer to the encapsulated array. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_getboolean.md b/windows.data.json/ijsonvalue_getboolean.md index 89e6c29a93..b9b638873a 100644 --- a/windows.data.json/ijsonvalue_getboolean.md +++ b/windows.data.json/ijsonvalue_getboolean.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.IJsonValue.GetBoolean --api-type: winrt method ---- # Windows.Data.Json.IJsonValue.GetBoolean ## -description Returns the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). If it is not, an exception is thrown. ## -returns The encapsulated value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.IJsonValue.GetBoolean +-api-type: winrt method +--- + + + +# Windows.Data.Json.IJsonValue.GetBoolean + +## -description +Returns the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). If it is not, an exception is thrown. + +## -returns +The encapsulated value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_getnumber.md b/windows.data.json/ijsonvalue_getnumber.md index f2717109e2..6fccf9756c 100644 --- a/windows.data.json/ijsonvalue_getnumber.md +++ b/windows.data.json/ijsonvalue_getnumber.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.IJsonValue.GetNumber --api-type: winrt method ---- # Windows.Data.Json.IJsonValue.GetNumber ## -description Returns the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. If it is not, an exception is thrown. ## -returns The encapsulated value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.IJsonValue.GetNumber +-api-type: winrt method +--- + + + +# Windows.Data.Json.IJsonValue.GetNumber + +## -description +Returns the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. If it is not, an exception is thrown. + +## -returns +The encapsulated value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_getobject.md b/windows.data.json/ijsonvalue_getobject.md index 53ff93530f..7b9877864c 100644 --- a/windows.data.json/ijsonvalue_getobject.md +++ b/windows.data.json/ijsonvalue_getobject.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.IJsonValue.GetObject --api-type: winrt method ---- # Windows.Data.Json.IJsonValue.GetObject ## -description Returns a pointer to the object if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. If it is not, an exception is thrown. ## -returns A pointer to the encapsulated object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.IJsonValue.GetObject +-api-type: winrt method +--- + + + +# Windows.Data.Json.IJsonValue.GetObject + +## -description +Returns a pointer to the object if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. If it is not, an exception is thrown. + +## -returns +A pointer to the encapsulated object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_getstring.md b/windows.data.json/ijsonvalue_getstring.md index a5e6175f0b..d4d0604f2f 100644 --- a/windows.data.json/ijsonvalue_getstring.md +++ b/windows.data.json/ijsonvalue_getstring.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.IJsonValue.GetString --api-type: winrt method ---- # Windows.Data.Json.IJsonValue.GetString ## -description Returns the [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). If it is not, an exception is thrown. ## -returns The encapsulated [String](https://msdn.microsoft.com/library/system.string.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.IJsonValue.GetString +-api-type: winrt method +--- + + + +# Windows.Data.Json.IJsonValue.GetString + +## -description +Returns the [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). If it is not, an exception is thrown. + +## -returns +The encapsulated [String](https://msdn.microsoft.com/library/system.string.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_stringify.md b/windows.data.json/ijsonvalue_stringify.md index 09cee779bd..d2a09961ed 100644 --- a/windows.data.json/ijsonvalue_stringify.md +++ b/windows.data.json/ijsonvalue_stringify.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.IJsonValue.Stringify --api-type: winrt method ---- # Windows.Data.Json.IJsonValue.Stringify ## -description Retrieves the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.IJsonValue.Stringify +-api-type: winrt method +--- + + + +# Windows.Data.Json.IJsonValue.Stringify + +## -description +Retrieves the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/ijsonvalue_valuetype.md b/windows.data.json/ijsonvalue_valuetype.md index 87182588fe..4b4cc4c665 100644 --- a/windows.data.json/ijsonvalue_valuetype.md +++ b/windows.data.json/ijsonvalue_valuetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Json.IJsonValue.ValueType --api-type: winrt property ---- # Windows.Data.Json.IJsonValue.ValueType ## -description Gets the type of the encapsulated JSON value. Possible types are defined by [JsonValueType](jsonvaluetype.md). ## -property-value The JSON value type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Json.IJsonValue.ValueType +-api-type: winrt property +--- + + + +# Windows.Data.Json.IJsonValue.ValueType + +## -description +Gets the type of the encapsulated JSON value. Possible types are defined by [JsonValueType](jsonvaluetype.md). + +## -property-value +The JSON value type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_append_249091036.md b/windows.data.json/jsonarray_append_249091036.md index b316a5b723..d36fbfe469 100644 --- a/windows.data.json/jsonarray_append_249091036.md +++ b/windows.data.json/jsonarray_append_249091036.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.Append(Windows.Data.Json.IJsonValue) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.Append ## -description Adds a new item to the array. ## -parameters ### -param value The new item to add. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.Append(Windows.Data.Json.IJsonValue) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.Append + +## -description +Adds a new item to the array. + +## -parameters +### -param value +The new item to add. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_clear_556466.md b/windows.data.json/jsonarray_clear_556466.md index b12577f6ea..bd542238ad 100644 --- a/windows.data.json/jsonarray_clear_556466.md +++ b/windows.data.json/jsonarray_clear_556466.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.Clear --api-type: winrt method ---- # Windows.Data.Json.JsonArray.Clear ## -description Removes all items from the collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.Clear +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.Clear + +## -description +Removes all items from the collection. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_first_1920739956.md b/windows.data.json/jsonarray_first_1920739956.md index 287b4ddae2..111faaf43c 100644 --- a/windows.data.json/jsonarray_first_1920739956.md +++ b/windows.data.json/jsonarray_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.First --api-type: winrt method ---- # Windows.Data.Json.JsonArray.First ## -description Returns the iterator for iteration over the items in the array. ## -returns The iterator object. The iterator's current position is at the 0-index position, or at the array end if the array is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.First +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.First + +## -description +Returns the iterator for iteration over the items in the array. + +## -returns +The iterator object. The iterator's current position is at the 0-index position, or at the array end if the array is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getarray_530765324.md b/windows.data.json/jsonarray_getarray_530765324.md index 16e5fd1c04..6d49036622 100644 --- a/windows.data.json/jsonarray_getarray_530765324.md +++ b/windows.data.json/jsonarray_getarray_530765324.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetArray --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetArray ## -description Gets the [JsonArray](jsonarray.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. ## -returns The [JsonArray](jsonarray.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetArray +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetArray + +## -description +Gets the [JsonArray](jsonarray.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. + +## -returns +The [JsonArray](jsonarray.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getarrayat_1864270881.md b/windows.data.json/jsonarray_getarrayat_1864270881.md index 86926165b6..7a375138bb 100644 --- a/windows.data.json/jsonarray_getarrayat_1864270881.md +++ b/windows.data.json/jsonarray_getarrayat_1864270881.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetArrayAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetArrayAt ## -description Gets the [JsonArray](jsonarray.md) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array** . ## -parameters ### -param index The specified index. ## -returns The [JsonArray](jsonarray.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetArrayAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetArrayAt + +## -description +Gets the [JsonArray](jsonarray.md) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array** . + +## -parameters +### -param index +The specified index. + +## -returns +The [JsonArray](jsonarray.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getat_496709656.md b/windows.data.json/jsonarray_getat_496709656.md index b83c997ad9..7c29c4f673 100644 --- a/windows.data.json/jsonarray_getat_496709656.md +++ b/windows.data.json/jsonarray_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetAt ## -description Returns the item located at the specified index. ## -parameters ### -param index The integer index for the value to retrieve. ## -returns The [JsonValue](jsonvalue.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetAt + +## -description +Returns the item located at the specified index. + +## -parameters +### -param index +The integer index for the value to retrieve. + +## -returns +The [JsonValue](jsonvalue.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getboolean_1304335680.md b/windows.data.json/jsonarray_getboolean_1304335680.md index 64fbf8b496..9b448140e1 100644 --- a/windows.data.json/jsonarray_getboolean_1304335680.md +++ b/windows.data.json/jsonarray_getboolean_1304335680.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetBoolean --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetBoolean ## -description Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). ## -returns The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetBoolean +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetBoolean + +## -description +Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). + +## -returns +The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getbooleanat_841638456.md b/windows.data.json/jsonarray_getbooleanat_841638456.md index f5c85b8a63..ef48350301 100644 --- a/windows.data.json/jsonarray_getbooleanat_841638456.md +++ b/windows.data.json/jsonarray_getbooleanat_841638456.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetBooleanAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetBooleanAt ## -description Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the value at that index is **Boolean**. ## -parameters ### -param index The specified index. ## -returns The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetBooleanAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetBooleanAt + +## -description +Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the value at that index is **Boolean**. + +## -parameters +### -param index +The specified index. + +## -returns +The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getmany_641821212.md b/windows.data.json/jsonarray_getmany_641821212.md index 6ae1787934..24c46eb335 100644 --- a/windows.data.json/jsonarray_getmany_641821212.md +++ b/windows.data.json/jsonarray_getmany_641821212.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetMany(System.UInt32,Windows.Data.Json.IJsonValue[]) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetMany ## -description Gets all array items of type [IJsonValue](ijsonvalue.md), starting from a specified index. ## -parameters ### -param startIndex The starting index. ### -param items Returns items of the [IJsonValue](ijsonvalue.md). ## -returns The index of *items* within the range of elements in an array that starts at *startIndex*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetMany(System.UInt32,Windows.Data.Json.IJsonValue[]) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetMany + +## -description +Gets all array items of type [IJsonValue](ijsonvalue.md), starting from a specified index. + +## -parameters +### -param startIndex +The starting index. + +### -param items +Returns items of the [IJsonValue](ijsonvalue.md). + +## -returns +The index of *items* within the range of elements in an array that starts at *startIndex*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getnumber_1143516409.md b/windows.data.json/jsonarray_getnumber_1143516409.md index 567f39b90b..d3c5649bdf 100644 --- a/windows.data.json/jsonarray_getnumber_1143516409.md +++ b/windows.data.json/jsonarray_getnumber_1143516409.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetNumber --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetNumber ## -description Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. ## -returns The number value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetNumber +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetNumber + +## -description +Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. + +## -returns +The number value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getnumberat_219581882.md b/windows.data.json/jsonarray_getnumberat_219581882.md index 2dd616faf3..d897f5a155 100644 --- a/windows.data.json/jsonarray_getnumberat_219581882.md +++ b/windows.data.json/jsonarray_getnumberat_219581882.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetNumberAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetNumberAt ## -description Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the value at that index is **Number**. ## -parameters ### -param index The specified index. ## -returns The number value at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetNumberAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetNumberAt + +## -description +Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the value at that index is **Number**. + +## -parameters +### -param index +The specified index. + +## -returns +The number value at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getobject_1682752975.md b/windows.data.json/jsonarray_getobject_1682752975.md index 77f61903bf..e6004091f5 100644 --- a/windows.data.json/jsonarray_getobject_1682752975.md +++ b/windows.data.json/jsonarray_getobject_1682752975.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetObject --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetObject ## -description Gets the [JsonObject](jsonobject.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. ## -returns The [JsonObject](jsonobject.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetObject +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetObject + +## -description +Gets the [JsonObject](jsonobject.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. + +## -returns +The [JsonObject](jsonobject.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getobjectat_113224994.md b/windows.data.json/jsonarray_getobjectat_113224994.md index 6b77c94374..6579dc0e15 100644 --- a/windows.data.json/jsonarray_getobjectat_113224994.md +++ b/windows.data.json/jsonarray_getobjectat_113224994.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetObjectAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetObjectAt ## -description Gets the [JsonObject](jsonobject.md) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. ## -parameters ### -param index The specified index. ## -returns The [JsonObject](jsonobject.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetObjectAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetObjectAt + +## -description +Gets the [JsonObject](jsonobject.md) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. + +## -parameters +### -param index +The specified index. + +## -returns +The [JsonObject](jsonobject.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getstring_1001279800.md b/windows.data.json/jsonarray_getstring_1001279800.md index beaf64c04c..74dc6fe781 100644 --- a/windows.data.json/jsonarray_getstring_1001279800.md +++ b/windows.data.json/jsonarray_getstring_1001279800.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetString --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetString ## -description Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). ## -returns The [String](https://msdn.microsoft.com/library/system.string.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetString +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetString + +## -description +Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). + +## -returns +The [String](https://msdn.microsoft.com/library/system.string.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getstringat_553983123.md b/windows.data.json/jsonarray_getstringat_553983123.md index 17244d3c48..c106ddf0cc 100644 --- a/windows.data.json/jsonarray_getstringat_553983123.md +++ b/windows.data.json/jsonarray_getstringat_553983123.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetStringAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetStringAt ## -description Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **String**. ## -parameters ### -param index The specified index. ## -returns The [String](https://msdn.microsoft.com/library/system.string.aspx) value at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetStringAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetStringAt + +## -description +Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) at the specified index if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **String**. + +## -parameters +### -param index +The specified index. + +## -returns +The [String](https://msdn.microsoft.com/library/system.string.aspx) value at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_getview_37498667.md b/windows.data.json/jsonarray_getview_37498667.md index 0429d0afbe..c784c90ea7 100644 --- a/windows.data.json/jsonarray_getview_37498667.md +++ b/windows.data.json/jsonarray_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.GetView --api-type: winrt method ---- # Windows.Data.Json.JsonArray.GetView ## -description Gets a [JsonArray](jsonarray.md) view. ## -returns The [JsonArray](jsonarray.md) view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.GetView +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.GetView + +## -description +Gets a [JsonArray](jsonarray.md) view. + +## -returns +The [JsonArray](jsonarray.md) view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_indexof_1181539556.md b/windows.data.json/jsonarray_indexof_1181539556.md index 6714a166f9..b76fb236ce 100644 --- a/windows.data.json/jsonarray_indexof_1181539556.md +++ b/windows.data.json/jsonarray_indexof_1181539556.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.IndexOf(Windows.Data.Json.IJsonValue,System.UInt32@) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.IndexOf ## -description Searches for a [JsonValue](jsonvalue.md) object and returns the zero-based index of its first occurrence within the [JsonArray](jsonarray.md). ## -parameters ### -param value The [IJsonValue](ijsonvalue.md) to look up. ### -param index The zero-based index of the first occurrence of item within the [JsonArray](jsonarray.md), if found; otherwise, –1. ## -returns Returns a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value indicating if an occurrence of *value* was found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.IndexOf(Windows.Data.Json.IJsonValue,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.IndexOf + +## -description +Searches for a [JsonValue](jsonvalue.md) object and returns the zero-based index of its first occurrence within the [JsonArray](jsonarray.md). + +## -parameters +### -param value +The [IJsonValue](ijsonvalue.md) to look up. + +### -param index +The zero-based index of the first occurrence of item within the [JsonArray](jsonarray.md), if found; otherwise, –1. + +## -returns +Returns a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value indicating if an occurrence of *value* was found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_insertat_1991617558.md b/windows.data.json/jsonarray_insertat_1991617558.md index f5d0e43bfe..47f168e4b5 100644 --- a/windows.data.json/jsonarray_insertat_1991617558.md +++ b/windows.data.json/jsonarray_insertat_1991617558.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.InsertAt(System.UInt32,Windows.Data.Json.IJsonValue) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.InsertAt ## -description Inserts a [JsonValue](jsonvalue.md) into an array at the specified index. ## -parameters ### -param index The zero-based index at which the item should be inserted. ### -param value The [IJsonValue](ijsonvalue.md) object to insert. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.InsertAt(System.UInt32,Windows.Data.Json.IJsonValue) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.InsertAt + +## -description +Inserts a [JsonValue](jsonvalue.md) into an array at the specified index. + +## -parameters +### -param index +The zero-based index at which the item should be inserted. + +### -param value +The [IJsonValue](ijsonvalue.md) object to insert. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_jsonarray_1221375020.md b/windows.data.json/jsonarray_jsonarray_1221375020.md index f0eb03d6fa..6ecaa5d6a4 100644 --- a/windows.data.json/jsonarray_jsonarray_1221375020.md +++ b/windows.data.json/jsonarray_jsonarray_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.#ctor --api-type: winrt method ---- # Windows.Data.Json.JsonArray.JsonArray ## -description Creates a new [JsonArray](jsonarray.md) object that represents a JSON array. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.#ctor +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.JsonArray + +## -description +Creates a new [JsonArray](jsonarray.md) object that represents a JSON array. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_parse_705027695.md b/windows.data.json/jsonarray_parse_705027695.md index 4aca74320d..d54b30f78e 100644 --- a/windows.data.json/jsonarray_parse_705027695.md +++ b/windows.data.json/jsonarray_parse_705027695.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.Parse(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.Parse ## -description Parses the specified JSON string that represents a [JsonArray](jsonarray.md). > [!NOTE] > This method will throw an exception if the provided JSON string is not valid. Use of [JsonObject.TryParse](jsonobject_tryparse.md) is a recommended alternative. A [TryParse](jsonarray_tryparse.md) call will return a boolean value to indicate success or failure and, if successful, the resultant [JsonArray](jsonarray.md). ## -parameters ### -param input The specified JSON string. ## -returns ## -remarks This method may only be called when the [ValueType](ijsonvalue_valuetype.md) is **Null**. If the value contained in the specified JSON string is a String, a Number or a Boolean, the [ValueType](ijsonvalue_valuetype.md) will be updated and the actual value can then be accessed through the [GetString](ijsonvalue_getstring.md), [GetNumber](ijsonvalue_getnumber.md) or [GetBoolean](ijsonvalue_getboolean.md) methods. If [Parse](jsonvalue_parse.md) fails due to an invalid JSON string or resource allocation errors, the [ValueType](ijsonvalue_valuetype.md) will not be changed. When implemented on the subclass [JsonObject](jsonobject_jsonobject.md), this method requires the specified input string to be a valid JSON object value. When implemented on the subclass [JsonArray](jsonarray_jsonarray.md), this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when [JsonObject](jsonobject_jsonobject.md).[Parse](jsonvalue_parse.md) or [JsonArray](jsonarray_jsonarray.md).[Parse](jsonvalue_parse.md) succeeds. If [Parse](jsonvalue_parse.md) fails, the object state remains intact. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.Parse(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.Parse + +## -description +Parses the specified JSON string that represents a [JsonArray](jsonarray.md). + +> [!NOTE] +> This method will throw an exception if the provided JSON string is not valid. Use of [JsonObject.TryParse](jsonobject_tryparse.md) is a recommended alternative. A [TryParse](jsonarray_tryparse.md) call will return a boolean value to indicate success or failure and, if successful, the resultant [JsonArray](jsonarray.md). + +## -parameters +### -param input +The specified JSON string. + +## -returns + + +## -remarks +This method may only be called when the [ValueType](ijsonvalue_valuetype.md) is **Null**. If the value contained in the specified JSON string is a String, a Number or a Boolean, the [ValueType](ijsonvalue_valuetype.md) will be updated and the actual value can then be accessed through the [GetString](ijsonvalue_getstring.md), [GetNumber](ijsonvalue_getnumber.md) or [GetBoolean](ijsonvalue_getboolean.md) methods. If [Parse](jsonvalue_parse.md) fails due to an invalid JSON string or resource allocation errors, the [ValueType](ijsonvalue_valuetype.md) will not be changed. + +When implemented on the subclass [JsonObject](jsonobject_jsonobject.md), this method requires the specified input string to be a valid JSON object value. When implemented on the subclass [JsonArray](jsonarray_jsonarray.md), this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when [JsonObject](jsonobject_jsonobject.md).[Parse](jsonvalue_parse.md) or [JsonArray](jsonarray_jsonarray.md).[Parse](jsonvalue_parse.md) succeeds. If [Parse](jsonvalue_parse.md) fails, the object state remains intact. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_removeat_1960564133.md b/windows.data.json/jsonarray_removeat_1960564133.md index a3b3b157ae..f768877ff9 100644 --- a/windows.data.json/jsonarray_removeat_1960564133.md +++ b/windows.data.json/jsonarray_removeat_1960564133.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.RemoveAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.RemoveAt ## -description Removes the element at the specified index of the collection. ## -parameters ### -param index The zero-based index of the element to remove. ## -remarks If successful, calling this method reduces the collection size by one. Items with index values greater than the called index have their index values reduced by one. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.RemoveAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.RemoveAt + +## -description +Removes the element at the specified index of the collection. + +## -parameters +### -param index +The zero-based index of the element to remove. + +## -remarks +If successful, calling this method reduces the collection size by one. Items with index values greater than the called index have their index values reduced by one. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_removeatend_1813436897.md b/windows.data.json/jsonarray_removeatend_1813436897.md index bf04a3ba28..1b533cf9f4 100644 --- a/windows.data.json/jsonarray_removeatend_1813436897.md +++ b/windows.data.json/jsonarray_removeatend_1813436897.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.RemoveAtEnd --api-type: winrt method ---- # Windows.Data.Json.JsonArray.RemoveAtEnd ## -description Removes the last item in the array. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.RemoveAtEnd +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.RemoveAtEnd + +## -description +Removes the last item in the array. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_replaceall_1398616878.md b/windows.data.json/jsonarray_replaceall_1398616878.md index 812c556f05..598d0e0fb8 100644 --- a/windows.data.json/jsonarray_replaceall_1398616878.md +++ b/windows.data.json/jsonarray_replaceall_1398616878.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.ReplaceAll(Windows.Data.Json.IJsonValue[]) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.ReplaceAll ## -description Clears the array and then inserts the provided collection of [JsonValue](jsonvalue.md) objects as new array items. ## -parameters ### -param items The new collection items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.ReplaceAll(Windows.Data.Json.IJsonValue[]) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.ReplaceAll + +## -description +Clears the array and then inserts the provided collection of [JsonValue](jsonvalue.md) objects as new array items. + +## -parameters +### -param items +The new collection items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_setat_132828262.md b/windows.data.json/jsonarray_setat_132828262.md index d995fd93ba..a7541660b7 100644 --- a/windows.data.json/jsonarray_setat_132828262.md +++ b/windows.data.json/jsonarray_setat_132828262.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.SetAt(System.UInt32,Windows.Data.Json.IJsonValue) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.SetAt ## -description Sets the value at the specified index using the provided [JsonValue](jsonvalue.md). ## -parameters ### -param index The index at which to set the value. ### -param value The value to set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.SetAt(System.UInt32,Windows.Data.Json.IJsonValue) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.SetAt + +## -description +Sets the value at the specified index using the provided [JsonValue](jsonvalue.md). + +## -parameters +### -param index +The index at which to set the value. + +### -param value +The value to set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_size.md b/windows.data.json/jsonarray_size.md index 8a1f57b158..513a25687d 100644 --- a/windows.data.json/jsonarray_size.md +++ b/windows.data.json/jsonarray_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Json.JsonArray.Size --api-type: winrt property ---- # Windows.Data.Json.JsonArray.Size ## -description Gets the size (count) of the array. ## -property-value The count of items in the array. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Json.JsonArray.Size +-api-type: winrt property +--- + + + +# Windows.Data.Json.JsonArray.Size + +## -description +Gets the size (count) of the array. + +## -property-value +The count of items in the array. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_stringify_428328011.md b/windows.data.json/jsonarray_stringify_428328011.md index 268bcf88df..252f51ca12 100644 --- a/windows.data.json/jsonarray_stringify_428328011.md +++ b/windows.data.json/jsonarray_stringify_428328011.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.Stringify --api-type: winrt method ---- # Windows.Data.Json.JsonArray.Stringify ## -description Returns the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.Stringify +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.Stringify + +## -description +Returns the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_tostring_1274845745.md b/windows.data.json/jsonarray_tostring_1274845745.md index c509c6baba..2dbe49a4cf 100644 --- a/windows.data.json/jsonarray_tostring_1274845745.md +++ b/windows.data.json/jsonarray_tostring_1274845745.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.ToString --api-type: winrt method ---- # Windows.Data.Json.JsonArray.ToString ## -description Returns the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.ToString +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.ToString + +## -description +Returns the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_tryparse_1149006451.md b/windows.data.json/jsonarray_tryparse_1149006451.md index faa79f78df..ff51c58c15 100644 --- a/windows.data.json/jsonarray_tryparse_1149006451.md +++ b/windows.data.json/jsonarray_tryparse_1149006451.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Json.JsonArray.TryParse(System.String,Windows.Data.Json.JsonArray@) --api-type: winrt method ---- # Windows.Data.Json.JsonArray.TryParse ## -description Parses the provided string into a [JsonArray](jsonarray.md). ## -parameters ### -param input The specified string. ### -param result The new [JsonArray](jsonarray.md) object. ## -returns True if the [JsonValue](jsonvalue.md) object was successfully created; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonArray.TryParse(System.String,Windows.Data.Json.JsonArray@) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonArray.TryParse + +## -description +Parses the provided string into a [JsonArray](jsonarray.md). + +## -parameters +### -param input +The specified string. + +### -param result +The new [JsonArray](jsonarray.md) object. + +## -returns +True if the [JsonValue](jsonvalue.md) object was successfully created; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonarray_valuetype.md b/windows.data.json/jsonarray_valuetype.md index aa52e6521e..179f6e7406 100644 --- a/windows.data.json/jsonarray_valuetype.md +++ b/windows.data.json/jsonarray_valuetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Json.JsonArray.ValueType --api-type: winrt property ---- # Windows.Data.Json.JsonArray.ValueType ## -description Gets the type of the values within the array. Possible types are defined by [JsonValueType](jsonvaluetype.md). ## -property-value The JSON value type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Json.JsonArray.ValueType +-api-type: winrt property +--- + + + +# Windows.Data.Json.JsonArray.ValueType + +## -description +Gets the type of the values within the array. Possible types are defined by [JsonValueType](jsonvaluetype.md). + +## -property-value +The JSON value type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonerror_getjsonstatus_917539589.md b/windows.data.json/jsonerror_getjsonstatus_917539589.md index 75d248c88d..29262e1e19 100644 --- a/windows.data.json/jsonerror_getjsonstatus_917539589.md +++ b/windows.data.json/jsonerror_getjsonstatus_917539589.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonError.GetJsonStatus(System.Int32) --api-type: winrt method ---- # Windows.Data.Json.JsonError.GetJsonStatus ## -description Gets the specific error using the returned **HRESULT** value. Possible values are defined by [JsonErrorStatus](jsonerrorstatus.md). ## -parameters ### -param hresult An **HRESULT** returned during the operation. ## -returns The error encountered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonError.GetJsonStatus(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonError.GetJsonStatus + +## -description +Gets the specific error using the returned **HRESULT** value. Possible values are defined by [JsonErrorStatus](jsonerrorstatus.md). + +## -parameters +### -param hresult +An **HRESULT** returned during the operation. + +## -returns +The error encountered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_clear_556466.md b/windows.data.json/jsonobject_clear_556466.md index a26a36021a..d529e6df8a 100644 --- a/windows.data.json/jsonobject_clear_556466.md +++ b/windows.data.json/jsonobject_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.Clear --api-type: winrt method ---- # Windows.Data.Json.JsonObject.Clear ## -description Removes all items from the collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.Clear +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.Clear + +## -description +Removes all items from the collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_first_1920739956.md b/windows.data.json/jsonobject_first_1920739956.md index 446e57e7c9..a063cc1b25 100644 --- a/windows.data.json/jsonobject_first_1920739956.md +++ b/windows.data.json/jsonobject_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.First --api-type: winrt method ---- # Windows.Data.Json.JsonObject.First ## -description Returns the iterator for iteration over the key/value pairs in the [JsonObject](jsonobject.md). ## -returns The iterator object. The iterator's current position is at the 0-index position, or at the array end if the array is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.First +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.First + +## -description +Returns the iterator for iteration over the key/value pairs in the [JsonObject](jsonobject.md). + +## -returns +The iterator object. The iterator's current position is at the 0-index position, or at the array end if the array is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_getarray_530765324.md b/windows.data.json/jsonobject_getarray_530765324.md index 289ae32c28..1baecb9a1c 100644 --- a/windows.data.json/jsonobject_getarray_530765324.md +++ b/windows.data.json/jsonobject_getarray_530765324.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetArray --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetArray ## -description Returns a [JsonArray](jsonarray.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. ## -returns The [JsonArray](jsonarray.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetArray +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetArray + +## -description +Returns a [JsonArray](jsonarray.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. + +## -returns +The [JsonArray](jsonarray.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_getboolean_1304335680.md b/windows.data.json/jsonobject_getboolean_1304335680.md index d64833720f..d3392431e5 100644 --- a/windows.data.json/jsonobject_getboolean_1304335680.md +++ b/windows.data.json/jsonobject_getboolean_1304335680.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetBoolean --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetBoolean ## -description Gets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). ## -returns The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetBoolean +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetBoolean + +## -description +Gets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). + +## -returns +The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_getnamedarray_1079835619.md b/windows.data.json/jsonobject_getnamedarray_1079835619.md index 92d71aa86d..68d4542a64 100644 --- a/windows.data.json/jsonobject_getnamedarray_1079835619.md +++ b/windows.data.json/jsonobject_getnamedarray_1079835619.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedArray(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedArray ## -description Gets the [JsonArray](jsonarray.md) value with the specified name. ## -parameters ### -param name The name. ## -returns The [JsonArray](jsonarray.md) with the specified *name*. ## -remarks This method should always used with a try/catch block because it throws an exception if the name found is not a [JsonArray](jsonarray.md) type or the name is not found. ## -examples ## -see-also [GetNamedArray(String, JsonArray)](jsonobject_getnamedarray_1738038789.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedArray(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedArray + +## -description +Gets the [JsonArray](jsonarray.md) value with the specified name. + +## -parameters +### -param name +The name. + +## -returns +The [JsonArray](jsonarray.md) with the specified *name*. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name found is not a [JsonArray](jsonarray.md) type or the name is not found. + +## -examples + +## -see-also +[GetNamedArray(String, JsonArray)](jsonobject_getnamedarray_1738038789.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedarray_1738038789.md b/windows.data.json/jsonobject_getnamedarray_1738038789.md index 9811cd94a7..2ac5c41a04 100644 --- a/windows.data.json/jsonobject_getnamedarray_1738038789.md +++ b/windows.data.json/jsonobject_getnamedarray_1738038789.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedArray(System.String,Windows.Data.Json.JsonArray) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedArray ## -description Gets the [JsonArray](jsonarray_jsonarray.md) value with the specified name, or the provided default value if no such named value is found. ## -parameters ### -param name The name. ### -param defaultValue The default value to use if the JSON property is not found. ## -returns The [JsonArray](jsonarray.md) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. ## -remarks This method should always used with a try/catch block because it throws an exception if the name is not found. ## -examples ## -see-also [GetNamedArray(String)](jsonobject_getnamedarray_1079835619.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedArray(System.String,Windows.Data.Json.JsonArray) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedArray + +## -description +Gets the [JsonArray](jsonarray_jsonarray.md) value with the specified name, or the provided default value if no such named value is found. + +## -parameters +### -param name +The name. + +### -param defaultValue +The default value to use if the JSON property is not found. + +## -returns +The [JsonArray](jsonarray.md) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name is not found. + +## -examples + +## -see-also +[GetNamedArray(String)](jsonobject_getnamedarray_1079835619.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedboolean_1247149794.md b/windows.data.json/jsonobject_getnamedboolean_1247149794.md index b221948c58..d7bde41a4a 100644 --- a/windows.data.json/jsonobject_getnamedboolean_1247149794.md +++ b/windows.data.json/jsonobject_getnamedboolean_1247149794.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedBoolean(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedBoolean ## -description Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value with the specified name. ## -parameters ### -param name The name. ## -returns The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) with the specified *name*. ## -remarks This method should always used with a try/catch block because it throws an exception if the name found is not a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) type or the name is not found. ## -examples ## -see-also [GetNamedBoolean(String, Boolean)](jsonobject_getnamedboolean_1472935654.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedBoolean(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedBoolean + +## -description +Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value with the specified name. + +## -parameters +### -param name +The name. + +## -returns +The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) with the specified *name*. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name found is not a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) type or the name is not found. + +## -examples + +## -see-also +[GetNamedBoolean(String, Boolean)](jsonobject_getnamedboolean_1472935654.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedboolean_1472935654.md b/windows.data.json/jsonobject_getnamedboolean_1472935654.md index 6bf8d465ad..a417c7e653 100644 --- a/windows.data.json/jsonobject_getnamedboolean_1472935654.md +++ b/windows.data.json/jsonobject_getnamedboolean_1472935654.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedBoolean(System.String,System.Boolean) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedBoolean ## -description Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value with the specified name, or the provided default value if no such named value is found. ## -parameters ### -param name The name. ### -param defaultValue The default value to use if the JSON property is not found. ## -returns The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. ## -remarks This method should always used with a try/catch block because it throws an exception if the name is not found. ## -examples ## -see-also [GetNamedBoolean(String)](jsonobject_getnamedboolean_1247149794.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedBoolean(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedBoolean + +## -description +Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value with the specified name, or the provided default value if no such named value is found. + +## -parameters +### -param name +The name. + +### -param defaultValue +The default value to use if the JSON property is not found. + +## -returns +The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name is not found. + +## -examples + +## -see-also +[GetNamedBoolean(String)](jsonobject_getnamedboolean_1247149794.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamednumber_124311229.md b/windows.data.json/jsonobject_getnamednumber_124311229.md index 5147ce7728..7d61b33451 100644 --- a/windows.data.json/jsonobject_getnamednumber_124311229.md +++ b/windows.data.json/jsonobject_getnamednumber_124311229.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedNumber(System.String,System.Double) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedNumber ## -description Gets the number value (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) with the specified name, or the provided default value if no such named value is found. ## -parameters ### -param name The name. ### -param defaultValue The default value to use if the JSON property is not found. ## -returns The [Double](https://msdn.microsoft.com/library/system.double.aspx) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. ## -remarks This method should always used with a try/catch block because it throws an exception if the name is not found. ## -examples ## -see-also [GetNamedNumber(String)](jsonobject_getnamednumber_448999001.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedNumber(System.String,System.Double) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedNumber + +## -description +Gets the number value (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) with the specified name, or the provided default value if no such named value is found. + +## -parameters +### -param name +The name. + +### -param defaultValue +The default value to use if the JSON property is not found. + +## -returns +The [Double](https://msdn.microsoft.com/library/system.double.aspx) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name is not found. + +## -examples + +## -see-also +[GetNamedNumber(String)](jsonobject_getnamednumber_448999001.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamednumber_448999001.md b/windows.data.json/jsonobject_getnamednumber_448999001.md index 738b938082..1593f770a1 100644 --- a/windows.data.json/jsonobject_getnamednumber_448999001.md +++ b/windows.data.json/jsonobject_getnamednumber_448999001.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedNumber(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedNumber ## -description Gets the number value (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) with the specified name. ## -parameters ### -param name The name. ## -returns The [Double](https://msdn.microsoft.com/library/system.double.aspx) with the specified *name*. ## -remarks This method should always used with a try/catch block because it throws an exception if the name found is not a [Double](https://msdn.microsoft.com/library/system.double.aspx) type or the name is not found. ## -examples ## -see-also [GetNamedNumber(String, Double)](jsonobject_getnamednumber_124311229.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedNumber(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedNumber + +## -description +Gets the number value (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) with the specified name. + +## -parameters +### -param name +The name. + +## -returns +The [Double](https://msdn.microsoft.com/library/system.double.aspx) with the specified *name*. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name found is not a [Double](https://msdn.microsoft.com/library/system.double.aspx) type or the name is not found. + +## -examples + +## -see-also +[GetNamedNumber(String, Double)](jsonobject_getnamednumber_124311229.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedobject_1279840399.md b/windows.data.json/jsonobject_getnamedobject_1279840399.md index 8f42b2f5a5..f71a6013b6 100644 --- a/windows.data.json/jsonobject_getnamedobject_1279840399.md +++ b/windows.data.json/jsonobject_getnamedobject_1279840399.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedObject(System.String,Windows.Data.Json.JsonObject) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedObject ## -description Gets the [JsonObject](jsonobject.md) value with the specified name, or the provided default value if no such named value is found. ## -parameters ### -param name The name. ### -param defaultValue The default value to use if the JSON property is not found. ## -returns The [JsonObject](jsonobject.md) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. ## -remarks This method should always used with a try/catch block because it throws an exception if the name is not found. ## -examples ## -see-also [GetNamedObject(String)](jsonobject_getnamedobject_1569283711.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedObject(System.String,Windows.Data.Json.JsonObject) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedObject + +## -description +Gets the [JsonObject](jsonobject.md) value with the specified name, or the provided default value if no such named value is found. + +## -parameters +### -param name +The name. + +### -param defaultValue +The default value to use if the JSON property is not found. + +## -returns +The [JsonObject](jsonobject.md) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name is not found. + +## -examples + +## -see-also +[GetNamedObject(String)](jsonobject_getnamedobject_1569283711.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedobject_1569283711.md b/windows.data.json/jsonobject_getnamedobject_1569283711.md index 6243d5699d..c4c7b168d2 100644 --- a/windows.data.json/jsonobject_getnamedobject_1569283711.md +++ b/windows.data.json/jsonobject_getnamedobject_1569283711.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedObject(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedObject ## -description Gets the [JsonObject](jsonobject.md) value with the specified name. ## -parameters ### -param name The name. ## -returns The [JsonObject](jsonobject.md) value with the specified name. ## -remarks This method should always used with a try/catch block because it throws an exception if the name found is not a [JsonObject](jsonobject.md) type or the name is not found. ## -examples ## -see-also [GetNamedObject(String, JsonObject)](jsonobject_getnamedobject_1279840399.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedObject(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedObject + +## -description +Gets the [JsonObject](jsonobject.md) value with the specified name. + +## -parameters +### -param name +The name. + +## -returns +The [JsonObject](jsonobject.md) value with the specified name. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name found is not a [JsonObject](jsonobject.md) type or the name is not found. + +## -examples + +## -see-also +[GetNamedObject(String, JsonObject)](jsonobject_getnamedobject_1279840399.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedstring_1418463848.md b/windows.data.json/jsonobject_getnamedstring_1418463848.md index 7aafbb3ef1..8b4b256119 100644 --- a/windows.data.json/jsonobject_getnamedstring_1418463848.md +++ b/windows.data.json/jsonobject_getnamedstring_1418463848.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedString(System.String,System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedString ## -description Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) value with the specified name, or the provided default value if no such named value is found. ## -parameters ### -param name The name. ### -param defaultValue The default value to use if the JSON property is not found. ## -returns The [String](https://msdn.microsoft.com/library/system.string.aspx) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. ## -remarks This method should always used with a try/catch block because it throws an exception if the name is not found. ## -examples ## -see-also [GetNamedString(String)](jsonobject_getnamedstring_409995224.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedString(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedString + +## -description +Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) value with the specified name, or the provided default value if no such named value is found. + +## -parameters +### -param name +The name. + +### -param defaultValue +The default value to use if the JSON property is not found. + +## -returns +The [String](https://msdn.microsoft.com/library/system.string.aspx) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name is not found. + +## -examples + +## -see-also +[GetNamedString(String)](jsonobject_getnamedstring_409995224.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedstring_409995224.md b/windows.data.json/jsonobject_getnamedstring_409995224.md index 5bcd4969de..34effbebf7 100644 --- a/windows.data.json/jsonobject_getnamedstring_409995224.md +++ b/windows.data.json/jsonobject_getnamedstring_409995224.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedString(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedString ## -description Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) value with the specified name. ## -parameters ### -param name The name. ## -returns The [String](https://msdn.microsoft.com/library/system.string.aspx) value with the specified name. ## -remarks This method should always used with a try/catch block because it throws an exception if the name found is not a [String](https://msdn.microsoft.com/library/system.string.aspx) type or the name is not found. ## -examples ## -see-also [GetNamedString(String, String)](jsonobject_getnamedstring_1418463848.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedString(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedString + +## -description +Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) value with the specified name. + +## -parameters +### -param name +The name. + +## -returns +The [String](https://msdn.microsoft.com/library/system.string.aspx) value with the specified name. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name found is not a [String](https://msdn.microsoft.com/library/system.string.aspx) type or the name is not found. + +## -examples + +## -see-also +[GetNamedString(String, String)](jsonobject_getnamedstring_1418463848.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedvalue_1852490180.md b/windows.data.json/jsonobject_getnamedvalue_1852490180.md index 1850298bb4..ea3456708f 100644 --- a/windows.data.json/jsonobject_getnamedvalue_1852490180.md +++ b/windows.data.json/jsonobject_getnamedvalue_1852490180.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedValue(System.String,Windows.Data.Json.JsonValue) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedValue ## -description Gets the specified [JsonValue](jsonvalue.md) value, or the provided default value if no such named value is found. ## -parameters ### -param name The name. ### -param defaultValue The default value to use if the JSON property is not found. ## -returns The [JsonValue](jsonvalue.md) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. ## -remarks This method should always used with a try/catch block because it throws an exception if the name is not found. ## -examples ## -see-also [GetNamedValue(String)](jsonobject_getnamedvalue_789604106.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedValue(System.String,Windows.Data.Json.JsonValue) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedValue + +## -description +Gets the specified [JsonValue](jsonvalue.md) value, or the provided default value if no such named value is found. + +## -parameters +### -param name +The name. + +### -param defaultValue +The default value to use if the JSON property is not found. + +## -returns +The [JsonValue](jsonvalue.md) with the specified *name*, or if this value wasn't found, the *defaultValue* is returned. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name is not found. + +## -examples + +## -see-also +[GetNamedValue(String)](jsonobject_getnamedvalue_789604106.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnamedvalue_789604106.md b/windows.data.json/jsonobject_getnamedvalue_789604106.md index 1ff2fc84dd..0a3ec7e992 100644 --- a/windows.data.json/jsonobject_getnamedvalue_789604106.md +++ b/windows.data.json/jsonobject_getnamedvalue_789604106.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNamedValue(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNamedValue ## -description Gets the [JsonValue](jsonvalue.md) value with the specified name. ## -parameters ### -param name The name. ## -returns The [JsonValue](jsonvalue.md) value with the specified name. ## -remarks This method should always used with a try/catch block because it throws an exception if the name found is not a [JsonValue](jsonvalue.md) type or the name is not found. ## -examples ## -see-also [GetNamedValue(String, JsonValue)](jsonobject_getnamedvalue_1852490180.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNamedValue(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNamedValue + +## -description +Gets the [JsonValue](jsonvalue.md) value with the specified name. + +## -parameters +### -param name +The name. + +## -returns +The [JsonValue](jsonvalue.md) value with the specified name. + +## -remarks +This method should always used with a try/catch block because it throws an exception if the name found is not a [JsonValue](jsonvalue.md) type or the name is not found. + +## -examples + +## -see-also +[GetNamedValue(String, JsonValue)](jsonobject_getnamedvalue_1852490180.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_getnumber_1143516409.md b/windows.data.json/jsonobject_getnumber_1143516409.md index 967eb4cb3e..44ddf8838a 100644 --- a/windows.data.json/jsonobject_getnumber_1143516409.md +++ b/windows.data.json/jsonobject_getnumber_1143516409.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetNumber --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetNumber ## -description Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. ## -returns The number value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetNumber +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetNumber + +## -description +Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. + +## -returns +The number value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_getobject_1682752975.md b/windows.data.json/jsonobject_getobject_1682752975.md index 27b9bad763..fb6f9b6524 100644 --- a/windows.data.json/jsonobject_getobject_1682752975.md +++ b/windows.data.json/jsonobject_getobject_1682752975.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetObject --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetObject ## -description Gets the [JsonObject](jsonobject.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. ## -returns The encapsulated [JsonObject](jsonobject.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetObject +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetObject + +## -description +Gets the [JsonObject](jsonobject.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. + +## -returns +The encapsulated [JsonObject](jsonobject.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_getstring_1001279800.md b/windows.data.json/jsonobject_getstring_1001279800.md index c6998726da..95e882fbe5 100644 --- a/windows.data.json/jsonobject_getstring_1001279800.md +++ b/windows.data.json/jsonobject_getstring_1001279800.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetString --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetString ## -description Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). ## -returns The [String](https://msdn.microsoft.com/library/system.string.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetString +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetString + +## -description +Gets the [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). + +## -returns +The [String](https://msdn.microsoft.com/library/system.string.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_getview_37498667.md b/windows.data.json/jsonobject_getview_37498667.md index 8562f81b66..1c3a80b2a0 100644 --- a/windows.data.json/jsonobject_getview_37498667.md +++ b/windows.data.json/jsonobject_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.GetView --api-type: winrt method ---- # Windows.Data.Json.JsonObject.GetView ## -description Gets a [JsonObject](jsonobject.md) view. ## -returns The [JsonObject](jsonobject.md) view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.GetView +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.GetView + +## -description +Gets a [JsonObject](jsonobject.md) view. + +## -returns +The [JsonObject](jsonobject.md) view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_haskey_425964900.md b/windows.data.json/jsonobject_haskey_425964900.md index a8ca72e424..8c73ed5d61 100644 --- a/windows.data.json/jsonobject_haskey_425964900.md +++ b/windows.data.json/jsonobject_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.HasKey(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.HasKey ## -description Indicates whether the [JsonObject](jsonobject.md) has an entry with the requested key. ## -parameters ### -param key The requested key. ## -returns true if the [JsonObject](jsonobject.md) has an entry with the requested key; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.HasKey + +## -description +Indicates whether the [JsonObject](jsonobject.md) has an entry with the requested key. + +## -parameters +### -param key +The requested key. + +## -returns +true if the [JsonObject](jsonobject.md) has an entry with the requested key; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_insert_554710680.md b/windows.data.json/jsonobject_insert_554710680.md index 2ed5d91957..fe1aed8081 100644 --- a/windows.data.json/jsonobject_insert_554710680.md +++ b/windows.data.json/jsonobject_insert_554710680.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.Insert(System.String,Windows.Data.Json.IJsonValue) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.Insert ## -description Adds a new entry to the [JsonObject](jsonobject.md). ## -parameters ### -param key The key to insert. ### -param value The [IJsonValue](ijsonvalue.md) to insert. ## -returns true if calling the method replaced a value that already existed for the key; false if calling the method defined a new key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.Insert(System.String,Windows.Data.Json.IJsonValue) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.Insert + +## -description +Adds a new entry to the [JsonObject](jsonobject.md). + +## -parameters +### -param key +The key to insert. + +### -param value +The [IJsonValue](ijsonvalue.md) to insert. + +## -returns +true if calling the method replaced a value that already existed for the key; false if calling the method defined a new key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_jsonobject_1221375020.md b/windows.data.json/jsonobject_jsonobject_1221375020.md index 47fb3bcd62..5d941dd19c 100644 --- a/windows.data.json/jsonobject_jsonobject_1221375020.md +++ b/windows.data.json/jsonobject_jsonobject_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.#ctor --api-type: winrt method ---- # Windows.Data.Json.JsonObject.JsonObject ## -description Initializes a new instance of a [JsonObject](jsonobject.md) that represents a JSON object containing a collection of name and [JsonValue](jsonvalue.md) pairs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.#ctor +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.JsonObject + +## -description +Initializes a new instance of a [JsonObject](jsonobject.md) that represents a JSON object containing a collection of name and [JsonValue](jsonvalue.md) pairs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_lookup_711408188.md b/windows.data.json/jsonobject_lookup_711408188.md index bd22a500d1..1e765fb20a 100644 --- a/windows.data.json/jsonobject_lookup_711408188.md +++ b/windows.data.json/jsonobject_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.Lookup(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.Lookup ## -description Gets the JSON value associated with the supplied key, if an entry with that key exists. ## -parameters ### -param key The requested key. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.Lookup + +## -description +Gets the JSON value associated with the supplied key, if an entry with that key exists. + +## -parameters +### -param key +The requested key. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_parse_705027695.md b/windows.data.json/jsonobject_parse_705027695.md index 04960a9f75..2b02ab25ab 100644 --- a/windows.data.json/jsonobject_parse_705027695.md +++ b/windows.data.json/jsonobject_parse_705027695.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.Parse(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.Parse ## -description Parses the specified JSON string that represents a [JsonObject](jsonobject.md) into a JSON value. > [!NOTE] > This will throw an exception if the provided JSON string is not valid. Use of [JsonObject.TryParse](jsonobject_tryparse.md) is a recommended alternative. A [TryParse](jsonobject_tryparse.md) call will return a boolean value to indicate success or failure and, if successful, the resultant [JsonObject](jsonobject.md). ## -parameters ### -param input The specified JSON string. ## -returns ## -remarks This method may only be called when the [ValueType](ijsonvalue_valuetype.md) is **Null**. If the value contained in the specified JSON string is a String, a Number or a Boolean, the [ValueType](ijsonvalue_valuetype.md) will be updated and the actual value can then be accessed through the [GetString](ijsonvalue_getstring.md), [GetNumber](ijsonvalue_getnumber.md) or [GetBoolean](ijsonvalue_getboolean.md) methods. If [Parse](jsonvalue_parse.md) fails due to an invalid JSON string or resource allocation errors, the [ValueType](ijsonvalue_valuetype.md) will not be changed. When implemented on the subclass [JsonObject](jsonobject_jsonobject.md), this method requires the specified input string to be a valid JSON object value. When implemented on the subclass [JsonArray](jsonarray_jsonarray.md), this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when [JsonObject](jsonobject_jsonobject.md).[Parse](jsonvalue_parse.md) or [JsonArray](jsonarray_jsonarray.md).[Parse](jsonvalue_parse.md) succeeds. If [Parse](jsonvalue_parse.md) fails, the object state remains intact. ## -examples ## -see-also [TryParse](jsonobject_tryparse.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.Parse(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.Parse + +## -description +Parses the specified JSON string that represents a [JsonObject](jsonobject.md) into a JSON value. + +> [!NOTE] +> This will throw an exception if the provided JSON string is not valid. Use of [JsonObject.TryParse](jsonobject_tryparse.md) is a recommended alternative. A [TryParse](jsonobject_tryparse.md) call will return a boolean value to indicate success or failure and, if successful, the resultant [JsonObject](jsonobject.md). + +## -parameters +### -param input +The specified JSON string. + +## -returns + + +## -remarks +This method may only be called when the [ValueType](ijsonvalue_valuetype.md) is **Null**. If the value contained in the specified JSON string is a String, a Number or a Boolean, the [ValueType](ijsonvalue_valuetype.md) will be updated and the actual value can then be accessed through the [GetString](ijsonvalue_getstring.md), [GetNumber](ijsonvalue_getnumber.md) or [GetBoolean](ijsonvalue_getboolean.md) methods. If [Parse](jsonvalue_parse.md) fails due to an invalid JSON string or resource allocation errors, the [ValueType](ijsonvalue_valuetype.md) will not be changed. + +When implemented on the subclass [JsonObject](jsonobject_jsonobject.md), this method requires the specified input string to be a valid JSON object value. When implemented on the subclass [JsonArray](jsonarray_jsonarray.md), this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when [JsonObject](jsonobject_jsonobject.md).[Parse](jsonvalue_parse.md) or [JsonArray](jsonarray_jsonarray.md).[Parse](jsonvalue_parse.md) succeeds. If [Parse](jsonvalue_parse.md) fails, the object state remains intact. + +## -examples + +## -see-also +[TryParse](jsonobject_tryparse.md) \ No newline at end of file diff --git a/windows.data.json/jsonobject_remove_1498489487.md b/windows.data.json/jsonobject_remove_1498489487.md index ea0f67fd38..dfad709c55 100644 --- a/windows.data.json/jsonobject_remove_1498489487.md +++ b/windows.data.json/jsonobject_remove_1498489487.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.Remove(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.Remove ## -description Removes a specific item from the [JsonObject](jsonobject.md). ## -parameters ### -param key The key of the item to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.Remove + +## -description +Removes a specific item from the [JsonObject](jsonobject.md). + +## -parameters +### -param key +The key of the item to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_setnamedvalue_896207804.md b/windows.data.json/jsonobject_setnamedvalue_896207804.md index 1f45c5cf1a..c926e258f8 100644 --- a/windows.data.json/jsonobject_setnamedvalue_896207804.md +++ b/windows.data.json/jsonobject_setnamedvalue_896207804.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.SetNamedValue(System.String,Windows.Data.Json.IJsonValue) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.SetNamedValue ## -description Sets the value of the first [JsonValue](jsonvalue.md) object with the specified name to the specified value. If no such object is found, a new name and [JsonValue](jsonvalue.md) pair is inserted into the JSON object. ## -parameters ### -param name The specified name. ### -param value The specified value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.SetNamedValue(System.String,Windows.Data.Json.IJsonValue) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.SetNamedValue + +## -description +Sets the value of the first [JsonValue](jsonvalue.md) object with the specified name to the specified value. If no such object is found, a new name and [JsonValue](jsonvalue.md) pair is inserted into the JSON object. + +## -parameters +### -param name +The specified name. + +### -param value +The specified value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_size.md b/windows.data.json/jsonobject_size.md index 8056d8c570..cb8f07cd83 100644 --- a/windows.data.json/jsonobject_size.md +++ b/windows.data.json/jsonobject_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Json.JsonObject.Size --api-type: winrt property ---- # Windows.Data.Json.JsonObject.Size ## -description Gets the size (count) of the collection. ## -property-value The count of items in the collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Json.JsonObject.Size +-api-type: winrt property +--- + + + +# Windows.Data.Json.JsonObject.Size + +## -description +Gets the size (count) of the collection. + +## -property-value +The count of items in the collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_stringify_428328011.md b/windows.data.json/jsonobject_stringify_428328011.md index 3041b49434..c52a7022b6 100644 --- a/windows.data.json/jsonobject_stringify_428328011.md +++ b/windows.data.json/jsonobject_stringify_428328011.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.Stringify --api-type: winrt method ---- # Windows.Data.Json.JsonObject.Stringify ## -description Retrieves the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.Stringify +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.Stringify + +## -description +Retrieves the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_tostring_1274845745.md b/windows.data.json/jsonobject_tostring_1274845745.md index 6f4b81c0f1..e2ad270704 100644 --- a/windows.data.json/jsonobject_tostring_1274845745.md +++ b/windows.data.json/jsonobject_tostring_1274845745.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.ToString --api-type: winrt method ---- # Windows.Data.Json.JsonObject.ToString ## -description Retrieves the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.ToString +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.ToString + +## -description +Retrieves the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_tryparse_1919547471.md b/windows.data.json/jsonobject_tryparse_1919547471.md index 93c4ec2d26..8dc32a2043 100644 --- a/windows.data.json/jsonobject_tryparse_1919547471.md +++ b/windows.data.json/jsonobject_tryparse_1919547471.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Json.JsonObject.TryParse(System.String,Windows.Data.Json.JsonObject@) --api-type: winrt method ---- # Windows.Data.Json.JsonObject.TryParse ## -description Parses the specified string that represents a JSON object into a [JsonObject](jsonobject.md). ## -parameters ### -param input The specified JSON string. ### -param result The resultant [JsonObject](jsonobject.md). ## -returns True if the [JsonValue](jsonvalue.md) object was successfully created; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonObject.TryParse(System.String,Windows.Data.Json.JsonObject@) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonObject.TryParse + +## -description +Parses the specified string that represents a JSON object into a [JsonObject](jsonobject.md). + +## -parameters +### -param input +The specified JSON string. + +### -param result +The resultant [JsonObject](jsonobject.md). + +## -returns +True if the [JsonValue](jsonvalue.md) object was successfully created; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonobject_valuetype.md b/windows.data.json/jsonobject_valuetype.md index 592fda003b..6f80a65c82 100644 --- a/windows.data.json/jsonobject_valuetype.md +++ b/windows.data.json/jsonobject_valuetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Json.JsonObject.ValueType --api-type: winrt property ---- # Windows.Data.Json.JsonObject.ValueType ## -description Gets the type of the encapsulated JSON value. Possible types are defined by [JsonValueType](jsonvaluetype.md). ## -property-value The JSON value type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Json.JsonObject.ValueType +-api-type: winrt property +--- + + + +# Windows.Data.Json.JsonObject.ValueType + +## -description +Gets the type of the encapsulated JSON value. Possible types are defined by [JsonValueType](jsonvaluetype.md). + +## -property-value +The JSON value type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_createbooleanvalue_1660561746.md b/windows.data.json/jsonvalue_createbooleanvalue_1660561746.md index 4cf5be1691..2e6625d2ab 100644 --- a/windows.data.json/jsonvalue_createbooleanvalue_1660561746.md +++ b/windows.data.json/jsonvalue_createbooleanvalue_1660561746.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.CreateBooleanValue(System.Boolean) --api-type: winrt method ---- # Windows.Data.Json.JsonValue.CreateBooleanValue ## -description Creates a [JsonValue](jsonvalue.md) from a Boolean. ## -parameters ### -param input The value to store in the [JsonValue](jsonvalue.md). ## -returns The [JsonValue](jsonvalue.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.CreateBooleanValue(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.CreateBooleanValue + +## -description +Creates a [JsonValue](jsonvalue.md) from a Boolean. + +## -parameters +### -param input +The value to store in the [JsonValue](jsonvalue.md). + +## -returns +The [JsonValue](jsonvalue.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_createnullvalue_895858836.md b/windows.data.json/jsonvalue_createnullvalue_895858836.md index c556e2dfd1..0d112c0303 100644 --- a/windows.data.json/jsonvalue_createnullvalue_895858836.md +++ b/windows.data.json/jsonvalue_createnullvalue_895858836.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.CreateNullValue --api-type: winrt method ---- # Windows.Data.Json.JsonValue.CreateNullValue ## -description Creates a [JsonValue](jsonvalue.md) with a **NULL** value. ## -returns The [JsonValue](jsonvalue.md) with a **NULL** value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.CreateNullValue +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.CreateNullValue + +## -description +Creates a [JsonValue](jsonvalue.md) with a **NULL** value. + +## -returns +The [JsonValue](jsonvalue.md) with a **NULL** value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_createnumbervalue_269010811.md b/windows.data.json/jsonvalue_createnumbervalue_269010811.md index d16cdadabc..f0a6a3eca9 100644 --- a/windows.data.json/jsonvalue_createnumbervalue_269010811.md +++ b/windows.data.json/jsonvalue_createnumbervalue_269010811.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.CreateNumberValue(System.Double) --api-type: winrt method ---- # Windows.Data.Json.JsonValue.CreateNumberValue ## -description Creates a [JsonValue](jsonvalue.md) from a Number (**Double**). ## -parameters ### -param input The Number to store in the [JsonValue](jsonvalue.md). ## -returns The [JsonValue](jsonvalue.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.CreateNumberValue(System.Double) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.CreateNumberValue + +## -description +Creates a [JsonValue](jsonvalue.md) from a Number (**Double**). + +## -parameters +### -param input +The Number to store in the [JsonValue](jsonvalue.md). + +## -returns +The [JsonValue](jsonvalue.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_createstringvalue_753032080.md b/windows.data.json/jsonvalue_createstringvalue_753032080.md index d955ec7e14..fde215099f 100644 --- a/windows.data.json/jsonvalue_createstringvalue_753032080.md +++ b/windows.data.json/jsonvalue_createstringvalue_753032080.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.CreateStringValue(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonValue.CreateStringValue ## -description Creates the string for a [JsonValue](jsonvalue.md). ## -parameters ### -param input The string for the [JsonValue](jsonvalue.md). ## -returns The [JsonValue](jsonvalue.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.CreateStringValue(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.CreateStringValue + +## -description +Creates the string for a [JsonValue](jsonvalue.md). + +## -parameters +### -param input +The string for the [JsonValue](jsonvalue.md). + +## -returns +The [JsonValue](jsonvalue.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_getarray_530765324.md b/windows.data.json/jsonvalue_getarray_530765324.md index 57540c550b..a74424a379 100644 --- a/windows.data.json/jsonvalue_getarray_530765324.md +++ b/windows.data.json/jsonvalue_getarray_530765324.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.GetArray --api-type: winrt method ---- # Windows.Data.Json.JsonValue.GetArray ## -description Gets an array if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. ## -returns The [JsonArray](jsonarray.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.GetArray +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.GetArray + +## -description +Gets an array if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Array**. + +## -returns +The [JsonArray](jsonarray.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_getboolean_1304335680.md b/windows.data.json/jsonvalue_getboolean_1304335680.md index f613e30a74..09db2962c0 100644 --- a/windows.data.json/jsonvalue_getboolean_1304335680.md +++ b/windows.data.json/jsonvalue_getboolean_1304335680.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.GetBoolean --api-type: winrt method ---- # Windows.Data.Json.JsonValue.GetBoolean ## -description Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). ## -returns The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.GetBoolean +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.GetBoolean + +## -description +Gets the [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx). + +## -returns +The [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_getnumber_1143516409.md b/windows.data.json/jsonvalue_getnumber_1143516409.md index 2867ed00b1..68ae091261 100644 --- a/windows.data.json/jsonvalue_getnumber_1143516409.md +++ b/windows.data.json/jsonvalue_getnumber_1143516409.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.GetNumber --api-type: winrt method ---- # Windows.Data.Json.JsonValue.GetNumber ## -description Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. ## -returns The number value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.GetNumber +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.GetNumber + +## -description +Gets the number (a [Double](https://msdn.microsoft.com/library/system.double.aspx)) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Number**. + +## -returns +The number value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_getobject_1682752975.md b/windows.data.json/jsonvalue_getobject_1682752975.md index 309a5da329..264284d0e7 100644 --- a/windows.data.json/jsonvalue_getobject_1682752975.md +++ b/windows.data.json/jsonvalue_getobject_1682752975.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.GetObject --api-type: winrt method ---- # Windows.Data.Json.JsonValue.GetObject ## -description Gets a [JsonObject](jsonobject.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. ## -returns The [JsonObject](jsonobject.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.GetObject +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.GetObject + +## -description +Gets a [JsonObject](jsonobject.md) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is **Object**. + +## -returns +The [JsonObject](jsonobject.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_getstring_1001279800.md b/windows.data.json/jsonvalue_getstring_1001279800.md index c29e5e9905..dc07c421f4 100644 --- a/windows.data.json/jsonvalue_getstring_1001279800.md +++ b/windows.data.json/jsonvalue_getstring_1001279800.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.GetString --api-type: winrt method ---- # Windows.Data.Json.JsonValue.GetString ## -description Gets a [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). ## -returns The [String](https://msdn.microsoft.com/library/system.string.aspx) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.GetString +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.GetString + +## -description +Gets a [String](https://msdn.microsoft.com/library/system.string.aspx) if the [ValueType](ijsonvalue_valuetype.md) of the encapsulated value is [String](https://msdn.microsoft.com/library/system.string.aspx). + +## -returns +The [String](https://msdn.microsoft.com/library/system.string.aspx) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_parse_705027695.md b/windows.data.json/jsonvalue_parse_705027695.md index 56f840d7eb..e550c7c220 100644 --- a/windows.data.json/jsonvalue_parse_705027695.md +++ b/windows.data.json/jsonvalue_parse_705027695.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.Parse(System.String) --api-type: winrt method ---- # Windows.Data.Json.JsonValue.Parse ## -description Parses the specified JSON string into a [JsonValue](jsonvalue.md). > [!NOTE] > This method will throw an exception if the provided JSON string is not valid. Use of [JsonObject.TryParse](jsonobject_tryparse.md) is a recommended alternative. A [TryParse](jsonvalue_tryparse.md) call will return a boolean value to indicate success or failure and, if successful, the resultant [JsonValue](jsonvalue.md). ## -parameters ### -param input The specified JSON string. ## -returns ## -remarks This method may only be called when the [ValueType](ijsonvalue_valuetype.md) is **Null**. If the value contained in the specified JSON string is a String, a Number or a Boolean, the [ValueType](ijsonvalue_valuetype.md) will be updated and the actual value can then be accessed through the [GetString](ijsonvalue_getstring.md), [GetNumber](ijsonvalue_getnumber.md) or [GetBoolean](ijsonvalue_getboolean.md) methods. If [Parse](jsonvalue_parse.md) fails due to an invalid JSON string or resource allocation errors, the [ValueType](ijsonvalue_valuetype.md) will not be changed. When implemented on the subclass [JsonObject](jsonobject_jsonobject.md), this method requires the specified input string to be a valid JSON object value. When implemented on the subclass [JsonArray](jsonarray_jsonarray.md), this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when [JsonObject](jsonobject_jsonobject.md).[Parse](jsonvalue_parse.md) or [JsonArray](jsonarray_jsonarray.md).[Parse](jsonvalue_parse.md) succeeds. If [Parse](jsonvalue_parse.md) fails, the object state remains intact. ## -examples ## -see-also [TryParse](jsonvalue_tryparse.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.Parse(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.Parse + +## -description +Parses the specified JSON string into a [JsonValue](jsonvalue.md). + +> [!NOTE] +> This method will throw an exception if the provided JSON string is not valid. Use of [JsonObject.TryParse](jsonobject_tryparse.md) is a recommended alternative. A [TryParse](jsonvalue_tryparse.md) call will return a boolean value to indicate success or failure and, if successful, the resultant [JsonValue](jsonvalue.md). + +## -parameters +### -param input +The specified JSON string. + +## -returns + + +## -remarks +This method may only be called when the [ValueType](ijsonvalue_valuetype.md) is **Null**. If the value contained in the specified JSON string is a String, a Number or a Boolean, the [ValueType](ijsonvalue_valuetype.md) will be updated and the actual value can then be accessed through the [GetString](ijsonvalue_getstring.md), [GetNumber](ijsonvalue_getnumber.md) or [GetBoolean](ijsonvalue_getboolean.md) methods. If [Parse](jsonvalue_parse.md) fails due to an invalid JSON string or resource allocation errors, the [ValueType](ijsonvalue_valuetype.md) will not be changed. + +When implemented on the subclass [JsonObject](jsonobject_jsonobject.md), this method requires the specified input string to be a valid JSON object value. When implemented on the subclass [JsonArray](jsonarray_jsonarray.md), this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when [JsonObject](jsonobject_jsonobject.md).[Parse](jsonvalue_parse.md) or [JsonArray](jsonarray_jsonarray.md).[Parse](jsonvalue_parse.md) succeeds. If [Parse](jsonvalue_parse.md) fails, the object state remains intact. + +## -examples + +## -see-also +[TryParse](jsonvalue_tryparse.md) \ No newline at end of file diff --git a/windows.data.json/jsonvalue_stringify_428328011.md b/windows.data.json/jsonvalue_stringify_428328011.md index 99ddb59cee..eb57f5ae26 100644 --- a/windows.data.json/jsonvalue_stringify_428328011.md +++ b/windows.data.json/jsonvalue_stringify_428328011.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.Stringify --api-type: winrt method ---- # Windows.Data.Json.JsonValue.Stringify ## -description Retrieves the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.Stringify +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.Stringify + +## -description +Retrieves the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_tostring_1274845745.md b/windows.data.json/jsonvalue_tostring_1274845745.md index 6e512c86ce..f838f41a2b 100644 --- a/windows.data.json/jsonvalue_tostring_1274845745.md +++ b/windows.data.json/jsonvalue_tostring_1274845745.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.ToString --api-type: winrt method ---- # Windows.Data.Json.JsonValue.ToString ## -description Retrieves the JSON representation of the encapsulated value. ## -returns A JSON representation of the encapsulated value. ## -remarks If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.ToString +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.ToString + +## -description +Retrieves the JSON representation of the encapsulated value. + +## -returns +A JSON representation of the encapsulated value. + +## -remarks +If the [ValueType](ijsonvalue_valuetype.md) is **String**, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format. + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_tryparse_1449496227.md b/windows.data.json/jsonvalue_tryparse_1449496227.md index 3d75c6fcf3..62fe492dd2 100644 --- a/windows.data.json/jsonvalue_tryparse_1449496227.md +++ b/windows.data.json/jsonvalue_tryparse_1449496227.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Json.JsonValue.TryParse(System.String,Windows.Data.Json.JsonValue@) --api-type: winrt method ---- # Windows.Data.Json.JsonValue.TryParse ## -description Parses the specified string into a [JsonValue](jsonvalue.md). ## -parameters ### -param input The specified string. ### -param result The new [JsonValue](jsonvalue.md) object. ## -returns True if the [JsonValue](jsonvalue.md) object was successfully created; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Json.JsonValue.TryParse(System.String,Windows.Data.Json.JsonValue@) +-api-type: winrt method +--- + + + +# Windows.Data.Json.JsonValue.TryParse + +## -description +Parses the specified string into a [JsonValue](jsonvalue.md). + +## -parameters +### -param input +The specified string. + +### -param result +The new [JsonValue](jsonvalue.md) object. + +## -returns +True if the [JsonValue](jsonvalue.md) object was successfully created; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.json/jsonvalue_valuetype.md b/windows.data.json/jsonvalue_valuetype.md index d655807670..1272bbf8e2 100644 --- a/windows.data.json/jsonvalue_valuetype.md +++ b/windows.data.json/jsonvalue_valuetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Json.JsonValue.ValueType --api-type: winrt property ---- # Windows.Data.Json.JsonValue.ValueType ## -description Gets the type of the encapsulated JSON value. Possible types are defined by [JsonValueType](jsonvaluetype.md). ## -property-value The JSON value type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Json.JsonValue.ValueType +-api-type: winrt property +--- + + + +# Windows.Data.Json.JsonValue.ValueType + +## -description +Gets the type of the encapsulated JSON value. Possible types are defined by [JsonValueType](jsonvaluetype.md). + +## -property-value +The JSON value type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfdocument.md b/windows.data.pdf/pdfdocument.md index ea9e6e41da..59f30ce205 100644 --- a/windows.data.pdf/pdfdocument.md +++ b/windows.data.pdf/pdfdocument.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Data.Pdf.PdfDocument --api-type: winrt class ---- # Windows.Data.Pdf.PdfDocument ## -description Represents a Portable Document Format (PDF) document. ## -remarks Methods of this class return an **STG_E_READFAULT** error if there is a problem in reading the Portable Document Format (PDF) document. ## -examples ## -see-also [PDF document sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703785) \ No newline at end of file +--- +-api-id: T:Windows.Data.Pdf.PdfDocument +-api-type: winrt class +--- + + + +# Windows.Data.Pdf.PdfDocument + +## -description +Represents a Portable Document Format (PDF) document. + +## -remarks +Methods of this class return an **STG_E_READFAULT** error if there is a problem in reading the Portable Document Format (PDF) document. + +## -examples + +## -see-also +[PDF document sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703785) \ No newline at end of file diff --git a/windows.data.pdf/pdfdocument_getpage_1101951670.md b/windows.data.pdf/pdfdocument_getpage_1101951670.md index e33764802f..c828517b98 100644 --- a/windows.data.pdf/pdfdocument_getpage_1101951670.md +++ b/windows.data.pdf/pdfdocument_getpage_1101951670.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Pdf.PdfDocument.GetPage(System.UInt32) --api-type: winrt method ---- # Windows.Data.Pdf.PdfDocument.GetPage ## -description Gets a page from a Portable Document Format (PDF) document. ## -parameters ### -param pageIndex The location of the Portable Document Format (PDF) page relative to its parent document. ## -returns The Portable Document Format (PDF) page. ## -remarks The first page of a Portable Document Format (PDF) document is 0 (zero). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfDocument.GetPage(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfDocument.GetPage + +## -description +Gets a page from a Portable Document Format (PDF) document. + +## -parameters +### -param pageIndex +The location of the Portable Document Format (PDF) page relative to its parent document. + +## -returns +The Portable Document Format (PDF) page. + +## -remarks +The first page of a Portable Document Format (PDF) document is 0 (zero). + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfdocument_ispasswordprotected.md b/windows.data.pdf/pdfdocument_ispasswordprotected.md index 40eef4f5b2..ba60269b3f 100644 --- a/windows.data.pdf/pdfdocument_ispasswordprotected.md +++ b/windows.data.pdf/pdfdocument_ispasswordprotected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfDocument.IsPasswordProtected --api-type: winrt property ---- # Windows.Data.Pdf.PdfDocument.IsPasswordProtected ## -description Gets whether the Portable Document Format (PDF) document is password-protected. ## -property-value True if the Portable Document Format (PDF) document is password-protected; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfDocument.IsPasswordProtected +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfDocument.IsPasswordProtected + +## -description +Gets whether the Portable Document Format (PDF) document is password-protected. + +## -property-value +True if the Portable Document Format (PDF) document is password-protected; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfdocument_loadfromfileasync_1809867868.md b/windows.data.pdf/pdfdocument_loadfromfileasync_1809867868.md index d57cf240b9..2d6297f844 100644 --- a/windows.data.pdf/pdfdocument_loadfromfileasync_1809867868.md +++ b/windows.data.pdf/pdfdocument_loadfromfileasync_1809867868.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromFileAsync(Windows.Storage.IStorageFile,System.String) --api-type: winrt method ---- # Windows.Data.Pdf.PdfDocument.LoadFromFileAsync ## -description Outputs an asynchronous operation. When the operation completes, a [PdfDocument](pdfdocument.md) object is returned, which represents a Portable Document Format (PDF) document. Use this method if the Portable Document Format (PDF) document is password-protected. ## -parameters ### -param file The file, which represents a Portable Document Format (PDF) document. ### -param password The password to open the Portable Document Format (PDF) document, if it requires one. ## -returns The asynchronous operation. ## -remarks If the Portable Document Format (PDF) document does not require a password, this method ignores it. This method returns an **ERROR_WRONG_PASSWORD** error if the wrong password is specified. ## -examples ## -see-also [LoadFromFileAsync(IStorageFile)](pdfdocument_loadfromfileasync_656173540.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromFileAsync(Windows.Storage.IStorageFile,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfDocument.LoadFromFileAsync + +## -description +Outputs an asynchronous operation. When the operation completes, a [PdfDocument](pdfdocument.md) object is returned, which represents a Portable Document Format (PDF) document. Use this method if the Portable Document Format (PDF) document is password-protected. + +## -parameters +### -param file +The file, which represents a Portable Document Format (PDF) document. + +### -param password +The password to open the Portable Document Format (PDF) document, if it requires one. + +## -returns +The asynchronous operation. + +## -remarks +If the Portable Document Format (PDF) document does not require a password, this method ignores it. + +This method returns an **ERROR_WRONG_PASSWORD** error if the wrong password is specified. + +## -examples + +## -see-also +[LoadFromFileAsync(IStorageFile)](pdfdocument_loadfromfileasync_656173540.md) \ No newline at end of file diff --git a/windows.data.pdf/pdfdocument_loadfromfileasync_656173540.md b/windows.data.pdf/pdfdocument_loadfromfileasync_656173540.md index 464cb04a9b..a882d0d551 100644 --- a/windows.data.pdf/pdfdocument_loadfromfileasync_656173540.md +++ b/windows.data.pdf/pdfdocument_loadfromfileasync_656173540.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Data.Pdf.PdfDocument.LoadFromFileAsync ## -description Outputs an asynchronous operation. When the operation completes, a [PdfDocument](pdfdocument.md) object is returned, which represents a Portable Document Format (PDF) document. ## -parameters ### -param file The file, which represents a Portable Document Format (PDF) document. ## -returns The asynchronous operation. ## -remarks ## -examples ## -see-also [LoadFromFileAsync(IStorageFile, String)](pdfdocument_loadfromfileasync_1809867868.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfDocument.LoadFromFileAsync + +## -description +Outputs an asynchronous operation. When the operation completes, a [PdfDocument](pdfdocument.md) object is returned, which represents a Portable Document Format (PDF) document. + +## -parameters +### -param file +The file, which represents a Portable Document Format (PDF) document. + +## -returns +The asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[LoadFromFileAsync(IStorageFile, String)](pdfdocument_loadfromfileasync_1809867868.md) \ No newline at end of file diff --git a/windows.data.pdf/pdfdocument_loadfromstreamasync_1652306870.md b/windows.data.pdf/pdfdocument_loadfromstreamasync_1652306870.md index 5c6339adb9..0c6a43a15b 100644 --- a/windows.data.pdf/pdfdocument_loadfromstreamasync_1652306870.md +++ b/windows.data.pdf/pdfdocument_loadfromstreamasync_1652306870.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync(Windows.Storage.Streams.IRandomAccessStream,System.String) --api-type: winrt method ---- # Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync ## -description Creates a [PdfDocument](pdfdocument.md) object, representing a Portable Document Format (PDF) document, from a stream of data that represents a Portable Document Format (PDF) document in the file system. Use this method if the Portable Document Format (PDF) document is password-protected. ## -parameters ### -param inputStream The stream of data, which represents a Portable Document Format (PDF) document. ### -param password The password to open the Portable Document Format (PDF) document, if it requires one. ## -returns The asynchronous operation. ## -remarks If the Portable Document Format (PDF) document does not require a password, this method ignores it. This method returns an **ERROR_WRONG_PASSWORD** error if the wrong password is specified. ## -examples ## -see-also [LoadFromStreamAsync(IRandomAccessStream)](pdfdocument_loadfromstreamasync_780156426.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync(Windows.Storage.Streams.IRandomAccessStream,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync + +## -description +Creates a [PdfDocument](pdfdocument.md) object, representing a Portable Document Format (PDF) document, from a stream of data that represents a Portable Document Format (PDF) document in the file system. Use this method if the Portable Document Format (PDF) document is password-protected. + +## -parameters +### -param inputStream +The stream of data, which represents a Portable Document Format (PDF) document. + +### -param password +The password to open the Portable Document Format (PDF) document, if it requires one. + +## -returns +The asynchronous operation. + +## -remarks +If the Portable Document Format (PDF) document does not require a password, this method ignores it. + +This method returns an **ERROR_WRONG_PASSWORD** error if the wrong password is specified. + +## -examples + +## -see-also +[LoadFromStreamAsync(IRandomAccessStream)](pdfdocument_loadfromstreamasync_780156426.md) \ No newline at end of file diff --git a/windows.data.pdf/pdfdocument_loadfromstreamasync_780156426.md b/windows.data.pdf/pdfdocument_loadfromstreamasync_780156426.md index b143630745..3c54ad9021 100644 --- a/windows.data.pdf/pdfdocument_loadfromstreamasync_780156426.md +++ b/windows.data.pdf/pdfdocument_loadfromstreamasync_780156426.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync ## -description Creates a [PdfDocument](pdfdocument.md) object, representing a Portable Document Format (PDF) document, from a stream of data that represents a Portable Document Format (PDF) document in the file system. ## -parameters ### -param inputStream The stream of data, which represents a Portable Document Format (PDF) document. ## -returns The asynchronous operation. ## -remarks ## -examples ## -see-also [LoadFromStreamAsync(IRandomAccessStream, String)](pdfdocument_loadfromstreamasync_1652306870.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfDocument.LoadFromStreamAsync + +## -description +Creates a [PdfDocument](pdfdocument.md) object, representing a Portable Document Format (PDF) document, from a stream of data that represents a Portable Document Format (PDF) document in the file system. + +## -parameters +### -param inputStream +The stream of data, which represents a Portable Document Format (PDF) document. + +## -returns +The asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[LoadFromStreamAsync(IRandomAccessStream, String)](pdfdocument_loadfromstreamasync_1652306870.md) \ No newline at end of file diff --git a/windows.data.pdf/pdfdocument_pagecount.md b/windows.data.pdf/pdfdocument_pagecount.md index d2bc68f3f0..624649c2d9 100644 --- a/windows.data.pdf/pdfdocument_pagecount.md +++ b/windows.data.pdf/pdfdocument_pagecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfDocument.PageCount --api-type: winrt property ---- # Windows.Data.Pdf.PdfDocument.PageCount ## -description Gets the number of pages in the Portable Document Format (PDF) document. ## -property-value The number of pages in the Portable Document Format (PDF) document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfDocument.PageCount +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfDocument.PageCount + +## -description +Gets the number of pages in the Portable Document Format (PDF) document. + +## -property-value +The number of pages in the Portable Document Format (PDF) document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage.md b/windows.data.pdf/pdfpage.md index 7b6baa5f34..dfa7421988 100644 --- a/windows.data.pdf/pdfpage.md +++ b/windows.data.pdf/pdfpage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Data.Pdf.PdfPage --api-type: winrt class ---- # Windows.Data.Pdf.PdfPage ## -description Represents a single page in a Portable Document Format (PDF) document. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [PDF document sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703785) \ No newline at end of file +--- +-api-id: T:Windows.Data.Pdf.PdfPage +-api-type: winrt class +--- + + + +# Windows.Data.Pdf.PdfPage + +## -description +Represents a single page in a Portable Document Format (PDF) document. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [PDF document sample (Windows 10)](http://go.microsoft.com/fwlink/?LinkID=703785) \ No newline at end of file diff --git a/windows.data.pdf/pdfpage_close_811482585.md b/windows.data.pdf/pdfpage_close_811482585.md index d7dca08039..117c57ff70 100644 --- a/windows.data.pdf/pdfpage_close_811482585.md +++ b/windows.data.pdf/pdfpage_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Pdf.PdfPage.Close --api-type: winrt method ---- # Windows.Data.Pdf.PdfPage.Close ## -description Releases all resources associated with the Portable Document Format (PDF) page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfPage.Close +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfPage.Close + +## -description +Releases all resources associated with the Portable Document Format (PDF) page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage_dimensions.md b/windows.data.pdf/pdfpage_dimensions.md index c9ebc105bb..fe57a19e76 100644 --- a/windows.data.pdf/pdfpage_dimensions.md +++ b/windows.data.pdf/pdfpage_dimensions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPage.Dimensions --api-type: winrt property ---- # Windows.Data.Pdf.PdfPage.Dimensions ## -description Gets the group of dimension properties for a single page in a Portable Document Format (PDF) document. ## -property-value The group of page dimension properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPage.Dimensions +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPage.Dimensions + +## -description +Gets the group of dimension properties for a single page in a Portable Document Format (PDF) document. + +## -property-value +The group of page dimension properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage_index.md b/windows.data.pdf/pdfpage_index.md index 3f279c8ed1..441823016b 100644 --- a/windows.data.pdf/pdfpage_index.md +++ b/windows.data.pdf/pdfpage_index.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPage.Index --api-type: winrt property ---- # Windows.Data.Pdf.PdfPage.Index ## -description Gets the relative position of the Portable Document Format (PDF) page within its parent Portable Document Format (PDF) document. ## -property-value The position of the Portable Document Format (PDF) page relative to its parent Portable Document Format (PDF) document. ## -remarks The first page of a Portable Document Format (PDF) document is index 0 (zero). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPage.Index +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPage.Index + +## -description +Gets the relative position of the Portable Document Format (PDF) page within its parent Portable Document Format (PDF) document. + +## -property-value +The position of the Portable Document Format (PDF) page relative to its parent Portable Document Format (PDF) document. + +## -remarks +The first page of a Portable Document Format (PDF) document is index 0 (zero). + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage_preferredzoom.md b/windows.data.pdf/pdfpage_preferredzoom.md index bbc3cc02b2..1978f7fb8a 100644 --- a/windows.data.pdf/pdfpage_preferredzoom.md +++ b/windows.data.pdf/pdfpage_preferredzoom.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPage.PreferredZoom --api-type: winrt property ---- # Windows.Data.Pdf.PdfPage.PreferredZoom ## -description Gets the Portable Document Format (PDF) page's preferred magnification factor. ## -property-value The magnification scaling factor to display or print the Portable Document Format (PDF) page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPage.PreferredZoom +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPage.PreferredZoom + +## -description +Gets the Portable Document Format (PDF) page's preferred magnification factor. + +## -property-value +The magnification scaling factor to display or print the Portable Document Format (PDF) page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage_preparepageasync_2117482162.md b/windows.data.pdf/pdfpage_preparepageasync_2117482162.md index 7fbe74b9b0..15f141c37e 100644 --- a/windows.data.pdf/pdfpage_preparepageasync_2117482162.md +++ b/windows.data.pdf/pdfpage_preparepageasync_2117482162.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Pdf.PdfPage.PreparePageAsync --api-type: winrt method ---- # Windows.Data.Pdf.PdfPage.PreparePageAsync ## -description Begins building the Portable Document Format (PDF) page. After this method finishes, the Portable Document Format (PDF) page is completely built. ## -returns Represents the fully-built Portable Document Format (PDF) page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfPage.PreparePageAsync +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfPage.PreparePageAsync + +## -description +Begins building the Portable Document Format (PDF) page. After this method finishes, the Portable Document Format (PDF) page is completely built. + +## -returns +Represents the fully-built Portable Document Format (PDF) page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage_rendertostreamasync_507686896.md b/windows.data.pdf/pdfpage_rendertostreamasync_507686896.md index 6a982207aa..24ce2535eb 100644 --- a/windows.data.pdf/pdfpage_rendertostreamasync_507686896.md +++ b/windows.data.pdf/pdfpage_rendertostreamasync_507686896.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Pdf.PdfPage.RenderToStreamAsync(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Data.Pdf.PdfPage.RenderToStreamAsync ## -description Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents, as an asynchronous action. This asynchronous action can be used to create an image of the Portable Document Format (PDF) page. ## -parameters ### -param outputStream The stream of data, which represents a Portable Document Format (PDF) page's content. ## -returns The asynchronous action. ## -remarks ## -examples ## -see-also [RenderToStreamAsync(IRandomAccessStream, PdfPageRenderOptions)](pdfpage_rendertostreamasync_894123342.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfPage.RenderToStreamAsync(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfPage.RenderToStreamAsync + +## -description +Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents, as an asynchronous action. This asynchronous action can be used to create an image of the Portable Document Format (PDF) page. + +## -parameters +### -param outputStream +The stream of data, which represents a Portable Document Format (PDF) page's content. + +## -returns +The asynchronous action. + +## -remarks + +## -examples + +## -see-also +[RenderToStreamAsync(IRandomAccessStream, PdfPageRenderOptions)](pdfpage_rendertostreamasync_894123342.md) \ No newline at end of file diff --git a/windows.data.pdf/pdfpage_rendertostreamasync_894123342.md b/windows.data.pdf/pdfpage_rendertostreamasync_894123342.md index d309cdcfd8..6029781e71 100644 --- a/windows.data.pdf/pdfpage_rendertostreamasync_894123342.md +++ b/windows.data.pdf/pdfpage_rendertostreamasync_894123342.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Pdf.PdfPage.RenderToStreamAsync(Windows.Storage.Streams.IRandomAccessStream,Windows.Data.Pdf.PdfPageRenderOptions) --api-type: winrt method ---- # Windows.Data.Pdf.PdfPage.RenderToStreamAsync ## -description Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an asynchronous action. This asynchronous action can be used to create a customized display image of the Portable Document Format (PDF) page. ## -parameters ### -param outputStream The stream of data, which represents a Portable Document Format (PDF) page's contents. ### -param options The requested set of display settings to apply to the display image that is output based on the Portable Document Format (PDF) page. ## -returns The asynchronous action. ## -remarks ## -examples ## -see-also [RenderToStreamAsync(IRandomAccessStream)](pdfpage_rendertostreamasync_507686896.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfPage.RenderToStreamAsync(Windows.Storage.Streams.IRandomAccessStream,Windows.Data.Pdf.PdfPageRenderOptions) +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfPage.RenderToStreamAsync + +## -description +Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an asynchronous action. This asynchronous action can be used to create a customized display image of the Portable Document Format (PDF) page. + +## -parameters +### -param outputStream +The stream of data, which represents a Portable Document Format (PDF) page's contents. + +### -param options +The requested set of display settings to apply to the display image that is output based on the Portable Document Format (PDF) page. + +## -returns +The asynchronous action. + +## -remarks + +## -examples + +## -see-also +[RenderToStreamAsync(IRandomAccessStream)](pdfpage_rendertostreamasync_507686896.md) \ No newline at end of file diff --git a/windows.data.pdf/pdfpage_rotation.md b/windows.data.pdf/pdfpage_rotation.md index 5fbd777ced..3aa780f7ff 100644 --- a/windows.data.pdf/pdfpage_rotation.md +++ b/windows.data.pdf/pdfpage_rotation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPage.Rotation --api-type: winrt property ---- # Windows.Data.Pdf.PdfPage.Rotation ## -description Gets the number of degrees that the Portable Document Format (PDF) page will be rotated when it's displayed or printed. ## -property-value The number of degrees to rotate the Portable Document Format (PDF) page, expressed as one of the enumeration values. ## -remarks Degrees are expressed relative to a clockwise rotation. Degrees are expressed in multiples of 90. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPage.Rotation +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPage.Rotation + +## -description +Gets the number of degrees that the Portable Document Format (PDF) page will be rotated when it's displayed or printed. + +## -property-value +The number of degrees to rotate the Portable Document Format (PDF) page, expressed as one of the enumeration values. + +## -remarks +Degrees are expressed relative to a clockwise rotation. Degrees are expressed in multiples of 90. + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpage_size.md b/windows.data.pdf/pdfpage_size.md index 5e7af28f6e..c99d1c130c 100644 --- a/windows.data.pdf/pdfpage_size.md +++ b/windows.data.pdf/pdfpage_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPage.Size --api-type: winrt property ---- # Windows.Data.Pdf.PdfPage.Size ## -description Gets the Portable Document Format (PDF) page's size based on its related [CropBox](pdfpagedimensions_cropbox.md), [MediaBox](pdfpagedimensions_mediabox.md), and [Rotation](pdfpage_rotation.md) property values. ## -property-value The Portable Document Format (PDF) page's computed size. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPage.Size +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPage.Size + +## -description +Gets the Portable Document Format (PDF) page's size based on its related [CropBox](pdfpagedimensions_cropbox.md), [MediaBox](pdfpagedimensions_mediabox.md), and [Rotation](pdfpage_rotation.md) property values. + +## -property-value +The Portable Document Format (PDF) page's computed size. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagedimensions.md b/windows.data.pdf/pdfpagedimensions.md index fe34813c4b..68e0d872c8 100644 --- a/windows.data.pdf/pdfpagedimensions.md +++ b/windows.data.pdf/pdfpagedimensions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Data.Pdf.PdfPageDimensions --api-type: winrt class ---- # Windows.Data.Pdf.PdfPageDimensions ## -description Represents the dimensions of a single page in a Portable Document Format (PDF) document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Pdf.PdfPageDimensions +-api-type: winrt class +--- + + + +# Windows.Data.Pdf.PdfPageDimensions + +## -description +Represents the dimensions of a single page in a Portable Document Format (PDF) document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagedimensions_artbox.md b/windows.data.pdf/pdfpagedimensions_artbox.md index 4f8a476772..5f6b2e2d6d 100644 --- a/windows.data.pdf/pdfpagedimensions_artbox.md +++ b/windows.data.pdf/pdfpagedimensions_artbox.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageDimensions.ArtBox --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageDimensions.ArtBox ## -description Gets the size of a rectangle that contains the Portable Document Format (PDF) page's contents, including any meaningful surrounding white space, as intended by the Portable Document Format (PDF) page's creator. ## -property-value The size of the Portable Document Format (PDF) page's contents and any meaningful surrounding white space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageDimensions.ArtBox +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageDimensions.ArtBox + +## -description +Gets the size of a rectangle that contains the Portable Document Format (PDF) page's contents, including any meaningful surrounding white space, as intended by the Portable Document Format (PDF) page's creator. + +## -property-value +The size of the Portable Document Format (PDF) page's contents and any meaningful surrounding white space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagedimensions_bleedbox.md b/windows.data.pdf/pdfpagedimensions_bleedbox.md index c0a8e4bb72..85c963e464 100644 --- a/windows.data.pdf/pdfpagedimensions_bleedbox.md +++ b/windows.data.pdf/pdfpagedimensions_bleedbox.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageDimensions.BleedBox --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageDimensions.BleedBox ## -description Gets the size of a rectangle that specifies the clipped region of a Portable Document Format (PDF) page's contents when it is displayed. ## -property-value The size of the Portable Document Format (PDF) page's clipped region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageDimensions.BleedBox +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageDimensions.BleedBox + +## -description +Gets the size of a rectangle that specifies the clipped region of a Portable Document Format (PDF) page's contents when it is displayed. + +## -property-value +The size of the Portable Document Format (PDF) page's clipped region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagedimensions_cropbox.md b/windows.data.pdf/pdfpagedimensions_cropbox.md index 420b1318bc..d9b564b9c0 100644 --- a/windows.data.pdf/pdfpagedimensions_cropbox.md +++ b/windows.data.pdf/pdfpagedimensions_cropbox.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageDimensions.CropBox --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageDimensions.CropBox ## -description Gets the size of a rectangle that specifies the cropped region of a Portable Document Format (PDF) page's contents when it is displayed. ## -property-value The size of the Portable Document Format (PDF) page's cropped region. ## -remarks When the Portable Document Format (PDF) page is displayed or printed, its contents are cropped to this rectangle. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageDimensions.CropBox +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageDimensions.CropBox + +## -description +Gets the size of a rectangle that specifies the cropped region of a Portable Document Format (PDF) page's contents when it is displayed. + +## -property-value +The size of the Portable Document Format (PDF) page's cropped region. + +## -remarks +When the Portable Document Format (PDF) page is displayed or printed, its contents are cropped to this rectangle. + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagedimensions_mediabox.md b/windows.data.pdf/pdfpagedimensions_mediabox.md index 0985fbe461..ddfffe4196 100644 --- a/windows.data.pdf/pdfpagedimensions_mediabox.md +++ b/windows.data.pdf/pdfpagedimensions_mediabox.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageDimensions.MediaBox --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageDimensions.MediaBox ## -description Gets the size of a rectangle that defines the boundaries of the area that the Portable Document Format (PDF) page will be displayed or printed to. ## -property-value The size of the Portable Document Format (PDF) page's display or print boundaries. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageDimensions.MediaBox +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageDimensions.MediaBox + +## -description +Gets the size of a rectangle that defines the boundaries of the area that the Portable Document Format (PDF) page will be displayed or printed to. + +## -property-value +The size of the Portable Document Format (PDF) page's display or print boundaries. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagedimensions_trimbox.md b/windows.data.pdf/pdfpagedimensions_trimbox.md index 8e8112bc49..1d16d6aecb 100644 --- a/windows.data.pdf/pdfpagedimensions_trimbox.md +++ b/windows.data.pdf/pdfpagedimensions_trimbox.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageDimensions.TrimBox --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageDimensions.TrimBox ## -description Gets the size of a rectangle that specifies the intended dimensions of the Portable Document Format (PDF) page after it has been trimmed. ## -property-value The Portable Document Format (PDF) page's trimmed dimensions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageDimensions.TrimBox +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageDimensions.TrimBox + +## -description +Gets the size of a rectangle that specifies the intended dimensions of the Portable Document Format (PDF) page after it has been trimmed. + +## -property-value +The Portable Document Format (PDF) page's trimmed dimensions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions.md b/windows.data.pdf/pdfpagerenderoptions.md index 81938a39d1..5a85c78d91 100644 --- a/windows.data.pdf/pdfpagerenderoptions.md +++ b/windows.data.pdf/pdfpagerenderoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Data.Pdf.PdfPageRenderOptions --api-type: winrt class ---- # Windows.Data.Pdf.PdfPageRenderOptions ## -description Represents display settings for a single page of a Portable Document Format (PDF) document, such as the page's background color and its encoding type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Pdf.PdfPageRenderOptions +-api-type: winrt class +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions + +## -description +Represents display settings for a single page of a Portable Document Format (PDF) document, such as the page's background color and its encoding type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_backgroundcolor.md b/windows.data.pdf/pdfpagerenderoptions_backgroundcolor.md index 20e1969f97..4eaee91e6f 100644 --- a/windows.data.pdf/pdfpagerenderoptions_backgroundcolor.md +++ b/windows.data.pdf/pdfpagerenderoptions_backgroundcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.BackgroundColor --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageRenderOptions.BackgroundColor ## -description Gets or sets the Portable Document Format (PDF) page's background color. ## -property-value The Portable Document Format (PDF) page's background color. ## -remarks The default background color is [White](../windows.ui/colors_white.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.BackgroundColor +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.BackgroundColor + +## -description +Gets or sets the Portable Document Format (PDF) page's background color. + +## -property-value +The Portable Document Format (PDF) page's background color. + +## -remarks +The default background color is [White](../windows.ui/colors_white.md) + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_bitmapencoderid.md b/windows.data.pdf/pdfpagerenderoptions_bitmapencoderid.md index 581c2b0adf..43dfd65aa7 100644 --- a/windows.data.pdf/pdfpagerenderoptions_bitmapencoderid.md +++ b/windows.data.pdf/pdfpagerenderoptions_bitmapencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.BitmapEncoderId --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageRenderOptions.BitmapEncoderId ## -description Gets or sets the Portable Document Format (PDF) page's encoding type to be used while the page is being converted to a bitmap. ## -property-value A [BmpEncoderId](../windows.graphics.imaging/bitmapencoder_bmpencoderid.md) value representing the unique identifier of the built-in bitmap encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.BitmapEncoderId +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.BitmapEncoderId + +## -description +Gets or sets the Portable Document Format (PDF) page's encoding type to be used while the page is being converted to a bitmap. + +## -property-value +A [BmpEncoderId](../windows.graphics.imaging/bitmapencoder_bmpencoderid.md) value representing the unique identifier of the built-in bitmap encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_destinationheight.md b/windows.data.pdf/pdfpagerenderoptions_destinationheight.md index 7bd9f5ddb7..31274fca30 100644 --- a/windows.data.pdf/pdfpagerenderoptions_destinationheight.md +++ b/windows.data.pdf/pdfpagerenderoptions_destinationheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.DestinationHeight --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageRenderOptions.DestinationHeight ## -description Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs). ## -property-value The Portable Document Format (PDF) page's scaling factor relative to the page's destination display height boundary. ## -remarks The value for **DestinationHeight** is the final size of the rendered page. If **DestinationHeight** is not specified, the page's aspect ratio is maintained relative to the destination width. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.DestinationHeight +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.DestinationHeight + +## -description +Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs). + +## -property-value +The Portable Document Format (PDF) page's scaling factor relative to the page's destination display height boundary. + +## -remarks +The value for **DestinationHeight** is the final size of the rendered page. If **DestinationHeight** is not specified, the page's aspect ratio is maintained relative to the destination width. + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_destinationwidth.md b/windows.data.pdf/pdfpagerenderoptions_destinationwidth.md index da145a2653..692e8a7dd4 100644 --- a/windows.data.pdf/pdfpagerenderoptions_destinationwidth.md +++ b/windows.data.pdf/pdfpagerenderoptions_destinationwidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.DestinationWidth --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageRenderOptions.DestinationWidth ## -description Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs). ## -property-value The Portable Document Format (PDF) page's scaling factor relative to the page's destination display width boundary. ## -remarks The value for **DestinationWidth** is the final size of the rendered page. If **DestinationWidth** is not specified, the page's aspect ratio is maintained relative to the destination height. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.DestinationWidth +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.DestinationWidth + +## -description +Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs). + +## -property-value +The Portable Document Format (PDF) page's scaling factor relative to the page's destination display width boundary. + +## -remarks +The value for **DestinationWidth** is the final size of the rendered page. If **DestinationWidth** is not specified, the page's aspect ratio is maintained relative to the destination height. + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_isignoringhighcontrast.md b/windows.data.pdf/pdfpagerenderoptions_isignoringhighcontrast.md index ecf66a2f03..2f3ba9854b 100644 --- a/windows.data.pdf/pdfpagerenderoptions_isignoringhighcontrast.md +++ b/windows.data.pdf/pdfpagerenderoptions_isignoringhighcontrast.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.IsIgnoringHighContrast --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageRenderOptions.IsIgnoringHighContrast ## -description Gets or sets whether the Portable Document Format (PDF) page uses the system's high contrast display setting. ## -property-value False to use high contrast; otherwise, true. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.IsIgnoringHighContrast +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.IsIgnoringHighContrast + +## -description +Gets or sets whether the Portable Document Format (PDF) page uses the system's high contrast display setting. + +## -property-value +False to use high contrast; otherwise, true. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_pdfpagerenderoptions_1221375020.md b/windows.data.pdf/pdfpagerenderoptions_pdfpagerenderoptions_1221375020.md index 453c62cab7..829dca9026 100644 --- a/windows.data.pdf/pdfpagerenderoptions_pdfpagerenderoptions_1221375020.md +++ b/windows.data.pdf/pdfpagerenderoptions_pdfpagerenderoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Pdf.PdfPageRenderOptions.#ctor --api-type: winrt method ---- # Windows.Data.Pdf.PdfPageRenderOptions.PdfPageRenderOptions ## -description Creates and initializes a new instance of display settings for a single page of a Portable Document Format (PDF) document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Pdf.PdfPageRenderOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.PdfPageRenderOptions + +## -description +Creates and initializes a new instance of display settings for a single page of a Portable Document Format (PDF) document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.pdf/pdfpagerenderoptions_sourcerect.md b/windows.data.pdf/pdfpagerenderoptions_sourcerect.md index ff975d8d10..f77b930447 100644 --- a/windows.data.pdf/pdfpagerenderoptions_sourcerect.md +++ b/windows.data.pdf/pdfpagerenderoptions_sourcerect.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.SourceRect --api-type: winrt property ---- # Windows.Data.Pdf.PdfPageRenderOptions.SourceRect ## -description Gets or sets a portion of the Portable Document Format (PDF) page to be displayed. ## -property-value The portion of the Portable Document Format (PDF) page to be displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Pdf.PdfPageRenderOptions.SourceRect +-api-type: winrt property +--- + + + +# Windows.Data.Pdf.PdfPageRenderOptions.SourceRect + +## -description +Gets or sets a portion of the Portable Document Format (PDF) page to be displayed. + +## -property-value +The portion of the Portable Document Format (PDF) page to be displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/alternatewordform.md b/windows.data.text/alternatewordform.md index 82ebfd6a14..b931133286 100644 --- a/windows.data.text/alternatewordform.md +++ b/windows.data.text/alternatewordform.md @@ -1,3 +1,32 @@ ---- -api-id: T:Windows.Data.Text.AlternateWordForm --api-type: winrt class ---- # Windows.Data.Text.AlternateWordForm ## -description Identifies an alternate form of the word represented by a [WordSegment](wordsegment.md) object.. For example, this may contain a number in a normalized format. ## -remarks Your code does not create instances of this class. It retrieves them from a [WordSegment.AlternateForms](wordsegment_alternateforms.md) list. The value of the [AlternateNormalizationFormat](alternatenormalizationformat.md) property indicates the normalization format used to format the [AlternateText](alternatetext.md) property. It is one of the following possible normalization formats. When *NormalizationFormat* property is **AlternateNormalizationFormat.Number**, "." is used to indicate the decimal separator, and a leading "-" indicates that the number is negative. When *NormalizationFormat* is **AlternateNormalizationFormat.Currency**, "." is used to indicate the decimal separator, a leading "-" indicates that the number is negative, and the text following the last digit is the currency symbol. When *NormalizationFormat* is **AlternateNormalizationFormat.Date**, the result is "YYYY-MM-DD", where "YYYY" is the Gregorian year (0-padded), "MM" is the numerical month (0-padded), and "DD" is the day (0-padded). When *NormalizationFormat* is **AlternateNormalizationFormat.Time**, the result is "HH:MM:SS", where "HH" is the hour in 24-hour time (0-padded) (0-23), "MM" is the minute (0-padded), and "SS" is the seconds (0-padded). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.AlternateWordForm +-api-type: winrt class +--- + + + +# Windows.Data.Text.AlternateWordForm + +## -description +Identifies an alternate form of the word represented by a [WordSegment](wordsegment.md) object.. For example, this may contain a number in a normalized format. + +## -remarks +Your code does not create instances of this class. It retrieves them from a [WordSegment.AlternateForms](wordsegment_alternateforms.md) list. + +The value of the [AlternateNormalizationFormat](alternatenormalizationformat.md) property indicates the normalization format used to format the [AlternateText](alternatetext.md) property. It is one of the following possible normalization formats. + +When *NormalizationFormat* property is **AlternateNormalizationFormat.Number**, "." is used to indicate the decimal separator, and a leading "-" indicates that the number is negative. + +When *NormalizationFormat* is **AlternateNormalizationFormat.Currency**, "." is used to indicate the decimal separator, a leading "-" indicates that the number is negative, and the text following the last digit is the currency symbol. + +When *NormalizationFormat* is **AlternateNormalizationFormat.Date**, the result is "YYYY-MM-DD", where "YYYY" is the Gregorian year (0-padded), "MM" is the numerical month (0-padded), and "DD" is the day (0-padded). + +When *NormalizationFormat* is **AlternateNormalizationFormat.Time**, the result is "HH:MM:SS", where "HH" is the hour in 24-hour time (0-padded) (0-23), "MM" is the minute (0-padded), and "SS" is the seconds (0-padded). + + + +## -examples + +## -see-also diff --git a/windows.data.text/alternatewordform_alternatetext.md b/windows.data.text/alternatewordform_alternatetext.md index 316d0364c3..0d39988218 100644 --- a/windows.data.text/alternatewordform_alternatetext.md +++ b/windows.data.text/alternatewordform_alternatetext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Text.AlternateWordForm.AlternateText --api-type: winrt property ---- # Windows.Data.Text.AlternateWordForm.AlternateText ## -description Gets the text of the alternate word form identified by this [AlternateWordForm](alternatewordform.md) object. ## -property-value The alternate word form. ## -remarks ## -examples ## -see-also [AlternateNormalizationFormat](alternatenormalizationformat.md) \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.AlternateWordForm.AlternateText +-api-type: winrt property +--- + + + +# Windows.Data.Text.AlternateWordForm.AlternateText + +## -description +Gets the text of the alternate word form identified by this [AlternateWordForm](alternatewordform.md) object. + +## -property-value +The alternate word form. + +## -remarks + +## -examples + +## -see-also +[AlternateNormalizationFormat](alternatenormalizationformat.md) \ No newline at end of file diff --git a/windows.data.text/alternatewordform_normalizationformat.md b/windows.data.text/alternatewordform_normalizationformat.md index c1a2aa2af2..b051fcf4e0 100644 --- a/windows.data.text/alternatewordform_normalizationformat.md +++ b/windows.data.text/alternatewordform_normalizationformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Text.AlternateWordForm.NormalizationFormat --api-type: winrt property ---- # Windows.Data.Text.AlternateWordForm.NormalizationFormat ## -description Gets the normalization format for this current [AlternateWordForm](alternatewordform.md) object. ## -property-value The normalization format. ## -remarks ## -examples ## -see-also [AlternateNormalizationFormat](alternatenormalizationformat.md) \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.AlternateWordForm.NormalizationFormat +-api-type: winrt property +--- + + + +# Windows.Data.Text.AlternateWordForm.NormalizationFormat + +## -description +Gets the normalization format for this current [AlternateWordForm](alternatewordform.md) object. + +## -property-value +The normalization format. + +## -remarks + +## -examples + +## -see-also +[AlternateNormalizationFormat](alternatenormalizationformat.md) \ No newline at end of file diff --git a/windows.data.text/alternatewordform_sourcetextsegment.md b/windows.data.text/alternatewordform_sourcetextsegment.md index 329ec8218d..aa48296203 100644 --- a/windows.data.text/alternatewordform_sourcetextsegment.md +++ b/windows.data.text/alternatewordform_sourcetextsegment.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Text.AlternateWordForm.SourceTextSegment --api-type: winrt property ---- # Windows.Data.Text.AlternateWordForm.SourceTextSegment ## -description Gets the [TextSegment](textsegment.md) that identifies the source text's sub-string for which this [AlternateWordForm](alternatewordform.md) object is an alternate. ## -property-value The [TextSegment](textsegment.md) structure that identifies the word in your provided text. ## -remarks ## -examples ## -see-also [TextSegment](textsegment.md) \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.AlternateWordForm.SourceTextSegment +-api-type: winrt property +--- + + + +# Windows.Data.Text.AlternateWordForm.SourceTextSegment + +## -description +Gets the [TextSegment](textsegment.md) that identifies the source text's sub-string for which this [AlternateWordForm](alternatewordform.md) object is an alternate. + +## -property-value +The [TextSegment](textsegment.md) structure that identifies the word in your provided text. + +## -remarks + +## -examples + +## -see-also +[TextSegment](textsegment.md) \ No newline at end of file diff --git a/windows.data.text/selectablewordsegment.md b/windows.data.text/selectablewordsegment.md index 46b4038b5d..e6088f9737 100644 --- a/windows.data.text/selectablewordsegment.md +++ b/windows.data.text/selectablewordsegment.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Data.Text.SelectableWordSegment --api-type: winrt class ---- # Windows.Data.Text.SelectableWordSegment ## -description Represents a segment from your provided text that includes a word and any trailing whitespace and/or punctuation after this word. ## -remarks Your code does not instantiate this class directly. Instead, you use instances retrieved from a [SelectableWordsSegmenter](selectablewordssegmenter.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.SelectableWordSegment +-api-type: winrt class +--- + + + +# Windows.Data.Text.SelectableWordSegment + +## -description +Represents a segment from your provided text that includes a word and any trailing whitespace and/or punctuation after this word. + +## -remarks +Your code does not instantiate this class directly. Instead, you use instances retrieved from a [SelectableWordsSegmenter](selectablewordssegmenter.md) object. + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordsegment_sourcetextsegment.md b/windows.data.text/selectablewordsegment_sourcetextsegment.md index 7443d1e79d..e1366bf96a 100644 --- a/windows.data.text/selectablewordsegment_sourcetextsegment.md +++ b/windows.data.text/selectablewordsegment_sourcetextsegment.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Text.SelectableWordSegment.SourceTextSegment --api-type: winrt property ---- # Windows.Data.Text.SelectableWordSegment.SourceTextSegment ## -description Gets the [TextSegment](textsegment.md) that identifies the source text's sub-string that is the selected word. ## -property-value The [TextSegment](textsegment.md) structure that identifies the word in your provided text. ## -remarks ## -examples ## -see-also [TextSegment](textsegment.md) \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.SelectableWordSegment.SourceTextSegment +-api-type: winrt property +--- + + + +# Windows.Data.Text.SelectableWordSegment.SourceTextSegment + +## -description +Gets the [TextSegment](textsegment.md) that identifies the source text's sub-string that is the selected word. + +## -property-value +The [TextSegment](textsegment.md) structure that identifies the word in your provided text. + +## -remarks + +## -examples + +## -see-also +[TextSegment](textsegment.md) \ No newline at end of file diff --git a/windows.data.text/selectablewordsegment_text.md b/windows.data.text/selectablewordsegment_text.md index 2acbe9dc99..a8bfb43fb4 100644 --- a/windows.data.text/selectablewordsegment_text.md +++ b/windows.data.text/selectablewordsegment_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.SelectableWordSegment.Text --api-type: winrt property ---- # Windows.Data.Text.SelectableWordSegment.Text ## -description Gets the text of the selected word identified by this [SelectableWordSegment](selectablewordsegment.md) object. ## -property-value The selected word. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.SelectableWordSegment.Text +-api-type: winrt property +--- + + + +# Windows.Data.Text.SelectableWordSegment.Text + +## -description +Gets the text of the selected word identified by this [SelectableWordSegment](selectablewordsegment.md) object. + +## -property-value +The selected word. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordssegmenter.md b/windows.data.text/selectablewordssegmenter.md index 15efaf5144..19495df17f 100644 --- a/windows.data.text/selectablewordssegmenter.md +++ b/windows.data.text/selectablewordssegmenter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Data.Text.SelectableWordsSegmenter --api-type: winrt class ---- # Windows.Data.Text.SelectableWordsSegmenter ## -description A segmenter class that is able to segment provided text into units appropriate for selecting text by words. The language supplied when this object is constructed is matched against the languages with word breakers on the system, and the best word segmentation rules available are used. The language need not be one of the app's supported languages. If there are no supported language rules available specifically for that language, the language-neutral rules are used (an implementation of [Unicode Standard Annex #29 Unicode Text Segmentation](http://go.microsoft.com/fwlink/p/?LinkId=325425)), and the [ResolvedLanguage](selectablewordssegmenter_resolvedlanguage.md) property is set to "und" (undetermined language). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.SelectableWordsSegmenter +-api-type: winrt class +--- + + + +# Windows.Data.Text.SelectableWordsSegmenter + +## -description +A segmenter class that is able to segment provided text into units appropriate for selecting text by words. + +The language supplied when this object is constructed is matched against the languages with word breakers on the system, and the best word segmentation rules available are used. The language need not be one of the app's supported languages. If there are no supported language rules available specifically for that language, the language-neutral rules are used (an implementation of [Unicode Standard Annex #29 Unicode Text Segmentation](http://go.microsoft.com/fwlink/p/?LinkId=325425)), and the [ResolvedLanguage](selectablewordssegmenter_resolvedlanguage.md) property is set to "und" (undetermined language). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordssegmenter_gettokenat_467343.md b/windows.data.text/selectablewordssegmenter_gettokenat_467343.md index 9080b0e3ac..3ff36f1db7 100644 --- a/windows.data.text/selectablewordssegmenter_gettokenat_467343.md +++ b/windows.data.text/selectablewordssegmenter_gettokenat_467343.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Text.SelectableWordsSegmenter.GetTokenAt(System.String,System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.SelectableWordsSegmenter.GetTokenAt ## -description Determines and returns the selectable word which contains or follows a specified index into the provided text. ## -parameters ### -param text Provided text in which a word is to be selected. ### -param startIndex A zero-based index into *text*. It must be less than the length of *text*. ## -returns A [SelectableWordSegment](selectablewordsegment.md) that represents the selected word. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SelectableWordsSegmenter.GetTokenAt(System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SelectableWordsSegmenter.GetTokenAt + +## -description +Determines and returns the selectable word which contains or follows a specified index into the provided text. + +## -parameters +### -param text +Provided text in which a word is to be selected. + +### -param startIndex +A zero-based index into *text*. It must be less than the length of *text*. + +## -returns +A [SelectableWordSegment](selectablewordsegment.md) that represents the selected word. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordssegmenter_gettokens_132398159.md b/windows.data.text/selectablewordssegmenter_gettokens_132398159.md index dae3798167..8a7ca38379 100644 --- a/windows.data.text/selectablewordssegmenter_gettokens_132398159.md +++ b/windows.data.text/selectablewordssegmenter_gettokens_132398159.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Text.SelectableWordsSegmenter.GetTokens(System.String) --api-type: winrt method ---- # Windows.Data.Text.SelectableWordsSegmenter.GetTokens ## -description Determines and returns all of the selectable words in the provided text. ## -parameters ### -param text Provided text containing words to be selected. ## -returns A collection of [SelectableWordSegment](selectablewordsegment.md) objects that represent the selectable words. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SelectableWordsSegmenter.GetTokens(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SelectableWordsSegmenter.GetTokens + +## -description +Determines and returns all of the selectable words in the provided text. + +## -parameters +### -param text +Provided text containing words to be selected. + +## -returns +A collection of [SelectableWordSegment](selectablewordsegment.md) objects that represent the selectable words. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordssegmenter_resolvedlanguage.md b/windows.data.text/selectablewordssegmenter_resolvedlanguage.md index 1636689ebf..de8849d2b8 100644 --- a/windows.data.text/selectablewordssegmenter_resolvedlanguage.md +++ b/windows.data.text/selectablewordssegmenter_resolvedlanguage.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Data.Text.SelectableWordsSegmenter.ResolvedLanguage --api-type: winrt property ---- # Windows.Data.Text.SelectableWordsSegmenter.ResolvedLanguage ## -description Gets the language of the rules used by this [SelectableWordsSegmenter](selectablewordssegmenter.md) object. "und" (undetermined) is returned if we are using language-neutral rules. ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the rules employed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.SelectableWordsSegmenter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Data.Text.SelectableWordsSegmenter.ResolvedLanguage + +## -description +Gets the language of the rules used by this [SelectableWordsSegmenter](selectablewordssegmenter.md) object. + +"und" (undetermined) is returned if we are using language-neutral rules. + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the rules employed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordssegmenter_selectablewordssegmenter_290278668.md b/windows.data.text/selectablewordssegmenter_selectablewordssegmenter_290278668.md index 5d7dd4e792..5cdeb50cf9 100644 --- a/windows.data.text/selectablewordssegmenter_selectablewordssegmenter_290278668.md +++ b/windows.data.text/selectablewordssegmenter_selectablewordssegmenter_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Text.SelectableWordsSegmenter.#ctor(System.String) --api-type: winrt method ---- # Windows.Data.Text.SelectableWordsSegmenter.SelectableWordsSegmenter ## -description Creates a [SelectableWordsSegmenter](selectablewordssegmenter.md) object. See the introduction in [SelectableWordsSegmenter](selectablewordssegmenter.md) for a description of how the language supplied to this constructor is used. ## -parameters ### -param language A [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SelectableWordsSegmenter.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SelectableWordsSegmenter.SelectableWordsSegmenter + +## -description +Creates a [SelectableWordsSegmenter](selectablewordssegmenter.md) object. See the introduction in [SelectableWordsSegmenter](selectablewordssegmenter.md) for a description of how the language supplied to this constructor is used. + +## -parameters +### -param language +A [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/selectablewordssegmenter_tokenize_561242729.md b/windows.data.text/selectablewordssegmenter_tokenize_561242729.md index bf371bacd9..aa4063861d 100644 --- a/windows.data.text/selectablewordssegmenter_tokenize_561242729.md +++ b/windows.data.text/selectablewordssegmenter_tokenize_561242729.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Data.Text.SelectableWordsSegmenter.Tokenize(System.String,System.UInt32,Windows.Data.Text.SelectableWordSegmentsTokenizingHandler) --api-type: winrt method ---- # Windows.Data.Text.SelectableWordsSegmenter.Tokenize ## -description Calls the provided handler with two iterators that iterate through the selectable words prior to and following a given index into the provided text. ## -parameters ### -param text Provided text containing words to be selected. ### -param startIndex A zero-based index into *text*. It must be less than the length of *text*. ### -param handler The function that receives the iterators. ## -remarks The iterators in [SelectableWordSegmentsTokenizingHandler](selectablewordsegmentstokenizinghandler.md) are lazy and evaluate small chunks of text at a time. The handler is called at most once per call to [Tokenize](selectablewordssegmenter_tokenize.md). The handler is not called if there are no selectable words in *text*. ## -examples ## -see-also [SelectableWordSegmentsTokenizingHandler](selectablewordsegmentstokenizinghandler.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SelectableWordsSegmenter.Tokenize(System.String,System.UInt32,Windows.Data.Text.SelectableWordSegmentsTokenizingHandler) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SelectableWordsSegmenter.Tokenize + +## -description +Calls the provided handler with two iterators that iterate through the selectable words prior to and following a given index into the provided text. + +## -parameters +### -param text +Provided text containing words to be selected. + +### -param startIndex +A zero-based index into *text*. It must be less than the length of *text*. + +### -param handler +The function that receives the iterators. + +## -remarks +The iterators in [SelectableWordSegmentsTokenizingHandler](selectablewordsegmentstokenizinghandler.md) are lazy and evaluate small chunks of text at a time. + +The handler is called at most once per call to [Tokenize](selectablewordssegmenter_tokenize.md). The handler is not called if there are no selectable words in *text*. + +## -examples + +## -see-also +[SelectableWordSegmentsTokenizingHandler](selectablewordsegmentstokenizinghandler.md) \ No newline at end of file diff --git a/windows.data.text/semantictextquery.md b/windows.data.text/semantictextquery.md index edfc28a363..704844b8c8 100644 --- a/windows.data.text/semantictextquery.md +++ b/windows.data.text/semantictextquery.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Data.Text.SemanticTextQuery --api-type: winrt class ---- # Windows.Data.Text.SemanticTextQuery ## -description Permits apps to perform text queries using Advanced Query Syntax (AQS) strings, with the option of providing a language tag to be employed in the query. ## -remarks ## -examples ## -see-also [Semantic text query sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620594) \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.SemanticTextQuery +-api-type: winrt class +--- + + + +# Windows.Data.Text.SemanticTextQuery + +## -description +Permits apps to perform text queries using Advanced Query Syntax (AQS) strings, with the option of providing a language tag to be employed in the query. + +## -remarks + +## -examples + +## -see-also +[Semantic text query sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620594) \ No newline at end of file diff --git a/windows.data.text/semantictextquery_find_1750099982.md b/windows.data.text/semantictextquery_find_1750099982.md index 46baed5048..322e6fdaba 100644 --- a/windows.data.text/semantictextquery_find_1750099982.md +++ b/windows.data.text/semantictextquery_find_1750099982.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Text.SemanticTextQuery.Find(System.String) --api-type: winrt method ---- # Windows.Data.Text.SemanticTextQuery.Find ## -description Returns segments of a source string that match the [SemanticTextQuery](semantictextquery.md) object's query. ## -parameters ### -param content A source string to be queried. ## -returns A collection of [TextSegment](textsegment.md) structures that represent hits from the query. ## -remarks ## -examples ## -see-also [Semantic text query sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620594) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SemanticTextQuery.Find(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SemanticTextQuery.Find + +## -description +Returns segments of a source string that match the [SemanticTextQuery](semantictextquery.md) object's query. + +## -parameters +### -param content +A source string to be queried. + +## -returns +A collection of [TextSegment](textsegment.md) structures that represent hits from the query. + +## -remarks + +## -examples + +## -see-also +[Semantic text query sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620594) \ No newline at end of file diff --git a/windows.data.text/semantictextquery_findinproperty_180827774.md b/windows.data.text/semantictextquery_findinproperty_180827774.md index c71f036c0c..fb0a5c6414 100644 --- a/windows.data.text/semantictextquery_findinproperty_180827774.md +++ b/windows.data.text/semantictextquery_findinproperty_180827774.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Text.SemanticTextQuery.FindInProperty(System.String,System.String) --api-type: winrt method ---- # Windows.Data.Text.SemanticTextQuery.FindInProperty ## -description Returns segments of a source string that match the [SemanticTextQuery](semantictextquery.md) object's query over properties. ## -parameters ### -param propertyContent A source string to be queried. ### -param propertyName The name of the property. ## -returns A collection of [TextSegment](textsegment.md) structures that represent hits from the query. ## -remarks ## -examples ## -see-also [Semantic text query sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620594) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SemanticTextQuery.FindInProperty(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SemanticTextQuery.FindInProperty + +## -description +Returns segments of a source string that match the [SemanticTextQuery](semantictextquery.md) object's query over properties. + +## -parameters +### -param propertyContent +A source string to be queried. + +### -param propertyName +The name of the property. + +## -returns +A collection of [TextSegment](textsegment.md) structures that represent hits from the query. + +## -remarks + +## -examples + +## -see-also +[Semantic text query sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620594) \ No newline at end of file diff --git a/windows.data.text/semantictextquery_semantictextquery_1571897524.md b/windows.data.text/semantictextquery_semantictextquery_1571897524.md index bf238f7b6b..9667c08563 100644 --- a/windows.data.text/semantictextquery_semantictextquery_1571897524.md +++ b/windows.data.text/semantictextquery_semantictextquery_1571897524.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Text.SemanticTextQuery.#ctor(System.String,System.String) --api-type: winrt method ---- # Windows.Data.Text.SemanticTextQuery.SemanticTextQuery ## -description Creates a [SemanticTextQuery](semantictextquery.md) from an Advanced Query Syntax (AQS) query string and a language tag. ## -parameters ### -param aqsFilter An Advanced Query Syntax (AQS) string that contains the desired query. Learn more about Advanced Query Syntax (AQS) in [](http://msdn.microsoft.com/library/8e55bd40-c7cf-44a6-bc18-24bc7a267779). ### -param filterLanguage The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag to be employed in the query. To see a list of the language tags specifically supported by the Windows Store, see [Choosing your languages](http://msdn.microsoft.com/library/fca66311-4145-46ac-8b20-1e736f940976). ## -remarks *filterLanguage* permits queries to work with language differences. For example, if *aqsFilter* is "19,5" and *filterLanguage* is "pl" (Polish), a call to [Find](semantictextquery_find.md) against text that includes "19.5" returns a text segment because it is understood that the comma is the decimal separator in Polish. ## -examples ## -see-also [SemanticTextQuery(String)](semantictextquery_semantictextquery_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SemanticTextQuery.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SemanticTextQuery.SemanticTextQuery + +## -description +Creates a [SemanticTextQuery](semantictextquery.md) from an Advanced Query Syntax (AQS) query string and a language tag. + +## -parameters +### -param aqsFilter +An Advanced Query Syntax (AQS) string that contains the desired query. Learn more about Advanced Query Syntax (AQS) in [](http://msdn.microsoft.com/library/8e55bd40-c7cf-44a6-bc18-24bc7a267779). + +### -param filterLanguage +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag to be employed in the query. + +To see a list of the language tags specifically supported by the Windows Store, see [Choosing your languages](http://msdn.microsoft.com/library/fca66311-4145-46ac-8b20-1e736f940976). + +## -remarks +*filterLanguage* permits queries to work with language differences. For example, if *aqsFilter* is "19,5" and *filterLanguage* is "pl" (Polish), a call to [Find](semantictextquery_find.md) against text that includes "19.5" returns a text segment because it is understood that the comma is the decimal separator in Polish. + +## -examples + +## -see-also +[SemanticTextQuery(String)](semantictextquery_semantictextquery_290278668.md) \ No newline at end of file diff --git a/windows.data.text/semantictextquery_semantictextquery_290278668.md b/windows.data.text/semantictextquery_semantictextquery_290278668.md index a86232efd9..7dd1f77060 100644 --- a/windows.data.text/semantictextquery_semantictextquery_290278668.md +++ b/windows.data.text/semantictextquery_semantictextquery_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Data.Text.SemanticTextQuery.#ctor(System.String) --api-type: winrt method ---- # Windows.Data.Text.SemanticTextQuery.SemanticTextQuery ## -description Creates a [SemanticTextQuery](semantictextquery.md) from an Advanced Query Syntax (AQS) query string. ## -parameters ### -param aqsFilter An Advanced Query Syntax (AQS) string that contains the desired query. Learn more about Advanced Query Syntax (AQS) in [](http://msdn.microsoft.com/library/8e55bd40-c7cf-44a6-bc18-24bc7a267779). ## -remarks ## -examples ## -see-also [SemanticTextQuery(String, String)](semantictextquery_semantictextquery_1571897524.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.SemanticTextQuery.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.SemanticTextQuery.SemanticTextQuery + +## -description +Creates a [SemanticTextQuery](semantictextquery.md) from an Advanced Query Syntax (AQS) query string. + +## -parameters +### -param aqsFilter +An Advanced Query Syntax (AQS) string that contains the desired query. Learn more about Advanced Query Syntax (AQS) in [](http://msdn.microsoft.com/library/8e55bd40-c7cf-44a6-bc18-24bc7a267779). + +## -remarks + +## -examples + +## -see-also +[SemanticTextQuery(String, String)](semantictextquery_semantictextquery_1571897524.md) \ No newline at end of file diff --git a/windows.data.text/textconversiongenerator.md b/windows.data.text/textconversiongenerator.md index c55229c343..9d8e49c61c 100644 --- a/windows.data.text/textconversiongenerator.md +++ b/windows.data.text/textconversiongenerator.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Data.Text.TextConversionGenerator --api-type: winrt class ---- # Windows.Data.Text.TextConversionGenerator ## -description Converts input phonetic characters into a collection of corresponding ideographic characters (Chinese characters). Input of Japanese and Chinese Pinyin is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.TextConversionGenerator +-api-type: winrt class +--- + + + +# Windows.Data.Text.TextConversionGenerator + +## -description +Converts input phonetic characters into a collection of corresponding ideographic characters (Chinese characters). + +Input of Japanese and Chinese Pinyin is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textconversiongenerator_getcandidatesasync_1095978545.md b/windows.data.text/textconversiongenerator_getcandidatesasync_1095978545.md index cf75f67fee..c45a6a8aed 100644 --- a/windows.data.text/textconversiongenerator_getcandidatesasync_1095978545.md +++ b/windows.data.text/textconversiongenerator_getcandidatesasync_1095978545.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync ## -description Asynchronously gets a list of candidate words based on the provided phonetic characters. ## -parameters ### -param input The phonetic characters of the words to be returned. ## -returns An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of candidate words. ## -remarks ## -examples ## -see-also [GetCandidatesAsync(String, UInt32)](textconversiongenerator_getcandidatesasync_1185174467.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync + +## -description +Asynchronously gets a list of candidate words based on the provided phonetic characters. + +## -parameters +### -param input +The phonetic characters of the words to be returned. + +## -returns +An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of candidate words. + +## -remarks + +## -examples + +## -see-also +[GetCandidatesAsync(String, UInt32)](textconversiongenerator_getcandidatesasync_1185174467.md) \ No newline at end of file diff --git a/windows.data.text/textconversiongenerator_getcandidatesasync_1185174467.md b/windows.data.text/textconversiongenerator_getcandidatesasync_1185174467.md index 50cb604595..4a8b8d88ad 100644 --- a/windows.data.text/textconversiongenerator_getcandidatesasync_1185174467.md +++ b/windows.data.text/textconversiongenerator_getcandidatesasync_1185174467.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync(System.String,System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync ## -description Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters. ## -parameters ### -param input The phonetic characters of the words to be returned. ### -param maxCandidates The maximum number of candidate words to return. ## -returns An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of candidate words. ## -remarks ## -examples ## -see-also [GetCandidatesAsync(String)](textconversiongenerator_getcandidatesasync_1095978545.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync(System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextConversionGenerator.GetCandidatesAsync + +## -description +Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters. + +## -parameters +### -param input +The phonetic characters of the words to be returned. + +### -param maxCandidates +The maximum number of candidate words to return. + +## -returns +An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of candidate words. + +## -remarks + +## -examples + +## -see-also +[GetCandidatesAsync(String)](textconversiongenerator_getcandidatesasync_1095978545.md) \ No newline at end of file diff --git a/windows.data.text/textconversiongenerator_languageavailablebutnotinstalled.md b/windows.data.text/textconversiongenerator_languageavailablebutnotinstalled.md index c800319204..e71c29eaf8 100644 --- a/windows.data.text/textconversiongenerator_languageavailablebutnotinstalled.md +++ b/windows.data.text/textconversiongenerator_languageavailablebutnotinstalled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextConversionGenerator.LanguageAvailableButNotInstalled --api-type: winrt property ---- # Windows.Data.Text.TextConversionGenerator.LanguageAvailableButNotInstalled ## -description Determines if the language tag specified is available for conversions, but is not installed on the user's device. ## -property-value **true** if the language is available but not installed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextConversionGenerator.LanguageAvailableButNotInstalled +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextConversionGenerator.LanguageAvailableButNotInstalled + +## -description +Determines if the language tag specified is available for conversions, but is not installed on the user's device. + +## -property-value +**true** if the language is available but not installed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textconversiongenerator_resolvedlanguage.md b/windows.data.text/textconversiongenerator_resolvedlanguage.md index 3a0d3b1ee1..5bec3551a7 100644 --- a/windows.data.text/textconversiongenerator_resolvedlanguage.md +++ b/windows.data.text/textconversiongenerator_resolvedlanguage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextConversionGenerator.ResolvedLanguage --api-type: winrt property ---- # Windows.Data.Text.TextConversionGenerator.ResolvedLanguage ## -description Gets the language tag of the successfully created [TextConversionGenerator](textconversiongenerator.md) object. ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the conversion generator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextConversionGenerator.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextConversionGenerator.ResolvedLanguage + +## -description +Gets the language tag of the successfully created [TextConversionGenerator](textconversiongenerator.md) object. + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the conversion generator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textconversiongenerator_textconversiongenerator_290278668.md b/windows.data.text/textconversiongenerator_textconversiongenerator_290278668.md index b3144bf1f2..db987997b7 100644 --- a/windows.data.text/textconversiongenerator_textconversiongenerator_290278668.md +++ b/windows.data.text/textconversiongenerator_textconversiongenerator_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Text.TextConversionGenerator.#ctor(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextConversionGenerator.TextConversionGenerator ## -description Constructs a [TextConversionGenerator](textconversiongenerator.md) object based on a specific [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. ## -parameters ### -param languageTag The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the language in which the words are to be projected. Japanese ("ja") and Simplified Chinese ("zh-Hans") are supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextConversionGenerator.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextConversionGenerator.TextConversionGenerator + +## -description +Constructs a [TextConversionGenerator](textconversiongenerator.md) object based on a specific [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. + +## -parameters +### -param languageTag +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the language in which the words are to be projected. Japanese ("ja") and Simplified Chinese ("zh-Hans") are supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textphoneme.md b/windows.data.text/textphoneme.md index ddca04e5ad..7570993d76 100644 --- a/windows.data.text/textphoneme.md +++ b/windows.data.text/textphoneme.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Data.Text.TextPhoneme --api-type: winrt class ---- # Windows.Data.Text.TextPhoneme ## -description Represents the result of calling the [TextReverseConversionGenerator.GetPhonemesAsync](textreverseconversiongenerator_getphonemesasync.md) method, encapsulating both the original display text and the phonemes that match the original display text. ## -remarks Your code does not instantiate objects of this class. Rather, objects are instantiated and returned to you as the output of the [TextReverseConversionGenerator.GetPhonemesAsync](textreverseconversiongenerator_getphonemesasync.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.TextPhoneme +-api-type: winrt class +--- + + + +# Windows.Data.Text.TextPhoneme + +## -description +Represents the result of calling the [TextReverseConversionGenerator.GetPhonemesAsync](textreverseconversiongenerator_getphonemesasync.md) method, encapsulating both the original display text and the phonemes that match the original display text. + +## -remarks +Your code does not instantiate objects of this class. Rather, objects are instantiated and returned to you as the output of the [TextReverseConversionGenerator.GetPhonemesAsync](textreverseconversiongenerator_getphonemesasync.md) method. + +## -examples + +## -see-also diff --git a/windows.data.text/textphoneme_displaytext.md b/windows.data.text/textphoneme_displaytext.md index f6a74e2abd..c71d19dcea 100644 --- a/windows.data.text/textphoneme_displaytext.md +++ b/windows.data.text/textphoneme_displaytext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextPhoneme.DisplayText --api-type: winrt property ---- # Windows.Data.Text.TextPhoneme.DisplayText ## -description Gets the display text for a Japanese phoneme. ## -property-value The display text as originally passed to [TextReverseConversionGenerator.GetPhonemesAsync](textreverseconversiongenerator_getphonemesasync.md). In the typical use case of passing a Japanese sentence to that method, the display text is one phonetic part of the sentence in Kanji or a mix of Kanji and phonetic characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextPhoneme.DisplayText +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextPhoneme.DisplayText + +## -description +Gets the display text for a Japanese phoneme. + +## -property-value +The display text as originally passed to [TextReverseConversionGenerator.GetPhonemesAsync](textreverseconversiongenerator_getphonemesasync.md). In the typical use case of passing a Japanese sentence to that method, the display text is one phonetic part of the sentence in Kanji or a mix of Kanji and phonetic characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textphoneme_readingtext.md b/windows.data.text/textphoneme_readingtext.md index e95fd7bf14..aa04067f1a 100644 --- a/windows.data.text/textphoneme_readingtext.md +++ b/windows.data.text/textphoneme_readingtext.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Data.Text.TextPhoneme.ReadingText --api-type: winrt property ---- # Windows.Data.Text.TextPhoneme.ReadingText ## -description Gets the phonetic reading of the [DisplayText](textphoneme_displaytext.md), with Japanese characters in Hiragana. ## -property-value The reading of the [DisplayText](textphoneme_displaytext.md), with Japanese characters in Hiragana. For an example, for the input string "今日はいい天気", the display texts are '"今日", "は", "いい", "天気"' and the corresponding reading texts are "きょう", "は", "いい", "てんき". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextPhoneme.ReadingText +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextPhoneme.ReadingText + +## -description +Gets the phonetic reading of the [DisplayText](textphoneme_displaytext.md), with Japanese characters in Hiragana. + +## -property-value +The reading of the [DisplayText](textphoneme_displaytext.md), with Japanese characters in Hiragana. + +For an example, for the input string "今日はいい天気", the display texts are '"今日", "は", "いい", "天気"' and the corresponding reading texts are "きょう", "は", "いい", "てんき". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textpredictiongenerator.md b/windows.data.text/textpredictiongenerator.md index 85fa701fe9..1896f69d09 100644 --- a/windows.data.text/textpredictiongenerator.md +++ b/windows.data.text/textpredictiongenerator.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Data.Text.TextPredictionGenerator --api-type: winrt class ---- # Windows.Data.Text.TextPredictionGenerator ## -description Predicts Japanese words based on a phonetic characters prefix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.TextPredictionGenerator +-api-type: winrt class +--- + + + +# Windows.Data.Text.TextPredictionGenerator + +## -description +Predicts Japanese words based on a phonetic characters prefix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textpredictiongenerator_getcandidatesasync_1095978545.md b/windows.data.text/textpredictiongenerator_getcandidatesasync_1095978545.md index 848c2ce960..924085a969 100644 --- a/windows.data.text/textpredictiongenerator_getcandidatesasync_1095978545.md +++ b/windows.data.text/textpredictiongenerator_getcandidatesasync_1095978545.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync ## -description Asynchronously gets a list of candidate words based on the provided phonetic characters prefix. ## -parameters ### -param input The beginning phonetic characters of the words to be returned. ## -returns An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of predicted words. ## -remarks ## -examples ## -see-also [GetCandidatesAsync(String, UInt32)](textpredictiongenerator_getcandidatesasync_1185174467.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync + +## -description +Asynchronously gets a list of candidate words based on the provided phonetic characters prefix. + +## -parameters +### -param input +The beginning phonetic characters of the words to be returned. + +## -returns +An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of predicted words. + +## -remarks + +## -examples + +## -see-also +[GetCandidatesAsync(String, UInt32)](textpredictiongenerator_getcandidatesasync_1185174467.md) \ No newline at end of file diff --git a/windows.data.text/textpredictiongenerator_getcandidatesasync_1185174467.md b/windows.data.text/textpredictiongenerator_getcandidatesasync_1185174467.md index 6e42f67528..400938526d 100644 --- a/windows.data.text/textpredictiongenerator_getcandidatesasync_1185174467.md +++ b/windows.data.text/textpredictiongenerator_getcandidatesasync_1185174467.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync(System.String,System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync ## -description Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix. ## -parameters ### -param input The beginning phonetic characters of the words to be returned. ### -param maxCandidates The maximum number of predicted words to return. ## -returns An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of predicted words. ## -remarks ## -examples ## -see-also [GetCandidatesAsync(String)](textpredictiongenerator_getcandidatesasync_1095978545.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync(System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextPredictionGenerator.GetCandidatesAsync + +## -description +Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix. + +## -parameters +### -param input +The beginning phonetic characters of the words to be returned. + +### -param maxCandidates +The maximum number of predicted words to return. + +## -returns +An asynchronous operation to return an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of the list of predicted words. + +## -remarks + +## -examples + +## -see-also +[GetCandidatesAsync(String)](textpredictiongenerator_getcandidatesasync_1095978545.md) \ No newline at end of file diff --git a/windows.data.text/textpredictiongenerator_languageavailablebutnotinstalled.md b/windows.data.text/textpredictiongenerator_languageavailablebutnotinstalled.md index 4f3e04904a..1751e7fb26 100644 --- a/windows.data.text/textpredictiongenerator_languageavailablebutnotinstalled.md +++ b/windows.data.text/textpredictiongenerator_languageavailablebutnotinstalled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextPredictionGenerator.LanguageAvailableButNotInstalled --api-type: winrt property ---- # Windows.Data.Text.TextPredictionGenerator.LanguageAvailableButNotInstalled ## -description Determines if the language tag specified is available for generating predictions, but is not installed on the user's device. ## -property-value **true** if the language is available but not installed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextPredictionGenerator.LanguageAvailableButNotInstalled +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextPredictionGenerator.LanguageAvailableButNotInstalled + +## -description +Determines if the language tag specified is available for generating predictions, but is not installed on the user's device. + +## -property-value +**true** if the language is available but not installed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textpredictiongenerator_resolvedlanguage.md b/windows.data.text/textpredictiongenerator_resolvedlanguage.md index 76e2e5bb22..27f6e7cfef 100644 --- a/windows.data.text/textpredictiongenerator_resolvedlanguage.md +++ b/windows.data.text/textpredictiongenerator_resolvedlanguage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextPredictionGenerator.ResolvedLanguage --api-type: winrt property ---- # Windows.Data.Text.TextPredictionGenerator.ResolvedLanguage ## -description Gets the language tag of the successfully created [TextPredictionGenerator](textpredictiongenerator.md) object. ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the prediction generator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextPredictionGenerator.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextPredictionGenerator.ResolvedLanguage + +## -description +Gets the language tag of the successfully created [TextPredictionGenerator](textpredictiongenerator.md) object. + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the prediction generator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textpredictiongenerator_textpredictiongenerator_290278668.md b/windows.data.text/textpredictiongenerator_textpredictiongenerator_290278668.md index 72457d83c7..cbb8364de7 100644 --- a/windows.data.text/textpredictiongenerator_textpredictiongenerator_290278668.md +++ b/windows.data.text/textpredictiongenerator_textpredictiongenerator_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Text.TextPredictionGenerator.#ctor(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextPredictionGenerator.TextPredictionGenerator ## -description Constructs a [TextPredictionGenerator](textpredictiongenerator.md) object based on a specific [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. ## -parameters ### -param languageTag The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the language in which the words are to be projected. Only Japanese ("ja") is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextPredictionGenerator.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextPredictionGenerator.TextPredictionGenerator + +## -description +Constructs a [TextPredictionGenerator](textpredictiongenerator.md) object based on a specific [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. + +## -parameters +### -param languageTag +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the language in which the words are to be projected. Only Japanese ("ja") is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textreverseconversiongenerator.md b/windows.data.text/textreverseconversiongenerator.md index 43866deeee..6d98bcdfe7 100644 --- a/windows.data.text/textreverseconversiongenerator.md +++ b/windows.data.text/textreverseconversiongenerator.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Data.Text.TextReverseConversionGenerator --api-type: winrt class ---- # Windows.Data.Text.TextReverseConversionGenerator ## -description Reverse-converts a Japanese string which is mix of phonetic and ideographic characters, to a string of phonetic characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.TextReverseConversionGenerator +-api-type: winrt class +--- + + + +# Windows.Data.Text.TextReverseConversionGenerator + +## -description +Reverse-converts a Japanese string which is mix of phonetic and ideographic characters, to a string of phonetic characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textreverseconversiongenerator_convertbackasync_1530060465.md b/windows.data.text/textreverseconversiongenerator_convertbackasync_1530060465.md index 8980320e8a..635a46a470 100644 --- a/windows.data.text/textreverseconversiongenerator_convertbackasync_1530060465.md +++ b/windows.data.text/textreverseconversiongenerator_convertbackasync_1530060465.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Text.TextReverseConversionGenerator.ConvertBackAsync(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextReverseConversionGenerator.ConvertBackAsync ## -description Asynchronously reverse-converts a string which contains ideographic characters to a phonetic expression. ## -parameters ### -param input The string containing ideographic characters to be reverse-converted. ## -returns An asynchronous operation to return the phonetic expression. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextReverseConversionGenerator.ConvertBackAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextReverseConversionGenerator.ConvertBackAsync + +## -description +Asynchronously reverse-converts a string which contains ideographic characters to a phonetic expression. + +## -parameters +### -param input +The string containing ideographic characters to be reverse-converted. + +## -returns +An asynchronous operation to return the phonetic expression. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textreverseconversiongenerator_getphonemesasync_395544774.md b/windows.data.text/textreverseconversiongenerator_getphonemesasync_395544774.md index 2d3741bb24..3bfd5844a1 100644 --- a/windows.data.text/textreverseconversiongenerator_getphonemesasync_395544774.md +++ b/windows.data.text/textreverseconversiongenerator_getphonemesasync_395544774.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Data.Text.TextReverseConversionGenerator.GetPhonemesAsync(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextReverseConversionGenerator.GetPhonemesAsync ## -description Returns a set of phonemes representing the given input string. This method is primarily intended for use in sorting data in the Japanese language. Phonetic reading is important for Japanese data handling, especially to sort names in proper phonetic order rather than in character code point order. Proper names in Japanese that sound the same when pronounced can be spelled in different ways in Kanji. The point of sorting by phonemes is to sort all of the different Kanji spellings of a given proper name to be next to each other in a sorted list, rather than sorting them by character code point and having the various spellings not sorting next to each other. ## -parameters ### -param input A string containing words in Japanese. ## -returns On successful completion of the async operation, a list of [TextPhoneme](textphoneme.md) objects representing the input string in phoneme form. ## -remarks Each [TextPhoneme](textphoneme.md) in the result list has the following properties. + The [DisplayText](textphoneme_displaytext.md) always matches a segment of the input string. + For Japanese input, the [ReadingText](textphoneme_readingtext.md) is the Hiragana-based reading of the display text. + If the system cannot generate a reading, then it reports the [ReadingText](textphoneme_readingtext.md) as being the same as the [DisplayText](textphoneme_displaytext.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextReverseConversionGenerator.GetPhonemesAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextReverseConversionGenerator.GetPhonemesAsync + +## -description +Returns a set of phonemes representing the given input string. This method is primarily intended for use in sorting data in the Japanese language. Phonetic reading is important for Japanese data handling, especially to sort names in proper phonetic order rather than in character code point order. + +Proper names in Japanese that sound the same when pronounced can be spelled in different ways in Kanji. The point of sorting by phonemes is to sort all of the different Kanji spellings of a given proper name to be next to each other in a sorted list, rather than sorting them by character code point and having the various spellings not sorting next to each other. + +## -parameters +### -param input +A string containing words in Japanese. + +## -returns +On successful completion of the async operation, a list of [TextPhoneme](textphoneme.md) objects representing the input string in phoneme form. + +## -remarks + +Each [TextPhoneme](textphoneme.md) in the result list has the following properties. + ++ The [DisplayText](textphoneme_displaytext.md) always matches a segment of the input string. ++ For Japanese input, the [ReadingText](textphoneme_readingtext.md) is the Hiragana-based reading of the display text. ++ If the system cannot generate a reading, then it reports the [ReadingText](textphoneme_readingtext.md) as being the same as the [DisplayText](textphoneme_displaytext.md). + + +## -examples + +## -see-also diff --git a/windows.data.text/textreverseconversiongenerator_languageavailablebutnotinstalled.md b/windows.data.text/textreverseconversiongenerator_languageavailablebutnotinstalled.md index 683003c181..be4fbf9fa2 100644 --- a/windows.data.text/textreverseconversiongenerator_languageavailablebutnotinstalled.md +++ b/windows.data.text/textreverseconversiongenerator_languageavailablebutnotinstalled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextReverseConversionGenerator.LanguageAvailableButNotInstalled --api-type: winrt property ---- # Windows.Data.Text.TextReverseConversionGenerator.LanguageAvailableButNotInstalled ## -description Determines if the language tag specified is available for reverse conversions, but is not installed on the user's device. ## -property-value **true** if the language is available but not installed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextReverseConversionGenerator.LanguageAvailableButNotInstalled +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextReverseConversionGenerator.LanguageAvailableButNotInstalled + +## -description +Determines if the language tag specified is available for reverse conversions, but is not installed on the user's device. + +## -property-value +**true** if the language is available but not installed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textreverseconversiongenerator_resolvedlanguage.md b/windows.data.text/textreverseconversiongenerator_resolvedlanguage.md index 51606634f6..d1417b9807 100644 --- a/windows.data.text/textreverseconversiongenerator_resolvedlanguage.md +++ b/windows.data.text/textreverseconversiongenerator_resolvedlanguage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.TextReverseConversionGenerator.ResolvedLanguage --api-type: winrt property ---- # Windows.Data.Text.TextReverseConversionGenerator.ResolvedLanguage ## -description Gets the language tag of the successfully created [TextReverseConversionGenerator](textreverseconversiongenerator.md) object. ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the reverse conversion generator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.TextReverseConversionGenerator.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Data.Text.TextReverseConversionGenerator.ResolvedLanguage + +## -description +Gets the language tag of the successfully created [TextReverseConversionGenerator](textreverseconversiongenerator.md) object. + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the reverse conversion generator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/textreverseconversiongenerator_textreverseconversiongenerator_290278668.md b/windows.data.text/textreverseconversiongenerator_textreverseconversiongenerator_290278668.md index d5600eb61d..4937d49029 100644 --- a/windows.data.text/textreverseconversiongenerator_textreverseconversiongenerator_290278668.md +++ b/windows.data.text/textreverseconversiongenerator_textreverseconversiongenerator_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Text.TextReverseConversionGenerator.#ctor(System.String) --api-type: winrt method ---- # Windows.Data.Text.TextReverseConversionGenerator.TextReverseConversionGenerator ## -description Constructs a [TextReverseConversionGenerator](textreverseconversiongenerator.md) object based on a specific [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. ## -parameters ### -param languageTag The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the language in which the words are to be reverse-converted. Only Japanese ("ja") is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.TextReverseConversionGenerator.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.TextReverseConversionGenerator.TextReverseConversionGenerator + +## -description +Constructs a [TextReverseConversionGenerator](textreverseconversiongenerator.md) object based on a specific [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. + +## -parameters +### -param languageTag +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the language in which the words are to be reverse-converted. Only Japanese ("ja") is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/unicodecharacters.md b/windows.data.text/unicodecharacters.md index 7e88ec912d..b396117ba0 100644 --- a/windows.data.text/unicodecharacters.md +++ b/windows.data.text/unicodecharacters.md @@ -1,3 +1,34 @@ ---- -api-id: T:Windows.Data.Text.UnicodeCharacters --api-type: winrt class ---- # Windows.Data.Text.UnicodeCharacters ## -description Provides a way for apps to get information about Unicode characters, per the [Unicode Standard Annex #44](http://go.microsoft.com/fwlink/p/?LinkId=302088). ## -remarks Use [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) to prepare Unicode characters before you pass them to any of the other methods of this class, in order to properly process supplementary characters. See [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) for a discussion of supplementary Unicode characters. The normal procedure for processing the code points in a stream is to: 1. Use [IsHighSurrogate](unicodecharacters_ishighsurrogate.md) to determine if a code point is a high surrogate. 1. If it is not, pass it to the desired method of [UnicodeCharacters](unicodecharacters.md). 1. Else the code point is a high surrogate:1. Use [IsLowSurrogate](unicodecharacters_islowsurrogate.md) to check the next code point in the stream to determine if it is a low surrogate. 1. If it is not, you have an invalid sequence of code points. 1. Else the second code point is a low surrogate. Pass the high and low pair to [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) to obtain the supplementary Unicode character that can be passed on to the desired method. The methods in this class throw an invalid argument exception if the input is not a valid codepoint. ## -examples ## -see-also [Unicode string processing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620614) \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.UnicodeCharacters +-api-type: winrt class +--- + + + +# Windows.Data.Text.UnicodeCharacters + +## -description +Provides a way for apps to get information about Unicode characters, per the [Unicode Standard Annex #44](http://go.microsoft.com/fwlink/p/?LinkId=302088). + +## -remarks +Use [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) to prepare Unicode characters before you pass them to any of the other methods of this class, in order to properly process supplementary characters. See [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) for a discussion of supplementary Unicode characters. + + +The normal procedure for processing the code points in a stream is to: + +1. Use [IsHighSurrogate](unicodecharacters_ishighsurrogate.md) to determine if a code point is a high surrogate. +1. If it is not, pass it to the desired method of [UnicodeCharacters](unicodecharacters.md). +1. Else the code point is a high surrogate:1. Use [IsLowSurrogate](unicodecharacters_islowsurrogate.md) to check the next code point in the stream to determine if it is a low surrogate. +1. If it is not, you have an invalid sequence of code points. +1. Else the second code point is a low surrogate. Pass the high and low pair to [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) to obtain the supplementary Unicode character that can be passed on to the desired method. + + + +The methods in this class throw an invalid argument exception if the input is not a valid codepoint. + +## -examples + +## -see-also +[Unicode string processing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620614) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_getcodepointfromsurrogatepair_1886831018.md b/windows.data.text/unicodecharacters_getcodepointfromsurrogatepair_1886831018.md index 5911ba0caf..5d66f58cd6 100644 --- a/windows.data.text/unicodecharacters_getcodepointfromsurrogatepair_1886831018.md +++ b/windows.data.text/unicodecharacters_getcodepointfromsurrogatepair_1886831018.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.GetCodepointFromSurrogatePair(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.GetCodepointFromSurrogatePair ## -description Returns the supplementary Unicode character for the specified high and low surrogate pair. ## -parameters ### -param highSurrogate The high surrogate value. This must be in the proper range: 0xD800 <= *highSurrogate* <= 0xDBFF. ### -param lowSurrogate The low surrogate value. This must be in the proper range: 0xDC00 <= *lowSurrogate* <= 0xDFFF. ## -returns The supplementary Unicode character. ## -remarks ## -examples ## -see-also [GetSurrogatePairFromCodepoint](unicodecharacters_getsurrogatepairfromcodepoint.md), [IsHighSurrogate](unicodecharacters_ishighsurrogate.md), [IsLowSurrogate](unicodecharacters_islowsurrogate.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.GetCodepointFromSurrogatePair(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.GetCodepointFromSurrogatePair + +## -description +Returns the supplementary Unicode character for the specified high and low surrogate pair. + +## -parameters +### -param highSurrogate +The high surrogate value. This must be in the proper range: 0xD800 <= *highSurrogate* <= 0xDBFF. + +### -param lowSurrogate +The low surrogate value. This must be in the proper range: 0xDC00 <= *lowSurrogate* <= 0xDFFF. + +## -returns +The supplementary Unicode character. + +## -remarks + + +## -examples + +## -see-also +[GetSurrogatePairFromCodepoint](unicodecharacters_getsurrogatepairfromcodepoint.md), [IsHighSurrogate](unicodecharacters_ishighsurrogate.md), [IsLowSurrogate](unicodecharacters_islowsurrogate.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_getgeneralcategory_1785789586.md b/windows.data.text/unicodecharacters_getgeneralcategory_1785789586.md index 26a6f12cb3..3be5e8e45b 100644 --- a/windows.data.text/unicodecharacters_getgeneralcategory_1785789586.md +++ b/windows.data.text/unicodecharacters_getgeneralcategory_1785789586.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.GetGeneralCategory(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.GetGeneralCategory ## -description Returns the [UnicodeGeneralCategory](unicodegeneralcategory.md) of the specified Unicode character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns The Unicode general category for *codepoint*. ## -remarks ## -examples ## -see-also [UnicodeGeneralCategory](unicodegeneralcategory.md), [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.GetGeneralCategory(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.GetGeneralCategory + +## -description +Returns the [UnicodeGeneralCategory](unicodegeneralcategory.md) of the specified Unicode character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +The Unicode general category for *codepoint*. + +## -remarks + + +## -examples + +## -see-also +[UnicodeGeneralCategory](unicodegeneralcategory.md), [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_getnumerictype_1735068207.md b/windows.data.text/unicodecharacters_getnumerictype_1735068207.md index 0df449dbd0..405ebd6b33 100644 --- a/windows.data.text/unicodecharacters_getnumerictype_1735068207.md +++ b/windows.data.text/unicodecharacters_getnumerictype_1735068207.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.GetNumericType(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.GetNumericType ## -description Returns the [UnicodeNumericType](unicodenumerictype.md) of the specified Unicode character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns The Unicode numeric type for *codepoint*. ## -remarks ## -examples ## -see-also [UnicodeNumericType](unicodenumerictype.md), [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.GetNumericType(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.GetNumericType + +## -description +Returns the [UnicodeNumericType](unicodenumerictype.md) of the specified Unicode character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +The Unicode numeric type for *codepoint*. + +## -remarks + + +## -examples + +## -see-also +[UnicodeNumericType](unicodenumerictype.md), [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_getsurrogatepairfromcodepoint_381440991.md b/windows.data.text/unicodecharacters_getsurrogatepairfromcodepoint_381440991.md index 6551fc7944..6dea7310b0 100644 --- a/windows.data.text/unicodecharacters_getsurrogatepairfromcodepoint_381440991.md +++ b/windows.data.text/unicodecharacters_getsurrogatepairfromcodepoint_381440991.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.GetSurrogatePairFromCodepoint(System.UInt32,System.Char@,System.Char@) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.GetSurrogatePairFromCodepoint ## -description Returns the high and low surrogate pair values for the specified supplementary Unicode character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ### -param highSurrogate The high surrogate value returned. ### -param lowSurrogate The low surrogate value returned. ## -remarks See [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) for a discussion of supplementary Unicode characters. ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.GetSurrogatePairFromCodepoint(System.UInt32,System.Char@,System.Char@) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.GetSurrogatePairFromCodepoint + +## -description +Returns the high and low surrogate pair values for the specified supplementary Unicode character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +### -param highSurrogate +The high surrogate value returned. + +### -param lowSurrogate +The low surrogate value returned. + +## -remarks +See [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) for a discussion of supplementary Unicode characters. + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isalphabetic_1523219215.md b/windows.data.text/unicodecharacters_isalphabetic_1523219215.md index 71d6848177..4fb77438ba 100644 --- a/windows.data.text/unicodecharacters_isalphabetic_1523219215.md +++ b/windows.data.text/unicodecharacters_isalphabetic_1523219215.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsAlphabetic(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsAlphabetic ## -description Determines if a specified Unicode character can be considered alphabetic. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is alphabetic; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsAlphabetic(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsAlphabetic + +## -description +Determines if a specified Unicode character can be considered alphabetic. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is alphabetic; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_iscased_545276236.md b/windows.data.text/unicodecharacters_iscased_545276236.md index 7c5cef738d..a16659df2b 100644 --- a/windows.data.text/unicodecharacters_iscased_545276236.md +++ b/windows.data.text/unicodecharacters_iscased_545276236.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsCased(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsCased ## -description Determines if a specified Unicode character can be considered cased (uppercase, lowercase or titlecase). ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is cased; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsCased(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsCased + +## -description +Determines if a specified Unicode character can be considered cased (uppercase, lowercase or titlecase). + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is cased; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isgraphemebase_1245235484.md b/windows.data.text/unicodecharacters_isgraphemebase_1245235484.md index a1052f9e90..6ecd953192 100644 --- a/windows.data.text/unicodecharacters_isgraphemebase_1245235484.md +++ b/windows.data.text/unicodecharacters_isgraphemebase_1245235484.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsGraphemeBase(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsGraphemeBase ## -description Determines if a specified Unicode character can be considered the beginning of a grapheme. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is the beginning of a grapheme; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsGraphemeBase(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsGraphemeBase + +## -description +Determines if a specified Unicode character can be considered the beginning of a grapheme. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is the beginning of a grapheme; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isgraphemeextend_2001005979.md b/windows.data.text/unicodecharacters_isgraphemeextend_2001005979.md index dfed739d36..0d95d40452 100644 --- a/windows.data.text/unicodecharacters_isgraphemeextend_2001005979.md +++ b/windows.data.text/unicodecharacters_isgraphemeextend_2001005979.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsGraphemeExtend(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsGraphemeExtend ## -description Determines if a specified Unicode character can be considered to continue a previous grapheme. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* continues the previous grapheme; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsGraphemeExtend(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsGraphemeExtend + +## -description +Determines if a specified Unicode character can be considered to continue a previous grapheme. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* continues the previous grapheme; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_ishighsurrogate_1444937275.md b/windows.data.text/unicodecharacters_ishighsurrogate_1444937275.md index 69d030879a..e4c5052e51 100644 --- a/windows.data.text/unicodecharacters_ishighsurrogate_1444937275.md +++ b/windows.data.text/unicodecharacters_ishighsurrogate_1444937275.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsHighSurrogate(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsHighSurrogate ## -description Determines if a specified Unicode character is a high surrogate. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is a high surrogate; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsHighSurrogate(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsHighSurrogate + +## -description +Determines if a specified Unicode character is a high surrogate. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is a high surrogate; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isidcontinue_1555021665.md b/windows.data.text/unicodecharacters_isidcontinue_1555021665.md index d17c75551a..30a29cc6f4 100644 --- a/windows.data.text/unicodecharacters_isidcontinue_1555021665.md +++ b/windows.data.text/unicodecharacters_isidcontinue_1555021665.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsIdContinue(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsIdContinue ## -description Determines if a specified Unicode character can be considered a continuation character of an identifier in programming. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is a continuation character of an identifier in programming; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsIdContinue(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsIdContinue + +## -description +Determines if a specified Unicode character can be considered a continuation character of an identifier in programming. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is a continuation character of an identifier in programming; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isidstart_701241523.md b/windows.data.text/unicodecharacters_isidstart_701241523.md index 8ba0fc060c..e7859b5bb0 100644 --- a/windows.data.text/unicodecharacters_isidstart_701241523.md +++ b/windows.data.text/unicodecharacters_isidstart_701241523.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsIdStart(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsIdStart ## -description Determines if a specified Unicode character can be considered the start character of an identifier in programming. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is the start character of an identifier in programming; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsIdStart(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsIdStart + +## -description +Determines if a specified Unicode character can be considered the start character of an identifier in programming. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is the start character of an identifier in programming; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_islowercase_1110032096.md b/windows.data.text/unicodecharacters_islowercase_1110032096.md index aeb451bca7..9ad95b7728 100644 --- a/windows.data.text/unicodecharacters_islowercase_1110032096.md +++ b/windows.data.text/unicodecharacters_islowercase_1110032096.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsLowercase(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsLowercase ## -description Determines if a specified Unicode character can be considered a lower case character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is a lower case character; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsLowercase(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsLowercase + +## -description +Determines if a specified Unicode character can be considered a lower case character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is a lower case character; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_islowsurrogate_645121110.md b/windows.data.text/unicodecharacters_islowsurrogate_645121110.md index 906c14f1c4..571b4f3a10 100644 --- a/windows.data.text/unicodecharacters_islowsurrogate_645121110.md +++ b/windows.data.text/unicodecharacters_islowsurrogate_645121110.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsLowSurrogate(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsLowSurrogate ## -description Determines if a specified Unicode character is a low surrogate. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is a low surrogate; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsLowSurrogate(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsLowSurrogate + +## -description +Determines if a specified Unicode character is a low surrogate. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is a low surrogate; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md), [Surrogates and Supplementary Characters](http://msdn.microsoft.com/library/0dea39e2-a2b4-47fc-b44a-56af8ba1e346) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isnoncharacter_636588793.md b/windows.data.text/unicodecharacters_isnoncharacter_636588793.md index db764bad11..a7cb9591a8 100644 --- a/windows.data.text/unicodecharacters_isnoncharacter_636588793.md +++ b/windows.data.text/unicodecharacters_isnoncharacter_636588793.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsNoncharacter(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsNoncharacter ## -description Determines if a specified codepoint is a non-character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is a non-character; otherwise **FALSE**. ## -remarks This method determines if *codepoint* is a one of the invalid Unicode code points (U+FFD0 through U+FFEF, U+xxFFFE, or U+xxFFFF). ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsNoncharacter(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsNoncharacter + +## -description +Determines if a specified codepoint is a non-character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is a non-character; otherwise **FALSE**. + +## -remarks +This method determines if *codepoint* is a one of the invalid Unicode code points (U+FFD0 through U+FFEF, U+xxFFFE, or U+xxFFFF). + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_issupplementary_2056623819.md b/windows.data.text/unicodecharacters_issupplementary_2056623819.md index d7b44128e9..60076f9c67 100644 --- a/windows.data.text/unicodecharacters_issupplementary_2056623819.md +++ b/windows.data.text/unicodecharacters_issupplementary_2056623819.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsSupplementary(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsSupplementary ## -description Determines if a specified Unicode character is a supplementary character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is a supplementary character; otherwise **FALSE**. ## -remarks This method determines if *codepoint* is a supplementary character (greater than 0xFFFF). ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsSupplementary(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsSupplementary + +## -description +Determines if a specified Unicode character is a supplementary character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is a supplementary character; otherwise **FALSE**. + +## -remarks +This method determines if *codepoint* is a supplementary character (greater than 0xFFFF). + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_isuppercase_1285793309.md b/windows.data.text/unicodecharacters_isuppercase_1285793309.md index 84f0b4f558..999ba077f6 100644 --- a/windows.data.text/unicodecharacters_isuppercase_1285793309.md +++ b/windows.data.text/unicodecharacters_isuppercase_1285793309.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsUppercase(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsUppercase ## -description Determines if a specified Unicode character can be considered an upper case character. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is an upper case character; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsUppercase(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsUppercase + +## -description +Determines if a specified Unicode character can be considered an upper case character. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is an upper case character; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/unicodecharacters_iswhitespace_1748629005.md b/windows.data.text/unicodecharacters_iswhitespace_1748629005.md index dee64edeca..6d3ca5cf9d 100644 --- a/windows.data.text/unicodecharacters_iswhitespace_1748629005.md +++ b/windows.data.text/unicodecharacters_iswhitespace_1748629005.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Text.UnicodeCharacters.IsWhitespace(System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.UnicodeCharacters.IsWhitespace ## -description Determines if a specified Unicode character can be considered whitespace. ## -parameters ### -param codepoint A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. ## -returns **TRUE** if *codepoint* is whitespace; otherwise **FALSE**. ## -remarks ## -examples ## -see-also [GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.UnicodeCharacters.IsWhitespace(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.UnicodeCharacters.IsWhitespace + +## -description +Determines if a specified Unicode character can be considered whitespace. + +## -parameters +### -param codepoint +A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. + +## -returns +**TRUE** if *codepoint* is whitespace; otherwise **FALSE**. + +## -remarks + + +## -examples + +## -see-also +[GetCodepointFromSurrogatePair](unicodecharacters_getcodepointfromsurrogatepair.md) \ No newline at end of file diff --git a/windows.data.text/wordsegment.md b/windows.data.text/wordsegment.md index 952732e470..46b79831b9 100644 --- a/windows.data.text/wordsegment.md +++ b/windows.data.text/wordsegment.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Data.Text.WordSegment --api-type: winrt class ---- # Windows.Data.Text.WordSegment ## -description Represents a word from your provided text. Words in this class do not include trailing whitespace or punctuation. This class can also expose alternate forms of words, and normalized numbers, currencies, dates, and times. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.WordSegment +-api-type: winrt class +--- + + + +# Windows.Data.Text.WordSegment + +## -description +Represents a word from your provided text. + +Words in this class do not include trailing whitespace or punctuation. This class can also expose alternate forms of words, and normalized numbers, currencies, dates, and times. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordsegment_alternateforms.md b/windows.data.text/wordsegment_alternateforms.md index ae2e7365b3..c3435be93b 100644 --- a/windows.data.text/wordsegment_alternateforms.md +++ b/windows.data.text/wordsegment_alternateforms.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Data.Text.WordSegment.AlternateForms --api-type: winrt property ---- # Windows.Data.Text.WordSegment.AlternateForms ## -description Gets the alternate forms (if any) associated with the current word. Alternate forms are loosely associated with the current word. An alternate form may encompass less text, more text, or the same text as the original word. ## -property-value A collection of [AlternateWordForm](alternatewordform.md) objects that represent alternate forms of the current word. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.WordSegment.AlternateForms +-api-type: winrt property +--- + + + +# Windows.Data.Text.WordSegment.AlternateForms + +## -description +Gets the alternate forms (if any) associated with the current word. + +Alternate forms are loosely associated with the current word. An alternate form may encompass less text, more text, or the same text as the original word. + +## -property-value +A collection of [AlternateWordForm](alternatewordform.md) objects that represent alternate forms of the current word. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordsegment_sourcetextsegment.md b/windows.data.text/wordsegment_sourcetextsegment.md index 6fc6cf5a2f..a78a7b08b6 100644 --- a/windows.data.text/wordsegment_sourcetextsegment.md +++ b/windows.data.text/wordsegment_sourcetextsegment.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Text.WordSegment.SourceTextSegment --api-type: winrt property ---- # Windows.Data.Text.WordSegment.SourceTextSegment ## -description Gets the [TextSegment](textsegment.md) that identifies the source text's sub-string that is a word. ## -property-value The [TextSegment](textsegment.md) structure that identifies the word in your provided text. ## -remarks ## -examples ## -see-also [TextSegment](textsegment.md) \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.WordSegment.SourceTextSegment +-api-type: winrt property +--- + + + +# Windows.Data.Text.WordSegment.SourceTextSegment + +## -description +Gets the [TextSegment](textsegment.md) that identifies the source text's sub-string that is a word. + +## -property-value +The [TextSegment](textsegment.md) structure that identifies the word in your provided text. + +## -remarks + +## -examples + +## -see-also +[TextSegment](textsegment.md) \ No newline at end of file diff --git a/windows.data.text/wordsegment_text.md b/windows.data.text/wordsegment_text.md index 0c7eea8b2e..2b94ca90c7 100644 --- a/windows.data.text/wordsegment_text.md +++ b/windows.data.text/wordsegment_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Text.WordSegment.Text --api-type: winrt property ---- # Windows.Data.Text.WordSegment.Text ## -description Gets the text of the word identified by this [WordSegment](wordsegment.md) object. ## -property-value The current word. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.WordSegment.Text +-api-type: winrt property +--- + + + +# Windows.Data.Text.WordSegment.Text + +## -description +Gets the text of the word identified by this [WordSegment](wordsegment.md) object. + +## -property-value +The current word. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordssegmenter.md b/windows.data.text/wordssegmenter.md index 42990ed41c..14be5da186 100644 --- a/windows.data.text/wordssegmenter.md +++ b/windows.data.text/wordssegmenter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Data.Text.WordsSegmenter --api-type: winrt class ---- # Windows.Data.Text.WordsSegmenter ## -description A segmenter class that is able to segment provided text into words. The language supplied when this object is constructed is matched against the languages with word breakers on the system, and the best word segmentation rules available are used. The language need not be one of the app's supported languages. If there are no supported language rules available specifically for that language, the language-neutral rules are used (an implementation of [Unicode Standard Annex #29 Unicode Text Segmentation](http://go.microsoft.com/fwlink/p/?LinkId=325425)), and the [ResolvedLanguage](selectablewordssegmenter_resolvedlanguage.md) property is set to "und" (undetermined language). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Data.Text.WordsSegmenter +-api-type: winrt class +--- + + + +# Windows.Data.Text.WordsSegmenter + +## -description +A segmenter class that is able to segment provided text into words. + +The language supplied when this object is constructed is matched against the languages with word breakers on the system, and the best word segmentation rules available are used. The language need not be one of the app's supported languages. If there are no supported language rules available specifically for that language, the language-neutral rules are used (an implementation of [Unicode Standard Annex #29 Unicode Text Segmentation](http://go.microsoft.com/fwlink/p/?LinkId=325425)), and the [ResolvedLanguage](selectablewordssegmenter_resolvedlanguage.md) property is set to "und" (undetermined language). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordssegmenter_gettokenat_467343.md b/windows.data.text/wordssegmenter_gettokenat_467343.md index ad1ba50b86..bca7db4f2d 100644 --- a/windows.data.text/wordssegmenter_gettokenat_467343.md +++ b/windows.data.text/wordssegmenter_gettokenat_467343.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Text.WordsSegmenter.GetTokenAt(System.String,System.UInt32) --api-type: winrt method ---- # Windows.Data.Text.WordsSegmenter.GetTokenAt ## -description Determines and returns the word which contains or follows a specified index into the provided text. ## -parameters ### -param text Provided text from which the word is to be returned. ### -param startIndex A zero-based index into *text*. It must be less than the length of *text*. ## -returns A [WordSegment](wordsegment.md) that represents the word. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.WordsSegmenter.GetTokenAt(System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Text.WordsSegmenter.GetTokenAt + +## -description +Determines and returns the word which contains or follows a specified index into the provided text. + +## -parameters +### -param text +Provided text from which the word is to be returned. + +### -param startIndex +A zero-based index into *text*. It must be less than the length of *text*. + +## -returns +A [WordSegment](wordsegment.md) that represents the word. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordssegmenter_gettokens_132398159.md b/windows.data.text/wordssegmenter_gettokens_132398159.md index 71afd2b90c..c76ff5b408 100644 --- a/windows.data.text/wordssegmenter_gettokens_132398159.md +++ b/windows.data.text/wordssegmenter_gettokens_132398159.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Text.WordsSegmenter.GetTokens(System.String) --api-type: winrt method ---- # Windows.Data.Text.WordsSegmenter.GetTokens ## -description Determines and returns all of the words in the provided text. ## -parameters ### -param text Provided text containing words to be returned. ## -returns A collection of [WordSegment](wordsegment.md) objects that represent the words. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.WordsSegmenter.GetTokens(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.WordsSegmenter.GetTokens + +## -description +Determines and returns all of the words in the provided text. + +## -parameters +### -param text +Provided text containing words to be returned. + +## -returns +A collection of [WordSegment](wordsegment.md) objects that represent the words. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordssegmenter_resolvedlanguage.md b/windows.data.text/wordssegmenter_resolvedlanguage.md index fb356ced43..e3aafc8b92 100644 --- a/windows.data.text/wordssegmenter_resolvedlanguage.md +++ b/windows.data.text/wordssegmenter_resolvedlanguage.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Data.Text.WordsSegmenter.ResolvedLanguage --api-type: winrt property ---- # Windows.Data.Text.WordsSegmenter.ResolvedLanguage ## -description Gets the language of the rules used by this [WordsSegmenter](wordssegmenter.md) object. "und" (undetermined) is returned if we are using language-neutral rules. ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the rules employed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Text.WordsSegmenter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Data.Text.WordsSegmenter.ResolvedLanguage + +## -description +Gets the language of the rules used by this [WordsSegmenter](wordssegmenter.md) object. + +"und" (undetermined) is returned if we are using language-neutral rules. + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag of the rules employed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.text/wordssegmenter_tokenize_982453003.md b/windows.data.text/wordssegmenter_tokenize_982453003.md index beb616b0a3..4fdb089115 100644 --- a/windows.data.text/wordssegmenter_tokenize_982453003.md +++ b/windows.data.text/wordssegmenter_tokenize_982453003.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Data.Text.WordsSegmenter.Tokenize(System.String,System.UInt32,Windows.Data.Text.WordSegmentsTokenizingHandler) --api-type: winrt method ---- # Windows.Data.Text.WordsSegmenter.Tokenize ## -description Calls the provided handler with two iterators that iterate through the words prior to and following a given index into the provided text. ## -parameters ### -param text Provided text containing words to be returned. ### -param startIndex A zero-based index into *text*. It must be less than the length of *text*. ### -param handler The function that receives the iterators. ## -remarks The iterators in [WordSegmentsTokenizingHandler](wordsegmentstokenizinghandler.md) are lazy and evaluate small chunks of text at a time. The handler is called at most once per call to [Tokenize](wordssegmenter_tokenize.md). The handler is not called if there are no selectable words in *text*. ## -examples ## -see-also [WordSegmentsTokenizingHandler](wordsegmentstokenizinghandler.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.WordsSegmenter.Tokenize(System.String,System.UInt32,Windows.Data.Text.WordSegmentsTokenizingHandler) +-api-type: winrt method +--- + + + +# Windows.Data.Text.WordsSegmenter.Tokenize + +## -description +Calls the provided handler with two iterators that iterate through the words prior to and following a given index into the provided text. + +## -parameters +### -param text +Provided text containing words to be returned. + +### -param startIndex +A zero-based index into *text*. It must be less than the length of *text*. + +### -param handler +The function that receives the iterators. + +## -remarks +The iterators in [WordSegmentsTokenizingHandler](wordsegmentstokenizinghandler.md) are lazy and evaluate small chunks of text at a time. + +The handler is called at most once per call to [Tokenize](wordssegmenter_tokenize.md). The handler is not called if there are no selectable words in *text*. + +## -examples + +## -see-also +[WordSegmentsTokenizingHandler](wordsegmentstokenizinghandler.md) \ No newline at end of file diff --git a/windows.data.text/wordssegmenter_wordssegmenter_290278668.md b/windows.data.text/wordssegmenter_wordssegmenter_290278668.md index 001658d699..115e25a4eb 100644 --- a/windows.data.text/wordssegmenter_wordssegmenter_290278668.md +++ b/windows.data.text/wordssegmenter_wordssegmenter_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Text.WordsSegmenter.#ctor(System.String) --api-type: winrt method ---- # Windows.Data.Text.WordsSegmenter.WordsSegmenter ## -description Creates a [WordsSegmenter](wordssegmenter.md) object. See the introduction in [WordsSegmenter](wordssegmenter.md) for a description of how the language supplied to this constructor is used. ## -parameters ### -param language A [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Text.WordsSegmenter.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Text.WordsSegmenter.WordsSegmenter + +## -description +Creates a [WordsSegmenter](wordssegmenter.md) object. See the introduction in [WordsSegmenter](wordssegmenter.md) for a description of how the language supplied to this constructor is used. + +## -parameters +### -param language +A [BCP-47](http://go.microsoft.com/fwlink/p/?LinkId=227302) language tag. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_appendchild_1014377324.md b/windows.data.xml.dom/dtdentity_appendchild_1014377324.md index 82d44693f5..3f49a673c3 100644 --- a/windows.data.xml.dom/dtdentity_appendchild_1014377324.md +++ b/windows.data.xml.dom/dtdentity_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_attributes.md b/windows.data.xml.dom/dtdentity_attributes.md index 9d64327a37..a38b3dda1b 100644 --- a/windows.data.xml.dom/dtdentity_attributes.md +++ b/windows.data.xml.dom/dtdentity_attributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_childnodes.md b/windows.data.xml.dom/dtdentity_childnodes.md index 4363f88c58..e6c739662d 100644 --- a/windows.data.xml.dom/dtdentity_childnodes.md +++ b/windows.data.xml.dom/dtdentity_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_clonenode_554530370.md b/windows.data.xml.dom/dtdentity_clonenode_554530370.md index f8c170ee6f..1b565c70b7 100644 --- a/windows.data.xml.dom/dtdentity_clonenode_554530370.md +++ b/windows.data.xml.dom/dtdentity_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_firstchild.md b/windows.data.xml.dom/dtdentity_firstchild.md index 669f5cbb0b..8f0d72411c 100644 --- a/windows.data.xml.dom/dtdentity_firstchild.md +++ b/windows.data.xml.dom/dtdentity_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_getxml_999931642.md b/windows.data.xml.dom/dtdentity_getxml_999931642.md index bf2b99ad15..90d603a826 100644 --- a/windows.data.xml.dom/dtdentity_getxml_999931642.md +++ b/windows.data.xml.dom/dtdentity_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_haschildnodes_464206014.md b/windows.data.xml.dom/dtdentity_haschildnodes_464206014.md index fcb963dd70..26e4b726ef 100644 --- a/windows.data.xml.dom/dtdentity_haschildnodes_464206014.md +++ b/windows.data.xml.dom/dtdentity_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_innertext.md b/windows.data.xml.dom/dtdentity_innertext.md index 7fafd0de58..52a15d93eb 100644 --- a/windows.data.xml.dom/dtdentity_innertext.md +++ b/windows.data.xml.dom/dtdentity_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_insertbefore_88135496.md b/windows.data.xml.dom/dtdentity_insertbefore_88135496.md index a158271818..34a70e81d1 100644 --- a/windows.data.xml.dom/dtdentity_insertbefore_88135496.md +++ b/windows.data.xml.dom/dtdentity_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the child node list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild * parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the child node list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild * parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_lastchild.md b/windows.data.xml.dom/dtdentity_lastchild.md index 6492a1a739..ef5fcc3ebf 100644 --- a/windows.data.xml.dom/dtdentity_lastchild.md +++ b/windows.data.xml.dom/dtdentity_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_localname.md b/windows.data.xml.dom/dtdentity_localname.md index 83a8bd890b..9a8da3ab13 100644 --- a/windows.data.xml.dom/dtdentity_localname.md +++ b/windows.data.xml.dom/dtdentity_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_namespaceuri.md b/windows.data.xml.dom/dtdentity_namespaceuri.md index 7269acb297..7c6c18a489 100644 --- a/windows.data.xml.dom/dtdentity_namespaceuri.md +++ b/windows.data.xml.dom/dtdentity_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_nextsibling.md b/windows.data.xml.dom/dtdentity_nextsibling.md index 2444772bf6..fc3d4b0894 100644 --- a/windows.data.xml.dom/dtdentity_nextsibling.md +++ b/windows.data.xml.dom/dtdentity_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node or NULL if there is no right sibling. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node or NULL if there is no right sibling. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_nodename.md b/windows.data.xml.dom/dtdentity_nodename.md index 4ffd1db26b..7fae203aa6 100644 --- a/windows.data.xml.dom/dtdentity_nodename.md +++ b/windows.data.xml.dom/dtdentity_nodename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_nodetype.md b/windows.data.xml.dom/dtdentity_nodetype.md index 875da124ae..14c79b82c3 100644 --- a/windows.data.xml.dom/dtdentity_nodetype.md +++ b/windows.data.xml.dom/dtdentity_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_nodevalue.md b/windows.data.xml.dom/dtdentity_nodevalue.md index 9bac9829ff..e6520ddfa6 100644 --- a/windows.data.xml.dom/dtdentity_nodevalue.md +++ b/windows.data.xml.dom/dtdentity_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.NodeValue ## -description Gets or sets the text associated with the node. This value is always NULL. ## -property-value This value is always NULL. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionentire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.NodeValue + +## -description +Gets or sets the text associated with the node. This value is always NULL. + +## -property-value +This value is always NULL. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionentire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_normalize_347475160.md b/windows.data.xml.dom/dtdentity_normalize_347475160.md index ffa8d2c281..92517743eb 100644 --- a/windows.data.xml.dom/dtdentity_normalize_347475160.md +++ b/windows.data.xml.dom/dtdentity_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_notationname.md b/windows.data.xml.dom/dtdentity_notationname.md index df3151acd5..f334910bb3 100644 --- a/windows.data.xml.dom/dtdentity_notationname.md +++ b/windows.data.xml.dom/dtdentity_notationname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.NotationName --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.NotationName ## -description Gets the notation name. ## -property-value The notation name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.NotationName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.NotationName + +## -description +Gets the notation name. + +## -property-value +The notation name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_ownerdocument.md b/windows.data.xml.dom/dtdentity_ownerdocument.md index 128a699f61..3f83172d23 100644 --- a/windows.data.xml.dom/dtdentity_ownerdocument.md +++ b/windows.data.xml.dom/dtdentity_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_parentnode.md b/windows.data.xml.dom/dtdentity_parentnode.md index 8ddbddc91b..39f9b47800 100644 --- a/windows.data.xml.dom/dtdentity_parentnode.md +++ b/windows.data.xml.dom/dtdentity_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_prefix.md b/windows.data.xml.dom/dtdentity_prefix.md index b05302d64e..ea7c9ab9d9 100644 --- a/windows.data.xml.dom/dtdentity_prefix.md +++ b/windows.data.xml.dom/dtdentity_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.Prefix ## -description Returns the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.Prefix + +## -description +Returns the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_previoussibling.md b/windows.data.xml.dom/dtdentity_previoussibling.md index 6629f5e07b..8b8e790396 100644 --- a/windows.data.xml.dom/dtdentity_previoussibling.md +++ b/windows.data.xml.dom/dtdentity_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_publicid.md b/windows.data.xml.dom/dtdentity_publicid.md index 70a313b47a..770ae72f33 100644 --- a/windows.data.xml.dom/dtdentity_publicid.md +++ b/windows.data.xml.dom/dtdentity_publicid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.PublicId --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.PublicId ## -description Gets the public identifier associated with the entity. ## -property-value The public identifier associated with the entity. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.PublicId +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.PublicId + +## -description +Gets the public identifier associated with the entity. + +## -property-value +The public identifier associated with the entity. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_removechild_1165510615.md b/windows.data.xml.dom/dtdentity_removechild_1165510615.md index 0678f5cba1..f2e6703632 100644 --- a/windows.data.xml.dom/dtdentity_removechild_1165510615.md +++ b/windows.data.xml.dom/dtdentity_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_replacechild_85158540.md b/windows.data.xml.dom/dtdentity_replacechild_85158540.md index b86a62c2a3..507508fbc8 100644 --- a/windows.data.xml.dom/dtdentity_replacechild_85158540.md +++ b/windows.data.xml.dom/dtdentity_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_selectnodes_71711491.md b/windows.data.xml.dom/dtdentity_selectnodes_71711491.md index c6c964b721..827ff6902e 100644 --- a/windows.data.xml.dom/dtdentity_selectnodes_71711491.md +++ b/windows.data.xml.dom/dtdentity_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_selectnodesns_2126476717.md b/windows.data.xml.dom/dtdentity_selectnodesns_2126476717.md index db59741b27..bd792a6c85 100644 --- a/windows.data.xml.dom/dtdentity_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/dtdentity_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_selectsinglenode_1817002489.md b/windows.data.xml.dom/dtdentity_selectsinglenode_1817002489.md index 41a5b9ebe7..6ba6867b27 100644 --- a/windows.data.xml.dom/dtdentity_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/dtdentity_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_selectsinglenodens_1164847996.md b/windows.data.xml.dom/dtdentity_selectsinglenodens_1164847996.md index 9f994a163f..85c905e026 100644 --- a/windows.data.xml.dom/dtdentity_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/dtdentity_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdEntity.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdEntity.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdentity_systemid.md b/windows.data.xml.dom/dtdentity_systemid.md index 5593bc6e57..909ef4d8b7 100644 --- a/windows.data.xml.dom/dtdentity_systemid.md +++ b/windows.data.xml.dom/dtdentity_systemid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdEntity.SystemId --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdEntity.SystemId ## -description Gets the system identifier associated with the entity. ## -property-value The system identifier associated with the entity. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdEntity.SystemId +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdEntity.SystemId + +## -description +Gets the system identifier associated with the entity. + +## -property-value +The system identifier associated with the entity. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_appendchild_1014377324.md b/windows.data.xml.dom/dtdnotation_appendchild_1014377324.md index 5e9c155676..9694521c4d 100644 --- a/windows.data.xml.dom/dtdnotation_appendchild_1014377324.md +++ b/windows.data.xml.dom/dtdnotation_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_attributes.md b/windows.data.xml.dom/dtdnotation_attributes.md index 5bf02fe706..f569df5130 100644 --- a/windows.data.xml.dom/dtdnotation_attributes.md +++ b/windows.data.xml.dom/dtdnotation_attributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_childnodes.md b/windows.data.xml.dom/dtdnotation_childnodes.md index b33f769a15..460104c769 100644 --- a/windows.data.xml.dom/dtdnotation_childnodes.md +++ b/windows.data.xml.dom/dtdnotation_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_clonenode_554530370.md b/windows.data.xml.dom/dtdnotation_clonenode_554530370.md index ebf086be0e..7398fd1016 100644 --- a/windows.data.xml.dom/dtdnotation_clonenode_554530370.md +++ b/windows.data.xml.dom/dtdnotation_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_firstchild.md b/windows.data.xml.dom/dtdnotation_firstchild.md index 9d86d5b9fa..69c79f5ae5 100644 --- a/windows.data.xml.dom/dtdnotation_firstchild.md +++ b/windows.data.xml.dom/dtdnotation_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_getxml_999931642.md b/windows.data.xml.dom/dtdnotation_getxml_999931642.md index 9a4b03aebb..d457fbd5e2 100644 --- a/windows.data.xml.dom/dtdnotation_getxml_999931642.md +++ b/windows.data.xml.dom/dtdnotation_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_haschildnodes_464206014.md b/windows.data.xml.dom/dtdnotation_haschildnodes_464206014.md index f83ba4b8a9..80b49e4602 100644 --- a/windows.data.xml.dom/dtdnotation_haschildnodes_464206014.md +++ b/windows.data.xml.dom/dtdnotation_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_innertext.md b/windows.data.xml.dom/dtdnotation_innertext.md index 6a257882c2..3c36ac1392 100644 --- a/windows.data.xml.dom/dtdnotation_innertext.md +++ b/windows.data.xml.dom/dtdnotation_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_insertbefore_88135496.md b/windows.data.xml.dom/dtdnotation_insertbefore_88135496.md index 4d7b7c4fa3..e1f11aca1d 100644 --- a/windows.data.xml.dom/dtdnotation_insertbefore_88135496.md +++ b/windows.data.xml.dom/dtdnotation_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the child node list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the child node list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_lastchild.md b/windows.data.xml.dom/dtdnotation_lastchild.md index 24b5da18ee..475a17859c 100644 --- a/windows.data.xml.dom/dtdnotation_lastchild.md +++ b/windows.data.xml.dom/dtdnotation_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_localname.md b/windows.data.xml.dom/dtdnotation_localname.md index 9d75d7270e..d61043c142 100644 --- a/windows.data.xml.dom/dtdnotation_localname.md +++ b/windows.data.xml.dom/dtdnotation_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_namespaceuri.md b/windows.data.xml.dom/dtdnotation_namespaceuri.md index d388cc70c5..1a80ba2d89 100644 --- a/windows.data.xml.dom/dtdnotation_namespaceuri.md +++ b/windows.data.xml.dom/dtdnotation_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_nextsibling.md b/windows.data.xml.dom/dtdnotation_nextsibling.md index aa4fa29890..0265a518fb 100644 --- a/windows.data.xml.dom/dtdnotation_nextsibling.md +++ b/windows.data.xml.dom/dtdnotation_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node or NULL if there is no right sibling.. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node or NULL if there is no right sibling.. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_nodename.md b/windows.data.xml.dom/dtdnotation_nodename.md index 4cf9ae90bf..657c460eef 100644 --- a/windows.data.xml.dom/dtdnotation_nodename.md +++ b/windows.data.xml.dom/dtdnotation_nodename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_nodetype.md b/windows.data.xml.dom/dtdnotation_nodetype.md index 7d1d2aa279..1b08a4024f 100644 --- a/windows.data.xml.dom/dtdnotation_nodetype.md +++ b/windows.data.xml.dom/dtdnotation_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_nodevalue.md b/windows.data.xml.dom/dtdnotation_nodevalue.md index af8bbfae79..471cb380aa 100644 --- a/windows.data.xml.dom/dtdnotation_nodevalue.md +++ b/windows.data.xml.dom/dtdnotation_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value This value is always NULL. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionentire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +This value is always NULL. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionentire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_normalize_347475160.md b/windows.data.xml.dom/dtdnotation_normalize_347475160.md index 09842a167a..bc8d3e11cf 100644 --- a/windows.data.xml.dom/dtdnotation_normalize_347475160.md +++ b/windows.data.xml.dom/dtdnotation_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_ownerdocument.md b/windows.data.xml.dom/dtdnotation_ownerdocument.md index 2fc54ed0ff..4d6d3d974a 100644 --- a/windows.data.xml.dom/dtdnotation_ownerdocument.md +++ b/windows.data.xml.dom/dtdnotation_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_parentnode.md b/windows.data.xml.dom/dtdnotation_parentnode.md index 537a2b15b1..19fe2feaf0 100644 --- a/windows.data.xml.dom/dtdnotation_parentnode.md +++ b/windows.data.xml.dom/dtdnotation_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_prefix.md b/windows.data.xml.dom/dtdnotation_prefix.md index 48f022f6b3..b0f0e59276 100644 --- a/windows.data.xml.dom/dtdnotation_prefix.md +++ b/windows.data.xml.dom/dtdnotation_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_previoussibling.md b/windows.data.xml.dom/dtdnotation_previoussibling.md index 90b8ee1a25..22017fe66a 100644 --- a/windows.data.xml.dom/dtdnotation_previoussibling.md +++ b/windows.data.xml.dom/dtdnotation_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_publicid.md b/windows.data.xml.dom/dtdnotation_publicid.md index 83e7428a36..d7b120409a 100644 --- a/windows.data.xml.dom/dtdnotation_publicid.md +++ b/windows.data.xml.dom/dtdnotation_publicid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.PublicId --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.PublicId ## -description Gets the public identifier for the notation. ## -property-value The public identifier for the notation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.PublicId +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.PublicId + +## -description +Gets the public identifier for the notation. + +## -property-value +The public identifier for the notation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_removechild_1165510615.md b/windows.data.xml.dom/dtdnotation_removechild_1165510615.md index af005c556e..b454008bce 100644 --- a/windows.data.xml.dom/dtdnotation_removechild_1165510615.md +++ b/windows.data.xml.dom/dtdnotation_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_replacechild_85158540.md b/windows.data.xml.dom/dtdnotation_replacechild_85158540.md index 99179d834c..d8897a011f 100644 --- a/windows.data.xml.dom/dtdnotation_replacechild_85158540.md +++ b/windows.data.xml.dom/dtdnotation_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_selectnodes_71711491.md b/windows.data.xml.dom/dtdnotation_selectnodes_71711491.md index 881d716243..b7618c2f91 100644 --- a/windows.data.xml.dom/dtdnotation_selectnodes_71711491.md +++ b/windows.data.xml.dom/dtdnotation_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_selectnodesns_2126476717.md b/windows.data.xml.dom/dtdnotation_selectnodesns_2126476717.md index eccb55080d..f0c9bb1394 100644 --- a/windows.data.xml.dom/dtdnotation_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/dtdnotation_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expresssion. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expresssion. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_selectsinglenode_1817002489.md b/windows.data.xml.dom/dtdnotation_selectsinglenode_1817002489.md index 39f9f90f0c..11a0ff523a 100644 --- a/windows.data.xml.dom/dtdnotation_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/dtdnotation_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_selectsinglenodens_1164847996.md b/windows.data.xml.dom/dtdnotation_selectsinglenodens_1164847996.md index 9ce30ede09..2e643a7c39 100644 --- a/windows.data.xml.dom/dtdnotation_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/dtdnotation_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.DtdNotation.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.DtdNotation.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/dtdnotation_systemid.md b/windows.data.xml.dom/dtdnotation_systemid.md index f71f7be052..9989a8e3d0 100644 --- a/windows.data.xml.dom/dtdnotation_systemid.md +++ b/windows.data.xml.dom/dtdnotation_systemid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.DtdNotation.SystemId --api-type: winrt property ---- # Windows.Data.Xml.Dom.DtdNotation.SystemId ## -description Gets the system identifier for the notation. ## -property-value The system identifier for the notation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.DtdNotation.SystemId +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.DtdNotation.SystemId + +## -description +Gets the system identifier for the notation. + +## -property-value +The system identifier for the notation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_appenddata.md b/windows.data.xml.dom/ixmlcharacterdata_appenddata.md index 9890a64bbf..c5c677c1eb 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_appenddata.md +++ b/windows.data.xml.dom/ixmlcharacterdata_appenddata.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.AppendData(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlCharacterData.AppendData ## -description Appends the supplied string to the existing string data. ## -parameters ### -param data The data to be appended to the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.AppendData(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.AppendData + +## -description +Appends the supplied string to the existing string data. + +## -parameters +### -param data +The data to be appended to the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_data.md b/windows.data.xml.dom/ixmlcharacterdata_data.md index 37665780ac..68448a7668 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_data.md +++ b/windows.data.xml.dom/ixmlcharacterdata_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlCharacterData.Data --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlCharacterData.Data ## -description Gets or sets the node data depending on the node type. ## -property-value The node data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlCharacterData.Data +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.Data + +## -description +Gets or sets the node data depending on the node type. + +## -property-value +The node data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_deletedata.md b/windows.data.xml.dom/ixmlcharacterdata_deletedata.md index 372cdb834b..75fbd17e59 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_deletedata.md +++ b/windows.data.xml.dom/ixmlcharacterdata_deletedata.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.DeleteData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlCharacterData.DeleteData ## -description Deletes specified data. ## -parameters ### -param offset The offset, in characters, at which to start deleting the string data. ### -param count The number of characters to delete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.DeleteData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.DeleteData + +## -description +Deletes specified data. + +## -parameters +### -param offset +The offset, in characters, at which to start deleting the string data. + +### -param count +The number of characters to delete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_insertdata.md b/windows.data.xml.dom/ixmlcharacterdata_insertdata.md index 106f903d28..7347f69ff7 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_insertdata.md +++ b/windows.data.xml.dom/ixmlcharacterdata_insertdata.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.InsertData(System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlCharacterData.InsertData ## -description Inserts a string at the specified offset. ## -parameters ### -param offset The offset, in characters, at which to insert the supplied string data. ### -param data The data to be inserted into the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.InsertData(System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.InsertData + +## -description +Inserts a string at the specified offset. + +## -parameters +### -param offset +The offset, in characters, at which to insert the supplied string data. + +### -param data +The data to be inserted into the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_length.md b/windows.data.xml.dom/ixmlcharacterdata_length.md index 756baa93cd..dee5f45b1b 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_length.md +++ b/windows.data.xml.dom/ixmlcharacterdata_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlCharacterData.Length --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlCharacterData.Length ## -description Gets the length of the data, in Unicode characters. ## -property-value The length of the data, in Unicode characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlCharacterData.Length +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.Length + +## -description +Gets the length of the data, in Unicode characters. + +## -property-value +The length of the data, in Unicode characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_replacedata.md b/windows.data.xml.dom/ixmlcharacterdata_replacedata.md index cc40d388d9..5c833b97b5 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_replacedata.md +++ b/windows.data.xml.dom/ixmlcharacterdata_replacedata.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.ReplaceData(System.UInt32,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlCharacterData.ReplaceData ## -description Replaces the specified number of characters with the supplied string. ## -parameters ### -param offset The offset, in characters, at which to start replacing string data. ### -param count The number of characters to replace. ### -param data The new data that replaces the old string data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.ReplaceData(System.UInt32,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.ReplaceData + +## -description +Replaces the specified number of characters with the supplied string. + +## -parameters +### -param offset +The offset, in characters, at which to start replacing string data. + +### -param count +The number of characters to replace. + +### -param data +The new data that replaces the old string data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlcharacterdata_substringdata.md b/windows.data.xml.dom/ixmlcharacterdata_substringdata.md index 9ac6baa8a6..a1e471c0d2 100644 --- a/windows.data.xml.dom/ixmlcharacterdata_substringdata.md +++ b/windows.data.xml.dom/ixmlcharacterdata_substringdata.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.SubstringData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlCharacterData.SubstringData ## -description Retrieves a substring of the full string from the specified range. ## -parameters ### -param offset Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. ### -param count Specifies the number of characters to retrieve from the specified offset. ## -returns The returned substring. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlCharacterData.SubstringData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlCharacterData.SubstringData + +## -description +Retrieves a substring of the full string from the specified range. + +## -parameters +### -param offset +Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. + +### -param count +Specifies the number of characters to retrieve from the specified offset. + +## -returns +The returned substring. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_appendchild.md b/windows.data.xml.dom/ixmlnode_appendchild.md index 231eb3b0ff..b1eda04e4f 100644 --- a/windows.data.xml.dom/ixmlnode_appendchild.md +++ b/windows.data.xml.dom/ixmlnode_appendchild.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_attributes.md b/windows.data.xml.dom/ixmlnode_attributes.md index b561770e9e..2e30839401 100644 --- a/windows.data.xml.dom/ixmlnode_attributes.md +++ b/windows.data.xml.dom/ixmlnode_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_childnodes.md b/windows.data.xml.dom/ixmlnode_childnodes.md index 9887cf322e..9bc78c9c00 100644 --- a/windows.data.xml.dom/ixmlnode_childnodes.md +++ b/windows.data.xml.dom/ixmlnode_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_clonenode.md b/windows.data.xml.dom/ixmlnode_clonenode.md index cdd76a546b..3ef2253ea2 100644 --- a/windows.data.xml.dom/ixmlnode_clonenode.md +++ b/windows.data.xml.dom/ixmlnode_clonenode.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_firstchild.md b/windows.data.xml.dom/ixmlnode_firstchild.md index 2e92d83fd1..df22199eb2 100644 --- a/windows.data.xml.dom/ixmlnode_firstchild.md +++ b/windows.data.xml.dom/ixmlnode_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_haschildnodes.md b/windows.data.xml.dom/ixmlnode_haschildnodes.md index b117e82a6d..82f80a27cf 100644 --- a/windows.data.xml.dom/ixmlnode_haschildnodes.md +++ b/windows.data.xml.dom/ixmlnode_haschildnodes.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_insertbefore.md b/windows.data.xml.dom/ixmlnode_insertbefore.md index 6caecd5864..aa56af2a70 100644 --- a/windows.data.xml.dom/ixmlnode_insertbefore.md +++ b/windows.data.xml.dom/ixmlnode_insertbefore.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_lastchild.md b/windows.data.xml.dom/ixmlnode_lastchild.md index bea4fda6ec..0fc8c99ca8 100644 --- a/windows.data.xml.dom/ixmlnode_lastchild.md +++ b/windows.data.xml.dom/ixmlnode_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_localname.md b/windows.data.xml.dom/ixmlnode_localname.md index d11f7ed9ef..2b805c501e 100644 --- a/windows.data.xml.dom/ixmlnode_localname.md +++ b/windows.data.xml.dom/ixmlnode_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_namespaceuri.md b/windows.data.xml.dom/ixmlnode_namespaceuri.md index e3a26bd0aa..02df7e5594 100644 --- a/windows.data.xml.dom/ixmlnode_namespaceuri.md +++ b/windows.data.xml.dom/ixmlnode_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_nextsibling.md b/windows.data.xml.dom/ixmlnode_nextsibling.md index 0cb4832db3..889b5e7d0b 100644 --- a/windows.data.xml.dom/ixmlnode_nextsibling.md +++ b/windows.data.xml.dom/ixmlnode_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_nodename.md b/windows.data.xml.dom/ixmlnode_nodename.md index 76c6549352..8b0a788c2f 100644 --- a/windows.data.xml.dom/ixmlnode_nodename.md +++ b/windows.data.xml.dom/ixmlnode_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_nodetype.md b/windows.data.xml.dom/ixmlnode_nodetype.md index 86618dd8da..bd6634bd65 100644 --- a/windows.data.xml.dom/ixmlnode_nodetype.md +++ b/windows.data.xml.dom/ixmlnode_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_nodevalue.md b/windows.data.xml.dom/ixmlnode_nodevalue.md index 2cef021673..2d54ce5277 100644 --- a/windows.data.xml.dom/ixmlnode_nodevalue.md +++ b/windows.data.xml.dom/ixmlnode_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_normalize.md b/windows.data.xml.dom/ixmlnode_normalize.md index 11b63f27c2..5bd9fbcb4e 100644 --- a/windows.data.xml.dom/ixmlnode_normalize.md +++ b/windows.data.xml.dom/ixmlnode_normalize.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_ownerdocument.md b/windows.data.xml.dom/ixmlnode_ownerdocument.md index 2038710c35..80c61d7f23 100644 --- a/windows.data.xml.dom/ixmlnode_ownerdocument.md +++ b/windows.data.xml.dom/ixmlnode_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_parentnode.md b/windows.data.xml.dom/ixmlnode_parentnode.md index 8ef6e54187..833f77fa16 100644 --- a/windows.data.xml.dom/ixmlnode_parentnode.md +++ b/windows.data.xml.dom/ixmlnode_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_prefix.md b/windows.data.xml.dom/ixmlnode_prefix.md index eeeceb001f..a87c748b42 100644 --- a/windows.data.xml.dom/ixmlnode_prefix.md +++ b/windows.data.xml.dom/ixmlnode_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_previoussibling.md b/windows.data.xml.dom/ixmlnode_previoussibling.md index e1fb7342ab..6e6eee33d0 100644 --- a/windows.data.xml.dom/ixmlnode_previoussibling.md +++ b/windows.data.xml.dom/ixmlnode_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNode.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNode.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNode.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_removechild.md b/windows.data.xml.dom/ixmlnode_removechild.md index d7339748f3..d0a845b834 100644 --- a/windows.data.xml.dom/ixmlnode_removechild.md +++ b/windows.data.xml.dom/ixmlnode_removechild.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnode_replacechild.md b/windows.data.xml.dom/ixmlnode_replacechild.md index 7b80d4b671..0f8e23101c 100644 --- a/windows.data.xml.dom/ixmlnode_replacechild.md +++ b/windows.data.xml.dom/ixmlnode_replacechild.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNode.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNode.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNode.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNode.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnodeselector_selectnodes.md b/windows.data.xml.dom/ixmlnodeselector_selectnodes.md index 16a7b68460..18d06a9dc1 100644 --- a/windows.data.xml.dom/ixmlnodeselector_selectnodes.md +++ b/windows.data.xml.dom/ixmlnodeselector_selectnodes.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnodeselector_selectnodesns.md b/windows.data.xml.dom/ixmlnodeselector_selectnodesns.md index d51785bb92..54b96df368 100644 --- a/windows.data.xml.dom/ixmlnodeselector_selectnodesns.md +++ b/windows.data.xml.dom/ixmlnodeselector_selectnodesns.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expresssion. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNodeSelector.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expresssion. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnodeselector_selectsinglenode.md b/windows.data.xml.dom/ixmlnodeselector_selectsinglenode.md index 5cdb10b09a..498c300ae1 100644 --- a/windows.data.xml.dom/ixmlnodeselector_selectsinglenode.md +++ b/windows.data.xml.dom/ixmlnodeselector_selectsinglenode.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnodeselector_selectsinglenodens.md b/windows.data.xml.dom/ixmlnodeselector_selectsinglenodens.md index 6a1ba29031..d7912a5b58 100644 --- a/windows.data.xml.dom/ixmlnodeselector_selectsinglenodens.md +++ b/windows.data.xml.dom/ixmlnodeselector_selectsinglenodens.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNodeSelector.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnodeserializer_getxml.md b/windows.data.xml.dom/ixmlnodeserializer_getxml.md index b6180921e6..7949761cf2 100644 --- a/windows.data.xml.dom/ixmlnodeserializer_getxml.md +++ b/windows.data.xml.dom/ixmlnodeserializer_getxml.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlNodeSerializer.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlNodeSerializer.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlNodeSerializer.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlNodeSerializer.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/ixmlnodeserializer_innertext.md b/windows.data.xml.dom/ixmlnodeserializer_innertext.md index 9061caa83d..42f6da8568 100644 --- a/windows.data.xml.dom/ixmlnodeserializer_innertext.md +++ b/windows.data.xml.dom/ixmlnodeserializer_innertext.md @@ -1,3 +1,47 @@ ---- -api-id: P:Windows.Data.Xml.Dom.IXmlNodeSerializer.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.IXmlNodeSerializer.InnerText ## -description Gets and sets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ```xml var doc = new Window.Data.Xml.Dom.XmlDocument(); doc.loadXml('\r\n hello\r\n world\r\n '); var xml = doc.getXml(); var txt = doc.InnerText; ``` The XML in this example is as follows. ``` hello world ``` The *txt* variable receives the following value from the **InnerText** member: ``` hello world ``` ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.IXmlNodeSerializer.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.IXmlNodeSerializer.InnerText + +## -description +Gets and sets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples +```xml +var doc = new Window.Data.Xml.Dom.XmlDocument(); +doc.loadXml('\r\n hello\r\n world\r\n '); +var xml = doc.getXml(); +var txt = doc.InnerText; + +``` + +The XML in this example is as follows. + +``` + + hello + world + + +``` + +The *txt* variable receives the following value from the **InnerText** member: + +``` +hello world +``` + + + +## -see-also diff --git a/windows.data.xml.dom/ixmltext_splittext.md b/windows.data.xml.dom/ixmltext_splittext.md index dc17518fea..97baa1298b 100644 --- a/windows.data.xml.dom/ixmltext_splittext.md +++ b/windows.data.xml.dom/ixmltext_splittext.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.IXmlText.SplitText(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.IXmlText.SplitText ## -description Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node. ## -parameters ### -param offset The number of characters at which to split this text node into two nodes, starting from zero. ## -returns The new text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.IXmlText.SplitText(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.IXmlText.SplitText + +## -description +Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node. + +## -parameters +### -param offset +The number of characters at which to split this text node into two nodes, starting from zero. + +## -returns +The new text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_appendchild_1014377324.md b/windows.data.xml.dom/xmlattribute_appendchild_1014377324.md index 71247d9412..65adac79e7 100644 --- a/windows.data.xml.dom/xmlattribute_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmlattribute_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.AppendChild ## -description This method is not applicable to this class and will throw an exception. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.AppendChild + +## -description +This method is not applicable to this class and will throw an exception. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_attributes.md b/windows.data.xml.dom/xmlattribute_attributes.md index bde7e6d5d4..e0bd839862 100644 --- a/windows.data.xml.dom/xmlattribute_attributes.md +++ b/windows.data.xml.dom/xmlattribute_attributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.Attributes ## -description This method is not applicable to this class and will throw an exception. ## -property-value The attributes for this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.Attributes + +## -description +This method is not applicable to this class and will throw an exception. + +## -property-value +The attributes for this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_childnodes.md b/windows.data.xml.dom/xmlattribute_childnodes.md index 5bf95193b6..d9c33a5c1c 100644 --- a/windows.data.xml.dom/xmlattribute_childnodes.md +++ b/windows.data.xml.dom/xmlattribute_childnodes.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks Child nodes can be a text or entity reference. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks +Child nodes can be a text or entity reference. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_clonenode_554530370.md b/windows.data.xml.dom/xmlattribute_clonenode_554530370.md index 9e718aa92b..856d38ceba 100644 --- a/windows.data.xml.dom/xmlattribute_clonenode_554530370.md +++ b/windows.data.xml.dom/xmlattribute_clonenode_554530370.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks If you want the cloned attribute to include the value of the attribute, you must use deep clone; otherwise only the attribute name is cloned. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks +If you want the cloned attribute to include the value of the attribute, you must use deep clone; otherwise only the attribute name is cloned. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_firstchild.md b/windows.data.xml.dom/xmlattribute_firstchild.md index 59d3a73d7d..d5751454b7 100644 --- a/windows.data.xml.dom/xmlattribute_firstchild.md +++ b/windows.data.xml.dom/xmlattribute_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_getxml_999931642.md b/windows.data.xml.dom/xmlattribute_getxml_999931642.md index 880fa69e8e..d595141750 100644 --- a/windows.data.xml.dom/xmlattribute_getxml_999931642.md +++ b/windows.data.xml.dom/xmlattribute_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_haschildnodes_464206014.md b/windows.data.xml.dom/xmlattribute_haschildnodes_464206014.md index 90b645ed18..a3ab95ac7d 100644 --- a/windows.data.xml.dom/xmlattribute_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmlattribute_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_innertext.md b/windows.data.xml.dom/xmlattribute_innertext.md index 9880473e81..0c24354cde 100644 --- a/windows.data.xml.dom/xmlattribute_innertext.md +++ b/windows.data.xml.dom/xmlattribute_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_insertbefore_88135496.md b/windows.data.xml.dom/xmlattribute_insertbefore_88135496.md index 522e0f6a97..195387888f 100644 --- a/windows.data.xml.dom/xmlattribute_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmlattribute_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the child node list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the child node list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_lastchild.md b/windows.data.xml.dom/xmlattribute_lastchild.md index 53645f0a04..f19715b1ee 100644 --- a/windows.data.xml.dom/xmlattribute_lastchild.md +++ b/windows.data.xml.dom/xmlattribute_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_localname.md b/windows.data.xml.dom/xmlattribute_localname.md index 0b24156a86..c49d96ff6e 100644 --- a/windows.data.xml.dom/xmlattribute_localname.md +++ b/windows.data.xml.dom/xmlattribute_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_name.md b/windows.data.xml.dom/xmlattribute_name.md index 34a7bac675..6842288c36 100644 --- a/windows.data.xml.dom/xmlattribute_name.md +++ b/windows.data.xml.dom/xmlattribute_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Name --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.Name ## -description Returns the attribute name. ## -property-value The attribute name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Name +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.Name + +## -description +Returns the attribute name. + +## -property-value +The attribute name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_namespaceuri.md b/windows.data.xml.dom/xmlattribute_namespaceuri.md index 01ee4c0404..058afe4747 100644 --- a/windows.data.xml.dom/xmlattribute_namespaceuri.md +++ b/windows.data.xml.dom/xmlattribute_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_nextsibling.md b/windows.data.xml.dom/xmlattribute_nextsibling.md index edb22e2fd5..f3b8f9984c 100644 --- a/windows.data.xml.dom/xmlattribute_nextsibling.md +++ b/windows.data.xml.dom/xmlattribute_nextsibling.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.NextSibling ## -description This property is not applicable to this class and will always return null. ## -property-value NULL ## -remarks Attribute objects inherit the Node interface, but are not actually child nodes of the element they describe and are not considered part of the document tree. Therefore this property will always return null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.NextSibling + +## -description +This property is not applicable to this class and will always return null. + +## -property-value +NULL + +## -remarks +Attribute objects inherit the Node interface, but are not actually child nodes of the element they describe and are not considered part of the document tree. Therefore this property will always return null. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_nodename.md b/windows.data.xml.dom/xmlattribute_nodename.md index 8b36f75738..a4ed5dd707 100644 --- a/windows.data.xml.dom/xmlattribute_nodename.md +++ b/windows.data.xml.dom/xmlattribute_nodename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_nodetype.md b/windows.data.xml.dom/xmlattribute_nodetype.md index eb82b3b162..d59f37bce4 100644 --- a/windows.data.xml.dom/xmlattribute_nodetype.md +++ b/windows.data.xml.dom/xmlattribute_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value This property always returns value **attributeNode**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +This property always returns value **attributeNode**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_nodevalue.md b/windows.data.xml.dom/xmlattribute_nodevalue.md index c20db9d529..c9418e3e50 100644 --- a/windows.data.xml.dom/xmlattribute_nodevalue.md +++ b/windows.data.xml.dom/xmlattribute_nodevalue.md @@ -1,3 +1,43 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks On retrieval, the value of this attribute is returned as a string. Character and general entity references are replaced with their values. On setting, this property creates a Text node with the unparsed contents of the string. This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +On retrieval, the value of this attribute is returned as a string. Character and general entity references are replaced with their values. + +On setting, this property creates a Text node with the unparsed contents of the string. + +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_normalize_347475160.md b/windows.data.xml.dom/xmlattribute_normalize_347475160.md index 7dcf3a081f..e8638e3d2a 100644 --- a/windows.data.xml.dom/xmlattribute_normalize_347475160.md +++ b/windows.data.xml.dom/xmlattribute_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.Normalize ## -description This method is not applicable to this class and will throw an exception. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.Normalize + +## -description +This method is not applicable to this class and will throw an exception. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_ownerdocument.md b/windows.data.xml.dom/xmlattribute_ownerdocument.md index 06fb148886..b5e13b938d 100644 --- a/windows.data.xml.dom/xmlattribute_ownerdocument.md +++ b/windows.data.xml.dom/xmlattribute_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_parentnode.md b/windows.data.xml.dom/xmlattribute_parentnode.md index 132a8b9cdb..068b32d540 100644 --- a/windows.data.xml.dom/xmlattribute_parentnode.md +++ b/windows.data.xml.dom/xmlattribute_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.ParentNode ## -description This property is not applicable to this class and will throw an exception. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.ParentNode + +## -description +This property is not applicable to this class and will throw an exception. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_prefix.md b/windows.data.xml.dom/xmlattribute_prefix.md index 3bceaede9d..a0445e725d 100644 --- a/windows.data.xml.dom/xmlattribute_prefix.md +++ b/windows.data.xml.dom/xmlattribute_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_previoussibling.md b/windows.data.xml.dom/xmlattribute_previoussibling.md index 26044b77cc..c8d9022548 100644 --- a/windows.data.xml.dom/xmlattribute_previoussibling.md +++ b/windows.data.xml.dom/xmlattribute_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.PreviousSibling ## -description This property is not applicable to this class and will throw an exception. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.PreviousSibling + +## -description +This property is not applicable to this class and will throw an exception. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_removechild_1165510615.md b/windows.data.xml.dom/xmlattribute_removechild_1165510615.md index 5d5c020cc3..ad78c6903b 100644 --- a/windows.data.xml.dom/xmlattribute_removechild_1165510615.md +++ b/windows.data.xml.dom/xmlattribute_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_replacechild_85158540.md b/windows.data.xml.dom/xmlattribute_replacechild_85158540.md index df94c8c9e1..61a1544fa5 100644 --- a/windows.data.xml.dom/xmlattribute_replacechild_85158540.md +++ b/windows.data.xml.dom/xmlattribute_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_selectnodes_71711491.md b/windows.data.xml.dom/xmlattribute_selectnodes_71711491.md index 460c89eb82..8491e2562e 100644 --- a/windows.data.xml.dom/xmlattribute_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmlattribute_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_selectnodesns_2126476717.md b/windows.data.xml.dom/xmlattribute_selectnodesns_2126476717.md index 88560503ce..68e51ccf6a 100644 --- a/windows.data.xml.dom/xmlattribute_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmlattribute_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expresssion. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expresssion. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmlattribute_selectsinglenode_1817002489.md index 86eed00018..15e852488c 100644 --- a/windows.data.xml.dom/xmlattribute_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmlattribute_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmlattribute_selectsinglenodens_1164847996.md index ba8ea1d2f1..f160ce3b01 100644 --- a/windows.data.xml.dom/xmlattribute_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmlattribute_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_specified.md b/windows.data.xml.dom/xmlattribute_specified.md index b27ffb4ef8..e9f7bbc29e 100644 --- a/windows.data.xml.dom/xmlattribute_specified.md +++ b/windows.data.xml.dom/xmlattribute_specified.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Specified --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.Specified ## -description Gets a value that indicates whether the attribute is explicitly specified or derived from a default value in the document type definition (DTD) or schema. ## -property-value True if the attribute is explicitly specified; false if the attribute is derived from a default value. ## -remarks If you change the value of the attribute (even if it has the same value as the default value) then this property is automatically set to true. To re-specify the attribute as the default value from the DTD, you must delete the attribute. The implementation will then make a new attribute available with this property set to false and the default value (if one exists). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Specified +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.Specified + +## -description +Gets a value that indicates whether the attribute is explicitly specified or derived from a default value in the document type definition (DTD) or schema. + +## -property-value +True if the attribute is explicitly specified; false if the attribute is derived from a default value. + +## -remarks +If you change the value of the attribute (even if it has the same value as the default value) then this property is automatically set to true. To re-specify the attribute as the default value from the DTD, you must delete the attribute. The implementation will then make a new attribute available with this property set to false and the default value (if one exists). + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlattribute_value.md b/windows.data.xml.dom/xmlattribute_value.md index 1e2fbf0900..a53fdc1a6e 100644 --- a/windows.data.xml.dom/xmlattribute_value.md +++ b/windows.data.xml.dom/xmlattribute_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Value --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlAttribute.Value ## -description Gets or sets the attribute value. ## -property-value The attribute value. ## -remarks When the value is retrieved, it is returned as a string. When the value is set, a text node is created with the unparsed contents of the string provided. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlAttribute.Value +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlAttribute.Value + +## -description +Gets or sets the attribute value. + +## -property-value +The attribute value. + +## -remarks +When the value is retrieved, it is returned as a string. When the value is set, a text node is created with the unparsed contents of the string provided. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_appendchild_1014377324.md b/windows.data.xml.dom/xmlcdatasection_appendchild_1014377324.md index 9deea43586..f219d6eb51 100644 --- a/windows.data.xml.dom/xmlcdatasection_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmlcdatasection_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.AppendChild ## -description This method is not applicable to this class. The CDataSection does not have children. This method will throw an exception. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.AppendChild + +## -description +This method is not applicable to this class. The CDataSection does not have children. This method will throw an exception. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_appenddata_1408952063.md b/windows.data.xml.dom/xmlcdatasection_appenddata_1408952063.md index 32f8af364d..03a6c7dc11 100644 --- a/windows.data.xml.dom/xmlcdatasection_appenddata_1408952063.md +++ b/windows.data.xml.dom/xmlcdatasection_appenddata_1408952063.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.AppendData(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.AppendData ## -description Appends the supplied string to the existing string data. ## -parameters ### -param data The data to be appended to the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.AppendData(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.AppendData + +## -description +Appends the supplied string to the existing string data. + +## -parameters +### -param data +The data to be appended to the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_attributes.md b/windows.data.xml.dom/xmlcdatasection_attributes.md index 4073e106d8..35f1d757dd 100644 --- a/windows.data.xml.dom/xmlcdatasection_attributes.md +++ b/windows.data.xml.dom/xmlcdatasection_attributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_childnodes.md b/windows.data.xml.dom/xmlcdatasection_childnodes.md index e584db263c..2f012053e4 100644 --- a/windows.data.xml.dom/xmlcdatasection_childnodes.md +++ b/windows.data.xml.dom/xmlcdatasection_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.ChildNodes ## -description Gets a list of children in the current node. This property always returns NULL. ## -property-value This property always returns NULL. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.ChildNodes + +## -description +Gets a list of children in the current node. This property always returns NULL. + +## -property-value +This property always returns NULL. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_clonenode_554530370.md b/windows.data.xml.dom/xmlcdatasection_clonenode_554530370.md index 516c56243f..4273109d71 100644 --- a/windows.data.xml.dom/xmlcdatasection_clonenode_554530370.md +++ b/windows.data.xml.dom/xmlcdatasection_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_data.md b/windows.data.xml.dom/xmlcdatasection_data.md index 263ffb0023..3a179f4c0b 100644 --- a/windows.data.xml.dom/xmlcdatasection_data.md +++ b/windows.data.xml.dom/xmlcdatasection_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Data --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.Data ## -description Gets or sets the node data depending on the node type. ## -property-value The node data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Data +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.Data + +## -description +Gets or sets the node data depending on the node type. + +## -property-value +The node data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_deletedata_1339091348.md b/windows.data.xml.dom/xmlcdatasection_deletedata_1339091348.md index 4d9d4be8be..bf9a4692c5 100644 --- a/windows.data.xml.dom/xmlcdatasection_deletedata_1339091348.md +++ b/windows.data.xml.dom/xmlcdatasection_deletedata_1339091348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.DeleteData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.DeleteData ## -description Deletes specified data. ## -parameters ### -param offset The offset, in characters, at which to start deleting the string data. ### -param count The number of characters to delete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.DeleteData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.DeleteData + +## -description +Deletes specified data. + +## -parameters +### -param offset +The offset, in characters, at which to start deleting the string data. + +### -param count +The number of characters to delete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_firstchild.md b/windows.data.xml.dom/xmlcdatasection_firstchild.md index 69ff330e26..81ae596fc1 100644 --- a/windows.data.xml.dom/xmlcdatasection_firstchild.md +++ b/windows.data.xml.dom/xmlcdatasection_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.FirstChild ## -description Gets the first child node. This property always returns NULL. ## -property-value The first child node. This property always returns NULL. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.FirstChild + +## -description +Gets the first child node. This property always returns NULL. + +## -property-value +The first child node. This property always returns NULL. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_getxml_999931642.md b/windows.data.xml.dom/xmlcdatasection_getxml_999931642.md index 1c56d4cc7b..5b4cbc50ba 100644 --- a/windows.data.xml.dom/xmlcdatasection_getxml_999931642.md +++ b/windows.data.xml.dom/xmlcdatasection_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_haschildnodes_464206014.md b/windows.data.xml.dom/xmlcdatasection_haschildnodes_464206014.md index 4c484df892..f9cd32a5a8 100644 --- a/windows.data.xml.dom/xmlcdatasection_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmlcdatasection_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.HasChildNodes ## -description Determines whether a node has children. The CDataSection does not have children. This method always returns false. ## -returns True if this node has children; otherwise false. This method always returns false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.HasChildNodes + +## -description +Determines whether a node has children. The CDataSection does not have children. This method always returns false. + +## -returns +True if this node has children; otherwise false. This method always returns false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_innertext.md b/windows.data.xml.dom/xmlcdatasection_innertext.md index 39fb22b064..b3799a14a4 100644 --- a/windows.data.xml.dom/xmlcdatasection_innertext.md +++ b/windows.data.xml.dom/xmlcdatasection_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_insertbefore_88135496.md b/windows.data.xml.dom/xmlcdatasection_insertbefore_88135496.md index c062a33c3b..e1fe083047 100644 --- a/windows.data.xml.dom/xmlcdatasection_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmlcdatasection_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the child node list. This method is not applicable to this class and will throw an exception. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the child node list. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_insertdata_1015561500.md b/windows.data.xml.dom/xmlcdatasection_insertdata_1015561500.md index cee1ccac72..a9be22c2db 100644 --- a/windows.data.xml.dom/xmlcdatasection_insertdata_1015561500.md +++ b/windows.data.xml.dom/xmlcdatasection_insertdata_1015561500.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.InsertData(System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.InsertData ## -description Inserts a string at the specified offset. ## -parameters ### -param offset The offset, in characters, at which to insert the supplied string data. ### -param data The data to be inserted into the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.InsertData(System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.InsertData + +## -description +Inserts a string at the specified offset. + +## -parameters +### -param offset +The offset, in characters, at which to insert the supplied string data. + +### -param data +The data to be inserted into the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_lastchild.md b/windows.data.xml.dom/xmlcdatasection_lastchild.md index f9a19b0037..d7ea981d1c 100644 --- a/windows.data.xml.dom/xmlcdatasection_lastchild.md +++ b/windows.data.xml.dom/xmlcdatasection_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.LastChild ## -description Gets the last child node. This property always returns NULL because the CDataSection does not have children. ## -property-value The last child node. This property is always NULL. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.LastChild + +## -description +Gets the last child node. This property always returns NULL because the CDataSection does not have children. + +## -property-value +The last child node. This property is always NULL. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_length.md b/windows.data.xml.dom/xmlcdatasection_length.md index c3aa4a8301..618698888f 100644 --- a/windows.data.xml.dom/xmlcdatasection_length.md +++ b/windows.data.xml.dom/xmlcdatasection_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Length --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.Length ## -description Gets the length of the data, in Unicode characters. ## -property-value The length of the data, in Unicode characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Length +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.Length + +## -description +Gets the length of the data, in Unicode characters. + +## -property-value +The length of the data, in Unicode characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_localname.md b/windows.data.xml.dom/xmlcdatasection_localname.md index 5266de2235..40a2057b43 100644 --- a/windows.data.xml.dom/xmlcdatasection_localname.md +++ b/windows.data.xml.dom/xmlcdatasection_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_namespaceuri.md b/windows.data.xml.dom/xmlcdatasection_namespaceuri.md index 8cbbbbd223..ad64d673eb 100644 --- a/windows.data.xml.dom/xmlcdatasection_namespaceuri.md +++ b/windows.data.xml.dom/xmlcdatasection_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_nextsibling.md b/windows.data.xml.dom/xmlcdatasection_nextsibling.md index 8f089ef391..8e5ef3f066 100644 --- a/windows.data.xml.dom/xmlcdatasection_nextsibling.md +++ b/windows.data.xml.dom/xmlcdatasection_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_nodename.md b/windows.data.xml.dom/xmlcdatasection_nodename.md index c3646cd3ff..74f322b88d 100644 --- a/windows.data.xml.dom/xmlcdatasection_nodename.md +++ b/windows.data.xml.dom/xmlcdatasection_nodename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_nodetype.md b/windows.data.xml.dom/xmlcdatasection_nodetype.md index ca5ef6b5bc..6868e6041b 100644 --- a/windows.data.xml.dom/xmlcdatasection_nodetype.md +++ b/windows.data.xml.dom/xmlcdatasection_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_nodevalue.md b/windows.data.xml.dom/xmlcdatasection_nodevalue.md index d6f3d1689f..d91dba3e1b 100644 --- a/windows.data.xml.dom/xmlcdatasection_nodevalue.md +++ b/windows.data.xml.dom/xmlcdatasection_nodevalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_normalize_347475160.md b/windows.data.xml.dom/xmlcdatasection_normalize_347475160.md index 8ca9f73d75..1fd31e190f 100644 --- a/windows.data.xml.dom/xmlcdatasection_normalize_347475160.md +++ b/windows.data.xml.dom/xmlcdatasection_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_ownerdocument.md b/windows.data.xml.dom/xmlcdatasection_ownerdocument.md index 12967d3642..0dfbf4cbd4 100644 --- a/windows.data.xml.dom/xmlcdatasection_ownerdocument.md +++ b/windows.data.xml.dom/xmlcdatasection_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_parentnode.md b/windows.data.xml.dom/xmlcdatasection_parentnode.md index 3ff7f8fe74..0e3c04eaee 100644 --- a/windows.data.xml.dom/xmlcdatasection_parentnode.md +++ b/windows.data.xml.dom/xmlcdatasection_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_prefix.md b/windows.data.xml.dom/xmlcdatasection_prefix.md index 7f30e38543..20c9429e0a 100644 --- a/windows.data.xml.dom/xmlcdatasection_prefix.md +++ b/windows.data.xml.dom/xmlcdatasection_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_previoussibling.md b/windows.data.xml.dom/xmlcdatasection_previoussibling.md index aca0901ffe..0ef63ab390 100644 --- a/windows.data.xml.dom/xmlcdatasection_previoussibling.md +++ b/windows.data.xml.dom/xmlcdatasection_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlCDataSection.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlCDataSection.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_removechild_1165510615.md b/windows.data.xml.dom/xmlcdatasection_removechild_1165510615.md index 8f57e55875..b380fc145b 100644 --- a/windows.data.xml.dom/xmlcdatasection_removechild_1165510615.md +++ b/windows.data.xml.dom/xmlcdatasection_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.RemoveChild ## -description Removes the specified child node from the list of children and returns it. This method is not applicable to this class as the CDataSection does not have children. This method will throw an exception. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. This method is not applicable to this class as the CDataSection does not have children. This method will throw an exception. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_replacechild_85158540.md b/windows.data.xml.dom/xmlcdatasection_replacechild_85158540.md index c02f8b0133..dd1a62a43b 100644 --- a/windows.data.xml.dom/xmlcdatasection_replacechild_85158540.md +++ b/windows.data.xml.dom/xmlcdatasection_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. This method is not applicable to this class as the CDataSection does not have children. This method will throw an exception. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. This method is not applicable to this class as the CDataSection does not have children. This method will throw an exception. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_replacedata_1060591057.md b/windows.data.xml.dom/xmlcdatasection_replacedata_1060591057.md index 6d431e17d7..c582ebf4d3 100644 --- a/windows.data.xml.dom/xmlcdatasection_replacedata_1060591057.md +++ b/windows.data.xml.dom/xmlcdatasection_replacedata_1060591057.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.ReplaceData(System.UInt32,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.ReplaceData ## -description Replaces the specified number of characters with the supplied string. ## -parameters ### -param offset The offset, in characters, at which to start replacing string data. ### -param count The number of characters to replace. ### -param data The new data that replaces the old string data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.ReplaceData(System.UInt32,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.ReplaceData + +## -description +Replaces the specified number of characters with the supplied string. + +## -parameters +### -param offset +The offset, in characters, at which to start replacing string data. + +### -param count +The number of characters to replace. + +### -param data +The new data that replaces the old string data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_selectnodes_71711491.md b/windows.data.xml.dom/xmlcdatasection_selectnodes_71711491.md index 4f41967424..c5ddcf22fc 100644 --- a/windows.data.xml.dom/xmlcdatasection_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmlcdatasection_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_selectnodesns_2126476717.md b/windows.data.xml.dom/xmlcdatasection_selectnodesns_2126476717.md index f291417cf5..85b025bc14 100644 --- a/windows.data.xml.dom/xmlcdatasection_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmlcdatasection_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expresssion. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expresssion. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmlcdatasection_selectsinglenode_1817002489.md index 1d5c093202..c8b461f5bd 100644 --- a/windows.data.xml.dom/xmlcdatasection_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmlcdatasection_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmlcdatasection_selectsinglenodens_1164847996.md index 0b307cacd1..9d2ae221c6 100644 --- a/windows.data.xml.dom/xmlcdatasection_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmlcdatasection_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_splittext_1458849685.md b/windows.data.xml.dom/xmlcdatasection_splittext_1458849685.md index 61c75ffd97..7c635f6d05 100644 --- a/windows.data.xml.dom/xmlcdatasection_splittext_1458849685.md +++ b/windows.data.xml.dom/xmlcdatasection_splittext_1458849685.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SplitText(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.SplitText ## -description Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node. ## -parameters ### -param offset The number of characters at which to split this text node into two nodes, starting from zero. ## -returns The new text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SplitText(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.SplitText + +## -description +Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node. + +## -parameters +### -param offset +The number of characters at which to split this text node into two nodes, starting from zero. + +## -returns +The new text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcdatasection_substringdata_67214485.md b/windows.data.xml.dom/xmlcdatasection_substringdata_67214485.md index 67ae6317c1..bb462f6384 100644 --- a/windows.data.xml.dom/xmlcdatasection_substringdata_67214485.md +++ b/windows.data.xml.dom/xmlcdatasection_substringdata_67214485.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SubstringData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlCDataSection.SubstringData ## -description Retrieves a substring of the full string from the specified range. ## -parameters ### -param offset Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. ### -param count Specifies the number of characters to retrieve from the specified offset. ## -returns The returned substring. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlCDataSection.SubstringData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlCDataSection.SubstringData + +## -description +Retrieves a substring of the full string from the specified range. + +## -parameters +### -param offset +Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. + +### -param count +Specifies the number of characters to retrieve from the specified offset. + +## -returns +The returned substring. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_appendchild_1014377324.md b/windows.data.xml.dom/xmlcomment_appendchild_1014377324.md index e04a55a0fb..abc4155379 100644 --- a/windows.data.xml.dom/xmlcomment_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmlcomment_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.AppendChild ## -description Appends a new child node as the last child of the node. This method is not applicable to this class and it will throw an exception. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.AppendChild + +## -description +Appends a new child node as the last child of the node. This method is not applicable to this class and it will throw an exception. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_appenddata_1408952063.md b/windows.data.xml.dom/xmlcomment_appenddata_1408952063.md index 2135ab19c4..ccce2801a2 100644 --- a/windows.data.xml.dom/xmlcomment_appenddata_1408952063.md +++ b/windows.data.xml.dom/xmlcomment_appenddata_1408952063.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.AppendData(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.AppendData ## -description Appends the supplied string to the existing string data. ## -parameters ### -param data The data to be appended to the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.AppendData(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.AppendData + +## -description +Appends the supplied string to the existing string data. + +## -parameters +### -param data +The data to be appended to the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_attributes.md b/windows.data.xml.dom/xmlcomment_attributes.md index 40edf57030..896f39c916 100644 --- a/windows.data.xml.dom/xmlcomment_attributes.md +++ b/windows.data.xml.dom/xmlcomment_attributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_childnodes.md b/windows.data.xml.dom/xmlcomment_childnodes.md index 7093416bd7..19b8e7b179 100644 --- a/windows.data.xml.dom/xmlcomment_childnodes.md +++ b/windows.data.xml.dom/xmlcomment_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.ChildNodes ## -description Gets a list of children in the current node. This method always returns NULL. ## -property-value The list of child nodes. This value is always NULL. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.ChildNodes + +## -description +Gets a list of children in the current node. This method always returns NULL. + +## -property-value +The list of child nodes. This value is always NULL. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_clonenode_554530370.md b/windows.data.xml.dom/xmlcomment_clonenode_554530370.md index 4b38820fd0..ba46e60e31 100644 --- a/windows.data.xml.dom/xmlcomment_clonenode_554530370.md +++ b/windows.data.xml.dom/xmlcomment_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_data.md b/windows.data.xml.dom/xmlcomment_data.md index 0b9c38c342..0ebca79e53 100644 --- a/windows.data.xml.dom/xmlcomment_data.md +++ b/windows.data.xml.dom/xmlcomment_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.Data --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.Data ## -description Gets or sets the node data depending on the node type. ## -property-value The node data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.Data +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.Data + +## -description +Gets or sets the node data depending on the node type. + +## -property-value +The node data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_deletedata_1339091348.md b/windows.data.xml.dom/xmlcomment_deletedata_1339091348.md index a5b82ba417..c6361765a9 100644 --- a/windows.data.xml.dom/xmlcomment_deletedata_1339091348.md +++ b/windows.data.xml.dom/xmlcomment_deletedata_1339091348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.DeleteData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.DeleteData ## -description Deletes the specified data. ## -parameters ### -param offset The offset, in characters, at which to start deleting the string data. ### -param count The number of characters to delete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.DeleteData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.DeleteData + +## -description +Deletes the specified data. + +## -parameters +### -param offset +The offset, in characters, at which to start deleting the string data. + +### -param count +The number of characters to delete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_firstchild.md b/windows.data.xml.dom/xmlcomment_firstchild.md index b2375ea05c..d154ec864e 100644 --- a/windows.data.xml.dom/xmlcomment_firstchild.md +++ b/windows.data.xml.dom/xmlcomment_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.FirstChild ## -description Gets the first child node. This property always returns NULL. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.FirstChild + +## -description +Gets the first child node. This property always returns NULL. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_getxml_999931642.md b/windows.data.xml.dom/xmlcomment_getxml_999931642.md index e2ea5c2d18..8de5858532 100644 --- a/windows.data.xml.dom/xmlcomment_getxml_999931642.md +++ b/windows.data.xml.dom/xmlcomment_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_haschildnodes_464206014.md b/windows.data.xml.dom/xmlcomment_haschildnodes_464206014.md index 8fdf9b87a4..5423a0d543 100644 --- a/windows.data.xml.dom/xmlcomment_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmlcomment_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_innertext.md b/windows.data.xml.dom/xmlcomment_innertext.md index 5a184304ca..5643b05269 100644 --- a/windows.data.xml.dom/xmlcomment_innertext.md +++ b/windows.data.xml.dom/xmlcomment_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_insertbefore_88135496.md b/windows.data.xml.dom/xmlcomment_insertbefore_88135496.md index b7ec15255d..b5a0a666dc 100644 --- a/windows.data.xml.dom/xmlcomment_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmlcomment_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. This method is not applicable to this class and will throw an exception. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_insertdata_1015561500.md b/windows.data.xml.dom/xmlcomment_insertdata_1015561500.md index 19ea8e2e03..831d9cfd0c 100644 --- a/windows.data.xml.dom/xmlcomment_insertdata_1015561500.md +++ b/windows.data.xml.dom/xmlcomment_insertdata_1015561500.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.InsertData(System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.InsertData ## -description Inserts a string at the specified offset. ## -parameters ### -param offset The offset, in characters, at which to insert the supplied string data. ### -param data The data to be inserted into the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.InsertData(System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.InsertData + +## -description +Inserts a string at the specified offset. + +## -parameters +### -param offset +The offset, in characters, at which to insert the supplied string data. + +### -param data +The data to be inserted into the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_lastchild.md b/windows.data.xml.dom/xmlcomment_lastchild.md index 985a1c8eae..a41c889c45 100644 --- a/windows.data.xml.dom/xmlcomment_lastchild.md +++ b/windows.data.xml.dom/xmlcomment_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.LastChild ## -description Gets the last child node. This property always returns NULL. ## -property-value The last child node. This property always returns NULL. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.LastChild + +## -description +Gets the last child node. This property always returns NULL. + +## -property-value +The last child node. This property always returns NULL. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_length.md b/windows.data.xml.dom/xmlcomment_length.md index c874e38099..82559c93a8 100644 --- a/windows.data.xml.dom/xmlcomment_length.md +++ b/windows.data.xml.dom/xmlcomment_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.Length --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.Length ## -description Gets the length of the data in Unicode characters. ## -property-value The length of the data, in Unicode characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.Length +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.Length + +## -description +Gets the length of the data in Unicode characters. + +## -property-value +The length of the data, in Unicode characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_localname.md b/windows.data.xml.dom/xmlcomment_localname.md index 76f32c32f6..3724f728c2 100644 --- a/windows.data.xml.dom/xmlcomment_localname.md +++ b/windows.data.xml.dom/xmlcomment_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_namespaceuri.md b/windows.data.xml.dom/xmlcomment_namespaceuri.md index 4cffa72d47..5da006e138 100644 --- a/windows.data.xml.dom/xmlcomment_namespaceuri.md +++ b/windows.data.xml.dom/xmlcomment_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_nextsibling.md b/windows.data.xml.dom/xmlcomment_nextsibling.md index 7bf8382bae..4d103ac8a8 100644 --- a/windows.data.xml.dom/xmlcomment_nextsibling.md +++ b/windows.data.xml.dom/xmlcomment_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_nodename.md b/windows.data.xml.dom/xmlcomment_nodename.md index 2fd64ce9dc..2a1a135d69 100644 --- a/windows.data.xml.dom/xmlcomment_nodename.md +++ b/windows.data.xml.dom/xmlcomment_nodename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_nodetype.md b/windows.data.xml.dom/xmlcomment_nodetype.md index ed64cbed37..6305590b22 100644 --- a/windows.data.xml.dom/xmlcomment_nodetype.md +++ b/windows.data.xml.dom/xmlcomment_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_nodevalue.md b/windows.data.xml.dom/xmlcomment_nodevalue.md index 8190b9e689..dc1bafb94e 100644 --- a/windows.data.xml.dom/xmlcomment_nodevalue.md +++ b/windows.data.xml.dom/xmlcomment_nodevalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value Gets or sets the text associated with the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +Gets or sets the text associated with the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_normalize_347475160.md b/windows.data.xml.dom/xmlcomment_normalize_347475160.md index c5edbb4437..13c0b56a76 100644 --- a/windows.data.xml.dom/xmlcomment_normalize_347475160.md +++ b/windows.data.xml.dom/xmlcomment_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_ownerdocument.md b/windows.data.xml.dom/xmlcomment_ownerdocument.md index 4562491837..411ca07d37 100644 --- a/windows.data.xml.dom/xmlcomment_ownerdocument.md +++ b/windows.data.xml.dom/xmlcomment_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_parentnode.md b/windows.data.xml.dom/xmlcomment_parentnode.md index b4737b29ea..017c3dd7cb 100644 --- a/windows.data.xml.dom/xmlcomment_parentnode.md +++ b/windows.data.xml.dom/xmlcomment_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_prefix.md b/windows.data.xml.dom/xmlcomment_prefix.md index 6b4245c2f4..4aa8b2e418 100644 --- a/windows.data.xml.dom/xmlcomment_prefix.md +++ b/windows.data.xml.dom/xmlcomment_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_previoussibling.md b/windows.data.xml.dom/xmlcomment_previoussibling.md index 1f9e72e4f6..a8152fe682 100644 --- a/windows.data.xml.dom/xmlcomment_previoussibling.md +++ b/windows.data.xml.dom/xmlcomment_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlComment.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlComment.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlComment.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlComment.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_removechild_1165510615.md b/windows.data.xml.dom/xmlcomment_removechild_1165510615.md index 7527887e81..f0071c52a7 100644 --- a/windows.data.xml.dom/xmlcomment_removechild_1165510615.md +++ b/windows.data.xml.dom/xmlcomment_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.RemoveChild ## -description Removes the specified child node from the list of children and returns it. This method is not applicable to this class and will throw an exception. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_replacechild_85158540.md b/windows.data.xml.dom/xmlcomment_replacechild_85158540.md index a73a71facf..84fbaa9019 100644 --- a/windows.data.xml.dom/xmlcomment_replacechild_85158540.md +++ b/windows.data.xml.dom/xmlcomment_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. This method is not applicable to this class and will throw an exception. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_replacedata_1060591057.md b/windows.data.xml.dom/xmlcomment_replacedata_1060591057.md index 5ba1baf355..240abee921 100644 --- a/windows.data.xml.dom/xmlcomment_replacedata_1060591057.md +++ b/windows.data.xml.dom/xmlcomment_replacedata_1060591057.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.ReplaceData(System.UInt32,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.ReplaceData ## -description Replaces the specified number of characters with the supplied string. ## -parameters ### -param offset The offset, in characters, at which to start replacing string data. ### -param count The number of characters to replace. ### -param data The new data that replaces the old string data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.ReplaceData(System.UInt32,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.ReplaceData + +## -description +Replaces the specified number of characters with the supplied string. + +## -parameters +### -param offset +The offset, in characters, at which to start replacing string data. + +### -param count +The number of characters to replace. + +### -param data +The new data that replaces the old string data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_selectnodes_71711491.md b/windows.data.xml.dom/xmlcomment_selectnodes_71711491.md index 4795b9f657..26ec8cae91 100644 --- a/windows.data.xml.dom/xmlcomment_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmlcomment_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_selectnodesns_2126476717.md b/windows.data.xml.dom/xmlcomment_selectnodesns_2126476717.md index ea58471a7d..068b1e3d7a 100644 --- a/windows.data.xml.dom/xmlcomment_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmlcomment_selectnodesns_2126476717.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expresssion. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expresssion. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmlcomment_selectsinglenode_1817002489.md index 47a4e3aac7..d3d78d68f7 100644 --- a/windows.data.xml.dom/xmlcomment_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmlcomment_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmlcomment_selectsinglenodens_1164847996.md index 7fbb69bf53..1c23327733 100644 --- a/windows.data.xml.dom/xmlcomment_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmlcomment_selectsinglenodens_1164847996.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlcomment_substringdata_67214485.md b/windows.data.xml.dom/xmlcomment_substringdata_67214485.md index b2455daa99..51f1fa5222 100644 --- a/windows.data.xml.dom/xmlcomment_substringdata_67214485.md +++ b/windows.data.xml.dom/xmlcomment_substringdata_67214485.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlComment.SubstringData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlComment.SubstringData ## -description Retrieves a substring of the full string from the specified range. ## -parameters ### -param offset Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. ### -param count Specifies the number of characters to retrieve from the specified offset. ## -returns The returned substring. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlComment.SubstringData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlComment.SubstringData + +## -description +Retrieves a substring of the full string from the specified range. + +## -parameters +### -param offset +Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. + +### -param count +Specifies the number of characters to retrieve from the specified offset. + +## -returns +The returned substring. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_appendchild_1014377324.md b/windows.data.xml.dom/xmldocument_appendchild_1014377324.md index fd5784c4d5..f6d7ac4eed 100644 --- a/windows.data.xml.dom/xmldocument_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmldocument_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_attributes.md b/windows.data.xml.dom/xmldocument_attributes.md index c608628cec..12d74857a0 100644 --- a/windows.data.xml.dom/xmldocument_attributes.md +++ b/windows.data.xml.dom/xmldocument_attributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_childnodes.md b/windows.data.xml.dom/xmldocument_childnodes.md index 6a3b94048e..c2c3412696 100644 --- a/windows.data.xml.dom/xmldocument_childnodes.md +++ b/windows.data.xml.dom/xmldocument_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_clonenode_554530370.md b/windows.data.xml.dom/xmldocument_clonenode_554530370.md index e787a4278b..41097258f1 100644 --- a/windows.data.xml.dom/xmldocument_clonenode_554530370.md +++ b/windows.data.xml.dom/xmldocument_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createattribute_1125729955.md b/windows.data.xml.dom/xmldocument_createattribute_1125729955.md index aefdd3a592..23b44d3c1b 100644 --- a/windows.data.xml.dom/xmldocument_createattribute_1125729955.md +++ b/windows.data.xml.dom/xmldocument_createattribute_1125729955.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateAttribute(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateAttribute ## -description Creates a new attribute with the specified name. ## -parameters ### -param name The name of the new attribute object. This name is subsequently available as the new node's [NodeName](xmlattribute_nodename.md) property. ## -returns The newly created attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateAttribute(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateAttribute + +## -description +Creates a new attribute with the specified name. + +## -parameters +### -param name +The name of the new attribute object. This name is subsequently available as the new node's [NodeName](xmlattribute_nodename.md) property. + +## -returns +The newly created attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createattributens_84639206.md b/windows.data.xml.dom/xmldocument_createattributens_84639206.md index ab90249cac..8fbd666a1d 100644 --- a/windows.data.xml.dom/xmldocument_createattributens_84639206.md +++ b/windows.data.xml.dom/xmldocument_createattributens_84639206.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateAttributeNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateAttributeNS ## -description Creates a new attribute with the specified namespace and name. ## -parameters ### -param namespaceUri The name of the desired namespace or a null value if no namespace is desired. ### -param qualifiedName The name of the new attribute object. This name is subsequently available as the new node's [NodeName](xmlattribute_nodename.md) property. ## -returns The newly created attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateAttributeNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateAttributeNS + +## -description +Creates a new attribute with the specified namespace and name. + +## -parameters +### -param namespaceUri +The name of the desired namespace or a null value if no namespace is desired. + +### -param qualifiedName +The name of the new attribute object. This name is subsequently available as the new node's [NodeName](xmlattribute_nodename.md) property. + +## -returns +The newly created attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createcdatasection_1089116649.md b/windows.data.xml.dom/xmldocument_createcdatasection_1089116649.md index d3f0fc5c40..133f7aec5d 100644 --- a/windows.data.xml.dom/xmldocument_createcdatasection_1089116649.md +++ b/windows.data.xml.dom/xmldocument_createcdatasection_1089116649.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateCDataSection(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateCDataSection ## -description Creates a CDATA section node that contains the supplied data. ## -parameters ### -param data The value to be supplied to the new CDATA section object's [NodeValue](xmlcdatasection_nodevalue.md) property. ## -returns The newly created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateCDataSection(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateCDataSection + +## -description +Creates a CDATA section node that contains the supplied data. + +## -parameters +### -param data +The value to be supplied to the new CDATA section object's [NodeValue](xmlcdatasection_nodevalue.md) property. + +## -returns +The newly created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createcomment_213989097.md b/windows.data.xml.dom/xmldocument_createcomment_213989097.md index afd13204a9..5e685d4876 100644 --- a/windows.data.xml.dom/xmldocument_createcomment_213989097.md +++ b/windows.data.xml.dom/xmldocument_createcomment_213989097.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateComment(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateComment ## -description Creates a comment node that contains the supplied data. ## -parameters ### -param data The value to be supplied to the new comment object's [NodeValue](xmlcomment_nodevalue.md). ## -returns The newly created comment node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateComment(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateComment + +## -description +Creates a comment node that contains the supplied data. + +## -parameters +### -param data +The value to be supplied to the new comment object's [NodeValue](xmlcomment_nodevalue.md). + +## -returns +The newly created comment node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createdocumentfragment_1713030076.md b/windows.data.xml.dom/xmldocument_createdocumentfragment_1713030076.md index 819e06c025..d35bcbbc9f 100644 --- a/windows.data.xml.dom/xmldocument_createdocumentfragment_1713030076.md +++ b/windows.data.xml.dom/xmldocument_createdocumentfragment_1713030076.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateDocumentFragment --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateDocumentFragment ## -description Creates an empty [XmlDocumentFragment](xmldocumentfragment.md) object. ## -returns The newly created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateDocumentFragment +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateDocumentFragment + +## -description +Creates an empty [XmlDocumentFragment](xmldocumentfragment.md) object. + +## -returns +The newly created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createelement_750938135.md b/windows.data.xml.dom/xmldocument_createelement_750938135.md index 97e1327979..8835945f96 100644 --- a/windows.data.xml.dom/xmldocument_createelement_750938135.md +++ b/windows.data.xml.dom/xmldocument_createelement_750938135.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateElement(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateElement ## -description Creates an element node using the specified name. ## -parameters ### -param tagName The name for the new element node. The string is case-sensitive. This name is subsequently available as the element node's [NodeName](xmlelement_nodename.md) property. ## -returns The newly created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateElement(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateElement + +## -description +Creates an element node using the specified name. + +## -parameters +### -param tagName +The name for the new element node. The string is case-sensitive. This name is subsequently available as the element node's [NodeName](xmlelement_nodename.md) property. + +## -returns +The newly created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createelementns_1302649478.md b/windows.data.xml.dom/xmldocument_createelementns_1302649478.md index 87e754c0da..c42cee5f5a 100644 --- a/windows.data.xml.dom/xmldocument_createelementns_1302649478.md +++ b/windows.data.xml.dom/xmldocument_createelementns_1302649478.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateElementNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateElementNS ## -description Creates an element node using the specified namespace and name. ## -parameters ### -param namespaceUri The name of the desired namespace or a null value if no namespace is desired. ### -param qualifiedName The name for the new element node. It is case-sensitive. This name is subsequently available as the element node's [NodeName](xmlelement_nodename.md) property. ## -returns The newly created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateElementNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateElementNS + +## -description +Creates an element node using the specified namespace and name. + +## -parameters +### -param namespaceUri +The name of the desired namespace or a null value if no namespace is desired. + +### -param qualifiedName +The name for the new element node. It is case-sensitive. This name is subsequently available as the element node's [NodeName](xmlelement_nodename.md) property. + +## -returns +The newly created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createentityreference_14539518.md b/windows.data.xml.dom/xmldocument_createentityreference_14539518.md index e85f55ccd8..aacf510a76 100644 --- a/windows.data.xml.dom/xmldocument_createentityreference_14539518.md +++ b/windows.data.xml.dom/xmldocument_createentityreference_14539518.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateEntityReference(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateEntityReference ## -description Creates a new [XmlEntityReference](xmlentityreference.md) object. ## -parameters ### -param name The name of the entity referenced. This name is subsequently available as the new object's [NodeName](xmlelement_nodename.md) property. ## -returns The newly created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateEntityReference(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateEntityReference + +## -description +Creates a new [XmlEntityReference](xmlentityreference.md) object. + +## -parameters +### -param name +The name of the entity referenced. This name is subsequently available as the new object's [NodeName](xmlelement_nodename.md) property. + +## -returns +The newly created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createprocessinginstruction_455863903.md b/windows.data.xml.dom/xmldocument_createprocessinginstruction_455863903.md index 93fbff1366..b8e8d7470f 100644 --- a/windows.data.xml.dom/xmldocument_createprocessinginstruction_455863903.md +++ b/windows.data.xml.dom/xmldocument_createprocessinginstruction_455863903.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateProcessingInstruction(System.String,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateProcessingInstruction ## -description Creates a processing instruction node that contains the supplied target and data. ## -parameters ### -param target The target part of the processing instruction. It supplies the [NodeName](xmlprocessinginstruction_nodename.md) property of the new object. ### -param data The remainder of the processing instruction preceding the closing** ?>** characters. It supplies the [NodeValue](xmlprocessinginstruction_nodevalue.md) property for the new object. ## -returns The newly created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateProcessingInstruction(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateProcessingInstruction + +## -description +Creates a processing instruction node that contains the supplied target and data. + +## -parameters +### -param target +The target part of the processing instruction. It supplies the [NodeName](xmlprocessinginstruction_nodename.md) property of the new object. + +### -param data +The remainder of the processing instruction preceding the closing** ?>** characters. It supplies the [NodeValue](xmlprocessinginstruction_nodevalue.md) property for the new object. + +## -returns +The newly created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_createtextnode_1780106332.md b/windows.data.xml.dom/xmldocument_createtextnode_1780106332.md index 2a72d590ef..7461028f08 100644 --- a/windows.data.xml.dom/xmldocument_createtextnode_1780106332.md +++ b/windows.data.xml.dom/xmldocument_createtextnode_1780106332.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateTextNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.CreateTextNode ## -description Creates a text node that contains the supplied data. ## -parameters ### -param data The value to be supplied to the new text object's [NodeValue](xmltext_nodevalue.md). ## -returns The created text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.CreateTextNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.CreateTextNode + +## -description +Creates a text node that contains the supplied data. + +## -parameters +### -param data +The value to be supplied to the new text object's [NodeValue](xmltext_nodevalue.md). + +## -returns +The created text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_doctype.md b/windows.data.xml.dom/xmldocument_doctype.md index ca4af126a6..2a1cb4d13e 100644 --- a/windows.data.xml.dom/xmldocument_doctype.md +++ b/windows.data.xml.dom/xmldocument_doctype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.Doctype --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.Doctype ## -description For XML, this property gets the address of the node that specifies the DTD. This property returns Null for for HTML documents and XML documents without a DTD. ## -property-value The document type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.Doctype +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.Doctype + +## -description +For XML, this property gets the address of the node that specifies the DTD. This property returns Null for for HTML documents and XML documents without a DTD. + +## -property-value +The document type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_documentelement.md b/windows.data.xml.dom/xmldocument_documentelement.md index 68ce03c9c3..3f675a3f24 100644 --- a/windows.data.xml.dom/xmldocument_documentelement.md +++ b/windows.data.xml.dom/xmldocument_documentelement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.DocumentElement --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.DocumentElement ## -description Gets the root element of the document. ## -property-value The root element of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.DocumentElement +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.DocumentElement + +## -description +Gets the root element of the document. + +## -property-value +The root element of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_documenturi.md b/windows.data.xml.dom/xmldocument_documenturi.md index fd6c252142..b7e5b85421 100644 --- a/windows.data.xml.dom/xmldocument_documenturi.md +++ b/windows.data.xml.dom/xmldocument_documenturi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.DocumentUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.DocumentUri ## -description Returns the URL for the last loaded XML document. ## -property-value The URL for the last loaded XML document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.DocumentUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.DocumentUri + +## -description +Returns the URL for the last loaded XML document. + +## -property-value +The URL for the last loaded XML document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_firstchild.md b/windows.data.xml.dom/xmldocument_firstchild.md index 982f909a83..444b2c5d0a 100644 --- a/windows.data.xml.dom/xmldocument_firstchild.md +++ b/windows.data.xml.dom/xmldocument_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_getelementbyid_186814839.md b/windows.data.xml.dom/xmldocument_getelementbyid_186814839.md index e013bc3e18..c06be11a39 100644 --- a/windows.data.xml.dom/xmldocument_getelementbyid_186814839.md +++ b/windows.data.xml.dom/xmldocument_getelementbyid_186814839.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.GetElementById(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.GetElementById ## -description Returns the element that matches the ID attribute. ## -parameters ### -param elementId The ID to match. ## -returns The element that matches the supplied ID. If no elements match, this method returns Null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.GetElementById(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.GetElementById + +## -description +Returns the element that matches the ID attribute. + +## -parameters +### -param elementId +The ID to match. + +## -returns +The element that matches the supplied ID. If no elements match, this method returns Null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_getelementsbytagname_328846646.md b/windows.data.xml.dom/xmldocument_getelementsbytagname_328846646.md index 92006f6aa0..043dc3baa2 100644 --- a/windows.data.xml.dom/xmldocument_getelementsbytagname_328846646.md +++ b/windows.data.xml.dom/xmldocument_getelementsbytagname_328846646.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.GetElementsByTagName(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.GetElementsByTagName ## -description Returns a collection of elements that have the specified name. ## -parameters ### -param tagName The element name to find. The value "*" returns all elements in the document. ## -returns The collection of elements that match the specified name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.GetElementsByTagName(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.GetElementsByTagName + +## -description +Returns a collection of elements that have the specified name. + +## -parameters +### -param tagName +The element name to find. The value "*" returns all elements in the document. + +## -returns +The collection of elements that match the specified name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_getxml_999931642.md b/windows.data.xml.dom/xmldocument_getxml_999931642.md index c2f73ea085..8ed181b2b9 100644 --- a/windows.data.xml.dom/xmldocument_getxml_999931642.md +++ b/windows.data.xml.dom/xmldocument_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_haschildnodes_464206014.md b/windows.data.xml.dom/xmldocument_haschildnodes_464206014.md index 339d18d9f6..61f8b349fc 100644 --- a/windows.data.xml.dom/xmldocument_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmldocument_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_implementation.md b/windows.data.xml.dom/xmldocument_implementation.md index c4c7fd8d92..28e4f9edc5 100644 --- a/windows.data.xml.dom/xmldocument_implementation.md +++ b/windows.data.xml.dom/xmldocument_implementation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.Implementation --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.Implementation ## -description Gets the Implementation object for the document. ## -property-value The Implementation object for the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.Implementation +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.Implementation + +## -description +Gets the Implementation object for the document. + +## -property-value +The Implementation object for the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_importnode_192749086.md b/windows.data.xml.dom/xmldocument_importnode_192749086.md index f0cbc9883c..8d106e6dbd 100644 --- a/windows.data.xml.dom/xmldocument_importnode_192749086.md +++ b/windows.data.xml.dom/xmldocument_importnode_192749086.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.ImportNode(Windows.Data.Xml.Dom.IXmlNode,System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.ImportNode ## -description Imports a node from another document to this document. ## -parameters ### -param node The object to be cloned. ### -param deep If true, any children of node will be cloned as well. If false, no children of the node will be cloned. ## -returns The imported node. ## -remarks The returned node has no parent (the is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.ImportNode(Windows.Data.Xml.Dom.IXmlNode,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.ImportNode + +## -description +Imports a node from another document to this document. + +## -parameters +### -param node +The object to be cloned. + +### -param deep +If true, any children of node will be cloned as well. If false, no children of the node will be cloned. + +## -returns +The imported node. + +## -remarks +The returned node has no parent (the is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_innertext.md b/windows.data.xml.dom/xmldocument_innertext.md index a0526b804a..54fdee8479 100644 --- a/windows.data.xml.dom/xmldocument_innertext.md +++ b/windows.data.xml.dom/xmldocument_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_insertbefore_88135496.md b/windows.data.xml.dom/xmldocument_insertbefore_88135496.md index fcf704f49c..e60570e928 100644 --- a/windows.data.xml.dom/xmldocument_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmldocument_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the child node list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the child node list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_lastchild.md b/windows.data.xml.dom/xmldocument_lastchild.md index d0fdc2530d..4adbf9fd02 100644 --- a/windows.data.xml.dom/xmldocument_lastchild.md +++ b/windows.data.xml.dom/xmldocument_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_loadfromfileasync_590256742.md b/windows.data.xml.dom/xmldocument_loadfromfileasync_590256742.md index d64136acde..2c5816e1b6 100644 --- a/windows.data.xml.dom/xmldocument_loadfromfileasync_590256742.md +++ b/windows.data.xml.dom/xmldocument_loadfromfileasync_590256742.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync(Windows.Storage.IStorageFile,Windows.Data.Xml.Dom.XmlLoadSettings) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync ## -description Asynchronously loads an XML document from the specified file. The document is parsed using the provided settings. ## -parameters ### -param file The file from which to load the document. ### -param loadSettings Settings for customizing parser behavior. ## -returns The object that must be used to start the operation. ## -remarks ## -examples ## -see-also [LoadFromFileAsync(IStorageFile)](xmldocument_loadfromfileasync_656173540.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync(Windows.Storage.IStorageFile,Windows.Data.Xml.Dom.XmlLoadSettings) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync + +## -description +Asynchronously loads an XML document from the specified file. The document is parsed using the provided settings. + +## -parameters +### -param file +The file from which to load the document. + +### -param loadSettings +Settings for customizing parser behavior. + +## -returns +The object that must be used to start the operation. + +## -remarks + +## -examples + +## -see-also +[LoadFromFileAsync(IStorageFile)](xmldocument_loadfromfileasync_656173540.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadfromfileasync_656173540.md b/windows.data.xml.dom/xmldocument_loadfromfileasync_656173540.md index 31b94ffb17..7e57978522 100644 --- a/windows.data.xml.dom/xmldocument_loadfromfileasync_656173540.md +++ b/windows.data.xml.dom/xmldocument_loadfromfileasync_656173540.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync ## -description Asynchronously loads an XML document from the specified file. The document is parsed using the default parser settings. ## -parameters ### -param file The file from which to load the document. ## -returns The object that must be used to start the operation. ## -remarks ## -examples ## -see-also [LoadFromFileAsync(IStorageFile, XmlLoadSettings)](xmldocument_loadfromfileasync_590256742.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadFromFileAsync + +## -description +Asynchronously loads an XML document from the specified file. The document is parsed using the default parser settings. + +## -parameters +### -param file +The file from which to load the document. + +## -returns +The object that must be used to start the operation. + +## -remarks + +## -examples + +## -see-also +[LoadFromFileAsync(IStorageFile, XmlLoadSettings)](xmldocument_loadfromfileasync_590256742.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadfromuriasync_810772136.md b/windows.data.xml.dom/xmldocument_loadfromuriasync_810772136.md index 897c3d0e18..986caa879c 100644 --- a/windows.data.xml.dom/xmldocument_loadfromuriasync_810772136.md +++ b/windows.data.xml.dom/xmldocument_loadfromuriasync_810772136.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync(Windows.Foundation.Uri,Windows.Data.Xml.Dom.XmlLoadSettings) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync ## -description Asynchronously loads an XML document from the specified location. The document is parsed using the provided settings. ## -parameters ### -param uri A URL that specifies the location of the XML file. ### -param loadSettings Customizes parser behavior. ## -returns An object that must be used to start the operation. ## -remarks This operation does not start until a call is made to the IAsyncOperation::StartOperation method. ## -examples ## -see-also [LoadFromUriAsync(Uri)](xmldocument_loadfromuriasync_878810410.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync(Windows.Foundation.Uri,Windows.Data.Xml.Dom.XmlLoadSettings) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync + +## -description +Asynchronously loads an XML document from the specified location. The document is parsed using the provided settings. + +## -parameters +### -param uri +A URL that specifies the location of the XML file. + +### -param loadSettings +Customizes parser behavior. + +## -returns +An object that must be used to start the operation. + +## -remarks +This operation does not start until a call is made to the IAsyncOperation::StartOperation method. + +## -examples + +## -see-also +[LoadFromUriAsync(Uri)](xmldocument_loadfromuriasync_878810410.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadfromuriasync_878810410.md b/windows.data.xml.dom/xmldocument_loadfromuriasync_878810410.md index 5e5ee5d405..7b66d28041 100644 --- a/windows.data.xml.dom/xmldocument_loadfromuriasync_878810410.md +++ b/windows.data.xml.dom/xmldocument_loadfromuriasync_878810410.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync ## -description Asynchronously loads an XML document from the specified location. The document is parsed using the default parser settings. ## -parameters ### -param uri A URL that specifies the location of the XML file. ## -returns The object that must be used to start the operation. ## -remarks ## -examples ## -see-also [LoadFromUriAsync(Uri, XmlLoadSettings)](xmldocument_loadfromuriasync_810772136.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadFromUriAsync + +## -description +Asynchronously loads an XML document from the specified location. The document is parsed using the default parser settings. + +## -parameters +### -param uri +A URL that specifies the location of the XML file. + +## -returns +The object that must be used to start the operation. + +## -remarks + +## -examples + +## -see-also +[LoadFromUriAsync(Uri, XmlLoadSettings)](xmldocument_loadfromuriasync_810772136.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadxml_310605385.md b/windows.data.xml.dom/xmldocument_loadxml_310605385.md index 1bebf43e1c..9da0a2ac1c 100644 --- a/windows.data.xml.dom/xmldocument_loadxml_310605385.md +++ b/windows.data.xml.dom/xmldocument_loadxml_310605385.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXml(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadXml ## -description Loads an XML document using the supplied string. The document is parsed using the default parser settings. ## -parameters ### -param xml The XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment. ## -remarks ## -examples ## -see-also [LoadXml(String, IXmlLoadSettings)](xmldocument_loadxml_380732875.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXml(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadXml + +## -description +Loads an XML document using the supplied string. The document is parsed using the default parser settings. + +## -parameters +### -param xml +The XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment. + +## -remarks + +## -examples + +## -see-also +[LoadXml(String, IXmlLoadSettings)](xmldocument_loadxml_380732875.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadxml_380732875.md b/windows.data.xml.dom/xmldocument_loadxml_380732875.md index eab302a431..b35e76f349 100644 --- a/windows.data.xml.dom/xmldocument_loadxml_380732875.md +++ b/windows.data.xml.dom/xmldocument_loadxml_380732875.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXml(System.String,Windows.Data.Xml.Dom.XmlLoadSettings) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadXml ## -description Loads an XML document using the supplied string. The document is parsed using the settings provided. ## -parameters ### -param xml The XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment. ### -param loadSettings The settings for parsing the document. ## -remarks ## -examples ## -see-also [LoadXml(String)](xmldocument_loadxml_310605385.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXml(System.String,Windows.Data.Xml.Dom.XmlLoadSettings) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadXml + +## -description +Loads an XML document using the supplied string. The document is parsed using the settings provided. + +## -parameters +### -param xml +The XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment. + +### -param loadSettings +The settings for parsing the document. + +## -remarks + +## -examples + +## -see-also +[LoadXml(String)](xmldocument_loadxml_310605385.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_413502960.md b/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_413502960.md index f2b44169f0..806eafa57d 100644 --- a/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_413502960.md +++ b/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_413502960.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer ## -description Loads an XML document using the buffer. The document is parsed using the default parser settings. ## -parameters ### -param buffer The buffer to load into this XML document object. This buffer can contain an entire XML document or a well-formed fragment. ## -remarks ## -examples ## -see-also [LoadXmlFromBuffer(IBuffer, XmlLoadSettings)](xmldocument_loadxmlfrombuffer_479690350.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer + +## -description +Loads an XML document using the buffer. The document is parsed using the default parser settings. + +## -parameters +### -param buffer +The buffer to load into this XML document object. This buffer can contain an entire XML document or a well-formed fragment. + +## -remarks + +## -examples + +## -see-also +[LoadXmlFromBuffer(IBuffer, XmlLoadSettings)](xmldocument_loadxmlfrombuffer_479690350.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_479690350.md b/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_479690350.md index be3f92d474..2c4a74358e 100644 --- a/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_479690350.md +++ b/windows.data.xml.dom/xmldocument_loadxmlfrombuffer_479690350.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Data.Xml.Dom.XmlLoadSettings) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer ## -description Loads an XML document using the buffer. The document is parsed using the settings provided. ## -parameters ### -param buffer The buffer to load into this XML document object. This buffer can contain an entire XML document or a well-formed fragment. ### -param loadSettings The settings for parsing the document. ## -remarks ## -examples ## -see-also [LoadXmlFromBuffer(IBuffer)](xmldocument_loadxmlfrombuffer_413502960.md) \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Data.Xml.Dom.XmlLoadSettings) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LoadXmlFromBuffer + +## -description +Loads an XML document using the buffer. The document is parsed using the settings provided. + +## -parameters +### -param buffer +The buffer to load into this XML document object. This buffer can contain an entire XML document or a well-formed fragment. + +### -param loadSettings +The settings for parsing the document. + +## -remarks + +## -examples + +## -see-also +[LoadXmlFromBuffer(IBuffer)](xmldocument_loadxmlfrombuffer_413502960.md) \ No newline at end of file diff --git a/windows.data.xml.dom/xmldocument_localname.md b/windows.data.xml.dom/xmldocument_localname.md index 68ace328ef..585eca9721 100644 --- a/windows.data.xml.dom/xmldocument_localname.md +++ b/windows.data.xml.dom/xmldocument_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_namespaceuri.md b/windows.data.xml.dom/xmldocument_namespaceuri.md index 54570b6410..66f5d6a4db 100644 --- a/windows.data.xml.dom/xmldocument_namespaceuri.md +++ b/windows.data.xml.dom/xmldocument_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_nextsibling.md b/windows.data.xml.dom/xmldocument_nextsibling.md index 586f678ded..6684f4a9d7 100644 --- a/windows.data.xml.dom/xmldocument_nextsibling.md +++ b/windows.data.xml.dom/xmldocument_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.NextSibling ## -description Gets the next sibling of the node in the parent's child list. This property is not applicable to this class. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. This property is not applicable to this class. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_nodename.md b/windows.data.xml.dom/xmldocument_nodename.md index ea787d9ebc..6a081b0bc9 100644 --- a/windows.data.xml.dom/xmldocument_nodename.md +++ b/windows.data.xml.dom/xmldocument_nodename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_nodetype.md b/windows.data.xml.dom/xmldocument_nodetype.md index 7bc3c863c6..1c9b219fef 100644 --- a/windows.data.xml.dom/xmldocument_nodetype.md +++ b/windows.data.xml.dom/xmldocument_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_nodevalue.md b/windows.data.xml.dom/xmldocument_nodevalue.md index fce7a051ee..8ad8b81a84 100644 --- a/windows.data.xml.dom/xmldocument_nodevalue.md +++ b/windows.data.xml.dom/xmldocument_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_normalize_347475160.md b/windows.data.xml.dom/xmldocument_normalize_347475160.md index 61585c617b..d3351ae7b0 100644 --- a/windows.data.xml.dom/xmldocument_normalize_347475160.md +++ b/windows.data.xml.dom/xmldocument_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_ownerdocument.md b/windows.data.xml.dom/xmldocument_ownerdocument.md index 0c90e3d280..cf767b5d76 100644 --- a/windows.data.xml.dom/xmldocument_ownerdocument.md +++ b/windows.data.xml.dom/xmldocument_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_parentnode.md b/windows.data.xml.dom/xmldocument_parentnode.md index 4fcaf68b4d..aae2cbe07c 100644 --- a/windows.data.xml.dom/xmldocument_parentnode.md +++ b/windows.data.xml.dom/xmldocument_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.ParentNode ## -description Gets the parent node of the node instance. ## -property-value This property returns NULL. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +This property returns NULL. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_prefix.md b/windows.data.xml.dom/xmldocument_prefix.md index a61fd879b3..ab0bf597a6 100644 --- a/windows.data.xml.dom/xmldocument_prefix.md +++ b/windows.data.xml.dom/xmldocument_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_previoussibling.md b/windows.data.xml.dom/xmldocument_previoussibling.md index b1e2759bb2..a9e100bc9d 100644 --- a/windows.data.xml.dom/xmldocument_previoussibling.md +++ b/windows.data.xml.dom/xmldocument_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocument.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocument.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. This property is not applicable to this class. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocument.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. This property is not applicable to this class. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_removechild_1165510615.md b/windows.data.xml.dom/xmldocument_removechild_1165510615.md index 7329a75b3f..f018f82e9d 100644 --- a/windows.data.xml.dom/xmldocument_removechild_1165510615.md +++ b/windows.data.xml.dom/xmldocument_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_replacechild_85158540.md b/windows.data.xml.dom/xmldocument_replacechild_85158540.md index c35caacbcf..d7dd781a80 100644 --- a/windows.data.xml.dom/xmldocument_replacechild_85158540.md +++ b/windows.data.xml.dom/xmldocument_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_savetofileasync_96915967.md b/windows.data.xml.dom/xmldocument_savetofileasync_96915967.md index dd32fed06c..74655a1ee0 100644 --- a/windows.data.xml.dom/xmldocument_savetofileasync_96915967.md +++ b/windows.data.xml.dom/xmldocument_savetofileasync_96915967.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.SaveToFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.SaveToFileAsync ## -description Asynchronously saves an XML document to the specified file. ## -parameters ### -param file The file to save the document to. ## -returns The object that must be used to start the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.SaveToFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.SaveToFileAsync + +## -description +Asynchronously saves an XML document to the specified file. + +## -parameters +### -param file +The file to save the document to. + +## -returns +The object that must be used to start the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_selectnodes_71711491.md b/windows.data.xml.dom/xmldocument_selectnodes_71711491.md index dab039f913..56b3a091e1 100644 --- a/windows.data.xml.dom/xmldocument_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmldocument_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_selectnodesns_2126476717.md b/windows.data.xml.dom/xmldocument_selectnodesns_2126476717.md index 7bf3b12a43..a3275bc466 100644 --- a/windows.data.xml.dom/xmldocument_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmldocument_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmldocument_selectsinglenode_1817002489.md index 0de86e02b6..f6a8532e3f 100644 --- a/windows.data.xml.dom/xmldocument_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmldocument_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmldocument_selectsinglenodens_1164847996.md index f32709e221..b37dd9e326 100644 --- a/windows.data.xml.dom/xmldocument_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmldocument_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocument_xmldocument_1221375020.md b/windows.data.xml.dom/xmldocument_xmldocument_1221375020.md index 4b02f28420..f274cad3cc 100644 --- a/windows.data.xml.dom/xmldocument_xmldocument_1221375020.md +++ b/windows.data.xml.dom/xmldocument_xmldocument_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocument.#ctor --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocument.XmlDocument ## -description Creates a new instance of the [XmlDocument](xmldocument.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocument.#ctor +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocument.XmlDocument + +## -description +Creates a new instance of the [XmlDocument](xmldocument.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_appendchild_1014377324.md b/windows.data.xml.dom/xmldocumentfragment_appendchild_1014377324.md index 45ff91f063..f25d6b334b 100644 --- a/windows.data.xml.dom/xmldocumentfragment_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmldocumentfragment_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_attributes.md b/windows.data.xml.dom/xmldocumentfragment_attributes.md index 5547e02cd7..a3bdacca49 100644 --- a/windows.data.xml.dom/xmldocumentfragment_attributes.md +++ b/windows.data.xml.dom/xmldocumentfragment_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_childnodes.md b/windows.data.xml.dom/xmldocumentfragment_childnodes.md index 64b7a83e54..7339af1414 100644 --- a/windows.data.xml.dom/xmldocumentfragment_childnodes.md +++ b/windows.data.xml.dom/xmldocumentfragment_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_clonenode_554530370.md b/windows.data.xml.dom/xmldocumentfragment_clonenode_554530370.md index d40be6f88d..82a6584fb3 100644 --- a/windows.data.xml.dom/xmldocumentfragment_clonenode_554530370.md +++ b/windows.data.xml.dom/xmldocumentfragment_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_firstchild.md b/windows.data.xml.dom/xmldocumentfragment_firstchild.md index ac15f100e3..57ce4ca997 100644 --- a/windows.data.xml.dom/xmldocumentfragment_firstchild.md +++ b/windows.data.xml.dom/xmldocumentfragment_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_getxml_999931642.md b/windows.data.xml.dom/xmldocumentfragment_getxml_999931642.md index 6b03b78d63..2ff632eca9 100644 --- a/windows.data.xml.dom/xmldocumentfragment_getxml_999931642.md +++ b/windows.data.xml.dom/xmldocumentfragment_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_haschildnodes_464206014.md b/windows.data.xml.dom/xmldocumentfragment_haschildnodes_464206014.md index caa519810f..cd81d31083 100644 --- a/windows.data.xml.dom/xmldocumentfragment_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmldocumentfragment_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_innertext.md b/windows.data.xml.dom/xmldocumentfragment_innertext.md index 67f4e502e7..05eedf69ac 100644 --- a/windows.data.xml.dom/xmldocumentfragment_innertext.md +++ b/windows.data.xml.dom/xmldocumentfragment_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_insertbefore_88135496.md b/windows.data.xml.dom/xmldocumentfragment_insertbefore_88135496.md index 5fc4d2edab..c010f03439 100644 --- a/windows.data.xml.dom/xmldocumentfragment_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmldocumentfragment_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_lastchild.md b/windows.data.xml.dom/xmldocumentfragment_lastchild.md index b1f16ebf3d..8668b4315f 100644 --- a/windows.data.xml.dom/xmldocumentfragment_lastchild.md +++ b/windows.data.xml.dom/xmldocumentfragment_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_localname.md b/windows.data.xml.dom/xmldocumentfragment_localname.md index 09cc7bdfbf..8c675d2658 100644 --- a/windows.data.xml.dom/xmldocumentfragment_localname.md +++ b/windows.data.xml.dom/xmldocumentfragment_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_namespaceuri.md b/windows.data.xml.dom/xmldocumentfragment_namespaceuri.md index e2af1de544..476030ef32 100644 --- a/windows.data.xml.dom/xmldocumentfragment_namespaceuri.md +++ b/windows.data.xml.dom/xmldocumentfragment_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_nextsibling.md b/windows.data.xml.dom/xmldocumentfragment_nextsibling.md index 4e8e6f6484..61f958c103 100644 --- a/windows.data.xml.dom/xmldocumentfragment_nextsibling.md +++ b/windows.data.xml.dom/xmldocumentfragment_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_nodename.md b/windows.data.xml.dom/xmldocumentfragment_nodename.md index e7761b86d3..8d4edc46ae 100644 --- a/windows.data.xml.dom/xmldocumentfragment_nodename.md +++ b/windows.data.xml.dom/xmldocumentfragment_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_nodetype.md b/windows.data.xml.dom/xmldocumentfragment_nodetype.md index cc4a78717b..0d7f36362b 100644 --- a/windows.data.xml.dom/xmldocumentfragment_nodetype.md +++ b/windows.data.xml.dom/xmldocumentfragment_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_nodevalue.md b/windows.data.xml.dom/xmldocumentfragment_nodevalue.md index e53e0202e2..96fa6a7b8a 100644 --- a/windows.data.xml.dom/xmldocumentfragment_nodevalue.md +++ b/windows.data.xml.dom/xmldocumentfragment_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_normalize_347475160.md b/windows.data.xml.dom/xmldocumentfragment_normalize_347475160.md index 757b81c4c9..8453e801f3 100644 --- a/windows.data.xml.dom/xmldocumentfragment_normalize_347475160.md +++ b/windows.data.xml.dom/xmldocumentfragment_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_ownerdocument.md b/windows.data.xml.dom/xmldocumentfragment_ownerdocument.md index e0f0962681..49cc3e5c28 100644 --- a/windows.data.xml.dom/xmldocumentfragment_ownerdocument.md +++ b/windows.data.xml.dom/xmldocumentfragment_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_parentnode.md b/windows.data.xml.dom/xmldocumentfragment_parentnode.md index 9a10cc83b8..a41c3ccf79 100644 --- a/windows.data.xml.dom/xmldocumentfragment_parentnode.md +++ b/windows.data.xml.dom/xmldocumentfragment_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.ParentNode ## -description Gets the parent node of the node instance. This property is not applicable to this class. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.ParentNode + +## -description +Gets the parent node of the node instance. This property is not applicable to this class. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_prefix.md b/windows.data.xml.dom/xmldocumentfragment_prefix.md index 1abf189e7e..9586e7cd7e 100644 --- a/windows.data.xml.dom/xmldocumentfragment_prefix.md +++ b/windows.data.xml.dom/xmldocumentfragment_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_previoussibling.md b/windows.data.xml.dom/xmldocumentfragment_previoussibling.md index ef08e2b830..e98118ff5c 100644 --- a/windows.data.xml.dom/xmldocumentfragment_previoussibling.md +++ b/windows.data.xml.dom/xmldocumentfragment_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. This property is not applicable to this class. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentFragment.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. This property is not applicable to this class. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_removechild_1165510615.md b/windows.data.xml.dom/xmldocumentfragment_removechild_1165510615.md index 1382f5b01b..bacac500d8 100644 --- a/windows.data.xml.dom/xmldocumentfragment_removechild_1165510615.md +++ b/windows.data.xml.dom/xmldocumentfragment_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_replacechild_85158540.md b/windows.data.xml.dom/xmldocumentfragment_replacechild_85158540.md index d66a69ed80..35d80be4c6 100644 --- a/windows.data.xml.dom/xmldocumentfragment_replacechild_85158540.md +++ b/windows.data.xml.dom/xmldocumentfragment_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_selectnodes_71711491.md b/windows.data.xml.dom/xmldocumentfragment_selectnodes_71711491.md index c6f2e66fa9..d936f0bfe6 100644 --- a/windows.data.xml.dom/xmldocumentfragment_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmldocumentfragment_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_selectnodesns_2126476717.md b/windows.data.xml.dom/xmldocumentfragment_selectnodesns_2126476717.md index 8aaf03a17b..1a29117073 100644 --- a/windows.data.xml.dom/xmldocumentfragment_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmldocumentfragment_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmldocumentfragment_selectsinglenode_1817002489.md index 780ae461d3..fbee6e9ac0 100644 --- a/windows.data.xml.dom/xmldocumentfragment_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmldocumentfragment_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumentfragment_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmldocumentfragment_selectsinglenodens_1164847996.md index 3e0cbd2341..ef42f71535 100644 --- a/windows.data.xml.dom/xmldocumentfragment_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmldocumentfragment_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentFragment.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_appendchild_1014377324.md b/windows.data.xml.dom/xmldocumenttype_appendchild_1014377324.md index 389742fddd..a0dad4371b 100644 --- a/windows.data.xml.dom/xmldocumenttype_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmldocumenttype_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_attributes.md b/windows.data.xml.dom/xmldocumenttype_attributes.md index c8f979114d..f999abe347 100644 --- a/windows.data.xml.dom/xmldocumenttype_attributes.md +++ b/windows.data.xml.dom/xmldocumenttype_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_childnodes.md b/windows.data.xml.dom/xmldocumenttype_childnodes.md index d0bd5900c4..920875364d 100644 --- a/windows.data.xml.dom/xmldocumenttype_childnodes.md +++ b/windows.data.xml.dom/xmldocumenttype_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_clonenode_554530370.md b/windows.data.xml.dom/xmldocumenttype_clonenode_554530370.md index 9a152a910e..e5dcae8634 100644 --- a/windows.data.xml.dom/xmldocumenttype_clonenode_554530370.md +++ b/windows.data.xml.dom/xmldocumenttype_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_entities.md b/windows.data.xml.dom/xmldocumenttype_entities.md index 49f151a56a..77368ee285 100644 --- a/windows.data.xml.dom/xmldocumenttype_entities.md +++ b/windows.data.xml.dom/xmldocumenttype_entities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Entities --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.Entities ## -description Gets a list of the entities declared in the **<!DOCTYPE>** declaration. ## -property-value A list of the general entities, both external and internal, that are present in this document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Entities +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.Entities + +## -description +Gets a list of the entities declared in the **<!DOCTYPE>** declaration. + +## -property-value +A list of the general entities, both external and internal, that are present in this document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_firstchild.md b/windows.data.xml.dom/xmldocumenttype_firstchild.md index e84bdccdd8..daa960f393 100644 --- a/windows.data.xml.dom/xmldocumenttype_firstchild.md +++ b/windows.data.xml.dom/xmldocumenttype_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_getxml_999931642.md b/windows.data.xml.dom/xmldocumenttype_getxml_999931642.md index 1c7af0d5bb..bdf1450412 100644 --- a/windows.data.xml.dom/xmldocumenttype_getxml_999931642.md +++ b/windows.data.xml.dom/xmldocumenttype_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_haschildnodes_464206014.md b/windows.data.xml.dom/xmldocumenttype_haschildnodes_464206014.md index e637e884b2..0a4143f101 100644 --- a/windows.data.xml.dom/xmldocumenttype_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmldocumenttype_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_innertext.md b/windows.data.xml.dom/xmldocumenttype_innertext.md index 9a2aad526e..e4ee9f8c7c 100644 --- a/windows.data.xml.dom/xmldocumenttype_innertext.md +++ b/windows.data.xml.dom/xmldocumenttype_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_insertbefore_88135496.md b/windows.data.xml.dom/xmldocumenttype_insertbefore_88135496.md index 615cecea05..6c1a2c24d1 100644 --- a/windows.data.xml.dom/xmldocumenttype_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmldocumenttype_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_lastchild.md b/windows.data.xml.dom/xmldocumenttype_lastchild.md index 20547179ca..e68e49e2cb 100644 --- a/windows.data.xml.dom/xmldocumenttype_lastchild.md +++ b/windows.data.xml.dom/xmldocumenttype_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_localname.md b/windows.data.xml.dom/xmldocumenttype_localname.md index a025b0da71..daf81a8f55 100644 --- a/windows.data.xml.dom/xmldocumenttype_localname.md +++ b/windows.data.xml.dom/xmldocumenttype_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_name.md b/windows.data.xml.dom/xmldocumenttype_name.md index ba51a62381..c3498391a9 100644 --- a/windows.data.xml.dom/xmldocumenttype_name.md +++ b/windows.data.xml.dom/xmldocumenttype_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Name --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.Name ## -description A list of the general entities, both external and internal, that are present in this document. ## -property-value The name of the document type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Name +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.Name + +## -description +A list of the general entities, both external and internal, that are present in this document. + +## -property-value +The name of the document type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_namespaceuri.md b/windows.data.xml.dom/xmldocumenttype_namespaceuri.md index b709feda54..e0df87fea5 100644 --- a/windows.data.xml.dom/xmldocumenttype_namespaceuri.md +++ b/windows.data.xml.dom/xmldocumenttype_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_nextsibling.md b/windows.data.xml.dom/xmldocumenttype_nextsibling.md index d56f552ccd..d937ab825f 100644 --- a/windows.data.xml.dom/xmldocumenttype_nextsibling.md +++ b/windows.data.xml.dom/xmldocumenttype_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_nodename.md b/windows.data.xml.dom/xmldocumenttype_nodename.md index 567fa71b38..f1fbb3953a 100644 --- a/windows.data.xml.dom/xmldocumenttype_nodename.md +++ b/windows.data.xml.dom/xmldocumenttype_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_nodetype.md b/windows.data.xml.dom/xmldocumenttype_nodetype.md index aaf2fefe8b..767038291a 100644 --- a/windows.data.xml.dom/xmldocumenttype_nodetype.md +++ b/windows.data.xml.dom/xmldocumenttype_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_nodevalue.md b/windows.data.xml.dom/xmldocumenttype_nodevalue.md index 4ba7dcc589..9ebd4bad27 100644 --- a/windows.data.xml.dom/xmldocumenttype_nodevalue.md +++ b/windows.data.xml.dom/xmldocumenttype_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_normalize_347475160.md b/windows.data.xml.dom/xmldocumenttype_normalize_347475160.md index 9d39051e9a..d8fee58e8d 100644 --- a/windows.data.xml.dom/xmldocumenttype_normalize_347475160.md +++ b/windows.data.xml.dom/xmldocumenttype_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_notations.md b/windows.data.xml.dom/xmldocumenttype_notations.md index 061ad5c0c4..faa19dfc7f 100644 --- a/windows.data.xml.dom/xmldocumenttype_notations.md +++ b/windows.data.xml.dom/xmldocumenttype_notations.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Notations --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.Notations ## -description Returns a list of the [DtdNotation](dtdnotation.md) members that are present in the document type declaration. ## -property-value A list of [DtdNotation](dtdnotation.md) members that are present in the document type declaration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Notations +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.Notations + +## -description +Returns a list of the [DtdNotation](dtdnotation.md) members that are present in the document type declaration. + +## -property-value +A list of [DtdNotation](dtdnotation.md) members that are present in the document type declaration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_ownerdocument.md b/windows.data.xml.dom/xmldocumenttype_ownerdocument.md index 23b91b83e6..b127d68847 100644 --- a/windows.data.xml.dom/xmldocumenttype_ownerdocument.md +++ b/windows.data.xml.dom/xmldocumenttype_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_parentnode.md b/windows.data.xml.dom/xmldocumenttype_parentnode.md index ebffa1ab80..213967612d 100644 --- a/windows.data.xml.dom/xmldocumenttype_parentnode.md +++ b/windows.data.xml.dom/xmldocumenttype_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_prefix.md b/windows.data.xml.dom/xmldocumenttype_prefix.md index a11252e684..3d9c6f250c 100644 --- a/windows.data.xml.dom/xmldocumenttype_prefix.md +++ b/windows.data.xml.dom/xmldocumenttype_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_previoussibling.md b/windows.data.xml.dom/xmldocumenttype_previoussibling.md index 0aabb091ef..8c9322903f 100644 --- a/windows.data.xml.dom/xmldocumenttype_previoussibling.md +++ b/windows.data.xml.dom/xmldocumenttype_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlDocumentType.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlDocumentType.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_removechild_1165510615.md b/windows.data.xml.dom/xmldocumenttype_removechild_1165510615.md index 0344f10d53..fc33ff6f1d 100644 --- a/windows.data.xml.dom/xmldocumenttype_removechild_1165510615.md +++ b/windows.data.xml.dom/xmldocumenttype_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_replacechild_85158540.md b/windows.data.xml.dom/xmldocumenttype_replacechild_85158540.md index 91eb270e79..be8d88655a 100644 --- a/windows.data.xml.dom/xmldocumenttype_replacechild_85158540.md +++ b/windows.data.xml.dom/xmldocumenttype_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_selectnodes_71711491.md b/windows.data.xml.dom/xmldocumenttype_selectnodes_71711491.md index 6f7f16879c..b0b1f1f8c7 100644 --- a/windows.data.xml.dom/xmldocumenttype_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmldocumenttype_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_selectnodesns_2126476717.md b/windows.data.xml.dom/xmldocumenttype_selectnodesns_2126476717.md index 08658afe20..e800b6ccff 100644 --- a/windows.data.xml.dom/xmldocumenttype_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmldocumenttype_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmldocumenttype_selectsinglenode_1817002489.md index 650b4df39c..9a948cf3fa 100644 --- a/windows.data.xml.dom/xmldocumenttype_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmldocumenttype_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldocumenttype_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmldocumenttype_selectsinglenodens_1164847996.md index 1204150ee4..8d6b6140e2 100644 --- a/windows.data.xml.dom/xmldocumenttype_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmldocumenttype_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDocumentType.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmldomimplementation_hasfeature_416630701.md b/windows.data.xml.dom/xmldomimplementation_hasfeature_416630701.md index ff5b97decc..fa62d543e1 100644 --- a/windows.data.xml.dom/xmldomimplementation_hasfeature_416630701.md +++ b/windows.data.xml.dom/xmldomimplementation_hasfeature_416630701.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlDomImplementation.HasFeature(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlDomImplementation.HasFeature ## -description Indicates support for the specified feature. ## -parameters ### -param feature Specifies the feature to test. In Level 1, valid feature values are "XML", "DOM", and "MS-DOM" (case-insensitive). ### -param version Specifies the version number to test. If NULL, tests for implementation of the feature in any version. In Level 1, "1.0" is the valid version value. ## -returns True if the specified feature is implemented; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlDomImplementation.HasFeature(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlDomImplementation.HasFeature + +## -description +Indicates support for the specified feature. + +## -parameters +### -param feature +Specifies the feature to test. In Level 1, valid feature values are "XML", "DOM", and "MS-DOM" (case-insensitive). + +### -param version +Specifies the version number to test. If NULL, tests for implementation of the feature in any version. In Level 1, "1.0" is the valid version value. + +## -returns +True if the specified feature is implemented; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_appendchild_1014377324.md b/windows.data.xml.dom/xmlelement_appendchild_1014377324.md index afba6f87e7..5143e50a91 100644 --- a/windows.data.xml.dom/xmlelement_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmlelement_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_attributes.md b/windows.data.xml.dom/xmlelement_attributes.md index 0db5e59b6f..1cf9d3c6d0 100644 --- a/windows.data.xml.dom/xmlelement_attributes.md +++ b/windows.data.xml.dom/xmlelement_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_childnodes.md b/windows.data.xml.dom/xmlelement_childnodes.md index d88ee58dfc..c6e355ee64 100644 --- a/windows.data.xml.dom/xmlelement_childnodes.md +++ b/windows.data.xml.dom/xmlelement_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_clonenode_554530370.md b/windows.data.xml.dom/xmlelement_clonenode_554530370.md index 36fc5f4fe4..7caefe88e6 100644 --- a/windows.data.xml.dom/xmlelement_clonenode_554530370.md +++ b/windows.data.xml.dom/xmlelement_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_firstchild.md b/windows.data.xml.dom/xmlelement_firstchild.md index 683cf98e95..b97dd124f2 100644 --- a/windows.data.xml.dom/xmlelement_firstchild.md +++ b/windows.data.xml.dom/xmlelement_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_getattribute_990637886.md b/windows.data.xml.dom/xmlelement_getattribute_990637886.md index 0cf255b459..7d18976ce1 100644 --- a/windows.data.xml.dom/xmlelement_getattribute_990637886.md +++ b/windows.data.xml.dom/xmlelement_getattribute_990637886.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttribute(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.GetAttribute ## -description Returns the value of the attribute. ## -parameters ### -param attributeName The name of the required attribute. ## -returns The string value of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttribute(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.GetAttribute + +## -description +Returns the value of the attribute. + +## -parameters +### -param attributeName +The name of the required attribute. + +## -returns +The string value of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_getattributenode_1145473300.md b/windows.data.xml.dom/xmlelement_getattributenode_1145473300.md index 6994e8da50..a8e8aea86a 100644 --- a/windows.data.xml.dom/xmlelement_getattributenode_1145473300.md +++ b/windows.data.xml.dom/xmlelement_getattributenode_1145473300.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttributeNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.GetAttributeNode ## -description Returns the attribute node. ## -parameters ### -param attributeName The name of the required attribute. ## -returns The returned attribute pointer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttributeNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.GetAttributeNode + +## -description +Returns the attribute node. + +## -parameters +### -param attributeName +The name of the required attribute. + +## -returns +The returned attribute pointer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_getattributenodens_1921409124.md b/windows.data.xml.dom/xmlelement_getattributenodens_1921409124.md index 124efd6ba1..5898e6e878 100644 --- a/windows.data.xml.dom/xmlelement_getattributenodens_1921409124.md +++ b/windows.data.xml.dom/xmlelement_getattributenodens_1921409124.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttributeNodeNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.GetAttributeNodeNS ## -description Returns the specified attribute from the specified namespace. ## -parameters ### -param namespaceUri The namespace of the attribute to get. ### -param localName The name of the attribute without the namespace prefix. ## -returns The returned attribute pointer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttributeNodeNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.GetAttributeNodeNS + +## -description +Returns the specified attribute from the specified namespace. + +## -parameters +### -param namespaceUri +The namespace of the attribute to get. + +### -param localName +The name of the attribute without the namespace prefix. + +## -returns +The returned attribute pointer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_getattributens_506267688.md b/windows.data.xml.dom/xmlelement_getattributens_506267688.md index a7006704ab..a4809d4994 100644 --- a/windows.data.xml.dom/xmlelement_getattributens_506267688.md +++ b/windows.data.xml.dom/xmlelement_getattributens_506267688.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttributeNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.GetAttributeNS ## -description Returns the value of the attribute. ## -parameters ### -param namespaceUri The namespace of the attribute to get. ### -param localName The name of the attribute without the namespace prefix. ## -returns The string value of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.GetAttributeNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.GetAttributeNS + +## -description +Returns the value of the attribute. + +## -parameters +### -param namespaceUri +The namespace of the attribute to get. + +### -param localName +The name of the attribute without the namespace prefix. + +## -returns +The string value of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_getelementsbytagname_328846646.md b/windows.data.xml.dom/xmlelement_getelementsbytagname_328846646.md index a91c091a54..e3bd18fb24 100644 --- a/windows.data.xml.dom/xmlelement_getelementsbytagname_328846646.md +++ b/windows.data.xml.dom/xmlelement_getelementsbytagname_328846646.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.GetElementsByTagName(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.GetElementsByTagName ## -description Returns a list of all descendant elements that match the supplied name. ## -parameters ### -param tagName The tag of the required elements. ## -returns The required elements. The list can be empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.GetElementsByTagName(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.GetElementsByTagName + +## -description +Returns a list of all descendant elements that match the supplied name. + +## -parameters +### -param tagName +The tag of the required elements. + +## -returns +The required elements. The list can be empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_getxml_999931642.md b/windows.data.xml.dom/xmlelement_getxml_999931642.md index 03e29414a1..aed960eb87 100644 --- a/windows.data.xml.dom/xmlelement_getxml_999931642.md +++ b/windows.data.xml.dom/xmlelement_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_haschildnodes_464206014.md b/windows.data.xml.dom/xmlelement_haschildnodes_464206014.md index 19172db6c4..c936a76ff3 100644 --- a/windows.data.xml.dom/xmlelement_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmlelement_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_innertext.md b/windows.data.xml.dom/xmlelement_innertext.md index 98090037b5..e282ce187c 100644 --- a/windows.data.xml.dom/xmlelement_innertext.md +++ b/windows.data.xml.dom/xmlelement_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_insertbefore_88135496.md b/windows.data.xml.dom/xmlelement_insertbefore_88135496.md index e86ad1afae..78f6fe4726 100644 --- a/windows.data.xml.dom/xmlelement_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmlelement_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_lastchild.md b/windows.data.xml.dom/xmlelement_lastchild.md index e612d9e753..96896e7e5f 100644 --- a/windows.data.xml.dom/xmlelement_lastchild.md +++ b/windows.data.xml.dom/xmlelement_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_localname.md b/windows.data.xml.dom/xmlelement_localname.md index 54a757fe3d..0b8fed3185 100644 --- a/windows.data.xml.dom/xmlelement_localname.md +++ b/windows.data.xml.dom/xmlelement_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_namespaceuri.md b/windows.data.xml.dom/xmlelement_namespaceuri.md index 4d91bfcbc1..c02d7901db 100644 --- a/windows.data.xml.dom/xmlelement_namespaceuri.md +++ b/windows.data.xml.dom/xmlelement_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_nextsibling.md b/windows.data.xml.dom/xmlelement_nextsibling.md index f6c669f5a0..93d07ff7fe 100644 --- a/windows.data.xml.dom/xmlelement_nextsibling.md +++ b/windows.data.xml.dom/xmlelement_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_nodename.md b/windows.data.xml.dom/xmlelement_nodename.md index b9d3678437..93b242fe96 100644 --- a/windows.data.xml.dom/xmlelement_nodename.md +++ b/windows.data.xml.dom/xmlelement_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_nodetype.md b/windows.data.xml.dom/xmlelement_nodetype.md index 3cd5bd9c43..efd552b0b2 100644 --- a/windows.data.xml.dom/xmlelement_nodetype.md +++ b/windows.data.xml.dom/xmlelement_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_nodevalue.md b/windows.data.xml.dom/xmlelement_nodevalue.md index 6f0680a966..7dae098098 100644 --- a/windows.data.xml.dom/xmlelement_nodevalue.md +++ b/windows.data.xml.dom/xmlelement_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_normalize_347475160.md b/windows.data.xml.dom/xmlelement_normalize_347475160.md index 448709e4c8..134ea3fb00 100644 --- a/windows.data.xml.dom/xmlelement_normalize_347475160.md +++ b/windows.data.xml.dom/xmlelement_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_ownerdocument.md b/windows.data.xml.dom/xmlelement_ownerdocument.md index fe6fe15863..23ec63af4f 100644 --- a/windows.data.xml.dom/xmlelement_ownerdocument.md +++ b/windows.data.xml.dom/xmlelement_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_parentnode.md b/windows.data.xml.dom/xmlelement_parentnode.md index b9aaee9859..fa9a58a172 100644 --- a/windows.data.xml.dom/xmlelement_parentnode.md +++ b/windows.data.xml.dom/xmlelement_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_prefix.md b/windows.data.xml.dom/xmlelement_prefix.md index 5578a1a24f..f4af91ceac 100644 --- a/windows.data.xml.dom/xmlelement_prefix.md +++ b/windows.data.xml.dom/xmlelement_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_previoussibling.md b/windows.data.xml.dom/xmlelement_previoussibling.md index 855df9ba4d..27103336fd 100644 --- a/windows.data.xml.dom/xmlelement_previoussibling.md +++ b/windows.data.xml.dom/xmlelement_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_removeattribute_1193643678.md b/windows.data.xml.dom/xmlelement_removeattribute_1193643678.md index cc9e4a3d1f..a1defd7952 100644 --- a/windows.data.xml.dom/xmlelement_removeattribute_1193643678.md +++ b/windows.data.xml.dom/xmlelement_removeattribute_1193643678.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveAttribute(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.RemoveAttribute ## -description Removes or replaces the named attribute. ## -parameters ### -param attributeName The name of the attribute to be removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveAttribute(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.RemoveAttribute + +## -description +Removes or replaces the named attribute. + +## -parameters +### -param attributeName +The name of the attribute to be removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_removeattributenode_2120605866.md b/windows.data.xml.dom/xmlelement_removeattributenode_2120605866.md index 2268bb68e1..b37c1e5ec8 100644 --- a/windows.data.xml.dom/xmlelement_removeattributenode_2120605866.md +++ b/windows.data.xml.dom/xmlelement_removeattributenode_2120605866.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNode(Windows.Data.Xml.Dom.XmlAttribute) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNode ## -description Removes the specified attribute from this element. ## -parameters ### -param attributeNode The attribute to be removed. ## -returns The removed attribute, if any. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNode(Windows.Data.Xml.Dom.XmlAttribute) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNode + +## -description +Removes the specified attribute from this element. + +## -parameters +### -param attributeNode +The attribute to be removed. + +## -returns +The removed attribute, if any. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_removeattributens_853369305.md b/windows.data.xml.dom/xmlelement_removeattributens_853369305.md index dd311ce0bf..1cbb51ca32 100644 --- a/windows.data.xml.dom/xmlelement_removeattributens_853369305.md +++ b/windows.data.xml.dom/xmlelement_removeattributens_853369305.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNS ## -description Removes the specified attribute from this element in the specified namespace. ## -parameters ### -param namespaceUri The namespace of attribute to be removed. ### -param localName The name of the attribute without the namespace prefix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.RemoveAttributeNS + +## -description +Removes the specified attribute from this element in the specified namespace. + +## -parameters +### -param namespaceUri +The namespace of attribute to be removed. + +### -param localName +The name of the attribute without the namespace prefix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_removechild_1165510615.md b/windows.data.xml.dom/xmlelement_removechild_1165510615.md index 9df623d3a9..3611d6192f 100644 --- a/windows.data.xml.dom/xmlelement_removechild_1165510615.md +++ b/windows.data.xml.dom/xmlelement_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_replacechild_85158540.md b/windows.data.xml.dom/xmlelement_replacechild_85158540.md index 2cd71b85fd..711086368a 100644 --- a/windows.data.xml.dom/xmlelement_replacechild_85158540.md +++ b/windows.data.xml.dom/xmlelement_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_selectnodes_71711491.md b/windows.data.xml.dom/xmlelement_selectnodes_71711491.md index c75621c832..d99a85b2da 100644 --- a/windows.data.xml.dom/xmlelement_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmlelement_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_selectnodesns_2126476717.md b/windows.data.xml.dom/xmlelement_selectnodesns_2126476717.md index 91d30a9604..57512cd480 100644 --- a/windows.data.xml.dom/xmlelement_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmlelement_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmlelement_selectsinglenode_1817002489.md index 44bf8069ca..86568565d1 100644 --- a/windows.data.xml.dom/xmlelement_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmlelement_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmlelement_selectsinglenodens_1164847996.md index caafb45c34..ba0b23cbda 100644 --- a/windows.data.xml.dom/xmlelement_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmlelement_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_setattribute_2012716166.md b/windows.data.xml.dom/xmlelement_setattribute_2012716166.md index a423f16c49..94cbe0960e 100644 --- a/windows.data.xml.dom/xmlelement_setattribute_2012716166.md +++ b/windows.data.xml.dom/xmlelement_setattribute_2012716166.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttribute(System.String,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SetAttribute ## -description Sets the value of the named attribute. ## -parameters ### -param attributeName The name of the required attribute. ### -param attributeValue The new value for the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttribute(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SetAttribute + +## -description +Sets the value of the named attribute. + +## -parameters +### -param attributeName +The name of the required attribute. + +### -param attributeValue +The new value for the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_setattributenode_1809833043.md b/windows.data.xml.dom/xmlelement_setattributenode_1809833043.md index f111f594dc..02ec09a48c 100644 --- a/windows.data.xml.dom/xmlelement_setattributenode_1809833043.md +++ b/windows.data.xml.dom/xmlelement_setattributenode_1809833043.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttributeNode(Windows.Data.Xml.Dom.XmlAttribute) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SetAttributeNode ## -description Sets or updates the supplied attribute node on this element. ## -parameters ### -param newAttribute A pointer to the new attribute. ## -returns The returned pointer to the previous attribute (if any) with the same name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttributeNode(Windows.Data.Xml.Dom.XmlAttribute) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SetAttributeNode + +## -description +Sets or updates the supplied attribute node on this element. + +## -parameters +### -param newAttribute +A pointer to the new attribute. + +## -returns +The returned pointer to the previous attribute (if any) with the same name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_setattributenodens_336591962.md b/windows.data.xml.dom/xmlelement_setattributenodens_336591962.md index 2bbb5c177c..117272a599 100644 --- a/windows.data.xml.dom/xmlelement_setattributenodens_336591962.md +++ b/windows.data.xml.dom/xmlelement_setattributenodens_336591962.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttributeNodeNS(Windows.Data.Xml.Dom.XmlAttribute) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SetAttributeNodeNS ## -description Sets or updates the supplied attribute node on this element. If you are not using any namespaces, then use the [SetAttributeNode](xmlelement_setattributenode.md) method. ## -parameters ### -param newAttribute The node to add to the collection. > [!NOTE] > You set the namespace when you create the node using the [CreateAttributeNS](xmldocument_createattributens.md) method. ## -returns The attribute successfully added to the collection. If Null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttributeNodeNS(Windows.Data.Xml.Dom.XmlAttribute) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SetAttributeNodeNS + +## -description +Sets or updates the supplied attribute node on this element. If you are not using any namespaces, then use the [SetAttributeNode](xmlelement_setattributenode.md) method. + +## -parameters +### -param newAttribute +The node to add to the collection. + +> [!NOTE] +> You set the namespace when you create the node using the [CreateAttributeNS](xmldocument_createattributens.md) method. + +## -returns +The attribute successfully added to the collection. If Null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_setattributens_2017164580.md b/windows.data.xml.dom/xmlelement_setattributens_2017164580.md index 861b6c0982..fd15df8b7b 100644 --- a/windows.data.xml.dom/xmlelement_setattributens_2017164580.md +++ b/windows.data.xml.dom/xmlelement_setattributens_2017164580.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttributeNS(System.Object,System.String,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlElement.SetAttributeNS ## -description Sets the value of the named attribute in the given namespace. ## -parameters ### -param namespaceUri The namespace of the attribute being set. ### -param qualifiedName The name of the attribute being set. ### -param value The new value for the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlElement.SetAttributeNS(System.Object,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlElement.SetAttributeNS + +## -description +Sets the value of the named attribute in the given namespace. + +## -parameters +### -param namespaceUri +The namespace of the attribute being set. + +### -param qualifiedName +The name of the attribute being set. + +### -param value +The new value for the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlelement_tagname.md b/windows.data.xml.dom/xmlelement_tagname.md index b3891c1eca..58fcea342c 100644 --- a/windows.data.xml.dom/xmlelement_tagname.md +++ b/windows.data.xml.dom/xmlelement_tagname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlElement.TagName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlElement.TagName ## -description Gets the element name. ## -property-value The tag for this element. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlElement.TagName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlElement.TagName + +## -description +Gets the element name. + +## -property-value +The tag for this element. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_appendchild_1014377324.md b/windows.data.xml.dom/xmlentityreference_appendchild_1014377324.md index 4633accccd..16a41a0c04 100644 --- a/windows.data.xml.dom/xmlentityreference_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmlentityreference_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_attributes.md b/windows.data.xml.dom/xmlentityreference_attributes.md index 9a13262e05..05614c1329 100644 --- a/windows.data.xml.dom/xmlentityreference_attributes.md +++ b/windows.data.xml.dom/xmlentityreference_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_childnodes.md b/windows.data.xml.dom/xmlentityreference_childnodes.md index 99ac402aff..bed62d011c 100644 --- a/windows.data.xml.dom/xmlentityreference_childnodes.md +++ b/windows.data.xml.dom/xmlentityreference_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_clonenode_554530370.md b/windows.data.xml.dom/xmlentityreference_clonenode_554530370.md index 6cc1967aaa..f90f6b7a97 100644 --- a/windows.data.xml.dom/xmlentityreference_clonenode_554530370.md +++ b/windows.data.xml.dom/xmlentityreference_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_firstchild.md b/windows.data.xml.dom/xmlentityreference_firstchild.md index c0af30f08a..b4e1598b17 100644 --- a/windows.data.xml.dom/xmlentityreference_firstchild.md +++ b/windows.data.xml.dom/xmlentityreference_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_getxml_999931642.md b/windows.data.xml.dom/xmlentityreference_getxml_999931642.md index ffeef7e0e8..8941d49d06 100644 --- a/windows.data.xml.dom/xmlentityreference_getxml_999931642.md +++ b/windows.data.xml.dom/xmlentityreference_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_haschildnodes_464206014.md b/windows.data.xml.dom/xmlentityreference_haschildnodes_464206014.md index 9583546a7d..3b879d9bdb 100644 --- a/windows.data.xml.dom/xmlentityreference_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmlentityreference_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_innertext.md b/windows.data.xml.dom/xmlentityreference_innertext.md index da879e425d..1931b5cbfe 100644 --- a/windows.data.xml.dom/xmlentityreference_innertext.md +++ b/windows.data.xml.dom/xmlentityreference_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_insertbefore_88135496.md b/windows.data.xml.dom/xmlentityreference_insertbefore_88135496.md index 8c4616d8fa..b369341dfa 100644 --- a/windows.data.xml.dom/xmlentityreference_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmlentityreference_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_lastchild.md b/windows.data.xml.dom/xmlentityreference_lastchild.md index 4a2128205f..463352dce4 100644 --- a/windows.data.xml.dom/xmlentityreference_lastchild.md +++ b/windows.data.xml.dom/xmlentityreference_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_localname.md b/windows.data.xml.dom/xmlentityreference_localname.md index 4fc2045ad5..3ee868a977 100644 --- a/windows.data.xml.dom/xmlentityreference_localname.md +++ b/windows.data.xml.dom/xmlentityreference_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_namespaceuri.md b/windows.data.xml.dom/xmlentityreference_namespaceuri.md index c64fbd8498..aafad0b358 100644 --- a/windows.data.xml.dom/xmlentityreference_namespaceuri.md +++ b/windows.data.xml.dom/xmlentityreference_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_nextsibling.md b/windows.data.xml.dom/xmlentityreference_nextsibling.md index 07babf7989..eabe5c4383 100644 --- a/windows.data.xml.dom/xmlentityreference_nextsibling.md +++ b/windows.data.xml.dom/xmlentityreference_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_nodename.md b/windows.data.xml.dom/xmlentityreference_nodename.md index 5f353d2356..e31fec9a1b 100644 --- a/windows.data.xml.dom/xmlentityreference_nodename.md +++ b/windows.data.xml.dom/xmlentityreference_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_nodetype.md b/windows.data.xml.dom/xmlentityreference_nodetype.md index eb6ca26c0a..b0d6b0c619 100644 --- a/windows.data.xml.dom/xmlentityreference_nodetype.md +++ b/windows.data.xml.dom/xmlentityreference_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_nodevalue.md b/windows.data.xml.dom/xmlentityreference_nodevalue.md index 614ceb95ee..8cb5832030 100644 --- a/windows.data.xml.dom/xmlentityreference_nodevalue.md +++ b/windows.data.xml.dom/xmlentityreference_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_normalize_347475160.md b/windows.data.xml.dom/xmlentityreference_normalize_347475160.md index 70cf21abe3..c02c280465 100644 --- a/windows.data.xml.dom/xmlentityreference_normalize_347475160.md +++ b/windows.data.xml.dom/xmlentityreference_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_ownerdocument.md b/windows.data.xml.dom/xmlentityreference_ownerdocument.md index 74f4845703..fa1acfbbed 100644 --- a/windows.data.xml.dom/xmlentityreference_ownerdocument.md +++ b/windows.data.xml.dom/xmlentityreference_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_parentnode.md b/windows.data.xml.dom/xmlentityreference_parentnode.md index 10dbc3d1c0..4885d79c48 100644 --- a/windows.data.xml.dom/xmlentityreference_parentnode.md +++ b/windows.data.xml.dom/xmlentityreference_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_prefix.md b/windows.data.xml.dom/xmlentityreference_prefix.md index 62011d12f1..2645c78f37 100644 --- a/windows.data.xml.dom/xmlentityreference_prefix.md +++ b/windows.data.xml.dom/xmlentityreference_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_previoussibling.md b/windows.data.xml.dom/xmlentityreference_previoussibling.md index 992deaaa97..2aafe9c75a 100644 --- a/windows.data.xml.dom/xmlentityreference_previoussibling.md +++ b/windows.data.xml.dom/xmlentityreference_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlEntityReference.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlEntityReference.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_removechild_1165510615.md b/windows.data.xml.dom/xmlentityreference_removechild_1165510615.md index d865d2fbc4..54a119f68e 100644 --- a/windows.data.xml.dom/xmlentityreference_removechild_1165510615.md +++ b/windows.data.xml.dom/xmlentityreference_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_replacechild_85158540.md b/windows.data.xml.dom/xmlentityreference_replacechild_85158540.md index 2bc1492f07..cc80aadd47 100644 --- a/windows.data.xml.dom/xmlentityreference_replacechild_85158540.md +++ b/windows.data.xml.dom/xmlentityreference_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_selectnodes_71711491.md b/windows.data.xml.dom/xmlentityreference_selectnodes_71711491.md index e682850b79..e59e1a9a87 100644 --- a/windows.data.xml.dom/xmlentityreference_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmlentityreference_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_selectnodesns_2126476717.md b/windows.data.xml.dom/xmlentityreference_selectnodesns_2126476717.md index 32ce9e7fda..c42b78d07d 100644 --- a/windows.data.xml.dom/xmlentityreference_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmlentityreference_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmlentityreference_selectsinglenode_1817002489.md index c7f3f743b8..520cda8f6d 100644 --- a/windows.data.xml.dom/xmlentityreference_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmlentityreference_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlentityreference_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmlentityreference_selectsinglenodens_1164847996.md index 54f563fbe9..144e12e884 100644 --- a/windows.data.xml.dom/xmlentityreference_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmlentityreference_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlEntityReference.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlloadsettings_elementcontentwhitespace.md b/windows.data.xml.dom/xmlloadsettings_elementcontentwhitespace.md index f60aaac09a..b2b99fc1ec 100644 --- a/windows.data.xml.dom/xmlloadsettings_elementcontentwhitespace.md +++ b/windows.data.xml.dom/xmlloadsettings_elementcontentwhitespace.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ElementContentWhiteSpace --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlLoadSettings.ElementContentWhiteSpace ## -description Specifies whether default handling preserves white space. ## -property-value True if default processing preserves white space; otherwise false. The default value is true. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ElementContentWhiteSpace +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlLoadSettings.ElementContentWhiteSpace + +## -description +Specifies whether default handling preserves white space. + +## -property-value +True if default processing preserves white space; otherwise false. The default value is true. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlloadsettings_maxelementdepth.md b/windows.data.xml.dom/xmlloadsettings_maxelementdepth.md index 12464497fa..23d316bce6 100644 --- a/windows.data.xml.dom/xmlloadsettings_maxelementdepth.md +++ b/windows.data.xml.dom/xmlloadsettings_maxelementdepth.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.MaxElementDepth --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlLoadSettings.MaxElementDepth ## -description Gets and sets the limits of the element depth of an XML document to be loaded into a DOM object. ## -property-value The depth value. The default value is 256. ## -remarks A zero (0) value means no limits on the element depth of an XML document. A non-zero value specifies the maximum depth. An entity counts as one level of nesting. For example, if you have an entity that references an XML document that includes two nested XML elements, set the value to 3. When the DOM object is cloned, the value of this property is propagated to the cloned object. When the size of an XML document exceeds the limit set by this property, a load error will result when the document is parsed. This property helps to avoid denial of service attacks in which a document is submitted that has excessive element depth. Failure to limit the element depth leaves you open to the exploit where a relatively small XML document can cause denial of service. The **MaxElementDepth** property mitigates this threat. If you are concerned about denial of service, you should set this property to a value that allows you to load your documents yet limits depth to a reasonable level. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.MaxElementDepth +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlLoadSettings.MaxElementDepth + +## -description +Gets and sets the limits of the element depth of an XML document to be loaded into a DOM object. + +## -property-value +The depth value. The default value is 256. + +## -remarks +A zero (0) value means no limits on the element depth of an XML document. A non-zero value specifies the maximum depth. + +An entity counts as one level of nesting. For example, if you have an entity that references an XML document that includes two nested XML elements, set the value to 3. + +When the DOM object is cloned, the value of this property is propagated to the cloned object. When the size of an XML document exceeds the limit set by this property, a load error will result when the document is parsed. + +This property helps to avoid denial of service attacks in which a document is submitted that has excessive element depth. Failure to limit the element depth leaves you open to the exploit where a relatively small XML document can cause denial of service. The **MaxElementDepth** property mitigates this threat. If you are concerned about denial of service, you should set this property to a value that allows you to load your documents yet limits depth to a reasonable level. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlloadsettings_prohibitdtd.md b/windows.data.xml.dom/xmlloadsettings_prohibitdtd.md index dc10504e4c..e614cb4a32 100644 --- a/windows.data.xml.dom/xmlloadsettings_prohibitdtd.md +++ b/windows.data.xml.dom/xmlloadsettings_prohibitdtd.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ProhibitDtd --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlLoadSettings.ProhibitDtd ## -description Gets or sets a value that specifies whether to prohibit or allow the inclusion of a DTD in the XML DOM document. ## -property-value True to prohibit the inclusion of a DTD in the XML DOM document; false to allow the inclusion. The default value is true. ## -remarks This property allows you to prohibit DTD use and can help prevent a denial of service attack in some situations. For example, an application might become unresponsive if a large number of entity references are included with the DTD and require resolution when the document XML is parsed and loaded. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ProhibitDtd +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlLoadSettings.ProhibitDtd + +## -description +Gets or sets a value that specifies whether to prohibit or allow the inclusion of a DTD in the XML DOM document. + +## -property-value +True to prohibit the inclusion of a DTD in the XML DOM document; false to allow the inclusion. The default value is true. + +## -remarks +This property allows you to prohibit DTD use and can help prevent a denial of service attack in some situations. For example, an application might become unresponsive if a large number of entity references are included with the DTD and require resolution when the document XML is parsed and loaded. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlloadsettings_resolveexternals.md b/windows.data.xml.dom/xmlloadsettings_resolveexternals.md index e662073144..79b8b5d6ad 100644 --- a/windows.data.xml.dom/xmlloadsettings_resolveexternals.md +++ b/windows.data.xml.dom/xmlloadsettings_resolveexternals.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ResolveExternals --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlLoadSettings.ResolveExternals ## -description Gets or sets a value that specifies whether external definitions, resolvable namespaces, external subsets of document type definitions (DTDs), and external entity references are to be resolved at the time the document is parsed. ## -property-value True if external definitions, resolvable namespaces, external subsets of DTDs, and external entity references are resolved at the time the document is parsed; otherwise false. The default value is false. ## -remarks When this property is true, external definitions are resolved at parse time. This allows default attributes and data types to be defined on elements from the schema and allows use of the DTD as a file inclusion mechanism. This setting is independent of whether validation is to be performed, as indicated by the value of the [ValidateOnParse](xmlloadsettings_validateonparse.md) property. If externals cannot be resolved during validation, a validation error occurs. When the value of **ResolveExternals** is false, externals are not resolved and validation is not performed. A resolvable namespace is indicated by a namespace Universal Resource Identifier (URI) that begins with "x-schema:" as its prefix. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ResolveExternals +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlLoadSettings.ResolveExternals + +## -description +Gets or sets a value that specifies whether external definitions, resolvable namespaces, external subsets of document type definitions (DTDs), and external entity references are to be resolved at the time the document is parsed. + +## -property-value +True if external definitions, resolvable namespaces, external subsets of DTDs, and external entity references are resolved at the time the document is parsed; otherwise false. The default value is false. + +## -remarks +When this property is true, external definitions are resolved at parse time. This allows default attributes and data types to be defined on elements from the schema and allows use of the DTD as a file inclusion mechanism. + +This setting is independent of whether validation is to be performed, as indicated by the value of the [ValidateOnParse](xmlloadsettings_validateonparse.md) property. If externals cannot be resolved during validation, a validation error occurs. When the value of **ResolveExternals** is false, externals are not resolved and validation is not performed. + +A resolvable namespace is indicated by a namespace Universal Resource Identifier (URI) that begins with "x-schema:" as its prefix. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlloadsettings_validateonparse.md b/windows.data.xml.dom/xmlloadsettings_validateonparse.md index 75c635f6ae..8802fe3190 100644 --- a/windows.data.xml.dom/xmlloadsettings_validateonparse.md +++ b/windows.data.xml.dom/xmlloadsettings_validateonparse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ValidateOnParse --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlLoadSettings.ValidateOnParse ## -description Gets or sets a value that specifies whether the XML parser should validate this document against the document type definition (DTD) on loading. ## -property-value If true, the internal or external DTD will be used to validate the document. The default value is false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlLoadSettings.ValidateOnParse +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlLoadSettings.ValidateOnParse + +## -description +Gets or sets a value that specifies whether the XML parser should validate this document against the document type definition (DTD) on loading. + +## -property-value +If true, the internal or external DTD will be used to validate the document. The default value is false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlloadsettings_xmlloadsettings_1221375020.md b/windows.data.xml.dom/xmlloadsettings_xmlloadsettings_1221375020.md index 4eeeb6cee7..97db3ed91b 100644 --- a/windows.data.xml.dom/xmlloadsettings_xmlloadsettings_1221375020.md +++ b/windows.data.xml.dom/xmlloadsettings_xmlloadsettings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlLoadSettings.#ctor --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlLoadSettings.XmlLoadSettings ## -description Creates a new [XmlLoadSettings](xmlloadsettings.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlLoadSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlLoadSettings.XmlLoadSettings + +## -description +Creates a new [XmlLoadSettings](xmlloadsettings.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_first_1920739956.md b/windows.data.xml.dom/xmlnamednodemap_first_1920739956.md index d69f0bab77..ad13a05ec0 100644 --- a/windows.data.xml.dom/xmlnamednodemap_first_1920739956.md +++ b/windows.data.xml.dom/xmlnamednodemap_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.First --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.First ## -description Returns an iterator that iterates over the items in the collection. ## -returns The iterator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.First +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.First + +## -description +Returns an iterator that iterates over the items in the collection. + +## -returns +The iterator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_getat_496709656.md b/windows.data.xml.dom/xmlnamednodemap_getat_496709656.md index d650509194..040a835eb3 100644 --- a/windows.data.xml.dom/xmlnamednodemap_getat_496709656.md +++ b/windows.data.xml.dom/xmlnamednodemap_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.GetAt ## -description Returns the item at the specified index in the vector view. ## -parameters ### -param index The zero-based index of the item in the vector view to return. ## -returns The item in the vector view at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.GetAt + +## -description +Returns the item at the specified index in the vector view. + +## -parameters +### -param index +The zero-based index of the item in the vector view to return. + +## -returns +The item in the vector view at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_getmany_1180991412.md b/windows.data.xml.dom/xmlnamednodemap_getmany_1180991412.md index 79e09b3613..659ecdbfb4 100644 --- a/windows.data.xml.dom/xmlnamednodemap_getmany_1180991412.md +++ b/windows.data.xml.dom/xmlnamednodemap_getmany_1180991412.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetMany(System.UInt32,Windows.Data.Xml.Dom.IXmlNode[]) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.GetMany ## -description Returns the items that start at the specified index of the vector view. ## -parameters ### -param startIndex The zero-based index of the start of the items in the vector to return. ### -param items The items in the vector view that start at *startIndex*. ## -returns The number of items returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetMany(System.UInt32,Windows.Data.Xml.Dom.IXmlNode[]) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.GetMany + +## -description +Returns the items that start at the specified index of the vector view. + +## -parameters +### -param startIndex +The zero-based index of the start of the items in the vector to return. + +### -param items +The items in the vector view that start at *startIndex*. + +## -returns +The number of items returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_getnameditem_2051383144.md b/windows.data.xml.dom/xmlnamednodemap_getnameditem_2051383144.md index cb84ad3b8d..e7b64303ad 100644 --- a/windows.data.xml.dom/xmlnamednodemap_getnameditem_2051383144.md +++ b/windows.data.xml.dom/xmlnamednodemap_getnameditem_2051383144.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItem(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItem ## -description Retrieves the attribute with the specified name. ## -parameters ### -param name The name of the attribute. ## -returns The returned attribute with the specified name. This method returns Null if the attribute node is not in this collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItem(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItem + +## -description +Retrieves the attribute with the specified name. + +## -parameters +### -param name +The name of the attribute. + +## -returns +The returned attribute with the specified name. This method returns Null if the attribute node is not in this collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_getnameditemns_1012941850.md b/windows.data.xml.dom/xmlnamednodemap_getnameditemns_1012941850.md index b5fabd2a40..d8de5785ca 100644 --- a/windows.data.xml.dom/xmlnamednodemap_getnameditemns_1012941850.md +++ b/windows.data.xml.dom/xmlnamednodemap_getnameditemns_1012941850.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItemNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItemNS ## -description Retrieves the attribute with the specified namespace and name. ## -parameters ### -param namespaceUri The namespace name of the attribute. ### -param name The name of the attribute. ## -returns The attribute with the specified namespace and name. This method returns Null if the attribute node is not in this collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItemNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.GetNamedItemNS + +## -description +Retrieves the attribute with the specified namespace and name. + +## -parameters +### -param namespaceUri +The namespace name of the attribute. + +### -param name +The name of the attribute. + +## -returns +The attribute with the specified namespace and name. This method returns Null if the attribute node is not in this collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_indexof_975080885.md b/windows.data.xml.dom/xmlnamednodemap_indexof_975080885.md index 7d327d48ca..d395c2b14c 100644 --- a/windows.data.xml.dom/xmlnamednodemap_indexof_975080885.md +++ b/windows.data.xml.dom/xmlnamednodemap_indexof_975080885.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.IndexOf(Windows.Data.Xml.Dom.IXmlNode,System.UInt32@) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.IndexOf ## -description Returns the index of a specified item in the vector view. ## -parameters ### -param value The item to find in the vector view. ### -param index The zero-based index of the item if found. Zero is returned if the item is not found. ## -returns TRUE if the item is found; otherwise, FALSE if it is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.IndexOf(Windows.Data.Xml.Dom.IXmlNode,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.IndexOf + +## -description +Returns the index of a specified item in the vector view. + +## -parameters +### -param value +The item to find in the vector view. + +### -param index +The zero-based index of the item if found. Zero is returned if the item is not found. + +## -returns +TRUE if the item is found; otherwise, FALSE if it is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_item_136949887.md b/windows.data.xml.dom/xmlnamednodemap_item_136949887.md index 2c9a0f09df..5524f9854c 100644 --- a/windows.data.xml.dom/xmlnamednodemap_item_136949887.md +++ b/windows.data.xml.dom/xmlnamednodemap_item_136949887.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.Item(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.Item ## -description Allows random access to individual nodes within the collection. ## -parameters ### -param index The index of the item within the collection. The first item is zero. ## -returns The object to access. This method returns **null** if the index is out of range. ## -remarks > **Microsoft .NET** > For C# and Microsoft Visual Basic, [XmlNamedNodeMap](xmlnamednodemap.md) has a property named [Item](xmlnamednodemap_item_1.md) (not a method). That property is the Microsoft .NET indexer property for the collection and also supports a **set** syntax. For more info and the usage syntax see [Item](xmlnamednodemap_item_1.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.Item(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.Item + +## -description +Allows random access to individual nodes within the collection. + +## -parameters +### -param index +The index of the item within the collection. The first item is zero. + +## -returns +The object to access. This method returns **null** if the index is out of range. + +## -remarks +> **Microsoft .NET** +> For C# and Microsoft Visual Basic, [XmlNamedNodeMap](xmlnamednodemap.md) has a property named [Item](xmlnamednodemap_item_1.md) (not a method). That property is the Microsoft .NET indexer property for the collection and also supports a **set** syntax. For more info and the usage syntax see [Item](xmlnamednodemap_item_1.md). + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_length.md b/windows.data.xml.dom/xmlnamednodemap_length.md index 631aeb41ff..15d19e11c0 100644 --- a/windows.data.xml.dom/xmlnamednodemap_length.md +++ b/windows.data.xml.dom/xmlnamednodemap_length.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlNamedNodeMap.Length --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.Length ## -description Gets the length of the list of nodes. ## -property-value The number of nodes in the list. ## -remarks The range of valid child node indices is 0 to length-1 inclusive. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlNamedNodeMap.Length +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.Length + +## -description +Gets the length of the list of nodes. + +## -property-value +The number of nodes in the list. + +## -remarks +The range of valid child node indices is 0 to length-1 inclusive. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_removenameditem_303420908.md b/windows.data.xml.dom/xmlnamednodemap_removenameditem_303420908.md index cd11d24809..91d6833a56 100644 --- a/windows.data.xml.dom/xmlnamednodemap_removenameditem_303420908.md +++ b/windows.data.xml.dom/xmlnamednodemap_removenameditem_303420908.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItem(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItem ## -description Removes the specified item. ## -parameters ### -param name The name of the attribute to remove from the collection. ## -returns The node removed from the collection. This method returns Null if the named node is not an attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItem(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItem + +## -description +Removes the specified item. + +## -parameters +### -param name +The name of the attribute to remove from the collection. + +## -returns +The node removed from the collection. This method returns Null if the named node is not an attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_removenameditemns_1921591319.md b/windows.data.xml.dom/xmlnamednodemap_removenameditemns_1921591319.md index be59c5b213..24b9d98f03 100644 --- a/windows.data.xml.dom/xmlnamednodemap_removenameditemns_1921591319.md +++ b/windows.data.xml.dom/xmlnamednodemap_removenameditemns_1921591319.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItemNS(System.Object,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItemNS ## -description Removes an item that is specified by a namespace and local name. ## -parameters ### -param namespaceUri The namespace name of the attribute. ### -param name The name of the attribute. ## -returns The node removed from the collection. This method returns Null if the named node is not an attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItemNS(System.Object,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.RemoveNamedItemNS + +## -description +Removes an item that is specified by a namespace and local name. + +## -parameters +### -param namespaceUri +The namespace name of the attribute. + +### -param name +The name of the attribute. + +## -returns +The node removed from the collection. This method returns Null if the named node is not an attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_setnameditem_762437060.md b/windows.data.xml.dom/xmlnamednodemap_setnameditem_762437060.md index bbc7e114a2..5ff69da353 100644 --- a/windows.data.xml.dom/xmlnamednodemap_setnameditem_762437060.md +++ b/windows.data.xml.dom/xmlnamednodemap_setnameditem_762437060.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItem(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItem ## -description Adds the specified node to the collection. ## -parameters ### -param node The node to add to the collection. ## -returns The attribute successfully added to the collection. If Null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItem(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItem + +## -description +Adds the specified node to the collection. + +## -parameters +### -param node +The node to add to the collection. + +## -returns +The attribute successfully added to the collection. If Null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_setnameditemns_589220033.md b/windows.data.xml.dom/xmlnamednodemap_setnameditemns_589220033.md index 642426a754..e431d87bf0 100644 --- a/windows.data.xml.dom/xmlnamednodemap_setnameditemns_589220033.md +++ b/windows.data.xml.dom/xmlnamednodemap_setnameditemns_589220033.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItemNS(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItemNS ## -description Adds the specified node to the collection in the specified namespace. If you are not using any namespaces, then use the [SetNamedItem](xmlnamednodemap_setnameditem.md) method. ## -parameters ### -param node The node to add to the collection. > [!NOTE] > You set the namespace when you create the node using the [CreateAttributeNS](xmldocument_createattributens.md) or [CreateElementNS](xmldocument_createelementns.md) methods. ## -returns The attribute successfully added to the collection. If Null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItemNS(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.SetNamedItemNS + +## -description +Adds the specified node to the collection in the specified namespace. If you are not using any namespaces, then use the [SetNamedItem](xmlnamednodemap_setnameditem.md) method. + +## -parameters +### -param node +The node to add to the collection. + +> [!NOTE] +> You set the namespace when you create the node using the [CreateAttributeNS](xmldocument_createattributens.md) or [CreateElementNS](xmldocument_createelementns.md) methods. + +## -returns +The attribute successfully added to the collection. If Null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnamednodemap_size.md b/windows.data.xml.dom/xmlnamednodemap_size.md index e4dc7c3cd9..38f61fac0d 100644 --- a/windows.data.xml.dom/xmlnamednodemap_size.md +++ b/windows.data.xml.dom/xmlnamednodemap_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlNamedNodeMap.Size --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlNamedNodeMap.Size ## -description Gets the number of elements in the vector view. ## -property-value The number of elements in the vector view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlNamedNodeMap.Size +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlNamedNodeMap.Size + +## -description +Gets the number of elements in the vector view. + +## -property-value +The number of elements in the vector view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_first_1920739956.md b/windows.data.xml.dom/xmlnodelist_first_1920739956.md index c2cd63e07d..3d10082cfb 100644 --- a/windows.data.xml.dom/xmlnodelist_first_1920739956.md +++ b/windows.data.xml.dom/xmlnodelist_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNodeList.First --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNodeList.First ## -description Returns an iterator that iterates over the items in the collection. ## -returns The iterator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNodeList.First +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.First + +## -description +Returns an iterator that iterates over the items in the collection. + +## -returns +The iterator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_getat_496709656.md b/windows.data.xml.dom/xmlnodelist_getat_496709656.md index c5030ab2f7..01b7a229b7 100644 --- a/windows.data.xml.dom/xmlnodelist_getat_496709656.md +++ b/windows.data.xml.dom/xmlnodelist_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNodeList.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNodeList.GetAt ## -description Returns the item at the specified index in the vector view. ## -parameters ### -param index The zero-based index of the item in the vector view to return. ## -returns The item in the vector view at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNodeList.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.GetAt + +## -description +Returns the item at the specified index in the vector view. + +## -parameters +### -param index +The zero-based index of the item in the vector view to return. + +## -returns +The item in the vector view at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_getmany_1180991412.md b/windows.data.xml.dom/xmlnodelist_getmany_1180991412.md index 3686984c5c..3b0e0dd605 100644 --- a/windows.data.xml.dom/xmlnodelist_getmany_1180991412.md +++ b/windows.data.xml.dom/xmlnodelist_getmany_1180991412.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNodeList.GetMany(System.UInt32,Windows.Data.Xml.Dom.IXmlNode[]) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNodeList.GetMany ## -description Returns the items that start at the specified index of the vector view. ## -parameters ### -param startIndex The zero-based index of the start of the items in the vector to return. ### -param items The items in the vector view that start at *startIndex*. ## -returns The number of items returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNodeList.GetMany(System.UInt32,Windows.Data.Xml.Dom.IXmlNode[]) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.GetMany + +## -description +Returns the items that start at the specified index of the vector view. + +## -parameters +### -param startIndex +The zero-based index of the start of the items in the vector to return. + +### -param items +The items in the vector view that start at *startIndex*. + +## -returns +The number of items returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_indexof_975080885.md b/windows.data.xml.dom/xmlnodelist_indexof_975080885.md index b58f900f34..249f1875f3 100644 --- a/windows.data.xml.dom/xmlnodelist_indexof_975080885.md +++ b/windows.data.xml.dom/xmlnodelist_indexof_975080885.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNodeList.IndexOf(Windows.Data.Xml.Dom.IXmlNode,System.UInt32@) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNodeList.IndexOf ## -description Returns the index of a specified item in the vector. ## -parameters ### -param value The item to find in the vector. ### -param index The zero-based index of the item if found. Zero is returned if the item is not found. ## -returns TRUE if the item is found; otherwise, FALSE if the item is not found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNodeList.IndexOf(Windows.Data.Xml.Dom.IXmlNode,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.IndexOf + +## -description +Returns the index of a specified item in the vector. + +## -parameters +### -param value +The item to find in the vector. + +### -param index +The zero-based index of the item if found. Zero is returned if the item is not found. + +## -returns +TRUE if the item is found; otherwise, FALSE if the item is not found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_item_136949887.md b/windows.data.xml.dom/xmlnodelist_item_136949887.md index 77cd90b596..8eb9a52a36 100644 --- a/windows.data.xml.dom/xmlnodelist_item_136949887.md +++ b/windows.data.xml.dom/xmlnodelist_item_136949887.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlNodeList.Item(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlNodeList.Item ## -description Returns the item in the list at the specified index. ## -parameters ### -param index The zero-based index of the requested item. ## -returns The requested item. This method returns NULL if the index is not valid. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlNodeList.Item(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.Item + +## -description +Returns the item in the list at the specified index. + +## -parameters +### -param index +The zero-based index of the requested item. + +## -returns +The requested item. This method returns NULL if the index is not valid. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_length.md b/windows.data.xml.dom/xmlnodelist_length.md index 12a210a40d..09acfb352e 100644 --- a/windows.data.xml.dom/xmlnodelist_length.md +++ b/windows.data.xml.dom/xmlnodelist_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlNodeList.Length --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlNodeList.Length ## -description Gets the length of the list. ## -property-value The length of the list. The range of valid child node indices is 0 to length-1 inclusive. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlNodeList.Length +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.Length + +## -description +Gets the length of the list. + +## -property-value +The length of the list. The range of valid child node indices is 0 to length-1 inclusive. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlnodelist_size.md b/windows.data.xml.dom/xmlnodelist_size.md index af45c93397..a6154a1533 100644 --- a/windows.data.xml.dom/xmlnodelist_size.md +++ b/windows.data.xml.dom/xmlnodelist_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlNodeList.Size --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlNodeList.Size ## -description Gets the number of elements in the vector view. ## -property-value The number of elements in the vector view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlNodeList.Size +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlNodeList.Size + +## -description +Gets the number of elements in the vector view. + +## -property-value +The number of elements in the vector view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_appendchild_1014377324.md b/windows.data.xml.dom/xmlprocessinginstruction_appendchild_1014377324.md index bbea519bef..07207c6cf0 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_attributes.md b/windows.data.xml.dom/xmlprocessinginstruction_attributes.md index 188491f511..69b0190539 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_attributes.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_childnodes.md b/windows.data.xml.dom/xmlprocessinginstruction_childnodes.md index e48d046c64..bcb2671baf 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_childnodes.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_clonenode_554530370.md b/windows.data.xml.dom/xmlprocessinginstruction_clonenode_554530370.md index d79af7d7f8..053a8e93e7 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_clonenode_554530370.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_data.md b/windows.data.xml.dom/xmlprocessinginstruction_data.md index 6d1a3ed0ce..f364243266 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_data.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Data --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.Data ## -description Gets or sets the content of the processing instruction, excluding the target. ## -property-value The content of the processing instruction, excluding the target. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Data +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.Data + +## -description +Gets or sets the content of the processing instruction, excluding the target. + +## -property-value +The content of the processing instruction, excluding the target. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_firstchild.md b/windows.data.xml.dom/xmlprocessinginstruction_firstchild.md index 6df3e09e59..7c520367f1 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_firstchild.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_getxml_999931642.md b/windows.data.xml.dom/xmlprocessinginstruction_getxml_999931642.md index 96a25bd29d..e562d97796 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_getxml_999931642.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_haschildnodes_464206014.md b/windows.data.xml.dom/xmlprocessinginstruction_haschildnodes_464206014.md index 25908ae00a..16a8e13814 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_innertext.md b/windows.data.xml.dom/xmlprocessinginstruction_innertext.md index f6008d044e..d78aad500c 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_innertext.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_insertbefore_88135496.md b/windows.data.xml.dom/xmlprocessinginstruction_insertbefore_88135496.md index 52d539abc3..4404a39c19 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_lastchild.md b/windows.data.xml.dom/xmlprocessinginstruction_lastchild.md index 817b5f0b0d..2a31d2925c 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_lastchild.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_localname.md b/windows.data.xml.dom/xmlprocessinginstruction_localname.md index 4810a670d1..29bd612f45 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_localname.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_namespaceuri.md b/windows.data.xml.dom/xmlprocessinginstruction_namespaceuri.md index ec9e9015bc..29a35dfe81 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_namespaceuri.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_nextsibling.md b/windows.data.xml.dom/xmlprocessinginstruction_nextsibling.md index 2178087ccc..be9d52655e 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_nextsibling.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_nodename.md b/windows.data.xml.dom/xmlprocessinginstruction_nodename.md index 036dd1538d..3a8ddd3b95 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_nodename.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_nodetype.md b/windows.data.xml.dom/xmlprocessinginstruction_nodetype.md index 4004f26ac4..463cc3aff2 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_nodetype.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_nodevalue.md b/windows.data.xml.dom/xmlprocessinginstruction_nodevalue.md index cf6ab9264a..cce8d76793 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_nodevalue.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_normalize_347475160.md b/windows.data.xml.dom/xmlprocessinginstruction_normalize_347475160.md index badfa132ec..80f9b261e4 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_normalize_347475160.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_ownerdocument.md b/windows.data.xml.dom/xmlprocessinginstruction_ownerdocument.md index 640f5cf496..feaa5cf95a 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_ownerdocument.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_parentnode.md b/windows.data.xml.dom/xmlprocessinginstruction_parentnode.md index bd704de10a..edaf9c6137 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_parentnode.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_prefix.md b/windows.data.xml.dom/xmlprocessinginstruction_prefix.md index f420bdd2a7..94b38ade36 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_prefix.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_previoussibling.md b/windows.data.xml.dom/xmlprocessinginstruction_previoussibling.md index b26367d5cb..47dd2bb1bf 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_previoussibling.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_removechild_1165510615.md b/windows.data.xml.dom/xmlprocessinginstruction_removechild_1165510615.md index f8d7d8427b..873047d1d8 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_removechild_1165510615.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_replacechild_85158540.md b/windows.data.xml.dom/xmlprocessinginstruction_replacechild_85158540.md index ad515d5b4d..464bbe299d 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_replacechild_85158540.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_selectnodes_71711491.md b/windows.data.xml.dom/xmlprocessinginstruction_selectnodes_71711491.md index d37179241d..6267ed0bce 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_selectnodesns_2126476717.md b/windows.data.xml.dom/xmlprocessinginstruction_selectnodesns_2126476717.md index ebf484e515..51f61a1bdb 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenode_1817002489.md index 1064c80318..d146deb9ff 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenodens_1164847996.md index 9f2a6981dd..d4d3f4b8d1 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmlprocessinginstruction_target.md b/windows.data.xml.dom/xmlprocessinginstruction_target.md index 8d04aa4b54..062cc36eac 100644 --- a/windows.data.xml.dom/xmlprocessinginstruction_target.md +++ b/windows.data.xml.dom/xmlprocessinginstruction_target.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Target --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlProcessingInstruction.Target ## -description Gets the target for the processing instruction. ## -property-value The target application to which this processing instruction is directed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlProcessingInstruction.Target +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlProcessingInstruction.Target + +## -description +Gets the target for the processing instruction. + +## -property-value +The target application to which this processing instruction is directed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_appendchild_1014377324.md b/windows.data.xml.dom/xmltext_appendchild_1014377324.md index 736300ed25..cd5a54c543 100644 --- a/windows.data.xml.dom/xmltext_appendchild_1014377324.md +++ b/windows.data.xml.dom/xmltext_appendchild_1014377324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.AppendChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.AppendChild ## -description Appends a new child node as the last child of the node. ## -parameters ### -param newChild The new child node to be appended to the end of the list of children of this node. ## -returns The new child node successfully appended to the list. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.AppendChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.AppendChild + +## -description +Appends a new child node as the last child of the node. + +## -parameters +### -param newChild +The new child node to be appended to the end of the list of children of this node. + +## -returns +The new child node successfully appended to the list. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_appenddata_1408952063.md b/windows.data.xml.dom/xmltext_appenddata_1408952063.md index e12553c1c5..9094bba6ea 100644 --- a/windows.data.xml.dom/xmltext_appenddata_1408952063.md +++ b/windows.data.xml.dom/xmltext_appenddata_1408952063.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.AppendData(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.AppendData ## -description Appends the supplied string to the existing string data. ## -parameters ### -param data The data to be appended to the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.AppendData(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.AppendData + +## -description +Appends the supplied string to the existing string data. + +## -parameters +### -param data +The data to be appended to the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_attributes.md b/windows.data.xml.dom/xmltext_attributes.md index d079c324b0..e5809c1eaa 100644 --- a/windows.data.xml.dom/xmltext_attributes.md +++ b/windows.data.xml.dom/xmltext_attributes.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.Attributes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.Attributes ## -description Gets the list of attributes of this node. ## -property-value The attributes for this node. ## -remarks This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. The following table describes the attributes for the node types.
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.Attributes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.Attributes + +## -description +Gets the list of attributes of this node. + +## -property-value +The attributes for this node. + +## -remarks +This property returns a [XmlNamedNodeMap](xmlnamednodemap.md) for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the [XmlNamedNodeMap](xmlnamednodemap.md) is always returned; when there are no attributes on the element, the list length is set to zero. + +The following table describes the attributes for the node types. + + + + + + + + + + + + + + + +
NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_childnodes.md b/windows.data.xml.dom/xmltext_childnodes.md index 19fc8a92cc..8e614c50b6 100644 --- a/windows.data.xml.dom/xmltext_childnodes.md +++ b/windows.data.xml.dom/xmltext_childnodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.ChildNodes --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.ChildNodes ## -description Gets a list of children in the current node. ## -property-value The list of child nodes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.ChildNodes +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.ChildNodes + +## -description +Gets a list of children in the current node. + +## -property-value +The list of child nodes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_clonenode_554530370.md b/windows.data.xml.dom/xmltext_clonenode_554530370.md index cf7b299643..8642455044 100644 --- a/windows.data.xml.dom/xmltext_clonenode_554530370.md +++ b/windows.data.xml.dom/xmltext_clonenode_554530370.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.CloneNode(System.Boolean) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.CloneNode ## -description Clones a new node. ## -parameters ### -param deep A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. ## -returns The newly created clone node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.CloneNode(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.CloneNode + +## -description +Clones a new node. + +## -parameters +### -param deep +A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. + +## -returns +The newly created clone node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_data.md b/windows.data.xml.dom/xmltext_data.md index b0b6eee1b4..dcca189113 100644 --- a/windows.data.xml.dom/xmltext_data.md +++ b/windows.data.xml.dom/xmltext_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.Data --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.Data ## -description Gets or sets the node data depending on the node type. ## -property-value The node data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.Data +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.Data + +## -description +Gets or sets the node data depending on the node type. + +## -property-value +The node data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_deletedata_1339091348.md b/windows.data.xml.dom/xmltext_deletedata_1339091348.md index d946d0dc75..365727cdad 100644 --- a/windows.data.xml.dom/xmltext_deletedata_1339091348.md +++ b/windows.data.xml.dom/xmltext_deletedata_1339091348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.DeleteData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.DeleteData ## -description Deletes specified data. ## -parameters ### -param offset The offset, in characters, at which to start deleting the string data. ### -param count The number of characters to delete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.DeleteData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.DeleteData + +## -description +Deletes specified data. + +## -parameters +### -param offset +The offset, in characters, at which to start deleting the string data. + +### -param count +The number of characters to delete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_firstchild.md b/windows.data.xml.dom/xmltext_firstchild.md index c08771505f..fe4cfd11cc 100644 --- a/windows.data.xml.dom/xmltext_firstchild.md +++ b/windows.data.xml.dom/xmltext_firstchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.FirstChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.FirstChild ## -description Gets the first child node. ## -property-value The first child node. This property returns NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.FirstChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.FirstChild + +## -description +Gets the first child node. + +## -property-value +The first child node. This property returns NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_getxml_999931642.md b/windows.data.xml.dom/xmltext_getxml_999931642.md index 2c671bd4c4..17770f4151 100644 --- a/windows.data.xml.dom/xmltext_getxml_999931642.md +++ b/windows.data.xml.dom/xmltext_getxml_999931642.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.GetXml --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.GetXml ## -description Returns the XML representation of the node and all its descendants. ## -returns The XML representation of the node and all its descendants. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.GetXml +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.GetXml + +## -description +Returns the XML representation of the node and all its descendants. + +## -returns +The XML representation of the node and all its descendants. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_haschildnodes_464206014.md b/windows.data.xml.dom/xmltext_haschildnodes_464206014.md index e801333f70..503a37cdc6 100644 --- a/windows.data.xml.dom/xmltext_haschildnodes_464206014.md +++ b/windows.data.xml.dom/xmltext_haschildnodes_464206014.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.HasChildNodes --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.HasChildNodes ## -description Determines whether a node has children. ## -returns True if this node has children; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.HasChildNodes +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.HasChildNodes + +## -description +Determines whether a node has children. + +## -returns +True if this node has children; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_innertext.md b/windows.data.xml.dom/xmltext_innertext.md index b9871760b9..6160513b07 100644 --- a/windows.data.xml.dom/xmltext_innertext.md +++ b/windows.data.xml.dom/xmltext_innertext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.InnerText --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.InnerText ## -description Gets the text from inside the XML. ## -property-value The text from inside the XML. Returns an empty string if there is no text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.InnerText +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.InnerText + +## -description +Gets the text from inside the XML. + +## -property-value +The text from inside the XML. Returns an empty string if there is no text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_insertbefore_88135496.md b/windows.data.xml.dom/xmltext_insertbefore_88135496.md index 826ea5cd54..bb43333377 100644 --- a/windows.data.xml.dom/xmltext_insertbefore_88135496.md +++ b/windows.data.xml.dom/xmltext_insertbefore_88135496.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.InsertBefore ## -description Inserts a child node to the left of the specified node, or at the end of the list. ## -parameters ### -param newChild The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. ### -param referenceChild The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. ## -returns On success, the child node that was inserted. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.InsertBefore(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.InsertBefore + +## -description +Inserts a child node to the left of the specified node, or at the end of the list. + +## -parameters +### -param newChild +The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. + +If *newChild* is already in the tree, it is first removed before it is reinserted before the *referenceChild* node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the *newChild* parameter. + +### -param referenceChild +The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. + +## -returns +On success, the child node that was inserted. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_insertdata_1015561500.md b/windows.data.xml.dom/xmltext_insertdata_1015561500.md index 27272f2f2f..0f3a9ae512 100644 --- a/windows.data.xml.dom/xmltext_insertdata_1015561500.md +++ b/windows.data.xml.dom/xmltext_insertdata_1015561500.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.InsertData(System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.InsertData ## -description Inserts a string at the specified offset. ## -parameters ### -param offset The offset, in characters, at which to insert the supplied string data. ### -param data The data to be inserted into the existing string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.InsertData(System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.InsertData + +## -description +Inserts a string at the specified offset. + +## -parameters +### -param offset +The offset, in characters, at which to insert the supplied string data. + +### -param data +The data to be inserted into the existing string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_lastchild.md b/windows.data.xml.dom/xmltext_lastchild.md index cf729e69ca..833d5716be 100644 --- a/windows.data.xml.dom/xmltext_lastchild.md +++ b/windows.data.xml.dom/xmltext_lastchild.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.LastChild --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.LastChild ## -description Gets the last child node. ## -property-value The last child node. This property is NULL if there are no children. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.LastChild +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.LastChild + +## -description +Gets the last child node. + +## -property-value +The last child node. This property is NULL if there are no children. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_length.md b/windows.data.xml.dom/xmltext_length.md index f6b6ec6150..e882536912 100644 --- a/windows.data.xml.dom/xmltext_length.md +++ b/windows.data.xml.dom/xmltext_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.Length --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.Length ## -description Gets the length of the data, in Unicode characters. ## -property-value The length of the data, in Unicode characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.Length +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.Length + +## -description +Gets the length of the data, in Unicode characters. + +## -property-value +The length of the data, in Unicode characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_localname.md b/windows.data.xml.dom/xmltext_localname.md index 4dac4c2e93..387168760a 100644 --- a/windows.data.xml.dom/xmltext_localname.md +++ b/windows.data.xml.dom/xmltext_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.LocalName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.LocalName ## -description Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. ## -property-value The local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.LocalName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.LocalName + +## -description +Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML. + +## -property-value +The local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_namespaceuri.md b/windows.data.xml.dom/xmltext_namespaceuri.md index b2f13fb22d..32db49bf92 100644 --- a/windows.data.xml.dom/xmltext_namespaceuri.md +++ b/windows.data.xml.dom/xmltext_namespaceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.NamespaceUri --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.NamespaceUri ## -description Returns the Uniform Resource Identifier (URI) for the namespace. ## -property-value The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.NamespaceUri +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.NamespaceUri + +## -description +Returns the Uniform Resource Identifier (URI) for the namespace. + +## -property-value +The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_nextsibling.md b/windows.data.xml.dom/xmltext_nextsibling.md index f2c3b44d1c..29c4319f52 100644 --- a/windows.data.xml.dom/xmltext_nextsibling.md +++ b/windows.data.xml.dom/xmltext_nextsibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.NextSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.NextSibling ## -description Gets the next sibling of the node in the parent's child list. ## -property-value The right sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.NextSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.NextSibling + +## -description +Gets the next sibling of the node in the parent's child list. + +## -property-value +The right sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_nodename.md b/windows.data.xml.dom/xmltext_nodename.md index d29cdceacb..0c029f0a6f 100644 --- a/windows.data.xml.dom/xmltext_nodename.md +++ b/windows.data.xml.dom/xmltext_nodename.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.NodeName --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.NodeName ## -description Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. ## -property-value The qualified node name, which varies depending on the node type. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.NodeName +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.NodeName + +## -description +Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types. + +## -property-value +The qualified node name, which varies depending on the node type. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_nodetype.md b/windows.data.xml.dom/xmltext_nodetype.md index ce69d3eee5..98f49a9118 100644 --- a/windows.data.xml.dom/xmltext_nodetype.md +++ b/windows.data.xml.dom/xmltext_nodetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.NodeType --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.NodeType ## -description Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. ## -property-value The node type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.NodeType +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.NodeType + +## -description +Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes. + +## -property-value +The node type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_nodevalue.md b/windows.data.xml.dom/xmltext_nodevalue.md index e0751ed151..a047ed0d9a 100644 --- a/windows.data.xml.dom/xmltext_nodevalue.md +++ b/windows.data.xml.dom/xmltext_nodevalue.md @@ -1,3 +1,39 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.NodeValue --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.NodeValue ## -description Gets or sets the text associated with the node. ## -property-value The text associated with the node. ## -remarks This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency.
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.NodeValue +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.NodeValue + +## -description +Gets or sets the text associated with the node. + +## -property-value +The text associated with the node. + +## -remarks +This value depends on the [NodeType](ixmlnode_nodetype.md) property. The following table describes this dependency. + + + + + + + + + + + + + + + +
NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL
+ +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_normalize_347475160.md b/windows.data.xml.dom/xmltext_normalize_347475160.md index e0c27f5f07..301180b8a2 100644 --- a/windows.data.xml.dom/xmltext_normalize_347475160.md +++ b/windows.data.xml.dom/xmltext_normalize_347475160.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.Normalize --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.Normalize ## -description Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.Normalize +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.Normalize + +## -description +Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_ownerdocument.md b/windows.data.xml.dom/xmltext_ownerdocument.md index 87760e022b..74d7de05e0 100644 --- a/windows.data.xml.dom/xmltext_ownerdocument.md +++ b/windows.data.xml.dom/xmltext_ownerdocument.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.OwnerDocument --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.OwnerDocument ## -description Returns the root of the document that contains the node. ## -property-value The parent document that represents the root of the document. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.OwnerDocument +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.OwnerDocument + +## -description +Returns the root of the document that contains the node. + +## -property-value +The parent document that represents the root of the document. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_parentnode.md b/windows.data.xml.dom/xmltext_parentnode.md index aea1aae65d..9db26231d8 100644 --- a/windows.data.xml.dom/xmltext_parentnode.md +++ b/windows.data.xml.dom/xmltext_parentnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.ParentNode --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.ParentNode ## -description Gets the parent node of the node instance. ## -property-value The parent node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.ParentNode +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.ParentNode + +## -description +Gets the parent node of the node instance. + +## -property-value +The parent node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_prefix.md b/windows.data.xml.dom/xmltext_prefix.md index 4a359d078c..efc5738b9e 100644 --- a/windows.data.xml.dom/xmltext_prefix.md +++ b/windows.data.xml.dom/xmltext_prefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.Prefix --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.Prefix ## -description Gets or sets the namespace prefix. ## -property-value The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.Prefix +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.Prefix + +## -description +Gets or sets the namespace prefix. + +## -property-value +The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_previoussibling.md b/windows.data.xml.dom/xmltext_previoussibling.md index e878d21aa4..c2b76ac391 100644 --- a/windows.data.xml.dom/xmltext_previoussibling.md +++ b/windows.data.xml.dom/xmltext_previoussibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Data.Xml.Dom.XmlText.PreviousSibling --api-type: winrt property ---- # Windows.Data.Xml.Dom.XmlText.PreviousSibling ## -description Gets the previous sibling of the node in the parent's child list. ## -property-value The left sibling of this node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Data.Xml.Dom.XmlText.PreviousSibling +-api-type: winrt property +--- + + + +# Windows.Data.Xml.Dom.XmlText.PreviousSibling + +## -description +Gets the previous sibling of the node in the parent's child list. + +## -property-value +The left sibling of this node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_removechild_1165510615.md b/windows.data.xml.dom/xmltext_removechild_1165510615.md index 3616cd3a85..58e1cd4671 100644 --- a/windows.data.xml.dom/xmltext_removechild_1165510615.md +++ b/windows.data.xml.dom/xmltext_removechild_1165510615.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.RemoveChild ## -description Removes the specified child node from the list of children and returns it. ## -parameters ### -param childNode The child node to be removed from the list of children of this node. ## -returns The removed child node. If null, the *childNode* object is not removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.RemoveChild(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.RemoveChild + +## -description +Removes the specified child node from the list of children and returns it. + +## -parameters +### -param childNode +The child node to be removed from the list of children of this node. + +## -returns +The removed child node. If null, the *childNode* object is not removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_replacechild_85158540.md b/windows.data.xml.dom/xmltext_replacechild_85158540.md index 51740d8f80..9ec7836065 100644 --- a/windows.data.xml.dom/xmltext_replacechild_85158540.md +++ b/windows.data.xml.dom/xmltext_replacechild_85158540.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.ReplaceChild ## -description Replaces the specified old child node with the supplied new child node. ## -parameters ### -param newChild The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. ### -param referenceChild The old child that is to be replaced by the new child. ## -returns The old child that is replaced. If null, no object is created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.ReplaceChild(Windows.Data.Xml.Dom.IXmlNode,Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.ReplaceChild + +## -description +Replaces the specified old child node with the supplied new child node. + +## -parameters +### -param newChild +The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. + +### -param referenceChild +The old child that is to be replaced by the new child. + +## -returns +The old child that is replaced. If null, no object is created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_replacedata_1060591057.md b/windows.data.xml.dom/xmltext_replacedata_1060591057.md index a5ac63cb0e..7e8ae698ae 100644 --- a/windows.data.xml.dom/xmltext_replacedata_1060591057.md +++ b/windows.data.xml.dom/xmltext_replacedata_1060591057.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.ReplaceData(System.UInt32,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.ReplaceData ## -description Replaces the specified number of characters with the supplied string. ## -parameters ### -param offset The offset, in characters, at which to start replacing string data. ### -param count The number of characters to replace. ### -param data The new data that replaces the old string data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.ReplaceData(System.UInt32,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.ReplaceData + +## -description +Replaces the specified number of characters with the supplied string. + +## -parameters +### -param offset +The offset, in characters, at which to start replacing string data. + +### -param count +The number of characters to replace. + +### -param data +The new data that replaces the old string data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_selectnodes_71711491.md b/windows.data.xml.dom/xmltext_selectnodes_71711491.md index f6556f587e..2d37ecdcff 100644 --- a/windows.data.xml.dom/xmltext_selectnodes_71711491.md +++ b/windows.data.xml.dom/xmltext_selectnodes_71711491.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.SelectNodes(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.SelectNodes ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.SelectNodes(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.SelectNodes + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_selectnodesns_2126476717.md b/windows.data.xml.dom/xmltext_selectnodesns_2126476717.md index fa781a0aca..ac40891879 100644 --- a/windows.data.xml.dom/xmltext_selectnodesns_2126476717.md +++ b/windows.data.xml.dom/xmltext_selectnodesns_2126476717.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.SelectNodesNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.SelectNodesNS ## -description Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.SelectNodesNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.SelectNodesNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an [XmlNodeList](xmlnodelist.md). + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_selectsinglenode_1817002489.md b/windows.data.xml.dom/xmltext_selectsinglenode_1817002489.md index d08dcb0bdd..64331fbc9b 100644 --- a/windows.data.xml.dom/xmltext_selectsinglenode_1817002489.md +++ b/windows.data.xml.dom/xmltext_selectsinglenode_1817002489.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.SelectSingleNode(System.String) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.SelectSingleNode ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.SelectSingleNode(System.String) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.SelectSingleNode + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_selectsinglenodens_1164847996.md b/windows.data.xml.dom/xmltext_selectsinglenodens_1164847996.md index b9f939b555..903d764060 100644 --- a/windows.data.xml.dom/xmltext_selectsinglenodens_1164847996.md +++ b/windows.data.xml.dom/xmltext_selectsinglenodens_1164847996.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.SelectSingleNodeNS(System.String,System.Object) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.SelectSingleNodeNS ## -description Applies the specified pattern-matching operation to this node's context and returns the first matching node. ## -parameters ### -param xpath Specifies an XPath expression. ### -param namespaces Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. ## -returns The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. ## -remarks Prefixes in the query are resolved using the specified namespace declarations. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.SelectSingleNodeNS(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.SelectSingleNodeNS + +## -description +Applies the specified pattern-matching operation to this node's context and returns the first matching node. + +## -parameters +### -param xpath +Specifies an XPath expression. + +### -param namespaces +Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. + +## -returns +The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value. + +## -remarks +Prefixes in the query are resolved using the specified namespace declarations. + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_splittext_1458849685.md b/windows.data.xml.dom/xmltext_splittext_1458849685.md index e70598f03d..29adeb3be0 100644 --- a/windows.data.xml.dom/xmltext_splittext_1458849685.md +++ b/windows.data.xml.dom/xmltext_splittext_1458849685.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.SplitText(System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.SplitText ## -description Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node. ## -parameters ### -param offset The number of characters at which to split this text node into two nodes, starting from zero. ## -returns The new text node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.SplitText(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.SplitText + +## -description +Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node. + +## -parameters +### -param offset +The number of characters at which to split this text node into two nodes, starting from zero. + +## -returns +The new text node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.dom/xmltext_substringdata_67214485.md b/windows.data.xml.dom/xmltext_substringdata_67214485.md index 1d264df75a..72bff8cefa 100644 --- a/windows.data.xml.dom/xmltext_substringdata_67214485.md +++ b/windows.data.xml.dom/xmltext_substringdata_67214485.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Data.Xml.Dom.XmlText.SubstringData(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Data.Xml.Dom.XmlText.SubstringData ## -description Retrieves a substring of the full string from the specified range. ## -parameters ### -param offset The offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. ### -param count The number of characters to retrieve from the specified offset. ## -returns The returned substring. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Dom.XmlText.SubstringData(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Dom.XmlText.SubstringData + +## -description +Retrieves a substring of the full string from the specified range. + +## -parameters +### -param offset +The offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. + +### -param count +The number of characters to retrieve from the specified offset. + +## -returns +The returned substring. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.xsl/xsltprocessor_transformtodocument_204388955.md b/windows.data.xml.xsl/xsltprocessor_transformtodocument_204388955.md index 92c8eafd97..9f6456ec99 100644 --- a/windows.data.xml.xsl/xsltprocessor_transformtodocument_204388955.md +++ b/windows.data.xml.xsl/xsltprocessor_transformtodocument_204388955.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Xsl.XsltProcessor.TransformToDocument(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Xsl.XsltProcessor.TransformToDocument ## -description Processes a node and its children and returns the resulting [XmlDocument](../windows.data.xml.dom/xmldocument.md). ## -parameters ### -param inputNode The node to process. ## -returns The resulting transformation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Xsl.XsltProcessor.TransformToDocument(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Xsl.XsltProcessor.TransformToDocument + +## -description +Processes a node and its children and returns the resulting [XmlDocument](../windows.data.xml.dom/xmldocument.md). + +## -parameters +### -param inputNode +The node to process. + +## -returns +The resulting transformation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.xsl/xsltprocessor_transformtostring_1106762375.md b/windows.data.xml.xsl/xsltprocessor_transformtostring_1106762375.md index 07d3481bc1..6507d37833 100644 --- a/windows.data.xml.xsl/xsltprocessor_transformtostring_1106762375.md +++ b/windows.data.xml.xsl/xsltprocessor_transformtostring_1106762375.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Data.Xml.Xsl.XsltProcessor.TransformToString(Windows.Data.Xml.Dom.IXmlNode) --api-type: winrt method ---- # Windows.Data.Xml.Xsl.XsltProcessor.TransformToString ## -description Processes a node and its children and returns the resulting string transformation. ## -parameters ### -param inputNode The node to process. ## -returns The resulting transformation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Xsl.XsltProcessor.TransformToString(Windows.Data.Xml.Dom.IXmlNode) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Xsl.XsltProcessor.TransformToString + +## -description +Processes a node and its children and returns the resulting string transformation. + +## -parameters +### -param inputNode +The node to process. + +## -returns +The resulting transformation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.data.xml.xsl/xsltprocessor_xsltprocessor_93177318.md b/windows.data.xml.xsl/xsltprocessor_xsltprocessor_93177318.md index c3fb0ec735..5b20b897c0 100644 --- a/windows.data.xml.xsl/xsltprocessor_xsltprocessor_93177318.md +++ b/windows.data.xml.xsl/xsltprocessor_xsltprocessor_93177318.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Data.Xml.Xsl.XsltProcessor.#ctor(Windows.Data.Xml.Dom.XmlDocument) --api-type: winrt method ---- # Windows.Data.Xml.Xsl.XsltProcessor.XsltProcessor ## -description Creates a new [XsltProcessor](xsltprocessor.md) object from the document provided. ## -parameters ### -param document The XSLT to process. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Data.Xml.Xsl.XsltProcessor.#ctor(Windows.Data.Xml.Dom.XmlDocument) +-api-type: winrt method +--- + + + +# Windows.Data.Xml.Xsl.XsltProcessor.XsltProcessor + +## -description +Creates a new [XsltProcessor](xsltprocessor.md) object from the document provided. + +## -parameters +### -param document +The XSLT to process. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_acquirechannel.md b/windows.devices.adc.provider/iadccontrollerprovider_acquirechannel.md index fe1c046908..8f7f311ba0 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_acquirechannel.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_acquirechannel.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.AcquireChannel(System.Int32) --api-type: winrt method ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.AcquireChannel ## -description Acquires a connection to the specified channel. ## -parameters ### -param channel Which channel to connect to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.AcquireChannel(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.AcquireChannel + +## -description +Acquires a connection to the specified channel. + +## -parameters +### -param channel +Which channel to connect to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_channelcount.md b/windows.devices.adc.provider/iadccontrollerprovider_channelcount.md index 1d23befe88..6c18e79de1 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_channelcount.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_channelcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelCount --api-type: winrt property ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelCount ## -description Gets the number of channels available on for the controller. ## -property-value Number of channels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelCount +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelCount + +## -description +Gets the number of channels available on for the controller. + +## -property-value +Number of channels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_channelmode.md b/windows.devices.adc.provider/iadccontrollerprovider_channelmode.md index b28f8528dc..055a615eb5 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_channelmode.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_channelmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelMode --api-type: winrt property ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelMode ## -description Gets or sets the controller channel mode. ## -property-value The channel mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelMode +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.ChannelMode + +## -description +Gets or sets the controller channel mode. + +## -property-value +The channel mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_ischannelmodesupported.md b/windows.devices.adc.provider/iadccontrollerprovider_ischannelmodesupported.md index 7fb7e779a2..4816bf5182 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_ischannelmodesupported.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_ischannelmodesupported.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.IsChannelModeSupported(Windows.Devices.Adc.Provider.ProviderAdcChannelMode) --api-type: winrt method ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.IsChannelModeSupported ## -description Determines if the specified channel mode is supported by the controller. ## -parameters ### -param channelMode The channel mode in question. ## -returns True if the specified channel mode is supported, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.IsChannelModeSupported(Windows.Devices.Adc.Provider.ProviderAdcChannelMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.IsChannelModeSupported + +## -description +Determines if the specified channel mode is supported by the controller. + +## -parameters +### -param channelMode +The channel mode in question. + +## -returns +True if the specified channel mode is supported, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_maxvalue.md b/windows.devices.adc.provider/iadccontrollerprovider_maxvalue.md index 32d5dbcd66..fc23d91731 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_maxvalue.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_maxvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.MaxValue --api-type: winrt property ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.MaxValue ## -description Gets the maximum value that the controller can return. ## -property-value The maximum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.MaxValue +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.MaxValue + +## -description +Gets the maximum value that the controller can return. + +## -property-value +The maximum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_minvalue.md b/windows.devices.adc.provider/iadccontrollerprovider_minvalue.md index 404b714053..1fc9ee0b6a 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_minvalue.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_minvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.MinValue --api-type: winrt property ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.MinValue ## -description Gets the minimum value that the controller can return. ## -property-value The minimum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.MinValue +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.MinValue + +## -description +Gets the minimum value that the controller can return. + +## -property-value +The minimum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_readvalue.md b/windows.devices.adc.provider/iadccontrollerprovider_readvalue.md index 4f32a75998..ad1034e290 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_readvalue.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_readvalue.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.ReadValue(System.Int32) --api-type: winrt method ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.ReadValue ## -description Gets the digital representation of the analog value on the specified channel. ## -parameters ### -param channelNumber Which channel to read from. ## -returns The digital representation of the analog value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.ReadValue(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.ReadValue + +## -description +Gets the digital representation of the analog value on the specified channel. + +## -parameters +### -param channelNumber +Which channel to read from. + +## -returns +The digital representation of the analog value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_releasechannel.md b/windows.devices.adc.provider/iadccontrollerprovider_releasechannel.md index 7073a93ffb..953a29d882 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_releasechannel.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_releasechannel.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.ReleaseChannel(System.Int32) --api-type: winrt method ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.ReleaseChannel ## -description Releases the channel connection, opening that channel for others to use. ## -parameters ### -param channel Which channel to close the connection to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.Provider.IAdcControllerProvider.ReleaseChannel(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.ReleaseChannel + +## -description +Releases the channel connection, opening that channel for others to use. + +## -parameters +### -param channel +Which channel to close the connection to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadccontrollerprovider_resolutioninbits.md b/windows.devices.adc.provider/iadccontrollerprovider_resolutioninbits.md index 95c2869ede..e16f762a25 100644 --- a/windows.devices.adc.provider/iadccontrollerprovider_resolutioninbits.md +++ b/windows.devices.adc.provider/iadccontrollerprovider_resolutioninbits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.ResolutionInBits --api-type: winrt property ---- # Windows.Devices.Adc.Provider.IAdcControllerProvider.ResolutionInBits ## -description Gets the resolution of the controller as number of bits it has. ## -property-value The resolution as number of bits. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.Provider.IAdcControllerProvider.ResolutionInBits +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.Provider.IAdcControllerProvider.ResolutionInBits + +## -description +Gets the resolution of the controller as number of bits it has. + +## -property-value +The resolution as number of bits. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc.provider/iadcprovider_getcontrollers.md b/windows.devices.adc.provider/iadcprovider_getcontrollers.md index a90eafb083..31c5d9c134 100644 --- a/windows.devices.adc.provider/iadcprovider_getcontrollers.md +++ b/windows.devices.adc.provider/iadcprovider_getcontrollers.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Adc.Provider.IAdcProvider.GetControllers --api-type: winrt method ---- # Windows.Devices.Adc.Provider.IAdcProvider.GetControllers ## -description Gets the ADC controllers available on the system. ## -returns When this method completes it returns a list of all the available controllers on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.Provider.IAdcProvider.GetControllers +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.Provider.IAdcProvider.GetControllers + +## -description +Gets the ADC controllers available on the system. + +## -returns +When this method completes it returns a list of all the available controllers on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adcchannel.md b/windows.devices.adc/adcchannel.md index d42c6803bd..ec8dd6cf15 100644 --- a/windows.devices.adc/adcchannel.md +++ b/windows.devices.adc/adcchannel.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Adc.AdcChannel --api-type: winrt class ---- # Windows.Devices.Adc.AdcChannel ## -description Represents a single ADC channel. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Adc.AdcChannel +-api-type: winrt class +--- + + + +# Windows.Devices.Adc.AdcChannel + +## -description +Represents a single ADC channel. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.adc/adcchannel_close_811482585.md b/windows.devices.adc/adcchannel_close_811482585.md index f7f0955f9f..a02b43e772 100644 --- a/windows.devices.adc/adcchannel_close_811482585.md +++ b/windows.devices.adc/adcchannel_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Adc.AdcChannel.Close --api-type: winrt method ---- # Windows.Devices.Adc.AdcChannel.Close ## -description Closes the connection on this channel, making it available to be opened by others. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcChannel.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcChannel.Close + +## -description +Closes the connection on this channel, making it available to be opened by others. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adcchannel_controller.md b/windows.devices.adc/adcchannel_controller.md index b1d88088a7..8ab9cdfa98 100644 --- a/windows.devices.adc/adcchannel_controller.md +++ b/windows.devices.adc/adcchannel_controller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.AdcChannel.Controller --api-type: winrt property ---- # Windows.Devices.Adc.AdcChannel.Controller ## -description Gets the ADC controller for this channel. ## -property-value The ADC controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.AdcChannel.Controller +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.AdcChannel.Controller + +## -description +Gets the ADC controller for this channel. + +## -property-value +The ADC controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adcchannel_readratio_873475695.md b/windows.devices.adc/adcchannel_readratio_873475695.md index 3fc83632ee..3f1f9002e7 100644 --- a/windows.devices.adc/adcchannel_readratio_873475695.md +++ b/windows.devices.adc/adcchannel_readratio_873475695.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Adc.AdcChannel.ReadRatio --api-type: winrt method ---- # Windows.Devices.Adc.AdcChannel.ReadRatio ## -description Reads the value as a percentage of the max value possible for this controller. ## -returns The value as percentage of the max value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcChannel.ReadRatio +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcChannel.ReadRatio + +## -description +Reads the value as a percentage of the max value possible for this controller. + +## -returns +The value as percentage of the max value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adcchannel_readvalue_1994379969.md b/windows.devices.adc/adcchannel_readvalue_1994379969.md index c206d157d9..dfe9d3c7c2 100644 --- a/windows.devices.adc/adcchannel_readvalue_1994379969.md +++ b/windows.devices.adc/adcchannel_readvalue_1994379969.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Adc.AdcChannel.ReadValue --api-type: winrt method ---- # Windows.Devices.Adc.AdcChannel.ReadValue ## -description Reads the digital representation of the analog value from the ADC. ## -returns The digital value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcChannel.ReadValue +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcChannel.ReadValue + +## -description +Reads the digital representation of the analog value from the ADC. + +## -returns +The digital value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller.md b/windows.devices.adc/adccontroller.md index 0b679b497c..7b5d6ff476 100644 --- a/windows.devices.adc/adccontroller.md +++ b/windows.devices.adc/adccontroller.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Adc.AdcController --api-type: winrt class ---- # Windows.Devices.Adc.AdcController ## -description Represents an ADC controller on the system ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Adc.AdcController +-api-type: winrt class +--- + + + +# Windows.Devices.Adc.AdcController + +## -description +Represents an ADC controller on the system + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_channelcount.md b/windows.devices.adc/adccontroller_channelcount.md index c3e9edc383..ba21a16076 100644 --- a/windows.devices.adc/adccontroller_channelcount.md +++ b/windows.devices.adc/adccontroller_channelcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.AdcController.ChannelCount --api-type: winrt property ---- # Windows.Devices.Adc.AdcController.ChannelCount ## -description The number of channels available on the ADC controller. ## -property-value Number of channels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.AdcController.ChannelCount +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.AdcController.ChannelCount + +## -description +The number of channels available on the ADC controller. + +## -property-value +Number of channels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_channelmode.md b/windows.devices.adc/adccontroller_channelmode.md index d6157bbf8d..40b1c87166 100644 --- a/windows.devices.adc/adccontroller_channelmode.md +++ b/windows.devices.adc/adccontroller_channelmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.AdcController.ChannelMode --api-type: winrt property ---- # Windows.Devices.Adc.AdcController.ChannelMode ## -description Gets or sets the channel mode for the ADC controller. ## -property-value The ADC channel mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.AdcController.ChannelMode +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.AdcController.ChannelMode + +## -description +Gets or sets the channel mode for the ADC controller. + +## -property-value +The ADC channel mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_getcontrollersasync_372561093.md b/windows.devices.adc/adccontroller_getcontrollersasync_372561093.md index 5485994d15..1defb2ee93 100644 --- a/windows.devices.adc/adccontroller_getcontrollersasync_372561093.md +++ b/windows.devices.adc/adccontroller_getcontrollersasync_372561093.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Adc.AdcController.GetControllersAsync(Windows.Devices.Adc.Provider.IAdcProvider) --api-type: winrt method ---- # Windows.Devices.Adc.AdcController.GetControllersAsync ## -description Gets all the controllers that are connected to the system asynchronously . ## -parameters ### -param provider The ADC provider for the controllers on the system. ## -returns When the method completes successfully, it returns a list of values that represent the controllers available on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcController.GetControllersAsync(Windows.Devices.Adc.Provider.IAdcProvider) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcController.GetControllersAsync + +## -description +Gets all the controllers that are connected to the system asynchronously . + +## -parameters +### -param provider +The ADC provider for the controllers on the system. + +## -returns +When the method completes successfully, it returns a list of values that represent the controllers available on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_getdefaultasync_1549573963.md b/windows.devices.adc/adccontroller_getdefaultasync_1549573963.md index e11ebe43f5..84891e7f3c 100644 --- a/windows.devices.adc/adccontroller_getdefaultasync_1549573963.md +++ b/windows.devices.adc/adccontroller_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Adc.AdcController.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Adc.AdcController.GetDefaultAsync ## -description Gets the default ADC controller on the system. ## -returns The default ADC controller on the system, or null if the system has no ADC controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcController.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcController.GetDefaultAsync + +## -description +Gets the default ADC controller on the system. + +## -returns +The default ADC controller on the system, or null if the system has no ADC controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_ischannelmodesupported_1326380101.md b/windows.devices.adc/adccontroller_ischannelmodesupported_1326380101.md index 8f2a404ee6..cb4e5222a5 100644 --- a/windows.devices.adc/adccontroller_ischannelmodesupported_1326380101.md +++ b/windows.devices.adc/adccontroller_ischannelmodesupported_1326380101.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Adc.AdcController.IsChannelModeSupported(Windows.Devices.Adc.AdcChannelMode) --api-type: winrt method ---- # Windows.Devices.Adc.AdcController.IsChannelModeSupported ## -description Verifies that the specified channel mode is supported by the controller. ## -parameters ### -param channelMode The channel mode. ## -returns True if the specified channel mode is supported, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcController.IsChannelModeSupported(Windows.Devices.Adc.AdcChannelMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcController.IsChannelModeSupported + +## -description +Verifies that the specified channel mode is supported by the controller. + +## -parameters +### -param channelMode +The channel mode. + +## -returns +True if the specified channel mode is supported, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_maxvalue.md b/windows.devices.adc/adccontroller_maxvalue.md index 2f052a5036..c6b58f5fc7 100644 --- a/windows.devices.adc/adccontroller_maxvalue.md +++ b/windows.devices.adc/adccontroller_maxvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.AdcController.MaxValue --api-type: winrt property ---- # Windows.Devices.Adc.AdcController.MaxValue ## -description Gets the maximum value that the controller can report. ## -property-value The maximum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.AdcController.MaxValue +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.AdcController.MaxValue + +## -description +Gets the maximum value that the controller can report. + +## -property-value +The maximum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_minvalue.md b/windows.devices.adc/adccontroller_minvalue.md index d19b97fe62..e06f0b1bb5 100644 --- a/windows.devices.adc/adccontroller_minvalue.md +++ b/windows.devices.adc/adccontroller_minvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.AdcController.MinValue --api-type: winrt property ---- # Windows.Devices.Adc.AdcController.MinValue ## -description The minimum value the controller can report. ## -property-value The minimum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.AdcController.MinValue +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.AdcController.MinValue + +## -description +The minimum value the controller can report. + +## -property-value +The minimum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_openchannel_1957760911.md b/windows.devices.adc/adccontroller_openchannel_1957760911.md index 2a2efa41d1..5a0148e308 100644 --- a/windows.devices.adc/adccontroller_openchannel_1957760911.md +++ b/windows.devices.adc/adccontroller_openchannel_1957760911.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Adc.AdcController.OpenChannel(System.Int32) --api-type: winrt method ---- # Windows.Devices.Adc.AdcController.OpenChannel ## -description Opens a connection to the specified ADC channel. ## -parameters ### -param channelNumber The channel to connect to. ## -returns The ADC channel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Adc.AdcController.OpenChannel(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Adc.AdcController.OpenChannel + +## -description +Opens a connection to the specified ADC channel. + +## -parameters +### -param channelNumber +The channel to connect to. + +## -returns +The ADC channel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.adc/adccontroller_resolutioninbits.md b/windows.devices.adc/adccontroller_resolutioninbits.md index 41bf71f81e..ea4850aa3a 100644 --- a/windows.devices.adc/adccontroller_resolutioninbits.md +++ b/windows.devices.adc/adccontroller_resolutioninbits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Adc.AdcController.ResolutionInBits --api-type: winrt property ---- # Windows.Devices.Adc.AdcController.ResolutionInBits ## -description Gets the resolution of the controller as number of bits it has. For example, if we have a 10-bit ADC, that means it can detect 1024 (2^10) discrete levels. ## -property-value The number of bits the ADC controller has. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Adc.AdcController.ResolutionInBits +-api-type: winrt property +--- + + + +# Windows.Devices.Adc.AdcController.ResolutionInBits + +## -description +Gets the resolution of the controller as number of bits it has. For example, if we have a 10-bit ADC, that means it can detect 1024 (2^10) discrete levels. + +## -property-value +The number of bits the ADC controller has. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynaboutdata.md b/windows.devices.alljoyn/alljoynaboutdata.md index e462efdb6d..8d4706a47b 100644 --- a/windows.devices.alljoyn/alljoynaboutdata.md +++ b/windows.devices.alljoyn/alljoynaboutdata.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynAboutData --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynAboutData ## -description Used to set descriptive information about the app and the device it is running on. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynAboutData +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData + +## -description +Used to set descriptive information about the app and the device it is running on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_appid.md b/windows.devices.alljoyn/alljoynaboutdata_appid.md index e94da8761c..4c27606aed 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_appid.md +++ b/windows.devices.alljoyn/alljoynaboutdata_appid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.AppId --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.AppId ## -description A globally unique identifier associated with the app. ## -property-value A GUID representing the globally unique identifier. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.AppId +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.AppId + +## -description +A globally unique identifier associated with the app. + +## -property-value +A GUID representing the globally unique identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_appnames.md b/windows.devices.alljoyn/alljoynaboutdata_appnames.md index 2681fe8392..b439bedcfb 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_appnames.md +++ b/windows.devices.alljoyn/alljoynaboutdata_appnames.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.AppNames --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.AppNames ## -description A collection of language-specific app names. ## -property-value The app name in each supported language. ## -remarks By default the returned value contains a single string pair. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.AppNames +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.AppNames + +## -description +A collection of language-specific app names. + +## -property-value +The app name in each supported language. + +## -remarks +By default the returned value contains a single string pair. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_dateofmanufacture.md b/windows.devices.alljoyn/alljoynaboutdata_dateofmanufacture.md index af5625757d..39aaf1627d 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_dateofmanufacture.md +++ b/windows.devices.alljoyn/alljoynaboutdata_dateofmanufacture.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DateOfManufacture --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.DateOfManufacture ## -description The date of manufacture. ## -property-value The date of manufacture in a **YYYY-MM-DD** format. ## -remarks By default the returned value is an empty string for Windows Store app, or the [DateModified](XREF:TODO:properties.props_System_DateModified) property of the EXE for Desktop apps. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DateOfManufacture +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.DateOfManufacture + +## -description +The date of manufacture. + +## -property-value +The date of manufacture in a **YYYY-MM-DD** format. + +## -remarks +By default the returned value is an empty string for Windows Store app, or the [DateModified](XREF:TODO:properties.props_System_DateModified) property of the EXE for Desktop apps. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_defaultappname.md b/windows.devices.alljoyn/alljoynaboutdata_defaultappname.md index ee715d7cb1..7183f63012 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_defaultappname.md +++ b/windows.devices.alljoyn/alljoynaboutdata_defaultappname.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DefaultAppName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.DefaultAppName ## -description The default app name assigned by the manufacturer- either the developer or the OEM. This property is a shortcut to the entry in the [AppNames](alljoynaboutdata_appnames.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). ## -property-value The default app name. ## -remarks By default the returned value is a single entry that indicates in the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md), with value either pulled from the "Display name" field in a Windows Store app 's app manifest, or the [ProductName](XREF:TODO:properties.props_System_Software_ProductName) property of a Desktop app. This property serves as a shortcut to the entry in the [Descriptions](alljoynaboutdata_descriptions.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DefaultAppName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.DefaultAppName + +## -description +The default app name assigned by the manufacturer- either the developer or the OEM. This property is a shortcut to the entry in the [AppNames](alljoynaboutdata_appnames.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). + +## -property-value +The default app name. + +## -remarks +By default the returned value is a single entry that indicates in the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md), with value either pulled from the "Display name" field in a Windows Store app 's app manifest, or the [ProductName](XREF:TODO:properties.props_System_Software_ProductName) property of a Desktop app. + +This property serves as a shortcut to the entry in the [Descriptions](alljoynaboutdata_descriptions.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_defaultdescription.md b/windows.devices.alljoyn/alljoynaboutdata_defaultdescription.md index 45bd1f11f0..892de4f323 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_defaultdescription.md +++ b/windows.devices.alljoyn/alljoynaboutdata_defaultdescription.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DefaultDescription --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.DefaultDescription ## -description The default description of the app. This property is a shortcut to the entry in the [Descriptions](alljoynaboutdata_descriptions.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). ## -property-value The app description. ## -remarks By default the returned value is pulled from either the "Description" field in a Windows Store app 's app manifest, or [FileDescription](XREF:TODO:properties.props_System_FileDescription) property of the EXE in a Desktop app. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DefaultDescription +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.DefaultDescription + +## -description +The default description of the app. This property is a shortcut to the entry in the [Descriptions](alljoynaboutdata_descriptions.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). + +## -property-value +The app description. + +## -remarks +By default the returned value is pulled from either the "Description" field in a Windows Store app 's app manifest, or [FileDescription](XREF:TODO:properties.props_System_FileDescription) property of the EXE in a Desktop app. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_defaultmanufacturer.md b/windows.devices.alljoyn/alljoynaboutdata_defaultmanufacturer.md index f5b39a37dc..0afffd5fc4 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_defaultmanufacturer.md +++ b/windows.devices.alljoyn/alljoynaboutdata_defaultmanufacturer.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DefaultManufacturer --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.DefaultManufacturer ## -description The name of the manufacturer of the app. This property is a shortcut to the entry in the [Manufacturers](alljoynaboutdata_manufacturers.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). ## -property-value The manufacturer name. ## -remarks By default the value returned is pulled from the "Publisher display name" field in the app manifest of a Windows Store app, from the "CompanyName" property of the EXE for a Desktop app, or from the device as defined by the manufacturer. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.DefaultManufacturer +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.DefaultManufacturer + +## -description +The name of the manufacturer of the app. This property is a shortcut to the entry in the [Manufacturers](alljoynaboutdata_manufacturers.md) property for the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). + +## -property-value +The manufacturer name. + +## -remarks +By default the value returned is pulled from the "Publisher display name" field in the app manifest of a Windows Store app, from the "CompanyName" property of the EXE for a Desktop app, or from the device as defined by the manufacturer. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_descriptions.md b/windows.devices.alljoyn/alljoynaboutdata_descriptions.md index f125f9eeb8..df6f1712e8 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_descriptions.md +++ b/windows.devices.alljoyn/alljoynaboutdata_descriptions.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.Descriptions --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.Descriptions ## -description A collection of language-specific app description strings. ## -property-value The app description. ## -remarks By default the returned value contains a single string pair. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.Descriptions +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.Descriptions + +## -description +A collection of language-specific app description strings. + +## -property-value +The app description. + +## -remarks +By default the returned value contains a single string pair. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_isenabled.md b/windows.devices.alljoyn/alljoynaboutdata_isenabled.md index 4be873eeb0..96fa7894ce 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_isenabled.md +++ b/windows.devices.alljoyn/alljoynaboutdata_isenabled.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.IsEnabled --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.IsEnabled ## -description Indicates if the service should advertise the provided [AllJoynAboutData](alljoynaboutdata.md) values. ## -property-value True if enabled; otherwise, false. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.IsEnabled + +## -description +Indicates if the service should advertise the provided [AllJoynAboutData](alljoynaboutdata.md) values. + +## -property-value +True if enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_manufacturers.md b/windows.devices.alljoyn/alljoynaboutdata_manufacturers.md index 06b92f0b04..c97048fc37 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_manufacturers.md +++ b/windows.devices.alljoyn/alljoynaboutdata_manufacturers.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.Manufacturers --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.Manufacturers ## -description A collection of language-specific manufacturer name strings. ## -property-value The manufacturer name in each supported language. ## -remarks By default the value returned contains a single string pair. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.Manufacturers +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.Manufacturers + +## -description +A collection of language-specific manufacturer name strings. + +## -property-value +The manufacturer name in each supported language. + +## -remarks +By default the value returned contains a single string pair. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_modelnumber.md b/windows.devices.alljoyn/alljoynaboutdata_modelnumber.md index 314acb5c17..16b6af9f9c 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_modelnumber.md +++ b/windows.devices.alljoyn/alljoynaboutdata_modelnumber.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.ModelNumber --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.ModelNumber ## -description The model number of the device running the app. ## -property-value The device model number. ## -remarks Defaults to an empty string for all apps. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.ModelNumber +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.ModelNumber + +## -description +The model number of the device running the app. + +## -property-value +The device model number. + +## -remarks +Defaults to an empty string for all apps. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_softwareversion.md b/windows.devices.alljoyn/alljoynaboutdata_softwareversion.md index 2ad6ffea8c..5bcd9fad49 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_softwareversion.md +++ b/windows.devices.alljoyn/alljoynaboutdata_softwareversion.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.SoftwareVersion --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.SoftwareVersion ## -description The version number of the app. Use of this property applies to Producer apps. ## -property-value The version number. ## -remarks By default the returned value is pulled from either the "Version" field of the Windows Store app app manifest, or the "Product version" property of the EXE of a Desktop app. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.SoftwareVersion +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.SoftwareVersion + +## -description +The version number of the app. Use of this property applies to Producer apps. + +## -property-value +The version number. + +## -remarks +By default the returned value is pulled from either the "Version" field of the Windows Store app app manifest, or the "Product version" property of the EXE of a Desktop app. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdata_supporturl.md b/windows.devices.alljoyn/alljoynaboutdata_supporturl.md index 7afd0db7c2..8623419c53 100644 --- a/windows.devices.alljoyn/alljoynaboutdata_supporturl.md +++ b/windows.devices.alljoyn/alljoynaboutdata_supporturl.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.SupportUrl --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutData.SupportUrl ## -description A URL to the manufacturer or developer support portal. ## -property-value The support URL. ## -remarks This property defaults to an empty [Uri](../windows.foundation/uri.md) object, which means the data field is not present in the protocol. This is an optional field that can be populated by the app manufacturer. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutData.SupportUrl +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutData.SupportUrl + +## -description +A URL to the manufacturer or developer support portal. + +## -property-value +The support URL. + +## -remarks +This property defaults to an empty [Uri](../windows.foundation/uri.md) object, which means the data field is not present in the protocol. This is an optional field that can be populated by the app manufacturer. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview.md b/windows.devices.alljoyn/alljoynaboutdataview.md index 440e20c347..a9774ba20b 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview.md +++ b/windows.devices.alljoyn/alljoynaboutdataview.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynAboutDataView --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView ## -description Used to view data about another app and the device it is running on. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynAboutDataView +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView + +## -description +Used to view data about another app and the device it is running on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_ajsoftwareversion.md b/windows.devices.alljoyn/alljoynaboutdataview_ajsoftwareversion.md index 6d8b6ca375..e2f156bcb2 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_ajsoftwareversion.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_ajsoftwareversion.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.AJSoftwareVersion --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.AJSoftwareVersion ## -description The version number for the implemented AllJoyn platform software. ## -property-value Current version number. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.AJSoftwareVersion +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.AJSoftwareVersion + +## -description +The version number for the implemented AllJoyn platform software. + +## -property-value +Current version number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_appid.md b/windows.devices.alljoyn/alljoynaboutdataview_appid.md index 407a4b5267..44c71eb77e 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_appid.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_appid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.AppId --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.AppId ## -description A globally unique identifier associated with the app. ## -property-value A GUID representing the globally unique identifier. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.AppId +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.AppId + +## -description +A globally unique identifier associated with the app. + +## -property-value +A GUID representing the globally unique identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_appname.md b/windows.devices.alljoyn/alljoynaboutdataview_appname.md index 394709d559..1b28c2a0fd 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_appname.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_appname.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.AppName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.AppName ## -description The name of the app. ## -property-value The app name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.AppName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.AppName + +## -description +The name of the app. + +## -property-value +The app name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_dateofmanufacture.md b/windows.devices.alljoyn/alljoynaboutdataview_dateofmanufacture.md index f2fd2dffed..aadbc17d53 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_dateofmanufacture.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_dateofmanufacture.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DateOfManufacture --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.DateOfManufacture ## -description The date of manufacture. ## -property-value A date value in the **YYYY-MM-DD** format. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DateOfManufacture +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.DateOfManufacture + +## -description +The date of manufacture. + +## -property-value +A date value in the **YYYY-MM-DD** format. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_defaultlanguage.md b/windows.devices.alljoyn/alljoynaboutdataview_defaultlanguage.md index db38b33a7f..62112d355c 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_defaultlanguage.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_defaultlanguage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DefaultLanguage --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.DefaultLanguage ## -description The default language of the app. ## -property-value The default language. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DefaultLanguage +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.DefaultLanguage + +## -description +The default language of the app. + +## -property-value +The default language. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_description.md b/windows.devices.alljoyn/alljoynaboutdataview_description.md index 285e55f42a..d8c046fc5b 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_description.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_description.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Description --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.Description ## -description An app description provided by the manufacturer. ## -property-value The app description. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Description +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.Description + +## -description +An app description provided by the manufacturer. + +## -property-value +The app description. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_deviceid.md b/windows.devices.alljoyn/alljoynaboutdataview_deviceid.md index b2635f1197..38a227ec8e 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_deviceid.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceId --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceId ## -description The device ID used during advertising. ## -property-value The device ID. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceId + +## -description +The device ID used during advertising. + +## -property-value +The device ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_devicename.md b/windows.devices.alljoyn/alljoynaboutdataview_devicename.md index 23385035ab..233103260c 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_devicename.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_devicename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceName ## -description Name of the device. ## -property-value The device name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.DeviceName + +## -description +Name of the device. + +## -property-value +The device name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_561097955.md b/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_561097955.md index 4b495e7f5f..b5573449bd 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_561097955.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_561097955.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync(System.String,Windows.Devices.AllJoyn.AllJoynBusAttachment,System.UInt16,Windows.Globalization.Language) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync ## -description Gets the About data for a session in a particular language. ## -parameters ### -param uniqueName The unique name. ### -param busAttachment The bus attachment supporting the session. ### -param sessionPort The port used to connect to the session. ### -param language The language to return the descriptive data in. ## -returns An object containing About data for the session in the set language. ## -remarks ## -examples ## -see-also [GetDataBySessionPortAsync(String, AllJoynBusAttachment, UInt16)](alljoynaboutdataview_getdatabysessionportasync_660342083.md) ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync(System.String,Windows.Devices.AllJoyn.AllJoynBusAttachment,System.UInt16,Windows.Globalization.Language) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync + +## -description +Gets the About data for a session in a particular language. + +## -parameters +### -param uniqueName +The unique name. + +### -param busAttachment +The bus attachment supporting the session. + +### -param sessionPort +The port used to connect to the session. + +### -param language +The language to return the descriptive data in. + +## -returns +An object containing About data for the session in the set language. + +## -remarks + +## -examples + +## -see-also +[GetDataBySessionPortAsync(String, AllJoynBusAttachment, UInt16)](alljoynaboutdataview_getdatabysessionportasync_660342083.md) + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_660342083.md b/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_660342083.md index 94e1e0b930..98e61cc492 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_660342083.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_getdatabysessionportasync_660342083.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync(System.String,Windows.Devices.AllJoyn.AllJoynBusAttachment,System.UInt16) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync ## -description Gets the About data for a session. ## -parameters ### -param uniqueName The unique name. ### -param busAttachment The bus attachment supporting the session. ### -param sessionPort The port used to connect to the session. ## -returns An object containing About data for the session. ## -remarks ## -examples ## -see-also [GetDataBySessionPortAsync(String, AllJoynBusAttachment, UInt16, Language)](alljoynaboutdataview_getdatabysessionportasync_561097955.md) ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync(System.String,Windows.Devices.AllJoyn.AllJoynBusAttachment,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.GetDataBySessionPortAsync + +## -description +Gets the About data for a session. + +## -parameters +### -param uniqueName +The unique name. + +### -param busAttachment +The bus attachment supporting the session. + +### -param sessionPort +The port used to connect to the session. + +## -returns +An object containing About data for the session. + +## -remarks + +## -examples + +## -see-also +[GetDataBySessionPortAsync(String, AllJoynBusAttachment, UInt16, Language)](alljoynaboutdataview_getdatabysessionportasync_561097955.md) + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_hardwareversion.md b/windows.devices.alljoyn/alljoynaboutdataview_hardwareversion.md index 4d5a01cf88..8f19e845b8 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_hardwareversion.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_hardwareversion.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.HardwareVersion --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.HardwareVersion ## -description The current version of the hardware that the app is running on. This field is optional, presenting as an empty string if not set. ## -property-value The hardware version number. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.HardwareVersion +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.HardwareVersion + +## -description +The current version of the hardware that the app is running on. This field is optional, presenting as an empty string if not set. + +## -property-value +The hardware version number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_manufacturer.md b/windows.devices.alljoyn/alljoynaboutdataview_manufacturer.md index 09ed5ff8b9..e77d566d9e 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_manufacturer.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_manufacturer.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Manufacturer --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.Manufacturer ## -description The name of the manufacturer. ## -property-value The manufacturer name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Manufacturer +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.Manufacturer + +## -description +The name of the manufacturer. + +## -property-value +The manufacturer name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_modelnumber.md b/windows.devices.alljoyn/alljoynaboutdataview_modelnumber.md index aa3fd578e8..00464f20e1 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_modelnumber.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_modelnumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.ModelNumber --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.ModelNumber ## -description The model number of the device running the app. ## -property-value The model number. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.ModelNumber +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.ModelNumber + +## -description +The model number of the device running the app. + +## -property-value +The model number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_properties.md b/windows.devices.alljoyn/alljoynaboutdataview_properties.md index 76327b2c11..b87701a10f 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_properties.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_properties.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Properties --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.Properties ## -description This is a set of fields, where each other named [AllJoynAboutDataView](alljoynaboutdataview.md) property is also accessible. For example, [ModelNumber](alljoynaboutdataview_modelnumber.md) is [Properties](alljoynaboutdataview_properties.md)**["ModelNumber"]**. Additionally, this property can be used to get custom properties. ## -property-value A set of fields that provide access to [AllJoynAboutDataView](alljoynaboutdataview.md) properties. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.Properties + +## -description +This is a set of fields, where each other named [AllJoynAboutDataView](alljoynaboutdataview.md) property is also accessible. For example, [ModelNumber](alljoynaboutdataview_modelnumber.md) is [Properties](alljoynaboutdataview_properties.md)**["ModelNumber"]**. Additionally, this property can be used to get custom properties. + +## -property-value +A set of fields that provide access to [AllJoynAboutDataView](alljoynaboutdataview.md) properties. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_softwareversion.md b/windows.devices.alljoyn/alljoynaboutdataview_softwareversion.md index 436fe0b81d..2a9dfca3e0 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_softwareversion.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_softwareversion.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.SoftwareVersion --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.SoftwareVersion ## -description The version number of the app. ## -property-value The version number. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.SoftwareVersion +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.SoftwareVersion + +## -description +The version number of the app. + +## -property-value +The version number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_status.md b/windows.devices.alljoyn/alljoynaboutdataview_status.md index 5765973cfe..976cce8b64 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_status.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_status.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Status --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.Status ## -description The status returned by the [GetDataBySessionPortAsync](alljoynaboutdataview_getdatabysessionportasync.md) operation that created the [AllJoynAboutDataView](alljoynaboutdataview.md) object. ## -property-value The status code. ## -remarks If the returned value is an error, (i.e. anything other than Ok), it can mean that the other properties aren’t populated, opposed to being populated with actual values that might happen to be empty. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.Status +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.Status + +## -description +The status returned by the [GetDataBySessionPortAsync](alljoynaboutdataview_getdatabysessionportasync.md) operation that created the [AllJoynAboutDataView](alljoynaboutdataview.md) object. + +## -property-value +The status code. + +## -remarks +If the returned value is an error, (i.e. anything other than Ok), it can mean that the other properties aren’t populated, opposed to being populated with actual values that might happen to be empty. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_supportedlanguages.md b/windows.devices.alljoyn/alljoynaboutdataview_supportedlanguages.md index e20615bf3b..4795fbb48b 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_supportedlanguages.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_supportedlanguages.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportedLanguages --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportedLanguages ## -description A list of languages supported by the app and will always include the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). ## -property-value A list of [Language](../windows.globalization/language.md) objects. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportedLanguages +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportedLanguages + +## -description +A list of languages supported by the app and will always include the [DefaultLanguage](alljoynaboutdataview_defaultlanguage.md). + +## -property-value +A list of [Language](../windows.globalization/language.md) objects. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynaboutdataview_supporturl.md b/windows.devices.alljoyn/alljoynaboutdataview_supporturl.md index 25076fb6fb..b5b8e82ebd 100644 --- a/windows.devices.alljoyn/alljoynaboutdataview_supporturl.md +++ b/windows.devices.alljoyn/alljoynaboutdataview_supporturl.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportUrl --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportUrl ## -description A URL to the manufacturer or developer support portal. ## -property-value The support URL. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportUrl +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAboutDataView.SupportUrl + +## -description +A URL to the manufacturer or developer support portal. + +## -property-value +The support URL. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs.md index a5b1198fb8..65c69aaf45 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs ## -description Contains information about a join session request that is used to determine if the request will be accepted and initiate the session connection. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs + +## -description +Contains information about a join session request that is used to determine if the request will be accepted and initiate the session connection. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_accept_1944939200.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_accept_1944939200.md index 75035a570d..a16e1863d6 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_accept_1944939200.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_accept_1944939200.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.Accept --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.Accept ## -description Called to accept the session connection. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.Accept +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.Accept + +## -description +Called to accept the session connection. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_alljoynacceptsessionjoinereventargs_1145659634.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_alljoynacceptsessionjoinereventargs_1145659634.md index 7ab5795dea..fc1d8c5186 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_alljoynacceptsessionjoinereventargs_1145659634.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_alljoynacceptsessionjoinereventargs_1145659634.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.#ctor(System.String,System.UInt16,Windows.Devices.AllJoyn.AllJoynTrafficType,System.Byte,Windows.Devices.AllJoyn.IAllJoynAcceptSessionJoiner) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.AllJoynAcceptSessionJoinerEventArgs ## -description Generates an object containing information about the connection being accepted to the session and the method that completes the session join. ## -parameters ### -param uniqueName The unique bus name. ### -param sessionPort The session port used for the connection. ### -param trafficType The type of traffic provided over the connection. ### -param proximity Indicates network proximity. ### -param acceptSessionJoiner The [IAllJoynAcceptSessionJoiner](ialljoynacceptsessionjoiner.md) object used to complete the session join. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.#ctor(System.String,System.UInt16,Windows.Devices.AllJoyn.AllJoynTrafficType,System.Byte,Windows.Devices.AllJoyn.IAllJoynAcceptSessionJoiner) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.AllJoynAcceptSessionJoinerEventArgs + +## -description +Generates an object containing information about the connection being accepted to the session and the method that completes the session join. + +## -parameters +### -param uniqueName +The unique bus name. + +### -param sessionPort +The session port used for the connection. + +### -param trafficType +The type of traffic provided over the connection. + +### -param proximity +Indicates network proximity. + +### -param acceptSessionJoiner +The [IAllJoynAcceptSessionJoiner](ialljoynacceptsessionjoiner.md) object used to complete the session join. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samenetwork.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samenetwork.md index f9d9dd7e6e..fa6571682a 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samenetwork.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samenetwork.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SameNetwork --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SameNetwork ## -description Indicates if the app joining the session is on the same network. ## -property-value True if on the same network; otherwise, false. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SameNetwork +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SameNetwork + +## -description +Indicates if the app joining the session is on the same network. + +## -property-value +True if on the same network; otherwise, false. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samephysicalnode.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samephysicalnode.md index dd44116ebd..a78b187583 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samephysicalnode.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_samephysicalnode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SamePhysicalNode --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SamePhysicalNode ## -description The app joining the session is on the same physical node. ## -property-value True if on the same node; otherwise, false. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SamePhysicalNode +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SamePhysicalNode + +## -description +The app joining the session is on the same physical node. + +## -property-value +True if on the same node; otherwise, false. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_sessionport.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_sessionport.md index 6e64b8d78e..71e51441f4 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_sessionport.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_sessionport.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SessionPort --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SessionPort ## -description The session port being used to connect to the session. ## -property-value The session port number. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SessionPort +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.SessionPort + +## -description +The session port being used to connect to the session. + +## -property-value +The session port number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_traffictype.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_traffictype.md index 170020e6be..d9aca9e662 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_traffictype.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_traffictype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.TrafficType --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.TrafficType ## -description The traffic type supported during the session. ## -property-value The traffic type. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.TrafficType +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.TrafficType + +## -description +The traffic type supported during the session. + +## -property-value +The traffic type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_uniquename.md b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_uniquename.md index 325081a926..7e60c1aace 100644 --- a/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_uniquename.md +++ b/windows.devices.alljoyn/alljoynacceptsessionjoinereventargs_uniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.UniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.UniqueName ## -description The unique bus name of the app requesting a session connection. ## -property-value The unique bus name of the app. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.UniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAcceptSessionJoinerEventArgs.UniqueName + +## -description +The unique bus name of the app requesting a session connection. + +## -property-value +The unique bus name of the app. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs.md b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs.md index 9b0fea0d4c..b20add82b1 100644 --- a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs.md +++ b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs ## -description Contains information about a successful or unsuccessful completion of an authentication operation. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs + +## -description +Contains information about a successful or unsuccessful completion of an authentication operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_authenticationmechanism.md b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_authenticationmechanism.md index 7b742ef7bc..d4e6039a46 100644 --- a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_authenticationmechanism.md +++ b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_authenticationmechanism.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.AuthenticationMechanism --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.AuthenticationMechanism ## -description The mechanism used during authentication. ## -property-value The authentication mechanism. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.AuthenticationMechanism +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.AuthenticationMechanism + +## -description +The mechanism used during authentication. + +## -property-value +The authentication mechanism. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_peeruniquename.md b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_peeruniquename.md index 754e2f35ed..b33147b62e 100644 --- a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_peeruniquename.md +++ b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_peeruniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.PeerUniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.PeerUniqueName ## -description The unique bus name of the Consumer being authenticated. On the initiating side this will be the unique bus name of the remote app being authenticated. On the accepting side this will be the unique bus name for the remote app. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.PeerUniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.PeerUniqueName + +## -description +The unique bus name of the Consumer being authenticated. On the initiating side this will be the unique bus name of the remote app being authenticated. On the accepting side this will be the unique bus name for the remote app. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_succeeded.md b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_succeeded.md index 4cb29a023d..0ad190b5f1 100644 --- a/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_succeeded.md +++ b/windows.devices.alljoyn/alljoynauthenticationcompleteeventargs_succeeded.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.Succeeded --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.Succeeded ## -description Indicates if the remote app was authenticated. ## -property-value True if the authentication was successful; otherwise, false. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.Succeeded +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynAuthenticationCompleteEventArgs.Succeeded + +## -description +Indicates if the remote app was authenticated. + +## -property-value +True if the authentication was successful; otherwise, false. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment.md b/windows.devices.alljoyn/alljoynbusattachment.md index c670968c3b..c37a942728 100644 --- a/windows.devices.alljoyn/alljoynbusattachment.md +++ b/windows.devices.alljoyn/alljoynbusattachment.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynBusAttachment --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment ## -description Represents a connection to the underlying communication pipeline (transport agnostic) that AllJoyn uses to communicate with other endpoints regardless of the transport. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynBusAttachment +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment + +## -description +Represents a connection to the underlying communication pipeline (transport agnostic) that AllJoyn uses to communicate with other endpoints regardless of the transport. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_aboutdata.md b/windows.devices.alljoyn/alljoynbusattachment_aboutdata.md index e1ca94c84f..364d2891fa 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_aboutdata.md +++ b/windows.devices.alljoyn/alljoynbusattachment_aboutdata.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.AboutData --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.AboutData ## -description This property returns an [AllJoynAboutData](alljoynaboutdata.md) object containing the descriptive data that the platform may advertise on behalf of the app. ## -property-value An object containing descriptive information for an app. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.AboutData +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.AboutData + +## -description +This property returns an [AllJoynAboutData](alljoynaboutdata.md) object containing the descriptive data that the platform may advertise on behalf of the app. + +## -property-value +An object containing descriptive information for an app. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_1221375020.md b/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_1221375020.md index 1f8174d84d..5c33b13299 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_1221375020.md +++ b/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.#ctor --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.AllJoynBusAttachment ## -description Generates an [AllJoynBusAttachment](alljoynbusattachment.md) object using the default named pipe connection specification. ## -remarks ## -examples ## -see-also [AllJoynBusAttachment(String)](alljoynbusattachment_alljoynbusattachment_290278668.md) ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.AllJoynBusAttachment + +## -description +Generates an [AllJoynBusAttachment](alljoynbusattachment.md) object using the default named pipe connection specification. + +## -remarks + +## -examples + +## -see-also +[AllJoynBusAttachment(String)](alljoynbusattachment_alljoynbusattachment_290278668.md) + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_290278668.md b/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_290278668.md index ac354e964e..4a4817d2aa 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_290278668.md +++ b/windows.devices.alljoyn/alljoynbusattachment_alljoynbusattachment_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.AllJoynBusAttachment ## -description Generates an [AllJoynBusAttachment](alljoynbusattachment.md) object using the provided connection specification. ## -parameters ### -param connectionSpecification Specification used to initiate and maintain connections to a router node (bus). Windows 10 supports the 'npipe:' transport, formatted according to the . ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.AllJoynBusAttachment + +## -description +Generates an [AllJoynBusAttachment](alljoynbusattachment.md) object using the provided connection specification. + +## -parameters +### -param connectionSpecification +Specification used to initiate and maintain connections to a router node (bus). Windows 10 supports the 'npipe:' transport, formatted according to the . + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_authenticationcomplete.md b/windows.devices.alljoyn/alljoynbusattachment_authenticationcomplete.md index ff51badae6..a8ddab0703 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_authenticationcomplete.md +++ b/windows.devices.alljoyn/alljoynbusattachment_authenticationcomplete.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationComplete --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationComplete ## -description Occurs when verification of supplied credentials is complete. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationComplete +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationComplete + +## -description +Occurs when verification of supplied credentials is complete. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_authenticationmechanisms.md b/windows.devices.alljoyn/alljoynbusattachment_authenticationmechanisms.md index af5844376c..3c909962d6 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_authenticationmechanisms.md +++ b/windows.devices.alljoyn/alljoynbusattachment_authenticationmechanisms.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationMechanisms --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationMechanisms ## -description A list of [AllJoynAuthenticationMechanism](alljoynauthenticationmechanism.md) objects representing the acceptable authentication mechanisms. Default values include Rsa and None. ## -property-value The supported authentication mechanisms. ## -remarks These values are used to negotiate on a per API interface basis. Any API interface marked as secure will ignore the "None" value. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationMechanisms +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.AuthenticationMechanisms + +## -description +A list of [AllJoynAuthenticationMechanism](alljoynauthenticationmechanism.md) objects representing the acceptable authentication mechanisms. Default values include Rsa and None. + +## -property-value +The supported authentication mechanisms. + +## -remarks +These values are used to negotiate on a per API interface basis. Any API interface marked as secure will ignore the "None" value. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_connect_1614351178.md b/windows.devices.alljoyn/alljoynbusattachment_connect_1614351178.md index 1eacd9d244..21c367cbd7 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_connect_1614351178.md +++ b/windows.devices.alljoyn/alljoynbusattachment_connect_1614351178.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.Connect --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.Connect ## -description Initiates the connection. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.Connect +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.Connect + +## -description +Initiates the connection. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_connectionspecification.md b/windows.devices.alljoyn/alljoynbusattachment_connectionspecification.md index 004355c983..3f1b3ca6e5 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_connectionspecification.md +++ b/windows.devices.alljoyn/alljoynbusattachment_connectionspecification.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.ConnectionSpecification --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.ConnectionSpecification ## -description The connection specification used to establish and maintain the bus attachment. If a specification was not provided, this property will retrieve a default named pipe specification. ## -property-value The connection specification. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.ConnectionSpecification +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.ConnectionSpecification + +## -description +The connection specification used to establish and maintain the bus attachment. If a specification was not provided, this property will retrieve a default named pipe specification. + +## -property-value +The connection specification. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_credentialsrequested.md b/windows.devices.alljoyn/alljoynbusattachment_credentialsrequested.md index 9f3435edd1..f0ff79c992 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_credentialsrequested.md +++ b/windows.devices.alljoyn/alljoynbusattachment_credentialsrequested.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsRequested --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsRequested ## -description Occurs when credentials are requested for authentication. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsRequested +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsRequested + +## -description +Occurs when credentials are requested for authentication. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_credentialsverificationrequested.md b/windows.devices.alljoyn/alljoynbusattachment_credentialsverificationrequested.md index 14fde9fe00..b53f736888 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_credentialsverificationrequested.md +++ b/windows.devices.alljoyn/alljoynbusattachment_credentialsverificationrequested.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsVerificationRequested --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsVerificationRequested ## -description Occurs when credentials have been provided by a remote Consumer for verification. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsVerificationRequested +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.CredentialsVerificationRequested + +## -description +Occurs when credentials have been provided by a remote Consumer for verification. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_disconnect_1865647988.md b/windows.devices.alljoyn/alljoynbusattachment_disconnect_1865647988.md index 43d3a1077e..b1c048313d 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_disconnect_1865647988.md +++ b/windows.devices.alljoyn/alljoynbusattachment_disconnect_1865647988.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.Disconnect --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.Disconnect ## -description Initiates a disconnect operation from the router node (bus). ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.Disconnect +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.Disconnect + +## -description +Initiates a disconnect operation from the router node (bus). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_getdefault_846721868.md b/windows.devices.alljoyn/alljoynbusattachment_getdefault_846721868.md index 809a616d5b..339de426d8 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_getdefault_846721868.md +++ b/windows.devices.alljoyn/alljoynbusattachment_getdefault_846721868.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.GetDefault --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.GetDefault ## -description Gets the default [AllJoynBusAttachment](alljoynbusattachment.md) as defined by the app's manifest. ## -returns The default bus attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.GetDefault + +## -description +Gets the default [AllJoynBusAttachment](alljoynbusattachment.md) as defined by the app's manifest. + +## -returns +The default bus attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusattachment_getwatcher_662132931.md b/windows.devices.alljoyn/alljoynbusattachment_getwatcher_662132931.md index 9b4d857f6c..2dcc0e834a 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_getwatcher_662132931.md +++ b/windows.devices.alljoyn/alljoynbusattachment_getwatcher_662132931.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.GetWatcher(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.GetWatcher ## -description Creates a [DeviceWatcher](../windows.devices.enumeration/devicewatcher.md) that yields AllJoyn bus objects that implement the entire set of interfaces. ## -parameters ### -param requiredInterfaces The required interfaces that must be implemented by the bus objects. This can be a **List** of **String**. ## -returns The device watcher for the bus objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.GetWatcher(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.GetWatcher + +## -description +Creates a [DeviceWatcher](../windows.devices.enumeration/devicewatcher.md) that yields AllJoyn bus objects that implement the entire set of interfaces. + +## -parameters +### -param requiredInterfaces +The required interfaces that must be implemented by the bus objects. This can be a **List** of **String**. + +## -returns +The device watcher for the bus objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusattachment_pingasync_479185192.md b/windows.devices.alljoyn/alljoynbusattachment_pingasync_479185192.md index fb3d8f33ae..4b7b43db07 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_pingasync_479185192.md +++ b/windows.devices.alljoyn/alljoynbusattachment_pingasync_479185192.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.PingAsync(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.PingAsync ## -description Pings the specified connection asynchronously. ## -parameters ### -param uniqueName The unique name associated with the connection. ## -returns An AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.PingAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.PingAsync + +## -description +Pings the specified connection asynchronously. + +## -parameters +### -param uniqueName +The unique name associated with the connection. + +## -returns +An AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_state.md b/windows.devices.alljoyn/alljoynbusattachment_state.md index 5277da27c5..0f7ea12e06 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_state.md +++ b/windows.devices.alljoyn/alljoynbusattachment_state.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.State --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.State ## -description The current state of the bus attachment. State changes are surfaced via [StateChanged](alljoynbusattachment_statechanged.md) events. Possible values are defined by the [AllJoynBusAttachmentState](alljoynbusattachmentstate.md) enumeration. ## -property-value The state of the bus attachment. ## -remarks ## -examples ## -see-also [StateChanged](alljoynbusattachment_statechanged.md), [AllJoynBusAttachmentState](alljoynbusattachmentstate.md) ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.State +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.State + +## -description +The current state of the bus attachment. State changes are surfaced via [StateChanged](alljoynbusattachment_statechanged.md) events. Possible values are defined by the [AllJoynBusAttachmentState](alljoynbusattachmentstate.md) enumeration. + +## -property-value +The state of the bus attachment. + +## -remarks + +## -examples + +## -see-also +[StateChanged](alljoynbusattachment_statechanged.md), [AllJoynBusAttachmentState](alljoynbusattachmentstate.md) + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_statechanged.md b/windows.devices.alljoyn/alljoynbusattachment_statechanged.md index 5a575dbc2a..5ff4b07231 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_statechanged.md +++ b/windows.devices.alljoyn/alljoynbusattachment_statechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.StateChanged --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.StateChanged ## -description Occurs when the state of the bus attachment changes. The [AllJoynBusAttachmentState](alljoynbusattachmentstate.md) enumeration defines the possible state values. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.StateChanged +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.StateChanged + +## -description +Occurs when the state of the bus attachment changes. The [AllJoynBusAttachmentState](alljoynbusattachmentstate.md) enumeration defines the possible state values. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_uniquename.md b/windows.devices.alljoyn/alljoynbusattachment_uniquename.md index 5c1c1dde61..c797f31836 100644 --- a/windows.devices.alljoyn/alljoynbusattachment_uniquename.md +++ b/windows.devices.alljoyn/alljoynbusattachment_uniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.UniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachment.UniqueName ## -description The unique bus name associated with the remote app. This unique bus name is used to represent it on the bus via the bus attachment. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachment.UniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.UniqueName + +## -description +The unique bus name associated with the remote app. This unique bus name is used to represent it on the bus via the bus attachment. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs.md b/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs.md index 014e199936..13784aa14b 100644 --- a/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs.md +++ b/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs ## -description Contains information about state and status changes to an AllJoyn bus connection managed by an [AllJoynBusAttachment](alljoynbusattachment.md) object. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs + +## -description +Contains information about state and status changes to an AllJoyn bus connection managed by an [AllJoynBusAttachment](alljoynbusattachment.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_state.md b/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_state.md index e847e64a66..fda1d9bdcc 100644 --- a/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_state.md +++ b/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_state.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.State --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.State ## -description Indicates the current state of a connection to an AllJoyn bus. ## -property-value The current connection state. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.State + +## -description +Indicates the current state of a connection to an AllJoyn bus. + +## -property-value +The current connection state. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_status.md b/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_status.md index d845623154..1afc4e7405 100644 --- a/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_status.md +++ b/windows.devices.alljoyn/alljoynbusattachmentstatechangedeventargs_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.Status ## -description Contains a status code that provides status information for [AllJoynBusAttachment](alljoynbusattachment.md) change events. Properties used in the generation of possible values are defined by [AllJoynStatus](alljoynstatus.md). ## -property-value The AllJoyn status code associated with the event. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachmentStateChangedEventArgs.Status + +## -description +Contains a status code that provides status information for [AllJoynBusAttachment](alljoynbusattachment.md) change events. Properties used in the generation of possible values are defined by [AllJoynStatus](alljoynstatus.md). + +## -property-value +The AllJoyn status code associated with the event. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusobject.md b/windows.devices.alljoyn/alljoynbusobject.md index 03d61eb032..2d419d91ee 100644 --- a/windows.devices.alljoyn/alljoynbusobject.md +++ b/windows.devices.alljoyn/alljoynbusobject.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynBusObject --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynBusObject ## -description Represents a bus object available over the transport agnostic communication pipeline. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynBusObject +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject + +## -description +Represents a bus object available over the transport agnostic communication pipeline. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobject_addproducer_1528733518.md b/windows.devices.alljoyn/alljoynbusobject_addproducer_1528733518.md index 36615cfeec..f174cabaec 100644 --- a/windows.devices.alljoyn/alljoynbusobject_addproducer_1528733518.md +++ b/windows.devices.alljoyn/alljoynbusobject_addproducer_1528733518.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.AddProducer(Windows.Devices.AllJoyn.IAllJoynProducer) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObject.AddProducer ## -description Adds an additional interface to be produced to the service provider. ## -parameters ### -param producer The interface to be produced. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.AddProducer(Windows.Devices.AllJoyn.IAllJoynProducer) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.AddProducer + +## -description +Adds an additional interface to be produced to the service provider. + +## -parameters +### -param producer +The interface to be produced. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_1221375020.md b/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_1221375020.md index d8487f7220..c374791a52 100644 --- a/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_1221375020.md +++ b/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.#ctor --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObject.AllJoynBusObject ## -description Creates an [AllJoynBusObject](alljoynbusobject.md) with the object path as the root object path. i.e. "/". ## -remarks ## -examples ## -see-also [AllJoynBusObject(String)](alljoynbusobject_alljoynbusobject_290278668.md), [AllJoynBusObject(String, AllJoynBusAttachment)](alljoynbusobject_alljoynbusobject_172872340.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.AllJoynBusObject + +## -description +Creates an [AllJoynBusObject](alljoynbusobject.md) with the object path as the root object path. i.e. "/". + +## -remarks + +## -examples + +## -see-also +[AllJoynBusObject(String)](alljoynbusobject_alljoynbusobject_290278668.md), [AllJoynBusObject(String, AllJoynBusAttachment)](alljoynbusobject_alljoynbusobject_172872340.md) \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_172872340.md b/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_172872340.md index 539a62e127..c9177d2003 100644 --- a/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_172872340.md +++ b/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_172872340.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.#ctor(System.String,Windows.Devices.AllJoyn.AllJoynBusAttachment) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObject.AllJoynBusObject ## -description Create an [AllJoynBusObject](alljoynbusobject.md) that will implement one or more interfaces at the specified object path with the [AllJoynBusAttachment](alljoynbusattachment.md) specified. ## -parameters ### -param objectPath The object path. ### -param busAttachment The bus attachment instance. ## -remarks ## -examples ## -see-also [AllJoynBusObject(String)](alljoynbusobject_alljoynbusobject_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.#ctor(System.String,Windows.Devices.AllJoyn.AllJoynBusAttachment) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.AllJoynBusObject + +## -description +Create an [AllJoynBusObject](alljoynbusobject.md) that will implement one or more interfaces at the specified object path with the [AllJoynBusAttachment](alljoynbusattachment.md) specified. + +## -parameters +### -param objectPath +The object path. + +### -param busAttachment +The bus attachment instance. + +## -remarks + +## -examples + +## -see-also +[AllJoynBusObject(String)](alljoynbusobject_alljoynbusobject_290278668.md) \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_290278668.md b/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_290278668.md index 154d53655a..ac324b5ea9 100644 --- a/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_290278668.md +++ b/windows.devices.alljoyn/alljoynbusobject_alljoynbusobject_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObject.AllJoynBusObject ## -description Create an [AllJoynBusObject](alljoynbusobject.md) that will implement one or more interfaces at the specified object path. ## -parameters ### -param objectPath The object path. ## -remarks ## -examples ## -see-also [AllJoynBusObject(String, AllJoynBusAttachment)](alljoynbusobject_alljoynbusobject_172872340.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.AllJoynBusObject + +## -description +Create an [AllJoynBusObject](alljoynbusobject.md) that will implement one or more interfaces at the specified object path. + +## -parameters +### -param objectPath +The object path. + +## -remarks + +## -examples + +## -see-also +[AllJoynBusObject(String, AllJoynBusAttachment)](alljoynbusobject_alljoynbusobject_172872340.md) \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusobject_busattachment.md b/windows.devices.alljoyn/alljoynbusobject_busattachment.md index 5ae8913ae1..c1395a1a40 100644 --- a/windows.devices.alljoyn/alljoynbusobject_busattachment.md +++ b/windows.devices.alljoyn/alljoynbusobject_busattachment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusObject.BusAttachment --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusObject.BusAttachment ## -description Gets the bus attachment of this [AllJoynBusObject](alljoynbusobject.md). ## -property-value The bus attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusObject.BusAttachment +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.BusAttachment + +## -description +Gets the bus attachment of this [AllJoynBusObject](alljoynbusobject.md). + +## -property-value +The bus attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobject_session.md b/windows.devices.alljoyn/alljoynbusobject_session.md index a5af7d48fe..91c8177a9b 100644 --- a/windows.devices.alljoyn/alljoynbusobject_session.md +++ b/windows.devices.alljoyn/alljoynbusobject_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusObject.Session --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusObject.Session ## -description Gets the [AllJoynSession](alljoynsession.md) for this [AllJoynBusObject](alljoynbusobject.md). ## -property-value The AllJoyn session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusObject.Session +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.Session + +## -description +Gets the [AllJoynSession](alljoynsession.md) for this [AllJoynBusObject](alljoynbusobject.md). + +## -property-value +The AllJoyn session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobject_start_1587696324.md b/windows.devices.alljoyn/alljoynbusobject_start_1587696324.md index 8b01d67816..17e67736c7 100644 --- a/windows.devices.alljoyn/alljoynbusobject_start_1587696324.md +++ b/windows.devices.alljoyn/alljoynbusobject_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.Start --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObject.Start ## -description Starts the [AllJoynBusObject](alljoynbusobject.md). If the bus attachment is not already explicitly connected, starting the producer will automatically connect the bus attachment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.Start +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.Start + +## -description +Starts the [AllJoynBusObject](alljoynbusobject.md). If the bus attachment is not already explicitly connected, starting the producer will automatically connect the bus attachment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobject_stop_1201535524.md b/windows.devices.alljoyn/alljoynbusobject_stop_1201535524.md index b6abbe0e7e..9b3d33046a 100644 --- a/windows.devices.alljoyn/alljoynbusobject_stop_1201535524.md +++ b/windows.devices.alljoyn/alljoynbusobject_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.Stop --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObject.Stop ## -description Stops the [AllJoynBusObject](alljoynbusobject.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObject.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.Stop + +## -description +Stops the [AllJoynBusObject](alljoynbusobject.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobject_stopped.md b/windows.devices.alljoyn/alljoynbusobject_stopped.md index e7c4bd2f54..ccf628bdef 100644 --- a/windows.devices.alljoyn/alljoynbusobject_stopped.md +++ b/windows.devices.alljoyn/alljoynbusobject_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynBusObject.Stopped --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynBusObject.Stopped ## -description Event triggered when the [AllJoynBusObject](alljoynbusobject.md) is stopped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusObject.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObject.Stopped + +## -description +Event triggered when the [AllJoynBusObject](alljoynbusobject.md) is stopped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs.md b/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs.md index 113fc81609..d69778d915 100644 --- a/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs.md +++ b/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs ## -description Contains information about the stopped [AllJoynBusObject](alljoynbusobject.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs + +## -description +Contains information about the stopped [AllJoynBusObject](alljoynbusobject.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_alljoynbusobjectstoppedeventargs_745845612.md b/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_alljoynbusobjectstoppedeventargs_745845612.md index c374d58979..d78f8ec386 100644 --- a/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_alljoynbusobjectstoppedeventargs_745845612.md +++ b/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_alljoynbusobjectstoppedeventargs_745845612.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.AllJoynBusObjectStoppedEventArgs ## -description Creates an [AllJoynBusObjectStoppedEventArgs](alljoynbusobjectstoppedeventargs.md) class used for communicating status of the [AllJoynBusObject.Stopped](alljoynbusobject_stopped.md) event. ## -parameters ### -param status Value indicating the status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.AllJoynBusObjectStoppedEventArgs + +## -description +Creates an [AllJoynBusObjectStoppedEventArgs](alljoynbusobjectstoppedeventargs.md) class used for communicating status of the [AllJoynBusObject.Stopped](alljoynbusobject_stopped.md) event. + +## -parameters +### -param status +Value indicating the status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_status.md b/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_status.md index cbbdc8e16e..139c5f5cd3 100644 --- a/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_status.md +++ b/windows.devices.alljoyn/alljoynbusobjectstoppedeventargs_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.Status ## -description Gets the status of the [AllJoynBusObject](alljoynbusobject.md) that was stopped. ## -property-value The status of the bus object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusObjectStoppedEventArgs.Status + +## -description +Gets the status of the [AllJoynBusObject](alljoynbusobject.md) that was stopped. + +## -property-value +The status of the bus object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoyncredentials.md b/windows.devices.alljoyn/alljoyncredentials.md index c64f4b64eb..800b3a389f 100644 --- a/windows.devices.alljoyn/alljoyncredentials.md +++ b/windows.devices.alljoyn/alljoyncredentials.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynCredentials --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynCredentials ## -description Defines properties used when passing credentials during authentication. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynCredentials +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentials + +## -description +Defines properties used when passing credentials during authentication. + +## -remarks + + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentials_authenticationmechanism.md b/windows.devices.alljoyn/alljoyncredentials_authenticationmechanism.md index ad15daec64..8cf58895d5 100644 --- a/windows.devices.alljoyn/alljoyncredentials_authenticationmechanism.md +++ b/windows.devices.alljoyn/alljoyncredentials_authenticationmechanism.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.AuthenticationMechanism --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentials.AuthenticationMechanism ## -description The mechanism used for credential authentication. ## -property-value The authentication mechanism. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.AuthenticationMechanism +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentials.AuthenticationMechanism + +## -description +The mechanism used for credential authentication. + +## -property-value +The authentication mechanism. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentials_certificate.md b/windows.devices.alljoyn/alljoyncredentials_certificate.md index cf4695fd4d..4afd759fb2 100644 --- a/windows.devices.alljoyn/alljoyncredentials_certificate.md +++ b/windows.devices.alljoyn/alljoyncredentials_certificate.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.Certificate --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentials.Certificate ## -description The cryptography certificate used for the Rsa and EcdheEcdsa authentication mechanisms. ## -property-value The cryptography certificate. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.Certificate +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentials.Certificate + +## -description +The cryptography certificate used for the Rsa and EcdheEcdsa authentication mechanisms. + +## -property-value +The cryptography certificate. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentials_passwordcredential.md b/windows.devices.alljoyn/alljoyncredentials_passwordcredential.md index e76798d873..7e9d6b9732 100644 --- a/windows.devices.alljoyn/alljoyncredentials_passwordcredential.md +++ b/windows.devices.alljoyn/alljoyncredentials_passwordcredential.md @@ -1,3 +1,37 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.PasswordCredential --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentials.PasswordCredential ## -description The user name, if any, and password used for authentication. ## -property-value A user name/password combination. ## -remarks The password value contained in a [PasswordCredential](../windows.security.credentials/passwordcredential.md) object is used by the following authentication mechanisms: It’s also optionally used by Rsa if the private key associated with the certificate is encrypted with a password. The user name is used only by SrpLogon, and is ignored for the other ones. + SrpAnonymous + SrpLogon + Pin + EcdhePsk > [!NOTE] > Used for Rsa if the private key associated with the certificate is encrypted with a password. The username value contained in a [PasswordCredential](../windows.security.credentials/passwordcredential.md) object is used only by SrpLogon, and is ignored by other authentication mechanisms. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.PasswordCredential +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentials.PasswordCredential + +## -description +The user name, if any, and password used for authentication. + +## -property-value +A user name/password combination. + +## -remarks +The password value contained in a [PasswordCredential](../windows.security.credentials/passwordcredential.md) object is used by the following authentication mechanisms: It’s also optionally used by Rsa if the private key associated with the certificate is encrypted with a password. The user name is used only by SrpLogon, and is ignored for the other ones. + + ++ SrpAnonymous ++ SrpLogon ++ Pin ++ EcdhePsk +> [!NOTE] +> Used for Rsa if the private key associated with the certificate is encrypted with a password. + +The username value contained in a [PasswordCredential](../windows.security.credentials/passwordcredential.md) object is used only by SrpLogon, and is ignored by other authentication mechanisms. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentials_timeout.md b/windows.devices.alljoyn/alljoyncredentials_timeout.md index c2b70ac440..129016d9b0 100644 --- a/windows.devices.alljoyn/alljoyncredentials_timeout.md +++ b/windows.devices.alljoyn/alljoyncredentials_timeout.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.Timeout --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentials.Timeout ## -description The period of time before provided credentials expire. ## -property-value The expiration time. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentials.Timeout +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentials.Timeout + +## -description +The period of time before provided credentials expire. + +## -property-value +The expiration time. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs.md b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs.md index a175dbca0f..daaa33cc80 100644 --- a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs.md +++ b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs ## -description Contains information about a request for credentials in order to authenticate to a peer. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs + +## -description +Contains information about a request for credentials in order to authenticate to a peer. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_attemptcount.md b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_attemptcount.md index ebdf42c4a9..3ebf94e00c 100644 --- a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_attemptcount.md +++ b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_attemptcount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.AttemptCount --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.AttemptCount ## -description The number of times the credential request has been tried. ## -property-value The number of retries. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.AttemptCount +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.AttemptCount + +## -description +The number of times the credential request has been tried. + +## -property-value +The number of retries. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_credentials.md b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_credentials.md index d9093a8a62..3c96fb40e1 100644 --- a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_credentials.md +++ b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_credentials.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.Credentials --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.Credentials ## -description The authentication credentials to be filled in by the app. ## -property-value Object containing certificate and logon credentials. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.Credentials +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.Credentials + +## -description +The authentication credentials to be filled in by the app. + +## -property-value +Object containing certificate and logon credentials. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_getdeferral_254836512.md b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_getdeferral_254836512.md index 33d0bbc5ca..255907ac63 100644 --- a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_getdeferral_254836512.md +++ b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_getdeferral_254836512.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.GetDeferral ## -description Allows JavaScript Windows Store app to handle the verification of provided of credentials asynchronously. ## -returns The credential request deferral. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.GetDeferral + +## -description +Allows JavaScript Windows Store app to handle the verification of provided of credentials asynchronously. + +## -returns +The credential request deferral. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_peeruniquename.md b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_peeruniquename.md index 3fe1024a45..217a326662 100644 --- a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_peeruniquename.md +++ b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_peeruniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.PeerUniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.PeerUniqueName ## -description The unique bus name of the remote app that provided the requested credentials. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.PeerUniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.PeerUniqueName + +## -description +The unique bus name of the remote app that provided the requested credentials. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_requestedusername.md b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_requestedusername.md index 42e6bd9c11..f7038387ad 100644 --- a/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_requestedusername.md +++ b/windows.devices.alljoyn/alljoyncredentialsrequestedeventargs_requestedusername.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.RequestedUserName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.RequestedUserName ## -description A user name value used by mechanisms that accept a user name/password pair. ## -property-value The user name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.RequestedUserName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsRequestedEventArgs.RequestedUserName + +## -description +A user name value used by mechanisms that accept a user name/password pair. + +## -property-value +The user name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs.md index fadeb93ce4..4bb67f0495 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs ## -description Used to allow the application to indicate whether the credentials provided by a peer are valid. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs + +## -description +Used to allow the application to indicate whether the credentials provided by a peer are valid. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_accept_1944939200.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_accept_1944939200.md index c9ea2ea823..dbc7311b39 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_accept_1944939200.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_accept_1944939200.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.Accept --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.Accept ## -description Calling this method indicates that the credentials provided for authentication are valid. ## -remarks On failure, the [AuthenticationComplete](alljoynbusattachment_authenticationcomplete.md) event will be signaled with a failure status. ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.Accept +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.Accept + +## -description +Calling this method indicates that the credentials provided for authentication are valid. + +## -remarks +On failure, the [AuthenticationComplete](alljoynbusattachment_authenticationcomplete.md) event will be signaled with a failure status. + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_authenticationmechanism.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_authenticationmechanism.md index c1c131ebf2..fa7fbfed8f 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_authenticationmechanism.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_authenticationmechanism.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.AuthenticationMechanism --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.AuthenticationMechanism ## -description The mechanism used to authenticate credentials. ## -property-value The authentication mechanism. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.AuthenticationMechanism +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.AuthenticationMechanism + +## -description +The mechanism used to authenticate credentials. + +## -property-value +The authentication mechanism. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_getdeferral_254836512.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_getdeferral_254836512.md index 390353c5b2..101bef001c 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_getdeferral_254836512.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_getdeferral_254836512.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.GetDeferral ## -description Conducts verification of provided of credentials asynchronously. ## -returns The verification deferral. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.GetDeferral + +## -description +Conducts verification of provided of credentials asynchronously. + +## -returns +The verification deferral. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificate.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificate.md index 0b5ba395dd..a088727955 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificate.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificate.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificate --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificate ## -description The cryptography certificate provided for authentication. ## -property-value The cryptography certificate. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificate +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificate + +## -description +The cryptography certificate provided for authentication. + +## -property-value +The cryptography certificate. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrors.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrors.md index b6dd115ccc..3d84de6e5d 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrors.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrors.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrors --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrors ## -description A list of errors that occurred during authentication of the provided cryptography certificate. ## -property-value A list of credential errors. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrors +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrors + +## -description +A list of errors that occurred during authentication of the provided cryptography certificate. + +## -property-value +A list of credential errors. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrorseverity.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrorseverity.md index 26b0dfa1fa..f20aa123dd 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrorseverity.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peercertificateerrorseverity.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrorSeverity --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrorSeverity ## -description The category of an errors encountered authenticating the cryptography certificate. ## -property-value The severity of the error. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrorSeverity +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerCertificateErrorSeverity + +## -description +The category of an errors encountered authenticating the cryptography certificate. + +## -property-value +The severity of the error. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peerintermediatecertificates.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peerintermediatecertificates.md index b598657d89..4801252b0b 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peerintermediatecertificates.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peerintermediatecertificates.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerIntermediateCertificates --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerIntermediateCertificates ## -description Retrieves the intermediate certificates sent during authentication. ## -property-value A list of the intermediate certificates. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerIntermediateCertificates +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerIntermediateCertificates + +## -description +Retrieves the intermediate certificates sent during authentication. + +## -property-value +A list of the intermediate certificates. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peeruniquename.md b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peeruniquename.md index ce558f6349..a7c860f22a 100644 --- a/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peeruniquename.md +++ b/windows.devices.alljoyn/alljoyncredentialsverificationrequestedeventargs_peeruniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerUniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerUniqueName ## -description The unique bus name of the remote app being authenticated. ## -property-value A unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerUniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynCredentialsVerificationRequestedEventArgs.PeerUniqueName + +## -description +The unique bus name of the remote app being authenticated. + +## -property-value +A unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynmessageinfo.md b/windows.devices.alljoyn/alljoynmessageinfo.md index be8b1a8c2a..d515c43635 100644 --- a/windows.devices.alljoyn/alljoynmessageinfo.md +++ b/windows.devices.alljoyn/alljoynmessageinfo.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynMessageInfo --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynMessageInfo ## -description Exposes information about the sender of a message being processed. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynMessageInfo +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynMessageInfo + +## -description +Exposes information about the sender of a message being processed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynmessageinfo_alljoynmessageinfo_290278668.md b/windows.devices.alljoyn/alljoynmessageinfo_alljoynmessageinfo_290278668.md index 9829bfb670..c9bc77c92e 100644 --- a/windows.devices.alljoyn/alljoynmessageinfo_alljoynmessageinfo_290278668.md +++ b/windows.devices.alljoyn/alljoynmessageinfo_alljoynmessageinfo_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynMessageInfo.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynMessageInfo.AllJoynMessageInfo ## -description Generates an [AllJoynMessageInfo](alljoynmessageinfo.md) object that contains the unique name of the sender that sent the message being processed. ## -parameters ### -param senderUniqueName The unique name of the sender. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynMessageInfo.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynMessageInfo.AllJoynMessageInfo + +## -description +Generates an [AllJoynMessageInfo](alljoynmessageinfo.md) object that contains the unique name of the sender that sent the message being processed. + +## -parameters +### -param senderUniqueName +The unique name of the sender. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynmessageinfo_senderuniquename.md b/windows.devices.alljoyn/alljoynmessageinfo_senderuniquename.md index 981cde6d1e..955d2a9740 100644 --- a/windows.devices.alljoyn/alljoynmessageinfo_senderuniquename.md +++ b/windows.devices.alljoyn/alljoynmessageinfo_senderuniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynMessageInfo.SenderUniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynMessageInfo.SenderUniqueName ## -description The unique bus name of the message sender. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynMessageInfo.SenderUniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynMessageInfo.SenderUniqueName + +## -description +The unique bus name of the message sender. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynproducerstoppedeventargs.md b/windows.devices.alljoyn/alljoynproducerstoppedeventargs.md index d5af148a1c..469b0631b6 100644 --- a/windows.devices.alljoyn/alljoynproducerstoppedeventargs.md +++ b/windows.devices.alljoyn/alljoynproducerstoppedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs ## -description Contains status information that indicates why a Producer app was stopped. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs + +## -description +Contains status information that indicates why a Producer app was stopped. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynproducerstoppedeventargs_alljoynproducerstoppedeventargs_745845612.md b/windows.devices.alljoyn/alljoynproducerstoppedeventargs_alljoynproducerstoppedeventargs_745845612.md index 2ea03b5fe0..03fd8b8b9b 100644 --- a/windows.devices.alljoyn/alljoynproducerstoppedeventargs_alljoynproducerstoppedeventargs_745845612.md +++ b/windows.devices.alljoyn/alljoynproducerstoppedeventargs_alljoynproducerstoppedeventargs_745845612.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.AllJoynProducerStoppedEventArgs ## -description Generates an object containing status information for the stopped Producer app. ## -parameters ### -param status An AllJoyn status code that indicates why the Producer was stopped. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.AllJoynProducerStoppedEventArgs + +## -description +Generates an object containing status information for the stopped Producer app. + +## -parameters +### -param status +An AllJoyn status code that indicates why the Producer was stopped. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynproducerstoppedeventargs_status.md b/windows.devices.alljoyn/alljoynproducerstoppedeventargs_status.md index ae06a97bfe..a26c418164 100644 --- a/windows.devices.alljoyn/alljoynproducerstoppedeventargs_status.md +++ b/windows.devices.alljoyn/alljoynproducerstoppedeventargs_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.Status ## -description Returns an AllJoyn status code that indicates why the Producer was stopped. Common values are defined by [AllJoynStatus](alljoynstatus.md). ## -property-value The AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynProducerStoppedEventArgs.Status + +## -description +Returns an AllJoyn status code that indicates why the Producer was stopped. Common values are defined by [AllJoynStatus](alljoynstatus.md). + +## -property-value +The AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinfo.md b/windows.devices.alljoyn/alljoynserviceinfo.md index 955831bd24..7c183ce2f1 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo.md +++ b/windows.devices.alljoyn/alljoynserviceinfo.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynServiceInfo --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynServiceInfo ## -description Exposes unique name and transport information for an advertising app. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynServiceInfo +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfo + +## -description +Exposes unique name and transport information for an advertising app. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinfo_alljoynserviceinfo_378045624.md b/windows.devices.alljoyn/alljoynserviceinfo_alljoynserviceinfo_378045624.md index 62bf29a259..c40ad978b0 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo_alljoynserviceinfo_378045624.md +++ b/windows.devices.alljoyn/alljoynserviceinfo_alljoynserviceinfo_378045624.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynServiceInfo.#ctor(System.String,System.String,System.UInt16) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynServiceInfo.AllJoynServiceInfo ## -description Generates an [AllJoynServiceInfo](alljoynserviceinfo.md) object that represents an advertising app. This object provides the unique bus name, object path and transport information. ## -parameters ### -param uniqueName The unique bus name. ### -param objectPath The object path. ### -param sessionPort The port for this session. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynServiceInfo.#ctor(System.String,System.String,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfo.AllJoynServiceInfo + +## -description +Generates an [AllJoynServiceInfo](alljoynserviceinfo.md) object that represents an advertising app. This object provides the unique bus name, object path and transport information. + +## -parameters +### -param uniqueName +The unique bus name. + +### -param objectPath +The object path. + +### -param sessionPort +The port for this session. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md b/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md index e528913464..4fc5cec89b 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md +++ b/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynServiceInfo.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynServiceInfo.FromIdAsync ## -description TBD ## -parameters ### -param deviceId ## -returns ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynServiceInfo.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfo.FromIdAsync + +## -description +TBD + +## -parameters +### -param deviceId + + +## -returns + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynserviceinfo_objectpath.md b/windows.devices.alljoyn/alljoynserviceinfo_objectpath.md index f9bb33b1d2..18f12d2858 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo_objectpath.md +++ b/windows.devices.alljoyn/alljoynserviceinfo_objectpath.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfo.ObjectPath --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynServiceInfo.ObjectPath ## -description The path to the service object. This path is used to match communications with service objects connected to the session. ## -property-value The service object path. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfo.ObjectPath +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfo.ObjectPath + +## -description +The path to the service object. This path is used to match communications with service objects connected to the session. + +## -property-value +The service object path. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinfo_sessionport.md b/windows.devices.alljoyn/alljoynserviceinfo_sessionport.md index 506006c286..7549df7fa4 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo_sessionport.md +++ b/windows.devices.alljoyn/alljoynserviceinfo_sessionport.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfo.SessionPort --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynServiceInfo.SessionPort ## -description The port used to connect to the session. ## -property-value The connection port number. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfo.SessionPort +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfo.SessionPort + +## -description +The port used to connect to the session. + +## -property-value +The connection port number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinfo_uniquename.md b/windows.devices.alljoyn/alljoynserviceinfo_uniquename.md index a065645093..6356bfcd07 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo_uniquename.md +++ b/windows.devices.alljoyn/alljoynserviceinfo_uniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfo.UniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynServiceInfo.UniqueName ## -description The unique bus name associated with the advertising app. ## -property-value The unique name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfo.UniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfo.UniqueName + +## -description +The unique bus name associated with the advertising app. + +## -property-value +The unique name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinforemovedeventargs.md b/windows.devices.alljoyn/alljoynserviceinforemovedeventargs.md index ec5203b7bf..8fa9f496bb 100644 --- a/windows.devices.alljoyn/alljoynserviceinforemovedeventargs.md +++ b/windows.devices.alljoyn/alljoynserviceinforemovedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs ## -description Contains information that identifies an advertising app that is no longer available. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs + +## -description +Contains information that identifies an advertising app that is no longer available. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_alljoynserviceinforemovedeventargs_290278668.md b/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_alljoynserviceinforemovedeventargs_290278668.md index 433942fb0a..637233ff8e 100644 --- a/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_alljoynserviceinforemovedeventargs_290278668.md +++ b/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_alljoynserviceinforemovedeventargs_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.AllJoynServiceInfoRemovedEventArgs ## -description Generates an object containing information about an advertising app that is no longer available. ## -parameters ### -param uniqueName The unique app name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.AllJoynServiceInfoRemovedEventArgs + +## -description +Generates an object containing information about an advertising app that is no longer available. + +## -parameters +### -param uniqueName +The unique app name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_uniquename.md b/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_uniquename.md index 1894b3c6b1..e285559054 100644 --- a/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_uniquename.md +++ b/windows.devices.alljoyn/alljoynserviceinforemovedeventargs_uniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.UniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.UniqueName ## -description The unique bus name of the advertising app that is no longer available. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.UniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynServiceInfoRemovedEventArgs.UniqueName + +## -description +The unique bus name of the advertising app that is no longer available. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsession.md b/windows.devices.alljoyn/alljoynsession.md index cd222f70d4..7735a97623 100644 --- a/windows.devices.alljoyn/alljoynsession.md +++ b/windows.devices.alljoyn/alljoynsession.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynSession --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynSession ## -description Represents an AllJoyn session created with a provider to consume the services available from that provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynSession +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession + +## -description +Represents an AllJoyn session created with a provider to consume the services available from that provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1177093202.md b/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1177093202.md index 8148150ff4..ecb1fe4263 100644 --- a/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1177093202.md +++ b/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1177093202.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync(Windows.Devices.AllJoyn.AllJoynServiceInfo,Windows.Devices.AllJoyn.AllJoynBusAttachment) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync ## -description Gets a session with the producer based on the specified service info and bus attachment. ## -parameters ### -param serviceInfo The service info to acquire the correct session. ### -param busAttachment The bus attachment to identify the AllJoyn session. If not specified, it is set to the result of [AllJoynBusAttachment.GetDefault](alljoynbusattachment_getdefault.md). ## -returns An AllJoyn object for the AllJoyn session based off the service info. ## -remarks ## -examples ## -see-also [GetFromServiceInfoAsync(AllJoynServiceInfo)](alljoynsession_getfromserviceinfoasync_1563007946.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync(Windows.Devices.AllJoyn.AllJoynServiceInfo,Windows.Devices.AllJoyn.AllJoynBusAttachment) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync + +## -description +Gets a session with the producer based on the specified service info and bus attachment. + +## -parameters +### -param serviceInfo +The service info to acquire the correct session. + +### -param busAttachment +The bus attachment to identify the AllJoyn session. If not specified, it is set to the result of [AllJoynBusAttachment.GetDefault](alljoynbusattachment_getdefault.md). + +## -returns +An AllJoyn object for the AllJoyn session based off the service info. + +## -remarks + +## -examples + +## -see-also +[GetFromServiceInfoAsync(AllJoynServiceInfo)](alljoynsession_getfromserviceinfoasync_1563007946.md) \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1563007946.md b/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1563007946.md index 69c5557d5c..b0601e4246 100644 --- a/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1563007946.md +++ b/windows.devices.alljoyn/alljoynsession_getfromserviceinfoasync_1563007946.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync(Windows.Devices.AllJoyn.AllJoynServiceInfo) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync ## -description Gets a session with the producer based on the specified service info. ## -parameters ### -param serviceInfo The service info to acquire the correct session. ## -returns An AllJoyn object for the AllJoyn session based off the service info. ## -remarks ## -examples ## -see-also [GetFromServiceInfoAsync(AllJoynServiceInfo, AllJoynBusAttachment)](alljoynsession_getfromserviceinfoasync_1177093202.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync(Windows.Devices.AllJoyn.AllJoynServiceInfo) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.GetFromServiceInfoAsync + +## -description +Gets a session with the producer based on the specified service info. + +## -parameters +### -param serviceInfo +The service info to acquire the correct session. + +## -returns +An AllJoyn object for the AllJoyn session based off the service info. + +## -remarks + +## -examples + +## -see-also +[GetFromServiceInfoAsync(AllJoynServiceInfo, AllJoynBusAttachment)](alljoynsession_getfromserviceinfoasync_1177093202.md) \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsession_id.md b/windows.devices.alljoyn/alljoynsession_id.md index 616608a456..a66f10aa0c 100644 --- a/windows.devices.alljoyn/alljoynsession_id.md +++ b/windows.devices.alljoyn/alljoynsession_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynSession.Id --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynSession.Id ## -description Gets the unique ID of the session. ## -property-value The ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynSession.Id +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.Id + +## -description +Gets the unique ID of the session. + +## -property-value +The ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsession_lost.md b/windows.devices.alljoyn/alljoynsession_lost.md index a5cfebcaaf..b1102be7e6 100644 --- a/windows.devices.alljoyn/alljoynsession_lost.md +++ b/windows.devices.alljoyn/alljoynsession_lost.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynSession.Lost --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynSession.Lost ## -description Event triggered when an [AllJoynSession](alljoynsession.md) has been lost. More information about the event can be found in the associated [AllJoynSessionLostEventArgs](alljoynsessionlosteventargs.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynSession.Lost +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.Lost + +## -description +Event triggered when an [AllJoynSession](alljoynsession.md) has been lost. More information about the event can be found in the associated [AllJoynSessionLostEventArgs](alljoynsessionlosteventargs.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsession_memberadded.md b/windows.devices.alljoyn/alljoynsession_memberadded.md index e31cc9c9e2..52c33ac192 100644 --- a/windows.devices.alljoyn/alljoynsession_memberadded.md +++ b/windows.devices.alljoyn/alljoynsession_memberadded.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynSession.MemberAdded --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynSession.MemberAdded ## -description Event triggered when a member has been added to an [AllJoynSession](alljoynsession.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynSession.MemberAdded +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.MemberAdded + +## -description +Event triggered when a member has been added to an [AllJoynSession](alljoynsession.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsession_memberremoved.md b/windows.devices.alljoyn/alljoynsession_memberremoved.md index d49e40890e..dd31862874 100644 --- a/windows.devices.alljoyn/alljoynsession_memberremoved.md +++ b/windows.devices.alljoyn/alljoynsession_memberremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.AllJoyn.AllJoynSession.MemberRemoved --api-type: winrt event ---- # Windows.Devices.AllJoyn.AllJoynSession.MemberRemoved ## -description Event triggered when a member has been removed from an [AllJoynSession](alljoynsession.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynSession.MemberRemoved +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.MemberRemoved + +## -description +Event triggered when a member has been removed from an [AllJoynSession](alljoynsession.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsession_removememberasync_1330664247.md b/windows.devices.alljoyn/alljoynsession_removememberasync_1330664247.md index 618244224a..34af6e1ac3 100644 --- a/windows.devices.alljoyn/alljoynsession_removememberasync_1330664247.md +++ b/windows.devices.alljoyn/alljoynsession_removememberasync_1330664247.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSession.RemoveMemberAsync(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSession.RemoveMemberAsync ## -description Removes the member specified by the input [String](https://msdn.microsoft.com/library/system.string.aspx) from the session. ## -parameters ### -param uniqueName Name of member to be removed from the session. ## -returns An AllJoyn status code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSession.RemoveMemberAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.RemoveMemberAsync + +## -description +Removes the member specified by the input [String](https://msdn.microsoft.com/library/system.string.aspx) from the session. + +## -parameters +### -param uniqueName +Name of member to be removed from the session. + +## -returns +An AllJoyn status code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsession_status.md b/windows.devices.alljoyn/alljoynsession_status.md index d5af0e27a5..acc4e75e45 100644 --- a/windows.devices.alljoyn/alljoynsession_status.md +++ b/windows.devices.alljoyn/alljoynsession_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynSession.Status --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynSession.Status ## -description Gets the current status of the session. ## -property-value Value representing the status of the session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynSession.Status +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynSession.Status + +## -description +Gets the current status of the session. + +## -property-value +Value representing the status of the session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsessionjoinedeventargs.md b/windows.devices.alljoyn/alljoynsessionjoinedeventargs.md index 9f6719b7ef..8ab72c6f02 100644 --- a/windows.devices.alljoyn/alljoynsessionjoinedeventargs.md +++ b/windows.devices.alljoyn/alljoynsessionjoinedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs ## -description Contains information that identifies a session that has been joined. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs + +## -description +Contains information that identifies a session that has been joined. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsessionjoinedeventargs_alljoynsessionjoinedeventargs_1343316673.md b/windows.devices.alljoyn/alljoynsessionjoinedeventargs_alljoynsessionjoinedeventargs_1343316673.md index 7b3cecfcbc..37586dd0f0 100644 --- a/windows.devices.alljoyn/alljoynsessionjoinedeventargs_alljoynsessionjoinedeventargs_1343316673.md +++ b/windows.devices.alljoyn/alljoynsessionjoinedeventargs_alljoynsessionjoinedeventargs_1343316673.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.#ctor(Windows.Devices.AllJoyn.AllJoynSession) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.AllJoynSessionJoinedEventArgs ## -description Creates an [AllJoynSessionJoinedEventArgs](alljoynsessionjoinedeventargs.md) object with the specified session information. ## -parameters ### -param session The session that has been joined. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.#ctor(Windows.Devices.AllJoyn.AllJoynSession) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.AllJoynSessionJoinedEventArgs + +## -description +Creates an [AllJoynSessionJoinedEventArgs](alljoynsessionjoinedeventargs.md) object with the specified session information. + +## -parameters +### -param session +The session that has been joined. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsessionjoinedeventargs_session.md b/windows.devices.alljoyn/alljoynsessionjoinedeventargs_session.md index 6bce1c10f2..7d66c6fcdf 100644 --- a/windows.devices.alljoyn/alljoynsessionjoinedeventargs_session.md +++ b/windows.devices.alljoyn/alljoynsessionjoinedeventargs_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.Session --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.Session ## -description Gets the session that has been joined. ## -property-value The joined session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.Session +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionJoinedEventArgs.Session + +## -description +Gets the session that has been joined. + +## -property-value +The joined session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.alljoyn/alljoynsessionlosteventargs.md b/windows.devices.alljoyn/alljoynsessionlosteventargs.md index b114cd4d11..ecb0f518f7 100644 --- a/windows.devices.alljoyn/alljoynsessionlosteventargs.md +++ b/windows.devices.alljoyn/alljoynsessionlosteventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs ## -description Contains information that identifies the reason for a lost session. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs + +## -description +Contains information that identifies the reason for a lost session. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionlosteventargs_alljoynsessionlosteventargs_1359425283.md b/windows.devices.alljoyn/alljoynsessionlosteventargs_alljoynsessionlosteventargs_1359425283.md index 84c85177c9..f47039d2a0 100644 --- a/windows.devices.alljoyn/alljoynsessionlosteventargs_alljoynsessionlosteventargs_1359425283.md +++ b/windows.devices.alljoyn/alljoynsessionlosteventargs_alljoynsessionlosteventargs_1359425283.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.#ctor(Windows.Devices.AllJoyn.AllJoynSessionLostReason) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.AllJoynSessionLostEventArgs ## -description Generates an [AllJoynSessionLostEventArgs](alljoynsessionlosteventargs.md) object containing information that identifies the reason for the lost session. ## -parameters ### -param reason The reason the session was lost. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.#ctor(Windows.Devices.AllJoyn.AllJoynSessionLostReason) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.AllJoynSessionLostEventArgs + +## -description +Generates an [AllJoynSessionLostEventArgs](alljoynsessionlosteventargs.md) object containing information that identifies the reason for the lost session. + +## -parameters +### -param reason +The reason the session was lost. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionlosteventargs_reason.md b/windows.devices.alljoyn/alljoynsessionlosteventargs_reason.md index 877dd198a3..2c9d53a92b 100644 --- a/windows.devices.alljoyn/alljoynsessionlosteventargs_reason.md +++ b/windows.devices.alljoyn/alljoynsessionlosteventargs_reason.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.Reason --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.Reason ## -description Retrieves a value that indicates the reason for a lost session. ## -property-value The reason the session was lost. Possible values are defined by [AllJoynSessionLostReason](alljoynsessionlostreason.md). ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionLostEventArgs.Reason + +## -description +Retrieves a value that indicates the reason for a lost session. + +## -property-value +The reason the session was lost. Possible values are defined by [AllJoynSessionLostReason](alljoynsessionlostreason.md). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs.md b/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs.md index 8018f74d90..87e7dcb510 100644 --- a/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs.md +++ b/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs ## -description Contains information about a peer that was added to a session. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs + +## -description +Contains information about a peer that was added to a session. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_alljoynsessionmemberaddedeventargs_290278668.md b/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_alljoynsessionmemberaddedeventargs_290278668.md index 75966e7ef9..6afc40f5b0 100644 --- a/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_alljoynsessionmemberaddedeventargs_290278668.md +++ b/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_alljoynsessionmemberaddedeventargs_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.AllJoynSessionMemberAddedEventArgs ## -description Generates an object that contains information about the remote app added to the session. ## -parameters ### -param uniqueName The unique Consumer name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.AllJoynSessionMemberAddedEventArgs + +## -description +Generates an object that contains information about the remote app added to the session. + +## -parameters +### -param uniqueName +The unique Consumer name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_uniquename.md b/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_uniquename.md index c3f1697cf4..5186101f26 100644 --- a/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_uniquename.md +++ b/windows.devices.alljoyn/alljoynsessionmemberaddedeventargs_uniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.UniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.UniqueName ## -description The unique bus name of the remote app new to the session. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.UniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionMemberAddedEventArgs.UniqueName + +## -description +The unique bus name of the remote app new to the session. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs.md b/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs.md index 9276ceb128..1b8058952a 100644 --- a/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs.md +++ b/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs ## -description Contains information about a remote app removed from a session. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs + +## -description +Contains information about a remote app removed from a session. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_alljoynsessionmemberremovedeventargs_290278668.md b/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_alljoynsessionmemberremovedeventargs_290278668.md index eda41527b2..ea438391f4 100644 --- a/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_alljoynsessionmemberremovedeventargs_290278668.md +++ b/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_alljoynsessionmemberremovedeventargs_290278668.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.AllJoynSessionMemberRemovedEventArgs ## -description Generates an object containing information about a remote app removed from a session. ## -parameters ### -param uniqueName The unique bus name of the remote app removed from the session. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.AllJoynSessionMemberRemovedEventArgs + +## -description +Generates an object containing information about a remote app removed from a session. + +## -parameters +### -param uniqueName +The unique bus name of the remote app removed from the session. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_uniquename.md b/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_uniquename.md index c7faadc6e0..b1d321eeb8 100644 --- a/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_uniquename.md +++ b/windows.devices.alljoyn/alljoynsessionmemberremovedeventargs_uniquename.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.UniqueName --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.UniqueName ## -description The unique bus name of the remote app removed from the session. ## -property-value The unique bus name. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.UniqueName +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynSessionMemberRemovedEventArgs.UniqueName + +## -description +The unique bus name of the remote app removed from the session. + +## -property-value +The unique bus name. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus.md b/windows.devices.alljoyn/alljoynstatus.md index b75d20629e..ec2ba5347c 100644 --- a/windows.devices.alljoyn/alljoynstatus.md +++ b/windows.devices.alljoyn/alljoynstatus.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynStatus --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynStatus ## -description Defines a collection of properties used to convey meaning for AllJoyn status codes. For possible status values, refer to the [AllJoyn standard documentation](https://allseenalliance.org/docs/api/cpp/_status_8h.html ). ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynStatus +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus + +## -description +Defines a collection of properties used to convey meaning for AllJoyn status codes. For possible status values, refer to the [AllJoyn standard documentation](https://allseenalliance.org/docs/api/cpp/_status_8h.html ). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_authenticationfailed.md b/windows.devices.alljoyn/alljoynstatus_authenticationfailed.md index 78be39574b..023ec77c62 100644 --- a/windows.devices.alljoyn/alljoynstatus_authenticationfailed.md +++ b/windows.devices.alljoyn/alljoynstatus_authenticationfailed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationFailed --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationFailed ## -description Indicates that authentication could not be completed. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationFailed +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationFailed + +## -description +Indicates that authentication could not be completed. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_authenticationrejectedbyuser.md b/windows.devices.alljoyn/alljoynstatus_authenticationrejectedbyuser.md index 54bad548bf..b559174543 100644 --- a/windows.devices.alljoyn/alljoynstatus_authenticationrejectedbyuser.md +++ b/windows.devices.alljoyn/alljoynstatus_authenticationrejectedbyuser.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationRejectedByUser --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationRejectedByUser ## -description Authentication was rejected by the advertising app. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationRejectedByUser +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.AuthenticationRejectedByUser + +## -description +Authentication was rejected by the advertising app. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_connectionrefused.md b/windows.devices.alljoyn/alljoynstatus_connectionrefused.md index 3210ed64bd..1537cb33ca 100644 --- a/windows.devices.alljoyn/alljoynstatus_connectionrefused.md +++ b/windows.devices.alljoyn/alljoynstatus_connectionrefused.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.ConnectionRefused --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.ConnectionRefused ## -description The connection to the session was refused. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.ConnectionRefused +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.ConnectionRefused + +## -description +The connection to the session was refused. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_fail.md b/windows.devices.alljoyn/alljoynstatus_fail.md index e948e35bde..2b8b7723d6 100644 --- a/windows.devices.alljoyn/alljoynstatus_fail.md +++ b/windows.devices.alljoyn/alljoynstatus_fail.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.Fail --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.Fail ## -description The operation has failed. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.Fail +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.Fail + +## -description +The operation has failed. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_insufficientsecurity.md b/windows.devices.alljoyn/alljoynstatus_insufficientsecurity.md index 244b9652c1..d7079f95c5 100644 --- a/windows.devices.alljoyn/alljoynstatus_insufficientsecurity.md +++ b/windows.devices.alljoyn/alljoynstatus_insufficientsecurity.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InsufficientSecurity --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InsufficientSecurity ## -description Insufficient security provided for session connections. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InsufficientSecurity +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InsufficientSecurity + +## -description +Insufficient security provided for session connections. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument1.md b/windows.devices.alljoyn/alljoynstatus_invalidargument1.md index afd78872ff..f0ee6516f3 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument1.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument1.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument1 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument1 ## -description Function call argument 1 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument1 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument1 + +## -description +Function call argument 1 is invalid. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument2.md b/windows.devices.alljoyn/alljoynstatus_invalidargument2.md index 678f6004eb..46da042f7b 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument2.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument2.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument2 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument2 ## -description Function call argument 2 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument2 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument2 + +## -description +Function call argument 2 is invalid. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument3.md b/windows.devices.alljoyn/alljoynstatus_invalidargument3.md index ae85eab2d0..753d27be38 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument3.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument3.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument3 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument3 ## -description Function call argument 3 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument3 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument3 + +## -description +Function call argument 3 is invalid. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument4.md b/windows.devices.alljoyn/alljoynstatus_invalidargument4.md index 96f04630fc..ccdf23202a 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument4.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument4.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument4 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument4 ## -description Function call argument 4 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument4 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument4 + +## -description +Function call argument 4 is invalid. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument5.md b/windows.devices.alljoyn/alljoynstatus_invalidargument5.md index 9e1ae17ddb..25c710ba8c 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument5.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument5.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument5 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument5 ## -description Function call argument 5 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument5 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument5 + +## -description +Function call argument 5 is invalid. + + + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument6.md b/windows.devices.alljoyn/alljoynstatus_invalidargument6.md index f1e61e60b5..cd02d1df71 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument6.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument6.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument6 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument6 ## -description Function call argument 6 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument6 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument6 + +## -description +Function call argument 6 is invalid. + + + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument7.md b/windows.devices.alljoyn/alljoynstatus_invalidargument7.md index 717561a1aa..6425dcb9b7 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument7.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument7.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument7 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument7 ## -description Function call argument 7 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument7 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument7 + +## -description +Function call argument 7 is invalid. + + + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_invalidargument8.md b/windows.devices.alljoyn/alljoynstatus_invalidargument8.md index da63e692e9..f60c5c47f5 100644 --- a/windows.devices.alljoyn/alljoynstatus_invalidargument8.md +++ b/windows.devices.alljoyn/alljoynstatus_invalidargument8.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument8 --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument8 ## -description Function call argument 8 is invalid. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument8 +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.InvalidArgument8 + +## -description +Function call argument 8 is invalid. + + + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_ok.md b/windows.devices.alljoyn/alljoynstatus_ok.md index 1099d1a92c..13f6f3c919 100644 --- a/windows.devices.alljoyn/alljoynstatus_ok.md +++ b/windows.devices.alljoyn/alljoynstatus_ok.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.Ok --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.Ok ## -description Operation successful. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.Ok +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.Ok + +## -description +Operation successful. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_operationtimedout.md b/windows.devices.alljoyn/alljoynstatus_operationtimedout.md index 1ea497c081..acb99542c8 100644 --- a/windows.devices.alljoyn/alljoynstatus_operationtimedout.md +++ b/windows.devices.alljoyn/alljoynstatus_operationtimedout.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.OperationTimedOut --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.OperationTimedOut ## -description The operation timed out. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.OperationTimedOut +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.OperationTimedOut + +## -description +The operation timed out. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_otherendclosed.md b/windows.devices.alljoyn/alljoynstatus_otherendclosed.md index a1217f729e..a5c15bd5f6 100644 --- a/windows.devices.alljoyn/alljoynstatus_otherendclosed.md +++ b/windows.devices.alljoyn/alljoynstatus_otherendclosed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.OtherEndClosed --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.OtherEndClosed ## -description The Producer end of the session connection was closed. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.OtherEndClosed +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.OtherEndClosed + +## -description +The Producer end of the session connection was closed. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_sslconnectfailed.md b/windows.devices.alljoyn/alljoynstatus_sslconnectfailed.md index 8e03cfb862..9cf87db1b2 100644 --- a/windows.devices.alljoyn/alljoynstatus_sslconnectfailed.md +++ b/windows.devices.alljoyn/alljoynstatus_sslconnectfailed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.SslConnectFailed --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.SslConnectFailed ## -description The SSL connection has failed. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.SslConnectFailed +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.SslConnectFailed + +## -description +The SSL connection has failed. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynstatus_sslidentityverificationfailed.md b/windows.devices.alljoyn/alljoynstatus_sslidentityverificationfailed.md index e5cb025714..11b60bae0c 100644 --- a/windows.devices.alljoyn/alljoynstatus_sslidentityverificationfailed.md +++ b/windows.devices.alljoyn/alljoynstatus_sslidentityverificationfailed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.SslIdentityVerificationFailed --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynStatus.SslIdentityVerificationFailed ## -description The SSL verification failed. Review provided SSL credentials. ## -property-value The relevant AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynStatus.SslIdentityVerificationFailed +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynStatus.SslIdentityVerificationFailed + +## -description +The SSL verification failed. Review provided SSL credentials. + +## -property-value +The relevant AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynwatcherstoppedeventargs.md b/windows.devices.alljoyn/alljoynwatcherstoppedeventargs.md index 57a46fad1a..8c147f314d 100644 --- a/windows.devices.alljoyn/alljoynwatcherstoppedeventargs.md +++ b/windows.devices.alljoyn/alljoynwatcherstoppedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs --api-type: winrt class ---- # Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs ## -description Contains information about the stopped session watcher object. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: T:Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs + +## -description +Contains information about the stopped session watcher object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_alljoynwatcherstoppedeventargs_745845612.md b/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_alljoynwatcherstoppedeventargs_745845612.md index aa7c777163..e16e5f2c00 100644 --- a/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_alljoynwatcherstoppedeventargs_745845612.md +++ b/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_alljoynwatcherstoppedeventargs_745845612.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.AllJoynWatcherStoppedEventArgs ## -description Generates an [AllJoynWatcherStoppedEventArgs](alljoynwatcherstoppedeventargs.md) object that contains status information that identifies the reason the watcher object was stopped. ## -parameters ### -param status The AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.AllJoynWatcherStoppedEventArgs + +## -description +Generates an [AllJoynWatcherStoppedEventArgs](alljoynwatcherstoppedeventargs.md) object that contains status information that identifies the reason the watcher object was stopped. + +## -parameters +### -param status +The AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_status.md b/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_status.md index a3cef0fe62..616ac92883 100644 --- a/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_status.md +++ b/windows.devices.alljoyn/alljoynwatcherstoppedeventargs_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.Status ## -description Returns a status code that was returned when the watcher object is stopped. This value is represented by [AllJoynStatus](alljoynstatus.md). ## -property-value The AllJoyn status code. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: P:Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.AllJoyn.AllJoynWatcherStoppedEventArgs.Status + +## -description +Returns a status code that was returned when the watcher object is stopped. This value is represented by [AllJoynStatus](alljoynstatus.md). + +## -property-value +The AllJoyn status code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/ialljoynacceptsessionjoiner_accept.md b/windows.devices.alljoyn/ialljoynacceptsessionjoiner_accept.md index a5f60c8254..aa2ed35a92 100644 --- a/windows.devices.alljoyn/ialljoynacceptsessionjoiner_accept.md +++ b/windows.devices.alljoyn/ialljoynacceptsessionjoiner_accept.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.AllJoyn.IAllJoynAcceptSessionJoiner.Accept --api-type: winrt method ---- # Windows.Devices.AllJoyn.IAllJoynAcceptSessionJoiner.Accept ## -description Accept an incoming request to join the session. ## -remarks ## -examples ## -see-also ## -capabilities allJoyn \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.IAllJoynAcceptSessionJoiner.Accept +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.IAllJoynAcceptSessionJoiner.Accept + +## -description +Accept an incoming request to join the session. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/ialljoynproducer_setbusobject.md b/windows.devices.alljoyn/ialljoynproducer_setbusobject.md index b78a998ae9..6f4bb19a9b 100644 --- a/windows.devices.alljoyn/ialljoynproducer_setbusobject.md +++ b/windows.devices.alljoyn/ialljoynproducer_setbusobject.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.AllJoyn.IAllJoynProducer.SetBusObject(Windows.Devices.AllJoyn.AllJoynBusObject) --api-type: winrt method ---- # Windows.Devices.AllJoyn.IAllJoynProducer.SetBusObject ## -description Sets the specified bus object to be used when the producer is added. ## -parameters ### -param busObject The desired bus object. ## -remarks ## -examples ## -see-also [AllJoynBusObject.AddProducer](alljoynbusobject_addproducer.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.AllJoyn.IAllJoynProducer.SetBusObject(Windows.Devices.AllJoyn.AllJoynBusObject) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.IAllJoynProducer.SetBusObject + +## -description +Sets the specified bus object to be used when the producer is added. + +## -parameters +### -param busObject +The desired bus object. + +## -remarks + +## -examples + +## -see-also +[AllJoynBusObject.AddProducer](alljoynbusobject_addproducer.md) \ No newline at end of file diff --git a/windows.devices.background/deviceservicingdetails_arguments.md b/windows.devices.background/deviceservicingdetails_arguments.md index fa39d1d605..dbc1ded1c0 100644 --- a/windows.devices.background/deviceservicingdetails_arguments.md +++ b/windows.devices.background/deviceservicingdetails_arguments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Background.DeviceServicingDetails.Arguments --api-type: winrt property ---- # Windows.Devices.Background.DeviceServicingDetails.Arguments ## -description Gets the arguments string provided by the app when it called [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) on the [DeviceServicingTrigger](../windows.applicationmodel.background/deviceservicingtrigger.md). This allows the app to easily pass parameters to the task when it invokes it. ## -property-value The *arguments* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Background.DeviceServicingDetails.Arguments +-api-type: winrt property +--- + + + +# Windows.Devices.Background.DeviceServicingDetails.Arguments + +## -description +Gets the arguments string provided by the app when it called [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) on the [DeviceServicingTrigger](../windows.applicationmodel.background/deviceservicingtrigger.md). This allows the app to easily pass parameters to the task when it invokes it. + +## -property-value +The *arguments* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.background/deviceservicingdetails_deviceid.md b/windows.devices.background/deviceservicingdetails_deviceid.md index bf68099c6d..c3dd26a54b 100644 --- a/windows.devices.background/deviceservicingdetails_deviceid.md +++ b/windows.devices.background/deviceservicingdetails_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Background.DeviceServicingDetails.DeviceId --api-type: winrt property ---- # Windows.Devices.Background.DeviceServicingDetails.DeviceId ## -description Gets the [DeviceInformation.ID](../windows.devices.enumeration/deviceinformation_id.md) of the device the task is targeting. The background task can provide this to the `FromIdAsync` method of the appropriate device access class to open the device. For example, call [UsbDevice.FromIdAsync](../windows.devices.usb/usbdevice_fromidasync.md) in the [Windows.Devices.Usb](../windows.devices.usb/windows_devices_usb.md) namespace to open a USB device. ## -property-value The *deviceId* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Background.DeviceServicingDetails.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Background.DeviceServicingDetails.DeviceId + +## -description +Gets the [DeviceInformation.ID](../windows.devices.enumeration/deviceinformation_id.md) of the device the task is targeting. The background task can provide this to the `FromIdAsync` method of the appropriate device access class to open the device. For example, call [UsbDevice.FromIdAsync](../windows.devices.usb/usbdevice_fromidasync.md) in the [Windows.Devices.Usb](../windows.devices.usb/windows_devices_usb.md) namespace to open a USB device. + +## -property-value +The *deviceId* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.background/deviceservicingdetails_expectedduration.md b/windows.devices.background/deviceservicingdetails_expectedduration.md index fdf0da0ea8..28b7bb39ab 100644 --- a/windows.devices.background/deviceservicingdetails_expectedduration.md +++ b/windows.devices.background/deviceservicingdetails_expectedduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Background.DeviceServicingDetails.ExpectedDuration --api-type: winrt property ---- # Windows.Devices.Background.DeviceServicingDetails.ExpectedDuration ## -description Gets the estimated duration provided by the app when it called [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) on the [DeviceServicingTrigger](../windows.applicationmodel.background/deviceservicingtrigger.md). ## -property-value The *expectedDuration* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Background.DeviceServicingDetails.ExpectedDuration +-api-type: winrt property +--- + + + +# Windows.Devices.Background.DeviceServicingDetails.ExpectedDuration + +## -description +Gets the estimated duration provided by the app when it called [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) on the [DeviceServicingTrigger](../windows.applicationmodel.background/deviceservicingtrigger.md). + +## -property-value +The *expectedDuration* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.background/deviceusedetails_arguments.md b/windows.devices.background/deviceusedetails_arguments.md index f2b8a6d4e4..c9e7d5d5cd 100644 --- a/windows.devices.background/deviceusedetails_arguments.md +++ b/windows.devices.background/deviceusedetails_arguments.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Background.DeviceUseDetails.Arguments --api-type: winrt property ---- # Windows.Devices.Background.DeviceUseDetails.Arguments ## -description Gets the arguments string provided by the app when it called [RequestAsync](../windows.applicationmodel.background/deviceusetrigger_requestasync.md) on the [DeviceUseTrigger](../windows.applicationmodel.background/deviceusetrigger.md). This allows the app to easily pass parameters to the task when it invokes it. ## -property-value The *arguments* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Background.DeviceUseDetails.Arguments +-api-type: winrt property +--- + + + +# Windows.Devices.Background.DeviceUseDetails.Arguments + +## -description +Gets the arguments string provided by the app when it called [RequestAsync](../windows.applicationmodel.background/deviceusetrigger_requestasync.md) on the [DeviceUseTrigger](../windows.applicationmodel.background/deviceusetrigger.md). This allows the app to easily pass parameters to the task when it invokes it. + +## -property-value +The *arguments* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.background/deviceusedetails_deviceid.md b/windows.devices.background/deviceusedetails_deviceid.md index 9cc8e631c3..46931f5a9e 100644 --- a/windows.devices.background/deviceusedetails_deviceid.md +++ b/windows.devices.background/deviceusedetails_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Background.DeviceUseDetails.DeviceId --api-type: winrt property ---- # Windows.Devices.Background.DeviceUseDetails.DeviceId ## -description Gets the [DeviceInformation.ID](../windows.devices.enumeration/deviceinformation_id.md) of the device the task is targeting. The background task can provide this to the `FromIdAsync` method of the appropriate device access class to open the device. For example, call [UsbDevice.FromIdAsync](../windows.devices.usb/usbdevice_fromidasync.md) in the [Windows.Devices.Usb](../windows.devices.usb/windows_devices_usb.md) namespace to open a USB device. ## -property-value The *deviceId* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Background.DeviceUseDetails.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Background.DeviceUseDetails.DeviceId + +## -description +Gets the [DeviceInformation.ID](../windows.devices.enumeration/deviceinformation_id.md) of the device the task is targeting. The background task can provide this to the `FromIdAsync` method of the appropriate device access class to open the device. For example, call [UsbDevice.FromIdAsync](../windows.devices.usb/usbdevice_fromidasync.md) in the [Windows.Devices.Usb](../windows.devices.usb/windows_devices_usb.md) namespace to open a USB device. + +## -property-value +The *deviceId* parameter value from the originating [RequestAsync](../windows.applicationmodel.background/deviceservicingtrigger_requestasync.md) call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement.md index e0e2233fd4..c17e375a81 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement ## -description A representation of a Bluetooth LE advertisement payload. ## -remarks This class is used to represent an advertisement received by the system, an advertisement pattern to filter for, or an advertisement payload that needs to be published. In the case it is generated by the system to represent an advertisement received, certain properties are automatically populated. For more information about its usage, refer to [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) class for receiving advertisements and the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) class for sending advertisements. ## -examples ## -see-also [BluetoothLEAdvertisementBytePattern](bluetoothleadvertisementbytepattern.md), [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md), [BluetoothLEAdvertisementDataTypes](bluetoothleadvertisementdatatypes.md), [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md), [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement + +## -description +A representation of a Bluetooth LE advertisement payload. + +## -remarks +This class is used to represent an advertisement received by the system, an advertisement pattern to filter for, or an advertisement payload that needs to be published. In the case it is generated by the system to represent an advertisement received, certain properties are automatically populated. + +For more information about its usage, refer to [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) class for receiving advertisements and the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) class for sending advertisements. + +## -examples + +## -see-also +[BluetoothLEAdvertisementBytePattern](bluetoothleadvertisementbytepattern.md), [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md), [BluetoothLEAdvertisementDataTypes](bluetoothleadvertisementdatatypes.md), [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md), [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_bluetoothleadvertisement_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_bluetoothleadvertisement_1221375020.md index 1742698ee6..497b4939c8 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_bluetoothleadvertisement_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_bluetoothleadvertisement_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.BluetoothLEAdvertisement ## -description Creates a new [BluetoothLEAdvertisement](bluetoothleadvertisement.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.BluetoothLEAdvertisement + +## -description +Creates a new [BluetoothLEAdvertisement](bluetoothleadvertisement.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_datasections.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_datasections.md index 80d8cd5bd5..0855696f44 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_datasections.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_datasections.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.DataSections --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.DataSections ## -description Gets the list of raw data sections. ## -property-value The list of raw data sections. ## -remarks When a [BluetoothLEAdvertisement](bluetoothleadvertisement.md) is generated by the system, the other properties are different representations of the sections contained within this list. As such, only the [DataSections](bluetoothleadvertisement_datasections.md) property needs to be copied when switching between the different usages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.DataSections +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.DataSections + +## -description +Gets the list of raw data sections. + +## -property-value +The list of raw data sections. + +## -remarks +When a [BluetoothLEAdvertisement](bluetoothleadvertisement.md) is generated by the system, the other properties are different representations of the sections contained within this list. As such, only the [DataSections](bluetoothleadvertisement_datasections.md) property needs to be copied when switching between the different usages. + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_flags.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_flags.md index ade653b86e..eb93fdd847 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_flags.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_flags.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.Flags --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.Flags ## -description Bluetooth LE advertisement flags. ## -property-value Bluetooth LE advertisement flags. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.Flags +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.Flags + +## -description +Bluetooth LE advertisement flags. + +## -property-value +Bluetooth LE advertisement flags. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getmanufacturerdatabycompanyid_1684229603.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getmanufacturerdatabycompanyid_1684229603.md index dae0ecb3e2..a9feb9c67c 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getmanufacturerdatabycompanyid_1684229603.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getmanufacturerdatabycompanyid_1684229603.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetManufacturerDataByCompanyId(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetManufacturerDataByCompanyId ## -description Return a list of all manufacturer data sections in the [BluetoothLEAdvertisement](bluetoothleadvertisement.md) payload matching the specified company ID. ## -parameters ### -param companyId The company identifier code defined by the Bluetooth Special Interest Group (SIG). ## -returns A vector of [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) contained within the payload. ## -remarks ## -examples ## -see-also [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetManufacturerDataByCompanyId(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetManufacturerDataByCompanyId + +## -description +Return a list of all manufacturer data sections in the [BluetoothLEAdvertisement](bluetoothleadvertisement.md) payload matching the specified company ID. + +## -parameters +### -param companyId +The company identifier code defined by the Bluetooth Special Interest Group (SIG). + +## -returns +A vector of [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) contained within the payload. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getsectionsbytype_899223712.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getsectionsbytype_899223712.md index 523b5751c3..361a9c5921 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getsectionsbytype_899223712.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_getsectionsbytype_899223712.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetSectionsByType(System.Byte) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetSectionsByType ## -description Return a list of advertisement data sections that matches a given advertisement section type in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md). ## -parameters ### -param type The advertisement section type ## -returns A vector of all the [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) matching the given advertisement type. This method returns an empty list if no such sections are found in the payload. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetSectionsByType(System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.GetSectionsByType + +## -description +Return a list of advertisement data sections that matches a given advertisement section type in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md). + +## -parameters +### -param type +The advertisement section type + +## -returns +A vector of all the [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) matching the given advertisement type. This method returns an empty list if no such sections are found in the payload. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_localname.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_localname.md index ed3dfe81b8..168d6c6da5 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_localname.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_localname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.LocalName --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.LocalName ## -description The local name contained within the advertisement. ## -property-value The local name contained within the advertisement. This property can be either the shortened or complete local name defined by the Bluetooth LE specifications. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.LocalName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.LocalName + +## -description +The local name contained within the advertisement. + +## -property-value +The local name contained within the advertisement. This property can be either the shortened or complete local name defined by the Bluetooth LE specifications. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_manufacturerdata.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_manufacturerdata.md index e7ee860e1b..6c9676cefc 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_manufacturerdata.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_manufacturerdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ManufacturerData --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ManufacturerData ## -description Gets the list of manufacturer-specific data sections in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md). ## -property-value The list of manufacturer-specific data sections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ManufacturerData +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ManufacturerData + +## -description +Gets the list of manufacturer-specific data sections in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md). + +## -property-value +The list of manufacturer-specific data sections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_serviceuuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_serviceuuids.md index c458a74312..3f4656e227 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_serviceuuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisement_serviceuuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ServiceUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ServiceUuids ## -description The list of service UUIDs in 128-bit GUID format in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md). ## -property-value The list of service UUIDs in 128-bit GUID format. This property aggregates all the 16-bit, 32-bit and 128-bit service UUIDs into a single list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ServiceUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ServiceUuids + +## -description +The list of service UUIDs in 128-bit GUID format in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md). + +## -property-value +The list of service UUIDs in 128-bit GUID format. This property aggregates all the 16-bit, 32-bit and 128-bit service UUIDs into a single list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern.md index fca5ce324c..e669b71235 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern ## -description A Bluetooth LE advertisement byte pattern for filters to match. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern + +## -description +A Bluetooth LE advertisement byte pattern for filters to match. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1221375020.md index 8ac09e24a8..85c9082ac3 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.BluetoothLEAdvertisementBytePattern ## -description Create a new [BluetoothLEAdvertisementBytePattern](bluetoothleadvertisementbytepattern.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementBytePattern(Byte, Int16, IBuffer)](bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1700056151.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.BluetoothLEAdvertisementBytePattern + +## -description +Create a new [BluetoothLEAdvertisementBytePattern](bluetoothleadvertisementbytepattern.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementBytePattern(Byte, Int16, IBuffer)](bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1700056151.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1700056151.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1700056151.md index 331631f029..41a381644e 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1700056151.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_bluetoothleadvertisementbytepattern_1700056151.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.#ctor(System.Byte,System.Int16,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.BluetoothLEAdvertisementBytePattern ## -description Create a new [BluetoothLEAdvertisementBytePattern](bluetoothleadvertisementbytepattern.md) object with an advertisement data type to match, the advertisement data byte pattern to match, and the offset of the byte pattern from the beginning of the advertisement data section. ## -parameters ### -param dataType The Bluetooth LE advertisement data type to match. ### -param offset The offset of byte pattern from beginning of advertisement data section. ### -param data The Bluetooth LE advertisement data byte pattern to match. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.#ctor(System.Byte,System.Int16,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.BluetoothLEAdvertisementBytePattern + +## -description +Create a new [BluetoothLEAdvertisementBytePattern](bluetoothleadvertisementbytepattern.md) object with an advertisement data type to match, the advertisement data byte pattern to match, and the offset of the byte pattern from the beginning of the advertisement data section. + +## -parameters +### -param dataType +The Bluetooth LE advertisement data type to match. + +### -param offset +The offset of byte pattern from beginning of advertisement data section. + +### -param data +The Bluetooth LE advertisement data byte pattern to match. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_data.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_data.md index 099cb7ccf1..f300f01955 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_data.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_data.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Data --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Data ## -description The Bluetooth LE advertisement data byte pattern to match. ## -property-value The Bluetooth LE advertisement data byte pattern to match. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Data +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Data + +## -description +The Bluetooth LE advertisement data byte pattern to match. + +## -property-value +The Bluetooth LE advertisement data byte pattern to match. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_datatype.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_datatype.md index e8aeb118b9..ec4dd38258 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_datatype.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_datatype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.DataType --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.DataType ## -description The Bluetooth LE advertisement data type defined by the Bluetooth Special Interest Group (SIG) to match. ## -property-value The Bluetooth LE advertisement data type to match. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.DataType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.DataType + +## -description +The Bluetooth LE advertisement data type defined by the Bluetooth Special Interest Group (SIG) to match. + +## -property-value +The Bluetooth LE advertisement data type to match. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_offset.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_offset.md index 9420a8fe48..e6bbe1dfce 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_offset.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementbytepattern_offset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Offset --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Offset ## -description The offset of byte pattern from beginning of advertisement data section. ## -property-value The offset of byte pattern from beginning of advertisement data section. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Offset +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementBytePattern.Offset + +## -description +The offset of byte pattern from beginning of advertisement data section. + +## -property-value +The offset of byte pattern from beginning of advertisement data section. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection.md index a55d09064d..09c9769e7a 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection ## -description A Bluetooth LE advertisement section. A Bluetooth LE advertisement packet can contain multiple instances of these [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) objects. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection + +## -description +A Bluetooth LE advertisement section. A Bluetooth LE advertisement packet can contain multiple instances of these [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) objects. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_1221375020.md index 1c8dd8eab9..3f5a56d2e0 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.BluetoothLEAdvertisementDataSection ## -description Creates a new [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementDataSection(Byte, IBuffer)](bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_452095857.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.BluetoothLEAdvertisementDataSection + +## -description +Creates a new [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementDataSection(Byte, IBuffer)](bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_452095857.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_452095857.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_452095857.md index 8675678d4e..4936879d30 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_452095857.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_bluetoothleadvertisementdatasection_452095857.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.#ctor(System.Byte,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.BluetoothLEAdvertisementDataSection ## -description Creates a new [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) object with the Bluetooth LE advertisement data type and the payload. ## -parameters ### -param dataType The Bluetooth LE advertisement data type as defined by the Bluetooth Special Interest Group (SIG). ### -param data The Bluetooth LE advertisement data payload. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.#ctor(System.Byte,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.BluetoothLEAdvertisementDataSection + +## -description +Creates a new [BluetoothLEAdvertisementDataSection](bluetoothleadvertisementdatasection.md) object with the Bluetooth LE advertisement data type and the payload. + +## -parameters +### -param dataType +The Bluetooth LE advertisement data type as defined by the Bluetooth Special Interest Group (SIG). + +### -param data +The Bluetooth LE advertisement data payload. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_data.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_data.md index aff7063708..b7a2f98002 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_data.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_data.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.Data --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.Data ## -description The Bluetooth LE advertisement data payload. ## -property-value The Bluetooth LE advertisement data payload. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.Data +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.Data + +## -description +The Bluetooth LE advertisement data payload. + +## -property-value +The Bluetooth LE advertisement data payload. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_datatype.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_datatype.md index 6a1152e3cb..719ff6505f 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_datatype.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatasection_datatype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.DataType --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.DataType ## -description The Bluetooth LE advertisement data type as defined by the Bluetooth Special Interest Group (SIG). ## -property-value The Bluetooth LE advertisement data type, ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.DataType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataSection.DataType + +## -description +The Bluetooth LE advertisement data type as defined by the Bluetooth Special Interest Group (SIG). + +## -property-value +The Bluetooth LE advertisement data type, + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes.md index 809acf6e30..d45b961840 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes ## -description Some of the Bluetooth LE advertisement types defined in the Generic Access Profile (GAP) by the Bluetooth Special Interest Group (SIG). ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes + +## -description +Some of the Bluetooth LE advertisement types defined in the Generic Access Profile (GAP) by the Bluetooth Special Interest Group (SIG). + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_advertisinginterval.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_advertisinginterval.md index d64b18b88a..4935fe4e60 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_advertisinginterval.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_advertisinginterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.AdvertisingInterval --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.AdvertisingInterval ## -description Section data type for the Bluetooth LE advertising interval. ## -property-value The Bluetooth LE advertising interval. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.AdvertisingInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.AdvertisingInterval + +## -description +Section data type for the Bluetooth LE advertising interval. + +## -property-value +The Bluetooth LE advertising interval. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_appearance.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_appearance.md index 1091c2c2ae..0a505828e6 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_appearance.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_appearance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Appearance --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Appearance ## -description Section data type for the Bluetooth LE advertising appearance. ## -property-value The Bluetooth LE advertising appearance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Appearance +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Appearance + +## -description +Section data type for the Bluetooth LE advertising appearance. + +## -property-value +The Bluetooth LE advertising appearance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completelocalname.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completelocalname.md index e5101e8f45..1d6feaf71b 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completelocalname.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completelocalname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteLocalName --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteLocalName ## -description Section data type for the Bluetooth LE complete local name. ## -property-value The Bluetooth LE complete local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteLocalName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteLocalName + +## -description +Section data type for the Bluetooth LE complete local name. + +## -property-value +The Bluetooth LE complete local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice128bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice128bituuids.md index 4622cd81b7..0e4a68ceb6 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice128bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice128bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService128BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService128BitUuids ## -description Section data type for the complete list of 128-bit Bluetooth LE service UUIDs ## -property-value The complete list of 128-bit Bluetooth LE service UUIDs ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService128BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService128BitUuids + +## -description +Section data type for the complete list of 128-bit Bluetooth LE service UUIDs + +## -property-value +The complete list of 128-bit Bluetooth LE service UUIDs + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice16bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice16bituuids.md index 5b868e7cd6..189595c501 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice16bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice16bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService16BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService16BitUuids ## -description Section data type for the complete list of 16-bit Bluetooth LE service UUIDs ## -property-value The complete list of 16-bit Bluetooth LE service UUIDs ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService16BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService16BitUuids + +## -description +Section data type for the complete list of 16-bit Bluetooth LE service UUIDs + +## -property-value +The complete list of 16-bit Bluetooth LE service UUIDs + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice32bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice32bituuids.md index 78fdeddc8c..acb9380fa8 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice32bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_completeservice32bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService32BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService32BitUuids ## -description Section data type for the complete list of 32-bit Bluetooth LE service UUIDs ## -property-value The complete list of 32-bit Bluetooth LE service UUIDs ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService32BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.CompleteService32BitUuids + +## -description +Section data type for the complete list of 32-bit Bluetooth LE service UUIDs + +## -property-value +The complete list of 32-bit Bluetooth LE service UUIDs + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_flags.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_flags.md index 7d56ff53f6..bf794c1733 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_flags.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_flags.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Flags --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Flags ## -description Section data type for a set of flags for internal use. ## -property-value A set of flags for internal use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Flags +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.Flags + +## -description +Section data type for a set of flags for internal use. + +## -property-value +A set of flags for internal use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice128bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice128bituuids.md index f3d85d3a57..55ab0297fa 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice128bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice128bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService128BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService128BitUuids ## -description Section data type for an incomplete list of 128-bit Bluetooth LE service UUIDs. ## -property-value An incomplete list of 128-bit Bluetooth LE service UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService128BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService128BitUuids + +## -description +Section data type for an incomplete list of 128-bit Bluetooth LE service UUIDs. + +## -property-value +An incomplete list of 128-bit Bluetooth LE service UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice16bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice16bituuids.md index a65195fb47..4e66781ca4 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice16bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice16bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService16BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService16BitUuids ## -description Section data type for an incomplete list of 16-bit Bluetooth LE service UUIDs. ## -property-value An incomplete list of 16-bit Bluetooth LE service UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService16BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService16BitUuids + +## -description +Section data type for an incomplete list of 16-bit Bluetooth LE service UUIDs. + +## -property-value +An incomplete list of 16-bit Bluetooth LE service UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice32bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice32bituuids.md index 3182986fe6..0a7db7ac76 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice32bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_incompleteservice32bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService32BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService32BitUuids ## -description Section data type for an incomplete list of 32-bit Bluetooth LE service UUIDs. ## -property-value An incomplete list of 32-bit Bluetooth LE service UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService32BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.IncompleteService32BitUuids + +## -description +Section data type for an incomplete list of 32-bit Bluetooth LE service UUIDs. + +## -property-value +An incomplete list of 32-bit Bluetooth LE service UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_manufacturerspecificdata.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_manufacturerspecificdata.md index cf97703ef5..993fa6ad85 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_manufacturerspecificdata.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_manufacturerspecificdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ManufacturerSpecificData --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ManufacturerSpecificData ## -description Section data type for manufacturer-specific data for a Bluetooth LE advertisements. ## -property-value Manufacturer-specific data for a Bluetooth LE advertisements. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ManufacturerSpecificData +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ManufacturerSpecificData + +## -description +Section data type for manufacturer-specific data for a Bluetooth LE advertisements. + +## -property-value +Manufacturer-specific data for a Bluetooth LE advertisements. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_publictargetaddress.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_publictargetaddress.md index 3452c849e0..0efc3bd2d2 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_publictargetaddress.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_publictargetaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.PublicTargetAddress --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.PublicTargetAddress ## -description Section data type for a list of public Bluetooth LE target addresses. ## -property-value A list of public Bluetooth LE target addresses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.PublicTargetAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.PublicTargetAddress + +## -description +Section data type for a list of public Bluetooth LE target addresses. + +## -property-value +A list of public Bluetooth LE target addresses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_randomtargetaddress.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_randomtargetaddress.md index 879b3f3ce4..455f03bd55 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_randomtargetaddress.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_randomtargetaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.RandomTargetAddress --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.RandomTargetAddress ## -description Section data type for a list of random Bluetooth LE target addresses. ## -property-value A list of random Bluetooth LE target addresses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.RandomTargetAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.RandomTargetAddress + +## -description +Section data type for a list of random Bluetooth LE target addresses. + +## -property-value +A list of random Bluetooth LE target addresses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata128bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata128bituuids.md index b8b7b6e94f..38524557d1 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata128bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata128bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData128BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData128BitUuids ## -description Section data type for service data for 128-bit Bluetooth LE UUIDs. ## -property-value Service data for 128-bit Bluetooth LE UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData128BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData128BitUuids + +## -description +Section data type for service data for 128-bit Bluetooth LE UUIDs. + +## -property-value +Service data for 128-bit Bluetooth LE UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata16bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata16bituuids.md index 36e4d8c29e..2e67830b12 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata16bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata16bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData16BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData16BitUuids ## -description Section data type for service data for 16-bit Bluetooth LE UUIDs. ## -property-value Service data for 16-bit Bluetooth LE UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData16BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData16BitUuids + +## -description +Section data type for service data for 16-bit Bluetooth LE UUIDs. + +## -property-value +Service data for 16-bit Bluetooth LE UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata32bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata32bituuids.md index 301be41e72..089247c452 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata32bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicedata32bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData32BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData32BitUuids ## -description Section data type for service data for 32-bit Bluetooth LE UUIDs.. ## -property-value Service data for 32-bit Bluetooth LE UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData32BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceData32BitUuids + +## -description +Section data type for service data for 32-bit Bluetooth LE UUIDs.. + +## -property-value +Service data for 32-bit Bluetooth LE UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation128bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation128bituuids.md index 920ef987cb..bef03be776 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation128bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation128bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation128BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation128BitUuids ## -description Section data type for a list of 128-bit Bluetooth LE service solicitation UUIDs. ## -property-value A list of 128-bit Bluetooth LE service solicitation UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation128BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation128BitUuids + +## -description +Section data type for a list of 128-bit Bluetooth LE service solicitation UUIDs. + +## -property-value +A list of 128-bit Bluetooth LE service solicitation UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation16bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation16bituuids.md index 29a6344e4c..9708f17e8c 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation16bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation16bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation16BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation16BitUuids ## -description Section data type for a list of 16-bit Bluetooth LE service solicitation UUIDs. ## -property-value A list of 16-bit Bluetooth LE service solicitation UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation16BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation16BitUuids + +## -description +Section data type for a list of 16-bit Bluetooth LE service solicitation UUIDs. + +## -property-value +A list of 16-bit Bluetooth LE service solicitation UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation32bituuids.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation32bituuids.md index 31ca2b2922..bea86d63b5 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation32bituuids.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_servicesolicitation32bituuids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation32BitUuids --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation32BitUuids ## -description Section data type for a list of 32-bit Bluetooth LE service solicitation UUIDs. ## -property-value A list of 32-bit Bluetooth LE service solicitation UUIDs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation32BitUuids +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ServiceSolicitation32BitUuids + +## -description +Section data type for a list of 32-bit Bluetooth LE service solicitation UUIDs. + +## -property-value +A list of 32-bit Bluetooth LE service solicitation UUIDs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_shortenedlocalname.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_shortenedlocalname.md index 6b2c5d0558..41f26663db 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_shortenedlocalname.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_shortenedlocalname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ShortenedLocalName --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ShortenedLocalName ## -description Section data type for a shortened local name. ## -property-value A shortened local name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ShortenedLocalName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.ShortenedLocalName + +## -description +Section data type for a shortened local name. + +## -property-value +A shortened local name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_slaveconnectionintervalrange.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_slaveconnectionintervalrange.md index 44ae32b2a9..3af390f8a2 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_slaveconnectionintervalrange.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_slaveconnectionintervalrange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.SlaveConnectionIntervalRange --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.SlaveConnectionIntervalRange ## -description Section data type for the slave connection interval range. ## -property-value The slave connection interval range. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.SlaveConnectionIntervalRange +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.SlaveConnectionIntervalRange + +## -description +Section data type for the slave connection interval range. + +## -property-value +The slave connection interval range. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_txpowerlevel.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_txpowerlevel.md index a3a0b8bae8..a3befe8277 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_txpowerlevel.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementdatatypes_txpowerlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.TxPowerLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.TxPowerLevel ## -description Section data type for the Bluetooth LE transmit power level. ## -property-value The Bluetooth LE transmit power level. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.TxPowerLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementDataTypes.TxPowerLevel + +## -description +Section data type for the Bluetooth LE transmit power level. + +## -property-value +The Bluetooth LE transmit power level. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter.md index 3435c95401..b3b4a8b7e7 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter ## -description Groups parameters used to configure payload-based filtering of received Bluetooth LE advertisements. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter + +## -description +Groups parameters used to configure payload-based filtering of received Bluetooth LE advertisements. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_advertisement.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_advertisement.md index a9fb5d88b9..e786594074 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_advertisement.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_advertisement.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.Advertisement --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.Advertisement ## -description A [BluetoothLEAdvertisement](bluetoothleadvertisement.md) object that can be applied as filters to received Bluetooth LE advertisements. ## -property-value A [BluetoothLEAdvertisement](bluetoothleadvertisement.md) object that can be applied as filters to received Bluetooth LE advertisements. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.Advertisement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.Advertisement + +## -description +A [BluetoothLEAdvertisement](bluetoothleadvertisement.md) object that can be applied as filters to received Bluetooth LE advertisements. + +## -property-value +A [BluetoothLEAdvertisement](bluetoothleadvertisement.md) object that can be applied as filters to received Bluetooth LE advertisements. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bluetoothleadvertisementfilter_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bluetoothleadvertisementfilter_1221375020.md index 013779214a..2d27a4cc62 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bluetoothleadvertisementfilter_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bluetoothleadvertisementfilter_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.BluetoothLEAdvertisementFilter ## -description Creates a new [BluetoothLEAdvertisementFilter](bluetoothleadvertisementfilter.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.BluetoothLEAdvertisementFilter + +## -description +Creates a new [BluetoothLEAdvertisementFilter](bluetoothleadvertisementfilter.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bytepatterns.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bytepatterns.md index 0fb07b765e..7e23f25403 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bytepatterns.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementfilter_bytepatterns.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.BytePatterns --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.BytePatterns ## -description Gets a vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement. ## -property-value A vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.BytePatterns +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter.BytePatterns + +## -description +Gets a vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement. + +## -property-value +A vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md index 695a5172a3..66f4ba8cca 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md @@ -1,3 +1,70 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher ## -description An object to send Bluetooth Low Energy (LE) advertisements. ## -remarks The [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) class allows the configuration and advertising of a Bluetooth LE advertisement packet. The advertising request is serviced on a best effort basis and the advertising parameters are defined by an advertising policy. The payload of the advertisement is configured when the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) is constructed. The payload can be retrieved by the [Advertisement](bluetoothleadvertisementpublisher_advertisement.md) property of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). The [BluetoothLEAdvertisement](bluetoothleadvertisement.md) class must be managed by the caller if used this way. For example, it is not recommended to directly reuse a [BluetoothLEAdvertisement](bluetoothleadvertisement.md) obtained from a [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) because it contains duplication of actual payload in order to facilitate the access to common data sections. If a received [BluetoothLEAdvertisement](bluetoothleadvertisement.md) needs to be duplicated, only the [DataSections](bluetoothleadvertisement_datasections.md) property should be copied, as they represent the advertisement data sections in their raw form. The local advertisement resource is limited at the protocol layer. Usage of this resource is best suited for controlled scenarios such as enterprise use cases. Other apps may compete for this limited resource and regular broadcast of advertisements for any specific use case cannot be guaranteed. The following advertisement types are allowed: + Manufacturer Specific Information (0xFF) + Any non-standard type not reserved by the system, as shown in the list below. For more information on non-standard types, see [this page](https://www.bluetooth.org/specification/assigned-numbers/generic-access-profile) from the Bluetooth specification. The following advertisement types are system-reserved and are not allowed: + Flags (0x01) + Incomplete List of 16-bit Service UUIDs (0x02) + Complete List of 16-bit Service UUIDs (0x03) + Incomplete List of 32-bit Service UUIDs (0x04) + Complete List of 32-bit Service UUIDs (0x05) + Incomplete List of 128-bit Service UUIDs (0x06) + Complete List of 128-bit Service UUIDs (0x07) + Shortened Local Name (0x08) + Complete Local Name (0x09) + Tx Power Level (0x0A) + Class of Device (0x0D) + Simple Pairing Hash C192 (0x0E) + Simple Pairing Randomizer R192 (0x0F) + Security Manager TK Values (0x10) + Security Manager Out-of-Band Flags (0x11) + Slave Connection Interval Range (0x12) + List of 16-bit Service Solicitation UUIDs (0x14) + List of 32-bit Service Solicitation UUIDs (0x1F) + List of 128-bit Service Solicitation UUIDs (0x15) + Service Data 16-bit UUID (0x16) + Service Data 32-bit UUID (0x20) + Service Data 128-bit UUID (0x21) + Public Target Address (0x17) + Random Target Address (0x18) + Appearance (0x19) + Advertising Interval (0x1A) + LE Bluetooth Device Address (0x1B) + LE Role (0x1C) + Simple Pairing Hash C256 (0x1D) + Simple Pairing Randomizer R256 (0x1E) + 3D Information Data (0x3D) ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisement.DataSections](bluetoothleadvertisement_datasections.md), [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher + +## -description +An object to send Bluetooth Low Energy (LE) advertisements. + +## -remarks +The [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) class allows the configuration and advertising of a Bluetooth LE advertisement packet. The advertising request is serviced on a best effort basis and the advertising parameters are defined by an advertising policy. + +The payload of the advertisement is configured when the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) is constructed. The payload can be retrieved by the [Advertisement](bluetoothleadvertisementpublisher_advertisement.md) property of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). The [BluetoothLEAdvertisement](bluetoothleadvertisement.md) class must be managed by the caller if used this way. For example, it is not recommended to directly reuse a [BluetoothLEAdvertisement](bluetoothleadvertisement.md) obtained from a [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) because it contains duplication of actual payload in order to facilitate the access to common data sections. If a received [BluetoothLEAdvertisement](bluetoothleadvertisement.md) needs to be duplicated, only the [DataSections](bluetoothleadvertisement_datasections.md) property should be copied, as they represent the advertisement data sections in their raw form. + +The local advertisement resource is limited at the protocol layer. Usage of this resource is best suited for controlled scenarios such as enterprise use cases. Other apps may compete for this limited resource and regular broadcast of advertisements for any specific use case cannot be guaranteed. + + +The following advertisement types are allowed: + ++ Manufacturer Specific Information (0xFF) ++ Any non-standard type not reserved by the system, as shown in the list below. For more information on non-standard types, see [this page](https://www.bluetooth.org/specification/assigned-numbers/generic-access-profile) from the Bluetooth specification. + + + +The following advertisement types are system-reserved and are not allowed: + ++ Flags (0x01) ++ Incomplete List of 16-bit Service UUIDs (0x02) ++ Complete List of 16-bit Service UUIDs (0x03) ++ Incomplete List of 32-bit Service UUIDs (0x04) ++ Complete List of 32-bit Service UUIDs (0x05) ++ Incomplete List of 128-bit Service UUIDs (0x06) ++ Complete List of 128-bit Service UUIDs (0x07) ++ Shortened Local Name (0x08) ++ Complete Local Name (0x09) ++ Tx Power Level (0x0A) ++ Class of Device (0x0D) ++ Simple Pairing Hash C192 (0x0E) ++ Simple Pairing Randomizer R192 (0x0F) ++ Security Manager TK Values (0x10) ++ Security Manager Out-of-Band Flags (0x11) ++ Slave Connection Interval Range (0x12) ++ List of 16-bit Service Solicitation UUIDs (0x14) ++ List of 32-bit Service Solicitation UUIDs (0x1F) ++ List of 128-bit Service Solicitation UUIDs (0x15) ++ Service Data 16-bit UUID (0x16) ++ Service Data 32-bit UUID (0x20) ++ Service Data 128-bit UUID (0x21) ++ Public Target Address (0x17) ++ Random Target Address (0x18) ++ Appearance (0x19) ++ Advertising Interval (0x1A) ++ LE Bluetooth Device Address (0x1B) ++ LE Role (0x1C) ++ Simple Pairing Hash C256 (0x1D) ++ Simple Pairing Randomizer R256 (0x1E) ++ 3D Information Data (0x3D) + + + + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisement.DataSections](bluetoothleadvertisement_datasections.md), [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_advertisement.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_advertisement.md index 84514a4b46..4a17e1e823 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_advertisement.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_advertisement.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Advertisement --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Advertisement ## -description Gets a copy of the Bluetooth LE advertisement to publish. ## -property-value A copy of the Bluetooth LE advertisement to publish. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Advertisement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Advertisement + +## -description +Gets a copy of the Bluetooth LE advertisement to publish. + +## -property-value +A copy of the Bluetooth LE advertisement to publish. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1221375020.md index e2cfe9355d..89d0479e18 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.BluetoothLEAdvertisementPublisher ## -description Creates a new [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementPublisher(BluetoothLEAdvertisement)](bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1239156254.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.BluetoothLEAdvertisementPublisher + +## -description +Creates a new [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisher(BluetoothLEAdvertisement)](bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1239156254.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1239156254.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1239156254.md index 55b26110d4..3de0f2fe3c 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1239156254.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_bluetoothleadvertisementpublisher_1239156254.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.#ctor(Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.BluetoothLEAdvertisementPublisher ## -description Creates a new [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) object with the Bluetooth LE advertisement to publish. ## -parameters ### -param advertisement The Bluetooth LE advertisement to publish. ## -remarks There are additional policy restrictions on certain system-reserved data types that cannot be advertised through using the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). Advertisement containing these data types will be rejected and an exception will be thrown when the [Start](XREF:TODO:w_dvc_blue_ad.bluetoothleadvertisementpublisher_start\) method is called. ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.#ctor(Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.BluetoothLEAdvertisementPublisher + +## -description +Creates a new [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) object with the Bluetooth LE advertisement to publish. + +## -parameters +### -param advertisement +The Bluetooth LE advertisement to publish. + +## -remarks +There are additional policy restrictions on certain system-reserved data types that cannot be advertised through using the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). Advertisement containing these data types will be rejected and an exception will be thrown when the [Start](XREF:TODO:w_dvc_blue_ad.bluetoothleadvertisementpublisher_start\) method is called. + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_start_1587696324.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_start_1587696324.md index a605fa4980..f8dc13a11e 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_start_1587696324.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_start_1587696324.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Start --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Start ## -description Start advertising a Bluetooth LE advertisement payload. ## -remarks The status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will transition to **Started** or **Waiting** depending on whether the advertisement can be serviced or to the **Aborted** state if the request failed immediately due to error. If the [Start](bluetoothleadvertisementpublisher_start.md) method is called in the **Stopping** state, the request will be pended and the state will remain in the **Stopping** state until the request completes, at which time a new request will be sent and the state will transition into **Started**. The [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will be automatically stopped when an app is suspended. ## -examples ## -see-also [BluetoothLEAdvertisementPublisher.Stop](bluetoothleadvertisementpublisher_stop.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md), [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md), [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Start + +## -description +Start advertising a Bluetooth LE advertisement payload. + +## -remarks +The status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will transition to **Started** or **Waiting** depending on whether the advertisement can be serviced or to the **Aborted** state if the request failed immediately due to error. + +If the [Start](bluetoothleadvertisementpublisher_start.md) method is called in the **Stopping** state, the request will be pended and the state will remain in the **Stopping** state until the request completes, at which time a new request will be sent and the state will transition into **Started**. + +The [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will be automatically stopped when an app is suspended. + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisher.Stop](bluetoothleadvertisementpublisher_stop.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md), [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md), [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_status.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_status.md index 09636d547c..8a5e953559 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_status.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Status --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Status ## -description Gets the current status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -property-value The current status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Status + +## -description +Gets the current status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -property-value +The current status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_statuschanged.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_statuschanged.md index 57090dda24..7cdd150ac3 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_statuschanged.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_statuschanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.StatusChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.StatusChanged ## -description Notification that the status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) has changed. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md), [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.StatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.StatusChanged + +## -description +Notification that the status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) has changed. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md), [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_stop_1201535524.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_stop_1201535524.md index a208162713..f4005b67a2 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_stop_1201535524.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher_stop_1201535524.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Stop --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Stop ## -description Stop the publisher and stop advertising a Bluetooth LE advertisement payload. ## -remarks The status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will transition to the **Stopping** state until the advertising is cancelled in which the state will transition to **Stopped** state. Calling the [Stop](bluetoothleadvertisementpublisher_stop.md) method in the **Stopped** or **Aborted** state has no effect. Calling the [Stop](bluetoothleadvertisementpublisher_stop.md) method in the **Stopping** state will overwrite any advertisements in the last [Start](bluetoothleadvertisementpublisher_start.md) method call during that state. The [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will be automatically stopped when an app is suspended. ## -examples ## -see-also [BluetoothLEAdvertisementPublisher.Start](bluetoothleadvertisementpublisher_start.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md), [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md), [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisher.Stop + +## -description +Stop the publisher and stop advertising a Bluetooth LE advertisement payload. + +## -remarks +The status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will transition to the **Stopping** state until the advertising is cancelled in which the state will transition to **Stopped** state. Calling the [Stop](bluetoothleadvertisementpublisher_stop.md) method in the **Stopped** or **Aborted** state has no effect. Calling the [Stop](bluetoothleadvertisementpublisher_stop.md) method in the **Stopping** state will overwrite any advertisements in the last [Start](bluetoothleadvertisementpublisher_start.md) method call during that state. + +The [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) will be automatically stopped when an app is suspended. + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisher.Start](bluetoothleadvertisementpublisher_start.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md), [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md), [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs.md index e592b606c0..d5db0f21e3 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs ## -description Provides data for a [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -remarks A [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) instance is created when the [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event occurs on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) object. ## -examples ## -see-also [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs + +## -description +Provides data for a [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -remarks +A [BluetoothLEAdvertisementPublisherStatusChangedEventArgs](bluetoothleadvertisementpublisherstatuschangedeventargs.md) instance is created when the [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event occurs on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) object. + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_error.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_error.md index c79dc0fc3e..83e35b015b 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_error.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_error.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Error --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Error ## -description Gets the error status for a [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -property-value The error status for a [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Error + +## -description +Gets the error status for a [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -property-value +The error status for a [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event on a [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_status.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_status.md index 69527dad49..0bb56af7d2 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_status.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisherstatuschangedeventargs_status.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Status ## -description Gets the new status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -property-value The new status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). ## -remarks The current status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) might have changed by the time this property is accessed. This property reflects the new status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) at the time it was changed and the [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event occurred. ## -examples ## -see-also [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md), [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementPublisherStatusChangedEventArgs.Status + +## -description +Gets the new status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -property-value +The new status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md). + +## -remarks +The current status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) might have changed by the time this property is accessed. This property reflects the new status of the [BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md) at the time it was changed and the [StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md) event occurred. + +## -examples + +## -see-also +[BluetoothLEAdvertisementPublisher](bluetoothleadvertisementpublisher.md), [BluetoothLEAdvertisementPublisher.StatusChanged](bluetoothleadvertisementpublisher_statuschanged.md), [BluetoothLEAdvertisementPublisherStatus](bluetoothleadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs.md index 85b8701f3a..8892984f99 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs ## -description Provides data for a [Received](bluetoothleadvertisementwatcher_received.md) event on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). A [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) instance is created when the [Received](bluetoothleadvertisementwatcher_received.md) event occurs on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Received](bluetoothleadvertisementwatcher_received.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs + +## -description +Provides data for a [Received](bluetoothleadvertisementwatcher_received.md) event on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). A [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) instance is created when the [Received](bluetoothleadvertisementwatcher_received.md) event occurs on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Received](bluetoothleadvertisementwatcher_received.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisement.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisement.md index ae08fa2028..aaa55ddb19 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisement.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisement.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Advertisement --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Advertisement ## -description Gets the Bluetooth LE advertisement payload data received. ## -property-value The Bluetooth LE advertisement payload data received. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Advertisement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Advertisement + +## -description +Gets the Bluetooth LE advertisement payload data received. + +## -property-value +The Bluetooth LE advertisement payload data received. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisementtype.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisementtype.md index c8768f0ff9..fedff369f1 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisementtype.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_advertisementtype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.AdvertisementType --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.AdvertisementType ## -description Gets the type of the received Bluetooth LE advertisement packet. ## -property-value the type of the received Bluetooth LE advertisement packet. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.AdvertisementType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.AdvertisementType + +## -description +Gets the type of the received Bluetooth LE advertisement packet. + +## -property-value +the type of the received Bluetooth LE advertisement packet. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_bluetoothaddress.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_bluetoothaddress.md index 05c2b0a327..5839bfd263 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_bluetoothaddress.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_bluetoothaddress.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.BluetoothAddress --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.BluetoothAddress ## -description Gets the Bluetooth address of the device sending the Bluetooth LE advertisement. ## -property-value the Bluetooth address of the device sending the Bluetooth LE advertisement. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.BluetoothAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.BluetoothAddress + +## -description +Gets the Bluetooth address of the device sending the Bluetooth LE advertisement. + +## -property-value +the Bluetooth address of the device sending the Bluetooth LE advertisement. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_rawsignalstrengthindbm.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_rawsignalstrengthindbm.md index 3d4230e03e..0499c95583 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_rawsignalstrengthindbm.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_rawsignalstrengthindbm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.RawSignalStrengthInDBm --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.RawSignalStrengthInDBm ## -description Gets the received signal strength indicator (RSSI) value, in dBm, for this received Bluetooth LE advertisement event. This value could be the raw RSSI or a filtered RSSI depending on filtering settings configured through [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md). ## -property-value The received signal strength indicator (RSSI) value, in dBm, for this event. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.RawSignalStrengthInDBm +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.RawSignalStrengthInDBm + +## -description +Gets the received signal strength indicator (RSSI) value, in dBm, for this received Bluetooth LE advertisement event. This value could be the raw RSSI or a filtered RSSI depending on filtering settings configured through [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md). + +## -property-value +The received signal strength indicator (RSSI) value, in dBm, for this event. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_timestamp.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_timestamp.md index a25ad8413f..3612409081 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_timestamp.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementreceivedeventargs_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Timestamp --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Timestamp ## -description Gets the timestamp when the [Received](bluetoothleadvertisementwatcher_received.md) event occurred. ## -property-value The timestamp when the [Received](bluetoothleadvertisementwatcher_received.md) event occurred. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Received](bluetoothleadvertisementwatcher_received.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementReceivedEventArgs.Timestamp + +## -description +Gets the timestamp when the [Received](bluetoothleadvertisementwatcher_received.md) event occurred. + +## -property-value +The timestamp when the [Received](bluetoothleadvertisementwatcher_received.md) event occurred. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Received](bluetoothleadvertisementwatcher_received.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md index 01b1fbf849..17e9c6afed 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher ## -description An object to receive Bluetooth Low Energy (LE) advertisements. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher + +## -description +An object to receive Bluetooth Low Energy (LE) advertisements. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_advertisementfilter.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_advertisementfilter.md index 00ee50db1a..99bf466560 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_advertisementfilter.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_advertisementfilter.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.AdvertisementFilter --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.AdvertisementFilter ## -description Gets or sets a [BluetoothLEAdvertisementFilter](bluetoothleadvertisementfilter.md) object used for configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. ## -property-value Configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.AdvertisementFilter +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.AdvertisementFilter + +## -description +Gets or sets a [BluetoothLEAdvertisementFilter](bluetoothleadvertisementfilter.md) object used for configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. + +## -property-value +Configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1138055855.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1138055855.md index 4373836d88..2feb7baa9d 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1138055855.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1138055855.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.#ctor(Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.BluetoothLEAdvertisementWatcher ## -description Creates a new [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object with an advertisement filter to initialize the watcher. ## -parameters ### -param advertisementFilter The advertisement filter to initialize the watcher. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementFilter](bluetoothleadvertisementfilter.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.#ctor(Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementFilter) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.BluetoothLEAdvertisementWatcher + +## -description +Creates a new [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object with an advertisement filter to initialize the watcher. + +## -parameters +### -param advertisementFilter +The advertisement filter to initialize the watcher. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementFilter](bluetoothleadvertisementfilter.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1221375020.md index c0e0137b26..f94aa29c56 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.BluetoothLEAdvertisementWatcher ## -description Creates a new [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher(BluetoothLEAdvertisementFilter)](bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1138055855.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.BluetoothLEAdvertisementWatcher + +## -description +Creates a new [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEAdvertisementWatcher(BluetoothLEAdvertisementFilter)](bluetoothleadvertisementwatcher_bluetoothleadvertisementwatcher_1138055855.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxoutofrangetimeout.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxoutofrangetimeout.md index 1b94c9c773..163072abfa 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxoutofrangetimeout.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxoutofrangetimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxOutOfRangeTimeout --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxOutOfRangeTimeout ## -description Gets the maximum out of range timeout. ## -property-value The maximum out of range timeout. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxOutOfRangeTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxOutOfRangeTimeout + +## -description +Gets the maximum out of range timeout. + +## -property-value +The maximum out of range timeout. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxsamplinginterval.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxsamplinginterval.md index c47e902c5f..ab48ac53ab 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxsamplinginterval.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_maxsamplinginterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxSamplingInterval --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxSamplingInterval ## -description Gets the maximum sampling interval. ## -property-value The maximum sampling interval. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxSamplingInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MaxSamplingInterval + +## -description +Gets the maximum sampling interval. + +## -property-value +The maximum sampling interval. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minoutofrangetimeout.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minoutofrangetimeout.md index 07088a9f6e..1cd20183af 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minoutofrangetimeout.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minoutofrangetimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinOutOfRangeTimeout --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinOutOfRangeTimeout ## -description Gets the minimum out of range timeout. ## -property-value The minimum out of range timeout. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinOutOfRangeTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinOutOfRangeTimeout + +## -description +Gets the minimum out of range timeout. + +## -property-value +The minimum out of range timeout. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minsamplinginterval.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minsamplinginterval.md index bffd37e6eb..3856ef49e5 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minsamplinginterval.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_minsamplinginterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinSamplingInterval --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinSamplingInterval ## -description Gets the minimum sampling interval. ## -property-value The minimum sampling interval. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinSamplingInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.MinSamplingInterval + +## -description +Gets the minimum sampling interval. + +## -property-value +The minimum sampling interval. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_received.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_received.md index 458223009d..37884f75d8 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_received.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_received.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Received --api-type: winrt event ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Received ## -description Notification for new Bluetooth LE advertisement events received. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Received +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Received + +## -description +Notification for new Bluetooth LE advertisement events received. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementReceivedEventArgs](bluetoothleadvertisementreceivedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_scanningmode.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_scanningmode.md index eff3dc8317..7191ed4186 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_scanningmode.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_scanningmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.ScanningMode --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.ScanningMode ## -description Gets or sets the Bluetooth LE scanning mode. ## -property-value The Bluetooth LE scanning mode. ## -remarks ## -examples ## -see-also [BluetoothLEScanningMode](bluetoothlescanningmode.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.ScanningMode +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.ScanningMode + +## -description +Gets or sets the Bluetooth LE scanning mode. + +## -property-value +The Bluetooth LE scanning mode. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEScanningMode](bluetoothlescanningmode.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_signalstrengthfilter.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_signalstrengthfilter.md index f768e08b33..4e30acfad7 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_signalstrengthfilter.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_signalstrengthfilter.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.SignalStrengthFilter --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.SignalStrengthFilter ## -description Gets or sets a [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md) object used for configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. ## -property-value Configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. ## -remarks The [SignalStrengthFilter](bluetoothleadvertisementwatcher_signalstrengthfilter.md) has additional limitations on its properties when used by the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) class. An exception will be thrown when the watcher is started with parameters outside of the valid range. If the properties are left as **NULL**, a default value is selected. The additional restrictions and default values are as follows: + [InRangeThresholdInDBm](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_inrangethresholdindbm.md) - The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for BR/EDR is -127 (default when **NULL** is -127. + [OutOfRangeThresholdInDBm](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) - The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for BR/EDR is -127 (default when **NULL** is -127). + [OutOfRangeTimeout](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangetimeout.md) - Equal or greater than 1 second and less than or equal to 60 seconds (default when **NULL** is 60 seconds). + [SamplingInterval](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_samplinginterval.md) - Equal or greater than 0. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. For more information about the behavior of the RSSI filtering, refer to the [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md). ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.SignalStrengthFilter +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.SignalStrengthFilter + +## -description +Gets or sets a [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md) object used for configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. + +## -property-value +Configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering. + +## -remarks +The [SignalStrengthFilter](bluetoothleadvertisementwatcher_signalstrengthfilter.md) has additional limitations on its properties when used by the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) class. An exception will be thrown when the watcher is started with parameters outside of the valid range. If the properties are left as **NULL**, a default value is selected. + +The additional restrictions and default values are as follows: + + ++ [InRangeThresholdInDBm](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_inrangethresholdindbm.md) - The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for BR/EDR is -127 (default when **NULL** is -127. ++ [OutOfRangeThresholdInDBm](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) - The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for BR/EDR is -127 (default when **NULL** is -127). ++ [OutOfRangeTimeout](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangetimeout.md) - Equal or greater than 1 second and less than or equal to 60 seconds (default when **NULL** is 60 seconds). ++ [SamplingInterval](../windows.devices.bluetooth/bluetoothsignalstrengthfilter_samplinginterval.md) - Equal or greater than 0. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. For more information about the behavior of the RSSI filtering, refer to the [BluetoothSignalStrengthFilter](../windows.devices.bluetooth/bluetoothsignalstrengthfilter.md). + + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_start_1587696324.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_start_1587696324.md index f5024948b6..279715e982 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_start_1587696324.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_start_1587696324.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Start --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Start ## -description Start the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) to scan for Bluetooth LE advertisements. ## -remarks This method will transition the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) to the **Started** state immediately with a pending scan request or to the **Aborted** state if the request failed immediately due to error. If this method is called in the **Stopping** state, the request will be pended and the state will remain in the **Stopping** state until the request completes, at which time a new request will be sent and the state will transition to the **Started** state. The [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) will be automatically stopped when an app is suspended. ## -examples ## -see-also [BluetoothLEAdvertisementWatcherStatus](bluetoothleadvertisementwatcherstatus.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Start + +## -description +Start the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) to scan for Bluetooth LE advertisements. + +## -remarks +This method will transition the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) to the **Started** state immediately with a pending scan request or to the **Aborted** state if the request failed immediately due to error. + +If this method is called in the **Stopping** state, the request will be pended and the state will remain in the **Stopping** state until the request completes, at which time a new request will be sent and the state will transition to the **Started** state. + +The [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) will be automatically stopped when an app is suspended. + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcherStatus](bluetoothleadvertisementwatcherstatus.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_status.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_status.md index 35dbeb197f..c7a5ef68bf 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_status.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Status --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Status ## -description Gets the current status of the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). ## -property-value The current status of the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Status + +## -description +Gets the current status of the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). + +## -property-value +The current status of the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stop_1201535524.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stop_1201535524.md index 1b3d840cd9..1e7427d56c 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stop_1201535524.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stop_1201535524.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stop --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stop ## -description Stop the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) and disable the scanning for Bluetooth LE advertisements. ## -remarks This method will transition the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) to the **Stopping** state until the scan is cancelled in which the state will transition to the **Stopped** state. Calling this method in the **Stopped** or **Aborted** state has no effect. Calling this method in the **Stopping** state will overwrite any advertisements received in the last [Start](bluetoothleadvertisementwatcher_start.md) method call during that state. The [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) will be automatically stopped when an app is suspended. > [!NOTE] > Stopping the scan for the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) will not actually stop the Bluetooth radio from scanning if another app or the system still requires the radio to remain in a scanning state. ## -examples ## -see-also [BluetoothLEAdvertisementWatcherStatus](bluetoothleadvertisementwatcherstatus.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stop + +## -description +Stop the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) and disable the scanning for Bluetooth LE advertisements. + +## -remarks +This method will transition the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) to the **Stopping** state until the scan is cancelled in which the state will transition to the **Stopped** state. Calling this method in the **Stopped** or **Aborted** state has no effect. Calling this method in the **Stopping** state will overwrite any advertisements received in the last [Start](bluetoothleadvertisementwatcher_start.md) method call during that state. + +The [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) will be automatically stopped when an app is suspended. + +> [!NOTE] +> Stopping the scan for the [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) will not actually stop the Bluetooth radio from scanning if another app or the system still requires the radio to remain in a scanning state. + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcherStatus](bluetoothleadvertisementwatcherstatus.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stopped.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stopped.md index 274556f475..00f305cebd 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stopped.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_stopped.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stopped --api-type: winrt event ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stopped ## -description Notification to the app that the Bluetooth LE scanning for advertisements has been cancelled or aborted either by the app or due to an error. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementWatcherStoppedEventArgs](bluetoothleadvertisementwatcherstoppedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcher.Stopped + +## -description +Notification to the app that the Bluetooth LE scanning for advertisements has been cancelled or aborted either by the app or due to an error. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcherStoppedEventArgs](bluetoothleadvertisementwatcherstoppedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs.md index 75eada3bb7..36262270c6 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs ## -description Provides data for a [Stopped](bluetoothleadvertisementwatcher_stopped.md) event on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). A [BluetoothLEAdvertisementWatcherStoppedEventArgs](bluetoothleadvertisementwatcherstoppedeventargs.md) instance is created when the [Stopped](bluetoothleadvertisementwatcher_stopped.md) event occurs on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Stopped](bluetoothleadvertisementwatcher_stopped.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs + +## -description +Provides data for a [Stopped](bluetoothleadvertisementwatcher_stopped.md) event on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md). A [BluetoothLEAdvertisementWatcherStoppedEventArgs](bluetoothleadvertisementwatcherstoppedeventargs.md) instance is created when the [Stopped](bluetoothleadvertisementwatcher_stopped.md) event occurs on a [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Stopped](bluetoothleadvertisementwatcher_stopped.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs_error.md b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs_error.md index 02703cb9af..3d43f72277 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs_error.md +++ b/windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcherstoppedeventargs_error.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs.Error --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs.Error ## -description Gets the error status for [Stopped](bluetoothleadvertisementwatcher_stopped.md) event. ## -property-value The error status for [Stopped](bluetoothleadvertisementwatcher_stopped.md) event. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Stopped](bluetoothleadvertisementwatcher_stopped.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisementWatcherStoppedEventArgs.Error + +## -description +Gets the error status for [Stopped](bluetoothleadvertisementwatcher_stopped.md) event. + +## -property-value +The error status for [Stopped](bluetoothleadvertisementwatcher_stopped.md) event. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcher](bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.Stopped](bluetoothleadvertisementwatcher_stopped.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata.md b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata.md index d9d03abf0e..210d3f2bd2 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata.md +++ b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData --api-type: winrt class ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData ## -description A Bluetooth LE manufacturer-specific data section (one particular type of LE advertisement section). A Bluetooth LE advertisement packet can contain multiple instances of these [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) objects. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData + +## -description +A Bluetooth LE manufacturer-specific data section (one particular type of LE advertisement section). A Bluetooth LE advertisement packet can contain multiple instances of these [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) objects. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1221375020.md b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1221375020.md index 064bcb18bb..d959201f61 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1221375020.md +++ b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.BluetoothLEManufacturerData ## -description Creates a new [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEManufacturerData(UInt16, IBuffer)](bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1489238939.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.BluetoothLEManufacturerData + +## -description +Creates a new [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md), [BluetoothLEManufacturerData(UInt16, IBuffer)](bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1489238939.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1489238939.md b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1489238939.md index b042d2339a..34a7857e24 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1489238939.md +++ b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_bluetoothlemanufacturerdata_1489238939.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.#ctor(System.UInt16,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.BluetoothLEManufacturerData ## -description Creates a new [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) object with a company identifier code and manufacterer-specific section data. ## -parameters ### -param companyId The Bluetooth LE company identifier code as defined by the Bluetooth Special Interest Group (SIG). ### -param data Bluetooth LE manufacturer-specific section data. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.#ctor(System.UInt16,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.BluetoothLEManufacturerData + +## -description +Creates a new [BluetoothLEManufacturerData](bluetoothlemanufacturerdata.md) object with a company identifier code and manufacterer-specific section data. + +## -parameters +### -param companyId +The Bluetooth LE company identifier code as defined by the Bluetooth Special Interest Group (SIG). + +### -param data +Bluetooth LE manufacturer-specific section data. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_companyid.md b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_companyid.md index 66986e2520..1dc6d381b3 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_companyid.md +++ b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_companyid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.CompanyId --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.CompanyId ## -description The Bluetooth LE company identifier code as defined by the Bluetooth Special Interest Group (SIG). ## -property-value The Bluetooth LE company identifier code. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.CompanyId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.CompanyId + +## -description +The Bluetooth LE company identifier code as defined by the Bluetooth Special Interest Group (SIG). + +## -property-value +The Bluetooth LE company identifier code. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_data.md b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_data.md index 617d8940ae..a14cdfb1d3 100644 --- a/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_data.md +++ b/windows.devices.bluetooth.advertisement/bluetoothlemanufacturerdata_data.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.Data --api-type: winrt property ---- # Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.Data ## -description Bluetooth LE manufacturer-specific section data. ## -property-value Bluetooth LE manufacturer-specific section data. ## -remarks ## -examples ## -see-also [BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.Data +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Advertisement.BluetoothLEManufacturerData.Data + +## -description +Bluetooth LE manufacturer-specific section data. + +## -property-value +Bluetooth LE manufacturer-specific section data. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEAdvertisement](bluetoothleadvertisement.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md index 47f41d0b0f..ec89c002a6 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails --api-type: winrt class ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails ## -description Provides information about a [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md) trigger. You can obtain an instance of this class through a [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md) trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails + +## -description +Provides information about a [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md) trigger. You can obtain an instance of this class through a [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md) trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_error.md b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_error.md index c065debbc1..28c6de3efb 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_error.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Error --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Error ## -description Gets the error status for the trigger. ## -property-value The error status for the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Error + +## -description +Gets the error status for the trigger. + +## -property-value +The error status for the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_status.md b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_status.md index ce4cd456cc..e48d202287 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_status.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Status --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Status ## -description Gets the current status of the [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md). ## -property-value The current status of the [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails.Status + +## -description +Gets the current status of the [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md). + +## -property-value +The current status of the [BluetoothLEAdvertisementPublisher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementpublisher.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails.md b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails.md index fa9500e431..2256cc94fd 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails --api-type: winrt class ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails ## -description Provides information about a [BluetoothLEAdvertisementWatcher](XREF:TODO:BluetoothLEAdvertisementPublisherTriggerDetails) trigger. You can obtain an instance of this class through a [BluetoothLEAdvertisementWatcher](XREF:TODO:BluetoothLEAdvertisementPublisherTriggerDetails) trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails + +## -description +Provides information about a [BluetoothLEAdvertisementWatcher](XREF:TODO:BluetoothLEAdvertisementPublisherTriggerDetails) trigger. You can obtain an instance of this class through a [BluetoothLEAdvertisementWatcher](XREF:TODO:BluetoothLEAdvertisementPublisherTriggerDetails) trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_advertisements.md b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_advertisements.md index 1ed794922f..8c9faeee22 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_advertisements.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_advertisements.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Advertisements --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Advertisements ## -description Gets a collection of Bluetooth LE advertisements. ## -property-value A collection of Bluetooth LE advertisements. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Advertisements +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Advertisements + +## -description +Gets a collection of Bluetooth LE advertisements. + +## -property-value +A collection of Bluetooth LE advertisements. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_error.md b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_error.md index cb16b0089c..24fc4fbf5e 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_error.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Error --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Error ## -description Gets the error status for the trigger. ## -property-value The error status for the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.Error + +## -description +Gets the error status for the trigger. + +## -property-value +The error status for the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_signalstrengthfilter.md b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_signalstrengthfilter.md index 7cf14563ca..5554f6db48 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_signalstrengthfilter.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementwatchertriggerdetails_signalstrengthfilter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.SignalStrengthFilter --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.SignalStrengthFilter ## -description Gets the parameters used to configure received signal strength indicator (RSSI)-based filtering. ## -property-value The parameters used to configure received signal strength indicator (RSSI)-based filtering. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.SignalStrengthFilter +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementWatcherTriggerDetails.SignalStrengthFilter + +## -description +Gets the parameters used to configure received signal strength indicator (RSSI)-based filtering. + +## -property-value +The parameters used to configure received signal strength indicator (RSSI)-based filtering. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails.md b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails.md index 5ebcbca79d..8829d35682 100644 --- a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails.md +++ b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails --api-type: winrt class ---- # Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails ## -description Provides information about the Bluetooth LE device that caused this trigger to fire. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails + +## -description +Provides information about the Bluetooth LE device that caused this trigger to fire. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_characteristic.md b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_characteristic.md index b4675477e4..56776c9952 100644 --- a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_characteristic.md +++ b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_characteristic.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Characteristic --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Characteristic ## -description Gets the GATT characteristic that changed. ## -property-value The GATT characteristic that changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Characteristic +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Characteristic + +## -description +Gets the GATT characteristic that changed. + +## -property-value +The GATT characteristic that changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_value.md b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_value.md index 98a0e2b8a7..477a2ce471 100644 --- a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_value.md +++ b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Value --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Value ## -description Gets a byte stream containing the new value of the characteristic. ## -property-value A byte stream containing the new value of the characteristic. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Value +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Value + +## -description +Gets a byte stream containing the new value of the characteristic. + +## -property-value +A byte stream containing the new value of the characteristic. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails.md b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails.md index ae9e63603c..775e240919 100644 --- a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails.md +++ b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails --api-type: winrt class ---- # Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails ## -description Provides information about the Bluetooth device that caused this trigger to fire. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails + +## -description +Provides information about the Bluetooth device that caused this trigger to fire. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_incoming.md b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_incoming.md index dcf067cd4c..b16c6b8074 100644 --- a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_incoming.md +++ b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_incoming.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Incoming --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Incoming ## -description Gets whether this is an incoming connection. ## -property-value True if the trigger was fired for an incoming connection; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Incoming +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Incoming + +## -description +Gets whether this is an incoming connection. + +## -property-value +True if the trigger was fired for an incoming connection; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_remotedevice.md b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_remotedevice.md index 66c9167a94..179074491f 100644 --- a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_remotedevice.md +++ b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_remotedevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.RemoteDevice --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.RemoteDevice ## -description Gets the [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object that represents the remote device. ## -property-value The [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object that represents the remote device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.RemoteDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.RemoteDevice + +## -description +Gets the [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object that represents the remote device. + +## -property-value +The [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object that represents the remote device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_socket.md b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_socket.md index ddc79ba5bd..cab636b099 100644 --- a/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_socket.md +++ b/windows.devices.bluetooth.background/rfcommconnectiontriggerdetails_socket.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Socket --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Socket ## -description Gets a reference to the underlying [StreamSocket](../windows.networking.sockets/streamsocket.md) of this connection. ## -property-value A reference to the underlying [StreamSocket](../windows.networking.sockets/streamsocket.md) of this connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Socket +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommConnectionTriggerDetails.Socket + +## -description +Gets a reference to the underlying [StreamSocket](../windows.networking.sockets/streamsocket.md) of this connection. + +## -property-value +A reference to the underlying [StreamSocket](../windows.networking.sockets/streamsocket.md) of this connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation.md b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation.md index 2062f6467b..889428e209 100644 --- a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation.md +++ b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation --api-type: winrt class ---- # Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation ## -description Provides information about incoming RFCOMM connections. If an app wants the system to listen for incoming connections on behalf of an [RfcommConnectionTrigger](../windows.applicationmodel.background/rfcommconnectiontrigger.md), the app must create this object and attach it to the RfcommConnectionTrigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation + +## -description +Provides information about incoming RFCOMM connections. If an app wants the system to listen for incoming connections on behalf of an [RfcommConnectionTrigger](../windows.applicationmodel.background/rfcommconnectiontrigger.md), the app must create this object and attach it to the RfcommConnectionTrigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_localserviceid.md b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_localserviceid.md index a6e900e7d9..993de93fbb 100644 --- a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_localserviceid.md +++ b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_localserviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.LocalServiceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.LocalServiceId ## -description Gets or sets the service UUID that will be advertised in the SDP record. ## -property-value The service UUID that will be advertised in the SDP record. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.LocalServiceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.LocalServiceId + +## -description +Gets or sets the service UUID that will be advertised in the SDP record. + +## -property-value +The service UUID that will be advertised in the SDP record. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_sdprecord.md b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_sdprecord.md index 492d09f00b..349099ec84 100644 --- a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_sdprecord.md +++ b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_sdprecord.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.SdpRecord --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.SdpRecord ## -description Gets or sets the Bluetooth SDP record that the system will advertise on behalf of the app. ## -property-value The Bluetooth SDP record that the system will advertise on behalf of the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.SdpRecord +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.SdpRecord + +## -description +Gets or sets the Bluetooth SDP record that the system will advertise on behalf of the app. + +## -property-value +The Bluetooth SDP record that the system will advertise on behalf of the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_servicecapabilities.md b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_servicecapabilities.md index bfaed41ad5..1a8b3c77b6 100644 --- a/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_servicecapabilities.md +++ b/windows.devices.bluetooth.background/rfcomminboundconnectioninformation_servicecapabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.ServiceCapabilities --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.ServiceCapabilities ## -description Gets or sets the service capabilities that will be advertised. ## -property-value One of the [BluetoothServiceCapabilities](../windows.devices.bluetooth/bluetoothservicecapabilities.md) enumeration values that specifies the service capabilities to be advertised. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.ServiceCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation.ServiceCapabilities + +## -description +Gets or sets the service capabilities that will be advertised. + +## -property-value +One of the [BluetoothServiceCapabilities](../windows.devices.bluetooth/bluetoothservicecapabilities.md) enumeration values that specifies the service capabilities to be advertised. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation.md b/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation.md index d1952129d1..8c61738d0e 100644 --- a/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation.md +++ b/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation --api-type: winrt class ---- # Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation ## -description Provides information for RFCOMM outbound connections. If an app wants the system to create outbound connections on its behalf, the app must create this object and attach it to the [RfcommConnectionTrigger](../windows.applicationmodel.background/rfcommconnectiontrigger.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation + +## -description +Provides information for RFCOMM outbound connections. If an app wants the system to create outbound connections on its behalf, the app must create this object and attach it to the [RfcommConnectionTrigger](../windows.applicationmodel.background/rfcommconnectiontrigger.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation_remoteserviceid.md b/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation_remoteserviceid.md index 98f583683a..06268ce727 100644 --- a/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation_remoteserviceid.md +++ b/windows.devices.bluetooth.background/rfcommoutboundconnectioninformation_remoteserviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation.RemoteServiceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation.RemoteServiceId ## -description Gets or sets the service UUID of the remote service to which the system will connect on behalf of the app. ## -property-value The service UUID of the remote service to which the system will connect on behalf of the app. This value must be set. When the system creates outgoing connections for the app, it will connect to any remote service that lists the specified UUID in its ServiceClassIDList. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation.RemoteServiceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation.RemoteServiceId + +## -description +Gets or sets the service UUID of the remote service to which the system will connect on behalf of the app. + +## -property-value +The service UUID of the remote service to which the system will connect on behalf of the app. This value must be set. When the system creates outgoing connections for the app, it will connect to any remote service that lists the specified UUID in its ServiceClassIDList. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic.md index 128fb3db2d..0f381bd10c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic ## -description Represents a Characteristic of a GATT service. The GattCharacteristic object represents a GATT Characteristic of a particular service, and is obtained from the Characteristics property of the GattDeviceService object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic + +## -description +Represents a Characteristic of a GATT service. The GattCharacteristic object represents a GATT Characteristic of a particular service, and is obtained from the Characteristics property of the GattDeviceService object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_attributehandle.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_attributehandle.md index d6ea16d547..0b702f148b 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_attributehandle.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_attributehandle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.AttributeHandle --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.AttributeHandle ## -description Gets the handle used to uniquely identify GATT-based characteristic attributes as declared on the Bluetooth LE device. ## -property-value Handle that uniquely identifies GATT-based characteristic attributes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.AttributeHandle +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.AttributeHandle + +## -description +Gets the handle used to uniquely identify GATT-based characteristic attributes as declared on the Bluetooth LE device. + +## -property-value +Handle that uniquely identifies GATT-based characteristic attributes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_characteristicproperties.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_characteristicproperties.md index 4c89d51740..7800789c78 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_characteristicproperties.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_characteristicproperties.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.CharacteristicProperties --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.CharacteristicProperties ## -description Gets the GATT characteristic properties, as defined by the GATT profile. If the *ExtendedProperties* flag is present it also represents the properties of the Extended Characteristic Properties Descriptor. ## -property-value The GATT characteristic properties, as defined by the GATT profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.CharacteristicProperties +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.CharacteristicProperties + +## -description +Gets the GATT characteristic properties, as defined by the GATT profile. + +If the *ExtendedProperties* flag is present it also represents the properties of the Extended Characteristic Properties Descriptor. + +## -property-value +The GATT characteristic properties, as defined by the GATT profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_convertshortidtouuid_998320409.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_convertshortidtouuid_998320409.md index b1edc6302b..57d17bcd61 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_convertshortidtouuid_998320409.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_convertshortidtouuid_998320409.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ConvertShortIdToUuid(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ConvertShortIdToUuid ## -description Converts a Bluetooth SIG defined short Id to a full GATT UUID. ## -parameters ### -param shortId A 16-bit Bluetooth GATT Service UUID. ## -returns The corresponding 128-bit GATT Characteristic UUID, that uniquely identifies this characteristic. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ConvertShortIdToUuid(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ConvertShortIdToUuid + +## -description +Converts a Bluetooth SIG defined short Id to a full GATT UUID. + +## -parameters +### -param shortId +A 16-bit Bluetooth GATT Service UUID. + +## -returns +The corresponding 128-bit GATT Characteristic UUID, that uniquely identifies this characteristic. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getalldescriptors_340618261.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getalldescriptors_340618261.md index a9b3f5bc89..7975106505 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getalldescriptors_340618261.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getalldescriptors_340618261.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetAllDescriptors --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetAllDescriptors ## -description Gets the collection of all descriptors belonging to this GattCharacteristic instance. ## -returns The collection of all descriptors belonging to this GattCharacteristic instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetAllDescriptors +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetAllDescriptors + +## -description +Gets the collection of all descriptors belonging to this GattCharacteristic instance. + +## -returns +The collection of all descriptors belonging to this GattCharacteristic instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptors_319594072.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptors_319594072.md index bd8cd876cf..a5140d6af8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptors_319594072.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptors_319594072.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptors(System.Guid) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptors ## -description Returns a vector of descriptors, that are identified by the specified UUID, and belong to this GattCharacteristic instance. ## -parameters ### -param descriptorUuid The UUID for the descriptors to be retrieved. ## -returns A vector of descriptors whose UUIDs match descriptorUuid. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptors(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptors + +## -description +Returns a vector of descriptors, that are identified by the specified UUID, and belong to this GattCharacteristic instance. + +## -parameters +### -param descriptorUuid +The UUID for the descriptors to be retrieved. + +## -returns +A vector of descriptors whose UUIDs match descriptorUuid. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_presentationformats.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_presentationformats.md index 6d607b770b..0708c152d4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_presentationformats.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_presentationformats.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.PresentationFormats --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.PresentationFormats ## -description Gets the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor. The list shall be empty if no PresentationFormat or Aggregate Format descriptors are found. ## -property-value An array of GattPresentationFormat objects that contain the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.PresentationFormats +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.PresentationFormats + +## -description +Gets the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor. + +The list shall be empty if no PresentationFormat or Aggregate Format descriptors are found. + +## -property-value +An array of GattPresentationFormat objects that contain the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_protectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_protectionlevel.md index 927dcae323..5428da171c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_protectionlevel.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_protectionlevel.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ProtectionLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ProtectionLevel ## -description Gets or sets the desired GATT security options for over the air communication with the device. Windows will negotiate the maximum security possible with the device as part of the pairing process, and specifying a lower level of security won’t degrade the existing security level. ## -property-value The desired GATT security options for over the air communication with the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ProtectionLevel + +## -description +Gets or sets the desired GATT security options for over the air communication with the device. + +Windows will negotiate the maximum security possible with the device as part of the pairing process, and specifying a lower level of security won’t degrade the existing security level. + +## -property-value +The desired GATT security options for over the air communication with the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync_310627851.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync_310627851.md index 11ac4d079e..1adb3911a2 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync_310627851.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync_310627851.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadClientCharacteristicConfigurationDescriptorAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadClientCharacteristicConfigurationDescriptorAsync ## -description Reads the current value of the ClientCharacteristicConfigurationDescriptor. ## -returns The object that manages the asynchronous operation. Upon completion of the asynchronous method, the [IAsyncOperation(GattReadClientCharacteristicConfigurationDescriptorResult)](../windows.foundation/iasyncoperation_1.md) contains the result of the read operation, which contains the status of completed operation. The [Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) property on the [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md) returned indicates if the result of the operation was successful. ## -remarks ## -examples ## -see-also [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md), [GattReadClientCharacteristicConfigurationDescriptorResult.ClientCharacteristicConfigurationDescriptor](gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md), [GattReadClientCharacteristicConfigurationDescriptorResult.Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadClientCharacteristicConfigurationDescriptorAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadClientCharacteristicConfigurationDescriptorAsync + +## -description +Reads the current value of the ClientCharacteristicConfigurationDescriptor. + +## -returns +The object that manages the asynchronous operation. Upon completion of the asynchronous method, the [IAsyncOperation(GattReadClientCharacteristicConfigurationDescriptorResult)](../windows.foundation/iasyncoperation_1.md) contains the result of the read operation, which contains the status of completed operation. The [Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) property on the [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md) returned indicates if the result of the operation was successful. + +## -remarks + +## -examples + +## -see-also +[GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md), [GattReadClientCharacteristicConfigurationDescriptorResult.ClientCharacteristicConfigurationDescriptor](gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md), [GattReadClientCharacteristicConfigurationDescriptorResult.Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_2134129157.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_2134129157.md index 973e79da5c..11d11f2ed0 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_2134129157.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_2134129157.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync ## -description Performs a Characteristic Value read either from the value cache maintained by Windows, or directly from the device. ## -parameters ### -param cacheMode Specifies whether to read the value directly from the device or from a value cache maintained by Windows. ## -returns The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. ## -remarks ## -examples ## -see-also [ReadValueAsync](gattcharacteristic_readvalueasync_873593826.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync + +## -description +Performs a Characteristic Value read either from the value cache maintained by Windows, or directly from the device. + +## -parameters +### -param cacheMode +Specifies whether to read the value directly from the device or from a value cache maintained by Windows. + +## -returns +The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. + +## -remarks + +## -examples + +## -see-also +[ReadValueAsync](gattcharacteristic_readvalueasync_873593826.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_873593826.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_873593826.md index eba26ccd99..1e5056e1e5 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_873593826.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_readvalueasync_873593826.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync ## -description Performs a Characteristic Value read from the value cache maintained by Windows. ## -returns The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. ## -remarks ## -examples ## -see-also [ReadValueAsync(BluetoothCacheMode)](gattcharacteristic_readvalueasync_2134129157.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ReadValueAsync + +## -description +Performs a Characteristic Value read from the value cache maintained by Windows. + +## -returns +The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. + +## -remarks + +## -examples + +## -see-also +[ReadValueAsync(BluetoothCacheMode)](gattcharacteristic_readvalueasync_2134129157.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_service.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_service.md index 9ac6b418bb..8c466c3316 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_service.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_service.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Service --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Service ## -description Gets the [GattDeviceService](gattdeviceservice.md) of which this characteristic is a member. ## -property-value The [GattDeviceService](gattdeviceservice.md) of which this characteristic is a member. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Service +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Service + +## -description +Gets the [GattDeviceService](gattdeviceservice.md) of which this characteristic is a member. + +## -property-value +The [GattDeviceService](gattdeviceservice.md) of which this characteristic is a member. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_userdescription.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_userdescription.md index aea0468537..5fb2ebb1f8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_userdescription.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_userdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.UserDescription --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.UserDescription ## -description Get the user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string. ## -property-value The user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.UserDescription +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.UserDescription + +## -description +Get the user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string. + +## -property-value +The user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_uuid.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_uuid.md index c840a1fbfa..784136f7d3 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_uuid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_uuid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Uuid --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Uuid ## -description Gets the GATT Characteristic UUID for this GattCharacteristic. ## -property-value The GATT Characteristic UUID for this GattCharacteristic. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.Uuid + +## -description +Gets the GATT Characteristic UUID for this GattCharacteristic. + +## -property-value +The GATT Characteristic UUID for this GattCharacteristic. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_valuechanged.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_valuechanged.md index e60c7cf75a..121415fc75 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_valuechanged.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_valuechanged.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ValueChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ValueChanged ## -description An App can register an event handler in order to receive events when notification or indications are received from a device, after setting the Client Characteristic Configuration Descriptor. ## -remarks The [GattValueChangedEventArgs](gattvaluechangedeventargs.md) object represents the arguments received by a [ValueChanged](gattcharacteristic_valuechanged.md) event handler used to process characteristic value change notification and indication events sent by a Bluetooth LE device. ## -examples ## -see-also [GattValueChangedEventArgs](gattvaluechangedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ValueChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.ValueChanged + +## -description +An App can register an event handler in order to receive events when notification or indications are received from a device, after setting the Client Characteristic Configuration Descriptor. + +## -remarks +The [GattValueChangedEventArgs](gattvaluechangedeventargs.md) object represents the arguments received by a [ValueChanged](gattcharacteristic_valuechanged.md) event handler used to process characteristic value change notification and indication events sent by a Bluetooth LE device. + +## -examples + +## -see-also +[GattValueChangedEventArgs](gattvaluechangedeventargs.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorasync_1448478467.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorasync_1448478467.md index 5eca05c653..600d61fbbf 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorasync_1448478467.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorasync_1448478467.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteClientCharacteristicConfigurationDescriptorAsync(Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientCharacteristicConfigurationDescriptorValue) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteClientCharacteristicConfigurationDescriptorAsync ## -description Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device. ## -parameters ### -param clientCharacteristicConfigurationDescriptorValue Specifies a new value for the ClientCharacteristicConfigurationDescriptor of this Characteristic object. ## -returns The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteClientCharacteristicConfigurationDescriptorAsync(Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientCharacteristicConfigurationDescriptorValue) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteClientCharacteristicConfigurationDescriptorAsync + +## -description +Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device. + +## -parameters +### -param clientCharacteristicConfigurationDescriptorValue +Specifies a new value for the ClientCharacteristicConfigurationDescriptor of this Characteristic object. + +## -returns +The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_1609109153.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_1609109153.md index dc84225c31..b9fc113a09 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_1609109153.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_1609109153.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync ## -description Performs a Characteristic Value write to a Bluetooth LE device. ## -parameters ### -param value A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. ## -returns The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. ## -remarks ## -examples ## -see-also [WriteValueAsync(IBuffer, GattWriteOption)](gattcharacteristic_writevalueasync_991358569.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync + +## -description +Performs a Characteristic Value write to a Bluetooth LE device. + +## -parameters +### -param value +A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. + +## -returns +The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. + +## -remarks + +## -examples + +## -see-also +[WriteValueAsync(IBuffer, GattWriteOption)](gattcharacteristic_writevalueasync_991358569.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_991358569.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_991358569.md index 50edb9c0d3..6a7d11ea06 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_991358569.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevalueasync_991358569.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync(Windows.Storage.Streams.IBuffer,Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteOption) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync ## -description Performs a Characteristic Value write to a Bluetooth LE device. ## -parameters ### -param value A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. ### -param writeOption Specifies what type of GATT write should be performed. ## -returns The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. ## -remarks ## -examples ## -see-also [WriteValueAsync(IBuffer)](gattcharacteristic_writevalueasync_1609109153.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync(Windows.Storage.Streams.IBuffer,Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteOption) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueAsync + +## -description +Performs a Characteristic Value write to a Bluetooth LE device. + +## -parameters +### -param value +A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. + +### -param writeOption +Specifies what type of GATT write should be performed. + +## -returns +The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. + +## -remarks + +## -examples + +## -see-also +[WriteValueAsync(IBuffer)](gattcharacteristic_writevalueasync_1609109153.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids.md index b1e4577b7b..5de1010cd8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids ## -description Represents an enumeration of the most well known Characteristic UUID values, and provides convenience methods for working with GATT characteristic UUIDs, and static properties providing characteristic UUIDs for common GATT characteristics. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids + +## -description +Represents an enumeration of the most well known Characteristic UUID values, and provides convenience methods for working with GATT characteristic UUIDs, and static properties providing characteristic UUIDs for common GATT characteristics. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryid.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryid.md index da55ee30be..87169c5e19 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryId --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryId ## -description Gets the Bluetooth SIG-defined AlertCategoryId characteristic UUID. ## -property-value The Bluetooth SIG-defined AlertCategoryId characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryId + +## -description +Gets the Bluetooth SIG-defined AlertCategoryId characteristic UUID. + +## -property-value +The Bluetooth SIG-defined AlertCategoryId characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryidbitmask.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryidbitmask.md index c5d8d7babf..87e69d0ea0 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryidbitmask.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertcategoryidbitmask.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryIdBitMask --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryIdBitMask ## -description Gets the Bluetooth SIG-Defined AlertCategoryIdBitMask characteristic UUID. To view a list of all Bluetooth SIG-defined characteristic UUIDs, see [Bluetooth SIG-defined Characteristic UUIDs](http://go.microsoft.com/fwlink/p/?LinkId=391800). ## -property-value The Bluetooth SIG-defined AlertCategoryIdBitMask characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryIdBitMask +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertCategoryIdBitMask + +## -description +Gets the Bluetooth SIG-Defined AlertCategoryIdBitMask characteristic UUID. To view a list of all Bluetooth SIG-defined characteristic UUIDs, see [Bluetooth SIG-defined Characteristic UUIDs](http://go.microsoft.com/fwlink/p/?LinkId=391800). + +## -property-value +The Bluetooth SIG-defined AlertCategoryIdBitMask characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertlevel.md index 783cf304ee..34ba8bd348 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertlevel.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertLevel ## -description Gets the Bluetooth SIG-defined AlertLevel characteristic UUID. ## -property-value The Bluetooth SIG-defined AlertLevel characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertLevel + +## -description +Gets the Bluetooth SIG-defined AlertLevel characteristic UUID. + +## -property-value +The Bluetooth SIG-defined AlertLevel characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertnotificationcontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertnotificationcontrolpoint.md index 395411a1d6..5c8ef0f1bd 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertnotificationcontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertnotificationcontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertNotificationControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertNotificationControlPoint ## -description Gets the Bluetooth SIG-defined AlertNotificationControlPoint characteristic UUID. ## -property-value The Bluetooth SIG-defined AlertNotificationControlPoint characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertNotificationControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertNotificationControlPoint + +## -description +Gets the Bluetooth SIG-defined AlertNotificationControlPoint characteristic UUID. + +## -property-value +The Bluetooth SIG-defined AlertNotificationControlPoint characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertstatus.md index c2bf953a0a..bd62465d6a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertstatus.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_alertstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertStatus --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertStatus ## -description Gets the Bluetooth SIG-defined AlertStatus characteristic UUID. ## -property-value The Bluetooth SIG-defined AllertStatus characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.AlertStatus + +## -description +Gets the Bluetooth SIG-defined AlertStatus characteristic UUID. + +## -property-value +The Bluetooth SIG-defined AllertStatus characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_batterylevel.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_batterylevel.md index dae5037b67..8a4055382a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_batterylevel.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_batterylevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BatteryLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BatteryLevel ## -description Gets the Bluetooth SIG-defined Battery Level Characteristic UUID. ## -property-value The Bluetooth SIG-defined Battery Level Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BatteryLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BatteryLevel + +## -description +Gets the Bluetooth SIG-defined Battery Level Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Battery Level Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressurefeature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressurefeature.md index 842244c166..8bbd0468e5 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressurefeature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressurefeature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureFeature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureFeature ## -description Gets the Bluetooth SIG-defined Blood Pressure Feature Characteristic UUID. ## -property-value The Bluetooth SIG-defined Blood Pressure Feature Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureFeature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureFeature + +## -description +Gets the Bluetooth SIG-defined Blood Pressure Feature Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Blood Pressure Feature Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressuremeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressuremeasurement.md index fdab628fb2..91eed173ea 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressuremeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bloodpressuremeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureMeasurement ## -description Gets the Bluetooth SIG-defined Blood Pressure Measurement Characteristic UUID. ## -property-value The Bluetooth SIG-defined Blood Pressure Measurement Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BloodPressureMeasurement + +## -description +Gets the Bluetooth SIG-defined Blood Pressure Measurement Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Blood Pressure Measurement Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bodysensorlocation.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bodysensorlocation.md index 2b8693e987..1949ca8190 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bodysensorlocation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bodysensorlocation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BodySensorLocation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BodySensorLocation ## -description Gets the Bluetooth SIG-defined Body Sensor Location Characteristic UUID. ## -property-value The Bluetooth SIG-defined Body Sensor Location Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BodySensorLocation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BodySensorLocation + +## -description +Gets the Bluetooth SIG-defined Body Sensor Location Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Body Sensor Location Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardinputreport.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardinputreport.md index 8debfa8f43..ac392f3608 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardinputreport.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardinputreport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardInputReport --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardInputReport ## -description Gets the Bluetooth SIG-defined BootKeyboardInputReport characteristic UUID. ## -property-value The Bluetooth SIG-defined BootKayboardInputReport characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardInputReport +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardInputReport + +## -description +Gets the Bluetooth SIG-defined BootKeyboardInputReport characteristic UUID. + +## -property-value +The Bluetooth SIG-defined BootKayboardInputReport characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardoutputreport.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardoutputreport.md index aaec43cd71..353224b9a6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardoutputreport.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootkeyboardoutputreport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardOutputReport --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardOutputReport ## -description Gets the Bluetooth SIG-defined BootKeyboardOutputReport characteristic UUID. ## -property-value The Bluetooth SIG-defined characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardOutputReport +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootKeyboardOutputReport + +## -description +Gets the Bluetooth SIG-defined BootKeyboardOutputReport characteristic UUID. + +## -property-value +The Bluetooth SIG-defined characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootmouseinputreport.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootmouseinputreport.md index 54c35108ef..b20a926a54 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootmouseinputreport.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_bootmouseinputreport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootMouseInputReport --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootMouseInputReport ## -description Gets the Bluetooth SIG-defined BootMouseInputReport characteristic UUID. ## -property-value The Bluetooth SIG-defined BootMouseInputReport characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootMouseInputReport +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.BootMouseInputReport + +## -description +Gets the Bluetooth SIG-defined BootMouseInputReport characteristic UUID. + +## -property-value +The Bluetooth SIG-defined BootMouseInputReport characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscfeature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscfeature.md index 298d0a6461..2c48d4de47 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscfeature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscfeature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscFeature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscFeature ## -description Gets the Bluetooth SIG-defined Csc Feature Characteristic UUID. ## -property-value The Bluetooth SIG-defined Csc Feature Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscFeature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscFeature + +## -description +Gets the Bluetooth SIG-defined Csc Feature Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Csc Feature Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscmeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscmeasurement.md index 0db28fc9de..4d7264a18f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscmeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cscmeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscMeasurement ## -description Gets the Bluetooth SIG-defined Csc Measurement Characteristic UUID. ## -property-value The Bluetooth SIG-defined Csc Measurement Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CscMeasurement + +## -description +Gets the Bluetooth SIG-defined Csc Measurement Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Csc Measurement Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_currenttime.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_currenttime.md index 2354c73558..45f2698907 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_currenttime.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_currenttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CurrentTime --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CurrentTime ## -description Gets the Bluetooth SIG-defined CurrentTime characteristic UUID. ## -property-value The Bluetooth SIG-defined CurrentTime characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CurrentTime +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CurrentTime + +## -description +Gets the Bluetooth SIG-defined CurrentTime characteristic UUID. + +## -property-value +The Bluetooth SIG-defined CurrentTime characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowercontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowercontrolpoint.md index be04ccc493..5942d46f21 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowercontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowercontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerControlPoint ## -description Gets the Bluetooth SIG-defined CyclingPowerControlPoint characteristic UUID. ## -property-value The Bluetooth SIG-defined CyclingPowerControlPoint characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerControlPoint + +## -description +Gets the Bluetooth SIG-defined CyclingPowerControlPoint characteristic UUID. + +## -property-value +The Bluetooth SIG-defined CyclingPowerControlPoint characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowerfeature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowerfeature.md index be50bf36ca..1c1723f1a9 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowerfeature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowerfeature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerFeature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerFeature ## -description Gets the Bluetooth SIG-defined CyclingPowerFeature characteristic UUID. ## -property-value The Bluetooth SIG-defined CyclingPowerFeature characterisitc UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerFeature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerFeature + +## -description +Gets the Bluetooth SIG-defined CyclingPowerFeature characteristic UUID. + +## -property-value +The Bluetooth SIG-defined CyclingPowerFeature characterisitc UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowermeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowermeasurement.md index 281b86380c..fb660099eb 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowermeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowermeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerMeasurement ## -description Gets the Bluetooth SIG-defined CyclingPowerMeasurement characteristic UUID. ## -property-value The Bluetooth SIG-defined CyclingPowerMeasurement characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerMeasurement + +## -description +Gets the Bluetooth SIG-defined CyclingPowerMeasurement characteristic UUID. + +## -property-value +The Bluetooth SIG-defined CyclingPowerMeasurement characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowervector.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowervector.md index 9f280606fb..eda24147f0 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowervector.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_cyclingpowervector.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerVector --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerVector ## -description Gets the Bluetooth SIG-defined CyclingPowerVector characteristic UUID. ## -property-value The Bluetooth SIG-defined CyclingPowerVector characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerVector +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.CyclingPowerVector + +## -description +Gets the Bluetooth SIG-defined CyclingPowerVector characteristic UUID. + +## -property-value +The Bluetooth SIG-defined CyclingPowerVector characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_datetime.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_datetime.md index df8a404f7a..fe6de1a307 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_datetime.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_datetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DateTime --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DateTime ## -description Gets the Bluetooth SIG-defined DateTime characteristic UUID. ## -property-value The Bluetooth SIG-defined DateTime characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DateTime +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DateTime + +## -description +Gets the Bluetooth SIG-defined DateTime characteristic UUID. + +## -property-value +The Bluetooth SIG-defined DateTime characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_daydatetime.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_daydatetime.md index 011e341b75..4a89f0f507 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_daydatetime.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_daydatetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayDateTime --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayDateTime ## -description Gets the Bluetooth SIG-defined DayDateTime characteristic UUID. ## -property-value The Bluetooth SIG-defined DayDateTime characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayDateTime +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayDateTime + +## -description +Gets the Bluetooth SIG-defined DayDateTime characteristic UUID. + +## -property-value +The Bluetooth SIG-defined DayDateTime characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dayofweek.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dayofweek.md index 6790322300..cfd9c34668 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dayofweek.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dayofweek.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayOfWeek --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayOfWeek ## -description Gets the Bluetooth SIG-defined DayOfWeek characteristic UUID. ## -property-value The Bluetooth SIG-defined DayOfWeek characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayOfWeek +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DayOfWeek + +## -description +Gets the Bluetooth SIG-defined DayOfWeek characteristic UUID. + +## -property-value +The Bluetooth SIG-defined DayOfWeek characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dstoffset.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dstoffset.md index f0238b1a83..95b77369c2 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dstoffset.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_dstoffset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DstOffset --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DstOffset ## -description Gets the Bluetooth SIG-defined DstOffset characteristic UUID. ## -property-value The Bluetooth SIG-defined DstOffset characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DstOffset +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.DstOffset + +## -description +Gets the Bluetooth SIG-defined DstOffset characteristic UUID. + +## -property-value +The Bluetooth SIG-defined DstOffset characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_exacttime256.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_exacttime256.md index c6bf2493fe..300ecae0bc 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_exacttime256.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_exacttime256.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ExactTime256 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ExactTime256 ## -description Gets the Bluetooth SIG-defined ExactTime256 characteristic UUID. ## -property-value The Bluetooth SIG-defined ExactTime256 characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ExactTime256 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ExactTime256 + +## -description +Gets the Bluetooth SIG-defined ExactTime256 characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ExactTime256 characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_firmwarerevisionstring.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_firmwarerevisionstring.md index 643b167a62..837229d45a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_firmwarerevisionstring.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_firmwarerevisionstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.FirmwareRevisionString --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.FirmwareRevisionString ## -description Gets the Bluetooth SIG-defined FirmwareRevisionString characteristic UUID. ## -property-value The Bluetooth SIG-defined FirmwareRevisionString characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.FirmwareRevisionString +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.FirmwareRevisionString + +## -description +Gets the Bluetooth SIG-defined FirmwareRevisionString characteristic UUID. + +## -property-value +The Bluetooth SIG-defined FirmwareRevisionString characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapappearance.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapappearance.md index c9f9987fea..dd9874069d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapappearance.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapappearance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapAppearance --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapAppearance ## -description Gets the Bluetooth SIG-defined GapAppearance characteristic UUID. ## -property-value The Bluetooth SIG-defined GapAppearance characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapAppearance +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapAppearance + +## -description +Gets the Bluetooth SIG-defined GapAppearance characteristic UUID. + +## -property-value +The Bluetooth SIG-defined GapAppearance characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapdevicename.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapdevicename.md index eba637c021..619fddf3db 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapdevicename.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapdevicename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapDeviceName --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapDeviceName ## -description Gets the Bluetooth SIG-defined GapDeviceName characteristic UUID. ## -property-value The Bluetooth SIG-defined GapDeviceName characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapDeviceName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapDeviceName + +## -description +Gets the Bluetooth SIG-defined GapDeviceName characteristic UUID. + +## -property-value +The Bluetooth SIG-defined GapDeviceName characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralpreferredconnectionparameters.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralpreferredconnectionparameters.md index 1fd810228e..eeb1e2e1b8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralpreferredconnectionparameters.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralpreferredconnectionparameters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPreferredConnectionParameters --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPreferredConnectionParameters ## -description Gets the Bluetooth SIG-defined GapPeripheralPreferredConnectionParameters characteristic UUID. ## -property-value The Bluetooth SIG-defined GapPeripheralPreferredConnectionParameters characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPreferredConnectionParameters +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPreferredConnectionParameters + +## -description +Gets the Bluetooth SIG-defined GapPeripheralPreferredConnectionParameters characteristic UUID. + +## -property-value +The Bluetooth SIG-defined GapPeripheralPreferredConnectionParameters characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralprivacyflag.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralprivacyflag.md index eae4533256..4616d4c7fa 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralprivacyflag.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapperipheralprivacyflag.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPrivacyFlag --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPrivacyFlag ## -description Gets the Bluetooth GapPeripheralPrivacyFlag characterisitc UUID. ## -property-value The Bluetooth GapPeripheralPrivacyFlag characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPrivacyFlag +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapPeripheralPrivacyFlag + +## -description +Gets the Bluetooth GapPeripheralPrivacyFlag characterisitc UUID. + +## -property-value +The Bluetooth GapPeripheralPrivacyFlag characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapreconnectionaddress.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapreconnectionaddress.md index 66d375c198..4ead659fb2 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapreconnectionaddress.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gapreconnectionaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapReconnectionAddress --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapReconnectionAddress ## -description Gets the Bluetooth SIG-defined GapReconnectionAddress characteristic UUID. ## -property-value The Bluetooth SIG-defined GapReconnectionAddress characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapReconnectionAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GapReconnectionAddress + +## -description +Gets the Bluetooth SIG-defined GapReconnectionAddress characteristic UUID. + +## -property-value +The Bluetooth SIG-defined GapReconnectionAddress characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gattservicechanged.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gattservicechanged.md index fdd7ec9bf7..b31554a702 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gattservicechanged.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_gattservicechanged.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GattServiceChanged --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GattServiceChanged ## -description Gets the Bluetooth SIG-defined GattServiceChanged characteristic UUID. ## -property-value The Bluetooth SIG-defined GattServiceChanged characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GattServiceChanged +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GattServiceChanged + +## -description +Gets the Bluetooth SIG-defined GattServiceChanged characteristic UUID. + +## -property-value +The Bluetooth SIG-defined GattServiceChanged characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosefeature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosefeature.md index 03933822c7..eca0277831 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosefeature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosefeature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseFeature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseFeature ## -description Gets the Bluetooth SIG-defined Glucose Feature Characteristic UUID. ## -property-value The Bluetooth SIG-defined Glucose Feature Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseFeature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseFeature + +## -description +Gets the Bluetooth SIG-defined Glucose Feature Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Glucose Feature Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurement.md index 7e95bd8af4..82ffdb9a26 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurement ## -description Gets the Bluetooth SIG-defined Glucose Measurement Characteristic UUID. ## -property-value The Bluetooth SIG-defined Glucose Measurement Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurement + +## -description +Gets the Bluetooth SIG-defined Glucose Measurement Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Glucose Measurement Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurementcontext.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurementcontext.md index 4d8b606e6b..40f889e4f2 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurementcontext.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_glucosemeasurementcontext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurementContext --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurementContext ## -description Gets the Bluetooth SIG-defined Glucose Measurement Context Characteristic UUID. ## -property-value The Bluetooth SIG-defined Glucose Measurement Context Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurementContext +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.GlucoseMeasurementContext + +## -description +Gets the Bluetooth SIG-defined Glucose Measurement Context Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Glucose Measurement Context Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hardwarerevisionstring.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hardwarerevisionstring.md index 5e8f4b0ba1..03be70dbad 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hardwarerevisionstring.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hardwarerevisionstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HardwareRevisionString --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HardwareRevisionString ## -description Gets the Bluetooth SIG-defined HardwareRevisionString characterisitc UUID. ## -property-value The Bluetooth SIG-defined HardwareRevisionString characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HardwareRevisionString +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HardwareRevisionString + +## -description +Gets the Bluetooth SIG-defined HardwareRevisionString characterisitc UUID. + +## -property-value +The Bluetooth SIG-defined HardwareRevisionString characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratecontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratecontrolpoint.md index 6910300c00..ea583b2ec7 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratecontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratecontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateControlPoint ## -description Gets the Bluetooth SIG-defined Heart Rate Control Point Characteristic UUID. ## -property-value The Bluetooth SIG-defined Heart Rate Control Point Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateControlPoint + +## -description +Gets the Bluetooth SIG-defined Heart Rate Control Point Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Heart Rate Control Point Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratemeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratemeasurement.md index a1bb7e08b8..5004c897cf 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratemeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_heartratemeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateMeasurement ## -description Gets the Bluetooth SIG-defined Heart Rate Measurement Characteristic UUID. ## -property-value The Bluetooth SIG-defined Heart Rate Measurement Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HeartRateMeasurement + +## -description +Gets the Bluetooth SIG-defined Heart Rate Measurement Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Heart Rate Measurement Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidcontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidcontrolpoint.md index f683904d87..23bdf541e2 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidcontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidcontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidControlPoint ## -description Gets the Bluetooth SIG-defined HidControlPoint characteristic UUID. ## -property-value The Bluetooth SIG-defined HidControlPoint characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidControlPoint + +## -description +Gets the Bluetooth SIG-defined HidControlPoint characteristic UUID. + +## -property-value +The Bluetooth SIG-defined HidControlPoint characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidinformation.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidinformation.md index e4cd36a77e..b5a749c2b4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidinformation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_hidinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidInformation ## -description Gets the Bluetooth SIG-defined HidInformation characteristic UUID. ## -property-value The Bluetooth SIG-defined HidInformation characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.HidInformation + +## -description +Gets the Bluetooth SIG-defined HidInformation characteristic UUID. + +## -property-value +The Bluetooth SIG-defined HidInformation characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ieee1107320601regulatorycertificationdatalist.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ieee1107320601regulatorycertificationdatalist.md index 81a6d3b923..70ab82d9b1 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ieee1107320601regulatorycertificationdatalist.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ieee1107320601regulatorycertificationdatalist.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Ieee1107320601RegulatoryCertificationDataList --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Ieee1107320601RegulatoryCertificationDataList ## -description Gets the Bluetooth SIG-defined Ieee1107320601RegulatoryCertificationDataList characteristic UUID. ## -property-value The Bluetooth SIG-defined Ieee1107320601RegulatoryCertificationDataList characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Ieee1107320601RegulatoryCertificationDataList +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Ieee1107320601RegulatoryCertificationDataList + +## -description +Gets the Bluetooth SIG-defined Ieee1107320601RegulatoryCertificationDataList characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Ieee1107320601RegulatoryCertificationDataList characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatecuffpressure.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatecuffpressure.md index 89601db80b..6672418d65 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatecuffpressure.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatecuffpressure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateCuffPressure --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateCuffPressure ## -description Gets the Bluetooth SIG-defined Intermediate Cuff Pressure Characteristic UUID. ## -property-value The Bluetooth SIG-defined Intermediate Cuff Pressure Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateCuffPressure +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateCuffPressure + +## -description +Gets the Bluetooth SIG-defined Intermediate Cuff Pressure Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Intermediate Cuff Pressure Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatetemperature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatetemperature.md index 32cb9a2bf6..023a76c913 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatetemperature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_intermediatetemperature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateTemperature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateTemperature ## -description Gets the Bluetooth SIG-defined Intermediate Temperature Characteristic UUID. ## -property-value The Bluetooth SIG-defined Intermediate Temperature Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateTemperature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.IntermediateTemperature + +## -description +Gets the Bluetooth SIG-defined Intermediate Temperature Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Intermediate Temperature Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lncontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lncontrolpoint.md index 62e338cde9..087f61a9f7 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lncontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lncontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnControlPoint ## -description Gets the Bluetooth SIG-defined LnControlPoint characteristic UUID. ## -property-value The Bluetooth SIG-defined LnControlPoint characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnControlPoint + +## -description +Gets the Bluetooth SIG-defined LnControlPoint characteristic UUID. + +## -property-value +The Bluetooth SIG-defined LnControlPoint characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lnfeature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lnfeature.md index 2fea7a2c6a..61becf0a9d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lnfeature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_lnfeature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnFeature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnFeature ## -description Gets the Bluetooth SIG-defined LnFeature characteristic UUID. ## -property-value The Bluetooth SIG-defined LnFeature characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnFeature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LnFeature + +## -description +Gets the Bluetooth SIG-defined LnFeature characteristic UUID. + +## -property-value +The Bluetooth SIG-defined LnFeature characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_localtimeinformation.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_localtimeinformation.md index 4406ba4fad..05da5672b0 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_localtimeinformation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_localtimeinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocalTimeInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocalTimeInformation ## -description Gets the Bluetooth SIG-defined LocalTimeInformation characteristic UUID. ## -property-value The Bluetooth SIG-defined LocalTimeInformation characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocalTimeInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocalTimeInformation + +## -description +Gets the Bluetooth SIG-defined LocalTimeInformation characteristic UUID. + +## -property-value +The Bluetooth SIG-defined LocalTimeInformation characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_locationandspeed.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_locationandspeed.md index abbe96e74e..467aafc49e 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_locationandspeed.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_locationandspeed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocationAndSpeed --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocationAndSpeed ## -description Gets the Bluetooth SIG-defined LocationAndSpeed characteristic UUID. ## -property-value The Bluetooth SIG-defined LocationAndSpeed characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocationAndSpeed +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.LocationAndSpeed + +## -description +Gets the Bluetooth SIG-defined LocationAndSpeed characteristic UUID. + +## -property-value +The Bluetooth SIG-defined LocationAndSpeed characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_manufacturernamestring.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_manufacturernamestring.md index a269777782..61bb0ed902 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_manufacturernamestring.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_manufacturernamestring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ManufacturerNameString --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ManufacturerNameString ## -description Gets the Bluetooth SIG-defined ManufacturerNameString characteristic UUID. ## -property-value The Bluetooth SIG-defined ManufacturerNameString characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ManufacturerNameString +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ManufacturerNameString + +## -description +Gets the Bluetooth SIG-defined ManufacturerNameString characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ManufacturerNameString characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_measurementinterval.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_measurementinterval.md index 11ead623a8..1a5ad754bc 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_measurementinterval.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_measurementinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.MeasurementInterval --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.MeasurementInterval ## -description Gets the Bluetooth SIG-defined Measurement Interval Characteristic UUID. ## -property-value The Bluetooth SIG-defined Measurement Interval Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.MeasurementInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.MeasurementInterval + +## -description +Gets the Bluetooth SIG-defined Measurement Interval Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Measurement Interval Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_modelnumberstring.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_modelnumberstring.md index f7e1d8bbe0..34b1c042d3 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_modelnumberstring.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_modelnumberstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ModelNumberString --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ModelNumberString ## -description Gets the Bluetooth SIG-defined ModelNumberString UUID. ## -property-value The Bluetooth SIG-defined ModelNumberString UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ModelNumberString +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ModelNumberString + +## -description +Gets the Bluetooth SIG-defined ModelNumberString UUID. + +## -property-value +The Bluetooth SIG-defined ModelNumberString UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_navigation.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_navigation.md index 8bc2a5e41b..a98d0687ee 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_navigation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_navigation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Navigation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Navigation ## -description Gets the Bluetooth SIG-defined Navigation characteristic UUID. ## -property-value The Bluetooth SIG-defined Navigation characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Navigation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Navigation + +## -description +Gets the Bluetooth SIG-defined Navigation characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Navigation characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_newalert.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_newalert.md index 0c7c866f39..31b86e66c3 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_newalert.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_newalert.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.NewAlert --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.NewAlert ## -description Gets the Bluetooth SIG-defined NewAlert characteristic UUID. ## -property-value The Bluetooth SIG-defined NewAlert characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.NewAlert +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.NewAlert + +## -description +Gets the Bluetooth SIG-defined NewAlert characteristic UUID. + +## -property-value +The Bluetooth SIG-defined NewAlert characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_pnpid.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_pnpid.md index 1dd39b6574..ad4539888c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_pnpid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_pnpid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PnpId --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PnpId ## -description Gets the Bluetooth SIG-defined PnpId characteristic UUID. ## -property-value The Bluetooth SIG-defined PnpId characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PnpId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PnpId + +## -description +Gets the Bluetooth SIG-defined PnpId characteristic UUID. + +## -property-value +The Bluetooth SIG-defined PnpId characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_positionquality.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_positionquality.md index 6ce64939d4..6c096e94d7 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_positionquality.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_positionquality.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PositionQuality --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PositionQuality ## -description Gets the Bluetooth SIG-defined PositionQuality characteristic UUID. ## -property-value The Bluetooth SIG-defined PositionQuality characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PositionQuality +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.PositionQuality + +## -description +Gets the Bluetooth SIG-defined PositionQuality characteristic UUID. + +## -property-value +The Bluetooth SIG-defined PositionQuality characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_protocolmode.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_protocolmode.md index 1520979cd0..1d43e3247a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_protocolmode.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_protocolmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ProtocolMode --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ProtocolMode ## -description Gets the Bluetooth SIG-defined ProtocolMode characteristic UUID. ## -property-value The Bluetooth SIG-defined ProtocolMode characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ProtocolMode +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ProtocolMode + +## -description +Gets the Bluetooth SIG-defined ProtocolMode characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ProtocolMode characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_recordaccesscontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_recordaccesscontrolpoint.md index 0fa7bc3ba6..7e7c43462f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_recordaccesscontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_recordaccesscontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RecordAccessControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RecordAccessControlPoint ## -description Gets the Bluetooth SIG-defined Record Access Control Point Characteristic UUID. ## -property-value The Bluetooth SIG-defined Record Access Control Point Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RecordAccessControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RecordAccessControlPoint + +## -description +Gets the Bluetooth SIG-defined Record Access Control Point Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Record Access Control Point Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_referencetimeinformation.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_referencetimeinformation.md index f37250177c..ce0cb65223 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_referencetimeinformation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_referencetimeinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReferenceTimeInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReferenceTimeInformation ## -description Gets the Bluetooth SIG-defined ReferenceTimeInformation characteristic UUID. ## -property-value The Bluetooth SIG-defined ReferenceTimeInformation characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReferenceTimeInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReferenceTimeInformation + +## -description +Gets the Bluetooth SIG-defined ReferenceTimeInformation characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ReferenceTimeInformation characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_report.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_report.md index f0598160e7..8f5e2ae825 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_report.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_report.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Report --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Report ## -description Gets the Bluetooth SIG-defined Report characteristic UUID. ## -property-value The Bluetooth SIG-defined Report characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Report +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.Report + +## -description +Gets the Bluetooth SIG-defined Report characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Report characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_reportmap.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_reportmap.md index c5cf0070a6..3a4d361ce5 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_reportmap.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_reportmap.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReportMap --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReportMap ## -description Gets the Bluetooth SIG-defined ReportMap characteristic UUID. ## -property-value The Bluetooth SIG-defined ReportMap characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReportMap +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ReportMap + +## -description +Gets the Bluetooth SIG-defined ReportMap characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ReportMap characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringercontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringercontrolpoint.md index b0d59e0259..9f4722b886 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringercontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringercontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerControlPoint ## -description Gets the Bluetooth SIG-defined RingerControlPoint characteristic UUID. ## -property-value The Bluetooth SIG-defined RingerControlPoint characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerControlPoint + +## -description +Gets the Bluetooth SIG-defined RingerControlPoint characteristic UUID. + +## -property-value +The Bluetooth SIG-defined RingerControlPoint characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringersetting.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringersetting.md index 5aeefa2efb..1fbaf2fabb 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringersetting.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_ringersetting.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerSetting --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerSetting ## -description Gets the Bluetooth SIG-defined RingerSetting characteristic UUID. ## -property-value The Bluetooth SIG-defined RingerSetting characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerSetting +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RingerSetting + +## -description +Gets the Bluetooth SIG-defined RingerSetting characteristic UUID. + +## -property-value +The Bluetooth SIG-defined RingerSetting characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscfeature.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscfeature.md index 2b3396414c..29d44f1dcb 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscfeature.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscfeature.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscFeature --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscFeature ## -description Gets the Bluetooth SIG-defined Rsc Feature Characteristic UUID. ## -property-value The Bluetooth SIG-defined Rsc Feature Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscFeature +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscFeature + +## -description +Gets the Bluetooth SIG-defined Rsc Feature Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Rsc Feature Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscmeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscmeasurement.md index b962299832..63cf583539 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscmeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_rscmeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscMeasurement ## -description Gets the Bluetooth SIG-defined Rsc Measurement Characteristic UUID. ## -property-value The Bluetooth SIG-defined Rsc Measurement Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.RscMeasurement + +## -description +Gets the Bluetooth SIG-defined Rsc Measurement Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Rsc Measurement Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanintervalwindow.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanintervalwindow.md index 61a6196003..7a8a77bfa9 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanintervalwindow.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanintervalwindow.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanIntervalWindow --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanIntervalWindow ## -description Gets the Bluetooth SIG-defined ScanIntervalWindow characteristic UUID. ## -property-value The Bluetooth SIG-defined ScanIntervalWindow characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanIntervalWindow +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanIntervalWindow + +## -description +Gets the Bluetooth SIG-defined ScanIntervalWindow characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ScanIntervalWindow characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanrefresh.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanrefresh.md index 6bd17a6dc8..c075e02a1f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanrefresh.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_scanrefresh.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanRefresh --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanRefresh ## -description Gets the Bluetooth SIG-defined ScanRefresh characteristic UUID. ## -property-value The Bluetooth SIG-defined ScanRefresh characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanRefresh +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.ScanRefresh + +## -description +Gets the Bluetooth SIG-defined ScanRefresh characteristic UUID. + +## -property-value +The Bluetooth SIG-defined ScanRefresh characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sccontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sccontrolpoint.md index 12fb4eaabb..fb0517d2d4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sccontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sccontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SCControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SCControlPoint ## -description Gets the Bluetooth SIG-defined SC Control Point Characteristic UUID. ## -property-value The Bluetooth SIG-defined SC Control Point Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SCControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SCControlPoint + +## -description +Gets the Bluetooth SIG-defined SC Control Point Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined SC Control Point Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sensorlocation.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sensorlocation.md index 96cf1d84d0..5e931bf12d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sensorlocation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_sensorlocation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SensorLocation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SensorLocation ## -description Gets the Bluetooth SIG-defined Sensor Location Characteristic UUID. ## -property-value The Bluetooth SIG-defined Sensor Location Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SensorLocation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SensorLocation + +## -description +Gets the Bluetooth SIG-defined Sensor Location Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Sensor Location Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_serialnumberstring.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_serialnumberstring.md index 497ba03041..a7116727f7 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_serialnumberstring.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_serialnumberstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SerialNumberString --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SerialNumberString ## -description Gets the Bluetooth SIG-defined SerialNumberString characteristic UUID. ## -property-value The Bluetooth SIG-defined SerialNumberString characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SerialNumberString +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SerialNumberString + +## -description +Gets the Bluetooth SIG-defined SerialNumberString characteristic UUID. + +## -property-value +The Bluetooth SIG-defined SerialNumberString characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_softwarerevisionstring.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_softwarerevisionstring.md index 8d3d23dccd..da37255171 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_softwarerevisionstring.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_softwarerevisionstring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SoftwareRevisionString --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SoftwareRevisionString ## -description Gets the Bluetooth SIG-defined SoftwareRevisionString characteristic UUID. ## -property-value The Bluetooth SIG-defined SoftwareRevisionString characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SoftwareRevisionString +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SoftwareRevisionString + +## -description +Gets the Bluetooth SIG-defined SoftwareRevisionString characteristic UUID. + +## -property-value +The Bluetooth SIG-defined SoftwareRevisionString characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportednewalertcategory.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportednewalertcategory.md index fbc616d3e3..ffabd86d34 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportednewalertcategory.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportednewalertcategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportedNewAlertCategory --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportedNewAlertCategory ## -description Gets the Bluetooth SIG-defined SupportedNewAlertCategory characteristic UUID. ## -property-value The Bluetooth SIG-defined SupportedNewAlertCategory characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportedNewAlertCategory +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportedNewAlertCategory + +## -description +Gets the Bluetooth SIG-defined SupportedNewAlertCategory characteristic UUID. + +## -property-value +The Bluetooth SIG-defined SupportedNewAlertCategory characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportunreadalertcategory.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportunreadalertcategory.md index 8001de3e43..e13c49a55d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportunreadalertcategory.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_supportunreadalertcategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportUnreadAlertCategory --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportUnreadAlertCategory ## -description Gets the Bluetooth SIG-defined SupportUnreadAlertCategory characteristic UUID. ## -property-value The Bluetooth SIG-defined SupportUnreadAlertCategory characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportUnreadAlertCategory +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SupportUnreadAlertCategory + +## -description +Gets the Bluetooth SIG-defined SupportUnreadAlertCategory characteristic UUID. + +## -property-value +The Bluetooth SIG-defined SupportUnreadAlertCategory characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_systemid.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_systemid.md index 52348c31fd..5bd1256e73 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_systemid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_systemid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SystemId --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SystemId ## -description Gets the Bluetooth SIG-defined SystemId characteristic UUID. ## -property-value The Bluetooth SIG-defined SystemId characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SystemId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.SystemId + +## -description +Gets the Bluetooth SIG-defined SystemId characteristic UUID. + +## -property-value +The Bluetooth SIG-defined SystemId characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturemeasurement.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturemeasurement.md index 7fd1c7a81c..659cb0e99a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturemeasurement.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturemeasurement.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureMeasurement --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureMeasurement ## -description Gets the Bluetooth SIG-defined Temperature Measurement Characteristic UUID. ## -property-value The Bluetooth SIG-defined Temperature Measurement Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureMeasurement +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureMeasurement + +## -description +Gets the Bluetooth SIG-defined Temperature Measurement Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Temperature Measurement Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturetype.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturetype.md index 5d2e25c6d2..45881f4c00 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturetype.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_temperaturetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureType --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureType ## -description Gets the Bluetooth SIG-defined Temperature Type Characteristic UUID. ## -property-value The Bluetooth SIG-defined Temperature Type Characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TemperatureType + +## -description +Gets the Bluetooth SIG-defined Temperature Type Characteristic UUID. + +## -property-value +The Bluetooth SIG-defined Temperature Type Characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeaccuracy.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeaccuracy.md index 74072a4095..72420aa420 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeaccuracy.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeaccuracy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeAccuracy --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeAccuracy ## -description Gets the Bluetooth SIG-defined TimeAccuracy characteristic UUID. ## -property-value The Bluetooth SIG-defined TimeAccuracy characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeAccuracy + +## -description +Gets the Bluetooth SIG-defined TimeAccuracy characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TimeAccuracy characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timesource.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timesource.md index a1c04a199f..46cde72081 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timesource.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeSource --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeSource ## -description Gets the Bluetooth SIG-defined TimeSource characteristic UUID. ## -property-value The Bluetooth SIG-defined TimeSource characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeSource +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeSource + +## -description +Gets the Bluetooth SIG-defined TimeSource characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TimeSource characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatecontrolpoint.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatecontrolpoint.md index 5c17e67078..311f267fc8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatecontrolpoint.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatecontrolpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateControlPoint --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateControlPoint ## -description Gets the Bluetooth SIG-defined TimeUpdateControlPoint characteristic UUID. ## -property-value The Bluetooth SIG-defined TimeUpdateControlPoint characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateControlPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateControlPoint + +## -description +Gets the Bluetooth SIG-defined TimeUpdateControlPoint characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TimeUpdateControlPoint characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatestate.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatestate.md index 22a2f0e2dd..d8f3052bb9 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatestate.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timeupdatestate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateState --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateState ## -description Gets the Bluetooth SIG-defined TimeUpdateState characteristic UUID. ## -property-value The Bluetooth SIG-defined TimeUpdateState characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateState +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeUpdateState + +## -description +Gets the Bluetooth SIG-defined TimeUpdateState characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TimeUpdateState characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timewithdst.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timewithdst.md index 50b5a206af..66d31e6f59 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timewithdst.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timewithdst.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeWithDst --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeWithDst ## -description Gets the Bluetooth SIG-defined TimeWithDst characteristic UUID. ## -property-value The Bluetooth SIG-defined TimeWithDst characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeWithDst +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeWithDst + +## -description +Gets the Bluetooth SIG-defined TimeWithDst characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TimeWithDst characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timezone.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timezone.md index ce692f3d62..bca1a0dd63 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timezone.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_timezone.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeZone --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeZone ## -description Gets the Bluetooth SIG-defined TimeZone characteristic UUID. ## -property-value The Bluetooth SIG-defined TimeZone characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeZone +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TimeZone + +## -description +Gets the Bluetooth SIG-defined TimeZone characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TimeZone characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_txpowerlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_txpowerlevel.md index 26f7422a8e..aaff989dc8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_txpowerlevel.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_txpowerlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TxPowerLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TxPowerLevel ## -description Gets the Bluetooth SIG-defined TxPowerLevel characteristic UUID. ## -property-value The Bluetooth SIG-defined TxPowerLevel characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TxPowerLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.TxPowerLevel + +## -description +Gets the Bluetooth SIG-defined TxPowerLevel characteristic UUID. + +## -property-value +The Bluetooth SIG-defined TxPowerLevel characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_unreadalertstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_unreadalertstatus.md index cc0f87ba17..7967cd6e32 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_unreadalertstatus.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicuuids_unreadalertstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.UnreadAlertStatus --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.UnreadAlertStatus ## -description Gets the Bluetooth SIG-defined UnreadAlertStatus characteristic UUID. ## -property-value The Bluetooth SIG-defined UnreadAlertStatus characteristic UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.UnreadAlertStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicUuids.UnreadAlertStatus + +## -description +Gets the Bluetooth SIG-defined UnreadAlertStatus characteristic UUID. + +## -property-value +The Bluetooth SIG-defined UnreadAlertStatus characteristic UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor.md index 1963f62975..8f12c5c20c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor ## -description Represents a Descriptor of a GATT Characteristic. The GattDescriptor object represents a GATT Descriptor of a particular characteristic, and is obtained from the Descriptors property of the GattCharacteristic object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor + +## -description +Represents a Descriptor of a GATT Characteristic. The GattDescriptor object represents a GATT Descriptor of a particular characteristic, and is obtained from the Descriptors property of the GattCharacteristic object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_attributehandle.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_attributehandle.md index cc062c53eb..43d9a24a67 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_attributehandle.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_attributehandle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.AttributeHandle --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.AttributeHandle ## -description Gets the GATT Attribute handle used to uniquely identify this attribute on the GATT Server Device. ## -property-value Handle that uniquely identifies this attribute on the GATT Server Device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.AttributeHandle +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.AttributeHandle + +## -description +Gets the GATT Attribute handle used to uniquely identify this attribute on the GATT Server Device. + +## -property-value +Handle that uniquely identifies this attribute on the GATT Server Device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_convertshortidtouuid_998320409.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_convertshortidtouuid_998320409.md index 8d6eafd57f..32fd0b0435 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_convertshortidtouuid_998320409.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_convertshortidtouuid_998320409.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ConvertShortIdToUuid(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ConvertShortIdToUuid ## -description Converts a Bluetooth SIG defined short Id to a full GATT UUID. ## -parameters ### -param shortId A 16-bit Bluetooth GATT Descriptor UUID. ## -returns The corresponding 128-bit GATT Descriptor UUID, that uniquely identifies this descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ConvertShortIdToUuid(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ConvertShortIdToUuid + +## -description +Converts a Bluetooth SIG defined short Id to a full GATT UUID. + +## -parameters +### -param shortId +A 16-bit Bluetooth GATT Descriptor UUID. + +## -returns +The corresponding 128-bit GATT Descriptor UUID, that uniquely identifies this descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_protectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_protectionlevel.md index a932225418..d80973e740 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_protectionlevel.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_protectionlevel.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ProtectionLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ProtectionLevel ## -description Gets or sets the desired GATT security options for over the air communication with the device. Windows will negotiate the maximum security possible with the device as part of the pairing process, and specifying a lower level of security won’t degrade the existing security level. ## -property-value The desired GATT security options for over the air communication with the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ProtectionLevel + +## -description +Gets or sets the desired GATT security options for over the air communication with the device. + +Windows will negotiate the maximum security possible with the device as part of the pairing process, and specifying a lower level of security won’t degrade the existing security level. + +## -property-value +The desired GATT security options for over the air communication with the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_2134129157.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_2134129157.md index 63fb062b22..5574d456e3 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_2134129157.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_2134129157.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync ## -description Performs a Descriptor Value read either from the value cache maintained by Windows, or directly from the device. ## -parameters ### -param cacheMode Specifies whether to read the value directly from the device or from a value cache maintained by Windows. ## -returns The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. ## -remarks ## -examples ## -see-also [ReadValueAsync](gattdescriptor_readvalueasync_873593826.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync + +## -description +Performs a Descriptor Value read either from the value cache maintained by Windows, or directly from the device. + +## -parameters +### -param cacheMode +Specifies whether to read the value directly from the device or from a value cache maintained by Windows. + +## -returns +The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. + +## -remarks + +## -examples + +## -see-also +[ReadValueAsync](gattdescriptor_readvalueasync_873593826.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_873593826.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_873593826.md index 90af7afe3c..6f91aaf6b4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_873593826.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_readvalueasync_873593826.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync ## -description Performs a Descriptor Value read from a value cache maintained by Windows. ## -returns The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. ## -remarks ## -examples ## -see-also [ReadValueAsync(BluetoothCacheMode)](gattdescriptor_readvalueasync_2134129157.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.ReadValueAsync + +## -description +Performs a Descriptor Value read from a value cache maintained by Windows. + +## -returns +The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device. + +## -remarks + +## -examples + +## -see-also +[ReadValueAsync(BluetoothCacheMode)](gattdescriptor_readvalueasync_2134129157.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_uuid.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_uuid.md index 56d29b5f0b..1c8fd3ab53 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_uuid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_uuid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.Uuid --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.Uuid ## -description Gets the GATT Descriptor UUID for this GattDescriptor. ## -property-value The GATT Descriptor UUID for this GattDescriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.Uuid + +## -description +Gets the GATT Descriptor UUID for this GattDescriptor. + +## -property-value +The GATT Descriptor UUID for this GattDescriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevalueasync_1609109153.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevalueasync_1609109153.md index 1f74d33423..cad9a92f0f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevalueasync_1609109153.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevalueasync_1609109153.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.WriteValueAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.WriteValueAsync ## -description Performs a Descriptor Value write to a Bluetooth LE device. ## -parameters ### -param value A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. ## -returns The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.WriteValueAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.WriteValueAsync + +## -description +Performs a Descriptor Value write to a Bluetooth LE device. + +## -parameters +### -param value +A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. + +## -returns +The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids.md index 8b1f4584df..2d26c8e567 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids ## -description Represents an enumeration of the most well known Descriptor UUID values, and provides convenience methods for working with GATT descriptor UUIDs, and static properties providing descriptor UUIDs for common GATT descriptors. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids + +## -description +Represents an enumeration of the most well known Descriptor UUID values, and provides convenience methods for working with GATT descriptor UUIDs, and static properties providing descriptor UUIDs for common GATT descriptors. + + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicaggregateformat.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicaggregateformat.md index 536a968e36..f79ac46444 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicaggregateformat.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicaggregateformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicAggregateFormat --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicAggregateFormat ## -description Gets the Bluetooth SIG-defined Characteristic Aggregate Format Descriptor UUID. ## -property-value The Bluetooth SIG-defined Characteristic Aggregate Format Descriptor UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicAggregateFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicAggregateFormat + +## -description +Gets the Bluetooth SIG-defined Characteristic Aggregate Format Descriptor UUID. + +## -property-value +The Bluetooth SIG-defined Characteristic Aggregate Format Descriptor UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicextendedproperties.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicextendedproperties.md index 45ace354ea..f9270086bc 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicextendedproperties.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicextendedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicExtendedProperties --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicExtendedProperties ## -description Gets the Bluetooth SIG-defined Characteristic Extended Properties Descriptor UUID. ## -property-value The Bluetooth SIG-defined Characteristic Extended Properties Descriptor UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicExtendedProperties +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicExtendedProperties + +## -description +Gets the Bluetooth SIG-defined Characteristic Extended Properties Descriptor UUID. + +## -property-value +The Bluetooth SIG-defined Characteristic Extended Properties Descriptor UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicpresentationformat.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicpresentationformat.md index f46583f8af..160a6bd26f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicpresentationformat.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicpresentationformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicPresentationFormat --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicPresentationFormat ## -description Gets the Bluetooth SIG-defined Characteristic Presentation Format Descriptor UUID. ## -property-value The Bluetooth SIG-defined Characteristic Presentation Format Descriptor UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicPresentationFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicPresentationFormat + +## -description +Gets the Bluetooth SIG-defined Characteristic Presentation Format Descriptor UUID. + +## -property-value +The Bluetooth SIG-defined Characteristic Presentation Format Descriptor UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicuserdescription.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicuserdescription.md index 97e5573938..2cba7a550d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicuserdescription.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_characteristicuserdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicUserDescription --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicUserDescription ## -description Gets the Bluetooth SIG-defined Characteristic User Description Descriptor UUID. ## -property-value The Bluetooth SIG-defined Characteristic User Description Descriptor UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicUserDescription +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.CharacteristicUserDescription + +## -description +Gets the Bluetooth SIG-defined Characteristic User Description Descriptor UUID. + +## -property-value +The Bluetooth SIG-defined Characteristic User Description Descriptor UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_clientcharacteristicconfiguration.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_clientcharacteristicconfiguration.md index e2dbe30801..9726a3724f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_clientcharacteristicconfiguration.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_clientcharacteristicconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ClientCharacteristicConfiguration --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ClientCharacteristicConfiguration ## -description Gets the Bluetooth SIG-defined Client Characteristic Configuration Descriptor UUID. ## -property-value The Bluetooth SIG-defined Client Characteristic Configuration Descriptor UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ClientCharacteristicConfiguration +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ClientCharacteristicConfiguration + +## -description +Gets the Bluetooth SIG-defined Client Characteristic Configuration Descriptor UUID. + +## -property-value +The Bluetooth SIG-defined Client Characteristic Configuration Descriptor UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_servercharacteristicconfiguration.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_servercharacteristicconfiguration.md index 8ea53293c6..f886a2f974 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_servercharacteristicconfiguration.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptoruuids_servercharacteristicconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ServerCharacteristicConfiguration --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ServerCharacteristicConfiguration ## -description Gets the Bluetooth SIG-defined Server Characteristic Configuration Descriptor UUID. ## -property-value The Bluetooth SIG-defined Server Characteristic Configuration Descriptor UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ServerCharacteristicConfiguration +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorUuids.ServerCharacteristicConfiguration + +## -description +Gets the Bluetooth SIG-defined Server Characteristic Configuration Descriptor UUID. + +## -property-value +The Bluetooth SIG-defined Server Characteristic Configuration Descriptor UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md index 594d94c260..962ca61264 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService ## -description Represents a GATT Primary Service on a Bluetooth device. The [GattDeviceService](gattdeviceservice.md) class represents a GATT service on a Bluetooth LE device. It is instantiated by using a device service instance path, obtained by finding a device using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) API. ## -remarks ## -examples ## -see-also [BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService + +## -description +Represents a GATT Primary Service on a Bluetooth device. The [GattDeviceService](gattdeviceservice.md) class represents a GATT service on a Bluetooth LE device. It is instantiated by using a device service instance path, obtained by finding a device using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) API. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_attributehandle.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_attributehandle.md index 04678ad901..539caf7444 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_attributehandle.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_attributehandle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.AttributeHandle --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.AttributeHandle ## -description Gets the handle used to uniquely identify GATT-based service attributes as declared on the Bluetooth LE device. ## -property-value Handle to uniquely identify GATT-based service attributes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.AttributeHandle +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.AttributeHandle + +## -description +Gets the handle used to uniquely identify GATT-based service attributes as declared on the Bluetooth LE device. + +## -property-value +Handle to uniquely identify GATT-based service attributes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_close_811482585.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_close_811482585.md index 6473a3eb41..47173afe3b 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_close_811482585.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Close --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Close ## -description Releases the resources associated with the GattDeviceService class. This allows other apps to access the resources of the GattDeviceService in question. A GattDeviceService object should not be used after Close is invoked, instead a new GattDeviceService object should be instantiated using the FromIdAsync method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Close + +## -description +Releases the resources associated with the GattDeviceService class. This allows other apps to access the resources of the GattDeviceService in question. A GattDeviceService object should not be used after Close is invoked, instead a new GattDeviceService object should be instantiated using the FromIdAsync method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_convertshortidtouuid_998320409.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_convertshortidtouuid_998320409.md index 4fd2f7b01a..a539c1878a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_convertshortidtouuid_998320409.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_convertshortidtouuid_998320409.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ConvertShortIdToUuid(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ConvertShortIdToUuid ## -description Converts a Bluetooth SIG defined short Id to a full GATT UUID. ## -parameters ### -param shortId A 16-bit Bluetooth GATT Service UUID. ## -returns The corresponding 128-bit GATT Service UUID, that uniquely identifies this service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ConvertShortIdToUuid(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ConvertShortIdToUuid + +## -description +Converts a Bluetooth SIG defined short Id to a full GATT UUID. + +## -parameters +### -param shortId +A 16-bit Bluetooth GATT Service UUID. + +## -returns +The corresponding 128-bit GATT Service UUID, that uniquely identifies this service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_device.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_device.md index cbf3a83369..9c5a5d1264 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_device.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_device.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Device --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Device ## -description Gets the [BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md) object describing the device associated with the current [GattDeviceService](gattdeviceservice.md) object. ## -property-value The [BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md) object describing the device associated with the current [GattDeviceService](gattdeviceservice.md) object. ## -remarks ## -examples ## -see-also [BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Device +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Device + +## -description +Gets the [BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md) object describing the device associated with the current [GattDeviceService](gattdeviceservice.md) object. + +## -property-value +The [BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md) object describing the device associated with the current [GattDeviceService](gattdeviceservice.md) object. + +## -remarks + +## -examples + +## -see-also +[BluetoothLEDevice](../windows.devices.bluetooth/bluetoothledevice.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceid.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceid.md index 0184779eb2..e67af2b40a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.DeviceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.DeviceId ## -description Get the string that represents the GATT service instance path used to instantiate the GattDeviceService. ## -property-value String that represents the GATT service instance path used to instantiate the GattDeviceService. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.DeviceId + +## -description +Get the string that represents the GATT service instance path used to instantiate the GattDeviceService. + +## -property-value +String that represents the GATT service instance path used to instantiate the GattDeviceService. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_1322863552.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_1322863552.md index 93cc982832..df09058e0e 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_1322863552.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_1322863552.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.FromIdAsync ## -description Instantiates a new GattDeviceService from the device ID. ## -parameters ### -param deviceId The GATT device ID. ## -returns The object for managing the asynchronous operation, which, upon completion, returns the newly instantiated GattDeviceService. ## -remarks The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread. If a store app has not declared the right capabilities or the user does not grant consent, the method returns a null object. For Windows 10Universal Windows Platform (UWP) apps, use the **bluetooth** capability. For more info see [App capability declarations](http://aka.ms/appcap).For Windows 8.x store apps, see [How to specify device capabilities for Bluetooth (Windows)](XREF:TODO:AppxManifestSchema.how_to_specify_device_capabilities_for_bluetooth) to declare the right capabilities. ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.FromIdAsync + +## -description +Instantiates a new GattDeviceService from the device ID. + +## -parameters +### -param deviceId +The GATT device ID. + +## -returns +The object for managing the asynchronous operation, which, upon completion, returns the newly instantiated GattDeviceService. + +## -remarks +The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread. + +If a store app has not declared the right capabilities or the user does not grant consent, the method returns a null object. + + +For Windows 10Universal Windows Platform (UWP) apps, use the **bluetooth** capability. For more info see [App capability declarations](http://aka.ms/appcap).For Windows 8.x store apps, see [How to specify device capabilities for Bluetooth (Windows)](XREF:TODO:AppxManifestSchema.how_to_specify_device_capabilities_for_bluetooth) to declare the right capabilities. + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallcharacteristics_28361943.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallcharacteristics_28361943.md index b1893196b8..2bc37fce5c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallcharacteristics_28361943.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallcharacteristics_28361943.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllCharacteristics --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllCharacteristics ## -description Gets the collection of all characteristics belonging to this GattDeviceService instance. ## -returns The collection of all characteristics belonging to this GattDeviceService instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllCharacteristics +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllCharacteristics + +## -description +Gets the collection of all characteristics belonging to this GattDeviceService instance. + +## -returns +The collection of all characteristics belonging to this GattDeviceService instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallincludedservices_1439635648.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallincludedservices_1439635648.md index 919156b586..475150f8f9 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallincludedservices_1439635648.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getallincludedservices_1439635648.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllIncludedServices --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllIncludedServices ## -description Gets the collection of all included services belonging to this GattDeviceService instance. ## -returns The collection of all included services belonging to this GattDeviceService instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllIncludedServices +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetAllIncludedServices + +## -description +Gets the collection of all included services belonging to this GattDeviceService instance. + +## -returns +The collection of all included services belonging to this GattDeviceService instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristics_1478897314.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristics_1478897314.md index f51a5d9364..2e0b20e64d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristics_1478897314.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristics_1478897314.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristics(System.Guid) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristics ## -description Returns a vector of characteristics, that are identified by the specified UUID and belong to this GattDeviceService instance. ## -parameters ### -param characteristicUuid The UUID for the characteristics to be retrieved. ## -returns A vector of GattCharacteristic objects whose UUIDs match characteristicUuid. ## -remarks Only a single app can access a single service. If one app has registered a GATT notification trigger, this method will throw an exception for all other apps that sub subsequently call this API. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristics(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristics + +## -description +Returns a vector of characteristics, that are identified by the specified UUID and belong to this GattDeviceService instance. + +## -parameters +### -param characteristicUuid +The UUID for the characteristics to be retrieved. + +## -returns +A vector of GattCharacteristic objects whose UUIDs match characteristicUuid. + +## -remarks +Only a single app can access a single service. If one app has registered a GATT notification trigger, this method will throw an exception for all other apps that sub subsequently call this API. + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromshortid_783818200.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromshortid_783818200.md index 753cb3d545..7fd5492727 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromshortid_783818200.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromshortid_783818200.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromShortId(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromShortId ## -description Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a 16-bit Bluetooth GATT Service UUID. ## -parameters ### -param serviceShortId A 16-bit Bluetooth GATT Service UUID. ## -returns A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromShortId(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromShortId + +## -description +Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a 16-bit Bluetooth GATT Service UUID. + +## -parameters +### -param serviceShortId +A 16-bit Bluetooth GATT Service UUID. + +## -returns +A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromuuid_26757927.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromuuid_26757927.md index 116598b3d2..8c04d8ee41 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromuuid_26757927.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorfromuuid_26757927.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromUuid(System.Guid) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromUuid ## -description Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a Bluetooth service UUID. ## -parameters ### -param serviceUuid A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. ## -returns A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromUuid(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorFromUuid + +## -description +Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a Bluetooth service UUID. + +## -parameters +### -param serviceUuid +A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. + +## -returns +A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservices_72848473.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservices_72848473.md index 6b3ace3b3e..eed0f0a237 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservices_72848473.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservices_72848473.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServices(System.Guid) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServices ## -description Returns a vector of included services, that are identified by the specified UUID and belong to this GattDeviceService instance. ## -parameters ### -param serviceUuid The UUID for the included services to be retrieved. ## -returns A vector of included services whose UUIDs match serviceUuid. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServices(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServices + +## -description +Returns a vector of included services, that are identified by the specified UUID and belong to this GattDeviceService instance. + +## -parameters +### -param serviceUuid +The UUID for the included services to be retrieved. + +## -returns +A vector of included services whose UUIDs match serviceUuid. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_parentservices.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_parentservices.md index 87121ea02a..15f8fe1fb6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_parentservices.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_parentservices.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ParentServices --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ParentServices ## -description Gets the read-only list of parent services for this service. ## -property-value A read-only list of parent services from which this object is derived, if this GattDeviceService is an included service; Otherwise, null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ParentServices +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.ParentServices + +## -description +Gets the read-only list of parent services for this service. + +## -property-value +A read-only list of parent services from which this object is derived, if this GattDeviceService is an included service; Otherwise, null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_uuid.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_uuid.md index 53c67d5834..5413183e82 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_uuid.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_uuid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Uuid --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Uuid ## -description The GATT Service UUID associated with this GattDeviceService. ## -property-value **A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.** ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Uuid + +## -description +The GATT Service UUID associated with this GattDeviceService. + +## -property-value + + **A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.** + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat.md index 5efc7688e1..2b95387a7c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat ## -description Represents the value of a single Presentation Format GATT Descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat + +## -description +Represents the value of a single Presentation Format GATT Descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_bluetoothsigassignednumbers.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_bluetoothsigassignednumbers.md index 1d16a9018d..d9b407ad11 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_bluetoothsigassignednumbers.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_bluetoothsigassignednumbers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.BluetoothSigAssignedNumbers --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.BluetoothSigAssignedNumbers ## -description Gets the value of the Bluetooth SIG Assigned Numbers Namespace. ## -property-value The value of the Bluetooth SIG Assigned Numbers Namespace. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.BluetoothSigAssignedNumbers +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.BluetoothSigAssignedNumbers + +## -description +Gets the value of the Bluetooth SIG Assigned Numbers Namespace. + +## -property-value +The value of the Bluetooth SIG Assigned Numbers Namespace. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_description.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_description.md index cc6e8dbed3..af49a62241 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_description.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Description --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Description ## -description Gets the Description of the GattPresentationFormat object. ## -property-value The Description of the GattPresentationFormat object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Description +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Description + +## -description +Gets the Description of the GattPresentationFormat object. + +## -property-value +The Description of the GattPresentationFormat object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_exponent.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_exponent.md index 01b1d02304..eb01f1f886 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_exponent.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_exponent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Exponent --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Exponent ## -description Gets the Exponent of the GattPresentationFormat object. ## -property-value The Exponent of the GattPresentationFormat object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Exponent +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Exponent + +## -description +Gets the Exponent of the GattPresentationFormat object. + +## -property-value +The Exponent of the GattPresentationFormat object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_formattype.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_formattype.md index 4c08f66d2d..9378d37912 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_formattype.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_formattype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.FormatType --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.FormatType ## -description Gets the Format Type of the GattPresentationFormat object. ## -property-value The Format Type of the GattPresentationFormat object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.FormatType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.FormatType + +## -description +Gets the Format Type of the GattPresentationFormat object. + +## -property-value +The Format Type of the GattPresentationFormat object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_namespace.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_namespace.md index 1b220d1ac3..c1208bc267 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_namespace.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_namespace.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Namespace --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Namespace ## -description Gets the Namespace of the GattPresentationFormat object. ## -property-value The Namespace of the GattPresentationFormat object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Namespace +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Namespace + +## -description +Gets the Namespace of the GattPresentationFormat object. + +## -property-value +The Namespace of the GattPresentationFormat object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_unit.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_unit.md index ba53087837..5f67962ae9 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_unit.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_unit.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Unit --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Unit ## -description Gets the Unit of the GattPresentationFormat object. ## -property-value The Unit of the GattPresentationFormat object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Unit +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.Unit + +## -description +Gets the Unit of the GattPresentationFormat object. + +## -property-value +The Unit of the GattPresentationFormat object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes.md index 4ca65bf3e8..79fa5086a6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes ## -description Represents the different well-known values that the GattPresentationFormat.FormatType property can take. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes + +## -description +Represents the different well-known values that the GattPresentationFormat.FormatType property can take. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_bit2.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_bit2.md index f614db470a..4b9bb4117b 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_bit2.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_bit2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Bit2 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Bit2 ## -description Gets the value of the Bit2 Format Type. ## -property-value The value of the Bit2 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Bit2 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Bit2 + +## -description +Gets the value of the Bit2 Format Type. + +## -property-value +The value of the Bit2 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_boolean.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_boolean.md index aa6751ae16..1e56541e3a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_boolean.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_boolean.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Boolean --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Boolean ## -description Gets the value of the Boolean Format Type. ## -property-value The value of the Boolean Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Boolean +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Boolean + +## -description +Gets the value of the Boolean Format Type. + +## -property-value +The value of the Boolean Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_duint16.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_duint16.md index 3b047f26bb..db1eb3b76f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_duint16.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_duint16.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.DUInt16 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.DUInt16 ## -description Gets the value of the DUInt16 Format Type. ## -property-value The value of the DUInt16 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.DUInt16 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.DUInt16 + +## -description +Gets the value of the DUInt16 Format Type. + +## -property-value +The value of the DUInt16 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float.md index 8ec0655c38..6a35711af1 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float ## -description Gets the value of the Float Format Type. ## -property-value The value of the Float Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float + +## -description +Gets the value of the Float Format Type. + +## -property-value +The value of the Float Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float32.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float32.md index f0bacc1b1c..f20a374b00 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float32.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float32.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float32 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float32 ## -description Gets the value of the Float32 Format Type. ## -property-value The value of the Float32 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float32 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float32 + +## -description +Gets the value of the Float32 Format Type. + +## -property-value +The value of the Float32 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float64.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float64.md index 5a131ddfff..50f138b847 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float64.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_float64.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float64 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float64 ## -description Gets the value of the Float64 Format Type. ## -property-value The value of the Float64 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float64 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Float64 + +## -description +Gets the value of the Float64 Format Type. + +## -property-value +The value of the Float64 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_nibble.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_nibble.md index caf0a86c41..2be6673091 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_nibble.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_nibble.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Nibble --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Nibble ## -description Gets the value of the Nibble Format Type. ## -property-value The value of the Nibble Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Nibble +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Nibble + +## -description +Gets the value of the Nibble Format Type. + +## -property-value +The value of the Nibble Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sfloat.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sfloat.md index 4ee44de279..665369913c 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sfloat.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sfloat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SFloat --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SFloat ## -description Gets the value of the SFloat Format Type. ## -property-value The value of the SFloat Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SFloat +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SFloat + +## -description +Gets the value of the SFloat Format Type. + +## -property-value +The value of the SFloat Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint12.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint12.md index 5b0bb3c35d..42fa30e4a1 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint12.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint12.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt12 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt12 ## -description Gets the value of the SInt12 Format Type. ## -property-value The value of the SInt12 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt12 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt12 + +## -description +Gets the value of the SInt12 Format Type. + +## -property-value +The value of the SInt12 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint128.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint128.md index f1e0c5fa95..fd437b068d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint128.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint128.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt128 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt128 ## -description Gets the value of the SInt128 Format Type. ## -property-value The value of the SInt128 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt128 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt128 + +## -description +Gets the value of the SInt128 Format Type. + +## -property-value +The value of the SInt128 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint16.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint16.md index ed078dc031..7223567d66 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint16.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint16.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt16 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt16 ## -description Gets the value of the SInt16 Format Type. ## -property-value The value of the SInt16 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt16 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt16 + +## -description +Gets the value of the SInt16 Format Type. + +## -property-value +The value of the SInt16 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint24.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint24.md index a03ef657be..409ac83551 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint24.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint24.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt24 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt24 ## -description Gets the value of the SInt24 Format Type. ## -property-value The value of the SInt24 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt24 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt24 + +## -description +Gets the value of the SInt24 Format Type. + +## -property-value +The value of the SInt24 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint32.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint32.md index fed86ee27c..782a98f3a4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint32.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint32.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt32 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt32 ## -description Gets the value of the SInt32 Format Type. ## -property-value The value of the SInt32 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt32 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt32 + +## -description +Gets the value of the SInt32 Format Type. + +## -property-value +The value of the SInt32 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint48.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint48.md index a30a02fbb6..123e22ae27 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint48.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint48.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt48 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt48 ## -description Gets the value of the SInt48 Format Type. ## -property-value The value of the SInt48 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt48 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt48 + +## -description +Gets the value of the SInt48 Format Type. + +## -property-value +The value of the SInt48 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint64.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint64.md index 74313bf39a..71e3eeaa2f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint64.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint64.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt64 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt64 ## -description Gets the value of the SInt64 Format Type. ## -property-value The value of the SInt64 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt64 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt64 + +## -description +Gets the value of the SInt64 Format Type. + +## -property-value +The value of the SInt64 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint8.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint8.md index 06aeaa10ea..48df182a08 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint8.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_sint8.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt8 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt8 ## -description Gets the value of the SInt8 Format Type. ## -property-value The value of the SInt8 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt8 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.SInt8 + +## -description +Gets the value of the SInt8 Format Type. + +## -property-value +The value of the SInt8 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_struct.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_struct.md index 0943692205..8fa74b34b6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_struct.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_struct.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Struct --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Struct ## -description Gets the value of the Struct Format Type. ## -property-value The value of the Struct Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Struct +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Struct + +## -description +Gets the value of the Struct Format Type. + +## -property-value +The value of the Struct Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint12.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint12.md index c624f57cd3..f7e2a8d4f8 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint12.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint12.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt12 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt12 ## -description Gets the value of the UInt12 Format Type. ## -property-value The value of the UInt12 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt12 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt12 + +## -description +Gets the value of the UInt12 Format Type. + +## -property-value +The value of the UInt12 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint128.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint128.md index c2f3577ae5..0178baabc4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint128.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint128.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt128 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt128 ## -description Gets the value of the UInt128 Format Type. ## -property-value The value of the UInt128 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt128 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt128 + +## -description +Gets the value of the UInt128 Format Type. + +## -property-value +The value of the UInt128 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint16.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint16.md index be26c683ea..b3ec7ee702 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint16.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint16.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt16 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt16 ## -description Gets the value of the UInt16 Format Type. ## -property-value The value of the UInt16 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt16 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt16 + +## -description +Gets the value of the UInt16 Format Type. + +## -property-value +The value of the UInt16 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint24.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint24.md index 64a350c814..51c00a1161 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint24.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint24.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt24 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt24 ## -description Gets the value of the UInt24 Format Type. ## -property-value The value of the UInt24 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt24 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt24 + +## -description +Gets the value of the UInt24 Format Type. + +## -property-value +The value of the UInt24 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint32.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint32.md index ab5f678a62..8c3c4eeb5f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint32.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint32.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt32 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt32 ## -description Gets the value of the UInt32 Format Type. ## -property-value The value of the UInt32 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt32 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt32 + +## -description +Gets the value of the UInt32 Format Type. + +## -property-value +The value of the UInt32 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint48.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint48.md index ea085795c5..5d2a15b115 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint48.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint48.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt48 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt48 ## -description Gets the value of the UInt48 Format Type. ## -property-value The value of the UInt48 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt48 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt48 + +## -description +Gets the value of the UInt48 Format Type. + +## -property-value +The value of the UInt48 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint64.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint64.md index 5a6a1862ed..dd80a7a52b 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint64.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint64.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt64 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt64 ## -description Gets the value of the UInt64 Format Type. ## -property-value The value of the UInt64 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt64 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt64 + +## -description +Gets the value of the UInt64 Format Type. + +## -property-value +The value of the UInt64 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint8.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint8.md index f4a86ae49d..56d9f9aabe 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint8.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_uint8.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt8 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt8 ## -description Gets the value of the UInt8 Format Type. ## -property-value The value of the UInt8 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt8 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.UInt8 + +## -description +Gets the value of the UInt8 Format Type. + +## -property-value +The value of the UInt8 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf16.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf16.md index d65f2d32f9..4a9f5a1ba0 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf16.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf16.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf16 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf16 ## -description Gets the value of the Utf16 Format Type. ## -property-value The value of the Utf16 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf16 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf16 + +## -description +Gets the value of the Utf16 Format Type. + +## -property-value +The value of the Utf16 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf8.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf8.md index 90c26474db..63459ffd80 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf8.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformattypes_utf8.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf8 --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf8 ## -description Gets the value of the Utf8 Format Type. ## -property-value The value of the Utf8 Format Type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf8 +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormatTypes.Utf8 + +## -description +Gets the value of the Utf8 Format Type. + +## -property-value +The value of the Utf8 Format Type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult.md b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult.md index a74d1f2891..3ad35756b6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult ## -description Represents the result of reading a GATT Client CharacteristicConfigurationClientDescriptor value. ## -remarks The [ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md) method is used to retrieve a [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md) object. The [Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) property on the [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md) returned indicates if the result of the operation was successful. ## -examples ## -see-also [ClientCharacteristicConfigurationDescriptor](gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md), [GattCharacteristic](gattcharacteristic.md), [ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md), [Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult + +## -description +Represents the result of reading a GATT Client CharacteristicConfigurationClientDescriptor value. + +## -remarks +The [ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md) method is used to retrieve a [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md) object. + +The [Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) property on the [GattReadClientCharacteristicConfigurationDescriptorResult](gattreadclientcharacteristicconfigurationdescriptorresult.md) returned indicates if the result of the operation was successful. + +## -examples + +## -see-also +[ClientCharacteristicConfigurationDescriptor](gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md), [GattCharacteristic](gattcharacteristic.md), [ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md), [Status](gattreadclientcharacteristicconfigurationdescriptorresult_status.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md index 24a2824519..e826bc3b3f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_clientcharacteristicconfigurationdescriptor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.ClientCharacteristicConfigurationDescriptor --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.ClientCharacteristicConfigurationDescriptor ## -description Gets the result of an asynchronous read operation. ## -property-value The result of the asynchronous read operation. ## -remarks ## -examples ## -see-also [ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.ClientCharacteristicConfigurationDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.ClientCharacteristicConfigurationDescriptor + +## -description +Gets the result of an asynchronous read operation. + +## -property-value +The result of the asynchronous read operation. + +## -remarks + +## -examples + +## -see-also +[ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_status.md index 750a9573bd..7d687f25c2 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_status.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.Status --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.Status ## -description Gets the status of an asynchronous operation. ## -property-value The status of the asynchronous operation. ## -remarks ## -examples ## -see-also [ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.Status + +## -description +Gets the status of an asynchronous operation. + +## -property-value +The status of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[ReadClientCharacteristicConfigurationDescriptorAsync](gattcharacteristic_readclientcharacteristicconfigurationdescriptorasync.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadresult.md b/windows.devices.bluetooth.genericattributeprofile/gattreadresult.md index 549164087b..9ec4990d82 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreadresult.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadresult.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult ## -description Represents the result of an asynchronous read operation of a GATT Characteristic or Descriptor value. ## -remarks One of the [ReadValueAsync](gattcharacteristic_readvalueasync.md) methods is used to retrieve a [GattReadResult](gattreadresult.md) object. The [Status](gattreadresult_status.md) property on the [GattReadResult](gattreadresult.md) returned indicates if the result of the operation was successful. ## -examples ## -see-also [ReadValueAsync](gattcharacteristic_readvalueasync.md), [Status](gattreadresult_status.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult + +## -description +Represents the result of an asynchronous read operation of a GATT Characteristic or Descriptor value. + +## -remarks +One of the [ReadValueAsync](gattcharacteristic_readvalueasync.md) methods is used to retrieve a [GattReadResult](gattreadresult.md) object. + +The [Status](gattreadresult_status.md) property on the [GattReadResult](gattreadresult.md) returned indicates if the result of the operation was successful. + +## -examples + +## -see-also +[ReadValueAsync](gattcharacteristic_readvalueasync.md), [Status](gattreadresult_status.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattreadresult_status.md index 11e0585ad7..fe473d3673 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreadresult_status.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadresult_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Status --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Status ## -description Gets the status of an asynchronous operation. ## -property-value The status of the asynchronous operation. ## -remarks ## -examples ## -see-also [ReadValueAsync](gattcharacteristic_readvalueasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Status + +## -description +Gets the status of an asynchronous operation. + +## -property-value +The status of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[ReadValueAsync](gattcharacteristic_readvalueasync.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadresult_value.md b/windows.devices.bluetooth.genericattributeprofile/gattreadresult_value.md index aaba13582a..6a7f5de158 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreadresult_value.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadresult_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Value --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Value ## -description Gets the value read from the device. ## -property-value The value read from the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Value +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.Value + +## -description +Gets the value read from the device. + +## -property-value +The value read from the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction.md b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction.md index 9e6263cabb..219354632a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction ## -description Performs GATT reliable writes on the Bluetooth LE device, in the form of a transaction write operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction + +## -description +Performs GATT reliable writes on the Bluetooth LE device, in the form of a transaction write operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitasync_1433804794.md b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitasync_1433804794.md index c05c1632c1..f22c43a46d 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitasync_1433804794.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitasync_1433804794.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.CommitAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.CommitAsync ## -description Performs all the queued writes, in sequence, writing the data to the device. Once a transaction object has been committed, no further operations are possible on the GattReliableWriteTransaction object. ## -returns The object used to manage the asynchronous operation, which, upon completion, will return the status of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.CommitAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.CommitAsync + +## -description +Performs all the queued writes, in sequence, writing the data to the device. Once a transaction object has been committed, no further operations are possible on the GattReliableWriteTransaction object. + +## -returns +The object used to manage the asynchronous operation, which, upon completion, will return the status of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_gattreliablewritetransaction_1221375020.md b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_gattreliablewritetransaction_1221375020.md index 237e9d67a8..100594db83 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_gattreliablewritetransaction_1221375020.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_gattreliablewritetransaction_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.GattReliableWriteTransaction ## -description Creates a new GattReliableWriteTransaction object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.GattReliableWriteTransaction + +## -description +Creates a new GattReliableWriteTransaction object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_writevalue_2051134409.md b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_writevalue_2051134409.md index c17fb2efc8..96c2d268ba 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_writevalue_2051134409.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_writevalue_2051134409.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.WriteValue(Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.WriteValue ## -description Adds a new write operation to the transaction object. ## -parameters ### -param characteristic The GattCharacteristic object on which to perform the write operation. ### -param value The Characteristic Value to be written to characteristic. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.WriteValue(Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.WriteValue + +## -description +Adds a new write operation to the transaction object. + +## -parameters +### -param characteristic +The GattCharacteristic object on which to perform the write operation. + +### -param value +The Characteristic Value to be written to characteristic. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids.md index ff64da377b..bfd72704a1 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids ## -description Represents an enumeration of the most well known Service UUID values, and provides convenience methods for working with GATT service UUIDs, and static properties providing service UUIDs for common GATT services. To view a list of all Bluetooth SIG-defined service UUIDs, see [Bluetooth SIG-defined Service UUIDs](http://go.microsoft.com/fwlink/p/?LinkId=391801). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids + +## -description +Represents an enumeration of the most well known Service UUID values, and provides convenience methods for working with GATT service UUIDs, and static properties providing service UUIDs for common GATT services. To view a list of all Bluetooth SIG-defined service UUIDs, see [Bluetooth SIG-defined Service UUIDs](http://go.microsoft.com/fwlink/p/?LinkId=391801). + + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_alertnotification.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_alertnotification.md index bd6bdd4b85..748751f741 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_alertnotification.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_alertnotification.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.AlertNotification --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.AlertNotification ## -description Gets the Bluetooth SIG-defined AlertNotification Service UUID. ## -property-value The Bluetooth SIG-defined AlertNotification Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.AlertNotification +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.AlertNotification + +## -description +Gets the Bluetooth SIG-defined AlertNotification Service UUID. + +## -property-value +The Bluetooth SIG-defined AlertNotification Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_battery.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_battery.md index f26e6d2869..8866ea3705 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_battery.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_battery.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Battery --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Battery ## -description Gets the Bluetooth SIG-defined Battery Service UUID. ## -property-value The Bluetooth SIG-defined Battery Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Battery +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Battery + +## -description +Gets the Bluetooth SIG-defined Battery Service UUID. + +## -property-value +The Bluetooth SIG-defined Battery Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_bloodpressure.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_bloodpressure.md index b1555922ef..3e338cbed4 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_bloodpressure.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_bloodpressure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.BloodPressure --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.BloodPressure ## -description Gets the Bluetooth SIG-defined Blood Pressure Service UUID. ## -property-value The Bluetooth SIG-defined Blood Pressure Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.BloodPressure +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.BloodPressure + +## -description +Gets the Bluetooth SIG-defined Blood Pressure Service UUID. + +## -property-value +The Bluetooth SIG-defined Blood Pressure Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_currenttime.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_currenttime.md index 543e71f39f..380349dc36 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_currenttime.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_currenttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CurrentTime --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CurrentTime ## -description Gets the Bluetooth SIG-defined CurrentTime service UUID. ## -property-value The Bluetooth SIG-defined CurrentTime service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CurrentTime +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CurrentTime + +## -description +Gets the Bluetooth SIG-defined CurrentTime service UUID. + +## -property-value +The Bluetooth SIG-defined CurrentTime service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingpower.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingpower.md index ba604d6076..32ad90a733 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingpower.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingpower.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingPower --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingPower ## -description Gets the Bluetooth SIG-defined CyclingPower service UUID. ## -property-value The Bluetooth SIG-defined CyclingPower service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingPower +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingPower + +## -description +Gets the Bluetooth SIG-defined CyclingPower service UUID. + +## -property-value +The Bluetooth SIG-defined CyclingPower service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingspeedandcadence.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingspeedandcadence.md index 15af1cc478..3ee7a32838 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingspeedandcadence.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_cyclingspeedandcadence.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingSpeedAndCadence --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingSpeedAndCadence ## -description Gets the Bluetooth SIG-defined Cycling Speed And Cadence Service UUID. ## -property-value The Bluetooth SIG-defined Cycling Speed And Cadence Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingSpeedAndCadence +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.CyclingSpeedAndCadence + +## -description +Gets the Bluetooth SIG-defined Cycling Speed And Cadence Service UUID. + +## -property-value +The Bluetooth SIG-defined Cycling Speed And Cadence Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_deviceinformation.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_deviceinformation.md index 13a9b90507..f981a5f964 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_deviceinformation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.DeviceInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.DeviceInformation ## -description Gets the Bluetooth SIG-defined DeviceInformation service UUID. ## -property-value The Bluetooth SIG-defined DeviceInformation UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.DeviceInformation + +## -description +Gets the Bluetooth SIG-defined DeviceInformation service UUID. + +## -property-value +The Bluetooth SIG-defined DeviceInformation UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericaccess.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericaccess.md index fd6b716a70..962e3c211a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericaccess.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericaccess.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAccess --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAccess ## -description Gets the Bluetooth SIG-defined UUID for the Generic Access Service. ## -property-value The Bluetooth SIG-defined UUID for the Generic Access Service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAccess +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAccess + +## -description +Gets the Bluetooth SIG-defined UUID for the Generic Access Service. + +## -property-value +The Bluetooth SIG-defined UUID for the Generic Access Service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericattribute.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericattribute.md index 01696aaa41..233be2804f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericattribute.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_genericattribute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAttribute --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAttribute ## -description Gets the Bluetooth SIG-defined UUID for the Generic Attribute Service. ## -property-value The Bluetooth SIG-defined UUID for the Generic Attribute Service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAttribute +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.GenericAttribute + +## -description +Gets the Bluetooth SIG-defined UUID for the Generic Attribute Service. + +## -property-value +The Bluetooth SIG-defined UUID for the Generic Attribute Service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_glucose.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_glucose.md index f93f1e51cd..c6ca2f038a 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_glucose.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_glucose.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Glucose --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Glucose ## -description Gets the Bluetooth SIG-defined Glucose Service UUID. ## -property-value The Bluetooth SIG-defined Glucose Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Glucose +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.Glucose + +## -description +Gets the Bluetooth SIG-defined Glucose Service UUID. + +## -property-value +The Bluetooth SIG-defined Glucose Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_healththermometer.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_healththermometer.md index ca0eede245..44d922007f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_healththermometer.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_healththermometer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HealthThermometer --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HealthThermometer ## -description Gets the Bluetooth SIG-defined Health Thermometer Service UUID. ## -property-value The Bluetooth SIG-defined Health Thermometer Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HealthThermometer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HealthThermometer + +## -description +Gets the Bluetooth SIG-defined Health Thermometer Service UUID. + +## -property-value +The Bluetooth SIG-defined Health Thermometer Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_heartrate.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_heartrate.md index 8ba33bfb6c..40de9b3b9e 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_heartrate.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_heartrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HeartRate --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HeartRate ## -description Gets the Bluetooth SIG-defined Heart Rate Service UUID. ## -property-value The Bluetooth SIG-defined Heart Rate Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HeartRate +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HeartRate + +## -description +Gets the Bluetooth SIG-defined Heart Rate Service UUID. + +## -property-value +The Bluetooth SIG-defined Heart Rate Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_humaninterfacedevice.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_humaninterfacedevice.md index 584c6d46e5..9cdd8d8c42 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_humaninterfacedevice.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_humaninterfacedevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HumanInterfaceDevice --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HumanInterfaceDevice ## -description Gets the Bluetooth SIG-defined HumanInterfaceDevice service UUID. ## -property-value The Bluetooth SIG-defined HumanInterfaceDevice service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HumanInterfaceDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.HumanInterfaceDevice + +## -description +Gets the Bluetooth SIG-defined HumanInterfaceDevice service UUID. + +## -property-value +The Bluetooth SIG-defined HumanInterfaceDevice service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_immediatealert.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_immediatealert.md index 262cca1a36..c82b7110af 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_immediatealert.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_immediatealert.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ImmediateAlert --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ImmediateAlert ## -description Gets the Bluetooth SIG-defined ImmediateAlert service UUID. ## -property-value The Bluetooth SIG-defined ImmediateAlert service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ImmediateAlert +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ImmediateAlert + +## -description +Gets the Bluetooth SIG-defined ImmediateAlert service UUID. + +## -property-value +The Bluetooth SIG-defined ImmediateAlert service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_linkloss.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_linkloss.md index 205916feb3..d0ae03b0ea 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_linkloss.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_linkloss.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LinkLoss --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LinkLoss ## -description Gets the Bluetooth SIG-defined LinkLoss service UUID. ## -property-value The Bluetooth SIG-defined LinkLoss service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LinkLoss +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LinkLoss + +## -description +Gets the Bluetooth SIG-defined LinkLoss service UUID. + +## -property-value +The Bluetooth SIG-defined LinkLoss service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_locationandnavigation.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_locationandnavigation.md index a9854addf6..59d3ad0dfb 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_locationandnavigation.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_locationandnavigation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LocationAndNavigation --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LocationAndNavigation ## -description Gets the Bluetooth SIG-defined LocationAndNavigation service UUID. ## -property-value The Bluetooth SIG-defined LocationAndNavigation service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LocationAndNavigation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.LocationAndNavigation + +## -description +Gets the Bluetooth SIG-defined LocationAndNavigation service UUID. + +## -property-value +The Bluetooth SIG-defined LocationAndNavigation service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_nextdstchange.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_nextdstchange.md index 0fbcee790d..e50f743db3 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_nextdstchange.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_nextdstchange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.NextDstChange --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.NextDstChange ## -description Gets the Bluetooth SIG-defined NextDstChange service UUID. ## -property-value The Bluetooth SIG-defined NextDstChange service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.NextDstChange +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.NextDstChange + +## -description +Gets the Bluetooth SIG-defined NextDstChange service UUID. + +## -property-value +The Bluetooth SIG-defined NextDstChange service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_phonealertstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_phonealertstatus.md index 16738acaff..eeb6d3a243 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_phonealertstatus.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_phonealertstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.PhoneAlertStatus --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.PhoneAlertStatus ## -description Gets the Bluetooth SIG-defined PhoneAlertStatus service UUID. ## -property-value The Bluetooth SIG-defined PhoneAlertStatus service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.PhoneAlertStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.PhoneAlertStatus + +## -description +Gets the Bluetooth SIG-defined PhoneAlertStatus service UUID. + +## -property-value +The Bluetooth SIG-defined PhoneAlertStatus service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_referencetimeupdate.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_referencetimeupdate.md index d3d55bef3c..b0da743864 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_referencetimeupdate.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_referencetimeupdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ReferenceTimeUpdate --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ReferenceTimeUpdate ## -description Gets the Bluetooth SIG-defined ReferenceTimeUpdate service UUID. ## -property-value The Bluetooth SIG-defined ReferenceTimeUpdate service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ReferenceTimeUpdate +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ReferenceTimeUpdate + +## -description +Gets the Bluetooth SIG-defined ReferenceTimeUpdate service UUID. + +## -property-value +The Bluetooth SIG-defined ReferenceTimeUpdate service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_runningspeedandcadence.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_runningspeedandcadence.md index 99fd7475b9..ba3b11db6f 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_runningspeedandcadence.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_runningspeedandcadence.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.RunningSpeedAndCadence --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.RunningSpeedAndCadence ## -description Gets the Bluetooth SIG-defined Running Speed And Cadence Service UUID. ## -property-value The Bluetooth SIG-defined Running Speed And Cadence Service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.RunningSpeedAndCadence +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.RunningSpeedAndCadence + +## -description +Gets the Bluetooth SIG-defined Running Speed And Cadence Service UUID. + +## -property-value +The Bluetooth SIG-defined Running Speed And Cadence Service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_scanparameters.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_scanparameters.md index 394ad1d751..a753a5d8b6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_scanparameters.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_scanparameters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ScanParameters --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ScanParameters ## -description Gets the Bluetooth SIG-defined ScanParameters service UUID. ## -property-value The Bluetooth SIG-defined ScanParameters service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ScanParameters +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.ScanParameters + +## -description +Gets the Bluetooth SIG-defined ScanParameters service UUID. + +## -property-value +The Bluetooth SIG-defined ScanParameters service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_txpower.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_txpower.md index 7b98542def..b314ef551e 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_txpower.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceuuids_txpower.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.TxPower --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.TxPower ## -description Gets the Bluetooth SIG-defined TxPower service UUID. ## -property-value The Bluetooth SIG-defined TxPower service UUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.TxPower +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceUuids.TxPower + +## -description +Gets the Bluetooth SIG-defined TxPower service UUID. + +## -property-value +The Bluetooth SIG-defined TxPower service UUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs.md b/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs.md index 1d0d1e12b1..66b379782b 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs ## -description Represents the arguments received by a [GattCharacteristic.ValueChanged](gattcharacteristic_valuechanged.md) event handler used to process characteristic value change notification and indication events sent by a Bluetooth LE device. ## -remarks ## -examples ## -see-also [GattCharacteristic.ValueChanged](gattcharacteristic_valuechanged.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs + +## -description +Represents the arguments received by a [GattCharacteristic.ValueChanged](gattcharacteristic_valuechanged.md) event handler used to process characteristic value change notification and indication events sent by a Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also +[GattCharacteristic.ValueChanged](gattcharacteristic_valuechanged.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_characteristicvalue.md b/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_characteristicvalue.md index e6b0c879bc..7aef2be706 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_characteristicvalue.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_characteristicvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.CharacteristicValue --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.CharacteristicValue ## -description Gets the new Characteristic Value. ## -property-value The new Characteristic Value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.CharacteristicValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.CharacteristicValue + +## -description +Gets the new Characteristic Value. + +## -property-value +The new Characteristic Value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_timestamp.md b/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_timestamp.md index 1a345c0015..65f4651dc6 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_timestamp.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattvaluechangedeventargs_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.Timestamp --api-type: winrt property ---- # Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.Timestamp ## -description Gets the time at which the system was notified of the Characteristic Value change. ## -property-value The time at which the system was notified of the Characteristic Value change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattValueChangedEventArgs.Timestamp + +## -description +Gets the time at which the system was notified of the Characteristic Value change. + +## -property-value +The time at which the system was notified of the Characteristic Value change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice.md index 788d4326be..bf95b05d71 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService --api-type: winrt class ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService ## -description Represents an instance of a service on a Bluetooth BR device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService + +## -description +Represents an instance of a service on a Bluetooth BR device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_close_811482585.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_close_811482585.md index 8e2ceb58e7..ca490c0388 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_close_811482585.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Close --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Close ## -description Closes the RFCOMM device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Close + +## -description +Closes the RFCOMM device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionhostname.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionhostname.md index 50071f9d32..856305e9d3 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionhostname.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionhostname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionHostName --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionHostName ## -description Gets the connection host name of the RFCOMM service instance, which is used to connect to the remote device. ## -property-value The HostName object of the RFCOMM service instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionHostName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionHostName + +## -description +Gets the connection host name of the RFCOMM service instance, which is used to connect to the remote device. + +## -property-value +The HostName object of the RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionservicename.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionservicename.md index bcffbd830a..32bc41e1a6 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionservicename.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_connectionservicename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionServiceName --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionServiceName ## -description Gets the connection service name of the RFCOMM service instance, which is used to connect to the remote device. ## -property-value The ServiceName object of the RFCOMM service instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionServiceName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ConnectionServiceName + +## -description +Gets the connection service name of the RFCOMM service instance, which is used to connect to the remote device. + +## -property-value +The ServiceName object of the RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_device.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_device.md index 4ced104247..72411d7c2d 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_device.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Device --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Device ## -description Gets the [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object describing the device associated with the current [RfcommDeviceService](rfcommdeviceservice.md) object. ## -property-value The [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object describing the device associated with the current [RfcommDeviceService](rfcommdeviceservice.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Device +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Device + +## -description +Gets the [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object describing the device associated with the current [RfcommDeviceService](rfcommdeviceservice.md) object. + +## -property-value +The [BluetoothDevice](../windows.devices.bluetooth/bluetoothdevice.md) object describing the device associated with the current [RfcommDeviceService](rfcommdeviceservice.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_deviceaccessinformation.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_deviceaccessinformation.md index bcc047b2e9..bde0a8704c 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_deviceaccessinformation.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_deviceaccessinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.DeviceAccessInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.DeviceAccessInformation ## -description The device access information. Used to check and monitor access. ## -property-value Gets the current [DeviceAccessInformation](../windows.devices.enumeration/deviceaccessinformation.md) for the service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.DeviceAccessInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.DeviceAccessInformation + +## -description +The device access information. Used to check and monitor access. + +## -property-value +Gets the current [DeviceAccessInformation](../windows.devices.enumeration/deviceaccessinformation.md) for the service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_fromidasync_1322863552.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_fromidasync_1322863552.md index aca32b156c..41a1b93433 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_fromidasync_1322863552.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_fromidasync_1322863552.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.FromIdAsync ## -description Gets an RfcommDeviceService object from a DeviceInformation Id for an RFCOMM service instance. ## -parameters ### -param deviceId The DeviceInformation Id that identifies the RFCOMM service instance. This id can be retrieved from [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md). ## -returns The RfcommDeviceService object that represents the RFCOMM service instance. ## -remarks The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread. If a store app has not declared the right capabilities or the user does not grant consent, the method returns a null object. + For Universal Windows Platform (UWP) apps, use the **bluetooth** capability. For more info, see [App capability declarations](http://aka.ms/appcap). + For Windows 8.x store apps, see [How to specify device capabilities for Bluetooth (Windows)](XREF:TODO:AppxManifestSchema.how_to_specify_device_capabilities_for_bluetooth) to declare the right capabilities. > [!WARNING] > If the device acting as the RFCOMM server does not have the correct channel registered in its manifest, this method throws an exception when called on the device acting as the RFCOMM client. ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.FromIdAsync + +## -description +Gets an RfcommDeviceService object from a DeviceInformation Id for an RFCOMM service instance. + +## -parameters +### -param deviceId +The DeviceInformation Id that identifies the RFCOMM service instance. This id can be retrieved from [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md). + +## -returns +The RfcommDeviceService object that represents the RFCOMM service instance. + +## -remarks +The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread. + +If a store app has not declared the right capabilities or the user does not grant consent, the method returns a null object. + + ++ For Universal Windows Platform (UWP) apps, use the **bluetooth** capability. For more info, see [App capability declarations](http://aka.ms/appcap). ++ For Windows 8.x store apps, see [How to specify device capabilities for Bluetooth (Windows)](XREF:TODO:AppxManifestSchema.how_to_specify_device_capabilities_for_bluetooth) to declare the right capabilities. + + +> [!WARNING] +> If the device acting as the RFCOMM server does not have the correct channel registered in its manifest, this method throws an exception when called on the device acting as the RFCOMM client. + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselector_1048224564.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselector_1048224564.md index b6103a80a1..4aab7cf7d0 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselector_1048224564.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselector_1048224564.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelector(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string for identifying instances of an RFCOMM service. This string is passed to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. ## -parameters ### -param serviceId The service id for which to query. ## -returns An AQS string for identifying RFCOMM service instances. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelector(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying instances of an RFCOMM service. This string is passed to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. + +## -parameters +### -param serviceId +The service id for which to query. + +## -returns +An AQS string for identifying RFCOMM service instances. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_1565690012.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_1565690012.md index 57012f0d92..62abb795e8 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_1565690012.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_1565690012.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice(Windows.Devices.Bluetooth.BluetoothDevice) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice ## -description Gets an Advanced Query Syntax (AQS) string for identifying instances of all Rfcomm services on a remote Bluetooth device. ## -parameters ### -param bluetoothDevice The remote bluetooth device. ## -returns The AQS string for identifying instances of all Rfcomm services on a remote Bluetooth device. ## -remarks ## -examples ## -see-also [GetDeviceSelectorForBluetoothDevice(BluetoothDevice, BluetoothCacheMode)](rfcommdeviceservice_getdeviceselectorforbluetoothdevice_887551146.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice(Windows.Devices.Bluetooth.BluetoothDevice) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying instances of all Rfcomm services on a remote Bluetooth device. + +## -parameters +### -param bluetoothDevice +The remote bluetooth device. + +## -returns +The AQS string for identifying instances of all Rfcomm services on a remote Bluetooth device. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelectorForBluetoothDevice(BluetoothDevice, BluetoothCacheMode)](rfcommdeviceservice_getdeviceselectorforbluetoothdevice_887551146.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_887551146.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_887551146.md index f24be2da82..b25e4e5b8d 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_887551146.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdevice_887551146.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice(Windows.Devices.Bluetooth.BluetoothDevice,Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice ## -description Gets an Advanced Query Syntax (AQS) string for identifying cached instances of all Rfcomm services on a remote Bluetooth device. ## -parameters ### -param bluetoothDevice The remote Bluetooth device. ### -param cacheMode The cache mode. ## -returns The AQS string for identifying cached instances of all Rfcomm services on a remote Bluetooth device. ## -remarks ## -examples ## -see-also [GetDeviceSelectorForBluetoothDevice(BluetoothDevice)](rfcommdeviceservice_getdeviceselectorforbluetoothdevice_1565690012.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice(Windows.Devices.Bluetooth.BluetoothDevice,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDevice + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying cached instances of all Rfcomm services on a remote Bluetooth device. + +## -parameters +### -param bluetoothDevice +The remote Bluetooth device. + +### -param cacheMode +The cache mode. + +## -returns +The AQS string for identifying cached instances of all Rfcomm services on a remote Bluetooth device. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelectorForBluetoothDevice(BluetoothDevice)](rfcommdeviceservice_getdeviceselectorforbluetoothdevice_1565690012.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1512427800.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1512427800.md index 096bfe168d..b0e3e7f162 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1512427800.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1512427800.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId(Windows.Devices.Bluetooth.BluetoothDevice,Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId ## -description Gets an Advanced Query Syntax (AQS) string for identifying instances of Rfcomm services on a remote Bluetooth device. ## -parameters ### -param bluetoothDevice The remote Bluetooth device. ### -param serviceId The service ID. ## -returns The AQS string for identifying instances of Rfcomm services. ## -remarks ## -examples ## -see-also [GetDeviceSelectorForBluetoothDeviceAndServiceId(BluetoothDevice, RfcommServiceId, BluetoothCacheMode)](rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1991431812.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId(Windows.Devices.Bluetooth.BluetoothDevice,Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying instances of Rfcomm services on a remote Bluetooth device. + +## -parameters +### -param bluetoothDevice +The remote Bluetooth device. + +### -param serviceId +The service ID. + +## -returns +The AQS string for identifying instances of Rfcomm services. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelectorForBluetoothDeviceAndServiceId(BluetoothDevice, RfcommServiceId, BluetoothCacheMode)](rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1991431812.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1991431812.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1991431812.md index 0afbb4dc71..c3c24967eb 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1991431812.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1991431812.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId(Windows.Devices.Bluetooth.BluetoothDevice,Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId,Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId ## -description Gets an Advanced Query Syntax (AQS) string for identifying instances of Rfcomm services on a remote Bluetooth device. ## -parameters ### -param bluetoothDevice The remote bluetooth device. ### -param serviceId The service ID. ### -param cacheMode The cache mode. ## -returns The AQS string for identifying instances of Rfcomm services. ## -remarks ## -examples ## -see-also [GetDeviceSelectorForBluetoothDeviceAndServiceId(BluetoothDevice, RfcommServiceId)](rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1512427800.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId(Windows.Devices.Bluetooth.BluetoothDevice,Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelectorForBluetoothDeviceAndServiceId + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying instances of Rfcomm services on a remote Bluetooth device. + +## -parameters +### -param bluetoothDevice +The remote bluetooth device. + +### -param serviceId +The service ID. + +### -param cacheMode +The cache mode. + +## -returns +The AQS string for identifying instances of Rfcomm services. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelectorForBluetoothDeviceAndServiceId(BluetoothDevice, RfcommServiceId)](rfcommdeviceservice_getdeviceselectorforbluetoothdeviceandserviceid_1512427800.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_1098060142.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_1098060142.md index da6aa47edb..cc941ca320 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_1098060142.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_1098060142.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync ## -description Gets the cached SDP attributes of the RFCOMM service instance. ## -returns The SDP attributes of the RFCOMM service instance. ## -remarks ## -examples ## -see-also [GetSdpRawAttributesAsync(BluetoothCacheMode)](rfcommdeviceservice_getsdprawattributesasync_173461641.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync + +## -description +Gets the cached SDP attributes of the RFCOMM service instance. + +## -returns +The SDP attributes of the RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also +[GetSdpRawAttributesAsync(BluetoothCacheMode)](rfcommdeviceservice_getsdprawattributesasync_173461641.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_173461641.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_173461641.md index e5a48c2710..5ef0898007 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_173461641.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_getsdprawattributesasync_173461641.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync ## -description Gets the SDP attributes of the RFCOMM service instance. ## -parameters ### -param cacheMode Indicates whether SDP attributes should be retrieved from the cache or from the device. ## -returns The SDP attributes of the RFCOMM service instance. ## -remarks ## -examples ## -see-also [GetSdpRawAttributesAsync](rfcommdeviceservice_getsdprawattributesasync_1098060142.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetSdpRawAttributesAsync + +## -description +Gets the SDP attributes of the RFCOMM service instance. + +## -parameters +### -param cacheMode +Indicates whether SDP attributes should be retrieved from the cache or from the device. + +## -returns +The SDP attributes of the RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also +[GetSdpRawAttributesAsync](rfcommdeviceservice_getsdprawattributesasync_1098060142.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_maxprotectionlevel.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_maxprotectionlevel.md index 9487c29f85..379c6118e1 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_maxprotectionlevel.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_maxprotectionlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.MaxProtectionLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.MaxProtectionLevel ## -description Gets the maximum SocketProtectionLevel supported by this RFCOMM service instance. ## -property-value The maximum SocketProtectionLevel of the RFCOMM service instance. This level can be passed to [StreamSocket.ConnectAsync](../windows.networking.sockets/streamsocket_connectasync.md) to upgrade the RFCOMM link protection level. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.MaxProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.MaxProtectionLevel + +## -description +Gets the maximum SocketProtectionLevel supported by this RFCOMM service instance. + +## -property-value +The maximum SocketProtectionLevel of the RFCOMM service instance. This level can be passed to [StreamSocket.ConnectAsync](../windows.networking.sockets/streamsocket_connectasync.md) to upgrade the RFCOMM link protection level. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_protectionlevel.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_protectionlevel.md index c3f1e04412..3c133fe58e 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_protectionlevel.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_protectionlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ProtectionLevel --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ProtectionLevel ## -description Gets the current SocketProtectionLevel of the RFCOMM service instance. ## -property-value The current SocketProtectionLevel of the remote RFCOMM service instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ProtectionLevel + +## -description +Gets the current SocketProtectionLevel of the RFCOMM service instance. + +## -property-value +The current SocketProtectionLevel of the remote RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_requestaccessasync_380675631.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_requestaccessasync_380675631.md index 6e991e5a46..0df3fdd1fa 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_requestaccessasync_380675631.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_requestaccessasync_380675631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.RequestAccessAsync ## -description Used to request explicit access to the Rfcomm service. This invokes Device Consent and must be called on the UI thread. By default, unpaired devices do not require consent, while paired devices do. [FromIdAsync](rfcommdeviceservice_fromidasync.md) will only display a consent prompt when called for a paired device. [RequestAccessAsync](rfcommdeviceservice_requestaccessasync.md) allows the app to make the access request explicit in the event where the device may become paired in the future through other uses of the device. ## -returns After the async operation completes, returns a [DeviceAccessStatus](../windows.devices.enumeration/deviceaccessstatus.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.RequestAccessAsync + +## -description +Used to request explicit access to the Rfcomm service. This invokes Device Consent and must be called on the UI thread. By default, unpaired devices do not require consent, while paired devices do. [FromIdAsync](rfcommdeviceservice_fromidasync.md) will only display a consent prompt when called for a paired device. [RequestAccessAsync](rfcommdeviceservice_requestaccessasync.md) allows the app to make the access request explicit in the event where the device may become paired in the future through other uses of the device. + +## -returns +After the async operation completes, returns a [DeviceAccessStatus](../windows.devices.enumeration/deviceaccessstatus.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_serviceid.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_serviceid.md index 3a99e897df..bf9093f129 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_serviceid.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservice_serviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ServiceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ServiceId ## -description Gets the RfcommServiceId of this RFCOMM service instance. ## -property-value The RfcommServiceId of the RFCOMM service instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ServiceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ServiceId + +## -description +Gets the RfcommServiceId of this RFCOMM service instance. + +## -property-value +The RfcommServiceId of the RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md index 6a95d0e390..6a00dce9b5 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult --api-type: winrt class ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult ## -description The result of an Rfcomm device service request. ## -remarks This class is returned as a result of calling the [GetRfcommServicesAsync](../windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_1314819113.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult + +## -description +The result of an Rfcomm device service request. + +## -remarks +This class is returned as a result of calling the [GetRfcommServicesAsync](../windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_1314819113.md) method. + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_error.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_error.md index 8c2eb04b41..b81f6abd03 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_error.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Error --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Error ## -description Indicates that an error occurred. ## -property-value Gets the error property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Error + +## -description +Indicates that an error occurred. + +## -property-value +Gets the error property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_services.md b/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_services.md index 8e8446d837..1a4617a5cb 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_services.md +++ b/windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult_services.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Services --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Services ## -description The [RfcommDeviceService](rfcommdeviceservice.md) object. ## -property-value Gets the [RfcommDeviceService](rfcommdeviceservice.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Services +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Services + +## -description +The [RfcommDeviceService](rfcommdeviceservice.md) object. + +## -property-value +Gets the [RfcommDeviceService](rfcommdeviceservice.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid.md index 1915e5acc9..f32325c50c 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId --api-type: winrt class ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId ## -description Represents an RFCOMM service ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId + +## -description +Represents an RFCOMM service ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_asshortid_725412571.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_asshortid_725412571.md index 670b4fd194..10b3ab3d0e 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_asshortid_725412571.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_asshortid_725412571.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsShortId --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsShortId ## -description Converts the RfcommServiceId to a 32-bit service id if possible. ## -returns Returns the 32-bit service id if the RfcommServiceId represents a standardized service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsShortId +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsShortId + +## -description +Converts the RfcommServiceId to a 32-bit service id if possible. + +## -returns +Returns the 32-bit service id if the RfcommServiceId represents a standardized service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_asstring_1253088126.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_asstring_1253088126.md index 12a65aa4ff..8ae64cd43e 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_asstring_1253088126.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_asstring_1253088126.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsString --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsString ## -description Converts the RfcommServiceId to a string. ## -returns Returns the string representation of the 128-bit service id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsString +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsString + +## -description +Converts the RfcommServiceId to a string. + +## -returns +Returns the string representation of the 128-bit service id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromshortid_1277388785.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromshortid_1277388785.md index 4681b13366..de0b54c81d 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromshortid_1277388785.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromshortid_1277388785.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromShortId(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromShortId ## -description Creates a RfcommServiceId object from a 32-bit service id. ## -parameters ### -param shortId The 32-bit service id. ## -returns The RfcommServiceId object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromShortId(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromShortId + +## -description +Creates a RfcommServiceId object from a 32-bit service id. + +## -parameters +### -param shortId +The 32-bit service id. + +## -returns +The RfcommServiceId object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromuuid_1765185597.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromuuid_1765185597.md index 77bf749581..7d6384f88f 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromuuid_1765185597.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_fromuuid_1765185597.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromUuid(System.Guid) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromUuid ## -description Creates a RfcommServiceId object from a 128-bit service id. ## -parameters ### -param uuid The 128-bit service id. ## -returns The RfcommServiceId object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromUuid(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromUuid + +## -description +Creates a RfcommServiceId object from a 128-bit service id. + +## -parameters +### -param uuid +The 128-bit service id. + +## -returns +The RfcommServiceId object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_genericfiletransfer.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_genericfiletransfer.md index 35b98cb14c..6f74d4c480 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_genericfiletransfer.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_genericfiletransfer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.GenericFileTransfer --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.GenericFileTransfer ## -description Creates a RfcommServiceId object corresponding to the service id for the standardized Generic File Transfer service (with short id 0x1202). ## -property-value The RfcommServiceId object that represents the service id for the Generic File Transfer service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.GenericFileTransfer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.GenericFileTransfer + +## -description +Creates a RfcommServiceId object corresponding to the service id for the standardized Generic File Transfer service (with short id 0x1202). + +## -property-value +The RfcommServiceId object that represents the service id for the Generic File Transfer service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexfiletransfer.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexfiletransfer.md index 6a87236c34..0062f116b4 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexfiletransfer.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexfiletransfer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexFileTransfer --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexFileTransfer ## -description Creates a RfcommServiceId object corresponding to the service id for the standardized OBEX File Transfer service (with short id 0x1106). ## -property-value The RfcommServiceId object that represents the service id for the Obex File Transfer service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexFileTransfer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexFileTransfer + +## -description +Creates a RfcommServiceId object corresponding to the service id for the standardized OBEX File Transfer service (with short id 0x1106). + +## -property-value +The RfcommServiceId object that represents the service id for the Obex File Transfer service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexobjectpush.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexobjectpush.md index 60a211b386..1e5d0023e9 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexobjectpush.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_obexobjectpush.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexObjectPush --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexObjectPush ## -description Creates a RfcommServiceId object corresponding to the service id for the standardized OBEX Object Push service (with short id 0x1105). ## -property-value The RfcommServiceId object that represents the service id for the OBEX Object Push service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexObjectPush +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexObjectPush + +## -description +Creates a RfcommServiceId object corresponding to the service id for the standardized OBEX Object Push service (with short id 0x1105). + +## -property-value +The RfcommServiceId object that represents the service id for the OBEX Object Push service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspce.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspce.md index b3d0d35b47..4c9ebac305 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspce.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspce.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPce --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPce ## -description Creates a RfcommServiceId object corresponding to the service id for the standardized Phone Book Access (PCE) service (with short id 0x112E). ## -property-value The RfcommServiceId object that represents the service id for the Phone Book Access (PCE) service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPce +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPce + +## -description +Creates a RfcommServiceId object corresponding to the service id for the standardized Phone Book Access (PCE) service (with short id 0x112E). + +## -property-value +The RfcommServiceId object that represents the service id for the Phone Book Access (PCE) service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspse.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspse.md index dbbd37720c..ada87efdec 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspse.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_phonebookaccesspse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPse --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPse ## -description Creates a RfcommServiceId object corresponding to the service id for the standardized Phone Book Access (PSE) service (with short id 0x112F). ## -property-value The RfcommServiceId object that represents the service id for the Phone Book Access (PSE) service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPse +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPse + +## -description +Creates a RfcommServiceId object corresponding to the service id for the standardized Phone Book Access (PSE) service (with short id 0x112F). + +## -property-value +The RfcommServiceId object that represents the service id for the Phone Book Access (PSE) service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_serialport.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_serialport.md index f0cff8888e..4ac18b3818 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_serialport.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_serialport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.SerialPort --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.SerialPort ## -description Creates a RfcommServiceId object corresponding to the service id for the standardized Serial Port service (with short id 0x1101). ## -property-value The RfcommServiceId object that represents the service id for the Serial Port service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.SerialPort +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.SerialPort + +## -description +Creates a RfcommServiceId object corresponding to the service id for the standardized Serial Port service (with short id 0x1101). + +## -property-value +The RfcommServiceId object that represents the service id for the Serial Port service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceid_uuid.md b/windows.devices.bluetooth.rfcomm/rfcommserviceid_uuid.md index 8a2f458c3e..cf6d67331f 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceid_uuid.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceid_uuid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.Uuid --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.Uuid ## -description Retrieves the 128-bit service id. ## -property-value The 128-bit service id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId.Uuid + +## -description +Retrieves the 128-bit service id. + +## -property-value +The 128-bit service id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider.md index 30f39aee96..52c7cf08aa 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider --api-type: winrt class ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider ## -description Represents an instance of a local RFCOMM service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider + +## -description +Represents an instance of a local RFCOMM service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_createasync_725413930.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_createasync_725413930.md index dcc7ea9ea8..eaeb459335 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_createasync_725413930.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_createasync_725413930.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.CreateAsync(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.CreateAsync ## -description Gets a RfcommServiceProvider object from a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) Id for a RFCOMM service instance. ## -parameters ### -param serviceId The RfcommServiceId to be hosted locally. ## -returns The RfcommServiceProvider object that represents the local RFCOMM service instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.CreateAsync(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.CreateAsync + +## -description +Gets a RfcommServiceProvider object from a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) Id for a RFCOMM service instance. + +## -parameters +### -param serviceId +The RfcommServiceId to be hosted locally. + +## -returns +The RfcommServiceProvider object that represents the local RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_sdprawattributes.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_sdprawattributes.md index 9ccc5dc466..13f54a4be2 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_sdprawattributes.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_sdprawattributes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.SdpRawAttributes --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.SdpRawAttributes ## -description Gets a collection of SDP attributes for advertising. ## -property-value The collection of SDP attributes for advertising. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.SdpRawAttributes +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.SdpRawAttributes + +## -description +Gets a collection of SDP attributes for advertising. + +## -property-value +The collection of SDP attributes for advertising. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_serviceid.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_serviceid.md index f42ba5731c..c2e688a64a 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_serviceid.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_serviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.ServiceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.ServiceId ## -description Gets the RfcommServiceId of this local RFCOMM service instance. ## -property-value The RfcommServiceId of the local RFCOMM service instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.ServiceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.ServiceId + +## -description +Gets the RfcommServiceId of this local RFCOMM service instance. + +## -property-value +The RfcommServiceId of the local RFCOMM service instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1818586023.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1818586023.md index d57a1e668d..cecbb23aee 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1818586023.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1818586023.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising(Windows.Networking.Sockets.StreamSocketListener) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising ## -description Begins advertising the SDP attributes. ## -parameters ### -param listener The StreamSocketListener that is listening for incoming connections. ## -remarks ## -examples ## -see-also [StartAdvertising(StreamSocketListener, Boolean)](rfcommserviceprovider_startadvertising_1912316833.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising(Windows.Networking.Sockets.StreamSocketListener) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising + +## -description +Begins advertising the SDP attributes. + +## -parameters +### -param listener +The StreamSocketListener that is listening for incoming connections. + +## -remarks + +## -examples + +## -see-also +[StartAdvertising(StreamSocketListener, Boolean)](rfcommserviceprovider_startadvertising_1912316833.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1912316833.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1912316833.md index 956a625d38..d5dc165a41 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1912316833.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_startadvertising_1912316833.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising(Windows.Networking.Sockets.StreamSocketListener,System.Boolean) --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising ## -description Begins advertising the SDP attributes. ## -parameters ### -param listener The StreamSocketListener that is listening for incoming connections. ### -param radioDiscoverable Indicates whether the radio is discoverable (true) or not (false). ## -remarks ## -examples ## -see-also [StartAdvertising(StreamSocketListener)](rfcommserviceprovider_startadvertising_1818586023.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising(Windows.Networking.Sockets.StreamSocketListener,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StartAdvertising + +## -description +Begins advertising the SDP attributes. + +## -parameters +### -param listener +The StreamSocketListener that is listening for incoming connections. + +### -param radioDiscoverable +Indicates whether the radio is discoverable (true) or not (false). + +## -remarks + +## -examples + +## -see-also +[StartAdvertising(StreamSocketListener)](rfcommserviceprovider_startadvertising_1818586023.md) \ No newline at end of file diff --git a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_stopadvertising_1074698824.md b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_stopadvertising_1074698824.md index 41094fb046..5b12fc636e 100644 --- a/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_stopadvertising_1074698824.md +++ b/windows.devices.bluetooth.rfcomm/rfcommserviceprovider_stopadvertising_1074698824.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StopAdvertising --api-type: winrt method ---- # Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StopAdvertising ## -description Stops advertising the SDP attributes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StopAdvertising +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Rfcomm.RfcommServiceProvider.StopAdvertising + +## -description +Stops advertising the SDP attributes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothclassofdevice.md b/windows.devices.bluetooth/bluetoothclassofdevice.md index 92017f67a0..a9f96c738e 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothClassOfDevice --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice ## -description Provides functionality to determine the Bluetooth Class Of Device (Bluetooth COD) information for a device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothClassOfDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice + +## -description +Provides functionality to determine the Bluetooth Class Of Device (Bluetooth COD) information for a device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothclassofdevice_fromparts_1738721922.md b/windows.devices.bluetooth/bluetoothclassofdevice_fromparts_1738721922.md index d48716a52f..bcee0a640a 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice_fromparts_1738721922.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice_fromparts_1738721922.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromParts(Windows.Devices.Bluetooth.BluetoothMajorClass,Windows.Devices.Bluetooth.BluetoothMinorClass,Windows.Devices.Bluetooth.BluetoothServiceCapabilities) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromParts ## -description Creates a [BluetoothClassOfDevice](bluetoothclassofdevice.md) object by supplying values for [BluetoothMajorClass](bluetoothmajorclass.md), [BluetoothMinorClass](bluetoothminorclass.md) and [BluetoothClassOfDevice](bluetoothclassofdevice.md). ## -parameters ### -param majorClass One of the enumeration values that specifies the device's main function. ### -param minorClass One of the enumeration values that specifies the minor class value to be used. ### -param serviceCapabilities One of the enumeration values that specifies the service the device supports. ## -returns A BluetoothClassOfDevice object. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromParts(Windows.Devices.Bluetooth.BluetoothMajorClass,Windows.Devices.Bluetooth.BluetoothMinorClass,Windows.Devices.Bluetooth.BluetoothServiceCapabilities) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromParts + +## -description +Creates a [BluetoothClassOfDevice](bluetoothclassofdevice.md) object by supplying values for [BluetoothMajorClass](bluetoothmajorclass.md), [BluetoothMinorClass](bluetoothminorclass.md) and [BluetoothClassOfDevice](bluetoothclassofdevice.md). + +## -parameters +### -param majorClass +One of the enumeration values that specifies the device's main function. + +### -param minorClass +One of the enumeration values that specifies the minor class value to be used. + +### -param serviceCapabilities +One of the enumeration values that specifies the service the device supports. + +## -returns +A BluetoothClassOfDevice object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothclassofdevice_fromrawvalue_1947497240.md b/windows.devices.bluetooth/bluetoothclassofdevice_fromrawvalue_1947497240.md index 18de8cd443..c48f8bc5b2 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice_fromrawvalue_1947497240.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice_fromrawvalue_1947497240.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromRawValue(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromRawValue ## -description Creates a [BluetoothClassOfDevice](bluetoothclassofdevice.md) object from a raw integer value representing the Major Class, Minor Class and Service Capabilities of the device. ## -parameters ### -param rawValue The raw integer value from which to create the BluetoothClassOfDevice object. ## -returns A BluetoothClassOfDevice object. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromRawValue(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice.FromRawValue + +## -description +Creates a [BluetoothClassOfDevice](bluetoothclassofdevice.md) object from a raw integer value representing the Major Class, Minor Class and Service Capabilities of the device. + +## -parameters +### -param rawValue +The raw integer value from which to create the BluetoothClassOfDevice object. + +## -returns +A BluetoothClassOfDevice object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothclassofdevice_majorclass.md b/windows.devices.bluetooth/bluetoothclassofdevice_majorclass.md index ee5ccf2de6..d82467e075 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice_majorclass.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice_majorclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.MajorClass --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice.MajorClass ## -description Gets the Major Class code of the Bluetooth device. ## -property-value One of the enumeration values that specifies the device's Major Class code. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.MajorClass +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice.MajorClass + +## -description +Gets the Major Class code of the Bluetooth device. + +## -property-value +One of the enumeration values that specifies the device's Major Class code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothclassofdevice_minorclass.md b/windows.devices.bluetooth/bluetoothclassofdevice_minorclass.md index e46cb8bd14..465e3a5ea5 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice_minorclass.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice_minorclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.MinorClass --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice.MinorClass ## -description Gets the Minor Class code of the device. ## -property-value One of the enumeration values that specifies the device's Minor Class code. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.MinorClass +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice.MinorClass + +## -description +Gets the Minor Class code of the device. + +## -property-value +One of the enumeration values that specifies the device's Minor Class code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothclassofdevice_rawvalue.md b/windows.devices.bluetooth/bluetoothclassofdevice_rawvalue.md index 212c64c648..96df14a62b 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice_rawvalue.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice_rawvalue.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.RawValue --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice.RawValue ## -description Gets the Bluetooth Class Of Device information, represented as an integer value. ## -property-value The Bluetooth Class Of Device information, represented as a raw integer value. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.RawValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice.RawValue + +## -description +Gets the Bluetooth Class Of Device information, represented as an integer value. + +## -property-value +The Bluetooth Class Of Device information, represented as a raw integer value. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothclassofdevice_servicecapabilities.md b/windows.devices.bluetooth/bluetoothclassofdevice_servicecapabilities.md index 3664c955f7..02beed3610 100644 --- a/windows.devices.bluetooth/bluetoothclassofdevice_servicecapabilities.md +++ b/windows.devices.bluetooth/bluetoothclassofdevice_servicecapabilities.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.ServiceCapabilities --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothClassOfDevice.ServiceCapabilities ## -description Gets the service capabilities of the device. ## -property-value One of the enumeration values that specifies the service capabilities of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothClassOfDevice.ServiceCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothClassOfDevice.ServiceCapabilities + +## -description +Gets the service capabilities of the device. + +## -property-value +One of the enumeration values that specifies the service capabilities of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice.md b/windows.devices.bluetooth/bluetoothdevice.md index b9303c18d3..62c62f2d16 100644 --- a/windows.devices.bluetooth/bluetoothdevice.md +++ b/windows.devices.bluetooth/bluetoothdevice.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothDevice --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothDevice ## -description Represents a Bluetooth device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice + +## -description +Represents a Bluetooth device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_bluetoothaddress.md b/windows.devices.bluetooth/bluetoothdevice_bluetoothaddress.md index a37556bdd5..b15ba355dd 100644 --- a/windows.devices.bluetooth/bluetoothdevice_bluetoothaddress.md +++ b/windows.devices.bluetooth/bluetoothdevice_bluetoothaddress.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.BluetoothAddress --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.BluetoothAddress ## -description Gets the device address. ## -property-value The device address. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.BluetoothAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.BluetoothAddress + +## -description +Gets the device address. + +## -property-value +The device address. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_classofdevice.md b/windows.devices.bluetooth/bluetoothdevice_classofdevice.md index 0d9d983e63..b719bed5f3 100644 --- a/windows.devices.bluetooth/bluetoothdevice_classofdevice.md +++ b/windows.devices.bluetooth/bluetoothdevice_classofdevice.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.ClassOfDevice --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.ClassOfDevice ## -description Gets the Bluetooth Class Of Device information of the device. ## -property-value The Bluetooth Class Of Device information of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.ClassOfDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.ClassOfDevice + +## -description +Gets the Bluetooth Class Of Device information of the device. + +## -property-value +The Bluetooth Class Of Device information of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_close_811482585.md b/windows.devices.bluetooth/bluetoothdevice_close_811482585.md index efd9b65c4f..32818205ed 100644 --- a/windows.devices.bluetooth/bluetoothdevice_close_811482585.md +++ b/windows.devices.bluetooth/bluetoothdevice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.Close --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.Close ## -description Closes the Bluetooth device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.Close + +## -description +Closes the Bluetooth device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_connectionstatus.md b/windows.devices.bluetooth/bluetoothdevice_connectionstatus.md index fdae52b331..667c8e7b96 100644 --- a/windows.devices.bluetooth/bluetoothdevice_connectionstatus.md +++ b/windows.devices.bluetooth/bluetoothdevice_connectionstatus.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatus --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatus ## -description Gets the connection status of the device. ## -property-value One of the BluetoothConnectionStatus enumeration values that specifies the connection status of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatus + +## -description +Gets the connection status of the device. + +## -property-value +One of the BluetoothConnectionStatus enumeration values that specifies the connection status of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_connectionstatuschanged.md b/windows.devices.bluetooth/bluetoothdevice_connectionstatuschanged.md index 0e5973df59..eb0c68ac36 100644 --- a/windows.devices.bluetooth/bluetoothdevice_connectionstatuschanged.md +++ b/windows.devices.bluetooth/bluetoothdevice_connectionstatuschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatusChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatusChanged ## -description Occurs when the connection status of the device has changed. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.ConnectionStatusChanged + +## -description +Occurs when the connection status of the device has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_deviceaccessinformation.md b/windows.devices.bluetooth/bluetoothdevice_deviceaccessinformation.md index 13a2c0c21d..3f0bd4da1d 100644 --- a/windows.devices.bluetooth/bluetoothdevice_deviceaccessinformation.md +++ b/windows.devices.bluetooth/bluetoothdevice_deviceaccessinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.DeviceAccessInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.DeviceAccessInformation ## -description The current **DeviceAccessInformation** object for the device. Used to check and monitor access changes to the device. ## -property-value The current **DeviceAccessInformation** object for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.DeviceAccessInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.DeviceAccessInformation + +## -description +The current **DeviceAccessInformation** object for the device. Used to check and monitor access changes to the device. + +## -property-value +The current **DeviceAccessInformation** object for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_deviceid.md b/windows.devices.bluetooth/bluetoothdevice_deviceid.md index 0affeb202b..c7d2e28fce 100644 --- a/windows.devices.bluetooth/bluetoothdevice_deviceid.md +++ b/windows.devices.bluetooth/bluetoothdevice_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.DeviceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.DeviceId ## -description Gets the device ID. ## -property-value The ID of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.DeviceId + +## -description +Gets the device ID. + +## -property-value +The ID of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_deviceinformation.md b/windows.devices.bluetooth/bluetoothdevice_deviceinformation.md index ef5386e2c2..24f3840713 100644 --- a/windows.devices.bluetooth/bluetoothdevice_deviceinformation.md +++ b/windows.devices.bluetooth/bluetoothdevice_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.DeviceInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.DeviceInformation ## -description Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the Bluetooth device. ## -property-value The device information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.DeviceInformation + +## -description +Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the Bluetooth device. + +## -property-value +The device information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_frombluetoothaddressasync_117221987.md b/windows.devices.bluetooth/bluetoothdevice_frombluetoothaddressasync_117221987.md index 2cf8e0fc33..35cc3ae9e9 100644 --- a/windows.devices.bluetooth/bluetoothdevice_frombluetoothaddressasync_117221987.md +++ b/windows.devices.bluetooth/bluetoothdevice_frombluetoothaddressasync_117221987.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.FromBluetoothAddressAsync(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.FromBluetoothAddressAsync ## -description Returns a [BluetoothDevice](bluetoothdevice.md) object for the given [BluetoothAddress](bluetoothdevice_bluetoothaddress.md). ## -parameters ### -param address The address of the Bluetooth device. ## -returns After the asynchronous operation completes, returns the [BluetoothDevice](bluetoothdevice.md) object with the given [BluetoothAddress](bluetoothledevice_bluetoothaddress.md) or null if the address does not resolve to a valid device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.FromBluetoothAddressAsync(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.FromBluetoothAddressAsync + +## -description +Returns a [BluetoothDevice](bluetoothdevice.md) object for the given [BluetoothAddress](bluetoothdevice_bluetoothaddress.md). + +## -parameters +### -param address +The address of the Bluetooth device. + +## -returns +After the asynchronous operation completes, returns the [BluetoothDevice](bluetoothdevice.md) object with the given [BluetoothAddress](bluetoothledevice_bluetoothaddress.md) or null if the address does not resolve to a valid device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_fromhostnameasync_552172834.md b/windows.devices.bluetooth/bluetoothdevice_fromhostnameasync_552172834.md index ea3fdebe29..5a761c2ecd 100644 --- a/windows.devices.bluetooth/bluetoothdevice_fromhostnameasync_552172834.md +++ b/windows.devices.bluetooth/bluetoothdevice_fromhostnameasync_552172834.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.FromHostNameAsync(Windows.Networking.HostName) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.FromHostNameAsync ## -description Returns a [BluetoothDevice](bluetoothdevice.md) object identified by the given [HostName](bluetoothdevice_hostname.md). ## -parameters ### -param hostName The HostName that identifies the BluetoothDevice instance. ## -returns After the asynchronous operation completes, returns the [BluetoothDevice](bluetoothdevice.md) object identified by the given [HostName](bluetoothdevice_hostname.md). ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.FromHostNameAsync(Windows.Networking.HostName) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.FromHostNameAsync + +## -description +Returns a [BluetoothDevice](bluetoothdevice.md) object identified by the given [HostName](bluetoothdevice_hostname.md). + +## -parameters +### -param hostName +The HostName that identifies the BluetoothDevice instance. + +## -returns +After the asynchronous operation completes, returns the [BluetoothDevice](bluetoothdevice.md) object identified by the given [HostName](bluetoothdevice_hostname.md). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_fromidasync_1322863552.md b/windows.devices.bluetooth/bluetoothdevice_fromidasync_1322863552.md index 6ed31d5d8a..6ce654050e 100644 --- a/windows.devices.bluetooth/bluetoothdevice_fromidasync_1322863552.md +++ b/windows.devices.bluetooth/bluetoothdevice_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.FromIdAsync ## -description Returns a [BluetoothDevice](bluetoothdevice.md) object identified by the given [DeviceId](bluetoothledevice_deviceid.md). ## -parameters ### -param deviceId The DeviceId value that identifies the BluetoothDevice instance. ## -returns After the asynchronous operation completes, returns the [BluetoothDevice](bluetoothdevice.md) object identified by the given [DeviceId](bluetoothledevice_deviceid.md). ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.FromIdAsync + +## -description +Returns a [BluetoothDevice](bluetoothdevice.md) object identified by the given [DeviceId](bluetoothledevice_deviceid.md). + +## -parameters +### -param deviceId +The DeviceId value that identifies the BluetoothDevice instance. + +## -returns +After the asynchronous operation completes, returns the [BluetoothDevice](bluetoothdevice.md) object identified by the given [DeviceId](bluetoothledevice_deviceid.md). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_getdeviceselector_838466080.md b/windows.devices.bluetooth/bluetoothdevice_getdeviceselector_838466080.md index ffae30c806..2fe377a4ce 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getdeviceselector_838466080.md +++ b/windows.devices.bluetooth/bluetoothdevice_getdeviceselector_838466080.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string for identifying instances of this device. This string is passed to the FindAllAsync or CreateWatcher method. ## -returns The device selector for this device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying instances of this device. This string is passed to the FindAllAsync or CreateWatcher method. + +## -returns +The device selector for this device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrombluetoothaddress_1273508324.md b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrombluetoothaddress_1273508324.md index 26df599e90..efacad11f0 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrombluetoothaddress_1273508324.md +++ b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrombluetoothaddress_1273508324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromBluetoothAddress(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromBluetoothAddress ## -description Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address that represents a Bluetooth device. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. ## -parameters ### -param bluetoothAddress A 64-bit Bluetooth device address used for constructing the AQS string. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromBluetoothAddress(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromBluetoothAddress + +## -description +Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address that represents a Bluetooth device. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. + +## -parameters +### -param bluetoothAddress +A 64-bit Bluetooth device address used for constructing the AQS string. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromclassofdevice_1315371062.md b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromclassofdevice_1315371062.md index 8ef714f1b6..e108b930f4 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromclassofdevice_1315371062.md +++ b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromclassofdevice_1315371062.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromClassOfDevice(Windows.Devices.Bluetooth.BluetoothClassOfDevice) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromClassOfDevice ## -description Creates an Advanced Query Syntax (AQS) filter string from a [BluetoothClassOfDevice](bluetoothclassofdevice.md) object. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. ## -parameters ### -param classOfDevice The class of device used for constructing the AQS string. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks Each section of the classOfDevice parameter is optional. However, if the minor class of device is set, then the major class of device must also be set. The following are behaviors related what is set. + If no major/minor class of device is set, all devices matching the supplied service capabilities will be returned. + If no minor class of device is set, all devices matching the major class of devices AND the supplied service capabilities will be returned. + If service capabilities are set, all devices that match at LEAST the supplied service capabilities AND the major/minor class of device will be returned. + If no service capabilities are set, all devices that match the major/minor class of device will be returned. + If no major/minor class of device is set AND no service capabilities are set, all devices will be returned. This AQS Filter string will request an inquiry to be issued. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromClassOfDevice(Windows.Devices.Bluetooth.BluetoothClassOfDevice) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromClassOfDevice + +## -description +Creates an Advanced Query Syntax (AQS) filter string from a [BluetoothClassOfDevice](bluetoothclassofdevice.md) object. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. + +## -parameters +### -param classOfDevice +The class of device used for constructing the AQS string. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks +Each section of the classOfDevice parameter is optional. However, if the minor class of device is set, then the major class of device must also be set. The following are behaviors related what is set. + ++ If no major/minor class of device is set, all devices matching the supplied service capabilities will be returned. ++ If no minor class of device is set, all devices matching the major class of devices AND the supplied service capabilities will be returned. ++ If service capabilities are set, all devices that match at LEAST the supplied service capabilities AND the major/minor class of device will be returned. ++ If no service capabilities are set, all devices that match the major/minor class of device will be returned. ++ If no major/minor class of device is set AND no service capabilities are set, all devices will be returned. This AQS Filter string will request an inquiry to be issued. + + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromconnectionstatus_401358086.md b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromconnectionstatus_401358086.md index cf7edc5e1d..1c4c6ecbbf 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromconnectionstatus_401358086.md +++ b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromconnectionstatus_401358086.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromConnectionStatus(Windows.Devices.Bluetooth.BluetoothConnectionStatus) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromConnectionStatus ## -description Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices with the indicated [BluetoothConnectionStatus](bluetoothconnectionstatus.md). The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects with the indicated Bluetooth connection status. ## -parameters ### -param connectionStatus The connection status used for constructing the AQS string. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromConnectionStatus(Windows.Devices.Bluetooth.BluetoothConnectionStatus) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromConnectionStatus + +## -description +Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices with the indicated [BluetoothConnectionStatus](bluetoothconnectionstatus.md). The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects with the indicated Bluetooth connection status. + +## -parameters +### -param connectionStatus +The connection status used for constructing the AQS string. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromdevicename_1784232756.md b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromdevicename_1784232756.md index 9b31445028..dfa8190d29 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromdevicename_1784232756.md +++ b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfromdevicename_1784232756.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromDeviceName(System.String) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromDeviceName ## -description Creates an Advanced Query Syntax (AQS) filter string that contains a query for the Bluetooth device name. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects containing the specified Bluetooth device name. ## -parameters ### -param deviceName The Bluetooth device name used for constructing the AQS string. ## -returns An AQS string that is passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromDeviceName(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromDeviceName + +## -description +Creates an Advanced Query Syntax (AQS) filter string that contains a query for the Bluetooth device name. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects containing the specified Bluetooth device name. + +## -parameters +### -param deviceName +The Bluetooth device name used for constructing the AQS string. + +## -returns +An AQS string that is passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrompairingstate_446391455.md b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrompairingstate_446391455.md index d4eb9159d6..1eddc6641c 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrompairingstate_446391455.md +++ b/windows.devices.bluetooth/bluetoothdevice_getdeviceselectorfrompairingstate_446391455.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromPairingState(System.Boolean) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromPairingState ## -description Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices that are either paired or unpaired. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. ## -parameters ### -param pairingState The current pairing state for Bluetooth devices used for constructing the AQS string. Bluetooth devices can be either paired (true) or unpaired (false). The AQS Filter string will request scanning to be performed when the pairingState is false. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromPairingState(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromPairingState + +## -description +Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices that are either paired or unpaired. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. + +## -parameters +### -param pairingState +The current pairing state for Bluetooth devices used for constructing the AQS string. Bluetooth devices can be either paired (true) or unpaired (false). The AQS Filter string will request scanning to be performed when the pairingState is false. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_1314819113.md b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_1314819113.md index 51f1f42d42..fffeba3520 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_1314819113.md +++ b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_1314819113.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync ## -description Retrieves all cached Rfcomm Services on the remote Bluetooth Device. ## -parameters ### -param cacheMode The cache mode. ## -returns After the asynchronous operation completes, returns a [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. ## -remarks ## -examples ## -see-also [GetRfcommServicesAsync](bluetoothdevice_getrfcommservicesasync_91966924.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync + +## -description +Retrieves all cached Rfcomm Services on the remote Bluetooth Device. + +## -parameters +### -param cacheMode +The cache mode. + +## -returns +After the asynchronous operation completes, returns a [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. + +## -remarks + +## -examples + +## -see-also +[GetRfcommServicesAsync](bluetoothdevice_getrfcommservicesasync_91966924.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_91966924.md b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_91966924.md index cc02826684..88cb90d501 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_91966924.md +++ b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesasync_91966924.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync ## -description Retrieves all Rfcomm Services on the remote Bluetooth Device. ## -returns After the asynchronous operation completes, returns a [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. ## -remarks ## -examples ## -see-also [GetRfcommServicesAsync(BluetoothCacheMode)](bluetoothdevice_getrfcommservicesasync_1314819113.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesAsync + +## -description +Retrieves all Rfcomm Services on the remote Bluetooth Device. + +## -returns +After the asynchronous operation completes, returns a [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. + +## -remarks + +## -examples + +## -see-also +[GetRfcommServicesAsync(BluetoothCacheMode)](bluetoothdevice_getrfcommservicesasync_1314819113.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_2013167460.md b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_2013167460.md index d19d563ea2..9c57cf0906 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_2013167460.md +++ b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_2013167460.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync ## -description Retrieves all Rfcomm Services on the Remote Bluetooth Device matching the specified [RfcommServiceId](../windows.devices.bluetooth.rfcomm/rfcommserviceid.md). ## -parameters ### -param serviceId The Rfcomm service id. ## -returns After the asynchronous operation completes, returns an [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. ## -remarks ## -examples ## -see-also [GetRfcommServicesForIdAsync(RfcommServiceId, BluetoothCacheMode)](bluetoothdevice_getrfcommservicesforidasync_508166994.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync + +## -description +Retrieves all Rfcomm Services on the Remote Bluetooth Device matching the specified [RfcommServiceId](../windows.devices.bluetooth.rfcomm/rfcommserviceid.md). + +## -parameters +### -param serviceId +The Rfcomm service id. + +## -returns +After the asynchronous operation completes, returns an [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. + +## -remarks + +## -examples + +## -see-also +[GetRfcommServicesForIdAsync(RfcommServiceId, BluetoothCacheMode)](bluetoothdevice_getrfcommservicesforidasync_508166994.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_508166994.md b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_508166994.md index 84695adeda..6287494105 100644 --- a/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_508166994.md +++ b/windows.devices.bluetooth/bluetoothdevice_getrfcommservicesforidasync_508166994.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId,Windows.Devices.Bluetooth.BluetoothCacheMode) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync ## -description Retrieves all cached Rfcomm Services on the Remote Bluetooth Device matching the specified [RfcommServiceId](../windows.devices.bluetooth.rfcomm/rfcommserviceid.md). ## -parameters ### -param serviceId The Rfcomm service id. ### -param cacheMode The cache mode. ## -returns After the asynchronous operation completes, returns an [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. ## -remarks ## -examples ## -see-also [GetRfcommServicesForIdAsync(RfcommServiceId)](bluetoothdevice_getrfcommservicesforidasync_2013167460.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync(Windows.Devices.Bluetooth.Rfcomm.RfcommServiceId,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.GetRfcommServicesForIdAsync + +## -description +Retrieves all cached Rfcomm Services on the Remote Bluetooth Device matching the specified [RfcommServiceId](../windows.devices.bluetooth.rfcomm/rfcommserviceid.md). + +## -parameters +### -param serviceId +The Rfcomm service id. + +### -param cacheMode +The cache mode. + +## -returns +After the asynchronous operation completes, returns an [RfcommDeviceServicesResult](../windows.devices.bluetooth.rfcomm/rfcommdeviceservicesresult.md) object. + +## -remarks + +## -examples + +## -see-also +[GetRfcommServicesForIdAsync(RfcommServiceId)](bluetoothdevice_getrfcommservicesforidasync_2013167460.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_hostname.md b/windows.devices.bluetooth/bluetoothdevice_hostname.md index 10e2c547f1..09dd766710 100644 --- a/windows.devices.bluetooth/bluetoothdevice_hostname.md +++ b/windows.devices.bluetooth/bluetoothdevice_hostname.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.HostName --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.HostName ## -description Gets the HostName of the device. ## -property-value The HostName of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.HostName +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.HostName + +## -description +Gets the HostName of the device. + +## -property-value +The HostName of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_name.md b/windows.devices.bluetooth/bluetoothdevice_name.md index d5c12b4c07..be5e329676 100644 --- a/windows.devices.bluetooth/bluetoothdevice_name.md +++ b/windows.devices.bluetooth/bluetoothdevice_name.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.Name --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.Name ## -description Gets the Name of the device. ## -property-value The name of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.Name +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.Name + +## -description +Gets the Name of the device. + +## -property-value +The name of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_namechanged.md b/windows.devices.bluetooth/bluetoothdevice_namechanged.md index 4fef5ea314..45c72e2017 100644 --- a/windows.devices.bluetooth/bluetoothdevice_namechanged.md +++ b/windows.devices.bluetooth/bluetoothdevice_namechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Bluetooth.BluetoothDevice.NameChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.BluetoothDevice.NameChanged ## -description Occurs when the name of the device has changed. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.BluetoothDevice.NameChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.NameChanged + +## -description +Occurs when the name of the device has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_requestaccessasync_380675631.md b/windows.devices.bluetooth/bluetoothdevice_requestaccessasync_380675631.md index 57020c33a8..818ed70a2a 100644 --- a/windows.devices.bluetooth/bluetoothdevice_requestaccessasync_380675631.md +++ b/windows.devices.bluetooth/bluetoothdevice_requestaccessasync_380675631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothDevice.RequestAccessAsync ## -description Used to request explicit access to the Bluetooth device. This invokes Device Consent and must be called on the UI thread. ## -returns After the asynchronous operation completes, returns a [DeviceAccessStatus](../windows.devices.enumeration/deviceaccessstatus.md) enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDevice.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.RequestAccessAsync + +## -description +Used to request explicit access to the Bluetooth device. This invokes Device Consent and must be called on the UI thread. + +## -returns +After the asynchronous operation completes, returns a [DeviceAccessStatus](../windows.devices.enumeration/deviceaccessstatus.md) enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdevice_rfcommservices.md b/windows.devices.bluetooth/bluetoothdevice_rfcommservices.md index 9a8a6624a7..5a1cc7b8a5 100644 --- a/windows.devices.bluetooth/bluetoothdevice_rfcommservices.md +++ b/windows.devices.bluetooth/bluetoothdevice_rfcommservices.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.RfcommServices --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.RfcommServices ## -description Gets the read-only list of RFCOMM services supported by the device. ## -property-value The read-only list of RFCOMM services supported by the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.RfcommServices +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.RfcommServices + +## -description +Gets the read-only list of RFCOMM services supported by the device. + +## -property-value +The read-only list of RFCOMM services supported by the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_sdprecords.md b/windows.devices.bluetooth/bluetoothdevice_sdprecords.md index e5b49b7fac..6d975b2f2f 100644 --- a/windows.devices.bluetooth/bluetoothdevice_sdprecords.md +++ b/windows.devices.bluetooth/bluetoothdevice_sdprecords.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.SdpRecords --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothDevice.SdpRecords ## -description Gets the read-only list of Service Discovery Protocol (SDP) records for the device. ## -property-value The read-only list of Service Discovery Protocol (SDP) records for the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.SdpRecords +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.SdpRecords + +## -description +Gets the read-only list of Service Discovery Protocol (SDP) records for the device. + +## -property-value +The read-only list of Service Discovery Protocol (SDP) records for the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothdevice_sdprecordschanged.md b/windows.devices.bluetooth/bluetoothdevice_sdprecordschanged.md index c0dd6a896c..0075fa7481 100644 --- a/windows.devices.bluetooth/bluetoothdevice_sdprecordschanged.md +++ b/windows.devices.bluetooth/bluetoothdevice_sdprecordschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Bluetooth.BluetoothDevice.SdpRecordsChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.BluetoothDevice.SdpRecordsChanged ## -description Occurs when the list SDP records for the device has changed. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.BluetoothDevice.SdpRecordsChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.BluetoothDevice.SdpRecordsChanged + +## -description +Occurs when the list SDP records for the device has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothleappearance.md b/windows.devices.bluetooth/bluetoothleappearance.md index ffc88844f3..b599db6092 100644 --- a/windows.devices.bluetooth/bluetoothleappearance.md +++ b/windows.devices.bluetooth/bluetoothleappearance.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothLEAppearance --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothLEAppearance ## -description Provides functionality to determine the Bluetooth Low Energy (LE) Appearance information for a device. To get an instance of this class, call the [BluetoothLEAppearance.FromRawValue](bluetoothleappearance_fromrawvalue.md) method or the [BluetoothLEAppearance.FromParts](bluetoothleappearance_fromparts.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothLEAppearance +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearance + +## -description +Provides functionality to determine the Bluetooth Low Energy (LE) Appearance information for a device. To get an instance of this class, call the [BluetoothLEAppearance.FromRawValue](bluetoothleappearance_fromrawvalue.md) method or the [BluetoothLEAppearance.FromParts](bluetoothleappearance_fromparts.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearance_category.md b/windows.devices.bluetooth/bluetoothleappearance_category.md index ccff8379a8..6ef93cd25a 100644 --- a/windows.devices.bluetooth/bluetoothleappearance_category.md +++ b/windows.devices.bluetooth/bluetoothleappearance_category.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearance.Category --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearance.Category ## -description Gets the appearance category value of the Bluetooth LE device. ## -property-value The appearance category of the Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearance.Category +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearance.Category + +## -description +Gets the appearance category value of the Bluetooth LE device. + +## -property-value +The appearance category of the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearance_fromparts_1479822747.md b/windows.devices.bluetooth/bluetoothleappearance_fromparts_1479822747.md index 09c03e5977..1920a79ab6 100644 --- a/windows.devices.bluetooth/bluetoothleappearance_fromparts_1479822747.md +++ b/windows.devices.bluetooth/bluetoothleappearance_fromparts_1479822747.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEAppearance.FromParts(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEAppearance.FromParts ## -description Creates a [BluetoothLEAppearance](bluetoothleappearance.md) object by supplying values for Category (see [BluetoothLEAppearanceCategories](bluetoothleappearancecategories.md)) and Subcategory (see [BluetoothLEAppearanceSubcategories](bluetoothleappearancesubcategories.md)) of the Bluetooth LE device. ## -parameters ### -param appearanceCategory The Bluetooth LE appearance category. See [BluetoothLEAppearanceSubcategories](bluetoothleappearancesubcategories.md). ### -param appearanceSubCategory The Bluetooth LE appearance subcategory. See [BluetoothLEAppearanceSubcategories](bluetoothleappearancesubcategories.md). ## -returns The Bluetooth LE appearance object that was created from the appearance category and subcategory. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEAppearance.FromParts(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearance.FromParts + +## -description +Creates a [BluetoothLEAppearance](bluetoothleappearance.md) object by supplying values for Category (see [BluetoothLEAppearanceCategories](bluetoothleappearancecategories.md)) and Subcategory (see [BluetoothLEAppearanceSubcategories](bluetoothleappearancesubcategories.md)) of the Bluetooth LE device. + +## -parameters +### -param appearanceCategory +The Bluetooth LE appearance category. See [BluetoothLEAppearanceSubcategories](bluetoothleappearancesubcategories.md). + +### -param appearanceSubCategory +The Bluetooth LE appearance subcategory. See [BluetoothLEAppearanceSubcategories](bluetoothleappearancesubcategories.md). + +## -returns +The Bluetooth LE appearance object that was created from the appearance category and subcategory. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearance_fromrawvalue_1696697572.md b/windows.devices.bluetooth/bluetoothleappearance_fromrawvalue_1696697572.md index bb27697db7..60111d3657 100644 --- a/windows.devices.bluetooth/bluetoothleappearance_fromrawvalue_1696697572.md +++ b/windows.devices.bluetooth/bluetoothleappearance_fromrawvalue_1696697572.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEAppearance.FromRawValue(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEAppearance.FromRawValue ## -description Creates a [BluetoothLEAppearance](bluetoothleappearance.md) object by supplying for raw integer values representing the Category and Subcategory of the Bluetooth LE device. ## -parameters ### -param rawValue The raw integer value representing the appearance category and subcategory. ## -returns The Bluetooth LE appearance object that was created from the appearance category and subcategory. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEAppearance.FromRawValue(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearance.FromRawValue + +## -description +Creates a [BluetoothLEAppearance](bluetoothleappearance.md) object by supplying for raw integer values representing the Category and Subcategory of the Bluetooth LE device. + +## -parameters +### -param rawValue +The raw integer value representing the appearance category and subcategory. + +## -returns +The Bluetooth LE appearance object that was created from the appearance category and subcategory. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearance_rawvalue.md b/windows.devices.bluetooth/bluetoothleappearance_rawvalue.md index 182a368ecf..95fc9f0fed 100644 --- a/windows.devices.bluetooth/bluetoothleappearance_rawvalue.md +++ b/windows.devices.bluetooth/bluetoothleappearance_rawvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearance.RawValue --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearance.RawValue ## -description Gets the appearance raw value of the Bluetooth LE device. ## -property-value The appearance raw value of the Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearance.RawValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearance.RawValue + +## -description +Gets the appearance raw value of the Bluetooth LE device. + +## -property-value +The appearance raw value of the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearance_subcategory.md b/windows.devices.bluetooth/bluetoothleappearance_subcategory.md index fc8142f409..a509281e09 100644 --- a/windows.devices.bluetooth/bluetoothleappearance_subcategory.md +++ b/windows.devices.bluetooth/bluetoothleappearance_subcategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearance.SubCategory --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearance.SubCategory ## -description Gets the appearance subcategory value of the Bluetooth LE device. ## -property-value The appearance subcategory of the Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearance.SubCategory +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearance.SubCategory + +## -description +Gets the appearance subcategory value of the Bluetooth LE device. + +## -property-value +The appearance subcategory of the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories.md b/windows.devices.bluetooth/bluetoothleappearancecategories.md index d23891c80c..09a1914ca3 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories ## -description Indicates the appearance category code of the Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories + +## -description +Indicates the appearance category code of the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_barcodescanner.md b/windows.devices.bluetooth/bluetoothleappearancecategories_barcodescanner.md index e6b8c4f8d2..7f133aa65c 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_barcodescanner.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_barcodescanner.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BarcodeScanner --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BarcodeScanner ## -description Gets the barcode scanner appearance category code. ## -property-value The appearance category code for a barcode scanner Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BarcodeScanner +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BarcodeScanner + +## -description +Gets the barcode scanner appearance category code. + +## -property-value +The appearance category code for a barcode scanner Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_bloodpressure.md b/windows.devices.bluetooth/bluetoothleappearancecategories_bloodpressure.md index b2c84e763e..53d705840b 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_bloodpressure.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_bloodpressure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BloodPressure --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BloodPressure ## -description Gets the blood pressure appearance category code. ## -property-value The appearance category code for a blood pressure Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BloodPressure +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.BloodPressure + +## -description +Gets the blood pressure appearance category code. + +## -property-value +The appearance category code for a blood pressure Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_clock.md b/windows.devices.bluetooth/bluetoothleappearancecategories_clock.md index 3270785b5a..cf7910364c 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_clock.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_clock.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Clock --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Clock ## -description Gets the clock appearance category code. ## -property-value The appearance category code for a clock Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Clock +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Clock + +## -description +Gets the clock appearance category code. + +## -property-value +The appearance category code for a clock Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_computer.md b/windows.devices.bluetooth/bluetoothleappearancecategories_computer.md index 9ba71f732d..f4c80ebcbc 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_computer.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_computer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Computer --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Computer ## -description Gets the computer appearance category code. ## -property-value The appearance category code for a computer Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Computer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Computer + +## -description +Gets the computer appearance category code. + +## -property-value +The appearance category code for a computer Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_cycling.md b/windows.devices.bluetooth/bluetoothleappearancecategories_cycling.md index 6a46c56efa..1fcbf6ecfc 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_cycling.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_cycling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Cycling --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Cycling ## -description Gets the cycling appearance category code. ## -property-value The appearance category code for a cycling Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Cycling +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Cycling + +## -description +Gets the cycling appearance category code. + +## -property-value +The appearance category code for a cycling Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_display.md b/windows.devices.bluetooth/bluetoothleappearancecategories_display.md index 27009c24ab..c4ec14376e 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_display.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_display.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Display --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Display ## -description Gets the display appearance category code. ## -property-value The appearance category code for a display Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Display +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Display + +## -description +Gets the display appearance category code. + +## -property-value +The appearance category code for a display Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_eyeglasses.md b/windows.devices.bluetooth/bluetoothleappearancecategories_eyeglasses.md index 975535d2a0..451357233a 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_eyeglasses.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_eyeglasses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.EyeGlasses --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.EyeGlasses ## -description Gets the eye glasses appearance category code. ## -property-value The appearance category code for an eye glasses Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.EyeGlasses +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.EyeGlasses + +## -description +Gets the eye glasses appearance category code. + +## -property-value +The appearance category code for an eye glasses Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_glucosemeter.md b/windows.devices.bluetooth/bluetoothleappearancecategories_glucosemeter.md index 3d73efc0ab..e65c0078ba 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_glucosemeter.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_glucosemeter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.GlucoseMeter --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.GlucoseMeter ## -description Gets the glucose meter appearance category code. ## -property-value The appearance category code for a glucose meter Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.GlucoseMeter +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.GlucoseMeter + +## -description +Gets the glucose meter appearance category code. + +## -property-value +The appearance category code for a glucose meter Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_heartrate.md b/windows.devices.bluetooth/bluetoothleappearancecategories_heartrate.md index 68b4f14916..5df267d38a 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_heartrate.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_heartrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HeartRate --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HeartRate ## -description Gets the heart rate appearance category code. ## -property-value The appearance category code for a heart rate Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HeartRate +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HeartRate + +## -description +Gets the heart rate appearance category code. + +## -property-value +The appearance category code for a heart rate Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_humaninterfacedevice.md b/windows.devices.bluetooth/bluetoothleappearancecategories_humaninterfacedevice.md index e48d4730f1..066664b582 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_humaninterfacedevice.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_humaninterfacedevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HumanInterfaceDevice --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HumanInterfaceDevice ## -description Gets the human interface device appearance category code. ## -property-value The appearance category code for a human interface device Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HumanInterfaceDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.HumanInterfaceDevice + +## -description +Gets the human interface device appearance category code. + +## -property-value +The appearance category code for a human interface device Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_keyring.md b/windows.devices.bluetooth/bluetoothleappearancecategories_keyring.md index 4ec8432c33..55ad110a20 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_keyring.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_keyring.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Keyring --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Keyring ## -description Gets the key ring appearance category code. ## -property-value The appearance category code for a key ring Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Keyring +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Keyring + +## -description +Gets the key ring appearance category code. + +## -property-value +The appearance category code for a key ring Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_mediaplayer.md b/windows.devices.bluetooth/bluetoothleappearancecategories_mediaplayer.md index 867e2e9657..544b7141a1 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_mediaplayer.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_mediaplayer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.MediaPlayer --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.MediaPlayer ## -description Gets the media player appearance category code. ## -property-value The appearance category code for a media player Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.MediaPlayer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.MediaPlayer + +## -description +Gets the media player appearance category code. + +## -property-value +The appearance category code for a media player Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_outdoorsportactivity.md b/windows.devices.bluetooth/bluetoothleappearancecategories_outdoorsportactivity.md index 1b546d14e3..cfc5edcae6 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_outdoorsportactivity.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_outdoorsportactivity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.OutdoorSportActivity --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.OutdoorSportActivity ## -description Gets the outdoor sport activity appearance category code. ## -property-value The appearance category code for an outdoor sport activity Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.OutdoorSportActivity +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.OutdoorSportActivity + +## -description +Gets the outdoor sport activity appearance category code. + +## -property-value +The appearance category code for an outdoor sport activity Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_phone.md b/windows.devices.bluetooth/bluetoothleappearancecategories_phone.md index 5817826a2b..6f307c64c3 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_phone.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_phone.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Phone --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Phone ## -description Gets the phone appearance category code. ## -property-value The appearance category code for a phone Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Phone +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Phone + +## -description +Gets the phone appearance category code. + +## -property-value +The appearance category code for a phone Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_pulseoximeter.md b/windows.devices.bluetooth/bluetoothleappearancecategories_pulseoximeter.md index 9d2e28600a..7d85e66e2e 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_pulseoximeter.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_pulseoximeter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.PulseOximeter --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.PulseOximeter ## -description Gets the pulse oximeter appearance category code. ## -property-value The appearance category code for a pulse oximeter Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.PulseOximeter +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.PulseOximeter + +## -description +Gets the pulse oximeter appearance category code. + +## -property-value +The appearance category code for a pulse oximeter Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_remotecontrol.md b/windows.devices.bluetooth/bluetoothleappearancecategories_remotecontrol.md index 56a57f4c0b..0a06970728 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_remotecontrol.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_remotecontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RemoteControl --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RemoteControl ## -description Gets the remote control appearance category code. ## -property-value The appearance category code for a remote control Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RemoteControl +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RemoteControl + +## -description +Gets the remote control appearance category code. + +## -property-value +The appearance category code for a remote control Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_runningwalking.md b/windows.devices.bluetooth/bluetoothleappearancecategories_runningwalking.md index 5a397d3cf6..19f6e504cb 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_runningwalking.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_runningwalking.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RunningWalking --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RunningWalking ## -description Gets the running or walking appearance category code. ## -property-value The appearance category code for a running or walking Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RunningWalking +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.RunningWalking + +## -description +Gets the running or walking appearance category code. + +## -property-value +The appearance category code for a running or walking Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_tag.md b/windows.devices.bluetooth/bluetoothleappearancecategories_tag.md index 972cf2c5f9..510360e021 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_tag.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_tag.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Tag --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Tag ## -description Gets the tag appearance category code. ## -property-value The appearance category code for a tag Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Tag +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Tag + +## -description +Gets the tag appearance category code. + +## -property-value +The appearance category code for a tag Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_thermometer.md b/windows.devices.bluetooth/bluetoothleappearancecategories_thermometer.md index c5af6a4521..77a4adad12 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_thermometer.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_thermometer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Thermometer --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Thermometer ## -description Gets the thermometer appearance category code. ## -property-value The appearance category code for a thermometer Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Thermometer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Thermometer + +## -description +Gets the thermometer appearance category code. + +## -property-value +The appearance category code for a thermometer Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_uncategorized.md b/windows.devices.bluetooth/bluetoothleappearancecategories_uncategorized.md index 9a7c60af1d..6fa75c4bd4 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_uncategorized.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_uncategorized.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Uncategorized --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Uncategorized ## -description Gets the uncategorized appearance category code. ## -property-value The appearance category code for an uncategorized Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Uncategorized +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Uncategorized + +## -description +Gets the uncategorized appearance category code. + +## -property-value +The appearance category code for an uncategorized Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_watch.md b/windows.devices.bluetooth/bluetoothleappearancecategories_watch.md index 0257a1efb5..13c13114f1 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_watch.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_watch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Watch --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Watch ## -description Gets the watch appearance category code. ## -property-value The appearance category code for a watch Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Watch +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.Watch + +## -description +Gets the watch appearance category code. + +## -property-value +The appearance category code for a watch Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancecategories_weightscale.md b/windows.devices.bluetooth/bluetoothleappearancecategories_weightscale.md index f4e4a77cd4..e6d91a21ca 100644 --- a/windows.devices.bluetooth/bluetoothleappearancecategories_weightscale.md +++ b/windows.devices.bluetooth/bluetoothleappearancecategories_weightscale.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.WeightScale --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.WeightScale ## -description Gets the weight scale appearance category code. ## -property-value The appearance category code for a weight scale Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.WeightScale +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceCategories.WeightScale + +## -description +Gets the weight scale appearance category code. + +## -property-value +The appearance category code for a weight scale Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories.md index c1853aeef1..87312140ae 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories ## -description Indicates the appearance subcategory code of the Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories + +## -description +Indicates the appearance subcategory code of the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_barcodescanner.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_barcodescanner.md index d0b6033fef..1393bc0be0 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_barcodescanner.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_barcodescanner.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BarcodeScanner --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BarcodeScanner ## -description Gets the pulse barcode scanner appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a barcode scanner Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BarcodeScanner +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BarcodeScanner + +## -description +Gets the pulse barcode scanner appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a barcode scanner Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurearm.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurearm.md index ec3d2c8bf5..9b1f6778f2 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurearm.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurearm.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureArm --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureArm ## -description Gets the blood pressure arm appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.BloodPressure](bluetoothleappearancecategories_bloodpressure.md) appearance category. ## -property-value The appearance subcategory code for a blood pressure arm Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureArm +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureArm + +## -description +Gets the blood pressure arm appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.BloodPressure](bluetoothleappearancecategories_bloodpressure.md) appearance category. + +## -property-value +The appearance subcategory code for a blood pressure arm Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurewrist.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurewrist.md index 5033781c12..7bc1bd4d13 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurewrist.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_bloodpressurewrist.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureWrist --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureWrist ## -description Gets the blood pressure wrist appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.BloodPressure](bluetoothleappearancecategories_bloodpressure.md) appearance category. ## -property-value The appearance subcategory code for a blood pressure wrist Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureWrist +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.BloodPressureWrist + +## -description +Gets the blood pressure wrist appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.BloodPressure](bluetoothleappearancecategories_bloodpressure.md) appearance category. + +## -property-value +The appearance subcategory code for a blood pressure wrist Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cardreader.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cardreader.md index ffe4d26360..c7fd8c815a 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cardreader.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cardreader.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CardReader --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CardReader ## -description Gets the card reader appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a card reader Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CardReader +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CardReader + +## -description +Gets the card reader appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a card reader Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcadencesensor.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcadencesensor.md index 985885558d..21ca499707 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcadencesensor.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcadencesensor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingCadenceSensor --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingCadenceSensor ## -description Gets the cycling cadence sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. ## -property-value The appearance subcategory code for a cycling cadence sensor Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingCadenceSensor +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingCadenceSensor + +## -description +Gets the cycling cadence sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. + +## -property-value +The appearance subcategory code for a cycling cadence sensor Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcomputer.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcomputer.md index d1b9661513..de146c772a 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcomputer.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingcomputer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingComputer --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingComputer ## -description Gets the cycling computer appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. ## -property-value The appearance subcategory code for a cycling computer Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingComputer +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingComputer + +## -description +Gets the cycling computer appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. + +## -property-value +The appearance subcategory code for a cycling computer Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingpowersensor.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingpowersensor.md index e21ec7e04b..316f17d6c4 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingpowersensor.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingpowersensor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingPowerSensor --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingPowerSensor ## -description Gets the cycling power sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. ## -property-value The appearance subcategory code for a cycling power sensor Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingPowerSensor +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingPowerSensor + +## -description +Gets the cycling power sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. + +## -property-value +The appearance subcategory code for a cycling power sensor Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedcadencesensor.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedcadencesensor.md index 96e3dcd225..5e9ea093b2 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedcadencesensor.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedcadencesensor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedCadenceSensor --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedCadenceSensor ## -description Gets the cycling speed cadence sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. ## -property-value The appearance subcategory code for a cycling speed cadence sensor Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedCadenceSensor +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedCadenceSensor + +## -description +Gets the cycling speed cadence sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. + +## -property-value +The appearance subcategory code for a cycling speed cadence sensor Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedsensor.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedsensor.md index 48c97c5f44..7bf12b3866 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedsensor.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_cyclingspeedsensor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedSensor --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedSensor ## -description Gets the cycling speed sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. ## -property-value The appearance subcategory code for a cycling speed sensor Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedSensor +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.CyclingSpeedSensor + +## -description +Gets the cycling speed sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.Cycling](bluetoothleappearancecategories_cycling.md) appearance category. + +## -property-value +The appearance subcategory code for a cycling speed sensor Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitalpen.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitalpen.md index 7c1c7358ad..2f9824fc30 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitalpen.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitalpen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitalPen --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitalPen ## -description Gets the digital pen appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a digital pen Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitalPen +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitalPen + +## -description +Gets the digital pen appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a digital pen Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitizertablet.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitizertablet.md index 52a4b0850a..750563be63 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitizertablet.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_digitizertablet.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitizerTablet --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitizerTablet ## -description Gets the digitizer tablet appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a digitizer tablet Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitizerTablet +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.DigitizerTablet + +## -description +Gets the digitizer tablet appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a digitizer tablet Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_gamepad.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_gamepad.md index 74dff74816..6824066199 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_gamepad.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_gamepad.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Gamepad --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Gamepad ## -description Gets the gamepad appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a gamepad Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Gamepad +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Gamepad + +## -description +Gets the gamepad appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a gamepad Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_generic.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_generic.md index 10fc06baa6..f0ce45a411 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_generic.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_generic.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Generic --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Generic ## -description Gets the generic appearance subcategory code. ## -property-value The appearance subcategory code for a generic Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Generic +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Generic + +## -description +Gets the generic appearance subcategory code. + +## -property-value +The appearance subcategory code for a generic Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_heartratebelt.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_heartratebelt.md index 120b140507..3a310fde0e 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_heartratebelt.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_heartratebelt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.HeartRateBelt --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.HeartRateBelt ## -description Gets the heart rate belt appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HeartRate](bluetoothleappearancecategories_heartrate.md) appearance category. ## -property-value The appearance subcategory code for a heart rate belt Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.HeartRateBelt +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.HeartRateBelt + +## -description +Gets the heart rate belt appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HeartRate](bluetoothleappearancecategories_heartrate.md) appearance category. + +## -property-value +The appearance subcategory code for a heart rate belt Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_joystick.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_joystick.md index baddb2aaa9..07b9029bd3 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_joystick.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_joystick.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Joystick --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Joystick ## -description Gets the joystick appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a joystick Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Joystick +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Joystick + +## -description +Gets the joystick appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a joystick Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_keyboard.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_keyboard.md index b79daa8fb6..1e7f402f2e 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_keyboard.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_keyboard.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Keyboard --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Keyboard ## -description Gets the keyboard appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a keyboard Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Keyboard +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Keyboard + +## -description +Gets the keyboard appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a keyboard Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationdisplay.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationdisplay.md index b5b78780d3..413689cf15 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationdisplay.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationdisplay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationDisplay --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationDisplay ## -description Gets the location display appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. ## -property-value The appearance subcategory code for a location display Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationDisplay +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationDisplay + +## -description +Gets the location display appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. + +## -property-value +The appearance subcategory code for a location display Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationdisplay.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationdisplay.md index 3abc3086e4..9d2aee27dd 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationdisplay.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationdisplay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationDisplay --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationDisplay ## -description Gets the location navigation display appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. ## -property-value The appearance subcategory code for a location navigation display Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationDisplay +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationDisplay + +## -description +Gets the location navigation display appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. + +## -property-value +The appearance subcategory code for a location navigation display Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationpod.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationpod.md index 1f91d34afe..b944a3dd3b 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationpod.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationnavigationpod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationPod --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationPod ## -description Gets the location navigation pod appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. ## -property-value The appearance subcategory code for a location navigation pod Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationPod +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationNavigationPod + +## -description +Gets the location navigation pod appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. + +## -property-value +The appearance subcategory code for a location navigation pod Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationpod.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationpod.md index b963711634..e97ed55f08 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationpod.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_locationpod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationPod --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationPod ## -description Gets the location pod appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. ## -property-value The appearance subcategory code for a location pod Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationPod +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.LocationPod + +## -description +Gets the location pod appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.OutdoorSportActivity](bluetoothleappearancecategories_outdoorsportactivity.md) appearance category. + +## -property-value +The appearance subcategory code for a location pod Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_mouse.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_mouse.md index b98d8c68dc..1c9584b30f 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_mouse.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_mouse.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Mouse --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Mouse ## -description Gets the mouse appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. ## -property-value The appearance subcategory code for a mouse Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Mouse +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.Mouse + +## -description +Gets the mouse appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.HumanInterfaceDevice](bluetoothleappearancecategories_humaninterfacedevice.md) appearance category. + +## -property-value +The appearance subcategory code for a mouse Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterfingertip.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterfingertip.md index 430ff1f5c7..559af72a06 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterfingertip.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterfingertip.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterFingertip --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterFingertip ## -description Gets the oximeter fingertip appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.PulseOximeter](bluetoothleappearancecategories_pulseoximeter.md) appearance category. ## -property-value The appearance subcategory code for a oximeter fingertip Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterFingertip +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterFingertip + +## -description +Gets the oximeter fingertip appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.PulseOximeter](bluetoothleappearancecategories_pulseoximeter.md) appearance category. + +## -property-value +The appearance subcategory code for a oximeter fingertip Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterwristworn.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterwristworn.md index 1d654731e6..f01e34979a 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterwristworn.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_oximeterwristworn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterWristWorn --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterWristWorn ## -description Gets the oximeter wrist worn appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.PulseOximeter](bluetoothleappearancecategories_pulseoximeter.md) appearance category. ## -property-value The appearance subcategory code for a oximeter wrist worn Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterWristWorn +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.OximeterWristWorn + +## -description +Gets the oximeter wrist worn appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.PulseOximeter](bluetoothleappearancecategories_pulseoximeter.md) appearance category. + +## -property-value +The appearance subcategory code for a oximeter wrist worn Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkinginshoe.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkinginshoe.md index 2d97d682c8..c977bc51c7 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkinginshoe.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkinginshoe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingInShoe --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingInShoe ## -description Gets the running or walking in shoe appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. ## -property-value The appearance subcategory code for a running or walking in shoe Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingInShoe +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingInShoe + +## -description +Gets the running or walking in shoe appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. + +## -property-value +The appearance subcategory code for a running or walking in shoe Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonhip.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonhip.md index 10a0380c76..203deecd9b 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonhip.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonhip.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnHip --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnHip ## -description Gets the running or walking on hip appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. ## -property-value The appearance subcategory code for a running or walking on hip Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnHip +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnHip + +## -description +Gets the running or walking on hip appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. + +## -property-value +The appearance subcategory code for a running or walking on hip Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonshoe.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonshoe.md index 97edad8bd2..43ddf9617d 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonshoe.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_runningwalkingonshoe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnShoe --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnShoe ## -description Gets the running or walking on shoe appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. ## -property-value The appearance subcategory code for a running or walking on shoe Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnShoe +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.RunningWalkingOnShoe + +## -description +Gets the running or walking on shoe appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. + +## -property-value +The appearance subcategory code for a running or walking on shoe Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_sportswatch.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_sportswatch.md index 1cc35193d2..a2088781eb 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_sportswatch.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_sportswatch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.SportsWatch --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.SportsWatch ## -description Gets the sports watch appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. ## -property-value The appearance subcategory code for a sports watch Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.SportsWatch +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.SportsWatch + +## -description +Gets the sports watch appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. + +## -property-value +The appearance subcategory code for a sports watch Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothleappearancesubcategories_thermometerear.md b/windows.devices.bluetooth/bluetoothleappearancesubcategories_thermometerear.md index 06049c0458..4778fb82e8 100644 --- a/windows.devices.bluetooth/bluetoothleappearancesubcategories_thermometerear.md +++ b/windows.devices.bluetooth/bluetoothleappearancesubcategories_thermometerear.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.ThermometerEar --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.ThermometerEar ## -description Gets the ear thermometer appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. ## -property-value The appearance subcategory code for a ear thermometer Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.ThermometerEar +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEAppearanceSubcategories.ThermometerEar + +## -description +Gets the ear thermometer appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the [BluetoothLEAppearanceCategories.RunningWalking](bluetoothleappearancecategories_runningwalking.md) appearance category. + +## -property-value +The appearance subcategory code for a ear thermometer Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice.md b/windows.devices.bluetooth/bluetoothledevice.md index d0d6065d55..120839e974 100644 --- a/windows.devices.bluetooth/bluetoothledevice.md +++ b/windows.devices.bluetooth/bluetoothledevice.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothLEDevice --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothLEDevice ## -description Represents a Bluetooth LE device. ## -remarks ## -examples ## -see-also [GattDeviceService](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md), [GattDeviceService.Device](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_device.md) ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothLEDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice + +## -description +Represents a Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also +[GattDeviceService](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice.md), [GattDeviceService.Device](../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_device.md) + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_appearance.md b/windows.devices.bluetooth/bluetoothledevice_appearance.md index cd784aed15..53336dd3f4 100644 --- a/windows.devices.bluetooth/bluetoothledevice_appearance.md +++ b/windows.devices.bluetooth/bluetoothledevice_appearance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.Appearance --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.Appearance ## -description Gets the [BluetoothLEAppearance](bluetoothleappearance.md) object for the Bluetooth LE device. ## -property-value The appearance for the Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.Appearance +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.Appearance + +## -description +Gets the [BluetoothLEAppearance](bluetoothleappearance.md) object for the Bluetooth LE device. + +## -property-value +The appearance for the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_bluetoothaddress.md b/windows.devices.bluetooth/bluetoothledevice_bluetoothaddress.md index 34af50795a..250b40637b 100644 --- a/windows.devices.bluetooth/bluetoothledevice_bluetoothaddress.md +++ b/windows.devices.bluetooth/bluetoothledevice_bluetoothaddress.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddress --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddress ## -description Gets the device address. ## -property-value The address of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddress + +## -description +Gets the device address. + +## -property-value +The address of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_bluetoothaddresstype.md b/windows.devices.bluetooth/bluetoothledevice_bluetoothaddresstype.md index a6130778be..5ab5f7d55c 100644 --- a/windows.devices.bluetooth/bluetoothledevice_bluetoothaddresstype.md +++ b/windows.devices.bluetooth/bluetoothledevice_bluetoothaddresstype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddressType --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddressType ## -description Gets the address type for the Bluetooth LE device. ## -property-value The address type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddressType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothAddressType + +## -description +Gets the address type for the Bluetooth LE device. + +## -property-value +The address type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_close_811482585.md b/windows.devices.bluetooth/bluetoothledevice_close_811482585.md index d856de7398..26525f8a5b 100644 --- a/windows.devices.bluetooth/bluetoothledevice_close_811482585.md +++ b/windows.devices.bluetooth/bluetoothledevice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.Close --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.Close ## -description Closes this Bluetooth LE device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.Close + +## -description +Closes this Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_connectionstatus.md b/windows.devices.bluetooth/bluetoothledevice_connectionstatus.md index cae6042ff7..e5f09188db 100644 --- a/windows.devices.bluetooth/bluetoothledevice_connectionstatus.md +++ b/windows.devices.bluetooth/bluetoothledevice_connectionstatus.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatus --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatus ## -description Gets the connection status of the device. ## -property-value One of the BluetoothConnectionStatus enumeration values that specifies the connection status of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatus + +## -description +Gets the connection status of the device. + +## -property-value +One of the BluetoothConnectionStatus enumeration values that specifies the connection status of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_connectionstatuschanged.md b/windows.devices.bluetooth/bluetoothledevice_connectionstatuschanged.md index 6e6762507c..c9474a0b9c 100644 --- a/windows.devices.bluetooth/bluetoothledevice_connectionstatuschanged.md +++ b/windows.devices.bluetooth/bluetoothledevice_connectionstatuschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatusChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatusChanged ## -description Occurs when the connection status for the device has changed. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.ConnectionStatusChanged + +## -description +Occurs when the connection status for the device has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_deviceid.md b/windows.devices.bluetooth/bluetoothledevice_deviceid.md index 73fb27666f..de66c5c922 100644 --- a/windows.devices.bluetooth/bluetoothledevice_deviceid.md +++ b/windows.devices.bluetooth/bluetoothledevice_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceId --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceId ## -description Gets the device Id. ## -property-value The Id of the device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceId + +## -description +Gets the device Id. + +## -property-value +The Id of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_deviceinformation.md b/windows.devices.bluetooth/bluetoothledevice_deviceinformation.md index 3e83c505cd..bac75df74c 100644 --- a/windows.devices.bluetooth/bluetoothledevice_deviceinformation.md +++ b/windows.devices.bluetooth/bluetoothledevice_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceInformation --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceInformation ## -description Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the Bluetooth LE device. ## -property-value The device information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceInformation + +## -description +Gets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the Bluetooth LE device. + +## -property-value +The device information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_117221987.md b/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_117221987.md index b17a89e88f..47300d1f50 100644 --- a/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_117221987.md +++ b/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_117221987.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync ## -description Returns a [BluetoothLEDevice](bluetoothledevice.md) object for the given [BluetoothAddress](bluetoothledevice_bluetoothaddress.md). ## -parameters ### -param bluetoothAddress The address of the Bluetooth LE device. ## -returns After the asynchronous operation completes, returns the [BluetoothLEDevice](bluetoothledevice.md) object with the given [BluetoothAddress](bluetoothledevice_bluetoothaddress.md). ## -remarks ## -examples ## -see-also [FromBluetoothAddressAsync(UInt64, BluetoothAddressType)](bluetoothledevice_frombluetoothaddressasync_613922801.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync + +## -description +Returns a [BluetoothLEDevice](bluetoothledevice.md) object for the given [BluetoothAddress](bluetoothledevice_bluetoothaddress.md). + +## -parameters +### -param bluetoothAddress +The address of the Bluetooth LE device. + +## -returns +After the asynchronous operation completes, returns the [BluetoothLEDevice](bluetoothledevice.md) object with the given [BluetoothAddress](bluetoothledevice_bluetoothaddress.md). + +## -remarks + +## -examples + +## -see-also +[FromBluetoothAddressAsync(UInt64, BluetoothAddressType)](bluetoothledevice_frombluetoothaddressasync_613922801.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_613922801.md b/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_613922801.md index e23023b62d..69882c3409 100644 --- a/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_613922801.md +++ b/windows.devices.bluetooth/bluetoothledevice_frombluetoothaddressasync_613922801.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync(System.UInt64,Windows.Devices.Bluetooth.BluetoothAddressType) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync ## -description Returns a [BluetoothLEDevice](bluetoothledevice.md) object for the given [BluetoothAddress](bluetoothaddresstype.md) value and [BluetoothAddressType](bluetoothaddresstype.md) value. ## -parameters ### -param bluetoothAddress The 64-bit address of the Bluetooth LE device. ### -param bluetoothAddressType The address type of the Bluetooth LE device. ## -returns Returns an asynchronous operation that completes with the [BluetoothLEDevice](bluetoothledevice.md) object. ## -remarks ## -examples ## -see-also [FromBluetoothAddressAsync(UInt64)](bluetoothledevice_frombluetoothaddressasync_117221987.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync(System.UInt64,Windows.Devices.Bluetooth.BluetoothAddressType) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.FromBluetoothAddressAsync + +## -description +Returns a [BluetoothLEDevice](bluetoothledevice.md) object for the given [BluetoothAddress](bluetoothaddresstype.md) value and [BluetoothAddressType](bluetoothaddresstype.md) value. + +## -parameters +### -param bluetoothAddress +The 64-bit address of the Bluetooth LE device. + +### -param bluetoothAddressType +The address type of the Bluetooth LE device. + +## -returns +Returns an asynchronous operation that completes with the [BluetoothLEDevice](bluetoothledevice.md) object. + +## -remarks + +## -examples + +## -see-also +[FromBluetoothAddressAsync(UInt64)](bluetoothledevice_frombluetoothaddressasync_117221987.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_fromidasync_1322863552.md b/windows.devices.bluetooth/bluetoothledevice_fromidasync_1322863552.md index dfd886853c..a32d9ffe39 100644 --- a/windows.devices.bluetooth/bluetoothledevice_fromidasync_1322863552.md +++ b/windows.devices.bluetooth/bluetoothledevice_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.FromIdAsync ## -description Returns a BluetoothLEDevice object for the given Id. ## -parameters ### -param deviceId The Id of the Bluetooth LE device. ## -returns After the asynchronous operation completes, returns the [BluetoothLEDevice](bluetoothledevice.md) object with the given Id. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.FromIdAsync + +## -description +Returns a BluetoothLEDevice object for the given Id. + +## -parameters +### -param deviceId +The Id of the Bluetooth LE device. + +## -returns +After the asynchronous operation completes, returns the [BluetoothLEDevice](bluetoothledevice.md) object with the given Id. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_gattservices.md b/windows.devices.bluetooth/bluetoothledevice_gattservices.md index fe88efb4d2..9b187c0529 100644 --- a/windows.devices.bluetooth/bluetoothledevice_gattservices.md +++ b/windows.devices.bluetooth/bluetoothledevice_gattservices.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.GattServices --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GattServices ## -description Gets the read-only list of GATT services supported by the device. ## -property-value The read-only list of GATT services supported by this Bluetooth LE device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.GattServices +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GattServices + +## -description +Gets the read-only list of GATT services supported by the device. + +## -property-value +The read-only list of GATT services supported by this Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_gattserviceschanged.md b/windows.devices.bluetooth/bluetoothledevice_gattserviceschanged.md index b574340fef..d0edca72d8 100644 --- a/windows.devices.bluetooth/bluetoothledevice_gattserviceschanged.md +++ b/windows.devices.bluetooth/bluetoothledevice_gattserviceschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Bluetooth.BluetoothLEDevice.GattServicesChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GattServicesChanged ## -description Occurs when the list of GATT services supported by the device has changed. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.BluetoothLEDevice.GattServicesChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GattServicesChanged + +## -description +Occurs when the list of GATT services supported by the device has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselector_838466080.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselector_838466080.md index 65eabe93a0..c31f1399ec 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselector_838466080.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselector_838466080.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string for identifying all Bluetooth Low Energy (LE) devices. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method in order to get a list of Bluetooth LE devices. ## -returns The device selector for this device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying all Bluetooth Low Energy (LE) devices. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method in order to get a list of Bluetooth LE devices. + +## -returns +The device selector for this device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromappearance_1402870688.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromappearance_1402870688.md index 3a236b2e70..59da5759b4 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromappearance_1402870688.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromappearance_1402870688.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromAppearance(Windows.Devices.Bluetooth.BluetoothLEAppearance) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromAppearance ## -description Creates an Advanced Query Syntax (AQS) filter string from a [BluetoothLEAppearance](bluetoothleappearance.md) object. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects with the specified appearance. ## -parameters ### -param appearance The Bluetooth LE appearance used for constructing the AQS string. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromAppearance(Windows.Devices.Bluetooth.BluetoothLEAppearance) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromAppearance + +## -description +Creates an Advanced Query Syntax (AQS) filter string from a [BluetoothLEAppearance](bluetoothleappearance.md) object. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects with the specified appearance. + +## -parameters +### -param appearance +The Bluetooth LE appearance used for constructing the AQS string. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1273508324.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1273508324.md index 13f3509d74..8b3a9a1770 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1273508324.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1273508324.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress ## -description Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address that represents a Bluetooth LE device. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. ## -parameters ### -param bluetoothAddress A 64-bit Bluetooth LE device address used for constructing the AQS string. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also [GetDeviceSelectorFromBluetoothAddress(UInt64, BluetoothAddressType)](bluetoothledevice_getdeviceselectorfrombluetoothaddress_1770204274.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress + +## -description +Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address that represents a Bluetooth LE device. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. + +## -parameters +### -param bluetoothAddress +A 64-bit Bluetooth LE device address used for constructing the AQS string. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelectorFromBluetoothAddress(UInt64, BluetoothAddressType)](bluetoothledevice_getdeviceselectorfrombluetoothaddress_1770204274.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1770204274.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1770204274.md index bbe97f60a1..774d08f79e 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1770204274.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrombluetoothaddress_1770204274.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress(System.UInt64,Windows.Devices.Bluetooth.BluetoothAddressType) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress ## -description Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address and address type that represents a Bluetooth LE device. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -parameters ### -param bluetoothAddress A 64-bit Bluetooth LE device address used for constructing the AQS string. ### -param bluetoothAddressType The Bluetooth LE device address type. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also [GetDeviceSelectorFromBluetoothAddress(UInt64)](bluetoothledevice_getdeviceselectorfrombluetoothaddress_1273508324.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress(System.UInt64,Windows.Devices.Bluetooth.BluetoothAddressType) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromBluetoothAddress + +## -description +Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address and address type that represents a Bluetooth LE device. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -parameters +### -param bluetoothAddress +A 64-bit Bluetooth LE device address used for constructing the AQS string. + +### -param bluetoothAddressType +The Bluetooth LE device address type. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelectorFromBluetoothAddress(UInt64)](bluetoothledevice_getdeviceselectorfrombluetoothaddress_1273508324.md) \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromconnectionstatus_401358086.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromconnectionstatus_401358086.md index 2828ff364c..bd5a832ee1 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromconnectionstatus_401358086.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromconnectionstatus_401358086.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromConnectionStatus(Windows.Devices.Bluetooth.BluetoothConnectionStatus) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromConnectionStatus ## -description Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth LE devices with the indicated [BluetoothConnectionStatus](bluetoothconnectionstatus.md). The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects with the indicated Bluetooth connection status. ## -parameters ### -param connectionStatus The connection status used for constructing the AQS string. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromConnectionStatus(Windows.Devices.Bluetooth.BluetoothConnectionStatus) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromConnectionStatus + +## -description +Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth LE devices with the indicated [BluetoothConnectionStatus](bluetoothconnectionstatus.md). The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects with the indicated Bluetooth connection status. + +## -parameters +### -param connectionStatus +The connection status used for constructing the AQS string. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromdevicename_1784232756.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromdevicename_1784232756.md index 5e4310b5f0..b5b2743241 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromdevicename_1784232756.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfromdevicename_1784232756.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromDeviceName(System.String) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromDeviceName ## -description Creates an Advanced Query Syntax (AQS) filter string that contains a query for the Bluetooth LE device name. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects containing the specified Bluetooth LE device name. ## -parameters ### -param deviceName The Bluetooth LE device name used for constructing the AQS string. ## -returns An AQS string that is passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromDeviceName(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromDeviceName + +## -description +Creates an Advanced Query Syntax (AQS) filter string that contains a query for the Bluetooth LE device name. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects containing the specified Bluetooth LE device name. + +## -parameters +### -param deviceName +The Bluetooth LE device name used for constructing the AQS string. + +## -returns +An AQS string that is passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrompairingstate_446391455.md b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrompairingstate_446391455.md index b155e0e101..0caab4f168 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrompairingstate_446391455.md +++ b/windows.devices.bluetooth/bluetoothledevice_getdeviceselectorfrompairingstate_446391455.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromPairingState(System.Boolean) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromPairingState ## -description Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth LE devices that are either paired or unpaired. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. ## -parameters ### -param pairingState The current pairing state for Bluetooth LE devices used for constructing the AQS string. Bluetooth LE devices can be either paired (true) or unpaired (false). The AQS Filter string will request scanning to be performed when the pairingState is false. ## -returns An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromPairingState(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetDeviceSelectorFromPairingState + +## -description +Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth LE devices that are either paired or unpaired. The AQS string is passed into the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method to return a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects. + +## -parameters +### -param pairingState +The current pairing state for Bluetooth LE devices used for constructing the AQS string. Bluetooth LE devices can be either paired (true) or unpaired (false). The AQS Filter string will request scanning to be performed when the pairingState is false. + +## -returns +An AQS string that can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.bluetooth/bluetoothledevice_getgattservice_451005846.md b/windows.devices.bluetooth/bluetoothledevice_getgattservice_451005846.md index d40aacadd2..758cc64b12 100644 --- a/windows.devices.bluetooth/bluetoothledevice_getgattservice_451005846.md +++ b/windows.devices.bluetooth/bluetoothledevice_getgattservice_451005846.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattService(System.Guid) --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattService ## -description Returns the GATT service with the given service Id. ## -parameters ### -param serviceUuid The service Id of the GATT service. ## -returns The GATT service represented by the given service Id. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattService(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattService + +## -description +Returns the GATT service with the given service Id. + +## -parameters +### -param serviceUuid +The service Id of the GATT service. + +## -returns +The GATT service represented by the given service Id. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_name.md b/windows.devices.bluetooth/bluetoothledevice_name.md index b5b1c19e9f..d3c38245db 100644 --- a/windows.devices.bluetooth/bluetoothledevice_name.md +++ b/windows.devices.bluetooth/bluetoothledevice_name.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.Name --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.Name ## -description Gets the name of the Bluetooth LE device. ## -property-value The name of the Bluetooth LE device. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.Name +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.Name + +## -description +Gets the name of the Bluetooth LE device. + +## -property-value +The name of the Bluetooth LE device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothledevice_namechanged.md b/windows.devices.bluetooth/bluetoothledevice_namechanged.md index c5ad3f641f..7d9cb12293 100644 --- a/windows.devices.bluetooth/bluetoothledevice_namechanged.md +++ b/windows.devices.bluetooth/bluetoothledevice_namechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Bluetooth.BluetoothLEDevice.NameChanged --api-type: winrt event ---- # Windows.Devices.Bluetooth.BluetoothLEDevice.NameChanged ## -description Occurs when the name of the device has changed. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: E:Windows.Devices.Bluetooth.BluetoothLEDevice.NameChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.NameChanged + +## -description +Occurs when the name of the device has changed. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothsignalstrengthfilter.md b/windows.devices.bluetooth/bluetoothsignalstrengthfilter.md index 077f52b452..796d9c9c70 100644 --- a/windows.devices.bluetooth/bluetoothsignalstrengthfilter.md +++ b/windows.devices.bluetooth/bluetoothsignalstrengthfilter.md @@ -1,3 +1,47 @@ ---- -api-id: T:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter --api-type: winrt class ---- # Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter ## -description Groups parameters used to configure received signal strength indicator (RSSI)-based filtering. ## -remarks The [BluetoothSignalStrengthFilter](bluetoothsignalstrengthfilter.md) class only accepts a limited range for its properties. However, depending on how this class is used by an app, additional restrictions may apply. For example, the valid range for RSSI values differs between Bluetooth LE and Bluetooth BR/EDR devices. The valid range for these properties are as follows: + [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md) - The minimum threshold for an RSSI event to be considered in range. The valid range is -128 to 127. + [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) - The minimum threshold for an RSSI event to be considered out of range. The valid range is -128 to 127. + [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) - Timeout for an RSSI event to be considered out of range. The valid range is equal or greater than 1 second. + [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) - The interval at which RSSI events are sampled. The valid range is equal or greater than 0. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. There are two possible states for filtering RSSI values for any device: + In range. + Out of range. Any RSSI events are propagated if they are considered in range. This includes events with RSSI values lower or equal than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) as long as [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) has not expired. This class has additional limitations on its properties when used by the [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md) class. An exception will be thrown when the [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md) is started with parameters outside of the valid range for [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md). In general, there are three main use cases for this API:
[InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)[OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md)[OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md)[SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md)Behavior
Any<= [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)>= 10Will receive all RSSI events as they arrive as long as they are considered "in range". The events are considered "out of range" if [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires without any events or without any events with RSSI values greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md). No additional events are generated when [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires.
Any<= [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)>= 1(0, 25.5)Will receive RSSI events on a regular interval defined by [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) as long as they are considered “in range”. The RSSI value will be an average of the values of events received within a [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md). If no events are received within [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md), no event will be propagated. If [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires without any events or without any events with RSSI values greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), the events are considered “out of range” and an event with the last RSSI value received will be generated. If the last RSSI value was above [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), it is set to -127 dBm.
Any<= [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)>= 1>=25.5 (disabled)Will receive a RSSI event when the RSSI events are transitioning to "in range" from "out of range". If [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires without any events or without any events with RSSI values greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), the events are considered “out of range” and an event with the last RSSI value received will be generated. If the last RSSI value was above [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), it is set to [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md).
## -examples ## -see-also [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.SignalStrengthFilter](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_signalstrengthfilter.md) ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter + +## -description +Groups parameters used to configure received signal strength indicator (RSSI)-based filtering. + +## -remarks +The [BluetoothSignalStrengthFilter](bluetoothsignalstrengthfilter.md) class only accepts a limited range for its properties. However, depending on how this class is used by an app, additional restrictions may apply. For example, the valid range for RSSI values differs between Bluetooth LE and Bluetooth BR/EDR devices. + +The valid range for these properties are as follows: + + ++ [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md) - The minimum threshold for an RSSI event to be considered in range. The valid range is -128 to 127. ++ [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) - The minimum threshold for an RSSI event to be considered out of range. The valid range is -128 to 127. ++ [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) - Timeout for an RSSI event to be considered out of range. The valid range is equal or greater than 1 second. ++ [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) - The interval at which RSSI events are sampled. The valid range is equal or greater than 0. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. +There are two possible states for filtering RSSI values for any device: ++ In range. ++ Out of range. + Any RSSI events are propagated if they are considered in range. This includes events with RSSI values lower or equal than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) as long as [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) has not expired. + +This class has additional limitations on its properties when used by the [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md) class. An exception will be thrown when the [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md) is started with parameters outside of the valid range for [BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md). + +In general, there are three main use cases for this API: + + + + + + +
[InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)[OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md)[OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md)[SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md)Behavior
Any<= [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)>= 10Will receive all RSSI events as they arrive as long as they are considered "in range". The events are considered "out of range" if [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires without any events or without any events with RSSI values greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md). No additional events are generated when [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires.
Any<= [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)>= 1(0, 25.5)Will receive RSSI events on a regular interval defined by [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) as long as they are considered “in range”. The RSSI value will be an average of the values of events received within a [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md). If no events are received within [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md), no event will be propagated. If [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires without any events or without any events with RSSI values greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), the events are considered “out of range” and an event with the last RSSI value received will be generated. If the last RSSI value was above [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), it is set to -127 dBm.
Any<= [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md)>= 1>=25.5 (disabled)Will receive a RSSI event when the RSSI events are transitioning to "in range" from "out of range". If [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) expires without any events or without any events with RSSI values greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), the events are considered “out of range” and an event with the last RSSI value received will be generated. If the last RSSI value was above [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md), it is set to [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md).
+ +## -examples + +## -see-also +[BluetoothLEAdvertisementWatcher](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher.md), [BluetoothLEAdvertisementWatcher.SignalStrengthFilter](../windows.devices.bluetooth.advertisement/bluetoothleadvertisementwatcher_signalstrengthfilter.md) + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_bluetoothsignalstrengthfilter_1221375020.md b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_bluetoothsignalstrengthfilter_1221375020.md index 285a893896..a5e223210c 100644 --- a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_bluetoothsignalstrengthfilter_1221375020.md +++ b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_bluetoothsignalstrengthfilter_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.#ctor --api-type: winrt method ---- # Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.BluetoothSignalStrengthFilter ## -description Create a new [BluetoothSignalStrengthFilter](bluetoothsignalstrengthfilter.md) object. ## -remarks ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.BluetoothSignalStrengthFilter + +## -description +Create a new [BluetoothSignalStrengthFilter](bluetoothsignalstrengthfilter.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_inrangethresholdindbm.md b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_inrangethresholdindbm.md index d7bc4272fa..94931d4efd 100644 --- a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_inrangethresholdindbm.md +++ b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_inrangethresholdindbm.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.InRangeThresholdInDBm --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.InRangeThresholdInDBm ## -description The minimum received signal strength indicator (RSSI) value in dBm on which RSSI events will be propagated or considered in range if the previous events were considered out of range. ## -property-value The minimum RSSI value in dBm on which RSSI events will be propagated or considered in range. ## -remarks The valid range for this property is between -128 and 127. This condition still applies if no events were received since the beginning of the filtering process. The initial assumption for any device is always out of range. An event is considered in range if its RSSI value is greater than or equal to [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md) or if the previous event was considered in range and the [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) has not expired. ## -examples ## -see-also [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.InRangeThresholdInDBm +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.InRangeThresholdInDBm + +## -description +The minimum received signal strength indicator (RSSI) value in dBm on which RSSI events will be propagated or considered in range if the previous events were considered out of range. + +## -property-value +The minimum RSSI value in dBm on which RSSI events will be propagated or considered in range. + +## -remarks +The valid range for this property is between -128 and 127. + +This condition still applies if no events were received since the beginning of the filtering process. The initial assumption for any device is always out of range. An event is considered in range if its RSSI value is greater than or equal to [InRangeThresholdInDBm](bluetoothsignalstrengthfilter_inrangethresholdindbm.md) or if the previous event was considered in range and the [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) has not expired. + +## -examples + +## -see-also +[OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangethresholdindbm.md b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangethresholdindbm.md index 8d53a21bf2..592ff7e142 100644 --- a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangethresholdindbm.md +++ b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangethresholdindbm.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeThresholdInDBm --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeThresholdInDBm ## -description The minimum received signal strength indicator (RSSI) value in dBm on which RSSI events will be considered out of range. ## -property-value The minimum RSSI value in dBm on which RSSI events will be considered out of range. ## -remarks The valid range for this property is between -128 and 127. RSSI events are considered out of range after their RSSI values are kept lower than or equal to [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) within [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md). RSSI events are also considered out of range if no events are received within [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md). ## -examples ## -see-also [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeThresholdInDBm +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeThresholdInDBm + +## -description +The minimum received signal strength indicator (RSSI) value in dBm on which RSSI events will be considered out of range. + +## -property-value +The minimum RSSI value in dBm on which RSSI events will be considered out of range. + +## -remarks +The valid range for this property is between -128 and 127. + +RSSI events are considered out of range after their RSSI values are kept lower than or equal to [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) within [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md). RSSI events are also considered out of range if no events are received within [OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md). + +## -examples + +## -see-also +[OutOfRangeTimeout](bluetoothsignalstrengthfilter_outofrangetimeout.md) + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangetimeout.md b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangetimeout.md index 3a22c6e0cf..9d40945d66 100644 --- a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangetimeout.md +++ b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_outofrangetimeout.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeTimeout --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeTimeout ## -description The timeout for a received signal strength indicator (RSSI) event to be considered out of range. ## -property-value The timeout for an RSSI event to be considered out of range. ## -remarks The valid range for this property is equal or greater than 1 second. If the RSSI events are currently considered in range, this is the timeout period during which if the received RSSI events have RSSI values less than or equal to [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) or no RSSI events are received, further RSSI events will be considered out of range. This timer is reset if received RSSI values are greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md). If the events are currently out of range, this property has no effect. When applied to LE advertisements, an advertisement with the minimum RSSI value (-127) will be generated to indicate that the advertisement went out of range. ## -examples ## -see-also [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.OutOfRangeTimeout + +## -description +The timeout for a received signal strength indicator (RSSI) event to be considered out of range. + +## -property-value +The timeout for an RSSI event to be considered out of range. + +## -remarks +The valid range for this property is equal or greater than 1 second. + +If the RSSI events are currently considered in range, this is the timeout period during which if the received RSSI events have RSSI values less than or equal to [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) or no RSSI events are received, further RSSI events will be considered out of range. This timer is reset if received RSSI values are greater than [OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md). If the events are currently out of range, this property has no effect. + +When applied to LE advertisements, an advertisement with the minimum RSSI value (-127) will be generated to indicate that the advertisement went out of range. + +## -examples + +## -see-also +[OutOfRangeThresholdInDBm](bluetoothsignalstrengthfilter_outofrangethresholdindbm.md) + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_samplinginterval.md b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_samplinginterval.md index 60762763dd..3a13eeeec8 100644 --- a/windows.devices.bluetooth/bluetoothsignalstrengthfilter_samplinginterval.md +++ b/windows.devices.bluetooth/bluetoothsignalstrengthfilter_samplinginterval.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.SamplingInterval --api-type: winrt property ---- # Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.SamplingInterval ## -description The interval at which received signal strength indicator (RSSI) events are sampled. ## -property-value The interval at which RSSI events are sampled. ## -remarks The valid range for this property is equal or greater than zero. If the [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) is zero, every received RSSI event that satisfies the conditions configured through the other [BluetoothSignalStrengthFilter](bluetoothsignalstrengthfilter.md) properties will be propagated. If the sampling interval is greater than or equal to a maximum limit value (currently 25.5 seconds), sampling will be disabled and RSSI events will only be propagated on a triggered basis when they transition between in range and out of range. Otherwise, an aggregated RSSI value (average in most cases) of the RSSI events received within [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) will be propagated. If no RSSI events have been received within [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md), no RSSI events are propagated. ## -examples ## -see-also ## -capabilities bluetooth \ No newline at end of file +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.SamplingInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothSignalStrengthFilter.SamplingInterval + +## -description +The interval at which received signal strength indicator (RSSI) events are sampled. + +## -property-value +The interval at which RSSI events are sampled. + +## -remarks +The valid range for this property is equal or greater than zero. + +If the [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) is zero, every received RSSI event that satisfies the conditions configured through the other [BluetoothSignalStrengthFilter](bluetoothsignalstrengthfilter.md) properties will be propagated. If the sampling interval is greater than or equal to a maximum limit value (currently 25.5 seconds), sampling will be disabled and RSSI events will only be propagated on a triggered basis when they transition between in range and out of range. Otherwise, an aggregated RSSI value (average in most cases) of the RSSI events received within [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md) will be propagated. If no RSSI events have been received within [SamplingInterval](bluetoothsignalstrengthfilter_samplinginterval.md), no RSSI events are propagated. + +## -examples + +## -see-also + + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.custom/customdevice.md b/windows.devices.custom/customdevice.md index f9e5643693..fc2ab9c7f3 100644 --- a/windows.devices.custom/customdevice.md +++ b/windows.devices.custom/customdevice.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Custom.CustomDevice --api-type: winrt class ---- # Windows.Devices.Custom.CustomDevice ## -description Represents a custom device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Custom.CustomDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Custom.CustomDevice + +## -description +Represents a custom device. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.custom/customdevice_fromidasync_2057531694.md b/windows.devices.custom/customdevice_fromidasync_2057531694.md index f91a0b8439..0c85f1a92e 100644 --- a/windows.devices.custom/customdevice_fromidasync_2057531694.md +++ b/windows.devices.custom/customdevice_fromidasync_2057531694.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Custom.CustomDevice.FromIdAsync(System.String,Windows.Devices.Custom.DeviceAccessMode,Windows.Devices.Custom.DeviceSharingMode) --api-type: winrt method ---- # Windows.Devices.Custom.CustomDevice.FromIdAsync ## -description Creates a [CustomDevice](customdevice.md) object asynchronously for the specified [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). ## -parameters ### -param deviceId The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the device . ### -param desiredAccess The desired access. ### -param sharingMode The sharing mode. ## -returns Returns a custom device. ## -remarks ## -examples ## -see-also ## -capabilities optical \ No newline at end of file +--- +-api-id: M:Windows.Devices.Custom.CustomDevice.FromIdAsync(System.String,Windows.Devices.Custom.DeviceAccessMode,Windows.Devices.Custom.DeviceSharingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Custom.CustomDevice.FromIdAsync + +## -description +Creates a [CustomDevice](customdevice.md) object asynchronously for the specified [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the device . + +### -param desiredAccess +The desired access. + +### -param sharingMode +The sharing mode. + +## -returns +Returns a custom device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +optical \ No newline at end of file diff --git a/windows.devices.custom/customdevice_getdeviceselector_1740344150.md b/windows.devices.custom/customdevice_getdeviceselector_1740344150.md index e5efc6355c..f9685b8143 100644 --- a/windows.devices.custom/customdevice_getdeviceselector_1740344150.md +++ b/windows.devices.custom/customdevice_getdeviceselector_1740344150.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.Custom.CustomDevice.GetDeviceSelector(System.Guid) --api-type: winrt method ---- # Windows.Devices.Custom.CustomDevice.GetDeviceSelector ## -description Gets a device selector. ## -parameters ### -param classGuid The Device Interface Class GUID of the device interface to create a device selector for. ## -returns The device selector. ## -remarks For more info about the Device Interface Class GUID, see [Overview of Device Interface Classes](XREF:TODO:devinst.overview_of_device_interface_classes). ## -examples ## -see-also [Overview of Device Interface Classes](XREF:TODO:devinst.overview_of_device_interface_classes) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Custom.CustomDevice.GetDeviceSelector(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Custom.CustomDevice.GetDeviceSelector + +## -description +Gets a device selector. + +## -parameters +### -param classGuid +The Device Interface Class GUID of the device interface to create a device selector for. + +## -returns +The device selector. + +## -remarks +For more info about the Device Interface Class GUID, see [Overview of Device Interface Classes](XREF:TODO:devinst.overview_of_device_interface_classes). + +## -examples + +## -see-also +[Overview of Device Interface Classes](XREF:TODO:devinst.overview_of_device_interface_classes) \ No newline at end of file diff --git a/windows.devices.custom/customdevice_inputstream.md b/windows.devices.custom/customdevice_inputstream.md index 832457ae81..df3ee5f38d 100644 --- a/windows.devices.custom/customdevice_inputstream.md +++ b/windows.devices.custom/customdevice_inputstream.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.CustomDevice.InputStream --api-type: winrt property ---- # Windows.Devices.Custom.CustomDevice.InputStream ## -description The input stream. ## -property-value The input stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.CustomDevice.InputStream +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.CustomDevice.InputStream + +## -description +The input stream. + +## -property-value +The input stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/customdevice_outputstream.md b/windows.devices.custom/customdevice_outputstream.md index 30048d1828..51eb14b967 100644 --- a/windows.devices.custom/customdevice_outputstream.md +++ b/windows.devices.custom/customdevice_outputstream.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.CustomDevice.OutputStream --api-type: winrt property ---- # Windows.Devices.Custom.CustomDevice.OutputStream ## -description The output stream. ## -property-value The output stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.CustomDevice.OutputStream +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.CustomDevice.OutputStream + +## -description +The output stream. + +## -property-value +The output stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/customdevice_sendiocontrolasync_1607685722.md b/windows.devices.custom/customdevice_sendiocontrolasync_1607685722.md index afdb7a1b35..b164ac7dd6 100644 --- a/windows.devices.custom/customdevice_sendiocontrolasync_1607685722.md +++ b/windows.devices.custom/customdevice_sendiocontrolasync_1607685722.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Custom.CustomDevice.SendIOControlAsync(Windows.Devices.Custom.IIOControlCode,Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Custom.CustomDevice.SendIOControlAsync ## -description Sends an IO control code. ## -parameters ### -param ioControlCode The IO control code. ### -param inputBuffer The input buffer. ### -param outputBuffer The output buffer. ## -returns The result of the async operation. ## -remarks [SendIOControlAsync](customdevice_sendiocontrolasync.md) is like [TrySendIOControlAsync](customdevice_trysendiocontrolasync.md), except this method throws an exception if the operation fails. If you want to handle any exceptions that occur during the operation, use the [SendIOControlAsync](customdevice_sendiocontrolasync.md) method. If you just want to be notified whether the operation is successful, but not handle any specific exceptions, use [TrySendIOControlAsync](customdevice_trysendiocontrolasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Custom.CustomDevice.SendIOControlAsync(Windows.Devices.Custom.IIOControlCode,Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Custom.CustomDevice.SendIOControlAsync + +## -description +Sends an IO control code. + +## -parameters +### -param ioControlCode +The IO control code. + +### -param inputBuffer +The input buffer. + +### -param outputBuffer +The output buffer. + +## -returns +The result of the async operation. + +## -remarks +[SendIOControlAsync](customdevice_sendiocontrolasync.md) is like [TrySendIOControlAsync](customdevice_trysendiocontrolasync.md), except this method throws an exception if the operation fails. If you want to handle any exceptions that occur during the operation, use the [SendIOControlAsync](customdevice_sendiocontrolasync.md) method. If you just want to be notified whether the operation is successful, but not handle any specific exceptions, use [TrySendIOControlAsync](customdevice_trysendiocontrolasync.md). + +## -examples + +## -see-also diff --git a/windows.devices.custom/customdevice_trysendiocontrolasync_260174567.md b/windows.devices.custom/customdevice_trysendiocontrolasync_260174567.md index f5cf4bb56d..ef626c977a 100644 --- a/windows.devices.custom/customdevice_trysendiocontrolasync_260174567.md +++ b/windows.devices.custom/customdevice_trysendiocontrolasync_260174567.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Custom.CustomDevice.TrySendIOControlAsync(Windows.Devices.Custom.IIOControlCode,Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Custom.CustomDevice.TrySendIOControlAsync ## -description Sends an IO control code. A return value indicates whether the operation succeeded. ## -parameters ### -param ioControlCode The IO control code. ### -param inputBuffer The input buffer. ### -param outputBuffer The output buffer. ## -returns **true** if the operation is successful; otherwise, **false**. ## -remarks [TrySendIOControlAsync](customdevice_trysendiocontrolasync.md) is like [SendIOControlAsync](customdevice_sendiocontrolasync.md), except this method doesn't throw an exception if the operation fails. Instead, it returns **false**. If you want to handle any exceptions that occur during the operation, use the [SendIOControlAsync](customdevice_sendiocontrolasync.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Custom.CustomDevice.TrySendIOControlAsync(Windows.Devices.Custom.IIOControlCode,Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Custom.CustomDevice.TrySendIOControlAsync + +## -description +Sends an IO control code. A return value indicates whether the operation succeeded. + +## -parameters +### -param ioControlCode +The IO control code. + +### -param inputBuffer +The input buffer. + +### -param outputBuffer +The output buffer. + +## -returns +**true** if the operation is successful; otherwise, **false**. + +## -remarks +[TrySendIOControlAsync](customdevice_trysendiocontrolasync.md) is like [SendIOControlAsync](customdevice_sendiocontrolasync.md), except this method doesn't throw an exception if the operation fails. Instead, it returns **false**. If you want to handle any exceptions that occur during the operation, use the [SendIOControlAsync](customdevice_sendiocontrolasync.md) method. + +## -examples + +## -see-also diff --git a/windows.devices.custom/iiocontrolcode_accessmode.md b/windows.devices.custom/iiocontrolcode_accessmode.md index 1df6cc35bb..842d1614ed 100644 --- a/windows.devices.custom/iiocontrolcode_accessmode.md +++ b/windows.devices.custom/iiocontrolcode_accessmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IIOControlCode.AccessMode --api-type: winrt property ---- # Windows.Devices.Custom.IIOControlCode.AccessMode ## -description The access mode. ## -property-value The access mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IIOControlCode.AccessMode +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IIOControlCode.AccessMode + +## -description +The access mode. + +## -property-value +The access mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iiocontrolcode_bufferingmethod.md b/windows.devices.custom/iiocontrolcode_bufferingmethod.md index f5b25a0cdf..9ab5d11a89 100644 --- a/windows.devices.custom/iiocontrolcode_bufferingmethod.md +++ b/windows.devices.custom/iiocontrolcode_bufferingmethod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IIOControlCode.BufferingMethod --api-type: winrt property ---- # Windows.Devices.Custom.IIOControlCode.BufferingMethod ## -description The buffering method. ## -property-value The buffering method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IIOControlCode.BufferingMethod +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IIOControlCode.BufferingMethod + +## -description +The buffering method. + +## -property-value +The buffering method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iiocontrolcode_controlcode.md b/windows.devices.custom/iiocontrolcode_controlcode.md index 60015e7f09..6c1b88d7ef 100644 --- a/windows.devices.custom/iiocontrolcode_controlcode.md +++ b/windows.devices.custom/iiocontrolcode_controlcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IIOControlCode.ControlCode --api-type: winrt property ---- # Windows.Devices.Custom.IIOControlCode.ControlCode ## -description The control code. ## -property-value The control code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IIOControlCode.ControlCode +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IIOControlCode.ControlCode + +## -description +The control code. + +## -property-value +The control code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iiocontrolcode_devicetype.md b/windows.devices.custom/iiocontrolcode_devicetype.md index a0275e4918..ebb45e9395 100644 --- a/windows.devices.custom/iiocontrolcode_devicetype.md +++ b/windows.devices.custom/iiocontrolcode_devicetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IIOControlCode.DeviceType --api-type: winrt property ---- # Windows.Devices.Custom.IIOControlCode.DeviceType ## -description The device type. ## -property-value The device type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IIOControlCode.DeviceType +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IIOControlCode.DeviceType + +## -description +The device type. + +## -property-value +The device type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iiocontrolcode_function.md b/windows.devices.custom/iiocontrolcode_function.md index 9ca7220ae5..403db921a2 100644 --- a/windows.devices.custom/iiocontrolcode_function.md +++ b/windows.devices.custom/iiocontrolcode_function.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IIOControlCode.Function --api-type: winrt property ---- # Windows.Devices.Custom.IIOControlCode.Function ## -description The function. ## -property-value The function. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IIOControlCode.Function +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IIOControlCode.Function + +## -description +The function. + +## -property-value +The function. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iocontrolcode.md b/windows.devices.custom/iocontrolcode.md index 1f2722c712..36c5714ff6 100644 --- a/windows.devices.custom/iocontrolcode.md +++ b/windows.devices.custom/iocontrolcode.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Custom.IOControlCode --api-type: winrt class ---- # Windows.Devices.Custom.IOControlCode ## -description Represents the control code. ## -remarks ## -examples ## -see-also [IIOControlCode](iiocontrolcode.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Custom.IOControlCode +-api-type: winrt class +--- + + + +# Windows.Devices.Custom.IOControlCode + +## -description +Represents the control code. + +## -remarks + +## -examples + +## -see-also +[IIOControlCode](iiocontrolcode.md) \ No newline at end of file diff --git a/windows.devices.custom/iocontrolcode_accessmode.md b/windows.devices.custom/iocontrolcode_accessmode.md index bcfa40c560..976ab848c0 100644 --- a/windows.devices.custom/iocontrolcode_accessmode.md +++ b/windows.devices.custom/iocontrolcode_accessmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IOControlCode.AccessMode --api-type: winrt property ---- # Windows.Devices.Custom.IOControlCode.AccessMode ## -description The access mode. ## -property-value The access mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IOControlCode.AccessMode +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IOControlCode.AccessMode + +## -description +The access mode. + +## -property-value +The access mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iocontrolcode_bufferingmethod.md b/windows.devices.custom/iocontrolcode_bufferingmethod.md index d2eced6139..8194eb0a8b 100644 --- a/windows.devices.custom/iocontrolcode_bufferingmethod.md +++ b/windows.devices.custom/iocontrolcode_bufferingmethod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IOControlCode.BufferingMethod --api-type: winrt property ---- # Windows.Devices.Custom.IOControlCode.BufferingMethod ## -description The buffering method. ## -property-value The buffering method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IOControlCode.BufferingMethod +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IOControlCode.BufferingMethod + +## -description +The buffering method. + +## -property-value +The buffering method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iocontrolcode_controlcode.md b/windows.devices.custom/iocontrolcode_controlcode.md index fbfe63cb13..704d55ec44 100644 --- a/windows.devices.custom/iocontrolcode_controlcode.md +++ b/windows.devices.custom/iocontrolcode_controlcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IOControlCode.ControlCode --api-type: winrt property ---- # Windows.Devices.Custom.IOControlCode.ControlCode ## -description The control code. ## -property-value The control code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IOControlCode.ControlCode +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IOControlCode.ControlCode + +## -description +The control code. + +## -property-value +The control code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iocontrolcode_devicetype.md b/windows.devices.custom/iocontrolcode_devicetype.md index 9529887542..273b3b2885 100644 --- a/windows.devices.custom/iocontrolcode_devicetype.md +++ b/windows.devices.custom/iocontrolcode_devicetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IOControlCode.DeviceType --api-type: winrt property ---- # Windows.Devices.Custom.IOControlCode.DeviceType ## -description The device type. ## -property-value The device type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IOControlCode.DeviceType +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IOControlCode.DeviceType + +## -description +The device type. + +## -property-value +The device type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iocontrolcode_function.md b/windows.devices.custom/iocontrolcode_function.md index f8bbd5cd7b..010f64fb73 100644 --- a/windows.devices.custom/iocontrolcode_function.md +++ b/windows.devices.custom/iocontrolcode_function.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.IOControlCode.Function --api-type: winrt property ---- # Windows.Devices.Custom.IOControlCode.Function ## -description The function. ## -property-value The function. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.IOControlCode.Function +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.IOControlCode.Function + +## -description +The function. + +## -property-value +The function. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/iocontrolcode_iocontrolcode_2090250203.md b/windows.devices.custom/iocontrolcode_iocontrolcode_2090250203.md index 40a2321149..b2f5ea50ed 100644 --- a/windows.devices.custom/iocontrolcode_iocontrolcode_2090250203.md +++ b/windows.devices.custom/iocontrolcode_iocontrolcode_2090250203.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Custom.IOControlCode.#ctor(System.UInt16,System.UInt16,Windows.Devices.Custom.IOControlAccessMode,Windows.Devices.Custom.IOControlBufferingMethod) --api-type: winrt method ---- # Windows.Devices.Custom.IOControlCode.IOControlCode ## -description The control code. ## -parameters ### -param deviceType The device type. ### -param function The device function. ### -param accessMode The access mode. ### -param bufferingMethod The buffering method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Custom.IOControlCode.#ctor(System.UInt16,System.UInt16,Windows.Devices.Custom.IOControlAccessMode,Windows.Devices.Custom.IOControlBufferingMethod) +-api-type: winrt method +--- + + + +# Windows.Devices.Custom.IOControlCode.IOControlCode + +## -description +The control code. + +## -parameters +### -param deviceType +The device type. + +### -param function +The device function. + +### -param accessMode +The access mode. + +### -param bufferingMethod +The buffering method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.custom/knowndevicetypes.md b/windows.devices.custom/knowndevicetypes.md index 2f63379ec0..ad540332b4 100644 --- a/windows.devices.custom/knowndevicetypes.md +++ b/windows.devices.custom/knowndevicetypes.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Custom.KnownDeviceTypes --api-type: winrt class ---- # Windows.Devices.Custom.KnownDeviceTypes ## -description Represents know device types. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Custom.KnownDeviceTypes +-api-type: winrt class +--- + + + +# Windows.Devices.Custom.KnownDeviceTypes + +## -description +Represents know device types. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.custom/knowndevicetypes_unknown.md b/windows.devices.custom/knowndevicetypes_unknown.md index 95951e3600..caac502f0f 100644 --- a/windows.devices.custom/knowndevicetypes_unknown.md +++ b/windows.devices.custom/knowndevicetypes_unknown.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Custom.KnownDeviceTypes.Unknown --api-type: winrt property ---- # Windows.Devices.Custom.KnownDeviceTypes.Unknown ## -description Defined by the device vendor. ## -property-value Defined by the device vendor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Custom.KnownDeviceTypes.Unknown +-api-type: winrt property +--- + + + +# Windows.Devices.Custom.KnownDeviceTypes.Unknown + +## -description +Defined by the device vendor. + +## -property-value +Defined by the device vendor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobject_createfromidasync_1267380005.md b/windows.devices.enumeration.pnp/pnpobject_createfromidasync_1267380005.md index 05ac313295..19af2e8485 100644 --- a/windows.devices.enumeration.pnp/pnpobject_createfromidasync_1267380005.md +++ b/windows.devices.enumeration.pnp/pnpobject_createfromidasync_1267380005.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.CreateFromIdAsync(Windows.Devices.Enumeration.Pnp.PnpObjectType,System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObject.CreateFromIdAsync ## -description Creates a [PnpObject](pnpobject.md) object asynchronously from a previously saved [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID. ## -parameters ### -param type The type of the [PnpObject](pnpobject.md). ### -param id The string value identifying the [PnpObject](pnpobject.md). ### -param requestedProperties An iterable list of additional properties to include in the [Properties](../windows.devices.enumeration/deviceinformation_properties.md) property of the [PnpObject](pnpobject.md) object to create. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -returns The [PnpObject](pnpobject.md) created from the previously saved [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.CreateFromIdAsync(Windows.Devices.Enumeration.Pnp.PnpObjectType,System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.CreateFromIdAsync + +## -description +Creates a [PnpObject](pnpobject.md) object asynchronously from a previously saved [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID. + +## -parameters +### -param type +The type of the [PnpObject](pnpobject.md). + +### -param id +The string value identifying the [PnpObject](pnpobject.md). + +### -param requestedProperties +An iterable list of additional properties to include in the [Properties](../windows.devices.enumeration/deviceinformation_properties.md) property of the [PnpObject](pnpobject.md) object to create. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -returns +The [PnpObject](pnpobject.md) created from the previously saved [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobject_createwatcher_1842907357.md b/windows.devices.enumeration.pnp/pnpobject_createwatcher_1842907357.md index 25b698fadf..3831db1f97 100644 --- a/windows.devices.enumeration.pnp/pnpobject_createwatcher_1842907357.md +++ b/windows.devices.enumeration.pnp/pnpobject_createwatcher_1842907357.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher ## -description Returns a [PnpObjectWatcher](pnpobjectwatcher.md) object that is used to enumerate a filtered collection of PnP objects using events. ## -parameters ### -param type The type of the [PnpObject](pnpobject.md). ### -param requestedProperties An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ### -param aqsFilter An AQS string that filters the PnP objects that will be returned. Typically, this string is retrieved from the method of a class that interacts with devices. ## -returns A [PnpObjectWatcher](pnpobjectwatcher.md) object used to enumerate the collection by registering event notification delegates and by issuing start and stop event notifications. ## -remarks ## -examples ## -see-also [CreateWatcher(PnpObjectType, IIterable_1)](pnpobject_createwatcher_199191645.md), [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher + +## -description +Returns a [PnpObjectWatcher](pnpobjectwatcher.md) object that is used to enumerate a filtered collection of PnP objects using events. + +## -parameters +### -param type +The type of the [PnpObject](pnpobject.md). + +### -param requestedProperties +An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +### -param aqsFilter +An AQS string that filters the PnP objects that will be returned. Typically, this string is retrieved from the method of a class that interacts with devices. + +## -returns +A [PnpObjectWatcher](pnpobjectwatcher.md) object used to enumerate the collection by registering event notification delegates and by issuing start and stop event notifications. + +## -remarks + +## -examples + +## -see-also +[CreateWatcher(PnpObjectType, IIterable_1)](pnpobject_createwatcher_199191645.md), [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobject_createwatcher_199191645.md b/windows.devices.enumeration.pnp/pnpobject_createwatcher_199191645.md index 8deba663f0..198b2d0b35 100644 --- a/windows.devices.enumeration.pnp/pnpobject_createwatcher_199191645.md +++ b/windows.devices.enumeration.pnp/pnpobject_createwatcher_199191645.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher ## -description Returns a [PnpObjectWatcher](pnpobjectwatcher.md) object that is used to enumerate the PnP objects in the collection using events. ## -parameters ### -param type The type of the [PnpObject](pnpobject.md). ### -param requestedProperties An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -returns A [PnpObjectWatcher](pnpobjectwatcher.md) object used to enumerate the collection by registering event notification delegates and by issuing start and stop event notifications. ## -remarks [CreateWatcher](pnpobject_createwatcher.md) is a primary starting point method for enumerating device objects. A client should use this API to enumerate [PnpObject](pnpobject.md) s if they want the enumeration to happen incrementally, or if they want the results to be updated as things change. For example, if a [PnpObject](pnpobject.md) is added, removed or its properties are updated, the client will register event handlers with the returned watcher object to receive the enumerated [PnpObject](pnpobject.md) as well as the later updates. ## -examples ## -see-also [CreateWatcher(PnpObjectType, IIterable_1, String)](pnpobject_createwatcher_1842907357.md), [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.CreateWatcher + +## -description +Returns a [PnpObjectWatcher](pnpobjectwatcher.md) object that is used to enumerate the PnP objects in the collection using events. + +## -parameters +### -param type +The type of the [PnpObject](pnpobject.md). + +### -param requestedProperties +An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -returns +A [PnpObjectWatcher](pnpobjectwatcher.md) object used to enumerate the collection by registering event notification delegates and by issuing start and stop event notifications. + +## -remarks +[CreateWatcher](pnpobject_createwatcher.md) is a primary starting point method for enumerating device objects. A client should use this API to enumerate [PnpObject](pnpobject.md) s if they want the enumeration to happen incrementally, or if they want the results to be updated as things change. For example, if a [PnpObject](pnpobject.md) is added, removed or its properties are updated, the client will register event handlers with the returned watcher object to receive the enumerated [PnpObject](pnpobject.md) as well as the later updates. + +## -examples + +## -see-also +[CreateWatcher(PnpObjectType, IIterable_1, String)](pnpobject_createwatcher_1842907357.md), [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobject_findallasync_1097308762.md b/windows.devices.enumeration.pnp/pnpobject_findallasync_1097308762.md index 36f4196266..415e941494 100644 --- a/windows.devices.enumeration.pnp/pnpobject_findallasync_1097308762.md +++ b/windows.devices.enumeration.pnp/pnpobject_findallasync_1097308762.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync ## -description Returns all of the PnP objects of a specified type that match the specified criteria. ## -parameters ### -param type The type of the [PnpObject](pnpobject.md). ### -param requestedProperties An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -returns An object that represents the asynchronous operation. ## -remarks ## -examples ## -see-also [FindAllAsync(PnpObjectType, IIterable_1, String)](pnpobject_findallasync_660635354.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync + +## -description +Returns all of the PnP objects of a specified type that match the specified criteria. + +## -parameters +### -param type +The type of the [PnpObject](pnpobject.md). + +### -param requestedProperties +An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -returns +An object that represents the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync(PnpObjectType, IIterable_1, String)](pnpobject_findallasync_660635354.md) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobject_findallasync_660635354.md b/windows.devices.enumeration.pnp/pnpobject_findallasync_660635354.md index 5a964bb5e0..a19441b856 100644 --- a/windows.devices.enumeration.pnp/pnpobject_findallasync_660635354.md +++ b/windows.devices.enumeration.pnp/pnpobject_findallasync_660635354.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync ## -description Returns all of the PnP objects of a specified type that match the specified filter. ## -parameters ### -param type The type of the [PnpObject](pnpobject.md). ### -param requestedProperties An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ### -param aqsFilter An AQS string that filters the PnP objects that will be returned. Typically, this string is retrieved from the method of a class that interacts with devices. ## -returns An object that represents the asynchronous operation. ## -remarks ## -examples ## -see-also [FindAllAsync(PnpObjectType, IIterable_1)](pnpobject_findallasync_1097308762.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync(Windows.Devices.Enumeration.Pnp.PnpObjectType,Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.FindAllAsync + +## -description +Returns all of the PnP objects of a specified type that match the specified filter. + +## -parameters +### -param type +The type of the [PnpObject](pnpobject.md). + +### -param requestedProperties +An iterable list of additional properties to include in the [Properties](pnpobject_properties.md) property of the [PnpObject](pnpobject.md) objects included in enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +### -param aqsFilter +An AQS string that filters the PnP objects that will be returned. Typically, this string is retrieved from the method of a class that interacts with devices. + +## -returns +An object that represents the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync(PnpObjectType, IIterable_1)](pnpobject_findallasync_1097308762.md) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobject_id.md b/windows.devices.enumeration.pnp/pnpobject_id.md index 0e48d266cd..8d5554db07 100644 --- a/windows.devices.enumeration.pnp/pnpobject_id.md +++ b/windows.devices.enumeration.pnp/pnpobject_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObject.Id --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObject.Id ## -description A string representing the identity of the [PnpObject](pnpobject.md). ## -property-value The identity string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObject.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.Id + +## -description +A string representing the identity of the [PnpObject](pnpobject.md). + +## -property-value +The identity string. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobject_properties.md b/windows.devices.enumeration.pnp/pnpobject_properties.md index 1a14ed06c1..f24b013e77 100644 --- a/windows.devices.enumeration.pnp/pnpobject_properties.md +++ b/windows.devices.enumeration.pnp/pnpobject_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObject.Properties --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObject.Properties ## -description A property store containing well-known values as well as additional specified properties. ## -property-value A pointer to the property store. ## -remarks For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObject.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.Properties + +## -description +A property store containing well-known values as well as additional specified properties. + +## -property-value +A pointer to the property store. + +## -remarks +For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobject_type.md b/windows.devices.enumeration.pnp/pnpobject_type.md index 184ecabbad..96d4da436e 100644 --- a/windows.devices.enumeration.pnp/pnpobject_type.md +++ b/windows.devices.enumeration.pnp/pnpobject_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObject.Type --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObject.Type ## -description The type of the [PnpObject](pnpobject.md). ## -property-value The type of the object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObject.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.Type + +## -description +The type of the [PnpObject](pnpobject.md). + +## -property-value +The type of the object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobject_update_414576016.md b/windows.devices.enumeration.pnp/pnpobject_update_414576016.md index 48cae74d08..17d766dabd 100644 --- a/windows.devices.enumeration.pnp/pnpobject_update_414576016.md +++ b/windows.devices.enumeration.pnp/pnpobject_update_414576016.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.Update(Windows.Devices.Enumeration.Pnp.PnpObjectUpdate) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObject.Update ## -description Updates the properties of an existing [PnpObject](pnpobject.md) by applying the changes described in a [PnpObjectUpdate](pnpobjectupdate.md) object. ## -parameters ### -param updateInfo Indicates the properties to update. ## -remarks ## -examples ## -see-also [PnpObjectUpdate](pnpobjectupdate.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObject.Update(Windows.Devices.Enumeration.Pnp.PnpObjectUpdate) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObject.Update + +## -description +Updates the properties of an existing [PnpObject](pnpobject.md) by applying the changes described in a [PnpObjectUpdate](pnpobjectupdate.md) object. + +## -parameters +### -param updateInfo +Indicates the properties to update. + +## -remarks + +## -examples + +## -see-also +[PnpObjectUpdate](pnpobjectupdate.md) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobjectcollection_first_1920739956.md b/windows.devices.enumeration.pnp/pnpobjectcollection_first_1920739956.md index 1aa9131309..14e567eab6 100644 --- a/windows.devices.enumeration.pnp/pnpobjectcollection_first_1920739956.md +++ b/windows.devices.enumeration.pnp/pnpobjectcollection_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.First --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObjectCollection.First ## -description Returns the iterator for iteration over the items in the collection. ## -returns The iterator object. The iterator's current position is at the 0-index position, or at the end of the collection if the collection is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.First +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectCollection.First + +## -description +Returns the iterator for iteration over the items in the collection. + +## -returns +The iterator object. The iterator's current position is at the 0-index position, or at the end of the collection if the collection is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectcollection_getat_496709656.md b/windows.devices.enumeration.pnp/pnpobjectcollection_getat_496709656.md index 5cb6a4429f..15c0883390 100644 --- a/windows.devices.enumeration.pnp/pnpobjectcollection_getat_496709656.md +++ b/windows.devices.enumeration.pnp/pnpobjectcollection_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetAt ## -description Returns the [PnpObject](pnpobject.md) located at the specified index. ## -parameters ### -param index The integer index for the value to retrieve. ## -returns The [PnpObject](pnpobject.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetAt + +## -description +Returns the [PnpObject](pnpobject.md) located at the specified index. + +## -parameters +### -param index +The integer index for the value to retrieve. + +## -returns +The [PnpObject](pnpobject.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectcollection_getmany_736635870.md b/windows.devices.enumeration.pnp/pnpobjectcollection_getmany_736635870.md index 7bfae9e3ba..a005d04b38 100644 --- a/windows.devices.enumeration.pnp/pnpobjectcollection_getmany_736635870.md +++ b/windows.devices.enumeration.pnp/pnpobjectcollection_getmany_736635870.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetMany(System.UInt32,Windows.Devices.Enumeration.Pnp.PnpObject[]) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetMany ## -description Retrieves multiple elements in a single pass through the iterator. ## -parameters ### -param startIndex The index from which to start retrieval. ### -param items Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. ## -returns The number of items retrieved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetMany(System.UInt32,Windows.Devices.Enumeration.Pnp.PnpObject[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectCollection.GetMany + +## -description +Retrieves multiple elements in a single pass through the iterator. + +## -parameters +### -param startIndex +The index from which to start retrieval. + +### -param items +Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. + +## -returns +The number of items retrieved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectcollection_indexof_32729408.md b/windows.devices.enumeration.pnp/pnpobjectcollection_indexof_32729408.md index 50ef205b08..2d002d3ea9 100644 --- a/windows.devices.enumeration.pnp/pnpobjectcollection_indexof_32729408.md +++ b/windows.devices.enumeration.pnp/pnpobjectcollection_indexof_32729408.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.IndexOf(Windows.Devices.Enumeration.Pnp.PnpObject,System.UInt32@) --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObjectCollection.IndexOf ## -description Retrieves the index of the specified item. ## -parameters ### -param value The value to find in the collection. ### -param index The index of the item to find, if found. ## -returns True if an item with the specified value was found; otherwise, False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.IndexOf(Windows.Devices.Enumeration.Pnp.PnpObject,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectCollection.IndexOf + +## -description +Retrieves the index of the specified item. + +## -parameters +### -param value +The value to find in the collection. + +### -param index +The index of the item to find, if found. + +## -returns +True if an item with the specified value was found; otherwise, False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectcollection_size.md b/windows.devices.enumeration.pnp/pnpobjectcollection_size.md index a76487ee62..98e0873668 100644 --- a/windows.devices.enumeration.pnp/pnpobjectcollection_size.md +++ b/windows.devices.enumeration.pnp/pnpobjectcollection_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.Size --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObjectCollection.Size ## -description Returns the number of items in the collection. ## -property-value The number of items in the collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectCollection.Size +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectCollection.Size + +## -description +Returns the number of items in the collection. + +## -property-value +The number of items in the collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectupdate_id.md b/windows.devices.enumeration.pnp/pnpobjectupdate_id.md index f1c0edba69..49f742d2f6 100644 --- a/windows.devices.enumeration.pnp/pnpobjectupdate_id.md +++ b/windows.devices.enumeration.pnp/pnpobjectupdate_id.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Id --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Id ## -description The identifier of the [PnpObject](pnpobject.md). ## -property-value The identifier of the [PnpObject](pnpobject.md). ## -remarks ## -examples ## -see-also [PnpObject](pnpobject.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Id + +## -description +The identifier of the [PnpObject](pnpobject.md). + +## -property-value +The identifier of the [PnpObject](pnpobject.md). + +## -remarks + + +## -examples + +## -see-also +[PnpObject](pnpobject.md) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobjectupdate_properties.md b/windows.devices.enumeration.pnp/pnpobjectupdate_properties.md index 2957792998..2e0236f62c 100644 --- a/windows.devices.enumeration.pnp/pnpobjectupdate_properties.md +++ b/windows.devices.enumeration.pnp/pnpobjectupdate_properties.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Properties --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Properties ## -description The changed properties in an update to a [PnpObject](pnpobject.md). ## -property-value The changed properties. ## -remarks For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -examples ## -see-also [PnpObject](pnpobject.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Properties + +## -description +The changed properties in an update to a [PnpObject](pnpobject.md). + +## -property-value +The changed properties. + +## -remarks +For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -examples + +## -see-also +[PnpObject](pnpobject.md) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobjectupdate_type.md b/windows.devices.enumeration.pnp/pnpobjectupdate_type.md index 4bb235b33c..e45b9a72ed 100644 --- a/windows.devices.enumeration.pnp/pnpobjectupdate_type.md +++ b/windows.devices.enumeration.pnp/pnpobjectupdate_type.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Type --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Type ## -description The type of the [PnpObject](pnpobject.md). One of the values of the [PnpObjectType](pnpobjecttype.md) enumeration. ## -property-value The type of the [PnpObject](pnpobject.md). ## -remarks ## -examples ## -see-also [PnpObject](pnpobject.md), [PnpObjectType](pnpobjecttype.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectUpdate.Type + +## -description +The type of the [PnpObject](pnpobject.md). One of the values of the [PnpObjectType](pnpobjecttype.md) enumeration. + +## -property-value +The type of the [PnpObject](pnpobject.md). + +## -remarks + + +## -examples + +## -see-also +[PnpObject](pnpobject.md), [PnpObjectType](pnpobjecttype.md) \ No newline at end of file diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_added.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_added.md index 77bf045d95..f98b7d134c 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_added.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_added.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Added --api-type: winrt event ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Added ## -description Occurs when a [PnpObject](pnpobject.md) is added to the collection enumerated by the [PnpObjectWatcher](pnpobjectwatcher.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Added +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Added + +## -description +Occurs when a [PnpObject](pnpobject.md) is added to the collection enumerated by the [PnpObjectWatcher](pnpobjectwatcher.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_enumerationcompleted.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_enumerationcompleted.md index 2994a5d13f..497c886aa0 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_enumerationcompleted.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_enumerationcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.EnumerationCompleted --api-type: winrt event ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.EnumerationCompleted ## -description Occurs when the enumeration of Pnp device objects has been completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.EnumerationCompleted + +## -description +Occurs when the enumeration of Pnp device objects has been completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_removed.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_removed.md index f23ad262f6..84e173feeb 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_removed.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_removed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Removed --api-type: winrt event ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Removed ## -description Occurs when a [PnpObject](pnpobject.md) is removed from the collection enumerated by the [PnpObjectWatcher](pnpobjectwatcher.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Removed + +## -description +Occurs when a [PnpObject](pnpobject.md) is removed from the collection enumerated by the [PnpObjectWatcher](pnpobjectwatcher.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_start_1587696324.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_start_1587696324.md index 50ad4fc68e..d39ff0b5c3 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_start_1587696324.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_start_1587696324.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Start --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Start ## -description Starts raising the events to inform the client that a [PnpObject](pnpobject.md) has been added, updated, or removed. ## -remarks An app calls [Start](pnpobjectwatcher_start.md) to begin the search for devices. During this intial enumeration, the [PnpObjectWatcher](pnpobjectwatcher.md) raises an [Added](pnpobjectwatcher_added.md) event for each device that's found, until all devices are found. The [PnpObjectWatcher](pnpobjectwatcher.md) raises an [EnumerationCompleted](pnpobjectwatcher_enumerationcompleted.md) event when the initial enumeration is complete, and continues to raise events if a device is added, updated, or removed. The [Start](pnpobjectwatcher_start.md) method can only be called when the [PnpObjectWatcher](pnpobjectwatcher.md) is in the **Created**, **Stopped** or **Aborted** state. The [Status](pnpobjectwatcher_status.md) property indicates the [PnpObjectWatcher](pnpobjectwatcher.md) state. When re-starting the watcher, wait for the [Stopped](pnpobjectwatcher_stopped.md) event before calling [Start](pnpobjectwatcher_start.md). The following diagram shows how the [PnpObjectWatcher](pnpobjectwatcher.md) transitions between the states represented by [DeviceWatcherStatus](../windows.devices.enumeration/devicewatcherstatus.md) enumeration. state diagram of DeviceWatcher states ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Start + +## -description +Starts raising the events to inform the client that a [PnpObject](pnpobject.md) has been added, updated, or removed. + +## -remarks +An app calls [Start](pnpobjectwatcher_start.md) to begin the search for devices. During this intial enumeration, the [PnpObjectWatcher](pnpobjectwatcher.md) raises an [Added](pnpobjectwatcher_added.md) event for each device that's found, until all devices are found. The [PnpObjectWatcher](pnpobjectwatcher.md) raises an [EnumerationCompleted](pnpobjectwatcher_enumerationcompleted.md) event when the initial enumeration is complete, and continues to raise events if a device is added, updated, or removed. + +The [Start](pnpobjectwatcher_start.md) method can only be called when the [PnpObjectWatcher](pnpobjectwatcher.md) is in the **Created**, **Stopped** or **Aborted** state. The [Status](pnpobjectwatcher_status.md) property indicates the [PnpObjectWatcher](pnpobjectwatcher.md) state. When re-starting the watcher, wait for the [Stopped](pnpobjectwatcher_stopped.md) event before calling [Start](pnpobjectwatcher_start.md). + +The following diagram shows how the [PnpObjectWatcher](pnpobjectwatcher.md) transitions between the states represented by [DeviceWatcherStatus](../windows.devices.enumeration/devicewatcherstatus.md) enumeration. + +state diagram of DeviceWatcher states + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_status.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_status.md index 9bd9ac5324..7f3be17a3b 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_status.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Status --api-type: winrt property ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Status ## -description The status associated with the asynchronous operation. ## -property-value The status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Status + +## -description +The status associated with the asynchronous operation. + +## -property-value +The status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_stop_1201535524.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_stop_1201535524.md index a5baaa82ac..bbf2b86a6b 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_stop_1201535524.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_stop_1201535524.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stop --api-type: winrt method ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stop ## -description Stops raising the events to inform the client that a [PnpObject](pnpobject.md) has been added, updated, or removed. ## -remarks To stop a search for devices, an app calls [Stop](pnpobjectwatcher_stop.md). This call transitions the [PnpObjectWatcher](pnpobjectwatcher.md) to the **Stopping** state and completes immediately. The watcher will transition to the **Stopped** state once all events that are already in the process of being raised have completed. Callers may wait for the [Stopped](pnpobjectwatcher_stopped.md) event if they need to know when the [PnpObjectWatcher](pnpobjectwatcher.md) has stopped. Callers must wait for the [Stopped](pnpobjectwatcher_stopped.md) event before they can call [Start](pnpobjectwatcher_start.md) to restart the watcher. Callers may unsubscribe from events if they do not want to receive any additional events after [Stop](pnpobjectwatcher_stop.md) but do not want to wait for the [Stopped](pnpobjectwatcher_stopped.md) event. The following diagram shows how the [PnpObjectWatcher](pnpobjectwatcher.md) transitions between the states represented by [DeviceWatcherStatus](../windows.devices.enumeration/devicewatcherstatus.md) enumeration. state diagram of DeviceWatcher states ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stop + +## -description +Stops raising the events to inform the client that a [PnpObject](pnpobject.md) has been added, updated, or removed. + +## -remarks +To stop a search for devices, an app calls [Stop](pnpobjectwatcher_stop.md). + +This call transitions the [PnpObjectWatcher](pnpobjectwatcher.md) to the **Stopping** state and completes immediately. The watcher will transition to the **Stopped** state once all events that are already in the process of being raised have completed. + +Callers may wait for the [Stopped](pnpobjectwatcher_stopped.md) event if they need to know when the [PnpObjectWatcher](pnpobjectwatcher.md) has stopped. Callers must wait for the [Stopped](pnpobjectwatcher_stopped.md) event before they can call [Start](pnpobjectwatcher_start.md) to restart the watcher. Callers may unsubscribe from events if they do not want to receive any additional events after [Stop](pnpobjectwatcher_stop.md) but do not want to wait for the [Stopped](pnpobjectwatcher_stopped.md) event. + +The following diagram shows how the [PnpObjectWatcher](pnpobjectwatcher.md) transitions between the states represented by [DeviceWatcherStatus](../windows.devices.enumeration/devicewatcherstatus.md) enumeration. + +state diagram of DeviceWatcher states + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_stopped.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_stopped.md index 1e94160223..821287736e 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_stopped.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stopped --api-type: winrt event ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stopped ## -description Occurs when the [PnpObjectWatcher](pnpobjectwatcher.md) has stopped monitoring changes to the collection of Pnp device objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Stopped + +## -description +Occurs when the [PnpObjectWatcher](pnpobjectwatcher.md) has stopped monitoring changes to the collection of Pnp device objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration.pnp/pnpobjectwatcher_updated.md b/windows.devices.enumeration.pnp/pnpobjectwatcher_updated.md index 7bce6d79d8..bb9023a707 100644 --- a/windows.devices.enumeration.pnp/pnpobjectwatcher_updated.md +++ b/windows.devices.enumeration.pnp/pnpobjectwatcher_updated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Updated --api-type: winrt event ---- # Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Updated ## -description Occurs when the properties of a [PnpObject](pnpobject.md) in the collection enumerated by the [PnpObjectWatcher](pnpobjectwatcher.md) are updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Updated +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.Pnp.PnpObjectWatcher.Updated + +## -description +Occurs when the properties of a [PnpObject](pnpobject.md) in the collection enumerated by the [PnpObjectWatcher](pnpobjectwatcher.md) are updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccesschangedeventargs.md b/windows.devices.enumeration/deviceaccesschangedeventargs.md index 4f9fc37282..c2b3abbbe9 100644 --- a/windows.devices.enumeration/deviceaccesschangedeventargs.md +++ b/windows.devices.enumeration/deviceaccesschangedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceAccessChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceAccessChangedEventArgs ## -description Provides data for the [AccessChanged](deviceaccessinformation_accesschanged.md) event. ## -remarks This object is not instantiated directly, it is created by the [AccessChanged](deviceaccessinformation_accesschanged.md) event and is returned as an argument to the [AccessChanged](deviceaccessinformation_accesschanged.md) event handler. > [!NOTE] > : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see [Threading and Marshaling (C++/CX)](http://go.microsoft.com/fwlink/p/?linkid=258275) and [Using Windows Runtime objects in a multithreaded environment (.NET)](http://go.microsoft.com/fwlink/p/?linkid=258277). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceAccessChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceAccessChangedEventArgs + +## -description +Provides data for the [AccessChanged](deviceaccessinformation_accesschanged.md) event. + +## -remarks +This object is not instantiated directly, it is created by the [AccessChanged](deviceaccessinformation_accesschanged.md) event and is returned as an argument to the [AccessChanged](deviceaccessinformation_accesschanged.md) event handler. + +> [!NOTE] +> : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see [Threading and Marshaling (C++/CX)](http://go.microsoft.com/fwlink/p/?linkid=258275) and [Using Windows Runtime objects in a multithreaded environment (.NET)](http://go.microsoft.com/fwlink/p/?linkid=258277). + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccesschangedeventargs_id.md b/windows.devices.enumeration/deviceaccesschangedeventargs_id.md index bb75427dfb..72f45419c4 100644 --- a/windows.devices.enumeration/deviceaccesschangedeventargs_id.md +++ b/windows.devices.enumeration/deviceaccesschangedeventargs_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Id --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Id ## -description Gets the [DeviceInformation](deviceinformation.md) ID of the device referenced by [DeviceAccessChangedEventArgs](deviceaccesschangedeventargs.md). ## -property-value The [DeviceInformation](deviceinformation.md) ID for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Id + +## -description +Gets the [DeviceInformation](deviceinformation.md) ID of the device referenced by [DeviceAccessChangedEventArgs](deviceaccesschangedeventargs.md). + +## -property-value +The [DeviceInformation](deviceinformation.md) ID for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccesschangedeventargs_status.md b/windows.devices.enumeration/deviceaccesschangedeventargs_status.md index 39472bc8e0..a4e3b49247 100644 --- a/windows.devices.enumeration/deviceaccesschangedeventargs_status.md +++ b/windows.devices.enumeration/deviceaccesschangedeventargs_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Status ## -description The new status of access to a device. ## -property-value The new status of access to a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceAccessChangedEventArgs.Status + +## -description +The new status of access to a device. + +## -property-value +The new status of access to a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccessinformation.md b/windows.devices.enumeration/deviceaccessinformation.md index d56ff6837d..f8e5c14b2e 100644 --- a/windows.devices.enumeration/deviceaccessinformation.md +++ b/windows.devices.enumeration/deviceaccessinformation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceAccessInformation --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceAccessInformation ## -description Contains the information about access to a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceAccessInformation +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceAccessInformation + +## -description +Contains the information about access to a device. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccessinformation_accesschanged.md b/windows.devices.enumeration/deviceaccessinformation_accesschanged.md index 0311b4805f..135f241121 100644 --- a/windows.devices.enumeration/deviceaccessinformation_accesschanged.md +++ b/windows.devices.enumeration/deviceaccessinformation_accesschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceAccessInformation.AccessChanged --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceAccessInformation.AccessChanged ## -description Raised when access to a device has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceAccessInformation.AccessChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceAccessInformation.AccessChanged + +## -description +Raised when access to a device has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclass_1192758659.md b/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclass_1192758659.md index 9bb1083afc..8c7a2b5f24 100644 --- a/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclass_1192758659.md +++ b/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclass_1192758659.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClass(Windows.Devices.Enumeration.DeviceClass) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClass ## -description Initializes a [DeviceAccessInformation](deviceaccessinformation.md) object based on a given [DeviceClass](deviceclass.md). ## -parameters ### -param deviceClass Device class to get [DeviceAccessInformation](deviceaccessinformation.md) about. ## -returns The [DeviceAccessInformation](deviceaccessinformation.md) object for the given [DeviceClass](deviceclass.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClass(Windows.Devices.Enumeration.DeviceClass) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClass + +## -description +Initializes a [DeviceAccessInformation](deviceaccessinformation.md) object based on a given [DeviceClass](deviceclass.md). + +## -parameters +### -param deviceClass +Device class to get [DeviceAccessInformation](deviceaccessinformation.md) about. + +## -returns +The [DeviceAccessInformation](deviceaccessinformation.md) object for the given [DeviceClass](deviceclass.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclassid_1512370682.md b/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclassid_1512370682.md index d1b230062e..690374ba90 100644 --- a/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclassid_1512370682.md +++ b/windows.devices.enumeration/deviceaccessinformation_createfromdeviceclassid_1512370682.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClassId(System.Guid) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClassId ## -description Initializes a [DeviceAccessInformation](deviceaccessinformation.md) object based on a device class id. ## -parameters ### -param deviceClassId Id of the device class to get [DeviceAccessInformation](deviceaccessinformation.md) about. ## -returns The [DeviceAccessInformation](deviceaccessinformation.md) object for the given device class id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClassId(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromDeviceClassId + +## -description +Initializes a [DeviceAccessInformation](deviceaccessinformation.md) object based on a device class id. + +## -parameters +### -param deviceClassId +Id of the device class to get [DeviceAccessInformation](deviceaccessinformation.md) about. + +## -returns +The [DeviceAccessInformation](deviceaccessinformation.md) object for the given device class id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccessinformation_createfromid_1774777795.md b/windows.devices.enumeration/deviceaccessinformation_createfromid_1774777795.md index 64b7e075a5..e6c759dd7d 100644 --- a/windows.devices.enumeration/deviceaccessinformation_createfromid_1774777795.md +++ b/windows.devices.enumeration/deviceaccessinformation_createfromid_1774777795.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromId(System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromId ## -description Initializes a [DeviceAccessInformation](deviceaccessinformation.md) object based on a device id. ## -parameters ### -param deviceId Id of the device to get [DeviceAccessInformation](deviceaccessinformation.md) about. ## -returns The [DeviceAccessInformation](deviceaccessinformation.md) object for the given device id. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceAccessInformation.CreateFromId + +## -description +Initializes a [DeviceAccessInformation](deviceaccessinformation.md) object based on a device id. + +## -parameters +### -param deviceId +Id of the device to get [DeviceAccessInformation](deviceaccessinformation.md) about. + +## -returns +The [DeviceAccessInformation](deviceaccessinformation.md) object for the given device id. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceaccessinformation_currentstatus.md b/windows.devices.enumeration/deviceaccessinformation_currentstatus.md index 7ebd224297..430d481e06 100644 --- a/windows.devices.enumeration/deviceaccessinformation_currentstatus.md +++ b/windows.devices.enumeration/deviceaccessinformation_currentstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceAccessInformation.CurrentStatus --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceAccessInformation.CurrentStatus ## -description The current device access status. ## -property-value The current device access status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceAccessInformation.CurrentStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceAccessInformation.CurrentStatus + +## -description +The current device access status. + +## -property-value +The current device access status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceconnectionchangetriggerdetails.md b/windows.devices.enumeration/deviceconnectionchangetriggerdetails.md index 3d859493e6..3c22a7f304 100644 --- a/windows.devices.enumeration/deviceconnectionchangetriggerdetails.md +++ b/windows.devices.enumeration/deviceconnectionchangetriggerdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails ## -description Provides information about the device that caused this trigger to fire. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails + +## -description +Provides information about the device that caused this trigger to fire. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceconnectionchangetriggerdetails_deviceid.md b/windows.devices.enumeration/deviceconnectionchangetriggerdetails_deviceid.md index 6c5db8e9c1..e9c1bda449 100644 --- a/windows.devices.enumeration/deviceconnectionchangetriggerdetails_deviceid.md +++ b/windows.devices.enumeration/deviceconnectionchangetriggerdetails_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails.DeviceId --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails.DeviceId ## -description Gets the device Id of the device that caused this trigger to fire. ## -property-value The device id of the device that caused this trigger to fire. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceConnectionChangeTriggerDetails.DeviceId + +## -description +Gets the device Id of the device that caused this trigger to fire. + +## -property-value +The device id of the device that caused this trigger to fire. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs.md b/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs.md index c6a92737fc..a0ff7ba772 100644 --- a/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs.md +++ b/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs ## -description Provides data for the [DisconnectButtonClicked](devicepicker_disconnectbuttonclicked.md) event on the [DevicePicker](devicepicker.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs + +## -description +Provides data for the [DisconnectButtonClicked](devicepicker_disconnectbuttonclicked.md) event on the [DevicePicker](devicepicker.md) object. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs_device.md b/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs_device.md index 40aefecd95..673c78f477 100644 --- a/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs_device.md +++ b/windows.devices.enumeration/devicedisconnectbuttonclickedeventargs_device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs.Device --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs.Device ## -description The device that the user clicked the disconnect button for. ## -property-value The device to disconnect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs.Device +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceDisconnectButtonClickedEventArgs.Device + +## -description +The device that the user clicked the disconnect button for. + +## -property-value +The device to disconnect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_createfromidasync_270724983.md b/windows.devices.enumeration/deviceinformation_createfromidasync_270724983.md index 2007ffafc9..5d3b0e8d95 100644 --- a/windows.devices.enumeration/deviceinformation_createfromidasync_270724983.md +++ b/windows.devices.enumeration/deviceinformation_createfromidasync_270724983.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync ## -description Creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID, a list of additional properties, and a [DeviceInformationKind](deviceinformationkind.md) parameter. ## -parameters ### -param deviceId A string containing the [DeviceInformation](deviceinformation.md) ID. ### -param additionalProperties An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ### -param kind The type of [DeviceInformation](deviceinformation.md) object you want to create. ## -returns An object for starting and managing the asynchronous creation of the [DeviceInformation](deviceinformation.md) object. ## -remarks ## -examples ## -see-also [CreateFromIdAsync(String)](deviceinformation_createfromidasync_728202765.md), [CreateFromIdAsync(String, IIterable(String))](deviceinformation_createfromidasync_907774063.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync + +## -description +Creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID, a list of additional properties, and a [DeviceInformationKind](deviceinformationkind.md) parameter. + +## -parameters +### -param deviceId +A string containing the [DeviceInformation](deviceinformation.md) ID. + +### -param additionalProperties +An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +### -param kind +The type of [DeviceInformation](deviceinformation.md) object you want to create. + +## -returns +An object for starting and managing the asynchronous creation of the [DeviceInformation](deviceinformation.md) object. + +## -remarks + +## -examples + +## -see-also +[CreateFromIdAsync(String)](deviceinformation_createfromidasync_728202765.md), [CreateFromIdAsync(String, IIterable(String))](deviceinformation_createfromidasync_907774063.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createfromidasync_728202765.md b/windows.devices.enumeration/deviceinformation_createfromidasync_728202765.md index 05c10eb489..e616b1ccd0 100644 --- a/windows.devices.enumeration/deviceinformation_createfromidasync_728202765.md +++ b/windows.devices.enumeration/deviceinformation_createfromidasync_728202765.md @@ -1,3 +1,46 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync ## -description Creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID. ## -parameters ### -param deviceId The device ID. ## -returns An object for starting and managing the asynchronous creation of the [DeviceInformation](deviceinformation.md) object. ## -remarks ## -examples The savedId variable in this example is a [DeviceInformation](deviceinformation.md) ID previously saved by the application, obtained from the [id](deviceinformation_id.md) property of the last-used [DeviceInformation](deviceinformation.md) object. ```javascript // Create a DeviceInformation object from a saved ID var Enum = Windows.Devices.Enumeration; var DevInf = Enum.DeviceInformation; DevInf.createFromIdAsync(savedId).then( function(devinfo) { // Use the created DeviceInformation object printMessage("Created DeviceInformation. Name: " + devinfo.name); }, function (e) { displayError("Failed to create DeviceInformation: " + e.message); }); ``` ## -see-also [CreateFromIdAsync(String, IIterable_1)](deviceinformation_createfromidasync_907774063.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync + +## -description +Creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID. + +## -parameters +### -param deviceId +The device ID. + +## -returns +An object for starting and managing the asynchronous creation of the [DeviceInformation](deviceinformation.md) object. + +## -remarks + +## -examples +The savedId variable in this example is a [DeviceInformation](deviceinformation.md) ID previously saved by the application, obtained from the [id](deviceinformation_id.md) property of the last-used [DeviceInformation](deviceinformation.md) object. + +```javascript + + // Create a DeviceInformation object from a saved ID + var Enum = Windows.Devices.Enumeration; + var DevInf = Enum.DeviceInformation; + DevInf.createFromIdAsync(savedId).then( + function(devinfo) { + // Use the created DeviceInformation object + printMessage("Created DeviceInformation. Name: " + devinfo.name); + }, + function (e) { + displayError("Failed to create DeviceInformation: " + e.message); + }); + +``` + + + +## -see-also +[CreateFromIdAsync(String, IIterable_1)](deviceinformation_createfromidasync_907774063.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createfromidasync_907774063.md b/windows.devices.enumeration/deviceinformation_createfromidasync_907774063.md index e0e97f798f..50509f7dfa 100644 --- a/windows.devices.enumeration/deviceinformation_createfromidasync_907774063.md +++ b/windows.devices.enumeration/deviceinformation_createfromidasync_907774063.md @@ -1,3 +1,56 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync ## -description Creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID and a list of additional properties. ## -parameters ### -param deviceId A string containing the [DeviceInformation](deviceinformation.md) ID. ### -param additionalProperties An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -returns An object for starting and managing the asynchronous creation of the [DeviceInformation](deviceinformation.md) object. ## -remarks ## -examples The following example builds a list of properties to include in the [DeviceInformation](deviceinformation.md) object to create from a [DeviceInformation](deviceinformation.md) ID.The savedId variable in this example is a [DeviceInformation](deviceinformation.md) ID previously saved by the application, obtained from the [id](deviceinformation_id.md) property of the last-used [DeviceInformation](deviceinformation.md) object. ```javascript // Create a set of two additional properties var propertiesToRetrieve = new Array(); propertiesToRetrieve.push("System.InterfaceClassGuid"); propertiesToRetrieve.push("System.Storage.IsPortable"); // Create a DeviceInformation object from a saved ID var Enum = Windows.Devices.Enumeration; var DevInf = Enum.DeviceInformation; DevInf.createFromIdAsync(savedId, propertiesToRetrieve).then( function(devinfo) { // Use the created DeviceInformation object printMessage("Created DeviceInformation. Name: " + devinfo.name); }, function (e) { displayError("Failed to create DeviceInformation: " + e.message); }); ``` ## -see-also [CreateFromIdAsync(String)](deviceinformation_createfromidasync_728202765.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync + +## -description +Creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID and a list of additional properties. + +## -parameters +### -param deviceId +A string containing the [DeviceInformation](deviceinformation.md) ID. + +### -param additionalProperties +An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -returns +An object for starting and managing the asynchronous creation of the [DeviceInformation](deviceinformation.md) object. + +## -remarks + +## -examples +The following example builds a list of properties to include in the [DeviceInformation](deviceinformation.md) object to create from a [DeviceInformation](deviceinformation.md) ID.The savedId variable in this example is a [DeviceInformation](deviceinformation.md) ID previously saved by the application, obtained from the [id](deviceinformation_id.md) property of the last-used [DeviceInformation](deviceinformation.md) object. + +```javascript + + // Create a set of two additional properties + var propertiesToRetrieve = new Array(); + propertiesToRetrieve.push("System.InterfaceClassGuid"); + propertiesToRetrieve.push("System.Storage.IsPortable"); + + // Create a DeviceInformation object from a saved ID + var Enum = Windows.Devices.Enumeration; + var DevInf = Enum.DeviceInformation; + DevInf.createFromIdAsync(savedId, propertiesToRetrieve).then( + function(devinfo) { + // Use the created DeviceInformation object + printMessage("Created DeviceInformation. Name: " + devinfo.name); + }, + function (e) { + displayError("Failed to create DeviceInformation: " + e.message); + }); + + + +``` + + + +## -see-also +[CreateFromIdAsync(String)](deviceinformation_createfromidasync_728202765.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createwatcher_1506431823.md b/windows.devices.enumeration/deviceinformation_createwatcher_1506431823.md index 197a9da834..a91c28228c 100644 --- a/windows.devices.enumeration/deviceinformation_createwatcher_1506431823.md +++ b/windows.devices.enumeration/deviceinformation_createwatcher_1506431823.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateWatcher ## -description Creates a [DeviceWatcher](devicewatcher.md) for all devices. ## -returns The created [DeviceWatcher](devicewatcher.md). ## -remarks The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. See the [DeviceWatcher](devicewatcher.md) class for an example. > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. ## -examples ## -see-also [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md), [CreateWatcher(String, IIterable_1)](deviceinformation_createwatcher_490167309.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateWatcher + +## -description +Creates a [DeviceWatcher](devicewatcher.md) for all devices. + +## -returns +The created [DeviceWatcher](devicewatcher.md). + +## -remarks +The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. + +See the [DeviceWatcher](devicewatcher.md) class for an example. + +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +## -examples + +## -see-also +[CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md), [CreateWatcher(String, IIterable_1)](deviceinformation_createwatcher_490167309.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createwatcher_490167309.md b/windows.devices.enumeration/deviceinformation_createwatcher_490167309.md index 67a36653d1..4b0a2af9ea 100644 --- a/windows.devices.enumeration/deviceinformation_createwatcher_490167309.md +++ b/windows.devices.enumeration/deviceinformation_createwatcher_490167309.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateWatcher ## -description Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string and the specified collection of properties. ## -parameters ### -param aqsFilter An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. ### -param additionalProperties An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -returns The created [DeviceWatcher](devicewatcher.md). ## -remarks The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. See the [DeviceWatcher](devicewatcher.md) class for an example. ## -examples ## -see-also [CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateWatcher + +## -description +Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string and the specified collection of properties. + +## -parameters +### -param aqsFilter +An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. + +### -param additionalProperties +An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -returns +The created [DeviceWatcher](devicewatcher.md). + +## -remarks +The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. + +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +See the [DeviceWatcher](devicewatcher.md) class for an example. + +## -examples + +## -see-also +[CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createwatcher_4958831.md b/windows.devices.enumeration/deviceinformation_createwatcher_4958831.md index 1034bdd760..4fbce8c8f7 100644 --- a/windows.devices.enumeration/deviceinformation_createwatcher_4958831.md +++ b/windows.devices.enumeration/deviceinformation_createwatcher_4958831.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateWatcher ## -description Create s a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string. ## -parameters ### -param aqsFilter An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. ## -returns The created [DeviceWatcher](devicewatcher.md). ## -remarks The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. See the [DeviceWatcher](devicewatcher.md) class for an example. ## -examples ## -see-also [CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String, IIterable_1)](deviceinformation_createwatcher_490167309.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateWatcher + +## -description +Create s a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string. + +## -parameters +### -param aqsFilter +An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. + +## -returns +The created [DeviceWatcher](devicewatcher.md). + +## -remarks +The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. + +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +See the [DeviceWatcher](devicewatcher.md) class for an example. + +## -examples + +## -see-also +[CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String, IIterable_1)](deviceinformation_createwatcher_490167309.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createwatcher_674507571.md b/windows.devices.enumeration/deviceinformation_createwatcher_674507571.md index 0b79ba4cb3..398cd820ae 100644 --- a/windows.devices.enumeration/deviceinformation_createwatcher_674507571.md +++ b/windows.devices.enumeration/deviceinformation_createwatcher_674507571.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(Windows.Devices.Enumeration.DeviceClass) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateWatcher ## -description Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified [DeviceClass](deviceclass.md). ## -parameters ### -param deviceClass The class of device to enumerate using the [DeviceWatcher](devicewatcher.md). ## -returns The created [DeviceWatcher](devicewatcher.md). ## -remarks The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. See the [DeviceWatcher](devicewatcher.md) class for an example. ## -examples ## -see-also [CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md), [CreateWatcher(String, IIterable_1)](deviceinformation_createwatcher_490167309.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(Windows.Devices.Enumeration.DeviceClass) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateWatcher + +## -description +Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified [DeviceClass](deviceclass.md). + +## -parameters +### -param deviceClass +The class of device to enumerate using the [DeviceWatcher](devicewatcher.md). + +## -returns +The created [DeviceWatcher](devicewatcher.md). + +## -remarks +The [DeviceWatcher](devicewatcher.md) first performs an initial enumeration of devices, raising an [Added](devicewatcher_added.md) event for each device that it finds, and raising an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete. After the initial enumeration is complete, it raises events when a device is added, deleted, or updated. + +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +See the [DeviceWatcher](devicewatcher.md) class for an example. + +## -examples + +## -see-also +[CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md), [CreateWatcher(String, IIterable_1)](deviceinformation_createwatcher_490167309.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_createwatcher_990788373.md b/windows.devices.enumeration/deviceinformation_createwatcher_990788373.md index c7bd2e7566..06639c2b9a 100644 --- a/windows.devices.enumeration/deviceinformation_createwatcher_990788373.md +++ b/windows.devices.enumeration/deviceinformation_createwatcher_990788373.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.CreateWatcher ## -description Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string, the specified collection of properties, and the kind of devices. ## -parameters ### -param aqsFilter An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. ### -param additionalProperties An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ### -param kind The specific types of devices the [DeviceWatcher](devicewatcher.md) is interested in. ## -returns The created [DeviceWatcher](devicewatcher.md). ## -remarks ## -examples ## -see-also [CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md), [CreateWatcher(String, IIterable(String))](deviceinformation_createwatcher_490167309.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.CreateWatcher + +## -description +Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string, the specified collection of properties, and the kind of devices. + +## -parameters +### -param aqsFilter +An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. + +### -param additionalProperties +An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +### -param kind +The specific types of devices the [DeviceWatcher](devicewatcher.md) is interested in. + +## -returns +The created [DeviceWatcher](devicewatcher.md). + +## -remarks + +## -examples + +## -see-also +[CreateWatcher](deviceinformation_createwatcher_1506431823.md), [CreateWatcher(DeviceClass)](deviceinformation_createwatcher_674507571.md), [CreateWatcher(String)](deviceinformation_createwatcher_4958831.md), [CreateWatcher(String, IIterable(String))](deviceinformation_createwatcher_490167309.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_enclosurelocation.md b/windows.devices.enumeration/deviceinformation_enclosurelocation.md index a672b326d6..0d15443219 100644 --- a/windows.devices.enumeration/deviceinformation_enclosurelocation.md +++ b/windows.devices.enumeration/deviceinformation_enclosurelocation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.EnclosureLocation --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.EnclosureLocation ## -description The physical location of the device in its enclosure. For example, it may describe the location of a webcam inside a laptop. ## -property-value The object that describes the physical location of the device. ## -remarks If no enclosure location information is available, the property will be null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.EnclosureLocation +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.EnclosureLocation + +## -description +The physical location of the device in its enclosure. For example, it may describe the location of a webcam inside a laptop. + +## -property-value +The object that describes the physical location of the device. + +## -remarks +If no enclosure location information is available, the property will be null. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_findallasync_1257462890.md b/windows.devices.enumeration/deviceinformation_findallasync_1257462890.md index 4c9440cd84..1670d54389 100644 --- a/windows.devices.enumeration/deviceinformation_findallasync_1257462890.md +++ b/windows.devices.enumeration/deviceinformation_findallasync_1257462890.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.FindAllAsync ## -description Enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) string. ## -parameters ### -param aqsFilter An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. ## -returns The object for managing the asynchronous operation. ## -remarks > [!IMPORTANT] > This method is not available using JavaScript. If you try to use it, your code will instead call [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md) with an invalid class and return a collection with all devices. Instead, you should use [FindAllAsync(String, IIterable(String)](deviceinformation_findallasync_1469032970.md) with **null** as the second parameter if no other properties are needed. ## -examples ## -see-also [FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String, IIterable_1)](deviceinformation_findallasync_1469032970.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.FindAllAsync + +## -description +Enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) string. + +## -parameters +### -param aqsFilter +An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. + +## -returns +The object for managing the asynchronous operation. + +## -remarks +> [!IMPORTANT] +> This method is not available using JavaScript. If you try to use it, your code will instead call [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md) with an invalid class and return a collection with all devices. Instead, you should use [FindAllAsync(String, IIterable(String)](deviceinformation_findallasync_1469032970.md) with **null** as the second parameter if no other properties are needed. + +## -examples + +## -see-also +[FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String, IIterable_1)](deviceinformation_findallasync_1469032970.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_findallasync_1469032970.md b/windows.devices.enumeration/deviceinformation_findallasync_1469032970.md index f7a77271b5..1faaf88a71 100644 --- a/windows.devices.enumeration/deviceinformation_findallasync_1469032970.md +++ b/windows.devices.enumeration/deviceinformation_findallasync_1469032970.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.FindAllAsync ## -description Enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) string and including the specified collection of properties. ## -parameters ### -param aqsFilter An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. ### -param additionalProperties An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -returns The object for managing the asynchronous operation. ## -remarks ## -examples ## -see-also [FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.FindAllAsync + +## -description +Enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) string and including the specified collection of properties. + +## -parameters +### -param aqsFilter +An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. + +### -param additionalProperties +An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -returns +The object for managing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_findallasync_1653398836.md b/windows.devices.enumeration/deviceinformation_findallasync_1653398836.md index de7cabf0a1..38dc4742d0 100644 --- a/windows.devices.enumeration/deviceinformation_findallasync_1653398836.md +++ b/windows.devices.enumeration/deviceinformation_findallasync_1653398836.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(Windows.Devices.Enumeration.DeviceClass) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.FindAllAsync ## -description Enumerates [DeviceInformation](deviceinformation.md) objects of the specified class. ## -parameters ### -param deviceClass The class of devices to enumerate. ## -returns The object for managing the asynchronous operation. ## -remarks ## -examples ## -see-also [FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md), [FindAllAsync(String, IIterable_1)](deviceinformation_findallasync_1469032970.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(Windows.Devices.Enumeration.DeviceClass) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.FindAllAsync + +## -description +Enumerates [DeviceInformation](deviceinformation.md) objects of the specified class. + +## -parameters +### -param deviceClass +The class of devices to enumerate. + +## -returns +The object for managing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md), [FindAllAsync(String, IIterable_1)](deviceinformation_findallasync_1469032970.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_findallasync_1907805458.md b/windows.devices.enumeration/deviceinformation_findallasync_1907805458.md index e62c99a015..8adfb19f99 100644 --- a/windows.devices.enumeration/deviceinformation_findallasync_1907805458.md +++ b/windows.devices.enumeration/deviceinformation_findallasync_1907805458.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.FindAllAsync ## -description Enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) string, the device kind, and including the specified collection of properties. ## -parameters ### -param aqsFilter An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. ### -param additionalProperties An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ### -param kind The specific type of device to find. ## -returns The object for managing the asynchronous operation. ## -remarks ## -examples ## -see-also [FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md), [FindAllAsync(String, IIterable(String))](deviceinformation_findallasync_1469032970.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.FindAllAsync + +## -description +Enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) string, the device kind, and including the specified collection of properties. + +## -parameters +### -param aqsFilter +An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class. + +### -param additionalProperties +An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +### -param kind +The specific type of device to find. + +## -returns +The object for managing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync](deviceinformation_findallasync_326280522.md), [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md), [FindAllAsync(String, IIterable(String))](deviceinformation_findallasync_1469032970.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_findallasync_326280522.md b/windows.devices.enumeration/deviceinformation_findallasync_326280522.md index 36bd8f36ee..5ebce61a43 100644 --- a/windows.devices.enumeration/deviceinformation_findallasync_326280522.md +++ b/windows.devices.enumeration/deviceinformation_findallasync_326280522.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.FindAllAsync ## -description Enumerates all [DeviceInformation](deviceinformation.md) objects. ## -returns The object for managing the asynchronous operation. ## -remarks ## -examples ## -see-also [FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md), [FindAllAsync(String, IIterable_1)](deviceinformation_findallasync_1469032970.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.FindAllAsync + +## -description +Enumerates all [DeviceInformation](deviceinformation.md) objects. + +## -returns +The object for managing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync(DeviceClass)](deviceinformation_findallasync_1653398836.md), [FindAllAsync(String)](deviceinformation_findallasync_1257462890.md), [FindAllAsync(String, IIterable_1)](deviceinformation_findallasync_1469032970.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_getaqsfilterfromdeviceclass_449011558.md b/windows.devices.enumeration/deviceinformation_getaqsfilterfromdeviceclass_449011558.md index bc287826dc..0e3d101bc8 100644 --- a/windows.devices.enumeration/deviceinformation_getaqsfilterfromdeviceclass_449011558.md +++ b/windows.devices.enumeration/deviceinformation_getaqsfilterfromdeviceclass_449011558.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.GetAqsFilterFromDeviceClass(Windows.Devices.Enumeration.DeviceClass) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.GetAqsFilterFromDeviceClass ## -description Creates a filter to use to enumerate through a subset of device types. ## -parameters ### -param deviceClass The type of devices that you want to create a filter for. ## -returns The Advanced Query Syntax (AQS) filter used to specifically enumerate through the device type specified by *deviceClass*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.GetAqsFilterFromDeviceClass(Windows.Devices.Enumeration.DeviceClass) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.GetAqsFilterFromDeviceClass + +## -description +Creates a filter to use to enumerate through a subset of device types. + +## -parameters +### -param deviceClass +The type of devices that you want to create a filter for. + +## -returns +The Advanced Query Syntax (AQS) filter used to specifically enumerate through the device type specified by *deviceClass*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_getglyphthumbnailasync_183408693.md b/windows.devices.enumeration/deviceinformation_getglyphthumbnailasync_183408693.md index eba8ec09b7..a7f8790bce 100644 --- a/windows.devices.enumeration/deviceinformation_getglyphthumbnailasync_183408693.md +++ b/windows.devices.enumeration/deviceinformation_getglyphthumbnailasync_183408693.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.GetGlyphThumbnailAsync --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.GetGlyphThumbnailAsync ## -description Gets a glyph for the device. ## -returns The object for managing the asynchronous operation that will return a [DeviceThumbnail](devicethumbnail.md) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.GetGlyphThumbnailAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.GetGlyphThumbnailAsync + +## -description +Gets a glyph for the device. + +## -returns +The object for managing the asynchronous operation that will return a [DeviceThumbnail](devicethumbnail.md) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_getthumbnailasync_241227233.md b/windows.devices.enumeration/deviceinformation_getthumbnailasync_241227233.md index 087b039cea..cad18ae3f8 100644 --- a/windows.devices.enumeration/deviceinformation_getthumbnailasync_241227233.md +++ b/windows.devices.enumeration/deviceinformation_getthumbnailasync_241227233.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.GetThumbnailAsync --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.GetThumbnailAsync ## -description Returns a thumbnail image for the device. ## -returns The object for managing the asynchronous operation that will return a [DeviceThumbnail](devicethumbnail.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.GetThumbnailAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.GetThumbnailAsync + +## -description +Returns a thumbnail image for the device. + +## -returns +The object for managing the asynchronous operation that will return a [DeviceThumbnail](devicethumbnail.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_id.md b/windows.devices.enumeration/deviceinformation_id.md index 36296baaf7..03e86e7f8a 100644 --- a/windows.devices.enumeration/deviceinformation_id.md +++ b/windows.devices.enumeration/deviceinformation_id.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.Id --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.Id ## -description A string representing the identity of the device. ## -property-value A string representing the identity of the device. ## -remarks This ID can be used to activate device functionality using the [CreateFromIdAsync](deviceinformation_createfromidasync.md) methods on classes that implement device functionality. The [DeviceInformation](deviceinformation.md) object that the Id property identifies is actually adevice interface . For simplicity in this documentation, the [DeviceInformation](deviceinformation.md) object is called a device, and the identifier in its [Id](deviceinformation_id.md) property is called a [DeviceInformation](deviceinformation.md) ID. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.Id + +## -description +A string representing the identity of the device. + +## -property-value +A string representing the identity of the device. + +## -remarks +This ID can be used to activate device functionality using the [CreateFromIdAsync](deviceinformation_createfromidasync.md) methods on classes that implement device functionality. + +The [DeviceInformation](deviceinformation.md) object that the Id property identifies is actually adevice interface . For simplicity in this documentation, the [DeviceInformation](deviceinformation.md) object is called a device, and the identifier in its [Id](deviceinformation_id.md) property is called a [DeviceInformation](deviceinformation.md) ID. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_isdefault.md b/windows.devices.enumeration/deviceinformation_isdefault.md index 487831b9a8..3f6f470ee2 100644 --- a/windows.devices.enumeration/deviceinformation_isdefault.md +++ b/windows.devices.enumeration/deviceinformation_isdefault.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.IsDefault --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.IsDefault ## -description Indicates whether this device is the default device for the class. ## -property-value Indicates whether this device is the default device for the class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.IsDefault +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.IsDefault + +## -description +Indicates whether this device is the default device for the class. + +## -property-value +Indicates whether this device is the default device for the class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_isenabled.md b/windows.devices.enumeration/deviceinformation_isenabled.md index 178d787125..dd284a5ce6 100644 --- a/windows.devices.enumeration/deviceinformation_isenabled.md +++ b/windows.devices.enumeration/deviceinformation_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.IsEnabled --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.IsEnabled ## -description Indicates whether this device is enabled. ## -property-value Indicates whether this device is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.IsEnabled + +## -description +Indicates whether this device is enabled. + +## -property-value +Indicates whether this device is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_kind.md b/windows.devices.enumeration/deviceinformation_kind.md index 2c4da447e4..131c4ec21c 100644 --- a/windows.devices.enumeration/deviceinformation_kind.md +++ b/windows.devices.enumeration/deviceinformation_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.Kind --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.Kind ## -description Gets the type of [DeviceInformation](deviceinformation.md) represented by this object. ## -property-value The type of information represented by this object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.Kind +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.Kind + +## -description +Gets the type of [DeviceInformation](deviceinformation.md) represented by this object. + +## -property-value +The type of information represented by this object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_name.md b/windows.devices.enumeration/deviceinformation_name.md index 334d75c845..4e29f19d9b 100644 --- a/windows.devices.enumeration/deviceinformation_name.md +++ b/windows.devices.enumeration/deviceinformation_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.Name --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.Name ## -description The name of the device. This name is in the best available language for the app. ## -property-value The name of the device. This name is in the best available language for the app. ## -remarks The [Name](deviceinformation_name.md) property should only be used for display purposes only and not for finding a device because the [Name](deviceinformation_name.md) can change due to localization or a user assigning a name. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.Name +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.Name + +## -description +The name of the device. This name is in the best available language for the app. + +## -property-value +The name of the device. This name is in the best available language for the app. + +## -remarks +The [Name](deviceinformation_name.md) property should only be used for display purposes only and not for finding a device because the [Name](deviceinformation_name.md) can change due to localization or a user assigning a name. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_pairing.md b/windows.devices.enumeration/deviceinformation_pairing.md index 38deb5d660..a45bf45967 100644 --- a/windows.devices.enumeration/deviceinformation_pairing.md +++ b/windows.devices.enumeration/deviceinformation_pairing.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.Pairing --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.Pairing ## -description Gets the information about the capabilities for this device to pair. ## -property-value The pairing information for this device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.Pairing +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.Pairing + +## -description +Gets the information about the capabilities for this device to pair. + +## -property-value +The pairing information for this device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformation_properties.md b/windows.devices.enumeration/deviceinformation_properties.md index 66e5c0deca..79476474a9 100644 --- a/windows.devices.enumeration/deviceinformation_properties.md +++ b/windows.devices.enumeration/deviceinformation_properties.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformation.Properties --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformation.Properties ## -description Property store containing well-known values as well as additional properties that can be specified during device enumeration. ## -property-value The property store for the device. ## -remarks For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -examples ## -see-also [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformation.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.Properties + +## -description +Property store containing well-known values as well as additional properties that can be specified during device enumeration. + +## -property-value +The property store for the device. + +## -remarks +For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -examples + +## -see-also +[Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformation_update_1167410501.md b/windows.devices.enumeration/deviceinformation_update_1167410501.md index 107aebf435..ea2daf020f 100644 --- a/windows.devices.enumeration/deviceinformation_update_1167410501.md +++ b/windows.devices.enumeration/deviceinformation_update_1167410501.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformation.Update(Windows.Devices.Enumeration.DeviceInformationUpdate) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformation.Update ## -description Updates the properties of an existing [DeviceInformation](deviceinformation.md) object. ## -parameters ### -param updateInfo Indicates the properties to update. ## -remarks For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -examples ## -see-also [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformation.Update(Windows.Devices.Enumeration.DeviceInformationUpdate) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformation.Update + +## -description +Updates the properties of an existing [DeviceInformation](deviceinformation.md) object. + +## -parameters +### -param updateInfo +Indicates the properties to update. + +## -remarks +For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -examples + +## -see-also +[Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationcollection_first_1920739956.md b/windows.devices.enumeration/deviceinformationcollection_first_1920739956.md index 0cac7a140a..119a423d31 100644 --- a/windows.devices.enumeration/deviceinformationcollection_first_1920739956.md +++ b/windows.devices.enumeration/deviceinformationcollection_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.First --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCollection.First ## -description Gets an object that can iterate through the enumerated [DeviceInformation](deviceinformation.md) objects, starting with the first. ## -returns An object that can iterate through the enumerated devices, starting with the first. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.First +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCollection.First + +## -description +Gets an object that can iterate through the enumerated [DeviceInformation](deviceinformation.md) objects, starting with the first. + +## -returns +An object that can iterate through the enumerated devices, starting with the first. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationcollection_getat_496709656.md b/windows.devices.enumeration/deviceinformationcollection_getat_496709656.md index d2efc5413e..95e150272b 100644 --- a/windows.devices.enumeration/deviceinformationcollection_getat_496709656.md +++ b/windows.devices.enumeration/deviceinformationcollection_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCollection.GetAt ## -description Gets the [DeviceInformation](deviceinformation.md) object at the specified index. ## -parameters ### -param index The index. ## -returns The [DeviceInformation](deviceinformation.md) object at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCollection.GetAt + +## -description +Gets the [DeviceInformation](deviceinformation.md) object at the specified index. + +## -parameters +### -param index +The index. + +## -returns +The [DeviceInformation](deviceinformation.md) object at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationcollection_getmany_2135489042.md b/windows.devices.enumeration/deviceinformationcollection_getmany_2135489042.md index 32ad2843a3..7822b8631e 100644 --- a/windows.devices.enumeration/deviceinformationcollection_getmany_2135489042.md +++ b/windows.devices.enumeration/deviceinformationcollection_getmany_2135489042.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.GetMany(System.UInt32,Windows.Devices.Enumeration.DeviceInformation[]) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCollection.GetMany ## -description Gets a range of [DeviceInformation](deviceinformation.md) objects. ## -parameters ### -param startIndex The index at which to start retrieving [DeviceInformation](deviceinformation.md) objects. ### -param items The array of [DeviceInformation](deviceinformation.md) objects starting at the index specified by *startIndex*. ## -returns The number of [DeviceInformation](deviceinformation.md) objects returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.GetMany(System.UInt32,Windows.Devices.Enumeration.DeviceInformation[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCollection.GetMany + +## -description +Gets a range of [DeviceInformation](deviceinformation.md) objects. + +## -parameters +### -param startIndex +The index at which to start retrieving [DeviceInformation](deviceinformation.md) objects. + +### -param items +The array of [DeviceInformation](deviceinformation.md) objects starting at the index specified by *startIndex*. + +## -returns +The number of [DeviceInformation](deviceinformation.md) objects returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationcollection_indexof_1396375606.md b/windows.devices.enumeration/deviceinformationcollection_indexof_1396375606.md index 3c27d2115c..058470418e 100644 --- a/windows.devices.enumeration/deviceinformationcollection_indexof_1396375606.md +++ b/windows.devices.enumeration/deviceinformationcollection_indexof_1396375606.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.IndexOf(Windows.Devices.Enumeration.DeviceInformation,System.UInt32@) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCollection.IndexOf ## -description Returns the index of the specified [DeviceInformation](deviceinformation.md) object in the collection. ## -parameters ### -param value The [DeviceInformation](deviceinformation.md) object in the collection. ### -param index The index. ## -returns **true** if the method succeeded; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCollection.IndexOf(Windows.Devices.Enumeration.DeviceInformation,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCollection.IndexOf + +## -description +Returns the index of the specified [DeviceInformation](deviceinformation.md) object in the collection. + +## -parameters +### -param value +The [DeviceInformation](deviceinformation.md) object in the collection. + +### -param index +The index. + +## -returns +**true** if the method succeeded; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationcollection_size.md b/windows.devices.enumeration/deviceinformationcollection_size.md index 806d4f9576..2f4d722090 100644 --- a/windows.devices.enumeration/deviceinformationcollection_size.md +++ b/windows.devices.enumeration/deviceinformationcollection_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationCollection.Size --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationCollection.Size ## -description The number of [DeviceInformation](deviceinformation.md) objects in the collection. ## -property-value The number of [DeviceInformation](deviceinformation.md) objects in the collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationCollection.Size +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCollection.Size + +## -description +The number of [DeviceInformation](deviceinformation.md) objects in the collection. + +## -property-value +The number of [DeviceInformation](deviceinformation.md) objects in the collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationcustompairing.md b/windows.devices.enumeration/deviceinformationcustompairing.md index 32e2080637..615103994c 100644 --- a/windows.devices.enumeration/deviceinformationcustompairing.md +++ b/windows.devices.enumeration/deviceinformationcustompairing.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceInformationCustomPairing --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceInformationCustomPairing ## -description Represents a custom pairing for a [DeviceInformation](deviceinformation.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceInformationCustomPairing +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCustomPairing + +## -description +Represents a custom pairing for a [DeviceInformation](deviceinformation.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationcustompairing_pairasync_1027214629.md b/windows.devices.enumeration/deviceinformationcustompairing_pairasync_1027214629.md index 002fe4f8c5..6cb9a0c999 100644 --- a/windows.devices.enumeration/deviceinformationcustompairing_pairasync_1027214629.md +++ b/windows.devices.enumeration/deviceinformationcustompairing_pairasync_1027214629.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingKinds) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync ## -description Attempts to pair the device. ## -parameters ### -param pairingKindsSupported The different pairing kinds supported by this [DeviceInformation](deviceinformation.md) object. ## -returns The result of the pairing action. ## -remarks ## -examples ## -see-also [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel)](deviceinformationcustompairing_pairasync_991868827.md), [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel, IDevicePairingSettings)](deviceinformationcustompairing_pairasync_548316619.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingKinds) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync + +## -description +Attempts to pair the device. + +## -parameters +### -param pairingKindsSupported +The different pairing kinds supported by this [DeviceInformation](deviceinformation.md) object. + +## -returns +The result of the pairing action. + +## -remarks + +## -examples + +## -see-also +[PairAsync(DevicePairingKinds, DevicePairingProtectionLevel)](deviceinformationcustompairing_pairasync_991868827.md), [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel, IDevicePairingSettings)](deviceinformationcustompairing_pairasync_548316619.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationcustompairing_pairasync_548316619.md b/windows.devices.enumeration/deviceinformationcustompairing_pairasync_548316619.md index 8d707ac81c..af2e790440 100644 --- a/windows.devices.enumeration/deviceinformationcustompairing_pairasync_548316619.md +++ b/windows.devices.enumeration/deviceinformationcustompairing_pairasync_548316619.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingKinds,Windows.Devices.Enumeration.DevicePairingProtectionLevel,Windows.Devices.Enumeration.IDevicePairingSettings) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync ## -description Attempts to pair a device using a minimum protection level and custom settings. ## -parameters ### -param pairingKindsSupported The different pairing kinds supported by this [DeviceInformation](deviceinformation.md) object. ### -param minProtectionLevel The minimum protection level this [DeviceInformation](deviceinformation.md) object requires in order to pair. ### -param devicePairingSettings The custom device pairing settings. ## -returns The result of the pairing action. ## -remarks ## -examples ## -see-also [PairAsync(DevicePairingKinds)](deviceinformationcustompairing_pairasync_1027214629.md), [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel)](deviceinformationcustompairing_pairasync_991868827.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingKinds,Windows.Devices.Enumeration.DevicePairingProtectionLevel,Windows.Devices.Enumeration.IDevicePairingSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync + +## -description +Attempts to pair a device using a minimum protection level and custom settings. + +## -parameters +### -param pairingKindsSupported +The different pairing kinds supported by this [DeviceInformation](deviceinformation.md) object. + +### -param minProtectionLevel +The minimum protection level this [DeviceInformation](deviceinformation.md) object requires in order to pair. + +### -param devicePairingSettings +The custom device pairing settings. + +## -returns +The result of the pairing action. + +## -remarks + +## -examples + +## -see-also +[PairAsync(DevicePairingKinds)](deviceinformationcustompairing_pairasync_1027214629.md), [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel)](deviceinformationcustompairing_pairasync_991868827.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationcustompairing_pairasync_991868827.md b/windows.devices.enumeration/deviceinformationcustompairing_pairasync_991868827.md index 38f58d88dd..3d3a7e08ea 100644 --- a/windows.devices.enumeration/deviceinformationcustompairing_pairasync_991868827.md +++ b/windows.devices.enumeration/deviceinformationcustompairing_pairasync_991868827.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingKinds,Windows.Devices.Enumeration.DevicePairingProtectionLevel) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync ## -description Attempts to pair a device using a minimum protection level. ## -parameters ### -param pairingKindsSupported The different pairing kinds supported by this [DeviceInformation](deviceinformation.md) object. ### -param minProtectionLevel The minimum protection level this [DeviceInformation](deviceinformation.md) object requires in order to pair. ## -returns The result of the pairing action. ## -remarks ## -examples ## -see-also [PairAsync(DevicePairingKinds)](deviceinformationcustompairing_pairasync_1027214629.md), [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel, IDevicePairingSettings)](deviceinformationcustompairing_pairasync_548316619.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingKinds,Windows.Devices.Enumeration.DevicePairingProtectionLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairAsync + +## -description +Attempts to pair a device using a minimum protection level. + +## -parameters +### -param pairingKindsSupported +The different pairing kinds supported by this [DeviceInformation](deviceinformation.md) object. + +### -param minProtectionLevel +The minimum protection level this [DeviceInformation](deviceinformation.md) object requires in order to pair. + +## -returns +The result of the pairing action. + +## -remarks + +## -examples + +## -see-also +[PairAsync(DevicePairingKinds)](deviceinformationcustompairing_pairasync_1027214629.md), [PairAsync(DevicePairingKinds, DevicePairingProtectionLevel, IDevicePairingSettings)](deviceinformationcustompairing_pairasync_548316619.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationcustompairing_pairingrequested.md b/windows.devices.enumeration/deviceinformationcustompairing_pairingrequested.md index e5c939f7c2..c80b3445b9 100644 --- a/windows.devices.enumeration/deviceinformationcustompairing_pairingrequested.md +++ b/windows.devices.enumeration/deviceinformationcustompairing_pairingrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairingRequested --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairingRequested ## -description Raised when a pairing action is requested. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairingRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairingRequested + +## -description +Raised when a pairing action is requested. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing.md b/windows.devices.enumeration/deviceinformationpairing.md index 42ac569609..e702896dea 100644 --- a/windows.devices.enumeration/deviceinformationpairing.md +++ b/windows.devices.enumeration/deviceinformationpairing.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceInformationPairing --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceInformationPairing ## -description Contains information and enables pairing for a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceInformationPairing +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing + +## -description +Contains information and enables pairing for a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing_canpair.md b/windows.devices.enumeration/deviceinformationpairing_canpair.md index fa3c03742f..881f03c901 100644 --- a/windows.devices.enumeration/deviceinformationpairing_canpair.md +++ b/windows.devices.enumeration/deviceinformationpairing_canpair.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.CanPair --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationPairing.CanPair ## -description Gets a value that indicates whether the device can be paired. ## -property-value **True** if the device can be paired, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.CanPair +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.CanPair + +## -description +Gets a value that indicates whether the device can be paired. + +## -property-value +**True** if the device can be paired, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing_custom.md b/windows.devices.enumeration/deviceinformationpairing_custom.md index e511ed20c4..689adf8e1a 100644 --- a/windows.devices.enumeration/deviceinformationpairing_custom.md +++ b/windows.devices.enumeration/deviceinformationpairing_custom.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.Custom --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationPairing.Custom ## -description Gets the [DeviceInformationCustomPairing](deviceinformationcustompairing.md) object necessary for custom pairing. ## -property-value The associated [DeviceInformationCustomPairing](deviceinformationcustompairing.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.Custom +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.Custom + +## -description +Gets the [DeviceInformationCustomPairing](deviceinformationcustompairing.md) object necessary for custom pairing. + +## -property-value +The associated [DeviceInformationCustomPairing](deviceinformationcustompairing.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing_ispaired.md b/windows.devices.enumeration/deviceinformationpairing_ispaired.md index 06f6113b83..41ffbd6bec 100644 --- a/windows.devices.enumeration/deviceinformationpairing_ispaired.md +++ b/windows.devices.enumeration/deviceinformationpairing_ispaired.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.IsPaired --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationPairing.IsPaired ## -description Gets a value that indicates whether the device is currently paired. ## -property-value **True** if the device is currently paired, otherwise **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.IsPaired +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.IsPaired + +## -description +Gets a value that indicates whether the device is currently paired. + +## -property-value +**True** if the device is currently paired, otherwise **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing_pairasync_1041481788.md b/windows.devices.enumeration/deviceinformationpairing_pairasync_1041481788.md index ab7dd8d503..d8402998fd 100644 --- a/windows.devices.enumeration/deviceinformationpairing_pairasync_1041481788.md +++ b/windows.devices.enumeration/deviceinformationpairing_pairasync_1041481788.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingProtectionLevel,Windows.Devices.Enumeration.IDevicePairingSettings) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync ## -description Attempts to pair a device object with a specified protection level and custom settings. ## -parameters ### -param minProtectionLevel The required level of protection to use for the pairing action. ### -param devicePairingSettings The custom device pairing settings. ## -returns The result of the pairing action. ## -remarks ## -examples ## -see-also [PairAsync](deviceinformationpairing_pairasync_819565643.md), [PairAsync(DevicePairingProtectionLevel)](deviceinformationpairing_pairasync_868993300.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingProtectionLevel,Windows.Devices.Enumeration.IDevicePairingSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync + +## -description +Attempts to pair a device object with a specified protection level and custom settings. + +## -parameters +### -param minProtectionLevel +The required level of protection to use for the pairing action. + +### -param devicePairingSettings +The custom device pairing settings. + +## -returns +The result of the pairing action. + +## -remarks + +## -examples + +## -see-also +[PairAsync](deviceinformationpairing_pairasync_819565643.md), [PairAsync(DevicePairingProtectionLevel)](deviceinformationpairing_pairasync_868993300.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationpairing_pairasync_819565643.md b/windows.devices.enumeration/deviceinformationpairing_pairasync_819565643.md index 80684f2045..8cc1dd8589 100644 --- a/windows.devices.enumeration/deviceinformationpairing_pairasync_819565643.md +++ b/windows.devices.enumeration/deviceinformationpairing_pairasync_819565643.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync ## -description Attempts to pair the device. ## -returns The result of the pairing action. ## -remarks ## -examples ## -see-also [PairAsync(DevicePairingProtectionLevel)](deviceinformationpairing_pairasync_868993300.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync + +## -description +Attempts to pair the device. + +## -returns +The result of the pairing action. + +## -remarks + +## -examples + +## -see-also +[PairAsync(DevicePairingProtectionLevel)](deviceinformationpairing_pairasync_868993300.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationpairing_pairasync_868993300.md b/windows.devices.enumeration/deviceinformationpairing_pairasync_868993300.md index 7815e871a8..776884208b 100644 --- a/windows.devices.enumeration/deviceinformationpairing_pairasync_868993300.md +++ b/windows.devices.enumeration/deviceinformationpairing_pairasync_868993300.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingProtectionLevel) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync ## -description Attempts to pair the device using a provided level of protection. ## -parameters ### -param minProtectionLevel The required level of protection to use for the pairing action. ## -returns The result of the pairing action. ## -remarks ## -examples ## -see-also [PairAsync](deviceinformationpairing_pairasync_819565643.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync(Windows.Devices.Enumeration.DevicePairingProtectionLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.PairAsync + +## -description +Attempts to pair the device using a provided level of protection. + +## -parameters +### -param minProtectionLevel +The required level of protection to use for the pairing action. + +## -returns +The result of the pairing action. + +## -remarks + +## -examples + +## -see-also +[PairAsync](deviceinformationpairing_pairasync_819565643.md) \ No newline at end of file diff --git a/windows.devices.enumeration/deviceinformationpairing_protectionlevel.md b/windows.devices.enumeration/deviceinformationpairing_protectionlevel.md index 730d8f44c0..42c1806031 100644 --- a/windows.devices.enumeration/deviceinformationpairing_protectionlevel.md +++ b/windows.devices.enumeration/deviceinformationpairing_protectionlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.ProtectionLevel --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationPairing.ProtectionLevel ## -description Gets the level of protection used to pair the device. ## -property-value The protection level. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationPairing.ProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.ProtectionLevel + +## -description +Gets the level of protection used to pair the device. + +## -property-value +The protection level. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing_tryregisterforallinboundpairingrequests_649661304.md b/windows.devices.enumeration/deviceinformationpairing_tryregisterforallinboundpairingrequests_649661304.md index 90233c53fd..94c93f6a38 100644 --- a/windows.devices.enumeration/deviceinformationpairing_tryregisterforallinboundpairingrequests_649661304.md +++ b/windows.devices.enumeration/deviceinformationpairing_tryregisterforallinboundpairingrequests_649661304.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.TryRegisterForAllInboundPairingRequests(Windows.Devices.Enumeration.DevicePairingKinds) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationPairing.TryRegisterForAllInboundPairingRequests ## -description Registers the application to handle all inbound pairing requests. ## -parameters ### -param pairingKindsSupported The pairing kinds your app supports. ## -returns Whether or not the attempt was successful. ## -remarks This API only works with Windows 10 IoT Core (IoT Core) applications. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.TryRegisterForAllInboundPairingRequests(Windows.Devices.Enumeration.DevicePairingKinds) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.TryRegisterForAllInboundPairingRequests + +## -description +Registers the application to handle all inbound pairing requests. + +## -parameters +### -param pairingKindsSupported +The pairing kinds your app supports. + +## -returns +Whether or not the attempt was successful. + +## -remarks +This API only works with Windows 10 IoT Core (IoT Core) applications. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationpairing_unpairasync_1345006169.md b/windows.devices.enumeration/deviceinformationpairing_unpairasync_1345006169.md index 1a838ca9bc..950ddf2b1d 100644 --- a/windows.devices.enumeration/deviceinformationpairing_unpairasync_1345006169.md +++ b/windows.devices.enumeration/deviceinformationpairing_unpairasync_1345006169.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.UnpairAsync --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceInformationPairing.UnpairAsync ## -description Attempts to unpair the device. ## -returns The result of the unpairing action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceInformationPairing.UnpairAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceInformationPairing.UnpairAsync + +## -description +Attempts to unpair the device. + +## -returns +The result of the unpairing action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationupdate_id.md b/windows.devices.enumeration/deviceinformationupdate_id.md index 0ef09d6449..b60ab96a8e 100644 --- a/windows.devices.enumeration/deviceinformationupdate_id.md +++ b/windows.devices.enumeration/deviceinformationupdate_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationUpdate.Id --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationUpdate.Id ## -description The [DeviceInformation](deviceinformation.md) ID of the updated device. ## -property-value The [DeviceInformation](deviceinformation.md) ID of the updated device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationUpdate.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationUpdate.Id + +## -description +The [DeviceInformation](deviceinformation.md) ID of the updated device. + +## -property-value +The [DeviceInformation](deviceinformation.md) ID of the updated device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationupdate_kind.md b/windows.devices.enumeration/deviceinformationupdate_kind.md index 0ebd7ee864..82e677fec8 100644 --- a/windows.devices.enumeration/deviceinformationupdate_kind.md +++ b/windows.devices.enumeration/deviceinformationupdate_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationUpdate.Kind --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationUpdate.Kind ## -description Gets the type of device for the updated device. ## -property-value The type of device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationUpdate.Kind +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationUpdate.Kind + +## -description +Gets the type of device for the updated device. + +## -property-value +The type of device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceinformationupdate_properties.md b/windows.devices.enumeration/deviceinformationupdate_properties.md index 868f4b3d50..09d8a7080e 100644 --- a/windows.devices.enumeration/deviceinformationupdate_properties.md +++ b/windows.devices.enumeration/deviceinformationupdate_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceInformationUpdate.Properties --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceInformationUpdate.Properties ## -description The changed properties in a update to a [DeviceInformation](deviceinformation.md) object. ## -property-value The changed properties. ## -remarks For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceInformationUpdate.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceInformationUpdate.Properties + +## -description +The changed properties in a update to a [DeviceInformation](deviceinformation.md) object. + +## -property-value +The changed properties. + +## -remarks +For more info on what the properties represent, see [Device information properties](http://msdn.microsoft.com/library/4a4c2802-e674-4c04-8a6d-d7c1bbf1bd20). + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs.md b/windows.devices.enumeration/devicepairingrequestedeventargs.md index 4f1329672e..c82d1915aa 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs ## -description Provides data for the [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs + +## -description +Provides data for the [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs_accept_1944939200.md b/windows.devices.enumeration/devicepairingrequestedeventargs_accept_1944939200.md index 23e1b182aa..c2994b7b9c 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs_accept_1944939200.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs_accept_1944939200.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept ## -description Accepts a [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event and pairs the device with the application. ## -remarks ## -examples ## -see-also [Accept(String)](devicepairingrequestedeventargs_accept_711758752.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept + +## -description +Accepts a [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event and pairs the device with the application. + +## -remarks + +## -examples + +## -see-also +[Accept(String)](devicepairingrequestedeventargs_accept_711758752.md) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs_accept_711758752.md b/windows.devices.enumeration/devicepairingrequestedeventargs_accept_711758752.md index 0e82efb65e..0c2afc9216 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs_accept_711758752.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs_accept_711758752.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept(System.String) --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept ## -description Accepts a [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event and pairs the device with the application. Requires a pin for pairing purposes. ## -parameters ### -param pin The pin to use for attempting to pair a device. ## -remarks ## -examples ## -see-also [Accept](devicepairingrequestedeventargs_accept_1944939200.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Accept + +## -description +Accepts a [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event and pairs the device with the application. Requires a pin for pairing purposes. + +## -parameters +### -param pin +The pin to use for attempting to pair a device. + +## -remarks + +## -examples + +## -see-also +[Accept](devicepairingrequestedeventargs_accept_1944939200.md) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs_deviceinformation.md b/windows.devices.enumeration/devicepairingrequestedeventargs_deviceinformation.md index 26e75fcb14..58e560fe0f 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs_deviceinformation.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.DeviceInformation --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.DeviceInformation ## -description Gets the [DeviceInformation](deviceinformation.md) object associated with this pairing request. ## -property-value The [DeviceInformation](deviceinformation.md) object associated with this pairing request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.DeviceInformation + +## -description +Gets the [DeviceInformation](deviceinformation.md) object associated with this pairing request. + +## -property-value +The [DeviceInformation](deviceinformation.md) object associated with this pairing request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs_getdeferral_254836512.md b/windows.devices.enumeration/devicepairingrequestedeventargs_getdeferral_254836512.md index 58a802f0e3..df78657d12 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs_getdeferral_254836512.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.GetDeferral ## -description Requests a [Deferral](../windows.foundation/deferral.md) to support asynchronous operations. ## -returns The deferral necessary to support asynchronous actions. ## -remarks Sometimes it is necessary to create a delay while the user interacts with the application to support a specific [DevicePairingKinds](devicepairingkinds.md) value. For example, with **ProvidePin**, the application needs to wait until the user finishes providing a pin before continuing with the pairing process. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.GetDeferral + +## -description +Requests a [Deferral](../windows.foundation/deferral.md) to support asynchronous operations. + +## -returns +The deferral necessary to support asynchronous actions. + +## -remarks +Sometimes it is necessary to create a delay while the user interacts with the application to support a specific [DevicePairingKinds](devicepairingkinds.md) value. For example, with **ProvidePin**, the application needs to wait until the user finishes providing a pin before continuing with the pairing process. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs_pairingkind.md b/windows.devices.enumeration/devicepairingrequestedeventargs_pairingkind.md index 988c2d4e67..20d772223c 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs_pairingkind.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs_pairingkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.PairingKind --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.PairingKind ## -description Gets the kind of pairing associated with this pairing event. ## -property-value The kind of pairing used for this pairing request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.PairingKind +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.PairingKind + +## -description +Gets the kind of pairing associated with this pairing event. + +## -property-value +The kind of pairing used for this pairing request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingrequestedeventargs_pin.md b/windows.devices.enumeration/devicepairingrequestedeventargs_pin.md index 38123130c4..7e826c9d7f 100644 --- a/windows.devices.enumeration/devicepairingrequestedeventargs_pin.md +++ b/windows.devices.enumeration/devicepairingrequestedeventargs_pin.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Pin --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Pin ## -description Gets the pin associated with a pairing request. ## -property-value The pin associated with a pairing request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Pin +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.Pin + +## -description +Gets the pin associated with a pairing request. + +## -property-value +The pin associated with a pairing request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingresult.md b/windows.devices.enumeration/devicepairingresult.md index 3dbb4b8d15..f584d731f5 100644 --- a/windows.devices.enumeration/devicepairingresult.md +++ b/windows.devices.enumeration/devicepairingresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DevicePairingResult --api-type: winrt class ---- # Windows.Devices.Enumeration.DevicePairingResult ## -description Contains information about the result of attempting to pair a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DevicePairingResult +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DevicePairingResult + +## -description +Contains information about the result of attempting to pair a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingresult_protectionlevelused.md b/windows.devices.enumeration/devicepairingresult_protectionlevelused.md index 48c71ebc2d..7a01307ff7 100644 --- a/windows.devices.enumeration/devicepairingresult_protectionlevelused.md +++ b/windows.devices.enumeration/devicepairingresult_protectionlevelused.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePairingResult.ProtectionLevelUsed --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePairingResult.ProtectionLevelUsed ## -description Gets the level of protection used to pair the device. ## -property-value The level of protection used when the device was paired. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePairingResult.ProtectionLevelUsed +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePairingResult.ProtectionLevelUsed + +## -description +Gets the level of protection used to pair the device. + +## -property-value +The level of protection used when the device was paired. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepairingresult_status.md b/windows.devices.enumeration/devicepairingresult_status.md index 7a2a33fb96..c077291f40 100644 --- a/windows.devices.enumeration/devicepairingresult_status.md +++ b/windows.devices.enumeration/devicepairingresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePairingResult.Status --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePairingResult.Status ## -description Gets the paired status of the device after the pairing action completed. ## -property-value The paired status of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePairingResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePairingResult.Status + +## -description +Gets the paired status of the device after the pairing action completed. + +## -property-value +The paired status of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker.md b/windows.devices.enumeration/devicepicker.md index 65abcdefbb..8818fed430 100644 --- a/windows.devices.enumeration/devicepicker.md +++ b/windows.devices.enumeration/devicepicker.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DevicePicker --api-type: winrt class ---- # Windows.Devices.Enumeration.DevicePicker ## -description Represents a picker flyout that contains a list of devices for the user to choose from. ## -remarks ## -examples ## -see-also [Advanced casting sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620480) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DevicePicker +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DevicePicker + +## -description +Represents a picker flyout that contains a list of devices for the user to choose from. + +## -remarks + +## -examples + +## -see-also +[Advanced casting sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620480) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepicker_appearance.md b/windows.devices.enumeration/devicepicker_appearance.md index 8ff6eded69..da49345c49 100644 --- a/windows.devices.enumeration/devicepicker_appearance.md +++ b/windows.devices.enumeration/devicepicker_appearance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePicker.Appearance --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePicker.Appearance ## -description Gets the colors of the picker. ## -property-value The color of the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePicker.Appearance +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePicker.Appearance + +## -description +Gets the colors of the picker. + +## -property-value +The color of the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_devicepicker_1221375020.md b/windows.devices.enumeration/devicepicker_devicepicker_1221375020.md index 53a4fbdfb9..ad8b6b5058 100644 --- a/windows.devices.enumeration/devicepicker_devicepicker_1221375020.md +++ b/windows.devices.enumeration/devicepicker_devicepicker_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.#ctor --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.DevicePicker ## -description Creates a [DevicePicker](devicepicker.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.DevicePicker + +## -description +Creates a [DevicePicker](devicepicker.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_devicepickerdismissed.md b/windows.devices.enumeration/devicepicker_devicepickerdismissed.md index 227be33408..e1b031b683 100644 --- a/windows.devices.enumeration/devicepicker_devicepickerdismissed.md +++ b/windows.devices.enumeration/devicepicker_devicepickerdismissed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.DevicePicker.DevicePickerDismissed --api-type: winrt event ---- # Windows.Devices.Enumeration.DevicePicker.DevicePickerDismissed ## -description Indicates that the device picker was light dismissed by the user. Light dismiss happens when the user clicks somewhere other than the picker UI and the picker UI disappears. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DevicePicker.DevicePickerDismissed +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DevicePicker.DevicePickerDismissed + +## -description +Indicates that the device picker was light dismissed by the user. Light dismiss happens when the user clicks somewhere other than the picker UI and the picker UI disappears. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_deviceselected.md b/windows.devices.enumeration/devicepicker_deviceselected.md index a489bf5ed5..50b2ca7975 100644 --- a/windows.devices.enumeration/devicepicker_deviceselected.md +++ b/windows.devices.enumeration/devicepicker_deviceselected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.DevicePicker.DeviceSelected --api-type: winrt event ---- # Windows.Devices.Enumeration.DevicePicker.DeviceSelected ## -description Indicates that the user selected a device in the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DevicePicker.DeviceSelected +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DevicePicker.DeviceSelected + +## -description +Indicates that the user selected a device in the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_disconnectbuttonclicked.md b/windows.devices.enumeration/devicepicker_disconnectbuttonclicked.md index b5b096e9a1..ee6dde46ba 100644 --- a/windows.devices.enumeration/devicepicker_disconnectbuttonclicked.md +++ b/windows.devices.enumeration/devicepicker_disconnectbuttonclicked.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.DevicePicker.DisconnectButtonClicked --api-type: winrt event ---- # Windows.Devices.Enumeration.DevicePicker.DisconnectButtonClicked ## -description Indicates that the user clicked or tapped the disconnect button for a device in the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DevicePicker.DisconnectButtonClicked +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DevicePicker.DisconnectButtonClicked + +## -description +Indicates that the user clicked or tapped the disconnect button for a device in the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_filter.md b/windows.devices.enumeration/devicepicker_filter.md index 5fe0cea3eb..76c561719e 100644 --- a/windows.devices.enumeration/devicepicker_filter.md +++ b/windows.devices.enumeration/devicepicker_filter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePicker.Filter --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePicker.Filter ## -description Gets the filter used to choose what devices to show in the picker. ## -property-value The filter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePicker.Filter +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePicker.Filter + +## -description +Gets the filter used to choose what devices to show in the picker. + +## -property-value +The filter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_hide_1985563870.md b/windows.devices.enumeration/devicepicker_hide_1985563870.md index 394d025516..8cd26767fc 100644 --- a/windows.devices.enumeration/devicepicker_hide_1985563870.md +++ b/windows.devices.enumeration/devicepicker_hide_1985563870.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.Hide --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.Hide ## -description Hides the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.Hide +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.Hide + +## -description +Hides the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_picksingledeviceasync_1010469438.md b/windows.devices.enumeration/devicepicker_picksingledeviceasync_1010469438.md index b0e6b24822..3d0e8a079c 100644 --- a/windows.devices.enumeration/devicepicker_picksingledeviceasync_1010469438.md +++ b/windows.devices.enumeration/devicepicker_picksingledeviceasync_1010469438.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync(Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync ## -description Shows the picker UI and returns the selected device; does not require you to register for an event. The picker flies out from the specified edge of the specified rectangle. ## -parameters ### -param selection The rectangle from which you want the picker to fly out. ### -param placement The edge of the rectangle from which you want the picker to fly out. ## -returns The device selected. ## -remarks ## -examples ## -see-also [PickSingleDeviceAsync(Rect)](devicepicker_picksingledeviceasync_963938288.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync + +## -description +Shows the picker UI and returns the selected device; does not require you to register for an event. The picker flies out from the specified edge of the specified rectangle. + +## -parameters +### -param selection +The rectangle from which you want the picker to fly out. + +### -param placement +The edge of the rectangle from which you want the picker to fly out. + +## -returns +The device selected. + +## -remarks + +## -examples + +## -see-also +[PickSingleDeviceAsync(Rect)](devicepicker_picksingledeviceasync_963938288.md) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepicker_picksingledeviceasync_963938288.md b/windows.devices.enumeration/devicepicker_picksingledeviceasync_963938288.md index 3f7fcb6dee..cd852a4979 100644 --- a/windows.devices.enumeration/devicepicker_picksingledeviceasync_963938288.md +++ b/windows.devices.enumeration/devicepicker_picksingledeviceasync_963938288.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync ## -description Shows the picker UI and returns the selected device; does not require you to register for an event. The picker flies out from the edge of the specified rectangle. ## -parameters ### -param selection The rectangle from which you want the picker to fly out. ## -returns The device selected by the user. ## -remarks ## -examples ## -see-also [PickSingleDeviceAsync(Rect, Placement)](devicepicker_picksingledeviceasync_1010469438.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.PickSingleDeviceAsync + +## -description +Shows the picker UI and returns the selected device; does not require you to register for an event. The picker flies out from the edge of the specified rectangle. + +## -parameters +### -param selection +The rectangle from which you want the picker to fly out. + +## -returns +The device selected by the user. + +## -remarks + +## -examples + +## -see-also +[PickSingleDeviceAsync(Rect, Placement)](devicepicker_picksingledeviceasync_1010469438.md) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepicker_requestedproperties.md b/windows.devices.enumeration/devicepicker_requestedproperties.md index f69a8a54c2..36717553da 100644 --- a/windows.devices.enumeration/devicepicker_requestedproperties.md +++ b/windows.devices.enumeration/devicepicker_requestedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePicker.RequestedProperties --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePicker.RequestedProperties ## -description Gets a collection of properties for the returned device information object. ## -property-value The properties you want returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePicker.RequestedProperties +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePicker.RequestedProperties + +## -description +Gets a collection of properties for the returned device information object. + +## -property-value +The properties you want returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_setdisplaystatus_987185536.md b/windows.devices.enumeration/devicepicker_setdisplaystatus_987185536.md index 9a9bf64597..d00a9476a4 100644 --- a/windows.devices.enumeration/devicepicker_setdisplaystatus_987185536.md +++ b/windows.devices.enumeration/devicepicker_setdisplaystatus_987185536.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.SetDisplayStatus(Windows.Devices.Enumeration.DeviceInformation,System.String,Windows.Devices.Enumeration.DevicePickerDisplayStatusOptions) --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.SetDisplayStatus ## -description Updates the picker UI to reflect the provided status and display options for a specified device. ## -parameters ### -param device The device information. ### -param status The status to display. ### -param options The display options for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.SetDisplayStatus(Windows.Devices.Enumeration.DeviceInformation,System.String,Windows.Devices.Enumeration.DevicePickerDisplayStatusOptions) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.SetDisplayStatus + +## -description +Updates the picker UI to reflect the provided status and display options for a specified device. + +## -parameters +### -param device +The device information. + +### -param status +The status to display. + +### -param options +The display options for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepicker_show_8680471.md b/windows.devices.enumeration/devicepicker_show_8680471.md index 9a0d59486c..cb79d76832 100644 --- a/windows.devices.enumeration/devicepicker_show_8680471.md +++ b/windows.devices.enumeration/devicepicker_show_8680471.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.Show ## -description Shows the picker UI. The picker flies out from the specified edge of the specified rectangle. ## -parameters ### -param selection The rectangle from which you want the picker to fly out. ### -param placement The edge of the rectangle from which you want the picker to fly out. ## -remarks ## -examples ## -see-also [Show(Rect)](devicepicker_show_97155545.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.Show + +## -description +Shows the picker UI. The picker flies out from the specified edge of the specified rectangle. + +## -parameters +### -param selection +The rectangle from which you want the picker to fly out. + +### -param placement +The edge of the rectangle from which you want the picker to fly out. + +## -remarks + +## -examples + +## -see-also +[Show(Rect)](devicepicker_show_97155545.md) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepicker_show_97155545.md b/windows.devices.enumeration/devicepicker_show_97155545.md index f28ed62d02..726c547694 100644 --- a/windows.devices.enumeration/devicepicker_show_97155545.md +++ b/windows.devices.enumeration/devicepicker_show_97155545.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Enumeration.DevicePicker.Show(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Devices.Enumeration.DevicePicker.Show ## -description Shows the picker UI. The picker flies out from the edge of the specified rectangle. ## -parameters ### -param selection The rectangle from which you want the picker to fly out. ## -remarks ## -examples ## -see-also [Show(Rect, Placement)](devicepicker_show_8680471.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DevicePicker.Show(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DevicePicker.Show + +## -description +Shows the picker UI. The picker flies out from the edge of the specified rectangle. + +## -parameters +### -param selection +The rectangle from which you want the picker to fly out. + +## -remarks + +## -examples + +## -see-also +[Show(Rect, Placement)](devicepicker_show_8680471.md) \ No newline at end of file diff --git a/windows.devices.enumeration/devicepickerappearance.md b/windows.devices.enumeration/devicepickerappearance.md index 8f6a633d03..1af9807bd7 100644 --- a/windows.devices.enumeration/devicepickerappearance.md +++ b/windows.devices.enumeration/devicepickerappearance.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DevicePickerAppearance --api-type: winrt class ---- # Windows.Devices.Enumeration.DevicePickerAppearance ## -description Represents the appearance of a device picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DevicePickerAppearance +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance + +## -description +Represents the appearance of a device picker. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_accentcolor.md b/windows.devices.enumeration/devicepickerappearance_accentcolor.md index 357fb4c690..a3495d51ac 100644 --- a/windows.devices.enumeration/devicepickerappearance_accentcolor.md +++ b/windows.devices.enumeration/devicepickerappearance_accentcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.AccentColor --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.AccentColor ## -description Gets and sets the accent color of the picker UI. ## -property-value The accent color. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.AccentColor +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.AccentColor + +## -description +Gets and sets the accent color of the picker UI. + +## -property-value +The accent color. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_backgroundcolor.md b/windows.devices.enumeration/devicepickerappearance_backgroundcolor.md index 34e74d2afc..debfd5d9f0 100644 --- a/windows.devices.enumeration/devicepickerappearance_backgroundcolor.md +++ b/windows.devices.enumeration/devicepickerappearance_backgroundcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.BackgroundColor --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.BackgroundColor ## -description Gets and sets the background color of the picker UI. ## -property-value The background color. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.BackgroundColor +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.BackgroundColor + +## -description +Gets and sets the background color of the picker UI. + +## -property-value +The background color. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_foregroundcolor.md b/windows.devices.enumeration/devicepickerappearance_foregroundcolor.md index 15adc4aef2..06eed98d0e 100644 --- a/windows.devices.enumeration/devicepickerappearance_foregroundcolor.md +++ b/windows.devices.enumeration/devicepickerappearance_foregroundcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.ForegroundColor --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.ForegroundColor ## -description Gets and sets the foreground color of the picker UI. ## -property-value The foreground color. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.ForegroundColor +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.ForegroundColor + +## -description +Gets and sets the foreground color of the picker UI. + +## -property-value +The foreground color. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_selectedaccentcolor.md b/windows.devices.enumeration/devicepickerappearance_selectedaccentcolor.md index 739203b6f2..c0a719d12f 100644 --- a/windows.devices.enumeration/devicepickerappearance_selectedaccentcolor.md +++ b/windows.devices.enumeration/devicepickerappearance_selectedaccentcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.SelectedAccentColor --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.SelectedAccentColor ## -description Gets and sets the accent color for a device that has been selected in the picker. ## -property-value The accent color. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.SelectedAccentColor +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.SelectedAccentColor + +## -description +Gets and sets the accent color for a device that has been selected in the picker. + +## -property-value +The accent color. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_selectedbackgroundcolor.md b/windows.devices.enumeration/devicepickerappearance_selectedbackgroundcolor.md index 2fb35f634b..2437fac248 100644 --- a/windows.devices.enumeration/devicepickerappearance_selectedbackgroundcolor.md +++ b/windows.devices.enumeration/devicepickerappearance_selectedbackgroundcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.SelectedBackgroundColor --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.SelectedBackgroundColor ## -description Gets and sets the background color for a device that is selected in the picker. ## -property-value The color to use as the background of a selected device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.SelectedBackgroundColor +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.SelectedBackgroundColor + +## -description +Gets and sets the background color for a device that is selected in the picker. + +## -property-value +The color to use as the background of a selected device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_selectedforegroundcolor.md b/windows.devices.enumeration/devicepickerappearance_selectedforegroundcolor.md index 58df71e07a..a6c4652264 100644 --- a/windows.devices.enumeration/devicepickerappearance_selectedforegroundcolor.md +++ b/windows.devices.enumeration/devicepickerappearance_selectedforegroundcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.SelectedForegroundColor --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.SelectedForegroundColor ## -description Gets and sets the foreground color for a device that is selected in the picker. ## -property-value The foreground color. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.SelectedForegroundColor +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.SelectedForegroundColor + +## -description +Gets and sets the foreground color for a device that is selected in the picker. + +## -property-value +The foreground color. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerappearance_title.md b/windows.devices.enumeration/devicepickerappearance_title.md index 0d51a1187b..6b58b68e10 100644 --- a/windows.devices.enumeration/devicepickerappearance_title.md +++ b/windows.devices.enumeration/devicepickerappearance_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.Title --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerAppearance.Title ## -description Gets and sets the title for the picker UI. ## -property-value The title of the picker UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerAppearance.Title +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerAppearance.Title + +## -description +Gets and sets the title for the picker UI. + +## -property-value +The title of the picker UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerfilter.md b/windows.devices.enumeration/devicepickerfilter.md index 23fa26fa10..826620994f 100644 --- a/windows.devices.enumeration/devicepickerfilter.md +++ b/windows.devices.enumeration/devicepickerfilter.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DevicePickerFilter --api-type: winrt class ---- # Windows.Devices.Enumeration.DevicePickerFilter ## -description Represents the filter used to determine which devices to show in the device picker. The filter parameters are OR-ed together to build the resulting filter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DevicePickerFilter +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DevicePickerFilter + +## -description +Represents the filter used to determine which devices to show in the device picker. The filter parameters are OR-ed together to build the resulting filter. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerfilter_supporteddeviceclasses.md b/windows.devices.enumeration/devicepickerfilter_supporteddeviceclasses.md index 692d2caa22..5cb1c1783f 100644 --- a/windows.devices.enumeration/devicepickerfilter_supporteddeviceclasses.md +++ b/windows.devices.enumeration/devicepickerfilter_supporteddeviceclasses.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceClasses --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceClasses ## -description Gets a list of supported device classes to show in the picker. This defaults to an empty list (no filter). You can add device classes to this vector and filter the devices list to those that are in one or more of the provided classes. ## -property-value The list of device classes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceClasses +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceClasses + +## -description +Gets a list of supported device classes to show in the picker. This defaults to an empty list (no filter). You can add device classes to this vector and filter the devices list to those that are in one or more of the provided classes. + +## -property-value +The list of device classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicepickerfilter_supporteddeviceselectors.md b/windows.devices.enumeration/devicepickerfilter_supporteddeviceselectors.md index 89466b41b2..0cdb26f4e8 100644 --- a/windows.devices.enumeration/devicepickerfilter_supporteddeviceselectors.md +++ b/windows.devices.enumeration/devicepickerfilter_supporteddeviceselectors.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceSelectors --api-type: winrt property ---- # Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceSelectors ## -description Gets a list of AQS filter strings. This defaults to empty list (no filter). You can add one or more AQS filter strings to this vector and filter the devices list to those that meet one or more of the provided filters. ## -property-value The list of AQS filters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceSelectors +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DevicePickerFilter.SupportedDeviceSelectors + +## -description +Gets a list of AQS filter strings. This defaults to empty list (no filter). You can add one or more AQS filter strings to this vector and filter the devices list to those that meet one or more of the provided filters. + +## -property-value +The list of AQS filters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceselectedeventargs.md b/windows.devices.enumeration/deviceselectedeventargs.md index d2e827ca71..008063172d 100644 --- a/windows.devices.enumeration/deviceselectedeventargs.md +++ b/windows.devices.enumeration/deviceselectedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceSelectedEventArgs --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceSelectedEventArgs ## -description Provides data for the [DeviceSelected](devicepicker_deviceselected.md) event on the [DevicePicker](devicepicker.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceSelectedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceSelectedEventArgs + +## -description +Provides data for the [DeviceSelected](devicepicker_deviceselected.md) event on the [DevicePicker](devicepicker.md) object. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceselectedeventargs_selecteddevice.md b/windows.devices.enumeration/deviceselectedeventargs_selecteddevice.md index 1a0c2307f2..38f8714377 100644 --- a/windows.devices.enumeration/deviceselectedeventargs_selecteddevice.md +++ b/windows.devices.enumeration/deviceselectedeventargs_selecteddevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceSelectedEventArgs.SelectedDevice --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceSelectedEventArgs.SelectedDevice ## -description The device selected by the user in the picker. ## -property-value The selected device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceSelectedEventArgs.SelectedDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceSelectedEventArgs.SelectedDevice + +## -description +The device selected by the user in the picker. + +## -property-value +The selected device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_canread.md b/windows.devices.enumeration/devicethumbnail_canread.md index f9b4b51cfa..5d3c636218 100644 --- a/windows.devices.enumeration/devicethumbnail_canread.md +++ b/windows.devices.enumeration/devicethumbnail_canread.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.CanRead --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceThumbnail.CanRead ## -description Gets a value that indicates whether the stream can be read from. ## -property-value True if the stream can be read from. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.CanRead +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.CanRead + +## -description +Gets a value that indicates whether the stream can be read from. + +## -property-value +True if the stream can be read from. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_canwrite.md b/windows.devices.enumeration/devicethumbnail_canwrite.md index cfe0dd3255..1456e76068 100644 --- a/windows.devices.enumeration/devicethumbnail_canwrite.md +++ b/windows.devices.enumeration/devicethumbnail_canwrite.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.CanWrite --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceThumbnail.CanWrite ## -description Gets a value that indicates whether the stream can be written to. ## -property-value True if the stream can be written to. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.CanWrite +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.CanWrite + +## -description +Gets a value that indicates whether the stream can be written to. + +## -property-value +True if the stream can be written to. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_clonestream_242904981.md b/windows.devices.enumeration/devicethumbnail_clonestream_242904981.md index 89d031e0d5..8bbe9b21d3 100644 --- a/windows.devices.enumeration/devicethumbnail_clonestream_242904981.md +++ b/windows.devices.enumeration/devicethumbnail_clonestream_242904981.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.CloneStream --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.CloneStream ## -description Creates a new instance of a [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) over the same resource as the current stream. ## -returns The new stream. The initial, internal position of the stream is 0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.CloneStream +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.CloneStream + +## -description +Creates a new instance of a [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) over the same resource as the current stream. + +## -returns +The new stream. The initial, internal position of the stream is 0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_close_811482585.md b/windows.devices.enumeration/devicethumbnail_close_811482585.md index 4e3ada6614..89374dfefb 100644 --- a/windows.devices.enumeration/devicethumbnail_close_811482585.md +++ b/windows.devices.enumeration/devicethumbnail_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.Close --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.Close ## -description Closes the current stream and releases system resources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.Close + +## -description +Closes the current stream and releases system resources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_contenttype.md b/windows.devices.enumeration/devicethumbnail_contenttype.md index 40d87987e0..00ba26ce5a 100644 --- a/windows.devices.enumeration/devicethumbnail_contenttype.md +++ b/windows.devices.enumeration/devicethumbnail_contenttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.ContentType --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceThumbnail.ContentType ## -description Returns the content type of the thumbnail image. ## -property-value The content type of the image. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.ContentType +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.ContentType + +## -description +Returns the content type of the thumbnail image. + +## -property-value +The content type of the image. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_flushasync_491532439.md b/windows.devices.enumeration/devicethumbnail_flushasync_491532439.md index 157ef6d353..984ec782d7 100644 --- a/windows.devices.enumeration/devicethumbnail_flushasync_491532439.md +++ b/windows.devices.enumeration/devicethumbnail_flushasync_491532439.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.FlushAsync --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.FlushAsync ## -description Flushes data asynchronously in a sequential stream. ## -returns The stream flush operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.FlushAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.FlushAsync + +## -description +Flushes data asynchronously in a sequential stream. + +## -returns +The stream flush operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_getinputstreamat_1916887525.md b/windows.devices.enumeration/devicethumbnail_getinputstreamat_1916887525.md index f6d74638e0..1b67d64969 100644 --- a/windows.devices.enumeration/devicethumbnail_getinputstreamat_1916887525.md +++ b/windows.devices.enumeration/devicethumbnail_getinputstreamat_1916887525.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.GetInputStreamAt(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.GetInputStreamAt ## -description Returns a pointer to an input stream starting at the specified location. ## -parameters ### -param position The position in the input stream. ## -returns A pointer to an input stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.GetInputStreamAt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.GetInputStreamAt + +## -description +Returns a pointer to an input stream starting at the specified location. + +## -parameters +### -param position +The position in the input stream. + +## -returns +A pointer to an input stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_getoutputstreamat_379282997.md b/windows.devices.enumeration/devicethumbnail_getoutputstreamat_379282997.md index 542ade64aa..c08590601d 100644 --- a/windows.devices.enumeration/devicethumbnail_getoutputstreamat_379282997.md +++ b/windows.devices.enumeration/devicethumbnail_getoutputstreamat_379282997.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.GetOutputStreamAt(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.GetOutputStreamAt ## -description Returns a pointer to an output stream starting at the specified location. ## -parameters ### -param position The position in the output stream. ## -returns A pointer to an output stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.GetOutputStreamAt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.GetOutputStreamAt + +## -description +Returns a pointer to an output stream starting at the specified location. + +## -parameters +### -param position +The position in the output stream. + +## -returns +A pointer to an output stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_position.md b/windows.devices.enumeration/devicethumbnail_position.md index 8e7f6da7a3..a33bacc584 100644 --- a/windows.devices.enumeration/devicethumbnail_position.md +++ b/windows.devices.enumeration/devicethumbnail_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.Position --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceThumbnail.Position ## -description Gets the byte offset of the stream. ## -property-value The number of bytes from the start of the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.Position +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.Position + +## -description +Gets the byte offset of the stream. + +## -property-value +The number of bytes from the start of the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_readasync_1012630619.md b/windows.devices.enumeration/devicethumbnail_readasync_1012630619.md index ab741b38c9..1f65cfeb2c 100644 --- a/windows.devices.enumeration/devicethumbnail_readasync_1012630619.md +++ b/windows.devices.enumeration/devicethumbnail_readasync_1012630619.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.ReadAsync(Windows.Storage.Streams.IBuffer,System.UInt32,Windows.Storage.Streams.InputStreamOptions) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.ReadAsync ## -description Returns an asynchronous byte reader object. ## -parameters ### -param buffer The buffer into which the asynchronous read operation places the bytes that are read. ### -param count The number of bytes to read. ### -param options Specifies the type of the asynchronous read operation. ## -returns The asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.ReadAsync(Windows.Storage.Streams.IBuffer,System.UInt32,Windows.Storage.Streams.InputStreamOptions) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.ReadAsync + +## -description +Returns an asynchronous byte reader object. + +## -parameters +### -param buffer +The buffer into which the asynchronous read operation places the bytes that are read. + +### -param count +The number of bytes to read. + +### -param options +Specifies the type of the asynchronous read operation. + +## -returns +The asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_seek_1797934981.md b/windows.devices.enumeration/devicethumbnail_seek_1797934981.md index 67f9475cb5..e0c7547268 100644 --- a/windows.devices.enumeration/devicethumbnail_seek_1797934981.md +++ b/windows.devices.enumeration/devicethumbnail_seek_1797934981.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.Seek(System.UInt64) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.Seek ## -description Sets the position of the stream to the specified value. ## -parameters ### -param position The new position of the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.Seek(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.Seek + +## -description +Sets the position of the stream to the specified value. + +## -parameters +### -param position +The new position of the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_size.md b/windows.devices.enumeration/devicethumbnail_size.md index a93ae66258..d1efb7c1c7 100644 --- a/windows.devices.enumeration/devicethumbnail_size.md +++ b/windows.devices.enumeration/devicethumbnail_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.Size --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceThumbnail.Size ## -description Gets or sets the size of the device thumbnail image. ## -property-value The size of the device thumbnail image. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceThumbnail.Size +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.Size + +## -description +Gets or sets the size of the device thumbnail image. + +## -property-value +The size of the device thumbnail image. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicethumbnail_writeasync_897036872.md b/windows.devices.enumeration/devicethumbnail_writeasync_897036872.md index afa0ea8d54..3e908c57a7 100644 --- a/windows.devices.enumeration/devicethumbnail_writeasync_897036872.md +++ b/windows.devices.enumeration/devicethumbnail_writeasync_897036872.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.WriteAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceThumbnail.WriteAsync ## -description Writes data asynchronously in a sequential stream. ## -parameters ### -param buffer The buffer into which the asynchronous writer operation writes. ## -returns The byte writer operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceThumbnail.WriteAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceThumbnail.WriteAsync + +## -description +Writes data asynchronously in a sequential stream. + +## -parameters +### -param buffer +The buffer into which the asynchronous writer operation writes. + +## -returns +The byte writer operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceunpairingresult.md b/windows.devices.enumeration/deviceunpairingresult.md index 11ac1ad783..69b54ccdb8 100644 --- a/windows.devices.enumeration/deviceunpairingresult.md +++ b/windows.devices.enumeration/deviceunpairingresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceUnpairingResult --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceUnpairingResult ## -description Contains information about the result of attempting to unpair a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceUnpairingResult +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceUnpairingResult + +## -description +Contains information about the result of attempting to unpair a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/deviceunpairingresult_status.md b/windows.devices.enumeration/deviceunpairingresult_status.md index 702f8e38f6..d4b7d0d994 100644 --- a/windows.devices.enumeration/deviceunpairingresult_status.md +++ b/windows.devices.enumeration/deviceunpairingresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceUnpairingResult.Status --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceUnpairingResult.Status ## -description Gets the paired status of the device after the unpairing action completed. ## -property-value The paired status of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceUnpairingResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceUnpairingResult.Status + +## -description +Gets the paired status of the device after the unpairing action completed. + +## -property-value +The paired status of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcher_added.md b/windows.devices.enumeration/devicewatcher_added.md index 35de8d95e8..36e3729086 100644 --- a/windows.devices.enumeration/devicewatcher_added.md +++ b/windows.devices.enumeration/devicewatcher_added.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Added --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceWatcher.Added ## -description Event that is raised when a device is added to the collection enumerated by the [DeviceWatcher](devicewatcher.md). ## -remarks > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. ## -examples ## -see-also [Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Added +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Added + +## -description +Event that is raised when a device is added to the collection enumerated by the [DeviceWatcher](devicewatcher.md). + +## -remarks +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +## -examples + +## -see-also +[Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file diff --git a/windows.devices.enumeration/devicewatcher_enumerationcompleted.md b/windows.devices.enumeration/devicewatcher_enumerationcompleted.md index 44ac4a44d2..649eeff096 100644 --- a/windows.devices.enumeration/devicewatcher_enumerationcompleted.md +++ b/windows.devices.enumeration/devicewatcher_enumerationcompleted.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceWatcher.EnumerationCompleted --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceWatcher.EnumerationCompleted ## -description Event that is raised when the enumeration of devices completes. ## -remarks ## -examples ## -see-also [Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.EnumerationCompleted + +## -description +Event that is raised when the enumeration of devices completes. + +## -remarks + +## -examples + +## -see-also +[Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file diff --git a/windows.devices.enumeration/devicewatcher_getbackgroundtrigger_287578946.md b/windows.devices.enumeration/devicewatcher_getbackgroundtrigger_287578946.md index 4656aabaa5..93dd348913 100644 --- a/windows.devices.enumeration/devicewatcher_getbackgroundtrigger_287578946.md +++ b/windows.devices.enumeration/devicewatcher_getbackgroundtrigger_287578946.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceWatcher.GetBackgroundTrigger(Windows.Foundation.Collections.IIterable{Windows.Devices.Enumeration.DeviceWatcherEventKind}) --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceWatcher.GetBackgroundTrigger ## -description Gets a [DeviceWatcherTrigger](../windows.applicationmodel.background/devicewatchertrigger.md) object monitoring for changes to the list of devices. ## -parameters ### -param requestedEventKinds A list of the specific updates you want to monitor. ## -returns The watcher trigger to monitor for the specified changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceWatcher.GetBackgroundTrigger(Windows.Foundation.Collections.IIterable{Windows.Devices.Enumeration.DeviceWatcherEventKind}) +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.GetBackgroundTrigger + +## -description +Gets a [DeviceWatcherTrigger](../windows.applicationmodel.background/devicewatchertrigger.md) object monitoring for changes to the list of devices. + +## -parameters +### -param requestedEventKinds +A list of the specific updates you want to monitor. + +## -returns +The watcher trigger to monitor for the specified changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcher_removed.md b/windows.devices.enumeration/devicewatcher_removed.md index a50760ec2e..7ad9f2a2ca 100644 --- a/windows.devices.enumeration/devicewatcher_removed.md +++ b/windows.devices.enumeration/devicewatcher_removed.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Removed --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceWatcher.Removed ## -description Event that is raised when a device is removed from the collection of enumerated devices. ## -remarks > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. ## -examples ## -see-also [Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Removed + +## -description +Event that is raised when a device is removed from the collection of enumerated devices. + +## -remarks +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +## -examples + +## -see-also +[Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file diff --git a/windows.devices.enumeration/devicewatcher_start_1587696324.md b/windows.devices.enumeration/devicewatcher_start_1587696324.md index 6b16138560..e8d73932b5 100644 --- a/windows.devices.enumeration/devicewatcher_start_1587696324.md +++ b/windows.devices.enumeration/devicewatcher_start_1587696324.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceWatcher.Start --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceWatcher.Start ## -description Starts a search for devices, and subscribes to device enumeration events. ## -remarks An app calls [Start](devicewatcher_start.md) to begin the search for devices. During this intial enumeration, the [DeviceWatcher](devicewatcher.md) raises an [Added](devicewatcher_added.md) event for each device that's found, until all devices are found. The [DeviceWatcher](devicewatcher.md) raises an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete, and continues to raise events if a device is added, updated, or removed. The [Start](devicewatcher_start.md) method can only be called when the [DeviceWatcher](devicewatcher.md) is in the **Created**, **Stopped** or **Aborted** state. The [Status](devicewatcher_status.md) property indicates the [DeviceWatcher](devicewatcher.md) state. When re-starting the watcher, wait for the [Stopped](devicewatcher_stopped.md) event before calling [Start](devicewatcher_start.md). The following diagram shows how the [DeviceWatcher](devicewatcher.md) transitions between the states represented by [DeviceWatcherStatus](devicewatcherstatus.md) enumeration. state diagram of DeviceWatcher states ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Start + +## -description +Starts a search for devices, and subscribes to device enumeration events. + +## -remarks +An app calls [Start](devicewatcher_start.md) to begin the search for devices. During this intial enumeration, the [DeviceWatcher](devicewatcher.md) raises an [Added](devicewatcher_added.md) event for each device that's found, until all devices are found. The [DeviceWatcher](devicewatcher.md) raises an [EnumerationCompleted](devicewatcher_enumerationcompleted.md) event when the initial enumeration is complete, and continues to raise events if a device is added, updated, or removed. + +The [Start](devicewatcher_start.md) method can only be called when the [DeviceWatcher](devicewatcher.md) is in the **Created**, **Stopped** or **Aborted** state. The [Status](devicewatcher_status.md) property indicates the [DeviceWatcher](devicewatcher.md) state. When re-starting the watcher, wait for the [Stopped](devicewatcher_stopped.md) event before calling [Start](devicewatcher_start.md). The following diagram shows how the [DeviceWatcher](devicewatcher.md) transitions between the states represented by [DeviceWatcherStatus](devicewatcherstatus.md) enumeration. + +state diagram of DeviceWatcher states + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcher_status.md b/windows.devices.enumeration/devicewatcher_status.md index 49827ea7a1..2a30aca162 100644 --- a/windows.devices.enumeration/devicewatcher_status.md +++ b/windows.devices.enumeration/devicewatcher_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceWatcher.Status --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceWatcher.Status ## -description The status of the [DeviceWatcher](devicewatcher.md). ## -property-value The status of the [DeviceWatcher](devicewatcher.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Status + +## -description +The status of the [DeviceWatcher](devicewatcher.md). + +## -property-value +The status of the [DeviceWatcher](devicewatcher.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcher_stop_1201535524.md b/windows.devices.enumeration/devicewatcher_stop_1201535524.md index 60c2310130..b647478b00 100644 --- a/windows.devices.enumeration/devicewatcher_stop_1201535524.md +++ b/windows.devices.enumeration/devicewatcher_stop_1201535524.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.Enumeration.DeviceWatcher.Stop --api-type: winrt method ---- # Windows.Devices.Enumeration.DeviceWatcher.Stop ## -description Stop raising the events that add, update and remove enumeration results. ## -remarks To stop a search for devices, an app calls [Stop](devicewatcher_stop.md) and enters the **Stopping** state. The [Stopped](devicewatcher_stopped.md) event is raised when the [Stop](devicewatcher_stop.md) operation completes and the [DeviceWatcher](devicewatcher.md) enters the **Stopped** state. The following diagram shows how the [DeviceWatcher](devicewatcher.md) transitions between the states represented by [DeviceWatcherStatus](devicewatcherstatus.md) enumeration. state diagram of DeviceWatcher states This call transitions the [DeviceWatcher](devicewatcher.md) to the **Stopping** state and completes immediately. The watcher will transition to the **Stopped** state once all events that are already in the process of being raised have completed. Callers may wait for the [Stopped](devicewatcher_stopped.md) event if they need to know when the [DeviceWatcher](devicewatcher.md) has stopped. Callers must wait for the [Stopped](devicewatcher_stopped.md) event before they can call [Start](devicewatcher_start.md) to restart the watcher. Callers may unsubscribe from events if they do not want to receive any additional events after [Stop](devicewatcher_stop.md) but do not want to wait for the [Stopped](devicewatcher_stopped.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Enumeration.DeviceWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Stop + +## -description +Stop raising the events that add, update and remove enumeration results. + +## -remarks +To stop a search for devices, an app calls [Stop](devicewatcher_stop.md) and enters the **Stopping** state. The [Stopped](devicewatcher_stopped.md) event is raised when the [Stop](devicewatcher_stop.md) operation completes and the [DeviceWatcher](devicewatcher.md) enters the **Stopped** state. + +The following diagram shows how the [DeviceWatcher](devicewatcher.md) transitions between the states represented by [DeviceWatcherStatus](devicewatcherstatus.md) enumeration. + +state diagram of DeviceWatcher states + +This call transitions the [DeviceWatcher](devicewatcher.md) to the **Stopping** state and completes immediately. The watcher will transition to the **Stopped** state once all events that are already in the process of being raised have completed. + +Callers may wait for the [Stopped](devicewatcher_stopped.md) event if they need to know when the [DeviceWatcher](devicewatcher.md) has stopped. Callers must wait for the [Stopped](devicewatcher_stopped.md) event before they can call [Start](devicewatcher_start.md) to restart the watcher. Callers may unsubscribe from events if they do not want to receive any additional events after [Stop](devicewatcher_stop.md) but do not want to wait for the [Stopped](devicewatcher_stopped.md) event. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcher_stopped.md b/windows.devices.enumeration/devicewatcher_stopped.md index d68addce4d..fb13652676 100644 --- a/windows.devices.enumeration/devicewatcher_stopped.md +++ b/windows.devices.enumeration/devicewatcher_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Stopped --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceWatcher.Stopped ## -description Event that is raised when the enumeration operation has been stopped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Stopped + +## -description +Event that is raised when the enumeration operation has been stopped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcher_updated.md b/windows.devices.enumeration/devicewatcher_updated.md index 9ab27db102..84fff78073 100644 --- a/windows.devices.enumeration/devicewatcher_updated.md +++ b/windows.devices.enumeration/devicewatcher_updated.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Updated --api-type: winrt event ---- # Windows.Devices.Enumeration.DeviceWatcher.Updated ## -description Event that is raised when a device is updated in the collection of enumerated devices. ## -remarks > [!NOTE] > An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Enumeration.DeviceWatcher.Updated +-api-type: winrt event +--- + + + +# Windows.Devices.Enumeration.DeviceWatcher.Updated + +## -description +Event that is raised when a device is updated in the collection of enumerated devices. + +## -remarks +> [!NOTE] +> An app must subscribe to all of the [added](devicewatcher_added.md), [removed](devicewatcher_removed.md), and [updated](devicewatcher_updated.md) events to be notified when there are device additions, removals or updates. If an app handles only the [added](devicewatcher_added.md) event, it will not receive an update if a device is added to the system after the initial device enumeration completes. + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcherevent.md b/windows.devices.enumeration/devicewatcherevent.md index 9107c94f76..2291c914b2 100644 --- a/windows.devices.enumeration/devicewatcherevent.md +++ b/windows.devices.enumeration/devicewatcherevent.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceWatcherEvent --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceWatcherEvent ## -description Triggered when the list of devices is updated after the initial enumeration is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceWatcherEvent +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceWatcherEvent + +## -description +Triggered when the list of devices is updated after the initial enumeration is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcherevent_deviceinformation.md b/windows.devices.enumeration/devicewatcherevent_deviceinformation.md index 102a8ff188..d1e4257979 100644 --- a/windows.devices.enumeration/devicewatcherevent_deviceinformation.md +++ b/windows.devices.enumeration/devicewatcherevent_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformation --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformation ## -description Gets the information for the device associated with the [DeviceWatcherEvent](devicewatcherevent.md). ## -property-value The information for the added, removed, or updated device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformation + +## -description +Gets the information for the device associated with the [DeviceWatcherEvent](devicewatcherevent.md). + +## -property-value +The information for the added, removed, or updated device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcherevent_deviceinformationupdate.md b/windows.devices.enumeration/devicewatcherevent_deviceinformationupdate.md index 8dfc154013..4d1a5d4882 100644 --- a/windows.devices.enumeration/devicewatcherevent_deviceinformationupdate.md +++ b/windows.devices.enumeration/devicewatcherevent_deviceinformationupdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformationUpdate --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformationUpdate ## -description Gets updated information for a device updated by the [DeviceWatcherEvent](devicewatcherevent.md). ## -property-value The updated information for the modified device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformationUpdate +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceWatcherEvent.DeviceInformationUpdate + +## -description +Gets updated information for a device updated by the [DeviceWatcherEvent](devicewatcherevent.md). + +## -property-value +The updated information for the modified device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatcherevent_kind.md b/windows.devices.enumeration/devicewatcherevent_kind.md index b422ddc7c0..31f6ee94fd 100644 --- a/windows.devices.enumeration/devicewatcherevent_kind.md +++ b/windows.devices.enumeration/devicewatcherevent_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceWatcherEvent.Kind --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceWatcherEvent.Kind ## -description Gets the type for the device indicated by the [DeviceWatcherEvent](devicewatcherevent.md). ## -property-value The type of device added, removed, or updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceWatcherEvent.Kind +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceWatcherEvent.Kind + +## -description +Gets the type for the device indicated by the [DeviceWatcherEvent](devicewatcherevent.md). + +## -property-value +The type of device added, removed, or updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatchertriggerdetails.md b/windows.devices.enumeration/devicewatchertriggerdetails.md index 5d1a75a910..49e44a2fff 100644 --- a/windows.devices.enumeration/devicewatchertriggerdetails.md +++ b/windows.devices.enumeration/devicewatchertriggerdetails.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Enumeration.DeviceWatcherTriggerDetails --api-type: winrt class ---- # Windows.Devices.Enumeration.DeviceWatcherTriggerDetails ## -description Provides details about the device updates that invoked the trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Enumeration.DeviceWatcherTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Enumeration.DeviceWatcherTriggerDetails + +## -description +Provides details about the device updates that invoked the trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/devicewatchertriggerdetails_devicewatcherevents.md b/windows.devices.enumeration/devicewatchertriggerdetails_devicewatcherevents.md index 9143da52f5..70f935361e 100644 --- a/windows.devices.enumeration/devicewatchertriggerdetails_devicewatcherevents.md +++ b/windows.devices.enumeration/devicewatchertriggerdetails_devicewatcherevents.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.DeviceWatcherTriggerDetails.DeviceWatcherEvents --api-type: winrt property ---- # Windows.Devices.Enumeration.DeviceWatcherTriggerDetails.DeviceWatcherEvents ## -description Gets the events that activated the trigger. ## -property-value The events that activated the watcher trigger. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.DeviceWatcherTriggerDetails.DeviceWatcherEvents +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.DeviceWatcherTriggerDetails.DeviceWatcherEvents + +## -description +Gets the events that activated the trigger. + +## -property-value +The events that activated the watcher trigger. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/enclosurelocation_indock.md b/windows.devices.enumeration/enclosurelocation_indock.md index 25f3f31a86..335a8e9d35 100644 --- a/windows.devices.enumeration/enclosurelocation_indock.md +++ b/windows.devices.enumeration/enclosurelocation_indock.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.EnclosureLocation.InDock --api-type: winrt property ---- # Windows.Devices.Enumeration.EnclosureLocation.InDock ## -description Indicates whether the device is physically located in the docking station of the portable computer. ## -property-value A value that is **True** if the device is physically located in the docking station, and **False** if it is not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.EnclosureLocation.InDock +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.EnclosureLocation.InDock + +## -description +Indicates whether the device is physically located in the docking station of the portable computer. + +## -property-value +A value that is **True** if the device is physically located in the docking station, and **False** if it is not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/enclosurelocation_inlid.md b/windows.devices.enumeration/enclosurelocation_inlid.md index 22f49bbf1b..e4a882f62f 100644 --- a/windows.devices.enumeration/enclosurelocation_inlid.md +++ b/windows.devices.enumeration/enclosurelocation_inlid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.EnclosureLocation.InLid --api-type: winrt property ---- # Windows.Devices.Enumeration.EnclosureLocation.InLid ## -description Indicates whether the device is physically located in the lid of the portable computer. ## -property-value A value that is **True** if the device is physically located in the lid, and **False** if it is not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.EnclosureLocation.InLid +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.EnclosureLocation.InLid + +## -description +Indicates whether the device is physically located in the lid of the portable computer. + +## -property-value +A value that is **True** if the device is physically located in the lid, and **False** if it is not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/enclosurelocation_panel.md b/windows.devices.enumeration/enclosurelocation_panel.md index 4cca3105b1..b81833ed68 100644 --- a/windows.devices.enumeration/enclosurelocation_panel.md +++ b/windows.devices.enumeration/enclosurelocation_panel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.EnclosureLocation.Panel --api-type: winrt property ---- # Windows.Devices.Enumeration.EnclosureLocation.Panel ## -description Indicates which panel of the computer the device is physically located on. ## -property-value One of the values of the [Panel](panel.md) enumeration that indicates which panel of the computer the device is physically located on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.EnclosureLocation.Panel +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.EnclosureLocation.Panel + +## -description +Indicates which panel of the computer the device is physically located on. + +## -property-value +One of the values of the [Panel](panel.md) enumeration that indicates which panel of the computer the device is physically located on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.enumeration/enclosurelocation_rotationangleindegreesclockwise.md b/windows.devices.enumeration/enclosurelocation_rotationangleindegreesclockwise.md index bf24a95706..e6cace2b10 100644 --- a/windows.devices.enumeration/enclosurelocation_rotationangleindegreesclockwise.md +++ b/windows.devices.enumeration/enclosurelocation_rotationangleindegreesclockwise.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Enumeration.EnclosureLocation.RotationAngleInDegreesClockwise --api-type: winrt property ---- # Windows.Devices.Enumeration.EnclosureLocation.RotationAngleInDegreesClockwise ## -description Gets the physical degree of rotation for a device in its enclosure. ## -property-value The degrees of rotation for the device in its enclosure. This is in a clockwise direction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Enumeration.EnclosureLocation.RotationAngleInDegreesClockwise +-api-type: winrt property +--- + + + +# Windows.Devices.Enumeration.EnclosureLocation.RotationAngleInDegreesClockwise + +## -description +Gets the physical degree of rotation for a device in its enclosure. + +## -property-value +The degrees of rotation for the device in its enclosure. This is in a clockwise direction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence.md b/windows.devices.geolocation.geofencing/geofence.md index 6c6a6e135f..3031d9fef3 100644 --- a/windows.devices.geolocation.geofencing/geofence.md +++ b/windows.devices.geolocation.geofencing/geofence.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Geolocation.Geofencing.Geofence --api-type: winrt class ---- # Windows.Devices.Geolocation.Geofencing.Geofence ## -description Contains the functionality to define a geofence (a geographical area of interest) to monitor. ## -remarks ## -examples ## -see-also [Windows.Devices.Geolocation](windows_devices_geolocation_geofencing.md), [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.Geofencing.Geofence +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence + +## -description +Contains the functionality to define a geofence (a geographical area of interest) to monitor. + +## -remarks + +## -examples + +## -see-also +[Windows.Devices.Geolocation](windows_devices_geolocation_geofencing.md), [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofence_duration.md b/windows.devices.geolocation.geofencing/geofence_duration.md index 2d2b8d64c6..189825ffb5 100644 --- a/windows.devices.geolocation.geofencing/geofence_duration.md +++ b/windows.devices.geolocation.geofencing/geofence_duration.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.Duration --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Duration ## -description Gets the time window, beginning after the [StartTime](geofence_starttime.md), during which the [Geofence](geofence.md) is monitored. ## -property-value The time window, beginning after the [StartTime](geofence_starttime.md), during which the [Geofence](geofence.md) is monitored. ## -remarks This property is read-only. Use one of the overloaded [Geofence](geofence.md) constructors to set the duration value. When the duration time window expires, the system automatically removes the geofence from the system and stops monitoring it. If you want your app to be notified when a geofence expires, be sure to include the **GeofenceState.Removed** state when initializing the geofence. The default value for this property is a [TimeSpan](../windows.foundation/timespan.md) with a time interval of 0. A time interval of 0 indicates that the geofence will not expire and will be monitored indefinitely or until the app manually removes the geofence. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.Duration +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Duration + +## -description +Gets the time window, beginning after the [StartTime](geofence_starttime.md), during which the [Geofence](geofence.md) is monitored. + +## -property-value +The time window, beginning after the [StartTime](geofence_starttime.md), during which the [Geofence](geofence.md) is monitored. + +## -remarks +This property is read-only. Use one of the overloaded [Geofence](geofence.md) constructors to set the duration value. + +When the duration time window expires, the system automatically removes the geofence from the system and stops monitoring it. If you want your app to be notified when a geofence expires, be sure to include the **GeofenceState.Removed** state when initializing the geofence. + +The default value for this property is a [TimeSpan](../windows.foundation/timespan.md) with a time interval of 0. A time interval of 0 indicates that the geofence will not expire and will be monitored indefinitely or until the app manually removes the geofence. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence_dwelltime.md b/windows.devices.geolocation.geofencing/geofence_dwelltime.md index 9fed44fc7d..f24473a22b 100644 --- a/windows.devices.geolocation.geofencing/geofence_dwelltime.md +++ b/windows.devices.geolocation.geofencing/geofence_dwelltime.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.DwellTime --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.DwellTime ## -description The minimum time that a position has to be inside or outside of the [Geofence](geofence.md) in order for the notification to be triggered. ## -property-value The minimum time that a position has to be inside or outside of the geofence in order for the notification to be triggered. ## -remarks When creating geofences that use a dwell time, the time span must be greater than 0. The **DwellTime** value is used for monitoring both the **Entered** and **Exited** states of a single geofence. If you want to provide different dwell time values for entering and exiting, you should create two [Geofence](geofence.md) objects, using one to track the **Entered** state and another to track the **Exited** state. Then you can specify a different dwell time for each object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.DwellTime +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.DwellTime + +## -description +The minimum time that a position has to be inside or outside of the [Geofence](geofence.md) in order for the notification to be triggered. + +## -property-value +The minimum time that a position has to be inside or outside of the geofence in order for the notification to be triggered. + +## -remarks +When creating geofences that use a dwell time, the time span must be greater than 0. + +The **DwellTime** value is used for monitoring both the **Entered** and **Exited** states of a single geofence. If you want to provide different dwell time values for entering and exiting, you should create two [Geofence](geofence.md) objects, using one to track the **Entered** state and another to track the **Exited** state. Then you can specify a different dwell time for each object. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence_geofence_1118020828.md b/windows.devices.geolocation.geofencing/geofence_geofence_1118020828.md index 4b21b41b3b..4c82dfd22a 100644 --- a/windows.devices.geolocation.geofencing/geofence_geofence_1118020828.md +++ b/windows.devices.geolocation.geofencing/geofence_geofence_1118020828.md @@ -1,3 +1,49 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape,Windows.Devices.Geolocation.Geofencing.MonitoredGeofenceStates,System.Boolean,Windows.Foundation.TimeSpan,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Geofence ## -description Initializes a new [Geofence](geofence.md) object given the *id*, the shape of the geofence, the states to monitor the geofence for, the *singleUse* flag, the *dwellTime* for the geofence, the time to start monitoring the geofence, and the *duration* of the geofence. ## -parameters ### -param id The Id of the geofence. ### -param geoshape The area that defines the geofence to monitor. ### -param monitoredStates The states to monitor the geofence for. ### -param singleUse True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. ### -param dwellTime The time that a position has to be in or out of the geofence in order for the notification to be triggered.This object must represent a positive value. ### -param startTime The time to start monitoring the geofence. ### -param duration The duration of time to monitor the geofence for. The duration begins at the *startTime*. This object must represent a positive value. ## -remarks You must specify the **Entered** or **Exited** states, or both, for a geofence to be monitored. It is not possible to create a geofence that only monitors the **Removed** state. The *id* value must be non-null and less than 64 characters. The *geoshape* parameter must be a non-null [Geocircle](../windows.devices.geolocation/geocircle.md) with a [SpatialReferenceId](../windows.devices.geolocation/igeoshape_spatialreferenceid.md) that matches the platform or an exception will be thrown. If the expiration date for the geofence - which is the start time plus the duration time span - occurs sooner than the creation time plus the dwell time value, an exception will be thrown. ## -examples ## -see-also [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape)](geofence_geofence_161909132.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean)](geofence_geofence_1541426940.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan)](geofence_geofence_247731772.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape,Windows.Devices.Geolocation.Geofencing.MonitoredGeofenceStates,System.Boolean,Windows.Foundation.TimeSpan,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Geofence + +## -description +Initializes a new [Geofence](geofence.md) object given the *id*, the shape of the geofence, the states to monitor the geofence for, the *singleUse* flag, the *dwellTime* for the geofence, the time to start monitoring the geofence, and the *duration* of the geofence. + +## -parameters +### -param id +The Id of the geofence. + +### -param geoshape +The area that defines the geofence to monitor. + +### -param monitoredStates +The states to monitor the geofence for. + +### -param singleUse +True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. + +### -param dwellTime +The time that a position has to be in or out of the geofence in order for the notification to be triggered.This object must represent a positive value. + +### -param startTime +The time to start monitoring the geofence. + +### -param duration +The duration of time to monitor the geofence for. The duration begins at the *startTime*. This object must represent a positive value. + +## -remarks +You must specify the **Entered** or **Exited** states, or both, for a geofence to be monitored. It is not possible to create a geofence that only monitors the **Removed** state. + +The *id* value must be non-null and less than 64 characters. + +The *geoshape* parameter must be a non-null [Geocircle](../windows.devices.geolocation/geocircle.md) with a [SpatialReferenceId](../windows.devices.geolocation/igeoshape_spatialreferenceid.md) that matches the platform or an exception will be thrown. + +If the expiration date for the geofence - which is the start time plus the duration time span - occurs sooner than the creation time plus the dwell time value, an exception will be thrown. + +## -examples + +## -see-also +[Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape)](geofence_geofence_161909132.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean)](geofence_geofence_1541426940.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan)](geofence_geofence_247731772.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofence_geofence_1541426940.md b/windows.devices.geolocation.geofencing/geofence_geofence_1541426940.md index 5528867eb6..c590c529be 100644 --- a/windows.devices.geolocation.geofencing/geofence_geofence_1541426940.md +++ b/windows.devices.geolocation.geofencing/geofence_geofence_1541426940.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape,Windows.Devices.Geolocation.Geofencing.MonitoredGeofenceStates,System.Boolean) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Geofence ## -description Initializes a new [Geofence](geofence.md) object given the *id*, the shape of the geofence, the states to monitor the geofence for, and the *singleUse* flag. ## -parameters ### -param id The Id of the geofence. ### -param geoshape The area that defines the geofence to monitor. ### -param monitoredStates The states to monitor the geofence for. ### -param singleUse True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. ## -remarks ## -examples ## -see-also [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape)](geofence_geofence_161909132.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan)](geofence_geofence_247731772.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan, DateTime, TimeSpan)](geofence_geofence_1118020828.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape,Windows.Devices.Geolocation.Geofencing.MonitoredGeofenceStates,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Geofence + +## -description +Initializes a new [Geofence](geofence.md) object given the *id*, the shape of the geofence, the states to monitor the geofence for, and the *singleUse* flag. + +## -parameters +### -param id +The Id of the geofence. + +### -param geoshape +The area that defines the geofence to monitor. + +### -param monitoredStates +The states to monitor the geofence for. + +### -param singleUse +True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. + +## -remarks + +## -examples + +## -see-also +[Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape)](geofence_geofence_161909132.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan)](geofence_geofence_247731772.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan, DateTime, TimeSpan)](geofence_geofence_1118020828.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofence_geofence_161909132.md b/windows.devices.geolocation.geofencing/geofence_geofence_161909132.md index 59a89936c4..b3c33a35cc 100644 --- a/windows.devices.geolocation.geofencing/geofence_geofence_161909132.md +++ b/windows.devices.geolocation.geofencing/geofence_geofence_161909132.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Geofence ## -description Initializes a new [Geofence](geofence.md) object given the *id* and the shape of the geofence. ## -parameters ### -param id The Id of the geofence. ### -param geoshape The area that defines the geofence to monitor. ## -remarks When this constructor is used, the [MonitoredStates](geofence_monitoredstates.md) will default to monitor for both the **Entered** and **Exited** states, [SingleUse](geofence_singleuse.md) will default to false, the [DwellTime](geofence_dwelltime.md) will default to 10 seconds, the [StartTime](geofence_starttime.md) will default to 0 meaning start immediately, and the [Duration](geofence_duration.md) will default to 0, meaning forever. The *id* value must be non-null and less than 64 characters. The *geoshape* parameter must be a non-null [Geocircle](../windows.devices.geolocation/geocircle.md) with a [SpatialReferenceId](../windows.devices.geolocation/igeoshape_spatialreferenceid.md) that matches the platform or an exception will be thrown. ## -examples ## -see-also [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean)](geofence_geofence_1541426940.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan)](geofence_geofence_247731772.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan, DateTime, TimeSpan)](geofence_geofence_1118020828.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Geofence + +## -description +Initializes a new [Geofence](geofence.md) object given the *id* and the shape of the geofence. + +## -parameters +### -param id +The Id of the geofence. + +### -param geoshape +The area that defines the geofence to monitor. + +## -remarks +When this constructor is used, the [MonitoredStates](geofence_monitoredstates.md) will default to monitor for both the **Entered** and **Exited** states, [SingleUse](geofence_singleuse.md) will default to false, the [DwellTime](geofence_dwelltime.md) will default to 10 seconds, the [StartTime](geofence_starttime.md) will default to 0 meaning start immediately, and the [Duration](geofence_duration.md) will default to 0, meaning forever. + +The *id* value must be non-null and less than 64 characters. + +The *geoshape* parameter must be a non-null [Geocircle](../windows.devices.geolocation/geocircle.md) with a [SpatialReferenceId](../windows.devices.geolocation/igeoshape_spatialreferenceid.md) that matches the platform or an exception will be thrown. + +## -examples + +## -see-also +[Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean)](geofence_geofence_1541426940.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan)](geofence_geofence_247731772.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan, DateTime, TimeSpan)](geofence_geofence_1118020828.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofence_geofence_247731772.md b/windows.devices.geolocation.geofencing/geofence_geofence_247731772.md index 6eac47286e..c641420e04 100644 --- a/windows.devices.geolocation.geofencing/geofence_geofence_247731772.md +++ b/windows.devices.geolocation.geofencing/geofence_geofence_247731772.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape,Windows.Devices.Geolocation.Geofencing.MonitoredGeofenceStates,System.Boolean,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Geofence ## -description Initializes a new [Geofence](geofence.md) object given the *id*, the shape of the geofence, the states to monitor the geofence for, the *singleUse* flag, and the *dwellTime* for the geofence. ## -parameters ### -param id The Id of the geofence. ### -param geoshape The area that defines the geofence to monitor. ### -param monitoredStates The states to monitor the geofence for. ### -param singleUse True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. ### -param dwellTime The time that a position has to be in or out of the geofence in order for the notification to be triggered. This object must represent a positive value. ## -remarks ## -examples ## -see-also [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape)](geofence_geofence_161909132.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean)](geofence_geofence_1541426940.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan, DateTime, TimeSpan)](geofence_geofence_1118020828.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geofencing.Geofence.#ctor(System.String,Windows.Devices.Geolocation.IGeoshape,Windows.Devices.Geolocation.Geofencing.MonitoredGeofenceStates,System.Boolean,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Geofence + +## -description +Initializes a new [Geofence](geofence.md) object given the *id*, the shape of the geofence, the states to monitor the geofence for, the *singleUse* flag, and the *dwellTime* for the geofence. + +## -parameters +### -param id +The Id of the geofence. + +### -param geoshape +The area that defines the geofence to monitor. + +### -param monitoredStates +The states to monitor the geofence for. + +### -param singleUse +True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. + +### -param dwellTime +The time that a position has to be in or out of the geofence in order for the notification to be triggered. This object must represent a positive value. + +## -remarks + +## -examples + +## -see-also +[Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Geofence(String, IGeoshape)](geofence_geofence_161909132.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean)](geofence_geofence_1541426940.md), [Geofence(String, IGeoshape, MonitoredGeofenceStates, Boolean, TimeSpan, DateTime, TimeSpan)](geofence_geofence_1118020828.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofence_geoshape.md b/windows.devices.geolocation.geofencing/geofence_geoshape.md index faa5e4d2ad..d4324d5471 100644 --- a/windows.devices.geolocation.geofencing/geofence_geoshape.md +++ b/windows.devices.geolocation.geofencing/geofence_geoshape.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.Geoshape --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Geoshape ## -description The shape of the geofence region. ## -property-value The shape of the geofence region. ## -remarks This property is read-only. You must set the shape of a geofence when you initialize it using one of the constructors. The type of this property, [IGeoshape](../windows.devices.geolocation/igeoshape.md), is an interface to enable the possibility of supporting multiple shapes for geofences. The only shape that is currently supported is [Geocircle](../windows.devices.geolocation/geocircle.md), so this is the class you should use when initializing your geofences. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.Geoshape +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Geoshape + +## -description +The shape of the geofence region. + +## -property-value +The shape of the geofence region. + +## -remarks +This property is read-only. You must set the shape of a geofence when you initialize it using one of the constructors. + +The type of this property, [IGeoshape](../windows.devices.geolocation/igeoshape.md), is an interface to enable the possibility of supporting multiple shapes for geofences. The only shape that is currently supported is [Geocircle](../windows.devices.geolocation/geocircle.md), so this is the class you should use when initializing your geofences. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence_id.md b/windows.devices.geolocation.geofencing/geofence_id.md index c2450dff7e..274b9862f5 100644 --- a/windows.devices.geolocation.geofencing/geofence_id.md +++ b/windows.devices.geolocation.geofencing/geofence_id.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.Id --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.Id ## -description The id of the [Geofence](geofence.md). ## -property-value The id of the geofence. ## -remarks The *Id* is limited in length to 63 characters. The *Id* value must be unique among all geofences associated with the same application and user. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.Id + +## -description +The id of the [Geofence](geofence.md). + +## -property-value +The id of the geofence. + +## -remarks +The *Id* is limited in length to 63 characters. + +The *Id* value must be unique among all geofences associated with the same application and user. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence_monitoredstates.md b/windows.devices.geolocation.geofencing/geofence_monitoredstates.md index cb5d38ccae..31c56bf9b8 100644 --- a/windows.devices.geolocation.geofencing/geofence_monitoredstates.md +++ b/windows.devices.geolocation.geofencing/geofence_monitoredstates.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.MonitoredStates --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.MonitoredStates ## -description Indicates the states that the [Geofence](geofence.md) is being monitored for. ## -property-value The states that the geofence is being monitored for. ## -remarks You must specify the **Entered** or **Exited** states, or both, for a geofence to be monitored. It is not possible to create a geofence that only monitors the **Removed** state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.MonitoredStates +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.MonitoredStates + +## -description +Indicates the states that the [Geofence](geofence.md) is being monitored for. + +## -property-value +The states that the geofence is being monitored for. + +## -remarks +You must specify the **Entered** or **Exited** states, or both, for a geofence to be monitored. It is not possible to create a geofence that only monitors the **Removed** state. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence_singleuse.md b/windows.devices.geolocation.geofencing/geofence_singleuse.md index 6e6a31231a..a9fe192649 100644 --- a/windows.devices.geolocation.geofencing/geofence_singleuse.md +++ b/windows.devices.geolocation.geofencing/geofence_singleuse.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.SingleUse --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.SingleUse ## -description Indicates whether the [Geofence](geofence.md) should be triggered once or multiple times. ## -property-value **True** indicates the geofence should be monitored only for one use. **False** indicates the geofence should be monitored for multiple uses. ## -remarks A geofence is considered used when all [MonitoredStates](geofence_monitoredstates.md) have been triggered. If a geofence is only being monitored for the **Entered** event and [SingleUse](geofence_singleuse.md) is set to **true**, then entering the geofence will mark it as used and it will be removed. If a geofence is being monitored for both **Entered** and **Exited** events and [SingleUse](geofence_singleuse.md) is set to **true**, then the geofence will be removed after the user has both entered and exited the geofence. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.SingleUse +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.SingleUse + +## -description +Indicates whether the [Geofence](geofence.md) should be triggered once or multiple times. + +## -property-value +**True** indicates the geofence should be monitored only for one use. **False** indicates the geofence should be monitored for multiple uses. + +## -remarks +A geofence is considered used when all [MonitoredStates](geofence_monitoredstates.md) have been triggered. If a geofence is only being monitored for the **Entered** event and [SingleUse](geofence_singleuse.md) is set to **true**, then entering the geofence will mark it as used and it will be removed. If a geofence is being monitored for both **Entered** and **Exited** events and [SingleUse](geofence_singleuse.md) is set to **true**, then the geofence will be removed after the user has both entered and exited the geofence. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofence_starttime.md b/windows.devices.geolocation.geofencing/geofence_starttime.md index 40d00a4ee3..f3da9128e9 100644 --- a/windows.devices.geolocation.geofencing/geofence_starttime.md +++ b/windows.devices.geolocation.geofencing/geofence_starttime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.StartTime --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.Geofence.StartTime ## -description The time to start monitoring the [Geofence](geofence.md). ## -property-value The time to start monitoring the geofence. The default value is 0, which is the beginning of time, epoch. ## -remarks A geofence is made active when the [StartTime](geofence_starttime.md) is in the past. If the device is within the geofence's area when it becomes active and the geofence is being monitored for the **Entered** state, then the geofence will trigger as soon as the [DwellTime](geofence_dwelltime.md) requirement has been met. However, if the device is outside of the geofence when it becomes active, the geofence does not instantly switch to the **Exited** state. The device must enter a geofence, remain inside for the specified [DwellTime](geofence_dwelltime.md), and then exit in order to switch to the **Exited** state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.Geofence.StartTime +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.Geofence.StartTime + +## -description +The time to start monitoring the [Geofence](geofence.md). + +## -property-value +The time to start monitoring the geofence. The default value is 0, which is the beginning of time, epoch. + +## -remarks +A geofence is made active when the [StartTime](geofence_starttime.md) is in the past. If the device is within the geofence's area when it becomes active and the geofence is being monitored for the **Entered** state, then the geofence will trigger as soon as the [DwellTime](geofence_dwelltime.md) requirement has been met. However, if the device is outside of the geofence when it becomes active, the geofence does not instantly switch to the **Exited** state. The device must enter a geofence, remain inside for the specified [DwellTime](geofence_dwelltime.md), and then exit in order to switch to the **Exited** state. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation.geofencing/geofencemonitor.md b/windows.devices.geolocation.geofencing/geofencemonitor.md index de2740e7d7..8c145ea2b5 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor --api-type: winrt class ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor ## -description Contains the information about the monitored [Geofence](geofence.md) objects. ## -remarks Use the static [Current](geofencemonitor_current.md) property to get the [GeofenceMonitor](geofencemonitor.md) object which contains all of an app’s geofence information. You will receive an **IDS_GEOFENCEMONITOR_OUT_OF_SYNC** exception if the Location Framework Service event state is out of synchronization with the [GeofenceMonitor](geofencemonitor.md). You can attempt to recover by removing all event handlers on the [GeofenceMonitor](geofencemonitor.md) or restarting the application. Once all event handlers have been removed, you may add back any event handlers and retry the operation. ## -examples ## -see-also [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Windows.Devices.Geolocation](windows_devices_geolocation_geofencing.md), [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor + +## -description +Contains the information about the monitored [Geofence](geofence.md) objects. + +## -remarks +Use the static [Current](geofencemonitor_current.md) property to get the [GeofenceMonitor](geofencemonitor.md) object which contains all of an app’s geofence information. + +You will receive an **IDS_GEOFENCEMONITOR_OUT_OF_SYNC** exception if the Location Framework Service event state is out of synchronization with the [GeofenceMonitor](geofencemonitor.md). You can attempt to recover by removing all event handlers on the [GeofenceMonitor](geofencemonitor.md) or restarting the application. Once all event handlers have been removed, you may add back any event handlers and retry the operation. + +## -examples + +## -see-also +[Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [Windows.Devices.Geolocation](windows_devices_geolocation_geofencing.md), [Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_current.md b/windows.devices.geolocation.geofencing/geofencemonitor_current.md index 12778d8d1b..1da43ff57b 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_current.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_current.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Current --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Current ## -description Gets the [GeofenceMonitor](geofencemonitor.md) object which contains all of an app's [Geofence](geofence.md) information. ## -property-value Gets the [GeofenceMonitor](geofencemonitor.md) object which contains all of an app's geofence information. ## -remarks ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Current +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Current + +## -description +Gets the [GeofenceMonitor](geofencemonitor.md) object which contains all of an app's [Geofence](geofence.md) information. + +## -property-value +Gets the [GeofenceMonitor](geofencemonitor.md) object which contains all of an app's geofence information. + +## -remarks + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_geofences.md b/windows.devices.geolocation.geofencing/geofencemonitor_geofences.md index cf1b26c381..61e852663b 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_geofences.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_geofences.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Geofences --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Geofences ## -description Returns a vector of the app's [Geofence](geofence.md) objects currently registered with the system-wide [GeofenceMonitor](geofencemonitor.md). ## -property-value A collection of the [Geofence](geofence.md) objects to monitor. ## -remarks Register a [Geofence](geofence.md) to be monitored by the system by adding it to this collection. Geofences are persisted to disk, so they only need to be added to the system once. Attempting to add a [Geofence](geofence.md) with an [Id](geofence_id.md) that is already registered will throw an exception. Attempting to remove a [Geofence](geofence.md) from the [Geofences](geofencemonitor_geofences.md) property will fail with an exception if the specified [Geofence](geofence.md) is registered with the system but does not belong to the calling application's collection. This vector reflects only updates made by the app. To view changes made by the system, as in after a single-use [Geofence](geofence.md) is triggered and removed, the app can call this property again or safely remove the removed [Geofence](geofence.md) from a previously returned vector. ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Geofences +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Geofences + +## -description +Returns a vector of the app's [Geofence](geofence.md) objects currently registered with the system-wide [GeofenceMonitor](geofencemonitor.md). + +## -property-value +A collection of the [Geofence](geofence.md) objects to monitor. + +## -remarks +Register a [Geofence](geofence.md) to be monitored by the system by adding it to this collection. + +Geofences are persisted to disk, so they only need to be added to the system once. Attempting to add a [Geofence](geofence.md) with an [Id](geofence_id.md) that is already registered will throw an exception. + +Attempting to remove a [Geofence](geofence.md) from the [Geofences](geofencemonitor_geofences.md) property will fail with an exception if the specified [Geofence](geofence.md) is registered with the system but does not belong to the calling application's collection. + +This vector reflects only updates made by the app. To view changes made by the system, as in after a single-use [Geofence](geofence.md) is triggered and removed, the app can call this property again or safely remove the removed [Geofence](geofence.md) from a previously returned vector. + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_geofencestatechanged.md b/windows.devices.geolocation.geofencing/geofencemonitor_geofencestatechanged.md index 0bddc03ac5..378b264e8c 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_geofencestatechanged.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_geofencestatechanged.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.GeofenceStateChanged --api-type: winrt event ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.GeofenceStateChanged ## -description Raised when the state of one or more [Geofence](geofence.md) objects in the [Geofences](geofencemonitor_geofences.md) collection of the [GeofenceMonitor](geofencemonitor.md) has changed ## -remarks This event is raised when your app is running and the state of a geofence registered by your app changes. This event is also raised when your app activates if there are unread reports in the collection obtained by calling [ReadReports](geofencemonitor_readreports.md). This allows an app that is coming back from being suspended to be notified that there are unread reports in the queue and update the UI accordingly. This also allows your app to read reports that occurred in the background in cases where your background task was not launched to due to conditions set with [SystemCondition](../windows.applicationmodel.background/systemcondition.md), such as waiting for an internet connection or waiting for the user to be present. ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.GeofenceStateChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.GeofenceStateChanged + +## -description +Raised when the state of one or more [Geofence](geofence.md) objects in the [Geofences](geofencemonitor_geofences.md) collection of the [GeofenceMonitor](geofencemonitor.md) has changed + +## -remarks +This event is raised when your app is running and the state of a geofence registered by your app changes. This event is also raised when your app activates if there are unread reports in the collection obtained by calling [ReadReports](geofencemonitor_readreports.md). This allows an app that is coming back from being suspended to be notified that there are unread reports in the queue and update the UI accordingly. This also allows your app to read reports that occurred in the background in cases where your background task was not launched to due to conditions set with [SystemCondition](../windows.applicationmodel.background/systemcondition.md), such as waiting for an internet connection or waiting for the user to be present. + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_lastknowngeoposition.md b/windows.devices.geolocation.geofencing/geofencemonitor_lastknowngeoposition.md index 716100ea07..675b156e87 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_lastknowngeoposition.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_lastknowngeoposition.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.LastKnownGeoposition --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.LastKnownGeoposition ## -description Last reading of the device's location. ## -property-value Last reading of the device's location. ## -remarks Before using the value from this property, the application must first check that the value is not **NULL**. ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.LastKnownGeoposition +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.LastKnownGeoposition + +## -description +Last reading of the device's location. + +## -property-value +Last reading of the device's location. + +## -remarks +Before using the value from this property, the application must first check that the value is not **NULL**. + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_readreports_231406138.md b/windows.devices.geolocation.geofencing/geofencemonitor_readreports_231406138.md index aa152a75e5..0ea73305c0 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_readreports_231406138.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_readreports_231406138.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.ReadReports --api-type: winrt method ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.ReadReports ## -description Gets a collection of status changes to the [Geofence](geofence.md) objects in the [Geofences](geofencemonitor_geofences.md) collection of the [GeofenceMonitor](geofencemonitor.md). ## -returns collection of status changes to the [Geofence](geofence.md) object(s) in [GeofenceMonitor](geofencemonitor.md). ## -remarks Each report in the collection contains the most recent state for the geofences that changed state since the last time **ReadReports** was called. Older state changes may be present in the collection if **ReadReports** hasn't been called over a period of time when many geofence state changes have occurred, but the system may purge these older state changes. The collection returned from this method may be empty and contain no [GeofenceStateChangeReport](geofencestatechangereport.md) objects. This can happen if no status changes have occurred since the last time the method was called, either by the app or the background task. ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.ReadReports +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.ReadReports + +## -description +Gets a collection of status changes to the [Geofence](geofence.md) objects in the [Geofences](geofencemonitor_geofences.md) collection of the [GeofenceMonitor](geofencemonitor.md). + +## -returns +collection of status changes to the [Geofence](geofence.md) object(s) in [GeofenceMonitor](geofencemonitor.md). + +## -remarks +Each report in the collection contains the most recent state for the geofences that changed state since the last time **ReadReports** was called. Older state changes may be present in the collection if **ReadReports** hasn't been called over a period of time when many geofence state changes have occurred, but the system may purge these older state changes. + +The collection returned from this method may be empty and contain no [GeofenceStateChangeReport](geofencestatechangereport.md) objects. This can happen if no status changes have occurred since the last time the method was called, either by the app or the background task. + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_status.md b/windows.devices.geolocation.geofencing/geofencemonitor_status.md index 964db85113..f2160d586d 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_status.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Status --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Status ## -description Indicates the current state of the [GeofenceMonitor](geofencemonitor.md). ## -property-value Indicates the current state of a [GeofenceMonitor](geofencemonitor.md). ## -remarks ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.Status + +## -description +Indicates the current state of the [GeofenceMonitor](geofencemonitor.md). + +## -property-value +Indicates the current state of a [GeofenceMonitor](geofencemonitor.md). + +## -remarks + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencemonitor_statuschanged.md b/windows.devices.geolocation.geofencing/geofencemonitor_statuschanged.md index d20bf95a0f..2119fb600a 100644 --- a/windows.devices.geolocation.geofencing/geofencemonitor_statuschanged.md +++ b/windows.devices.geolocation.geofencing/geofencemonitor_statuschanged.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.StatusChanged --api-type: winrt event ---- # Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.StatusChanged ## -description Raised when the status of the [GeofenceMonitor](geofencemonitor.md) has changed. ## -remarks When using a geofence, use the [GeofenceMonitor](geofencemonitor.md) 's [StatusChanged](geofencemonitor_statuschanged.md) event to monitor changes in location permissions instead of the [StatusChanged](../windows.devices.geolocation/geolocator_statuschanged.md) event from the [Geolocator](../windows.devices.geolocation/geolocator.md) class. A [GeofenceMonitorStatus](geofencemonitorstatus.md) of **Disabled** is equivalent to a **Disabled **[PositionStatus](../windows.devices.geolocation/positionstatus.md) - both indicate that the app does not have permission to access the location. ## -examples ## -see-also [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.StatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceMonitor.StatusChanged + +## -description +Raised when the status of the [GeofenceMonitor](geofencemonitor.md) has changed. + +## -remarks +When using a geofence, use the [GeofenceMonitor](geofencemonitor.md) 's [StatusChanged](geofencemonitor_statuschanged.md) event to monitor changes in location permissions instead of the [StatusChanged](../windows.devices.geolocation/geolocator_statuschanged.md) event from the [Geolocator](../windows.devices.geolocation/geolocator.md) class. A [GeofenceMonitorStatus](geofencemonitorstatus.md) of **Disabled** is equivalent to a **Disabled **[PositionStatus](../windows.devices.geolocation/positionstatus.md) - both indicate that the app does not have permission to access the location. + +## -examples + +## -see-also +[Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencestatechangereport.md b/windows.devices.geolocation.geofencing/geofencestatechangereport.md index 49d9f3b0cd..992b568bd8 100644 --- a/windows.devices.geolocation.geofencing/geofencestatechangereport.md +++ b/windows.devices.geolocation.geofencing/geofencestatechangereport.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport --api-type: winrt class ---- # Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport ## -description Contains the information about the state changes for a [Geofence](geofence.md). ## -remarks Use the [GeofenceMonitor.ReadReports](geofencemonitor_readreports.md) method to get a collection of [GeofenceStateChangeReport](geofencestatechangereport.md) objects which contain information about changes in state to a geofence. ## -examples ## -see-also [Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport + +## -description +Contains the information about the state changes for a [Geofence](geofence.md). + +## -remarks +Use the [GeofenceMonitor.ReadReports](geofencemonitor_readreports.md) method to get a collection of [GeofenceStateChangeReport](geofencestatechangereport.md) objects which contain information about changes in state to a geofence. + +## -examples + +## -see-also +[Geofencing, start to finish](http://msdn.microsoft.com/library/eee6b589-2eab-4279-ac61-22bfa5e06d8e), [GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencestatechangereport_geofence.md b/windows.devices.geolocation.geofencing/geofencestatechangereport_geofence.md index 34c6bf33f1..91fd96c02b 100644 --- a/windows.devices.geolocation.geofencing/geofencestatechangereport_geofence.md +++ b/windows.devices.geolocation.geofencing/geofencestatechangereport_geofence.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geofence --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geofence ## -description The [Geofence](geofence.md) object whose state has changed. ## -property-value The [Geofence](geofence.md) object whose state has changed. ## -remarks ## -examples ## -see-also [GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geofence +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geofence + +## -description +The [Geofence](geofence.md) object whose state has changed. + +## -property-value +The [Geofence](geofence.md) object whose state has changed. + +## -remarks + +## -examples + +## -see-also +[GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencestatechangereport_geoposition.md b/windows.devices.geolocation.geofencing/geofencestatechangereport_geoposition.md index 49033bccfd..b04cd4cb0a 100644 --- a/windows.devices.geolocation.geofencing/geofencestatechangereport_geoposition.md +++ b/windows.devices.geolocation.geofencing/geofencestatechangereport_geoposition.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geoposition --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geoposition ## -description The position of the [Geofence](geofence.md) object whose state has changed. ## -property-value The position of the [Geofence](geofence.md) object whose state has changed. ## -remarks ## -examples ## -see-also [GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geoposition +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.Geoposition + +## -description +The position of the [Geofence](geofence.md) object whose state has changed. + +## -property-value +The position of the [Geofence](geofence.md) object whose state has changed. + +## -remarks + +## -examples + +## -see-also +[GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencestatechangereport_newstate.md b/windows.devices.geolocation.geofencing/geofencestatechangereport_newstate.md index 1b2f3495e6..3fe7ad1639 100644 --- a/windows.devices.geolocation.geofencing/geofencestatechangereport_newstate.md +++ b/windows.devices.geolocation.geofencing/geofencestatechangereport_newstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.NewState --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.NewState ## -description The new state of the [Geofence](geofence.md) object whose state has changed. ## -property-value The new state of the [Geofence](geofence.md) object whose state has changed. ## -remarks ## -examples ## -see-also [GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.NewState +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.NewState + +## -description +The new state of the [Geofence](geofence.md) object whose state has changed. + +## -property-value +The new state of the [Geofence](geofence.md) object whose state has changed. + +## -remarks + +## -examples + +## -see-also +[GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation.geofencing/geofencestatechangereport_removalreason.md b/windows.devices.geolocation.geofencing/geofencestatechangereport_removalreason.md index 9d72b9a241..f981927cc7 100644 --- a/windows.devices.geolocation.geofencing/geofencestatechangereport_removalreason.md +++ b/windows.devices.geolocation.geofencing/geofencestatechangereport_removalreason.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.RemovalReason --api-type: winrt property ---- # Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.RemovalReason ## -description Indicates the reason a [Geofence](geofence.md) was removed. ## -property-value Indicates the reason a geofence was removed. ## -remarks This property defaults to a value of **Used**. You should ignore this property unless the Geofence has changed state to being **Removed**. Removal event notifications can happen when the app is in the foreground or the background. However, removal events themselves do not fire the trigger when the app is in the background. This means that background apps cannot use the removal event to wake up the app. When an app comes back from being in the background, it can see the removal event that occurred waiting in the [GeofenceStateChangeReports.](geofencestatechangereport.md) ## -examples ## -see-also [GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.RemovalReason +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geofencing.GeofenceStateChangeReport.RemovalReason + +## -description +Indicates the reason a [Geofence](geofence.md) was removed. + +## -property-value +Indicates the reason a geofence was removed. + +## -remarks +This property defaults to a value of **Used**. You should ignore this property unless the Geofence has changed state to being **Removed**. + +Removal event notifications can happen when the app is in the foreground or the background. However, removal events themselves do not fire the trigger when the app is in the background. This means that background apps cannot use the removal event to wake up the app. When an app comes back from being in the background, it can see the removal event that occurred waiting in the [GeofenceStateChangeReports.](geofencestatechangereport.md) + +## -examples + +## -see-also +[GeofenceMonitor](geofencemonitor.md), [Geofence](geofence.md) \ No newline at end of file diff --git a/windows.devices.geolocation/civicaddress_city.md b/windows.devices.geolocation/civicaddress_city.md index 8847ffab7b..7000f8642b 100644 --- a/windows.devices.geolocation/civicaddress_city.md +++ b/windows.devices.geolocation/civicaddress_city.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.CivicAddress.City --api-type: winrt property ---- # Windows.Devices.Geolocation.CivicAddress.City ## -description Unsupported API. ## -property-value Unsupported API. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.CivicAddress.City +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.CivicAddress.City + +## -description +Unsupported API. + +## -property-value +Unsupported API. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/civicaddress_country.md b/windows.devices.geolocation/civicaddress_country.md index c7c347f862..21da5ea706 100644 --- a/windows.devices.geolocation/civicaddress_country.md +++ b/windows.devices.geolocation/civicaddress_country.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.CivicAddress.Country --api-type: winrt property ---- # Windows.Devices.Geolocation.CivicAddress.Country ## -description Unsupported API. ## -property-value Unsupported API. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.CivicAddress.Country +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.CivicAddress.Country + +## -description +Unsupported API. + +## -property-value +Unsupported API. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/civicaddress_postalcode.md b/windows.devices.geolocation/civicaddress_postalcode.md index c726dfa9c3..65290e72c7 100644 --- a/windows.devices.geolocation/civicaddress_postalcode.md +++ b/windows.devices.geolocation/civicaddress_postalcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.CivicAddress.PostalCode --api-type: winrt property ---- # Windows.Devices.Geolocation.CivicAddress.PostalCode ## -description Unsupported API. ## -property-value Unsupported API. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.CivicAddress.PostalCode +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.CivicAddress.PostalCode + +## -description +Unsupported API. + +## -property-value +Unsupported API. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/civicaddress_state.md b/windows.devices.geolocation/civicaddress_state.md index 7280de1f6b..05f809866a 100644 --- a/windows.devices.geolocation/civicaddress_state.md +++ b/windows.devices.geolocation/civicaddress_state.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.CivicAddress.State --api-type: winrt property ---- # Windows.Devices.Geolocation.CivicAddress.State ## -description Unsupported API. ## -property-value Unsupported API. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.CivicAddress.State +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.CivicAddress.State + +## -description +Unsupported API. + +## -property-value +Unsupported API. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/civicaddress_timestamp.md b/windows.devices.geolocation/civicaddress_timestamp.md index 87a055f709..35b412cc89 100644 --- a/windows.devices.geolocation/civicaddress_timestamp.md +++ b/windows.devices.geolocation/civicaddress_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.CivicAddress.Timestamp --api-type: winrt property ---- # Windows.Devices.Geolocation.CivicAddress.Timestamp ## -description Unsupported API. ## -property-value Unsupported API. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.CivicAddress.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.CivicAddress.Timestamp + +## -description +Unsupported API. + +## -property-value +Unsupported API. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox.md b/windows.devices.geolocation/geoboundingbox.md index ecc1b1fa46..24b62c002a 100644 --- a/windows.devices.geolocation/geoboundingbox.md +++ b/windows.devices.geolocation/geoboundingbox.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Geolocation.GeoboundingBox --api-type: winrt class ---- # Windows.Devices.Geolocation.GeoboundingBox ## -description Represents a rectangle that defines a geographic area. ## -remarks ## -examples ## -see-also [IGeoshape](igeoshape.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.GeoboundingBox +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox + +## -description +Represents a rectangle that defines a geographic area. + +## -remarks + +## -examples + +## -see-also +[IGeoshape](igeoshape.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox_altitudereferencesystem.md b/windows.devices.geolocation/geoboundingbox_altitudereferencesystem.md index dbbd5ba82e..3bfeb2d3b6 100644 --- a/windows.devices.geolocation/geoboundingbox_altitudereferencesystem.md +++ b/windows.devices.geolocation/geoboundingbox_altitudereferencesystem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.AltitudeReferenceSystem --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.AltitudeReferenceSystem ## -description Gets the altitude reference system used by the [GeoboundingBox](geoboundingbox.md). ## -property-value The altitude reference system used by the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.AltitudeReferenceSystem +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.AltitudeReferenceSystem + +## -description +Gets the altitude reference system used by the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The altitude reference system used by the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_center.md b/windows.devices.geolocation/geoboundingbox_center.md index fba91334b2..1baa882b31 100644 --- a/windows.devices.geolocation/geoboundingbox_center.md +++ b/windows.devices.geolocation/geoboundingbox_center.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.Center --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.Center ## -description Gets the center of the [GeoboundingBox](geoboundingbox.md). ## -property-value The center of the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.Center +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.Center + +## -description +Gets the center of the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The center of the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_geoboundingbox_1237088599.md b/windows.devices.geolocation/geoboundingbox_geoboundingbox_1237088599.md index d71476de90..e3a72928cd 100644 --- a/windows.devices.geolocation/geoboundingbox_geoboundingbox_1237088599.md +++ b/windows.devices.geolocation/geoboundingbox_geoboundingbox_1237088599.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Geolocation.GeoboundingBox.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.BasicGeoposition) --api-type: winrt method ---- # Windows.Devices.Geolocation.GeoboundingBox.GeoboundingBox ## -description Initializes a new instance of the [GeoboundingBox](geoboundingbox.md) class that has the specified corners. ## -parameters ### -param northwestCorner The northwest corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [NorthwestCorner](geoboundingbox_northwestcorner.md) property. ### -param southeastCorner The southeast corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SoutheastCorner](geoboundingbox_southeastcorner.md) property. ## -remarks ## -examples ## -see-also [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem)](geoboundingbox_geoboundingbox_267191261.md), [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem, UInt32)](geoboundingbox_geoboundingbox_271676437.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.GeoboundingBox.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.BasicGeoposition) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.GeoboundingBox + +## -description +Initializes a new instance of the [GeoboundingBox](geoboundingbox.md) class that has the specified corners. + +## -parameters +### -param northwestCorner +The northwest corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [NorthwestCorner](geoboundingbox_northwestcorner.md) property. + +### -param southeastCorner +The southeast corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SoutheastCorner](geoboundingbox_southeastcorner.md) property. + +## -remarks + +## -examples + +## -see-also +[GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem)](geoboundingbox_geoboundingbox_267191261.md), [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem, UInt32)](geoboundingbox_geoboundingbox_271676437.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox_geoboundingbox_267191261.md b/windows.devices.geolocation/geoboundingbox_geoboundingbox_267191261.md index 6892c1bb3d..12da9c21de 100644 --- a/windows.devices.geolocation/geoboundingbox_geoboundingbox_267191261.md +++ b/windows.devices.geolocation/geoboundingbox_geoboundingbox_267191261.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Geolocation.GeoboundingBox.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem) --api-type: winrt method ---- # Windows.Devices.Geolocation.GeoboundingBox.GeoboundingBox ## -description Initializes a new instance of the [GeoboundingBox](geoboundingbox.md) class that has the specified corners and uses the specified altitude reference system. ## -parameters ### -param northwestCorner The northwest corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [NorthwestCorner](geoboundingbox_northwestcorner.md) property. ### -param southeastCorner The southeast corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SoutheastCorner](geoboundingbox_southeastcorner.md) property. ### -param altitudeReferenceSystem The altitude reference system to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. ## -remarks ## -examples ## -see-also [GeoboundingBox(BasicGeoposition, BasicGeoposition)](geoboundingbox_geoboundingbox_1237088599.md), [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem, UInt32)](geoboundingbox_geoboundingbox_271676437.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.GeoboundingBox.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.GeoboundingBox + +## -description +Initializes a new instance of the [GeoboundingBox](geoboundingbox.md) class that has the specified corners and uses the specified altitude reference system. + +## -parameters +### -param northwestCorner +The northwest corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [NorthwestCorner](geoboundingbox_northwestcorner.md) property. + +### -param southeastCorner +The southeast corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SoutheastCorner](geoboundingbox_southeastcorner.md) property. + +### -param altitudeReferenceSystem +The altitude reference system to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. + +## -remarks + +## -examples + +## -see-also +[GeoboundingBox(BasicGeoposition, BasicGeoposition)](geoboundingbox_geoboundingbox_1237088599.md), [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem, UInt32)](geoboundingbox_geoboundingbox_271676437.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox_geoboundingbox_271676437.md b/windows.devices.geolocation/geoboundingbox_geoboundingbox_271676437.md index 94a7852896..28c704ba17 100644 --- a/windows.devices.geolocation/geoboundingbox_geoboundingbox_271676437.md +++ b/windows.devices.geolocation/geoboundingbox_geoboundingbox_271676437.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Geolocation.GeoboundingBox.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) --api-type: winrt method ---- # Windows.Devices.Geolocation.GeoboundingBox.GeoboundingBox ## -description Initializes a new instance of the [GeoboundingBox](geoboundingbox.md) class that has the specified corners and uses the specified altitude reference system and spatial reference ID (SRID). ## -parameters ### -param northwestCorner The northwest corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [NorthwestCorner](geoboundingbox_northwestcorner.md) property. ### -param southeastCorner The southeast corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SoutheastCorner](geoboundingbox_southeastcorner.md) property. ### -param altitudeReferenceSystem The altitude reference system to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. ### -param spatialReferenceId The spatial reference ID (SRID) to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SpatialReferenceId](geoboundingbox_spatialreferenceid.md) property. ## -remarks ## -examples ## -see-also [GeoboundingBox(BasicGeoposition, BasicGeoposition)](geoboundingbox_geoboundingbox_1237088599.md), [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem)](geoboundingbox_geoboundingbox_267191261.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.GeoboundingBox.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.GeoboundingBox + +## -description +Initializes a new instance of the [GeoboundingBox](geoboundingbox.md) class that has the specified corners and uses the specified altitude reference system and spatial reference ID (SRID). + +## -parameters +### -param northwestCorner +The northwest corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [NorthwestCorner](geoboundingbox_northwestcorner.md) property. + +### -param southeastCorner +The southeast corner to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SoutheastCorner](geoboundingbox_southeastcorner.md) property. + +### -param altitudeReferenceSystem +The altitude reference system to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. + +### -param spatialReferenceId +The spatial reference ID (SRID) to use for the new [GeoboundingBox](geoboundingbox.md). For more info, see the [SpatialReferenceId](geoboundingbox_spatialreferenceid.md) property. + +## -remarks + +## -examples + +## -see-also +[GeoboundingBox(BasicGeoposition, BasicGeoposition)](geoboundingbox_geoboundingbox_1237088599.md), [GeoboundingBox(BasicGeoposition, BasicGeoposition, AltitudeReferenceSystem)](geoboundingbox_geoboundingbox_267191261.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox_geoshapetype.md b/windows.devices.geolocation/geoboundingbox_geoshapetype.md index 35cc0a5589..b34eb44b05 100644 --- a/windows.devices.geolocation/geoboundingbox_geoshapetype.md +++ b/windows.devices.geolocation/geoboundingbox_geoshapetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.GeoshapeType --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.GeoshapeType ## -description Gets the type of geographic shape represented by the [GeoboundingBox](geoboundingbox.md). ## -property-value The type of geographic shape represented by the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.GeoshapeType +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.GeoshapeType + +## -description +Gets the type of geographic shape represented by the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The type of geographic shape represented by the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_maxaltitude.md b/windows.devices.geolocation/geoboundingbox_maxaltitude.md index ede1569d9d..b8c2c14847 100644 --- a/windows.devices.geolocation/geoboundingbox_maxaltitude.md +++ b/windows.devices.geolocation/geoboundingbox_maxaltitude.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.MaxAltitude --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.MaxAltitude ## -description Gets the altitude of the highest corner of the [GeoboundingBox](geoboundingbox.md). ## -property-value The altitude of the highest corner of the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.MaxAltitude +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.MaxAltitude + +## -description +Gets the altitude of the highest corner of the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The altitude of the highest corner of the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_minaltitude.md b/windows.devices.geolocation/geoboundingbox_minaltitude.md index 37eb6b116b..5fdb15f34a 100644 --- a/windows.devices.geolocation/geoboundingbox_minaltitude.md +++ b/windows.devices.geolocation/geoboundingbox_minaltitude.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.MinAltitude --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.MinAltitude ## -description Gets the altitude of the lowest corner of the [GeoboundingBox](geoboundingbox.md). ## -property-value The altitude of the lowest corner of the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.MinAltitude +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.MinAltitude + +## -description +Gets the altitude of the lowest corner of the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The altitude of the lowest corner of the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_northwestcorner.md b/windows.devices.geolocation/geoboundingbox_northwestcorner.md index 962652e3fa..3a609112e5 100644 --- a/windows.devices.geolocation/geoboundingbox_northwestcorner.md +++ b/windows.devices.geolocation/geoboundingbox_northwestcorner.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.NorthwestCorner --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.NorthwestCorner ## -description Gets the northwest corner of the [GeoboundingBox](geoboundingbox.md). ## -property-value The northwest corner of the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.NorthwestCorner +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.NorthwestCorner + +## -description +Gets the northwest corner of the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The northwest corner of the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_southeastcorner.md b/windows.devices.geolocation/geoboundingbox_southeastcorner.md index db3e0d5454..73f1a06751 100644 --- a/windows.devices.geolocation/geoboundingbox_southeastcorner.md +++ b/windows.devices.geolocation/geoboundingbox_southeastcorner.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.SoutheastCorner --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.SoutheastCorner ## -description Gets the southeast corner of the [GeoboundingBox](geoboundingbox.md). ## -property-value The southeast corner of the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.SoutheastCorner +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.SoutheastCorner + +## -description +Gets the southeast corner of the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The southeast corner of the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_spatialreferenceid.md b/windows.devices.geolocation/geoboundingbox_spatialreferenceid.md index 175ec544d4..10c566c5e6 100644 --- a/windows.devices.geolocation/geoboundingbox_spatialreferenceid.md +++ b/windows.devices.geolocation/geoboundingbox_spatialreferenceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeoboundingBox.SpatialReferenceId --api-type: winrt property ---- # Windows.Devices.Geolocation.GeoboundingBox.SpatialReferenceId ## -description Gets the spatial reference ID (SRID) used by the [GeoboundingBox](geoboundingbox.md). ## -property-value The spatial reference ID (SRID) used by the [GeoboundingBox](geoboundingbox.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeoboundingBox.SpatialReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.SpatialReferenceId + +## -description +Gets the spatial reference ID (SRID) used by the [GeoboundingBox](geoboundingbox.md). + +## -property-value +The spatial reference ID (SRID) used by the [GeoboundingBox](geoboundingbox.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoboundingbox_trycompute_467892569.md b/windows.devices.geolocation/geoboundingbox_trycompute_467892569.md index 4c2f277805..d1b0b27224 100644 --- a/windows.devices.geolocation/geoboundingbox_trycompute_467892569.md +++ b/windows.devices.geolocation/geoboundingbox_trycompute_467892569.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Geolocation.GeoboundingBox.TryCompute(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition}) --api-type: winrt method ---- # Windows.Devices.Geolocation.GeoboundingBox.TryCompute ## -description Calculates a [GeoboundingBox](geoboundingbox.md) that contains the specified set of geographic positions. ## -parameters ### -param positions A collection of geographic positions to include inside the [GeoboundingBox](geoboundingbox.md). ## -returns The calculated rectangle that contains the specified set of geographic positions. ## -remarks ## -examples ## -see-also [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geoboundingbox_trycompute_952878109.md), [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geoboundingbox_trycompute_925237241.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.GeoboundingBox.TryCompute(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition}) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.TryCompute + +## -description +Calculates a [GeoboundingBox](geoboundingbox.md) that contains the specified set of geographic positions. + +## -parameters +### -param positions +A collection of geographic positions to include inside the [GeoboundingBox](geoboundingbox.md). + +## -returns +The calculated rectangle that contains the specified set of geographic positions. + +## -remarks + +## -examples + +## -see-also +[TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geoboundingbox_trycompute_952878109.md), [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geoboundingbox_trycompute_925237241.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox_trycompute_925237241.md b/windows.devices.geolocation/geoboundingbox_trycompute_925237241.md index 6ba10cdc00..2b56e64509 100644 --- a/windows.devices.geolocation/geoboundingbox_trycompute_925237241.md +++ b/windows.devices.geolocation/geoboundingbox_trycompute_925237241.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Geolocation.GeoboundingBox.TryCompute(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) --api-type: winrt method ---- # Windows.Devices.Geolocation.GeoboundingBox.TryCompute ## -description Calculates a [GeoboundingBox](geoboundingbox.md) that contains the specified set of geographic positions and uses the specified altitude reference system and spatial reference ID (SRID). ## -parameters ### -param positions A collection of geographic positions to include inside the [GeoboundingBox](geoboundingbox.md). ### -param altitudeRefSystem The altitude reference system to use for the [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. ### -param spatialReferenceId The spatial reference ID (SRID) to use for the [GeoboundingBox](geoboundingbox.md). For more info, see the [SpatialReferenceId](geoboundingbox_spatialreferenceid.md) property. ## -returns The calculated rectangle that contains the specified set of geographic positions. ## -remarks ## -examples ## -see-also [TryCompute(IIterable(BasicGeoposition))](geoboundingbox_trycompute_467892569.md), [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geoboundingbox_trycompute_952878109.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.GeoboundingBox.TryCompute(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.TryCompute + +## -description +Calculates a [GeoboundingBox](geoboundingbox.md) that contains the specified set of geographic positions and uses the specified altitude reference system and spatial reference ID (SRID). + +## -parameters +### -param positions +A collection of geographic positions to include inside the [GeoboundingBox](geoboundingbox.md). + +### -param altitudeRefSystem +The altitude reference system to use for the [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. + +### -param spatialReferenceId +The spatial reference ID (SRID) to use for the [GeoboundingBox](geoboundingbox.md). For more info, see the [SpatialReferenceId](geoboundingbox_spatialreferenceid.md) property. + +## -returns +The calculated rectangle that contains the specified set of geographic positions. + +## -remarks + +## -examples + +## -see-also +[TryCompute(IIterable(BasicGeoposition))](geoboundingbox_trycompute_467892569.md), [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geoboundingbox_trycompute_952878109.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geoboundingbox_trycompute_952878109.md b/windows.devices.geolocation/geoboundingbox_trycompute_952878109.md index 74c080b6ad..c597435657 100644 --- a/windows.devices.geolocation/geoboundingbox_trycompute_952878109.md +++ b/windows.devices.geolocation/geoboundingbox_trycompute_952878109.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Geolocation.GeoboundingBox.TryCompute(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem) --api-type: winrt method ---- # Windows.Devices.Geolocation.GeoboundingBox.TryCompute ## -description Calculates a [GeoboundingBox](geoboundingbox.md) that contains the specified set of geographic positions and uses the specified altitude reference system. ## -parameters ### -param positions A collection of geographic positions to include inside the [GeoboundingBox](geoboundingbox.md). ### -param altitudeRefSystem The altitude reference system to use for the [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. ## -returns The calculated rectangle that contains the specified set of geographic positions. ## -remarks ## -examples ## -see-also [TryCompute(IIterable(BasicGeoposition))](geoboundingbox_trycompute_467892569.md), [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geoboundingbox_trycompute_925237241.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.GeoboundingBox.TryCompute(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeoboundingBox.TryCompute + +## -description +Calculates a [GeoboundingBox](geoboundingbox.md) that contains the specified set of geographic positions and uses the specified altitude reference system. + +## -parameters +### -param positions +A collection of geographic positions to include inside the [GeoboundingBox](geoboundingbox.md). + +### -param altitudeRefSystem +The altitude reference system to use for the [GeoboundingBox](geoboundingbox.md). For more info, see the [AltitudeReferenceSystem](geoboundingbox_altitudereferencesystem.md) property. + +## -returns +The calculated rectangle that contains the specified set of geographic positions. + +## -remarks + +## -examples + +## -see-also +[TryCompute(IIterable(BasicGeoposition))](geoboundingbox_trycompute_467892569.md), [TryCompute(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geoboundingbox_trycompute_925237241.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geocircle.md b/windows.devices.geolocation/geocircle.md index f08dc73fc8..3cec03fdba 100644 --- a/windows.devices.geolocation/geocircle.md +++ b/windows.devices.geolocation/geocircle.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Geolocation.Geocircle --api-type: winrt class ---- # Windows.Devices.Geolocation.Geocircle ## -description Describes a geographic circle with a center point and a radius. ## -remarks ## -examples ## -see-also [IGeoshape](igeoshape.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.Geocircle +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geocircle + +## -description +Describes a geographic circle with a center point and a radius. + +## -remarks + +## -examples + +## -see-also +[IGeoshape](igeoshape.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geocircle_altitudereferencesystem.md b/windows.devices.geolocation/geocircle_altitudereferencesystem.md index 245c0fc74f..814b98b166 100644 --- a/windows.devices.geolocation/geocircle_altitudereferencesystem.md +++ b/windows.devices.geolocation/geocircle_altitudereferencesystem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocircle.AltitudeReferenceSystem --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocircle.AltitudeReferenceSystem ## -description The altitude reference system of the geographic circle. ## -property-value The altitude reference system of the geographic circle. ## -remarks Windows supports the **Ellipsoid** altitude reference system. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocircle.AltitudeReferenceSystem +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocircle.AltitudeReferenceSystem + +## -description +The altitude reference system of the geographic circle. + +## -property-value +The altitude reference system of the geographic circle. + +## -remarks +Windows supports the **Ellipsoid** altitude reference system. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_center.md b/windows.devices.geolocation/geocircle_center.md index 02f58ef29a..1a343d1713 100644 --- a/windows.devices.geolocation/geocircle_center.md +++ b/windows.devices.geolocation/geocircle_center.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocircle.Center --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocircle.Center ## -description The center point of a geographic circle. ## -property-value The center point of a geographic circle. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocircle.Center +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocircle.Center + +## -description +The center point of a geographic circle. + +## -property-value +The center point of a geographic circle. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_geocircle_1438058527.md b/windows.devices.geolocation/geocircle_geocircle_1438058527.md index 131922ea82..15b9b16e67 100644 --- a/windows.devices.geolocation/geocircle_geocircle_1438058527.md +++ b/windows.devices.geolocation/geocircle_geocircle_1438058527.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geocircle.#ctor(Windows.Devices.Geolocation.BasicGeoposition,System.Double) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geocircle.Geocircle ## -description Create a geographic circle object for the given position and radius. ## -parameters ### -param position The geographic position of the new circle. ### -param radius The radius of the new circle, in meters. ## -remarks The constructor will throw an exception if the provided [BasicGeoposition](basicgeoposition.md) has a latitude is less than -90 or greater than 90 or if the supplied [Radius](geocircle_radius.md) is outside of the allowed range. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geocircle.#ctor(Windows.Devices.Geolocation.BasicGeoposition,System.Double) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geocircle.Geocircle + +## -description +Create a geographic circle object for the given position and radius. + +## -parameters +### -param position +The geographic position of the new circle. + +### -param radius +The radius of the new circle, in meters. + +## -remarks +The constructor will throw an exception if the provided [BasicGeoposition](basicgeoposition.md) has a latitude is less than -90 or greater than 90 or if the supplied [Radius](geocircle_radius.md) is outside of the allowed range. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_geocircle_205129053.md b/windows.devices.geolocation/geocircle_geocircle_205129053.md index 5834cc7cda..fdcac78865 100644 --- a/windows.devices.geolocation/geocircle_geocircle_205129053.md +++ b/windows.devices.geolocation/geocircle_geocircle_205129053.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geocircle.#ctor(Windows.Devices.Geolocation.BasicGeoposition,System.Double,Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geocircle.Geocircle ## -description Create a geographic circle object for the given position, radius, altitude reference system, and spatial reference id. ## -parameters ### -param position The geographic position of the new circle. ### -param radius The radius of the new circle, in meters. ### -param altitudeReferenceSystem The altitude reference system of the new circle. ### -param spatialReferenceId The spatial reference Id of the new circle. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geocircle.#ctor(Windows.Devices.Geolocation.BasicGeoposition,System.Double,Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geocircle.Geocircle + +## -description +Create a geographic circle object for the given position, radius, altitude reference system, and spatial reference id. + +## -parameters +### -param position +The geographic position of the new circle. + +### -param radius +The radius of the new circle, in meters. + +### -param altitudeReferenceSystem +The altitude reference system of the new circle. + +### -param spatialReferenceId +The spatial reference Id of the new circle. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_geocircle_333869717.md b/windows.devices.geolocation/geocircle_geocircle_333869717.md index 22b12324aa..4a7086917c 100644 --- a/windows.devices.geolocation/geocircle_geocircle_333869717.md +++ b/windows.devices.geolocation/geocircle_geocircle_333869717.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geocircle.#ctor(Windows.Devices.Geolocation.BasicGeoposition,System.Double,Windows.Devices.Geolocation.AltitudeReferenceSystem) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geocircle.Geocircle ## -description Create a geographic circle object for the given position, radius and altitude reference system. ## -parameters ### -param position The geographic position of the new circle. ### -param radius The radius of the new circle, in meters. ### -param altitudeReferenceSystem The altitude reference system of the new circle. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geocircle.#ctor(Windows.Devices.Geolocation.BasicGeoposition,System.Double,Windows.Devices.Geolocation.AltitudeReferenceSystem) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geocircle.Geocircle + +## -description +Create a geographic circle object for the given position, radius and altitude reference system. + +## -parameters +### -param position +The geographic position of the new circle. + +### -param radius +The radius of the new circle, in meters. + +### -param altitudeReferenceSystem +The altitude reference system of the new circle. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_geoshapetype.md b/windows.devices.geolocation/geocircle_geoshapetype.md index 11963bc0c3..8dbc6263b4 100644 --- a/windows.devices.geolocation/geocircle_geoshapetype.md +++ b/windows.devices.geolocation/geocircle_geoshapetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocircle.GeoshapeType --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocircle.GeoshapeType ## -description The type of geographic shape. ## -property-value The type of geographic shape. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocircle.GeoshapeType +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocircle.GeoshapeType + +## -description +The type of geographic shape. + +## -property-value +The type of geographic shape. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_radius.md b/windows.devices.geolocation/geocircle_radius.md index f52c737620..d77d5773e2 100644 --- a/windows.devices.geolocation/geocircle_radius.md +++ b/windows.devices.geolocation/geocircle_radius.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocircle.Radius --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocircle.Radius ## -description The radius of a geographic circle in meters. ## -property-value The radius of a geographic circle. ## -remarks The valid range of radius values is from .1 to 10018754.3 meters. 10018754.3 meters is one quarter of the earth’s circumference. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocircle.Radius +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocircle.Radius + +## -description +The radius of a geographic circle in meters. + +## -property-value +The radius of a geographic circle. + +## -remarks +The valid range of radius values is from .1 to 10018754.3 meters. 10018754.3 meters is one quarter of the earth’s circumference. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocircle_spatialreferenceid.md b/windows.devices.geolocation/geocircle_spatialreferenceid.md index 2c33085963..c02435b0bb 100644 --- a/windows.devices.geolocation/geocircle_spatialreferenceid.md +++ b/windows.devices.geolocation/geocircle_spatialreferenceid.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocircle.SpatialReferenceId --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocircle.SpatialReferenceId ## -description The spatial reference identifier for the geographic circle, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. ## -property-value The spatial reference identifier for the geographic circle, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. ## -remarks The spatial reference id (SRID) corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. Spatial instances with the same SRID can be used when performing operations with spatial data methods on your data. The result of any spatial method derived from two spatial data instances is valid only if those instances have the same SRID that is based on the same unit of measurement, datum, and projection used to determine the coordinates of the instances. The most common units of measurement of a SRID are meters or square meters. The default SRID for the Windows platform is 4326 which is WGS84 ellipsoid. The spatial reference identification system is defined by the [European Petroleum Survey Group (EPSG)](http://go.microsoft.com/fwlink/p/?LinkID=306785) standard, which is a set of standards developed for cartography, surveying, and geodetic data storage. This standard is owned by the Oil and Gas Producers (OGP) Surveying and Positioning Committee. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocircle.SpatialReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocircle.SpatialReferenceId + +## -description +The spatial reference identifier for the geographic circle, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. + +## -property-value +The spatial reference identifier for the geographic circle, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. + +## -remarks +The spatial reference id (SRID) corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. Spatial instances with the same SRID can be used when performing operations with spatial data methods on your data. The result of any spatial method derived from two spatial data instances is valid only if those instances have the same SRID that is based on the same unit of measurement, datum, and projection used to determine the coordinates of the instances. The most common units of measurement of a SRID are meters or square meters. The default SRID for the Windows platform is 4326 which is WGS84 ellipsoid. + +The spatial reference identification system is defined by the [European Petroleum Survey Group (EPSG)](http://go.microsoft.com/fwlink/p/?LinkID=306785) standard, which is a set of standards developed for cartography, surveying, and geodetic data storage. This standard is owned by the Oil and Gas Producers (OGP) Surveying and Positioning Committee. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocoordinate_accuracy.md b/windows.devices.geolocation/geocoordinate_accuracy.md index 706e8f85ae..7b47aec0d6 100644 --- a/windows.devices.geolocation/geocoordinate_accuracy.md +++ b/windows.devices.geolocation/geocoordinate_accuracy.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Accuracy --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Accuracy ## -description The accuracy of the location in meters. ## -property-value The accuracy in meters. ## -remarks Location services accuracy depends on the location data available. For example, if Wi-Fi is available, data is accurate to within 50 meters. If Wi-Fi is not available, the data could be accurate to within 10 miles or larger. A GNSS device can provide data accurate to within a few meters. However, its accuracy can vary if the GNSS sensor is obscured by buildings, trees, or cloud cover. GNSS data may not be available at all within a building. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Accuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Accuracy + +## -description +The accuracy of the location in meters. + +## -property-value +The accuracy in meters. + +## -remarks +Location services accuracy depends on the location data available. For example, if Wi-Fi is available, data is accurate to within 50 meters. If Wi-Fi is not available, the data could be accurate to within 10 miles or larger. + +A GNSS device can provide data accurate to within a few meters. However, its accuracy can vary if the GNSS sensor is obscured by buildings, trees, or cloud cover. GNSS data may not be available at all within a building. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_altitude.md b/windows.devices.geolocation/geocoordinate_altitude.md index 8cc7af5136..aa4c0c653d 100644 --- a/windows.devices.geolocation/geocoordinate_altitude.md +++ b/windows.devices.geolocation/geocoordinate_altitude.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Altitude --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Altitude ## -description > [!NOTE] > Altitude may be altered or unavailable after Windows 8.1 and Windows Phone 8.1. Instead, use [Geocoordinate.Point](geocoordinate_point.md). The altitude of the location, in meters. ## -property-value The altitude in meters. ## -remarks This optional property will be set if it is available. If the property is not available, the value will be **NULL** or **NaN** (depending on the operating system version). We recommend that your app checks for both of these possibilities. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Altitude +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Altitude + +## -description +> [!NOTE] +> Altitude may be altered or unavailable after Windows 8.1 and Windows Phone 8.1. Instead, use [Geocoordinate.Point](geocoordinate_point.md). + +The altitude of the location, in meters. + +## -property-value +The altitude in meters. + +## -remarks +This optional property will be set if it is available. If the property is not available, the value will be **NULL** or **NaN** (depending on the operating system version). We recommend that your app checks for both of these possibilities. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_altitudeaccuracy.md b/windows.devices.geolocation/geocoordinate_altitudeaccuracy.md index 4fdc53f796..4ddf33f0e1 100644 --- a/windows.devices.geolocation/geocoordinate_altitudeaccuracy.md +++ b/windows.devices.geolocation/geocoordinate_altitudeaccuracy.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.AltitudeAccuracy --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.AltitudeAccuracy ## -description The accuracy of the altitude, in meters. ## -property-value The accuracy of the altitude. ## -remarks This optional property will be set if it is available. If the property is not available, the value will be **NULL**. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.AltitudeAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.AltitudeAccuracy + +## -description +The accuracy of the altitude, in meters. + +## -property-value +The accuracy of the altitude. + +## -remarks +This optional property will be set if it is available. If the property is not available, the value will be **NULL**. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_heading.md b/windows.devices.geolocation/geocoordinate_heading.md index 12b74612e3..f45cebcee8 100644 --- a/windows.devices.geolocation/geocoordinate_heading.md +++ b/windows.devices.geolocation/geocoordinate_heading.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Heading --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Heading ## -description The current heading in degrees relative to true north. ## -property-value The current heading in degrees relative to true north. ## -remarks This optional property will be set if it is available. If the property is not available, the value will be **NULL** or **NaN** (depending on the operating system version). We recommend that your app checks for both of these possibilities. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Heading +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Heading + +## -description +The current heading in degrees relative to true north. + +## -property-value +The current heading in degrees relative to true north. + +## -remarks +This optional property will be set if it is available. If the property is not available, the value will be **NULL** or **NaN** (depending on the operating system version). We recommend that your app checks for both of these possibilities. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_latitude.md b/windows.devices.geolocation/geocoordinate_latitude.md index 6bfc4e2bd1..dfbca48ea5 100644 --- a/windows.devices.geolocation/geocoordinate_latitude.md +++ b/windows.devices.geolocation/geocoordinate_latitude.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Latitude --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Latitude ## -description > [!NOTE] > Latitude may be altered or unavailable after Windows 8.1 and Windows Phone 8.1. Instead, use [Geocoordinate.Point](geocoordinate_point.md). The latitude in degrees. ## -property-value The latitude in degrees. The valid range of values is from -90.0 to 90.0. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Latitude +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Latitude + +## -description +> [!NOTE] +> Latitude may be altered or unavailable after Windows 8.1 and Windows Phone 8.1. Instead, use [Geocoordinate.Point](geocoordinate_point.md). + +The latitude in degrees. + +## -property-value +The latitude in degrees. The valid range of values is from -90.0 to 90.0. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_longitude.md b/windows.devices.geolocation/geocoordinate_longitude.md index 121a6fdd0c..11e511e64b 100644 --- a/windows.devices.geolocation/geocoordinate_longitude.md +++ b/windows.devices.geolocation/geocoordinate_longitude.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Longitude --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Longitude ## -description > [!NOTE] > Longitude may be altered or unavailable after Windows 8.1 and Windows Phone 8.1. Instead, use [Geocoordinate.Point](geocoordinate_point.md). The longitude in degrees. ## -property-value The longitude in degrees. The valid range of values is from -180.0 to 180.0. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Longitude +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Longitude + +## -description +> [!NOTE] +> Longitude may be altered or unavailable after Windows 8.1 and Windows Phone 8.1. Instead, use [Geocoordinate.Point](geocoordinate_point.md). + +The longitude in degrees. + +## -property-value +The longitude in degrees. The valid range of values is from -180.0 to 180.0. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_point.md b/windows.devices.geolocation/geocoordinate_point.md index adb3042b75..5e709d206c 100644 --- a/windows.devices.geolocation/geocoordinate_point.md +++ b/windows.devices.geolocation/geocoordinate_point.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Point --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Point ## -description The location of the [Geocoordinate.](geocoordinate.md) ## -property-value The location of the [Geocoordinate](geocoordinate.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Point +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Point + +## -description +The location of the [Geocoordinate.](geocoordinate.md) + +## -property-value +The location of the [Geocoordinate](geocoordinate.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocoordinate_positionsource.md b/windows.devices.geolocation/geocoordinate_positionsource.md index 293b3ca815..7eca69b824 100644 --- a/windows.devices.geolocation/geocoordinate_positionsource.md +++ b/windows.devices.geolocation/geocoordinate_positionsource.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.PositionSource --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.PositionSource ## -description Gets the source used to obtain a Geocoordinate. ## -property-value Gets the source used to obtain a Geocoordinate. ## -remarks ## -examples ## -see-also ## -capabilities locationHistory, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.PositionSource +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.PositionSource + +## -description +Gets the source used to obtain a Geocoordinate. + +## -property-value +Gets the source used to obtain a Geocoordinate. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +locationHistory, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_positionsourcetimestamp.md b/windows.devices.geolocation/geocoordinate_positionsourcetimestamp.md index 868be8f682..756b7750cf 100644 --- a/windows.devices.geolocation/geocoordinate_positionsourcetimestamp.md +++ b/windows.devices.geolocation/geocoordinate_positionsourcetimestamp.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.PositionSourceTimestamp --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.PositionSourceTimestamp ## -description Gets the time at which the associated [Geocoordinate](geocoordinate.md) position was calculated. ## -property-value The time at which the associated [Geocoordinate](geocoordinate.md) position was calculated. ## -remarks When this property is not available, the value will be **NULL**. The timestamp returned by this property depends on how the location was obtained and may be completely unrelated to the system time on the device. For example, if the position is obtained from the Global Navigation Satellite System (GNSS) the timestamp would be obtained from the satellites. If the position was is obtained from Secure User Plane Location (SUPL), the timestamp would be obtained from SUPL servers. This means that the timestamps obtained from these services will be precise and, most importantly, consistent across all devices regardless of whether the system time on the devices is set correctly. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.PositionSourceTimestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.PositionSourceTimestamp + +## -description +Gets the time at which the associated [Geocoordinate](geocoordinate.md) position was calculated. + +## -property-value +The time at which the associated [Geocoordinate](geocoordinate.md) position was calculated. + +## -remarks +When this property is not available, the value will be **NULL**. + +The timestamp returned by this property depends on how the location was obtained and may be completely unrelated to the system time on the device. For example, if the position is obtained from the Global Navigation Satellite System (GNSS) the timestamp would be obtained from the satellites. If the position was is obtained from Secure User Plane Location (SUPL), the timestamp would be obtained from SUPL servers. This means that the timestamps obtained from these services will be precise and, most importantly, consistent across all devices regardless of whether the system time on the devices is set correctly. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geocoordinate_satellitedata.md b/windows.devices.geolocation/geocoordinate_satellitedata.md index 727c100b04..1fa219467c 100644 --- a/windows.devices.geolocation/geocoordinate_satellitedata.md +++ b/windows.devices.geolocation/geocoordinate_satellitedata.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.SatelliteData --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.SatelliteData ## -description Gets information about the satellites used to obtain a Geocoordinate. ## -property-value Gets information about the satellites used to obtain a Geocoordinate. ## -remarks ## -examples ## -see-also ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.SatelliteData +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.SatelliteData + +## -description +Gets information about the satellites used to obtain a Geocoordinate. + +## -property-value +Gets information about the satellites used to obtain a Geocoordinate. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_speed.md b/windows.devices.geolocation/geocoordinate_speed.md index bd4a9a0b39..e2dd6e4f3e 100644 --- a/windows.devices.geolocation/geocoordinate_speed.md +++ b/windows.devices.geolocation/geocoordinate_speed.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Speed --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Speed ## -description The speed in meters per second. ## -property-value The speed in meters per second. ## -remarks This optional property will be set if it is available. If the property is not available, the value will be **NULL** or **NaN** (depending on the operating system version). We recommend that your app checks for both of these possibilities. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Speed +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Speed + +## -description +The speed in meters per second. + +## -property-value +The speed in meters per second. + +## -remarks +This optional property will be set if it is available. If the property is not available, the value will be **NULL** or **NaN** (depending on the operating system version). We recommend that your app checks for both of these possibilities. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinate_timestamp.md b/windows.devices.geolocation/geocoordinate_timestamp.md index f854ed916f..dafbfdcb78 100644 --- a/windows.devices.geolocation/geocoordinate_timestamp.md +++ b/windows.devices.geolocation/geocoordinate_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geocoordinate.Timestamp --api-type: winrt property ---- # Windows.Devices.Geolocation.Geocoordinate.Timestamp ## -description The system time at which the location was determined. ## -property-value The system time at which the location was determined. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geocoordinate.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geocoordinate.Timestamp + +## -description +The system time at which the location was determined. + +## -property-value +The system time at which the location was determined. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinatesatellitedata.md b/windows.devices.geolocation/geocoordinatesatellitedata.md index e037b4d4d1..614a27370a 100644 --- a/windows.devices.geolocation/geocoordinatesatellitedata.md +++ b/windows.devices.geolocation/geocoordinatesatellitedata.md @@ -1,3 +1,31 @@ ---- -api-id: T:Windows.Devices.Geolocation.GeocoordinateSatelliteData --api-type: winrt class ---- # Windows.Devices.Geolocation.GeocoordinateSatelliteData ## -description Provides additional information about a [Geocoordinate](geocoordinate.md). This information is only applicable to position estimates obtained using satellite signals. ## -remarks You can use the [Geocoordinate.PositionSource](geocoordinate_positionsource.md) property to receive the [GeocoordinateSatelliteData](geocoordinatesatellitedata.md) information. The properties of this class convey information about the satellite geometry with which the position was obtained. Their values indicate the level of confidence that the position provided is precise. Lower values for dilution of precision (DOP) indicate high confidence on the precision of the position obtained. Positions with a DOP of 5 or less are considered reliable. Positions with a DOP higher than 10 are low confidence and should generally be discarded other than for a rough position estimation. Positions with a DOP higher than 20 should always be discarded. > [!NOTE] > If the GPS sensor returns a zero for any of the dilution of precision (DOP) values, the corresponding properties will return **NULL**. ## -examples ## -see-also [Geolocation sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=533278) ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.GeocoordinateSatelliteData +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.GeocoordinateSatelliteData + +## -description +Provides additional information about a [Geocoordinate](geocoordinate.md). This information is only applicable to position estimates obtained using satellite signals. + +## -remarks +You can use the [Geocoordinate.PositionSource](geocoordinate_positionsource.md) property to receive the [GeocoordinateSatelliteData](geocoordinatesatellitedata.md) information. + +The properties of this class convey information about the satellite geometry with which the position was obtained. Their values indicate the level of confidence that the position provided is precise. Lower values for dilution of precision (DOP) indicate high confidence on the precision of the position obtained. Positions with a DOP of 5 or less are considered reliable. Positions with a DOP higher than 10 are low confidence and should generally be discarded other than for a rough position estimation. Positions with a DOP higher than 20 should always be discarded. + + + +> [!NOTE] +> If the GPS sensor returns a zero for any of the dilution of precision (DOP) values, the corresponding properties will return **NULL**. + +## -examples + +## -see-also +[Geolocation sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=533278) + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinatesatellitedata_horizontaldilutionofprecision.md b/windows.devices.geolocation/geocoordinatesatellitedata_horizontaldilutionofprecision.md index f33fb728e4..84c4fd170c 100644 --- a/windows.devices.geolocation/geocoordinatesatellitedata_horizontaldilutionofprecision.md +++ b/windows.devices.geolocation/geocoordinatesatellitedata_horizontaldilutionofprecision.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeocoordinateSatelliteData.HorizontalDilutionOfPrecision --api-type: winrt property ---- # Windows.Devices.Geolocation.GeocoordinateSatelliteData.HorizontalDilutionOfPrecision ## -description Gets the horizontal dilution of precision (HDOP) of a [Geocoordinate](geocoordinate.md). ## -property-value The horizontal dilution of precision (HDOP). ## -remarks ## -examples ## -see-also ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeocoordinateSatelliteData.HorizontalDilutionOfPrecision +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeocoordinateSatelliteData.HorizontalDilutionOfPrecision + +## -description +Gets the horizontal dilution of precision (HDOP) of a [Geocoordinate](geocoordinate.md). + +## -property-value +The horizontal dilution of precision (HDOP). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinatesatellitedata_positiondilutionofprecision.md b/windows.devices.geolocation/geocoordinatesatellitedata_positiondilutionofprecision.md index 3ae914f102..fbdf4aeb30 100644 --- a/windows.devices.geolocation/geocoordinatesatellitedata_positiondilutionofprecision.md +++ b/windows.devices.geolocation/geocoordinatesatellitedata_positiondilutionofprecision.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeocoordinateSatelliteData.PositionDilutionOfPrecision --api-type: winrt property ---- # Windows.Devices.Geolocation.GeocoordinateSatelliteData.PositionDilutionOfPrecision ## -description Gets the position dilution of precision (PDOP) of a [Geocoordinate](geocoordinate.md). ## -property-value The position dilution of precision (PDOP). ## -remarks ## -examples ## -see-also ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeocoordinateSatelliteData.PositionDilutionOfPrecision +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeocoordinateSatelliteData.PositionDilutionOfPrecision + +## -description +Gets the position dilution of precision (PDOP) of a [Geocoordinate](geocoordinate.md). + +## -property-value +The position dilution of precision (PDOP). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geocoordinatesatellitedata_verticaldilutionofprecision.md b/windows.devices.geolocation/geocoordinatesatellitedata_verticaldilutionofprecision.md index f45f508f19..618c49cea8 100644 --- a/windows.devices.geolocation/geocoordinatesatellitedata_verticaldilutionofprecision.md +++ b/windows.devices.geolocation/geocoordinatesatellitedata_verticaldilutionofprecision.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.GeocoordinateSatelliteData.VerticalDilutionOfPrecision --api-type: winrt property ---- # Windows.Devices.Geolocation.GeocoordinateSatelliteData.VerticalDilutionOfPrecision ## -description Gets the vertical dilution of precision (VDOP) of a [Geocoordinate](geocoordinate.md). ## -property-value The vertical dilution of precision (VDOP). ## -remarks ## -examples ## -see-also ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.GeocoordinateSatelliteData.VerticalDilutionOfPrecision +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeocoordinateSatelliteData.VerticalDilutionOfPrecision + +## -description +Gets the vertical dilution of precision (VDOP) of a [Geocoordinate](geocoordinate.md). + +## -property-value +The vertical dilution of precision (VDOP). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_allowfallbacktoconsentlesspositions_328227365.md b/windows.devices.geolocation/geolocator_allowfallbacktoconsentlesspositions_328227365.md index 135e043727..199a4430f1 100644 --- a/windows.devices.geolocation/geolocator_allowfallbacktoconsentlesspositions_328227365.md +++ b/windows.devices.geolocation/geolocator_allowfallbacktoconsentlesspositions_328227365.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.AllowFallbackToConsentlessPositions --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.AllowFallbackToConsentlessPositions ## -description Sets the [Geolocator](geolocator.md) to use Consentless Location, in which position requests will return an obfuscated location when the circumstances call for it (see Remarks). ## -remarks The Consentless Location feature allows the app to bypass the app-specific location switch (located in system settings) and obtain a "rough" location that is obfuscated with at least a 4km radius of uncertainty. The [PositionSource](geocoordinate_positionsource.md) property of the retrieved [Geocoordinate](geocoordinate.md) will report **Obfuscated**. Consentless Location, if enabled in the app, will be utilized when the app-specific location switch is set to **off** (that is, when precise location is not allowed). The system-wide location switch, however, must be still switched **on** in order for any location retrieval to take place. This feature is enabled for any [Geolocator](geolocator.md) object that calls [AllowFallbackToConsentlessPositions](geolocator_allowfallbacktoconsentlesspositions.md) — it is disabled by default. Normally, an app that uses location services should first call [RequestAccessAsync](geolocator_requestaccessasync.md) to check if its app-specific location is switched **on**, and if not, it should prompt the user to go to system settings and switch it **on**. However, an app that has Consentless Location capability does not need to call , as it can function whether location access is allowed or denied. The user may still turn on the app-specific location in order to use precise location, but this is not needed for the app's location functionality to work. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.AllowFallbackToConsentlessPositions +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.AllowFallbackToConsentlessPositions + +## -description +Sets the [Geolocator](geolocator.md) to use Consentless Location, in which position requests will return an obfuscated location when the circumstances call for it (see Remarks). + +## -remarks +The Consentless Location feature allows the app to bypass the app-specific location switch (located in system settings) and obtain a "rough" location that is obfuscated with at least a 4km radius of uncertainty. The [PositionSource](geocoordinate_positionsource.md) property of the retrieved [Geocoordinate](geocoordinate.md) will report **Obfuscated**. + +Consentless Location, if enabled in the app, will be utilized when the app-specific location switch is set to **off** (that is, when precise location is not allowed). The system-wide location switch, however, must be still switched **on** in order for any location retrieval to take place. + +This feature is enabled for any [Geolocator](geolocator.md) object that calls [AllowFallbackToConsentlessPositions](geolocator_allowfallbacktoconsentlesspositions.md) — it is disabled by default. + +Normally, an app that uses location services should first call [RequestAccessAsync](geolocator_requestaccessasync.md) to check if its app-specific location is switched **on**, and if not, it should prompt the user to go to system settings and switch it **on**. However, an app that has Consentless Location capability does not need to call , as it can function whether location access is allowed or denied. The user may still turn on the app-specific location in order to use precise location, but this is not needed for the app's location functionality to work. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geolocator_defaultgeoposition.md b/windows.devices.geolocation/geolocator_defaultgeoposition.md index 62a4e69d43..38302b5f8f 100644 --- a/windows.devices.geolocation/geolocator_defaultgeoposition.md +++ b/windows.devices.geolocation/geolocator_defaultgeoposition.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.DefaultGeoposition --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.DefaultGeoposition ## -description Gets the location manually entered into the system by the user, to be utilized if no better options exist. ## -property-value The location manually entered by the user. ## -remarks ## -examples ## -see-also ## -capabilities locationSystem \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.DefaultGeoposition +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.DefaultGeoposition + +## -description +Gets the location manually entered into the system by the user, to be utilized if no better options exist. + +## -property-value +The location manually entered by the user. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +locationSystem \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_desiredaccuracy.md b/windows.devices.geolocation/geolocator_desiredaccuracy.md index 938a8a8bee..ca3ca9b9b1 100644 --- a/windows.devices.geolocation/geolocator_desiredaccuracy.md +++ b/windows.devices.geolocation/geolocator_desiredaccuracy.md @@ -1,3 +1,54 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.DesiredAccuracy --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.DesiredAccuracy ## -description The accuracy level at which the [Geolocator](geolocator.md) provides location updates. ## -property-value The accuracy level at which the [Geolocator](geolocator.md) provides location updates. ## -remarks Set [DesiredAccuracy](geolocator_desiredaccuracy.md) to **High** only if your application requires the most accurate data available. Set [DesiredAccuracy](geolocator_desiredaccuracy.md) to **Default** to optimize for power. > [!NOTE] > Some hardware may not support high accuracy location data. If your app attempts to set accuracy to a value that’s not supported, accuracy will be set to the limit that the hardware supports. Therefore, setting the [DesiredAccuracy](geolocator_desiredaccuracy.md) property is not guaranteed to have an effect on the accuracy of data. The [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md) property provides more granularity and control of the accuracy of the position results. Most applications can simply use the [DesiredAccuracy](geolocator_desiredaccuracy.md) property. When neither [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md) nor [DesiredAccuracy](geolocator_desiredaccuracy.md) are set, your app will use an accuracy setting of 500 meters (which corresponds to the [DesiredAccuracy](geolocator_desiredaccuracy.md) setting of **Default**). Setting [DesiredAccuracy](geolocator_desiredaccuracy.md) to **Default** or **High** indirectly sets [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md) to 500 or 10 meters, respectively. When your app sets both [DesiredAccuracy](geolocator_desiredaccuracy.md) and [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md), your app will use whichever accuracy value was set last. ## -examples The following example shows how to set the desired accuracy in JavaScript. ```javascript var geolocator = new Windows.Devices.Geolocation.Geolocator(); geolocator.desiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.default; geolocator.desiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.high; ``` The following example shows how to set the desired accuracy in C#. ```csharp Geolocator geolocator = new Geolocator(); geolocator.DesiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.Default; geolocator.DesiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.High; ``` ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.DesiredAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.DesiredAccuracy + +## -description +The accuracy level at which the [Geolocator](geolocator.md) provides location updates. + +## -property-value +The accuracy level at which the [Geolocator](geolocator.md) provides location updates. + +## -remarks +Set [DesiredAccuracy](geolocator_desiredaccuracy.md) to **High** only if your application requires the most accurate data available. Set [DesiredAccuracy](geolocator_desiredaccuracy.md) to **Default** to optimize for power. + + + +> [!NOTE] +> Some hardware may not support high accuracy location data. If your app attempts to set accuracy to a value that’s not supported, accuracy will be set to the limit that the hardware supports. Therefore, setting the [DesiredAccuracy](geolocator_desiredaccuracy.md) property is not guaranteed to have an effect on the accuracy of data. + +The [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md) property provides more granularity and control of the accuracy of the position results. Most applications can simply use the [DesiredAccuracy](geolocator_desiredaccuracy.md) property. + +When neither [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md) nor [DesiredAccuracy](geolocator_desiredaccuracy.md) are set, your app will use an accuracy setting of 500 meters (which corresponds to the [DesiredAccuracy](geolocator_desiredaccuracy.md) setting of **Default**). Setting [DesiredAccuracy](geolocator_desiredaccuracy.md) to **Default** or **High** indirectly sets [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md) to 500 or 10 meters, respectively. When your app sets both [DesiredAccuracy](geolocator_desiredaccuracy.md) and [DesiredAccuracyInMeters](geolocator_desiredaccuracyinmeters.md), your app will use whichever accuracy value was set last. + +## -examples +The following example shows how to set the desired accuracy in JavaScript. + +```javascript +var geolocator = new Windows.Devices.Geolocation.Geolocator(); +geolocator.desiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.default; +geolocator.desiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.high; + +``` + +The following example shows how to set the desired accuracy in C#. + +```csharp +Geolocator geolocator = new Geolocator(); +geolocator.DesiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.Default; +geolocator.DesiredAccuracy = Windows.Devices.Geolocation.PositionAccuracy.High; +``` + + + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_desiredaccuracyinmeters.md b/windows.devices.geolocation/geolocator_desiredaccuracyinmeters.md index abb64bea0b..25f693bf52 100644 --- a/windows.devices.geolocation/geolocator_desiredaccuracyinmeters.md +++ b/windows.devices.geolocation/geolocator_desiredaccuracyinmeters.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.DesiredAccuracyInMeters --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.DesiredAccuracyInMeters ## -description Gets or sets the desired accuracy in meters for data returned from the location service. ## -property-value The desired accuracy in meters for data returned from the location service. ## -remarks ## -examples ## -see-also ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.DesiredAccuracyInMeters +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.DesiredAccuracyInMeters + +## -description +Gets or sets the desired accuracy in meters for data returned from the location service. + +## -property-value +The desired accuracy in meters for data returned from the location service. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_geolocator_1221375020.md b/windows.devices.geolocation/geolocator_geolocator_1221375020.md index d4aaa274b1..16e37a6aa0 100644 --- a/windows.devices.geolocation/geolocator_geolocator_1221375020.md +++ b/windows.devices.geolocation/geolocator_geolocator_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.#ctor --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.Geolocator ## -description Initializes a new [Geolocator](geolocator.md) object. ## -remarks ## -examples ## -see-also [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.Geolocator + +## -description +Initializes a new [Geolocator](geolocator.md) object. + +## -remarks + +## -examples + +## -see-also +[geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_getgeopositionasync_189682258.md b/windows.devices.geolocation/geolocator_getgeopositionasync_189682258.md index eaeab7b620..e76f22977e 100644 --- a/windows.devices.geolocation/geolocator_getgeopositionasync_189682258.md +++ b/windows.devices.geolocation/geolocator_getgeopositionasync_189682258.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync ## -description Starts an asynchronous operation to retrieve the current location of the device. ## -returns An asynchronous operation that, upon completion, returns a [Geoposition](geoposition.md) marking the found location. ## -remarks This method throws an exception if the app doesn't have location permissions or if it times out with no location data retrieved. Therefore, the method should be called within a try/catch statement so that these common exception cases can be handled. This method times out after 60 seconds, except when in Connected Standby. During Connected Standby, [Geolocator](geolocator.md) objects can be instantiated but the [Geolocator](geolocator.md) object will not find any sensors to aggregate and calls to [GetGeopositionAsync](geolocator_getgeopositionasync.md) will time out after 7 seconds. Upon time out, the [StatusChanged](geolocator_statuschanged.md) event listeners will be called once with the **NoData** status, and the [PositionChanged](geolocator_positionchanged.md) event listeners will never be called. The user sets the privacy of their location data with the **location privacy settings** in the **Settings** app. Your app can access the user's location only when: + **Location for this device...** is turned **on** (not applicable to Windows 10 Mobile) + The location services setting, **Location**, is turned **on** + Under **Choose apps that can use your location**, your app is set to **on** > [!IMPORTANT] > Starting in Windows 10, call the [RequestAccessAsync](geolocator_requestaccessasync.md) method before accessing the user’s location. At that time, your app must be in the foreground and **RequestAccessAsync** must be called from the UI thread. Your app can then handle the no-permissions case without throwing an exception. ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Geoposition](geoposition.md), [Geocoordinate](geocoordinate.md), [GetGeopositionAsync(TimeSpan, TimeSpan)](geolocator_getgeopositionasync_726098746.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync + +## -description +Starts an asynchronous operation to retrieve the current location of the device. + +## -returns +An asynchronous operation that, upon completion, returns a [Geoposition](geoposition.md) marking the found location. + +## -remarks +This method throws an exception if the app doesn't have location permissions or if it times out with no location data retrieved. Therefore, the method should be called within a try/catch statement so that these common exception cases can be handled. + +This method times out after 60 seconds, except when in Connected Standby. During Connected Standby, [Geolocator](geolocator.md) objects can be instantiated but the [Geolocator](geolocator.md) object will not find any sensors to aggregate and calls to [GetGeopositionAsync](geolocator_getgeopositionasync.md) will time out after 7 seconds. Upon time out, the [StatusChanged](geolocator_statuschanged.md) event listeners will be called once with the **NoData** status, and the [PositionChanged](geolocator_positionchanged.md) event listeners will never be called. + +The user sets the privacy of their location data with the **location privacy settings** in the **Settings** app. Your app can access the user's location only when: ++ **Location for this device...** is turned **on** (not applicable to Windows 10 Mobile) ++ The location services setting, **Location**, is turned **on** ++ Under **Choose apps that can use your location**, your app is set to **on** + + +> [!IMPORTANT] +> Starting in Windows 10, call the [RequestAccessAsync](geolocator_requestaccessasync.md) method before accessing the user’s location. At that time, your app must be in the foreground and **RequestAccessAsync** must be called from the UI thread. Your app can then handle the no-permissions case without throwing an exception. + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Geoposition](geoposition.md), [Geocoordinate](geocoordinate.md), [GetGeopositionAsync(TimeSpan, TimeSpan)](geolocator_getgeopositionasync_726098746.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_getgeopositionasync_726098746.md b/windows.devices.geolocation/geolocator_getgeopositionasync_726098746.md index c1efb3c47c..db40dfbc66 100644 --- a/windows.devices.geolocation/geolocator_getgeopositionasync_726098746.md +++ b/windows.devices.geolocation/geolocator_getgeopositionasync_726098746.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync(Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync ## -description Starts an asynchronous operation to retrieve the current location of the device. ## -parameters ### -param maximumAge The maximum acceptable age of cached location data. A [TimeSpan](../windows.foundation/timespan.md) is a time period expressed in 100-nanosecond units. ### -param timeout The timeout. A [TimeSpan](../windows.foundation/timespan.md) is a time period expressed in 100-nanosecond units. ## -returns An asynchronous operation that, upon completion, returns a [Geoposition](geoposition.md) marking the found location. ## -remarks A location will be returned immediately if the latest location is within an acceptable age. Otherwise, a location will not be returned until the next change. In some cases, your app may receive location data that is older than the specified *maximumAge* value. This is because an additional age value will be calculated based on the desired accuracy setting, and your app will use whichever of the two ages is larger. For example, say a default accuracy of 500 meters corresponds to a maximum age of 30 seconds. In that case, your app could receive 20 second old data even if you set *maximumAge* to 10 seconds. ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [Geoposition](geoposition.md), [Geocoordinate](geocoordinate.md), [GetGeopositionAsync](geolocator_getgeopositionasync_189682258.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync(Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.GetGeopositionAsync + +## -description +Starts an asynchronous operation to retrieve the current location of the device. + +## -parameters +### -param maximumAge +The maximum acceptable age of cached location data. A [TimeSpan](../windows.foundation/timespan.md) is a time period expressed in 100-nanosecond units. + +### -param timeout +The timeout. A [TimeSpan](../windows.foundation/timespan.md) is a time period expressed in 100-nanosecond units. + +## -returns +An asynchronous operation that, upon completion, returns a [Geoposition](geoposition.md) marking the found location. + +## -remarks +A location will be returned immediately if the latest location is within an acceptable age. Otherwise, a location will not be returned until the next change. In some cases, your app may receive location data that is older than the specified *maximumAge* value. This is because an additional age value will be calculated based on the desired accuracy setting, and your app will use whichever of the two ages is larger. For example, say a default accuracy of 500 meters corresponds to a maximum age of 30 seconds. In that case, your app could receive 20 second old data even if you set *maximumAge* to 10 seconds. + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [Geoposition](geoposition.md), [Geocoordinate](geocoordinate.md), [GetGeopositionAsync](geolocator_getgeopositionasync_189682258.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_1254824286.md b/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_1254824286.md index 795d5b5240..816e4515f0 100644 --- a/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_1254824286.md +++ b/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_1254824286.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync ## -description Starts an asynchronous operation to retrieve the location history of the device. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param startTime Represents the beginning of the time span for which positions are to be returned. ## -returns Positions (of type [Geoposition](geoposition.md)) that were collected during the specified time span. ## -remarks The [GetGeopositionHistoryAsync](geolocator_getgeopositionhistoryasync.md) method allows your app to asynchronously fetch a list of positions that have been collected by location services. Only positions that have been collected since the specified *startTime* will be returned. If no positions are available from that time span, an empty list will be returned. This method returns only positions that have already been collected by location services in the last 24 hours; it does not resolve new positions. Specifying a time span that exceeds this 24-hour window will not yield any additional positions. Location services collects positions only when an app or services queries for the user's location - but no more than once per second. Location history is limited to 3600 positions; if location history isn't cleared by the user, each position will be stored in location history between 1 and 24 hours. > [!NOTE] > If you use a background task to call this method frequently, it's important to consider the impact that will have on the battery. Although this method doesn't trigger the GPS receiver, processor resources are still required to run the background task. ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [GetGeopositionHistoryAsync(DateTime, TimeSpan)](geolocator_getgeopositionhistoryasync_544182854.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities locationHistory \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync + +## -description +Starts an asynchronous operation to retrieve the location history of the device. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param startTime +Represents the beginning of the time span for which positions are to be returned. + +## -returns +Positions (of type [Geoposition](geoposition.md)) that were collected during the specified time span. + +## -remarks +The [GetGeopositionHistoryAsync](geolocator_getgeopositionhistoryasync.md) method allows your app to asynchronously fetch a list of positions that have been collected by location services. Only positions that have been collected since the specified *startTime* will be returned. If no positions are available from that time span, an empty list will be returned. + +This method returns only positions that have already been collected by location services in the last 24 hours; it does not resolve new positions. Specifying a time span that exceeds this 24-hour window will not yield any additional positions. + +Location services collects positions only when an app or services queries for the user's location - but no more than once per second. Location history is limited to 3600 positions; if location history isn't cleared by the user, each position will be stored in location history between 1 and 24 hours. + +> [!NOTE] +> If you use a background task to call this method frequently, it's important to consider the impact that will have on the battery. Although this method doesn't trigger the GPS receiver, processor resources are still required to run the background task. + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [GetGeopositionHistoryAsync(DateTime, TimeSpan)](geolocator_getgeopositionhistoryasync_544182854.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +locationHistory \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_544182854.md b/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_544182854.md index 2086f29c59..f561fbf791 100644 --- a/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_544182854.md +++ b/windows.devices.geolocation/geolocator_getgeopositionhistoryasync_544182854.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync ## -description Starts an asynchronous operation to retrieve the location history of the device. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param startTime Represents the beginning of the time span for which positions are to be returned. ### -param duration Represents the length of time after *startTime* for which positions are to be returned. ## -returns Positions (of type [Geoposition](geoposition.md)) that were collected during the specified time span. ## -remarks Only positions that were collected during the specified *duration* after *startTime* will be returned. ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [GetGeopositionHistoryAsync(DateTime)](geolocator_getgeopositionhistoryasync_1254824286.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities locationHistory \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.GetGeopositionHistoryAsync + +## -description +Starts an asynchronous operation to retrieve the location history of the device. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param startTime +Represents the beginning of the time span for which positions are to be returned. + +### -param duration +Represents the length of time after *startTime* for which positions are to be returned. + +## -returns +Positions (of type [Geoposition](geoposition.md)) that were collected during the specified time span. + +## -remarks +Only positions that were collected during the specified *duration* after *startTime* will be returned. + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [GetGeopositionHistoryAsync(DateTime)](geolocator_getgeopositionhistoryasync_1254824286.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +locationHistory \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_isdefaultgeopositionrecommended.md b/windows.devices.geolocation/geolocator_isdefaultgeopositionrecommended.md index 5697102834..7154d403ca 100644 --- a/windows.devices.geolocation/geolocator_isdefaultgeopositionrecommended.md +++ b/windows.devices.geolocation/geolocator_isdefaultgeopositionrecommended.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.IsDefaultGeopositionRecommended --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.IsDefaultGeopositionRecommended ## -description Indicates whether the user should be prompted to set a default location manually. ## -property-value **true** if the app would benefit from a manually-set location, **false** if a better option is available. ## -remarks ## -examples ## -see-also ## -capabilities locationSystem \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.IsDefaultGeopositionRecommended +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.IsDefaultGeopositionRecommended + +## -description +Indicates whether the user should be prompted to set a default location manually. + +## -property-value +**true** if the app would benefit from a manually-set location, **false** if a better option is available. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +locationSystem \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_locationstatus.md b/windows.devices.geolocation/geolocator_locationstatus.md index 7936a36745..68f89f64df 100644 --- a/windows.devices.geolocation/geolocator_locationstatus.md +++ b/windows.devices.geolocation/geolocator_locationstatus.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.LocationStatus --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.LocationStatus ## -description The status that indicates the ability of the [Geolocator](geolocator.md) to provide location updates. ## -property-value The status of the [Geolocator](geolocator.md). ## -remarks The **LocationStatus** property is updated dynamically only when a tracking session is active. Otherwise, it is either **NotInitialized** or **Disabled**. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.LocationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.LocationStatus + +## -description +The status that indicates the ability of the [Geolocator](geolocator.md) to provide location updates. + +## -property-value +The status of the [Geolocator](geolocator.md). + +## -remarks +The **LocationStatus** property is updated dynamically only when a tracking session is active. Otherwise, it is either **NotInitialized** or **Disabled**. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_movementthreshold.md b/windows.devices.geolocation/geolocator_movementthreshold.md index 2fd1f4744a..0e26aff0c4 100644 --- a/windows.devices.geolocation/geolocator_movementthreshold.md +++ b/windows.devices.geolocation/geolocator_movementthreshold.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.MovementThreshold --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.MovementThreshold ## -description The distance of movement, in meters, relative to the coordinate from the last [PositionChanged](geolocator_positionchanged.md) event, that is required for the [Geolocator](geolocator.md) to raise a [PositionChanged](geolocator_positionchanged.md) event. ## -property-value The distance of required movement, in meters, for location services to raise a [PositionChanged](geolocator_positionchanged.md) event. The default value is 0. ## -remarks The default report interval is 1 second or as frequent as the hardware can support – whichever is shorter. Location updates can be set to a different frequency if you specify a [MovementThreshold](geolocator_movementthreshold.md) or set [ReportInterval](geolocator_reportinterval.md) to a different value. If your app sets both [MovementThreshold](geolocator_movementthreshold.md) and [ReportInterval](geolocator_reportinterval.md), location will be updated according to [MovementThreshold](geolocator_movementthreshold.md). ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba) ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.MovementThreshold +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.MovementThreshold + +## -description +The distance of movement, in meters, relative to the coordinate from the last [PositionChanged](geolocator_positionchanged.md) event, that is required for the [Geolocator](geolocator.md) to raise a [PositionChanged](geolocator_positionchanged.md) event. + +## -property-value +The distance of required movement, in meters, for location services to raise a [PositionChanged](geolocator_positionchanged.md) event. The default value is 0. + +## -remarks +The default report interval is 1 second or as frequent as the hardware can support – whichever is shorter. Location updates can be set to a different frequency if you specify a [MovementThreshold](geolocator_movementthreshold.md) or set [ReportInterval](geolocator_reportinterval.md) to a different value. If your app sets both [MovementThreshold](geolocator_movementthreshold.md) and [ReportInterval](geolocator_reportinterval.md), location will be updated according to [MovementThreshold](geolocator_movementthreshold.md). + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba) + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_positionchanged.md b/windows.devices.geolocation/geolocator_positionchanged.md index 6501a7c3d2..1dd78b246b 100644 --- a/windows.devices.geolocation/geolocator_positionchanged.md +++ b/windows.devices.geolocation/geolocator_positionchanged.md @@ -1,3 +1,27 @@ ---- -api-id: E:Windows.Devices.Geolocation.Geolocator.PositionChanged --api-type: winrt event ---- # Windows.Devices.Geolocation.Geolocator.PositionChanged ## -description Raised when the location is updated. ## -remarks You can access information about the event with the [PositionChangedEventArgs](positionchangedeventargs.md) object that is passed to your event handler. > [!TIP] > When using an emulator, you must manually change the emulated location in order to trigger the [PositionChanged](geolocator_positionchanged.md) event. ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [PositionChangedEventArgs](positionchangedeventargs.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: E:Windows.Devices.Geolocation.Geolocator.PositionChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Geolocation.Geolocator.PositionChanged + +## -description +Raised when the location is updated. + +## -remarks +You can access information about the event with the [PositionChangedEventArgs](positionchangedeventargs.md) object that is passed to your event handler. + +> [!TIP] +> When using an emulator, you must manually change the emulated location in order to trigger the [PositionChanged](geolocator_positionchanged.md) event. + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [PositionChangedEventArgs](positionchangedeventargs.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_reportinterval.md b/windows.devices.geolocation/geolocator_reportinterval.md index 09153ed00f..0d756f23b9 100644 --- a/windows.devices.geolocation/geolocator_reportinterval.md +++ b/windows.devices.geolocation/geolocator_reportinterval.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geolocator.ReportInterval --api-type: winrt property ---- # Windows.Devices.Geolocation.Geolocator.ReportInterval ## -description The requested minimum time interval between location updates, in milliseconds. If your application requires updates infrequently, set this value so that location services can conserve power by calculating location only when needed. ## -property-value The requested minimum time interval between location updates. ## -remarks The default report interval is 1 second or as frequent as the hardware can support – whichever is shorter. Location updates can be set to a different frequency if you specify a [MovementThreshold](geolocator_movementthreshold.md) or set [ReportInterval](geolocator_reportinterval.md) to a different value. If your app sets both [MovementThreshold](geolocator_movementthreshold.md) and [ReportInterval](geolocator_reportinterval.md), location will be updated according to [MovementThreshold](geolocator_movementthreshold.md). If another application has requested more frequent updates, by specifying a smaller value for [ReportInterval](geolocator_reportinterval.md), your application may receive updates at a higher frequency than requested. ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba) ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geolocator.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geolocator.ReportInterval + +## -description +The requested minimum time interval between location updates, in milliseconds. If your application requires updates infrequently, set this value so that location services can conserve power by calculating location only when needed. + +## -property-value +The requested minimum time interval between location updates. + +## -remarks +The default report interval is 1 second or as frequent as the hardware can support – whichever is shorter. Location updates can be set to a different frequency if you specify a [MovementThreshold](geolocator_movementthreshold.md) or set [ReportInterval](geolocator_reportinterval.md) to a different value. If your app sets both [MovementThreshold](geolocator_movementthreshold.md) and [ReportInterval](geolocator_reportinterval.md), location will be updated according to [MovementThreshold](geolocator_movementthreshold.md). + +If another application has requested more frequent updates, by specifying a smaller value for [ReportInterval](geolocator_reportinterval.md), your application may receive updates at a higher frequency than requested. + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba) + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_requestaccessasync_380675631.md b/windows.devices.geolocation/geolocator_requestaccessasync_380675631.md index 705468592c..4d8282c719 100644 --- a/windows.devices.geolocation/geolocator_requestaccessasync_380675631.md +++ b/windows.devices.geolocation/geolocator_requestaccessasync_380675631.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geolocator.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.Geolocation.Geolocator.RequestAccessAsync ## -description Requests permission to access location data. ## -returns A [GeolocationAccessStatus](geolocationaccessstatus.md) that indicates if permission to location data has been granted. ## -remarks The [RequestAccessAsync](geolocator_requestaccessasync.md) method prompts the user for permission to access their location. The user is only prompted once (per app). After the first time they grant or deny permission, this method no longer prompts for permission. To help the user change location permissions after they've been prompted, we recommend providing a link to the location settings on their device. > [!TIP] > To link to location settings from your app, call the [LaunchUriAsync](../windows.system/launcher_launchuriasync.md) method with the URI "`ms-settings:privacy-location` ". For more info, see [Launch the Windows Settings app](http://msdn.microsoft.com/library/c84d4bee-1fee-4648-ad7d-8321eac70290). ## -examples ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geolocator.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geolocator.RequestAccessAsync + +## -description +Requests permission to access location data. + +## -returns +A [GeolocationAccessStatus](geolocationaccessstatus.md) that indicates if permission to location data has been granted. + +## -remarks +The [RequestAccessAsync](geolocator_requestaccessasync.md) method prompts the user for permission to access their location. The user is only prompted once (per app). After the first time they grant or deny permission, this method no longer prompts for permission. To help the user change location permissions after they've been prompted, we recommend providing a link to the location settings on their device. + +> [!TIP] +> To link to location settings from your app, call the [LaunchUriAsync](../windows.system/launcher_launchuriasync.md) method with the URI "`ms-settings:privacy-location` ". For more info, see [Launch the Windows Settings app](http://msdn.microsoft.com/library/c84d4bee-1fee-4648-ad7d-8321eac70290). + + + +## -examples + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) \ No newline at end of file diff --git a/windows.devices.geolocation/geolocator_statuschanged.md b/windows.devices.geolocation/geolocator_statuschanged.md index 4fdb2ca4b2..470fc3848d 100644 --- a/windows.devices.geolocation/geolocator_statuschanged.md +++ b/windows.devices.geolocation/geolocator_statuschanged.md @@ -1,3 +1,94 @@ ---- -api-id: E:Windows.Devices.Geolocation.Geolocator.StatusChanged --api-type: winrt event ---- # Windows.Devices.Geolocation.Geolocator.StatusChanged ## -description Raised when the ability of the [Geolocator](geolocator.md) to provide updated location changes. ## -remarks You can access information about the event with the [StatusChangedEventArgs](statuschangedeventargs.md) object that is passed to your event handler. When using a geofence, use the [GeofenceMonitor](../windows.devices.geolocation.geofencing/geofencemonitor.md) 's [StatusChanged](../windows.devices.geolocation.geofencing/geofencemonitor_statuschanged.md) event to monitor changes in location permissions instead of this event from the [Geolocator](geolocator.md) class. A [GeofenceMonitorStatus](../windows.devices.geolocation.geofencing/geofencemonitorstatus.md) of **Disabled** is equivalent to a **Disabled **[PositionStatus](positionstatus.md) - both indicate that the app does not have permission to access location. ## -examples This code example demonstrates how the [StatusChanged](geolocator_statuschanged.md) event is handled. The [Geolocator](geolocator.md) object triggers the [StatusChanged](geolocator_statuschanged.md) event to indicate that the user's location settings changed. That event passes the corresponding status via the argument's **Status** property (of type [PositionStatus](positionstatus.md)). Note that this method is not called from the UI thread and the [Dispatcher](../windows.ui.core/coredispatcher.md) object invokes the UI changes. For more info, see [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8). ```csharp using Windows.UI.Core; ... async private void OnStatusChanged(Geolocator sender, StatusChangedEventArgs e) { await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () => { // Show the location setting message only if status is disabled. LocationDisabledMessage.Visibility = Visibility.Collapsed; switch (e.Status) { case PositionStatus.Ready: // Location platform is providing valid data. ScenarioOutput_Status.Text = "Ready"; _rootPage.NotifyUser("Location platform is ready.", NotifyType.StatusMessage); break; case PositionStatus.Initializing: // Location platform is attempting to acquire a fix. ScenarioOutput_Status.Text = "Initializing"; _rootPage.NotifyUser("Location platform is attempting to obtain a position.", NotifyType.StatusMessage); break; case PositionStatus.NoData: // Location platform could not obtain location data. ScenarioOutput_Status.Text = "No data"; _rootPage.NotifyUser("Not able to determine the location.", NotifyType.ErrorMessage); break; case PositionStatus.Disabled: // The permission to access location data is denied by the user or other policies. ScenarioOutput_Status.Text = "Disabled"; _rootPage.NotifyUser("Access to location is denied.", NotifyType.ErrorMessage); // Show message to the user to go to location settings LocationDisabledMessage.Visibility = Visibility.Visible; // Clear cached location data if any UpdateLocationData(null); break; case PositionStatus.NotInitialized: // The location platform is not initialized. This indicates that the application // has not made a request for location data. ScenarioOutput_Status.Text = "Not initialized"; _rootPage.NotifyUser("No request for location is made yet.", NotifyType.StatusMessage); break; case PositionStatus.NotAvailable: // The location platform is not available on this version of the OS. ScenarioOutput_Status.Text = "Not available"; _rootPage.NotifyUser("Location is not available on this version of the OS.", NotifyType.ErrorMessage); break; default: ScenarioOutput_Status.Text = "Unknown"; _rootPage.NotifyUser(string.Empty, NotifyType.StatusMessage); break; } }); } ``` ## -see-also [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [StatusChangedEventArgs](statuschangedeventargs.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: E:Windows.Devices.Geolocation.Geolocator.StatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Geolocation.Geolocator.StatusChanged + +## -description +Raised when the ability of the [Geolocator](geolocator.md) to provide updated location changes. + +## -remarks +You can access information about the event with the [StatusChangedEventArgs](statuschangedeventargs.md) object that is passed to your event handler. + +When using a geofence, use the [GeofenceMonitor](../windows.devices.geolocation.geofencing/geofencemonitor.md) 's [StatusChanged](../windows.devices.geolocation.geofencing/geofencemonitor_statuschanged.md) event to monitor changes in location permissions instead of this event from the [Geolocator](geolocator.md) class. A [GeofenceMonitorStatus](../windows.devices.geolocation.geofencing/geofencemonitorstatus.md) of **Disabled** is equivalent to a **Disabled **[PositionStatus](positionstatus.md) - both indicate that the app does not have permission to access location. + +## -examples +This code example demonstrates how the [StatusChanged](geolocator_statuschanged.md) event is handled. The [Geolocator](geolocator.md) object triggers the [StatusChanged](geolocator_statuschanged.md) event to indicate that the user's location settings changed. That event passes the corresponding status via the argument's **Status** property (of type [PositionStatus](positionstatus.md)). Note that this method is not called from the UI thread and the [Dispatcher](../windows.ui.core/coredispatcher.md) object invokes the UI changes. For more info, see [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8). + +```csharp + +using Windows.UI.Core; +... +async private void OnStatusChanged(Geolocator sender, StatusChangedEventArgs e) +{ + await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () => + { + // Show the location setting message only if status is disabled. + LocationDisabledMessage.Visibility = Visibility.Collapsed; + + switch (e.Status) + { + case PositionStatus.Ready: + // Location platform is providing valid data. + ScenarioOutput_Status.Text = "Ready"; + _rootPage.NotifyUser("Location platform is ready.", NotifyType.StatusMessage); + break; + + case PositionStatus.Initializing: + // Location platform is attempting to acquire a fix. + ScenarioOutput_Status.Text = "Initializing"; + _rootPage.NotifyUser("Location platform is attempting to obtain a position.", NotifyType.StatusMessage); + break; + + case PositionStatus.NoData: + // Location platform could not obtain location data. + ScenarioOutput_Status.Text = "No data"; + _rootPage.NotifyUser("Not able to determine the location.", NotifyType.ErrorMessage); + break; + + case PositionStatus.Disabled: + // The permission to access location data is denied by the user or other policies. + ScenarioOutput_Status.Text = "Disabled"; + _rootPage.NotifyUser("Access to location is denied.", NotifyType.ErrorMessage); + + // Show message to the user to go to location settings + LocationDisabledMessage.Visibility = Visibility.Visible; + + // Clear cached location data if any + UpdateLocationData(null); + break; + + case PositionStatus.NotInitialized: + // The location platform is not initialized. This indicates that the application + // has not made a request for location data. + ScenarioOutput_Status.Text = "Not initialized"; + _rootPage.NotifyUser("No request for location is made yet.", NotifyType.StatusMessage); + break; + + case PositionStatus.NotAvailable: + // The location platform is not available on this version of the OS. + ScenarioOutput_Status.Text = "Not available"; + _rootPage.NotifyUser("Location is not available on this version of the OS.", NotifyType.ErrorMessage); + break; + + default: + ScenarioOutput_Status.Text = "Unknown"; + _rootPage.NotifyUser(string.Empty, NotifyType.StatusMessage); + break; + } + }); +} +``` + + + +## -see-also +[Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Get current location](http://msdn.microsoft.com/library/24dc9a41-8cc1-48b0-bc6d-24bf571afcc8), [Set up a geofence](http://msdn.microsoft.com/library/a3a46e03-0751-4dbd-a2a1-2323db09bdba), [StatusChangedEventArgs](statuschangedeventargs.md), [geolocation sample](http://go.microsoft.com/fwlink/p/?linkid=533278) + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geopath.md b/windows.devices.geolocation/geopath.md index 3ac0da7a96..e55ad40f8d 100644 --- a/windows.devices.geolocation/geopath.md +++ b/windows.devices.geolocation/geopath.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Geolocation.Geopath --api-type: winrt class ---- # Windows.Devices.Geolocation.Geopath ## -description Represents an ordered series of geographic points. ## -remarks ## -examples ## -see-also [IGeoshape](igeoshape.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.Geopath +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geopath + +## -description +Represents an ordered series of geographic points. + +## -remarks + +## -examples + +## -see-also +[IGeoshape](igeoshape.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geopath_altitudereferencesystem.md b/windows.devices.geolocation/geopath_altitudereferencesystem.md index f0acf62a1b..d99aca8ffe 100644 --- a/windows.devices.geolocation/geopath_altitudereferencesystem.md +++ b/windows.devices.geolocation/geopath_altitudereferencesystem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopath.AltitudeReferenceSystem --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopath.AltitudeReferenceSystem ## -description Gets the altitude reference system used by the [Geopath](geopath.md). ## -property-value The altitude reference system used by the [Geopath](geopath.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopath.AltitudeReferenceSystem +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopath.AltitudeReferenceSystem + +## -description +Gets the altitude reference system used by the [Geopath](geopath.md). + +## -property-value +The altitude reference system used by the [Geopath](geopath.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopath_geopath_209419777.md b/windows.devices.geolocation/geopath_geopath_209419777.md index 69d73c741c..2190c307ec 100644 --- a/windows.devices.geolocation/geopath_geopath_209419777.md +++ b/windows.devices.geolocation/geopath_geopath_209419777.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geopath.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition}) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geopath.Geopath ## -description Initializes a new instance of the [Geopath](geopath.md) class with the specified collection of positions. ## -parameters ### -param positions The collection of positions to use to create the new [Geopath](geopath.md). For more info, see the [Positions](geopath_positions.md) property. ## -remarks ## -examples ## -see-also [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geopath_geopath_794018629.md), [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geopath_geopath_549320865.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geopath.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition}) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geopath.Geopath + +## -description +Initializes a new instance of the [Geopath](geopath.md) class with the specified collection of positions. + +## -parameters +### -param positions +The collection of positions to use to create the new [Geopath](geopath.md). For more info, see the [Positions](geopath_positions.md) property. + +## -remarks + +## -examples + +## -see-also +[Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geopath_geopath_794018629.md), [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geopath_geopath_549320865.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geopath_geopath_549320865.md b/windows.devices.geolocation/geopath_geopath_549320865.md index 6b2c9248d3..a6dceceb20 100644 --- a/windows.devices.geolocation/geopath_geopath_549320865.md +++ b/windows.devices.geolocation/geopath_geopath_549320865.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geopath.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geopath.Geopath ## -description Initializes a new instance of the [Geopath](geopath.md) class with the specified collection of positions and with the specified altitude reference system and spatial reference ID (SRID). ## -parameters ### -param positions The collection of positions to use to create the new [Geopath](geopath.md). For more info, see the [Positions](geopath_positions.md) property. ### -param altitudeReferenceSystem The altitude reference system to use to create the new [Geopath](geopath.md). For more info, see the [AltitudeReferenceSystem](geopath_altitudereferencesystem.md) property. ### -param spatialReferenceId The spatial reference ID (SRID) to use to create the new [Geopath](geopath.md). For more info, see the [SpatialReferenceId](geopath_spatialreferenceid.md) property. ## -remarks ## -examples ## -see-also [Geopath(IIterable(BasicGeoposition))](geopath_geopath_209419777.md), [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geopath_geopath_794018629.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geopath.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geopath.Geopath + +## -description +Initializes a new instance of the [Geopath](geopath.md) class with the specified collection of positions and with the specified altitude reference system and spatial reference ID (SRID). + +## -parameters +### -param positions +The collection of positions to use to create the new [Geopath](geopath.md). For more info, see the [Positions](geopath_positions.md) property. + +### -param altitudeReferenceSystem +The altitude reference system to use to create the new [Geopath](geopath.md). For more info, see the [AltitudeReferenceSystem](geopath_altitudereferencesystem.md) property. + +### -param spatialReferenceId +The spatial reference ID (SRID) to use to create the new [Geopath](geopath.md). For more info, see the [SpatialReferenceId](geopath_spatialreferenceid.md) property. + +## -remarks + +## -examples + +## -see-also +[Geopath(IIterable(BasicGeoposition))](geopath_geopath_209419777.md), [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem)](geopath_geopath_794018629.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geopath_geopath_794018629.md b/windows.devices.geolocation/geopath_geopath_794018629.md index 3093293b47..edbb64493d 100644 --- a/windows.devices.geolocation/geopath_geopath_794018629.md +++ b/windows.devices.geolocation/geopath_geopath_794018629.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geopath.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geopath.Geopath ## -description Initializes a new instance of the [Geopath](geopath.md) class with the specified collection of positions and with the specified altitude reference system. ## -parameters ### -param positions The collection of positions to use to create the new [Geopath](geopath.md). For more info, see the [Positions](geopath_positions.md) property. ### -param altitudeReferenceSystem The altitude reference system to use to create the new [Geopath](geopath.md). For more info, see the [AltitudeReferenceSystem](geopath_altitudereferencesystem.md) property. ## -remarks ## -examples ## -see-also [Geopath(IIterable(BasicGeoposition))](geopath_geopath_209419777.md), [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geopath_geopath_549320865.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geopath.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Geolocation.BasicGeoposition},Windows.Devices.Geolocation.AltitudeReferenceSystem) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geopath.Geopath + +## -description +Initializes a new instance of the [Geopath](geopath.md) class with the specified collection of positions and with the specified altitude reference system. + +## -parameters +### -param positions +The collection of positions to use to create the new [Geopath](geopath.md). For more info, see the [Positions](geopath_positions.md) property. + +### -param altitudeReferenceSystem +The altitude reference system to use to create the new [Geopath](geopath.md). For more info, see the [AltitudeReferenceSystem](geopath_altitudereferencesystem.md) property. + +## -remarks + +## -examples + +## -see-also +[Geopath(IIterable(BasicGeoposition))](geopath_geopath_209419777.md), [Geopath(IIterable(BasicGeoposition), AltitudeReferenceSystem, UInt32)](geopath_geopath_549320865.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geopath_geoshapetype.md b/windows.devices.geolocation/geopath_geoshapetype.md index 448010560b..b777933097 100644 --- a/windows.devices.geolocation/geopath_geoshapetype.md +++ b/windows.devices.geolocation/geopath_geoshapetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopath.GeoshapeType --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopath.GeoshapeType ## -description Gets the type of geographic shape represented by the [Geopath](geopath.md). ## -property-value The type of geographic shape represented by the [Geopath](geopath.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopath.GeoshapeType +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopath.GeoshapeType + +## -description +Gets the type of geographic shape represented by the [Geopath](geopath.md). + +## -property-value +The type of geographic shape represented by the [Geopath](geopath.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopath_positions.md b/windows.devices.geolocation/geopath_positions.md index 93547a43c0..c42b2c457f 100644 --- a/windows.devices.geolocation/geopath_positions.md +++ b/windows.devices.geolocation/geopath_positions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopath.Positions --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopath.Positions ## -description Gets the collection of geographic points that define the [Geopath](geopath.md). ## -property-value The collection of geographic points that define the [Geopath](geopath.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopath.Positions +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopath.Positions + +## -description +Gets the collection of geographic points that define the [Geopath](geopath.md). + +## -property-value +The collection of geographic points that define the [Geopath](geopath.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopath_spatialreferenceid.md b/windows.devices.geolocation/geopath_spatialreferenceid.md index 39c24316e7..04c5e12ae4 100644 --- a/windows.devices.geolocation/geopath_spatialreferenceid.md +++ b/windows.devices.geolocation/geopath_spatialreferenceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopath.SpatialReferenceId --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopath.SpatialReferenceId ## -description Gets the spatial reference ID (SRID) used by the [Geopath](geopath.md). ## -property-value The spatial reference ID (SRID) used by the [Geopath](geopath.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopath.SpatialReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopath.SpatialReferenceId + +## -description +Gets the spatial reference ID (SRID) used by the [Geopath](geopath.md). + +## -property-value +The spatial reference ID (SRID) used by the [Geopath](geopath.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint.md b/windows.devices.geolocation/geopoint.md index 26bd260545..f5ad6f779f 100644 --- a/windows.devices.geolocation/geopoint.md +++ b/windows.devices.geolocation/geopoint.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Geolocation.Geopoint --api-type: winrt class ---- # Windows.Devices.Geolocation.Geopoint ## -description Describes a geographic point. ## -remarks ## -examples ## -see-also [IGeoshape](igeoshape.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.Geopoint +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geopoint + +## -description +Describes a geographic point. + +## -remarks + +## -examples + +## -see-also +[IGeoshape](igeoshape.md) \ No newline at end of file diff --git a/windows.devices.geolocation/geopoint_altitudereferencesystem.md b/windows.devices.geolocation/geopoint_altitudereferencesystem.md index f64412185a..b6aed1cf4b 100644 --- a/windows.devices.geolocation/geopoint_altitudereferencesystem.md +++ b/windows.devices.geolocation/geopoint_altitudereferencesystem.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopoint.AltitudeReferenceSystem --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopoint.AltitudeReferenceSystem ## -description The altitude reference system of the geographic point. ## -property-value The altitude reference system of the geographic point. ## -remarks > [!NOTE] > The default [altitude reference system](altitudereferencesystem.md) that’s used to provide location data depends on the GPS/GNSS radio hardware. Hardware typically found on older desktop PCs will continue using an **Ellipsoid** reference system. Everything else will default to using the **Geoid** reference system. To find out which one is being used by a [Geopoint](geopoint.md) object, see the [AltitudeReferenceSystem](geopoint_altitudereferencesystem.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopoint.AltitudeReferenceSystem +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopoint.AltitudeReferenceSystem + +## -description +The altitude reference system of the geographic point. + +## -property-value +The altitude reference system of the geographic point. + +## -remarks +> [!NOTE] +> The default [altitude reference system](altitudereferencesystem.md) that’s used to provide location data depends on the GPS/GNSS radio hardware. Hardware typically found on older desktop PCs will continue using an **Ellipsoid** reference system. Everything else will default to using the **Geoid** reference system. To find out which one is being used by a [Geopoint](geopoint.md) object, see the [AltitudeReferenceSystem](geopoint_altitudereferencesystem.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint_geopoint_1209856251.md b/windows.devices.geolocation/geopoint_geopoint_1209856251.md index daa9e9ea36..3ecc53d669 100644 --- a/windows.devices.geolocation/geopoint_geopoint_1209856251.md +++ b/windows.devices.geolocation/geopoint_geopoint_1209856251.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geopoint.#ctor(Windows.Devices.Geolocation.BasicGeoposition) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geopoint.Geopoint ## -description Create a geographic point object for the given position. ## -parameters ### -param position Create a geographic point object for the given position. ## -remarks The constructor will throw an exception if the provided [BasicGeoposition](basicgeoposition.md) has a latitude is less than -90 or greater than 90. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geopoint.#ctor(Windows.Devices.Geolocation.BasicGeoposition) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geopoint.Geopoint + +## -description +Create a geographic point object for the given position. + +## -parameters +### -param position +Create a geographic point object for the given position. + +## -remarks +The constructor will throw an exception if the provided [BasicGeoposition](basicgeoposition.md) has a latitude is less than -90 or greater than 90. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint_geopoint_1692038747.md b/windows.devices.geolocation/geopoint_geopoint_1692038747.md index 607d11c0aa..0cd2ea4c6c 100644 --- a/windows.devices.geolocation/geopoint_geopoint_1692038747.md +++ b/windows.devices.geolocation/geopoint_geopoint_1692038747.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geopoint.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geopoint.Geopoint ## -description Create a geographic point object for the given position, altitude reference system, and spatial reference Id. ## -parameters ### -param position Create a geographic point object for the given position. ### -param altitudeReferenceSystem The altitude reference system of the new point. ### -param spatialReferenceId The spatial reference Id of the new point. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geopoint.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geopoint.Geopoint + +## -description +Create a geographic point object for the given position, altitude reference system, and spatial reference Id. + +## -parameters +### -param position +Create a geographic point object for the given position. + +### -param altitudeReferenceSystem +The altitude reference system of the new point. + +### -param spatialReferenceId +The spatial reference Id of the new point. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint_geopoint_1798589887.md b/windows.devices.geolocation/geopoint_geopoint_1798589887.md index d0ec21f0d2..af7d877192 100644 --- a/windows.devices.geolocation/geopoint_geopoint_1798589887.md +++ b/windows.devices.geolocation/geopoint_geopoint_1798589887.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Geolocation.Geopoint.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem) --api-type: winrt method ---- # Windows.Devices.Geolocation.Geopoint.Geopoint ## -description Create a geographic point object for the given position and altitude reference system. ## -parameters ### -param position Create a geographic point object for the given position. ### -param altitudeReferenceSystem The altitude reference system of the new point. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Geolocation.Geopoint.#ctor(Windows.Devices.Geolocation.BasicGeoposition,Windows.Devices.Geolocation.AltitudeReferenceSystem) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.Geopoint.Geopoint + +## -description +Create a geographic point object for the given position and altitude reference system. + +## -parameters +### -param position +Create a geographic point object for the given position. + +### -param altitudeReferenceSystem +The altitude reference system of the new point. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint_geoshapetype.md b/windows.devices.geolocation/geopoint_geoshapetype.md index 572c68323a..ff6487a898 100644 --- a/windows.devices.geolocation/geopoint_geoshapetype.md +++ b/windows.devices.geolocation/geopoint_geoshapetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopoint.GeoshapeType --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopoint.GeoshapeType ## -description The type of geographic shape. ## -property-value The type of geographic shape. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopoint.GeoshapeType +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopoint.GeoshapeType + +## -description +The type of geographic shape. + +## -property-value +The type of geographic shape. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint_position.md b/windows.devices.geolocation/geopoint_position.md index 981f135efd..34831ca5a5 100644 --- a/windows.devices.geolocation/geopoint_position.md +++ b/windows.devices.geolocation/geopoint_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopoint.Position --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopoint.Position ## -description The position of a geographic point. ## -property-value The position of a geographic point. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopoint.Position +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopoint.Position + +## -description +The position of a geographic point. + +## -property-value +The position of a geographic point. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geopoint_spatialreferenceid.md b/windows.devices.geolocation/geopoint_spatialreferenceid.md index 3be3fa7234..cd3f11ee2a 100644 --- a/windows.devices.geolocation/geopoint_spatialreferenceid.md +++ b/windows.devices.geolocation/geopoint_spatialreferenceid.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geopoint.SpatialReferenceId --api-type: winrt property ---- # Windows.Devices.Geolocation.Geopoint.SpatialReferenceId ## -description The spatial reference identifier for the geographic point, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. ## -property-value The spatial reference identifier for the geographic point, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. ## -remarks The spatial reference id (SRID) corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. Spatial instances with the same SRID can be used when performing operations with spatial data methods on your data. The result of any spatial method derived from two spatial data instances is valid only if those instances have the same SRID that is based on the same unit of measurement, datum, and projection used to determine the coordinates of the instances. The most common units of measurement of a SRID are meters or square meters. The default SRID for the Windows platform is 4326 which is WGS84 ellipsoid. The spatial reference identification system is defined by the [European Petroleum Survey Group (EPSG)](http://go.microsoft.com/fwlink/p/?LinkID=306785) standard, which is a set of standards developed for cartography, surveying, and geodetic data storage. This standard is owned by the Oil and Gas Producers (OGP) Surveying and Positioning Committee. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geopoint.SpatialReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geopoint.SpatialReferenceId + +## -description +The spatial reference identifier for the geographic point, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. + +## -property-value +The spatial reference identifier for the geographic point, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. + +## -remarks +The spatial reference id (SRID) corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. Spatial instances with the same SRID can be used when performing operations with spatial data methods on your data. The result of any spatial method derived from two spatial data instances is valid only if those instances have the same SRID that is based on the same unit of measurement, datum, and projection used to determine the coordinates of the instances. The most common units of measurement of a SRID are meters or square meters. The default SRID for the Windows platform is 4326 which is WGS84 ellipsoid. + +The spatial reference identification system is defined by the [European Petroleum Survey Group (EPSG)](http://go.microsoft.com/fwlink/p/?LinkID=306785) standard, which is a set of standards developed for cartography, surveying, and geodetic data storage. This standard is owned by the Oil and Gas Producers (OGP) Surveying and Positioning Committee. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/geoposition_civicaddress.md b/windows.devices.geolocation/geoposition_civicaddress.md index fa423ea13a..5f55e3a40e 100644 --- a/windows.devices.geolocation/geoposition_civicaddress.md +++ b/windows.devices.geolocation/geoposition_civicaddress.md @@ -1,3 +1,32 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geoposition.CivicAddress --api-type: winrt property ---- # Windows.Devices.Geolocation.Geoposition.CivicAddress ## -description Unsupported API. ## -property-value Unsupported API. This property always returns **null**. ## -remarks Civic address is no longer available. Even when a Civic Address provider is installed, [Geoposition.CivicAddress](geoposition_civicaddress.md) will always return **NULL**. > [!NOTE] > This API is backwards compatible. When used in apps compiled for Windows 8.1 and Windows Phone 8.1, this API will continue to provide the civic address when it’s available. ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geoposition.CivicAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geoposition.CivicAddress + +## -description +Unsupported API. + +## -property-value +Unsupported API. This property always returns **null**. + +## -remarks +Civic address is no longer available. Even when a Civic Address provider is installed, [Geoposition.CivicAddress](geoposition_civicaddress.md) will always return **NULL**. + + + +> [!NOTE] +> This API is backwards compatible. When used in apps compiled for Windows 8.1 and Windows Phone 8.1, this API will continue to provide the civic address when it’s available. + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geoposition_coordinate.md b/windows.devices.geolocation/geoposition_coordinate.md index 98ab29c1e5..36f9f4647b 100644 --- a/windows.devices.geolocation/geoposition_coordinate.md +++ b/windows.devices.geolocation/geoposition_coordinate.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geoposition.Coordinate --api-type: winrt property ---- # Windows.Devices.Geolocation.Geoposition.Coordinate ## -description The latitude and longitude associated with a geographic location. ## -property-value The latitude and longitude associated with a geographic location. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geoposition.Coordinate +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geoposition.Coordinate + +## -description +The latitude and longitude associated with a geographic location. + +## -property-value +The latitude and longitude associated with a geographic location. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/geoposition_venuedata.md b/windows.devices.geolocation/geoposition_venuedata.md index e6e975e079..921fd02db0 100644 --- a/windows.devices.geolocation/geoposition_venuedata.md +++ b/windows.devices.geolocation/geoposition_venuedata.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Geolocation.Geoposition.VenueData --api-type: winrt property ---- # Windows.Devices.Geolocation.Geoposition.VenueData ## -description Represents the venue associated with a geographic location. ## -property-value A [VenueData](venuedata.md) object that represents the venue associated with the geographic location. ## -remarks This property represents a venue, such as a shopping mall or office building. The [VenueData](venuedata.md) object is created as a property of the [Geoposition](geoposition.md) class when venue information is available for a geographic location. Otherwise, this property returns **NULL**. Venue information is not available for all geographic locations. A [VenueData](venuedata.md) object will be returned only when the geographic location is within a venue that’s supported by the data provider. > [!NOTE] > In the current release, Bing is the exclusive data provider for all venue information. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.Geoposition.VenueData +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geoposition.VenueData + +## -description +Represents the venue associated with a geographic location. + +## -property-value +A [VenueData](venuedata.md) object that represents the venue associated with the geographic location. + +## -remarks +This property represents a venue, such as a shopping mall or office building. The [VenueData](venuedata.md) object is created as a property of the [Geoposition](geoposition.md) class when venue information is available for a geographic location. Otherwise, this property returns **NULL**. + +Venue information is not available for all geographic locations. A [VenueData](venuedata.md) object will be returned only when the geographic location is within a venue that’s supported by the data provider. + + + +> [!NOTE] +> In the current release, Bing is the exclusive data provider for all venue information. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/igeoshape_altitudereferencesystem.md b/windows.devices.geolocation/igeoshape_altitudereferencesystem.md index 8f5ca0257f..0ba9eaee5f 100644 --- a/windows.devices.geolocation/igeoshape_altitudereferencesystem.md +++ b/windows.devices.geolocation/igeoshape_altitudereferencesystem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.IGeoshape.AltitudeReferenceSystem --api-type: winrt property ---- # Windows.Devices.Geolocation.IGeoshape.AltitudeReferenceSystem ## -description The altitude reference system of the geographic shape. ## -property-value The altitude reference system of the geographic shape. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.IGeoshape.AltitudeReferenceSystem +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.IGeoshape.AltitudeReferenceSystem + +## -description +The altitude reference system of the geographic shape. + +## -property-value +The altitude reference system of the geographic shape. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/igeoshape_geoshapetype.md b/windows.devices.geolocation/igeoshape_geoshapetype.md index 6677a4d2c0..8688d03fc0 100644 --- a/windows.devices.geolocation/igeoshape_geoshapetype.md +++ b/windows.devices.geolocation/igeoshape_geoshapetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Geolocation.IGeoshape.GeoshapeType --api-type: winrt property ---- # Windows.Devices.Geolocation.IGeoshape.GeoshapeType ## -description The type of geographic shape. ## -property-value The type of geographic shape. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.IGeoshape.GeoshapeType +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.IGeoshape.GeoshapeType + +## -description +The type of geographic shape. + +## -property-value +The type of geographic shape. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/igeoshape_spatialreferenceid.md b/windows.devices.geolocation/igeoshape_spatialreferenceid.md index b440beea3e..7198c52a10 100644 --- a/windows.devices.geolocation/igeoshape_spatialreferenceid.md +++ b/windows.devices.geolocation/igeoshape_spatialreferenceid.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Geolocation.IGeoshape.SpatialReferenceId --api-type: winrt property ---- # Windows.Devices.Geolocation.IGeoshape.SpatialReferenceId ## -description The spatial reference identifier for the geographic shape, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. ## -property-value The spatial reference identifier for the geographic shape, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. ## -remarks The spatial reference id (SRID) corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. Spatial instances with the same SRID can be used when performing operations with spatial data methods on your data. The result of any spatial method derived from two spatial data instances is valid only if those instances have the same SRID that is based on the same unit of measurement, datum, and projection used to determine the coordinates of the instances. The most common units of measurement of a SRID are meters or square meters. The default SRID on Windows and Windows Phone is 4326 which is WGS84 ellipsoid. The spatial reference identification system is defined by the [European Petroleum Survey Group (EPSG)](http://go.microsoft.com/fwlink/p/?LinkID=306785) standard, which is a set of standards developed for cartography, surveying, and geodetic data storage. This standard is owned by the Oil and Gas Producers (OGP) Surveying and Positioning Committee. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.IGeoshape.SpatialReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.IGeoshape.SpatialReferenceId + +## -description +The spatial reference identifier for the geographic shape, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. + +## -property-value +The spatial reference identifier for the geographic shape, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. + +## -remarks +The spatial reference id (SRID) corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. Spatial instances with the same SRID can be used when performing operations with spatial data methods on your data. The result of any spatial method derived from two spatial data instances is valid only if those instances have the same SRID that is based on the same unit of measurement, datum, and projection used to determine the coordinates of the instances. The most common units of measurement of a SRID are meters or square meters. The default SRID on Windows and Windows Phone is 4326 which is WGS84 ellipsoid. + +The spatial reference identification system is defined by the [European Petroleum Survey Group (EPSG)](http://go.microsoft.com/fwlink/p/?LinkID=306785) standard, which is a set of standards developed for cartography, surveying, and geodetic data storage. This standard is owned by the Oil and Gas Producers (OGP) Surveying and Positioning Committee. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/positionchangedeventargs_position.md b/windows.devices.geolocation/positionchangedeventargs_position.md index 9a171dc6d8..cd06cd43d5 100644 --- a/windows.devices.geolocation/positionchangedeventargs_position.md +++ b/windows.devices.geolocation/positionchangedeventargs_position.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.PositionChangedEventArgs.Position --api-type: winrt property ---- # Windows.Devices.Geolocation.PositionChangedEventArgs.Position ## -description The location data associated with the [PositionChanged](geolocator_positionchanged.md) event. ## -property-value A [Geoposition](geoposition.md) object containing geographic location data. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.PositionChangedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.PositionChangedEventArgs.Position + +## -description +The location data associated with the [PositionChanged](geolocator_positionchanged.md) event. + +## -property-value +A [Geoposition](geoposition.md) object containing geographic location data. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/statuschangedeventargs_status.md b/windows.devices.geolocation/statuschangedeventargs_status.md index a0fe0c2846..bec7c7c42f 100644 --- a/windows.devices.geolocation/statuschangedeventargs_status.md +++ b/windows.devices.geolocation/statuschangedeventargs_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Geolocation.StatusChangedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.Geolocation.StatusChangedEventArgs.Status ## -description The updated status of the [Geolocator](geolocator.md) object. ## -property-value The updated status of the [Geolocator](geolocator.md) object. The status indicates the ability of the [Geolocator](geolocator.md) to provide location updates. ## -remarks ## -examples ## -see-also ## -capabilities location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.StatusChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.StatusChangedEventArgs.Status + +## -description +The updated status of the [Geolocator](geolocator.md) object. + +## -property-value +The updated status of the [Geolocator](geolocator.md) object. The status indicates the ability of the [Geolocator](geolocator.md) to provide location updates. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +location, ID_CAP_LOCATION [Windows Phone] \ No newline at end of file diff --git a/windows.devices.geolocation/venuedata.md b/windows.devices.geolocation/venuedata.md index c1e52cc6bf..c94fd3c43a 100644 --- a/windows.devices.geolocation/venuedata.md +++ b/windows.devices.geolocation/venuedata.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Devices.Geolocation.VenueData --api-type: winrt class ---- # Windows.Devices.Geolocation.VenueData ## -description Represents the venue associated with a geographic location. ## -remarks This class represents a venue, such as a shopping mall or office building. The [VenueData](venuedata.md) object is created as a property of the [Geoposition](geoposition.md) class when venue information is available for a geographic location. Otherwise, this property returns **NULL**. Venue information is not available for all geographic locations. A [VenueData](venuedata.md) object will be returned only when the geographic location is within a venue that’s supported by the data provider. > [!NOTE] > In this release, Bing is the exclusive data provider for all venue information. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Geolocation.VenueData +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.VenueData + +## -description +Represents the venue associated with a geographic location. + +## -remarks +This class represents a venue, such as a shopping mall or office building. The [VenueData](venuedata.md) object is created as a property of the [Geoposition](geoposition.md) class when venue information is available for a geographic location. Otherwise, this property returns **NULL**. + +Venue information is not available for all geographic locations. A [VenueData](venuedata.md) object will be returned only when the geographic location is within a venue that’s supported by the data provider. + + + +> [!NOTE] +> In this release, Bing is the exclusive data provider for all venue information. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/venuedata_id.md b/windows.devices.geolocation/venuedata_id.md index a0471f804e..a907239c66 100644 --- a/windows.devices.geolocation/venuedata_id.md +++ b/windows.devices.geolocation/venuedata_id.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.Geolocation.VenueData.Id --api-type: winrt property ---- # Windows.Devices.Geolocation.VenueData.Id ## -description Gets the identifier (ID) of the venue. ## -property-value The identifier (ID) of the venue. ## -remarks The **Id** property value and string format is determined by the data provider. > [!NOTE] > This property is equivalent to the ID of a Bing venue map. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.VenueData.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.VenueData.Id + +## -description +Gets the identifier (ID) of the venue. + +## -property-value +The identifier (ID) of the venue. + +## -remarks +The **Id** property value and string format is determined by the data provider. + + + +> [!NOTE] +> This property is equivalent to the ID of a Bing venue map. + +## -examples + +## -see-also diff --git a/windows.devices.geolocation/venuedata_level.md b/windows.devices.geolocation/venuedata_level.md index 735706092d..c1848c0adb 100644 --- a/windows.devices.geolocation/venuedata_level.md +++ b/windows.devices.geolocation/venuedata_level.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.Geolocation.VenueData.Level --api-type: winrt property ---- # Windows.Devices.Geolocation.VenueData.Level ## -description Gets the identifier (ID) of the building level. ## -property-value The identifier (ID) of the building level. ## -remarks The **Level** property value and string format is determined by the data provider. > [!NOTE] > This property is equivalent to the name of a floor in a Bing venue map. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Geolocation.VenueData.Level +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.VenueData.Level + +## -description +Gets the identifier (ID) of the building level. + +## -property-value +The identifier (ID) of the building level. + +## -remarks +The **Level** property value and string format is determined by the data provider. + + + +> [!NOTE] +> This property is equivalent to the name of a floor in a Bing venue map. + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs.md b/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs.md index 427ee3ecfd..189accd247 100644 --- a/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs.md +++ b/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs ## -description Provides information about the [IGpioPinProvider.ValueChanged](igpiopinprovider_valuechanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs + +## -description +Provides information about the [IGpioPinProvider.ValueChanged](igpiopinprovider_valuechanged.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_edge.md b/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_edge.md index a1a368e21e..d16c20113a 100644 --- a/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_edge.md +++ b/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_edge.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.Edge --api-type: winrt property ---- # Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.Edge ## -description Gets the value the pin has changed to. ## -property-value The pin edge. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.Edge +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.Edge + +## -description +Gets the value the pin has changed to. + +## -property-value +The pin edge. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_gpiopinprovidervaluechangedeventargs_930032666.md b/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_gpiopinprovidervaluechangedeventargs_930032666.md index 8cb7b53851..e18d8322c1 100644 --- a/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_gpiopinprovidervaluechangedeventargs_930032666.md +++ b/windows.devices.gpio.provider/gpiopinprovidervaluechangedeventargs_gpiopinprovidervaluechangedeventargs_930032666.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.#ctor(Windows.Devices.Gpio.Provider.ProviderGpioPinEdge) --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.GpioPinProviderValueChangedEventArgs ## -description Contructs the [GpioPinProviderValueChangedEventArgs](gpiopinprovidervaluechangedeventargs.md) class with the specified edge value. ## -parameters ### -param edge The desired pin edge. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.#ctor(Windows.Devices.Gpio.Provider.ProviderGpioPinEdge) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.GpioPinProviderValueChangedEventArgs.GpioPinProviderValueChangedEventArgs + +## -description +Contructs the [GpioPinProviderValueChangedEventArgs](gpiopinprovidervaluechangedeventargs.md) class with the specified edge value. + +## -parameters +### -param edge +The desired pin edge. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiocontrollerprovider_openpinprovider.md b/windows.devices.gpio.provider/igpiocontrollerprovider_openpinprovider.md index e054399fba..27a962a32b 100644 --- a/windows.devices.gpio.provider/igpiocontrollerprovider_openpinprovider.md +++ b/windows.devices.gpio.provider/igpiocontrollerprovider_openpinprovider.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioControllerProvider.OpenPinProvider(System.Int32,Windows.Devices.Gpio.Provider.ProviderGpioSharingMode) --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioControllerProvider.OpenPinProvider ## -description Opens and returns the general-purpose I/O (GPIO) pin provider for a specific pin. ## -parameters ### -param pin The desired GPIO pin number. ### -param sharingMode The sharing mode to open the pin as. ## -returns The GPIO pin provider for the specified pin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioControllerProvider.OpenPinProvider(System.Int32,Windows.Devices.Gpio.Provider.ProviderGpioSharingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioControllerProvider.OpenPinProvider + +## -description +Opens and returns the general-purpose I/O (GPIO) pin provider for a specific pin. + +## -parameters +### -param pin +The desired GPIO pin number. + +### -param sharingMode +The sharing mode to open the pin as. + +## -returns +The GPIO pin provider for the specified pin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiocontrollerprovider_pincount.md b/windows.devices.gpio.provider/igpiocontrollerprovider_pincount.md index e2088a21d0..d7241e2b3b 100644 --- a/windows.devices.gpio.provider/igpiocontrollerprovider_pincount.md +++ b/windows.devices.gpio.provider/igpiocontrollerprovider_pincount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Gpio.Provider.IGpioControllerProvider.PinCount --api-type: winrt property ---- # Windows.Devices.Gpio.Provider.IGpioControllerProvider.PinCount ## -description Gets the number of general-purpose I/O (GPIO) pins available. ## -property-value The number of GPIO pins available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.Provider.IGpioControllerProvider.PinCount +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.Provider.IGpioControllerProvider.PinCount + +## -description +Gets the number of general-purpose I/O (GPIO) pins available. + +## -property-value +The number of GPIO pins available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_debouncetimeout.md b/windows.devices.gpio.provider/igpiopinprovider_debouncetimeout.md index 32fe93484b..34199bb151 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_debouncetimeout.md +++ b/windows.devices.gpio.provider/igpiopinprovider_debouncetimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Gpio.Provider.IGpioPinProvider.DebounceTimeout --api-type: winrt property ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.DebounceTimeout ## -description Gets or sets the debounce timeout for the general-purpose I/O (GPIO) pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](igpiopinprovider_valuechanged.md) events. ## -property-value The debounce timeout for the GPIO pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](igpiopinprovider_valuechanged.md) events. If the length of this interval is 0, all changes to the value of the pin generate [ValueChanged](igpiopinprovider_valuechanged.md) events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.Provider.IGpioPinProvider.DebounceTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.DebounceTimeout + +## -description +Gets or sets the debounce timeout for the general-purpose I/O (GPIO) pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](igpiopinprovider_valuechanged.md) events. + +## -property-value +The debounce timeout for the GPIO pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](igpiopinprovider_valuechanged.md) events. If the length of this interval is 0, all changes to the value of the pin generate [ValueChanged](igpiopinprovider_valuechanged.md) events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_getdrivemode.md b/windows.devices.gpio.provider/igpiopinprovider_getdrivemode.md index 20d5422f67..b9d23c0f47 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_getdrivemode.md +++ b/windows.devices.gpio.provider/igpiopinprovider_getdrivemode.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.GetDriveMode --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.GetDriveMode ## -description Gets the pin's currently configured drive mode. ## -returns The drive mode of the pin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.GetDriveMode +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.GetDriveMode + +## -description +Gets the pin's currently configured drive mode. + +## -returns +The drive mode of the pin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_isdrivemodesupported.md b/windows.devices.gpio.provider/igpiopinprovider_isdrivemodesupported.md index 84ce553704..8a72317658 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_isdrivemodesupported.md +++ b/windows.devices.gpio.provider/igpiopinprovider_isdrivemodesupported.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.IsDriveModeSupported(Windows.Devices.Gpio.Provider.ProviderGpioPinDriveMode) --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.IsDriveModeSupported ## -description Determines if a drive mode is supported for the pin. ## -parameters ### -param driveMode The desired drive mode. ## -returns True if the drive mode is supported; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.IsDriveModeSupported(Windows.Devices.Gpio.Provider.ProviderGpioPinDriveMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.IsDriveModeSupported + +## -description +Determines if a drive mode is supported for the pin. + +## -parameters +### -param driveMode +The desired drive mode. + +## -returns +True if the drive mode is supported; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_pinnumber.md b/windows.devices.gpio.provider/igpiopinprovider_pinnumber.md index e9a8470f1b..81d43773b5 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_pinnumber.md +++ b/windows.devices.gpio.provider/igpiopinprovider_pinnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Gpio.Provider.IGpioPinProvider.PinNumber --api-type: winrt property ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.PinNumber ## -description Gets the pin number of the general-purpose I/O (GPIO) pin. ## -property-value The pin number of the GPIO pin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.Provider.IGpioPinProvider.PinNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.PinNumber + +## -description +Gets the pin number of the general-purpose I/O (GPIO) pin. + +## -property-value +The pin number of the GPIO pin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_read.md b/windows.devices.gpio.provider/igpiopinprovider_read.md index 6426f8ea03..5b3aed8a9c 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_read.md +++ b/windows.devices.gpio.provider/igpiopinprovider_read.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.Read --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.Read ## -description Reads the current value of the pin. ## -returns The pin's value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.Read +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.Read + +## -description +Reads the current value of the pin. + +## -returns +The pin's value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_setdrivemode.md b/windows.devices.gpio.provider/igpiopinprovider_setdrivemode.md index b978e446f2..d98268b933 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_setdrivemode.md +++ b/windows.devices.gpio.provider/igpiopinprovider_setdrivemode.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.SetDriveMode(Windows.Devices.Gpio.Provider.ProviderGpioPinDriveMode) --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.SetDriveMode ## -description Sets the pin's drive mode. ## -parameters ### -param value The desired drive mode for the pin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.SetDriveMode(Windows.Devices.Gpio.Provider.ProviderGpioPinDriveMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.SetDriveMode + +## -description +Sets the pin's drive mode. + +## -parameters +### -param value +The desired drive mode for the pin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_sharingmode.md b/windows.devices.gpio.provider/igpiopinprovider_sharingmode.md index 95e4d7289a..19c9e6a4c7 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_sharingmode.md +++ b/windows.devices.gpio.provider/igpiopinprovider_sharingmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Gpio.Provider.IGpioPinProvider.SharingMode --api-type: winrt property ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.SharingMode ## -description Gets the sharing mode in which the general-purpose I/O (GPIO) pin is open. ## -property-value The sharing mode in which the GPIO pin is open. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.Provider.IGpioPinProvider.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.SharingMode + +## -description +Gets the sharing mode in which the general-purpose I/O (GPIO) pin is open. + +## -property-value +The sharing mode in which the GPIO pin is open. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpiopinprovider_valuechanged.md b/windows.devices.gpio.provider/igpiopinprovider_valuechanged.md index 742e5e8eb9..b96b1284ba 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_valuechanged.md +++ b/windows.devices.gpio.provider/igpiopinprovider_valuechanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Gpio.Provider.IGpioPinProvider.ValueChanged --api-type: winrt event ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.ValueChanged ## -description Event that fires when the value of the pin has changed. ## -remarks ## -examples ## -see-also [GpioPinProviderValueChangedEventArgs](gpiopinprovidervaluechangedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Gpio.Provider.IGpioPinProvider.ValueChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.ValueChanged + +## -description +Event that fires when the value of the pin has changed. + +## -remarks + +## -examples + +## -see-also +[GpioPinProviderValueChangedEventArgs](gpiopinprovidervaluechangedeventargs.md) \ No newline at end of file diff --git a/windows.devices.gpio.provider/igpiopinprovider_write.md b/windows.devices.gpio.provider/igpiopinprovider_write.md index a37527aa22..35ee22a36a 100644 --- a/windows.devices.gpio.provider/igpiopinprovider_write.md +++ b/windows.devices.gpio.provider/igpiopinprovider_write.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.Write(Windows.Devices.Gpio.Provider.ProviderGpioPinValue) --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioPinProvider.Write ## -description Writes a value to the pin. ## -parameters ### -param value The value to write. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioPinProvider.Write(Windows.Devices.Gpio.Provider.ProviderGpioPinValue) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioPinProvider.Write + +## -description +Writes a value to the pin. + +## -parameters +### -param value +The value to write. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio.provider/igpioprovider_getcontrollers.md b/windows.devices.gpio.provider/igpioprovider_getcontrollers.md index b658dcd4b5..4c49ec2466 100644 --- a/windows.devices.gpio.provider/igpioprovider_getcontrollers.md +++ b/windows.devices.gpio.provider/igpioprovider_getcontrollers.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Gpio.Provider.IGpioProvider.GetControllers --api-type: winrt method ---- # Windows.Devices.Gpio.Provider.IGpioProvider.GetControllers ## -description Gets the controllers available on the system. ## -returns A list of values that represent the controllers available on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.Provider.IGpioProvider.GetControllers +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.Provider.IGpioProvider.GetControllers + +## -description +Gets the controllers available on the system. + +## -returns +A list of values that represent the controllers available on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio/gpiocontroller.md b/windows.devices.gpio/gpiocontroller.md index 31e7ea3d6c..7c254ba8a1 100644 --- a/windows.devices.gpio/gpiocontroller.md +++ b/windows.devices.gpio/gpiocontroller.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Gpio.GpioController --api-type: winrt class ---- # Windows.Devices.Gpio.GpioController ## -description Represents the default general-purpose I/O (GPIO) controller for the system. ## -remarks To get a [GpioController](gpiocontroller.md) object, use the [GpioController.GetDefault](gpiocontroller_getdefault.md) method. ## -examples ## -see-also [GpioController.GetDefault](gpiocontroller_getdefault.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Gpio.GpioController +-api-type: winrt class +--- + + + +# Windows.Devices.Gpio.GpioController + +## -description +Represents the default general-purpose I/O (GPIO) controller for the system. + +## -remarks +To get a [GpioController](gpiocontroller.md) object, use the [GpioController.GetDefault](gpiocontroller_getdefault.md) method. + +## -examples + +## -see-also +[GpioController.GetDefault](gpiocontroller_getdefault.md) \ No newline at end of file diff --git a/windows.devices.gpio/gpiocontroller_getcontrollersasync_905412264.md b/windows.devices.gpio/gpiocontroller_getcontrollersasync_905412264.md index 1499e88c85..a1b34d4ea5 100644 --- a/windows.devices.gpio/gpiocontroller_getcontrollersasync_905412264.md +++ b/windows.devices.gpio/gpiocontroller_getcontrollersasync_905412264.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioController.GetControllersAsync(Windows.Devices.Gpio.Provider.IGpioProvider) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioController.GetControllersAsync ## -description Gets all the controllers that are connected to the system asynchronously. ## -parameters ### -param provider The GPIO provider for the controllers on the system. ## -returns When the method completes successfully, it returns a list of values that represent the controllers available on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioController.GetControllersAsync(Windows.Devices.Gpio.Provider.IGpioProvider) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioController.GetControllersAsync + +## -description +Gets all the controllers that are connected to the system asynchronously. + +## -parameters +### -param provider +The GPIO provider for the controllers on the system. + +## -returns +When the method completes successfully, it returns a list of values that represent the controllers available on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio/gpiocontroller_getdefault_846721868.md b/windows.devices.gpio/gpiocontroller_getdefault_846721868.md index 4ca2f3f1ee..21e8b5b135 100644 --- a/windows.devices.gpio/gpiocontroller_getdefault_846721868.md +++ b/windows.devices.gpio/gpiocontroller_getdefault_846721868.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioController.GetDefault --api-type: winrt method ---- # Windows.Devices.Gpio.GpioController.GetDefault ## -description Gets the default general-purpose I/O (GPIO) controller for the system. ## -returns The default GPIO controller for the system, or null if the system has no GPIO controller. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioController.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioController.GetDefault + +## -description +Gets the default general-purpose I/O (GPIO) controller for the system. + +## -returns +The default GPIO controller for the system, or null if the system has no GPIO controller. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiocontroller_getdefaultasync_1549573963.md b/windows.devices.gpio/gpiocontroller_getdefaultasync_1549573963.md index 4392c3007c..92c9f55d64 100644 --- a/windows.devices.gpio/gpiocontroller_getdefaultasync_1549573963.md +++ b/windows.devices.gpio/gpiocontroller_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioController.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Gpio.GpioController.GetDefaultAsync ## -description Gets the default general-purpose I/O (GPIO) controller for the system. ## -returns The default GPIO controller for the system, or null if the system has no GPIO controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioController.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioController.GetDefaultAsync + +## -description +Gets the default general-purpose I/O (GPIO) controller for the system. + +## -returns +The default GPIO controller for the system, or null if the system has no GPIO controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.gpio/gpiocontroller_openpin_1000658948.md b/windows.devices.gpio/gpiocontroller_openpin_1000658948.md index a21f678df3..603ada5d68 100644 --- a/windows.devices.gpio/gpiocontroller_openpin_1000658948.md +++ b/windows.devices.gpio/gpiocontroller_openpin_1000658948.md @@ -1,3 +1,60 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioController.OpenPin(System.Int32) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioController.OpenPin ## -description Opens a connection to the specified general-purpose I/O (GPIO) pin in exclusive mode. ## -parameters ### -param pinNumber The pin number of the GPIO pin that you want to open. The pin number must be + in range + available to usermode applications Pin numbers start at 0, and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). Which pins are available to usermode depends on the circuit board on which the code is running. For information about how pin numbers correspond to physical pins, see the documentation for your circuit board. Pin mappings for boards such as the Raspberry Pi are available at the [IoT developer center](https://developer.microsoft.com/en-us/windows/iot/). ## -returns The opened GPIO pin. ## -exceptions ### E_INVALIDARG (0x80070057) An invalid parameter was specified. This error will be returned if the pin number is out of range. Pin numbers start at 0 and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). ### HRESULT_FROM_WIN32(ERROR_NOT_FOUND) (0x80070490) The pin is not available to usermode applications; it is reserved by the system. See the documentation for your circuit board to find out which pins are available to usermode applications. ### HRESULT_FROM_WIN32(ERROR_SHARING_VIOLATION) (0x80070020) The pin is currently open in an incompatible sharing mode. For example: + The pin is already open in **GpioSharingMode.Exclusive** mode. + The pin is already open in **GpioSharingMode.SharedReadOnly** mode when you request to open it in **GpioSharingMode.Exclusive** mode. ### HRESULT_FROM_WIN32(ERROR_GPIO_INCOMPATIBLE_CONNECT_MODE) (0x80073bde) The pin is currently muxed to a different function; for example I2C, SPI, or UART. Ensure the pin is not in use by another function. ### HRESULT_FROM_WIN32(ERROR_GEN_FAILURE) (0x8007001f) The GPIO driver returned an error. Ensure that the GPIO driver is running and configured correctly. ## -remarks ## -examples ## -see-also [OpenPin(Int32, GpioSharingMode)](gpiocontroller_openpin_1242230438.md), [GpioPin.Close](gpiopin_close.md), [GpioSharingMode](gpiosharingmode.md), [TryOpenPin](gpiocontroller_tryopenpin.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioController.OpenPin(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioController.OpenPin + +## -description +Opens a connection to the specified general-purpose I/O (GPIO) pin in exclusive mode. + +## -parameters +### -param pinNumber +The pin number of the GPIO pin that you want to open. The pin number must be ++ in range ++ available to usermode applications + + +Pin numbers start at 0, and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). + +Which pins are available to usermode depends on the circuit board on which the code is running. For information about how pin numbers correspond to physical pins, see the documentation for your circuit board. Pin mappings for boards such as the Raspberry Pi are available at the [IoT developer center](https://developer.microsoft.com/en-us/windows/iot/). + +## -returns +The opened GPIO pin. + +## -exceptions +### E_INVALIDARG (0x80070057) + +An invalid parameter was specified. This error will be returned if the pin number is out of range. Pin numbers start at 0 and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). + +### HRESULT_FROM_WIN32(ERROR_NOT_FOUND) (0x80070490) + +The pin is not available to usermode applications; it is reserved by the system. See the documentation for your circuit board to find out which pins are available to usermode applications. + +### HRESULT_FROM_WIN32(ERROR_SHARING_VIOLATION) (0x80070020) + +The pin is currently open in an incompatible sharing mode. For example: + + ++ The pin is already open in **GpioSharingMode.Exclusive** mode. ++ The pin is already open in **GpioSharingMode.SharedReadOnly** mode when you request to open it in **GpioSharingMode.Exclusive** mode. + + +### HRESULT_FROM_WIN32(ERROR_GPIO_INCOMPATIBLE_CONNECT_MODE) (0x80073bde) + +The pin is currently muxed to a different function; for example I2C, SPI, or UART. Ensure the pin is not in use by another function. + +### HRESULT_FROM_WIN32(ERROR_GEN_FAILURE) (0x8007001f) + +The GPIO driver returned an error. Ensure that the GPIO driver is running and configured correctly. + +## -remarks + +## -examples + +## -see-also +[OpenPin(Int32, GpioSharingMode)](gpiocontroller_openpin_1242230438.md), [GpioPin.Close](gpiopin_close.md), [GpioSharingMode](gpiosharingmode.md), [TryOpenPin](gpiocontroller_tryopenpin.md) \ No newline at end of file diff --git a/windows.devices.gpio/gpiocontroller_openpin_1242230438.md b/windows.devices.gpio/gpiocontroller_openpin_1242230438.md index 9f5b7bc2c9..e1af7a8065 100644 --- a/windows.devices.gpio/gpiocontroller_openpin_1242230438.md +++ b/windows.devices.gpio/gpiocontroller_openpin_1242230438.md @@ -1,3 +1,63 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioController.OpenPin(System.Int32,Windows.Devices.Gpio.GpioSharingMode) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioController.OpenPin ## -description Opens the specified general-purpose I/O (GPIO) pin in the specified mode. ## -parameters ### -param pinNumber The pin number of the GPIO pin that you want to open. The pin number must be + in range + available to usermode applications Pin numbers start at 0, and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). Which pins are available to usermode depends on the circuit board on which the code is running. For information about how pin numbers correspond to physical pins, see the documentation for your circuit board. Pin mappings for boards such as the Raspberry Pi are available at the [IoT developer center](https://developer.microsoft.com/en-us/windows/iot/). ### -param sharingMode The mode in which you want to open the GPIO pin, which determines whether other connections to the pin can be opened while you have the pin open. ## -returns The opened GPIO pin. ## -exceptions ### E_INVALIDARG (0x80070057) An invalid parameter was specified. This error will be returned if the pin number is out of range. Pin numbers start at 0 and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). ### HRESULT_FROM_WIN32(ERROR_NOT_FOUND) (0x80070490) The pin is not available to usermode applications; it is reserved by the system. See the documentation for your circuit board to find out which pins are available to usermode applications. ### HRESULT_FROM_WIN32(ERROR_SHARING_VIOLATION) (0x80070020) The pin is currently open in an incompatible sharing mode. For example: + The pin is already open in **GpioSharingMode.Exclusive** mode. + The pin is already open in **GpioSharingMode.SharedReadOnly** mode when you request to open it in **GpioSharingMode.Exclusive** mode. ### HRESULT_FROM_WIN32(ERROR_GPIO_INCOMPATIBLE_CONNECT_MODE) (0x80073bde) The pin is currently muxed to a different function; for example I2C, SPI, or UART. Ensure the pin is not in use by another function. ### HRESULT_FROM_WIN32(ERROR_GEN_FAILURE) (0x8007001f) The GPIO driver returned an error. Ensure that the GPIO driver is running and configured correctly. ## -remarks ## -examples ## -see-also [OpenPin(Int32)](gpiocontroller_openpin_1000658948.md), [GpioPin.Close](gpiopin_close.md), [GpioSharingMode](gpiosharingmode.md), [TryOpenPin](gpiocontroller_tryopenpin.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioController.OpenPin(System.Int32,Windows.Devices.Gpio.GpioSharingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioController.OpenPin + +## -description +Opens the specified general-purpose I/O (GPIO) pin in the specified mode. + +## -parameters +### -param pinNumber +The pin number of the GPIO pin that you want to open. The pin number must be ++ in range ++ available to usermode applications + + +Pin numbers start at 0, and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). + +Which pins are available to usermode depends on the circuit board on which the code is running. For information about how pin numbers correspond to physical pins, see the documentation for your circuit board. Pin mappings for boards such as the Raspberry Pi are available at the [IoT developer center](https://developer.microsoft.com/en-us/windows/iot/). + +### -param sharingMode +The mode in which you want to open the GPIO pin, which determines whether other connections to the pin can be opened while you have the pin open. + +## -returns +The opened GPIO pin. + +## -exceptions +### E_INVALIDARG (0x80070057) + +An invalid parameter was specified. This error will be returned if the pin number is out of range. Pin numbers start at 0 and increase to the maximum pin number, which is one less than the value returned by [GpioController.PinCount](gpiocontroller_pincount.md). + +### HRESULT_FROM_WIN32(ERROR_NOT_FOUND) (0x80070490) + +The pin is not available to usermode applications; it is reserved by the system. See the documentation for your circuit board to find out which pins are available to usermode applications. + +### HRESULT_FROM_WIN32(ERROR_SHARING_VIOLATION) (0x80070020) + +The pin is currently open in an incompatible sharing mode. For example: + + ++ The pin is already open in **GpioSharingMode.Exclusive** mode. ++ The pin is already open in **GpioSharingMode.SharedReadOnly** mode when you request to open it in **GpioSharingMode.Exclusive** mode. + + +### HRESULT_FROM_WIN32(ERROR_GPIO_INCOMPATIBLE_CONNECT_MODE) (0x80073bde) + +The pin is currently muxed to a different function; for example I2C, SPI, or UART. Ensure the pin is not in use by another function. + +### HRESULT_FROM_WIN32(ERROR_GEN_FAILURE) (0x8007001f) + +The GPIO driver returned an error. Ensure that the GPIO driver is running and configured correctly. + +## -remarks + +## -examples + +## -see-also +[OpenPin(Int32)](gpiocontroller_openpin_1000658948.md), [GpioPin.Close](gpiopin_close.md), [GpioSharingMode](gpiosharingmode.md), [TryOpenPin](gpiocontroller_tryopenpin.md) \ No newline at end of file diff --git a/windows.devices.gpio/gpiocontroller_pincount.md b/windows.devices.gpio/gpiocontroller_pincount.md index f5e7b9679e..0051488d3b 100644 --- a/windows.devices.gpio/gpiocontroller_pincount.md +++ b/windows.devices.gpio/gpiocontroller_pincount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Gpio.GpioController.PinCount --api-type: winrt property ---- # Windows.Devices.Gpio.GpioController.PinCount ## -description Gets the number of pins on the general-purpose I/O (GPIO) controller. ## -property-value The number of pins on the GPIO controller. Some pins may not be available in user mode. For information about how the pin numbers correspond to physical pins, see the documentation for your circuit board. ## -remarks ## -examples ## -see-also [OpenPin](gpiocontroller_openpin.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.GpioController.PinCount +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioController.PinCount + +## -description +Gets the number of pins on the general-purpose I/O (GPIO) controller. + +## -property-value +The number of pins on the GPIO controller. Some pins may not be available in user mode. For information about how the pin numbers correspond to physical pins, see the documentation for your circuit board. + +## -remarks + +## -examples + +## -see-also +[OpenPin](gpiocontroller_openpin.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiocontroller_tryopenpin_619900994.md b/windows.devices.gpio/gpiocontroller_tryopenpin_619900994.md index 301f3a63cb..63b6c37b76 100644 --- a/windows.devices.gpio/gpiocontroller_tryopenpin_619900994.md +++ b/windows.devices.gpio/gpiocontroller_tryopenpin_619900994.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioController.TryOpenPin(System.Int32,Windows.Devices.Gpio.GpioSharingMode,Windows.Devices.Gpio.GpioPin@,Windows.Devices.Gpio.GpioOpenStatus@) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioController.TryOpenPin ## -description Opens the specified general-purpose I/O (GPIO) pin in the specified mode, and gets a status value that you can use to handle a failure to open the pin programmatically. ## -parameters ### -param pinNumber The pin number of the GPIO pin that you want to open. Some pins may not be available in user mode. For information about how the pin numbers correspond to physical pins, see the documentation for your circuit board. ### -param sharingMode The mode in which you want to open the GPIO pin, which determines whether other connections to the pin can be opened while you have the pin open. ### -param pin The opened GPIO pin if the return value is true; otherwise null. ### -param openStatus An enumeration value that indicates either that the attempt to open the GPIO pin succeeded, or the reason that the attempt to open the GPIO pin failed. ## -returns True if the method successfully opened the pin; otherwise false. If the method returns true, the *pin* parameter receives an instance of a [GpioPin](gpiopin.md), and the *openStatus* parameter receives **GpioOpenStatus.PinOpened**. If the method returns false, the *pin* parameter is null and the *openStatus* parameter receives the reason that the operation failed. ## -remarks ## -examples ## -see-also [OpenPin](gpiocontroller_openpin.md), [GpioOpenStatus](gpioopenstatus.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioController.TryOpenPin(System.Int32,Windows.Devices.Gpio.GpioSharingMode,Windows.Devices.Gpio.GpioPin@,Windows.Devices.Gpio.GpioOpenStatus@) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioController.TryOpenPin + +## -description +Opens the specified general-purpose I/O (GPIO) pin in the specified mode, and gets a status value that you can use to handle a failure to open the pin programmatically. + +## -parameters +### -param pinNumber +The pin number of the GPIO pin that you want to open. Some pins may not be available in user mode. For information about how the pin numbers correspond to physical pins, see the documentation for your circuit board. + +### -param sharingMode +The mode in which you want to open the GPIO pin, which determines whether other connections to the pin can be opened while you have the pin open. + +### -param pin +The opened GPIO pin if the return value is true; otherwise null. + +### -param openStatus +An enumeration value that indicates either that the attempt to open the GPIO pin succeeded, or the reason that the attempt to open the GPIO pin failed. + +## -returns +True if the method successfully opened the pin; otherwise false. + +If the method returns true, the *pin* parameter receives an instance of a [GpioPin](gpiopin.md), and the *openStatus* parameter receives **GpioOpenStatus.PinOpened**. If the method returns false, the *pin* parameter is null and the *openStatus* parameter receives the reason that the operation failed. + +## -remarks + +## -examples + +## -see-also +[OpenPin](gpiocontroller_openpin.md), [GpioOpenStatus](gpioopenstatus.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin.md b/windows.devices.gpio/gpiopin.md index 35700849d9..944af4ed41 100644 --- a/windows.devices.gpio/gpiopin.md +++ b/windows.devices.gpio/gpiopin.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Gpio.GpioPin --api-type: winrt class ---- # Windows.Devices.Gpio.GpioPin ## -description Represents a general-purpose I/O (GPIO) pin. ## -remarks To get a [GpioPin](gpiopin.md) object, use the [GpioController.OpenPin](gpiocontroller_openpin.md) or [GpioController.TryOpenPin](gpiocontroller_tryopenpin.md) method. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Gpio.GpioPin +-api-type: winrt class +--- + + + +# Windows.Devices.Gpio.GpioPin + +## -description +Represents a general-purpose I/O (GPIO) pin. + +## -remarks +To get a [GpioPin](gpiopin.md) object, use the [GpioController.OpenPin](gpiocontroller_openpin.md) or [GpioController.TryOpenPin](gpiocontroller_tryopenpin.md) method. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_close_811482585.md b/windows.devices.gpio/gpiopin_close_811482585.md index 2fc703aaad..76391bfcf4 100644 --- a/windows.devices.gpio/gpiopin_close_811482585.md +++ b/windows.devices.gpio/gpiopin_close_811482585.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioPin.Close --api-type: winrt method ---- # Windows.Devices.Gpio.GpioPin.Close ## -description Closes the general-purpose I/O (GPIO) pin and releases the resources associated with it. ## -remarks You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also [GpioController.OpenPin](gpiocontroller_openpin.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioPin.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioPin.Close + +## -description +Closes the general-purpose I/O (GPIO) pin and releases the resources associated with it. + +## -remarks +You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also +[GpioController.OpenPin](gpiocontroller_openpin.md) \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_debouncetimeout.md b/windows.devices.gpio/gpiopin_debouncetimeout.md index 0f352df6f0..99bfbc7b4b 100644 --- a/windows.devices.gpio/gpiopin_debouncetimeout.md +++ b/windows.devices.gpio/gpiopin_debouncetimeout.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Gpio.GpioPin.DebounceTimeout --api-type: winrt property ---- # Windows.Devices.Gpio.GpioPin.DebounceTimeout ## -description Gets or sets the debounce timeout for the general-purpose I/O (GPIO) pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](gpiopin_valuechanged.md) events. ## -property-value The debounce timeout for the GPIO pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](gpiopin_valuechanged.md) events. If the length of this interval is 0, all changes to the value of the pin generate [ValueChanged](gpiopin_valuechanged.md) events. ## -remarks ## -examples ## -see-also [ValueChanged](gpiopin_valuechanged.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.GpioPin.DebounceTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioPin.DebounceTimeout + +## -description +Gets or sets the debounce timeout for the general-purpose I/O (GPIO) pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](gpiopin_valuechanged.md) events. + +## -property-value +The debounce timeout for the GPIO pin, which is an interval during which changes to the value of the pin are filtered out and do not generate [ValueChanged](gpiopin_valuechanged.md) events. If the length of this interval is 0, all changes to the value of the pin generate [ValueChanged](gpiopin_valuechanged.md) events. + +## -remarks + +## -examples + +## -see-also +[ValueChanged](gpiopin_valuechanged.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_getdrivemode_1456675415.md b/windows.devices.gpio/gpiopin_getdrivemode_1456675415.md index a8c275c2f9..d798f4ccf5 100644 --- a/windows.devices.gpio/gpiopin_getdrivemode_1456675415.md +++ b/windows.devices.gpio/gpiopin_getdrivemode_1456675415.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioPin.GetDriveMode --api-type: winrt method ---- # Windows.Devices.Gpio.GpioPin.GetDriveMode ## -description Gets the current drive mode for the general-purpose I/O (GPIO) pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. ## -returns An enumeration value that indicates the current drive mode for the GPIO pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. ## -remarks ## -examples ## -see-also [GpioPinDriveMode](gpiopindrivemode.md), [GpioPin.SetDriveMode](gpiopin_setdrivemode.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioPin.GetDriveMode +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioPin.GetDriveMode + +## -description +Gets the current drive mode for the general-purpose I/O (GPIO) pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. + +## -returns +An enumeration value that indicates the current drive mode for the GPIO pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. + +## -remarks + +## -examples + +## -see-also +[GpioPinDriveMode](gpiopindrivemode.md), [GpioPin.SetDriveMode](gpiopin_setdrivemode.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_isdrivemodesupported_1169156336.md b/windows.devices.gpio/gpiopin_isdrivemodesupported_1169156336.md index e6ae810685..70761d8b29 100644 --- a/windows.devices.gpio/gpiopin_isdrivemodesupported_1169156336.md +++ b/windows.devices.gpio/gpiopin_isdrivemodesupported_1169156336.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioPin.IsDriveModeSupported(Windows.Devices.Gpio.GpioPinDriveMode) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioPin.IsDriveModeSupported ## -description Gets whether the general-purpose I/O (GPIO) pin supports the specified drive mode. ## -parameters ### -param driveMode The drive mode that you want to check for support. ## -returns True if the GPIO pin supports the drive mode that *driveMode* specifies; otherwise false. If you specify a drive mode for which this method returns false when you call [SetDriveMode](gpiopin_setdrivemode.md), [SetDriveMode](gpiopin_setdrivemode.md) generates an exception. ## -remarks ## -examples ## -see-also [GpioPinDriveMode](gpiopindrivemode.md), [GetDriveMode](gpiopin_getdrivemode.md), [SetDriveMode](gpiopin_setdrivemode.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioPin.IsDriveModeSupported(Windows.Devices.Gpio.GpioPinDriveMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioPin.IsDriveModeSupported + +## -description +Gets whether the general-purpose I/O (GPIO) pin supports the specified drive mode. + +## -parameters +### -param driveMode +The drive mode that you want to check for support. + +## -returns +True if the GPIO pin supports the drive mode that *driveMode* specifies; otherwise false. If you specify a drive mode for which this method returns false when you call [SetDriveMode](gpiopin_setdrivemode.md), [SetDriveMode](gpiopin_setdrivemode.md) generates an exception. + +## -remarks + +## -examples + +## -see-also +[GpioPinDriveMode](gpiopindrivemode.md), [GetDriveMode](gpiopin_getdrivemode.md), [SetDriveMode](gpiopin_setdrivemode.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_pinnumber.md b/windows.devices.gpio/gpiopin_pinnumber.md index 8b38989db2..1b695147bd 100644 --- a/windows.devices.gpio/gpiopin_pinnumber.md +++ b/windows.devices.gpio/gpiopin_pinnumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Gpio.GpioPin.PinNumber --api-type: winrt property ---- # Windows.Devices.Gpio.GpioPin.PinNumber ## -description Gets the pin number of the general-purpose I/O (GPIO) pin. ## -property-value The pin number of the GPIO pin. ## -remarks ## -examples ## -see-also [GpioController.PinCount](gpiocontroller_pincount.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.GpioPin.PinNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioPin.PinNumber + +## -description +Gets the pin number of the general-purpose I/O (GPIO) pin. + +## -property-value +The pin number of the GPIO pin. + +## -remarks + +## -examples + +## -see-also +[GpioController.PinCount](gpiocontroller_pincount.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_read_431746835.md b/windows.devices.gpio/gpiopin_read_431746835.md index d190df78d0..d1b922772f 100644 --- a/windows.devices.gpio/gpiopin_read_431746835.md +++ b/windows.devices.gpio/gpiopin_read_431746835.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioPin.Read --api-type: winrt method ---- # Windows.Devices.Gpio.GpioPin.Read ## -description Reads the current value of the general-purpose I/O (GPIO) pin. ## -returns The current value of the GPIO pin. If the pin is configured as an output, this value is the last value written to the pin. ## -remarks ## -examples ## -see-also [GpioPinValue](gpiopinvalue.md), [GpioPin.Write](gpiopin_write.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioPin.Read +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioPin.Read + +## -description +Reads the current value of the general-purpose I/O (GPIO) pin. + +## -returns +The current value of the GPIO pin. If the pin is configured as an output, this value is the last value written to the pin. + +## -remarks + +## -examples + +## -see-also +[GpioPinValue](gpiopinvalue.md), [GpioPin.Write](gpiopin_write.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_setdrivemode_419000462.md b/windows.devices.gpio/gpiopin_setdrivemode_419000462.md index 1d9584120a..dd2792afb0 100644 --- a/windows.devices.gpio/gpiopin_setdrivemode_419000462.md +++ b/windows.devices.gpio/gpiopin_setdrivemode_419000462.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioPin.SetDriveMode(Windows.Devices.Gpio.GpioPinDriveMode) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioPin.SetDriveMode ## -description Sets the drive mode of the general-purpose I/O (GPIO) pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. ## -parameters ### -param value An enumeration value that specifies drive mode to use for the GPIO pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. ## -exceptions ### E_INVALIDARG The GPIO pin does not support the specified drive mode. ### E_ACCESSDENIED The pin is open in shared read-only mode. Close the pin and reopen it in exclusive mode to change the drive mode of the pin. ## -remarks ## -examples ## -see-also [GpioPinDriveMode](gpiopindrivemode.md), [GpioPin.GetDriveMode](gpiopin_getdrivemode.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioPin.SetDriveMode(Windows.Devices.Gpio.GpioPinDriveMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioPin.SetDriveMode + +## -description +Sets the drive mode of the general-purpose I/O (GPIO) pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. + +## -parameters +### -param value +An enumeration value that specifies drive mode to use for the GPIO pin. The drive mode specifies whether the pin is configured as an input or an output, and determines how values are driven onto the pin. + +## -exceptions +### E_INVALIDARG + +The GPIO pin does not support the specified drive mode. + +### E_ACCESSDENIED + +The pin is open in shared read-only mode. Close the pin and reopen it in exclusive mode to change the drive mode of the pin. + +## -remarks + +## -examples + +## -see-also +[GpioPinDriveMode](gpiopindrivemode.md), [GpioPin.GetDriveMode](gpiopin_getdrivemode.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_sharingmode.md b/windows.devices.gpio/gpiopin_sharingmode.md index 6a92a6f4bc..eb682fac67 100644 --- a/windows.devices.gpio/gpiopin_sharingmode.md +++ b/windows.devices.gpio/gpiopin_sharingmode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Gpio.GpioPin.SharingMode --api-type: winrt property ---- # Windows.Devices.Gpio.GpioPin.SharingMode ## -description Gets the sharing mode in which the general-purpose I/O (GPIO) pin is open. ## -property-value The sharing mode in which the GPIO pin is open. ## -remarks ## -examples ## -see-also [GpioSharingMode](gpiosharingmode.md), [GpioController.OpenPin](gpiocontroller_openpin.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.GpioPin.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioPin.SharingMode + +## -description +Gets the sharing mode in which the general-purpose I/O (GPIO) pin is open. + +## -property-value +The sharing mode in which the GPIO pin is open. + +## -remarks + +## -examples + +## -see-also +[GpioSharingMode](gpiosharingmode.md), [GpioController.OpenPin](gpiocontroller_openpin.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_valuechanged.md b/windows.devices.gpio/gpiopin_valuechanged.md index a9ff2c4ae3..e7f18f5faf 100644 --- a/windows.devices.gpio/gpiopin_valuechanged.md +++ b/windows.devices.gpio/gpiopin_valuechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Gpio.GpioPin.ValueChanged --api-type: winrt event ---- # Windows.Devices.Gpio.GpioPin.ValueChanged ## -description Occurs when the value of the general-purpose I/O (GPIO) pin changes, either because of an external stimulus when the pin is configured as an input, or when a value is written to the pin when the pin in configured as an output. ## -remarks ## -examples ## -see-also [GpioPinValueChangedEventArgs](gpiopinvaluechangedeventargs.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: E:Windows.Devices.Gpio.GpioPin.ValueChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Gpio.GpioPin.ValueChanged + +## -description +Occurs when the value of the general-purpose I/O (GPIO) pin changes, either because of an external stimulus when the pin is configured as an input, or when a value is written to the pin when the pin in configured as an output. + +## -remarks + +## -examples + +## -see-also +[GpioPinValueChangedEventArgs](gpiopinvaluechangedeventargs.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopin_write_1817827092.md b/windows.devices.gpio/gpiopin_write_1817827092.md index d93f42c409..afe47a6981 100644 --- a/windows.devices.gpio/gpiopin_write_1817827092.md +++ b/windows.devices.gpio/gpiopin_write_1817827092.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.Gpio.GpioPin.Write(Windows.Devices.Gpio.GpioPinValue) --api-type: winrt method ---- # Windows.Devices.Gpio.GpioPin.Write ## -description Drives the specified value onto the general purpose I/O (GPIO) pin according to the current drive mode for the pin if the pin is configured as an output, or updates the latched output value for the pin if the pin is configured as an input. ## -parameters ### -param value The enumeration value to write to the GPIO pin. If the GPIO pin is configured as an output, the method drives the specified value onto the pin according to the current drive mode for the pin. If the GPIO pin is configured as an input, the method updates the latched output value for the pin. The latched output value is driven onto the pin when the configuration for the pin changes to output. ## -exceptions ### E_ACCESSDENIED The GPIO pin is open in shared read-only mode. To write to the pin, close the pin and reopen the pin in exclusive mode. ## -remarks ## -examples ## -see-also [GpioPinValue](gpiopinvalue.md), [GpioPin.Read](gpiopin_read.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Gpio.GpioPin.Write(Windows.Devices.Gpio.GpioPinValue) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioPin.Write + +## -description +Drives the specified value onto the general purpose I/O (GPIO) pin according to the current drive mode for the pin if the pin is configured as an output, or updates the latched output value for the pin if the pin is configured as an input. + +## -parameters +### -param value +The enumeration value to write to the GPIO pin. + +If the GPIO pin is configured as an output, the method drives the specified value onto the pin according to the current drive mode for the pin. + +If the GPIO pin is configured as an input, the method updates the latched output value for the pin. The latched output value is driven onto the pin when the configuration for the pin changes to output. + +## -exceptions +### E_ACCESSDENIED + +The GPIO pin is open in shared read-only mode. To write to the pin, close the pin and reopen the pin in exclusive mode. + +## -remarks + +## -examples + +## -see-also +[GpioPinValue](gpiopinvalue.md), [GpioPin.Read](gpiopin_read.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.gpio/gpiopinvaluechangedeventargs.md b/windows.devices.gpio/gpiopinvaluechangedeventargs.md index 7be1ed6147..b1140ffa5b 100644 --- a/windows.devices.gpio/gpiopinvaluechangedeventargs.md +++ b/windows.devices.gpio/gpiopinvaluechangedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Gpio.GpioPinValueChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Gpio.GpioPinValueChangedEventArgs ## -description Provides data about the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event that occurs when the value of the general-purpose I/O (GPIO) pin changes, either because of an external stimulus when the pin is configured as an input, or when a value is written to the pin when the pin in configured as an output. ## -remarks [GpioPinValueChangedEventArgs](gpiopinvaluechangedeventargs.md) is passed to the event handler that you implement for the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event. ## -examples ## -see-also [GpioPin.ValueChanged](gpiopin_valuechanged.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Gpio.GpioPinValueChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Gpio.GpioPinValueChangedEventArgs + +## -description +Provides data about the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event that occurs when the value of the general-purpose I/O (GPIO) pin changes, either because of an external stimulus when the pin is configured as an input, or when a value is written to the pin when the pin in configured as an output. + +## -remarks +[GpioPinValueChangedEventArgs](gpiopinvaluechangedeventargs.md) is passed to the event handler that you implement for the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event. + +## -examples + +## -see-also +[GpioPin.ValueChanged](gpiopin_valuechanged.md) \ No newline at end of file diff --git a/windows.devices.gpio/gpiopinvaluechangedeventargs_edge.md b/windows.devices.gpio/gpiopinvaluechangedeventargs_edge.md index 2fbc0b784a..e8cbfa6b8d 100644 --- a/windows.devices.gpio/gpiopinvaluechangedeventargs_edge.md +++ b/windows.devices.gpio/gpiopinvaluechangedeventargs_edge.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Gpio.GpioPinValueChangedEventArgs.Edge --api-type: winrt property ---- # Windows.Devices.Gpio.GpioPinValueChangedEventArgs.Edge ## -description Gets the type of change that occurred to the value of the general-purpose I/O (GPIO) pin for the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event. ## -property-value An enumeration value that indicates the type of change that occurred to the value of the GPIO pin for the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event. ## -remarks ## -examples ## -see-also [GpioPin.ValueChanged](gpiopin_valuechanged.md), [GpioPinEdge](gpiopinedge.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Gpio.GpioPinValueChangedEventArgs.Edge +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioPinValueChangedEventArgs.Edge + +## -description +Gets the type of change that occurred to the value of the general-purpose I/O (GPIO) pin for the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event. + +## -property-value +An enumeration value that indicates the type of change that occurred to the value of the GPIO pin for the [GpioPin.ValueChanged](gpiopin_valuechanged.md) event. + +## -remarks + +## -examples + +## -see-also +[GpioPin.ValueChanged](gpiopin_valuechanged.md), [GpioPinEdge](gpiopinedge.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol.md b/windows.devices.humaninterfacedevice/hidbooleancontrol.md index 29ebe66c77..8155841249 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidBooleanControl --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControl ## -description Represents a simple Boolean control on a HID device that returns on/off values. An example would be the LED light on a keyboard. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidBooleanControl +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControl + +## -description +Represents a simple Boolean control on a HID device that returns on/off values. An example would be the LED light on a keyboard. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol_controldescription.md b/windows.devices.humaninterfacedevice/hidbooleancontrol_controldescription.md index c86cd9b944..a3f4ab8124 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol_controldescription.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol_controldescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.ControlDescription --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControl.ControlDescription ## -description Retrieves a description of the given Boolean control. ## -property-value A **HidBooleanControlDescription** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.ControlDescription +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControl.ControlDescription + +## -description +Retrieves a description of the given Boolean control. + +## -property-value +A **HidBooleanControlDescription** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol_id.md b/windows.devices.humaninterfacedevice/hidbooleancontrol_id.md index 275f574332..95182ac535 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol_id.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControl.Id ## -description Retrieves the identifier for a given Boolean control. ## -property-value The control identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControl.Id + +## -description +Retrieves the identifier for a given Boolean control. + +## -property-value +The control identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol_isactive.md b/windows.devices.humaninterfacedevice/hidbooleancontrol_isactive.md index 9dca7bc608..0e54b32cf8 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol_isactive.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol_isactive.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.IsActive --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControl.IsActive ## -description Retrieves a Boolean value indicating whether the given Boolean control is active. ## -property-value True if the control is active; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.IsActive +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControl.IsActive + +## -description +Retrieves a Boolean value indicating whether the given Boolean control is active. + +## -property-value +True if the control is active; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol_usageid.md b/windows.devices.humaninterfacedevice/hidbooleancontrol_usageid.md index e2c7ddc9c8..772a608266 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol_usageid.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol_usageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsageId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsageId ## -description Retrieves the usage identifier associated with the given Boolean control. ## -property-value The usage identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsageId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsageId + +## -description +Retrieves the usage identifier associated with the given Boolean control. + +## -property-value +The usage identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol_usagepage.md b/windows.devices.humaninterfacedevice/hidbooleancontrol_usagepage.md index 73484bd4c9..1e134cb4ed 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol_usagepage.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol_usagepage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsagePage --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsagePage ## -description Retrieves the usage page for a given Boolean control. ## -property-value The usage page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsagePage +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControl.UsagePage + +## -description +Retrieves the usage page for a given Boolean control. + +## -property-value +The usage page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md index 591a07ea43..e52d539b45 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription ## -description Describes a Boolean control for a given HID device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription + +## -description +Describes a Boolean control for a given HID device. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_id.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_id.md index 98de7609c2..2aced30eb5 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_id.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.Id ## -description Retrieves the identifier for a given Boolean control. ## -property-value The control identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.Id + +## -description +Retrieves the identifier for a given Boolean control. + +## -property-value +The control identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_isabsolute.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_isabsolute.md index 05167044ee..67400612ba 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_isabsolute.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_isabsolute.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.IsAbsolute --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.IsAbsolute ## -description Gets a value indicating whether the given boolean control values are absolute or relative. ## -property-value True if the values are absolute; false if the values are relative. ## -remarks This property is useful when an app provides similar functionality as the system and needs to keep the corresponding in-app control synchronized with the system setting. For example, an in-app (relative) mute button that doesn't affect the system volume, but which must correspond to any changes made to the system setting (absolute). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.IsAbsolute +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.IsAbsolute + +## -description +Gets a value indicating whether the given boolean control values are absolute or relative. + +## -property-value +True if the values are absolute; false if the values are relative. + +## -remarks +This property is useful when an app provides similar functionality as the system and needs to keep the corresponding in-app control synchronized with the system setting. For example, an in-app (relative) mute button that doesn't affect the system volume, but which must correspond to any changes made to the system setting (absolute). + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_parentcollections.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_parentcollections.md index c715c66dbd..db30c3b8c6 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_parentcollections.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_parentcollections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ParentCollections --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ParentCollections ## -description Retrieves the parent collection for a given Boolean control. ## -property-value The control's parent collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ParentCollections +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ParentCollections + +## -description +Retrieves the parent collection for a given Boolean control. + +## -property-value +The control's parent collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reportid.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reportid.md index 706f9eb99e..8aa7d85bc1 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reportid.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reportid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportId ## -description Retrieves the identifier for the report associated with the given Boolean control. ## -property-value The report identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportId + +## -description +Retrieves the identifier for the report associated with the given Boolean control. + +## -property-value +The report identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reporttype.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reporttype.md index 0ee50920c1..735c7359b7 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reporttype.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_reporttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportType --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportType ## -description Retrieves the report type for the report associated with the given Boolean control. ## -property-value The report type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportType +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.ReportType + +## -description +Retrieves the report type for the report associated with the given Boolean control. + +## -property-value +The report type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usageid.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usageid.md index df0a00e3d0..0217c38d8c 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usageid.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsageId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsageId ## -description Retrieves the usage identifier associated with the given Boolean control. ## -property-value The usage identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsageId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsageId + +## -description +Retrieves the usage identifier associated with the given Boolean control. + +## -property-value +The usage identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usagepage.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usagepage.md index 57bbce4499..fd45ab53e3 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usagepage.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription_usagepage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsagePage --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsagePage ## -description Retrieves the usage page associated with the given Boolean control. ## -property-value The usage page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsagePage +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription.UsagePage + +## -description +Retrieves the usage page associated with the given Boolean control. + +## -property-value +The usage page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidcollection.md b/windows.devices.humaninterfacedevice/hidcollection.md index 846fa3a317..d26d09d4ef 100644 --- a/windows.devices.humaninterfacedevice/hidcollection.md +++ b/windows.devices.humaninterfacedevice/hidcollection.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidCollection --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidCollection ## -description Retrieves the collection information for a group of related controls. The HID protocol uses collections to group a set of controls that are similar to one another, or, are related by physical or operational proximity. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidCollection +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidCollection + +## -description +Retrieves the collection information for a group of related controls. + +The HID protocol uses collections to group a set of controls that are similar to one another, or, are related by physical or operational proximity. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidcollection_id.md b/windows.devices.humaninterfacedevice/hidcollection_id.md index 49d207af5e..90a1eb0fcb 100644 --- a/windows.devices.humaninterfacedevice/hidcollection_id.md +++ b/windows.devices.humaninterfacedevice/hidcollection_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidCollection.Id ## -description Retrieves the identifier for a collection of HID controls. ## -property-value The collection identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidCollection.Id + +## -description +Retrieves the identifier for a collection of HID controls. + +## -property-value +The collection identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidcollection_type.md b/windows.devices.humaninterfacedevice/hidcollection_type.md index b2c6f41bd7..d8874b57ce 100644 --- a/windows.devices.humaninterfacedevice/hidcollection_type.md +++ b/windows.devices.humaninterfacedevice/hidcollection_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.Type --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidCollection.Type ## -description Retrieves the collection type. ## -property-value A **HidCollectionType** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.Type +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidCollection.Type + +## -description +Retrieves the collection type. + +## -property-value +A **HidCollectionType** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidcollection_usageid.md b/windows.devices.humaninterfacedevice/hidcollection_usageid.md index 6278caacaa..2a566380f1 100644 --- a/windows.devices.humaninterfacedevice/hidcollection_usageid.md +++ b/windows.devices.humaninterfacedevice/hidcollection_usageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.UsageId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidCollection.UsageId ## -description Retrieves the usage identifier for the given control collection. ## -property-value The usage identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.UsageId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidCollection.UsageId + +## -description +Retrieves the usage identifier for the given control collection. + +## -property-value +The usage identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidcollection_usagepage.md b/windows.devices.humaninterfacedevice/hidcollection_usagepage.md index 214abe0e03..814ddf3a11 100644 --- a/windows.devices.humaninterfacedevice/hidcollection_usagepage.md +++ b/windows.devices.humaninterfacedevice/hidcollection_usagepage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.UsagePage --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidCollection.UsagePage ## -description Retrieves the usage page for the given control collection. ## -property-value The usage page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidCollection.UsagePage +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidCollection.UsagePage + +## -description +Retrieves the usage page for the given control collection. + +## -property-value +The usage page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice.md b/windows.devices.humaninterfacedevice/hiddevice.md index b00595c4c8..69b4849608 100644 --- a/windows.devices.humaninterfacedevice/hiddevice.md +++ b/windows.devices.humaninterfacedevice/hiddevice.md @@ -1,3 +1,81 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidDevice --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidDevice ## -description Represents a top-level collection and the corresponding device. ## -remarks The following example demonstrates how a Windows Store app built with XAML and C# uses the **GetDeviceSelector** method to create a selector for a specific HID device and then uses** FromIdAsync** method to open a connection to that device. ```css using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Windows.Devices.Enumeration; using Windows.Devices.HumanInterfaceDevice; using Windows.Storage; using Windows.Storage.Streams; namespace HidSampleCS { class Enumeration { // Enumerate HID devices private async void EnumerateHidDevices() { UInt32 vendorId = 0x045E; UInt32 productId = 0x078F; UInt32 usagePage = 0xFF00; UInt32 usageId = 0x0001; // Create a selector that gets a HID device using VID/PID and a // VendorDefined usage string selector = HidDevice.GetDeviceSelector(usagePage, usageId, vendorId, productId); // Enumerate devices using the selector var devices = await DeviceInformation.FindAllAsync(selector); if (devices.Count > 0) { // Open the target HID device HidDevice device = await HidDevice.FromIdAsync(devices.ElementAt(0).Id, FileAccessMode.ReadWrite); // At this point the device is available to communicate with // So we can send/receive HID reports from it or // query it for control descriptions } else { // There were no HID devices that met the selector criteria this.NotifyUser("MUTT HID device not found"); } } } } ``` ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidDevice +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice + +## -description +Represents a top-level collection and the corresponding device. + +## -remarks +The following example demonstrates how a Windows Store app built with XAML and C# uses the **GetDeviceSelector** method to create a selector for a specific HID device and then uses** FromIdAsync** method to open a connection to that device. + + + + + +```css +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +using Windows.Devices.Enumeration; +using Windows.Devices.HumanInterfaceDevice; +using Windows.Storage; +using Windows.Storage.Streams; + +namespace HidSampleCS +{ + class Enumeration + { + // Enumerate HID devices + private async void EnumerateHidDevices() + { + UInt32 vendorId = 0x045E; + UInt32 productId = 0x078F; + UInt32 usagePage = 0xFF00; + UInt32 usageId = 0x0001; + + // Create a selector that gets a HID device using VID/PID and a + // VendorDefined usage + string selector = HidDevice.GetDeviceSelector(usagePage, usageId, + vendorId, productId); + + // Enumerate devices using the selector + var devices = await DeviceInformation.FindAllAsync(selector); + + if (devices.Count > 0) + { + // Open the target HID device + HidDevice device = await HidDevice.FromIdAsync(devices.ElementAt(0).Id, + FileAccessMode.ReadWrite); + + // At this point the device is available to communicate with + // So we can send/receive HID reports from it or + // query it for control descriptions + } + else + { + // There were no HID devices that met the selector criteria + this.NotifyUser("MUTT HID device not found"); + } + } + } +} + + +``` + + + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_close_811482585.md b/windows.devices.humaninterfacedevice/hiddevice_close_811482585.md index 3b25c05098..7f0b13c634 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_close_811482585.md +++ b/windows.devices.humaninterfacedevice/hiddevice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.Close --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.Close ## -description Closes the connection between the host and the given HID device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.Close + +## -description +Closes the connection between the host and the given HID device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_1887738354.md b/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_1887738354.md index d02568d453..97db35a789 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_1887738354.md +++ b/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_1887738354.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport ## -description Creates the only, or default, feature report that the host will send to the device. ## -returns A **HidFeatureReport** object. ## -remarks ## -examples ## -see-also [CreateFeatureReport(UInt16)](hiddevice_createfeaturereport_498407181.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport + +## -description +Creates the only, or default, feature report that the host will send to the device. + +## -returns +A **HidFeatureReport** object. + +## -remarks + +## -examples + +## -see-also +[CreateFeatureReport(UInt16)](hiddevice_createfeaturereport_498407181.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_498407181.md b/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_498407181.md index 741d303811..2f9d5fe151 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_498407181.md +++ b/windows.devices.humaninterfacedevice/hiddevice_createfeaturereport_498407181.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport(System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport ## -description Creates a feature report, identified by the *reportId* parameter, that the host will send to the device. ## -parameters ### -param reportId Identifies the report being created. ## -returns A **HidFeatureReport** object. ## -remarks ## -examples ## -see-also [CreateFeatureReport](hiddevice_createfeaturereport_1887738354.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.CreateFeatureReport + +## -description +Creates a feature report, identified by the *reportId* parameter, that the host will send to the device. + +## -parameters +### -param reportId +Identifies the report being created. + +## -returns +A **HidFeatureReport** object. + +## -remarks + +## -examples + +## -see-also +[CreateFeatureReport](hiddevice_createfeaturereport_1887738354.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_1734227882.md b/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_1734227882.md index 85546d3b08..068323d9ec 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_1734227882.md +++ b/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_1734227882.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport ## -description Creates the only, or default, output report that the host will send to the device. ## -returns A **HidOutputReport** object. ## -remarks ## -examples ## -see-also [CreateOutputReport(UInt16)](hiddevice_createoutputreport_175094101.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport + +## -description +Creates the only, or default, output report that the host will send to the device. + +## -returns +A **HidOutputReport** object. + +## -remarks + +## -examples + +## -see-also +[CreateOutputReport(UInt16)](hiddevice_createoutputreport_175094101.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_175094101.md b/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_175094101.md index 4645f68ed4..b7e32b4292 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_175094101.md +++ b/windows.devices.humaninterfacedevice/hiddevice_createoutputreport_175094101.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport(System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport ## -description Creates an output report, identified by the *reportId* parameter, that the host will send to the device. ## -parameters ### -param reportId Identifies the report being created. ## -returns A **HidOutputReport** object. ## -remarks ## -examples ## -see-also [CreateOutputReport](hiddevice_createoutputreport_1734227882.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.CreateOutputReport + +## -description +Creates an output report, identified by the *reportId* parameter, that the host will send to the device. + +## -parameters +### -param reportId +Identifies the report being created. + +## -returns +A **HidOutputReport** object. + +## -remarks + +## -examples + +## -see-also +[CreateOutputReport](hiddevice_createoutputreport_1734227882.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_fromidasync_1634380010.md b/windows.devices.humaninterfacedevice/hiddevice_fromidasync_1634380010.md index 3b7054b006..f15443def1 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_fromidasync_1634380010.md +++ b/windows.devices.humaninterfacedevice/hiddevice_fromidasync_1634380010.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.FromIdAsync(System.String,Windows.Storage.FileAccessMode) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.FromIdAsync ## -description Opens a handle to the device identified by the *deviceId* parameter. The access type is specified by the *accessMode* parameter. ## -parameters ### -param deviceId The [DeviceInformation]( http://go.microsoft.com/fwlink/p/?LinkID=296709) ID that identifies the HID device. ### -param accessMode Specifies the access mode. The supported access modes are Read and ReadWrite. ## -returns A **HidDevice** object. ## -remarks The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread. The manifest for your app must declare a specific HID device capability before you invoke this method; and, this capability must map to the capabilities of the target device. If there is no declaration in the manifest, or, if the declaration specifies a device not supported by the HID API, this method fails with an error of E_ACCESSDENIED. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.FromIdAsync(System.String,Windows.Storage.FileAccessMode) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.FromIdAsync + +## -description +Opens a handle to the device identified by the *deviceId* parameter. The access type is specified by the *accessMode* parameter. + +## -parameters +### -param deviceId +The [DeviceInformation]( http://go.microsoft.com/fwlink/p/?LinkID=296709) ID that identifies the HID device. + +### -param accessMode +Specifies the access mode. The supported access modes are Read and ReadWrite. + +## -returns +A **HidDevice** object. + +## -remarks +The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread. + +The manifest for your app must declare a specific HID device capability before you invoke this method; and, this capability must map to the capabilities of the target device. + +If there is no declaration in the manifest, or, if the declaration specifies a device not supported by the HID API, this method fails with an error of E_ACCESSDENIED. + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_getbooleancontroldescriptions_378829625.md b/windows.devices.humaninterfacedevice/hiddevice_getbooleancontroldescriptions_378829625.md index 86903fb26d..0ed0ba9e50 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getbooleancontroldescriptions_378829625.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getbooleancontroldescriptions_378829625.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetBooleanControlDescriptions(Windows.Devices.HumanInterfaceDevice.HidReportType,System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetBooleanControlDescriptions ## -description Retrieves the descriptions of the boolean controls for the given HID device. ## -parameters ### -param reportType Specifies the type of report for which the control descriptions are requested. ### -param usagePage Identifies the usage page associated with the controls. ### -param usageId Identifies the usage associated with the controls. ## -returns A vector of **HidBooleanControlDescription** objects. ## -remarks Boolean controls are simple controls that return On/Off values. (They are sometimes referred to as button controls.) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetBooleanControlDescriptions(Windows.Devices.HumanInterfaceDevice.HidReportType,System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetBooleanControlDescriptions + +## -description +Retrieves the descriptions of the boolean controls for the given HID device. + +## -parameters +### -param reportType +Specifies the type of report for which the control descriptions are requested. + +### -param usagePage +Identifies the usage page associated with the controls. + +### -param usageId +Identifies the usage associated with the controls. + +## -returns +A vector of **HidBooleanControlDescription** objects. + +## -remarks +Boolean controls are simple controls that return On/Off values. (They are sometimes referred to as button controls.) + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_1541481733.md b/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_1541481733.md index d056e60fbb..f639b829b0 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_1541481733.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_1541481733.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector(System.UInt16,System.UInt16,System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector ## -description Retrieves an Advanced Query Syntax (AQS) string based on the given *usagePage*, *usageId*, *vendorId*, and *productId*. ## -parameters ### -param usagePage Specifies the usage page of the top-level collection for the given HID device. ### -param usageId Specifies the usage identifier of the top-level collection for the given HID device. ### -param vendorId Identifies the device vendor. ### -param productId Identifies the product. ## -returns An Advanced Query Syntax (AQS) string that represents a device selector. ## -remarks ## -examples ## -see-also [GetDeviceSelector(UInt16, UInt16)](hiddevice_getdeviceselector_2035586791.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector(System.UInt16,System.UInt16,System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string based on the given *usagePage*, *usageId*, *vendorId*, and *productId*. + +## -parameters +### -param usagePage +Specifies the usage page of the top-level collection for the given HID device. + +### -param usageId +Specifies the usage identifier of the top-level collection for the given HID device. + +### -param vendorId +Identifies the device vendor. + +### -param productId +Identifies the product. + +## -returns +An Advanced Query Syntax (AQS) string that represents a device selector. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(UInt16, UInt16)](hiddevice_getdeviceselector_2035586791.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_2035586791.md b/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_2035586791.md index 375900e3f6..fbf01c428c 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_2035586791.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getdeviceselector_2035586791.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector ## -description Retrieves an Advanced Query Syntax (AQS) string based on the given *usagePage* and *usageId*. ## -parameters ### -param usagePage Specifies the usage page of the top-level collection for the given HID device. ### -param usageId Specifies the usage identifier of the top-level collection for the given HID device. ## -returns An Advanced Query Syntax (AQS) string that represents a device selector. ## -remarks ## -examples ## -see-also [GetDeviceSelector(UInt16, UInt16, UInt16, UInt16)](hiddevice_getdeviceselector_1541481733.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string based on the given *usagePage* and *usageId*. + +## -parameters +### -param usagePage +Specifies the usage page of the top-level collection for the given HID device. + +### -param usageId +Specifies the usage identifier of the top-level collection for the given HID device. + +## -returns +An Advanced Query Syntax (AQS) string that represents a device selector. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(UInt16, UInt16, UInt16, UInt16)](hiddevice_getdeviceselector_1541481733.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_1194285243.md b/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_1194285243.md index 8a36631020..5cfeb62a1d 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_1194285243.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_1194285243.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync(System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync ## -description Asynchronously retrieves a feature report, identified by the *reportId* parameter, for the given HID device. ## -parameters ### -param reportId Identifies the requested feature report. ## -returns A **HidFeatureReport** object. ## -remarks ## -examples ## -see-also [GetFeatureReportAsync](hiddevice_getfeaturereportasync_706664006.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync + +## -description +Asynchronously retrieves a feature report, identified by the *reportId* parameter, for the given HID device. + +## -parameters +### -param reportId +Identifies the requested feature report. + +## -returns +A **HidFeatureReport** object. + +## -remarks + +## -examples + +## -see-also +[GetFeatureReportAsync](hiddevice_getfeaturereportasync_706664006.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_706664006.md b/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_706664006.md index b31fbdb52b..11bfdef6ba 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_706664006.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getfeaturereportasync_706664006.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync ## -description Asynchronously retrieves the first, or default, feature report from the given HID device. ## -returns A **HidFeatureReport** object. ## -remarks This instance of the method retrieves the first available feature report. ## -examples ## -see-also [GetFeatureReportAsync(UInt16)](hiddevice_getfeaturereportasync_1194285243.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetFeatureReportAsync + +## -description +Asynchronously retrieves the first, or default, feature report from the given HID device. + +## -returns +A **HidFeatureReport** object. + +## -remarks +This instance of the method retrieves the first available feature report. + +## -examples + +## -see-also +[GetFeatureReportAsync(UInt16)](hiddevice_getfeaturereportasync_1194285243.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_2092816092.md b/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_2092816092.md index 4963ee7eeb..fcb358e2a0 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_2092816092.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_2092816092.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync ## -description Asynchronously retrieves the default, or first, input report from the given HID device. ## -returns A **HidInputReport** object. ## -remarks This instance of the method retrieves an input report. ## -examples ## -see-also [GetInputReportAsync(UInt16)](hiddevice_getinputreportasync_294410273.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync + +## -description +Asynchronously retrieves the default, or first, input report from the given HID device. + +## -returns +A **HidInputReport** object. + +## -remarks +This instance of the method retrieves an input report. + +## -examples + +## -see-also +[GetInputReportAsync(UInt16)](hiddevice_getinputreportasync_294410273.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_294410273.md b/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_294410273.md index e72efadcda..86fb9f3f9c 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_294410273.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getinputreportasync_294410273.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync(System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync ## -description Asynchronously retrieves an input report, identified by the *reportId* parameter, from the given HID device. ## -parameters ### -param reportId Identifies the requested input report. ## -returns A **HidInputReport** object. ## -remarks ## -examples ## -see-also [GetInputReportAsync](hiddevice_getinputreportasync_2092816092.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetInputReportAsync + +## -description +Asynchronously retrieves an input report, identified by the *reportId* parameter, from the given HID device. + +## -parameters +### -param reportId +Identifies the requested input report. + +## -returns +A **HidInputReport** object. + +## -remarks + +## -examples + +## -see-also +[GetInputReportAsync](hiddevice_getinputreportasync_2092816092.md) \ No newline at end of file diff --git a/windows.devices.humaninterfacedevice/hiddevice_getnumericcontroldescriptions_934374739.md b/windows.devices.humaninterfacedevice/hiddevice_getnumericcontroldescriptions_934374739.md index 3582fd66c3..c768680a1c 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_getnumericcontroldescriptions_934374739.md +++ b/windows.devices.humaninterfacedevice/hiddevice_getnumericcontroldescriptions_934374739.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetNumericControlDescriptions(Windows.Devices.HumanInterfaceDevice.HidReportType,System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.GetNumericControlDescriptions ## -description Retrieves the descriptions of the numeric controls for the given HID device. ## -parameters ### -param reportType Specifies the type of report for which the control descriptions are requested. ### -param usagePage Identifies the usage page associated with the controls. ### -param usageId Identifies the usage associated with the controls. ## -returns A vector of **HidNumericControlDescription** objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.GetNumericControlDescriptions(Windows.Devices.HumanInterfaceDevice.HidReportType,System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.GetNumericControlDescriptions + +## -description +Retrieves the descriptions of the numeric controls for the given HID device. + +## -parameters +### -param reportType +Specifies the type of report for which the control descriptions are requested. + +### -param usagePage +Identifies the usage page associated with the controls. + +### -param usageId +Identifies the usage associated with the controls. + +## -returns +A vector of **HidNumericControlDescription** objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_inputreportreceived.md b/windows.devices.humaninterfacedevice/hiddevice_inputreportreceived.md index f573b560fb..173cdba980 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_inputreportreceived.md +++ b/windows.devices.humaninterfacedevice/hiddevice_inputreportreceived.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Devices.HumanInterfaceDevice.HidDevice.InputReportReceived --api-type: winrt event ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.InputReportReceived ## -description Establishes an event listener which handles input reports issued by the device. ## -remarks This method waits for the device to interrupt the host when it has data to send. Internally, the HID WinRT API sends a IOCTL read request to a lower driver in the stack. The IOCTL is translated by the HID minidriver into a protocol-specific request. For a USB device, the minidriver translates this into an INTERRUPT IN request. And, for an I2C device that is running over the Microsoft HID-I2C miniport driver, the minidriver will wait for the device to assert an interrupt. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.HumanInterfaceDevice.HidDevice.InputReportReceived +-api-type: winrt event +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.InputReportReceived + +## -description +Establishes an event listener which handles input reports issued by the device. + +## -remarks +This method waits for the device to interrupt the host when it has data to send. Internally, the HID WinRT API sends a IOCTL read request to a lower driver in the stack. + +The IOCTL is translated by the HID minidriver into a protocol-specific request. For a USB device, the minidriver translates this into an INTERRUPT IN request. And, for an I2C device that is running over the Microsoft HID-I2C miniport driver, the minidriver will wait for the device to assert an interrupt. + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_productid.md b/windows.devices.humaninterfacedevice/hiddevice_productid.md index aeee4fa2ad..e9a1b7fbd5 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_productid.md +++ b/windows.devices.humaninterfacedevice/hiddevice_productid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.ProductId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.ProductId ## -description Gets the product identifier for the given HID device. ## -property-value The product identifier. ## -remarks Valid values are 0 through 0xFFFF. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.ProductId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.ProductId + +## -description +Gets the product identifier for the given HID device. + +## -property-value +The product identifier. + +## -remarks +Valid values are 0 through 0xFFFF. + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_sendfeaturereportasync_25126117.md b/windows.devices.humaninterfacedevice/hiddevice_sendfeaturereportasync_25126117.md index 9989070a5b..0d445e9bde 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_sendfeaturereportasync_25126117.md +++ b/windows.devices.humaninterfacedevice/hiddevice_sendfeaturereportasync_25126117.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.SendFeatureReportAsync(Windows.Devices.HumanInterfaceDevice.HidFeatureReport) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.SendFeatureReportAsync ## -description Sends an feature report asynchronously from the host to the device. ## -parameters ### -param featureReport The feature report which the host sends to the device. ## -returns The result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.SendFeatureReportAsync(Windows.Devices.HumanInterfaceDevice.HidFeatureReport) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.SendFeatureReportAsync + +## -description +Sends an feature report asynchronously from the host to the device. + +## -parameters +### -param featureReport +The feature report which the host sends to the device. + +## -returns +The result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_sendoutputreportasync_1405795481.md b/windows.devices.humaninterfacedevice/hiddevice_sendoutputreportasync_1405795481.md index 40979fc3a0..440dbb97cf 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_sendoutputreportasync_1405795481.md +++ b/windows.devices.humaninterfacedevice/hiddevice_sendoutputreportasync_1405795481.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.SendOutputReportAsync(Windows.Devices.HumanInterfaceDevice.HidOutputReport) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.SendOutputReportAsync ## -description Sends an output report asynchronously from the host to the device. ## -parameters ### -param outputReport The output report which the host sends to the device. ## -returns Specifies the count of bytes written to the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidDevice.SendOutputReportAsync(Windows.Devices.HumanInterfaceDevice.HidOutputReport) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.SendOutputReportAsync + +## -description +Sends an output report asynchronously from the host to the device. + +## -parameters +### -param outputReport +The output report which the host sends to the device. + +## -returns +Specifies the count of bytes written to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_usageid.md b/windows.devices.humaninterfacedevice/hiddevice_usageid.md index 96cf9908fe..1eebdf5222 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_usageid.md +++ b/windows.devices.humaninterfacedevice/hiddevice_usageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.UsageId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.UsageId ## -description Gets the usage identifier for the given HID device. ## -property-value The usage identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.UsageId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.UsageId + +## -description +Gets the usage identifier for the given HID device. + +## -property-value +The usage identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_usagepage.md b/windows.devices.humaninterfacedevice/hiddevice_usagepage.md index e24a8b6835..1db9d82df2 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_usagepage.md +++ b/windows.devices.humaninterfacedevice/hiddevice_usagepage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.UsagePage --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.UsagePage ## -description Gets the usage page of the top-level collection. ## -property-value The usage page. ## -remarks The **UsagePage** of the top-level collection is retrieved from the HID report descriptor. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.UsagePage +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.UsagePage + +## -description +Gets the usage page of the top-level collection. + +## -property-value +The usage page. + +## -remarks +The **UsagePage** of the top-level collection is retrieved from the HID report descriptor. + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_vendorid.md b/windows.devices.humaninterfacedevice/hiddevice_vendorid.md index 6301ba4113..f982689e31 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_vendorid.md +++ b/windows.devices.humaninterfacedevice/hiddevice_vendorid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.VendorId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.VendorId ## -description Gets the vendor identifier for the given HID device. ## -property-value The vendor identifier. ## -remarks Valid values are 0 through 0xFFFF. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.VendorId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.VendorId + +## -description +Gets the vendor identifier for the given HID device. + +## -property-value +The vendor identifier. + +## -remarks +Valid values are 0 through 0xFFFF. + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hiddevice_version.md b/windows.devices.humaninterfacedevice/hiddevice_version.md index 47398c3d4a..96c3efee02 100644 --- a/windows.devices.humaninterfacedevice/hiddevice_version.md +++ b/windows.devices.humaninterfacedevice/hiddevice_version.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.Version --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidDevice.Version ## -description Gets the version, or revision, number for the given HID device. ## -property-value The version number. ## -remarks The version is retrieved from the device descriptor. Valid values are 0 through 0xFFFF. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidDevice.Version +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidDevice.Version + +## -description +Gets the version, or revision, number for the given HID device. + +## -property-value +The version number. + +## -remarks +The version is retrieved from the device descriptor. + +Valid values are 0 through 0xFFFF. + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport.md b/windows.devices.humaninterfacedevice/hidfeaturereport.md index 68d095426a..b877145186 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidFeatureReport --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport ## -description Represents a feature report. Feature reports are issued by both the device and the host. Devices issue feature reports to describe their capabilities and default settings to a host. Hosts issue feature reports to make requests of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidFeatureReport +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport + +## -description +Represents a feature report. + +Feature reports are issued by both the device and the host. Devices issue feature reports to describe their capabilities and default settings to a host. Hosts issue feature reports to make requests of the device. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport_data.md b/windows.devices.humaninterfacedevice/hidfeaturereport_data.md index 360e22dffe..7058d77dce 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport_data.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Data --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Data ## -description Retrieves, or sets, the data associated with a given feature report. ## -property-value The feature-report data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Data +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Data + +## -description +Retrieves, or sets, the data associated with a given feature report. + +## -property-value +The feature-report data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrol_1611601713.md b/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrol_1611601713.md index 173978d12d..384358d19c 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrol_1611601713.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrol_1611601713.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControl(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControl ## -description Retrieves the Boolean control associated with the usagePage and *usageId* parameter and found in the given feature report. ## -parameters ### -param usagePage The usage page of the top-level collection for the given HID device. ### -param usageId The usage identifier of the top-level collection for the given HID device. ## -returns A **HidBooleanControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControl(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControl + +## -description +Retrieves the Boolean control associated with the usagePage and *usageId* parameter and found in the given feature report. + +## -parameters +### -param usagePage +The usage page of the top-level collection for the given HID device. + +### -param usageId +The usage identifier of the top-level collection for the given HID device. + +## -returns +A **HidBooleanControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrolbydescription_12392263.md b/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrolbydescription_12392263.md index ec7d5ab652..e0a55f5f14 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrolbydescription_12392263.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport_getbooleancontrolbydescription_12392263.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControlByDescription(Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControlByDescription ## -description Retrieves the Boolean control described by the *controlDescription* parameter and found in the given feature report. ## -parameters ### -param controlDescription A **HidBooleanControlDescription** object. ## -returns A **HidBooleanControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControlByDescription(Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetBooleanControlByDescription + +## -description +Retrieves the Boolean control described by the *controlDescription* parameter and found in the given feature report. + +## -parameters +### -param controlDescription +A **HidBooleanControlDescription** object. + +## -returns +A **HidBooleanControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrol_2120528126.md b/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrol_2120528126.md index 722d203c1d..b1d33117aa 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrol_2120528126.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrol_2120528126.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControl(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControl ## -description Retrieves the numeric control associated with the *usagePage* and *usageId* parameters and found in the given feature report. ## -parameters ### -param usagePage The usage page of the top-level collection for the given HID device. ### -param usageId The usage identifier of the top-level collection for the given HID device. ## -returns A **HidNumericControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControl(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControl + +## -description +Retrieves the numeric control associated with the *usagePage* and *usageId* parameters and found in the given feature report. + +## -parameters +### -param usagePage +The usage page of the top-level collection for the given HID device. + +### -param usageId +The usage identifier of the top-level collection for the given HID device. + +## -returns +A **HidNumericControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrolbydescription_1317493064.md b/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrolbydescription_1317493064.md index a622e10f6f..a60080a3cd 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrolbydescription_1317493064.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport_getnumericcontrolbydescription_1317493064.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControlByDescription(Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControlByDescription ## -description Retrieves the numeric control described by the *controlDescription* parameter and found in the given feature report. ## -parameters ### -param controlDescription A **HidNumericControlDescription** object. ## -returns A **HidNumericControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControlByDescription(Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport.GetNumericControlByDescription + +## -description +Retrieves the numeric control described by the *controlDescription* parameter and found in the given feature report. + +## -parameters +### -param controlDescription +A **HidNumericControlDescription** object. + +## -returns +A **HidNumericControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport_id.md b/windows.devices.humaninterfacedevice/hidfeaturereport_id.md index dd91fbd826..ddc04e6dca 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport_id.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Id ## -description Retrieves the identifier associated with a given feature report. ## -property-value The feature report identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidFeatureReport.Id + +## -description +Retrieves the identifier associated with a given feature report. + +## -property-value +The feature report identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport.md b/windows.devices.humaninterfacedevice/hidinputreport.md index 978ec9cce7..b5f167b897 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport.md +++ b/windows.devices.humaninterfacedevice/hidinputreport.md @@ -1,3 +1,91 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidInputReport --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport ## -description Represents an input report. Devices issue input reports to describe state changes, user-input, and other device-specific data. For example, a HID keyboard device would use an input report to signal a key press. A HID presence-sensor would use an input report to signal a presence detection event. ## -remarks The following example demonstrates how a Windows Store app built with XAML and C# uses the **GetInputReportAsync** method to obtain an input report. ```css using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Windows.Devices.Enumeration; using Windows.Devices.HumanInterfaceDevice; using Windows.Storage; using Windows.Storage.Streams; namespace HidSampleCS { class Vendor { private async void ReadWriteToHidDevice(HidDevice device) { if (device != null) { // construct a HID output report to send to the device HidOutputReport outReport = device.CreateOutputReport(); /// Initialize the data buffer and fill it in byte[] buffer = new byte[] { 10, 20, 30, 40 }; DataWriter dataWriter = new DataWriter(); dataWriter.WriteBytes(buffer); outReport.Data = dataWriter.DetachBuffer(); // Send the output report asynchronously await device.SendOutputReportAsync(outReport); // // Sent output report successfully // Now lets try read an input report // HidInputReport inReport = await device.GetInputReportAsync(); if (inReport != null) { UInt16 id = inReport.Id; var bytes = new byte[4]; DataReader dataReader = DataReader.FromBuffer(inReport.Data); dataReader.ReadBytes(bytes); } else { this.NotifyUser("Invalid input report received"); } } else { this.NotifyUser("device is NULL"); } } } } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidInputReport +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport + +## -description +Represents an input report. + +Devices issue input reports to describe state changes, user-input, and other device-specific data. For example, a HID keyboard device would use an input report to signal a key press. A HID presence-sensor would use an input report to signal a presence detection event. + +## -remarks +The following example demonstrates how a Windows Store app built with XAML and C# uses the **GetInputReportAsync** method to obtain an input report. + + + + + +```css +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +using Windows.Devices.Enumeration; +using Windows.Devices.HumanInterfaceDevice; +using Windows.Storage; +using Windows.Storage.Streams; + +namespace HidSampleCS +{ + class Vendor + { + private async void ReadWriteToHidDevice(HidDevice device) + { + if (device != null) + { + // construct a HID output report to send to the device + HidOutputReport outReport = device.CreateOutputReport(); + + /// Initialize the data buffer and fill it in + byte[] buffer = new byte[] { 10, 20, 30, 40 }; + + DataWriter dataWriter = new DataWriter(); + dataWriter.WriteBytes(buffer); + + outReport.Data = dataWriter.DetachBuffer(); + + // Send the output report asynchronously + await device.SendOutputReportAsync(outReport); + + // + // Sent output report successfully + // Now lets try read an input report + // + HidInputReport inReport = await device.GetInputReportAsync(); + + if (inReport != null) + { + UInt16 id = inReport.Id; + var bytes = new byte[4]; + DataReader dataReader = DataReader.FromBuffer(inReport.Data); + dataReader.ReadBytes(bytes); + } + else + { + this.NotifyUser("Invalid input report received"); + } + } + else + { + this.NotifyUser("device is NULL"); + } + } + } +} + + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_activatedbooleancontrols.md b/windows.devices.humaninterfacedevice/hidinputreport_activatedbooleancontrols.md index 7a5f66a1c7..8644ce0fb5 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_activatedbooleancontrols.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_activatedbooleancontrols.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.ActivatedBooleanControls --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.ActivatedBooleanControls ## -description Retrieves the currently activated Boolean controls for the given HID device. ## -property-value A collection of Boolean controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.ActivatedBooleanControls +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.ActivatedBooleanControls + +## -description +Retrieves the currently activated Boolean controls for the given HID device. + +## -property-value +A collection of Boolean controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_data.md b/windows.devices.humaninterfacedevice/hidinputreport_data.md index 5394dcd6d4..cd7c587391 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_data.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.Data --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.Data ## -description Retrieves the data associated with a given input report. ## -property-value The input-report data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.Data +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.Data + +## -description +Retrieves the data associated with a given input report. + +## -property-value +The input-report data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrol_1611601713.md b/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrol_1611601713.md index eaef3dcafd..543c30068f 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrol_1611601713.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrol_1611601713.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControl(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControl ## -description Retrieves the Boolean control associated with the *usagePage* and *usageId* parameter and found in the given input report. ## -parameters ### -param usagePage The usage page of the top-level collection for the given HID device. ### -param usageId The usage identifier of the top-level collection for the given HID device. ## -returns A **HidBooleanControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControl(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControl + +## -description +Retrieves the Boolean control associated with the *usagePage* and *usageId* parameter and found in the given input report. + +## -parameters +### -param usagePage +The usage page of the top-level collection for the given HID device. + +### -param usageId +The usage identifier of the top-level collection for the given HID device. + +## -returns +A **HidBooleanControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrolbydescription_12392263.md b/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrolbydescription_12392263.md index 695a14ddad..0b6c14031c 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrolbydescription_12392263.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_getbooleancontrolbydescription_12392263.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControlByDescription(Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControlByDescription ## -description Retrieves the Boolean control described by the *controlDescription* parameter and found in the given input report. ## -parameters ### -param controlDescription A **HidBooleanControlDescription** object. ## -returns A **HidBooleanControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControlByDescription(Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.GetBooleanControlByDescription + +## -description +Retrieves the Boolean control described by the *controlDescription* parameter and found in the given input report. + +## -parameters +### -param controlDescription +A **HidBooleanControlDescription** object. + +## -returns +A **HidBooleanControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrol_2120528126.md b/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrol_2120528126.md index 2f383c6915..c25c2f923e 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrol_2120528126.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrol_2120528126.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControl(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControl ## -description Retrieves the numeric control associated with the *usagePage* and *usageId* parameters and found in the given input report. ## -parameters ### -param usagePage The usage page of the top-level collection for the given HID device. ### -param usageId The usage identifier of the top-level collection for the given HID device. ## -returns A **HidNumericControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControl(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControl + +## -description +Retrieves the numeric control associated with the *usagePage* and *usageId* parameters and found in the given input report. + +## -parameters +### -param usagePage +The usage page of the top-level collection for the given HID device. + +### -param usageId +The usage identifier of the top-level collection for the given HID device. + +## -returns +A **HidNumericControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrolbydescription_1317493064.md b/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrolbydescription_1317493064.md index 812fce6046..ee73f1b9a8 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrolbydescription_1317493064.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_getnumericcontrolbydescription_1317493064.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControlByDescription(Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControlByDescription ## -description Retrieves the numeric control described by the *controlDescription* parameter and found in the given input report. ## -parameters ### -param controlDescription A **HidNumericControlDescription** object. ## -returns A **HidNumericControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControlByDescription(Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.GetNumericControlByDescription + +## -description +Retrieves the numeric control described by the *controlDescription* parameter and found in the given input report. + +## -parameters +### -param controlDescription +A **HidNumericControlDescription** object. + +## -returns +A **HidNumericControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_id.md b/windows.devices.humaninterfacedevice/hidinputreport_id.md index ff17446c49..5ba86043c7 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_id.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.Id ## -description Retrieves the identifier associated with a given input report. ## -property-value The input report identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.Id + +## -description +Retrieves the identifier associated with a given input report. + +## -property-value +The input report identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreport_transitionedbooleancontrols.md b/windows.devices.humaninterfacedevice/hidinputreport_transitionedbooleancontrols.md index c87d95ba04..6d8fa34246 100644 --- a/windows.devices.humaninterfacedevice/hidinputreport_transitionedbooleancontrols.md +++ b/windows.devices.humaninterfacedevice/hidinputreport_transitionedbooleancontrols.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.TransitionedBooleanControls --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidInputReport.TransitionedBooleanControls ## -description Retrieves the recently transitioned Boolean controls for the given HID device. ## -property-value A collection of Boolean controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReport.TransitionedBooleanControls +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReport.TransitionedBooleanControls + +## -description +Retrieves the recently transitioned Boolean controls for the given HID device. + +## -property-value +A collection of Boolean controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md b/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md index e6638a675b..41125e9ef2 100644 --- a/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md +++ b/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs ## -description Represents the arguments which the HID API sends as part of an input-report event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs + +## -description +Represents the arguments which the HID API sends as part of an input-report event. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs_report.md b/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs_report.md index de194fcb23..587cfb8f7d 100644 --- a/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs_report.md +++ b/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs_report.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs.Report --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs.Report ## -description Retrieves the input report. ## -property-value A **HidInputReport** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs.Report +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidInputReportReceivedEventArgs.Report + +## -description +Retrieves the input report. + +## -property-value +A **HidInputReport** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol.md b/windows.devices.humaninterfacedevice/hidnumericcontrol.md index 0f338ce0dd..263fdd4df2 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidNumericControl --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl ## -description Represents a numeric control on a HID device that returns a range of values. An example would be the volume control on a speaker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidNumericControl +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl + +## -description +Represents a numeric control on a HID device that returns a range of values. An example would be the volume control on a speaker. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_controldescription.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_controldescription.md index 6ac6369450..4eee893fc3 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_controldescription.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_controldescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.ControlDescription --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.ControlDescription ## -description Retrieves a control description for the given numeric control. ## -property-value A **HidNumericControlDescription** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.ControlDescription +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.ControlDescription + +## -description +Retrieves a control description for the given numeric control. + +## -property-value +A **HidNumericControlDescription** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_id.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_id.md index 80e2388570..fd09cd1c50 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_id.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.Id ## -description Retrieves the identifier for the given numeric control. ## -property-value The control identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.Id + +## -description +Retrieves the identifier for the given numeric control. + +## -property-value +The control identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_isgrouped.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_isgrouped.md index f4d4fc431e..6d0f1b261d 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_isgrouped.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_isgrouped.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.IsGrouped --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.IsGrouped ## -description Retrieves a Boolean value that indicates whether the given numeric control is grouped with other, related controls. ## -property-value True if grouped; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.IsGrouped +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.IsGrouped + +## -description +Retrieves a Boolean value that indicates whether the given numeric control is grouped with other, related controls. + +## -property-value +True if grouped; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_scaledvalue.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_scaledvalue.md index 855dd9ca5f..88ff9eef0c 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_scaledvalue.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_scaledvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.ScaledValue --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.ScaledValue ## -description Retrieves, or sets, a scaled numeric-value for the given control. ## -property-value The scaled value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.ScaledValue +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.ScaledValue + +## -description +Retrieves, or sets, a scaled numeric-value for the given control. + +## -property-value +The scaled value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_usageid.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_usageid.md index 5d5690dd86..2af18ce6a8 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_usageid.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_usageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsageId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsageId ## -description Retrieves the usage identifier for the given numeric control. ## -property-value The usage identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsageId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsageId + +## -description +Retrieves the usage identifier for the given numeric control. + +## -property-value +The usage identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_usagepage.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_usagepage.md index 3a15c9a0c5..2a47a3cfb7 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_usagepage.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_usagepage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsagePage --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsagePage ## -description Retrieves the usage page for the given numeric control. ## -property-value The usage page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsagePage +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.UsagePage + +## -description +Retrieves the usage page for the given numeric control. + +## -property-value +The usage page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol_value.md b/windows.devices.humaninterfacedevice/hidnumericcontrol_value.md index d76c8f71d0..1602c99787 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol_value.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.Value --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControl.Value ## -description Retrieves, or sets, the numeric value for a given control. ## -property-value The control value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControl.Value +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControl.Value + +## -description +Retrieves, or sets, the numeric value for a given control. + +## -property-value +The control value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md index 4027c2fad7..d990ddaca2 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription ## -description Describes a numeric control for a given HID device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription + +## -description +Describes a numeric control for a given HID device. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_hasnull.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_hasnull.md index 8c45912734..52bba21e6e 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_hasnull.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_hasnull.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.HasNull --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.HasNull ## -description Retrieves a Boolean value which indicates whether the control supports a null, or out-of-range, value. ## -property-value True if the control supports a null value; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.HasNull +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.HasNull + +## -description +Retrieves a Boolean value which indicates whether the control supports a null, or out-of-range, value. + +## -property-value +True if the control supports a null value; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_id.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_id.md index 848a5c6595..798ebf1e5d 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_id.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Id ## -description Retrieves the identifier for a given numeric control. ## -property-value Identifies the control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Id + +## -description +Retrieves the identifier for a given numeric control. + +## -property-value +Identifies the control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_isabsolute.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_isabsolute.md index ce48cc411a..4452e2648c 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_isabsolute.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_isabsolute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.IsAbsolute --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.IsAbsolute ## -description Retrieves a Boolean value indicating whether the given control values are absolute or relative. ## -property-value True if the values are absolute; false if the values are relative. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.IsAbsolute +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.IsAbsolute + +## -description +Retrieves a Boolean value indicating whether the given control values are absolute or relative. + +## -property-value +True if the values are absolute; false if the values are relative. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalmaximum.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalmaximum.md index 087f117f34..4236f8e918 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalmaximum.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalmaximum.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMaximum --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMaximum ## -description Retrieves the logical maximum value for the given control. ## -property-value The logical maximum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMaximum +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMaximum + +## -description +Retrieves the logical maximum value for the given control. + +## -property-value +The logical maximum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalminimum.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalminimum.md index 93387a8aac..5c4763ac7f 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalminimum.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_logicalminimum.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMinimum --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMinimum ## -description Retrieves the logical minimum value for the control. ## -property-value The logical minimum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMinimum +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.LogicalMinimum + +## -description +Retrieves the logical minimum value for the control. + +## -property-value +The logical minimum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_parentcollections.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_parentcollections.md index 37a0b93bfe..a341efaafe 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_parentcollections.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_parentcollections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ParentCollections --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ParentCollections ## -description Retrieves the parent collections for a given numeric control. ## -property-value A vector of **HidCollection** objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ParentCollections +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ParentCollections + +## -description +Retrieves the parent collections for a given numeric control. + +## -property-value +A vector of **HidCollection** objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalmaximum.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalmaximum.md index 3f3a9c91e9..f3b7fb7237 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalmaximum.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalmaximum.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMaximum --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMaximum ## -description Retrieves the physical maximum-value for the given control. ## -property-value The physical maximum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMaximum +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMaximum + +## -description +Retrieves the physical maximum-value for the given control. + +## -property-value +The physical maximum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalminimum.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalminimum.md index cbc7ecc887..71b5c303fc 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalminimum.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_physicalminimum.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMinimum --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMinimum ## -description Retrieves the physical minimum-value for the given control. ## -property-value The physical minimum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMinimum +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.PhysicalMinimum + +## -description +Retrieves the physical minimum-value for the given control. + +## -property-value +The physical minimum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportcount.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportcount.md index 71f503953f..3747017992 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportcount.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportCount --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportCount ## -description Retrieves the number of reports associated with the given control. ## -property-value The number of reports. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportCount +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportCount + +## -description +Retrieves the number of reports associated with the given control. + +## -property-value +The number of reports. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportid.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportid.md index d51310a6ca..567eb2b3d3 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportid.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportId ## -description Retrieves the identifier for the report associated with the given numeric control. ## -property-value The report identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportId + +## -description +Retrieves the identifier for the report associated with the given numeric control. + +## -property-value +The report identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportsize.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportsize.md index 13d8989da2..f5380b3ff8 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportsize.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reportsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportSize --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportSize ## -description Retrieves the size, in bytes, of the given numeric control. ## -property-value The report size (in bytes). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportSize +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportSize + +## -description +Retrieves the size, in bytes, of the given numeric control. + +## -property-value +The report size (in bytes). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reporttype.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reporttype.md index 04c03eb348..3af407f187 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reporttype.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_reporttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportType --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportType ## -description Retrieves the type of report associated with the given numeric control. ## -property-value The report type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportType +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.ReportType + +## -description +Retrieves the type of report associated with the given numeric control. + +## -property-value +The report type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unit.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unit.md index 6bcc6221fc..0b3d72dee7 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unit.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unit.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Unit --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Unit ## -description Retrieves the unit associated with the given numeric control. ## -property-value The report unit. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Unit +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.Unit + +## -description +Retrieves the unit associated with the given numeric control. + +## -property-value +The report unit. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unitexponent.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unitexponent.md index 3cc23d6f45..2894f8e1e4 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unitexponent.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_unitexponent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UnitExponent --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UnitExponent ## -description Retrieves the unit exponent for the given numeric control. ## -property-value The unit exponent. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UnitExponent +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UnitExponent + +## -description +Retrieves the unit exponent for the given numeric control. + +## -property-value +The unit exponent. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usageid.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usageid.md index 6ea042a338..22b53fcd5e 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usageid.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usageid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsageId --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsageId ## -description Retrieves the usage identifier associated with the given numeric control. ## -property-value The usage identifierl. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsageId +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsageId + +## -description +Retrieves the usage identifier associated with the given numeric control. + +## -property-value +The usage identifierl. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usagepage.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usagepage.md index 6511ffd561..cb6757442f 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usagepage.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription_usagepage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsagePage --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsagePage ## -description Retrieves the usage page associated with the given numeric control. ## -property-value The usage page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsagePage +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription.UsagePage + +## -description +Retrieves the usage page associated with the given numeric control. + +## -property-value +The usage page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport.md b/windows.devices.humaninterfacedevice/hidoutputreport.md index 86d76bca97..3f6df2e3b7 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport.md @@ -1,3 +1,91 @@ ---- -api-id: T:Windows.Devices.HumanInterfaceDevice.HidOutputReport --api-type: winrt class ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport ## -description Represents an output report. Hosts issue output reports to request changes on the device. For example, a host could issue a request to a keyboard to turn an LED on or off. ## -remarks The following example demonstrates how a Windows Store app built with XAML and C# uses the **CreateOutputReport** method to create an output report. This example then uses the **SendOutputReportAsync** method to send the report to the device. ```css using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Windows.Devices.Enumeration; using Windows.Devices.HumanInterfaceDevice; using Windows.Storage; using Windows.Storage.Streams; namespace HidSampleCS { class Vendor { private async void ReadWriteToHidDevice(HidDevice device) { if (device != null) { // construct a HID output report to send to the device HidOutputReport outReport = device.CreateOutputReport(); /// Initialize the data buffer and fill it in byte[] buffer = new byte[] { 10, 20, 30, 40 }; DataWriter dataWriter = new DataWriter(); dataWriter.WriteBytes(buffer); outReport.Data = dataWriter.DetachBuffer(); // Send the output report asynchronously await device.SendOutputReportAsync(outReport); // // Sent output report successfully // Now lets try read an input report // HidInputReport inReport = await device.GetInputReportAsync(); if (inReport != null) { UInt16 id = inReport.Id; var bytes = new byte[4]; DataReader dataReader = DataReader.FromBuffer(inReport.Data); dataReader.ReadBytes(bytes); } else { this.NotifyUser("Invalid input report received"); } } else { this.NotifyUser("device is NULL"); } } } } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.HumanInterfaceDevice.HidOutputReport +-api-type: winrt class +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport + +## -description +Represents an output report. + +Hosts issue output reports to request changes on the device. For example, a host could issue a request to a keyboard to turn an LED on or off. + +## -remarks +The following example demonstrates how a Windows Store app built with XAML and C# uses the **CreateOutputReport** method to create an output report. This example then uses the **SendOutputReportAsync** method to send the report to the device. + + + + + +```css +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +using Windows.Devices.Enumeration; +using Windows.Devices.HumanInterfaceDevice; +using Windows.Storage; +using Windows.Storage.Streams; + +namespace HidSampleCS +{ + class Vendor + { + private async void ReadWriteToHidDevice(HidDevice device) + { + if (device != null) + { + // construct a HID output report to send to the device + HidOutputReport outReport = device.CreateOutputReport(); + + /// Initialize the data buffer and fill it in + byte[] buffer = new byte[] { 10, 20, 30, 40 }; + + DataWriter dataWriter = new DataWriter(); + dataWriter.WriteBytes(buffer); + + outReport.Data = dataWriter.DetachBuffer(); + + // Send the output report asynchronously + await device.SendOutputReportAsync(outReport); + + // + // Sent output report successfully + // Now lets try read an input report + // + HidInputReport inReport = await device.GetInputReportAsync(); + + if (inReport != null) + { + UInt16 id = inReport.Id; + var bytes = new byte[4]; + DataReader dataReader = DataReader.FromBuffer(inReport.Data); + dataReader.ReadBytes(bytes); + } + else + { + this.NotifyUser("Invalid input report received"); + } + } + else + { + this.NotifyUser("device is NULL"); + } + } + } +} + + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport_data.md b/windows.devices.humaninterfacedevice/hidoutputreport_data.md index be9056bd16..c43cfc4ed3 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport_data.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidOutputReport.Data --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport.Data ## -description Retrieves, or sets, the data associated with a given output report. ## -property-value The output report data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidOutputReport.Data +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport.Data + +## -description +Retrieves, or sets, the data associated with a given output report. + +## -property-value +The output report data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrol_1611601713.md b/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrol_1611601713.md index db6decc414..b7607c55d0 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrol_1611601713.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrol_1611601713.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControl(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControl ## -description Retrieves the boolean control associated with the given *usagePage* and *usageId*. ## -parameters ### -param usagePage The usage page associated with the given control. ### -param usageId The usage identifier associated with the given control. ## -returns A **HidBooleanControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControl(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControl + +## -description +Retrieves the boolean control associated with the given *usagePage* and *usageId*. + +## -parameters +### -param usagePage +The usage page associated with the given control. + +### -param usageId +The usage identifier associated with the given control. + +## -returns +A **HidBooleanControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrolbydescription_12392263.md b/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrolbydescription_12392263.md index 3755cafff2..83b44269e6 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrolbydescription_12392263.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport_getbooleancontrolbydescription_12392263.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControlByDescription(Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControlByDescription ## -description Retrieves the boolean control associated with the given *controlDescription*. ## -parameters ### -param controlDescription Describes the Boolean control. ## -returns A **HidBooleanControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControlByDescription(Windows.Devices.HumanInterfaceDevice.HidBooleanControlDescription) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetBooleanControlByDescription + +## -description +Retrieves the boolean control associated with the given *controlDescription*. + +## -parameters +### -param controlDescription +Describes the Boolean control. + +## -returns +A **HidBooleanControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrol_2120528126.md b/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrol_2120528126.md index aabde90c60..fed4b465fe 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrol_2120528126.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrol_2120528126.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControl(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControl ## -description Retrieves the numeric control associated with the given *usagePage* and *usageId*. ## -parameters ### -param usagePage The usage page associated with the given control. ### -param usageId The usage identifier associated with the given control. ## -returns A **HidNumericControl** l object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControl(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControl + +## -description +Retrieves the numeric control associated with the given *usagePage* and *usageId*. + +## -parameters +### -param usagePage +The usage page associated with the given control. + +### -param usageId +The usage identifier associated with the given control. + +## -returns +A **HidNumericControl** l object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrolbydescription_1317493064.md b/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrolbydescription_1317493064.md index 7766faca49..7cf9839a16 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrolbydescription_1317493064.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport_getnumericcontrolbydescription_1317493064.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControlByDescription(Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription) --api-type: winrt method ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControlByDescription ## -description Retrieves the numeric control associated with the given *controlDescription*. ## -parameters ### -param controlDescription Describes the numeric control. ## -returns A **HidNumericControl** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControlByDescription(Windows.Devices.HumanInterfaceDevice.HidNumericControlDescription) +-api-type: winrt method +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport.GetNumericControlByDescription + +## -description +Retrieves the numeric control associated with the given *controlDescription*. + +## -parameters +### -param controlDescription +Describes the numeric control. + +## -returns +A **HidNumericControl** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.humaninterfacedevice/hidoutputreport_id.md b/windows.devices.humaninterfacedevice/hidoutputreport_id.md index 92d16012e1..83e1269112 100644 --- a/windows.devices.humaninterfacedevice/hidoutputreport_id.md +++ b/windows.devices.humaninterfacedevice/hidoutputreport_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.HumanInterfaceDevice.HidOutputReport.Id --api-type: winrt property ---- # Windows.Devices.HumanInterfaceDevice.HidOutputReport.Id ## -description Retrieves the identifier associated with a given output report. ## -property-value The output report identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.HumanInterfaceDevice.HidOutputReport.Id +-api-type: winrt property +--- + + + +# Windows.Devices.HumanInterfaceDevice.HidOutputReport.Id + +## -description +Retrieves the identifier associated with a given output report. + +## -property-value +The output report identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2ccontrollerprovider_getdeviceprovider.md b/windows.devices.i2c.provider/ii2ccontrollerprovider_getdeviceprovider.md index 1fdb1386a3..ac8c505729 100644 --- a/windows.devices.i2c.provider/ii2ccontrollerprovider_getdeviceprovider.md +++ b/windows.devices.i2c.provider/ii2ccontrollerprovider_getdeviceprovider.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cControllerProvider.GetDeviceProvider(Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cControllerProvider.GetDeviceProvider ## -description Gets the I2 C device provider with the specified settings. ## -parameters ### -param settings The desired settings. ## -returns The I2 C device provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cControllerProvider.GetDeviceProvider(Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cControllerProvider.GetDeviceProvider + +## -description +Gets the I2 C device provider with the specified settings. + +## -parameters +### -param settings +The desired settings. + +## -returns +The I2 C device provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_deviceid.md b/windows.devices.i2c.provider/ii2cdeviceprovider_deviceid.md index a0e891daa5..5bb12a7496 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_deviceid.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.I2c.Provider.II2cDeviceProvider.DeviceId --api-type: winrt property ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.DeviceId ## -description Gets the plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. ## -property-value The plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.Provider.II2cDeviceProvider.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.DeviceId + +## -description +Gets the plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. + +## -property-value +The plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_read.md b/windows.devices.i2c.provider/ii2cdeviceprovider_read.md index 09ca4c7d97..a67d72bf32 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_read.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_read.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.Read(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.Read ## -description Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer. ## -parameters ### -param buffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.Read(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.Read + +## -description +Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer. + +## -parameters +### -param buffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_readpartial.md b/windows.devices.i2c.provider/ii2cdeviceprovider_readpartial.md index 91df149608..fab3c78fd4 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_readpartial.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_readpartial.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.ReadPartial(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.ReadPartial ## -description Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer, and returns information about the success of the operation that you can use for error handling. ## -parameters ### -param buffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -returns A structure that contains information about the success of the read operation and the actual number of bytes that the operation read into the buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.ReadPartial(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.ReadPartial + +## -description +Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer, and returns information about the success of the operation that you can use for error handling. + +## -parameters +### -param buffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -returns +A structure that contains information about the success of the read operation and the actual number of bytes that the operation read into the buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_write.md b/windows.devices.i2c.provider/ii2cdeviceprovider_write.md index 2fc80747e1..ae1cce16f4 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_write.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_write.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.Write(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.Write ## -description Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected. ## -parameters ### -param buffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ## -exceptions ### 0x80070002 The bus address was not acknowledged. ### 0x8007045D The I2 C device negatively acknowledged the data transfer before the entire buffer was read. ## -remarks ## -examples ## -see-also [I2cDevice](../windows.devices.i2c/i2cdevice.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.Write(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.Write + +## -description +Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected. + +## -parameters +### -param buffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +## -exceptions +### 0x80070002 + +The bus address was not acknowledged. + +### 0x8007045D + +The I2 C device negatively acknowledged the data transfer before the entire buffer was read. + +## -remarks + +## -examples + +## -see-also +[I2cDevice](../windows.devices.i2c/i2cdevice.md) \ No newline at end of file diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_writepartial.md b/windows.devices.i2c.provider/ii2cdeviceprovider_writepartial.md index 1324756b6a..e2a280e65d 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_writepartial.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_writepartial.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.WritePartial(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.WritePartial ## -description Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. ## -parameters ### -param buffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ## -returns A structure that contains information about the success of the write operation and the actual number of bytes that the operation wrote into the buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.WritePartial(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.WritePartial + +## -description +Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. + +## -parameters +### -param buffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +## -returns +A structure that contains information about the success of the write operation and the actual number of bytes that the operation wrote into the buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_writeread.md b/windows.devices.i2c.provider/ii2cdeviceprovider_writeread.md index fe6389e1d1..a1337f98da 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_writeread.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_writeread.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteRead(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteRead ## -description Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and sends a restart condition between the write and read operations. ## -parameters ### -param writeBuffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ### -param readBuffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -exceptions ### 0x80070002 The bus address was not acknowledged. ### 0x8007045D The I2 C device negatively acknowledged the data transfer before the entire buffer was read. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteRead(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteRead + +## -description +Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and sends a restart condition between the write and read operations. + +## -parameters +### -param writeBuffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +### -param readBuffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -exceptions +### 0x80070002 + +The bus address was not acknowledged. + +### 0x8007045D + +The I2 C device negatively acknowledged the data transfer before the entire buffer was read. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cdeviceprovider_writereadpartial.md b/windows.devices.i2c.provider/ii2cdeviceprovider_writereadpartial.md index fc25744ed8..5eda4af71f 100644 --- a/windows.devices.i2c.provider/ii2cdeviceprovider_writereadpartial.md +++ b/windows.devices.i2c.provider/ii2cdeviceprovider_writereadpartial.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteReadPartial(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteReadPartial ## -description Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. ## -parameters ### -param writeBuffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ### -param readBuffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -returns A structure that contains information about whether both the read and write parts of the operation succeeded and the sum of the actual number of bytes that the operation wrote and the actual number of bytes that the operation read. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteReadPartial(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cDeviceProvider.WriteReadPartial + +## -description +Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. + +## -parameters +### -param writeBuffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +### -param readBuffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -returns +A structure that contains information about whether both the read and write parts of the operation succeeded and the sum of the actual number of bytes that the operation wrote and the actual number of bytes that the operation read. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/ii2cprovider_getcontrollersasync.md b/windows.devices.i2c.provider/ii2cprovider_getcontrollersasync.md index 1db7e5bc61..4300b3a0e5 100644 --- a/windows.devices.i2c.provider/ii2cprovider_getcontrollersasync.md +++ b/windows.devices.i2c.provider/ii2cprovider_getcontrollersasync.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.I2c.Provider.II2cProvider.GetControllersAsync --api-type: winrt method ---- # Windows.Devices.I2c.Provider.II2cProvider.GetControllersAsync ## -description Gets all the I2 C controllers that are on the system. ## -returns When the method completes successfully, it returns a list of values that represent the available I2 C controllers on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.Provider.II2cProvider.GetControllersAsync +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.Provider.II2cProvider.GetControllersAsync + +## -description +Gets all the I2 C controllers that are on the system. + +## -returns +When the method completes successfully, it returns a list of values that represent the available I2 C controllers on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/provideri2cconnectionsettings.md b/windows.devices.i2c.provider/provideri2cconnectionsettings.md index ea87ea08d4..2d84502f09 100644 --- a/windows.devices.i2c.provider/provideri2cconnectionsettings.md +++ b/windows.devices.i2c.provider/provideri2cconnectionsettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings --api-type: winrt class ---- # Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings ## -description Represents the connection settings you want to use for an inter-integrated circuit (I2 C) device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings +-api-type: winrt class +--- + + + +# Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings + +## -description +Represents the connection settings you want to use for an inter-integrated circuit (I2 C) device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/provideri2cconnectionsettings_busspeed.md b/windows.devices.i2c.provider/provideri2cconnectionsettings_busspeed.md index 647157b347..6581ff052a 100644 --- a/windows.devices.i2c.provider/provideri2cconnectionsettings_busspeed.md +++ b/windows.devices.i2c.provider/provideri2cconnectionsettings_busspeed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.BusSpeed --api-type: winrt property ---- # Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.BusSpeed ## -description Gets or sets the bus speed to use for connecting to an inter-integrated circuit (I2 C) device. The bus speed is the frequency at which to clock the I2 C bus when accessing the device. ## -property-value The bus speed to use for connecting to an I2 C device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.BusSpeed +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.BusSpeed + +## -description +Gets or sets the bus speed to use for connecting to an inter-integrated circuit (I2 C) device. The bus speed is the frequency at which to clock the I2 C bus when accessing the device. + +## -property-value +The bus speed to use for connecting to an I2 C device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/provideri2cconnectionsettings_sharingmode.md b/windows.devices.i2c.provider/provideri2cconnectionsettings_sharingmode.md index be3e810d94..2a6a7b44ca 100644 --- a/windows.devices.i2c.provider/provideri2cconnectionsettings_sharingmode.md +++ b/windows.devices.i2c.provider/provideri2cconnectionsettings_sharingmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SharingMode --api-type: winrt property ---- # Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SharingMode ## -description Gets or sets the sharing mode to use to connect to the inter-integrated circuit (I2 C) bus address. This mode determines whether other connections to the I2 C bus address can be opened while you are connect to the I2 C bus address. ## -property-value The sharing mode to use to connect to the I2 C bus address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SharingMode + +## -description +Gets or sets the sharing mode to use to connect to the inter-integrated circuit (I2 C) bus address. This mode determines whether other connections to the I2 C bus address can be opened while you are connect to the I2 C bus address. + +## -property-value +The sharing mode to use to connect to the I2 C bus address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c.provider/provideri2cconnectionsettings_slaveaddress.md b/windows.devices.i2c.provider/provideri2cconnectionsettings_slaveaddress.md index 48d2e5e463..cb62d514e1 100644 --- a/windows.devices.i2c.provider/provideri2cconnectionsettings_slaveaddress.md +++ b/windows.devices.i2c.provider/provideri2cconnectionsettings_slaveaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SlaveAddress --api-type: winrt property ---- # Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SlaveAddress ## -description Gets or sets the bus address of the inter-integrated circuit (I2 C) device. ## -property-value The bus address of the I2 C device. Only 7-bit addressing is supported, so the range of values that are valid is from 8 to 119. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SlaveAddress +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.Provider.ProviderI2cConnectionSettings.SlaveAddress + +## -description +Gets or sets the bus address of the inter-integrated circuit (I2 C) device. + +## -property-value +The bus address of the I2 C device. Only 7-bit addressing is supported, so the range of values that are valid is from 8 to 119. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c/i2cconnectionsettings.md b/windows.devices.i2c/i2cconnectionsettings.md index 02ee9b2cc4..6fd9731a1a 100644 --- a/windows.devices.i2c/i2cconnectionsettings.md +++ b/windows.devices.i2c/i2cconnectionsettings.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.I2c.I2cConnectionSettings --api-type: winrt class ---- # Windows.Devices.I2c.I2cConnectionSettings ## -description Represents the connection settings you want to use for an inter-integrated circuit (I2 C) device. ## -remarks ## -examples ## -see-also [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md), [I2cDevice.ConnectionSettings](i2cdevice_connectionsettings.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.I2c.I2cConnectionSettings +-api-type: winrt class +--- + + + +# Windows.Devices.I2c.I2cConnectionSettings + +## -description +Represents the connection settings you want to use for an inter-integrated circuit (I2 C) device. + +## -remarks + +## -examples + +## -see-also +[I2cDevice.FromIdAsync](i2cdevice_fromidasync.md), [I2cDevice.ConnectionSettings](i2cdevice_connectionsettings.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cconnectionsettings_busspeed.md b/windows.devices.i2c/i2cconnectionsettings_busspeed.md index 960d1147e3..8ddcf701db 100644 --- a/windows.devices.i2c/i2cconnectionsettings_busspeed.md +++ b/windows.devices.i2c/i2cconnectionsettings_busspeed.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.I2c.I2cConnectionSettings.BusSpeed --api-type: winrt property ---- # Windows.Devices.I2c.I2cConnectionSettings.BusSpeed ## -description Gets or sets the bus speed to use for connecting to an inter-integrated circuit (I2 C) device. The bus speed is the frequency at which to clock the I2 C bus when accessing the device. ## -property-value The bus speed to use for connecting to anI2 C device. ## -remarks ## -examples ## -see-also [I2cBusSpeed](i2cbusspeed.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.I2cConnectionSettings.BusSpeed +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.I2cConnectionSettings.BusSpeed + +## -description +Gets or sets the bus speed to use for connecting to an inter-integrated circuit (I2 C) device. The bus speed is the frequency at which to clock the I2 C bus when accessing the device. + +## -property-value +The bus speed to use for connecting to anI2 C device. + +## -remarks + +## -examples + +## -see-also +[I2cBusSpeed](i2cbusspeed.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cconnectionsettings_i2cconnectionsettings_745845612.md b/windows.devices.i2c/i2cconnectionsettings_i2cconnectionsettings_745845612.md index 546a5c9a8f..3b3f3e4228 100644 --- a/windows.devices.i2c/i2cconnectionsettings_i2cconnectionsettings_745845612.md +++ b/windows.devices.i2c/i2cconnectionsettings_i2cconnectionsettings_745845612.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.I2c.I2cConnectionSettings.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Devices.I2c.I2cConnectionSettings.I2cConnectionSettings ## -description Creates and initializes a new instance of the [I2cConnectionSettings](i2cconnectionsettings_i2cconnectionsettings.md) class for inter-integrated circuit (I2 C) device with specified bus address, using the default settings of the standard mode for the bus speed and exclusive sharing mode. ## -parameters ### -param slaveAddress The bus address of the inter-integrated circuit (I2 C) device to which the settings of the [I2cConnectionSettings](i2cconnectionsettings_i2cconnectionsettings.md) should apply. Only 7-bit addressing is supported, so the range of values that are valid is from 8 to 119. ## -remarks ## -examples ## -see-also [SlaveAddress](i2cconnectionsettings_slaveaddress.md), [I2cDevice.ConnectionSettings](i2cdevice_connectionsettings.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cConnectionSettings.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cConnectionSettings.I2cConnectionSettings + +## -description +Creates and initializes a new instance of the [I2cConnectionSettings](i2cconnectionsettings_i2cconnectionsettings.md) class for inter-integrated circuit (I2 C) device with specified bus address, using the default settings of the standard mode for the bus speed and exclusive sharing mode. + +## -parameters +### -param slaveAddress +The bus address of the inter-integrated circuit (I2 C) device to which the settings of the [I2cConnectionSettings](i2cconnectionsettings_i2cconnectionsettings.md) should apply. Only 7-bit addressing is supported, so the range of values that are valid is from 8 to 119. + +## -remarks + +## -examples + +## -see-also +[SlaveAddress](i2cconnectionsettings_slaveaddress.md), [I2cDevice.ConnectionSettings](i2cdevice_connectionsettings.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cconnectionsettings_sharingmode.md b/windows.devices.i2c/i2cconnectionsettings_sharingmode.md index fa2cbd686e..5ca000bc98 100644 --- a/windows.devices.i2c/i2cconnectionsettings_sharingmode.md +++ b/windows.devices.i2c/i2cconnectionsettings_sharingmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.I2c.I2cConnectionSettings.SharingMode --api-type: winrt property ---- # Windows.Devices.I2c.I2cConnectionSettings.SharingMode ## -description Gets or sets the sharing mode to use to connect to the inter-integrated circuit (I2 C) bus address. This mode determines whether other connections to the I2 C bus address can be opened while you are connect to the I2 C bus address. ## -property-value The sharing mode to use to connect to the I2 C bus address. ## -remarks ## -examples ## -see-also [I2cSharingMode](i2csharingmode.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.I2cConnectionSettings.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.I2cConnectionSettings.SharingMode + +## -description +Gets or sets the sharing mode to use to connect to the inter-integrated circuit (I2 C) bus address. This mode determines whether other connections to the I2 C bus address can be opened while you are connect to the I2 C bus address. + +## -property-value +The sharing mode to use to connect to the I2 C bus address. + +## -remarks + +## -examples + +## -see-also +[I2cSharingMode](i2csharingmode.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cconnectionsettings_slaveaddress.md b/windows.devices.i2c/i2cconnectionsettings_slaveaddress.md index ae36e83e11..cf2e763891 100644 --- a/windows.devices.i2c/i2cconnectionsettings_slaveaddress.md +++ b/windows.devices.i2c/i2cconnectionsettings_slaveaddress.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.I2c.I2cConnectionSettings.SlaveAddress --api-type: winrt property ---- # Windows.Devices.I2c.I2cConnectionSettings.SlaveAddress ## -description Gets or sets the bus address of the inter-integrated circuit (I2 C) device. ## -property-value The bus address of the I2 C device. Only 7-bit addressing is supported, so the range of values that are valid is from 8 to 119. ## -remarks ## -examples ## -see-also [I2cConnectionSettings(Int32)](i2cconnectionsettings_i2cconnectionsettings.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.I2cConnectionSettings.SlaveAddress +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.I2cConnectionSettings.SlaveAddress + +## -description +Gets or sets the bus address of the inter-integrated circuit (I2 C) device. + +## -property-value +The bus address of the I2 C device. Only 7-bit addressing is supported, so the range of values that are valid is from 8 to 119. + +## -remarks + +## -examples + +## -see-also +[I2cConnectionSettings(Int32)](i2cconnectionsettings_i2cconnectionsettings.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2ccontroller.md b/windows.devices.i2c/i2ccontroller.md index 246b41cd90..9746dccf2e 100644 --- a/windows.devices.i2c/i2ccontroller.md +++ b/windows.devices.i2c/i2ccontroller.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.I2c.I2cController --api-type: winrt class ---- # Windows.Devices.I2c.I2cController ## -description Represents the I2 C controller for the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.I2c.I2cController +-api-type: winrt class +--- + + + +# Windows.Devices.I2c.I2cController + +## -description +Represents the I2 C controller for the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c/i2ccontroller_getcontrollersasync_665348763.md b/windows.devices.i2c/i2ccontroller_getcontrollersasync_665348763.md index 2e42c305d2..8261195a14 100644 --- a/windows.devices.i2c/i2ccontroller_getcontrollersasync_665348763.md +++ b/windows.devices.i2c/i2ccontroller_getcontrollersasync_665348763.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.I2c.I2cController.GetControllersAsync(Windows.Devices.I2c.Provider.II2cProvider) --api-type: winrt method ---- # Windows.Devices.I2c.I2cController.GetControllersAsync ## -description Gets all the I2 C controllers that are on the system. ## -parameters ### -param provider The I2 C provider for the controllers on the system. ## -returns When the method completes successfully, it returns a list of values that represent the available I2 C controllers on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cController.GetControllersAsync(Windows.Devices.I2c.Provider.II2cProvider) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cController.GetControllersAsync + +## -description +Gets all the I2 C controllers that are on the system. + +## -parameters +### -param provider +The I2 C provider for the controllers on the system. + +## -returns +When the method completes successfully, it returns a list of values that represent the available I2 C controllers on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c/i2ccontroller_getdefaultasync_1549573963.md b/windows.devices.i2c/i2ccontroller_getdefaultasync_1549573963.md index 654e83eeb3..20aeb1a8e9 100644 --- a/windows.devices.i2c/i2ccontroller_getdefaultasync_1549573963.md +++ b/windows.devices.i2c/i2ccontroller_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.I2c.I2cController.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.I2c.I2cController.GetDefaultAsync ## -description Gets the default I2 C controller on the system. ## -returns The default I2 C controller on the system, or null if the system has no I2 C controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cController.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cController.GetDefaultAsync + +## -description +Gets the default I2 C controller on the system. + +## -returns +The default I2 C controller on the system, or null if the system has no I2 C controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c/i2ccontroller_getdevice_1206862599.md b/windows.devices.i2c/i2ccontroller_getdevice_1206862599.md index 40f9597575..56940c06da 100644 --- a/windows.devices.i2c/i2ccontroller_getdevice_1206862599.md +++ b/windows.devices.i2c/i2ccontroller_getdevice_1206862599.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.I2c.I2cController.GetDevice(Windows.Devices.I2c.I2cConnectionSettings) --api-type: winrt method ---- # Windows.Devices.I2c.I2cController.GetDevice ## -description Gets the I2 C device with the specified settings. ## -parameters ### -param settings The desired connection settings. ## -returns The I2 C device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cController.GetDevice(Windows.Devices.I2c.I2cConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cController.GetDevice + +## -description +Gets the I2 C device with the specified settings. + +## -parameters +### -param settings +The desired connection settings. + +## -returns +The I2 C device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.i2c/i2cdevice.md b/windows.devices.i2c/i2cdevice.md index aa28e736a7..6c236e01a6 100644 --- a/windows.devices.i2c/i2cdevice.md +++ b/windows.devices.i2c/i2cdevice.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.I2c.I2cDevice --api-type: winrt class ---- # Windows.Devices.I2c.I2cDevice ## -description Represents a communications channel to a device on an inter-integrated circuit (I2 C) bus. ## -remarks To get an instance of [I2cDevice](i2cdevice.md), use the [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) method. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [II2cDeviceStatics](ii2cdevicestatics.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.I2c.I2cDevice +-api-type: winrt class +--- + + + +# Windows.Devices.I2c.I2cDevice + +## -description +Represents a communications channel to a device on an inter-integrated circuit (I2 C) bus. + +## -remarks +To get an instance of [I2cDevice](i2cdevice.md), use the [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) method. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [II2cDeviceStatics](ii2cdevicestatics.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_close_811482585.md b/windows.devices.i2c/i2cdevice_close_811482585.md index fd29b321b7..ca286dd15a 100644 --- a/windows.devices.i2c/i2cdevice_close_811482585.md +++ b/windows.devices.i2c/i2cdevice_close_811482585.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.Close --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.Close ## -description Closes the connection to the inter-integrated circuit (I2 C) device. ## -remarks You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.Close + +## -description +Closes the connection to the inter-integrated circuit (I2 C) device. + +## -remarks +You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also +[I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_connectionsettings.md b/windows.devices.i2c/i2cdevice_connectionsettings.md index ef3c23bd3d..a449f695c5 100644 --- a/windows.devices.i2c/i2cdevice_connectionsettings.md +++ b/windows.devices.i2c/i2cdevice_connectionsettings.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.I2c.I2cDevice.ConnectionSettings --api-type: winrt property ---- # Windows.Devices.I2c.I2cDevice.ConnectionSettings ## -description Gets the connection settings used for communication with the inter-integrated circuit (I2 C) device. ## -property-value The connection settings used for communication with the inter-integrated circuit (I2 C) device. ## -remarks If you try to change the values of the [I2cConnectionSettings](i2cconnectionsettings.md) object that you get through this property, those changes will have no effect. You cannot change the connection settings after you create the [I2cDevice](i2cdevice.md) object. To specify the connection settings, use the [I2cConnectionSettings(Int32)](i2cconnectionsettings_i2cconnectionsettings.md) constructor to create an [I2cConnectionSettings](i2cconnectionsettings.md) object, and set the property values for that [I2cConnectionSettings](i2cconnectionsettings.md) object before you pass it to the [FromIdAsync](i2cdevice_fromidasync.md) method to create the [I2cDevice](i2cdevice.md) object. ## -examples ## -see-also [I2cConnectionSettings](i2cconnectionsettings.md), [I2cConnectionSettings(Int32)](i2cconnectionsettings_i2cconnectionsettings.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.I2cDevice.ConnectionSettings +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.I2cDevice.ConnectionSettings + +## -description +Gets the connection settings used for communication with the inter-integrated circuit (I2 C) device. + +## -property-value +The connection settings used for communication with the inter-integrated circuit (I2 C) device. + +## -remarks +If you try to change the values of the [I2cConnectionSettings](i2cconnectionsettings.md) object that you get through this property, those changes will have no effect. You cannot change the connection settings after you create the [I2cDevice](i2cdevice.md) object. To specify the connection settings, use the [I2cConnectionSettings(Int32)](i2cconnectionsettings_i2cconnectionsettings.md) constructor to create an [I2cConnectionSettings](i2cconnectionsettings.md) object, and set the property values for that [I2cConnectionSettings](i2cconnectionsettings.md) object before you pass it to the [FromIdAsync](i2cdevice_fromidasync.md) method to create the [I2cDevice](i2cdevice.md) object. + +## -examples + +## -see-also +[I2cConnectionSettings](i2cconnectionsettings.md), [I2cConnectionSettings(Int32)](i2cconnectionsettings_i2cconnectionsettings.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_deviceid.md b/windows.devices.i2c/i2cdevice_deviceid.md index 0a1fbc2ab5..99c85e8491 100644 --- a/windows.devices.i2c/i2cdevice_deviceid.md +++ b/windows.devices.i2c/i2cdevice_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.I2c.I2cDevice.DeviceId --api-type: winrt property ---- # Windows.Devices.I2c.I2cDevice.DeviceId ## -description Gets the plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. ## -property-value The plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. ## -remarks ## -examples ## -see-also [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md), [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.I2c.I2cDevice.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.I2c.I2cDevice.DeviceId + +## -description +Gets the plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. + +## -property-value +The plug and play device identifier of the inter-integrated circuit (I2 C) bus controller for the device. + +## -remarks + +## -examples + +## -see-also +[I2cDevice.FromIdAsync](i2cdevice_fromidasync.md), [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_fromidasync_1693757112.md b/windows.devices.i2c/i2cdevice_fromidasync_1693757112.md index d336d0378d..a9c2bcef7b 100644 --- a/windows.devices.i2c/i2cdevice_fromidasync_1693757112.md +++ b/windows.devices.i2c/i2cdevice_fromidasync_1693757112.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.FromIdAsync(System.String,Windows.Devices.I2c.I2cConnectionSettings) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.FromIdAsync ## -description Retrieves an [I2cDevice](i2cdevice.md) object asynchronously for the inter-integrated circuit (I2 C) bus controller that has the specified plug and play device identifier, using the specified connection settings. ## -parameters ### -param deviceId The plug and play device identifier of the I2 C bus controller for which you want to create an [I2cDevice](i2cdevice.md) object. ### -param settings The connection settings to use for communication with the I2 C bus controller that *deviceId* specifies. ## -returns An asynchronous operation that returns the [I2cDevice](i2cdevice.md) object. ## -remarks ## -examples ## -see-also [I2cConnectionSettings](i2cconnectionsettings.md), [GetDeviceSelector](i2cdevice_getdeviceselector.md), [I2cDevice.Close](i2cdevice_close.md), [I2cDevice.DeviceId](i2cdevice_deviceid.md), [II2cDeviceStatics.FromIdAsync](ii2cdevicestatics_fromidasync.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.FromIdAsync(System.String,Windows.Devices.I2c.I2cConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.FromIdAsync + +## -description +Retrieves an [I2cDevice](i2cdevice.md) object asynchronously for the inter-integrated circuit (I2 C) bus controller that has the specified plug and play device identifier, using the specified connection settings. + +## -parameters +### -param deviceId +The plug and play device identifier of the I2 C bus controller for which you want to create an [I2cDevice](i2cdevice.md) object. + +### -param settings +The connection settings to use for communication with the I2 C bus controller that *deviceId* specifies. + +## -returns +An asynchronous operation that returns the [I2cDevice](i2cdevice.md) object. + +## -remarks + +## -examples + +## -see-also +[I2cConnectionSettings](i2cconnectionsettings.md), [GetDeviceSelector](i2cdevice_getdeviceselector.md), [I2cDevice.Close](i2cdevice_close.md), [I2cDevice.DeviceId](i2cdevice_deviceid.md), [II2cDeviceStatics.FromIdAsync](ii2cdevicestatics_fromidasync.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_getdeviceselector_1752695616.md b/windows.devices.i2c/i2cdevice_getdeviceselector_1752695616.md index a6b6c6ae6f..65f0b62681 100644 --- a/windows.devices.i2c/i2cdevice_getdeviceselector_1752695616.md +++ b/windows.devices.i2c/i2cdevice_getdeviceselector_1752695616.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.GetDeviceSelector(System.String) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.GetDeviceSelector ## -description Retrieves an Advanced Query Syntax (AQS) string for the inter-integrated circuit (I2 C) bus that has the specified friendly name. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. ## -parameters ### -param friendlyName A friendly name for the particular I2 C bus on a particular hardware platform for which you want to get the AQS string. ## -returns An AQS string for the I2 C bus that *friendlyName* specifies, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. ## -remarks ## -examples ## -see-also [GetDeviceSelector](i2cdevice_getdeviceselector_838466080.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md), [II2CDeviceStatics.GetDeviceSelector(String)](ii2cdevicestatics_getdeviceselector_1752695616.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string for the inter-integrated circuit (I2 C) bus that has the specified friendly name. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. + +## -parameters +### -param friendlyName +A friendly name for the particular I2 C bus on a particular hardware platform for which you want to get the AQS string. + +## -returns +An AQS string for the I2 C bus that *friendlyName* specifies, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector](i2cdevice_getdeviceselector_838466080.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md), [II2CDeviceStatics.GetDeviceSelector(String)](ii2cdevicestatics_getdeviceselector_1752695616.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_getdeviceselector_838466080.md b/windows.devices.i2c/i2cdevice_getdeviceselector_838466080.md index dc1263afb6..96a5e353cd 100644 --- a/windows.devices.i2c/i2cdevice_getdeviceselector_838466080.md +++ b/windows.devices.i2c/i2cdevice_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.GetDeviceSelector ## -description Retrieves an Advanced Query Syntax (AQS) string for all of the inter-integrated circuit (I2 C) bus controllers on the system. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. ## -returns An AQS string for all of the I2 C bus controllers on the system, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. ## -remarks ## -examples ## -see-also [GetDeviceSelector(String)](i2cdevice_getdeviceselector_1752695616.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [II2cDeviceStatics.GetDeviceSelector()](ii2cdevicestatics_getdeviceselector_838466080.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string for all of the inter-integrated circuit (I2 C) bus controllers on the system. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. + +## -returns +An AQS string for all of the I2 C bus controllers on the system, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(String)](i2cdevice_getdeviceselector_1752695616.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [II2cDeviceStatics.GetDeviceSelector()](ii2cdevicestatics_getdeviceselector_838466080.md) \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_read_1437850332.md b/windows.devices.i2c/i2cdevice_read_1437850332.md index 6fd2cb72c2..66bf5500a9 100644 --- a/windows.devices.i2c/i2cdevice_read_1437850332.md +++ b/windows.devices.i2c/i2cdevice_read_1437850332.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.Read(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.Read ## -description Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer. ## -parameters ### -param buffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -exceptions ### 0x80070002 The bus address was not acknowledged. ### 0x8007045D The I2 C device negatively acknowledged the data transfer before the entire buffer was read. ## -remarks ## -examples ## -see-also [ReadPartial](i2cdevice_readpartial.md), [Write](i2cdevice_write.md), [WriteRead](i2cdevice_writeread.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.Read(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.Read + +## -description +Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer. + +## -parameters +### -param buffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -exceptions +### 0x80070002 + +The bus address was not acknowledged. + +### 0x8007045D + +The I2 C device negatively acknowledged the data transfer before the entire buffer was read. + +## -remarks + +## -examples + +## -see-also +[ReadPartial](i2cdevice_readpartial.md), [Write](i2cdevice_write.md), [WriteRead](i2cdevice_writeread.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_readpartial_589466211.md b/windows.devices.i2c/i2cdevice_readpartial_589466211.md index 3094676284..ffda03f7ef 100644 --- a/windows.devices.i2c/i2cdevice_readpartial_589466211.md +++ b/windows.devices.i2c/i2cdevice_readpartial_589466211.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.ReadPartial(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.ReadPartial ## -description Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer, and returns information about the success of the operation that you can use for error handling. ## -parameters ### -param buffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -returns A structure that contains information about the success of the read operation and the actual number of bytes that the operation read into the buffer. ## -remarks ## -examples ## -see-also [Read](i2cdevice_read.md), [I2cTransferResult](i2ctransferresult.md), [I2cTransferStatus](i2ctransferstatus.md), [WritePartial](i2cdevice_writepartial.md), [WriteReadPartial](i2cdevice_writereadpartial.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.ReadPartial(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.ReadPartial + +## -description +Reads data from the inter-integrated circuit (I2 C) bus on which the device is connected into the specified buffer, and returns information about the success of the operation that you can use for error handling. + +## -parameters +### -param buffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -returns +A structure that contains information about the success of the read operation and the actual number of bytes that the operation read into the buffer. + +## -remarks + +## -examples + +## -see-also +[Read](i2cdevice_read.md), [I2cTransferResult](i2ctransferresult.md), [I2cTransferStatus](i2ctransferstatus.md), [WritePartial](i2cdevice_writepartial.md), [WriteReadPartial](i2cdevice_writereadpartial.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_write_1047802370.md b/windows.devices.i2c/i2cdevice_write_1047802370.md index 1d3bacd5ae..0889b008e3 100644 --- a/windows.devices.i2c/i2cdevice_write_1047802370.md +++ b/windows.devices.i2c/i2cdevice_write_1047802370.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.Write(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.Write ## -description Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected, based on the bus address specified in the [I2cConnectionSetting](i2cconnectionsettings.md) s object that you used to create the [I2cDevice](i2cdevice.md) object. ## -parameters ### -param buffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ## -exceptions ### 0x80070002 The bus address was not acknowledged. ### 0x8007045D The I2 C device negatively acknowledged the data transfer before the entire buffer was written. ## -remarks ## -examples ## -see-also [WritePartial](i2cdevice_writepartial.md), [Read](i2cdevice_read.md), [WriteRead](i2cdevice_writeread.md), [I2cConnectionSetting](i2cconnectionsettings.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.Write(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.Write + +## -description +Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected, based on the bus address specified in the [I2cConnectionSetting](i2cconnectionsettings.md) s object that you used to create the [I2cDevice](i2cdevice.md) object. + +## -parameters +### -param buffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +## -exceptions +### 0x80070002 + +The bus address was not acknowledged. + +### 0x8007045D + +The I2 C device negatively acknowledged the data transfer before the entire buffer was written. + +## -remarks + +## -examples + +## -see-also +[WritePartial](i2cdevice_writepartial.md), [Read](i2cdevice_read.md), [WriteRead](i2cdevice_writeread.md), [I2cConnectionSetting](i2cconnectionsettings.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_writepartial_1107922632.md b/windows.devices.i2c/i2cdevice_writepartial_1107922632.md index f4f6f108ec..8981d23a08 100644 --- a/windows.devices.i2c/i2cdevice_writepartial_1107922632.md +++ b/windows.devices.i2c/i2cdevice_writepartial_1107922632.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.WritePartial(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.WritePartial ## -description Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. ## -parameters ### -param buffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ## -returns A structure that contains information about the success of the write operation and the actual number of bytes that the operation wrote into the buffer. ## -remarks ## -examples ## -see-also [Write](i2cdevice_write.md), [ReadPartial](i2cdevice_readpartial.md), [WriteReadPartial](i2cdevice_writereadpartial.md), [I2cTransferResult](i2ctransferresult.md), [I2cTransferStatus](i2ctransferstatus.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.WritePartial(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.WritePartial + +## -description +Writes data to the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. + +## -parameters +### -param buffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +## -returns +A structure that contains information about the success of the write operation and the actual number of bytes that the operation wrote into the buffer. + +## -remarks + +## -examples + +## -see-also +[Write](i2cdevice_write.md), [ReadPartial](i2cdevice_readpartial.md), [WriteReadPartial](i2cdevice_writereadpartial.md), [I2cTransferResult](i2ctransferresult.md), [I2cTransferStatus](i2ctransferstatus.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_writeread_1176071171.md b/windows.devices.i2c/i2cdevice_writeread_1176071171.md index 5bb3652ffa..e0e290f4b3 100644 --- a/windows.devices.i2c/i2cdevice_writeread_1176071171.md +++ b/windows.devices.i2c/i2cdevice_writeread_1176071171.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.WriteRead(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.WriteRead ## -description Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and sends a restart condition between the write and read operations. ## -parameters ### -param writeBuffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ### -param readBuffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -exceptions ### 0x80070002 The bus address was not acknowledged. ### 0x8007045D The I2 C device negatively acknowledged the data transfer before the entire buffer was read. ## -remarks ## -examples ## -see-also [WriteReadPartial](i2cdevice_writereadpartial.md), [Write](i2cdevice_write.md), [Read](i2cdevice_read.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.WriteRead(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.WriteRead + +## -description +Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and sends a restart condition between the write and read operations. + +## -parameters +### -param writeBuffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +### -param readBuffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -exceptions +### 0x80070002 + +The bus address was not acknowledged. + +### 0x8007045D + +The I2 C device negatively acknowledged the data transfer before the entire buffer was read. + +## -remarks + +## -examples + +## -see-also +[WriteReadPartial](i2cdevice_writereadpartial.md), [Write](i2cdevice_write.md), [Read](i2cdevice_read.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/i2cdevice_writereadpartial_776061530.md b/windows.devices.i2c/i2cdevice_writereadpartial_776061530.md index 2375b78994..27e67250f9 100644 --- a/windows.devices.i2c/i2cdevice_writereadpartial_776061530.md +++ b/windows.devices.i2c/i2cdevice_writereadpartial_776061530.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.I2c.I2cDevice.WriteReadPartial(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.I2c.I2cDevice.WriteReadPartial ## -description Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. ## -parameters ### -param writeBuffer A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. ### -param readBuffer The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. ## -returns A structure that contains information about whether both the read and write parts of the operation succeeded and the sum of the actual number of bytes that the operation wrote and the actual number of bytes that the operation read. ## -remarks ## -examples ## -see-also [WriteRead](i2cdevice_writeread.md), [ReadPartial](i2cdevice_readpartial.md), [WritePartial](i2cdevice_writepartial.md), [I2cTransferResult](i2ctransferresult.md), [I2CTransferStatus](i2ctransferstatus.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.I2cDevice.WriteReadPartial(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.I2cDevice.WriteReadPartial + +## -description +Performs an atomic operation to write data to and then read data from the inter-integrated circuit (I2 C) bus on which the device is connected, and returns information about the success of the operation that you can use for error handling. + +## -parameters +### -param writeBuffer +A buffer that contains the data that you want to write to the I2 C device. This data should not include the bus address. + +### -param readBuffer +The buffer to which you want to read the data from the I2 C bus. The length of the buffer determines how much data to request from the device. + +## -returns +A structure that contains information about whether both the read and write parts of the operation succeeded and the sum of the actual number of bytes that the operation wrote and the actual number of bytes that the operation read. + +## -remarks + +## -examples + +## -see-also +[WriteRead](i2cdevice_writeread.md), [ReadPartial](i2cdevice_readpartial.md), [WritePartial](i2cdevice_writepartial.md), [I2cTransferResult](i2ctransferresult.md), [I2CTransferStatus](i2ctransferstatus.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/ii2cdevicestatics_fromidasync.md b/windows.devices.i2c/ii2cdevicestatics_fromidasync.md index 6a9a26b1c6..a2b99c2442 100644 --- a/windows.devices.i2c/ii2cdevicestatics_fromidasync.md +++ b/windows.devices.i2c/ii2cdevicestatics_fromidasync.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.I2c.II2cDeviceStatics.FromIdAsync(System.String,Windows.Devices.I2c.I2cConnectionSettings) --api-type: winrt method ---- # Windows.Devices.I2c.II2cDeviceStatics.FromIdAsync ## -description Retrieves an [I2cDevice](i2cdevice.md) object asynchronously for the inter-integrated circuit (I2 C) bus controller that has the specified plug and play device identifier, using the specified connection settings. ## -parameters ### -param deviceId The plug and play device identifier of the I2 C bus controller for which you want to create an [I2cDevice](i2cdevice.md) object. ### -param settings The connection settings to use for communication with the I2 C bus controller that *deviceId* specifies. ## -returns An asynchronous operation that returns the [I2cDevice](i2cdevice.md) object. ## -remarks ## -examples ## -see-also [I2cConnectionSettings](i2cconnectionsettings.md), [GetDeviceSelector](ii2cdevicestatics_getdeviceselector.md), [I2cDevice.Close](i2cdevice_close.md), [I2cDevice.DeviceId](i2cdevice_deviceid.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.II2cDeviceStatics.FromIdAsync(System.String,Windows.Devices.I2c.I2cConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.II2cDeviceStatics.FromIdAsync + +## -description +Retrieves an [I2cDevice](i2cdevice.md) object asynchronously for the inter-integrated circuit (I2 C) bus controller that has the specified plug and play device identifier, using the specified connection settings. + +## -parameters +### -param deviceId +The plug and play device identifier of the I2 C bus controller for which you want to create an [I2cDevice](i2cdevice.md) object. + +### -param settings +The connection settings to use for communication with the I2 C bus controller that *deviceId* specifies. + +## -returns +An asynchronous operation that returns the [I2cDevice](i2cdevice.md) object. + +## -remarks + +## -examples + +## -see-also +[I2cConnectionSettings](i2cconnectionsettings.md), [GetDeviceSelector](ii2cdevicestatics_getdeviceselector.md), [I2cDevice.Close](i2cdevice_close.md), [I2cDevice.DeviceId](i2cdevice_deviceid.md), [I2cDevice.FromIdAsync](i2cdevice_fromidasync.md) + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_1752695616.md b/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_1752695616.md index 442d8c189b..c5fd07be78 100644 --- a/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_1752695616.md +++ b/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_1752695616.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector(System.String) --api-type: winrt method ---- # Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector ## -description Retrieves an Advanced Query Syntax (AQS) string for the inter-integrated circuit (I2 C) bus that has the specified friendly name. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. ## -parameters ### -param friendlyName A friendly name for the particular I2 C bus on a particular hardware platform for which you want to get the AQS string. ## -returns An AQS string for the I2 C bus that *friendlyName* specifies, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. ## -remarks ## -examples ## -see-also [GetDeviceSelector](ii2cdevicestatics_getdeviceselector_838466080.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [II2cDeviceStatics.FromIdAsync](ii2cdevicestatics_fromidasync.md), [I2cDevice.GetDeviceSelector(String)](i2cdevice_getdeviceselector_1752695616.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string for the inter-integrated circuit (I2 C) bus that has the specified friendly name. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. + +## -parameters +### -param friendlyName +A friendly name for the particular I2 C bus on a particular hardware platform for which you want to get the AQS string. + +## -returns +An AQS string for the I2 C bus that *friendlyName* specifies, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for that bus. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector](ii2cdevicestatics_getdeviceselector_838466080.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [II2cDeviceStatics.FromIdAsync](ii2cdevicestatics_fromidasync.md), [I2cDevice.GetDeviceSelector(String)](i2cdevice_getdeviceselector_1752695616.md) \ No newline at end of file diff --git a/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_838466080.md b/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_838466080.md index 75e3baa15d..3875a4f573 100644 --- a/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_838466080.md +++ b/windows.devices.i2c/ii2cdevicestatics_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector ## -description Retrieves an Advanced Query Syntax (AQS) string for all of the inter-integrated circuit (I2 C) bus controllers on the system. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. ## -returns An AQS string for all of the I2 C bus controllers on the system, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. ## -remarks ## -examples ## -see-also [GetDeviceSelector(String)](ii2cdevicestatics_getdeviceselector_1752695616.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [I2Device.GetDeviceSelector()](i2cdevice_getdeviceselector_838466080.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.I2c.II2cDeviceStatics.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string for all of the inter-integrated circuit (I2 C) bus controllers on the system. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. + +## -returns +An AQS string for all of the I2 C bus controllers on the system, which you can use with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those bus controllers. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(String)](ii2cdevicestatics_getdeviceselector_1752695616.md), [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), [I2Device.GetDeviceSelector()](i2cdevice_getdeviceselector_838466080.md) \ No newline at end of file diff --git a/windows.devices.input/keyboardcapabilities_keyboardcapabilities_1221375020.md b/windows.devices.input/keyboardcapabilities_keyboardcapabilities_1221375020.md index 53ec5fbee7..0410e51aec 100644 --- a/windows.devices.input/keyboardcapabilities_keyboardcapabilities_1221375020.md +++ b/windows.devices.input/keyboardcapabilities_keyboardcapabilities_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Input.KeyboardCapabilities.#ctor --api-type: winrt method ---- # Windows.Devices.Input.KeyboardCapabilities.KeyboardCapabilities ## -description Initializes a new instance of the [KeyboardCapabilities](keyboardcapabilities_keyboardcapabilities.md) class. ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Input.KeyboardCapabilities.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Input.KeyboardCapabilities.KeyboardCapabilities + +## -description +Initializes a new instance of the [KeyboardCapabilities](keyboardcapabilities_keyboardcapabilities.md) class. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/keyboardcapabilities_keyboardpresent.md b/windows.devices.input/keyboardcapabilities_keyboardpresent.md index e763b95a6a..a68a641ac9 100644 --- a/windows.devices.input/keyboardcapabilities_keyboardpresent.md +++ b/windows.devices.input/keyboardcapabilities_keyboardpresent.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Input.KeyboardCapabilities.KeyboardPresent --api-type: winrt property ---- # Windows.Devices.Input.KeyboardCapabilities.KeyboardPresent ## -description Gets a value that indicates whether a device identifying itself as a keyboard is detected. ## -property-value Returns 1 if a device identifying itself as a keyboard is detected. Otherwise, returns 0. ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.KeyboardCapabilities.KeyboardPresent +-api-type: winrt property +--- + + + +# Windows.Devices.Input.KeyboardCapabilities.KeyboardPresent + +## -description +Gets a value that indicates whether a device identifying itself as a keyboard is detected. + +## -property-value +Returns 1 if a device identifying itself as a keyboard is detected. Otherwise, returns 0. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousecapabilities_horizontalwheelpresent.md b/windows.devices.input/mousecapabilities_horizontalwheelpresent.md index 7e2ca6dc33..abe8f55262 100644 --- a/windows.devices.input/mousecapabilities_horizontalwheelpresent.md +++ b/windows.devices.input/mousecapabilities_horizontalwheelpresent.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.Devices.Input.MouseCapabilities.HorizontalWheelPresent --api-type: winrt property ---- # Windows.Devices.Input.MouseCapabilities.HorizontalWheelPresent ## -description Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that tilts left and right (usually for horizontal scrolling). ## -property-value The number of horizontal wheels detected. Typically 0 or 1. ## -remarks ## -examples The following code shows how to use this method. ```html function getMouseCapabilities() { var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); id("horizontalWheelPresent").innerHTML = mouseCapabilities.HorizontalWheelPresent; } ``` ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.MouseCapabilities.HorizontalWheelPresent +-api-type: winrt property +--- + + + +# Windows.Devices.Input.MouseCapabilities.HorizontalWheelPresent + +## -description +Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that tilts left and right (usually for horizontal scrolling). + +## -property-value +The number of horizontal wheels detected. Typically 0 or 1. + +## -remarks + + +## -examples +The following code shows how to use this method. + +```html + function getMouseCapabilities() { + var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); + id("horizontalWheelPresent").innerHTML = mouseCapabilities.HorizontalWheelPresent; + } +``` + + + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousecapabilities_mousecapabilities_1221375020.md b/windows.devices.input/mousecapabilities_mousecapabilities_1221375020.md index 33a6440c55..16aea445f5 100644 --- a/windows.devices.input/mousecapabilities_mousecapabilities_1221375020.md +++ b/windows.devices.input/mousecapabilities_mousecapabilities_1221375020.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Input.MouseCapabilities.#ctor --api-type: winrt method ---- # Windows.Devices.Input.MouseCapabilities.MouseCapabilities ## -description Initializes a new instance of the [MouseCapabilities](mousecapabilities_mousecapabilities.md) class. ## -remarks ## -examples The following code shows how to create an instance of the [MouseCapabilities](mousecapabilities_mousecapabilities.md) class. ```javascript function getMouseCapabilities() { var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); } ``` ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Input.MouseCapabilities.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Input.MouseCapabilities.MouseCapabilities + +## -description +Initializes a new instance of the [MouseCapabilities](mousecapabilities_mousecapabilities.md) class. + +## -remarks + +## -examples +The following code shows how to create an instance of the [MouseCapabilities](mousecapabilities_mousecapabilities.md) class. + +```javascript +function getMouseCapabilities() { + var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); +} + +``` + + + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousecapabilities_mousepresent.md b/windows.devices.input/mousecapabilities_mousepresent.md index ad278d085e..3c9640234b 100644 --- a/windows.devices.input/mousecapabilities_mousepresent.md +++ b/windows.devices.input/mousecapabilities_mousepresent.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Input.MouseCapabilities.MousePresent --api-type: winrt property ---- # Windows.Devices.Input.MouseCapabilities.MousePresent ## -description Gets a value that indicates whether a mouse device is detected. ## -property-value The number of mouse devices detected. Typically 0 or 1. ## -remarks ## -examples The following code shows how to use this method. ```html function getMouseCapabilities() { var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); id("mousePresent").innerHTML = mouseCapabilities.MousePresent; } ``` ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.MouseCapabilities.MousePresent +-api-type: winrt property +--- + + + +# Windows.Devices.Input.MouseCapabilities.MousePresent + +## -description +Gets a value that indicates whether a mouse device is detected. + +## -property-value +The number of mouse devices detected. Typically 0 or 1. + +## -remarks + +## -examples +The following code shows how to use this method. + +```html + function getMouseCapabilities() { + var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); + id("mousePresent").innerHTML = mouseCapabilities.MousePresent; + } +``` + + + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousecapabilities_numberofbuttons.md b/windows.devices.input/mousecapabilities_numberofbuttons.md index 9f3a1db536..affdae6934 100644 --- a/windows.devices.input/mousecapabilities_numberofbuttons.md +++ b/windows.devices.input/mousecapabilities_numberofbuttons.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Input.MouseCapabilities.NumberOfButtons --api-type: winrt property ---- # Windows.Devices.Input.MouseCapabilities.NumberOfButtons ## -description Gets a value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons. ## -property-value A value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons. ## -remarks ## -examples The following code shows how to use this method. ```html function getMouseCapabilities() { var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); id("numberOfButtons").innerHTML = mouseCapabilities.NumberOfButtons; } ``` ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.MouseCapabilities.NumberOfButtons +-api-type: winrt property +--- + + + +# Windows.Devices.Input.MouseCapabilities.NumberOfButtons + +## -description +Gets a value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons. + +## -property-value +A value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons. + +## -remarks + +## -examples +The following code shows how to use this method. + +```html + function getMouseCapabilities() { + var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); + id("numberOfButtons").innerHTML = mouseCapabilities.NumberOfButtons; + } +``` + + + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousecapabilities_swapbuttons.md b/windows.devices.input/mousecapabilities_swapbuttons.md index dab2e36a1b..9fd2a57129 100644 --- a/windows.devices.input/mousecapabilities_swapbuttons.md +++ b/windows.devices.input/mousecapabilities_swapbuttons.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Input.MouseCapabilities.SwapButtons --api-type: winrt property ---- # Windows.Devices.Input.MouseCapabilities.SwapButtons ## -description Gets a value indicating whether any of the mice connected to the computer has swapped left and right buttons. ## -property-value A value indicating whether any of the mice connected to the computer has swapped left and right buttons. ## -remarks ## -examples The following code shows how to use this method. ```html function getMouseCapabilities() { var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); id("swapButtons").innerHTML = mouseCapabilities.SwapButtons; } ``` ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.MouseCapabilities.SwapButtons +-api-type: winrt property +--- + + + +# Windows.Devices.Input.MouseCapabilities.SwapButtons + +## -description +Gets a value indicating whether any of the mice connected to the computer has swapped left and right buttons. + +## -property-value +A value indicating whether any of the mice connected to the computer has swapped left and right buttons. + +## -remarks + +## -examples +The following code shows how to use this method. + +```html + function getMouseCapabilities() { + var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); + id("swapButtons").innerHTML = mouseCapabilities.SwapButtons; + } +``` + + + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousecapabilities_verticalwheelpresent.md b/windows.devices.input/mousecapabilities_verticalwheelpresent.md index 99cbc3506d..51a5c4bfb3 100644 --- a/windows.devices.input/mousecapabilities_verticalwheelpresent.md +++ b/windows.devices.input/mousecapabilities_verticalwheelpresent.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Input.MouseCapabilities.VerticalWheelPresent --api-type: winrt property ---- # Windows.Devices.Input.MouseCapabilities.VerticalWheelPresent ## -description Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that rolls up and down (usually for vertical scrolling). ## -property-value The number of vertical wheels detected. Typically 0 or 1. ## -remarks ## -examples The following code shows how to use this method. ```html function getMouseCapabilities() { var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); id("verticalWheelPresent").innerHTML = mouseCapabilities.VerticalWheelPresent; } ``` ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.MouseCapabilities.VerticalWheelPresent +-api-type: winrt property +--- + + + +# Windows.Devices.Input.MouseCapabilities.VerticalWheelPresent + +## -description +Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that rolls up and down (usually for vertical scrolling). + +## -property-value +The number of vertical wheels detected. Typically 0 or 1. + +## -remarks + +## -examples +The following code shows how to use this method. + +```html + function getMouseCapabilities() { + var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities(); + id("verticalWheelPresent").innerHTML = mouseCapabilities.VerticalWheelPresent; + } +``` + + + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/mousedevice_getforcurrentview_1363600702.md b/windows.devices.input/mousedevice_getforcurrentview_1363600702.md index 124f70e8bd..0f89eb109d 100644 --- a/windows.devices.input/mousedevice_getforcurrentview_1363600702.md +++ b/windows.devices.input/mousedevice_getforcurrentview_1363600702.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Input.MouseDevice.GetForCurrentView --api-type: winrt method ---- # Windows.Devices.Input.MouseDevice.GetForCurrentView ## -description Retrieves the mouse device that is associated with the current view. ## -returns The mouse device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Input.MouseDevice.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Devices.Input.MouseDevice.GetForCurrentView + +## -description +Retrieves the mouse device that is associated with the current view. + +## -returns +The mouse device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.input/mousedevice_mousemoved.md b/windows.devices.input/mousedevice_mousemoved.md index 37a98aa0fd..23643e91fa 100644 --- a/windows.devices.input/mousedevice_mousemoved.md +++ b/windows.devices.input/mousedevice_mousemoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Input.MouseDevice.MouseMoved --api-type: winrt event ---- # Windows.Devices.Input.MouseDevice.MouseMoved ## -description Occurs when the mouse pointer is moved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Input.MouseDevice.MouseMoved +-api-type: winrt event +--- + + + +# Windows.Devices.Input.MouseDevice.MouseMoved + +## -description +Occurs when the mouse pointer is moved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.input/mouseeventargs_mousedelta.md b/windows.devices.input/mouseeventargs_mousedelta.md index b969811b19..b65fa686b9 100644 --- a/windows.devices.input/mouseeventargs_mousedelta.md +++ b/windows.devices.input/mouseeventargs_mousedelta.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Input.MouseEventArgs.MouseDelta --api-type: winrt property ---- # Windows.Devices.Input.MouseEventArgs.MouseDelta ## -description Gets a value that indicates the change in the screen location of the mouse pointer since the last mouse event. ## -property-value The change in screen location of the mouse pointer, relative to the location of the last mouse event. ## -remarks ## -examples ## -see-also [MouseMoved](mousedevice_mousemoved.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.MouseEventArgs.MouseDelta +-api-type: winrt property +--- + + + +# Windows.Devices.Input.MouseEventArgs.MouseDelta + +## -description +Gets a value that indicates the change in the screen location of the mouse pointer since the last mouse event. + +## -property-value +The change in screen location of the mouse pointer, relative to the location of the last mouse event. + +## -remarks + +## -examples + +## -see-also +[MouseMoved](mousedevice_mousemoved.md) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_getpointerdevice_227282961.md b/windows.devices.input/pointerdevice_getpointerdevice_227282961.md index bda03b61ff..1bf915b739 100644 --- a/windows.devices.input/pointerdevice_getpointerdevice_227282961.md +++ b/windows.devices.input/pointerdevice_getpointerdevice_227282961.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Input.PointerDevice.GetPointerDevice(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Input.PointerDevice.GetPointerDevice ## -description Gets information about the pointer device associated with the specified input pointer ID. ## -parameters ### -param pointerId The ID of the pointer input. ## -returns The [PointerDevice](pointerdevice.md) object that represents the associated pointer device. ## -remarks [GetPointerDevice](pointerdevice_getpointerdevice.md) is a static method. The input pointer specified by *pointerId* must identify an active input. ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Input.PointerDevice.GetPointerDevice(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Input.PointerDevice.GetPointerDevice + +## -description +Gets information about the pointer device associated with the specified input pointer ID. + +## -parameters +### -param pointerId +The ID of the pointer input. + +## -returns +The [PointerDevice](pointerdevice.md) object that represents the associated pointer device. + +## -remarks +[GetPointerDevice](pointerdevice_getpointerdevice.md) is a static method. + +The input pointer specified by *pointerId* must identify an active input. + + + + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_getpointerdevices_715093210.md b/windows.devices.input/pointerdevice_getpointerdevices_715093210.md index f4cd6bad83..51ac4cbcd8 100644 --- a/windows.devices.input/pointerdevice_getpointerdevices_715093210.md +++ b/windows.devices.input/pointerdevice_getpointerdevices_715093210.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Input.PointerDevice.GetPointerDevices --api-type: winrt method ---- # Windows.Devices.Input.PointerDevice.GetPointerDevices ## -description Gets information about the pointer devices attached to the system. ## -returns The collection of [PointerDevice](pointerdevice.md) objects that represent the pointer devices attached to the system. ## -remarks [GetPointerDevices](pointerdevice_getpointerdevices.md) is a static method. ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Input.PointerDevice.GetPointerDevices +-api-type: winrt method +--- + + + +# Windows.Devices.Input.PointerDevice.GetPointerDevices + +## -description +Gets information about the pointer devices attached to the system. + +## -returns +The collection of [PointerDevice](pointerdevice.md) objects that represent the pointer devices attached to the system. + +## -remarks +[GetPointerDevices](pointerdevice_getpointerdevices.md) is a static method. + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_maxcontacts.md b/windows.devices.input/pointerdevice_maxcontacts.md index 5fa07aed42..0f4efa973c 100644 --- a/windows.devices.input/pointerdevice_maxcontacts.md +++ b/windows.devices.input/pointerdevice_maxcontacts.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Input.PointerDevice.MaxContacts --api-type: winrt property ---- # Windows.Devices.Input.PointerDevice.MaxContacts ## -description Gets a value indicating the maximum number of contacts supported by the input device. ## -property-value The number of contacts. ## -remarks This property typically returns a value of 5 or more for touch devices and 1 for mouse and pen/stylus devices. ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.PointerDevice.MaxContacts +-api-type: winrt property +--- + + + +# Windows.Devices.Input.PointerDevice.MaxContacts + +## -description +Gets a value indicating the maximum number of contacts supported by the input device. + +## -property-value +The number of contacts. + +## -remarks +This property typically returns a value of 5 or more for touch devices and 1 for mouse and pen/stylus devices. + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_maxpointerswithzdistance.md b/windows.devices.input/pointerdevice_maxpointerswithzdistance.md index 980b0331e4..80cbfb600e 100644 --- a/windows.devices.input/pointerdevice_maxpointerswithzdistance.md +++ b/windows.devices.input/pointerdevice_maxpointerswithzdistance.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Input.PointerDevice.MaxPointersWithZDistance --api-type: winrt property ---- # Windows.Devices.Input.PointerDevice.MaxPointersWithZDistance ## -description Gets the maximum number of hover contacts supported by the input device. ## -property-value The default value is 0. > [!NOTE] > [MaxPointersWithZDistance](pointerdevice_maxpointerswithzdistance.md) might not be equal to [MaxContacts](pointerdevice_maxcontacts.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.PointerDevice.MaxPointersWithZDistance +-api-type: winrt property +--- + + + +# Windows.Devices.Input.PointerDevice.MaxPointersWithZDistance + +## -description +Gets the maximum number of hover contacts supported by the input device. + +## -property-value +The default value is 0. + +> [!NOTE] +> [MaxPointersWithZDistance](pointerdevice_maxpointerswithzdistance.md) might not be equal to [MaxContacts](pointerdevice_maxcontacts.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.input/pointerdevice_physicaldevicerect.md b/windows.devices.input/pointerdevice_physicaldevicerect.md index c6f4378111..46c9dc679e 100644 --- a/windows.devices.input/pointerdevice_physicaldevicerect.md +++ b/windows.devices.input/pointerdevice_physicaldevicerect.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Input.PointerDevice.PhysicalDeviceRect --api-type: winrt property ---- # Windows.Devices.Input.PointerDevice.PhysicalDeviceRect ## -description Gets the coordinates of the bounding rectangle supported by the input device. ## -property-value The bounding rectangle at 96 dots per inch (dpi). ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.PointerDevice.PhysicalDeviceRect +-api-type: winrt property +--- + + + +# Windows.Devices.Input.PointerDevice.PhysicalDeviceRect + +## -description +Gets the coordinates of the bounding rectangle supported by the input device. + +## -property-value +The bounding rectangle at 96 dots per inch (dpi). + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_pointerdevicetype.md b/windows.devices.input/pointerdevice_pointerdevicetype.md index bb2dd8388d..d5cc9fd8e4 100644 --- a/windows.devices.input/pointerdevice_pointerdevicetype.md +++ b/windows.devices.input/pointerdevice_pointerdevicetype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Input.PointerDevice.PointerDeviceType --api-type: winrt property ---- # Windows.Devices.Input.PointerDevice.PointerDeviceType ## -description Gets the pointer device type. ## -property-value A pointer device type. ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.PointerDevice.PointerDeviceType +-api-type: winrt property +--- + + + +# Windows.Devices.Input.PointerDevice.PointerDeviceType + +## -description +Gets the pointer device type. + +## -property-value +A pointer device type. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_screenrect.md b/windows.devices.input/pointerdevice_screenrect.md index 8fb451a192..1792c3faec 100644 --- a/windows.devices.input/pointerdevice_screenrect.md +++ b/windows.devices.input/pointerdevice_screenrect.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Input.PointerDevice.ScreenRect --api-type: winrt property ---- # Windows.Devices.Input.PointerDevice.ScreenRect ## -description Gets the screen coordinates that are mapped to the bounding rectangle supported by the input device. ## -property-value The screen coordinates, in device-independent pixel (DIP). ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.PointerDevice.ScreenRect +-api-type: winrt property +--- + + + +# Windows.Devices.Input.PointerDevice.ScreenRect + +## -description +Gets the screen coordinates that are mapped to the bounding rectangle supported by the input device. + +## -property-value +The screen coordinates, in device-independent pixel (DIP). + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/pointerdevice_supportedusages.md b/windows.devices.input/pointerdevice_supportedusages.md index e059522276..bc0b9cdbfa 100644 --- a/windows.devices.input/pointerdevice_supportedusages.md +++ b/windows.devices.input/pointerdevice_supportedusages.md @@ -1,3 +1,32 @@ ---- -api-id: P:Windows.Devices.Input.PointerDevice.SupportedUsages --api-type: winrt property ---- # Windows.Devices.Input.PointerDevice.SupportedUsages ## -description Gets a collection containing the supported [pointer device usages](pointerdeviceusage.md). ## -property-value A collection containing the supported pointer device usages. ## -remarks A Human Interface Device (HID) usage describes what a Human Interface Device (HID)-compliant control is measuring or reporting and can also indicate the control's intended use. A specific control usage is defined by its usage page, a usage ID, a name, and a description. For more info, see [Device Class Definition for ](http://go.microsoft.com/fwlink/p/?linkid=155094). > [!NOTE] > The core of the Microsoft interactive input device architecture is based on the Universal Serial Bus (USB) standard Device Class Definition for Human Interface Device (HID), which is defined by the [ Implementers Forum, Inc.](http://go.microsoft.com/fwlink/p/?linkid=233171) The Universal Serial Bus (USB) Human Interface Device (HID) standard defines the configuration and communication protocols for Human Interface Device (HID), such as keyboards, mouse devices, joysticks, and virtual reality devices, that humans use to enter data directly into a computer. (For detailed information about the USB HID standard, see the [USB Implementers Forum](http://go.microsoft.com/fwlink/p/?linkid=233171) website.) Although the core of the Windows input architecture is based on the Universal Serial Bus (USB) Human Interface Device (HID) standard, the architecture is not limited to Universal Serial Bus (USB) devices. The input architecture also supports serial port devices, i8042 port devices, and proprietary input devices. ## -examples ## -see-also [PointerDeviceUsage](pointerdeviceusage.md), [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.PointerDevice.SupportedUsages +-api-type: winrt property +--- + + + +# Windows.Devices.Input.PointerDevice.SupportedUsages + +## -description +Gets a collection containing the supported [pointer device usages](pointerdeviceusage.md). + +## -property-value +A collection containing the supported pointer device usages. + +## -remarks +A Human Interface Device (HID) usage describes what a Human Interface Device (HID)-compliant control is measuring or reporting and can also indicate the control's intended use. A specific control usage is defined by its usage page, a usage ID, a name, and a description. For more info, see [Device Class Definition +for ](http://go.microsoft.com/fwlink/p/?linkid=155094). + +> [!NOTE] +> The core of the Microsoft interactive input device architecture is based on the Universal Serial Bus (USB) standard Device Class Definition for Human Interface Device (HID), which is defined by the [ Implementers Forum, Inc.](http://go.microsoft.com/fwlink/p/?linkid=233171) + +The Universal Serial Bus (USB) Human Interface Device (HID) standard defines the configuration and communication protocols for Human Interface Device (HID), such as keyboards, mouse devices, joysticks, and virtual reality devices, that humans use to enter data directly into a computer. (For detailed information about the USB HID standard, see the [USB Implementers Forum](http://go.microsoft.com/fwlink/p/?linkid=233171) website.) + +Although the core of the Windows input architecture is based on the Universal Serial Bus (USB) Human Interface Device (HID) standard, the architecture is not limited to Universal Serial Bus (USB) devices. The input architecture also supports serial port devices, i8042 port devices, and proprietary input devices. + +## -examples + +## -see-also +[PointerDeviceUsage](pointerdeviceusage.md), [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/touchcapabilities_contacts.md b/windows.devices.input/touchcapabilities_contacts.md index 8eeaca6863..cf8244905d 100644 --- a/windows.devices.input/touchcapabilities_contacts.md +++ b/windows.devices.input/touchcapabilities_contacts.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Input.TouchCapabilities.Contacts --api-type: winrt property ---- # Windows.Devices.Input.TouchCapabilities.Contacts ## -description Gets the minimum number of contacts supported by all the digitizers. ## -property-value Gets the minimum number of contacts supported by all the digitizers. ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.TouchCapabilities.Contacts +-api-type: winrt property +--- + + + +# Windows.Devices.Input.TouchCapabilities.Contacts + +## -description +Gets the minimum number of contacts supported by all the digitizers. + +## -property-value +Gets the minimum number of contacts supported by all the digitizers. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/touchcapabilities_touchcapabilities_1221375020.md b/windows.devices.input/touchcapabilities_touchcapabilities_1221375020.md index ad03f0d64f..edd86adbce 100644 --- a/windows.devices.input/touchcapabilities_touchcapabilities_1221375020.md +++ b/windows.devices.input/touchcapabilities_touchcapabilities_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Input.TouchCapabilities.#ctor --api-type: winrt method ---- # Windows.Devices.Input.TouchCapabilities.TouchCapabilities ## -description Initializes a new instance of the [TouchCapabilities](touchcapabilities_touchcapabilities.md) class. ## -remarks ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Input.TouchCapabilities.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Input.TouchCapabilities.TouchCapabilities + +## -description +Initializes a new instance of the [TouchCapabilities](touchcapabilities_touchcapabilities.md) class. + +## -remarks + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.input/touchcapabilities_touchpresent.md b/windows.devices.input/touchcapabilities_touchpresent.md index 66e38a2ccc..c9b21b8742 100644 --- a/windows.devices.input/touchcapabilities_touchpresent.md +++ b/windows.devices.input/touchcapabilities_touchpresent.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Input.TouchCapabilities.TouchPresent --api-type: winrt property ---- # Windows.Devices.Input.TouchCapabilities.TouchPresent ## -description Gets a value that indicates whether a touch digitizer is detected. ## -property-value The number of touch digitizers detected. Typically 0 or 1. ## -remarks This property always returns 1 if an instance of the Microsoft Visual Studio simulator is running. ## -examples ## -see-also [Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Input.TouchCapabilities.TouchPresent +-api-type: winrt property +--- + + + +# Windows.Devices.Input.TouchCapabilities.TouchPresent + +## -description +Gets a value that indicates whether a touch digitizer is detected. + +## -property-value +The number of touch digitizers detected. Typically 0 or 1. + +## -remarks +This property always returns 1 if an instance of the Microsoft Visual Studio simulator is running. + +## -examples + +## -see-also +[Quickstart: Identifying input devices](http://msdn.microsoft.com/library/7001b56d-081b-4683-84bb-24c361397c08) \ No newline at end of file diff --git a/windows.devices.lights/lamp.md b/windows.devices.lights/lamp.md index c552295ebc..69597db8eb 100644 --- a/windows.devices.lights/lamp.md +++ b/windows.devices.lights/lamp.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Lights.Lamp --api-type: winrt class ---- # Windows.Devices.Lights.Lamp ## -description Represents a lamp device. ## -remarks A common scenario for using this class is adding a flashlight feature to your app that allows the user to manually turn on and off a device's camera torch light, if one is available. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Lights.Lamp +-api-type: winrt class +--- + + + +# Windows.Devices.Lights.Lamp + +## -description +Represents a lamp device. + +## -remarks +A common scenario for using this class is adding a flashlight feature to your app that allows the user to manually turn on and off a device's camera torch light, if one is available. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.lights/lamp_availabilitychanged.md b/windows.devices.lights/lamp_availabilitychanged.md index 1b4d77da07..67b725b606 100644 --- a/windows.devices.lights/lamp_availabilitychanged.md +++ b/windows.devices.lights/lamp_availabilitychanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Lights.Lamp.AvailabilityChanged --api-type: winrt event ---- # Windows.Devices.Lights.Lamp.AvailabilityChanged ## -description Occurs when the availability of the lamp device changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Lights.Lamp.AvailabilityChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Lights.Lamp.AvailabilityChanged + +## -description +Occurs when the availability of the lamp device changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_brightnesslevel.md b/windows.devices.lights/lamp_brightnesslevel.md index d15a226632..29dabf5db8 100644 --- a/windows.devices.lights/lamp_brightnesslevel.md +++ b/windows.devices.lights/lamp_brightnesslevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Lights.Lamp.BrightnessLevel --api-type: winrt property ---- # Windows.Devices.Lights.Lamp.BrightnessLevel ## -description Gets or sets a value indicating the current brightness level of the lamp, where 0.0 is completely off and 1.0 is maximum brightness. ## -property-value A value indicating the current brightness level of the lamp. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Lights.Lamp.BrightnessLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Lights.Lamp.BrightnessLevel + +## -description +Gets or sets a value indicating the current brightness level of the lamp, where 0.0 is completely off and 1.0 is maximum brightness. + +## -property-value +A value indicating the current brightness level of the lamp. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_close_811482585.md b/windows.devices.lights/lamp_close_811482585.md index 4ba04fe66e..9e56bc985e 100644 --- a/windows.devices.lights/lamp_close_811482585.md +++ b/windows.devices.lights/lamp_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Lights.Lamp.Close --api-type: winrt method ---- # Windows.Devices.Lights.Lamp.Close ## -description Releases the lamp device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Lights.Lamp.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Lights.Lamp.Close + +## -description +Releases the lamp device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_color.md b/windows.devices.lights/lamp_color.md index e480988872..88256f5569 100644 --- a/windows.devices.lights/lamp_color.md +++ b/windows.devices.lights/lamp_color.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Lights.Lamp.Color --api-type: winrt property ---- # Windows.Devices.Lights.Lamp.Color ## -description Gets or sets the color of the lamp. ## -property-value The color of the lamp. ## -remarks The alpha channel of the color is ignored by this API. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Lights.Lamp.Color +-api-type: winrt property +--- + + + +# Windows.Devices.Lights.Lamp.Color + +## -description +Gets or sets the color of the lamp. + +## -property-value +The color of the lamp. + +## -remarks +The alpha channel of the color is ignored by this API. + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_deviceid.md b/windows.devices.lights/lamp_deviceid.md index 7939dc734d..013b853b27 100644 --- a/windows.devices.lights/lamp_deviceid.md +++ b/windows.devices.lights/lamp_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Lights.Lamp.DeviceId --api-type: winrt property ---- # Windows.Devices.Lights.Lamp.DeviceId ## -description Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a lamp device. ## -property-value The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a lamp device. ## -remarks Pass this ID to the [FromIdAsync](lamp_fromidasync.md) method to retrieve the associated [Lamp](lamp.md) object. Implement a handler for the [DeviceWatcher.Removed](../windows.devices.enumeration/devicewatcher_removed.md) event and compare the ID of the [DeviceInformationUpdate](../windows.devices.enumeration/deviceinformationupdate.md) argument to the ID of a [Lamp](lamp.md) object to be notified if the device becomes unavailable. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Lights.Lamp.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Lights.Lamp.DeviceId + +## -description +Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a lamp device. + +## -property-value +The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a lamp device. + +## -remarks +Pass this ID to the [FromIdAsync](lamp_fromidasync.md) method to retrieve the associated [Lamp](lamp.md) object. Implement a handler for the [DeviceWatcher.Removed](../windows.devices.enumeration/devicewatcher_removed.md) event and compare the ID of the [DeviceInformationUpdate](../windows.devices.enumeration/deviceinformationupdate.md) argument to the ID of a [Lamp](lamp.md) object to be notified if the device becomes unavailable. + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_fromidasync_1322863552.md b/windows.devices.lights/lamp_fromidasync_1322863552.md index ee24c4e654..b641b12e4c 100644 --- a/windows.devices.lights/lamp_fromidasync_1322863552.md +++ b/windows.devices.lights/lamp_fromidasync_1322863552.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Lights.Lamp.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Lights.Lamp.FromIdAsync ## -description Gets a [Lamp](lamp.md) object representing the lamp device with the specified ID. ## -parameters ### -param deviceId The ID of the requested lamp device. ## -returns An asynchronous operation that returns a [Lamp](lamp.md) object upon successful completion. ## -remarks Use [GetDefaultAsync](lamp_getdefaultasync.md) to get the default lamp for a device. Enumerate lamp devices by passing the class selection string returned by the [GetDeviceSelector](lamp_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. Once retrieved, use the [DeviceId](lamp_deviceid.md) property to retrieve the ID for the associated lamp. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Lights.Lamp.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Lights.Lamp.FromIdAsync + +## -description +Gets a [Lamp](lamp.md) object representing the lamp device with the specified ID. + +## -parameters +### -param deviceId +The ID of the requested lamp device. + +## -returns +An asynchronous operation that returns a [Lamp](lamp.md) object upon successful completion. + +## -remarks +Use [GetDefaultAsync](lamp_getdefaultasync.md) to get the default lamp for a device. Enumerate lamp devices by passing the class selection string returned by the [GetDeviceSelector](lamp_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. Once retrieved, use the [DeviceId](lamp_deviceid.md) property to retrieve the ID for the associated lamp. + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_getdefaultasync_1549573963.md b/windows.devices.lights/lamp_getdefaultasync_1549573963.md index 4c153d8334..8641fc3d28 100644 --- a/windows.devices.lights/lamp_getdefaultasync_1549573963.md +++ b/windows.devices.lights/lamp_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Lights.Lamp.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Lights.Lamp.GetDefaultAsync ## -description Gets a [Lamp](lamp.md) object representing the default lamp for the device. ## -returns An asynchronous operation that returns a [Lamp](lamp.md) object upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Lights.Lamp.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Lights.Lamp.GetDefaultAsync + +## -description +Gets a [Lamp](lamp.md) object representing the default lamp for the device. + +## -returns +An asynchronous operation that returns a [Lamp](lamp.md) object upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_getdeviceselector_838466080.md b/windows.devices.lights/lamp_getdeviceselector_838466080.md index 730f15ac1f..f71e0ee6e9 100644 --- a/windows.devices.lights/lamp_getdeviceselector_838466080.md +++ b/windows.devices.lights/lamp_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Lights.Lamp.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Lights.Lamp.GetDeviceSelector ## -description Returns the class selection string that you can use to enumerate lamp devices. ## -returns The class selection string for lamp devices. ## -remarks You can enumerate lamp devices by passing the class selection string returned by the [GetDeviceSelector](lamp_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Lights.Lamp.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Lights.Lamp.GetDeviceSelector + +## -description +Returns the class selection string that you can use to enumerate lamp devices. + +## -returns +The class selection string for lamp devices. + +## -remarks +You can enumerate lamp devices by passing the class selection string returned by the [GetDeviceSelector](lamp_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_iscolorsettable.md b/windows.devices.lights/lamp_iscolorsettable.md index bc0067c3a3..6ff3466da2 100644 --- a/windows.devices.lights/lamp_iscolorsettable.md +++ b/windows.devices.lights/lamp_iscolorsettable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Lights.Lamp.IsColorSettable --api-type: winrt property ---- # Windows.Devices.Lights.Lamp.IsColorSettable ## -description Gets a value indicating whether you can set the [Color](lamp_color.md) property of the lamp device. ## -property-value True if you can set the [Color](lamp_color.md) property of the lamp; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Lights.Lamp.IsColorSettable +-api-type: winrt property +--- + + + +# Windows.Devices.Lights.Lamp.IsColorSettable + +## -description +Gets a value indicating whether you can set the [Color](lamp_color.md) property of the lamp device. + +## -property-value +True if you can set the [Color](lamp_color.md) property of the lamp; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.lights/lamp_isenabled.md b/windows.devices.lights/lamp_isenabled.md index 58c17fac2f..fdfee98849 100644 --- a/windows.devices.lights/lamp_isenabled.md +++ b/windows.devices.lights/lamp_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Lights.Lamp.IsEnabled --api-type: winrt property ---- # Windows.Devices.Lights.Lamp.IsEnabled ## -description Gets a value indicating whether the lamp device is enabled. ## -property-value True if the lamp is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Lights.Lamp.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Lights.Lamp.IsEnabled + +## -description +Gets a value indicating whether the lamp device is enabled. + +## -property-value +True if the lamp is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.lights/lampavailabilitychangedeventargs.md b/windows.devices.lights/lampavailabilitychangedeventargs.md index ec5a661f9b..93f3bde2da 100644 --- a/windows.devices.lights/lampavailabilitychangedeventargs.md +++ b/windows.devices.lights/lampavailabilitychangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Lights.LampAvailabilityChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Lights.LampAvailabilityChangedEventArgs ## -description Provides data for the [AvailabilityChanged](lamp_availabilitychanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Lights.LampAvailabilityChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Lights.LampAvailabilityChangedEventArgs + +## -description +Provides data for the [AvailabilityChanged](lamp_availabilitychanged.md) event. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.lights/lampavailabilitychangedeventargs_isavailable.md b/windows.devices.lights/lampavailabilitychangedeventargs_isavailable.md index bbd9a83d41..e9e235039b 100644 --- a/windows.devices.lights/lampavailabilitychangedeventargs_isavailable.md +++ b/windows.devices.lights/lampavailabilitychangedeventargs_isavailable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Lights.LampAvailabilityChangedEventArgs.IsAvailable --api-type: winrt property ---- # Windows.Devices.Lights.LampAvailabilityChangedEventArgs.IsAvailable ## -description Gets a value indicating whether the lamp device that triggered the event is available. ## -property-value True if the lamp device is available; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Lights.LampAvailabilityChangedEventArgs.IsAvailable +-api-type: winrt property +--- + + + +# Windows.Devices.Lights.LampAvailabilityChangedEventArgs.IsAvailable + +## -description +Gets a value indicating whether the lamp device that triggered the event is available. + +## -property-value +True if the lamp device is available; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/imidimessage_rawdata.md b/windows.devices.midi/imidimessage_rawdata.md index 4f971cb9e9..5c18587160 100644 --- a/windows.devices.midi/imidimessage_rawdata.md +++ b/windows.devices.midi/imidimessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.IMidiMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.IMidiMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.IMidiMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.IMidiMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/imidimessage_timestamp.md b/windows.devices.midi/imidimessage_timestamp.md index 59b987afe2..bc19d4a5af 100644 --- a/windows.devices.midi/imidimessage_timestamp.md +++ b/windows.devices.midi/imidimessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.IMidiMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.IMidiMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.IMidiMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.IMidiMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/imidimessage_type.md b/windows.devices.midi/imidimessage_type.md index 9782e10ff7..1884943fc6 100644 --- a/windows.devices.midi/imidimessage_type.md +++ b/windows.devices.midi/imidimessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.IMidiMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.IMidiMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.IMidiMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.IMidiMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/imidioutport_deviceid.md b/windows.devices.midi/imidioutport_deviceid.md index 6a23ec9831..98516c3897 100644 --- a/windows.devices.midi/imidioutport_deviceid.md +++ b/windows.devices.midi/imidioutport_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.IMidiOutPort.DeviceId --api-type: winrt property ---- # Windows.Devices.Midi.IMidiOutPort.DeviceId ## -description Gets the ID of the device that contains the MIDI out port. ## -property-value The device ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.IMidiOutPort.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.IMidiOutPort.DeviceId + +## -description +Gets the ID of the device that contains the MIDI out port. + +## -property-value +The device ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/imidioutport_sendbuffer.md b/windows.devices.midi/imidioutport_sendbuffer.md index 441632b7e9..7868c52fcd 100644 --- a/windows.devices.midi/imidioutport_sendbuffer.md +++ b/windows.devices.midi/imidioutport_sendbuffer.md @@ -1,23 +1,23 @@ ---- --api-id: M:Windows.Devices.Midi.IMidiOutPort.SendBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- - - - -# Windows.Devices.Midi.IMidiOutPort.SendBuffer - -## -description -Sends the contents of the buffer through the MIDI out port. - -## -parameters -### -param midiData -The data to send to the device. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Midi.IMidiOutPort.SendBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.IMidiOutPort.SendBuffer + +## -description +Sends the contents of the buffer through the MIDI out port. + +## -parameters +### -param midiData +The data to send to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/imidioutport_sendmessage.md b/windows.devices.midi/imidioutport_sendmessage.md index d6b0d63389..ff089d3f67 100644 --- a/windows.devices.midi/imidioutport_sendmessage.md +++ b/windows.devices.midi/imidioutport_sendmessage.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.IMidiOutPort.SendMessage(Windows.Devices.Midi.IMidiMessage) --api-type: winrt method ---- # Windows.Devices.Midi.IMidiOutPort.SendMessage ## -description Send the data in the specified MIDI message to the device associated with this [MidiOutPort](midioutport.md). ## -parameters ### -param midiMessage The MIDI message to send to the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.IMidiOutPort.SendMessage(Windows.Devices.Midi.IMidiMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.IMidiOutPort.SendMessage + +## -description +Send the data in the specified MIDI message to the device associated with this [MidiOutPort](midioutport.md). + +## -parameters +### -param midiMessage +The MIDI message to send to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiactivesensingmessage.md b/windows.devices.midi/midiactivesensingmessage.md index 94437fe2d8..46b3b7f15d 100644 --- a/windows.devices.midi/midiactivesensingmessage.md +++ b/windows.devices.midi/midiactivesensingmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiActiveSensingMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiActiveSensingMessage ## -description Represents a MIDI message that specifies active sensing. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiActiveSensingMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiActiveSensingMessage + +## -description +Represents a MIDI message that specifies active sensing. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midiactivesensingmessage_midiactivesensingmessage_1221375020.md b/windows.devices.midi/midiactivesensingmessage_midiactivesensingmessage_1221375020.md index b978728fa7..5fa0417c20 100644 --- a/windows.devices.midi/midiactivesensingmessage_midiactivesensingmessage_1221375020.md +++ b/windows.devices.midi/midiactivesensingmessage_midiactivesensingmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiActiveSensingMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiActiveSensingMessage.MidiActiveSensingMessage ## -description Creates a new [MidiActiveSensingMessage](midiactivesensingmessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiActiveSensingMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiActiveSensingMessage.MidiActiveSensingMessage + +## -description +Creates a new [MidiActiveSensingMessage](midiactivesensingmessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiactivesensingmessage_rawdata.md b/windows.devices.midi/midiactivesensingmessage_rawdata.md index 7ff0185a78..552a973f87 100644 --- a/windows.devices.midi/midiactivesensingmessage_rawdata.md +++ b/windows.devices.midi/midiactivesensingmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiActiveSensingMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiActiveSensingMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiActiveSensingMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiActiveSensingMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiactivesensingmessage_timestamp.md b/windows.devices.midi/midiactivesensingmessage_timestamp.md index b720bd1bbb..b266a81dcd 100644 --- a/windows.devices.midi/midiactivesensingmessage_timestamp.md +++ b/windows.devices.midi/midiactivesensingmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiActiveSensingMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiActiveSensingMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiActiveSensingMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiActiveSensingMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiactivesensingmessage_type.md b/windows.devices.midi/midiactivesensingmessage_type.md index c30ad7c378..5157404a4f 100644 --- a/windows.devices.midi/midiactivesensingmessage_type.md +++ b/windows.devices.midi/midiactivesensingmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiActiveSensingMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiActiveSensingMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiActiveSensingMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiActiveSensingMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midichannelpressuremessage.md b/windows.devices.midi/midichannelpressuremessage.md index 86e9d9f127..8be435dcf8 100644 --- a/windows.devices.midi/midichannelpressuremessage.md +++ b/windows.devices.midi/midichannelpressuremessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiChannelPressureMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiChannelPressureMessage ## -description Represents a MIDI message that specifies the channel pressure. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiChannelPressureMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage + +## -description +Represents a MIDI message that specifies the channel pressure. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midichannelpressuremessage_channel.md b/windows.devices.midi/midichannelpressuremessage_channel.md index a971e3f45d..cb368f5bcb 100644 --- a/windows.devices.midi/midichannelpressuremessage_channel.md +++ b/windows.devices.midi/midichannelpressuremessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiChannelPressureMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midichannelpressuremessage_midichannelpressuremessage_969710101.md b/windows.devices.midi/midichannelpressuremessage_midichannelpressuremessage_969710101.md index 6fb170cb8b..f07492f54f 100644 --- a/windows.devices.midi/midichannelpressuremessage_midichannelpressuremessage_969710101.md +++ b/windows.devices.midi/midichannelpressuremessage_midichannelpressuremessage_969710101.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Midi.MidiChannelPressureMessage.#ctor(System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiChannelPressureMessage.MidiChannelPressureMessage ## -description Creates a new [MidiChannelPressureMessage](midichannelpressuremessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param pressure The pressure from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiChannelPressureMessage.#ctor(System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage.MidiChannelPressureMessage + +## -description +Creates a new [MidiChannelPressureMessage](midichannelpressuremessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param pressure +The pressure from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midichannelpressuremessage_pressure.md b/windows.devices.midi/midichannelpressuremessage_pressure.md index a3ccc5dbd4..a77a5868c2 100644 --- a/windows.devices.midi/midichannelpressuremessage_pressure.md +++ b/windows.devices.midi/midichannelpressuremessage_pressure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Pressure --api-type: winrt property ---- # Windows.Devices.Midi.MidiChannelPressureMessage.Pressure ## -description Gets the pressure from 0-127. ## -property-value The pressure from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Pressure +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage.Pressure + +## -description +Gets the pressure from 0-127. + +## -property-value +The pressure from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midichannelpressuremessage_rawdata.md b/windows.devices.midi/midichannelpressuremessage_rawdata.md index e395f715a4..872c3b289c 100644 --- a/windows.devices.midi/midichannelpressuremessage_rawdata.md +++ b/windows.devices.midi/midichannelpressuremessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiChannelPressureMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midichannelpressuremessage_timestamp.md b/windows.devices.midi/midichannelpressuremessage_timestamp.md index 845267bb2e..410e03764d 100644 --- a/windows.devices.midi/midichannelpressuremessage_timestamp.md +++ b/windows.devices.midi/midichannelpressuremessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiChannelPressureMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midichannelpressuremessage_type.md b/windows.devices.midi/midichannelpressuremessage_type.md index cdf1fa164c..4ab3ec8523 100644 --- a/windows.devices.midi/midichannelpressuremessage_type.md +++ b/windows.devices.midi/midichannelpressuremessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiChannelPressureMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiChannelPressureMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiChannelPressureMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontinuemessage.md b/windows.devices.midi/midicontinuemessage.md index 28563d778b..4665ae34a6 100644 --- a/windows.devices.midi/midicontinuemessage.md +++ b/windows.devices.midi/midicontinuemessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiContinueMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiContinueMessage ## -description Represents a MIDI message that specifies a continue message. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiContinueMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiContinueMessage + +## -description +Represents a MIDI message that specifies a continue message. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midicontinuemessage_midicontinuemessage_1221375020.md b/windows.devices.midi/midicontinuemessage_midicontinuemessage_1221375020.md index 6680bf5e9e..9474491937 100644 --- a/windows.devices.midi/midicontinuemessage_midicontinuemessage_1221375020.md +++ b/windows.devices.midi/midicontinuemessage_midicontinuemessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiContinueMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiContinueMessage.MidiContinueMessage ## -description Creates a new [MidiContinueMessage](midicontinuemessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiContinueMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiContinueMessage.MidiContinueMessage + +## -description +Creates a new [MidiContinueMessage](midicontinuemessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontinuemessage_rawdata.md b/windows.devices.midi/midicontinuemessage_rawdata.md index cfb74ec1ff..09cb88c07e 100644 --- a/windows.devices.midi/midicontinuemessage_rawdata.md +++ b/windows.devices.midi/midicontinuemessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiContinueMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiContinueMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiContinueMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiContinueMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontinuemessage_timestamp.md b/windows.devices.midi/midicontinuemessage_timestamp.md index c56b2616ed..c53214180c 100644 --- a/windows.devices.midi/midicontinuemessage_timestamp.md +++ b/windows.devices.midi/midicontinuemessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiContinueMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiContinueMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiContinueMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiContinueMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontinuemessage_type.md b/windows.devices.midi/midicontinuemessage_type.md index 06bbb08cb5..6a093bd98d 100644 --- a/windows.devices.midi/midicontinuemessage_type.md +++ b/windows.devices.midi/midicontinuemessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiContinueMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiContinueMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiContinueMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiContinueMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage.md b/windows.devices.midi/midicontrolchangemessage.md index f3ab076ba1..8907d5d4f6 100644 --- a/windows.devices.midi/midicontrolchangemessage.md +++ b/windows.devices.midi/midicontrolchangemessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiControlChangeMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiControlChangeMessage ## -description Represents a MIDI message that specifies a control change. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiControlChangeMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage + +## -description +Represents a MIDI message that specifies a control change. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midicontrolchangemessage_channel.md b/windows.devices.midi/midicontrolchangemessage_channel.md index 4b895cb7f3..aed8c7f571 100644 --- a/windows.devices.midi/midicontrolchangemessage_channel.md +++ b/windows.devices.midi/midicontrolchangemessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiControlChangeMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage_controller.md b/windows.devices.midi/midicontrolchangemessage_controller.md index cb8c7e9977..4b53938681 100644 --- a/windows.devices.midi/midicontrolchangemessage_controller.md +++ b/windows.devices.midi/midicontrolchangemessage_controller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Controller --api-type: winrt property ---- # Windows.Devices.Midi.MidiControlChangeMessage.Controller ## -description Gets controller from 0-127 to receive this message. ## -property-value The controller from 0-127 to receive this message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Controller +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.Controller + +## -description +Gets controller from 0-127 to receive this message. + +## -property-value +The controller from 0-127 to receive this message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage_controlvalue.md b/windows.devices.midi/midicontrolchangemessage_controlvalue.md index 819146b185..e53a454723 100644 --- a/windows.devices.midi/midicontrolchangemessage_controlvalue.md +++ b/windows.devices.midi/midicontrolchangemessage_controlvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.ControlValue --api-type: winrt property ---- # Windows.Devices.Midi.MidiControlChangeMessage.ControlValue ## -description Gets the value from 0-127 to apply to the [controller](midicontrolchangemessage_controller.md). ## -property-value The value from 0-127 to apply to the [controller](midicontrolchangemessage_controller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.ControlValue +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.ControlValue + +## -description +Gets the value from 0-127 to apply to the [controller](midicontrolchangemessage_controller.md). + +## -property-value +The value from 0-127 to apply to the [controller](midicontrolchangemessage_controller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage_midicontrolchangemessage_2050166199.md b/windows.devices.midi/midicontrolchangemessage_midicontrolchangemessage_2050166199.md index f590b4123c..70fda33fc7 100644 --- a/windows.devices.midi/midicontrolchangemessage_midicontrolchangemessage_2050166199.md +++ b/windows.devices.midi/midicontrolchangemessage_midicontrolchangemessage_2050166199.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Midi.MidiControlChangeMessage.#ctor(System.Byte,System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiControlChangeMessage.MidiControlChangeMessage ## -description Creates a new [MidiControlChangeMessage](midicontrolchangemessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param controller The controller from 0-127 to receive this message. ### -param controlValue The value from 0-127 to apply to the [controller](midicontrolchangemessage_controller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiControlChangeMessage.#ctor(System.Byte,System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.MidiControlChangeMessage + +## -description +Creates a new [MidiControlChangeMessage](midicontrolchangemessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param controller +The controller from 0-127 to receive this message. + +### -param controlValue +The value from 0-127 to apply to the [controller](midicontrolchangemessage_controller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage_rawdata.md b/windows.devices.midi/midicontrolchangemessage_rawdata.md index 5cbdfb12e3..18dcb3512b 100644 --- a/windows.devices.midi/midicontrolchangemessage_rawdata.md +++ b/windows.devices.midi/midicontrolchangemessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiControlChangeMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage_timestamp.md b/windows.devices.midi/midicontrolchangemessage_timestamp.md index 9f1013eea6..08f7678179 100644 --- a/windows.devices.midi/midicontrolchangemessage_timestamp.md +++ b/windows.devices.midi/midicontrolchangemessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiControlChangeMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midicontrolchangemessage_type.md b/windows.devices.midi/midicontrolchangemessage_type.md index 01f1fece9f..bcc49149cb 100644 --- a/windows.devices.midi/midicontrolchangemessage_type.md +++ b/windows.devices.midi/midicontrolchangemessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiControlChangeMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiControlChangeMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiControlChangeMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiinport.md b/windows.devices.midi/midiinport.md index 3ba4be17b8..b1634a628f 100644 --- a/windows.devices.midi/midiinport.md +++ b/windows.devices.midi/midiinport.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Midi.MidiInPort --api-type: winrt class ---- # Windows.Devices.Midi.MidiInPort ## -description Represents a port used to receive MIDI messages from a MIDI device. ## -remarks If the MidiInPort becomes disconnected for any reason, it should be disposed and a new one created to continue receiving messages. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiInPort +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiInPort + +## -description +Represents a port used to receive MIDI messages from a MIDI device. + +## -remarks +If the MidiInPort becomes disconnected for any reason, it should be disposed and a new one created to continue receiving messages. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midiinport_close_811482585.md b/windows.devices.midi/midiinport_close_811482585.md index 9131e41a7f..cfa28759cf 100644 --- a/windows.devices.midi/midiinport_close_811482585.md +++ b/windows.devices.midi/midiinport_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiInPort.Close --api-type: winrt method ---- # Windows.Devices.Midi.MidiInPort.Close ## -description Closes the [MidiInPort](midiinport.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiInPort.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiInPort.Close + +## -description +Closes the [MidiInPort](midiinport.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiinport_deviceid.md b/windows.devices.midi/midiinport_deviceid.md index db1b5b53c2..9f0e9a0ff7 100644 --- a/windows.devices.midi/midiinport_deviceid.md +++ b/windows.devices.midi/midiinport_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiInPort.DeviceId --api-type: winrt property ---- # Windows.Devices.Midi.MidiInPort.DeviceId ## -description Gets the id of the device that was used to initialize the [MidiInPort](midiinport.md). ## -property-value The ID of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiInPort.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiInPort.DeviceId + +## -description +Gets the id of the device that was used to initialize the [MidiInPort](midiinport.md). + +## -property-value +The ID of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiinport_fromidasync_1322863552.md b/windows.devices.midi/midiinport_fromidasync_1322863552.md index 5ccca6b9b4..0d024abe4a 100644 --- a/windows.devices.midi/midiinport_fromidasync_1322863552.md +++ b/windows.devices.midi/midiinport_fromidasync_1322863552.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Midi.MidiInPort.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Midi.MidiInPort.FromIdAsync ## -description Creates a [MidiInPort](midiinport.md) object for the specified device. ## -parameters ### -param deviceId The device ID, which can be obtained by enumerating the devices on the system [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -returns The asynchronous operation. Upon completion, [IAsyncOperation.GetResults](../windows.foundation/iasyncoperation_1_getresults.md) returns a [MidiInPort](midiinport.md) object. ## -remarks To enumerate the [MidiInPort](midiinport.md) objects on the system, pass the query string provided by [GetDeviceSelector](midiinport_getdeviceselector.md) to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). Suggested times to attempt to create a **MidiInPort** are on any sort of app activation or user interaction. If a function call on a **MidiInPort** fails, or if a message received from a **MidiInPort** is invalid, do not try to recreate the port immediately. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiInPort.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiInPort.FromIdAsync + +## -description +Creates a [MidiInPort](midiinport.md) object for the specified device. + +## -parameters +### -param deviceId +The device ID, which can be obtained by enumerating the devices on the system [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -returns +The asynchronous operation. Upon completion, [IAsyncOperation.GetResults](../windows.foundation/iasyncoperation_1_getresults.md) returns a [MidiInPort](midiinport.md) object. + +## -remarks +To enumerate the [MidiInPort](midiinport.md) objects on the system, pass the query string provided by [GetDeviceSelector](midiinport_getdeviceselector.md) to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +Suggested times to attempt to create a **MidiInPort** are on any sort of app activation or user interaction. If a function call on a **MidiInPort** fails, or if a message received from a **MidiInPort** is invalid, do not try to recreate the port immediately. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiinport_getdeviceselector_838466080.md b/windows.devices.midi/midiinport_getdeviceselector_838466080.md index 7dca886831..58ad4389f0 100644 --- a/windows.devices.midi/midiinport_getdeviceselector_838466080.md +++ b/windows.devices.midi/midiinport_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.MidiInPort.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Midi.MidiInPort.GetDeviceSelector ## -description Gets a query string that can be used to enumerate all [MidiInPort](midiinport.md) objects on the system. ## -returns The query string used to enumerate the [MidiInPort](midiinport.md) objects on the system. ## -remarks To enumerate the [MidiInPort](midiinport.md) objects on the system, pass the query string provided by this method to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiInPort.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiInPort.GetDeviceSelector + +## -description +Gets a query string that can be used to enumerate all [MidiInPort](midiinport.md) objects on the system. + +## -returns +The query string used to enumerate the [MidiInPort](midiinport.md) objects on the system. + +## -remarks +To enumerate the [MidiInPort](midiinport.md) objects on the system, pass the query string provided by this method to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiinport_messagereceived.md b/windows.devices.midi/midiinport_messagereceived.md index 5fb62ec66a..3c3b18dd47 100644 --- a/windows.devices.midi/midiinport_messagereceived.md +++ b/windows.devices.midi/midiinport_messagereceived.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Devices.Midi.MidiInPort.MessageReceived --api-type: winrt event ---- # Windows.Devices.Midi.MidiInPort.MessageReceived ## -description Occurs when the [MidiInPort](midiinport.md) receives data. ## -remarks Apps should subscribe to this event to handle the input messages. If accessing any part of the message results in an exception, it can be assumed that the [MidiInPort](midiinport.md) has been disconnected from the device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Midi.MidiInPort.MessageReceived +-api-type: winrt event +--- + + + +# Windows.Devices.Midi.MidiInPort.MessageReceived + +## -description +Occurs when the [MidiInPort](midiinport.md) receives data. + +## -remarks +Apps should subscribe to this event to handle the input messages. + +If accessing any part of the message results in an exception, it can be assumed that the [MidiInPort](midiinport.md) has been disconnected from the device. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midimessagereceivedeventargs.md b/windows.devices.midi/midimessagereceivedeventargs.md index f322eecc83..872bc4fafe 100644 --- a/windows.devices.midi/midimessagereceivedeventargs.md +++ b/windows.devices.midi/midimessagereceivedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Midi.MidiMessageReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.Midi.MidiMessageReceivedEventArgs ## -description Provides data for the [MessageReceived](midiinport_messagereceived.md) event. ## -remarks This object is not instantiated directly; it is returned by the [MidiInPort.MessageReceived](midiinport_messagereceived.md) event when that event is raised. ## -examples ## -see-also [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiMessageReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiMessageReceivedEventArgs + +## -description +Provides data for the [MessageReceived](midiinport_messagereceived.md) event. + +## -remarks +This object is not instantiated directly; it is returned by the [MidiInPort.MessageReceived](midiinport_messagereceived.md) event when that event is raised. + +## -examples + +## -see-also +[MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midimessagereceivedeventargs_message.md b/windows.devices.midi/midimessagereceivedeventargs_message.md index 30bb6f4211..06f6cdc4a7 100644 --- a/windows.devices.midi/midimessagereceivedeventargs_message.md +++ b/windows.devices.midi/midimessagereceivedeventargs_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiMessageReceivedEventArgs.Message --api-type: winrt property ---- # Windows.Devices.Midi.MidiMessageReceivedEventArgs.Message ## -description The MIDI message. ## -property-value The MIDI message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiMessageReceivedEventArgs.Message +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiMessageReceivedEventArgs.Message + +## -description +The MIDI message. + +## -property-value +The MIDI message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage.md b/windows.devices.midi/midinoteoffmessage.md index e9f781b2d4..4f38456d0e 100644 --- a/windows.devices.midi/midinoteoffmessage.md +++ b/windows.devices.midi/midinoteoffmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiNoteOffMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiNoteOffMessage ## -description Represents a MIDI messages that specifies a MIDI note to turn off. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiNoteOffMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage + +## -description +Represents a MIDI messages that specifies a MIDI note to turn off. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midinoteoffmessage_channel.md b/windows.devices.midi/midinoteoffmessage_channel.md index 8a19a7f7ce..624a86a95f 100644 --- a/windows.devices.midi/midinoteoffmessage_channel.md +++ b/windows.devices.midi/midinoteoffmessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOffMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage_midinoteoffmessage_2050166199.md b/windows.devices.midi/midinoteoffmessage_midinoteoffmessage_2050166199.md index d336302c94..bb65115b06 100644 --- a/windows.devices.midi/midinoteoffmessage_midinoteoffmessage_2050166199.md +++ b/windows.devices.midi/midinoteoffmessage_midinoteoffmessage_2050166199.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Midi.MidiNoteOffMessage.#ctor(System.Byte,System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiNoteOffMessage.MidiNoteOffMessage ## -description Creates a new [MidiNoteOffMessage](midinoteoffmessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param note The note which is specified as a value from 0-127. ### -param velocity The velocity which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiNoteOffMessage.#ctor(System.Byte,System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.MidiNoteOffMessage + +## -description +Creates a new [MidiNoteOffMessage](midinoteoffmessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param note +The note which is specified as a value from 0-127. + +### -param velocity +The velocity which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage_note.md b/windows.devices.midi/midinoteoffmessage_note.md index 0e22e4a855..d893c45093 100644 --- a/windows.devices.midi/midinoteoffmessage_note.md +++ b/windows.devices.midi/midinoteoffmessage_note.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Note --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOffMessage.Note ## -description Gets the note to turn off which is specified as a value from 0-127. ## -property-value The note which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Note +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.Note + +## -description +Gets the note to turn off which is specified as a value from 0-127. + +## -property-value +The note which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage_rawdata.md b/windows.devices.midi/midinoteoffmessage_rawdata.md index ecedda22af..4f68441199 100644 --- a/windows.devices.midi/midinoteoffmessage_rawdata.md +++ b/windows.devices.midi/midinoteoffmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOffMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage_timestamp.md b/windows.devices.midi/midinoteoffmessage_timestamp.md index 147e65701d..9ad5271105 100644 --- a/windows.devices.midi/midinoteoffmessage_timestamp.md +++ b/windows.devices.midi/midinoteoffmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOffMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage_type.md b/windows.devices.midi/midinoteoffmessage_type.md index 71bae3638e..2f5860d37b 100644 --- a/windows.devices.midi/midinoteoffmessage_type.md +++ b/windows.devices.midi/midinoteoffmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOffMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteoffmessage_velocity.md b/windows.devices.midi/midinoteoffmessage_velocity.md index 4cfda61c85..c7ab39627d 100644 --- a/windows.devices.midi/midinoteoffmessage_velocity.md +++ b/windows.devices.midi/midinoteoffmessage_velocity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Velocity --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOffMessage.Velocity ## -description Gets the value of the velocity from 0-127. ## -property-value The velocity which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOffMessage.Velocity +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOffMessage.Velocity + +## -description +Gets the value of the velocity from 0-127. + +## -property-value +The velocity which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage.md b/windows.devices.midi/midinoteonmessage.md index ce0a8d3e46..8c6eae8246 100644 --- a/windows.devices.midi/midinoteonmessage.md +++ b/windows.devices.midi/midinoteonmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiNoteOnMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiNoteOnMessage ## -description Represents a MIDI message that specifies a MIDI note to turn on. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiNoteOnMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage + +## -description +Represents a MIDI message that specifies a MIDI note to turn on. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midinoteonmessage_channel.md b/windows.devices.midi/midinoteonmessage_channel.md index 967b459d69..ec79ad442b 100644 --- a/windows.devices.midi/midinoteonmessage_channel.md +++ b/windows.devices.midi/midinoteonmessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOnMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage_midinoteonmessage_2050166199.md b/windows.devices.midi/midinoteonmessage_midinoteonmessage_2050166199.md index 396fd3a21b..bf614c77d3 100644 --- a/windows.devices.midi/midinoteonmessage_midinoteonmessage_2050166199.md +++ b/windows.devices.midi/midinoteonmessage_midinoteonmessage_2050166199.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Midi.MidiNoteOnMessage.#ctor(System.Byte,System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiNoteOnMessage.MidiNoteOnMessage ## -description Creates a new [MidiNoteOnMessage](midinoteonmessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param note The note which is specified as a value from 0-127. ### -param velocity The velocity which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiNoteOnMessage.#ctor(System.Byte,System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.MidiNoteOnMessage + +## -description +Creates a new [MidiNoteOnMessage](midinoteonmessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param note +The note which is specified as a value from 0-127. + +### -param velocity +The velocity which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage_note.md b/windows.devices.midi/midinoteonmessage_note.md index ffe8214bfa..020838cfc3 100644 --- a/windows.devices.midi/midinoteonmessage_note.md +++ b/windows.devices.midi/midinoteonmessage_note.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Note --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOnMessage.Note ## -description Gets the note to turn on which is specified as a value from 0-127. ## -property-value The note which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Note +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.Note + +## -description +Gets the note to turn on which is specified as a value from 0-127. + +## -property-value +The note which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage_rawdata.md b/windows.devices.midi/midinoteonmessage_rawdata.md index 9dfdb2288d..0007c2429e 100644 --- a/windows.devices.midi/midinoteonmessage_rawdata.md +++ b/windows.devices.midi/midinoteonmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOnMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage_timestamp.md b/windows.devices.midi/midinoteonmessage_timestamp.md index 5549d8838e..dbcab9b93a 100644 --- a/windows.devices.midi/midinoteonmessage_timestamp.md +++ b/windows.devices.midi/midinoteonmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOnMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage_type.md b/windows.devices.midi/midinoteonmessage_type.md index 3c4bf70919..0ef1739800 100644 --- a/windows.devices.midi/midinoteonmessage_type.md +++ b/windows.devices.midi/midinoteonmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOnMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midinoteonmessage_velocity.md b/windows.devices.midi/midinoteonmessage_velocity.md index 5f5022acca..95c32806ad 100644 --- a/windows.devices.midi/midinoteonmessage_velocity.md +++ b/windows.devices.midi/midinoteonmessage_velocity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Velocity --api-type: winrt property ---- # Windows.Devices.Midi.MidiNoteOnMessage.Velocity ## -description Gets the value of the velocity from 0-127. ## -property-value The velocity which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiNoteOnMessage.Velocity +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiNoteOnMessage.Velocity + +## -description +Gets the value of the velocity from 0-127. + +## -property-value +The velocity which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midioutport.md b/windows.devices.midi/midioutport.md index 54ecd9debf..f2e76311b8 100644 --- a/windows.devices.midi/midioutport.md +++ b/windows.devices.midi/midioutport.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiOutPort --api-type: winrt class ---- # Windows.Devices.Midi.MidiOutPort ## -description Represents a port used to send MIDI messages to a MIDI device. ## -remarks ## -examples ## -see-also [IMidiOutPort](imidioutport.md), [IClosable](../windows.foundation/iclosable.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiOutPort +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiOutPort + +## -description +Represents a port used to send MIDI messages to a MIDI device. + +## -remarks + +## -examples + +## -see-also +[IMidiOutPort](imidioutport.md), [IClosable](../windows.foundation/iclosable.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midioutport_close_811482585.md b/windows.devices.midi/midioutport_close_811482585.md index 9c165a1882..31a09e72d8 100644 --- a/windows.devices.midi/midioutport_close_811482585.md +++ b/windows.devices.midi/midioutport_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiOutPort.Close --api-type: winrt method ---- # Windows.Devices.Midi.MidiOutPort.Close ## -description Closes the [MidiOutPort](midioutport.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiOutPort.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiOutPort.Close + +## -description +Closes the [MidiOutPort](midioutport.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midioutport_deviceid.md b/windows.devices.midi/midioutport_deviceid.md index a0882d788e..c488d3efaa 100644 --- a/windows.devices.midi/midioutport_deviceid.md +++ b/windows.devices.midi/midioutport_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiOutPort.DeviceId --api-type: winrt property ---- # Windows.Devices.Midi.MidiOutPort.DeviceId ## -description Gets the id of the device that was used to initialize the [MidiOutPort](midioutport.md). ## -property-value The ID of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiOutPort.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiOutPort.DeviceId + +## -description +Gets the id of the device that was used to initialize the [MidiOutPort](midioutport.md). + +## -property-value +The ID of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midioutport_fromidasync_1322863552.md b/windows.devices.midi/midioutport_fromidasync_1322863552.md index 0b6bc4e0b2..49958325b0 100644 --- a/windows.devices.midi/midioutport_fromidasync_1322863552.md +++ b/windows.devices.midi/midioutport_fromidasync_1322863552.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Midi.MidiOutPort.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Midi.MidiOutPort.FromIdAsync ## -description Creates a [MidiOutPort](midioutport.md) object for the specified device. ## -parameters ### -param deviceId The device ID, which can be obtained by enumerating the devices on the system [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -returns The asynchronous operation. Upon completion, [IAsyncOperation.GetResults](../windows.foundation/iasyncoperation_1_getresults.md) returns a [MidiOutPort](midioutport.md) object. ## -remarks To enumerate the [MidiOutPort](midioutport.md) objects on the system, pass the query string provided by [GetDeviceSelector](midiinport_getdeviceselector.md) to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). Suggested times to attempt to create a **MidiInPort** are on any sort of app activation or user interaction. If a function call on a **MidiInPort** fails, or if a message received from a **MidiInPort** is invalid, do not try to recreate the port immediately. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiOutPort.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiOutPort.FromIdAsync + +## -description +Creates a [MidiOutPort](midioutport.md) object for the specified device. + +## -parameters +### -param deviceId +The device ID, which can be obtained by enumerating the devices on the system [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -returns +The asynchronous operation. Upon completion, [IAsyncOperation.GetResults](../windows.foundation/iasyncoperation_1_getresults.md) returns a [MidiOutPort](midioutport.md) object. + +## -remarks +To enumerate the [MidiOutPort](midioutport.md) objects on the system, pass the query string provided by [GetDeviceSelector](midiinport_getdeviceselector.md) to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +Suggested times to attempt to create a **MidiInPort** are on any sort of app activation or user interaction. If a function call on a **MidiInPort** fails, or if a message received from a **MidiInPort** is invalid, do not try to recreate the port immediately. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midioutport_getdeviceselector_838466080.md b/windows.devices.midi/midioutport_getdeviceselector_838466080.md index ae6827cbf1..823070325d 100644 --- a/windows.devices.midi/midioutport_getdeviceselector_838466080.md +++ b/windows.devices.midi/midioutport_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.MidiOutPort.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Midi.MidiOutPort.GetDeviceSelector ## -description Gets a query string that can be used to enumerate all [MidiOutPort](midioutport.md) objects on the system. ## -returns The query string used to enumerate the [MidiOutPort](midioutport.md) objects on the system. ## -remarks To enumerate the [MidiOutPort](midioutport.md) objects on the system, pass the query string provided by this method to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiOutPort.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiOutPort.GetDeviceSelector + +## -description +Gets a query string that can be used to enumerate all [MidiOutPort](midioutport.md) objects on the system. + +## -returns +The query string used to enumerate the [MidiOutPort](midioutport.md) objects on the system. + +## -remarks +To enumerate the [MidiOutPort](midioutport.md) objects on the system, pass the query string provided by this method to [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -examples + +## -see-also diff --git a/windows.devices.midi/midioutport_sendbuffer_69762025.md b/windows.devices.midi/midioutport_sendbuffer_69762025.md index acb2aa8fd1..c4d38f5915 100644 --- a/windows.devices.midi/midioutport_sendbuffer_69762025.md +++ b/windows.devices.midi/midioutport_sendbuffer_69762025.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Midi.MidiOutPort.SendBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Midi.MidiOutPort.SendBuffer ## -description Send the specified data buffer to the device associated with this [MidiOutPort](midioutport.md). ## -parameters ### -param midiData The data to send to the device. ## -remarks If this method fails with **RO_E_CLOSED**, it can be assumed that the [MidiOutPort](midioutport.md) has been disconnected from the device. See [Obtaining pointers to data buffers (C++/CX)](http://msdn.microsoft.com/windows/apps/dn182761.aspx#) for more info. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiOutPort.SendBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiOutPort.SendBuffer + +## -description +Send the specified data buffer to the device associated with this [MidiOutPort](midioutport.md). + +## -parameters +### -param midiData +The data to send to the device. + +## -remarks +If this method fails with **RO_E_CLOSED**, it can be assumed that the [MidiOutPort](midioutport.md) has been disconnected from the device. + +See [Obtaining pointers to data buffers (C++/CX)](http://msdn.microsoft.com/windows/apps/dn182761.aspx#) for more info. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midioutport_sendmessage_275315374.md b/windows.devices.midi/midioutport_sendmessage_275315374.md index 5330162d6a..68c78924c4 100644 --- a/windows.devices.midi/midioutport_sendmessage_275315374.md +++ b/windows.devices.midi/midioutport_sendmessage_275315374.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.MidiOutPort.SendMessage(Windows.Devices.Midi.IMidiMessage) --api-type: winrt method ---- # Windows.Devices.Midi.MidiOutPort.SendMessage ## -description Send the data in the specified MIDI message to the device associated with this [MidiOutPort](midioutport.md). ## -parameters ### -param midiMessage The MIDI message to send to the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiOutPort.SendMessage(Windows.Devices.Midi.IMidiMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiOutPort.SendMessage + +## -description +Send the data in the specified MIDI message to the device associated with this [MidiOutPort](midioutport.md). + +## -parameters +### -param midiMessage +The MIDI message to send to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipitchbendchangemessage.md b/windows.devices.midi/midipitchbendchangemessage.md index 1aa37b4bdd..598e793b8d 100644 --- a/windows.devices.midi/midipitchbendchangemessage.md +++ b/windows.devices.midi/midipitchbendchangemessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiPitchBendChangeMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage ## -description Represents a MIDI message that specifies a pitch bend change. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiPitchBendChangeMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage + +## -description +Represents a MIDI message that specifies a pitch bend change. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midipitchbendchangemessage_bend.md b/windows.devices.midi/midipitchbendchangemessage_bend.md index 08192a5bb5..d30e35eadf 100644 --- a/windows.devices.midi/midipitchbendchangemessage_bend.md +++ b/windows.devices.midi/midipitchbendchangemessage_bend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Bend --api-type: winrt property ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage.Bend ## -description Gets the pitch bend value which is specified as a 14-bit value from 0-16383. ## -property-value The pitch bend value which is specified as a 14-bit value from 0-16383. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Bend +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage.Bend + +## -description +Gets the pitch bend value which is specified as a 14-bit value from 0-16383. + +## -property-value +The pitch bend value which is specified as a 14-bit value from 0-16383. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipitchbendchangemessage_channel.md b/windows.devices.midi/midipitchbendchangemessage_channel.md index 027b15cc30..bbfe30349c 100644 --- a/windows.devices.midi/midipitchbendchangemessage_channel.md +++ b/windows.devices.midi/midipitchbendchangemessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipitchbendchangemessage_midipitchbendchangemessage_1112558655.md b/windows.devices.midi/midipitchbendchangemessage_midipitchbendchangemessage_1112558655.md index 0d55714c81..91455b42a7 100644 --- a/windows.devices.midi/midipitchbendchangemessage_midipitchbendchangemessage_1112558655.md +++ b/windows.devices.midi/midipitchbendchangemessage_midipitchbendchangemessage_1112558655.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Midi.MidiPitchBendChangeMessage.#ctor(System.Byte,System.UInt16) --api-type: winrt method ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage.MidiPitchBendChangeMessage ## -description Creates a new [MidiPitchBendChangeMessage](midipitchbendchangemessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param bend The pitch bend value which is specified as a 14-bit value from 0-16383. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiPitchBendChangeMessage.#ctor(System.Byte,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage.MidiPitchBendChangeMessage + +## -description +Creates a new [MidiPitchBendChangeMessage](midipitchbendchangemessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param bend +The pitch bend value which is specified as a 14-bit value from 0-16383. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipitchbendchangemessage_rawdata.md b/windows.devices.midi/midipitchbendchangemessage_rawdata.md index 6bce6e9501..6fc17e7366 100644 --- a/windows.devices.midi/midipitchbendchangemessage_rawdata.md +++ b/windows.devices.midi/midipitchbendchangemessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipitchbendchangemessage_timestamp.md b/windows.devices.midi/midipitchbendchangemessage_timestamp.md index 08a780b881..8b2cb5c671 100644 --- a/windows.devices.midi/midipitchbendchangemessage_timestamp.md +++ b/windows.devices.midi/midipitchbendchangemessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipitchbendchangemessage_type.md b/windows.devices.midi/midipitchbendchangemessage_type.md index 22f84cbf2a..2065305db9 100644 --- a/windows.devices.midi/midipitchbendchangemessage_type.md +++ b/windows.devices.midi/midipitchbendchangemessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiPitchBendChangeMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPitchBendChangeMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPitchBendChangeMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage.md b/windows.devices.midi/midipolyphonickeypressuremessage.md index 6a6b765718..d2a79f6a7e 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage ## -description Represents a MIDI message that specifies the polyphonic key pressure. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage + +## -description +Represents a MIDI message that specifies the polyphonic key pressure. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_channel.md b/windows.devices.midi/midipolyphonickeypressuremessage_channel.md index 3fdb1beed2..bf5f32a50e 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_channel.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_midipolyphonickeypressuremessage_2050166199.md b/windows.devices.midi/midipolyphonickeypressuremessage_midipolyphonickeypressuremessage_2050166199.md index 71aaf635a5..85403e6290 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_midipolyphonickeypressuremessage_2050166199.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_midipolyphonickeypressuremessage_2050166199.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.#ctor(System.Byte,System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.MidiPolyphonicKeyPressureMessage ## -description Creates a new [MidiPolyphonicKeyPressureMessage](midipolyphonickeypressuremessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param note The note which is specified as a value from 0-127. ### -param pressure The polyphonic key pressure which is specified as a value from 0-127. ## -remarks If any of the values passed in to the constructor do not adhere to the specified requirements, an ArgumentException will be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.#ctor(System.Byte,System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.MidiPolyphonicKeyPressureMessage + +## -description +Creates a new [MidiPolyphonicKeyPressureMessage](midipolyphonickeypressuremessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param note +The note which is specified as a value from 0-127. + +### -param pressure +The polyphonic key pressure which is specified as a value from 0-127. + +## -remarks +If any of the values passed in to the constructor do not adhere to the specified requirements, an ArgumentException will be thrown. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_note.md b/windows.devices.midi/midipolyphonickeypressuremessage_note.md index 80626bd6b4..e6001ae9dc 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_note.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_note.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Note --api-type: winrt property ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Note ## -description Gets the note which is specified as a value from 0-127. ## -property-value The note which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Note +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Note + +## -description +Gets the note which is specified as a value from 0-127. + +## -property-value +The note which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_pressure.md b/windows.devices.midi/midipolyphonickeypressuremessage_pressure.md index b8c0dd103e..54190363cc 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_pressure.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_pressure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Pressure --api-type: winrt property ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Pressure ## -description Gets the polyphonic key pressure which is specified as a value from 0-127. ## -property-value The polyphonic key pressure which is specified as a value from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Pressure +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Pressure + +## -description +Gets the polyphonic key pressure which is specified as a value from 0-127. + +## -property-value +The polyphonic key pressure which is specified as a value from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_rawdata.md b/windows.devices.midi/midipolyphonickeypressuremessage_rawdata.md index 7b748839ad..459a3a5af7 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_rawdata.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_timestamp.md b/windows.devices.midi/midipolyphonickeypressuremessage_timestamp.md index 1a99521f68..d90c35f28d 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_timestamp.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midipolyphonickeypressuremessage_type.md b/windows.devices.midi/midipolyphonickeypressuremessage_type.md index 04ea530af7..8ec5fbcc50 100644 --- a/windows.devices.midi/midipolyphonickeypressuremessage_type.md +++ b/windows.devices.midi/midipolyphonickeypressuremessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiPolyphonicKeyPressureMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiprogramchangemessage.md b/windows.devices.midi/midiprogramchangemessage.md index ac7e636a13..495ef0f2aa 100644 --- a/windows.devices.midi/midiprogramchangemessage.md +++ b/windows.devices.midi/midiprogramchangemessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiProgramChangeMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiProgramChangeMessage ## -description Represents a MIDI message that specifies a program change. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiProgramChangeMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage + +## -description +Represents a MIDI message that specifies a program change. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midiprogramchangemessage_channel.md b/windows.devices.midi/midiprogramchangemessage_channel.md index 0a1a99dd4a..c920bf933f 100644 --- a/windows.devices.midi/midiprogramchangemessage_channel.md +++ b/windows.devices.midi/midiprogramchangemessage_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Channel --api-type: winrt property ---- # Windows.Devices.Midi.MidiProgramChangeMessage.Channel ## -description Gets the channel from 0-15 that this message applies to. ## -property-value The channel from 0-15 that this message applies to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage.Channel + +## -description +Gets the channel from 0-15 that this message applies to. + +## -property-value +The channel from 0-15 that this message applies to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiprogramchangemessage_midiprogramchangemessage_969710101.md b/windows.devices.midi/midiprogramchangemessage_midiprogramchangemessage_969710101.md index e1c7881f01..29b8d5a60f 100644 --- a/windows.devices.midi/midiprogramchangemessage_midiprogramchangemessage_969710101.md +++ b/windows.devices.midi/midiprogramchangemessage_midiprogramchangemessage_969710101.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Midi.MidiProgramChangeMessage.#ctor(System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiProgramChangeMessage.MidiProgramChangeMessage ## -description Creates a new [MidiProgramChangeMessage](midiprogramchangemessage.md) object. ## -parameters ### -param channel The channel from 0-15 that this message applies to. ### -param program The program to change from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiProgramChangeMessage.#ctor(System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage.MidiProgramChangeMessage + +## -description +Creates a new [MidiProgramChangeMessage](midiprogramchangemessage.md) object. + +## -parameters +### -param channel +The channel from 0-15 that this message applies to. + +### -param program +The program to change from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiprogramchangemessage_program.md b/windows.devices.midi/midiprogramchangemessage_program.md index b7d184177e..5ac9a260bf 100644 --- a/windows.devices.midi/midiprogramchangemessage_program.md +++ b/windows.devices.midi/midiprogramchangemessage_program.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Program --api-type: winrt property ---- # Windows.Devices.Midi.MidiProgramChangeMessage.Program ## -description Gets the program to change from 0-127. ## -property-value The program to change from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Program +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage.Program + +## -description +Gets the program to change from 0-127. + +## -property-value +The program to change from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiprogramchangemessage_rawdata.md b/windows.devices.midi/midiprogramchangemessage_rawdata.md index 33985048d4..291cb7b823 100644 --- a/windows.devices.midi/midiprogramchangemessage_rawdata.md +++ b/windows.devices.midi/midiprogramchangemessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiProgramChangeMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiprogramchangemessage_timestamp.md b/windows.devices.midi/midiprogramchangemessage_timestamp.md index 18b67a6512..9eb621eea4 100644 --- a/windows.devices.midi/midiprogramchangemessage_timestamp.md +++ b/windows.devices.midi/midiprogramchangemessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiProgramChangeMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midiprogramchangemessage_type.md b/windows.devices.midi/midiprogramchangemessage_type.md index 1daff56022..692b2415b9 100644 --- a/windows.devices.midi/midiprogramchangemessage_type.md +++ b/windows.devices.midi/midiprogramchangemessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiProgramChangeMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiProgramChangeMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiProgramChangeMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongpositionpointermessage.md b/windows.devices.midi/midisongpositionpointermessage.md index 4c079b7000..7fc62719bc 100644 --- a/windows.devices.midi/midisongpositionpointermessage.md +++ b/windows.devices.midi/midisongpositionpointermessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiSongPositionPointerMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiSongPositionPointerMessage ## -description Represents a MIDI message that specifies a song position pointer. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiSongPositionPointerMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiSongPositionPointerMessage + +## -description +Represents a MIDI message that specifies a song position pointer. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midisongpositionpointermessage_beats.md b/windows.devices.midi/midisongpositionpointermessage_beats.md index d251b52b61..ba74cb733d 100644 --- a/windows.devices.midi/midisongpositionpointermessage_beats.md +++ b/windows.devices.midi/midisongpositionpointermessage_beats.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.Beats --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongPositionPointerMessage.Beats ## -description Gets the song position pointer encoded in a 14-bit value from 0-16383. ## -property-value The song position pointer encoded in a 14-bit value from 0-16383. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.Beats +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongPositionPointerMessage.Beats + +## -description +Gets the song position pointer encoded in a 14-bit value from 0-16383. + +## -property-value +The song position pointer encoded in a 14-bit value from 0-16383. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongpositionpointermessage_midisongpositionpointermessage_637352657.md b/windows.devices.midi/midisongpositionpointermessage_midisongpositionpointermessage_637352657.md index 6722484e6a..dee72e32a1 100644 --- a/windows.devices.midi/midisongpositionpointermessage_midisongpositionpointermessage_637352657.md +++ b/windows.devices.midi/midisongpositionpointermessage_midisongpositionpointermessage_637352657.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSongPositionPointerMessage.#ctor(System.UInt16) --api-type: winrt method ---- # Windows.Devices.Midi.MidiSongPositionPointerMessage.MidiSongPositionPointerMessage ## -description Creates a new [MidiSongPositionPointerMessage](midisongpositionpointermessage.md) object. ## -parameters ### -param beats The song position pointer encoded in a 14-bit value from 0-16383. ## -remarks If any values passed into the constructor fo not adhere to the specified requirements, an InvalidArg exception will be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSongPositionPointerMessage.#ctor(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSongPositionPointerMessage.MidiSongPositionPointerMessage + +## -description +Creates a new [MidiSongPositionPointerMessage](midisongpositionpointermessage.md) object. + +## -parameters +### -param beats +The song position pointer encoded in a 14-bit value from 0-16383. + +## -remarks +If any values passed into the constructor fo not adhere to the specified requirements, an InvalidArg exception will be thrown. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongpositionpointermessage_rawdata.md b/windows.devices.midi/midisongpositionpointermessage_rawdata.md index 36a402fdbd..3999379486 100644 --- a/windows.devices.midi/midisongpositionpointermessage_rawdata.md +++ b/windows.devices.midi/midisongpositionpointermessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongPositionPointerMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongPositionPointerMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongpositionpointermessage_timestamp.md b/windows.devices.midi/midisongpositionpointermessage_timestamp.md index 38b41c21f1..8a5bdad46a 100644 --- a/windows.devices.midi/midisongpositionpointermessage_timestamp.md +++ b/windows.devices.midi/midisongpositionpointermessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongPositionPointerMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongPositionPointerMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongpositionpointermessage_type.md b/windows.devices.midi/midisongpositionpointermessage_type.md index 04a0f9b4dd..d539f33793 100644 --- a/windows.devices.midi/midisongpositionpointermessage_type.md +++ b/windows.devices.midi/midisongpositionpointermessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongPositionPointerMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongPositionPointerMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongPositionPointerMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongselectmessage.md b/windows.devices.midi/midisongselectmessage.md index ca127ee190..5b629f1449 100644 --- a/windows.devices.midi/midisongselectmessage.md +++ b/windows.devices.midi/midisongselectmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiSongSelectMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiSongSelectMessage ## -description Represents a MIDI message that specifies the selected song. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiSongSelectMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiSongSelectMessage + +## -description +Represents a MIDI message that specifies the selected song. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midisongselectmessage_midisongselectmessage_1741467195.md b/windows.devices.midi/midisongselectmessage_midisongselectmessage_1741467195.md index a1f50d5fd1..c24facb3b8 100644 --- a/windows.devices.midi/midisongselectmessage_midisongselectmessage_1741467195.md +++ b/windows.devices.midi/midisongselectmessage_midisongselectmessage_1741467195.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSongSelectMessage.#ctor(System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiSongSelectMessage.MidiSongSelectMessage ## -description Creates a new [MidiSongSelectMessage](midisongselectmessage.md) object. ## -parameters ### -param song The song to select from 0-127. ## -remarks If any values passed into the constructor do not adhere to the specified requirements, an invalid argument exception will be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSongSelectMessage.#ctor(System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSongSelectMessage.MidiSongSelectMessage + +## -description +Creates a new [MidiSongSelectMessage](midisongselectmessage.md) object. + +## -parameters +### -param song +The song to select from 0-127. + +## -remarks +If any values passed into the constructor do not adhere to the specified requirements, an invalid argument exception will be thrown. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongselectmessage_rawdata.md b/windows.devices.midi/midisongselectmessage_rawdata.md index fdb13328d9..24a6246f2f 100644 --- a/windows.devices.midi/midisongselectmessage_rawdata.md +++ b/windows.devices.midi/midisongselectmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongSelectMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongSelectMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongselectmessage_song.md b/windows.devices.midi/midisongselectmessage_song.md index f249814e51..3a837c6eb7 100644 --- a/windows.devices.midi/midisongselectmessage_song.md +++ b/windows.devices.midi/midisongselectmessage_song.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.Song --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongSelectMessage.Song ## -description Gets the song to select from 0-127. ## -property-value The song to select from 0-127. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.Song +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongSelectMessage.Song + +## -description +Gets the song to select from 0-127. + +## -property-value +The song to select from 0-127. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongselectmessage_timestamp.md b/windows.devices.midi/midisongselectmessage_timestamp.md index a322d63d8e..d3775c6209 100644 --- a/windows.devices.midi/midisongselectmessage_timestamp.md +++ b/windows.devices.midi/midisongselectmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongSelectMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongSelectMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisongselectmessage_type.md b/windows.devices.midi/midisongselectmessage_type.md index 4a091aacbf..c14a86aa84 100644 --- a/windows.devices.midi/midisongselectmessage_type.md +++ b/windows.devices.midi/midisongselectmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiSongSelectMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSongSelectMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSongSelectMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistartmessage.md b/windows.devices.midi/midistartmessage.md index 2c772297da..31276fcbc2 100644 --- a/windows.devices.midi/midistartmessage.md +++ b/windows.devices.midi/midistartmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiStartMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiStartMessage ## -description Represents a MIDI message that specifies a start message. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiStartMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiStartMessage + +## -description +Represents a MIDI message that specifies a start message. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midistartmessage_midistartmessage_1221375020.md b/windows.devices.midi/midistartmessage_midistartmessage_1221375020.md index e705a22d43..64451bd66c 100644 --- a/windows.devices.midi/midistartmessage_midistartmessage_1221375020.md +++ b/windows.devices.midi/midistartmessage_midistartmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiStartMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiStartMessage.MidiStartMessage ## -description Creates a new [MidiStartMessage](midistartmessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiStartMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiStartMessage.MidiStartMessage + +## -description +Creates a new [MidiStartMessage](midistartmessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistartmessage_rawdata.md b/windows.devices.midi/midistartmessage_rawdata.md index 1463d9de4c..4289f0bfcc 100644 --- a/windows.devices.midi/midistartmessage_rawdata.md +++ b/windows.devices.midi/midistartmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiStartMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiStartMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiStartMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiStartMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistartmessage_timestamp.md b/windows.devices.midi/midistartmessage_timestamp.md index 99002bae70..7cac6ca99e 100644 --- a/windows.devices.midi/midistartmessage_timestamp.md +++ b/windows.devices.midi/midistartmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiStartMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiStartMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiStartMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiStartMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistartmessage_type.md b/windows.devices.midi/midistartmessage_type.md index 16ee3fb378..ce0ce874f1 100644 --- a/windows.devices.midi/midistartmessage_type.md +++ b/windows.devices.midi/midistartmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiStartMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiStartMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiStartMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiStartMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistopmessage.md b/windows.devices.midi/midistopmessage.md index b340e9d5d3..6785fb69e1 100644 --- a/windows.devices.midi/midistopmessage.md +++ b/windows.devices.midi/midistopmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiStopMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiStopMessage ## -description Represents a MIDI message that specifies a stop message. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiStopMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiStopMessage + +## -description +Represents a MIDI message that specifies a stop message. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midistopmessage_midistopmessage_1221375020.md b/windows.devices.midi/midistopmessage_midistopmessage_1221375020.md index c2fdf65369..9a304743d8 100644 --- a/windows.devices.midi/midistopmessage_midistopmessage_1221375020.md +++ b/windows.devices.midi/midistopmessage_midistopmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiStopMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiStopMessage.MidiStopMessage ## -description Creates a new [MidiStopMessage](midistopmessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiStopMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiStopMessage.MidiStopMessage + +## -description +Creates a new [MidiStopMessage](midistopmessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistopmessage_rawdata.md b/windows.devices.midi/midistopmessage_rawdata.md index 53fe21acad..aff9bfb51a 100644 --- a/windows.devices.midi/midistopmessage_rawdata.md +++ b/windows.devices.midi/midistopmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiStopMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiStopMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiStopMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiStopMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistopmessage_timestamp.md b/windows.devices.midi/midistopmessage_timestamp.md index eea78697f3..524c1b1097 100644 --- a/windows.devices.midi/midistopmessage_timestamp.md +++ b/windows.devices.midi/midistopmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiStopMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiStopMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiStopMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiStopMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midistopmessage_type.md b/windows.devices.midi/midistopmessage_type.md index b0a082f352..84a5bc984f 100644 --- a/windows.devices.midi/midistopmessage_type.md +++ b/windows.devices.midi/midistopmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiStopMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiStopMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiStopMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiStopMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer.md b/windows.devices.midi/midisynthesizer.md index e948529aba..054067d8fc 100644 --- a/windows.devices.midi/midisynthesizer.md +++ b/windows.devices.midi/midisynthesizer.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiSynthesizer --api-type: winrt class ---- # Windows.Devices.Midi.MidiSynthesizer ## -description Represents the Microsoft GS wavetable software synthesizer, included in Windows. This synthesizer provides a Roland GS sound set, which includes and extends the General MIDI sound set. ## -remarks ## -examples ## -see-also [IMidiOutPort](imidioutport.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiSynthesizer +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiSynthesizer + +## -description +Represents the Microsoft GS wavetable software synthesizer, included in Windows. This synthesizer provides a Roland GS sound set, which includes and extends the General MIDI sound set. + +## -remarks + +## -examples + +## -see-also +[IMidiOutPort](imidioutport.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.midi/midisynthesizer_audiodevice.md b/windows.devices.midi/midisynthesizer_audiodevice.md index bdc2dbc184..dfe3abac77 100644 --- a/windows.devices.midi/midisynthesizer_audiodevice.md +++ b/windows.devices.midi/midisynthesizer_audiodevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSynthesizer.AudioDevice --api-type: winrt property ---- # Windows.Devices.Midi.MidiSynthesizer.AudioDevice ## -description Gets the audio output device being used by this instance of the Microsoft MIDI synthesizer. ## -property-value An object that represents the audio output device. Use the methods and properties of this object to further identify the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSynthesizer.AudioDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.AudioDevice + +## -description +Gets the audio output device being used by this instance of the Microsoft MIDI synthesizer. + +## -property-value +An object that represents the audio output device. Use the methods and properties of this object to further identify the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer_close_811482585.md b/windows.devices.midi/midisynthesizer_close_811482585.md index 17c81cc54b..dbee332a78 100644 --- a/windows.devices.midi/midisynthesizer_close_811482585.md +++ b/windows.devices.midi/midisynthesizer_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSynthesizer.Close --api-type: winrt method ---- # Windows.Devices.Midi.MidiSynthesizer.Close ## -description Closes this instance of the Microsoft MIDI synthesizer. It is a best practice for the caller to use this method to clear resources used by the MIDI object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSynthesizer.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.Close + +## -description +Closes this instance of the Microsoft MIDI synthesizer. It is a best practice for the caller to use this method to clear resources used by the MIDI object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer_createasync_1127173071.md b/windows.devices.midi/midisynthesizer_createasync_1127173071.md index f1a96edc8d..3c568ace52 100644 --- a/windows.devices.midi/midisynthesizer_createasync_1127173071.md +++ b/windows.devices.midi/midisynthesizer_createasync_1127173071.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSynthesizer.CreateAsync(Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- # Windows.Devices.Midi.MidiSynthesizer.CreateAsync ## -description Creates a new instance of the Microsoft MIDI synthesizer with a specified audio output device. ## -parameters ### -param audioDevice The audio output device. ## -returns An instance of the Microsoft MIDI synthesizer. ## -remarks ## -examples ## -see-also [CreateAsync](midisynthesizer_createasync_616540418.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSynthesizer.CreateAsync(Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.CreateAsync + +## -description +Creates a new instance of the Microsoft MIDI synthesizer with a specified audio output device. + +## -parameters +### -param audioDevice +The audio output device. + +## -returns +An instance of the Microsoft MIDI synthesizer. + +## -remarks + +## -examples + +## -see-also +[CreateAsync](midisynthesizer_createasync_616540418.md) \ No newline at end of file diff --git a/windows.devices.midi/midisynthesizer_createasync_616540418.md b/windows.devices.midi/midisynthesizer_createasync_616540418.md index 34d21ef11a..09ab291c73 100644 --- a/windows.devices.midi/midisynthesizer_createasync_616540418.md +++ b/windows.devices.midi/midisynthesizer_createasync_616540418.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSynthesizer.CreateAsync --api-type: winrt method ---- # Windows.Devices.Midi.MidiSynthesizer.CreateAsync ## -description Creates a new instance of the Microsoft MIDI synthesizer that uses the system's default audio output device. ## -returns An instance of the Windows MIDI synthesizer. ## -remarks ## -examples ## -see-also [CreateAsync(DeviceInformation)](midisynthesizer_createasync_1127173071.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSynthesizer.CreateAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.CreateAsync + +## -description +Creates a new instance of the Microsoft MIDI synthesizer that uses the system's default audio output device. + +## -returns +An instance of the Windows MIDI synthesizer. + +## -remarks + +## -examples + +## -see-also +[CreateAsync(DeviceInformation)](midisynthesizer_createasync_1127173071.md) \ No newline at end of file diff --git a/windows.devices.midi/midisynthesizer_deviceid.md b/windows.devices.midi/midisynthesizer_deviceid.md index 9fd666516b..cd49ede26b 100644 --- a/windows.devices.midi/midisynthesizer_deviceid.md +++ b/windows.devices.midi/midisynthesizer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSynthesizer.DeviceId --api-type: winrt property ---- # Windows.Devices.Midi.MidiSynthesizer.DeviceId ## -description Gets the device ID of the Microsoft MIDI synthesizer. Note that all instances of the synthesizer have the same ID. ## -property-value The device ID of this instance of the Microsoft MIDI synthesizer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSynthesizer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.DeviceId + +## -description +Gets the device ID of the Microsoft MIDI synthesizer. Note that all instances of the synthesizer have the same ID. + +## -property-value +The device ID of this instance of the Microsoft MIDI synthesizer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer_issynthesizer_1740398578.md b/windows.devices.midi/midisynthesizer_issynthesizer_1740398578.md index 8ef35a2c4d..30cea783d8 100644 --- a/windows.devices.midi/midisynthesizer_issynthesizer_1740398578.md +++ b/windows.devices.midi/midisynthesizer_issynthesizer_1740398578.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.Devices.Midi.MidiSynthesizer.IsSynthesizer(Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- - - - -# Windows.Devices.Midi.MidiSynthesizer.IsSynthesizer - -## -description -Determines whether a particular device is an instance of the Microsoft MIDI synthesizer. When all MIDI out ports on the system are enumerated, this method can be used to identify which of them is the Microsoft MIDI synthesizer. - -## -parameters -### -param midiDevice -An object that represents the device in question. - -## -returns -**True** if the device is the Microsoft MIDI synthesizer; otherwise, **false**. - - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Midi.MidiSynthesizer.IsSynthesizer(Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.IsSynthesizer + +## -description +Determines whether a particular device is an instance of the Microsoft MIDI synthesizer. When all MIDI out ports on the system are enumerated, this method can be used to identify which of them is the Microsoft MIDI synthesizer. + +## -parameters +### -param midiDevice +An object that represents the device in question. + +## -returns +**True** if the device is the Microsoft MIDI synthesizer; otherwise, **false**. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer_sendbuffer_69762025.md b/windows.devices.midi/midisynthesizer_sendbuffer_69762025.md index e779ce0530..4ef9608f7c 100644 --- a/windows.devices.midi/midisynthesizer_sendbuffer_69762025.md +++ b/windows.devices.midi/midisynthesizer_sendbuffer_69762025.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSynthesizer.SendBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Midi.MidiSynthesizer.SendBuffer ## -description Sends an array of bytes through the synthesizer's [out port](midioutport.md). This enables you to send your data as a byte array instead of as a defined MIDI message. ## -parameters ### -param midiData The array of bytes to send. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSynthesizer.SendBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.SendBuffer + +## -description +Sends an array of bytes through the synthesizer's [out port](midioutport.md). This enables you to send your data as a byte array instead of as a defined MIDI message. + +## -parameters +### -param midiData +The array of bytes to send. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer_sendmessage_275315374.md b/windows.devices.midi/midisynthesizer_sendmessage_275315374.md index 0402f8ab23..ae125eedc6 100644 --- a/windows.devices.midi/midisynthesizer_sendmessage_275315374.md +++ b/windows.devices.midi/midisynthesizer_sendmessage_275315374.md @@ -1,24 +1,24 @@ ---- --api-id: M:Windows.Devices.Midi.MidiSynthesizer.SendMessage(Windows.Devices.Midi.IMidiMessage) --api-type: winrt method ---- - - - -# Windows.Devices.Midi.MidiSynthesizer.SendMessage - -## -description -Sends a MIDI message through the Microsoft MIDI synthesizer's [out port](midioutport.md). - - -## -parameters -### -param midiMessage -The MIDI message to send. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Midi.MidiSynthesizer.SendMessage(Windows.Devices.Midi.IMidiMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.SendMessage + +## -description +Sends a MIDI message through the Microsoft MIDI synthesizer's [out port](midioutport.md). + + +## -parameters +### -param midiMessage +The MIDI message to send. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisynthesizer_volume.md b/windows.devices.midi/midisynthesizer_volume.md index 9a7b9b4bd2..8aec12ed96 100644 --- a/windows.devices.midi/midisynthesizer_volume.md +++ b/windows.devices.midi/midisynthesizer_volume.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSynthesizer.Volume --api-type: winrt property ---- # Windows.Devices.Midi.MidiSynthesizer.Volume ## -description Gets or sets the output volume of this instance of the Microsoft MIDI synthesizer. ## -property-value The synthesizer's output volume, a number between 0 and 1, inclusive. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSynthesizer.Volume +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSynthesizer.Volume + +## -description +Gets or sets the output volume of this instance of the Microsoft MIDI synthesizer. + +## -property-value +The synthesizer's output volume, a number between 0 and 1, inclusive. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemexclusivemessage.md b/windows.devices.midi/midisystemexclusivemessage.md index a528832274..1a8a453118 100644 --- a/windows.devices.midi/midisystemexclusivemessage.md +++ b/windows.devices.midi/midisystemexclusivemessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiSystemExclusiveMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiSystemExclusiveMessage ## -description Represents a MIDI message that specifies a system exclusive message. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiSystemExclusiveMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiSystemExclusiveMessage + +## -description +Represents a MIDI message that specifies a system exclusive message. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midisystemexclusivemessage_midisystemexclusivemessage_1985205386.md b/windows.devices.midi/midisystemexclusivemessage_midisystemexclusivemessage_1985205386.md index 331ce5d9ca..91ce8bbc8c 100644 --- a/windows.devices.midi/midisystemexclusivemessage_midisystemexclusivemessage_1985205386.md +++ b/windows.devices.midi/midisystemexclusivemessage_midisystemexclusivemessage_1985205386.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSystemExclusiveMessage.#ctor(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Midi.MidiSystemExclusiveMessage.MidiSystemExclusiveMessage ## -description Creates a new [MidiSystemExclusiveMessage](midisystemexclusivemessage.md) object. ## -parameters ### -param rawData The system exclusive data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSystemExclusiveMessage.#ctor(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSystemExclusiveMessage.MidiSystemExclusiveMessage + +## -description +Creates a new [MidiSystemExclusiveMessage](midisystemexclusivemessage.md) object. + +## -parameters +### -param rawData +The system exclusive data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemexclusivemessage_rawdata.md b/windows.devices.midi/midisystemexclusivemessage_rawdata.md index 4a5ca15c65..b896fdf8e4 100644 --- a/windows.devices.midi/midisystemexclusivemessage_rawdata.md +++ b/windows.devices.midi/midisystemexclusivemessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSystemExclusiveMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiSystemExclusiveMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSystemExclusiveMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSystemExclusiveMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemexclusivemessage_timestamp.md b/windows.devices.midi/midisystemexclusivemessage_timestamp.md index 89e83b032a..0bfea5db92 100644 --- a/windows.devices.midi/midisystemexclusivemessage_timestamp.md +++ b/windows.devices.midi/midisystemexclusivemessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSystemExclusiveMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiSystemExclusiveMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSystemExclusiveMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSystemExclusiveMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemexclusivemessage_type.md b/windows.devices.midi/midisystemexclusivemessage_type.md index a907c9b19e..25c0430ada 100644 --- a/windows.devices.midi/midisystemexclusivemessage_type.md +++ b/windows.devices.midi/midisystemexclusivemessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSystemExclusiveMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiSystemExclusiveMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSystemExclusiveMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSystemExclusiveMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemresetmessage.md b/windows.devices.midi/midisystemresetmessage.md index 58acbfcaf5..8ef97a88c2 100644 --- a/windows.devices.midi/midisystemresetmessage.md +++ b/windows.devices.midi/midisystemresetmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiSystemResetMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiSystemResetMessage ## -description Represents a MIDI message that specifies a system reset. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiSystemResetMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiSystemResetMessage + +## -description +Represents a MIDI message that specifies a system reset. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/midisystemresetmessage_midisystemresetmessage_1221375020.md b/windows.devices.midi/midisystemresetmessage_midisystemresetmessage_1221375020.md index f080d256a6..918aec1fa5 100644 --- a/windows.devices.midi/midisystemresetmessage_midisystemresetmessage_1221375020.md +++ b/windows.devices.midi/midisystemresetmessage_midisystemresetmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiSystemResetMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiSystemResetMessage.MidiSystemResetMessage ## -description Creates a new [MidiSystemResetMessage](midisystemresetmessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiSystemResetMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiSystemResetMessage.MidiSystemResetMessage + +## -description +Creates a new [MidiSystemResetMessage](midisystemresetmessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemresetmessage_rawdata.md b/windows.devices.midi/midisystemresetmessage_rawdata.md index 0aeb93d11f..d68187db92 100644 --- a/windows.devices.midi/midisystemresetmessage_rawdata.md +++ b/windows.devices.midi/midisystemresetmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSystemResetMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiSystemResetMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSystemResetMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSystemResetMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemresetmessage_timestamp.md b/windows.devices.midi/midisystemresetmessage_timestamp.md index bb00c0a580..76d8ebb562 100644 --- a/windows.devices.midi/midisystemresetmessage_timestamp.md +++ b/windows.devices.midi/midisystemresetmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSystemResetMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiSystemResetMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSystemResetMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSystemResetMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/midisystemresetmessage_type.md b/windows.devices.midi/midisystemresetmessage_type.md index 13007a1f8b..31d9e1d321 100644 --- a/windows.devices.midi/midisystemresetmessage_type.md +++ b/windows.devices.midi/midisystemresetmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiSystemResetMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiSystemResetMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiSystemResetMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiSystemResetMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimecodemessage.md b/windows.devices.midi/miditimecodemessage.md index 520b914896..d596c84f73 100644 --- a/windows.devices.midi/miditimecodemessage.md +++ b/windows.devices.midi/miditimecodemessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiTimeCodeMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiTimeCodeMessage ## -description Represents a MIDI message that specifies a time code. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiTimeCodeMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage + +## -description +Represents a MIDI message that specifies a time code. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/miditimecodemessage_frametype.md b/windows.devices.midi/miditimecodemessage_frametype.md index d4e41568e0..48d3c562ce 100644 --- a/windows.devices.midi/miditimecodemessage_frametype.md +++ b/windows.devices.midi/miditimecodemessage_frametype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.FrameType --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimeCodeMessage.FrameType ## -description Gets the value of the frame type from 0-7. ## -property-value The value of the frame type from 0-7. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.FrameType +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage.FrameType + +## -description +Gets the value of the frame type from 0-7. + +## -property-value +The value of the frame type from 0-7. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimecodemessage_miditimecodemessage_969710101.md b/windows.devices.midi/miditimecodemessage_miditimecodemessage_969710101.md index 1d8b04cc9e..61a6a72130 100644 --- a/windows.devices.midi/miditimecodemessage_miditimecodemessage_969710101.md +++ b/windows.devices.midi/miditimecodemessage_miditimecodemessage_969710101.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Midi.MidiTimeCodeMessage.#ctor(System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Devices.Midi.MidiTimeCodeMessage.MidiTimeCodeMessage ## -description Creates a new [MidiTimeCodeMessage](miditimecodemessage.md) object. ## -parameters ### -param frameType The frame type from 0-7. ### -param values The time code from 0-32. ## -remarks If any values passed into the constructor fo not adhere to the specified requirements, an invalid argument exception will be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiTimeCodeMessage.#ctor(System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage.MidiTimeCodeMessage + +## -description +Creates a new [MidiTimeCodeMessage](miditimecodemessage.md) object. + +## -parameters +### -param frameType +The frame type from 0-7. + +### -param values +The time code from 0-32. + +## -remarks +If any values passed into the constructor fo not adhere to the specified requirements, an invalid argument exception will be thrown. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimecodemessage_rawdata.md b/windows.devices.midi/miditimecodemessage_rawdata.md index 15d1cb7490..9ac881ef89 100644 --- a/windows.devices.midi/miditimecodemessage_rawdata.md +++ b/windows.devices.midi/miditimecodemessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimeCodeMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimecodemessage_timestamp.md b/windows.devices.midi/miditimecodemessage_timestamp.md index 8d4acefe92..bf13e5c524 100644 --- a/windows.devices.midi/miditimecodemessage_timestamp.md +++ b/windows.devices.midi/miditimecodemessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimeCodeMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimecodemessage_type.md b/windows.devices.midi/miditimecodemessage_type.md index 3576a1404a..6b626db176 100644 --- a/windows.devices.midi/miditimecodemessage_type.md +++ b/windows.devices.midi/miditimecodemessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimeCodeMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimecodemessage_values.md b/windows.devices.midi/miditimecodemessage_values.md index 4f27805d33..757fbdf48b 100644 --- a/windows.devices.midi/miditimecodemessage_values.md +++ b/windows.devices.midi/miditimecodemessage_values.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.Values --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimeCodeMessage.Values ## -description Gets the time code value from 0-32. ## -property-value The time code value from 0-32. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimeCodeMessage.Values +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimeCodeMessage.Values + +## -description +Gets the time code value from 0-32. + +## -property-value +The time code value from 0-32. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimingclockmessage.md b/windows.devices.midi/miditimingclockmessage.md index 34e625368a..93640bf0ca 100644 --- a/windows.devices.midi/miditimingclockmessage.md +++ b/windows.devices.midi/miditimingclockmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiTimingClockMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiTimingClockMessage ## -description Represents a MIDI message that specifies a timing clock. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiTimingClockMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiTimingClockMessage + +## -description +Represents a MIDI message that specifies a timing clock. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/miditimingclockmessage_miditimingclockmessage_1221375020.md b/windows.devices.midi/miditimingclockmessage_miditimingclockmessage_1221375020.md index 284853b65d..e64ac01d65 100644 --- a/windows.devices.midi/miditimingclockmessage_miditimingclockmessage_1221375020.md +++ b/windows.devices.midi/miditimingclockmessage_miditimingclockmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiTimingClockMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiTimingClockMessage.MidiTimingClockMessage ## -description Creates a new [MidiTimingClockMessage](miditimingclockmessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiTimingClockMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiTimingClockMessage.MidiTimingClockMessage + +## -description +Creates a new [MidiTimingClockMessage](miditimingclockmessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimingclockmessage_rawdata.md b/windows.devices.midi/miditimingclockmessage_rawdata.md index 04b353d044..6ec157aaeb 100644 --- a/windows.devices.midi/miditimingclockmessage_rawdata.md +++ b/windows.devices.midi/miditimingclockmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimingClockMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimingClockMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimingClockMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimingClockMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimingclockmessage_timestamp.md b/windows.devices.midi/miditimingclockmessage_timestamp.md index e2ff8a5d41..4c05f9b12a 100644 --- a/windows.devices.midi/miditimingclockmessage_timestamp.md +++ b/windows.devices.midi/miditimingclockmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimingClockMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimingClockMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimingClockMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimingClockMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditimingclockmessage_type.md b/windows.devices.midi/miditimingclockmessage_type.md index 86f3f90d87..ee5932f75c 100644 --- a/windows.devices.midi/miditimingclockmessage_type.md +++ b/windows.devices.midi/miditimingclockmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTimingClockMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiTimingClockMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTimingClockMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTimingClockMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditunerequestmessage.md b/windows.devices.midi/miditunerequestmessage.md index 7f3f375943..cd4b896208 100644 --- a/windows.devices.midi/miditunerequestmessage.md +++ b/windows.devices.midi/miditunerequestmessage.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Midi.MidiTuneRequestMessage --api-type: winrt class ---- # Windows.Devices.Midi.MidiTuneRequestMessage ## -description Represents a MIDI message that specifies a tune request. ## -remarks ## -examples ## -see-also [IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Midi.MidiTuneRequestMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Midi.MidiTuneRequestMessage + +## -description +Represents a MIDI message that specifies a tune request. + +## -remarks + +## -examples + +## -see-also +[IMidiMessage](imidimessage.md), [MIDI sample](http://go.microsoft.com/fwlink/p/?LinkID=394281) \ No newline at end of file diff --git a/windows.devices.midi/miditunerequestmessage_miditunerequestmessage_1221375020.md b/windows.devices.midi/miditunerequestmessage_miditunerequestmessage_1221375020.md index 69514afdc2..6cd4d22b6c 100644 --- a/windows.devices.midi/miditunerequestmessage_miditunerequestmessage_1221375020.md +++ b/windows.devices.midi/miditunerequestmessage_miditunerequestmessage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Midi.MidiTuneRequestMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Midi.MidiTuneRequestMessage.MidiTuneRequestMessage ## -description Creates a new [MidiTuneRequestMessage](miditunerequestmessage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Midi.MidiTuneRequestMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Midi.MidiTuneRequestMessage.MidiTuneRequestMessage + +## -description +Creates a new [MidiTuneRequestMessage](miditunerequestmessage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditunerequestmessage_rawdata.md b/windows.devices.midi/miditunerequestmessage_rawdata.md index c1396954b1..0b7963fff1 100644 --- a/windows.devices.midi/miditunerequestmessage_rawdata.md +++ b/windows.devices.midi/miditunerequestmessage_rawdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTuneRequestMessage.RawData --api-type: winrt property ---- # Windows.Devices.Midi.MidiTuneRequestMessage.RawData ## -description Gets the array of bytes associated with the MIDI message, including status byte. ## -property-value The array of bytes associated with the MIDI message. ## -remarks This property is immutable after initialization. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTuneRequestMessage.RawData +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTuneRequestMessage.RawData + +## -description +Gets the array of bytes associated with the MIDI message, including status byte. + +## -property-value +The array of bytes associated with the MIDI message. + +## -remarks +This property is immutable after initialization. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditunerequestmessage_timestamp.md b/windows.devices.midi/miditunerequestmessage_timestamp.md index 8ba9f4593c..8abf589d09 100644 --- a/windows.devices.midi/miditunerequestmessage_timestamp.md +++ b/windows.devices.midi/miditunerequestmessage_timestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTuneRequestMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Midi.MidiTuneRequestMessage.Timestamp ## -description Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -property-value The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. ## -remarks For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTuneRequestMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTuneRequestMessage.Timestamp + +## -description +Gets the duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -property-value +The duration from when the [MidiInPort](midiinport.md) was created to the time the message was received. + +## -remarks +For messages being sent to a [MidiOutPort](midioutport.md), this value has no meaning. + +## -examples + +## -see-also diff --git a/windows.devices.midi/miditunerequestmessage_type.md b/windows.devices.midi/miditunerequestmessage_type.md index 39ac44be24..acfb7c9068 100644 --- a/windows.devices.midi/miditunerequestmessage_type.md +++ b/windows.devices.midi/miditunerequestmessage_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Midi.MidiTuneRequestMessage.Type --api-type: winrt property ---- # Windows.Devices.Midi.MidiTuneRequestMessage.Type ## -description Gets the type of this MIDI message. ## -property-value The MIDI message type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Midi.MidiTuneRequestMessage.Type +-api-type: winrt property +--- + + + +# Windows.Devices.Midi.MidiTuneRequestMessage.Type + +## -description +Gets the type of this MIDI message. + +## -property-value +The MIDI message type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovider_available.md b/windows.devices.perception.provider/iperceptionframeprovider_available.md index a0488d3bc3..2411266d0a 100644 --- a/windows.devices.perception.provider/iperceptionframeprovider_available.md +++ b/windows.devices.perception.provider/iperceptionframeprovider_available.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Available --api-type: winrt property ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Available ## -description Gets a value indicating whether or not the device is ready to start producing PerceptionFrames. ## -property-value Whether or not the device is ready to start producing PerceptionFrames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Available +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Available + +## -description +Gets a value indicating whether or not the device is ready to start producing PerceptionFrames. + +## -property-value +Whether or not the device is ready to start producing PerceptionFrames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovider_frameproviderinfo.md b/windows.devices.perception.provider/iperceptionframeprovider_frameproviderinfo.md index 79d443e62b..6ad0573e0a 100644 --- a/windows.devices.perception.provider/iperceptionframeprovider_frameproviderinfo.md +++ b/windows.devices.perception.provider/iperceptionframeprovider_frameproviderinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.FrameProviderInfo --api-type: winrt property ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProvider.FrameProviderInfo ## -description Gets the PerceptionFrameProviderInfo describing this device. ## -property-value The PerceptionFrameProviderInfo describing this device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.FrameProviderInfo +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProvider.FrameProviderInfo + +## -description +Gets the PerceptionFrameProviderInfo describing this device. + +## -property-value +The PerceptionFrameProviderInfo describing this device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovider_properties.md b/windows.devices.perception.provider/iperceptionframeprovider_properties.md index 0a04eda098..dce4bfe221 100644 --- a/windows.devices.perception.provider/iperceptionframeprovider_properties.md +++ b/windows.devices.perception.provider/iperceptionframeprovider_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Properties --api-type: winrt property ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Properties ## -description The properties describing the device and the frames produced by the device. ## -property-value The properties describing the device and the frames produced by the device. PropertyType::Inspectable is not supported as a property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Properties + +## -description +The properties describing the device and the frames produced by the device. + +## -property-value +The properties describing the device and the frames produced by the device. PropertyType::Inspectable is not supported as a property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovider_setproperty.md b/windows.devices.perception.provider/iperceptionframeprovider_setproperty.md index aa3f5f812a..28f6021066 100644 --- a/windows.devices.perception.provider/iperceptionframeprovider_setproperty.md +++ b/windows.devices.perception.provider/iperceptionframeprovider_setproperty.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.SetProperty(Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProvider.SetProperty ## -description The device is requested to update one of its Properties to a new value. ## -parameters ### -param value Success or failure will be conveyed to the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.SetProperty(Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProvider.SetProperty + +## -description +The device is requested to update one of its Properties to a new value. + +## -parameters +### -param value +Success or failure will be conveyed to the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovider_start.md b/windows.devices.perception.provider/iperceptionframeprovider_start.md index f71bffa50d..3931404255 100644 --- a/windows.devices.perception.provider/iperceptionframeprovider_start.md +++ b/windows.devices.perception.provider/iperceptionframeprovider_start.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Start --api-type: winrt method ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Start ## -description Tells the device to start producing frames. If success is returned, PerceptionFrameProviderManagerService::PublishFrameForProvider is expected to be called by this Provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Start + +## -description +Tells the device to start producing frames. If success is returned, PerceptionFrameProviderManagerService::PublishFrameForProvider is expected to be called by this Provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovider_stop.md b/windows.devices.perception.provider/iperceptionframeprovider_stop.md index e1f5d4b60f..68f96300f3 100644 --- a/windows.devices.perception.provider/iperceptionframeprovider_stop.md +++ b/windows.devices.perception.provider/iperceptionframeprovider_stop.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Stop --api-type: winrt method ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Stop ## -description Tells the device to stop producing frames. Called only after Start is called and only if Start returns success. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProvider.Stop + +## -description +Tells the device to stop producing frames. Called only after Start is called and only if Start returns success. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/iperceptionframeprovidermanager_getframeprovider.md b/windows.devices.perception.provider/iperceptionframeprovidermanager_getframeprovider.md index 8e7f2140e6..28b5a33922 100644 --- a/windows.devices.perception.provider/iperceptionframeprovidermanager_getframeprovider.md +++ b/windows.devices.perception.provider/iperceptionframeprovidermanager_getframeprovider.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager.GetFrameProvider(Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager.GetFrameProvider ## -description The method to request an IPerceptionFrameProvider associated with a registered PerceptionFrameProviderInfo. ## -parameters ### -param frameProviderInfo The info specifying the desired IPerceptionFrameProvider. ## -returns The associated IPerceptionFrameProvider, or nullptr if there is no such registerd provider. ## -remarks A request with a registered info is expected to return S_OK and a valid IPerceptionFrameProvider, or the appropriate error code. Any requests with a PerceptionFrameProviderInfo which has not been registered or has since been unregistered are expected to return S_OK and nullptr. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager.GetFrameProvider(Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager.GetFrameProvider + +## -description +The method to request an IPerceptionFrameProvider associated with a registered PerceptionFrameProviderInfo. + +## -parameters +### -param frameProviderInfo +The info specifying the desired IPerceptionFrameProvider. + +## -returns +The associated IPerceptionFrameProvider, or nullptr if there is no such registerd provider. + +## -remarks +A request with a registered info is expected to return S_OK and a valid IPerceptionFrameProvider, or the appropriate error code. Any requests with a PerceptionFrameProviderInfo which has not been registered or has since been unregistered are expected to return S_OK and nullptr. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/knownperceptionframekind.md b/windows.devices.perception.provider/knownperceptionframekind.md index 521a471c91..de53434051 100644 --- a/windows.devices.perception.provider/knownperceptionframekind.md +++ b/windows.devices.perception.provider/knownperceptionframekind.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind --api-type: winrt class ---- # Windows.Devices.Perception.Provider.KnownPerceptionFrameKind ## -description A string used to identify the type classification of a frame. ## -remarks Possible values are Color, Depth, and Infrared. FrameProviders must indicate the type of frames they return by setting a FrameKind property on the IPerceptionFrameProviderInfo that matches one of the values retrieved from this static class. For example, if your FrameProvider returns Color frames, the FrameKind property of the IPerceptionFrameProviderInfo objects your provider must be set KnownPerceptionFrameKind::Color. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.KnownPerceptionFrameKind + +## -description +A string used to identify the type classification of a frame. + +## -remarks +Possible values are Color, Depth, and Infrared. + +FrameProviders must indicate the type of frames they return by setting a FrameKind property on the IPerceptionFrameProviderInfo that matches one of the values retrieved from this static class. + +For example, if your FrameProvider returns Color frames, the FrameKind property of the IPerceptionFrameProviderInfo objects your provider must be set KnownPerceptionFrameKind::Color. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/knownperceptionframekind_color.md b/windows.devices.perception.provider/knownperceptionframekind_color.md index 2737823de8..406bf89110 100644 --- a/windows.devices.perception.provider/knownperceptionframekind_color.md +++ b/windows.devices.perception.provider/knownperceptionframekind_color.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Color --api-type: winrt property ---- # Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Color ## -description Gets the string representing the Color FrameKind of a PerceptionFrameProviderInfo. ## -property-value The string representing the Color FrameKind of a PerceptionFrameProviderInfo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Color +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Color + +## -description +Gets the string representing the Color FrameKind of a PerceptionFrameProviderInfo. + +## -property-value +The string representing the Color FrameKind of a PerceptionFrameProviderInfo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/knownperceptionframekind_depth.md b/windows.devices.perception.provider/knownperceptionframekind_depth.md index 860263152e..9319106329 100644 --- a/windows.devices.perception.provider/knownperceptionframekind_depth.md +++ b/windows.devices.perception.provider/knownperceptionframekind_depth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Depth --api-type: winrt property ---- # Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Depth ## -description Gets the string representing the Depth FrameKind of a PerceptionFrameProviderInfo. ## -property-value The string representing the Depth FrameKind of a PerceptionFrameProviderInfo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Depth +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Depth + +## -description +Gets the string representing the Depth FrameKind of a PerceptionFrameProviderInfo. + +## -property-value +The string representing the Depth FrameKind of a PerceptionFrameProviderInfo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/knownperceptionframekind_infrared.md b/windows.devices.perception.provider/knownperceptionframekind_infrared.md index 6d07efe04a..127440127d 100644 --- a/windows.devices.perception.provider/knownperceptionframekind_infrared.md +++ b/windows.devices.perception.provider/knownperceptionframekind_infrared.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Infrared --api-type: winrt property ---- # Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Infrared ## -description Gets the string representing the Infrared FrameKind of a PerceptionFrameProviderInfo. ## -property-value The string representing the Infrared FrameKind of a PerceptionFrameProviderInfo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Infrared +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.KnownPerceptionFrameKind.Infrared + +## -description +Gets the string representing the Infrared FrameKind of a PerceptionFrameProviderInfo. + +## -property-value +The string representing the Infrared FrameKind of a PerceptionFrameProviderInfo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncontrolgroup.md b/windows.devices.perception.provider/perceptioncontrolgroup.md index 9a75100c78..47af1d10b1 100644 --- a/windows.devices.perception.provider/perceptioncontrolgroup.md +++ b/windows.devices.perception.provider/perceptioncontrolgroup.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionControlGroup --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionControlGroup ## -description A group of IPerceptionFrameProvider identifiers to be controlled together. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionControlGroup +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionControlGroup + +## -description +A group of IPerceptionFrameProvider identifiers to be controlled together. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncontrolgroup_frameproviderids.md b/windows.devices.perception.provider/perceptioncontrolgroup_frameproviderids.md index c7cf62665a..0126588dde 100644 --- a/windows.devices.perception.provider/perceptioncontrolgroup_frameproviderids.md +++ b/windows.devices.perception.provider/perceptioncontrolgroup_frameproviderids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionControlGroup.FrameProviderIds --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionControlGroup.FrameProviderIds ## -description The id(s) of the IPerceptionFrameProvider(s) controlled by this group. ## -property-value The id(s) of the IPerceptionFrameProvider(s) controlled by this group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionControlGroup.FrameProviderIds +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionControlGroup.FrameProviderIds + +## -description +The id(s) of the IPerceptionFrameProvider(s) controlled by this group. + +## -property-value +The id(s) of the IPerceptionFrameProvider(s) controlled by this group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncontrolgroup_perceptioncontrolgroup_1181929246.md b/windows.devices.perception.provider/perceptioncontrolgroup_perceptioncontrolgroup_1181929246.md index b6102f40a9..693592ca08 100644 --- a/windows.devices.perception.provider/perceptioncontrolgroup_perceptioncontrolgroup_1181929246.md +++ b/windows.devices.perception.provider/perceptioncontrolgroup_perceptioncontrolgroup_1181929246.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionControlGroup.#ctor(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionControlGroup.PerceptionControlGroup ## -description Creates a PerceptionControlGroup containing the IPerceptionFrameProviders with the ids specified. ## -parameters ### -param ids A list of the unique identifiers associated with the grouped IPerceptionFrameProviders. To be controllable, the id must match the associated PerceptionFrameProviderInfo::Id property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionControlGroup.#ctor(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionControlGroup.PerceptionControlGroup + +## -description +Creates a PerceptionControlGroup containing the IPerceptionFrameProviders with the ids specified. + +## -parameters +### -param ids +A list of the unique identifiers associated with the grouped IPerceptionFrameProviders. To be controllable, the id must match the associated PerceptionFrameProviderInfo::Id property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelation.md b/windows.devices.perception.provider/perceptioncorrelation.md index f0e8b6b048..4233bdca44 100644 --- a/windows.devices.perception.provider/perceptioncorrelation.md +++ b/windows.devices.perception.provider/perceptioncorrelation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionCorrelation --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionCorrelation ## -description A description of the physical position and orientation of a device specified by the IPerceptionFrameProvider's unique identifier (PerceptionFrameProviderInfo::Id) sharing a common coordinate frame of other PerceptionCorrelations that will be combined into a PerceptionCorrelationGroup. ## -remarks The origin of this coordinate frame can be the position of one of the cameras in the PerceptionCorrelationGroup such that one camera will have a Windows::Foundation::Numerics::Vector3::Zero Position and all others will not. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionCorrelation +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelation + +## -description +A description of the physical position and orientation of a device specified by the IPerceptionFrameProvider's unique identifier (PerceptionFrameProviderInfo::Id) sharing a common coordinate frame of other PerceptionCorrelations that will be combined into a PerceptionCorrelationGroup. + +## -remarks +The origin of this coordinate frame can be the position of one of the cameras in the PerceptionCorrelationGroup such that one camera will have a Windows::Foundation::Numerics::Vector3::Zero Position and all others will not. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelation_orientation.md b/windows.devices.perception.provider/perceptioncorrelation_orientation.md index f1fe3b4adf..0de8aeb22c 100644 --- a/windows.devices.perception.provider/perceptioncorrelation_orientation.md +++ b/windows.devices.perception.provider/perceptioncorrelation_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelation.Orientation --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionCorrelation.Orientation ## -description The orientation of the device in the common coordinate frame shared by other PerceptionCorrelations in the PerceptionCorrelationGroup. ## -property-value The orientation of the described device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelation.Orientation +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelation.Orientation + +## -description +The orientation of the device in the common coordinate frame shared by other PerceptionCorrelations in the PerceptionCorrelationGroup. + +## -property-value +The orientation of the described device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelation_perceptioncorrelation_1236693052.md b/windows.devices.perception.provider/perceptioncorrelation_perceptioncorrelation_1236693052.md index a56e9ca9f4..480806235c 100644 --- a/windows.devices.perception.provider/perceptioncorrelation_perceptioncorrelation_1236693052.md +++ b/windows.devices.perception.provider/perceptioncorrelation_perceptioncorrelation_1236693052.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionCorrelation.#ctor(System.String,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Quaternion) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionCorrelation.PerceptionCorrelation ## -description Initializes a new PerceptionCorrelation instance. ## -parameters ### -param targetId The unique identifier of the IPerceptionFrameProvider being described. ### -param position The position of the device in a common coordinate frame of all members of a PerceptionCorrelationGroup. ### -param orientation The orientation of the device in a common coordinate frame of all members of a PerceptionCorrelationGroup. ## -remarks Creates a PerceptionCorrelation associating a position and orientation with the unique identifier of an IPerceptionFrameProvider (via its PerceptionFrameProviderInfo::Id). When combined into an PerceptionCorrelationGroup, relative positions and orientations can be obtained to correlate resulting frames from each IPerceptionFrameProvider in the group. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionCorrelation.#ctor(System.String,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Quaternion) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelation.PerceptionCorrelation + +## -description +Initializes a new PerceptionCorrelation instance. + +## -parameters +### -param targetId +The unique identifier of the IPerceptionFrameProvider being described. + +### -param position +The position of the device in a common coordinate frame of all members of a PerceptionCorrelationGroup. + +### -param orientation +The orientation of the device in a common coordinate frame of all members of a PerceptionCorrelationGroup. + +## -remarks +Creates a PerceptionCorrelation associating a position and orientation with the unique identifier of an IPerceptionFrameProvider (via its PerceptionFrameProviderInfo::Id). When combined into an PerceptionCorrelationGroup, relative positions and orientations can be obtained to correlate resulting frames from each IPerceptionFrameProvider in the group. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelation_position.md b/windows.devices.perception.provider/perceptioncorrelation_position.md index 6d0b798855..f4ac919109 100644 --- a/windows.devices.perception.provider/perceptioncorrelation_position.md +++ b/windows.devices.perception.provider/perceptioncorrelation_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelation.Position --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionCorrelation.Position ## -description The position of the device in the common coordinate frame shared by other PerceptionCorrelations in the PerceptionCorrelationGroup. ## -property-value The position of the described device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelation.Position +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelation.Position + +## -description +The position of the device in the common coordinate frame shared by other PerceptionCorrelations in the PerceptionCorrelationGroup. + +## -property-value +The position of the described device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelation_targetid.md b/windows.devices.perception.provider/perceptioncorrelation_targetid.md index 8b6bd665c8..a32b8eb9cd 100644 --- a/windows.devices.perception.provider/perceptioncorrelation_targetid.md +++ b/windows.devices.perception.provider/perceptioncorrelation_targetid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelation.TargetId --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionCorrelation.TargetId ## -description The unique identifier of the described device. ## -property-value The unique identifier of the described device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelation.TargetId +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelation.TargetId + +## -description +The unique identifier of the described device. + +## -property-value +The unique identifier of the described device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelationgroup.md b/windows.devices.perception.provider/perceptioncorrelationgroup.md index 919a57ebca..4098b385b3 100644 --- a/windows.devices.perception.provider/perceptioncorrelationgroup.md +++ b/windows.devices.perception.provider/perceptioncorrelationgroup.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionCorrelationGroup --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionCorrelationGroup ## -description A collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionCorrelationGroup +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelationGroup + +## -description +A collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelationgroup_perceptioncorrelationgroup_931448428.md b/windows.devices.perception.provider/perceptioncorrelationgroup_perceptioncorrelationgroup_931448428.md index 8f1075fbbc..0b5ee4d8f7 100644 --- a/windows.devices.perception.provider/perceptioncorrelationgroup_perceptioncorrelationgroup_931448428.md +++ b/windows.devices.perception.provider/perceptioncorrelationgroup_perceptioncorrelationgroup_931448428.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Perception.Provider.PerceptionCorrelation}) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.PerceptionCorrelationGroup ## -description Initializes a new PerceptionCorrelationGroup from a collection of one or more PerceptionCorrelation objects describing multiple providers in a common coordinate frame. ## -parameters ### -param relativeLocations The collection of PerceptionCorrelations describing multiple providers in a common coordinate frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.#ctor(Windows.Foundation.Collections.IIterable{Windows.Devices.Perception.Provider.PerceptionCorrelation}) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.PerceptionCorrelationGroup + +## -description +Initializes a new PerceptionCorrelationGroup from a collection of one or more PerceptionCorrelation objects describing multiple providers in a common coordinate frame. + +## -parameters +### -param relativeLocations +The collection of PerceptionCorrelations describing multiple providers in a common coordinate frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptioncorrelationgroup_relativelocations.md b/windows.devices.perception.provider/perceptioncorrelationgroup_relativelocations.md index 9444dc0990..609705ce0d 100644 --- a/windows.devices.perception.provider/perceptioncorrelationgroup_relativelocations.md +++ b/windows.devices.perception.provider/perceptioncorrelationgroup_relativelocations.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.RelativeLocations --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.RelativeLocations ## -description The collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame. ## -property-value The collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.RelativeLocations +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionCorrelationGroup.RelativeLocations + +## -description +The collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame. + +## -property-value +The collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionfaceauthenticationgroup.md b/windows.devices.perception.provider/perceptionfaceauthenticationgroup.md index 91f97e6974..233ac76946 100644 --- a/windows.devices.perception.provider/perceptionfaceauthenticationgroup.md +++ b/windows.devices.perception.provider/perceptionfaceauthenticationgroup.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup ## -description A group of unique identifiers specifying IPerceptionFrameProviders that share handlers for entering and exiting Face Authentication mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup + +## -description +A group of unique identifiers specifying IPerceptionFrameProviders that share handlers for entering and exiting Face Authentication mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionfaceauthenticationgroup_frameproviderids.md b/windows.devices.perception.provider/perceptionfaceauthenticationgroup_frameproviderids.md index 1ccefd53a1..29c8d314b0 100644 --- a/windows.devices.perception.provider/perceptionfaceauthenticationgroup_frameproviderids.md +++ b/windows.devices.perception.provider/perceptionfaceauthenticationgroup_frameproviderids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.FrameProviderIds --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.FrameProviderIds ## -description The id(s) of the IPerceptionFrameProvider(s) referenced by this group. ## -property-value The id(s) of the IPerceptionFrameProvider(s) referenced by this group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.FrameProviderIds +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.FrameProviderIds + +## -description +The id(s) of the IPerceptionFrameProvider(s) referenced by this group. + +## -property-value +The id(s) of the IPerceptionFrameProvider(s) referenced by this group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionfaceauthenticationgroup_perceptionfaceauthenticationgroup_966035936.md b/windows.devices.perception.provider/perceptionfaceauthenticationgroup_perceptionfaceauthenticationgroup_966035936.md index 799e973cdb..499738ab7c 100644 --- a/windows.devices.perception.provider/perceptionfaceauthenticationgroup_perceptionfaceauthenticationgroup_966035936.md +++ b/windows.devices.perception.provider/perceptionfaceauthenticationgroup_perceptionfaceauthenticationgroup_966035936.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.#ctor(Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Perception.Provider.PerceptionStartFaceAuthenticationHandler,Windows.Devices.Perception.Provider.PerceptionStopFaceAuthenticationHandler) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.PerceptionFaceAuthenticationGroup ## -description Initializes a new PerceptionFaceAuthenticationGroup instance. ## -parameters ### -param ids The collection of unique identifiers which maps to IPerceptionFrameProviders via PerceptionFrameProviderInfo::Id. ### -param startHandler The handler to invoke when this group is requested to enter Face Authentication mode returning if it's ready. ### -param stopHandler The handler to invoke when this group is leaving Face Authentication mode after startHandler is called and returned true. ## -remarks Creates a PerceptionFaceAuthenticationGroup from a collection of unique identifiers specifying IPerceptionFrameProviders, a handler for the start of Face Authentication, and a handler for the end of Face Authentication. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.#ctor(Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Perception.Provider.PerceptionStartFaceAuthenticationHandler,Windows.Devices.Perception.Provider.PerceptionStopFaceAuthenticationHandler) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup.PerceptionFaceAuthenticationGroup + +## -description +Initializes a new PerceptionFaceAuthenticationGroup instance. + +## -parameters +### -param ids +The collection of unique identifiers which maps to IPerceptionFrameProviders via PerceptionFrameProviderInfo::Id. + +### -param startHandler +The handler to invoke when this group is requested to enter Face Authentication mode returning if it's ready. + +### -param stopHandler +The handler to invoke when this group is leaving Face Authentication mode after startHandler is called and returned true. + +## -remarks +Creates a PerceptionFaceAuthenticationGroup from a collection of unique identifiers specifying IPerceptionFrameProviders, a handler for the start of Face Authentication, and a handler for the end of Face Authentication. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframe.md b/windows.devices.perception.provider/perceptionframe.md index a8b65f719e..00bc81a089 100644 --- a/windows.devices.perception.provider/perceptionframe.md +++ b/windows.devices.perception.provider/perceptionframe.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionFrame --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionFrame ## -description Represents a frame of data from the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionFrame +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrame + +## -description +Represents a frame of data from the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframe_framedata.md b/windows.devices.perception.provider/perceptionframe_framedata.md index 484675b87f..9c1feef2be 100644 --- a/windows.devices.perception.provider/perceptionframe_framedata.md +++ b/windows.devices.perception.provider/perceptionframe_framedata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrame.FrameData --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrame.FrameData ## -description The actual bytes of the frame which can be consumed as described by the Properties of the IPerceptionFrameProvider which produced the frame. ## -property-value The bytes of the frames. ## -remarks To write to these bytes, one can use Windows::Foundation::IMemoryBuffer::CreateReference() to create a Windows::Foundation::IMemoryBufferReference. That can then be converted to a Windows::Foundation::IMemoryBufferByteAccess and call GetBuffer() on that to get to the raw byte buffer. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrame.FrameData +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrame.FrameData + +## -description +The actual bytes of the frame which can be consumed as described by the Properties of the IPerceptionFrameProvider which produced the frame. + +## -property-value +The bytes of the frames. + +## -remarks +To write to these bytes, one can use Windows::Foundation::IMemoryBuffer::CreateReference() to create a Windows::Foundation::IMemoryBufferReference. That can then be converted to a Windows::Foundation::IMemoryBufferByteAccess and call GetBuffer() on that to get to the raw byte buffer. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframe_properties.md b/windows.devices.perception.provider/perceptionframe_properties.md index 794726a2ad..f3ffc0c41d 100644 --- a/windows.devices.perception.provider/perceptionframe_properties.md +++ b/windows.devices.perception.provider/perceptionframe_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrame.Properties --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrame.Properties ## -description Gets the Properties for this frame. ## -property-value The Properties for this frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrame.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrame.Properties + +## -description +Gets the Properties for this frame. + +## -property-value +The Properties for this frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframe_relativetime.md b/windows.devices.perception.provider/perceptionframe_relativetime.md index 2828a09907..4e33ce079c 100644 --- a/windows.devices.perception.provider/perceptionframe_relativetime.md +++ b/windows.devices.perception.provider/perceptionframe_relativetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrame.RelativeTime --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrame.RelativeTime ## -description Gets or sets the Relative Time of this frame relative to other frames from this IPerceptionFrameProvider. ## -property-value The Relative Time of this frame relative to other frames from this IPerceptionFrameProvider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrame.RelativeTime +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrame.RelativeTime + +## -description +Gets or sets the Relative Time of this frame relative to other frames from this IPerceptionFrameProvider. + +## -property-value +The Relative Time of this frame relative to other frames from this IPerceptionFrameProvider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo.md b/windows.devices.perception.provider/perceptionframeproviderinfo.md index 60cd8f2069..8f9cc8c94c 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo.md @@ -1,3 +1,38 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo ## -description A specific set of properties describing a unique IPerceptionFrameProvider. ## -remarks The properties are: Id - A unique identifier of the IPerceptionFrameProvider, for example, a GUID or "com.contoso.depthcamera.x500.serialNumber1234". + This id must be persistent across reboots. + This id must be different between devices for a single manufacturer. + This id must be approximately globally unique such that there are no conflicts on any one host. DisplayName - A friendly name for the provider, for example, "Contoso Depth Camera x500". DeviceKind - A descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". FrameKind - The type of frames the device creates. This must be one of: + KnownPerceptionFrameKind::Color + KnownPerceptionFrameKind::Depth + KnownPerceptionFrameKind::Infrared Hidden - Whether or not the device enumerates via FindAllAsync or device added events on source watchers. If false, the device is accessible only via FromIdAsync. If false, and the device is registered in a FaceAuthenticationGroup, the device is still enumerated as a Face Authentication source. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo + +## -description +A specific set of properties describing a unique IPerceptionFrameProvider. + +## -remarks +The properties are: + +Id - A unique identifier of the IPerceptionFrameProvider, for example, a GUID or "com.contoso.depthcamera.x500.serialNumber1234". ++ This id must be persistent across reboots. ++ This id must be different between devices for a single manufacturer. ++ This id must be approximately globally unique such that there are no conflicts on any one host. + + +DisplayName - A friendly name for the provider, for example, "Contoso Depth Camera x500". + +DeviceKind - A descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". + +FrameKind - The type of frames the device creates. This must be one of: ++ KnownPerceptionFrameKind::Color ++ KnownPerceptionFrameKind::Depth ++ KnownPerceptionFrameKind::Infrared + + +Hidden - Whether or not the device enumerates via FindAllAsync or device added events on source watchers. If false, the device is accessible only via FromIdAsync. If false, and the device is registered in a FaceAuthenticationGroup, the device is still enumerated as a Face Authentication source. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo_devicekind.md b/windows.devices.perception.provider/perceptionframeproviderinfo_devicekind.md index 294cbad833..5d96f2d705 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo_devicekind.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo_devicekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DeviceKind --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DeviceKind ## -description Gets or sets the descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". ## -property-value The descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DeviceKind +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DeviceKind + +## -description +Gets or sets the descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". + +## -property-value +The descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo_displayname.md b/windows.devices.perception.provider/perceptionframeproviderinfo_displayname.md index 3aa4710ccc..61a4126be7 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo_displayname.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DisplayName --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DisplayName ## -description Gets or sets the friendly name for the device, for example, "Contoso Depth Camera x500". ## -property-value The friendly name for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.DisplayName + +## -description +Gets or sets the friendly name for the device, for example, "Contoso Depth Camera x500". + +## -property-value +The friendly name for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo_framekind.md b/windows.devices.perception.provider/perceptionframeproviderinfo_framekind.md index a35f910c98..74e14472ef 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo_framekind.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo_framekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.FrameKind --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.FrameKind ## -description Gets or sets the type of frames the device creates. ## -property-value The type of frames the device creates. Must be one of: IKnownPerceptionFrameKind::Color, IKnownPerceptionFrameKind::Depth, or IKnownPerceptionFrameKind::Infrared. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.FrameKind +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.FrameKind + +## -description +Gets or sets the type of frames the device creates. + +## -property-value +The type of frames the device creates. Must be one of: IKnownPerceptionFrameKind::Color, IKnownPerceptionFrameKind::Depth, or IKnownPerceptionFrameKind::Infrared. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo_hidden.md b/windows.devices.perception.provider/perceptionframeproviderinfo_hidden.md index 70645bb2e8..401543e699 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo_hidden.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo_hidden.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Hidden --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Hidden ## -description Gets or sets a value indicating whether the device enumerates via FindAllAsync or device-added events on source watchers. ## -property-value True if the device enumerates via FindAllAsync or device added events on source watchers; otherwise, false. If false, the device will only be accessible via FromIdAsync. If false, the device will enumerate as a Face Authentication source, if registered via PerceptionFrameProviderManagerService::RegisterFaceAuthenticationGroup(). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Hidden +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Hidden + +## -description +Gets or sets a value indicating whether the device enumerates via FindAllAsync or device-added events on source watchers. + +## -property-value +True if the device enumerates via FindAllAsync or device added events on source watchers; otherwise, false. If false, the device will only be accessible via FromIdAsync. If false, the device will enumerate as a Face Authentication source, if registered via PerceptionFrameProviderManagerService::RegisterFaceAuthenticationGroup(). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo_id.md b/windows.devices.perception.provider/perceptionframeproviderinfo_id.md index 52fc00ae68..cb2986e089 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo_id.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Id --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Id ## -description Gets or sets the unique identifier of the IPerceptionFrameProvider. ## -property-value The unique identifier of the IPerceptionFrameProvider, for example, a GUID, or "com.contoso.depthcamera.x500.serialNumber1234". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.Id + +## -description +Gets or sets the unique identifier of the IPerceptionFrameProvider. + +## -property-value +The unique identifier of the IPerceptionFrameProvider, for example, a GUID, or "com.contoso.depthcamera.x500.serialNumber1234". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeproviderinfo_perceptionframeproviderinfo_1221375020.md b/windows.devices.perception.provider/perceptionframeproviderinfo_perceptionframeproviderinfo_1221375020.md index ec241d4a1c..a220e02fc4 100644 --- a/windows.devices.perception.provider/perceptionframeproviderinfo_perceptionframeproviderinfo_1221375020.md +++ b/windows.devices.perception.provider/perceptionframeproviderinfo_perceptionframeproviderinfo_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.#ctor --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.PerceptionFrameProviderInfo ## -description Initializes a new PerceptionFrameProviderInfo instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo.PerceptionFrameProviderInfo + +## -description +Initializes a new PerceptionFrameProviderInfo instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice.md index 51bf036954..6183043827 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService ## -description Static methods for managing IPerceptionFrameProvider registration and unregistration, PerceptionFaceAuthenticationGroup registration and unregistration, PerceptionControlGroup registration and unregistration, PerceptionCorrelationGroup registration and unregistration, IPerceptionFrameProvider availablity, and publishing a new PerceptionFrame for an IPerceptionFrameProvider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService + +## -description +Static methods for managing IPerceptionFrameProvider registration and unregistration, PerceptionFaceAuthenticationGroup registration and unregistration, PerceptionControlGroup registration and unregistration, PerceptionCorrelationGroup registration and unregistration, IPerceptionFrameProvider availablity, and publishing a new PerceptionFrame for an IPerceptionFrameProvider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_publishframeforprovider_1261268620.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_publishframeforprovider_1261268620.md index 7f282cecba..37eba0441f 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_publishframeforprovider_1261268620.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_publishframeforprovider_1261268620.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.PublishFrameForProvider(Windows.Devices.Perception.Provider.IPerceptionFrameProvider,Windows.Devices.Perception.Provider.PerceptionFrame) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.PublishFrameForProvider ## -description Sends the PerceptionFrame to the service to tell any apps listening for frames for the provided provider. Frames aren't expected to be published before IPerceptionFrameProvider::Start() is called or after IPerceptionFrameProvider::Stop() is called. ## -parameters ### -param provider The IPerceptionFrameProvider which produced the frame. ### -param frame The PerceptionFrame that was produced and should be sent to apps. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.PublishFrameForProvider(Windows.Devices.Perception.Provider.IPerceptionFrameProvider,Windows.Devices.Perception.Provider.PerceptionFrame) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.PublishFrameForProvider + +## -description +Sends the PerceptionFrame to the service to tell any apps listening for frames for the provided provider. Frames aren't expected to be published before IPerceptionFrameProvider::Start() is called or after IPerceptionFrameProvider::Stop() is called. + +## -parameters +### -param provider +The IPerceptionFrameProvider which produced the frame. + +### -param frame +The PerceptionFrame that was produced and should be sent to apps. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercontrolgroup_153507926.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercontrolgroup_153507926.md index a0261844d3..244934a5c9 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercontrolgroup_153507926.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercontrolgroup_153507926.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterControlGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionControlGroup) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterControlGroup ## -description Registers a PerceptionControlGroup associated with the IPerceptionFrameProviderManager. ## -parameters ### -param manager The manager that owns the lifetime of the group. ### -param controlGroup The group of IPerceptionFrameProvider(s) to control atomically. ## -remarks The PerceptionControlGroup's ids used to create it can't appear in a PerceptionControlGroup which is already registered. Doing so raises an InvalidArgumentException. The PerceptionControlGroup specifies which IPerceptionFrameProvider(s) will be arbitrated for control together when control is successfully requested by an app and revoked when control is revoked from the app. When a PerceptionControlSession is acquired for a PerceptionControlGroup, that app may set properties on each provider in the group. Before the IPerceptionFrameProvider is registered in a control group, attempts to control it will fail and properties can't be set. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterControlGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionControlGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterControlGroup + +## -description +Registers a PerceptionControlGroup associated with the IPerceptionFrameProviderManager. + +## -parameters +### -param manager +The manager that owns the lifetime of the group. + +### -param controlGroup +The group of IPerceptionFrameProvider(s) to control atomically. + +## -remarks +The PerceptionControlGroup's ids used to create it can't appear in a PerceptionControlGroup which is already registered. Doing so raises an InvalidArgumentException. + +The PerceptionControlGroup specifies which IPerceptionFrameProvider(s) will be arbitrated for control together when control is successfully requested by an app and revoked when control is revoked from the app. + +When a PerceptionControlSession is acquired for a PerceptionControlGroup, that app may set properties on each provider in the group. Before the IPerceptionFrameProvider is registered in a control group, attempts to control it will fail and properties can't be set. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercorrelationgroup_1128997338.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercorrelationgroup_1128997338.md index 0e8e1e7db1..c25c3c803c 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercorrelationgroup_1128997338.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registercorrelationgroup_1128997338.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterCorrelationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionCorrelationGroup) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterCorrelationGroup ## -description Registers a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager. ## -parameters ### -param manager The manager that owns the lifetime of the group. ### -param correlationGroup The group of PerceptionCorrelations(s) to control atomically. ## -remarks This method enables finding correlated intrinsics and mappings to project and unproject frames between two correlated IPerceptionFrameProviders. Providers that aren't directly correlated together will not be correlatable with each other. An InvalidArgumentException is raised if a provider is in more than one registered PerceptionCorrelationGroup. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterCorrelationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionCorrelationGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterCorrelationGroup + +## -description +Registers a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager. + +## -parameters +### -param manager +The manager that owns the lifetime of the group. + +### -param correlationGroup +The group of PerceptionCorrelations(s) to control atomically. + +## -remarks +This method enables finding correlated intrinsics and mappings to project and unproject frames between two correlated IPerceptionFrameProviders. Providers that aren't directly correlated together will not be correlatable with each other. An InvalidArgumentException is raised if a provider is in more than one registered PerceptionCorrelationGroup. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerfaceauthenticationgroup_101031581.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerfaceauthenticationgroup_101031581.md index e84ddb2b85..4dcf0d376b 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerfaceauthenticationgroup_101031581.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerfaceauthenticationgroup_101031581.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFaceAuthenticationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFaceAuthenticationGroup ## -description Registers a PerceptionFaceAuthenticationGroup associated with the given IPerceptionProviderManager. ## -parameters ### -param manager The manager that owns the lifetime of the group. ### -param faceAuthenticationGroup The group of IPerceptionFrameProvider(s) to atomically control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFaceAuthenticationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFaceAuthenticationGroup + +## -description +Registers a PerceptionFaceAuthenticationGroup associated with the given IPerceptionProviderManager. + +## -parameters +### -param manager +The manager that owns the lifetime of the group. + +### -param faceAuthenticationGroup +The group of IPerceptionFrameProvider(s) to atomically control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerframeproviderinfo_1223408560.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerframeproviderinfo_1223408560.md index 2e581b0ac4..72f498950d 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerframeproviderinfo_1223408560.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_registerframeproviderinfo_1223408560.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFrameProviderInfo(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFrameProviderInfo ## -description Registers the PerceptionFrameProviderInfo in association with the given IPerceptionFrameProviderManager. ## -parameters ### -param manager The manager which can provide the IPerceptionFrameProvider associated with the info. ### -param frameProviderInfo The PerceptionFrameProviderInfo which identifies the available IPerceptionFrameProvider. ## -remarks This method enables the service to request the IPerceptionFrameProvider associated with the PerceptionFrameProviderInfo. The IPerceptionFrameProviderManager will be queried via IPerceptionFrameProviderManager::GetFrameProvider() to get the associated IPerceptionFrameProvider. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFrameProviderInfo(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.RegisterFrameProviderInfo + +## -description +Registers the PerceptionFrameProviderInfo in association with the given IPerceptionFrameProviderManager. + +## -parameters +### -param manager +The manager which can provide the IPerceptionFrameProvider associated with the info. + +### -param frameProviderInfo +The PerceptionFrameProviderInfo which identifies the available IPerceptionFrameProvider. + +## -remarks +This method enables the service to request the IPerceptionFrameProvider associated with the PerceptionFrameProviderInfo. The IPerceptionFrameProviderManager will be queried via IPerceptionFrameProviderManager::GetFrameProvider() to get the associated IPerceptionFrameProvider. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercontrolgroup_1009245162.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercontrolgroup_1009245162.md index 5c34ce4a7e..5d9037d0fd 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercontrolgroup_1009245162.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercontrolgroup_1009245162.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterControlGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionControlGroup) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterControlGroup ## -description Removes the registration of a previously registered PerceptionControlGroup. ## -parameters ### -param manager The manager that owns the lifetime of the group. ### -param controlGroup The group of IPerceptionFrameProvider(s) to prevent from being controlled. ## -remarks The service will no longer call IPerceptionFrameProviders::SetProperty() for any Frame provider in the group. After unregistering one control group, the members may be reregistered via the same or different control group(s). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterControlGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionControlGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterControlGroup + +## -description +Removes the registration of a previously registered PerceptionControlGroup. + +## -parameters +### -param manager +The manager that owns the lifetime of the group. + +### -param controlGroup +The group of IPerceptionFrameProvider(s) to prevent from being controlled. + +## -remarks +The service will no longer call IPerceptionFrameProviders::SetProperty() for any Frame provider in the group. After unregistering one control group, the members may be reregistered via the same or different control group(s). + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercorrelationgroup_1101896613.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercorrelationgroup_1101896613.md index 07fdce09e6..21609d0757 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercorrelationgroup_1101896613.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregistercorrelationgroup_1101896613.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterCorrelationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionCorrelationGroup) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterCorrelationGroup ## -description Unregisters a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager. ## -parameters ### -param manager The manager that owns the lifetime of the group. ### -param correlationGroup The PerceptionCorrelationGroup to unregister. ## -remarks The IPerceptionFrameProviders in the list no longer will have any correlation with each other. The group or any subset may be registered again after Unregistration completes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterCorrelationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionCorrelationGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterCorrelationGroup + +## -description +Unregisters a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager. + +## -parameters +### -param manager +The manager that owns the lifetime of the group. + +### -param correlationGroup +The PerceptionCorrelationGroup to unregister. + +## -remarks +The IPerceptionFrameProviders in the list no longer will have any correlation with each other. The group or any subset may be registered again after Unregistration completes. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterfaceauthenticationgroup_1900779887.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterfaceauthenticationgroup_1900779887.md index a3f724b000..27f5ac1b11 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterfaceauthenticationgroup_1900779887.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterfaceauthenticationgroup_1900779887.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFaceAuthenticationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFaceAuthenticationGroup ## -description Unregisters a PerceptionFaceAuthenticationGroup in association with the given IPerceptionProviderManager. ## -parameters ### -param manager The manager that owns the lifetime of the group. ### -param faceAuthenticationGroup The PerceptionFaceAuthenticationGroup to unregister. ## -remarks This stops the providers in the group from being requested to enter Face Authentication mode or being used for Face Authentication until it's registered again. The group or any subset of it may be registered again after being unregistered. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFaceAuthenticationGroup(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFaceAuthenticationGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFaceAuthenticationGroup + +## -description +Unregisters a PerceptionFaceAuthenticationGroup in association with the given IPerceptionProviderManager. + +## -parameters +### -param manager +The manager that owns the lifetime of the group. + +### -param faceAuthenticationGroup +The PerceptionFaceAuthenticationGroup to unregister. + +## -remarks +This stops the providers in the group from being requested to enter Face Authentication mode or being used for Face Authentication until it's registered again. The group or any subset of it may be registered again after being unregistered. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterframeproviderinfo_2112492236.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterframeproviderinfo_2112492236.md index b872b3626d..f43207c2e3 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterframeproviderinfo_2112492236.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_unregisterframeproviderinfo_2112492236.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFrameProviderInfo(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFrameProviderInfo ## -description Unregisters the PerceptionFrameProviderInfo in association with the given IPerceptionProviderManager. ## -parameters ### -param manager The manager which previously registered this info. ### -param frameProviderInfo The PerceptionFrameProviderInfo which identifies the IPerceptionFrameProvider. ## -remarks After this function returns, the service no longer calls the IPerceptionFrameProviderManager::GetFrameProvider() method with the provided PerceptionFrameProviderInfo. Unregistering a PerceptionFrameProviderInfo that is not registered, because it was never registered or because it's already unregistered, raises an InvalidArgumentException. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFrameProviderInfo(Windows.Devices.Perception.Provider.IPerceptionFrameProviderManager,Windows.Devices.Perception.Provider.PerceptionFrameProviderInfo) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UnregisterFrameProviderInfo + +## -description +Unregisters the PerceptionFrameProviderInfo in association with the given IPerceptionProviderManager. + +## -parameters +### -param manager +The manager which previously registered this info. + +### -param frameProviderInfo +The PerceptionFrameProviderInfo which identifies the IPerceptionFrameProvider. + +## -remarks +After this function returns, the service no longer calls the IPerceptionFrameProviderManager::GetFrameProvider() method with the provided PerceptionFrameProviderInfo. Unregistering a PerceptionFrameProviderInfo that is not registered, because it was never registered or because it's already unregistered, raises an InvalidArgumentException. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_updateavailabilityforprovider_73031645.md b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_updateavailabilityforprovider_73031645.md index 0c7c5bf11b..38613f58eb 100644 --- a/windows.devices.perception.provider/perceptionframeprovidermanagerservice_updateavailabilityforprovider_73031645.md +++ b/windows.devices.perception.provider/perceptionframeprovidermanagerservice_updateavailabilityforprovider_73031645.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UpdateAvailabilityForProvider(Windows.Devices.Perception.Provider.IPerceptionFrameProvider,System.Boolean) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UpdateAvailabilityForProvider ## -description Sets whether or not the IPerceptionFrameProvider is available. ## -parameters ### -param provider The provider to set availability for. ### -param available Whether or not the provider is available. ## -remarks Available providers are expected to be able to provide frames while unavailable providers aren't. Before calling this method, a provider is assumed to be available if registered. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UpdateAvailabilityForProvider(Windows.Devices.Perception.Provider.IPerceptionFrameProvider,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionFrameProviderManagerService.UpdateAvailabilityForProvider + +## -description +Sets whether or not the IPerceptionFrameProvider is available. + +## -parameters +### -param provider +The provider to set availability for. + +### -param available +Whether or not the provider is available. + +## -remarks +Available providers are expected to be able to provide frames while unavailable providers aren't. Before calling this method, a provider is assumed to be available if registered. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionpropertychangerequest.md b/windows.devices.perception.provider/perceptionpropertychangerequest.md index 33d4d569fa..c7404b8e9d 100644 --- a/windows.devices.perception.provider/perceptionpropertychangerequest.md +++ b/windows.devices.perception.provider/perceptionpropertychangerequest.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest ## -description A request from an app that's in control of this IPerceptionFrameProvider to update a property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest + +## -description +A request from an app that's in control of this IPerceptionFrameProvider to update a property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionpropertychangerequest_getdeferral_254836512.md b/windows.devices.perception.provider/perceptionpropertychangerequest_getdeferral_254836512.md index 3d6a938ccc..976a6b841b 100644 --- a/windows.devices.perception.provider/perceptionpropertychangerequest_getdeferral_254836512.md +++ b/windows.devices.perception.provider/perceptionpropertychangerequest_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.GetDeferral --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.GetDeferral ## -description Gets a Windows::Foundation::Deferral object to allow background processing if needed. ## -returns The Deferral object. ## -remarks When doing background processing, call GetDeferral() and store the result as well as the * PerceptionPropertyChangeRequest. When background processing is complete, set the Status on the PerceptionPropertyChangeRequest and call Complete() on the deferral before removing references to the objects. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.GetDeferral + +## -description +Gets a Windows::Foundation::Deferral object to allow background processing if needed. + +## -returns +The Deferral object. + +## -remarks +When doing background processing, call GetDeferral() and store the result as well as the * PerceptionPropertyChangeRequest. When background processing is complete, set the Status on the PerceptionPropertyChangeRequest and call Complete() on the deferral before removing references to the objects. + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionpropertychangerequest_name.md b/windows.devices.perception.provider/perceptionpropertychangerequest_name.md index 6699b60e3e..ce47570746 100644 --- a/windows.devices.perception.provider/perceptionpropertychangerequest_name.md +++ b/windows.devices.perception.provider/perceptionpropertychangerequest_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Name --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Name ## -description Gets the name of the property to change. ## -property-value The name of the property to change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Name +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Name + +## -description +Gets the name of the property to change. + +## -property-value +The name of the property to change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionpropertychangerequest_status.md b/windows.devices.perception.provider/perceptionpropertychangerequest_status.md index fee548cb2b..41cca10a3f 100644 --- a/windows.devices.perception.provider/perceptionpropertychangerequest_status.md +++ b/windows.devices.perception.provider/perceptionpropertychangerequest_status.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Status --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Status ## -description Sets the new status of the request after processing the request. ## -property-value The currently stored status of the request. ## -remarks The value should be set as follows: + **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::Accepted** –  The property has been updated to the new value. + **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::PropertyNotSupported** –  The property is not supported on this IPerceptionFrameProvider and can't be set. + **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::PropertyReadOnly** –  The property is supported on this IPerceptionFrameProvider but can't be changed. + **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::ValueOutOfRange** –  The property is supported on this IPerceptionFrameProvider but the provided new value is outside of the range of accepted values. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Status + +## -description +Sets the new status of the request after processing the request. + +## -property-value +The currently stored status of the request. + +## -remarks + +The value should be set as follows: + ++ **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::Accepted** –  The property has been updated to the new value. ++ **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::PropertyNotSupported** –  The property is not supported on this IPerceptionFrameProvider and can't be set. ++ **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::PropertyReadOnly** –  The property is supported on this IPerceptionFrameProvider but can't be changed. ++ **Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::ValueOutOfRange** –  The property is supported on this IPerceptionFrameProvider but the provided new value is outside of the range of accepted values. + + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionpropertychangerequest_value.md b/windows.devices.perception.provider/perceptionpropertychangerequest_value.md index c6f32a2689..61d644e755 100644 --- a/windows.devices.perception.provider/perceptionpropertychangerequest_value.md +++ b/windows.devices.perception.provider/perceptionpropertychangerequest_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Value --api-type: winrt property ---- # Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Value ## -description Gets the requested new value of the property. ## -property-value The requested new value of the property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Value +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.Provider.PerceptionPropertyChangeRequest.Value + +## -description +Gets the requested new value of the property. + +## -property-value +The requested new value of the property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionvideoframeallocator.md b/windows.devices.perception.provider/perceptionvideoframeallocator.md index 66a3c015ec..1ba9f86f46 100644 --- a/windows.devices.perception.provider/perceptionvideoframeallocator.md +++ b/windows.devices.perception.provider/perceptionvideoframeallocator.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator --api-type: winrt class ---- # Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator ## -description An allocator that can create PerceptionFrames directly which can be written into or copied from Windows::Media::VideoFrame into a PerceptionFrame. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator + +## -description +An allocator that can create PerceptionFrames directly which can be written into or copied from Windows::Media::VideoFrame into a PerceptionFrame. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception.provider/perceptionvideoframeallocator_allocateframe_1485401696.md b/windows.devices.perception.provider/perceptionvideoframeallocator_allocateframe_1485401696.md index 3a66e17b16..2e69cb4a39 100644 --- a/windows.devices.perception.provider/perceptionvideoframeallocator_allocateframe_1485401696.md +++ b/windows.devices.perception.provider/perceptionvideoframeallocator_allocateframe_1485401696.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.AllocateFrame --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.AllocateFrame ## -description Creates an empty PerceptionFrame with the properties specified when creating the PerceptionVideoFrameAllocator. ## -returns The empty frame with the properties specified when creating the PerceptionVideoFrameAllocator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.AllocateFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.AllocateFrame + +## -description +Creates an empty PerceptionFrame with the properties specified when creating the PerceptionVideoFrameAllocator. + +## -returns +The empty frame with the properties specified when creating the PerceptionVideoFrameAllocator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionvideoframeallocator_close_811482585.md b/windows.devices.perception.provider/perceptionvideoframeallocator_close_811482585.md index 5f426ce2b2..4b2e7d8150 100644 --- a/windows.devices.perception.provider/perceptionvideoframeallocator_close_811482585.md +++ b/windows.devices.perception.provider/perceptionvideoframeallocator_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.Close --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.Close ## -description Releases system resources that are exposed by a Windows Runtime object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionvideoframeallocator_copyfromvideoframe_737936415.md b/windows.devices.perception.provider/perceptionvideoframeallocator_copyfromvideoframe_737936415.md index 89bbe21c28..431288a355 100644 --- a/windows.devices.perception.provider/perceptionvideoframeallocator_copyfromvideoframe_737936415.md +++ b/windows.devices.perception.provider/perceptionvideoframeallocator_copyfromvideoframe_737936415.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.CopyFromVideoFrame(Windows.Media.VideoFrame) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.CopyFromVideoFrame ## -description Creates a deep copy of the video FrameProvider with the bytes already filled in with the resulting PerceptionFrame. ## -parameters ### -param frame The input frame from which to copy the pixel data. ## -returns The resulting filled PerceptionFrame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.CopyFromVideoFrame(Windows.Media.VideoFrame) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.CopyFromVideoFrame + +## -description +Creates a deep copy of the video FrameProvider with the bytes already filled in with the resulting PerceptionFrame. + +## -parameters +### -param frame +The input frame from which to copy the pixel data. + +## -returns +The resulting filled PerceptionFrame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception.provider/perceptionvideoframeallocator_perceptionvideoframeallocator_1073255883.md b/windows.devices.perception.provider/perceptionvideoframeallocator_perceptionvideoframeallocator_1073255883.md index eb67487921..a57a625c8c 100644 --- a/windows.devices.perception.provider/perceptionvideoframeallocator_perceptionvideoframeallocator_1073255883.md +++ b/windows.devices.perception.provider/perceptionvideoframeallocator_perceptionvideoframeallocator_1073255883.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.#ctor(System.UInt32,Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Foundation.Size,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.PerceptionVideoFrameAllocator ## -description Initializes a new PerceptionVideoFrameAllocator with the required properties for use by the IPerceptionFrameProvider to create PerceptionFrames published via PerceptionFrameProviderManagerService::PublishFrameForProvider. ## -parameters ### -param maxOutstandingFrameCountForWrite This is the number of buffers in flight required by the FrameProvider to produce its * frames at framerate. The suggestion is at least 2. ### -param format The Windows::Graphics::Imaging::BitmapPixelFormat describing the format of the bytes of the frame. ### -param resolution The resolution in pixels of the frame. ### -param alpha The Windows::Graphics::Imaging::BitmapAlphaMode describing how transparency is handled in the pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.#ctor(System.UInt32,Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Foundation.Size,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.Provider.PerceptionVideoFrameAllocator.PerceptionVideoFrameAllocator + +## -description +Initializes a new PerceptionVideoFrameAllocator with the required properties for use by the IPerceptionFrameProvider to create PerceptionFrames published via PerceptionFrameProviderManagerService::PublishFrameForProvider. + +## -parameters +### -param maxOutstandingFrameCountForWrite +This is the number of buffers in flight required by the FrameProvider to produce its * frames at framerate. The suggestion is at least 2. + +### -param format +The Windows::Graphics::Imaging::BitmapPixelFormat describing the format of the bytes of the frame. + +### -param resolution +The resolution in pixels of the frame. + +### -param alpha +The Windows::Graphics::Imaging::BitmapAlphaMode describing how transparency is handled in the pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knowncameraintrinsicsproperties.md b/windows.devices.perception/knowncameraintrinsicsproperties.md index 1a3bd928c1..0bb2c3e4bf 100644 --- a/windows.devices.perception/knowncameraintrinsicsproperties.md +++ b/windows.devices.perception/knowncameraintrinsicsproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.KnownCameraIntrinsicsProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownCameraIntrinsicsProperties ## -description Provides static methods for retrieving intrinsic properties of a camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownCameraIntrinsicsProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownCameraIntrinsicsProperties + +## -description +Provides static methods for retrieving intrinsic properties of a camera. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knowncameraintrinsicsproperties_focallength.md b/windows.devices.perception/knowncameraintrinsicsproperties_focallength.md index eb1b8fe766..ea2ed508b5 100644 --- a/windows.devices.perception/knowncameraintrinsicsproperties_focallength.md +++ b/windows.devices.perception/knowncameraintrinsicsproperties_focallength.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.FocalLength --api-type: winrt property ---- # Windows.Devices.Perception.KnownCameraIntrinsicsProperties.FocalLength ## -description Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the focal length of the camera. ## -property-value Indicates the focal length of the camera. This property is a SingleArray value that should be interpreted as a vector. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.FocalLength +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownCameraIntrinsicsProperties.FocalLength + +## -description +Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the focal length of the camera. + +## -property-value +Indicates the focal length of the camera. This property is a SingleArray value that should be interpreted as a vector. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knowncameraintrinsicsproperties_principalpoint.md b/windows.devices.perception/knowncameraintrinsicsproperties_principalpoint.md index 0815a564b9..73e68277a6 100644 --- a/windows.devices.perception/knowncameraintrinsicsproperties_principalpoint.md +++ b/windows.devices.perception/knowncameraintrinsicsproperties_principalpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.PrincipalPoint --api-type: winrt property ---- # Windows.Devices.Perception.KnownCameraIntrinsicsProperties.PrincipalPoint ## -description Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the principal point, relative to the camera. ## -property-value Indicates the principal point, relative to the camera. This property is a SingleArray value that should be interpreted as a vector. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.PrincipalPoint +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownCameraIntrinsicsProperties.PrincipalPoint + +## -description +Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the principal point, relative to the camera. + +## -property-value +Indicates the principal point, relative to the camera. This property is a SingleArray value that should be interpreted as a vector. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knowncameraintrinsicsproperties_radialdistortion.md b/windows.devices.perception/knowncameraintrinsicsproperties_radialdistortion.md index 22fbae756e..eefcd5dd9b 100644 --- a/windows.devices.perception/knowncameraintrinsicsproperties_radialdistortion.md +++ b/windows.devices.perception/knowncameraintrinsicsproperties_radialdistortion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.RadialDistortion --api-type: winrt property ---- # Windows.Devices.Perception.KnownCameraIntrinsicsProperties.RadialDistortion ## -description Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the radial distortion of the camera. ## -property-value Indicates the radial distortion of the camera. This property is a SingleArray value that should be interpreted as a vector. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.RadialDistortion +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownCameraIntrinsicsProperties.RadialDistortion + +## -description +Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the radial distortion of the camera. + +## -property-value +Indicates the radial distortion of the camera. This property is a SingleArray value that should be interpreted as a vector. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knowncameraintrinsicsproperties_tangentialdistortion.md b/windows.devices.perception/knowncameraintrinsicsproperties_tangentialdistortion.md index b20cdcb32b..c9c7208616 100644 --- a/windows.devices.perception/knowncameraintrinsicsproperties_tangentialdistortion.md +++ b/windows.devices.perception/knowncameraintrinsicsproperties_tangentialdistortion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.TangentialDistortion --api-type: winrt property ---- # Windows.Devices.Perception.KnownCameraIntrinsicsProperties.TangentialDistortion ## -description Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the tangential distortion of the camera. ## -property-value Indicates the tangential distortion of the camera. This property is a SingleArray value that should be interpreted as a vector. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownCameraIntrinsicsProperties.TangentialDistortion +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownCameraIntrinsicsProperties.TangentialDistortion + +## -description +Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the tangential distortion of the camera. + +## -property-value +Indicates the tangential distortion of the camera. This property is a SingleArray value that should be interpreted as a vector. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioncolorframesourceproperties.md b/windows.devices.perception/knownperceptioncolorframesourceproperties.md index f027dbb7f0..4e28099573 100644 --- a/windows.devices.perception/knownperceptioncolorframesourceproperties.md +++ b/windows.devices.perception/knownperceptioncolorframesourceproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties ## -description Provides static properties of color frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties + +## -description +Provides static properties of color frame sources. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioncolorframesourceproperties_autoexposureenabled.md b/windows.devices.perception/knownperceptioncolorframesourceproperties_autoexposureenabled.md index 47a7b5e2f5..9c1aa75f83 100644 --- a/windows.devices.perception/knownperceptioncolorframesourceproperties_autoexposureenabled.md +++ b/windows.devices.perception/knownperceptioncolorframesourceproperties_autoexposureenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.AutoExposureEnabled --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.AutoExposureEnabled ## -description Gets a string key used to retrieve a Boolean property indicating whether or not auto exposure is enabled. ## -property-value Indicates whether or not auto exposure is enabled. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.AutoExposureEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.AutoExposureEnabled + +## -description +Gets a string key used to retrieve a Boolean property indicating whether or not auto exposure is enabled. + +## -property-value +Indicates whether or not auto exposure is enabled. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioncolorframesourceproperties_exposure.md b/windows.devices.perception/knownperceptioncolorframesourceproperties_exposure.md index 9ee824190b..7fb328c966 100644 --- a/windows.devices.perception/knownperceptioncolorframesourceproperties_exposure.md +++ b/windows.devices.perception/knownperceptioncolorframesourceproperties_exposure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.Exposure --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.Exposure ## -description Gets a string key used to retrieve a TimeSpan property indicating the current exposure duration of the camera. ## -property-value The current exposure duration of the camera. This property is a TimeSpan value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.Exposure +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.Exposure + +## -description +Gets a string key used to retrieve a TimeSpan property indicating the current exposure duration of the camera. + +## -property-value +The current exposure duration of the camera. This property is a TimeSpan value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioncolorframesourceproperties_exposurecompensation.md b/windows.devices.perception/knownperceptioncolorframesourceproperties_exposurecompensation.md index da0e92c02a..fd5948b560 100644 --- a/windows.devices.perception/knownperceptioncolorframesourceproperties_exposurecompensation.md +++ b/windows.devices.perception/knownperceptioncolorframesourceproperties_exposurecompensation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.ExposureCompensation --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.ExposureCompensation ## -description Gets a string key used to retrieve a single-precision, floating-point property indicating the exposure compensation. ## -property-value The exposure compensation. This property is a Single value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.ExposureCompensation +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionColorFrameSourceProperties.ExposureCompensation + +## -description +Gets a string key used to retrieve a single-precision, floating-point property indicating the exposure compensation. + +## -property-value +The exposure compensation. This property is a Single value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptiondepthframesourceproperties.md b/windows.devices.perception/knownperceptiondepthframesourceproperties.md index 334a654d97..55a25e9308 100644 --- a/windows.devices.perception/knownperceptiondepthframesourceproperties.md +++ b/windows.devices.perception/knownperceptiondepthframesourceproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties ## -description Provides static properties of depth frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties + +## -description +Provides static properties of depth frame sources. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptiondepthframesourceproperties_maxdepth.md b/windows.devices.perception/knownperceptiondepthframesourceproperties_maxdepth.md index d0c44cdb26..b921163629 100644 --- a/windows.devices.perception/knownperceptiondepthframesourceproperties_maxdepth.md +++ b/windows.devices.perception/knownperceptiondepthframesourceproperties_maxdepth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MaxDepth --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MaxDepth ## -description Gets a string key used to retrieve a 16-bit unsigned integer property indicating the maximum depth of the depth frame source. ## -property-value Indicates the maximum depth of the depth frame source. This property is a UInt16 value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MaxDepth +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MaxDepth + +## -description +Gets a string key used to retrieve a 16-bit unsigned integer property indicating the maximum depth of the depth frame source. + +## -property-value +Indicates the maximum depth of the depth frame source. This property is a UInt16 value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptiondepthframesourceproperties_mindepth.md b/windows.devices.perception/knownperceptiondepthframesourceproperties_mindepth.md index 1fe6c08917..366b1caf01 100644 --- a/windows.devices.perception/knownperceptiondepthframesourceproperties_mindepth.md +++ b/windows.devices.perception/knownperceptiondepthframesourceproperties_mindepth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MinDepth --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MinDepth ## -description Gets a string key used to retrieve a 16-bit unsigned integer property indicating the minimum depth of the depth frame source. ## -property-value Indicates the minimum depth of the depth frame source. This property is a UInt16 value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MinDepth +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionDepthFrameSourceProperties.MinDepth + +## -description +Gets a string key used to retrieve a 16-bit unsigned integer property indicating the minimum depth of the depth frame source. + +## -property-value +Indicates the minimum depth of the depth frame source. This property is a UInt16 value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties.md b/windows.devices.perception/knownperceptionframesourceproperties.md index 8de4b25bb0..4a68f5b21d 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties.md +++ b/windows.devices.perception/knownperceptionframesourceproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties ## -description Provides static properties that are applicable to all types of frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties + +## -description +Provides static properties that are applicable to all types of frame sources. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties_deviceid.md b/windows.devices.perception/knownperceptionframesourceproperties_deviceid.md index 67718c955f..7277193ac4 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties_deviceid.md +++ b/windows.devices.perception/knownperceptionframesourceproperties_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceId --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceId ## -description Gets a string value that identifies the device on the system. ## -property-value The identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceId + +## -description +Gets a string value that identifies the device on the system. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties_devicemodelversion.md b/windows.devices.perception/knownperceptionframesourceproperties_devicemodelversion.md index 7543f6e23f..d7ab9b5e27 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties_devicemodelversion.md +++ b/windows.devices.perception/knownperceptionframesourceproperties_devicemodelversion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceModelVersion --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceModelVersion ## -description Gets a string key used to look up a string property with the device, model, version string for the physical sensor device this frame source represents. ## -property-value The device, model, version string for the physical sensor device this frame source represents. This property is a String value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceModelVersion +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.DeviceModelVersion + +## -description +Gets a string key used to look up a string property with the device, model, version string for the physical sensor device this frame source represents. + +## -property-value +The device, model, version string for the physical sensor device this frame source represents. This property is a String value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties_enclosurelocation.md b/windows.devices.perception/knownperceptionframesourceproperties_enclosurelocation.md index e043189ebe..c71466b40a 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties_enclosurelocation.md +++ b/windows.devices.perception/knownperceptionframesourceproperties_enclosurelocation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.EnclosureLocation --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.EnclosureLocation ## -description Gets a string key used to look up an enumeration property indicating the physical location of the sensor on the Windows device. ## -property-value The physical location of the sensor on the Windows device. This is an enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.EnclosureLocation +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.EnclosureLocation + +## -description +Gets a string key used to look up an enumeration property indicating the physical location of the sensor on the Windows device. + +## -property-value +The physical location of the sensor on the Windows device. This is an enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties_framekind.md b/windows.devices.perception/knownperceptionframesourceproperties_framekind.md index 4c7359fa4a..cb72421eed 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties_framekind.md +++ b/windows.devices.perception/knownperceptionframesourceproperties_framekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.FrameKind --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.FrameKind ## -description Gets a string key used to look up a string property that is a string key indicating the kind of frame the source provides. ## -property-value A string key indicating the kind of frame the source provides. This property is a String value. The string key will indicate color, depth, or infrared as specified by Windows.Devices.Perception.KnownPerceptionFrameKindStatics. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.FrameKind +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.FrameKind + +## -description +Gets a string key used to look up a string property that is a string key indicating the kind of frame the source provides. + +## -property-value +A string key indicating the kind of frame the source provides. This property is a String value. The string key will indicate color, depth, or infrared as specified by Windows.Devices.Perception.KnownPerceptionFrameKindStatics. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties_id.md b/windows.devices.perception/knownperceptionframesourceproperties_id.md index 6eae7b3c8c..b9ca9928f4 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties_id.md +++ b/windows.devices.perception/knownperceptionframesourceproperties_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.Id --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.Id ## -description Gets a string key used to look up a string property with the unique ID of the frame source. ## -property-value The unique ID of the frame source. This property is a String value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.Id + +## -description +Gets a string key used to look up a string property with the unique ID of the frame source. + +## -property-value +The unique ID of the frame source. This property is a String value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionframesourceproperties_physicaldeviceids.md b/windows.devices.perception/knownperceptionframesourceproperties_physicaldeviceids.md index df69936411..864e6df6b2 100644 --- a/windows.devices.perception/knownperceptionframesourceproperties_physicaldeviceids.md +++ b/windows.devices.perception/knownperceptionframesourceproperties_physicaldeviceids.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.PhysicalDeviceIds --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.PhysicalDeviceIds ## -description Gets a string key used to look up a string array property containing the physical device IDs of the sensor this frame source represents. ## -property-value An array of strings with the physical device IDs of the sensor this frame source represents. This property is a StringArray value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.PhysicalDeviceIds +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionFrameSourceProperties.PhysicalDeviceIds + +## -description +Gets a string key used to look up a string array property containing the physical device IDs of the sensor this frame source represents. + +## -property-value +An array of strings with the physical device IDs of the sensor this frame source represents. This property is a StringArray value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties.md index 6ae329404a..02c9bfef31 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties ## -description Provides static properties of infrared frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties + +## -description +Provides static properties of infrared frame sources. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_activeilluminationenabled.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_activeilluminationenabled.md index 3553d6e4e5..a459861aa0 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_activeilluminationenabled.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_activeilluminationenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ActiveIlluminationEnabled --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ActiveIlluminationEnabled ## -description Gets a string key used to retrieve a Boolean property indicating whether or not active IR illumination is enabled. ## -property-value Indicates whether or not active IR illumination is enabled. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ActiveIlluminationEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ActiveIlluminationEnabled + +## -description +Gets a string key used to retrieve a Boolean property indicating whether or not active IR illumination is enabled. + +## -property-value +Indicates whether or not active IR illumination is enabled. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_ambientsubtractionenabled.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_ambientsubtractionenabled.md index 5d455ba5ee..e08414a739 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_ambientsubtractionenabled.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_ambientsubtractionenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AmbientSubtractionEnabled --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AmbientSubtractionEnabled ## -description Gets a string key used to retrieve a Boolean property indicating whether or not ambient IR light subtraction is enabled. ## -property-value Indicates whether or not ambient IR light subtraction is enabled. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AmbientSubtractionEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AmbientSubtractionEnabled + +## -description +Gets a string key used to retrieve a Boolean property indicating whether or not ambient IR light subtraction is enabled. + +## -property-value +Indicates whether or not ambient IR light subtraction is enabled. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_autoexposureenabled.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_autoexposureenabled.md index 52cb09637f..cce177547e 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_autoexposureenabled.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_autoexposureenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AutoExposureEnabled --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AutoExposureEnabled ## -description Gets a string key used to retrieve a Boolean property indicating whether or not auto exposure is enabled. ## -property-value Indicates whether or not auto exposure is enabled. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AutoExposureEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.AutoExposureEnabled + +## -description +Gets a string key used to retrieve a Boolean property indicating whether or not auto exposure is enabled. + +## -property-value +Indicates whether or not auto exposure is enabled. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposure.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposure.md index 6288598e42..dca40496c0 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposure.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.Exposure --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.Exposure ## -description Gets a string key used to retrieve a TimeSpan property indicating the current exposure duration of the camera. ## -property-value The current exposure duration of the camera. This property is a TimeSpan value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.Exposure +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.Exposure + +## -description +Gets a string key used to retrieve a TimeSpan property indicating the current exposure duration of the camera. + +## -property-value +The current exposure duration of the camera. This property is a TimeSpan value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposurecompensation.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposurecompensation.md index 230e2dd263..ac039d73dc 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposurecompensation.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_exposurecompensation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ExposureCompensation --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ExposureCompensation ## -description Gets a string key used to retrieve a single-precision, floating-point property indicating the amount of exposure compensation. ## -property-value Indicates the amount of exposure compensation. This property is a Single value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ExposureCompensation +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.ExposureCompensation + +## -description +Gets a string key used to retrieve a single-precision, floating-point property indicating the amount of exposure compensation. + +## -property-value +Indicates the amount of exposure compensation. This property is a Single value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_interleavedilluminationenabled.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_interleavedilluminationenabled.md index 7515665b81..6e866b5762 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_interleavedilluminationenabled.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_interleavedilluminationenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.InterleavedIlluminationEnabled --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.InterleavedIlluminationEnabled ## -description Gets a string key used to retrieve a Boolean property indicating whether or not interleaved illumination is enabled. ## -property-value Indicates whether or not interleaved illumination is enabled. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.InterleavedIlluminationEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.InterleavedIlluminationEnabled + +## -description +Gets a string key used to retrieve a Boolean property indicating whether or not interleaved illumination is enabled. + +## -property-value +Indicates whether or not interleaved illumination is enabled. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptioninfraredframesourceproperties_structurelightpatternenabled.md b/windows.devices.perception/knownperceptioninfraredframesourceproperties_structurelightpatternenabled.md index 2757910b60..c71f6ea781 100644 --- a/windows.devices.perception/knownperceptioninfraredframesourceproperties_structurelightpatternenabled.md +++ b/windows.devices.perception/knownperceptioninfraredframesourceproperties_structurelightpatternenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.StructureLightPatternEnabled --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.StructureLightPatternEnabled ## -description Gets a string key used to retrieve a Boolean property indicating whether or not the structured light pattern is enabled. ## -property-value Indicates whether or not the structured light pattern is enabled. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.StructureLightPatternEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionInfraredFrameSourceProperties.StructureLightPatternEnabled + +## -description +Gets a string key used to retrieve a Boolean property indicating whether or not the structured light pattern is enabled. + +## -property-value +Indicates whether or not the structured light pattern is enabled. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoframesourceproperties.md b/windows.devices.perception/knownperceptionvideoframesourceproperties.md index aef165a68c..e718b2ee2f 100644 --- a/windows.devices.perception/knownperceptionvideoframesourceproperties.md +++ b/windows.devices.perception/knownperceptionvideoframesourceproperties.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties ## -description Provides static properties of video frame sources. ## -remarks The properties provided by these static methods are used as keys for controlling properties on the following classes: + PerceptionColorFrameSource + PerceptionDepthFrameSource + PerceptionInfraredFrameSource ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties + +## -description +Provides static properties of video frame sources. + +## -remarks + +The properties provided by these static methods are used as keys for controlling properties on the following classes: + ++ PerceptionColorFrameSource ++ PerceptionDepthFrameSource ++ PerceptionInfraredFrameSource + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoframesourceproperties_availablevideoprofiles.md b/windows.devices.perception/knownperceptionvideoframesourceproperties_availablevideoprofiles.md index dd7033fbbd..db7e58f74e 100644 --- a/windows.devices.perception/knownperceptionvideoframesourceproperties_availablevideoprofiles.md +++ b/windows.devices.perception/knownperceptionvideoframesourceproperties_availablevideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.AvailableVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.AvailableVideoProfiles ## -description Gets a string key used to retrieve a boolean property indicating the supported video profiles that are currently available. ## -property-value The supported video profiles that are currently available. This property is an IInspectable value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.AvailableVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.AvailableVideoProfiles + +## -description +Gets a string key used to retrieve a boolean property indicating the supported video profiles that are currently available. + +## -property-value +The supported video profiles that are currently available. This property is an IInspectable value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoframesourceproperties_cameraintrinsics.md b/windows.devices.perception/knownperceptionvideoframesourceproperties_cameraintrinsics.md index 4f06ebcb15..cfb12b8725 100644 --- a/windows.devices.perception/knownperceptionvideoframesourceproperties_cameraintrinsics.md +++ b/windows.devices.perception/knownperceptionvideoframesourceproperties_cameraintrinsics.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.CameraIntrinsics --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.CameraIntrinsics ## -description Gets a string key used to retrieve a CameraIntrinsics property defining the physical properties of the camera device. The CameraIntrinsics object also provides convenience methods for sensor-related geometry, including camera space to image space projections. ## -property-value Returns an object representing the intrinsic physical properties of the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.CameraIntrinsics +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.CameraIntrinsics + +## -description +Gets a string key used to retrieve a CameraIntrinsics property defining the physical properties of the camera device. The CameraIntrinsics object also provides convenience methods for sensor-related geometry, including camera space to image space projections. + +## -property-value +Returns an object representing the intrinsic physical properties of the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoframesourceproperties_ismirrored.md b/windows.devices.perception/knownperceptionvideoframesourceproperties_ismirrored.md index e87502109d..2ad5ce3237 100644 --- a/windows.devices.perception/knownperceptionvideoframesourceproperties_ismirrored.md +++ b/windows.devices.perception/knownperceptionvideoframesourceproperties_ismirrored.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.IsMirrored --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.IsMirrored ## -description Gets a string key used to retrieve a boolean property indicating whether or not the video frame source is providing mirrored video frames. ## -property-value Indicates whether or not the video frame source is providing mirrored video frames. This property is a Boolean value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.IsMirrored +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.IsMirrored + +## -description +Gets a string key used to retrieve a boolean property indicating whether or not the video frame source is providing mirrored video frames. + +## -property-value +Indicates whether or not the video frame source is providing mirrored video frames. This property is a Boolean value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoframesourceproperties_supportedvideoprofiles.md b/windows.devices.perception/knownperceptionvideoframesourceproperties_supportedvideoprofiles.md index 0fd6d991db..1f3b8e9620 100644 --- a/windows.devices.perception/knownperceptionvideoframesourceproperties_supportedvideoprofiles.md +++ b/windows.devices.perception/knownperceptionvideoframesourceproperties_supportedvideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.SupportedVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.SupportedVideoProfiles ## -description Gets a string key used to retrieve the supported video profiles property. ## -property-value The supported video profiles. This property is an IInspectable value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.SupportedVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.SupportedVideoProfiles + +## -description +Gets a string key used to retrieve the supported video profiles property. + +## -property-value +The supported video profiles. This property is an IInspectable value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoframesourceproperties_videoprofile.md b/windows.devices.perception/knownperceptionvideoframesourceproperties_videoprofile.md index 918a6bfa94..bb5ce6b073 100644 --- a/windows.devices.perception/knownperceptionvideoframesourceproperties_videoprofile.md +++ b/windows.devices.perception/knownperceptionvideoframesourceproperties_videoprofile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.VideoProfile --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.VideoProfile ## -description Gets a string key used to retrieve the current video profile property. ## -property-value The current video profile. This property is an IInspectable value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.VideoProfile +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoFrameSourceProperties.VideoProfile + +## -description +Gets a string key used to retrieve the current video profile property. + +## -property-value +The current video profile. This property is an IInspectable value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoprofileproperties.md b/windows.devices.perception/knownperceptionvideoprofileproperties.md index 9d416d5a19..6da59e269b 100644 --- a/windows.devices.perception/knownperceptionvideoprofileproperties.md +++ b/windows.devices.perception/knownperceptionvideoprofileproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties --api-type: winrt class ---- # Windows.Devices.Perception.KnownPerceptionVideoProfileProperties ## -description Provides static properties of a video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoProfileProperties + +## -description +Provides static properties of a video profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoprofileproperties_bitmapalphamode.md b/windows.devices.perception/knownperceptionvideoprofileproperties_bitmapalphamode.md index 32bac5d04a..30ffde54b9 100644 --- a/windows.devices.perception/knownperceptionvideoprofileproperties_bitmapalphamode.md +++ b/windows.devices.perception/knownperceptionvideoprofileproperties_bitmapalphamode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapAlphaMode --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapAlphaMode ## -description Gets a string key used to retrieve an enumeration property indicating the bitmap alpha mode. ## -property-value The bitmap alpha mode. This property is an enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapAlphaMode + +## -description +Gets a string key used to retrieve an enumeration property indicating the bitmap alpha mode. + +## -property-value +The bitmap alpha mode. This property is an enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoprofileproperties_bitmappixelformat.md b/windows.devices.perception/knownperceptionvideoprofileproperties_bitmappixelformat.md index f94ba54d4b..49a3bdb3f0 100644 --- a/windows.devices.perception/knownperceptionvideoprofileproperties_bitmappixelformat.md +++ b/windows.devices.perception/knownperceptionvideoprofileproperties_bitmappixelformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapPixelFormat --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapPixelFormat ## -description Gets a string key used to retrieve an enumeration property indicating the bitmap pixel format. ## -property-value The bitmap pixel format. This property is an enumeration value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.BitmapPixelFormat + +## -description +Gets a string key used to retrieve an enumeration property indicating the bitmap pixel format. + +## -property-value +The bitmap pixel format. This property is an enumeration value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoprofileproperties_frameduration.md b/windows.devices.perception/knownperceptionvideoprofileproperties_frameduration.md index 8bd2bc249d..ec7803f877 100644 --- a/windows.devices.perception/knownperceptionvideoprofileproperties_frameduration.md +++ b/windows.devices.perception/knownperceptionvideoprofileproperties_frameduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.FrameDuration --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.FrameDuration ## -description Gets a string key used to retrieve a TimeSpan property indicating the time duration of each frame. ## -property-value The time duration of each frame. This property is a TimeSpan value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.FrameDuration +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.FrameDuration + +## -description +Gets a string key used to retrieve a TimeSpan property indicating the time duration of each frame. + +## -property-value +The time duration of each frame. This property is a TimeSpan value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoprofileproperties_height.md b/windows.devices.perception/knownperceptionvideoprofileproperties_height.md index 293a2503ec..376abcebe9 100644 --- a/windows.devices.perception/knownperceptionvideoprofileproperties_height.md +++ b/windows.devices.perception/knownperceptionvideoprofileproperties_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Height --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Height ## -description Gets a string key used to retrieve a 32-bit unsigned integer property indicating the frame height, in pixels. ## -property-value The frame height, in pixels. This property is a UInt32 value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Height +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Height + +## -description +Gets a string key used to retrieve a 32-bit unsigned integer property indicating the frame height, in pixels. + +## -property-value +The frame height, in pixels. This property is a UInt32 value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/knownperceptionvideoprofileproperties_width.md b/windows.devices.perception/knownperceptionvideoprofileproperties_width.md index de2f3725e0..d24541ab72 100644 --- a/windows.devices.perception/knownperceptionvideoprofileproperties_width.md +++ b/windows.devices.perception/knownperceptionvideoprofileproperties_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Width --api-type: winrt property ---- # Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Width ## -description Gets a string key used to retrieve a 32-bit unsigned integer property indicating the frame width, in pixels. ## -property-value The frame width, in pixels. This property is a UInt32 value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Width +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.KnownPerceptionVideoProfileProperties.Width + +## -description +Gets a string key used to retrieve a 32-bit unsigned integer property indicating the frame width, in pixels. + +## -property-value +The frame width, in pixels. This property is a UInt32 value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframe.md b/windows.devices.perception/perceptioncolorframe.md index 5efdc35ba1..35096f342d 100644 --- a/windows.devices.perception/perceptioncolorframe.md +++ b/windows.devices.perception/perceptioncolorframe.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrame --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrame ## -description Contains a Windows.Media.VideoFrame with the color frame data. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrame +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrame + +## -description +Contains a Windows.Media.VideoFrame with the color frame data. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptioncolorframe_close_811482585.md b/windows.devices.perception/perceptioncolorframe_close_811482585.md index c49b9ac73f..e6b6e9fd45 100644 --- a/windows.devices.perception/perceptioncolorframe_close_811482585.md +++ b/windows.devices.perception/perceptioncolorframe_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrame.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrame.Close ## -description Releases system resources that are exposed by a Windows Runtime object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrame.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrame.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframe_videoframe.md b/windows.devices.perception/perceptioncolorframe_videoframe.md index bba6193140..97f5f875ac 100644 --- a/windows.devices.perception/perceptioncolorframe_videoframe.md +++ b/windows.devices.perception/perceptioncolorframe_videoframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrame.VideoFrame --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrame.VideoFrame ## -description Gets a Windows.Media.VideoFrame with the color frame data. ## -property-value A Windows.Media.VideoFrame with the color frame data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrame.VideoFrame +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrame.VideoFrame + +## -description +Gets a Windows.Media.VideoFrame with the color frame data. + +## -property-value +A Windows.Media.VideoFrame with the color frame data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframearrivedeventargs.md b/windows.devices.perception/perceptioncolorframearrivedeventargs.md index a58fd16134..02c151a736 100644 --- a/windows.devices.perception/perceptioncolorframearrivedeventargs.md +++ b/windows.devices.perception/perceptioncolorframearrivedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs ## -description Contains information about a color frame arrived event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs + +## -description +Contains information about a color frame arrived event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframearrivedeventargs_relativetime.md b/windows.devices.perception/perceptioncolorframearrivedeventargs_relativetime.md index e40940b787..c4eae28ea1 100644 --- a/windows.devices.perception/perceptioncolorframearrivedeventargs_relativetime.md +++ b/windows.devices.perception/perceptioncolorframearrivedeventargs_relativetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.RelativeTime --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.RelativeTime ## -description Gets the relative time of this frame. ## -property-value The relative time of this frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.RelativeTime +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.RelativeTime + +## -description +Gets the relative time of this frame. + +## -property-value +The relative time of this frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframearrivedeventargs_tryopenframe_1525544366.md b/windows.devices.perception/perceptioncolorframearrivedeventargs_tryopenframe_1525544366.md index e166d0c2c2..4187602dfd 100644 --- a/windows.devices.perception/perceptioncolorframearrivedeventargs_tryopenframe_1525544366.md +++ b/windows.devices.perception/perceptioncolorframearrivedeventargs_tryopenframe_1525544366.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.TryOpenFrame --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.TryOpenFrame ## -description Attempts to open the color frame that has arrived. ## -returns If the attempt is successful, this method returns the newly-arrived color frame. If the attempt is unsuccessful, this value is unchanged. ## -remarks Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.TryOpenFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameArrivedEventArgs.TryOpenFrame + +## -description +Attempts to open the color frame that has arrived. + +## -returns +If the attempt is successful, this method returns the newly-arrived color frame. If the attempt is unsuccessful, this value is unchanged. + +## -remarks +Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail. + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframereader.md b/windows.devices.perception/perceptioncolorframereader.md index 416a2fb048..d9431ba750 100644 --- a/windows.devices.perception/perceptioncolorframereader.md +++ b/windows.devices.perception/perceptioncolorframereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrameReader --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrameReader ## -description Reads color frames from a color frame source. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrameReader +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameReader + +## -description +Reads color frames from a color frame source. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptioncolorframereader_close_811482585.md b/windows.devices.perception/perceptioncolorframereader_close_811482585.md index 26db92ac60..1ddae64b97 100644 --- a/windows.devices.perception/perceptioncolorframereader_close_811482585.md +++ b/windows.devices.perception/perceptioncolorframereader_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameReader.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameReader.Close ## -description Releases system resources that are exposed by a Windows Runtime object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameReader.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameReader.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframereader_framearrived.md b/windows.devices.perception/perceptioncolorframereader_framearrived.md index bc7a9c12a5..5449b0b2ec 100644 --- a/windows.devices.perception/perceptioncolorframereader_framearrived.md +++ b/windows.devices.perception/perceptioncolorframereader_framearrived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameReader.FrameArrived --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameReader.FrameArrived ## -description Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the color frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameReader.FrameArrived +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameReader.FrameArrived + +## -description +Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the color frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframereader_ispaused.md b/windows.devices.perception/perceptioncolorframereader_ispaused.md index 50228c932f..bab63d1efa 100644 --- a/windows.devices.perception/perceptioncolorframereader_ispaused.md +++ b/windows.devices.perception/perceptioncolorframereader_ispaused.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameReader.IsPaused --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameReader.IsPaused ## -description Gets or sets a boolean value indicating whether or not this reader is paused. ## -property-value A boolean value indicating whether or not this reader is paused. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameReader.IsPaused +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameReader.IsPaused + +## -description +Gets or sets a boolean value indicating whether or not this reader is paused. + +## -property-value +A boolean value indicating whether or not this reader is paused. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframereader_source.md b/windows.devices.perception/perceptioncolorframereader_source.md index f2f5d56887..e7a31e3a0e 100644 --- a/windows.devices.perception/perceptioncolorframereader_source.md +++ b/windows.devices.perception/perceptioncolorframereader_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameReader.Source --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameReader.Source ## -description Gets the color frame source this reader gets frames from. ## -property-value The color frame source this reader gets frames from. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameReader.Source +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameReader.Source + +## -description +Gets the color frame source this reader gets frames from. + +## -property-value +The color frame source this reader gets frames from. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframereader_tryreadlatestframe_1676630157.md b/windows.devices.perception/perceptioncolorframereader_tryreadlatestframe_1676630157.md index 58f85077fb..fdf11257d7 100644 --- a/windows.devices.perception/perceptioncolorframereader_tryreadlatestframe_1676630157.md +++ b/windows.devices.perception/perceptioncolorframereader_tryreadlatestframe_1676630157.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameReader.TryReadLatestFrame --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameReader.TryReadLatestFrame ## -description Attempts to read the most recent frame that is available to this color frame reader. ## -returns If the attempt was successful, this method returns the most recent frame that is available to this color frame reader. If the attempt was not successful, this method returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameReader.TryReadLatestFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameReader.TryReadLatestFrame + +## -description +Attempts to read the most recent frame that is available to this color frame reader. + +## -returns +If the attempt was successful, this method returns the most recent frame that is available to this color frame reader. If the attempt was not successful, this method returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource.md b/windows.devices.perception/perceptioncolorframesource.md index e8ed5e7869..892690f114 100644 --- a/windows.devices.perception/perceptioncolorframesource.md +++ b/windows.devices.perception/perceptioncolorframesource.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrameSource --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrameSource ## -description A frame source that provides color frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrameSource +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource + +## -description +A frame source that provides color frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_acquirecontrolsession_73364641.md b/windows.devices.perception/perceptioncolorframesource_acquirecontrolsession_73364641.md index 2ce29efcdd..3521fd0646 100644 --- a/windows.devices.perception/perceptioncolorframesource_acquirecontrolsession_73364641.md +++ b/windows.devices.perception/perceptioncolorframesource_acquirecontrolsession_73364641.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.AcquireControlSession --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.AcquireControlSession ## -description Attempts to acquire Controller Mode on the color frame source. ## -returns If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the color frame source. Otherwise, this returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.AcquireControlSession +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.AcquireControlSession + +## -description +Attempts to acquire Controller Mode on the color frame source. + +## -returns +If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the color frame source. Otherwise, this returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_active.md b/windows.devices.perception/perceptioncolorframesource_active.md index 566c181c92..014246d592 100644 --- a/windows.devices.perception/perceptioncolorframesource_active.md +++ b/windows.devices.perception/perceptioncolorframesource_active.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Active --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.Active ## -description Gets a boolean value indicating whether or not the source is active. ## -property-value A boolean value indicating whether or not the source is active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Active +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.Active + +## -description +Gets a boolean value indicating whether or not the source is active. + +## -property-value +A boolean value indicating whether or not the source is active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_activechanged.md b/windows.devices.perception/perceptioncolorframesource_activechanged.md index 472b0d93c8..e4674c262a 100644 --- a/windows.devices.perception/perceptioncolorframesource_activechanged.md +++ b/windows.devices.perception/perceptioncolorframesource_activechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.ActiveChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSource.ActiveChanged ## -description Subscribes to the ActiveChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.ActiveChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.ActiveChanged + +## -description +Subscribes to the ActiveChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_available.md b/windows.devices.perception/perceptioncolorframesource_available.md index 1656a684e0..58fa651c09 100644 --- a/windows.devices.perception/perceptioncolorframesource_available.md +++ b/windows.devices.perception/perceptioncolorframesource_available.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Available --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.Available ## -description Gets a boolean value indicating whether or not the source is available. ## -property-value A boolean value indicating whether or not the source is available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Available +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.Available + +## -description +Gets a boolean value indicating whether or not the source is available. + +## -property-value +A boolean value indicating whether or not the source is available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_availablechanged.md b/windows.devices.perception/perceptioncolorframesource_availablechanged.md index 41ed745f40..8b7337ba2f 100644 --- a/windows.devices.perception/perceptioncolorframesource_availablechanged.md +++ b/windows.devices.perception/perceptioncolorframesource_availablechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.AvailableChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSource.AvailableChanged ## -description Subscribes to the AvailableChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.AvailableChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.AvailableChanged + +## -description +Subscribes to the AvailableChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_availablevideoprofiles.md b/windows.devices.perception/perceptioncolorframesource_availablevideoprofiles.md index 6c6021b8fa..1672e1e96f 100644 --- a/windows.devices.perception/perceptioncolorframesource_availablevideoprofiles.md +++ b/windows.devices.perception/perceptioncolorframesource_availablevideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.AvailableVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.AvailableVideoProfiles ## -description Gets a read-only collection of video profiles that are currently available from the color frame source. ## -property-value A read-only collection of video profiles that are currently available from the color frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.AvailableVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.AvailableVideoProfiles + +## -description +Gets a read-only collection of video profiles that are currently available from the color frame source. + +## -property-value +A read-only collection of video profiles that are currently available from the color frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_cameraintrinsics.md b/windows.devices.perception/perceptioncolorframesource_cameraintrinsics.md index f1cc159a13..1fae2196db 100644 --- a/windows.devices.perception/perceptioncolorframesource_cameraintrinsics.md +++ b/windows.devices.perception/perceptioncolorframesource_cameraintrinsics.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsics --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsics ## -description Gets a CameraIntrinsics value specifying the intrinsic properties of the color frame source camera device. ## -property-value A CameraIntrinsics value specifying the intrinsic properties of the color frame source camera device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsics +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsics + +## -description +Gets a CameraIntrinsics value specifying the intrinsic properties of the color frame source camera device. + +## -property-value +A CameraIntrinsics value specifying the intrinsic properties of the color frame source camera device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_cameraintrinsicschanged.md b/windows.devices.perception/perceptioncolorframesource_cameraintrinsicschanged.md index e0d6ba507c..cd85b8f586 100644 --- a/windows.devices.perception/perceptioncolorframesource_cameraintrinsicschanged.md +++ b/windows.devices.perception/perceptioncolorframesource_cameraintrinsicschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsicsChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsicsChanged ## -description Subscribes to the CameraIntrinsicsChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsicsChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.CameraIntrinsicsChanged + +## -description +Subscribes to the CameraIntrinsicsChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_cancontrolindependentlyfrom_1911149790.md b/windows.devices.perception/perceptioncolorframesource_cancontrolindependentlyfrom_1911149790.md index 7e6132278b..665145cfaf 100644 --- a/windows.devices.perception/perceptioncolorframesource_cancontrolindependentlyfrom_1911149790.md +++ b/windows.devices.perception/perceptioncolorframesource_cancontrolindependentlyfrom_1911149790.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.CanControlIndependentlyFrom(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.CanControlIndependentlyFrom ## -description This method returns a boolean value indicating whether or not the color frame source can be controlled separately from another frame source. ## -parameters ### -param targetId A string representing the unique ID of the other frame source. ## -returns Returns true if the two sources can be controlled independently of one another, otherwise returns false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.CanControlIndependentlyFrom(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.CanControlIndependentlyFrom + +## -description +This method returns a boolean value indicating whether or not the color frame source can be controlled separately from another frame source. + +## -parameters +### -param targetId +A string representing the unique ID of the other frame source. + +## -returns +Returns true if the two sources can be controlled independently of one another, otherwise returns false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_createwatcher_1506431823.md b/windows.devices.perception/perceptioncolorframesource_createwatcher_1506431823.md index c236097571..1f3ca879a5 100644 --- a/windows.devices.perception/perceptioncolorframesource_createwatcher_1506431823.md +++ b/windows.devices.perception/perceptioncolorframesource_createwatcher_1506431823.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.CreateWatcher --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.CreateWatcher ## -description Creates a new color frame source watcher. ## -returns A new color frame source watcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.CreateWatcher +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.CreateWatcher + +## -description +Creates a new color frame source watcher. + +## -returns +A new color frame source watcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_deviceid.md b/windows.devices.perception/perceptioncolorframesource_deviceid.md index 906b4b7a85..fc67336e46 100644 --- a/windows.devices.perception/perceptioncolorframesource_deviceid.md +++ b/windows.devices.perception/perceptioncolorframesource_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.DeviceId --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.DeviceId ## -description Gets a string value that identifies the device on the system. ## -property-value The identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.DeviceId + +## -description +Gets a string value that identifies the device on the system. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_devicekind.md b/windows.devices.perception/perceptioncolorframesource_devicekind.md index d2862a02f1..e0da02b750 100644 --- a/windows.devices.perception/perceptioncolorframesource_devicekind.md +++ b/windows.devices.perception/perceptioncolorframesource_devicekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.DeviceKind --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.DeviceKind ## -description Gets a string value indicating the kind of physical device that generates the color frames for this source. ## -property-value A string value indicating the kind of physical device that generates the color frames for this source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.DeviceKind +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.DeviceKind + +## -description +Gets a string value indicating the kind of physical device that generates the color frames for this source. + +## -property-value +A string value indicating the kind of physical device that generates the color frames for this source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_displayname.md b/windows.devices.perception/perceptioncolorframesource_displayname.md index b19baa3bf0..5536cc4dc6 100644 --- a/windows.devices.perception/perceptioncolorframesource_displayname.md +++ b/windows.devices.perception/perceptioncolorframesource_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.DisplayName --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.DisplayName ## -description Gets a string value indicating the display name of the color frame source. ## -property-value A string value indicating the display name of the color frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.DisplayName +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.DisplayName + +## -description +Gets a string value indicating the display name of the color frame source. + +## -property-value +A string value indicating the display name of the color frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_findallasync_326280522.md b/windows.devices.perception/perceptioncolorframesource_findallasync_326280522.md index eb1d119eed..3bf195fd30 100644 --- a/windows.devices.perception/perceptioncolorframesource_findallasync_326280522.md +++ b/windows.devices.perception/perceptioncolorframesource_findallasync_326280522.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.FindAllAsync --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.FindAllAsync ## -description Finds all color frame sources. ## -returns When the method completes, it asynchronously returns a list of color frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.FindAllAsync + +## -description +Finds all color frame sources. + +## -returns +When the method completes, it asynchronously returns a list of color frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_fromidasync_1322863552.md b/windows.devices.perception/perceptioncolorframesource_fromidasync_1322863552.md index 9aa8154f3c..a723fe2d0c 100644 --- a/windows.devices.perception/perceptioncolorframesource_fromidasync_1322863552.md +++ b/windows.devices.perception/perceptioncolorframesource_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.FromIdAsync ## -description Finds an color frame source by looking up its unique ID. ## -parameters ### -param id The unique ID of the color frame source. ## -returns When this method completes, it asynchronously returns a color frame source if one exists with the specified ID. Otherwise, this method asynchronously returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.FromIdAsync + +## -description +Finds an color frame source by looking up its unique ID. + +## -parameters +### -param id +The unique ID of the color frame source. + +## -returns +When this method completes, it asynchronously returns a color frame source if one exists with the specified ID. Otherwise, this method asynchronously returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_id.md b/windows.devices.perception/perceptioncolorframesource_id.md index 3e6f5e9939..45cbc3bf22 100644 --- a/windows.devices.perception/perceptioncolorframesource_id.md +++ b/windows.devices.perception/perceptioncolorframesource_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Id --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.Id ## -description Gets a string value indicating the unique ID of the color frame source. ## -property-value A string value indicating the unique ID of the color frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.Id + +## -description +Gets a string value indicating the unique ID of the color frame source. + +## -property-value +A string value indicating the unique ID of the color frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_iscontrolled.md b/windows.devices.perception/perceptioncolorframesource_iscontrolled.md index 622b8db293..c6aa4de79f 100644 --- a/windows.devices.perception/perceptioncolorframesource_iscontrolled.md +++ b/windows.devices.perception/perceptioncolorframesource_iscontrolled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.IsControlled --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.IsControlled ## -description Gets a boolean value indicating whether or not the source is the subject of controller mode. ## -property-value A boolean value indicating whether or not the source is the subject of controller mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.IsControlled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.IsControlled + +## -description +Gets a boolean value indicating whether or not the source is the subject of controller mode. + +## -property-value +A boolean value indicating whether or not the source is the subject of controller mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_iscorrelatedwith_25122365.md b/windows.devices.perception/perceptioncolorframesource_iscorrelatedwith_25122365.md index adcfac8615..b720f1c55a 100644 --- a/windows.devices.perception/perceptioncolorframesource_iscorrelatedwith_25122365.md +++ b/windows.devices.perception/perceptioncolorframesource_iscorrelatedwith_25122365.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.IsCorrelatedWith(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.IsCorrelatedWith ## -description Checks whether or not the color frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this color frame source to the entity, or vice versa. ## -parameters ### -param targetId The unique ID of the target entity. ## -returns Returns true if a correlation exists, otherwise returns false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.IsCorrelatedWith(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.IsCorrelatedWith + +## -description +Checks whether or not the color frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this color frame source to the entity, or vice versa. + +## -parameters +### -param targetId +The unique ID of the target entity. + +## -returns +Returns true if a correlation exists, otherwise returns false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_openreader_1109726428.md b/windows.devices.perception/perceptioncolorframesource_openreader_1109726428.md index c0c441fc20..af50ab6e19 100644 --- a/windows.devices.perception/perceptioncolorframesource_openreader_1109726428.md +++ b/windows.devices.perception/perceptioncolorframesource_openreader_1109726428.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.OpenReader --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.OpenReader ## -description Gets a frame reader that reads frames from this color frame source. ## -returns Returns a frame reader that reads frames from this color frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.OpenReader +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.OpenReader + +## -description +Gets a frame reader that reads frames from this color frame source. + +## -returns +Returns a frame reader that reads frames from this color frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_properties.md b/windows.devices.perception/perceptioncolorframesource_properties.md index b88eddd301..2ac279298c 100644 --- a/windows.devices.perception/perceptioncolorframesource_properties.md +++ b/windows.devices.perception/perceptioncolorframesource_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Properties --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.Properties ## -description Gets a read-only collection of frame source properties. ## -property-value A read-only collection of frame source properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.Properties + +## -description +Gets a read-only collection of frame source properties. + +## -property-value +A read-only collection of frame source properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_propertieschanged.md b/windows.devices.perception/perceptioncolorframesource_propertieschanged.md index 6079b42c98..61b80170cd 100644 --- a/windows.devices.perception/perceptioncolorframesource_propertieschanged.md +++ b/windows.devices.perception/perceptioncolorframesource_propertieschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.PropertiesChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSource.PropertiesChanged ## -description Subscribes to the PropertiesChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.PropertiesChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.PropertiesChanged + +## -description +Subscribes to the PropertiesChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_requestaccessasync_380675631.md b/windows.devices.perception/perceptioncolorframesource_requestaccessasync_380675631.md index 0a6eea8317..b6fa2c63e0 100644 --- a/windows.devices.perception/perceptioncolorframesource_requestaccessasync_380675631.md +++ b/windows.devices.perception/perceptioncolorframesource_requestaccessasync_380675631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.RequestAccessAsync ## -description Requests access to use color frame sources. ## -returns When this method completes, it asynchronously returns a [PerceptionFrameSourceAccessStatus](perceptionframesourceaccessstatus.md) indicating the result of the access request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.RequestAccessAsync + +## -description +Requests access to use color frame sources. + +## -returns +When this method completes, it asynchronously returns a [PerceptionFrameSourceAccessStatus](perceptionframesourceaccessstatus.md) indicating the result of the access request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_supportedvideoprofiles.md b/windows.devices.perception/perceptioncolorframesource_supportedvideoprofiles.md index 40cc69e264..6abc33b8a3 100644 --- a/windows.devices.perception/perceptioncolorframesource_supportedvideoprofiles.md +++ b/windows.devices.perception/perceptioncolorframesource_supportedvideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.SupportedVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.SupportedVideoProfiles ## -description Gets a read-only collection of video profiles that are supported by the color frame source. ## -property-value A read-only collection of video profiles that are supported by the color frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.SupportedVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.SupportedVideoProfiles + +## -description +Gets a read-only collection of video profiles that are supported by the color frame source. + +## -property-value +A read-only collection of video profiles that are supported by the color frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md b/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md index c77d52af19..3109ee2e99 100644 --- a/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md +++ b/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync(Windows.Devices.Perception.PerceptionDepthFrameSource) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync ## -description Attempts to get the intrinsic properties of the depth camera that is correlated with this color source. ## -parameters ### -param correlatedDepthFrameSource The depth frame source to try to get intrinsic properties of. ## -returns If the attempt is successful, this will return a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync(Windows.Devices.Perception.PerceptionDepthFrameSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync + +## -description +Attempts to get the intrinsic properties of the depth camera that is correlated with this color source. + +## -parameters +### -param correlatedDepthFrameSource +The depth frame source to try to get intrinsic properties of. + +## -returns +If the attempt is successful, this will return a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md b/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md index f9fa38b5e9..1708d199f3 100644 --- a/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md +++ b/windows.devices.perception/perceptioncolorframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync(System.String,Windows.Devices.Perception.PerceptionDepthFrameSource) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync ## -description Attempts to get a coordinate mapper that maps from color frame image space to depth frame space. ## -parameters ### -param targetSourceId The unique ID of the depth frame source to try to map to. ### -param correlatedDepthFrameSource The depth frame source to try to map to. This should be in a correlation group with the color frame source. ## -returns If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync(System.String,Windows.Devices.Perception.PerceptionDepthFrameSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync + +## -description +Attempts to get a coordinate mapper that maps from color frame image space to depth frame space. + +## -parameters +### -param targetSourceId +The unique ID of the depth frame source to try to map to. + +### -param correlatedDepthFrameSource +The depth frame source to try to map to. This should be in a correlation group with the color frame source. + +## -returns +If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_trygettransformto_253749040.md b/windows.devices.perception/perceptioncolorframesource_trygettransformto_253749040.md index 725ce5b7da..018b5871df 100644 --- a/windows.devices.perception/perceptioncolorframesource_trygettransformto_253749040.md +++ b/windows.devices.perception/perceptioncolorframesource_trygettransformto_253749040.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TryGetTransformTo(System.String,Windows.Foundation.Numerics.Matrix4x4@) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.TryGetTransformTo ## -description This method returns the transform from the color frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified. ## -parameters ### -param targetId The unique ID of the target entity. ### -param result If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the color frame source coordinate system to the target entity coordinate system. ## -returns Returns true if a correlation exists, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TryGetTransformTo(System.String,Windows.Foundation.Numerics.Matrix4x4@) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.TryGetTransformTo + +## -description +This method returns the transform from the color frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified. + +## -parameters +### -param targetId +The unique ID of the target entity. + +### -param result +If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the color frame source coordinate system to the target entity coordinate system. + +## -returns +Returns true if a correlation exists, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_trysetvideoprofileasync_998537711.md b/windows.devices.perception/perceptioncolorframesource_trysetvideoprofileasync_998537711.md index edc31b5244..f70b5c3ec1 100644 --- a/windows.devices.perception/perceptioncolorframesource_trysetvideoprofileasync_998537711.md +++ b/windows.devices.perception/perceptioncolorframesource_trysetvideoprofileasync_998537711.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TrySetVideoProfileAsync(Windows.Devices.Perception.PerceptionControlSession,Windows.Devices.Perception.PerceptionVideoProfile) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSource.TrySetVideoProfileAsync ## -description Attempts to set a video profile on this color frame source. Requires an active Controller Mode control session on this frame source. ## -parameters ### -param controlSession A PerceptionControlSession representing active control of this frame source. ### -param profile The video profile to set. ## -returns This method returns an PerceptionFrameSourcePropertyChangeResult object asynchonously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result that indicates success. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSource.TrySetVideoProfileAsync(Windows.Devices.Perception.PerceptionControlSession,Windows.Devices.Perception.PerceptionVideoProfile) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.TrySetVideoProfileAsync + +## -description +Attempts to set a video profile on this color frame source. Requires an active Controller Mode control session on this frame source. + +## -parameters +### -param controlSession +A PerceptionControlSession representing active control of this frame source. + +### -param profile +The video profile to set. + +## -returns +This method returns an PerceptionFrameSourcePropertyChangeResult object asynchonously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result that indicates success. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_videoprofile.md b/windows.devices.perception/perceptioncolorframesource_videoprofile.md index e6797d08cf..995869f22c 100644 --- a/windows.devices.perception/perceptioncolorframesource_videoprofile.md +++ b/windows.devices.perception/perceptioncolorframesource_videoprofile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfile --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfile ## -description Gets a PerceptionVideoProfile object indicating the current video profile. ## -property-value A PerceptionVideoProfile object indicating the current video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfile +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfile + +## -description +Gets a PerceptionVideoProfile object indicating the current video profile. + +## -property-value +A PerceptionVideoProfile object indicating the current video profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesource_videoprofilechanged.md b/windows.devices.perception/perceptioncolorframesource_videoprofilechanged.md index 2de0ad7c89..d52af7e2b1 100644 --- a/windows.devices.perception/perceptioncolorframesource_videoprofilechanged.md +++ b/windows.devices.perception/perceptioncolorframesource_videoprofilechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfileChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfileChanged ## -description Subscribes to the VideoProfileChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfileChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSource.VideoProfileChanged + +## -description +Subscribes to the VideoProfileChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourceaddedeventargs.md b/windows.devices.perception/perceptioncolorframesourceaddedeventargs.md index abf1fcf5ed..411ad25d96 100644 --- a/windows.devices.perception/perceptioncolorframesourceaddedeventargs.md +++ b/windows.devices.perception/perceptioncolorframesourceaddedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs ## -description Event data for color frame source added events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs + +## -description +Event data for color frame source added events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourceaddedeventargs_framesource.md b/windows.devices.perception/perceptioncolorframesourceaddedeventargs_framesource.md index f69200fd9d..445d7bc24a 100644 --- a/windows.devices.perception/perceptioncolorframesourceaddedeventargs_framesource.md +++ b/windows.devices.perception/perceptioncolorframesourceaddedeventargs_framesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs.FrameSource --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs.FrameSource ## -description Gets the color frame source that was added. ## -property-value The color frame source that was added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs.FrameSource +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceAddedEventArgs.FrameSource + +## -description +Gets the color frame source that was added. + +## -property-value +The color frame source that was added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourceremovedeventargs.md b/windows.devices.perception/perceptioncolorframesourceremovedeventargs.md index 7008355980..46e468277f 100644 --- a/windows.devices.perception/perceptioncolorframesourceremovedeventargs.md +++ b/windows.devices.perception/perceptioncolorframesourceremovedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs ## -description Event data for color frame source added events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs + +## -description +Event data for color frame source added events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourceremovedeventargs_framesource.md b/windows.devices.perception/perceptioncolorframesourceremovedeventargs_framesource.md index f25c8056d5..317ba3af0c 100644 --- a/windows.devices.perception/perceptioncolorframesourceremovedeventargs_framesource.md +++ b/windows.devices.perception/perceptioncolorframesourceremovedeventargs_framesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs.FrameSource --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs.FrameSource ## -description Gets the color frame source that was removed. ## -property-value The color frame source that was removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs.FrameSource +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceRemovedEventArgs.FrameSource + +## -description +Gets the color frame source that was removed. + +## -property-value +The color frame source that was removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher.md b/windows.devices.perception/perceptioncolorframesourcewatcher.md index adc51b5316..70f44b7f59 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher ## -description Monitors changes to the list of color frame sources, and provides notifications when the list changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher + +## -description +Monitors changes to the list of color frame sources, and provides notifications when the list changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_enumerationcompleted.md b/windows.devices.perception/perceptioncolorframesourcewatcher_enumerationcompleted.md index 12559a6555..c096745ab7 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_enumerationcompleted.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_enumerationcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.EnumerationCompleted --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.EnumerationCompleted ## -description Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known color frame sources is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.EnumerationCompleted + +## -description +Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known color frame sources is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_sourceadded.md b/windows.devices.perception/perceptioncolorframesourcewatcher_sourceadded.md index ac28dfaaa2..debb639e61 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_sourceadded.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_sourceadded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceAdded --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceAdded ## -description Subscribes to the SourceAdded event. ## -remarks When the Start method is called, this event is fired for every color frame source already known to the system, then the EnumerationCompleted event is fired. New color frame sources that are subsequently added will trigger additional SourceAdded events. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceAdded +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceAdded + +## -description +Subscribes to the SourceAdded event. + +## -remarks +When the Start method is called, this event is fired for every color frame source already known to the system, then the EnumerationCompleted event is fired. New color frame sources that are subsequently added will trigger additional SourceAdded events. + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_sourceremoved.md b/windows.devices.perception/perceptioncolorframesourcewatcher_sourceremoved.md index 0d78fa590c..b66fbfc3a7 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_sourceremoved.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_sourceremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceRemoved --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceRemoved ## -description Subscribes to the SourceRemoved event. This event is fired once for every color frame source that is removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceRemoved +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.SourceRemoved + +## -description +Subscribes to the SourceRemoved event. This event is fired once for every color frame source that is removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_start_1587696324.md b/windows.devices.perception/perceptioncolorframesourcewatcher_start_1587696324.md index f4aa8fe588..4deafe1d40 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_start_1587696324.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Start --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Start ## -description When this method is called, the color frame source watcher enumerates any existing color frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The color frame source then starts watching for new color frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Start + +## -description +When this method is called, the color frame source watcher enumerates any existing color frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The color frame source then starts watching for new color frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_status.md b/windows.devices.perception/perceptioncolorframesourcewatcher_status.md index b1db5cccd0..dd56ae5751 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_status.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Status --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Status ## -description Gets the operational status of the color frame source watcher. ## -property-value A DeviceWatcherStatus enumeration value indicating the status of the color frame source watcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Status + +## -description +Gets the operational status of the color frame source watcher. + +## -property-value +A DeviceWatcherStatus enumeration value indicating the status of the color frame source watcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_stop_1201535524.md b/windows.devices.perception/perceptioncolorframesourcewatcher_stop_1201535524.md index 8c7d38b0ac..75af1fb3ae 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_stop_1201535524.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stop --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stop ## -description When this method is called, the color frame source watcher stops looking for changes to the color frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stop + +## -description +When this method is called, the color frame source watcher stops looking for changes to the color frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncolorframesourcewatcher_stopped.md b/windows.devices.perception/perceptioncolorframesourcewatcher_stopped.md index 00a4656b6a..f42efb65ea 100644 --- a/windows.devices.perception/perceptioncolorframesourcewatcher_stopped.md +++ b/windows.devices.perception/perceptioncolorframesourcewatcher_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stopped --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stopped ## -description Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of color frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionColorFrameSourceWatcher.Stopped + +## -description +Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of color frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncontrolsession.md b/windows.devices.perception/perceptioncontrolsession.md index a84c4579f9..4c9847bb84 100644 --- a/windows.devices.perception/perceptioncontrolsession.md +++ b/windows.devices.perception/perceptioncontrolsession.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionControlSession --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionControlSession ## -description Represents a control session on a controllable frame source. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionControlSession +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionControlSession + +## -description +Represents a control session on a controllable frame source. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptioncontrolsession_close_811482585.md b/windows.devices.perception/perceptioncontrolsession_close_811482585.md index e3a6b6d801..c71812f9f0 100644 --- a/windows.devices.perception/perceptioncontrolsession_close_811482585.md +++ b/windows.devices.perception/perceptioncontrolsession_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionControlSession.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionControlSession.Close ## -description Releases system resources that are exposed by a Windows Runtime object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionControlSession.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionControlSession.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncontrolsession_controllost.md b/windows.devices.perception/perceptioncontrolsession_controllost.md index 7e4bbe810a..c4bbad2be5 100644 --- a/windows.devices.perception/perceptioncontrolsession_controllost.md +++ b/windows.devices.perception/perceptioncontrolsession_controllost.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionControlSession.ControlLost --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionControlSession.ControlLost ## -description Subscribes to the ControlLost event. This event is triggered when control of the session is lost to another client. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionControlSession.ControlLost +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionControlSession.ControlLost + +## -description +Subscribes to the ControlLost event. This event is triggered when control of the session is lost to another client. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioncontrolsession_trysetpropertyasync_492628961.md b/windows.devices.perception/perceptioncontrolsession_trysetpropertyasync_492628961.md index 3c9f618fd1..502fd4e1dc 100644 --- a/windows.devices.perception/perceptioncontrolsession_trysetpropertyasync_492628961.md +++ b/windows.devices.perception/perceptioncontrolsession_trysetpropertyasync_492628961.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionControlSession.TrySetPropertyAsync(System.String,System.Object) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionControlSession.TrySetPropertyAsync ## -description Creates a property change request. This request is asynchronously processed, and is not guaranteed to succeed. The property change result should be inspected to determine if the property change was actually accepted and, if it was not, the reason why the property change was not accepted. ## -parameters ### -param name The name of the property to change. ### -param value The new property value. ## -returns This method asynchronously returns the result of the property change request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionControlSession.TrySetPropertyAsync(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionControlSession.TrySetPropertyAsync + +## -description +Creates a property change request. This request is asynchronously processed, and is not guaranteed to succeed. The property change result should be inspected to determine if the property change was actually accepted and, if it was not, the reason why the property change was not accepted. + +## -parameters +### -param name +The name of the property to change. + +### -param value +The new property value. + +## -returns +This method asynchronously returns the result of the property change request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics.md b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics.md index 371ab4688a..f07f57a200 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics ## -description Provides convenience methods to facilitate geometric math for a camera device, combining the intrinsic properties of that camera with correlated depth frames to provide screen-space pixel to camera-space coordinate projections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics + +## -description +Provides convenience methods to facilitate geometric math for a camera device, combining the intrinsic properties of that camera with correlated depth frames to provide screen-space pixel to camera-space coordinate projections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectallpixelsatcorrelateddepthasync_308588192.md b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectallpixelsatcorrelateddepthasync_308588192.md index 72b272e350..62f3a70da7 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectallpixelsatcorrelateddepthasync_308588192.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectallpixelsatcorrelateddepthasync_308588192.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectAllPixelsAtCorrelatedDepthAsync(Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Numerics.Vector3[]) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectAllPixelsAtCorrelatedDepthAsync ## -description Unprojects all pixels in an image from camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera. ## -parameters ### -param depthFrame The depth frame containing the depth value to use when projecting the points into camera space. The coordinates of each pixel in the image will be mapped from camera image space to depth image space, and then used to look up the depth in this depth frame. ### -param results Returns a set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. ## -returns This method returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectAllPixelsAtCorrelatedDepthAsync(Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Numerics.Vector3[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectAllPixelsAtCorrelatedDepthAsync + +## -description +Unprojects all pixels in an image from camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera. + +## -parameters +### -param depthFrame +The depth frame containing the depth value to use when projecting the points into camera space. The coordinates of each pixel in the image will be mapped from camera image space to depth image space, and then used to look up the depth in this depth frame. + +### -param results +Returns a set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. + +## -returns +This method returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelatcorrelateddepth_1543456086.md b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelatcorrelateddepth_1543456086.md index f8f1bb2dd4..e7bcb991b6 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelatcorrelateddepth_1543456086.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelatcorrelateddepth_1543456086.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelAtCorrelatedDepth(Windows.Foundation.Point,Windows.Devices.Perception.PerceptionDepthFrame) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelAtCorrelatedDepth ## -description Unprojects a point in camera image space out into the coordinate frame of the camera device, using the corresponding depth from a correlated depth camera. ## -parameters ### -param pixelCoordinate A point, relative to the camera frame. ### -param depthFrame The depth frame containing the depth value to use when projecting the point into camera space. The pixelCoordinate will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. ## -returns An unprojected coordinate, relative to the coordinate system of the camera device. The coordinate is located in front of the camera, at the depth of the corresponding pixel in depthFrame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelAtCorrelatedDepth(Windows.Foundation.Point,Windows.Devices.Perception.PerceptionDepthFrame) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelAtCorrelatedDepth + +## -description +Unprojects a point in camera image space out into the coordinate frame of the camera device, using the corresponding depth from a correlated depth camera. + +## -parameters +### -param pixelCoordinate +A point, relative to the camera frame. + +### -param depthFrame +The depth frame containing the depth value to use when projecting the point into camera space. The pixelCoordinate will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. + +## -returns +An unprojected coordinate, relative to the coordinate system of the camera device. The coordinate is located in front of the camera, at the depth of the corresponding pixel in depthFrame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelsatcorrelateddepth_1411106938.md b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelsatcorrelateddepth_1411106938.md index fad78be072..8a12a1453b 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelsatcorrelateddepth_1411106938.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectpixelsatcorrelateddepth_1411106938.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelsAtCorrelatedDepth(Windows.Foundation.Point[],Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Numerics.Vector3[]) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelsAtCorrelatedDepth ## -description Unprojects a set of points in camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera. ## -parameters ### -param sourceCoordinates A set of points, relative to the camera frame. ### -param depthFrame The depth frame containing the depth value to use when projecting the points into camera space. The pixelCoordinate will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. ### -param results A set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelsAtCorrelatedDepth(Windows.Foundation.Point[],Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Numerics.Vector3[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectPixelsAtCorrelatedDepth + +## -description +Unprojects a set of points in camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera. + +## -parameters +### -param sourceCoordinates +A set of points, relative to the camera frame. + +### -param depthFrame +The depth frame containing the depth value to use when projecting the points into camera space. The pixelCoordinate will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. + +### -param results +A set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectregionpixelsatcorrelateddepthasync_1579557747.md b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectregionpixelsatcorrelateddepthasync_1579557747.md index 08060dbe25..abb180c5c2 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectregionpixelsatcorrelateddepthasync_1579557747.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcameraintrinsics_unprojectregionpixelsatcorrelateddepthasync_1579557747.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectRegionPixelsAtCorrelatedDepthAsync(Windows.Foundation.Rect,Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Numerics.Vector3[]) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectRegionPixelsAtCorrelatedDepthAsync ## -description Unprojects a region of pixels in an image from camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera. ## -parameters ### -param region The region of pixels to project from camera image space out into the coordinate frame of the camera device. ### -param depthFrame The depth frame containing the depth value to use when projecting the points into camera space. The pixelCoordinates will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. ### -param results A set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. ## -returns This method returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectRegionPixelsAtCorrelatedDepthAsync(Windows.Foundation.Rect,Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Numerics.Vector3[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCameraIntrinsics.UnprojectRegionPixelsAtCorrelatedDepthAsync + +## -description +Unprojects a region of pixels in an image from camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera. + +## -parameters +### -param region +The region of pixels to project from camera image space out into the coordinate frame of the camera device. + +### -param depthFrame +The depth frame containing the depth value to use when projecting the points into camera space. The pixelCoordinates will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. + +### -param results +A set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. + +## -returns +This method returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper.md b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper.md index e0686832e4..84bb7afba1 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper ## -description Provides convenience methods to map pixel coordinates in camera image space to depth image space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper + +## -description +Provides convenience methods to map pixel coordinates in camera image space to depth image space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapallpixelstotargetasync_1894583828.md b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapallpixelstotargetasync_1894583828.md index 80641ed3e8..9a9652ef25 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapallpixelstotargetasync_1894583828.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapallpixelstotargetasync_1894583828.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapAllPixelsToTargetAsync(Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapAllPixelsToTargetAsync ## -description Maps all pixels in an image from camera image space to depth image space. ## -parameters ### -param depthFrame The depth frame to map the pixels to. ### -param targetCoordinates Returns the pixel coordinates, mapped to depth image space. ## -returns This function returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapAllPixelsToTargetAsync(Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapAllPixelsToTargetAsync + +## -description +Maps all pixels in an image from camera image space to depth image space. + +## -parameters +### -param depthFrame +The depth frame to map the pixels to. + +### -param targetCoordinates +Returns the pixel coordinates, mapped to depth image space. + +## -returns +This function returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixelstotarget_1078477197.md b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixelstotarget_1078477197.md index 91a6166acc..1dee34f426 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixelstotarget_1078477197.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixelstotarget_1078477197.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelsToTarget(Windows.Foundation.Point[],Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelsToTarget ## -description Maps a set of pixels from camera image space to depth image space. ## -parameters ### -param sourceCoordinates A set of pixel coordinates, in camera image space. ### -param depthFrame The depth frame to map the pixels to. ### -param results The mapping of the pixel coordinate to depth image space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelsToTarget(Windows.Foundation.Point[],Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelsToTarget + +## -description +Maps a set of pixels from camera image space to depth image space. + +## -parameters +### -param sourceCoordinates +A set of pixel coordinates, in camera image space. + +### -param depthFrame +The depth frame to map the pixels to. + +### -param results +The mapping of the pixel coordinate to depth image space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixeltotarget_668884943.md b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixeltotarget_668884943.md index 3feb31d146..8cfbae6ab1 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixeltotarget_668884943.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mappixeltotarget_668884943.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelToTarget(Windows.Foundation.Point,Windows.Devices.Perception.PerceptionDepthFrame) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelToTarget ## -description Maps a pixel from camera image space to depth image space. ## -parameters ### -param sourcePixelCoordinate A pixel coordinate, in camera image space. ### -param depthFrame The depth frame to map the pixel to. ## -returns Returns the mapping of the pixel coordinate to depth image space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelToTarget(Windows.Foundation.Point,Windows.Devices.Perception.PerceptionDepthFrame) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapPixelToTarget + +## -description +Maps a pixel from camera image space to depth image space. + +## -parameters +### -param sourcePixelCoordinate +A pixel coordinate, in camera image space. + +### -param depthFrame +The depth frame to map the pixel to. + +## -returns +Returns the mapping of the pixel coordinate to depth image space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapregionofpixelstotargetasync_1640921678.md b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapregionofpixelstotargetasync_1640921678.md index 99c0912d6d..011bf79dc1 100644 --- a/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapregionofpixelstotargetasync_1640921678.md +++ b/windows.devices.perception/perceptiondepthcorrelatedcoordinatemapper_mapregionofpixelstotargetasync_1640921678.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapRegionOfPixelsToTargetAsync(Windows.Foundation.Rect,Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapRegionOfPixelsToTargetAsync ## -description Maps a region of pixels from camera image space to depth image space. ## -parameters ### -param region The region of pixels to map from camera image space to depth image space. ### -param depthFrame The depth frame to map the region of pixels to. ### -param targetCoordinates The pixel coordinates, mapped to depth image space. ## -returns This function returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapRegionOfPixelsToTargetAsync(Windows.Foundation.Rect,Windows.Devices.Perception.PerceptionDepthFrame,Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthCorrelatedCoordinateMapper.MapRegionOfPixelsToTargetAsync + +## -description +Maps a region of pixels from camera image space to depth image space. + +## -parameters +### -param region +The region of pixels to map from camera image space to depth image space. + +### -param depthFrame +The depth frame to map the region of pixels to. + +### -param targetCoordinates +The pixel coordinates, mapped to depth image space. + +## -returns +This function returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframe.md b/windows.devices.perception/perceptiondepthframe.md index 9c8f4ae18e..9308218a1e 100644 --- a/windows.devices.perception/perceptiondepthframe.md +++ b/windows.devices.perception/perceptiondepthframe.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrame --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrame ## -description Contains a Windows.Media.VideoFrame with the depth frame data. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrame +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrame + +## -description +Contains a Windows.Media.VideoFrame with the depth frame data. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptiondepthframe_close_811482585.md b/windows.devices.perception/perceptiondepthframe_close_811482585.md index 90a7066863..976b74c26e 100644 --- a/windows.devices.perception/perceptiondepthframe_close_811482585.md +++ b/windows.devices.perception/perceptiondepthframe_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrame.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrame.Close ## -description Releases system resources that are exposed by a Windows Runtime object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrame.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrame.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframe_videoframe.md b/windows.devices.perception/perceptiondepthframe_videoframe.md index 17995da5fe..b60c3913ad 100644 --- a/windows.devices.perception/perceptiondepthframe_videoframe.md +++ b/windows.devices.perception/perceptiondepthframe_videoframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrame.VideoFrame --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrame.VideoFrame ## -description Gets a Windows.Media.VideoFrame with the depth frame data. ## -property-value A Windows.Media.VideoFrame with the depth frame data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrame.VideoFrame +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrame.VideoFrame + +## -description +Gets a Windows.Media.VideoFrame with the depth frame data. + +## -property-value +A Windows.Media.VideoFrame with the depth frame data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframearrivedeventargs.md b/windows.devices.perception/perceptiondepthframearrivedeventargs.md index efd395a9ca..5b165b4fc0 100644 --- a/windows.devices.perception/perceptiondepthframearrivedeventargs.md +++ b/windows.devices.perception/perceptiondepthframearrivedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs ## -description Contains information about a depth frame arrived event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs + +## -description +Contains information about a depth frame arrived event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframearrivedeventargs_relativetime.md b/windows.devices.perception/perceptiondepthframearrivedeventargs_relativetime.md index 302307bcf2..ceeb93928b 100644 --- a/windows.devices.perception/perceptiondepthframearrivedeventargs_relativetime.md +++ b/windows.devices.perception/perceptiondepthframearrivedeventargs_relativetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.RelativeTime --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.RelativeTime ## -description Gets the relative time of this frame. ## -property-value The relative time of this frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.RelativeTime +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.RelativeTime + +## -description +Gets the relative time of this frame. + +## -property-value +The relative time of this frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframearrivedeventargs_tryopenframe_1525544366.md b/windows.devices.perception/perceptiondepthframearrivedeventargs_tryopenframe_1525544366.md index ff8dcf6b21..8ca682633f 100644 --- a/windows.devices.perception/perceptiondepthframearrivedeventargs_tryopenframe_1525544366.md +++ b/windows.devices.perception/perceptiondepthframearrivedeventargs_tryopenframe_1525544366.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.TryOpenFrame --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.TryOpenFrame ## -description Attempts to open the depth frame that has arrived. Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail. ## -returns If the attempt is successful, this method returns the newly-arrived depth frame. If the attempt is unsuccessful, this value is unchanged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.TryOpenFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameArrivedEventArgs.TryOpenFrame + +## -description +Attempts to open the depth frame that has arrived. Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail. + +## -returns +If the attempt is successful, this method returns the newly-arrived depth frame. If the attempt is unsuccessful, this value is unchanged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframereader.md b/windows.devices.perception/perceptiondepthframereader.md index 9061efd9c4..ecea0611c0 100644 --- a/windows.devices.perception/perceptiondepthframereader.md +++ b/windows.devices.perception/perceptiondepthframereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrameReader --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrameReader ## -description Reads depth frames from a depth frame source. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrameReader +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameReader + +## -description +Reads depth frames from a depth frame source. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptiondepthframereader_close_811482585.md b/windows.devices.perception/perceptiondepthframereader_close_811482585.md index 5638c1c8e4..ac25766ff1 100644 --- a/windows.devices.perception/perceptiondepthframereader_close_811482585.md +++ b/windows.devices.perception/perceptiondepthframereader_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameReader.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameReader.Close ## -description Releases system resources that are exposed by a Windows Runtime object ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameReader.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameReader.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframereader_framearrived.md b/windows.devices.perception/perceptiondepthframereader_framearrived.md index 6492710ecb..84b80e9ab1 100644 --- a/windows.devices.perception/perceptiondepthframereader_framearrived.md +++ b/windows.devices.perception/perceptiondepthframereader_framearrived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameReader.FrameArrived --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameReader.FrameArrived ## -description Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the depth frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameReader.FrameArrived +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameReader.FrameArrived + +## -description +Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the depth frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframereader_ispaused.md b/windows.devices.perception/perceptiondepthframereader_ispaused.md index 3bdca88d10..fe789d33b2 100644 --- a/windows.devices.perception/perceptiondepthframereader_ispaused.md +++ b/windows.devices.perception/perceptiondepthframereader_ispaused.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameReader.IsPaused --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameReader.IsPaused ## -description Gets a boolean value indicating whether or not this reader is paused. ## -property-value A boolean value indicating whether or not this reader is paused. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameReader.IsPaused +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameReader.IsPaused + +## -description +Gets a boolean value indicating whether or not this reader is paused. + +## -property-value +A boolean value indicating whether or not this reader is paused. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframereader_source.md b/windows.devices.perception/perceptiondepthframereader_source.md index 25259b69da..5ff89916f1 100644 --- a/windows.devices.perception/perceptiondepthframereader_source.md +++ b/windows.devices.perception/perceptiondepthframereader_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameReader.Source --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameReader.Source ## -description Gets the depth frame source this reader gets frames from. ## -property-value The depth frame source this reader gets frames from. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameReader.Source +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameReader.Source + +## -description +Gets the depth frame source this reader gets frames from. + +## -property-value +The depth frame source this reader gets frames from. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframereader_tryreadlatestframe_1676630157.md b/windows.devices.perception/perceptiondepthframereader_tryreadlatestframe_1676630157.md index 31b8a9c3b0..03635a303c 100644 --- a/windows.devices.perception/perceptiondepthframereader_tryreadlatestframe_1676630157.md +++ b/windows.devices.perception/perceptiondepthframereader_tryreadlatestframe_1676630157.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameReader.TryReadLatestFrame --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameReader.TryReadLatestFrame ## -description Attempts to read the most recent frame that is available to this depth frame reader. ## -returns If the attempt was successful, this method returns the most recent frame that is available to this depth frame reader. If the attempt was not successful, this method returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameReader.TryReadLatestFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameReader.TryReadLatestFrame + +## -description +Attempts to read the most recent frame that is available to this depth frame reader. + +## -returns +If the attempt was successful, this method returns the most recent frame that is available to this depth frame reader. If the attempt was not successful, this method returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource.md b/windows.devices.perception/perceptiondepthframesource.md index 7394451471..ce30481459 100644 --- a/windows.devices.perception/perceptiondepthframesource.md +++ b/windows.devices.perception/perceptiondepthframesource.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSource --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrameSource ## -description A frame source that provides depth frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSource +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource + +## -description +A frame source that provides depth frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_acquirecontrolsession_73364641.md b/windows.devices.perception/perceptiondepthframesource_acquirecontrolsession_73364641.md index 0efebc5262..22dc611d44 100644 --- a/windows.devices.perception/perceptiondepthframesource_acquirecontrolsession_73364641.md +++ b/windows.devices.perception/perceptiondepthframesource_acquirecontrolsession_73364641.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.AcquireControlSession --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.AcquireControlSession ## -description Attempts to acquire Controller Mode on the depth frame source. ## -returns If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the depth frame source. Otherwise, this returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.AcquireControlSession +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.AcquireControlSession + +## -description +Attempts to acquire Controller Mode on the depth frame source. + +## -returns +If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the depth frame source. Otherwise, this returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_active.md b/windows.devices.perception/perceptiondepthframesource_active.md index 71bcfe7b93..228155b138 100644 --- a/windows.devices.perception/perceptiondepthframesource_active.md +++ b/windows.devices.perception/perceptiondepthframesource_active.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Active --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.Active ## -description Gets a boolean value indicating whether or not the source is active. ## -property-value A boolean value indicating whether or not the source is active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Active +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.Active + +## -description +Gets a boolean value indicating whether or not the source is active. + +## -property-value +A boolean value indicating whether or not the source is active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_activechanged.md b/windows.devices.perception/perceptiondepthframesource_activechanged.md index f0fb85b5c8..962bae5b23 100644 --- a/windows.devices.perception/perceptiondepthframesource_activechanged.md +++ b/windows.devices.perception/perceptiondepthframesource_activechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.ActiveChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.ActiveChanged ## -description Subscribes to the ActiveChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.ActiveChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.ActiveChanged + +## -description +Subscribes to the ActiveChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_available.md b/windows.devices.perception/perceptiondepthframesource_available.md index e4fa8d27c5..d040fd7477 100644 --- a/windows.devices.perception/perceptiondepthframesource_available.md +++ b/windows.devices.perception/perceptiondepthframesource_available.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Available --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.Available ## -description Gets a boolean value indicating whether or not the source is available. ## -property-value A boolean value indicating whether or not the source is available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Available +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.Available + +## -description +Gets a boolean value indicating whether or not the source is available. + +## -property-value +A boolean value indicating whether or not the source is available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_availablechanged.md b/windows.devices.perception/perceptiondepthframesource_availablechanged.md index 438ec2efe0..f347577596 100644 --- a/windows.devices.perception/perceptiondepthframesource_availablechanged.md +++ b/windows.devices.perception/perceptiondepthframesource_availablechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableChanged ## -description Subscribes to the AvailableChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableChanged + +## -description +Subscribes to the AvailableChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_availablevideoprofiles.md b/windows.devices.perception/perceptiondepthframesource_availablevideoprofiles.md index 159e1a60d7..68f738b238 100644 --- a/windows.devices.perception/perceptiondepthframesource_availablevideoprofiles.md +++ b/windows.devices.perception/perceptiondepthframesource_availablevideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableVideoProfiles ## -description Gets a read-only collection of video profiles that are currently available from the depth frame source. ## -property-value A read-only collection of video profiles that are currently available from the depth frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.AvailableVideoProfiles + +## -description +Gets a read-only collection of video profiles that are currently available from the depth frame source. + +## -property-value +A read-only collection of video profiles that are currently available from the depth frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_cameraintrinsics.md b/windows.devices.perception/perceptiondepthframesource_cameraintrinsics.md index ce26e69771..0f0b9f584b 100644 --- a/windows.devices.perception/perceptiondepthframesource_cameraintrinsics.md +++ b/windows.devices.perception/perceptiondepthframesource_cameraintrinsics.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsics --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsics ## -description Gets a CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device. ## -property-value A CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsics +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsics + +## -description +Gets a CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device. + +## -property-value +A CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_cameraintrinsicschanged.md b/windows.devices.perception/perceptiondepthframesource_cameraintrinsicschanged.md index 61f6ac554d..9d58d0d13b 100644 --- a/windows.devices.perception/perceptiondepthframesource_cameraintrinsicschanged.md +++ b/windows.devices.perception/perceptiondepthframesource_cameraintrinsicschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsicsChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsicsChanged ## -description Subscribes to the CameraIntrinsicsChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsicsChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.CameraIntrinsicsChanged + +## -description +Subscribes to the CameraIntrinsicsChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_cancontrolindependentlyfrom_1911149790.md b/windows.devices.perception/perceptiondepthframesource_cancontrolindependentlyfrom_1911149790.md index c1c6591dcf..7cb48feb7d 100644 --- a/windows.devices.perception/perceptiondepthframesource_cancontrolindependentlyfrom_1911149790.md +++ b/windows.devices.perception/perceptiondepthframesource_cancontrolindependentlyfrom_1911149790.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.CanControlIndependentlyFrom(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.CanControlIndependentlyFrom ## -description This method returns a boolean value indicating whether or not the depth frame source can be controlled separately from another frame source. ## -parameters ### -param targetId A string representing the unique ID of the other frame source. ## -returns True if the two sources can be controlled independently of one another; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.CanControlIndependentlyFrom(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.CanControlIndependentlyFrom + +## -description +This method returns a boolean value indicating whether or not the depth frame source can be controlled separately from another frame source. + +## -parameters +### -param targetId +A string representing the unique ID of the other frame source. + +## -returns +True if the two sources can be controlled independently of one another; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_createwatcher_1506431823.md b/windows.devices.perception/perceptiondepthframesource_createwatcher_1506431823.md index 7414416d85..5844ed1d45 100644 --- a/windows.devices.perception/perceptiondepthframesource_createwatcher_1506431823.md +++ b/windows.devices.perception/perceptiondepthframesource_createwatcher_1506431823.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.CreateWatcher --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.CreateWatcher ## -description Creates a new depth frame source watcher. ## -returns A new depth frame source watcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.CreateWatcher +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.CreateWatcher + +## -description +Creates a new depth frame source watcher. + +## -returns +A new depth frame source watcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_deviceid.md b/windows.devices.perception/perceptiondepthframesource_deviceid.md index 62c59f1131..c3b27431f4 100644 --- a/windows.devices.perception/perceptiondepthframesource_deviceid.md +++ b/windows.devices.perception/perceptiondepthframesource_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceId --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceId ## -description Gets a string value that identifies the device on the system. ## -property-value The identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceId + +## -description +Gets a string value that identifies the device on the system. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_devicekind.md b/windows.devices.perception/perceptiondepthframesource_devicekind.md index 5504be218e..fe99d1e537 100644 --- a/windows.devices.perception/perceptiondepthframesource_devicekind.md +++ b/windows.devices.perception/perceptiondepthframesource_devicekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceKind --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceKind ## -description Gets a string value indicating the kind of physical device that generates the depth frames. ## -property-value A string value indicating the kind of physical device that generates the depth frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceKind +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.DeviceKind + +## -description +Gets a string value indicating the kind of physical device that generates the depth frames. + +## -property-value +A string value indicating the kind of physical device that generates the depth frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_displayname.md b/windows.devices.perception/perceptiondepthframesource_displayname.md index 76f9e0ad70..19848cf93c 100644 --- a/windows.devices.perception/perceptiondepthframesource_displayname.md +++ b/windows.devices.perception/perceptiondepthframesource_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.DisplayName --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.DisplayName ## -description Gets a string value indicating the display name of the depth frame source. ## -property-value A string value indicating the display name of the depth frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.DisplayName +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.DisplayName + +## -description +Gets a string value indicating the display name of the depth frame source. + +## -property-value +A string value indicating the display name of the depth frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_findallasync_326280522.md b/windows.devices.perception/perceptiondepthframesource_findallasync_326280522.md index 013ed8ceb0..4dd2ad9997 100644 --- a/windows.devices.perception/perceptiondepthframesource_findallasync_326280522.md +++ b/windows.devices.perception/perceptiondepthframesource_findallasync_326280522.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.FindAllAsync --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.FindAllAsync ## -description Finds all depth frame sources. ## -returns When the method completes, it asynchronously returns a list of depth frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.FindAllAsync + +## -description +Finds all depth frame sources. + +## -returns +When the method completes, it asynchronously returns a list of depth frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_fromidasync_1322863552.md b/windows.devices.perception/perceptiondepthframesource_fromidasync_1322863552.md index 1baded69ba..48fe8192ce 100644 --- a/windows.devices.perception/perceptiondepthframesource_fromidasync_1322863552.md +++ b/windows.devices.perception/perceptiondepthframesource_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.FromIdAsync ## -description Finds an depth frame source by looking up its unique ID. ## -parameters ### -param id The unique ID of the depth frame source. ## -returns When this method completes, it asynchronously returns a depth frame source if one exists with the specified ID. Otherwise, this method asynchronously returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.FromIdAsync + +## -description +Finds an depth frame source by looking up its unique ID. + +## -parameters +### -param id +The unique ID of the depth frame source. + +## -returns +When this method completes, it asynchronously returns a depth frame source if one exists with the specified ID. Otherwise, this method asynchronously returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_id.md b/windows.devices.perception/perceptiondepthframesource_id.md index 64bb749606..fed0e4a80e 100644 --- a/windows.devices.perception/perceptiondepthframesource_id.md +++ b/windows.devices.perception/perceptiondepthframesource_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Id --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.Id ## -description Gets a string value indicating the unique ID of the depth frame source. ## -property-value A string value indicating the unique ID of the depth frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.Id + +## -description +Gets a string value indicating the unique ID of the depth frame source. + +## -property-value +A string value indicating the unique ID of the depth frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_iscontrolled.md b/windows.devices.perception/perceptiondepthframesource_iscontrolled.md index 9bae291bd7..fb0373864b 100644 --- a/windows.devices.perception/perceptiondepthframesource_iscontrolled.md +++ b/windows.devices.perception/perceptiondepthframesource_iscontrolled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.IsControlled --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.IsControlled ## -description Gets a boolean value indicating whether or not the source is the subject of controller mode. ## -property-value A boolean value indicating whether or not the source is the subject of controller mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.IsControlled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.IsControlled + +## -description +Gets a boolean value indicating whether or not the source is the subject of controller mode. + +## -property-value +A boolean value indicating whether or not the source is the subject of controller mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_iscorrelatedwith_25122365.md b/windows.devices.perception/perceptiondepthframesource_iscorrelatedwith_25122365.md index ad06464dfa..5ebaee2ad8 100644 --- a/windows.devices.perception/perceptiondepthframesource_iscorrelatedwith_25122365.md +++ b/windows.devices.perception/perceptiondepthframesource_iscorrelatedwith_25122365.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.IsCorrelatedWith(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.IsCorrelatedWith ## -description Checks whether or not the depth frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this depth frame source to the entity, or vice versa. ## -parameters ### -param targetId The unique ID of the target entity. ## -returns True if a correlation exists, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.IsCorrelatedWith(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.IsCorrelatedWith + +## -description +Checks whether or not the depth frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this depth frame source to the entity, or vice versa. + +## -parameters +### -param targetId +The unique ID of the target entity. + +## -returns +True if a correlation exists, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_openreader_1109726428.md b/windows.devices.perception/perceptiondepthframesource_openreader_1109726428.md index e3328d7e1d..d4ee0433ec 100644 --- a/windows.devices.perception/perceptiondepthframesource_openreader_1109726428.md +++ b/windows.devices.perception/perceptiondepthframesource_openreader_1109726428.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.OpenReader --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.OpenReader ## -description Gets a frame reader that reads frames from this depth frame source. ## -returns A frame reader that reads frames from this depth frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.OpenReader +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.OpenReader + +## -description +Gets a frame reader that reads frames from this depth frame source. + +## -returns +A frame reader that reads frames from this depth frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_properties.md b/windows.devices.perception/perceptiondepthframesource_properties.md index 29e9a380f6..ba4fc5d9fa 100644 --- a/windows.devices.perception/perceptiondepthframesource_properties.md +++ b/windows.devices.perception/perceptiondepthframesource_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Properties --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.Properties ## -description Gets a read-only collection of frame source properties. ## -property-value A read-only collection of frame source properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.Properties + +## -description +Gets a read-only collection of frame source properties. + +## -property-value +A read-only collection of frame source properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_propertieschanged.md b/windows.devices.perception/perceptiondepthframesource_propertieschanged.md index d149b1ed14..e4543765d6 100644 --- a/windows.devices.perception/perceptiondepthframesource_propertieschanged.md +++ b/windows.devices.perception/perceptiondepthframesource_propertieschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.PropertiesChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.PropertiesChanged ## -description Subscribes to the PropertiesChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.PropertiesChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.PropertiesChanged + +## -description +Subscribes to the PropertiesChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_requestaccessasync_380675631.md b/windows.devices.perception/perceptiondepthframesource_requestaccessasync_380675631.md index 6b9e75bd5a..d9ae57826c 100644 --- a/windows.devices.perception/perceptiondepthframesource_requestaccessasync_380675631.md +++ b/windows.devices.perception/perceptiondepthframesource_requestaccessasync_380675631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.RequestAccessAsync ## -description Requests access to use depth frame sources. ## -returns When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.RequestAccessAsync + +## -description +Requests access to use depth frame sources. + +## -returns +When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_supportedvideoprofiles.md b/windows.devices.perception/perceptiondepthframesource_supportedvideoprofiles.md index 45f0afb550..57eb90de7c 100644 --- a/windows.devices.perception/perceptiondepthframesource_supportedvideoprofiles.md +++ b/windows.devices.perception/perceptiondepthframesource_supportedvideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.SupportedVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.SupportedVideoProfiles ## -description Gets a read-only collection of video profiles that are supported by the depth frame source. ## -property-value A read-only collection of video profiles that are supported by the depth frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.SupportedVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.SupportedVideoProfiles + +## -description +Gets a read-only collection of video profiles that are supported by the depth frame source. + +## -property-value +A read-only collection of video profiles that are supported by the depth frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md b/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md index 1da541f1fd..eb70b6ba64 100644 --- a/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md +++ b/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync(Windows.Devices.Perception.PerceptionDepthFrameSource) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync ## -description Attempts to get the intrinsic properties of the depth camera that is correlated with this depth source. ## -parameters ### -param target The depth frame source to try to get intrinsic properties of. ## -returns If the attempt is successful, this returns a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync(Windows.Devices.Perception.PerceptionDepthFrameSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync + +## -description +Attempts to get the intrinsic properties of the depth camera that is correlated with this depth source. + +## -parameters +### -param target +The depth frame source to try to get intrinsic properties of. + +## -returns +If the attempt is successful, this returns a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md b/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md index 677535eee0..11d3445358 100644 --- a/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md +++ b/windows.devices.perception/perceptiondepthframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync(System.String,Windows.Devices.Perception.PerceptionDepthFrameSource) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync ## -description Attempts to get a coordinate mapper that maps from depth frame image space to depth frame space. ## -parameters ### -param targetId The unique ID of the depth frame source to try to map to. ### -param depthFrameSourceToMapWith The depth frame source to try to map to. This should be in a correlation group with the depth frame source. ## -returns If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync(System.String,Windows.Devices.Perception.PerceptionDepthFrameSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync + +## -description +Attempts to get a coordinate mapper that maps from depth frame image space to depth frame space. + +## -parameters +### -param targetId +The unique ID of the depth frame source to try to map to. + +### -param depthFrameSourceToMapWith +The depth frame source to try to map to. This should be in a correlation group with the depth frame source. + +## -returns +If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_trygettransformto_253749040.md b/windows.devices.perception/perceptiondepthframesource_trygettransformto_253749040.md index 2b517dcd68..8b920b292b 100644 --- a/windows.devices.perception/perceptiondepthframesource_trygettransformto_253749040.md +++ b/windows.devices.perception/perceptiondepthframesource_trygettransformto_253749040.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetTransformTo(System.String,Windows.Foundation.Numerics.Matrix4x4@) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetTransformTo ## -description Gets the transform from the depth frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified. ## -parameters ### -param targetId The unique ID of the target entity. ### -param result If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the depth frame source coordinate system to the target entity coordinate system. ## -returns True if a correlation exists, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetTransformTo(System.String,Windows.Foundation.Numerics.Matrix4x4@) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.TryGetTransformTo + +## -description +Gets the transform from the depth frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified. + +## -parameters +### -param targetId +The unique ID of the target entity. + +### -param result +If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the depth frame source coordinate system to the target entity coordinate system. + +## -returns +True if a correlation exists, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_trysetvideoprofileasync_998537711.md b/windows.devices.perception/perceptiondepthframesource_trysetvideoprofileasync_998537711.md index ca14ddeba3..acd6459320 100644 --- a/windows.devices.perception/perceptiondepthframesource_trysetvideoprofileasync_998537711.md +++ b/windows.devices.perception/perceptiondepthframesource_trysetvideoprofileasync_998537711.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TrySetVideoProfileAsync(Windows.Devices.Perception.PerceptionControlSession,Windows.Devices.Perception.PerceptionVideoProfile) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.TrySetVideoProfileAsync ## -description Attempts to set a video profile on this depth frame source. Requires an active Controller Mode control session on this frame source. ## -parameters ### -param controlSession A PerceptionControlSession representing active control of this frame source. ### -param profile The video profile to set. ## -returns This method returns an PerceptionFrameSourcePropertyChangeResult object asynchronously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result indicating success. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSource.TrySetVideoProfileAsync(Windows.Devices.Perception.PerceptionControlSession,Windows.Devices.Perception.PerceptionVideoProfile) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.TrySetVideoProfileAsync + +## -description +Attempts to set a video profile on this depth frame source. Requires an active Controller Mode control session on this frame source. + +## -parameters +### -param controlSession +A PerceptionControlSession representing active control of this frame source. + +### -param profile +The video profile to set. + +## -returns +This method returns an PerceptionFrameSourcePropertyChangeResult object asynchronously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result indicating success. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_videoprofile.md b/windows.devices.perception/perceptiondepthframesource_videoprofile.md index e60b005748..493ffc6058 100644 --- a/windows.devices.perception/perceptiondepthframesource_videoprofile.md +++ b/windows.devices.perception/perceptiondepthframesource_videoprofile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfile --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfile ## -description Gets a PerceptionVideoProfile object indicating the current video profile. ## -property-value A PerceptionVideoProfile object indicating the current video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfile +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfile + +## -description +Gets a PerceptionVideoProfile object indicating the current video profile. + +## -property-value +A PerceptionVideoProfile object indicating the current video profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesource_videoprofilechanged.md b/windows.devices.perception/perceptiondepthframesource_videoprofilechanged.md index 4c68e75847..d3ace16208 100644 --- a/windows.devices.perception/perceptiondepthframesource_videoprofilechanged.md +++ b/windows.devices.perception/perceptiondepthframesource_videoprofilechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfileChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfileChanged ## -description Subscribes to the VideoProfileChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfileChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSource.VideoProfileChanged + +## -description +Subscribes to the VideoProfileChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourceaddedeventargs.md b/windows.devices.perception/perceptiondepthframesourceaddedeventargs.md index 6f5ed31c34..73264a3f15 100644 --- a/windows.devices.perception/perceptiondepthframesourceaddedeventargs.md +++ b/windows.devices.perception/perceptiondepthframesourceaddedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs ## -description Event data for depth frame source added events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs + +## -description +Event data for depth frame source added events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourceaddedeventargs_framesource.md b/windows.devices.perception/perceptiondepthframesourceaddedeventargs_framesource.md index 91609bda89..28d98686d8 100644 --- a/windows.devices.perception/perceptiondepthframesourceaddedeventargs_framesource.md +++ b/windows.devices.perception/perceptiondepthframesourceaddedeventargs_framesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs.FrameSource --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs.FrameSource ## -description Gets the depth frame source that was added. ## -property-value The depth frame source that was added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs.FrameSource +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceAddedEventArgs.FrameSource + +## -description +Gets the depth frame source that was added. + +## -property-value +The depth frame source that was added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourceremovedeventargs.md b/windows.devices.perception/perceptiondepthframesourceremovedeventargs.md index 6d5f6df8eb..10e6e7cf36 100644 --- a/windows.devices.perception/perceptiondepthframesourceremovedeventargs.md +++ b/windows.devices.perception/perceptiondepthframesourceremovedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs ## -description Event data for depth frame source removed events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs + +## -description +Event data for depth frame source removed events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourceremovedeventargs_framesource.md b/windows.devices.perception/perceptiondepthframesourceremovedeventargs_framesource.md index 0e6320326f..e921d1c095 100644 --- a/windows.devices.perception/perceptiondepthframesourceremovedeventargs_framesource.md +++ b/windows.devices.perception/perceptiondepthframesourceremovedeventargs_framesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs.FrameSource --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs.FrameSource ## -description Gets the depth frame source that was removed. ## -property-value The depth frame source that was removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs.FrameSource +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceRemovedEventArgs.FrameSource + +## -description +Gets the depth frame source that was removed. + +## -property-value +The depth frame source that was removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher.md b/windows.devices.perception/perceptiondepthframesourcewatcher.md index 8b70ffa7cb..460bdb66e7 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher ## -description Monitors changes to the list of depth frame sources, and provides notifications when the list changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher + +## -description +Monitors changes to the list of depth frame sources, and provides notifications when the list changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_enumerationcompleted.md b/windows.devices.perception/perceptiondepthframesourcewatcher_enumerationcompleted.md index 85ad6b6b4b..bf0a1ad9a9 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_enumerationcompleted.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_enumerationcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.EnumerationCompleted --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.EnumerationCompleted ## -description Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known depth frame sources is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.EnumerationCompleted + +## -description +Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known depth frame sources is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_sourceadded.md b/windows.devices.perception/perceptiondepthframesourcewatcher_sourceadded.md index 91371ac8d0..ee423afda2 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_sourceadded.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_sourceadded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceAdded --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceAdded ## -description Subscribes to the SourceAdded event. ## -remarks When the Start method is called, this event is fired for every depth frame source already known to the system, then the EnumerationCompleted event is fired. New depth frame sources that are subsequently added will trigger additional SourceAdded events. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceAdded +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceAdded + +## -description +Subscribes to the SourceAdded event. + +## -remarks +When the Start method is called, this event is fired for every depth frame source already known to the system, then the EnumerationCompleted event is fired. New depth frame sources that are subsequently added will trigger additional SourceAdded events. + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_sourceremoved.md b/windows.devices.perception/perceptiondepthframesourcewatcher_sourceremoved.md index 032db77b3a..b4c1799f3a 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_sourceremoved.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_sourceremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceRemoved --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceRemoved ## -description Subscribes to the SourceRemoved event. This event is fired once for every depth frame source that is removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceRemoved +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.SourceRemoved + +## -description +Subscribes to the SourceRemoved event. This event is fired once for every depth frame source that is removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_start_1587696324.md b/windows.devices.perception/perceptiondepthframesourcewatcher_start_1587696324.md index 20a0deca7f..960aa8cdb7 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_start_1587696324.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Start --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Start ## -description When this method is called, the depth frame source watcher enumerates any existing depth frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The depth frame source then starts watching for new depth frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Start + +## -description +When this method is called, the depth frame source watcher enumerates any existing depth frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The depth frame source then starts watching for new depth frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_status.md b/windows.devices.perception/perceptiondepthframesourcewatcher_status.md index f3a3783e9e..4f0f250533 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_status.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Status --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Status ## -description Gets the operational status of the depth frame source watcher. ## -property-value A DeviceWatcherStatus enumeration value indicating the status of the depth frame source watcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Status + +## -description +Gets the operational status of the depth frame source watcher. + +## -property-value +A DeviceWatcherStatus enumeration value indicating the status of the depth frame source watcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_stop_1201535524.md b/windows.devices.perception/perceptiondepthframesourcewatcher_stop_1201535524.md index 5ed9970f19..fdab991102 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_stop_1201535524.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stop --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stop ## -description When this method is called, the depth frame source watcher stops looking for changes to the depth frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stop + +## -description +When this method is called, the depth frame source watcher stops looking for changes to the depth frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptiondepthframesourcewatcher_stopped.md b/windows.devices.perception/perceptiondepthframesourcewatcher_stopped.md index 6af0d7b0ad..7075bba3aa 100644 --- a/windows.devices.perception/perceptiondepthframesourcewatcher_stopped.md +++ b/windows.devices.perception/perceptiondepthframesourcewatcher_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stopped --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stopped ## -description Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of depth frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionDepthFrameSourceWatcher.Stopped + +## -description +Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of depth frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionframesourcepropertieschangedeventargs.md b/windows.devices.perception/perceptionframesourcepropertieschangedeventargs.md index eae731d40b..e9843cba1e 100644 --- a/windows.devices.perception/perceptionframesourcepropertieschangedeventargs.md +++ b/windows.devices.perception/perceptionframesourcepropertieschangedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs ## -description Contains information about an attempt to change properties on a frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs + +## -description +Contains information about an attempt to change properties on a frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_collectionchange.md b/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_collectionchange.md index 613ac1fbb7..37ede0131b 100644 --- a/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_collectionchange.md +++ b/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_collectionchange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.CollectionChange --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.CollectionChange ## -description Gets the type of change that occurred as a result of the property change request. ## -property-value The type of change that occurred as a result of the property change request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.CollectionChange +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.CollectionChange + +## -description +Gets the type of change that occurred as a result of the property change request. + +## -property-value +The type of change that occurred as a result of the property change request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_key.md b/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_key.md index 3ea58c7283..39e49509c2 100644 --- a/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_key.md +++ b/windows.devices.perception/perceptionframesourcepropertieschangedeventargs_key.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.Key --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.Key ## -description Gets a string key indicating the location of the change in the collection. ## -property-value A string key indicating the location of the change in the collection ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.Key +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionFrameSourcePropertiesChangedEventArgs.Key + +## -description +Gets a string key indicating the location of the change in the collection. + +## -property-value +A string key indicating the location of the change in the collection + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionframesourcepropertychangeresult.md b/windows.devices.perception/perceptionframesourcepropertychangeresult.md index 6e0d0e79e9..26a10efcbb 100644 --- a/windows.devices.perception/perceptionframesourcepropertychangeresult.md +++ b/windows.devices.perception/perceptionframesourcepropertychangeresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult ## -description Contains information about an attempted property change on a frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult + +## -description +Contains information about an attempted property change on a frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionframesourcepropertychangeresult_newvalue.md b/windows.devices.perception/perceptionframesourcepropertychangeresult_newvalue.md index 5fa5f50b0b..cd1229feac 100644 --- a/windows.devices.perception/perceptionframesourcepropertychangeresult_newvalue.md +++ b/windows.devices.perception/perceptionframesourcepropertychangeresult_newvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.NewValue --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.NewValue ## -description Gets a PerceptionFrameSourcePropertyChangeStatus indicating the status of the change request, including whether or not the change took effect. ## -property-value A PerceptionFrameSourcePropertyChangeStatus indicating the status of the change request, including whether or not the change took effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.NewValue +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.NewValue + +## -description +Gets a PerceptionFrameSourcePropertyChangeStatus indicating the status of the change request, including whether or not the change took effect. + +## -property-value +A PerceptionFrameSourcePropertyChangeStatus indicating the status of the change request, including whether or not the change took effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionframesourcepropertychangeresult_status.md b/windows.devices.perception/perceptionframesourcepropertychangeresult_status.md index ee1bc8393d..14302ed24f 100644 --- a/windows.devices.perception/perceptionframesourcepropertychangeresult_status.md +++ b/windows.devices.perception/perceptionframesourcepropertychangeresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.Status --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.Status ## -description Gets the value of the property after the change request has been processed. ## -property-value The value of the property after the change request has been processed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionFrameSourcePropertyChangeResult.Status + +## -description +Gets the value of the property after the change request has been processed. + +## -property-value +The value of the property after the change request has been processed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframe.md b/windows.devices.perception/perceptioninfraredframe.md index 371799e3bb..e2163d5241 100644 --- a/windows.devices.perception/perceptioninfraredframe.md +++ b/windows.devices.perception/perceptioninfraredframe.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrame --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrame ## -description Contains a Windows.Media.VideoFrame with the infrared frame data. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrame +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrame + +## -description +Contains a Windows.Media.VideoFrame with the infrared frame data. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptioninfraredframe_close_811482585.md b/windows.devices.perception/perceptioninfraredframe_close_811482585.md index 2dc830eba4..b071d3b203 100644 --- a/windows.devices.perception/perceptioninfraredframe_close_811482585.md +++ b/windows.devices.perception/perceptioninfraredframe_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrame.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrame.Close ## -description Releases system resources that are exposed by a Windows Runtime object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrame.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrame.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframe_videoframe.md b/windows.devices.perception/perceptioninfraredframe_videoframe.md index f356002e39..55710ee450 100644 --- a/windows.devices.perception/perceptioninfraredframe_videoframe.md +++ b/windows.devices.perception/perceptioninfraredframe_videoframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrame.VideoFrame --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrame.VideoFrame ## -description Gets a Windows.Media.VideoFrame with the infrared frame data. ## -property-value A Windows.Media.VideoFrame with the infrared frame data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrame.VideoFrame +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrame.VideoFrame + +## -description +Gets a Windows.Media.VideoFrame with the infrared frame data. + +## -property-value +A Windows.Media.VideoFrame with the infrared frame data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframearrivedeventargs.md b/windows.devices.perception/perceptioninfraredframearrivedeventargs.md index b4373e3111..ea4b04393c 100644 --- a/windows.devices.perception/perceptioninfraredframearrivedeventargs.md +++ b/windows.devices.perception/perceptioninfraredframearrivedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs ## -description Contains information about a infrared frame arrived event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs + +## -description +Contains information about a infrared frame arrived event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframearrivedeventargs_relativetime.md b/windows.devices.perception/perceptioninfraredframearrivedeventargs_relativetime.md index 226247f09e..5ebbd1631c 100644 --- a/windows.devices.perception/perceptioninfraredframearrivedeventargs_relativetime.md +++ b/windows.devices.perception/perceptioninfraredframearrivedeventargs_relativetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.RelativeTime --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.RelativeTime ## -description Gets the relative time of this frame. ## -property-value The relative time of this frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.RelativeTime +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.RelativeTime + +## -description +Gets the relative time of this frame. + +## -property-value +The relative time of this frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframearrivedeventargs_tryopenframe_1525544366.md b/windows.devices.perception/perceptioninfraredframearrivedeventargs_tryopenframe_1525544366.md index 702d316e0e..cf52482fb5 100644 --- a/windows.devices.perception/perceptioninfraredframearrivedeventargs_tryopenframe_1525544366.md +++ b/windows.devices.perception/perceptioninfraredframearrivedeventargs_tryopenframe_1525544366.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.TryOpenFrame --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.TryOpenFrame ## -description Attempts to open the infrared frame that has arrived. ## -returns If the attempt is successful, this method returns the newly-arrived infrared frame. If the attempt is unsuccessful, this value is unchanged. ## -remarks Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.TryOpenFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameArrivedEventArgs.TryOpenFrame + +## -description +Attempts to open the infrared frame that has arrived. + +## -returns +If the attempt is successful, this method returns the newly-arrived infrared frame. If the attempt is unsuccessful, this value is unchanged. + +## -remarks +Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail. + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframereader.md b/windows.devices.perception/perceptioninfraredframereader.md index 9ebeea3c63..34f80130e2 100644 --- a/windows.devices.perception/perceptioninfraredframereader.md +++ b/windows.devices.perception/perceptioninfraredframereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameReader --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrameReader ## -description Reads infrared frames from a infrared frame source. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameReader +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameReader + +## -description +Reads infrared frames from a infrared frame source. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.perception/perceptioninfraredframereader_close_811482585.md b/windows.devices.perception/perceptioninfraredframereader_close_811482585.md index 576b7e6919..6f76d80bab 100644 --- a/windows.devices.perception/perceptioninfraredframereader_close_811482585.md +++ b/windows.devices.perception/perceptioninfraredframereader_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameReader.Close --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameReader.Close ## -description Releases system resources that are exposed by a Windows Runtime object ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameReader.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameReader.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframereader_framearrived.md b/windows.devices.perception/perceptioninfraredframereader_framearrived.md index c37020a7e1..0c10e9fa6e 100644 --- a/windows.devices.perception/perceptioninfraredframereader_framearrived.md +++ b/windows.devices.perception/perceptioninfraredframereader_framearrived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameReader.FrameArrived --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameReader.FrameArrived ## -description Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the infrared frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameReader.FrameArrived +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameReader.FrameArrived + +## -description +Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the infrared frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframereader_ispaused.md b/windows.devices.perception/perceptioninfraredframereader_ispaused.md index 945ef417f4..188f0a15dd 100644 --- a/windows.devices.perception/perceptioninfraredframereader_ispaused.md +++ b/windows.devices.perception/perceptioninfraredframereader_ispaused.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameReader.IsPaused --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameReader.IsPaused ## -description Gets a boolean value indicating whether or not this reader is paused. ## -property-value A boolean value indicating whether or not this reader is paused. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameReader.IsPaused +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameReader.IsPaused + +## -description +Gets a boolean value indicating whether or not this reader is paused. + +## -property-value +A boolean value indicating whether or not this reader is paused. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframereader_source.md b/windows.devices.perception/perceptioninfraredframereader_source.md index de43e43797..9d40b8ecff 100644 --- a/windows.devices.perception/perceptioninfraredframereader_source.md +++ b/windows.devices.perception/perceptioninfraredframereader_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameReader.Source --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameReader.Source ## -description Gets the infrared frame source this reader gets frames from. ## -property-value The infrared frame source this reader gets frames from. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameReader.Source +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameReader.Source + +## -description +Gets the infrared frame source this reader gets frames from. + +## -property-value +The infrared frame source this reader gets frames from. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframereader_tryreadlatestframe_1676630157.md b/windows.devices.perception/perceptioninfraredframereader_tryreadlatestframe_1676630157.md index afb0965bca..62ddce5b0e 100644 --- a/windows.devices.perception/perceptioninfraredframereader_tryreadlatestframe_1676630157.md +++ b/windows.devices.perception/perceptioninfraredframereader_tryreadlatestframe_1676630157.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameReader.TryReadLatestFrame --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameReader.TryReadLatestFrame ## -description Attempts to read the most recent frame that is available to this infrared frame reader. ## -returns If the attempt was successful, this method returns the most recent frame that is available to this infrared frame reader. If the attempt was not successful, this method returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameReader.TryReadLatestFrame +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameReader.TryReadLatestFrame + +## -description +Attempts to read the most recent frame that is available to this infrared frame reader. + +## -returns +If the attempt was successful, this method returns the most recent frame that is available to this infrared frame reader. If the attempt was not successful, this method returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource.md b/windows.devices.perception/perceptioninfraredframesource.md index 0fbce8ec28..f12a56c96f 100644 --- a/windows.devices.perception/perceptioninfraredframesource.md +++ b/windows.devices.perception/perceptioninfraredframesource.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSource --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource ## -description A frame source that provides infrared frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSource +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource + +## -description +A frame source that provides infrared frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_acquirecontrolsession_73364641.md b/windows.devices.perception/perceptioninfraredframesource_acquirecontrolsession_73364641.md index 3ecd69113b..8211542cc2 100644 --- a/windows.devices.perception/perceptioninfraredframesource_acquirecontrolsession_73364641.md +++ b/windows.devices.perception/perceptioninfraredframesource_acquirecontrolsession_73364641.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.AcquireControlSession --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.AcquireControlSession ## -description Attempts to acquire Controller Mode on the infrared frame source. ## -returns If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the infrared frame source. Otherwise, this returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.AcquireControlSession +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.AcquireControlSession + +## -description +Attempts to acquire Controller Mode on the infrared frame source. + +## -returns +If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the infrared frame source. Otherwise, this returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_active.md b/windows.devices.perception/perceptioninfraredframesource_active.md index 55bee32e27..e9b02e9b26 100644 --- a/windows.devices.perception/perceptioninfraredframesource_active.md +++ b/windows.devices.perception/perceptioninfraredframesource_active.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Active --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.Active ## -description Gets a boolean value indicating whether or not the source is active. ## -property-value A boolean value indicating whether or not the source is active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Active +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.Active + +## -description +Gets a boolean value indicating whether or not the source is active. + +## -property-value +A boolean value indicating whether or not the source is active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_activechanged.md b/windows.devices.perception/perceptioninfraredframesource_activechanged.md index 9dbd84e685..4f04ef9f22 100644 --- a/windows.devices.perception/perceptioninfraredframesource_activechanged.md +++ b/windows.devices.perception/perceptioninfraredframesource_activechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.ActiveChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.ActiveChanged ## -description Subscribes to the ActiveChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.ActiveChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.ActiveChanged + +## -description +Subscribes to the ActiveChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_available.md b/windows.devices.perception/perceptioninfraredframesource_available.md index 5d3fac14af..33a8512080 100644 --- a/windows.devices.perception/perceptioninfraredframesource_available.md +++ b/windows.devices.perception/perceptioninfraredframesource_available.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Available --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.Available ## -description Gets a boolean value indicating whether or not the source is available. ## -property-value A boolean value indicating whether or not the source is available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Available +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.Available + +## -description +Gets a boolean value indicating whether or not the source is available. + +## -property-value +A boolean value indicating whether or not the source is available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_availablechanged.md b/windows.devices.perception/perceptioninfraredframesource_availablechanged.md index 23d64ba720..01ebd5d58e 100644 --- a/windows.devices.perception/perceptioninfraredframesource_availablechanged.md +++ b/windows.devices.perception/perceptioninfraredframesource_availablechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableChanged ## -description Subscribes to the AvailableChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableChanged + +## -description +Subscribes to the AvailableChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_availablevideoprofiles.md b/windows.devices.perception/perceptioninfraredframesource_availablevideoprofiles.md index c46d999988..ef8598980b 100644 --- a/windows.devices.perception/perceptioninfraredframesource_availablevideoprofiles.md +++ b/windows.devices.perception/perceptioninfraredframesource_availablevideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableVideoProfiles ## -description Gets a read-only collection of video profiles that are currently available from the infrared frame source. ## -property-value A read-only collection of video profiles that are currently available from the infrared frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.AvailableVideoProfiles + +## -description +Gets a read-only collection of video profiles that are currently available from the infrared frame source. + +## -property-value +A read-only collection of video profiles that are currently available from the infrared frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_cameraintrinsics.md b/windows.devices.perception/perceptioninfraredframesource_cameraintrinsics.md index ee362f6323..d4d3873ce5 100644 --- a/windows.devices.perception/perceptioninfraredframesource_cameraintrinsics.md +++ b/windows.devices.perception/perceptioninfraredframesource_cameraintrinsics.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsics --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsics ## -description Gets a CameraIntrinsics value specifying the intrinsic properties of the infrared frame source camera device. ## -property-value A CameraIntrinsics value specifying the intrinsic properties of the infrared frame source camera device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsics +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsics + +## -description +Gets a CameraIntrinsics value specifying the intrinsic properties of the infrared frame source camera device. + +## -property-value +A CameraIntrinsics value specifying the intrinsic properties of the infrared frame source camera device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_cameraintrinsicschanged.md b/windows.devices.perception/perceptioninfraredframesource_cameraintrinsicschanged.md index e8bebb9a86..f68d28eb91 100644 --- a/windows.devices.perception/perceptioninfraredframesource_cameraintrinsicschanged.md +++ b/windows.devices.perception/perceptioninfraredframesource_cameraintrinsicschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsicsChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsicsChanged ## -description Subscribes to the CameraIntrinsicsChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsicsChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.CameraIntrinsicsChanged + +## -description +Subscribes to the CameraIntrinsicsChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_cancontrolindependentlyfrom_1911149790.md b/windows.devices.perception/perceptioninfraredframesource_cancontrolindependentlyfrom_1911149790.md index 8ba2e1a7e3..07d0e024c5 100644 --- a/windows.devices.perception/perceptioninfraredframesource_cancontrolindependentlyfrom_1911149790.md +++ b/windows.devices.perception/perceptioninfraredframesource_cancontrolindependentlyfrom_1911149790.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.CanControlIndependentlyFrom(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.CanControlIndependentlyFrom ## -description Retrieves a boolean value indicating whether or not the infrared frame source can be controlled separately from another frame source. ## -parameters ### -param targetId A string representing the unique ID of the other frame source. ## -returns True if the two sources can be controlled independently of one another, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.CanControlIndependentlyFrom(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.CanControlIndependentlyFrom + +## -description +Retrieves a boolean value indicating whether or not the infrared frame source can be controlled separately from another frame source. + +## -parameters +### -param targetId +A string representing the unique ID of the other frame source. + +## -returns +True if the two sources can be controlled independently of one another, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_createwatcher_1506431823.md b/windows.devices.perception/perceptioninfraredframesource_createwatcher_1506431823.md index 41da321bca..a449ac792d 100644 --- a/windows.devices.perception/perceptioninfraredframesource_createwatcher_1506431823.md +++ b/windows.devices.perception/perceptioninfraredframesource_createwatcher_1506431823.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.CreateWatcher --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.CreateWatcher ## -description Creates a new infrared frame source watcher. ## -returns A new infrared frame source watcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.CreateWatcher +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.CreateWatcher + +## -description +Creates a new infrared frame source watcher. + +## -returns +A new infrared frame source watcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_deviceid.md b/windows.devices.perception/perceptioninfraredframesource_deviceid.md index 22b4f04352..c7c4fd6c68 100644 --- a/windows.devices.perception/perceptioninfraredframesource_deviceid.md +++ b/windows.devices.perception/perceptioninfraredframesource_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceId --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceId ## -description Gets a string value that identifies the device on the system. ## -property-value The identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceId + +## -description +Gets a string value that identifies the device on the system. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_devicekind.md b/windows.devices.perception/perceptioninfraredframesource_devicekind.md index 5649bc688d..bb85ac94e1 100644 --- a/windows.devices.perception/perceptioninfraredframesource_devicekind.md +++ b/windows.devices.perception/perceptioninfraredframesource_devicekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceKind --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceKind ## -description Gets a string value indicating the kind of physical device that generates the infrared frames. ## -property-value A string value indicating the kind of physical device that generates the infrared frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceKind +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.DeviceKind + +## -description +Gets a string value indicating the kind of physical device that generates the infrared frames. + +## -property-value +A string value indicating the kind of physical device that generates the infrared frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_displayname.md b/windows.devices.perception/perceptioninfraredframesource_displayname.md index 01bac5a69c..e256dbd1eb 100644 --- a/windows.devices.perception/perceptioninfraredframesource_displayname.md +++ b/windows.devices.perception/perceptioninfraredframesource_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.DisplayName --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.DisplayName ## -description Gets a string value indicating the display name of the infrared frame source. ## -property-value A string value indicating the display name of the infrared frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.DisplayName +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.DisplayName + +## -description +Gets a string value indicating the display name of the infrared frame source. + +## -property-value +A string value indicating the display name of the infrared frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_findallasync_326280522.md b/windows.devices.perception/perceptioninfraredframesource_findallasync_326280522.md index d28af79b56..e926d83733 100644 --- a/windows.devices.perception/perceptioninfraredframesource_findallasync_326280522.md +++ b/windows.devices.perception/perceptioninfraredframesource_findallasync_326280522.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.FindAllAsync --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.FindAllAsync ## -description Finds all infrared frame sources. ## -returns When the method completes, it asynchronously returns a list of infrared frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.FindAllAsync + +## -description +Finds all infrared frame sources. + +## -returns +When the method completes, it asynchronously returns a list of infrared frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_fromidasync_1322863552.md b/windows.devices.perception/perceptioninfraredframesource_fromidasync_1322863552.md index 531578972f..4cccb7ea15 100644 --- a/windows.devices.perception/perceptioninfraredframesource_fromidasync_1322863552.md +++ b/windows.devices.perception/perceptioninfraredframesource_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.FromIdAsync ## -description Finds an infrared frame source by looking up its unique ID. ## -parameters ### -param id The unique ID of the infrared frame source. ## -returns When the method completes, it asynchronously returns an infrared frame source if one exists with the specified ID. Otherwise, this method asynchronously returns nullptr. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.FromIdAsync + +## -description +Finds an infrared frame source by looking up its unique ID. + +## -parameters +### -param id +The unique ID of the infrared frame source. + +## -returns +When the method completes, it asynchronously returns an infrared frame source if one exists with the specified ID. Otherwise, this method asynchronously returns nullptr. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_id.md b/windows.devices.perception/perceptioninfraredframesource_id.md index 716f1f996e..93febd4bca 100644 --- a/windows.devices.perception/perceptioninfraredframesource_id.md +++ b/windows.devices.perception/perceptioninfraredframesource_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Id --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.Id ## -description Gets a string value indicating the unique ID of the infrared frame source. ## -property-value A string value indicating the unique ID of the infrared frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.Id + +## -description +Gets a string value indicating the unique ID of the infrared frame source. + +## -property-value +A string value indicating the unique ID of the infrared frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_iscontrolled.md b/windows.devices.perception/perceptioninfraredframesource_iscontrolled.md index c02d00da1d..a25df40770 100644 --- a/windows.devices.perception/perceptioninfraredframesource_iscontrolled.md +++ b/windows.devices.perception/perceptioninfraredframesource_iscontrolled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.IsControlled --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.IsControlled ## -description Gets a boolean value indicating whether or not the source is the subject of controller mode. ## -property-value A boolean value indicating whether or not the source is the subject of controller mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.IsControlled +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.IsControlled + +## -description +Gets a boolean value indicating whether or not the source is the subject of controller mode. + +## -property-value +A boolean value indicating whether or not the source is the subject of controller mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_iscorrelatedwith_25122365.md b/windows.devices.perception/perceptioninfraredframesource_iscorrelatedwith_25122365.md index 49a36968ce..47f406eed1 100644 --- a/windows.devices.perception/perceptioninfraredframesource_iscorrelatedwith_25122365.md +++ b/windows.devices.perception/perceptioninfraredframesource_iscorrelatedwith_25122365.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.IsCorrelatedWith(System.String) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.IsCorrelatedWith ## -description Checks whether or not the infrared frame source is correlated with the target entity. ## -parameters ### -param targetId The unique ID of the target entity. ## -returns True if a correlation exists, otherwise false. If the result is true, a transform matrix can be retrieved to change coordinate basis from this infrared frame source to the entity, or vice versa. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.IsCorrelatedWith(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.IsCorrelatedWith + +## -description +Checks whether or not the infrared frame source is correlated with the target entity. + +## -parameters +### -param targetId +The unique ID of the target entity. + +## -returns +True if a correlation exists, otherwise false. If the result is true, a transform matrix can be retrieved to change coordinate basis from this infrared frame source to the entity, or vice versa. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_openreader_1109726428.md b/windows.devices.perception/perceptioninfraredframesource_openreader_1109726428.md index 54710efd3f..1be5eb3b73 100644 --- a/windows.devices.perception/perceptioninfraredframesource_openreader_1109726428.md +++ b/windows.devices.perception/perceptioninfraredframesource_openreader_1109726428.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.OpenReader --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.OpenReader ## -description Gets a frame reader that reads frames from this infrared frame source. ## -returns A frame reader that reads frames from this infrared frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.OpenReader +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.OpenReader + +## -description +Gets a frame reader that reads frames from this infrared frame source. + +## -returns +A frame reader that reads frames from this infrared frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_properties.md b/windows.devices.perception/perceptioninfraredframesource_properties.md index e077e526bf..947dc20398 100644 --- a/windows.devices.perception/perceptioninfraredframesource_properties.md +++ b/windows.devices.perception/perceptioninfraredframesource_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Properties --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.Properties ## -description Gets a read-only collection of frame source properties. ## -property-value A read-only collection of frame source properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.Properties + +## -description +Gets a read-only collection of frame source properties. + +## -property-value +A read-only collection of frame source properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_propertieschanged.md b/windows.devices.perception/perceptioninfraredframesource_propertieschanged.md index 7541ad60ec..e9996228d6 100644 --- a/windows.devices.perception/perceptioninfraredframesource_propertieschanged.md +++ b/windows.devices.perception/perceptioninfraredframesource_propertieschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.PropertiesChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.PropertiesChanged ## -description Subscribes to the PropertiesChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.PropertiesChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.PropertiesChanged + +## -description +Subscribes to the PropertiesChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_requestaccessasync_380675631.md b/windows.devices.perception/perceptioninfraredframesource_requestaccessasync_380675631.md index 1f486bfd59..0461c8a2b5 100644 --- a/windows.devices.perception/perceptioninfraredframesource_requestaccessasync_380675631.md +++ b/windows.devices.perception/perceptioninfraredframesource_requestaccessasync_380675631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.RequestAccessAsync ## -description Requests access to use infrared frame sources. ## -returns When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.RequestAccessAsync + +## -description +Requests access to use infrared frame sources. + +## -returns +When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_supportedvideoprofiles.md b/windows.devices.perception/perceptioninfraredframesource_supportedvideoprofiles.md index 2b040b1dc1..e4b5fa3fce 100644 --- a/windows.devices.perception/perceptioninfraredframesource_supportedvideoprofiles.md +++ b/windows.devices.perception/perceptioninfraredframesource_supportedvideoprofiles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.SupportedVideoProfiles --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.SupportedVideoProfiles ## -description Gets a read-only collection of video profiles that are supported by the infrared frame source. ## -property-value A read-only collection of video profiles that are supported by the infrared frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.SupportedVideoProfiles +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.SupportedVideoProfiles + +## -description +Gets a read-only collection of video profiles that are supported by the infrared frame source. + +## -property-value +A read-only collection of video profiles that are supported by the infrared frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md b/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md index 50e1e18a3e..19e3e35619 100644 --- a/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md +++ b/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcameraintrinsicsasync_1720979259.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync(Windows.Devices.Perception.PerceptionDepthFrameSource) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync ## -description Attempts to get the intrinsic properties of the depth camera that is correlated with this infrared source. ## -parameters ### -param target The depth frame source to try to get intrinsic properties of. ## -returns If the attempt is successful, this returns a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync(Windows.Devices.Perception.PerceptionDepthFrameSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCameraIntrinsicsAsync + +## -description +Attempts to get the intrinsic properties of the depth camera that is correlated with this infrared source. + +## -parameters +### -param target +The depth frame source to try to get intrinsic properties of. + +## -returns +If the attempt is successful, this returns a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md b/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md index af57ad10ca..d54ff29f46 100644 --- a/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md +++ b/windows.devices.perception/perceptioninfraredframesource_trygetdepthcorrelatedcoordinatemapperasync_87243846.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync(System.String,Windows.Devices.Perception.PerceptionDepthFrameSource) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync ## -description Attempts to get a coordinate mapper that maps from infrared frame image space to depth frame space. ## -parameters ### -param targetId The unique ID of the depth frame source to try to map to. ### -param depthFrameSourceToMapWith The depth frame source to try to map to. This should be in a correlation group with the infrared frame source. ## -returns If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync(System.String,Windows.Devices.Perception.PerceptionDepthFrameSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetDepthCorrelatedCoordinateMapperAsync + +## -description +Attempts to get a coordinate mapper that maps from infrared frame image space to depth frame space. + +## -parameters +### -param targetId +The unique ID of the depth frame source to try to map to. + +### -param depthFrameSourceToMapWith +The depth frame source to try to map to. This should be in a correlation group with the infrared frame source. + +## -returns +If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_trygettransformto_253749040.md b/windows.devices.perception/perceptioninfraredframesource_trygettransformto_253749040.md index 76872bfb09..bd7507f10e 100644 --- a/windows.devices.perception/perceptioninfraredframesource_trygettransformto_253749040.md +++ b/windows.devices.perception/perceptioninfraredframesource_trygettransformto_253749040.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetTransformTo(System.String,Windows.Foundation.Numerics.Matrix4x4@) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetTransformTo ## -description Gets the transform from the infrared frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified. ## -parameters ### -param targetId The unique ID of the target entity. ### -param result If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the infrared frame source coordinate system to the target entity coordinate system. ## -returns True if a correlation exists, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetTransformTo(System.String,Windows.Foundation.Numerics.Matrix4x4@) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.TryGetTransformTo + +## -description +Gets the transform from the infrared frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified. + +## -parameters +### -param targetId +The unique ID of the target entity. + +### -param result +If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the infrared frame source coordinate system to the target entity coordinate system. + +## -returns +True if a correlation exists, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_trysetvideoprofileasync_998537711.md b/windows.devices.perception/perceptioninfraredframesource_trysetvideoprofileasync_998537711.md index 0597f87b94..ca8c0efd49 100644 --- a/windows.devices.perception/perceptioninfraredframesource_trysetvideoprofileasync_998537711.md +++ b/windows.devices.perception/perceptioninfraredframesource_trysetvideoprofileasync_998537711.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TrySetVideoProfileAsync(Windows.Devices.Perception.PerceptionControlSession,Windows.Devices.Perception.PerceptionVideoProfile) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.TrySetVideoProfileAsync ## -description Attempts to set a video profile on this infrared frame source. Requires an active Controller Mode control session on this frame source. ## -parameters ### -param controlSession A PerceptionControlSession representing active control of this frame source. ### -param profile The video profile to set. ## -returns This method returns an PerceptionFrameSourcePropertyChangeResult object asynchonously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a success result. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSource.TrySetVideoProfileAsync(Windows.Devices.Perception.PerceptionControlSession,Windows.Devices.Perception.PerceptionVideoProfile) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.TrySetVideoProfileAsync + +## -description +Attempts to set a video profile on this infrared frame source. Requires an active Controller Mode control session on this frame source. + +## -parameters +### -param controlSession +A PerceptionControlSession representing active control of this frame source. + +### -param profile +The video profile to set. + +## -returns +This method returns an PerceptionFrameSourcePropertyChangeResult object asynchonously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a success result. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_videoprofile.md b/windows.devices.perception/perceptioninfraredframesource_videoprofile.md index e641f3559a..67ffe4e8f0 100644 --- a/windows.devices.perception/perceptioninfraredframesource_videoprofile.md +++ b/windows.devices.perception/perceptioninfraredframesource_videoprofile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfile --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfile ## -description Gets a PerceptionVideoProfile object indicating the current video profile. ## -property-value A PerceptionVideoProfile object indicating the current video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfile +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfile + +## -description +Gets a PerceptionVideoProfile object indicating the current video profile. + +## -property-value +A PerceptionVideoProfile object indicating the current video profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesource_videoprofilechanged.md b/windows.devices.perception/perceptioninfraredframesource_videoprofilechanged.md index fcb219d351..2a468e12a1 100644 --- a/windows.devices.perception/perceptioninfraredframesource_videoprofilechanged.md +++ b/windows.devices.perception/perceptioninfraredframesource_videoprofilechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfileChanged --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfileChanged ## -description Subscribes to the VideoProfileChanged event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfileChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSource.VideoProfileChanged + +## -description +Subscribes to the VideoProfileChanged event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourceaddedeventargs.md b/windows.devices.perception/perceptioninfraredframesourceaddedeventargs.md index 814f9e3a03..dc2ac0f40e 100644 --- a/windows.devices.perception/perceptioninfraredframesourceaddedeventargs.md +++ b/windows.devices.perception/perceptioninfraredframesourceaddedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs ## -description Event data for infrared frame source added events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs + +## -description +Event data for infrared frame source added events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourceaddedeventargs_framesource.md b/windows.devices.perception/perceptioninfraredframesourceaddedeventargs_framesource.md index 6e93a2d160..3036e28f0e 100644 --- a/windows.devices.perception/perceptioninfraredframesourceaddedeventargs_framesource.md +++ b/windows.devices.perception/perceptioninfraredframesourceaddedeventargs_framesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs.FrameSource --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs.FrameSource ## -description Gets the infrared frame source that was added. ## -property-value The infrared frame source that was added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs.FrameSource +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceAddedEventArgs.FrameSource + +## -description +Gets the infrared frame source that was added. + +## -property-value +The infrared frame source that was added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourceremovedeventargs.md b/windows.devices.perception/perceptioninfraredframesourceremovedeventargs.md index bbb9845598..2b9d110d64 100644 --- a/windows.devices.perception/perceptioninfraredframesourceremovedeventargs.md +++ b/windows.devices.perception/perceptioninfraredframesourceremovedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs ## -description Event data for infrared frame source removed events. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs + +## -description +Event data for infrared frame source removed events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourceremovedeventargs_framesource.md b/windows.devices.perception/perceptioninfraredframesourceremovedeventargs_framesource.md index 2dd0e7aa26..260e2c48a9 100644 --- a/windows.devices.perception/perceptioninfraredframesourceremovedeventargs_framesource.md +++ b/windows.devices.perception/perceptioninfraredframesourceremovedeventargs_framesource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs.FrameSource --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs.FrameSource ## -description Gets the infrared frame source that was removed. ## -property-value The infrared frame source that was removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs.FrameSource +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceRemovedEventArgs.FrameSource + +## -description +Gets the infrared frame source that was removed. + +## -property-value +The infrared frame source that was removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher.md b/windows.devices.perception/perceptioninfraredframesourcewatcher.md index 2a1465f93b..95cf31304c 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher ## -description Monitors changes to the list of infrared frame sources, and provides notifications when the list changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher + +## -description +Monitors changes to the list of infrared frame sources, and provides notifications when the list changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_enumerationcompleted.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_enumerationcompleted.md index 4b4949f515..d9f9f93639 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_enumerationcompleted.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_enumerationcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.EnumerationCompleted --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.EnumerationCompleted ## -description Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known infrared frame sources is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.EnumerationCompleted + +## -description +Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known infrared frame sources is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceadded.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceadded.md index 18d99c7654..8775b3d039 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceadded.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceadded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceAdded --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceAdded ## -description Subscribes to the SourceAdded event. ## -remarks When the Start method is called, this event is fired for every infrared frame source already known to the system, then the EnumerationCompleted event is fired. New infrared frame sources that are subsequently added will trigger additional SourceAdded events. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceAdded +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceAdded + +## -description +Subscribes to the SourceAdded event. + +## -remarks +When the Start method is called, this event is fired for every infrared frame source already known to the system, then the EnumerationCompleted event is fired. New infrared frame sources that are subsequently added will trigger additional SourceAdded events. + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceremoved.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceremoved.md index 3aeeb9dc12..ec539de411 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceremoved.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_sourceremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceRemoved --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceRemoved ## -description Subscribes to the SourceRemoved event. This event is fired once for every infrared frame source that is removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceRemoved +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.SourceRemoved + +## -description +Subscribes to the SourceRemoved event. This event is fired once for every infrared frame source that is removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_start_1587696324.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_start_1587696324.md index 557bad2c59..00e7a01fc1 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_start_1587696324.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Start --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Start ## -description When this method is called, the infrared frame source watcher enumerates any existing infrared frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The infrared frame source then starts watching for new infrared frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Start + +## -description +When this method is called, the infrared frame source watcher enumerates any existing infrared frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The infrared frame source then starts watching for new infrared frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_status.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_status.md index 12bb610baa..af27a8e793 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_status.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Status --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Status ## -description Gets the operational status of the infrared frame source watcher. ## -property-value The operational status of the infrared frame source watcher. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Status + +## -description +Gets the operational status of the infrared frame source watcher. + +## -property-value +The operational status of the infrared frame source watcher. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_stop_1201535524.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_stop_1201535524.md index 10639dee9f..6ae58129ef 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_stop_1201535524.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stop --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stop ## -description When this method is called, the infrared frame source watcher stops looking for changes to the infrared frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stop + +## -description +When this method is called, the infrared frame source watcher stops looking for changes to the infrared frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptioninfraredframesourcewatcher_stopped.md b/windows.devices.perception/perceptioninfraredframesourcewatcher_stopped.md index e2c0f0a16e..54f05eeca5 100644 --- a/windows.devices.perception/perceptioninfraredframesourcewatcher_stopped.md +++ b/windows.devices.perception/perceptioninfraredframesourcewatcher_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stopped --api-type: winrt event ---- # Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stopped ## -description Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listeningfor changes to the list of infrared frame sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Devices.Perception.PerceptionInfraredFrameSourceWatcher.Stopped + +## -description +Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listeningfor changes to the list of infrared frame sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile.md b/windows.devices.perception/perceptionvideoprofile.md index 312144943a..bbfdfe4e90 100644 --- a/windows.devices.perception/perceptionvideoprofile.md +++ b/windows.devices.perception/perceptionvideoprofile.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Perception.PerceptionVideoProfile --api-type: winrt class ---- # Windows.Devices.Perception.PerceptionVideoProfile ## -description Represents a Windows.Devices.Perception video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Perception.PerceptionVideoProfile +-api-type: winrt class +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile + +## -description +Represents a Windows.Devices.Perception video profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile_bitmapalphamode.md b/windows.devices.perception/perceptionvideoprofile_bitmapalphamode.md index 8ec51cd70e..0eb7b075a9 100644 --- a/windows.devices.perception/perceptionvideoprofile_bitmapalphamode.md +++ b/windows.devices.perception/perceptionvideoprofile_bitmapalphamode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.BitmapAlphaMode --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionVideoProfile.BitmapAlphaMode ## -description Gets the bitmap alpha mode. ## -property-value A BitmapAlphaMode enumeration value indicating the bitmap alpha mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.BitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile.BitmapAlphaMode + +## -description +Gets the bitmap alpha mode. + +## -property-value +A BitmapAlphaMode enumeration value indicating the bitmap alpha mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile_bitmappixelformat.md b/windows.devices.perception/perceptionvideoprofile_bitmappixelformat.md index 0db418dca3..3cc2ae12fd 100644 --- a/windows.devices.perception/perceptionvideoprofile_bitmappixelformat.md +++ b/windows.devices.perception/perceptionvideoprofile_bitmappixelformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.BitmapPixelFormat --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionVideoProfile.BitmapPixelFormat ## -description Gets the bitmap pixel format. ## -property-value A BitmapPixelFormat enumeration value indicating the bitmap pixel format. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.BitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile.BitmapPixelFormat + +## -description +Gets the bitmap pixel format. + +## -property-value +A BitmapPixelFormat enumeration value indicating the bitmap pixel format. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile_frameduration.md b/windows.devices.perception/perceptionvideoprofile_frameduration.md index e30ad4b4c3..a5c6c3bbb8 100644 --- a/windows.devices.perception/perceptionvideoprofile_frameduration.md +++ b/windows.devices.perception/perceptionvideoprofile_frameduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.FrameDuration --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionVideoProfile.FrameDuration ## -description Gets the time duration of each frame. ## -property-value A Windows.Foundation.TimeSpan indicating the time duration of each video frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.FrameDuration +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile.FrameDuration + +## -description +Gets the time duration of each frame. + +## -property-value +A Windows.Foundation.TimeSpan indicating the time duration of each video frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile_height.md b/windows.devices.perception/perceptionvideoprofile_height.md index 5449aaa024..c96f596b2b 100644 --- a/windows.devices.perception/perceptionvideoprofile_height.md +++ b/windows.devices.perception/perceptionvideoprofile_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.Height --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionVideoProfile.Height ## -description Gets the frame height, in pixels. ## -property-value The frame height, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.Height +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile.Height + +## -description +Gets the frame height, in pixels. + +## -property-value +The frame height, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile_isequal_485828652.md b/windows.devices.perception/perceptionvideoprofile_isequal_485828652.md index 66d7ce8e4d..2c69a99927 100644 --- a/windows.devices.perception/perceptionvideoprofile_isequal_485828652.md +++ b/windows.devices.perception/perceptionvideoprofile_isequal_485828652.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Perception.PerceptionVideoProfile.IsEqual(Windows.Devices.Perception.PerceptionVideoProfile) --api-type: winrt method ---- # Windows.Devices.Perception.PerceptionVideoProfile.IsEqual ## -description A comparison function used to determine if two IPerceptionVideoProfile objects are equivalent. ## -parameters ### -param other The IPerceptionVideoProfile object to compare to this one. ## -returns True if the two video profiles are equivalent, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Perception.PerceptionVideoProfile.IsEqual(Windows.Devices.Perception.PerceptionVideoProfile) +-api-type: winrt method +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile.IsEqual + +## -description +A comparison function used to determine if two IPerceptionVideoProfile objects are equivalent. + +## -parameters +### -param other +The IPerceptionVideoProfile object to compare to this one. + +## -returns +True if the two video profiles are equivalent, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.perception/perceptionvideoprofile_width.md b/windows.devices.perception/perceptionvideoprofile_width.md index 98f265eab4..15b80dfe6f 100644 --- a/windows.devices.perception/perceptionvideoprofile_width.md +++ b/windows.devices.perception/perceptionvideoprofile_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.Width --api-type: winrt property ---- # Windows.Devices.Perception.PerceptionVideoProfile.Width ## -description Gets the frame width, in pixels. ## -property-value The frame width, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Perception.PerceptionVideoProfile.Width +-api-type: winrt property +--- + + + +# Windows.Devices.Perception.PerceptionVideoProfile.Width + +## -description +Gets the frame width, in pixels. + +## -property-value +The frame width, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner.md b/windows.devices.pointofservice/barcodescanner.md index 6bf9162570..3637ed989a 100644 --- a/windows.devices.pointofservice/barcodescanner.md +++ b/windows.devices.pointofservice/barcodescanner.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScanner --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScanner ## -description Represents the barcode scanner device. ## -remarks This object is created when [GetDefaultAsync](barcodescanner_getdefaultasync.md) or [FromIdAsync](barcodescanner_fromidasync.md) method completes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScanner +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner + +## -description +Represents the barcode scanner device. + +## -remarks +This object is created when [GetDefaultAsync](barcodescanner_getdefaultasync.md) or [FromIdAsync](barcodescanner_fromidasync.md) method completes. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_capabilities.md b/windows.devices.pointofservice/barcodescanner_capabilities.md index c2ebcc383c..34d5bf2900 100644 --- a/windows.devices.pointofservice/barcodescanner_capabilities.md +++ b/windows.devices.pointofservice/barcodescanner_capabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScanner.Capabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScanner.Capabilities ## -description Gets the capabilities of the specified barcode scanner. ## -property-value The capabilities of the barcode scanner. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScanner.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.Capabilities + +## -description +Gets the capabilities of the specified barcode scanner. + +## -property-value +The capabilities of the barcode scanner. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_checkhealthasync_1543183748.md b/windows.devices.pointofservice/barcodescanner_checkhealthasync_1543183748.md index f505e8d6b3..4e474e8096 100644 --- a/windows.devices.pointofservice/barcodescanner_checkhealthasync_1543183748.md +++ b/windows.devices.pointofservice/barcodescanner_checkhealthasync_1543183748.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.CheckHealthAsync ## -description Tests the state of the barcode scanner. ## -parameters ### -param level The specified health check level. ## -returns A text description of the test result. Returns an error if the specified check level is not supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.CheckHealthAsync + +## -description +Tests the state of the barcode scanner. + +## -parameters +### -param level +The specified health check level. + +## -returns +A text description of the test result. Returns an error if the specified check level is not supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md b/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md index 802f2e10d6..8b289652a4 100644 --- a/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md +++ b/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync - -## -description -Attempts to get an exclusive access to the barcode scanner. - -## -returns -When the method completes, it returns a [ClaimedBarcodeScanner](claimedbarcodescanner.md). - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cpp[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetClaimBarcodeScanner)][!code-cs[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetClaimBarcodeScanner)] - -[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] - -## -see-also -[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync + +## -description +Attempts to get an exclusive access to the barcode scanner. + +## -returns +When the method completes, it returns a [ClaimedBarcodeScanner](claimedbarcodescanner.md). + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cpp[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetClaimBarcodeScanner)][!code-cs[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetClaimBarcodeScanner)] + +[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] + +## -see-also +[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) diff --git a/windows.devices.pointofservice/barcodescanner_deviceid.md b/windows.devices.pointofservice/barcodescanner_deviceid.md index 5f92b6a604..7b3a54048c 100644 --- a/windows.devices.pointofservice/barcodescanner_deviceid.md +++ b/windows.devices.pointofservice/barcodescanner_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScanner.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScanner.DeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the barcode scanner. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the barcode scanner. ## -remarks ## -examples ## -see-also [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScanner.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.DeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the barcode scanner. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the barcode scanner. + +## -remarks + +## -examples + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md b/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md index d2b27e4369..2026dae556 100644 --- a/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md +++ b/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.FromIdAsync ## -description Creates [BarcodeScanner](barcodescanner.md) object from the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). ## -parameters ### -param deviceId The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific barcode scanner, which can be retrieved from the [DeviceId](barcodescanner_deviceid.md) property. ## -returns The barcode scanner specified by the unique device identifier. Returns a null object in the following cases: + The specific device is not found. + Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. ## -remarks ## -examples ## -see-also [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.FromIdAsync + +## -description +Creates [BarcodeScanner](barcodescanner.md) object from the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific barcode scanner, which can be retrieved from the [DeviceId](barcodescanner_deviceid.md) property. + +## -returns +The barcode scanner specified by the unique device identifier. Returns a null object in the following cases: ++ The specific device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + + +## -remarks + +## -examples + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/barcodescanner_getdefaultasync_1549573963.md b/windows.devices.pointofservice/barcodescanner_getdefaultasync_1549573963.md index d190682bc5..547f646ef1 100644 --- a/windows.devices.pointofservice/barcodescanner_getdefaultasync_1549573963.md +++ b/windows.devices.pointofservice/barcodescanner_getdefaultasync_1549573963.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetDefaultAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.BarcodeScanner.GetDefaultAsync - -## -description -Returns the first available barcode scanner. - -## -returns -The first available barcode scanner. Returns a null object in the following cases: -+ A device is not found. -+ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. - - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cpp[CreateBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetCreateBarcodeScanner)][!code-cs[CreateBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetCreateBarcodeScanner)][!code-js[CreateBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScanner)] - -[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] - -## -see-also -[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.GetDefaultAsync + +## -description +Returns the first available barcode scanner. + +## -returns +The first available barcode scanner. Returns a null object in the following cases: ++ A device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cpp[CreateBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetCreateBarcodeScanner)][!code-cs[CreateBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetCreateBarcodeScanner)][!code-js[CreateBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScanner)] + +[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] + +## -see-also +[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) diff --git a/windows.devices.pointofservice/barcodescanner_getdeviceselector_838466080.md b/windows.devices.pointofservice/barcodescanner_getdeviceselector_838466080.md index 711812f0e0..70d8592dd8 100644 --- a/windows.devices.pointofservice/barcodescanner_getdeviceselector_838466080.md +++ b/windows.devices.pointofservice/barcodescanner_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that you can use to list the available barcode scanners. ## -returns An Advanced Query Syntax (AQS) string that is used to enumerate available barcode scanners. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the available barcode scanners. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate available barcode scanners. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_getsupportedprofiles_321103645.md b/windows.devices.pointofservice/barcodescanner_getsupportedprofiles_321103645.md index 0f9ac4f301..8c8c406825 100644 --- a/windows.devices.pointofservice/barcodescanner_getsupportedprofiles_321103645.md +++ b/windows.devices.pointofservice/barcodescanner_getsupportedprofiles_321103645.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetSupportedProfiles --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.GetSupportedProfiles ## -description Gets the list of profiles supported by the barcode scanner. ## -returns As array of strings representing the supported profiles. Returns an empty list if the scanner does not support profiles. ## -remarks A barcode scanner can support a number of features in addition to scanning, such as focal length and scan duration. There can be as many as 100 features exposed through settings or properties. To simplify the scanner configuration, the concept of a profile is introduced, which wraps one or more settings defined by the manufacturer. An application developer can query for a list of supported profiles and set a profile. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetSupportedProfiles +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.GetSupportedProfiles + +## -description +Gets the list of profiles supported by the barcode scanner. + +## -returns +As array of strings representing the supported profiles. Returns an empty list if the scanner does not support profiles. + +## -remarks +A barcode scanner can support a number of features in addition to scanning, such as focal length and scan duration. There can be as many as 100 features exposed through settings or properties. To simplify the scanner configuration, the concept of a profile is introduced, which wraps one or more settings defined by the manufacturer. An application developer can query for a list of supported profiles and set a profile. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_getsupportedsymbologiesasync_934072028.md b/windows.devices.pointofservice/barcodescanner_getsupportedsymbologiesasync_934072028.md index 253854f208..fec753539a 100644 --- a/windows.devices.pointofservice/barcodescanner_getsupportedsymbologiesasync_934072028.md +++ b/windows.devices.pointofservice/barcodescanner_getsupportedsymbologiesasync_934072028.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetSupportedSymbologiesAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.GetSupportedSymbologiesAsync ## -description Gets the symbologies supported by the claimed barcode scanner. ## -returns When the method completes successfully, it returns a list of values that represent the symbologies supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetSupportedSymbologiesAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.GetSupportedSymbologiesAsync + +## -description +Gets the symbologies supported by the claimed barcode scanner. + +## -returns +When the method completes successfully, it returns a list of values that represent the symbologies supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_isprofilesupported_1386341468.md b/windows.devices.pointofservice/barcodescanner_isprofilesupported_1386341468.md index 9b83b04b29..9ccadb6738 100644 --- a/windows.devices.pointofservice/barcodescanner_isprofilesupported_1386341468.md +++ b/windows.devices.pointofservice/barcodescanner_isprofilesupported_1386341468.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.IsProfileSupported(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.IsProfileSupported ## -description Determines whether the profile is supported. ## -parameters ### -param profile Barcode scanner profile. ## -returns True if the barcode scanner supports the profile; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.IsProfileSupported(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.IsProfileSupported + +## -description +Determines whether the profile is supported. + +## -parameters +### -param profile +Barcode scanner profile. + +## -returns +True if the barcode scanner supports the profile; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_issymbologysupportedasync_1191115390.md b/windows.devices.pointofservice/barcodescanner_issymbologysupportedasync_1191115390.md index 82b2b72911..39790c0566 100644 --- a/windows.devices.pointofservice/barcodescanner_issymbologysupportedasync_1191115390.md +++ b/windows.devices.pointofservice/barcodescanner_issymbologysupportedasync_1191115390.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.IsSymbologySupportedAsync(System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.IsSymbologySupportedAsync ## -description Determines whether the specified symbology is supported by the barcode scanner. ## -parameters ### -param barcodeSymbology The specific barcode symbology. ## -returns True if the device supports the specified symbology; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.IsSymbologySupportedAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.IsSymbologySupportedAsync + +## -description +Determines whether the specified symbology is supported by the barcode scanner. + +## -parameters +### -param barcodeSymbology +The specific barcode symbology. + +## -returns +True if the device supports the specified symbology; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_retrievestatisticsasync_735443283.md b/windows.devices.pointofservice/barcodescanner_retrievestatisticsasync_735443283.md index 19d4a2fc00..3be5c8e129 100644 --- a/windows.devices.pointofservice/barcodescanner_retrievestatisticsasync_735443283.md +++ b/windows.devices.pointofservice/barcodescanner_retrievestatisticsasync_735443283.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeScanner.RetrieveStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeScanner.RetrieveStatisticsAsync ## -description Retrieves the requested statistics from the barcode scanner. ## -parameters ### -param statisticsCategories The list of statistics to retrieve. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and groups names ("name3", "U_", "M_"). ## -returns IBuffer representing the requested statistics. ## -remarks The result does not contain any duplicate statistics even if the input contains duplicates. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.RetrieveStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.RetrieveStatisticsAsync + +## -description +Retrieves the requested statistics from the barcode scanner. + +## -parameters +### -param statisticsCategories +The list of statistics to retrieve. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and groups names ("name3", "U_", "M_"). + + +## -returns +IBuffer representing the requested statistics. + +## -remarks +The result does not contain any duplicate statistics even if the input contains duplicates. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_statusupdated.md b/windows.devices.pointofservice/barcodescanner_statusupdated.md index b35dd63bed..4b35c38c3d 100644 --- a/windows.devices.pointofservice/barcodescanner_statusupdated.md +++ b/windows.devices.pointofservice/barcodescanner_statusupdated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.BarcodeScanner.StatusUpdated --api-type: winrt event ---- # Windows.Devices.PointOfService.BarcodeScanner.StatusUpdated ## -description Occurs when the barcode scanner detects an operation status change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.BarcodeScanner.StatusUpdated +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.StatusUpdated + +## -description +Occurs when the barcode scanner detects an operation status change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescanner_videodeviceid.md b/windows.devices.pointofservice/barcodescanner_videodeviceid.md index c51c8f3417..c88b6ffc79 100644 --- a/windows.devices.pointofservice/barcodescanner_videodeviceid.md +++ b/windows.devices.pointofservice/barcodescanner_videodeviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScanner.VideoDeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScanner.VideoDeviceId ## -description Retrieves the video device ID which represents the camera lens associated with the claimed barcode scanner. ## -property-value The video device ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScanner.VideoDeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.VideoDeviceId + +## -description +Retrieves the video device ID which represents the camera lens associated with the claimed barcode scanner. + +## -property-value +The video device ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannercapabilities.md b/windows.devices.pointofservice/barcodescannercapabilities.md index 72e041c738..2e9a707bb5 100644 --- a/windows.devices.pointofservice/barcodescannercapabilities.md +++ b/windows.devices.pointofservice/barcodescannercapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScannerCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScannerCapabilities ## -description Represents the barcode scanner capabilities. ## -remarks This object is accessed when you retrieve the [Capabilities](barcodescanner_capabilities.md) property of the [BarcodeScanner](barcodescanner.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScannerCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerCapabilities + +## -description +Represents the barcode scanner capabilities. + +## -remarks +This object is accessed when you retrieve the [Capabilities](barcodescanner_capabilities.md) property of the [BarcodeScanner](barcodescanner.md) object. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannercapabilities_isimagepreviewsupported.md b/windows.devices.pointofservice/barcodescannercapabilities_isimagepreviewsupported.md index af0981d3b4..a63de7987a 100644 --- a/windows.devices.pointofservice/barcodescannercapabilities_isimagepreviewsupported.md +++ b/windows.devices.pointofservice/barcodescannercapabilities_isimagepreviewsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsImagePreviewSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsImagePreviewSupported ## -description Indicates whether the barcode scanner supports image preview. ## -property-value True if the barcode scanner supports image preview; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsImagePreviewSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsImagePreviewSupported + +## -description +Indicates whether the barcode scanner supports image preview. + +## -property-value +True if the barcode scanner supports image preview; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannercapabilities_issoftwaretriggersupported.md b/windows.devices.pointofservice/barcodescannercapabilities_issoftwaretriggersupported.md index 7390af0e47..595f931060 100644 --- a/windows.devices.pointofservice/barcodescannercapabilities_issoftwaretriggersupported.md +++ b/windows.devices.pointofservice/barcodescannercapabilities_issoftwaretriggersupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsSoftwareTriggerSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsSoftwareTriggerSupported ## -description Indicates whether the barcode scanner supports the software trigger functionality. ## -property-value True if the software trigger is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsSoftwareTriggerSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsSoftwareTriggerSupported + +## -description +Indicates whether the barcode scanner supports the software trigger functionality. + +## -property-value +True if the software trigger is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsreportingsupported.md b/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsreportingsupported.md index 3d705d86db..770db05cb9 100644 --- a/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsreportingsupported.md +++ b/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsreportingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsReportingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsReportingSupported ## -description Indicates whether the barcode scanner supports reporting of usage statistics. ## -property-value True if the barcode scanner supports statistics reporting; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsReportingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsReportingSupported + +## -description +Indicates whether the barcode scanner supports reporting of usage statistics. + +## -property-value +True if the barcode scanner supports statistics reporting; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsupdatingsupported.md b/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsupdatingsupported.md index 3377c871aa..15073f0a48 100644 --- a/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsupdatingsupported.md +++ b/windows.devices.pointofservice/barcodescannercapabilities_isstatisticsupdatingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsUpdatingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsUpdatingSupported ## -description Indicates whether the barcode scanner supports updating or resetting of usage statistics. ## -property-value True if the barcode scanner supports updating of usage statistics; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsUpdatingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerCapabilities.IsStatisticsUpdatingSupported + +## -description +Indicates whether the barcode scanner supports updating or resetting of usage statistics. + +## -property-value +True if the barcode scanner supports updating of usage statistics; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannercapabilities_powerreportingtype.md b/windows.devices.pointofservice/barcodescannercapabilities_powerreportingtype.md index 64b74ac774..5736e2a41f 100644 --- a/windows.devices.pointofservice/barcodescannercapabilities_powerreportingtype.md +++ b/windows.devices.pointofservice/barcodescannercapabilities_powerreportingtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.PowerReportingType --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerCapabilities.PowerReportingType ## -description Gets the power reporting type for the barcode scanner. ## -property-value Power reporting type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerCapabilities.PowerReportingType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerCapabilities.PowerReportingType + +## -description +Gets the power reporting type for the barcode scanner. + +## -property-value +Power reporting type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerdatareceivedeventargs.md b/windows.devices.pointofservice/barcodescannerdatareceivedeventargs.md index 07919f8794..836852d4ab 100644 --- a/windows.devices.pointofservice/barcodescannerdatareceivedeventargs.md +++ b/windows.devices.pointofservice/barcodescannerdatareceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs ## -description Provides the barcode data from the [DataReceived](claimedbarcodescanner_datareceived.md) event. ## -remarks This object is created by the [DataReceived](claimedbarcodescanner_datareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs + +## -description +Provides the barcode data from the [DataReceived](claimedbarcodescanner_datareceived.md) event. + +## -remarks +This object is created by the [DataReceived](claimedbarcodescanner_datareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerdatareceivedeventargs_report.md b/windows.devices.pointofservice/barcodescannerdatareceivedeventargs_report.md index 9605b82e1e..a39abed0c9 100644 --- a/windows.devices.pointofservice/barcodescannerdatareceivedeventargs_report.md +++ b/windows.devices.pointofservice/barcodescannerdatareceivedeventargs_report.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs.Report --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs.Report ## -description Gets the data from the [DataReceived](claimedbarcodescanner_datareceived.md) event. ## -property-value Data from the barcode scanning event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs.Report +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerDataReceivedEventArgs.Report + +## -description +Gets the data from the [DataReceived](claimedbarcodescanner_datareceived.md) event. + +## -property-value +Data from the barcode scanning event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannererroroccurredeventargs.md b/windows.devices.pointofservice/barcodescannererroroccurredeventargs.md index b9b996547b..2f00c09f06 100644 --- a/windows.devices.pointofservice/barcodescannererroroccurredeventargs.md +++ b/windows.devices.pointofservice/barcodescannererroroccurredeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs ## -description Provides data for the [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) event. ## -remarks This object is created by the [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs + +## -description +Provides data for the [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) event. + +## -remarks +This object is created by the [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannererroroccurredeventargs_errordata.md b/windows.devices.pointofservice/barcodescannererroroccurredeventargs_errordata.md index 8cd1c6fa08..4e611a51ad 100644 --- a/windows.devices.pointofservice/barcodescannererroroccurredeventargs_errordata.md +++ b/windows.devices.pointofservice/barcodescannererroroccurredeventargs_errordata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.ErrorData --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.ErrorData ## -description Gets the data associated with the [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) event. ## -property-value The error information. ## -remarks ## -examples ## -see-also [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.ErrorData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.ErrorData + +## -description +Gets the data associated with the [ErrorOccurred](claimedbarcodescanner_erroroccurred.md) event. + +## -property-value +The error information. + +## -remarks + +## -examples + +## -see-also +[ErrorOccurred](claimedbarcodescanner_erroroccurred.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/barcodescannererroroccurredeventargs_isretriable.md b/windows.devices.pointofservice/barcodescannererroroccurredeventargs_isretriable.md index 1c0fa30734..e0d9eefed6 100644 --- a/windows.devices.pointofservice/barcodescannererroroccurredeventargs_isretriable.md +++ b/windows.devices.pointofservice/barcodescannererroroccurredeventargs_isretriable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.IsRetriable --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.IsRetriable ## -description Indicates whether it is worthwhile to make another attempt at the operation. ## -property-value True if the application should make another attempt at the operation; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.IsRetriable +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.IsRetriable + +## -description +Indicates whether it is worthwhile to make another attempt at the operation. + +## -property-value +True if the application should make another attempt at the operation; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannererroroccurredeventargs_partialinputdata.md b/windows.devices.pointofservice/barcodescannererroroccurredeventargs_partialinputdata.md index f1b96bb0b0..27d8f88ebc 100644 --- a/windows.devices.pointofservice/barcodescannererroroccurredeventargs_partialinputdata.md +++ b/windows.devices.pointofservice/barcodescannererroroccurredeventargs_partialinputdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.PartialInputData --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.PartialInputData ## -description Gets any data that was successfully read. ## -property-value The partial input information from the barcode scanner. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.PartialInputData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerErrorOccurredEventArgs.PartialInputData + +## -description +Gets any data that was successfully read. + +## -property-value +The partial input information from the barcode scanner. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs.md b/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs.md index a5e03c5bea..fa1892f7a0 100644 --- a/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs.md +++ b/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs ## -description Provides the data from the [ImagePreviewReceived](claimedbarcodescanner_imagepreviewreceived.md) event. ## -remarks This object is created by the [ImagePreviewReceived](claimedbarcodescanner_imagepreviewreceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs + +## -description +Provides the data from the [ImagePreviewReceived](claimedbarcodescanner_imagepreviewreceived.md) event. + +## -remarks +This object is created by the [ImagePreviewReceived](claimedbarcodescanner_imagepreviewreceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs_preview.md b/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs_preview.md index a01bea55b8..3ef8dfe5df 100644 --- a/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs_preview.md +++ b/windows.devices.pointofservice/barcodescannerimagepreviewreceivedeventargs_preview.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs.Preview --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs.Preview ## -description Gets the from the device representing a preview frame. ## -property-value The data stream representing the preview frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs.Preview +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerImagePreviewReceivedEventArgs.Preview + +## -description +Gets the from the device representing a preview frame. + +## -property-value +The data stream representing the preview frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerreport.md b/windows.devices.pointofservice/barcodescannerreport.md index 6dacd9d22e..d665bad2de 100644 --- a/windows.devices.pointofservice/barcodescannerreport.md +++ b/windows.devices.pointofservice/barcodescannerreport.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScannerReport --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScannerReport ## -description Contains the barcode scanner data. ## -remarks This object is accessed when you retrieve the [Report](barcodescannerdatareceivedeventargs_report.md) property of the [BarcodeScannerDataReceivedEventArgs](barcodescannerdatareceivedeventargs.md) object. ## -examples ## -see-also [Report](barcodescannerdatareceivedeventargs_report.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScannerReport +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerReport + +## -description +Contains the barcode scanner data. + +## -remarks +This object is accessed when you retrieve the [Report](barcodescannerdatareceivedeventargs_report.md) property of the [BarcodeScannerDataReceivedEventArgs](barcodescannerdatareceivedeventargs.md) object. + +## -examples + +## -see-also +[Report](barcodescannerdatareceivedeventargs_report.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/barcodescannerreport_scandata.md b/windows.devices.pointofservice/barcodescannerreport_scandata.md index a8980213ca..13edc068ce 100644 --- a/windows.devices.pointofservice/barcodescannerreport_scandata.md +++ b/windows.devices.pointofservice/barcodescannerreport_scandata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerReport.ScanData --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerReport.ScanData ## -description Gets the full raw data from the [DataReceived](claimedbarcodescanner_datareceived.md) event. ## -property-value The raw data stream from the scanning event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerReport.ScanData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerReport.ScanData + +## -description +Gets the full raw data from the [DataReceived](claimedbarcodescanner_datareceived.md) event. + +## -property-value +The raw data stream from the scanning event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerreport_scandatalabel.md b/windows.devices.pointofservice/barcodescannerreport_scandatalabel.md index b6e8f7d1e2..beefba3281 100644 --- a/windows.devices.pointofservice/barcodescannerreport_scandatalabel.md +++ b/windows.devices.pointofservice/barcodescannerreport_scandatalabel.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataLabel --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataLabel ## -description Gets the decoded barcode label, which does not include the header, checksum, and other miscellaneous information. ## -property-value The data stream containing the decoded barcode label. ## -remarks If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is true, this property contains the decodes barcode label. If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is false, this property is set to null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataLabel +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataLabel + +## -description +Gets the decoded barcode label, which does not include the header, checksum, and other miscellaneous information. + +## -property-value +The data stream containing the decoded barcode label. + +## -remarks +If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is true, this property contains the decodes barcode label. If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is false, this property is set to null. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerreport_scandatatype.md b/windows.devices.pointofservice/barcodescannerreport_scandatatype.md index 312921577a..556212ffe1 100644 --- a/windows.devices.pointofservice/barcodescannerreport_scandatatype.md +++ b/windows.devices.pointofservice/barcodescannerreport_scandatatype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataType --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataType ## -description Gets the decoded barcode label type. Possible values are defined in the [BarcodeSymbologies](barcodesymbologies.md) class. ## -property-value The specific barcode symbology. ## -remarks The return value of this property depends on the value of [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) property. If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is true, this property contains the barcode symbology. If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is false, this property contains the [BarcodeSymbology.Unknown](barcodesymbologies_unknown.md) value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerReport.ScanDataType + +## -description +Gets the decoded barcode label type. Possible values are defined in the [BarcodeSymbologies](barcodesymbologies.md) class. + +## -property-value +The specific barcode symbology. + +## -remarks +The return value of this property depends on the value of [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) property. If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is true, this property contains the barcode symbology. If [IsDecodeDataEnabled](claimedbarcodescanner_isdecodedataenabled.md) is false, this property contains the [BarcodeSymbology.Unknown](barcodesymbologies_unknown.md) value. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs.md b/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs.md index eed34fe2dc..477b4725df 100644 --- a/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs.md +++ b/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs ## -description Provides information about an operation status change. ## -remarks This object is created by the [StatusUpdated](barcodescanner_statusupdated.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs + +## -description +Provides information about an operation status change. + +## -remarks +This object is created by the [StatusUpdated](barcodescanner_statusupdated.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_extendedstatus.md b/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_extendedstatus.md index 1822024578..35d1408c44 100644 --- a/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_extendedstatus.md +++ b/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_extendedstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.ExtendedStatus --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.ExtendedStatus ## -description Gets the vendor specific status code. ## -property-value The vendor specific status code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.ExtendedStatus +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.ExtendedStatus + +## -description +Gets the vendor specific status code. + +## -property-value +The vendor specific status code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_status.md b/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_status.md index bceef97043..e3fbfd77ae 100644 --- a/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_status.md +++ b/windows.devices.pointofservice/barcodescannerstatusupdatedeventargs_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.Status ## -description Gets the status change information. ## -property-value The status change information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeScannerStatusUpdatedEventArgs.Status + +## -description +Gets the status change information. + +## -property-value +The status change information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies.md b/windows.devices.pointofservice/barcodesymbologies.md index fd1ebd87c6..851a62c8ba 100644 --- a/windows.devices.pointofservice/barcodesymbologies.md +++ b/windows.devices.pointofservice/barcodesymbologies.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.BarcodeSymbologies --api-type: winrt class ---- # Windows.Devices.PointOfService.BarcodeSymbologies ## -description Contains the barcode symbology. ## -remarks This is a static class that contains the barcode symbologies. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeSymbologies +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies + +## -description +Contains the barcode symbology. + +## -remarks +This is a static class that contains the barcode symbologies. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_auspost.md b/windows.devices.pointofservice/barcodesymbologies_auspost.md index b0d8c59f11..89d30539f3 100644 --- a/windows.devices.pointofservice/barcodesymbologies_auspost.md +++ b/windows.devices.pointofservice/barcodesymbologies_auspost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.AusPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.AusPost ## -description Gets the Australia Postal barcode symbology. ## -property-value The Australia Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.AusPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.AusPost + +## -description +Gets the Australia Postal barcode symbology. + +## -property-value +The Australia Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_aztec.md b/windows.devices.pointofservice/barcodesymbologies_aztec.md index 741716ced4..1b83d5ad6b 100644 --- a/windows.devices.pointofservice/barcodesymbologies_aztec.md +++ b/windows.devices.pointofservice/barcodesymbologies_aztec.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Aztec --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Aztec ## -description Gets the Aztec barcode symbology. ## -property-value The Aztec barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Aztec +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Aztec + +## -description +Gets the Aztec barcode symbology. + +## -property-value +The Aztec barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_canpost.md b/windows.devices.pointofservice/barcodesymbologies_canpost.md index dcbfc189a5..50f22c9d91 100644 --- a/windows.devices.pointofservice/barcodesymbologies_canpost.md +++ b/windows.devices.pointofservice/barcodesymbologies_canpost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.CanPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.CanPost ## -description Gets the Canada Postal barcode symbology. ## -property-value The Canada Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.CanPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.CanPost + +## -description +Gets the Canada Postal barcode symbology. + +## -property-value +The Canada Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ccab.md b/windows.devices.pointofservice/barcodesymbologies_ccab.md index 750589fa7a..2b3825f932 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ccab.md +++ b/windows.devices.pointofservice/barcodesymbologies_ccab.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ccab --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ccab ## -description Gets the Composite Component A or B barcode symbology. ## -property-value The Composite Component A or B barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ccab +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ccab + +## -description +Gets the Composite Component A or B barcode symbology. + +## -property-value +The Composite Component A or B barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ccc.md b/windows.devices.pointofservice/barcodesymbologies_ccc.md index b6076a0a1a..dadb249cca 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ccc.md +++ b/windows.devices.pointofservice/barcodesymbologies_ccc.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ccc --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ccc ## -description Gets the Composite Component-C barcode symbology. ## -property-value The Composite Component-C barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ccc +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ccc + +## -description +Gets the Composite Component-C barcode symbology. + +## -property-value +The Composite Component-C barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_chinapost.md b/windows.devices.pointofservice/barcodesymbologies_chinapost.md index 8b8ad74605..eb61676c1c 100644 --- a/windows.devices.pointofservice/barcodesymbologies_chinapost.md +++ b/windows.devices.pointofservice/barcodesymbologies_chinapost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ChinaPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.ChinaPost ## -description Gets the China Postal barcode symbology. ## -property-value The China Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ChinaPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.ChinaPost + +## -description +Gets the China Postal barcode symbology. + +## -property-value +The China Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_codabar.md b/windows.devices.pointofservice/barcodesymbologies_codabar.md index 2e9a148080..dfe18fb7eb 100644 --- a/windows.devices.pointofservice/barcodesymbologies_codabar.md +++ b/windows.devices.pointofservice/barcodesymbologies_codabar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Codabar --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Codabar ## -description Gets the Codabar barcode symbology. ## -property-value The Codabar barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Codabar +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Codabar + +## -description +Gets the Codabar barcode symbology. + +## -property-value +The Codabar barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_codablock128.md b/windows.devices.pointofservice/barcodesymbologies_codablock128.md index 74ed5932f9..e48612abd8 100644 --- a/windows.devices.pointofservice/barcodesymbologies_codablock128.md +++ b/windows.devices.pointofservice/barcodesymbologies_codablock128.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Codablock128 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Codablock128 ## -description Gets the Codablock 128 barcode symbology. ## -property-value The Codablock 128 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Codablock128 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Codablock128 + +## -description +Gets the Codablock 128 barcode symbology. + +## -property-value +The Codablock 128 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_codablocka.md b/windows.devices.pointofservice/barcodesymbologies_codablocka.md index a0017a9c44..9fe9ea654d 100644 --- a/windows.devices.pointofservice/barcodesymbologies_codablocka.md +++ b/windows.devices.pointofservice/barcodesymbologies_codablocka.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.CodablockA --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.CodablockA ## -description Gets the Codablock A barcode symbology. ## -property-value The Codablock A barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.CodablockA +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.CodablockA + +## -description +Gets the Codablock A barcode symbology. + +## -property-value +The Codablock A barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_codablockf.md b/windows.devices.pointofservice/barcodesymbologies_codablockf.md index a149c65b2c..a644151a3a 100644 --- a/windows.devices.pointofservice/barcodesymbologies_codablockf.md +++ b/windows.devices.pointofservice/barcodesymbologies_codablockf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.CodablockF --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.CodablockF ## -description Gets the Codablock F barcode symbology. ## -property-value The Codablock F barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.CodablockF +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.CodablockF + +## -description +Gets the Codablock F barcode symbology. + +## -property-value +The Codablock F barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code11.md b/windows.devices.pointofservice/barcodesymbologies_code11.md index e40ed702a4..16d81e5b8e 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code11.md +++ b/windows.devices.pointofservice/barcodesymbologies_code11.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code11 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code11 ## -description Gets the Code 11 barcode symbology. ## -property-value The Code 11 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code11 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code11 + +## -description +Gets the Code 11 barcode symbology. + +## -property-value +The Code 11 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code128.md b/windows.devices.pointofservice/barcodesymbologies_code128.md index 5d0f98a12a..72dbbe41ea 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code128.md +++ b/windows.devices.pointofservice/barcodesymbologies_code128.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code128 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code128 ## -description Gets the Code 128 barcode symbology. ## -property-value The Code 128 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code128 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code128 + +## -description +Gets the Code 128 barcode symbology. + +## -property-value +The Code 128 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code16k.md b/windows.devices.pointofservice/barcodesymbologies_code16k.md index 9dbf474f1e..891bc69de1 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code16k.md +++ b/windows.devices.pointofservice/barcodesymbologies_code16k.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code16k --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code16k ## -description Gets the Code 16k barcode symbology. ## -property-value The Code 16k barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code16k +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code16k + +## -description +Gets the Code 16k barcode symbology. + +## -property-value +The Code 16k barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code32.md b/windows.devices.pointofservice/barcodesymbologies_code32.md index c9f6683f7c..0ae0f49a45 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code32.md +++ b/windows.devices.pointofservice/barcodesymbologies_code32.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code32 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code32 ## -description Gets the Code 32 barcode symbology. ## -property-value The Code 32 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code32 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code32 + +## -description +Gets the Code 32 barcode symbology. + +## -property-value +The Code 32 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code39.md b/windows.devices.pointofservice/barcodesymbologies_code39.md index e613cea22e..218f54cbec 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code39.md +++ b/windows.devices.pointofservice/barcodesymbologies_code39.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code39 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code39 ## -description Gets the Code 39 barcode symbology. ## -property-value The Code 39 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code39 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code39 + +## -description +Gets the Code 39 barcode symbology. + +## -property-value +The Code 39 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code39ex.md b/windows.devices.pointofservice/barcodesymbologies_code39ex.md index 991d67f50d..2a29bd6e73 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code39ex.md +++ b/windows.devices.pointofservice/barcodesymbologies_code39ex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code39Ex --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code39Ex ## -description Gets the Code 39 Extended barcode symbology. ## -property-value The Code 39 Extended barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code39Ex +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code39Ex + +## -description +Gets the Code 39 Extended barcode symbology. + +## -property-value +The Code 39 Extended barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code49.md b/windows.devices.pointofservice/barcodesymbologies_code49.md index b3ce525496..a318fabe37 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code49.md +++ b/windows.devices.pointofservice/barcodesymbologies_code49.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code49 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code49 ## -description Gets the Code 49 barcode symbology. ## -property-value The Code 49 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code49 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code49 + +## -description +Gets the Code 49 barcode symbology. + +## -property-value +The Code 49 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code93.md b/windows.devices.pointofservice/barcodesymbologies_code93.md index 00fb91f519..a0712d25ab 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code93.md +++ b/windows.devices.pointofservice/barcodesymbologies_code93.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code93 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code93 ## -description Gets the Code 93 barcode symbology. ## -property-value The Code 93 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code93 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code93 + +## -description +Gets the Code 93 barcode symbology. + +## -property-value +The Code 93 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_code93ex.md b/windows.devices.pointofservice/barcodesymbologies_code93ex.md index dbe5483d08..6e632ba9ff 100644 --- a/windows.devices.pointofservice/barcodesymbologies_code93ex.md +++ b/windows.devices.pointofservice/barcodesymbologies_code93ex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code93Ex --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Code93Ex ## -description Gets the Code 93 Extended barcode symbology. ## -property-value The Code 93 Extended barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Code93Ex +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Code93Ex + +## -description +Gets the Code 93 Extended barcode symbology. + +## -property-value +The Code 93 Extended barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_datacode.md b/windows.devices.pointofservice/barcodesymbologies_datacode.md index 0722ead9b4..2787f506bc 100644 --- a/windows.devices.pointofservice/barcodesymbologies_datacode.md +++ b/windows.devices.pointofservice/barcodesymbologies_datacode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.DataCode --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.DataCode ## -description Gets the Data Code barcode symbology. ## -property-value The Data Code barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.DataCode +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.DataCode + +## -description +Gets the Data Code barcode symbology. + +## -property-value +The Data Code barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_datamatrix.md b/windows.devices.pointofservice/barcodesymbologies_datamatrix.md index b1f9be8ace..ea1d2dd5d3 100644 --- a/windows.devices.pointofservice/barcodesymbologies_datamatrix.md +++ b/windows.devices.pointofservice/barcodesymbologies_datamatrix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.DataMatrix --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.DataMatrix ## -description Gets the Data Matric barcode symbology. ## -property-value The Data Matrix barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.DataMatrix +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.DataMatrix + +## -description +Gets the Data Matric barcode symbology. + +## -property-value +The Data Matrix barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_dutchkix.md b/windows.devices.pointofservice/barcodesymbologies_dutchkix.md index 6a918ce400..49e2b99919 100644 --- a/windows.devices.pointofservice/barcodesymbologies_dutchkix.md +++ b/windows.devices.pointofservice/barcodesymbologies_dutchkix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.DutchKix --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.DutchKix ## -description Gets the Dutch Postal barcode symbology. ## -property-value The Dutch Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.DutchKix +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.DutchKix + +## -description +Gets the Dutch Postal barcode symbology. + +## -property-value +The Dutch Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean13.md b/windows.devices.pointofservice/barcodesymbologies_ean13.md index 5c8a6cec54..44d6d1d427 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean13.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean13.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean13 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean13 ## -description Gets the EAN (European Article Number) 13 barcode symbology. ## -property-value The EAN 13 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean13 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean13 + +## -description +Gets the EAN (European Article Number) 13 barcode symbology. + +## -property-value +The EAN 13 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean13add2.md b/windows.devices.pointofservice/barcodesymbologies_ean13add2.md index 9910bc523d..7d67edbce0 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean13add2.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean13add2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add2 ## -description Gets the EAN 13 with 2 digit supplement barcode symbology. ## -property-value The EAN 13 with 2 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add2 + +## -description +Gets the EAN 13 with 2 digit supplement barcode symbology. + +## -property-value +The EAN 13 with 2 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean13add5.md b/windows.devices.pointofservice/barcodesymbologies_ean13add5.md index 20901d539a..e0c77be287 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean13add5.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean13add5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add5 ## -description Gets the EAN 13 with 5 digit supplement barcode symbology. ## -property-value The EAN 13 with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean13Add5 + +## -description +Gets the EAN 13 with 5 digit supplement barcode symbology. + +## -property-value +The EAN 13 with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean8.md b/windows.devices.pointofservice/barcodesymbologies_ean8.md index cac20d6611..b9833c35a8 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean8.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean8.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean8 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean8 ## -description Gets the EAN 8 barcode symbology. ## -property-value The EAN 8 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean8 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean8 + +## -description +Gets the EAN 8 barcode symbology. + +## -property-value +The EAN 8 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean8add2.md b/windows.devices.pointofservice/barcodesymbologies_ean8add2.md index 43859dd8e5..cc4d4035e1 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean8add2.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean8add2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add2 ## -description Gets the EAN 8 with 2 digit supplement barcode symbology. ## -property-value The EAN 8 with 2 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add2 + +## -description +Gets the EAN 8 with 2 digit supplement barcode symbology. + +## -property-value +The EAN 8 with 2 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean8add5.md b/windows.devices.pointofservice/barcodesymbologies_ean8add5.md index e7ece5536e..7578315742 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean8add5.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean8add5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add5 ## -description Gets the EAN 8 with 5 digit supplement barcode symbology. ## -property-value The EAN 8 with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean8Add5 + +## -description +Gets the EAN 8 with 5 digit supplement barcode symbology. + +## -property-value +The EAN 8 with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean99.md b/windows.devices.pointofservice/barcodesymbologies_ean99.md index 2a6270a992..7ed12a74d7 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean99.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean99.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean99 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean99 ## -description Gets the EAN 99 barcode symbology. ## -property-value The EAN 99 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean99 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean99 + +## -description +Gets the EAN 99 barcode symbology. + +## -property-value +The EAN 99 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean99add2.md b/windows.devices.pointofservice/barcodesymbologies_ean99add2.md index 9b292823b4..55450c7b16 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean99add2.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean99add2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add2 ## -description Gets the EAN 99 with 2 digit supplement barcode symbology. ## -property-value The EAN 99 with 2 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add2 + +## -description +Gets the EAN 99 with 2 digit supplement barcode symbology. + +## -property-value +The EAN 99 with 2 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ean99add5.md b/windows.devices.pointofservice/barcodesymbologies_ean99add5.md index 12ab075f30..12a8b067da 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ean99add5.md +++ b/windows.devices.pointofservice/barcodesymbologies_ean99add5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add5 ## -description Gets the EAN 99 with 5 digit supplement barcode symbology. ## -property-value The EAN 99 with 5 digit supplementbarcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ean99Add5 + +## -description +Gets the EAN 99 with 5 digit supplement barcode symbology. + +## -property-value +The EAN 99 with 5 digit supplementbarcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_eanv.md b/windows.devices.pointofservice/barcodesymbologies_eanv.md index 4dae1930f1..567ca688fb 100644 --- a/windows.devices.pointofservice/barcodesymbologies_eanv.md +++ b/windows.devices.pointofservice/barcodesymbologies_eanv.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Eanv --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Eanv ## -description Gets the EAN Velocity barcode symbology. ## -property-value The EAN Velocity barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Eanv +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Eanv + +## -description +Gets the EAN Velocity barcode symbology. + +## -property-value +The EAN Velocity barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_eanvadd2.md b/windows.devices.pointofservice/barcodesymbologies_eanvadd2.md index 939563dac6..0f1201c0bb 100644 --- a/windows.devices.pointofservice/barcodesymbologies_eanvadd2.md +++ b/windows.devices.pointofservice/barcodesymbologies_eanvadd2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd2 ## -description Gets the EAN Velocity with 2 digit supplement barcode symbology. ## -property-value The EAN Velocity with 2 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd2 + +## -description +Gets the EAN Velocity with 2 digit supplement barcode symbology. + +## -property-value +The EAN Velocity with 2 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_eanvadd5.md b/windows.devices.pointofservice/barcodesymbologies_eanvadd5.md index c4388e9658..c256bf7084 100644 --- a/windows.devices.pointofservice/barcodesymbologies_eanvadd5.md +++ b/windows.devices.pointofservice/barcodesymbologies_eanvadd5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd5 ## -description Gets the EAN Velocity with 5 digit supplement barcode symbology. ## -property-value The EAN Velocity with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.EanvAdd5 + +## -description +Gets the EAN Velocity with 5 digit supplement barcode symbology. + +## -property-value +The EAN Velocity with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_extendedbase.md b/windows.devices.pointofservice/barcodesymbologies_extendedbase.md index d46f3c387c..9ca9a06f94 100644 --- a/windows.devices.pointofservice/barcodesymbologies_extendedbase.md +++ b/windows.devices.pointofservice/barcodesymbologies_extendedbase.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ExtendedBase --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.ExtendedBase ## -description Gets the first possible OEM defined barcode symbology when the symbology type is not included in the current list. ## -property-value The OEM defined barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ExtendedBase +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.ExtendedBase + +## -description +Gets the first possible OEM defined barcode symbology when the symbology type is not included in the current list. + +## -property-value +The OEM defined barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_getname_782339402.md b/windows.devices.pointofservice/barcodesymbologies_getname_782339402.md index 39e3ee8b70..ae501cdfa6 100644 --- a/windows.devices.pointofservice/barcodesymbologies_getname_782339402.md +++ b/windows.devices.pointofservice/barcodesymbologies_getname_782339402.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.BarcodeSymbologies.GetName(System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.BarcodeSymbologies.GetName ## -description Returns the barcode symbology type as a string. ## -parameters ### -param scanDataType The barcode symbology type. ## -returns The barcode symbology type as a string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeSymbologies.GetName(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.GetName + +## -description +Returns the barcode symbology type as a string. + +## -parameters +### -param scanDataType +The barcode symbology type. + +## -returns +The barcode symbology type as a string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_gs1128.md b/windows.devices.pointofservice/barcodesymbologies_gs1128.md index 29a325b7f0..1ed323f486 100644 --- a/windows.devices.pointofservice/barcodesymbologies_gs1128.md +++ b/windows.devices.pointofservice/barcodesymbologies_gs1128.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128 ## -description Gets the GS1 128 shipping container barcode symbology. ## -property-value The GS1 128 shipping container barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128 + +## -description +Gets the GS1 128 shipping container barcode symbology. + +## -property-value +The GS1 128 shipping container barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_gs1128coupon.md b/windows.devices.pointofservice/barcodesymbologies_gs1128coupon.md index 79e5157547..37c613012f 100644 --- a/windows.devices.pointofservice/barcodesymbologies_gs1128coupon.md +++ b/windows.devices.pointofservice/barcodesymbologies_gs1128coupon.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128Coupon --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128Coupon ## -description Gets the GS1 128 Coupon barcode symbology. ## -property-value The GS1 128 Coupon barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128Coupon +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Gs1128Coupon + +## -description +Gets the GS1 128 Coupon barcode symbology. + +## -property-value +The GS1 128 Coupon barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_gs1databartype1.md b/windows.devices.pointofservice/barcodesymbologies_gs1databartype1.md index cfd3b67251..9aff01bcbd 100644 --- a/windows.devices.pointofservice/barcodesymbologies_gs1databartype1.md +++ b/windows.devices.pointofservice/barcodesymbologies_gs1databartype1.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType1 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType1 ## -description Gets the GS1 Databar Omnidirectional, GS1 Databar Stacked Omnidirectional, GS1 Databar Stacked, or GS1 Databar Truncated barcode symbology. ## -property-value The GS1 Databar Omnidirectional, GS1 Databar Stacked Omnidirectional, GS1 Databar Stacked, or GS1 Databar Truncated barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType1 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType1 + +## -description +Gets the GS1 Databar Omnidirectional, GS1 Databar Stacked Omnidirectional, GS1 Databar Stacked, or GS1 Databar Truncated barcode symbology. + +## -property-value +The GS1 Databar Omnidirectional, GS1 Databar Stacked Omnidirectional, GS1 Databar Stacked, or GS1 Databar Truncated barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_gs1databartype2.md b/windows.devices.pointofservice/barcodesymbologies_gs1databartype2.md index 452fdf8e37..3a3743853f 100644 --- a/windows.devices.pointofservice/barcodesymbologies_gs1databartype2.md +++ b/windows.devices.pointofservice/barcodesymbologies_gs1databartype2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType2 ## -description Gets the GS1 DataBar Limited or RSS Limited barcode symbology. ## -property-value The GS1 DataBar Limited or RSS Limited barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType2 + +## -description +Gets the GS1 DataBar Limited or RSS Limited barcode symbology. + +## -property-value +The GS1 DataBar Limited or RSS Limited barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_gs1databartype3.md b/windows.devices.pointofservice/barcodesymbologies_gs1databartype3.md index 70036c6279..eb68b746e9 100644 --- a/windows.devices.pointofservice/barcodesymbologies_gs1databartype3.md +++ b/windows.devices.pointofservice/barcodesymbologies_gs1databartype3.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType3 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType3 ## -description Gets the GS1 Databar Expanded, GS1 Databar Expanded Stacked, or RSS Expanded barcode symbology. ## -property-value The GS1 Databar Expanded, GS1 Databar Expanded Stacked, or RSS Expanded barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType3 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DatabarType3 + +## -description +Gets the GS1 Databar Expanded, GS1 Databar Expanded Stacked, or RSS Expanded barcode symbology. + +## -property-value +The GS1 Databar Expanded, GS1 Databar Expanded Stacked, or RSS Expanded barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_hanxin.md b/windows.devices.pointofservice/barcodesymbologies_hanxin.md index 14e226ff6d..9dabbc3f44 100644 --- a/windows.devices.pointofservice/barcodesymbologies_hanxin.md +++ b/windows.devices.pointofservice/barcodesymbologies_hanxin.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.HanXin --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.HanXin ## -description Gets the Han Xin barcode symbology. ## -property-value The Han Xin barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.HanXin +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.HanXin + +## -description +Gets the Han Xin barcode symbology. + +## -property-value +The Han Xin barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_infomail.md b/windows.devices.pointofservice/barcodesymbologies_infomail.md index 9d82ca2d88..0ab7906707 100644 --- a/windows.devices.pointofservice/barcodesymbologies_infomail.md +++ b/windows.devices.pointofservice/barcodesymbologies_infomail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.InfoMail --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.InfoMail ## -description Gets the InfoMail barcode symbology. ## -property-value The InfoMail barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.InfoMail +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.InfoMail + +## -description +Gets the InfoMail barcode symbology. + +## -property-value +The InfoMail barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_isbn.md b/windows.devices.pointofservice/barcodesymbologies_isbn.md index 709c396db2..bd723f9749 100644 --- a/windows.devices.pointofservice/barcodesymbologies_isbn.md +++ b/windows.devices.pointofservice/barcodesymbologies_isbn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Isbn --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Isbn ## -description Gets the International Standard Book Number (ISBN), also known as Bookland or Bookland EAN, barcode symbology. ## -property-value The International Standard Book Number (ISBN), also known as Bookland or Bookland EAN, barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Isbn +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Isbn + +## -description +Gets the International Standard Book Number (ISBN), also known as Bookland or Bookland EAN, barcode symbology. + +## -property-value +The International Standard Book Number (ISBN), also known as Bookland or Bookland EAN, barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_isbnadd5.md b/windows.devices.pointofservice/barcodesymbologies_isbnadd5.md index f373b5d9bf..99d8ab8fb7 100644 --- a/windows.devices.pointofservice/barcodesymbologies_isbnadd5.md +++ b/windows.devices.pointofservice/barcodesymbologies_isbnadd5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IsbnAdd5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.IsbnAdd5 ## -description Gets the ISBN with 5 digit supplement barcode symbology. ## -property-value The ISBN with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IsbnAdd5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.IsbnAdd5 + +## -description +Gets the ISBN with 5 digit supplement barcode symbology. + +## -property-value +The ISBN with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_isbt.md b/windows.devices.pointofservice/barcodesymbologies_isbt.md index ac487c6a0c..e7d6ef6a3d 100644 --- a/windows.devices.pointofservice/barcodesymbologies_isbt.md +++ b/windows.devices.pointofservice/barcodesymbologies_isbt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Isbt --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Isbt ## -description Gets the International Society of Blood Transfusion (ISBT) 128 barcode symbology. ## -property-value The International Society of Blood Transfusion (ISBT) 128 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Isbt +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Isbt + +## -description +Gets the International Society of Blood Transfusion (ISBT) 128 barcode symbology. + +## -property-value +The International Society of Blood Transfusion (ISBT) 128 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ismn.md b/windows.devices.pointofservice/barcodesymbologies_ismn.md index 6f2a95d5d5..67e0bfc52f 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ismn.md +++ b/windows.devices.pointofservice/barcodesymbologies_ismn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ismn --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Ismn ## -description Gets the International Standard Music Number (ISMN) barcode symbology. ## -property-value The International Standard Music Number (ISMN) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Ismn +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Ismn + +## -description +Gets the International Standard Music Number (ISMN) barcode symbology. + +## -property-value +The International Standard Music Number (ISMN) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ismnadd2.md b/windows.devices.pointofservice/barcodesymbologies_ismnadd2.md index 70cf9344b9..2f1fa99a32 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ismnadd2.md +++ b/windows.devices.pointofservice/barcodesymbologies_ismnadd2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd2 ## -description Gets the ISMN with 2 digit supplement barcode symbology. ## -property-value The ISMN with 2 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd2 + +## -description +Gets the ISMN with 2 digit supplement barcode symbology. + +## -property-value +The ISMN with 2 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ismnadd5.md b/windows.devices.pointofservice/barcodesymbologies_ismnadd5.md index b917c41880..caa330953a 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ismnadd5.md +++ b/windows.devices.pointofservice/barcodesymbologies_ismnadd5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd5 ## -description Gets the ISMN with 5 digit supplement barcode symbology. ## -property-value The ISMN with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.IsmnAdd5 + +## -description +Gets the ISMN with 5 digit supplement barcode symbology. + +## -property-value +The ISMN with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_issn.md b/windows.devices.pointofservice/barcodesymbologies_issn.md index 1214e562b3..6ce7a895a9 100644 --- a/windows.devices.pointofservice/barcodesymbologies_issn.md +++ b/windows.devices.pointofservice/barcodesymbologies_issn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Issn --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Issn ## -description Gets the International Standard Serial Number (ISSN) barcode symbology. ## -property-value The International Standard Serial Number (ISSN) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Issn +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Issn + +## -description +Gets the International Standard Serial Number (ISSN) barcode symbology. + +## -property-value +The International Standard Serial Number (ISSN) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_issnadd2.md b/windows.devices.pointofservice/barcodesymbologies_issnadd2.md index fd3fbece13..6ad095dd60 100644 --- a/windows.devices.pointofservice/barcodesymbologies_issnadd2.md +++ b/windows.devices.pointofservice/barcodesymbologies_issnadd2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd2 ## -description Gets the ISSN with 2 digit supplement barcode symbology. ## -property-value The ISMN with 2 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd2 + +## -description +Gets the ISSN with 2 digit supplement barcode symbology. + +## -property-value +The ISMN with 2 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_issnadd5.md b/windows.devices.pointofservice/barcodesymbologies_issnadd5.md index de90b49c58..ad529d4373 100644 --- a/windows.devices.pointofservice/barcodesymbologies_issnadd5.md +++ b/windows.devices.pointofservice/barcodesymbologies_issnadd5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd5 ## -description Gets the ISSN with 5 digit supplement barcode symbology. ## -property-value The ISSN with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.IssnAdd5 + +## -description +Gets the ISSN with 5 digit supplement barcode symbology. + +## -property-value +The ISSN with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_italianpost25.md b/windows.devices.pointofservice/barcodesymbologies_italianpost25.md index 8d0d369918..4272438f27 100644 --- a/windows.devices.pointofservice/barcodesymbologies_italianpost25.md +++ b/windows.devices.pointofservice/barcodesymbologies_italianpost25.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost25 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost25 ## -description Gets the Italian Post 25 barcode symbology. ## -property-value The Italian Post 25 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost25 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost25 + +## -description +Gets the Italian Post 25 barcode symbology. + +## -property-value +The Italian Post 25 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_italianpost39.md b/windows.devices.pointofservice/barcodesymbologies_italianpost39.md index 3e1da1435b..1a533c11fe 100644 --- a/windows.devices.pointofservice/barcodesymbologies_italianpost39.md +++ b/windows.devices.pointofservice/barcodesymbologies_italianpost39.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost39 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost39 ## -description Gets the Italian Post 39 barcode symbology. ## -property-value The Italian Post 39 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost39 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.ItalianPost39 + +## -description +Gets the Italian Post 39 barcode symbology. + +## -property-value +The Italian Post 39 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_japanpost.md b/windows.devices.pointofservice/barcodesymbologies_japanpost.md index 18a8035dd2..50b6e226f4 100644 --- a/windows.devices.pointofservice/barcodesymbologies_japanpost.md +++ b/windows.devices.pointofservice/barcodesymbologies_japanpost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.JapanPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.JapanPost ## -description Gets the Japan Postal barcode symbology. ## -property-value The Japan Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.JapanPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.JapanPost + +## -description +Gets the Japan Postal barcode symbology. + +## -property-value +The Japan Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_koreanpost.md b/windows.devices.pointofservice/barcodesymbologies_koreanpost.md index 3726297e5d..93f018bf4e 100644 --- a/windows.devices.pointofservice/barcodesymbologies_koreanpost.md +++ b/windows.devices.pointofservice/barcodesymbologies_koreanpost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.KoreanPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.KoreanPost ## -description Gets the Korea Postal barcode symbology. ## -property-value The Korea Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.KoreanPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.KoreanPost + +## -description +Gets the Korea Postal barcode symbology. + +## -property-value +The Korea Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_maxicode.md b/windows.devices.pointofservice/barcodesymbologies_maxicode.md index 7f26bc994d..88ea266ca7 100644 --- a/windows.devices.pointofservice/barcodesymbologies_maxicode.md +++ b/windows.devices.pointofservice/barcodesymbologies_maxicode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Maxicode --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Maxicode ## -description Gets the MaxiCode barcode symbology. ## -property-value The MaxiCode barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Maxicode +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Maxicode + +## -description +Gets the MaxiCode barcode symbology. + +## -property-value +The MaxiCode barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_micr.md b/windows.devices.pointofservice/barcodesymbologies_micr.md index 3de7b2b91b..06dbc9fa69 100644 --- a/windows.devices.pointofservice/barcodesymbologies_micr.md +++ b/windows.devices.pointofservice/barcodesymbologies_micr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Micr --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Micr ## -description Gets the Magnetic Ink Character Recognition (MICR) barcode symbology. ## -property-value The Magnetic Ink Character Recognition (MICR) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Micr +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Micr + +## -description +Gets the Magnetic Ink Character Recognition (MICR) barcode symbology. + +## -property-value +The Magnetic Ink Character Recognition (MICR) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_micropdf417.md b/windows.devices.pointofservice/barcodesymbologies_micropdf417.md index 866dbd279a..e25e7cb83c 100644 --- a/windows.devices.pointofservice/barcodesymbologies_micropdf417.md +++ b/windows.devices.pointofservice/barcodesymbologies_micropdf417.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.MicroPdf417 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.MicroPdf417 ## -description Gets the Micro PDF 417 barcode symbology. ## -property-value The Micro PDF 417 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.MicroPdf417 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.MicroPdf417 + +## -description +Gets the Micro PDF 417 barcode symbology. + +## -property-value +The Micro PDF 417 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_microqr.md b/windows.devices.pointofservice/barcodesymbologies_microqr.md index 21c5450455..3eb0e11f55 100644 --- a/windows.devices.pointofservice/barcodesymbologies_microqr.md +++ b/windows.devices.pointofservice/barcodesymbologies_microqr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.MicroQr --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.MicroQr ## -description Gets the Micro QR Code barcode symbology. ## -property-value The Micro QR Code barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.MicroQr +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.MicroQr + +## -description +Gets the Micro QR Code barcode symbology. + +## -property-value +The Micro QR Code barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_msi.md b/windows.devices.pointofservice/barcodesymbologies_msi.md index badff82d3d..74dc90b603 100644 --- a/windows.devices.pointofservice/barcodesymbologies_msi.md +++ b/windows.devices.pointofservice/barcodesymbologies_msi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Msi --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Msi ## -description Gets the MSI barcode symbology. ## -property-value The MSI barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Msi +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Msi + +## -description +Gets the MSI barcode symbology. + +## -property-value +The MSI barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_mstag.md b/windows.devices.pointofservice/barcodesymbologies_mstag.md index aeb8881de6..a619e3f9fd 100644 --- a/windows.devices.pointofservice/barcodesymbologies_mstag.md +++ b/windows.devices.pointofservice/barcodesymbologies_mstag.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.MsTag --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.MsTag ## -description Gets the Microsoft tag barcode symbology. ## -property-value The Microsoft tag barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.MsTag +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.MsTag + +## -description +Gets the Microsoft tag barcode symbology. + +## -property-value +The Microsoft tag barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ocra.md b/windows.devices.pointofservice/barcodesymbologies_ocra.md index f4ada18275..cd39c7fd9a 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ocra.md +++ b/windows.devices.pointofservice/barcodesymbologies_ocra.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.OcrA --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.OcrA ## -description Gets the OCR-A barcode symbology. ## -property-value The OCR-A barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.OcrA +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.OcrA + +## -description +Gets the OCR-A barcode symbology. + +## -property-value +The OCR-A barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ocrb.md b/windows.devices.pointofservice/barcodesymbologies_ocrb.md index 5d87eb5222..5fa8516a4a 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ocrb.md +++ b/windows.devices.pointofservice/barcodesymbologies_ocrb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.OcrB --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.OcrB ## -description Gets the OCR-B barcode symbology. ## -property-value The OCR-B barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.OcrB +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.OcrB + +## -description +Gets the OCR-B barcode symbology. + +## -property-value +The OCR-B barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_pdf417.md b/windows.devices.pointofservice/barcodesymbologies_pdf417.md index 03933279d3..4a310e4b74 100644 --- a/windows.devices.pointofservice/barcodesymbologies_pdf417.md +++ b/windows.devices.pointofservice/barcodesymbologies_pdf417.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Pdf417 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Pdf417 ## -description Gets the PDF 417 barcode symbology. ## -property-value The PDF 417 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Pdf417 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Pdf417 + +## -description +Gets the PDF 417 barcode symbology. + +## -property-value +The PDF 417 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_plessey.md b/windows.devices.pointofservice/barcodesymbologies_plessey.md index 43161ec97b..e2d7b4490c 100644 --- a/windows.devices.pointofservice/barcodesymbologies_plessey.md +++ b/windows.devices.pointofservice/barcodesymbologies_plessey.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Plessey --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Plessey ## -description Gets the Plessey barcode symbology. ## -property-value The Plessey barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Plessey +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Plessey + +## -description +Gets the Plessey barcode symbology. + +## -property-value +The Plessey barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_pzn.md b/windows.devices.pointofservice/barcodesymbologies_pzn.md index 939bdeeb07..995c28b722 100644 --- a/windows.devices.pointofservice/barcodesymbologies_pzn.md +++ b/windows.devices.pointofservice/barcodesymbologies_pzn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Pzn --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Pzn ## -description Gets the Pharma-Zentral-Nummer (Pzn) barcode symbology. ## -property-value The Pharma-Zentral-Nummer (Pzn) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Pzn +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Pzn + +## -description +Gets the Pharma-Zentral-Nummer (Pzn) barcode symbology. + +## -property-value +The Pharma-Zentral-Nummer (Pzn) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_qr.md b/windows.devices.pointofservice/barcodesymbologies_qr.md index d869c8fbf3..ce53a14488 100644 --- a/windows.devices.pointofservice/barcodesymbologies_qr.md +++ b/windows.devices.pointofservice/barcodesymbologies_qr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Qr --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Qr ## -description Gets the Quick Response (QR) Code barcode symbology. ## -property-value The Quick Response (QR) Code barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Qr +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Qr + +## -description +Gets the Quick Response (QR) Code barcode symbology. + +## -property-value +The Quick Response (QR) Code barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_sisac.md b/windows.devices.pointofservice/barcodesymbologies_sisac.md index cbfd7228c1..479f1fc3c5 100644 --- a/windows.devices.pointofservice/barcodesymbologies_sisac.md +++ b/windows.devices.pointofservice/barcodesymbologies_sisac.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Sisac --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Sisac ## -description Gets the Serials Industry Systems Advisory Committee (SISAC) barcode symbology. ## -property-value The Serials Industry Systems Advisory Committee (SISAC) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Sisac +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Sisac + +## -description +Gets the Serials Industry Systems Advisory Committee (SISAC) barcode symbology. + +## -property-value +The Serials Industry Systems Advisory Committee (SISAC) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_swedenpost.md b/windows.devices.pointofservice/barcodesymbologies_swedenpost.md index 981fb1654f..be01ee1b09 100644 --- a/windows.devices.pointofservice/barcodesymbologies_swedenpost.md +++ b/windows.devices.pointofservice/barcodesymbologies_swedenpost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.SwedenPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.SwedenPost ## -description Gets the Sweden Postal barcode symbology. ## -property-value The Sweden Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.SwedenPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.SwedenPost + +## -description +Gets the Sweden Postal barcode symbology. + +## -property-value +The Sweden Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_telepen.md b/windows.devices.pointofservice/barcodesymbologies_telepen.md index e035c51336..f494f60869 100644 --- a/windows.devices.pointofservice/barcodesymbologies_telepen.md +++ b/windows.devices.pointofservice/barcodesymbologies_telepen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Telepen --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Telepen ## -description Gets the Telepen barcode symbology. ## -property-value The Telepen barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Telepen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Telepen + +## -description +Gets the Telepen barcode symbology. + +## -property-value +The Telepen barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tfdis.md b/windows.devices.pointofservice/barcodesymbologies_tfdis.md index 9387476965..e1384b9a40 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tfdis.md +++ b/windows.devices.pointofservice/barcodesymbologies_tfdis.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfDis --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.TfDis ## -description Gets the Discreet 2 of 5 barcode symbology. ## -property-value The Discreet 2 of 5 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfDis +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.TfDis + +## -description +Gets the Discreet 2 of 5 barcode symbology. + +## -property-value +The Discreet 2 of 5 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tfiata.md b/windows.devices.pointofservice/barcodesymbologies_tfiata.md index 376fa69175..5853db200c 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tfiata.md +++ b/windows.devices.pointofservice/barcodesymbologies_tfiata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfIata --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.TfIata ## -description Gets the 2 of 5 International Air Transportation Association (IATA) barcode symbology. ## -property-value The 2 of 5 International Air Transportation Association (IATA) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfIata +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.TfIata + +## -description +Gets the 2 of 5 International Air Transportation Association (IATA) barcode symbology. + +## -property-value +The 2 of 5 International Air Transportation Association (IATA) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tfind.md b/windows.devices.pointofservice/barcodesymbologies_tfind.md index fa1f071115..35d11d072a 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tfind.md +++ b/windows.devices.pointofservice/barcodesymbologies_tfind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfInd --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.TfInd ## -description Gets the Industrial 2 of 5 barcode symbology. ## -property-value The Industrial 2 of 5 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfInd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.TfInd + +## -description +Gets the Industrial 2 of 5 barcode symbology. + +## -property-value +The Industrial 2 of 5 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tfint.md b/windows.devices.pointofservice/barcodesymbologies_tfint.md index ea09c483df..3bc8a0a5d3 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tfint.md +++ b/windows.devices.pointofservice/barcodesymbologies_tfint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfInt --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.TfInt ## -description Gets the Interleaved 2 of 5 barcode symbology. ## -property-value The Interleaved 2 of 5 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfInt +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.TfInt + +## -description +Gets the Interleaved 2 of 5 barcode symbology. + +## -property-value +The Interleaved 2 of 5 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tfmat.md b/windows.devices.pointofservice/barcodesymbologies_tfmat.md index 9b03a0e060..26169600a5 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tfmat.md +++ b/windows.devices.pointofservice/barcodesymbologies_tfmat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfMat --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.TfMat ## -description Gets the 2 of 5 Matrix barcode symbology. ## -property-value The 2 of 5 Matrix barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfMat +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.TfMat + +## -description +Gets the 2 of 5 Matrix barcode symbology. + +## -property-value +The 2 of 5 Matrix barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tfstd.md b/windows.devices.pointofservice/barcodesymbologies_tfstd.md index 7d3fb15d37..5da6a56ce6 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tfstd.md +++ b/windows.devices.pointofservice/barcodesymbologies_tfstd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfStd --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.TfStd ## -description Gets the Standard 2 of 5 barcode symbology. ## -property-value The Standard 2 of 5 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.TfStd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.TfStd + +## -description +Gets the Standard 2 of 5 barcode symbology. + +## -property-value +The Standard 2 of 5 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_tlc39.md b/windows.devices.pointofservice/barcodesymbologies_tlc39.md index 6a4ff645d2..91a66085f6 100644 --- a/windows.devices.pointofservice/barcodesymbologies_tlc39.md +++ b/windows.devices.pointofservice/barcodesymbologies_tlc39.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Tlc39 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Tlc39 ## -description Gets the TLC 39 barcode symbology. ## -property-value The TLC 39 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Tlc39 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Tlc39 + +## -description +Gets the TLC 39 barcode symbology. + +## -property-value +The TLC 39 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_trioptic39.md b/windows.devices.pointofservice/barcodesymbologies_trioptic39.md index 32617df086..000b1402b3 100644 --- a/windows.devices.pointofservice/barcodesymbologies_trioptic39.md +++ b/windows.devices.pointofservice/barcodesymbologies_trioptic39.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Trioptic39 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Trioptic39 ## -description Gets the Tri-Optic Media Storage Devices barcode symbology. ## -property-value The Tri-Optic Media Storage Devices barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Trioptic39 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Trioptic39 + +## -description +Gets the Tri-Optic Media Storage Devices barcode symbology. + +## -property-value +The Tri-Optic Media Storage Devices barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_uccean128.md b/windows.devices.pointofservice/barcodesymbologies_uccean128.md index 01f48d2863..f0167d6bb7 100644 --- a/windows.devices.pointofservice/barcodesymbologies_uccean128.md +++ b/windows.devices.pointofservice/barcodesymbologies_uccean128.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UccEan128 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UccEan128 ## -description Gets the UCC/EAN 128 barcode symbology. ## -property-value The UCC/EAN 128 barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UccEan128 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UccEan128 + +## -description +Gets the UCC/EAN 128 barcode symbology. + +## -property-value +The UCC/EAN 128 barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_ukpost.md b/windows.devices.pointofservice/barcodesymbologies_ukpost.md index cbfb45524e..d62d29c7ef 100644 --- a/windows.devices.pointofservice/barcodesymbologies_ukpost.md +++ b/windows.devices.pointofservice/barcodesymbologies_ukpost.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UkPost --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UkPost ## -description Gets the UK Postal barcode symbology. ## -property-value The UK Postal barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UkPost +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UkPost + +## -description +Gets the UK Postal barcode symbology. + +## -property-value +The UK Postal barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_unknown.md b/windows.devices.pointofservice/barcodesymbologies_unknown.md index b0adc8597a..fadb273a29 100644 --- a/windows.devices.pointofservice/barcodesymbologies_unknown.md +++ b/windows.devices.pointofservice/barcodesymbologies_unknown.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Unknown --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Unknown ## -description Unknown barcode symbology. ## -property-value Unknown barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Unknown +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Unknown + +## -description +Unknown barcode symbology. + +## -property-value +Unknown barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upca.md b/windows.devices.pointofservice/barcodesymbologies_upca.md index dbecfea612..47f533f023 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upca.md +++ b/windows.devices.pointofservice/barcodesymbologies_upca.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Upca --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Upca ## -description Gets the Universal Product Code (UPC) version A barcode symbology. ## -property-value The Universal Product Code (UPC) version A barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Upca +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Upca + +## -description +Gets the Universal Product Code (UPC) version A barcode symbology. + +## -property-value +The Universal Product Code (UPC) version A barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upcaadd2.md b/windows.devices.pointofservice/barcodesymbologies_upcaadd2.md index 3f9903aba9..426a94040c 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upcaadd2.md +++ b/windows.devices.pointofservice/barcodesymbologies_upcaadd2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd2 ## -description Gets the UPC A with 2 digit supplemental barcode symbology. ## -property-value The UPC A with 2 digit supplemental barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd2 + +## -description +Gets the UPC A with 2 digit supplemental barcode symbology. + +## -property-value +The UPC A with 2 digit supplemental barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upcaadd5.md b/windows.devices.pointofservice/barcodesymbologies_upcaadd5.md index cc9141e06f..da1fb9bd21 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upcaadd5.md +++ b/windows.devices.pointofservice/barcodesymbologies_upcaadd5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd5 ## -description Gets the UPC A with 5 digit supplement barcode symbology. ## -property-value The UPC A with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UpcaAdd5 + +## -description +Gets the UPC A with 5 digit supplement barcode symbology. + +## -property-value +The UPC A with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upccoupon.md b/windows.devices.pointofservice/barcodesymbologies_upccoupon.md index 10b5f4ac8f..b798a12f63 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upccoupon.md +++ b/windows.devices.pointofservice/barcodesymbologies_upccoupon.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpcCoupon --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UpcCoupon ## -description Gets the UPC Coupon with supplemental barcode symbology. ## -property-value The UPC Coupon with supplemental barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpcCoupon +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UpcCoupon + +## -description +Gets the UPC Coupon with supplemental barcode symbology. + +## -property-value +The UPC Coupon with supplemental barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upce.md b/windows.devices.pointofservice/barcodesymbologies_upce.md index d2b695498d..6d03a58d27 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upce.md +++ b/windows.devices.pointofservice/barcodesymbologies_upce.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Upce --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Upce ## -description Gets the Universal Product Code (UPC) version E barcode symbology. ## -property-value The Universal Product Code (UPC) version E barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Upce +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Upce + +## -description +Gets the Universal Product Code (UPC) version E barcode symbology. + +## -property-value +The Universal Product Code (UPC) version E barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upceadd2.md b/windows.devices.pointofservice/barcodesymbologies_upceadd2.md index 6308d06ba3..9087c85b1e 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upceadd2.md +++ b/windows.devices.pointofservice/barcodesymbologies_upceadd2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd2 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd2 ## -description Gets the UPC-E with 2 digit supplemnent barcode symbology. ## -property-value The UPC-E with 2 digit supplemnent barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd2 + +## -description +Gets the UPC-E with 2 digit supplemnent barcode symbology. + +## -property-value +The UPC-E with 2 digit supplemnent barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_upceadd5.md b/windows.devices.pointofservice/barcodesymbologies_upceadd5.md index 7bf57a0bdf..a8a6412eac 100644 --- a/windows.devices.pointofservice/barcodesymbologies_upceadd5.md +++ b/windows.devices.pointofservice/barcodesymbologies_upceadd5.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd5 --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd5 ## -description Gets the UPC-E with 5 digit supplement barcode symbology. ## -property-value The UPC-E with 5 digit supplement barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd5 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UpceAdd5 + +## -description +Gets the UPC-E with 5 digit supplement barcode symbology. + +## -property-value +The UPC-E with 5 digit supplement barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_us4statefics.md b/windows.devices.pointofservice/barcodesymbologies_us4statefics.md index 4388f13ccd..0d9125b438 100644 --- a/windows.devices.pointofservice/barcodesymbologies_us4statefics.md +++ b/windows.devices.pointofservice/barcodesymbologies_us4statefics.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Us4StateFics --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.Us4StateFics ## -description Gets the United States Postal Service 4-State Flat Mail Identification Code Sort (FICS) barcode symbology. ## -property-value The United States Postal Service 4-State Flat Mail Identification Code Sort (FICS) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Us4StateFics +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Us4StateFics + +## -description +Gets the United States Postal Service 4-State Flat Mail Identification Code Sort (FICS) barcode symbology. + +## -property-value +The United States Postal Service 4-State Flat Mail Identification Code Sort (FICS) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_usintelligent.md b/windows.devices.pointofservice/barcodesymbologies_usintelligent.md index fd14d319a6..1942b42c89 100644 --- a/windows.devices.pointofservice/barcodesymbologies_usintelligent.md +++ b/windows.devices.pointofservice/barcodesymbologies_usintelligent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligent --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligent ## -description Gets the United States Postal Service (USPS) Intelligent Mail barcode symbology. ## -property-value The United States Postal Service (USPS) Intelligent Mail barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligent +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligent + +## -description +Gets the United States Postal Service (USPS) Intelligent Mail barcode symbology. + +## -property-value +The United States Postal Service (USPS) Intelligent Mail barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_usintelligentpkg.md b/windows.devices.pointofservice/barcodesymbologies_usintelligentpkg.md index 5616d35256..05bb0d166e 100644 --- a/windows.devices.pointofservice/barcodesymbologies_usintelligentpkg.md +++ b/windows.devices.pointofservice/barcodesymbologies_usintelligentpkg.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligentPkg --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligentPkg ## -description Gets the United States Postal Service (USPS) Intelligent Mail Package barcode symbology. ## -property-value The United States Postal Service (USPS) Intelligent Mail Package barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligentPkg +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UsIntelligentPkg + +## -description +Gets the United States Postal Service (USPS) Intelligent Mail Package barcode symbology. + +## -property-value +The United States Postal Service (USPS) Intelligent Mail Package barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_usplanet.md b/windows.devices.pointofservice/barcodesymbologies_usplanet.md index b6ac4b1849..a2efa09ab9 100644 --- a/windows.devices.pointofservice/barcodesymbologies_usplanet.md +++ b/windows.devices.pointofservice/barcodesymbologies_usplanet.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsPlanet --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UsPlanet ## -description Gets the United States Postal Service PLANET barcode symbology. ## -property-value The United States Postal Service PLANET barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsPlanet +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UsPlanet + +## -description +Gets the United States Postal Service PLANET barcode symbology. + +## -property-value +The United States Postal Service PLANET barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies_uspostnet.md b/windows.devices.pointofservice/barcodesymbologies_uspostnet.md index 362b746e36..80b5a693b9 100644 --- a/windows.devices.pointofservice/barcodesymbologies_uspostnet.md +++ b/windows.devices.pointofservice/barcodesymbologies_uspostnet.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsPostNet --api-type: winrt property ---- # Windows.Devices.PointOfService.BarcodeSymbologies.UsPostNet ## -description Gets the United States Postal Numeric Encoding Technique (POSTNET) barcode symbology. ## -property-value The United States Postal Numeric Encoding Technique (POSTNET) barcode symbology. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.UsPostNet +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.UsPostNet + +## -description +Gets the United States Postal Numeric Encoding Technique (POSTNET) barcode symbology. + +## -property-value +The United States Postal Numeric Encoding Technique (POSTNET) barcode symbology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer.md b/windows.devices.pointofservice/cashdrawer.md index 340534d942..38c97c76ba 100644 --- a/windows.devices.pointofservice/cashdrawer.md +++ b/windows.devices.pointofservice/cashdrawer.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawer --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawer ## -description A cash drawer device in a retail scenario. ## -remarks To get a [CashDrawer](cashdrawer.md) object, use the [FromIdAsync](cashdrawer_fromidasync.md) or [GetDefaultAsync](posprinter_getdefaultasync.md) static methods. ## -examples ## -see-also [FromIdAsync](cashdrawer_fromidasync.md), [GetDefaultAsync](posprinter_getdefaultasync.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawer +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawer + +## -description +A cash drawer device in a retail scenario. + +## -remarks +To get a [CashDrawer](cashdrawer.md) object, use the [FromIdAsync](cashdrawer_fromidasync.md) or [GetDefaultAsync](posprinter_getdefaultasync.md) static methods. + +## -examples + +## -see-also +[FromIdAsync](cashdrawer_fromidasync.md), [GetDefaultAsync](posprinter_getdefaultasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/cashdrawer_capabilities.md b/windows.devices.pointofservice/cashdrawer_capabilities.md index d72490cba9..15cee3184c 100644 --- a/windows.devices.pointofservice/cashdrawer_capabilities.md +++ b/windows.devices.pointofservice/cashdrawer_capabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawer.Capabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawer.Capabilities ## -description The functionality of the cash drawer device as exposed by API. ## -property-value The functionality of the cash drawer device as exposed by API. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawer.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawer.Capabilities + +## -description +The functionality of the cash drawer device as exposed by API. + +## -property-value +The functionality of the cash drawer device as exposed by API. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_checkhealthasync_1543183748.md b/windows.devices.pointofservice/cashdrawer_checkhealthasync_1543183748.md index ce7c7ade33..60c48562a1 100644 --- a/windows.devices.pointofservice/cashdrawer_checkhealthasync_1543183748.md +++ b/windows.devices.pointofservice/cashdrawer_checkhealthasync_1543183748.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawer.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawer.CheckHealthAsync ## -description Gets the device's health state asynchronously. ## -parameters ### -param level The specified health check level. ## -returns This value is intended to be reflected in the app interface immediately so the user of the app can interpret it. For example, it will return “OK” as the health string if the device state is good. ## -remarks This feature behaves identically to corresponding features in the other POS peripherals, and support for this operation is required by the UPOS standard. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.CheckHealthAsync + +## -description +Gets the device's health state asynchronously. + +## -parameters +### -param level +The specified health check level. + +## -returns +This value is intended to be reflected in the app interface immediately so the user of the app can interpret it. For example, it will return “OK” as the health string if the device state is good. + +## -remarks +This feature behaves identically to corresponding features in the other POS peripherals, and support for this operation is required by the UPOS standard. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_claimdrawerasync_887994265.md b/windows.devices.pointofservice/cashdrawer_claimdrawerasync_887994265.md index d1a077df88..fece049b5c 100644 --- a/windows.devices.pointofservice/cashdrawer_claimdrawerasync_887994265.md +++ b/windows.devices.pointofservice/cashdrawer_claimdrawerasync_887994265.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawer.ClaimDrawerAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawer.ClaimDrawerAsync ## -description Attempts to get exclusive access on the cash drawer. ## -returns When the method completes, it returns a [ClaimedCashDrawer](claimedcashdrawer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.ClaimDrawerAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.ClaimDrawerAsync + +## -description +Attempts to get exclusive access on the cash drawer. + +## -returns +When the method completes, it returns a [ClaimedCashDrawer](claimedcashdrawer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_deviceid.md b/windows.devices.pointofservice/cashdrawer_deviceid.md index f7c75eb5f1..79b6317a27 100644 --- a/windows.devices.pointofservice/cashdrawer_deviceid.md +++ b/windows.devices.pointofservice/cashdrawer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawer.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawer.DeviceId ## -description The identifier string of the cash drawer device. ## -property-value String representing the ID of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawer.DeviceId + +## -description +The identifier string of the cash drawer device. + +## -property-value +String representing the ID of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_drawereventsource.md b/windows.devices.pointofservice/cashdrawer_drawereventsource.md index 1b3a5bc782..50377a4b80 100644 --- a/windows.devices.pointofservice/cashdrawer_drawereventsource.md +++ b/windows.devices.pointofservice/cashdrawer_drawereventsource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawer.DrawerEventSource --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawer.DrawerEventSource ## -description Gets the [CashDrawerEventSource](cashdrawereventsource.md) to allow the app to detect the open/close state of the drawer. The actual current state is reported by [IsDrawerOpen.](cashdrawer_isdraweropen.md). ## -property-value The cash drawer event source. If the drawer does not support open/close detection, then it will return null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawer.DrawerEventSource +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawer.DrawerEventSource + +## -description +Gets the [CashDrawerEventSource](cashdrawereventsource.md) to allow the app to detect the open/close state of the drawer. The actual current state is reported by [IsDrawerOpen.](cashdrawer_isdraweropen.md). + +## -property-value +The cash drawer event source. If the drawer does not support open/close detection, then it will return null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_fromidasync_1322863552.md b/windows.devices.pointofservice/cashdrawer_fromidasync_1322863552.md index d0ff6c8388..15b6be36ab 100644 --- a/windows.devices.pointofservice/cashdrawer_fromidasync_1322863552.md +++ b/windows.devices.pointofservice/cashdrawer_fromidasync_1322863552.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawer.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawer.FromIdAsync ## -description Creates [CashDrawer](cashdrawer.md) object from the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). ## -parameters ### -param deviceId The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific cash drawer, which can be retrieved from the [DeviceId](barcodescanner_deviceid.md) property. ## -returns The cash drawer specified by the unique device identifier. Returns a null object in the following cases: + The specific device is not found. + Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.FromIdAsync + +## -description +Creates [CashDrawer](cashdrawer.md) object from the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific cash drawer, which can be retrieved from the [DeviceId](barcodescanner_deviceid.md) property. + +## -returns +The cash drawer specified by the unique device identifier. Returns a null object in the following cases: ++ The specific device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_getdefaultasync_1549573963.md b/windows.devices.pointofservice/cashdrawer_getdefaultasync_1549573963.md index 0e125cdf05..fbb362687a 100644 --- a/windows.devices.pointofservice/cashdrawer_getdefaultasync_1549573963.md +++ b/windows.devices.pointofservice/cashdrawer_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawer.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawer.GetDefaultAsync ## -description Gets the default paired or locally-connected cash drawer. ## -returns The default locally-connected drawer. May return null if there is no drawer available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.GetDefaultAsync + +## -description +Gets the default paired or locally-connected cash drawer. + +## -returns +The default locally-connected drawer. May return null if there is no drawer available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_getdeviceselector_838466080.md b/windows.devices.pointofservice/cashdrawer_getdeviceselector_838466080.md index 2bfdbd4c6a..df9eaf679b 100644 --- a/windows.devices.pointofservice/cashdrawer_getdeviceselector_838466080.md +++ b/windows.devices.pointofservice/cashdrawer_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawer.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawer.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that you can use to list the available cash drawers. ## -returns An Advanced Query Syntax (AQS) string that is used to enumerate available cash drawers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the available cash drawers. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate available cash drawers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_getstatisticsasync_980600774.md b/windows.devices.pointofservice/cashdrawer_getstatisticsasync_980600774.md index fe06aef9b6..b7d91868fa 100644 --- a/windows.devices.pointofservice/cashdrawer_getstatisticsasync_980600774.md +++ b/windows.devices.pointofservice/cashdrawer_getstatisticsasync_980600774.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawer.GetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawer.GetStatisticsAsync ## -description Retrieves the requested statistics from the cash drawer. ## -parameters ### -param statisticsCategories The list of statistics to retrieve. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and groups names ("name3", "U_", "M_"). ## -returns String representing the requested statistics. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.GetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.GetStatisticsAsync + +## -description +Retrieves the requested statistics from the cash drawer. + +## -parameters +### -param statisticsCategories +The list of statistics to retrieve. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and groups names ("name3", "U_", "M_"). + + +## -returns +String representing the requested statistics. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_isdraweropen.md b/windows.devices.pointofservice/cashdrawer_isdraweropen.md index 26c1026421..995e4dda5d 100644 --- a/windows.devices.pointofservice/cashdrawer_isdraweropen.md +++ b/windows.devices.pointofservice/cashdrawer_isdraweropen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawer.IsDrawerOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawer.IsDrawerOpen ## -description Indicates whether the cash drawer is open. ## -property-value True if the drawer is open, otherwise false. ## -remarks ## -examples ## -see-also [CashDrawerCapabilities.IsDrawerOpenSensorAvailable](cashdrawercapabilities_isdraweropensensoravailable.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawer.IsDrawerOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawer.IsDrawerOpen + +## -description +Indicates whether the cash drawer is open. + +## -property-value +True if the drawer is open, otherwise false. + +## -remarks + +## -examples + +## -see-also +[CashDrawerCapabilities.IsDrawerOpenSensorAvailable](cashdrawercapabilities_isdraweropensensoravailable.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/cashdrawer_status.md b/windows.devices.pointofservice/cashdrawer_status.md index aea07610cd..a6cf005144 100644 --- a/windows.devices.pointofservice/cashdrawer_status.md +++ b/windows.devices.pointofservice/cashdrawer_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawer.Status --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawer.Status ## -description Get the current power and availability status of the cash drawer. ## -property-value The cash drawer status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawer.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawer.Status + +## -description +Get the current power and availability status of the cash drawer. + +## -property-value +The cash drawer status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawer_statusupdated.md b/windows.devices.pointofservice/cashdrawer_statusupdated.md index 3d394229ec..f967133205 100644 --- a/windows.devices.pointofservice/cashdrawer_statusupdated.md +++ b/windows.devices.pointofservice/cashdrawer_statusupdated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.CashDrawer.StatusUpdated --api-type: winrt event ---- # Windows.Devices.PointOfService.CashDrawer.StatusUpdated ## -description Indicates there has been a change in the power availability status of the drawer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.CashDrawer.StatusUpdated +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.CashDrawer.StatusUpdated + +## -description +Indicates there has been a change in the power availability status of the drawer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawercapabilities.md b/windows.devices.pointofservice/cashdrawercapabilities.md index 65033b37ce..482ec1e4aa 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities.md +++ b/windows.devices.pointofservice/cashdrawercapabilities.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerCapabilities ## -description Represents the cash drawer capabilities. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities + +## -description +Represents the cash drawer capabilities. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawercapabilities_isdraweropensensoravailable.md b/windows.devices.pointofservice/cashdrawercapabilities_isdraweropensensoravailable.md index 50633ed8ec..1e2764a324 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities_isdraweropensensoravailable.md +++ b/windows.devices.pointofservice/cashdrawercapabilities_isdraweropensensoravailable.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsDrawerOpenSensorAvailable --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCapabilities.IsDrawerOpenSensorAvailable ## -description Indicated whether cash drawer open sensor is available. ## -property-value True if the sensor is available, otherwise false. ## -remarks ## -examples ## -see-also [CashDrawer.IsDrawerOpen](cashdrawer_isdraweropen.md), [ClaimedCashDrawer.CloseAlarm](claimedcashdrawer_closealarm.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsDrawerOpenSensorAvailable +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities.IsDrawerOpenSensorAvailable + +## -description +Indicated whether cash drawer open sensor is available. + +## -property-value +True if the sensor is available, otherwise false. + +## -remarks + +## -examples + +## -see-also +[CashDrawer.IsDrawerOpen](cashdrawer_isdraweropen.md), [ClaimedCashDrawer.CloseAlarm](claimedcashdrawer_closealarm.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsreportingsupported.md b/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsreportingsupported.md index 603dc99b6e..d5110e320e 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsreportingsupported.md +++ b/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsreportingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsReportingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsReportingSupported ## -description Whether statistics reporting is supported by the cash drawer. ## -property-value True if statistics reporting is supported by the cash drawer; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsReportingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsReportingSupported + +## -description +Whether statistics reporting is supported by the cash drawer. + +## -property-value +True if statistics reporting is supported by the cash drawer; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsupdatingsupported.md b/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsupdatingsupported.md index d79675f03d..fb0f45869e 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsupdatingsupported.md +++ b/windows.devices.pointofservice/cashdrawercapabilities_isstatisticsupdatingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsUpdatingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsUpdatingSupported ## -description Whether statistics updating is supported by the cash drawer. ## -property-value True if statistics updating is supported by the cash drawer; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsUpdatingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatisticsUpdatingSupported + +## -description +Whether statistics updating is supported by the cash drawer. + +## -property-value +True if statistics updating is supported by the cash drawer; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawercapabilities_isstatusmultidrawerdetectsupported.md b/windows.devices.pointofservice/cashdrawercapabilities_isstatusmultidrawerdetectsupported.md index ccafb48472..f2d6672986 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities_isstatusmultidrawerdetectsupported.md +++ b/windows.devices.pointofservice/cashdrawercapabilities_isstatusmultidrawerdetectsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusMultiDrawerDetectSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusMultiDrawerDetectSupported ## -description Whether the status from multiple drawers is supported. ## -property-value True if multiple drawer detection is supported, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusMultiDrawerDetectSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusMultiDrawerDetectSupported + +## -description +Whether the status from multiple drawers is supported. + +## -property-value +True if multiple drawer detection is supported, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawercapabilities_isstatusreportingsupported.md b/windows.devices.pointofservice/cashdrawercapabilities_isstatusreportingsupported.md index 1184aca6fb..bbf18d0a9d 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities_isstatusreportingsupported.md +++ b/windows.devices.pointofservice/cashdrawercapabilities_isstatusreportingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusReportingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusReportingSupported ## -description Whether status reporting is supported by the cash drawer. ## -property-value True if status reporting is supported, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusReportingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities.IsStatusReportingSupported + +## -description +Whether status reporting is supported by the cash drawer. + +## -property-value +True if status reporting is supported, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawercapabilities_powerreportingtype.md b/windows.devices.pointofservice/cashdrawercapabilities_powerreportingtype.md index 172bb93b21..37a1061845 100644 --- a/windows.devices.pointofservice/cashdrawercapabilities_powerreportingtype.md +++ b/windows.devices.pointofservice/cashdrawercapabilities_powerreportingtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.PowerReportingType --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCapabilities.PowerReportingType ## -description Whether the cash drawer has standard or advanced power reporting. ## -property-value Defines the constants that indicates power reporting capabilities of the cash drawer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCapabilities.PowerReportingType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCapabilities.PowerReportingType + +## -description +Whether the cash drawer has standard or advanced power reporting. + +## -property-value +Defines the constants that indicates power reporting capabilities of the cash drawer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm.md b/windows.devices.pointofservice/cashdrawerclosealarm.md index f070e5e928..ca71430bbb 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerCloseAlarm --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm ## -description The cash drawer close alarm. Parameter defaults are provided, however the user can update them as appropriate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerCloseAlarm +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm + +## -description +The cash drawer close alarm. Parameter defaults are provided, however the user can update them as appropriate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeout.md b/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeout.md index d159e9fc04..ba12501191 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeout.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeout --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeout ## -description Gets or sets the alarm timeout for the cash drawer close alarm. ## -property-value Defines the amount of time for the alarm timeout. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeout + +## -description +Gets or sets the alarm timeout for the cash drawer close alarm. + +## -property-value +Defines the amount of time for the alarm timeout. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeoutexpired.md b/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeoutexpired.md index f42d7c60c6..856c35e08d 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeoutexpired.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm_alarmtimeoutexpired.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeoutExpired --api-type: winrt event ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeoutExpired ## -description Event allowing the app to be notified if the alarm timeout has been triggered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeoutExpired +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm.AlarmTimeoutExpired + +## -description +Event allowing the app to be notified if the alarm timeout has been triggered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm_beepdelay.md b/windows.devices.pointofservice/cashdrawerclosealarm_beepdelay.md index 22d46a7456..9651576b99 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm_beepdelay.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm_beepdelay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDelay --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDelay ## -description Delay between cash drawer closed alarm beeps. ## -property-value Defines the amount of time between beeps. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDelay +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDelay + +## -description +Delay between cash drawer closed alarm beeps. + +## -property-value +Defines the amount of time between beeps. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm_beepduration.md b/windows.devices.pointofservice/cashdrawerclosealarm_beepduration.md index 2ea29ede42..d10c0188b1 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm_beepduration.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm_beepduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDuration --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDuration ## -description Duration of the cash drawer close alarm beep. ## -property-value Defines the length of time the alarm beep sounds. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDuration +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepDuration + +## -description +Duration of the cash drawer close alarm beep. + +## -property-value +Defines the length of time the alarm beep sounds. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm_beepfrequency.md b/windows.devices.pointofservice/cashdrawerclosealarm_beepfrequency.md index 80a9fb7563..aa5973f90d 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm_beepfrequency.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm_beepfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepFrequency --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepFrequency ## -description Frequency of beep tone. ## -property-value Defines the audio frequency of the beep tone. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm.BeepFrequency + +## -description +Frequency of beep tone. + +## -property-value +Defines the audio frequency of the beep tone. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosealarm_startasync_1931900819.md b/windows.devices.pointofservice/cashdrawerclosealarm_startasync_1931900819.md index 02f2098c84..51c533a9fd 100644 --- a/windows.devices.pointofservice/cashdrawerclosealarm_startasync_1931900819.md +++ b/windows.devices.pointofservice/cashdrawerclosealarm_startasync_1931900819.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.CashDrawerCloseAlarm.StartAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.CashDrawerCloseAlarm.StartAsync ## -description Starts the alarm countdown, returning an awaitable object that completes when the cash drawer is closed. ## -returns True if the drawer has been closed; otherwise, false indicates a problem has occurred. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawerCloseAlarm.StartAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawerCloseAlarm.StartAsync + +## -description +Starts the alarm countdown, returning an awaitable object that completes when the cash drawer is closed. + +## -returns +True if the drawer has been closed; otherwise, false indicates a problem has occurred. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerclosedeventargs.md b/windows.devices.pointofservice/cashdrawerclosedeventargs.md index a27d718c15..aaa459b98d 100644 --- a/windows.devices.pointofservice/cashdrawerclosedeventargs.md +++ b/windows.devices.pointofservice/cashdrawerclosedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerClosedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerClosedEventArgs ## -description This object is passed as a parameter to the event handlers for the [DrawerClosed](cashdrawereventsource_drawerclosed.md) event. ## -remarks This object is created by the [DrawerClosed](cashdrawereventsource_drawerclosed.md) event and is returned as an argument by the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also [ICashDrawerEventSourceEventArgs](icashdrawereventsourceeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerClosedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerClosedEventArgs + +## -description +This object is passed as a parameter to the event handlers for the [DrawerClosed](cashdrawereventsource_drawerclosed.md) event. + +## -remarks +This object is created by the [DrawerClosed](cashdrawereventsource_drawerclosed.md) event and is returned as an argument by the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also +[ICashDrawerEventSourceEventArgs](icashdrawereventsourceeventargs.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/cashdrawerclosedeventargs_cashdrawer.md b/windows.devices.pointofservice/cashdrawerclosedeventargs_cashdrawer.md index 7bbc2d9dd2..f14a379e8e 100644 --- a/windows.devices.pointofservice/cashdrawerclosedeventargs_cashdrawer.md +++ b/windows.devices.pointofservice/cashdrawerclosedeventargs_cashdrawer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerClosedEventArgs.CashDrawer --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerClosedEventArgs.CashDrawer ## -description Gets the data associated with the [DrawerClosed](cashdrawereventsource_drawerclosed.md) event. ## -property-value The cash drawer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerClosedEventArgs.CashDrawer +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerClosedEventArgs.CashDrawer + +## -description +Gets the data associated with the [DrawerClosed](cashdrawereventsource_drawerclosed.md) event. + +## -property-value +The cash drawer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawereventsource.md b/windows.devices.pointofservice/cashdrawereventsource.md index fbf2c1fb3b..afd73550e3 100644 --- a/windows.devices.pointofservice/cashdrawereventsource.md +++ b/windows.devices.pointofservice/cashdrawereventsource.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerEventSource --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerEventSource ## -description Provides event sources that allow a developer to detect when the cash drawer is opened or closed. ## -remarks [CashDrawerEventSource](cashdrawereventsource.md) is created from [CashDrawer.DrawerEventSource](cashdrawer_drawereventsource.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerEventSource +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerEventSource + +## -description +Provides event sources that allow a developer to detect when the cash drawer is opened or closed. + +## -remarks +[CashDrawerEventSource](cashdrawereventsource.md) is created from [CashDrawer.DrawerEventSource](cashdrawer_drawereventsource.md). + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawereventsource_drawerclosed.md b/windows.devices.pointofservice/cashdrawereventsource_drawerclosed.md index 43816d76c5..1d6ba6d675 100644 --- a/windows.devices.pointofservice/cashdrawereventsource_drawerclosed.md +++ b/windows.devices.pointofservice/cashdrawereventsource_drawerclosed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.CashDrawerEventSource.DrawerClosed --api-type: winrt event ---- # Windows.Devices.PointOfService.CashDrawerEventSource.DrawerClosed ## -description Occurs when the cash drawer is closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.CashDrawerEventSource.DrawerClosed +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.CashDrawerEventSource.DrawerClosed + +## -description +Occurs when the cash drawer is closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawereventsource_draweropened.md b/windows.devices.pointofservice/cashdrawereventsource_draweropened.md index 5cf025f361..9d91a09d2f 100644 --- a/windows.devices.pointofservice/cashdrawereventsource_draweropened.md +++ b/windows.devices.pointofservice/cashdrawereventsource_draweropened.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.CashDrawerEventSource.DrawerOpened --api-type: winrt event ---- # Windows.Devices.PointOfService.CashDrawerEventSource.DrawerOpened ## -description Occurs when the cash drawer is opened. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.CashDrawerEventSource.DrawerOpened +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.CashDrawerEventSource.DrawerOpened + +## -description +Occurs when the cash drawer is opened. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdraweropenedeventargs.md b/windows.devices.pointofservice/cashdraweropenedeventargs.md index b0210b944d..b9b1d86a18 100644 --- a/windows.devices.pointofservice/cashdraweropenedeventargs.md +++ b/windows.devices.pointofservice/cashdraweropenedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerOpenedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerOpenedEventArgs ## -description This object is passed as a parameter to the event handlers for the [DrawerOpened](cashdrawereventsource_draweropened.md) event. ## -remarks This object is created by the [DrawerOpened](cashdrawereventsource_draweropened.md) event and is returned as an argument by the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also [ICashDrawerEventSourceEventArgs](icashdrawereventsourceeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerOpenedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerOpenedEventArgs + +## -description +This object is passed as a parameter to the event handlers for the [DrawerOpened](cashdrawereventsource_draweropened.md) event. + +## -remarks +This object is created by the [DrawerOpened](cashdrawereventsource_draweropened.md) event and is returned as an argument by the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also +[ICashDrawerEventSourceEventArgs](icashdrawereventsourceeventargs.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/cashdraweropenedeventargs_cashdrawer.md b/windows.devices.pointofservice/cashdraweropenedeventargs_cashdrawer.md index 0be6dbdef1..f67abadd43 100644 --- a/windows.devices.pointofservice/cashdraweropenedeventargs_cashdrawer.md +++ b/windows.devices.pointofservice/cashdraweropenedeventargs_cashdrawer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerOpenedEventArgs.CashDrawer --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerOpenedEventArgs.CashDrawer ## -description Gets the data associated with the [DrawerOpened](cashdrawereventsource_draweropened.md) event. ## -property-value The cash drawer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerOpenedEventArgs.CashDrawer +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerOpenedEventArgs.CashDrawer + +## -description +Gets the data associated with the [DrawerOpened](cashdrawereventsource_draweropened.md) event. + +## -property-value +The cash drawer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerstatus.md b/windows.devices.pointofservice/cashdrawerstatus.md index ee10e19c4f..a93df7d643 100644 --- a/windows.devices.pointofservice/cashdrawerstatus.md +++ b/windows.devices.pointofservice/cashdrawerstatus.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerStatus --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerStatus ## -description Provides the current power and availability status of the cash drawer. ## -remarks [CashDrawerStatus](cashdrawerstatus.md) comes from the [StatusUpdated](cashdrawer_statusupdated.md) event or from the [Status](cashdrawer_status.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerStatus +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerStatus + +## -description +Provides the current power and availability status of the cash drawer. + +## -remarks +[CashDrawerStatus](cashdrawerstatus.md) comes from the [StatusUpdated](cashdrawer_statusupdated.md) event or from the [Status](cashdrawer_status.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerstatus_extendedstatus.md b/windows.devices.pointofservice/cashdrawerstatus_extendedstatus.md index 0e30e3038f..cc85635574 100644 --- a/windows.devices.pointofservice/cashdrawerstatus_extendedstatus.md +++ b/windows.devices.pointofservice/cashdrawerstatus_extendedstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerStatus.ExtendedStatus --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerStatus.ExtendedStatus ## -description ExtendedStatus provides a way for a Point of Service driver or provider to send custom notifications to the app. ## -property-value Value representing the custom notification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerStatus.ExtendedStatus +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerStatus.ExtendedStatus + +## -description +ExtendedStatus provides a way for a Point of Service driver or provider to send custom notifications to the app. + +## -property-value +Value representing the custom notification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerstatus_statuskind.md b/windows.devices.pointofservice/cashdrawerstatus_statuskind.md index 118b0e5887..6e0bd1f614 100644 --- a/windows.devices.pointofservice/cashdrawerstatus_statuskind.md +++ b/windows.devices.pointofservice/cashdrawerstatus_statuskind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerStatus.StatusKind --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerStatus.StatusKind ## -description Gets the status kind for the cash drawer status. ## -property-value The status kind. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerStatus.StatusKind +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerStatus.StatusKind + +## -description +Gets the status kind for the cash drawer status. + +## -property-value +The status kind. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs.md b/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs.md index 2d80e5fe07..2a5231c58e 100644 --- a/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs.md +++ b/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs ## -description This object is passed as a parameter to the event handlers for the [StatusUpdated](cashdrawer_statusupdated.md) event. ## -remarks This object is created by the [StatusUpdated](cashdrawer_statusupdated.md) event and is returned as an argument by the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs + +## -description +This object is passed as a parameter to the event handlers for the [StatusUpdated](cashdrawer_statusupdated.md) event. + +## -remarks +This object is created by the [StatusUpdated](cashdrawer_statusupdated.md) event and is returned as an argument by the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs_status.md b/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs_status.md index 9583a1d8d0..b49c2cac52 100644 --- a/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs_status.md +++ b/windows.devices.pointofservice/cashdrawerstatusupdatedeventargs_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs.Status ## -description Gets the data associated with the [StatusUpdated](cashdrawer_statusupdated.md) event. ## -property-value The cash drawer status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.CashDrawerStatusUpdatedEventArgs.Status + +## -description +Gets the data associated with the [StatusUpdated](cashdrawer_statusupdated.md) event. + +## -property-value +The cash drawer status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner.md b/windows.devices.pointofservice/claimedbarcodescanner.md index 130dca571d..071e96cb8b 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner.md +++ b/windows.devices.pointofservice/claimedbarcodescanner.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedBarcodeScanner --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner ## -description Represents the claimed barcode scanner. ## -remarks The object is created when [ClaimScannerAsync](barcodescanner_claimscannerasync.md) method completes. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedBarcodeScanner +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner + +## -description +Represents the claimed barcode scanner. + +## -remarks +The object is created when [ClaimScannerAsync](barcodescanner_claimscannerasync.md) method completes. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedbarcodescanner_close_811482585.md b/windows.devices.pointofservice/claimedbarcodescanner_close_811482585.md index 105ae991bb..4f7f7b8678 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_close_811482585.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.Close --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.Close ## -description Releases exclusive claim to the barcode scanner. ## -remarks [Close](../windows.foundation/iclosable_close.md) methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.Close + +## -description +Releases exclusive claim to the barcode scanner. + +## -remarks +[Close](../windows.foundation/iclosable_close.md) methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_datareceived.md b/windows.devices.pointofservice/claimedbarcodescanner_datareceived.md index 5189019d41..5635faebf4 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_datareceived.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_datareceived.md @@ -1,37 +1,37 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.DataReceived --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedBarcodeScanner.DataReceived - -## -description -Occurs when the device scans a barcode. - -## -remarks - -## -examples -The following example shows how to setup the barcode scanner to receive data after a scanning event. - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetSetupBarcodeScanner)][!code-cs[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetSetupBarcodeScanner)] - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[DataReceived](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetDataReceived)][!code-cs[DataReceived](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetDataReceived)][!code-js[DataReceived](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetDataReceived)] - - - -[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] - - - -[!code-js[DataReceivedJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetDataReceivedJS)] - -## -see-also -[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.DataReceived +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.DataReceived + +## -description +Occurs when the device scans a barcode. + +## -remarks + +## -examples +The following example shows how to setup the barcode scanner to receive data after a scanning event. + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetSetupBarcodeScanner)][!code-cs[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetSetupBarcodeScanner)] + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[DataReceived](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetDataReceived)][!code-cs[DataReceived](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetDataReceived)][!code-js[DataReceived](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetDataReceived)] + + + +[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] + + + +[!code-js[DataReceivedJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetDataReceivedJS)] + +## -see-also +[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) diff --git a/windows.devices.pointofservice/claimedbarcodescanner_deviceid.md b/windows.devices.pointofservice/claimedbarcodescanner_deviceid.md index c60c084d4f..28baf7f5ff 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_deviceid.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.DeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed barcode scanner. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed barcode scanner. ## -remarks ## -examples ## -see-also [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.DeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed barcode scanner. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed barcode scanner. + +## -remarks + +## -examples + +## -see-also +[DeviceInformation](../windows.devices.enumeration/deviceinformation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedbarcodescanner_disableasync_490053963.md b/windows.devices.pointofservice/claimedbarcodescanner_disableasync_490053963.md index ea0c4a0316..7c5e0cf70b 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_disableasync_490053963.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_disableasync_490053963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.DisableAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.DisableAsync ## -description Puts the barcode scanner into a state where it cannot receive [DataReceived](claimedbarcodescanner_datareceived.md) events. ## -returns No object or value is returned when this method completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.DisableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.DisableAsync + +## -description +Puts the barcode scanner into a state where it cannot receive [DataReceived](claimedbarcodescanner_datareceived.md) events. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md b/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md index 5d8ffeaa66..ed40961d3b 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync - -## -description -Gets the barcode scanner into a ready state for [DataReceived](claimedbarcodescanner_datareceived.md) events. - -## -returns -No object or value is returned when this method completes. - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cpp[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetEnableBarcodeScanner)][!code-cs[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetEnableBarcodeScanner)] - -[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] - -## -see-also +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync + +## -description +Gets the barcode scanner into a ready state for [DataReceived](claimedbarcodescanner_datareceived.md) events. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cpp[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetEnableBarcodeScanner)][!code-cs[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetEnableBarcodeScanner)] + +[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_erroroccurred.md b/windows.devices.pointofservice/claimedbarcodescanner_erroroccurred.md index 2ea3a09f0a..3765bb2365 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_erroroccurred.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_erroroccurred.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ErrorOccurred --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.ErrorOccurred ## -description Occurs when there is a problem in reading a barcode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ErrorOccurred +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ErrorOccurred + +## -description +Occurs when there is a problem in reading a barcode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_imagepreviewreceived.md b/windows.devices.pointofservice/claimedbarcodescanner_imagepreviewreceived.md index b8028b3126..480928b812 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_imagepreviewreceived.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_imagepreviewreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ImagePreviewReceived --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.ImagePreviewReceived ## -description Occurs when the device receives the bitmap image of the scan. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ImagePreviewReceived +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ImagePreviewReceived + +## -description +Occurs when the device receives the bitmap image of the scan. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_isdecodedataenabled.md b/windows.devices.pointofservice/claimedbarcodescanner_isdecodedataenabled.md index 43913605df..d99c98c053 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_isdecodedataenabled.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_isdecodedataenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDecodeDataEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDecodeDataEnabled ## -description Gets or sets a Boolean value that indicates whether to provide the decoded data to the service object. ## -property-value Set to true if decoded data is provided to the application; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDecodeDataEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDecodeDataEnabled + +## -description +Gets or sets a Boolean value that indicates whether to provide the decoded data to the service object. + +## -property-value +Set to true if decoded data is provided to the application; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_isdisabledondatareceived.md b/windows.devices.pointofservice/claimedbarcodescanner_isdisabledondatareceived.md index 02fea4a799..bcc1801eca 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_isdisabledondatareceived.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_isdisabledondatareceived.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDisabledOnDataReceived --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDisabledOnDataReceived ## -description Gets or sets a Boolean value that indicates whether the barcode scanner is disabled after receiving the data. ## -property-value Set to true if the application wants to receive and process only one input or only one input at a time. ## -remarks When [IsDisabledOnDataReceived](claimedbarcodescanner_isdisabledondatareceived.md) is true, the application can only received one data at a time and the device is disabled after the [DataReceived](claimedbarcodescanner_datareceived.md) event. The application must call [EnableAsync](claimedbarcodescanner_enableasync.md) to enable the device to received data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDisabledOnDataReceived +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsDisabledOnDataReceived + +## -description +Gets or sets a Boolean value that indicates whether the barcode scanner is disabled after receiving the data. + +## -property-value +Set to true if the application wants to receive and process only one input or only one input at a time. + +## -remarks +When [IsDisabledOnDataReceived](claimedbarcodescanner_isdisabledondatareceived.md) is true, the application can only received one data at a time and the device is disabled after the [DataReceived](claimedbarcodescanner_datareceived.md) event. The application must call [EnableAsync](claimedbarcodescanner_enableasync.md) to enable the device to received data. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_isenabled.md b/windows.devices.pointofservice/claimedbarcodescanner_isenabled.md index 163a4f5b42..91973a9571 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_isenabled.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsEnabled ## -description Indicates whether the barcode scanner can receive [DataReceived](claimedbarcodescanner_datareceived.md) events. ## -property-value True if the device can receive [DataReceived](claimedbarcodescanner_datareceived.md) events; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.IsEnabled + +## -description +Indicates whether the barcode scanner can receive [DataReceived](claimedbarcodescanner_datareceived.md) events. + +## -property-value +True if the device can receive [DataReceived](claimedbarcodescanner_datareceived.md) events; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md b/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md index de37d33d2a..fdde62672f 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md @@ -1,30 +1,30 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested - -## -description -Occurs when the device gets a request to release its exclusive claim. - -## -remarks -If your application receives a [ReleaseDeviceRequested](claimedbarcodescanner_releasedevicerequested.md) event from another application, it may lose its exclusive claim unless your application retains the device. - -## -examples -The following example shows how to setup the event handler. - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetSetupBarcodeScanner)][!code-cs[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetSetupBarcodeScanner)] - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetReleaseDeviceRequested)][!code-cs[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetReleaseDeviceRequested)] - -## -see-also -[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested + +## -description +Occurs when the device gets a request to release its exclusive claim. + +## -remarks +If your application receives a [ReleaseDeviceRequested](claimedbarcodescanner_releasedevicerequested.md) event from another application, it may lose its exclusive claim unless your application retains the device. + +## -examples +The following example shows how to setup the event handler. + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetSetupBarcodeScanner)][!code-cs[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetSetupBarcodeScanner)] + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetReleaseDeviceRequested)][!code-cs[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetReleaseDeviceRequested)] + +## -see-also +[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) diff --git a/windows.devices.pointofservice/claimedbarcodescanner_resetstatisticsasync_1362172727.md b/windows.devices.pointofservice/claimedbarcodescanner_resetstatisticsasync_1362172727.md index 3cbca96192..eaeea8dcd5 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_resetstatisticsasync_1362172727.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_resetstatisticsasync_1362172727.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.ResetStatisticsAsync ## -description Resets the specified statistics to zero for all statistics that can be reset. ## -parameters ### -param statisticsCategories The list of names of the statistics to reset. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and groups names ("name3", "U_", "M_"). ## -returns No object or value is returned by this method when it completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ResetStatisticsAsync + +## -description +Resets the specified statistics to zero for all statistics that can be reset. + +## -parameters +### -param statisticsCategories +The list of names of the statistics to reset. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and groups names ("name3", "U_", "M_"). + + +## -returns +No object or value is returned by this method when it completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_retaindevice_1634489834.md b/windows.devices.pointofservice/claimedbarcodescanner_retaindevice_1634489834.md index 15fc7a5984..60e8de9fc9 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_retaindevice_1634489834.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_retaindevice_1634489834.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.RetainDevice --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.RetainDevice ## -description Retains exclusive claim to the barcode scanner. ## -remarks When the application receives a request to release its exclusive claim to the barcode scanner, it must call [RetainDevice](claimedbarcodescanner_retaindevice.md), otherwise it will lose its claim to the device. ## -examples ## -see-also [ReleaseDeviceRequested](claimedbarcodescanner_releasedevicerequested.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.RetainDevice +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.RetainDevice + +## -description +Retains exclusive claim to the barcode scanner. + +## -remarks +When the application receives a request to release its exclusive claim to the barcode scanner, it must call [RetainDevice](claimedbarcodescanner_retaindevice.md), otherwise it will lose its claim to the device. + +## -examples + +## -see-also +[ReleaseDeviceRequested](claimedbarcodescanner_releasedevicerequested.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedbarcodescanner_setactiveprofileasync_840436713.md b/windows.devices.pointofservice/claimedbarcodescanner_setactiveprofileasync_840436713.md index bb0b47e610..ab904b5589 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_setactiveprofileasync_840436713.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_setactiveprofileasync_840436713.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveProfileAsync(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveProfileAsync ## -description Sets the active profile on the barcode scanner. ## -parameters ### -param profile The name of the profile to set on the device. ## -returns No object or value is returned when the method completes. ## -remarks The input parameter must match one of the supported profiles. For more information, see [GetSupportedProfiles](barcodescanner_getsupportedprofiles.md) or [IsProfileSupported](barcodescanner_isprofilesupported.md). Barcode scanners can support a number of features beyond scanning, such as focal length and scan duration. These features are typically exposed through settings or properties and can be as many as 100 on complex devices. The simplify the model of scanner configuration, one or more profiles are exposed to application developers with each profile containing one or more OEM defined settings. ## -examples ## -see-also [GetSupportedProfiles](barcodescanner_getsupportedprofiles.md), [IsProfileSupported](barcodescanner_isprofilesupported.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveProfileAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveProfileAsync + +## -description +Sets the active profile on the barcode scanner. + +## -parameters +### -param profile +The name of the profile to set on the device. + +## -returns +No object or value is returned when the method completes. + +## -remarks +The input parameter must match one of the supported profiles. For more information, see [GetSupportedProfiles](barcodescanner_getsupportedprofiles.md) or [IsProfileSupported](barcodescanner_isprofilesupported.md). + +Barcode scanners can support a number of features beyond scanning, such as focal length and scan duration. These features are typically exposed through settings or properties and can be as many as 100 on complex devices. The simplify the model of scanner configuration, one or more profiles are exposed to application developers with each profile containing one or more OEM defined settings. + +## -examples + +## -see-also +[GetSupportedProfiles](barcodescanner_getsupportedprofiles.md), [IsProfileSupported](barcodescanner_isprofilesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedbarcodescanner_setactivesymbologiesasync_987210999.md b/windows.devices.pointofservice/claimedbarcodescanner_setactivesymbologiesasync_987210999.md index f475ea9b90..62e531d882 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_setactivesymbologiesasync_987210999.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_setactivesymbologiesasync_987210999.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveSymbologiesAsync(Windows.Foundation.Collections.IIterable{System.UInt32}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveSymbologiesAsync ## -description Sets the barcode symbologies for the device to use. ## -parameters ### -param symbologies The specific symbologies to use. ## -returns No object or value is returned when this method completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveSymbologiesAsync(Windows.Foundation.Collections.IIterable{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetActiveSymbologiesAsync + +## -description +Sets the barcode symbologies for the device to use. + +## -parameters +### -param symbologies +The specific symbologies to use. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_startsoftwaretriggerasync_1426624742.md b/windows.devices.pointofservice/claimedbarcodescanner_startsoftwaretriggerasync_1426624742.md index af2e2c4779..3e767bb041 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_startsoftwaretriggerasync_1426624742.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_startsoftwaretriggerasync_1426624742.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.StartSoftwareTriggerAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.StartSoftwareTriggerAsync ## -description Used to signal the barcode scanner to start scanning. A session is active until [StopSoftwareTriggerAsync](claimedbarcodescanner_stopsoftwaretriggerasync.md) is invoked, or until the scanner ends the session on its own. ## -returns No object or value is returned when this method completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.StartSoftwareTriggerAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.StartSoftwareTriggerAsync + +## -description +Used to signal the barcode scanner to start scanning. A session is active until [StopSoftwareTriggerAsync](claimedbarcodescanner_stopsoftwaretriggerasync.md) is invoked, or until the scanner ends the session on its own. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_stopsoftwaretriggerasync_1202164471.md b/windows.devices.pointofservice/claimedbarcodescanner_stopsoftwaretriggerasync_1202164471.md index 8e9789a389..37b25779df 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_stopsoftwaretriggerasync_1202164471.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_stopsoftwaretriggerasync_1202164471.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.StopSoftwareTriggerAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.StopSoftwareTriggerAsync ## -description Used to stop a session that was started with [StartSoftwareTriggerAsync](claimedbarcodescanner_startsoftwaretriggerasync.md). No error is raised if this is called when no session is active. ## -returns No object or value is returned when this method completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.StopSoftwareTriggerAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.StopSoftwareTriggerAsync + +## -description +Used to stop a session that was started with [StartSoftwareTriggerAsync](claimedbarcodescanner_startsoftwaretriggerasync.md). No error is raised if this is called when no session is active. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_triggerpressed.md b/windows.devices.pointofservice/claimedbarcodescanner_triggerpressed.md index 7a65a1f189..feae96c1da 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_triggerpressed.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_triggerpressed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerPressed --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerPressed ## -description Occurs when the barcode scanner trigger or button is pressed during a scanning operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerPressed +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerPressed + +## -description +Occurs when the barcode scanner trigger or button is pressed during a scanning operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_triggerreleased.md b/windows.devices.pointofservice/claimedbarcodescanner_triggerreleased.md index 93e9056e3f..600bb77a56 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_triggerreleased.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_triggerreleased.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerReleased --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerReleased ## -description Occurs when the barcode scanner trigger or button is released during a scanning operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerReleased +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.TriggerReleased + +## -description +Occurs when the barcode scanner trigger or button is released during a scanning operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_updatestatisticsasync_1631267301.md b/windows.devices.pointofservice/claimedbarcodescanner_updatestatisticsasync_1631267301.md index f044489d41..fad999606f 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_updatestatisticsasync_1631267301.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_updatestatisticsasync_1631267301.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedBarcodeScanner.UpdateStatisticsAsync ## -description Updates the specified statistics. ## -parameters ### -param statistics The list of key-value pairs of statistics to update. + An empty string ("", "value1") sets all statistics that can be set to value1. + "U_", "value2" sets all UnifiedPOS defined statistics that can be set to value2. + "M_", "value3" sets all manufacturer defined statistics that can be set to value3. + "name1", "value4" sets specific named statistics as defined by the UnifiedPOS or manufacturer to value4. ## -returns No object or value is returned by this method when it completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.UpdateStatisticsAsync + +## -description +Updates the specified statistics. + +## -parameters +### -param statistics +The list of key-value pairs of statistics to update. ++ An empty string ("", "value1") sets all statistics that can be set to value1. ++ "U_", "value2" sets all UnifiedPOS defined statistics that can be set to value2. ++ "M_", "value3" sets all manufacturer defined statistics that can be set to value3. ++ "name1", "value4" sets specific named statistics as defined by the UnifiedPOS or manufacturer to value4. + + +## -returns +No object or value is returned by this method when it completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer.md b/windows.devices.pointofservice/claimedcashdrawer.md index 1f6439f821..d053737bfe 100644 --- a/windows.devices.pointofservice/claimedcashdrawer.md +++ b/windows.devices.pointofservice/claimedcashdrawer.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedCashDrawer --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedCashDrawer ## -description Provides access to exclusive and privileged methods, properties, and events on a point-of-service cash drawer device. ## -remarks The user gets an instance of [ClaimedCashDrawer](claimedcashdrawer.md) from the [CashDrawer.ClaimDrawerAsync](cashdrawer_claimdrawerasync.md) method. Claim is cooperatively managed, so multiple concurrent apps can negotiate which app owns claim. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedCashDrawer +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer + +## -description +Provides access to exclusive and privileged methods, properties, and events on a point-of-service cash drawer device. + +## -remarks +The user gets an instance of [ClaimedCashDrawer](claimedcashdrawer.md) from the [CashDrawer.ClaimDrawerAsync](cashdrawer_claimdrawerasync.md) method. Claim is cooperatively managed, so multiple concurrent apps can negotiate which app owns claim. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedcashdrawer_close_811482585.md b/windows.devices.pointofservice/claimedcashdrawer_close_811482585.md index 5938e6cc5e..4f2febaf65 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_close_811482585.md +++ b/windows.devices.pointofservice/claimedcashdrawer_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.Close --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.Close ## -description Disposes the claimed cash drawer, releases claim on the device, and disables the device the same way as calling [DisableAsync.](claimedcashdrawer_disableasync.md) ## -remarks [Close](../windows.foundation/iclosable_close.md) methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.Close + +## -description +Disposes the claimed cash drawer, releases claim on the device, and disables the device the same way as calling [DisableAsync.](claimedcashdrawer_disableasync.md) + +## -remarks +[Close](../windows.foundation/iclosable_close.md) methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_closealarm.md b/windows.devices.pointofservice/claimedcashdrawer_closealarm.md index 4bc6c368f0..d65108fc5c 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_closealarm.md +++ b/windows.devices.pointofservice/claimedcashdrawer_closealarm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.CloseAlarm --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.CloseAlarm ## -description Gets the close alarm for this cash drawer. This is only valid if [IsDrawerOpenSensorAvailable](cashdrawercapabilities_isdraweropensensoravailable.md) is true. ## -property-value The close alarm for the cash drawer. ## -remarks ## -examples ## -see-also [CashDrawerCapabilities.IsDrawerOpenSensorAvailable](cashdrawercapabilities_isdraweropensensoravailable.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.CloseAlarm +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.CloseAlarm + +## -description +Gets the close alarm for this cash drawer. This is only valid if [IsDrawerOpenSensorAvailable](cashdrawercapabilities_isdraweropensensoravailable.md) is true. + +## -property-value +The close alarm for the cash drawer. + +## -remarks + +## -examples + +## -see-also +[CashDrawerCapabilities.IsDrawerOpenSensorAvailable](cashdrawercapabilities_isdraweropensensoravailable.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedcashdrawer_deviceid.md b/windows.devices.pointofservice/claimedcashdrawer_deviceid.md index af43a05921..42e59f1a1a 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_deviceid.md +++ b/windows.devices.pointofservice/claimedcashdrawer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.DeviceId ## -description The identifier string of the claimed cash drawer device. ## -property-value String representing the ID of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.DeviceId + +## -description +The identifier string of the claimed cash drawer device. + +## -property-value +String representing the ID of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_disableasync_490053963.md b/windows.devices.pointofservice/claimedcashdrawer_disableasync_490053963.md index 59b235e796..53e6c7a486 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_disableasync_490053963.md +++ b/windows.devices.pointofservice/claimedcashdrawer_disableasync_490053963.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.DisableAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.DisableAsync ## -description Notifies the underlying hardware to power off. ## -returns Whether the attempt to disable succeeded or not. ## -remarks This behaves identically to the existing POS peripheral API with the exception that this API returns an instance of IAsyncOperation<boolean> instead of IAsyncAction, so the caller does not need to catch exceptions to determine whether the attempt to disable succeeded or not. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.DisableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.DisableAsync + +## -description +Notifies the underlying hardware to power off. + +## -returns +Whether the attempt to disable succeeded or not. + +## -remarks +This behaves identically to the existing POS peripheral API with the exception that this API returns an instance of IAsyncOperation<boolean> instead of IAsyncAction, so the caller does not need to catch exceptions to determine whether the attempt to disable succeeded or not. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_enableasync_208845947.md b/windows.devices.pointofservice/claimedcashdrawer_enableasync_208845947.md index be307f22fc..cfb811d13d 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_enableasync_208845947.md +++ b/windows.devices.pointofservice/claimedcashdrawer_enableasync_208845947.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.EnableAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.EnableAsync ## -description Asynchronously notifies the underlying hardware to power on for use. ## -returns Whether the attempt to enable succeeded or not. ## -remarks This behaves identically to the existing POS peripheral API with the exception that this API returns an instance of IAsyncOperation<boolean> instead of IAsyncAction, so the caller does not need to catch exceptions to determine whether the attempt to enable succeeded or not. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.EnableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.EnableAsync + +## -description +Asynchronously notifies the underlying hardware to power on for use. + +## -returns +Whether the attempt to enable succeeded or not. + +## -remarks +This behaves identically to the existing POS peripheral API with the exception that this API returns an instance of IAsyncOperation<boolean> instead of IAsyncAction, so the caller does not need to catch exceptions to determine whether the attempt to enable succeeded or not. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_isdraweropen.md b/windows.devices.pointofservice/claimedcashdrawer_isdraweropen.md index a1d493e392..679025591d 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_isdraweropen.md +++ b/windows.devices.pointofservice/claimedcashdrawer_isdraweropen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.IsDrawerOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.IsDrawerOpen ## -description Indicates whether the cash drawer is open. ## -property-value True if the drawer is open, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.IsDrawerOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.IsDrawerOpen + +## -description +Indicates whether the cash drawer is open. + +## -property-value +True if the drawer is open, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_isenabled.md b/windows.devices.pointofservice/claimedcashdrawer_isenabled.md index edbe432fa3..6e65d62eb9 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_isenabled.md +++ b/windows.devices.pointofservice/claimedcashdrawer_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.IsEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.IsEnabled ## -description Indicates whether the cash drawer is operational and can be used. ## -property-value True if the cash drawer can be opened or [CloseAlarm](claimedcashdrawer_closealarm.md) can be used; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedCashDrawer.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.IsEnabled + +## -description +Indicates whether the cash drawer is operational and can be used. + +## -property-value +True if the cash drawer can be opened or [CloseAlarm](claimedcashdrawer_closealarm.md) can be used; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_opendrawerasync_147918364.md b/windows.devices.pointofservice/claimedcashdrawer_opendrawerasync_147918364.md index 94b0d7d626..bff3140632 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_opendrawerasync_147918364.md +++ b/windows.devices.pointofservice/claimedcashdrawer_opendrawerasync_147918364.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.OpenDrawerAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.OpenDrawerAsync ## -description Opens the cash drawer. ## -returns Boolean indicating whether the drawer was successfully opened. ## -remarks All devices support this asynchronous operation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.OpenDrawerAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.OpenDrawerAsync + +## -description +Opens the cash drawer. + +## -returns +Boolean indicating whether the drawer was successfully opened. + +## -remarks +All devices support this asynchronous operation. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_releasedevicerequested.md b/windows.devices.pointofservice/claimedcashdrawer_releasedevicerequested.md index efe2cff1e4..e2086deb09 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_releasedevicerequested.md +++ b/windows.devices.pointofservice/claimedcashdrawer_releasedevicerequested.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedCashDrawer.ReleaseDeviceRequested --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.ReleaseDeviceRequested ## -description Occurs when the device gets a request to release its exclusive claim. There is a small window of time (2 seconds) where the app may call [RetainDeviceAsync](claimedcashdrawer_retaindeviceasync.md) to keep exclusive claim. Or alternatively, the app may release claim via [Close](claimedcashdrawer_close.md) to end the window immediately. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedCashDrawer.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.ReleaseDeviceRequested + +## -description +Occurs when the device gets a request to release its exclusive claim. + +There is a small window of time (2 seconds) where the app may call [RetainDeviceAsync](claimedcashdrawer_retaindeviceasync.md) to keep exclusive claim. Or alternatively, the app may release claim via [Close](claimedcashdrawer_close.md) to end the window immediately. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_resetstatisticsasync_1362172727.md b/windows.devices.pointofservice/claimedcashdrawer_resetstatisticsasync_1362172727.md index 4c6b96c45b..435fbd3411 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_resetstatisticsasync_1362172727.md +++ b/windows.devices.pointofservice/claimedcashdrawer_resetstatisticsasync_1362172727.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.ResetStatisticsAsync ## -description Resets the specified device statistics to their defaults. ## -parameters ### -param statisticsCategories The list of names of the statistics to reset. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and groups names ("name3", "U_", "M_"). ## -returns True on success; otherwise false. ## -remarks This method represents a change in state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.ResetStatisticsAsync + +## -description +Resets the specified device statistics to their defaults. + +## -parameters +### -param statisticsCategories +The list of names of the statistics to reset. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and groups names ("name3", "U_", "M_"). + + +## -returns +True on success; otherwise false. + +## -remarks +This method represents a change in state. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_retaindeviceasync_1460106534.md b/windows.devices.pointofservice/claimedcashdrawer_retaindeviceasync_1460106534.md index ebe3c4c396..2fead8404e 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_retaindeviceasync_1460106534.md +++ b/windows.devices.pointofservice/claimedcashdrawer_retaindeviceasync_1460106534.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.RetainDeviceAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.RetainDeviceAsync ## -description Retain the current claim on the cash drawer. This is usually called in response to a [ReleaseDeviceRequested](claimedcashdrawer_releasedevicerequested.md) event notification. ## -returns True if the retain attempt succeeded; false if the retain attempt failed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.RetainDeviceAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.RetainDeviceAsync + +## -description +Retain the current claim on the cash drawer. This is usually called in response to a [ReleaseDeviceRequested](claimedcashdrawer_releasedevicerequested.md) event notification. + +## -returns +True if the retain attempt succeeded; false if the retain attempt failed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedcashdrawer_updatestatisticsasync_1631267301.md b/windows.devices.pointofservice/claimedcashdrawer_updatestatisticsasync_1631267301.md index 7da058d04c..963475c119 100644 --- a/windows.devices.pointofservice/claimedcashdrawer_updatestatisticsasync_1631267301.md +++ b/windows.devices.pointofservice/claimedcashdrawer_updatestatisticsasync_1631267301.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedCashDrawer.UpdateStatisticsAsync ## -description Updates device statistics values using the provided key/value pair. ## -parameters ### -param statistics The statistics to update. ## -returns True if update succeeded; otherwise false. ## -remarks This method generates a change of state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedCashDrawer.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedCashDrawer.UpdateStatisticsAsync + +## -description +Updates device statistics values using the provided key/value pair. + +## -parameters +### -param statistics +The statistics to update. + +## -returns +True if update succeeded; otherwise false. + +## -remarks +This method generates a change of state. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter.md b/windows.devices.pointofservice/claimedjournalprinter.md index 5071a7edbc..819440a713 100644 --- a/windows.devices.pointofservice/claimedjournalprinter.md +++ b/windows.devices.pointofservice/claimedjournalprinter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedJournalPrinter --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter ## -description Represents a journal printer station that has been claimed for use. ## -remarks To get a [ClaimedJournalPrinter](claimedjournalprinter.md) object, use the [ClaimedPosPrinter.Journal](claimedposprinter_journal.md) property. ## -examples ## -see-also [ICommonClaimedPosPrinterStation](icommonclaimedposprinterstation.md), [ClaimedPosPrinter.Journal](claimedposprinter_journal.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedJournalPrinter +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter + +## -description +Represents a journal printer station that has been claimed for use. + +## -remarks +To get a [ClaimedJournalPrinter](claimedjournalprinter.md) object, use the [ClaimedPosPrinter.Journal](claimedposprinter_journal.md) property. + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation](icommonclaimedposprinterstation.md), [ClaimedPosPrinter.Journal](claimedposprinter_journal.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedjournalprinter_charactersperline.md b/windows.devices.pointofservice/claimedjournalprinter_charactersperline.md index 7fb42130aa..5330fbe7fd 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_charactersperline.md +++ b/windows.devices.pointofservice/claimedjournalprinter_charactersperline.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.CharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.CharactersPerLine ## -description Gets or sets the number of characters per line for the journal printer station. It is worth noting that changing this property can potentially change the [LineHeight](claimedjournalprinter_lineheight.md), [LineSpacing](claimedjournalprinter_linespacing.md) and [LineWidth](claimedjournalprinter_linewidth.md) properties. ## -property-value The number of characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.CharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.CharactersPerLine + +## -description +Gets or sets the number of characters per line for the journal printer station. + +It is worth noting that changing this property can potentially change the [LineHeight](claimedjournalprinter_lineheight.md), [LineSpacing](claimedjournalprinter_linespacing.md) and [LineWidth](claimedjournalprinter_linewidth.md) properties. + +## -property-value +The number of characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_colorcartridge.md b/windows.devices.pointofservice/claimedjournalprinter_colorcartridge.md index 01d19eefce..0833c8c48d 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_colorcartridge.md +++ b/windows.devices.pointofservice/claimedjournalprinter_colorcartridge.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.ColorCartridge --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.ColorCartridge ## -description Gets or sets the color cartridge that the journal printer station should use when it prints. This property must agree with what is available through [ColorCartridgeCapabilities](journalprintercapabilities_colorcartridgecapabilities.md). ## -property-value An enumeration value that identifies the color cartridge that the journal printer station should use when it prints. ## -remarks ## -examples ## -see-also [PosPrinterColorCartridge](posprintercolorcartridge.md), [ICommonClaimedPosPrinterStation.ColorCartridge](icommonclaimedposprinterstation_colorcartridge.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.ColorCartridge +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.ColorCartridge + +## -description +Gets or sets the color cartridge that the journal printer station should use when it prints. This property must agree with what is available through [ColorCartridgeCapabilities](journalprintercapabilities_colorcartridgecapabilities.md). + +## -property-value +An enumeration value that identifies the color cartridge that the journal printer station should use when it prints. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCartridge](posprintercolorcartridge.md), [ICommonClaimedPosPrinterStation.ColorCartridge](icommonclaimedposprinterstation_colorcartridge.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedjournalprinter_createjob_1417454808.md b/windows.devices.pointofservice/claimedjournalprinter_createjob_1417454808.md index a749afb9eb..b71508f118 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_createjob_1417454808.md +++ b/windows.devices.pointofservice/claimedjournalprinter_createjob_1417454808.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedJournalPrinter.CreateJob --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.CreateJob ## -description Creates a new print job for the journal printer station. ## -returns The new print job for the journal printer station. ## -remarks ## -examples ## -see-also [JournalPrintJob](journalprintjob.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedJournalPrinter.CreateJob +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.CreateJob + +## -description +Creates a new print job for the journal printer station. + +## -returns +The new print job for the journal printer station. + +## -remarks + +## -examples + +## -see-also +[JournalPrintJob](journalprintjob.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedjournalprinter_iscartridgeempty.md b/windows.devices.pointofservice/claimedjournalprinter_iscartridgeempty.md index 7e02d616a2..74447fc77e 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_iscartridgeempty.md +++ b/windows.devices.pointofservice/claimedjournalprinter_iscartridgeempty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeEmpty ## -description Gets whether the printer cartridge for the journal printer station is empty. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. ## -property-value True if the printer cartridge is empty; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeEmpty + +## -description +Gets whether the printer cartridge for the journal printer station is empty. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. + +## -property-value +True if the printer cartridge is empty; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_iscartridgeremoved.md b/windows.devices.pointofservice/claimedjournalprinter_iscartridgeremoved.md index 0357021e35..d0f606e268 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_iscartridgeremoved.md +++ b/windows.devices.pointofservice/claimedjournalprinter_iscartridgeremoved.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeRemoved --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeRemoved ## -description Gets whether the cartridge for journal printer station has been removed. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. ## -property-value True if the cartridge is missing; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeRemoved +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCartridgeRemoved + +## -description +Gets whether the cartridge for journal printer station has been removed. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. + +## -property-value +True if the cartridge is missing; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_iscoveropen.md b/windows.devices.pointofservice/claimedjournalprinter_iscoveropen.md index 6ce34c7469..c645c4c040 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_iscoveropen.md +++ b/windows.devices.pointofservice/claimedjournalprinter_iscoveropen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCoverOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCoverOpen ## -description Gets whether the printer cover for the journal printer station is open. ## -property-value True if the cover is open; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCoverOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsCoverOpen + +## -description +Gets whether the printer cover for the journal printer station is open. + +## -property-value +True if the cover is open; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_isheadcleaning.md b/windows.devices.pointofservice/claimedjournalprinter_isheadcleaning.md index 99c39f3fd6..85c88f6ccb 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_isheadcleaning.md +++ b/windows.devices.pointofservice/claimedjournalprinter_isheadcleaning.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsHeadCleaning --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsHeadCleaning ## -description Gets whether the head for the journal printer station is currently cleaning. ## -property-value True if the head is currently cleaning; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsHeadCleaning +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsHeadCleaning + +## -description +Gets whether the head for the journal printer station is currently cleaning. + +## -property-value +True if the head is currently cleaning; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_isletterquality.md b/windows.devices.pointofservice/claimedjournalprinter_isletterquality.md index c2c1b0ba92..fb3483ecc9 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_isletterquality.md +++ b/windows.devices.pointofservice/claimedjournalprinter_isletterquality.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsLetterQuality --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsLetterQuality ## -description Gets or sets whether the journal printer station prints with high quality or high speed. Note, this may throw an exception if the corresponding sensor is not available on the printer. ## -property-value True if the journal printer station prints with high quality. False if the journal printer station prints with high speed. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsLetterQuality](icommonclaimedposprinterstation_isletterquality.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsLetterQuality +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsLetterQuality + +## -description +Gets or sets whether the journal printer station prints with high quality or high speed. Note, this may throw an exception if the corresponding sensor is not available on the printer. + +## -property-value +True if the journal printer station prints with high quality. False if the journal printer station prints with high speed. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsLetterQuality](icommonclaimedposprinterstation_isletterquality.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedjournalprinter_ispaperempty.md b/windows.devices.pointofservice/claimedjournalprinter_ispaperempty.md index e90db783a0..1b1612886f 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_ispaperempty.md +++ b/windows.devices.pointofservice/claimedjournalprinter_ispaperempty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperEmpty ## -description Gets whether the paper is empty for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. ## -property-value True if the printer is out of paper; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperEmpty + +## -description +Gets whether the paper is empty for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. + +## -property-value +True if the printer is out of paper; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_ispapernearend.md b/windows.devices.pointofservice/claimedjournalprinter_ispapernearend.md index 774042c918..773e03d861 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_ispapernearend.md +++ b/windows.devices.pointofservice/claimedjournalprinter_ispapernearend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperNearEnd --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperNearEnd ## -description Gets whether the printer paper is near the end for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. ## -property-value True if the paper is near the end; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperNearEnd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsPaperNearEnd + +## -description +Gets whether the printer paper is near the end for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. + +## -property-value +True if the paper is near the end; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_isreadytoprint.md b/windows.devices.pointofservice/claimedjournalprinter_isreadytoprint.md index 8ef83b0010..3aea9b8050 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_isreadytoprint.md +++ b/windows.devices.pointofservice/claimedjournalprinter_isreadytoprint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsReadyToPrint --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.IsReadyToPrint ## -description Gets whether the journal printer station is ready to print. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. ## -property-value True if the printer is ready to print; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.IsReadyToPrint +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.IsReadyToPrint + +## -description +Gets whether the journal printer station is ready to print. Note, this may throw an exception if the corresponding sensor is not available on the printer. See [JournalPrinterCapabilities](journalprintercapabilities.md) to verify sensor availability. + +## -property-value +True if the printer is ready to print; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_lineheight.md b/windows.devices.pointofservice/claimedjournalprinter_lineheight.md index 8341d4009b..a0c8019024 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_lineheight.md +++ b/windows.devices.pointofservice/claimedjournalprinter_lineheight.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.LineHeight --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.LineHeight ## -description Gets or sets the current height of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. It is worth noting that changing this property can potentially change the [CharactersPerLine](claimedjournalprinter_charactersperline.md), [LineSpacing](claimedjournalprinter_linespacing.md) and [LineWidth](claimedjournalprinter_linewidth.md) properties. ## -property-value The current height of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedJournalPrinter.LineSpacing](claimedjournalprinter_linespacing.md), [ClaimedJournalPrinter.LineWidth](claimedjournalprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.LineHeight +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.LineHeight + +## -description +Gets or sets the current height of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +It is worth noting that changing this property can potentially change the [CharactersPerLine](claimedjournalprinter_charactersperline.md), [LineSpacing](claimedjournalprinter_linespacing.md) and [LineWidth](claimedjournalprinter_linewidth.md) properties. + +## -property-value +The current height of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedJournalPrinter.LineSpacing](claimedjournalprinter_linespacing.md), [ClaimedJournalPrinter.LineWidth](claimedjournalprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedjournalprinter_linespacing.md b/windows.devices.pointofservice/claimedjournalprinter_linespacing.md index 22afa6782d..07d4c9ad5c 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_linespacing.md +++ b/windows.devices.pointofservice/claimedjournalprinter_linespacing.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.LineSpacing --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.LineSpacing ## -description Gets or sets the spacing of each single-high print line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. It is worth noting that changing this property can potentially change the [CharactersPerLine](claimedjournalprinter_charactersperline.md), [LineHeight](claimedjournalprinter_lineheight.md) and [LineWidth](claimedjournalprinter_linewidth.md) properties. ## -property-value The spacing of each single-high print line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.LineSpacing +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.LineSpacing + +## -description +Gets or sets the spacing of each single-high print line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. + +It is worth noting that changing this property can potentially change the [CharactersPerLine](claimedjournalprinter_charactersperline.md), [LineHeight](claimedjournalprinter_lineheight.md) and [LineWidth](claimedjournalprinter_linewidth.md) properties. + +## -property-value +The spacing of each single-high print line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedjournalprinter_linewidth.md b/windows.devices.pointofservice/claimedjournalprinter_linewidth.md index bf7a7df9ba..b4c6a2824b 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_linewidth.md +++ b/windows.devices.pointofservice/claimedjournalprinter_linewidth.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.LineWidth --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.LineWidth ## -description Gets the current width of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. It is worth noting that changing this property can potentially change the [CharactersPerLine](claimedjournalprinter_charactersperline.md), [LineHeight](claimedjournalprinter_lineheight.md) and [LineSpacing](claimedjournalprinter_linespacing.md) properties. ## -property-value The current width of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedJournalPrinter.LineHeight](claimedjournalprinter_lineheight.md), [ClaimedJournalPrinter.LineSpacing](claimedjournalprinter_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedJournalPrinter.LineWidth +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.LineWidth + +## -description +Gets the current width of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +It is worth noting that changing this property can potentially change the [CharactersPerLine](claimedjournalprinter_charactersperline.md), [LineHeight](claimedjournalprinter_lineheight.md) and [LineSpacing](claimedjournalprinter_linespacing.md) properties. + +## -property-value +The current width of the printed line for the journal printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedJournalPrinter.LineHeight](claimedjournalprinter_lineheight.md), [ClaimedJournalPrinter.LineSpacing](claimedjournalprinter_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedjournalprinter_validatedata_977746434.md b/windows.devices.pointofservice/claimedjournalprinter_validatedata_977746434.md index c24a2eadb3..328ee71035 100644 --- a/windows.devices.pointofservice/claimedjournalprinter_validatedata_977746434.md +++ b/windows.devices.pointofservice/claimedjournalprinter_validatedata_977746434.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedJournalPrinter.ValidateData(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedJournalPrinter.ValidateData ## -description Determines if a [JournalPrintJob](journalprintjob.md) can successfully execute a print instruction with the specified data. ## -parameters ### -param data The data sequence that you want to validate before you use it with the [JournalPrintJob.Print](journalprintjob_print.md) method. This sequence may include printable data and escape sequences. If the sequence is not valid, and you use it with [JournalPrintJob.Print](journalprintjob_print.md) anyways, the job fails when you run it with [JournalPrintJob.ExecuteAsync](journalprintjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [JournalPrintJob.Print](journalprintjob_print.md). ## -returns True if the data passes validation; otherwise false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.ValidateData](icommonclaimedposprinterstation_validatedata.md), [JournalPrintJob.Print](journalprintjob_print.md), [JournalPrintJob.ExecuteAsync](journalprintjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedJournalPrinter.ValidateData(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedJournalPrinter.ValidateData + +## -description +Determines if a [JournalPrintJob](journalprintjob.md) can successfully execute a print instruction with the specified data. + +## -parameters +### -param data +The data sequence that you want to validate before you use it with the [JournalPrintJob.Print](journalprintjob_print.md) method. This sequence may include printable data and escape sequences. + +If the sequence is not valid, and you use it with [JournalPrintJob.Print](journalprintjob_print.md) anyways, the job fails when you run it with [JournalPrintJob.ExecuteAsync](journalprintjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [JournalPrintJob.Print](journalprintjob_print.md). + +## -returns +True if the data passes validation; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.ValidateData](icommonclaimedposprinterstation_validatedata.md), [JournalPrintJob.Print](journalprintjob_print.md), [JournalPrintJob.ExecuteAsync](journalprintjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader.md b/windows.devices.pointofservice/claimedmagneticstripereader.md index 54bddf7665..eb06aac471 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedMagneticStripeReader --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader ## -description Represents the claimed magnetic stripe reader. ## -remarks This object is created when [ClaimReaderAsync](magneticstripereader_claimreaderasync.md) method completes. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedMagneticStripeReader +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader + +## -description +Represents the claimed magnetic stripe reader. + +## -remarks +This object is created when [ClaimReaderAsync](magneticstripereader_claimreaderasync.md) method completes. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_aamvacarddatareceived.md b/windows.devices.pointofservice/claimedmagneticstripereader_aamvacarddatareceived.md index 11c91671e5..1302bc1c82 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_aamvacarddatareceived.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_aamvacarddatareceived.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AamvaCardDataReceived --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AamvaCardDataReceived ## -description Occurs when a motor vehicle card is swiped. ## -remarks An application can register for this event handler to receive data from driver licenses or other cards formatted according to American Association Motor Vehicles Administrators (AAMVA) card specification. ## -examples ## -see-also [Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AamvaCardDataReceived +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AamvaCardDataReceived + +## -description +Occurs when a motor vehicle card is swiped. + +## -remarks +An application can register for this event handler to receive data from driver licenses or other cards formatted according to American Association Motor Vehicles Administrators (AAMVA) card specification. + +## -examples + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_authenticatedeviceasync_1083929220.md b/windows.devices.pointofservice/claimedmagneticstripereader_authenticatedeviceasync_1083929220.md index 9d72e3f8df..062ad08591 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_authenticatedeviceasync_1083929220.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_authenticatedeviceasync_1083929220.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AuthenticateDeviceAsync(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AuthenticateDeviceAsync ## -description Puts the device into an authenticated state. ## -parameters ### -param responseToken A buffer containing the response token generated from the challenge token retrieved from a previous call to the [RetrieveDeviceAuthenticationDataAsync](claimedmagneticstripereader_retrievedeviceauthenticationdataasync.md) method. ## -returns ## -remarks The method is only valid for devices that support authentication. To authenticate a device, the application calls the [RetrieveDeviceAuthenticationDataAsync](claimedmagneticstripereader_retrievedeviceauthenticationdataasync.md) method to retrieve a challenge token. The application typically passes this token to another entity that has special knowledge of a shared secret and is able to create a proper response token. This response token is then passed into the [AuthenticateDeviceAsync](claimedmagneticstripereader_authenticatedeviceasync.md) method that uses it to validate the authentication request. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AuthenticateDeviceAsync(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.AuthenticateDeviceAsync + +## -description +Puts the device into an authenticated state. + +## -parameters +### -param responseToken +A buffer containing the response token generated from the challenge token retrieved from a previous call to the [RetrieveDeviceAuthenticationDataAsync](claimedmagneticstripereader_retrievedeviceauthenticationdataasync.md) method. + +## -returns + + +## -remarks +The method is only valid for devices that support authentication. + +To authenticate a device, the application calls the [RetrieveDeviceAuthenticationDataAsync](claimedmagneticstripereader_retrievedeviceauthenticationdataasync.md) method to retrieve a challenge token. The application typically passes this token to another entity that has special knowledge of a shared secret and is able to create a proper response token. This response token is then passed into the [AuthenticateDeviceAsync](claimedmagneticstripereader_authenticatedeviceasync.md) method that uses it to validate the authentication request. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md b/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md index 37260f8510..485020e227 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md @@ -1,38 +1,38 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived - -## -description -Occurs when a bank card is swiped. - -## -remarks -An application can register for this event event handler to get the bank card data each time a bank card is swiped through the magnetic stripe reader. - -## -examples -The following example shows how to setup the magnetic stripe reader to receive data after a scanning event. - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)][!code-cs[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderDataReceived)][!code-cs[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderDataReceived)][!code-js[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetMagStripeReaderDataReceived)] - - - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - - - -[!code-js[MagStripeReaderDataReceivedJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetMagStripeReaderDataReceivedJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived + +## -description +Occurs when a bank card is swiped. + +## -remarks +An application can register for this event event handler to get the bank card data each time a bank card is swiped through the magnetic stripe reader. + +## -examples +The following example shows how to setup the magnetic stripe reader to receive data after a scanning event. + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)][!code-cs[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderDataReceived)][!code-cs[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderDataReceived)][!code-js[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetMagStripeReaderDataReceived)] + + + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + + + +[!code-js[MagStripeReaderDataReceivedJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetMagStripeReaderDataReceivedJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_close_811482585.md b/windows.devices.pointofservice/claimedmagneticstripereader_close_811482585.md index 95932efe29..1722d42ad3 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_close_811482585.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.Close --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.Close ## -description Releases the exclusive claim to the magnetic strip reader. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.Close + +## -description +Releases the exclusive claim to the magnetic strip reader. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_dataencryptionalgorithm.md b/windows.devices.pointofservice/claimedmagneticstripereader_dataencryptionalgorithm.md index f1051bca03..61b93cc817 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_dataencryptionalgorithm.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_dataencryptionalgorithm.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DataEncryptionAlgorithm --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DataEncryptionAlgorithm ## -description Gets or sets the [MagneticStripeReaderEncryptionAlgorithms](magneticstripereaderencryptionalgorithms.md) that will be used to encrypt the track data. ## -property-value The encryption algorithm the will be used to encrypt the track data. ## -remarks This property can only be updated when the device is opened and claimed; it cannot be updated when the device is enabled. ## -examples ## -see-also [MagneticStripeReaderEncryptionAlgorithms](magneticstripereaderencryptionalgorithms.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DataEncryptionAlgorithm +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DataEncryptionAlgorithm + +## -description +Gets or sets the [MagneticStripeReaderEncryptionAlgorithms](magneticstripereaderencryptionalgorithms.md) that will be used to encrypt the track data. + +## -property-value +The encryption algorithm the will be used to encrypt the track data. + +## -remarks +This property can only be updated when the device is opened and claimed; it cannot be updated when the device is enabled. + +## -examples + +## -see-also +[MagneticStripeReaderEncryptionAlgorithms](magneticstripereaderencryptionalgorithms.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_deauthenticatedeviceasync_493859666.md b/windows.devices.pointofservice/claimedmagneticstripereader_deauthenticatedeviceasync_493859666.md index 61e1423e2b..efdb62e0bb 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_deauthenticatedeviceasync_493859666.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_deauthenticatedeviceasync_493859666.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeAuthenticateDeviceAsync(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeAuthenticateDeviceAsync ## -description Puts the device into an unauthenticated state. ## -parameters ### -param responseToken A buffer containing the response token generated from the challenge token retrieved from a previous call to the [RetrieveDeviceAuthenticationDataAsync](claimedmagneticstripereader_retrievedeviceauthenticationdataasync.md) method. ## -returns ## -remarks When successful, the [IsDeviceAuthenticated](claimedmagneticstripereader_isdeviceauthenticated.md) property changes to false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeAuthenticateDeviceAsync(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeAuthenticateDeviceAsync + +## -description +Puts the device into an unauthenticated state. + +## -parameters +### -param responseToken +A buffer containing the response token generated from the challenge token retrieved from a previous call to the [RetrieveDeviceAuthenticationDataAsync](claimedmagneticstripereader_retrievedeviceauthenticationdataasync.md) method. + +## -returns + + +## -remarks +When successful, the [IsDeviceAuthenticated](claimedmagneticstripereader_isdeviceauthenticated.md) property changes to false. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_deviceid.md b/windows.devices.pointofservice/claimedmagneticstripereader_deviceid.md index db4b052a85..c1f9c94709 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_deviceid.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed magnetic stripe reader. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed magnetic stripe reader. ## -remarks ## -examples ## -see-also [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed magnetic stripe reader. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the claimed magnetic stripe reader. + +## -remarks + +## -examples + +## -see-also +[DeviceInformation](../windows.devices.enumeration/deviceinformation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_disableasync_490053963.md b/windows.devices.pointofservice/claimedmagneticstripereader_disableasync_490053963.md index 6c501a748c..eeb7450ada 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_disableasync_490053963.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_disableasync_490053963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DisableAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DisableAsync ## -description Puts the [ClaimedMagneticStripeReader](claimedmagneticstripereader.md) into a state where it cannot receive data events. ## -returns No object or value is returned when this method completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DisableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.DisableAsync + +## -description +Puts the [ClaimedMagneticStripeReader](claimedmagneticstripereader.md) into a state where it cannot receive data events. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md b/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md index 693a903537..5a66b7cce8 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync - -## -description -Gets the magnetic stripe reader into a ready state to receive data events. - -## -returns -No object or value is returned by this method when it completes. - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cpp[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetEnableMagStripeReader)][!code-cs[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetEnableMagStripeReader)] - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync + +## -description +Gets the magnetic stripe reader into a ready state to receive data events. + +## -returns +No object or value is returned by this method when it completes. + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cpp[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetEnableMagStripeReader)][!code-cs[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetEnableMagStripeReader)] + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_erroroccurred.md b/windows.devices.pointofservice/claimedmagneticstripereader_erroroccurred.md index ff9829ae87..a1429efe5a 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_erroroccurred.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_erroroccurred.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ErrorOccurred --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ErrorOccurred ## -description Occurs when the magnetic stripe reader detects an error when reading a card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ErrorOccurred +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ErrorOccurred + +## -description +Occurs when the magnetic stripe reader detects an error when reading a card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_isdecodedataenabled.md b/windows.devices.pointofservice/claimedmagneticstripereader_isdecodedataenabled.md index fb643c6f2d..dcec0ca879 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_isdecodedataenabled.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_isdecodedataenabled.md @@ -1,3 +1,43 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDecodeDataEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDecodeDataEnabled ## -description Indicates whether to provide raw or decoded data from the most recently swiped card. ## -property-value Set to true if decoded data is provided to the application; otherwise, false. ## -remarks Use this property to decide whether to pass the data from the card swipe in the original raw form or to decode it first. If set to true, each byte of track data is mapped from its original encoded bit sequence, as it exists in the magnetic card, to its corresponding decoded ASCII bit sequence. This conversion is not relevant to 7-bit format, which is not encoded. For each card type, the decoding takes place as follows:
Card typeTrack data propertyRaw data formatRaw bytesDecoded Values
ISOTrack 1 data6-bit0x00-0x3F0x20 through 0x5F
ISOTrack 2 data4-bit0x00-0x3F0x30 through 0x3F
ISOTrack 3 data4-bit0x00-0x3F0x30 through 0x3F
JIS-ITrack 1 data6-bit0x00-0x3F0x20 through 0x5F
JIS-ITrack 1 data7-bit0x00-0x7FData unaltered
JIS-ITrack 2 data4-bit0x00-0x0F0x20 through 0x3F
JIS-ITrack 3 data4-bit0x00-0x0F0x20 through 0x3F
JIS-ITrack 3 data7-bit0x00-0x7FData unaltered
JIS-IITrack 4 data7-bit0x00-0x7FData unaltered
AAMVATrack 1 data6-bit0x00-0x3F0x20 through 0x5F
AAMVATrack 2 data4-bit0x00-0x0F0x30 through 0x3F
AAMVATrack 3 data6-bit0x00-0x3F0x20 through 0x5F
This property is initialized to false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDecodeDataEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDecodeDataEnabled + +## -description +Indicates whether to provide raw or decoded data from the most recently swiped card. + +## -property-value +Set to true if decoded data is provided to the application; otherwise, false. + +## -remarks +Use this property to decide whether to pass the data from the card swipe in the original raw form or to decode it first. + +If set to true, each byte of track data is mapped from its original encoded bit sequence, as it exists in the magnetic card, to its corresponding decoded ASCII bit sequence. This conversion is not relevant to 7-bit format, which is not encoded. + +For each card type, the decoding takes place as follows: + + + + + + + + + + + + + +
Card typeTrack data propertyRaw data formatRaw bytesDecoded Values
ISOTrack 1 data6-bit0x00-0x3F0x20 through 0x5F
ISOTrack 2 data4-bit0x00-0x3F0x30 through 0x3F
ISOTrack 3 data4-bit0x00-0x3F0x30 through 0x3F
JIS-ITrack 1 data6-bit0x00-0x3F0x20 through 0x5F
JIS-ITrack 1 data7-bit0x00-0x7FData unaltered
JIS-ITrack 2 data4-bit0x00-0x0F0x20 through 0x3F
JIS-ITrack 3 data4-bit0x00-0x0F0x20 through 0x3F
JIS-ITrack 3 data7-bit0x00-0x7FData unaltered
JIS-IITrack 4 data7-bit0x00-0x7FData unaltered
AAMVATrack 1 data6-bit0x00-0x3F0x20 through 0x5F
AAMVATrack 2 data4-bit0x00-0x0F0x30 through 0x3F
AAMVATrack 3 data6-bit0x00-0x3F0x20 through 0x5F
+ +This property is initialized to false. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_isdeviceauthenticated.md b/windows.devices.pointofservice/claimedmagneticstripereader_isdeviceauthenticated.md index b75e9f42bc..a4cc74e04f 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_isdeviceauthenticated.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_isdeviceauthenticated.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDeviceAuthenticated --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDeviceAuthenticated ## -description Indicates whether the device is authenticated. ## -property-value True is the device is authenticated; otherwise, false. ## -remarks This property is only valid in the devices that support authentication. When the device authentication state changes, the [StatusUpdated](magneticstripereader_statusupdated.md) event occurs to indicate the change. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDeviceAuthenticated +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDeviceAuthenticated + +## -description +Indicates whether the device is authenticated. + +## -property-value +True is the device is authenticated; otherwise, false. + +## -remarks +This property is only valid in the devices that support authentication. + +When the device authentication state changes, the [StatusUpdated](magneticstripereader_statusupdated.md) event occurs to indicate the change. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_isdisabledondatareceived.md b/windows.devices.pointofservice/claimedmagneticstripereader_isdisabledondatareceived.md index 3db4ea6814..d6e86065db 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_isdisabledondatareceived.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_isdisabledondatareceived.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDisabledOnDataReceived --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDisabledOnDataReceived ## -description Gets or sets a Boolean value that indicates whether the magnetic stripe reader is disabled after receiving the data from the most recently swiped card. ## -property-value Set to true if the application wants to receive and process only one input or only one input at a time. ## -remarks [IsDisabledOnDataReceived](claimedmagneticstripereader_isdisabledondatareceived.md) provides the application the option to disable the magnetic stripe reader after receiving the data. When set to true, the device is disabled as soon as it receives the data from the most recently swiped card. The application must call [EnableAsync](claimedmagneticstripereader_enableasync.md) to get the device ready for the next data event. This property is initialized to false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDisabledOnDataReceived +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsDisabledOnDataReceived + +## -description +Gets or sets a Boolean value that indicates whether the magnetic stripe reader is disabled after receiving the data from the most recently swiped card. + +## -property-value +Set to true if the application wants to receive and process only one input or only one input at a time. + +## -remarks +[IsDisabledOnDataReceived](claimedmagneticstripereader_isdisabledondatareceived.md) provides the application the option to disable the magnetic stripe reader after receiving the data. When set to true, the device is disabled as soon as it receives the data from the most recently swiped card. The application must call [EnableAsync](claimedmagneticstripereader_enableasync.md) to get the device ready for the next data event. + +This property is initialized to false. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_isenabled.md b/windows.devices.pointofservice/claimedmagneticstripereader_isenabled.md index 2c7d7828b4..48e950ef89 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_isenabled.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsEnabled ## -description Indicates whether the magnetic stripe reader is ready to receive data events. ## -property-value True if the device is operational; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsEnabled + +## -description +Indicates whether the magnetic stripe reader is ready to receive data events. + +## -property-value +True if the device is operational; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_istransmitsentinelsenabled.md b/windows.devices.pointofservice/claimedmagneticstripereader_istransmitsentinelsenabled.md index 019d6ef508..9676c6d5c7 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_istransmitsentinelsenabled.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_istransmitsentinelsenabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsTransmitSentinelsEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsTransmitSentinelsEnabled ## -description Indicates whether the track data contains start and end sentinel values. ## -property-value True if the track data contains start and end sentinel values. False if the track data properties only contain track data between sentinels. ## -remarks This property is initialized to false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsTransmitSentinelsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.IsTransmitSentinelsEnabled + +## -description +Indicates whether the track data contains start and end sentinel values. + +## -property-value +True if the track data contains start and end sentinel values. False if the track data properties only contain track data between sentinels. + +## -remarks +This property is initialized to false. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md b/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md index 64fe97309c..e3f35c6a70 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md @@ -1,29 +1,29 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested - -## -description -Occurs when the device gets a request to release its exclusive claim. - -## -remarks - -## -examples -The following example shows how to setup the event handler. - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)][!code-cs[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] - - - -> [!div class="tabbedCodeSnippets"][!code-cpp[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderReleaseDeviceRequested)][!code-cs[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderReleaseDeviceRequested)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested + +## -description +Occurs when the device gets a request to release its exclusive claim. + +## -remarks + +## -examples +The following example shows how to setup the event handler. + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)][!code-cs[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] + + + +> [!div class="tabbedCodeSnippets"][!code-cpp[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderReleaseDeviceRequested)][!code-cs[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderReleaseDeviceRequested)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_resetstatisticsasync_1362172727.md b/windows.devices.pointofservice/claimedmagneticstripereader_resetstatisticsasync_1362172727.md index c94f5114c1..4ec1751642 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_resetstatisticsasync_1362172727.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_resetstatisticsasync_1362172727.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ResetStatisticsAsync ## -description Resets the specified statistics to zero for all statistics that can be reset. ## -parameters ### -param statisticsCategories The list of names of the statistics to reset. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ## -returns No object or value is returned by this method when it completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ResetStatisticsAsync + +## -description +Resets the specified statistics to zero for all statistics that can be reset. + +## -parameters +### -param statisticsCategories +The list of names of the statistics to reset. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + + +## -returns +No object or value is returned by this method when it completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_retaindevice_1634489834.md b/windows.devices.pointofservice/claimedmagneticstripereader_retaindevice_1634489834.md index b80ca8b12c..2863a82686 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_retaindevice_1634489834.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_retaindevice_1634489834.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetainDevice --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetainDevice ## -description Retains exclusive claim to the magnetic stripe reader. ## -remarks When the application receives a request to release its exclusive claim to the magnetic stripe reader, it must call [RetainDevice](claimedmagneticstripereader_retaindevice.md), otherwise it will lose its claim to the device. ## -examples ## -see-also [ReleaseDeviceRequested](claimedmagneticstripereader_releasedevicerequested.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetainDevice +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetainDevice + +## -description +Retains exclusive claim to the magnetic stripe reader. + +## -remarks +When the application receives a request to release its exclusive claim to the magnetic stripe reader, it must call [RetainDevice](claimedmagneticstripereader_retaindevice.md), otherwise it will lose its claim to the device. + +## -examples + +## -see-also +[ReleaseDeviceRequested](claimedmagneticstripereader_releasedevicerequested.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_retrievedeviceauthenticationdataasync_1404266163.md b/windows.devices.pointofservice/claimedmagneticstripereader_retrievedeviceauthenticationdataasync_1404266163.md index b5e1514685..0fcea9bf79 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_retrievedeviceauthenticationdataasync_1404266163.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_retrievedeviceauthenticationdataasync_1404266163.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetrieveDeviceAuthenticationDataAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetrieveDeviceAuthenticationDataAsync ## -description Retrieves a challenge token from the device. ## -returns Buffer used to store the resulting challenge token from the device. ## -remarks This method is only valid for devices that support authentication. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetrieveDeviceAuthenticationDataAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.RetrieveDeviceAuthenticationDataAsync + +## -description +Retrieves a challenge token from the device. + +## -returns +Buffer used to store the resulting challenge token from the device. + +## -remarks +This method is only valid for devices that support authentication. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_seterrorreportingtype_1688670757.md b/windows.devices.pointofservice/claimedmagneticstripereader_seterrorreportingtype_1688670757.md index 3fb5d702bc..079ac578db 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_seterrorreportingtype_1688670757.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_seterrorreportingtype_1688670757.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.SetErrorReportingType(Windows.Devices.PointOfService.MagneticStripeReaderErrorReportingType) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.SetErrorReportingType ## -description Sets the type of error to report by the [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) event. ## -parameters ### -param value Error reporting type. ## -remarks ## -examples ## -see-also [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.SetErrorReportingType(Windows.Devices.PointOfService.MagneticStripeReaderErrorReportingType) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.SetErrorReportingType + +## -description +Sets the type of error to report by the [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) event. + +## -parameters +### -param value +Error reporting type. + +## -remarks + +## -examples + +## -see-also +[ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_trackstoread.md b/windows.devices.pointofservice/claimedmagneticstripereader_trackstoread.md index e6de7a4682..c6b8e4a1df 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_trackstoread.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_trackstoread.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.TracksToRead --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.TracksToRead ## -description Gets or sets the track data that the application wants to receive following a card swipe. ## -property-value The card track. ## -remarks [TracksToRead](claimedmagneticstripereader_trackstoread.md) determines which tracks the application wants to receive following a card swipe. This does not indicate the capability of the device hardware; instead, it is an application configurable property representing which tracks to read. There are cases when the desired data cannot be obtained, such as cards not having data for a particular track. Decreasing the required number of tracks may provide a greater success rate and somewhat greater responsiveness by removing the processing for inaccessible data. This property is initialized for all tracks (Track1 | Track 2 | Track3 | Track4). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.TracksToRead +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.TracksToRead + +## -description +Gets or sets the track data that the application wants to receive following a card swipe. + +## -property-value +The card track. + +## -remarks +[TracksToRead](claimedmagneticstripereader_trackstoread.md) determines which tracks the application wants to receive following a card swipe. This does not indicate the capability of the device hardware; instead, it is an application configurable property representing which tracks to read. There are cases when the desired data cannot be obtained, such as cards not having data for a particular track. + +Decreasing the required number of tracks may provide a greater success rate and somewhat greater responsiveness by removing the processing for inaccessible data. + +This property is initialized for all tracks (Track1 | Track 2 | Track3 | Track4). + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_updatekeyasync_1087865289.md b/windows.devices.pointofservice/claimedmagneticstripereader_updatekeyasync_1087865289.md index facbe38837..9de86d4be3 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_updatekeyasync_1087865289.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_updatekeyasync_1087865289.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateKeyAsync(System.String,System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateKeyAsync ## -description Provides a new encryption key to the device. ## -parameters ### -param key The HEX-ASCII or base64-encoded value for the new key. ### -param keyName The name used to identify the key. ## -returns ## -remarks This method is only used for those encryption algorithms in which the new key values are sent to the terminal as a field in standard messages from the host. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateKeyAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateKeyAsync + +## -description +Provides a new encryption key to the device. + +## -parameters +### -param key +The HEX-ASCII or base64-encoded value for the new key. + +### -param keyName +The name used to identify the key. + +## -returns + + +## -remarks +This method is only used for those encryption algorithms in which the new key values are sent to the terminal as a field in standard messages from the host. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_updatestatisticsasync_1631267301.md b/windows.devices.pointofservice/claimedmagneticstripereader_updatestatisticsasync_1631267301.md index ca578a5cd5..eb5db19a52 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_updatestatisticsasync_1631267301.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_updatestatisticsasync_1631267301.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateStatisticsAsync ## -description Updates the specified statistics. ## -parameters ### -param statistics The list of key-value pairs of statistics to update. + An empty string ("", "value1") sets all statistics that can be set to value1. + "U_", "value2" sets all UnifiedPOS defined statistics that can be set to value2. + "M_", "value3" sets all manufacturer defined statistics that can be set to value3. + "name1", "value4" sets specific named statistics as defined by the UnifiedPOS or manufacturer to value4. ## -returns No object or value is returned by this method when it completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.UpdateStatisticsAsync + +## -description +Updates the specified statistics. + +## -parameters +### -param statistics +The list of key-value pairs of statistics to update. ++ An empty string ("", "value1") sets all statistics that can be set to value1. ++ "U_", "value2" sets all UnifiedPOS defined statistics that can be set to value2. ++ "M_", "value3" sets all manufacturer defined statistics that can be set to value3. ++ "name1", "value4" sets specific named statistics as defined by the UnifiedPOS or manufacturer to value4. + + +## -returns +No object or value is returned by this method when it completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_vendorspecificdatareceived.md b/windows.devices.pointofservice/claimedmagneticstripereader_vendorspecificdatareceived.md index 0b24f24379..a5838a4d8c 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_vendorspecificdatareceived.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_vendorspecificdatareceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.VendorSpecificDataReceived --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedMagneticStripeReader.VendorSpecificDataReceived ## -description Occurs when a vendor-specific card is swiped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.VendorSpecificDataReceived +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.VendorSpecificDataReceived + +## -description +Occurs when a vendor-specific card is swiped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter.md b/windows.devices.pointofservice/claimedposprinter.md index a4b1c9c38e..536948e128 100644 --- a/windows.devices.pointofservice/claimedposprinter.md +++ b/windows.devices.pointofservice/claimedposprinter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedPosPrinter --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedPosPrinter ## -description Represent a point-of-service printer that has been claimed for use. ## -remarks To get an instance of the [ClaimedPosPrinter](claimedposprinter.md) class, use the [PosPrinter.ClaimPrinterAsync](posprinter_claimprinterasync.md) method. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [PosPrinter.ClaimPrinterAsync](posprinter_claimprinterasync.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedPosPrinter +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter + +## -description +Represent a point-of-service printer that has been claimed for use. + +## -remarks +To get an instance of the [ClaimedPosPrinter](claimedposprinter.md) class, use the [PosPrinter.ClaimPrinterAsync](posprinter_claimprinterasync.md) method. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [PosPrinter.ClaimPrinterAsync](posprinter_claimprinterasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_characterset.md b/windows.devices.pointofservice/claimedposprinter_characterset.md index 860411da3e..c9d461225f 100644 --- a/windows.devices.pointofservice/claimedposprinter_characterset.md +++ b/windows.devices.pointofservice/claimedposprinter_characterset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.CharacterSet --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.CharacterSet ## -description Gets or sets a numeric value that indicates the character set that the application wants to use for printing characters. ## -property-value The character set that the application wants to use for printing characters. ## -remarks ## -examples ## -see-also [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.CharacterSet +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.CharacterSet + +## -description +Gets or sets a numeric value that indicates the character set that the application wants to use for printing characters. + +## -property-value +The character set that the application wants to use for printing characters. + +## -remarks + +## -examples + +## -see-also +[PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_close_811482585.md b/windows.devices.pointofservice/claimedposprinter_close_811482585.md index 18739203d8..112b9666c8 100644 --- a/windows.devices.pointofservice/claimedposprinter_close_811482585.md +++ b/windows.devices.pointofservice/claimedposprinter_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.Close --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.Close ## -description Disposes the claimed point-of-service printer object synchronously, releases the exclusive claim on the printer and disables it. ## -remarks You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.Close + +## -description +Disposes the claimed point-of-service printer object synchronously, releases the exclusive claim on the printer and disables it. + +## -remarks +You cannot call [Close](../windows.foundation/iclosable_close.md) methods through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](../windows.foundation/iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_deviceid.md b/windows.devices.pointofservice/claimedposprinter_deviceid.md index ed251ad2c0..557cd34df9 100644 --- a/windows.devices.pointofservice/claimedposprinter_deviceid.md +++ b/windows.devices.pointofservice/claimedposprinter_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.DeviceId ## -description Gets the identifier string of the claimed point-of-service printer. ## -property-value The identifier of the claimed point-of-service printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.DeviceId + +## -description +Gets the identifier string of the claimed point-of-service printer. + +## -property-value +The identifier of the claimed point-of-service printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_disableasync_490053963.md b/windows.devices.pointofservice/claimedposprinter_disableasync_490053963.md index 77dfcc63bc..5e68e50722 100644 --- a/windows.devices.pointofservice/claimedposprinter_disableasync_490053963.md +++ b/windows.devices.pointofservice/claimedposprinter_disableasync_490053963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.DisableAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.DisableAsync ## -description Notifies the underlying hardware to turn off. ## -returns True if the attempt turn off the printer succeeded; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.DisableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.DisableAsync + +## -description +Notifies the underlying hardware to turn off. + +## -returns +True if the attempt turn off the printer succeeded; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_enableasync_208845947.md b/windows.devices.pointofservice/claimedposprinter_enableasync_208845947.md index 8b3cb2f570..d09ad3393e 100644 --- a/windows.devices.pointofservice/claimedposprinter_enableasync_208845947.md +++ b/windows.devices.pointofservice/claimedposprinter_enableasync_208845947.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.EnableAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.EnableAsync ## -description Notifies the underlying hardware asynchronously to power on for use. ## -returns True if the attempt to turn on the printer succeeded; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.EnableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.EnableAsync + +## -description +Notifies the underlying hardware asynchronously to power on for use. + +## -returns +True if the attempt to turn on the printer succeeded; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_ischaractersetmappingenabled.md b/windows.devices.pointofservice/claimedposprinter_ischaractersetmappingenabled.md index 5655ff7861..1760e89df7 100644 --- a/windows.devices.pointofservice/claimedposprinter_ischaractersetmappingenabled.md +++ b/windows.devices.pointofservice/claimedposprinter_ischaractersetmappingenabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.IsCharacterSetMappingEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.IsCharacterSetMappingEnabled ## -description Gets or sets whether the driver or provider can map Unicode characters to characters that the point-of-service printer can print, or just sends the low byte of the Unicode character to the printer directly. ## -property-value True if the driver or provider maps Unicode characters to character that the point-of-service printer can print. False if the driver or provider sends the low byte of each Unicode character to the point-of-service printer directly. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md), [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.IsCharacterSetMappingEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.IsCharacterSetMappingEnabled + +## -description +Gets or sets whether the driver or provider can map Unicode characters to characters that the point-of-service printer can print, or just sends the low byte of the Unicode character to the printer directly. + +## -property-value +True if the driver or provider maps Unicode characters to character that the point-of-service printer can print. False if the driver or provider sends the low byte of each Unicode character to the point-of-service printer directly. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md), [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_iscoveropen.md b/windows.devices.pointofservice/claimedposprinter_iscoveropen.md index 27de0408ca..2b82ff4ac4 100644 --- a/windows.devices.pointofservice/claimedposprinter_iscoveropen.md +++ b/windows.devices.pointofservice/claimedposprinter_iscoveropen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.IsCoverOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.IsCoverOpen ## -description Gets whether the cover of the point-of-service printer is currently open. ## -property-value True if the cover of the printer is currently open; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.IsCoverOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.IsCoverOpen + +## -description +Gets whether the cover of the point-of-service printer is currently open. + +## -property-value +True if the cover of the printer is currently open; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_isenabled.md b/windows.devices.pointofservice/claimedposprinter_isenabled.md index 95c3ed8c03..3a6e3ad87b 100644 --- a/windows.devices.pointofservice/claimedposprinter_isenabled.md +++ b/windows.devices.pointofservice/claimedposprinter_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.IsEnabled --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.IsEnabled ## -description Gets whether the printer is powered on for use. ## -property-value True if the printer is powered on for use; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.IsEnabled + +## -description +Gets whether the printer is powered on for use. + +## -property-value +True if the printer is powered on for use; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_journal.md b/windows.devices.pointofservice/claimedposprinter_journal.md index f09f24e8b6..632a9f0315 100644 --- a/windows.devices.pointofservice/claimedposprinter_journal.md +++ b/windows.devices.pointofservice/claimedposprinter_journal.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.Journal --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.Journal ## -description Gets an object that represents the journal station for a claimed point-of-service printer. The journal station is used for simple text messages that log transaction and activity information kept by the store for audit and other purposes. There is only one instance of this object per [ClaimedPosPrinter](claimedposprinter.md) instance. Additionally, this is only valid to access if [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md) indicates it is present. ## -property-value An object that represents the journal station for a claimed point-of-service printer. Null if a journal station is not present. ## -remarks You should check the value of the [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md) property before you try to use the [ClaimedPosPrinter.Journal](claimedposprinter_journal.md) property. ## -examples ## -see-also [ClaimedJournalPrinter](claimedjournalprinter.md), [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.Journal +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.Journal + +## -description +Gets an object that represents the journal station for a claimed point-of-service printer. + +The journal station is used for simple text messages that log transaction and activity information kept by the store for audit and other purposes. + +There is only one instance of this object per [ClaimedPosPrinter](claimedposprinter.md) instance. Additionally, this is only valid to access if [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md) indicates it is present. + +## -property-value +An object that represents the journal station for a claimed point-of-service printer. Null if a journal station is not present. + +## -remarks +You should check the value of the [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md) property before you try to use the [ClaimedPosPrinter.Journal](claimedposprinter_journal.md) property. + +## -examples + +## -see-also +[ClaimedJournalPrinter](claimedjournalprinter.md), [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_mapmode.md b/windows.devices.pointofservice/claimedposprinter_mapmode.md index 1b34d8044e..af503ac5ac 100644 --- a/windows.devices.pointofservice/claimedposprinter_mapmode.md +++ b/windows.devices.pointofservice/claimedposprinter_mapmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.MapMode --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.MapMode ## -description Gets or sets the mapping mode of the point-of-service printer that the app wants to use. The mapping mode defines the unit of measure used for other printer properties, such as line height and line spacing. ## -property-value An enumeration value that indicates the mapping mode of the point-of-service printer that the app wants to use. ## -remarks ## -examples ## -see-also [PosPrinterMapMode](posprintermapmode.md), [ClaimedJournalPrinter.LineHeight](claimedjournalprinter_lineheight.md), [ClaimedJournalPrinter.LineSpacing](claimedjournalprinter_linespacing.md), [ClaimedJournalPrinter.LineWidth](claimedjournalprinter_linewidth.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md), [ClaimedReceiptPrinter.LineWidth](claimedreceiptprinter_linewidth.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ClaimedSlipPrinter.LineWidth](claimedslipprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md), [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.MapMode +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.MapMode + +## -description +Gets or sets the mapping mode of the point-of-service printer that the app wants to use. The mapping mode defines the unit of measure used for other printer properties, such as line height and line spacing. + +## -property-value +An enumeration value that indicates the mapping mode of the point-of-service printer that the app wants to use. + +## -remarks + +## -examples + +## -see-also +[PosPrinterMapMode](posprintermapmode.md), [ClaimedJournalPrinter.LineHeight](claimedjournalprinter_lineheight.md), [ClaimedJournalPrinter.LineSpacing](claimedjournalprinter_linespacing.md), [ClaimedJournalPrinter.LineWidth](claimedjournalprinter_linewidth.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md), [ClaimedReceiptPrinter.LineWidth](claimedreceiptprinter_linewidth.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ClaimedSlipPrinter.LineWidth](claimedslipprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md), [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_receipt.md b/windows.devices.pointofservice/claimedposprinter_receipt.md index 62b465ae9f..93c4bf017d 100644 --- a/windows.devices.pointofservice/claimedposprinter_receipt.md +++ b/windows.devices.pointofservice/claimedposprinter_receipt.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.Receipt --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.Receipt ## -description Gets an object that represents the receipt station for a claimed point-of-service printer. The receipt station is used to print transaction information that is typically given to the customer, or for store reports. The receipt station contains either a knife to automatically cut the paper between transactions, or a tear bar to manually cut the paper. There is only one instance of this object per [ClaimedPosPrinter](claimedposprinter.md) instance. Additionally, this is only valid to access if [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md) indicates it is present. ## -property-value An object that represents the receipt station for a claimed point-of-service printer. Null if a receipt station is not present. ## -remarks You should check the value of the [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md) property before you try to use the [ClaimedPosPrinter.Receipt](claimedposprinter_receipt.md) property. ## -examples ## -see-also [ClaimedReceiptPrinter](claimedreceiptprinter.md), [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.Receipt +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.Receipt + +## -description +Gets an object that represents the receipt station for a claimed point-of-service printer. + +The receipt station is used to print transaction information that is typically given to the customer, or for store reports. The receipt station contains either a knife to automatically cut the paper between transactions, or a tear bar to manually cut the paper. + +There is only one instance of this object per [ClaimedPosPrinter](claimedposprinter.md) instance. Additionally, this is only valid to access if [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md) indicates it is present. + +## -property-value +An object that represents the receipt station for a claimed point-of-service printer. Null if a receipt station is not present. + +## -remarks +You should check the value of the [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md) property before you try to use the [ClaimedPosPrinter.Receipt](claimedposprinter_receipt.md) property. + +## -examples + +## -see-also +[ClaimedReceiptPrinter](claimedreceiptprinter.md), [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_releasedevicerequested.md b/windows.devices.pointofservice/claimedposprinter_releasedevicerequested.md index 5b69eb0217..16f0279ddb 100644 --- a/windows.devices.pointofservice/claimedposprinter_releasedevicerequested.md +++ b/windows.devices.pointofservice/claimedposprinter_releasedevicerequested.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.PointOfService.ClaimedPosPrinter.ReleaseDeviceRequested --api-type: winrt event ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.ReleaseDeviceRequested ## -description Occurs when a point-of-service printer gets a request to release its exclusive claim. ## -remarks When this event occurs, the app has a two-second window of time to call the [RetainDeviceAsync](claimedposprinter_retaindeviceasync.md) so that the app can keep exclusive claim on the device. Alternatively, the app can call [Close](claimedposprinter_close.md) to release the claim and end the window immediately. ## -examples ## -see-also [PosPrinterReleaseDeviceRequestedEventArgs](posprinterreleasedevicerequestedeventargs.md), [RetainDeviceAsync](claimedposprinter_retaindeviceasync.md), [Close](claimedposprinter_close.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedPosPrinter.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.ReleaseDeviceRequested + +## -description +Occurs when a point-of-service printer gets a request to release its exclusive claim. + +## -remarks +When this event occurs, the app has a two-second window of time to call the [RetainDeviceAsync](claimedposprinter_retaindeviceasync.md) so that the app can keep exclusive claim on the device. Alternatively, the app can call [Close](claimedposprinter_close.md) to release the claim and end the window immediately. + +## -examples + +## -see-also +[PosPrinterReleaseDeviceRequestedEventArgs](posprinterreleasedevicerequestedeventargs.md), [RetainDeviceAsync](claimedposprinter_retaindeviceasync.md), [Close](claimedposprinter_close.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_resetstatisticsasync_1362172727.md b/windows.devices.pointofservice/claimedposprinter_resetstatisticsasync_1362172727.md index b4717ede1a..aec63733a4 100644 --- a/windows.devices.pointofservice/claimedposprinter_resetstatisticsasync_1362172727.md +++ b/windows.devices.pointofservice/claimedposprinter_resetstatisticsasync_1362172727.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.ResetStatisticsAsync ## -description Resets the specified statistics to zero for all statistics for the point-of-service printer that can be reset. ## -parameters ### -param statisticsCategories A list of the names of the statistics that you want to reset. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS-defined statistics. + "M_" retrieves all manufacturer-defined statistics. + *Name1* and/or *Name2* retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and group names (*Name3*, "U_", "M_"). . ## -returns An operation that returns true if the reset succeeds, or otherwise returns false. ## -remarks This method represents a change in state. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.ResetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.ResetStatisticsAsync + +## -description +Resets the specified statistics to zero for all statistics for the point-of-service printer that can be reset. + +## -parameters +### -param statisticsCategories +A list of the names of the statistics that you want to reset. + + ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS-defined statistics. ++ "M_" retrieves all manufacturer-defined statistics. ++ *Name1* and/or *Name2* retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and group names (*Name3*, "U_", "M_"). + . + +## -returns +An operation that returns true if the reset succeeds, or otherwise returns false. + +## -remarks +This method represents a change in state. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedposprinter_retaindeviceasync_1460106534.md b/windows.devices.pointofservice/claimedposprinter_retaindeviceasync_1460106534.md index 5238cc7af1..4e2f6c7b36 100644 --- a/windows.devices.pointofservice/claimedposprinter_retaindeviceasync_1460106534.md +++ b/windows.devices.pointofservice/claimedposprinter_retaindeviceasync_1460106534.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.RetainDeviceAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.RetainDeviceAsync ## -description Retains the claim on the point-of-service printer asynchronously, usually in response to the [ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) event. ## -returns True if the printer was successfully retained; otherwise, false. ## -remarks ## -examples ## -see-also [ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.RetainDeviceAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.RetainDeviceAsync + +## -description +Retains the claim on the point-of-service printer asynchronously, usually in response to the [ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) event. + +## -returns +True if the printer was successfully retained; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_slip.md b/windows.devices.pointofservice/claimedposprinter_slip.md index 263e248260..d1d75e9b0d 100644 --- a/windows.devices.pointofservice/claimedposprinter_slip.md +++ b/windows.devices.pointofservice/claimedposprinter_slip.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.Slip --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.Slip ## -description Gets an object that represents the slip station for a claimed point-of-service printer. The slip station is used to print information on a form that is typically given to the customer, or to print validation information on a form. The form type is usually a check or credit card slip. There is only one instance of this object per [ClaimedPosPrinter](claimedposprinter.md) instance. Additionally, this is only valid to access if [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) indicates it is present. ## -property-value An object that represents the slip station for a claimed point-of-service printer. Null if a slip station is not present. ## -remarks You should check the value of the [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) property before you try to use the [ClaimedPosPrinter.Slip](claimedposprinter_slip.md) property. ## -examples ## -see-also [ClaimedSlipPrinter](claimedslipprinter.md), [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedPosPrinter.Slip +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.Slip + +## -description +Gets an object that represents the slip station for a claimed point-of-service printer. + +The slip station is used to print information on a form that is typically given to the customer, or to print validation information on a form. The form type is usually a check or credit card slip. + +There is only one instance of this object per [ClaimedPosPrinter](claimedposprinter.md) instance. Additionally, this is only valid to access if [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) indicates it is present. + +## -property-value +An object that represents the slip station for a claimed point-of-service printer. Null if a slip station is not present. + +## -remarks +You should check the value of the [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) property before you try to use the [ClaimedPosPrinter.Slip](claimedposprinter_slip.md) property. + +## -examples + +## -see-also +[ClaimedSlipPrinter](claimedslipprinter.md), [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedposprinter_updatestatisticsasync_1631267301.md b/windows.devices.pointofservice/claimedposprinter_updatestatisticsasync_1631267301.md index 50231488af..be71b10c5f 100644 --- a/windows.devices.pointofservice/claimedposprinter_updatestatisticsasync_1631267301.md +++ b/windows.devices.pointofservice/claimedposprinter_updatestatisticsasync_1631267301.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedPosPrinter.UpdateStatisticsAsync ## -description Updates the specified statistics for the point-of-service printer. ## -parameters ### -param statistics The statistics to update. ## -returns An operation that returns true if the update succeeds, or otherwise returns false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedPosPrinter.UpdateStatisticsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedPosPrinter.UpdateStatisticsAsync + +## -description +Updates the specified statistics for the point-of-service printer. + +## -parameters +### -param statistics +The statistics to update. + +## -returns +An operation that returns true if the update succeeds, or otherwise returns false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedreceiptprinter.md b/windows.devices.pointofservice/claimedreceiptprinter.md index 5c80b99545..756c75a309 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter.md +++ b/windows.devices.pointofservice/claimedreceiptprinter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedReceiptPrinter --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter ## -description Represents a receipt printer station that has been claimed for use. ## -remarks To get a [ClaimedReceiptPrinter](claimedreceiptprinter.md) object, use the [ClaimedPosPrinter.Receipt](claimedposprinter_receipt.md) property. ## -examples ## -see-also [ICommonClaimedPosPrinterStation](icommonclaimedposprinterstation.md), [ClaimedPosPrinter.Receipt](claimedposprinter_receipt.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedReceiptPrinter +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter + +## -description +Represents a receipt printer station that has been claimed for use. + +## -remarks +To get a [ClaimedReceiptPrinter](claimedreceiptprinter.md) object, use the [ClaimedPosPrinter.Receipt](claimedposprinter_receipt.md) property. + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation](icommonclaimedposprinterstation.md), [ClaimedPosPrinter.Receipt](claimedposprinter_receipt.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_charactersperline.md b/windows.devices.pointofservice/claimedreceiptprinter_charactersperline.md index 7414170125..8109948ec7 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_charactersperline.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_charactersperline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.CharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.CharactersPerLine ## -description Gets or sets the number of characters the receipt printer station can print per line of text. ## -property-value The number of characters the receipt printer station can print per line of text. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.CharactersPerLine](icommonclaimedposprinterstation_charactersperline.md), [ReceiptPrinterCapabilities.SupportedCharactersPerLine](receiptprintercapabilities_supportedcharactersperline.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.CharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.CharactersPerLine + +## -description +Gets or sets the number of characters the receipt printer station can print per line of text. + +## -property-value +The number of characters the receipt printer station can print per line of text. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.CharactersPerLine](icommonclaimedposprinterstation_charactersperline.md), [ReceiptPrinterCapabilities.SupportedCharactersPerLine](receiptprintercapabilities_supportedcharactersperline.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_colorcartridge.md b/windows.devices.pointofservice/claimedreceiptprinter_colorcartridge.md index 0e4ee8e0c7..dfbda3b82c 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_colorcartridge.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_colorcartridge.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.ColorCartridge --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.ColorCartridge ## -description Gets or sets the color cartridge that the receipt printer station should use when it prints. ## -property-value An enumeration value that identifies the color cartridge that the receipt printer station should use when it prints. ## -remarks ## -examples ## -see-also [PosPrinterColorCartridge](posprintercolorcartridge.md), [ICommonClaimedPosPrinterStation.ColorCartridge](icommonclaimedposprinterstation_colorcartridge.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.ColorCartridge +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.ColorCartridge + +## -description +Gets or sets the color cartridge that the receipt printer station should use when it prints. + +## -property-value +An enumeration value that identifies the color cartridge that the receipt printer station should use when it prints. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCartridge](posprintercolorcartridge.md), [ICommonClaimedPosPrinterStation.ColorCartridge](icommonclaimedposprinterstation_colorcartridge.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_createjob_1417454808.md b/windows.devices.pointofservice/claimedreceiptprinter_createjob_1417454808.md index 45451df0c5..b678201e61 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_createjob_1417454808.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_createjob_1417454808.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedReceiptPrinter.CreateJob --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.CreateJob ## -description Creates a new print job for the receipt printer station. ## -returns The new print job for the receipt printer station. ## -remarks ## -examples ## -see-also [ReceiptPrintJob](receiptprintjob.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedReceiptPrinter.CreateJob +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.CreateJob + +## -description +Creates a new print job for the receipt printer station. + +## -returns +The new print job for the receipt printer station. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrintJob](receiptprintjob.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeempty.md b/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeempty.md index 34e60e2218..e505f605a8 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeempty.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeempty.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeEmpty ## -description Gets whether the cartridge of the receipt printer station is currently out of ink or toner. ## -property-value True if the cartridge of the receipt printer station is currently out of ink or toner; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCartridgeEmpty](icommonclaimedposprinterstation_iscartridgeempty.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeEmpty + +## -description +Gets whether the cartridge of the receipt printer station is currently out of ink or toner. + +## -property-value +True if the cartridge of the receipt printer station is currently out of ink or toner; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCartridgeEmpty](icommonclaimedposprinterstation_iscartridgeempty.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeremoved.md b/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeremoved.md index 5d178ca0bc..6ab8cf02ea 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeremoved.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_iscartridgeremoved.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeRemoved --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeRemoved ## -description Gets whether the cartridge of the receipt printer station is currently removed. ## -property-value True if the cartridge of the receipt printer station is currently removed; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCartridgeRemoved](icommonclaimedposprinterstation_iscartridgeremoved.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeRemoved +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCartridgeRemoved + +## -description +Gets whether the cartridge of the receipt printer station is currently removed. + +## -property-value +True if the cartridge of the receipt printer station is currently removed; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCartridgeRemoved](icommonclaimedposprinterstation_iscartridgeremoved.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_iscoveropen.md b/windows.devices.pointofservice/claimedreceiptprinter_iscoveropen.md index c0f4387c53..09e0430655 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_iscoveropen.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_iscoveropen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCoverOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCoverOpen ## -description Gets whether the cover of the receipt printer station is currently open. ## -property-value True if the cover of the receipt printer station is currently open; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCoverOpen](icommonclaimedposprinterstation_iscoveropen.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCoverOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsCoverOpen + +## -description +Gets whether the cover of the receipt printer station is currently open. + +## -property-value +True if the cover of the receipt printer station is currently open; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCoverOpen](icommonclaimedposprinterstation_iscoveropen.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_isheadcleaning.md b/windows.devices.pointofservice/claimedreceiptprinter_isheadcleaning.md index d80a0fb68a..b4dea6af9b 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_isheadcleaning.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_isheadcleaning.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsHeadCleaning --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsHeadCleaning ## -description Gets whether the receipt printer station is currently cleaning its print head. ## -property-value True if the receipt printer station is currently cleaning its print head; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsHeadCleaning](icommonclaimedposprinterstation_isheadcleaning.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsHeadCleaning +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsHeadCleaning + +## -description +Gets whether the receipt printer station is currently cleaning its print head. + +## -property-value +True if the receipt printer station is currently cleaning its print head; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsHeadCleaning](icommonclaimedposprinterstation_isheadcleaning.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_isletterquality.md b/windows.devices.pointofservice/claimedreceiptprinter_isletterquality.md index b3932cc147..30ec2f75aa 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_isletterquality.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_isletterquality.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsLetterQuality --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsLetterQuality ## -description Gets or sets whether the receipt printer station prints with high quality or high speed. ## -property-value True if the receipt printer station prints with high quality. False if the receipt printer station prints with high speed. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsLetterQuality](icommonclaimedposprinterstation_isletterquality.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsLetterQuality +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsLetterQuality + +## -description +Gets or sets whether the receipt printer station prints with high quality or high speed. + +## -property-value +True if the receipt printer station prints with high quality. False if the receipt printer station prints with high speed. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsLetterQuality](icommonclaimedposprinterstation_isletterquality.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_ispaperempty.md b/windows.devices.pointofservice/claimedreceiptprinter_ispaperempty.md index 17ab7c9b57..87004fbda1 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_ispaperempty.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_ispaperempty.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperEmpty ## -description Gets whether the receipt printer station needs paper. ## -property-value True if the receipt printer station needs paper; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsPaperEmpty](icommonclaimedposprinterstation_ispaperempty.md), [ReceiptPrinterCapabilities.IsPaperEmptySensorSupported](receiptprintercapabilities_ispaperemptysensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperEmpty + +## -description +Gets whether the receipt printer station needs paper. + +## -property-value +True if the receipt printer station needs paper; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsPaperEmpty](icommonclaimedposprinterstation_ispaperempty.md), [ReceiptPrinterCapabilities.IsPaperEmptySensorSupported](receiptprintercapabilities_ispaperemptysensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_ispapernearend.md b/windows.devices.pointofservice/claimedreceiptprinter_ispapernearend.md index 5da8cfb509..af194b7ae7 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_ispapernearend.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_ispapernearend.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperNearEnd --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperNearEnd ## -description Gets whether the receipt printer station is almost out of paper. ## -property-value True if the receipt printer station is almost out of paper; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsPaperNearEnd](icommonclaimedposprinterstation_ispapernearend.md), [ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported](receiptprintercapabilities_ispapernearendsensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperNearEnd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsPaperNearEnd + +## -description +Gets whether the receipt printer station is almost out of paper. + +## -property-value +True if the receipt printer station is almost out of paper; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsPaperNearEnd](icommonclaimedposprinterstation_ispapernearend.md), [ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported](receiptprintercapabilities_ispapernearendsensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_isreadytoprint.md b/windows.devices.pointofservice/claimedreceiptprinter_isreadytoprint.md index ab19fb193b..0d47d084a8 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_isreadytoprint.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_isreadytoprint.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsReadyToPrint --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsReadyToPrint ## -description Gets whether the receipt printer station is on and accepting print jobs. ## -property-value True if the receipt printer station is on and accepting print jobs; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsReadyToPrint](icommonclaimedposprinterstation_isreadytoprint.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsReadyToPrint +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.IsReadyToPrint + +## -description +Gets whether the receipt printer station is on and accepting print jobs. + +## -property-value +True if the receipt printer station is on and accepting print jobs; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsReadyToPrint](icommonclaimedposprinterstation_isreadytoprint.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_lineheight.md b/windows.devices.pointofservice/claimedreceiptprinter_lineheight.md index 12728d9ac8..197c2a5fe8 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_lineheight.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_lineheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineHeight --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineHeight ## -description Gets or sets the current height of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The current height of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md), [ClaimedReceiptPrinter.LineWidth](claimedreceiptprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineHeight +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineHeight + +## -description +Gets or sets the current height of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The current height of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md), [ClaimedReceiptPrinter.LineWidth](claimedreceiptprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_linespacing.md b/windows.devices.pointofservice/claimedreceiptprinter_linespacing.md index e9e43e9d14..0a97c490b5 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_linespacing.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_linespacing.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineSpacing --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineSpacing ## -description Gets or sets the spacing of each single-high print line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. ## -property-value The spacing of each single-high print line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineSpacing +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineSpacing + +## -description +Gets or sets the spacing of each single-high print line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. + + + +## -property-value +The spacing of each single-high print line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_linestopapercut.md b/windows.devices.pointofservice/claimedreceiptprinter_linestopapercut.md index ddb0d3c5b5..f56098c541 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_linestopapercut.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_linestopapercut.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LinesToPaperCut --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.LinesToPaperCut ## -description Gets the number of lines that must be advanced before cutting the receipt paper. ## -property-value The number of lines that must be advanced before cutting the receipt paper. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LinesToPaperCut +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.LinesToPaperCut + +## -description +Gets the number of lines that must be advanced before cutting the receipt paper. + +## -property-value +The number of lines that must be advanced before cutting the receipt paper. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedreceiptprinter_linewidth.md b/windows.devices.pointofservice/claimedreceiptprinter_linewidth.md index 3984630c4d..dca229ef99 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_linewidth.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_linewidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineWidth --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineWidth ## -description Gets the current width of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The current width of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineWidth +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.LineWidth + +## -description +Gets the current width of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The current width of the printed line for the receipt printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_pagesize.md b/windows.devices.pointofservice/claimedreceiptprinter_pagesize.md index 18a7e99fa8..fab10baef6 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_pagesize.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_pagesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.PageSize --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.PageSize ## -description Gets the size of paper that the claimed receipt printer station currently uses. ## -property-value The size of paper that the claimed receipt printer station currently uses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.PageSize +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.PageSize + +## -description +Gets the size of paper that the claimed receipt printer station currently uses. + +## -property-value +The size of paper that the claimed receipt printer station currently uses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedreceiptprinter_printarea.md b/windows.devices.pointofservice/claimedreceiptprinter_printarea.md index d6cce5e4be..fc6c614a1d 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_printarea.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_printarea.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.PrintArea --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.PrintArea ## -description Gets the print area for the receipt printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The print area for the receipt printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.PrintArea +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.PrintArea + +## -description +Gets the print area for the receipt printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The print area for the receipt printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxchars.md b/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxchars.md index 4d938038b9..163117dbbe 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxchars.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxchars.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxChars --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxChars ## -description Gets the maximum number of characters that the receipt printer station can print on each line in sideways mode. ## -property-value The maximum number of characters that the receipt printer station can print on each line in sideways mode. ## -remarks ## -examples ## -see-also [ClaimedReceiptPrinter.SidewaysMaxLines](claimedreceiptprinter_sidewaysmaxlines.md), [ReceiptPrinterCapabilities.IsLeft90RotationSupported](receiptprintercapabilities_isleft90rotationsupported.md), [ReceiptPrinterCapabilities.IsRight90RotationSupported](receiptprintercapabilities_isright90rotationsupported.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxChars +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxChars + +## -description +Gets the maximum number of characters that the receipt printer station can print on each line in sideways mode. + +## -property-value +The maximum number of characters that the receipt printer station can print on each line in sideways mode. + +## -remarks + +## -examples + +## -see-also +[ClaimedReceiptPrinter.SidewaysMaxLines](claimedreceiptprinter_sidewaysmaxlines.md), [ReceiptPrinterCapabilities.IsLeft90RotationSupported](receiptprintercapabilities_isleft90rotationsupported.md), [ReceiptPrinterCapabilities.IsRight90RotationSupported](receiptprintercapabilities_isright90rotationsupported.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxlines.md b/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxlines.md index b299eb1527..6f868fd5cf 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxlines.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_sidewaysmaxlines.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxLines --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxLines ## -description Gets the maximum number of lines that the receipt printer station can print in sideways mode. ## -property-value The maximum number of lines that the receipt printer station can print in sideways mode. ## -remarks ## -examples ## -see-also [ClaimedReceiptPrinter.SidewaysMaxChars](claimedreceiptprinter_sidewaysmaxchars.md), [ReceiptPrinterCapabilities.IsLeft90RotationSupported](receiptprintercapabilities_isleft90rotationsupported.md), [ReceiptPrinterCapabilities.IsRight90RotationSupported](receiptprintercapabilities_isright90rotationsupported.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxLines +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.SidewaysMaxLines + +## -description +Gets the maximum number of lines that the receipt printer station can print in sideways mode. + +## -property-value +The maximum number of lines that the receipt printer station can print in sideways mode. + +## -remarks + +## -examples + +## -see-also +[ClaimedReceiptPrinter.SidewaysMaxChars](claimedreceiptprinter_sidewaysmaxchars.md), [ReceiptPrinterCapabilities.IsLeft90RotationSupported](receiptprintercapabilities_isleft90rotationsupported.md), [ReceiptPrinterCapabilities.IsRight90RotationSupported](receiptprintercapabilities_isright90rotationsupported.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedReceiptPrinter.LineSpacing](claimedreceiptprinter_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedreceiptprinter_validatedata_977746434.md b/windows.devices.pointofservice/claimedreceiptprinter_validatedata_977746434.md index 3ec7b8ccff..faf423c025 100644 --- a/windows.devices.pointofservice/claimedreceiptprinter_validatedata_977746434.md +++ b/windows.devices.pointofservice/claimedreceiptprinter_validatedata_977746434.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedReceiptPrinter.ValidateData(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedReceiptPrinter.ValidateData ## -description Determines whether a data sequence, possibly including one or more escape sequences, is valid for the receipt printer station, before you use that data sequence when you call the [ReceiptPrintJob.Print](receiptprintjob_print.md) and [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md) methods. ## -parameters ### -param data The data sequence that you want to validate before you use it with the [ReceiptPrintJob.Print](receiptprintjob_print.md) method. This sequence may include printable data and escape sequences. If the sequence is not valid, and you use it with [ReceiptPrintJob.Print](receiptprintjob_print.md) anyways, the job fails when you run it with [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [ReceiptPrintJob.Print](receiptprintjob_print.md). ## -returns True if the data passes validation; otherwise false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.ValidateData](icommonclaimedposprinterstation_validatedata.md), [ReceiptPrintJob.Print](receiptprintjob_print.md), [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedReceiptPrinter.ValidateData(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedReceiptPrinter.ValidateData + +## -description +Determines whether a data sequence, possibly including one or more escape sequences, is valid for the receipt printer station, before you use that data sequence when you call the [ReceiptPrintJob.Print](receiptprintjob_print.md) and [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md) methods. + +## -parameters +### -param data +The data sequence that you want to validate before you use it with the [ReceiptPrintJob.Print](receiptprintjob_print.md) method. This sequence may include printable data and escape sequences. + +If the sequence is not valid, and you use it with [ReceiptPrintJob.Print](receiptprintjob_print.md) anyways, the job fails when you run it with [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [ReceiptPrintJob.Print](receiptprintjob_print.md). + +## -returns +True if the data passes validation; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.ValidateData](icommonclaimedposprinterstation_validatedata.md), [ReceiptPrintJob.Print](receiptprintjob_print.md), [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter.md b/windows.devices.pointofservice/claimedslipprinter.md index f7a9c5336f..e1cafa3a6d 100644 --- a/windows.devices.pointofservice/claimedslipprinter.md +++ b/windows.devices.pointofservice/claimedslipprinter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ClaimedSlipPrinter --api-type: winrt class ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter ## -description Represents a slip printer station that has been claimed for use. ## -remarks To get a [ClaimedSlipPrinter ](claimedslipprinter.md) object, use the [ClaimedPosPrinter.Slip](claimedposprinter_slip.md) property. ## -examples ## -see-also [ICommonClaimedPosPrinterStation](icommonclaimedposprinterstation.md), [ClaimedPosPrinter.Slip](claimedposprinter_slip.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedSlipPrinter +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter + +## -description +Represents a slip printer station that has been claimed for use. + +## -remarks +To get a [ClaimedSlipPrinter ](claimedslipprinter.md) object, use the [ClaimedPosPrinter.Slip](claimedposprinter_slip.md) property. + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation](icommonclaimedposprinterstation.md), [ClaimedPosPrinter.Slip](claimedposprinter_slip.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_changeprintside_1548488616.md b/windows.devices.pointofservice/claimedslipprinter_changeprintside_1548488616.md index 568bd50790..7535fc0eab 100644 --- a/windows.devices.pointofservice/claimedslipprinter_changeprintside_1548488616.md +++ b/windows.devices.pointofservice/claimedslipprinter_changeprintside_1548488616.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.ChangePrintSide(Windows.Devices.PointOfService.PosPrinterPrintSide) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.ChangePrintSide ## -description Changes the side of the sheet on which the claimed slip printer station is currently printing. ## -parameters ### -param printSide The side of the sheet on which the claimed slip printer station is currently printing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.ChangePrintSide(Windows.Devices.PointOfService.PosPrinterPrintSide) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.ChangePrintSide + +## -description +Changes the side of the sheet on which the claimed slip printer station is currently printing. + +## -parameters +### -param printSide +The side of the sheet on which the claimed slip printer station is currently printing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedslipprinter_charactersperline.md b/windows.devices.pointofservice/claimedslipprinter_charactersperline.md index c69238b1c4..f7262cbaa0 100644 --- a/windows.devices.pointofservice/claimedslipprinter_charactersperline.md +++ b/windows.devices.pointofservice/claimedslipprinter_charactersperline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.CharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.CharactersPerLine ## -description Gets or sets the number of characters the slip printer station can print per line of text. ## -property-value The number of characters the slip printer station can print per line of text. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.CharactersPerLine](icommonclaimedposprinterstation_charactersperline.md), [SlipPrinterCapabilities.SupportedCharactersPerLine](slipprintercapabilities_supportedcharactersperline.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.CharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.CharactersPerLine + +## -description +Gets or sets the number of characters the slip printer station can print per line of text. + +## -property-value +The number of characters the slip printer station can print per line of text. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.CharactersPerLine](icommonclaimedposprinterstation_charactersperline.md), [SlipPrinterCapabilities.SupportedCharactersPerLine](slipprintercapabilities_supportedcharactersperline.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_closejaws_455707994.md b/windows.devices.pointofservice/claimedslipprinter_closejaws_455707994.md index 12070a9256..b447439345 100644 --- a/windows.devices.pointofservice/claimedslipprinter_closejaws_455707994.md +++ b/windows.devices.pointofservice/claimedslipprinter_closejaws_455707994.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.CloseJaws --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.CloseJaws ## -description Closes the mechanism that holds the slip in place while the slip printer station is printing, typically after the user inserts or removes the slip. ## -remarks ## -examples ## -see-also [OpenJaws](claimedslipprinter_openjaws.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.CloseJaws +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.CloseJaws + +## -description +Closes the mechanism that holds the slip in place while the slip printer station is printing, typically after the user inserts or removes the slip. + +## -remarks + +## -examples + +## -see-also +[OpenJaws](claimedslipprinter_openjaws.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_colorcartridge.md b/windows.devices.pointofservice/claimedslipprinter_colorcartridge.md index 7c61ade74a..1fba7953bb 100644 --- a/windows.devices.pointofservice/claimedslipprinter_colorcartridge.md +++ b/windows.devices.pointofservice/claimedslipprinter_colorcartridge.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.ColorCartridge --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.ColorCartridge ## -description Gets or sets the color cartridge that the slip printer station should use when it prints. ## -property-value An enumeration value that identifies the color cartridge that the slip printer station should use when it prints. ## -remarks ## -examples ## -see-also [PosPrinterColorCartridge](posprintercolorcartridge.md), [ICommonClaimedPosPrinterStation.ColorCartridge](icommonclaimedposprinterstation_colorcartridge.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.ColorCartridge +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.ColorCartridge + +## -description +Gets or sets the color cartridge that the slip printer station should use when it prints. + +## -property-value +An enumeration value that identifies the color cartridge that the slip printer station should use when it prints. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCartridge](posprintercolorcartridge.md), [ICommonClaimedPosPrinterStation.ColorCartridge](icommonclaimedposprinterstation_colorcartridge.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_createjob_1417454808.md b/windows.devices.pointofservice/claimedslipprinter_createjob_1417454808.md index 9481c3952a..642b1f7c41 100644 --- a/windows.devices.pointofservice/claimedslipprinter_createjob_1417454808.md +++ b/windows.devices.pointofservice/claimedslipprinter_createjob_1417454808.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.CreateJob --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.CreateJob ## -description Creates a new print job for the slip printer stiation. ## -returns The new print job for the slip printer station. ## -remarks ## -examples ## -see-also [SlipPrintJob](slipprintjob.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.CreateJob +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.CreateJob + +## -description +Creates a new print job for the slip printer stiation. + +## -returns +The new print job for the slip printer station. + +## -remarks + +## -examples + +## -see-also +[SlipPrintJob](slipprintjob.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_insertslipasync_1445956481.md b/windows.devices.pointofservice/claimedslipprinter_insertslipasync_1445956481.md index fe586aa850..fa0a6e6fb8 100644 --- a/windows.devices.pointofservice/claimedslipprinter_insertslipasync_1445956481.md +++ b/windows.devices.pointofservice/claimedslipprinter_insertslipasync_1445956481.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.InsertSlipAsync(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.InsertSlipAsync ## -description Waits for the user to insert a slip into the slip printer station. ## -parameters ### -param timeout The interval of time that the operation should wait for the user to insert the slip before exiting. ## -returns An asynchronous operation that returns true if the user inserts the slip within the specified time span, and returns false otherwise. ## -remarks ## -examples ## -see-also [RemoveSlipAsync](claimedslipprinter_removeslipasync.md), [OpenJaws](claimedslipprinter_openjaws.md), [CloseJaws](claimedslipprinter_closejaws.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.InsertSlipAsync(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.InsertSlipAsync + +## -description +Waits for the user to insert a slip into the slip printer station. + +## -parameters +### -param timeout +The interval of time that the operation should wait for the user to insert the slip before exiting. + +## -returns +An asynchronous operation that returns true if the user inserts the slip within the specified time span, and returns false otherwise. + +## -remarks + +## -examples + +## -see-also +[RemoveSlipAsync](claimedslipprinter_removeslipasync.md), [OpenJaws](claimedslipprinter_openjaws.md), [CloseJaws](claimedslipprinter_closejaws.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_iscartridgeempty.md b/windows.devices.pointofservice/claimedslipprinter_iscartridgeempty.md index 4baf3a8aa4..d06ac1e6bb 100644 --- a/windows.devices.pointofservice/claimedslipprinter_iscartridgeempty.md +++ b/windows.devices.pointofservice/claimedslipprinter_iscartridgeempty.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeEmpty ## -description Gets whether the cartridge of the slip printer station is currently out of ink or toner. ## -property-value True if the cartridge of the slip printer station is currently out of ink or toner; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCartridgeEmpty](icommonclaimedposprinterstation_iscartridgeempty.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeEmpty + +## -description +Gets whether the cartridge of the slip printer station is currently out of ink or toner. + +## -property-value +True if the cartridge of the slip printer station is currently out of ink or toner; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCartridgeEmpty](icommonclaimedposprinterstation_iscartridgeempty.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_iscartridgeremoved.md b/windows.devices.pointofservice/claimedslipprinter_iscartridgeremoved.md index 18249e7fa5..3240939237 100644 --- a/windows.devices.pointofservice/claimedslipprinter_iscartridgeremoved.md +++ b/windows.devices.pointofservice/claimedslipprinter_iscartridgeremoved.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeRemoved --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeRemoved ## -description Gets whether the cartridge of the slip printer station is currently removed. ## -property-value True if the cartridge of the slip printer station is currently removed; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCartridgeRemoved](icommonclaimedposprinterstation_iscartridgeremoved.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeRemoved +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCartridgeRemoved + +## -description +Gets whether the cartridge of the slip printer station is currently removed. + +## -property-value +True if the cartridge of the slip printer station is currently removed; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCartridgeRemoved](icommonclaimedposprinterstation_iscartridgeremoved.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_iscoveropen.md b/windows.devices.pointofservice/claimedslipprinter_iscoveropen.md index cda14ae440..5c68357bde 100644 --- a/windows.devices.pointofservice/claimedslipprinter_iscoveropen.md +++ b/windows.devices.pointofservice/claimedslipprinter_iscoveropen.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCoverOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCoverOpen ## -description Gets whether the cover of the slip printer station is currently open. ## -property-value True if the cover of the slip printer station is currently open; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCoverOpen](icommonclaimedposprinterstation_iscoveropen.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCoverOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsCoverOpen + +## -description +Gets whether the cover of the slip printer station is currently open. + +## -property-value +True if the cover of the slip printer station is currently open; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCoverOpen](icommonclaimedposprinterstation_iscoveropen.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_isheadcleaning.md b/windows.devices.pointofservice/claimedslipprinter_isheadcleaning.md index e3e91d5bb2..af85feb16c 100644 --- a/windows.devices.pointofservice/claimedslipprinter_isheadcleaning.md +++ b/windows.devices.pointofservice/claimedslipprinter_isheadcleaning.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsHeadCleaning --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsHeadCleaning ## -description Gets whether the slip printer station is currently cleaning its print head. ## -property-value True if the slip printer station is currently cleaning its print head; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsHeadCleaning](icommonclaimedposprinterstation_isheadcleaning.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsHeadCleaning +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsHeadCleaning + +## -description +Gets whether the slip printer station is currently cleaning its print head. + +## -property-value +True if the slip printer station is currently cleaning its print head; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsHeadCleaning](icommonclaimedposprinterstation_isheadcleaning.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_isletterquality.md b/windows.devices.pointofservice/claimedslipprinter_isletterquality.md index 9c6f221338..e3baa6b143 100644 --- a/windows.devices.pointofservice/claimedslipprinter_isletterquality.md +++ b/windows.devices.pointofservice/claimedslipprinter_isletterquality.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsLetterQuality --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsLetterQuality ## -description Gets or sets whether the slip printer station prints with high quality or high speed. ## -property-value True if the slip printer station prints with high quality. False if the slip printer station with high speed. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsLetterQuality](icommonclaimedposprinterstation_isletterquality.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsLetterQuality +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsLetterQuality + +## -description +Gets or sets whether the slip printer station prints with high quality or high speed. + +## -property-value +True if the slip printer station prints with high quality. False if the slip printer station with high speed. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsLetterQuality](icommonclaimedposprinterstation_isletterquality.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_ispaperempty.md b/windows.devices.pointofservice/claimedslipprinter_ispaperempty.md index e51d741109..01442cfaff 100644 --- a/windows.devices.pointofservice/claimedslipprinter_ispaperempty.md +++ b/windows.devices.pointofservice/claimedslipprinter_ispaperempty.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperEmpty ## -description Gets whether the slip printer station needs paper. ## -property-value True if the slip printer station needs paper; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsPaperEmpty](icommonclaimedposprinterstation_ispaperempty.md), [SlipPrinterCapabilities.IsPaperEmptySensorSupported](slipprintercapabilities_ispaperemptysensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperEmpty + +## -description +Gets whether the slip printer station needs paper. + +## -property-value +True if the slip printer station needs paper; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsPaperEmpty](icommonclaimedposprinterstation_ispaperempty.md), [SlipPrinterCapabilities.IsPaperEmptySensorSupported](slipprintercapabilities_ispaperemptysensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_ispapernearend.md b/windows.devices.pointofservice/claimedslipprinter_ispapernearend.md index 44a1de6fdd..f8417d9801 100644 --- a/windows.devices.pointofservice/claimedslipprinter_ispapernearend.md +++ b/windows.devices.pointofservice/claimedslipprinter_ispapernearend.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperNearEnd --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperNearEnd ## -description Gets whether the slip printer station is almost out of paper. ## -property-value True if the slip printer station is almost out of paper; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsPaperNearEnd](icommonclaimedposprinterstation_ispapernearend.md), [SlipPrinterCapabilities.IsPaperNearEndSensorSupported](slipprintercapabilities_ispapernearendsensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperNearEnd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsPaperNearEnd + +## -description +Gets whether the slip printer station is almost out of paper. + +## -property-value +True if the slip printer station is almost out of paper; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsPaperNearEnd](icommonclaimedposprinterstation_ispapernearend.md), [SlipPrinterCapabilities.IsPaperNearEndSensorSupported](slipprintercapabilities_ispapernearendsensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_isreadytoprint.md b/windows.devices.pointofservice/claimedslipprinter_isreadytoprint.md index 9aef1c6189..160f500951 100644 --- a/windows.devices.pointofservice/claimedslipprinter_isreadytoprint.md +++ b/windows.devices.pointofservice/claimedslipprinter_isreadytoprint.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsReadyToPrint --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.IsReadyToPrint ## -description Gets whether the slip printer station is on and accepting print jobs. ## -property-value True if the slip printer station is on and accepting print jobs; otherwise, false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsReadyToPrint](icommonclaimedposprinterstation_isreadytoprint.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.IsReadyToPrint +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.IsReadyToPrint + +## -description +Gets whether the slip printer station is on and accepting print jobs. + +## -property-value +True if the slip printer station is on and accepting print jobs; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsReadyToPrint](icommonclaimedposprinterstation_isreadytoprint.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_lineheight.md b/windows.devices.pointofservice/claimedslipprinter_lineheight.md index 7fc44d9466..05629feb61 100644 --- a/windows.devices.pointofservice/claimedslipprinter_lineheight.md +++ b/windows.devices.pointofservice/claimedslipprinter_lineheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LineHeight --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.LineHeight ## -description Gets or sets the current height of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The current height of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ClaimedSlipPrinter.LineWidth](claimedslipprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LineHeight +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.LineHeight + +## -description +Gets or sets the current height of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The current height of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ClaimedSlipPrinter.LineWidth](claimedslipprinter_linewidth.md), [ICommonClaimedPosPrinterStation.LineHeight](icommonclaimedposprinterstation_lineheight.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_linesnearendtoend.md b/windows.devices.pointofservice/claimedslipprinter_linesnearendtoend.md index 5e757419ac..5a7dbc2bda 100644 --- a/windows.devices.pointofservice/claimedslipprinter_linesnearendtoend.md +++ b/windows.devices.pointofservice/claimedslipprinter_linesnearendtoend.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LinesNearEndToEnd --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.LinesNearEndToEnd ## -description Gets the number of lines that the slip printer station can print after the [ClaimedSlipPrinter.IsPaperNearEnd](claimedslipprinter_ispapernearend.md) property is set to **true** but before the printer reaches the end of the slip. ## -property-value The number of lines that the slip printer station can print after the [ClaimedSlipPrinter.IsPaperNearEnd](claimedslipprinter_ispapernearend.md) property is set to **true** but before the printer reaches the end of the slip. ## -remarks ## -examples ## -see-also [ClaimedSlipPrinter.IsPaperNearEnd](claimedslipprinter_ispapernearend.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ClaimedSlipPrinter.IsPaperEmpty](claimedslipprinter_ispaperempty.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LinesNearEndToEnd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.LinesNearEndToEnd + +## -description +Gets the number of lines that the slip printer station can print after the [ClaimedSlipPrinter.IsPaperNearEnd](claimedslipprinter_ispapernearend.md) property is set to **true** but before the printer reaches the end of the slip. + +## -property-value +The number of lines that the slip printer station can print after the [ClaimedSlipPrinter.IsPaperNearEnd](claimedslipprinter_ispapernearend.md) property is set to **true** but before the printer reaches the end of the slip. + +## -remarks + +## -examples + +## -see-also +[ClaimedSlipPrinter.IsPaperNearEnd](claimedslipprinter_ispapernearend.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ClaimedSlipPrinter.IsPaperEmpty](claimedslipprinter_ispaperempty.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_linespacing.md b/windows.devices.pointofservice/claimedslipprinter_linespacing.md index 69fc17a254..741ff4aee8 100644 --- a/windows.devices.pointofservice/claimedslipprinter_linespacing.md +++ b/windows.devices.pointofservice/claimedslipprinter_linespacing.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LineSpacing --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.LineSpacing ## -description Gets or sets the spacing of each single-high print line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. ## -property-value The spacing of each single-high print line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LineSpacing +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.LineSpacing + +## -description +Gets or sets the spacing of each single-high print line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. + + + +## -property-value +The spacing of each single-high print line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_linewidth.md b/windows.devices.pointofservice/claimedslipprinter_linewidth.md index b91aaadd0f..11e7b0ecd9 100644 --- a/windows.devices.pointofservice/claimedslipprinter_linewidth.md +++ b/windows.devices.pointofservice/claimedslipprinter_linewidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LineWidth --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.LineWidth ## -description Gets the current width of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The current width of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.LineWidth +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.LineWidth + +## -description +Gets the current width of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The current width of the printed line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_maxlines.md b/windows.devices.pointofservice/claimedslipprinter_maxlines.md index 727923516f..77de538148 100644 --- a/windows.devices.pointofservice/claimedslipprinter_maxlines.md +++ b/windows.devices.pointofservice/claimedslipprinter_maxlines.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.MaxLines --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.MaxLines ## -description Gets the maximum number of lines that the slip printer station can print on a form. ## -property-value The maximum number of lines that the slip printer station can print on a form. ## -remarks ## -examples ## -see-also [SlipPrinterCapabilities.IsFullLengthSupported](slipprintercapabilities_isfulllengthsupported.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.MaxLines +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.MaxLines + +## -description +Gets the maximum number of lines that the slip printer station can print on a form. + +## -property-value +The maximum number of lines that the slip printer station can print on a form. + +## -remarks + +## -examples + +## -see-also +[SlipPrinterCapabilities.IsFullLengthSupported](slipprintercapabilities_isfulllengthsupported.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_openjaws_1310830337.md b/windows.devices.pointofservice/claimedslipprinter_openjaws_1310830337.md index 5e4673b143..c4320a5e54 100644 --- a/windows.devices.pointofservice/claimedslipprinter_openjaws_1310830337.md +++ b/windows.devices.pointofservice/claimedslipprinter_openjaws_1310830337.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.OpenJaws --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.OpenJaws ## -description Opens the mechanism that holds the slip in place while the slip printer station is printing, typically before the user inserts or removes the slip. ## -remarks ## -examples ## -see-also [CloseJaws](claimedslipprinter_closejaws.md), [InsertSlipAsync](claimedslipprinter_insertslipasync.md), [RemoveSlipAsync](claimedslipprinter_removeslipasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.OpenJaws +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.OpenJaws + +## -description +Opens the mechanism that holds the slip in place while the slip printer station is printing, typically before the user inserts or removes the slip. + +## -remarks + +## -examples + +## -see-also +[CloseJaws](claimedslipprinter_closejaws.md), [InsertSlipAsync](claimedslipprinter_insertslipasync.md), [RemoveSlipAsync](claimedslipprinter_removeslipasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_pagesize.md b/windows.devices.pointofservice/claimedslipprinter_pagesize.md index 25cdffcbc3..789dd0c39f 100644 --- a/windows.devices.pointofservice/claimedslipprinter_pagesize.md +++ b/windows.devices.pointofservice/claimedslipprinter_pagesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.PageSize --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.PageSize ## -description Gets the size of paper that the claimed slip printer station currently uses, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The size of paper that the claimed slip printer station currently uses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.PageSize +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.PageSize + +## -description +Gets the size of paper that the claimed slip printer station currently uses, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The size of paper that the claimed slip printer station currently uses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedslipprinter_printarea.md b/windows.devices.pointofservice/claimedslipprinter_printarea.md index 01ce698bf3..ac5e5f9547 100644 --- a/windows.devices.pointofservice/claimedslipprinter_printarea.md +++ b/windows.devices.pointofservice/claimedslipprinter_printarea.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintArea --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintArea ## -description Gets the print area for the slip printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The print area for the slip printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintArea +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintArea + +## -description +Gets the print area for the slip printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The print area for the slip printer station, expressed in the unit of measurement that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_printside.md b/windows.devices.pointofservice/claimedslipprinter_printside.md index dfadd59ce3..2a1e514b28 100644 --- a/windows.devices.pointofservice/claimedslipprinter_printside.md +++ b/windows.devices.pointofservice/claimedslipprinter_printside.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintSide --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintSide ## -description Gets the side of the sheet on which the claimed slip printer station is currently printing. ## -property-value The side of the sheet on which the claimed slip printer station is currently printing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintSide +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.PrintSide + +## -description +Gets the side of the sheet on which the claimed slip printer station is currently printing. + +## -property-value +The side of the sheet on which the claimed slip printer station is currently printing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedslipprinter_removeslipasync_1430912393.md b/windows.devices.pointofservice/claimedslipprinter_removeslipasync_1430912393.md index f4ba740be1..3a0f03cf90 100644 --- a/windows.devices.pointofservice/claimedslipprinter_removeslipasync_1430912393.md +++ b/windows.devices.pointofservice/claimedslipprinter_removeslipasync_1430912393.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.RemoveSlipAsync(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.RemoveSlipAsync ## -description Waits for the user to remove a slip from the slip printer station. ## -parameters ### -param timeout The interval of time that the operation should wait for the user to remove the slip before exiting. ## -returns An asynchronous operation that returns true if the user removes the slip within the specified time span, and returns false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.RemoveSlipAsync(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.RemoveSlipAsync + +## -description +Waits for the user to remove a slip from the slip printer station. + +## -parameters +### -param timeout +The interval of time that the operation should wait for the user to remove the slip before exiting. + +## -returns +An asynchronous operation that returns true if the user removes the slip within the specified time span, and returns false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxchars.md b/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxchars.md index 449175c219..73b86cb958 100644 --- a/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxchars.md +++ b/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxchars.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxChars --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxChars ## -description Gets the maximum number of characters that the slip printer station can print on each line in sideways mode. ## -property-value The maximum number of characters that the slip printer station can print on each line in sideways mode. ## -remarks ## -examples ## -see-also [ClaimedSlipPrinter.SidewaysMaxLines](claimedslipprinter_sidewaysmaxlines.md), [SlipPrinterCapabilities.IsLeft90RotationSupported](slipprintercapabilities_isleft90rotationsupported.md), [SlipPrinterCapabilities.IsRight90RotationSupported](slipprintercapabilities_isright90rotationsupported.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxChars +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxChars + +## -description +Gets the maximum number of characters that the slip printer station can print on each line in sideways mode. + +## -property-value +The maximum number of characters that the slip printer station can print on each line in sideways mode. + +## -remarks + +## -examples + +## -see-also +[ClaimedSlipPrinter.SidewaysMaxLines](claimedslipprinter_sidewaysmaxlines.md), [SlipPrinterCapabilities.IsLeft90RotationSupported](slipprintercapabilities_isleft90rotationsupported.md), [SlipPrinterCapabilities.IsRight90RotationSupported](slipprintercapabilities_isright90rotationsupported.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxlines.md b/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxlines.md index e72f0dc4f9..d00ef9431d 100644 --- a/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxlines.md +++ b/windows.devices.pointofservice/claimedslipprinter_sidewaysmaxlines.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxLines --api-type: winrt property ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxLines ## -description Gets the maximum number of lines that the slip printer station can print in sideways mode. ## -property-value The maximum number of lines that the slip printer station can print in sideways mode. ## -remarks ## -examples ## -see-also [ClaimedSlipPrinter.SidewaysMaxChars](claimedslipprinter_sidewaysmaxchars.md), [SlipPrinterCapabilities.IsLeft90RotationSupported](slipprintercapabilities_isleft90rotationsupported.md), [SlipPrinterCapabilities.IsRight90RotationSupported](slipprintercapabilities_isright90rotationsupported.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxLines +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.SidewaysMaxLines + +## -description +Gets the maximum number of lines that the slip printer station can print in sideways mode. + +## -property-value +The maximum number of lines that the slip printer station can print in sideways mode. + +## -remarks + +## -examples + +## -see-also +[ClaimedSlipPrinter.SidewaysMaxChars](claimedslipprinter_sidewaysmaxchars.md), [SlipPrinterCapabilities.IsLeft90RotationSupported](slipprintercapabilities_isleft90rotationsupported.md), [SlipPrinterCapabilities.IsRight90RotationSupported](slipprintercapabilities_isright90rotationsupported.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md), [ClaimedSlipPrinter.LineSpacing](claimedslipprinter_linespacing.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/claimedslipprinter_validatedata_977746434.md b/windows.devices.pointofservice/claimedslipprinter_validatedata_977746434.md index a75ee273df..3d95f762b4 100644 --- a/windows.devices.pointofservice/claimedslipprinter_validatedata_977746434.md +++ b/windows.devices.pointofservice/claimedslipprinter_validatedata_977746434.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.ValidateData(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ClaimedSlipPrinter.ValidateData ## -description Determines whether a data sequence, possibly including one or more escape sequences, is valid for the slip printer station, before you use that data sequence when you call the [SlipPrintJob.Print](slipprintjob_print.md) and [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md) methods. ## -parameters ### -param data The data sequence that you want to validate before you use it with the [SlipPrintJob.Print](slipprintjob_print.md) method. This sequence may include printable data and escape sequences. If the sequence is not valid, and you use it with [SlipPrintJob.Print](slipprintjob_print.md) anyways, the job fails when you run it with [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [SlipPrintJob.Print](slipprintjob_print.md). ## -returns True if the data passes validation; otherwise false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.ValidateData](icommonclaimedposprinterstation_validatedata.md), [SlipPrintJob.Print](slipprintjob_print.md), [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedSlipPrinter.ValidateData(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedSlipPrinter.ValidateData + +## -description +Determines whether a data sequence, possibly including one or more escape sequences, is valid for the slip printer station, before you use that data sequence when you call the [SlipPrintJob.Print](slipprintjob_print.md) and [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md) methods. + +## -parameters +### -param data +The data sequence that you want to validate before you use it with the [SlipPrintJob.Print](slipprintjob_print.md) method. This sequence may include printable data and escape sequences. + +If the sequence is not valid, and you use it with [SlipPrintJob.Print](slipprintjob_print.md) anyways, the job fails when you run it with [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [SlipPrintJob.Print](slipprintjob_print.md). + +## -returns +True if the data passes validation; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.ValidateData](icommonclaimedposprinterstation_validatedata.md), [SlipPrintJob.Print](slipprintjob_print.md), [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icashdrawereventsourceeventargs_cashdrawer.md b/windows.devices.pointofservice/icashdrawereventsourceeventargs_cashdrawer.md index 01c417d7d3..c239f1276f 100644 --- a/windows.devices.pointofservice/icashdrawereventsourceeventargs_cashdrawer.md +++ b/windows.devices.pointofservice/icashdrawereventsourceeventargs_cashdrawer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICashDrawerEventSourceEventArgs.CashDrawer --api-type: winrt property ---- # Windows.Devices.PointOfService.ICashDrawerEventSourceEventArgs.CashDrawer ## -description Gets the cash drawer associated with the event source. ## -property-value The cash drawer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICashDrawerEventSourceEventArgs.CashDrawer +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICashDrawerEventSourceEventArgs.CashDrawer + +## -description +Gets the cash drawer associated with the event source. + +## -property-value +The cash drawer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_charactersperline.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_charactersperline.md index 5df98b52ab..f893455e95 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_charactersperline.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_charactersperline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.CharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.CharactersPerLine ## -description Gets or sets the number of characters the station can print per line of text. ## -property-value The number of characters the device can print per line of text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.CharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.CharactersPerLine + +## -description +Gets or sets the number of characters the station can print per line of text. + +## -property-value +The number of characters the device can print per line of text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_colorcartridge.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_colorcartridge.md index 7949cfc71a..6adefe13fc 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_colorcartridge.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_colorcartridge.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ColorCartridge --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ColorCartridge ## -description Gets or sets the color cartridge that the printer station should use when it prints. ## -property-value An enumeration value that identifies the color cartridge that the printer station should use when it prints. ## -remarks ## -examples ## -see-also [PosPrinterColorCartridge](posprintercolorcartridge.md), [ClaimedJournalPrinter.ColorCartridge](claimedjournalprinter_colorcartridge.md), [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md), [ClaimedSlipPrinter.ColorCartridge](claimedslipprinter_colorcartridge.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ColorCartridge +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ColorCartridge + +## -description +Gets or sets the color cartridge that the printer station should use when it prints. + +## -property-value +An enumeration value that identifies the color cartridge that the printer station should use when it prints. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCartridge](posprintercolorcartridge.md), [ClaimedJournalPrinter.ColorCartridge](claimedjournalprinter_colorcartridge.md), [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md), [ClaimedSlipPrinter.ColorCartridge](claimedslipprinter_colorcartridge.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeempty.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeempty.md index 1f713b8aa5..9eedb40fea 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeempty.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeempty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeEmpty ## -description Gets whether the cartridge of the printer station is currently out of ink or toner. ## -property-value True if the cartridge of the printer station is currently out of ink or toner; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeEmpty + +## -description +Gets whether the cartridge of the printer station is currently out of ink or toner. + +## -property-value +True if the cartridge of the printer station is currently out of ink or toner; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeremoved.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeremoved.md index bde4845701..849b7be1e4 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeremoved.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_iscartridgeremoved.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeRemoved --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeRemoved ## -description Gets whether the cartridge of the printer station is currently removed. ## -property-value True if the cartridge of the printer station is currently removed; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeRemoved +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCartridgeRemoved + +## -description +Gets whether the cartridge of the printer station is currently removed. + +## -property-value +True if the cartridge of the printer station is currently removed; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_iscoveropen.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_iscoveropen.md index 2e0e00b4b8..fd663eee01 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_iscoveropen.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_iscoveropen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCoverOpen --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCoverOpen ## -description Gets whether the cover of the printer station is currently open. ## -property-value True if the cover of the printer station is currently open; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCoverOpen +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsCoverOpen + +## -description +Gets whether the cover of the printer station is currently open. + +## -property-value +True if the cover of the printer station is currently open; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_isheadcleaning.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_isheadcleaning.md index 3fe3d18847..3a379dab2d 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_isheadcleaning.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_isheadcleaning.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsHeadCleaning --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsHeadCleaning ## -description Gets whether the printer station is currently cleaning its print head. ## -property-value True if the printer station is currently cleaning its print head; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsHeadCleaning +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsHeadCleaning + +## -description +Gets whether the printer station is currently cleaning its print head. + +## -property-value +True if the printer station is currently cleaning its print head; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_isletterquality.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_isletterquality.md index a49d421a17..ccafe49950 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_isletterquality.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_isletterquality.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsLetterQuality --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsLetterQuality ## -description Gets or sets whether the printer station prints with high quality or high speed. ## -property-value True if the printer station prints with high quality. False if the point-of-service printer prints with high speed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsLetterQuality +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsLetterQuality + +## -description +Gets or sets whether the printer station prints with high quality or high speed. + +## -property-value +True if the printer station prints with high quality. False if the point-of-service printer prints with high speed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_ispaperempty.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_ispaperempty.md index e476a8c00a..d89523b97a 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_ispaperempty.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_ispaperempty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperEmpty --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperEmpty ## -description Gets whether the printer station needs paper. ## -property-value True if the printer station needs paper; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperEmpty + +## -description +Gets whether the printer station needs paper. + +## -property-value +True if the printer station needs paper; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_ispapernearend.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_ispapernearend.md index a1229d13a8..914e13a5d2 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_ispapernearend.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_ispapernearend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperNearEnd --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperNearEnd ## -description Gets whether the printer station is almost out of paper. ## -property-value True if the printer station is almost out of paper; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperNearEnd +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsPaperNearEnd + +## -description +Gets whether the printer station is almost out of paper. + +## -property-value +True if the printer station is almost out of paper; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_isreadytoprint.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_isreadytoprint.md index 210684ef24..541a8308ce 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_isreadytoprint.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_isreadytoprint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsReadyToPrint --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsReadyToPrint ## -description Gets whether the printer station is on and accepting print jobs. ## -property-value True if the printer station is on and accepting print jobs; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsReadyToPrint +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.IsReadyToPrint + +## -description +Gets whether the printer station is on and accepting print jobs. + +## -property-value +True if the printer station is on and accepting print jobs; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_lineheight.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_lineheight.md index c7a2462b3c..5dabfaf979 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_lineheight.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_lineheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineHeight --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineHeight ## -description Gets or sets the current height of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The current height of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md), [ClaimedJournalPrinter.LineHeight](claimedjournalprinter_lineheight.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineHeight +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineHeight + +## -description +Gets or sets the current height of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The current height of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md), [ICommonClaimedPosPrinterStation.LineWidth](icommonclaimedposprinterstation_linewidth.md), [ClaimedJournalPrinter.LineHeight](claimedjournalprinter_lineheight.md), [ClaimedReceiptPrinter.LineHeight](claimedreceiptprinter_lineheight.md), [ClaimedSlipPrinter.LineHeight](claimedslipprinter_lineheight.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_linespacing.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_linespacing.md index 36cbfc4898..14fc14683d 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_linespacing.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_linespacing.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineSpacing --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineSpacing ## -description Gets or sets the spacing of each single-high print line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. ## -property-value The spacing of each single-high print line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineSpacing +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineSpacing + +## -description +Gets or sets the spacing of each single-high print line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines. + + + +## -property-value +The spacing of each single-high print line for the slip printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_linewidth.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_linewidth.md index 90bdae803f..908760bb97 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_linewidth.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_linewidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineWidth --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineWidth ## -description Gets the current width of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -property-value The current width of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ ICommonClaimedPosPrinterStation.LineHeight](claimedjournalprinter_lineheight.md), [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md), [ClaimedJournalPrinter.LineWidth](claimedjournalprinter_linewidth.md), [ClaimedReceiptPrinter.LineWidth](claimedreceiptprinter_linewidth.md), [ClaimedSlipPrinter.LineWidth](claimedslipprinter_linewidth.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineWidth +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.LineWidth + +## -description +Gets the current width of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -property-value +The current width of the printed line for the printer station, in the units that the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property specifies. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [ ICommonClaimedPosPrinterStation.LineHeight](claimedjournalprinter_lineheight.md), [ICommonClaimedPosPrinterStation.LineSpacing](icommonclaimedposprinterstation_linespacing.md), [ClaimedJournalPrinter.LineWidth](claimedjournalprinter_linewidth.md), [ClaimedReceiptPrinter.LineWidth](claimedreceiptprinter_linewidth.md), [ClaimedSlipPrinter.LineWidth](claimedslipprinter_linewidth.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonclaimedposprinterstation_validatedata.md b/windows.devices.pointofservice/icommonclaimedposprinterstation_validatedata.md index 5853cd30c1..ccd4697003 100644 --- a/windows.devices.pointofservice/icommonclaimedposprinterstation_validatedata.md +++ b/windows.devices.pointofservice/icommonclaimedposprinterstation_validatedata.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ValidateData(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ValidateData ## -description Determines whether a data sequence, possibly including one or more escape sequences, is valid for the printer station, before you use that data sequence when you call the [IPosPrinterJob.Print](iposprinterjob_print.md) and [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) methods. ## -parameters ### -param data The data sequence that you want to validate before you use it with the [IPosPrinterJob.Print](iposprinterjob_print.md) method. This sequence may include printable data and escape sequences. If the sequence is not valid, and you use it with [IPosPrinterJob.Print](iposprinterjob_print.md) anyways, the job fails when you run it with [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [IPosPrinterJob.Print](iposprinterjob_print.md). ## -returns True if the data passes validation; otherwise false. ## -remarks ## -examples ## -see-also [IPosPrinterJob.Print](iposprinterjob_print.md), [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md), [ClaimedJournalPrinter.ValidateData](claimedjournalprinter_validatedata.md), [ClaimedReceiptPrinter.ValidateData](claimedreceiptprinter_validatedata.md), [ClaimedSlipPrinter.ValidateData](claimedslipprinter_validatedata.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ValidateData(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ICommonClaimedPosPrinterStation.ValidateData + +## -description +Determines whether a data sequence, possibly including one or more escape sequences, is valid for the printer station, before you use that data sequence when you call the [IPosPrinterJob.Print](iposprinterjob_print.md) and [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) methods. + +## -parameters +### -param data +The data sequence that you want to validate before you use it with the [IPosPrinterJob.Print](iposprinterjob_print.md) method. This sequence may include printable data and escape sequences. + +If the sequence is not valid, and you use it with [IPosPrinterJob.Print](iposprinterjob_print.md) anyways, the job fails when you run it with [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md). You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with [IPosPrinterJob.Print](iposprinterjob_print.md). + +## -returns +True if the data passes validation; otherwise false. + +## -remarks + +## -examples + +## -see-also +[IPosPrinterJob.Print](iposprinterjob_print.md), [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md), [ClaimedJournalPrinter.ValidateData](claimedjournalprinter_validatedata.md), [ClaimedReceiptPrinter.ValidateData](claimedreceiptprinter_validatedata.md), [ClaimedSlipPrinter.ValidateData](claimedslipprinter_validatedata.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_cartridgesensors.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_cartridgesensors.md index 6f64bdf141..5f02c44720 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_cartridgesensors.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_cartridgesensors.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.CartridgeSensors --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.CartridgeSensors ## -description Gets information about the sensors that the printer station has available to report the status of the printer station. ## -property-value A combination of enumeration values that indicate the sensors that the printer station has available to report the status of the printer station. ## -remarks ## -examples ## -see-also [PosPrinterCartridgeSensors](posprintercartridgesensors.md), [JournalPrinterCapabilities.CartridgeSensors](journalprintercapabilities_cartridgesensors.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.CartridgeSensors +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.CartridgeSensors + +## -description +Gets information about the sensors that the printer station has available to report the status of the printer station. + +## -property-value +A combination of enumeration values that indicate the sensors that the printer station has available to report the status of the printer station. + +## -remarks + +## -examples + +## -see-also +[PosPrinterCartridgeSensors](posprintercartridgesensors.md), [JournalPrinterCapabilities.CartridgeSensors](journalprintercapabilities_cartridgesensors.md), [ReceiptPrinterCapabilities.CartridgeSensors](receiptprintercapabilities_cartridgesensors.md), [SlipPrinterCapabilities.CartridgeSensors](slipprintercapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_colorcartridgecapabilities.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_colorcartridgecapabilities.md index 6df435b18b..0cf440327f 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_colorcartridgecapabilities.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_colorcartridgecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities ## -description Gets the color cartridges that the printer station can use to print in color. ## -property-value A combination of enumeration values that indicates which color cartridges the printer station can use to print in color. ## -remarks ## -examples ## -see-also [PosPrinterColorCapabilities](posprintercolorcapabilities.md), [JournalPrinterCapabilities.ColorCartridgeCapabilities](journalprintercapabilities_colorcartridgecapabilities.md), [ReceiptPrinterCapabilities.ColorCartridgeCapabilities](receiptprintercapabilities_colorcartridgecapabilities.md), [SlipPrinterCapabilities.ColorCartridgeCapabilities](slipprintercapabilities_colorcartridgecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities + +## -description +Gets the color cartridges that the printer station can use to print in color. + +## -property-value +A combination of enumeration values that indicates which color cartridges the printer station can use to print in color. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCapabilities](posprintercolorcapabilities.md), [JournalPrinterCapabilities.ColorCartridgeCapabilities](journalprintercapabilities_colorcartridgecapabilities.md), [ReceiptPrinterCapabilities.ColorCartridgeCapabilities](receiptprintercapabilities_colorcartridgecapabilities.md), [SlipPrinterCapabilities.ColorCartridgeCapabilities](slipprintercapabilities_colorcartridgecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isboldsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isboldsupported.md index ff65cf2faa..8c29dad7c1 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isboldsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isboldsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsBoldSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsBoldSupported ## -description Gets whether the printer station can print bold characters. ## -property-value True if the printer station can print bold characters; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsBoldSupported](journalprintercapabilities_isboldsupported.md), [ReceiptPrinterCapabilities.IsBoldSupported](receiptprintercapabilities_isboldsupported.md), [SlipPrinterCapabilities.IsBoldSupported](slipprintercapabilities_isboldsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsBoldSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsBoldSupported + +## -description +Gets whether the printer station can print bold characters. + +## -property-value +True if the printer station can print bold characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsBoldSupported](journalprintercapabilities_isboldsupported.md), [ReceiptPrinterCapabilities.IsBoldSupported](receiptprintercapabilities_isboldsupported.md), [SlipPrinterCapabilities.IsBoldSupported](slipprintercapabilities_isboldsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md index 913b97cda3..f766db7194 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported ## -description Gets whether the printer station can print characters that are both double-high and double-wide. ## -property-value True if the printer station can print characters that are both double-high and double-wide; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported](journalprintercapabilities_isdoublehighdoublewideprintsupported.md), [ReceiptPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported](receiptprintercapabilities_isdoublehighdoublewideprintsupported.md), [SlipPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported](slipprintercapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported + +## -description +Gets whether the printer station can print characters that are both double-high and double-wide. + +## -property-value +True if the printer station can print characters that are both double-high and double-wide; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported](journalprintercapabilities_isdoublehighdoublewideprintsupported.md), [ReceiptPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported](receiptprintercapabilities_isdoublehighdoublewideprintsupported.md), [SlipPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported](slipprintercapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighprintsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighprintsupported.md index 81d1217828..9ddd0e4d4c 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighprintsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublehighprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported ## -description Gets whether the printer station can print double-high characters. ## -property-value True if the printer station can print double-high characters; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsDoubleHighPrintSupported](journalprintercapabilities_isdoublehighprintsupported.md), [ReceiptPrinterCapabilities.IsDoubleHighPrintSupported](receiptprintercapabilities_isdoublehighprintsupported.md), [SlipPrinterCapabilities.IsDoubleHighPrintSupported](slipprintercapabilities_isdoublehighprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported + +## -description +Gets whether the printer station can print double-high characters. + +## -property-value +True if the printer station can print double-high characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsDoubleHighPrintSupported](journalprintercapabilities_isdoublehighprintsupported.md), [ReceiptPrinterCapabilities.IsDoubleHighPrintSupported](receiptprintercapabilities_isdoublehighprintsupported.md), [SlipPrinterCapabilities.IsDoubleHighPrintSupported](slipprintercapabilities_isdoublehighprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublewideprintsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublewideprintsupported.md index c9e7fc0649..b6f39368cd 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublewideprintsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported ## -description Gets whether the printer station can print double-wide characters. ## -property-value True if the printer station can print double-wide characters; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsDoubleWidePrintSupported](journalprintercapabilities_isdoublewideprintsupported.md), [ReceiptPrinterCapabilities.IsDoubleWidePrintSupported](receiptprintercapabilities_isdoublewideprintsupported.md), [SlipPrinterCapabilities.IsDoubleWidePrintSupported](slipprintercapabilities_isdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported + +## -description +Gets whether the printer station can print double-wide characters. + +## -property-value +True if the printer station can print double-wide characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsDoubleWidePrintSupported](journalprintercapabilities_isdoublewideprintsupported.md), [ReceiptPrinterCapabilities.IsDoubleWidePrintSupported](receiptprintercapabilities_isdoublewideprintsupported.md), [SlipPrinterCapabilities.IsDoubleWidePrintSupported](slipprintercapabilities_isdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdualcolorsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdualcolorsupported.md index ef09a5cb4c..a507b2695e 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isdualcolorsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isdualcolorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDualColorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDualColorSupported ## -description Gets whether the printer station can print a dark color plus an alternate color. ## -property-value True if the printer station can print a dark color plus an alternate color; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDualColorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsDualColorSupported + +## -description +Gets whether the printer station can print a dark color plus an alternate color. + +## -property-value +True if the printer station can print a dark color plus an alternate color; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isitalicsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isitalicsupported.md index 1c848fabda..7e0051ca86 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isitalicsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isitalicsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsItalicSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsItalicSupported ## -description Gets whether the printer station can print italic characters. ## -property-value True if the printer station can print italic characters; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsItalicSupported](journalprintercapabilities_isitalicsupported.md), [ReceiptPrinterCapabilities.IsItalicSupported](receiptprintercapabilities_isitalicsupported.md), [SlipPrinterCapabilities.IsItalicSupported](slipprintercapabilities_isitalicsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsItalicSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsItalicSupported + +## -description +Gets whether the printer station can print italic characters. + +## -property-value +True if the printer station can print italic characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsItalicSupported](journalprintercapabilities_isitalicsupported.md), [ReceiptPrinterCapabilities.IsItalicSupported](receiptprintercapabilities_isitalicsupported.md), [SlipPrinterCapabilities.IsItalicSupported](slipprintercapabilities_isitalicsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_ispaperemptysensorsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_ispaperemptysensorsupported.md index fd134c2b64..e2d79d7120 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_ispaperemptysensorsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_ispaperemptysensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported ## -description Gets whether the printer station has an out-of-paper sensor. ## -property-value True if the printer station has an out-of-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsPaperEmptySensorSupported](journalprintercapabilities_ispaperemptysensorsupported.md), [ReceiptPrinterCapabilities.IsPaperEmptySensorSupported](receiptprintercapabilities_ispaperemptysensorsupported.md), [SlipPrinterCapabilities.IsPaperEmptySensorSupported](slipprintercapabilities_ispaperemptysensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported + +## -description +Gets whether the printer station has an out-of-paper sensor. + +## -property-value +True if the printer station has an out-of-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsPaperEmptySensorSupported](journalprintercapabilities_ispaperemptysensorsupported.md), [ReceiptPrinterCapabilities.IsPaperEmptySensorSupported](receiptprintercapabilities_ispaperemptysensorsupported.md), [SlipPrinterCapabilities.IsPaperEmptySensorSupported](slipprintercapabilities_ispaperemptysensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_ispapernearendsensorsupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_ispapernearendsensorsupported.md index b47d291192..dc830ed36b 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_ispapernearendsensorsupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_ispapernearendsensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported ## -description Gets whether the printer station has a low-paper sensor. ## -property-value True if the printer station has a low-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsPaperNearEndSensorSupported](journalprintercapabilities_ispapernearendsensorsupported.md), [ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported](receiptprintercapabilities_ispapernearendsensorsupported.md), [SlipPrinterCapabilities.IsPaperNearEndSensorSupported](slipprintercapabilities_ispapernearendsensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported + +## -description +Gets whether the printer station has a low-paper sensor. + +## -property-value +True if the printer station has a low-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsPaperNearEndSensorSupported](journalprintercapabilities_ispapernearendsensorsupported.md), [ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported](receiptprintercapabilities_ispapernearendsensorsupported.md), [SlipPrinterCapabilities.IsPaperNearEndSensorSupported](slipprintercapabilities_ispapernearendsensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isprinterpresent.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isprinterpresent.md index 5f51fb98c2..c0629e4a37 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isprinterpresent.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isprinterpresent.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPrinterPresent --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPrinterPresent ## -description Gets whether a printer station is present. ## -property-value True if a printer station is present; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md), [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md), [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPrinterPresent +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsPrinterPresent + +## -description +Gets whether a printer station is present. + +## -property-value +True if a printer station is present; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsPrinterPresent](journalprintercapabilities_isprinterpresent.md), [ReceiptPrinterCapabilities.IsPrinterPresent](receiptprintercapabilities_isprinterpresent.md), [SlipPrinterCapabilities.IsPrinterPresent](slipprintercapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_isunderlinesupported.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_isunderlinesupported.md index 0ac9107e61..b3e8aa2201 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_isunderlinesupported.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_isunderlinesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsUnderlineSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsUnderlineSupported ## -description Gets whether the printer station can underline characters. ## -property-value True if the printer station can underline characters; otherwise false. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.IsUnderlineSupported](journalprintercapabilities_isunderlinesupported.md), [ReceiptPrinterCapabilities.IsUnderlineSupported](receiptprintercapabilities_isunderlinesupported.md), [SlipPrinterCapabilities.IsUnderlineSupported](slipprintercapabilities_isunderlinesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsUnderlineSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.IsUnderlineSupported + +## -description +Gets whether the printer station can underline characters. + +## -property-value +True if the printer station can underline characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.IsUnderlineSupported](journalprintercapabilities_isunderlinesupported.md), [ReceiptPrinterCapabilities.IsUnderlineSupported](receiptprintercapabilities_isunderlinesupported.md), [SlipPrinterCapabilities.IsUnderlineSupported](slipprintercapabilities_isunderlinesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonposprintstationcapabilities_supportedcharactersperline.md b/windows.devices.pointofservice/icommonposprintstationcapabilities_supportedcharactersperline.md index b7468ef029..d7379ff951 100644 --- a/windows.devices.pointofservice/icommonposprintstationcapabilities_supportedcharactersperline.md +++ b/windows.devices.pointofservice/icommonposprintstationcapabilities_supportedcharactersperline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.SupportedCharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.SupportedCharactersPerLine ## -description Gets a collection of the line widths in characters per line that the printer station supports. ## -property-value A collection of the line widths in characters per line that the printer station supports. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities.SupportedCharactersPerLine](journalprintercapabilities_supportedcharactersperline.md), [ReceiptPrinterCapabilities.SupportedCharactersPerLine](receiptprintercapabilities_supportedcharactersperline.md), [SlipPrinterCapabilities.SupportedCharactersPerLine](slipprintercapabilities_supportedcharactersperline.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.SupportedCharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonPosPrintStationCapabilities.SupportedCharactersPerLine + +## -description +Gets a collection of the line widths in characters per line that the printer station supports. + +## -property-value +A collection of the line widths in characters per line that the printer station supports. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities.SupportedCharactersPerLine](journalprintercapabilities_supportedcharactersperline.md), [ReceiptPrinterCapabilities.SupportedCharactersPerLine](receiptprintercapabilities_supportedcharactersperline.md), [SlipPrinterCapabilities.SupportedCharactersPerLine](slipprintercapabilities_supportedcharactersperline.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_is180rotationsupported.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_is180rotationsupported.md index e226d8bd21..eb618c6a3a 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_is180rotationsupported.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_is180rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.Is180RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.Is180RotationSupported ## -description Gets whether the receipt or slip printer station can print in a rotated upside-down mode. ## -property-value True if the receipt or slip printer station can print in a rotated upside-down mode; otherwise false. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities.Is180RotationSupported](receiptprintercapabilities_is180rotationsupported.md), [SlipPrinterCapabilities.Is180RotationSupported](slipprintercapabilities_is180rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.Is180RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.Is180RotationSupported + +## -description +Gets whether the receipt or slip printer station can print in a rotated upside-down mode. + +## -property-value +True if the receipt or slip printer station can print in a rotated upside-down mode; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities.Is180RotationSupported](receiptprintercapabilities_is180rotationsupported.md), [SlipPrinterCapabilities.Is180RotationSupported](slipprintercapabilities_is180rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbarcodesupported.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbarcodesupported.md index 0a82e3c882..abd110bc59 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbarcodesupported.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbarcodesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBarcodeSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBarcodeSupported ## -description Gets whether the receipt or slip printer station can print barcodes. ## -property-value True if the receipt or slip printer station can print barcodes; otherwise false. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities.IsBarcodeSupported](receiptprintercapabilities_isbarcodesupported.md), [SlipPrinterCapabilities.IsBarcodeSupported](slipprintercapabilities_isbarcodesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBarcodeSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBarcodeSupported + +## -description +Gets whether the receipt or slip printer station can print barcodes. + +## -property-value +True if the receipt or slip printer station can print barcodes; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities.IsBarcodeSupported](receiptprintercapabilities_isbarcodesupported.md), [SlipPrinterCapabilities.IsBarcodeSupported](slipprintercapabilities_isbarcodesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbitmapsupported.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbitmapsupported.md index 76bdd145d0..ec1bfd47d7 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbitmapsupported.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isbitmapsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBitmapSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBitmapSupported ## -description Gets whether the receipt or slip printer station can print bitmaps. ## -property-value True if the receipt or slip printer station can print bitmaps; otherwise false. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities.IsBitmapSupported](receiptprintercapabilities_isbitmapsupported.md), [SlipPrinterCapabilities.IsBitmapSupported](slipprintercapabilities_isbitmapsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBitmapSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsBitmapSupported + +## -description +Gets whether the receipt or slip printer station can print bitmaps. + +## -property-value +True if the receipt or slip printer station can print bitmaps; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities.IsBitmapSupported](receiptprintercapabilities_isbitmapsupported.md), [SlipPrinterCapabilities.IsBitmapSupported](slipprintercapabilities_isbitmapsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isleft90rotationsupported.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isleft90rotationsupported.md index c88a2c28f0..21d966a818 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isleft90rotationsupported.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isleft90rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsLeft90RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsLeft90RotationSupported ## -description Gets whether the receipt or slip printer station can print information rotated 90 degrees to the left. ## -property-value True if the receipt or slip printer station can print information rotated 90 degrees to the left; otherwise false. ## -remarks ## -examples ## -see-also [ReceiptPrintCapabilities.IsLeft90RotationSupported](receiptprintercapabilities_isleft90rotationsupported.md), [SlipPrintCapabilities.IsLeft90RotationSupported](slipprintercapabilities_isleft90rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsLeft90RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsLeft90RotationSupported + +## -description +Gets whether the receipt or slip printer station can print information rotated 90 degrees to the left. + +## -property-value +True if the receipt or slip printer station can print information rotated 90 degrees to the left; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrintCapabilities.IsLeft90RotationSupported](receiptprintercapabilities_isleft90rotationsupported.md), [SlipPrintCapabilities.IsLeft90RotationSupported](slipprintercapabilities_isleft90rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isprintareasupported.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isprintareasupported.md index f60aee4521..768cfca684 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isprintareasupported.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isprintareasupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsPrintAreaSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsPrintAreaSupported ## -description Gets whether the receipt or slip printer station supports setting a custom size for the area of the page on which the printer station should print. ## -property-value True if the receipt or slip printer station supports setting a custom size for the area of the page on which the printer station should print; otherwise false. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md), [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsPrintAreaSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsPrintAreaSupported + +## -description +Gets whether the receipt or slip printer station supports setting a custom size for the area of the page on which the printer station should print. + +## -property-value +True if the receipt or slip printer station supports setting a custom size for the area of the page on which the printer station should print; otherwise false. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md), [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isright90rotationsupported.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isright90rotationsupported.md index 7af562d848..a8bb06583d 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_isright90rotationsupported.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_isright90rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsRight90RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsRight90RotationSupported ## -description Gets whether the receipt or slip printer station can print information rotated 90 degrees to the right. ## -property-value True if the receipt or slip printer station can print information rotated 90 degrees to the right; otherwise false. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities.IsRight90RotationSupported](receiptprintercapabilities_isright90rotationsupported.md), [SlipPrinterCapabilities.IsRight90RotationSupported](slipprintercapabilities_isright90rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsRight90RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.IsRight90RotationSupported + +## -description +Gets whether the receipt or slip printer station can print information rotated 90 degrees to the right. + +## -property-value +True if the receipt or slip printer station can print information rotated 90 degrees to the right; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities.IsRight90RotationSupported](receiptprintercapabilities_isright90rotationsupported.md), [SlipPrinterCapabilities.IsRight90RotationSupported](slipprintercapabilities_isright90rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_ruledlinecapabilities.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_ruledlinecapabilities.md index c0583fe331..b8306ebdf5 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_ruledlinecapabilities.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_ruledlinecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.RuledLineCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.RuledLineCapabilities ## -description Gets information about the capabilities of the receipt or slip printer station to draw ruled lines. ## -property-value Information about the capabilities of the printer station to draw ruled lines. ## -remarks ## -examples ## -see-also [PosPrinterRuledLineCapabilities](posprinterruledlinecapabilities.md), [ReceiptPrinterCapabilities.RuledLineCapabilities](receiptprintercapabilities_ruledlinecapabilities.md), [SlipPrinterCapabilities.RuledLineCapabilities](slipprintercapabilities_ruledlinecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.RuledLineCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.RuledLineCapabilities + +## -description +Gets information about the capabilities of the receipt or slip printer station to draw ruled lines. + +## -property-value +Information about the capabilities of the printer station to draw ruled lines. + +## -remarks + +## -examples + +## -see-also +[PosPrinterRuledLineCapabilities](posprinterruledlinecapabilities.md), [ReceiptPrinterCapabilities.RuledLineCapabilities](receiptprintercapabilities_ruledlinecapabilities.md), [SlipPrinterCapabilities.RuledLineCapabilities](slipprintercapabilities_ruledlinecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbarcoderotations.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbarcoderotations.md index 21de6f8314..cdb77acf1f 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbarcoderotations.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbarcoderotations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBarcodeRotations --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBarcodeRotations ## -description Gets a list of the directions in which the receipt or slip printer station can rotate a barcode when printing. ## -property-value A list of the directions in which the receipt or slip printer station can rotate a barcode when printing. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities.SupportedBarcodeRotations](receiptprintercapabilities_supportedbarcoderotations.md), [SlipPrinterCapabilities.SupportedBarcodeRotations](slipprintercapabilities_supportedbarcoderotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBarcodeRotations +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBarcodeRotations + +## -description +Gets a list of the directions in which the receipt or slip printer station can rotate a barcode when printing. + +## -property-value +A list of the directions in which the receipt or slip printer station can rotate a barcode when printing. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities.SupportedBarcodeRotations](receiptprintercapabilities_supportedbarcoderotations.md), [SlipPrinterCapabilities.SupportedBarcodeRotations](slipprintercapabilities_supportedbarcoderotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbitmaprotations.md b/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbitmaprotations.md index 15f69bc1e1..76832e1c6a 100644 --- a/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbitmaprotations.md +++ b/windows.devices.pointofservice/icommonreceiptslipcapabilities_supportedbitmaprotations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBitmapRotations --api-type: winrt property ---- # Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBitmapRotations ## -description Gets a list of the directions in which the receipt or slip printer station can rotate a bitmap when printing. ## -property-value A list of the directions in which the receipt or slip printer station can rotate a bitmap when printing. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities.SupportedBitmapRotations](receiptprintercapabilities_supportedbitmaprotations.md), [SlipPrinterCapabilities.SupportedBitmapRotations](slipprintercapabilities_supportedbitmaprotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBitmapRotations +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ICommonReceiptSlipCapabilities.SupportedBitmapRotations + +## -description +Gets a list of the directions in which the receipt or slip printer station can rotate a bitmap when printing. + +## -property-value +A list of the directions in which the receipt or slip printer station can rotate a bitmap when printing. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities.SupportedBitmapRotations](receiptprintercapabilities_supportedbitmaprotations.md), [SlipPrinterCapabilities.SupportedBitmapRotations](slipprintercapabilities_supportedbitmaprotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/iposprinterjob_executeasync.md b/windows.devices.pointofservice/iposprinterjob_executeasync.md index 5092eda450..2d3a71ebba 100644 --- a/windows.devices.pointofservice/iposprinterjob_executeasync.md +++ b/windows.devices.pointofservice/iposprinterjob_executeasync.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.ExecuteAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.IPosPrinterJob.ExecuteAsync ## -description Runs the print job on the printer station asynchronously. ## -returns The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. ## -remarks ## -examples ## -see-also [JournalPrintJob.ExecuteAsync](journalprintjob_executeasync.md), [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md), [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.ExecuteAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IPosPrinterJob.ExecuteAsync + +## -description +Runs the print job on the printer station asynchronously. + +## -returns +The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. + +## -remarks + +## -examples + +## -see-also +[JournalPrintJob.ExecuteAsync](journalprintjob_executeasync.md), [ReceiptPrintJob.ExecuteAsync](receiptprintjob_executeasync.md), [SlipPrintJob.ExecuteAsync](slipprintjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/iposprinterjob_print.md b/windows.devices.pointofservice/iposprinterjob_print.md index 0cd6dad414..8f68642d48 100644 --- a/windows.devices.pointofservice/iposprinterjob_print.md +++ b/windows.devices.pointofservice/iposprinterjob_print.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.Print(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.IPosPrinterJob.Print ## -description Adds an instruction to the print job to print the specified text. ## -parameters ### -param data The text to print on the point-of-service printer. ## -remarks If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.Print(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IPosPrinterJob.Print + +## -description +Adds an instruction to the print job to print the specified text. + +## -parameters +### -param data +The text to print on the point-of-service printer. + +## -remarks +If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/iposprinterjob_printline_1360992803.md b/windows.devices.pointofservice/iposprinterjob_printline_1360992803.md index 3298dade51..3475b45b29 100644 --- a/windows.devices.pointofservice/iposprinterjob_printline_1360992803.md +++ b/windows.devices.pointofservice/iposprinterjob_printline_1360992803.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.PrintLine(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.IPosPrinterJob.PrintLine ## -description Adds an instruction to the print job to print the specified line of text. ## -parameters ### -param data The line of text to print. ## -remarks ## -examples ## -see-also [PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.PrintLine(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IPosPrinterJob.PrintLine + +## -description +Adds an instruction to the print job to print the specified line of text. + +## -parameters +### -param data +The line of text to print. + +## -remarks + +## -examples + +## -see-also +[PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/iposprinterjob_printline_144630531.md b/windows.devices.pointofservice/iposprinterjob_printline_144630531.md index 064101edc8..05be811108 100644 --- a/windows.devices.pointofservice/iposprinterjob_printline_144630531.md +++ b/windows.devices.pointofservice/iposprinterjob_printline_144630531.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.PrintLine --api-type: winrt method ---- # Windows.Devices.PointOfService.IPosPrinterJob.PrintLine ## -description Adds an instruction to the print job to print a newline character. ## -remarks ## -examples ## -see-also [PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IPosPrinterJob.PrintLine +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IPosPrinterJob.PrintLine + +## -description +Adds an instruction to the print job to print a newline character. + +## -remarks + +## -examples + +## -see-also +[PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_drawruledline.md b/windows.devices.pointofservice/ireceiptorslipjob_drawruledline.md index 98087a14e8..b52d7bde14 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_drawruledline.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_drawruledline.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.DrawRuledLine(System.String,Windows.Devices.PointOfService.PosPrinterLineDirection,System.UInt32,Windows.Devices.PointOfService.PosPrinterLineStyle,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.DrawRuledLine ## -description Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt or slip printer station. ## -parameters ### -param positionList The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. ### -param lineDirection The direction in which to print the ruled line. ### -param lineWidth The width of the ruled line that the printer station should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer station is used. ### -param lineStyle The appearance of the ruled line, such as whether it is solid or broken, or single or double. ### -param lineColor The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ICommonClaimedPosPrinterStation.ColorCartridge](claimedjournalprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable. ## -remarks ## -examples ## -see-also [ReceiptPrintJob.DrawRuledLine](receiptprintjob_drawruledline.md), [SlipPrintJob.DrawRuledLine](slipprintjob_drawruledline.md), [ICommonClaimedPosPrinterStation.ColorCartridge](claimedjournalprinter_colorcartridge.md), [PosPrinterLineDirection](posprinterlinedirection.md), [PosPrinterLineStyle](posprinterlinestyle.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.DrawRuledLine(System.String,Windows.Devices.PointOfService.PosPrinterLineDirection,System.UInt32,Windows.Devices.PointOfService.PosPrinterLineStyle,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.DrawRuledLine + +## -description +Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt or slip printer station. + +## -parameters +### -param positionList +The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. + +### -param lineDirection +The direction in which to print the ruled line. + +### -param lineWidth +The width of the ruled line that the printer station should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer station is used. + +### -param lineStyle +The appearance of the ruled line, such as whether it is solid or broken, or single or double. + +### -param lineColor +The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ICommonClaimedPosPrinterStation.ColorCartridge](claimedjournalprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrintJob.DrawRuledLine](receiptprintjob_drawruledline.md), [SlipPrintJob.DrawRuledLine](slipprintjob_drawruledline.md), [ICommonClaimedPosPrinterStation.ColorCartridge](claimedjournalprinter_colorcartridge.md), [PosPrinterLineDirection](posprinterlinedirection.md), [PosPrinterLineStyle](posprinterlinestyle.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printbarcode.md b/windows.devices.pointofservice/ireceiptorslipjob_printbarcode.md index a57ee6f29d..d1160938af 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printbarcode.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printbarcode.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcode(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcode ## -description Adds an instruction to the print job to print a barcode on the receipt or slip printer station with the specified data and symbology. ## -parameters ### -param data The data to represent as a barcode. ### -param symbology The symbology (encoding) of the barcode. ### -param height The height of the barcode, in pixels. ### -param width The width of the barcode, in pixels. ### -param textPosition The vertical position of the barcode text relative to the barcode. ### -param alignment The horizontal alignment of the barcode on the page. ## -remarks ## -examples ## -see-also [ReceiptPrintJob.PrintBarcode](receiptprintjob_printbarcode.md), [SlipPrintJob.PrintBarcode](slipprintjob_printbarcode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcode(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcode + +## -description +Adds an instruction to the print job to print a barcode on the receipt or slip printer station with the specified data and symbology. + +## -parameters +### -param data +The data to represent as a barcode. + +### -param symbology +The symbology (encoding) of the barcode. + +### -param height +The height of the barcode, in pixels. + +### -param width +The width of the barcode, in pixels. + +### -param textPosition +The vertical position of the barcode text relative to the barcode. + +### -param alignment +The horizontal alignment of the barcode on the page. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrintJob.PrintBarcode](receiptprintjob_printbarcode.md), [SlipPrintJob.PrintBarcode](slipprintjob_printbarcode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printbarcodecustomalign.md b/windows.devices.pointofservice/ireceiptorslipjob_printbarcodecustomalign.md index 9c5d24e6d9..853ecf8fcf 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printbarcodecustomalign.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printbarcodecustomalign.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcodeCustomAlign(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcodeCustomAlign ## -description Adds an instruction to the print job to print a barcode on a receipt or slip printer station with the specified data, symbology, and custom alignment. ## -parameters ### -param data The data to represent as a barcode. ### -param symbology The symbology (encoding) of the barcode. ### -param height The height of the barcode, in pixels. ### -param width The width of the barcode, in pixels. ### -param textPosition The vertical position of the barcode text relative to the barcode. ### -param alignmentDistance The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [ReceiptPrintJob.PrintBarcodeCustomAlign](receiptprintjob_printbarcodecustomalign.md), [SlipPrintJob.PrintBarcodeCustomAlign](slipprintjob_printbarcodecustomalign.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcodeCustomAlign(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBarcodeCustomAlign + +## -description +Adds an instruction to the print job to print a barcode on a receipt or slip printer station with the specified data, symbology, and custom alignment. + +## -parameters +### -param data +The data to represent as a barcode. + +### -param symbology +The symbology (encoding) of the barcode. + +### -param height +The height of the barcode, in pixels. + +### -param width +The width of the barcode, in pixels. + +### -param textPosition +The vertical position of the barcode text relative to the barcode. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrintJob.PrintBarcodeCustomAlign](receiptprintjob_printbarcodecustomalign.md), [SlipPrintJob.PrintBarcodeCustomAlign](slipprintjob_printbarcodecustomalign.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1103111072.md b/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1103111072.md index daa627e81e..1f81d67dbc 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1103111072.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1103111072.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt or slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.PrintBitmap(BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_printbitmap_1311643772.md), [Receipt.PrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [SlipPrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt or slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.PrintBitmap(BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_printbitmap_1311643772.md), [Receipt.PrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [SlipPrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1311643772.md b/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1311643772.md index 3786070e7b..2e7fbafcf7 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1311643772.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printbitmap_1311643772.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt or slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_printbitmap_1103111072.md), [ReceiptPrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [SlipPrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt or slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_printbitmap_1103111072.md), [ReceiptPrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [SlipPrintJob.PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_386594225.md b/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_386594225.md index 706b2f93d2..873f15472a 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_386594225.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_386594225.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap ## -description Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt or slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_printcustomalignedbitmap_417648213.md), [ReceiptPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [SlipPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt or slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_printcustomalignedbitmap_417648213.md), [ReceiptPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [SlipPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_417648213.md b/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_417648213.md index 25da3b0a86..8ae11aee4b 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_417648213.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printcustomalignedbitmap_417648213.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt or slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32)](ireceiptorslipjob_printcustomalignedbitmap_386594225.md), [ReceiptPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [SlipPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintCustomAlignedBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt or slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32)](ireceiptorslipjob_printcustomalignedbitmap_386594225.md), [ReceiptPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [SlipPrintJob.PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_printsavedbitmap.md b/windows.devices.pointofservice/ireceiptorslipjob_printsavedbitmap.md index c88e7a1622..d6f93b153f 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_printsavedbitmap.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_printsavedbitmap.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintSavedBitmap(System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintSavedBitmap ## -description Adds an instruction to the print job to print a bitmap on the receipt or slip printer station by using the information that you saved about the bitmap and how to print it when you called the [SetBitmap](ireceiptorslipjob_setbitmap.md) or [SetCustomAlignedBitmap](ireceiptorslipjob_setcustomalignedbitmap.md) method. ## -parameters ### -param bitmapNumber The number that you assigned to the bitmap that you want to print when you called [SetBitmap](ireceiptorslipjob_setbitmap.md) or [SetCustomAlignedBitmap](ireceiptorslipjob_setcustomalignedbitmap.md). ## -remarks The bitmap rotation setting that you specify by calling [IReceiptOrSlipJob.SetPrintRotation](ireceiptorslipjob_setprintrotation.md) may not apply to bitmaps that you saved to the printer. ## -examples ## -see-also [SetBitmap](ireceiptorslipjob_setbitmap.md), [SetCustomAlignedBitmap](ireceiptorslipjob_setcustomalignedbitmap.md), [IReceiptOrSlipJob.SetPrintRotation](ireceiptorslipjob_setprintrotation.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintSavedBitmap(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.PrintSavedBitmap + +## -description +Adds an instruction to the print job to print a bitmap on the receipt or slip printer station by using the information that you saved about the bitmap and how to print it when you called the [SetBitmap](ireceiptorslipjob_setbitmap.md) or [SetCustomAlignedBitmap](ireceiptorslipjob_setcustomalignedbitmap.md) method. + +## -parameters +### -param bitmapNumber +The number that you assigned to the bitmap that you want to print when you called [SetBitmap](ireceiptorslipjob_setbitmap.md) or [SetCustomAlignedBitmap](ireceiptorslipjob_setcustomalignedbitmap.md). + +## -remarks +The bitmap rotation setting that you specify by calling [IReceiptOrSlipJob.SetPrintRotation](ireceiptorslipjob_setprintrotation.md) may not apply to bitmaps that you saved to the printer. + +## -examples + +## -see-also +[SetBitmap](ireceiptorslipjob_setbitmap.md), [SetCustomAlignedBitmap](ireceiptorslipjob_setcustomalignedbitmap.md), [IReceiptOrSlipJob.SetPrintRotation](ireceiptorslipjob_setprintrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setbarcoderotation.md b/windows.devices.pointofservice/ireceiptorslipjob_setbarcoderotation.md index fe370e0bc7..e1f0c72448 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setbarcoderotation.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setbarcoderotation.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBarcodeRotation(Windows.Devices.PointOfService.PosPrinterRotation) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBarcodeRotation ## -description Sets the rotation of the barcode on the page for the receipt or slip printer station. ## -parameters ### -param value The rotation of the barcode on the page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBarcodeRotation(Windows.Devices.PointOfService.PosPrinterRotation) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBarcodeRotation + +## -description +Sets the rotation of the barcode on the page for the receipt or slip printer station. + +## -parameters +### -param value +The rotation of the barcode on the page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_489195165.md b/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_489195165.md index 5731e0a948..1903bf7657 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_489195165.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_489195165.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap ## -description Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ## -remarks If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap + +## -description +Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +## -remarks +If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_49606997.md b/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_49606997.md index d2f065db91..e09ed0d915 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_49606997.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setbitmap_49606997.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap ## -description Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_setbitmap_489195165.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetBitmap + +## -description +Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks +If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_setbitmap_489195165.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1134515791.md b/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1134515791.md index ea897198cb..8481d04936 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1134515791.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1134515791.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap ## -description Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1547903367.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap + +## -description +Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1547903367.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1547903367.md b/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1547903367.md index 27330b3d33..4e585cd5d2 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1547903367.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setcustomalignedbitmap_1547903367.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap ## -description Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1134515791.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetCustomAlignedBitmap + +## -description +Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](ireceiptorslipjob_setcustomalignedbitmap_1134515791.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](ireceiptorslipjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](ireceiptorslipjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setprintarea.md b/windows.devices.pointofservice/ireceiptorslipjob_setprintarea.md index 889098e180..d7be936675 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setprintarea.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setprintarea.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintArea(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintArea ## -description Sets the area of the page on which the receipt or slip printer station can print the job. ## -parameters ### -param value The area of the page on which the receipt or slip printer station can print the job. ## -remarks When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called [IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md). ## -examples ## -see-also [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md), [ICommonReceiptSlipCapabilities.IsPrintAreaSupported](icommonreceiptslipcapabilities_isprintareasupported.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintArea(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintArea + +## -description +Sets the area of the page on which the receipt or slip printer station can print the job. + +## -parameters +### -param value +The area of the page on which the receipt or slip printer station can print the job. + +## -remarks +When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called [IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md). + +## -examples + +## -see-also +[ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md), [ICommonReceiptSlipCapabilities.IsPrintAreaSupported](icommonreceiptslipcapabilities_isprintareasupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/ireceiptorslipjob_setprintrotation.md b/windows.devices.pointofservice/ireceiptorslipjob_setprintrotation.md index cb4cbb3f3b..cdb2c4fa54 100644 --- a/windows.devices.pointofservice/ireceiptorslipjob_setprintrotation.md +++ b/windows.devices.pointofservice/ireceiptorslipjob_setprintrotation.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintRotation(Windows.Devices.PointOfService.PosPrinterRotation,System.Boolean) --api-type: winrt method ---- # Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintRotation ## -description Sets the rotation of the text or image on the page for the receipt or slip printer station. ## -parameters ### -param value The rotation of the text or image on the page. ### -param includeBitmaps Whether bitmaps should be rotated as well. This setting takes effect only for subsequent calls to [PrintBitmap](ireceiptorslipjob_printbitmap.md), and may not apply to saved bitmaps that you print using [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md). ## -remarks This rotation setting persists beyond the current print job. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintRotation(Windows.Devices.PointOfService.PosPrinterRotation,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.IReceiptOrSlipJob.SetPrintRotation + +## -description +Sets the rotation of the text or image on the page for the receipt or slip printer station. + +## -parameters +### -param value +The rotation of the text or image on the page. + +### -param includeBitmaps +Whether bitmaps should be rotated as well. This setting takes effect only for subsequent calls to [PrintBitmap](ireceiptorslipjob_printbitmap.md), and may not apply to saved bitmaps that you print using [PrintSavedBitmap](ireceiptorslipjob_printsavedbitmap.md). + +## -remarks +This rotation setting persists beyond the current print job. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/journalprintercapabilities.md b/windows.devices.pointofservice/journalprintercapabilities.md index da319cbadd..9a8769c9c8 100644 --- a/windows.devices.pointofservice/journalprintercapabilities.md +++ b/windows.devices.pointofservice/journalprintercapabilities.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.JournalPrinterCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities ## -description Represents the capabilities of journal station of a point-of-service printer. ## -remarks To get the capabilities of the journal station of a point-of-service printer, use [PosPrinterCapabilities.Journal](posprintercapabilities_journal.md). ## -examples ## -see-also [ICommonPosPrintStationCapabilities](icommonposprintstationcapabilities.md), [PosPrinterCapabilities.Journal](posprintercapabilities_journal.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.JournalPrinterCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities + +## -description +Represents the capabilities of journal station of a point-of-service printer. + +## -remarks +To get the capabilities of the journal station of a point-of-service printer, use [PosPrinterCapabilities.Journal](posprintercapabilities_journal.md). + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities](icommonposprintstationcapabilities.md), [PosPrinterCapabilities.Journal](posprintercapabilities_journal.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_cartridgesensors.md b/windows.devices.pointofservice/journalprintercapabilities_cartridgesensors.md index 0d72020f9e..a93c856518 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_cartridgesensors.md +++ b/windows.devices.pointofservice/journalprintercapabilities_cartridgesensors.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.CartridgeSensors --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.CartridgeSensors ## -description Gets information about the sensors that the journal printer station has available to report the status of the printer cartridge. ## -property-value A combination of enumeration values that indicate the set of sensors that can provide state information for the journal printer ink cartridges. ## -remarks ## -examples ## -see-also [PosPrinterCartridgeSensors](posprintercartridgesensors.md), [ICommonPosPrintStationCapabilities.CartridgeSensors](icommonposprintstationcapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.CartridgeSensors +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.CartridgeSensors + +## -description +Gets information about the sensors that the journal printer station has available to report the status of the printer cartridge. + +## -property-value +A combination of enumeration values that indicate the set of sensors that can provide state information for the journal printer ink cartridges. + +## -remarks + +## -examples + +## -see-also +[PosPrinterCartridgeSensors](posprintercartridgesensors.md), [ICommonPosPrintStationCapabilities.CartridgeSensors](icommonposprintstationcapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_colorcartridgecapabilities.md b/windows.devices.pointofservice/journalprintercapabilities_colorcartridgecapabilities.md index b52d00779b..0de4e61c52 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_colorcartridgecapabilities.md +++ b/windows.devices.pointofservice/journalprintercapabilities_colorcartridgecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.ColorCartridgeCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.ColorCartridgeCapabilities ## -description Gets the color cartridges that the journal printer station can use to print in color. ## -property-value A combination of enumeration values that indicates which color cartridges the journal printer station can use to print in color. ## -remarks ## -examples ## -see-also [PosPrinterColorCapabilities](posprintercolorcapabilities.md), [ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities](icommonposprintstationcapabilities_colorcartridgecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.ColorCartridgeCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.ColorCartridgeCapabilities + +## -description +Gets the color cartridges that the journal printer station can use to print in color. + +## -property-value +A combination of enumeration values that indicates which color cartridges the journal printer station can use to print in color. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCapabilities](posprintercolorcapabilities.md), [ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities](icommonposprintstationcapabilities_colorcartridgecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isboldsupported.md b/windows.devices.pointofservice/journalprintercapabilities_isboldsupported.md index 892208d5e3..73f30ce37f 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isboldsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isboldsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsBoldSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsBoldSupported ## -description Gets whether the journal printer station can print bold characters. ## -property-value True if the journal printer station can print bold characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsBoldSupported](icommonposprintstationcapabilities_isboldsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsBoldSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsBoldSupported + +## -description +Gets whether the journal printer station can print bold characters. + +## -property-value +True if the journal printer station can print bold characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsBoldSupported](icommonposprintstationcapabilities_isboldsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isdoublehighdoublewideprintsupported.md b/windows.devices.pointofservice/journalprintercapabilities_isdoublehighdoublewideprintsupported.md index c76b80d225..3109b49627 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isdoublehighdoublewideprintsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isdoublehighdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported ## -description Gets whether the journal printer station can print characters that are both double-high and double-wide. ## -property-value True if the journal printer station can print characters that are both double-high and double-wide; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported + +## -description +Gets whether the journal printer station can print characters that are both double-high and double-wide. + +## -property-value +True if the journal printer station can print characters that are both double-high and double-wide; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isdoublehighprintsupported.md b/windows.devices.pointofservice/journalprintercapabilities_isdoublehighprintsupported.md index 2bd1e4d360..bc2ed3ae05 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isdoublehighprintsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isdoublehighprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighPrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighPrintSupported ## -description Gets whether the journal printer station can print double-high characters. ## -property-value True if the journal printer station can print double-high characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported](icommonposprintstationcapabilities_isdoublehighprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighPrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleHighPrintSupported + +## -description +Gets whether the journal printer station can print double-high characters. + +## -property-value +True if the journal printer station can print double-high characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported](icommonposprintstationcapabilities_isdoublehighprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isdoublewideprintsupported.md b/windows.devices.pointofservice/journalprintercapabilities_isdoublewideprintsupported.md index 353ef054c7..f66978c610 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isdoublewideprintsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleWidePrintSupported ## -description Gets whether the journal printer station can print double-wide characters. ## -property-value True if the journal printer station can print double-wide characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDoubleWidePrintSupported + +## -description +Gets whether the journal printer station can print double-wide characters. + +## -property-value +True if the journal printer station can print double-wide characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isdualcolorsupported.md b/windows.devices.pointofservice/journalprintercapabilities_isdualcolorsupported.md index 09a984fba5..be2a5f2d0c 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isdualcolorsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isdualcolorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDualColorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDualColorSupported ## -description Gets whether the journal printer station can print a dark color plus an alternate color. ## -property-value True if the journal printer station can print a dark color plus an alternate color; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDualColorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsDualColorSupported + +## -description +Gets whether the journal printer station can print a dark color plus an alternate color. + +## -property-value +True if the journal printer station can print a dark color plus an alternate color; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isitalicsupported.md b/windows.devices.pointofservice/journalprintercapabilities_isitalicsupported.md index 8e15d95c0b..7c88d9c294 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isitalicsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isitalicsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsItalicSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsItalicSupported ## -description Gets whether the journal printer station can print italic characters. ## -property-value True if the journal printer station can print italic characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsItalicSupported](icommonposprintstationcapabilities_isitalicsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsItalicSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsItalicSupported + +## -description +Gets whether the journal printer station can print italic characters. + +## -property-value +True if the journal printer station can print italic characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsItalicSupported](icommonposprintstationcapabilities_isitalicsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_ispaperemptysensorsupported.md b/windows.devices.pointofservice/journalprintercapabilities_ispaperemptysensorsupported.md index 455005e765..79de47babe 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_ispaperemptysensorsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_ispaperemptysensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperEmptySensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperEmptySensorSupported ## -description Gets whether the journal printer station has an out-of-paper sensor. ## -property-value True if the journal printer station has an out-of-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported](icommonposprintstationcapabilities_ispaperemptysensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperEmptySensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperEmptySensorSupported + +## -description +Gets whether the journal printer station has an out-of-paper sensor. + +## -property-value +True if the journal printer station has an out-of-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported](icommonposprintstationcapabilities_ispaperemptysensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_ispapernearendsensorsupported.md b/windows.devices.pointofservice/journalprintercapabilities_ispapernearendsensorsupported.md index dc42cef275..5673822034 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_ispapernearendsensorsupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_ispapernearendsensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperNearEndSensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperNearEndSensorSupported ## -description Gets whether the journal printer station has a low-paper sensor. ## -property-value True if the journal printer station has a low-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported](icommonposprintstationcapabilities_ispapernearendsensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperNearEndSensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPaperNearEndSensorSupported + +## -description +Gets whether the journal printer station has a low-paper sensor. + +## -property-value +True if the journal printer station has a low-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported](icommonposprintstationcapabilities_ispapernearendsensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isprinterpresent.md b/windows.devices.pointofservice/journalprintercapabilities_isprinterpresent.md index 30b4034e00..f58e578a6c 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isprinterpresent.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isprinterpresent.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPrinterPresent --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPrinterPresent ## -description Gets whether a point-of-service printer with a station that functions as a journal printer station is present. ## -property-value True if a point-of-service printer with a station that functions as a journal printer station is present; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPrinterPresent](icommonposprintstationcapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPrinterPresent +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsPrinterPresent + +## -description +Gets whether a point-of-service printer with a station that functions as a journal printer station is present. + +## -property-value +True if a point-of-service printer with a station that functions as a journal printer station is present; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPrinterPresent](icommonposprintstationcapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_isunderlinesupported.md b/windows.devices.pointofservice/journalprintercapabilities_isunderlinesupported.md index 6705527d39..47bdf04f5e 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_isunderlinesupported.md +++ b/windows.devices.pointofservice/journalprintercapabilities_isunderlinesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsUnderlineSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.IsUnderlineSupported ## -description Gets whether the journal printer station can underline characters. ## -property-value True if the journal printer station can underline characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsUnderlineSupported](icommonposprintstationcapabilities_isunderlinesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.IsUnderlineSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.IsUnderlineSupported + +## -description +Gets whether the journal printer station can underline characters. + +## -property-value +True if the journal printer station can underline characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsUnderlineSupported](icommonposprintstationcapabilities_isunderlinesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintercapabilities_supportedcharactersperline.md b/windows.devices.pointofservice/journalprintercapabilities_supportedcharactersperline.md index fa6083c921..bc7d76eb4e 100644 --- a/windows.devices.pointofservice/journalprintercapabilities_supportedcharactersperline.md +++ b/windows.devices.pointofservice/journalprintercapabilities_supportedcharactersperline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.SupportedCharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.JournalPrinterCapabilities.SupportedCharactersPerLine ## -description Gets a collection of the line widths in characters per line that the journal printer station supports. ## -property-value A collection of the line widths in characters per line that the journal printer station supports. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.SupportedCharactersPerLine](icommonposprintstationcapabilities_supportedcharactersperline.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.JournalPrinterCapabilities.SupportedCharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.JournalPrinterCapabilities.SupportedCharactersPerLine + +## -description +Gets a collection of the line widths in characters per line that the journal printer station supports. + +## -property-value +A collection of the line widths in characters per line that the journal printer station supports. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.SupportedCharactersPerLine](icommonposprintstationcapabilities_supportedcharactersperline.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintjob.md b/windows.devices.pointofservice/journalprintjob.md index dc0bce1171..b628f38483 100644 --- a/windows.devices.pointofservice/journalprintjob.md +++ b/windows.devices.pointofservice/journalprintjob.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.JournalPrintJob --api-type: winrt class ---- # Windows.Devices.PointOfService.JournalPrintJob ## -description Represents a set of printing instructions that you want to run on the journal printer station. ## -remarks To create a new print job for the journal printer, call [ClaimedJournalPrinter.CreateJob](claimedjournalprinter_createjob.md). ## -examples ## -see-also [IPosPrinterJob](iposprinterjob.md), [ClaimedJournalPrinter.CreateJob](claimedjournalprinter_createjob.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.JournalPrintJob +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.JournalPrintJob + +## -description +Represents a set of printing instructions that you want to run on the journal printer station. + +## -remarks +To create a new print job for the journal printer, call [ClaimedJournalPrinter.CreateJob](claimedjournalprinter_createjob.md). + +## -examples + +## -see-also +[IPosPrinterJob](iposprinterjob.md), [ClaimedJournalPrinter.CreateJob](claimedjournalprinter_createjob.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintjob_executeasync_2108924004.md b/windows.devices.pointofservice/journalprintjob_executeasync_2108924004.md index 83cdc8a7ea..872f29d58b 100644 --- a/windows.devices.pointofservice/journalprintjob_executeasync_2108924004.md +++ b/windows.devices.pointofservice/journalprintjob_executeasync_2108924004.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.JournalPrintJob.ExecuteAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.JournalPrintJob.ExecuteAsync ## -description Runs the print job on the journal printer station asynchronously. ## -returns The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. ## -remarks ## -examples ## -see-also [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.JournalPrintJob.ExecuteAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.JournalPrintJob.ExecuteAsync + +## -description +Runs the print job on the journal printer station asynchronously. + +## -returns +The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. + +## -remarks + +## -examples + +## -see-also +[IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintjob_print_1512698335.md b/windows.devices.pointofservice/journalprintjob_print_1512698335.md index 4c30af92fc..cbc9f10740 100644 --- a/windows.devices.pointofservice/journalprintjob_print_1512698335.md +++ b/windows.devices.pointofservice/journalprintjob_print_1512698335.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.JournalPrintJob.Print(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.JournalPrintJob.Print ## -description Adds an instruction to the print job to print the specified text on the journal printer station. ## -parameters ### -param data The text to print on the journal printer. ## -remarks If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. ## -examples ## -see-also [IPosPrinterJob.Print](iposprinterjob_print.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.JournalPrintJob.Print(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.JournalPrintJob.Print + +## -description +Adds an instruction to the print job to print the specified text on the journal printer station. + +## -parameters +### -param data +The text to print on the journal printer. + +## -remarks +If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. + +## -examples + +## -see-also +[IPosPrinterJob.Print](iposprinterjob_print.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintjob_printline_1360992803.md b/windows.devices.pointofservice/journalprintjob_printline_1360992803.md index 22f20cbbd6..d56d9817c5 100644 --- a/windows.devices.pointofservice/journalprintjob_printline_1360992803.md +++ b/windows.devices.pointofservice/journalprintjob_printline_1360992803.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.JournalPrintJob.PrintLine(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.JournalPrintJob.PrintLine ## -description Adds an instruction to the print job to print the specified line of text on the journal printer station. ## -parameters ### -param data The line of text to print. ## -remarks ## -examples ## -see-also [PrintLine](journalprintjob_printline_144630531.md), [IPosPrinterJob.PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.JournalPrintJob.PrintLine(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.JournalPrintJob.PrintLine + +## -description +Adds an instruction to the print job to print the specified line of text on the journal printer station. + +## -parameters +### -param data +The line of text to print. + +## -remarks + +## -examples + +## -see-also +[PrintLine](journalprintjob_printline_144630531.md), [IPosPrinterJob.PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/journalprintjob_printline_144630531.md b/windows.devices.pointofservice/journalprintjob_printline_144630531.md index c62bd3a06f..e1cc57fb26 100644 --- a/windows.devices.pointofservice/journalprintjob_printline_144630531.md +++ b/windows.devices.pointofservice/journalprintjob_printline_144630531.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.JournalPrintJob.PrintLine --api-type: winrt method ---- # Windows.Devices.PointOfService.JournalPrintJob.PrintLine ## -description Adds an instruction to the print job to print a newline character on the journal printer station. ## -remarks ## -examples ## -see-also [PrintLine(String)](journalprintjob_printline_1360992803.md), [IPosPrinterJob.PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.JournalPrintJob.PrintLine +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.JournalPrintJob.PrintLine + +## -description +Adds an instruction to the print job to print a newline character on the journal printer station. + +## -remarks + +## -examples + +## -see-also +[PrintLine(String)](journalprintjob_printline_1360992803.md), [IPosPrinterJob.PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/magneticstripereader.md b/windows.devices.pointofservice/magneticstripereader.md index 2e714531e4..1229eb349a 100644 --- a/windows.devices.pointofservice/magneticstripereader.md +++ b/windows.devices.pointofservice/magneticstripereader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReader --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReader ## -description Represents the magnetic stripe reader device. ## -remarks This object is created when [GetDefaultAsync](magneticstripereader_getdefaultasync.md) or [FromIdAsync](magneticstripereader_fromidasync.md) method completes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReader +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader + +## -description +Represents the magnetic stripe reader device. + +## -remarks +This object is created when [GetDefaultAsync](magneticstripereader_getdefaultasync.md) or [FromIdAsync](magneticstripereader_fromidasync.md) method completes. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_capabilities.md b/windows.devices.pointofservice/magneticstripereader_capabilities.md index 7f7b31cf6a..033d19ccbf 100644 --- a/windows.devices.pointofservice/magneticstripereader_capabilities.md +++ b/windows.devices.pointofservice/magneticstripereader_capabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.Capabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReader.Capabilities ## -description Gets the capabilities of the magnetic stripe reader. ## -property-value The capabilities of the magnetic stripe reader. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.Capabilities + +## -description +Gets the capabilities of the magnetic stripe reader. + +## -property-value +The capabilities of the magnetic stripe reader. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_checkhealthasync_1543183748.md b/windows.devices.pointofservice/magneticstripereader_checkhealthasync_1543183748.md index 730ab88315..345b8fdd4f 100644 --- a/windows.devices.pointofservice/magneticstripereader_checkhealthasync_1543183748.md +++ b/windows.devices.pointofservice/magneticstripereader_checkhealthasync_1543183748.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) --api-type: winrt method ---- # Windows.Devices.PointOfService.MagneticStripeReader.CheckHealthAsync ## -description Tests the health of the magnetic stripe reader. ## -parameters ### -param level The specific health check level. ## -returns A text description of the text result. Returns an error if the specified check level is not supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.CheckHealthAsync + +## -description +Tests the health of the magnetic stripe reader. + +## -parameters +### -param level +The specific health check level. + +## -returns +A text description of the text result. Returns an error if the specified check level is not supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md b/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md index dd5fff33df..2fc1218565 100644 --- a/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md +++ b/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync - -## -description -Attempts to get an exclusive access to the magnetic stripe reader. - -## -returns -When the method completes, it returns a [ClaimedMagneticStripeReader](claimedmagneticstripereader.md) or it returns null if the operation fails to claim a magnetic stripe reader. - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cpp[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetClaimMagStripeReader)][!code-cs[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetClaimMagStripeReader)] - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync + +## -description +Attempts to get an exclusive access to the magnetic stripe reader. + +## -returns +When the method completes, it returns a [ClaimedMagneticStripeReader](claimedmagneticstripereader.md) or it returns null if the operation fails to claim a magnetic stripe reader. + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cpp[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetClaimMagStripeReader)][!code-cs[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetClaimMagStripeReader)] + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/magneticstripereader_deviceauthenticationprotocol.md b/windows.devices.pointofservice/magneticstripereader_deviceauthenticationprotocol.md index e6f071f1d7..a4e8017460 100644 --- a/windows.devices.pointofservice/magneticstripereader_deviceauthenticationprotocol.md +++ b/windows.devices.pointofservice/magneticstripereader_deviceauthenticationprotocol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.DeviceAuthenticationProtocol --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReader.DeviceAuthenticationProtocol ## -description Device authentication protocol supported by the magnetic stripe reader. ## -property-value The supported authentication protocol. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.DeviceAuthenticationProtocol +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.DeviceAuthenticationProtocol + +## -description +Device authentication protocol supported by the magnetic stripe reader. + +## -property-value +The supported authentication protocol. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_deviceid.md b/windows.devices.pointofservice/magneticstripereader_deviceid.md index 5070c9f5df..f6cdafc3cf 100644 --- a/windows.devices.pointofservice/magneticstripereader_deviceid.md +++ b/windows.devices.pointofservice/magneticstripereader_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReader.DeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the magnetic stripe reader. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the magnetic stripe reader. ## -remarks ## -examples ## -see-also [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.DeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the magnetic stripe reader. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the magnetic stripe reader. + +## -remarks + +## -examples + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/magneticstripereader_fromidasync_1322863552.md b/windows.devices.pointofservice/magneticstripereader_fromidasync_1322863552.md index 47ed4a111f..525223e6bc 100644 --- a/windows.devices.pointofservice/magneticstripereader_fromidasync_1322863552.md +++ b/windows.devices.pointofservice/magneticstripereader_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.MagneticStripeReader.FromIdAsync ## -description Creates a [MagneticStripeReader](magneticstripereader.md) object from [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). ## -parameters ### -param deviceId The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific magnetic stripe reader, which can be retrieved from the [DeviceId](magneticstripereader_deviceid.md) property. ## -returns The magnetic stripe reader specified by the unique device identifier. Returns a null object in the following cases: + The specific device is not found. + Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. ## -remarks ## -examples ## -see-also [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.FromIdAsync + +## -description +Creates a [MagneticStripeReader](magneticstripereader.md) object from [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific magnetic stripe reader, which can be retrieved from the [DeviceId](magneticstripereader_deviceid.md) property. + +## -returns +The magnetic stripe reader specified by the unique device identifier. Returns a null object in the following cases: ++ The specific device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + + +## -remarks + +## -examples + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/magneticstripereader_getdefaultasync_1549573963.md b/windows.devices.pointofservice/magneticstripereader_getdefaultasync_1549573963.md index 2d7abbc096..85b80cb654 100644 --- a/windows.devices.pointofservice/magneticstripereader_getdefaultasync_1549573963.md +++ b/windows.devices.pointofservice/magneticstripereader_getdefaultasync_1549573963.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetDefaultAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.MagneticStripeReader.GetDefaultAsync - -## -description -Returns the first magnetic stripe reader found. - -## -returns -The first magnetic stripe reader found. Returns a null object in the following cases: -+ A device is not found. -+ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. - - -## -remarks - -## -examples - - -> [!div class="tabbedCodeSnippets"][!code-cpp[CreateMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetCreateMagStripeReader)][!code-cs[CreateMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetCreateMagStripeReader)][!code-js[CreateMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReader)] - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.GetDefaultAsync + +## -description +Returns the first magnetic stripe reader found. + +## -returns +The first magnetic stripe reader found. Returns a null object in the following cases: ++ A device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + + +## -remarks + +## -examples + + +> [!div class="tabbedCodeSnippets"][!code-cpp[CreateMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetCreateMagStripeReader)][!code-cs[CreateMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetCreateMagStripeReader)][!code-js[CreateMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReader)] + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/magneticstripereader_getdeviceselector_838466080.md b/windows.devices.pointofservice/magneticstripereader_getdeviceselector_838466080.md index c2e6bb9863..17a2419b3a 100644 --- a/windows.devices.pointofservice/magneticstripereader_getdeviceselector_838466080.md +++ b/windows.devices.pointofservice/magneticstripereader_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.PointOfService.MagneticStripeReader.GetDeviceSelector ## -description Returns an Advanced Query Syntax (AQS) string that is used to enumerate available magnetic stripe readers. ## -returns An Advanced Query Syntax (AQS) string that is used to enumerate available magnetic stripe readers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.GetDeviceSelector + +## -description +Returns an Advanced Query Syntax (AQS) string that is used to enumerate available magnetic stripe readers. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate available magnetic stripe readers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_geterrorreportingtype_23320717.md b/windows.devices.pointofservice/magneticstripereader_geterrorreportingtype_23320717.md index 31dcec7ddf..106141ef62 100644 --- a/windows.devices.pointofservice/magneticstripereader_geterrorreportingtype_23320717.md +++ b/windows.devices.pointofservice/magneticstripereader_geterrorreportingtype_23320717.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetErrorReportingType --api-type: winrt method ---- # Windows.Devices.PointOfService.MagneticStripeReader.GetErrorReportingType ## -description Gets the error reporting type the application wants to receive. ## -returns The error reporting type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetErrorReportingType +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.GetErrorReportingType + +## -description +Gets the error reporting type the application wants to receive. + +## -returns +The error reporting type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_retrievestatisticsasync_735443283.md b/windows.devices.pointofservice/magneticstripereader_retrievestatisticsasync_735443283.md index ecaf4fe5f3..a5a3a20319 100644 --- a/windows.devices.pointofservice/magneticstripereader_retrievestatisticsasync_735443283.md +++ b/windows.devices.pointofservice/magneticstripereader_retrievestatisticsasync_735443283.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.RetrieveStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.MagneticStripeReader.RetrieveStatisticsAsync ## -description Retrieves the requested statistics from the magnetic stripe reader. ## -parameters ### -param statisticsCategories The list of statistics to retrieve. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and groups names ("name3", "U_", "M_"). ## -returns IBuffer representing the requested statistics. ## -remarks The result does not contain any duplicate statistics even if the input contains duplicates. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.RetrieveStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.RetrieveStatisticsAsync + +## -description +Retrieves the requested statistics from the magnetic stripe reader. + +## -parameters +### -param statisticsCategories +The list of statistics to retrieve. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and groups names ("name3", "U_", "M_"). + + +## -returns +IBuffer representing the requested statistics. + +## -remarks +The result does not contain any duplicate statistics even if the input contains duplicates. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_statusupdated.md b/windows.devices.pointofservice/magneticstripereader_statusupdated.md index d3f14f25ed..6073f25453 100644 --- a/windows.devices.pointofservice/magneticstripereader_statusupdated.md +++ b/windows.devices.pointofservice/magneticstripereader_statusupdated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.PointOfService.MagneticStripeReader.StatusUpdated --api-type: winrt event ---- # Windows.Devices.PointOfService.MagneticStripeReader.StatusUpdated ## -description Occurs when the device detects an operation status change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.MagneticStripeReader.StatusUpdated +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.StatusUpdated + +## -description +Occurs when the device detects an operation status change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereader_supportedcardtypes.md b/windows.devices.pointofservice/magneticstripereader_supportedcardtypes.md index 823f457721..434ac16398 100644 --- a/windows.devices.pointofservice/magneticstripereader_supportedcardtypes.md +++ b/windows.devices.pointofservice/magneticstripereader_supportedcardtypes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.SupportedCardTypes --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReader.SupportedCardTypes ## -description Gets the card types supported by the magnetic stripe reader. ## -property-value The card type identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReader.SupportedCardTypes +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.SupportedCardTypes + +## -description +Gets the card types supported by the magnetic stripe reader. + +## -property-value +The card type identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs.md index 9e32abf16d..c4adb9e96b 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs ## -description Provides the American Association of Motor Vehicle Administrators (AAMVA) card data from the [AamvaCardDataReceived](claimedmagneticstripereader_aamvacarddatareceived.md) event. ## -remarks This object is created by the [AamvaCardDataReceived](claimedmagneticstripereader_aamvacarddatareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs + +## -description +Provides the American Association of Motor Vehicle Administrators (AAMVA) card data from the [AamvaCardDataReceived](claimedmagneticstripereader_aamvacarddatareceived.md) event. + +## -remarks +This object is created by the [AamvaCardDataReceived](claimedmagneticstripereader_aamvacarddatareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_address.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_address.md index b8f3fd134a..203d67f266 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_address.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_address.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Address --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Address ## -description Gets the address from the swiped AAMVA card. ## -property-value The address from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Address +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Address + +## -description +Gets the address from the swiped AAMVA card. + +## -property-value +The address from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_birthdate.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_birthdate.md index b4421c8a84..ea6368ca3e 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_birthdate.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_birthdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.BirthDate --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.BirthDate ## -description Gets the birth date from the swiped AAMVA card. ## -property-value The birth date from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.BirthDate +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.BirthDate + +## -description +Gets the birth date from the swiped AAMVA card. + +## -property-value +The birth date from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_city.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_city.md index 2c2eb0246a..f91f7a3962 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_city.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_city.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.City --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.City ## -description Gets the city from the swiped AAMVA card. ## -property-value The city from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.City +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.City + +## -description +Gets the city from the swiped AAMVA card. + +## -property-value +The city from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_class.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_class.md index 29cc652d27..3a29611c46 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_class.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_class.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Class --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Class ## -description Gets the class from the swiped AAMVA card. ## -property-value The class from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Class +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Class + +## -description +Gets the class from the swiped AAMVA card. + +## -property-value +The class from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_endorsements.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_endorsements.md index e5681239ba..b656e1ce51 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_endorsements.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_endorsements.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Endorsements --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Endorsements ## -description Gets the endorsements from the swiped AAMVA card. ## -property-value The endorsements from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Endorsements +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Endorsements + +## -description +Gets the endorsements from the swiped AAMVA card. + +## -property-value +The endorsements from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_expirationdate.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_expirationdate.md index 190e6f778e..90779c1e75 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_expirationdate.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_expirationdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.ExpirationDate --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.ExpirationDate ## -description Gets the expiration date from the swiped AAMVA card. ## -property-value The expiration date from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.ExpirationDate +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.ExpirationDate + +## -description +Gets the expiration date from the swiped AAMVA card. + +## -property-value +The expiration date from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_eyecolor.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_eyecolor.md index 455cf07df6..eec9b1b16e 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_eyecolor.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_eyecolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.EyeColor --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.EyeColor ## -description Gets the eye color from the swiped AAMVA card. ## -property-value The eye color from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.EyeColor +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.EyeColor + +## -description +Gets the eye color from the swiped AAMVA card. + +## -property-value +The eye color from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_firstname.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_firstname.md index a7f04e1c1e..7e77955735 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_firstname.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_firstname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.FirstName --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.FirstName ## -description Gets the first name from the swiped AAMVA card. ## -property-value The first name from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.FirstName +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.FirstName + +## -description +Gets the first name from the swiped AAMVA card. + +## -property-value +The first name from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_gender.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_gender.md index 03db653474..c65cf5eb4d 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_gender.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_gender.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Gender --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Gender ## -description Gets the gender from the swiped AAMVA card. ## -property-value The gender from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Gender +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Gender + +## -description +Gets the gender from the swiped AAMVA card. + +## -property-value +The gender from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_haircolor.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_haircolor.md index fc71c45a79..a695851123 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_haircolor.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_haircolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.HairColor --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.HairColor ## -description Gets the hair color from the swiped AAMVA card. ## -property-value The hair color from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.HairColor +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.HairColor + +## -description +Gets the hair color from the swiped AAMVA card. + +## -property-value +The hair color from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_height.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_height.md index 6ca5b6afa9..1a0588e2d6 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_height.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Height --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Height ## -description Gets the height from the swiped AAMVA card. ## -property-value The height from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Height +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Height + +## -description +Gets the height from the swiped AAMVA card. + +## -property-value +The height from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_licensenumber.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_licensenumber.md index 5bd206c363..fdc2a60c8a 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_licensenumber.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_licensenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.LicenseNumber --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.LicenseNumber ## -description Gets the license number from the swiped AAMVA card. ## -property-value The license number from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.LicenseNumber +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.LicenseNumber + +## -description +Gets the license number from the swiped AAMVA card. + +## -property-value +The license number from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_postalcode.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_postalcode.md index 9acc89e12e..06541c4be9 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_postalcode.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_postalcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.PostalCode --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.PostalCode ## -description Gets the postal code from the swiped AAMVA card. ## -property-value The postal code from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.PostalCode +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.PostalCode + +## -description +Gets the postal code from the swiped AAMVA card. + +## -property-value +The postal code from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_report.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_report.md index 656677c63d..46d1436d15 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_report.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_report.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Report --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Report ## -description Gets the additional data from the swiped AAMVA card. ## -property-value The report from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Report +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Report + +## -description +Gets the additional data from the swiped AAMVA card. + +## -property-value +The report from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_restrictions.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_restrictions.md index 1a33fabb44..6c7933ddc5 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_restrictions.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_restrictions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Restrictions --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Restrictions ## -description Gets the restrictions from the swiped AAMVA card. ## -property-value The restrictions from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Restrictions +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Restrictions + +## -description +Gets the restrictions from the swiped AAMVA card. + +## -property-value +The restrictions from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_state.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_state.md index c2ec637ec8..c12a4d7a6c 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_state.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.State --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.State ## -description Gets the state from the swiped AAMVA card. ## -property-value The state from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.State + +## -description +Gets the state from the swiped AAMVA card. + +## -property-value +The state from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_suffix.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_suffix.md index 1a3cbf04b0..930c2fc183 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_suffix.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_suffix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Suffix --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Suffix ## -description Gets the suffix from the swiped AAMVA card. ## -property-value The suffix from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Suffix +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Suffix + +## -description +Gets the suffix from the swiped AAMVA card. + +## -property-value +The suffix from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_surname.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_surname.md index 9b3fd94831..5fb33594ed 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_surname.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_surname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Surname --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Surname ## -description Gets the surname from the swiped card. ## -property-value The surname from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Surname +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Surname + +## -description +Gets the surname from the swiped card. + +## -property-value +The surname from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_weight.md b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_weight.md index ed0cfa980d..af6af00348 100644 --- a/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_weight.md +++ b/windows.devices.pointofservice/magneticstripereaderaamvacarddatareceivedeventargs_weight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Weight --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Weight ## -description Gets the weight from the swiped AAMVA card. ## -property-value The weight from the swiped AAMVA card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Weight +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderAamvaCardDataReceivedEventArgs.Weight + +## -description +Gets the weight from the swiped AAMVA card. + +## -property-value +The weight from the swiped AAMVA card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs.md index 97c7073667..606ba7de16 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs ## -description Provides bank card data from the [BankCardDataReceived](claimedmagneticstripereader_bankcarddatareceived.md) event. ## -remarks This object is created by the [BankCardDataReceived](claimedmagneticstripereader_bankcarddatareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs + +## -description +Provides bank card data from the [BankCardDataReceived](claimedmagneticstripereader_bankcarddatareceived.md) event. + +## -remarks +This object is created by the [BankCardDataReceived](claimedmagneticstripereader_bankcarddatareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_accountnumber.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_accountnumber.md index 705622e85b..7d44c1a112 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_accountnumber.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_accountnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.AccountNumber --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.AccountNumber ## -description Gets the account number from the swiped bank card. ## -property-value The account number from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.AccountNumber +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.AccountNumber + +## -description +Gets the account number from the swiped bank card. + +## -property-value +The account number from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_expirationdate.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_expirationdate.md index e0234a91e9..d403ec21de 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_expirationdate.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_expirationdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ExpirationDate --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ExpirationDate ## -description Gets the expiration date from the swiped card. ## -property-value The expiration date from the swiped card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ExpirationDate +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ExpirationDate + +## -description +Gets the expiration date from the swiped card. + +## -property-value +The expiration date from the swiped card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_firstname.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_firstname.md index 93e6114502..a9dce14c0e 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_firstname.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_firstname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.FirstName --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.FirstName ## -description Gets the first name from the swiped bank card. ## -property-value The first name from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.FirstName +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.FirstName + +## -description +Gets the first name from the swiped bank card. + +## -property-value +The first name from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_middleinitial.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_middleinitial.md index 5cc42ae598..2bb251ab3a 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_middleinitial.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_middleinitial.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.MiddleInitial --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.MiddleInitial ## -description Gets the middle initial from the swiped bank card. ## -property-value The middle initial from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.MiddleInitial +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.MiddleInitial + +## -description +Gets the middle initial from the swiped bank card. + +## -property-value +The middle initial from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_report.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_report.md index 5d2b8bcd14..48b14d6ad7 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_report.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_report.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Report --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Report ## -description Gets the data from the swiped bank card. ## -property-value The data from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Report +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Report + +## -description +Gets the data from the swiped bank card. + +## -property-value +The data from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_servicecode.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_servicecode.md index f8df88e539..6b65a21d1c 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_servicecode.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_servicecode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ServiceCode --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ServiceCode ## -description Gets the service code for the swiped bank card. ## -property-value The service code for the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ServiceCode +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.ServiceCode + +## -description +Gets the service code for the swiped bank card. + +## -property-value +The service code for the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_suffix.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_suffix.md index 7230ab0cd4..24db0c8273 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_suffix.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_suffix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Suffix --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Suffix ## -description Gets the suffix from the swiped bank card. ## -property-value The suffix from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Suffix +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Suffix + +## -description +Gets the suffix from the swiped bank card. + +## -property-value +The suffix from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_surname.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_surname.md index 7da20119a9..14a5ea8efb 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_surname.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_surname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Surname --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Surname ## -description Gets the surname from the swiped bank card. ## -property-value The surname from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Surname +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Surname + +## -description +Gets the surname from the swiped bank card. + +## -property-value +The surname from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_title.md b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_title.md index 27c5097379..767afd9eb4 100644 --- a/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_title.md +++ b/windows.devices.pointofservice/magneticstripereaderbankcarddatareceivedeventargs_title.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Title --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Title ## -description Gets the title from the swiped bank card. ## -property-value The title from the swiped bank card. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Title +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderBankCardDataReceivedEventArgs.Title + +## -description +Gets the title from the swiped bank card. + +## -property-value +The title from the swiped bank card. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities.md b/windows.devices.pointofservice/magneticstripereadercapabilities.md index c752e554db..d494f43b1e 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities ## -description Provides capabilities information for the magnetic stripe reader. ## -remarks This object is accessed when you retrieve the [Capabilities](magneticstripereader_capabilities.md) property of the [MagneticStripeReader](magneticstripereader.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities + +## -description +Provides capabilities information for the magnetic stripe reader. + +## -remarks +This object is accessed when you retrieve the [Capabilities](magneticstripereader_capabilities.md) property of the [MagneticStripeReader](magneticstripereader.md) object. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_authenticationlevel.md b/windows.devices.pointofservice/magneticstripereadercapabilities_authenticationlevel.md index c59e97d749..00d6594efa 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_authenticationlevel.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_authenticationlevel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.AuthenticationLevel --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.AuthenticationLevel ## -description Gets the authentication level supported by the device. ## -property-value The supported authentication level. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.AuthenticationLevel +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.AuthenticationLevel + +## -description +Gets the authentication level supported by the device. + +## -property-value +The supported authentication level. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_cardauthentication.md b/windows.devices.pointofservice/magneticstripereadercapabilities_cardauthentication.md index 43fc382194..e72c316148 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_cardauthentication.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_cardauthentication.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.CardAuthentication --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.CardAuthentication ## -description Gets the type of card authentication data that is supported by the device. ## -property-value The string containing the type of card authentication data. ## -remarks An empty string indicates that the device does not support authentication. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.CardAuthentication +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.CardAuthentication + +## -description +Gets the type of card authentication data that is supported by the device. + +## -property-value +The string containing the type of card authentication data. + +## -remarks +An empty string indicates that the device does not support authentication. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_isisosupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_isisosupported.md index 39fd650299..0d8fbe1ff8 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_isisosupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_isisosupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsIsoSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsIsoSupported ## -description Indicates whether the device supports ISO cards. ## -property-value True if the device supports ISO cards; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsIsoSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsIsoSupported + +## -description +Indicates whether the device supports ISO cards. + +## -property-value +True if the device supports ISO cards; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_isjisonesupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_isjisonesupported.md index 2d3aa84346..638d2ba48a 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_isjisonesupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_isjisonesupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisOneSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisOneSupported ## -description Indicates whether device supports JIS Type-I cards. ## -property-value True if the device support JIS Type-I cards; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisOneSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisOneSupported + +## -description +Indicates whether device supports JIS Type-I cards. + +## -property-value +True if the device support JIS Type-I cards; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_isjistwosupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_isjistwosupported.md index ac692800de..53beb7d7c7 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_isjistwosupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_isjistwosupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisTwoSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisTwoSupported ## -description Indicates whether the device supports JIS Type-II cards. ## -property-value True if the device supports JIS Type-II cards; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisTwoSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsJisTwoSupported + +## -description +Indicates whether the device supports JIS Type-II cards. + +## -property-value +True if the device supports JIS Type-II cards; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsreportingsupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsreportingsupported.md index ed91d7bc31..5ea57a061b 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsreportingsupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsreportingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsReportingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsReportingSupported ## -description Indicates whether the device supports reporting of usage statistics. ## -property-value True if the device supports reporting of usage statistics; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsReportingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsReportingSupported + +## -description +Indicates whether the device supports reporting of usage statistics. + +## -property-value +True if the device supports reporting of usage statistics; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsupdatingsupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsupdatingsupported.md index 58e1b8b46b..4445baf550 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsupdatingsupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_isstatisticsupdatingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsUpdatingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsUpdatingSupported ## -description Indicates whether the device supports updating of usage statistics. ## -property-value True if the device supports updating of statistics; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsUpdatingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsStatisticsUpdatingSupported + +## -description +Indicates whether the device supports updating of usage statistics. + +## -property-value +True if the device supports updating of statistics; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_istrackdatamaskingsupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_istrackdatamaskingsupported.md index c5375bcc49..f5bcefb76b 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_istrackdatamaskingsupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_istrackdatamaskingsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTrackDataMaskingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTrackDataMaskingSupported ## -description Indicates whether the device is capable of masking track data. ## -property-value True if the device is capable of masking track data; otherwise, false. ## -remarks When [IsTrackDataMaskingSupported](magneticstripereadercapabilities_istrackdatamaskingsupported.md) is true and encryption is enabled, the data returned from a data event contains masked data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTrackDataMaskingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTrackDataMaskingSupported + +## -description +Indicates whether the device is capable of masking track data. + +## -property-value +True if the device is capable of masking track data; otherwise, false. + +## -remarks +When [IsTrackDataMaskingSupported](magneticstripereadercapabilities_istrackdatamaskingsupported.md) is true and encryption is enabled, the data returned from a data event contains masked data. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_istransmitsentinelssupported.md b/windows.devices.pointofservice/magneticstripereadercapabilities_istransmitsentinelssupported.md index 5099ea07ae..e6e59fed35 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_istransmitsentinelssupported.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_istransmitsentinelssupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTransmitSentinelsSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTransmitSentinelsSupported ## -description Indicates whether the devices is able to transmit start and end sentinels. ## -property-value True if the device is able to transmit start and end sentinels; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTransmitSentinelsSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.IsTransmitSentinelsSupported + +## -description +Indicates whether the devices is able to transmit start and end sentinels. + +## -property-value +True if the device is able to transmit start and end sentinels; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_powerreportingtype.md b/windows.devices.pointofservice/magneticstripereadercapabilities_powerreportingtype.md index b409fb3d4a..e5b25e2e51 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_powerreportingtype.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_powerreportingtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.PowerReportingType --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.PowerReportingType ## -description Gets the power reporting capabilities of the device. ## -property-value The power reporting capabilities of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.PowerReportingType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.PowerReportingType + +## -description +Gets the power reporting capabilities of the device. + +## -property-value +The power reporting capabilities of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercapabilities_supportedencryptionalgorithms.md b/windows.devices.pointofservice/magneticstripereadercapabilities_supportedencryptionalgorithms.md index 560de5ef82..4e422611a6 100644 --- a/windows.devices.pointofservice/magneticstripereadercapabilities_supportedencryptionalgorithms.md +++ b/windows.devices.pointofservice/magneticstripereadercapabilities_supportedencryptionalgorithms.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.SupportedEncryptionAlgorithms --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.SupportedEncryptionAlgorithms ## -description Gets the supported encryption algorithm. ## -property-value The supported encryption algorithm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.SupportedEncryptionAlgorithms +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCapabilities.SupportedEncryptionAlgorithms + +## -description +Gets the supported encryption algorithm. + +## -property-value +The supported encryption algorithm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercardtypes.md b/windows.devices.pointofservice/magneticstripereadercardtypes.md index a2e3eb4f23..879ce8b9bb 100644 --- a/windows.devices.pointofservice/magneticstripereadercardtypes.md +++ b/windows.devices.pointofservice/magneticstripereadercardtypes.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderCardTypes ## -description Contains the card type of the recently swiped card. ## -remarks This is a static class that contains the card type of the most recently swiped card. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCardTypes + +## -description +Contains the card type of the recently swiped card. + +## -remarks +This is a static class that contains the card type of the most recently swiped card. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercardtypes_aamva.md b/windows.devices.pointofservice/magneticstripereadercardtypes_aamva.md index 3f83cacac7..252607b83c 100644 --- a/windows.devices.pointofservice/magneticstripereadercardtypes_aamva.md +++ b/windows.devices.pointofservice/magneticstripereadercardtypes_aamva.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Aamva --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Aamva ## -description Indicates the American Association of Motor Vehicle Administrators (AAMVA) card type. ## -property-value The AAMVA card type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Aamva +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Aamva + +## -description +Indicates the American Association of Motor Vehicle Administrators (AAMVA) card type. + +## -property-value +The AAMVA card type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercardtypes_bank.md b/windows.devices.pointofservice/magneticstripereadercardtypes_bank.md index 36429e3ce9..4306db9da9 100644 --- a/windows.devices.pointofservice/magneticstripereadercardtypes_bank.md +++ b/windows.devices.pointofservice/magneticstripereadercardtypes_bank.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Bank --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Bank ## -description Indicates a bank card type. ## -property-value Bank card type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Bank +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Bank + +## -description +Indicates a bank card type. + +## -property-value +Bank card type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercardtypes_extendedbase.md b/windows.devices.pointofservice/magneticstripereadercardtypes_extendedbase.md index fbbe92ebc9..26c40c03e6 100644 --- a/windows.devices.pointofservice/magneticstripereadercardtypes_extendedbase.md +++ b/windows.devices.pointofservice/magneticstripereadercardtypes_extendedbase.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.ExtendedBase --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.ExtendedBase ## -description Indicates vendor-specific card type. ## -property-value Vendor-specific card type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.ExtendedBase +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.ExtendedBase + +## -description +Indicates vendor-specific card type. + +## -property-value +Vendor-specific card type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadercardtypes_unknown.md b/windows.devices.pointofservice/magneticstripereadercardtypes_unknown.md index 80ed4222e1..d9a14191b5 100644 --- a/windows.devices.pointofservice/magneticstripereadercardtypes_unknown.md +++ b/windows.devices.pointofservice/magneticstripereadercardtypes_unknown.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Unknown --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Unknown ## -description Indicates an unknown card type. ## -property-value Unknown card type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Unknown +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderCardTypes.Unknown + +## -description +Indicates an unknown card type. + +## -property-value +Unknown card type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms.md b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms.md index 719f150682..c83ee00323 100644 --- a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms.md +++ b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms ## -description Contains the encryption algorithm supported by the device. ## -remarks This is a static class that contains the encryption algorithm supported by the device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms + +## -description +Contains the encryption algorithm supported by the device. + +## -remarks +This is a static class that contains the encryption algorithm supported by the device. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_extendedbase.md b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_extendedbase.md index d719568fde..a878385ab0 100644 --- a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_extendedbase.md +++ b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_extendedbase.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.ExtendedBase --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.ExtendedBase ## -description Indicates vendor specific encryption algorithm. ## -property-value Vendor-specific algorithm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.ExtendedBase +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.ExtendedBase + +## -description +Indicates vendor specific encryption algorithm. + +## -property-value +Vendor-specific algorithm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_none.md b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_none.md index 49f55ffed5..42d9b19ab3 100644 --- a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_none.md +++ b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_none.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.None --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.None ## -description Indicates no encryption algorithm. ## -property-value No encryption algorithm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.None +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.None + +## -description +Indicates no encryption algorithm. + +## -property-value +No encryption algorithm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_tripledesdukpt.md b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_tripledesdukpt.md index 2d5da77dd4..05706ca01f 100644 --- a/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_tripledesdukpt.md +++ b/windows.devices.pointofservice/magneticstripereaderencryptionalgorithms_tripledesdukpt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.TripleDesDukpt --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.TripleDesDukpt ## -description Indicates Triple DES DUKPT (Derived Unique Key Per Transaction) encryption algorithm supported by the device. ## -property-value The Triple DES DUKPT encryption algorithm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.TripleDesDukpt +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderEncryptionAlgorithms.TripleDesDukpt + +## -description +Indicates Triple DES DUKPT (Derived Unique Key Per Transaction) encryption algorithm supported by the device. + +## -property-value +The Triple DES DUKPT encryption algorithm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs.md index 7e20de1551..26b04a569a 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs ## -description Provides error information for the [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) event. ## -remarks This object is created by the [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs + +## -description +Provides error information for the [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) event. + +## -remarks +This object is created by the [ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also +[ErrorOccurred](claimedmagneticstripereader_erroroccurred.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_errordata.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_errordata.md index 1502edcee7..c9013e5505 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_errordata.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_errordata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.ErrorData --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.ErrorData ## -description Gets the error information, such as cause of error, severity, error message, and any available vendor specific error information. ## -property-value The error information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.ErrorData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.ErrorData + +## -description +Gets the error information, such as cause of error, severity, error message, and any available vendor specific error information. + +## -property-value +The error information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_partialinputdata.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_partialinputdata.md index 0c735c5997..26b3bb1b09 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_partialinputdata.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_partialinputdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.PartialInputData --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.PartialInputData ## -description Gets the track data for tracks the did not have errors. ## -property-value The track data for tracks the did not have errors. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.PartialInputData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.PartialInputData + +## -description +Gets the track data for tracks the did not have errors. + +## -property-value +The track data for tracks the did not have errors. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track1status.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track1status.md index 0efa1fd0fb..73f10aeea7 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track1status.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track1status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track1Status --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track1Status ## -description Gets the Track 1 error information. ## -property-value The Track 1 error information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track1Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track1Status + +## -description +Gets the Track 1 error information. + +## -property-value +The Track 1 error information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track2status.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track2status.md index 504aee10f6..db3475f048 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track2status.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track2status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track2Status --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track2Status ## -description Gets the Track 2 error information. ## -property-value The Track 2 error information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track2Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track2Status + +## -description +Gets the Track 2 error information. + +## -property-value +The Track 2 error information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track3status.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track3status.md index b9686a168b..beb1c1beb1 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track3status.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track3status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track3Status --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track3Status ## -description Gets the Track 3 error information. ## -property-value The Track 3 error information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track3Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track3Status + +## -description +Gets the Track 3 error information. + +## -property-value +The Track 3 error information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track4status.md b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track4status.md index bd94fd5cd8..03c1774a8c 100644 --- a/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track4status.md +++ b/windows.devices.pointofservice/magneticstripereadererroroccurredeventargs_track4status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track4Status --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track4Status ## -description Gets the Track 4 error information. ## -property-value The Track 4 error information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track4Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderErrorOccurredEventArgs.Track4Status + +## -description +Gets the Track 4 error information. + +## -property-value +The Track 4 error information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport.md b/windows.devices.pointofservice/magneticstripereaderreport.md index d21d7226ea..5837418057 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport.md +++ b/windows.devices.pointofservice/magneticstripereaderreport.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderReport --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport ## -description Contains data from the recently swiped card. ## -remarks This object is accessed when you retrieve the Report property of [MagneticStripeReaderBankCardDataReceivedEventArgs](magneticstripereaderbankcarddatareceivedeventargs.md), [MagneticStripeReaderAamvaCardDataReceivedEventArgs](magneticstripereaderaamvacarddatareceivedeventargs.md), or [MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs](magneticstripereadervendorspecificcarddatareceivedeventargs.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderReport +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport + +## -description +Contains data from the recently swiped card. + +## -remarks +This object is accessed when you retrieve the Report property of [MagneticStripeReaderBankCardDataReceivedEventArgs](magneticstripereaderbankcarddatareceivedeventargs.md), [MagneticStripeReaderAamvaCardDataReceivedEventArgs](magneticstripereaderaamvacarddatareceivedeventargs.md), or [MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs](magneticstripereadervendorspecificcarddatareceivedeventargs.md) object. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_additionalsecurityinformation.md b/windows.devices.pointofservice/magneticstripereaderreport_additionalsecurityinformation.md index b3b0ce5d51..464829cee9 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_additionalsecurityinformation.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_additionalsecurityinformation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.AdditionalSecurityInformation --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.AdditionalSecurityInformation ## -description Gets the additional security or encryption information for the recently swiped card. ## -property-value The additional security or encryption information. ## -remarks The information content and internal format of this property vary among encryption algorithms. For example, for DUKPT this property contains the DUKPT sequence number. This property is empty if the encryption algorithm does not require it. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.AdditionalSecurityInformation +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.AdditionalSecurityInformation + +## -description +Gets the additional security or encryption information for the recently swiped card. + +## -property-value +The additional security or encryption information. + +## -remarks +The information content and internal format of this property vary among encryption algorithms. For example, for DUKPT this property contains the DUKPT sequence number. This property is empty if the encryption algorithm does not require it. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdata.md b/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdata.md index 05808f958c..142dbd748e 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdata.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationData --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationData ## -description Gets the card authentication information for the recently swiped card. ## -property-value The card authentication data. ## -remarks The information and internal format of this property vary among services. This property is empty if the device does not support authentication. Otherwise, the value of this property is encrypted using the encryption algorithm in [DataEncryptionAlgorithm](claimedmagneticstripereader_dataencryptionalgorithm.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationData + +## -description +Gets the card authentication information for the recently swiped card. + +## -property-value +The card authentication data. + +## -remarks +The information and internal format of this property vary among services. This property is empty if the device does not support authentication. Otherwise, the value of this property is encrypted using the encryption algorithm in [DataEncryptionAlgorithm](claimedmagneticstripereader_dataencryptionalgorithm.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdatalength.md b/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdatalength.md index f07b29fbb4..b0131a867a 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdatalength.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_cardauthenticationdatalength.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationDataLength --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationDataLength ## -description Gets the length of the raw [CardAuthenticationData](magneticstripereaderreport_cardauthenticationdata.md) before it is encrypted. ## -property-value The length of the raw [CardAuthenticationData](magneticstripereaderreport_cardauthenticationdata.md) before it is encrypted. ## -remarks Many encryption algorithms require padding of the input data before it can be encrypted. This property contains the length of the original unpadded data before it is encrypted. It may be needed to restore the original data after decryption. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationDataLength +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.CardAuthenticationDataLength + +## -description +Gets the length of the raw [CardAuthenticationData](magneticstripereaderreport_cardauthenticationdata.md) before it is encrypted. + +## -property-value +The length of the raw [CardAuthenticationData](magneticstripereaderreport_cardauthenticationdata.md) before it is encrypted. + +## -remarks +Many encryption algorithms require padding of the input data before it can be encrypted. This property contains the length of the original unpadded data before it is encrypted. It may be needed to restore the original data after decryption. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_cardtype.md b/windows.devices.pointofservice/magneticstripereaderreport_cardtype.md index a0b501c9e1..faf143f029 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_cardtype.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_cardtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.CardType --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.CardType ## -description Gets the card type identifier for the recently swiped card. ## -property-value The card type identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.CardType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.CardType + +## -description +Gets the card type identifier for the recently swiped card. + +## -property-value +The card type identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_properties.md b/windows.devices.pointofservice/magneticstripereaderreport_properties.md index adff86919f..9452492b13 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_properties.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Properties --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.Properties ## -description Gets a dictionary of properties for the recently swiped card. ## -property-value A dictionary of properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.Properties + +## -description +Gets a dictionary of properties for the recently swiped card. + +## -property-value +A dictionary of properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_track1.md b/windows.devices.pointofservice/magneticstripereaderreport_track1.md index 5e1390b99d..cbdf4ee702 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_track1.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_track1.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track1 --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.Track1 ## -description Gets the track data for Track 1. ## -property-value The Track 1 data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track1 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.Track1 + +## -description +Gets the track data for Track 1. + +## -property-value +The Track 1 data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_track2.md b/windows.devices.pointofservice/magneticstripereaderreport_track2.md index b6a5d66799..d5720e4b75 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_track2.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_track2.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track2 --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.Track2 ## -description Gets the track data for Track 2. ## -property-value The Track 3 data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.Track2 + +## -description +Gets the track data for Track 2. + +## -property-value +The Track 3 data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_track3.md b/windows.devices.pointofservice/magneticstripereaderreport_track3.md index 2766fc523c..1f69262433 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_track3.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_track3.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track3 --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.Track3 ## -description Gets the track data for Track 3. ## -property-value The Track 3 data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track3 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.Track3 + +## -description +Gets the track data for Track 3. + +## -property-value +The Track 3 data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderreport_track4.md b/windows.devices.pointofservice/magneticstripereaderreport_track4.md index bf0b76302b..23e29ef303 100644 --- a/windows.devices.pointofservice/magneticstripereaderreport_track4.md +++ b/windows.devices.pointofservice/magneticstripereaderreport_track4.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track4 --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderReport.Track4 ## -description Gets the track data for Track 4. ## -property-value The Track 4 data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderReport.Track4 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderReport.Track4 + +## -description +Gets the track data for Track 4. + +## -property-value +The Track 4 data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs.md b/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs.md index 776b880b56..0b57eb20c9 100644 --- a/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs.md +++ b/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs ## -description Provides information about an operation status change. ## -remarks This object is created by the [StatusUpdated](magneticstripereader_statusupdated.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs + +## -description +Provides information about an operation status change. + +## -remarks +This object is created by the [StatusUpdated](magneticstripereader_statusupdated.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_extendedstatus.md b/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_extendedstatus.md index be05c7db9e..96b281cc38 100644 --- a/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_extendedstatus.md +++ b/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_extendedstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.ExtendedStatus --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.ExtendedStatus ## -description Gets the vendor specific error code. ## -property-value The vendor specific error code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.ExtendedStatus +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.ExtendedStatus + +## -description +Gets the vendor specific error code. + +## -property-value +The vendor specific error code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_status.md b/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_status.md index b55f99788d..da069f23d7 100644 --- a/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_status.md +++ b/windows.devices.pointofservice/magneticstripereaderstatusupdatedeventargs_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.Status ## -description Gets the status change information. ## -property-value The status change information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderStatusUpdatedEventArgs.Status + +## -description +Gets the status change information. + +## -property-value +The status change information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadertrackdata.md b/windows.devices.pointofservice/magneticstripereadertrackdata.md index a72b28f915..b7b75444bc 100644 --- a/windows.devices.pointofservice/magneticstripereadertrackdata.md +++ b/windows.devices.pointofservice/magneticstripereadertrackdata.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderTrackData --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderTrackData ## -description Contains the track data obtained following a card swipe. ## -remarks This object is accessed when you retrieve the [Track1](magneticstripereaderreport_track1.md), [Track2](magneticstripereaderreport_track2.md), [Track3](magneticstripereaderreport_track3.md), and [Track4](magneticstripereaderreport_track4.md) properties of the [MagneticStripeReaderReport](magneticstripereaderreport.md) object. ## -examples ## -see-also [MagneticStripeReaderReport](magneticstripereaderreport.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderTrackData +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderTrackData + +## -description +Contains the track data obtained following a card swipe. + +## -remarks +This object is accessed when you retrieve the [Track1](magneticstripereaderreport_track1.md), [Track2](magneticstripereaderreport_track2.md), [Track3](magneticstripereaderreport_track3.md), and [Track4](magneticstripereaderreport_track4.md) properties of the [MagneticStripeReaderReport](magneticstripereaderreport.md) object. + +## -examples + +## -see-also +[MagneticStripeReaderReport](magneticstripereaderreport.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/magneticstripereadertrackdata_data.md b/windows.devices.pointofservice/magneticstripereadertrackdata_data.md index 03ff84ae67..2c4b5ee229 100644 --- a/windows.devices.pointofservice/magneticstripereadertrackdata_data.md +++ b/windows.devices.pointofservice/magneticstripereadertrackdata_data.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderTrackData.Data --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderTrackData.Data ## -description Gets the raw or decoded data from the swiped card. ## -property-value The track data from the swiped card. ## -remarks If [IsDecodeDataEnabled](claimedmagneticstripereader_isdecodedataenabled.md) is true, then [Data](magneticstripereadertrackdata_data.md) contains decoded data. If [IsTransmitSentinelsEnabled](claimedmagneticstripereader_istransmitsentinelsenabled.md) is false, then [Data](magneticstripereadertrackdata_data.md) contains the track data between sentinels, but not including the start and end sentinels. If [IsTransmitSentinelsEnabled](claimedmagneticstripereader_istransmitsentinelsenabled.md) is true, then the track data includes the start and end sentinels. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderTrackData.Data +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderTrackData.Data + +## -description +Gets the raw or decoded data from the swiped card. + +## -property-value +The track data from the swiped card. + +## -remarks +If [IsDecodeDataEnabled](claimedmagneticstripereader_isdecodedataenabled.md) is true, then [Data](magneticstripereadertrackdata_data.md) contains decoded data. + +If [IsTransmitSentinelsEnabled](claimedmagneticstripereader_istransmitsentinelsenabled.md) is false, then [Data](magneticstripereadertrackdata_data.md) contains the track data between sentinels, but not including the start and end sentinels. If [IsTransmitSentinelsEnabled](claimedmagneticstripereader_istransmitsentinelsenabled.md) is true, then the track data includes the start and end sentinels. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadertrackdata_discretionarydata.md b/windows.devices.pointofservice/magneticstripereadertrackdata_discretionarydata.md index acb420d1ca..c9542e9f27 100644 --- a/windows.devices.pointofservice/magneticstripereadertrackdata_discretionarydata.md +++ b/windows.devices.pointofservice/magneticstripereadertrackdata_discretionarydata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderTrackData.DiscretionaryData --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderTrackData.DiscretionaryData ## -description Gets the discretionary data from the swiped card. ## -property-value The discretionary data from the swiped card. ## -remarks The array will always be empty if [IsDecodeDataEnabled](claimedmagneticstripereader_isdecodedataenabled.md) propety is false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderTrackData.DiscretionaryData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderTrackData.DiscretionaryData + +## -description +Gets the discretionary data from the swiped card. + +## -property-value +The discretionary data from the swiped card. + +## -remarks +The array will always be empty if [IsDecodeDataEnabled](claimedmagneticstripereader_isdecodedataenabled.md) propety is false. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadertrackdata_encrypteddata.md b/windows.devices.pointofservice/magneticstripereadertrackdata_encrypteddata.md index a13095a72c..f5b71a644b 100644 --- a/windows.devices.pointofservice/magneticstripereadertrackdata_encrypteddata.md +++ b/windows.devices.pointofservice/magneticstripereadertrackdata_encrypteddata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderTrackData.EncryptedData --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderTrackData.EncryptedData ## -description Gets the encrypted data from the swiped card. ## -property-value The encrypted data from the swiped card. ## -remarks This property is empty if the [DataEncryptionAlgorithm](claimedmagneticstripereader_dataencryptionalgorithm.md) is set to None. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderTrackData.EncryptedData +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderTrackData.EncryptedData + +## -description +Gets the encrypted data from the swiped card. + +## -property-value +The encrypted data from the swiped card. + +## -remarks +This property is empty if the [DataEncryptionAlgorithm](claimedmagneticstripereader_dataencryptionalgorithm.md) is set to None. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs.md b/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs.md index 0d284fbe7e..877cb8011f 100644 --- a/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs.md +++ b/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs ## -description Provides data for the recently swiped vendor card. ## -remarks This object is created by the [VendorSpecificDataReceived](claimedmagneticstripereader_vendorspecificdatareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs + +## -description +Provides data for the recently swiped vendor card. + +## -remarks +This object is created by the [VendorSpecificDataReceived](claimedmagneticstripereader_vendorspecificdatareceived.md) event and is returned as an argument to the [TypedEventHandler](../windows.foundation/typedeventhandler_2.md) delegate. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs_report.md b/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs_report.md index 4bc0008e9f..f843fbe9b4 100644 --- a/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs_report.md +++ b/windows.devices.pointofservice/magneticstripereadervendorspecificcarddatareceivedeventargs_report.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs.Report --api-type: winrt property ---- # Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs.Report ## -description Gets data for the recently swiped vendor card. ## -property-value The vendor specific data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs.Report +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs.Report + +## -description +Gets data for the recently swiped vendor card. + +## -property-value +The vendor specific data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinter.md b/windows.devices.pointofservice/posprinter.md index e24523cb18..fe5526e33a 100644 --- a/windows.devices.pointofservice/posprinter.md +++ b/windows.devices.pointofservice/posprinter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.PosPrinter --api-type: winrt class ---- # Windows.Devices.PointOfService.PosPrinter ## -description Represents a point-of-service printer. ## -remarks To get a [PosPrinter](posprinter.md) object, use the [FromIdAsync](posprinter_fromidasync.md) or [GetDefaultAsync](posprinter_getdefaultasync.md) static methods. ## -examples ## -see-also [FromIdAsync](posprinter_fromidasync.md), [GetDefaultAsync](posprinter_getdefaultasync.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.PosPrinter +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.PosPrinter + +## -description +Represents a point-of-service printer. + +## -remarks +To get a [PosPrinter](posprinter.md) object, use the [FromIdAsync](posprinter_fromidasync.md) or [GetDefaultAsync](posprinter_getdefaultasync.md) static methods. + +## -examples + +## -see-also +[FromIdAsync](posprinter_fromidasync.md), [GetDefaultAsync](posprinter_getdefaultasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_capabilities.md b/windows.devices.pointofservice/posprinter_capabilities.md index b5e8c69b37..9b7882fdb3 100644 --- a/windows.devices.pointofservice/posprinter_capabilities.md +++ b/windows.devices.pointofservice/posprinter_capabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinter.Capabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinter.Capabilities ## -description Gets the capabilities of the point-of-service printer. ## -property-value The capabilities of the point-of-service printer. ## -remarks ## -examples ## -see-also [PosPrinterCapabilities](posprintercapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinter.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinter.Capabilities + +## -description +Gets the capabilities of the point-of-service printer. + +## -property-value +The capabilities of the point-of-service printer. + +## -remarks + +## -examples + +## -see-also +[PosPrinterCapabilities](posprintercapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_checkhealthasync_1543183748.md b/windows.devices.pointofservice/posprinter_checkhealthasync_1543183748.md index 16392781f5..58ae577953 100644 --- a/windows.devices.pointofservice/posprinter_checkhealthasync_1543183748.md +++ b/windows.devices.pointofservice/posprinter_checkhealthasync_1543183748.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.PointOfService.PosPrinter.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) --api-type: winrt method ---- # Windows.Devices.PointOfService.PosPrinter.CheckHealthAsync ## -description Gets the health state of the point-of-service printer asynchronously. ## -parameters ### -param level The type of health check that you want to perform for the point-of-service printer. Only level POSInternal(1) should be used, as any other [UnifiedPosHealthCheckLevel](unifiedposhealthchecklevel.md) levels will result in an error. ## -returns An asynchronous operation that returns the health state of the point-of-service printer. You should display this value in the app interface immediately so the user of the app can interpret the value. For example, the operation returns “OK” as the health state if the state of the point-of-service printer is good. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.CheckHealthAsync + +## -description +Gets the health state of the point-of-service printer asynchronously. + +## -parameters +### -param level +The type of health check that you want to perform for the point-of-service printer. Only level POSInternal(1) should be used, as any other [UnifiedPosHealthCheckLevel](unifiedposhealthchecklevel.md) levels will result in an error. + +## -returns +An asynchronous operation that returns the health state of the point-of-service printer. You should display this value in the app interface immediately so the user of the app can interpret the value. For example, the operation returns “OK” as the health state if the state of the point-of-service printer is good. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinter_claimprinterasync_1994037670.md b/windows.devices.pointofservice/posprinter_claimprinterasync_1994037670.md index f13a293125..66e150d0a4 100644 --- a/windows.devices.pointofservice/posprinter_claimprinterasync_1994037670.md +++ b/windows.devices.pointofservice/posprinter_claimprinterasync_1994037670.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.PosPrinter.ClaimPrinterAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.PosPrinter.ClaimPrinterAsync ## -description Claims the point-of-service printer for use, and gets an instance of the [ClaimedPosPrinter](claimedposprinter.md) class for the point-of-service printer. ## -returns The claimed point-of-service printer. ## -remarks The claim is cooperatively managed, so multiple concurrent apps can negotiate which app owns the claim. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.ClaimPrinterAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.ClaimPrinterAsync + +## -description +Claims the point-of-service printer for use, and gets an instance of the [ClaimedPosPrinter](claimedposprinter.md) class for the point-of-service printer. + +## -returns +The claimed point-of-service printer. + +## -remarks +The claim is cooperatively managed, so multiple concurrent apps can negotiate which app owns the claim. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinter_deviceid.md b/windows.devices.pointofservice/posprinter_deviceid.md index ea22495287..931427aca1 100644 --- a/windows.devices.pointofservice/posprinter_deviceid.md +++ b/windows.devices.pointofservice/posprinter_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinter.DeviceId --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinter.DeviceId ## -description Gets the identifier of the point-of-service printer. ## -property-value The identifier of the point-of-service printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinter.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinter.DeviceId + +## -description +Gets the identifier of the point-of-service printer. + +## -property-value +The identifier of the point-of-service printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinter_fromidasync_1322863552.md b/windows.devices.pointofservice/posprinter_fromidasync_1322863552.md index 9230114552..656ad529df 100644 --- a/windows.devices.pointofservice/posprinter_fromidasync_1322863552.md +++ b/windows.devices.pointofservice/posprinter_fromidasync_1322863552.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.PosPrinter.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.PosPrinter.FromIdAsync ## -description Creates a [PosPrinter](posprinter.md) object for point-of-service printer with the specified [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). ## -parameters ### -param deviceId The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific point-of-service printer. ## -returns The point-of-service printer that the unique device identifier identifies. Returns a null object in the following cases: + The specific printer is not found. + Access is denied to the existing printer. The user can deny access to a device, which is not treated as an exception. ## -remarks The app package manifest must include the PointofService device capability. If the manifest omits this capability, this method returns null and no exception is generated. ## -examples ## -see-also [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.FromIdAsync + +## -description +Creates a [PosPrinter](posprinter.md) object for point-of-service printer with the specified [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific point-of-service printer. + +## -returns +The point-of-service printer that the unique device identifier identifies. Returns a null object in the following cases: ++ The specific printer is not found. ++ Access is denied to the existing printer. The user can deny access to a device, which is not treated as an exception. + + +## -remarks +The app package manifest must include the PointofService device capability. If the manifest omits this capability, this method returns null and no exception is generated. + +## -examples + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_getdefaultasync_1549573963.md b/windows.devices.pointofservice/posprinter_getdefaultasync_1549573963.md index d6519338e6..597cb195d2 100644 --- a/windows.devices.pointofservice/posprinter_getdefaultasync_1549573963.md +++ b/windows.devices.pointofservice/posprinter_getdefaultasync_1549573963.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.PosPrinter.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.PosPrinter.GetDefaultAsync ## -description Gets the default paired or locally-connected printer. ## -returns The default locally-connected printer. ## -remarks The app manifest must include the PointofService device capability. If the manifest omits this capability, this method returns null and no exception is generated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.GetDefaultAsync + +## -description +Gets the default paired or locally-connected printer. + +## -returns +The default locally-connected printer. + +## -remarks +The app manifest must include the PointofService device capability. If the manifest omits this capability, this method returns null and no exception is generated. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinter_getdeviceselector_838466080.md b/windows.devices.pointofservice/posprinter_getdeviceselector_838466080.md index 57159ee5b4..7ee729b70f 100644 --- a/windows.devices.pointofservice/posprinter_getdeviceselector_838466080.md +++ b/windows.devices.pointofservice/posprinter_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.PointOfService.PosPrinter.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.PointOfService.PosPrinter.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that you can use to list the available point-of-service printers. ## -returns An Advanced Query Syntax (AQS) string that you can use to list the available point-of-service printers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the available point-of-service printers. + +## -returns +An Advanced Query Syntax (AQS) string that you can use to list the available point-of-service printers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinter_getstatisticsasync_980600774.md b/windows.devices.pointofservice/posprinter_getstatisticsasync_980600774.md index 8aa4332580..dc8c6f17c2 100644 --- a/windows.devices.pointofservice/posprinter_getstatisticsasync_980600774.md +++ b/windows.devices.pointofservice/posprinter_getstatisticsasync_980600774.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.PosPrinter.GetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Devices.PointOfService.PosPrinter.GetStatisticsAsync ## -description Gets the specified statistics from the point-of-service printer. ## -parameters ### -param statisticsCategories The list of statistics to retrieve. + An empty string ("") retrieves all statistics. + "U_" retrieves all UnifiedPOS defined statistics. + "M_" retrieves all manufacturer defined statistics. + "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. + Any combination of individual and groups names ("name3", "U_", "M_"). ## -returns The requested statistics. ## -remarks ## -examples ## -see-also [IIterable](../windows.foundation.collections/iiterable_1.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.GetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.GetStatisticsAsync + +## -description +Gets the specified statistics from the point-of-service printer. + +## -parameters +### -param statisticsCategories +The list of statistics to retrieve. ++ An empty string ("") retrieves all statistics. ++ "U_" retrieves all UnifiedPOS defined statistics. ++ "M_" retrieves all manufacturer defined statistics. ++ "name1" and/or "name2" retrieves specific named statistics as defined by the UnifiedPOS or manufacturer. ++ Any combination of individual and groups names ("name3", "U_", "M_"). + + +## -returns +The requested statistics. + +## -remarks + +## -examples + +## -see-also +[IIterable](../windows.foundation.collections/iiterable_1.md), [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_status.md b/windows.devices.pointofservice/posprinter_status.md index 4a6c3145e4..20039603d8 100644 --- a/windows.devices.pointofservice/posprinter_status.md +++ b/windows.devices.pointofservice/posprinter_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinter.Status --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinter.Status ## -description Gets the current status of the power and availability of the point-of-service printer. ## -property-value The current status of the power and availability of the point-of-service printer. ## -remarks ## -examples ## -see-also [PosPrinterStatus](posprinterstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinter.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinter.Status + +## -description +Gets the current status of the power and availability of the point-of-service printer. + +## -property-value +The current status of the power and availability of the point-of-service printer. + +## -remarks + +## -examples + +## -see-also +[PosPrinterStatus](posprinterstatus.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_statusupdated.md b/windows.devices.pointofservice/posprinter_statusupdated.md index de3deef671..e2aad2c160 100644 --- a/windows.devices.pointofservice/posprinter_statusupdated.md +++ b/windows.devices.pointofservice/posprinter_statusupdated.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.PointOfService.PosPrinter.StatusUpdated --api-type: winrt event ---- # Windows.Devices.PointOfService.PosPrinter.StatusUpdated ## -description Occurs when the status of the power or availability of the point-of-service printer changes. ## -remarks ## -examples ## -see-also [TypedEventHandler](../windows.foundation/typedeventhandler_2.md), [PosPrinterStatusUpdatedEventArgs](posprinterstatusupdatedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.PointOfService.PosPrinter.StatusUpdated +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.PosPrinter.StatusUpdated + +## -description +Occurs when the status of the power or availability of the point-of-service printer changes. + +## -remarks + +## -examples + +## -see-also +[TypedEventHandler](../windows.foundation/typedeventhandler_2.md), [PosPrinterStatusUpdatedEventArgs](posprinterstatusupdatedeventargs.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_supportedcharactersets.md b/windows.devices.pointofservice/posprinter_supportedcharactersets.md index 0ef20af9e5..bc9fe58fe3 100644 --- a/windows.devices.pointofservice/posprinter_supportedcharactersets.md +++ b/windows.devices.pointofservice/posprinter_supportedcharactersets.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinter.SupportedCharacterSets --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinter.SupportedCharacterSets ## -description Gets the list of character sets that the point-of-service printer supports. ## -property-value The list of numeric values for the character sets that the point-of-service-printer supports. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinter.SupportedCharacterSets +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinter.SupportedCharacterSets + +## -description +Gets the list of character sets that the point-of-service printer supports. + +## -property-value +The list of numeric values for the character sets that the point-of-service-printer supports. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinter_supportedtypefaces.md b/windows.devices.pointofservice/posprinter_supportedtypefaces.md index 2ecf7649d3..1772810136 100644 --- a/windows.devices.pointofservice/posprinter_supportedtypefaces.md +++ b/windows.devices.pointofservice/posprinter_supportedtypefaces.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinter.SupportedTypeFaces --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinter.SupportedTypeFaces ## -description Gets the fonts and typefaces that the point-of-service printer supports. ## -property-value The fonts and typefaces that the point-of-service printer supports. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinter.SupportedTypeFaces +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinter.SupportedTypeFaces + +## -description +Gets the fonts and typefaces that the point-of-service printer supports. + +## -property-value +The fonts and typefaces that the point-of-service printer supports. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercapabilities.md b/windows.devices.pointofservice/posprintercapabilities.md index 283c402b7e..4ab8a6b67c 100644 --- a/windows.devices.pointofservice/posprintercapabilities.md +++ b/windows.devices.pointofservice/posprintercapabilities.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.PosPrinterCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.PosPrinterCapabilities ## -description Represents the capabilities of the point-of-service printer. ## -remarks To get the capabilities of the point-of-service printer, use the [PosPrinter.Capabilities](posprinter_capabilities.md) property. ## -examples ## -see-also [PosPrinter.Capabilities](posprinter_capabilities.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.PosPrinterCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities + +## -description +Represents the capabilities of the point-of-service printer. + +## -remarks +To get the capabilities of the point-of-service printer, use the [PosPrinter.Capabilities](posprinter_capabilities.md) property. + +## -examples + +## -see-also +[PosPrinter.Capabilities](posprinter_capabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercapabilities_canmapcharacterset.md b/windows.devices.pointofservice/posprintercapabilities_canmapcharacterset.md index 8889e3738f..b0bc2477af 100644 --- a/windows.devices.pointofservice/posprintercapabilities_canmapcharacterset.md +++ b/windows.devices.pointofservice/posprintercapabilities_canmapcharacterset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.CanMapCharacterSet --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.CanMapCharacterSet ## -description Gets whether the point-of-service printer can map the characters that the application sends (in the character set that the [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) property defines) to the character sets that the [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) property defines. ## -property-value True if the point-of-service printer can map the characters that the application sends to the code page used by the printer. If false, the user must make sure that the Unicode characters have the low byte as the value that will be used to send to the printer. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md), [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.CanMapCharacterSet +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.CanMapCharacterSet + +## -description +Gets whether the point-of-service printer can map the characters that the application sends (in the character set that the [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) property defines) to the character sets that the [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) property defines. + +## -property-value +True if the point-of-service printer can map the characters that the application sends to the code page used by the printer. If false, the user must make sure that the Unicode characters have the low byte as the value that will be used to send to the printer. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md), [PosPrinter.SupportedCharacterSets](posprinter_supportedcharactersets.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercapabilities_defaultcharacterset.md b/windows.devices.pointofservice/posprintercapabilities_defaultcharacterset.md index 94e427df15..ba284d1e14 100644 --- a/windows.devices.pointofservice/posprintercapabilities_defaultcharacterset.md +++ b/windows.devices.pointofservice/posprintercapabilities_defaultcharacterset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.DefaultCharacterSet --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.DefaultCharacterSet ## -description Gets the character set that the point-of-service printer uses by default. ## -property-value The character set that the point-of-service printer uses by default. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.DefaultCharacterSet +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.DefaultCharacterSet + +## -description +Gets the character set that the point-of-service printer uses by default. + +## -property-value +The character set that the point-of-service printer uses by default. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercapabilities_hascoversensor.md b/windows.devices.pointofservice/posprintercapabilities_hascoversensor.md index 1f4745e362..7f4ebb7e45 100644 --- a/windows.devices.pointofservice/posprintercapabilities_hascoversensor.md +++ b/windows.devices.pointofservice/posprintercapabilities_hascoversensor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.HasCoverSensor --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.HasCoverSensor ## -description Gets whether the point-of-service printer has a sensor that detects if the printer cover is open. ## -property-value True if the point-of-service printer has a sensor that detects if the printer cover is open; otherwise false. ## -remarks ## -examples ## -see-also [ICommonClaimedPosPrinterStation.IsCoverOpen](icommonclaimedposprinterstation_iscoveropen.md), [ClaimedPosPrinter.IsCoverOpen](claimedposprinter_iscoveropen.md), [ClaimedJournalPrinter.IsCoverOpen](claimedjournalprinter_iscoveropen.md), [ClaimedReceiptPrinter.IsCoverOpen](claimedreceiptprinter_iscoveropen.md), [ClaimedSlipPrinter.IsCoverOpen](claimedslipprinter_iscoveropen.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.HasCoverSensor +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.HasCoverSensor + +## -description +Gets whether the point-of-service printer has a sensor that detects if the printer cover is open. + +## -property-value +True if the point-of-service printer has a sensor that detects if the printer cover is open; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonClaimedPosPrinterStation.IsCoverOpen](icommonclaimedposprinterstation_iscoveropen.md), [ClaimedPosPrinter.IsCoverOpen](claimedposprinter_iscoveropen.md), [ClaimedJournalPrinter.IsCoverOpen](claimedjournalprinter_iscoveropen.md), [ClaimedReceiptPrinter.IsCoverOpen](claimedreceiptprinter_iscoveropen.md), [ClaimedSlipPrinter.IsCoverOpen](claimedslipprinter_iscoveropen.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercapabilities_isstatisticsreportingsupported.md b/windows.devices.pointofservice/posprintercapabilities_isstatisticsreportingsupported.md index 7150ccbd08..7d15915b3e 100644 --- a/windows.devices.pointofservice/posprintercapabilities_isstatisticsreportingsupported.md +++ b/windows.devices.pointofservice/posprintercapabilities_isstatisticsreportingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsReportingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsReportingSupported ## -description Gets whether the point-of-service printer supports reporting statistics. ## -property-value True if the point-of-service printer supports reporting statistics; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsReportingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsReportingSupported + +## -description +Gets whether the point-of-service printer supports reporting statistics. + +## -property-value +True if the point-of-service printer supports reporting statistics; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercapabilities_isstatisticsupdatingsupported.md b/windows.devices.pointofservice/posprintercapabilities_isstatisticsupdatingsupported.md index e6db7185cf..7d52bff4e8 100644 --- a/windows.devices.pointofservice/posprintercapabilities_isstatisticsupdatingsupported.md +++ b/windows.devices.pointofservice/posprintercapabilities_isstatisticsupdatingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsUpdatingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsUpdatingSupported ## -description Gets whether the point-of-service printer supports updating statistics. ## -property-value True if the point-of-service printer supports updating statistics; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsUpdatingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.IsStatisticsUpdatingSupported + +## -description +Gets whether the point-of-service printer supports updating statistics. + +## -property-value +True if the point-of-service printer supports updating statistics; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercapabilities_istransactionsupported.md b/windows.devices.pointofservice/posprintercapabilities_istransactionsupported.md index d1a22f99cb..15546d13cc 100644 --- a/windows.devices.pointofservice/posprintercapabilities_istransactionsupported.md +++ b/windows.devices.pointofservice/posprintercapabilities_istransactionsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.IsTransactionSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.IsTransactionSupported ## -description Gets whether the point-of-service printer supports printer transactions. ## -property-value True if the point-of-service printer supports printer transactions; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.IsTransactionSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.IsTransactionSupported + +## -description +Gets whether the point-of-service printer supports printer transactions. + +## -property-value +True if the point-of-service printer supports printer transactions; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercapabilities_journal.md b/windows.devices.pointofservice/posprintercapabilities_journal.md index 84ba6cefc5..72e46552c8 100644 --- a/windows.devices.pointofservice/posprintercapabilities_journal.md +++ b/windows.devices.pointofservice/posprintercapabilities_journal.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.Journal --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.Journal ## -description Gets the capabilities of the journal station for the point-of-service printer. The journal station is used for simple text messages that log transaction and activity information kept by the store for audit and other purposes. ## -property-value The capabilities of the journal station for the point-of-service printer. ## -remarks ## -examples ## -see-also [JournalPrinterCapabilities](journalprintercapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.Journal +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.Journal + +## -description +Gets the capabilities of the journal station for the point-of-service printer. + +The journal station is used for simple text messages that log transaction and activity information kept by the store for audit and other purposes. + +## -property-value +The capabilities of the journal station for the point-of-service printer. + +## -remarks + +## -examples + +## -see-also +[JournalPrinterCapabilities](journalprintercapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercapabilities_powerreportingtype.md b/windows.devices.pointofservice/posprintercapabilities_powerreportingtype.md index fb713f9d8c..d2482b3e06 100644 --- a/windows.devices.pointofservice/posprintercapabilities_powerreportingtype.md +++ b/windows.devices.pointofservice/posprintercapabilities_powerreportingtype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.PowerReportingType --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.PowerReportingType ## -description Gets the power reporting capabilities of the point-of-service printer. ## -property-value The power reporting capabilities of the point-of-service printer, such as whether the printer can determine and report two or three different power states. ## -remarks ## -examples ## -see-also [UnifiedPosPowerReportingType](unifiedpospowerreportingtype.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.PowerReportingType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.PowerReportingType + +## -description +Gets the power reporting capabilities of the point-of-service printer. + +## -property-value +The power reporting capabilities of the point-of-service printer, such as whether the printer can determine and report two or three different power states. + +## -remarks + +## -examples + +## -see-also +[UnifiedPosPowerReportingType](unifiedpospowerreportingtype.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercapabilities_receipt.md b/windows.devices.pointofservice/posprintercapabilities_receipt.md index 92e8effa0b..ca7e3ef1e6 100644 --- a/windows.devices.pointofservice/posprintercapabilities_receipt.md +++ b/windows.devices.pointofservice/posprintercapabilities_receipt.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.Receipt --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.Receipt ## -description Gets the capabilities of the receipt station for the point-of-service printer. The receipt station is used to print transaction information that is typically given to the customer, or for store reports. Receipt contains either a knife to automatically cut the paper between transactions, or a tear bar to manually cut the paper. ## -property-value The capabilities of the receipt station for the point-of-service printer. ## -remarks ## -examples ## -see-also [ReceiptPrinterCapabilities](receiptprintercapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.Receipt +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.Receipt + +## -description +Gets the capabilities of the receipt station for the point-of-service printer. + +The receipt station is used to print transaction information that is typically given to the customer, or for store reports. Receipt contains either a knife to automatically cut the paper between transactions, or a tear bar to manually cut the paper. + +## -property-value +The capabilities of the receipt station for the point-of-service printer. + +## -remarks + +## -examples + +## -see-also +[ReceiptPrinterCapabilities](receiptprintercapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercapabilities_slip.md b/windows.devices.pointofservice/posprintercapabilities_slip.md index 862a1d4eaa..5e7e326b76 100644 --- a/windows.devices.pointofservice/posprintercapabilities_slip.md +++ b/windows.devices.pointofservice/posprintercapabilities_slip.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.Slip --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCapabilities.Slip ## -description Gets the capabilities of the slip station for the point-of-service printer. The slip station is used to print information on a form that is typically given to the customer, or to print validation information on a form. The form type is usually a check or credit card slip. ## -property-value The capabilities of the slip station for the point-of-service printer. ## -remarks ## -examples ## -see-also [SlipPrinterCapabilities](slipprintercapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCapabilities.Slip +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCapabilities.Slip + +## -description +Gets the capabilities of the slip station for the point-of-service printer. + +The slip station is used to print information on a form that is typically given to the customer, or to print validation information on a form. The form type is usually a check or credit card slip. + +## -property-value +The capabilities of the slip station for the point-of-service printer. + +## -remarks + +## -examples + +## -see-also +[SlipPrinterCapabilities](slipprintercapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprintercharactersetids.md b/windows.devices.pointofservice/posprintercharactersetids.md index ac45878163..8d070c63b2 100644 --- a/windows.devices.pointofservice/posprintercharactersetids.md +++ b/windows.devices.pointofservice/posprintercharactersetids.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.PosPrinterCharacterSetIds --api-type: winrt class ---- # Windows.Devices.PointOfService.PosPrinterCharacterSetIds ## -description Represents the set of identifiers for the character sets that a point-of-service printer can use. ## -remarks This class consists entirely of static members, so you do not need to create an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.PosPrinterCharacterSetIds +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.PosPrinterCharacterSetIds + +## -description +Represents the set of identifiers for the character sets that a point-of-service printer can use. + +## -remarks +This class consists entirely of static members, so you do not need to create an instance of this class. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercharactersetids_ansi.md b/windows.devices.pointofservice/posprintercharactersetids_ansi.md index dc8da10d7d..c0b8f961c4 100644 --- a/windows.devices.pointofservice/posprintercharactersetids_ansi.md +++ b/windows.devices.pointofservice/posprintercharactersetids_ansi.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ansi --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ansi ## -description Gets the identifier for the ANSI character set. ## -property-value The identifier for the ANSI character set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ansi +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ansi + +## -description +Gets the identifier for the ANSI character set. + +## -property-value +The identifier for the ANSI character set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercharactersetids_ascii.md b/windows.devices.pointofservice/posprintercharactersetids_ascii.md index 0ca369bc85..4a505904f3 100644 --- a/windows.devices.pointofservice/posprintercharactersetids_ascii.md +++ b/windows.devices.pointofservice/posprintercharactersetids_ascii.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ascii --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ascii ## -description Gets the identifier for the ASCII character set. ## -property-value The identifier for the ASCII character set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ascii +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Ascii + +## -description +Gets the identifier for the ASCII character set. + +## -property-value +The identifier for the ASCII character set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprintercharactersetids_utf16le.md b/windows.devices.pointofservice/posprintercharactersetids_utf16le.md index 25d33110ad..b71d508a73 100644 --- a/windows.devices.pointofservice/posprintercharactersetids_utf16le.md +++ b/windows.devices.pointofservice/posprintercharactersetids_utf16le.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Utf16LE --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Utf16LE ## -description Gets the identifier for the UTF16LE character set. ## -property-value The identifier for the UTF16LE character set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Utf16LE +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterCharacterSetIds.Utf16LE + +## -description +Gets the identifier for the UTF16LE character set. + +## -property-value +The identifier for the UTF16LE character set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinterreleasedevicerequestedeventargs.md b/windows.devices.pointofservice/posprinterreleasedevicerequestedeventargs.md index 52dec4f181..faf8d89d21 100644 --- a/windows.devices.pointofservice/posprinterreleasedevicerequestedeventargs.md +++ b/windows.devices.pointofservice/posprinterreleasedevicerequestedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.PosPrinterReleaseDeviceRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.PosPrinterReleaseDeviceRequestedEventArgs ## -description Provides information about the [ClaimedPosPrinter.ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) event that occurs when a point-of-service printer gets a request to release its exclusive claim. ## -remarks An instance of this class is passed to the event handler that you create for the [ClaimedPosPrinter.ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) event. ## -examples ## -see-also [ClaimedPosPrinter.ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.PosPrinterReleaseDeviceRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.PosPrinterReleaseDeviceRequestedEventArgs + +## -description +Provides information about the [ClaimedPosPrinter.ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) event that occurs when a point-of-service printer gets a request to release its exclusive claim. + +## -remarks +An instance of this class is passed to the event handler that you create for the [ClaimedPosPrinter.ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) event. + +## -examples + +## -see-also +[ClaimedPosPrinter.ReleaseDeviceRequested](claimedposprinter_releasedevicerequested.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinterstatus.md b/windows.devices.pointofservice/posprinterstatus.md index 72b5fb44a7..5ff8c13e26 100644 --- a/windows.devices.pointofservice/posprinterstatus.md +++ b/windows.devices.pointofservice/posprinterstatus.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.PointOfService.PosPrinterStatus --api-type: winrt class ---- # Windows.Devices.PointOfService.PosPrinterStatus ## -description Provides information about the status of a point-of-service printer, such as the power state of the printer. ## -remarks You can get the [PosPrinterStatus](posprinterstatus.md) either by using the [PosPrinter.Status](posprinter_status.md) or [PosPrinterStatusUpdatedEventArgs.Status](posprinterstatusupdatedeventargs_status.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.PosPrinterStatus +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.PosPrinterStatus + +## -description +Provides information about the status of a point-of-service printer, such as the power state of the printer. + +## -remarks +You can get the [PosPrinterStatus](posprinterstatus.md) either by using the [PosPrinter.Status](posprinter_status.md) or [PosPrinterStatusUpdatedEventArgs.Status](posprinterstatusupdatedeventargs_status.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/posprinterstatus_extendedstatus.md b/windows.devices.pointofservice/posprinterstatus_extendedstatus.md index 30ea162c59..0ae7b0f83d 100644 --- a/windows.devices.pointofservice/posprinterstatus_extendedstatus.md +++ b/windows.devices.pointofservice/posprinterstatus_extendedstatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterStatus.ExtendedStatus --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterStatus.ExtendedStatus ## -description Gets extended information about the power state of the point-of-service printer that the original equipment manufacturer (OEM) defines. Value is only valid if the [PosPrinterStatus.StatusKind](posprinterstatus_statuskind.md) property is **PosPrinterStatusKind.Extended**. ## -property-value An OEM-defined value that provides extended information about the power state of the point-of-service printer when the value of the [PosPrinterStatus.StatusKind](posprinterstatus_statuskind.md) property is **PosPrinterStatusKind.Extended**. ## -remarks ## -examples ## -see-also [PosPrinterStatus.StatusKind](posprinterstatus_statuskind.md), [PosPrinterStatusKind](posprinterstatuskind.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterStatus.ExtendedStatus +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterStatus.ExtendedStatus + +## -description +Gets extended information about the power state of the point-of-service printer that the original equipment manufacturer (OEM) defines. Value is only valid if the [PosPrinterStatus.StatusKind](posprinterstatus_statuskind.md) property is **PosPrinterStatusKind.Extended**. + +## -property-value +An OEM-defined value that provides extended information about the power state of the point-of-service printer when the value of the [PosPrinterStatus.StatusKind](posprinterstatus_statuskind.md) property is **PosPrinterStatusKind.Extended**. + +## -remarks + +## -examples + +## -see-also +[PosPrinterStatus.StatusKind](posprinterstatus_statuskind.md), [PosPrinterStatusKind](posprinterstatuskind.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinterstatus_statuskind.md b/windows.devices.pointofservice/posprinterstatus_statuskind.md index 72bc828d41..edd406b777 100644 --- a/windows.devices.pointofservice/posprinterstatus_statuskind.md +++ b/windows.devices.pointofservice/posprinterstatus_statuskind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterStatus.StatusKind --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterStatus.StatusKind ## -description Gets the power state of a point-of-service printer. ## -property-value The power state of a point-of-service printer. ## -remarks ## -examples ## -see-also [PosPrinterStatusKind](posprinterstatuskind.md), [PosPrinterStatus.ExtendedStatus](posprinterstatus_extendedstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterStatus.StatusKind +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterStatus.StatusKind + +## -description +Gets the power state of a point-of-service printer. + +## -property-value +The power state of a point-of-service printer. + +## -remarks + +## -examples + +## -see-also +[PosPrinterStatusKind](posprinterstatuskind.md), [PosPrinterStatus.ExtendedStatus](posprinterstatus_extendedstatus.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinterstatusupdatedeventargs.md b/windows.devices.pointofservice/posprinterstatusupdatedeventargs.md index 69c6219efe..6ab3fb51e6 100644 --- a/windows.devices.pointofservice/posprinterstatusupdatedeventargs.md +++ b/windows.devices.pointofservice/posprinterstatusupdatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs --api-type: winrt class ---- # Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs ## -description Provides information about the [PosPrinter.StatusUpdated](posprinter_statusupdated.md) event that occurs when the status of a point-of-service printer changes. ## -remarks An instance of this class is passed to the event handler that you create for the [PosPrinter.StatusUpdated](posprinter_statusupdated.md) event. ## -examples ## -see-also [PosPrinter.StatusUpdated](posprinter_statusupdated.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs + +## -description +Provides information about the [PosPrinter.StatusUpdated](posprinter_statusupdated.md) event that occurs when the status of a point-of-service printer changes. + +## -remarks +An instance of this class is passed to the event handler that you create for the [PosPrinter.StatusUpdated](posprinter_statusupdated.md) event. + +## -examples + +## -see-also +[PosPrinter.StatusUpdated](posprinter_statusupdated.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/posprinterstatusupdatedeventargs_status.md b/windows.devices.pointofservice/posprinterstatusupdatedeventargs_status.md index 905e566bf2..78eada41ed 100644 --- a/windows.devices.pointofservice/posprinterstatusupdatedeventargs_status.md +++ b/windows.devices.pointofservice/posprinterstatusupdatedeventargs_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs.Status ## -description Gets the new status of the point-of-service printer after the status of the printer changes. ## -property-value The new status of the point-of-service printer after the status of the printer changes. ## -remarks ## -examples ## -see-also [PosPrinterStatus](posprinterstatus.md), [PosPrinter.StatusUpdated](posprinter_statusupdated.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.PosPrinterStatusUpdatedEventArgs.Status + +## -description +Gets the new status of the point-of-service printer after the status of the printer changes. + +## -property-value +The new status of the point-of-service printer after the status of the printer changes. + +## -remarks + +## -examples + +## -see-also +[PosPrinterStatus](posprinterstatus.md), [PosPrinter.StatusUpdated](posprinter_statusupdated.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities.md b/windows.devices.pointofservice/receiptprintercapabilities.md index a7a0f81a79..f78d42d620 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities.md +++ b/windows.devices.pointofservice/receiptprintercapabilities.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ReceiptPrinterCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities ## -description Represents the capabilities of receipt station of a point-of-service printer. ## -remarks To get the capabilities of the receipt station of a point-of-service printer, use [PosPrinterCapabilities.Receipt](posprintercapabilities_receipt.md). ## -examples ## -see-also [ICommonReceiptSlipCapabilities](icommonreceiptslipcapabilities.md), [ICommonPosPrintStationCapabilities](icommonposprintstationcapabilities.md), [PosPrinterCapabilities.Receipt](posprintercapabilities_receipt.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ReceiptPrinterCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities + +## -description +Represents the capabilities of receipt station of a point-of-service printer. + +## -remarks +To get the capabilities of the receipt station of a point-of-service printer, use [PosPrinterCapabilities.Receipt](posprintercapabilities_receipt.md). + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities](icommonreceiptslipcapabilities.md), [ICommonPosPrintStationCapabilities](icommonposprintstationcapabilities.md), [PosPrinterCapabilities.Receipt](posprintercapabilities_receipt.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_cancutpaper.md b/windows.devices.pointofservice/receiptprintercapabilities_cancutpaper.md index 543199b595..b90870ba0c 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_cancutpaper.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_cancutpaper.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CanCutPaper --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CanCutPaper ## -description Gets whether the receipt printer station can perform paper cuts. ## -property-value True if the receipt printer station can perform paper cuts; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CanCutPaper +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CanCutPaper + +## -description +Gets whether the receipt printer station can perform paper cuts. + +## -property-value +True if the receipt printer station can perform paper cuts; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/receiptprintercapabilities_cartridgesensors.md b/windows.devices.pointofservice/receiptprintercapabilities_cartridgesensors.md index 39e5922f6b..9f329db690 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_cartridgesensors.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_cartridgesensors.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CartridgeSensors --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CartridgeSensors ## -description Gets information about the sensors that the receipt printer station has available to report the status of the printer station. ## -property-value A combination of enumeration values that indicate the sensors that the receipt printer station has available to report the status of the printer station. ## -remarks ## -examples ## -see-also [PosPrinterCartridgeSensors](posprintercartridgesensors.md), [ICommonPosPrintStationCapabilities.CartridgeSensors](icommonposprintstationcapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CartridgeSensors +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.CartridgeSensors + +## -description +Gets information about the sensors that the receipt printer station has available to report the status of the printer station. + +## -property-value +A combination of enumeration values that indicate the sensors that the receipt printer station has available to report the status of the printer station. + +## -remarks + +## -examples + +## -see-also +[PosPrinterCartridgeSensors](posprintercartridgesensors.md), [ICommonPosPrintStationCapabilities.CartridgeSensors](icommonposprintstationcapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_colorcartridgecapabilities.md b/windows.devices.pointofservice/receiptprintercapabilities_colorcartridgecapabilities.md index 29f0be44a4..90cc1df547 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_colorcartridgecapabilities.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_colorcartridgecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.ColorCartridgeCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.ColorCartridgeCapabilities ## -description Gets the color cartridges that the receipt printer station can use to print in color. ## -property-value A combination of enumeration values that indicates which color cartridges the receipt printer station can use to print in color. ## -remarks ## -examples ## -see-also [PosPrinterColorCapabilities](posprintercolorcapabilities.md), [ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities](icommonposprintstationcapabilities_colorcartridgecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.ColorCartridgeCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.ColorCartridgeCapabilities + +## -description +Gets the color cartridges that the receipt printer station can use to print in color. + +## -property-value +A combination of enumeration values that indicates which color cartridges the receipt printer station can use to print in color. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCapabilities](posprintercolorcapabilities.md), [ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities](icommonposprintstationcapabilities_colorcartridgecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_is180rotationsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_is180rotationsupported.md index 8e6737dc43..9cc136ec41 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_is180rotationsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_is180rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.Is180RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.Is180RotationSupported ## -description Gets whether the receipt printer station can print in a rotated upside-down mode. ## -property-value True if the receipt printer station can print in a rotated upside-down mode; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.Is180RotationSupported](icommonreceiptslipcapabilities_is180rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.Is180RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.Is180RotationSupported + +## -description +Gets whether the receipt printer station can print in a rotated upside-down mode. + +## -property-value +True if the receipt printer station can print in a rotated upside-down mode; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.Is180RotationSupported](icommonreceiptslipcapabilities_is180rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isbarcodesupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isbarcodesupported.md index 646a6fff94..63bee3b35a 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isbarcodesupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isbarcodesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBarcodeSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBarcodeSupported ## -description Gets whether the receipt printer station can print barcodes. ## -property-value True if the receipt printer station can print barcodes; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsBarcodeSupported](icommonreceiptslipcapabilities_isbarcodesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBarcodeSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBarcodeSupported + +## -description +Gets whether the receipt printer station can print barcodes. + +## -property-value +True if the receipt printer station can print barcodes; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsBarcodeSupported](icommonreceiptslipcapabilities_isbarcodesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isbitmapsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isbitmapsupported.md index 29314466da..59a8679c7f 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isbitmapsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isbitmapsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBitmapSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBitmapSupported ## -description Gets whether the receipt printer station can print bitmaps. ## -property-value True if the receipt printer station can print bitmaps; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsBitmapSupported](icommonreceiptslipcapabilities_isbitmapsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBitmapSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBitmapSupported + +## -description +Gets whether the receipt printer station can print bitmaps. + +## -property-value +True if the receipt printer station can print bitmaps; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsBitmapSupported](icommonreceiptslipcapabilities_isbitmapsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isboldsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isboldsupported.md index c14204019a..c4a2852dd7 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isboldsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isboldsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBoldSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBoldSupported ## -description Gets whether the receipt printer station can print bold characters. ## -property-value True if the receipt printer station can print bold characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsBoldSupported](icommonposprintstationcapabilities_isboldsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBoldSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsBoldSupported + +## -description +Gets whether the receipt printer station can print bold characters. + +## -property-value +True if the receipt printer station can print bold characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsBoldSupported](icommonposprintstationcapabilities_isboldsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighdoublewideprintsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighdoublewideprintsupported.md index eeb9702af4..ece202d249 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighdoublewideprintsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported ## -description Gets whether the receipt printer station can print characters that are both double-high and double-wide. ## -property-value True if the receipt printer station can print characters that are both double-high and double-wide; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported + +## -description +Gets whether the receipt printer station can print characters that are both double-high and double-wide. + +## -property-value +True if the receipt printer station can print characters that are both double-high and double-wide; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighprintsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighprintsupported.md index b30fb92336..52bc5dc192 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighprintsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isdoublehighprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighPrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighPrintSupported ## -description Gets whether the receipt printer station can print double-high characters. ## -property-value True if the receipt printer station can print double-high characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported](icommonposprintstationcapabilities_isdoublehighprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighPrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleHighPrintSupported + +## -description +Gets whether the receipt printer station can print double-high characters. + +## -property-value +True if the receipt printer station can print double-high characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported](icommonposprintstationcapabilities_isdoublehighprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isdoublewideprintsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isdoublewideprintsupported.md index 7722921e37..2789340562 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isdoublewideprintsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleWidePrintSupported ## -description Gets whether the receipt printer station can print double-wide characters. ## -property-value True if the receipt printer station can print double-wide characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDoubleWidePrintSupported + +## -description +Gets whether the receipt printer station can print double-wide characters. + +## -property-value +True if the receipt printer station can print double-wide characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isdualcolorsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isdualcolorsupported.md index 8a0ee20ab9..aa72b2b342 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isdualcolorsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isdualcolorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDualColorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDualColorSupported ## -description Gets whether the receipt printer station can print a dark color plus an alternate color. ## -property-value True if the receipt printer station can print a dark color plus an alternate color; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDualColorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsDualColorSupported + +## -description +Gets whether the receipt printer station can print a dark color plus an alternate color. + +## -property-value +True if the receipt printer station can print a dark color plus an alternate color; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isitalicsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isitalicsupported.md index 7bf7fff896..b9d7152df7 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isitalicsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isitalicsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsItalicSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsItalicSupported ## -description Gets whether the receipt printer station can print italic characters. ## -property-value True if the receipt printer station can print italic characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsItalicSupported](icommonposprintstationcapabilities_isitalicsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsItalicSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsItalicSupported + +## -description +Gets whether the receipt printer station can print italic characters. + +## -property-value +True if the receipt printer station can print italic characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsItalicSupported](icommonposprintstationcapabilities_isitalicsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isleft90rotationsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isleft90rotationsupported.md index ac6a549fa8..ad10ffe27f 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isleft90rotationsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isleft90rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsLeft90RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsLeft90RotationSupported ## -description Gets whether the receipt printer station can print information rotated 90 degrees to the left. ## -property-value True if the receipt printer station can print information rotated 90 degrees to the left; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsLeft90RotationSupported](icommonreceiptslipcapabilities_isleft90rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsLeft90RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsLeft90RotationSupported + +## -description +Gets whether the receipt printer station can print information rotated 90 degrees to the left. + +## -property-value +True if the receipt printer station can print information rotated 90 degrees to the left; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsLeft90RotationSupported](icommonreceiptslipcapabilities_isleft90rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_ispaperemptysensorsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_ispaperemptysensorsupported.md index 871dcb7a2b..c77db6812d 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_ispaperemptysensorsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_ispaperemptysensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperEmptySensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperEmptySensorSupported ## -description Gets whether the receipt printer station has an out-of-paper sensor. ## -property-value True if the receipt printer station has an out-of-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported](icommonposprintstationcapabilities_ispaperemptysensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperEmptySensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperEmptySensorSupported + +## -description +Gets whether the receipt printer station has an out-of-paper sensor. + +## -property-value +True if the receipt printer station has an out-of-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported](icommonposprintstationcapabilities_ispaperemptysensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_ispapernearendsensorsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_ispapernearendsensorsupported.md index abc75406ed..5b8edd7074 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_ispapernearendsensorsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_ispapernearendsensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported ## -description Gets whether the receipt printer station has a low-paper sensor. ## -property-value True if the receipt printer station has a low-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported](icommonposprintstationcapabilities_ispapernearendsensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPaperNearEndSensorSupported + +## -description +Gets whether the receipt printer station has a low-paper sensor. + +## -property-value +True if the receipt printer station has a low-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported](icommonposprintstationcapabilities_ispapernearendsensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isprintareasupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isprintareasupported.md index f08bbd70ed..406119b589 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isprintareasupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isprintareasupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrintAreaSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrintAreaSupported ## -description Gets whether the receipt printer station supports setting a custom size for the area of the page on which the printer should print. ## -property-value True if the receipt printer station supports setting a custom size for the area of the page on which the printer should print; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsPrintAreaSupported](icommonreceiptslipcapabilities_isprintareasupported.md), [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrintAreaSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrintAreaSupported + +## -description +Gets whether the receipt printer station supports setting a custom size for the area of the page on which the printer should print. + +## -property-value +True if the receipt printer station supports setting a custom size for the area of the page on which the printer should print; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsPrintAreaSupported](icommonreceiptslipcapabilities_isprintareasupported.md), [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isprinterpresent.md b/windows.devices.pointofservice/receiptprintercapabilities_isprinterpresent.md index 3fb9228766..2cdb4d4115 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isprinterpresent.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isprinterpresent.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrinterPresent --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrinterPresent ## -description Gets whether a point-of-service printer with a station that prints receipts is present. ## -property-value True if a point-of-service printer with a station that prints receipts is present; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPrinterPresent](icommonposprintstationcapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrinterPresent +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsPrinterPresent + +## -description +Gets whether a point-of-service printer with a station that prints receipts is present. + +## -property-value +True if a point-of-service printer with a station that prints receipts is present; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPrinterPresent](icommonposprintstationcapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isright90rotationsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isright90rotationsupported.md index a4709fe692..5e40646fe9 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isright90rotationsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isright90rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsRight90RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsRight90RotationSupported ## -description Gets whether the receipt printer station can print information rotated 90 degrees to the right. ## -property-value True if the receipt printer station can print information rotated 90 degrees to the right; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsRight90RotationSupported](icommonreceiptslipcapabilities_isright90rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsRight90RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsRight90RotationSupported + +## -description +Gets whether the receipt printer station can print information rotated 90 degrees to the right. + +## -property-value +True if the receipt printer station can print information rotated 90 degrees to the right; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsRight90RotationSupported](icommonreceiptslipcapabilities_isright90rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isstampsupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isstampsupported.md index 3965b0a11b..098068f47d 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isstampsupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isstampsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsStampSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsStampSupported ## -description Gets whether the receipt printer station has a stamp capability. ## -property-value True if the receipt printer station has a stamp capability; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsStampSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsStampSupported + +## -description +Gets whether the receipt printer station has a stamp capability. + +## -property-value +True if the receipt printer station has a stamp capability; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/receiptprintercapabilities_isunderlinesupported.md b/windows.devices.pointofservice/receiptprintercapabilities_isunderlinesupported.md index 89a9e22242..3352010490 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_isunderlinesupported.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_isunderlinesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsUnderlineSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsUnderlineSupported ## -description Gets whether the receipt printer station can underline characters. ## -property-value True if the receipt printer station can underline characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsUnderlineSupported](icommonposprintstationcapabilities_isunderlinesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsUnderlineSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.IsUnderlineSupported + +## -description +Gets whether the receipt printer station can underline characters. + +## -property-value +True if the receipt printer station can underline characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsUnderlineSupported](icommonposprintstationcapabilities_isunderlinesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_markfeedcapabilities.md b/windows.devices.pointofservice/receiptprintercapabilities_markfeedcapabilities.md index c3694ea90b..35843bd0d6 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_markfeedcapabilities.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_markfeedcapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.MarkFeedCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.MarkFeedCapabilities ## -description Gets the type of mark-sensed paper handling that is available for the receipt printer station. ## -property-value A logical OR combination of values that indicate the type of mark-sensed paper handling that is available for the receipt printer station. ## -remarks ## -examples ## -see-also [PosPrinterMarkFeedCapabilities](posprintermarkfeedcapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.MarkFeedCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.MarkFeedCapabilities + +## -description +Gets the type of mark-sensed paper handling that is available for the receipt printer station. + +## -property-value +A logical OR combination of values that indicate the type of mark-sensed paper handling that is available for the receipt printer station. + +## -remarks + +## -examples + +## -see-also +[PosPrinterMarkFeedCapabilities](posprintermarkfeedcapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_ruledlinecapabilities.md b/windows.devices.pointofservice/receiptprintercapabilities_ruledlinecapabilities.md index 3f4b019857..cc1ccfe249 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_ruledlinecapabilities.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_ruledlinecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.RuledLineCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.RuledLineCapabilities ## -description Gets information about the capabilities of the receipt printer station to draw ruled lines. ## -property-value Information about the capabilities of the receipt printer station to draw ruled lines. ## -remarks ## -examples ## -see-also [PosPrinterRuledLineCapabilities](posprinterruledlinecapabilities.md), [ICommonReceiptSlipCapabilities.RuledLineCapabilities](icommonreceiptslipcapabilities_ruledlinecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.RuledLineCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.RuledLineCapabilities + +## -description +Gets information about the capabilities of the receipt printer station to draw ruled lines. + +## -property-value +Information about the capabilities of the receipt printer station to draw ruled lines. + +## -remarks + +## -examples + +## -see-also +[PosPrinterRuledLineCapabilities](posprinterruledlinecapabilities.md), [ICommonReceiptSlipCapabilities.RuledLineCapabilities](icommonreceiptslipcapabilities_ruledlinecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_supportedbarcoderotations.md b/windows.devices.pointofservice/receiptprintercapabilities_supportedbarcoderotations.md index 8da509be3d..abe74b94d1 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_supportedbarcoderotations.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_supportedbarcoderotations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBarcodeRotations --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBarcodeRotations ## -description Gets a list of the directions in which the receipt printer station can rotate a barcode when printing. ## -property-value A list of the directions in which the receipt printer station can rotate a barcode when printing. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.SupportedBarcodeRotations](icommonreceiptslipcapabilities_supportedbarcoderotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBarcodeRotations +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBarcodeRotations + +## -description +Gets a list of the directions in which the receipt printer station can rotate a barcode when printing. + +## -property-value +A list of the directions in which the receipt printer station can rotate a barcode when printing. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.SupportedBarcodeRotations](icommonreceiptslipcapabilities_supportedbarcoderotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_supportedbitmaprotations.md b/windows.devices.pointofservice/receiptprintercapabilities_supportedbitmaprotations.md index be0dca197b..59219364dd 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_supportedbitmaprotations.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_supportedbitmaprotations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBitmapRotations --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBitmapRotations ## -description Gets a list of the directions in which the receipt printer station can rotate a bitmap when printing. ## -property-value A list of the directions in which the receipt printer station can rotate a bitmap when printing. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.SupportedBitmapRotations](icommonreceiptslipcapabilities_supportedbitmaprotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBitmapRotations +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedBitmapRotations + +## -description +Gets a list of the directions in which the receipt printer station can rotate a bitmap when printing. + +## -property-value +A list of the directions in which the receipt printer station can rotate a bitmap when printing. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.SupportedBitmapRotations](icommonreceiptslipcapabilities_supportedbitmaprotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintercapabilities_supportedcharactersperline.md b/windows.devices.pointofservice/receiptprintercapabilities_supportedcharactersperline.md index ada412ba76..631113c640 100644 --- a/windows.devices.pointofservice/receiptprintercapabilities_supportedcharactersperline.md +++ b/windows.devices.pointofservice/receiptprintercapabilities_supportedcharactersperline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedCharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedCharactersPerLine ## -description Gets a collection of the line widths in characters per line that the receipt printer station supports. ## -property-value A collection of the line widths in characters per line that the receipt printer station supports. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.SupportedCharactersPerLine](icommonposprintstationcapabilities_supportedcharactersperline.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedCharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ReceiptPrinterCapabilities.SupportedCharactersPerLine + +## -description +Gets a collection of the line widths in characters per line that the receipt printer station supports. + +## -property-value +A collection of the line widths in characters per line that the receipt printer station supports. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.SupportedCharactersPerLine](icommonposprintstationcapabilities_supportedcharactersperline.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob.md b/windows.devices.pointofservice/receiptprintjob.md index 371dc89135..a18e426e2b 100644 --- a/windows.devices.pointofservice/receiptprintjob.md +++ b/windows.devices.pointofservice/receiptprintjob.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.ReceiptPrintJob --api-type: winrt class ---- # Windows.Devices.PointOfService.ReceiptPrintJob ## -description Represents a set of printing instructions that you want to run on the receipt printer. ## -remarks To create a new print job for the receipt printer, call [ClaimedReceiptPrinter.CreateJob](claimedreceiptprinter_createjob.md). ## -examples ## -see-also [IReceiptOrSlipJob](ireceiptorslipjob.md), [IPosPrinterJob](iposprinterjob.md), [ClaimedReceiptPrinter.CreateJob](claimedreceiptprinter_createjob.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.ReceiptPrintJob +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob + +## -description +Represents a set of printing instructions that you want to run on the receipt printer. + +## -remarks +To create a new print job for the receipt printer, call [ClaimedReceiptPrinter.CreateJob](claimedreceiptprinter_createjob.md). + +## -examples + +## -see-also +[IReceiptOrSlipJob](ireceiptorslipjob.md), [IPosPrinterJob](iposprinterjob.md), [ClaimedReceiptPrinter.CreateJob](claimedreceiptprinter_createjob.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_cutpaper_1725234121.md b/windows.devices.pointofservice/receiptprintjob_cutpaper_1725234121.md index 8b199e02cd..bc54451034 100644 --- a/windows.devices.pointofservice/receiptprintjob_cutpaper_1725234121.md +++ b/windows.devices.pointofservice/receiptprintjob_cutpaper_1725234121.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper ## -description Adds an instruction to the printer job to cut the receipt paper completely. ## -remarks ## -examples ## -see-also [CutPaper(Double)](receiptprintjob_cutpaper_1744897979.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper + +## -description +Adds an instruction to the printer job to cut the receipt paper completely. + +## -remarks + +## -examples + +## -see-also +[CutPaper(Double)](receiptprintjob_cutpaper_1744897979.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_cutpaper_1744897979.md b/windows.devices.pointofservice/receiptprintjob_cutpaper_1744897979.md index e2d04bbe1c..5f6583f29e 100644 --- a/windows.devices.pointofservice/receiptprintjob_cutpaper_1744897979.md +++ b/windows.devices.pointofservice/receiptprintjob_cutpaper_1744897979.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper(System.Double) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper ## -description Adds an instruction to the printer job to cut the specified percentage of the receipt paper. ## -parameters ### -param percentage Decimal representation of the percentage of the receipt that the receipt printer should cut. Many printers with paper cutting capability can perform both full and partial cuts. Some offer gradations of partial cuts, such as a perforated cut and an almost-full cut. Use the following general guidelines:
ValueMeaning
100Fully cuts the paper.
90Leaves only a small part of paper for very easy final separation.
70Perforates the paper for final separation that is somewhat more difficult and unlikely to occur by accidental handling.
50Partial perforation of the paper.
Printer capabilities vary, so the actual result can be device-dependent. ## -remarks ## -examples ## -see-also [CutPaper()](receiptprintjob_cutpaper_1725234121.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper(System.Double) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.CutPaper + +## -description +Adds an instruction to the printer job to cut the specified percentage of the receipt paper. + +## -parameters +### -param percentage +Decimal representation of the percentage of the receipt that the receipt printer should cut. + +Many printers with paper cutting capability can perform both full and partial cuts. Some offer gradations of partial cuts, such as a perforated cut and an almost-full cut. Use the following general guidelines: + + + + + + + +
ValueMeaning
100Fully cuts the paper.
90Leaves only a small part of paper for very easy final separation.
70Perforates the paper for final separation that is somewhat more difficult and unlikely to occur by accidental handling.
50Partial perforation of the paper.
+ +Printer capabilities vary, so the actual result can be device-dependent. + +## -remarks + +## -examples + +## -see-also +[CutPaper()](receiptprintjob_cutpaper_1725234121.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_drawruledline_1309666666.md b/windows.devices.pointofservice/receiptprintjob_drawruledline_1309666666.md index a43a7ad6bb..6be77ab802 100644 --- a/windows.devices.pointofservice/receiptprintjob_drawruledline_1309666666.md +++ b/windows.devices.pointofservice/receiptprintjob_drawruledline_1309666666.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.DrawRuledLine(System.String,Windows.Devices.PointOfService.PosPrinterLineDirection,System.UInt32,Windows.Devices.PointOfService.PosPrinterLineStyle,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.DrawRuledLine ## -description Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt printer station. ## -parameters ### -param positionList The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. ### -param lineDirection The direction in which to print the ruled line. ### -param lineWidth The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used. ### -param lineStyle The appearance of the ruled line, such as whether it is solid or broken, or single or double. ### -param lineColor The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.DrawRuledLine](ireceiptorslipjob_drawruledline.md), [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md), [PosPrinterLineDirection](posprinterlinedirection.md), [PosPrinterLineStyle](posprinterlinestyle.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.DrawRuledLine(System.String,Windows.Devices.PointOfService.PosPrinterLineDirection,System.UInt32,Windows.Devices.PointOfService.PosPrinterLineStyle,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.DrawRuledLine + +## -description +Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt printer station. + +## -parameters +### -param positionList +The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. + +### -param lineDirection +The direction in which to print the ruled line. + +### -param lineWidth +The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used. + +### -param lineStyle +The appearance of the ruled line, such as whether it is solid or broken, or single or double. + +### -param lineColor +The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.DrawRuledLine](ireceiptorslipjob_drawruledline.md), [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md), [PosPrinterLineDirection](posprinterlinedirection.md), [PosPrinterLineStyle](posprinterlinestyle.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_executeasync_2108924004.md b/windows.devices.pointofservice/receiptprintjob_executeasync_2108924004.md index 190e41d904..c0a07b0f44 100644 --- a/windows.devices.pointofservice/receiptprintjob_executeasync_2108924004.md +++ b/windows.devices.pointofservice/receiptprintjob_executeasync_2108924004.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.ExecuteAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.ExecuteAsync ## -description Runs the print job on the receipt printer station asynchronously. ## -returns The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. ## -remarks ## -examples ## -see-also [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.ExecuteAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.ExecuteAsync + +## -description +Runs the print job on the receipt printer station asynchronously. + +## -returns +The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. + +## -remarks + +## -examples + +## -see-also +[IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_markfeed_40048292.md b/windows.devices.pointofservice/receiptprintjob_markfeed_40048292.md index 241245a813..577f563ae0 100644 --- a/windows.devices.pointofservice/receiptprintjob_markfeed_40048292.md +++ b/windows.devices.pointofservice/receiptprintjob_markfeed_40048292.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.MarkFeed(Windows.Devices.PointOfService.PosPrinterMarkFeedKind) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.MarkFeed ## -description Adds an instruction to the printer job to use the mark sensor of the receipt printer station to position the receipt paper. ## -parameters ### -param kind An enumeration value that specifies how to position the receipt paper. ## -remarks ## -examples ## -see-also [PosPrinterMarkFeedKind](posprintermarkfeedkind.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.MarkFeed(Windows.Devices.PointOfService.PosPrinterMarkFeedKind) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.MarkFeed + +## -description +Adds an instruction to the printer job to use the mark sensor of the receipt printer station to position the receipt paper. + +## -parameters +### -param kind +An enumeration value that specifies how to position the receipt paper. + +## -remarks + +## -examples + +## -see-also +[PosPrinterMarkFeedKind](posprintermarkfeedkind.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_print_1512698335.md b/windows.devices.pointofservice/receiptprintjob_print_1512698335.md index 880aa71f4b..299db0bd7c 100644 --- a/windows.devices.pointofservice/receiptprintjob_print_1512698335.md +++ b/windows.devices.pointofservice/receiptprintjob_print_1512698335.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.Print(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.Print ## -description Adds an instruction to the print job to print the specified text on the receipt printer station. ## -parameters ### -param data The text to print on the receipt printer station. ## -remarks If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. ## -examples ## -see-also [IPosPrinterJob.Print](iposprinterjob_print.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.Print(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.Print + +## -description +Adds an instruction to the print job to print the specified text on the receipt printer station. + +## -parameters +### -param data +The text to print on the receipt printer station. + +## -remarks +If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. + +## -examples + +## -see-also +[IPosPrinterJob.Print](iposprinterjob_print.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md b/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md index a4eaa89aa5..d5ebec0723 100644 --- a/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md +++ b/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md @@ -1,3 +1,51 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcode(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcode ## -description Adds an instruction to the print job to print a barcode with the specified data and symbology on the receipt printer station. ## -parameters ### -param data The data to be represented as a barcode. ### -param symbology The symbology (encoding) of the barcode. This can be determined based on the [BarcodeSymbologies](barcodesymbologies.md) class static methods. ### -param height The height of the barcode, in pixels. ### -param width The width of the barcode. ESC/POS control language is used for most Windows POS device communication, and ESC/POS only accepts integers from 2 to 6. Each value contains a matched measurement for the thin and thick elements of a barcode. In order for a barcode to be read properly, the width of the lines is crucial, especially when scaling. Additionally, the minimum width capability varies by printer model. Actual sizes are dependent on the capabilities of the target printer, but approximate sizes for accepted values are:
Width ValueThin ElementThick Element
20.250 - 0.282 mm0.625 - 0.706 mm
30.375 - 0.423 mm1.000 - 1.129 mm
40.500 - 0.564 mm1.250 - 1.411 mm
50.625 - 0.706 mm1.625 - 1.834 mm
60.750 - 0.847 mm2.000 - 2.258 mm
See the remarks in [POS Printer](pos_printer.md) for more information on ESC/POS. ### -param textPosition The vertical position of the barcode text relative to the barcode. ### -param alignment The horizontal alignment of the barcode on the page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcode(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcode + +## -description +Adds an instruction to the print job to print a barcode with the specified data and symbology on the receipt printer station. + +## -parameters +### -param data +The data to be represented as a barcode. + +### -param symbology +The symbology (encoding) of the barcode. This can be determined based on the [BarcodeSymbologies](barcodesymbologies.md) class static methods. + +### -param height +The height of the barcode, in pixels. + +### -param width +The width of the barcode. + +ESC/POS control language is used for most Windows POS device communication, and ESC/POS only accepts integers from 2 to 6. Each value contains a matched measurement for the thin and thick elements of a barcode. In order for a barcode to be read properly, the width of the lines is crucial, especially when scaling. Additionally, the minimum width capability varies by printer model. + +Actual sizes are dependent on the capabilities of the target printer, but approximate sizes for accepted values are: + + + + + + +
Width ValueThin ElementThick Element
20.250 - 0.282 mm0.625 - 0.706 mm
30.375 - 0.423 mm1.000 - 1.129 mm
40.500 - 0.564 mm1.250 - 1.411 mm
50.625 - 0.706 mm1.625 - 1.834 mm
60.750 - 0.847 mm2.000 - 2.258 mm
+ +See the remarks in [POS Printer](pos_printer.md) for more information on ESC/POS. + +### -param textPosition +The vertical position of the barcode text relative to the barcode. + +### -param alignment +The horizontal alignment of the barcode on the page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/receiptprintjob_printbarcodecustomalign_1844017198.md b/windows.devices.pointofservice/receiptprintjob_printbarcodecustomalign_1844017198.md index 5e06b20eec..6cf46e1d3e 100644 --- a/windows.devices.pointofservice/receiptprintjob_printbarcodecustomalign_1844017198.md +++ b/windows.devices.pointofservice/receiptprintjob_printbarcodecustomalign_1844017198.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcodeCustomAlign(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcodeCustomAlign ## -description Adds an instruction to the print job to print a barcode with the specified data, symbology, and custom alignment on the receipt printer station. ## -parameters ### -param data The data to be represented as a barcode. ### -param symbology The symbology (encoding) of the barcode. ### -param height The height of the barcode, in pixels. ### -param width The width of the barcode, in pixels. ### -param textPosition The vertical position of the barcode text relative to the barcode. ### -param alignmentDistance The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcodeCustomAlign(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintBarcodeCustomAlign + +## -description +Adds an instruction to the print job to print a barcode with the specified data, symbology, and custom alignment on the receipt printer station. + +## -parameters +### -param data +The data to be represented as a barcode. + +### -param symbology +The symbology (encoding) of the barcode. + +### -param height +The height of the barcode, in pixels. + +### -param width +The width of the barcode, in pixels. + +### -param textPosition +The vertical position of the barcode text relative to the barcode. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printbitmap_1103111072.md b/windows.devices.pointofservice/receiptprintjob_printbitmap_1103111072.md index c615565ba5..5d410f5696 100644 --- a/windows.devices.pointofservice/receiptprintjob_printbitmap_1103111072.md +++ b/windows.devices.pointofservice/receiptprintjob_printbitmap_1103111072.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printbitmap_1311643772.md b/windows.devices.pointofservice/receiptprintjob_printbitmap_1311643772.md index f59d554132..a3f518dfd0 100644 --- a/windows.devices.pointofservice/receiptprintjob_printbitmap_1311643772.md +++ b/windows.devices.pointofservice/receiptprintjob_printbitmap_1311643772.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ## -remarks ## -examples ## -see-also [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +## -remarks + +## -examples + +## -see-also +[PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_386594225.md b/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_386594225.md index 0d123f5de9..8fba6d3bc2 100644 --- a/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_386594225.md +++ b/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_386594225.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap ## -description Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](receiptprintjob_printcustomalignedbitmap_417648213.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_417648213.md b/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_417648213.md index 14ea949544..d0f44bf1ca 100644 --- a/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_417648213.md +++ b/windows.devices.pointofservice/receiptprintjob_printcustomalignedbitmap_417648213.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPriinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintCustomAlignedBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPriinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[PrintCustomAlignedBitmap(BitmapFrame, UInt32)](receiptprintjob_printcustomalignedbitmap_386594225.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](receiptprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printline_1360992803.md b/windows.devices.pointofservice/receiptprintjob_printline_1360992803.md index 71599d2ed8..adaf77d41d 100644 --- a/windows.devices.pointofservice/receiptprintjob_printline_1360992803.md +++ b/windows.devices.pointofservice/receiptprintjob_printline_1360992803.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine ## -description Adds an instruction to the print job to print a line of text on the receipt printer station. ## -parameters ### -param data The line of text to print. ## -remarks ## -examples ## -see-also [PrintLine](receiptprintjob_printline_144630531.md), [IPosPrinterJob.PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine + +## -description +Adds an instruction to the print job to print a line of text on the receipt printer station. + +## -parameters +### -param data +The line of text to print. + +## -remarks + +## -examples + +## -see-also +[PrintLine](receiptprintjob_printline_144630531.md), [IPosPrinterJob.PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printline_144630531.md b/windows.devices.pointofservice/receiptprintjob_printline_144630531.md index 577f26b616..2e38d04c6d 100644 --- a/windows.devices.pointofservice/receiptprintjob_printline_144630531.md +++ b/windows.devices.pointofservice/receiptprintjob_printline_144630531.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine ## -description Adds an instruction to the print job to print a newline character on the receipt printer station. ## -remarks ## -examples ## -see-also [PrintLine(String)](receiptprintjob_printline_1360992803.md), [IPosPrinterJob.PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintLine + +## -description +Adds an instruction to the print job to print a newline character on the receipt printer station. + +## -remarks + +## -examples + +## -see-also +[PrintLine(String)](receiptprintjob_printline_1360992803.md), [IPosPrinterJob.PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_printsavedbitmap_1902948304.md b/windows.devices.pointofservice/receiptprintjob_printsavedbitmap_1902948304.md index d0cc3c8464..2171c6b284 100644 --- a/windows.devices.pointofservice/receiptprintjob_printsavedbitmap_1902948304.md +++ b/windows.devices.pointofservice/receiptprintjob_printsavedbitmap_1902948304.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintSavedBitmap(System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.PrintSavedBitmap ## -description Adds an instruction to the print job to print a bitmap on the receipt printer station by using the bitmap and information saved to the printer via [SetBitmap](receiptprintjob_setbitmap.md) or [SetCustomAlignedBitmap](receiptprintjob_setcustomalignedbitmap.md). ## -parameters ### -param bitmapNumber The number that you assigned to the bitmap that you want to print when you called [SetBitmap](receiptprintjob_setbitmap.md) or [SetCustomAlignedBitmap](receiptprintjob_setcustomalignedbitmap.md). ## -remarks The bitmap rotation setting that you specify by calling [ReceiptPrintJob.SetPrintRotation](receiptprintjob_setprintrotation.md) may not apply to bitmaps that you saved to the printer. ## -examples ## -see-also [SetBitmap](receiptprintjob_setbitmap.md), [SetCustomAlignedBitmap](receiptprintjob_setcustomalignedbitmap.md), [ReceiptPrintJob.SetPrintRotation](receiptprintjob_setprintrotation.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.PrintSavedBitmap(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.PrintSavedBitmap + +## -description +Adds an instruction to the print job to print a bitmap on the receipt printer station by using the bitmap and information saved to the printer via [SetBitmap](receiptprintjob_setbitmap.md) or [SetCustomAlignedBitmap](receiptprintjob_setcustomalignedbitmap.md). + +## -parameters +### -param bitmapNumber +The number that you assigned to the bitmap that you want to print when you called [SetBitmap](receiptprintjob_setbitmap.md) or [SetCustomAlignedBitmap](receiptprintjob_setcustomalignedbitmap.md). + +## -remarks +The bitmap rotation setting that you specify by calling [ReceiptPrintJob.SetPrintRotation](receiptprintjob_setprintrotation.md) may not apply to bitmaps that you saved to the printer. + +## -examples + +## -see-also +[SetBitmap](receiptprintjob_setbitmap.md), [SetCustomAlignedBitmap](receiptprintjob_setcustomalignedbitmap.md), [ReceiptPrintJob.SetPrintRotation](receiptprintjob_setprintrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_setbarcoderotation_1140294829.md b/windows.devices.pointofservice/receiptprintjob_setbarcoderotation_1140294829.md index 13e74c24a0..4ef7f7a9ab 100644 --- a/windows.devices.pointofservice/receiptprintjob_setbarcoderotation_1140294829.md +++ b/windows.devices.pointofservice/receiptprintjob_setbarcoderotation_1140294829.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetBarcodeRotation(Windows.Devices.PointOfService.PosPrinterRotation) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetBarcodeRotation ## -description Sets the rotation of the barcode on the page on the receipt printer station. ## -parameters ### -param value The rotation of the barcode on the page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetBarcodeRotation(Windows.Devices.PointOfService.PosPrinterRotation) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetBarcodeRotation + +## -description +Sets the rotation of the barcode on the page on the receipt printer station. + +## -parameters +### -param value +The rotation of the barcode on the page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/receiptprintjob_setbitmap_489195165.md b/windows.devices.pointofservice/receiptprintjob_setbitmap_489195165.md index f5484a75bb..f05d8ca951 100644 --- a/windows.devices.pointofservice/receiptprintjob_setbitmap_489195165.md +++ b/windows.devices.pointofservice/receiptprintjob_setbitmap_489195165.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap ## -description Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ## -remarks If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](receiptprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](receiptprintjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap + +## -description +Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +## -remarks +If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](receiptprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](receiptprintjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_setbitmap_49606997.md b/windows.devices.pointofservice/receiptprintjob_setbitmap_49606997.md index 53680799dd..fff3f23358 100644 --- a/windows.devices.pointofservice/receiptprintjob_setbitmap_49606997.md +++ b/windows.devices.pointofservice/receiptprintjob_setbitmap_49606997.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap ## -description Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](receiptprintjob_setbitmap_489195165.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](receiptprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](receiptprintjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetBitmap + +## -description +Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks +If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](receiptprintjob_setbitmap_489195165.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](receiptprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](receiptprintjob_setcustomalignedbitmap_1547903367.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1134515791.md b/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1134515791.md index b759923b2a..3f7be51049 100644 --- a/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1134515791.md +++ b/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1134515791.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap ## -description Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](receiptprintjob_setcustomalignedbitmap_1547903367.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](receiptprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap + +## -description +Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](receiptprintjob_setcustomalignedbitmap_1547903367.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](receiptprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1547903367.md b/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1547903367.md index cbf5038552..ab35dc7ce5 100644 --- a/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1547903367.md +++ b/windows.devices.pointofservice/receiptprintjob_setcustomalignedbitmap_1547903367.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap ## -description Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](receiptprintjob_setcustomalignedbitmap_1134515791.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](receiptprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetCustomAlignedBitmap + +## -description +Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt printer station, so that you can use the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](receiptprintjob_setcustomalignedbitmap_1134515791.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](receiptprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](receiptprintjob_setbitmap_49606997.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_setprintarea_1895383025.md b/windows.devices.pointofservice/receiptprintjob_setprintarea_1895383025.md index 23b2613e39..d85f4339fc 100644 --- a/windows.devices.pointofservice/receiptprintjob_setprintarea_1895383025.md +++ b/windows.devices.pointofservice/receiptprintjob_setprintarea_1895383025.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintArea(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintArea ## -description Sets the area of the page on which the receipt printer station can print the job. ## -parameters ### -param value The area of the page on which the receipt printer can print the job. ## -remarks When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called [ReceiptPrintJob.SetPrintArea](receiptprintjob_setprintarea.md). ## -examples ## -see-also [IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md), [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md), [ReceiptPrinterCapabilities.IsPrintAreaSupported](receiptprintercapabilities_isprintareasupported.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintArea(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintArea + +## -description +Sets the area of the page on which the receipt printer station can print the job. + +## -parameters +### -param value +The area of the page on which the receipt printer can print the job. + +## -remarks +When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called [ReceiptPrintJob.SetPrintArea](receiptprintjob_setprintarea.md). + +## -examples + +## -see-also +[IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md), [ClaimedReceiptPrinter.PrintArea](claimedreceiptprinter_printarea.md), [ReceiptPrinterCapabilities.IsPrintAreaSupported](receiptprintercapabilities_isprintareasupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/receiptprintjob_setprintrotation_513865495.md b/windows.devices.pointofservice/receiptprintjob_setprintrotation_513865495.md index 683183024e..73e492f2c9 100644 --- a/windows.devices.pointofservice/receiptprintjob_setprintrotation_513865495.md +++ b/windows.devices.pointofservice/receiptprintjob_setprintrotation_513865495.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintRotation(Windows.Devices.PointOfService.PosPrinterRotation,System.Boolean) --api-type: winrt method ---- # Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintRotation ## -description Sets the rotation of the text or image on the page for the receipt printer station. ## -parameters ### -param value The rotation of the text or image on the page for the receipt printer station. ### -param includeBitmaps Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to [PrintBitmap](receiptprintjob_printbitmap.md), and may not apply to saved bitmaps that you print using [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md). ## -remarks This rotation setting persists beyond the current print job. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintRotation(Windows.Devices.PointOfService.PosPrinterRotation,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ReceiptPrintJob.SetPrintRotation + +## -description +Sets the rotation of the text or image on the page for the receipt printer station. + +## -parameters +### -param value +The rotation of the text or image on the page for the receipt printer station. + +### -param includeBitmaps +Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to [PrintBitmap](receiptprintjob_printbitmap.md), and may not apply to saved bitmaps that you print using [PrintSavedBitmap](receiptprintjob_printsavedbitmap.md). + +## -remarks +This rotation setting persists beyond the current print job. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/slipprintercapabilities.md b/windows.devices.pointofservice/slipprintercapabilities.md index e3d01a66e7..3831026d27 100644 --- a/windows.devices.pointofservice/slipprintercapabilities.md +++ b/windows.devices.pointofservice/slipprintercapabilities.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.SlipPrinterCapabilities --api-type: winrt class ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities ## -description Represents the capabilities of slip station of a point-of-service printer. ## -remarks To get the capabilities of the slip station of a point-of-service printer, use [PosPrinterCapabilities.Slip](posprintercapabilities_slip.md). ## -examples ## -see-also [ICommonReceiptSlipCapabilities](icommonreceiptslipcapabilities.md), [ICommonPosPrintStationCapabilities](icommonposprintstationcapabilities.md), [PosPrinterCapabilities.Slip](posprintercapabilities_slip.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.SlipPrinterCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities + +## -description +Represents the capabilities of slip station of a point-of-service printer. + +## -remarks +To get the capabilities of the slip station of a point-of-service printer, use [PosPrinterCapabilities.Slip](posprintercapabilities_slip.md). + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities](icommonreceiptslipcapabilities.md), [ICommonPosPrintStationCapabilities](icommonposprintstationcapabilities.md), [PosPrinterCapabilities.Slip](posprintercapabilities_slip.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_cartridgesensors.md b/windows.devices.pointofservice/slipprintercapabilities_cartridgesensors.md index 08f40b5f3e..32cd8d4eb5 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_cartridgesensors.md +++ b/windows.devices.pointofservice/slipprintercapabilities_cartridgesensors.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.CartridgeSensors --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.CartridgeSensors ## -description Gets information about the sensors that the slip printer station has available to report the status of the printer station. ## -property-value A combination of enumeration values that indicate the sensors that the slip printer station has available to report the status of the printer station. ## -remarks ## -examples ## -see-also [PosPrinterCartridgeSensors](posprintercartridgesensors.md), [ICommonPosPrintStationCapabilities.CartridgeSensors](icommonposprintstationcapabilities_cartridgesensors.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.CartridgeSensors +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.CartridgeSensors + +## -description +Gets information about the sensors that the slip printer station has available to report the status of the printer station. + +## -property-value +A combination of enumeration values that indicate the sensors that the slip printer station has available to report the status of the printer station. + +## -remarks + +## -examples + +## -see-also +[PosPrinterCartridgeSensors](posprintercartridgesensors.md), [ICommonPosPrintStationCapabilities.CartridgeSensors](icommonposprintstationcapabilities_cartridgesensors.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_colorcartridgecapabilities.md b/windows.devices.pointofservice/slipprintercapabilities_colorcartridgecapabilities.md index 94d950e6fc..9f8f0dd15d 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_colorcartridgecapabilities.md +++ b/windows.devices.pointofservice/slipprintercapabilities_colorcartridgecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.ColorCartridgeCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.ColorCartridgeCapabilities ## -description Gets the color cartridges that the slip printer station can use to print in color. ## -property-value A combination of enumeration values that indicates which color cartridges the slip printer station can use to print in color. ## -remarks ## -examples ## -see-also [PosPrinterColorCapabilities](posprintercolorcapabilities.md), [ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities](icommonposprintstationcapabilities_colorcartridgecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.ColorCartridgeCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.ColorCartridgeCapabilities + +## -description +Gets the color cartridges that the slip printer station can use to print in color. + +## -property-value +A combination of enumeration values that indicates which color cartridges the slip printer station can use to print in color. + +## -remarks + +## -examples + +## -see-also +[PosPrinterColorCapabilities](posprintercolorcapabilities.md), [ICommonPosPrintStationCapabilities.ColorCartridgeCapabilities](icommonposprintstationcapabilities_colorcartridgecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_is180rotationsupported.md b/windows.devices.pointofservice/slipprintercapabilities_is180rotationsupported.md index b35781229e..329827746a 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_is180rotationsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_is180rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.Is180RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.Is180RotationSupported ## -description Gets whether the slip printer station can print in a rotated upside-down mode. ## -property-value True if the slip printer station can print in a rotated upside-down mode; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.Is180RotationSupported](icommonreceiptslipcapabilities_is180rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.Is180RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.Is180RotationSupported + +## -description +Gets whether the slip printer station can print in a rotated upside-down mode. + +## -property-value +True if the slip printer station can print in a rotated upside-down mode; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.Is180RotationSupported](icommonreceiptslipcapabilities_is180rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isbarcodesupported.md b/windows.devices.pointofservice/slipprintercapabilities_isbarcodesupported.md index c29f7677f4..5a5848dbce 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isbarcodesupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isbarcodesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBarcodeSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBarcodeSupported ## -description Gets whether the slip printer station can print barcodes. ## -property-value True if the slip printer station can print barcodes; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsBarcodeSupported](icommonreceiptslipcapabilities_isbarcodesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBarcodeSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBarcodeSupported + +## -description +Gets whether the slip printer station can print barcodes. + +## -property-value +True if the slip printer station can print barcodes; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsBarcodeSupported](icommonreceiptslipcapabilities_isbarcodesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isbitmapsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isbitmapsupported.md index b42e88cde6..e086cbd6ed 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isbitmapsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isbitmapsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBitmapSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBitmapSupported ## -description Gets whether the slip printer station can print bitmaps. ## -property-value True if the slip printer station can print bitmaps; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsBitmapSupported](icommonreceiptslipcapabilities_isbitmapsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBitmapSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBitmapSupported + +## -description +Gets whether the slip printer station can print bitmaps. + +## -property-value +True if the slip printer station can print bitmaps; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsBitmapSupported](icommonreceiptslipcapabilities_isbitmapsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isboldsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isboldsupported.md index 674b7e1589..c767f5914c 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isboldsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isboldsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBoldSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBoldSupported ## -description Gets whether the slip printer station can print bold characters. ## -property-value True if the slip printer station can print bold characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsBoldSupported](icommonposprintstationcapabilities_isboldsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBoldSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBoldSupported + +## -description +Gets whether the slip printer station can print bold characters. + +## -property-value +True if the slip printer station can print bold characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsBoldSupported](icommonposprintstationcapabilities_isboldsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isbothsidesprintingsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isbothsidesprintingsupported.md index a554699c00..30e6a85366 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isbothsidesprintingsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isbothsidesprintingsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBothSidesPrintingSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBothSidesPrintingSupported ## -description Gets whether the slip printer station supports printing on both sides of the document. ## -property-value True if the slip printer station supports printing on both sides of the document; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBothSidesPrintingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsBothSidesPrintingSupported + +## -description +Gets whether the slip printer station supports printing on both sides of the document. + +## -property-value +True if the slip printer station supports printing on both sides of the document; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/slipprintercapabilities_isdoublehighdoublewideprintsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isdoublehighdoublewideprintsupported.md index ea684dfd03..2c6c6dc420 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isdoublehighdoublewideprintsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isdoublehighdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported ## -description Gets whether the slip printer station can print characters that are both double-high and double-wide. ## -property-value True if the slip printer station can print characters that are both double-high and double-wide; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighDoubleWidePrintSupported + +## -description +Gets whether the slip printer station can print characters that are both double-high and double-wide. + +## -property-value +True if the slip printer station can print characters that are both double-high and double-wide; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleHighDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublehighdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isdoublehighprintsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isdoublehighprintsupported.md index 357f87aad4..54f6da7be5 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isdoublehighprintsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isdoublehighprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighPrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighPrintSupported ## -description Gets whether the slip printer station can print double-high characters. ## -property-value True if the slip printer station can print double-high characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported](icommonposprintstationcapabilities_isdoublehighprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighPrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleHighPrintSupported + +## -description +Gets whether the slip printer station can print double-high characters. + +## -property-value +True if the slip printer station can print double-high characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleHighPrintSupported](icommonposprintstationcapabilities_isdoublehighprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isdoublewideprintsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isdoublewideprintsupported.md index ac65eb699b..149727c76b 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isdoublewideprintsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isdoublewideprintsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleWidePrintSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleWidePrintSupported ## -description Gets whether the slip printer station can print double-wide characters. ## -property-value True if the slip printer station can print double-wide characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublewideprintsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleWidePrintSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDoubleWidePrintSupported + +## -description +Gets whether the slip printer station can print double-wide characters. + +## -property-value +True if the slip printer station can print double-wide characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDoubleWidePrintSupported](icommonposprintstationcapabilities_isdoublewideprintsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isdualcolorsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isdualcolorsupported.md index fc07b92a1a..a151dbc1b5 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isdualcolorsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isdualcolorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDualColorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDualColorSupported ## -description Gets whether the slip printer station can print a dark color plus an alternate color. ## -property-value True if the slip printer station can print a dark color plus an alternate color; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDualColorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsDualColorSupported + +## -description +Gets whether the slip printer station can print a dark color plus an alternate color. + +## -property-value +True if the slip printer station can print a dark color plus an alternate color; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsDualColorSupported](journalprintercapabilities_isdualcolorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isfulllengthsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isfulllengthsupported.md index 925878fc23..143b9cc992 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isfulllengthsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isfulllengthsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsFullLengthSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsFullLengthSupported ## -description Gets whether the slip printer station can print full-length forms. ## -property-value True if the slip printer station can print full-length forms. False if the slip printer station is a validation-type station. Validation-type stations usually limit the number of print lines and turn off access to the receipt and journal stations while the validation slip is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsFullLengthSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsFullLengthSupported + +## -description +Gets whether the slip printer station can print full-length forms. + +## -property-value +True if the slip printer station can print full-length forms. False if the slip printer station is a validation-type station. Validation-type stations usually limit the number of print lines and turn off access to the receipt and journal stations while the validation slip is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/slipprintercapabilities_isitalicsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isitalicsupported.md index 4442d92694..d5ec66a2c5 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isitalicsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isitalicsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsItalicSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsItalicSupported ## -description Gets whether the slip printer station can print italic characters. ## -property-value True if the slip printer station can print italic characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsItalicSupported](icommonposprintstationcapabilities_isitalicsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsItalicSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsItalicSupported + +## -description +Gets whether the slip printer station can print italic characters. + +## -property-value +True if the slip printer station can print italic characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsItalicSupported](icommonposprintstationcapabilities_isitalicsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isleft90rotationsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isleft90rotationsupported.md index edbfbcf9d1..b3d84018bd 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isleft90rotationsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isleft90rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsLeft90RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsLeft90RotationSupported ## -description Gets whether the slip printer station can print information rotated 90 degrees to the left. ## -property-value True if the slip printer station can print information rotated 90 degrees to the left; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsLeft90RotationSupported](icommonreceiptslipcapabilities_isleft90rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsLeft90RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsLeft90RotationSupported + +## -description +Gets whether the slip printer station can print information rotated 90 degrees to the left. + +## -property-value +True if the slip printer station can print information rotated 90 degrees to the left; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsLeft90RotationSupported](icommonreceiptslipcapabilities_isleft90rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_ispaperemptysensorsupported.md b/windows.devices.pointofservice/slipprintercapabilities_ispaperemptysensorsupported.md index b4de151802..1c55204b80 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_ispaperemptysensorsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_ispaperemptysensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperEmptySensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperEmptySensorSupported ## -description Gets whether the slip printer station has an out-of-paper sensor. ## -property-value True if the slip printer station has an out-of-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported](icommonposprintstationcapabilities_ispaperemptysensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperEmptySensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperEmptySensorSupported + +## -description +Gets whether the slip printer station has an out-of-paper sensor. + +## -property-value +True if the slip printer station has an out-of-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPaperEmptySensorSupported](icommonposprintstationcapabilities_ispaperemptysensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_ispapernearendsensorsupported.md b/windows.devices.pointofservice/slipprintercapabilities_ispapernearendsensorsupported.md index 92683cdc6a..16ba256be5 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_ispapernearendsensorsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_ispapernearendsensorsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperNearEndSensorSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperNearEndSensorSupported ## -description Gets whether the slip printer station has a low-paper sensor. ## -property-value True if the slip printer station has a low-paper sensor; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported](icommonposprintstationcapabilities_ispapernearendsensorsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperNearEndSensorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPaperNearEndSensorSupported + +## -description +Gets whether the slip printer station has a low-paper sensor. + +## -property-value +True if the slip printer station has a low-paper sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPaperNearEndSensorSupported](icommonposprintstationcapabilities_ispapernearendsensorsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isprintareasupported.md b/windows.devices.pointofservice/slipprintercapabilities_isprintareasupported.md index ab82d8d047..6d1e81ccfe 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isprintareasupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isprintareasupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrintAreaSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrintAreaSupported ## -description Gets whether the slip printer station supports setting a custom size for the area of the page on which the printer station should print. ## -property-value True if the slip printer station supports setting a custom size for the area of the page on which the printer station should print; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsPrintAreaSupported](icommonreceiptslipcapabilities_isprintareasupported.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrintAreaSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrintAreaSupported + +## -description +Gets whether the slip printer station supports setting a custom size for the area of the page on which the printer station should print. + +## -property-value +True if the slip printer station supports setting a custom size for the area of the page on which the printer station should print; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsPrintAreaSupported](icommonreceiptslipcapabilities_isprintareasupported.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isprinterpresent.md b/windows.devices.pointofservice/slipprintercapabilities_isprinterpresent.md index a4ae95b574..ea473260a2 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isprinterpresent.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isprinterpresent.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrinterPresent --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrinterPresent ## -description Gets whether a point-of-service printer with a station that prints forms such as checks or credit card slips is present. ## -property-value True if a point-of-service printer with a station that prints forms such as checks or credit card slips is present; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsPrinterPresent](icommonposprintstationcapabilities_isprinterpresent.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrinterPresent +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsPrinterPresent + +## -description +Gets whether a point-of-service printer with a station that prints forms such as checks or credit card slips is present. + +## -property-value +True if a point-of-service printer with a station that prints forms such as checks or credit card slips is present; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsPrinterPresent](icommonposprintstationcapabilities_isprinterpresent.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isright90rotationsupported.md b/windows.devices.pointofservice/slipprintercapabilities_isright90rotationsupported.md index b921bbe2d1..877f38aa96 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isright90rotationsupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isright90rotationsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsRight90RotationSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsRight90RotationSupported ## -description Gets whether the slip printer station can print information rotated 90 degrees to the right. ## -property-value True if the slip printer station can print information rotated 90 degrees to the right; otherwise false. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.IsRight90RotationSupported](icommonreceiptslipcapabilities_isright90rotationsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsRight90RotationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsRight90RotationSupported + +## -description +Gets whether the slip printer station can print information rotated 90 degrees to the right. + +## -property-value +True if the slip printer station can print information rotated 90 degrees to the right; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.IsRight90RotationSupported](icommonreceiptslipcapabilities_isright90rotationsupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_isunderlinesupported.md b/windows.devices.pointofservice/slipprintercapabilities_isunderlinesupported.md index 83063d8fab..2f14da0812 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_isunderlinesupported.md +++ b/windows.devices.pointofservice/slipprintercapabilities_isunderlinesupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsUnderlineSupported --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.IsUnderlineSupported ## -description Gets whether the slip printer station can underline characters. ## -property-value True if the slip printer station can underline characters; otherwise false. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.IsUnderlineSupported](icommonposprintstationcapabilities_isunderlinesupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.IsUnderlineSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.IsUnderlineSupported + +## -description +Gets whether the slip printer station can underline characters. + +## -property-value +True if the slip printer station can underline characters; otherwise false. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.IsUnderlineSupported](icommonposprintstationcapabilities_isunderlinesupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_ruledlinecapabilities.md b/windows.devices.pointofservice/slipprintercapabilities_ruledlinecapabilities.md index 980057885e..77726c1976 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_ruledlinecapabilities.md +++ b/windows.devices.pointofservice/slipprintercapabilities_ruledlinecapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.RuledLineCapabilities --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.RuledLineCapabilities ## -description Gets information about the capabilities of the slip printer station to draw ruled lines. ## -property-value Information about the capabilities of the slip printer station to draw ruled lines. ## -remarks ## -examples ## -see-also [PosPrinterRuledLineCapabilities](posprinterruledlinecapabilities.md), [ICommonReceiptSlipCapabilities.RuledLineCapabilities](icommonreceiptslipcapabilities_ruledlinecapabilities.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.RuledLineCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.RuledLineCapabilities + +## -description +Gets information about the capabilities of the slip printer station to draw ruled lines. + +## -property-value +Information about the capabilities of the slip printer station to draw ruled lines. + +## -remarks + +## -examples + +## -see-also +[PosPrinterRuledLineCapabilities](posprinterruledlinecapabilities.md), [ICommonReceiptSlipCapabilities.RuledLineCapabilities](icommonreceiptslipcapabilities_ruledlinecapabilities.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_supportedbarcoderotations.md b/windows.devices.pointofservice/slipprintercapabilities_supportedbarcoderotations.md index 99961ff21c..b2fbcb97e4 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_supportedbarcoderotations.md +++ b/windows.devices.pointofservice/slipprintercapabilities_supportedbarcoderotations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBarcodeRotations --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBarcodeRotations ## -description Gets a list of the directions in which the slip printer station can rotate a barcode when printing. ## -property-value A list of the directions in which the slip printer station can rotate a barcode when printing. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.SupportedBarcodeRotations](icommonreceiptslipcapabilities_supportedbarcoderotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBarcodeRotations +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBarcodeRotations + +## -description +Gets a list of the directions in which the slip printer station can rotate a barcode when printing. + +## -property-value +A list of the directions in which the slip printer station can rotate a barcode when printing. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.SupportedBarcodeRotations](icommonreceiptslipcapabilities_supportedbarcoderotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_supportedbitmaprotations.md b/windows.devices.pointofservice/slipprintercapabilities_supportedbitmaprotations.md index 15cfad32e6..aba818b970 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_supportedbitmaprotations.md +++ b/windows.devices.pointofservice/slipprintercapabilities_supportedbitmaprotations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBitmapRotations --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBitmapRotations ## -description Gets a list of the directions in which the slip printer station can rotate a bitmap when printing. ## -property-value A list of the directions in which the slip printer station can rotate a bitmap when printing. ## -remarks ## -examples ## -see-also [ICommonReceiptSlipCapabilities.SupportedBitmapRotations](icommonreceiptslipcapabilities_supportedbitmaprotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBitmapRotations +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedBitmapRotations + +## -description +Gets a list of the directions in which the slip printer station can rotate a bitmap when printing. + +## -property-value +A list of the directions in which the slip printer station can rotate a bitmap when printing. + +## -remarks + +## -examples + +## -see-also +[ICommonReceiptSlipCapabilities.SupportedBitmapRotations](icommonreceiptslipcapabilities_supportedbitmaprotations.md), [PosPrinterRotation](posprinterrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintercapabilities_supportedcharactersperline.md b/windows.devices.pointofservice/slipprintercapabilities_supportedcharactersperline.md index 188721dd78..fd93f1d3b5 100644 --- a/windows.devices.pointofservice/slipprintercapabilities_supportedcharactersperline.md +++ b/windows.devices.pointofservice/slipprintercapabilities_supportedcharactersperline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedCharactersPerLine --api-type: winrt property ---- # Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedCharactersPerLine ## -description Gets a collection of the line widths in characters per line that the slip printer station supports. ## -property-value A collection of the line widths in characters per line that the slip printer station supports. ## -remarks ## -examples ## -see-also [ICommonPosPrintStationCapabilities.SupportedCharactersPerLine](icommonposprintstationcapabilities_supportedcharactersperline.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedCharactersPerLine +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.SlipPrinterCapabilities.SupportedCharactersPerLine + +## -description +Gets a collection of the line widths in characters per line that the slip printer station supports. + +## -property-value +A collection of the line widths in characters per line that the slip printer station supports. + +## -remarks + +## -examples + +## -see-also +[ICommonPosPrintStationCapabilities.SupportedCharactersPerLine](icommonposprintstationcapabilities_supportedcharactersperline.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob.md b/windows.devices.pointofservice/slipprintjob.md index 14b8406915..33bc5df46f 100644 --- a/windows.devices.pointofservice/slipprintjob.md +++ b/windows.devices.pointofservice/slipprintjob.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.SlipPrintJob --api-type: winrt class ---- # Windows.Devices.PointOfService.SlipPrintJob ## -description Represents a set of printing instructions that you want to run on the slip printer station. ## -remarks To create a new print job for the slip printer, call [ClaimedSlipPrinter.CreateJob](claimedslipprinter_createjob.md). ## -examples ## -see-also [IReceiptOrSlipJob](ireceiptorslipjob.md), [IPosPrinterJob](iposprinterjob.md), [ClaimedSlipPrinter.CreateJob](claimedslipprinter_createjob.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.SlipPrintJob +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob + +## -description +Represents a set of printing instructions that you want to run on the slip printer station. + +## -remarks +To create a new print job for the slip printer, call [ClaimedSlipPrinter.CreateJob](claimedslipprinter_createjob.md). + +## -examples + +## -see-also +[IReceiptOrSlipJob](ireceiptorslipjob.md), [IPosPrinterJob](iposprinterjob.md), [ClaimedSlipPrinter.CreateJob](claimedslipprinter_createjob.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_drawruledline_1309666666.md b/windows.devices.pointofservice/slipprintjob_drawruledline_1309666666.md index 7d53b1fb43..412ec9fb27 100644 --- a/windows.devices.pointofservice/slipprintjob_drawruledline_1309666666.md +++ b/windows.devices.pointofservice/slipprintjob_drawruledline_1309666666.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.DrawRuledLine(System.String,Windows.Devices.PointOfService.PosPrinterLineDirection,System.UInt32,Windows.Devices.PointOfService.PosPrinterLineStyle,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.DrawRuledLine ## -description Adds an instruction to the print job to print a drawn, ruled line on the paper of the slip printer station. ## -parameters ### -param positionList The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. ### -param lineDirection The direction in which to print the ruled line. ### -param lineWidth The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used. ### -param lineStyle The appearance of the ruled line, such as whether it is solid or broken, or single or double. ### -param lineColor The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ClaimedSlipPrinter.ColorCartridge](claimedslipprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.DrawRuledLine](ireceiptorslipjob_drawruledline.md), [ClaimedSlipPrinter.ColorCartridge](claimedslipprinter_colorcartridge.md), [PosPrinterLineDirection](posprinterlinedirection.md), [PosPrinterLineStyle](posprinterlinestyle.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.DrawRuledLine(System.String,Windows.Devices.PointOfService.PosPrinterLineDirection,System.UInt32,Windows.Devices.PointOfService.PosPrinterLineStyle,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.DrawRuledLine + +## -description +Adds an instruction to the print job to print a drawn, ruled line on the paper of the slip printer station. + +## -parameters +### -param positionList +The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. + +### -param lineDirection +The direction in which to print the ruled line. + +### -param lineWidth +The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used. + +### -param lineStyle +The appearance of the ruled line, such as whether it is solid or broken, or single or double. + +### -param lineColor +The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ClaimedSlipPrinter.ColorCartridge](claimedslipprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.DrawRuledLine](ireceiptorslipjob_drawruledline.md), [ClaimedSlipPrinter.ColorCartridge](claimedslipprinter_colorcartridge.md), [PosPrinterLineDirection](posprinterlinedirection.md), [PosPrinterLineStyle](posprinterlinestyle.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_executeasync_2108924004.md b/windows.devices.pointofservice/slipprintjob_executeasync_2108924004.md index 6210d79407..b7a7c99293 100644 --- a/windows.devices.pointofservice/slipprintjob_executeasync_2108924004.md +++ b/windows.devices.pointofservice/slipprintjob_executeasync_2108924004.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.ExecuteAsync --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.ExecuteAsync ## -description Runs the print job on the slip printer station asynchronously. ## -returns The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. ## -remarks ## -examples ## -see-also [IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.ExecuteAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.ExecuteAsync + +## -description +Runs the print job on the slip printer station asynchronously. + +## -returns +The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false. + +## -remarks + +## -examples + +## -see-also +[IPosPrinterJob.ExecuteAsync](iposprinterjob_executeasync.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_print_1512698335.md b/windows.devices.pointofservice/slipprintjob_print_1512698335.md index d5d1898444..6b3d664b72 100644 --- a/windows.devices.pointofservice/slipprintjob_print_1512698335.md +++ b/windows.devices.pointofservice/slipprintjob_print_1512698335.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.Print(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.Print ## -description Adds an instruction to the print job to print the specified text on the slip printer station. ## -parameters ### -param data The text to print on the slip printer station. ## -remarks If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. ## -examples ## -see-also [IPosPrinterJob.Print](iposprinterjob_print.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.Print(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.Print + +## -description +Adds an instruction to the print job to print the specified text on the slip printer station. + +## -parameters +### -param data +The text to print on the slip printer station. + +## -remarks +If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is true, the text is mapped to the font on the printer that [ClaimedPosPrinter.CharacterSet](claimedposprinter_characterset.md) specifies. If [ClaimedPosPrinter.IsCharacterSetMappingEnabled](claimedposprinter_ischaractersetmappingenabled.md) is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim. + +## -examples + +## -see-also +[IPosPrinterJob.Print](iposprinterjob_print.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printbarcode_1361148756.md b/windows.devices.pointofservice/slipprintjob_printbarcode_1361148756.md index e00ea4eb2b..90c113fca1 100644 --- a/windows.devices.pointofservice/slipprintjob_printbarcode_1361148756.md +++ b/windows.devices.pointofservice/slipprintjob_printbarcode_1361148756.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBarcode(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintBarcode ## -description Adds an instruction to the print job to print a barcode on the slip printer station with the specified data and symbology. ## -parameters ### -param data The data to represent as a barcode. ### -param symbology The symbology (encoding) of the barcode. ### -param height The height of the barcode, in pixels. ### -param width The width of the barcode, in pixels. ### -param textPosition The vertical position of the barcode text relative to the barcode. ### -param alignment The horizontal alignment of the barcode on the page. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.PrintBarcode](ireceiptorslipjob_printbarcode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBarcode(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintBarcode + +## -description +Adds an instruction to the print job to print a barcode on the slip printer station with the specified data and symbology. + +## -parameters +### -param data +The data to represent as a barcode. + +### -param symbology +The symbology (encoding) of the barcode. + +### -param height +The height of the barcode, in pixels. + +### -param width +The width of the barcode, in pixels. + +### -param textPosition +The vertical position of the barcode text relative to the barcode. + +### -param alignment +The horizontal alignment of the barcode on the page. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.PrintBarcode](ireceiptorslipjob_printbarcode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printbarcodecustomalign_1844017198.md b/windows.devices.pointofservice/slipprintjob_printbarcodecustomalign_1844017198.md index 988861de5e..a8ee65f811 100644 --- a/windows.devices.pointofservice/slipprintjob_printbarcodecustomalign_1844017198.md +++ b/windows.devices.pointofservice/slipprintjob_printbarcodecustomalign_1844017198.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBarcodeCustomAlign(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintBarcodeCustomAlign ## -description Adds an instruction to the print job to print a barcode on the slip printer station with the specified data, symbology, and custom alignment. ## -parameters ### -param data The data to represent as a barcode. ### -param symbology The symbology (encoding) of the barcode. ### -param height The height of the barcode, in pixels. ### -param width The width of the barcode, in pixels. ### -param textPosition The vertical position of the barcode text relative to the barcode. ### -param alignmentDistance The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [IReceiptOrSlipJob.PrintBarcodeCustomAlign](ireceiptorslipjob_printbarcodecustomalign.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBarcodeCustomAlign(System.String,System.UInt32,System.UInt32,System.UInt32,Windows.Devices.PointOfService.PosPrinterBarcodeTextPosition,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintBarcodeCustomAlign + +## -description +Adds an instruction to the print job to print a barcode on the slip printer station with the specified data, symbology, and custom alignment. + +## -parameters +### -param data +The data to represent as a barcode. + +### -param symbology +The symbology (encoding) of the barcode. + +### -param height +The height of the barcode, in pixels. + +### -param width +The width of the barcode, in pixels. + +### -param textPosition +The vertical position of the barcode text relative to the barcode. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[IReceiptOrSlipJob.PrintBarcodeCustomAlign](ireceiptorslipjob_printbarcodecustomalign.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printbitmap_1103111072.md b/windows.devices.pointofservice/slipprintjob_printbitmap_1103111072.md index 33f24905c2..7378075f86 100644 --- a/windows.devices.pointofservice/slipprintjob_printbitmap_1103111072.md +++ b/windows.devices.pointofservice/slipprintjob_printbitmap_1103111072.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [PosPrinterAlignment](posprinteralignment.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printbitmap_1311643772.md b/windows.devices.pointofservice/slipprintjob_printbitmap_1311643772.md index fd00222fe0..8c65816f2f 100644 --- a/windows.devices.pointofservice/slipprintjob_printbitmap_1311643772.md +++ b/windows.devices.pointofservice/slipprintjob_printbitmap_1311643772.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ## -remarks ## -examples ## -see-also [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap(Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +## -remarks + +## -examples + +## -see-also +[PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_386594225.md b/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_386594225.md index 41b59d479c..6770d9dec5 100644 --- a/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_386594225.md +++ b/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_386594225.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap ## -description Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)](slipprintjob_printcustomalignedbitmap_417648213.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_417648213.md b/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_417648213.md index 587597f249..4b3236eba6 100644 --- a/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_417648213.md +++ b/windows.devices.pointofservice/slipprintjob_printcustomalignedbitmap_417648213.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap ## -description Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the slip printer station. ## -parameters ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap(Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintCustomAlignedBitmap + +## -description +Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the slip printer station. + +## -parameters +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[PrintCustomAlignedBitmap(BitmapFrame, UInt32)](slipprintjob_printcustomalignedbitmap_386594225.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment)](slipprintjob_printbitmap_1311643772.md), [PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_printbitmap_1103111072.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printline_1360992803.md b/windows.devices.pointofservice/slipprintjob_printline_1360992803.md index d44f7fc216..e932a5d4aa 100644 --- a/windows.devices.pointofservice/slipprintjob_printline_1360992803.md +++ b/windows.devices.pointofservice/slipprintjob_printline_1360992803.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintLine(System.String) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintLine ## -description Adds an instruction to the print job to print a line of text on the slip printer station. ## -parameters ### -param data The line of text to print. ## -remarks ## -examples ## -see-also [PrintLine](slipprintjob_printline_144630531.md), [IPosPrinterJob.PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintLine(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintLine + +## -description +Adds an instruction to the print job to print a line of text on the slip printer station. + +## -parameters +### -param data +The line of text to print. + +## -remarks + +## -examples + +## -see-also +[PrintLine](slipprintjob_printline_144630531.md), [IPosPrinterJob.PrintLine(String)](iposprinterjob_printline_1360992803.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printline_144630531.md b/windows.devices.pointofservice/slipprintjob_printline_144630531.md index a2aa622625..0d0abe10ae 100644 --- a/windows.devices.pointofservice/slipprintjob_printline_144630531.md +++ b/windows.devices.pointofservice/slipprintjob_printline_144630531.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintLine --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintLine ## -description Adds an instruction to the print job to print a newline character on the slip printer station. ## -remarks ## -examples ## -see-also [PrintLine(String)](slipprintjob_printline_1360992803.md), [IPosPrinterJob.PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintLine +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintLine + +## -description +Adds an instruction to the print job to print a newline character on the slip printer station. + +## -remarks + +## -examples + +## -see-also +[PrintLine(String)](slipprintjob_printline_1360992803.md), [IPosPrinterJob.PrintLine](iposprinterjob_printline_144630531.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_printsavedbitmap_1902948304.md b/windows.devices.pointofservice/slipprintjob_printsavedbitmap_1902948304.md index a84ef3bb32..6ec1861b39 100644 --- a/windows.devices.pointofservice/slipprintjob_printsavedbitmap_1902948304.md +++ b/windows.devices.pointofservice/slipprintjob_printsavedbitmap_1902948304.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintSavedBitmap(System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.PrintSavedBitmap ## -description Adds an instruction to the print job to print a bitmap on the slip printer station by using the information that you saved about the bitmap and how to print it when you called the [SetBitmap](slipprintjob_setbitmap.md) or [SetCustomAlignedBitmap](slipprintjob_setcustomalignedbitmap.md) method. ## -parameters ### -param bitmapNumber The number that you assigned to the bitmap that you want to print when you called [SetBitmap](slipprintjob_setbitmap.md) or [SetCustomAlignedBitmap](slipprintjob_setcustomalignedbitmap.md). ## -remarks The bitmap rotation setting that you specify by calling [SlipPrintJob.SetPrintRotation](slipprintjob_setprintrotation.md) may not apply to bitmaps that you saved to the printer. ## -examples ## -see-also [SetBitmap](slipprintjob_setbitmap.md), [SetCustomAlignedBitmap](slipprintjob_setcustomalignedbitmap.md), [SlipPrintJob.SetPrintRotation](slipprintjob_setprintrotation.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.PrintSavedBitmap(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.PrintSavedBitmap + +## -description +Adds an instruction to the print job to print a bitmap on the slip printer station by using the information that you saved about the bitmap and how to print it when you called the [SetBitmap](slipprintjob_setbitmap.md) or [SetCustomAlignedBitmap](slipprintjob_setcustomalignedbitmap.md) method. + +## -parameters +### -param bitmapNumber +The number that you assigned to the bitmap that you want to print when you called [SetBitmap](slipprintjob_setbitmap.md) or [SetCustomAlignedBitmap](slipprintjob_setcustomalignedbitmap.md). + +## -remarks +The bitmap rotation setting that you specify by calling [SlipPrintJob.SetPrintRotation](slipprintjob_setprintrotation.md) may not apply to bitmaps that you saved to the printer. + +## -examples + +## -see-also +[SetBitmap](slipprintjob_setbitmap.md), [SetCustomAlignedBitmap](slipprintjob_setcustomalignedbitmap.md), [SlipPrintJob.SetPrintRotation](slipprintjob_setprintrotation.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_setbarcoderotation_1140294829.md b/windows.devices.pointofservice/slipprintjob_setbarcoderotation_1140294829.md index 1986ea2540..ff31833160 100644 --- a/windows.devices.pointofservice/slipprintjob_setbarcoderotation_1140294829.md +++ b/windows.devices.pointofservice/slipprintjob_setbarcoderotation_1140294829.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetBarcodeRotation(Windows.Devices.PointOfService.PosPrinterRotation) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetBarcodeRotation ## -description Sets the rotation of the barcode on the page on the slip printer station. ## -parameters ### -param value The rotation of the barcode on the page on the slip printer station. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetBarcodeRotation(Windows.Devices.PointOfService.PosPrinterRotation) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetBarcodeRotation + +## -description +Sets the rotation of the barcode on the page on the slip printer station. + +## -parameters +### -param value +The rotation of the barcode on the page on the slip printer station. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/slipprintjob_setbitmap_489195165.md b/windows.devices.pointofservice/slipprintjob_setbitmap_489195165.md index e9d78f684e..cbccddad46 100644 --- a/windows.devices.pointofservice/slipprintjob_setbitmap_489195165.md +++ b/windows.devices.pointofservice/slipprintjob_setbitmap_489195165.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetBitmap ## -description Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ## -remarks If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](slipprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](slipprintjob_setcustomalignedbitmap_1547903367.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetBitmap + +## -description +Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +## -remarks +If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](slipprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](slipprintjob_setcustomalignedbitmap_1547903367.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_setbitmap_49606997.md b/windows.devices.pointofservice/slipprintjob_setbitmap_49606997.md index a9045cb179..50679b0eca 100644 --- a/windows.devices.pointofservice/slipprintjob_setbitmap_49606997.md +++ b/windows.devices.pointofservice/slipprintjob_setbitmap_49606997.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetBitmap ## -description Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignment An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](slipprintjob_setbitmap_489195165.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](slipprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](slipprintjob_setcustomalignedbitmap_1547903367.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,Windows.Devices.PointOfService.PosPrinterAlignment,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetBitmap + +## -description +Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignment +An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks +If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer. + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](slipprintjob_setbitmap_489195165.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](slipprintjob_setcustomalignedbitmap_1134515791.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](slipprintjob_setcustomalignedbitmap_1547903367.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PosPrinterAlignment](posprinteralignment.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1134515791.md b/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1134515791.md index 871f53948a..45e892bf13 100644 --- a/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1134515791.md +++ b/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1134515791.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap ## -description Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](slipprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](slipprintjob_setcustomalignedbitmap_1547903367.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap + +## -description +Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](slipprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)](slipprintjob_setcustomalignedbitmap_1547903367.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1547903367.md b/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1547903367.md index 2e4d2a8467..ae8edfeb31 100644 --- a/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1547903367.md +++ b/windows.devices.pointofservice/slipprintjob_setcustomalignedbitmap_1547903367.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap ## -description Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. ## -parameters ### -param bitmapNumber The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. ### -param bitmap Information about the bitmap that you want to print. ### -param alignmentDistance The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ### -param width The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. ## -remarks ## -examples ## -see-also [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](slipprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](slipprintjob_setcustomalignedbitmap_1134515791.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap(System.UInt32,Windows.Graphics.Imaging.BitmapFrame,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetCustomAlignedBitmap + +## -description +Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the slip printer station, so that you can use the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method to add that information to the print job later. + +## -parameters +### -param bitmapNumber +The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) method later to add the print instructions to the print job. + +### -param bitmap +Information about the bitmap that you want to print. + +### -param alignmentDistance +The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +### -param width +The width to use for printing the bitmap, expressed in the unit of measurement indicated by the [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md) property. + +## -remarks + +## -examples + +## -see-also +[SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)](slipprintjob_setbitmap_489195165.md), [SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)](slipprintjob_setbitmap_49606997.md), [SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)](slipprintjob_setcustomalignedbitmap_1134515791.md), [ClaimedPosPrinter.MapMode](claimedposprinter_mapmode.md), [PrintSavedBitmap](slipprintjob_printsavedbitmap.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_setprintarea_1895383025.md b/windows.devices.pointofservice/slipprintjob_setprintarea_1895383025.md index 84ea95b0e1..0db4d25cb4 100644 --- a/windows.devices.pointofservice/slipprintjob_setprintarea_1895383025.md +++ b/windows.devices.pointofservice/slipprintjob_setprintarea_1895383025.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetPrintArea(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetPrintArea ## -description Sets the area of the page on which the slip printer station can print the job. ## -parameters ### -param value The area of the page on which the slip printer station can print the job. ## -remarks When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called [SlipPrintJob.SetPrintArea](slipprintjob_setprintarea.md). ## -examples ## -see-also [IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md), [SlipPrinterCapabilities.IsPrintAreaSupported](slipprintercapabilities_isprintareasupported.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetPrintArea(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetPrintArea + +## -description +Sets the area of the page on which the slip printer station can print the job. + +## -parameters +### -param value +The area of the page on which the slip printer station can print the job. + +## -remarks +When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called [SlipPrintJob.SetPrintArea](slipprintjob_setprintarea.md). + +## -examples + +## -see-also +[IReceiptOrSlipJob.SetPrintArea](ireceiptorslipjob_setprintarea.md), [ClaimedSlipPrinter.PrintArea](claimedslipprinter_printarea.md), [SlipPrinterCapabilities.IsPrintAreaSupported](slipprintercapabilities_isprintareasupported.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/slipprintjob_setprintrotation_513865495.md b/windows.devices.pointofservice/slipprintjob_setprintrotation_513865495.md index 70417f02e6..d491572a94 100644 --- a/windows.devices.pointofservice/slipprintjob_setprintrotation_513865495.md +++ b/windows.devices.pointofservice/slipprintjob_setprintrotation_513865495.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetPrintRotation(Windows.Devices.PointOfService.PosPrinterRotation,System.Boolean) --api-type: winrt method ---- # Windows.Devices.PointOfService.SlipPrintJob.SetPrintRotation ## -description Sets the rotation of the text or image on the page on the slip printer station. ## -parameters ### -param value The rotation of the text or image on the page. ### -param includeBitmaps Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to [PrintBitmap](slipprintjob_printbitmap.md), and may not apply to saved bitmaps that you print using [PrintSavedBitmap](slipprintjob_printsavedbitmap.md). ## -remarks This rotation setting persists beyond the current print job. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.PointOfService.SlipPrintJob.SetPrintRotation(Windows.Devices.PointOfService.PosPrinterRotation,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.SlipPrintJob.SetPrintRotation + +## -description +Sets the rotation of the text or image on the page on the slip printer station. + +## -parameters +### -param value +The rotation of the text or image on the page. + +### -param includeBitmaps +Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to [PrintBitmap](slipprintjob_printbitmap.md), and may not apply to saved bitmaps that you print using [PrintSavedBitmap](slipprintjob_printsavedbitmap.md). + +## -remarks +This rotation setting persists beyond the current print job. + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/unifiedposerrordata.md b/windows.devices.pointofservice/unifiedposerrordata.md index 9df983596b..945b20f40e 100644 --- a/windows.devices.pointofservice/unifiedposerrordata.md +++ b/windows.devices.pointofservice/unifiedposerrordata.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.PointOfService.UnifiedPosErrorData --api-type: winrt class ---- # Windows.Devices.PointOfService.UnifiedPosErrorData ## -description Provides error information. ## -remarks This object is accessed when you retrieve the ErrorData property of the [BarcodeScannerErrorOccurredEventArgs](barcodescannererroroccurredeventargs.md) or [MagneticStripeReaderErrorOccurredEventArgs](magneticstripereadererroroccurredeventargs.md) object. ## -examples ## -see-also [BarcodeScannerErrorOccurredEventArgs.ErrorData](barcodescannererroroccurredeventargs_errordata.md), [MagneticStripeReaderErrorOccurredEventArgs.ErrorData](magneticstripereadererroroccurredeventargs_errordata.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.PointOfService.UnifiedPosErrorData +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.UnifiedPosErrorData + +## -description +Provides error information. + +## -remarks +This object is accessed when you retrieve the ErrorData property of the [BarcodeScannerErrorOccurredEventArgs](barcodescannererroroccurredeventargs.md) or [MagneticStripeReaderErrorOccurredEventArgs](magneticstripereadererroroccurredeventargs.md) object. + +## -examples + +## -see-also +[BarcodeScannerErrorOccurredEventArgs.ErrorData](barcodescannererroroccurredeventargs_errordata.md), [MagneticStripeReaderErrorOccurredEventArgs.ErrorData](magneticstripereadererroroccurredeventargs_errordata.md) \ No newline at end of file diff --git a/windows.devices.pointofservice/unifiedposerrordata_extendedreason.md b/windows.devices.pointofservice/unifiedposerrordata_extendedreason.md index b6a3c38cc7..904f8b45ec 100644 --- a/windows.devices.pointofservice/unifiedposerrordata_extendedreason.md +++ b/windows.devices.pointofservice/unifiedposerrordata_extendedreason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.ExtendedReason --api-type: winrt property ---- # Windows.Devices.PointOfService.UnifiedPosErrorData.ExtendedReason ## -description Gets the vendor specific error information. ## -property-value The vendor specific error information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.ExtendedReason +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.UnifiedPosErrorData.ExtendedReason + +## -description +Gets the vendor specific error information. + +## -property-value +The vendor specific error information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/unifiedposerrordata_message.md b/windows.devices.pointofservice/unifiedposerrordata_message.md index 16ae070314..c4b7a4da66 100644 --- a/windows.devices.pointofservice/unifiedposerrordata_message.md +++ b/windows.devices.pointofservice/unifiedposerrordata_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.Message --api-type: winrt property ---- # Windows.Devices.PointOfService.UnifiedPosErrorData.Message ## -description Gets the error message. ## -property-value The error message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.Message +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.UnifiedPosErrorData.Message + +## -description +Gets the error message. + +## -property-value +The error message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/unifiedposerrordata_reason.md b/windows.devices.pointofservice/unifiedposerrordata_reason.md index 5e05ec21f8..9bac75b492 100644 --- a/windows.devices.pointofservice/unifiedposerrordata_reason.md +++ b/windows.devices.pointofservice/unifiedposerrordata_reason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.Reason --api-type: winrt property ---- # Windows.Devices.PointOfService.UnifiedPosErrorData.Reason ## -description Gets the cause of the error. ## -property-value The cause of the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.Reason +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.UnifiedPosErrorData.Reason + +## -description +Gets the cause of the error. + +## -property-value +The cause of the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pointofservice/unifiedposerrordata_severity.md b/windows.devices.pointofservice/unifiedposerrordata_severity.md index f5ae72ec1d..61eb95fbe0 100644 --- a/windows.devices.pointofservice/unifiedposerrordata_severity.md +++ b/windows.devices.pointofservice/unifiedposerrordata_severity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.Severity --api-type: winrt property ---- # Windows.Devices.PointOfService.UnifiedPosErrorData.Severity ## -description Gets the error severity. ## -property-value The error severity. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.PointOfService.UnifiedPosErrorData.Severity +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.UnifiedPosErrorData.Severity + +## -description +Gets the error severity. + +## -property-value +The error severity. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.portable/storagedevice_fromid_114571398.md b/windows.devices.portable/storagedevice_fromid_114571398.md index a50280cf9e..0b1409add8 100644 --- a/windows.devices.portable/storagedevice_fromid_114571398.md +++ b/windows.devices.portable/storagedevice_fromid_114571398.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.Portable.StorageDevice.FromId(System.String) --api-type: winrt method ---- # Windows.Devices.Portable.StorageDevice.FromId ## -description Gets a [StorageFolder](../windows.storage/storagefolder.md) object from a DeviceInformation Id for a removable storage device. ## -parameters ### -param deviceId The [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID that identifies the removable storage device. This id can be retrieved from [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) or the [DeviceInformationId](../windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md) property of the AutoPlay device event arguments. For more information, see [Quickstart: Register an app for an AutoPlay device](http://msdn.microsoft.com/library/6a3b8910-ebec-427b-bcba-7ce3fa3f878a). In order for [FromId](storagedevice_fromid.md) to succeed, the app must declare both the removableStorage capability as shown in the [App capability declarations](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) and file type associations for the files it wishes to access on the device as shown in [How to handle file activation](http://msdn.microsoft.com/library/cd540a91-5276-4a89-b517-85cea866172c). For more information, see the [Removable Storage sample](http://go.microsoft.com/fwlink/p/?LinkID=242035). ## -returns The storage folder object that represents the removable storage device and provides access to content on the device. ## -remarks Pass the selector string from [GetDeviceSelector](storagedevice_getdeviceselector.md) to the Windows.Devices.Enumeration API to get a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects representing storage devices. Select the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the storage you want to access, and use its [Id](../windows.devices.enumeration/deviceinformation_id.md) property as the *deviceInformationId* parameter to [FromId](storagedevice_fromid.md). ## -examples ## -see-also [DeviceInformation](../windows.devices.enumeration/deviceinformation.md), [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md), [Enumerating Common Devices](http://msdn.microsoft.com/library/2deddbba-de46-409e-ac76-87419cb03eba) ## -capabilities removableStorage \ No newline at end of file +--- +-api-id: M:Windows.Devices.Portable.StorageDevice.FromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Portable.StorageDevice.FromId + +## -description +Gets a [StorageFolder](../windows.storage/storagefolder.md) object from a DeviceInformation Id for a removable storage device. + +## -parameters +### -param deviceId +The [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID that identifies the removable storage device. This id can be retrieved from [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) or the [DeviceInformationId](../windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md) property of the AutoPlay device event arguments. For more information, see [Quickstart: Register an app for an AutoPlay device](http://msdn.microsoft.com/library/6a3b8910-ebec-427b-bcba-7ce3fa3f878a). In order for [FromId](storagedevice_fromid.md) to succeed, the app must declare both the removableStorage capability as shown in the [App capability declarations](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) and file type associations for the files it wishes to access on the device as shown in [How to handle file activation](http://msdn.microsoft.com/library/cd540a91-5276-4a89-b517-85cea866172c). For more information, see the [Removable Storage sample](http://go.microsoft.com/fwlink/p/?LinkID=242035). + +## -returns +The storage folder object that represents the removable storage device and provides access to content on the device. + +## -remarks +Pass the selector string from [GetDeviceSelector](storagedevice_getdeviceselector.md) to the Windows.Devices.Enumeration API to get a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects representing storage devices. Select the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the storage you want to access, and use its [Id](../windows.devices.enumeration/deviceinformation_id.md) property as the *deviceInformationId* parameter to [FromId](storagedevice_fromid.md). + +## -examples + +## -see-also +[DeviceInformation](../windows.devices.enumeration/deviceinformation.md), [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md), [Enumerating Common Devices](http://msdn.microsoft.com/library/2deddbba-de46-409e-ac76-87419cb03eba) + +## -capabilities +removableStorage \ No newline at end of file diff --git a/windows.devices.portable/storagedevice_getdeviceselector_838466080.md b/windows.devices.portable/storagedevice_getdeviceselector_838466080.md index 7ccd6ada71..15aead8ff6 100644 --- a/windows.devices.portable/storagedevice_getdeviceselector_838466080.md +++ b/windows.devices.portable/storagedevice_getdeviceselector_838466080.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Portable.StorageDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Portable.StorageDevice.GetDeviceSelector ## -description An Advanced Query Syntax (AQS) string for identifying removable storage devices. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. ## -returns An AQS string for identifying storage devices. ## -remarks ## -examples ## -see-also [Removable Storage Sample](http://go.microsoft.com/fwlink/p/?linkid=242035) ## -capabilities removableStorage \ No newline at end of file +--- +-api-id: M:Windows.Devices.Portable.StorageDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Portable.StorageDevice.GetDeviceSelector + +## -description +An Advanced Query Syntax (AQS) string for identifying removable storage devices. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. + +## -returns +An AQS string for identifying storage devices. + +## -remarks + +## -examples + +## -see-also +[Removable Storage Sample](http://go.microsoft.com/fwlink/p/?linkid=242035) + +## -capabilities +removableStorage \ No newline at end of file diff --git a/windows.devices.power/battery.md b/windows.devices.power/battery.md index 1ccfb831bd..e44b7431a8 100644 --- a/windows.devices.power/battery.md +++ b/windows.devices.power/battery.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Power.Battery --api-type: winrt class ---- # Windows.Devices.Power.Battery ## -description Provides information about a battery controller that is currently connected to the device. For more info, see [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2). ## -remarks In this context, *device* refers to the hardware that your app is running on. *Battery controller* refers to the electronics that interface between the physical battery and the operating system. A battery controller appears in Device Manager as a "Battery" under the **Batteries** node. Depending on the device, it may be possible to remove the physical battery while the device remains running. For example, a laptop that's plugged into A/C power. In that case, if the battery controller were part of the laptop enclosure, you could potentially create a [Battery](battery.md) object when no battery is connected to the device. However, if the battery controller resided on the physical battery, it would no longer be visible to the operating system and therefore you could not create a corresponding [Battery](battery.md) object for an individual battery. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Power.Battery +-api-type: winrt class +--- + + + +# Windows.Devices.Power.Battery + +## -description +Provides information about a battery controller that is currently connected to the device. For more info, see [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2). + +## -remarks +In this context, *device* refers to the hardware that your app is running on. *Battery controller* refers to the electronics that interface between the physical battery and the operating system. A battery controller appears in Device Manager as a "Battery" under the **Batteries** node. + +Depending on the device, it may be possible to remove the physical battery while the device remains running. For example, a laptop that's plugged into A/C power. In that case, if the battery controller were part of the laptop enclosure, you could potentially create a [Battery](battery.md) object when no battery is connected to the device. However, if the battery controller resided on the physical battery, it would no longer be visible to the operating system and therefore you could not create a corresponding [Battery](battery.md) object for an individual battery. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/battery_aggregatebattery.md b/windows.devices.power/battery_aggregatebattery.md index a5a8541349..8641bfb530 100644 --- a/windows.devices.power/battery_aggregatebattery.md +++ b/windows.devices.power/battery_aggregatebattery.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Power.Battery.AggregateBattery --api-type: winrt property ---- # Windows.Devices.Power.Battery.AggregateBattery ## -description Gets a [Battery](battery.md) object that represents all battery controllers connected to the device. ## -property-value A [Battery](battery.md) object that represents overall battery power. ## -remarks When created with [AggregateBattery](battery_aggregatebattery.md), the [Battery](battery.md) object represents an aggregate of all battery controllers connected to the device. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Power.Battery.AggregateBattery +-api-type: winrt property +--- + + + +# Windows.Devices.Power.Battery.AggregateBattery + +## -description +Gets a [Battery](battery.md) object that represents all battery controllers connected to the device. + +## -property-value +A [Battery](battery.md) object that represents overall battery power. + +## -remarks +When created with [AggregateBattery](battery_aggregatebattery.md), the [Battery](battery.md) object represents an aggregate of all battery controllers connected to the device. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/battery_deviceid.md b/windows.devices.power/battery_deviceid.md index a449be61f3..06ba2be5a7 100644 --- a/windows.devices.power/battery_deviceid.md +++ b/windows.devices.power/battery_deviceid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Power.Battery.DeviceId --api-type: winrt property ---- # Windows.Devices.Power.Battery.DeviceId ## -description Gets the identifier (ID) for an individual battery controller. ## -property-value The battery controller identifier (ID). ## -remarks When the [Battery](battery.md) object represents an individual battery controller, this property value can be used with the [FromIdAsync](battery_fromidasync.md) method to re-create an object that represents the same battery controller (if it's still connected to the device). When the Battery object is an aggregate of battery controllers, this property is equal to "`AggregateBattery` ". ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Power.Battery.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Power.Battery.DeviceId + +## -description +Gets the identifier (ID) for an individual battery controller. + +## -property-value +The battery controller identifier (ID). + +## -remarks +When the [Battery](battery.md) object represents an individual battery controller, this property value can be used with the [FromIdAsync](battery_fromidasync.md) method to re-create an object that represents the same battery controller (if it's still connected to the device). When the Battery object is an aggregate of battery controllers, this property is equal to "`AggregateBattery` ". + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/battery_fromidasync_1322863552.md b/windows.devices.power/battery_fromidasync_1322863552.md index c090ef23ed..0aaaa39c84 100644 --- a/windows.devices.power/battery_fromidasync_1322863552.md +++ b/windows.devices.power/battery_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Power.Battery.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Power.Battery.FromIdAsync ## -description Gets a [Battery](battery.md) object that represents an individual battery controller connected to the device. ## -parameters ### -param deviceId The device ID of the battery controller ([DeviceId](battery_deviceid.md)). ## -returns A [Battery](battery.md) object that corresponds to the specified battery controller. ## -remarks [FromIdAsync](battery_fromidasync.md) will return null if the battery controller does not exist and the *deviceId* value is well-formed. If the *deviceId* value is not well-formed, such as "`AggregateBattery`," then the method will fail with `STATUS_OBJECT_NAME_INVALID`. You can use a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for a battery controller to use that object's [Id](../windows.devices.enumeration/deviceinformation_id.md) property value as the *deviceId* parameter in [FromIdAsync](battery_fromidasync.md) to create a [Battery](battery.md) object ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Power.Battery.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Power.Battery.FromIdAsync + +## -description +Gets a [Battery](battery.md) object that represents an individual battery controller connected to the device. + +## -parameters +### -param deviceId +The device ID of the battery controller ([DeviceId](battery_deviceid.md)). + +## -returns +A [Battery](battery.md) object that corresponds to the specified battery controller. + +## -remarks +[FromIdAsync](battery_fromidasync.md) will return null if the battery controller does not exist and the *deviceId* value is well-formed. If the *deviceId* value is not well-formed, such as "`AggregateBattery`," then the method will fail with `STATUS_OBJECT_NAME_INVALID`. + +You can use a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for a battery controller to use that object's [Id](../windows.devices.enumeration/deviceinformation_id.md) property value as the *deviceId* parameter in [FromIdAsync](battery_fromidasync.md) to create a [Battery](battery.md) object + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/battery_getdeviceselector_838466080.md b/windows.devices.power/battery_getdeviceselector_838466080.md index 9164d0a9d8..086518acbc 100644 --- a/windows.devices.power/battery_getdeviceselector_838466080.md +++ b/windows.devices.power/battery_getdeviceselector_838466080.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Power.Battery.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Power.Battery.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that can be used to find all battery controllers that are connected to the device. ## -returns An AQS string that can be used to find all battery controllers connected to the device. ## -remarks Use the AQS string returned by [GetDeviceSelector](battery_getdeviceselector.md) with the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) APIs to find all battery controllers that are connected to the device. See [FromIdAsync](battery_fromidasync.md) for information on how to create a [Battery](battery.md) object. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Power.Battery.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Power.Battery.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that can be used to find all battery controllers that are connected to the device. + +## -returns +An AQS string that can be used to find all battery controllers connected to the device. + +## -remarks +Use the AQS string returned by [GetDeviceSelector](battery_getdeviceselector.md) with the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) APIs to find all battery controllers that are connected to the device. See [FromIdAsync](battery_fromidasync.md) for information on how to create a [Battery](battery.md) object. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/battery_getreport_610268658.md b/windows.devices.power/battery_getreport_610268658.md index 66b4cac80c..0074676dc0 100644 --- a/windows.devices.power/battery_getreport_610268658.md +++ b/windows.devices.power/battery_getreport_610268658.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Power.Battery.GetReport --api-type: winrt method ---- # Windows.Devices.Power.Battery.GetReport ## -description Gets a [BatteryReport](batteryreport.md) object that indicates the charge, capacity, and status of the battery or aggregate. ## -returns Indicates the charge, capacity, and status of the battery or aggregate. ## -remarks ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Power.Battery.GetReport +-api-type: winrt method +--- + + + +# Windows.Devices.Power.Battery.GetReport + +## -description +Gets a [BatteryReport](batteryreport.md) object that indicates the charge, capacity, and status of the battery or aggregate. + +## -returns +Indicates the charge, capacity, and status of the battery or aggregate. + +## -remarks + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/battery_reportupdated.md b/windows.devices.power/battery_reportupdated.md index 30eab0af08..636526c3c5 100644 --- a/windows.devices.power/battery_reportupdated.md +++ b/windows.devices.power/battery_reportupdated.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Devices.Power.Battery.ReportUpdated --api-type: winrt event ---- # Windows.Devices.Power.Battery.ReportUpdated ## -description Occurs when the charge, capacity, or status of a battery changes. ## -remarks The [ReportUpdated](battery_reportupdated.md) event is triggered by any change in status, charge rate, or power capacity on any of the batteries connected to the device. This typically happens immediately for status changes and periodically for all other changes. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: E:Windows.Devices.Power.Battery.ReportUpdated +-api-type: winrt event +--- + + + +# Windows.Devices.Power.Battery.ReportUpdated + +## -description + +Occurs when the charge, capacity, or status of a battery changes. + +## -remarks +The [ReportUpdated](battery_reportupdated.md) event is triggered by any change in status, charge rate, or power capacity on any of the batteries connected to the device. This typically happens immediately for status changes and periodically for all other changes. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/batteryreport.md b/windows.devices.power/batteryreport.md index 044c45d957..bf78b594b1 100644 --- a/windows.devices.power/batteryreport.md +++ b/windows.devices.power/batteryreport.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Power.BatteryReport --api-type: winrt class ---- # Windows.Devices.Power.BatteryReport ## -description Provides properties that indicate the charge, capacity, and status of the battery. For more info, see [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2). ## -remarks All properties in [BatteryReport](batteryreport.md) will return **null** when the battery is not present or the value is not reported by the battery controller. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Power.BatteryReport +-api-type: winrt class +--- + + + +# Windows.Devices.Power.BatteryReport + +## -description +Provides properties that indicate the charge, capacity, and status of the battery. For more info, see [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2). + +## -remarks +All properties in [BatteryReport](batteryreport.md) will return **null** when the battery is not present or the value is not reported by the battery controller. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/batteryreport_chargerateinmilliwatts.md b/windows.devices.power/batteryreport_chargerateinmilliwatts.md index 856528ca9d..643b92de88 100644 --- a/windows.devices.power/batteryreport_chargerateinmilliwatts.md +++ b/windows.devices.power/batteryreport_chargerateinmilliwatts.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Power.BatteryReport.ChargeRateInMilliwatts --api-type: winrt property ---- # Windows.Devices.Power.BatteryReport.ChargeRateInMilliwatts ## -description Gets the rate that the battery is charging. ## -property-value The rate that the battery is charging in milliwatts (mW). ## -remarks This value is negative when the battery is discharging. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Power.BatteryReport.ChargeRateInMilliwatts +-api-type: winrt property +--- + + + +# Windows.Devices.Power.BatteryReport.ChargeRateInMilliwatts + +## -description +Gets the rate that the battery is charging. + +## -property-value +The rate that the battery is charging in milliwatts (mW). + +## -remarks +This value is negative when the battery is discharging. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/batteryreport_designcapacityinmilliwatthours.md b/windows.devices.power/batteryreport_designcapacityinmilliwatthours.md index a677572cef..07915c8ed1 100644 --- a/windows.devices.power/batteryreport_designcapacityinmilliwatthours.md +++ b/windows.devices.power/batteryreport_designcapacityinmilliwatthours.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Power.BatteryReport.DesignCapacityInMilliwattHours --api-type: winrt property ---- # Windows.Devices.Power.BatteryReport.DesignCapacityInMilliwattHours ## -description Gets the estimated energy capacity of a new battery of this type. ## -property-value The estimated energy capacity of a new battery of this type, in milliwatt-hours (mWh). ## -remarks This property is not supported by all battery controllers. Some battery controllers might return the same value as [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) or return no value at all. When this property is supported, the capacity ratio is the ratio of [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) to [DesignCapacityInMilliwattHours](batteryreport_designcapacityinmilliwatthours.md). [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) is used in this way because the full charge capacity typically changes with battery wear. ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Power.BatteryReport.DesignCapacityInMilliwattHours +-api-type: winrt property +--- + + + +# Windows.Devices.Power.BatteryReport.DesignCapacityInMilliwattHours + +## -description +Gets the estimated energy capacity of a new battery of this type. + +## -property-value +The estimated energy capacity of a new battery of this type, in milliwatt-hours (mWh). + +## -remarks +This property is not supported by all battery controllers. Some battery controllers might return the same value as [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) or return no value at all. + +When this property is supported, the capacity ratio is the ratio of [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) to [DesignCapacityInMilliwattHours](batteryreport_designcapacityinmilliwatthours.md). [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) is used in this way because the full charge capacity typically changes with battery wear. + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/batteryreport_fullchargecapacityinmilliwatthours.md b/windows.devices.power/batteryreport_fullchargecapacityinmilliwatthours.md index 813e8dfd50..b190101d87 100644 --- a/windows.devices.power/batteryreport_fullchargecapacityinmilliwatthours.md +++ b/windows.devices.power/batteryreport_fullchargecapacityinmilliwatthours.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Devices.Power.BatteryReport.FullChargeCapacityInMilliwattHours --api-type: winrt property ---- - - - -# Windows.Devices.Power.BatteryReport.FullChargeCapacityInMilliwattHours - -## -description -Gets the fully-charged energy capacity of the battery. - -## -property-value -The fully-charged energy capacity of the battery, in milliwatt-hours (mWh). - -> Note: Some devices report their battery capacity in milliamp-hours (mAh) instead of mWh. As a rough heuristic, if the value reported is lower than 4400 it is likely represented in mAh, otherwise it is in mWh. - -## -remarks -[FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) is used by the capacity ratio to estimate battery health. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Devices.Power.BatteryReport.FullChargeCapacityInMilliwattHours +-api-type: winrt property +--- + + + +# Windows.Devices.Power.BatteryReport.FullChargeCapacityInMilliwattHours + +## -description +Gets the fully-charged energy capacity of the battery. + +## -property-value +The fully-charged energy capacity of the battery, in milliwatt-hours (mWh). + +> Note: Some devices report their battery capacity in milliamp-hours (mAh) instead of mWh. As a rough heuristic, if the value reported is lower than 4400 it is likely represented in mAh, otherwise it is in mWh. + +## -remarks +[FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md) is used by the capacity ratio to estimate battery health. + +## -examples + +## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/batteryreport_remainingcapacityinmilliwatthours.md b/windows.devices.power/batteryreport_remainingcapacityinmilliwatthours.md index 67a766750e..6de8bc806a 100644 --- a/windows.devices.power/batteryreport_remainingcapacityinmilliwatthours.md +++ b/windows.devices.power/batteryreport_remainingcapacityinmilliwatthours.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Power.BatteryReport.RemainingCapacityInMilliwattHours --api-type: winrt property ---- # Windows.Devices.Power.BatteryReport.RemainingCapacityInMilliwattHours ## -description Gets the remaining power capacity of the battery. ## -property-value The remaining power capacity of the battery, in milliwatt-hours. ## -remarks To calculate the battery level, divide [RemainingCapacityInMilliwattHours](batteryreport_remainingcapacityinmilliwatthours.md) by [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md). ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Power.BatteryReport.RemainingCapacityInMilliwattHours +-api-type: winrt property +--- + + + +# Windows.Devices.Power.BatteryReport.RemainingCapacityInMilliwattHours + +## -description +Gets the remaining power capacity of the battery. + +## -property-value +The remaining power capacity of the battery, in milliwatt-hours. + +## -remarks +To calculate the battery level, divide [RemainingCapacityInMilliwattHours](batteryreport_remainingcapacityinmilliwatthours.md) by [FullChargeCapacityInMilliwattHours](batteryreport_fullchargecapacityinmilliwatthours.md). + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.power/batteryreport_status.md b/windows.devices.power/batteryreport_status.md index e5252fcc99..218e420e3e 100644 --- a/windows.devices.power/batteryreport_status.md +++ b/windows.devices.power/batteryreport_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Power.BatteryReport.Status --api-type: winrt property ---- # Windows.Devices.Power.BatteryReport.Status ## -description Gets a [BatteryStatus](../windows.system.power/batterystatus.md) enumeration that indicates the status of the battery. ## -property-value A [BatteryStatus](../windows.system.power/batterystatus.md) enumeration that indicates the status of the battery. ## -remarks ## -examples ## -see-also [Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Power.BatteryReport.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Power.BatteryReport.Status + +## -description +Gets a [BatteryStatus](../windows.system.power/batterystatus.md) enumeration that indicates the status of the battery. + +## -property-value +A [BatteryStatus](../windows.system.power/batterystatus.md) enumeration that indicates the status of the battery. + +## -remarks + +## -examples + +## -see-also +[Get battery information](http://msdn.microsoft.com/library/a9fb0f39-8827-420a-922d-dcee6fb9c9d2) \ No newline at end of file diff --git a/windows.devices.printers.extensions/print3dworkflow.md b/windows.devices.printers.extensions/print3dworkflow.md index d84b9b49c8..ae23755258 100644 --- a/windows.devices.printers.extensions/print3dworkflow.md +++ b/windows.devices.printers.extensions/print3dworkflow.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Printers.Extensions.Print3DWorkflow --api-type: winrt class ---- # Windows.Devices.Printers.Extensions.Print3DWorkflow ## -description Represents a customized printing experience for a 3D printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Printers.Extensions.Print3DWorkflow +-api-type: winrt class +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflow + +## -description +Represents a customized printing experience for a 3D printer. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflow_deviceid.md b/windows.devices.printers.extensions/print3dworkflow_deviceid.md index 4f20150f74..8b7feac3e9 100644 --- a/windows.devices.printers.extensions/print3dworkflow_deviceid.md +++ b/windows.devices.printers.extensions/print3dworkflow_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflow.DeviceID --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.Print3DWorkflow.DeviceID ## -description Gets the device identifier of the 3D printer. ## -property-value The device identifier of the 3D printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflow.DeviceID +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflow.DeviceID + +## -description +Gets the device identifier of the 3D printer. + +## -property-value +The device identifier of the 3D printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflow_getprintmodelpackage_1854594613.md b/windows.devices.printers.extensions/print3dworkflow_getprintmodelpackage_1854594613.md index 6914371f36..de2e037dc6 100644 --- a/windows.devices.printers.extensions/print3dworkflow_getprintmodelpackage_1854594613.md +++ b/windows.devices.printers.extensions/print3dworkflow_getprintmodelpackage_1854594613.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflow.GetPrintModelPackage --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.Print3DWorkflow.GetPrintModelPackage ## -description Gets the model of the 3D object to be printed. ## -returns The model of the 3D object to be printed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflow.GetPrintModelPackage +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflow.GetPrintModelPackage + +## -description +Gets the model of the 3D object to be printed. + +## -returns +The model of the 3D object to be printed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflow_isprintready.md b/windows.devices.printers.extensions/print3dworkflow_isprintready.md index 01a7a4fb5d..697f7c0164 100644 --- a/windows.devices.printers.extensions/print3dworkflow_isprintready.md +++ b/windows.devices.printers.extensions/print3dworkflow_isprintready.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflow.IsPrintReady --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.Print3DWorkflow.IsPrintReady ## -description Gets or sets a value that indicates the 3D object is ready for printing and no further user interaction is required. ## -property-value **true** if the 3D object is ready for printing; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflow.IsPrintReady +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflow.IsPrintReady + +## -description +Gets or sets a value that indicates the 3D object is ready for printing and no further user interaction is required. + +## -property-value +**true** if the 3D object is ready for printing; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflow_printerchanged.md b/windows.devices.printers.extensions/print3dworkflow_printerchanged.md index 6fb4cfc033..cdae2b1d57 100644 --- a/windows.devices.printers.extensions/print3dworkflow_printerchanged.md +++ b/windows.devices.printers.extensions/print3dworkflow_printerchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Printers.Extensions.Print3DWorkflow.PrinterChanged --api-type: winrt event ---- # Windows.Devices.Printers.Extensions.Print3DWorkflow.PrinterChanged ## -description Occurs when the user changes the designated 3D printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Printers.Extensions.Print3DWorkflow.PrinterChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflow.PrinterChanged + +## -description +Occurs when the user changes the designated 3D printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflow_printrequested.md b/windows.devices.printers.extensions/print3dworkflow_printrequested.md index 4f75c9b669..147b1e9d56 100644 --- a/windows.devices.printers.extensions/print3dworkflow_printrequested.md +++ b/windows.devices.printers.extensions/print3dworkflow_printrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Printers.Extensions.Print3DWorkflow.PrintRequested --api-type: winrt event ---- # Windows.Devices.Printers.Extensions.Print3DWorkflow.PrintRequested ## -description Occurs when the user initiates printing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Printers.Extensions.Print3DWorkflow.PrintRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflow.PrintRequested + +## -description +Occurs when the user initiates printing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs.md b/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs.md index 661d8eeb52..2fe55bb981 100644 --- a/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs.md +++ b/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs ## -description Provides data about the printer change to the app that initiated the change. ## -remarks This class is instantiated automatically when the [PrinterChanged](print3dworkflow_printerchanged.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs + +## -description +Provides data about the printer change to the app that initiated the change. + +## -remarks +This class is instantiated automatically when the [PrinterChanged](print3dworkflow_printerchanged.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs_newdeviceid.md b/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs_newdeviceid.md index 092a839e3c..77d0e2a1d5 100644 --- a/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs_newdeviceid.md +++ b/windows.devices.printers.extensions/print3dworkflowprinterchangedeventargs_newdeviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs.NewDeviceId --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs.NewDeviceId ## -description Gets the device identifier of the new 3D printer. ## -property-value Device identifier of the new 3D printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs.NewDeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrinterChangedEventArgs.NewDeviceId + +## -description +Gets the device identifier of the new 3D printer. + +## -property-value +Device identifier of the new 3D printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs.md b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs.md index 896897122a..ae6ad8a4a4 100644 --- a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs.md +++ b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs ## -description Provides data about the print request to the app that initiated the request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs + +## -description +Provides data about the print request to the app that initiated the request. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setextendedstatus_690262532.md b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setextendedstatus_690262532.md index f4b2ac1ca0..202ec00d33 100644 --- a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setextendedstatus_690262532.md +++ b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setextendedstatus_690262532.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetExtendedStatus(Windows.Devices.Printers.Extensions.Print3DWorkflowDetail) --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetExtendedStatus ## -description Sets the extended status of the print request. ## -parameters ### -param value The extended status of the print request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetExtendedStatus(Windows.Devices.Printers.Extensions.Print3DWorkflowDetail) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetExtendedStatus + +## -description +Sets the extended status of the print request. + +## -parameters +### -param value +The extended status of the print request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsource_1677558739.md b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsource_1677558739.md index b4c66d6311..d92f42d40d 100644 --- a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsource_1677558739.md +++ b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsource_1677558739.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSource(System.Object) --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSource ## -description Sets the latest model data, including any updates made by the [Print3DWorkflow](print3dworkflow.md). ## -parameters ### -param source The latest model data, including any updates made by the [Print3DWorkflow](print3dworkflow.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSource(System.Object) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSource + +## -description +Sets the latest model data, including any updates made by the [Print3DWorkflow](print3dworkflow.md). + +## -parameters +### -param source +The latest model data, including any updates made by the [Print3DWorkflow](print3dworkflow.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsourcechanged_912762290.md b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsourcechanged_912762290.md index 65894abbe6..42de3349ed 100644 --- a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsourcechanged_912762290.md +++ b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_setsourcechanged_912762290.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSourceChanged(System.Boolean) --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSourceChanged ## -description Indicates if the data model has been updated by the [Print3DWorkflow](print3dworkflow.md). ## -parameters ### -param value Returns **true** if the data model has been updated; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSourceChanged(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.SetSourceChanged + +## -description +Indicates if the data model has been updated by the [Print3DWorkflow](print3dworkflow.md). + +## -parameters +### -param value +Returns **true** if the data model has been updated; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_status.md b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_status.md index b95efc105b..91cda9ecd9 100644 --- a/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_status.md +++ b/windows.devices.printers.extensions/print3dworkflowprintrequestedeventargs_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.Status ## -description Gets the status of the print request. ## -property-value The status of the print request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.Print3DWorkflowPrintRequestedEventArgs.Status + +## -description +Gets the status of the print request. + +## -property-value +The status of the print request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printextensioncontext_fromdeviceid_1454676498.md b/windows.devices.printers.extensions/printextensioncontext_fromdeviceid_1454676498.md index 1d789255de..08f76e2fe6 100644 --- a/windows.devices.printers.extensions/printextensioncontext_fromdeviceid_1454676498.md +++ b/windows.devices.printers.extensions/printextensioncontext_fromdeviceid_1454676498.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.PrintExtensionContext.FromDeviceId(System.String) --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.PrintExtensionContext.FromDeviceId ## -description Gets the context for the printer extension object based on the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID. ## -parameters ### -param deviceId The device information ID for the print device. ## -returns Pointer to the context. ## -remarks ## -examples ## -see-also [ for Printers](http://msdn.microsoft.com/library/windows/hardware/br259129) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.PrintExtensionContext.FromDeviceId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.PrintExtensionContext.FromDeviceId + +## -description +Gets the context for the printer extension object based on the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID. + +## -parameters +### -param deviceId +The device information ID for the print device. + +## -returns +Pointer to the context. + +## -remarks + +## -examples + +## -see-also +[ for Printers](http://msdn.microsoft.com/library/windows/hardware/br259129) \ No newline at end of file diff --git a/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md b/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md index 9ce609ccc9..8b72c32d4e 100644 --- a/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md +++ b/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData ## -description Gets or sets the event data for a print notification event. ## -property-value The print notification event data. ## -remarks The property is nested XML that is formatted as string. To get this property, parse for the Bidi request and response schema that is embedded in an ``, following the AsyncUI's [balloonUI](XREF:TODO:print.balloonui) element message, which contains the [action](XREF:TODO:print.action) element. The [action](XREF:TODO:print.action) element contains the `` where the Bidi response schema is found. Examine the Bidi response to determine the cause of the event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData + +## -description +Gets or sets the event data for a print notification event. + +## -property-value +The print notification event data. + +## -remarks +The property is nested XML that is formatted as string. To get this property, parse for the Bidi request and response schema that is embedded in an ``, following the AsyncUI's [balloonUI](XREF:TODO:print.balloonui) element message, which contains the [action](XREF:TODO:print.action) element. The [action](XREF:TODO:print.action) element contains the `` where the Bidi response schema is found. Examine the Bidi response to determine the cause of the event. + + + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printnotificationeventdetails_printername.md b/windows.devices.printers.extensions/printnotificationeventdetails_printername.md index 992a090933..ca88ef2e1b 100644 --- a/windows.devices.printers.extensions/printnotificationeventdetails_printername.md +++ b/windows.devices.printers.extensions/printnotificationeventdetails_printername.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.PrinterName --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.PrinterName ## -description Gets the name of the print device associated with the print notification. ## -property-value The print device name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.PrinterName +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.PrinterName + +## -description +Gets the name of the print device associated with the print notification. + +## -property-value +The print device name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfiguration_printerextensioncontext.md b/windows.devices.printers.extensions/printtaskconfiguration_printerextensioncontext.md index 8e4d7cf2aa..fb136ed839 100644 --- a/windows.devices.printers.extensions/printtaskconfiguration_printerextensioncontext.md +++ b/windows.devices.printers.extensions/printtaskconfiguration_printerextensioncontext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.PrintTaskConfiguration.PrinterExtensionContext --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.PrintTaskConfiguration.PrinterExtensionContext ## -description Gets the context for the print task extension. ## -property-value The context for the print task extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.PrintTaskConfiguration.PrinterExtensionContext +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfiguration.PrinterExtensionContext + +## -description +Gets the context for the print task extension. + +## -property-value +The context for the print task extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfiguration_saverequested.md b/windows.devices.printers.extensions/printtaskconfiguration_saverequested.md index df65165309..6756a81536 100644 --- a/windows.devices.printers.extensions/printtaskconfiguration_saverequested.md +++ b/windows.devices.printers.extensions/printtaskconfiguration_saverequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Printers.Extensions.PrintTaskConfiguration.SaveRequested --api-type: winrt event ---- # Windows.Devices.Printers.Extensions.PrintTaskConfiguration.SaveRequested ## -description Raised by the print window for your app to notify the device app that the print ticket must be updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Printers.Extensions.PrintTaskConfiguration.SaveRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfiguration.SaveRequested + +## -description +Raised by the print window for your app to notify the device app that the print ticket must be updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_cancel_1985564044.md b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_cancel_1985564044.md index c7a65dc47b..e71968c97d 100644 --- a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_cancel_1985564044.md +++ b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_cancel_1985564044.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Cancel --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Cancel ## -description Called by the device app to cancel the client's request to save the print task configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Cancel + +## -description +Called by the device app to cancel the client's request to save the print task configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_deadline.md b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_deadline.md index 6ddcba3a21..d857d3a286 100644 --- a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_deadline.md +++ b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Deadline --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Deadline ## -description Gets the date-time object that provides the deadline information for the print task. ## -property-value The deadline for the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Deadline +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Deadline + +## -description +Gets the date-time object that provides the deadline information for the print task. + +## -property-value +The deadline for the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_getdeferral_254836512.md b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_getdeferral_254836512.md index 66f7421a1f..5628aa27b3 100644 --- a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_getdeferral_254836512.md +++ b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.GetDeferral --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.GetDeferral ## -description Called by the device app when it has to complete some asynchronous tasks before it can save the print task configuration information. ## -returns The object that represents the deferral for the print task configuration save request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.GetDeferral + +## -description +Called by the device app when it has to complete some asynchronous tasks before it can save the print task configuration information. + +## -returns +The object that represents the deferral for the print task configuration save request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_save_869409274.md b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_save_869409274.md index abbca64487..63deacba00 100644 --- a/windows.devices.printers.extensions/printtaskconfigurationsaverequest_save_869409274.md +++ b/windows.devices.printers.extensions/printtaskconfigurationsaverequest_save_869409274.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Save(System.Object) --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Save ## -description Called by the device app to save the print task configuration. ## -parameters ### -param printerExtensionContext The object that represents the print task extension context. ## -remarks ## -examples ## -see-also [printerExtensionContext](printtaskconfiguration_printerextensioncontext.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Save(System.Object) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest.Save + +## -description +Called by the device app to save the print task configuration. + +## -parameters +### -param printerExtensionContext +The object that represents the print task extension context. + +## -remarks + +## -examples + +## -see-also +[printerExtensionContext](printtaskconfiguration_printerextensioncontext.md) \ No newline at end of file diff --git a/windows.devices.printers.extensions/printtaskconfigurationsaverequesteddeferral_complete_1807836922.md b/windows.devices.printers.extensions/printtaskconfigurationsaverequesteddeferral_complete_1807836922.md index 930583a06b..c5a0622793 100644 --- a/windows.devices.printers.extensions/printtaskconfigurationsaverequesteddeferral_complete_1807836922.md +++ b/windows.devices.printers.extensions/printtaskconfigurationsaverequesteddeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedDeferral.Complete --api-type: winrt method ---- # Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedDeferral.Complete ## -description Called by the device app when the deferral is completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedDeferral.Complete + +## -description +Called by the device app when the deferral is completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers.extensions/printtaskconfigurationsaverequestedeventargs_request.md b/windows.devices.printers.extensions/printtaskconfigurationsaverequestedeventargs_request.md index e2298fc053..05238055a8 100644 --- a/windows.devices.printers.extensions/printtaskconfigurationsaverequestedeventargs_request.md +++ b/windows.devices.printers.extensions/printtaskconfigurationsaverequestedeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedEventArgs.Request --api-type: winrt property ---- # Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedEventArgs.Request ## -description Gets the information that is required for updating the print task configuration. ## -property-value The print task configuration save request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedEventArgs.Request + +## -description +Gets the information that is required for updating the print task configuration. + +## -property-value +The print task configuration save request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers/print3ddevice.md b/windows.devices.printers/print3ddevice.md index dce3a2c143..1096beffaf 100644 --- a/windows.devices.printers/print3ddevice.md +++ b/windows.devices.printers/print3ddevice.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Printers.Print3DDevice --api-type: winrt class ---- # Windows.Devices.Printers.Print3DDevice ## -description Represents a 3D printer. ## -remarks Use the AQS string returned by [GetDeviceSelector](print3ddevice_getdeviceselector.md) with the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) APIs to find all 3D printers that are connected to the device. Once you have a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for a 3D printer, you can use that object's [Id](../windows.devices.enumeration/deviceinformation_id.md) property value as the *deviceId* parameter in [FromIdAsync](print3ddevice_fromidasync.md) to create a [Print3DDevice](print3ddevice.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Printers.Print3DDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Printers.Print3DDevice + +## -description +Represents a 3D printer. + +## -remarks +Use the AQS string returned by [GetDeviceSelector](print3ddevice_getdeviceselector.md) with the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) APIs to find all 3D printers that are connected to the device. Once you have a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for a 3D printer, you can use that object's [Id](../windows.devices.enumeration/deviceinformation_id.md) property value as the *deviceId* parameter in [FromIdAsync](print3ddevice_fromidasync.md) to create a [Print3DDevice](print3ddevice.md) object. + +## -examples + +## -see-also diff --git a/windows.devices.printers/print3ddevice_fromidasync_1322863552.md b/windows.devices.printers/print3ddevice_fromidasync_1322863552.md index c7c2b040bb..13e6e24381 100644 --- a/windows.devices.printers/print3ddevice_fromidasync_1322863552.md +++ b/windows.devices.printers/print3ddevice_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Printers.Print3DDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Printers.Print3DDevice.FromIdAsync ## -description Creates a [Print3DDevice](print3ddevice.md) object that represents a 3D printer connected to the device. ## -parameters ### -param deviceId The device ID of the 3D printer. ## -returns A [Print3DDevice](print3ddevice.md) object that corresponds to the specified 3D printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Print3DDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Print3DDevice.FromIdAsync + +## -description +Creates a [Print3DDevice](print3ddevice.md) object that represents a 3D printer connected to the device. + +## -parameters +### -param deviceId +The device ID of the 3D printer. + +## -returns +A [Print3DDevice](print3ddevice.md) object that corresponds to the specified 3D printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers/print3ddevice_getdeviceselector_838466080.md b/windows.devices.printers/print3ddevice_getdeviceselector_838466080.md index d08a8046e8..9cea55c8e4 100644 --- a/windows.devices.printers/print3ddevice_getdeviceselector_838466080.md +++ b/windows.devices.printers/print3ddevice_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Printers.Print3DDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Printers.Print3DDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that can be used to find all 3D printers that are connected to the device. ## -returns An AQS string that can be used to find all 3D printers connected to the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.Print3DDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.Print3DDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that can be used to find all 3D printers that are connected to the device. + +## -returns +An AQS string that can be used to find all 3D printers connected to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers/print3ddevice_printschema.md b/windows.devices.printers/print3ddevice_printschema.md index 380a07765b..e71b459732 100644 --- a/windows.devices.printers/print3ddevice_printschema.md +++ b/windows.devices.printers/print3ddevice_printschema.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Printers.Print3DDevice.PrintSchema --api-type: winrt property ---- # Windows.Devices.Printers.Print3DDevice.PrintSchema ## -description Gets the [PrintSchema](printschema.md) object for obtaining capabilities and print ticket information. ## -property-value The [PrintSchema](printschema.md) object for obtaining capabilities and print ticket information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Printers.Print3DDevice.PrintSchema +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Print3DDevice.PrintSchema + +## -description +Gets the [PrintSchema](printschema.md) object for obtaining capabilities and print ticket information. + +## -property-value +The [PrintSchema](printschema.md) object for obtaining capabilities and print ticket information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers/printschema.md b/windows.devices.printers/printschema.md index ff1048b6e8..aa4b8961ed 100644 --- a/windows.devices.printers/printschema.md +++ b/windows.devices.printers/printschema.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Printers.PrintSchema --api-type: winrt class ---- # Windows.Devices.Printers.PrintSchema ## -description Provides APIs to access a 3D printer's capabilities and print tickets. ## -remarks For more information about the XML documents returned by the methods of this class, see the [Print Schema Specification](https://msdn.microsoft.com/library/windows/hardware/gg463385). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Printers.PrintSchema +-api-type: winrt class +--- + + + +# Windows.Devices.Printers.PrintSchema + +## -description +Provides APIs to access a 3D printer's capabilities and print tickets. + +## -remarks +For more information about the XML documents returned by the methods of this class, see the [Print Schema Specification](https://msdn.microsoft.com/library/windows/hardware/gg463385). + +## -examples + +## -see-also diff --git a/windows.devices.printers/printschema_getcapabilitiesasync_270284645.md b/windows.devices.printers/printschema_getcapabilitiesasync_270284645.md index dfa9f194eb..7933c0c222 100644 --- a/windows.devices.printers/printschema_getcapabilitiesasync_270284645.md +++ b/windows.devices.printers/printschema_getcapabilitiesasync_270284645.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Printers.PrintSchema.GetCapabilitiesAsync(Windows.Storage.Streams.IRandomAccessStreamWithContentType) --api-type: winrt method ---- # Windows.Devices.Printers.PrintSchema.GetCapabilitiesAsync ## -description Gets the 3D printer capabilities. ## -parameters ### -param constrainTicket The print ticket. ## -returns An XML PrintCapabilities document containing 3D printer capabilities. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.PrintSchema.GetCapabilitiesAsync(Windows.Storage.Streams.IRandomAccessStreamWithContentType) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.PrintSchema.GetCapabilitiesAsync + +## -description +Gets the 3D printer capabilities. + +## -parameters +### -param constrainTicket +The print ticket. + +## -returns +An XML PrintCapabilities document containing 3D printer capabilities. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers/printschema_getdefaultprintticketasync_2066314240.md b/windows.devices.printers/printschema_getdefaultprintticketasync_2066314240.md index 304e8c7562..dffa1a5685 100644 --- a/windows.devices.printers/printschema_getdefaultprintticketasync_2066314240.md +++ b/windows.devices.printers/printschema_getdefaultprintticketasync_2066314240.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Printers.PrintSchema.GetDefaultPrintTicketAsync --api-type: winrt method ---- # Windows.Devices.Printers.PrintSchema.GetDefaultPrintTicketAsync ## -description Gets the 3D printer's default print ticket. ## -returns An XML PrintTicket document containing the 3D printer's default print ticket. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.PrintSchema.GetDefaultPrintTicketAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.PrintSchema.GetDefaultPrintTicketAsync + +## -description +Gets the 3D printer's default print ticket. + +## -returns +An XML PrintTicket document containing the 3D printer's default print ticket. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.printers/printschema_mergeandvalidatewithdefaultprintticketasync_1815175578.md b/windows.devices.printers/printschema_mergeandvalidatewithdefaultprintticketasync_1815175578.md index 1c11c12755..da242202ec 100644 --- a/windows.devices.printers/printschema_mergeandvalidatewithdefaultprintticketasync_1815175578.md +++ b/windows.devices.printers/printschema_mergeandvalidatewithdefaultprintticketasync_1815175578.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.Printers.PrintSchema.MergeAndValidateWithDefaultPrintTicketAsync(Windows.Storage.Streams.IRandomAccessStreamWithContentType) --api-type: winrt method ---- # Windows.Devices.Printers.PrintSchema.MergeAndValidateWithDefaultPrintTicketAsync ## -description Creates a new print ticket by merging the user’s selection with the default print ticket and validating that it will work for the device. ## -parameters ### -param deltaTicket The delta print ticket, specifies the differences between the default print ticket and the user's selections. ## -returns An XML PrintTicket document containing the suggested print ticket. ## -remarks This method attempts to merge the user's selections with a default print ticket - even one for a different 3D printer. The returned print ticket is "suggested" because it may fail upon submission to the 3D printer. If that ticket fails, it indicates that the print ticket is invalid for the printer. If that ticket succeeds, it can be reused by the 3D designer in subsequent submissions. ## -examples ## -see-also [GetDefaultPrintTicketAsync](printschema_getdefaultprintticketasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Printers.PrintSchema.MergeAndValidateWithDefaultPrintTicketAsync(Windows.Storage.Streams.IRandomAccessStreamWithContentType) +-api-type: winrt method +--- + + + +# Windows.Devices.Printers.PrintSchema.MergeAndValidateWithDefaultPrintTicketAsync + +## -description +Creates a new print ticket by merging the user’s selection with the default print ticket and validating that it will work for the device. + +## -parameters +### -param deltaTicket +The delta print ticket, specifies the differences between the default print ticket and the user's selections. + +## -returns +An XML PrintTicket document containing the suggested print ticket. + +## -remarks +This method attempts to merge the user's selections with a default print ticket - even one for a different 3D printer. The returned print ticket is "suggested" because it may fail upon submission to the 3D printer. If that ticket fails, it indicates that the print ticket is invalid for the printer. If that ticket succeeds, it can be reused by the 3D designer in subsequent submissions. + +## -examples + +## -see-also +[GetDefaultPrintTicketAsync](printschema_getdefaultprintticketasync.md) \ No newline at end of file diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_acquirepin.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_acquirepin.md index b3b9e7f68c..dcf830a32e 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_acquirepin.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_acquirepin.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.AcquirePin(System.Int32) --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.AcquirePin ## -description Acquires the specified pin and opens that pin for use. ## -parameters ### -param pin Which pin to open a PWM connection to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.AcquirePin(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.AcquirePin + +## -description +Acquires the specified pin and opens that pin for use. + +## -parameters +### -param pin +Which pin to open a PWM connection to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_actualfrequency.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_actualfrequency.md index 78e7965a69..a895ffe7e9 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_actualfrequency.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_actualfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.ActualFrequency --api-type: winrt property ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.ActualFrequency ## -description Gets the actual frequency of the PWM. ## -property-value The frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.ActualFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.ActualFrequency + +## -description +Gets the actual frequency of the PWM. + +## -property-value +The frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_disablepin.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_disablepin.md index 9b6ce48c95..24e0ce6f49 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_disablepin.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_disablepin.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.DisablePin(System.Int32) --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.DisablePin ## -description Stops the PWM on this pin. ## -parameters ### -param pin Which pin to stop the PWM signal on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.DisablePin(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.DisablePin + +## -description +Stops the PWM on this pin. + +## -parameters +### -param pin +Which pin to stop the PWM signal on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_enablepin.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_enablepin.md index 20c05cf08c..7476560013 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_enablepin.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_enablepin.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.EnablePin(System.Int32) --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.EnablePin ## -description Starts the PWM signal on the specified pin. ## -parameters ### -param pin Which pin to start the PWM signal on. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.EnablePin(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.EnablePin + +## -description +Starts the PWM signal on the specified pin. + +## -parameters +### -param pin +Which pin to start the PWM signal on. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_maxfrequency.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_maxfrequency.md index cf2085d7d0..6be26b899c 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_maxfrequency.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_maxfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.MaxFrequency --api-type: winrt property ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.MaxFrequency ## -description Gets the maximum frequency offered by the controller. ## -property-value The maximum frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.MaxFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.MaxFrequency + +## -description +Gets the maximum frequency offered by the controller. + +## -property-value +The maximum frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_minfrequency.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_minfrequency.md index cd478f029a..2eabdf44aa 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_minfrequency.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_minfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.MinFrequency --api-type: winrt property ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.MinFrequency ## -description Gets the minimum frequency offered by the controller. ## -property-value The minimum frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.MinFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.MinFrequency + +## -description +Gets the minimum frequency offered by the controller. + +## -property-value +The minimum frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_pincount.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_pincount.md index 3aa970b912..d188c25fc5 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_pincount.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_pincount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.PinCount --api-type: winrt property ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.PinCount ## -description Gets the number of PWM pins available on the system. ## -property-value The number of pins available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.Provider.IPwmControllerProvider.PinCount +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.PinCount + +## -description +Gets the number of PWM pins available on the system. + +## -property-value +The number of pins available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_releasepin.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_releasepin.md index e2c347abc4..6a5478a49b 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_releasepin.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_releasepin.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.ReleasePin(System.Int32) --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.ReleasePin ## -description Releases connection to specified pin and makes that pin available to others. ## -parameters ### -param pin Which pin to release. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.ReleasePin(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.ReleasePin + +## -description +Releases connection to specified pin and makes that pin available to others. + +## -parameters +### -param pin +Which pin to release. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_setdesiredfrequency.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_setdesiredfrequency.md index 46ae764c94..72175a8a91 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_setdesiredfrequency.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_setdesiredfrequency.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetDesiredFrequency(System.Double) --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetDesiredFrequency ## -description Sets the desired PWM frequency. ## -parameters ### -param frequency The desired frequency in Hz. ## -returns The actual PWM frequency after setting to above value. This will be the closest supported match as determined by the provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetDesiredFrequency(System.Double) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetDesiredFrequency + +## -description +Sets the desired PWM frequency. + +## -parameters +### -param frequency +The desired frequency in Hz. + +## -returns +The actual PWM frequency after setting to above value. This will be the closest supported match as determined by the provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmcontrollerprovider_setpulseparameters.md b/windows.devices.pwm.provider/ipwmcontrollerprovider_setpulseparameters.md index 65f4e2c085..ae1cc5ac22 100644 --- a/windows.devices.pwm.provider/ipwmcontrollerprovider_setpulseparameters.md +++ b/windows.devices.pwm.provider/ipwmcontrollerprovider_setpulseparameters.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetPulseParameters(System.Int32,System.Double,System.Boolean) --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetPulseParameters ## -description Sets the PWM parameters for pin, duty cycle, and polarity. ## -parameters ### -param pin Indicates which pin these values apply to. ### -param dutyCycle The duty cycle percentage, with value between 0 and 100 inclusive. ### -param invertPolarity True if polarity of pin should be inverted, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetPulseParameters(System.Int32,System.Double,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmControllerProvider.SetPulseParameters + +## -description +Sets the PWM parameters for pin, duty cycle, and polarity. + +## -parameters +### -param pin +Indicates which pin these values apply to. + +### -param dutyCycle +The duty cycle percentage, with value between 0 and 100 inclusive. + +### -param invertPolarity +True if polarity of pin should be inverted, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm.provider/ipwmprovider_getcontrollers.md b/windows.devices.pwm.provider/ipwmprovider_getcontrollers.md index 7664bc3dc0..03a875cfa8 100644 --- a/windows.devices.pwm.provider/ipwmprovider_getcontrollers.md +++ b/windows.devices.pwm.provider/ipwmprovider_getcontrollers.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Pwm.Provider.IPwmProvider.GetControllers --api-type: winrt method ---- # Windows.Devices.Pwm.Provider.IPwmProvider.GetControllers ## -description Gets the controllers available on the system. ## -returns Returns a list of PWM controllers available on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.Provider.IPwmProvider.GetControllers +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.Provider.IPwmProvider.GetControllers + +## -description +Gets the controllers available on the system. + +## -returns +Returns a list of PWM controllers available on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller.md b/windows.devices.pwm/pwmcontroller.md index f15171aa32..38d2e54d1e 100644 --- a/windows.devices.pwm/pwmcontroller.md +++ b/windows.devices.pwm/pwmcontroller.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Pwm.PwmController --api-type: winrt class ---- # Windows.Devices.Pwm.PwmController ## -description Represents a PWM controller connected to the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Pwm.PwmController +-api-type: winrt class +--- + + + +# Windows.Devices.Pwm.PwmController + +## -description +Represents a PWM controller connected to the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_actualfrequency.md b/windows.devices.pwm/pwmcontroller_actualfrequency.md index b55f6852b7..b0167eb5f2 100644 --- a/windows.devices.pwm/pwmcontroller_actualfrequency.md +++ b/windows.devices.pwm/pwmcontroller_actualfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmController.ActualFrequency --api-type: winrt property ---- # Windows.Devices.Pwm.PwmController.ActualFrequency ## -description Gets the actual frequency of the PWM. ## -property-value The frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmController.ActualFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmController.ActualFrequency + +## -description +Gets the actual frequency of the PWM. + +## -property-value +The frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_getcontrollersasync_1587237371.md b/windows.devices.pwm/pwmcontroller_getcontrollersasync_1587237371.md index 335a5d9725..0ff416da1b 100644 --- a/windows.devices.pwm/pwmcontroller_getcontrollersasync_1587237371.md +++ b/windows.devices.pwm/pwmcontroller_getcontrollersasync_1587237371.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmController.GetControllersAsync(Windows.Devices.Pwm.Provider.IPwmProvider) --api-type: winrt method ---- # Windows.Devices.Pwm.PwmController.GetControllersAsync ## -description Gets all the controllers on the system asynchronously. ## -parameters ### -param provider The PWM provider that is on the system. ## -returns When the method completes successfully, it returns a list of values that represent the controllers available on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmController.GetControllersAsync(Windows.Devices.Pwm.Provider.IPwmProvider) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.GetControllersAsync + +## -description +Gets all the controllers on the system asynchronously. + +## -parameters +### -param provider +The PWM provider that is on the system. + +## -returns +When the method completes successfully, it returns a list of values that represent the controllers available on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_getdefaultasync_1549573963.md b/windows.devices.pwm/pwmcontroller_getdefaultasync_1549573963.md index 3ff2bee594..e256858248 100644 --- a/windows.devices.pwm/pwmcontroller_getdefaultasync_1549573963.md +++ b/windows.devices.pwm/pwmcontroller_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmController.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Pwm.PwmController.GetDefaultAsync ## -description Gets the default PWM controller on the system. ## -returns The default PWM controller on the system, or null if the system has no PWM controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmController.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.GetDefaultAsync + +## -description +Gets the default PWM controller on the system. + +## -returns +The default PWM controller on the system, or null if the system has no PWM controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_maxfrequency.md b/windows.devices.pwm/pwmcontroller_maxfrequency.md index f91aa05bce..4c56e73d00 100644 --- a/windows.devices.pwm/pwmcontroller_maxfrequency.md +++ b/windows.devices.pwm/pwmcontroller_maxfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmController.MaxFrequency --api-type: winrt property ---- # Windows.Devices.Pwm.PwmController.MaxFrequency ## -description Gets the maximum frequency offered by the controller. ## -property-value The maximum frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmController.MaxFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmController.MaxFrequency + +## -description +Gets the maximum frequency offered by the controller. + +## -property-value +The maximum frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_minfrequency.md b/windows.devices.pwm/pwmcontroller_minfrequency.md index ab59640f31..fd7ab0bfd1 100644 --- a/windows.devices.pwm/pwmcontroller_minfrequency.md +++ b/windows.devices.pwm/pwmcontroller_minfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmController.MinFrequency --api-type: winrt property ---- # Windows.Devices.Pwm.PwmController.MinFrequency ## -description Gets the minimum frequency offered by the controller. ## -property-value The minimum frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmController.MinFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmController.MinFrequency + +## -description +Gets the minimum frequency offered by the controller. + +## -property-value +The minimum frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_openpin_1000658948.md b/windows.devices.pwm/pwmcontroller_openpin_1000658948.md index 4efd69d76d..190092e815 100644 --- a/windows.devices.pwm/pwmcontroller_openpin_1000658948.md +++ b/windows.devices.pwm/pwmcontroller_openpin_1000658948.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmController.OpenPin(System.Int32) --api-type: winrt method ---- # Windows.Devices.Pwm.PwmController.OpenPin ## -description Opens the pin for use. ## -parameters ### -param pinNumber Which pin to open. ## -returns The requested pin now available for use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmController.OpenPin(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.OpenPin + +## -description +Opens the pin for use. + +## -parameters +### -param pinNumber +Which pin to open. + +## -returns +The requested pin now available for use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_pincount.md b/windows.devices.pwm/pwmcontroller_pincount.md index 7624fd366c..9589741ec0 100644 --- a/windows.devices.pwm/pwmcontroller_pincount.md +++ b/windows.devices.pwm/pwmcontroller_pincount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmController.PinCount --api-type: winrt property ---- # Windows.Devices.Pwm.PwmController.PinCount ## -description Gets the number of pins available on the system. ## -property-value The number of pins. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmController.PinCount +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmController.PinCount + +## -description +Gets the number of pins available on the system. + +## -property-value +The number of pins. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_setdesiredfrequency_2009351498.md b/windows.devices.pwm/pwmcontroller_setdesiredfrequency_2009351498.md index d013862bdc..5b695f01c5 100644 --- a/windows.devices.pwm/pwmcontroller_setdesiredfrequency_2009351498.md +++ b/windows.devices.pwm/pwmcontroller_setdesiredfrequency_2009351498.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmController.SetDesiredFrequency(System.Double) --api-type: winrt method ---- # Windows.Devices.Pwm.PwmController.SetDesiredFrequency ## -description Sets the PWM frequency. ## -parameters ### -param desiredFrequency Then value of the desired frequency in Hz. ## -returns The actual frequency that was set. This will be the closest supported match as determined by the provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmController.SetDesiredFrequency(System.Double) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.SetDesiredFrequency + +## -description +Sets the PWM frequency. + +## -parameters +### -param desiredFrequency +Then value of the desired frequency in Hz. + +## -returns +The actual frequency that was set. This will be the closest supported match as determined by the provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin.md b/windows.devices.pwm/pwmpin.md index f279d11594..c977400cda 100644 --- a/windows.devices.pwm/pwmpin.md +++ b/windows.devices.pwm/pwmpin.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Pwm.PwmPin --api-type: winrt class ---- # Windows.Devices.Pwm.PwmPin ## -description Represents a single PWM pin on the system. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Pwm.PwmPin +-api-type: winrt class +--- + + + +# Windows.Devices.Pwm.PwmPin + +## -description +Represents a single PWM pin on the system. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.pwm/pwmpin_close_811482585.md b/windows.devices.pwm/pwmpin_close_811482585.md index 53e691405c..41f86b8798 100644 --- a/windows.devices.pwm/pwmpin_close_811482585.md +++ b/windows.devices.pwm/pwmpin_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmPin.Close --api-type: winrt method ---- # Windows.Devices.Pwm.PwmPin.Close ## -description Closes current connection to the pin, and makes pin available to be opened by others. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmPin.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmPin.Close + +## -description +Closes current connection to the pin, and makes pin available to be opened by others. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_controller.md b/windows.devices.pwm/pwmpin_controller.md index 33b876de10..45559cbbe0 100644 --- a/windows.devices.pwm/pwmpin_controller.md +++ b/windows.devices.pwm/pwmpin_controller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmPin.Controller --api-type: winrt property ---- # Windows.Devices.Pwm.PwmPin.Controller ## -description Gets the PWM controller in use by this pin. ## -property-value The controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmPin.Controller +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmPin.Controller + +## -description +Gets the PWM controller in use by this pin. + +## -property-value +The controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_getactivedutycyclepercentage_877336788.md b/windows.devices.pwm/pwmpin_getactivedutycyclepercentage_877336788.md index f4e5048217..e753e06456 100644 --- a/windows.devices.pwm/pwmpin_getactivedutycyclepercentage_877336788.md +++ b/windows.devices.pwm/pwmpin_getactivedutycyclepercentage_877336788.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmPin.GetActiveDutyCyclePercentage --api-type: winrt method ---- # Windows.Devices.Pwm.PwmPin.GetActiveDutyCyclePercentage ## -description Retrieves the duty cycle percentage for this pin. ## -returns The duty cycle percentage, between 0.0 and 1.0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmPin.GetActiveDutyCyclePercentage +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmPin.GetActiveDutyCyclePercentage + +## -description +Retrieves the duty cycle percentage for this pin. + +## -returns +The duty cycle percentage, between 0.0 and 1.0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_isstarted.md b/windows.devices.pwm/pwmpin_isstarted.md index badee89510..d7fcad8e46 100644 --- a/windows.devices.pwm/pwmpin_isstarted.md +++ b/windows.devices.pwm/pwmpin_isstarted.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmPin.IsStarted --api-type: winrt property ---- # Windows.Devices.Pwm.PwmPin.IsStarted ## -description Gets the started state of the pin. ## -property-value True if the PWM has started on this pin, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmPin.IsStarted +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmPin.IsStarted + +## -description +Gets the started state of the pin. + +## -property-value +True if the PWM has started on this pin, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_polarity.md b/windows.devices.pwm/pwmpin_polarity.md index 4a8d907b79..a4b3f16dcd 100644 --- a/windows.devices.pwm/pwmpin_polarity.md +++ b/windows.devices.pwm/pwmpin_polarity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Pwm.PwmPin.Polarity --api-type: winrt property ---- # Windows.Devices.Pwm.PwmPin.Polarity ## -description Gets or sets the polarity of the pin. ## -property-value The pin polarity. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Pwm.PwmPin.Polarity +-api-type: winrt property +--- + + + +# Windows.Devices.Pwm.PwmPin.Polarity + +## -description +Gets or sets the polarity of the pin. + +## -property-value +The pin polarity. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_setactivedutycyclepercentage_1735097187.md b/windows.devices.pwm/pwmpin_setactivedutycyclepercentage_1735097187.md index 8a5f85168d..be7a478aa7 100644 --- a/windows.devices.pwm/pwmpin_setactivedutycyclepercentage_1735097187.md +++ b/windows.devices.pwm/pwmpin_setactivedutycyclepercentage_1735097187.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmPin.SetActiveDutyCyclePercentage(System.Double) --api-type: winrt method ---- # Windows.Devices.Pwm.PwmPin.SetActiveDutyCyclePercentage ## -description Sets the duty cycle percentage for this pin. ## -parameters ### -param dutyCyclePercentage The desired duty cycle percentage, represented as a value between 0.0 and 1.0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmPin.SetActiveDutyCyclePercentage(System.Double) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmPin.SetActiveDutyCyclePercentage + +## -description +Sets the duty cycle percentage for this pin. + +## -parameters +### -param dutyCyclePercentage +The desired duty cycle percentage, represented as a value between 0.0 and 1.0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_start_1587696324.md b/windows.devices.pwm/pwmpin_start_1587696324.md index 71b8952c27..e2ecaeb12d 100644 --- a/windows.devices.pwm/pwmpin_start_1587696324.md +++ b/windows.devices.pwm/pwmpin_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmPin.Start --api-type: winrt method ---- # Windows.Devices.Pwm.PwmPin.Start ## -description Starts the PWM on this pin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmPin.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmPin.Start + +## -description +Starts the PWM on this pin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmpin_stop_1201535524.md b/windows.devices.pwm/pwmpin_stop_1201535524.md index daf4c76fca..b191ecc292 100644 --- a/windows.devices.pwm/pwmpin_stop_1201535524.md +++ b/windows.devices.pwm/pwmpin_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Pwm.PwmPin.Stop --api-type: winrt method ---- # Windows.Devices.Pwm.PwmPin.Stop ## -description Stops the PWM on this pin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Pwm.PwmPin.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmPin.Stop + +## -description +Stops the PWM on this pin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.radios/radio.md b/windows.devices.radios/radio.md index f9139e492a..105bafe341 100644 --- a/windows.devices.radios/radio.md +++ b/windows.devices.radios/radio.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Devices.Radios.Radio --api-type: winrt class ---- # Windows.Devices.Radios.Radio ## -description Represents a radio device on the system. ## -remarks Your code uses static members of this class like [GetRadiosAsync](radio_getradiosasync.md), [GetDeviceSelector](radio_getdeviceselector.md), and [FromIdAsync](radio_fromidasync.md) to query for radios and to retrieve instantiated Radio objects representing particular radios on the device. Note that your code should call [RequestAccessAsync](radio_requestaccessasync.md) at least once, from the UI thread, before trying to call [SetStateAsync](radio_setstateasync.md). This is because in some regions, with some user settings choices, attempting to change radio state requires user permission. In this situation, calling [RequestAccessAsync](radio_requestaccessasync.md) shows the user a prompt asking if they want to allow your app to have permission to control the radio. If your app is running on a device that requires user permission and your code hasn't requested and received permission, then [SetStateAsync](radio_setstateasync.md) will fail for lack of user permission. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Radios.Radio +-api-type: winrt class +--- + + + +# Windows.Devices.Radios.Radio + +## -description +Represents a radio device on the system. + +## -remarks +Your code uses static members of this class like [GetRadiosAsync](radio_getradiosasync.md), [GetDeviceSelector](radio_getdeviceselector.md), and [FromIdAsync](radio_fromidasync.md) to query for radios and to retrieve instantiated Radio objects representing particular radios on the device. + +Note that your code should call [RequestAccessAsync](radio_requestaccessasync.md) at least once, from the UI thread, before trying to call [SetStateAsync](radio_setstateasync.md). This is because in some regions, with some user settings choices, attempting to change radio state requires user permission. In this situation, calling [RequestAccessAsync](radio_requestaccessasync.md) shows the user a prompt asking if they want to allow your app to have permission to control the radio. If your app is running on a device that requires user permission and your code hasn't requested and received permission, then [SetStateAsync](radio_setstateasync.md) will fail for lack of user permission. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannerformatconfiguration_defaultformat.md b/windows.devices.scanners/iimagescannerformatconfiguration_defaultformat.md index 59d557e903..d1ff3cc439 100644 --- a/windows.devices.scanners/iimagescannerformatconfiguration_defaultformat.md +++ b/windows.devices.scanners/iimagescannerformatconfiguration_defaultformat.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerFormatConfiguration.DefaultFormat --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerFormatConfiguration.DefaultFormat ## -description Gets the default file format for the scan source at the beginning of a new scan session. ## -property-value The file type. ## -remarks All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + 1. Jpeg + 2. Png + 3. Bitmap ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerFormatConfiguration.DefaultFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerFormatConfiguration.DefaultFormat + +## -description +Gets the default file format for the scan source at the beginning of a new scan session. + +## -property-value +The file type. + +## -remarks +All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. + +By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + + ++ 1. Jpeg ++ 2. Png ++ 3. Bitmap + + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannerformatconfiguration_format.md b/windows.devices.scanners/iimagescannerformatconfiguration_format.md index c5fb230454..9a2f542fb3 100644 --- a/windows.devices.scanners/iimagescannerformatconfiguration_format.md +++ b/windows.devices.scanners/iimagescannerformatconfiguration_format.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerFormatConfiguration.Format --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerFormatConfiguration.Format ## -description Gets or sets the current file transfer format for image data acquisition from the device to the client app. ## -property-value The file type. ## -remarks When a new scan session starts, this property is set to the default file format. See the [DefaultFormat](iimagescannerformatconfiguration_defaultformat.md) property on how this is done. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerFormatConfiguration.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerFormatConfiguration.Format + +## -description +Gets or sets the current file transfer format for image data acquisition from the device to the client app. + +## -property-value +The file type. + +## -remarks +When a new scan session starts, this property is set to the default file format. See the [DefaultFormat](iimagescannerformatconfiguration_defaultformat.md) property on how this is done. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannerformatconfiguration_isformatsupported.md b/windows.devices.scanners/iimagescannerformatconfiguration_isformatsupported.md index 8e325dc593..ea5a027ddd 100644 --- a/windows.devices.scanners/iimagescannerformatconfiguration_isformatsupported.md +++ b/windows.devices.scanners/iimagescannerformatconfiguration_isformatsupported.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.IImageScannerFormatConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) --api-type: winrt method ---- # Windows.Devices.Scanners.IImageScannerFormatConfiguration.IsFormatSupported ## -description Determines whether the input scanner supports the specified file format or not. ## -parameters ### -param value The file type. ## -returns True if the specified file type is supported; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.IImageScannerFormatConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.IImageScannerFormatConfiguration.IsFormatSupported + +## -description +Determines whether the input scanner supports the specified file format or not. + +## -parameters +### -param value +The file type. + +## -returns +True if the specified file type is supported; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_actualresolution.md b/windows.devices.scanners/iimagescannersourceconfiguration_actualresolution.md index 9a8d550665..b0661f7a84 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_actualresolution.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_actualresolution.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.ActualResolution --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.ActualResolution ## -description Gets the actual horizontal and vertical scan resolution for the scan source, in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.ActualResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.ActualResolution + +## -description +Gets the actual horizontal and vertical scan resolution for the scan source, in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_autocroppingmode.md b/windows.devices.scanners/iimagescannersourceconfiguration_autocroppingmode.md index 96e16fe09d..378deeeea3 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_autocroppingmode.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_autocroppingmode.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.AutoCroppingMode --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.AutoCroppingMode ## -description Gets or sets the automatic crop mode. When automatic detection is enabled on the scan source, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is **Disabled**. ## -property-value The automatic crop mode for the scan. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.AutoCroppingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.AutoCroppingMode + +## -description +Gets or sets the automatic crop mode. + +When automatic detection is enabled on the scan source, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is **Disabled**. + +## -property-value +The automatic crop mode for the scan. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_brightness.md b/windows.devices.scanners/iimagescannersourceconfiguration_brightness.md index 39c4d1ddf1..98f987b592 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_brightness.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_brightness.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.Brightness --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.Brightness ## -description Configures the current brightness level for capturing image data from the scan source. On a new scan session, the value of this property is the [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) property. ## -property-value The brightness level. ## -remarks This property's value must be between [MinBrightness](iimagescannersourceconfiguration_minbrightness.md) and [MaxBrightness](iimagescannersourceconfiguration_maxbrightness.md), and is related to [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) with this equation: **Brightness = MinBrightness + (N*BrightnessStep)** where N is a positive integer smaller than or equal to **(MaxBrightness - MinBrightness) / BrightnessStep**. Your app can return the brightness level to default by setting the value of this property to the [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) property value. If the scanner doesn't allow brightness changes, **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, the **BrightnessStep** is set to 0, and the app can't change the **Brightness** property to a different value other than **DefaultBrightness**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.Brightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.Brightness + +## -description +Configures the current brightness level for capturing image data from the scan source. On a new scan session, the value of this property is the [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) property. + +## -property-value +The brightness level. + +## -remarks +This property's value must be between [MinBrightness](iimagescannersourceconfiguration_minbrightness.md) and [MaxBrightness](iimagescannersourceconfiguration_maxbrightness.md), and is related to [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) with this equation: + +**Brightness = MinBrightness + (N*BrightnessStep)** + +where N is a positive integer smaller than or equal to **(MaxBrightness - MinBrightness) / BrightnessStep**. + +Your app can return the brightness level to default by setting the value of this property to the [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) property value. If the scanner doesn't allow brightness changes, **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, the **BrightnessStep** is set to 0, and the app can't change the **Brightness** property to a different value other than **DefaultBrightness**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_brightnessstep.md b/windows.devices.scanners/iimagescannersourceconfiguration_brightnessstep.md index b4a7609cc0..23cb1f08bb 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_brightnessstep.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_brightnessstep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.BrightnessStep --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.BrightnessStep ## -description Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values. ## -property-value The step size to increment or decrement. A typical value is 1. ## -remarks If the scanner doesn't allow brightness changes, then the **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, and the **BrightnessStep** is set to 0. Your app can determine if the scan source doesn't support brightness adjustments by reading the **BrightnessStep** value. If the value is greater than 0, the scan source supports brightness adjustments. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.BrightnessStep +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.BrightnessStep + +## -description +Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values. + +## -property-value +The step size to increment or decrement. A typical value is 1. + +## -remarks +If the scanner doesn't allow brightness changes, then the **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, and the **BrightnessStep** is set to 0. Your app can determine if the scan source doesn't support brightness adjustments by reading the **BrightnessStep** value. If the value is greater than 0, the scan source supports brightness adjustments. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_colormode.md b/windows.devices.scanners/iimagescannersourceconfiguration_colormode.md index eceb9cdff3..bc2e178f8d 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_colormode.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_colormode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.ColorMode --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.ColorMode ## -description Gets or sets the color mode for the scan source. When a new scan session starts, this property is the same as the [DefaultColorMode](iimagescannersourceconfiguration_defaultcolormode.md) property. ## -property-value The color mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.ColorMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.ColorMode + +## -description +Gets or sets the color mode for the scan source. When a new scan session starts, this property is the same as the [DefaultColorMode](iimagescannersourceconfiguration_defaultcolormode.md) property. + +## -property-value +The color mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_contrast.md b/windows.devices.scanners/iimagescannersourceconfiguration_contrast.md index 17f6e9cf56..ecd9461afa 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_contrast.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_contrast.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.Contrast --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.Contrast ## -description Sets or gets the current contrast level for capturing image data from the scan source. At the beginning of a new scan session this property is set to the [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) property. ## -property-value The contrast level. ## -remarks Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinContrast](iimagescannersourceconfiguration_mincontrast.md) and [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) values, and also relates to the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value with this equation: **Contrast = MinContrast + (N * ContrastStep)** where N is a positive integer smaller than or equal to **(MaxContrast - MinContrast) / ContrastStep**. The app can return the contrast level to default by setting the value of this property to [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md). If the scanner doesn't allow contrast adjustments, **MinContrast**, **MaxContrast** and **DefaultContrast** are set to the same value-oftentimes 0, the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value is 0, and the app can't set the **Contrast** property to a value other than **DefaultContrast**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.Contrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.Contrast + +## -description +Sets or gets the current contrast level for capturing image data from the scan source. At the beginning of a new scan session this property is set to the [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) property. + +## -property-value +The contrast level. + +## -remarks +Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinContrast](iimagescannersourceconfiguration_mincontrast.md) and [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) values, and also relates to the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value with this equation: + +**Contrast = MinContrast + (N * ContrastStep)** + +where N is a positive integer smaller than or equal to **(MaxContrast - MinContrast) / ContrastStep**. + +The app can return the contrast level to default by setting the value of this property to [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md). + +If the scanner doesn't allow contrast adjustments, **MinContrast**, **MaxContrast** and **DefaultContrast** are set to the same value-oftentimes 0, the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value is 0, and the app can't set the **Contrast** property to a value other than **DefaultContrast**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_contraststep.md b/windows.devices.scanners/iimagescannersourceconfiguration_contraststep.md index 83db6c04ef..f8990b30be 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_contraststep.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_contraststep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.ContrastStep --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.ContrastStep ## -description Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values. ## -property-value The step size to increment or decrement. The typical value is 1. ## -remarks If the scanner doesn't allow contrast changes, then the [MinContrast](iimagescannersourceconfiguration_mincontrast.md), [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) and [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) are set to the same value-oftentimes 0, and the **ContrastStep** value is set to 0. Your app can determine if the scan source doesn't support contrast adjustments by reading the **ContrastStep** value. If the value is greater than 0, then the scan source supports contrast adjustments. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.ContrastStep +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.ContrastStep + +## -description +Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values. + +## -property-value +The step size to increment or decrement. The typical value is 1. + +## -remarks +If the scanner doesn't allow contrast changes, then the [MinContrast](iimagescannersourceconfiguration_mincontrast.md), [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) and [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) are set to the same value-oftentimes 0, and the **ContrastStep** value is set to 0. Your app can determine if the scan source doesn't support contrast adjustments by reading the **ContrastStep** value. If the value is greater than 0, then the scan source supports contrast adjustments. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_defaultbrightness.md b/windows.devices.scanners/iimagescannersourceconfiguration_defaultbrightness.md index 9ce56b01e6..9b8befeaf7 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_defaultbrightness.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_defaultbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultBrightness ## -description Gets the default brightness level for the scan source. ## -property-value The default brightness level for the scanner. ## -remarks A scan source that doesn't allow brightness adjustments can have [MinBrightness](iimagescannersourceconfiguration_minbrightness.md), [MaxBrightness](iimagescannersourceconfiguration_maxbrightness.md) and **DefaultBrightness** set to the same value-oftentimes 0, and the [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultBrightness + +## -description +Gets the default brightness level for the scan source. + +## -property-value +The default brightness level for the scanner. + +## -remarks +A scan source that doesn't allow brightness adjustments can have [MinBrightness](iimagescannersourceconfiguration_minbrightness.md), [MaxBrightness](iimagescannersourceconfiguration_maxbrightness.md) and **DefaultBrightness** set to the same value-oftentimes 0, and the [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_defaultcolormode.md b/windows.devices.scanners/iimagescannersourceconfiguration_defaultcolormode.md index 28d9a87668..67282ade0f 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_defaultcolormode.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_defaultcolormode.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultColorMode --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultColorMode ## -description Gets the default color mode for this scan source. ## -property-value The color mode. ## -remarks When a new scan session begins, this property chooses the default color mode based on the pixel data types and bit depths that each scanner device supports. This order of priority is used: + AutoColor + Color + Grayscale + BlackAndWhite If the scanner device doesn't support any of the standard color modes, the current scan source will be considered unavailable and the app won’t be able to scan from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultColorMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultColorMode + +## -description +Gets the default color mode for this scan source. + +## -property-value +The color mode. + +## -remarks +When a new scan session begins, this property chooses the default color mode based on the pixel data types and bit depths that each scanner device supports. This order of priority is used: + + ++ AutoColor ++ Color ++ Grayscale ++ BlackAndWhite +If the scanner device doesn't support any of the standard color modes, the current scan source will be considered unavailable and the app won’t be able to scan from there. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_defaultcontrast.md b/windows.devices.scanners/iimagescannersourceconfiguration_defaultcontrast.md index 4ab05f1f3f..2fa5e6808d 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_defaultcontrast.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_defaultcontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultContrast --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultContrast ## -description Gets the default contrast level for the scan source. ## -property-value The default contrast level. ## -remarks A scan source that doesn't allow contrast adjustments can have [MinContrast](iimagescannersourceconfiguration_mincontrast.md), [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) and **DefaultContrast** set to the same value-oftentimes 0, and the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.DefaultContrast + +## -description +Gets the default contrast level for the scan source. + +## -property-value +The default contrast level. + +## -remarks +A scan source that doesn't allow contrast adjustments can have [MinContrast](iimagescannersourceconfiguration_mincontrast.md), [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) and **DefaultContrast** set to the same value-oftentimes 0, and the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_desiredresolution.md b/windows.devices.scanners/iimagescannersourceconfiguration_desiredresolution.md index fa176c8e3e..43d4f06c28 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_desiredresolution.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_desiredresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DesiredResolution --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.DesiredResolution ## -description Gets or sets the horizontal and vertical scan resolution for the scan source that the app requests, in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks This property value can be [MinResolution](iimagescannersourceconfiguration_minresolution.md), [MaxResolution](iimagescannersourceconfiguration_maxresolution.md), or [OpticalResolution](iimagescannersourceconfiguration_opticalresolution.md). But, if your app sets this value to other resolutions, this property will choose the closest resolution values. See [ActualResolution](iimagescannersourceconfiguration_actualresolution.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.DesiredResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.DesiredResolution + +## -description +Gets or sets the horizontal and vertical scan resolution for the scan source that the app requests, in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks +This property value can be [MinResolution](iimagescannersourceconfiguration_minresolution.md), [MaxResolution](iimagescannersourceconfiguration_maxresolution.md), or [OpticalResolution](iimagescannersourceconfiguration_opticalresolution.md). But, if your app sets this value to other resolutions, this property will choose the closest resolution values. See [ActualResolution](iimagescannersourceconfiguration_actualresolution.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_isautocroppingmodesupported.md b/windows.devices.scanners/iimagescannersourceconfiguration_isautocroppingmodesupported.md index c9b3d35b9a..a2651d5fd0 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_isautocroppingmodesupported.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_isautocroppingmodesupported.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsAutoCroppingModeSupported(Windows.Devices.Scanners.ImageScannerAutoCroppingMode) --api-type: winrt method ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsAutoCroppingModeSupported ## -description Determines if the scan source supports the specified [ImageScannerAutoCroppingMode](imagescannerautocroppingmode.md). ## -parameters ### -param value The auto crop mode of the image to scan. ## -returns True if the device supports the *value* mode; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsAutoCroppingModeSupported(Windows.Devices.Scanners.ImageScannerAutoCroppingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsAutoCroppingModeSupported + +## -description +Determines if the scan source supports the specified [ImageScannerAutoCroppingMode](imagescannerautocroppingmode.md). + +## -parameters +### -param value +The auto crop mode of the image to scan. + +## -returns +True if the device supports the *value* mode; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_iscolormodesupported.md b/windows.devices.scanners/iimagescannersourceconfiguration_iscolormodesupported.md index 07f5824ae7..4474129385 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_iscolormodesupported.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_iscolormodesupported.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsColorModeSupported(Windows.Devices.Scanners.ImageScannerColorMode) --api-type: winrt method ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsColorModeSupported ## -description Determines if the scan source can scan and transfer images in the specified color mode. ## -parameters ### -param value The color mode. ## -returns True if the scanner can scan images in *value* mode; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsColorModeSupported(Windows.Devices.Scanners.ImageScannerColorMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.IsColorModeSupported + +## -description +Determines if the scan source can scan and transfer images in the specified color mode. + +## -parameters +### -param value +The color mode. + +## -returns +True if the scanner can scan images in *value* mode; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_maxbrightness.md b/windows.devices.scanners/iimagescannersourceconfiguration_maxbrightness.md index 69470a8afc..eb5f0a603b 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_maxbrightness.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_maxbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxBrightness ## -description Gets the maximum brightness level supported by the scan source. ## -property-value The maximum brightness level, typically 1000. ## -remarks This property's value must be greater than or equal to the value of the [MinBrightness](iimagescannersourceconfiguration_minbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxBrightness + +## -description +Gets the maximum brightness level supported by the scan source. + +## -property-value +The maximum brightness level, typically 1000. + +## -remarks +This property's value must be greater than or equal to the value of the [MinBrightness](iimagescannersourceconfiguration_minbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_maxcontrast.md b/windows.devices.scanners/iimagescannersourceconfiguration_maxcontrast.md index 8c8db346b7..ea06434f16 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_maxcontrast.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_maxcontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxContrast --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxContrast ## -description Gets the maximum contrast level supported by the scan source. ## -property-value The maximum contrast level, typically 1000. ## -remarks This property's value must be greater than or equal to the value of the [MinContrast](iimagescannersourceconfiguration_mincontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxContrast + +## -description +Gets the maximum contrast level supported by the scan source. + +## -property-value +The maximum contrast level, typically 1000. + +## -remarks +This property's value must be greater than or equal to the value of the [MinContrast](iimagescannersourceconfiguration_mincontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_maxresolution.md b/windows.devices.scanners/iimagescannersourceconfiguration_maxresolution.md index cd6f395ed9..7d0ef9eee1 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_maxresolution.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_maxresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxResolution --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxResolution ## -description Gets the maximum horizontal and vertical scan resolution of the scan source in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks Apps can scan at **MaxResolution** in a small area at the highest possible resolution. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxResolution + +## -description +Gets the maximum horizontal and vertical scan resolution of the scan source in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks +Apps can scan at **MaxResolution** in a small area at the highest possible resolution. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_maxscanarea.md b/windows.devices.scanners/iimagescannersourceconfiguration_maxscanarea.md index bf74193172..808ff8e4cb 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_maxscanarea.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_maxscanarea.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxScanArea --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxScanArea ## -description Gets the maximum scan area dimensions in inches. The maximum scan width is the longest width a document can have in order for the Feeder and Flatbed to scan it. ## -property-value The width and height of the area. ## -remarks For Feeder scan sources, there are restrictions for the maximum scan area: + The currently selected page size, if page size auto-detection is not enabled. + The dimensions of the selected page size, which becomes the new maximum dimensions of the permissible scan area. These limits are dictated by hardware for Feeder, Flatbed and other types of scan sources. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxScanArea +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MaxScanArea + +## -description +Gets the maximum scan area dimensions in inches. The maximum scan width is the longest width a document can have in order for the Feeder and Flatbed to scan it. + +## -property-value +The width and height of the area. + +## -remarks +For Feeder scan sources, there are restrictions for the maximum scan area: ++ The currently selected page size, if page size auto-detection is not enabled. ++ The dimensions of the selected page size, which becomes the new maximum dimensions of the permissible scan area. + These limits are dictated by hardware for Feeder, Flatbed and other types of scan sources. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_minbrightness.md b/windows.devices.scanners/iimagescannersourceconfiguration_minbrightness.md index cfc450b61c..bbd5c02cfa 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_minbrightness.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_minbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinBrightness ## -description Gets the minimum brightness level supported by the scan source. ## -property-value The minimum brightness level, typically -1000. ## -remarks This property's value must be smaller than or equal to the value of the [MaxBrightness](iimagescannersourceconfiguration_maxbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinBrightness + +## -description +Gets the minimum brightness level supported by the scan source. + +## -property-value +The minimum brightness level, typically -1000. + +## -remarks +This property's value must be smaller than or equal to the value of the [MaxBrightness](iimagescannersourceconfiguration_maxbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](iimagescannersourceconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](iimagescannersourceconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_mincontrast.md b/windows.devices.scanners/iimagescannersourceconfiguration_mincontrast.md index a7f9ba13ab..6423860b84 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_mincontrast.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_mincontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinContrast --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinContrast ## -description Gets the minimum contrast level supported by the scan source. ## -property-value The minimum contrast level, typically -1000. ## -remarks This property's value must be smaller than or equal to the value of the [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinContrast + +## -description +Gets the minimum contrast level supported by the scan source. + +## -property-value +The minimum contrast level, typically -1000. + +## -remarks +This property's value must be smaller than or equal to the value of the [MaxContrast](iimagescannersourceconfiguration_maxcontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](iimagescannersourceconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](iimagescannersourceconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_minresolution.md b/windows.devices.scanners/iimagescannersourceconfiguration_minresolution.md index ca2ef8b0a1..dbff963b11 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_minresolution.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_minresolution.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinResolution --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinResolution ## -description Gets the minimum horizontal and vertical scan resolution of the scan source in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinResolution + +## -description +Gets the minimum horizontal and vertical scan resolution of the scan source in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_minscanarea.md b/windows.devices.scanners/iimagescannersourceconfiguration_minscanarea.md index 930d52cc2d..2bff082165 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_minscanarea.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_minscanarea.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinScanArea --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinScanArea ## -description Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Flatbed or Feeder to scan it. ## -property-value The width and height of the area. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinScanArea +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.MinScanArea + +## -description +Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Flatbed or Feeder to scan it. + +## -property-value +The width and height of the area. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_opticalresolution.md b/windows.devices.scanners/iimagescannersourceconfiguration_opticalresolution.md index 8b1125d1a9..f6040c7216 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_opticalresolution.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_opticalresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.OpticalResolution --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.OpticalResolution ## -description Gets the optical horizontal and vertical scan resolution of the scan source in DPI. ## -property-value The horizontal and vertical scan resolution in pixels. ## -remarks Apps can scan at **OpticalResolution** for the best quality per pixel that the hardware device is capable of. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.OpticalResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.OpticalResolution + +## -description +Gets the optical horizontal and vertical scan resolution of the scan source in DPI. + +## -property-value +The horizontal and vertical scan resolution in pixels. + +## -remarks +Apps can scan at **OpticalResolution** for the best quality per pixel that the hardware device is capable of. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/iimagescannersourceconfiguration_selectedscanregion.md b/windows.devices.scanners/iimagescannersourceconfiguration_selectedscanregion.md index 52aa5fa16b..759e875350 100644 --- a/windows.devices.scanners/iimagescannersourceconfiguration_selectedscanregion.md +++ b/windows.devices.scanners/iimagescannersourceconfiguration_selectedscanregion.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.SelectedScanRegion --api-type: winrt property ---- # Windows.Devices.Scanners.IImageScannerSourceConfiguration.SelectedScanRegion ## -description Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the [AutoCroppingMode](iimagescannersourceconfiguration_autocroppingmode.md) property is not set to **Disabled**. ## -property-value The location and size of a rectangle. ## -remarks This table describes the property's restrictions. Default values are set at the beginning of a new scan session.
NameDefault valueValid Flatbed valuesValid Feeder values
0between 0 and - 1between 0 and
0between 0 and - 1between 0 and
between and ( – )between and
between and ( – )between and
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.IImageScannerSourceConfiguration.SelectedScanRegion +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.IImageScannerSourceConfiguration.SelectedScanRegion + +## -description +Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the [AutoCroppingMode](iimagescannersourceconfiguration_autocroppingmode.md) property is not set to **Disabled**. + +## -property-value +The location and size of a rectangle. + +## -remarks +This table describes the property's restrictions. Default values are set at the beginning of a new scan session. + + + + + + + +
NameDefault valueValid Flatbed valuesValid Feeder values
0between 0 and - 1between 0 and
0between 0 and - 1between 0 and
between and ( – )between and
between and ( – )between and
+ +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner.md b/windows.devices.scanners/imagescanner.md index 44284a2dd7..a54b059e90 100644 --- a/windows.devices.scanners/imagescanner.md +++ b/windows.devices.scanners/imagescanner.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Scanners.ImageScanner --api-type: winrt class ---- # Windows.Devices.Scanners.ImageScanner ## -description Represents the properties of images to scan. ## -remarks ## -examples ## -see-also [Scan Sample](http://go.microsoft.com/fwlink/p/?LinkId=301980) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Scanners.ImageScanner +-api-type: winrt class +--- + + + +# Windows.Devices.Scanners.ImageScanner + +## -description +Represents the properties of images to scan. + +## -remarks + +## -examples + +## -see-also +[Scan Sample](http://go.microsoft.com/fwlink/p/?LinkId=301980) \ No newline at end of file diff --git a/windows.devices.scanners/imagescanner_autoconfiguration.md b/windows.devices.scanners/imagescanner_autoconfiguration.md index bcf3a24947..ea687ec017 100644 --- a/windows.devices.scanners/imagescanner_autoconfiguration.md +++ b/windows.devices.scanners/imagescanner_autoconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScanner.AutoConfiguration --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScanner.AutoConfiguration ## -description Gets and sets the scan settings of the auto-configured scan unit, like the file format, including compression to deliver the scanned data in. This property is ignored if the scanner is not capable of auto-configuration. ## -property-value The scan configuration. Null if the scanner is not capable of auto-configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScanner.AutoConfiguration +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScanner.AutoConfiguration + +## -description +Gets and sets the scan settings of the auto-configured scan unit, like the file format, including compression to deliver the scanned data in. This property is ignored if the scanner is not capable of auto-configuration. + +## -property-value +The scan configuration. Null if the scanner is not capable of auto-configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_defaultscansource.md b/windows.devices.scanners/imagescanner_defaultscansource.md index 83670c9032..bc55b8cb8d 100644 --- a/windows.devices.scanners/imagescanner_defaultscansource.md +++ b/windows.devices.scanners/imagescanner_defaultscansource.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScanner.DefaultScanSource --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScanner.DefaultScanSource ## -description Gets the default scan source chosen for this scanner device. ## -property-value The type of scan source. ## -remarks By default, the scan source will be selected from the device in this order of priority: + 1. Auto + 2. Flatbed + 3. Feeder ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScanner.DefaultScanSource +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScanner.DefaultScanSource + +## -description +Gets the default scan source chosen for this scanner device. + +## -property-value +The type of scan source. + +## -remarks +By default, the scan source will be selected from the device in this order of priority: ++ 1. Auto ++ 2. Flatbed ++ 3. Feeder + + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_deviceid.md b/windows.devices.scanners/imagescanner_deviceid.md index 3c4ebf08b1..909c10e412 100644 --- a/windows.devices.scanners/imagescanner_deviceid.md +++ b/windows.devices.scanners/imagescanner_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScanner.DeviceId --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScanner.DeviceId ## -description Gets the PnP device identifier of this scanner device. ## -property-value The PnP device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScanner.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScanner.DeviceId + +## -description +Gets the PnP device identifier of this scanner device. + +## -property-value +The PnP device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_feederconfiguration.md b/windows.devices.scanners/imagescanner_feederconfiguration.md index 2651023847..aca5f9e224 100644 --- a/windows.devices.scanners/imagescanner_feederconfiguration.md +++ b/windows.devices.scanners/imagescanner_feederconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScanner.FeederConfiguration --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScanner.FeederConfiguration ## -description Gets or sets the scan settings of the Feeder scan unit, like page size, orientation, and scan resolution. ## -property-value The scanner's Feeder configuration. Null if there is no Feeder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScanner.FeederConfiguration +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScanner.FeederConfiguration + +## -description +Gets or sets the scan settings of the Feeder scan unit, like page size, orientation, and scan resolution. + +## -property-value +The scanner's Feeder configuration. Null if there is no Feeder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_flatbedconfiguration.md b/windows.devices.scanners/imagescanner_flatbedconfiguration.md index 5d3d3a1b48..3ed2522aaf 100644 --- a/windows.devices.scanners/imagescanner_flatbedconfiguration.md +++ b/windows.devices.scanners/imagescanner_flatbedconfiguration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScanner.FlatbedConfiguration --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScanner.FlatbedConfiguration ## -description Gets and sets the scan settings of the Flatbed scan unit, like scan resolution and color mode. ## -property-value The scan configuration of the scanner's Flatbed. Null if there is no Flatbed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScanner.FlatbedConfiguration +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScanner.FlatbedConfiguration + +## -description +Gets and sets the scan settings of the Flatbed scan unit, like scan resolution and color mode. + +## -property-value +The scan configuration of the scanner's Flatbed. Null if there is no Flatbed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_fromidasync_1322863552.md b/windows.devices.scanners/imagescanner_fromidasync_1322863552.md index 700b0f8568..cb4e812ba5 100644 --- a/windows.devices.scanners/imagescanner_fromidasync_1322863552.md +++ b/windows.devices.scanners/imagescanner_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScanner.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScanner.FromIdAsync ## -description Creates an instance of a [ImageScanner](imagescanner.md) object based on a scanners device information ID. This method is required for broker device enumeration. ## -parameters ### -param deviceId The device information ID. See [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property. ## -returns The [ImageScanner](imagescanner.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScanner.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScanner.FromIdAsync + +## -description +Creates an instance of a [ImageScanner](imagescanner.md) object based on a scanners device information ID. This method is required for broker device enumeration. + +## -parameters +### -param deviceId +The device information ID. See [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property. + +## -returns +The [ImageScanner](imagescanner.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_getdeviceselector_838466080.md b/windows.devices.scanners/imagescanner_getdeviceselector_838466080.md index 942330c500..97b15ea877 100644 --- a/windows.devices.scanners/imagescanner_getdeviceselector_838466080.md +++ b/windows.devices.scanners/imagescanner_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScanner.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScanner.GetDeviceSelector ## -description Returns the class selection string that apps can use to enumerate scanner devices. This method is required for the brokered device enumeration. ## -returns The class selection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScanner.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScanner.GetDeviceSelector + +## -description +Returns the class selection string that apps can use to enumerate scanner devices. This method is required for the brokered device enumeration. + +## -returns +The class selection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_ispreviewsupported_1814773792.md b/windows.devices.scanners/imagescanner_ispreviewsupported_1814773792.md index 15a25df270..3179f10a7a 100644 --- a/windows.devices.scanners/imagescanner_ispreviewsupported_1814773792.md +++ b/windows.devices.scanners/imagescanner_ispreviewsupported_1814773792.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScanner.IsPreviewSupported(Windows.Devices.Scanners.ImageScannerScanSource) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScanner.IsPreviewSupported ## -description Determines if the specified scan source supports scan preview. ## -parameters ### -param scanSource The scan source. ## -returns Returns True if the specified scan source supports preview; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScanner.IsPreviewSupported(Windows.Devices.Scanners.ImageScannerScanSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScanner.IsPreviewSupported + +## -description +Determines if the specified scan source supports scan preview. + +## -parameters +### -param scanSource +The scan source. + +## -returns +Returns True if the specified scan source supports preview; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_isscansourcesupported_233028473.md b/windows.devices.scanners/imagescanner_isscansourcesupported_233028473.md index c2ee3852e4..37fb9a9716 100644 --- a/windows.devices.scanners/imagescanner_isscansourcesupported_233028473.md +++ b/windows.devices.scanners/imagescanner_isscansourcesupported_233028473.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScanner.IsScanSourceSupported(Windows.Devices.Scanners.ImageScannerScanSource) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScanner.IsScanSourceSupported ## -description Determines if the specified scan source is available on the scanner. ## -parameters ### -param value The scan source. ## -returns True if the scan source, Flatbed or Feeder, is available; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScanner.IsScanSourceSupported(Windows.Devices.Scanners.ImageScannerScanSource) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScanner.IsScanSourceSupported + +## -description +Determines if the specified scan source is available on the scanner. + +## -parameters +### -param value +The scan source. + +## -returns +True if the scan source, Flatbed or Feeder, is available; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_scanfilestofolderasync_1480338181.md b/windows.devices.scanners/imagescanner_scanfilestofolderasync_1480338181.md index 1f4aa59079..c3127b4eca 100644 --- a/windows.devices.scanners/imagescanner_scanfilestofolderasync_1480338181.md +++ b/windows.devices.scanners/imagescanner_scanfilestofolderasync_1480338181.md @@ -1,3 +1,66 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScanner.ScanFilesToFolderAsync(Windows.Devices.Scanners.ImageScannerScanSource,Windows.Storage.StorageFolder) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScanner.ScanFilesToFolderAsync ## -description Starts a scan job with the specified scan source and writes one or multiple images to one multi-page file like TIFF, XPS, and PDF; or one or multiple single-page files like DIB, PNG, JPG, and TIFF to the specified folder location. Returns the progress of the scan. ## -parameters ### -param scanSource The image scan source. ### -param storageFolder The target folder location of the scanned file. ## -returns The list of scanned image files from ImageScannerScanResult and the progress of the WIA scan job from UInt32, which indicates how many files were transferred to the target folder. ## -remarks The files are named using temporary names, with a standard file extension that depends on the file format type. > [!NOTE] > In Windows Store app, when this method is invoked, the app must be visible and running in the foreground. When the app cancels the async call, it initiates a cancellation request of the current scan job. There is no guarantee that if the app cancels the async call that the scan job will be canceled. If the cancellation goes through, the scanner may stop for these reasons: + It takes a few seconds before the scanner stops scanning. + It stops only when it runs out of paper (for a Feeder acquisition). + It completes running the scan head to the end of the bed and then fully returns the scan head to its parked location (for a Flatbed acquisition). Internally the async cancelation will flag the current WIA 2.0 scan job as canceled from within the app. If the WIA device makes the next callback to the WIA service the job cancellation may or may not be successfully communicated to the WIA driver. But, even if the WIA driver receives the cancel request from one of its callbacks there is no guarantee that the driver can successfully stop the scanner from scanning, immediately or after any predictable period of time. Here's the list of WIA specific HRESULT error codes as well as standard COM HRESULT error codes this function returns. > [!NOTE] > (the API will call WinRTOriginateError and/or OriginateErrorWithResourceString (all specific WIA errors will have localizable error descriptions) for the WIA specific failure HRESULTs):
WIA_ERROR_GENERAL_ERRORWIA_ERROR_PAPER_JAMWIA_ERROR_PAPER_EMPTY
WIA_ERROR_PAPER_PROBLEMWIA_ERROR_OFFLINEWIA_ERROR_BUSY
WIA_ERROR_WARMING_UPWIA_ERROR_USER_INTERVENTIONWIA_ERROR_ITEM_DELETED
WIA_ERROR_DEVICE_COMMUNICATIONWIA_ERROR_INVALID_COMMANDWIA_ERROR_INCORRECT_HARDWARE_SETTING
WIA_ERROR_DEVICE_LOCKEDWIA_ERROR_EXCEPTION_IN_DRIVERWIA_ERROR_INVALID_DRIVER_RESPONSE
WIA_ERROR_COVER_OPENWIA_ERROR_LAMP_OFFWIA_ERROR_MULTI_FEED
There are two special cases: + The WIA’s HRESULT of S_FALSE will be translated to a canceled async call (AsyncStatus.Canceled). + The WIA’s WIA_ERROR_PAPER_EMPTY will be translated by this API to a successful return (AsyncStatus.Completed) with an empty list of files (IVectorView.Size set to 0). To prevent orphan files, this method deletes any remaining orphan files used to transfer images upon failure, before the failure occurred. The method will save the transfer files as temporary files and keep them until the scan job completes. The app must instruct the user to rescan the document. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScanner.ScanFilesToFolderAsync(Windows.Devices.Scanners.ImageScannerScanSource,Windows.Storage.StorageFolder) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScanner.ScanFilesToFolderAsync + +## -description +Starts a scan job with the specified scan source and writes one or multiple images to one multi-page file like TIFF, XPS, and PDF; or one or multiple single-page files like DIB, PNG, JPG, and TIFF to the specified folder location. Returns the progress of the scan. + +## -parameters +### -param scanSource +The image scan source. + +### -param storageFolder +The target folder location of the scanned file. + +## -returns +The list of scanned image files from ImageScannerScanResult and the progress of the WIA scan job from UInt32, which indicates how many files were transferred to the target folder. + +## -remarks +The files are named using temporary names, with a standard file extension that depends on the file format type. + + + +> [!NOTE] +> In Windows Store app, when this method is invoked, the app must be visible and running in the foreground. + +When the app cancels the async call, it initiates a cancellation request of the current scan job. There is no guarantee that if the app cancels the async call that the scan job will be canceled. If the cancellation goes through, the scanner may stop for these reasons: + + ++ It takes a few seconds before the scanner stops scanning. ++ It stops only when it runs out of paper (for a Feeder acquisition). ++ It completes running the scan head to the end of the bed and then fully returns the scan head to its parked location (for a Flatbed acquisition). + + +Internally the async cancelation will flag the current WIA 2.0 scan job as canceled from within the app. If the WIA device makes the next callback to the WIA service the job cancellation may or may not be successfully communicated to the WIA driver. But, even if the WIA driver receives the cancel request from one of its callbacks there is no guarantee that the driver can successfully stop the scanner from scanning, immediately or after any predictable period of time. + +Here's the list of WIA specific HRESULT error codes as well as standard COM HRESULT error codes this function returns. + +> [!NOTE] +> (the API will call WinRTOriginateError and/or OriginateErrorWithResourceString (all specific WIA errors will have localizable error descriptions) for the WIA specific failure HRESULTs): + + + + + + + + +
WIA_ERROR_GENERAL_ERRORWIA_ERROR_PAPER_JAMWIA_ERROR_PAPER_EMPTY
WIA_ERROR_PAPER_PROBLEMWIA_ERROR_OFFLINEWIA_ERROR_BUSY
WIA_ERROR_WARMING_UPWIA_ERROR_USER_INTERVENTIONWIA_ERROR_ITEM_DELETED
WIA_ERROR_DEVICE_COMMUNICATIONWIA_ERROR_INVALID_COMMANDWIA_ERROR_INCORRECT_HARDWARE_SETTING
WIA_ERROR_DEVICE_LOCKEDWIA_ERROR_EXCEPTION_IN_DRIVERWIA_ERROR_INVALID_DRIVER_RESPONSE
WIA_ERROR_COVER_OPENWIA_ERROR_LAMP_OFFWIA_ERROR_MULTI_FEED
+ +There are two special cases: + + ++ The WIA’s HRESULT of S_FALSE will be translated to a canceled async call (AsyncStatus.Canceled). ++ The WIA’s WIA_ERROR_PAPER_EMPTY will be translated by this API to a successful return (AsyncStatus.Completed) with an empty list of files (IVectorView.Size set to 0). +To prevent orphan files, this method deletes any remaining orphan files used to transfer images upon failure, before the failure occurred. The method will save the transfer files as temporary files and keep them until the scan job completes. The app must instruct the user to rescan the document. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescanner_scanpreviewtostreamasync_148361145.md b/windows.devices.scanners/imagescanner_scanpreviewtostreamasync_148361145.md index f6c2eaec5b..b4aada77bd 100644 --- a/windows.devices.scanners/imagescanner_scanpreviewtostreamasync_148361145.md +++ b/windows.devices.scanners/imagescanner_scanpreviewtostreamasync_148361145.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScanner.ScanPreviewToStreamAsync(Windows.Devices.Scanners.ImageScannerScanSource,Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScanner.ScanPreviewToStreamAsync ## -description Scans one image from the specified scan source and applies the lowest scan resolution with the selected image file format. ## -parameters ### -param scanSource The image scan source. ### -param targetStream The scanned image file. ## -returns The progress of the scan and the scanned file format. ## -remarks Attempting to preview from a Feeder that supports preview but is empty at the time will result in a successful completion of the async call. The app should check for the returned [ImageScannerPreviewResult.Succeeded](imagescannerpreviewresult.md) result before attempting to read data from the stream, especially when scanning from the Feeder. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScanner.ScanPreviewToStreamAsync(Windows.Devices.Scanners.ImageScannerScanSource,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScanner.ScanPreviewToStreamAsync + +## -description +Scans one image from the specified scan source and applies the lowest scan resolution with the selected image file format. + +## -parameters +### -param scanSource +The image scan source. + +### -param targetStream +The scanned image file. + +## -returns +The progress of the scan and the scanned file format. + +## -remarks +Attempting to preview from a Feeder that supports preview but is empty at the time will result in a successful completion of the async call. The app should check for the returned [ImageScannerPreviewResult.Succeeded](imagescannerpreviewresult.md) result before attempting to read data from the stream, especially when scanning from the Feeder. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerautoconfiguration.md b/windows.devices.scanners/imagescannerautoconfiguration.md index 021fa0c431..9e7c04e9d7 100644 --- a/windows.devices.scanners/imagescannerautoconfiguration.md +++ b/windows.devices.scanners/imagescannerautoconfiguration.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Scanners.ImageScannerAutoConfiguration --api-type: winrt class ---- # Windows.Devices.Scanners.ImageScannerAutoConfiguration ## -description Represents the auto-configured scan source of the scanner. ## -remarks ## -examples ## -see-also [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Scanners.ImageScannerAutoConfiguration +-api-type: winrt class +--- + + + +# Windows.Devices.Scanners.ImageScannerAutoConfiguration + +## -description +Represents the auto-configured scan source of the scanner. + +## -remarks + +## -examples + +## -see-also +[IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md) \ No newline at end of file diff --git a/windows.devices.scanners/imagescannerautoconfiguration_defaultformat.md b/windows.devices.scanners/imagescannerautoconfiguration_defaultformat.md index ca198e441b..eed87d9041 100644 --- a/windows.devices.scanners/imagescannerautoconfiguration_defaultformat.md +++ b/windows.devices.scanners/imagescannerautoconfiguration_defaultformat.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerAutoConfiguration.DefaultFormat --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerAutoConfiguration.DefaultFormat ## -description The default file format for the scan source at the beginning of a new scan session. ## -property-value The file type. ## -remarks All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + 1. Jpeg + 2. Png + 3. Bitmap ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerAutoConfiguration.DefaultFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerAutoConfiguration.DefaultFormat + +## -description +The default file format for the scan source at the beginning of a new scan session. + +## -property-value +The file type. + +## -remarks +All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. + +By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + + ++ 1. Jpeg ++ 2. Png ++ 3. Bitmap + + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerautoconfiguration_format.md b/windows.devices.scanners/imagescannerautoconfiguration_format.md index 04cc4548b2..2901f3fb6b 100644 --- a/windows.devices.scanners/imagescannerautoconfiguration_format.md +++ b/windows.devices.scanners/imagescannerautoconfiguration_format.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerAutoConfiguration.Format --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerAutoConfiguration.Format ## -description Gets or sets the current file transfer format for image data acquisition from the device to the client app. ## -property-value The file type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerAutoConfiguration.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerAutoConfiguration.Format + +## -description +Gets or sets the current file transfer format for image data acquisition from the device to the client app. + +## -property-value +The file type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerautoconfiguration_isformatsupported_1921560568.md b/windows.devices.scanners/imagescannerautoconfiguration_isformatsupported_1921560568.md index 93c2e9f2e6..5d15d0f6d8 100644 --- a/windows.devices.scanners/imagescannerautoconfiguration_isformatsupported_1921560568.md +++ b/windows.devices.scanners/imagescannerautoconfiguration_isformatsupported_1921560568.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerAutoConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerAutoConfiguration.IsFormatSupported ## -description Determines if the input scanner supports the specified file format. ## -parameters ### -param value The file type. ## -returns True if the specified file type is supported; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerAutoConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerAutoConfiguration.IsFormatSupported + +## -description +Determines if the input scanner supports the specified file format. + +## -parameters +### -param value +The file type. + +## -returns +True if the specified file type is supported; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration.md b/windows.devices.scanners/imagescannerfeederconfiguration.md index 0c2d5171ba..188697a650 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Scanners.ImageScannerFeederConfiguration --api-type: winrt class ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration ## -description Represents the Feeder scan source of the scanner. ## -remarks This runtime class implements the [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md), and [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) interfaces. ## -examples ## -see-also [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md), [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Scanners.ImageScannerFeederConfiguration +-api-type: winrt class +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration + +## -description +Represents the Feeder scan source of the scanner. + +## -remarks +This runtime class implements the [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md), and [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) interfaces. + +## -examples + +## -see-also +[IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md), [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) \ No newline at end of file diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_actualresolution.md b/windows.devices.scanners/imagescannerfeederconfiguration_actualresolution.md index cb693e9bfb..cde2ba2117 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_actualresolution.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_actualresolution.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ActualResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.ActualResolution ## -description Gets the actual horizontal and vertical scan resolution for the scanner's Feeder, in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ActualResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.ActualResolution + +## -description +Gets the actual horizontal and vertical scan resolution for the scanner's Feeder, in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_autocroppingmode.md b/windows.devices.scanners/imagescannerfeederconfiguration_autocroppingmode.md index b7e8c38486..d533341aba 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_autocroppingmode.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_autocroppingmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoCroppingMode --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoCroppingMode ## -description Gets or sets the automatic crop mode. ## -property-value The automatic crop mode for the scan. ## -remarks When automatic detection is enabled on the scanner's Feeder, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is **Disabled**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoCroppingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoCroppingMode + +## -description +Gets or sets the automatic crop mode. + +## -property-value +The automatic crop mode for the scan. + +## -remarks +When automatic detection is enabled on the scanner's Feeder, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is **Disabled**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_autodetectpagesize.md b/windows.devices.scanners/imagescannerfeederconfiguration_autodetectpagesize.md index 708efc65c6..7c5f0e96cb 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_autodetectpagesize.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_autodetectpagesize.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoDetectPageSize --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoDetectPageSize ## -description Gets or sets the page size automatic detection feature for the scanner's Feeder. ## -property-value True if the page size automatic detection feature is enabled; otherwise False. ## -remarks This property can be True only if [CanAutoDetectPageSize](imagescannerfeederconfiguration_canautodetectpagesize.md) property is True. When this property is True the [PageSize](imagescannerfeederconfiguration_pagesize.md) and [PageOrientation](imagescannerfeederconfiguration_pageorientation.md) values are ignored. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoDetectPageSize +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.AutoDetectPageSize + +## -description +Gets or sets the page size automatic detection feature for the scanner's Feeder. + +## -property-value +True if the page size automatic detection feature is enabled; otherwise False. + +## -remarks +This property can be True only if [CanAutoDetectPageSize](imagescannerfeederconfiguration_canautodetectpagesize.md) property is True. When this property is True the [PageSize](imagescannerfeederconfiguration_pagesize.md) and [PageOrientation](imagescannerfeederconfiguration_pageorientation.md) values are ignored. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_brightness.md b/windows.devices.scanners/imagescannerfeederconfiguration_brightness.md index a4613b82b2..77ba4c7329 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_brightness.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_brightness.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Brightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.Brightness ## -description Gets or sets the current brightness level for capturing image data from the scanner's Feeder. At the beginning of a new scan session, this property is set to the [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md) property. ## -property-value The current brightness level. ## -remarks Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinBrightness](imagescannerfeederconfiguration_minbrightness.md) and [MaxBrightness](imagescannerfeederconfiguration_maxbrightness.md) values, and also relates to the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value with this equation: **Brightness = MinBrightness + (N * BrightnessStep)** where N is a positive integer smaller than or equal to **(MaxBrightness - MinBrightness) / BrightnessStep**. The app can return the brightness level to default by setting the value of this property to [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md). If the scanner doesn't allow brightness adjustments, **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, the **BrightnessStep** value is 0, and the app can't set the **Brightness** property to a value other than **DefaultBrightness**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Brightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.Brightness + +## -description +Gets or sets the current brightness level for capturing image data from the scanner's Feeder. At the beginning of a new scan session, this property is set to the [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md) property. + +## -property-value +The current brightness level. + +## -remarks +Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinBrightness](imagescannerfeederconfiguration_minbrightness.md) and [MaxBrightness](imagescannerfeederconfiguration_maxbrightness.md) values, and also relates to the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value with this equation: + +**Brightness = MinBrightness + (N * BrightnessStep)** + +where N is a positive integer smaller than or equal to **(MaxBrightness - MinBrightness) / BrightnessStep**. + +The app can return the brightness level to default by setting the value of this property to [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md). + +If the scanner doesn't allow brightness adjustments, **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, the **BrightnessStep** value is 0, and the app can't set the **Brightness** property to a value other than **DefaultBrightness**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_brightnessstep.md b/windows.devices.scanners/imagescannerfeederconfiguration_brightnessstep.md index f78c4a2fe4..cdd8fd18df 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_brightnessstep.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_brightnessstep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.BrightnessStep --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.BrightnessStep ## -description Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values. ## -property-value The step size to increment or decrement. A typical value is 1. ## -remarks If the scanner doesn't allow brightness changes, then the **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, and the **BrightnessStep** is set to 0. Your app can determine if the scan source doesn't support brightness adjustments by reading the **BrightnessStep** value. If the value is greater than 0, the scan source supports brightness adjustments. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.BrightnessStep +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.BrightnessStep + +## -description +Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values. + +## -property-value +The step size to increment or decrement. A typical value is 1. + +## -remarks +If the scanner doesn't allow brightness changes, then the **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, and the **BrightnessStep** is set to 0. Your app can determine if the scan source doesn't support brightness adjustments by reading the **BrightnessStep** value. If the value is greater than 0, the scan source supports brightness adjustments. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_canautodetectpagesize.md b/windows.devices.scanners/imagescannerfeederconfiguration_canautodetectpagesize.md index 0a51ea830a..0a535a12ec 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_canautodetectpagesize.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_canautodetectpagesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanAutoDetectPageSize --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanAutoDetectPageSize ## -description Returns True if the device can automatically detect at scan time the size of the document pages scanned through the Feeder; otherwise returns False. ## -property-value True if the device can automatically detect at scan time the size of the document pages scanned through the Feeder; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanAutoDetectPageSize +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanAutoDetectPageSize + +## -description +Returns True if the device can automatically detect at scan time the size of the document pages scanned through the Feeder; otherwise returns False. + +## -property-value +True if the device can automatically detect at scan time the size of the document pages scanned through the Feeder; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_canscanahead.md b/windows.devices.scanners/imagescannerfeederconfiguration_canscanahead.md index ab87697c03..0d46ba5b63 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_canscanahead.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_canscanahead.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanAhead --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanAhead ## -description Gets whether the scanner device is capable of scanning ahead from its Feeder. ## -property-value Indicates whether or not the scanner's Feeder can scan ahead. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanAhead +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanAhead + +## -description +Gets whether the scanner device is capable of scanning ahead from its Feeder. + +## -property-value +Indicates whether or not the scanner's Feeder can scan ahead. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_canscanduplex.md b/windows.devices.scanners/imagescannerfeederconfiguration_canscanduplex.md index bd02ebf60a..50334d37b8 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_canscanduplex.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_canscanduplex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanDuplex --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanDuplex ## -description Gets whether the scanner's Feeder is capable of duplex scanning (scanning both document page sides, front and back). When scanning in duplex mode the same scan settings (such as color mode and scan resolution) are applied to scan both page sides. ## -property-value Indicates whether duplex scanning is available. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanDuplex +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.CanScanDuplex + +## -description +Gets whether the scanner's Feeder is capable of duplex scanning (scanning both document page sides, front and back). When scanning in duplex mode the same scan settings (such as color mode and scan resolution) are applied to scan both page sides. + +## -property-value +Indicates whether duplex scanning is available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_colormode.md b/windows.devices.scanners/imagescannerfeederconfiguration_colormode.md index 70aa9c2dd5..24a6963ba8 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_colormode.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_colormode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ColorMode --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.ColorMode ## -description Gets or sets the color mode for the scanner's Feeder. ## -property-value The color mode. ## -remarks When a new scan session starts, this property is the same as the [DefaultColorMode](imagescannerfeederconfiguration_defaultcolormode.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ColorMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.ColorMode + +## -description +Gets or sets the color mode for the scanner's Feeder. + +## -property-value +The color mode. + +## -remarks +When a new scan session starts, this property is the same as the [DefaultColorMode](imagescannerfeederconfiguration_defaultcolormode.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_contrast.md b/windows.devices.scanners/imagescannerfeederconfiguration_contrast.md index 4e7866f788..a07756b032 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_contrast.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_contrast.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Contrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.Contrast ## -description Sets or gets the current contrast level for capturing image data from the scanner's Feeder. At the beginning of a new scan session this property is set to the [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) property. ## -property-value The contrast level. ## -remarks Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinContrast](imagescannerfeederconfiguration_mincontrast.md) and [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) values, and also relates to the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value with this equation: **Contrast = MinContrast + (N * ContrastStep)** where N is a positive integer smaller than or equal to **(MaxContrast - MinContrast) / ContrastStep**. The app can return the contrast level to default by setting the value of this property to [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md). If the scanner doesn't allow contrast adjustments, **MinContrast**, **MaxContrast** and **DefaultContrast** are set to the same value-oftentimes 0, the **ContrastStep** value is 0, and the app can't set the **Contrast** property to a value other than **DefaultContrast**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Contrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.Contrast + +## -description +Sets or gets the current contrast level for capturing image data from the scanner's Feeder. At the beginning of a new scan session this property is set to the [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) property. + +## -property-value +The contrast level. + +## -remarks +Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinContrast](imagescannerfeederconfiguration_mincontrast.md) and [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) values, and also relates to the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value with this equation: + +**Contrast = MinContrast + (N * ContrastStep)** + +where N is a positive integer smaller than or equal to **(MaxContrast - MinContrast) / ContrastStep**. + +The app can return the contrast level to default by setting the value of this property to [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md). + +If the scanner doesn't allow contrast adjustments, **MinContrast**, **MaxContrast** and **DefaultContrast** are set to the same value-oftentimes 0, the **ContrastStep** value is 0, and the app can't set the **Contrast** property to a value other than **DefaultContrast**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_contraststep.md b/windows.devices.scanners/imagescannerfeederconfiguration_contraststep.md index 7052b7fc50..2e860c2de8 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_contraststep.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_contraststep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ContrastStep --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.ContrastStep ## -description Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values. ## -property-value The step size to increment or decrement. The typical value is 1. ## -remarks If the scanner doesn't allow contrast changes, then the [MinContrast](imagescannerfeederconfiguration_mincontrast.md), [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) and [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) are set to the same value-oftentimes 0, and the **ContrastStep** value is set to 0. Your app can determine if the scan source doesn't support contrast adjustments by reading the **ContrastStep** value. If the value is greater than 0, then the scan source supports contrast adjustments. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ContrastStep +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.ContrastStep + +## -description +Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values. + +## -property-value +The step size to increment or decrement. The typical value is 1. + +## -remarks +If the scanner doesn't allow contrast changes, then the [MinContrast](imagescannerfeederconfiguration_mincontrast.md), [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) and [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) are set to the same value-oftentimes 0, and the **ContrastStep** value is set to 0. Your app can determine if the scan source doesn't support contrast adjustments by reading the **ContrastStep** value. If the value is greater than 0, then the scan source supports contrast adjustments. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_defaultbrightness.md b/windows.devices.scanners/imagescannerfeederconfiguration_defaultbrightness.md index cab09f92f0..b24f711414 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_defaultbrightness.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_defaultbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultBrightness ## -description Gets the default brightness level for the scanner's Feeder. ## -property-value The default brightness level for the scanner. ## -remarks A scan source that doesn't allow brightness adjustments can have [MinBrightness](imagescannerfeederconfiguration_minbrightness.md), [MaxBrightness](imagescannerfeederconfiguration_maxbrightness.md) and **DefaultBrightness** set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultBrightness + +## -description +Gets the default brightness level for the scanner's Feeder. + +## -property-value +The default brightness level for the scanner. + +## -remarks +A scan source that doesn't allow brightness adjustments can have [MinBrightness](imagescannerfeederconfiguration_minbrightness.md), [MaxBrightness](imagescannerfeederconfiguration_maxbrightness.md) and **DefaultBrightness** set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_defaultcolormode.md b/windows.devices.scanners/imagescannerfeederconfiguration_defaultcolormode.md index 746b424691..298cb981a2 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_defaultcolormode.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_defaultcolormode.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultColorMode --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultColorMode ## -description Gets the default color mode for the scanner's Feeder. ## -property-value The color mode. ## -remarks When a new scan session begins, this property chooses the default color mode based on the pixel data types and bit depths that each scanner device supports. This is the order of priority: + AutoColor + Color + Grayscale + BlackAndWhite If the scanner device doesn't support any of the standard color modes, the current scan source will be considered unavailable and the app won’t be able to scan from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultColorMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultColorMode + +## -description +Gets the default color mode for the scanner's Feeder. + +## -property-value +The color mode. + +## -remarks +When a new scan session begins, this property chooses the default color mode based on the pixel data types and bit depths that each scanner device supports. This is the order of priority: + + ++ AutoColor ++ Color ++ Grayscale ++ BlackAndWhite +If the scanner device doesn't support any of the standard color modes, the current scan source will be considered unavailable and the app won’t be able to scan from there. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_defaultcontrast.md b/windows.devices.scanners/imagescannerfeederconfiguration_defaultcontrast.md index 5c1a094f86..3fc6aa21c0 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_defaultcontrast.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_defaultcontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultContrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultContrast ## -description Gets the default contrast level for the scanner's Feeder. ## -property-value The default contrast level. ## -remarks A scan source that doesn't allow contrast adjustments can have [MinContrast](imagescannerfeederconfiguration_mincontrast.md), [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) and **DefaultContrast** set to the same value-oftentimes 0, and the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultContrast + +## -description +Gets the default contrast level for the scanner's Feeder. + +## -property-value +The default contrast level. + +## -remarks +A scan source that doesn't allow contrast adjustments can have [MinContrast](imagescannerfeederconfiguration_mincontrast.md), [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) and **DefaultContrast** set to the same value-oftentimes 0, and the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_defaultformat.md b/windows.devices.scanners/imagescannerfeederconfiguration_defaultformat.md index ba82f02cdd..c4295b91cb 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_defaultformat.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_defaultformat.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultFormat --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultFormat ## -description Gets the default file format for the scanner's Feeder at the beginning of a new scan session. ## -property-value The file type. ## -remarks All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + 1. Jpeg + 2. Png + 3. Bitmap ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.DefaultFormat + +## -description +Gets the default file format for the scanner's Feeder at the beginning of a new scan session. + +## -property-value +The file type. + +## -remarks +All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. + +By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + + ++ 1. Jpeg ++ 2. Png ++ 3. Bitmap + + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_desiredresolution.md b/windows.devices.scanners/imagescannerfeederconfiguration_desiredresolution.md index 8d40c60d3b..309a28c396 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_desiredresolution.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_desiredresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DesiredResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.DesiredResolution ## -description Gets or sets the horizontal and vertical scan resolution for the scanner's Feeder that the app requests, in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks This property value can be [MinResolution](imagescannerfeederconfiguration_minresolution.md), [MaxResolution](imagescannerfeederconfiguration_maxresolution.md), or [OpticalResolution](imagescannerfeederconfiguration_opticalresolution.md). But, if your app sets this value to other resolutions, this property will choose the closest resolution values. See [ActualResolution](imagescannerfeederconfiguration_actualresolution.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.DesiredResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.DesiredResolution + +## -description +Gets or sets the horizontal and vertical scan resolution for the scanner's Feeder that the app requests, in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks +This property value can be [MinResolution](imagescannerfeederconfiguration_minresolution.md), [MaxResolution](imagescannerfeederconfiguration_maxresolution.md), or [OpticalResolution](imagescannerfeederconfiguration_opticalresolution.md). But, if your app sets this value to other resolutions, this property will choose the closest resolution values. See [ActualResolution](imagescannerfeederconfiguration_actualresolution.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_duplex.md b/windows.devices.scanners/imagescannerfeederconfiguration_duplex.md index c10221fdda..3f6816457a 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_duplex.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_duplex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Duplex --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.Duplex ## -description Indicates whether the scanner's Feeder can scan both document page sides. ## -property-value Returns True if the Feeder can scan both page sides. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Duplex +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.Duplex + +## -description +Indicates whether the scanner's Feeder can scan both document page sides. + +## -property-value +Returns True if the Feeder can scan both page sides. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_format.md b/windows.devices.scanners/imagescannerfeederconfiguration_format.md index 1c1085ba8d..084676d16b 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_format.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_format.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Format --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.Format ## -description Gets or sets the current file transfer format for image data acquisition from the scanner's Feeder to the client app. ## -property-value The file type. ## -remarks When a new scan session starts, this property is set to the default file format. See the [DefaultFormat](imagescannerfeederconfiguration_defaultformat.md) property on how this is done. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.Format + +## -description +Gets or sets the current file transfer format for image data acquisition from the scanner's Feeder to the client app. + +## -property-value +The file type. + +## -remarks +When a new scan session starts, this property is set to the default file format. See the [DefaultFormat](imagescannerfeederconfiguration_defaultformat.md) property on how this is done. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_isautocroppingmodesupported_2103996678.md b/windows.devices.scanners/imagescannerfeederconfiguration_isautocroppingmodesupported_2103996678.md index 37126478dd..c54d74620e 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_isautocroppingmodesupported_2103996678.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_isautocroppingmodesupported_2103996678.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsAutoCroppingModeSupported(Windows.Devices.Scanners.ImageScannerAutoCroppingMode) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsAutoCroppingModeSupported ## -description Returns whether the scanner's Feeder supports the specified [ImageScannerAutoCroppingMode](imagescannerautocroppingmode.md). ## -parameters ### -param value The auto crop mode of the image to scan. ## -returns Indicates whether the device supports *value* mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsAutoCroppingModeSupported(Windows.Devices.Scanners.ImageScannerAutoCroppingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsAutoCroppingModeSupported + +## -description +Returns whether the scanner's Feeder supports the specified [ImageScannerAutoCroppingMode](imagescannerautocroppingmode.md). + +## -parameters +### -param value +The auto crop mode of the image to scan. + +## -returns +Indicates whether the device supports *value* mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_iscolormodesupported_1543452622.md b/windows.devices.scanners/imagescannerfeederconfiguration_iscolormodesupported_1543452622.md index 646d6fab20..ce7a7b5514 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_iscolormodesupported_1543452622.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_iscolormodesupported_1543452622.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsColorModeSupported(Windows.Devices.Scanners.ImageScannerColorMode) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsColorModeSupported ## -description Returns whether the scanner's Feeder can scan and transfer images in the specified color mode. ## -parameters ### -param value The color mode. ## -returns Indicates whether the scanner can scan images in *value* mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsColorModeSupported(Windows.Devices.Scanners.ImageScannerColorMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsColorModeSupported + +## -description +Returns whether the scanner's Feeder can scan and transfer images in the specified color mode. + +## -parameters +### -param value +The color mode. + +## -returns +Indicates whether the scanner can scan images in *value* mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_isformatsupported_1921560568.md b/windows.devices.scanners/imagescannerfeederconfiguration_isformatsupported_1921560568.md index 8d2cde2c78..124ac1aa59 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_isformatsupported_1921560568.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_isformatsupported_1921560568.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsFormatSupported ## -description Determines whether the scanner's Feeder supports the specified file format or not. ## -parameters ### -param value The file type. ## -returns Indicates whether the specified file type is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsFormatSupported + +## -description +Determines whether the scanner's Feeder supports the specified file format or not. + +## -parameters +### -param value +The file type. + +## -returns +Indicates whether the specified file type is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_ispagesizesupported_560257665.md b/windows.devices.scanners/imagescannerfeederconfiguration_ispagesizesupported_560257665.md index 07e5fa5261..57768e306b 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_ispagesizesupported_560257665.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_ispagesizesupported_560257665.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsPageSizeSupported(Windows.Graphics.Printing.PrintMediaSize,Windows.Graphics.Printing.PrintOrientation) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsPageSizeSupported ## -description Returns whether the Feeder can scan documents in the specified page size and orientation. ## -parameters ### -param pageSize The page size. ### -param pageOrientation The page orientation. ## -returns Indicates the scanner can scan with *pageSize* and *pageOrientation* values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsPageSizeSupported(Windows.Graphics.Printing.PrintMediaSize,Windows.Graphics.Printing.PrintOrientation) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.IsPageSizeSupported + +## -description +Returns whether the Feeder can scan documents in the specified page size and orientation. + +## -parameters +### -param pageSize +The page size. + +### -param pageOrientation +The page orientation. + +## -returns +Indicates the scanner can scan with *pageSize* and *pageOrientation* values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_maxbrightness.md b/windows.devices.scanners/imagescannerfeederconfiguration_maxbrightness.md index 4088edd3c3..e443e086ab 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_maxbrightness.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_maxbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxBrightness ## -description Gets the maximum brightness level supported by the scanner's Feeder. ## -property-value The maximum brightness level, typically 1000. ## -remarks This property's value must be greater than or equal to the value of the [MinBrightness](imagescannerfeederconfiguration_minbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxBrightness + +## -description +Gets the maximum brightness level supported by the scanner's Feeder. + +## -property-value +The maximum brightness level, typically 1000. + +## -remarks +This property's value must be greater than or equal to the value of the [MinBrightness](imagescannerfeederconfiguration_minbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_maxcontrast.md b/windows.devices.scanners/imagescannerfeederconfiguration_maxcontrast.md index 95d954d791..51ec8d89cd 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_maxcontrast.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_maxcontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxContrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxContrast ## -description Gets the maximum contrast level supported by the scanner's Feeder. ## -property-value The maximum contrast level, typically 1000. ## -remarks This property's value must be greater than or equal to the value of the [MinContrast](imagescannerfeederconfiguration_mincontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxContrast + +## -description +Gets the maximum contrast level supported by the scanner's Feeder. + +## -property-value +The maximum contrast level, typically 1000. + +## -remarks +This property's value must be greater than or equal to the value of the [MinContrast](imagescannerfeederconfiguration_mincontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_maxnumberofpages.md b/windows.devices.scanners/imagescannerfeederconfiguration_maxnumberofpages.md index 09a0640987..b676760f90 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_maxnumberofpages.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_maxnumberofpages.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxNumberOfPages --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxNumberOfPages ## -description Gets or sets the maximum number of pages-not images, the app can scan in one scan job, before the scanner stops. ## -property-value The number of pages. ## -remarks The default value is 1. If this property is 0, the scanner must scan until the Feeder tray is empty. Each scanned page can produce one or more images. For example when scanning duplex with [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) set to [ImageScannerAutoCroppingMode.Disabled](imagescannerautocroppingmode.md) there are two images to acquire for each scanned page (one image from the front and another image from the back side of the scanned page). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxNumberOfPages +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxNumberOfPages + +## -description +Gets or sets the maximum number of pages-not images, the app can scan in one scan job, before the scanner stops. + +## -property-value +The number of pages. + +## -remarks +The default value is 1. If this property is 0, the scanner must scan until the Feeder tray is empty. Each scanned page can produce one or more images. For example when scanning duplex with [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) set to [ImageScannerAutoCroppingMode.Disabled](imagescannerautocroppingmode.md) there are two images to acquire for each scanned page (one image from the front and another image from the back side of the scanned page). + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_maxresolution.md b/windows.devices.scanners/imagescannerfeederconfiguration_maxresolution.md index 02552e2d5b..7b4cb6e48b 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_maxresolution.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_maxresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxResolution ## -description Gets the maximum horizontal and vertical scan resolution of the scanner's Feeder in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks Apps can scan at **MaxResolution** in a small area at the highest possible resolution. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxResolution + +## -description +Gets the maximum horizontal and vertical scan resolution of the scanner's Feeder in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks +Apps can scan at **MaxResolution** in a small area at the highest possible resolution. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_maxscanarea.md b/windows.devices.scanners/imagescannerfeederconfiguration_maxscanarea.md index 8e77e5d560..4ab9e61def 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_maxscanarea.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_maxscanarea.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxScanArea --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxScanArea ## -description Gets the maximum scan area dimensions in inches. The maximum scan width is the widest a document can be in order for the scanner's Feeder to scan it. ## -property-value The width and height of the area. ## -remarks For Feeder scan sources, there are restrictions for the maximum scan area: + The currently selected page size, if page size auto-detection is not enabled. + The dimensions of the selected page size, which becomes the new maximum dimensions of the permissible scan area. These limits are dictated by hardware for Feeder, Flatbed and other types of scan sources. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxScanArea +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MaxScanArea + +## -description +Gets the maximum scan area dimensions in inches. The maximum scan width is the widest a document can be in order for the scanner's Feeder to scan it. + +## -property-value +The width and height of the area. + +## -remarks +For Feeder scan sources, there are restrictions for the maximum scan area: ++ The currently selected page size, if page size auto-detection is not enabled. ++ The dimensions of the selected page size, which becomes the new maximum dimensions of the permissible scan area. + These limits are dictated by hardware for Feeder, Flatbed and other types of scan sources. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_minbrightness.md b/windows.devices.scanners/imagescannerfeederconfiguration_minbrightness.md index 66f7574285..f7f802e9cb 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_minbrightness.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_minbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinBrightness ## -description Gets the minimum brightness level supported by the scanner's Feeder. ## -property-value The minimum brightness level, typically -1000. ## -remarks This property's value must be smaller than or equal to the value of the [MaxBrightness](imagescannerfeederconfiguration_maxbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinBrightness + +## -description +Gets the minimum brightness level supported by the scanner's Feeder. + +## -property-value +The minimum brightness level, typically -1000. + +## -remarks +This property's value must be smaller than or equal to the value of the [MaxBrightness](imagescannerfeederconfiguration_maxbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerfeederconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerfeederconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_mincontrast.md b/windows.devices.scanners/imagescannerfeederconfiguration_mincontrast.md index 08406f3bc0..c4f5dea017 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_mincontrast.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_mincontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinContrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinContrast ## -description Gets the minimum contrast level supported by the scanner's Feeder. ## -property-value The minimum contrast level, typically -1000. ## -remarks This property's value must be smaller than or equal to the value of the [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinContrast + +## -description +Gets the minimum contrast level supported by the scanner's Feeder. + +## -property-value +The minimum contrast level, typically -1000. + +## -remarks +This property's value must be smaller than or equal to the value of the [MaxContrast](imagescannerfeederconfiguration_maxcontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerfeederconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerfeederconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_minresolution.md b/windows.devices.scanners/imagescannerfeederconfiguration_minresolution.md index 7572d4c3f6..3aad7fba80 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_minresolution.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_minresolution.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinResolution ## -description Gets the minimum horizontal and vertical scan resolution of the scanner's Feeder in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinResolution + +## -description +Gets the minimum horizontal and vertical scan resolution of the scanner's Feeder in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_minscanarea.md b/windows.devices.scanners/imagescannerfeederconfiguration_minscanarea.md index 9ff926db16..ee1bed5938 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_minscanarea.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_minscanarea.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinScanArea --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinScanArea ## -description Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Feeder to scan it. ## -property-value The width and height of the area. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinScanArea +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.MinScanArea + +## -description +Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Feeder to scan it. + +## -property-value +The width and height of the area. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_opticalresolution.md b/windows.devices.scanners/imagescannerfeederconfiguration_opticalresolution.md index 83d4c7e1bd..dde0ece4d6 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_opticalresolution.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_opticalresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.OpticalResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.OpticalResolution ## -description Gets the optical horizontal and vertical scan resolution of the scanner's Feeder in DPI. ## -property-value The horizontal and vertical scan resolution in pixels. ## -remarks Apps can scan at **OpticalResolution** for the best quality per pixel that the hardware device is capable of. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.OpticalResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.OpticalResolution + +## -description +Gets the optical horizontal and vertical scan resolution of the scanner's Feeder in DPI. + +## -property-value +The horizontal and vertical scan resolution in pixels. + +## -remarks +Apps can scan at **OpticalResolution** for the best quality per pixel that the hardware device is capable of. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_pageorientation.md b/windows.devices.scanners/imagescannerfeederconfiguration_pageorientation.md index fe58040eff..38728c104c 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_pageorientation.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_pageorientation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageOrientation --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageOrientation ## -description Gets or sets the currently selected page orientation that tells how to place the documents in the scanner's Feeder input tray. ## -property-value The orientation of the page. ## -remarks Some devices may not support all orientation values for all [PageSize](imagescannerfeederconfiguration_pagesize.md) values. For example, a [MaxScanArea.Width](imagescannerfeederconfiguration_maxscanarea.md) of 8500 (8.5”) and MaxScanArea.Height of 1100 (11”) can have a PageSize of NorthAmericaLetter and a PageOrientation of Portrait, but can't be Landscape. When the [AutoDetectPageSize](imagescannerfeederconfiguration_autodetectpagesize.md) property is True the scanner device automatically detects at scan time the size of the document pages being scanned and the values of the PageSize and PageOrientation properties are ignored. When the [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) property is SingleRegion or MultipleRegion, the scanner device will detect crop regions (and scan them to separate images) while the Feeder feeds and scans the specified document size. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageOrientation +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageOrientation + +## -description +Gets or sets the currently selected page orientation that tells how to place the documents in the scanner's Feeder input tray. + +## -property-value +The orientation of the page. + +## -remarks +Some devices may not support all orientation values for all [PageSize](imagescannerfeederconfiguration_pagesize.md) values. For example, a [MaxScanArea.Width](imagescannerfeederconfiguration_maxscanarea.md) of 8500 (8.5”) and MaxScanArea.Height of 1100 (11”) can have a PageSize of NorthAmericaLetter and a PageOrientation of Portrait, but can't be Landscape. When the [AutoDetectPageSize](imagescannerfeederconfiguration_autodetectpagesize.md) property is True the scanner device automatically detects at scan time the size of the document pages being scanned and the values of the PageSize and PageOrientation properties are ignored. When the [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) property is SingleRegion or MultipleRegion, the scanner device will detect crop regions (and scan them to separate images) while the Feeder feeds and scans the specified document size. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_pagesize.md b/windows.devices.scanners/imagescannerfeederconfiguration_pagesize.md index 702dfe40aa..8a43959638 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_pagesize.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_pagesize.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSize --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSize ## -description Gets or sets the currently selected page size to scan from the Feeder. ## -property-value The page size. ## -remarks When the [AutoDetectPageSize](imagescannerfeederconfiguration_autodetectpagesize.md) property is True the scanner device automatically detects at scan time the size of the document pages to scan and the values of the PageSize and [PageOrientation](imagescannerfeederconfiguration_pageorientation.md) properties are ignored. When the [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) property is SingleRegion or MultiRegion, the scanner device will detect crop regions (and scan them to separate images) while the Feeder feeds and scans the specified document size. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSize +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSize + +## -description +Gets or sets the currently selected page size to scan from the Feeder. + +## -property-value +The page size. + +## -remarks +When the [AutoDetectPageSize](imagescannerfeederconfiguration_autodetectpagesize.md) property is True the scanner device automatically detects at scan time the size of the document pages to scan and the values of the PageSize and [PageOrientation](imagescannerfeederconfiguration_pageorientation.md) properties are ignored. + +When the [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) property is SingleRegion or MultiRegion, the scanner device will detect crop regions (and scan them to separate images) while the Feeder feeds and scans the specified document size. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_pagesizedimensions.md b/windows.devices.scanners/imagescannerfeederconfiguration_pagesizedimensions.md index 05e438d83e..cf9f1e4542 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_pagesizedimensions.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_pagesizedimensions.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSizeDimensions --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSizeDimensions ## -description Gets the dimensions (width and height) and orientation of the selected page size, in mil units (1/1000"). ## -property-value The page size. ## -remarks When the [AutoDetectPageSize](imagescannerfeederconfiguration_autodetectpagesize.md) property is False this property describes the dimensions (width and height) and orientation of the page size, in mil (1/1000”) units. For example, a Portrait NorthAmericaLetter having dimensions 8.5" x 11” has a PageSizeDimensions.Width value of 8500 units and a PageSizeDimensions.Height value of 11000 units, while a Landscape NorthAmericaLetter having dimensions 11" x 8.5” has a PageSizeDimensions.Width value of 11000 units and a PageSizeDimensions.Height value of 8500 units. When the **AutoDetectPageSize** property is True the value of this property is automatically set to MaximumScanArea.Width and MaximumScanArea.Height and the app should ignore it. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSizeDimensions +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.PageSizeDimensions + +## -description +Gets the dimensions (width and height) and orientation of the selected page size, in mil units (1/1000"). + +## -property-value +The page size. + +## -remarks +When the [AutoDetectPageSize](imagescannerfeederconfiguration_autodetectpagesize.md) property is False this property describes the dimensions (width and height) and orientation of the page size, in mil (1/1000”) units. For example, a Portrait NorthAmericaLetter having dimensions 8.5" x 11” has a PageSizeDimensions.Width value of 8500 units and a PageSizeDimensions.Height value of 11000 units, while a Landscape NorthAmericaLetter having dimensions 11" x 8.5” has a PageSizeDimensions.Width value of 11000 units and a PageSizeDimensions.Height value of 8500 units. + +When the **AutoDetectPageSize** property is True the value of this property is automatically set to MaximumScanArea.Width and MaximumScanArea.Height and the app should ignore it. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_scanahead.md b/windows.devices.scanners/imagescannerfeederconfiguration_scanahead.md index 7c0ae6b057..77dc42c6ed 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_scanahead.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_scanahead.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ScanAhead --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.ScanAhead ## -description Indicates whether or not to scan ahead. ## -property-value True to scan ahead. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.ScanAhead +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.ScanAhead + +## -description +Indicates whether or not to scan ahead. + +## -property-value +True to scan ahead. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerfeederconfiguration_selectedscanregion.md b/windows.devices.scanners/imagescannerfeederconfiguration_selectedscanregion.md index 1bca70ca17..e51366a2c5 100644 --- a/windows.devices.scanners/imagescannerfeederconfiguration_selectedscanregion.md +++ b/windows.devices.scanners/imagescannerfeederconfiguration_selectedscanregion.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.SelectedScanRegion --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFeederConfiguration.SelectedScanRegion ## -description Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) property is not **Disabled**. ## -property-value The scan region, in inches. ## -remarks This table describes the property's restrictions. Default values are set at the beginning of a new scan session.
NameDefault valueValid Flatbed valuesValid Feeder values
0between 0 and - 1between 0 and
0between 0 and - 1between 0 and
between and ( – )between and
between and ( – )between and
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFeederConfiguration.SelectedScanRegion +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFeederConfiguration.SelectedScanRegion + +## -description +Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the [AutoCroppingMode](imagescannerfeederconfiguration_autocroppingmode.md) property is not **Disabled**. + +## -property-value +The scan region, in inches. + +## -remarks +This table describes the property's restrictions. Default values are set at the beginning of a new scan session. + + + + + + + +
NameDefault valueValid Flatbed valuesValid Feeder values
0between 0 and - 1between 0 and
0between 0 and - 1between 0 and
between and ( – )between and
between and ( – )between and
+ +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration.md b/windows.devices.scanners/imagescannerflatbedconfiguration.md index d788e1896a..a0de781904 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration --api-type: winrt class ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration ## -description Represents the Flatbed scan source of the scanner. ## -remarks This runtime class implements the [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) interface and the [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md) interface. ## -examples ## -see-also [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md), [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration +-api-type: winrt class +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration + +## -description +Represents the Flatbed scan source of the scanner. + +## -remarks +This runtime class implements the [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) interface and the [IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md) interface. + +## -examples + +## -see-also +[IImageScannerFormatConfiguration](iimagescannerformatconfiguration.md), [IImageScannerSourceConfiguration](iimagescannersourceconfiguration.md) \ No newline at end of file diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_actualresolution.md b/windows.devices.scanners/imagescannerflatbedconfiguration_actualresolution.md index 74659774a0..cd44c88d2f 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_actualresolution.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_actualresolution.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ActualResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ActualResolution ## -description Gets the actual horizontal and vertical scan resolution for the Flatbed scanner, in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ActualResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ActualResolution + +## -description +Gets the actual horizontal and vertical scan resolution for the Flatbed scanner, in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_autocroppingmode.md b/windows.devices.scanners/imagescannerflatbedconfiguration_autocroppingmode.md index 6e20f3ba58..de8e9c651c 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_autocroppingmode.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_autocroppingmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.AutoCroppingMode --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.AutoCroppingMode ## -description Gets or sets the automatic crop mode. ## -property-value The automatic crop mode for the scan. ## -remarks When automatic detection is enabled on the scanner's Flatbed, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is **Disabled**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.AutoCroppingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.AutoCroppingMode + +## -description +Gets or sets the automatic crop mode. + +## -property-value +The automatic crop mode for the scan. + +## -remarks +When automatic detection is enabled on the scanner's Flatbed, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is **Disabled**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_brightness.md b/windows.devices.scanners/imagescannerflatbedconfiguration_brightness.md index 8c1508b019..b6f2ff3a16 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_brightness.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_brightness.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Brightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Brightness ## -description Gets or sets the current brightness level for capturing image data from the scanner's Flatbed. At the beginning of a new scan session, this property is set to the [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md) property. ## -property-value The current brightness level. ## -remarks Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinBrightness](imagescannerflatbedconfiguration_minbrightness.md) and [MaxBrightness](imagescannerflatbedconfiguration_maxbrightness.md) values, and also relates to the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value with this equation: **Brightness = MinBrightness + (N * BrightnessStep)** where N is a positive integer smaller than or equal to **(MaxBrightness - MinBrightness) / BrightnessStep**. The app can return the brightness level to default by setting the value of this property to [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md). If the scanner doesn't allow brightness adjustments, **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, the **BrightnessStep** value is 0, and the app can't set the **Brightness** property to a value other than **DefaultBrightness**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Brightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Brightness + +## -description +Gets or sets the current brightness level for capturing image data from the scanner's Flatbed. At the beginning of a new scan session, this property is set to the [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md) property. + +## -property-value +The current brightness level. + +## -remarks +Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinBrightness](imagescannerflatbedconfiguration_minbrightness.md) and [MaxBrightness](imagescannerflatbedconfiguration_maxbrightness.md) values, and also relates to the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value with this equation: + +**Brightness = MinBrightness + (N * BrightnessStep)** + +where N is a positive integer smaller than or equal to **(MaxBrightness - MinBrightness) / BrightnessStep**. + +The app can return the brightness level to default by setting the value of this property to [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md). + +If the scanner doesn't allow brightness adjustments, **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, the **BrightnessStep** value is 0, and the app can't set the **Brightness** property to a value other than **DefaultBrightness**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_brightnessstep.md b/windows.devices.scanners/imagescannerflatbedconfiguration_brightnessstep.md index 066efbd460..658541122d 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_brightnessstep.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_brightnessstep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.BrightnessStep --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.BrightnessStep ## -description Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values. ## -property-value The step size to increment or decrement. A typical value is 1. ## -remarks If the scanner doesn't allow brightness changes, then the **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, and the **BrightnessStep** is set to 0. Your app can determine if the scan source doesn't support brightness adjustments by reading the **BrightnessStep** value. If the value is greater than 0, the scan source supports brightness adjustments. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.BrightnessStep +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.BrightnessStep + +## -description +Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values. + +## -property-value +The step size to increment or decrement. A typical value is 1. + +## -remarks +If the scanner doesn't allow brightness changes, then the **MinBrightness**, **MaxBrightness** and **DefaultBrightness** are set to the same value-oftentimes 0, and the **BrightnessStep** is set to 0. Your app can determine if the scan source doesn't support brightness adjustments by reading the **BrightnessStep** value. If the value is greater than 0, the scan source supports brightness adjustments. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_colormode.md b/windows.devices.scanners/imagescannerflatbedconfiguration_colormode.md index 4879579357..813e3bf029 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_colormode.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_colormode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ColorMode --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ColorMode ## -description Gets or sets the color mode for the Flatbed scanner. ## -property-value The color mode. ## -remarks When a new scan session starts, this property is the same as the [DefaultColorMode](imagescannerflatbedconfiguration_defaultcolormode.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ColorMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ColorMode + +## -description +Gets or sets the color mode for the Flatbed scanner. + +## -property-value +The color mode. + +## -remarks +When a new scan session starts, this property is the same as the [DefaultColorMode](imagescannerflatbedconfiguration_defaultcolormode.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_contrast.md b/windows.devices.scanners/imagescannerflatbedconfiguration_contrast.md index 591f3b5b8d..c83922875b 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_contrast.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_contrast.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Contrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Contrast ## -description Sets or gets the current contrast level for capturing image data from the scan source. At the beginning of a new scan session this property is set to the [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) property. ## -property-value The contrast level. ## -remarks Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinContrast](imagescannerflatbedconfiguration_mincontrast.md) and [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) values, and also relates to the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value with this equation: **Contrast = MinContrast + (N * ContrastStep)** where N is a positive integer smaller than or equal to **(MaxContrast - MinContrast) / ContrastStep**. The app can return the contrast level to default by setting the value of this property to [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md). If the scanner doesn't allow contrast adjustments, **MinContrast**, **MaxContrast** and **DefaultContrast** are set to the same value-oftentimes 0, the **ContrastStep** value is 0, and the app can't set the **Contrast** property to a value other than **DefaultContrast**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Contrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Contrast + +## -description +Sets or gets the current contrast level for capturing image data from the scan source. At the beginning of a new scan session this property is set to the [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) property. + +## -property-value +The contrast level. + +## -remarks +Your app can set the value of this property to any [Int32](https://msdn.microsoft.com/library/system.int32.aspx) value between the [MinContrast](imagescannerflatbedconfiguration_mincontrast.md) and [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) values, and also relates to the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value with this equation: + +**Contrast = MinContrast + (N * ContrastStep)** + +where N is a positive integer smaller than or equal to **(MaxContrast - MinContrast) / ContrastStep**. + +The app can return the contrast level to default by setting the value of this property to [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md). + +If the scanner doesn't allow contrast adjustments, **MinContrast**, **MaxContrast** and **DefaultContrast** are set to the same value-oftentimes 0, the **ContrastStep** value is 0, and the app can't set the **Contrast** property to a value other than **DefaultContrast**. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_contraststep.md b/windows.devices.scanners/imagescannerflatbedconfiguration_contraststep.md index bb179947d9..84be6296d0 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_contraststep.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_contraststep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ContrastStep --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ContrastStep ## -description Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values. ## -property-value The step size to increment or decrement. The typical value is 1. ## -remarks If the scanner doesn't allow contrast changes, then the [MinContrast](imagescannerflatbedconfiguration_mincontrast.md), [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) and [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) are set to the same value-oftentimes 0, and the **ContrastStep** value is set to 0. Your app can determine if the scan source doesn't support contrast adjustments by reading the **ContrastStep** value. If the value is greater than 0, then the scan source supports contrast adjustments. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ContrastStep +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.ContrastStep + +## -description +Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values. + +## -property-value +The step size to increment or decrement. The typical value is 1. + +## -remarks +If the scanner doesn't allow contrast changes, then the [MinContrast](imagescannerflatbedconfiguration_mincontrast.md), [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) and [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) are set to the same value-oftentimes 0, and the **ContrastStep** value is set to 0. Your app can determine if the scan source doesn't support contrast adjustments by reading the **ContrastStep** value. If the value is greater than 0, then the scan source supports contrast adjustments. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultbrightness.md b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultbrightness.md index f73fdb481c..8ef8713a4f 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultbrightness.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultBrightness ## -description Gets the default brightness level for the scanner's Flatbed. ## -property-value The default brightness level for the scanner. ## -remarks A scan source that doesn't allow brightness adjustments can have [MinBrightness](imagescannerflatbedconfiguration_minbrightness.md), [MaxBrightness](imagescannerflatbedconfiguration_maxbrightness.md) and **DefaultBrightness** set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultBrightness + +## -description +Gets the default brightness level for the scanner's Flatbed. + +## -property-value +The default brightness level for the scanner. + +## -remarks +A scan source that doesn't allow brightness adjustments can have [MinBrightness](imagescannerflatbedconfiguration_minbrightness.md), [MaxBrightness](imagescannerflatbedconfiguration_maxbrightness.md) and **DefaultBrightness** set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcolormode.md b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcolormode.md index 0c8d68427e..24782fccb4 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcolormode.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcolormode.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultColorMode --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultColorMode ## -description Gets the default color mode for the scanner's Flatbed. ## -property-value The color mode. ## -remarks When a new scan session begins, this property chooses the default color mode based on the pixel data types and bit depths that each scanner device supports. This is the order of priority: + AutoColor + Color + Grayscale + BlackAndWhite If the scanner device doesn't support any of the standard color modes, the current scan source will be considered unavailable and the app won’t be able to scan from there. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultColorMode +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultColorMode + +## -description +Gets the default color mode for the scanner's Flatbed. + +## -property-value +The color mode. + +## -remarks +When a new scan session begins, this property chooses the default color mode based on the pixel data types and bit depths that each scanner device supports. This is the order of priority: + + ++ AutoColor ++ Color ++ Grayscale ++ BlackAndWhite +If the scanner device doesn't support any of the standard color modes, the current scan source will be considered unavailable and the app won’t be able to scan from there. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcontrast.md b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcontrast.md index b77a02f9cc..3b509b147c 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcontrast.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultcontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultContrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultContrast ## -description Gets the default contrast level for the scanner's Flatbed. ## -property-value The default contrast level. ## -remarks A scan source that doesn't allow contrast adjustments can have [MinContrast](imagescannerflatbedconfiguration_mincontrast.md), [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) and **DefaultContrast** set to the same value-oftentimes 0, and the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultContrast + +## -description +Gets the default contrast level for the scanner's Flatbed. + +## -property-value +The default contrast level. + +## -remarks +A scan source that doesn't allow contrast adjustments can have [MinContrast](imagescannerflatbedconfiguration_mincontrast.md), [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) and **DefaultContrast** set to the same value-oftentimes 0, and the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultformat.md b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultformat.md index 762c62f644..c570f92d8e 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_defaultformat.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_defaultformat.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultFormat --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultFormat ## -description Gets the default file format for the scanner's Flatbed at the beginning of a new scan session. ## -property-value The file type. ## -remarks All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + 1. Jpeg + 2. Png + 3. Bitmap ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultFormat +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DefaultFormat + +## -description +Gets the default file format for the scanner's Flatbed at the beginning of a new scan session. + +## -property-value +The file type. + +## -remarks +All WIA scanner devices support the Windows Device Independent Bitmap (DIB) format. + +By default, these values in this order will be selected based on the file formats the device supports, from the smallest file size (in bytes) to the largest size: + + ++ 1. Jpeg ++ 2. Png ++ 3. Bitmap + + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_desiredresolution.md b/windows.devices.scanners/imagescannerflatbedconfiguration_desiredresolution.md index 3d5e315103..1dd6f15189 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_desiredresolution.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_desiredresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DesiredResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DesiredResolution ## -description Gets or sets the horizontal and vertical scan resolution for the scanner's Flatbed that the app requests, in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks This property value can be [MinResolution](imagescannerflatbedconfiguration_minresolution.md), [MaxResolution](imagescannerflatbedconfiguration_maxresolution.md), or [OpticalResolution](imagescannerflatbedconfiguration_opticalresolution.md). But, if your app sets this value to other resolutions, this property will choose the closest resolution values. See [ActualResolution](imagescannerflatbedconfiguration_actualresolution.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DesiredResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.DesiredResolution + +## -description +Gets or sets the horizontal and vertical scan resolution for the scanner's Flatbed that the app requests, in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks +This property value can be [MinResolution](imagescannerflatbedconfiguration_minresolution.md), [MaxResolution](imagescannerflatbedconfiguration_maxresolution.md), or [OpticalResolution](imagescannerflatbedconfiguration_opticalresolution.md). But, if your app sets this value to other resolutions, this property will choose the closest resolution values. See [ActualResolution](imagescannerflatbedconfiguration_actualresolution.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_format.md b/windows.devices.scanners/imagescannerflatbedconfiguration_format.md index 40ed0c8b87..a701a0c21d 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_format.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_format.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Format --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Format ## -description Gets or sets the current file transfer format for image data acquisition from the scanner's Flatbed to the client app. ## -property-value The file type. ## -remarks When a new scan session starts, this property is set to the default file format. See the [DefaultFormat](imagescannerflatbedconfiguration_defaultformat.md) property on how this is done. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.Format + +## -description +Gets or sets the current file transfer format for image data acquisition from the scanner's Flatbed to the client app. + +## -property-value +The file type. + +## -remarks +When a new scan session starts, this property is set to the default file format. See the [DefaultFormat](imagescannerflatbedconfiguration_defaultformat.md) property on how this is done. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_isautocroppingmodesupported_2103996678.md b/windows.devices.scanners/imagescannerflatbedconfiguration_isautocroppingmodesupported_2103996678.md index 601d645bcb..b8e8f28c9f 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_isautocroppingmodesupported_2103996678.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_isautocroppingmodesupported_2103996678.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsAutoCroppingModeSupported(Windows.Devices.Scanners.ImageScannerAutoCroppingMode) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsAutoCroppingModeSupported ## -description Returns whether the scanner's Flatbed supports the specified [ImageScannerAutoCroppingMode](imagescannerautocroppingmode.md). ## -parameters ### -param value The auto crop mode of the image to scan. ## -returns Indicates whether the device supports *value* mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsAutoCroppingModeSupported(Windows.Devices.Scanners.ImageScannerAutoCroppingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsAutoCroppingModeSupported + +## -description +Returns whether the scanner's Flatbed supports the specified [ImageScannerAutoCroppingMode](imagescannerautocroppingmode.md). + +## -parameters +### -param value +The auto crop mode of the image to scan. + +## -returns +Indicates whether the device supports *value* mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_iscolormodesupported_1543452622.md b/windows.devices.scanners/imagescannerflatbedconfiguration_iscolormodesupported_1543452622.md index af4ecd86be..f22617dfbf 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_iscolormodesupported_1543452622.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_iscolormodesupported_1543452622.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsColorModeSupported(Windows.Devices.Scanners.ImageScannerColorMode) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsColorModeSupported ## -description Returns whether the scanner's Flatbed can scan and transfer images in the specified color mode. ## -parameters ### -param value The color mode. ## -returns Indicates whether the scanner can scan images in *value* mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsColorModeSupported(Windows.Devices.Scanners.ImageScannerColorMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsColorModeSupported + +## -description +Returns whether the scanner's Flatbed can scan and transfer images in the specified color mode. + +## -parameters +### -param value +The color mode. + +## -returns +Indicates whether the scanner can scan images in *value* mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_isformatsupported_1921560568.md b/windows.devices.scanners/imagescannerflatbedconfiguration_isformatsupported_1921560568.md index a725f2e522..5318ba4371 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_isformatsupported_1921560568.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_isformatsupported_1921560568.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) --api-type: winrt method ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsFormatSupported ## -description Determines whether the scanner's Flatbed supports the specified file format or not. ## -parameters ### -param value The file type. ## -returns Indicates whether the specified file type is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsFormatSupported(Windows.Devices.Scanners.ImageScannerFormat) +-api-type: winrt method +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.IsFormatSupported + +## -description +Determines whether the scanner's Flatbed supports the specified file format or not. + +## -parameters +### -param value +The file type. + +## -returns +Indicates whether the specified file type is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_maxbrightness.md b/windows.devices.scanners/imagescannerflatbedconfiguration_maxbrightness.md index d32fb03f68..9a33c0a3cd 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_maxbrightness.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_maxbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxBrightness ## -description Gets the maximum brightness level supported by the scanner's Flatbed. ## -property-value The maximum brightness level, typically 1000. ## -remarks This property's value must be greater than or equal to the value of the [MinBrightness](imagescannerflatbedconfiguration_minbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxBrightness + +## -description +Gets the maximum brightness level supported by the scanner's Flatbed. + +## -property-value +The maximum brightness level, typically 1000. + +## -remarks +This property's value must be greater than or equal to the value of the [MinBrightness](imagescannerflatbedconfiguration_minbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_maxcontrast.md b/windows.devices.scanners/imagescannerflatbedconfiguration_maxcontrast.md index 72eff20af5..b6741b6f1f 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_maxcontrast.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_maxcontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxContrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxContrast ## -description Gets the maximum contrast level supported by the scanner's Flatbed. ## -property-value The maximum contrast level, typically 1000. ## -remarks This property's value must be greater than or equal to the value of the [MinContrast](imagescannerflatbedconfiguration_mincontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxContrast + +## -description +Gets the maximum contrast level supported by the scanner's Flatbed. + +## -property-value +The maximum contrast level, typically 1000. + +## -remarks +This property's value must be greater than or equal to the value of the [MinContrast](imagescannerflatbedconfiguration_mincontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_maxresolution.md b/windows.devices.scanners/imagescannerflatbedconfiguration_maxresolution.md index eee5b5e6cc..7d2a7b14aa 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_maxresolution.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_maxresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxResolution ## -description Gets the maximum horizontal and vertical scan resolution of the scanner's Flatbed in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks Apps can scan at **MaxResolution** in a small area at the highest possible resolution. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxResolution + +## -description +Gets the maximum horizontal and vertical scan resolution of the scanner's Flatbed in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks +Apps can scan at **MaxResolution** in a small area at the highest possible resolution. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_maxscanarea.md b/windows.devices.scanners/imagescannerflatbedconfiguration_maxscanarea.md index a41c84c775..bebbad1ffe 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_maxscanarea.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_maxscanarea.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxScanArea --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxScanArea ## -description Gets the maximum scan area dimensions in inches. The maximum scan width is the widest a document can be in order for the scanner's Flatbed to scan it. ## -property-value The width and height of the area. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxScanArea +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MaxScanArea + +## -description +Gets the maximum scan area dimensions in inches. The maximum scan width is the widest a document can be in order for the scanner's Flatbed to scan it. + +## -property-value +The width and height of the area. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_minbrightness.md b/windows.devices.scanners/imagescannerflatbedconfiguration_minbrightness.md index c5fe85c3d6..80f3ccfb30 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_minbrightness.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_minbrightness.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinBrightness --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinBrightness ## -description Gets the minimum brightness level supported by the scanner's Flatbed. ## -property-value The minimum brightness level, typically -1000. ## -remarks This property's value must be smaller than or equal to the value of the [MaxBrightness](imagescannerflatbedconfiguration_maxbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinBrightness +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinBrightness + +## -description +Gets the minimum brightness level supported by the scanner's Flatbed. + +## -property-value +The minimum brightness level, typically -1000. + +## -remarks +This property's value must be smaller than or equal to the value of the [MaxBrightness](imagescannerflatbedconfiguration_maxbrightness.md) property. A scan source that doesn't allow brightness adjustments can have **MinBrightness**, **MaxBrightness** and [DefaultBrightness](imagescannerflatbedconfiguration_defaultbrightness.md) set to the same value-oftentimes 0, and the [BrightnessStep](imagescannerflatbedconfiguration_brightnessstep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_mincontrast.md b/windows.devices.scanners/imagescannerflatbedconfiguration_mincontrast.md index 6b1aa0aca5..9d264ee953 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_mincontrast.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_mincontrast.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinContrast --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinContrast ## -description Gets the minimum contrast level supported by the scanner's Flatbed. ## -property-value The minimum contrast level, typically -1000. ## -remarks This property's value must be smaller than or equal to the value of the [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value set to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinContrast +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinContrast + +## -description +Gets the minimum contrast level supported by the scanner's Flatbed. + +## -property-value +The minimum contrast level, typically -1000. + +## -remarks +This property's value must be smaller than or equal to the value of the [MaxContrast](imagescannerflatbedconfiguration_maxcontrast.md) property. A scan source that doesn't allow contrast adjustments can have **MinContrast**, **MaxContrast** and [DefaultContrast](imagescannerflatbedconfiguration_defaultcontrast.md) set to the same value-oftentimes 0, and the [ContrastStep](imagescannerflatbedconfiguration_contraststep.md) value set to 0. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_minresolution.md b/windows.devices.scanners/imagescannerflatbedconfiguration_minresolution.md index 232b70202c..e6b9a408d7 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_minresolution.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_minresolution.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinResolution ## -description Gets the minimum horizontal and vertical scan resolution of the scanner's Flatbed in DPI. ## -property-value The horizontal and vertical resolution, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinResolution + +## -description +Gets the minimum horizontal and vertical scan resolution of the scanner's Flatbed in DPI. + +## -property-value +The horizontal and vertical resolution, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_minscanarea.md b/windows.devices.scanners/imagescannerflatbedconfiguration_minscanarea.md index f6b384badd..cbd030489c 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_minscanarea.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_minscanarea.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinScanArea --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinScanArea ## -description Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Flatbed to scan it. ## -property-value The width and height of the area. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinScanArea +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.MinScanArea + +## -description +Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Flatbed to scan it. + +## -property-value +The width and height of the area. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_opticalresolution.md b/windows.devices.scanners/imagescannerflatbedconfiguration_opticalresolution.md index 189eff07b1..5eaba9c17f 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_opticalresolution.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_opticalresolution.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.OpticalResolution --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.OpticalResolution ## -description Gets the optical scan resolution of the Flatbed scanner in DPI. ## -property-value The horizontal and vertical scan resolution in pixels. ## -remarks Apps can scan at **OpticalResolution** for the best quality per pixel that the hardware device is capable of. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.OpticalResolution +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.OpticalResolution + +## -description +Gets the optical scan resolution of the Flatbed scanner in DPI. + +## -property-value +The horizontal and vertical scan resolution in pixels. + +## -remarks +Apps can scan at **OpticalResolution** for the best quality per pixel that the hardware device is capable of. + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerflatbedconfiguration_selectedscanregion.md b/windows.devices.scanners/imagescannerflatbedconfiguration_selectedscanregion.md index f364c29441..33859373bf 100644 --- a/windows.devices.scanners/imagescannerflatbedconfiguration_selectedscanregion.md +++ b/windows.devices.scanners/imagescannerflatbedconfiguration_selectedscanregion.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.SelectedScanRegion --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.SelectedScanRegion ## -description Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the [AutoCroppingMode](imagescannerflatbedconfiguration_autocroppingmode.md) property is not **Disabled**. ## -property-value The location and size of a rectangle. ## -remarks This table describes the property's restrictions. Default values are set at the beginning of a new scan session.
NameDefault valueValid Flatbed valuesValid Feeder values
SelectedScanRegion.X0between 0 and MaximumScanArea.Width - 1between 0 and PageSizeDimenstions.Width
SelectedScanRegion.Y0between 0 and MaximumScanArea.Height - 1between 0 and PageSizeDimenstions.Height
SelectedScanRegion.WidthMaximumScanArea.Widthbetween MinimumScanArea.Width and (MaximumScanArea.Width – SelectedScanRegion.X)between MinimumScanArea.Width and PageSizeDimensions.Width
SelectedScanRegion.HeightMaximumScanArea.Heightbetween MinimumScanAreaHeight and (MaximumScanAreaHeight – SelectedScanRegion.Y)between MinimumScanArea.Height and PageSizeDimensions.Height
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.SelectedScanRegion +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerFlatbedConfiguration.SelectedScanRegion + +## -description +Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the [AutoCroppingMode](imagescannerflatbedconfiguration_autocroppingmode.md) property is not **Disabled**. + +## -property-value +The location and size of a rectangle. + +## -remarks +This table describes the property's restrictions. Default values are set at the beginning of a new scan session. + + + + + + + +
NameDefault valueValid Flatbed valuesValid Feeder values
SelectedScanRegion.X0between 0 and MaximumScanArea.Width - 1between 0 and PageSizeDimenstions.Width
SelectedScanRegion.Y0between 0 and MaximumScanArea.Height - 1between 0 and PageSizeDimenstions.Height
SelectedScanRegion.WidthMaximumScanArea.Widthbetween MinimumScanArea.Width and (MaximumScanArea.Width – SelectedScanRegion.X)between MinimumScanArea.Width and PageSizeDimensions.Width
SelectedScanRegion.HeightMaximumScanArea.Heightbetween MinimumScanAreaHeight and (MaximumScanAreaHeight – SelectedScanRegion.Y)between MinimumScanArea.Height and PageSizeDimensions.Height
+ +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerpreviewresult.md b/windows.devices.scanners/imagescannerpreviewresult.md index 2a25507dff..4987ecdf96 100644 --- a/windows.devices.scanners/imagescannerpreviewresult.md +++ b/windows.devices.scanners/imagescannerpreviewresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Scanners.ImageScannerPreviewResult --api-type: winrt class ---- # Windows.Devices.Scanners.ImageScannerPreviewResult ## -description Represents the result of a preview scan job. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Scanners.ImageScannerPreviewResult +-api-type: winrt class +--- + + + +# Windows.Devices.Scanners.ImageScannerPreviewResult + +## -description +Represents the result of a preview scan job. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerpreviewresult_format.md b/windows.devices.scanners/imagescannerpreviewresult_format.md index 85df089e99..7cd4851bde 100644 --- a/windows.devices.scanners/imagescannerpreviewresult_format.md +++ b/windows.devices.scanners/imagescannerpreviewresult_format.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerPreviewResult.Format --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerPreviewResult.Format ## -description Gets the format of the data for the scan preview. After preview this property is restored to the value before preview. ## -property-value The scan format. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerPreviewResult.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerPreviewResult.Format + +## -description +Gets the format of the data for the scan preview. After preview this property is restored to the value before preview. + +## -property-value +The scan format. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerpreviewresult_succeeded.md b/windows.devices.scanners/imagescannerpreviewresult_succeeded.md index dbd6036145..6988bfe613 100644 --- a/windows.devices.scanners/imagescannerpreviewresult_succeeded.md +++ b/windows.devices.scanners/imagescannerpreviewresult_succeeded.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerPreviewResult.Succeeded --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerPreviewResult.Succeeded ## -description Gets whether the scan preview was successful. ## -property-value True if scan preview was successful; otherwise False. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerPreviewResult.Succeeded +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerPreviewResult.Succeeded + +## -description +Gets whether the scan preview was successful. + +## -property-value +True if scan preview was successful; otherwise False. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerscanresult.md b/windows.devices.scanners/imagescannerscanresult.md index 4efd7fee21..82c11053c0 100644 --- a/windows.devices.scanners/imagescannerscanresult.md +++ b/windows.devices.scanners/imagescannerscanresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Scanners.ImageScannerScanResult --api-type: winrt class ---- # Windows.Devices.Scanners.ImageScannerScanResult ## -description Represents the result of a scan job. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Scanners.ImageScannerScanResult +-api-type: winrt class +--- + + + +# Windows.Devices.Scanners.ImageScannerScanResult + +## -description +Represents the result of a scan job. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.scanners/imagescannerscanresult_scannedfiles.md b/windows.devices.scanners/imagescannerscanresult_scannedfiles.md index debc6600ec..9f379b1f21 100644 --- a/windows.devices.scanners/imagescannerscanresult_scannedfiles.md +++ b/windows.devices.scanners/imagescannerscanresult_scannedfiles.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Scanners.ImageScannerScanResult.ScannedFiles --api-type: winrt property ---- # Windows.Devices.Scanners.ImageScannerScanResult.ScannedFiles ## -description Gets the list of scanned image files that was produced by the completed scan job. ## -property-value A list of scanned image files from the completed scan job. If there is no scanned file, the [IVectorView<T>.Size](../windows.foundation.collections/ivectorview_1_size.md) property will be 0. ## -remarks When nothing is scanned, the **IVectorView<T>.Size** property will be set to 0. The app should check the size to make sure there are actual files before attempting to access the files. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Scanners.ImageScannerScanResult.ScannedFiles +-api-type: winrt property +--- + + + +# Windows.Devices.Scanners.ImageScannerScanResult.ScannedFiles + +## -description +Gets the list of scanned image files that was produced by the completed scan job. + +## -property-value +A list of scanned image files from the completed scan job. If there is no scanned file, the [IVectorView<T>.Size](../windows.foundation.collections/ivectorview_1_size.md) property will be 0. + +## -remarks +When nothing is scanned, the **IVectorView<T>.Size** property will be set to 0. The app should check the size to make sure there are actual files before attempting to access the files. + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor.md b/windows.devices.sensors.custom/customsensor.md index 695f6266e4..a55ed43c7a 100644 --- a/windows.devices.sensors.custom/customsensor.md +++ b/windows.devices.sensors.custom/customsensor.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Sensors.Custom.CustomSensor --api-type: winrt class ---- # Windows.Devices.Sensors.Custom.CustomSensor ## -description Represents a custom sensor. This class reuses the same [ReadingChanged](customsensor_readingchanged.md) event mechanism and the same common properties ([DeviceId](customsensor_deviceid.md), [ReportInterval](customsensor_reportinterval.md)) as the [Windows.Devices.Sensors](windows_devices_sensors_custom.md) classes ([Accelerometer](../windows.devices.sensors/accelerometer.md), [Gyrometer](../windows.devices.sensors/gyrometer.md), [Magnetometer](../windows.devices.sensors/magnetometer.md), and so on). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Custom.CustomSensor +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor + +## -description +Represents a custom sensor. + +This class reuses the same [ReadingChanged](customsensor_readingchanged.md) event mechanism and the same common properties ([DeviceId](customsensor_deviceid.md), [ReportInterval](customsensor_reportinterval.md)) as the [Windows.Devices.Sensors](windows_devices_sensors_custom.md) classes ([Accelerometer](../windows.devices.sensors/accelerometer.md), [Gyrometer](../windows.devices.sensors/gyrometer.md), [Magnetometer](../windows.devices.sensors/magnetometer.md), and so on). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_deviceid.md b/windows.devices.sensors.custom/customsensor_deviceid.md index 7127aa3a78..a402b253f3 100644 --- a/windows.devices.sensors.custom/customsensor_deviceid.md +++ b/windows.devices.sensors.custom/customsensor_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Custom.CustomSensor.DeviceId ## -description Gets the device identifier of the sensor. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.DeviceId + +## -description +Gets the device identifier of the sensor. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_fromidasync_1322863552.md b/windows.devices.sensors.custom/customsensor_fromidasync_1322863552.md index a2dd0904d1..e625ee790f 100644 --- a/windows.devices.sensors.custom/customsensor_fromidasync_1322863552.md +++ b/windows.devices.sensors.custom/customsensor_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sensors.Custom.CustomSensor.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Sensors.Custom.CustomSensor.FromIdAsync ## -description Asynchronously obtains the sensor from its identifier. ## -parameters ### -param sensorId The sensor identifier. ## -returns Returns the [CustomSensor](customsensor.md) object from its identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Custom.CustomSensor.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param sensorId +The sensor identifier. + +## -returns +Returns the [CustomSensor](customsensor.md) object from its identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_getcurrentreading_1416488181.md b/windows.devices.sensors.custom/customsensor_getcurrentreading_1416488181.md index f4c90ca394..f10fcd2067 100644 --- a/windows.devices.sensors.custom/customsensor_getcurrentreading_1416488181.md +++ b/windows.devices.sensors.custom/customsensor_getcurrentreading_1416488181.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Devices.Sensors.Custom.CustomSensor.GetCurrentReading --api-type: winrt method ---- # Windows.Devices.Sensors.Custom.CustomSensor.GetCurrentReading ## -description Gets the current sensor reading. ## -returns The current sensor reading. ## -remarks An app may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](customsensor_readingchanged.md) event handler. This would be the preferred alternative for an app that updates its user interface at a specific frame rate. Whether polling once or many times, the app must establish a desired [ReportInterval](customsensor_reportinterval.md). This informs the sensor driver to allocate resources to satisfy subsequent polling requests. Before using the return value from this method, the app must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Custom.CustomSensor.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.GetCurrentReading + +## -description +Gets the current sensor reading. + +## -returns +The current sensor reading. + +## -remarks +An app may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](customsensor_readingchanged.md) event handler. This would be the preferred alternative for an app that updates its user interface at a specific frame rate. Whether polling once or many times, the app must establish a desired [ReportInterval](customsensor_reportinterval.md). This informs the sensor driver to allocate resources to satisfy subsequent polling requests. + +Before using the return value from this method, the app must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_getdeviceselector_1740344150.md b/windows.devices.sensors.custom/customsensor_getdeviceselector_1740344150.md index a24d9a9233..56a810acbb 100644 --- a/windows.devices.sensors.custom/customsensor_getdeviceselector_1740344150.md +++ b/windows.devices.sensors.custom/customsensor_getdeviceselector_1740344150.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sensors.Custom.CustomSensor.GetDeviceSelector(System.Guid) --api-type: winrt method ---- # Windows.Devices.Sensors.Custom.CustomSensor.GetDeviceSelector ## -description Gets the device selector from the given interface identifier. ## -parameters ### -param interfaceId The interface [Guid](https://msdn.microsoft.com/library/system.guid.aspx) that is associated with the custom sensor. This [Guid](https://msdn.microsoft.com/library/system.guid.aspx) is defined and registered by the sensor. ## -returns Returns the device selector, if it exists; otherwise, null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Custom.CustomSensor.GetDeviceSelector(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.GetDeviceSelector + +## -description +Gets the device selector from the given interface identifier. + +## -parameters +### -param interfaceId +The interface [Guid](https://msdn.microsoft.com/library/system.guid.aspx) that is associated with the custom sensor. This [Guid](https://msdn.microsoft.com/library/system.guid.aspx) is defined and registered by the sensor. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_minimumreportinterval.md b/windows.devices.sensors.custom/customsensor_minimumreportinterval.md index dee2c2ea86..c9e5fa42a1 100644 --- a/windows.devices.sensors.custom/customsensor_minimumreportinterval.md +++ b/windows.devices.sensors.custom/customsensor_minimumreportinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Custom.CustomSensor.MinimumReportInterval ## -description Gets the minimum report interval that is supported by the sensor. ## -property-value The minimum report interval that is supported by the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.MinimumReportInterval + +## -description +Gets the minimum report interval that is supported by the sensor. + +## -property-value +The minimum report interval that is supported by the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_readingchanged.md b/windows.devices.sensors.custom/customsensor_readingchanged.md index 14be65a42d..b71f9d4dec 100644 --- a/windows.devices.sensors.custom/customsensor_readingchanged.md +++ b/windows.devices.sensors.custom/customsensor_readingchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Sensors.Custom.CustomSensor.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.Custom.CustomSensor.ReadingChanged ## -description Occurs each time the sensor reports a new sensor reading. ## -remarks An app may register this event handler to obtain sensor readings. The app must establish a desired [ReportInterval](customsensor_reportinterval.md). This informs the sensor driver to allocate resources to satisfy the requirements of the app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.Custom.CustomSensor.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.ReadingChanged + +## -description +Occurs each time the sensor reports a new sensor reading. + +## -remarks +An app may register this event handler to obtain sensor readings. The app must establish a desired [ReportInterval](customsensor_reportinterval.md). This informs the sensor driver to allocate resources to satisfy the requirements of the app. + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensor_reportinterval.md b/windows.devices.sensors.custom/customsensor_reportinterval.md index 0653465676..ff5dd966cf 100644 --- a/windows.devices.sensors.custom/customsensor_reportinterval.md +++ b/windows.devices.sensors.custom/customsensor_reportinterval.md @@ -1,3 +1,44 @@ ---- -api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Custom.CustomSensor.ReportInterval ## -description Gets or sets the current report interval for the sensor. ## -property-value The current report interval for the sensor. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app doesn't want to use this default value, set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](customsensor_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the app’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](customsensor_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an app is finished with the sensor, we recommend that it explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. We recommend that the app consult the [MinimumReportInterval](customsensor_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the app can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The custom sensor platform automatically sets the change sensitivity for custom sensors based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified as G force)
1 ms – 16 ms0.01 G
17 ms – 32 ms0.02 G
>= 33 ms0.05 G
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.ReportInterval + +## -description +Gets or sets the current report interval for the sensor. + +## -property-value +The current report interval for the sensor. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app doesn't want to use this default value, set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](customsensor_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the app’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](customsensor_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an app is finished with the sensor, we recommend that it explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +We recommend that the app consult the [MinimumReportInterval](customsensor_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the app can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The custom sensor platform automatically sets the change sensitivity for custom sensors based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified as G force)
1 ms – 16 ms0.01 G
17 ms – 32 ms0.02 G
>= 33 ms0.05 G
+ +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensorreading.md b/windows.devices.sensors.custom/customsensorreading.md index 50285766f9..65f41fe756 100644 --- a/windows.devices.sensors.custom/customsensorreading.md +++ b/windows.devices.sensors.custom/customsensorreading.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Devices.Sensors.Custom.CustomSensorReading --api-type: winrt class ---- # Windows.Devices.Sensors.Custom.CustomSensorReading ## -description Represents a property set of key/value pairs that contain the custom data sent from the sensor’s driver to the app. Each key is a string that represents a [PROPERTYKEY](http://msdn.microsoft.com/library/3f5f31af-f040-443b-9045-9761055381ea). Each value can be an integer, Boolean, float, or double. ## -remarks This object is accessed when you call the [GetCurrentReading](customsensor_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](customsensorreadingchangedeventargs_reading.md) property of the [CustomSensorReadingChangedEventArgs](customsensorreadingchangedeventargs.md) object in the event callback method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Custom.CustomSensorReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensorReading + +## -description +Represents a property set of key/value pairs that contain the custom data sent from the sensor’s driver to the app. + +Each key is a string that represents a [PROPERTYKEY](http://msdn.microsoft.com/library/3f5f31af-f040-443b-9045-9761055381ea). Each value can be an integer, Boolean, float, or double. + +## -remarks +This object is accessed when you call the [GetCurrentReading](customsensor_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](customsensorreadingchangedeventargs_reading.md) property of the [CustomSensorReadingChangedEventArgs](customsensorreadingchangedeventargs.md) object in the event callback method. + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensorreading_properties.md b/windows.devices.sensors.custom/customsensorreading_properties.md index 09cef10dc8..cdc23d09ed 100644 --- a/windows.devices.sensors.custom/customsensorreading_properties.md +++ b/windows.devices.sensors.custom/customsensorreading_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReading.Properties --api-type: winrt property ---- # Windows.Devices.Sensors.Custom.CustomSensorReading.Properties ## -description Gets the property set for the sensor. ## -property-value The property set for the sensor. This set contains the key/value pair for each property in the set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensorReading.Properties + +## -description +Gets the property set for the sensor. + +## -property-value +The property set for the sensor. This set contains the key/value pair for each property in the set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensorreading_timestamp.md b/windows.devices.sensors.custom/customsensorreading_timestamp.md index 26ba75ed5f..62fd384efb 100644 --- a/windows.devices.sensors.custom/customsensorreading_timestamp.md +++ b/windows.devices.sensors.custom/customsensorreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.Custom.CustomSensorReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The instant in time when the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensorReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The instant in time when the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensorreadingchangedeventargs.md b/windows.devices.sensors.custom/customsensorreadingchangedeventargs.md index 2e553f7e42..a3baec40a6 100644 --- a/windows.devices.sensors.custom/customsensorreadingchangedeventargs.md +++ b/windows.devices.sensors.custom/customsensorreadingchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs ## -description Represents data for the reading– changed event of the custom sensor. ## -remarks This object is accessed when your app supports the [ReadingChanged](customsensor_readingchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs + +## -description +Represents data for the reading– changed event of the custom sensor. + +## -remarks +This object is accessed when your app supports the [ReadingChanged](customsensor_readingchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors.custom/customsensorreadingchangedeventargs_reading.md b/windows.devices.sensors.custom/customsensorreadingchangedeventargs_reading.md index dc904f0072..71b375287b 100644 --- a/windows.devices.sensors.custom/customsensorreadingchangedeventargs_reading.md +++ b/windows.devices.sensors.custom/customsensorreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs.Reading ## -description Gets the most recent sensor reading. ## -property-value The most recent sensor reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensorReadingChangedEventArgs.Reading + +## -description +Gets the most recent sensor reading. + +## -property-value +The most recent sensor reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometer_deviceid.md b/windows.devices.sensors/accelerometer_deviceid.md index 4612865c48..a29e3f0bf0 100644 --- a/windows.devices.sensors/accelerometer_deviceid.md +++ b/windows.devices.sensors/accelerometer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometer_getcurrentreading_1416488181.md b/windows.devices.sensors/accelerometer_getcurrentreading_1416488181.md index 3571eb5ed1..2460a56c42 100644 --- a/windows.devices.sensors/accelerometer_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/accelerometer_getcurrentreading_1416488181.md @@ -1,40 +1,40 @@ ---- --api-id: M:Windows.Devices.Sensors.Accelerometer.GetCurrentReading --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Accelerometer.GetCurrentReading - -## -description -Gets the current accelerometer reading. - -## -returns -This method has no parameters. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](accelerometer_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](accelerometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests - -If the sensor is configured to support batch delivery, this method flushes the current batch and starts a new latency period. For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). - -Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) - -The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the three axes of the default accelerometer. - - - -[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario3.xaml.cs#SnippetGetCurrentReadingCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the three axes of the default accelerometer. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario3.js#SnippetGetReadingJS)] - -## -examples - -## -see-also -[Sensor data and display orientation](http://msdn.microsoft.com/library/f90937f1-edaf-469c-b360-2ed67cb4fad0), [Accelerometer sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620477) +--- +-api-id: M:Windows.Devices.Sensors.Accelerometer.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Accelerometer.GetCurrentReading + +## -description +Gets the current accelerometer reading. + +## -returns +This method has no parameters. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](accelerometer_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](accelerometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests + +If the sensor is configured to support batch delivery, this method flushes the current batch and starts a new latency period. For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the three axes of the default accelerometer. + + + +[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario3.xaml.cs#SnippetGetCurrentReadingCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the three axes of the default accelerometer. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario3.js#SnippetGetReadingJS)] + +## -examples + +## -see-also +[Sensor data and display orientation](http://msdn.microsoft.com/library/f90937f1-edaf-469c-b360-2ed67cb4fad0), [Accelerometer sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620477) diff --git a/windows.devices.sensors/accelerometer_getdefault_702418228.md b/windows.devices.sensors/accelerometer_getdefault_702418228.md index d8be41b4d6..e10b17e4cc 100644 --- a/windows.devices.sensors/accelerometer_getdefault_702418228.md +++ b/windows.devices.sensors/accelerometer_getdefault_702418228.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sensors.Accelerometer.GetDefault(Windows.Devices.Sensors.AccelerometerReadingType) --api-type: winrt method ---- # Windows.Devices.Sensors.Accelerometer.GetDefault ## -description Returns the default accelerometer of a specific type of sensor. The possible accelerometer sensors are defined by [AccelerometerReadingType](accelerometerreadingtype.md). ## -parameters ### -param readingType Indicates the type of accelerometer to retrieve. ## -returns The default accelerometer or **null** if no integrated accelerometers are found. ## -remarks ## -examples ## -see-also [GetDefault](accelerometer_getdefault_846721868.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Accelerometer.GetDefault(Windows.Devices.Sensors.AccelerometerReadingType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Accelerometer.GetDefault + +## -description +Returns the default accelerometer of a specific type of sensor. The possible accelerometer sensors are defined by [AccelerometerReadingType](accelerometerreadingtype.md). + +## -parameters +### -param readingType +Indicates the type of accelerometer to retrieve. + +## -returns +The default accelerometer or **null** if no integrated accelerometers are found. + +## -remarks + +## -examples + +## -see-also +[GetDefault](accelerometer_getdefault_846721868.md) \ No newline at end of file diff --git a/windows.devices.sensors/accelerometer_getdefault_846721868.md b/windows.devices.sensors/accelerometer_getdefault_846721868.md index ca788fb633..e3dd990922 100644 --- a/windows.devices.sensors/accelerometer_getdefault_846721868.md +++ b/windows.devices.sensors/accelerometer_getdefault_846721868.md @@ -1,38 +1,38 @@ ---- --api-id: M:Windows.Devices.Sensors.Accelerometer.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Accelerometer.GetDefault - -## -description -Returns the default accelerometer. - -## -returns -The default accelerometer or null if no integrated accelerometers are found. - -## -remarks -This method only returns values for an accelerometer that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](accelerometer_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default accelerometer. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default accelerometer. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also -[GetDefault(AccelerometerReadingType)](accelerometer_getdefault_702418228.md) +--- +-api-id: M:Windows.Devices.Sensors.Accelerometer.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Accelerometer.GetDefault + +## -description +Returns the default accelerometer. + +## -returns +The default accelerometer or null if no integrated accelerometers are found. + +## -remarks +This method only returns values for an accelerometer that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](accelerometer_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default accelerometer. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default accelerometer. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also +[GetDefault(AccelerometerReadingType)](accelerometer_getdefault_702418228.md) diff --git a/windows.devices.sensors/accelerometer_maxbatchsize.md b/windows.devices.sensors/accelerometer_maxbatchsize.md index f25fe4dd2b..9ca0e2aa80 100644 --- a/windows.devices.sensors/accelerometer_maxbatchsize.md +++ b/windows.devices.sensors/accelerometer_maxbatchsize.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.MaxBatchSize --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.MaxBatchSize ## -description Gets the maximum number of events that can be batched by the sensor. ## -property-value The maximum number of batched events. ## -remarks A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](accelerometer_reportlatency.md). The maximum latency equals the [ReportInterval](accelerometer_reportinterval.md) times the [MaxBatchSize](accelerometer_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](accelerometer_reportlatency.md). The maximum latency equals the [ReportInterval](accelerometer_reportinterval.md) times the [MaxBatchSize](accelerometer_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometer_minimumreportinterval.md b/windows.devices.sensors/accelerometer_minimumreportinterval.md index c4f607b61e..285ee77174 100644 --- a/windows.devices.sensors/accelerometer_minimumreportinterval.md +++ b/windows.devices.sensors/accelerometer_minimumreportinterval.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.MinimumReportInterval ## -description Gets the minimum report interval supported by the accelerometer. ## -property-value The minimum [ReportInterval](accelerometer_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also [ReportInterval](accelerometer_reportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the accelerometer. + +## -property-value +The minimum [ReportInterval](accelerometer_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also +[ReportInterval](accelerometer_reportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/accelerometer_readingchanged.md b/windows.devices.sensors/accelerometer_readingchanged.md index afb286a388..442b211f43 100644 --- a/windows.devices.sensors/accelerometer_readingchanged.md +++ b/windows.devices.sensors/accelerometer_readingchanged.md @@ -1,45 +1,45 @@ ---- --api-id: E:Windows.Devices.Sensors.Accelerometer.ReadingChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.Accelerometer.ReadingChanged - -## -description -Occurs each time the accelerometer reports a new sensor reading. - -## -remarks -An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](accelerometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. - -The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example shows the [ReadingChanged](accelerometer_readingchanged.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario1.xaml.cs#SnippetReadingChangedCS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. - - - -[!code-js[EnableDataChangedJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario1.js#SnippetEnableDataChangedJS)] - -The following example shows the [ReadingChanged](accelerometer_readingchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also -[Accelerometer sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620477) +--- +-api-id: E:Windows.Devices.Sensors.Accelerometer.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Accelerometer.ReadingChanged + +## -description +Occurs each time the accelerometer reports a new sensor reading. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](accelerometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. + +The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example shows the [ReadingChanged](accelerometer_readingchanged.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario1.xaml.cs#SnippetReadingChangedCS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. + + + +[!code-js[EnableDataChangedJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario1.js#SnippetEnableDataChangedJS)] + +The following example shows the [ReadingChanged](accelerometer_readingchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also +[Accelerometer sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620477) diff --git a/windows.devices.sensors/accelerometer_readingtransform.md b/windows.devices.sensors/accelerometer_readingtransform.md index 783f3e4698..a3c9be7134 100644 --- a/windows.devices.sensors/accelerometer_readingtransform.md +++ b/windows.devices.sensors/accelerometer_readingtransform.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks This property provides these improvements: + Differences in the sensor data on landscape-first devices versus portrait-first devices are no longer important. + Easily port existing sensor-based apps that were written for landscape-first devices to portrait-first devices and vice-versa. + Allows handling of display orientation changes. You can align the sensor data with the current orientation by updating the sensor’s [ReadingTransform](accelerometer_readingtransform.md) to match the current display orientation. + Allows aligning sensor data with a display orientation that is different from the current display orientation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +This property provides these improvements: + ++ Differences in the sensor data on landscape-first devices versus portrait-first devices are no longer important. ++ Easily port existing sensor-based apps that were written for landscape-first devices to portrait-first devices and vice-versa. ++ Allows handling of display orientation changes. You can align the sensor data with the current orientation by updating the sensor’s [ReadingTransform](accelerometer_readingtransform.md) to match the current display orientation. ++ Allows aligning sensor data with a display orientation that is different from the current display orientation. + + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometer_readingtype.md b/windows.devices.sensors/accelerometer_readingtype.md index b9421759ea..3744a6191b 100644 --- a/windows.devices.sensors/accelerometer_readingtype.md +++ b/windows.devices.sensors/accelerometer_readingtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.ReadingType --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.ReadingType ## -description Gets the type of accelerometer sensor the is represented by this object. ## -property-value The type of accelerometer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.ReadingType +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.ReadingType + +## -description +Gets the type of accelerometer sensor the is represented by this object. + +## -property-value +The type of accelerometer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometer_reportinterval.md b/windows.devices.sensors/accelerometer_reportinterval.md index 05a585a924..fb8023a37b 100644 --- a/windows.devices.sensors/accelerometer_reportinterval.md +++ b/windows.devices.sensors/accelerometer_reportinterval.md @@ -1,3 +1,62 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.ReportInterval ## -description Gets or sets the current report interval for the accelerometer. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](accelerometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](accelerometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](accelerometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval,the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. ## -examples ## -see-also [MinimumReportInterval](accelerometer_minimumreportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.ReportInterval + +## -description +Gets or sets the current report interval for the accelerometer. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](accelerometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](accelerometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](accelerometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval,the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + + + + +## -examples + +## -see-also +[MinimumReportInterval](accelerometer_minimumreportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/accelerometer_reportlatency.md b/windows.devices.sensors/accelerometer_reportlatency.md index d1310e92e5..d8c013fb79 100644 --- a/windows.devices.sensors/accelerometer_reportlatency.md +++ b/windows.devices.sensors/accelerometer_reportlatency.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Devices.Sensors.Accelerometer.ReportLatency --api-type: winrt property ---- # Windows.Devices.Sensors.Accelerometer.ReportLatency ## -description Gets or sets the delay between batches of sensor information. ## -property-value The delay between batches of sensor information in milliseconds. ## -remarks This property is in reference to the frequency of [ReadingChanged](accelerometer_readingchanged.md) events. Not all sensors support [ReportLatency](accelerometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. If you set [ReportLatency](accelerometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](accelerometer_reportlatency.md) equals the [MaxBatchSize](accelerometer_maxbatchsize.md) times the [ReportInterval](accelerometer_reportinterval.md). Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](accelerometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](accelerometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Accelerometer.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Accelerometer.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](accelerometer_readingchanged.md) events. + +Not all sensors support [ReportLatency](accelerometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](accelerometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](accelerometer_reportlatency.md) equals the [MaxBatchSize](accelerometer_maxbatchsize.md) times the [ReportInterval](accelerometer_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](accelerometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](accelerometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometer_shaken.md b/windows.devices.sensors/accelerometer_shaken.md index 97dd07922b..3cc17b2ec8 100644 --- a/windows.devices.sensors/accelerometer_shaken.md +++ b/windows.devices.sensors/accelerometer_shaken.md @@ -1,49 +1,49 @@ ---- --api-id: E:Windows.Devices.Sensors.Accelerometer.Shaken --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.Accelerometer.Shaken - -## -description -Occurs when the accelerometer detects that the PC has been shaken. - -## -remarks -Use this event to receive notification that the device containing the accelerometer has been shaken. The app is not required to set a report interval prior to registering for [Shaken](accelerometer_shaken.md) events. - -The following example demonstrates how a Windows Store app built with C# and XAML registers its **Shaken** event handler. - - - -[!code-cs[EnableShakenCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario2.xaml.cs#SnippetEnableShakenCS)] - -The following example shows the [Shaken](accelerometer_shaken.md) event handler. - - - -[!code-cs[ShakenCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario2.xaml.cs#SnippetShakenCS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its **Shaken** event handler. - - - -[!code-js[EnableShakenJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario2.js#SnippetEnableShakenJS)] - -The following example shows the [Shaken](accelerometer_shaken.md) event handler. - - - -[!code-js[onShakenJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario2.js#SnippetonShakenJS)] - - - -> **Windows Phone 8** -> The accelerometer sensor does not raise the Shaken event on the Windows Phone 8 platform. If you add an event handler for the Shaken event in your Windows Phone 8 app, no error is raised, but the code in the event handler won’t run. - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.Accelerometer.Shaken +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Accelerometer.Shaken + +## -description +Occurs when the accelerometer detects that the PC has been shaken. + +## -remarks +Use this event to receive notification that the device containing the accelerometer has been shaken. The app is not required to set a report interval prior to registering for [Shaken](accelerometer_shaken.md) events. + +The following example demonstrates how a Windows Store app built with C# and XAML registers its **Shaken** event handler. + + + +[!code-cs[EnableShakenCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario2.xaml.cs#SnippetEnableShakenCS)] + +The following example shows the [Shaken](accelerometer_shaken.md) event handler. + + + +[!code-cs[ShakenCS](../windows.devices.sensors/code/Accelerometer/cs/Scenario2.xaml.cs#SnippetShakenCS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its **Shaken** event handler. + + + +[!code-js[EnableShakenJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario2.js#SnippetEnableShakenJS)] + +The following example shows the [Shaken](accelerometer_shaken.md) event handler. + + + +[!code-js[onShakenJS](../windows.devices.sensors/code/Accelerometer/javascript/scenario2.js#SnippetonShakenJS)] + + + +> **Windows Phone 8** +> The accelerometer sensor does not raise the Shaken event on the Windows Phone 8 platform. If you add an event handler for the Shaken event in your Windows Phone 8 app, no error is raised, but the code in the event handler won’t run. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometerreading_accelerationx.md b/windows.devices.sensors/accelerometerreading_accelerationx.md index d4008ee30a..043829a77f 100644 --- a/windows.devices.sensors/accelerometerreading_accelerationx.md +++ b/windows.devices.sensors/accelerometerreading_accelerationx.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AccelerometerReading.AccelerationX --api-type: winrt property ---- # Windows.Devices.Sensors.AccelerometerReading.AccelerationX ## -description Gets the g-force acceleration along the x-axis. ## -property-value The x-axis acceleration in g's. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReading.AccelerationX +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReading.AccelerationX + +## -description +Gets the g-force acceleration along the x-axis. + +## -property-value +The x-axis acceleration in g's. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometerreading_accelerationy.md b/windows.devices.sensors/accelerometerreading_accelerationy.md index 6d82c3180b..3d9ec77b52 100644 --- a/windows.devices.sensors/accelerometerreading_accelerationy.md +++ b/windows.devices.sensors/accelerometerreading_accelerationy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AccelerometerReading.AccelerationY --api-type: winrt property ---- # Windows.Devices.Sensors.AccelerometerReading.AccelerationY ## -description Gets the g-force acceleration along the y-axis. ## -property-value The y-axis acceleration in g's. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReading.AccelerationY +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReading.AccelerationY + +## -description +Gets the g-force acceleration along the y-axis. + +## -property-value +The y-axis acceleration in g's. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometerreading_accelerationz.md b/windows.devices.sensors/accelerometerreading_accelerationz.md index 048ccdf6d2..83e5d0dbd4 100644 --- a/windows.devices.sensors/accelerometerreading_accelerationz.md +++ b/windows.devices.sensors/accelerometerreading_accelerationz.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AccelerometerReading.AccelerationZ --api-type: winrt property ---- # Windows.Devices.Sensors.AccelerometerReading.AccelerationZ ## -description Gets the g-force acceleration along the z-axis. ## -property-value The g-force acceleration along the z-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReading.AccelerationZ +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReading.AccelerationZ + +## -description +Gets the g-force acceleration along the z-axis. + +## -property-value +The g-force acceleration along the z-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometerreading_timestamp.md b/windows.devices.sensors/accelerometerreading_timestamp.md index a37fcc6247..2405796a84 100644 --- a/windows.devices.sensors/accelerometerreading_timestamp.md +++ b/windows.devices.sensors/accelerometerreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AccelerometerReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.AccelerometerReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The instant in time when the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The instant in time when the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometerreadingchangedeventargs_reading.md b/windows.devices.sensors/accelerometerreadingchangedeventargs_reading.md index 98ba6ce72d..d33d8a6dd2 100644 --- a/windows.devices.sensors/accelerometerreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/accelerometerreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AccelerometerReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.AccelerometerReadingChangedEventArgs.Reading ## -description Gets the most recent accelerometer reading. ## -property-value The most recent accelerometer reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReadingChangedEventArgs.Reading + +## -description +Gets the most recent accelerometer reading. + +## -property-value +The most recent accelerometer reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/accelerometershakeneventargs_timestamp.md b/windows.devices.sensors/accelerometershakeneventargs_timestamp.md index 07ebf08202..780a7498a6 100644 --- a/windows.devices.sensors/accelerometershakeneventargs_timestamp.md +++ b/windows.devices.sensors/accelerometershakeneventargs_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AccelerometerShakenEventArgs.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.AccelerometerShakenEventArgs.Timestamp ## -description Gets the time at which the sensor reported the shaken event. ## -property-value The time at which the sensor reported the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerShakenEventArgs.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerShakenEventArgs.Timestamp + +## -description +Gets the time at which the sensor reported the shaken event. + +## -property-value +The time at which the sensor reported the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor.md b/windows.devices.sensors/activitysensor.md index 81e18be9bd..cbf178a825 100644 --- a/windows.devices.sensors/activitysensor.md +++ b/windows.devices.sensors/activitysensor.md @@ -1,3 +1,35 @@ ---- -api-id: T:Windows.Devices.Sensors.ActivitySensor --api-type: winrt class ---- # Windows.Devices.Sensors.ActivitySensor ## -description Represents an activity sensor that provides the activity and status of a sensor. ## -remarks > [!NOTE] > This class is not supported in JavaScript In order to use [ActivitySensor](activitysensor.md), you need to define the activity device capability in your app manifest file. ``` ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ActivitySensor +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ActivitySensor + +## -description +Represents an activity sensor that provides the activity and status of a sensor. + +## -remarks +> [!NOTE] +> This class is not supported in JavaScript + +In order to use [ActivitySensor](activitysensor.md), you need to define the activity device capability in your app manifest file. + + + + + +``` + + + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_deviceid.md b/windows.devices.sensors/activitysensor_deviceid.md index 861df6e5bc..1ad1431061 100644 --- a/windows.devices.sensors/activitysensor_deviceid.md +++ b/windows.devices.sensors/activitysensor_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensor.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensor.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensor.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensor.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_fromidasync_1322863552.md b/windows.devices.sensors/activitysensor_fromidasync_1322863552.md index 52b5dd817d..6adfc7e3a4 100644 --- a/windows.devices.sensors/activitysensor_fromidasync_1322863552.md +++ b/windows.devices.sensors/activitysensor_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensor.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensor.FromIdAsync ## -description Asynchronously obtains the sensor from its identifier. ## -parameters ### -param deviceId The sensor identifier. ## -returns Returns the [ActivitySensor](activitysensor.md) object from its identifier. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensor.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensor.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The sensor identifier. + +## -returns +Returns the [ActivitySensor](activitysensor.md) object from its identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensor_getcurrentreadingasync_1875759564.md b/windows.devices.sensors/activitysensor_getcurrentreadingasync_1875759564.md index 58d23432e0..9f48be7bb4 100644 --- a/windows.devices.sensors/activitysensor_getcurrentreadingasync_1875759564.md +++ b/windows.devices.sensors/activitysensor_getcurrentreadingasync_1875759564.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensor.GetCurrentReadingAsync --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensor.GetCurrentReadingAsync ## -description Asynchronously gets the current sensor reading. ## -returns Asynchronously returns a [ActivitySensorReading](activitysensorreading.md) object that represents info about the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensor.GetCurrentReadingAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensor.GetCurrentReadingAsync + +## -description +Asynchronously gets the current sensor reading. + +## -returns +Asynchronously returns a [ActivitySensorReading](activitysensorreading.md) object that represents info about the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_getdefaultasync_1549573963.md b/windows.devices.sensors/activitysensor_getdefaultasync_1549573963.md index 07967074d3..a70d1073e1 100644 --- a/windows.devices.sensors/activitysensor_getdefaultasync_1549573963.md +++ b/windows.devices.sensors/activitysensor_getdefaultasync_1549573963.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensor.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensor.GetDefaultAsync ## -description Asynchronously obtains the default sensor. ## -returns Asynchronously returns a [ActivitySensor](activitysensor.md) object that represents the default sensor. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensor.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensor.GetDefaultAsync + +## -description +Asynchronously obtains the default sensor. + +## -returns +Asynchronously returns a [ActivitySensor](activitysensor.md) object that represents the default sensor. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensor_getdeviceselector_838466080.md b/windows.devices.sensors/activitysensor_getdeviceselector_838466080.md index fa5b1eb0b4..7d2ec499ab 100644 --- a/windows.devices.sensors/activitysensor_getdeviceselector_838466080.md +++ b/windows.devices.sensors/activitysensor_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensor.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensor.GetDeviceSelector ## -description Gets the device selector. ## -returns Returns the device selector, if it exists; otherwise, null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensor.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensor.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_getsystemhistoryasync_1048912884.md b/windows.devices.sensors/activitysensor_getsystemhistoryasync_1048912884.md index bd9934101e..d6cca2cb57 100644 --- a/windows.devices.sensors/activitysensor_getsystemhistoryasync_1048912884.md +++ b/windows.devices.sensors/activitysensor_getsystemhistoryasync_1048912884.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync ## -description Asynchronously gets sensor readings from a specific time. ## -parameters ### -param fromTime The time at which to get sensor readings. ## -returns Asynchronously returns a list of [ActivitySensorReading](activitysensorreading.md) objects that represent info about the sensor. ## -remarks ## -examples ## -see-also [GetSystemHistoryAsync(DateTime, TimeSpan)](activitysensor_getsystemhistoryasync_1411492076.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync + +## -description +Asynchronously gets sensor readings from a specific time. + +## -parameters +### -param fromTime +The time at which to get sensor readings. + +## -returns +Asynchronously returns a list of [ActivitySensorReading](activitysensorreading.md) objects that represent info about the sensor. + +## -remarks + +## -examples + +## -see-also +[GetSystemHistoryAsync(DateTime, TimeSpan)](activitysensor_getsystemhistoryasync_1411492076.md) \ No newline at end of file diff --git a/windows.devices.sensors/activitysensor_getsystemhistoryasync_1411492076.md b/windows.devices.sensors/activitysensor_getsystemhistoryasync_1411492076.md index 34a9508f61..38eda1d761 100644 --- a/windows.devices.sensors/activitysensor_getsystemhistoryasync_1411492076.md +++ b/windows.devices.sensors/activitysensor_getsystemhistoryasync_1411492076.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync ## -description Asynchronously gets sensor readings from a specific time and duration. ## -parameters ### -param fromTime The time at which to get sensor readings. ### -param duration The time span during which to get sensor readings. ## -returns Asynchronously returns a list of [ActivitySensorReading](activitysensorreading.md) objects that represent info about the sensor. ## -remarks ## -examples ## -see-also [GetSystemHistoryAsync(DateTime)](activitysensor_getsystemhistoryasync_1048912884.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensor.GetSystemHistoryAsync + +## -description +Asynchronously gets sensor readings from a specific time and duration. + +## -parameters +### -param fromTime +The time at which to get sensor readings. + +### -param duration +The time span during which to get sensor readings. + +## -returns +Asynchronously returns a list of [ActivitySensorReading](activitysensorreading.md) objects that represent info about the sensor. + +## -remarks + +## -examples + +## -see-also +[GetSystemHistoryAsync(DateTime)](activitysensor_getsystemhistoryasync_1048912884.md) \ No newline at end of file diff --git a/windows.devices.sensors/activitysensor_minimumreportinterval.md b/windows.devices.sensors/activitysensor_minimumreportinterval.md index 9022f6eaa4..d7e85c0f14 100644 --- a/windows.devices.sensors/activitysensor_minimumreportinterval.md +++ b/windows.devices.sensors/activitysensor_minimumreportinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensor.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensor.MinimumReportInterval ## -description Gets the minimum report interval supported by the sensor. ## -property-value The minimum report interval supported by the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensor.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensor.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the sensor. + +## -property-value +The minimum report interval supported by the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_powerinmilliwatts.md b/windows.devices.sensors/activitysensor_powerinmilliwatts.md index 8ee8441a38..d516e886e6 100644 --- a/windows.devices.sensors/activitysensor_powerinmilliwatts.md +++ b/windows.devices.sensors/activitysensor_powerinmilliwatts.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensor.PowerInMilliwatts --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensor.PowerInMilliwatts ## -description Gets the power in milliwatts that the sensor consumes. ## -property-value The power in milliwatts that the sensor consumes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensor.PowerInMilliwatts +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensor.PowerInMilliwatts + +## -description +Gets the power in milliwatts that the sensor consumes. + +## -property-value +The power in milliwatts that the sensor consumes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_readingchanged.md b/windows.devices.sensors/activitysensor_readingchanged.md index d2b4614fc9..338c52deb1 100644 --- a/windows.devices.sensors/activitysensor_readingchanged.md +++ b/windows.devices.sensors/activitysensor_readingchanged.md @@ -1,3 +1,28 @@ ---- -api-id: E:Windows.Devices.Sensors.ActivitySensor.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.ActivitySensor.ReadingChanged ## -description Occurs each time the sensor reports a new sensor reading. ## -remarks When you add a callback function, you receive an initial callback. However, there is a case where you will not receive this initial callback. + Add a callback function. + Remove the callback function. + Add another callback function (or the original one a second time) In this sequence of events, the second callback function will not receive the initial callback. It will receive callback notifications normally when the [ActivitySensor](activitysensor.md) reports a new reading; only the initial callback will be missed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.ActivitySensor.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.ActivitySensor.ReadingChanged + +## -description +Occurs each time the sensor reports a new sensor reading. + +## -remarks +When you add a callback function, you receive an initial callback. However, there is a case where you will not receive this initial callback. + + ++ Add a callback function. ++ Remove the callback function. ++ Add another callback function (or the original one a second time) + + +In this sequence of events, the second callback function will not receive the initial callback. It will receive callback notifications normally when the [ActivitySensor](activitysensor.md) reports a new reading; only the initial callback will be missed. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_subscribedactivities.md b/windows.devices.sensors/activitysensor_subscribedactivities.md index f517464a11..910421df58 100644 --- a/windows.devices.sensors/activitysensor_subscribedactivities.md +++ b/windows.devices.sensors/activitysensor_subscribedactivities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensor.SubscribedActivities --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensor.SubscribedActivities ## -description Gets the list of activity types that the sensor pledges to perform. ## -property-value The list of [ActivityType](activitytype.md)-typed values for the activity types that the sensor pledges to perform. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensor.SubscribedActivities +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensor.SubscribedActivities + +## -description +Gets the list of activity types that the sensor pledges to perform. + +## -property-value +The list of [ActivityType](activitytype.md)-typed values for the activity types that the sensor pledges to perform. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensor_supportedactivities.md b/windows.devices.sensors/activitysensor_supportedactivities.md index c956ec2a7c..76ae8f09a6 100644 --- a/windows.devices.sensors/activitysensor_supportedactivities.md +++ b/windows.devices.sensors/activitysensor_supportedactivities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensor.SupportedActivities --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensor.SupportedActivities ## -description Gets the list of activity types that the sensor supports. ## -property-value The list of [ActivityType](activitytype.md)-typed values for the activity types that the sensor supports. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensor.SupportedActivities +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensor.SupportedActivities + +## -description +Gets the list of activity types that the sensor supports. + +## -property-value +The list of [ActivityType](activitytype.md)-typed values for the activity types that the sensor supports. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/activitysensorreading.md b/windows.devices.sensors/activitysensorreading.md index 1ea062b266..b68cff9cf5 100644 --- a/windows.devices.sensors/activitysensorreading.md +++ b/windows.devices.sensors/activitysensorreading.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Sensors.ActivitySensorReading --api-type: winrt class ---- # Windows.Devices.Sensors.ActivitySensorReading ## -description Represents the reading of an activity sensor that provides readings for the sensor. ## -remarks This object is accessed when you call the [ActivitySensor.GetCurrentReadingAsync](activitysensor_getcurrentreadingasync.md) method. ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ActivitySensorReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ActivitySensorReading + +## -description +Represents the reading of an activity sensor that provides readings for the sensor. + +## -remarks +This object is accessed when you call the [ActivitySensor.GetCurrentReadingAsync](activitysensor_getcurrentreadingasync.md) method. + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreading_activity.md b/windows.devices.sensors/activitysensorreading_activity.md index b3f940d4aa..ad5f1ca763 100644 --- a/windows.devices.sensors/activitysensorreading_activity.md +++ b/windows.devices.sensors/activitysensorreading_activity.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensorReading.Activity --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensorReading.Activity ## -description Gets the activity type for the sensor. ## -property-value A [ActivityType](activitytype.md)-typed value that specifies the current activity for the sensor. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensorReading.Activity +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensorReading.Activity + +## -description +Gets the activity type for the sensor. + +## -property-value +A [ActivityType](activitytype.md)-typed value that specifies the current activity for the sensor. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreading_confidence.md b/windows.devices.sensors/activitysensorreading_confidence.md index b6f85f2d9e..33338d6009 100644 --- a/windows.devices.sensors/activitysensorreading_confidence.md +++ b/windows.devices.sensors/activitysensorreading_confidence.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensorReading.Confidence --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensorReading.Confidence ## -description Gets the reading confidence for the sensor. ## -property-value A [ActivitySensorReadingConfidence](activitysensorreadingconfidence.md)-typed value that specifies the reading confidence for the sensor. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensorReading.Confidence +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensorReading.Confidence + +## -description +Gets the reading confidence for the sensor. + +## -property-value +A [ActivitySensorReadingConfidence](activitysensorreadingconfidence.md)-typed value that specifies the reading confidence for the sensor. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreading_timestamp.md b/windows.devices.sensors/activitysensorreading_timestamp.md index 1f1f688c20..5ea6e3d3f4 100644 --- a/windows.devices.sensors/activitysensorreading_timestamp.md +++ b/windows.devices.sensors/activitysensorreading_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensorReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensorReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The instant in time when the sensor reported the reading. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensorReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensorReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The instant in time when the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreadingchangedeventargs.md b/windows.devices.sensors/activitysensorreadingchangedeventargs.md index f8d94b3611..5a1aaaee07 100644 --- a/windows.devices.sensors/activitysensorreadingchangedeventargs.md +++ b/windows.devices.sensors/activitysensorreadingchangedeventargs.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs ## -description Represents data for the reading–changed event of the sensor. ## -remarks This object is accessed when your app supports the [ActivitySensor.ReadingChanged](activitysensor_readingchanged.md) event. ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs + +## -description +Represents data for the reading–changed event of the sensor. + +## -remarks +This object is accessed when your app supports the [ActivitySensor.ReadingChanged](activitysensor_readingchanged.md) event. + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreadingchangedeventargs_reading.md b/windows.devices.sensors/activitysensorreadingchangedeventargs_reading.md index c943185433..f2bd0db8f0 100644 --- a/windows.devices.sensors/activitysensorreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/activitysensorreadingchangedeventargs_reading.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs.Reading ## -description Gets the most recent sensor reading. ## -property-value The most recent sensor reading. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensorReadingChangedEventArgs.Reading + +## -description +Gets the most recent sensor reading. + +## -property-value +The most recent sensor reading. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreadingchangereport.md b/windows.devices.sensors/activitysensorreadingchangereport.md index 036d28c58a..1ad15ba877 100644 --- a/windows.devices.sensors/activitysensorreadingchangereport.md +++ b/windows.devices.sensors/activitysensorreadingchangereport.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Sensors.ActivitySensorReadingChangeReport --api-type: winrt class ---- # Windows.Devices.Sensors.ActivitySensorReadingChangeReport ## -description Represents data for the sensor trigger. ## -remarks This object is accessed when you call the [ActivitySensorTriggerDetails.ReadReports](activitysensortriggerdetails_readreports.md) method. ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ActivitySensorReadingChangeReport +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ActivitySensorReadingChangeReport + +## -description +Represents data for the sensor trigger. + +## -remarks +This object is accessed when you call the [ActivitySensorTriggerDetails.ReadReports](activitysensortriggerdetails_readreports.md) method. + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensorreadingchangereport_reading.md b/windows.devices.sensors/activitysensorreadingchangereport_reading.md index 2943b23393..9a91998f3d 100644 --- a/windows.devices.sensors/activitysensorreadingchangereport_reading.md +++ b/windows.devices.sensors/activitysensorreadingchangereport_reading.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.ActivitySensorReadingChangeReport.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.ActivitySensorReadingChangeReport.Reading ## -description Gets the reading of the sensor when it's triggered. ## -property-value The reading of the sensor when it's triggered. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ActivitySensorReadingChangeReport.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ActivitySensorReadingChangeReport.Reading + +## -description +Gets the reading of the sensor when it's triggered. + +## -property-value +The reading of the sensor when it's triggered. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensortriggerdetails.md b/windows.devices.sensors/activitysensortriggerdetails.md index d63b154205..77291995e2 100644 --- a/windows.devices.sensors/activitysensortriggerdetails.md +++ b/windows.devices.sensors/activitysensortriggerdetails.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.Sensors.ActivitySensorTriggerDetails --api-type: winrt class ---- # Windows.Devices.Sensors.ActivitySensorTriggerDetails ## -description Represents details about the sensor triggering. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ActivitySensorTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ActivitySensorTriggerDetails + +## -description +Represents details about the sensor triggering. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/activitysensortriggerdetails_readreports_231406138.md b/windows.devices.sensors/activitysensortriggerdetails_readreports_231406138.md index 3462fcff9a..14eb61593f 100644 --- a/windows.devices.sensors/activitysensortriggerdetails_readreports_231406138.md +++ b/windows.devices.sensors/activitysensortriggerdetails_readreports_231406138.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sensors.ActivitySensorTriggerDetails.ReadReports --api-type: winrt method ---- # Windows.Devices.Sensors.ActivitySensorTriggerDetails.ReadReports ## -description Reads reports about the sensor triggering. ## -returns Returns a list of [ActivitySensorReadingChangeReport](activitysensorreadingchangereport.md) objects that provides data for the sensor trigger. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ActivitySensorTriggerDetails.ReadReports +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ActivitySensorTriggerDetails.ReadReports + +## -description +Reads reports about the sensor triggering. + +## -returns +Returns a list of [ActivitySensorReadingChangeReport](activitysensorreadingchangereport.md) objects that provides data for the sensor trigger. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/altimeter.md b/windows.devices.sensors/altimeter.md index a6f8b555e1..7c60bf384c 100644 --- a/windows.devices.sensors/altimeter.md +++ b/windows.devices.sensors/altimeter.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Sensors.Altimeter --api-type: winrt class ---- # Windows.Devices.Sensors.Altimeter ## -description Provides an interface for an altimetric sensor to measure the relative altitude. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Altimeter +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Altimeter + +## -description +Provides an interface for an altimetric sensor to measure the relative altitude. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeter_deviceid.md b/windows.devices.sensors/altimeter_deviceid.md index ed0c9bfcea..6ba3eeb2ac 100644 --- a/windows.devices.sensors/altimeter_deviceid.md +++ b/windows.devices.sensors/altimeter_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Altimeter.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Altimeter.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Altimeter.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Altimeter.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeter_getcurrentreading_1416488181.md b/windows.devices.sensors/altimeter_getcurrentreading_1416488181.md index 3defe7920f..a1fa0ba0b5 100644 --- a/windows.devices.sensors/altimeter_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/altimeter_getcurrentreading_1416488181.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sensors.Altimeter.GetCurrentReading --api-type: winrt method ---- # Windows.Devices.Sensors.Altimeter.GetCurrentReading ## -description Gets the current reading for the altimeter. ## -returns The current alititude reading for this sensor. ## -remarks It is important to note that the altitude reading for this sensor is not the absolute altitude. Rather, this API is designed to determine the change in elevation between readings. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Altimeter.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Altimeter.GetCurrentReading + +## -description +Gets the current reading for the altimeter. + +## -returns +The current alititude reading for this sensor. + +## -remarks +It is important to note that the altitude reading for this sensor is not the absolute altitude. Rather, this API is designed to determine the change in elevation between readings. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeter_getdefault_846721868.md b/windows.devices.sensors/altimeter_getdefault_846721868.md index 978b538e31..c709d7975e 100644 --- a/windows.devices.sensors/altimeter_getdefault_846721868.md +++ b/windows.devices.sensors/altimeter_getdefault_846721868.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sensors.Altimeter.GetDefault --api-type: winrt method ---- # Windows.Devices.Sensors.Altimeter.GetDefault ## -description Returns the default altimeter sensor. ## -returns The default altimeter. ## -remarks If no barometer sensor is available, this method will return the null pointer. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Altimeter.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Altimeter.GetDefault + +## -description +Returns the default altimeter sensor. + +## -returns +The default altimeter. + +## -remarks +If no barometer sensor is available, this method will return the null pointer. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeter_minimumreportinterval.md b/windows.devices.sensors/altimeter_minimumreportinterval.md index 7952b6e621..64f22554d7 100644 --- a/windows.devices.sensors/altimeter_minimumreportinterval.md +++ b/windows.devices.sensors/altimeter_minimumreportinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Altimeter.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Altimeter.MinimumReportInterval ## -description The smallest report interval that is supported by this altimeter sensor. ## -property-value The smallest [ReportInterval](altimeter_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Altimeter.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Altimeter.MinimumReportInterval + +## -description +The smallest report interval that is supported by this altimeter sensor. + +## -property-value +The smallest [ReportInterval](altimeter_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeter_readingchanged.md b/windows.devices.sensors/altimeter_readingchanged.md index 498ff467a7..13bca36fef 100644 --- a/windows.devices.sensors/altimeter_readingchanged.md +++ b/windows.devices.sensors/altimeter_readingchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Sensors.Altimeter.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.Altimeter.ReadingChanged ## -description Occurs each time the altimeter sensor reports a new value. ## -remarks An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](altimeter_reportinterval.md). This sets the frequency of the **ReadingChanged** event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.Altimeter.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Altimeter.ReadingChanged + +## -description +Occurs each time the altimeter sensor reports a new value. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](altimeter_reportinterval.md). This sets the frequency of the **ReadingChanged** event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeter_reportinterval.md b/windows.devices.sensors/altimeter_reportinterval.md index c3dfbf90a1..1bacba5f42 100644 --- a/windows.devices.sensors/altimeter_reportinterval.md +++ b/windows.devices.sensors/altimeter_reportinterval.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Sensors.Altimeter.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Altimeter.ReportInterval ## -description Gets or sets the current report interval for the altimeter. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](altimeter_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](altimeter_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. Your application should consult the [MinimumReportInterval](altimeter_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Altimeter.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Altimeter.ReportInterval + +## -description +Gets or sets the current report interval for the altimeter. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](altimeter_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](altimeter_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +Your application should consult the [MinimumReportInterval](altimeter_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeterreading.md b/windows.devices.sensors/altimeterreading.md index 0b4bdb2f87..41ea5ecc66 100644 --- a/windows.devices.sensors/altimeterreading.md +++ b/windows.devices.sensors/altimeterreading.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.AltimeterReading --api-type: winrt class ---- # Windows.Devices.Sensors.AltimeterReading ## -description Represents an altimeter reading. ## -remarks This object is accessed when you invoke the [GetCurrentReading](altimeter_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](altimeterreadingchangedeventargs_reading.md) property of the [AltimeterReadingChangedEventArgs](altimeterreadingchangedeventargs.md) object in the event callback method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.AltimeterReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.AltimeterReading + +## -description +Represents an altimeter reading. + +## -remarks +This object is accessed when you invoke the [GetCurrentReading](altimeter_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](altimeterreadingchangedeventargs_reading.md) property of the [AltimeterReadingChangedEventArgs](altimeterreadingchangedeventargs.md) object in the event callback method. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeterreading_altitudechangeinmeters.md b/windows.devices.sensors/altimeterreading_altitudechangeinmeters.md index 47906dc3a8..05704bee9c 100644 --- a/windows.devices.sensors/altimeterreading_altitudechangeinmeters.md +++ b/windows.devices.sensors/altimeterreading_altitudechangeinmeters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AltimeterReading.AltitudeChangeInMeters --api-type: winrt property ---- # Windows.Devices.Sensors.AltimeterReading.AltitudeChangeInMeters ## -description Gets the current altitude determined by the altimeter sensor. ## -property-value The altitude in meters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AltimeterReading.AltitudeChangeInMeters +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AltimeterReading.AltitudeChangeInMeters + +## -description +Gets the current altitude determined by the altimeter sensor. + +## -property-value +The altitude in meters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeterreading_timestamp.md b/windows.devices.sensors/altimeterreading_timestamp.md index 04355201c8..fc7b99ca07 100644 --- a/windows.devices.sensors/altimeterreading_timestamp.md +++ b/windows.devices.sensors/altimeterreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AltimeterReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.AltimeterReading.Timestamp ## -description Gets the time for the most recent altimeter reading. ## -property-value The time when the altimeter sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AltimeterReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AltimeterReading.Timestamp + +## -description +Gets the time for the most recent altimeter reading. + +## -property-value +The time when the altimeter sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeterreadingchangedeventargs.md b/windows.devices.sensors/altimeterreadingchangedeventargs.md index bf7648455b..b6bc08ba10 100644 --- a/windows.devices.sensors/altimeterreadingchangedeventargs.md +++ b/windows.devices.sensors/altimeterreadingchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.AltimeterReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.AltimeterReadingChangedEventArgs ## -description Provides data for the altimeter reading– changed event. ## -remarks This object is accessed when your app supports the [ReadingChanged](altimeter_readingchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.AltimeterReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.AltimeterReadingChangedEventArgs + +## -description +Provides data for the altimeter reading– changed event. + +## -remarks +This object is accessed when your app supports the [ReadingChanged](altimeter_readingchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/altimeterreadingchangedeventargs_reading.md b/windows.devices.sensors/altimeterreadingchangedeventargs_reading.md index 7a14fbea55..0f2eef1002 100644 --- a/windows.devices.sensors/altimeterreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/altimeterreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.AltimeterReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.AltimeterReadingChangedEventArgs.Reading ## -description Gets the most recent barometer reading. ## -property-value The most recent altimeter reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.AltimeterReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AltimeterReadingChangedEventArgs.Reading + +## -description +Gets the most recent barometer reading. + +## -property-value +The most recent altimeter reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer.md b/windows.devices.sensors/barometer.md index 6a8c329cb3..5a5322d408 100644 --- a/windows.devices.sensors/barometer.md +++ b/windows.devices.sensors/barometer.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Sensors.Barometer --api-type: winrt class ---- # Windows.Devices.Sensors.Barometer ## -description Provides an interface for a barometric sensor to measure atmospheric pressure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Barometer +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Barometer + +## -description +Provides an interface for a barometric sensor to measure atmospheric pressure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_deviceid.md b/windows.devices.sensors/barometer_deviceid.md index b055c01616..d7d2b50e81 100644 --- a/windows.devices.sensors/barometer_deviceid.md +++ b/windows.devices.sensors/barometer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Barometer.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Barometer.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Barometer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Barometer.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_getcurrentreading_1416488181.md b/windows.devices.sensors/barometer_getcurrentreading_1416488181.md index a156b129dd..a0da64248e 100644 --- a/windows.devices.sensors/barometer_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/barometer_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.Barometer.GetCurrentReading --api-type: winrt method ---- # Windows.Devices.Sensors.Barometer.GetCurrentReading ## -description Gets the current reading for the barometer. ## -returns The current atmospheric pressure according to this sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Barometer.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Barometer.GetCurrentReading + +## -description +Gets the current reading for the barometer. + +## -returns +The current atmospheric pressure according to this sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_getdefault_846721868.md b/windows.devices.sensors/barometer_getdefault_846721868.md index 2bdaa22a95..b5e74e802b 100644 --- a/windows.devices.sensors/barometer_getdefault_846721868.md +++ b/windows.devices.sensors/barometer_getdefault_846721868.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sensors.Barometer.GetDefault --api-type: winrt method ---- # Windows.Devices.Sensors.Barometer.GetDefault ## -description Returns the default barometer sensor. ## -returns The default barometer. ## -remarks If no barometer sensor is available, this method will return the null pointer. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Barometer.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Barometer.GetDefault + +## -description +Returns the default barometer sensor. + +## -returns +The default barometer. + +## -remarks +If no barometer sensor is available, this method will return the null pointer. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_minimumreportinterval.md b/windows.devices.sensors/barometer_minimumreportinterval.md index 779c6ea388..11bae87f69 100644 --- a/windows.devices.sensors/barometer_minimumreportinterval.md +++ b/windows.devices.sensors/barometer_minimumreportinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Barometer.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Barometer.MinimumReportInterval ## -description The smallest report interval that is supported by this barometer sensor. ## -property-value The smallest [ReportInterval](barometer_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Barometer.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Barometer.MinimumReportInterval + +## -description +The smallest report interval that is supported by this barometer sensor. + +## -property-value +The smallest [ReportInterval](barometer_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_readingchanged.md b/windows.devices.sensors/barometer_readingchanged.md index a652ef1607..18824161e4 100644 --- a/windows.devices.sensors/barometer_readingchanged.md +++ b/windows.devices.sensors/barometer_readingchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Sensors.Barometer.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.Barometer.ReadingChanged ## -description Occurs each time the barometer sensor reports a new value. ## -remarks An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](barometer_reportinterval.md). This sets the frequency of the **ReadingChanged** event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.Barometer.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Barometer.ReadingChanged + +## -description +Occurs each time the barometer sensor reports a new value. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](barometer_reportinterval.md). This sets the frequency of the **ReadingChanged** event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_reportinterval.md b/windows.devices.sensors/barometer_reportinterval.md index 76523f362c..9610ffc972 100644 --- a/windows.devices.sensors/barometer_reportinterval.md +++ b/windows.devices.sensors/barometer_reportinterval.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Sensors.Barometer.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Barometer.ReportInterval ## -description Gets or sets the current report interval for the barometer. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](barometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](barometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. Your application should consult the [MinimumReportInterval](barometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Barometer.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Barometer.ReportInterval + +## -description +Gets or sets the current report interval for the barometer. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](barometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](barometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +Your application should consult the [MinimumReportInterval](barometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometerreading.md b/windows.devices.sensors/barometerreading.md index 9215dc083e..6c58632b66 100644 --- a/windows.devices.sensors/barometerreading.md +++ b/windows.devices.sensors/barometerreading.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.BarometerReading --api-type: winrt class ---- # Windows.Devices.Sensors.BarometerReading ## -description Represents a barometer reading. ## -remarks This object is accessed when you invoke the [GetCurrentReading](barometer_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](barometerreadingchangedeventargs_reading.md) property of the [BarometerReadingChangedEventArgs](barometerreadingchangedeventargs.md) object in the event callback method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.BarometerReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.BarometerReading + +## -description +Represents a barometer reading. + +## -remarks +This object is accessed when you invoke the [GetCurrentReading](barometer_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](barometerreadingchangedeventargs_reading.md) property of the [BarometerReadingChangedEventArgs](barometerreadingchangedeventargs.md) object in the event callback method. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometerreading_stationpressureinhectopascals.md b/windows.devices.sensors/barometerreading_stationpressureinhectopascals.md index 7a247d53ee..b316dc2b34 100644 --- a/windows.devices.sensors/barometerreading_stationpressureinhectopascals.md +++ b/windows.devices.sensors/barometerreading_stationpressureinhectopascals.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.BarometerReading.StationPressureInHectopascals --api-type: winrt property ---- # Windows.Devices.Sensors.BarometerReading.StationPressureInHectopascals ## -description Gets the barometric pressure determined by the barometer sensor. ## -property-value The pressure in hectopascals (hPA). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.BarometerReading.StationPressureInHectopascals +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.BarometerReading.StationPressureInHectopascals + +## -description +Gets the barometric pressure determined by the barometer sensor. + +## -property-value +The pressure in hectopascals (hPA). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometerreading_timestamp.md b/windows.devices.sensors/barometerreading_timestamp.md index 2190faa590..9cf8ff0896 100644 --- a/windows.devices.sensors/barometerreading_timestamp.md +++ b/windows.devices.sensors/barometerreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.BarometerReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.BarometerReading.Timestamp ## -description Gets the time for the most recent barometer reading. ## -property-value The time when the barometer sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.BarometerReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.BarometerReading.Timestamp + +## -description +Gets the time for the most recent barometer reading. + +## -property-value +The time when the barometer sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometerreadingchangedeventargs.md b/windows.devices.sensors/barometerreadingchangedeventargs.md index b90b89f017..d92f0e0e07 100644 --- a/windows.devices.sensors/barometerreadingchangedeventargs.md +++ b/windows.devices.sensors/barometerreadingchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.BarometerReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.BarometerReadingChangedEventArgs ## -description Provides data for the barometer reading– changed event. ## -remarks This object is accessed when your app supports the [ReadingChanged](barometer_readingchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.BarometerReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.BarometerReadingChangedEventArgs + +## -description +Provides data for the barometer reading– changed event. + +## -remarks +This object is accessed when your app supports the [ReadingChanged](barometer_readingchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometerreadingchangedeventargs_reading.md b/windows.devices.sensors/barometerreadingchangedeventargs_reading.md index 95975fd458..2a13f26646 100644 --- a/windows.devices.sensors/barometerreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/barometerreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.BarometerReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.BarometerReadingChangedEventArgs.Reading ## -description Gets the most recent barometer reading. ## -property-value The most recent barometer reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.BarometerReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.BarometerReadingChangedEventArgs.Reading + +## -description +Gets the most recent barometer reading. + +## -property-value +The most recent barometer reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_deviceid.md b/windows.devices.sensors/compass_deviceid.md index 9a613c6f7c..3f40786b23 100644 --- a/windows.devices.sensors/compass_deviceid.md +++ b/windows.devices.sensors/compass_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Compass.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Compass.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Compass.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Compass.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_getcurrentreading_1416488181.md b/windows.devices.sensors/compass_getcurrentreading_1416488181.md index 4b8affba19..d26865aa84 100644 --- a/windows.devices.sensors/compass_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/compass_getcurrentreading_1416488181.md @@ -1,41 +1,41 @@ ---- --api-id: M:Windows.Devices.Sensors.Compass.GetCurrentReading --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Compass.GetCurrentReading - -## -description -Gets the current compass reading. - -## -returns -The current compass reading. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](compass_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](compass_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests - -The returned value is a magnetic heading specified in degrees. - -The accuracy of this value is dependent on the capabilities of the compass. - -Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) - -The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current heading for the default compass. - - - -[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/compass/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current heading for the default compass. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/compass/javascript/scenario2.js#SnippetGetReadingJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.Compass.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Compass.GetCurrentReading + +## -description +Gets the current compass reading. + +## -returns +The current compass reading. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](compass_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](compass_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests + +The returned value is a magnetic heading specified in degrees. + +The accuracy of this value is dependent on the capabilities of the compass. + +Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current heading for the default compass. + + + +[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/compass/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current heading for the default compass. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/compass/javascript/scenario2.js#SnippetGetReadingJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_getdefault_846721868.md b/windows.devices.sensors/compass_getdefault_846721868.md index 0d560a0c55..1f588918f7 100644 --- a/windows.devices.sensors/compass_getdefault_846721868.md +++ b/windows.devices.sensors/compass_getdefault_846721868.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.Compass.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Compass.GetDefault - -## -description -Returns the default compass. - -## -returns -The default compass or null if no integrated compasses are found. - -## -remarks -This method only returns values for a compass that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](compass_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default compass. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/compass/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default compass. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/compass/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.Compass.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Compass.GetDefault + +## -description +Returns the default compass. + +## -returns +The default compass or null if no integrated compasses are found. + +## -remarks +This method only returns values for a compass that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](compass_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default compass. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/compass/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default compass. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/compass/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_minimumreportinterval.md b/windows.devices.sensors/compass_minimumreportinterval.md index 554fdcbe83..9dad6bb992 100644 --- a/windows.devices.sensors/compass_minimumreportinterval.md +++ b/windows.devices.sensors/compass_minimumreportinterval.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.Sensors.Compass.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Compass.MinimumReportInterval ## -description Gets the minimum report interval supported by the compass. ## -property-value The minimum [ReportInterval](compass_reportinterval.md) supported by the sensor. ## -remarks The interval is specified in milliseconds. ## -examples ## -see-also [ReportInterval](compass_reportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Compass.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Compass.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the compass. + +## -property-value +The minimum [ReportInterval](compass_reportinterval.md) supported by the sensor. + +## -remarks +The interval is specified in milliseconds. + +## -examples + +## -see-also +[ReportInterval](compass_reportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/compass_readingchanged.md b/windows.devices.sensors/compass_readingchanged.md index b91fe10bd9..6ab2d95cf5 100644 --- a/windows.devices.sensors/compass_readingchanged.md +++ b/windows.devices.sensors/compass_readingchanged.md @@ -1,46 +1,46 @@ ---- --api-id: E:Windows.Devices.Sensors.Compass.ReadingChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.Compass.ReadingChanged - -## -description -Occurs each time the compass reports a new sensor reading. - -## -remarks -An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](compass_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. - -Applications can set the frequency of this event by setting the **ReportInterval** property. - -The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/compass/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example shows the [ReadingChanged](compass_readingchanged.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/compass/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. - - - -[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/compass/javascript/scenario1.js#SnippetEnableReadingChangedJS)] - -The following example shows the [ReadingChanged](compass_readingchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/compass/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.Compass.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Compass.ReadingChanged + +## -description +Occurs each time the compass reports a new sensor reading. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](compass_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. + +Applications can set the frequency of this event by setting the **ReportInterval** property. + +The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/compass/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example shows the [ReadingChanged](compass_readingchanged.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/compass/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. + + + +[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/compass/javascript/scenario1.js#SnippetEnableReadingChangedJS)] + +The following example shows the [ReadingChanged](compass_readingchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/compass/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_readingtransform.md b/windows.devices.sensors/compass_readingtransform.md index 78c359d65f..400f8666e6 100644 --- a/windows.devices.sensors/compass_readingtransform.md +++ b/windows.devices.sensors/compass_readingtransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Compass.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.Compass.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Compass.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Compass.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_reportinterval.md b/windows.devices.sensors/compass_reportinterval.md index 473a0cc1cd..5b9f042dd0 100644 --- a/windows.devices.sensors/compass_reportinterval.md +++ b/windows.devices.sensors/compass_reportinterval.md @@ -1,3 +1,45 @@ ---- -api-id: P:Windows.Devices.Sensors.Compass.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Compass.ReportInterval ## -description Gets or sets the current report interval for the compass. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](compass_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](compass_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](compass_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The Sensor platform automatically sets the change sensitivity for compasses based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degrees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
## -examples ## -see-also [MinimumReportInterval](compass_minimumreportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Compass.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Compass.ReportInterval + +## -description +Gets or sets the current report interval for the compass. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](compass_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](compass_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](compass_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The Sensor platform automatically sets the change sensitivity for compasses based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degrees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
+ +## -examples + +## -see-also +[MinimumReportInterval](compass_minimumreportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/compassreading_headingaccuracy.md b/windows.devices.sensors/compassreading_headingaccuracy.md index edd5b5abed..8f8076f441 100644 --- a/windows.devices.sensors/compassreading_headingaccuracy.md +++ b/windows.devices.sensors/compassreading_headingaccuracy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.CompassReading.HeadingAccuracy --api-type: winrt property ---- # Windows.Devices.Sensors.CompassReading.HeadingAccuracy ## -description Gets the compass's heading accuracy. ## -property-value The compass's heading accuracy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.CompassReading.HeadingAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReading.HeadingAccuracy + +## -description +Gets the compass's heading accuracy. + +## -property-value +The compass's heading accuracy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compassreading_headingmagneticnorth.md b/windows.devices.sensors/compassreading_headingmagneticnorth.md index 47aa1a5372..ae92010c53 100644 --- a/windows.devices.sensors/compassreading_headingmagneticnorth.md +++ b/windows.devices.sensors/compassreading_headingmagneticnorth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.CompassReading.HeadingMagneticNorth --api-type: winrt property ---- # Windows.Devices.Sensors.CompassReading.HeadingMagneticNorth ## -description Gets the heading in degrees relative to magnetic-north. ## -property-value The magnetic-north heading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.CompassReading.HeadingMagneticNorth +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReading.HeadingMagneticNorth + +## -description +Gets the heading in degrees relative to magnetic-north. + +## -property-value +The magnetic-north heading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compassreading_headingtruenorth.md b/windows.devices.sensors/compassreading_headingtruenorth.md index 8c9664b265..be2401fc15 100644 --- a/windows.devices.sensors/compassreading_headingtruenorth.md +++ b/windows.devices.sensors/compassreading_headingtruenorth.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.Sensors.CompassReading.HeadingTrueNorth --api-type: winrt property ---- # Windows.Devices.Sensors.CompassReading.HeadingTrueNorth ## -description Gets the heading in degrees relative to geographic true-north. ## -property-value The true-north heading. ## -remarks Before retrieving this property, your code should first check to verify that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) In order to retrieve the declination, your app needs to have access to the device's current location. If the location is not available, the declination defaults to 0 degrees. In this scenario, [HeadingTrueNorth](compassreading_headingtruenorth.md) equals [HeadingMagneticNorth](compassreading_headingmagneticnorth.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.CompassReading.HeadingTrueNorth +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReading.HeadingTrueNorth + +## -description +Gets the heading in degrees relative to geographic true-north. + +## -property-value +The true-north heading. + +## -remarks +Before retrieving this property, your code should first check to verify that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +In order to retrieve the declination, your app needs to have access to the device's current location. If the location is not available, the declination defaults to 0 degrees. In this scenario, [HeadingTrueNorth](compassreading_headingtruenorth.md) equals [HeadingMagneticNorth](compassreading_headingmagneticnorth.md). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compassreading_timestamp.md b/windows.devices.sensors/compassreading_timestamp.md index 0da402d4a4..845cb63d44 100644 --- a/windows.devices.sensors/compassreading_timestamp.md +++ b/windows.devices.sensors/compassreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.CompassReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.CompassReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The time at which the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.CompassReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The time at which the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compassreadingchangedeventargs_reading.md b/windows.devices.sensors/compassreadingchangedeventargs_reading.md index b2cafb1e10..2813fd3ea4 100644 --- a/windows.devices.sensors/compassreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/compassreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.CompassReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.CompassReadingChangedEventArgs.Reading ## -description Gets the current compass reading. ## -property-value The current compass reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.CompassReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReadingChangedEventArgs.Reading + +## -description +Gets the current compass reading. + +## -property-value +The current compass reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometer_deviceid.md b/windows.devices.sensors/gyrometer_deviceid.md index 212e865ccf..d9ade3b1a8 100644 --- a/windows.devices.sensors/gyrometer_deviceid.md +++ b/windows.devices.sensors/gyrometer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Gyrometer.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Gyrometer.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Gyrometer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Gyrometer.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometer_getcurrentreading_1416488181.md b/windows.devices.sensors/gyrometer_getcurrentreading_1416488181.md index 354555e60f..fcd0e96d61 100644 --- a/windows.devices.sensors/gyrometer_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/gyrometer_getcurrentreading_1416488181.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.Gyrometer.GetCurrentReading --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Gyrometer.GetCurrentReading - -## -description -Gets the current gyrometer reading. - -## -returns -This method has no parameters. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](gyrometer_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](gyrometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests - -Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) - -The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default gyrometer. - - - -[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default gyrometer. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/gyrometer/javascript/scenario2.js#SnippetGetReadingJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.Gyrometer.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Gyrometer.GetCurrentReading + +## -description +Gets the current gyrometer reading. + +## -returns +This method has no parameters. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](gyrometer_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](gyrometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests + +Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default gyrometer. + + + +[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default gyrometer. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/gyrometer/javascript/scenario2.js#SnippetGetReadingJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometer_getdefault_846721868.md b/windows.devices.sensors/gyrometer_getdefault_846721868.md index 5c8432458a..81b6a2c6a2 100644 --- a/windows.devices.sensors/gyrometer_getdefault_846721868.md +++ b/windows.devices.sensors/gyrometer_getdefault_846721868.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.Gyrometer.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Gyrometer.GetDefault - -## -description -Returns the default gyrometer. - -## -returns -The default gyrometer or null if no integrated gyrometers are found. - -## -remarks -This method only returns values for a gyrometer that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](gyrometer_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default gyrometer. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default gyrometer. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/gyrometer/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.Gyrometer.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Gyrometer.GetDefault + +## -description +Returns the default gyrometer. + +## -returns +The default gyrometer or null if no integrated gyrometers are found. + +## -remarks +This method only returns values for a gyrometer that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](gyrometer_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default gyrometer. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default gyrometer. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/gyrometer/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometer_minimumreportinterval.md b/windows.devices.sensors/gyrometer_minimumreportinterval.md index 7cb3135699..716e7b75cc 100644 --- a/windows.devices.sensors/gyrometer_minimumreportinterval.md +++ b/windows.devices.sensors/gyrometer_minimumreportinterval.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.Gyrometer.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Gyrometer.MinimumReportInterval ## -description Gets the minimum report interval supported by the gyrometer. ## -property-value The minimum [ReportInterval](gyrometer_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also [ReportInterval](gyrometer_reportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Gyrometer.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Gyrometer.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the gyrometer. + +## -property-value +The minimum [ReportInterval](gyrometer_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also +[ReportInterval](gyrometer_reportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/gyrometer_readingchanged.md b/windows.devices.sensors/gyrometer_readingchanged.md index 1eff6a64fa..3c66e38c5e 100644 --- a/windows.devices.sensors/gyrometer_readingchanged.md +++ b/windows.devices.sensors/gyrometer_readingchanged.md @@ -1,46 +1,46 @@ ---- --api-id: E:Windows.Devices.Sensors.Gyrometer.ReadingChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.Gyrometer.ReadingChanged - -## -description -Occurs each time the gyrometer reports the current sensor reading. - -## -remarks -An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](gyrometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. - -Applications can set the frequency of this event by setting the **ReportInterval** property. - -The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example shows the [ReadingChanged](gyrometer_readingchanged.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. - - - -[!code-js[EnableDataChangedJS](../windows.devices.sensors/code/gyrometer/javascript/scenario1.js#SnippetEnableDataChangedJS)] - -The following example shows the [ReadingChanged](gyrometer_readingchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/gyrometer/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.Gyrometer.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Gyrometer.ReadingChanged + +## -description +Occurs each time the gyrometer reports the current sensor reading. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](gyrometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. + +Applications can set the frequency of this event by setting the **ReportInterval** property. + +The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example shows the [ReadingChanged](gyrometer_readingchanged.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/gyrometer/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. + + + +[!code-js[EnableDataChangedJS](../windows.devices.sensors/code/gyrometer/javascript/scenario1.js#SnippetEnableDataChangedJS)] + +The following example shows the [ReadingChanged](gyrometer_readingchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/gyrometer/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometer_readingtransform.md b/windows.devices.sensors/gyrometer_readingtransform.md index 5cddcb0e02..b755883e6d 100644 --- a/windows.devices.sensors/gyrometer_readingtransform.md +++ b/windows.devices.sensors/gyrometer_readingtransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Gyrometer.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.Gyrometer.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Gyrometer.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Gyrometer.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometer_reportinterval.md b/windows.devices.sensors/gyrometer_reportinterval.md index 6c23c539ea..1b0b343a4d 100644 --- a/windows.devices.sensors/gyrometer_reportinterval.md +++ b/windows.devices.sensors/gyrometer_reportinterval.md @@ -1,3 +1,45 @@ ---- -api-id: P:Windows.Devices.Sensors.Gyrometer.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Gyrometer.ReportInterval ## -description Gets or sets the current report interval for the gyrometer. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](gyrometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](gyrometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](gyrometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The Sensor platform automatically sets the change sensitivity for gyrometers based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified as degrees per second)
1 ms – 16 ms0.1 DPS
17 ms – 32 ms0.5 DPS
>= 33 ms1.0 DPS
## -examples ## -see-also [MinimumReportInterval](gyrometer_minimumreportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Gyrometer.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Gyrometer.ReportInterval + +## -description +Gets or sets the current report interval for the gyrometer. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](gyrometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](gyrometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](gyrometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The Sensor platform automatically sets the change sensitivity for gyrometers based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified as degrees per second)
1 ms – 16 ms0.1 DPS
17 ms – 32 ms0.5 DPS
>= 33 ms1.0 DPS
+ +## -examples + +## -see-also +[MinimumReportInterval](gyrometer_minimumreportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/gyrometerreading_angularvelocityx.md b/windows.devices.sensors/gyrometerreading_angularvelocityx.md index 9e709abdc0..cb25d1696e 100644 --- a/windows.devices.sensors/gyrometerreading_angularvelocityx.md +++ b/windows.devices.sensors/gyrometerreading_angularvelocityx.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.GyrometerReading.AngularVelocityX --api-type: winrt property ---- # Windows.Devices.Sensors.GyrometerReading.AngularVelocityX ## -description Gets the angular velocity, in degrees per second, about the x-axis. ## -property-value The angular velocity, in degrees per second, about the x-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReading.AngularVelocityX +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReading.AngularVelocityX + +## -description +Gets the angular velocity, in degrees per second, about the x-axis. + +## -property-value +The angular velocity, in degrees per second, about the x-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometerreading_angularvelocityy.md b/windows.devices.sensors/gyrometerreading_angularvelocityy.md index 590ea2a943..0371728bf9 100644 --- a/windows.devices.sensors/gyrometerreading_angularvelocityy.md +++ b/windows.devices.sensors/gyrometerreading_angularvelocityy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.GyrometerReading.AngularVelocityY --api-type: winrt property ---- # Windows.Devices.Sensors.GyrometerReading.AngularVelocityY ## -description Gets the angular velocity, in degrees per second, about the y-axis. ## -property-value The angular velocity, in degrees per second, about the y-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReading.AngularVelocityY +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReading.AngularVelocityY + +## -description +Gets the angular velocity, in degrees per second, about the y-axis. + +## -property-value +The angular velocity, in degrees per second, about the y-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometerreading_angularvelocityz.md b/windows.devices.sensors/gyrometerreading_angularvelocityz.md index e93fc23175..750b7587fa 100644 --- a/windows.devices.sensors/gyrometerreading_angularvelocityz.md +++ b/windows.devices.sensors/gyrometerreading_angularvelocityz.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.GyrometerReading.AngularVelocityZ --api-type: winrt property ---- # Windows.Devices.Sensors.GyrometerReading.AngularVelocityZ ## -description Gets the angular velocity, in degrees per second, about the z-axis. ## -property-value The angular velocity, in degrees per second, about the z-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReading.AngularVelocityZ +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReading.AngularVelocityZ + +## -description +Gets the angular velocity, in degrees per second, about the z-axis. + +## -property-value +The angular velocity, in degrees per second, about the z-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometerreading_timestamp.md b/windows.devices.sensors/gyrometerreading_timestamp.md index 740bea82a8..6d225912fd 100644 --- a/windows.devices.sensors/gyrometerreading_timestamp.md +++ b/windows.devices.sensors/gyrometerreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.GyrometerReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.GyrometerReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The time at which the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The time at which the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometerreadingchangedeventargs_reading.md b/windows.devices.sensors/gyrometerreadingchangedeventargs_reading.md index 1fd6a8836f..0702a2df70 100644 --- a/windows.devices.sensors/gyrometerreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/gyrometerreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.GyrometerReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.GyrometerReadingChangedEventArgs.Reading ## -description Gets the current gyrometer reading. ## -property-value The current gyrometer reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReadingChangedEventArgs.Reading + +## -description +Gets the current gyrometer reading. + +## -property-value +The current gyrometer reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_deviceid.md b/windows.devices.sensors/inclinometer_deviceid.md index eb138da194..1349798003 100644 --- a/windows.devices.sensors/inclinometer_deviceid.md +++ b/windows.devices.sensors/inclinometer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Inclinometer.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Inclinometer.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_getcurrentreading_1416488181.md b/windows.devices.sensors/inclinometer_getcurrentreading_1416488181.md index f5c5fefe08..b5031630c9 100644 --- a/windows.devices.sensors/inclinometer_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/inclinometer_getcurrentreading_1416488181.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.Inclinometer.GetCurrentReading --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Inclinometer.GetCurrentReading - -## -description -Gets the current inclinometer reading. - -## -returns -The current inclinometer reading. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](inclinometer_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](inclinometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests - -Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) - -The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default inclinometer. - - - -[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default inclinometer. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/inclinometer/javascript/scenario2.js#SnippetGetReadingJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.Inclinometer.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Inclinometer.GetCurrentReading + +## -description +Gets the current inclinometer reading. + +## -returns +The current inclinometer reading. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](inclinometer_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](inclinometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests + +Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default inclinometer. + + + +[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default inclinometer. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/inclinometer/javascript/scenario2.js#SnippetGetReadingJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_getdefault_2064571144.md b/windows.devices.sensors/inclinometer_getdefault_2064571144.md index 61b60306b7..2c7bd230ac 100644 --- a/windows.devices.sensors/inclinometer_getdefault_2064571144.md +++ b/windows.devices.sensors/inclinometer_getdefault_2064571144.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sensors.Inclinometer.GetDefault(Windows.Devices.Sensors.SensorReadingType) --api-type: winrt method ---- # Windows.Devices.Sensors.Inclinometer.GetDefault ## -description Returns the default inclinometer based on the [SensorReadingType](sensorreadingtype.md). ## -parameters ### -param sensorReadingtype The type of sensor to retrieve. ## -returns The default inclinometer or **null** if no inclinometers are found. ## -remarks This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The inclinometer readings are derived from multiple sensors.) A **null** value will be returned if the specified sensor is not available in the system. When a system is in Connected Standby, a call to the [GetDefault](inclinometer_getdefault.md) method will return immediately with a **null** result. ## -examples ## -see-also [GetDefault](inclinometer_getdefault_846721868.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Inclinometer.GetDefault(Windows.Devices.Sensors.SensorReadingType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Inclinometer.GetDefault + +## -description +Returns the default inclinometer based on the [SensorReadingType](sensorreadingtype.md). + +## -parameters +### -param sensorReadingtype +The type of sensor to retrieve. + +## -returns +The default inclinometer or **null** if no inclinometers are found. + +## -remarks +This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The inclinometer readings are derived from multiple sensors.) A **null** value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](inclinometer_getdefault.md) method will return immediately with a **null** result. + +## -examples + +## -see-also +[GetDefault](inclinometer_getdefault_846721868.md) \ No newline at end of file diff --git a/windows.devices.sensors/inclinometer_getdefault_846721868.md b/windows.devices.sensors/inclinometer_getdefault_846721868.md index 3794f86a98..b9a6bbc6bd 100644 --- a/windows.devices.sensors/inclinometer_getdefault_846721868.md +++ b/windows.devices.sensors/inclinometer_getdefault_846721868.md @@ -1,38 +1,38 @@ ---- --api-id: M:Windows.Devices.Sensors.Inclinometer.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.Inclinometer.GetDefault - -## -description -Returns the default inclinometer. - -## -returns -The default inclinometer or null if no inclinometers are found. - -## -remarks -This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The inclinometer readings are derived from multiple sensors.) A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](inclinometer_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default inclinometer. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default inclinometer. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/inclinometer/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also -[GetDefault(SensorReadingType)](inclinometer_getdefault_2064571144.md) +--- +-api-id: M:Windows.Devices.Sensors.Inclinometer.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Inclinometer.GetDefault + +## -description +Returns the default inclinometer. + +## -returns +The default inclinometer or null if no inclinometers are found. + +## -remarks +This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The inclinometer readings are derived from multiple sensors.) A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](inclinometer_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default inclinometer. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default inclinometer. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/inclinometer/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also +[GetDefault(SensorReadingType)](inclinometer_getdefault_2064571144.md) diff --git a/windows.devices.sensors/inclinometer_getdefaultforrelativereadings_1926893248.md b/windows.devices.sensors/inclinometer_getdefaultforrelativereadings_1926893248.md index 0584d2480c..bc28701ad9 100644 --- a/windows.devices.sensors/inclinometer_getdefaultforrelativereadings_1926893248.md +++ b/windows.devices.sensors/inclinometer_getdefaultforrelativereadings_1926893248.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.Inclinometer.GetDefaultForRelativeReadings --api-type: winrt method ---- # Windows.Devices.Sensors.Inclinometer.GetDefaultForRelativeReadings ## -description Returns the default inclinometer. ## -returns The default inclinometer or null if no inclinometers are found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Inclinometer.GetDefaultForRelativeReadings +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Inclinometer.GetDefaultForRelativeReadings + +## -description +Returns the default inclinometer. + +## -returns +The default inclinometer or null if no inclinometers are found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_minimumreportinterval.md b/windows.devices.sensors/inclinometer_minimumreportinterval.md index a8d6d68d0e..4a5d35d4f8 100644 --- a/windows.devices.sensors/inclinometer_minimumreportinterval.md +++ b/windows.devices.sensors/inclinometer_minimumreportinterval.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.Inclinometer.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Inclinometer.MinimumReportInterval ## -description Gets the minimum report interval supported by the inclinometer. ## -property-value The minimum [ReportInterval](inclinometer_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also [ReportInterval](inclinometer_reportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the inclinometer. + +## -property-value +The minimum [ReportInterval](inclinometer_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also +[ReportInterval](inclinometer_reportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/inclinometer_readingchanged.md b/windows.devices.sensors/inclinometer_readingchanged.md index 991f5bab96..48fdb51b4f 100644 --- a/windows.devices.sensors/inclinometer_readingchanged.md +++ b/windows.devices.sensors/inclinometer_readingchanged.md @@ -1,44 +1,44 @@ ---- --api-id: E:Windows.Devices.Sensors.Inclinometer.ReadingChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.Inclinometer.ReadingChanged - -## -description -Occurs each time the inclinometer reports a new sensor reading. - -## -remarks -Applications can set the frequency of this event by setting the **ReportInterval** property. - -The following example demonstrates how a Windows Store app built with C# and XAML registered its **ReadingChanged** event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example shows the [ReadingChanged](inclinometer_readingchanged.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its [ReadingChanged](inclinometer_readingchanged.md) event handler. - - - -[!code-js[EnableDataChangedJS](../windows.devices.sensors/code/inclinometer/javascript/scenario1.js#SnippetEnableDataChangedJS)] - -The following example shows the [ReadingChanged](inclinometer_readingchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/inclinometer/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.Inclinometer.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Inclinometer.ReadingChanged + +## -description +Occurs each time the inclinometer reports a new sensor reading. + +## -remarks +Applications can set the frequency of this event by setting the **ReportInterval** property. + +The following example demonstrates how a Windows Store app built with C# and XAML registered its **ReadingChanged** event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example shows the [ReadingChanged](inclinometer_readingchanged.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/inclinometer/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its [ReadingChanged](inclinometer_readingchanged.md) event handler. + + + +[!code-js[EnableDataChangedJS](../windows.devices.sensors/code/inclinometer/javascript/scenario1.js#SnippetEnableDataChangedJS)] + +The following example shows the [ReadingChanged](inclinometer_readingchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/inclinometer/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_readingtransform.md b/windows.devices.sensors/inclinometer_readingtransform.md index bfb00d1dd3..c39feb1acf 100644 --- a/windows.devices.sensors/inclinometer_readingtransform.md +++ b/windows.devices.sensors/inclinometer_readingtransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Inclinometer.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.Inclinometer.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_readingtype.md b/windows.devices.sensors/inclinometer_readingtype.md index bab110dfe0..8de03d9cee 100644 --- a/windows.devices.sensors/inclinometer_readingtype.md +++ b/windows.devices.sensors/inclinometer_readingtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Inclinometer.ReadingType --api-type: winrt property ---- # Windows.Devices.Sensors.Inclinometer.ReadingType ## -description Gets the sensor reading type. ## -property-value A [SensorReadingType](sensorreadingtype.md)-typed value that specifies the sensor reading type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.ReadingType +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.ReadingType + +## -description +Gets the sensor reading type. + +## -property-value +A [SensorReadingType](sensorreadingtype.md)-typed value that specifies the sensor reading type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometer_reportinterval.md b/windows.devices.sensors/inclinometer_reportinterval.md index af3e0be7b7..f4ad2e6400 100644 --- a/windows.devices.sensors/inclinometer_reportinterval.md +++ b/windows.devices.sensors/inclinometer_reportinterval.md @@ -1,3 +1,45 @@ ---- -api-id: P:Windows.Devices.Sensors.Inclinometer.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Inclinometer.ReportInterval ## -description Gets or sets the current report interval for the inclinometer. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](inclinometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](inclinometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](inclinometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The Sensor platform automatically sets the change sensitivity for inclinometers based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degreees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
## -examples ## -see-also [MinimumReportInterval](inclinometer_minimumreportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.ReportInterval + +## -description +Gets or sets the current report interval for the inclinometer. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](inclinometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](inclinometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](inclinometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The Sensor platform automatically sets the change sensitivity for inclinometers based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degreees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
+ +## -examples + +## -see-also +[MinimumReportInterval](inclinometer_minimumreportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/inclinometerreading_pitchdegrees.md b/windows.devices.sensors/inclinometerreading_pitchdegrees.md index c5ae7b7b2b..d66dfc4ada 100644 --- a/windows.devices.sensors/inclinometerreading_pitchdegrees.md +++ b/windows.devices.sensors/inclinometerreading_pitchdegrees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.InclinometerReading.PitchDegrees --api-type: winrt property ---- # Windows.Devices.Sensors.InclinometerReading.PitchDegrees ## -description Gets the rotation in degrees around the x-axis. ## -property-value The rotation in degrees around the x-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.PitchDegrees +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.PitchDegrees + +## -description +Gets the rotation in degrees around the x-axis. + +## -property-value +The rotation in degrees around the x-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometerreading_rolldegrees.md b/windows.devices.sensors/inclinometerreading_rolldegrees.md index c0fb9d8997..100b748959 100644 --- a/windows.devices.sensors/inclinometerreading_rolldegrees.md +++ b/windows.devices.sensors/inclinometerreading_rolldegrees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.InclinometerReading.RollDegrees --api-type: winrt property ---- # Windows.Devices.Sensors.InclinometerReading.RollDegrees ## -description Gets the rotation in degrees around the y-axis. ## -property-value The rotation in degrees around the y-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.RollDegrees +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.RollDegrees + +## -description +Gets the rotation in degrees around the y-axis. + +## -property-value +The rotation in degrees around the y-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometerreading_timestamp.md b/windows.devices.sensors/inclinometerreading_timestamp.md index 9d1a1bd94e..ef48da29d0 100644 --- a/windows.devices.sensors/inclinometerreading_timestamp.md +++ b/windows.devices.sensors/inclinometerreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.InclinometerReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.InclinometerReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The time at which the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The time at which the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometerreading_yawaccuracy.md b/windows.devices.sensors/inclinometerreading_yawaccuracy.md index afec08a651..3af1f870f6 100644 --- a/windows.devices.sensors/inclinometerreading_yawaccuracy.md +++ b/windows.devices.sensors/inclinometerreading_yawaccuracy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.InclinometerReading.YawAccuracy --api-type: winrt property ---- # Windows.Devices.Sensors.InclinometerReading.YawAccuracy ## -description Gets the inclinometer's z-axis accuracy. ## -property-value The inclinometer's z-axis accuracy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.YawAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.YawAccuracy + +## -description +Gets the inclinometer's z-axis accuracy. + +## -property-value +The inclinometer's z-axis accuracy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometerreading_yawdegrees.md b/windows.devices.sensors/inclinometerreading_yawdegrees.md index f29e7c7474..372b8d7d78 100644 --- a/windows.devices.sensors/inclinometerreading_yawdegrees.md +++ b/windows.devices.sensors/inclinometerreading_yawdegrees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.InclinometerReading.YawDegrees --api-type: winrt property ---- # Windows.Devices.Sensors.InclinometerReading.YawDegrees ## -description Gets the rotation in degrees around the z-axis. ## -property-value The rotation in degrees around the z-axis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.YawDegrees +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.YawDegrees + +## -description +Gets the rotation in degrees around the z-axis. + +## -property-value +The rotation in degrees around the z-axis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/inclinometerreadingchangedeventargs_reading.md b/windows.devices.sensors/inclinometerreadingchangedeventargs_reading.md index fbb37fe837..e3f2b8f371 100644 --- a/windows.devices.sensors/inclinometerreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/inclinometerreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.InclinometerReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.InclinometerReadingChangedEventArgs.Reading ## -description Gets the current inclinometer reading. ## -property-value The current inclinometer reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReadingChangedEventArgs.Reading + +## -description +Gets the current inclinometer reading. + +## -property-value +The current inclinometer reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensor_deviceid.md b/windows.devices.sensors/lightsensor_deviceid.md index 4a228aeb97..d1865a72ef 100644 --- a/windows.devices.sensors/lightsensor_deviceid.md +++ b/windows.devices.sensors/lightsensor_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.LightSensor.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.LightSensor.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.LightSensor.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensor.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensor_getcurrentreading_1416488181.md b/windows.devices.sensors/lightsensor_getcurrentreading_1416488181.md index 1f954567e0..6dc699f601 100644 --- a/windows.devices.sensors/lightsensor_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/lightsensor_getcurrentreading_1416488181.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.LightSensor.GetCurrentReading --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.LightSensor.GetCurrentReading - -## -description -Gets the current ambient-light sensor reading. - -## -returns -The current ambient-light sensor reading. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](lightsensor_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](lightsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests - -Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) - -The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default light sensor. - - - -[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default light sensor. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/lightsensor/javascript/scenario2.js#SnippetGetReadingJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.LightSensor.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.LightSensor.GetCurrentReading + +## -description +Gets the current ambient-light sensor reading. + +## -returns +The current ambient-light sensor reading. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](lightsensor_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](lightsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests + +Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default light sensor. + + + +[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default light sensor. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/lightsensor/javascript/scenario2.js#SnippetGetReadingJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensor_getdefault_846721868.md b/windows.devices.sensors/lightsensor_getdefault_846721868.md index 9d0094d8c8..00eb8206da 100644 --- a/windows.devices.sensors/lightsensor_getdefault_846721868.md +++ b/windows.devices.sensors/lightsensor_getdefault_846721868.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.LightSensor.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.LightSensor.GetDefault - -## -description -Returns the default ambient-light sensor. - -## -returns -The default ambient-light sensor or null if no integrated light sensors are found. - -## -remarks -This method only returns values for a light sensor that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](lightsensor_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default light sensor. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default light sensor. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/lightsensor/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.LightSensor.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.LightSensor.GetDefault + +## -description +Returns the default ambient-light sensor. + +## -returns +The default ambient-light sensor or null if no integrated light sensors are found. + +## -remarks +This method only returns values for a light sensor that has been integrated into the computer by the manufacturer. A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](lightsensor_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default light sensor. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default light sensor. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/lightsensor/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensor_minimumreportinterval.md b/windows.devices.sensors/lightsensor_minimumreportinterval.md index 00a8916205..de71c4f97b 100644 --- a/windows.devices.sensors/lightsensor_minimumreportinterval.md +++ b/windows.devices.sensors/lightsensor_minimumreportinterval.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.LightSensor.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.LightSensor.MinimumReportInterval ## -description Gets the minimum report interval supported by the sensor. ## -property-value The minimum [ReportInterval](lightsensor_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also [ReportInterval](lightsensor_reportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.LightSensor.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensor.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the sensor. + +## -property-value +The minimum [ReportInterval](lightsensor_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also +[ReportInterval](lightsensor_reportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/lightsensor_readingchanged.md b/windows.devices.sensors/lightsensor_readingchanged.md index 7a285301f5..f77435f6fd 100644 --- a/windows.devices.sensors/lightsensor_readingchanged.md +++ b/windows.devices.sensors/lightsensor_readingchanged.md @@ -1,46 +1,46 @@ ---- --api-id: E:Windows.Devices.Sensors.LightSensor.ReadingChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.LightSensor.ReadingChanged - -## -description -Occurs each time the ambient-light sensor reports a new sensor reading. - -## -remarks -An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](lightsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. - -Applications can set the frequency of this event by setting the **ReportInterval** property. - -The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example shows the [ReadingChanged](lightsensor_readingchanged.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] - -The following example demonstrates how a Windows Store app bulit with JavaScript registers its **ReadingChanged** event handler. - - - -[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/lightsensor/javascript/scenario1.js#SnippetEnableReadingChangedJS)] - -The following example shows the [ReadingChanged](lightsensor_readingchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/lightsensor/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.LightSensor.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.LightSensor.ReadingChanged + +## -description +Occurs each time the ambient-light sensor reports a new sensor reading. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](lightsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. + +Applications can set the frequency of this event by setting the **ReportInterval** property. + +The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example shows the [ReadingChanged](lightsensor_readingchanged.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/lightsensor/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] + +The following example demonstrates how a Windows Store app bulit with JavaScript registers its **ReadingChanged** event handler. + + + +[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/lightsensor/javascript/scenario1.js#SnippetEnableReadingChangedJS)] + +The following example shows the [ReadingChanged](lightsensor_readingchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/lightsensor/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensor_reportinterval.md b/windows.devices.sensors/lightsensor_reportinterval.md index d4a772e89e..d99cd0ad98 100644 --- a/windows.devices.sensors/lightsensor_reportinterval.md +++ b/windows.devices.sensors/lightsensor_reportinterval.md @@ -1,3 +1,45 @@ ---- -api-id: P:Windows.Devices.Sensors.LightSensor.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.LightSensor.ReportInterval ## -description Gets or sets the current report interval for the ambient light sensor. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](lightsensor_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](lightsensor_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](lightsensor_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The Sensor platform automatically sets the change sensitivity for ambient light sensors based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified as a percentage)
1 ms – 16 ms1%
17 ms – 32 ms1%
>= 33 ms5%
## -examples ## -see-also [MinimumReportInterval](lightsensor_minimumreportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.LightSensor.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensor.ReportInterval + +## -description +Gets or sets the current report interval for the ambient light sensor. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](lightsensor_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](lightsensor_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](lightsensor_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The Sensor platform automatically sets the change sensitivity for ambient light sensors based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified as a percentage)
1 ms – 16 ms1%
17 ms – 32 ms1%
>= 33 ms5%
+ +## -examples + +## -see-also +[MinimumReportInterval](lightsensor_minimumreportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/lightsensorreading_illuminanceinlux.md b/windows.devices.sensors/lightsensorreading_illuminanceinlux.md index 426ff45803..f9d3a9f4b5 100644 --- a/windows.devices.sensors/lightsensorreading_illuminanceinlux.md +++ b/windows.devices.sensors/lightsensorreading_illuminanceinlux.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.LightSensorReading.IlluminanceInLux --api-type: winrt property ---- # Windows.Devices.Sensors.LightSensorReading.IlluminanceInLux ## -description Gets the illuminance level in lux. ## -property-value The illuminance level in lux. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.LightSensorReading.IlluminanceInLux +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensorReading.IlluminanceInLux + +## -description +Gets the illuminance level in lux. + +## -property-value +The illuminance level in lux. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensorreading_timestamp.md b/windows.devices.sensors/lightsensorreading_timestamp.md index 4a0899195f..1413d00723 100644 --- a/windows.devices.sensors/lightsensorreading_timestamp.md +++ b/windows.devices.sensors/lightsensorreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.LightSensorReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.LightSensorReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The time at which the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.LightSensorReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensorReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The time at which the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensorreadingchangedeventargs_reading.md b/windows.devices.sensors/lightsensorreadingchangedeventargs_reading.md index 776ceaea55..f5519eb5ac 100644 --- a/windows.devices.sensors/lightsensorreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/lightsensorreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.LightSensorReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.LightSensorReadingChangedEventArgs.Reading ## -description Gets the current ambient light-sensor reading. ## -property-value The current ambient light-sensor reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.LightSensorReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensorReadingChangedEventArgs.Reading + +## -description +Gets the current ambient light-sensor reading. + +## -property-value +The current ambient light-sensor reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer.md b/windows.devices.sensors/magnetometer.md index 99e9d4eb77..2c54de7dd3 100644 --- a/windows.devices.sensors/magnetometer.md +++ b/windows.devices.sensors/magnetometer.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.Magnetometer --api-type: winrt class ---- # Windows.Devices.Sensors.Magnetometer ## -description Represents a magnetic sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Magnetometer +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Magnetometer + +## -description +Represents a magnetic sensor. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_deviceid.md b/windows.devices.sensors/magnetometer_deviceid.md index 3e3566e9dc..13bee983cb 100644 --- a/windows.devices.sensors/magnetometer_deviceid.md +++ b/windows.devices.sensors/magnetometer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Magnetometer.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Magnetometer.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Magnetometer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Magnetometer.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_getcurrentreading_1416488181.md b/windows.devices.sensors/magnetometer_getcurrentreading_1416488181.md index 126fd1a9ae..c903ec60da 100644 --- a/windows.devices.sensors/magnetometer_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/magnetometer_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.Magnetometer.GetCurrentReading --api-type: winrt method ---- # Windows.Devices.Sensors.Magnetometer.GetCurrentReading ## -description Gets the current magnetometer reading. ## -returns The current magnetometer reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Magnetometer.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Magnetometer.GetCurrentReading + +## -description +Gets the current magnetometer reading. + +## -returns +The current magnetometer reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_getdefault_846721868.md b/windows.devices.sensors/magnetometer_getdefault_846721868.md index ef998d279d..3c25adf43a 100644 --- a/windows.devices.sensors/magnetometer_getdefault_846721868.md +++ b/windows.devices.sensors/magnetometer_getdefault_846721868.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.Magnetometer.GetDefault --api-type: winrt method ---- # Windows.Devices.Sensors.Magnetometer.GetDefault ## -description Returns the default magnetometer. ## -returns The default magnetometer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Magnetometer.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Magnetometer.GetDefault + +## -description +Returns the default magnetometer. + +## -returns +The default magnetometer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_minimumreportinterval.md b/windows.devices.sensors/magnetometer_minimumreportinterval.md index f05d7b8371..9440cd92cf 100644 --- a/windows.devices.sensors/magnetometer_minimumreportinterval.md +++ b/windows.devices.sensors/magnetometer_minimumreportinterval.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.Magnetometer.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Magnetometer.MinimumReportInterval ## -description Gets the minimum report interval supported by the magnetometer. ## -property-value The minimum [ReportInterval](compass_reportinterval.md) supported by the sensor. ## -remarks The interval is specified in milliseconds. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Magnetometer.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Magnetometer.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the magnetometer. + +## -property-value +The minimum [ReportInterval](compass_reportinterval.md) supported by the sensor. + +## -remarks +The interval is specified in milliseconds. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_readingchanged.md b/windows.devices.sensors/magnetometer_readingchanged.md index 1cd3c8c7f2..5061fdfecb 100644 --- a/windows.devices.sensors/magnetometer_readingchanged.md +++ b/windows.devices.sensors/magnetometer_readingchanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Devices.Sensors.Magnetometer.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.Magnetometer.ReadingChanged ## -description Occurs each time the compass reports a new sensor reading. ## -remarks An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](magnetometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. Applications can set the frequency of this event by setting the **ReportInterval** property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.Magnetometer.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Magnetometer.ReadingChanged + +## -description +Occurs each time the compass reports a new sensor reading. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](magnetometer_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. + +Applications can set the frequency of this event by setting the **ReportInterval** property. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_readingtransform.md b/windows.devices.sensors/magnetometer_readingtransform.md index a932abb405..f57ceb3f81 100644 --- a/windows.devices.sensors/magnetometer_readingtransform.md +++ b/windows.devices.sensors/magnetometer_readingtransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Magnetometer.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.Magnetometer.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Magnetometer.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Magnetometer.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometer_reportinterval.md b/windows.devices.sensors/magnetometer_reportinterval.md index d8a01f8317..544ca1e2ae 100644 --- a/windows.devices.sensors/magnetometer_reportinterval.md +++ b/windows.devices.sensors/magnetometer_reportinterval.md @@ -1,3 +1,44 @@ ---- -api-id: P:Windows.Devices.Sensors.Magnetometer.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Magnetometer.ReportInterval ## -description Gets or sets the current report interval for the magnetometer. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](magnetometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](magnetometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](magnetometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The sensor platform automatically sets the change sensitivity for magnetometers based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degrees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Magnetometer.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Magnetometer.ReportInterval + +## -description +Gets or sets the current report interval for the magnetometer. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](magnetometer_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](magnetometer_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](magnetometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The sensor platform automatically sets the change sensitivity for magnetometers based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degrees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
+ +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading.md b/windows.devices.sensors/magnetometerreading.md index e1f6ac77a3..1a3c59218b 100644 --- a/windows.devices.sensors/magnetometerreading.md +++ b/windows.devices.sensors/magnetometerreading.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.MagnetometerReading --api-type: winrt class ---- # Windows.Devices.Sensors.MagnetometerReading ## -description Represents a magnetometer reading. ## -remarks This object is accessed when you invoke the [GetCurrentReading](magnetometer_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](magnetometerreadingchangedeventargs_reading.md) property of the [MagnetometerReadingChangedEventArgs](magnetometerreadingchangedeventargs.md) object in the event callback method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.MagnetometerReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.MagnetometerReading + +## -description +Represents a magnetometer reading. + +## -remarks +This object is accessed when you invoke the [GetCurrentReading](magnetometer_getcurrentreading.md) method; and, it is accessed when you retrieve the [Reading](magnetometerreadingchangedeventargs_reading.md) property of the [MagnetometerReadingChangedEventArgs](magnetometerreadingchangedeventargs.md) object in the event callback method. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading_directionalaccuracy.md b/windows.devices.sensors/magnetometerreading_directionalaccuracy.md index 6292e20481..4fd77d9a5e 100644 --- a/windows.devices.sensors/magnetometerreading_directionalaccuracy.md +++ b/windows.devices.sensors/magnetometerreading_directionalaccuracy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.MagnetometerReading.DirectionalAccuracy --api-type: winrt property ---- # Windows.Devices.Sensors.MagnetometerReading.DirectionalAccuracy ## -description Gets the magnetometer's directional accuracy. ## -property-value The magnetometer's directional accuracy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.DirectionalAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.DirectionalAccuracy + +## -description +Gets the magnetometer's directional accuracy. + +## -property-value +The magnetometer's directional accuracy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading_magneticfieldx.md b/windows.devices.sensors/magnetometerreading_magneticfieldx.md index e179ff9502..831bae9776 100644 --- a/windows.devices.sensors/magnetometerreading_magneticfieldx.md +++ b/windows.devices.sensors/magnetometerreading_magneticfieldx.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.MagnetometerReading.MagneticFieldX --api-type: winrt property ---- # Windows.Devices.Sensors.MagnetometerReading.MagneticFieldX ## -description Gets the magnetic field strength in microteslas along the X axis. ## -property-value The magnetic field strength in microteslas along the X axis. ## -remarks The accuracy of this value depends on the state of magnetometer calibration reflected in the [DirectionalAccuracy](magnetometerreading_directionalaccuracy.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.MagneticFieldX +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.MagneticFieldX + +## -description +Gets the magnetic field strength in microteslas along the X axis. + +## -property-value +The magnetic field strength in microteslas along the X axis. + +## -remarks +The accuracy of this value depends on the state of magnetometer calibration reflected in the [DirectionalAccuracy](magnetometerreading_directionalaccuracy.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading_magneticfieldy.md b/windows.devices.sensors/magnetometerreading_magneticfieldy.md index d2056b52de..6b13b370c8 100644 --- a/windows.devices.sensors/magnetometerreading_magneticfieldy.md +++ b/windows.devices.sensors/magnetometerreading_magneticfieldy.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.MagnetometerReading.MagneticFieldY --api-type: winrt property ---- # Windows.Devices.Sensors.MagnetometerReading.MagneticFieldY ## -description Gets the magnetic field strength in microteslas along the Y axis. ## -property-value The magnetic field strength in microteslas along the Y axis. ## -remarks The accuracy of this value depends on the state of magnetometer calibration reflected in the [DirectionalAccuracy](magnetometerreading_directionalaccuracy.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.MagneticFieldY +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.MagneticFieldY + +## -description +Gets the magnetic field strength in microteslas along the Y axis. + +## -property-value +The magnetic field strength in microteslas along the Y axis. + +## -remarks +The accuracy of this value depends on the state of magnetometer calibration reflected in the [DirectionalAccuracy](magnetometerreading_directionalaccuracy.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading_magneticfieldz.md b/windows.devices.sensors/magnetometerreading_magneticfieldz.md index 1eae79ca40..a485ef12a2 100644 --- a/windows.devices.sensors/magnetometerreading_magneticfieldz.md +++ b/windows.devices.sensors/magnetometerreading_magneticfieldz.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.MagnetometerReading.MagneticFieldZ --api-type: winrt property ---- # Windows.Devices.Sensors.MagnetometerReading.MagneticFieldZ ## -description Gets the magnetic field strength in microteslas along the Z axis. ## -property-value The magnetic field strength in microteslas along the Z axis. ## -remarks The accuracy of this value depends on the state of magnetometer calibration reflected in the [DirectionalAccuracy](magnetometerreading_directionalaccuracy.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.MagneticFieldZ +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.MagneticFieldZ + +## -description +Gets the magnetic field strength in microteslas along the Z axis. + +## -property-value +The magnetic field strength in microteslas along the Z axis. + +## -remarks +The accuracy of this value depends on the state of magnetometer calibration reflected in the [DirectionalAccuracy](magnetometerreading_directionalaccuracy.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading_timestamp.md b/windows.devices.sensors/magnetometerreading_timestamp.md index a6c2d28b49..f877414244 100644 --- a/windows.devices.sensors/magnetometerreading_timestamp.md +++ b/windows.devices.sensors/magnetometerreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.MagnetometerReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.MagnetometerReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The time at which the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The time at which the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreadingchangedeventargs.md b/windows.devices.sensors/magnetometerreadingchangedeventargs.md index 815a8a8666..da64304364 100644 --- a/windows.devices.sensors/magnetometerreadingchangedeventargs.md +++ b/windows.devices.sensors/magnetometerreadingchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs ## -description Provides data for the magnetometer reading– changed event. ## -remarks This object is accessed when your app supports the [ReadingChanged](magnetometer_readingchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs + +## -description +Provides data for the magnetometer reading– changed event. + +## -remarks +This object is accessed when your app supports the [ReadingChanged](magnetometer_readingchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreadingchangedeventargs_reading.md b/windows.devices.sensors/magnetometerreadingchangedeventargs_reading.md index 7fef115095..008b899ef5 100644 --- a/windows.devices.sensors/magnetometerreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/magnetometerreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs.Reading ## -description Gets the current magnetometer reading. ## -property-value The current magnetometer reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReadingChangedEventArgs.Reading + +## -description +Gets the current magnetometer reading. + +## -property-value +The current magnetometer reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_deviceid.md b/windows.devices.sensors/orientationsensor_deviceid.md index 7ef1a85d9c..7defb06725 100644 --- a/windows.devices.sensors/orientationsensor_deviceid.md +++ b/windows.devices.sensors/orientationsensor_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensor.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensor.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_getcurrentreading_1416488181.md b/windows.devices.sensors/orientationsensor_getcurrentreading_1416488181.md index 7f06bf6900..ce94de9f78 100644 --- a/windows.devices.sensors/orientationsensor_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/orientationsensor_getcurrentreading_1416488181.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.OrientationSensor.GetCurrentReading --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.OrientationSensor.GetCurrentReading - -## -description -Gets the current sensor reading. - -## -returns -The current sensor reading. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](orientationsensor_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](orientationsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests - -Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) - -The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the orientation sensor. - - - -[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/orientation/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the orientation sensor. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/orientation/javascript/scenario2.js#SnippetGetReadingJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetCurrentReading + +## -description +Gets the current sensor reading. + +## -returns +The current sensor reading. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [ReadingChanged](orientationsensor_readingchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired [ReportInterval](orientationsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests + +Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.) + +The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the orientation sensor. + + + +[!code-cs[GetCurrentReadingCS](../windows.devices.sensors/code/orientation/csharp/Scenario2.xaml.cs#SnippetGetCurrentReadingCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the orientation sensor. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/orientation/javascript/scenario2.js#SnippetGetReadingJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_getdefault_2064571144.md b/windows.devices.sensors/orientationsensor_getdefault_2064571144.md index 427c2b4da8..b3fc715551 100644 --- a/windows.devices.sensors/orientationsensor_getdefault_2064571144.md +++ b/windows.devices.sensors/orientationsensor_getdefault_2064571144.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefault(Windows.Devices.Sensors.SensorReadingType) --api-type: winrt method ---- # Windows.Devices.Sensors.OrientationSensor.GetDefault ## -description Gets the default orientation sensor, taking into account accuracy preferences. ## -parameters ### -param sensorReadingtype The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated.” ## -returns The default orientation sensor or **null** if no orientation sensors are found. ## -remarks This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The orientation-sensor readings are derived from multiple sensors.) A **null** value will be returned if the specified sensor is not available in the system. When a system is in Connected Standby, a call to the [GetDefault](orientationsensor_getdefault.md) method will return immediately with a **null** result. ## -examples ## -see-also [GetDefault(SensorReadingType, SensorOptimizationGoal)](orientationsensor_getdefault_274432112.md), [GetDefault](orientationsensor_getdefault_846721868.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefault(Windows.Devices.Sensors.SensorReadingType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetDefault + +## -description +Gets the default orientation sensor, taking into account accuracy preferences. + +## -parameters +### -param sensorReadingtype +The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated.” + +## -returns +The default orientation sensor or **null** if no orientation sensors are found. + +## -remarks +This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The orientation-sensor readings are derived from multiple sensors.) A **null** value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](orientationsensor_getdefault.md) method will return immediately with a **null** result. + +## -examples + +## -see-also +[GetDefault(SensorReadingType, SensorOptimizationGoal)](orientationsensor_getdefault_274432112.md), [GetDefault](orientationsensor_getdefault_846721868.md) \ No newline at end of file diff --git a/windows.devices.sensors/orientationsensor_getdefault_274432112.md b/windows.devices.sensors/orientationsensor_getdefault_274432112.md index 373fb1b6dd..83728af7d2 100644 --- a/windows.devices.sensors/orientationsensor_getdefault_274432112.md +++ b/windows.devices.sensors/orientationsensor_getdefault_274432112.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefault(Windows.Devices.Sensors.SensorReadingType,Windows.Devices.Sensors.SensorOptimizationGoal) --api-type: winrt method ---- # Windows.Devices.Sensors.OrientationSensor.GetDefault ## -description Gets the default orientation sensor, taking into account power and accuracy preferences. ## -parameters ### -param sensorReadingType The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated.” ### -param optimizationGoal Indicates the preferences of optimization for the sensor. This field is only used if an Absolute SensorReadingType is specified. An optimizationGoal of Precision will return an OrientationSensor using an accelereometer, a gyrometer, and a magnetometer to determine orientation with respect to magnetic North. This has the potential to use a lot of power due to it’s use of a gyrometer. In contrast, specifying an optimizationGoal of PowerEfficiency will return an OrientationSensor using an accelerometer and magnetometer only (no gyrometer) to save power at the a cost of some accuracy (readings will still be relatively accurate in most circumstances). ## -returns The default orientation sensor or **null** if no orientation sensors are found. ## -remarks This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The orientation-sensor readings are derived from multiple sensors.) A **null** value will be returned if the specified sensor is not available in the system. When a system is in Connected Standby, a call to the [GetDefault](orientationsensor_getdefault.md) method will return immediately with a **null** result. The *optimizationGoal* parameter is dependent on the hardware available. It will attempt to choose the best sensor available based on your provided preference for optimization. It only has an effect if the *sensorReadingType* is **Absolute**. ## -examples ## -see-also [GetDefault(SensorReadingType)](orientationsensor_getdefault_2064571144.md), [GetDefault](orientationsensor_getdefault_846721868.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefault(Windows.Devices.Sensors.SensorReadingType,Windows.Devices.Sensors.SensorOptimizationGoal) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetDefault + +## -description +Gets the default orientation sensor, taking into account power and accuracy preferences. + +## -parameters +### -param sensorReadingType +The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated.” + +### -param optimizationGoal +Indicates the preferences of optimization for the sensor. This field is only used if an Absolute SensorReadingType is specified. An optimizationGoal of Precision will return an OrientationSensor using an accelereometer, a gyrometer, and a magnetometer to determine orientation with respect to magnetic North. This has the potential to use a lot of power due to it’s use of a gyrometer. In contrast, specifying an optimizationGoal of PowerEfficiency will return an OrientationSensor using an accelerometer and magnetometer only (no gyrometer) to save power at the a cost of some accuracy (readings will still be relatively accurate in most circumstances). + +## -returns +The default orientation sensor or **null** if no orientation sensors are found. + +## -remarks +This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The orientation-sensor readings are derived from multiple sensors.) A **null** value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](orientationsensor_getdefault.md) method will return immediately with a **null** result. + +The *optimizationGoal* parameter is dependent on the hardware available. It will attempt to choose the best sensor available based on your provided preference for optimization. It only has an effect if the *sensorReadingType* is **Absolute**. + +## -examples + +## -see-also +[GetDefault(SensorReadingType)](orientationsensor_getdefault_2064571144.md), [GetDefault](orientationsensor_getdefault_846721868.md) \ No newline at end of file diff --git a/windows.devices.sensors/orientationsensor_getdefault_846721868.md b/windows.devices.sensors/orientationsensor_getdefault_846721868.md index cc995449e7..6b4be393cf 100644 --- a/windows.devices.sensors/orientationsensor_getdefault_846721868.md +++ b/windows.devices.sensors/orientationsensor_getdefault_846721868.md @@ -1,38 +1,38 @@ ---- --api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.OrientationSensor.GetDefault - -## -description -Gets the default orientation sensor. - -## -returns -The default orientation sensor or **null** if no orientation sensors are found. - -## -remarks -This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The orientation-sensor readings are derived from multiple sensors.) A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](orientationsensor_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the orientation sensor. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/orientation/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the orientation sensor. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/orientation/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also -[GetDefault(SensorReadingType)](orientationsensor_getdefault_2064571144.md), [GetDefault(SensorReadingType, SensorOptimizationGoal)](orientationsensor_getdefault_274432112.md) +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetDefault + +## -description +Gets the default orientation sensor. + +## -returns +The default orientation sensor or **null** if no orientation sensors are found. + +## -remarks +This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The orientation-sensor readings are derived from multiple sensors.) A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](orientationsensor_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the orientation sensor. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/orientation/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the orientation sensor. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/orientation/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also +[GetDefault(SensorReadingType)](orientationsensor_getdefault_2064571144.md), [GetDefault(SensorReadingType, SensorOptimizationGoal)](orientationsensor_getdefault_274432112.md) diff --git a/windows.devices.sensors/orientationsensor_getdefaultforrelativereadings_1926893248.md b/windows.devices.sensors/orientationsensor_getdefaultforrelativereadings_1926893248.md index 823fbbf0ce..3e68fa740b 100644 --- a/windows.devices.sensors/orientationsensor_getdefaultforrelativereadings_1926893248.md +++ b/windows.devices.sensors/orientationsensor_getdefaultforrelativereadings_1926893248.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefaultForRelativeReadings --api-type: winrt method ---- # Windows.Devices.Sensors.OrientationSensor.GetDefaultForRelativeReadings ## -description Gets the default orientation sensor. ## -returns The default orientation sensor or null if no orientation sensors are found. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDefaultForRelativeReadings +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetDefaultForRelativeReadings + +## -description +Gets the default orientation sensor. + +## -returns +The default orientation sensor or null if no orientation sensors are found. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_minimumreportinterval.md b/windows.devices.sensors/orientationsensor_minimumreportinterval.md index 60842e374a..6346a7c123 100644 --- a/windows.devices.sensors/orientationsensor_minimumreportinterval.md +++ b/windows.devices.sensors/orientationsensor_minimumreportinterval.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensor.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensor.MinimumReportInterval ## -description Gets the minimum report interval supported by the sensor. ## -property-value The minimum [ReportInterval](orientationsensor_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also [ReportInterval](orientationsensor_reportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.MinimumReportInterval + +## -description +Gets the minimum report interval supported by the sensor. + +## -property-value +The minimum [ReportInterval](orientationsensor_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also +[ReportInterval](orientationsensor_reportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/orientationsensor_readingchanged.md b/windows.devices.sensors/orientationsensor_readingchanged.md index ad936dc984..9d0f1bfe3e 100644 --- a/windows.devices.sensors/orientationsensor_readingchanged.md +++ b/windows.devices.sensors/orientationsensor_readingchanged.md @@ -1,46 +1,46 @@ ---- --api-id: E:Windows.Devices.Sensors.OrientationSensor.ReadingChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.OrientationSensor.ReadingChanged - -## -description -Occurs each time the orientation sensor reports a new sensor reading. - -## -remarks -An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](orientationsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. - -The [OrientationSensor](orientationsensor.md) returns a quaternion and a rotation matrix. - -The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/orientation/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example shows the [ReadingChanged](orientationsensorreadingchangedeventargs.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/orientation/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. - - - -[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/orientation/javascript/scenario1.js#SnippetEnableReadingChangedJS)] - -The following example shows the [ReadingChanged](orientationsensor_readingchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/orientation/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.OrientationSensor.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.OrientationSensor.ReadingChanged + +## -description +Occurs each time the orientation sensor reports a new sensor reading. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](orientationsensor_reportinterval.md). This informs the sensor driver that resources should be allocated to satisfy the requirements of the application. + +The [OrientationSensor](orientationsensor.md) returns a quaternion and a rotation matrix. + +The following example demonstrates how a Windows Store app built with C# and XAML registers its **ReadingChanged** event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/orientation/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example shows the [ReadingChanged](orientationsensorreadingchangedeventargs.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/orientation/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its **ReadingChanged** event handler. + + + +[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/orientation/javascript/scenario1.js#SnippetEnableReadingChangedJS)] + +The following example shows the [ReadingChanged](orientationsensor_readingchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/orientation/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_readingtransform.md b/windows.devices.sensors/orientationsensor_readingtransform.md index e20fa3660d..e051b4b389 100644 --- a/windows.devices.sensors/orientationsensor_readingtransform.md +++ b/windows.devices.sensors/orientationsensor_readingtransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensor.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensor.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_readingtype.md b/windows.devices.sensors/orientationsensor_readingtype.md index 7bc35aa92f..2df92b66f5 100644 --- a/windows.devices.sensors/orientationsensor_readingtype.md +++ b/windows.devices.sensors/orientationsensor_readingtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensor.ReadingType --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensor.ReadingType ## -description Gets the sensor reading type. ## -property-value A [SensorReadingType](sensorreadingtype.md)-typed value that specifies the sensor reading type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.ReadingType +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.ReadingType + +## -description +Gets the sensor reading type. + +## -property-value +A [SensorReadingType](sensorreadingtype.md)-typed value that specifies the sensor reading type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_reportinterval.md b/windows.devices.sensors/orientationsensor_reportinterval.md index e19a527556..c57f7e79e7 100644 --- a/windows.devices.sensors/orientationsensor_reportinterval.md +++ b/windows.devices.sensors/orientationsensor_reportinterval.md @@ -1,3 +1,45 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensor.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensor.ReportInterval ## -description Gets or sets the report interval supported by the sensor. ## -property-value The report interval supported by the sensor. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](orientationsensor_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or [GetCurrentReading](orientationsensor_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. The application should consult the [MinimumReportInterval](orientationsensor_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. The Sensor platform automatically sets the change sensitivity for orientation sensors based on the current report interval. This table specifies the change sensitivity values for given intervals.
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degreees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
## -examples ## -see-also [MinimumReportInterval](orientationsensor_minimumreportinterval.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.ReportInterval + +## -description +Gets or sets the report interval supported by the sensor. + +## -property-value +The report interval supported by the sensor. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling [GetCurrentReading](orientationsensor_getcurrentreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or [GetCurrentReading](orientationsensor_getcurrentreading.md) has been called may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +The application should consult the [MinimumReportInterval](orientationsensor_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +The Sensor platform automatically sets the change sensitivity for orientation sensors based on the current report interval. This table specifies the change sensitivity values for given intervals. + + + + + + +
Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
1 ms – 16 ms0.01 degreees
17 ms – 32 ms0.5 degrees
>= 33 ms2 degrees
+ +## -examples + +## -see-also +[MinimumReportInterval](orientationsensor_minimumreportinterval.md) \ No newline at end of file diff --git a/windows.devices.sensors/orientationsensorreading_quaternion.md b/windows.devices.sensors/orientationsensorreading_quaternion.md index efcb7b460b..2c5a7c65fd 100644 --- a/windows.devices.sensors/orientationsensorreading_quaternion.md +++ b/windows.devices.sensors/orientationsensorreading_quaternion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensorReading.Quaternion --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensorReading.Quaternion ## -description Gets the Quaternion for the current orientation-sensor reading. ## -property-value The Quaternion for the current orientation-sensor reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReading.Quaternion +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReading.Quaternion + +## -description +Gets the Quaternion for the current orientation-sensor reading. + +## -property-value +The Quaternion for the current orientation-sensor reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensorreading_rotationmatrix.md b/windows.devices.sensors/orientationsensorreading_rotationmatrix.md index 844875eb8c..3ae0af6e17 100644 --- a/windows.devices.sensors/orientationsensorreading_rotationmatrix.md +++ b/windows.devices.sensors/orientationsensorreading_rotationmatrix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensorReading.RotationMatrix --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensorReading.RotationMatrix ## -description Gets the rotation matrix for the current orientation-sensor reading. ## -property-value The rotation matrix for the current orientation-sensor reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReading.RotationMatrix +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReading.RotationMatrix + +## -description +Gets the rotation matrix for the current orientation-sensor reading. + +## -property-value +The rotation matrix for the current orientation-sensor reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensorreading_timestamp.md b/windows.devices.sensors/orientationsensorreading_timestamp.md index 81997112f0..9145608ae5 100644 --- a/windows.devices.sensors/orientationsensorreading_timestamp.md +++ b/windows.devices.sensors/orientationsensorreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensorReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensorReading.Timestamp ## -description Gets the time at which the sensor reported the reading. ## -property-value The time at which the sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReading.Timestamp + +## -description +Gets the time at which the sensor reported the reading. + +## -property-value +The time at which the sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensorreading_yawaccuracy.md b/windows.devices.sensors/orientationsensorreading_yawaccuracy.md index 2559206d22..3973025519 100644 --- a/windows.devices.sensors/orientationsensorreading_yawaccuracy.md +++ b/windows.devices.sensors/orientationsensorreading_yawaccuracy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensorReading.YawAccuracy --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensorReading.YawAccuracy ## -description Gets the orientation sensor's z-axis accuracy. ## -property-value The orientation sensor's z-axis accuracy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReading.YawAccuracy +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReading.YawAccuracy + +## -description +Gets the orientation sensor's z-axis accuracy. + +## -property-value +The orientation sensor's z-axis accuracy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensorreadingchangedeventargs_reading.md b/windows.devices.sensors/orientationsensorreadingchangedeventargs_reading.md index c74e1a7427..51761793a4 100644 --- a/windows.devices.sensors/orientationsensorreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/orientationsensorreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.OrientationSensorReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.OrientationSensorReadingChangedEventArgs.Reading ## -description Gets the current reading which includes a Quaternion, a RotationMatrix, and a timestamp. ## -property-value The current reading which includes a Quaternion, a RotationMatrix, and a timestamp. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReadingChangedEventArgs.Reading + +## -description +Gets the current reading which includes a Quaternion, a RotationMatrix, and a timestamp. + +## -property-value +The current reading which includes a Quaternion, a RotationMatrix, and a timestamp. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer.md b/windows.devices.sensors/pedometer.md index 8b9010d6fa..d4029e4c9c 100644 --- a/windows.devices.sensors/pedometer.md +++ b/windows.devices.sensors/pedometer.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Sensors.Pedometer --api-type: winrt class ---- # Windows.Devices.Sensors.Pedometer ## -description Provides an interface for a pedometer to measure the number of steps taken. ## -remarks > [!NOTE] > This class is not supported in JavaScript ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.Pedometer +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.Pedometer + +## -description +Provides an interface for a pedometer to measure the number of steps taken. + +## -remarks +> [!NOTE] +> This class is not supported in JavaScript + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_deviceid.md b/windows.devices.sensors/pedometer_deviceid.md index 3524c28989..20ca1efef1 100644 --- a/windows.devices.sensors/pedometer_deviceid.md +++ b/windows.devices.sensors/pedometer_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Pedometer.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.Pedometer.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Pedometer.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Pedometer.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_fromidasync_1322863552.md b/windows.devices.sensors/pedometer_fromidasync_1322863552.md index 50dd686ba6..80033429c4 100644 --- a/windows.devices.sensors/pedometer_fromidasync_1322863552.md +++ b/windows.devices.sensors/pedometer_fromidasync_1322863552.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.FromIdAsync ## -description Obtains the pedometer from its identifier. ## -parameters ### -param deviceId The sensor identifier. ## -returns Returns the [Pedometer](pedometer.md) object from its identifier. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.FromIdAsync + +## -description +Obtains the pedometer from its identifier. + +## -parameters +### -param deviceId +The sensor identifier. + +## -returns +Returns the [Pedometer](pedometer.md) object from its identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometer_getcurrentreadings_1413407989.md b/windows.devices.sensors/pedometer_getcurrentreadings_1413407989.md index c7a2ea7f2e..b0c7b9391e 100644 --- a/windows.devices.sensors/pedometer_getcurrentreadings_1413407989.md +++ b/windows.devices.sensors/pedometer_getcurrentreadings_1413407989.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.GetCurrentReadings --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.GetCurrentReadings ## -description Gets the current step information from the pedometer sensor. ## -returns A collection of the step information available from the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.GetCurrentReadings +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.GetCurrentReadings + +## -description +Gets the current step information from the pedometer sensor. + +## -returns +A collection of the step information available from the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_getdefaultasync_1549573963.md b/windows.devices.sensors/pedometer_getdefaultasync_1549573963.md index feb93ddbcf..9481f7d0d3 100644 --- a/windows.devices.sensors/pedometer_getdefaultasync_1549573963.md +++ b/windows.devices.sensors/pedometer_getdefaultasync_1549573963.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.GetDefaultAsync ## -description Asynchronously obtains the default pedometer. ## -returns Asynchronously returns a [Pedometer](pedometer.md) object that represents the default sensor. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.GetDefaultAsync + +## -description +Asynchronously obtains the default pedometer. + +## -returns +Asynchronously returns a [Pedometer](pedometer.md) object that represents the default sensor. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometer_getdeviceselector_838466080.md b/windows.devices.sensors/pedometer_getdeviceselector_838466080.md index 8544759802..aab998d39f 100644 --- a/windows.devices.sensors/pedometer_getdeviceselector_838466080.md +++ b/windows.devices.sensors/pedometer_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.GetDeviceSelector ## -description Gets the device selector. ## -returns Returns the device selector, if it exists; otherwise null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_getreadingsfromtriggerdetails_412199864.md b/windows.devices.sensors/pedometer_getreadingsfromtriggerdetails_412199864.md index f15458c0a3..aae62c3b3b 100644 --- a/windows.devices.sensors/pedometer_getreadingsfromtriggerdetails_412199864.md +++ b/windows.devices.sensors/pedometer_getreadingsfromtriggerdetails_412199864.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.GetReadingsFromTriggerDetails(Windows.Devices.Sensors.SensorDataThresholdTriggerDetails) --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.GetReadingsFromTriggerDetails ## -description Gets readings from the trigger details in background task. ## -parameters ### -param triggerDetails The trigger details received from the background task. ## -returns The collection of pedometer data retrieved from the trigger details. ## -remarks [SensorDataThresholdTriggerDetails](sensordatathresholdtriggerdetails.md) objects are designed to be independent of the sensor that activated the background trigger. This enables you to support all of the sensors your are interested in with a single background task. In order to support this methodology, you need to define this method in all of your sensors that extract data from the background trigger. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.GetReadingsFromTriggerDetails(Windows.Devices.Sensors.SensorDataThresholdTriggerDetails) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.GetReadingsFromTriggerDetails + +## -description +Gets readings from the trigger details in background task. + +## -parameters +### -param triggerDetails +The trigger details received from the background task. + +## -returns +The collection of pedometer data retrieved from the trigger details. + +## -remarks +[SensorDataThresholdTriggerDetails](sensordatathresholdtriggerdetails.md) objects are designed to be independent of the sensor that activated the background trigger. This enables you to support all of the sensors your are interested in with a single background task. In order to support this methodology, you need to define this method in all of your sensors that extract data from the background trigger. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_getsystemhistoryasync_1048912884.md b/windows.devices.sensors/pedometer_getsystemhistoryasync_1048912884.md index a167ffa6e8..2a92e3e0c6 100644 --- a/windows.devices.sensors/pedometer_getsystemhistoryasync_1048912884.md +++ b/windows.devices.sensors/pedometer_getsystemhistoryasync_1048912884.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync ## -description Asynchronously gets sensor readings from a specific time. ## -parameters ### -param fromTime The time for which you want to retrieve the reading. ## -returns Asynchronously returns a list of [PedometerReading](pedometerreading.md) objects that represent info about the sensor. ## -remarks ## -examples ## -see-also [GetSystemHistoryAsync(DateTime, TimeSpan)](pedometer_getsystemhistoryasync_1411492076.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync + +## -description +Asynchronously gets sensor readings from a specific time. + +## -parameters +### -param fromTime +The time for which you want to retrieve the reading. + +## -returns +Asynchronously returns a list of [PedometerReading](pedometerreading.md) objects that represent info about the sensor. + +## -remarks + +## -examples + +## -see-also +[GetSystemHistoryAsync(DateTime, TimeSpan)](pedometer_getsystemhistoryasync_1411492076.md) \ No newline at end of file diff --git a/windows.devices.sensors/pedometer_getsystemhistoryasync_1411492076.md b/windows.devices.sensors/pedometer_getsystemhistoryasync_1411492076.md index 3fc6869583..ddbd574111 100644 --- a/windows.devices.sensors/pedometer_getsystemhistoryasync_1411492076.md +++ b/windows.devices.sensors/pedometer_getsystemhistoryasync_1411492076.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync ## -description Asynchronously gets pedometer readings from a specific time and duration. ## -parameters ### -param fromTime The time for which you want to retrieve the reading. ### -param duration The duration over which you want to retrieve data. ## -returns Asynchronously returns a list of [PedometerReading](pedometerreading.md) objects that represent info about the sensor. ## -remarks ## -examples ## -see-also [GetSystemHistoryAsync(DateTime)](pedometer_getsystemhistoryasync_1048912884.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Pedometer.GetSystemHistoryAsync + +## -description +Asynchronously gets pedometer readings from a specific time and duration. + +## -parameters +### -param fromTime +The time for which you want to retrieve the reading. + +### -param duration +The duration over which you want to retrieve data. + +## -returns +Asynchronously returns a list of [PedometerReading](pedometerreading.md) objects that represent info about the sensor. + +## -remarks + +## -examples + +## -see-also +[GetSystemHistoryAsync(DateTime)](pedometer_getsystemhistoryasync_1048912884.md) \ No newline at end of file diff --git a/windows.devices.sensors/pedometer_minimumreportinterval.md b/windows.devices.sensors/pedometer_minimumreportinterval.md index 7cb4520a1b..6970e4ba1a 100644 --- a/windows.devices.sensors/pedometer_minimumreportinterval.md +++ b/windows.devices.sensors/pedometer_minimumreportinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Pedometer.MinimumReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Pedometer.MinimumReportInterval ## -description The smallest report interval that is supported by this pedometer. ## -property-value The smallest [ReportInterval](pedometer_reportinterval.md) supported by the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Pedometer.MinimumReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Pedometer.MinimumReportInterval + +## -description +The smallest report interval that is supported by this pedometer. + +## -property-value +The smallest [ReportInterval](pedometer_reportinterval.md) supported by the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_powerinmilliwatts.md b/windows.devices.sensors/pedometer_powerinmilliwatts.md index 220274425d..fbdedfc6a4 100644 --- a/windows.devices.sensors/pedometer_powerinmilliwatts.md +++ b/windows.devices.sensors/pedometer_powerinmilliwatts.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.Pedometer.PowerInMilliwatts --api-type: winrt property ---- # Windows.Devices.Sensors.Pedometer.PowerInMilliwatts ## -description Gets the power that the sensor consumes. ## -property-value The amount of power consumed in milliwatts. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Pedometer.PowerInMilliwatts +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Pedometer.PowerInMilliwatts + +## -description +Gets the power that the sensor consumes. + +## -property-value +The amount of power consumed in milliwatts. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_readingchanged.md b/windows.devices.sensors/pedometer_readingchanged.md index 767b62324f..00fed6c69d 100644 --- a/windows.devices.sensors/pedometer_readingchanged.md +++ b/windows.devices.sensors/pedometer_readingchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Sensors.Pedometer.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.Pedometer.ReadingChanged ## -description Occurs each time the pedometer reports a new value. ## -remarks An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](pedometer_reportinterval.md). This sets the frequency of the **ReadingChanged** event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.Pedometer.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.Pedometer.ReadingChanged + +## -description +Occurs each time the pedometer reports a new value. + +## -remarks +An application may register this event handler to obtain sensor readings. The application must establish a desired [ReportInterval](pedometer_reportinterval.md). This sets the frequency of the **ReadingChanged** event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometer_reportinterval.md b/windows.devices.sensors/pedometer_reportinterval.md index 8845779b70..71d6d43212 100644 --- a/windows.devices.sensors/pedometer_reportinterval.md +++ b/windows.devices.sensors/pedometer_reportinterval.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Devices.Sensors.Pedometer.ReportInterval --api-type: winrt property ---- # Windows.Devices.Sensors.Pedometer.ReportInterval ## -description Gets or sets the current report interval for the pedometer. ## -property-value The current report interval. ## -remarks The report interval is specified in milliseconds. The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or requesting a [PedometerReading](pedometerreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. Changes to the report interval after an event handler has been registered or after you check the sensor history may apply to the delivery of subsequent sensor readings. Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. Your application should consult the [MinimumReportInterval](pedometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.Pedometer.ReportInterval +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Pedometer.ReportInterval + +## -description +Gets or sets the current report interval for the pedometer. + +## -property-value +The current report interval. + +## -remarks +The report interval is specified in milliseconds. + +The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or requesting a [PedometerReading](pedometerreading.md). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor. + +Changes to the report interval after an event handler has been registered or after you check the sensor history may apply to the delivery of subsequent sensor readings. + +Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection. + +Your application should consult the [MinimumReportInterval](pedometer_minimumreportinterval.md) property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results. + +Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometerdatathreshold.md b/windows.devices.sensors/pedometerdatathreshold.md index 856a9d4189..6f0fb9aa10 100644 --- a/windows.devices.sensors/pedometerdatathreshold.md +++ b/windows.devices.sensors/pedometerdatathreshold.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.PedometerDataThreshold --api-type: winrt class ---- # Windows.Devices.Sensors.PedometerDataThreshold ## -description A threshold for the [Pedometer](pedometer.md) sensor. When the threshold conditions are met, the sensor trigger will activate. ## -remarks ## -examples ## -see-also [ISensorDataThreshold](isensordatathreshold.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.PedometerDataThreshold +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.PedometerDataThreshold + +## -description +A threshold for the [Pedometer](pedometer.md) sensor. When the threshold conditions are met, the sensor trigger will activate. + +## -remarks + +## -examples + +## -see-also +[ISensorDataThreshold](isensordatathreshold.md) \ No newline at end of file diff --git a/windows.devices.sensors/pedometerdatathreshold_pedometerdatathreshold_620982627.md b/windows.devices.sensors/pedometerdatathreshold_pedometerdatathreshold_620982627.md index 8b25dbecc7..bb7d3b790e 100644 --- a/windows.devices.sensors/pedometerdatathreshold_pedometerdatathreshold_620982627.md +++ b/windows.devices.sensors/pedometerdatathreshold_pedometerdatathreshold_620982627.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sensors.PedometerDataThreshold.#ctor(Windows.Devices.Sensors.Pedometer,System.Int32) --api-type: winrt method ---- # Windows.Devices.Sensors.PedometerDataThreshold.PedometerDataThreshold ## -description Creates a [PedometerDataThreshold](pedometerdatathreshold.md) object. ## -parameters ### -param sensor The pedometer sensor. ### -param stepGoal The number of steps before the threshold is exceeded and the background task is activated. ## -remarks The value of *stepGoal* needs to be greater than 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.PedometerDataThreshold.#ctor(Windows.Devices.Sensors.Pedometer,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.PedometerDataThreshold.PedometerDataThreshold + +## -description +Creates a [PedometerDataThreshold](pedometerdatathreshold.md) object. + +## -parameters +### -param sensor +The pedometer sensor. + +### -param stepGoal +The number of steps before the threshold is exceeded and the background task is activated. + +## -remarks +The value of *stepGoal* needs to be greater than 0. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/pedometerreading.md b/windows.devices.sensors/pedometerreading.md index fbadf2b1cc..6687e946b3 100644 --- a/windows.devices.sensors/pedometerreading.md +++ b/windows.devices.sensors/pedometerreading.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Sensors.PedometerReading --api-type: winrt class ---- # Windows.Devices.Sensors.PedometerReading ## -description Represents a pedometer reading. ## -remarks This object is accessed when you request the sensor history. It is also accessed when you retrieve the [Reading](pedometerreadingchangedeventargs_reading.md) property of the [PedometerReadingChangedEventArgs](pedometerreadingchangedeventargs.md) object in the event callback method. ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.PedometerReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.PedometerReading + +## -description +Represents a pedometer reading. + +## -remarks +This object is accessed when you request the sensor history. It is also accessed when you retrieve the [Reading](pedometerreadingchangedeventargs_reading.md) property of the [PedometerReadingChangedEventArgs](pedometerreadingchangedeventargs.md) object in the event callback method. + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometerreading_cumulativesteps.md b/windows.devices.sensors/pedometerreading_cumulativesteps.md index 44961ef680..4fba9f12e2 100644 --- a/windows.devices.sensors/pedometerreading_cumulativesteps.md +++ b/windows.devices.sensors/pedometerreading_cumulativesteps.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.PedometerReading.CumulativeSteps --api-type: winrt property ---- # Windows.Devices.Sensors.PedometerReading.CumulativeSteps ## -description Gets the total number of steps taken for this pedometer reading. ## -property-value The total number of steps taken. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.PedometerReading.CumulativeSteps +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.PedometerReading.CumulativeSteps + +## -description +Gets the total number of steps taken for this pedometer reading. + +## -property-value +The total number of steps taken. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometerreading_cumulativestepsduration.md b/windows.devices.sensors/pedometerreading_cumulativestepsduration.md index 9604346973..e3b8f56f58 100644 --- a/windows.devices.sensors/pedometerreading_cumulativestepsduration.md +++ b/windows.devices.sensors/pedometerreading_cumulativestepsduration.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.PedometerReading.CumulativeStepsDuration --api-type: winrt property ---- # Windows.Devices.Sensors.PedometerReading.CumulativeStepsDuration ## -description Gets the amount of time that has elapsed for this pedometer reading. ## -property-value The amount of elapsed time for the current reading of cumulative steps. This value is given in milliseconds. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.PedometerReading.CumulativeStepsDuration +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.PedometerReading.CumulativeStepsDuration + +## -description +Gets the amount of time that has elapsed for this pedometer reading. + +## -property-value +The amount of elapsed time for the current reading of cumulative steps. This value is given in milliseconds. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometerreading_stepkind.md b/windows.devices.sensors/pedometerreading_stepkind.md index a0ba7104b4..b0e6063d30 100644 --- a/windows.devices.sensors/pedometerreading_stepkind.md +++ b/windows.devices.sensors/pedometerreading_stepkind.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.PedometerReading.StepKind --api-type: winrt property ---- # Windows.Devices.Sensors.PedometerReading.StepKind ## -description Indicates the type of steps taken for this pedometer reading. ## -property-value The type of step taken. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.PedometerReading.StepKind +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.PedometerReading.StepKind + +## -description +Indicates the type of steps taken for this pedometer reading. + +## -property-value +The type of step taken. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometerreading_timestamp.md b/windows.devices.sensors/pedometerreading_timestamp.md index 2902ac7233..7decfe5c2f 100644 --- a/windows.devices.sensors/pedometerreading_timestamp.md +++ b/windows.devices.sensors/pedometerreading_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.PedometerReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.PedometerReading.Timestamp ## -description Gets the time for the most recent pedometer reading. ## -property-value The time when the pedometer reported the reading. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.PedometerReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.PedometerReading.Timestamp + +## -description +Gets the time for the most recent pedometer reading. + +## -property-value +The time when the pedometer reported the reading. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometerreadingchangedeventargs.md b/windows.devices.sensors/pedometerreadingchangedeventargs.md index d33aa02625..31419fd1e6 100644 --- a/windows.devices.sensors/pedometerreadingchangedeventargs.md +++ b/windows.devices.sensors/pedometerreadingchangedeventargs.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Sensors.PedometerReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.PedometerReadingChangedEventArgs ## -description Provides data for the pedometer reading– changed event. ## -remarks This object is accessed when your app supports the [ReadingChanged](pedometer_readingchanged.md) event. ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.PedometerReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.PedometerReadingChangedEventArgs + +## -description +Provides data for the pedometer reading– changed event. + +## -remarks +This object is accessed when your app supports the [ReadingChanged](pedometer_readingchanged.md) event. + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/pedometerreadingchangedeventargs_reading.md b/windows.devices.sensors/pedometerreadingchangedeventargs_reading.md index 0e1c45ff97..ee154cfb06 100644 --- a/windows.devices.sensors/pedometerreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/pedometerreadingchangedeventargs_reading.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sensors.PedometerReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.PedometerReadingChangedEventArgs.Reading ## -description Gets the most recent pedometer reading. ## -property-value The most recent pedometer reading. ## -remarks ## -examples ## -see-also ## -capabilities activity \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.PedometerReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.PedometerReadingChangedEventArgs.Reading + +## -description +Gets the most recent pedometer reading. + +## -property-value +The most recent pedometer reading. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +activity \ No newline at end of file diff --git a/windows.devices.sensors/proximitysensor.md b/windows.devices.sensors/proximitysensor.md index bebcdf0f12..5eb4f96bb0 100644 --- a/windows.devices.sensors/proximitysensor.md +++ b/windows.devices.sensors/proximitysensor.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Sensors.ProximitySensor --api-type: winrt class ---- # Windows.Devices.Sensors.ProximitySensor ## -description Provides an interface for a proximity sensor to determine whether or not an object is detected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ProximitySensor +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ProximitySensor + +## -description +Provides an interface for a proximity sensor to determine whether or not an object is detected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_createdisplayonoffcontroller_1711685055.md b/windows.devices.sensors/proximitysensor_createdisplayonoffcontroller_1711685055.md index eac555520d..d64bdb15b5 100644 --- a/windows.devices.sensors/proximitysensor_createdisplayonoffcontroller_1711685055.md +++ b/windows.devices.sensors/proximitysensor_createdisplayonoffcontroller_1711685055.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensor.CreateDisplayOnOffController --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensor.CreateDisplayOnOffController ## -description Creates a controller responsible for turning the display on or off based on the [ProximitySensorReading](proximitysensorreading.md). ## -returns The controller for the phone display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensor.CreateDisplayOnOffController +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensor.CreateDisplayOnOffController + +## -description +Creates a controller responsible for turning the display on or off based on the [ProximitySensorReading](proximitysensorreading.md). + +## -returns +The controller for the phone display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_deviceid.md b/windows.devices.sensors/proximitysensor_deviceid.md index 5405d38d60..2d42c495fc 100644 --- a/windows.devices.sensors/proximitysensor_deviceid.md +++ b/windows.devices.sensors/proximitysensor_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensor.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensor.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensor.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensor.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_fromid_114571398.md b/windows.devices.sensors/proximitysensor_fromid_114571398.md index 893a60a211..cd0f15418d 100644 --- a/windows.devices.sensors/proximitysensor_fromid_114571398.md +++ b/windows.devices.sensors/proximitysensor_fromid_114571398.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensor.FromId(System.String) --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensor.FromId ## -description Obtains the proximity sensor from its identifier. ## -parameters ### -param sensorId The sensor identifier. ## -returns Returns the [ProximitySensor](proximitysensor.md) object from its identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensor.FromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensor.FromId + +## -description +Obtains the proximity sensor from its identifier. + +## -parameters +### -param sensorId +The sensor identifier. + +## -returns +Returns the [ProximitySensor](proximitysensor.md) object from its identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_getcurrentreading_1416488181.md b/windows.devices.sensors/proximitysensor_getcurrentreading_1416488181.md index 3e8354164e..6fdf658d58 100644 --- a/windows.devices.sensors/proximitysensor_getcurrentreading_1416488181.md +++ b/windows.devices.sensors/proximitysensor_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensor.GetCurrentReading --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensor.GetCurrentReading ## -description Gets the current reading for the proximity sensor. ## -returns Indicates whether or not the proximity sensor detects an object, and if so, the distance to that object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensor.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensor.GetCurrentReading + +## -description +Gets the current reading for the proximity sensor. + +## -returns +Indicates whether or not the proximity sensor detects an object, and if so, the distance to that object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_getdeviceselector_838466080.md b/windows.devices.sensors/proximitysensor_getdeviceselector_838466080.md index e92b25a722..f1140af372 100644 --- a/windows.devices.sensors/proximitysensor_getdeviceselector_838466080.md +++ b/windows.devices.sensors/proximitysensor_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensor.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensor.GetDeviceSelector ## -description Gets the device selector. ## -returns Returns the device selector. If no device selector is available, this method returns null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensor.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensor.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector. If no device selector is available, this method returns null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_getreadingsfromtriggerdetails_412199864.md b/windows.devices.sensors/proximitysensor_getreadingsfromtriggerdetails_412199864.md index 57a962a1a3..6eb2e025d4 100644 --- a/windows.devices.sensors/proximitysensor_getreadingsfromtriggerdetails_412199864.md +++ b/windows.devices.sensors/proximitysensor_getreadingsfromtriggerdetails_412199864.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensor.GetReadingsFromTriggerDetails(Windows.Devices.Sensors.SensorDataThresholdTriggerDetails) --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensor.GetReadingsFromTriggerDetails ## -description Gets readings from the trigger details in background task. ## -parameters ### -param triggerDetails The trigger details received from the background task. ## -returns The collection of proximity data retrieved from the trigger details. ## -remarks [SensorDataThresholdTriggerDetails](sensordatathresholdtriggerdetails.md) objects are designed to be independent of the sensor that activated the background trigger. This enables you to support all of the sensors your are interested in with a single background task. In order to support this methodology, you need to define this method in all of your sensors that extract data from the background trigger. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensor.GetReadingsFromTriggerDetails(Windows.Devices.Sensors.SensorDataThresholdTriggerDetails) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensor.GetReadingsFromTriggerDetails + +## -description +Gets readings from the trigger details in background task. + +## -parameters +### -param triggerDetails +The trigger details received from the background task. + +## -returns +The collection of proximity data retrieved from the trigger details. + +## -remarks +[SensorDataThresholdTriggerDetails](sensordatathresholdtriggerdetails.md) objects are designed to be independent of the sensor that activated the background trigger. This enables you to support all of the sensors your are interested in with a single background task. In order to support this methodology, you need to define this method in all of your sensors that extract data from the background trigger. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_maxdistanceinmillimeters.md b/windows.devices.sensors/proximitysensor_maxdistanceinmillimeters.md index 81d317db61..5616b04da3 100644 --- a/windows.devices.sensors/proximitysensor_maxdistanceinmillimeters.md +++ b/windows.devices.sensors/proximitysensor_maxdistanceinmillimeters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensor.MaxDistanceInMillimeters --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensor.MaxDistanceInMillimeters ## -description The largest distance where the proximity sensor can detect an object. ## -property-value The maximum distance in millimeters where the proximity sensor supports detecting an object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensor.MaxDistanceInMillimeters +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensor.MaxDistanceInMillimeters + +## -description +The largest distance where the proximity sensor can detect an object. + +## -property-value +The maximum distance in millimeters where the proximity sensor supports detecting an object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_mindistanceinmillimeters.md b/windows.devices.sensors/proximitysensor_mindistanceinmillimeters.md index 28559340fa..e670809d0b 100644 --- a/windows.devices.sensors/proximitysensor_mindistanceinmillimeters.md +++ b/windows.devices.sensors/proximitysensor_mindistanceinmillimeters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensor.MinDistanceInMillimeters --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensor.MinDistanceInMillimeters ## -description The shortest distance where the proximity sensor can detect an object. ## -property-value The minimum distance in millimeters where the proximity sensor supports detecting an object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensor.MinDistanceInMillimeters +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensor.MinDistanceInMillimeters + +## -description +The shortest distance where the proximity sensor can detect an object. + +## -property-value +The minimum distance in millimeters where the proximity sensor supports detecting an object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensor_readingchanged.md b/windows.devices.sensors/proximitysensor_readingchanged.md index 0434c0a7e7..d2d5bbbe21 100644 --- a/windows.devices.sensors/proximitysensor_readingchanged.md +++ b/windows.devices.sensors/proximitysensor_readingchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.Sensors.ProximitySensor.ReadingChanged --api-type: winrt event ---- # Windows.Devices.Sensors.ProximitySensor.ReadingChanged ## -description Occurs each time the proximity sensor reports a new value. ## -remarks An application may register this event handler to obtain sensor readings. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sensors.ProximitySensor.ReadingChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.ProximitySensor.ReadingChanged + +## -description +Occurs each time the proximity sensor reports a new value. + +## -remarks +An application may register this event handler to obtain sensor readings. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensordatathreshold.md b/windows.devices.sensors/proximitysensordatathreshold.md index 6dbfbfb811..df7b4d9172 100644 --- a/windows.devices.sensors/proximitysensordatathreshold.md +++ b/windows.devices.sensors/proximitysensordatathreshold.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.ProximitySensorDataThreshold --api-type: winrt class ---- # Windows.Devices.Sensors.ProximitySensorDataThreshold ## -description A threshold for the [ProximitySensor](proximitysensor.md). When the threshold conditions are met, the sensor trigger will activate. ## -remarks ## -examples ## -see-also [ISensorDataThreshold](isensordatathreshold.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ProximitySensorDataThreshold +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ProximitySensorDataThreshold + +## -description +A threshold for the [ProximitySensor](proximitysensor.md). When the threshold conditions are met, the sensor trigger will activate. + +## -remarks + +## -examples + +## -see-also +[ISensorDataThreshold](isensordatathreshold.md) \ No newline at end of file diff --git a/windows.devices.sensors/proximitysensordatathreshold_proximitysensordatathreshold_1624220772.md b/windows.devices.sensors/proximitysensordatathreshold_proximitysensordatathreshold_1624220772.md index 4945ab38cd..a1ff751574 100644 --- a/windows.devices.sensors/proximitysensordatathreshold_proximitysensordatathreshold_1624220772.md +++ b/windows.devices.sensors/proximitysensordatathreshold_proximitysensordatathreshold_1624220772.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensorDataThreshold.#ctor(Windows.Devices.Sensors.ProximitySensor) --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensorDataThreshold.ProximitySensorDataThreshold ## -description Creates a [ProximitySensorDataThreshold](proximitysensordatathreshold.md) object. ## -parameters ### -param sensor The proximity sensor. ## -remarks The threshold for a [ProximitySensorDataThreshold](proximitysensordatathreshold.md) is if the [ProximitySensorReading](proximitysensorreading.md) value changes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensorDataThreshold.#ctor(Windows.Devices.Sensors.ProximitySensor) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensorDataThreshold.ProximitySensorDataThreshold + +## -description +Creates a [ProximitySensorDataThreshold](proximitysensordatathreshold.md) object. + +## -parameters +### -param sensor +The proximity sensor. + +## -remarks +The threshold for a [ProximitySensorDataThreshold](proximitysensordatathreshold.md) is if the [ProximitySensorReading](proximitysensorreading.md) value changes. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensordisplayonoffcontroller.md b/windows.devices.sensors/proximitysensordisplayonoffcontroller.md index eb2e7bd0c2..6b598b0f32 100644 --- a/windows.devices.sensors/proximitysensordisplayonoffcontroller.md +++ b/windows.devices.sensors/proximitysensordisplayonoffcontroller.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Sensors.ProximitySensorDisplayOnOffController --api-type: winrt class ---- # Windows.Devices.Sensors.ProximitySensorDisplayOnOffController ## -description Provides a controller responsible for turning on or off the phone display based on the readings from the [ProximitySensor](proximitysensor.md). ## -remarks This class will have no effect if your app is running on a platform that doesn't support a controller for the display state. For example, this class has no effect on applications running on a desktop because the desktop platform does not support a controller cycling the display. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ProximitySensorDisplayOnOffController +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ProximitySensorDisplayOnOffController + +## -description +Provides a controller responsible for turning on or off the phone display based on the readings from the [ProximitySensor](proximitysensor.md). + +## -remarks +This class will have no effect if your app is running on a platform that doesn't support a controller for the display state. For example, this class has no effect on applications running on a desktop because the desktop platform does not support a controller cycling the display. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.sensors/proximitysensordisplayonoffcontroller_close_811482585.md b/windows.devices.sensors/proximitysensordisplayonoffcontroller_close_811482585.md index 0c62fa124a..c10563b444 100644 --- a/windows.devices.sensors/proximitysensordisplayonoffcontroller_close_811482585.md +++ b/windows.devices.sensors/proximitysensordisplayonoffcontroller_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Sensors.ProximitySensorDisplayOnOffController.Close --api-type: winrt method ---- # Windows.Devices.Sensors.ProximitySensorDisplayOnOffController.Close ## -description Disconnects this [ProximitySensorDisplayOnOffController](proximitysensordisplayonoffcontroller.md) instance from the service and frees all the allocated resources. ## -remarks This method follows the same behavior as [IClosable](http://msdn.microsoft.com/library/856c7d91-15ab-4101-bc5f-232004ad6df4). This means that if you are using Microsoft Visual C++ or C# you should not call this method directly. Instead you should use **delete** or the **Dispose** method respectively. See [IClosable](http://msdn.microsoft.com/library/856c7d91-15ab-4101-bc5f-232004ad6df4) for more details. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sensors.ProximitySensorDisplayOnOffController.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.ProximitySensorDisplayOnOffController.Close + +## -description +Disconnects this [ProximitySensorDisplayOnOffController](proximitysensordisplayonoffcontroller.md) instance from the service and frees all the allocated resources. + +## -remarks +This method follows the same behavior as [IClosable](http://msdn.microsoft.com/library/856c7d91-15ab-4101-bc5f-232004ad6df4). This means that if you are using Microsoft Visual C++ or C# you should not call this method directly. Instead you should use **delete** or the **Dispose** method respectively. See [IClosable](http://msdn.microsoft.com/library/856c7d91-15ab-4101-bc5f-232004ad6df4) for more details. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensorreading.md b/windows.devices.sensors/proximitysensorreading.md index 0655452eaf..0afd18173d 100644 --- a/windows.devices.sensors/proximitysensorreading.md +++ b/windows.devices.sensors/proximitysensorreading.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.ProximitySensorReading --api-type: winrt class ---- # Windows.Devices.Sensors.ProximitySensorReading ## -description Represents a reading from the proximity sensor. ## -remarks This object is accessed when you invoke the [GetCurrentReading](proximitysensor_getcurrentreading.md) method; and it is accessed when you retrieve the [Reading](proximitysensorreadingchangedeventargs_reading.md) property of the [ProximityReadingChangedEventArgs](proximitysensorreadingchangedeventargs.md) object in the event callback method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ProximitySensorReading +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ProximitySensorReading + +## -description +Represents a reading from the proximity sensor. + +## -remarks +This object is accessed when you invoke the [GetCurrentReading](proximitysensor_getcurrentreading.md) method; and it is accessed when you retrieve the [Reading](proximitysensorreadingchangedeventargs_reading.md) property of the [ProximityReadingChangedEventArgs](proximitysensorreadingchangedeventargs.md) object in the event callback method. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensorreading_distanceinmillimeters.md b/windows.devices.sensors/proximitysensorreading_distanceinmillimeters.md index ef7db0bab2..6e54c6744d 100644 --- a/windows.devices.sensors/proximitysensorreading_distanceinmillimeters.md +++ b/windows.devices.sensors/proximitysensorreading_distanceinmillimeters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensorReading.DistanceInMillimeters --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensorReading.DistanceInMillimeters ## -description Gets the distance from the proximity sensor to the detected object. ## -property-value The distance between the sensor and the object in millimeters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensorReading.DistanceInMillimeters +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensorReading.DistanceInMillimeters + +## -description +Gets the distance from the proximity sensor to the detected object. + +## -property-value +The distance between the sensor and the object in millimeters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensorreading_isdetected.md b/windows.devices.sensors/proximitysensorreading_isdetected.md index 17a2687b3e..5f6b610113 100644 --- a/windows.devices.sensors/proximitysensorreading_isdetected.md +++ b/windows.devices.sensors/proximitysensorreading_isdetected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensorReading.IsDetected --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensorReading.IsDetected ## -description Gets whether or not an object is detected by the proximity sensor. ## -property-value True if an object is detected by the proximity sensor; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensorReading.IsDetected +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensorReading.IsDetected + +## -description +Gets whether or not an object is detected by the proximity sensor. + +## -property-value +True if an object is detected by the proximity sensor; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensorreading_timestamp.md b/windows.devices.sensors/proximitysensorreading_timestamp.md index d5c7101250..87bd5479d0 100644 --- a/windows.devices.sensors/proximitysensorreading_timestamp.md +++ b/windows.devices.sensors/proximitysensorreading_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensorReading.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensorReading.Timestamp ## -description Gets the time for the most recent proximity sensor reading. ## -property-value The time when the proximity sensor reported the reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensorReading.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensorReading.Timestamp + +## -description +Gets the time for the most recent proximity sensor reading. + +## -property-value +The time when the proximity sensor reported the reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensorreadingchangedeventargs.md b/windows.devices.sensors/proximitysensorreadingchangedeventargs.md index 5fac3a3674..c558abd101 100644 --- a/windows.devices.sensors/proximitysensorreadingchangedeventargs.md +++ b/windows.devices.sensors/proximitysensorreadingchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs --api-type: winrt class ---- # Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs ## -description Provides data for the reading– changed event of the proximity sensor. ## -remarks This object is accessed when your app supports the [ReadingChanged](proximitysensor_readingchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs + +## -description +Provides data for the reading– changed event of the proximity sensor. + +## -remarks +This object is accessed when your app supports the [ReadingChanged](proximitysensor_readingchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/proximitysensorreadingchangedeventargs_reading.md b/windows.devices.sensors/proximitysensorreadingchangedeventargs_reading.md index 0e44832e98..86a390e835 100644 --- a/windows.devices.sensors/proximitysensorreadingchangedeventargs_reading.md +++ b/windows.devices.sensors/proximitysensorreadingchangedeventargs_reading.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs.Reading --api-type: winrt property ---- # Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs.Reading ## -description Gets or sets the most recent proximity sensor reading. ## -property-value The most recent proximity sensor reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs.Reading +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.ProximitySensorReadingChangedEventArgs.Reading + +## -description +Gets or sets the most recent proximity sensor reading. + +## -property-value +The most recent proximity sensor reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensordatathresholdtriggerdetails.md b/windows.devices.sensors/sensordatathresholdtriggerdetails.md index 78e3a02a39..dae57b8db6 100644 --- a/windows.devices.sensors/sensordatathresholdtriggerdetails.md +++ b/windows.devices.sensors/sensordatathresholdtriggerdetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Sensors.SensorDataThresholdTriggerDetails --api-type: winrt class ---- # Windows.Devices.Sensors.SensorDataThresholdTriggerDetails ## -description Provides data for what sensor triggered the data threshold monitoring task. ## -remarks In order to support the background trigger of sensors based on data threshold triggers, you will need to implement a method like [GetReadingsFromTriggerDetails](pedometer_getreadingsfromtriggerdetails.md). You will need to do this for every sensor you want to respond to the data threshold trigger. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sensors.SensorDataThresholdTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Sensors.SensorDataThresholdTriggerDetails + +## -description +Provides data for what sensor triggered the data threshold monitoring task. + +## -remarks +In order to support the background trigger of sensors based on data threshold triggers, you will need to implement a method like [GetReadingsFromTriggerDetails](pedometer_getreadingsfromtriggerdetails.md). You will need to do this for every sensor you want to respond to the data threshold trigger. + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensordatathresholdtriggerdetails_deviceid.md b/windows.devices.sensors/sensordatathresholdtriggerdetails_deviceid.md index d5acc3ebcd..688b21eee3 100644 --- a/windows.devices.sensors/sensordatathresholdtriggerdetails_deviceid.md +++ b/windows.devices.sensors/sensordatathresholdtriggerdetails_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.DeviceId ## -description Gets the device identifier for the device that activated the threshold trigger. ## -property-value The device identifier of the sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.DeviceId + +## -description +Gets the device identifier for the device that activated the threshold trigger. + +## -property-value +The device identifier of the sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensordatathresholdtriggerdetails_sensortype.md b/windows.devices.sensors/sensordatathresholdtriggerdetails_sensortype.md index 841ebd34ad..381fa04505 100644 --- a/windows.devices.sensors/sensordatathresholdtriggerdetails_sensortype.md +++ b/windows.devices.sensors/sensordatathresholdtriggerdetails_sensortype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.SensorType --api-type: winrt property ---- # Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.SensorType ## -description Gets the type of sensor associated with the threshold trigger. ## -property-value The type of sensor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.SensorType +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorDataThresholdTriggerDetails.SensorType + +## -description +Gets the type of sensor associated with the threshold trigger. + +## -property-value +The type of sensor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorquaternion_w.md b/windows.devices.sensors/sensorquaternion_w.md index c9e0506f28..fe6c38ebc0 100644 --- a/windows.devices.sensors/sensorquaternion_w.md +++ b/windows.devices.sensors/sensorquaternion_w.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorQuaternion.W --api-type: winrt property ---- # Windows.Devices.Sensors.SensorQuaternion.W ## -description Gets the w-value of the Quaternion. ## -property-value The w-value of the Quaternion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorQuaternion.W +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorQuaternion.W + +## -description +Gets the w-value of the Quaternion. + +## -property-value +The w-value of the Quaternion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorquaternion_x.md b/windows.devices.sensors/sensorquaternion_x.md index 986375f8c3..d2bad6e74e 100644 --- a/windows.devices.sensors/sensorquaternion_x.md +++ b/windows.devices.sensors/sensorquaternion_x.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorQuaternion.X --api-type: winrt property ---- # Windows.Devices.Sensors.SensorQuaternion.X ## -description Gets the x-value of the Quaternion. ## -property-value The x-value of the Quaternion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorQuaternion.X +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorQuaternion.X + +## -description +Gets the x-value of the Quaternion. + +## -property-value +The x-value of the Quaternion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorquaternion_y.md b/windows.devices.sensors/sensorquaternion_y.md index 1b82580e42..0120b2d23a 100644 --- a/windows.devices.sensors/sensorquaternion_y.md +++ b/windows.devices.sensors/sensorquaternion_y.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorQuaternion.Y --api-type: winrt property ---- # Windows.Devices.Sensors.SensorQuaternion.Y ## -description Gets the y-value of the Quaternion. ## -property-value The y-value of the Quaternion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorQuaternion.Y +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorQuaternion.Y + +## -description +Gets the y-value of the Quaternion. + +## -property-value +The y-value of the Quaternion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorquaternion_z.md b/windows.devices.sensors/sensorquaternion_z.md index 625dffc792..11a0946012 100644 --- a/windows.devices.sensors/sensorquaternion_z.md +++ b/windows.devices.sensors/sensorquaternion_z.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorQuaternion.Z --api-type: winrt property ---- # Windows.Devices.Sensors.SensorQuaternion.Z ## -description Gets the z-value of the Quaternion. ## -property-value The z-value of the Quaternion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorQuaternion.Z +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorQuaternion.Z + +## -description +Gets the z-value of the Quaternion. + +## -property-value +The z-value of the Quaternion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m11.md b/windows.devices.sensors/sensorrotationmatrix_m11.md index c0ace9a04b..8296bc0ae0 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m11.md +++ b/windows.devices.sensors/sensorrotationmatrix_m11.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M11 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M11 ## -description Gets the value at row 1, column 1 of the given rotation matrix. ## -property-value The value at row 1, column 1 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M11 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M11 + +## -description +Gets the value at row 1, column 1 of the given rotation matrix. + +## -property-value +The value at row 1, column 1 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m12.md b/windows.devices.sensors/sensorrotationmatrix_m12.md index 58d9d3e177..0b62369c16 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m12.md +++ b/windows.devices.sensors/sensorrotationmatrix_m12.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M12 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M12 ## -description Gets the value at row 1, column 2 of the given rotation matrix. ## -property-value The value at row 1, column 2 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M12 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M12 + +## -description +Gets the value at row 1, column 2 of the given rotation matrix. + +## -property-value +The value at row 1, column 2 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m13.md b/windows.devices.sensors/sensorrotationmatrix_m13.md index b111be727e..2d2bf4478a 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m13.md +++ b/windows.devices.sensors/sensorrotationmatrix_m13.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M13 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M13 ## -description Gets the value at row 1, column 3 of the given rotation matrix. ## -property-value The value at row 1, column 3 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M13 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M13 + +## -description +Gets the value at row 1, column 3 of the given rotation matrix. + +## -property-value +The value at row 1, column 3 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m21.md b/windows.devices.sensors/sensorrotationmatrix_m21.md index 75198f094a..5a4d0f4589 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m21.md +++ b/windows.devices.sensors/sensorrotationmatrix_m21.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M21 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M21 ## -description Gets the value at row 2, column 1 of the given rotation matrix. ## -property-value The value at row 2, column 1 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M21 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M21 + +## -description +Gets the value at row 2, column 1 of the given rotation matrix. + +## -property-value +The value at row 2, column 1 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m22.md b/windows.devices.sensors/sensorrotationmatrix_m22.md index ec3d9bd26a..87537406fb 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m22.md +++ b/windows.devices.sensors/sensorrotationmatrix_m22.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M22 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M22 ## -description Gets the value at row 2, column 2 of the given rotation matrix. ## -property-value The value at row 2, column 2 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M22 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M22 + +## -description +Gets the value at row 2, column 2 of the given rotation matrix. + +## -property-value +The value at row 2, column 2 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m23.md b/windows.devices.sensors/sensorrotationmatrix_m23.md index 06d2176922..50abaef252 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m23.md +++ b/windows.devices.sensors/sensorrotationmatrix_m23.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M23 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M23 ## -description Gets the value at row 2, column 3 of the given rotation matrix. ## -property-value The value at row 2, column 3 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M23 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M23 + +## -description +Gets the value at row 2, column 3 of the given rotation matrix. + +## -property-value +The value at row 2, column 3 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m31.md b/windows.devices.sensors/sensorrotationmatrix_m31.md index 53d763f466..6df5e755b6 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m31.md +++ b/windows.devices.sensors/sensorrotationmatrix_m31.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M31 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M31 ## -description Gets the value at row 3, column 1 of the given rotation matrix. ## -property-value The value at row 3, column 1 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M31 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M31 + +## -description +Gets the value at row 3, column 1 of the given rotation matrix. + +## -property-value +The value at row 3, column 1 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m32.md b/windows.devices.sensors/sensorrotationmatrix_m32.md index df0dd76bc6..a8ad1584c0 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m32.md +++ b/windows.devices.sensors/sensorrotationmatrix_m32.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M32 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M32 ## -description Gets the value at row 3, column 2 of the given rotation matrix. ## -property-value The value at row 3, column 2 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M32 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M32 + +## -description +Gets the value at row 3, column 2 of the given rotation matrix. + +## -property-value +The value at row 3, column 2 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/sensorrotationmatrix_m33.md b/windows.devices.sensors/sensorrotationmatrix_m33.md index 41b226b672..a41f6b3fe5 100644 --- a/windows.devices.sensors/sensorrotationmatrix_m33.md +++ b/windows.devices.sensors/sensorrotationmatrix_m33.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M33 --api-type: winrt property ---- # Windows.Devices.Sensors.SensorRotationMatrix.M33 ## -description Gets the value at row 3, column 3 of the given rotation matrix. ## -property-value The value at row 3, column 3 of the given rotation matrix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SensorRotationMatrix.M33 +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SensorRotationMatrix.M33 + +## -description +Gets the value at row 3, column 3 of the given rotation matrix. + +## -property-value +The value at row 3, column 3 of the given rotation matrix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensor_deviceid.md b/windows.devices.sensors/simpleorientationsensor_deviceid.md index b2b448e5b6..19a2b6bf37 100644 --- a/windows.devices.sensors/simpleorientationsensor_deviceid.md +++ b/windows.devices.sensors/simpleorientationsensor_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SimpleOrientationSensor.DeviceId --api-type: winrt property ---- # Windows.Devices.Sensors.SimpleOrientationSensor.DeviceId ## -description Gets the device identifier. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SimpleOrientationSensor.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensor.DeviceId + +## -description +Gets the device identifier. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensor_getcurrentorientation_1060648321.md b/windows.devices.sensors/simpleorientationsensor_getcurrentorientation_1060648321.md index 335c9e9128..60f4b83b03 100644 --- a/windows.devices.sensors/simpleorientationsensor_getcurrentorientation_1060648321.md +++ b/windows.devices.sensors/simpleorientationsensor_getcurrentorientation_1060648321.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.Devices.Sensors.SimpleOrientationSensor.GetCurrentOrientation --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.SimpleOrientationSensor.GetCurrentOrientation - -## -description -Gets the default simple orientation sensor. - -## -returns -The default simple orientation sensor. - -## -remarks -An application may use this method to poll the sensor for the current reading as an alternative to registering a [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. - -The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieved the current device orientation by using the simple orientation sensor. - - - -[!code-js[GetReadingJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario2.js#SnippetGetReadingJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.SimpleOrientationSensor.GetCurrentOrientation +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensor.GetCurrentOrientation + +## -description +Gets the default simple orientation sensor. + +## -returns +The default simple orientation sensor. + +## -remarks +An application may use this method to poll the sensor for the current reading as an alternative to registering a [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. + +The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieved the current device orientation by using the simple orientation sensor. + + + +[!code-js[GetReadingJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario2.js#SnippetGetReadingJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensor_getdefault_846721868.md b/windows.devices.sensors/simpleorientationsensor_getdefault_846721868.md index 0efe72e8da..52220b0a3c 100644 --- a/windows.devices.sensors/simpleorientationsensor_getdefault_846721868.md +++ b/windows.devices.sensors/simpleorientationsensor_getdefault_846721868.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.Devices.Sensors.SimpleOrientationSensor.GetDefault --api-type: winrt method ---- - - - -# Windows.Devices.Sensors.SimpleOrientationSensor.GetDefault - -## -description -Gets the default simple orientation sensor. - -## -returns -The default simple orientation sensor or null if no simple orientation sensors are found. - -## -remarks -This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The simple orientation-sensor readings are derived from an accelerometer.) A null value will be returned if the specified sensor is not available in the system. - -When a system is in Connected Standby, a call to the [GetDefault](simpleorientationsensor_getdefault.md) method will return immediately with a null result. - -The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the simple orientation sensor. - - - -[!code-cs[GetDefaultCS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] - -The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the simple orientation sensor. - - - -[!code-js[GetDefaultJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario1.js#SnippetGetDefaultJS)] - -## -examples - -## -see-also +--- +-api-id: M:Windows.Devices.Sensors.SimpleOrientationSensor.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensor.GetDefault + +## -description +Gets the default simple orientation sensor. + +## -returns +The default simple orientation sensor or null if no simple orientation sensors are found. + +## -remarks +This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The simple orientation-sensor readings are derived from an accelerometer.) A null value will be returned if the specified sensor is not available in the system. + +When a system is in Connected Standby, a call to the [GetDefault](simpleorientationsensor_getdefault.md) method will return immediately with a null result. + +The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the simple orientation sensor. + + + +[!code-cs[GetDefaultCS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetGetDefaultCS)] + +The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the simple orientation sensor. + + + +[!code-js[GetDefaultJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario1.js#SnippetGetDefaultJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensor_orientationchanged.md b/windows.devices.sensors/simpleorientationsensor_orientationchanged.md index f0f3154b5a..60ac4a0551 100644 --- a/windows.devices.sensors/simpleorientationsensor_orientationchanged.md +++ b/windows.devices.sensors/simpleorientationsensor_orientationchanged.md @@ -1,46 +1,46 @@ ---- --api-id: E:Windows.Devices.Sensors.SimpleOrientationSensor.OrientationChanged --api-type: winrt event ---- - - - -# Windows.Devices.Sensors.SimpleOrientationSensor.OrientationChanged - -## -description -Occurs each time the simple orientation sensor reports a new sensor reading - -## -remarks -The following example demonstrates how a Windows Store app built with C# and XAML registers its [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. - - - -[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] - -The following example demonstrates how a Windows Store app built with XAML registers an [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. - - - -[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] - - - -[!code-cs[ReadingChanged2CS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetReadingChanged2CS)] - -The following example demonstrates how a Windows Store app built with JavaScript registers its [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. - - - -[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario1.js#SnippetEnableReadingChangedJS)] - -The following example shows the [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. - - - -[!code-js[onDataChangedJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario1.js#SnippetonDataChangedJS)] - -## -examples - -## -see-also +--- +-api-id: E:Windows.Devices.Sensors.SimpleOrientationSensor.OrientationChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensor.OrientationChanged + +## -description +Occurs each time the simple orientation sensor reports a new sensor reading + +## -remarks +The following example demonstrates how a Windows Store app built with C# and XAML registers its [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. + + + +[!code-cs[EnableReadingChangedCS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetEnableReadingChangedCS)] + +The following example demonstrates how a Windows Store app built with XAML registers an [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. + + + +[!code-cs[ReadingChangedCS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetReadingChangedCS)] + + + +[!code-cs[ReadingChanged2CS](../windows.devices.sensors/code/simpleorientation/csharp/Scenario1.xaml.cs#SnippetReadingChanged2CS)] + +The following example demonstrates how a Windows Store app built with JavaScript registers its [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. + + + +[!code-js[EnableReadingChangedJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario1.js#SnippetEnableReadingChangedJS)] + +The following example shows the [OrientationChanged](simpleorientationsensor_orientationchanged.md) event handler. + + + +[!code-js[onDataChangedJS](../windows.devices.sensors/code/simpleorientation/javascript/scenario1.js#SnippetonDataChangedJS)] + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensor_readingtransform.md b/windows.devices.sensors/simpleorientationsensor_readingtransform.md index e9ea013eb7..000088e13e 100644 --- a/windows.devices.sensors/simpleorientationsensor_readingtransform.md +++ b/windows.devices.sensors/simpleorientationsensor_readingtransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SimpleOrientationSensor.ReadingTransform --api-type: winrt property ---- # Windows.Devices.Sensors.SimpleOrientationSensor.ReadingTransform ## -description Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. ## -property-value A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SimpleOrientationSensor.ReadingTransform +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensor.ReadingTransform + +## -description +Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data. + +## -property-value +A [DisplayOrientations](../windows.graphics.display/displayorientations.md)-typed value that specifies the display orientation with which to align the sensor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_orientation.md b/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_orientation.md index fa58d04683..d3ee459752 100644 --- a/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_orientation.md +++ b/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Orientation --api-type: winrt property ---- # Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Orientation ## -description Gets the current sensor orientation. ## -property-value The current sensor orientation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Orientation +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Orientation + +## -description +Gets the current sensor orientation. + +## -property-value +The current sensor orientation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_timestamp.md b/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_timestamp.md index d9c2fab6bb..085768258f 100644 --- a/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_timestamp.md +++ b/windows.devices.sensors/simpleorientationsensororientationchangedeventargs_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Timestamp --api-type: winrt property ---- # Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Timestamp ## -description Gets the time of the current sensor reading. ## -property-value The time of the current sensor reading. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.SimpleOrientationSensorOrientationChangedEventArgs.Timestamp + +## -description +Gets the time of the current sensor reading. + +## -property-value +The time of the current sensor reading. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/errorreceivedeventargs.md b/windows.devices.serialcommunication/errorreceivedeventargs.md index 5edb57e175..c3a9305595 100644 --- a/windows.devices.serialcommunication/errorreceivedeventargs.md +++ b/windows.devices.serialcommunication/errorreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SerialCommunication.ErrorReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.SerialCommunication.ErrorReceivedEventArgs ## -description Represents the object that is passed as a parameter to the event handler that is invoked when error occurs on the serial port. ## -remarks [ErrorReceivedEventArgs](errorreceivedeventargs.md) is used to determine the type of error condition. When error occurs on the port, the previously registered [ErrorReceived](serialdevice_errorreceived.md) event handler is invoked. That event handler's parameter is a [ErrorReceivedEventArgs](errorreceivedeventargs.md) object. After the event handler is invoked, you can determine the error condition by using the [Error](serialerror.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.SerialCommunication.ErrorReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.SerialCommunication.ErrorReceivedEventArgs + +## -description +Represents the object that is passed as a parameter to the event handler that is invoked when error occurs on the serial port. + +## -remarks +[ErrorReceivedEventArgs](errorreceivedeventargs.md) is used to determine the type of error condition. When error occurs on the port, the previously registered [ErrorReceived](serialdevice_errorreceived.md) event handler is invoked. That event handler's parameter is a [ErrorReceivedEventArgs](errorreceivedeventargs.md) object. After the event handler is invoked, you can determine the error condition by using the [Error](serialerror.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/errorreceivedeventargs_error.md b/windows.devices.serialcommunication/errorreceivedeventargs_error.md index aaa268e970..c74cbc84fb 100644 --- a/windows.devices.serialcommunication/errorreceivedeventargs_error.md +++ b/windows.devices.serialcommunication/errorreceivedeventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.ErrorReceivedEventArgs.Error --api-type: winrt property ---- # Windows.Devices.SerialCommunication.ErrorReceivedEventArgs.Error ## -description Gets the character type received that caused the event on the serial port. ## -property-value One of the values defined in the [SerialError](serialerror.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.ErrorReceivedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.ErrorReceivedEventArgs.Error + +## -description +Gets the character type received that caused the event on the serial port. + +## -property-value +One of the values defined in the [SerialError](serialerror.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/pinchangedeventargs.md b/windows.devices.serialcommunication/pinchangedeventargs.md index 16aa440300..445899f495 100644 --- a/windows.devices.serialcommunication/pinchangedeventargs.md +++ b/windows.devices.serialcommunication/pinchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SerialCommunication.PinChangedEventArgs --api-type: winrt class ---- # Windows.Devices.SerialCommunication.PinChangedEventArgs ## -description Represents the object that is passed as a parameter to the event handler that is invoked when the state of a signal line changes on the serial port. ## -remarks At times, the state of a signal line can change on the serial port. For example, when the break state is enabled on the serial port causing data transmission to stop. The event is reported by invoking the app-implemented [PinChanged](serialdevice_pinchanged.md) event handler. That event handler's parameter is a [PinChangedEventArgs](pinchangedeventargs.md) object. Inspect the [PinChange](pinchangedeventargs_pinchange.md) property to determine the type of signal line. Those values are defined in the [SerialPinChange](serialpinchange.md) enumeration. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.SerialCommunication.PinChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.SerialCommunication.PinChangedEventArgs + +## -description +Represents the object that is passed as a parameter to the event handler that is invoked when the state of a signal line changes on the serial port. + +## -remarks +At times, the state of a signal line can change on the serial port. For example, when the break state is enabled on the serial port causing data transmission to stop. The event is reported by invoking the app-implemented [PinChanged](serialdevice_pinchanged.md) event handler. That event handler's parameter is a [PinChangedEventArgs](pinchangedeventargs.md) object. Inspect the [PinChange](pinchangedeventargs_pinchange.md) property to determine the type of signal line. Those values are defined in the [SerialPinChange](serialpinchange.md) enumeration. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/pinchangedeventargs_pinchange.md b/windows.devices.serialcommunication/pinchangedeventargs_pinchange.md index 89d38c1518..4f1fcc0c62 100644 --- a/windows.devices.serialcommunication/pinchangedeventargs_pinchange.md +++ b/windows.devices.serialcommunication/pinchangedeventargs_pinchange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.PinChangedEventArgs.PinChange --api-type: winrt property ---- # Windows.Devices.SerialCommunication.PinChangedEventArgs.PinChange ## -description Gets the type of signal change that caused the event on the serial port. ## -property-value One of the values defined in [SerialPinChange](serialpinchange.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.PinChangedEventArgs.PinChange +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.PinChangedEventArgs.PinChange + +## -description +Gets the type of signal change that caused the event on the serial port. + +## -property-value +One of the values defined in [SerialPinChange](serialpinchange.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice.md b/windows.devices.serialcommunication/serialdevice.md index 9f7e1e16c2..4135ce94ed 100644 --- a/windows.devices.serialcommunication/serialdevice.md +++ b/windows.devices.serialcommunication/serialdevice.md @@ -1,3 +1,50 @@ ---- -api-id: T:Windows.Devices.SerialCommunication.SerialDevice --api-type: winrt class ---- # Windows.Devices.SerialCommunication.SerialDevice ## -description Represents a serial port. The object provides methods and properties that an app can use to find the port (in the system). ## -remarks The serial device capability, [<DeviceCapability>](http://msdn.microsoft.com/library/4353c4fd-f038-4986-81ed-d2ec0c6235ef), is required to use the [SerialDevice](serialdevice.md) class. For more info, see [Windows.Devices.SerialCommunication](windows_devices_serialcommunication.md). **Create a SerialDevice object** 1. Get this information about the serial port.+ The COM port name that represents the serial port, such as "COM1". In Device Manager, open **Ports (COM & LPT)**, the device node string indicates the port number. + If you are using a Serial-to-USB converter, the virtual COM port name such as "COM1" or the vendor and product identifiers of the converter. You can derive the identifiers from the **Hardware Ids** property in Device Manager. For example, if **Hardware Id** is "USB\VID_045E&PID_078E", vendor ID is "0x045E" and product Id is "0x078E". 1. Generate an Advanced Query Syntax (AQS) string that contains search criteria for finding the device in the enumerated device collection. If you have the vendor and product identifiers, call [GetDeviceSelectorFromUsbVidPid](serialdevice_getdeviceselectorfromusbvidpid.md). 1. Pass the retrieved string to [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). The call retrieves a [DeviceInformationCollection](../windows.devices.enumeration/deviceinformationcollection.md) object. 1. Loop through the collection. Each iteration gets a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object. 1. Get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. The string value is the device instance path. For example, PCI#VEN_9710&DEV_9835&SUBSYS_00011000&REV_01\5&338FDA70&0&20F0#CHILD0000. 1. Call [FromIdAsync](serialdevice_fromidasync.md) by passing the device instance string and get the [SerialDevice](serialdevice.md) object. **Read and write data** You can then use the [SerialDevice](serialdevice.md) object to read from or write to the serial port by using the [Windows.Storage.Streams](../windows.storage.streams/windows_storage_streams.md) namespace. 1. Obtain a reference to the input stream by getting the [SerialDevice.InputStream](serialdevice_inputstream.md) property. 1. Create a [DataReader](../windows.storage.streams/datareader.md) object by specifying the input stream in the [DataReader](../windows.storage.streams/datareader_datareader.md) constructor. 1. Obtain a reference to the output stream by getting the [SerialDevice.OutputStream](serialdevice_outputstream.md) property. 1. Create a [DataWriter](../windows.storage.streams/datawriter.md) object by specifying the output stream in the [DataWriter](../windows.storage.streams/datawriter_datawriter.md) constructor. **Release the SerialDevice object** After you are finished using the [SerialDevice](serialdevice.md) object, release it. C++ apps must release the reference by using the delete keyword. C#/VB apps must call the SerialDevice.Dispose method. JavaScript apps must call [SerialDevice.Close](serialdevice_close.md). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SerialCommunication.SerialDevice +-api-type: winrt class +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice + +## -description +Represents a serial port. The object provides methods and properties that an app can use to find the port (in the system). + +## -remarks +The serial device capability, [<DeviceCapability>](http://msdn.microsoft.com/library/4353c4fd-f038-4986-81ed-d2ec0c6235ef), is required to use the [SerialDevice](serialdevice.md) class. For more info, see [Windows.Devices.SerialCommunication](windows_devices_serialcommunication.md). + + +**Create a SerialDevice object** + +1. Get this information about the serial port.+ The COM port name that represents the serial port, such as "COM1". In Device Manager, open **Ports (COM & LPT)**, the device node string indicates the port number. ++ If you are using a Serial-to-USB converter, the virtual COM port name such as "COM1" or the vendor and product identifiers of the converter. You can derive the identifiers from the **Hardware Ids** property in Device Manager. For example, if **Hardware Id** is "USB\VID_045E&PID_078E", vendor ID is "0x045E" and product Id is "0x078E". + +1. Generate an Advanced Query Syntax (AQS) string that contains search criteria for finding the device in the enumerated device collection. If you have the vendor and product identifiers, call [GetDeviceSelectorFromUsbVidPid](serialdevice_getdeviceselectorfromusbvidpid.md). +1. Pass the retrieved string to [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). The call retrieves a [DeviceInformationCollection](../windows.devices.enumeration/deviceinformationcollection.md) object. +1. Loop through the collection. Each iteration gets a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object. +1. Get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. The string value is the device instance path. For example, PCI#VEN_9710&DEV_9835&SUBSYS_00011000&REV_01\5&338FDA70&0&20F0#CHILD0000. +1. Call [FromIdAsync](serialdevice_fromidasync.md) by passing the device instance string and get the [SerialDevice](serialdevice.md) object. + + +**Read and write data** + +You can then use the [SerialDevice](serialdevice.md) object to read from or write to the serial port by using the [Windows.Storage.Streams](../windows.storage.streams/windows_storage_streams.md) namespace. +1. Obtain a reference to the input stream by getting the [SerialDevice.InputStream](serialdevice_inputstream.md) property. +1. Create a [DataReader](../windows.storage.streams/datareader.md) object by specifying the input stream in the [DataReader](../windows.storage.streams/datareader_datareader.md) constructor. + +1. Obtain a reference to the output stream by getting the [SerialDevice.OutputStream](serialdevice_outputstream.md) property. +1. Create a [DataWriter](../windows.storage.streams/datawriter.md) object by specifying the output stream in the [DataWriter](../windows.storage.streams/datawriter_datawriter.md) constructor. + + +**Release the SerialDevice object** + +After you are finished using the [SerialDevice](serialdevice.md) object, release it. + +C++ apps must release the reference by using the delete keyword. C#/VB apps must call the SerialDevice.Dispose method. JavaScript apps must call [SerialDevice.Close](serialdevice_close.md). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.serialcommunication/serialdevice_baudrate.md b/windows.devices.serialcommunication/serialdevice_baudrate.md index 34fd761627..c78c41ed04 100644 --- a/windows.devices.serialcommunication/serialdevice_baudrate.md +++ b/windows.devices.serialcommunication/serialdevice_baudrate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.BaudRate --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.BaudRate ## -description Gets or sets the baud rate. ## -property-value The baud rate of the serial port. ## -remarks The property is set on the [SerialDevice](serialdevice.md) object that represents the serial port. The baud rate must be supported by the serial port. To see the possible values, in Device Manager, open the **Port Settings** tab of the COM port. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.BaudRate +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.BaudRate + +## -description +Gets or sets the baud rate. + +## -property-value +The baud rate of the serial port. + +## -remarks +The property is set on the [SerialDevice](serialdevice.md) object that represents the serial port. The baud rate must be supported by the serial port. To see the possible values, in Device Manager, open the **Port Settings** tab of the COM port. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_breaksignalstate.md b/windows.devices.serialcommunication/serialdevice_breaksignalstate.md index 4a79ad76dd..3fedb44328 100644 --- a/windows.devices.serialcommunication/serialdevice_breaksignalstate.md +++ b/windows.devices.serialcommunication/serialdevice_breaksignalstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.BreakSignalState --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.BreakSignalState ## -description Gets or sets the break signal state. ## -property-value Toggles the TX line to enable or disable data transmission. ## -remarks In serial communication, the break signal state is used to toggle the TX line. To suspend data transmission, set the property value to **true**. In that state, you cannot write to the serial port. To resume transmission, set to **false**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.BreakSignalState +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.BreakSignalState + +## -description +Gets or sets the break signal state. + +## -property-value +Toggles the TX line to enable or disable data transmission. + +## -remarks +In serial communication, the break signal state is used to toggle the TX line. To suspend data transmission, set the property value to **true**. In that state, you cannot write to the serial port. To resume transmission, set to **false**. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_bytesreceived.md b/windows.devices.serialcommunication/serialdevice_bytesreceived.md index b26d2cf231..938e6cc3d0 100644 --- a/windows.devices.serialcommunication/serialdevice_bytesreceived.md +++ b/windows.devices.serialcommunication/serialdevice_bytesreceived.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.BytesReceived --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.BytesReceived ## -description Represents the number of bytes received by the last read operation of the input stream. ## -property-value The number of bytes received by the last read operation of the input stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.BytesReceived +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.BytesReceived + +## -description +Represents the number of bytes received by the last read operation of the input stream. + +## -property-value +The number of bytes received by the last read operation of the input stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_carrierdetectstate.md b/windows.devices.serialcommunication/serialdevice_carrierdetectstate.md index 0510d6d030..44d8f7da54 100644 --- a/windows.devices.serialcommunication/serialdevice_carrierdetectstate.md +++ b/windows.devices.serialcommunication/serialdevice_carrierdetectstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.CarrierDetectState --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.CarrierDetectState ## -description Gets the state of the Carrier Detect (CD) line. ## -property-value Detects the state of Carrier Detect line. If the line is detected, value is **true**; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.CarrierDetectState +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.CarrierDetectState + +## -description +Gets the state of the Carrier Detect (CD) line. + +## -property-value +Detects the state of Carrier Detect line. If the line is detected, value is **true**; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_cleartosendstate.md b/windows.devices.serialcommunication/serialdevice_cleartosendstate.md index df5b9d8972..214b801757 100644 --- a/windows.devices.serialcommunication/serialdevice_cleartosendstate.md +++ b/windows.devices.serialcommunication/serialdevice_cleartosendstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.ClearToSendState --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.ClearToSendState ## -description Gets the state of the Clear-to-Send (CTS) line. ## -property-value Detects the state of Clear-to-Send line. If the line is detected, value is **true**; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.ClearToSendState +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.ClearToSendState + +## -description +Gets the state of the Clear-to-Send (CTS) line. + +## -property-value +Detects the state of Clear-to-Send line. If the line is detected, value is **true**; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_close_811482585.md b/windows.devices.serialcommunication/serialdevice_close_811482585.md index 8f4802d1f7..8a6f77c706 100644 --- a/windows.devices.serialcommunication/serialdevice_close_811482585.md +++ b/windows.devices.serialcommunication/serialdevice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.SerialCommunication.SerialDevice.Close --api-type: winrt method ---- # Windows.Devices.SerialCommunication.SerialDevice.Close ## -description Releases the reference to the [SerialDevice](serialdevice.md) object that was previously obtained by calling [FromIdAsync](serialdevice_fromidasync.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.SerialCommunication.SerialDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.Close + +## -description +Releases the reference to the [SerialDevice](serialdevice.md) object that was previously obtained by calling [FromIdAsync](serialdevice_fromidasync.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_databits.md b/windows.devices.serialcommunication/serialdevice_databits.md index 0593fcda41..e819f07c01 100644 --- a/windows.devices.serialcommunication/serialdevice_databits.md +++ b/windows.devices.serialcommunication/serialdevice_databits.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.DataBits --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.DataBits ## -description The number of data bits in each character value that is transmitted or received, and does not include parity bits or stop bits. ## -property-value The number of data bits in each character value that is transmitted or received. ## -remarks [DataBits](serialdevice_databits.md) corresponds to the **WordLength** member of the [SERIAL_LINE_CONTROL](XREF:TODO:serports.serial_line_control) structure. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.DataBits +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.DataBits + +## -description +The number of data bits in each character value that is transmitted or received, and does not include parity bits or stop bits. + +## -property-value +The number of data bits in each character value that is transmitted or received. + +## -remarks +[DataBits](serialdevice_databits.md) corresponds to the **WordLength** member of the [SERIAL_LINE_CONTROL](XREF:TODO:serports.serial_line_control) structure. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_datasetreadystate.md b/windows.devices.serialcommunication/serialdevice_datasetreadystate.md index 0d06da28fd..6127bf2ce2 100644 --- a/windows.devices.serialcommunication/serialdevice_datasetreadystate.md +++ b/windows.devices.serialcommunication/serialdevice_datasetreadystate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.DataSetReadyState --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.DataSetReadyState ## -description Gets the state of the Data Set Ready (DSR) signal. ## -property-value Indicates whether DSR has been sent to the serial port. If the signal was sent, value is **true**; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.DataSetReadyState +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.DataSetReadyState + +## -description +Gets the state of the Data Set Ready (DSR) signal. + +## -property-value +Indicates whether DSR has been sent to the serial port. If the signal was sent, value is **true**; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_errorreceived.md b/windows.devices.serialcommunication/serialdevice_errorreceived.md index db9c7cb252..54b73df98d 100644 --- a/windows.devices.serialcommunication/serialdevice_errorreceived.md +++ b/windows.devices.serialcommunication/serialdevice_errorreceived.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.SerialCommunication.SerialDevice.ErrorReceived --api-type: winrt event ---- # Windows.Devices.SerialCommunication.SerialDevice.ErrorReceived ## -description Event handler that is invoked when error occurs on the serial port. ## -remarks This event is used to detect and respond to errors when communicating data through a serial port. When an error condition occurs, the [ErrorReceived](serialdevice_errorreceived.md) event handler is invoked and error information is received in an [ErrorReceivedEventArgs](errorreceivedeventargs.md) object. Determine the type of error by retrieving the [Error](errorreceivedeventargs_error.md) property of the [ErrorReceivedEventArgs](errorreceivedeventargs.md) class. Those property values are defined in the [SerialError](serialerror.md) enumeration. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.SerialCommunication.SerialDevice.ErrorReceived +-api-type: winrt event +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.ErrorReceived + +## -description +Event handler that is invoked when error occurs on the serial port. + +## -remarks +This event is used to detect and respond to errors when communicating data through a serial port. When an error condition occurs, the [ErrorReceived](serialdevice_errorreceived.md) event handler is invoked and error information is received in an [ErrorReceivedEventArgs](errorreceivedeventargs.md) object. Determine the type of error by retrieving the [Error](errorreceivedeventargs_error.md) property of the [ErrorReceivedEventArgs](errorreceivedeventargs.md) class. Those property values are defined in the [SerialError](serialerror.md) enumeration. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_fromidasync_1322863552.md b/windows.devices.serialcommunication/serialdevice_fromidasync_1322863552.md index d4e3a17884..5da714eed1 100644 --- a/windows.devices.serialcommunication/serialdevice_fromidasync_1322863552.md +++ b/windows.devices.serialcommunication/serialdevice_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.SerialCommunication.SerialDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.SerialCommunication.SerialDevice.FromIdAsync ## -description Starts an asynchronous operation that creates a [SerialDevice](serialdevice.md) object. ## -parameters ### -param deviceId The device instance path of the device. To obtain that value, get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. ## -returns Returns an [IAsyncOperation(SerialDevice)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.SerialCommunication.SerialDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.FromIdAsync + +## -description +Starts an asynchronous operation that creates a [SerialDevice](serialdevice.md) object. + +## -parameters +### -param deviceId +The device instance path of the device. To obtain that value, get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. + +## -returns +Returns an [IAsyncOperation(SerialDevice)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_getdeviceselector_1752695616.md b/windows.devices.serialcommunication/serialdevice_getdeviceselector_1752695616.md index 0ee6ed4c3e..51bf4d6d90 100644 --- a/windows.devices.serialcommunication/serialdevice_getdeviceselector_1752695616.md +++ b/windows.devices.serialcommunication/serialdevice_getdeviceselector_1752695616.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector(System.String) --api-type: winrt method ---- # Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a serial device by specifying its port name. ## -parameters ### -param portName The serial port name. For example, "COM1". ## -returns String formatted as an AQS query. ## -remarks ## -examples ## -see-also [GetDeviceSelector](serialdevice_getdeviceselector_838466080.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a serial device by specifying its port name. + +## -parameters +### -param portName +The serial port name. For example, "COM1". + +## -returns +String formatted as an AQS query. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector](serialdevice_getdeviceselector_838466080.md) \ No newline at end of file diff --git a/windows.devices.serialcommunication/serialdevice_getdeviceselector_838466080.md b/windows.devices.serialcommunication/serialdevice_getdeviceselector_838466080.md index f1066f06ea..b407fd0f46 100644 --- a/windows.devices.serialcommunication/serialdevice_getdeviceselector_838466080.md +++ b/windows.devices.serialcommunication/serialdevice_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find all serial devices on the system. ## -returns String formatted as an AQS query. ## -remarks ## -examples ## -see-also [GetDeviceSelector(String)](serialdevice_getdeviceselector_1752695616.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find all serial devices on the system. + +## -returns +String formatted as an AQS query. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(String)](serialdevice_getdeviceselector_1752695616.md) \ No newline at end of file diff --git a/windows.devices.serialcommunication/serialdevice_getdeviceselectorfromusbvidpid_2128196110.md b/windows.devices.serialcommunication/serialdevice_getdeviceselectorfromusbvidpid_2128196110.md index 8c4d96504f..fc48e8596f 100644 --- a/windows.devices.serialcommunication/serialdevice_getdeviceselectorfromusbvidpid_2128196110.md +++ b/windows.devices.serialcommunication/serialdevice_getdeviceselectorfromusbvidpid_2128196110.md @@ -1,3 +1,58 @@ ---- -api-id: M:Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelectorFromUsbVidPid(System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelectorFromUsbVidPid ## -description Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific Serial-to-USB device by specifying it's VID and PID. ## -parameters ### -param vendorId Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. ### -param productId Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. ## -returns String formatted as an AQS query. ## -remarks ## -examples This example code shows how to get the [SerialDevice](serialdevice.md) object by specifying the vendor/product Id of the Serial-to-USB device. ```csharp protected override async void OnLaunched1(LaunchActivatedEventArgs args) { UInt32 vid = 0x045E; UInt32 pid = 0x078F; string aqs = SerialDevice.GetDeviceSelectorFromUsbVidPid(vid, pid); var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(aqs, null); if (myDevices.Count == 0) { ShowError("Device not found!"); return; } SerialDevice device = await SerialDevice.FromIdAsync(myDevices[0].Id); } ``` ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelectorFromUsbVidPid(System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.GetDeviceSelectorFromUsbVidPid + +## -description +Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific Serial-to-USB device by specifying it's VID and PID. + +## -parameters +### -param vendorId +Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. + +### -param productId +Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. + +## -returns +String formatted as an AQS query. + +## -remarks + +## -examples +This example code shows how to get the [SerialDevice](serialdevice.md) object by specifying the vendor/product Id of the Serial-to-USB device. + +```csharp + + +protected override async void OnLaunched1(LaunchActivatedEventArgs args) +{ + UInt32 vid = 0x045E; + UInt32 pid = 0x078F; + + string aqs = SerialDevice.GetDeviceSelectorFromUsbVidPid(vid, pid); + + var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(aqs, null); + + if (myDevices.Count == 0) + { + ShowError("Device not found!"); + return; + } + + SerialDevice device = await SerialDevice.FromIdAsync(myDevices[0].Id); + +} + + + +``` + + + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_handshake.md b/windows.devices.serialcommunication/serialdevice_handshake.md index 118eb3a21a..923cc80f92 100644 --- a/windows.devices.serialcommunication/serialdevice_handshake.md +++ b/windows.devices.serialcommunication/serialdevice_handshake.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.Handshake --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.Handshake ## -description Gets or sets the handshaking protocol for flow control. ## -property-value One of the values defined in [SerialHandshake](serialhandshake.md) enumeration. ## -remarks The handshaking protocol is used by the serial port to establish flow control between the port and the connected device. There are two types of control protocol. + Hardware control: The Request-to-Send (RTS) line is set to false when the receiver's buffer is full. This indicates to the sender that it must stop sending data. When the buffer is able to hold data, the RTS line is set to true that indicates to the send that it is now ready to receive data again. + Software control: The receiver sends an Xoff control code to the sender to stop transmission of data. When the receiver is ready, it sends the Xon code and the sender resumes data transmission. The [SerialHandshake](serialhandshake.md) enumeration defines the preceding control type values. You can set hardware, software, or both types of control protocol. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.Handshake +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.Handshake + +## -description +Gets or sets the handshaking protocol for flow control. + +## -property-value +One of the values defined in [SerialHandshake](serialhandshake.md) enumeration. + +## -remarks +The handshaking protocol is used by the serial port to establish flow control between the port and the connected device. There are two types of control protocol. + + ++ Hardware control: The Request-to-Send (RTS) line is set to false when the receiver's buffer is full. This indicates to the sender that it must stop sending data. When the buffer is able to hold data, the RTS line is set to true that indicates to the send that it is now ready to receive data again. ++ Software control: The receiver sends an Xoff control code to the sender to stop transmission of data. When the receiver is ready, it sends the Xon code and the sender resumes data transmission. + The [SerialHandshake](serialhandshake.md) enumeration defines the preceding control type values. + +You can set hardware, software, or both types of control protocol. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_inputstream.md b/windows.devices.serialcommunication/serialdevice_inputstream.md index d0a19edb51..9ee8d73d5e 100644 --- a/windows.devices.serialcommunication/serialdevice_inputstream.md +++ b/windows.devices.serialcommunication/serialdevice_inputstream.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.InputStream --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.InputStream ## -description Input stream that contains the data received on the serial port. ## -property-value Input stream that contains the data received ## -remarks To access data received on the port, get the input stream from [SerialDevice](serialdevice.md) object, and then use the [DataReader](../windows.storage.streams/datareader.md) to read data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.InputStream +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.InputStream + +## -description +Input stream that contains the data received on the serial port. + +## -property-value +Input stream that contains the data received + +## -remarks +To access data received on the port, get the input stream from [SerialDevice](serialdevice.md) object, and then use the [DataReader](../windows.storage.streams/datareader.md) to read data. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_isdataterminalreadyenabled.md b/windows.devices.serialcommunication/serialdevice_isdataterminalreadyenabled.md index 43b2ba173e..fe7e991af0 100644 --- a/windows.devices.serialcommunication/serialdevice_isdataterminalreadyenabled.md +++ b/windows.devices.serialcommunication/serialdevice_isdataterminalreadyenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.IsDataTerminalReadyEnabled --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.IsDataTerminalReadyEnabled ## -description Gets or sets a value that enables the Data Terminal Ready (DTR) signal. ## -property-value Enables or disables the Data Terminal Ready (DTR) signal. **true** enables DTR; Otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.IsDataTerminalReadyEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.IsDataTerminalReadyEnabled + +## -description +Gets or sets a value that enables the Data Terminal Ready (DTR) signal. + +## -property-value +Enables or disables the Data Terminal Ready (DTR) signal. **true** enables DTR; Otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_isrequesttosendenabled.md b/windows.devices.serialcommunication/serialdevice_isrequesttosendenabled.md index 351e56088f..1648287f71 100644 --- a/windows.devices.serialcommunication/serialdevice_isrequesttosendenabled.md +++ b/windows.devices.serialcommunication/serialdevice_isrequesttosendenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.IsRequestToSendEnabled --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.IsRequestToSendEnabled ## -description Gets or sets a value that enables the Request to Send (RTS) signal. ## -property-value Enables or disables the Request to Send (RTS) signal. **true** enables DTR; Otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.IsRequestToSendEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.IsRequestToSendEnabled + +## -description +Gets or sets a value that enables the Request to Send (RTS) signal. + +## -property-value +Enables or disables the Request to Send (RTS) signal. **true** enables DTR; Otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_outputstream.md b/windows.devices.serialcommunication/serialdevice_outputstream.md index 76d919934d..d5d6862f8c 100644 --- a/windows.devices.serialcommunication/serialdevice_outputstream.md +++ b/windows.devices.serialcommunication/serialdevice_outputstream.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.OutputStream --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.OutputStream ## -description Gets an output stream to which the app can write data to transmit through the serial port. ## -property-value The output steam that contains the transfer data. ## -remarks To write data, first get the output stream from the [SerialDevice](serialdevice.md) object by using [OutputStream](serialdevice_outputstream.md) property and then use the [DataWriter](../windows.storage.streams/datawriter.md) object to write the actual buffer. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.OutputStream +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.OutputStream + +## -description +Gets an output stream to which the app can write data to transmit through the serial port. + +## -property-value +The output steam that contains the transfer data. + +## -remarks +To write data, first get the output stream from the [SerialDevice](serialdevice.md) object by using [OutputStream](serialdevice_outputstream.md) property and then use the [DataWriter](../windows.storage.streams/datawriter.md) object to write the actual buffer. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_parity.md b/windows.devices.serialcommunication/serialdevice_parity.md index 101bf728f2..5134e37b9c 100644 --- a/windows.devices.serialcommunication/serialdevice_parity.md +++ b/windows.devices.serialcommunication/serialdevice_parity.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.Parity --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.Parity ## -description Gets or sets the parity bit for error-checking. ## -property-value One of the values defined in [SerialParity](serialparity.md) enumeration. ## -remarks In serial communication, the parity bit is used as an error-checking procedure. In data transmission that uses parity checking, the bit format is 7 data bits-*x*-1 stop bit, where *x* is the parity bit. That bit indicates whether the number of 1s in the data byte is even or odd. The parity bit can be E (even), O (odd), M (mark), or S (space). Those values are defined in the [SerialParity](serialparity.md) enumeration. For example, if the format is 7-E-1 and the data bits are 0001000, the parity bit is set to 1 to make sure there are even number of 1s. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.Parity +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.Parity + +## -description +Gets or sets the parity bit for error-checking. + +## -property-value +One of the values defined in [SerialParity](serialparity.md) enumeration. + +## -remarks +In serial communication, the parity bit is used as an error-checking procedure. In data transmission that uses parity checking, the bit format is 7 data bits-*x*-1 stop bit, where *x* is the parity bit. That bit indicates whether the number of 1s in the data byte is even or odd. The parity bit can be E (even), O (odd), M (mark), or S (space). Those values are defined in the [SerialParity](serialparity.md) enumeration. + +For example, if the format is 7-E-1 and the data bits are 0001000, the parity bit is set to 1 to make sure there are even number of 1s. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_pinchanged.md b/windows.devices.serialcommunication/serialdevice_pinchanged.md index e725a524ad..d9da1951d5 100644 --- a/windows.devices.serialcommunication/serialdevice_pinchanged.md +++ b/windows.devices.serialcommunication/serialdevice_pinchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.SerialCommunication.SerialDevice.PinChanged --api-type: winrt event ---- # Windows.Devices.SerialCommunication.SerialDevice.PinChanged ## -description Event handler that is invoked when the state of a signal or line changes on the serial port. ## -remarks This event is used to detect and respond to changes in the signal state of the serial port. When state changes, the [PinChanged](serialdevice_pinchanged.md) event handler is invoked and information is received in a [PinChangedEventArgs](pinchangedeventargs.md) object. Determine the type of signal by retrieving the [PinChange](pinchangedeventargs_pinchange.md) property. Those property values are defined in the [SerialPinChange](serialpinchange.md) enumeration. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.SerialCommunication.SerialDevice.PinChanged +-api-type: winrt event +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.PinChanged + +## -description +Event handler that is invoked when the state of a signal or line changes on the serial port. + +## -remarks +This event is used to detect and respond to changes in the signal state of the serial port. When state changes, the [PinChanged](serialdevice_pinchanged.md) event handler is invoked and information is received in a [PinChangedEventArgs](pinchangedeventargs.md) object. Determine the type of signal by retrieving the [PinChange](pinchangedeventargs_pinchange.md) property. Those property values are defined in the [SerialPinChange](serialpinchange.md) enumeration. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_portname.md b/windows.devices.serialcommunication/serialdevice_portname.md index 6dae4ecc67..b4ea815788 100644 --- a/windows.devices.serialcommunication/serialdevice_portname.md +++ b/windows.devices.serialcommunication/serialdevice_portname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.PortName --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.PortName ## -description Gets the port name for serial communications. ## -property-value The communication port name. For example "COM1". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.PortName +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.PortName + +## -description +Gets the port name for serial communications. + +## -property-value +The communication port name. For example "COM1". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_readtimeout.md b/windows.devices.serialcommunication/serialdevice_readtimeout.md index 29abec31fa..58af7b62cf 100644 --- a/windows.devices.serialcommunication/serialdevice_readtimeout.md +++ b/windows.devices.serialcommunication/serialdevice_readtimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.ReadTimeout --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.ReadTimeout ## -description Gets or sets the time-out value for a read operation. ## -property-value The span of time before a time-out occurs when a read operation does not finish. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.ReadTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.ReadTimeout + +## -description +Gets or sets the time-out value for a read operation. + +## -property-value +The span of time before a time-out occurs when a read operation does not finish. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_stopbits.md b/windows.devices.serialcommunication/serialdevice_stopbits.md index 02cf0c7990..7ec9120b26 100644 --- a/windows.devices.serialcommunication/serialdevice_stopbits.md +++ b/windows.devices.serialcommunication/serialdevice_stopbits.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.StopBits --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.StopBits ## -description Gets or sets the standard number of stop bits per byte. ## -property-value One of the values defined in the [SerialStopBitCount](serialstopbitcount.md) enumeration. ## -remarks In serial communication, a transmission begins with a start bit, followed by 8 bits of data, and ends with a stop bit. The purpose of the stop bit is to separate each unit of data or to indicate that no data is available for transmission. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.StopBits +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.StopBits + +## -description +Gets or sets the standard number of stop bits per byte. + +## -property-value +One of the values defined in the [SerialStopBitCount](serialstopbitcount.md) enumeration. + +## -remarks +In serial communication, a transmission begins with a start bit, followed by 8 bits of data, and ends with a stop bit. The purpose of the stop bit is to separate each unit of data or to indicate that no data is available for transmission. + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_usbproductid.md b/windows.devices.serialcommunication/serialdevice_usbproductid.md index 7c7d376f1a..965a9e54ae 100644 --- a/windows.devices.serialcommunication/serialdevice_usbproductid.md +++ b/windows.devices.serialcommunication/serialdevice_usbproductid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.UsbProductId --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.UsbProductId ## -description Gets the **idProduct** field of the [USB device descriptor](http://msdn.microsoft.com/library/ebec470d-5602-44cb-93a4-49f07ee2f013). This value indicates the device-specific product identifier and is assigned by the manufacturer. ## -property-value The device-defined product identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.UsbProductId +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.UsbProductId + +## -description +Gets the **idProduct** field of the [USB device descriptor](http://msdn.microsoft.com/library/ebec470d-5602-44cb-93a4-49f07ee2f013). This value indicates the device-specific product identifier and is assigned by the manufacturer. + +## -property-value +The device-defined product identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_usbvendorid.md b/windows.devices.serialcommunication/serialdevice_usbvendorid.md index 9051e5467b..884ded32d7 100644 --- a/windows.devices.serialcommunication/serialdevice_usbvendorid.md +++ b/windows.devices.serialcommunication/serialdevice_usbvendorid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.UsbVendorId --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.UsbVendorId ## -description Gets the **idVendor** field of the [USB device descriptor](http://msdn.microsoft.com/library/ebec470d-5602-44cb-93a4-49f07ee2f013). The value indicates the vendor identifier for the device as assigned by the USB specification committee. ## -property-value The vendor identifier for the device as assigned by the USB specification committee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.UsbVendorId +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.UsbVendorId + +## -description +Gets the **idVendor** field of the [USB device descriptor](http://msdn.microsoft.com/library/ebec470d-5602-44cb-93a4-49f07ee2f013). The value indicates the vendor identifier for the device as assigned by the USB specification committee. + +## -property-value +The vendor identifier for the device as assigned by the USB specification committee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.serialcommunication/serialdevice_writetimeout.md b/windows.devices.serialcommunication/serialdevice_writetimeout.md index e5ef3b5375..4e5f35ba48 100644 --- a/windows.devices.serialcommunication/serialdevice_writetimeout.md +++ b/windows.devices.serialcommunication/serialdevice_writetimeout.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SerialCommunication.SerialDevice.WriteTimeout --api-type: winrt property ---- # Windows.Devices.SerialCommunication.SerialDevice.WriteTimeout ## -description Gets or sets the time-out value for a write operation. ## -property-value The span of time before a time-out occurs when a write operation does not finish. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SerialCommunication.SerialDevice.WriteTimeout +-api-type: winrt property +--- + + + +# Windows.Devices.SerialCommunication.SerialDevice.WriteTimeout + +## -description +Gets or sets the time-out value for a write operation. + +## -property-value +The span of time before a time-out occurs when a write operation does not finish. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.smartcards/cardaddedeventargs.md b/windows.devices.smartcards/cardaddedeventargs.md index 5af72c06e1..4db143e9a9 100644 --- a/windows.devices.smartcards/cardaddedeventargs.md +++ b/windows.devices.smartcards/cardaddedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.CardAddedEventArgs --api-type: winrt class ---- # Windows.Devices.SmartCards.CardAddedEventArgs ## -description Provides data for the [CardAdded](smartcardreader_cardadded.md) event. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.CardAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.CardAddedEventArgs + +## -description +Provides data for the [CardAdded](smartcardreader_cardadded.md) event. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/cardaddedeventargs_smartcard.md b/windows.devices.smartcards/cardaddedeventargs_smartcard.md index 89fc49051d..a2d7fa0187 100644 --- a/windows.devices.smartcards/cardaddedeventargs_smartcard.md +++ b/windows.devices.smartcards/cardaddedeventargs_smartcard.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.CardAddedEventArgs.SmartCard --api-type: winrt property ---- # Windows.Devices.SmartCards.CardAddedEventArgs.SmartCard ## -description Gets info about the smart card that was inserted into the smart card reader. ## -property-value Info about the smart card that was inserted. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.CardAddedEventArgs.SmartCard +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.CardAddedEventArgs.SmartCard + +## -description +Gets info about the smart card that was inserted into the smart card reader. + +## -property-value +Info about the smart card that was inserted. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/cardremovedeventargs.md b/windows.devices.smartcards/cardremovedeventargs.md index 2fbd64e029..b529a8ed80 100644 --- a/windows.devices.smartcards/cardremovedeventargs.md +++ b/windows.devices.smartcards/cardremovedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.CardRemovedEventArgs --api-type: winrt class ---- # Windows.Devices.SmartCards.CardRemovedEventArgs ## -description Provides data for the [CardRemoved](smartcardreader_cardremoved.md) event. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.CardRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.CardRemovedEventArgs + +## -description +Provides data for the [CardRemoved](smartcardreader_cardremoved.md) event. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/cardremovedeventargs_smartcard.md b/windows.devices.smartcards/cardremovedeventargs_smartcard.md index ed66940ca3..1070f5e4a2 100644 --- a/windows.devices.smartcards/cardremovedeventargs_smartcard.md +++ b/windows.devices.smartcards/cardremovedeventargs_smartcard.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.CardRemovedEventArgs.SmartCard --api-type: winrt property ---- # Windows.Devices.SmartCards.CardRemovedEventArgs.SmartCard ## -description Gets info about the smart card that was taken out of the smart card reader. ## -property-value Info about the smart card that was taken out of the smart card reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.CardRemovedEventArgs.SmartCard +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.CardRemovedEventArgs.SmartCard + +## -description +Gets info about the smart card that was taken out of the smart card reader. + +## -property-value +Info about the smart card that was taken out of the smart card reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcard.md b/windows.devices.smartcards/smartcard.md index cdf40c9712..75fabb2c41 100644 --- a/windows.devices.smartcards/smartcard.md +++ b/windows.devices.smartcards/smartcard.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCard --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCard ## -description Represents info about a smart card. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCard +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCard + +## -description +Represents info about a smart card. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcard_connectasync_1379479827.md b/windows.devices.smartcards/smartcard_connectasync_1379479827.md index e757dbfc84..c6942b0711 100644 --- a/windows.devices.smartcards/smartcard_connectasync_1379479827.md +++ b/windows.devices.smartcards/smartcard_connectasync_1379479827.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCard.ConnectAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCard.ConnectAsync ## -description Establishes a connection to the smart card and returns a [SmartCardConnection](smartcardconnection.md) object representing the connection. ## -returns Asynchronous operation that, when complete, returns the [SmartCardConnection](smartcardconnection.md) object representing the connection. ## -remarks ## -examples ## -see-also [SmartCardConnection](smartcardconnection.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCard.ConnectAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCard.ConnectAsync + +## -description +Establishes a connection to the smart card and returns a [SmartCardConnection](smartcardconnection.md) object representing the connection. + +## -returns +Asynchronous operation that, when complete, returns the [SmartCardConnection](smartcardconnection.md) object representing the connection. + +## -remarks + +## -examples + +## -see-also +[SmartCardConnection](smartcardconnection.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcard_getanswertoresetasync_1332653759.md b/windows.devices.smartcards/smartcard_getanswertoresetasync_1332653759.md index f5792273a6..f387acfc0f 100644 --- a/windows.devices.smartcards/smartcard_getanswertoresetasync_1332653759.md +++ b/windows.devices.smartcards/smartcard_getanswertoresetasync_1332653759.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCard.GetAnswerToResetAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCard.GetAnswerToResetAsync ## -description Returns the smart card's *Answer to Reset* (ATR), a standard series of bytes that contains info about the smart card's characteristics, behaviors, and state. ## -returns The smart card's ATR byte set. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCard.GetAnswerToResetAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCard.GetAnswerToResetAsync + +## -description +Returns the smart card's *Answer to Reset* (ATR), a standard series of bytes that contains info about the smart card's characteristics, behaviors, and state. + +## -returns +The smart card's ATR byte set. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcard_getstatusasync_240032933.md b/windows.devices.smartcards/smartcard_getstatusasync_240032933.md index 1ff0ba3205..273ed846ea 100644 --- a/windows.devices.smartcards/smartcard_getstatusasync_240032933.md +++ b/windows.devices.smartcards/smartcard_getstatusasync_240032933.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCard.GetStatusAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCard.GetStatusAsync ## -description Returns the smart card's status. ## -returns One of the [SmartCardStatus](smartcardstatus.md) enumeration values, representing the smart card's status. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCard.GetStatusAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCard.GetStatusAsync + +## -description +Returns the smart card's status. + +## -returns +One of the [SmartCardStatus](smartcardstatus.md) enumeration values, representing the smart card's status. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcard_reader.md b/windows.devices.smartcards/smartcard_reader.md index 217cdb22d9..d45507c539 100644 --- a/windows.devices.smartcards/smartcard_reader.md +++ b/windows.devices.smartcards/smartcard_reader.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCard.Reader --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCard.Reader ## -description Gets info about the smart card reader into which the smart card is inserted. ## -property-value Info about the smart card reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCard.Reader +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCard.Reader + +## -description +Gets info about the smart card reader into which the smart card is inserted. + +## -property-value +Info about the smart card reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup.md b/windows.devices.smartcards/smartcardappletidgroup.md index 44beb5836f..a16edcab47 100644 --- a/windows.devices.smartcards/smartcardappletidgroup.md +++ b/windows.devices.smartcards/smartcardappletidgroup.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardAppletIdGroup --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup ## -description Defines a collection of smart card applet IDs. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardAppletIdGroup +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup + +## -description +Defines a collection of smart card applet IDs. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_appletids.md b/windows.devices.smartcards/smartcardappletidgroup_appletids.md index a5a3eb5a08..65a9270570 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_appletids.md +++ b/windows.devices.smartcards/smartcardappletidgroup_appletids.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.AppletIds --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.AppletIds ## -description Gets the collection of applet IDs. ## -property-value The collection of applet IDs. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.AppletIds +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.AppletIds + +## -description +Gets the collection of applet IDs. + +## -property-value +The collection of applet IDs. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_automaticenablement.md b/windows.devices.smartcards/smartcardappletidgroup_automaticenablement.md index a76606e583..7142998ad0 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_automaticenablement.md +++ b/windows.devices.smartcards/smartcardappletidgroup_automaticenablement.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.AutomaticEnablement --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.AutomaticEnablement ## -description Gets or sets a Boolean value indicating if the operating system is permitted to enable this [AppletIdGroup](smartcardappletidgroup.md). ## -property-value A Boolean value indicating if the operating system is permitted to enable this [AppletIdGroup](smartcardappletidgroup.md). ## -remarks Set this property to true to allow the OS to enable this [AppletIdGroup](smartcardappletidgroup.md). For example, in the NFC settings panel, a user may select a payment app. If there is only a single payment [AppletIdGroup](smartcardappletidgroup.md), and this property is set to true, the OS will automatically enable the [AppletIdGroup](smartcardappletidgroup.md). If false, the OS will always defer to the application to enable the [AppletIdGroup](smartcardappletidgroup.md). The default value is true. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.AutomaticEnablement +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.AutomaticEnablement + +## -description +Gets or sets a Boolean value indicating if the operating system is permitted to enable this [AppletIdGroup](smartcardappletidgroup.md). + +## -property-value +A Boolean value indicating if the operating system is permitted to enable this [AppletIdGroup](smartcardappletidgroup.md). + +## -remarks +Set this property to true to allow the OS to enable this [AppletIdGroup](smartcardappletidgroup.md). For example, in the NFC settings panel, a user may select a payment app. If there is only a single payment [AppletIdGroup](smartcardappletidgroup.md), and this property is set to true, the OS will automatically enable the [AppletIdGroup](smartcardappletidgroup.md). If false, the OS will always defer to the application to enable the [AppletIdGroup](smartcardappletidgroup.md). The default value is true. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_displayname.md b/windows.devices.smartcards/smartcardappletidgroup_displayname.md index 16bbeccf67..c4b6662b06 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_displayname.md +++ b/windows.devices.smartcards/smartcardappletidgroup_displayname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.DisplayName --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.DisplayName ## -description Sets or gets the name of this applet ID group. ## -property-value The name of this applet ID group. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.DisplayName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.DisplayName + +## -description +Sets or gets the name of this applet ID group. + +## -property-value +The name of this applet ID group. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_maxappletids.md b/windows.devices.smartcards/smartcardappletidgroup_maxappletids.md index 2e0086c534..2dd498dd8c 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_maxappletids.md +++ b/windows.devices.smartcards/smartcardappletidgroup_maxappletids.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.MaxAppletIds --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.MaxAppletIds ## -description Gets the maximum number of permitted applet IDs. ## -property-value The maximum number of permitted applet IDs. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.MaxAppletIds +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.MaxAppletIds + +## -description +Gets the maximum number of permitted applet IDs. + +## -property-value +The maximum number of permitted applet IDs. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_1221375020.md b/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_1221375020.md index b6145c85b7..aa4a98138a 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_1221375020.md +++ b/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroup.#ctor --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardAppletIdGroup ## -description Initializes a new instance of the [SmartCardAppletIdGroup](smartcardappletidgroup.md) class. ## -remarks ## -examples ## -see-also [SmartCardAppletIdGroup(String, IVector(IBuffer), SmartCardEmulationCategory, SmartCardEmulationType)](smartcardappletidgroup_smartcardappletidgroup_817995324.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroup.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardAppletIdGroup + +## -description +Initializes a new instance of the [SmartCardAppletIdGroup](smartcardappletidgroup.md) class. + +## -remarks + +## -examples + +## -see-also +[SmartCardAppletIdGroup(String, IVector(IBuffer), SmartCardEmulationCategory, SmartCardEmulationType)](smartcardappletidgroup_smartcardappletidgroup_817995324.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_817995324.md b/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_817995324.md index 6b72898d0e..b36d648e8d 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_817995324.md +++ b/windows.devices.smartcards/smartcardappletidgroup_smartcardappletidgroup_817995324.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroup.#ctor(System.String,Windows.Foundation.Collections.IVector{Windows.Storage.Streams.IBuffer},Windows.Devices.SmartCards.SmartCardEmulationCategory,Windows.Devices.SmartCards.SmartCardEmulationType) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardAppletIdGroup ## -description Initializes a new instance of the [SmartCardAppletIdGroup](smartcardappletidgroup.md) class using the specified parameters. ## -parameters ### -param displayName The name for this applet ID group. ### -param appletIds The list of applet IDs. ### -param emulationCategory The category of smart card to which the applet IDs apply, payment card or other. ### -param emulationType The type of smart card to which the applet IDs apply, host card or UICC. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroup.#ctor(System.String,Windows.Foundation.Collections.IVector{Windows.Storage.Streams.IBuffer},Windows.Devices.SmartCards.SmartCardEmulationCategory,Windows.Devices.SmartCards.SmartCardEmulationType) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardAppletIdGroup + +## -description +Initializes a new instance of the [SmartCardAppletIdGroup](smartcardappletidgroup.md) class using the specified parameters. + +## -parameters +### -param displayName +The name for this applet ID group. + +### -param appletIds +The list of applet IDs. + +### -param emulationCategory +The category of smart card to which the applet IDs apply, payment card or other. + +### -param emulationType +The type of smart card to which the applet IDs apply, host card or UICC. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationcategory.md b/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationcategory.md index 26fcd9bd3f..2b4e0ed144 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationcategory.md +++ b/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationcategory.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationCategory --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationCategory ## -description Sets or gets the category of smart card to which the applet IDs apply, payment card or other. ## -property-value The category of smart card to which the applet IDs apply, payment card or other. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationCategory +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationCategory + +## -description +Sets or gets the category of smart card to which the applet IDs apply, payment card or other. + +## -property-value +The category of smart card to which the applet IDs apply, payment card or other. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationtype.md b/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationtype.md index 1d5fd41713..0defca3eba 100644 --- a/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationtype.md +++ b/windows.devices.smartcards/smartcardappletidgroup_smartcardemulationtype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationType --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationType ## -description Sets or gets the type of smart card to which the applet IDs apply, host card or UICC. ## -property-value The type of smart card to which the applet IDs apply, host card or UICC. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationType +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroup.SmartCardEmulationType + +## -description +Sets or gets the type of smart card to which the applet IDs apply, host card or UICC. + +## -property-value +The type of smart card to which the applet IDs apply, host card or UICC. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroupregistration.md b/windows.devices.smartcards/smartcardappletidgroupregistration.md index f27df871f4..716b77e113 100644 --- a/windows.devices.smartcards/smartcardappletidgroupregistration.md +++ b/windows.devices.smartcards/smartcardappletidgroupregistration.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration ## -description Represents a registered group of applet IDs. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration + +## -description +Represents a registered group of applet IDs. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroupregistration_activationpolicy.md b/windows.devices.smartcards/smartcardappletidgroupregistration_activationpolicy.md index 31d18b945b..2a9f5e978f 100644 --- a/windows.devices.smartcards/smartcardappletidgroupregistration_activationpolicy.md +++ b/windows.devices.smartcards/smartcardappletidgroupregistration_activationpolicy.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.ActivationPolicy --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.ActivationPolicy ## -description Gets the activation policy for the registered applet ID group. ## -property-value The activation policy for the registered applet ID group. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.ActivationPolicy +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.ActivationPolicy + +## -description +Gets the activation policy for the registered applet ID group. + +## -property-value +The activation policy for the registered applet ID group. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroupregistration_appletidgroup.md b/windows.devices.smartcards/smartcardappletidgroupregistration_appletidgroup.md index eed6b5c93d..a87311da4e 100644 --- a/windows.devices.smartcards/smartcardappletidgroupregistration_appletidgroup.md +++ b/windows.devices.smartcards/smartcardappletidgroupregistration_appletidgroup.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.AppletIdGroup --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.AppletIdGroup ## -description Gets the registered group of applet IDs. ## -property-value The registered group of applet IDs. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.AppletIdGroup +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.AppletIdGroup + +## -description +Gets the registered group of applet IDs. + +## -property-value +The registered group of applet IDs. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroupregistration_id.md b/windows.devices.smartcards/smartcardappletidgroupregistration_id.md index 6ee69faceb..88e0754a41 100644 --- a/windows.devices.smartcards/smartcardappletidgroupregistration_id.md +++ b/windows.devices.smartcards/smartcardappletidgroupregistration_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.Id --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.Id ## -description Gets a unique ID representing this applet ID group registration. ## -property-value A unique ID representing this applet ID group registration. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.Id +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.Id + +## -description +Gets a unique ID representing this applet ID group registration. + +## -property-value +A unique ID representing this applet ID group registration. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroupregistration_requestactivationpolicychangeasync_926513637.md b/windows.devices.smartcards/smartcardappletidgroupregistration_requestactivationpolicychangeasync_926513637.md index d0dbdf48e2..ad47b14aa3 100644 --- a/windows.devices.smartcards/smartcardappletidgroupregistration_requestactivationpolicychangeasync_926513637.md +++ b/windows.devices.smartcards/smartcardappletidgroupregistration_requestactivationpolicychangeasync_926513637.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.RequestActivationPolicyChangeAsync(Windows.Devices.SmartCards.SmartCardAppletIdGroupActivationPolicy) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.RequestActivationPolicyChangeAsync ## -description Attempts to asynchronously change the [ActivationPolicy](smartcardappletidgroupregistration_activationpolicy.md) for this group of registered applet IDs. ## -parameters ### -param policy The new activation policy. ## -returns Indicates if the policy change was allowed or denied. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.RequestActivationPolicyChangeAsync(Windows.Devices.SmartCards.SmartCardAppletIdGroupActivationPolicy) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.RequestActivationPolicyChangeAsync + +## -description +Attempts to asynchronously change the [ActivationPolicy](smartcardappletidgroupregistration_activationpolicy.md) for this group of registered applet IDs. + +## -parameters +### -param policy +The new activation policy. + +## -returns +Indicates if the policy change was allowed or denied. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardappletidgroupregistration_setautomaticresponseapdusasync_1051464775.md b/windows.devices.smartcards/smartcardappletidgroupregistration_setautomaticresponseapdusasync_1051464775.md index a83711c13a..6ab4b7121a 100644 --- a/windows.devices.smartcards/smartcardappletidgroupregistration_setautomaticresponseapdusasync_1051464775.md +++ b/windows.devices.smartcards/smartcardappletidgroupregistration_setautomaticresponseapdusasync_1051464775.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.SetAutomaticResponseApdusAsync(Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu}) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.SetAutomaticResponseApdusAsync ## -description Sets a collection of [SmartCardAutomaticResponseApdu](smartcardautomaticresponseapdu.md) objects containing the automatic responses to return for this [SmartCardAppletIdGroupRegistration](smartcardappletidgroupregistration.md). ## -parameters ### -param apdus A collection of automatic responses. ## -returns An asynchronous action that completes when the requested operation is done. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.SetAutomaticResponseApdusAsync(Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu}) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration.SetAutomaticResponseApdusAsync + +## -description +Sets a collection of [SmartCardAutomaticResponseApdu](smartcardautomaticresponseapdu.md) objects containing the automatic responses to return for this [SmartCardAppletIdGroupRegistration](smartcardappletidgroupregistration.md). + +## -parameters +### -param apdus +A collection of automatic responses. + +## -returns +An asynchronous action that completes when the requested operation is done. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu.md b/windows.devices.smartcards/smartcardautomaticresponseapdu.md index 65065d81d6..38942f9719 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu ## -description Represents the smart card automatic response Application Protocol Data Unit (APDU). ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu + +## -description +Represents the smart card automatic response Application Protocol Data Unit (APDU). + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_allowwhencryptogramgeneratornotprepared.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_allowwhencryptogramgeneratornotprepared.md index 43cb3d5cf1..cf80c77315 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_allowwhencryptogramgeneratornotprepared.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_allowwhencryptogramgeneratornotprepared.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AllowWhenCryptogramGeneratorNotPrepared --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AllowWhenCryptogramGeneratorNotPrepared ## -description Gets or sets a Boolean value indicating whether to continue with Automatic APDU processing if Cryptogram Materials cannot be prepared for use without user authorization. ## -property-value The boolean value indicating whether to continue with Automatic APDU processing if Cryptogram Materials cannot be prepared for use without user authorization. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AllowWhenCryptogramGeneratorNotPrepared +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AllowWhenCryptogramGeneratorNotPrepared + +## -description +Gets or sets a Boolean value indicating whether to continue with Automatic APDU processing if Cryptogram Materials cannot be prepared for use without user authorization. + +## -property-value +The boolean value indicating whether to continue with Automatic APDU processing if Cryptogram Materials cannot be prepared for use without user authorization. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_appletid.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_appletid.md index 8251dd958a..3faefd1b33 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_appletid.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_appletid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AppletId --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AppletId ## -description Gets or sets the applet identifier for this APDU. ## -property-value The applet identifier for this APDU. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AppletId +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.AppletId + +## -description +Gets or sets the applet identifier for this APDU. + +## -property-value +The applet identifier for this APDU. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdu.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdu.md index 941b47664c..f0ee6e50e2 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdu.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdu.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApdu --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApdu ## -description Gets or sets the command for this APDU. ## -property-value The command for this APDU. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApdu +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApdu + +## -description +Gets or sets the command for this APDU. + +## -property-value +The command for this APDU. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdubitmask.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdubitmask.md index ecfb6f262b..e2b1f45bad 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdubitmask.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_commandapdubitmask.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApduBitMask --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApduBitMask ## -description Gets or sets the bitmask for the APDU command. ## -property-value The bitmask for the APDU command. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApduBitMask +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.CommandApduBitMask + +## -description +Gets or sets the bitmask for the APDU command. + +## -property-value +The bitmask for the APDU command. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_inputstate.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_inputstate.md index dbf95bd883..a2285d3c7b 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_inputstate.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_inputstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.InputState --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.InputState ## -description Gets and puts the input state. ## -property-value The input state. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.InputState +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.InputState + +## -description +Gets and puts the input state. + +## -property-value +The input state. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_outputstate.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_outputstate.md index cee5111236..c6d2c6be42 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_outputstate.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_outputstate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.OutputState --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.OutputState ## -description Gets and puts the output state. ## -property-value The output state. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.OutputState +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.OutputState + +## -description +Gets and puts the output state. + +## -property-value +The output state. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_responseapdu.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_responseapdu.md index 72eaf86c5a..8d518bf606 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_responseapdu.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_responseapdu.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ResponseApdu --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ResponseApdu ## -description Gets or sets the response from the Application Protocol Data Unit (APDU). ## -property-value The response from the APDU. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ResponseApdu +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ResponseApdu + +## -description +Gets or sets the response from the Application Protocol Data Unit (APDU). + +## -property-value +The response from the APDU. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_shouldmatchlength.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_shouldmatchlength.md index 3ff2076efd..293083a867 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_shouldmatchlength.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_shouldmatchlength.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ShouldMatchLength --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ShouldMatchLength ## -description Gets or sets a Boolean value indicating whether the [CommandApdu](smartcardautomaticresponseapdu_commandapdu.md) and incoming command should have exactly matching length. ## -property-value A Boolean value indicating whether the [CommandApdu](smartcardautomaticresponseapdu_commandapdu.md) and incoming command should have exactly matching length. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ShouldMatchLength +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.ShouldMatchLength + +## -description +Gets or sets a Boolean value indicating whether the [CommandApdu](smartcardautomaticresponseapdu_commandapdu.md) and incoming command should have exactly matching length. + +## -property-value +A Boolean value indicating whether the [CommandApdu](smartcardautomaticresponseapdu_commandapdu.md) and incoming command should have exactly matching length. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardautomaticresponseapdu_smartcardautomaticresponseapdu_191698370.md b/windows.devices.smartcards/smartcardautomaticresponseapdu_smartcardautomaticresponseapdu_191698370.md index 3ff89eb170..1b58c483b9 100644 --- a/windows.devices.smartcards/smartcardautomaticresponseapdu_smartcardautomaticresponseapdu_191698370.md +++ b/windows.devices.smartcards/smartcardautomaticresponseapdu_smartcardautomaticresponseapdu_191698370.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.#ctor(Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.SmartCardAutomaticResponseApdu ## -description Initializes a new instance of the class. ## -parameters ### -param commandApdu The APDU command sent by the NFC reader. ### -param responseApdu The response to the NFC reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.#ctor(Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardAutomaticResponseApdu.SmartCardAutomaticResponseApdu + +## -description +Initializes a new instance of the class. + +## -parameters +### -param commandApdu +The APDU command sent by the NFC reader. + +### -param responseApdu +The response to the NFC reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext.md b/windows.devices.smartcards/smartcardchallengecontext.md index 7ee15ee634..913cee401c 100644 --- a/windows.devices.smartcards/smartcardchallengecontext.md +++ b/windows.devices.smartcards/smartcardchallengecontext.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardChallengeContext --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardChallengeContext ## -description Represents a smart card authentication challenge/response operation. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardChallengeContext +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext + +## -description +Represents a smart card authentication challenge/response operation. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext_challenge.md b/windows.devices.smartcards/smartcardchallengecontext_challenge.md index 8cc5f44b0b..2d97db9ce4 100644 --- a/windows.devices.smartcards/smartcardchallengecontext_challenge.md +++ b/windows.devices.smartcards/smartcardchallengecontext_challenge.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardChallengeContext.Challenge --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardChallengeContext.Challenge ## -description Gets the smart card's challenge value. ## -property-value The smart card's challenge value. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardChallengeContext.Challenge +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext.Challenge + +## -description +Gets the smart card's challenge value. + +## -property-value +The smart card's challenge value. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext_changeadministrativekeyasync_1387029175.md b/windows.devices.smartcards/smartcardchallengecontext_changeadministrativekeyasync_1387029175.md index 75202a4516..5663965094 100644 --- a/windows.devices.smartcards/smartcardchallengecontext_changeadministrativekeyasync_1387029175.md +++ b/windows.devices.smartcards/smartcardchallengecontext_changeadministrativekeyasync_1387029175.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.ChangeAdministrativeKeyAsync(Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardChallengeContext.ChangeAdministrativeKeyAsync ## -description Changes the smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). ## -parameters ### -param response The response to a smart card authentication challenge/response operation. ### -param newAdministrativeKey The new smart card admin key. ## -returns An asynchronous action that completes after the admin key change attempt is done. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.ChangeAdministrativeKeyAsync(Windows.Storage.Streams.IBuffer,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext.ChangeAdministrativeKeyAsync + +## -description +Changes the smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). + +## -parameters +### -param response +The response to a smart card authentication challenge/response operation. + +### -param newAdministrativeKey +The new smart card admin key. + +## -returns +An asynchronous action that completes after the admin key change attempt is done. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext_close_811482585.md b/windows.devices.smartcards/smartcardchallengecontext_close_811482585.md index 495fee6e16..c3beff9123 100644 --- a/windows.devices.smartcards/smartcardchallengecontext_close_811482585.md +++ b/windows.devices.smartcards/smartcardchallengecontext_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.Close --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardChallengeContext.Close ## -description Completes the smart card authentication challenge/response operation and frees associated system resources. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.Close +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext.Close + +## -description +Completes the smart card authentication challenge/response operation and frees associated system resources. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext_provisionasync_1459375156.md b/windows.devices.smartcards/smartcardchallengecontext_provisionasync_1459375156.md index 0023f822cf..a068f5b510 100644 --- a/windows.devices.smartcards/smartcardchallengecontext_provisionasync_1459375156.md +++ b/windows.devices.smartcards/smartcardchallengecontext_provisionasync_1459375156.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync(Windows.Storage.Streams.IBuffer,System.Boolean) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync ## -description Reconfigures an existing, configured smart card with a new response. Optionally, formats the smart card. ## -parameters ### -param response The new response to a smart card authentication challenge/response operation. ### -param formatCard True to format the smart card; otherwise false. ## -returns An asynchronous action that completes after the smart card reconfiguration attempt is done. ## -remarks ## -examples ## -see-also [ProvisionAsync(IBuffer, Boolean, Guid)](smartcardchallengecontext_provisionasync_267749652.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync(Windows.Storage.Streams.IBuffer,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync + +## -description +Reconfigures an existing, configured smart card with a new response. Optionally, formats the smart card. + +## -parameters +### -param response +The new response to a smart card authentication challenge/response operation. + +### -param formatCard +True to format the smart card; otherwise false. + +## -returns +An asynchronous action that completes after the smart card reconfiguration attempt is done. + +## -remarks + +## -examples + +## -see-also +[ProvisionAsync(IBuffer, Boolean, Guid)](smartcardchallengecontext_provisionasync_267749652.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext_provisionasync_267749652.md b/windows.devices.smartcards/smartcardchallengecontext_provisionasync_267749652.md index 60549eb5ee..436346051b 100644 --- a/windows.devices.smartcards/smartcardchallengecontext_provisionasync_267749652.md +++ b/windows.devices.smartcards/smartcardchallengecontext_provisionasync_267749652.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync(Windows.Storage.Streams.IBuffer,System.Boolean,System.Guid) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync ## -description Reconfigures an existing, configured smart card with a new response and ID. Optionally, formats the smart card. ## -parameters ### -param response The new response to a smart card authentication challenge/response operation. ### -param formatCard True to format the smart card; otherwise false. ### -param newCardId The new smart card ID. ## -returns An asynchronous action that completes after the smart card reconfiguration attempt is done. ## -remarks ## -examples ## -see-also [ProvisionAsync(IBuffer, Boolean)](smartcardchallengecontext_provisionasync_1459375156.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync(Windows.Storage.Streams.IBuffer,System.Boolean,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext.ProvisionAsync + +## -description +Reconfigures an existing, configured smart card with a new response and ID. Optionally, formats the smart card. + +## -parameters +### -param response +The new response to a smart card authentication challenge/response operation. + +### -param formatCard +True to format the smart card; otherwise false. + +### -param newCardId +The new smart card ID. + +## -returns +An asynchronous action that completes after the smart card reconfiguration attempt is done. + +## -remarks + +## -examples + +## -see-also +[ProvisionAsync(IBuffer, Boolean)](smartcardchallengecontext_provisionasync_1459375156.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardchallengecontext_verifyresponseasync_2085424111.md b/windows.devices.smartcards/smartcardchallengecontext_verifyresponseasync_2085424111.md index ce0670ce45..a0f4969e90 100644 --- a/windows.devices.smartcards/smartcardchallengecontext_verifyresponseasync_2085424111.md +++ b/windows.devices.smartcards/smartcardchallengecontext_verifyresponseasync_2085424111.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.VerifyResponseAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardChallengeContext.VerifyResponseAsync ## -description Verifies the response to the smart card challenge request. ## -parameters ### -param response The response to the smart card challenge request. ## -returns After the verification attempt is done, true if the response was successfully verified; otherwise false. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardChallengeContext.VerifyResponseAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardChallengeContext.VerifyResponseAsync + +## -description +Verifies the response to the smart card challenge request. + +## -parameters +### -param response +The response to the smart card challenge request. + +## -returns +After the verification attempt is done, true if the response was successfully verified; otherwise false. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardconnection.md b/windows.devices.smartcards/smartcardconnection.md index 0e293739c0..d9290a92d0 100644 --- a/windows.devices.smartcards/smartcardconnection.md +++ b/windows.devices.smartcards/smartcardconnection.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardConnection --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardConnection ## -description Represents a connection to a smart card. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardConnection +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardConnection + +## -description +Represents a connection to a smart card. + +## -remarks + + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardconnection_close_811482585.md b/windows.devices.smartcards/smartcardconnection_close_811482585.md index 0be8a8e0b9..bf3ea7dba6 100644 --- a/windows.devices.smartcards/smartcardconnection_close_811482585.md +++ b/windows.devices.smartcards/smartcardconnection_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardConnection.Close --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardConnection.Close ## -description Completes the smart card authentication challenge/response operation and frees associated system resources. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardConnection.Close +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardConnection.Close + +## -description +Completes the smart card authentication challenge/response operation and frees associated system resources. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardconnection_transmitasync_719956186.md b/windows.devices.smartcards/smartcardconnection_transmitasync_719956186.md index 6d4556a4a3..b6622ce68d 100644 --- a/windows.devices.smartcards/smartcardconnection_transmitasync_719956186.md +++ b/windows.devices.smartcards/smartcardconnection_transmitasync_719956186.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardConnection.TransmitAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardConnection.TransmitAsync ## -description Asynchronously transmits the supplied application protocol data unit (APDU) command and returns the response. ## -parameters ### -param command The application protocol data unit (APDU) command to transmit to the smart card. ## -returns An asynchronous operation that, when completed, returns the response to the command that was transmitted. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardConnection.TransmitAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardConnection.TransmitAsync + +## -description +Asynchronously transmits the supplied application protocol data unit (APDU) command and returns the response. + +## -parameters +### -param command +The application protocol data unit (APDU) command to transmit to the smart card. + +## -returns +An asynchronous operation that, when completed, returns the response to the command that was transmitted. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator.md b/windows.devices.smartcards/smartcardcryptogramgenerator.md index bc70843a58..9b6f05e926 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramGenerator --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator ## -description Represents the mechanism for providing hardware supported for secure payment applications and protocols. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramGenerator +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator + +## -description +Represents the mechanism for providing hardware supported for secure payment applications and protocols. + +## -remarks + + + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_createcryptogrammaterialstoragekeyasync_139541895.md b/windows.devices.smartcards/smartcardcryptogramgenerator_createcryptogrammaterialstoragekeyasync_139541895.md index f714071110..bbd27a51b4 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_createcryptogrammaterialstoragekeyasync_139541895.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_createcryptogrammaterialstoragekeyasync_139541895.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.CreateCryptogramMaterialStorageKeyAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,System.String,Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyAlgorithm,Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCapabilities) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.CreateCryptogramMaterialStorageKeyAsync ## -description Generates a cryptogram storage key. ## -parameters ### -param promptingBehavior The user prompting behavior. ### -param storageKeyName The name of the new storage key. ### -param algorithm The encryption algorithm to use with the storage key. ### -param capabilities The capabilities of the new storage key. ## -returns An asynchronous operation that completes with an operation status after the attempt of creating a storage key. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.CreateCryptogramMaterialStorageKeyAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,System.String,Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyAlgorithm,Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCapabilities) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.CreateCryptogramMaterialStorageKeyAsync + +## -description +Generates a cryptogram storage key. + +## -parameters +### -param promptingBehavior +The user prompting behavior. + +### -param storageKeyName +The name of the new storage key. + +### -param algorithm +The encryption algorithm to use with the storage key. + +### -param capabilities +The capabilities of the new storage key. + +## -returns +An asynchronous operation that completes with an operation status after the attempt of creating a storage key. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialpackageasync_1702077234.md b/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialpackageasync_1702077234.md index acf001e05e..b82fa0b7aa 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialpackageasync_1702077234.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialpackageasync_1702077234.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialPackageAsync(System.String) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialPackageAsync ## -description Deletes a cryptogram material package. ## -parameters ### -param materialPackageName The material package name. ## -returns An asynchronous operation that completes with an operation status after the prompting behavior is completed. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialPackageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialPackageAsync + +## -description +Deletes a cryptogram material package. + +## -parameters +### -param materialPackageName +The material package name. + +## -returns +An asynchronous operation that completes with an operation status after the prompting behavior is completed. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialstoragekeyasync_850731708.md b/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialstoragekeyasync_850731708.md index 10f8beb1f5..3c6a7a7a16 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialstoragekeyasync_850731708.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_deletecryptogrammaterialstoragekeyasync_850731708.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialStorageKeyAsync(System.String) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialStorageKeyAsync ## -description Deletes the app's storage key and all of its stored packages. ## -parameters ### -param storageKeyName The name of the storage key. ## -returns An asynchronous operation that completes with an operation status. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialStorageKeyAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.DeleteCryptogramMaterialStorageKeyAsync + +## -description +Deletes the app's storage key and all of its stored packages. + +## -parameters +### -param storageKeyName +The name of the storage key. + +## -returns +An asynchronous operation that completes with an operation status. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_getsmartcardcryptogramgeneratorasync_1165054052.md b/windows.devices.smartcards/smartcardcryptogramgenerator_getsmartcardcryptogramgeneratorasync_1165054052.md index 6153d95883..98e797f9a4 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_getsmartcardcryptogramgeneratorasync_1165054052.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_getsmartcardcryptogramgeneratorasync_1165054052.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetSmartCardCryptogramGeneratorAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetSmartCardCryptogramGeneratorAsync ## -description Gets the smart card cryptogram generator. ## -returns An asynchronous operation that completes with a generator. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetSmartCardCryptogramGeneratorAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetSmartCardCryptogramGeneratorAsync + +## -description +Gets the smart card cryptogram generator. + +## -returns +An asynchronous operation that completes with a generator. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_importcryptogrammaterialpackageasync_778075175.md b/windows.devices.smartcards/smartcardcryptogramgenerator_importcryptogrammaterialpackageasync_778075175.md index 204799d0bb..a08f826494 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_importcryptogrammaterialpackageasync_778075175.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_importcryptogrammaterialpackageasync_778075175.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.ImportCryptogramMaterialPackageAsync(Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageFormat,System.String,System.String,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.ImportCryptogramMaterialPackageAsync ## -description Imports a cryptogram package. ## -parameters ### -param format The format of the package. ### -param storageKeyName The name of the storage key. ### -param materialPackageName The name of the package. ### -param cryptogramMaterialPackage A buffer containing the cryptogram package data. ## -returns An asynchronous operation that completes with an operation status after the attempt of importing a package. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.ImportCryptogramMaterialPackageAsync(Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageFormat,System.String,System.String,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.ImportCryptogramMaterialPackageAsync + +## -description +Imports a cryptogram package. + +## -parameters +### -param format +The format of the package. + +### -param storageKeyName +The name of the storage key. + +### -param materialPackageName +The name of the package. + +### -param cryptogramMaterialPackage +A buffer containing the cryptogram package data. + +## -returns +An asynchronous operation that completes with an operation status after the attempt of importing a package. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync_688264229.md b/windows.devices.smartcards/smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync_688264229.md index b4674306ac..09667ce2a2 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync_688264229.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync_688264229.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestCryptogramMaterialStorageKeyInfoAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,System.String,Windows.Security.Cryptography.Core.CryptographicPublicKeyBlobType) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestCryptogramMaterialStorageKeyInfoAsync ## -description Returns the public key and attestation information related to the cryptogram storage key. ## -parameters ### -param promptingBehavior The prompting behavior to display to the user for validation. ### -param storageKeyName The name of the storage key. ### -param format The format in which the public key of the storage key is to be returned. ## -returns An asynchronous operation that returns the smart card cryptogram storage key information. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestCryptogramMaterialStorageKeyInfoAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,System.String,Windows.Security.Cryptography.Core.CryptographicPublicKeyBlobType) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestCryptogramMaterialStorageKeyInfoAsync + +## -description +Returns the public key and attestation information related to the cryptogram storage key. + +## -parameters +### -param promptingBehavior +The prompting behavior to display to the user for validation. + +### -param storageKeyName +The name of the storage key. + +### -param format +The format in which the public key of the storage key is to be returned. + +## -returns +An asynchronous operation that returns the smart card cryptogram storage key information. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_requestunlockcryptogrammaterialforuseasync_1735570022.md b/windows.devices.smartcards/smartcardcryptogramgenerator_requestunlockcryptogrammaterialforuseasync_1735570022.md index a62b594985..8ae3f042e1 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_requestunlockcryptogrammaterialforuseasync_1735570022.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_requestunlockcryptogrammaterialforuseasync_1735570022.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestUnlockCryptogramMaterialForUseAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestUnlockCryptogramMaterialForUseAsync ## -description Requests that previously imported cryptogram material packages be readied for use. ## -parameters ### -param promptingBehavior The unlock prompting behavior. ## -returns An asynchronous operation that completes with an operation status after the prompting behavior is completed. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestUnlockCryptogramMaterialForUseAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.RequestUnlockCryptogramMaterialForUseAsync + +## -description +Requests that previously imported cryptogram material packages be readied for use. + +## -parameters +### -param promptingBehavior +The unlock prompting behavior. + +## -returns +An asynchronous operation that completes with an operation status after the prompting behavior is completed. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogramalgorithms.md b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogramalgorithms.md index a07661ad46..0995419efc 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogramalgorithms.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogramalgorithms.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramAlgorithms --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramAlgorithms ## -description Get the supported cryptogram algorithms. ## -property-value The supported algorithms. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramAlgorithms +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramAlgorithms + +## -description +Get the supported cryptogram algorithms. + +## -property-value +The supported algorithms. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageconfirmationresponseformats.md b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageconfirmationresponseformats.md index bcf4212fb3..065c89563b 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageconfirmationresponseformats.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageconfirmationresponseformats.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageConfirmationResponseFormats --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageConfirmationResponseFormats ## -description Gets the supported cryptogram material package confirmation response formats. ## -property-value The supported cryptogram material package confirmation response formats. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageConfirmationResponseFormats +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageConfirmationResponseFormats + +## -description +Gets the supported cryptogram material package confirmation response formats. + +## -property-value +The supported cryptogram material package confirmation response formats. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageformats.md b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageformats.md index ef80e67cd7..1768a95fde 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageformats.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialpackageformats.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageFormats --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageFormats ## -description Gets the supported cryptogram material package formats. ## -property-value The supported cryptogram material package formats. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageFormats +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialPackageFormats + +## -description +Gets the supported cryptogram material package formats. + +## -property-value +The supported cryptogram material package formats. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialtypes.md b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialtypes.md index 06ab1f7760..ec8fa7389d 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialtypes.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedcryptogrammaterialtypes.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialTypes --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialTypes ## -description Gets the supported cryptogram material types. ## -property-value The supported cryptogram material types. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialTypes +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedCryptogramMaterialTypes + +## -description +Gets the supported cryptogram material types. + +## -property-value +The supported cryptogram material types. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedsmartcardcryptogramstoragekeycapabilities.md b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedsmartcardcryptogramstoragekeycapabilities.md index 6841f2e9d3..8708c751df 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_supportedsmartcardcryptogramstoragekeycapabilities.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_supportedsmartcardcryptogramstoragekeycapabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedSmartCardCryptogramStorageKeyCapabilities --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedSmartCardCryptogramStorageKeyCapabilities ## -description Gets the supported smart card cryptogram storage key capabilities. ## -property-value The supported smart card cryptogram storage key capabilities. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedSmartCardCryptogramStorageKeyCapabilities +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.SupportedSmartCardCryptogramStorageKeyCapabilities + +## -description +Gets the supported smart card cryptogram storage key capabilities. + +## -property-value +The supported smart card cryptogram storage key capabilities. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_tryprovepossessionofcryptogrammaterialpackageasync_2141877963.md b/windows.devices.smartcards/smartcardcryptogramgenerator_tryprovepossessionofcryptogrammaterialpackageasync_2141877963.md index 653333248c..6091a0297a 100644 --- a/windows.devices.smartcards/smartcardcryptogramgenerator_tryprovepossessionofcryptogrammaterialpackageasync_2141877963.md +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_tryprovepossessionofcryptogrammaterialpackageasync_2141877963.md @@ -1,3 +1,43 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.TryProvePossessionOfCryptogramMaterialPackageAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageConfirmationResponseFormat,System.String,System.String,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramGenerator.TryProvePossessionOfCryptogramMaterialPackageAsync ## -description This method allows the payment app to query the cryptogram generator for proof of material package possession. ## -parameters ### -param promptingBehavior The prompting behavior to display to the user for validation. ### -param responseFormat The format of the response. ### -param materialPackageName The material package name. ### -param materialName The material name. ### -param challenge A buffer that contains the confirmation challenge token. The challenge token must consist of UTF-8 characters conformating to the following C# regular expression. ``` ^(?0\d{7})(?\d+)(?\d*[|][0-9a-fA-F]*[|]\d*[|][QM])*$" ``` ## -returns An asynchronous operation that completes with the material possession proof. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.TryProvePossessionOfCryptogramMaterialPackageAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageConfirmationResponseFormat,System.String,System.String,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.TryProvePossessionOfCryptogramMaterialPackageAsync + +## -description +This method allows the payment app to query the cryptogram generator for proof of material package possession. + +## -parameters +### -param promptingBehavior +The prompting behavior to display to the user for validation. + +### -param responseFormat +The format of the response. + +### -param materialPackageName +The material package name. + +### -param materialName +The material name. + +### -param challenge +A buffer that contains the confirmation challenge token. The challenge token must consist of UTF-8 characters conformating to the following C# regular expression. ``` +^(?0\d{7})(?\d+)(?\d*[|][0-9a-fA-F]*[|]\d*[|][QM])*$" +``` + + + +## -returns +An asynchronous operation that completes with the material possession proof. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof.md b/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof.md index 0956ec5469..a6b6bab022 100644 --- a/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof.md +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof ## -description Contains the result of calling [TryProvePossessionOfCryptogramMaterialPackageAsync](smartcardcryptogramgenerator_tryprovepossessionofcryptogrammaterialpackageasync.md) with a challenge token to prove that the device possesses the identified cryptogram material. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof + +## -description +Contains the result of calling [TryProvePossessionOfCryptogramMaterialPackageAsync](smartcardcryptogramgenerator_tryprovepossessionofcryptogrammaterialpackageasync.md) with a challenge token to prove that the device possesses the identified cryptogram material. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_operationstatus.md b/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_operationstatus.md index efb016f1d0..95b7c35622 100644 --- a/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_operationstatus.md +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_operationstatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.OperationStatus --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.OperationStatus ## -description Gets or sets the operation status of the proof operation. ## -property-value The operation status. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.OperationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.OperationStatus + +## -description +Gets or sets the operation status of the proof operation. + +## -property-value +The operation status. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_proof.md b/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_proof.md index c83923bdeb..ca527e272d 100644 --- a/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_proof.md +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpossessionproof_proof.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.Proof --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.Proof ## -description Gets the result of the proof of possession operation. This field is only valid if the OperationStatus field is Success. ## -property-value A buffer containing the result from a successful proof of possession operation. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.Proof +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPossessionProof.Proof + +## -description +Gets the result of the proof of possession operation. This field is only valid if the OperationStatus field is Success. + +## -property-value +A buffer containing the result from a successful proof of possession operation. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep.md b/windows.devices.smartcards/smartcardcryptogramplacementstep.md index d0f8d4ca28..833878ce22 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep ## -description Contains instructions for placing a cryptogram in an outgoing message. ## -remarks ## -examples ## -see-also [SmartCardEmulatorApduReceivedEventArgs](smartcardemulatorapdureceivedeventargs.md), [TryRespondWithCryptogramsAsync](smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep + +## -description +Contains instructions for placing a cryptogram in an outgoing message. + +## -remarks + +## -examples + +## -see-also +[SmartCardEmulatorApduReceivedEventArgs](smartcardemulatorapdureceivedeventargs.md), [TryRespondWithCryptogramsAsync](smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_algorithm.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_algorithm.md index 8e67903e09..95f3de26c1 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_algorithm.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_algorithm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.Algorithm --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.Algorithm ## -description Gets or sets an optional placement step that will use this placement step's output as an input to the next specified placement step. ## -property-value The target of a chained step. The value must be null if this placement step is not chained. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.Algorithm +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.Algorithm + +## -description +Gets or sets an optional placement step that will use this placement step's output as an input to the next specified placement step. + +## -property-value +The target of a chained step. The value must be null if this placement step is not chained. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_chainedoutputstep.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_chainedoutputstep.md index 673b9666de..35f4b5980b 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_chainedoutputstep.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_chainedoutputstep.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.ChainedOutputStep --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.ChainedOutputStep ## -description Gets or sets the output of this chained step. ## -property-value The output of this chained step. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.ChainedOutputStep +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.ChainedOutputStep + +## -description +Gets or sets the output of this chained step. + +## -property-value +The output of this chained step. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramlength.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramlength.md index 41889b5204..4b5c092a1a 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramlength.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramlength.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramLength --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramLength ## -description Gets or sets the length of the output to take from the offset. ## -property-value The cryptogram inserted into the outgoing message may not exceed this length. Units may be either bytes or nibbles, based on the UnitsAreInNibbles flag of the [CryptogramPlacementOptions](smartcardcryptogramplacementstep_cryptogramplacementoptions.md) property. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramLength +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramLength + +## -description +Gets or sets the length of the output to take from the offset. + +## -property-value +The cryptogram inserted into the outgoing message may not exceed this length. Units may be either bytes or nibbles, based on the UnitsAreInNibbles flag of the [CryptogramPlacementOptions](smartcardcryptogramplacementstep_cryptogramplacementoptions.md) property. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialname.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialname.md index 47bdc1900c..e4c2341135 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialname.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialname.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialName --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialName ## -description Gets or sets the cryptogram material name to use when executing this step. ## -property-value The cryptogram material name to use in generating the cryptogram to be placed in this outgoing message. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialName + +## -description +Gets or sets the cryptogram material name to use when executing this step. + +## -property-value +The cryptogram material name to use in generating the cryptogram to be placed in this outgoing message. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialpackagename.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialpackagename.md index 4644e667ba..b0e2da171b 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialpackagename.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogrammaterialpackagename.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialPackageName --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialPackageName ## -description Gets or sets the cryptogram material package name that contains the material specified. ## -property-value The cryptogram material package name in which the named cryptogram material may be found. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialPackageName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramMaterialPackageName + +## -description +Gets or sets the cryptogram material package name that contains the material specified. + +## -property-value +The cryptogram material package name in which the named cryptogram material may be found. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramoffset.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramoffset.md index 16a0c7b44c..73eabfaffd 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramoffset.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramoffset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramOffset --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramOffset ## -description Gets or sets the data that will be used to generate the cryptogram to be placed in the outgoing message. ## -property-value The offset in the generated cryptogram to begin copying into the message that will be sent. Units may be either bytes or nibbles, based on the UnitsAreInNibbles flag of the [CryptogramPlacementOptions](smartcardcryptogramplacementstep_cryptogramplacementoptions.md) field. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramOffset +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramOffset + +## -description +Gets or sets the data that will be used to generate the cryptogram to be placed in the outgoing message. + +## -property-value +The offset in the generated cryptogram to begin copying into the message that will be sent. Units may be either bytes or nibbles, based on the UnitsAreInNibbles flag of the [CryptogramPlacementOptions](smartcardcryptogramplacementstep_cryptogramplacementoptions.md) field. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramplacementoptions.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramplacementoptions.md index c8f91af51c..a72b18e44e 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramplacementoptions.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_cryptogramplacementoptions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramPlacementOptions --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramPlacementOptions ## -description Gets or sets the cryptogram placement options. ## -property-value The cryptogram placement options. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramPlacementOptions +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.CryptogramPlacementOptions + +## -description +Gets or sets the cryptogram placement options. + +## -property-value +The cryptogram placement options. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_smartcardcryptogramplacementstep_1221375020.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_smartcardcryptogramplacementstep_1221375020.md index 526d91c4ec..13baa4a81b 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_smartcardcryptogramplacementstep_1221375020.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_smartcardcryptogramplacementstep_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.#ctor --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.SmartCardCryptogramPlacementStep ## -description Constructs a new [SmartCardCryptogramPlacementStep](smartcardcryptogramplacementstep.md) object. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.SmartCardCryptogramPlacementStep + +## -description +Constructs a new [SmartCardCryptogramPlacementStep](smartcardcryptogramplacementstep.md) object. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_sourcedata.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_sourcedata.md index 10c9b2c838..02e9b1a3a4 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_sourcedata.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_sourcedata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.SourceData --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.SourceData ## -description Gets or sets the data that will be encrypted in this step of chaining cryptograms. ## -property-value The source data. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.SourceData +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.SourceData + +## -description +Gets or sets the data that will be encrypted in this step of chaining cryptograms. + +## -property-value +The source data. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramplacementstep_templateoffset.md b/windows.devices.smartcards/smartcardcryptogramplacementstep_templateoffset.md index a7bbe120ad..6bb09c4aab 100644 --- a/windows.devices.smartcards/smartcardcryptogramplacementstep_templateoffset.md +++ b/windows.devices.smartcards/smartcardcryptogramplacementstep_templateoffset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.TemplateOffset --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.TemplateOffset ## -description Gets or sets the offset into the target output buffer at which the generated cryptogram will be placed. Units may be either bytes or nibbles, based on the UnitsAreInNibbles flag of the [CryptogramPlacementOptions](smartcardcryptogramplacementstep_cryptogramplacementoptions.md) field. ## -property-value The data template offset. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.TemplateOffset +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep.TemplateOffset + +## -description +Gets or sets the offset into the target output buffer at which the generated cryptogram will be placed. Units may be either bytes or nibbles, based on the UnitsAreInNibbles flag of the [CryptogramPlacementOptions](smartcardcryptogramplacementstep_cryptogramplacementoptions.md) field. + +## -property-value +The data template offset. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo.md index 48c0e14698..c721b5210b 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo ## -description Contains information about the storage key so that apps can register and certify the key information with their service. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo + +## -description +Contains information about the storage key so that apps can register and certify the key information with their service. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestation.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestation.md index b0dd08dab9..adfe3b6129 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestation.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Attestation --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Attestation ## -description Gets the attestation. ## -property-value A buffer containing the attestation. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Attestation +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Attestation + +## -description +Gets the attestation. + +## -property-value +A buffer containing the attestation. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationcertificatechain.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationcertificatechain.md index b81667e263..10d5f6e4aa 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationcertificatechain.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationcertificatechain.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationCertificateChain --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationCertificateChain ## -description Gets the attestation certificate chain. ## -property-value A buffer containing the attestation certificate chain. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationCertificateChain +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationCertificateChain + +## -description +Gets the attestation certificate chain. + +## -property-value +A buffer containing the attestation certificate chain. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationstatus.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationstatus.md index 4b270e4e4a..8b0627b83f 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationstatus.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_attestationstatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationStatus --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationStatus ## -description Gets the attestation status. ## -property-value The attestation status. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.AttestationStatus + +## -description +Gets the attestation status. + +## -property-value +The attestation status. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_capabilities.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_capabilities.md index 6aa16be7b8..5f6d33dec5 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_capabilities.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_capabilities.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Capabilities --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Capabilities ## -description Gets the cryptogram storage key capabilities. ## -property-value The cryptogram storage key capabilities. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.Capabilities + +## -description +Gets the cryptogram storage key capabilities. + +## -property-value +The cryptogram storage key capabilities. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationalrequirements.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationalrequirements.md index 7d0d882c09..785260c3d1 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationalrequirements.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationalrequirements.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationalRequirements --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationalRequirements ## -description Gets the operational requirements of the storage key. ## -property-value The operational requirements. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationalRequirements +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationalRequirements + +## -description +Gets the operational requirements of the storage key. + +## -property-value +The operational requirements. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationstatus.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationstatus.md index 56b6989441..42cbab33b6 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationstatus.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_operationstatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationStatus --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationStatus ## -description Gets the operation status. ## -property-value The operation status. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.OperationStatus + +## -description +Gets the operation status. + +## -property-value +The operation status. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickey.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickey.md index dcdf9b596e..72097c1d8a 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickey.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickey.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKey --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKey ## -description Gets the public key. ## -property-value A buffer containing the public key in the format specified when calling [RequestCryptogramMaterialStorageKeyInfoAsync](smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync.md). ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKey +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKey + +## -description +Gets the public key. + +## -property-value +A buffer containing the public key in the format specified when calling [RequestCryptogramMaterialStorageKeyInfoAsync](smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync.md). + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickeyblobtype.md b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickeyblobtype.md index 01ef7cf1e1..1fe75a6972 100644 --- a/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickeyblobtype.md +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeyinfo_publickeyblobtype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKeyBlobType --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKeyBlobType ## -description Gets the type of the public key object. This value reflects the public key blob type requested in the [RequestCryptogramMaterialStorageKeyInfoAsync](smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync.md) method. ## -property-value The type of the public key object. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKeyBlobType +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyInfo.PublicKeyBlobType + +## -description +Gets the type of the public key object. This value reflects the public key blob type requested in the [RequestCryptogramMaterialStorageKeyInfoAsync](smartcardcryptogramgenerator_requestcryptogrammaterialstoragekeyinfoasync.md) method. + +## -property-value +The type of the public key object. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator.md b/windows.devices.smartcards/smartcardemulator.md index 94adc40ede..0656e99cff 100644 --- a/windows.devices.smartcards/smartcardemulator.md +++ b/windows.devices.smartcards/smartcardemulator.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardEmulator --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardEmulator ## -description Represents a smart card emulator device. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardEmulator +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator + +## -description +Represents a smart card emulator device. + +## -remarks + + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_apdureceived.md b/windows.devices.smartcards/smartcardemulator_apdureceived.md index 11dfba9aea..8870d1b075 100644 --- a/windows.devices.smartcards/smartcardemulator_apdureceived.md +++ b/windows.devices.smartcards/smartcardemulator_apdureceived.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.SmartCards.SmartCardEmulator.ApduReceived --api-type: winrt event ---- # Windows.Devices.SmartCards.SmartCardEmulator.ApduReceived ## -description Occurs when an application protocol data unit (APDU) is received by the NFC controller. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: E:Windows.Devices.SmartCards.SmartCardEmulator.ApduReceived +-api-type: winrt event +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.ApduReceived + +## -description +Occurs when an application protocol data unit (APDU) is received by the NFC controller. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_connectiondeactivated.md b/windows.devices.smartcards/smartcardemulator_connectiondeactivated.md index 13827a599b..64be6bf722 100644 --- a/windows.devices.smartcards/smartcardemulator_connectiondeactivated.md +++ b/windows.devices.smartcards/smartcardemulator_connectiondeactivated.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.SmartCards.SmartCardEmulator.ConnectionDeactivated --api-type: winrt event ---- # Windows.Devices.SmartCards.SmartCardEmulator.ConnectionDeactivated ## -description Occurs when the connection with the device is physically broken or when the NFC reader requests a connection to a different app. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: E:Windows.Devices.SmartCards.SmartCardEmulator.ConnectionDeactivated +-api-type: winrt event +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.ConnectionDeactivated + +## -description +Occurs when the connection with the device is physically broken or when the NFC reader requests a connection to a different app. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_enablementpolicy.md b/windows.devices.smartcards/smartcardemulator_enablementpolicy.md index 216f07fda9..083710d8c9 100644 --- a/windows.devices.smartcards/smartcardemulator_enablementpolicy.md +++ b/windows.devices.smartcards/smartcardemulator_enablementpolicy.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulator.EnablementPolicy --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulator.EnablementPolicy ## -description Gets the current card emulation policy set by the user. ## -property-value The current card emulation policy set by the user through the phone settings. This property is read-only to the app; you should tell the user to change the card emulation policy in the settings on his or her phone, if their mobile operator allows it. ## -remarks You can launch the URI `ms-settings-nfctransactions:` from within your app to take the user to the NFC control panel for transactions so they can change the enablement policy. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulator.EnablementPolicy +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.EnablementPolicy + +## -description +Gets the current card emulation policy set by the user. + +## -property-value +The current card emulation policy set by the user through the phone settings. This property is read-only to the app; you should tell the user to change the card emulation policy in the settings on his or her phone, if their mobile operator allows it. + +## -remarks +You can launch the URI `ms-settings-nfctransactions:` from within your app to take the user to the NFC control panel for transactions so they can change the enablement policy. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_getappletidgroupregistrationsasync_913914797.md b/windows.devices.smartcards/smartcardemulator_getappletidgroupregistrationsasync_913914797.md index b71234efa5..96cfb156bc 100644 --- a/windows.devices.smartcards/smartcardemulator_getappletidgroupregistrationsasync_913914797.md +++ b/windows.devices.smartcards/smartcardemulator_getappletidgroupregistrationsasync_913914797.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.GetAppletIdGroupRegistrationsAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulator.GetAppletIdGroupRegistrationsAsync ## -description Gets the registered applet identifier groups for this smart card, asynchronously. ## -returns The registered applet identifier groups for this smart card. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.GetAppletIdGroupRegistrationsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.GetAppletIdGroupRegistrationsAsync + +## -description +Gets the registered applet identifier groups for this smart card, asynchronously. + +## -returns +The registered applet identifier groups for this smart card. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_getdefaultasync_1549573963.md b/windows.devices.smartcards/smartcardemulator_getdefaultasync_1549573963.md index e7bf9739f1..b899971453 100644 --- a/windows.devices.smartcards/smartcardemulator_getdefaultasync_1549573963.md +++ b/windows.devices.smartcards/smartcardemulator_getdefaultasync_1549573963.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulator.GetDefaultAsync ## -description Returns the [SmartCardEmulator](smartcardemulator.md) object representing the default smart card emulator device. ## -returns After the asynchronous operation completes, returns the default smart card emulator or null if there is no smart card emulator present. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.GetDefaultAsync + +## -description +Returns the [SmartCardEmulator](smartcardemulator.md) object representing the default smart card emulator device. + +## -returns +After the asynchronous operation completes, returns the default smart card emulator or null if there is no smart card emulator present. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_ishostcardemulationsupported_186978144.md b/windows.devices.smartcards/smartcardemulator_ishostcardemulationsupported_186978144.md index 8cc6277767..6b7dc2d94e 100644 --- a/windows.devices.smartcards/smartcardemulator_ishostcardemulationsupported_186978144.md +++ b/windows.devices.smartcards/smartcardemulator_ishostcardemulationsupported_186978144.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.IsHostCardEmulationSupported --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulator.IsHostCardEmulationSupported ## -description Gets a Boolean value indicating if host card emulation is supported by this device. ## -returns True if host card emulation is supported by this device. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.IsHostCardEmulationSupported +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.IsHostCardEmulationSupported + +## -description +Gets a Boolean value indicating if host card emulation is supported by this device. + +## -returns +True if host card emulation is supported by this device. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_maxappletidgroupregistrations.md b/windows.devices.smartcards/smartcardemulator_maxappletidgroupregistrations.md index b8126ebc6d..73b6ea51d8 100644 --- a/windows.devices.smartcards/smartcardemulator_maxappletidgroupregistrations.md +++ b/windows.devices.smartcards/smartcardemulator_maxappletidgroupregistrations.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulator.MaxAppletIdGroupRegistrations --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulator.MaxAppletIdGroupRegistrations ## -description Gets the maximum number of permitted applet ID group registrations. ## -property-value The maximum number of permitted applet ID group registrations. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulator.MaxAppletIdGroupRegistrations +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.MaxAppletIdGroupRegistrations + +## -description +Gets the maximum number of permitted applet ID group registrations. + +## -property-value +The maximum number of permitted applet ID group registrations. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_registerappletidgroupasync_1344612246.md b/windows.devices.smartcards/smartcardemulator_registerappletidgroupasync_1344612246.md index c263df2934..326aebbda8 100644 --- a/windows.devices.smartcards/smartcardemulator_registerappletidgroupasync_1344612246.md +++ b/windows.devices.smartcards/smartcardemulator_registerappletidgroupasync_1344612246.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.RegisterAppletIdGroupAsync(Windows.Devices.SmartCards.SmartCardAppletIdGroup) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulator.RegisterAppletIdGroupAsync ## -description Asynchronously registers a group of applet IDs. ## -parameters ### -param appletIdGroup The group of applet IDs to register. ## -returns The group of registered applet IDs. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.RegisterAppletIdGroupAsync(Windows.Devices.SmartCards.SmartCardAppletIdGroup) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.RegisterAppletIdGroupAsync + +## -description +Asynchronously registers a group of applet IDs. + +## -parameters +### -param appletIdGroup +The group of applet IDs to register. + +## -returns +The group of registered applet IDs. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_start_1587696324.md b/windows.devices.smartcards/smartcardemulator_start_1587696324.md index 423de8999e..355607a30c 100644 --- a/windows.devices.smartcards/smartcardemulator_start_1587696324.md +++ b/windows.devices.smartcards/smartcardemulator_start_1587696324.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.Start --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulator.Start ## -description Starts the smart card emulator. This method must be called from a background task. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.Start +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.Start + +## -description +Starts the smart card emulator. This method must be called from a background task. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulator_unregisterappletidgroupasync_1628485058.md b/windows.devices.smartcards/smartcardemulator_unregisterappletidgroupasync_1628485058.md index 092349d3d8..9948d4aa81 100644 --- a/windows.devices.smartcards/smartcardemulator_unregisterappletidgroupasync_1628485058.md +++ b/windows.devices.smartcards/smartcardemulator_unregisterappletidgroupasync_1628485058.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.UnregisterAppletIdGroupAsync(Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulator.UnregisterAppletIdGroupAsync ## -description Asynchronously unregisters a previously registered group of applet IDs. ## -parameters ### -param registration The previously registered group of applet IDs. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.UnregisterAppletIdGroupAsync(Windows.Devices.SmartCards.SmartCardAppletIdGroupRegistration) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.UnregisterAppletIdGroupAsync + +## -description +Asynchronously unregisters a previously registered group of applet IDs. + +## -parameters +### -param registration +The previously registered group of applet IDs. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs.md index 39ecbdb134..75c537d9cb 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs ## -description Provides data for the [ApduReceived](smartcardemulator_apdureceived.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [ApduReceived](smartcardemulator_apdureceived.md) event handler. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs + +## -description +Provides data for the [ApduReceived](smartcardemulator_apdureceived.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [ApduReceived](smartcardemulator_apdureceived.md) event handler. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_automaticresponsestatus.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_automaticresponsestatus.md index 95c6a9796b..9988554d92 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_automaticresponsestatus.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_automaticresponsestatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.AutomaticResponseStatus --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.AutomaticResponseStatus ## -description Gets a [SmartCardAutomaticResponseStatus](smartcardautomaticresponsestatus.md) object indicating the automatic response was already successfully sent (**Success**), attempted but failed (**UnknownError**), or was not matched with any auto-responder rule (**None**). ## -property-value The object indicating the status of the automatic response. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.AutomaticResponseStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.AutomaticResponseStatus + +## -description +Gets a [SmartCardAutomaticResponseStatus](smartcardautomaticresponsestatus.md) object indicating the automatic response was already successfully sent (**Success**), attempted but failed (**UnknownError**), or was not matched with any auto-responder rule (**None**). + +## -property-value +The object indicating the status of the automatic response. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_commandapdu.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_commandapdu.md index d5b2a6a214..851e1535d4 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_commandapdu.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_commandapdu.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.CommandApdu --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.CommandApdu ## -description Represents an application protocol data unit (APDU) command sent by an NFC reader. ## -property-value An application protocol data unit (APDU) command sent by an NFC reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.CommandApdu +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.CommandApdu + +## -description +Represents an application protocol data unit (APDU) command sent by an NFC reader. + +## -property-value +An application protocol data unit (APDU) command sent by an NFC reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_connectionproperties.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_connectionproperties.md index 27c04dd202..0cb833cb20 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_connectionproperties.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_connectionproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.ConnectionProperties --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.ConnectionProperties ## -description Gets the connection properties of the smart card emulator. ## -property-value The connection properties of the smart card emulator. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.ConnectionProperties +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.ConnectionProperties + +## -description +Gets the connection properties of the smart card emulator. + +## -property-value +The connection properties of the smart card emulator. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_state.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_state.md index 5d15b6585d..e2d66df1ab 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_state.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_state.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.State --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.State ## -description Gets the state. ## -property-value The state. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.State + +## -description +Gets the state. + +## -property-value +The state. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_1062726120.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_1062726120.md index 891eafdd1d..a0fcc442fa 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_1062726120.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_1062726120.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync ## -description Attempts to respond to an APDU. ## -parameters ### -param responseApdu A buffer containing the response. ## -returns Returns an asynchronous operation that returns a boolean when the operation completes indicating. The boolean will be true if the operation was successful and false otherwise. ## -remarks ## -examples ## -see-also [TryRespondAsync(IBuffer, IReference(UInt32))](smartcardemulatorapdureceivedeventargs_tryrespondasync_968497288.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync + +## -description +Attempts to respond to an APDU. + +## -parameters +### -param responseApdu +A buffer containing the response. + +## -returns +Returns an asynchronous operation that returns a boolean when the operation completes indicating. The boolean will be true if the operation was successful and false otherwise. + +## -remarks + +## -examples + +## -see-also +[TryRespondAsync(IBuffer, IReference(UInt32))](smartcardemulatorapdureceivedeventargs_tryrespondasync_968497288.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_968497288.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_968497288.md index 235fc4901a..f295f1f827 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_968497288.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondasync_968497288.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync(Windows.Storage.Streams.IBuffer,Windows.Foundation.IReference{System.UInt32}) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync ## -description Attempts to respond to an APDU. ## -parameters ### -param responseApdu A buffer containing the response. ### -param nextState A reference containing the next state. ## -returns Returns an asynchronous operation that returns a boolean when the operation completes. The boolean is true if the operation completed successfully and false otherwise. ## -remarks ## -examples ## -see-also [TryRespondAsync(IBuffer)](smartcardemulatorapdureceivedeventargs_tryrespondasync_1062726120.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync(Windows.Storage.Streams.IBuffer,Windows.Foundation.IReference{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondAsync + +## -description +Attempts to respond to an APDU. + +## -parameters +### -param responseApdu +A buffer containing the response. + +### -param nextState +A reference containing the next state. + +## -returns +Returns an asynchronous operation that returns a boolean when the operation completes. The boolean is true if the operation completed successfully and false otherwise. + +## -remarks + +## -examples + +## -see-also +[TryRespondAsync(IBuffer)](smartcardemulatorapdureceivedeventargs_tryrespondasync_1062726120.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md index 33aece2185..8806fb9bbf 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync(Windows.Storage.Streams.IBuffer,Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep}) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync ## -description Attempts to respond to an APDU, placing cryptograms in the outgoing message as instructed by the placement steps. ## -parameters ### -param responseTemplate A buffer containing a template response. ### -param cryptogramPlacementSteps A collection that contains the cryptogram steps. ## -returns Returns an asynchronous operation that completes with an operation status. ## -remarks ## -examples ## -see-also [TryRespondWithCryptogramsAsync(IBuffer, IIterable(SmartCardCryptogramPlacementStep), IReference(UInt32))](smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_429873224.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync(Windows.Storage.Streams.IBuffer,Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep}) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync + +## -description +Attempts to respond to an APDU, placing cryptograms in the outgoing message as instructed by the placement steps. + +## -parameters +### -param responseTemplate +A buffer containing a template response. + +### -param cryptogramPlacementSteps +A collection that contains the cryptogram steps. + +## -returns +Returns an asynchronous operation that completes with an operation status. + +## -remarks + +## -examples + +## -see-also +[TryRespondWithCryptogramsAsync(IBuffer, IIterable(SmartCardCryptogramPlacementStep), IReference(UInt32))](smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_429873224.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_429873224.md b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_429873224.md index 8afd72319a..cafebef7a6 100644 --- a/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_429873224.md +++ b/windows.devices.smartcards/smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_429873224.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync(Windows.Storage.Streams.IBuffer,Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep},Windows.Foundation.IReference{System.UInt32}) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync ## -description Returns an asynchronous operation that completes with an operation status. ## -parameters ### -param responseTemplate A buffer that contains a template response. ### -param cryptogramPlacementSteps A collection that contains the cryptogram steps. ### -param nextState A reference that contains the next state. ## -returns Returns an asynchronous operation that completes with an operation status. ## -remarks ## -examples ## -see-also [TryRespondWithCryptogramsAsync(IBuffer, IIterable(SmartCardCryptogramPlacementStep))](smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync(Windows.Storage.Streams.IBuffer,Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep},Windows.Foundation.IReference{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorApduReceivedEventArgs.TryRespondWithCryptogramsAsync + +## -description +Returns an asynchronous operation that completes with an operation status. + +## -parameters +### -param responseTemplate +A buffer that contains a template response. + +### -param cryptogramPlacementSteps +A collection that contains the cryptogram steps. + +### -param nextState +A reference that contains the next state. + +## -returns +Returns an asynchronous operation that completes with an operation status. + +## -remarks + +## -examples + +## -see-also +[TryRespondWithCryptogramsAsync(IBuffer, IIterable(SmartCardCryptogramPlacementStep))](smartcardemulatorapdureceivedeventargs_tryrespondwithcryptogramsasync_340048536.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs.md b/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs.md index e789ef8b8e..a28b156ac6 100644 --- a/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs.md +++ b/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs ## -description Provides data for the [ConnectionDeactivated](smartcardemulator_connectiondeactivated.md) event. ## -remarks The system generates an instance of this class and passes it as an argument to the application's [ConnectionDeactivated](smartcardemulator_connectiondeactivated.md) event handler. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs + +## -description +Provides data for the [ConnectionDeactivated](smartcardemulator_connectiondeactivated.md) event. + +## -remarks +The system generates an instance of this class and passes it as an argument to the application's [ConnectionDeactivated](smartcardemulator_connectiondeactivated.md) event handler. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_connectionproperties.md b/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_connectionproperties.md index 1f65f61d45..a6ed7ac750 100644 --- a/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_connectionproperties.md +++ b/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_connectionproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.ConnectionProperties --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.ConnectionProperties ## -description Gets the connection properties for the smart card emulator. ## -property-value The connection properties for the smart card emulator. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.ConnectionProperties +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.ConnectionProperties + +## -description +Gets the connection properties for the smart card emulator. + +## -property-value +The connection properties for the smart card emulator. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_reason.md b/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_reason.md index 212b61a9d1..d968bafb46 100644 --- a/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_reason.md +++ b/windows.devices.smartcards/smartcardemulatorconnectiondeactivatedeventargs_reason.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.Reason --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.Reason ## -description Gets the reason that the smart card connection to the NFC reader was deactivated. ## -property-value The reason that the smart card connection to the NFC reader was deactivated. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorConnectionDeactivatedEventArgs.Reason + +## -description +Gets the reason that the smart card connection to the NFC reader was deactivated. + +## -property-value +The reason that the smart card connection to the NFC reader was deactivated. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorconnectionproperties.md b/windows.devices.smartcards/smartcardemulatorconnectionproperties.md index f65aa52b19..ef2bd1f5fe 100644 --- a/windows.devices.smartcards/smartcardemulatorconnectionproperties.md +++ b/windows.devices.smartcards/smartcardemulatorconnectionproperties.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties ## -description Provides information about a smart card emulator connection to an NFC reader. ## -remarks TODO: Document how the developer can obtain this class object, and add or update retriever elements as necessary. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties + +## -description +Provides information about a smart card emulator connection to an NFC reader. + +## -remarks +TODO: Document how the developer can obtain this class object, and add or update retriever elements as necessary. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorconnectionproperties_id.md b/windows.devices.smartcards/smartcardemulatorconnectionproperties_id.md index 5f88ee786c..2b19343b91 100644 --- a/windows.devices.smartcards/smartcardemulatorconnectionproperties_id.md +++ b/windows.devices.smartcards/smartcardemulatorconnectionproperties_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Id --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Id ## -description Gets the identifier for the connection. ## -property-value The identifier for the connection. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Id +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Id + +## -description +Gets the identifier for the connection. + +## -property-value +The identifier for the connection. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardemulatorconnectionproperties_source.md b/windows.devices.smartcards/smartcardemulatorconnectionproperties_source.md index a3752eb984..41f6280b08 100644 --- a/windows.devices.smartcards/smartcardemulatorconnectionproperties_source.md +++ b/windows.devices.smartcards/smartcardemulatorconnectionproperties_source.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Source --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Source ## -description Gets an enum value indicating if the connection is to an NFC reader or something else. ## -property-value An enum value indicating if the connection is to an NFC reader or something else. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Source +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulatorConnectionProperties.Source + +## -description +Gets an enum value indicating if the connection is to an NFC reader or something else. + +## -property-value +An enum value indicating if the connection is to an NFC reader or something else. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy.md b/windows.devices.smartcards/smartcardpinpolicy.md index 97f96692f5..eab4980c24 100644 --- a/windows.devices.smartcards/smartcardpinpolicy.md +++ b/windows.devices.smartcards/smartcardpinpolicy.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardPinPolicy --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardPinPolicy ## -description Represents a set of personal identification number (PIN) rules on a Trusted Platform Module (TPM) virtual smart card. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardPinPolicy +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy + +## -description +Represents a set of personal identification number (PIN) rules on a Trusted Platform Module (TPM) virtual smart card. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy_digits.md b/windows.devices.smartcards/smartcardpinpolicy_digits.md index 2eb20c2381..857b08032c 100644 --- a/windows.devices.smartcards/smartcardpinpolicy_digits.md +++ b/windows.devices.smartcards/smartcardpinpolicy_digits.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.Digits --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinPolicy.Digits ## -description Gets or sets whether number characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. ## -property-value One of the enumeration values, representing whether number characters are allowed. ## -remarks The default value is to allow number characters. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.Digits +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy.Digits + +## -description +Gets or sets whether number characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. + +## -property-value +One of the enumeration values, representing whether number characters are allowed. + +## -remarks +The default value is to allow number characters. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy_lowercaseletters.md b/windows.devices.smartcards/smartcardpinpolicy_lowercaseletters.md index bbc7357d90..1fe261e20e 100644 --- a/windows.devices.smartcards/smartcardpinpolicy_lowercaseletters.md +++ b/windows.devices.smartcards/smartcardpinpolicy_lowercaseletters.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.LowercaseLetters --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinPolicy.LowercaseLetters ## -description Gets or sets whether lowercase letter characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. ## -property-value One of the enumeration values, representing whether lowercase letter characters are allowed. ## -remarks The default value is to allow lowercase letter characters. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.LowercaseLetters +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy.LowercaseLetters + +## -description +Gets or sets whether lowercase letter characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. + +## -property-value +One of the enumeration values, representing whether lowercase letter characters are allowed. + +## -remarks +The default value is to allow lowercase letter characters. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy_maxlength.md b/windows.devices.smartcards/smartcardpinpolicy_maxlength.md index da967bf180..d53bce69a2 100644 --- a/windows.devices.smartcards/smartcardpinpolicy_maxlength.md +++ b/windows.devices.smartcards/smartcardpinpolicy_maxlength.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.MaxLength --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinPolicy.MaxLength ## -description Gets or sets the maximum character length for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. ## -property-value The maximum character length. ## -remarks The lowest allowed maximum character length is 4. The highest allowed maximum character length is 127. The default maximum character length is 127. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.MaxLength +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy.MaxLength + +## -description +Gets or sets the maximum character length for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. + +## -property-value +The maximum character length. + +## -remarks +The lowest allowed maximum character length is 4. + +The highest allowed maximum character length is 127. + +The default maximum character length is 127. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy_minlength.md b/windows.devices.smartcards/smartcardpinpolicy_minlength.md index deae43c38e..31e43b1464 100644 --- a/windows.devices.smartcards/smartcardpinpolicy_minlength.md +++ b/windows.devices.smartcards/smartcardpinpolicy_minlength.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.MinLength --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinPolicy.MinLength ## -description Gets or sets the minimum character length for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. ## -property-value The minimum character length. ## -remarks The lowest allowed minimum character length is 4. The highest allowed minimum character length is 127. The default minimum character length is 8. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.MinLength +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy.MinLength + +## -description +Gets or sets the minimum character length for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. + +## -property-value +The minimum character length. + +## -remarks +The lowest allowed minimum character length is 4. + +The highest allowed minimum character length is 127. + +The default minimum character length is 8. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy_smartcardpinpolicy_1221375020.md b/windows.devices.smartcards/smartcardpinpolicy_smartcardpinpolicy_1221375020.md index fa6be93695..4688f53a7a 100644 --- a/windows.devices.smartcards/smartcardpinpolicy_smartcardpinpolicy_1221375020.md +++ b/windows.devices.smartcards/smartcardpinpolicy_smartcardpinpolicy_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardPinPolicy.#ctor --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardPinPolicy.SmartCardPinPolicy ## -description Creates and initializes a new instance of a set of personal identification number (PIN) rules on a Trusted Platform Module (TPM) virtual smart card. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardPinPolicy.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy.SmartCardPinPolicy + +## -description +Creates and initializes a new instance of a set of personal identification number (PIN) rules on a Trusted Platform Module (TPM) virtual smart card. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinpolicy_uppercaseletters.md b/windows.devices.smartcards/smartcardpinpolicy_uppercaseletters.md index bfec4168c7..a607097a84 100644 --- a/windows.devices.smartcards/smartcardpinpolicy_uppercaseletters.md +++ b/windows.devices.smartcards/smartcardpinpolicy_uppercaseletters.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.UppercaseLetters --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinPolicy.UppercaseLetters ## -description Gets or sets whether uppercase letter characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. ## -property-value One of the enumeration values, representing whether uppercase letter characters are allowed. ## -remarks The default value is to allow uppercase letter characters. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinPolicy.UppercaseLetters +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinPolicy.UppercaseLetters + +## -description +Gets or sets whether uppercase letter characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card. + +## -property-value +One of the enumeration values, representing whether uppercase letter characters are allowed. + +## -remarks +The default value is to allow uppercase letter characters. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetdeferral.md b/windows.devices.smartcards/smartcardpinresetdeferral.md index 7a53ee9f8c..abf3cb07e9 100644 --- a/windows.devices.smartcards/smartcardpinresetdeferral.md +++ b/windows.devices.smartcards/smartcardpinresetdeferral.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardPinResetDeferral --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardPinResetDeferral ## -description Represents a wait time for a requested smart card personal identification number (PIN) reset. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardPinResetDeferral +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetDeferral + +## -description +Represents a wait time for a requested smart card personal identification number (PIN) reset. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetdeferral_complete_1807836922.md b/windows.devices.smartcards/smartcardpinresetdeferral_complete_1807836922.md index f2e8621281..a9afbaae81 100644 --- a/windows.devices.smartcards/smartcardpinresetdeferral_complete_1807836922.md +++ b/windows.devices.smartcards/smartcardpinresetdeferral_complete_1807836922.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardPinResetDeferral.Complete --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardPinResetDeferral.Complete ## -description Returns a wait time completion for a smart card personal identification number (PIN) reset. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardPinResetDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetDeferral.Complete + +## -description +Returns a wait time completion for a smart card personal identification number (PIN) reset. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetrequest.md b/windows.devices.smartcards/smartcardpinresetrequest.md index ab402641a4..15769b7aba 100644 --- a/windows.devices.smartcards/smartcardpinresetrequest.md +++ b/windows.devices.smartcards/smartcardpinresetrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardPinResetRequest --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardPinResetRequest ## -description Represents a smart card personal identification number (PIN) reset request. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardPinResetRequest +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetRequest + +## -description +Represents a smart card personal identification number (PIN) reset request. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetrequest_challenge.md b/windows.devices.smartcards/smartcardpinresetrequest_challenge.md index 77ee781da5..94a6e30003 100644 --- a/windows.devices.smartcards/smartcardpinresetrequest_challenge.md +++ b/windows.devices.smartcards/smartcardpinresetrequest_challenge.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinResetRequest.Challenge --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinResetRequest.Challenge ## -description Gets the smart card's challenge value. ## -property-value The smart card's challenge value. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinResetRequest.Challenge +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetRequest.Challenge + +## -description +Gets the smart card's challenge value. + +## -property-value +The smart card's challenge value. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetrequest_deadline.md b/windows.devices.smartcards/smartcardpinresetrequest_deadline.md index 0d2ae01515..ea559beda4 100644 --- a/windows.devices.smartcards/smartcardpinresetrequest_deadline.md +++ b/windows.devices.smartcards/smartcardpinresetrequest_deadline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardPinResetRequest.Deadline --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardPinResetRequest.Deadline ## -description Gets the length of time to wait before requesting the smart card personal identification number (PIN) reset. ## -property-value The length of time to wait before requesting the smart card PIN reset. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardPinResetRequest.Deadline +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetRequest.Deadline + +## -description +Gets the length of time to wait before requesting the smart card personal identification number (PIN) reset. + +## -property-value +The length of time to wait before requesting the smart card PIN reset. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetrequest_getdeferral_254836512.md b/windows.devices.smartcards/smartcardpinresetrequest_getdeferral_254836512.md index 8666376d7d..e9809979d5 100644 --- a/windows.devices.smartcards/smartcardpinresetrequest_getdeferral_254836512.md +++ b/windows.devices.smartcards/smartcardpinresetrequest_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardPinResetRequest.GetDeferral --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardPinResetRequest.GetDeferral ## -description Gets an instance of a wait time for a requested smart card personal identification number (PIN) reset. ## -returns An instance of a wait time for a requested smart card PIN reset. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardPinResetRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetRequest.GetDeferral + +## -description +Gets an instance of a wait time for a requested smart card personal identification number (PIN) reset. + +## -returns +An instance of a wait time for a requested smart card PIN reset. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardpinresetrequest_setresponse_1059394790.md b/windows.devices.smartcards/smartcardpinresetrequest_setresponse_1059394790.md index db2dbcb150..874e350020 100644 --- a/windows.devices.smartcards/smartcardpinresetrequest_setresponse_1059394790.md +++ b/windows.devices.smartcards/smartcardpinresetrequest_setresponse_1059394790.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardPinResetRequest.SetResponse(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardPinResetRequest.SetResponse ## -description Sets the response to a smart card authentication challenge/response operation. ## -parameters ### -param response The response to a smart card authentication challenge/response operation. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardPinResetRequest.SetResponse(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardPinResetRequest.SetResponse + +## -description +Sets the response to a smart card authentication challenge/response operation. + +## -parameters +### -param response +The response to a smart card authentication challenge/response operation. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning.md b/windows.devices.smartcards/smartcardprovisioning.md index f8128e8bb0..2765eb5855 100644 --- a/windows.devices.smartcards/smartcardprovisioning.md +++ b/windows.devices.smartcards/smartcardprovisioning.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardProvisioning --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardProvisioning ## -description Represents info about, and operations for, configuring smart cards. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardProvisioning +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning + +## -description +Represents info about, and operations for, configuring smart cards. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_fromsmartcardasync_967054582.md b/windows.devices.smartcards/smartcardprovisioning_fromsmartcardasync_967054582.md index e0dce7ddb4..062cce04d4 100644 --- a/windows.devices.smartcards/smartcardprovisioning_fromsmartcardasync_967054582.md +++ b/windows.devices.smartcards/smartcardprovisioning_fromsmartcardasync_967054582.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.FromSmartCardAsync(Windows.Devices.SmartCards.SmartCard) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.FromSmartCardAsync ## -description Returns a smart card to be configured. ## -parameters ### -param card The specified smart card. ## -returns An instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the smart card to be configured. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.FromSmartCardAsync(Windows.Devices.SmartCards.SmartCard) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.FromSmartCardAsync + +## -description +Returns a smart card to be configured. + +## -parameters +### -param card +The specified smart card. + +## -returns +An instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the smart card to be configured. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_getauthoritykeycontainernameasync_65153950.md b/windows.devices.smartcards/smartcardprovisioning_getauthoritykeycontainernameasync_65153950.md index 13cdea78bd..723ec7e116 100644 --- a/windows.devices.smartcards/smartcardprovisioning_getauthoritykeycontainernameasync_65153950.md +++ b/windows.devices.smartcards/smartcardprovisioning_getauthoritykeycontainernameasync_65153950.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetAuthorityKeyContainerNameAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.GetAuthorityKeyContainerNameAsync ## -description Asynchronously gets the name of the authority key container. ## -returns An async operation that provides access to a string containing the name of the authority key container. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetAuthorityKeyContainerNameAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.GetAuthorityKeyContainerNameAsync + +## -description +Asynchronously gets the name of the authority key container. + +## -returns +An async operation that provides access to a string containing the name of the authority key container. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_getchallengecontextasync_431702420.md b/windows.devices.smartcards/smartcardprovisioning_getchallengecontextasync_431702420.md index d4c36e18f9..07371b75e7 100644 --- a/windows.devices.smartcards/smartcardprovisioning_getchallengecontextasync_431702420.md +++ b/windows.devices.smartcards/smartcardprovisioning_getchallengecontextasync_431702420.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetChallengeContextAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.GetChallengeContextAsync ## -description Returns a smart card's authentication challenge/response context. ## -returns After the asynchronous operation completes, returns an instance of [SmartCardChalllengeContext](smartcardchallengecontext.md), representing the smart card's authentication challenge/response context. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetChallengeContextAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.GetChallengeContextAsync + +## -description +Returns a smart card's authentication challenge/response context. + +## -returns +After the asynchronous operation completes, returns an instance of [SmartCardChalllengeContext](smartcardchallengecontext.md), representing the smart card's authentication challenge/response context. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_getidasync_2075207405.md b/windows.devices.smartcards/smartcardprovisioning_getidasync_2075207405.md index 6dd6d31d6b..af40090e96 100644 --- a/windows.devices.smartcards/smartcardprovisioning_getidasync_2075207405.md +++ b/windows.devices.smartcards/smartcardprovisioning_getidasync_2075207405.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetIdAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.GetIdAsync ## -description Returns the smart card's ID. ## -returns After the asynchronous operation completes, returns the smart card's ID. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetIdAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.GetIdAsync + +## -description +Returns the smart card's ID. + +## -returns +After the asynchronous operation completes, returns the smart card's ID. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_getnameasync_901540059.md b/windows.devices.smartcards/smartcardprovisioning_getnameasync_901540059.md index ce4b325fe3..4f2b370d0d 100644 --- a/windows.devices.smartcards/smartcardprovisioning_getnameasync_901540059.md +++ b/windows.devices.smartcards/smartcardprovisioning_getnameasync_901540059.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetNameAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.GetNameAsync ## -description Returns the smart card's minidriver name. ## -returns After the asynchronous operation completes, returns the smart card's name. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.GetNameAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.GetNameAsync + +## -description +Returns the smart card's minidriver name. + +## -returns +After the asynchronous operation completes, returns the smart card's name. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_1655839242.md b/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_1655839242.md index a96e27795a..52b0507dd7 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_1655839242.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_1655839242.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync ## -description Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters. ## -parameters ### -param friendlyName The smart card's human-readable name. ### -param administrativeKey The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). ### -param pinPolicy The smart card's PIN rules set. ## -returns After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. ## -remarks When this method is called, it displays a UI to get the PIN from the user. ## -examples ## -see-also [RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid)](smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_794718138.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync + +## -description +Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters. + +## -parameters +### -param friendlyName +The smart card's human-readable name. + +### -param administrativeKey +The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). + +### -param pinPolicy +The smart card's PIN rules set. + +## -returns +After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. + +## -remarks +When this method is called, it displays a UI to get the PIN from the user. + +## -examples + +## -see-also +[RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid)](smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_794718138.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_794718138.md b/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_794718138.md index 85946b12ad..accd04587f 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_794718138.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_794718138.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy,System.Guid) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync ## -description Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters. ## -parameters ### -param friendlyName The smart card's human-readable name. ### -param administrativeKey The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). ### -param pinPolicy The smart card's PIN rules set. ### -param cardId The smart card's ID. ## -returns After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. ## -remarks When this method is called, it displays a UI to get the PIN from the user. ## -examples ## -see-also [RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy)](smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_1655839242.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestAttestedVirtualSmartCardCreationAsync + +## -description +Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters. + +## -parameters +### -param friendlyName +The smart card's human-readable name. + +### -param administrativeKey +The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). + +### -param pinPolicy +The smart card's PIN rules set. + +### -param cardId +The smart card's ID. + +## -returns +After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. + +## -remarks +When this method is called, it displays a UI to get the PIN from the user. + +## -examples + +## -see-also +[RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy)](smartcardprovisioning_requestattestedvirtualsmartcardcreationasync_1655839242.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestpinchangeasync_482471191.md b/windows.devices.smartcards/smartcardprovisioning_requestpinchangeasync_482471191.md index 3c9c5b4667..addfbee089 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestpinchangeasync_482471191.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestpinchangeasync_482471191.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinChangeAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinChangeAsync ## -description Changes a smart card's personal identification number (PIN). ## -returns After the smart card PIN change attempt completes, returns true if the smart card's PIN was successfully changed; otherwise false. ## -remarks When this method is called, it displays a UI to get the PIN from the user. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinChangeAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinChangeAsync + +## -description +Changes a smart card's personal identification number (PIN). + +## -returns +After the smart card PIN change attempt completes, returns true if the smart card's PIN was successfully changed; otherwise false. + +## -remarks +When this method is called, it displays a UI to get the PIN from the user. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestpinresetasync_219367483.md b/windows.devices.smartcards/smartcardprovisioning_requestpinresetasync_219367483.md index 37c09b885a..51820f3e48 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestpinresetasync_219367483.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestpinresetasync_219367483.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinResetAsync(Windows.Devices.SmartCards.SmartCardPinResetHandler) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinResetAsync ## -description Resets a smart card's personal identification number (PIN). ## -parameters ### -param handler The method that handles the smart card PIN reset. ## -returns After the smart card PIN reset attempt completes, returns true if the smart card's PIN was successfully reset; otherwise false. ## -remarks When this method is called, it displays a UI to get the PIN from the user. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinResetAsync(Windows.Devices.SmartCards.SmartCardPinResetHandler) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestPinResetAsync + +## -description +Resets a smart card's personal identification number (PIN). + +## -parameters +### -param handler +The method that handles the smart card PIN reset. + +## -returns +After the smart card PIN reset attempt completes, returns true if the smart card's PIN was successfully reset; otherwise false. + +## -remarks +When this method is called, it displays a UI to get the PIN from the user. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_1650468110.md b/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_1650468110.md index 8380f4c8d2..92b198e4b8 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_1650468110.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_1650468110.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy,System.Guid) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync ## -description Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, personal identification number (PIN) rules set, and ID. ## -parameters ### -param friendlyName The smart card's human-readable name. ### -param administrativeKey The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). ### -param pinPolicy The smart card's PIN rules set. ### -param cardId The smart card's ID. ## -returns After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. ## -remarks When this method is called, it displays a UI to get the PIN from the user. ## -examples ## -see-also [RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy)](smartcardprovisioning_requestvirtualsmartcardcreationasync_797724862.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync + +## -description +Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, personal identification number (PIN) rules set, and ID. + +## -parameters +### -param friendlyName +The smart card's human-readable name. + +### -param administrativeKey +The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). + +### -param pinPolicy +The smart card's PIN rules set. + +### -param cardId +The smart card's ID. + +## -returns +After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. + +## -remarks +When this method is called, it displays a UI to get the PIN from the user. + +## -examples + +## -see-also +[RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy)](smartcardprovisioning_requestvirtualsmartcardcreationasync_797724862.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_797724862.md b/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_797724862.md index f560ff29c2..068dcda14a 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_797724862.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcardcreationasync_797724862.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync ## -description Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, and personal identification number (PIN) rules set. ## -parameters ### -param friendlyName The smart card's human-readable name. ### -param administrativeKey The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). ### -param pinPolicy The smart card's PIN rules set. ## -returns After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. ## -remarks When this method is called, it displays a UI to get the PIN from the user. ## -examples ## -see-also [RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid)](smartcardprovisioning_requestvirtualsmartcardcreationasync_1650468110.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync(System.String,Windows.Storage.Streams.IBuffer,Windows.Devices.SmartCards.SmartCardPinPolicy) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardCreationAsync + +## -description +Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, and personal identification number (PIN) rules set. + +## -parameters +### -param friendlyName +The smart card's human-readable name. + +### -param administrativeKey +The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). + +### -param pinPolicy +The smart card's PIN rules set. + +## -returns +After the operation completes, returns an instance of [SmartCardProvisioning](smartcardprovisioning.md), representing the configured TPM virtual smart card. + +## -remarks +When this method is called, it displays a UI to get the PIN from the user. + +## -examples + +## -see-also +[RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid)](smartcardprovisioning_requestvirtualsmartcardcreationasync_1650468110.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcarddeletionasync_566115327.md b/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcarddeletionasync_566115327.md index 9f772f11d4..fdd7456282 100644 --- a/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcarddeletionasync_566115327.md +++ b/windows.devices.smartcards/smartcardprovisioning_requestvirtualsmartcarddeletionasync_566115327.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardDeletionAsync(Windows.Devices.SmartCards.SmartCard) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardDeletionAsync ## -description Deletes a Trusted Platform Module (TPM) virtual smart card. ## -parameters ### -param card The TPM virtual smart card to delete. ## -returns After the deletion attempt completes, returns true if the TPM virtual smart card was successfully deleted; otherwise false. ## -remarks When this method is called, it displays a UI to enable the user to consent to the deletion. ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardDeletionAsync(Windows.Devices.SmartCards.SmartCard) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.RequestVirtualSmartCardDeletionAsync + +## -description +Deletes a Trusted Platform Module (TPM) virtual smart card. + +## -parameters +### -param card +The TPM virtual smart card to delete. + +## -returns +After the deletion attempt completes, returns true if the TPM virtual smart card was successfully deleted; otherwise false. + +## -remarks +When this method is called, it displays a UI to enable the user to consent to the deletion. + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardprovisioning_smartcard.md b/windows.devices.smartcards/smartcardprovisioning_smartcard.md index 74b11c9ff6..91c3dd2774 100644 --- a/windows.devices.smartcards/smartcardprovisioning_smartcard.md +++ b/windows.devices.smartcards/smartcardprovisioning_smartcard.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardProvisioning.SmartCard --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardProvisioning.SmartCard ## -description Gets the configured smart card. ## -property-value The configured smart card. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardProvisioning.SmartCard +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardProvisioning.SmartCard + +## -description +Gets the configured smart card. + +## -property-value +The configured smart card. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader.md b/windows.devices.smartcards/smartcardreader.md index c52f863bb7..67b772b9c9 100644 --- a/windows.devices.smartcards/smartcardreader.md +++ b/windows.devices.smartcards/smartcardreader.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardReader --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardReader ## -description Represents info about a smart card reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardReader +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardReader + +## -description +Represents info about a smart card reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_cardadded.md b/windows.devices.smartcards/smartcardreader_cardadded.md index 1e911e0116..dd8bc065ab 100644 --- a/windows.devices.smartcards/smartcardreader_cardadded.md +++ b/windows.devices.smartcards/smartcardreader_cardadded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.SmartCards.SmartCardReader.CardAdded --api-type: winrt event ---- # Windows.Devices.SmartCards.SmartCardReader.CardAdded ## -description Occurs when a smart card is inserted into the smart card reader or tapped on an NFC reader. ## -remarks ## -examples ## -see-also [CardAddedEventArgs](cardaddedeventargs.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: E:Windows.Devices.SmartCards.SmartCardReader.CardAdded +-api-type: winrt event +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.CardAdded + +## -description +Occurs when a smart card is inserted into the smart card reader or tapped on an NFC reader. + +## -remarks + +## -examples + +## -see-also +[CardAddedEventArgs](cardaddedeventargs.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_cardremoved.md b/windows.devices.smartcards/smartcardreader_cardremoved.md index 15c223e6d1..e15c149fec 100644 --- a/windows.devices.smartcards/smartcardreader_cardremoved.md +++ b/windows.devices.smartcards/smartcardreader_cardremoved.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.SmartCards.SmartCardReader.CardRemoved --api-type: winrt event ---- # Windows.Devices.SmartCards.SmartCardReader.CardRemoved ## -description Occurs when a smart card is taken out of the smart card reader. ## -remarks ## -examples ## -see-also [CardRemovedEventArgs](cardremovedeventargs.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: E:Windows.Devices.SmartCards.SmartCardReader.CardRemoved +-api-type: winrt event +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.CardRemoved + +## -description +Occurs when a smart card is taken out of the smart card reader. + +## -remarks + +## -examples + +## -see-also +[CardRemovedEventArgs](cardremovedeventargs.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_deviceid.md b/windows.devices.smartcards/smartcardreader_deviceid.md index 0a9c4ebd78..fbabbf5576 100644 --- a/windows.devices.smartcards/smartcardreader_deviceid.md +++ b/windows.devices.smartcards/smartcardreader_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardReader.DeviceId --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardReader.DeviceId ## -description Gets the smart card reader's device ID. ## -property-value The smart card reader's device ID. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardReader.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.DeviceId + +## -description +Gets the smart card reader's device ID. + +## -property-value +The smart card reader's device ID. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_findallcardsasync_1797660520.md b/windows.devices.smartcards/smartcardreader_findallcardsasync_1797660520.md index 836cec8b84..43d75d5844 100644 --- a/windows.devices.smartcards/smartcardreader_findallcardsasync_1797660520.md +++ b/windows.devices.smartcards/smartcardreader_findallcardsasync_1797660520.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardReader.FindAllCardsAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardReader.FindAllCardsAsync ## -description Returns a list of info about all smart cards that are connected to the smart card reader. ## -returns After the operation completes, returns the list of info about all smart cards that are connected to the smart card reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardReader.FindAllCardsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.FindAllCardsAsync + +## -description +Returns a list of info about all smart cards that are connected to the smart card reader. + +## -returns +After the operation completes, returns the list of info about all smart cards that are connected to the smart card reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_fromidasync_1322863552.md b/windows.devices.smartcards/smartcardreader_fromidasync_1322863552.md index 3b6f3c17d6..949572a235 100644 --- a/windows.devices.smartcards/smartcardreader_fromidasync_1322863552.md +++ b/windows.devices.smartcards/smartcardreader_fromidasync_1322863552.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardReader.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardReader.FromIdAsync ## -description Returns a smart card reader that matches the specified device ID. ## -parameters ### -param deviceId The smart card reader's device ID. ## -returns The matching smart card reader. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardReader.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.FromIdAsync + +## -description +Returns a smart card reader that matches the specified device ID. + +## -parameters +### -param deviceId +The smart card reader's device ID. + +## -returns +The matching smart card reader. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_getdeviceselector_1037956577.md b/windows.devices.smartcards/smartcardreader_getdeviceselector_1037956577.md index d1195aad01..b0e901420c 100644 --- a/windows.devices.smartcards/smartcardreader_getdeviceselector_1037956577.md +++ b/windows.devices.smartcards/smartcardreader_getdeviceselector_1037956577.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector(Windows.Devices.SmartCards.SmartCardReaderKind) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector ## -description Returns an Advanced Query Syntax (AQS) string representing a set of a specific type of smart card readers connected to the device. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to enumerate the given set of smart card readers. ## -parameters ### -param kind One of the enumeration values, representing a specific smart card reader type. ## -returns The Advanced Query Syntax (AQS) string representing a set of the specified type of smart card readers connected to the device. ## -remarks For info about AQS, see [Using Advanced Query Syntax Programmatically](http://msdn.microsoft.com/library/76e33903-d063-48c0-9afe-912c3daa8237). ## -examples ## -see-also [GetDeviceSelector](smartcardreader_getdeviceselector_838466080.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector(Windows.Devices.SmartCards.SmartCardReaderKind) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector + +## -description +Returns an Advanced Query Syntax (AQS) string representing a set of a specific type of smart card readers connected to the device. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to enumerate the given set of smart card readers. + +## -parameters +### -param kind +One of the enumeration values, representing a specific smart card reader type. + +## -returns +The Advanced Query Syntax (AQS) string representing a set of the specified type of smart card readers connected to the device. + +## -remarks +For info about AQS, see [Using Advanced Query Syntax Programmatically](http://msdn.microsoft.com/library/76e33903-d063-48c0-9afe-912c3daa8237). + +## -examples + +## -see-also +[GetDeviceSelector](smartcardreader_getdeviceselector_838466080.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_getdeviceselector_838466080.md b/windows.devices.smartcards/smartcardreader_getdeviceselector_838466080.md index 92f31ac7bb..d824632a05 100644 --- a/windows.devices.smartcards/smartcardreader_getdeviceselector_838466080.md +++ b/windows.devices.smartcards/smartcardreader_getdeviceselector_838466080.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector ## -description Returns an Advanced Query Syntax (AQS) string representing all smart card readers connected to the device. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to enumerate the given set of smart card readers. ## -returns The Advanced Query Syntax (AQS) string representing all smart card readers connected to the device. ## -remarks For info about AQS, see [Using Advanced Query Syntax Programmatically](http://msdn.microsoft.com/library/76e33903-d063-48c0-9afe-912c3daa8237). ## -examples ## -see-also [GetDeviceSelector(SmartCardReaderKind)](smartcardreader_getdeviceselector_1037956577.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.GetDeviceSelector + +## -description +Returns an Advanced Query Syntax (AQS) string representing all smart card readers connected to the device. This string is passed to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to enumerate the given set of smart card readers. + +## -returns +The Advanced Query Syntax (AQS) string representing all smart card readers connected to the device. + +## -remarks +For info about AQS, see [Using Advanced Query Syntax Programmatically](http://msdn.microsoft.com/library/76e33903-d063-48c0-9afe-912c3daa8237). + +## -examples + +## -see-also +[GetDeviceSelector(SmartCardReaderKind)](smartcardreader_getdeviceselector_1037956577.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_getstatusasync_240032933.md b/windows.devices.smartcards/smartcardreader_getstatusasync_240032933.md index b29ffce6f9..f60933b9cf 100644 --- a/windows.devices.smartcards/smartcardreader_getstatusasync_240032933.md +++ b/windows.devices.smartcards/smartcardreader_getstatusasync_240032933.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardReader.GetStatusAsync --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardReader.GetStatusAsync ## -description Returns the smart card reader's status. ## -returns After the status request completes, returns one of the [SmartCardReaderStatus](smartcardreaderstatus.md) enumeration values, representing the smart card reader's status. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardReader.GetStatusAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.GetStatusAsync + +## -description +Returns the smart card reader's status. + +## -returns +After the status request completes, returns one of the [SmartCardReaderStatus](smartcardreaderstatus.md) enumeration values, representing the smart card reader's status. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_kind.md b/windows.devices.smartcards/smartcardreader_kind.md index e5db12e698..b12d19ac4c 100644 --- a/windows.devices.smartcards/smartcardreader_kind.md +++ b/windows.devices.smartcards/smartcardreader_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardReader.Kind --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardReader.Kind ## -description Gets the smart card reader's type. ## -property-value One of the enumeration values, representing the smart card reader's type. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardReader.Kind +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.Kind + +## -description +Gets the smart card reader's type. + +## -property-value +One of the enumeration values, representing the smart card reader's type. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardreader_name.md b/windows.devices.smartcards/smartcardreader_name.md index e702e1df9b..a79ede04b6 100644 --- a/windows.devices.smartcards/smartcardreader_name.md +++ b/windows.devices.smartcards/smartcardreader_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardReader.Name --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardReader.Name ## -description Gets the smart card reader's device name. ## -property-value The smart card reader's device name. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardReader.Name +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardReader.Name + +## -description +Gets the smart card reader's device name. + +## -property-value +The smart card reader's device name. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails.md b/windows.devices.smartcards/smartcardtriggerdetails.md index 176bee58f8..44af732934 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails.md +++ b/windows.devices.smartcards/smartcardtriggerdetails.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.SmartCards.SmartCardTriggerDetails --api-type: winrt class ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails ## -description Provides details about a smart card trigger. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails + +## -description +Provides details about a smart card trigger. + +## -remarks + + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails_emulator.md b/windows.devices.smartcards/smartcardtriggerdetails_emulator.md index 9105c7b3a6..a266f87905 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails_emulator.md +++ b/windows.devices.smartcards/smartcardtriggerdetails_emulator.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.Emulator --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails.Emulator ## -description Gets the smart card emulator that caused the event to trigger. ## -property-value The smart card emulator that caused the event to trigger. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.Emulator +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.Emulator + +## -description +Gets the smart card emulator that caused the event to trigger. + +## -property-value +The smart card emulator that caused the event to trigger. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails_sourceappletid.md b/windows.devices.smartcards/smartcardtriggerdetails_sourceappletid.md index 861d8a392e..996887af9d 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails_sourceappletid.md +++ b/windows.devices.smartcards/smartcardtriggerdetails_sourceappletid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.SourceAppletId --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails.SourceAppletId ## -description Gets the applet ID of the source of the smart card trigger. ## -property-value The applet ID. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.SourceAppletId +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.SourceAppletId + +## -description +Gets the applet ID of the source of the smart card trigger. + +## -property-value +The applet ID. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails_triggerdata.md b/windows.devices.smartcards/smartcardtriggerdetails_triggerdata.md index 528dc8f7f0..f7263eb9ca 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails_triggerdata.md +++ b/windows.devices.smartcards/smartcardtriggerdetails_triggerdata.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerData --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerData ## -description Gets the smart card trigger data. ## -property-value The smart card trigger data. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerData +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerData + +## -description +Gets the smart card trigger data. + +## -property-value +The smart card trigger data. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails_triggertype.md b/windows.devices.smartcards/smartcardtriggerdetails_triggertype.md index 27dbe4b4bd..86d3da0ede 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails_triggertype.md +++ b/windows.devices.smartcards/smartcardtriggerdetails_triggertype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerType --api-type: winrt property ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerType ## -description Gets the smart card trigger type. ## -property-value The smart card trigger type. ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerType +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.TriggerType + +## -description +Gets the smart card trigger type. + +## -property-value +The smart card trigger type. + +## -remarks + +## -examples + +## -see-also +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1440316395.md b/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1440316395.md index 7e7bc875c4..8a860fc815 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1440316395.md +++ b/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1440316395.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync(System.String) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync ## -description Asynchronously attempts to launch the current smart card app, passing the specified arguments. ## -parameters ### -param arguments A string specifying the arguments to pass to the smart card app at launch. ## -returns A Boolean value indicating if the app launched successfully. ## -remarks ## -examples ## -see-also [TryLaunchCurrentAppAsync(String, SmartCardLaunchBehavior)](smartcardtriggerdetails_trylaunchcurrentappasync_1866940933.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync + +## -description +Asynchronously attempts to launch the current smart card app, passing the specified arguments. + +## -parameters +### -param arguments +A string specifying the arguments to pass to the smart card app at launch. + +## -returns +A Boolean value indicating if the app launched successfully. + +## -remarks + +## -examples + +## -see-also +[TryLaunchCurrentAppAsync(String, SmartCardLaunchBehavior)](smartcardtriggerdetails_trylaunchcurrentappasync_1866940933.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1866940933.md b/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1866940933.md index 0f9eb53344..c979578a04 100644 --- a/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1866940933.md +++ b/windows.devices.smartcards/smartcardtriggerdetails_trylaunchcurrentappasync_1866940933.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync(System.String,Windows.Devices.SmartCards.SmartCardLaunchBehavior) --api-type: winrt method ---- # Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync ## -description Asynchronously attempts to launch the current smart card app using the specified behavior, passing the specified arguments. ## -parameters ### -param arguments A string specifying the arguments to pass to the smart card app at launch. ### -param behavior The behavior to use when launching the app. ## -returns A Boolean value indicating if the app launched successfully. ## -remarks ## -examples ## -see-also [TryLaunchCurrentAppAsync(String)](smartcardtriggerdetails_trylaunchcurrentappasync_1440316395.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync(System.String,Windows.Devices.SmartCards.SmartCardLaunchBehavior) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.TryLaunchCurrentAppAsync + +## -description +Asynchronously attempts to launch the current smart card app using the specified behavior, passing the specified arguments. + +## -parameters +### -param arguments +A string specifying the arguments to pass to the smart card app at launch. + +### -param behavior +The behavior to use when launching the app. + +## -returns +A Boolean value indicating if the app launched successfully. + +## -remarks + +## -examples + +## -see-also +[TryLaunchCurrentAppAsync(String)](smartcardtriggerdetails_trylaunchcurrentappasync_1440316395.md), [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_cancel_1985564044.md b/windows.devices.sms/deletesmsmessageoperation_cancel_1985564044.md index 8e96734fbf..3811d4a41f 100644 --- a/windows.devices.sms/deletesmsmessageoperation_cancel_1985564044.md +++ b/windows.devices.sms/deletesmsmessageoperation_cancel_1985564044.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.DeleteSmsMessageOperation.Cancel --api-type: winrt method ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.Cancel ## -description Cancels the asynchronous SMS message delete operation. ## -remarks ## -examples ## -see-also ## -capabilities sms \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.DeleteSmsMessageOperation.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.Cancel + +## -description +Cancels the asynchronous SMS message delete operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_close_811482585.md b/windows.devices.sms/deletesmsmessageoperation_close_811482585.md index 02de77bb01..fd0b9be1f8 100644 --- a/windows.devices.sms/deletesmsmessageoperation_close_811482585.md +++ b/windows.devices.sms/deletesmsmessageoperation_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.DeleteSmsMessageOperation.Close --api-type: winrt method ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.Close ## -description Closes the asynchronous SMS message delete operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.DeleteSmsMessageOperation.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.Close + +## -description +Closes the asynchronous SMS message delete operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_completed.md b/windows.devices.sms/deletesmsmessageoperation_completed.md index ce40a3c719..e0cf7fdfff 100644 --- a/windows.devices.sms/deletesmsmessageoperation_completed.md +++ b/windows.devices.sms/deletesmsmessageoperation_completed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.Completed --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.Completed ## -description Specifies whether the asynchronous SMS message delete operation has completed or not. ## -property-value A handler for the completed event of an asynchronous action. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.Completed +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.Completed + +## -description +Specifies whether the asynchronous SMS message delete operation has completed or not. + +## -property-value +A handler for the completed event of an asynchronous action. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_errorcode.md b/windows.devices.sms/deletesmsmessageoperation_errorcode.md index 730b504f7e..2f29143cc8 100644 --- a/windows.devices.sms/deletesmsmessageoperation_errorcode.md +++ b/windows.devices.sms/deletesmsmessageoperation_errorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.ErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.ErrorCode ## -description Specifies the error code for the asynchronous SMS message delete operation. ## -property-value The result value of the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.ErrorCode + +## -description +Specifies the error code for the asynchronous SMS message delete operation. + +## -property-value +The result value of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_getresults_732303200.md b/windows.devices.sms/deletesmsmessageoperation_getresults_732303200.md index a2eeb366e0..9345e17ced 100644 --- a/windows.devices.sms/deletesmsmessageoperation_getresults_732303200.md +++ b/windows.devices.sms/deletesmsmessageoperation_getresults_732303200.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.DeleteSmsMessageOperation.GetResults --api-type: winrt method ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.GetResults ## -description Retrieves the result of the asynchronous SMS message delete operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.DeleteSmsMessageOperation.GetResults +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.GetResults + +## -description +Retrieves the result of the asynchronous SMS message delete operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_id.md b/windows.devices.sms/deletesmsmessageoperation_id.md index 11982e6c2e..f260500c46 100644 --- a/windows.devices.sms/deletesmsmessageoperation_id.md +++ b/windows.devices.sms/deletesmsmessageoperation_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.Id --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.Id ## -description Specifies the ID of the asynchronous SMS message delete operation. ## -property-value An integer that uniquely represents the asynchronous SMS message delete operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.Id + +## -description +Specifies the ID of the asynchronous SMS message delete operation. + +## -property-value +An integer that uniquely represents the asynchronous SMS message delete operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessageoperation_status.md b/windows.devices.sms/deletesmsmessageoperation_status.md index 83080cb764..89d1ba991c 100644 --- a/windows.devices.sms/deletesmsmessageoperation_status.md +++ b/windows.devices.sms/deletesmsmessageoperation_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.Status --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessageOperation.Status ## -description Specifies the status of the asynchronous SMS message delete operation. ## -property-value An enumerated value representing the status of the asynchronous SMS message delete operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessageOperation.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessageOperation.Status + +## -description +Specifies the status of the asynchronous SMS message delete operation. + +## -property-value +An enumerated value representing the status of the asynchronous SMS message delete operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_cancel_1985564044.md b/windows.devices.sms/deletesmsmessagesoperation_cancel_1985564044.md index 32d48374bf..49709799ea 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_cancel_1985564044.md +++ b/windows.devices.sms/deletesmsmessagesoperation_cancel_1985564044.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.DeleteSmsMessagesOperation.Cancel --api-type: winrt method ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.Cancel ## -description Cancels the asynchronous SMS message delete operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.DeleteSmsMessagesOperation.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.Cancel + +## -description +Cancels the asynchronous SMS message delete operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_close_811482585.md b/windows.devices.sms/deletesmsmessagesoperation_close_811482585.md index ea71c98239..9f0e99c832 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_close_811482585.md +++ b/windows.devices.sms/deletesmsmessagesoperation_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.DeleteSmsMessagesOperation.Close --api-type: winrt method ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.Close ## -description Closes the asynchronous SMS message delete operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.DeleteSmsMessagesOperation.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.Close + +## -description +Closes the asynchronous SMS message delete operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_completed.md b/windows.devices.sms/deletesmsmessagesoperation_completed.md index 3f53e5adc5..88acf686c9 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_completed.md +++ b/windows.devices.sms/deletesmsmessagesoperation_completed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.Completed --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.Completed ## -description Specifies whether the asynchronous SMS message delete operations have completed or not. ## -property-value A handler for the completed event of an asynchronous SMS message delete operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.Completed +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.Completed + +## -description +Specifies whether the asynchronous SMS message delete operations have completed or not. + +## -property-value +A handler for the completed event of an asynchronous SMS message delete operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_errorcode.md b/windows.devices.sms/deletesmsmessagesoperation_errorcode.md index 2113fb51be..9357c13b80 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_errorcode.md +++ b/windows.devices.sms/deletesmsmessagesoperation_errorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.ErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.ErrorCode ## -description Specifies the error code for the asynchronous SMS message delete operations. ## -property-value The result value of the asynchronous SMS message delete operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.ErrorCode + +## -description +Specifies the error code for the asynchronous SMS message delete operations. + +## -property-value +The result value of the asynchronous SMS message delete operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_getresults_732303200.md b/windows.devices.sms/deletesmsmessagesoperation_getresults_732303200.md index d319f1a444..9e972997b1 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_getresults_732303200.md +++ b/windows.devices.sms/deletesmsmessagesoperation_getresults_732303200.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.DeleteSmsMessagesOperation.GetResults --api-type: winrt method ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.GetResults ## -description Retrieves the result of the asynchronous message operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.DeleteSmsMessagesOperation.GetResults +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.GetResults + +## -description +Retrieves the result of the asynchronous message operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_id.md b/windows.devices.sms/deletesmsmessagesoperation_id.md index fcba2b5bd6..e88da95d60 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_id.md +++ b/windows.devices.sms/deletesmsmessagesoperation_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.Id --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.Id ## -description Specifies the ID of the asynchronous SMS message delete operations. ## -property-value An integer that uniquely represents the asynchronous SMS message delete operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.Id + +## -description +Specifies the ID of the asynchronous SMS message delete operations. + +## -property-value +An integer that uniquely represents the asynchronous SMS message delete operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/deletesmsmessagesoperation_status.md b/windows.devices.sms/deletesmsmessagesoperation_status.md index 3bbfe3e9fe..94a16d4880 100644 --- a/windows.devices.sms/deletesmsmessagesoperation_status.md +++ b/windows.devices.sms/deletesmsmessagesoperation_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.Status --api-type: winrt property ---- # Windows.Devices.Sms.DeleteSmsMessagesOperation.Status ## -description Specifies the status of the asynchronous SMS message delete operations. ## -property-value An enumerated value representing the status of the asynchronous SMS message delete operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.DeleteSmsMessagesOperation.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.DeleteSmsMessagesOperation.Status + +## -description +Specifies the status of the asynchronous SMS message delete operations. + +## -property-value +An enumerated value representing the status of the asynchronous SMS message delete operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_cancel_1985564044.md b/windows.devices.sms/getsmsdeviceoperation_cancel_1985564044.md index 999773f51f..dee0da6ff4 100644 --- a/windows.devices.sms/getsmsdeviceoperation_cancel_1985564044.md +++ b/windows.devices.sms/getsmsdeviceoperation_cancel_1985564044.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsDeviceOperation.Cancel --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsDeviceOperation.Cancel ## -description Cancels the asynchronous [SmsDevice](smsdevice.md) object retrieval. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsDeviceOperation.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.Cancel + +## -description +Cancels the asynchronous [SmsDevice](smsdevice.md) object retrieval. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_close_811482585.md b/windows.devices.sms/getsmsdeviceoperation_close_811482585.md index 0f3662a409..b4f1605a74 100644 --- a/windows.devices.sms/getsmsdeviceoperation_close_811482585.md +++ b/windows.devices.sms/getsmsdeviceoperation_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsDeviceOperation.Close --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsDeviceOperation.Close ## -description Closes the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsDeviceOperation.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.Close + +## -description +Closes the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_completed.md b/windows.devices.sms/getsmsdeviceoperation_completed.md index 5deada454f..29f2c97439 100644 --- a/windows.devices.sms/getsmsdeviceoperation_completed.md +++ b/windows.devices.sms/getsmsdeviceoperation_completed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.Completed --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsDeviceOperation.Completed ## -description Specifies whether the asynchronous [SmsDevice](smsdevice.md) object retrieval operation has completed or not. ## -property-value A handler for the completed event of an asynchronous action. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.Completed +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.Completed + +## -description +Specifies whether the asynchronous [SmsDevice](smsdevice.md) object retrieval operation has completed or not. + +## -property-value +A handler for the completed event of an asynchronous action. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_errorcode.md b/windows.devices.sms/getsmsdeviceoperation_errorcode.md index 2271515b32..3317038b8d 100644 --- a/windows.devices.sms/getsmsdeviceoperation_errorcode.md +++ b/windows.devices.sms/getsmsdeviceoperation_errorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.ErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsDeviceOperation.ErrorCode ## -description Specifies the error code for the asynchronous [SmsDevice](smsdevice.md) object retrieval operation ## -property-value The result value of the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.ErrorCode + +## -description +Specifies the error code for the asynchronous [SmsDevice](smsdevice.md) object retrieval operation + +## -property-value +The result value of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_getresults_732303200.md b/windows.devices.sms/getsmsdeviceoperation_getresults_732303200.md index 46140e7ffb..50ae75d0a5 100644 --- a/windows.devices.sms/getsmsdeviceoperation_getresults_732303200.md +++ b/windows.devices.sms/getsmsdeviceoperation_getresults_732303200.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsDeviceOperation.GetResults --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsDeviceOperation.GetResults ## -description Gets the results of the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. ## -returns A reference to an [SmsDevice](smsdevice.md) object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsDeviceOperation.GetResults +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.GetResults + +## -description +Gets the results of the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. + +## -returns +A reference to an [SmsDevice](smsdevice.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_id.md b/windows.devices.sms/getsmsdeviceoperation_id.md index 938628f37f..212f1b85ab 100644 --- a/windows.devices.sms/getsmsdeviceoperation_id.md +++ b/windows.devices.sms/getsmsdeviceoperation_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.Id --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsDeviceOperation.Id ## -description Specifies the ID of the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. ## -property-value An integer that uniquely represents the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.Id + +## -description +Specifies the ID of the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. + +## -property-value +An integer that uniquely represents the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsdeviceoperation_status.md b/windows.devices.sms/getsmsdeviceoperation_status.md index dd3763c52e..041b6c9563 100644 --- a/windows.devices.sms/getsmsdeviceoperation_status.md +++ b/windows.devices.sms/getsmsdeviceoperation_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.Status --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsDeviceOperation.Status ## -description Specifies the status of the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. ## -property-value An enumerated value representing the status of an asynchronous [SmsDevice](smsdevice.md) object retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsDeviceOperation.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsDeviceOperation.Status + +## -description +Specifies the status of the asynchronous [SmsDevice](smsdevice.md) object retrieval operation. + +## -property-value +An enumerated value representing the status of an asynchronous [SmsDevice](smsdevice.md) object retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_cancel_1985564044.md b/windows.devices.sms/getsmsmessageoperation_cancel_1985564044.md index 03c8ebecaf..3f92a85825 100644 --- a/windows.devices.sms/getsmsmessageoperation_cancel_1985564044.md +++ b/windows.devices.sms/getsmsmessageoperation_cancel_1985564044.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsMessageOperation.Cancel --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsMessageOperation.Cancel ## -description Cancels the asynchronous SMS message retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsMessageOperation.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.Cancel + +## -description +Cancels the asynchronous SMS message retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_close_811482585.md b/windows.devices.sms/getsmsmessageoperation_close_811482585.md index 09a4835eba..9294b552eb 100644 --- a/windows.devices.sms/getsmsmessageoperation_close_811482585.md +++ b/windows.devices.sms/getsmsmessageoperation_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsMessageOperation.Close --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsMessageOperation.Close ## -description Closes the asynchronous SMS message retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsMessageOperation.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.Close + +## -description +Closes the asynchronous SMS message retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_completed.md b/windows.devices.sms/getsmsmessageoperation_completed.md index e89e8ae2db..1a6b20ab95 100644 --- a/windows.devices.sms/getsmsmessageoperation_completed.md +++ b/windows.devices.sms/getsmsmessageoperation_completed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.Completed --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessageOperation.Completed ## -description A handler for the completed event of an asynchronous SMS message retrieval operation. ## -property-value A handler for the completed event of an asynchronous SMS message retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.Completed +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.Completed + +## -description +A handler for the completed event of an asynchronous SMS message retrieval operation. + +## -property-value +A handler for the completed event of an asynchronous SMS message retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_errorcode.md b/windows.devices.sms/getsmsmessageoperation_errorcode.md index e82416d901..d7d932e23b 100644 --- a/windows.devices.sms/getsmsmessageoperation_errorcode.md +++ b/windows.devices.sms/getsmsmessageoperation_errorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.ErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessageOperation.ErrorCode ## -description Specifies the error code for the asynchronous SMS message retrieval operation. ## -property-value The result value of the asynchronous SMS message retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.ErrorCode + +## -description +Specifies the error code for the asynchronous SMS message retrieval operation. + +## -property-value +The result value of the asynchronous SMS message retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_getresults_732303200.md b/windows.devices.sms/getsmsmessageoperation_getresults_732303200.md index deedce2456..684a80746b 100644 --- a/windows.devices.sms/getsmsmessageoperation_getresults_732303200.md +++ b/windows.devices.sms/getsmsmessageoperation_getresults_732303200.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsMessageOperation.GetResults --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsMessageOperation.GetResults ## -description Retrieves the result of the asynchronous SMS message retrieval operation. ## -returns An interface that accesses the retrieved message. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsMessageOperation.GetResults +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.GetResults + +## -description +Retrieves the result of the asynchronous SMS message retrieval operation. + +## -returns +An interface that accesses the retrieved message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_id.md b/windows.devices.sms/getsmsmessageoperation_id.md index 7d885827f2..cab77c1923 100644 --- a/windows.devices.sms/getsmsmessageoperation_id.md +++ b/windows.devices.sms/getsmsmessageoperation_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.Id --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessageOperation.Id ## -description Specifies the ID of the asynchronous SMS message retrieval operation. ## -property-value An integer uniquely representing the asynchronous SMS message retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.Id + +## -description +Specifies the ID of the asynchronous SMS message retrieval operation. + +## -property-value +An integer uniquely representing the asynchronous SMS message retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessageoperation_status.md b/windows.devices.sms/getsmsmessageoperation_status.md index b474f78c18..65d6884bc2 100644 --- a/windows.devices.sms/getsmsmessageoperation_status.md +++ b/windows.devices.sms/getsmsmessageoperation_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.Status --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessageOperation.Status ## -description Specifies the status of the asynchronous SMS message retrieval operation. ## -property-value An enumerated value representing the status of an asynchronous SMS message retrieval operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessageOperation.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessageOperation.Status + +## -description +Specifies the status of the asynchronous SMS message retrieval operation. + +## -property-value +An enumerated value representing the status of an asynchronous SMS message retrieval operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_cancel_1985564044.md b/windows.devices.sms/getsmsmessagesoperation_cancel_1985564044.md index 7feb73300a..81efae1f4e 100644 --- a/windows.devices.sms/getsmsmessagesoperation_cancel_1985564044.md +++ b/windows.devices.sms/getsmsmessagesoperation_cancel_1985564044.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsMessagesOperation.Cancel --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsMessagesOperation.Cancel ## -description Cancels the asynchronous operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsMessagesOperation.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.Cancel + +## -description +Cancels the asynchronous operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_close_811482585.md b/windows.devices.sms/getsmsmessagesoperation_close_811482585.md index 9ed0501b6d..b30a43cc69 100644 --- a/windows.devices.sms/getsmsmessagesoperation_close_811482585.md +++ b/windows.devices.sms/getsmsmessagesoperation_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsMessagesOperation.Close --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsMessagesOperation.Close ## -description Closes the asynchronous operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsMessagesOperation.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.Close + +## -description +Closes the asynchronous operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_completed.md b/windows.devices.sms/getsmsmessagesoperation_completed.md index 8d22d26a4c..c049728a2b 100644 --- a/windows.devices.sms/getsmsmessagesoperation_completed.md +++ b/windows.devices.sms/getsmsmessagesoperation_completed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Completed --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessagesOperation.Completed ## -description Specifies whether the asynchronous message retrieval operation has completed or not. ## -property-value Specifies whether the asynchronous message operation has completed or not. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Completed +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.Completed + +## -description +Specifies whether the asynchronous message retrieval operation has completed or not. + +## -property-value +Specifies whether the asynchronous message operation has completed or not. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_errorcode.md b/windows.devices.sms/getsmsmessagesoperation_errorcode.md index 82bced12d1..b85cd768af 100644 --- a/windows.devices.sms/getsmsmessagesoperation_errorcode.md +++ b/windows.devices.sms/getsmsmessagesoperation_errorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.ErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessagesOperation.ErrorCode ## -description Specifies the error code for the asynchronous message operation. ## -property-value The result value of the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.ErrorCode + +## -description +Specifies the error code for the asynchronous message operation. + +## -property-value +The result value of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_getresults_732303200.md b/windows.devices.sms/getsmsmessagesoperation_getresults_732303200.md index 80ec8d4ef5..eebcab289c 100644 --- a/windows.devices.sms/getsmsmessagesoperation_getresults_732303200.md +++ b/windows.devices.sms/getsmsmessagesoperation_getresults_732303200.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.GetSmsMessagesOperation.GetResults --api-type: winrt method ---- # Windows.Devices.Sms.GetSmsMessagesOperation.GetResults ## -description Retrieves the result of the asynchronous message retrieval operation. ## -returns A reference to the SMS messages retrieved. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.GetSmsMessagesOperation.GetResults +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.GetResults + +## -description +Retrieves the result of the asynchronous message retrieval operation. + +## -returns +A reference to the SMS messages retrieved. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_id.md b/windows.devices.sms/getsmsmessagesoperation_id.md index d2efce9685..cca5d45f67 100644 --- a/windows.devices.sms/getsmsmessagesoperation_id.md +++ b/windows.devices.sms/getsmsmessagesoperation_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Id --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessagesOperation.Id ## -description Indicates the ID of the asynchronous message operation. ## -property-value An integer uniquely representing the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.Id + +## -description +Indicates the ID of the asynchronous message operation. + +## -property-value +An integer uniquely representing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_progress.md b/windows.devices.sms/getsmsmessagesoperation_progress.md index 08c50a8982..a7c7a1f88c 100644 --- a/windows.devices.sms/getsmsmessagesoperation_progress.md +++ b/windows.devices.sms/getsmsmessagesoperation_progress.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Progress --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessagesOperation.Progress ## -description Specifies the progress status of the asynchronous message operation. ## -property-value A handler for progress update events of an asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Progress +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.Progress + +## -description +Specifies the progress status of the asynchronous message operation. + +## -property-value +A handler for progress update events of an asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/getsmsmessagesoperation_status.md b/windows.devices.sms/getsmsmessagesoperation_status.md index 053aa5c7b4..e812c06c6f 100644 --- a/windows.devices.sms/getsmsmessagesoperation_status.md +++ b/windows.devices.sms/getsmsmessagesoperation_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Status --api-type: winrt property ---- # Windows.Devices.Sms.GetSmsMessagesOperation.Status ## -description Specifies the status of the asynchronous message operations. ## -property-value An enumerated value representing the status of an asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.GetSmsMessagesOperation.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.GetSmsMessagesOperation.Status + +## -description +Specifies the status of the asynchronous message operations. + +## -property-value +An enumerated value representing the status of an asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsbinarymessage_format.md b/windows.devices.sms/ismsbinarymessage_format.md index b8e1a0184b..3d2de31e3c 100644 --- a/windows.devices.sms/ismsbinarymessage_format.md +++ b/windows.devices.sms/ismsbinarymessage_format.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsBinaryMessage.Format --api-type: winrt property ---- # Windows.Devices.Sms.ISmsBinaryMessage.Format ## -description Retrieves the detected protocol description unit (PDU) format of this message. ## -property-value An enumerated value describing the SMS data format. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsBinaryMessage.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsBinaryMessage.Format + +## -description +Retrieves the detected protocol description unit (PDU) format of this message. + +## -property-value +An enumerated value describing the SMS data format. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsbinarymessage_getdata.md b/windows.devices.sms/ismsbinarymessage_getdata.md index ef1e871584..3ace03bbc7 100644 --- a/windows.devices.sms/ismsbinarymessage_getdata.md +++ b/windows.devices.sms/ismsbinarymessage_getdata.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.ISmsBinaryMessage.GetData --api-type: winrt method ---- # Windows.Devices.Sms.ISmsBinaryMessage.GetData ## -description Returns the raw buffer of the message in binary protocol description unit (PDU) format as a byte array. ## -returns A byte array representing message data. If there is no message data, the returned array is empty. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.ISmsBinaryMessage.GetData +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.ISmsBinaryMessage.GetData + +## -description +Returns the raw buffer of the message in binary protocol description unit (PDU) format as a byte array. + +## -returns +A byte array representing message data. If there is no message data, the returned array is empty. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsbinarymessage_setdata.md b/windows.devices.sms/ismsbinarymessage_setdata.md index 761ee64569..d341f6fc61 100644 --- a/windows.devices.sms/ismsbinarymessage_setdata.md +++ b/windows.devices.sms/ismsbinarymessage_setdata.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sms.ISmsBinaryMessage.SetData(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Sms.ISmsBinaryMessage.SetData ## -description Specifies the raw binary payload of the SMS message. It should be formatted according to the protocol description unit (PDU) standard. ## -parameters ### -param value A byte array representing message data, formatted according to the protocol description unit (PDU) standard. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.ISmsBinaryMessage.SetData(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.ISmsBinaryMessage.SetData + +## -description +Specifies the raw binary payload of the SMS message. It should be formatted according to the protocol description unit (PDU) standard. + +## -parameters +### -param value +A byte array representing message data, formatted according to the protocol description unit (PDU) standard. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_accountphonenumber.md b/windows.devices.sms/ismsdevice_accountphonenumber.md index 683a7d0760..7185215b54 100644 --- a/windows.devices.sms/ismsdevice_accountphonenumber.md +++ b/windows.devices.sms/ismsdevice_accountphonenumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsDevice.AccountPhoneNumber --api-type: winrt property ---- # Windows.Devices.Sms.ISmsDevice.AccountPhoneNumber ## -description Returns the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox. ## -property-value A string representation of the account phone number. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsDevice.AccountPhoneNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsDevice.AccountPhoneNumber + +## -description +Returns the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox. + +## -property-value +A string representation of the account phone number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_calculatelength.md b/windows.devices.sms/ismsdevice_calculatelength.md index 3f536effe7..617f419392 100644 --- a/windows.devices.sms/ismsdevice_calculatelength.md +++ b/windows.devices.sms/ismsdevice_calculatelength.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.ISmsDevice.CalculateLength(Windows.Devices.Sms.SmsTextMessage) --api-type: winrt method ---- # Windows.Devices.Sms.ISmsDevice.CalculateLength ## -description Estimates the transmitted message length of the specified text message. The estimate can be useful to clients who want to give an indication of how many messages will be sent on the network to carry the text of the full message. ## -parameters ### -param message A reference to the SMS text message to measure. ## -returns A reference to an SmsEncodedLength structure that is populated with the length information. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.ISmsDevice.CalculateLength(Windows.Devices.Sms.SmsTextMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.ISmsDevice.CalculateLength + +## -description +Estimates the transmitted message length of the specified text message. The estimate can be useful to clients who want to give an indication of how many messages will be sent on the network to carry the text of the full message. + +## -parameters +### -param message +A reference to the SMS text message to measure. + +## -returns +A reference to an SmsEncodedLength structure that is populated with the length information. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_cellularclass.md b/windows.devices.sms/ismsdevice_cellularclass.md index 86c15f67b0..b03b10825b 100644 --- a/windows.devices.sms/ismsdevice_cellularclass.md +++ b/windows.devices.sms/ismsdevice_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsDevice.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.ISmsDevice.CellularClass ## -description Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect. ## -property-value An enumerated value indicating the device's cellular class. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsDevice.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsDevice.CellularClass + +## -description +Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect. + +## -property-value +An enumerated value indicating the device's cellular class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_devicestatus.md b/windows.devices.sms/ismsdevice_devicestatus.md index fcaafae299..6c6b130605 100644 --- a/windows.devices.sms/ismsdevice_devicestatus.md +++ b/windows.devices.sms/ismsdevice_devicestatus.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsDevice.DeviceStatus --api-type: winrt property ---- # Windows.Devices.Sms.ISmsDevice.DeviceStatus ## -description Returns the SMS device's status, which indicates whether the device is ready, or not. It also indcates what type of problem exists if the device is not ready. ## -property-value An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsDevice.DeviceStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsDevice.DeviceStatus + +## -description +Returns the SMS device's status, which indicates whether the device is ready, or not. It also indcates what type of problem exists if the device is not ready. + +## -property-value +An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_messagestore.md b/windows.devices.sms/ismsdevice_messagestore.md index 74ae9f5126..519592f688 100644 --- a/windows.devices.sms/ismsdevice_messagestore.md +++ b/windows.devices.sms/ismsdevice_messagestore.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsDevice.MessageStore --api-type: winrt property ---- # Windows.Devices.Sms.ISmsDevice.MessageStore ## -description Accesses the on-device message store. The store holds messages until a client can retrieve them. On some devices, for example, the store may correspond to the SIM storage for SMS messages. ## -property-value A reference to an SmsMessageStore object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsDevice.MessageStore +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsDevice.MessageStore + +## -description +Accesses the on-device message store. The store holds messages until a client can retrieve them. On some devices, for example, the store may correspond to the SIM storage for SMS messages. + +## -property-value +A reference to an SmsMessageStore object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_sendmessageasync.md b/windows.devices.sms/ismsdevice_sendmessageasync.md index 3ca6d1f8f9..2758d22d58 100644 --- a/windows.devices.sms/ismsdevice_sendmessageasync.md +++ b/windows.devices.sms/ismsdevice_sendmessageasync.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.ISmsDevice.SendMessageAsync(Windows.Devices.Sms.ISmsMessage) --api-type: winrt method ---- # Windows.Devices.Sms.ISmsDevice.SendMessageAsync ## -description Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The asynchronous operation object is returned immediately. ## -parameters ### -param message A reference to an SmsMessage object. The message can be in text or binary format. ## -returns A reference to an [SendSmsMessageOperation](sendsmsmessageoperation.md) object that supports asynchronous message sending. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.ISmsDevice.SendMessageAsync(Windows.Devices.Sms.ISmsMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.ISmsDevice.SendMessageAsync + +## -description +Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The asynchronous operation object is returned immediately. + +## -parameters +### -param message +A reference to an SmsMessage object. The message can be in text or binary format. + +## -returns +A reference to an [SendSmsMessageOperation](sendsmsmessageoperation.md) object that supports asynchronous message sending. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_smsdevicestatuschanged.md b/windows.devices.sms/ismsdevice_smsdevicestatuschanged.md index efbe0660f2..46a40105a5 100644 --- a/windows.devices.sms/ismsdevice_smsdevicestatuschanged.md +++ b/windows.devices.sms/ismsdevice_smsdevicestatuschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Sms.ISmsDevice.SmsDeviceStatusChanged --api-type: winrt event ---- # Windows.Devices.Sms.ISmsDevice.SmsDeviceStatusChanged ## -description Sets an event handler to be called when the status of the SMS device changes. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sms.ISmsDevice.SmsDeviceStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sms.ISmsDevice.SmsDeviceStatusChanged + +## -description +Sets an event handler to be called when the status of the SMS device changes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsdevice_smsmessagereceived.md b/windows.devices.sms/ismsdevice_smsmessagereceived.md index 7acd08a4cd..b2d24b1c8a 100644 --- a/windows.devices.sms/ismsdevice_smsmessagereceived.md +++ b/windows.devices.sms/ismsdevice_smsmessagereceived.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Sms.ISmsDevice.SmsMessageReceived --api-type: winrt event ---- # Windows.Devices.Sms.ISmsDevice.SmsMessageReceived ## -description Sets an event handler to be called when the device receives a new text message. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sms.ISmsDevice.SmsMessageReceived +-api-type: winrt event +--- + + + +# Windows.Devices.Sms.ISmsDevice.SmsMessageReceived + +## -description +Sets an event handler to be called when the device receives a new text message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessage_id.md b/windows.devices.sms/ismsmessage_id.md index 0ad1bd2011..c801d01fc7 100644 --- a/windows.devices.sms/ismsmessage_id.md +++ b/windows.devices.sms/ismsmessage_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessage.Id --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessage.Id ## -description Retrieves an ID for the message, which can later be specified in calling message store methods in order to get or delete the message. ## -property-value An integer ID for the message. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessage.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessage.Id + +## -description +Retrieves an ID for the message, which can later be specified in calling message store methods in order to get or delete the message. + +## -property-value +An integer ID for the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessage_messageclass.md b/windows.devices.sms/ismsmessage_messageclass.md index 6d58210491..f5f518827e 100644 --- a/windows.devices.sms/ismsmessage_messageclass.md +++ b/windows.devices.sms/ismsmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessage.MessageClass ## -description Returns the message class, as determined by the operator's message network. The two most common classes are None (normal message) or Class0 (special operator message, such as a roaming warning that must be shown immediately to the user). A typical client for end-user messages ignores Class0 messages. ## -property-value A value from the [SmsMessageClass](smsmessageclass.md) enumeration. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessage.MessageClass + +## -description +Returns the message class, as determined by the operator's message network. The two most common classes are None (normal message) or Class0 (special operator message, such as a roaming warning that must be shown immediately to the user). A typical client for end-user messages ignores Class0 messages. + +## -property-value +A value from the [SmsMessageClass](smsmessageclass.md) enumeration. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessagebase_cellularclass.md b/windows.devices.sms/ismsmessagebase_cellularclass.md index dd2ae302d4..fdc343a8dc 100644 --- a/windows.devices.sms/ismsmessagebase_cellularclass.md +++ b/windows.devices.sms/ismsmessagebase_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessageBase.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessageBase.CellularClass ## -description Gets the cellular class of the message. ## -property-value An enumeration value specifying the cellular class of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessageBase.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessageBase.CellularClass + +## -description +Gets the cellular class of the message. + +## -property-value +An enumeration value specifying the cellular class of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessagebase_deviceid.md b/windows.devices.sms/ismsmessagebase_deviceid.md index d7d1670306..df6b04462e 100644 --- a/windows.devices.sms/ismsmessagebase_deviceid.md +++ b/windows.devices.sms/ismsmessagebase_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessageBase.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessageBase.DeviceId ## -description Gets the unique device identifier associated with this message. ## -property-value The device identifier, as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessageBase.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessageBase.DeviceId + +## -description +Gets the unique device identifier associated with this message. + +## -property-value +The device identifier, as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessagebase_messageclass.md b/windows.devices.sms/ismsmessagebase_messageclass.md index 802d524015..f451f36c9e 100644 --- a/windows.devices.sms/ismsmessagebase_messageclass.md +++ b/windows.devices.sms/ismsmessagebase_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessageBase.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessageBase.MessageClass ## -description Gets the message class of this message. ## -property-value An enumeration value specifying the SMS message class of this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessageBase.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessageBase.MessageClass + +## -description +Gets the message class of this message. + +## -property-value +An enumeration value specifying the SMS message class of this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessagebase_messagetype.md b/windows.devices.sms/ismsmessagebase_messagetype.md index d9d22d65c3..82fa9d0e78 100644 --- a/windows.devices.sms/ismsmessagebase_messagetype.md +++ b/windows.devices.sms/ismsmessagebase_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessageBase.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessageBase.MessageType ## -description Gets the message type of this message. ## -property-value An enumeration value specifying the message type of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessageBase.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessageBase.MessageType + +## -description +Gets the message type of this message. + +## -property-value +An enumeration value specifying the message type of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismsmessagebase_simiccid.md b/windows.devices.sms/ismsmessagebase_simiccid.md index 609ddd1db9..98d024db0d 100644 --- a/windows.devices.sms/ismsmessagebase_simiccid.md +++ b/windows.devices.sms/ismsmessagebase_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsMessageBase.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.ISmsMessageBase.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsMessageBase.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsMessageBase.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_body.md b/windows.devices.sms/ismstextmessage_body.md index 99cabfa2ec..f6b7fe7e17 100644 --- a/windows.devices.sms/ismstextmessage_body.md +++ b/windows.devices.sms/ismstextmessage_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.Body --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.Body ## -description Specifies the plain text body of the message. ## -property-value A string representing the body of the text message. If there were decoding problems, some characters in the original message can be represented by a wildcard character, typically a question mark: '?'. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.Body + +## -description +Specifies the plain text body of the message. + +## -property-value +A string representing the body of the text message. If there were decoding problems, some characters in the original message can be represented by a wildcard character, typically a question mark: '?'. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_encoding.md b/windows.devices.sms/ismstextmessage_encoding.md index 92d816d98d..e3d3569a02 100644 --- a/windows.devices.sms/ismstextmessage_encoding.md +++ b/windows.devices.sms/ismstextmessage_encoding.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.Encoding --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.Encoding ## -description Specifies the encoding type that has been set to use when sending this message. ## -property-value A value from the [SmsEncoding](smsencoding.md) enumeration. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.Encoding +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.Encoding + +## -description +Specifies the encoding type that has been set to use when sending this message. + +## -property-value +A value from the [SmsEncoding](smsencoding.md) enumeration. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_from.md b/windows.devices.sms/ismstextmessage_from.md index 55ae4c466a..fe7306982f 100644 --- a/windows.devices.sms/ismstextmessage_from.md +++ b/windows.devices.sms/ismstextmessage_from.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.From --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.From ## -description Specifies the phone number of the sender of the message. ## -property-value A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.From +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.From + +## -description +Specifies the phone number of the sender of the message. + +## -property-value +A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_partcount.md b/windows.devices.sms/ismstextmessage_partcount.md index f1b46feba3..232311b88b 100644 --- a/windows.devices.sms/ismstextmessage_partcount.md +++ b/windows.devices.sms/ismstextmessage_partcount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.PartCount --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.PartCount ## -description Retrieves the total number of parts in the original message if the message is part of a multi-part message. ## -property-value An unsigned integer. If the message is standalone, the value is 1. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.PartCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.PartCount + +## -description +Retrieves the total number of parts in the original message if the message is part of a multi-part message. + +## -property-value +An unsigned integer. If the message is standalone, the value is 1. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_partnumber.md b/windows.devices.sms/ismstextmessage_partnumber.md index d32aa46f29..82bd82450b 100644 --- a/windows.devices.sms/ismstextmessage_partnumber.md +++ b/windows.devices.sms/ismstextmessage_partnumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.PartNumber --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.PartNumber ## -description Retrieves the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the PartReferenceId and PartCount properties. ## -property-value An unsigned integer. It is one-based. It will not exceed PartCount + 1. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.PartNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.PartNumber + +## -description +Retrieves the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the PartReferenceId and PartCount properties. + +## -property-value +An unsigned integer. It is one-based. It will not exceed PartCount + 1. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_partreferenceid.md b/windows.devices.sms/ismstextmessage_partreferenceid.md index ff6495ba6e..84ac2ba436 100644 --- a/windows.devices.sms/ismstextmessage_partreferenceid.md +++ b/windows.devices.sms/ismstextmessage_partreferenceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.PartReferenceId --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.PartReferenceId ## -description Indicates a reference value that can be used if the message is part of a multi-part message. If this message belongs to a multi-part message, the [PartNumber](smstextmessage_partnumber.md) value can be used to reconstruct the full original message, and each part of that message will have the same value for [PartReferenceId](smstextmessage_partreferenceid.md). ## -property-value An unsigned integer determined by the sending network; it cannot be manipulated through this interface. If the network has its own policy on the lifetime of a multi-part message, this reference number might not be valid indefinitely. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.PartReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.PartReferenceId + +## -description +Indicates a reference value that can be used if the message is part of a multi-part message. If this message belongs to a multi-part message, the [PartNumber](smstextmessage_partnumber.md) value can be used to reconstruct the full original message, and each part of that message will have the same value for [PartReferenceId](smstextmessage_partreferenceid.md). + +## -property-value +An unsigned integer determined by the sending network; it cannot be manipulated through this interface. If the network has its own policy on the lifetime of a multi-part message, this reference number might not be valid indefinitely. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_timestamp.md b/windows.devices.sms/ismstextmessage_timestamp.md index 36253318e1..f00c08e749 100644 --- a/windows.devices.sms/ismstextmessage_timestamp.md +++ b/windows.devices.sms/ismstextmessage_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.Timestamp ## -description Retrieves the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message. ## -property-value A value of the DateTime type. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.Timestamp + +## -description +Retrieves the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message. + +## -property-value +A value of the DateTime type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_to.md b/windows.devices.sms/ismstextmessage_to.md index 3f869e3196..777e03d925 100644 --- a/windows.devices.sms/ismstextmessage_to.md +++ b/windows.devices.sms/ismstextmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.ISmsTextMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.ISmsTextMessage.To ## -description Specifies the recipient phone number of this message. ## -property-value A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.ISmsTextMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.To + +## -description +Specifies the recipient phone number of this message. + +## -property-value +A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/ismstextmessage_tobinarymessages.md b/windows.devices.sms/ismstextmessage_tobinarymessages.md index 7708ee23a4..327f17aa7d 100644 --- a/windows.devices.sms/ismstextmessage_tobinarymessages.md +++ b/windows.devices.sms/ismstextmessage_tobinarymessages.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.ISmsTextMessage.ToBinaryMessages(Windows.Devices.Sms.SmsDataFormat) --api-type: winrt method ---- # Windows.Devices.Sms.ISmsTextMessage.ToBinaryMessages ## -description Reads a message in the specified format and places the results in a new instance of a binary message. ## -parameters ### -param format A value from the [SmsDataFormat](smsdataformat.md) enumeration. ## -returns The new binary message that holds the result of this method call. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.ISmsTextMessage.ToBinaryMessages(Windows.Devices.Sms.SmsDataFormat) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.ISmsTextMessage.ToBinaryMessages + +## -description +Reads a message in the specified format and places the results in a new instance of a binary message. + +## -parameters +### -param format +A value from the [SmsDataFormat](smsdataformat.md) enumeration. + +## -returns +The new binary message that holds the result of this method call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_cancel_1985564044.md b/windows.devices.sms/sendsmsmessageoperation_cancel_1985564044.md index 704b4a13ad..b18a6f701e 100644 --- a/windows.devices.sms/sendsmsmessageoperation_cancel_1985564044.md +++ b/windows.devices.sms/sendsmsmessageoperation_cancel_1985564044.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SendSmsMessageOperation.Cancel --api-type: winrt method ---- # Windows.Devices.Sms.SendSmsMessageOperation.Cancel ## -description Cancels the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SendSmsMessageOperation.Cancel +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.Cancel + +## -description +Cancels the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_close_811482585.md b/windows.devices.sms/sendsmsmessageoperation_close_811482585.md index 8470dfc38d..19ae1f07a2 100644 --- a/windows.devices.sms/sendsmsmessageoperation_close_811482585.md +++ b/windows.devices.sms/sendsmsmessageoperation_close_811482585.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SendSmsMessageOperation.Close --api-type: winrt method ---- # Windows.Devices.Sms.SendSmsMessageOperation.Close ## -description Closes the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SendSmsMessageOperation.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.Close + +## -description +Closes the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_completed.md b/windows.devices.sms/sendsmsmessageoperation_completed.md index 237c0b18be..32db979cea 100644 --- a/windows.devices.sms/sendsmsmessageoperation_completed.md +++ b/windows.devices.sms/sendsmsmessageoperation_completed.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.Completed --api-type: winrt property ---- # Windows.Devices.Sms.SendSmsMessageOperation.Completed ## -description A handler for the completed event of an asynchronous action. ## -property-value A handler for the completed event of an asynchronous action. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.Completed +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.Completed + +## -description +A handler for the completed event of an asynchronous action. + +## -property-value +A handler for the completed event of an asynchronous action. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_errorcode.md b/windows.devices.sms/sendsmsmessageoperation_errorcode.md index 509b69473a..da0b459023 100644 --- a/windows.devices.sms/sendsmsmessageoperation_errorcode.md +++ b/windows.devices.sms/sendsmsmessageoperation_errorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.ErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.SendSmsMessageOperation.ErrorCode ## -description Specifies the error code for the asynchronous message operation. ## -property-value The result value of the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.ErrorCode + +## -description +Specifies the error code for the asynchronous message operation. + +## -property-value +The result value of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_getresults_732303200.md b/windows.devices.sms/sendsmsmessageoperation_getresults_732303200.md index c15a7eda43..5da0f2b54c 100644 --- a/windows.devices.sms/sendsmsmessageoperation_getresults_732303200.md +++ b/windows.devices.sms/sendsmsmessageoperation_getresults_732303200.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SendSmsMessageOperation.GetResults --api-type: winrt method ---- # Windows.Devices.Sms.SendSmsMessageOperation.GetResults ## -description Retrieves the result of the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SendSmsMessageOperation.GetResults +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.GetResults + +## -description +Retrieves the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_id.md b/windows.devices.sms/sendsmsmessageoperation_id.md index b693461a0b..a231798ada 100644 --- a/windows.devices.sms/sendsmsmessageoperation_id.md +++ b/windows.devices.sms/sendsmsmessageoperation_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.Id --api-type: winrt property ---- # Windows.Devices.Sms.SendSmsMessageOperation.Id ## -description Indicates the ID of the asynchronous message operation. ## -property-value An integer uniquely representing the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.Id + +## -description +Indicates the ID of the asynchronous message operation. + +## -property-value +An integer uniquely representing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/sendsmsmessageoperation_status.md b/windows.devices.sms/sendsmsmessageoperation_status.md index 6d31519f0b..72ca608b96 100644 --- a/windows.devices.sms/sendsmsmessageoperation_status.md +++ b/windows.devices.sms/sendsmsmessageoperation_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.Status --api-type: winrt property ---- # Windows.Devices.Sms.SendSmsMessageOperation.Status ## -description Specifies the status of the asynchronous message operation. ## -property-value An enumerated value representing the status of an asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SendSmsMessageOperation.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SendSmsMessageOperation.Status + +## -description +Specifies the status of the asynchronous message operation. + +## -property-value +An enumerated value representing the status of an asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage.md b/windows.devices.sms/smsappmessage.md index 611df477ac..7017c57265 100644 --- a/windows.devices.sms/smsappmessage.md +++ b/windows.devices.sms/smsappmessage.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Sms.SmsAppMessage --api-type: winrt class ---- # Windows.Devices.Sms.SmsAppMessage ## -description The interface for manipulating an SMS Application message. Application messages are those which cannot be characterized as any other message type. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also [ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsAppMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsAppMessage + +## -description +The interface for manipulating an SMS Application message. Application messages are those which cannot be characterized as any other message type. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also +[ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_binarybody.md b/windows.devices.sms/smsappmessage_binarybody.md index d1af6ea266..2bdc73ac9c 100644 --- a/windows.devices.sms/smsappmessage_binarybody.md +++ b/windows.devices.sms/smsappmessage_binarybody.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.BinaryBody --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.BinaryBody ## -description Reads or writes the binary part of the Application message. ## -property-value Binary data part of the Application message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.BinaryBody +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.BinaryBody + +## -description +Reads or writes the binary part of the Application message. + +## -property-value +Binary data part of the Application message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_body.md b/windows.devices.sms/smsappmessage_body.md index 063d4592ac..62a525ea87 100644 --- a/windows.devices.sms/smsappmessage_body.md +++ b/windows.devices.sms/smsappmessage_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.Body --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.Body ## -description The plain text body of the message. ## -property-value The plain text body of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.Body + +## -description +The plain text body of the message. + +## -property-value +The plain text body of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_callbacknumber.md b/windows.devices.sms/smsappmessage_callbacknumber.md index 6d99be6e93..521a212f3d 100644 --- a/windows.devices.sms/smsappmessage_callbacknumber.md +++ b/windows.devices.sms/smsappmessage_callbacknumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.CallbackNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.CallbackNumber ## -description The number to be dialed in reply to a received SMS message. ## -property-value The number to be dialed in reply to a received SMS message. Available only for 3GPP2 messages. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.CallbackNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.CallbackNumber + +## -description +The number to be dialed in reply to a received SMS message. + +## -property-value +The number to be dialed in reply to a received SMS message. Available only for 3GPP2 messages. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_cellularclass.md b/windows.devices.sms/smsappmessage_cellularclass.md index 9eb142e283..38a6ef2de9 100644 --- a/windows.devices.sms/smsappmessage_cellularclass.md +++ b/windows.devices.sms/smsappmessage_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.CellularClass ## -description The class of the cellular device that received the message. ## -property-value The class of the cellular device that received the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.CellularClass + +## -description +The class of the cellular device that received the message. + +## -property-value +The class of the cellular device that received the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_deviceid.md b/windows.devices.sms/smsappmessage_deviceid.md index 48d43d35ab..5ada485419 100644 --- a/windows.devices.sms/smsappmessage_deviceid.md +++ b/windows.devices.sms/smsappmessage_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.DeviceId ## -description The device ID of the device that received the message. ## -property-value The device ID of the device that received the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.DeviceId + +## -description +The device ID of the device that received the message. + +## -property-value +The device ID of the device that received the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_encoding.md b/windows.devices.sms/smsappmessage_encoding.md index bf87fd90bc..b7752c6423 100644 --- a/windows.devices.sms/smsappmessage_encoding.md +++ b/windows.devices.sms/smsappmessage_encoding.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.Encoding --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.Encoding ## -description The encoding used to send the message. ## -property-value The encoding used to send the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.Encoding +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.Encoding + +## -description +The encoding used to send the message. + +## -property-value +The encoding used to send the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_from.md b/windows.devices.sms/smsappmessage_from.md index 8894c6a914..eb8b81e5a8 100644 --- a/windows.devices.sms/smsappmessage_from.md +++ b/windows.devices.sms/smsappmessage_from.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.From --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.From ## -description The telephone number of the sender of the message. ## -property-value The telephone number of the sender of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.From +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.From + +## -description +The telephone number of the sender of the message. + +## -property-value +The telephone number of the sender of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_isdeliverynotificationenabled.md b/windows.devices.sms/smsappmessage_isdeliverynotificationenabled.md index f0fa7da4fa..c3a5d003c0 100644 --- a/windows.devices.sms/smsappmessage_isdeliverynotificationenabled.md +++ b/windows.devices.sms/smsappmessage_isdeliverynotificationenabled.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.IsDeliveryNotificationEnabled --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.IsDeliveryNotificationEnabled ## -description Indicates whether an SMS delivery status report was sent by the SMSC. ## -property-value For a received message, indicates whether an SMS delivery status report was sent by the SMSC. For a sent message, determines whether an SMS delivery status report is requested. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.IsDeliveryNotificationEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.IsDeliveryNotificationEnabled + +## -description +Indicates whether an SMS delivery status report was sent by the SMSC. + +## -property-value +For a received message, indicates whether an SMS delivery status report was sent by the SMSC. For a sent message, determines whether an SMS delivery status report is requested. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_messageclass.md b/windows.devices.sms/smsappmessage_messageclass.md index 61d73537a3..d2be97f699 100644 --- a/windows.devices.sms/smsappmessage_messageclass.md +++ b/windows.devices.sms/smsappmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.MessageClass ## -description The message class of the message. ## -property-value The message class of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.MessageClass + +## -description +The message class of the message. + +## -property-value +The message class of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_messagetype.md b/windows.devices.sms/smsappmessage_messagetype.md index ac2b7115e8..65c8530203 100644 --- a/windows.devices.sms/smsappmessage_messagetype.md +++ b/windows.devices.sms/smsappmessage_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.MessageType ## -description The message type of the message. ## -property-value The message type of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.MessageType + +## -description +The message type of the message. + +## -property-value +The message type of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_portnumber.md b/windows.devices.sms/smsappmessage_portnumber.md index 32a3f6a04c..35ed5c22c1 100644 --- a/windows.devices.sms/smsappmessage_portnumber.md +++ b/windows.devices.sms/smsappmessage_portnumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.PortNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.PortNumber ## -description The port number of the message. ## -property-value The port number of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.PortNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.PortNumber + +## -description +The port number of the message. + +## -property-value +The port number of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_protocolid.md b/windows.devices.sms/smsappmessage_protocolid.md index 3a5ef378c1..2e811eec0c 100644 --- a/windows.devices.sms/smsappmessage_protocolid.md +++ b/windows.devices.sms/smsappmessage_protocolid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.ProtocolId --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.ProtocolId ## -description The Protocol identifier for the message. ## -property-value The Protocol identifier for the message. (3GPP2 only.) ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.ProtocolId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.ProtocolId + +## -description +The Protocol identifier for the message. + +## -property-value +The Protocol identifier for the message. (3GPP2 only.) + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_retryattemptcount.md b/windows.devices.sms/smsappmessage_retryattemptcount.md index 3efae76c68..f2f63d504e 100644 --- a/windows.devices.sms/smsappmessage_retryattemptcount.md +++ b/windows.devices.sms/smsappmessage_retryattemptcount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.RetryAttemptCount --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.RetryAttemptCount ## -description The retry attempt count for the message. ## -property-value The retry attempt count for the message. Set the maximum number of retries for outgoing messages, or get the number of retries for a received message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.RetryAttemptCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.RetryAttemptCount + +## -description +The retry attempt count for the message. + +## -property-value +The retry attempt count for the message. Set the maximum number of retries for outgoing messages, or get the number of retries for a received message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_simiccid.md b/windows.devices.sms/smsappmessage_simiccid.md index ce5555ea73..b6379ed41e 100644 --- a/windows.devices.sms/smsappmessage_simiccid.md +++ b/windows.devices.sms/smsappmessage_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_smsappmessage_1221375020.md b/windows.devices.sms/smsappmessage_smsappmessage_1221375020.md index ec193d614e..7a4fd2a012 100644 --- a/windows.devices.sms/smsappmessage_smsappmessage_1221375020.md +++ b/windows.devices.sms/smsappmessage_smsappmessage_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsAppMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Sms.SmsAppMessage.SmsAppMessage ## -description Constructor. Used to create an [SmsAppMessage](smsappmessage.md) prior to sending it. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsAppMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsAppMessage.SmsAppMessage + +## -description +Constructor. Used to create an [SmsAppMessage](smsappmessage.md) prior to sending it. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_teleserviceid.md b/windows.devices.sms/smsappmessage_teleserviceid.md index a708c5b422..3d3a30e4de 100644 --- a/windows.devices.sms/smsappmessage_teleserviceid.md +++ b/windows.devices.sms/smsappmessage_teleserviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.TeleserviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.TeleserviceId ## -description The Teleservice identifier for the message. ## -property-value The Teleservice identifier for the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.TeleserviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.TeleserviceId + +## -description +The Teleservice identifier for the message. + +## -property-value +The Teleservice identifier for the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_timestamp.md b/windows.devices.sms/smsappmessage_timestamp.md index 7df59cda68..4429ed4bd0 100644 --- a/windows.devices.sms/smsappmessage_timestamp.md +++ b/windows.devices.sms/smsappmessage_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.Timestamp ## -description The timestamp of the message. ## -property-value The timestamp of the message. If the message is constructed locally, then the **Timestamp** value is determined locally. If the message was received from the network, the value is determined by the service center. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.Timestamp + +## -description +The timestamp of the message. + +## -property-value +The timestamp of the message. If the message is constructed locally, then the **Timestamp** value is determined locally. If the message was received from the network, the value is determined by the service center. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsappmessage_to.md b/windows.devices.sms/smsappmessage_to.md index 54e5d22e6e..96ce59e3a2 100644 --- a/windows.devices.sms/smsappmessage_to.md +++ b/windows.devices.sms/smsappmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsAppMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsAppMessage.To ## -description The telephone number of the recipient of this message. ## -property-value The telephone number of the recipient of this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsAppMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsAppMessage.To + +## -description +The telephone number of the recipient of this message. + +## -property-value +The telephone number of the recipient of this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbinarymessage_format.md b/windows.devices.sms/smsbinarymessage_format.md index b5ae7d46b4..020f90f73a 100644 --- a/windows.devices.sms/smsbinarymessage_format.md +++ b/windows.devices.sms/smsbinarymessage_format.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBinaryMessage.Format --api-type: winrt property ---- # Windows.Devices.Sms.SmsBinaryMessage.Format ## -description Retrieves the detected protocol description unit (PDU) format of this message. ## -property-value An enumerated value describing the SMS data format. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBinaryMessage.Format +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBinaryMessage.Format + +## -description +Retrieves the detected protocol description unit (PDU) format of this message. + +## -property-value +An enumerated value describing the SMS data format. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbinarymessage_getdata_1741870623.md b/windows.devices.sms/smsbinarymessage_getdata_1741870623.md index 249b9aecf1..a3556b7f25 100644 --- a/windows.devices.sms/smsbinarymessage_getdata_1741870623.md +++ b/windows.devices.sms/smsbinarymessage_getdata_1741870623.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.SmsBinaryMessage.GetData --api-type: winrt method ---- # Windows.Devices.Sms.SmsBinaryMessage.GetData ## -description Returns the raw buffer of the message in binary protocol description unit (PDU) format as a byte array. ## -returns A byte array representing message data. If there is no message data, the returned array is empty. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsBinaryMessage.GetData +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsBinaryMessage.GetData + +## -description +Returns the raw buffer of the message in binary protocol description unit (PDU) format as a byte array. + +## -returns +A byte array representing message data. If there is no message data, the returned array is empty. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbinarymessage_id.md b/windows.devices.sms/smsbinarymessage_id.md index f4bc6d53d8..4cce6f923a 100644 --- a/windows.devices.sms/smsbinarymessage_id.md +++ b/windows.devices.sms/smsbinarymessage_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBinaryMessage.Id --api-type: winrt property ---- # Windows.Devices.Sms.SmsBinaryMessage.Id ## -description Indicates the ID of the asynchronous message operation. ## -property-value An integer uniquely representing the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBinaryMessage.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBinaryMessage.Id + +## -description +Indicates the ID of the asynchronous message operation. + +## -property-value +An integer uniquely representing the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbinarymessage_messageclass.md b/windows.devices.sms/smsbinarymessage_messageclass.md index 1fbfb1dc2c..34f43b617b 100644 --- a/windows.devices.sms/smsbinarymessage_messageclass.md +++ b/windows.devices.sms/smsbinarymessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBinaryMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsBinaryMessage.MessageClass ## -description Returns the message class, as determined by the operator's message network. The two most common classes are None (normal message) or Class0 (special operator message, such as a roaming warning that must be shown immediately to the user). A typical client for end-user messages ignores Class0 messages. ## -property-value A value from the SmsMessageClass enumeration. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBinaryMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBinaryMessage.MessageClass + +## -description +Returns the message class, as determined by the operator's message network. The two most common classes are None (normal message) or Class0 (special operator message, such as a roaming warning that must be shown immediately to the user). A typical client for end-user messages ignores Class0 messages. + +## -property-value +A value from the SmsMessageClass enumeration. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbinarymessage_setdata_742190524.md b/windows.devices.sms/smsbinarymessage_setdata_742190524.md index ac1f84bdfe..739d6a4c88 100644 --- a/windows.devices.sms/smsbinarymessage_setdata_742190524.md +++ b/windows.devices.sms/smsbinarymessage_setdata_742190524.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sms.SmsBinaryMessage.SetData(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Sms.SmsBinaryMessage.SetData ## -description Specifies the raw binary payload of the SMS message. It should be formatted according to the protocol description unit (PDU) standard. ## -parameters ### -param value A byte array representing message data. If there is no message data, the returned array is empty. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsBinaryMessage.SetData(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsBinaryMessage.SetData + +## -description +Specifies the raw binary payload of the SMS message. It should be formatted according to the protocol description unit (PDU) standard. + +## -parameters +### -param value +A byte array representing message data. If there is no message data, the returned array is empty. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbinarymessage_smsbinarymessage_1221375020.md b/windows.devices.sms/smsbinarymessage_smsbinarymessage_1221375020.md index ab5b41b7f1..4fdfce7052 100644 --- a/windows.devices.sms/smsbinarymessage_smsbinarymessage_1221375020.md +++ b/windows.devices.sms/smsbinarymessage_smsbinarymessage_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsBinaryMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Sms.SmsBinaryMessage.SmsBinaryMessage ## -description Creates an instance of the [SmsBinaryMessage](smsbinarymessage.md) class. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsBinaryMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsBinaryMessage.SmsBinaryMessage + +## -description +Creates an instance of the [SmsBinaryMessage](smsbinarymessage.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage.md b/windows.devices.sms/smsbroadcastmessage.md index 49cafa9882..dbab9bf3c4 100644 --- a/windows.devices.sms/smsbroadcastmessage.md +++ b/windows.devices.sms/smsbroadcastmessage.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Sms.SmsBroadcastMessage --api-type: winrt class ---- # Windows.Devices.Sms.SmsBroadcastMessage ## -description Represents a broadcast SMS message. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also [ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsBroadcastMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage + +## -description +Represents a broadcast SMS message. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also +[ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_body.md b/windows.devices.sms/smsbroadcastmessage_body.md index 3eaa2a599f..8ceef58486 100644 --- a/windows.devices.sms/smsbroadcastmessage_body.md +++ b/windows.devices.sms/smsbroadcastmessage_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.Body --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.Body ## -description Gets the body of the broadcast SMS message. ## -property-value The body of the broadcast SMS message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.Body + +## -description +Gets the body of the broadcast SMS message. + +## -property-value +The body of the broadcast SMS message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_broadcasttype.md b/windows.devices.sms/smsbroadcastmessage_broadcasttype.md index 0d33223abc..8cd2fec33d 100644 --- a/windows.devices.sms/smsbroadcastmessage_broadcasttype.md +++ b/windows.devices.sms/smsbroadcastmessage_broadcasttype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.BroadcastType --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.BroadcastType ## -description Gets the type of this broadcast SMS message. ## -property-value An enumeration value describing the type of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.BroadcastType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.BroadcastType + +## -description +Gets the type of this broadcast SMS message. + +## -property-value +An enumeration value describing the type of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_cellularclass.md b/windows.devices.sms/smsbroadcastmessage_cellularclass.md index aa5c137bcf..05432f7abf 100644 --- a/windows.devices.sms/smsbroadcastmessage_cellularclass.md +++ b/windows.devices.sms/smsbroadcastmessage_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.CellularClass ## -description Gets the cellular class of this broadcast message. ## -property-value An enumeration value describing the cellular class of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.CellularClass + +## -description +Gets the cellular class of this broadcast message. + +## -property-value +An enumeration value describing the cellular class of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_channel.md b/windows.devices.sms/smsbroadcastmessage_channel.md index 529adb0121..8a517ada49 100644 --- a/windows.devices.sms/smsbroadcastmessage_channel.md +++ b/windows.devices.sms/smsbroadcastmessage_channel.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.Channel --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.Channel ## -description Gets the channel associated with the broadcast SMS message. ## -property-value The channel for this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.Channel +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.Channel + +## -description +Gets the channel associated with the broadcast SMS message. + +## -property-value +The channel for this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_deviceid.md b/windows.devices.sms/smsbroadcastmessage_deviceid.md index ffcece1cb0..f2eca8074a 100644 --- a/windows.devices.sms/smsbroadcastmessage_deviceid.md +++ b/windows.devices.sms/smsbroadcastmessage_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.DeviceId ## -description Gets the device ID of the device that received the broadcast SMS message. ## -property-value The unique device ID of the device that received the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.DeviceId + +## -description +Gets the device ID of the device that received the broadcast SMS message. + +## -property-value +The unique device ID of the device that received the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_geographicalscope.md b/windows.devices.sms/smsbroadcastmessage_geographicalscope.md index fbbdfa638a..2f7d449a80 100644 --- a/windows.devices.sms/smsbroadcastmessage_geographicalscope.md +++ b/windows.devices.sms/smsbroadcastmessage_geographicalscope.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.GeographicalScope --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.GeographicalScope ## -description Gets the geographical scope associated with this broadcast SMS message. ## -property-value An enumeration value describing the geographical scope associated with this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.GeographicalScope +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.GeographicalScope + +## -description +Gets the geographical scope associated with this broadcast SMS message. + +## -property-value +An enumeration value describing the geographical scope associated with this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_isemergencyalert.md b/windows.devices.sms/smsbroadcastmessage_isemergencyalert.md index 4e09651d19..99cf7ec4ae 100644 --- a/windows.devices.sms/smsbroadcastmessage_isemergencyalert.md +++ b/windows.devices.sms/smsbroadcastmessage_isemergencyalert.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.IsEmergencyAlert --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.IsEmergencyAlert ## -description True when the broadcast SMS message is an emergency alert. ## -property-value True when the broadcast SMS message is an emergency alert. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.IsEmergencyAlert +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.IsEmergencyAlert + +## -description +True when the broadcast SMS message is an emergency alert. + +## -property-value +True when the broadcast SMS message is an emergency alert. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_isuserpopuprequested.md b/windows.devices.sms/smsbroadcastmessage_isuserpopuprequested.md index 038907cfdc..e01ec03221 100644 --- a/windows.devices.sms/smsbroadcastmessage_isuserpopuprequested.md +++ b/windows.devices.sms/smsbroadcastmessage_isuserpopuprequested.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.IsUserPopupRequested --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.IsUserPopupRequested ## -description True when a user popup is requested by this broadcast SMS message. ## -property-value True when a user popup is requested by this broadcast SMS message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.IsUserPopupRequested +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.IsUserPopupRequested + +## -description +True when a user popup is requested by this broadcast SMS message. + +## -property-value +True when a user popup is requested by this broadcast SMS message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_messageclass.md b/windows.devices.sms/smsbroadcastmessage_messageclass.md index 109c139122..afc825156e 100644 --- a/windows.devices.sms/smsbroadcastmessage_messageclass.md +++ b/windows.devices.sms/smsbroadcastmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.MessageClass ## -description Gets the message class associated with this broadcast SMS message. ## -property-value Enumeration value describing the message class of this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.MessageClass + +## -description +Gets the message class associated with this broadcast SMS message. + +## -property-value +Enumeration value describing the message class of this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_messagecode.md b/windows.devices.sms/smsbroadcastmessage_messagecode.md index d73bcb9062..66b68d8947 100644 --- a/windows.devices.sms/smsbroadcastmessage_messagecode.md +++ b/windows.devices.sms/smsbroadcastmessage_messagecode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.MessageCode --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.MessageCode ## -description Gets a code value associated with this broadcast SMS message. ## -property-value The code value associated with this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.MessageCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.MessageCode + +## -description +Gets a code value associated with this broadcast SMS message. + +## -property-value +The code value associated with this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_messagetype.md b/windows.devices.sms/smsbroadcastmessage_messagetype.md index a260c4a467..275fc61d01 100644 --- a/windows.devices.sms/smsbroadcastmessage_messagetype.md +++ b/windows.devices.sms/smsbroadcastmessage_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.MessageType ## -description Gets the message type of the broadcast SMS message. ## -property-value An enumeration value describing the message type. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.MessageType + +## -description +Gets the message type of the broadcast SMS message. + +## -property-value +An enumeration value describing the message type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_simiccid.md b/windows.devices.sms/smsbroadcastmessage_simiccid.md index 1031501717..f1fd5f2330 100644 --- a/windows.devices.sms/smsbroadcastmessage_simiccid.md +++ b/windows.devices.sms/smsbroadcastmessage_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_timestamp.md b/windows.devices.sms/smsbroadcastmessage_timestamp.md index bc91274023..486a0a7ce3 100644 --- a/windows.devices.sms/smsbroadcastmessage_timestamp.md +++ b/windows.devices.sms/smsbroadcastmessage_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.Timestamp ## -description Gets the timestamp of the broadcast SMS message. ## -property-value The timestamp of the message. Timestamp value is specified by the service center. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.Timestamp + +## -description +Gets the timestamp of the broadcast SMS message. + +## -property-value +The timestamp of the message. Timestamp value is specified by the service center. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_to.md b/windows.devices.sms/smsbroadcastmessage_to.md index de66ab5212..c7142bc6aa 100644 --- a/windows.devices.sms/smsbroadcastmessage_to.md +++ b/windows.devices.sms/smsbroadcastmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.To ## -description Gets the recipient phone number of the broadcast SMS message. ## -property-value A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.To + +## -description +Gets the recipient phone number of the broadcast SMS message. + +## -property-value +A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsbroadcastmessage_updatenumber.md b/windows.devices.sms/smsbroadcastmessage_updatenumber.md index 7266f16ab5..40ba2ed803 100644 --- a/windows.devices.sms/smsbroadcastmessage_updatenumber.md +++ b/windows.devices.sms/smsbroadcastmessage_updatenumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.UpdateNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsBroadcastMessage.UpdateNumber ## -description Gets the update number associated with this broadcast SMS message. ## -property-value The update number of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsBroadcastMessage.UpdateNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsBroadcastMessage.UpdateNumber + +## -description +Gets the update number associated with this broadcast SMS message. + +## -property-value +The update number of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2.md b/windows.devices.sms/smsdevice2.md index f4fb437653..3892d9f19e 100644 --- a/windows.devices.sms/smsdevice2.md +++ b/windows.devices.sms/smsdevice2.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Devices.Sms.SmsDevice2 --api-type: winrt class ---- # Windows.Devices.Sms.SmsDevice2 ## -description Extends the [SmsDevice](smsdevice.md) class, and supports the operation of a mobile broadband SMS device. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks Use this class as you would use the [SmsDevice](smsdevice.md) class, when you need the additional properties and methods this class provides. ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsDevice2 +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsDevice2 + +## -description +Extends the [SmsDevice](smsdevice.md) class, and supports the operation of a mobile broadband SMS device. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +Use this class as you would use the [SmsDevice](smsdevice.md) class, when you need the additional properties and methods this class provides. + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_accountphonenumber.md b/windows.devices.sms/smsdevice2_accountphonenumber.md index 56d8521a42..a58dc0702f 100644 --- a/windows.devices.sms/smsdevice2_accountphonenumber.md +++ b/windows.devices.sms/smsdevice2_accountphonenumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice2.AccountPhoneNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice2.AccountPhoneNumber ## -description Gets the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox. ## -property-value A string representation of the account phone number. ## -remarks ## -examples ## -see-also [SmsDevice.AccountPhoneNumber](smsdevice_accountphonenumber.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice2.AccountPhoneNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice2.AccountPhoneNumber + +## -description +Gets the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox. + +## -property-value +A string representation of the account phone number. + +## -remarks + +## -examples + +## -see-also +[SmsDevice.AccountPhoneNumber](smsdevice_accountphonenumber.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_calculatelength_2098933464.md b/windows.devices.sms/smsdevice2_calculatelength_2098933464.md index 40d67da4f6..8b8634e2fe 100644 --- a/windows.devices.sms/smsdevice2_calculatelength_2098933464.md +++ b/windows.devices.sms/smsdevice2_calculatelength_2098933464.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice2.CalculateLength(Windows.Devices.Sms.ISmsMessageBase) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice2.CalculateLength ## -description Estimates the transmitted message length of the specified text message. The estimate can be useful to clients that want to give an indication of how many messages will be sent on the network to carry the text of the full message. ## -parameters ### -param message A reference to the SMS text message to measure. ## -returns A reference to an SmsEncodedLength structure that is populated with the length information. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice2.CalculateLength(Windows.Devices.Sms.ISmsMessageBase) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice2.CalculateLength + +## -description +Estimates the transmitted message length of the specified text message. The estimate can be useful to clients that want to give an indication of how many messages will be sent on the network to carry the text of the full message. + +## -parameters +### -param message +A reference to the SMS text message to measure. + +## -returns +A reference to an SmsEncodedLength structure that is populated with the length information. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_cellularclass.md b/windows.devices.sms/smsdevice2_cellularclass.md index 8d7f6cc268..f02d3d2c66 100644 --- a/windows.devices.sms/smsdevice2_cellularclass.md +++ b/windows.devices.sms/smsdevice2_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice2.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice2.CellularClass ## -description Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect. ## -property-value An enumerated value indicating the device's cellular class. ## -remarks ## -examples ## -see-also [SmsDevice.CellularClass](smsdevice_cellularclass.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice2.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice2.CellularClass + +## -description +Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect. + +## -property-value +An enumerated value indicating the device's cellular class. + +## -remarks + +## -examples + +## -see-also +[SmsDevice.CellularClass](smsdevice_cellularclass.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_deviceid.md b/windows.devices.sms/smsdevice2_deviceid.md index 11db94acf8..fd48317f97 100644 --- a/windows.devices.sms/smsdevice2_deviceid.md +++ b/windows.devices.sms/smsdevice2_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice2.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice2.DeviceId ## -description The device ID of the device represented by this instance. ## -property-value String representation of the device ID. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice2.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice2.DeviceId + +## -description +The device ID of the device represented by this instance. + +## -property-value +String representation of the device ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_devicestatus.md b/windows.devices.sms/smsdevice2_devicestatus.md index 3fa17dbef3..5876a9777d 100644 --- a/windows.devices.sms/smsdevice2_devicestatus.md +++ b/windows.devices.sms/smsdevice2_devicestatus.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice2.DeviceStatus --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice2.DeviceStatus ## -description Returns the SMS device's status, which indicates whether the device is ready, or not. It also indicates what type of problem exists if the device is not ready. ## -property-value An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations. ## -remarks ## -examples ## -see-also [SmsDevice.DeviceStatus](smsdevice_devicestatus.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice2.DeviceStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice2.DeviceStatus + +## -description +Returns the SMS device's status, which indicates whether the device is ready, or not. It also indicates what type of problem exists if the device is not ready. + +## -property-value +An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations. + +## -remarks + +## -examples + +## -see-also +[SmsDevice.DeviceStatus](smsdevice_devicestatus.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_devicestatuschanged.md b/windows.devices.sms/smsdevice2_devicestatuschanged.md index 767c2f3b7d..85128882ff 100644 --- a/windows.devices.sms/smsdevice2_devicestatuschanged.md +++ b/windows.devices.sms/smsdevice2_devicestatuschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Sms.SmsDevice2.DeviceStatusChanged --api-type: winrt event ---- # Windows.Devices.Sms.SmsDevice2.DeviceStatusChanged ## -description Sets an event handler to be called when the status of the SMS device changes. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sms.SmsDevice2.DeviceStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sms.SmsDevice2.DeviceStatusChanged + +## -description +Sets an event handler to be called when the status of the SMS device changes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_fromid_114571398.md b/windows.devices.sms/smsdevice2_fromid_114571398.md index 34787d1361..a6625b68a3 100644 --- a/windows.devices.sms/smsdevice2_fromid_114571398.md +++ b/windows.devices.sms/smsdevice2_fromid_114571398.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice2.FromId(System.String) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice2.FromId ## -description Creates an instance of [SmsDevice2](smsdevice2.md) for a device that received an SMS message. ## -parameters ### -param deviceId A string representation of the device ID of the device that received an SMS message. ## -returns An instance of [SmsDevice2](smsdevice2.md) initialized for the device with the given ID. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice2.FromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice2.FromId + +## -description +Creates an instance of [SmsDevice2](smsdevice2.md) for a device that received an SMS message. + +## -parameters +### -param deviceId +A string representation of the device ID of the device that received an SMS message. + +## -returns +An instance of [SmsDevice2](smsdevice2.md) initialized for the device with the given ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_fromparentid_503628693.md b/windows.devices.sms/smsdevice2_fromparentid_503628693.md index 4656b4d1a6..ddbf7e93ed 100644 --- a/windows.devices.sms/smsdevice2_fromparentid_503628693.md +++ b/windows.devices.sms/smsdevice2_fromparentid_503628693.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice2.FromParentId(System.String) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice2.FromParentId ## -description Creates an instance of [SmsDevice2](smsdevice2.md) for a device, given the device ID of the parent device. ## -parameters ### -param parentDeviceId The device ID of the parent device. ## -returns An instance of [SmsDevice2](smsdevice2.md) initialized for the device with the given parent ID. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice2.FromParentId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice2.FromParentId + +## -description +Creates an instance of [SmsDevice2](smsdevice2.md) for a device, given the device ID of the parent device. + +## -parameters +### -param parentDeviceId +The device ID of the parent device. + +## -returns +An instance of [SmsDevice2](smsdevice2.md) initialized for the device with the given parent ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_getdefault_846721868.md b/windows.devices.sms/smsdevice2_getdefault_846721868.md index cf23131a2a..3ecb42f1f4 100644 --- a/windows.devices.sms/smsdevice2_getdefault_846721868.md +++ b/windows.devices.sms/smsdevice2_getdefault_846721868.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice2.GetDefault --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice2.GetDefault ## -description Creates an instance of [SmsDevice2](smsdevice2.md) associated with the default SMS device. ## -returns An instance of [SmsDevice2](smsdevice2.md) initialized for the default SMS device. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice2.GetDefault +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice2.GetDefault + +## -description +Creates an instance of [SmsDevice2](smsdevice2.md) associated with the default SMS device. + +## -returns +An instance of [SmsDevice2](smsdevice2.md) initialized for the default SMS device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_getdeviceselector_838466080.md b/windows.devices.sms/smsdevice2_getdeviceselector_838466080.md index 022b855401..7f84cfc370 100644 --- a/windows.devices.sms/smsdevice2_getdeviceselector_838466080.md +++ b/windows.devices.sms/smsdevice2_getdeviceselector_838466080.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice2.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice2.GetDeviceSelector ## -description Retrieves the class selection string that can be used to enumerate SMS devices. ## -returns A reference to an Advanced Query Syntax (AQS) string that identifies an SMS device. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice2.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice2.GetDeviceSelector + +## -description +Retrieves the class selection string that can be used to enumerate SMS devices. + +## -returns +A reference to an Advanced Query Syntax (AQS) string that identifies an SMS device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_parentdeviceid.md b/windows.devices.sms/smsdevice2_parentdeviceid.md index a47d629300..27d02b3653 100644 --- a/windows.devices.sms/smsdevice2_parentdeviceid.md +++ b/windows.devices.sms/smsdevice2_parentdeviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice2.ParentDeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice2.ParentDeviceId ## -description The parent device ID of this device. ## -property-value A string representation of the device ID of the parent to this device. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice2.ParentDeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice2.ParentDeviceId + +## -description +The parent device ID of this device. + +## -property-value +A string representation of the device ID of the parent to this device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_sendmessageandgetresultasync_123752871.md b/windows.devices.sms/smsdevice2_sendmessageandgetresultasync_123752871.md index 09ea4a93e3..0562174138 100644 --- a/windows.devices.sms/smsdevice2_sendmessageandgetresultasync_123752871.md +++ b/windows.devices.sms/smsdevice2_sendmessageandgetresultasync_123752871.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice2.SendMessageAndGetResultAsync(Windows.Devices.Sms.ISmsMessageBase) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice2.SendMessageAndGetResultAsync ## -description Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The message operation object is returned immediately. ## -parameters ### -param message A reference to an object that implements the [ISmsMessageBase](ismsmessagebase.md) interface. The message can be in text or binary format. ## -returns The message operation object. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice2.SendMessageAndGetResultAsync(Windows.Devices.Sms.ISmsMessageBase) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice2.SendMessageAndGetResultAsync + +## -description +Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The message operation object is returned immediately. + +## -parameters +### -param message +A reference to an object that implements the [ISmsMessageBase](ismsmessagebase.md) interface. The message can be in text or binary format. + +## -returns +The message operation object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice2_smscaddress.md b/windows.devices.sms/smsdevice2_smscaddress.md index a2784672d6..2e70fac48c 100644 --- a/windows.devices.sms/smsdevice2_smscaddress.md +++ b/windows.devices.sms/smsdevice2_smscaddress.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice2.SmscAddress --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice2.SmscAddress ## -description Gets or sets the SMSC address of this device. ## -property-value A string representation of the SMSC address of this device. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice2.SmscAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice2.SmscAddress + +## -description +Gets or sets the SMSC address of this device. + +## -property-value +A string representation of the SMSC address of this device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_accountphonenumber.md b/windows.devices.sms/smsdevice_accountphonenumber.md index dbdff000b2..735ddbb230 100644 --- a/windows.devices.sms/smsdevice_accountphonenumber.md +++ b/windows.devices.sms/smsdevice_accountphonenumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice.AccountPhoneNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice.AccountPhoneNumber ## -description Returns the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox. ## -property-value A string representation of the account phone number. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice.AccountPhoneNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice.AccountPhoneNumber + +## -description +Returns the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox. + +## -property-value +A string representation of the account phone number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_calculatelength_1029295099.md b/windows.devices.sms/smsdevice_calculatelength_1029295099.md index 92fb2c0a73..f33722e372 100644 --- a/windows.devices.sms/smsdevice_calculatelength_1029295099.md +++ b/windows.devices.sms/smsdevice_calculatelength_1029295099.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice.CalculateLength(Windows.Devices.Sms.SmsTextMessage) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice.CalculateLength ## -description Estimates the transmitted message length of the specified text message. The estimate can be useful to clients who want to give an indication of how many messages will be sent on the network to carry the text of the full message. ## -parameters ### -param message A reference to the SMS text message to measure. ## -returns A reference to an SmsEncodedLength structure that is populated with the length information. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice.CalculateLength(Windows.Devices.Sms.SmsTextMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice.CalculateLength + +## -description +Estimates the transmitted message length of the specified text message. The estimate can be useful to clients who want to give an indication of how many messages will be sent on the network to carry the text of the full message. + +## -parameters +### -param message +A reference to the SMS text message to measure. + +## -returns +A reference to an SmsEncodedLength structure that is populated with the length information. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_cellularclass.md b/windows.devices.sms/smsdevice_cellularclass.md index ae7a77cf33..a2007ed50f 100644 --- a/windows.devices.sms/smsdevice_cellularclass.md +++ b/windows.devices.sms/smsdevice_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice.CellularClass ## -description Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect. ## -property-value An enumerated value indicating the device's cellular class. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice.CellularClass + +## -description +Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect. + +## -property-value +An enumerated value indicating the device's cellular class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_devicestatus.md b/windows.devices.sms/smsdevice_devicestatus.md index ae589b243e..6ade9b7078 100644 --- a/windows.devices.sms/smsdevice_devicestatus.md +++ b/windows.devices.sms/smsdevice_devicestatus.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice.DeviceStatus --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice.DeviceStatus ## -description Returns the SMS device's status, which indicates whether the device is ready, or not. It also indicates what type of problem exists if the device is not ready. ## -property-value An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice.DeviceStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice.DeviceStatus + +## -description +Returns the SMS device's status, which indicates whether the device is ready, or not. It also indicates what type of problem exists if the device is not ready. + +## -property-value +An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_fromidasync_1322863552.md b/windows.devices.sms/smsdevice_fromidasync_1322863552.md index 204da2f0c6..8fa26ac85f 100644 --- a/windows.devices.sms/smsdevice_fromidasync_1322863552.md +++ b/windows.devices.sms/smsdevice_fromidasync_1322863552.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice.FromIdAsync ## -description Creates an instance of [SmsDevice](ismsdevice.md) for the device that received the SMS message. ## -parameters ### -param deviceId A string representation of the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID of the SMS device that received the SMS message. ## -returns The SMS device operation object. ## -remarks The [SmsReceivedEventDetails](smsreceivedeventdetails.md) interface handles the details of a received message; you can pass the [DeviceInformation](smsreceivedeventdetails_deviceid.md) ID from that interface to this method to activate the device and retrieve additional message details, such as the sender and the body of the message. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately. ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice.FromIdAsync + +## -description +Creates an instance of [SmsDevice](ismsdevice.md) for the device that received the SMS message. + +## -parameters +### -param deviceId +A string representation of the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID of the SMS device that received the SMS message. + +## -returns +The SMS device operation object. + +## -remarks +The [SmsReceivedEventDetails](smsreceivedeventdetails.md) interface handles the details of a received message; you can pass the [DeviceInformation](smsreceivedeventdetails_deviceid.md) ID from that interface to this method to activate the device and retrieve additional message details, such as the sender and the body of the message. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately. + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_fromnetworkaccountidasync_1793237152.md b/windows.devices.sms/smsdevice_fromnetworkaccountidasync_1793237152.md index ece92cd090..0ff21b74ff 100644 --- a/windows.devices.sms/smsdevice_fromnetworkaccountidasync_1793237152.md +++ b/windows.devices.sms/smsdevice_fromnetworkaccountidasync_1793237152.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice.FromNetworkAccountIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice.FromNetworkAccountIdAsync ## -description Creates an instance of [SmsDevice](ismsdevice.md) for the specified Mobile Broadband network account ID. ## -parameters ### -param networkAccountId The Mobile Broadband network account ID to use to select the corresponding mobile broadband device to use for the SMS device ## -returns When this method completes, it returns the [SmsDevice](smsdevice.md) for the specified Mobile Broadband network account ID. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice.FromNetworkAccountIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice.FromNetworkAccountIdAsync + +## -description +Creates an instance of [SmsDevice](ismsdevice.md) for the specified Mobile Broadband network account ID. + +## -parameters +### -param networkAccountId +The Mobile Broadband network account ID to use to select the corresponding mobile broadband device to use for the SMS device + +## -returns +When this method completes, it returns the [SmsDevice](smsdevice.md) for the specified Mobile Broadband network account ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_getdefaultasync_1549573963.md b/windows.devices.sms/smsdevice_getdefaultasync_1549573963.md index 8a1edee731..899fbacd2e 100644 --- a/windows.devices.sms/smsdevice_getdefaultasync_1549573963.md +++ b/windows.devices.sms/smsdevice_getdefaultasync_1549573963.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice.GetDefaultAsync ## -description Creates an instance of an [SmsDevice](ismsdevice.md) object associated with the default SMS device. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately. ## -returns A reference to an [IAsyncOperation(SmsDevice)](../windows.foundation/iasyncoperation_1.md) object that supports asynchronous [SmsDevice](smsdevice.md) object retrieval. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice.GetDefaultAsync + +## -description +Creates an instance of an [SmsDevice](ismsdevice.md) object associated with the default SMS device. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately. + +## -returns +A reference to an [IAsyncOperation(SmsDevice)](../windows.foundation/iasyncoperation_1.md) object that supports asynchronous [SmsDevice](smsdevice.md) object retrieval. + +## -remarks + + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_getdeviceselector_838466080.md b/windows.devices.sms/smsdevice_getdeviceselector_838466080.md index 585efe8c3e..3fac29621c 100644 --- a/windows.devices.sms/smsdevice_getdeviceselector_838466080.md +++ b/windows.devices.sms/smsdevice_getdeviceselector_838466080.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice.GetDeviceSelector ## -description Retrieves the class selection string that can be used to enumerate SMS devices. ## -returns A reference to an Advanced Query Syntax (AQS) string that identifies an SMS device. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice.GetDeviceSelector + +## -description +Retrieves the class selection string that can be used to enumerate SMS devices. + +## -returns +A reference to an Advanced Query Syntax (AQS) string that identifies an SMS device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_messagestore.md b/windows.devices.sms/smsdevice_messagestore.md index 79bafd24f0..9557c486af 100644 --- a/windows.devices.sms/smsdevice_messagestore.md +++ b/windows.devices.sms/smsdevice_messagestore.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDevice.MessageStore --api-type: winrt property ---- # Windows.Devices.Sms.SmsDevice.MessageStore ## -description Accesses the on-device message store. The store holds messages until a client can retrieve them. On some devices, for example, the store may correspond to the SIM storage for SMS messages. ## -property-value A reference to an [SmsDeviceMessageStore](smsdevicemessagestore.md) object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDevice.MessageStore +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDevice.MessageStore + +## -description +Accesses the on-device message store. The store holds messages until a client can retrieve them. On some devices, for example, the store may correspond to the SIM storage for SMS messages. + +## -property-value +A reference to an [SmsDeviceMessageStore](smsdevicemessagestore.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_sendmessageasync_558594201.md b/windows.devices.sms/smsdevice_sendmessageasync_558594201.md index aeb6570768..2d4126b9e7 100644 --- a/windows.devices.sms/smsdevice_sendmessageasync_558594201.md +++ b/windows.devices.sms/smsdevice_sendmessageasync_558594201.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDevice.SendMessageAsync(Windows.Devices.Sms.ISmsMessage) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDevice.SendMessageAsync ## -description Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The message operation object is returned immediately. ## -parameters ### -param message A reference to an [ISmsMessage](ismsmessage.md) object. The message can be in text or binary format. ## -returns The message operation object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDevice.SendMessageAsync(Windows.Devices.Sms.ISmsMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDevice.SendMessageAsync + +## -description +Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The message operation object is returned immediately. + +## -parameters +### -param message +A reference to an [ISmsMessage](ismsmessage.md) object. The message can be in text or binary format. + +## -returns +The message operation object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_smsdevicestatuschanged.md b/windows.devices.sms/smsdevice_smsdevicestatuschanged.md index a61ebdfbe6..e0ad3a14b2 100644 --- a/windows.devices.sms/smsdevice_smsdevicestatuschanged.md +++ b/windows.devices.sms/smsdevice_smsdevicestatuschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Sms.SmsDevice.SmsDeviceStatusChanged --api-type: winrt event ---- # Windows.Devices.Sms.SmsDevice.SmsDeviceStatusChanged ## -description Sets an event handler to be called when the status of the SMS device changes. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sms.SmsDevice.SmsDeviceStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Sms.SmsDevice.SmsDeviceStatusChanged + +## -description +Sets an event handler to be called when the status of the SMS device changes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevice_smsmessagereceived.md b/windows.devices.sms/smsdevice_smsmessagereceived.md index 2de78d8047..740a01a819 100644 --- a/windows.devices.sms/smsdevice_smsmessagereceived.md +++ b/windows.devices.sms/smsdevice_smsmessagereceived.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Sms.SmsDevice.SmsMessageReceived --api-type: winrt event ---- # Windows.Devices.Sms.SmsDevice.SmsMessageReceived ## -description Sets an event handler to be called when the device receives a new text message. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sms.SmsDevice.SmsMessageReceived +-api-type: winrt event +--- + + + +# Windows.Devices.Sms.SmsDevice.SmsMessageReceived + +## -description +Sets an event handler to be called when the device receives a new text message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevicemessagestore_deletemessageasync_1822155315.md b/windows.devices.sms/smsdevicemessagestore_deletemessageasync_1822155315.md index a53a4cabc4..1c2204a2d7 100644 --- a/windows.devices.sms/smsdevicemessagestore_deletemessageasync_1822155315.md +++ b/windows.devices.sms/smsdevicemessagestore_deletemessageasync_1822155315.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessageAsync(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessageAsync ## -description Deletes the message with the specified ID. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately. ## -parameters ### -param messageId Integer ID of the message to delete, which was previously read from an SmsTextMessage object obtained from the device message store. ## -returns A new message operation object that is used to start and track the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessageAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessageAsync + +## -description +Deletes the message with the specified ID. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately. + +## -parameters +### -param messageId +Integer ID of the message to delete, which was previously read from an SmsTextMessage object obtained from the device message store. + +## -returns +A new message operation object that is used to start and track the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevicemessagestore_deletemessagesasync_14783650.md b/windows.devices.sms/smsdevicemessagestore_deletemessagesasync_14783650.md index 8c4bd236db..3f330c7d70 100644 --- a/windows.devices.sms/smsdevicemessagestore_deletemessagesasync_14783650.md +++ b/windows.devices.sms/smsdevicemessagestore_deletemessagesasync_14783650.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessagesAsync(Windows.Devices.Sms.SmsMessageFilter) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessagesAsync ## -description Deletes the messages to which the filter applies. The filter can be used to delete all messages, or only messages that are read, unread, sent, or in a draft state. Because the operation might not be instantaneous, it executes asynchronously. The asynchronous operation object returns immediately. ## -parameters ### -param messageFilter A search filter that specifies which messages to delete. ## -returns A new message operation object that is used to start and track the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessagesAsync(Windows.Devices.Sms.SmsMessageFilter) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDeviceMessageStore.DeleteMessagesAsync + +## -description +Deletes the messages to which the filter applies. The filter can be used to delete all messages, or only messages that are read, unread, sent, or in a draft state. Because the operation might not be instantaneous, it executes asynchronously. The asynchronous operation object returns immediately. + +## -parameters +### -param messageFilter +A search filter that specifies which messages to delete. + +## -returns +A new message operation object that is used to start and track the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevicemessagestore_getmessageasync_746997042.md b/windows.devices.sms/smsdevicemessagestore_getmessageasync_746997042.md index fd96b7feeb..d172a2499a 100644 --- a/windows.devices.sms/smsdevicemessagestore_getmessageasync_746997042.md +++ b/windows.devices.sms/smsdevicemessagestore_getmessageasync_746997042.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.GetMessageAsync(System.UInt32) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDeviceMessageStore.GetMessageAsync ## -description Retrieves the message with the specified ID. The device might be busy, so the method executes asynchronously. The asynchronous operation object returns immediately. ## -parameters ### -param messageId ID of the message to retrieve. ## -returns Returns a new message operation object that is used to start and track the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.GetMessageAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDeviceMessageStore.GetMessageAsync + +## -description +Retrieves the message with the specified ID. The device might be busy, so the method executes asynchronously. The asynchronous operation object returns immediately. + +## -parameters +### -param messageId +ID of the message to retrieve. + +## -returns +Returns a new message operation object that is used to start and track the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevicemessagestore_getmessagesasync_1767936159.md b/windows.devices.sms/smsdevicemessagestore_getmessagesasync_1767936159.md index 39a7228b75..67a3b930be 100644 --- a/windows.devices.sms/smsdevicemessagestore_getmessagesasync_1767936159.md +++ b/windows.devices.sms/smsdevicemessagestore_getmessagesasync_1767936159.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.GetMessagesAsync(Windows.Devices.Sms.SmsMessageFilter) --api-type: winrt method ---- # Windows.Devices.Sms.SmsDeviceMessageStore.GetMessagesAsync ## -description Retrieves a list of messages that match the conditions specified in a filter. The messages can be filtered as read, unread, sent, or in the draft state. ## -parameters ### -param messageFilter ID of the message to retrieve. ## -returns Returns a new message operation object that is used to start and track the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsDeviceMessageStore.GetMessagesAsync(Windows.Devices.Sms.SmsMessageFilter) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsDeviceMessageStore.GetMessagesAsync + +## -description +Retrieves a list of messages that match the conditions specified in a filter. The messages can be filtered as read, unread, sent, or in the draft state. + +## -parameters +### -param messageFilter +ID of the message to retrieve. + +## -returns +Returns a new message operation object that is used to start and track the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsdevicemessagestore_maxmessages.md b/windows.devices.sms/smsdevicemessagestore_maxmessages.md index ce631a8b2a..80c63c06a1 100644 --- a/windows.devices.sms/smsdevicemessagestore_maxmessages.md +++ b/windows.devices.sms/smsdevicemessagestore_maxmessages.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsDeviceMessageStore.MaxMessages --api-type: winrt property ---- # Windows.Devices.Sms.SmsDeviceMessageStore.MaxMessages ## -description Indicates the maximum number of messages that can be stored in the device store. The client can use this value to determine how to maintain enough space in the device store to receive new messages from the network. ## -property-value An integer value representing the maximum number of messages for the device store. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsDeviceMessageStore.MaxMessages +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsDeviceMessageStore.MaxMessages + +## -description +Indicates the maximum number of messages that can be stored in the device store. The client can use this value to determine how to maintain enough space in the device store to receive new messages from the network. + +## -property-value +An integer value representing the maximum number of messages for the device store. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule.md b/windows.devices.sms/smsfilterrule.md index 6b89d4f235..81b607b9d4 100644 --- a/windows.devices.sms/smsfilterrule.md +++ b/windows.devices.sms/smsfilterrule.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Sms.SmsFilterRule --api-type: winrt class ---- # Windows.Devices.Sms.SmsFilterRule ## -description Describes an SMS filtering rule. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsFilterRule +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsFilterRule + +## -description +Describes an SMS filtering rule. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_broadcastchannels.md b/windows.devices.sms/smsfilterrule_broadcastchannels.md index 31b036ae8d..cacc5ef273 100644 --- a/windows.devices.sms/smsfilterrule_broadcastchannels.md +++ b/windows.devices.sms/smsfilterrule_broadcastchannels.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.BroadcastChannels --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.BroadcastChannels ## -description A list of broadcast channels that match this rule. ## -property-value List of broadcast channel identifiers that match this rule. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.BroadcastChannels +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.BroadcastChannels + +## -description +A list of broadcast channels that match this rule. + +## -property-value +List of broadcast channel identifiers that match this rule. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_broadcasttypes.md b/windows.devices.sms/smsfilterrule_broadcasttypes.md index 03627c55be..922a76a1c3 100644 --- a/windows.devices.sms/smsfilterrule_broadcasttypes.md +++ b/windows.devices.sms/smsfilterrule_broadcasttypes.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.BroadcastTypes --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.BroadcastTypes ## -description Gets a list of broadcast types for an SMS message that matches this rule. ## -property-value Enumeration values for broadcast types that match this rule. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.BroadcastTypes +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.BroadcastTypes + +## -description +Gets a list of broadcast types for an SMS message that matches this rule. + +## -property-value +Enumeration values for broadcast types that match this rule. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_cellularclass.md b/windows.devices.sms/smsfilterrule_cellularclass.md index 98a6de10f6..e8cdaf9138 100644 --- a/windows.devices.sms/smsfilterrule_cellularclass.md +++ b/windows.devices.sms/smsfilterrule_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.CellularClass ## -description The cellular class identifier for SMS messages that match this rule. ## -property-value The enumeration value for the cellular class that matches this rule. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.CellularClass + +## -description +The cellular class identifier for SMS messages that match this rule. + +## -property-value +The enumeration value for the cellular class that matches this rule. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_deviceids.md b/windows.devices.sms/smsfilterrule_deviceids.md index 00196f0d63..8984252739 100644 --- a/windows.devices.sms/smsfilterrule_deviceids.md +++ b/windows.devices.sms/smsfilterrule_deviceids.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.DeviceIds --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.DeviceIds ## -description Gets a list of device identifiers for an SMS message that matches this rule. ## -property-value List of device identifiers for the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.DeviceIds +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.DeviceIds + +## -description +Gets a list of device identifiers for an SMS message that matches this rule. + +## -property-value +List of device identifiers for the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_imsiprefixes.md b/windows.devices.sms/smsfilterrule_imsiprefixes.md index 62e149dd6e..5bb356047b 100644 --- a/windows.devices.sms/smsfilterrule_imsiprefixes.md +++ b/windows.devices.sms/smsfilterrule_imsiprefixes.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.ImsiPrefixes --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.ImsiPrefixes ## -description Gets the IMSI prefixes for an SMS message that matches this rule. ## -property-value A list of IMSI prefixes. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.ImsiPrefixes +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.ImsiPrefixes + +## -description +Gets the IMSI prefixes for an SMS message that matches this rule. + +## -property-value +A list of IMSI prefixes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_messagetype.md b/windows.devices.sms/smsfilterrule_messagetype.md index 5b882ea237..57992a84fd 100644 --- a/windows.devices.sms/smsfilterrule_messagetype.md +++ b/windows.devices.sms/smsfilterrule_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.MessageType ## -description Gets the message type of an SMS message that matches this filter rule. ## -property-value An enumeration value specifying the message type. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.MessageType + +## -description +Gets the message type of an SMS message that matches this filter rule. + +## -property-value +An enumeration value specifying the message type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_portnumbers.md b/windows.devices.sms/smsfilterrule_portnumbers.md index c852fa45bf..d9d23c256e 100644 --- a/windows.devices.sms/smsfilterrule_portnumbers.md +++ b/windows.devices.sms/smsfilterrule_portnumbers.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.PortNumbers --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.PortNumbers ## -description Gets a list of port numbers associated with the SMS message that matches this rule. ## -property-value List of port numbers. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.PortNumbers +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.PortNumbers + +## -description +Gets a list of port numbers associated with the SMS message that matches this rule. + +## -property-value +List of port numbers. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_protocolids.md b/windows.devices.sms/smsfilterrule_protocolids.md index 8fa50109d3..811b168a35 100644 --- a/windows.devices.sms/smsfilterrule_protocolids.md +++ b/windows.devices.sms/smsfilterrule_protocolids.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.ProtocolIds --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.ProtocolIds ## -description Gets a list of protocol identifiers associated with the SMS message that matches this rule.. ## -property-value List of protocol identifiers. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.ProtocolIds +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.ProtocolIds + +## -description +Gets a list of protocol identifiers associated with the SMS message that matches this rule.. + +## -property-value +List of protocol identifiers. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_sendernumbers.md b/windows.devices.sms/smsfilterrule_sendernumbers.md index 00e33830a3..de90e64932 100644 --- a/windows.devices.sms/smsfilterrule_sendernumbers.md +++ b/windows.devices.sms/smsfilterrule_sendernumbers.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.SenderNumbers --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.SenderNumbers ## -description Gets the sender numbers associated with an SMS message that matches this rule. ## -property-value List of sender numbers. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.SenderNumbers +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.SenderNumbers + +## -description +Gets the sender numbers associated with an SMS message that matches this rule. + +## -property-value +List of sender numbers. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_smsfilterrule_2115813883.md b/windows.devices.sms/smsfilterrule_smsfilterrule_2115813883.md index e605456103..8bbae01a98 100644 --- a/windows.devices.sms/smsfilterrule_smsfilterrule_2115813883.md +++ b/windows.devices.sms/smsfilterrule_smsfilterrule_2115813883.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sms.SmsFilterRule.#ctor(Windows.Devices.Sms.SmsMessageType) --api-type: winrt method ---- # Windows.Devices.Sms.SmsFilterRule.SmsFilterRule ## -description Creates a new, empty [SmsFilterRule](smsfilterrule.md). ## -parameters ### -param messageType An enumeration value specifying the message type that will match this rule. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsFilterRule.#ctor(Windows.Devices.Sms.SmsMessageType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsFilterRule.SmsFilterRule + +## -description +Creates a new, empty [SmsFilterRule](smsfilterrule.md). + +## -parameters +### -param messageType +An enumeration value specifying the message type that will match this rule. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_teleserviceids.md b/windows.devices.sms/smsfilterrule_teleserviceids.md index 9323fd4353..1315f1bed1 100644 --- a/windows.devices.sms/smsfilterrule_teleserviceids.md +++ b/windows.devices.sms/smsfilterrule_teleserviceids.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.TeleserviceIds --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.TeleserviceIds ## -description Gets the list of teleservice identifiers for an SMS message that matches this rule. ## -property-value Teleservice identifiers. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.TeleserviceIds +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.TeleserviceIds + +## -description +Gets the list of teleservice identifiers for an SMS message that matches this rule. + +## -property-value +Teleservice identifiers. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_textmessageprefixes.md b/windows.devices.sms/smsfilterrule_textmessageprefixes.md index 22af13f821..78019487e7 100644 --- a/windows.devices.sms/smsfilterrule_textmessageprefixes.md +++ b/windows.devices.sms/smsfilterrule_textmessageprefixes.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.TextMessagePrefixes --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.TextMessagePrefixes ## -description Gets a list of the text message prefixes for an SMS message that matches this filter. ## -property-value List of text message prefixes. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.TextMessagePrefixes +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.TextMessagePrefixes + +## -description +Gets a list of the text message prefixes for an SMS message that matches this filter. + +## -property-value +List of text message prefixes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_wapapplicationids.md b/windows.devices.sms/smsfilterrule_wapapplicationids.md index 06685bdff3..5e1abda9e1 100644 --- a/windows.devices.sms/smsfilterrule_wapapplicationids.md +++ b/windows.devices.sms/smsfilterrule_wapapplicationids.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.WapApplicationIds --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.WapApplicationIds ## -description Gets a list of WAP application identifiers for the SMS message that matches this rule. ## -property-value List of WAP application identifiers. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.WapApplicationIds +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.WapApplicationIds + +## -description +Gets a list of WAP application identifiers for the SMS message that matches this rule. + +## -property-value +List of WAP application identifiers. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrule_wapcontenttypes.md b/windows.devices.sms/smsfilterrule_wapcontenttypes.md index fe836ca56c..f7754fb9a1 100644 --- a/windows.devices.sms/smsfilterrule_wapcontenttypes.md +++ b/windows.devices.sms/smsfilterrule_wapcontenttypes.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRule.WapContentTypes --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRule.WapContentTypes ## -description Gets a list of WAP content types for the SMS message that matches this rule. ## -property-value List of WAP content types. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRule.WapContentTypes +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRule.WapContentTypes + +## -description +Gets a list of WAP content types for the SMS message that matches this rule. + +## -property-value +List of WAP content types. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrules.md b/windows.devices.sms/smsfilterrules.md index bf8ef8a50c..eee5b7ba38 100644 --- a/windows.devices.sms/smsfilterrules.md +++ b/windows.devices.sms/smsfilterrules.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Sms.SmsFilterRules --api-type: winrt class ---- # Windows.Devices.Sms.SmsFilterRules ## -description A collection of [SmsFilterRule](smsfilterrule_smsfilterrule.md) instances. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsFilterRules +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsFilterRules + +## -description +A collection of [SmsFilterRule](smsfilterrule_smsfilterrule.md) instances. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrules_actiontype.md b/windows.devices.sms/smsfilterrules_actiontype.md index b3426a0c5e..30c0f8547f 100644 --- a/windows.devices.sms/smsfilterrules_actiontype.md +++ b/windows.devices.sms/smsfilterrules_actiontype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRules.ActionType --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRules.ActionType ## -description The [SmsFilterActionType](smsfilteractiontype.md) for this set of filter rules. ## -property-value Specifies when and how the set of rules in this [SmsFilterRules](smsfilterrules.md) collection are to be applied to incoming SMS messages. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRules.ActionType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRules.ActionType + +## -description +The [SmsFilterActionType](smsfilteractiontype.md) for this set of filter rules. + +## -property-value +Specifies when and how the set of rules in this [SmsFilterRules](smsfilterrules.md) collection are to be applied to incoming SMS messages. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrules_rules.md b/windows.devices.sms/smsfilterrules_rules.md index 66088c2b7c..d68f8fc50e 100644 --- a/windows.devices.sms/smsfilterrules_rules.md +++ b/windows.devices.sms/smsfilterrules_rules.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsFilterRules.Rules --api-type: winrt property ---- # Windows.Devices.Sms.SmsFilterRules.Rules ## -description Gets the list of rules in this [SmsFilterRules](smsfilterrules.md) instance. ## -property-value A list of SMS filter rules. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsFilterRules.Rules +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsFilterRules.Rules + +## -description +Gets the list of rules in this [SmsFilterRules](smsfilterrules.md) instance. + +## -property-value +A list of SMS filter rules. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsfilterrules_smsfilterrules_1696418152.md b/windows.devices.sms/smsfilterrules_smsfilterrules_1696418152.md index 627b627aa1..f2b1fb796e 100644 --- a/windows.devices.sms/smsfilterrules_smsfilterrules_1696418152.md +++ b/windows.devices.sms/smsfilterrules_smsfilterrules_1696418152.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Sms.SmsFilterRules.#ctor(Windows.Devices.Sms.SmsFilterActionType) --api-type: winrt method ---- # Windows.Devices.Sms.SmsFilterRules.SmsFilterRules ## -description Creates an instance of [SmsFilterRules](smsfilterrules.md). ## -parameters ### -param actionType An enumeration value that specifies which action type is to be associated with the rules for this instance. Action type determines the order in which rules are evaluated, as well as the action to be taken when a rule is matched. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsFilterRules.#ctor(Windows.Devices.Sms.SmsFilterActionType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsFilterRules.SmsFilterRules + +## -description +Creates an instance of [SmsFilterRules](smsfilterrules.md). + +## -parameters +### -param actionType +An enumeration value that specifies which action type is to be associated with the rules for this instance. Action type determines the order in which rules are evaluated, as well as the action to be taken when a rule is matched. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedeventargs_binarymessage.md b/windows.devices.sms/smsmessagereceivedeventargs_binarymessage.md index 9b31d0a191..6354241c8a 100644 --- a/windows.devices.sms/smsmessagereceivedeventargs_binarymessage.md +++ b/windows.devices.sms/smsmessagereceivedeventargs_binarymessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedEventArgs.BinaryMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedEventArgs.BinaryMessage ## -description Retrieves an object that holds the binary representation of the message. This is of interest only to clients who want to pass binary messages on directly or do their own interpretation of the binary message contents. ## -property-value A reference to an [SmsBinaryMessage](smsbinarymessage.md) object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedEventArgs.BinaryMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedEventArgs.BinaryMessage + +## -description +Retrieves an object that holds the binary representation of the message. This is of interest only to clients who want to pass binary messages on directly or do their own interpretation of the binary message contents. + +## -property-value +A reference to an [SmsBinaryMessage](smsbinarymessage.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedeventargs_textmessage.md b/windows.devices.sms/smsmessagereceivedeventargs_textmessage.md index 024b51ad10..01984be018 100644 --- a/windows.devices.sms/smsmessagereceivedeventargs_textmessage.md +++ b/windows.devices.sms/smsmessagereceivedeventargs_textmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedEventArgs.TextMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedEventArgs.TextMessage ## -description Retrieves an object that holds the text representation of the message. If the message is not successfully decoded, an error is returned. ## -property-value A new [SmsTextMessage](smstextmessage.md) object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedEventArgs.TextMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedEventArgs.TextMessage + +## -description +Retrieves an object that holds the text representation of the message. If the message is not successfully decoded, an error is returned. + +## -property-value +A new [SmsTextMessage](smstextmessage.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails.md b/windows.devices.sms/smsmessagereceivedtriggerdetails.md index 6f7a9b1211..e54c8a202d 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails --api-type: winrt class ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails ## -description Contains event details for the event raised when an SMS message is received. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks You access an [SmsMessageReceivedTriggerDetails](smsmessagereceivedtriggerdetails.md) object through the function that you implement to handle the [SmsMessageRegistration.MessageReceived](smsmessageregistration_messagereceived.md) event. Your filtering code is required to acknowledge each filtered message by calling [Drop](smsmessagereceivedtriggerdetails_drop.md) or [Accept](smsmessagereceivedtriggerdetails_accept.md) before it can process the next message. ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails + +## -description +Contains event details for the event raised when an SMS message is received. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +You access an [SmsMessageReceivedTriggerDetails](smsmessagereceivedtriggerdetails.md) object through the function that you implement to handle the [SmsMessageRegistration.MessageReceived](smsmessageregistration_messagereceived.md) event. + +Your filtering code is required to acknowledge each filtered message by calling [Drop](smsmessagereceivedtriggerdetails_drop.md) or [Accept](smsmessagereceivedtriggerdetails_accept.md) before it can process the next message. + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_accept_1944939200.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_accept_1944939200.md index ca9f5e014c..dee21078a8 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_accept_1944939200.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_accept_1944939200.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Accept --api-type: winrt method ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Accept ## -description Delivers the filtered message to the messaging app. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Accept +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Accept + +## -description +Delivers the filtered message to the messaging app. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_appmessage.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_appmessage.md index 5b88a7d80a..f6c79be20b 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_appmessage.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_appmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.AppMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.AppMessage ## -description When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **App**, the message details for the message. ## -property-value Message details for the received message, when it is an app message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.AppMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.AppMessage + +## -description +When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **App**, the message details for the message. + +## -property-value +Message details for the received message, when it is an app message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_broadcastmessage.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_broadcastmessage.md index cdc86bc275..56eadcb966 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_broadcastmessage.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_broadcastmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.BroadcastMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.BroadcastMessage ## -description When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Broadcast**, the message details for the message. ## -property-value Message details for the received message, when it is a broadcast message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.BroadcastMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.BroadcastMessage + +## -description +When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Broadcast**, the message details for the message. + +## -property-value +Message details for the received message, when it is a broadcast message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_drop_1201404469.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_drop_1201404469.md index a2d96f2f3d..e1ad87ddf1 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_drop_1201404469.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_drop_1201404469.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Drop --api-type: winrt method ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Drop ## -description Drops the filtered message, so that it is not passed on to the messaging app. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Drop +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.Drop + +## -description +Drops the filtered message, so that it is not passed on to the messaging app. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_messagetype.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_messagetype.md index d8651e3c4c..abe3b8dd3b 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_messagetype.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.MessageType ## -description The [SmsMessageType](smsmessagetype.md) of the received message. ## -property-value The type of the received message. Use this value to determine which of the other properties of this instance is valid. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.MessageType + +## -description +The [SmsMessageType](smsmessagetype.md) of the received message. + +## -property-value +The type of the received message. Use this value to determine which of the other properties of this instance is valid. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_statusmessage.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_statusmessage.md index 2d679a9e54..a4caa61654 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_statusmessage.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_statusmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.StatusMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.StatusMessage ## -description When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Status**, the message details for the message. ## -property-value Message details for the received message, when it is a status message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.StatusMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.StatusMessage + +## -description +When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Status**, the message details for the message. + +## -property-value +Message details for the received message, when it is a status message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_textmessage.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_textmessage.md index e03d48dd3f..f5be33cf71 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_textmessage.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_textmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.TextMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.TextMessage ## -description When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Text**, the message details for the message. ## -property-value Message details for the received message, when it is a text message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.TextMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.TextMessage + +## -description +When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Text**, the message details for the message. + +## -property-value +Message details for the received message, when it is a text message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_voicemailmessage.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_voicemailmessage.md index 23f80784ac..f305bc3699 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_voicemailmessage.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_voicemailmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.VoicemailMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.VoicemailMessage ## -description When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Voicemail**, the message details for the message. ## -property-value Message details for the received message, when it is a voicemail message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.VoicemailMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.VoicemailMessage + +## -description +When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Voicemail**, the message details for the message. + +## -property-value +Message details for the received message, when it is a voicemail message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessagereceivedtriggerdetails_wapmessage.md b/windows.devices.sms/smsmessagereceivedtriggerdetails_wapmessage.md index b7391b371a..2ad76405e4 100644 --- a/windows.devices.sms/smsmessagereceivedtriggerdetails_wapmessage.md +++ b/windows.devices.sms/smsmessagereceivedtriggerdetails_wapmessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.WapMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.WapMessage ## -description When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Wap**, the message details for the message. ## -property-value Message details for the received message, when it is a WAP message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.WapMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageReceivedTriggerDetails.WapMessage + +## -description +When [MessageType](smsmessagereceivedtriggerdetails_messagetype.md) is **Wap**, the message details for the message. + +## -property-value +Message details for the received message, when it is a WAP message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessageregistration.md b/windows.devices.sms/smsmessageregistration.md index 9228cf9228..fe77235909 100644 --- a/windows.devices.sms/smsmessageregistration.md +++ b/windows.devices.sms/smsmessageregistration.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Devices.Sms.SmsMessageRegistration --api-type: winrt class ---- # Windows.Devices.Sms.SmsMessageRegistration ## -description Class used to represent registered message filters. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks Your code does not instantiate this class directly. A newly-created instance of the class is returned by the [SmsMessageRegistration.Register](smsmessageregistration_register.md) method, and you can retrieve a collection of instances representing existing registrations using the static [SmsMessageRegistration.AllRegistrations](smsmessageregistration_allregistrations.md) property. ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsMessageRegistration +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsMessageRegistration + +## -description +Class used to represent registered message filters. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +Your code does not instantiate this class directly. A newly-created instance of the class is returned by the [SmsMessageRegistration.Register](smsmessageregistration_register.md) method, and you can retrieve a collection of instances representing existing registrations using the static [SmsMessageRegistration.AllRegistrations](smsmessageregistration_allregistrations.md) property. + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessageregistration_allregistrations.md b/windows.devices.sms/smsmessageregistration_allregistrations.md index da915080f4..d090161036 100644 --- a/windows.devices.sms/smsmessageregistration_allregistrations.md +++ b/windows.devices.sms/smsmessageregistration_allregistrations.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageRegistration.AllRegistrations --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageRegistration.AllRegistrations ## -description Static property that gets a list of currently registered message filters.. ## -property-value A list of current registrations. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageRegistration.AllRegistrations +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageRegistration.AllRegistrations + +## -description +Static property that gets a list of currently registered message filters.. + +## -property-value +A list of current registrations. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessageregistration_id.md b/windows.devices.sms/smsmessageregistration_id.md index c7c3bf1df0..ea59fd34fd 100644 --- a/windows.devices.sms/smsmessageregistration_id.md +++ b/windows.devices.sms/smsmessageregistration_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsMessageRegistration.Id --api-type: winrt property ---- # Windows.Devices.Sms.SmsMessageRegistration.Id ## -description Gets an identifier for this registered message filter. ## -property-value The identifier specified at registration. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsMessageRegistration.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsMessageRegistration.Id + +## -description +Gets an identifier for this registered message filter. + +## -property-value +The identifier specified at registration. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessageregistration_messagereceived.md b/windows.devices.sms/smsmessageregistration_messagereceived.md index fb35e12e1f..8d154200f7 100644 --- a/windows.devices.sms/smsmessageregistration_messagereceived.md +++ b/windows.devices.sms/smsmessageregistration_messagereceived.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Devices.Sms.SmsMessageRegistration.MessageReceived --api-type: winrt event ---- # Windows.Devices.Sms.SmsMessageRegistration.MessageReceived ## -description Event signaled when a message has been received that meets the filter criteria set in a registered message filter. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: E:Windows.Devices.Sms.SmsMessageRegistration.MessageReceived +-api-type: winrt event +--- + + + +# Windows.Devices.Sms.SmsMessageRegistration.MessageReceived + +## -description +Event signaled when a message has been received that meets the filter criteria set in a registered message filter. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessageregistration_register_1493443681.md b/windows.devices.sms/smsmessageregistration_register_1493443681.md index cbb0c7e67f..a11227cdd3 100644 --- a/windows.devices.sms/smsmessageregistration_register_1493443681.md +++ b/windows.devices.sms/smsmessageregistration_register_1493443681.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Sms.SmsMessageRegistration.Register(System.String,Windows.Devices.Sms.SmsFilterRules) --api-type: winrt method ---- # Windows.Devices.Sms.SmsMessageRegistration.Register ## -description Registers a message filter. ## -parameters ### -param id Identifier used to describe this message filter. ### -param filterRules An object that represents the filter rules to be used for this registered message filter. ## -returns On successful completion, the [SmsMessageRegistration](smsmessageregistration.md) object that represents this registered message filter. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsMessageRegistration.Register(System.String,Windows.Devices.Sms.SmsFilterRules) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsMessageRegistration.Register + +## -description +Registers a message filter. + +## -parameters +### -param id +Identifier used to describe this message filter. + +### -param filterRules +An object that represents the filter rules to be used for this registered message filter. + +## -returns +On successful completion, the [SmsMessageRegistration](smsmessageregistration.md) object that represents this registered message filter. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsmessageregistration_unregister_1708113967.md b/windows.devices.sms/smsmessageregistration_unregister_1708113967.md index 07e396e1eb..5eb1cde46b 100644 --- a/windows.devices.sms/smsmessageregistration_unregister_1708113967.md +++ b/windows.devices.sms/smsmessageregistration_unregister_1708113967.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsMessageRegistration.Unregister --api-type: winrt method ---- # Windows.Devices.Sms.SmsMessageRegistration.Unregister ## -description Unregisters a previously-registered message filter. The filter will no longer be applied to incoming messages. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsMessageRegistration.Unregister +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsMessageRegistration.Unregister + +## -description +Unregisters a previously-registered message filter. The filter will no longer be applied to incoming messages. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsreceivedeventdetails_binarymessage.md b/windows.devices.sms/smsreceivedeventdetails_binarymessage.md index f41fcbfa58..dab95fcde4 100644 --- a/windows.devices.sms/smsreceivedeventdetails_binarymessage.md +++ b/windows.devices.sms/smsreceivedeventdetails_binarymessage.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.BinaryMessage --api-type: winrt property ---- # Windows.Devices.Sms.SmsReceivedEventDetails.BinaryMessage ## -description Gets the binary message object for the SMS message received by the background task. ## -property-value The binary message object for the SMS message received by the background task. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.BinaryMessage +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsReceivedEventDetails.BinaryMessage + +## -description +Gets the binary message object for the SMS message received by the background task. + +## -property-value +The binary message object for the SMS message received by the background task. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsreceivedeventdetails_deviceid.md b/windows.devices.sms/smsreceivedeventdetails_deviceid.md index 28b308f4cd..fd7a0c5674 100644 --- a/windows.devices.sms/smsreceivedeventdetails_deviceid.md +++ b/windows.devices.sms/smsreceivedeventdetails_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsReceivedEventDetails.DeviceId ## -description Returns the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID of the network interface that received the SMS message. This ID can be passed to [SmsDevice.FromIdAsync](smsdevice_fromidasync.md) to activate the device and retrieve additional message details. ## -property-value A string containing the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID of the SMS network interface (device). This value is typically used to retrieve details such as the sender and the body of the message. For example, you might use the ID to display a popup telling the user that a new message from a particular person has arrived. The combination of [DeviceId](smsreceivedeventdetails_deviceid.md) and [MessageIndex](smsreceivedeventdetails_messageindex.md) is sufficient to retrieve the new message from the SMS device. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsReceivedEventDetails.DeviceId + +## -description +Returns the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID of the network interface that received the SMS message. This ID can be passed to [SmsDevice.FromIdAsync](smsdevice_fromidasync.md) to activate the device and retrieve additional message details. + +## -property-value +A string containing the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID of the SMS network interface (device). This value is typically used to retrieve details such as the sender and the body of the message. For example, you might use the ID to display a popup telling the user that a new message from a particular person has arrived. The combination of [DeviceId](smsreceivedeventdetails_deviceid.md) and [MessageIndex](smsreceivedeventdetails_messageindex.md) is sufficient to retrieve the new message from the SMS device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsreceivedeventdetails_messageclass.md b/windows.devices.sms/smsreceivedeventdetails_messageclass.md index f116f4e02c..55a8b04c14 100644 --- a/windows.devices.sms/smsreceivedeventdetails_messageclass.md +++ b/windows.devices.sms/smsreceivedeventdetails_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsReceivedEventDetails.MessageClass ## -description Gets the message class for the SMS message received by the background task. ## -property-value The message class for the SMS message received by the background task. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsReceivedEventDetails.MessageClass + +## -description +Gets the message class for the SMS message received by the background task. + +## -property-value +The message class for the SMS message received by the background task. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsreceivedeventdetails_messageindex.md b/windows.devices.sms/smsreceivedeventdetails_messageindex.md index 6957efd5d8..c1851fbbcb 100644 --- a/windows.devices.sms/smsreceivedeventdetails_messageindex.md +++ b/windows.devices.sms/smsreceivedeventdetails_messageindex.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.MessageIndex --api-type: winrt property ---- # Windows.Devices.Sms.SmsReceivedEventDetails.MessageIndex ## -description Returns the index of the new message that raised the event. You can pass this to [SmsDevice.GetMessageAsync](smsdevicemessagestore_getmessageasync.md) to retrieve the new message itself. ## -property-value An integer index of the new message. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsReceivedEventDetails.MessageIndex +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsReceivedEventDetails.MessageIndex + +## -description +Returns the index of the new message that raised the event. You can pass this to [SmsDevice.GetMessageAsync](smsdevicemessagestore_getmessageasync.md) to retrieve the new message itself. + +## -property-value +An integer index of the new message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult.md b/windows.devices.sms/smssendmessageresult.md index 3a2741eb16..36c4150ef4 100644 --- a/windows.devices.sms/smssendmessageresult.md +++ b/windows.devices.sms/smssendmessageresult.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Devices.Sms.SmsSendMessageResult --api-type: winrt class ---- # Windows.Devices.Sms.SmsSendMessageResult ## -description Encapsulates the results of calling [SmsDevice2.SendMessageAndGetResultAsync](smsdevice2_sendmessageandgetresultasync.md). > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks You access an [SmsSendMessageResult](smssendmessageresult.md) object through the asynchronous result of the [SmsDevice2.SendMessageAndGetResultAsync](smsdevice2_sendmessageandgetresultasync.md) method. For information about working with the results of asynchronous methods, see [Asynchronous programming (Windows Runtime apps)](http://msdn.microsoft.com/library/904ff97c-bb36-4ac5-9eda-a961e3639415). ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsSendMessageResult +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult + +## -description +Encapsulates the results of calling [SmsDevice2.SendMessageAndGetResultAsync](smsdevice2_sendmessageandgetresultasync.md). + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +You access an [SmsSendMessageResult](smssendmessageresult.md) object through the asynchronous result of the [SmsDevice2.SendMessageAndGetResultAsync](smsdevice2_sendmessageandgetresultasync.md) method. For information about working with the results of asynchronous methods, see [Asynchronous programming (Windows Runtime apps)](http://msdn.microsoft.com/library/904ff97c-bb36-4ac5-9eda-a961e3639415). + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_cellularclass.md b/windows.devices.sms/smssendmessageresult_cellularclass.md index 86dd79d152..8d88a3fa72 100644 --- a/windows.devices.sms/smssendmessageresult_cellularclass.md +++ b/windows.devices.sms/smssendmessageresult_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.CellularClass ## -description Gets the cellular class used in the send operation. ## -property-value An enumeration value giving the cellular class used in the send operation. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.CellularClass + +## -description +Gets the cellular class used in the send operation. + +## -property-value +An enumeration value giving the cellular class used in the send operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_iserrortransient.md b/windows.devices.sms/smssendmessageresult_iserrortransient.md index ec6fb5ac80..83794af0c0 100644 --- a/windows.devices.sms/smssendmessageresult_iserrortransient.md +++ b/windows.devices.sms/smssendmessageresult_iserrortransient.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.IsErrorTransient --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.IsErrorTransient ## -description Gets a boolean value indicating whether the send operation has encountered a transient error. ## -property-value When true, the send resulted in an transient error. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.IsErrorTransient +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.IsErrorTransient + +## -description +Gets a boolean value indicating whether the send operation has encountered a transient error. + +## -property-value +When true, the send resulted in an transient error. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_issuccessful.md b/windows.devices.sms/smssendmessageresult_issuccessful.md index d1a5f3da8a..cb2e82acb3 100644 --- a/windows.devices.sms/smssendmessageresult_issuccessful.md +++ b/windows.devices.sms/smssendmessageresult_issuccessful.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.IsSuccessful --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.IsSuccessful ## -description Gets a value indicating whether the send operation was successful. ## -property-value When true, the send operation has completed successfully. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.IsSuccessful +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.IsSuccessful + +## -description +Gets a value indicating whether the send operation was successful. + +## -property-value +When true, the send operation has completed successfully. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_messagereferencenumbers.md b/windows.devices.sms/smssendmessageresult_messagereferencenumbers.md index 0b74cbd006..64d63933b1 100644 --- a/windows.devices.sms/smssendmessageresult_messagereferencenumbers.md +++ b/windows.devices.sms/smssendmessageresult_messagereferencenumbers.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.MessageReferenceNumbers --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.MessageReferenceNumbers ## -description Gets a list of message numbers sent. ## -property-value A list of message numbers that were sent. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.MessageReferenceNumbers +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.MessageReferenceNumbers + +## -description +Gets a list of message numbers sent. + +## -property-value +A list of message numbers that were sent. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_modemerrorcode.md b/windows.devices.sms/smssendmessageresult_modemerrorcode.md index 7f5697b516..a2c6654e00 100644 --- a/windows.devices.sms/smssendmessageresult_modemerrorcode.md +++ b/windows.devices.sms/smssendmessageresult_modemerrorcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.ModemErrorCode --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.ModemErrorCode ## -description Gets the error code for a modem error associated with the send operation. ## -property-value An enumeration value describing the error that occurred. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.ModemErrorCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.ModemErrorCode + +## -description +Gets the error code for a modem error associated with the send operation. + +## -property-value +An enumeration value describing the error that occurred. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_networkcausecode.md b/windows.devices.sms/smssendmessageresult_networkcausecode.md index 3a26c50e52..0b75bf0f9f 100644 --- a/windows.devices.sms/smssendmessageresult_networkcausecode.md +++ b/windows.devices.sms/smssendmessageresult_networkcausecode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.NetworkCauseCode --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.NetworkCauseCode ## -description Gets the error code for a network error associated with the send operation. ## -property-value Network-specific error codes. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.NetworkCauseCode +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.NetworkCauseCode + +## -description +Gets the error code for a network error associated with the send operation. + +## -property-value +Network-specific error codes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smssendmessageresult_transportfailurecause.md b/windows.devices.sms/smssendmessageresult_transportfailurecause.md index 1af9324c59..1aa950bb7a 100644 --- a/windows.devices.sms/smssendmessageresult_transportfailurecause.md +++ b/windows.devices.sms/smssendmessageresult_transportfailurecause.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsSendMessageResult.TransportFailureCause --api-type: winrt property ---- # Windows.Devices.Sms.SmsSendMessageResult.TransportFailureCause ## -description Gets the error code for a transport failure associated with the send operation. ## -property-value Transport-specific error code. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsSendMessageResult.TransportFailureCause +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsSendMessageResult.TransportFailureCause + +## -description +Gets the error code for a transport failure associated with the send operation. + +## -property-value +Transport-specific error code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage.md b/windows.devices.sms/smsstatusmessage.md index b1a5e6e726..26947dcdd3 100644 --- a/windows.devices.sms/smsstatusmessage.md +++ b/windows.devices.sms/smsstatusmessage.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.Devices.Sms.SmsStatusMessage --api-type: winrt class ---- # Windows.Devices.Sms.SmsStatusMessage ## -description Encapsulates an SMS status message. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). To access a received status message, create a background task that is triggered by the SmsMessageReceived event. In that task, first use [SmsMessageReceivedTriggerDetails.MessageType](smsmessagereceivedtriggerdetails_messagetype.md) to determine that the message is a status message, then use the [SmsMessageReceivedTriggerDetails.StatusMessage](smsmessagereceivedtriggerdetails_textmessage.md) property to access the instance of this class. ## -remarks ## -examples ## -see-also [ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsStatusMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsStatusMessage + +## -description +Encapsulates an SMS status message. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +To access a received status message, create a background task that is triggered by the SmsMessageReceived event. In that task, first use [SmsMessageReceivedTriggerDetails.MessageType](smsmessagereceivedtriggerdetails_messagetype.md) to determine that the message is a status message, then use the [SmsMessageReceivedTriggerDetails.StatusMessage](smsmessagereceivedtriggerdetails_textmessage.md) property to access the instance of this class. + +## -remarks + +## -examples + +## -see-also +[ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_body.md b/windows.devices.sms/smsstatusmessage_body.md index 58e04d9d88..462d3edd99 100644 --- a/windows.devices.sms/smsstatusmessage_body.md +++ b/windows.devices.sms/smsstatusmessage_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.Body --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.Body ## -description Gets the body of the status message. ## -property-value The plain text body of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.Body + +## -description +Gets the body of the status message. + +## -property-value +The plain text body of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_cellularclass.md b/windows.devices.sms/smsstatusmessage_cellularclass.md index 1214cd1b3f..aecdbd3068 100644 --- a/windows.devices.sms/smsstatusmessage_cellularclass.md +++ b/windows.devices.sms/smsstatusmessage_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.CellularClass ## -description Gets the cellular class of the message. ## -property-value An enumeration value describing the message's cellular class. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.CellularClass + +## -description +Gets the cellular class of the message. + +## -property-value +An enumeration value describing the message's cellular class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_deviceid.md b/windows.devices.sms/smsstatusmessage_deviceid.md index de7fdee30d..f0325c2fec 100644 --- a/windows.devices.sms/smsstatusmessage_deviceid.md +++ b/windows.devices.sms/smsstatusmessage_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.DeviceId ## -description Gets the device identifier associated with the status message. ## -property-value The unique device identifier, as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.DeviceId + +## -description +Gets the device identifier associated with the status message. + +## -property-value +The unique device identifier, as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_dischargetime.md b/windows.devices.sms/smsstatusmessage_dischargetime.md index b1a5e0f90b..5bdb55ca18 100644 --- a/windows.devices.sms/smsstatusmessage_dischargetime.md +++ b/windows.devices.sms/smsstatusmessage_dischargetime.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.DischargeTime --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.DischargeTime ## -description The discharge time of the status message. ## -property-value The discharge time. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.DischargeTime +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.DischargeTime + +## -description +The discharge time of the status message. + +## -property-value +The discharge time. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_from.md b/windows.devices.sms/smsstatusmessage_from.md index 24746ff44b..fbc31a9858 100644 --- a/windows.devices.sms/smsstatusmessage_from.md +++ b/windows.devices.sms/smsstatusmessage_from.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.From --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.From ## -description Gets the phone number that sent the status message. ## -property-value The sending phone number, as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.From +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.From + +## -description +Gets the phone number that sent the status message. + +## -property-value +The sending phone number, as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_messageclass.md b/windows.devices.sms/smsstatusmessage_messageclass.md index 99425f40dd..711a67c324 100644 --- a/windows.devices.sms/smsstatusmessage_messageclass.md +++ b/windows.devices.sms/smsstatusmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.MessageClass ## -description Gets the message class of the status message. ## -property-value An enumeration value giving the message class of the status message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.MessageClass + +## -description +Gets the message class of the status message. + +## -property-value +An enumeration value giving the message class of the status message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_messagereferencenumber.md b/windows.devices.sms/smsstatusmessage_messagereferencenumber.md index 97b81219fd..26af266d5f 100644 --- a/windows.devices.sms/smsstatusmessage_messagereferencenumber.md +++ b/windows.devices.sms/smsstatusmessage_messagereferencenumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.MessageReferenceNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.MessageReferenceNumber ## -description Gets the reference number of the status message. ## -property-value The message number. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.MessageReferenceNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.MessageReferenceNumber + +## -description +Gets the reference number of the status message. + +## -property-value +The message number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_messagetype.md b/windows.devices.sms/smsstatusmessage_messagetype.md index 02f6c15c46..ce59644a0b 100644 --- a/windows.devices.sms/smsstatusmessage_messagetype.md +++ b/windows.devices.sms/smsstatusmessage_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.MessageType ## -description Gets the message type of the status message. ## -property-value An enumeration value giving the message type of this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.MessageType + +## -description +Gets the message type of the status message. + +## -property-value +An enumeration value giving the message type of this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_servicecentertimestamp.md b/windows.devices.sms/smsstatusmessage_servicecentertimestamp.md index b942291cf1..68dbcc8966 100644 --- a/windows.devices.sms/smsstatusmessage_servicecentertimestamp.md +++ b/windows.devices.sms/smsstatusmessage_servicecentertimestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.ServiceCenterTimestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.ServiceCenterTimestamp ## -description Gets the service center timestamp of the status message. ## -property-value The service center date and time when the status message was sent. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.ServiceCenterTimestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.ServiceCenterTimestamp + +## -description +Gets the service center timestamp of the status message. + +## -property-value +The service center date and time when the status message was sent. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_simiccid.md b/windows.devices.sms/smsstatusmessage_simiccid.md index 90ec8aff2d..0dd5682f36 100644 --- a/windows.devices.sms/smsstatusmessage_simiccid.md +++ b/windows.devices.sms/smsstatusmessage_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_status.md b/windows.devices.sms/smsstatusmessage_status.md index 2c4248aebc..bd8c59588c 100644 --- a/windows.devices.sms/smsstatusmessage_status.md +++ b/windows.devices.sms/smsstatusmessage_status.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.Status --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.Status ## -description The status code associated with this message. ## -property-value The status in this status message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.Status + +## -description +The status code associated with this message. + +## -property-value +The status in this status message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsstatusmessage_to.md b/windows.devices.sms/smsstatusmessage_to.md index 1d54ab375b..d30362e703 100644 --- a/windows.devices.sms/smsstatusmessage_to.md +++ b/windows.devices.sms/smsstatusmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsStatusMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsStatusMessage.To ## -description Gets the phone number the status message was sent to. ## -property-value The phone number, as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsStatusMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsStatusMessage.To + +## -description +Gets the phone number the status message was sent to. + +## -property-value +The phone number, as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2.md b/windows.devices.sms/smstextmessage2.md index a3aebda5ad..ed7665a837 100644 --- a/windows.devices.sms/smstextmessage2.md +++ b/windows.devices.sms/smstextmessage2.md @@ -1,3 +1,30 @@ ---- -api-id: T:Windows.Devices.Sms.SmsTextMessage2 --api-type: winrt class ---- # Windows.Devices.Sms.SmsTextMessage2 ## -description Encapsulates a decoded SMS text message. Prefer this class to the older [SmsTextMessage](smstextmessage_smstextmessage.md) class. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). To send a text message, construct an instance of this class, set all appropriate fields, and send using [SmsDevice2.SendMessageAndGetResultAsync](smsdevice2_sendmessageandgetresultasync.md). To access a received text message, create a background task that is triggered by the SmsMessageReceived event. In that task, first use [SmsMessageReceivedTriggerDetails.MessageType](smsmessagereceivedtriggerdetails_messagetype.md) to determine that the message is a text message, then use the [SmsMessageReceivedTriggerDetails.TextMessage](smsmessagereceivedtriggerdetails_textmessage.md) property to access the instance of this class. ## -remarks ## -examples ## -see-also [ISmsMessageBase](ismsmessagebase.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsTextMessage2 +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsTextMessage2 + +## -description +Encapsulates a decoded SMS text message. Prefer this class to the older [SmsTextMessage](smstextmessage_smstextmessage.md) class. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +To send a text message, construct an instance of this class, set all appropriate fields, and send using [SmsDevice2.SendMessageAndGetResultAsync](smsdevice2_sendmessageandgetresultasync.md). + +To access a received text message, create a background task that is triggered by the SmsMessageReceived event. In that task, first use [SmsMessageReceivedTriggerDetails.MessageType](smsmessagereceivedtriggerdetails_messagetype.md) to determine that the message is a text message, then use the [SmsMessageReceivedTriggerDetails.TextMessage](smsmessagereceivedtriggerdetails_textmessage.md) property to access the instance of this class. + +## -remarks + +## -examples + +## -see-also +[ISmsMessageBase](ismsmessagebase.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_body.md b/windows.devices.sms/smstextmessage2_body.md index 6550bb51c8..5e4e82f3c8 100644 --- a/windows.devices.sms/smstextmessage2_body.md +++ b/windows.devices.sms/smstextmessage2_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.Body --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.Body ## -description Gets or sets the body of the text message. ## -property-value The plain text body of the message, as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.Body + +## -description +Gets or sets the body of the text message. + +## -property-value +The plain text body of the message, as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_callbacknumber.md b/windows.devices.sms/smstextmessage2_callbacknumber.md index 53387d7700..64f62cb33e 100644 --- a/windows.devices.sms/smstextmessage2_callbacknumber.md +++ b/windows.devices.sms/smstextmessage2_callbacknumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.CallbackNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.CallbackNumber ## -description Gets or sets the callback number for the message. ## -property-value The callback number as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.CallbackNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.CallbackNumber + +## -description +Gets or sets the callback number for the message. + +## -property-value +The callback number as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_cellularclass.md b/windows.devices.sms/smstextmessage2_cellularclass.md index a35543c3ca..a2d607920c 100644 --- a/windows.devices.sms/smstextmessage2_cellularclass.md +++ b/windows.devices.sms/smstextmessage2_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.CellularClass ## -description Gets the cellular class of the message. ## -property-value An enumeration value specifying the cellular class of the message (GSM or CDMA). ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.CellularClass + +## -description +Gets the cellular class of the message. + +## -property-value +An enumeration value specifying the cellular class of the message (GSM or CDMA). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_deviceid.md b/windows.devices.sms/smstextmessage2_deviceid.md index f53116e60e..8efe7e741c 100644 --- a/windows.devices.sms/smstextmessage2_deviceid.md +++ b/windows.devices.sms/smstextmessage2_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.DeviceId ## -description Gets the device identifier for the device associated with the SMS text message. ## -property-value The device identifier. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.DeviceId + +## -description +Gets the device identifier for the device associated with the SMS text message. + +## -property-value +The device identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_encoding.md b/windows.devices.sms/smstextmessage2_encoding.md index 54fb9e0c2b..95c8d3cac8 100644 --- a/windows.devices.sms/smstextmessage2_encoding.md +++ b/windows.devices.sms/smstextmessage2_encoding.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.Encoding --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.Encoding ## -description Gets or sets the encoding scheme used for the message. ## -property-value An enumeration value specifying the encoding scheme used in a received message, or the scheme to be used in a message that will be sent. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.Encoding +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.Encoding + +## -description +Gets or sets the encoding scheme used for the message. + +## -property-value +An enumeration value specifying the encoding scheme used in a received message, or the scheme to be used in a message that will be sent. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_from.md b/windows.devices.sms/smstextmessage2_from.md index 4e84204fa5..0b7ec433c0 100644 --- a/windows.devices.sms/smstextmessage2_from.md +++ b/windows.devices.sms/smstextmessage2_from.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.From --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.From ## -description gets the phone number of the sender of the message. ## -property-value The sender's phone number, as a string. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.From +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.From + +## -description +gets the phone number of the sender of the message. + +## -property-value +The sender's phone number, as a string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_isdeliverynotificationenabled.md b/windows.devices.sms/smstextmessage2_isdeliverynotificationenabled.md index 2799a841e7..322332a446 100644 --- a/windows.devices.sms/smstextmessage2_isdeliverynotificationenabled.md +++ b/windows.devices.sms/smstextmessage2_isdeliverynotificationenabled.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.IsDeliveryNotificationEnabled --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.IsDeliveryNotificationEnabled ## -description Gets or sets whether text message delivery notification is enabled for this message. ## -property-value True indicates that text message delivery notification is enabled. False indicates no notification. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.IsDeliveryNotificationEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.IsDeliveryNotificationEnabled + +## -description +Gets or sets whether text message delivery notification is enabled for this message. + +## -property-value +True indicates that text message delivery notification is enabled. False indicates no notification. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_messageclass.md b/windows.devices.sms/smstextmessage2_messageclass.md index 3efd569cc8..4ee9bc14f9 100644 --- a/windows.devices.sms/smstextmessage2_messageclass.md +++ b/windows.devices.sms/smstextmessage2_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.MessageClass ## -description Gets the message class of the message. ## -property-value An enumeration value, set according to the network, for the message class of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.MessageClass + +## -description +Gets the message class of the message. + +## -property-value +An enumeration value, set according to the network, for the message class of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_messagetype.md b/windows.devices.sms/smstextmessage2_messagetype.md index 43e963b7e7..01d5606265 100644 --- a/windows.devices.sms/smstextmessage2_messagetype.md +++ b/windows.devices.sms/smstextmessage2_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.MessageType ## -description Gets the message type of the message. ## -property-value An enumeration value indicating the message type. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.MessageType + +## -description +Gets the message type of the message. + +## -property-value +An enumeration value indicating the message type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_protocolid.md b/windows.devices.sms/smstextmessage2_protocolid.md index 3955b2f0f5..1166f3561c 100644 --- a/windows.devices.sms/smstextmessage2_protocolid.md +++ b/windows.devices.sms/smstextmessage2_protocolid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.ProtocolId --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.ProtocolId ## -description Gets the protocol identifier for the message. ## -property-value Gets an integer which identifies the protocol. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.ProtocolId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.ProtocolId + +## -description +Gets the protocol identifier for the message. + +## -property-value +Gets an integer which identifies the protocol. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_retryattemptcount.md b/windows.devices.sms/smstextmessage2_retryattemptcount.md index daa939d6ce..1bad5a0289 100644 --- a/windows.devices.sms/smstextmessage2_retryattemptcount.md +++ b/windows.devices.sms/smstextmessage2_retryattemptcount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.RetryAttemptCount --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.RetryAttemptCount ## -description Gets or sets the number of retry attempts for the message. ## -property-value The number of retry attempts to be attempted for a sent message, or that were required to send a received message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.RetryAttemptCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.RetryAttemptCount + +## -description +Gets or sets the number of retry attempts for the message. + +## -property-value +The number of retry attempts to be attempted for a sent message, or that were required to send a received message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_simiccid.md b/windows.devices.sms/smstextmessage2_simiccid.md index a4a23b4723..6845e292a5 100644 --- a/windows.devices.sms/smstextmessage2_simiccid.md +++ b/windows.devices.sms/smstextmessage2_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_smstextmessage2_1221375020.md b/windows.devices.sms/smstextmessage2_smstextmessage2_1221375020.md index 9c63a4e12f..abbffaaeed 100644 --- a/windows.devices.sms/smstextmessage2_smstextmessage2_1221375020.md +++ b/windows.devices.sms/smstextmessage2_smstextmessage2_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsTextMessage2.#ctor --api-type: winrt method ---- # Windows.Devices.Sms.SmsTextMessage2.SmsTextMessage2 ## -description Constructs a new, default instance of this class. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsTextMessage2.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.SmsTextMessage2 + +## -description +Constructs a new, default instance of this class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_teleserviceid.md b/windows.devices.sms/smstextmessage2_teleserviceid.md index dc3e29ac17..95f0687e94 100644 --- a/windows.devices.sms/smstextmessage2_teleserviceid.md +++ b/windows.devices.sms/smstextmessage2_teleserviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.TeleserviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.TeleserviceId ## -description Gets the teleservice identifier associated with this message. ## -property-value The teleservice identifier. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.TeleserviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.TeleserviceId + +## -description +Gets the teleservice identifier associated with this message. + +## -property-value +The teleservice identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_timestamp.md b/windows.devices.sms/smstextmessage2_timestamp.md index 730eedbf68..c83c8043ae 100644 --- a/windows.devices.sms/smstextmessage2_timestamp.md +++ b/windows.devices.sms/smstextmessage2_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.Timestamp ## -description The timestamp of this message. ## -property-value The timestamp. Based on local time for a constructed message, or on the service center timestamp for a received message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.Timestamp + +## -description +The timestamp of this message. + +## -property-value +The timestamp. Based on local time for a constructed message, or on the service center timestamp for a received message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage2_to.md b/windows.devices.sms/smstextmessage2_to.md index 6dbd70bf39..a0df39fdf9 100644 --- a/windows.devices.sms/smstextmessage2_to.md +++ b/windows.devices.sms/smstextmessage2_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage2.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage2.To ## -description Gets or sets the recipient phone number for the message. ## -property-value The destination phone number. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage2.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage2.To + +## -description +Gets or sets the recipient phone number for the message. + +## -property-value +The destination phone number. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_body.md b/windows.devices.sms/smstextmessage_body.md index 582ccc7774..2a8c244097 100644 --- a/windows.devices.sms/smstextmessage_body.md +++ b/windows.devices.sms/smstextmessage_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.Body --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.Body ## -description Specifies the plain text body of the message. ## -property-value A string representing the body of the text message. If there were decoding problems, some characters in the original message can be represented by a wildcard character, typically a question mark ('?'). ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.Body + +## -description +Specifies the plain text body of the message. + +## -property-value +A string representing the body of the text message. If there were decoding problems, some characters in the original message can be represented by a wildcard character, typically a question mark ('?'). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_encoding.md b/windows.devices.sms/smstextmessage_encoding.md index dc58f0840f..cdc419b010 100644 --- a/windows.devices.sms/smstextmessage_encoding.md +++ b/windows.devices.sms/smstextmessage_encoding.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.Encoding --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.Encoding ## -description Specifies the encoding type that has been set to use when sending this message. ## -property-value A value from the [SmsEncoding](smsencoding.md) enumeration. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.Encoding +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.Encoding + +## -description +Specifies the encoding type that has been set to use when sending this message. + +## -property-value +A value from the [SmsEncoding](smsencoding.md) enumeration. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_from.md b/windows.devices.sms/smstextmessage_from.md index 21b25b0b04..f3fbb76d57 100644 --- a/windows.devices.sms/smstextmessage_from.md +++ b/windows.devices.sms/smstextmessage_from.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.From --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.From ## -description Specifies the phone number of the sender of the message. ## -property-value A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.From +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.From + +## -description +Specifies the phone number of the sender of the message. + +## -property-value +A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_frombinarydata_937249457.md b/windows.devices.sms/smstextmessage_frombinarydata_937249457.md index 65f17b177f..7a9dbf579c 100644 --- a/windows.devices.sms/smstextmessage_frombinarydata_937249457.md +++ b/windows.devices.sms/smstextmessage_frombinarydata_937249457.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Sms.SmsTextMessage.FromBinaryData(Windows.Devices.Sms.SmsDataFormat,System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Sms.SmsTextMessage.FromBinaryData ## -description Decodes a binary message and places the results in a new instance of a text message. This method represents the binary message as a reference to a buffer of bytes and a selection of how the buffer is encoded. Therefore, it can be used when the message did not originate directly from the device or as an instance of an [SmsBinaryMessage](smsbinarymessage.md) class. ## -parameters ### -param format An [SmsDataFormat](smsdataformat.md) enumerated value that identifies the format of a particular protocol description unit (PDU) buffer. ### -param value An array of bytes containing the binary data to decode. ## -returns A new [SmsTextMessage](smstextmessage.md) object if the decoding was successful. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsTextMessage.FromBinaryData(Windows.Devices.Sms.SmsDataFormat,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsTextMessage.FromBinaryData + +## -description +Decodes a binary message and places the results in a new instance of a text message. This method represents the binary message as a reference to a buffer of bytes and a selection of how the buffer is encoded. Therefore, it can be used when the message did not originate directly from the device or as an instance of an [SmsBinaryMessage](smsbinarymessage.md) class. + +## -parameters +### -param format +An [SmsDataFormat](smsdataformat.md) enumerated value that identifies the format of a particular protocol description unit (PDU) buffer. + +### -param value +An array of bytes containing the binary data to decode. + +## -returns +A new [SmsTextMessage](smstextmessage.md) object if the decoding was successful. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_frombinarymessage_202044339.md b/windows.devices.sms/smstextmessage_frombinarymessage_202044339.md index f077b23ef0..985e0bd891 100644 --- a/windows.devices.sms/smstextmessage_frombinarymessage_202044339.md +++ b/windows.devices.sms/smstextmessage_frombinarymessage_202044339.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsTextMessage.FromBinaryMessage(Windows.Devices.Sms.SmsBinaryMessage) --api-type: winrt method ---- # Windows.Devices.Sms.SmsTextMessage.FromBinaryMessage ## -description Reads a binary message and decodes it. The results are placed in a new instance of a text message. ## -parameters ### -param binaryMessage An instance of a binary message to decode. ## -returns A new [SmsTextMessage](smstextmessage.md) object. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsTextMessage.FromBinaryMessage(Windows.Devices.Sms.SmsBinaryMessage) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsTextMessage.FromBinaryMessage + +## -description +Reads a binary message and decodes it. The results are placed in a new instance of a text message. + +## -parameters +### -param binaryMessage +An instance of a binary message to decode. + +## -returns +A new [SmsTextMessage](smstextmessage.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_id.md b/windows.devices.sms/smstextmessage_id.md index c0b71ba62e..0e26943c3e 100644 --- a/windows.devices.sms/smstextmessage_id.md +++ b/windows.devices.sms/smstextmessage_id.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.Id --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.Id ## -description Indicates the ID of the SMS text message. ## -property-value An integer ID for the message. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.Id + +## -description +Indicates the ID of the SMS text message. + +## -property-value +An integer ID for the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_messageclass.md b/windows.devices.sms/smstextmessage_messageclass.md index 43b8abb84c..aca3db4baf 100644 --- a/windows.devices.sms/smstextmessage_messageclass.md +++ b/windows.devices.sms/smstextmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.MessageClass ## -description Specifies the message class of a message. This message class typically originates on the network, not the mobile device. ## -property-value A value from the [SmsMessageClass](smsmessageclass.md) enumeration. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.MessageClass + +## -description +Specifies the message class of a message. This message class typically originates on the network, not the mobile device. + +## -property-value +A value from the [SmsMessageClass](smsmessageclass.md) enumeration. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_partcount.md b/windows.devices.sms/smstextmessage_partcount.md index b7d8c841e4..dcae337475 100644 --- a/windows.devices.sms/smstextmessage_partcount.md +++ b/windows.devices.sms/smstextmessage_partcount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.PartCount --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.PartCount ## -description Indicates the total number of parts in the original message if the message is part of a multi-part message. ## -property-value An unsigned integer. If the message is standalone, the value is 1. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.PartCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.PartCount + +## -description +Indicates the total number of parts in the original message if the message is part of a multi-part message. + +## -property-value +An unsigned integer. If the message is standalone, the value is 1. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_partnumber.md b/windows.devices.sms/smstextmessage_partnumber.md index 306b197eba..547ac15afe 100644 --- a/windows.devices.sms/smstextmessage_partnumber.md +++ b/windows.devices.sms/smstextmessage_partnumber.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.PartNumber --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.PartNumber ## -description Indicates the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the [PartReferenceId](smstextmessage_partreferenceid.md) and [PartCount](smstextmessage_partcount.md) properties. ## -property-value An unsigned integer. It is one-based. It will not exceed PartCount + 1. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.PartNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.PartNumber + +## -description +Indicates the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the [PartReferenceId](smstextmessage_partreferenceid.md) and [PartCount](smstextmessage_partcount.md) properties. + +## -property-value +An unsigned integer. It is one-based. It will not exceed PartCount + 1. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_partreferenceid.md b/windows.devices.sms/smstextmessage_partreferenceid.md index 39c8a83291..1323928fe3 100644 --- a/windows.devices.sms/smstextmessage_partreferenceid.md +++ b/windows.devices.sms/smstextmessage_partreferenceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.PartReferenceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.PartReferenceId ## -description Indicates a reference value that can be used if the message is part of a multi-part message. If this message belongs to a multi-part message, the [PartNumber](smstextmessage_partnumber.md) value can be used to reconstruct the full original message, and each part of that message will have the same value for [PartReferenceId](smstextmessage_partreferenceid.md). ## -property-value An unsigned integer determined by the sending network; it cannot be manipulated through this interface. If the network has its own policy on the lifetime of a multi-part message, this reference number might not be valid indefinitely. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.PartReferenceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.PartReferenceId + +## -description +Indicates a reference value that can be used if the message is part of a multi-part message. If this message belongs to a multi-part message, the [PartNumber](smstextmessage_partnumber.md) value can be used to reconstruct the full original message, and each part of that message will have the same value for [PartReferenceId](smstextmessage_partreferenceid.md). + +## -property-value +An unsigned integer determined by the sending network; it cannot be manipulated through this interface. If the network has its own policy on the lifetime of a multi-part message, this reference number might not be valid indefinitely. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_smstextmessage_1221375020.md b/windows.devices.sms/smstextmessage_smstextmessage_1221375020.md index 880d55536d..b284c6aa8c 100644 --- a/windows.devices.sms/smstextmessage_smstextmessage_1221375020.md +++ b/windows.devices.sms/smstextmessage_smstextmessage_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Sms.SmsTextMessage.#ctor --api-type: winrt method ---- # Windows.Devices.Sms.SmsTextMessage.SmsTextMessage ## -description Creates an instance of the [SmsTextMessage](smstextmessage.md) class. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsTextMessage.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsTextMessage.SmsTextMessage + +## -description +Creates an instance of the [SmsTextMessage](smstextmessage.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_timestamp.md b/windows.devices.sms/smstextmessage_timestamp.md index 7a866a9f75..0c93645368 100644 --- a/windows.devices.sms/smstextmessage_timestamp.md +++ b/windows.devices.sms/smstextmessage_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.Timestamp ## -description Indicates the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message. ## -property-value A value of the [DateTime](../windows.foundation/datetime.md) type. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.Timestamp + +## -description +Indicates the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message. + +## -property-value +A value of the [DateTime](../windows.foundation/datetime.md) type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_to.md b/windows.devices.sms/smstextmessage_to.md index 626130c9fe..bce491d27a 100644 --- a/windows.devices.sms/smstextmessage_to.md +++ b/windows.devices.sms/smstextmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsTextMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsTextMessage.To ## -description Indicates the recipient phone number of this message. ## -property-value A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsTextMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsTextMessage.To + +## -description +Indicates the recipient phone number of this message. + +## -property-value +A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smstextmessage_tobinarymessages_1744616223.md b/windows.devices.sms/smstextmessage_tobinarymessages_1744616223.md index 95298ba4b0..270965e788 100644 --- a/windows.devices.sms/smstextmessage_tobinarymessages_1744616223.md +++ b/windows.devices.sms/smstextmessage_tobinarymessages_1744616223.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Sms.SmsTextMessage.ToBinaryMessages(Windows.Devices.Sms.SmsDataFormat) --api-type: winrt method ---- # Windows.Devices.Sms.SmsTextMessage.ToBinaryMessages ## -description Reads a message in the specified format and places the results in a new instance of a binary message. ## -parameters ### -param format A value from the SmsDataFormat enumeration. ## -returns The new binary message that holds the result of this method call. ## -remarks ## -examples ## -see-also ## -capabilities sms, cellularMessaging \ No newline at end of file +--- +-api-id: M:Windows.Devices.Sms.SmsTextMessage.ToBinaryMessages(Windows.Devices.Sms.SmsDataFormat) +-api-type: winrt method +--- + + + +# Windows.Devices.Sms.SmsTextMessage.ToBinaryMessages + +## -description +Reads a message in the specified format and places the results in a new instance of a binary message. + +## -parameters +### -param format +A value from the SmsDataFormat enumeration. + +## -returns +The new binary message that holds the result of this method call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +sms, cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage.md b/windows.devices.sms/smsvoicemailmessage.md index c8cdf47e92..2c20748ace 100644 --- a/windows.devices.sms/smsvoicemailmessage.md +++ b/windows.devices.sms/smsvoicemailmessage.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Sms.SmsVoicemailMessage --api-type: winrt class ---- # Windows.Devices.Sms.SmsVoicemailMessage ## -description Encapsulates an SMS voicemail message. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks ## -examples ## -see-also [ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsVoicemailMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage + +## -description +Encapsulates an SMS voicemail message. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks + +## -examples + +## -see-also +[ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_body.md b/windows.devices.sms/smsvoicemailmessage_body.md index 8887550658..9453fca111 100644 --- a/windows.devices.sms/smsvoicemailmessage_body.md +++ b/windows.devices.sms/smsvoicemailmessage_body.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.Body --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.Body ## -description Gets the body of the voicemail message. ## -property-value The body of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.Body +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.Body + +## -description +Gets the body of the voicemail message. + +## -property-value +The body of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_cellularclass.md b/windows.devices.sms/smsvoicemailmessage_cellularclass.md index 108ed7eb60..cb4cb991f7 100644 --- a/windows.devices.sms/smsvoicemailmessage_cellularclass.md +++ b/windows.devices.sms/smsvoicemailmessage_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.CellularClass ## -description Gets the cellular class of the message. ## -property-value An enumeration value specifying the cellular class of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.CellularClass + +## -description +Gets the cellular class of the message. + +## -property-value +An enumeration value specifying the cellular class of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_deviceid.md b/windows.devices.sms/smsvoicemailmessage_deviceid.md index 7d99569299..eca114cf14 100644 --- a/windows.devices.sms/smsvoicemailmessage_deviceid.md +++ b/windows.devices.sms/smsvoicemailmessage_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.DeviceId ## -description Gets the unique device identifier associated with the message. ## -property-value A device identifier. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.DeviceId + +## -description +Gets the unique device identifier associated with the message. + +## -property-value +A device identifier. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_messageclass.md b/windows.devices.sms/smsvoicemailmessage_messageclass.md index 8858ca9052..116f283ccd 100644 --- a/windows.devices.sms/smsvoicemailmessage_messageclass.md +++ b/windows.devices.sms/smsvoicemailmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.MessageClass ## -description Gets the message class of the message. ## -property-value An enumeration value specifying the message class of this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.MessageClass + +## -description +Gets the message class of the message. + +## -property-value +An enumeration value specifying the message class of this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_messagecount.md b/windows.devices.sms/smsvoicemailmessage_messagecount.md index bdcd961353..5210f2617a 100644 --- a/windows.devices.sms/smsvoicemailmessage_messagecount.md +++ b/windows.devices.sms/smsvoicemailmessage_messagecount.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.MessageCount --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.MessageCount ## -description Gets the number of available messages. ## -property-value The number of available voicemail messages. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.MessageCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.MessageCount + +## -description +Gets the number of available messages. + +## -property-value +The number of available voicemail messages. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_messagetype.md b/windows.devices.sms/smsvoicemailmessage_messagetype.md index 2a356b291d..159cee6054 100644 --- a/windows.devices.sms/smsvoicemailmessage_messagetype.md +++ b/windows.devices.sms/smsvoicemailmessage_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.MessageType ## -description Gets the type of the message. ## -property-value An enumeration value specifying the message type. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.MessageType + +## -description +Gets the type of the message. + +## -property-value +An enumeration value specifying the message type. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_simiccid.md b/windows.devices.sms/smsvoicemailmessage_simiccid.md index fff40f9d05..eafaa013ce 100644 --- a/windows.devices.sms/smsvoicemailmessage_simiccid.md +++ b/windows.devices.sms/smsvoicemailmessage_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_timestamp.md b/windows.devices.sms/smsvoicemailmessage_timestamp.md index af4e49fb29..e9ebf9c1d5 100644 --- a/windows.devices.sms/smsvoicemailmessage_timestamp.md +++ b/windows.devices.sms/smsvoicemailmessage_timestamp.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.Timestamp ## -description The timestamp of the message. ## -property-value Received message timestamps are set by the service center. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.Timestamp + +## -description +The timestamp of the message. + +## -property-value +Received message timestamps are set by the service center. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smsvoicemailmessage_to.md b/windows.devices.sms/smsvoicemailmessage_to.md index 2781f6604c..2557db8fe3 100644 --- a/windows.devices.sms/smsvoicemailmessage_to.md +++ b/windows.devices.sms/smsvoicemailmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsVoicemailMessage.To ## -description The phone number the message was sent to. ## -property-value The phone number the message was sent to. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsVoicemailMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsVoicemailMessage.To + +## -description +The phone number the message was sent to. + +## -property-value +The phone number the message was sent to. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage.md b/windows.devices.sms/smswapmessage.md index 8dfaa0f3fd..af8e1fb13b 100644 --- a/windows.devices.sms/smswapmessage.md +++ b/windows.devices.sms/smswapmessage.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Devices.Sms.SmsWapMessage --api-type: winrt class ---- # Windows.Devices.Sms.SmsWapMessage ## -description Represents an SMS WAP push message. > [!NOTE] > This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). ## -remarks Pass the [DeviceId](smswapmessage_deviceid.md) property to [SmsDevice.FromIdAsync](smsdevice_fromidasync.md) to activate the device and retrieve additional message details. ## -examples ## -see-also [ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: T:Windows.Devices.Sms.SmsWapMessage +-api-type: winrt class +--- + + + +# Windows.Devices.Sms.SmsWapMessage + +## -description +Represents an SMS WAP push message. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see [Mobile Broadband: device apps](http://msdn.microsoft.com/library/windows/hardware/hh852368.aspx). + +## -remarks +Pass the [DeviceId](smswapmessage_deviceid.md) property to [SmsDevice.FromIdAsync](smsdevice_fromidasync.md) to activate the device and retrieve additional message details. + +## -examples + +## -see-also +[ISmsMessageBase](ismsmessagebase.md), [ISmsMessage](ismsmessage.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_applicationid.md b/windows.devices.sms/smswapmessage_applicationid.md index 399f8a9643..cb5be9281c 100644 --- a/windows.devices.sms/smswapmessage_applicationid.md +++ b/windows.devices.sms/smswapmessage_applicationid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.ApplicationId --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.ApplicationId ## -description Gets the value of the X-Wap-Application-Id header of the [SmsWapMessage](smswapmessage.md). ## -property-value The value of the X-Wap-Application-Id header. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.ApplicationId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.ApplicationId + +## -description +Gets the value of the X-Wap-Application-Id header of the [SmsWapMessage](smswapmessage.md). + +## -property-value +The value of the X-Wap-Application-Id header. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_binarybody.md b/windows.devices.sms/smswapmessage_binarybody.md index f2455b8cc9..233f572cc2 100644 --- a/windows.devices.sms/smswapmessage_binarybody.md +++ b/windows.devices.sms/smswapmessage_binarybody.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.BinaryBody --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.BinaryBody ## -description Gets the binary body of the blob in the [SmsWapMessage](smswapmessage.md). ## -property-value The binary body of the blob in the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.BinaryBody +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.BinaryBody + +## -description +Gets the binary body of the blob in the [SmsWapMessage](smswapmessage.md). + +## -property-value +The binary body of the blob in the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_cellularclass.md b/windows.devices.sms/smswapmessage_cellularclass.md index f3846002ba..1105488c38 100644 --- a/windows.devices.sms/smswapmessage_cellularclass.md +++ b/windows.devices.sms/smswapmessage_cellularclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.CellularClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.CellularClass ## -description Gets the cellular class of the SMS device that received the message. ## -property-value The cellular class of the SMS device that received the message. ## -remarks ## -examples ## -see-also [CellularClass](cellularclass.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.CellularClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.CellularClass + +## -description +Gets the cellular class of the SMS device that received the message. + +## -property-value +The cellular class of the SMS device that received the message. + +## -remarks + +## -examples + +## -see-also +[CellularClass](cellularclass.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_contenttype.md b/windows.devices.sms/smswapmessage_contenttype.md index 93fe6d185a..23e7add9b3 100644 --- a/windows.devices.sms/smswapmessage_contenttype.md +++ b/windows.devices.sms/smswapmessage_contenttype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.ContentType --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.ContentType ## -description Gets the value of the **Content-Type** header in the [SmsWapMessage](smswapmessage.md). Header parameters can be found in the [Headers](smswapmessage_headers.md) property. ## -property-value The value of the **Content-Type** header in the message. ## -remarks ## -examples ## -see-also [Headers](smswapmessage_headers.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.ContentType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.ContentType + +## -description +Gets the value of the **Content-Type** header in the [SmsWapMessage](smswapmessage.md). Header parameters can be found in the [Headers](smswapmessage_headers.md) property. + +## -property-value +The value of the **Content-Type** header in the message. + +## -remarks + +## -examples + +## -see-also +[Headers](smswapmessage_headers.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_deviceid.md b/windows.devices.sms/smswapmessage_deviceid.md index 6975dd9c2f..1188efa66a 100644 --- a/windows.devices.sms/smswapmessage_deviceid.md +++ b/windows.devices.sms/smswapmessage_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.DeviceId --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.DeviceId ## -description Gets the device information ID of the [SmsDevice](smsdevice.md) that receives the [SmsWapMessage](smswapmessage.md). ## -property-value The device information ID of the [SmsDevice](smsdevice.md) that receives the [SmsWapMessage](smswapmessage.md). ## -remarks ## -examples ## -see-also [SmsDevice](smsdevice.md), [SmsDevice.FromIdAsync](smsdevice_fromidasync.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.DeviceId + +## -description +Gets the device information ID of the [SmsDevice](smsdevice.md) that receives the [SmsWapMessage](smswapmessage.md). + +## -property-value +The device information ID of the [SmsDevice](smsdevice.md) that receives the [SmsWapMessage](smswapmessage.md). + +## -remarks + +## -examples + +## -see-also +[SmsDevice](smsdevice.md), [SmsDevice.FromIdAsync](smsdevice_fromidasync.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_from.md b/windows.devices.sms/smswapmessage_from.md index 5396398968..0bb4b8c1f5 100644 --- a/windows.devices.sms/smswapmessage_from.md +++ b/windows.devices.sms/smswapmessage_from.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.From --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.From ## -description Gets the phone number of the sender of the [SmsWapMessage](smswapmessage.md). ## -property-value The phone number of the sender of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.From +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.From + +## -description +Gets the phone number of the sender of the [SmsWapMessage](smswapmessage.md). + +## -property-value +The phone number of the sender of the message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_headers.md b/windows.devices.sms/smswapmessage_headers.md index 2bda6ddefc..f702d80f80 100644 --- a/windows.devices.sms/smswapmessage_headers.md +++ b/windows.devices.sms/smswapmessage_headers.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.Headers --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.Headers ## -description Gets the header name-value pairs of the WAP push message. ## -property-value The header name-value pairs of the WAP push message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.Headers +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.Headers + +## -description +Gets the header name-value pairs of the WAP push message. + +## -property-value +The header name-value pairs of the WAP push message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_messageclass.md b/windows.devices.sms/smswapmessage_messageclass.md index 49db06359e..6ec94a7494 100644 --- a/windows.devices.sms/smswapmessage_messageclass.md +++ b/windows.devices.sms/smswapmessage_messageclass.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.MessageClass --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.MessageClass ## -description Gets the message class of the [SmsWapMessage](smswapmessage.md). ## -property-value The message class of the [SmsWapMessage](smswapmessage.md). ## -remarks ## -examples ## -see-also [SmsMessageClass](smsmessageclass.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.MessageClass +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.MessageClass + +## -description +Gets the message class of the [SmsWapMessage](smswapmessage.md). + +## -property-value +The message class of the [SmsWapMessage](smswapmessage.md). + +## -remarks + +## -examples + +## -see-also +[SmsMessageClass](smsmessageclass.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_messagetype.md b/windows.devices.sms/smswapmessage_messagetype.md index 26a8d41663..744db79b8b 100644 --- a/windows.devices.sms/smswapmessage_messagetype.md +++ b/windows.devices.sms/smswapmessage_messagetype.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.MessageType --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.MessageType ## -description Gets the message type of the [SmsWapMessage](smswapmessage.md). ## -property-value The message type. ## -remarks ## -examples ## -see-also [SmsMessageType](smsmessagetype.md) ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.MessageType +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.MessageType + +## -description +Gets the message type of the [SmsWapMessage](smswapmessage.md). + +## -property-value +The message type. + +## -remarks + +## -examples + +## -see-also +[SmsMessageType](smsmessagetype.md) + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_simiccid.md b/windows.devices.sms/smswapmessage_simiccid.md index 95facc7538..0181cd3c00 100644 --- a/windows.devices.sms/smswapmessage_simiccid.md +++ b/windows.devices.sms/smswapmessage_simiccid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.SimIccId --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.SimIccId ## -description Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. ## -property-value The ICCID of the SIM. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.SimIccId +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.SimIccId + +## -description +Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message. + +## -property-value +The ICCID of the SIM. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_timestamp.md b/windows.devices.sms/smswapmessage_timestamp.md index af90f77824..3373feb47d 100644 --- a/windows.devices.sms/smswapmessage_timestamp.md +++ b/windows.devices.sms/smswapmessage_timestamp.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.Timestamp --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.Timestamp ## -description Gets the timestamp of the [SmsWapMessage](smswapmessage.md). The [Timestamp](smswapmessage_timestamp.md) property is determined locally for a constructed message instance or from the service center timestamp of a received message. ## -property-value The timestamp of the message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.Timestamp + +## -description +Gets the timestamp of the [SmsWapMessage](smswapmessage.md). + +The [Timestamp](smswapmessage_timestamp.md) property is determined locally for a constructed message instance or from the service center timestamp of a received message. + +## -property-value +The timestamp of the message. + +## -remarks + + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.sms/smswapmessage_to.md b/windows.devices.sms/smswapmessage_to.md index f614821023..738377393b 100644 --- a/windows.devices.sms/smswapmessage_to.md +++ b/windows.devices.sms/smswapmessage_to.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Sms.SmsWapMessage.To --api-type: winrt property ---- # Windows.Devices.Sms.SmsWapMessage.To ## -description Gets the recipient phone number of this [SmsWapMessage](smswapmessage.md). ## -property-value The recipient phone number of this message. ## -remarks ## -examples ## -see-also ## -capabilities cellularMessaging \ No newline at end of file +--- +-api-id: P:Windows.Devices.Sms.SmsWapMessage.To +-api-type: winrt property +--- + + + +# Windows.Devices.Sms.SmsWapMessage.To + +## -description +Gets the recipient phone number of this [SmsWapMessage](smswapmessage.md). + +## -property-value +The recipient phone number of this message. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +cellularMessaging \ No newline at end of file diff --git a/windows.devices.spi.provider/ispicontrollerprovider_getdeviceprovider.md b/windows.devices.spi.provider/ispicontrollerprovider_getdeviceprovider.md index 8753569d44..e145de3e49 100644 --- a/windows.devices.spi.provider/ispicontrollerprovider_getdeviceprovider.md +++ b/windows.devices.spi.provider/ispicontrollerprovider_getdeviceprovider.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ISpiControllerProvider.GetDeviceProvider(Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings) --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ISpiControllerProvider.GetDeviceProvider ## -description Gets the SPI device with the specified settings. ## -parameters ### -param settings The desired connection settings. ## -returns The SPI device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ISpiControllerProvider.GetDeviceProvider(Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ISpiControllerProvider.GetDeviceProvider + +## -description +Gets the SPI device with the specified settings. + +## -parameters +### -param settings +The desired connection settings. + +## -returns +The SPI device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispideviceprovider_connectionsettings.md b/windows.devices.spi.provider/ispideviceprovider_connectionsettings.md index cb3e2fa2a9..3a6d31f2db 100644 --- a/windows.devices.spi.provider/ispideviceprovider_connectionsettings.md +++ b/windows.devices.spi.provider/ispideviceprovider_connectionsettings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ISpiDeviceProvider.ConnectionSettings --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ISpiDeviceProvider.ConnectionSettings ## -description Gets the connection settings for the device. ## -property-value The connection settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ISpiDeviceProvider.ConnectionSettings +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ISpiDeviceProvider.ConnectionSettings + +## -description +Gets the connection settings for the device. + +## -property-value +The connection settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispideviceprovider_deviceid.md b/windows.devices.spi.provider/ispideviceprovider_deviceid.md index 83d66b1c9c..907bbebf7f 100644 --- a/windows.devices.spi.provider/ispideviceprovider_deviceid.md +++ b/windows.devices.spi.provider/ispideviceprovider_deviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ISpiDeviceProvider.DeviceId --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ISpiDeviceProvider.DeviceId ## -description Gets the unique ID associated with the device. ## -property-value The device ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ISpiDeviceProvider.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ISpiDeviceProvider.DeviceId + +## -description +Gets the unique ID associated with the device. + +## -property-value +The device ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispideviceprovider_read.md b/windows.devices.spi.provider/ispideviceprovider_read.md index 29e0d4569d..f1eddb0f4e 100644 --- a/windows.devices.spi.provider/ispideviceprovider_read.md +++ b/windows.devices.spi.provider/ispideviceprovider_read.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.Read(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ISpiDeviceProvider.Read ## -description Reads from the connected device. ## -parameters ### -param buffer Array containing data read from the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.Read(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ISpiDeviceProvider.Read + +## -description +Reads from the connected device. + +## -parameters +### -param buffer +Array containing data read from the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispideviceprovider_transferfullduplex.md b/windows.devices.spi.provider/ispideviceprovider_transferfullduplex.md index 5e778e8903..bf567ccc03 100644 --- a/windows.devices.spi.provider/ispideviceprovider_transferfullduplex.md +++ b/windows.devices.spi.provider/ispideviceprovider_transferfullduplex.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferFullDuplex(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferFullDuplex ## -description Transfer data using a full duplex communication system. Full duplex allows both the master and the slave to communicate simultaneously. ## -parameters ### -param writeBuffer Array containing data to write to the device. ### -param readBuffer Array containing data read from the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferFullDuplex(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferFullDuplex + +## -description +Transfer data using a full duplex communication system. Full duplex allows both the master and the slave to communicate simultaneously. + +## -parameters +### -param writeBuffer +Array containing data to write to the device. + +### -param readBuffer +Array containing data read from the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispideviceprovider_transfersequential.md b/windows.devices.spi.provider/ispideviceprovider_transfersequential.md index 0b480a988d..81c56b8c0e 100644 --- a/windows.devices.spi.provider/ispideviceprovider_transfersequential.md +++ b/windows.devices.spi.provider/ispideviceprovider_transfersequential.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferSequential(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferSequential ## -description Transfer data sequentially to the device. ## -parameters ### -param writeBuffer Array containing data to write to the device. ### -param readBuffer Array containing data read from the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferSequential(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ISpiDeviceProvider.TransferSequential + +## -description +Transfer data sequentially to the device. + +## -parameters +### -param writeBuffer +Array containing data to write to the device. + +### -param readBuffer +Array containing data read from the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispideviceprovider_write.md b/windows.devices.spi.provider/ispideviceprovider_write.md index cc3e5f2a95..9490cfe3d2 100644 --- a/windows.devices.spi.provider/ispideviceprovider_write.md +++ b/windows.devices.spi.provider/ispideviceprovider_write.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.Write(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ISpiDeviceProvider.Write ## -description Writes to the connected device. ## -parameters ### -param buffer Array containing the data to write to the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ISpiDeviceProvider.Write(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ISpiDeviceProvider.Write + +## -description +Writes to the connected device. + +## -parameters +### -param buffer +Array containing the data to write to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/ispiprovider_getcontrollersasync.md b/windows.devices.spi.provider/ispiprovider_getcontrollersasync.md index a193c0382d..32bc784afb 100644 --- a/windows.devices.spi.provider/ispiprovider_getcontrollersasync.md +++ b/windows.devices.spi.provider/ispiprovider_getcontrollersasync.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ISpiProvider.GetControllersAsync --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ISpiProvider.GetControllersAsync ## -description Gets all the SPI controllers on the system for the provider. ## -returns When the method completes successfully, it returns a list of values that represent the available SPI controllers on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ISpiProvider.GetControllersAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ISpiProvider.GetControllersAsync + +## -description +Gets all the SPI controllers on the system for the provider. + +## -returns +When the method completes successfully, it returns a list of values that represent the available SPI controllers on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings.md b/windows.devices.spi.provider/providerspiconnectionsettings.md index 5cd6b712c7..5a0c4603b3 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings --api-type: winrt class ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings ## -description Represents the provider settings for the connection to a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings +-api-type: winrt class +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings + +## -description +Represents the provider settings for the connection to a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings_chipselectline.md b/windows.devices.spi.provider/providerspiconnectionsettings_chipselectline.md index 387166818a..1d4243a02c 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings_chipselectline.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings_chipselectline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ChipSelectLine --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ChipSelectLine ## -description Gets or sets the chip select line for the connection to the SPI device. ## -property-value The chip select line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ChipSelectLine +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ChipSelectLine + +## -description +Gets or sets the chip select line for the connection to the SPI device. + +## -property-value +The chip select line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings_clockfrequency.md b/windows.devices.spi.provider/providerspiconnectionsettings_clockfrequency.md index b9adad90d7..25923cef6f 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings_clockfrequency.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings_clockfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ClockFrequency --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ClockFrequency ## -description Gets or sets the clock frequency for the connection. ## -property-value Value of the clock frequency in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ClockFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ClockFrequency + +## -description +Gets or sets the clock frequency for the connection. + +## -property-value +Value of the clock frequency in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings_databitlength.md b/windows.devices.spi.provider/providerspiconnectionsettings_databitlength.md index 77873580e6..15f1987455 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings_databitlength.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings_databitlength.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.DataBitLength --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.DataBitLength ## -description Gets or sets the bit length for data on this connection. ## -property-value The data bit length. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.DataBitLength +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.DataBitLength + +## -description +Gets or sets the bit length for data on this connection. + +## -property-value +The data bit length. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings_mode.md b/windows.devices.spi.provider/providerspiconnectionsettings_mode.md index 12ce7e4de1..51dc7a12e0 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings_mode.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.Mode --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.Mode ## -description Gets or sets the [ProviderSpiMode](providerspimode.md) for this connection. ## -property-value The communication mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.Mode +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.Mode + +## -description +Gets or sets the [ProviderSpiMode](providerspimode.md) for this connection. + +## -property-value +The communication mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings_providerspiconnectionsettings_745845612.md b/windows.devices.spi.provider/providerspiconnectionsettings_providerspiconnectionsettings_745845612.md index 92a0cf7d9c..c2ec25f685 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings_providerspiconnectionsettings_745845612.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings_providerspiconnectionsettings_745845612.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ProviderSpiConnectionSettings ## -description Initializes a new instance of [ProviderSpiConnectionSettings](providerspiconnectionsettings.md). ## -parameters ### -param chipSelectLine The chip select line on which the connection will be made. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.ProviderSpiConnectionSettings + +## -description +Initializes a new instance of [ProviderSpiConnectionSettings](providerspiconnectionsettings.md). + +## -parameters +### -param chipSelectLine +The chip select line on which the connection will be made. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi.provider/providerspiconnectionsettings_sharingmode.md b/windows.devices.spi.provider/providerspiconnectionsettings_sharingmode.md index af139160a9..d49984ac2c 100644 --- a/windows.devices.spi.provider/providerspiconnectionsettings_sharingmode.md +++ b/windows.devices.spi.provider/providerspiconnectionsettings_sharingmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.SharingMode --api-type: winrt property ---- # Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.SharingMode ## -description Gets or sets the sharing mode for the SPI connection. ## -property-value The sharing mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.Provider.ProviderSpiConnectionSettings.SharingMode + +## -description +Gets or sets the sharing mode for the SPI connection. + +## -property-value +The sharing mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/ispidevicestatics_fromidasync.md b/windows.devices.spi/ispidevicestatics_fromidasync.md index a8f25e396e..d46904676c 100644 --- a/windows.devices.spi/ispidevicestatics_fromidasync.md +++ b/windows.devices.spi/ispidevicestatics_fromidasync.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.FromIdAsync(System.String,Windows.Devices.Spi.SpiConnectionSettings) --api-type: winrt method ---- # Windows.Devices.Spi.ISpiDeviceStatics.FromIdAsync ## -description Opens a device with the connection settings provided. ## -parameters ### -param busId The id of the bus. ### -param settings The connection settings. ## -returns The SPI device. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.FromIdAsync(System.String,Windows.Devices.Spi.SpiConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.ISpiDeviceStatics.FromIdAsync + +## -description +Opens a device with the connection settings provided. + +## -parameters +### -param busId +The id of the bus. + +### -param settings +The connection settings. + +## -returns +The SPI device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/ispidevicestatics_getbusinfo.md b/windows.devices.spi/ispidevicestatics_getbusinfo.md index 724dbd9ec5..e1b5460a49 100644 --- a/windows.devices.spi/ispidevicestatics_getbusinfo.md +++ b/windows.devices.spi/ispidevicestatics_getbusinfo.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.GetBusInfo(System.String) --api-type: winrt method ---- # Windows.Devices.Spi.ISpiDeviceStatics.GetBusInfo ## -description Retrieves the info about a certain bus. ## -parameters ### -param busId The id of the bus. ## -returns The bus info requested. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.GetBusInfo(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.ISpiDeviceStatics.GetBusInfo + +## -description +Retrieves the info about a certain bus. + +## -parameters +### -param busId +The id of the bus. + +## -returns +The bus info requested. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/ispidevicestatics_getdeviceselector_1752695616.md b/windows.devices.spi/ispidevicestatics_getdeviceselector_1752695616.md index 64d5e2da02..c11facb70c 100644 --- a/windows.devices.spi/ispidevicestatics_getdeviceselector_1752695616.md +++ b/windows.devices.spi/ispidevicestatics_getdeviceselector_1752695616.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector(System.String) --api-type: winrt method ---- # Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector ## -description Gets all the SPI buses found on the system that match the input parameter. ## -parameters ### -param friendlyName Input parameter specifying an identifying name for the desired bus. This usually corresponds to a name on the schematic. ## -returns String containing all the buses that have the input in the name. ## -remarks ## -examples ## -see-also [GetDeviceSelector](ispidevicestatics_getdeviceselector_838466080.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector + +## -description +Gets all the SPI buses found on the system that match the input parameter. + +## -parameters +### -param friendlyName +Input parameter specifying an identifying name for the desired bus. This usually corresponds to a name on the schematic. + +## -returns +String containing all the buses that have the input in the name. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector](ispidevicestatics_getdeviceselector_838466080.md) \ No newline at end of file diff --git a/windows.devices.spi/ispidevicestatics_getdeviceselector_838466080.md b/windows.devices.spi/ispidevicestatics_getdeviceselector_838466080.md index beb81cd53a..1677fb3818 100644 --- a/windows.devices.spi/ispidevicestatics_getdeviceselector_838466080.md +++ b/windows.devices.spi/ispidevicestatics_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector ## -description Gets all the SPI buses found on the system. ## -returns String containing all the buses on the system. ## -remarks ## -examples ## -see-also [GetDeviceSelector(String)](ispidevicestatics_getdeviceselector_1752695616.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.ISpiDeviceStatics.GetDeviceSelector + +## -description +Gets all the SPI buses found on the system. + +## -returns +String containing all the buses on the system. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(String)](ispidevicestatics_getdeviceselector_1752695616.md) \ No newline at end of file diff --git a/windows.devices.spi/spibusinfo.md b/windows.devices.spi/spibusinfo.md index 3cf9de3470..4e44c8262b 100644 --- a/windows.devices.spi/spibusinfo.md +++ b/windows.devices.spi/spibusinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Spi.SpiBusInfo --api-type: winrt class ---- # Windows.Devices.Spi.SpiBusInfo ## -description Represents the info about a SPI bus. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Spi.SpiBusInfo +-api-type: winrt class +--- + + + +# Windows.Devices.Spi.SpiBusInfo + +## -description +Represents the info about a SPI bus. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spibusinfo_chipselectlinecount.md b/windows.devices.spi/spibusinfo_chipselectlinecount.md index eae6a7d11f..398e093156 100644 --- a/windows.devices.spi/spibusinfo_chipselectlinecount.md +++ b/windows.devices.spi/spibusinfo_chipselectlinecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.SpiBusInfo.ChipSelectLineCount --api-type: winrt property ---- # Windows.Devices.Spi.SpiBusInfo.ChipSelectLineCount ## -description Gets the number of chip select lines available on the bus. ## -property-value Number of chip select lines. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiBusInfo.ChipSelectLineCount +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiBusInfo.ChipSelectLineCount + +## -description +Gets the number of chip select lines available on the bus. + +## -property-value +Number of chip select lines. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spibusinfo_maxclockfrequency.md b/windows.devices.spi/spibusinfo_maxclockfrequency.md index 66c28a995f..c2b3128d6e 100644 --- a/windows.devices.spi/spibusinfo_maxclockfrequency.md +++ b/windows.devices.spi/spibusinfo_maxclockfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.SpiBusInfo.MaxClockFrequency --api-type: winrt property ---- # Windows.Devices.Spi.SpiBusInfo.MaxClockFrequency ## -description Maximum clock cycle frequency of the bus. ## -property-value The clock cycle in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiBusInfo.MaxClockFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiBusInfo.MaxClockFrequency + +## -description +Maximum clock cycle frequency of the bus. + +## -property-value +The clock cycle in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spibusinfo_minclockfrequency.md b/windows.devices.spi/spibusinfo_minclockfrequency.md index ff852c62ff..e71456ae30 100644 --- a/windows.devices.spi/spibusinfo_minclockfrequency.md +++ b/windows.devices.spi/spibusinfo_minclockfrequency.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.SpiBusInfo.MinClockFrequency --api-type: winrt property ---- # Windows.Devices.Spi.SpiBusInfo.MinClockFrequency ## -description Minimum clock cycle frequency of the bus. ## -property-value The clock cycle in Hz. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiBusInfo.MinClockFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiBusInfo.MinClockFrequency + +## -description +Minimum clock cycle frequency of the bus. + +## -property-value +The clock cycle in Hz. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spibusinfo_supporteddatabitlengths.md b/windows.devices.spi/spibusinfo_supporteddatabitlengths.md index 333a00ebd3..d38f2f465c 100644 --- a/windows.devices.spi/spibusinfo_supporteddatabitlengths.md +++ b/windows.devices.spi/spibusinfo_supporteddatabitlengths.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Spi.SpiBusInfo.SupportedDataBitLengths --api-type: winrt property ---- # Windows.Devices.Spi.SpiBusInfo.SupportedDataBitLengths ## -description Gets the bit lengths that can be used on the bus for transmitting data. ## -property-value The supported data lengths. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiBusInfo.SupportedDataBitLengths +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiBusInfo.SupportedDataBitLengths + +## -description +Gets the bit lengths that can be used on the bus for transmitting data. + +## -property-value +The supported data lengths. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spiconnectionsettings.md b/windows.devices.spi/spiconnectionsettings.md index ed017fad3a..4a668f023a 100644 --- a/windows.devices.spi/spiconnectionsettings.md +++ b/windows.devices.spi/spiconnectionsettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Spi.SpiConnectionSettings --api-type: winrt class ---- # Windows.Devices.Spi.SpiConnectionSettings ## -description Represents the settings for the connection with a device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Spi.SpiConnectionSettings +-api-type: winrt class +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings + +## -description +Represents the settings for the connection with a device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spiconnectionsettings_chipselectline.md b/windows.devices.spi/spiconnectionsettings_chipselectline.md index c7bcbd2ad6..b0a19eaea1 100644 --- a/windows.devices.spi/spiconnectionsettings_chipselectline.md +++ b/windows.devices.spi/spiconnectionsettings_chipselectline.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiConnectionSettings.ChipSelectLine --api-type: winrt property ---- # Windows.Devices.Spi.SpiConnectionSettings.ChipSelectLine ## -description Gets or sets the chip select line for the connection to the SPI device. ## -property-value The chip select line. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiConnectionSettings.ChipSelectLine +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings.ChipSelectLine + +## -description +Gets or sets the chip select line for the connection to the SPI device. + +## -property-value +The chip select line. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spiconnectionsettings_clockfrequency.md b/windows.devices.spi/spiconnectionsettings_clockfrequency.md index 7b79af081a..0e059de7be 100644 --- a/windows.devices.spi/spiconnectionsettings_clockfrequency.md +++ b/windows.devices.spi/spiconnectionsettings_clockfrequency.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiConnectionSettings.ClockFrequency --api-type: winrt property ---- # Windows.Devices.Spi.SpiConnectionSettings.ClockFrequency ## -description Gets or sets the clock frequency for the connection. ## -property-value Value of the clock frequency in Hz. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiConnectionSettings.ClockFrequency +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings.ClockFrequency + +## -description +Gets or sets the clock frequency for the connection. + +## -property-value +Value of the clock frequency in Hz. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spiconnectionsettings_databitlength.md b/windows.devices.spi/spiconnectionsettings_databitlength.md index e7bb87395c..6b4288812b 100644 --- a/windows.devices.spi/spiconnectionsettings_databitlength.md +++ b/windows.devices.spi/spiconnectionsettings_databitlength.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiConnectionSettings.DataBitLength --api-type: winrt property ---- # Windows.Devices.Spi.SpiConnectionSettings.DataBitLength ## -description Gets or sets the bit length for data on this connection. ## -property-value The data bit length. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiConnectionSettings.DataBitLength +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings.DataBitLength + +## -description +Gets or sets the bit length for data on this connection. + +## -property-value +The data bit length. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spiconnectionsettings_mode.md b/windows.devices.spi/spiconnectionsettings_mode.md index 331dbf2e17..d93d593d9c 100644 --- a/windows.devices.spi/spiconnectionsettings_mode.md +++ b/windows.devices.spi/spiconnectionsettings_mode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiConnectionSettings.Mode --api-type: winrt property ---- # Windows.Devices.Spi.SpiConnectionSettings.Mode ## -description Gets or sets the [SpiMode](spimode.md) for this connection. ## -property-value The communication mode. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiConnectionSettings.Mode +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings.Mode + +## -description +Gets or sets the [SpiMode](spimode.md) for this connection. + +## -property-value +The communication mode. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spiconnectionsettings_sharingmode.md b/windows.devices.spi/spiconnectionsettings_sharingmode.md index 295095e85e..4071e1f51f 100644 --- a/windows.devices.spi/spiconnectionsettings_sharingmode.md +++ b/windows.devices.spi/spiconnectionsettings_sharingmode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiConnectionSettings.SharingMode --api-type: winrt property ---- # Windows.Devices.Spi.SpiConnectionSettings.SharingMode ## -description Gets or sets the sharing mode for the SPI connection. ## -property-value The sharing mode. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiConnectionSettings.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings.SharingMode + +## -description +Gets or sets the sharing mode for the SPI connection. + +## -property-value +The sharing mode. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spiconnectionsettings_spiconnectionsettings_745845612.md b/windows.devices.spi/spiconnectionsettings_spiconnectionsettings_745845612.md index e00d9f6816..f896fe7da7 100644 --- a/windows.devices.spi/spiconnectionsettings_spiconnectionsettings_745845612.md +++ b/windows.devices.spi/spiconnectionsettings_spiconnectionsettings_745845612.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Spi.SpiConnectionSettings.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Devices.Spi.SpiConnectionSettings.SpiConnectionSettings ## -description Initializes new instance of [SpiConnectionSettings](spiconnectionsettings.md). ## -parameters ### -param chipSelectLine The chip select line on which the connection will be made. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiConnectionSettings.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiConnectionSettings.SpiConnectionSettings + +## -description +Initializes new instance of [SpiConnectionSettings](spiconnectionsettings.md). + +## -parameters +### -param chipSelectLine +The chip select line on which the connection will be made. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spicontroller.md b/windows.devices.spi/spicontroller.md index 5f525d8c85..b6b199e907 100644 --- a/windows.devices.spi/spicontroller.md +++ b/windows.devices.spi/spicontroller.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Spi.SpiController --api-type: winrt class ---- # Windows.Devices.Spi.SpiController ## -description Represents the SPI controller on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Spi.SpiController +-api-type: winrt class +--- + + + +# Windows.Devices.Spi.SpiController + +## -description +Represents the SPI controller on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spicontroller_getcontrollersasync_1644567174.md b/windows.devices.spi/spicontroller_getcontrollersasync_1644567174.md index 21b3a432f9..f3b8aebde8 100644 --- a/windows.devices.spi/spicontroller_getcontrollersasync_1644567174.md +++ b/windows.devices.spi/spicontroller_getcontrollersasync_1644567174.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Spi.SpiController.GetControllersAsync(Windows.Devices.Spi.Provider.ISpiProvider) --api-type: winrt method ---- # Windows.Devices.Spi.SpiController.GetControllersAsync ## -description Gets all the SPI controllers that are on the system. ## -parameters ### -param provider The SPI provider for the controllers on the system. ## -returns When the method completes successfully, it returns a list of values that represent the available SPI controllers on the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiController.GetControllersAsync(Windows.Devices.Spi.Provider.ISpiProvider) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiController.GetControllersAsync + +## -description +Gets all the SPI controllers that are on the system. + +## -parameters +### -param provider +The SPI provider for the controllers on the system. + +## -returns +When the method completes successfully, it returns a list of values that represent the available SPI controllers on the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spicontroller_getdefaultasync_1549573963.md b/windows.devices.spi/spicontroller_getdefaultasync_1549573963.md index 5e8109ecef..66bc7cfeb5 100644 --- a/windows.devices.spi/spicontroller_getdefaultasync_1549573963.md +++ b/windows.devices.spi/spicontroller_getdefaultasync_1549573963.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Spi.SpiController.GetDefaultAsync --api-type: winrt method ---- # Windows.Devices.Spi.SpiController.GetDefaultAsync ## -description Gets the default SPI controller on the system. ## -returns The default SPI controller on the system, or null if the system has no SPI controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiController.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiController.GetDefaultAsync + +## -description +Gets the default SPI controller on the system. + +## -returns +The default SPI controller on the system, or null if the system has no SPI controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spicontroller_getdevice_1481105661.md b/windows.devices.spi/spicontroller_getdevice_1481105661.md index 70638c98da..a4582cd31e 100644 --- a/windows.devices.spi/spicontroller_getdevice_1481105661.md +++ b/windows.devices.spi/spicontroller_getdevice_1481105661.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Spi.SpiController.GetDevice(Windows.Devices.Spi.SpiConnectionSettings) --api-type: winrt method ---- # Windows.Devices.Spi.SpiController.GetDevice ## -description Gets the SPI device with the specified settings. ## -parameters ### -param settings The desired connection settings. ## -returns The SPI device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiController.GetDevice(Windows.Devices.Spi.SpiConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiController.GetDevice + +## -description +Gets the SPI device with the specified settings. + +## -parameters +### -param settings +The desired connection settings. + +## -returns +The SPI device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spidevice.md b/windows.devices.spi/spidevice.md index 31d3be8030..c832af3d36 100644 --- a/windows.devices.spi/spidevice.md +++ b/windows.devices.spi/spidevice.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Spi.SpiDevice --api-type: winrt class ---- # Windows.Devices.Spi.SpiDevice ## -description Represents a device connected through the SPI bus. ## -remarks ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Spi.SpiDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Spi.SpiDevice + +## -description +Represents a device connected through the SPI bus. + +## -remarks + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.spi/spidevice_close_811482585.md b/windows.devices.spi/spidevice_close_811482585.md index c11de4a5d5..76f4871841 100644 --- a/windows.devices.spi/spidevice_close_811482585.md +++ b/windows.devices.spi/spidevice_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.Close --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.Close ## -description Closes the connection to the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.Close + +## -description +Closes the connection to the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.spi/spidevice_connectionsettings.md b/windows.devices.spi/spidevice_connectionsettings.md index 57260d64c6..a6ef75d26b 100644 --- a/windows.devices.spi/spidevice_connectionsettings.md +++ b/windows.devices.spi/spidevice_connectionsettings.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiDevice.ConnectionSettings --api-type: winrt property ---- # Windows.Devices.Spi.SpiDevice.ConnectionSettings ## -description Gets the connection settings for the device. ## -property-value The connection settings. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiDevice.ConnectionSettings +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiDevice.ConnectionSettings + +## -description +Gets the connection settings for the device. + +## -property-value +The connection settings. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_deviceid.md b/windows.devices.spi/spidevice_deviceid.md index f0fe8335af..c3500fff86 100644 --- a/windows.devices.spi/spidevice_deviceid.md +++ b/windows.devices.spi/spidevice_deviceid.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Devices.Spi.SpiDevice.DeviceId --api-type: winrt property ---- # Windows.Devices.Spi.SpiDevice.DeviceId ## -description Gets the unique ID associated with the device. ## -property-value The ID. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: P:Windows.Devices.Spi.SpiDevice.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Spi.SpiDevice.DeviceId + +## -description +Gets the unique ID associated with the device. + +## -property-value +The ID. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_fromidasync_1537599820.md b/windows.devices.spi/spidevice_fromidasync_1537599820.md index 72734e06f0..76c96d4f6b 100644 --- a/windows.devices.spi/spidevice_fromidasync_1537599820.md +++ b/windows.devices.spi/spidevice_fromidasync_1537599820.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.FromIdAsync(System.String,Windows.Devices.Spi.SpiConnectionSettings) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.FromIdAsync ## -description Opens a device with the connection settings provided. ## -parameters ### -param busId The id of the bus. ### -param settings The connection settings. ## -returns The SPI device requested. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.FromIdAsync(System.String,Windows.Devices.Spi.SpiConnectionSettings) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.FromIdAsync + +## -description +Opens a device with the connection settings provided. + +## -parameters +### -param busId +The id of the bus. + +### -param settings +The connection settings. + +## -returns +The SPI device requested. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_getbusinfo_536615562.md b/windows.devices.spi/spidevice_getbusinfo_536615562.md index 55142756f3..7187dc60ff 100644 --- a/windows.devices.spi/spidevice_getbusinfo_536615562.md +++ b/windows.devices.spi/spidevice_getbusinfo_536615562.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.GetBusInfo(System.String) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.GetBusInfo ## -description Retrieves the info about a certain bus. ## -parameters ### -param busId The id of the bus. ## -returns The bus info requested. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.GetBusInfo(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.GetBusInfo + +## -description +Retrieves the info about a certain bus. + +## -parameters +### -param busId +The id of the bus. + +## -returns +The bus info requested. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_getdeviceselector_1752695616.md b/windows.devices.spi/spidevice_getdeviceselector_1752695616.md index 8d98116f14..e5d9c93862 100644 --- a/windows.devices.spi/spidevice_getdeviceselector_1752695616.md +++ b/windows.devices.spi/spidevice_getdeviceselector_1752695616.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.GetDeviceSelector(System.String) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.GetDeviceSelector ## -description Gets all the SPI buses found on the system that match the input parameter. ## -parameters ### -param friendlyName Input parameter specifying an identifying name for the desired bus. This usually corresponds to a name on the schematic. ## -returns String containing all the buses that have the input in the name. ## -remarks ## -examples ## -see-also [GetDeviceSelector](spidevice_getdeviceselector_838466080.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.GetDeviceSelector + +## -description +Gets all the SPI buses found on the system that match the input parameter. + +## -parameters +### -param friendlyName +Input parameter specifying an identifying name for the desired bus. This usually corresponds to a name on the schematic. + +## -returns +String containing all the buses that have the input in the name. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector](spidevice_getdeviceselector_838466080.md) \ No newline at end of file diff --git a/windows.devices.spi/spidevice_getdeviceselector_838466080.md b/windows.devices.spi/spidevice_getdeviceselector_838466080.md index d4912951b6..5f6a9eca83 100644 --- a/windows.devices.spi/spidevice_getdeviceselector_838466080.md +++ b/windows.devices.spi/spidevice_getdeviceselector_838466080.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.GetDeviceSelector ## -description Gets all the SPI buses found on the system. ## -returns String containing all the buses found on the system. ## -remarks ## -examples ## -see-also [GetDeviceSelector(String)](spidevice_getdeviceselector_1752695616.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.GetDeviceSelector + +## -description +Gets all the SPI buses found on the system. + +## -returns +String containing all the buses found on the system. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(String)](spidevice_getdeviceselector_1752695616.md) \ No newline at end of file diff --git a/windows.devices.spi/spidevice_read_1437850332.md b/windows.devices.spi/spidevice_read_1437850332.md index 031726d166..cd22060c5e 100644 --- a/windows.devices.spi/spidevice_read_1437850332.md +++ b/windows.devices.spi/spidevice_read_1437850332.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.Read(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.Read ## -description Reads from the connected device. ## -parameters ### -param buffer Array containing data read from the device. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.Read(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.Read + +## -description +Reads from the connected device. + +## -parameters +### -param buffer +Array containing data read from the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_transferfullduplex_1952292325.md b/windows.devices.spi/spidevice_transferfullduplex_1952292325.md index 96de400073..87309ff148 100644 --- a/windows.devices.spi/spidevice_transferfullduplex_1952292325.md +++ b/windows.devices.spi/spidevice_transferfullduplex_1952292325.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.TransferFullDuplex(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.TransferFullDuplex ## -description Transfer data using a full duplex communication system. Full duplex allows both the master and the slave to communicate simultaneously. ## -parameters ### -param writeBuffer Array containing data to write to the device. ### -param readBuffer Array containing data read from the device. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.TransferFullDuplex(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.TransferFullDuplex + +## -description +Transfer data using a full duplex communication system. Full duplex allows both the master and the slave to communicate simultaneously. + +## -parameters +### -param writeBuffer +Array containing data to write to the device. + +### -param readBuffer +Array containing data read from the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_transfersequential_1108324954.md b/windows.devices.spi/spidevice_transfersequential_1108324954.md index eae1af1480..bc8a1ea88f 100644 --- a/windows.devices.spi/spidevice_transfersequential_1108324954.md +++ b/windows.devices.spi/spidevice_transfersequential_1108324954.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.TransferSequential(System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.TransferSequential ## -description Transfer data sequentially to the device. ## -parameters ### -param writeBuffer Array containing data to write to the device. ### -param readBuffer Array containing data read from the device. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.TransferSequential(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.TransferSequential + +## -description +Transfer data sequentially to the device. + +## -parameters +### -param writeBuffer +Array containing data to write to the device. + +### -param readBuffer +Array containing data read from the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.spi/spidevice_write_1047802370.md b/windows.devices.spi/spidevice_write_1047802370.md index 197dbf26ff..dd4c7e0a60 100644 --- a/windows.devices.spi/spidevice_write_1047802370.md +++ b/windows.devices.spi/spidevice_write_1047802370.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Spi.SpiDevice.Write(System.Byte[]) --api-type: winrt method ---- # Windows.Devices.Spi.SpiDevice.Write ## -description Writes to the connected device. ## -parameters ### -param buffer Array containing the data to write to the device. ## -remarks ## -examples ## -see-also ## -capabilities lowLevelDevices \ No newline at end of file +--- +-api-id: M:Windows.Devices.Spi.SpiDevice.Write(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Devices.Spi.SpiDevice.Write + +## -description +Writes to the connected device. + +## -parameters +### -param buffer +Array containing the data to write to the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +lowLevelDevices \ No newline at end of file diff --git a/windows.devices.usb/usbbulkinendpointdescriptor.md b/windows.devices.usb/usbbulkinendpointdescriptor.md index 3aba180e2f..2305cfc42c 100644 --- a/windows.devices.usb/usbbulkinendpointdescriptor.md +++ b/windows.devices.usb/usbbulkinendpointdescriptor.md @@ -1,3 +1,31 @@ ---- -api-id: T:Windows.Devices.Usb.UsbBulkInEndpointDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbBulkInEndpointDescriptor ## -description The endpoint descriptor for a USB bulk IN endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be read from the endpoint, in a single transfer. ## -remarks **JavaScript (Usage)** ``` var descriptorBulkInEp = device.defaultInterface.descriptors.getAt(1); var usbEndpointDescriptor = Windows.Devices.Usb.UsbEndpointDescriptor.parse(descriptorBulkInEp); var usbBulkInEndpointDescriptor = usbEndpointDescriptor.asBulkInEndpointDescriptor(); ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbBulkInEndpointDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbBulkInEndpointDescriptor + +## -description +The endpoint descriptor for a USB bulk IN endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be read from the endpoint, in a single transfer. + +## -remarks +**JavaScript (Usage)** + + + +``` +var descriptorBulkInEp = device.defaultInterface.descriptors.getAt(1); +var usbEndpointDescriptor = Windows.Devices.Usb.UsbEndpointDescriptor.parse(descriptorBulkInEp); +var usbBulkInEndpointDescriptor = usbEndpointDescriptor.asBulkInEndpointDescriptor(); + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinendpointdescriptor_endpointnumber.md b/windows.devices.usb/usbbulkinendpointdescriptor_endpointnumber.md index 6eb74806ba..d14f4618e5 100644 --- a/windows.devices.usb/usbbulkinendpointdescriptor_endpointnumber.md +++ b/windows.devices.usb/usbbulkinendpointdescriptor_endpointnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInEndpointDescriptor.EndpointNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInEndpointDescriptor.EndpointNumber ## -description Gets the USB endpoint number of the bulk IN endpoint. ## -property-value The endpoint number of the bulk IN endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInEndpointDescriptor.EndpointNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInEndpointDescriptor.EndpointNumber + +## -description +Gets the USB endpoint number of the bulk IN endpoint. + +## -property-value +The endpoint number of the bulk IN endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinendpointdescriptor_maxpacketsize.md b/windows.devices.usb/usbbulkinendpointdescriptor_maxpacketsize.md index 92d3593f89..784af22932 100644 --- a/windows.devices.usb/usbbulkinendpointdescriptor_maxpacketsize.md +++ b/windows.devices.usb/usbbulkinendpointdescriptor_maxpacketsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInEndpointDescriptor.MaxPacketSize --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInEndpointDescriptor.MaxPacketSize ## -description Gets the maximum number of bytes that can be sent to or received from this endpoint, in a single packet. ## -property-value Indicates the maximum packet size of the endpoint. This value is derived from the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInEndpointDescriptor.MaxPacketSize +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInEndpointDescriptor.MaxPacketSize + +## -description +Gets the maximum number of bytes that can be sent to or received from this endpoint, in a single packet. + +## -property-value +Indicates the maximum packet size of the endpoint. This value is derived from the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinendpointdescriptor_pipe.md b/windows.devices.usb/usbbulkinendpointdescriptor_pipe.md index 960523cbca..be69c3ce25 100644 --- a/windows.devices.usb/usbbulkinendpointdescriptor_pipe.md +++ b/windows.devices.usb/usbbulkinendpointdescriptor_pipe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInEndpointDescriptor.Pipe --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInEndpointDescriptor.Pipe ## -description Gets the object that represents the pipe that the host opens to communicate with the bulk IN endpoint. ## -property-value An [UsbBulkInPipe](usbbulkinpipe.md) object that is the pipe for the bulk IN endpoint. ## -remarks If the alternate setting, which defines this bulk endpoint, is not currently selected, the property returns NULL. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInEndpointDescriptor.Pipe +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInEndpointDescriptor.Pipe + +## -description +Gets the object that represents the pipe that the host opens to communicate with the bulk IN endpoint. + +## -property-value +An [UsbBulkInPipe](usbbulkinpipe.md) object that is the pipe for the bulk IN endpoint. + +## -remarks +If the alternate setting, which defines this bulk endpoint, is not currently selected, the property returns NULL. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe.md b/windows.devices.usb/usbbulkinpipe.md index 96e50e1eef..3cfe307103 100644 --- a/windows.devices.usb/usbbulkinpipe.md +++ b/windows.devices.usb/usbbulkinpipe.md @@ -1,3 +1,44 @@ ---- -api-id: T:Windows.Devices.Usb.UsbBulkInPipe --api-type: winrt class ---- # Windows.Devices.Usb.UsbBulkInPipe ## -description Represents the pipe that the underlying USB driver opens to communicate with a USB bulk IN endpoint of the device. The app can get an input stream from the pipe and access data is being read from the endpoint. ## -remarks This code example shows how to read data from a bulk IN pipe. The example assumes that the app has previously obtained the [UsbDevice](usbdevice.md) object. ```csharp UsbDevice device; UInt32 readLen = 8; // Get the UsbDevice object. Not shown. ... UsbBulkInPipe bulkIn = device.DefaultInterface.BulkInPipes[0]; DataReader reader = new DataReader(bulkIn.InputStream); await reader.LoadAsync(readLen); UInt64 data = reader.ReadUInt64(); ShowData(data); ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbBulkInPipe +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe + +## -description +Represents the pipe that the underlying USB driver opens to communicate with a USB bulk IN endpoint of the device. The app can get an input stream from the pipe and access data is being read from the endpoint. + +## -remarks + + +This code example shows how to read data from a bulk IN pipe. The example assumes that the app has previously obtained the [UsbDevice](usbdevice.md) object. + +```csharp +UsbDevice device; +UInt32 readLen = 8; + +// Get the UsbDevice object. Not shown. + +... + +UsbBulkInPipe bulkIn = device.DefaultInterface.BulkInPipes[0]; + +DataReader reader = new DataReader(bulkIn.InputStream); + +await reader.LoadAsync(readLen); + +UInt64 data = reader.ReadUInt64(); + +ShowData(data); + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe_clearstallasync_1674007612.md b/windows.devices.usb/usbbulkinpipe_clearstallasync_1674007612.md index 699432f156..85c2285957 100644 --- a/windows.devices.usb/usbbulkinpipe_clearstallasync_1674007612.md +++ b/windows.devices.usb/usbbulkinpipe_clearstallasync_1674007612.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Usb.UsbBulkInPipe.ClearStallAsync --api-type: winrt method ---- # Windows.Devices.Usb.UsbBulkInPipe.ClearStallAsync ## -description Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB bulk IN endpoint that is associated with the pipe. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbBulkInPipe.ClearStallAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe.ClearStallAsync + +## -description +Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB bulk IN endpoint that is associated with the pipe. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe_endpointdescriptor.md b/windows.devices.usb/usbbulkinpipe_endpointdescriptor.md index 0e05f73f05..77f9751cf3 100644 --- a/windows.devices.usb/usbbulkinpipe_endpointdescriptor.md +++ b/windows.devices.usb/usbbulkinpipe_endpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInPipe.EndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInPipe.EndpointDescriptor ## -description Gets the object that represents endpoint descriptor associated with the USB bulk IN endpoint. ## -property-value A [UsbBulkInEndpointDescriptor](usbbulkinendpointdescriptor.md) object that represents endpoint descriptor associated with the USB bulk IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInPipe.EndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe.EndpointDescriptor + +## -description +Gets the object that represents endpoint descriptor associated with the USB bulk IN endpoint. + +## -property-value +A [UsbBulkInEndpointDescriptor](usbbulkinendpointdescriptor.md) object that represents endpoint descriptor associated with the USB bulk IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe_flushbuffer_1890425863.md b/windows.devices.usb/usbbulkinpipe_flushbuffer_1890425863.md index 3fa08be999..b0384b4ede 100644 --- a/windows.devices.usb/usbbulkinpipe_flushbuffer_1890425863.md +++ b/windows.devices.usb/usbbulkinpipe_flushbuffer_1890425863.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Usb.UsbBulkInPipe.FlushBuffer --api-type: winrt method ---- # Windows.Devices.Usb.UsbBulkInPipe.FlushBuffer ## -description Discards any data that is cached in the bulk IN pipe. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbBulkInPipe.FlushBuffer +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe.FlushBuffer + +## -description +Discards any data that is cached in the bulk IN pipe. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe_inputstream.md b/windows.devices.usb/usbbulkinpipe_inputstream.md index 93c2c7f717..1e7fbf4c18 100644 --- a/windows.devices.usb/usbbulkinpipe_inputstream.md +++ b/windows.devices.usb/usbbulkinpipe_inputstream.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInPipe.InputStream --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInPipe.InputStream ## -description Input stream that stores the data that the bulk IN pipe received from the endpoint. ## -property-value Input stream that contains data read from the endpoint. ## -remarks To access data read from a bulk IN pipe, get the input stream from the pipe, and then use the [DataReader](../windows.storage.streams/datareader.md) to read data. ``` auto stream = DeviceList::Current->Fx2Device->Configuration->UsbInterfaces->GetAt(0)->BulkInPipes->GetAt(0)->InputStream; Windows::Storage::Streams::DataReader^ reader = ref new Windows::Storage::Streams::DataReader(stream); Concurrency::create_task(reader->LoadAsync(TRANSFER_SIZE)) .then ([this, reader] (uint32 result) { //Your code. }); ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInPipe.InputStream +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe.InputStream + +## -description +Input stream that stores the data that the bulk IN pipe received from the endpoint. + +## -property-value +Input stream that contains data read from the endpoint. + +## -remarks +To access data read from a bulk IN pipe, get the input stream from the pipe, and then use the [DataReader](../windows.storage.streams/datareader.md) to read data. + +``` + auto stream = DeviceList::Current->Fx2Device->Configuration->UsbInterfaces->GetAt(0)->BulkInPipes->GetAt(0)->InputStream; + + Windows::Storage::Streams::DataReader^ reader = ref new Windows::Storage::Streams::DataReader(stream); + + Concurrency::create_task(reader->LoadAsync(TRANSFER_SIZE)) + .then ([this, reader] (uint32 result) + { + + //Your code. + + + }); + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe_maxtransfersizebytes.md b/windows.devices.usb/usbbulkinpipe_maxtransfersizebytes.md index c87cbf19dc..8fb5bf70c3 100644 --- a/windows.devices.usb/usbbulkinpipe_maxtransfersizebytes.md +++ b/windows.devices.usb/usbbulkinpipe_maxtransfersizebytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInPipe.MaxTransferSizeBytes --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInPipe.MaxTransferSizeBytes ## -description Gets the maximum number of bytes that can be read from the bulk IN pipe in a single transfer. ## -property-value The maximum number of bytes that can be read from the bulk IN pipe in a single transfer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInPipe.MaxTransferSizeBytes +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe.MaxTransferSizeBytes + +## -description +Gets the maximum number of bytes that can be read from the bulk IN pipe in a single transfer. + +## -property-value +The maximum number of bytes that can be read from the bulk IN pipe in a single transfer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkinpipe_readoptions.md b/windows.devices.usb/usbbulkinpipe_readoptions.md index 393e0969c6..2ebcfa96e3 100644 --- a/windows.devices.usb/usbbulkinpipe_readoptions.md +++ b/windows.devices.usb/usbbulkinpipe_readoptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkInPipe.ReadOptions --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkInPipe.ReadOptions ## -description Gets or sets configuration flags that controls the behavior of the pipe that reads data from a USB bulk IN endpoint. ## -property-value A [UsbReadOptions](usbreadoptions.md) value that indicates the pipe policy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkInPipe.ReadOptions +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkInPipe.ReadOptions + +## -description +Gets or sets configuration flags that controls the behavior of the pipe that reads data from a USB bulk IN endpoint. + +## -property-value +A [UsbReadOptions](usbreadoptions.md) value that indicates the pipe policy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutendpointdescriptor.md b/windows.devices.usb/usbbulkoutendpointdescriptor.md index b948024ace..3ed2c85a24 100644 --- a/windows.devices.usb/usbbulkoutendpointdescriptor.md +++ b/windows.devices.usb/usbbulkoutendpointdescriptor.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbBulkOutEndpointDescriptor ## -description The endpoint descriptor for a USB bulk OUT endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be written to the endpoint, in a single transfer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbBulkOutEndpointDescriptor + +## -description +The endpoint descriptor for a USB bulk OUT endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be written to the endpoint, in a single transfer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutendpointdescriptor_endpointnumber.md b/windows.devices.usb/usbbulkoutendpointdescriptor_endpointnumber.md index 25c3028148..dd8e1e3f38 100644 --- a/windows.devices.usb/usbbulkoutendpointdescriptor_endpointnumber.md +++ b/windows.devices.usb/usbbulkoutendpointdescriptor_endpointnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.EndpointNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.EndpointNumber ## -description Gets the USB endpoint number of the bulk OUT endpoint. ## -property-value The endpoint number of the bulk OUT endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.EndpointNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.EndpointNumber + +## -description +Gets the USB endpoint number of the bulk OUT endpoint. + +## -property-value +The endpoint number of the bulk OUT endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutendpointdescriptor_maxpacketsize.md b/windows.devices.usb/usbbulkoutendpointdescriptor_maxpacketsize.md index 1c43bd578d..d1f7e35297 100644 --- a/windows.devices.usb/usbbulkoutendpointdescriptor_maxpacketsize.md +++ b/windows.devices.usb/usbbulkoutendpointdescriptor_maxpacketsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.MaxPacketSize --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.MaxPacketSize ## -description Gets the maximum number of bytes that can be sent to or received from this endpoint. ## -property-value Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.MaxPacketSize +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.MaxPacketSize + +## -description +Gets the maximum number of bytes that can be sent to or received from this endpoint. + +## -property-value +Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutendpointdescriptor_pipe.md b/windows.devices.usb/usbbulkoutendpointdescriptor_pipe.md index 2152142a05..b2d0d9155b 100644 --- a/windows.devices.usb/usbbulkoutendpointdescriptor_pipe.md +++ b/windows.devices.usb/usbbulkoutendpointdescriptor_pipe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.Pipe --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.Pipe ## -description Gets the object that represents the pipe that the host opens to communicate with the bulk IN endpoint. ## -property-value A [UsbBulkOutPipe](usbbulkoutpipe.md) object that is the pipe for the bulk OUT endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.Pipe +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkOutEndpointDescriptor.Pipe + +## -description +Gets the object that represents the pipe that the host opens to communicate with the bulk IN endpoint. + +## -property-value +A [UsbBulkOutPipe](usbbulkoutpipe.md) object that is the pipe for the bulk OUT endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutpipe.md b/windows.devices.usb/usbbulkoutpipe.md index f752d6c9ce..ffeca89266 100644 --- a/windows.devices.usb/usbbulkoutpipe.md +++ b/windows.devices.usb/usbbulkoutpipe.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbBulkOutPipe --api-type: winrt class ---- # Windows.Devices.Usb.UsbBulkOutPipe ## -description Represents the pipe that the underlying USB driver opens to communicate with a USB bulk OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbBulkOutPipe +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbBulkOutPipe + +## -description +Represents the pipe that the underlying USB driver opens to communicate with a USB bulk OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutpipe_clearstallasync_1674007612.md b/windows.devices.usb/usbbulkoutpipe_clearstallasync_1674007612.md index 8d49dafbad..b1964de1f9 100644 --- a/windows.devices.usb/usbbulkoutpipe_clearstallasync_1674007612.md +++ b/windows.devices.usb/usbbulkoutpipe_clearstallasync_1674007612.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Usb.UsbBulkOutPipe.ClearStallAsync --api-type: winrt method ---- # Windows.Devices.Usb.UsbBulkOutPipe.ClearStallAsync ## -description Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB bulk OUT endpoint that is associated with the pipe. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbBulkOutPipe.ClearStallAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbBulkOutPipe.ClearStallAsync + +## -description +Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB bulk OUT endpoint that is associated with the pipe. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutpipe_endpointdescriptor.md b/windows.devices.usb/usbbulkoutpipe_endpointdescriptor.md index 8c4f8a3e3f..5adcfc3357 100644 --- a/windows.devices.usb/usbbulkoutpipe_endpointdescriptor.md +++ b/windows.devices.usb/usbbulkoutpipe_endpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkOutPipe.EndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkOutPipe.EndpointDescriptor ## -description Gets the object that represents the endpoint descriptor associated with the USB bulk OUT endpoint. ## -property-value A [UsbBulkOutEndpointDescriptor](usbbulkoutendpointdescriptor.md) that represents the endpoint descriptor associated with the USB bulk OUT endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkOutPipe.EndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkOutPipe.EndpointDescriptor + +## -description +Gets the object that represents the endpoint descriptor associated with the USB bulk OUT endpoint. + +## -property-value +A [UsbBulkOutEndpointDescriptor](usbbulkoutendpointdescriptor.md) that represents the endpoint descriptor associated with the USB bulk OUT endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutpipe_outputstream.md b/windows.devices.usb/usbbulkoutpipe_outputstream.md index ed0157cf14..a44a7d1d80 100644 --- a/windows.devices.usb/usbbulkoutpipe_outputstream.md +++ b/windows.devices.usb/usbbulkoutpipe_outputstream.md @@ -1,3 +1,41 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkOutPipe.OutputStream --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkOutPipe.OutputStream ## -description Gets an output stream to which the app can write data to send to the endpoint. ## -property-value The output steam that contains the transfer data. ## -remarks To write data, first get the output stream from the pipe by using [OutputStream](usbinterruptoutpipe_outputstream.md) property and then use the [DataWriter](../windows.storage.streams/datawriter.md) object to write the actual buffer. ``` Windows::Storage::Streams::Buffer^ buffer = ref new Windows::Storage::Streams::Buffer(TRANSFER_SIZE); buffer->Length = TRANSFER_SIZE; auto stream = DeviceList::Current->Fx2Device->Configuration->UsbInterfaces->GetAt(0)->BulkOutPipes->GetAt(0)->OutputStream; Windows::Storage::Streams::DataWriter^ writer = ref new Windows::Storage::Streams::DataWriter(stream); writer->WriteBuffer(buffer); }); ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkOutPipe.OutputStream +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkOutPipe.OutputStream + +## -description +Gets an output stream to which the app can write data to send to the endpoint. + +## -property-value +The output steam that contains the transfer data. + +## -remarks +To write data, first get the output stream from the pipe by using [OutputStream](usbinterruptoutpipe_outputstream.md) property and then use the [DataWriter](../windows.storage.streams/datawriter.md) object to write the actual buffer. + +``` + Windows::Storage::Streams::Buffer^ buffer = ref new Windows::Storage::Streams::Buffer(TRANSFER_SIZE); + + buffer->Length = TRANSFER_SIZE; + + auto stream = DeviceList::Current->Fx2Device->Configuration->UsbInterfaces->GetAt(0)->BulkOutPipes->GetAt(0)->OutputStream; + + Windows::Storage::Streams::DataWriter^ writer = ref new Windows::Storage::Streams::DataWriter(stream); + + writer->WriteBuffer(buffer); + + + }); + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbbulkoutpipe_writeoptions.md b/windows.devices.usb/usbbulkoutpipe_writeoptions.md index 86c54c5e35..b391ea298c 100644 --- a/windows.devices.usb/usbbulkoutpipe_writeoptions.md +++ b/windows.devices.usb/usbbulkoutpipe_writeoptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbBulkOutPipe.WriteOptions --api-type: winrt property ---- # Windows.Devices.Usb.UsbBulkOutPipe.WriteOptions ## -description Gets or sets configuration flags that controls the behavior of the pipe that writes data to a USB bulk IN endpoint. ## -property-value A [UsbWriteOptions](usbwriteoptions.md) constant that indicates the pipe policy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbBulkOutPipe.WriteOptions +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbBulkOutPipe.WriteOptions + +## -description +Gets or sets configuration flags that controls the behavior of the pipe that writes data to a USB bulk IN endpoint. + +## -property-value +A [UsbWriteOptions](usbwriteoptions.md) constant that indicates the pipe policy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfiguration.md b/windows.devices.usb/usbconfiguration.md index c764ee926c..c2ac5cb563 100644 --- a/windows.devices.usb/usbconfiguration.md +++ b/windows.devices.usb/usbconfiguration.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Usb.UsbConfiguration --api-type: winrt class ---- # Windows.Devices.Usb.UsbConfiguration ## -description Provides information about a USB configuration, its descriptors and the interfaces defined within that configuration. For an explanation of a USB configuration, see Section 9.6.3 in the Universal Serial Bus (USB) specification. ## -remarks Within a USB configuration, the number of interfaces and their alternate settings are variable, depending on the number of interfaces that the device supports. You can collect all that information by using: [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) and [UsbConfigurationDescriptor.Descriptors](usbconfiguration_descriptors.md). The [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) contains the first 9 bytes of the configuration descriptor. The [UsbConfigurationDescriptor.Descriptors](usbconfiguration_descriptors.md) object contains an array of descriptors associated with all interfaces and their settings. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbConfiguration +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbConfiguration + +## -description +Provides information about a USB configuration, its descriptors and the interfaces defined within that configuration. For an explanation of a USB configuration, see Section 9.6.3 in the Universal Serial Bus (USB) specification. + +## -remarks +Within a USB configuration, the number of interfaces and their alternate settings are variable, depending on the number of interfaces that the device supports. You can collect all that information by using: [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) and [UsbConfigurationDescriptor.Descriptors](usbconfiguration_descriptors.md). The [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) contains the first 9 bytes of the configuration descriptor. The [UsbConfigurationDescriptor.Descriptors](usbconfiguration_descriptors.md) object contains an array of descriptors associated with all interfaces and their settings. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfiguration_configurationdescriptor.md b/windows.devices.usb/usbconfiguration_configurationdescriptor.md index 0d16fa467f..7655605d7a 100644 --- a/windows.devices.usb/usbconfiguration_configurationdescriptor.md +++ b/windows.devices.usb/usbconfiguration_configurationdescriptor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfiguration.ConfigurationDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfiguration.ConfigurationDescriptor ## -description Gets the object that contains the first 9 bytes of the descriptor associated with the USB configuration. ## -property-value A [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object that represents the first 9 bytes of the descriptor associated with the USB configuration. ## -remarks The received [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object represents only the first 9 bytes of the configuration descriptor. To get the entire set of descriptors associated with a USB configuration, use the Descriptors property that gets the array of all descriptors within the configuration. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfiguration.ConfigurationDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfiguration.ConfigurationDescriptor + +## -description +Gets the object that contains the first 9 bytes of the descriptor associated with the USB configuration. + +## -property-value +A [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object that represents the first 9 bytes of the descriptor associated with the USB configuration. + +## -remarks +The received [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object represents only the first 9 bytes of the configuration descriptor. To get the entire set of descriptors associated with a USB configuration, use the Descriptors property that gets the array of all descriptors within the configuration. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfiguration_descriptors.md b/windows.devices.usb/usbconfiguration_descriptors.md index 62d9960b6a..ec015a1d5d 100644 --- a/windows.devices.usb/usbconfiguration_descriptors.md +++ b/windows.devices.usb/usbconfiguration_descriptors.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfiguration.Descriptors --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfiguration.Descriptors ## -description Gets an array of objects that represent the full set of descriptors associated with a USB configuration. ## -property-value An array of [UsbDescriptor](usbdescriptor.md) objects that contains the full set of descriptors associated with a USB configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfiguration.Descriptors +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfiguration.Descriptors + +## -description +Gets an array of objects that represent the full set of descriptors associated with a USB configuration. + +## -property-value +An array of [UsbDescriptor](usbdescriptor.md) objects that contains the full set of descriptors associated with a USB configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfiguration_usbinterfaces.md b/windows.devices.usb/usbconfiguration_usbinterfaces.md index 3541e77d06..bcb695e31e 100644 --- a/windows.devices.usb/usbconfiguration_usbinterfaces.md +++ b/windows.devices.usb/usbconfiguration_usbinterfaces.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfiguration.UsbInterfaces --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfiguration.UsbInterfaces ## -description Gets an array of USB interfaces available in the USB configuration. ## -property-value An array of [UsbInterface](usbconfiguration_usbinterfaces.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfiguration.UsbInterfaces +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfiguration.UsbInterfaces + +## -description +Gets an array of USB interfaces available in the USB configuration. + +## -property-value +An array of [UsbInterface](usbconfiguration_usbinterfaces.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfigurationdescriptor.md b/windows.devices.usb/usbconfigurationdescriptor.md index 2512e283f2..992acb8019 100644 --- a/windows.devices.usb/usbconfigurationdescriptor.md +++ b/windows.devices.usb/usbconfigurationdescriptor.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.Usb.UsbConfigurationDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbConfigurationDescriptor ## -description Derives information from the first 9 bytes of a USB configuration descriptor. The information includes the power capabilities of the device when the configuration is active and the number of interfaces included in that configuration. For an explanation of a configuration descriptor, Section 9.6.3 Universal Serial Bus Specification. For information about descriptor fields, see: + Table 9.15 in the Universal Serial Bus 3.0 Specification + Table 9.10 in the Universal Serial Bus Specification (version 2.0) ## -remarks A USB device exposes its capabilities in the form of a USB configuration. A USB configuration is described in a configuration descriptor that the [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) class represents. For information about the descriptor, see [USB configuration descriptors](http://msdn.microsoft.com/library/6bc00e49-cbfe-42a3-ad45-f6dbc6820415). ## -examples ## -see-also [USB configuration descriptors](http://msdn.microsoft.com/library/6bc00e49-cbfe-42a3-ad45-f6dbc6820415) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbConfigurationDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor + +## -description +Derives information from the first 9 bytes of a USB configuration descriptor. The information includes the power capabilities of the device when the configuration is active and the number of interfaces included in that configuration. For an explanation of a configuration descriptor, Section 9.6.3 Universal Serial Bus Specification. For information about descriptor fields, see: + + ++ Table 9.15 in the Universal Serial Bus 3.0 Specification ++ Table 9.10 in the Universal Serial Bus Specification (version 2.0) + + +## -remarks +A USB device exposes its capabilities in the form of a USB configuration. A USB configuration is described in a configuration descriptor that the [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) class represents. For information about the descriptor, see [USB configuration descriptors](http://msdn.microsoft.com/library/6bc00e49-cbfe-42a3-ad45-f6dbc6820415). + +## -examples + +## -see-also +[USB configuration descriptors](http://msdn.microsoft.com/library/6bc00e49-cbfe-42a3-ad45-f6dbc6820415) \ No newline at end of file diff --git a/windows.devices.usb/usbconfigurationdescriptor_configurationvalue.md b/windows.devices.usb/usbconfigurationdescriptor_configurationvalue.md index 53390fdd47..067236a633 100644 --- a/windows.devices.usb/usbconfigurationdescriptor_configurationvalue.md +++ b/windows.devices.usb/usbconfigurationdescriptor_configurationvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.ConfigurationValue --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfigurationDescriptor.ConfigurationValue ## -description Gets the **bConfigurationValue** field of a USB configuration descriptor. The value is the number that identifies the configuration. ## -property-value The number that identifies the configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.ConfigurationValue +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor.ConfigurationValue + +## -description +Gets the **bConfigurationValue** field of a USB configuration descriptor. The value is the number that identifies the configuration. + +## -property-value +The number that identifies the configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfigurationdescriptor_maxpowermilliamps.md b/windows.devices.usb/usbconfigurationdescriptor_maxpowermilliamps.md index 4c8922c173..0635dd139e 100644 --- a/windows.devices.usb/usbconfigurationdescriptor_maxpowermilliamps.md +++ b/windows.devices.usb/usbconfigurationdescriptor_maxpowermilliamps.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.MaxPowerMilliamps --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfigurationDescriptor.MaxPowerMilliamps ## -description Gets the **bMaxPower** field of a USB configuration descriptor. The value indicates the maximum power (in milliamp units) that the device can draw from the bus, when the device is bus-powered. ## -property-value The maximum power (in milliamp units) that the device can draw from the bus. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.MaxPowerMilliamps +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor.MaxPowerMilliamps + +## -description +Gets the **bMaxPower** field of a USB configuration descriptor. The value indicates the maximum power (in milliamp units) that the device can draw from the bus, when the device is bus-powered. + +## -property-value +The maximum power (in milliamp units) that the device can draw from the bus. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfigurationdescriptor_parse_1098943634.md b/windows.devices.usb/usbconfigurationdescriptor_parse_1098943634.md index d8b9a7e079..245d330398 100644 --- a/windows.devices.usb/usbconfigurationdescriptor_parse_1098943634.md +++ b/windows.devices.usb/usbconfigurationdescriptor_parse_1098943634.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Usb.UsbConfigurationDescriptor.Parse(Windows.Devices.Usb.UsbDescriptor) --api-type: winrt method ---- # Windows.Devices.Usb.UsbConfigurationDescriptor.Parse ## -description Parses the specified USB descriptor and returns fields of a USB configuration descriptor. ## -parameters ### -param descriptor A [UsbDescriptor](usbdescriptor.md) object that contains first 9 bytes of the USB configuration descriptor. ## -returns A [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object that contains fields of a USB configuration descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbConfigurationDescriptor.Parse(Windows.Devices.Usb.UsbDescriptor) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor.Parse + +## -description +Parses the specified USB descriptor and returns fields of a USB configuration descriptor. + +## -parameters +### -param descriptor +A [UsbDescriptor](usbdescriptor.md) object that contains first 9 bytes of the USB configuration descriptor. + +## -returns +A [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object that contains fields of a USB configuration descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfigurationdescriptor_remotewakeup.md b/windows.devices.usb/usbconfigurationdescriptor_remotewakeup.md index 457c611cb0..175ff03fa8 100644 --- a/windows.devices.usb/usbconfigurationdescriptor_remotewakeup.md +++ b/windows.devices.usb/usbconfigurationdescriptor_remotewakeup.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.RemoteWakeup --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfigurationDescriptor.RemoteWakeup ## -description Gets the D5 bit value of the **bmAttributes** field in the USB configuration descriptor. The value indicates whether the device can send a resume signal to wake up itself or the host system from a low power state. ## -property-value True, if the device supports remote wakeup; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.RemoteWakeup +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor.RemoteWakeup + +## -description +Gets the D5 bit value of the **bmAttributes** field in the USB configuration descriptor. The value indicates whether the device can send a resume signal to wake up itself or the host system from a low power state. + +## -property-value +True, if the device supports remote wakeup; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfigurationdescriptor_selfpowered.md b/windows.devices.usb/usbconfigurationdescriptor_selfpowered.md index 732329666f..c05dc7d64e 100644 --- a/windows.devices.usb/usbconfigurationdescriptor_selfpowered.md +++ b/windows.devices.usb/usbconfigurationdescriptor_selfpowered.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.SelfPowered --api-type: winrt property ---- # Windows.Devices.Usb.UsbConfigurationDescriptor.SelfPowered ## -description Gets the D6 bit of the **bmAttributes** field in the USB configuration. This value indicates whether the device is drawing power from a local source or the bus. ## -property-value True, if the device is drawing power from a local source; false indicates that the device is only drawing power from the bus. ## -remarks If **SelfPowered** is true, the device is drawing power from a local source, and also some power from the bus. Get the **MaxPowerMilliamps** property value to determine the amount of power the device is drawing from the bus. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbConfigurationDescriptor.SelfPowered +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor.SelfPowered + +## -description +Gets the D6 bit of the **bmAttributes** field in the USB configuration. This value indicates whether the device is drawing power from a local source or the bus. + +## -property-value +True, if the device is drawing power from a local source; false indicates that the device is only drawing power from the bus. + +## -remarks +If **SelfPowered** is true, the device is drawing power from a local source, and also some power from the bus. Get the **MaxPowerMilliamps** property value to determine the amount of power the device is drawing from the bus. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbconfigurationdescriptor_tryparse_708618826.md b/windows.devices.usb/usbconfigurationdescriptor_tryparse_708618826.md index 8e8438ed2b..5cd72b9dea 100644 --- a/windows.devices.usb/usbconfigurationdescriptor_tryparse_708618826.md +++ b/windows.devices.usb/usbconfigurationdescriptor_tryparse_708618826.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Usb.UsbConfigurationDescriptor.TryParse(Windows.Devices.Usb.UsbDescriptor,Windows.Devices.Usb.UsbConfigurationDescriptor@) --api-type: winrt method ---- # Windows.Devices.Usb.UsbConfigurationDescriptor.TryParse ## -description Retrieves the first 9 bytes of a USB configuration descriptor in a [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object that is contained in a [UsbDescriptor](usbdescriptor.md) object. ## -parameters ### -param descriptor The [UsbDescriptor](usbdescriptor.md) object to parse. ### -param parsed Receives a [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object. ## -returns True, if a [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object was found in the specified [UsbDescriptor](usbdescriptor.md) object. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbConfigurationDescriptor.TryParse(Windows.Devices.Usb.UsbDescriptor,Windows.Devices.Usb.UsbConfigurationDescriptor@) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbConfigurationDescriptor.TryParse + +## -description +Retrieves the first 9 bytes of a USB configuration descriptor in a [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object that is contained in a [UsbDescriptor](usbdescriptor.md) object. + +## -parameters +### -param descriptor +The [UsbDescriptor](usbdescriptor.md) object to parse. + +### -param parsed +Receives a [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object. + +## -returns +True, if a [UsbConfigurationDescriptor](usbconfigurationdescriptor.md) object was found in the specified [UsbDescriptor](usbdescriptor.md) object. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbcontrolrequesttype.md b/windows.devices.usb/usbcontrolrequesttype.md index b6fa195a5a..0ba094ca79 100644 --- a/windows.devices.usb/usbcontrolrequesttype.md +++ b/windows.devices.usb/usbcontrolrequesttype.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbControlRequestType --api-type: winrt class ---- # Windows.Devices.Usb.UsbControlRequestType ## -description Provides information about the USB control transfer, the type of control request, whether the data is sent from or to the host, and the recipient of the request in the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbControlRequestType +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbControlRequestType + +## -description +Provides information about the USB control transfer, the type of control request, whether the data is sent from or to the host, and the recipient of the request in the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbcontrolrequesttype_asbyte.md b/windows.devices.usb/usbcontrolrequesttype_asbyte.md index b82f016506..b8bd37b63b 100644 --- a/windows.devices.usb/usbcontrolrequesttype_asbyte.md +++ b/windows.devices.usb/usbcontrolrequesttype_asbyte.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbControlRequestType.AsByte --api-type: winrt property ---- # Windows.Devices.Usb.UsbControlRequestType.AsByte ## -description Gets or sets the **bmRequestType** value as a byte. ## -property-value The entire **bmRequestType** value in a byte. ## -remarks If the hardware specification for the device defines the **bmRequestType** field value to be sent as a byte, you can use the [AsByte](usbcontrolrequesttype_asbyte.md) property. Otherwise, you must individually get or set **bmRequestType** values, such as direction, type, and recipient by using [ControlTransferType](usbcontrolrequesttype_type.md), [Direction](usbcontrolrequesttype_direction.md), and [Recipient](usbcontrolrequesttype_recipient.md) properties, respectively. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbControlRequestType.AsByte +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbControlRequestType.AsByte + +## -description +Gets or sets the **bmRequestType** value as a byte. + +## -property-value +The entire **bmRequestType** value in a byte. + +## -remarks +If the hardware specification for the device defines the **bmRequestType** field value to be sent as a byte, you can use the [AsByte](usbcontrolrequesttype_asbyte.md) property. Otherwise, you must individually get or set **bmRequestType** values, such as direction, type, and recipient by using [ControlTransferType](usbcontrolrequesttype_type.md), [Direction](usbcontrolrequesttype_direction.md), and [Recipient](usbcontrolrequesttype_recipient.md) properties, respectively. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbcontrolrequesttype_controltransfertype.md b/windows.devices.usb/usbcontrolrequesttype_controltransfertype.md index aa09813778..6749a30dd5 100644 --- a/windows.devices.usb/usbcontrolrequesttype_controltransfertype.md +++ b/windows.devices.usb/usbcontrolrequesttype_controltransfertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbControlRequestType.ControlTransferType --api-type: winrt property ---- # Windows.Devices.Usb.UsbControlRequestType.ControlTransferType ## -description Gets or sets the type of USB control transfer: standard, class, or vendor. ## -property-value The type of USB control transfer: standard, class, or vendor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbControlRequestType.ControlTransferType +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbControlRequestType.ControlTransferType + +## -description +Gets or sets the type of USB control transfer: standard, class, or vendor. + +## -property-value +The type of USB control transfer: standard, class, or vendor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbcontrolrequesttype_direction.md b/windows.devices.usb/usbcontrolrequesttype_direction.md index cb4ce7ab1a..9de704eefe 100644 --- a/windows.devices.usb/usbcontrolrequesttype_direction.md +++ b/windows.devices.usb/usbcontrolrequesttype_direction.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbControlRequestType.Direction --api-type: winrt property ---- # Windows.Devices.Usb.UsbControlRequestType.Direction ## -description Gets or sets the direction of the USB control transfer. ## -property-value The direction of the USB control transfer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbControlRequestType.Direction +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbControlRequestType.Direction + +## -description +Gets or sets the direction of the USB control transfer. + +## -property-value +The direction of the USB control transfer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbcontrolrequesttype_recipient.md b/windows.devices.usb/usbcontrolrequesttype_recipient.md index 7d6a6eee88..55e7535923 100644 --- a/windows.devices.usb/usbcontrolrequesttype_recipient.md +++ b/windows.devices.usb/usbcontrolrequesttype_recipient.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbControlRequestType.Recipient --api-type: winrt property ---- # Windows.Devices.Usb.UsbControlRequestType.Recipient ## -description Gets or sets the recipient of the USB control transfer. ## -property-value The recipient of the USB control transfer. ## -remarks If the recipient is the first interface of the active configuration ([DefaultInterface](usbdevice_defaultinterface.md)), [SendControlInTransferAsync](usbdevice_sendcontrolintransferasync_609557051.md) and [SendControlOutTransferAsync](usbdevice_sendcontrolouttransferasync_2044496736.md) methods overwrite the low byte of [UsbSetupPacket.Index](usbsetuppacket_index.md) with the interface number of the default interface. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbControlRequestType.Recipient +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbControlRequestType.Recipient + +## -description +Gets or sets the recipient of the USB control transfer. + +## -property-value +The recipient of the USB control transfer. + +## -remarks +If the recipient is the first interface of the active configuration ([DefaultInterface](usbdevice_defaultinterface.md)), [SendControlInTransferAsync](usbdevice_sendcontrolintransferasync_609557051.md) and [SendControlOutTransferAsync](usbdevice_sendcontrolouttransferasync_2044496736.md) methods overwrite the low byte of [UsbSetupPacket.Index](usbsetuppacket_index.md) with the interface number of the default interface. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbcontrolrequesttype_usbcontrolrequesttype_1221375020.md b/windows.devices.usb/usbcontrolrequesttype_usbcontrolrequesttype_1221375020.md index 498aa8a516..e258545475 100644 --- a/windows.devices.usb/usbcontrolrequesttype_usbcontrolrequesttype_1221375020.md +++ b/windows.devices.usb/usbcontrolrequesttype_usbcontrolrequesttype_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Usb.UsbControlRequestType.#ctor --api-type: winrt method ---- # Windows.Devices.Usb.UsbControlRequestType.UsbControlRequestType ## -description Creates a [UsbControlRequestType](usbcontrolrequesttype.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbControlRequestType.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbControlRequestType.UsbControlRequestType + +## -description +Creates a [UsbControlRequestType](usbcontrolrequesttype.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdescriptor.md b/windows.devices.usb/usbdescriptor.md index 64895d692f..4034bf2eca 100644 --- a/windows.devices.usb/usbdescriptor.md +++ b/windows.devices.usb/usbdescriptor.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.Usb.UsbDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbDescriptor ## -description Provides information about the type of descriptor, its size (in bytes), and gets the descriptor data. ## -remarks A USB device provides information about itself in data structures called USB descriptors. See section 9.5 of the Universal Serial Bus (USB) specification. ## -examples ## -see-also [USB descriptors](http://msdn.microsoft.com/library/9fdeebd3-f0b3-4530-b6cf-a844f96af1c2) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbDescriptor + +## -description +Provides information about the type of descriptor, its size (in bytes), and gets the descriptor data. + +## -remarks +A USB device provides information about itself in data structures called USB descriptors. See section 9.5 of the Universal Serial Bus (USB) specification. + +## -examples + +## -see-also +[USB descriptors](http://msdn.microsoft.com/library/9fdeebd3-f0b3-4530-b6cf-a844f96af1c2) \ No newline at end of file diff --git a/windows.devices.usb/usbdescriptor_descriptortype.md b/windows.devices.usb/usbdescriptor_descriptortype.md index 8264a0c089..a5d1166ffb 100644 --- a/windows.devices.usb/usbdescriptor_descriptortype.md +++ b/windows.devices.usb/usbdescriptor_descriptortype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDescriptor.DescriptorType --api-type: winrt property ---- # Windows.Devices.Usb.UsbDescriptor.DescriptorType ## -description Gets the type of descriptor. ## -property-value The type of descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDescriptor.DescriptorType +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDescriptor.DescriptorType + +## -description +Gets the type of descriptor. + +## -property-value +The type of descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdescriptor_length.md b/windows.devices.usb/usbdescriptor_length.md index d650670f32..e17d983d5e 100644 --- a/windows.devices.usb/usbdescriptor_length.md +++ b/windows.devices.usb/usbdescriptor_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDescriptor.Length --api-type: winrt property ---- # Windows.Devices.Usb.UsbDescriptor.Length ## -description Gets the length of the descriptor. ## -property-value The length of the descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDescriptor.Length +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDescriptor.Length + +## -description +Gets the length of the descriptor. + +## -property-value +The length of the descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdescriptor_readdescriptorbuffer_144625644.md b/windows.devices.usb/usbdescriptor_readdescriptorbuffer_144625644.md index ee5fd74c10..32918ff46a 100644 --- a/windows.devices.usb/usbdescriptor_readdescriptorbuffer_144625644.md +++ b/windows.devices.usb/usbdescriptor_readdescriptorbuffer_144625644.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDescriptor.ReadDescriptorBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDescriptor.ReadDescriptorBuffer ## -description Reads descriptor data in the caller-supplied buffer. ## -parameters ### -param buffer A caller-supplied buffer that receives descriptor data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDescriptor.ReadDescriptorBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDescriptor.ReadDescriptorBuffer + +## -description +Reads descriptor data in the caller-supplied buffer. + +## -parameters +### -param buffer +A caller-supplied buffer that receives descriptor data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevice.md b/windows.devices.usb/usbdevice.md index 1b5c773e4e..c433bc6878 100644 --- a/windows.devices.usb/usbdevice.md +++ b/windows.devices.usb/usbdevice.md @@ -1,3 +1,72 @@ ---- -api-id: T:Windows.Devices.Usb.UsbDevice --api-type: winrt class ---- # Windows.Devices.Usb.UsbDevice ## -description Represents a USB device. The object provides methods and properties that an app can use to find the device (in the system) with which the app wants to communicate, and sends IN and OUT control transfers to the device. ## -remarks Before getting a reference to the [UsbDevice](usbdevice.md) object, you must have one of these identifiers: + The vendor and product identifiers for the physical device. Those identifiers are part of the hardware ID string. You can obtain that string from the [Models](XREF:TODO:devinst.inf_models_section) section in the INF file. Alternatively, if WinUSB was loaded based on the compatible ID specified in the device descriptor, you can derive the identifiers from the **Hardware Ids** property in **Device Manager**. For example, if **Hardware Id** is "USB\VID_045E&PID_078E", vendor ID is "0x045E" and product Id is "0x078E". + The device interface GUID. You can obtain that GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***<Device Identifier>***\***<Instance Identifier>***\**Device Parameters** + The device's class, subclass, and protocol codes. You can obtain that information from the **CompatibleIds** registry entry, found under the **Device Parameters** key. To get the [UsbDevice](usbdevice.md) object: 1. Get the Advanced Query Syntax (AQS) string that contains search criteria for finding the device in the enumerated device collection. If you want to search by the vendor ID/product ID or the device interface GUID, call [GetDeviceSelector](usbdevice_getdeviceselector.md). If you want to search by the device class, call [GetDeviceClassSelector](usbdevice_getdeviceclassselector.md). Both calls retrieve formatted AQS strings. 1. Pass the retrieved string to [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). The call retrieves a [DeviceInformationCollection](../windows.devices.enumeration/deviceinformationcollection.md) object. 1. Loop through the collection. Each iteration gets a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object. 1. Get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. The string value is the device instance path. For example, "\\\\?\\USB#VID_045E&PID_078F#6&1b8ff026&0&5#{dee824ef-729b-4a0e-9c14-b7117d33a817}". 1. Call [FromIdAsync](usbdevice_fromidasync.md) by passing the device instance string and get the [UsbDevice](usbdevice.md) object. You can then use the [UsbDevice](usbdevice.md) object to perform other operations, such as sending a control transfer. When the app has finished using the [UsbDevice](usbdevice.md) object, the app must release it by calling [Close](usbdevice_close.md). ## -examples This example code shows how to get the [UsbDevice](usbdevice.md) object by specifying the vendor/product Id or the device interface GUID. ```csharp protected override async void OnLaunched1(LaunchActivatedEventArgs args) { UInt32 vid = 0x045E; UInt32 pid = 0x078F; string aqs = UsbDevice.GetDeviceSelector(vid, pid); var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(aqs, null); if (myDevices.Count == 0) { ShowError("Device not found!"); return; } UsbDevice device = await UsbDevice.FromIdAsync(myDevices[0].Id); // Send a control transfer. UsbSetupPacket initSetupPacket = new UsbSetupPacket() { Request = initRequest, RequestType = new UsbControlRequestType() { Recipient = UsbControlRecipient.DefaultInterface, ControlTransferType = UsbControlTransferType.Vendor } }; await device.SendOutControlTransferAsync(initSetupPacket); } ``` ## -see-also [IClosable](../windows.foundation/iclosable.md), [Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbDevice + +## -description +Represents a USB device. The object provides methods and properties that an app can use to find the device (in the system) with which the app wants to communicate, and sends IN and OUT control transfers to the device. + +## -remarks +Before getting a reference to the [UsbDevice](usbdevice.md) object, you must have one of these identifiers: ++ The vendor and product identifiers for the physical device. Those identifiers are part of the hardware ID string. You can obtain that string from the [Models](XREF:TODO:devinst.inf_models_section) section in the INF file. Alternatively, if WinUSB was loaded based on the compatible ID specified in the device descriptor, you can derive the identifiers from the **Hardware Ids** property in **Device Manager**. For example, if **Hardware Id** is "USB\VID_045E&PID_078E", vendor ID is "0x045E" and product Id is "0x078E". ++ The device interface GUID. You can obtain that GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***<Device Identifier>***\***<Instance Identifier>***\**Device Parameters** ++ The device's class, subclass, and protocol codes. You can obtain that information from the **CompatibleIds** registry entry, found under the **Device Parameters** key. + + +To get the [UsbDevice](usbdevice.md) object: +1. Get the Advanced Query Syntax (AQS) string that contains search criteria for finding the device in the enumerated device collection. If you want to search by the vendor ID/product ID or the device interface GUID, call [GetDeviceSelector](usbdevice_getdeviceselector.md). If you want to search by the device class, call [GetDeviceClassSelector](usbdevice_getdeviceclassselector.md). Both calls retrieve formatted AQS strings. +1. Pass the retrieved string to [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). The call retrieves a [DeviceInformationCollection](../windows.devices.enumeration/deviceinformationcollection.md) object. +1. Loop through the collection. Each iteration gets a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object. +1. Get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. The string value is the device instance path. For example, "\\\\?\\USB#VID_045E&PID_078F#6&1b8ff026&0&5#{dee824ef-729b-4a0e-9c14-b7117d33a817}". +1. Call [FromIdAsync](usbdevice_fromidasync.md) by passing the device instance string and get the [UsbDevice](usbdevice.md) object. + You can then use the [UsbDevice](usbdevice.md) object to perform other operations, such as sending a control transfer. When the app has finished using the [UsbDevice](usbdevice.md) object, the app must release it by calling [Close](usbdevice_close.md). + +## -examples +This example code shows how to get the [UsbDevice](usbdevice.md) object by specifying the vendor/product Id or the device interface GUID. + +```csharp +protected override async void OnLaunched1(LaunchActivatedEventArgs args) +{ + UInt32 vid = 0x045E; + UInt32 pid = 0x078F; + + string aqs = UsbDevice.GetDeviceSelector(vid, pid); + + var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(aqs, null); + + if (myDevices.Count == 0) + { + ShowError("Device not found!"); + return; + } + + UsbDevice device = await UsbDevice.FromIdAsync(myDevices[0].Id); + + // Send a control transfer. + + UsbSetupPacket initSetupPacket = new UsbSetupPacket() + { + Request = initRequest, + RequestType = new UsbControlRequestType() { + + Recipient = UsbControlRecipient.DefaultInterface, + + ControlTransferType = UsbControlTransferType.Vendor + } + }; + + await device.SendOutControlTransferAsync(initSetupPacket); + +} +``` + + + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Custom USB device sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620530) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_close_811482585.md b/windows.devices.usb/usbdevice_close_811482585.md index af0aff8a9a..0f7ad7a146 100644 --- a/windows.devices.usb/usbdevice_close_811482585.md +++ b/windows.devices.usb/usbdevice_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.Close --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.Close ## -description Releases the reference to the [UsbDevice](usbdevice.md) object that was previously obtained by calling [FromIdAsync](usbdevice_fromidasync.md). ## -remarks ## -examples ## -see-also [Fromidasync](usbdevice_fromidasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.Close + +## -description +Releases the reference to the [UsbDevice](usbdevice.md) object that was previously obtained by calling [FromIdAsync](usbdevice_fromidasync.md). + +## -remarks + +## -examples + +## -see-also +[Fromidasync](usbdevice_fromidasync.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_configuration.md b/windows.devices.usb/usbdevice_configuration.md index dc27f3d243..c943c3c4a4 100644 --- a/windows.devices.usb/usbdevice_configuration.md +++ b/windows.devices.usb/usbdevice_configuration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDevice.Configuration --api-type: winrt property ---- # Windows.Devices.Usb.UsbDevice.Configuration ## -description Gets an object that represents a USB configuration including all interfaces and their endpoints. ## -property-value A [UsbConfiguration](usbconfiguration.md) object that contains information about a USB configuration including the configuration descriptor and array of all USB interfaces in that configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDevice.Configuration +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDevice.Configuration + +## -description +Gets an object that represents a USB configuration including all interfaces and their endpoints. + +## -property-value +A [UsbConfiguration](usbconfiguration.md) object that contains information about a USB configuration including the configuration descriptor and array of all USB interfaces in that configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevice_defaultinterface.md b/windows.devices.usb/usbdevice_defaultinterface.md index 90ebc813a7..1ca36f7890 100644 --- a/windows.devices.usb/usbdevice_defaultinterface.md +++ b/windows.devices.usb/usbdevice_defaultinterface.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDevice.DefaultInterface --api-type: winrt property ---- # Windows.Devices.Usb.UsbDevice.DefaultInterface ## -description Gets the object that represents the default or the first interface in a USB configuration. ## -property-value A [UsbInterface](usbinterface.md) object that represents the default or the first interface in a USB configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDevice.DefaultInterface +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDevice.DefaultInterface + +## -description +Gets the object that represents the default or the first interface in a USB configuration. + +## -property-value +A [UsbInterface](usbinterface.md) object that represents the default or the first interface in a USB configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevice_devicedescriptor.md b/windows.devices.usb/usbdevice_devicedescriptor.md index e1af632795..47f661448f 100644 --- a/windows.devices.usb/usbdevice_devicedescriptor.md +++ b/windows.devices.usb/usbdevice_devicedescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDevice.DeviceDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbDevice.DeviceDescriptor ## -description Gets the object that represents the USB device descriptor. ## -property-value A [UsbDeviceDescriptor](usbdevicedescriptor.md) that represents the USB device descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDevice.DeviceDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDevice.DeviceDescriptor + +## -description +Gets the object that represents the USB device descriptor. + +## -property-value +A [UsbDeviceDescriptor](usbdevicedescriptor.md) that represents the USB device descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevice_fromidasync_1322863552.md b/windows.devices.usb/usbdevice_fromidasync_1322863552.md index 6784312448..c86a5f1cea 100644 --- a/windows.devices.usb/usbdevice_fromidasync_1322863552.md +++ b/windows.devices.usb/usbdevice_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.FromIdAsync ## -description Starts an asynchronous operation that creates a [UsbDevice](usbdevice.md) object. ## -parameters ### -param deviceId The device instance path of the device. To obtain that value, get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. ## -returns Returns an [IAsyncOperation(UsbDevice)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.FromIdAsync + +## -description +Starts an asynchronous operation that creates a [UsbDevice](usbdevice.md) object. + +## -parameters +### -param deviceId +The device instance path of the device. To obtain that value, get the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) property value. + +## -returns +Returns an [IAsyncOperation(UsbDevice)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevice_getdeviceclassselector_1975723348.md b/windows.devices.usb/usbdevice_getdeviceclassselector_1975723348.md index 8c47028460..191140f1d4 100644 --- a/windows.devices.usb/usbdevice_getdeviceclassselector_1975723348.md +++ b/windows.devices.usb/usbdevice_getdeviceclassselector_1975723348.md @@ -1,3 +1,62 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceClassSelector(Windows.Devices.Usb.UsbDeviceClass) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.GetDeviceClassSelector ## -description Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. ## -parameters ### -param usbClass A [UsbDeviceClass](usbdeviceclass.md) object for the device class specified by the app. ## -returns String formatted as an AQS query. ## -remarks You can search for a [UsbDevice](usbdevice.md) in the enumerated collection of devices by specifying class code, sub class code, or protocol code. To do this, 1. Create a [UsbDeviceClass](usbdeviceclass.md) object by specifying [ClassCode](usbdeviceclass_classcode.md), [SubclassCode](usbdeviceclass_subclasscode.md), and [ProtocolCode](usbdeviceclass_protocolcode.md) property values. Alternatively, you can call the constructor by specifying a particular [UsbDeviceClasses](usbdeviceclasses.md) property. 1. Call [GetDeviceClassSelector](usbdevice_getdeviceclassselector.md) and pass that new class. The call retrieves an AQS string. 1. Call [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) and pass the string to get the [UsbDevice](usbdevice.md) object. ## -examples ```csharp protected override async void OnLaunched(LaunchActivatedEventArgs args) { byte deviceClass = 0xf0; byte deviceSubclass = 0x01; var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync( UsbDevice.GetDeviceClassSelector( new UsbDeviceClass() { Class = deviceClass, Subclass = deviceSubclass })); UsbDevice device = null; foreach (var device in myDevices) { if (IsMyDevice(device)) { device = await UsbDevice.FromIdAsync(device.Id); } } if (device == null) { ShowError("Usb device not found"); return; } } ``` ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceClassSelector(Windows.Devices.Usb.UsbDeviceClass) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.GetDeviceClassSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that the app can pass to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. + +## -parameters +### -param usbClass +A [UsbDeviceClass](usbdeviceclass.md) object for the device class specified by the app. + +## -returns +String formatted as an AQS query. + +## -remarks +You can search for a [UsbDevice](usbdevice.md) in the enumerated collection of devices by specifying class code, sub class code, or protocol code. To do this, +1. Create a [UsbDeviceClass](usbdeviceclass.md) object by specifying [ClassCode](usbdeviceclass_classcode.md), [SubclassCode](usbdeviceclass_subclasscode.md), and [ProtocolCode](usbdeviceclass_protocolcode.md) property values. Alternatively, you can call the constructor by specifying a particular [UsbDeviceClasses](usbdeviceclasses.md) property. +1. Call [GetDeviceClassSelector](usbdevice_getdeviceclassselector.md) and pass that new class. The call retrieves an AQS string. +1. Call [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) and pass the string to get the [UsbDevice](usbdevice.md) object. + + +## -examples +```csharp +protected override async void OnLaunched(LaunchActivatedEventArgs args) +{ + byte deviceClass = 0xf0; + byte deviceSubclass = 0x01; + + var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync( + UsbDevice.GetDeviceClassSelector( + new UsbDeviceClass() { + Class = deviceClass, Subclass = deviceSubclass })); + + UsbDevice device = null; + + foreach (var device in myDevices) + { + if (IsMyDevice(device)) + { + device = await UsbDevice.FromIdAsync(device.Id); + } + } + + if (device == null) + { + ShowError("Usb device not found"); + return; + } + +} +``` + + + +## -see-also diff --git a/windows.devices.usb/usbdevice_getdeviceselector_1242207979.md b/windows.devices.usb/usbdevice_getdeviceselector_1242207979.md index e7b49186c6..384c2b1adc 100644 --- a/windows.devices.usb/usbdevice_getdeviceselector_1242207979.md +++ b/windows.devices.usb/usbdevice_getdeviceselector_1242207979.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceSelector(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string, based on vendor and product identifiers, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. ## -parameters ### -param vendorId Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. ### -param productId Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. ## -returns String formatted as an AQS query. ## -remarks ## -examples ## -see-also [GetDeviceSelector(UInt32, UInt32, Guid)](usbdevice_getdeviceselector_318985165.md), [GetDeviceSelector(Guid)](usbdevice_getdeviceselector_1740344150.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceSelector(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string, based on vendor and product identifiers, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. + +## -parameters +### -param vendorId +Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. + +### -param productId +Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. + +## -returns +String formatted as an AQS query. + +## -remarks + +## -examples + +## -see-also +[GetDeviceSelector(UInt32, UInt32, Guid)](usbdevice_getdeviceselector_318985165.md), [GetDeviceSelector(Guid)](usbdevice_getdeviceselector_1740344150.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_getdeviceselector_1740344150.md b/windows.devices.usb/usbdevice_getdeviceselector_1740344150.md index 88f37d2de4..7921e451e2 100644 --- a/windows.devices.usb/usbdevice_getdeviceselector_1740344150.md +++ b/windows.devices.usb/usbdevice_getdeviceselector_1740344150.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceSelector(System.Guid) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string, based on the device interface GUID identifier, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. ## -parameters ### -param winUsbInterfaceClass The device interface GUID exposed by the Winusb.sys driver. See the remarks section. ## -returns String formatted as an AQS query. ## -remarks You can obtain the device interface GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***<Device Identifier>***\***<Instance Identifier>***\**Device Parameters** ## -examples ## -see-also [GetDeviceSelector(UInt32, UInt32, Guid)](usbdevice_getdeviceselector_318985165.md), [GetDeviceSelector(UInt32, UInt32)](usbdevice_getdeviceselector_1242207979.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceSelector(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string, based on the device interface GUID identifier, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. + + + +## -parameters +### -param winUsbInterfaceClass +The device interface GUID exposed by the Winusb.sys driver. See the remarks section. + +## -returns +String formatted as an AQS query. + +## -remarks +You can obtain the device interface GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***<Device Identifier>***\***<Instance Identifier>***\**Device Parameters** + +## -examples + +## -see-also +[GetDeviceSelector(UInt32, UInt32, Guid)](usbdevice_getdeviceselector_318985165.md), [GetDeviceSelector(UInt32, UInt32)](usbdevice_getdeviceselector_1242207979.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_getdeviceselector_318985165.md b/windows.devices.usb/usbdevice_getdeviceselector_318985165.md index fca821a015..4ee4e2a409 100644 --- a/windows.devices.usb/usbdevice_getdeviceselector_318985165.md +++ b/windows.devices.usb/usbdevice_getdeviceselector_318985165.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceSelector(System.UInt32,System.UInt32,System.Guid) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.GetDeviceSelector ## -description Gets an Advanced Query Syntax (AQS) string, based on vendor, product, and device interface GUID identifiers, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. ## -parameters ### -param vendorId Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. ### -param productId Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. ### -param winUsbInterfaceClass The device interface GUID exposed by the Winusb.sys driver. See the remarks section. ## -returns String formatted as an AQS query. ## -remarks You can obtain the device interface GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***<Device Identifier>***\***<Instance Identifier>***\**Device Parameters** ## -examples ## -see-also [GetDeviceSelector(Guid)](usbdevice_getdeviceselector_1740344150.md), [GetDeviceSelector(UInt32, UInt32)](usbdevice_getdeviceselector_1242207979.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.GetDeviceSelector(System.UInt32,System.UInt32,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string, based on vendor, product, and device interface GUID identifiers, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) in order to find a specific type of USB device. + +## -parameters +### -param vendorId +Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. + +### -param productId +Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. + +### -param winUsbInterfaceClass +The device interface GUID exposed by the Winusb.sys driver. See the remarks section. + +## -returns +String formatted as an AQS query. + +## -remarks +You can obtain the device interface GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***<Device Identifier>***\***<Instance Identifier>***\**Device Parameters** + +## -examples + +## -see-also +[GetDeviceSelector(Guid)](usbdevice_getdeviceselector_1740344150.md), [GetDeviceSelector(UInt32, UInt32)](usbdevice_getdeviceselector_1242207979.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_sendcontrolintransferasync_1500240753.md b/windows.devices.usb/usbdevice_sendcontrolintransferasync_1500240753.md index 83fe09e81e..fd98d02437 100644 --- a/windows.devices.usb/usbdevice_sendcontrolintransferasync_1500240753.md +++ b/windows.devices.usb/usbdevice_sendcontrolintransferasync_1500240753.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync(Windows.Devices.Usb.UsbSetupPacket,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync ## -description Starts a USB control transfer to receive data from the default control endpoint of the device. ## -parameters ### -param setupPacket A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. ### -param buffer A caller-supplied buffer that contains transfer data. ## -returns Returns an [IAsyncOperation(IBuffer)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync(Windows.Devices.Usb.UsbSetupPacket,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync + +## -description +Starts a USB control transfer to receive data from the default control endpoint of the device. + +## -parameters +### -param setupPacket +A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. + +### -param buffer +A caller-supplied buffer that contains transfer data. + +## -returns +Returns an [IAsyncOperation(IBuffer)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevice_sendcontrolintransferasync_609557051.md b/windows.devices.usb/usbdevice_sendcontrolintransferasync_609557051.md index e603cdb6ba..f88af2ccb5 100644 --- a/windows.devices.usb/usbdevice_sendcontrolintransferasync_609557051.md +++ b/windows.devices.usb/usbdevice_sendcontrolintransferasync_609557051.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync(Windows.Devices.Usb.UsbSetupPacket) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync ## -description Starts a zero-length USB control transfer that reads from the default control endpoint of the device. ## -parameters ### -param setupPacket A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. ## -returns Returns an [IAsyncOperation(IBuffer)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. ## -remarks ## -examples ## -see-also [SendControlInTransferAsync(UsbSetupPacket, IBuffer)](usbdevice_sendcontrolintransferasync_1500240753.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync(Windows.Devices.Usb.UsbSetupPacket) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.SendControlInTransferAsync + +## -description +Starts a zero-length USB control transfer that reads from the default control endpoint of the device. + +## -parameters +### -param setupPacket +A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. + +## -returns +Returns an [IAsyncOperation(IBuffer)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. + +## -remarks + +## -examples + +## -see-also +[SendControlInTransferAsync(UsbSetupPacket, IBuffer)](usbdevice_sendcontrolintransferasync_1500240753.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_sendcontrolouttransferasync_2044496736.md b/windows.devices.usb/usbdevice_sendcontrolouttransferasync_2044496736.md index 13ad3fc89d..9f40fcb4ee 100644 --- a/windows.devices.usb/usbdevice_sendcontrolouttransferasync_2044496736.md +++ b/windows.devices.usb/usbdevice_sendcontrolouttransferasync_2044496736.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync(Windows.Devices.Usb.UsbSetupPacket) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync ## -description Starts a zero-length USB control transfer that writes to the default control endpoint of the device. ## -parameters ### -param setupPacket A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. ## -returns Returns an [IAsyncOperation(UInt32)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. ## -remarks ## -examples ## -see-also [SendControlOutTransferAsync(UsbSetupPacket, IBuffer)](usbdevice_sendcontrolouttransferasync_81938988.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync(Windows.Devices.Usb.UsbSetupPacket) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync + +## -description +Starts a zero-length USB control transfer that writes to the default control endpoint of the device. + +## -parameters +### -param setupPacket +A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. + +## -returns +Returns an [IAsyncOperation(UInt32)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. + +## -remarks + +## -examples + +## -see-also +[SendControlOutTransferAsync(UsbSetupPacket, IBuffer)](usbdevice_sendcontrolouttransferasync_81938988.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdevice_sendcontrolouttransferasync_81938988.md b/windows.devices.usb/usbdevice_sendcontrolouttransferasync_81938988.md index f153de7998..9459b53a51 100644 --- a/windows.devices.usb/usbdevice_sendcontrolouttransferasync_81938988.md +++ b/windows.devices.usb/usbdevice_sendcontrolouttransferasync_81938988.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync(Windows.Devices.Usb.UsbSetupPacket,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync ## -description Starts a USB control transfer to send data to the default control endpoint of the device. ## -parameters ### -param setupPacket A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. ### -param buffer A caller-supplied buffer that contains the transfer data. ## -returns Returns an [IAsyncOperation(UInt32)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. ## -remarks ## -examples ## -see-also [SendControlOutTransferAsync(UsbSetupPacket)](usbdevice_sendcontrolouttransferasync_2044496736.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync(Windows.Devices.Usb.UsbSetupPacket,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDevice.SendControlOutTransferAsync + +## -description +Starts a USB control transfer to send data to the default control endpoint of the device. + +## -parameters +### -param setupPacket +A [UsbSetupPacket](usbsetuppacket.md) object that contains the setup packet for the control transfer. + +### -param buffer +A caller-supplied buffer that contains the transfer data. + +## -returns +Returns an [IAsyncOperation(UInt32)](../windows.foundation/iasyncoperation_1.md) object that returns the results of the operation. + +## -remarks + +## -examples + +## -see-also +[SendControlOutTransferAsync(UsbSetupPacket)](usbdevice_sendcontrolouttransferasync_2044496736.md) \ No newline at end of file diff --git a/windows.devices.usb/usbdeviceclass.md b/windows.devices.usb/usbdeviceclass.md index 384aa574a4..1d1282c22d 100644 --- a/windows.devices.usb/usbdeviceclass.md +++ b/windows.devices.usb/usbdeviceclass.md @@ -1,3 +1,40 @@ ---- -api-id: T:Windows.Devices.Usb.UsbDeviceClass --api-type: winrt class ---- # Windows.Devices.Usb.UsbDeviceClass ## -description Provides a way for the app to get an Advanced Query Syntax (AQS) string by specifying the class code, subclass code, and the protocol code defined by the device. The properties in this class are passed in the call to [GetDeviceClassSelector](usbdevice_getdeviceclassselector.md). ## -remarks You can create a [UsbDeviceClass](usbdeviceclass.md) object by specifying any one of the following sets of properties: + Class code. + Class and subclass codes. + Class, subclass, and protocol codes. This code example shows how to specify the device class and subclass codes to obtain a [UsbDevice](usbdevice.md) object. ```csharp byte deviceClass = 0xf0; byte deviceSubclass = 0x01; var myDevices = await Windows.Devices.Enumeration.DeviceInformation.FindAllAsync( UsbDevice.GetDeviceClassSelector( new UsbDeviceClass() { Class = deviceClass, Subclass = deviceSubclass })); ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbDeviceClass +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbDeviceClass + +## -description +Provides a way for the app to get an Advanced Query Syntax (AQS) string by specifying the class code, subclass code, and the protocol code defined by the device. The properties in this class are passed in the call to [GetDeviceClassSelector](usbdevice_getdeviceclassselector.md). + +## -remarks +You can create a [UsbDeviceClass](usbdeviceclass.md) object by specifying any one of the following sets of properties: ++ Class code. ++ Class and subclass codes. ++ Class, subclass, and protocol codes. + + +This code example shows how to specify the device class and subclass codes to obtain a [UsbDevice](usbdevice.md) object. + +```csharp + byte deviceClass = 0xf0; + byte deviceSubclass = 0x01; + + var myDevices = await + Windows.Devices.Enumeration.DeviceInformation.FindAllAsync( + UsbDevice.GetDeviceClassSelector( + new UsbDeviceClass() { + Class = deviceClass, Subclass = deviceSubclass })); + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdeviceclass_classcode.md b/windows.devices.usb/usbdeviceclass_classcode.md index 6556393e8d..175990bac2 100644 --- a/windows.devices.usb/usbdeviceclass_classcode.md +++ b/windows.devices.usb/usbdeviceclass_classcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceClass.ClassCode --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceClass.ClassCode ## -description Gets or sets the class code of the device. ## -property-value The device class code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceClass.ClassCode +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceClass.ClassCode + +## -description +Gets or sets the class code of the device. + +## -property-value +The device class code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdeviceclass_protocolcode.md b/windows.devices.usb/usbdeviceclass_protocolcode.md index a59e00c698..04395181f0 100644 --- a/windows.devices.usb/usbdeviceclass_protocolcode.md +++ b/windows.devices.usb/usbdeviceclass_protocolcode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceClass.ProtocolCode --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceClass.ProtocolCode ## -description Gets or sets the protocol code of the device. ## -property-value The protocol code of the device. ## -remarks You can set the [ProtocolCode](usbdeviceclass_protocolcode.md) value only when [SubclassCode](usbdeviceclass_subclasscode.md) value is set to a non-null value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceClass.ProtocolCode +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceClass.ProtocolCode + +## -description +Gets or sets the protocol code of the device. + +## -property-value +The protocol code of the device. + +## -remarks +You can set the [ProtocolCode](usbdeviceclass_protocolcode.md) value only when [SubclassCode](usbdeviceclass_subclasscode.md) value is set to a non-null value. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdeviceclass_subclasscode.md b/windows.devices.usb/usbdeviceclass_subclasscode.md index df98ff5e0d..4fe697acdb 100644 --- a/windows.devices.usb/usbdeviceclass_subclasscode.md +++ b/windows.devices.usb/usbdeviceclass_subclasscode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceClass.SubclassCode --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceClass.SubclassCode ## -description Gets or sets the subclass code of the device. ## -property-value The subclass code of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceClass.SubclassCode +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceClass.SubclassCode + +## -description +Gets or sets the subclass code of the device. + +## -property-value +The subclass code of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdeviceclass_usbdeviceclass_1221375020.md b/windows.devices.usb/usbdeviceclass_usbdeviceclass_1221375020.md index 819a88776b..0fe10f9e1d 100644 --- a/windows.devices.usb/usbdeviceclass_usbdeviceclass_1221375020.md +++ b/windows.devices.usb/usbdeviceclass_usbdeviceclass_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.Usb.UsbDeviceClass.#ctor --api-type: winrt method ---- # Windows.Devices.Usb.UsbDeviceClass.UsbDeviceClass ## -description Creates a [UsbDeviceClass](usbdeviceclass.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbDeviceClass.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbDeviceClass.UsbDeviceClass + +## -description +Creates a [UsbDeviceClass](usbdeviceclass.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor.md b/windows.devices.usb/usbdevicedescriptor.md index 7209b1580b..3c4f05189e 100644 --- a/windows.devices.usb/usbdevicedescriptor.md +++ b/windows.devices.usb/usbdevicedescriptor.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Usb.UsbDeviceDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbDeviceDescriptor ## -description Derives information from the USB device descriptor of the device. For an explanation of the device descriptor, see Table 9.8 in the Universal Serial Bus Specification. ## -remarks The [UsbDeviceDescriptor](usbdevicedescriptor.md) class does not include manufacturer, product, and serial number strings that are included in a device-defined descriptor. You can obtain those strings by using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. For information about a USB device descriptor, see the top portion of this topic: [USB device descriptors](http://msdn.microsoft.com/library/ebec470d-5602-44cb-93a4-49f07ee2f013). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbDeviceDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor + +## -description +Derives information from the USB device descriptor of the device. For an explanation of the device descriptor, see Table 9.8 in the Universal Serial Bus Specification. + +## -remarks +The [UsbDeviceDescriptor](usbdevicedescriptor.md) class does not include manufacturer, product, and serial number strings that are included in a device-defined descriptor. You can obtain those strings by using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. For information about a USB device descriptor, see the top portion of this topic: [USB device descriptors](http://msdn.microsoft.com/library/ebec470d-5602-44cb-93a4-49f07ee2f013). + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor_bcddevicerevision.md b/windows.devices.usb/usbdevicedescriptor_bcddevicerevision.md index e6bb11a8df..61117421f9 100644 --- a/windows.devices.usb/usbdevicedescriptor_bcddevicerevision.md +++ b/windows.devices.usb/usbdevicedescriptor_bcddevicerevision.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.BcdDeviceRevision --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceDescriptor.BcdDeviceRevision ## -description Gets the **bcdDeviceRevision** field of the USB device descriptor. The value indicates the revision number defined by the device and is a binary-coded decimal number. ## -property-value The revision number defined by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.BcdDeviceRevision +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor.BcdDeviceRevision + +## -description +Gets the **bcdDeviceRevision** field of the USB device descriptor. The value indicates the revision number defined by the device and is a binary-coded decimal number. + +## -property-value +The revision number defined by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor_bcdusb.md b/windows.devices.usb/usbdevicedescriptor_bcdusb.md index 9e4615145a..7a4fa2a8fb 100644 --- a/windows.devices.usb/usbdevicedescriptor_bcdusb.md +++ b/windows.devices.usb/usbdevicedescriptor_bcdusb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.BcdUsb --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceDescriptor.BcdUsb ## -description Gets the **bcdUSB** field of the USB device descriptor. The value indicates the version of the USB specification to which the device conforms. ## -property-value The version of the USB specification to which the device conforms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.BcdUsb +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor.BcdUsb + +## -description +Gets the **bcdUSB** field of the USB device descriptor. The value indicates the version of the USB specification to which the device conforms. + +## -property-value +The version of the USB specification to which the device conforms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor_maxpacketsize0.md b/windows.devices.usb/usbdevicedescriptor_maxpacketsize0.md index b0cca1ffaa..3b4ec958ad 100644 --- a/windows.devices.usb/usbdevicedescriptor_maxpacketsize0.md +++ b/windows.devices.usb/usbdevicedescriptor_maxpacketsize0.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.MaxPacketSize0 --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceDescriptor.MaxPacketSize0 ## -description Gets the **bMaxPacketSize0** field of the USB device descriptor. The value indicates the maximum packet size, in bytes, for endpoint zero of the device. This value can be 8, 16, 32, or 64. ## -property-value The maximum packet size, in bytes, for endpoint zero of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.MaxPacketSize0 +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor.MaxPacketSize0 + +## -description +Gets the **bMaxPacketSize0** field of the USB device descriptor. The value indicates the maximum packet size, in bytes, for endpoint zero of the device. This value can be 8, 16, 32, or 64. + +## -property-value +The maximum packet size, in bytes, for endpoint zero of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor_numberofconfigurations.md b/windows.devices.usb/usbdevicedescriptor_numberofconfigurations.md index 1313cd3ba9..6df3ed89e8 100644 --- a/windows.devices.usb/usbdevicedescriptor_numberofconfigurations.md +++ b/windows.devices.usb/usbdevicedescriptor_numberofconfigurations.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.NumberOfConfigurations --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceDescriptor.NumberOfConfigurations ## -description Gets the **bNumConfigurations** field of the USB device descriptor. The value indicates the total count of USB configurations supported by the device. ## -property-value A number that indicates the total count of USB configurations supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.NumberOfConfigurations +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor.NumberOfConfigurations + +## -description +Gets the **bNumConfigurations** field of the USB device descriptor. The value indicates the total count of USB configurations supported by the device. + +## -property-value +A number that indicates the total count of USB configurations supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor_productid.md b/windows.devices.usb/usbdevicedescriptor_productid.md index f794ac3ee8..2261f92d9a 100644 --- a/windows.devices.usb/usbdevicedescriptor_productid.md +++ b/windows.devices.usb/usbdevicedescriptor_productid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.ProductId --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceDescriptor.ProductId ## -description Gets the **idProduct** field of the USB device descriptor. This value indicates the device-specific product identifier and is assigned by the manufacturer. ## -property-value The device-defined product identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.ProductId +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor.ProductId + +## -description +Gets the **idProduct** field of the USB device descriptor. This value indicates the device-specific product identifier and is assigned by the manufacturer. + +## -property-value +The device-defined product identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbdevicedescriptor_vendorid.md b/windows.devices.usb/usbdevicedescriptor_vendorid.md index 373ab435f2..6c68beda42 100644 --- a/windows.devices.usb/usbdevicedescriptor_vendorid.md +++ b/windows.devices.usb/usbdevicedescriptor_vendorid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.VendorId --api-type: winrt property ---- # Windows.Devices.Usb.UsbDeviceDescriptor.VendorId ## -description Gets the **idVendor** field of the USB device descriptor. The value indicates the vendor identifier for the device as assigned by the USB specification committee. ## -property-value The vendor identifier for the device as assigned by the USB specification committee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbDeviceDescriptor.VendorId +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbDeviceDescriptor.VendorId + +## -description +Gets the **idVendor** field of the USB device descriptor. The value indicates the vendor identifier for the device as assigned by the USB specification committee. + +## -property-value +The vendor identifier for the device as assigned by the USB specification committee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor.md b/windows.devices.usb/usbendpointdescriptor.md index e939c02c8d..4ad324ef95 100644 --- a/windows.devices.usb/usbendpointdescriptor.md +++ b/windows.devices.usb/usbendpointdescriptor.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Usb.UsbEndpointDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbEndpointDescriptor ## -description Derives information from the USB endpoint descriptor of the endpoint, such as type, direction, and endpoint number. This object also gets the specific endpoint descriptors based on the type of endpoint. For an explanation of an endpoint descriptor, see Section 9.6.5 in the Universal Serial Bus Specification: + Table 9.18 in the Universal Serial Bus 3.0 Specification + Table 9.13 in the Universal Serial Bus Specification (version 2.0) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbEndpointDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor + +## -description +Derives information from the USB endpoint descriptor of the endpoint, such as type, direction, and endpoint number. This object also gets the specific endpoint descriptors based on the type of endpoint. For an explanation of an endpoint descriptor, see Section 9.6.5 in the Universal Serial Bus Specification: + + ++ Table 9.18 in the Universal Serial Bus 3.0 Specification ++ Table 9.13 in the Universal Serial Bus Specification (version 2.0) + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_asbulkinendpointdescriptor.md b/windows.devices.usb/usbendpointdescriptor_asbulkinendpointdescriptor.md index afeaabd765..e7b11f3859 100644 --- a/windows.devices.usb/usbendpointdescriptor_asbulkinendpointdescriptor.md +++ b/windows.devices.usb/usbendpointdescriptor_asbulkinendpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkInEndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkInEndpointDescriptor ## -description Gets an object that represents the endpoint descriptor for the USB bulk IN endpoint. ## -property-value A [UsbBulkInEndpointDescriptor](usbbulkinendpointdescriptor.md) object that describes the USB bulk IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkInEndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkInEndpointDescriptor + +## -description +Gets an object that represents the endpoint descriptor for the USB bulk IN endpoint. + +## -property-value +A [UsbBulkInEndpointDescriptor](usbbulkinendpointdescriptor.md) object that describes the USB bulk IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_asbulkoutendpointdescriptor.md b/windows.devices.usb/usbendpointdescriptor_asbulkoutendpointdescriptor.md index 7f5d980503..6f6ff40f0b 100644 --- a/windows.devices.usb/usbendpointdescriptor_asbulkoutendpointdescriptor.md +++ b/windows.devices.usb/usbendpointdescriptor_asbulkoutendpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkOutEndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkOutEndpointDescriptor ## -description Gets an object that represents the endpoint descriptor for the USB bulk OUT endpoint. ## -property-value A [UsbBulkOutEndpointDescriptor](usbbulkoutendpointdescriptor.md) that describes the USB bulk OUT endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkOutEndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.AsBulkOutEndpointDescriptor + +## -description +Gets an object that represents the endpoint descriptor for the USB bulk OUT endpoint. + +## -property-value +A [UsbBulkOutEndpointDescriptor](usbbulkoutendpointdescriptor.md) that describes the USB bulk OUT endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_asinterruptinendpointdescriptor.md b/windows.devices.usb/usbendpointdescriptor_asinterruptinendpointdescriptor.md index 00f707b289..c6d2224c37 100644 --- a/windows.devices.usb/usbendpointdescriptor_asinterruptinendpointdescriptor.md +++ b/windows.devices.usb/usbendpointdescriptor_asinterruptinendpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptInEndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptInEndpointDescriptor ## -description Gets an object that represents the endpoint descriptor for the USB interrupt IN endpoint. ## -property-value An [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) that describes the USB interrupt IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptInEndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptInEndpointDescriptor + +## -description +Gets an object that represents the endpoint descriptor for the USB interrupt IN endpoint. + +## -property-value +An [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) that describes the USB interrupt IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_asinterruptoutendpointdescriptor.md b/windows.devices.usb/usbendpointdescriptor_asinterruptoutendpointdescriptor.md index 355d660751..2615fa806c 100644 --- a/windows.devices.usb/usbendpointdescriptor_asinterruptoutendpointdescriptor.md +++ b/windows.devices.usb/usbendpointdescriptor_asinterruptoutendpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptOutEndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptOutEndpointDescriptor ## -description Gets an object that represents the endpoint descriptor for the USB interrupt OUT endpoint. ## -property-value An [UsbInterruptOutEndpointDescriptor](usbinterruptoutendpointdescriptor.md) object that describes the interrupt OUT endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptOutEndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.AsInterruptOutEndpointDescriptor + +## -description +Gets an object that represents the endpoint descriptor for the USB interrupt OUT endpoint. + +## -property-value +An [UsbInterruptOutEndpointDescriptor](usbinterruptoutendpointdescriptor.md) object that describes the interrupt OUT endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_direction.md b/windows.devices.usb/usbendpointdescriptor_direction.md index 02d890eada..f214c1ba81 100644 --- a/windows.devices.usb/usbendpointdescriptor_direction.md +++ b/windows.devices.usb/usbendpointdescriptor_direction.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.Direction --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.Direction ## -description Gets the direction of the USB endpoint. ## -property-value A [UsbTransferDirection](usbtransferdirection.md) value that indicates the direction of the endpoint. This value is Bit 7 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.Direction +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.Direction + +## -description +Gets the direction of the USB endpoint. + +## -property-value +A [UsbTransferDirection](usbtransferdirection.md) value that indicates the direction of the endpoint. This value is Bit 7 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_endpointnumber.md b/windows.devices.usb/usbendpointdescriptor_endpointnumber.md index 1dd25fdbbe..afa98687d6 100644 --- a/windows.devices.usb/usbendpointdescriptor_endpointnumber.md +++ b/windows.devices.usb/usbendpointdescriptor_endpointnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.EndpointNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.EndpointNumber ## -description Gets the USB endpoint number. ## -property-value The USB endpoint number. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.EndpointNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.EndpointNumber + +## -description +Gets the USB endpoint number. + +## -property-value +The USB endpoint number. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_endpointtype.md b/windows.devices.usb/usbendpointdescriptor_endpointtype.md index 20749e685b..b9d2676bf9 100644 --- a/windows.devices.usb/usbendpointdescriptor_endpointtype.md +++ b/windows.devices.usb/usbendpointdescriptor_endpointtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.EndpointType --api-type: winrt property ---- # Windows.Devices.Usb.UsbEndpointDescriptor.EndpointType ## -description Gets the type of USB endpoint. ## -property-value A [UsbEndpointType](usbendpointtype.md) constant that indicates the type of USB endpoint. This value is Bit 1...0 of the **bmAttributes** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbEndpointDescriptor.EndpointType +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.EndpointType + +## -description +Gets the type of USB endpoint. + +## -property-value +A [UsbEndpointType](usbendpointtype.md) constant that indicates the type of USB endpoint. This value is Bit 1...0 of the **bmAttributes** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_parse_1098943634.md b/windows.devices.usb/usbendpointdescriptor_parse_1098943634.md index 7d44b28ac2..ddd79a32d8 100644 --- a/windows.devices.usb/usbendpointdescriptor_parse_1098943634.md +++ b/windows.devices.usb/usbendpointdescriptor_parse_1098943634.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Usb.UsbEndpointDescriptor.Parse(Windows.Devices.Usb.UsbDescriptor) --api-type: winrt method ---- # Windows.Devices.Usb.UsbEndpointDescriptor.Parse ## -description Parses the specified USB descriptor and returns the USB endpoint descriptor in a [UsbEndpointDescriptor](usbendpointdescriptor.md) object. ## -parameters ### -param descriptor A [UsbDescriptor](usbdescriptor.md) object that contains the USB endpoint descriptor. ## -returns A [UsbEndpointDescriptor](usbendpointdescriptor.md) object that contains the USB endpoint descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbEndpointDescriptor.Parse(Windows.Devices.Usb.UsbDescriptor) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.Parse + +## -description +Parses the specified USB descriptor and returns the USB endpoint descriptor in a [UsbEndpointDescriptor](usbendpointdescriptor.md) object. + +## -parameters +### -param descriptor +A [UsbDescriptor](usbdescriptor.md) object that contains the USB endpoint descriptor. + +## -returns +A [UsbEndpointDescriptor](usbendpointdescriptor.md) object that contains the USB endpoint descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbendpointdescriptor_tryparse_680735096.md b/windows.devices.usb/usbendpointdescriptor_tryparse_680735096.md index 33a02ce4c6..209ccb06b8 100644 --- a/windows.devices.usb/usbendpointdescriptor_tryparse_680735096.md +++ b/windows.devices.usb/usbendpointdescriptor_tryparse_680735096.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Usb.UsbEndpointDescriptor.TryParse(Windows.Devices.Usb.UsbDescriptor,Windows.Devices.Usb.UsbEndpointDescriptor@) --api-type: winrt method ---- # Windows.Devices.Usb.UsbEndpointDescriptor.TryParse ## -description Retrieves the USB endpoint descriptor in a [UsbEndpointDescriptor](usbendpointdescriptor.md) object that is contained in a [UsbDescriptor](usbdescriptor.md) object. ## -parameters ### -param descriptor The [UsbDescriptor](usbdescriptor.md) object to parse. ### -param parsed Receives a [UsbEndpointDescriptor](usbendpointdescriptor.md) object. ## -returns True, if the specified [UsbDescriptor](usbdescriptor.md) object is a USB endpoint descriptor. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbEndpointDescriptor.TryParse(Windows.Devices.Usb.UsbDescriptor,Windows.Devices.Usb.UsbEndpointDescriptor@) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbEndpointDescriptor.TryParse + +## -description +Retrieves the USB endpoint descriptor in a [UsbEndpointDescriptor](usbendpointdescriptor.md) object that is contained in a [UsbDescriptor](usbdescriptor.md) object. + +## -parameters +### -param descriptor +The [UsbDescriptor](usbdescriptor.md) object to parse. + +### -param parsed +Receives a [UsbEndpointDescriptor](usbendpointdescriptor.md) object. + +## -returns +True, if the specified [UsbDescriptor](usbdescriptor.md) object is a USB endpoint descriptor. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface.md b/windows.devices.usb/usbinterface.md index 64a8d1ac00..b18abe34e6 100644 --- a/windows.devices.usb/usbinterface.md +++ b/windows.devices.usb/usbinterface.md @@ -1,3 +1,111 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterface --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterface ## -description Provides information about the USB interface including its endpoints, the number of alternate settings the interface supports, and gets the entire descriptor set for those settings. It also obtains pipes associated with the endpoints that the interface supports. ## -remarks ## -examples This code example shows how to parse descriptors and get pipe objects. The example assumes that the app has previously obtained the [UsbDevice](usbdevice.md) object. ```csharp using Windows.Devices.Usb; using Windows.Storage.Streams; protected override async void OnLaunched(LaunchActivatedEventArgs args) { UsbDevice device; UInt32 readLen = 8; // Get the UsbDevice object. Not shown. ... UsbInterface myInterface = null; // // Need to find this descriptor after an interface descriptor: // // ===>Class-Specific Video Control Interface Header Descriptor<=== // bLength: 0x0D // bDescriptorType: 0x24 // bDescriptorSubtype:0x01 // bcdVDC: 0x0100 // wTotalLength: 0x00D9 -> Validated // dwClockFreq: 0x02DC6C00 = (48000000) Hz // bInCollection: 0x01 // baInterfaceNr[1]: 0x01 // USB Video Class device: spec version 1.0 // foreach (var interf in device.Configuration.UsbInterfaces) { foreach (var setting in interf.InterfaceSettings) { var descriptors = setting.Descriptors; // First descriptor in the setting must be the interface descriptor if (descriptors.Count >= 2 && UsbInterfaceDescriptor.TryParse(descriptors[0], null) == true && descriptors[1].Length == 0x0D && descriptors[1].DescriptorType == 0x24) { Windows.Storage.Streams.Buffer buffer = new Windows.Storage.Streams.Buffer(readLen); descriptors[1].readDescriptorBuffer(buffer); Windows.Storage.Streams.DataReader reader = Windows.Storage.Streams.DataReader.FromBuffer(buffer); reader.ReadByte(); // bLength reader.ReadByte(); // bDescriptorType byte bDescriptorSubType = reader.ReadByte(); if (bDescriptorSubType == 0x01) { // This is our interface. myInterface = interf; ushort bcdVDC = reader.ReadUInt16(); ushort wTotalLength = reader.ReadUInt16(); byte lsb = reader.ReadByte(); uint dwClockFreq = (reader.ReadUInt16() << 8) + lsb; byte bInCollection = reader.ReadByte(); byte baInterfaceNr1 = reader.ReadByte(); await setting.SelectSettingAsync(); } break; } } if (myInterface != null) { break; } } if (myInterface == null) { ShowError("Video Control Interface descriptor not found"); return; } // Pipes are now available to communicate with endpoints UsbInterruptInPipe interruptIn = myInterface.InterruptInPipes[0]; UsbBulkOutPipe bulkOut = myInterface.BulkOutPipes[0]; } ``` ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterface +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterface + +## -description +Provides information about the USB interface including its endpoints, the number of alternate settings the interface supports, and gets the entire descriptor set for those settings. It also obtains pipes associated with the endpoints that the interface supports. + +## -remarks + +## -examples +This code example shows how to parse descriptors and get pipe objects. The example assumes that the app has previously obtained the [UsbDevice](usbdevice.md) object. + +```csharp +using Windows.Devices.Usb; +using Windows.Storage.Streams; + +protected override async void OnLaunched(LaunchActivatedEventArgs args) +{ + + UsbDevice device; + UInt32 readLen = 8; + + // Get the UsbDevice object. Not shown. + + ... + + UsbInterface myInterface = null; + + // + // Need to find this descriptor after an interface descriptor: + // + // ===>Class-Specific Video Control Interface Header Descriptor<=== + // bLength: 0x0D + // bDescriptorType: 0x24 + // bDescriptorSubtype:0x01 + // bcdVDC: 0x0100 + // wTotalLength: 0x00D9 -> Validated + // dwClockFreq: 0x02DC6C00 = (48000000) Hz + // bInCollection: 0x01 + // baInterfaceNr[1]: 0x01 + // USB Video Class device: spec version 1.0 + // + foreach (var interf in device.Configuration.UsbInterfaces) + { + foreach (var setting in interf.InterfaceSettings) + { + var descriptors = setting.Descriptors; + + // First descriptor in the setting must be the interface descriptor + if (descriptors.Count >= 2 && + UsbInterfaceDescriptor.TryParse(descriptors[0], null) == + true && + descriptors[1].Length == 0x0D && + descriptors[1].DescriptorType == 0x24) + { + Windows.Storage.Streams.Buffer buffer = new Windows.Storage.Streams.Buffer(readLen); + descriptors[1].readDescriptorBuffer(buffer); + Windows.Storage.Streams.DataReader reader = Windows.Storage.Streams.DataReader.FromBuffer(buffer); + + reader.ReadByte(); // bLength + reader.ReadByte(); // bDescriptorType + byte bDescriptorSubType = reader.ReadByte(); + + if (bDescriptorSubType == 0x01) + { + // This is our interface. + myInterface = interf; + ushort bcdVDC = reader.ReadUInt16(); + ushort wTotalLength = reader.ReadUInt16(); + byte lsb = reader.ReadByte(); + uint dwClockFreq = (reader.ReadUInt16() << 8) + lsb; + byte bInCollection = reader.ReadByte(); + byte baInterfaceNr1 = reader.ReadByte(); + + await setting.SelectSettingAsync(); + } + break; + } + } + + if (myInterface != null) + { + break; + } + } + + if (myInterface == null) + { + ShowError("Video Control Interface descriptor not found"); + return; + } + + // Pipes are now available to communicate with endpoints + + UsbInterruptInPipe interruptIn = myInterface.InterruptInPipes[0]; + UsbBulkOutPipe bulkOut = myInterface.BulkOutPipes[0]; + +} + +``` + + + +## -see-also diff --git a/windows.devices.usb/usbinterface_bulkinpipes.md b/windows.devices.usb/usbinterface_bulkinpipes.md index 02fb11f584..ba26f22cab 100644 --- a/windows.devices.usb/usbinterface_bulkinpipes.md +++ b/windows.devices.usb/usbinterface_bulkinpipes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.BulkInPipes --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.BulkInPipes ## -description Gets an array of objects that represent pipes that the host opened to communicate with bulk IN endpoints defined in the current setting of the USB interface setting. ## -property-value An array of [UsbBulkInPipe](usbbulkinpipe.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.BulkInPipes +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.BulkInPipes + +## -description +Gets an array of objects that represent pipes that the host opened to communicate with bulk IN endpoints defined in the current setting of the USB interface setting. + +## -property-value +An array of [UsbBulkInPipe](usbbulkinpipe.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface_bulkoutpipes.md b/windows.devices.usb/usbinterface_bulkoutpipes.md index d19c71cf4f..aee20ae8f0 100644 --- a/windows.devices.usb/usbinterface_bulkoutpipes.md +++ b/windows.devices.usb/usbinterface_bulkoutpipes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.BulkOutPipes --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.BulkOutPipes ## -description Gets an array of objects that represent pipes that the host opened to communicate with bulk OUT endpoints defined in the current setting of the USB interface. ## -property-value An array of [UsbBulkOutPipe](usbbulkoutpipe.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.BulkOutPipes +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.BulkOutPipes + +## -description +Gets an array of objects that represent pipes that the host opened to communicate with bulk OUT endpoints defined in the current setting of the USB interface. + +## -property-value +An array of [UsbBulkOutPipe](usbbulkoutpipe.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface_descriptors.md b/windows.devices.usb/usbinterface_descriptors.md index 87d53ab677..b7a038a1a8 100644 --- a/windows.devices.usb/usbinterface_descriptors.md +++ b/windows.devices.usb/usbinterface_descriptors.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.Descriptors --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.Descriptors ## -description Gets an array of objects that represent descriptors for all alternate settings that are part of this USB interface. ## -property-value An array of [UsbDescriptor](usbdescriptor.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.Descriptors +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.Descriptors + +## -description +Gets an array of objects that represent descriptors for all alternate settings that are part of this USB interface. + +## -property-value +An array of [UsbDescriptor](usbdescriptor.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface_interfacenumber.md b/windows.devices.usb/usbinterface_interfacenumber.md index f2de412651..e2ba141f6c 100644 --- a/windows.devices.usb/usbinterface_interfacenumber.md +++ b/windows.devices.usb/usbinterface_interfacenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.InterfaceNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.InterfaceNumber ## -description Gets the interface number that identifies the USB interface. This value is the **bInterfaceNumber** field of a standard USB interface descriptor. ## -property-value The interface number that identifies the USB interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.InterfaceNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.InterfaceNumber + +## -description +Gets the interface number that identifies the USB interface. This value is the **bInterfaceNumber** field of a standard USB interface descriptor. + +## -property-value +The interface number that identifies the USB interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface_interfacesettings.md b/windows.devices.usb/usbinterface_interfacesettings.md index 55a059df32..067d967c44 100644 --- a/windows.devices.usb/usbinterface_interfacesettings.md +++ b/windows.devices.usb/usbinterface_interfacesettings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.InterfaceSettings --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.InterfaceSettings ## -description Gets an array of objects that represent alternate settings defined for the USB interface. ## -property-value An array of [UsbInterfaceSetting](usbinterfacesetting.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.InterfaceSettings +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.InterfaceSettings + +## -description +Gets an array of objects that represent alternate settings defined for the USB interface. + +## -property-value +An array of [UsbInterfaceSetting](usbinterfacesetting.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface_interruptinpipes.md b/windows.devices.usb/usbinterface_interruptinpipes.md index 0cb797fc41..967278c66d 100644 --- a/windows.devices.usb/usbinterface_interruptinpipes.md +++ b/windows.devices.usb/usbinterface_interruptinpipes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.InterruptInPipes --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.InterruptInPipes ## -description Gets an array of objects that represent pipes that the host opened to communicate with interrupt IN endpoints defined in the current setting of the USB interface. ## -property-value An array of [UsbInterruptInPipe](usbinterruptinpipe.md) objects. The objects are in the same order as they are defined in the interface descriptor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.InterruptInPipes +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.InterruptInPipes + +## -description +Gets an array of objects that represent pipes that the host opened to communicate with interrupt IN endpoints defined in the current setting of the USB interface. + +## -property-value +An array of [UsbInterruptInPipe](usbinterruptinpipe.md) objects. The objects are in the same order as they are defined in the interface descriptor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterface_interruptoutpipes.md b/windows.devices.usb/usbinterface_interruptoutpipes.md index 595343dbb6..16be3ae51a 100644 --- a/windows.devices.usb/usbinterface_interruptoutpipes.md +++ b/windows.devices.usb/usbinterface_interruptoutpipes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterface.InterruptOutPipes --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterface.InterruptOutPipes ## -description Gets an array of objects that represent pipes that the host opened to communicate with interrupt OUT endpoints defined in the current setting of the USB interface. ## -property-value An array of [UsbInterruptOutPipe](usbinterruptoutpipe.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterface.InterruptOutPipes +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterface.InterruptOutPipes + +## -description +Gets an array of objects that represent pipes that the host opened to communicate with interrupt OUT endpoints defined in the current setting of the USB interface. + +## -property-value +An array of [UsbInterruptOutPipe](usbinterruptoutpipe.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor.md b/windows.devices.usb/usbinterfacedescriptor.md index d95daa78e5..f3b514b927 100644 --- a/windows.devices.usb/usbinterfacedescriptor.md +++ b/windows.devices.usb/usbinterfacedescriptor.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterfaceDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterfaceDescriptor ## -description Describes a USB alternate setting (of an interface) in an interface descriptor. For an explanation of an interface descriptor, see Section 9.6.5 in the Universal Serial Bus Specification: + Table 9.15 in the Universal Serial Bus 3.0 Specification + Table 9.12 in the Universal Serial Bus Specification (version 2.0) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterfaceDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor + +## -description +Describes a USB alternate setting (of an interface) in an interface descriptor. For an explanation of an interface descriptor, see Section 9.6.5 in the Universal Serial Bus Specification: + + ++ Table 9.15 in the Universal Serial Bus 3.0 Specification ++ Table 9.12 in the Universal Serial Bus Specification (version 2.0) + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_alternatesettingnumber.md b/windows.devices.usb/usbinterfacedescriptor_alternatesettingnumber.md index 06211c5985..d6e14a0ad9 100644 --- a/windows.devices.usb/usbinterfacedescriptor_alternatesettingnumber.md +++ b/windows.devices.usb/usbinterfacedescriptor_alternatesettingnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.AlternateSettingNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.AlternateSettingNumber ## -description Gets the **bAlternateSetting** field of the USB interface descriptor. The value is a number that identifies the alternate setting defined by the interface. ## -property-value A number that identifies the alternate setting defined by the interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.AlternateSettingNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.AlternateSettingNumber + +## -description +Gets the **bAlternateSetting** field of the USB interface descriptor. The value is a number that identifies the alternate setting defined by the interface. + +## -property-value +A number that identifies the alternate setting defined by the interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_classcode.md b/windows.devices.usb/usbinterfacedescriptor_classcode.md index 93cbf10ef6..4751def94a 100644 --- a/windows.devices.usb/usbinterfacedescriptor_classcode.md +++ b/windows.devices.usb/usbinterfacedescriptor_classcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.ClassCode --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.ClassCode ## -description Gets the **bInterfaceClass** field of the USB interface descriptor. The value indicates the USB-defined class to which the interface conforms. ## -property-value The USB-defined class to which the interface conforms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.ClassCode +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.ClassCode + +## -description +Gets the **bInterfaceClass** field of the USB interface descriptor. The value indicates the USB-defined class to which the interface conforms. + +## -property-value +The USB-defined class to which the interface conforms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_interfacenumber.md b/windows.devices.usb/usbinterfacedescriptor_interfacenumber.md index 985f7f0b84..ee5cda707a 100644 --- a/windows.devices.usb/usbinterfacedescriptor_interfacenumber.md +++ b/windows.devices.usb/usbinterfacedescriptor_interfacenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.InterfaceNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.InterfaceNumber ## -description Gets the **bInterfaceNumber** field of the USB interface descriptor. The value is the index that identifies the interface. ## -property-value The index that identifies the interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.InterfaceNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.InterfaceNumber + +## -description +Gets the **bInterfaceNumber** field of the USB interface descriptor. The value is the index that identifies the interface. + +## -property-value +The index that identifies the interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_parse_1098943634.md b/windows.devices.usb/usbinterfacedescriptor_parse_1098943634.md index 1d35d98c5f..4629fb32a9 100644 --- a/windows.devices.usb/usbinterfacedescriptor_parse_1098943634.md +++ b/windows.devices.usb/usbinterfacedescriptor_parse_1098943634.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.Usb.UsbInterfaceDescriptor.Parse(Windows.Devices.Usb.UsbDescriptor) --api-type: winrt method ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.Parse ## -description Parses the specified USB descriptor and returns alternate setting information in a [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object. ## -parameters ### -param descriptor A [UsbDescriptor](usbdescriptor.md) object that contains the USB interface descriptor. ## -returns A [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object describes the alternate setting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbInterfaceDescriptor.Parse(Windows.Devices.Usb.UsbDescriptor) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.Parse + +## -description +Parses the specified USB descriptor and returns alternate setting information in a [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object. + +## -parameters +### -param descriptor +A [UsbDescriptor](usbdescriptor.md) object that contains the USB interface descriptor. + +## -returns +A [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object describes the alternate setting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_protocolcode.md b/windows.devices.usb/usbinterfacedescriptor_protocolcode.md index 0add5ad2c4..65641a28f0 100644 --- a/windows.devices.usb/usbinterfacedescriptor_protocolcode.md +++ b/windows.devices.usb/usbinterfacedescriptor_protocolcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.ProtocolCode --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.ProtocolCode ## -description Gets the **bInterfaceProtocol** field of the interface descriptor. The value is a USB-assigned identifier that specifies a USB-defined protocol to which the interface conforms. ## -property-value A USB-assigned identifier that specifies a USB-defined protocol to which the interface conforms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.ProtocolCode +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.ProtocolCode + +## -description +Gets the **bInterfaceProtocol** field of the interface descriptor. The value is a USB-assigned identifier that specifies a USB-defined protocol to which the interface conforms. + +## -property-value +A USB-assigned identifier that specifies a USB-defined protocol to which the interface conforms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_subclasscode.md b/windows.devices.usb/usbinterfacedescriptor_subclasscode.md index 8d46869624..3e40d52d88 100644 --- a/windows.devices.usb/usbinterfacedescriptor_subclasscode.md +++ b/windows.devices.usb/usbinterfacedescriptor_subclasscode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.SubclassCode --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.SubclassCode ## -description Gets the **bInterfaceSubClass** field of the USB interface descriptor. The value is a USB-assigned identifier that specifies a USB-defined subclass to which the interface. ## -property-value A USB-assigned identifier that specifies a USB-defined subclass to which the interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceDescriptor.SubclassCode +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.SubclassCode + +## -description +Gets the **bInterfaceSubClass** field of the USB interface descriptor. The value is a USB-assigned identifier that specifies a USB-defined subclass to which the interface. + +## -property-value +A USB-assigned identifier that specifies a USB-defined subclass to which the interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacedescriptor_tryparse_115773636.md b/windows.devices.usb/usbinterfacedescriptor_tryparse_115773636.md index d71abbccb4..2a89fe5fc8 100644 --- a/windows.devices.usb/usbinterfacedescriptor_tryparse_115773636.md +++ b/windows.devices.usb/usbinterfacedescriptor_tryparse_115773636.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Devices.Usb.UsbInterfaceDescriptor.TryParse(Windows.Devices.Usb.UsbDescriptor,Windows.Devices.Usb.UsbInterfaceDescriptor@) --api-type: winrt method ---- # Windows.Devices.Usb.UsbInterfaceDescriptor.TryParse ## -description Retrieves information about the alternate setting in a [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object that is contained in a [UsbDescriptor](usbdescriptor.md) object. ## -parameters ### -param descriptor The [UsbDescriptor](usbdescriptor.md) object to parse. ### -param parsed Receives a [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object. ## -returns True, if the specified [UsbDescriptor](usbdescriptor.md) object is USB interface descriptor. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbInterfaceDescriptor.TryParse(Windows.Devices.Usb.UsbDescriptor,Windows.Devices.Usb.UsbInterfaceDescriptor@) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbInterfaceDescriptor.TryParse + +## -description +Retrieves information about the alternate setting in a [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object that is contained in a [UsbDescriptor](usbdescriptor.md) object. + +## -parameters +### -param descriptor +The [UsbDescriptor](usbdescriptor.md) object to parse. + +### -param parsed +Receives a [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object. + +## -returns +True, if the specified [UsbDescriptor](usbdescriptor.md) object is USB interface descriptor. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting.md b/windows.devices.usb/usbinterfacesetting.md index 21a73cf02f..3a0caebf38 100644 --- a/windows.devices.usb/usbinterfacesetting.md +++ b/windows.devices.usb/usbinterfacesetting.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterfaceSetting --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterfaceSetting ## -description Provides information about an alternate setting and select that setting. The app can get the USB interface descriptors for the setting and its endpoints, and determine whether this setting is currently selected. ## -remarks For code example, see [UsbInterface](usbinterface.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterfaceSetting +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting + +## -description +Provides information about an alternate setting and select that setting. The app can get the USB interface descriptors for the setting and its endpoints, and determine whether this setting is currently selected. + +## -remarks +For code example, see [UsbInterface](usbinterface.md). + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_bulkinendpoints.md b/windows.devices.usb/usbinterfacesetting_bulkinendpoints.md index 73a320d3d6..5306c7c9f9 100644 --- a/windows.devices.usb/usbinterfacesetting_bulkinendpoints.md +++ b/windows.devices.usb/usbinterfacesetting_bulkinendpoints.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.BulkInEndpoints --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.BulkInEndpoints ## -description Gets an array of objects that represent descriptors associated with USB bulk IN endpoints that are defined in the alternate setting. ## -property-value An array of [UsbBulkInEndpointDescriptor](usbbulkinendpointdescriptor.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.BulkInEndpoints +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.BulkInEndpoints + +## -description +Gets an array of objects that represent descriptors associated with USB bulk IN endpoints that are defined in the alternate setting. + +## -property-value +An array of [UsbBulkInEndpointDescriptor](usbbulkinendpointdescriptor.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_bulkoutendpoints.md b/windows.devices.usb/usbinterfacesetting_bulkoutendpoints.md index 10dfccbfe3..069f3ed371 100644 --- a/windows.devices.usb/usbinterfacesetting_bulkoutendpoints.md +++ b/windows.devices.usb/usbinterfacesetting_bulkoutendpoints.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.BulkOutEndpoints --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.BulkOutEndpoints ## -description Gets an array of objects that represent descriptors associated with USB bulk OUT endpoints that are defined in the alternate setting. ## -property-value An array of [UsbBulkOutEndpointDescriptor](usbbulkoutendpointdescriptor.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.BulkOutEndpoints +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.BulkOutEndpoints + +## -description +Gets an array of objects that represent descriptors associated with USB bulk OUT endpoints that are defined in the alternate setting. + +## -property-value +An array of [UsbBulkOutEndpointDescriptor](usbbulkoutendpointdescriptor.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_descriptors.md b/windows.devices.usb/usbinterfacesetting_descriptors.md index e64e3de45a..e912a9be43 100644 --- a/windows.devices.usb/usbinterfacesetting_descriptors.md +++ b/windows.devices.usb/usbinterfacesetting_descriptors.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.Descriptors --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.Descriptors ## -description Gets an array of objects that represent descriptors associated with the alternate setting. ## -property-value An array of [UsbDescriptor](usbdescriptor.md) objects that represent the interface descriptor associated with the alternate setting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.Descriptors +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.Descriptors + +## -description +Gets an array of objects that represent descriptors associated with the alternate setting. + +## -property-value +An array of [UsbDescriptor](usbdescriptor.md) objects that represent the interface descriptor associated with the alternate setting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_interfacedescriptor.md b/windows.devices.usb/usbinterfacesetting_interfacedescriptor.md index bf4be491b0..a08779cba1 100644 --- a/windows.devices.usb/usbinterfacesetting_interfacedescriptor.md +++ b/windows.devices.usb/usbinterfacesetting_interfacedescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.InterfaceDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.InterfaceDescriptor ## -description Gets an object that represents the descriptor that describes the alternate setting. ## -property-value A [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object that has the full descriptor for the alternate setting. Requirements ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.InterfaceDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.InterfaceDescriptor + +## -description +Gets an object that represents the descriptor that describes the alternate setting. + +## -property-value +A [UsbInterfaceDescriptor](usbinterfacedescriptor.md) object that has the full descriptor for the alternate setting. Requirements + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_interruptinendpoints.md b/windows.devices.usb/usbinterfacesetting_interruptinendpoints.md index bbfc15209d..a96bebb9ad 100644 --- a/windows.devices.usb/usbinterfacesetting_interruptinendpoints.md +++ b/windows.devices.usb/usbinterfacesetting_interruptinendpoints.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.InterruptInEndpoints --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.InterruptInEndpoints ## -description Gets an array of objects that represent descriptors associated with USB interrupt IN endpoints that are defined in the alternate setting. ## -property-value An array of [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.InterruptInEndpoints +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.InterruptInEndpoints + +## -description +Gets an array of objects that represent descriptors associated with USB interrupt IN endpoints that are defined in the alternate setting. + +## -property-value +An array of [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_interruptoutendpoints.md b/windows.devices.usb/usbinterfacesetting_interruptoutendpoints.md index 04292591b4..dc309165c8 100644 --- a/windows.devices.usb/usbinterfacesetting_interruptoutendpoints.md +++ b/windows.devices.usb/usbinterfacesetting_interruptoutendpoints.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.InterruptOutEndpoints --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.InterruptOutEndpoints ## -description Gets an array of objects that represent descriptors associated with USB interrupt OUT endpoints that are defined in the alternate setting. ## -property-value An array of [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.InterruptOutEndpoints +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.InterruptOutEndpoints + +## -description +Gets an array of objects that represent descriptors associated with USB interrupt OUT endpoints that are defined in the alternate setting. + +## -property-value +An array of [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_selected.md b/windows.devices.usb/usbinterfacesetting_selected.md index 4e1fe425ca..2147fcf194 100644 --- a/windows.devices.usb/usbinterfacesetting_selected.md +++ b/windows.devices.usb/usbinterfacesetting_selected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.Selected --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterfaceSetting.Selected ## -description Determines whether the alternate setting is currently selected. ## -property-value True, if the alternate setting is currently selected; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterfaceSetting.Selected +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.Selected + +## -description +Determines whether the alternate setting is currently selected. + +## -property-value +True, if the alternate setting is currently selected; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterfacesetting_selectsettingasync_1330615377.md b/windows.devices.usb/usbinterfacesetting_selectsettingasync_1330615377.md index 5e75d7075e..b2a3fcb429 100644 --- a/windows.devices.usb/usbinterfacesetting_selectsettingasync_1330615377.md +++ b/windows.devices.usb/usbinterfacesetting_selectsettingasync_1330615377.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Usb.UsbInterfaceSetting.SelectSettingAsync --api-type: winrt method ---- # Windows.Devices.Usb.UsbInterfaceSetting.SelectSettingAsync ## -description Selects the alternate setting as the current setting in the USB interface. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks [SelectSettingAsync](usbinterfacesetting_selectsettingasync.md) disables the endpoints of the previous alternate setting and removes the pipes associated with them from the [UsbInterface](usbinterface.md) object. The method enables the endpoints of this setting, and adds the associated pipes to the [UsbInterface](usbinterface.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbInterfaceSetting.SelectSettingAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbInterfaceSetting.SelectSettingAsync + +## -description +Selects the alternate setting as the current setting in the USB interface. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +[SelectSettingAsync](usbinterfacesetting_selectsettingasync.md) disables the endpoints of the previous alternate setting and removes the pipes associated with them from the [UsbInterface](usbinterface.md) object. The method enables the endpoints of this setting, and adds the associated pipes to the [UsbInterface](usbinterface.md) object. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinendpointdescriptor.md b/windows.devices.usb/usbinterruptinendpointdescriptor.md index 435048da55..15a1b3c03f 100644 --- a/windows.devices.usb/usbinterruptinendpointdescriptor.md +++ b/windows.devices.usb/usbinterruptinendpointdescriptor.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterruptInEndpointDescriptor ## -description The endpoint descriptor for a USB interrupt IN endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be read from the endpoint, in a single transfer. The app can also get information about how often the host polls the endpoint for data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterruptInEndpointDescriptor + +## -description +The endpoint descriptor for a USB interrupt IN endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be read from the endpoint, in a single transfer. The app can also get information about how often the host polls the endpoint for data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinendpointdescriptor_endpointnumber.md b/windows.devices.usb/usbinterruptinendpointdescriptor_endpointnumber.md index 6401b5a927..465c695617 100644 --- a/windows.devices.usb/usbinterruptinendpointdescriptor_endpointnumber.md +++ b/windows.devices.usb/usbinterruptinendpointdescriptor_endpointnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.EndpointNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.EndpointNumber ## -description Gets the USB endpoint number of the interrupt IN endpoint. ## -property-value The endpoint number of the interrupt IN endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.EndpointNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.EndpointNumber + +## -description +Gets the USB endpoint number of the interrupt IN endpoint. + +## -property-value +The endpoint number of the interrupt IN endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinendpointdescriptor_interval.md b/windows.devices.usb/usbinterruptinendpointdescriptor_interval.md index d05049c3a7..741ed84c21 100644 --- a/windows.devices.usb/usbinterruptinendpointdescriptor_interval.md +++ b/windows.devices.usb/usbinterruptinendpointdescriptor_interval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Interval --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Interval ## -description Gets the poling interval of the USB interrupt endpoint. ## -property-value The poling interval of the USB interrupt endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Interval +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Interval + +## -description +Gets the poling interval of the USB interrupt endpoint. + +## -property-value +The poling interval of the USB interrupt endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinendpointdescriptor_maxpacketsize.md b/windows.devices.usb/usbinterruptinendpointdescriptor_maxpacketsize.md index 20e7addd07..3c30a743c4 100644 --- a/windows.devices.usb/usbinterruptinendpointdescriptor_maxpacketsize.md +++ b/windows.devices.usb/usbinterruptinendpointdescriptor_maxpacketsize.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.MaxPacketSize --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.MaxPacketSize ## -description Gets the maximum number of bytes that can be sent to or received (in a packet) from this endpoint. ## -property-value Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks The [MaxPacketSize](usbinterruptinendpointdescriptor_maxpacketsize.md) property value does not necessarily indicate the number of bytes that will be read at a time, in one interval. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.MaxPacketSize +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.MaxPacketSize + +## -description +Gets the maximum number of bytes that can be sent to or received (in a packet) from this endpoint. + +## -property-value +Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks +The [MaxPacketSize](usbinterruptinendpointdescriptor_maxpacketsize.md) property value does not necessarily indicate the number of bytes that will be read at a time, in one interval. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinendpointdescriptor_pipe.md b/windows.devices.usb/usbinterruptinendpointdescriptor_pipe.md index ebb957840f..823b0815d6 100644 --- a/windows.devices.usb/usbinterruptinendpointdescriptor_pipe.md +++ b/windows.devices.usb/usbinterruptinendpointdescriptor_pipe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Pipe --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Pipe ## -description Gets the object that represents the pipe that the host opens to communicate with the interrupt IN endpoint. ## -property-value An [UsbInterruptInPipe](usbinterruptinpipe.md) object that is the pipe for the interrupt IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Pipe +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptInEndpointDescriptor.Pipe + +## -description +Gets the object that represents the pipe that the host opens to communicate with the interrupt IN endpoint. + +## -property-value +An [UsbInterruptInPipe](usbinterruptinpipe.md) object that is the pipe for the interrupt IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptineventargs.md b/windows.devices.usb/usbinterruptineventargs.md index 3839707c11..b212ea9c4b 100644 --- a/windows.devices.usb/usbinterruptineventargs.md +++ b/windows.devices.usb/usbinterruptineventargs.md @@ -1,3 +1,33 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterruptInEventArgs --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterruptInEventArgs ## -description Represents the object that is passed as a parameter to the event handler for the [DataReceived](usbinterruptinpipe_datareceived.md) event. ## -remarks [UsbInterruptInEventArgs](usbinterruptineventargs.md) is used to access data from an interrupt IN pipe. When data arrives in an interrupt IN pipe, it raises the [DataReceived](usbinterruptinpipe_datareceived.md) event. You must register an event handler for the event. That event handler's parameter is a [UsbInterruptInEventArgs](usbinterruptineventargs.md) object. After the event handler is invoked, you can access the data by using the [InterruptData](usbinterruptineventargs_interruptdata.md) property. ``` function onDataReceived(eventArgs) { /* Your code */ var interruptData = eventArgs.interruptData; } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterruptInEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterruptInEventArgs + +## -description +Represents the object that is passed as a parameter to the event handler for the [DataReceived](usbinterruptinpipe_datareceived.md) event. + +## -remarks +[UsbInterruptInEventArgs](usbinterruptineventargs.md) is used to access data from an interrupt IN pipe. When data arrives in an interrupt IN pipe, it raises the [DataReceived](usbinterruptinpipe_datareceived.md) event. You must register an event handler for the event. That event handler's parameter is a [UsbInterruptInEventArgs](usbinterruptineventargs.md) object. After the event handler is invoked, you can access the data by using the [InterruptData](usbinterruptineventargs_interruptdata.md) property. + + + +``` +function onDataReceived(eventArgs) +{ + /* Your code */ + var interruptData = eventArgs.interruptData; +} + +``` + + + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptineventargs_interruptdata.md b/windows.devices.usb/usbinterruptineventargs_interruptdata.md index 4df041d1f2..e76eb82e49 100644 --- a/windows.devices.usb/usbinterruptineventargs_interruptdata.md +++ b/windows.devices.usb/usbinterruptineventargs_interruptdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptInEventArgs.InterruptData --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptInEventArgs.InterruptData ## -description Gets data from the interrupt IN endpoint. ## -property-value An [IBuffer](../windows.storage.streams/ibuffer.md) object that contains data that was read from the interrupt IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptInEventArgs.InterruptData +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptInEventArgs.InterruptData + +## -description +Gets data from the interrupt IN endpoint. + +## -property-value +An [IBuffer](../windows.storage.streams/ibuffer.md) object that contains data that was read from the interrupt IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinpipe.md b/windows.devices.usb/usbinterruptinpipe.md index e3522093d5..a2394f15d6 100644 --- a/windows.devices.usb/usbinterruptinpipe.md +++ b/windows.devices.usb/usbinterruptinpipe.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterruptInPipe --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterruptInPipe ## -description Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt IN endpoint of the device. The object also enables the app to specify an event handler. That handler that gets invoked when data is read from the endpoint. ## -remarks When the app registers an event handler, the host controller polls the endpoint for data at regular intervals. That interval value can be obtained in the [Interval](usbinterruptinendpointdescriptor_interval.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterruptInPipe +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterruptInPipe + +## -description +Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt IN endpoint of the device. The object also enables the app to specify an event handler. That handler that gets invoked when data is read from the endpoint. + +## -remarks +When the app registers an event handler, the host controller polls the endpoint for data at regular intervals. That interval value can be obtained in the [Interval](usbinterruptinendpointdescriptor_interval.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinpipe_clearstallasync_1674007612.md b/windows.devices.usb/usbinterruptinpipe_clearstallasync_1674007612.md index c33ab03cf2..504797f825 100644 --- a/windows.devices.usb/usbinterruptinpipe_clearstallasync_1674007612.md +++ b/windows.devices.usb/usbinterruptinpipe_clearstallasync_1674007612.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Usb.UsbInterruptInPipe.ClearStallAsync --api-type: winrt method ---- # Windows.Devices.Usb.UsbInterruptInPipe.ClearStallAsync ## -description Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt IN endpoint that is associated with the pipe. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbInterruptInPipe.ClearStallAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbInterruptInPipe.ClearStallAsync + +## -description +Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt IN endpoint that is associated with the pipe. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinpipe_datareceived.md b/windows.devices.usb/usbinterruptinpipe_datareceived.md index b2b4d47e6d..5a9c27636b 100644 --- a/windows.devices.usb/usbinterruptinpipe_datareceived.md +++ b/windows.devices.usb/usbinterruptinpipe_datareceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.Usb.UsbInterruptInPipe.DataReceived --api-type: winrt event ---- # Windows.Devices.Usb.UsbInterruptInPipe.DataReceived ## -description Raised when the interrupt pipe receives data from the interrupt IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.Usb.UsbInterruptInPipe.DataReceived +-api-type: winrt event +--- + + + +# Windows.Devices.Usb.UsbInterruptInPipe.DataReceived + +## -description +Raised when the interrupt pipe receives data from the interrupt IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptinpipe_endpointdescriptor.md b/windows.devices.usb/usbinterruptinpipe_endpointdescriptor.md index a98afe05f9..f032218ee7 100644 --- a/windows.devices.usb/usbinterruptinpipe_endpointdescriptor.md +++ b/windows.devices.usb/usbinterruptinpipe_endpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptInPipe.EndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptInPipe.EndpointDescriptor ## -description Gets the object that represents the endpoint descriptor associated with the USB interrupt IN endpoint. ## -property-value A [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) object that represents the endpoint descriptor associated with the USB interrupt IN endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptInPipe.EndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptInPipe.EndpointDescriptor + +## -description +Gets the object that represents the endpoint descriptor associated with the USB interrupt IN endpoint. + +## -property-value +A [UsbInterruptInEndpointDescriptor](usbinterruptinendpointdescriptor.md) object that represents the endpoint descriptor associated with the USB interrupt IN endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutendpointdescriptor.md b/windows.devices.usb/usbinterruptoutendpointdescriptor.md index 2dad12188a..9dbeaf1c60 100644 --- a/windows.devices.usb/usbinterruptoutendpointdescriptor.md +++ b/windows.devices.usb/usbinterruptoutendpointdescriptor.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor ## -description The endpoint descriptor for a USB interrupt OUT endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be written to the endpoint, in a single transfer. The app can also get information about how often the host polls the endpoint to send data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor + +## -description +The endpoint descriptor for a USB interrupt OUT endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be written to the endpoint, in a single transfer. The app can also get information about how often the host polls the endpoint to send data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutendpointdescriptor_endpointnumber.md b/windows.devices.usb/usbinterruptoutendpointdescriptor_endpointnumber.md index 29b541db60..ccff84ff03 100644 --- a/windows.devices.usb/usbinterruptoutendpointdescriptor_endpointnumber.md +++ b/windows.devices.usb/usbinterruptoutendpointdescriptor_endpointnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.EndpointNumber --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.EndpointNumber ## -description Gets the USB endpoint number of the interrupt OUT endpoint. ## -property-value The USB endpoint number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.EndpointNumber +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.EndpointNumber + +## -description +Gets the USB endpoint number of the interrupt OUT endpoint. + +## -property-value +The USB endpoint number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutendpointdescriptor_interval.md b/windows.devices.usb/usbinterruptoutendpointdescriptor_interval.md index a98b8ec04b..b3a12e6320 100644 --- a/windows.devices.usb/usbinterruptoutendpointdescriptor_interval.md +++ b/windows.devices.usb/usbinterruptoutendpointdescriptor_interval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Interval --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Interval ## -description Gets the poling interval of the USB interrupt endpoint. ## -property-value The poling interval of the USB interrupt endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Interval +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Interval + +## -description +Gets the poling interval of the USB interrupt endpoint. + +## -property-value +The poling interval of the USB interrupt endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutendpointdescriptor_maxpacketsize.md b/windows.devices.usb/usbinterruptoutendpointdescriptor_maxpacketsize.md index 27e26a5998..ee73a5eec4 100644 --- a/windows.devices.usb/usbinterruptoutendpointdescriptor_maxpacketsize.md +++ b/windows.devices.usb/usbinterruptoutendpointdescriptor_maxpacketsize.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.MaxPacketSize --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.MaxPacketSize ## -description Gets the maximum number of bytes that can be sent to or received from this endpoint. ## -property-value Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. ## -remarks The [MaxPacketSize](usbinterruptoutendpointdescriptor_maxpacketsize.md) property value does not necessarily indicate the number of bytes that will be written at a time, in one interval. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.MaxPacketSize +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.MaxPacketSize + +## -description +Gets the maximum number of bytes that can be sent to or received from this endpoint. + +## -property-value +Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification. + +## -remarks +The [MaxPacketSize](usbinterruptoutendpointdescriptor_maxpacketsize.md) property value does not necessarily indicate the number of bytes that will be written at a time, in one interval. + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutendpointdescriptor_pipe.md b/windows.devices.usb/usbinterruptoutendpointdescriptor_pipe.md index 3babf88307..33eba2911b 100644 --- a/windows.devices.usb/usbinterruptoutendpointdescriptor_pipe.md +++ b/windows.devices.usb/usbinterruptoutendpointdescriptor_pipe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Pipe --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Pipe ## -description Gets the object that represents the pipe that the host opens to communicate with the interrupt OUT endpoint. ## -property-value An [UsbInterruptInPipe](usbinterruptinpipe.md) object that is the pipe for the interrupt OUT endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Pipe +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutEndpointDescriptor.Pipe + +## -description +Gets the object that represents the pipe that the host opens to communicate with the interrupt OUT endpoint. + +## -property-value +An [UsbInterruptInPipe](usbinterruptinpipe.md) object that is the pipe for the interrupt OUT endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutpipe.md b/windows.devices.usb/usbinterruptoutpipe.md index 97b94a0264..d765dc9cb9 100644 --- a/windows.devices.usb/usbinterruptoutpipe.md +++ b/windows.devices.usb/usbinterruptoutpipe.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbInterruptOutPipe --api-type: winrt class ---- # Windows.Devices.Usb.UsbInterruptOutPipe ## -description Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbInterruptOutPipe +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbInterruptOutPipe + +## -description +Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutpipe_clearstallasync_1674007612.md b/windows.devices.usb/usbinterruptoutpipe_clearstallasync_1674007612.md index 67e978b542..6481552d9a 100644 --- a/windows.devices.usb/usbinterruptoutpipe_clearstallasync_1674007612.md +++ b/windows.devices.usb/usbinterruptoutpipe_clearstallasync_1674007612.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.Usb.UsbInterruptOutPipe.ClearStallAsync --api-type: winrt method ---- # Windows.Devices.Usb.UsbInterruptOutPipe.ClearStallAsync ## -description Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt OUT endpoint that is associated with the pipe. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbInterruptOutPipe.ClearStallAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbInterruptOutPipe.ClearStallAsync + +## -description +Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt OUT endpoint that is associated with the pipe. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutpipe_endpointdescriptor.md b/windows.devices.usb/usbinterruptoutpipe_endpointdescriptor.md index 380b3e29d6..f9eaf14ecc 100644 --- a/windows.devices.usb/usbinterruptoutpipe_endpointdescriptor.md +++ b/windows.devices.usb/usbinterruptoutpipe_endpointdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutPipe.EndpointDescriptor --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutPipe.EndpointDescriptor ## -description Gets the object that represents the endpoint descriptor associated with the USB interrupt OUT endpoint. ## -property-value A [UsbInterruptOutEndpointDescriptor](usbinterruptoutendpointdescriptor.md) object that represents the endpoint descriptor associated with the USB interrupt OUT endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutPipe.EndpointDescriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutPipe.EndpointDescriptor + +## -description +Gets the object that represents the endpoint descriptor associated with the USB interrupt OUT endpoint. + +## -property-value +A [UsbInterruptOutEndpointDescriptor](usbinterruptoutendpointdescriptor.md) object that represents the endpoint descriptor associated with the USB interrupt OUT endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutpipe_outputstream.md b/windows.devices.usb/usbinterruptoutpipe_outputstream.md index 4e5e70685b..27f0c38b86 100644 --- a/windows.devices.usb/usbinterruptoutpipe_outputstream.md +++ b/windows.devices.usb/usbinterruptoutpipe_outputstream.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutPipe.OutputStream --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutPipe.OutputStream ## -description Gets an output stream to which the app can write data to send to the endpoint. ## -property-value Output stream that contains data to write to the endpoint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutPipe.OutputStream +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutPipe.OutputStream + +## -description +Gets an output stream to which the app can write data to send to the endpoint. + +## -property-value +Output stream that contains data to write to the endpoint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbinterruptoutpipe_writeoptions.md b/windows.devices.usb/usbinterruptoutpipe_writeoptions.md index ca8ea2be2c..9f286dfa24 100644 --- a/windows.devices.usb/usbinterruptoutpipe_writeoptions.md +++ b/windows.devices.usb/usbinterruptoutpipe_writeoptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbInterruptOutPipe.WriteOptions --api-type: winrt property ---- # Windows.Devices.Usb.UsbInterruptOutPipe.WriteOptions ## -description Gets or sets configuration flags that controls the behavior of the pipe that writes data to a USB interrupt OUT endpoint. ## -property-value A [UsbWriteOptions](usbwriteoptions.md) constant that indicates the pipe policy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbInterruptOutPipe.WriteOptions +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbInterruptOutPipe.WriteOptions + +## -description +Gets or sets configuration flags that controls the behavior of the pipe that writes data to a USB interrupt OUT endpoint. + +## -property-value +A [UsbWriteOptions](usbwriteoptions.md) constant that indicates the pipe policy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket.md b/windows.devices.usb/usbsetuppacket.md index 3615bd8e36..54c04e2699 100644 --- a/windows.devices.usb/usbsetuppacket.md +++ b/windows.devices.usb/usbsetuppacket.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.Usb.UsbSetupPacket --api-type: winrt class ---- # Windows.Devices.Usb.UsbSetupPacket ## -description Describes the setup packet for a USB control transfer. For an explanation of the setup packet, see Table 9.2 in the Universal Serial Bus (USB) specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.Usb.UsbSetupPacket +-api-type: winrt class +--- + + + +# Windows.Devices.Usb.UsbSetupPacket + +## -description +Describes the setup packet for a USB control transfer. For an explanation of the setup packet, see Table 9.2 in the Universal Serial Bus (USB) specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket_index.md b/windows.devices.usb/usbsetuppacket_index.md index 412b63d405..4c862d5338 100644 --- a/windows.devices.usb/usbsetuppacket_index.md +++ b/windows.devices.usb/usbsetuppacket_index.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbSetupPacket.Index --api-type: winrt property ---- # Windows.Devices.Usb.UsbSetupPacket.Index ## -description Gets or sets the **wIndex** field in the setup packet of the USB control transfer. ## -property-value The **wIndex** field in the setup packet. For an explanation of this field, see section 9.3.4 of the Universal Serial Bus (USB) specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbSetupPacket.Index +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.Index + +## -description +Gets or sets the **wIndex** field in the setup packet of the USB control transfer. + +## -property-value +The **wIndex** field in the setup packet. For an explanation of this field, see section 9.3.4 of the Universal Serial Bus (USB) specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket_length.md b/windows.devices.usb/usbsetuppacket_length.md index d39706ae4c..09a9e48bcf 100644 --- a/windows.devices.usb/usbsetuppacket_length.md +++ b/windows.devices.usb/usbsetuppacket_length.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbSetupPacket.Length --api-type: winrt property ---- # Windows.Devices.Usb.UsbSetupPacket.Length ## -description Gets the length, in bytes, of the setup packet. ## -property-value The length, in bytes, of the setup packet. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbSetupPacket.Length +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.Length + +## -description +Gets the length, in bytes, of the setup packet. + +## -property-value +The length, in bytes, of the setup packet. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket_request.md b/windows.devices.usb/usbsetuppacket_request.md index be4b751d4f..7fdd058081 100644 --- a/windows.devices.usb/usbsetuppacket_request.md +++ b/windows.devices.usb/usbsetuppacket_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbSetupPacket.Request --api-type: winrt property ---- # Windows.Devices.Usb.UsbSetupPacket.Request ## -description Gets or sets the **bRequest** field in the setup packet of the USB control transfer. ## -property-value The **bRequest** field in the setup packet. For an explanation of this field, see section 9.3.2 of the Universal Serial Bus (USB) specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbSetupPacket.Request +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.Request + +## -description +Gets or sets the **bRequest** field in the setup packet of the USB control transfer. + +## -property-value +The **bRequest** field in the setup packet. For an explanation of this field, see section 9.3.2 of the Universal Serial Bus (USB) specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket_requesttype.md b/windows.devices.usb/usbsetuppacket_requesttype.md index e3f19efe82..7a772aaec5 100644 --- a/windows.devices.usb/usbsetuppacket_requesttype.md +++ b/windows.devices.usb/usbsetuppacket_requesttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbSetupPacket.RequestType --api-type: winrt property ---- # Windows.Devices.Usb.UsbSetupPacket.RequestType ## -description Gets or sets the **bmRequestType** field in the setup packet of the USB control transfer. That field is represented by a [UsbControlRequestType](usbcontrolrequesttype.md) object. ## -property-value The **bmRequestType** field in the setup packet. The values that are assigned to this field are described in Table 9.2 and section 9.3.1 of the Universal Serial Bus (USB) specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbSetupPacket.RequestType +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.RequestType + +## -description +Gets or sets the **bmRequestType** field in the setup packet of the USB control transfer. That field is represented by a [UsbControlRequestType](usbcontrolrequesttype.md) object. + +## -property-value +The **bmRequestType** field in the setup packet. The values that are assigned to this field are described in Table 9.2 and section 9.3.1 of the Universal Serial Bus (USB) specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket_usbsetuppacket_1221375020.md b/windows.devices.usb/usbsetuppacket_usbsetuppacket_1221375020.md index 2c3d3d2826..ca6e2a1e61 100644 --- a/windows.devices.usb/usbsetuppacket_usbsetuppacket_1221375020.md +++ b/windows.devices.usb/usbsetuppacket_usbsetuppacket_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.Usb.UsbSetupPacket.#ctor --api-type: winrt method ---- # Windows.Devices.Usb.UsbSetupPacket.UsbSetupPacket ## -description Creates a [UsbSetupPacket](usbsetuppacket.md) object. ## -remarks ## -examples ## -see-also [UsbSetupPacket(IBuffer)](usbsetuppacket_usbsetuppacket_1985205386.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbSetupPacket.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.UsbSetupPacket + +## -description +Creates a [UsbSetupPacket](usbsetuppacket.md) object. + +## -remarks + +## -examples + +## -see-also +[UsbSetupPacket(IBuffer)](usbsetuppacket_usbsetuppacket_1985205386.md) \ No newline at end of file diff --git a/windows.devices.usb/usbsetuppacket_usbsetuppacket_1985205386.md b/windows.devices.usb/usbsetuppacket_usbsetuppacket_1985205386.md index af63632abe..bfcc6f4123 100644 --- a/windows.devices.usb/usbsetuppacket_usbsetuppacket_1985205386.md +++ b/windows.devices.usb/usbsetuppacket_usbsetuppacket_1985205386.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.Usb.UsbSetupPacket.#ctor(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.Usb.UsbSetupPacket.UsbSetupPacket ## -description Creates a [UsbSetupPacket](usbsetuppacket.md) object from a formatted buffer (eight bytes) that contains the setup packet. ## -parameters ### -param eightByteBuffer A caller-supplied buffer that contains the setup packet formatted as per the standard USB specification. The length of the buffer must be eight bytes because that is the size of a setup packet on the bus. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.Usb.UsbSetupPacket.#ctor(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.UsbSetupPacket + +## -description +Creates a [UsbSetupPacket](usbsetuppacket.md) object from a formatted buffer (eight bytes) that contains the setup packet. + +## -parameters +### -param eightByteBuffer +A caller-supplied buffer that contains the setup packet formatted as per the standard USB specification. The length of the buffer must be eight bytes because that is the size of a setup packet on the bus. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.usb/usbsetuppacket_value.md b/windows.devices.usb/usbsetuppacket_value.md index 749e15c502..ea0d734d0b 100644 --- a/windows.devices.usb/usbsetuppacket_value.md +++ b/windows.devices.usb/usbsetuppacket_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.Usb.UsbSetupPacket.Value --api-type: winrt property ---- # Windows.Devices.Usb.UsbSetupPacket.Value ## -description Gets or sets the **wValue** field in the setup packet of the USB control transfer. ## -property-value The **wValue** field in the setup packet and the value varies according to the request. For an explanation of this field, see section 9.3.3 of the Universal Serial Bus (USB) specification. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.Usb.UsbSetupPacket.Value +-api-type: winrt property +--- + + + +# Windows.Devices.Usb.UsbSetupPacket.Value + +## -description +Gets or sets the **wValue** field in the setup packet of the USB control transfer. + +## -property-value +The **wValue** field in the setup packet and the value varies according to the request. For an explanation of this field, see section 9.3.3 of the Universal Serial Bus (USB) specification. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter.md b/windows.devices.wifi/wifiadapter.md index a3da273c42..d7765d20e1 100644 --- a/windows.devices.wifi/wifiadapter.md +++ b/windows.devices.wifi/wifiadapter.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFi.WiFiAdapter --api-type: winrt class ---- # Windows.Devices.WiFi.WiFiAdapter ## -description Use this class to enumerate local Wi-Fi adapters, initiate Wi-Fi scans, enumerate scan results, and to connect or disconnect individual adapters. ## -remarks Your code uses the static methods of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFi.WiFiAdapter +-api-type: winrt class +--- + + + +# Windows.Devices.WiFi.WiFiAdapter + +## -description +Use this class to enumerate local Wi-Fi adapters, initiate Wi-Fi scans, enumerate scan results, and to connect or disconnect individual adapters. + +## -remarks +Your code uses the static methods of this class. + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_availablenetworkschanged.md b/windows.devices.wifi/wifiadapter_availablenetworkschanged.md index ba7382f910..6e12272c63 100644 --- a/windows.devices.wifi/wifiadapter_availablenetworkschanged.md +++ b/windows.devices.wifi/wifiadapter_availablenetworkschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFi.WiFiAdapter.AvailableNetworksChanged --api-type: winrt event ---- # Windows.Devices.WiFi.WiFiAdapter.AvailableNetworksChanged ## -description Event raised when a scan completes on this Wi-Fi adapter. This even cannot be raised from a background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFi.WiFiAdapter.AvailableNetworksChanged +-api-type: winrt event +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.AvailableNetworksChanged + +## -description +Event raised when a scan completes on this Wi-Fi adapter. This even cannot be raised from a background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_connectasync_1064651212.md b/windows.devices.wifi/wifiadapter_connectasync_1064651212.md index a46c42f79a..b6dbc49cc1 100644 --- a/windows.devices.wifi/wifiadapter_connectasync_1064651212.md +++ b/windows.devices.wifi/wifiadapter_connectasync_1064651212.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind) --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.ConnectAsync ## -description Connect this Wi-Fi device to the specified network, with the specified reconnection policy. ## -parameters ### -param availableNetwork Describes the Wi-Fi network to be connected. ### -param reconnectionKind Specifies how to reconnect if the connection is lost. ## -returns An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. ## -remarks ## -examples ## -see-also [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential)](wifiadapter_connectasync_1490922496.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential, String)](wifiadapter_connectasync_1798151424.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.ConnectAsync + +## -description +Connect this Wi-Fi device to the specified network, with the specified reconnection policy. + +## -parameters +### -param availableNetwork +Describes the Wi-Fi network to be connected. + +### -param reconnectionKind +Specifies how to reconnect if the connection is lost. + +## -returns +An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential)](wifiadapter_connectasync_1490922496.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential, String)](wifiadapter_connectasync_1798151424.md) \ No newline at end of file diff --git a/windows.devices.wifi/wifiadapter_connectasync_1490922496.md b/windows.devices.wifi/wifiadapter_connectasync_1490922496.md index 3dee8f3c8e..8b80c0f86a 100644 --- a/windows.devices.wifi/wifiadapter_connectasync_1490922496.md +++ b/windows.devices.wifi/wifiadapter_connectasync_1490922496.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind,Windows.Security.Credentials.PasswordCredential) --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.ConnectAsync ## -description Connect this Wi-Fi device to the specified network, with the specified passphrase and reconnection policy. ## -parameters ### -param availableNetwork Specifies the Wi-Fi network to connect to. ### -param reconnectionKind Describes how to reconnect to the network if connection is lost. ### -param passwordCredential The passphrase to be used to connect to the access point. ## -returns An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. ## -remarks ## -examples ## -see-also [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind)](wifiadapter_connectasync_1064651212.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential, String)](wifiadapter_connectasync_1798151424.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind,Windows.Security.Credentials.PasswordCredential) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.ConnectAsync + +## -description +Connect this Wi-Fi device to the specified network, with the specified passphrase and reconnection policy. + +## -parameters +### -param availableNetwork +Specifies the Wi-Fi network to connect to. + +### -param reconnectionKind +Describes how to reconnect to the network if connection is lost. + +### -param passwordCredential +The passphrase to be used to connect to the access point. + +## -returns +An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind)](wifiadapter_connectasync_1064651212.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential, String)](wifiadapter_connectasync_1798151424.md) \ No newline at end of file diff --git a/windows.devices.wifi/wifiadapter_connectasync_1798151424.md b/windows.devices.wifi/wifiadapter_connectasync_1798151424.md index a583e344ad..3cd8f3694d 100644 --- a/windows.devices.wifi/wifiadapter_connectasync_1798151424.md +++ b/windows.devices.wifi/wifiadapter_connectasync_1798151424.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind,Windows.Security.Credentials.PasswordCredential,System.String) --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.ConnectAsync ## -description Connect this Wi-Fi device to a hidden network, with the given passphrase and reconnection policy. ## -parameters ### -param availableNetwork Describes the Wi-Fi network to connect to. ### -param reconnectionKind Describes how to reconnect to the network if connection is lost. ### -param passwordCredential Password or other credential to use to connect to the network. ### -param ssid When the network SSID is hidden, use this parameter to provide the SSID. ## -returns An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. ## -remarks ## -examples ## -see-also [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind)](wifiadapter_connectasync_1064651212.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential)](wifiadapter_connectasync_1490922496.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind,Windows.Security.Credentials.PasswordCredential,System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.ConnectAsync + +## -description +Connect this Wi-Fi device to a hidden network, with the given passphrase and reconnection policy. + +## -parameters +### -param availableNetwork +Describes the Wi-Fi network to connect to. + +### -param reconnectionKind +Describes how to reconnect to the network if connection is lost. + +### -param passwordCredential +Password or other credential to use to connect to the network. + +### -param ssid +When the network SSID is hidden, use this parameter to provide the SSID. + +## -returns +An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind)](wifiadapter_connectasync_1064651212.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential)](wifiadapter_connectasync_1490922496.md) \ No newline at end of file diff --git a/windows.devices.wifi/wifiadapter_disconnect_1865647988.md b/windows.devices.wifi/wifiadapter_disconnect_1865647988.md index 6f0e3e4184..9668057f33 100644 --- a/windows.devices.wifi/wifiadapter_disconnect_1865647988.md +++ b/windows.devices.wifi/wifiadapter_disconnect_1865647988.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.Disconnect --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.Disconnect ## -description Disconnects any active Wi-Fi connection through this adapter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.Disconnect +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.Disconnect + +## -description +Disconnects any active Wi-Fi connection through this adapter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_findalladaptersasync_130273039.md b/windows.devices.wifi/wifiadapter_findalladaptersasync_130273039.md index d79de3882c..3733f7e609 100644 --- a/windows.devices.wifi/wifiadapter_findalladaptersasync_130273039.md +++ b/windows.devices.wifi/wifiadapter_findalladaptersasync_130273039.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.FindAllAdaptersAsync --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.FindAllAdaptersAsync ## -description A static method that initiates an asynchronous operation to enumerate all Wi-Fi adapters in the system. Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. ## -returns An asynchronous enumeration operation. On successful completion, returns a list of available Wi-Fi adapters. If you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. ## -remarks ## -examples ## -see-also ## -capabilities wiFiControl \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.FindAllAdaptersAsync +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.FindAllAdaptersAsync + +## -description +A static method that initiates an asynchronous operation to enumerate all Wi-Fi adapters in the system. + +Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. + +## -returns +An asynchronous enumeration operation. On successful completion, returns a list of available Wi-Fi adapters. + +If you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +wiFiControl \ No newline at end of file diff --git a/windows.devices.wifi/wifiadapter_fromidasync_1322863552.md b/windows.devices.wifi/wifiadapter_fromidasync_1322863552.md index 2628ca73ef..f426e3439e 100644 --- a/windows.devices.wifi/wifiadapter_fromidasync_1322863552.md +++ b/windows.devices.wifi/wifiadapter_fromidasync_1322863552.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.FromIdAsync ## -description A static method that initiates an asynchronous operation to get a [WiFiAdapter](wifiadapter.md) object. Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. ## -parameters ### -param deviceId The Device ID of the Wi-Fi adapter to be retrieved. Obtain a Device ID through the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. ## -returns An asynchronous get operation. On successful completion, returns a [WiFiAdapter](wifiadapter.md) object specific to the requested Device ID. If you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. ## -remarks ## -examples ## -see-also ## -capabilities wiFiControl \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.FromIdAsync + +## -description +A static method that initiates an asynchronous operation to get a [WiFiAdapter](wifiadapter.md) object. + +Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. + +## -parameters +### -param deviceId +The Device ID of the Wi-Fi adapter to be retrieved. Obtain a Device ID through the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. + +## -returns +An asynchronous get operation. On successful completion, returns a [WiFiAdapter](wifiadapter.md) object specific to the requested Device ID. + +If you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method fails. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +wiFiControl \ No newline at end of file diff --git a/windows.devices.wifi/wifiadapter_getdeviceselector_838466080.md b/windows.devices.wifi/wifiadapter_getdeviceselector_838466080.md index cee11ff4a8..b85124c350 100644 --- a/windows.devices.wifi/wifiadapter_getdeviceselector_838466080.md +++ b/windows.devices.wifi/wifiadapter_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.GetDeviceSelector ## -description A static method that returns an Advanced Query Syntax (AQS) string to be used to enumerate Wi-Fi adapters using [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync_1257462890.md) and related methods. ## -returns An identifier to be used to enumerate Wi-Fi devices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.GetDeviceSelector + +## -description +A static method that returns an Advanced Query Syntax (AQS) string to be used to enumerate Wi-Fi adapters using [Windows.Devices.Enumeration.DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync_1257462890.md) and related methods. + +## -returns +An identifier to be used to enumerate Wi-Fi devices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_networkadapter.md b/windows.devices.wifi/wifiadapter_networkadapter.md index 130a4e51ed..d1328df6a2 100644 --- a/windows.devices.wifi/wifiadapter_networkadapter.md +++ b/windows.devices.wifi/wifiadapter_networkadapter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAdapter.NetworkAdapter --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAdapter.NetworkAdapter ## -description Gets information about a Wi-Fi adapter. ## -property-value An instance of [Windows.Networking.Connectivity.NetworkAdapter](../windows.networking.connectivity/networkadapter.md) representing this adapter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAdapter.NetworkAdapter +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.NetworkAdapter + +## -description +Gets information about a Wi-Fi adapter. + +## -property-value +An instance of [Windows.Networking.Connectivity.NetworkAdapter](../windows.networking.connectivity/networkadapter.md) representing this adapter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_networkreport.md b/windows.devices.wifi/wifiadapter_networkreport.md index b00e497489..d4b974864d 100644 --- a/windows.devices.wifi/wifiadapter_networkreport.md +++ b/windows.devices.wifi/wifiadapter_networkreport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAdapter.NetworkReport --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAdapter.NetworkReport ## -description Gets a list of available networks populated by the last Wi-Fi scan on this WiFiNetworkAdapter. ## -property-value A list of available networks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAdapter.NetworkReport +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.NetworkReport + +## -description +Gets a list of available networks populated by the last Wi-Fi scan on this WiFiNetworkAdapter. + +## -property-value +A list of available networks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_requestaccessasync_380675631.md b/windows.devices.wifi/wifiadapter_requestaccessasync_380675631.md index dec6427ee2..c661e64483 100644 --- a/windows.devices.wifi/wifiadapter_requestaccessasync_380675631.md +++ b/windows.devices.wifi/wifiadapter_requestaccessasync_380675631.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.RequestAccessAsync --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.RequestAccessAsync ## -description A static method for determining whether the current user can access any of the Wi-Fi adapters on this device. Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method always returns DeniedBySystem. Always returns **DeniedBySystem** on Xbox. ## -returns An asynchronous access operation. On successful completion, returns a status enumeration value describing whether the current user can access any Wi-Fi adapter. Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method always returns **DeniedBySystem**. Always returns **DeniedBySystem** on Xbox. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.RequestAccessAsync + +## -description +A static method for determining whether the current user can access any of the Wi-Fi adapters on this device. + +Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method always returns DeniedBySystem. + +Always returns **DeniedBySystem** on Xbox. + +## -returns +An asynchronous access operation. On successful completion, returns a status enumeration value describing whether the current user can access any Wi-Fi adapter. + +Note that if you do not specify that your app has the [wiFiControl](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) capability in your app manifest, this method always returns **DeniedBySystem**. + +Always returns **DeniedBySystem** on Xbox. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiadapter_scanasync_1036183308.md b/windows.devices.wifi/wifiadapter_scanasync_1036183308.md index 94fc6a90e2..de4a919b60 100644 --- a/windows.devices.wifi/wifiadapter_scanasync_1036183308.md +++ b/windows.devices.wifi/wifiadapter_scanasync_1036183308.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.WiFi.WiFiAdapter.ScanAsync --api-type: winrt method ---- # Windows.Devices.WiFi.WiFiAdapter.ScanAsync ## -description Directs this adapter to initiate an asynchronous network scan. ## -returns An asynchronous scan operation. On successful completion, returns a list of networks scanned by this adapter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.ScanAsync +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.ScanAsync + +## -description +Directs this adapter to initiate an asynchronous network scan. + +## -returns +An asynchronous scan operation. On successful completion, returns a list of networks scanned by this adapter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork.md b/windows.devices.wifi/wifiavailablenetwork.md index 474278e866..a658a100d8 100644 --- a/windows.devices.wifi/wifiavailablenetwork.md +++ b/windows.devices.wifi/wifiavailablenetwork.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFi.WiFiAvailableNetwork --api-type: winrt class ---- # Windows.Devices.WiFi.WiFiAvailableNetwork ## -description Describes an available Wi-Fi network. ## -remarks You do not instantiate objects of this class directly. The system creates instances of this object in as part of the process of scanning for networks and raising the [WiFiAdapter.AvailableNetworksChanged](wifiadapter_availablenetworkschanged.md) event. You can initiate a network scan using the [WiFiAdapter.FindAllAdaptersAsync](wifiadapter_findalladaptersasync.md) static method or the [WiFiAdapter.ScanAsync](wifiadapter_scanasync.md) method on a particular adapter. You can also retrieve the list of networks from the results of the most current scan from a given Wi-Fi adapter by getting the [AvailableNetworks](wifinetworkreport_availablenetworks.md) property of the [WiFiAdapter.NetworkReport](wifiadapter_networkreport.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFi.WiFiAvailableNetwork +-api-type: winrt class +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork + +## -description +Describes an available Wi-Fi network. + +## -remarks +You do not instantiate objects of this class directly. The system creates instances of this object in as part of the process of scanning for networks and raising the [WiFiAdapter.AvailableNetworksChanged](wifiadapter_availablenetworkschanged.md) event. You can initiate a network scan using the [WiFiAdapter.FindAllAdaptersAsync](wifiadapter_findalladaptersasync.md) static method or the [WiFiAdapter.ScanAsync](wifiadapter_scanasync.md) method on a particular adapter. You can also retrieve the list of networks from the results of the most current scan from a given Wi-Fi adapter by getting the [AvailableNetworks](wifinetworkreport_availablenetworks.md) property of the [WiFiAdapter.NetworkReport](wifiadapter_networkreport.md). + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_beaconinterval.md b/windows.devices.wifi/wifiavailablenetwork_beaconinterval.md index 651a94296d..df081e70ed 100644 --- a/windows.devices.wifi/wifiavailablenetwork_beaconinterval.md +++ b/windows.devices.wifi/wifiavailablenetwork_beaconinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.BeaconInterval --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.BeaconInterval ## -description Gets the interval between 802.11 Beacon frames used by this network. ## -property-value A [TimeSpan](../windows.foundation/timespan.md) representing the interval between beacons on this network. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.BeaconInterval +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.BeaconInterval + +## -description +Gets the interval between 802.11 Beacon frames used by this network. + +## -property-value +A [TimeSpan](../windows.foundation/timespan.md) representing the interval between beacons on this network. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_bssid.md b/windows.devices.wifi/wifiavailablenetwork_bssid.md index 024b18ffe0..071f87235b 100644 --- a/windows.devices.wifi/wifiavailablenetwork_bssid.md +++ b/windows.devices.wifi/wifiavailablenetwork_bssid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.Bssid --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.Bssid ## -description Gets the MAC address of the access point. ## -property-value The MAC address of the access point, formatted as xx:xx:xx:xx:xx:xx with always lower-case characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.Bssid +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.Bssid + +## -description +Gets the MAC address of the access point. + +## -property-value +The MAC address of the access point, formatted as xx:xx:xx:xx:xx:xx with always lower-case characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_channelcenterfrequencyinkilohertz.md b/windows.devices.wifi/wifiavailablenetwork_channelcenterfrequencyinkilohertz.md index 32a67637b3..6129f7a740 100644 --- a/windows.devices.wifi/wifiavailablenetwork_channelcenterfrequencyinkilohertz.md +++ b/windows.devices.wifi/wifiavailablenetwork_channelcenterfrequencyinkilohertz.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.ChannelCenterFrequencyInKilohertz --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.ChannelCenterFrequencyInKilohertz ## -description Gets the channel center frequency of the band on which the 802.11 Beacon or Probe Response was received. ## -property-value The channel center frequency of the band on which the 802.11 Beacon or Probe Response frame was received. The value of this property is in units of kilohertz (kHz). Note that this member is only valid for PHY types that are not frequency-hopping spread spectrum (FHSS). In all other cases the value returned is zero. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.ChannelCenterFrequencyInKilohertz +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.ChannelCenterFrequencyInKilohertz + +## -description +Gets the channel center frequency of the band on which the 802.11 Beacon or Probe Response was received. + +## -property-value +The channel center frequency of the band on which the 802.11 Beacon or Probe Response frame was received. The value of this property is in units of kilohertz (kHz). Note that this member is only valid for PHY types that are not frequency-hopping spread spectrum (FHSS). In all other cases the value returned is zero. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_iswifidirect.md b/windows.devices.wifi/wifiavailablenetwork_iswifidirect.md index 04539c24d5..bd89d44f1f 100644 --- a/windows.devices.wifi/wifiavailablenetwork_iswifidirect.md +++ b/windows.devices.wifi/wifiavailablenetwork_iswifidirect.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.IsWiFiDirect --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.IsWiFiDirect ## -description Gets a value indicating whether this network originates from a Wi-Fi Direct access point. ## -property-value When true, the network is originated by a Wi-Fi Direct access point. Otherwise, it is not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.IsWiFiDirect +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.IsWiFiDirect + +## -description +Gets a value indicating whether this network originates from a Wi-Fi Direct access point. + +## -property-value +When true, the network is originated by a Wi-Fi Direct access point. Otherwise, it is not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_networkkind.md b/windows.devices.wifi/wifiavailablenetwork_networkkind.md index afd5d0704d..3ab2e8f778 100644 --- a/windows.devices.wifi/wifiavailablenetwork_networkkind.md +++ b/windows.devices.wifi/wifiavailablenetwork_networkkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkKind --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkKind ## -description Gets a value describing the kind of network being described. ## -property-value A [WiFiNetworkKind](wifinetworkkind.md) enumeration member indicating the BSS network type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkKind +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkKind + +## -description +Gets a value describing the kind of network being described. + +## -property-value +A [WiFiNetworkKind](wifinetworkkind.md) enumeration member indicating the BSS network type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_networkrssiindecibelmilliwatts.md b/windows.devices.wifi/wifiavailablenetwork_networkrssiindecibelmilliwatts.md index e6f1f5998a..0e642c3ae6 100644 --- a/windows.devices.wifi/wifiavailablenetwork_networkrssiindecibelmilliwatts.md +++ b/windows.devices.wifi/wifiavailablenetwork_networkrssiindecibelmilliwatts.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkRssiInDecibelMilliwatts --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkRssiInDecibelMilliwatts ## -description Gets the signal strength of the network. ## -property-value The signal strength, expressed in dBm. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkRssiInDecibelMilliwatts +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.NetworkRssiInDecibelMilliwatts + +## -description +Gets the signal strength of the network. + +## -property-value +The signal strength, expressed in dBm. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_phykind.md b/windows.devices.wifi/wifiavailablenetwork_phykind.md index e57190f92e..493c08a826 100644 --- a/windows.devices.wifi/wifiavailablenetwork_phykind.md +++ b/windows.devices.wifi/wifiavailablenetwork_phykind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.PhyKind --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.PhyKind ## -description Gets a value describing the kind of PHY used by this network. ## -property-value A [WiFiPhyKind](wifiphykind.md) value indicating the PHY kind of the network. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.PhyKind +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.PhyKind + +## -description +Gets a value describing the kind of PHY used by this network. + +## -property-value +A [WiFiPhyKind](wifiphykind.md) value indicating the PHY kind of the network. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_securitysettings.md b/windows.devices.wifi/wifiavailablenetwork_securitysettings.md index 637e910802..88c7bf04db 100644 --- a/windows.devices.wifi/wifiavailablenetwork_securitysettings.md +++ b/windows.devices.wifi/wifiavailablenetwork_securitysettings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.SecuritySettings --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.SecuritySettings ## -description Gets the security configuration of the network. ## -property-value An Instance of [Windows.Networking.Connectivity.NetworkSecuritySettings](../windows.networking.connectivity/networksecuritysettings.md) describing the security configuration of the network. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.SecuritySettings +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.SecuritySettings + +## -description +Gets the security configuration of the network. + +## -property-value +An Instance of [Windows.Networking.Connectivity.NetworkSecuritySettings](../windows.networking.connectivity/networksecuritysettings.md) describing the security configuration of the network. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_signalbars.md b/windows.devices.wifi/wifiavailablenetwork_signalbars.md index 574e219948..8f6389b24a 100644 --- a/windows.devices.wifi/wifiavailablenetwork_signalbars.md +++ b/windows.devices.wifi/wifiavailablenetwork_signalbars.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.SignalBars --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.SignalBars ## -description Gets the strength of the signal as a number of bars. ## -property-value The current number of signal bars displayed by the Windows UI for the network. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.SignalBars +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.SignalBars + +## -description +Gets the strength of the signal as a number of bars. + +## -property-value +The current number of signal bars displayed by the Windows UI for the network. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_ssid.md b/windows.devices.wifi/wifiavailablenetwork_ssid.md index 4d8e68201c..2a74e6ec84 100644 --- a/windows.devices.wifi/wifiavailablenetwork_ssid.md +++ b/windows.devices.wifi/wifiavailablenetwork_ssid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.Ssid --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.Ssid ## -description Gets the SSID (name) of the network. ## -property-value The network SSID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.Ssid +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.Ssid + +## -description +Gets the SSID (name) of the network. + +## -property-value +The network SSID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifiavailablenetwork_uptime.md b/windows.devices.wifi/wifiavailablenetwork_uptime.md index c903725975..aab564f757 100644 --- a/windows.devices.wifi/wifiavailablenetwork_uptime.md +++ b/windows.devices.wifi/wifiavailablenetwork_uptime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.Uptime --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiAvailableNetwork.Uptime ## -description Gets the uptime value reported by the network. ## -property-value TimeSpan value representing the value of the Timestamp field from the 802.11 Beacon or Probe Response frame received by the wireless LAN interface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiAvailableNetwork.Uptime +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiAvailableNetwork.Uptime + +## -description +Gets the uptime value reported by the network. + +## -property-value +TimeSpan value representing the value of the Timestamp field from the 802.11 Beacon or Probe Response frame received by the wireless LAN interface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wificonnectionresult.md b/windows.devices.wifi/wificonnectionresult.md index 2105492d87..9ffe4aadf2 100644 --- a/windows.devices.wifi/wificonnectionresult.md +++ b/windows.devices.wifi/wificonnectionresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFi.WiFiConnectionResult --api-type: winrt class ---- # Windows.Devices.WiFi.WiFiConnectionResult ## -description Describes the results of an attempt to connect to a Wi-Fi network. ## -remarks An instance of this class is created and returned by the [WiFiAdapter.ConnectAsync](wifiadapter_connectasync.md) function. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFi.WiFiConnectionResult +-api-type: winrt class +--- + + + +# Windows.Devices.WiFi.WiFiConnectionResult + +## -description +Describes the results of an attempt to connect to a Wi-Fi network. + +## -remarks +An instance of this class is created and returned by the [WiFiAdapter.ConnectAsync](wifiadapter_connectasync.md) function. + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wificonnectionresult_connectionstatus.md b/windows.devices.wifi/wificonnectionresult_connectionstatus.md index adf0e42f7a..bc0e7b3887 100644 --- a/windows.devices.wifi/wificonnectionresult_connectionstatus.md +++ b/windows.devices.wifi/wificonnectionresult_connectionstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiConnectionResult.ConnectionStatus --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiConnectionResult.ConnectionStatus ## -description Gets the connection result value. ## -property-value Value describing the current status of the connection attempt. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiConnectionResult.ConnectionStatus +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiConnectionResult.ConnectionStatus + +## -description +Gets the connection result value. + +## -property-value +Value describing the current status of the connection attempt. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifinetworkreport.md b/windows.devices.wifi/wifinetworkreport.md index 8e6b9e1d4f..25f27f5d4c 100644 --- a/windows.devices.wifi/wifinetworkreport.md +++ b/windows.devices.wifi/wifinetworkreport.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFi.WiFiNetworkReport --api-type: winrt class ---- # Windows.Devices.WiFi.WiFiNetworkReport ## -description Contains the result of a network scan operation. ## -remarks The system creates an instance of this object when a network scan completes successfully and raises a [WiFiAdapter.AvailableNetworksChanged](wifiadapter_availablenetworkschanged.md) event. (You can initiate a network scan using the [WiFiAdapter.FindAllAdaptersAsync](wifiadapter_findalladaptersasync.md) static method or the [WiFiAdapter.ScanAsync](wifiadapter_scanasync.md) method on a particular adapter.) You can also retrieve the results of the most current scan from a given Wi-Fi adapter by getting the [WiFiAdapter.NetworkReport](wifiadapter_networkreport.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFi.WiFiNetworkReport +-api-type: winrt class +--- + + + +# Windows.Devices.WiFi.WiFiNetworkReport + +## -description +Contains the result of a network scan operation. + +## -remarks +The system creates an instance of this object when a network scan completes successfully and raises a [WiFiAdapter.AvailableNetworksChanged](wifiadapter_availablenetworkschanged.md) event. (You can initiate a network scan using the [WiFiAdapter.FindAllAdaptersAsync](wifiadapter_findalladaptersasync.md) static method or the [WiFiAdapter.ScanAsync](wifiadapter_scanasync.md) method on a particular adapter.) You can also retrieve the results of the most current scan from a given Wi-Fi adapter by getting the [WiFiAdapter.NetworkReport](wifiadapter_networkreport.md) property. + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifinetworkreport_availablenetworks.md b/windows.devices.wifi/wifinetworkreport_availablenetworks.md index 08f55823d5..6b026f62ef 100644 --- a/windows.devices.wifi/wifinetworkreport_availablenetworks.md +++ b/windows.devices.wifi/wifinetworkreport_availablenetworks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiNetworkReport.AvailableNetworks --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiNetworkReport.AvailableNetworks ## -description A list of available networks. ## -property-value A list of available networks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiNetworkReport.AvailableNetworks +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiNetworkReport.AvailableNetworks + +## -description +A list of available networks. + +## -property-value +A list of available networks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifi/wifinetworkreport_timestamp.md b/windows.devices.wifi/wifinetworkreport_timestamp.md index 3a004b9e70..5b3564dc63 100644 --- a/windows.devices.wifi/wifinetworkreport_timestamp.md +++ b/windows.devices.wifi/wifinetworkreport_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFi.WiFiNetworkReport.Timestamp --api-type: winrt property ---- # Windows.Devices.WiFi.WiFiNetworkReport.Timestamp ## -description Contains the result of a network scan operation. ## -property-value The date and time that the scan operation finished. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFi.WiFiNetworkReport.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiNetworkReport.Timestamp + +## -description +Contains the result of a network scan operation. + +## -property-value +The date and time that the scan operation finished. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice.md b/windows.devices.wifidirect.services/wifidirectservice.md index 1b724c2211..9cc4f3c59e 100644 --- a/windows.devices.wifidirect.services/wifidirectservice.md +++ b/windows.devices.wifidirect.services/wifidirectservice.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectService --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService ## -description Represents a Wi-Fi Direct service. This class is used by code on a device that seeks to use a Wi-Fi Direct Service, to establish a Wi-Fi Direct Service session with the service provider. ## -remarks This is one of several classes that support connecting two devices with a preference for which device should be the Group Owner. See the [Windows.Devices.WiFiDirect.Service](windows_devices_wifidirect_services.md) topic for a discussion of device pairing and how it can cause the Group Owner preference to be ignored (and how to fix that.) Your code does not instantiate this class directly. Instead, your code follows this process to get an instance of this class and use it to establish a Wi-Fi Direct Service session. 1. Use one of the [GetSelector](wifidirectservice_getselector.md) methods to get a query string for a particular service 1. Create a [DeviceWatcher](../windows.devices.enumeration/devicewatcher.md) that watches for Advertisers that match the query string. When an Advertiser is found, decide whether to use that Advertiser, either programmatically or by asking the user to indicate a choice. 1. Once your Seeker has identified the desired service advertiser, call the static [FromIdAsync](wifidirectservice_fromidasync.md) method with the Device ID of the chosen advertiser device. FromIdAsync retrieves an instance of [WiFiDirectService](wifidirectservice.md) for the requested service on the requested device. 1. Proceed to establish a session by calling [WiFiDirectService.ConnectAsync](wifidirectservice_connectasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectService +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService + +## -description +Represents a Wi-Fi Direct service. This class is used by code on a device that seeks to use a Wi-Fi Direct Service, to establish a Wi-Fi Direct Service session with the service provider. + +## -remarks +This is one of several classes that support connecting two devices with a preference for which device should be the Group Owner. See the [Windows.Devices.WiFiDirect.Service](windows_devices_wifidirect_services.md) topic for a discussion of device pairing and how it can cause the Group Owner preference to be ignored (and how to fix that.) + +Your code does not instantiate this class directly. Instead, your code follows this process to get an instance of this class and use it to establish a Wi-Fi Direct Service session. + + +1. Use one of the [GetSelector](wifidirectservice_getselector.md) methods to get a query string for a particular service +1. Create a [DeviceWatcher](../windows.devices.enumeration/devicewatcher.md) that watches for Advertisers that match the query string. When an Advertiser is found, decide whether to use that Advertiser, either programmatically or by asking the user to indicate a choice. +1. Once your Seeker has identified the desired service advertiser, call the static [FromIdAsync](wifidirectservice_fromidasync.md) method with the Device ID of the chosen advertiser device. FromIdAsync retrieves an instance of [WiFiDirectService](wifidirectservice.md) for the requested service on the requested device. +1. Proceed to establish a session by calling [WiFiDirectService.ConnectAsync](wifidirectservice_connectasync.md). + + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_connectasync_1379479827.md b/windows.devices.wifidirect.services/wifidirectservice_connectasync_1379479827.md index b38e6d0862..5c8b2fffdb 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_connectasync_1379479827.md +++ b/windows.devices.wifidirect.services/wifidirectservice_connectasync_1379479827.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync ## -description Initiates the establishment of a service session with the Wi-Fi Direct Service represented by this instance. ## -returns An asynchronous connection operation. When successfully completed, returns an object that represents the session that has been established. ## -remarks ## -examples ## -see-also [ConnectAsync(String)](wifidirectservice_connectasync_196659251.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync + +## -description +Initiates the establishment of a service session with the Wi-Fi Direct Service represented by this instance. + +## -returns +An asynchronous connection operation. When successfully completed, returns an object that represents the session that has been established. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync(String)](wifidirectservice_connectasync_196659251.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectservice_connectasync_196659251.md b/windows.devices.wifidirect.services/wifidirectservice_connectasync_196659251.md index 42364d0c51..da4023dfac 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_connectasync_196659251.md +++ b/windows.devices.wifidirect.services/wifidirectservice_connectasync_196659251.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync(System.String) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync ## -description Initiates the establishment of a service session with the Wi-Fi Direct Service represented by this instance, using a PIN to configure the session. ## -parameters ### -param pin The PIN to be used to configure the connection. ## -returns An asynchronous connection operation. When successfully completed, returns an object that represents the session that has been established. ## -remarks ## -examples ## -see-also [ConnectAsync](wifidirectservice_connectasync_1379479827.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.ConnectAsync + +## -description +Initiates the establishment of a service session with the Wi-Fi Direct Service represented by this instance, using a PIN to configure the session. + +## -parameters +### -param pin +The PIN to be used to configure the connection. + +## -returns +An asynchronous connection operation. When successfully completed, returns an object that represents the session that has been established. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync](wifidirectservice_connectasync_1379479827.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectservice_fromidasync_1322863552.md b/windows.devices.wifidirect.services/wifidirectservice_fromidasync_1322863552.md index eb330f22d3..7afc71f43a 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_fromidasync_1322863552.md +++ b/windows.devices.wifidirect.services/wifidirectservice_fromidasync_1322863552.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.FromIdAsync ## -description Static method that retrieves a WiFiDirectService instance for a Wi-Fi Direct Service offered by the device with a given device ID. ## -parameters ### -param deviceId Device ID of the device that advertises the desired Wi-Fi Direct Service. ## -returns An asynchronous retrieval operation. On successful completion, returns an instance of [WiFiDirectService](wifidirectservice.md) specific to the desired service instance, advertised by the indicated device. ## -remarks Your code retrieves Device IDs for service advertisers by using the search and enumeration methods in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.FromIdAsync + +## -description +Static method that retrieves a WiFiDirectService instance for a Wi-Fi Direct Service offered by the device with a given device ID. + +## -parameters +### -param deviceId +Device ID of the device that advertises the desired Wi-Fi Direct Service. + +## -returns +An asynchronous retrieval operation. On successful completion, returns an instance of [WiFiDirectService](wifidirectservice.md) specific to the desired service instance, advertised by the indicated device. + +## -remarks +Your code retrieves Device IDs for service advertisers by using the search and enumeration methods in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_getprovisioninginfoasync_628266286.md b/windows.devices.wifidirect.services/wifidirectservice_getprovisioninginfoasync_628266286.md index b05f2a77c3..4a1480e026 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_getprovisioninginfoasync_628266286.md +++ b/windows.devices.wifidirect.services/wifidirectservice_getprovisioninginfoasync_628266286.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetProvisioningInfoAsync(Windows.Devices.WiFiDirect.Services.WiFiDirectServiceConfigurationMethod) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetProvisioningInfoAsync ## -description Asynchronously retrieves Wi-Fi Direct Service session provisioning information. ## -parameters ### -param selectedConfigurationMethod The preferred method of configuring the session. ## -returns An asynchronous retrieval operation. On successful completion, returns provisioning information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetProvisioningInfoAsync(Windows.Devices.WiFiDirect.Services.WiFiDirectServiceConfigurationMethod) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetProvisioningInfoAsync + +## -description +Asynchronously retrieves Wi-Fi Direct Service session provisioning information. + +## -parameters +### -param selectedConfigurationMethod +The preferred method of configuring the session. + +## -returns +An asynchronous retrieval operation. On successful completion, returns provisioning information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_getselector_1490626236.md b/windows.devices.wifidirect.services/wifidirectservice_getselector_1490626236.md index c5acc0703c..cd5f67b754 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_getselector_1490626236.md +++ b/windows.devices.wifidirect.services/wifidirectservice_getselector_1490626236.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector(System.String) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector ## -description Gets an Advanced Query Syntax (AQS) string to be used to find Wi-Fi Direct Service advertisers for a particular service. ## -parameters ### -param serviceName The service name to be found. ## -returns The AQS string for the requested advertiser query. ## -remarks Your code uses AQS strings with the search and enumeration methods in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. ## -examples ## -see-also [GetSelector(String, IBuffer)](wifidirectservice_getselector_635955192.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector + +## -description +Gets an Advanced Query Syntax (AQS) string to be used to find Wi-Fi Direct Service advertisers for a particular service. + +## -parameters +### -param serviceName +The service name to be found. + +## -returns +The AQS string for the requested advertiser query. + +## -remarks +Your code uses AQS strings with the search and enumeration methods in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. + +## -examples + +## -see-also +[GetSelector(String, IBuffer)](wifidirectservice_getselector_635955192.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectservice_getselector_635955192.md b/windows.devices.wifidirect.services/wifidirectservice_getselector_635955192.md index c18a6aaeb1..8343f855f5 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_getselector_635955192.md +++ b/windows.devices.wifidirect.services/wifidirectservice_getselector_635955192.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector(System.String,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector ## -description Gets an Advanced Query Syntax (AQS) string to be used to find Wi-Fi Direct Service advertisers for a particular service, where a given byte sequence appears in the advertiser's service information blob. ## -parameters ### -param serviceName The service name to be found. ### -param serviceInfoFilter A byte sequence that must be found in the advertiser's service information blob. ## -returns The AQS string for the requested advertiser query. ## -remarks Your code uses AQS strings with the search and enumeration methods in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. ## -examples ## -see-also [GetSelector(String)](wifidirectservice_getselector_1490626236.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector(System.String,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.GetSelector + +## -description +Gets an Advanced Query Syntax (AQS) string to be used to find Wi-Fi Direct Service advertisers for a particular service, where a given byte sequence appears in the advertiser's service information blob. + +## -parameters +### -param serviceName +The service name to be found. + +### -param serviceInfoFilter +A byte sequence that must be found in the advertiser's service information blob. + +## -returns +The AQS string for the requested advertiser query. + +## -remarks +Your code uses AQS strings with the search and enumeration methods in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) namespace. + +## -examples + +## -see-also +[GetSelector(String)](wifidirectservice_getselector_1490626236.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectservice_prefergroupownermode.md b/windows.devices.wifidirect.services/wifidirectservice_prefergroupownermode.md index 5962db0795..6d7c641de7 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_prefergroupownermode.md +++ b/windows.devices.wifidirect.services/wifidirectservice_prefergroupownermode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.PreferGroupOwnerMode --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.PreferGroupOwnerMode ## -description Gets or sets a value specifying whether the service instance should choose Wi-Fi Direct Point to Point (P2P) Group Owner (GO) mode. ## -property-value When true, prefer GO mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.PreferGroupOwnerMode +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.PreferGroupOwnerMode + +## -description +Gets or sets a value specifying whether the service instance should choose Wi-Fi Direct Point to Point (P2P) Group Owner (GO) mode. + +## -property-value +When true, prefer GO mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_remoteserviceinfo.md b/windows.devices.wifidirect.services/wifidirectservice_remoteserviceinfo.md index 39cf96d9d5..39479df7b6 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_remoteserviceinfo.md +++ b/windows.devices.wifidirect.services/wifidirectservice_remoteserviceinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.RemoteServiceInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.RemoteServiceInfo ## -description Gets the service information blob from this service instance. ## -property-value A buffer of up to 255 bytes with information from the server. The format of this blob is determined by the individual service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.RemoteServiceInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.RemoteServiceInfo + +## -description +Gets the service information blob from this service instance. + +## -property-value +A buffer of up to 255 bytes with information from the server. The format of this blob is determined by the individual service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_serviceerror.md b/windows.devices.wifidirect.services/wifidirectservice_serviceerror.md index 037b3b0e15..db9cfb9848 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_serviceerror.md +++ b/windows.devices.wifidirect.services/wifidirectservice_serviceerror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.ServiceError --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.ServiceError ## -description Error information about the latest attempt to connect to the service. ## -property-value An enumeration value specifying the detailed reason for the failure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.ServiceError +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.ServiceError + +## -description +Error information about the latest attempt to connect to the service. + +## -property-value +An enumeration value specifying the detailed reason for the failure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_sessiondeferred.md b/windows.devices.wifidirect.services/wifidirectservice_sessiondeferred.md index 8bbb785735..e42cae3bcc 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_sessiondeferred.md +++ b/windows.devices.wifidirect.services/wifidirectservice_sessiondeferred.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionDeferred --api-type: winrt event ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionDeferred ## -description Event raised when a session request has been deferred. Note that this does not mean that the request has failed or been denied. It is a notification that the server is performing a long operation, such as waiting for a user to enter a PIN. The seeker that receives this message should begin a 120-second wait before it times out the session request, to give the server time to complete its operation. The event arguments include a buffer supplied by the server in the deferral notification with additional information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionDeferred +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionDeferred + +## -description +Event raised when a session request has been deferred. Note that this does not mean that the request has failed or been denied. It is a notification that the server is performing a long operation, such as waiting for a user to enter a PIN. The seeker that receives this message should begin a 120-second wait before it times out the session request, to give the server time to complete its operation. The event arguments include a buffer supplied by the server in the deferral notification with additional information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_sessioninfo.md b/windows.devices.wifidirect.services/wifidirectservice_sessioninfo.md index f17fc1f63d..2c88afd15e 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_sessioninfo.md +++ b/windows.devices.wifidirect.services/wifidirectservice_sessioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionInfo ## -description Gets or sets app-specific session information passed to the server when initiating a session. ## -property-value Session information. Format is determined by the individual service. Set this property before calling [ConnectAsync](wifidirectservice_connectasync.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.SessionInfo + +## -description +Gets or sets app-specific session information passed to the server when initiating a session. + +## -property-value +Session information. Format is determined by the individual service. Set this property before calling [ConnectAsync](wifidirectservice_connectasync.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservice_supportedconfigurationmethods.md b/windows.devices.wifidirect.services/wifidirectservice_supportedconfigurationmethods.md index 8c1c91f60b..cc4c5b5c94 100644 --- a/windows.devices.wifidirect.services/wifidirectservice_supportedconfigurationmethods.md +++ b/windows.devices.wifidirect.services/wifidirectservice_supportedconfigurationmethods.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.SupportedConfigurationMethods --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectService.SupportedConfigurationMethods ## -description Gets a list of supported configuration methods, ordered by preference. Your code uses [IVector](../windows.foundation.collections/ivector_1.md) operations to modify the contents of the list. ## -property-value Ordered list of configuration method enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectService.SupportedConfigurationMethods +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectService.SupportedConfigurationMethods + +## -description +Gets a list of supported configuration methods, ordered by preference. Your code uses [IVector](../windows.foundation.collections/ivector_1.md) operations to modify the contents of the list. + +## -property-value +Ordered list of configuration method enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser.md index 5b48471ce4..4e0da97f2e 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser ## -description Represents a Service Advertiser. This class is used by code on a device that advertises Wi-Fi Direct Services, to advertise the service. ## -remarks This is one of several classes that support connecting two devices with a preference for which device should be the Group Owner. See the [Windows.Devices.WiFiDirect.Service](windows_devices_wifidirect_services.md) topic for a discussion of device pairing and how it can cause the Group Owner preference to be ignored (and how to fix that.) The service name is set in the [WiFiDirectServiceAdvertiser](wifidirectserviceadvertiser_wifidirectserviceadvertiser.md) constructor. Service names are UTF-8 strings no more than 255 characters long. It is recommended that names use reverse domain name notation, where the service owner's DNS name (such as "contoso.com") is reversed and used as the beginning of the service name (such as "com.contoso.serviceX"). This convention is intended to make it easy to choose unique service names. Service names that start with "org.wi-fi.wfds" are reserved for use by the Wi-Fi Alliance, and you may not use such names for your service. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser + +## -description +Represents a Service Advertiser. This class is used by code on a device that advertises Wi-Fi Direct Services, to advertise the service. + +## -remarks +This is one of several classes that support connecting two devices with a preference for which device should be the Group Owner. See the [Windows.Devices.WiFiDirect.Service](windows_devices_wifidirect_services.md) topic for a discussion of device pairing and how it can cause the Group Owner preference to be ignored (and how to fix that.) + +The service name is set in the [WiFiDirectServiceAdvertiser](wifidirectserviceadvertiser_wifidirectserviceadvertiser.md) constructor. Service names are UTF-8 strings no more than 255 characters long. It is recommended that names use reverse domain name notation, where the service owner's DNS name (such as "contoso.com") is reversed and used as the beginning of the service name (such as "com.contoso.serviceX"). This convention is intended to make it easy to choose unique service names. Service names that start with "org.wi-fi.wfds" are reserved for use by the Wi-Fi Alliance, and you may not use such names for your service. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatus.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatus.md index 959734714f..65e3bc2c5c 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatus.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatus --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatus ## -description Gets a value that describes the current status of the advertisement. ## -property-value An enumeration value that describes current status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatus +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatus + +## -description +Gets a value that describes the current status of the advertisement. + +## -property-value +An enumeration value that describes current status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatuschanged.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatuschanged.md index 826e9fd5b6..61be721979 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatuschanged.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_advertisementstatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatusChanged --api-type: winrt event ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatusChanged ## -description Event raised when the [AdvertisementStatus](wifidirectserviceadvertiser_advertisementstatus.md) property value changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AdvertisementStatusChanged + +## -description +Event raised when the [AdvertisementStatus](wifidirectserviceadvertiser_advertisementstatus.md) property value changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsession.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsession.md index 98719f7d7a..e407ab8ceb 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsession.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsession.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSession --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSession ## -description Gets or sets the Auto Accept property for this service advertisement. ## -property-value When true, then the service automatically accepts all requests from service seekers to establish a session. If this value is false, then the service must actively accept a session request when the [SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event is raised. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSession +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSession + +## -description +Gets or sets the Auto Accept property for this service advertisement. + +## -property-value +When true, then the service automatically accepts all requests from service seekers to establish a session. If this value is false, then the service must actively accept a session request when the [SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event is raised. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsessionconnected.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsessionconnected.md index 675993b3d2..efad99e2ed 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsessionconnected.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_autoacceptsessionconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected --api-type: winrt event ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected ## -description Event raised when the service has automatically accepted a session request. Your event handler should establish socket connections for the endpoint pairs listed in the event arguments object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected + +## -description +Event raised when the service has automatically accepted a session request. Your event handler should establish socket connections for the endpoint pairs listed in the event arguments object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_2035670626.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_2035670626.md index 6ee7d38220..6dc19256b3 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_2035670626.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_2035670626.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync(Windows.Devices.Enumeration.DeviceInformation,System.String) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync ## -description Accepts a session request by connecting with the given PIN. ## -parameters ### -param deviceInfo Describes the device to be connected. Pass in the [WiFiDirectServiceSessionRequestedEventArgs.DeviceInformation](wifidirectservicesessionrequest_deviceinformation.md) property value. ### -param pin The PIN to be used to configure the session. ## -returns An asynchronous connection operation. On successful completion, returns an object that describes the session that has been created. ## -remarks ## -examples ## -see-also [ConnectAsync(DeviceInformation)](wifidirectserviceadvertiser_connectasync_900322270.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync(Windows.Devices.Enumeration.DeviceInformation,System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync + +## -description +Accepts a session request by connecting with the given PIN. + +## -parameters +### -param deviceInfo +Describes the device to be connected. Pass in the [WiFiDirectServiceSessionRequestedEventArgs.DeviceInformation](wifidirectservicesessionrequest_deviceinformation.md) property value. + +### -param pin +The PIN to be used to configure the session. + +## -returns +An asynchronous connection operation. On successful completion, returns an object that describes the session that has been created. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync(DeviceInformation)](wifidirectserviceadvertiser_connectasync_900322270.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_900322270.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_900322270.md index 73920c7a7f..4bdad23ebf 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_900322270.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_connectasync_900322270.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync(Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync ## -description Accepts a session request without requiring a PIN. ## -parameters ### -param deviceInfo Describes the device to be connected. Pass in the [WiFiDirectServiceSessionRequestedEventArgs.DeviceInformation](wifidirectservicesessionrequest_deviceinformation.md) property value. ## -returns An asynchronous connection operation. On successful completion, returns an object that describes the session that has been created. ## -remarks ## -examples ## -see-also [ConnectAsync(DeviceInformation, String)](wifidirectserviceadvertiser_connectasync_2035670626.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync(Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ConnectAsync + +## -description +Accepts a session request without requiring a PIN. + +## -parameters +### -param deviceInfo +Describes the device to be connected. Pass in the [WiFiDirectServiceSessionRequestedEventArgs.DeviceInformation](wifidirectservicesessionrequest_deviceinformation.md) property value. + +## -returns +An asynchronous connection operation. On successful completion, returns an object that describes the session that has been created. + +## -remarks + +## -examples + +## -see-also +[ConnectAsync(DeviceInformation, String)](wifidirectserviceadvertiser_connectasync_2035670626.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_customservicestatuscode.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_customservicestatuscode.md index eeda1dd93d..0c58cfbf10 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_customservicestatuscode.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_customservicestatuscode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.CustomServiceStatusCode --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.CustomServiceStatusCode ## -description Gets or sets a custom service status code. Only valid if the [ServiceStatus](wifidirectserviceadvertiser_servicestatus.md) property value is **Custom**. ## -property-value If [ServiceStatus](wifidirectserviceadvertiser_servicestatus.md) is set to **Custom**, this property is the custom status value. Custom values must be in the range 2 - 255. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.CustomServiceStatusCode +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.CustomServiceStatusCode + +## -description +Gets or sets a custom service status code. Only valid if the [ServiceStatus](wifidirectserviceadvertiser_servicestatus.md) property value is **Custom**. + +## -property-value +If [ServiceStatus](wifidirectserviceadvertiser_servicestatus.md) is set to **Custom**, this property is the custom status value. Custom values must be in the range 2 - 255. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_deferredsessioninfo.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_deferredsessioninfo.md index dd7d080742..1e5d6b740b 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_deferredsessioninfo.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_deferredsessioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.DeferredSessionInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.DeferredSessionInfo ## -description Gets or sets the service-specific information that is passed to a session requester when establishing a session will not be completed immediately, as when, for example, the service is waiting for user input to complete the request. A requester should implement a 120 second timeout when its request is deferred. ## -property-value The information to be sent to the session requester. Format is service-specific, and total size cannot exceed 144 bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.DeferredSessionInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.DeferredSessionInfo + +## -description +Gets or sets the service-specific information that is passed to a session requester when establishing a session will not be completed immediately, as when, for example, the service is waiting for user input to complete the request. A requester should implement a 120 second timeout when its request is deferred. + +## -property-value +The information to be sent to the session requester. Format is service-specific, and total size cannot exceed 144 bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_prefergroupownermode.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_prefergroupownermode.md index 149f1709f1..cdfa3d7ea1 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_prefergroupownermode.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_prefergroupownermode.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferGroupOwnerMode --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferGroupOwnerMode ## -description Gets or sets a value indicating whether the service requires that it be the Wi-Fi Direct Peer to Peer (P2P) Group Owner. Being the Group Owner enables the service to exercise more control over the P2P connection configuration and the connection process. For details, see the Wi-Fi Direct P2P Technical Specifications, available from the Wi-Fi Alliance. ## -property-value If true, the service must be the Group Owner (GO) of the Peer to Peer (P2P) connection between seeker and service. If false, the service will accept connections whether it is the GO or not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferGroupOwnerMode +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferGroupOwnerMode + +## -description +Gets or sets a value indicating whether the service requires that it be the Wi-Fi Direct Peer to Peer (P2P) Group Owner. + +Being the Group Owner enables the service to exercise more control over the P2P connection configuration and the connection process. For details, see the Wi-Fi Direct P2P Technical Specifications, available from the Wi-Fi Alliance. + +## -property-value +If true, the service must be the Group Owner (GO) of the Peer to Peer (P2P) connection between seeker and service. If false, the service will accept connections whether it is the GO or not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_preferredconfigurationmethods.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_preferredconfigurationmethods.md index 8985e53cc3..b53a0a1506 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_preferredconfigurationmethods.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_preferredconfigurationmethods.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferredConfigurationMethods --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferredConfigurationMethods ## -description Gets a list (that implements the [IVector](../windows.foundation.collections/ivector_1.md) interface) of preferred session configuration methods. Your code uses IVector operations on the list to add or remove elements from the list. ## -property-value An ordered list of enumeration values indicating preferred configuration methods. The earlier a configuration method appears in the list, the higher the preference for using that method when configuring sessions with this advertiser. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferredConfigurationMethods +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.PreferredConfigurationMethods + +## -description +Gets a list (that implements the [IVector](../windows.foundation.collections/ivector_1.md) interface) of preferred session configuration methods. Your code uses IVector operations on the list to add or remove elements from the list. + +## -property-value +An ordered list of enumeration values indicating preferred configuration methods. The earlier a configuration method appears in the list, the higher the preference for using that method when configuring sessions with this advertiser. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceerror.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceerror.md index 39f2f0a5ea..cfb4fe0bc9 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceerror.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceerror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceError --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceError ## -description Gets a specific error code when [AdvertisementStatus](wifidirectserviceadvertiser_advertisementstatus.md) is **Aborted**. ## -property-value An enumeration value that gives a more specific cause for [AdvertisementStatus](wifidirectserviceadvertiser_advertisementstatus.md) being **Aborted**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceError +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceError + +## -description +Gets a specific error code when [AdvertisementStatus](wifidirectserviceadvertiser_advertisementstatus.md) is **Aborted**. + +## -property-value +An enumeration value that gives a more specific cause for [AdvertisementStatus](wifidirectserviceadvertiser_advertisementstatus.md) being **Aborted**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceinfo.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceinfo.md index a3af8bb50c..ccccb78bef 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceinfo.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_serviceinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceInfo ## -description Gets or sets the service information blob. The format and contents of the blob are determined by the individual service, and are intended to be used by Seekers during service discovery. ## -property-value The service information blob. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceInfo + +## -description +Gets or sets the service information blob. The format and contents of the blob are determined by the individual service, and are intended to be used by Seekers during service discovery. + +## -property-value +The service information blob. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicename.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicename.md index 82bae06bf8..de95dd7b0b 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicename.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceName --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceName ## -description Gets the service name. ## -property-value The service name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceName +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceName + +## -description +Gets the service name. + +## -property-value +The service name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicenameprefixes.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicenameprefixes.md index eb4a2bd3dd..96b6780670 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicenameprefixes.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicenameprefixes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceNamePrefixes --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceNamePrefixes ## -description Gets a list of service name prefixes that should match this service when a seeker is using prefix searching. Your code uses [IVector](../windows.foundation.collections/ivector_1.md) methods to add or remove elements from the list. ## -property-value The list of prefixes. Prefix values ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceNamePrefixes +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceNamePrefixes + +## -description +Gets a list of service name prefixes that should match this service when a seeker is using prefix searching. Your code uses [IVector](../windows.foundation.collections/ivector_1.md) methods to add or remove elements from the list. + +## -property-value +The list of prefixes. Prefix values + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicestatus.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicestatus.md index ff2404b7af..5d4f30bb75 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicestatus.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_servicestatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceStatus --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceStatus ## -description Gets or sets the service status. ## -property-value An enumeration value that corresponds to the service status. Note that if this value is **Custom**, then the [CustomServiceStatusCode](wifidirectserviceadvertiser_customservicestatuscode.md) property gives the actual custom status code value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceStatus +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.ServiceStatus + +## -description +Gets or sets the service status. + +## -property-value +An enumeration value that corresponds to the service status. Note that if this value is **Custom**, then the [CustomServiceStatusCode](wifidirectserviceadvertiser_customservicestatuscode.md) property gives the actual custom status code value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_sessionrequested.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_sessionrequested.md index 76830b4c55..37903f3d2d 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_sessionrequested.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_sessionrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.SessionRequested --api-type: winrt event ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.SessionRequested ## -description Event raised when a Seeker has requested that a session be established with the service associated with this WiFiDirectServiceAdvertiser instance. To accept the request, call [WiFiDirectServiceAdvertiser.ConnectAsync](wifidirectserviceadvertiser_connectasync.md) in your event handler. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.SessionRequested +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.SessionRequested + +## -description +Event raised when a Seeker has requested that a session be established with the service associated with this WiFiDirectServiceAdvertiser instance. To accept the request, call [WiFiDirectServiceAdvertiser.ConnectAsync](wifidirectserviceadvertiser_connectasync.md) in your event handler. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_start_1587696324.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_start_1587696324.md index bd23f7c0dd..4dce0136ed 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_start_1587696324.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Start --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Start ## -description Starts advertising the service, using current property values to set the parameters of the advertisement. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Start +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Start + +## -description +Starts advertising the service, using current property values to set the parameters of the advertisement. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_stop_1201535524.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_stop_1201535524.md index ab17e28f48..bb22f0d06a 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_stop_1201535524.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Stop --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Stop ## -description Stops advertising the service. This does not affect existing sessions that are connected to the service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.Stop + +## -description +Stops advertising the service. This does not affect existing sessions that are connected to the service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_wifidirectserviceadvertiser_290278668.md b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_wifidirectserviceadvertiser_290278668.md index d92a904226..8f9cfb0bf6 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceadvertiser_wifidirectserviceadvertiser_290278668.md +++ b/windows.devices.wifidirect.services/wifidirectserviceadvertiser_wifidirectserviceadvertiser_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.#ctor(System.String) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.WiFiDirectServiceAdvertiser ## -description Creates an instance of the WiFiDirectServiceAdvertiser class. To start advertising a Wi-Fi Direct Service, create an instance of this class, set its properties appropriately for your service, and then call its [Start](wifidirectserviceadvertiser_start.md) method. ## -parameters ### -param serviceName The name of the service to be advertised. Service names are UTF-8 strings no more than 255 characters long. It is recommended that names use reverse domain name notation, where the service owner's DNS name (such as "contoso.com") is reversed and used as the beginning of the service name (such as "com.contoso.serviceX"). This convention is intended to make it easy to choose unique service names. Service names that start with "org.wi-fi.wfds" are reserved for use by the Wi-Fi Alliance, and you may not use such names for your service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAdvertiser.WiFiDirectServiceAdvertiser + +## -description +Creates an instance of the WiFiDirectServiceAdvertiser class. To start advertising a Wi-Fi Direct Service, create an instance of this class, set its properties appropriately for your service, and then call its [Start](wifidirectserviceadvertiser_start.md) method. + +## -parameters +### -param serviceName +The name of the service to be advertised. Service names are UTF-8 strings no more than 255 characters long. It is recommended that names use reverse domain name notation, where the service owner's DNS name (such as "contoso.com") is reversed and used as the beginning of the service name (such as "com.contoso.serviceX"). This convention is intended to make it easy to choose unique service names. Service names that start with "org.wi-fi.wfds" are reserved for use by the Wi-Fi Alliance, and you may not use such names for your service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs.md b/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs.md index a308ef817b..4fc60d01da 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs.md +++ b/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs ## -description Returned when a [WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected](wifidirectserviceadvertiser_autoacceptsessionconnected.md) event is raised. ## -remarks Your code does not instantiate this class directly. An instance is passed as an argument to your [WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected](wifidirectserviceadvertiser_autoacceptsessionconnected.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs + +## -description +Returned when a [WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected](wifidirectserviceadvertiser_autoacceptsessionconnected.md) event is raised. + +## -remarks +Your code does not instantiate this class directly. An instance is passed as an argument to your [WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected](wifidirectserviceadvertiser_autoacceptsessionconnected.md) event handler. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_session.md b/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_session.md index 105cdfec38..db02b23f44 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_session.md +++ b/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.Session --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.Session ## -description Gets the [WiFiDirectServiceSession](wifidirectservicesession.md) that was created when the connection was automatically accepted. ## -property-value The session object corresponding to this automatically accepted connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.Session +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.Session + +## -description +Gets the [WiFiDirectServiceSession](wifidirectservicesession.md) that was created when the connection was automatically accepted. + +## -property-value +The session object corresponding to this automatically accepted connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_sessioninfo.md b/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_sessioninfo.md index 3339b237bf..4d4dfb628d 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_sessioninfo.md +++ b/windows.devices.wifidirect.services/wifidirectserviceautoacceptsessionconnectedeventargs_sessioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.SessionInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.SessionInfo ## -description Gets the session information buffer that corresponds to this automatically accepted connection. ## -property-value Service-specific session information, up to 144 bytes. Can be NULL if the service provides no session information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.SessionInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceAutoAcceptSessionConnectedEventArgs.SessionInfo + +## -description +Gets the session information buffer that corresponds to this automatically accepted connection. + +## -property-value +Service-specific session information, up to 144 bytes. Can be NULL if the service provides no session information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo.md b/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo.md index 0b84a9f0a6..0a251950e1 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo.md +++ b/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo ## -description Contains provisioning information about a Wi-Fi Direct Service. ## -remarks Your code does not instantiate this class directly. You can retrieve an instance using either the [WiFiDirectServiceSessionRequest.ProvisioningInfo](wifidirectservicesessionrequest_provisioninginfo.md) property or the [WiFiDirectService.GetProvisioningInfoAsync](wifidirectservice_getprovisioninginfoasync.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo + +## -description +Contains provisioning information about a Wi-Fi Direct Service. + +## -remarks +Your code does not instantiate this class directly. You can retrieve an instance using either the [WiFiDirectServiceSessionRequest.ProvisioningInfo](wifidirectservicesessionrequest_provisioninginfo.md) property or the [WiFiDirectService.GetProvisioningInfoAsync](wifidirectservice_getprovisioninginfoasync.md) method. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_isgroupformationneeded.md b/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_isgroupformationneeded.md index 1e640ae30c..7ee12d7e0b 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_isgroupformationneeded.md +++ b/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_isgroupformationneeded.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.IsGroupFormationNeeded --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.IsGroupFormationNeeded ## -description Gets a value indicating whether Wi-Fi Direct Point to Point (P2P) group formation is needed. ## -property-value When true, group formation is needed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.IsGroupFormationNeeded +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.IsGroupFormationNeeded + +## -description +Gets a value indicating whether Wi-Fi Direct Point to Point (P2P) group formation is needed. + +## -property-value +When true, group formation is needed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_selectedconfigurationmethod.md b/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_selectedconfigurationmethod.md index 1d1578f7ee..97816451b9 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_selectedconfigurationmethod.md +++ b/windows.devices.wifidirect.services/wifidirectserviceprovisioninginfo_selectedconfigurationmethod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.SelectedConfigurationMethod --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.SelectedConfigurationMethod ## -description Gets a value describing the configuration method in use. ## -property-value Enumeration value representing the configuration method in use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.SelectedConfigurationMethod +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceProvisioningInfo.SelectedConfigurationMethod + +## -description +Gets a value describing the configuration method in use. + +## -property-value +Enumeration value representing the configuration method in use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs.md b/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs.md index 1174a4236f..7319cae2eb 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs.md +++ b/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs ## -description Returned when a [WiFiDirectServiceSession.RemotePortAdded](wifidirectservicesession_remoteportadded.md) event is raised. Your event handler should use this information to establish new socket connections to the new port. ## -remarks Your code does not instantiate this class directly. An instance is passed as an argument to your [WiFiDirectServiceSession.RemotePortAdded](wifidirectservicesession_remoteportadded.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs + +## -description +Returned when a [WiFiDirectServiceSession.RemotePortAdded](wifidirectservicesession_remoteportadded.md) event is raised. Your event handler should use this information to establish new socket connections to the new port. + +## -remarks +Your code does not instantiate this class directly. An instance is passed as an argument to your [WiFiDirectServiceSession.RemotePortAdded](wifidirectservicesession_remoteportadded.md) event handler. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_endpointpairs.md b/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_endpointpairs.md index e66a35f81b..5512607afd 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_endpointpairs.md +++ b/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_endpointpairs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.EndpointPairs --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.EndpointPairs ## -description Gets the endpoint pairs associated with the new remote port. ## -property-value New endpoint pairs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.EndpointPairs +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.EndpointPairs + +## -description +Gets the endpoint pairs associated with the new remote port. + +## -property-value +New endpoint pairs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_protocol.md b/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_protocol.md index 7754d028e6..b77a7d11d1 100644 --- a/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_protocol.md +++ b/windows.devices.wifidirect.services/wifidirectserviceremoteportaddedeventargs_protocol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.Protocol --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.Protocol ## -description Gets the protocol used to communicate with the new remote port. ## -property-value An enumeration value corresponding to the IP protocol to use for the new remote port. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.Protocol +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceRemotePortAddedEventArgs.Protocol + +## -description +Gets the protocol used to communicate with the new remote port. + +## -property-value +An enumeration value corresponding to the IP protocol to use for the new remote port. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession.md b/windows.devices.wifidirect.services/wifidirectservicesession.md index 3b9fcf5749..c08e4c17d7 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession ## -description Represents a Wi-Fi Direct Services (WFDS) session. ## -remarks Your code does not instantiate this class directly. An instance is created and passed to your code in event handlers when a new session is created or session state changes. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession + +## -description +Represents a Wi-Fi Direct Services (WFDS) session. + +## -remarks +Your code does not instantiate this class directly. An instance is created and passed to your code in event handlers when a new session is created or session state changes. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_adddatagramsocketasync_903878578.md b/windows.devices.wifidirect.services/wifidirectservicesession_adddatagramsocketasync_903878578.md index b9c24ef7df..ccbfc220ad 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_adddatagramsocketasync_903878578.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_adddatagramsocketasync_903878578.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddDatagramSocketAsync(Windows.Networking.Sockets.DatagramSocket) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddDatagramSocketAsync ## -description Adds a [DatagramSocket](../windows.networking.sockets/datagramsocket.md) to the session. Your code creates the DatagramSocket before calling this method. Associating a socket to the session causes port information to be sent to the remote device(s) in the session. (In terms of this API, a [RemotePortAdded](wifidirectservicesession_remoteportadded.md) event is raised on each remote device in the session, specifying the UDP protocol.) A remote device can use that information to open a socket and connect back to the local machine. ## -parameters ### -param value The DatagramSocket instance to associate with this session. ## -returns An asynchronous association action. Returns on successful completion of the association. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddDatagramSocketAsync(Windows.Networking.Sockets.DatagramSocket) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddDatagramSocketAsync + +## -description +Adds a [DatagramSocket](../windows.networking.sockets/datagramsocket.md) to the session. Your code creates the DatagramSocket before calling this method. Associating a socket to the session causes port information to be sent to the remote device(s) in the session. (In terms of this API, a [RemotePortAdded](wifidirectservicesession_remoteportadded.md) event is raised on each remote device in the session, specifying the UDP protocol.) A remote device can use that information to open a socket and connect back to the local machine. + +## -parameters +### -param value +The DatagramSocket instance to associate with this session. + +## -returns +An asynchronous association action. Returns on successful completion of the association. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_addstreamsocketlistenerasync_1369574118.md b/windows.devices.wifidirect.services/wifidirectservicesession_addstreamsocketlistenerasync_1369574118.md index 293e452bc7..37e4ef6377 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_addstreamsocketlistenerasync_1369574118.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_addstreamsocketlistenerasync_1369574118.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddStreamSocketListenerAsync(Windows.Networking.Sockets.StreamSocketListener) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddStreamSocketListenerAsync ## -description Adds a [StreamSocketListener](../windows.networking.sockets/streamsocketlistener.md) to the session. Your code creates the StreamSocketListener before calling this method. Associating a socket to the session causes port information to be sent to the remote device(s) in the session. (In terms of this API, a [RemotePortAdded](wifidirectservicesession_remoteportadded.md) event is raised on each remote device in the session, specifying the TCP protocol.) A remote device can use that information to open a socket and connect back to the local machine. ## -parameters ### -param value The StreamSocketListener instance to be associated with the session. ## -returns An asynchronous association action. Returns on successful completion of the association. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddStreamSocketListenerAsync(Windows.Networking.Sockets.StreamSocketListener) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AddStreamSocketListenerAsync + +## -description +Adds a [StreamSocketListener](../windows.networking.sockets/streamsocketlistener.md) to the session. Your code creates the StreamSocketListener before calling this method. Associating a socket to the session causes port information to be sent to the remote device(s) in the session. (In terms of this API, a [RemotePortAdded](wifidirectservicesession_remoteportadded.md) event is raised on each remote device in the session, specifying the TCP protocol.) A remote device can use that information to open a socket and connect back to the local machine. + +## -parameters +### -param value +The StreamSocketListener instance to be associated with the session. + +## -returns +An asynchronous association action. Returns on successful completion of the association. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_advertisementid.md b/windows.devices.wifidirect.services/wifidirectservicesession_advertisementid.md index daf27751e5..cd5baa1a5d 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_advertisementid.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_advertisementid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AdvertisementId --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AdvertisementId ## -description Gets the advertisement ID for the session. ## -property-value The advertisement ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AdvertisementId +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.AdvertisementId + +## -description +Gets the advertisement ID for the session. + +## -property-value +The advertisement ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_close_811482585.md b/windows.devices.wifidirect.services/wifidirectservicesession_close_811482585.md index 9b5d69f958..84ee8f9a8a 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_close_811482585.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Close --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Close ## -description Closes the session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Close +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Close + +## -description +Closes the session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_errorstatus.md b/windows.devices.wifidirect.services/wifidirectservicesession_errorstatus.md index b0513fdb14..4c3bb96ff9 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_errorstatus.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_errorstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ErrorStatus --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ErrorStatus ## -description Gets the error status of the session. ## -property-value An enumeration value giving session error status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ErrorStatus +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ErrorStatus + +## -description +Gets the error status of the session. + +## -property-value +An enumeration value giving session error status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_getconnectionendpointpairs_1958888015.md b/windows.devices.wifidirect.services/wifidirectservicesession_getconnectionendpointpairs_1958888015.md index 8106642846..48bc4ed653 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_getconnectionendpointpairs_1958888015.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_getconnectionendpointpairs_1958888015.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.GetConnectionEndpointPairs --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.GetConnectionEndpointPairs ## -description Gets a list of connection endpoint pairs for the session. Your code uses [IVectorView](../windows.foundation.collections/ivectorview_1.md) operations to enumerate the endpoint pairs in the list. ## -returns An immutable snapshot list of endpoint pairs involved in the session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.GetConnectionEndpointPairs +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.GetConnectionEndpointPairs + +## -description +Gets a list of connection endpoint pairs for the session. Your code uses [IVectorView](../windows.foundation.collections/ivectorview_1.md) operations to enumerate the endpoint pairs in the list. + +## -returns +An immutable snapshot list of endpoint pairs involved in the session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_remoteportadded.md b/windows.devices.wifidirect.services/wifidirectservicesession_remoteportadded.md index d03bc701bb..fa8b861645 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_remoteportadded.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_remoteportadded.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.RemotePortAdded --api-type: winrt event ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.RemotePortAdded ## -description Event raised when a new remote port is added to the session. Your event handler should respond by establishing the appropriate socket connection to the new remote port. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.RemotePortAdded +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.RemotePortAdded + +## -description +Event raised when a new remote port is added to the session. Your event handler should respond by establishing the appropriate socket connection to the new remote port. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_serviceaddress.md b/windows.devices.wifidirect.services/wifidirectservicesession_serviceaddress.md index 048e2782ea..6187478ddb 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_serviceaddress.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_serviceaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceAddress --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceAddress ## -description Gets the service address for this session. ## -property-value The service address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceAddress +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceAddress + +## -description +Gets the service address for this session. + +## -property-value +The service address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_servicename.md b/windows.devices.wifidirect.services/wifidirectservicesession_servicename.md index e9333ad206..d5db6c8005 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_servicename.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_servicename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceName --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceName ## -description Gets the service name of the advertiser service involved in the session. ## -property-value The service name of the advertiser service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceName +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.ServiceName + +## -description +Gets the service name of the advertiser service involved in the session. + +## -property-value +The service name of the advertiser service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_sessionaddress.md b/windows.devices.wifidirect.services/wifidirectservicesession_sessionaddress.md index 53a04cca60..7fdcbc65bb 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_sessionaddress.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_sessionaddress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionAddress --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionAddress ## -description Gets the session address for the session. ## -property-value The session address. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionAddress +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionAddress + +## -description +Gets the session address for the session. + +## -property-value +The session address. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_sessionid.md b/windows.devices.wifidirect.services/wifidirectservicesession_sessionid.md index af12dbccb5..b215726ee1 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_sessionid.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_sessionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionId --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionId ## -description Gets the session ID. ## -property-value A unique session identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionId +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionId + +## -description +Gets the session ID. + +## -property-value +A unique session identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_sessionstatuschanged.md b/windows.devices.wifidirect.services/wifidirectservicesession_sessionstatuschanged.md index 1d3e5aea9f..0ad6205bf3 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_sessionstatuschanged.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_sessionstatuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionStatusChanged --api-type: winrt event ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionStatusChanged ## -description Event raised when the session status changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.SessionStatusChanged + +## -description +Event raised when the session status changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesession_status.md b/windows.devices.wifidirect.services/wifidirectservicesession_status.md index e81c9b7e84..d86a0f6c3a 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesession_status.md +++ b/windows.devices.wifidirect.services/wifidirectservicesession_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Status --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Status ## -description Gets the session status. ## -property-value An enumeration value describing the current session status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Status +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSession.Status + +## -description +Gets the session status. + +## -property-value +An enumeration value describing the current session status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs.md b/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs.md index a34f1c0c38..66dac09161 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs ## -description Returned when a [WiFiDirectService.SessionDeferred](wifidirectservice_sessiondeferred.md) event is raised. ## -remarks Your code does not instantiate this class directly. An instance of this class is passed as an argument to your [WiFiDirectService.SessionDeferred](wifidirectservice_sessiondeferred.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs + +## -description +Returned when a [WiFiDirectService.SessionDeferred](wifidirectservice_sessiondeferred.md) event is raised. + +## -remarks +Your code does not instantiate this class directly. An instance of this class is passed as an argument to your [WiFiDirectService.SessionDeferred](wifidirectservice_sessiondeferred.md) event handler. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs_deferredsessioninfo.md b/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs_deferredsessioninfo.md index c28d163428..7dea0dffac 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs_deferredsessioninfo.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessiondeferredeventargs_deferredsessioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs.DeferredSessionInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs.DeferredSessionInfo ## -description Gets the service-defined session information returned by the service when it sends a deferral in response to a connection request. Note that a deferral does not indicate that the connection is refused. Rather, it indicates that the server is performing a time-consuming operation such as requesting user input. A seeker should implement a 120-second timeout after getting a deferral before giving up on the request. ## -property-value A byte sequence of deferred session information, up to 144 bytes. Format is defined by the service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs.DeferredSessionInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionDeferredEventArgs.DeferredSessionInfo + +## -description +Gets the service-defined session information returned by the service when it sends a deferral in response to a connection request. Note that a deferral does not indicate that the connection is refused. Rather, it indicates that the server is performing a time-consuming operation such as requesting user input. A seeker should implement a 120-second timeout after getting a deferral before giving up on the request. + +## -property-value +A byte sequence of deferred session information, up to 144 bytes. Format is defined by the service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequest.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequest.md index 52d63e2077..0290153a75 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequest.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequest.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest ## -description Describes a Wi-Fi Direct Service session request. ## -remarks Your code does not instantiate this class directly. An instance of this class is inside the [WiFiDirectServiceSessionRequestedEventArgs](wifidirectservicesessionrequestedeventargs.md) object passed to your [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event handler. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest + +## -description +Describes a Wi-Fi Direct Service session request. + +## -remarks +Your code does not instantiate this class directly. An instance of this class is inside the [WiFiDirectServiceSessionRequestedEventArgs](wifidirectservicesessionrequestedeventargs.md) object passed to your [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event handler. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_close_811482585.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_close_811482585.md index cfb2effacb..9bc24b0f36 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_close_811482585.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.Close --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.Close ## -description Closes the session request. Your server code calls this method to reject a session request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.Close +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.Close + +## -description +Closes the session request. Your server code calls this method to reject a session request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_deviceinformation.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_deviceinformation.md index 63c58aa844..e2060852fd 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_deviceinformation.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.DeviceInformation --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.DeviceInformation ## -description Gets device information for the requesting device. ## -property-value Describes the requesting device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.DeviceInformation + +## -description +Gets device information for the requesting device. + +## -property-value +Describes the requesting device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_provisioninginfo.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_provisioninginfo.md index 23c8a63a87..91bcaa6991 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_provisioninginfo.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_provisioninginfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.ProvisioningInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.ProvisioningInfo ## -description Gets information about how provisioning should be performed if the session is established. ## -property-value Provisioning information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.ProvisioningInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.ProvisioningInfo + +## -description +Gets information about how provisioning should be performed if the session is established. + +## -property-value +Provisioning information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_sessioninfo.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_sessioninfo.md index 3361a4693d..dab9abe8fb 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequest_sessioninfo.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequest_sessioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.SessionInfo --api-type: winrt property ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.SessionInfo ## -description Gets the session information blob associated with this request. ## -property-value A byte sequence, up to 144 bytes. The format is defined by the service. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.SessionInfo +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequest.SessionInfo + +## -description +Gets the session information blob associated with this request. + +## -property-value +A byte sequence, up to 144 bytes. The format is defined by the service. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs.md index 6d7a7c233f..e1b4ea1110 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs ## -description Returned when a [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event is raised. ## -remarks Your code does not instantiate this class directly. An instance is passed as an argument to your [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs + +## -description +Returned when a [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event is raised. + +## -remarks +Your code does not instantiate this class directly. An instance is passed as an argument to your [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event handler. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs_getsessionrequest_1327265926.md b/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs_getsessionrequest_1327265926.md index 548a092ffe..f632f8cead 100644 --- a/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs_getsessionrequest_1327265926.md +++ b/windows.devices.wifidirect.services/wifidirectservicesessionrequestedeventargs_getsessionrequest_1327265926.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs.GetSessionRequest --api-type: winrt method ---- # Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs.GetSessionRequest ## -description Gets information about the session request that raised a [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event. ## -returns Information about a new session request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs.GetSessionRequest +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.Services.WiFiDirectServiceSessionRequestedEventArgs.GetSessionRequest + +## -description +Gets information about the session request that raised a [WiFiDirectServiceAdvertiser.SessionRequested](wifidirectserviceadvertiser_sessionrequested.md) event. + +## -returns +Information about a new session request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectadvertisement.md b/windows.devices.wifidirect/wifidirectadvertisement.md index 555f41344c..d291b92fbc 100644 --- a/windows.devices.wifidirect/wifidirectadvertisement.md +++ b/windows.devices.wifidirect/wifidirectadvertisement.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisement ## -description Represent a Wi-Fi Direct advertisement and allows the app to control the listen state and custom information elements in the advertisement. ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisement + +## -description +Represent a Wi-Fi Direct advertisement and allows the app to control the listen state and custom information elements in the advertisement. + +## -remarks + + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisement_informationelements.md b/windows.devices.wifidirect/wifidirectadvertisement_informationelements.md index f02af912af..9ec18e365e 100644 --- a/windows.devices.wifidirect/wifidirectadvertisement_informationelements.md +++ b/windows.devices.wifidirect/wifidirectadvertisement_informationelements.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.InformationElements --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.InformationElements ## -description Information elements to advertise in the Wi-Fi Direct advertisement. ## -property-value Information elements to advertise. ## -remarks The default value for this property is **NULL**. ## -examples ## -see-also [WiFiDirectInformationElement](wifidirectinformationelement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.InformationElements +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.InformationElements + +## -description +Information elements to advertise in the Wi-Fi Direct advertisement. + +## -property-value +Information elements to advertise. + +## -remarks +The default value for this property is **NULL**. + +## -examples + +## -see-also +[WiFiDirectInformationElement](wifidirectinformationelement.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisement_isautonomousgroupownerenabled.md b/windows.devices.wifidirect/wifidirectadvertisement_isautonomousgroupownerenabled.md index 8f75488828..0927562170 100644 --- a/windows.devices.wifidirect/wifidirectadvertisement_isautonomousgroupownerenabled.md +++ b/windows.devices.wifidirect/wifidirectadvertisement_isautonomousgroupownerenabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.IsAutonomousGroupOwnerEnabled --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.IsAutonomousGroupOwnerEnabled ## -description Whether autonomous group owner will be enabled. ## -property-value Whether autonomous group owner will be enabled. ## -remarks The default value for this property is **FALSE**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.IsAutonomousGroupOwnerEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.IsAutonomousGroupOwnerEnabled + +## -description +Whether autonomous group owner will be enabled. + +## -property-value +Whether autonomous group owner will be enabled. + +## -remarks +The default value for this property is **FALSE**. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectadvertisement_legacysettings.md b/windows.devices.wifidirect/wifidirectadvertisement_legacysettings.md index c491b03524..71908741c9 100644 --- a/windows.devices.wifidirect/wifidirectadvertisement_legacysettings.md +++ b/windows.devices.wifidirect/wifidirectadvertisement_legacysettings.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.LegacySettings --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.LegacySettings ## -description Gets the settings object for "legacy" (non-Wi-Fi Direct) connections. ## -property-value The legacy settings object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.LegacySettings +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.LegacySettings + +## -description +Gets the settings object for "legacy" (non-Wi-Fi Direct) connections. + +## -property-value +The legacy settings object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectadvertisement_listenstatediscoverability.md b/windows.devices.wifidirect/wifidirectadvertisement_listenstatediscoverability.md index b446cb395d..87aaa100c5 100644 --- a/windows.devices.wifidirect/wifidirectadvertisement_listenstatediscoverability.md +++ b/windows.devices.wifidirect/wifidirectadvertisement_listenstatediscoverability.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.ListenStateDiscoverability --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.ListenStateDiscoverability ## -description Gets or sets the listen state and whether the Wi-Fi Direct device is discoverable. ## -property-value The listen state and whether the Wi-Fi Direct device is discoverable. ## -remarks The default value for this property is **None** (not discoverable). ## -examples ## -see-also [WiFiDirectAdvertisementListenStateDiscoverability](wifidirectadvertisementlistenstatediscoverability.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.ListenStateDiscoverability +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.ListenStateDiscoverability + +## -description +Gets or sets the listen state and whether the Wi-Fi Direct device is discoverable. + +## -property-value +The listen state and whether the Wi-Fi Direct device is discoverable. + +## -remarks +The default value for this property is **None** (not discoverable). + +## -examples + +## -see-also +[WiFiDirectAdvertisementListenStateDiscoverability](wifidirectadvertisementlistenstatediscoverability.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisement_supportedconfigurationmethods.md b/windows.devices.wifidirect/wifidirectadvertisement_supportedconfigurationmethods.md index 4ed7144a2e..21f6582a4f 100644 --- a/windows.devices.wifidirect/wifidirectadvertisement_supportedconfigurationmethods.md +++ b/windows.devices.wifidirect/wifidirectadvertisement_supportedconfigurationmethods.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.SupportedConfigurationMethods --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.SupportedConfigurationMethods ## -description Gets a device's supported configuration methods. When two devices are attempting to connect, their preferred pairing procedures and supported configuration methods are used to determine how pairing is accomplished. ## -property-value A list of [WiFiDirectConfigurationMethod](wifidirectconfigurationmethod.md) values representing supported configuration methods. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.SupportedConfigurationMethods +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisement.SupportedConfigurationMethods + +## -description +Gets a device's supported configuration methods. + +When two devices are attempting to connect, their preferred pairing procedures and supported configuration methods are used to determine how pairing is accomplished. + +## -property-value +A list of [WiFiDirectConfigurationMethod](wifidirectconfigurationmethod.md) values representing supported configuration methods. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher.md index 7d5f731522..79ea2a3517 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher ## -description An object to publish Wi-Fi Direct advertisements. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher + +## -description +An object to publish Wi-Fi Direct advertisements. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher_advertisement.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher_advertisement.md index b9ab382b33..c048cce118 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher_advertisement.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher_advertisement.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Advertisement --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Advertisement ## -description Gets the Wi-Fi Direct advertisement to publish. ## -property-value The Wi-Fi Direct advertisement to publish. ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Advertisement +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Advertisement + +## -description +Gets the Wi-Fi Direct advertisement to publish. + +## -property-value +The Wi-Fi Direct advertisement to publish. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher_start_1587696324.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher_start_1587696324.md index b32637d851..737790a787 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher_start_1587696324.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher_start_1587696324.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Start --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Start ## -description Starts the Wi-Fi Direct advertisement. ## -remarks The status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) will transition to the **Started** state or to the **Aborted** state if the request failed immediately due to an error. The [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) will be automatically stopped when an app is suspended if the [ListenStateDiscoverability](wifidirectadvertisement_listenstatediscoverability.md) property on the [WiFiDirectAdvertisement](wifidirectadvertisement.md) is set to **Normal**. ## -examples ## -see-also [WiFiDirectAdvertisement](wifidirectadvertisement.md), [WiFiDirectAdvertisement.ListenStateDiscoverability](wifidirectadvertisement_listenstatediscoverability.md), [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Start +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Start + +## -description +Starts the Wi-Fi Direct advertisement. + +## -remarks +The status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) will transition to the **Started** state or to the **Aborted** state if the request failed immediately due to an error. + +The [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) will be automatically stopped when an app is suspended if the [ListenStateDiscoverability](wifidirectadvertisement_listenstatediscoverability.md) property on the [WiFiDirectAdvertisement](wifidirectadvertisement.md) is set to **Normal**. + +## -examples + +## -see-also +[WiFiDirectAdvertisement](wifidirectadvertisement.md), [WiFiDirectAdvertisement.ListenStateDiscoverability](wifidirectadvertisement_listenstatediscoverability.md), [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher_status.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher_status.md index b2c8010760..7a8f2d9de0 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher_status.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Status --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Status ## -description Gets the current status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -property-value The current status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Status +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Status + +## -description +Gets the current status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -property-value +The current status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -remarks + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher_statuschanged.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher_statuschanged.md index 5a79304fb9..8b4e270ceb 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher_statuschanged.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher_statuschanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.StatusChanged --api-type: winrt event ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.StatusChanged ## -description Notification that the status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) has changed. ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisementPublisher.Start](wifidirectadvertisementpublisher_start.md), [WiFiDirectAdvertisementPublisher.Status](wifidirectadvertisementpublisher_status.md), [WiFiDirectAdvertisementPublisher.Stop](wifidirectadvertisementpublisher_stop.md), [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.StatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.StatusChanged + +## -description +Notification that the status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) has changed. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisher.Start](wifidirectadvertisementpublisher_start.md), [WiFiDirectAdvertisementPublisher.Status](wifidirectadvertisementpublisher_status.md), [WiFiDirectAdvertisementPublisher.Stop](wifidirectadvertisementpublisher_stop.md), [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher_stop_1201535524.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher_stop_1201535524.md index 7b3a8cdbb7..196949ed15 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher_stop_1201535524.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher_stop_1201535524.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Stop --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Stop ## -description Stops the Wi-Fi Direct advertisement. ## -remarks Calling the [Stop](wifidirectadvertisementpublisher_stop.md) method in the **Stopped** or **Aborted** state has no effect. ## -examples ## -see-also [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.Stop + +## -description +Stops the Wi-Fi Direct advertisement. + +## -remarks +Calling the [Stop](wifidirectadvertisementpublisher_stop.md) method in the **Stopped** or **Aborted** state has no effect. + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisher_wifidirectadvertisementpublisher_1221375020.md b/windows.devices.wifidirect/wifidirectadvertisementpublisher_wifidirectadvertisementpublisher_1221375020.md index 19c7f43d12..464bf8eca1 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisher_wifidirectadvertisementpublisher_1221375020.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisher_wifidirectadvertisementpublisher_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.#ctor --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.WiFiDirectAdvertisementPublisher ## -description Creates a new [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisher.WiFiDirectAdvertisementPublisher + +## -description +Creates a new [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs.md b/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs.md index 02fd48bc0b..c109875dbc 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs ## -description Provides data for a [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -remarks A [WiFiDirectAdvertisementPublisherStatusChangedEventArgs](wifidirectadvertisementpublisherstatuschangedeventargs.md) instance is created when the [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event occurs on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) object. ## -examples ## -see-also [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md), [WiFiDirectAdvertisementPublisher.StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs + +## -description +Provides data for a [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -remarks +A [WiFiDirectAdvertisementPublisherStatusChangedEventArgs](wifidirectadvertisementpublisherstatuschangedeventargs.md) instance is created when the [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event occurs on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) object. + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md), [WiFiDirectAdvertisementPublisher.StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_error.md b/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_error.md index 00a8fcbc08..13c00ba6be 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_error.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_error.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Error --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Error ## -description Gets the error status for a [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -property-value The error status for a [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md), [WiFiDirectAdvertisementPublisher.StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Error + +## -description +Gets the error status for a [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -property-value +The error status for a [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event on a [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -remarks + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md), [WiFiDirectAdvertisementPublisher.StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_status.md b/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_status.md index df8b1c460d..1e6c8b8a6c 100644 --- a/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_status.md +++ b/windows.devices.wifidirect/wifidirectadvertisementpublisherstatuschangedeventargs_status.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Status --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Status ## -description Gets the new status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -property-value The new status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). ## -remarks The current status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) might have changed by the time this property is accessed. This property reflects the new status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) at the time it was changed and the [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event occurred. ## -examples ## -see-also [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md), [WiFiDirectAdvertisementPublisher.StatusChanged](wifidirectadvertisementpublisher_statuschanged.md), [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectAdvertisementPublisherStatusChangedEventArgs.Status + +## -description +Gets the new status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -property-value +The new status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md). + +## -remarks +The current status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) might have changed by the time this property is accessed. This property reflects the new status of the [WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md) at the time it was changed and the [StatusChanged](wifidirectadvertisementpublisher_statuschanged.md) event occurred. + +## -examples + +## -see-also +[WiFiDirectAdvertisementPublisher](wifidirectadvertisementpublisher.md), [WiFiDirectAdvertisementPublisher.StatusChanged](wifidirectadvertisementpublisher_statuschanged.md), [WiFiDirectAdvertisementPublisherStatus](wifidirectadvertisementpublisherstatus.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectconnectionlistener.md b/windows.devices.wifidirect/wifidirectconnectionlistener.md index 5ec4ae93aa..fab70c771c 100644 --- a/windows.devices.wifidirect/wifidirectconnectionlistener.md +++ b/windows.devices.wifidirect/wifidirectconnectionlistener.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionListener --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionListener ## -description Class used to listen for incoming Wi-Fi Direct connection requests. ## -remarks If multiple apps are listening for [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event notifications, the notifications will be sent to the apps sequentially in last in first out order of when the apps registered the event handler. This class is similar to the [StreamSocketListener](../windows.networking.sockets/streamsocketlistener.md) class in the [Windows.Networking.Sockets](../windows.networking.sockets/windows_networking_sockets.md) namespace. When it sees an incoming request of the appropriate kind, it raises a [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event. ## -examples ## -see-also [StreamSocketListener](../windows.networking.sockets/streamsocketlistener.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionListener +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionListener + +## -description +Class used to listen for incoming Wi-Fi Direct connection requests. + +## -remarks +If multiple apps are listening for [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event notifications, the notifications will be sent to the apps sequentially in last in first out order of when the apps registered the event handler. + +This class is similar to the [StreamSocketListener](../windows.networking.sockets/streamsocketlistener.md) class in the [Windows.Networking.Sockets](../windows.networking.sockets/windows_networking_sockets.md) namespace. When it sees an incoming request of the appropriate kind, it raises a [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event. + +## -examples + +## -see-also +[StreamSocketListener](../windows.networking.sockets/streamsocketlistener.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectconnectionlistener_connectionrequested.md b/windows.devices.wifidirect/wifidirectconnectionlistener_connectionrequested.md index 199e98ce6c..59909c1361 100644 --- a/windows.devices.wifidirect/wifidirectconnectionlistener_connectionrequested.md +++ b/windows.devices.wifidirect/wifidirectconnectionlistener_connectionrequested.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.ConnectionRequested --api-type: winrt event ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.ConnectionRequested ## -description Notification on an incoming Wi-Fi Direct connection request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.ConnectionRequested +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.ConnectionRequested + +## -description +Notification on an incoming Wi-Fi Direct connection request. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionlistener_wifidirectconnectionlistener_1221375020.md b/windows.devices.wifidirect/wifidirectconnectionlistener_wifidirectconnectionlistener_1221375020.md index f6ac119f67..52c2026481 100644 --- a/windows.devices.wifidirect/wifidirectconnectionlistener_wifidirectconnectionlistener_1221375020.md +++ b/windows.devices.wifidirect/wifidirectconnectionlistener_wifidirectconnectionlistener_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.#ctor --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.WiFiDirectConnectionListener ## -description Creates a new [WiFiDirectConnectionListener](wifidirectconnectionlistener.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionListener.WiFiDirectConnectionListener + +## -description +Creates a new [WiFiDirectConnectionListener](wifidirectconnectionlistener.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionparameters.md b/windows.devices.wifidirect/wifidirectconnectionparameters.md index dc551211d8..632f79edc1 100644 --- a/windows.devices.wifidirect/wifidirectconnectionparameters.md +++ b/windows.devices.wifidirect/wifidirectconnectionparameters.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters ## -description Used by an app to specify the connection parameters for a Wi-Fi Direct connect/pairing operation. ## -remarks ## -examples ## -see-also [WiFiDirectConnectionListener](wifidirectconnectionlistener.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters + +## -description +Used by an app to specify the connection parameters for a Wi-Fi Direct connect/pairing operation. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectConnectionListener](wifidirectconnectionlistener.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectconnectionparameters_getdevicepairingkinds_527992555.md b/windows.devices.wifidirect/wifidirectconnectionparameters_getdevicepairingkinds_527992555.md index ec996b199a..99aeb6af8a 100644 --- a/windows.devices.wifidirect/wifidirectconnectionparameters_getdevicepairingkinds_527992555.md +++ b/windows.devices.wifidirect/wifidirectconnectionparameters_getdevicepairingkinds_527992555.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GetDevicePairingKinds(Windows.Devices.WiFiDirect.WiFiDirectConfigurationMethod) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GetDevicePairingKinds ## -description Gets a list of the [DevicePairingKinds](../windows.devices.enumeration/devicepairingkinds.md) supporting the given configuration method. ## -parameters ### -param configurationMethod A value specifying a configuration method. ## -returns A value specifying a pairing kind, for use with the pairing functionality in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) API. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GetDevicePairingKinds(Windows.Devices.WiFiDirect.WiFiDirectConfigurationMethod) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GetDevicePairingKinds + +## -description +Gets a list of the [DevicePairingKinds](../windows.devices.enumeration/devicepairingkinds.md) supporting the given configuration method. + +## -parameters +### -param configurationMethod +A value specifying a configuration method. + +## -returns +A value specifying a pairing kind, for use with the pairing functionality in the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) API. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionparameters_groupownerintent.md b/windows.devices.wifidirect/wifidirectconnectionparameters_groupownerintent.md index 2a27f98a51..85412bf05d 100644 --- a/windows.devices.wifidirect/wifidirectconnectionparameters_groupownerintent.md +++ b/windows.devices.wifidirect/wifidirectconnectionparameters_groupownerintent.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GroupOwnerIntent --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GroupOwnerIntent ## -description The group owner intent value used for group owner negotiation in a Wi-Fi Direct connect/pairing operation. ## -property-value The group owner intent value used for group owner negotiation in a Wi-Fi Direct connect/pairing operation. ## -remarks The default value for this property is 14. So the [WiFiDirectConnectionListener](wifidirectconnectionlistener.md) will try hard to be the group owner without forcing the issue. ## -examples ## -see-also [WiFiDirectConnectionListener](wifidirectconnectionlistener.md) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GroupOwnerIntent +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.GroupOwnerIntent + +## -description +The group owner intent value used for group owner negotiation in a Wi-Fi Direct connect/pairing operation. + +## -property-value +The group owner intent value used for group owner negotiation in a Wi-Fi Direct connect/pairing operation. + +## -remarks +The default value for this property is 14. So the [WiFiDirectConnectionListener](wifidirectconnectionlistener.md) will try hard to be the group owner without forcing the issue. + +## -examples + +## -see-also +[WiFiDirectConnectionListener](wifidirectconnectionlistener.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectconnectionparameters_preferenceorderedconfigurationmethods.md b/windows.devices.wifidirect/wifidirectconnectionparameters_preferenceorderedconfigurationmethods.md index 3d25a26a9c..e3b69dff65 100644 --- a/windows.devices.wifidirect/wifidirectconnectionparameters_preferenceorderedconfigurationmethods.md +++ b/windows.devices.wifidirect/wifidirectconnectionparameters_preferenceorderedconfigurationmethods.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferenceOrderedConfigurationMethods --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferenceOrderedConfigurationMethods ## -description Gets a list of supported configuration methods, in order of preference. ## -property-value A list of [WiFiDirectConfigurationMethod](wifidirectconfigurationmethod.md) values representing supported configuration methods, in order of preference (most preferred first.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferenceOrderedConfigurationMethods +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferenceOrderedConfigurationMethods + +## -description +Gets a list of supported configuration methods, in order of preference. + +## -property-value +A list of [WiFiDirectConfigurationMethod](wifidirectconfigurationmethod.md) values representing supported configuration methods, in order of preference (most preferred first.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionparameters_preferredpairingprocedure.md b/windows.devices.wifidirect/wifidirectconnectionparameters_preferredpairingprocedure.md index 8df71e024d..10ac30bdca 100644 --- a/windows.devices.wifidirect/wifidirectconnectionparameters_preferredpairingprocedure.md +++ b/windows.devices.wifidirect/wifidirectconnectionparameters_preferredpairingprocedure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferredPairingProcedure --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferredPairingProcedure ## -description Gets or sets a value specifying a device's preferred pairing procedure. ## -property-value The preferred pairing procedure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferredPairingProcedure +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.PreferredPairingProcedure + +## -description +Gets or sets a value specifying a device's preferred pairing procedure. + +## -property-value +The preferred pairing procedure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionparameters_wifidirectconnectionparameters_1221375020.md b/windows.devices.wifidirect/wifidirectconnectionparameters_wifidirectconnectionparameters_1221375020.md index 8411886546..1151300da5 100644 --- a/windows.devices.wifidirect/wifidirectconnectionparameters_wifidirectconnectionparameters_1221375020.md +++ b/windows.devices.wifidirect/wifidirectconnectionparameters_wifidirectconnectionparameters_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.#ctor --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.WiFiDirectConnectionParameters ## -description Creates a new [WiFiDirectConnectionParameters](wifidirectconnectionparameters.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters.WiFiDirectConnectionParameters + +## -description +Creates a new [WiFiDirectConnectionParameters](wifidirectconnectionparameters.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionrequest.md b/windows.devices.wifidirect/wifidirectconnectionrequest.md index 499cf8b6a8..3624090c0d 100644 --- a/windows.devices.wifidirect/wifidirectconnectionrequest.md +++ b/windows.devices.wifidirect/wifidirectconnectionrequest.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest ## -description A Wi-FI Direct connection request received by a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). ## -remarks A [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) instance is retrieved by the [GetConnectionRequest](wifidirectconnectionrequestedeventargs_getconnectionrequest.md) method on the [WiFiDirectConnectionRequestedEventArgs](wifidirectconnectionrequestedeventargs.md) object when the [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event occurs on a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). Retrieve information about the requesting device using [DeviceInformation](wifidirectconnectionrequest_deviceinformation.md). The [Close](wifidirectconnectionrequest_close.md) method releases all unmanaged resources associated with the [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) object. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [WiFiDirectConnectionRequestedEventArgs](wifidirectconnectionrequestedeventargs.md), [WiFiDirectConnectionRequestedEventArgs.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md), [WiFiDirectConnectionListener](wifidirectconnectionlistener.md), [WiFiDirectConnectionListener.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest + +## -description +A Wi-FI Direct connection request received by a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). + +## -remarks +A [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) instance is retrieved by the [GetConnectionRequest](wifidirectconnectionrequestedeventargs_getconnectionrequest.md) method on the [WiFiDirectConnectionRequestedEventArgs](wifidirectconnectionrequestedeventargs.md) object when the [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event occurs on a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). + +Retrieve information about the requesting device using [DeviceInformation](wifidirectconnectionrequest_deviceinformation.md). + +The [Close](wifidirectconnectionrequest_close.md) method releases all unmanaged resources associated with the [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) object. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [WiFiDirectConnectionRequestedEventArgs](wifidirectconnectionrequestedeventargs.md), [WiFiDirectConnectionRequestedEventArgs.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md), [WiFiDirectConnectionListener](wifidirectconnectionlistener.md), [WiFiDirectConnectionListener.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectconnectionrequest_close_811482585.md b/windows.devices.wifidirect/wifidirectconnectionrequest_close_811482585.md index 7f03af6d26..f943e998b2 100644 --- a/windows.devices.wifidirect/wifidirectconnectionrequest_close_811482585.md +++ b/windows.devices.wifidirect/wifidirectconnectionrequest_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.Close --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.Close ## -description Closes the [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.Close +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.Close + +## -description +Closes the [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) object. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionrequest_deviceinformation.md b/windows.devices.wifidirect/wifidirectconnectionrequest_deviceinformation.md index b485aa2920..015a439c6f 100644 --- a/windows.devices.wifidirect/wifidirectconnectionrequest_deviceinformation.md +++ b/windows.devices.wifidirect/wifidirectconnectionrequest_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.DeviceInformation --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.DeviceInformation ## -description Gets device information for the endpoint making the Wi-Fi Direct connection request. ## -property-value Device information for the endpoint making the Wi-Fi Direct connection request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionRequest.DeviceInformation + +## -description +Gets device information for the endpoint making the Wi-Fi Direct connection request. + +## -property-value +Device information for the endpoint making the Wi-Fi Direct connection request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs.md b/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs.md index 2fd84f07e5..0ffbfe350f 100644 --- a/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs.md +++ b/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs ## -description Provides data for a [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event on a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). ## -remarks Your code doesn't instantiate this class. Instead, a [WiFiDirectConnectionRequestedEventArgs](wifidirectconnectionrequestedeventargs.md) instance is created when the when the [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event occurs on a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). Not all [WiFiDirectDevice](wifidirectdevice.md) properties are exposed on [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event by a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). Properties that are exposed include the following: + Device Friendly Name + Device Category + Model ID + Information elements ## -examples ## -see-also [WiFiDirectConnectionListener](wifidirectconnectionlistener.md), [WiFiDirectConnectionListener.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs + +## -description +Provides data for a [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event on a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). + +## -remarks +Your code doesn't instantiate this class. Instead, a [WiFiDirectConnectionRequestedEventArgs](wifidirectconnectionrequestedeventargs.md) instance is created when the when the [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event occurs on a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). + +Not all [WiFiDirectDevice](wifidirectdevice.md) properties are exposed on [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event by a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). Properties that are exposed include the following: ++ Device Friendly Name ++ Device Category ++ Model ID ++ Information elements + + +## -examples + +## -see-also +[WiFiDirectConnectionListener](wifidirectconnectionlistener.md), [WiFiDirectConnectionListener.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs_getconnectionrequest_2044958184.md b/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs_getconnectionrequest_2044958184.md index 3f9551ceb0..7272c4e6d8 100644 --- a/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs_getconnectionrequest_2044958184.md +++ b/windows.devices.wifidirect/wifidirectconnectionrequestedeventargs_getconnectionrequest_2044958184.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs.GetConnectionRequest --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs.GetConnectionRequest ## -description Retrieves the [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) received on a [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event by a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). ## -returns The Wi-FI Direct connection request. ## -remarks ## -examples ## -see-also [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md), [WiFiDirectConnectionListener](wifidirectconnectionlistener.md), [WiFiDirectConnectionListener.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs.GetConnectionRequest +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectConnectionRequestedEventArgs.GetConnectionRequest + +## -description +Retrieves the [WiFiDirectConnectionRequest](wifidirectconnectionrequest.md) received on a [ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) event by a [WiFiDirectConnectionListener](wifidirectconnectionlistener.md). + +## -returns +The Wi-FI Direct connection request. + +## -remarks + + +## -examples + +## -see-also +[WiFiDirectConnectionRequest](wifidirectconnectionrequest.md), [WiFiDirectConnectionListener](wifidirectconnectionlistener.md), [WiFiDirectConnectionListener.ConnectionRequested](wifidirectconnectionlistener_connectionrequested.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_close_811482585.md b/windows.devices.wifidirect/wifidirectdevice_close_811482585.md index 2a5e5ab6db..875d401538 100644 --- a/windows.devices.wifidirect/wifidirectdevice_close_811482585.md +++ b/windows.devices.wifidirect/wifidirectdevice_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.Close --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.Close ## -description Close the active Wi-Fi Direct device connection. ## -remarks ## -examples ## -see-also [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.Close +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.Close + +## -description +Close the active Wi-Fi Direct device connection. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_connectionstatus.md b/windows.devices.wifidirect/wifidirectdevice_connectionstatus.md index d3d7e8f957..683c6c7b8f 100644 --- a/windows.devices.wifidirect/wifidirectdevice_connectionstatus.md +++ b/windows.devices.wifidirect/wifidirectdevice_connectionstatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatus --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatus ## -description Gets the connection status for the WiFi-Direct device. ## -property-value The connection status for the WiFi-Direct device. ## -remarks ## -examples ## -see-also [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatus +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatus + +## -description +Gets the connection status for the WiFi-Direct device. + +## -property-value +The connection status for the WiFi-Direct device. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_connectionstatuschanged.md b/windows.devices.wifidirect/wifidirectdevice_connectionstatuschanged.md index 0709903551..8db9ed1e6f 100644 --- a/windows.devices.wifidirect/wifidirectdevice_connectionstatuschanged.md +++ b/windows.devices.wifidirect/wifidirectdevice_connectionstatuschanged.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatusChanged --api-type: winrt event ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatusChanged ## -description Occurs when a Wi-Fi Direct device connection is connected or disconnected. ## -remarks You can add a handler for the [ConnectionStatusChanged](wifidirectdevice_connectionstatuschanged.md) event to be notified when the connection has been established or disconnected. ## -examples ## -see-also [GetDeviceSelector](wifidirectdevice_getdeviceselector.md), [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: E:Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.ConnectionStatusChanged + +## -description +Occurs when a Wi-Fi Direct device connection is connected or disconnected. + +## -remarks +You can add a handler for the [ConnectionStatusChanged](wifidirectdevice_connectionstatuschanged.md) event to be notified when the connection has been established or disconnected. + +## -examples + +## -see-also +[GetDeviceSelector](wifidirectdevice_getdeviceselector.md), [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_deviceid.md b/windows.devices.wifidirect/wifidirectdevice_deviceid.md index f30d6f65bd..ab721e01a4 100644 --- a/windows.devices.wifidirect/wifidirectdevice_deviceid.md +++ b/windows.devices.wifidirect/wifidirectdevice_deviceid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectDevice.DeviceId --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.DeviceId ## -description Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for the Wi-Fi Direct device. ## -property-value The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for the Wi-Fi Direct device. ## -remarks ## -examples ## -see-also [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectDevice.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.DeviceId + +## -description +Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for the Wi-Fi Direct device. + +## -property-value +The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for the Wi-Fi Direct device. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_fromidasync_1322863552.md b/windows.devices.wifidirect/wifidirectdevice_fromidasync_1322863552.md index 269f524b84..45ba35758e 100644 --- a/windows.devices.wifidirect/wifidirectdevice_fromidasync_1322863552.md +++ b/windows.devices.wifidirect/wifidirectdevice_fromidasync_1322863552.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync ## -description Creates an instance of the [WiFiDirectDevice](wifidirectdevice.md) class for the specified device interface id. ## -parameters ### -param deviceId The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of a Wi-Fi Direct device. ## -returns An asynchronous operation to retrieve the [WiFiDirectDevice](wifidirectdevice.md) that was created. ## -remarks You can use the [GetDeviceSelector](wifidirectdevice_getdeviceselector.md) methods to enumerate Wi-Fi Direct devices to determine their interface ids. ## -examples ## -see-also [FromIdAsync(String, WiFiDirectConnectionParameters)](wifidirectdevice_fromidasync_1400638850.md), [GetDeviceSelector](wifidirectdevice_getdeviceselector.md), [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync + +## -description +Creates an instance of the [WiFiDirectDevice](wifidirectdevice.md) class for the specified device interface id. + +## -parameters +### -param deviceId +The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of a Wi-Fi Direct device. + +## -returns +An asynchronous operation to retrieve the [WiFiDirectDevice](wifidirectdevice.md) that was created. + +## -remarks +You can use the [GetDeviceSelector](wifidirectdevice_getdeviceselector.md) methods to enumerate Wi-Fi Direct devices to determine their interface ids. + +## -examples + +## -see-also +[FromIdAsync(String, WiFiDirectConnectionParameters)](wifidirectdevice_fromidasync_1400638850.md), [GetDeviceSelector](wifidirectdevice_getdeviceselector.md), [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_fromidasync_1400638850.md b/windows.devices.wifidirect/wifidirectdevice_fromidasync_1400638850.md index e394cc6517..29b76b7f79 100644 --- a/windows.devices.wifidirect/wifidirectdevice_fromidasync_1400638850.md +++ b/windows.devices.wifidirect/wifidirectdevice_fromidasync_1400638850.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync(System.String,Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync ## -description Creates an instance of the [WiFiDirectDevice](wifidirectdevice.md) class for the specified device interface id with specific connection parameters. ## -parameters ### -param deviceId The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of a Wi-Fi Direct device. ### -param connectionParameters Connection parameters for a Wi-Fi Direct connect/pairing operation. ## -returns An asynchronous operation to retrieve the [WiFiDirectDevice](wifidirectdevice.md) that was created. ## -remarks You can use the [GetDeviceSelector](wifidirectdevice_getdeviceselector.md) methods to enumerate Wi-Fi Direct devices to determine their interface ids. ## -examples ## -see-also [FromIdAsync(String)](wifidirectdevice_fromidasync_1322863552.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync(System.String,Windows.Devices.WiFiDirect.WiFiDirectConnectionParameters) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.FromIdAsync + +## -description +Creates an instance of the [WiFiDirectDevice](wifidirectdevice.md) class for the specified device interface id with specific connection parameters. + +## -parameters +### -param deviceId +The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of a Wi-Fi Direct device. + +### -param connectionParameters +Connection parameters for a Wi-Fi Direct connect/pairing operation. + +## -returns +An asynchronous operation to retrieve the [WiFiDirectDevice](wifidirectdevice.md) that was created. + +## -remarks +You can use the [GetDeviceSelector](wifidirectdevice_getdeviceselector.md) methods to enumerate Wi-Fi Direct devices to determine their interface ids. + +## -examples + +## -see-also +[FromIdAsync(String)](wifidirectdevice_fromidasync_1322863552.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_getconnectionendpointpairs_1958888015.md b/windows.devices.wifidirect/wifidirectdevice_getconnectionendpointpairs_1958888015.md index ceb9ded67e..1885911bcb 100644 --- a/windows.devices.wifidirect/wifidirectdevice_getconnectionendpointpairs_1958888015.md +++ b/windows.devices.wifidirect/wifidirectdevice_getconnectionendpointpairs_1958888015.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.GetConnectionEndpointPairs --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.GetConnectionEndpointPairs ## -description Gets a collection of network addresses for the Wi-Fi Direct device as endpoint pairs. ## -returns A collection of network addresses for the Wi-Fi Direct device as endpoint pairs. ## -remarks ## -examples ## -see-also [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.GetConnectionEndpointPairs +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.GetConnectionEndpointPairs + +## -description +Gets a collection of network addresses for the Wi-Fi Direct device as endpoint pairs. + +## -returns +A collection of network addresses for the Wi-Fi Direct device as endpoint pairs. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_185243134.md b/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_185243134.md index beae38e898..f8a6aeb6e1 100644 --- a/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_185243134.md +++ b/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_185243134.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector(Windows.Devices.WiFiDirect.WiFiDirectDeviceSelectorType) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector ## -description Returns the class selection string that you can use to enumerate Wi-Fi Direct devices for a specific Wi-Fi Direct device selector type. ## -parameters ### -param type A specific Wi-Fi Direct device selector type. ## -returns The class selection string that you can use to enumerate Wi-Fi Direct devices. ## -remarks This method will return either Wi-Fi Direct device interfaces or associated endpoints for PCs, tablets, and phones that support Wi-Fi Direct depending on the value of the *type* parameter. ## -examples ## -see-also [GetDeviceSelector](wifidirectdevice_getdeviceselector_838466080.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector(Windows.Devices.WiFiDirect.WiFiDirectDeviceSelectorType) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector + +## -description +Returns the class selection string that you can use to enumerate Wi-Fi Direct devices for a specific Wi-Fi Direct device selector type. + +## -parameters +### -param type +A specific Wi-Fi Direct device selector type. + +## -returns +The class selection string that you can use to enumerate Wi-Fi Direct devices. + +## -remarks +This method will return either Wi-Fi Direct device interfaces or associated endpoints for PCs, tablets, and phones that support Wi-Fi Direct depending on the value of the *type* parameter. + +## -examples + +## -see-also +[GetDeviceSelector](wifidirectdevice_getdeviceselector_838466080.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_838466080.md b/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_838466080.md index 361751d18e..3db5e031c5 100644 --- a/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_838466080.md +++ b/windows.devices.wifidirect/wifidirectdevice_getdeviceselector_838466080.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector ## -description Returns the class selection string that you can use to enumerate Wi-Fi Direct devices. ## -returns The class selection string that you can use to enumerate Wi-Fi Direct devices. ## -remarks This method only returns Wi-Fi Direct device interfaces. ## -examples ## -see-also [GetDeviceSelector(WiFiDirectDeviceSelectorType)](wifidirectdevice_getdeviceselector_185243134.md), [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectDevice.GetDeviceSelector + +## -description +Returns the class selection string that you can use to enumerate Wi-Fi Direct devices. + +## -returns +The class selection string that you can use to enumerate Wi-Fi Direct devices. + +## -remarks +This method only returns Wi-Fi Direct device interfaces. + +## -examples + +## -see-also +[GetDeviceSelector(WiFiDirectDeviceSelectorType)](wifidirectdevice_getdeviceselector_185243134.md), [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectinformationelement.md b/windows.devices.wifidirect/wifidirectinformationelement.md index ee1056c023..bcda2e9cbf 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement.md +++ b/windows.devices.wifidirect/wifidirectinformationelement.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectInformationElement --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement ## -description Represents information elements in a Wi-Fi Direct packet. ## -remarks An information element (IE) is a form of structured data which can be included in Wi-Fi Direct packets. IEs are formatted as a variable length value field preceded by type and length fields. ## -examples ## -see-also [WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectInformationElement +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement + +## -description +Represents information elements in a Wi-Fi Direct packet. + +## -remarks +An information element (IE) is a form of structured data which can be included in Wi-Fi Direct packets. IEs are formatted as a variable length value field preceded by type and length fields. + +## -examples + +## -see-also +[WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectinformationelement_createfrombuffer_487188303.md b/windows.devices.wifidirect/wifidirectinformationelement_createfrombuffer_487188303.md index 470ae0e86a..7da2b8dc17 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement_createfrombuffer_487188303.md +++ b/windows.devices.wifidirect/wifidirectinformationelement_createfrombuffer_487188303.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromBuffer ## -description Create an array of information elements from a data buffer. ## -parameters ### -param buffer The data buffer that contains a information element. ## -returns A array of information elements created from the buffer. ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromBuffer + +## -description +Create an array of information elements from a data buffer. + +## -parameters +### -param buffer +The data buffer that contains a information element. + +## -returns +A array of information elements created from the buffer. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectinformationelement_createfromdeviceinformation_1258618423.md b/windows.devices.wifidirect/wifidirectinformationelement_createfromdeviceinformation_1258618423.md index 61ac353ef8..1be4f0a097 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement_createfromdeviceinformation_1258618423.md +++ b/windows.devices.wifidirect/wifidirectinformationelement_createfromdeviceinformation_1258618423.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromDeviceInformation(Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromDeviceInformation ## -description Create an array of information elements from a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object. ## -parameters ### -param deviceInformation The device information object that contains the information elements. ## -returns A array of information elements created from the device information object. ## -remarks ## -examples ## -see-also [WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromDeviceInformation(Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement.CreateFromDeviceInformation + +## -description +Create an array of information elements from a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object. + +## -parameters +### -param deviceInformation +The device information object that contains the information elements. + +## -returns +A array of information elements created from the device information object. + +## -remarks + +## -examples + +## -see-also +[WiFiDirectAdvertisement](wifidirectadvertisement.md) \ No newline at end of file diff --git a/windows.devices.wifidirect/wifidirectinformationelement_oui.md b/windows.devices.wifidirect/wifidirectinformationelement_oui.md index 5f5f34cdfd..cb1773f109 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement_oui.md +++ b/windows.devices.wifidirect/wifidirectinformationelement_oui.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Oui --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Oui ## -description A three-byte organization identifier used to indicate the organization which defined a vendor extension information element (IE). ## -property-value A three-byte organization identifier used to indicate the organization which defined a vendor extension IE. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Oui +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Oui + +## -description +A three-byte organization identifier used to indicate the organization which defined a vendor extension information element (IE). + +## -property-value +A three-byte organization identifier used to indicate the organization which defined a vendor extension IE. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectinformationelement_ouitype.md b/windows.devices.wifidirect/wifidirectinformationelement_ouitype.md index 9a641d2ca0..dd286b1aec 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement_ouitype.md +++ b/windows.devices.wifidirect/wifidirectinformationelement_ouitype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.OuiType --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement.OuiType ## -description A one byte type value used in a vendor extension information element (IE) to distinguish between different IE formats defined by the same organization. ## -property-value A one byte type value used in a vendor extension information element (IE) to distinguish between different IE formats defined by the same organization. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.OuiType +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement.OuiType + +## -description +A one byte type value used in a vendor extension information element (IE) to distinguish between different IE formats defined by the same organization. + +## -property-value +A one byte type value used in a vendor extension information element (IE) to distinguish between different IE formats defined by the same organization. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectinformationelement_value.md b/windows.devices.wifidirect/wifidirectinformationelement_value.md index 0959a55c74..8a054db26d 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement_value.md +++ b/windows.devices.wifidirect/wifidirectinformationelement_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Value --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Value ## -description The value of the information element. ## -property-value The value of the information element. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Value +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement.Value + +## -description +The value of the information element. + +## -property-value +The value of the information element. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectinformationelement_wifidirectinformationelement_1221375020.md b/windows.devices.wifidirect/wifidirectinformationelement_wifidirectinformationelement_1221375020.md index 03b1946cf5..35cb4ce376 100644 --- a/windows.devices.wifidirect/wifidirectinformationelement_wifidirectinformationelement_1221375020.md +++ b/windows.devices.wifidirect/wifidirectinformationelement_wifidirectinformationelement_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.#ctor --api-type: winrt method ---- # Windows.Devices.WiFiDirect.WiFiDirectInformationElement.WiFiDirectInformationElement ## -description Creates a new [WiFiDirectInformationElement](wifidirectinformationelement.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.WiFiDirect.WiFiDirectInformationElement.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectInformationElement.WiFiDirectInformationElement + +## -description +Creates a new [WiFiDirectInformationElement](wifidirectinformationelement.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectlegacysettings.md b/windows.devices.wifidirect/wifidirectlegacysettings.md index 2e676dbd8f..ef2a121cf8 100644 --- a/windows.devices.wifidirect/wifidirectlegacysettings.md +++ b/windows.devices.wifidirect/wifidirectlegacysettings.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings --api-type: winrt class ---- # Windows.Devices.WiFiDirect.WiFiDirectLegacySettings ## -description Settings governing "legacy" mode (non-Wi-Fi Direct connections to the access point being advertised.) This access point allows devices that do not support Wi-Fi Direct to connect to a device that does support it, and to use the services offered by the Wi-Fi Direct device. The connection does not serve as a general-purpose Wi-Fi access point. ## -remarks Your code retrieves instances of this class through the [WiFiDirectAdvertisement.LegacySettings](wifidirectadvertisement_legacysettings.md) property. It does not instantiate the class directly. The SSID is initially set to a Wi-Fi Direct compatible random string beginning with ""DIRECT-"". Your code can change this value to a different SSID if you choose to do so. The pass phrase is initialized to a random alphanumeric string. Your code can change this value to a different pass phrase if you choose to do so. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings +-api-type: winrt class +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectLegacySettings + +## -description +Settings governing "legacy" mode (non-Wi-Fi Direct connections to the access point being advertised.) + +This access point allows devices that do not support Wi-Fi Direct to connect to a device that does support it, and to use the services offered by the Wi-Fi Direct device. The connection does not serve as a general-purpose Wi-Fi access point. + +## -remarks +Your code retrieves instances of this class through the [WiFiDirectAdvertisement.LegacySettings](wifidirectadvertisement_legacysettings.md) property. It does not instantiate the class directly. + +The SSID is initially set to a Wi-Fi Direct compatible random string beginning with ""DIRECT-"". Your code can change this value to a different SSID if you choose to do so. + +The pass phrase is initialized to a random alphanumeric string. Your code can change this value to a different pass phrase if you choose to do so. + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectlegacysettings_isenabled.md b/windows.devices.wifidirect/wifidirectlegacysettings_isenabled.md index 42edf3525c..9ed5c68d24 100644 --- a/windows.devices.wifidirect/wifidirectlegacysettings_isenabled.md +++ b/windows.devices.wifidirect/wifidirectlegacysettings_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.IsEnabled --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.IsEnabled ## -description Gets or sets a value specifying whether "legacy mode" is enabled. When enabled, this mode causes this device to act as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct. ## -property-value When true, "legacy mode" is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.IsEnabled + +## -description +Gets or sets a value specifying whether "legacy mode" is enabled. When enabled, this mode causes this device to act as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct. + +## -property-value +When true, "legacy mode" is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectlegacysettings_passphrase.md b/windows.devices.wifidirect/wifidirectlegacysettings_passphrase.md index e4b2116537..31022302c5 100644 --- a/windows.devices.wifidirect/wifidirectlegacysettings_passphrase.md +++ b/windows.devices.wifidirect/wifidirectlegacysettings_passphrase.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Passphrase --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Passphrase ## -description Gets or sets the pass phrase used by non-Wi-Fi Direct clients to connect to this access point in "legacy mode". ## -property-value The pass phrase for the Wi-Fi network. This access point functions as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Passphrase +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Passphrase + +## -description +Gets or sets the pass phrase used by non-Wi-Fi Direct clients to connect to this access point in "legacy mode". + +## -property-value +The pass phrase for the Wi-Fi network. This access point functions as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices.wifidirect/wifidirectlegacysettings_ssid.md b/windows.devices.wifidirect/wifidirectlegacysettings_ssid.md index 2eb1afaeef..e1211db483 100644 --- a/windows.devices.wifidirect/wifidirectlegacysettings_ssid.md +++ b/windows.devices.wifidirect/wifidirectlegacysettings_ssid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Ssid --api-type: winrt property ---- # Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Ssid ## -description Gets or sets the Service Set Identifier (SSID, or "access point ID"). ## -property-value The SSID for the access point. This access point functions as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Ssid +-api-type: winrt property +--- + + + +# Windows.Devices.WiFiDirect.WiFiDirectLegacySettings.Ssid + +## -description +Gets or sets the Service Set Identifier (SSID, or "access point ID"). + +## -property-value +The SSID for the access point. This access point functions as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.devices/ilowleveldevicesaggregateprovider_adccontrollerprovider.md b/windows.devices/ilowleveldevicesaggregateprovider_adccontrollerprovider.md index ebb410994b..e8a15a1160 100644 --- a/windows.devices/ilowleveldevicesaggregateprovider_adccontrollerprovider.md +++ b/windows.devices/ilowleveldevicesaggregateprovider_adccontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.AdcControllerProvider --api-type: winrt property ---- # Windows.Devices.ILowLevelDevicesAggregateProvider.AdcControllerProvider ## -description Gets the default ADC provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The ADC provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.AdcControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.ILowLevelDevicesAggregateProvider.AdcControllerProvider + +## -description +Gets the default ADC provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The ADC provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/ilowleveldevicesaggregateprovider_gpiocontrollerprovider.md b/windows.devices/ilowleveldevicesaggregateprovider_gpiocontrollerprovider.md index 7686b74004..d1c24c9bd8 100644 --- a/windows.devices/ilowleveldevicesaggregateprovider_gpiocontrollerprovider.md +++ b/windows.devices/ilowleveldevicesaggregateprovider_gpiocontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.GpioControllerProvider --api-type: winrt property ---- # Windows.Devices.ILowLevelDevicesAggregateProvider.GpioControllerProvider ## -description Gets the default GPIO provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The GPIO provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.GpioControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.ILowLevelDevicesAggregateProvider.GpioControllerProvider + +## -description +Gets the default GPIO provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The GPIO provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/ilowleveldevicesaggregateprovider_i2ccontrollerprovider.md b/windows.devices/ilowleveldevicesaggregateprovider_i2ccontrollerprovider.md index 68601c22f7..cb39aa288c 100644 --- a/windows.devices/ilowleveldevicesaggregateprovider_i2ccontrollerprovider.md +++ b/windows.devices/ilowleveldevicesaggregateprovider_i2ccontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.I2cControllerProvider --api-type: winrt property ---- # Windows.Devices.ILowLevelDevicesAggregateProvider.I2cControllerProvider ## -description Gets the default I2 C provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The I2 C provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.I2cControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.ILowLevelDevicesAggregateProvider.I2cControllerProvider + +## -description +Gets the default I2 C provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The I2 C provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/ilowleveldevicesaggregateprovider_pwmcontrollerprovider.md b/windows.devices/ilowleveldevicesaggregateprovider_pwmcontrollerprovider.md index 3b60a18f68..effe0145ea 100644 --- a/windows.devices/ilowleveldevicesaggregateprovider_pwmcontrollerprovider.md +++ b/windows.devices/ilowleveldevicesaggregateprovider_pwmcontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.PwmControllerProvider --api-type: winrt property ---- # Windows.Devices.ILowLevelDevicesAggregateProvider.PwmControllerProvider ## -description Gets the default PWM provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The PWM provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.PwmControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.ILowLevelDevicesAggregateProvider.PwmControllerProvider + +## -description +Gets the default PWM provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The PWM provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/ilowleveldevicesaggregateprovider_spicontrollerprovider.md b/windows.devices/ilowleveldevicesaggregateprovider_spicontrollerprovider.md index 36dc89439e..944a521193 100644 --- a/windows.devices/ilowleveldevicesaggregateprovider_spicontrollerprovider.md +++ b/windows.devices/ilowleveldevicesaggregateprovider_spicontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.SpiControllerProvider --api-type: winrt property ---- # Windows.Devices.ILowLevelDevicesAggregateProvider.SpiControllerProvider ## -description Gets the default SPI provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The SPI provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.ILowLevelDevicesAggregateProvider.SpiControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.ILowLevelDevicesAggregateProvider.SpiControllerProvider + +## -description +Gets the default SPI provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The SPI provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicesaggregateprovider.md b/windows.devices/lowleveldevicesaggregateprovider.md index 070b8a6dcc..045b08988a 100644 --- a/windows.devices/lowleveldevicesaggregateprovider.md +++ b/windows.devices/lowleveldevicesaggregateprovider.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Devices.LowLevelDevicesAggregateProvider --api-type: winrt class ---- # Windows.Devices.LowLevelDevicesAggregateProvider ## -description Represents the low level bus device providers. This class gives access to the default provider for the low level bus controllers. ## -remarks ## -examples ## -see-also [ILowLevelDevicesAggregateProvider](ilowleveldevicesaggregateprovider.md) \ No newline at end of file +--- +-api-id: T:Windows.Devices.LowLevelDevicesAggregateProvider +-api-type: winrt class +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider + +## -description +Represents the low level bus device providers. This class gives access to the default provider for the low level bus controllers. + +## -remarks + +## -examples + +## -see-also +[ILowLevelDevicesAggregateProvider](ilowleveldevicesaggregateprovider.md) \ No newline at end of file diff --git a/windows.devices/lowleveldevicesaggregateprovider_adccontrollerprovider.md b/windows.devices/lowleveldevicesaggregateprovider_adccontrollerprovider.md index f75d269680..b53f4cefa3 100644 --- a/windows.devices/lowleveldevicesaggregateprovider_adccontrollerprovider.md +++ b/windows.devices/lowleveldevicesaggregateprovider_adccontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.AdcControllerProvider --api-type: winrt property ---- # Windows.Devices.LowLevelDevicesAggregateProvider.AdcControllerProvider ## -description Gets the default ADC provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The ADC provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.AdcControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider.AdcControllerProvider + +## -description +Gets the default ADC provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The ADC provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicesaggregateprovider_gpiocontrollerprovider.md b/windows.devices/lowleveldevicesaggregateprovider_gpiocontrollerprovider.md index 22141cd31f..1081b534c8 100644 --- a/windows.devices/lowleveldevicesaggregateprovider_gpiocontrollerprovider.md +++ b/windows.devices/lowleveldevicesaggregateprovider_gpiocontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.GpioControllerProvider --api-type: winrt property ---- # Windows.Devices.LowLevelDevicesAggregateProvider.GpioControllerProvider ## -description Gets the default GPIO provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The GPIO provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.GpioControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider.GpioControllerProvider + +## -description +Gets the default GPIO provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The GPIO provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicesaggregateprovider_i2ccontrollerprovider.md b/windows.devices/lowleveldevicesaggregateprovider_i2ccontrollerprovider.md index bdf0b20779..e15c34be97 100644 --- a/windows.devices/lowleveldevicesaggregateprovider_i2ccontrollerprovider.md +++ b/windows.devices/lowleveldevicesaggregateprovider_i2ccontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.I2cControllerProvider --api-type: winrt property ---- # Windows.Devices.LowLevelDevicesAggregateProvider.I2cControllerProvider ## -description Gets the default I2 C provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The I2 C provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.I2cControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider.I2cControllerProvider + +## -description +Gets the default I2 C provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The I2 C provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicesaggregateprovider_lowleveldevicesaggregateprovider_897317454.md b/windows.devices/lowleveldevicesaggregateprovider_lowleveldevicesaggregateprovider_897317454.md index 3485d65179..fa59ba4b32 100644 --- a/windows.devices/lowleveldevicesaggregateprovider_lowleveldevicesaggregateprovider_897317454.md +++ b/windows.devices/lowleveldevicesaggregateprovider_lowleveldevicesaggregateprovider_897317454.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Devices.LowLevelDevicesAggregateProvider.#ctor(Windows.Devices.Adc.Provider.IAdcControllerProvider,Windows.Devices.Pwm.Provider.IPwmControllerProvider,Windows.Devices.Gpio.Provider.IGpioControllerProvider,Windows.Devices.I2c.Provider.II2cControllerProvider,Windows.Devices.Spi.Provider.ISpiControllerProvider) --api-type: winrt method ---- # Windows.Devices.LowLevelDevicesAggregateProvider.LowLevelDevicesAggregateProvider ## -description Creates an instance of [LowLevelDevicesAggregateProvider](lowleveldevicesaggregateprovider.md) and sets the supplied providers as defaults for the respective bus. ## -parameters ### -param adc The ADC provider. ### -param pwm The PWM provider. ### -param gpio The GPIO provider. ### -param i2c The I2 C provider. ### -param spi The SPI provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Devices.LowLevelDevicesAggregateProvider.#ctor(Windows.Devices.Adc.Provider.IAdcControllerProvider,Windows.Devices.Pwm.Provider.IPwmControllerProvider,Windows.Devices.Gpio.Provider.IGpioControllerProvider,Windows.Devices.I2c.Provider.II2cControllerProvider,Windows.Devices.Spi.Provider.ISpiControllerProvider) +-api-type: winrt method +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider.LowLevelDevicesAggregateProvider + +## -description +Creates an instance of [LowLevelDevicesAggregateProvider](lowleveldevicesaggregateprovider.md) and sets the supplied providers as defaults for the respective bus. + +## -parameters +### -param adc +The ADC provider. + +### -param pwm +The PWM provider. + +### -param gpio +The GPIO provider. + +### -param i2c +The I2 C provider. + +### -param spi +The SPI provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicesaggregateprovider_pwmcontrollerprovider.md b/windows.devices/lowleveldevicesaggregateprovider_pwmcontrollerprovider.md index d43f8daa90..ce43439f6d 100644 --- a/windows.devices/lowleveldevicesaggregateprovider_pwmcontrollerprovider.md +++ b/windows.devices/lowleveldevicesaggregateprovider_pwmcontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.PwmControllerProvider --api-type: winrt property ---- # Windows.Devices.LowLevelDevicesAggregateProvider.PwmControllerProvider ## -description Gets the default PWM provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The PWM provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.PwmControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider.PwmControllerProvider + +## -description +Gets the default PWM provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The PWM provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicesaggregateprovider_spicontrollerprovider.md b/windows.devices/lowleveldevicesaggregateprovider_spicontrollerprovider.md index a4ada6f653..253fd6b930 100644 --- a/windows.devices/lowleveldevicesaggregateprovider_spicontrollerprovider.md +++ b/windows.devices/lowleveldevicesaggregateprovider_spicontrollerprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.SpiControllerProvider --api-type: winrt property ---- # Windows.Devices.LowLevelDevicesAggregateProvider.SpiControllerProvider ## -description Gets the default SPI provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. ## -property-value The SPI provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.LowLevelDevicesAggregateProvider.SpiControllerProvider +-api-type: winrt property +--- + + + +# Windows.Devices.LowLevelDevicesAggregateProvider.SpiControllerProvider + +## -description +Gets the default SPI provider. If the default provider is not explicitly set, it will fall back to the normal driver/controller. + +## -property-value +The SPI provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicescontroller.md b/windows.devices/lowleveldevicescontroller.md index ba477d303e..8c9a39d8a9 100644 --- a/windows.devices/lowleveldevicescontroller.md +++ b/windows.devices/lowleveldevicescontroller.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Devices.LowLevelDevicesController --api-type: winrt class ---- # Windows.Devices.LowLevelDevicesController ## -description Represents a low level bus device controller, and it's associated provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Devices.LowLevelDevicesController +-api-type: winrt class +--- + + + +# Windows.Devices.LowLevelDevicesController + +## -description +Represents a low level bus device controller, and it's associated provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.devices/lowleveldevicescontroller_defaultprovider.md b/windows.devices/lowleveldevicescontroller_defaultprovider.md index db3c2da5f6..e120a1a5df 100644 --- a/windows.devices/lowleveldevicescontroller_defaultprovider.md +++ b/windows.devices/lowleveldevicescontroller_defaultprovider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Devices.LowLevelDevicesController.DefaultProvider --api-type: winrt property ---- # Windows.Devices.LowLevelDevicesController.DefaultProvider ## -description Gets or sets the default provider for the controller. ## -property-value The device aggregate provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Devices.LowLevelDevicesController.DefaultProvider +-api-type: winrt property +--- + + + +# Windows.Devices.LowLevelDevicesController.DefaultProvider + +## -description +Gets or sets the default provider for the controller. + +## -property-value +The device aggregate provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.embedded.devicelockdown/devicelockdownprofile.md b/windows.embedded.devicelockdown/devicelockdownprofile.md index 7d725b2e07..92eca3e91f 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofile.md +++ b/windows.embedded.devicelockdown/devicelockdownprofile.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile --api-type: winrt class ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfile ## -description Provides the methods for getting and applying restrictions to applications and tiles on the device based on user role IDs. ## -remarks To use this API, certain capabilities and roles need to be configured. For information, see the remarks in [Windows.Embedded.DeviceLockdown](windows_embedded_devicelockdown.md). ## -examples ## -see-also ## -capabilities enterpriseDeviceLockdown \ No newline at end of file +--- +-api-id: T:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile +-api-type: winrt class +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfile + +## -description +Provides the methods for getting and applying restrictions to applications and tiles on the device based on user role IDs. + +## -remarks +To use this API, certain capabilities and roles need to be configured. For information, see the remarks in [Windows.Embedded.DeviceLockdown](windows_embedded_devicelockdown.md). + +## -examples + +## -see-also + + +## -capabilities +enterpriseDeviceLockdown \ No newline at end of file diff --git a/windows.embedded.devicelockdown/devicelockdownprofile_applylockdownprofileasync_1757957637.md b/windows.embedded.devicelockdown/devicelockdownprofile_applylockdownprofileasync_1757957637.md index ad364f9756..94042151da 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofile_applylockdownprofileasync_1757957637.md +++ b/windows.embedded.devicelockdown/devicelockdownprofile_applylockdownprofileasync_1757957637.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.ApplyLockdownProfileAsync(System.Guid) --api-type: winrt method ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.ApplyLockdownProfileAsync ## -description Activates the restrictions associated with the specified user role ID. ## -parameters ### -param profileID User role ID. ## -returns No object or value is returned when this method completes. ## -remarks ## -examples ## -see-also ## -capabilities enterpriseDeviceLockdown \ No newline at end of file +--- +-api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.ApplyLockdownProfileAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.ApplyLockdownProfileAsync + +## -description +Activates the restrictions associated with the specified user role ID. + +## -parameters +### -param profileID +User role ID. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +enterpriseDeviceLockdown \ No newline at end of file diff --git a/windows.embedded.devicelockdown/devicelockdownprofile_getcurrentlockdownprofile_954682171.md b/windows.embedded.devicelockdown/devicelockdownprofile_getcurrentlockdownprofile_954682171.md index 9ea3fbd0ad..960732542d 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofile_getcurrentlockdownprofile_954682171.md +++ b/windows.embedded.devicelockdown/devicelockdownprofile_getcurrentlockdownprofile_954682171.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetCurrentLockdownProfile --api-type: winrt method ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetCurrentLockdownProfile ## -description Gets the user role ID that is currently in use by the handheld device. ## -returns Role ID that is currently in use by the handheld device. ## -remarks ## -examples ## -see-also ## -capabilities enterpriseDeviceLockdown \ No newline at end of file +--- +-api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetCurrentLockdownProfile +-api-type: winrt method +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetCurrentLockdownProfile + +## -description +Gets the user role ID that is currently in use by the handheld device. + +## -returns +Role ID that is currently in use by the handheld device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +enterpriseDeviceLockdown \ No newline at end of file diff --git a/windows.embedded.devicelockdown/devicelockdownprofile_getlockdownprofileinformation_1662407645.md b/windows.embedded.devicelockdown/devicelockdownprofile_getlockdownprofileinformation_1662407645.md index 30718d67a4..850b9e08a8 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofile_getlockdownprofileinformation_1662407645.md +++ b/windows.embedded.devicelockdown/devicelockdownprofile_getlockdownprofileinformation_1662407645.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetLockdownProfileInformation(System.Guid) --api-type: winrt method ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetLockdownProfileInformation ## -description Gets the information object about a specific user role. ## -parameters ### -param profileID User role profile ID. ## -returns Information object about a specific user role. ## -remarks ## -examples ## -see-also ## -capabilities enterpriseDeviceLockdown \ No newline at end of file +--- +-api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetLockdownProfileInformation(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetLockdownProfileInformation + +## -description +Gets the information object about a specific user role. + +## -parameters +### -param profileID +User role profile ID. + +## -returns +Information object about a specific user role. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +enterpriseDeviceLockdown \ No newline at end of file diff --git a/windows.embedded.devicelockdown/devicelockdownprofile_getsupportedlockdownprofiles_256252409.md b/windows.embedded.devicelockdown/devicelockdownprofile_getsupportedlockdownprofiles_256252409.md index 85ebe14b09..fa3a369bcc 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofile_getsupportedlockdownprofiles_256252409.md +++ b/windows.embedded.devicelockdown/devicelockdownprofile_getsupportedlockdownprofiles_256252409.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetSupportedLockdownProfiles --api-type: winrt method ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetSupportedLockdownProfiles ## -description Gets the list of supported user role IDs. ## -returns List of supported profile IDs. ## -remarks ## -examples ## -see-also ## -capabilities enterpriseDeviceLockdown \ No newline at end of file +--- +-api-id: M:Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetSupportedLockdownProfiles +-api-type: winrt method +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfile.GetSupportedLockdownProfiles + +## -description +Gets the list of supported user role IDs. + +## -returns +List of supported profile IDs. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +enterpriseDeviceLockdown \ No newline at end of file diff --git a/windows.embedded.devicelockdown/devicelockdownprofileinformation.md b/windows.embedded.devicelockdown/devicelockdownprofileinformation.md index ff5528d87c..6b11d49784 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofileinformation.md +++ b/windows.embedded.devicelockdown/devicelockdownprofileinformation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation --api-type: winrt class ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation ## -description Represents the user role information. ## -remarks To use this API, certain capabilities and roles need to be configured. For information, see the remarks in [Windows.Embedded.DeviceLockdown](windows_embedded_devicelockdown.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation +-api-type: winrt class +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation + +## -description +Represents the user role information. + +## -remarks +To use this API, certain capabilities and roles need to be configured. For information, see the remarks in [Windows.Embedded.DeviceLockdown](windows_embedded_devicelockdown.md). + +## -examples + +## -see-also diff --git a/windows.embedded.devicelockdown/devicelockdownprofileinformation_name.md b/windows.embedded.devicelockdown/devicelockdownprofileinformation_name.md index 10fc3ee841..d0af7a4ba0 100644 --- a/windows.embedded.devicelockdown/devicelockdownprofileinformation_name.md +++ b/windows.embedded.devicelockdown/devicelockdownprofileinformation_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation.Name --api-type: winrt property ---- # Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation.Name ## -description Gets the user descriptor string. ## -property-value User role ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation.Name +-api-type: winrt property +--- + + + +# Windows.Embedded.DeviceLockdown.DeviceLockdownProfileInformation.Name + +## -description +Gets the user descriptor string. + +## -property-value +User role ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/ivectorchangedeventargs_collectionchange.md b/windows.foundation.collections/ivectorchangedeventargs_collectionchange.md index e500008c19..32a4e898ba 100644 --- a/windows.foundation.collections/ivectorchangedeventargs_collectionchange.md +++ b/windows.foundation.collections/ivectorchangedeventargs_collectionchange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Collections.IVectorChangedEventArgs.CollectionChange --api-type: winrt property ---- # Windows.Foundation.Collections.IVectorChangedEventArgs.CollectionChange ## -description Gets the type of change that occurred in the vector. ## -property-value The type of change in the vector. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Collections.IVectorChangedEventArgs.CollectionChange +-api-type: winrt property +--- + + + +# Windows.Foundation.Collections.IVectorChangedEventArgs.CollectionChange + +## -description +Gets the type of change that occurred in the vector. + +## -property-value +The type of change in the vector. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/ivectorchangedeventargs_index.md b/windows.foundation.collections/ivectorchangedeventargs_index.md index 2e34b94626..d45f4acf1d 100644 --- a/windows.foundation.collections/ivectorchangedeventargs_index.md +++ b/windows.foundation.collections/ivectorchangedeventargs_index.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Collections.IVectorChangedEventArgs.Index --api-type: winrt property ---- # Windows.Foundation.Collections.IVectorChangedEventArgs.Index ## -description Gets the position where the change occurred in the vector. ## -property-value The zero-based position where the change occurred in the vector, if applicable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Collections.IVectorChangedEventArgs.Index +-api-type: winrt property +--- + + + +# Windows.Foundation.Collections.IVectorChangedEventArgs.Index + +## -description +Gets the position where the change occurred in the vector. + +## -property-value +The zero-based position where the change occurred in the vector, if applicable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_clear_556466.md b/windows.foundation.collections/propertyset_clear_556466.md index a993f962a2..8b6dda2c33 100644 --- a/windows.foundation.collections/propertyset_clear_556466.md +++ b/windows.foundation.collections/propertyset_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.Clear --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.Clear ## -description Removes all items from the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.Clear +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.Clear + +## -description +Removes all items from the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_first_1920739956.md b/windows.foundation.collections/propertyset_first_1920739956.md index 272be0e9cf..1de9bd1aac 100644 --- a/windows.foundation.collections/propertyset_first_1920739956.md +++ b/windows.foundation.collections/propertyset_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.First --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.First ## -description Returns an iterator to enumerate the items in the property set. ## -returns The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.First +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.First + +## -description +Returns an iterator to enumerate the items in the property set. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_getview_37498667.md b/windows.foundation.collections/propertyset_getview_37498667.md index 9b50f3600e..82ffa649b4 100644 --- a/windows.foundation.collections/propertyset_getview_37498667.md +++ b/windows.foundation.collections/propertyset_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.GetView --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.GetView ## -description Gets an immutable view of the property set. ## -returns The immutable view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.GetView +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.GetView + +## -description +Gets an immutable view of the property set. + +## -returns +The immutable view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_haskey_425964900.md b/windows.foundation.collections/propertyset_haskey_425964900.md index d85c0b9873..2e23d0817d 100644 --- a/windows.foundation.collections/propertyset_haskey_425964900.md +++ b/windows.foundation.collections/propertyset_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.HasKey(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.HasKey ## -description Indicates whether the property set has an item with the specified key. ## -parameters ### -param key The key. ## -returns True if the property set has an item with the specified key; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.HasKey + +## -description +Indicates whether the property set has an item with the specified key. + +## -parameters +### -param key +The key. + +## -returns +True if the property set has an item with the specified key; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_insert_2123640444.md b/windows.foundation.collections/propertyset_insert_2123640444.md index bf71f37237..b461febead 100644 --- a/windows.foundation.collections/propertyset_insert_2123640444.md +++ b/windows.foundation.collections/propertyset_insert_2123640444.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.Insert(System.String,System.Object) --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.Insert ## -description Adds an item to the property set. ## -parameters ### -param key The key to insert. ### -param value The value to insert. ## -returns True if the method replaces a value that already exists for the key; false if this is a new key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.Insert(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.Insert + +## -description +Adds an item to the property set. + +## -parameters +### -param key +The key to insert. + +### -param value +The value to insert. + +## -returns +True if the method replaces a value that already exists for the key; false if this is a new key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_lookup_711408188.md b/windows.foundation.collections/propertyset_lookup_711408188.md index f2cc3ffa5b..af0c2448f1 100644 --- a/windows.foundation.collections/propertyset_lookup_711408188.md +++ b/windows.foundation.collections/propertyset_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.Lookup(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.Lookup ## -description Retrieves the value for the specified key. ## -parameters ### -param key The key. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.Lookup + +## -description +Retrieves the value for the specified key. + +## -parameters +### -param key +The key. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_mapchanged.md b/windows.foundation.collections/propertyset_mapchanged.md index c846f30138..3c69bd601b 100644 --- a/windows.foundation.collections/propertyset_mapchanged.md +++ b/windows.foundation.collections/propertyset_mapchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Foundation.Collections.PropertySet.MapChanged --api-type: winrt event ---- # Windows.Foundation.Collections.PropertySet.MapChanged ## -description Occurs when the observable map has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Collections.PropertySet.MapChanged +-api-type: winrt event +--- + + + +# Windows.Foundation.Collections.PropertySet.MapChanged + +## -description +Occurs when the observable map has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_propertyset_1221375020.md b/windows.foundation.collections/propertyset_propertyset_1221375020.md index 90580ff35e..e69a9b2388 100644 --- a/windows.foundation.collections/propertyset_propertyset_1221375020.md +++ b/windows.foundation.collections/propertyset_propertyset_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.#ctor --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.PropertySet ## -description Creates and initializes a new instance of the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.PropertySet + +## -description +Creates and initializes a new instance of the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_remove_1498489487.md b/windows.foundation.collections/propertyset_remove_1498489487.md index c96f074947..79930d2ea6 100644 --- a/windows.foundation.collections/propertyset_remove_1498489487.md +++ b/windows.foundation.collections/propertyset_remove_1498489487.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Collections.PropertySet.Remove(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.PropertySet.Remove ## -description Removes an item from the property set. ## -parameters ### -param key The key. ## -remarks For the C# or Microsoft Visual Basic version of the **Remove** method, see [Remove](propertyset_remove_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.PropertySet.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.PropertySet.Remove + +## -description +Removes an item from the property set. + +## -parameters +### -param key +The key. + +## -remarks +For the C# or Microsoft Visual Basic version of the **Remove** method, see [Remove](propertyset_remove_2.md). + +## -examples + +## -see-also diff --git a/windows.foundation.collections/propertyset_size.md b/windows.foundation.collections/propertyset_size.md index 8907b10062..091f03283c 100644 --- a/windows.foundation.collections/propertyset_size.md +++ b/windows.foundation.collections/propertyset_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Collections.PropertySet.Size --api-type: winrt property ---- # Windows.Foundation.Collections.PropertySet.Size ## -description Gets the number of items contained in the property set. ## -property-value The number of items in the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Collections.PropertySet.Size +-api-type: winrt property +--- + + + +# Windows.Foundation.Collections.PropertySet.Size + +## -description +Gets the number of items contained in the property set. + +## -property-value +The number of items in the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap.md b/windows.foundation.collections/stringmap.md index 33d40672bf..b13c5ee667 100644 --- a/windows.foundation.collections/stringmap.md +++ b/windows.foundation.collections/stringmap.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Foundation.Collections.StringMap --api-type: winrt class ---- # Windows.Foundation.Collections.StringMap ## -description An associative collection, also known as a map or a dictionary. ## -remarks This class allows JavaScript to easily iterate over a collection for which strings are the only expected value for both keys and values. ## -examples ## -see-also [IMap(String, String)](imap_2.md), [IIterable(IKeyValuePair)](iiterable_1.md), [IObservableMap(String, String)](iobservablemap_2.md) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Collections.StringMap +-api-type: winrt class +--- + + + +# Windows.Foundation.Collections.StringMap + +## -description +An associative collection, also known as a map or a dictionary. + +## -remarks +This class allows JavaScript to easily iterate over a collection for which strings are the only expected value for both keys and values. + +## -examples + +## -see-also +[IMap(String, String)](imap_2.md), [IIterable(IKeyValuePair)](iiterable_1.md), [IObservableMap(String, String)](iobservablemap_2.md) \ No newline at end of file diff --git a/windows.foundation.collections/stringmap_clear_556466.md b/windows.foundation.collections/stringmap_clear_556466.md index 6e000d558e..022ec65fd3 100644 --- a/windows.foundation.collections/stringmap_clear_556466.md +++ b/windows.foundation.collections/stringmap_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.Clear --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.Clear ## -description Removes all items from the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.Clear +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.Clear + +## -description +Removes all items from the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_first_1920739956.md b/windows.foundation.collections/stringmap_first_1920739956.md index 005f7fa1ef..68db2d619f 100644 --- a/windows.foundation.collections/stringmap_first_1920739956.md +++ b/windows.foundation.collections/stringmap_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.First --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.First ## -description Returns an iterator containing the items in the collection. ## -returns The items in the collection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.First +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.First + +## -description +Returns an iterator containing the items in the collection. + +## -returns +The items in the collection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_getview_37498667.md b/windows.foundation.collections/stringmap_getview_37498667.md index 642a3a2818..f9c53f8888 100644 --- a/windows.foundation.collections/stringmap_getview_37498667.md +++ b/windows.foundation.collections/stringmap_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.GetView --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.GetView ## -description Returns an immutable view of the map. ## -returns The view of the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.GetView +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.GetView + +## -description +Returns an immutable view of the map. + +## -returns +The view of the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_haskey_425964900.md b/windows.foundation.collections/stringmap_haskey_425964900.md index 5ade12d513..cc084170fb 100644 --- a/windows.foundation.collections/stringmap_haskey_425964900.md +++ b/windows.foundation.collections/stringmap_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.HasKey(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.HasKey ## -description Determines whether the map contains the specified key. ## -parameters ### -param key The key associated with the item to locate. ## -returns True if the key is found; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.HasKey + +## -description +Determines whether the map contains the specified key. + +## -parameters +### -param key +The key associated with the item to locate. + +## -returns +True if the key is found; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_insert_2006825190.md b/windows.foundation.collections/stringmap_insert_2006825190.md index e0c40226c3..c24e7dcaa6 100644 --- a/windows.foundation.collections/stringmap_insert_2006825190.md +++ b/windows.foundation.collections/stringmap_insert_2006825190.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.Insert(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.Insert ## -description Inserts or replaces an item in the map. ## -parameters ### -param key The key associated with the item to insert. ### -param value The item to insert. ## -returns True if an item with the specified key is an existing item that was replaced; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.Insert(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.Insert + +## -description +Inserts or replaces an item in the map. + +## -parameters +### -param key +The key associated with the item to insert. + +### -param value +The item to insert. + +## -returns +True if an item with the specified key is an existing item that was replaced; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_lookup_711408188.md b/windows.foundation.collections/stringmap_lookup_711408188.md index 3ea5f5132a..a3dc887a73 100644 --- a/windows.foundation.collections/stringmap_lookup_711408188.md +++ b/windows.foundation.collections/stringmap_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.Lookup(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.Lookup ## -description Returns the item at the specified key in the map. ## -parameters ### -param key The key associated with the item to locate. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.Lookup + +## -description +Returns the item at the specified key in the map. + +## -parameters +### -param key +The key associated with the item to locate. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_mapchanged.md b/windows.foundation.collections/stringmap_mapchanged.md index bdc0ec67bd..d28fc70c25 100644 --- a/windows.foundation.collections/stringmap_mapchanged.md +++ b/windows.foundation.collections/stringmap_mapchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Foundation.Collections.StringMap.MapChanged --api-type: winrt event ---- # Windows.Foundation.Collections.StringMap.MapChanged ## -description Occurs when the contents of the map change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Collections.StringMap.MapChanged +-api-type: winrt event +--- + + + +# Windows.Foundation.Collections.StringMap.MapChanged + +## -description +Occurs when the contents of the map change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_remove_1498489487.md b/windows.foundation.collections/stringmap_remove_1498489487.md index 5687d71e30..e9bf811a96 100644 --- a/windows.foundation.collections/stringmap_remove_1498489487.md +++ b/windows.foundation.collections/stringmap_remove_1498489487.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.Remove(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.Remove ## -description Removes an item from the map. ## -parameters ### -param key The key associated with the item to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.Remove + +## -description +Removes an item from the map. + +## -parameters +### -param key +The key associated with the item to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_size.md b/windows.foundation.collections/stringmap_size.md index c3c3ed4ded..c79e47a4ac 100644 --- a/windows.foundation.collections/stringmap_size.md +++ b/windows.foundation.collections/stringmap_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Collections.StringMap.Size --api-type: winrt property ---- # Windows.Foundation.Collections.StringMap.Size ## -description Gets the number of items in the map. ## -property-value The number of items in the map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Collections.StringMap.Size +-api-type: winrt property +--- + + + +# Windows.Foundation.Collections.StringMap.Size + +## -description +Gets the number of items in the map. + +## -property-value +The number of items in the map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/stringmap_stringmap_1221375020.md b/windows.foundation.collections/stringmap_stringmap_1221375020.md index 48732db805..8b09b3885d 100644 --- a/windows.foundation.collections/stringmap_stringmap_1221375020.md +++ b/windows.foundation.collections/stringmap_stringmap_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Collections.StringMap.#ctor --api-type: winrt method ---- # Windows.Foundation.Collections.StringMap.StringMap ## -description Creates and initializes a new instance of the StringMap. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.StringMap.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.StringMap.StringMap + +## -description +Creates and initializes a new instance of the StringMap. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/valueset_clear_556466.md b/windows.foundation.collections/valueset_clear_556466.md index c5193b1b53..ab04ec45dc 100644 --- a/windows.foundation.collections/valueset_clear_556466.md +++ b/windows.foundation.collections/valueset_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.Clear --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.Clear ## -description Removes all items from the value set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.Clear +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.Clear + +## -description +Removes all items from the value set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/valueset_first_1920739956.md b/windows.foundation.collections/valueset_first_1920739956.md index bab38cdf5b..e948810709 100644 --- a/windows.foundation.collections/valueset_first_1920739956.md +++ b/windows.foundation.collections/valueset_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.First --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.First ## -description Returns an iterator to enumerate the items in the value set. ## -returns The iterator. The current position of the iterator is index 0, or the end of the value set if the value set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.First +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.First + +## -description +Returns an iterator to enumerate the items in the value set. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the value set if the value set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/valueset_getview_37498667.md b/windows.foundation.collections/valueset_getview_37498667.md index 0fa9393476..3711037deb 100644 --- a/windows.foundation.collections/valueset_getview_37498667.md +++ b/windows.foundation.collections/valueset_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.GetView --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.GetView ## -description Gets an immutable view of the value set. ## -returns The immutable view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.GetView +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.GetView + +## -description +Gets an immutable view of the value set. + +## -returns +The immutable view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/valueset_haskey_425964900.md b/windows.foundation.collections/valueset_haskey_425964900.md index 08aafc0deb..2bc658ac03 100644 --- a/windows.foundation.collections/valueset_haskey_425964900.md +++ b/windows.foundation.collections/valueset_haskey_425964900.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.HasKey(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.HasKey ## -description Indicates whether the value set has an item with the specified key. ## -parameters ### -param key The key. ## -returns True if the value set has an item with the specified key; otherwise, false. ## -remarks Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [ContainsKey](valueset_containskey.md). ## -examples ## -see-also [ContainsKey](valueset_containskey.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.HasKey + +## -description +Indicates whether the value set has an item with the specified key. + +## -parameters +### -param key +The key. + +## -returns +True if the value set has an item with the specified key; otherwise, false. + +## -remarks +Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [ContainsKey](valueset_containskey.md). + +## -examples + +## -see-also +[ContainsKey](valueset_containskey.md) \ No newline at end of file diff --git a/windows.foundation.collections/valueset_insert_2123640444.md b/windows.foundation.collections/valueset_insert_2123640444.md index 7901fa31b6..755f21679d 100644 --- a/windows.foundation.collections/valueset_insert_2123640444.md +++ b/windows.foundation.collections/valueset_insert_2123640444.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.Insert(System.String,System.Object) --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.Insert ## -description Adds an item to the value set. ## -parameters ### -param key The key to insert. ### -param value The value to insert. ## -returns True if the method replaces a value that already exists for the key; false if this is a new key. ## -remarks Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [Add(String,Object)](valueset_add_2.md) and [Add(KeyValuePair)](valueset_add_1.md). ## -examples ## -see-also [Add(String,Object)](valueset_add_2.md), [Add(KeyValuePair)](valueset_add_1.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.Insert(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.Insert + +## -description +Adds an item to the value set. + +## -parameters +### -param key +The key to insert. + +### -param value +The value to insert. + +## -returns +True if the method replaces a value that already exists for the key; false if this is a new key. + +## -remarks +Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [Add(String,Object)](valueset_add_2.md) and [Add(KeyValuePair)](valueset_add_1.md). + +## -examples + +## -see-also +[Add(String,Object)](valueset_add_2.md), [Add(KeyValuePair)](valueset_add_1.md) \ No newline at end of file diff --git a/windows.foundation.collections/valueset_lookup_711408188.md b/windows.foundation.collections/valueset_lookup_711408188.md index 0d421c2214..69dfb56e17 100644 --- a/windows.foundation.collections/valueset_lookup_711408188.md +++ b/windows.foundation.collections/valueset_lookup_711408188.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.Lookup(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.Lookup ## -description Retrieves the value for the specified key. ## -parameters ### -param key The key. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [TryGetValue](valueset_trygetvalue.md). ## -examples ## -see-also [TryGetValue](valueset_trygetvalue.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.Lookup + +## -description +Retrieves the value for the specified key. + +## -parameters +### -param key +The key. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks +Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [TryGetValue](valueset_trygetvalue.md). + +## -examples + +## -see-also +[TryGetValue](valueset_trygetvalue.md) \ No newline at end of file diff --git a/windows.foundation.collections/valueset_mapchanged.md b/windows.foundation.collections/valueset_mapchanged.md index 0bfdb63d86..7609a9ea73 100644 --- a/windows.foundation.collections/valueset_mapchanged.md +++ b/windows.foundation.collections/valueset_mapchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Foundation.Collections.ValueSet.MapChanged --api-type: winrt event ---- # Windows.Foundation.Collections.ValueSet.MapChanged ## -description Occurs when the observable map has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Collections.ValueSet.MapChanged +-api-type: winrt event +--- + + + +# Windows.Foundation.Collections.ValueSet.MapChanged + +## -description +Occurs when the observable map has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.collections/valueset_remove_1498489487.md b/windows.foundation.collections/valueset_remove_1498489487.md index f4793fe511..f26c7ce2d1 100644 --- a/windows.foundation.collections/valueset_remove_1498489487.md +++ b/windows.foundation.collections/valueset_remove_1498489487.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.Remove(System.String) --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.Remove ## -description Removes an item from the value set. ## -parameters ### -param key The key. ## -remarks Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [Remove(String)](valueset_remove_2.md) and [Remove(KeyValuePair)](valueset_remove_1.md). ## -examples ## -see-also [Remove(String)](valueset_remove_2.md), [Remove(KeyValuePair)](valueset_remove_1.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.Remove + +## -description +Removes an item from the value set. + +## -parameters +### -param key +The key. + +## -remarks +Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [Remove(String)](valueset_remove_2.md) and [Remove(KeyValuePair)](valueset_remove_1.md). + +## -examples + +## -see-also +[Remove(String)](valueset_remove_2.md), [Remove(KeyValuePair)](valueset_remove_1.md) \ No newline at end of file diff --git a/windows.foundation.collections/valueset_size.md b/windows.foundation.collections/valueset_size.md index d077e86fcf..20be6f4071 100644 --- a/windows.foundation.collections/valueset_size.md +++ b/windows.foundation.collections/valueset_size.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Collections.ValueSet.Size --api-type: winrt property ---- # Windows.Foundation.Collections.ValueSet.Size ## -description Gets the number of items contained in the value set. ## -property-value The number of items in the value set. ## -remarks Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [Count](valueset_count.md). ## -examples ## -see-also [Count](valueset_count.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Collections.ValueSet.Size +-api-type: winrt property +--- + + + +# Windows.Foundation.Collections.ValueSet.Size + +## -description +Gets the number of items contained in the value set. + +## -property-value +The number of items in the value set. + +## -remarks +Some functionality in this class is restricted to specific development languages. The parent topic, [ValueSet](valueset.md) class, indicates which members are accessible in specific languages. For functionality similar to this member, see [Count](valueset_count.md). + +## -examples + +## -see-also +[Count](valueset_count.md) \ No newline at end of file diff --git a/windows.foundation.collections/valueset_valueset_1221375020.md b/windows.foundation.collections/valueset_valueset_1221375020.md index 4f9279b7f4..6d8072ca4c 100644 --- a/windows.foundation.collections/valueset_valueset_1221375020.md +++ b/windows.foundation.collections/valueset_valueset_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Collections.ValueSet.#ctor --api-type: winrt method ---- # Windows.Foundation.Collections.ValueSet.ValueSet ## -description Creates and initializes a new instance of the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Collections.ValueSet.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.ValueSet.ValueSet + +## -description +Creates and initializes a new instance of the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/asynccausalitytracer.md b/windows.foundation.diagnostics/asynccausalitytracer.md index 0110f1b181..1e7c4fdff5 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer.md +++ b/windows.foundation.diagnostics/asynccausalitytracer.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.AsyncCausalityTracer --api-type: winrt class ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer ## -description Enables tracing control flow across asynchronous operations. ## -remarks The [AsyncCausalityTracer](asynccausalitytracer.md) class provides methods that enable creating, propagating, and tracking causality as control flows across asynchronous operations. The causality is an abstraction for tracking both asynchronous and synchronous activities. You can use the collected data to develop causality graphs that are useful for debugging. Causality tracing uses event tracing for Windows (ETW) for logging. ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.AsyncCausalityTracer +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer + +## -description +Enables tracing control flow across asynchronous operations. + +## -remarks +The [AsyncCausalityTracer](asynccausalitytracer.md) class provides methods that enable creating, propagating, and tracking causality as control flows across asynchronous operations. The causality is an abstraction for tracking both asynchronous and synchronous activities. You can use the collected data to develop causality graphs that are useful for debugging. Causality tracing uses event tracing for Windows (ETW) for logging. + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcompletion_570067049.md b/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcompletion_570067049.md index 56a580ee6a..8a0df5e79a 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcompletion_570067049.md +++ b/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcompletion_570067049.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCompletion(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,Windows.Foundation.AsyncStatus) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCompletion ## -description Indicates that a previously created asynchronous operation has completed all of its asynchronous work. ## -parameters ### -param traceLevel The trace level. ### -param source The trace source. ### -param platformId Identifier for the operation type. ### -param operationId The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. ### -param status The completion status of the asynchronous operation. ## -remarks This function is used to indicate that a previously created asynchronous operation has completed all of its asynchronous work. The only work that the operation may schedule after logging completion is its completion continuation. The *operationId* and *platformId* parameters must match an asynchronous operation that was previously logged by a call to the [TraceOperationCreation](asynccausalitytracer_traceoperationcreation.md) method. ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md), [TraceOperationCreation](asynccausalitytracer_traceoperationcreation.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCompletion(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,Windows.Foundation.AsyncStatus) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCompletion + +## -description +Indicates that a previously created asynchronous operation has completed all of its asynchronous work. + +## -parameters +### -param traceLevel +The trace level. + +### -param source +The trace source. + +### -param platformId +Identifier for the operation type. + +### -param operationId +The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. + +### -param status +The completion status of the asynchronous operation. + +## -remarks +This function is used to indicate that a previously created asynchronous operation has completed all of its asynchronous work. The only work that the operation may schedule after logging completion is its completion continuation. The *operationId* and *platformId* parameters must match an asynchronous operation that was previously logged by a call to the [TraceOperationCreation](asynccausalitytracer_traceoperationcreation.md) method. + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md), [TraceOperationCreation](asynccausalitytracer_traceoperationcreation.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcreation_1939304732.md b/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcreation_1939304732.md index 50341e4d43..c0e6a823d6 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcreation_1939304732.md +++ b/windows.foundation.diagnostics/asynccausalitytracer_traceoperationcreation_1939304732.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCreation(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,System.String,System.UInt64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCreation ## -description Logs the creation of an asynchronous operation. ## -parameters ### -param traceLevel The trace level. ### -param source The trace source. ### -param platformId Identifier for the operation type. ### -param operationId An identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. ### -param operationName A human-readable description of the asynchronous work. ### -param relatedContext Additional information related to this operation. ## -remarks Use the [TraceOperationCreation](asynccausalitytracer_traceoperationcreation.md) method to log the creation of an asynchronous operation. An asynchronous operation represents a group of zero or more related synchronous work items that may be scheduled in an asynchronous way. Each asynchronous operation has a 128-bit GUID that identifies the operation type, like BCL task and WinJS Promise, and a **UInt64** operation identifier that must be unique within the platform for the lifetime of the asynchronous operation. Good choices for *operationId* include a native pointer to an underlying object, or an integer that's incremented for each new operation. The *operationName* should be a human readable description of the asynchronous work. The *relatedContext* associates any additional information related to this operation. ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCreation(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,System.String,System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationCreation + +## -description +Logs the creation of an asynchronous operation. + +## -parameters +### -param traceLevel +The trace level. + +### -param source +The trace source. + +### -param platformId +Identifier for the operation type. + +### -param operationId +An identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. + +### -param operationName +A human-readable description of the asynchronous work. + +### -param relatedContext +Additional information related to this operation. + +## -remarks +Use the [TraceOperationCreation](asynccausalitytracer_traceoperationcreation.md) method to log the creation of an asynchronous operation. An asynchronous operation represents a group of zero or more related synchronous work items that may be scheduled in an asynchronous way. Each asynchronous operation has a 128-bit GUID that identifies the operation type, like BCL task and WinJS Promise, and a **UInt64** operation identifier that must be unique within the platform for the lifetime of the asynchronous operation. Good choices for *operationId* include a native pointer to an underlying object, or an integer that's incremented for each new operation. The *operationName* should be a human readable description of the asynchronous work. The *relatedContext* associates any additional information related to this operation. + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/asynccausalitytracer_traceoperationrelation_1311244406.md b/windows.foundation.diagnostics/asynccausalitytracer_traceoperationrelation_1311244406.md index 4e67dbc645..c91c22142a 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer_traceoperationrelation_1311244406.md +++ b/windows.foundation.diagnostics/asynccausalitytracer_traceoperationrelation_1311244406.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationRelation(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,Windows.Foundation.Diagnostics.CausalityRelation) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationRelation ## -description Logs the relation between the currently running synchronous work item and a specific asynchronous operation that it's related to. ## -parameters ### -param traceLevel The trace level. ### -param source The trace source. ### -param platformId Identifier for the operation type. ### -param operationId The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. ### -param relation The relationship between the synchronous work item and asynchronous operation identified by *operationId*. ## -remarks Causality relations track ways that synchronous work items may interact with asynchronous operations. ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationRelation(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,Windows.Foundation.Diagnostics.CausalityRelation) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceOperationRelation + +## -description +Logs the relation between the currently running synchronous work item and a specific asynchronous operation that it's related to. + +## -parameters +### -param traceLevel +The trace level. + +### -param source +The trace source. + +### -param platformId +Identifier for the operation type. + +### -param operationId +The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. + +### -param relation +The relationship between the synchronous work item and asynchronous operation identified by *operationId*. + +## -remarks +Causality relations track ways that synchronous work items may interact with asynchronous operations. + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkcompletion_1223030300.md b/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkcompletion_1223030300.md index 5869b58aac..4f1048138e 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkcompletion_1223030300.md +++ b/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkcompletion_1223030300.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkCompletion(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,Windows.Foundation.Diagnostics.CausalitySynchronousWork) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkCompletion ## -description Indicates that the most recently created synchronous work item running on the thread that the [TraceSynchronousWorkCompletion](asynccausalitytracer_tracesynchronousworkcompletion.md) method is called on has completed. ## -parameters ### -param traceLevel The trace level. ### -param source The trace source. ### -param work Indicates the type of completion. ## -remarks ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkCompletion(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,Windows.Foundation.Diagnostics.CausalitySynchronousWork) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkCompletion + +## -description +Indicates that the most recently created synchronous work item running on the thread that the [TraceSynchronousWorkCompletion](asynccausalitytracer_tracesynchronousworkcompletion.md) method is called on has completed. + +## -parameters +### -param traceLevel +The trace level. + +### -param source +The trace source. + +### -param work +Indicates the type of completion. + +## -remarks + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkstart_590757521.md b/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkstart_590757521.md index 99401f483f..010fad331a 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkstart_590757521.md +++ b/windows.foundation.diagnostics/asynccausalitytracer_tracesynchronousworkstart_590757521.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkStart(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,Windows.Foundation.Diagnostics.CausalitySynchronousWork) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkStart ## -description Indicates that the specified asynchronous operation is scheduling synchronous work on the thread that the [TraceSynchronousWorkStart](asynccausalitytracer_tracesynchronousworkstart.md) method is called on. ## -parameters ### -param traceLevel The trace level. ### -param source The trace source. ### -param platformId Identifier for the operation type. ### -param operationId The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. ### -param work The relationship between the work item and the asynchronous operation. ## -remarks ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkStart(Windows.Foundation.Diagnostics.CausalityTraceLevel,Windows.Foundation.Diagnostics.CausalitySource,System.Guid,System.UInt64,Windows.Foundation.Diagnostics.CausalitySynchronousWork) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer.TraceSynchronousWorkStart + +## -description +Indicates that the specified asynchronous operation is scheduling synchronous work on the thread that the [TraceSynchronousWorkStart](asynccausalitytracer_tracesynchronousworkstart.md) method is called on. + +## -parameters +### -param traceLevel +The trace level. + +### -param source +The trace source. + +### -param platformId +Identifier for the operation type. + +### -param operationId +The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. + +### -param work +The relationship between the work item and the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/asynccausalitytracer_tracingstatuschanged.md b/windows.foundation.diagnostics/asynccausalitytracer_tracingstatuschanged.md index 92be9c1a2c..37dda725de 100644 --- a/windows.foundation.diagnostics/asynccausalitytracer_tracingstatuschanged.md +++ b/windows.foundation.diagnostics/asynccausalitytracer_tracingstatuschanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TracingStatusChanged --api-type: winrt event ---- # Windows.Foundation.Diagnostics.AsyncCausalityTracer.TracingStatusChanged ## -description Raised when a client starts listening to the causality trace. ## -remarks The logging level and flags are passed to enable fine-grained decisions about which instrumentation points should be enabled. The [TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) event is raised when logging is disabled. ## -examples ## -see-also [CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Diagnostics.AsyncCausalityTracer.TracingStatusChanged +-api-type: winrt event +--- + + + +# Windows.Foundation.Diagnostics.AsyncCausalityTracer.TracingStatusChanged + +## -description +Raised when a client starts listening to the causality trace. + +## -remarks +The logging level and flags are passed to enable fine-grained decisions about which instrumentation points should be enabled. + +The [TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) event is raised when logging is disabled. + +## -examples + +## -see-also +[CausalityRelation](causalityrelation.md), [CausalitySource](causalitysource.md), [CausalitySynchronousWork](causalitysynchronouswork.md), [CausalityTraceLevel](causalitytracelevel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/errordetails.md b/windows.foundation.diagnostics/errordetails.md index 8223f248f0..6c7132c02a 100644 --- a/windows.foundation.diagnostics/errordetails.md +++ b/windows.foundation.diagnostics/errordetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.ErrorDetails --api-type: winrt class ---- # Windows.Foundation.Diagnostics.ErrorDetails ## -description Provides information about an error that occurred. ## -remarks Constructed using the [CreateFromHResult](errordetails_createfromhresultasync.md) factory method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.ErrorDetails +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.ErrorDetails + +## -description +Provides information about an error that occurred. + +## -remarks +Constructed using the [CreateFromHResult](errordetails_createfromhresultasync.md) factory method. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/errordetails_createfromhresultasync_172714447.md b/windows.foundation.diagnostics/errordetails_createfromhresultasync_172714447.md index a319b7fbfb..21db2210d1 100644 --- a/windows.foundation.diagnostics/errordetails_createfromhresultasync_172714447.md +++ b/windows.foundation.diagnostics/errordetails_createfromhresultasync_172714447.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ErrorDetails.CreateFromHResultAsync(System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ErrorDetails.CreateFromHResultAsync ## -description Asynchronously creates an [ErrorDetails](errordetails.md) object based on an **HRESULT** error code. ## -parameters ### -param errorCode The unique code representing the error. ## -returns The newly created [ErrorDetails](errordetails.md) object representing the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ErrorDetails.CreateFromHResultAsync(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ErrorDetails.CreateFromHResultAsync + +## -description +Asynchronously creates an [ErrorDetails](errordetails.md) object based on an **HRESULT** error code. + +## -parameters +### -param errorCode +The unique code representing the error. + +## -returns +The newly created [ErrorDetails](errordetails.md) object representing the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/errordetails_description.md b/windows.foundation.diagnostics/errordetails_description.md index ec27460cb5..96e8ef8bf0 100644 --- a/windows.foundation.diagnostics/errordetails_description.md +++ b/windows.foundation.diagnostics/errordetails_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ErrorDetails.Description --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ErrorDetails.Description ## -description Gets a short description of the error. ## -property-value A short description of the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ErrorDetails.Description +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ErrorDetails.Description + +## -description +Gets a short description of the error. + +## -property-value +A short description of the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/errordetails_helpuri.md b/windows.foundation.diagnostics/errordetails_helpuri.md index cdc583a810..752ec39d6b 100644 --- a/windows.foundation.diagnostics/errordetails_helpuri.md +++ b/windows.foundation.diagnostics/errordetails_helpuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ErrorDetails.HelpUri --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ErrorDetails.HelpUri ## -description Gets the address to a help page about the error. ## -property-value The address to a help page about the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ErrorDetails.HelpUri +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ErrorDetails.HelpUri + +## -description +Gets the address to a help page about the error. + +## -property-value +The address to a help page about the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/errordetails_longdescription.md b/windows.foundation.diagnostics/errordetails_longdescription.md index e77fa8e57d..3ee8c96397 100644 --- a/windows.foundation.diagnostics/errordetails_longdescription.md +++ b/windows.foundation.diagnostics/errordetails_longdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ErrorDetails.LongDescription --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ErrorDetails.LongDescription ## -description Gets a detailed description of the error. ## -property-value A detailed description of the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ErrorDetails.LongDescription +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ErrorDetails.LongDescription + +## -description +Gets a detailed description of the error. + +## -property-value +A detailed description of the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/fileloggingsession.md b/windows.foundation.diagnostics/fileloggingsession.md index 300610d25e..189478273c 100644 --- a/windows.foundation.diagnostics/fileloggingsession.md +++ b/windows.foundation.diagnostics/fileloggingsession.md @@ -1,3 +1,46 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.FileLoggingSession --api-type: winrt class ---- # Windows.Foundation.Diagnostics.FileLoggingSession ## -description Represents the destination of logged messages from [LoggingChannel](loggingchannel.md) instances. ## -remarks Use the [FileLoggingSession](fileloggingsession.md) class to log messages and data to a file continuously as your app runs. You can view the log files by using the Windows Performance Toolkit (WPT) and other utilities like tracerpt.exe. Add [LoggingChannel](loggingchannel.md) instances to a [FileLoggingSession](fileloggingsession.md), and call [FileLoggingSession](fileloggingsession.md) instance methods to remove channels, dispose, and perform other operations. The number of channels is not currently limited. > **Windows Server 2012 R2Windows 8.1** > Each app is limited to 4 active channels, and channels must have unique names. The [FileLoggingSession](fileloggingsession.md) class sends logged messages to disk files as they are logged. The [FileLoggingSession](fileloggingsession.md) class uses sequential logging, which means that all messages are sent to a disk file, and a sequential history of messages is retained. This is distinct from the [LoggingSession](loggingsession.md) class, which sends logged messages to disk on-demand, i.e. when the app detects a problem and saves the in-memory messages for analysis. Use the [FileLoggingSession](fileloggingsession.md) class when you know that all messages need to be saved, usually over a long period of time, and when the app can't be burdened with on-demand saving steps. Like the[LoggingSession](loggingsession.md) class, [LoggingChannel](loggingchannel.md) instances are added to a [FileLoggingSession](fileloggingsession.md) instance, and the [FileLoggingSession](fileloggingsession.md) instance has methods to remove channels and dispose. [FileLoggingSession](fileloggingsession.md) instances are initialized with a delegate to a new file callback, which notifies the app when a log file rollover has occurred. The feature invokes the delegate when the current internal log file has reached capacity and a new file is being created for continued sequential logging. The delegate callback can also be called at suspend boundaries, or when the [FileLoggingSession](fileloggingsession.md) is disposed. When the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event is invoked, the app receives an [StorageFile](../windows.storage/storagefile.md) that represents the now-closed log file. The app can forward the log file for processing in an application-defined way. After this, the session continues logging to a newly created and now-open current log file. When this log file reaches capacity, the callback delegate is invoked again for the new file, and the process repeats. When you are done logging events, call [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) in order to get the last log file since the last log file may be still open if it has not yet reached capacity. You can also use [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) to close the session and get access to the last log file. Note that if the last log file was empty, or if all log files have already been reported by the [LogFileGenerated](fileloggingsession_logfilegenerated.md) method, the [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) method will return null. The log files are created in the of the **ApplicationData\Logs** folder. The name of each log file is based on the name of the session plus an index. The index is reset each time a new session is created. Each time a log file reaches maximum size, it is closed, the index is incremented, and a new log file is opened using the new index. (As a consequence, each time you restart an app, it will begin overwriting the log files generated by the previous instance of the app.) You can add a handler for the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event so that your app is notified each time a log file is closed. If you do not use the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event or the [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) method, the [FileLoggingSession](fileloggingsession.md) will not delete stale log files (though a new session may overwrite files generated by a previous session). Your app is responsible for locating and cleaning up the log files as needed. Before a log file is provided to an app via the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event or the [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) method, it is renamed to a special log file name. The same log file name is always used, so new logs will overwrite older logs. In this way, the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event and [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) methods help prevent stale log files from wasting space in the ApplicationData folder. [FileLoggingSession](fileloggingsession.md) will close the current log file and start a new log file when the current log file reaches 256KB. ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [IFileLoggingSession](ifileloggingsession.md), [IClosable](../windows.foundation/iclosable.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.FileLoggingSession +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession + +## -description +Represents the destination of logged messages from [LoggingChannel](loggingchannel.md) instances. + +## -remarks +Use the [FileLoggingSession](fileloggingsession.md) class to log messages and data to a file continuously as your app runs. You can view the log files by using the Windows Performance Toolkit (WPT) and other utilities like tracerpt.exe. + +Add [LoggingChannel](loggingchannel.md) instances to a [FileLoggingSession](fileloggingsession.md), and call [FileLoggingSession](fileloggingsession.md) instance methods to remove channels, dispose, and perform other operations. The number of channels is not currently limited. + +> **Windows Server 2012 R2Windows 8.1** +> Each app is limited to 4 active channels, and channels must have unique names. + +The [FileLoggingSession](fileloggingsession.md) class sends logged messages to disk files as they are logged. The [FileLoggingSession](fileloggingsession.md) class uses sequential logging, which means that all messages are sent to a disk file, and a sequential history of messages is retained. This is distinct from the [LoggingSession](loggingsession.md) class, which sends logged messages to disk on-demand, i.e. when the app detects a problem and saves the in-memory messages for analysis. + +Use the [FileLoggingSession](fileloggingsession.md) class when you know that all messages need to be saved, usually over a long period of time, and when the app can't be burdened with on-demand saving steps. Like the[LoggingSession](loggingsession.md) class, [LoggingChannel](loggingchannel.md) instances are added to a [FileLoggingSession](fileloggingsession.md) instance, and the [FileLoggingSession](fileloggingsession.md) instance has methods to remove channels and dispose. [FileLoggingSession](fileloggingsession.md) instances are initialized with a delegate to a new file callback, which notifies the app when a log file rollover has occurred. The feature invokes the delegate when the current internal log file has reached capacity and a new file is being created for continued sequential logging. The delegate callback can also be called at suspend boundaries, or when the [FileLoggingSession](fileloggingsession.md) is disposed. + +When the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event is invoked, the app receives an [StorageFile](../windows.storage/storagefile.md) that represents the now-closed log file. The app can forward the log file for processing in an application-defined way. After this, the session continues logging to a newly created and now-open current log file. When this log file reaches capacity, the callback delegate is invoked again for the new file, and the process repeats. + +When you are done logging events, call [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) in order to get the last log file since the last log file may be still open if it has not yet reached capacity. You can also use [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) to close the session and get access to the last log file. Note that if the last log file was empty, or if all log files have already been reported by the [LogFileGenerated](fileloggingsession_logfilegenerated.md) method, the [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) method will return null. + +The log files are created in the of the **ApplicationData\Logs** folder. + +The name of each log file is based on the name of the session plus an index. The index is reset each time a new session is created. Each time a log file reaches maximum size, it is closed, the index is incremented, and a new log file is opened using the new index. (As a consequence, each time you restart an app, it will begin overwriting the log files generated by the previous instance of the app.) + +You can add a handler for the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event so that your app is notified each time a log file is closed. + +If you do not use the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event or the [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) method, the [FileLoggingSession](fileloggingsession.md) will not delete stale log files (though a new session may overwrite files generated by a previous session). Your app is responsible for locating and cleaning up the log files as needed. + +Before a log file is provided to an app via the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event or the [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) method, it is renamed to a special log file name. The same log file name is always used, so new logs will overwrite older logs. In this way, the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event and [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) methods help prevent stale log files from wasting space in the ApplicationData folder. + +[FileLoggingSession](fileloggingsession.md) will close the current log file and start a new log file when the current log file reaches 256KB. + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [IFileLoggingSession](ifileloggingsession.md), [IClosable](../windows.foundation/iclosable.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file diff --git a/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_1409249414.md b/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_1409249414.md index 06d56e9598..c6a58be3c8 100644 --- a/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_1409249414.md +++ b/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_1409249414.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel ## -description Adds a logging channel to the current logging session. The logging channel only accepts events that have a logging level at or above the specified logging level. ## -parameters ### -param loggingChannel The logging channel to add. ### -param maxLevel The *minimum* logging level that an event must have to be accepted by the session. ## -remarks *maxLevel* specifies the which events from the channel the session will accept and which are ignored. It does not change the level of the channel itself. ## -examples ## -see-also [AddLoggingChannel(ILoggingChannel)](fileloggingsession_addloggingchannel_604200962.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel + +## -description +Adds a logging channel to the current logging session. The logging channel only accepts events that have a logging level at or above the specified logging level. + +## -parameters +### -param loggingChannel +The logging channel to add. + +### -param maxLevel +The *minimum* logging level that an event must have to be accepted by the session. + +## -remarks +*maxLevel* specifies the which events from the channel the session will accept and which are ignored. It does not change the level of the channel itself. + +## -examples + +## -see-also +[AddLoggingChannel(ILoggingChannel)](fileloggingsession_addloggingchannel_604200962.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_604200962.md b/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_604200962.md index ea30f43f21..c40c5e1150 100644 --- a/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_604200962.md +++ b/windows.foundation.diagnostics/fileloggingsession_addloggingchannel_604200962.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel ## -description Adds a logging channel to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ## -remarks The logging level is set to **LoggingLevel.Verbose**. The **LoggingChannel ** will accept all events. Adding a channel to a session more than once updates the level. ## -examples ## -see-also [AddLoggingChannel(ILoggingChannel, LoggingLevel)](fileloggingsession_addloggingchannel_1409249414.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.AddLoggingChannel + +## -description +Adds a logging channel to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +## -remarks +The logging level is set to **LoggingLevel.Verbose**. The **LoggingChannel ** will accept all events. + +Adding a channel to a session more than once updates the level. + +## -examples + +## -see-also +[AddLoggingChannel(ILoggingChannel, LoggingLevel)](fileloggingsession_addloggingchannel_1409249414.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/fileloggingsession_close_811482585.md b/windows.foundation.diagnostics/fileloggingsession_close_811482585.md index a7848f73dc..6261fc5fdf 100644 --- a/windows.foundation.diagnostics/fileloggingsession_close_811482585.md +++ b/windows.foundation.diagnostics/fileloggingsession_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.Close --api-type: winrt method ---- # Windows.Foundation.Diagnostics.FileLoggingSession.Close ## -description Ends the current logging session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.Close + +## -description +Ends the current logging session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/fileloggingsession_closeandsavetofileasync_867561099.md b/windows.foundation.diagnostics/fileloggingsession_closeandsavetofileasync_867561099.md index 4230cce277..6158189244 100644 --- a/windows.foundation.diagnostics/fileloggingsession_closeandsavetofileasync_867561099.md +++ b/windows.foundation.diagnostics/fileloggingsession_closeandsavetofileasync_867561099.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.CloseAndSaveToFileAsync --api-type: winrt method ---- # Windows.Foundation.Diagnostics.FileLoggingSession.CloseAndSaveToFileAsync ## -description Ends the current logging session and saves it to a file. ## -returns When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). Returns **NULL** if there are no events in the session or if logging has just rolled over into a new file that doesn't contain events yet. ## -remarks [FileLoggingSession.CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) closes the current logging session. If there is a handler for the [LogFileGenerated](fileloggingsession_logfilegenerated.md) method, and it has been called but not returned, the function waits for the handler to return. If there is any data in the current log file that has not already been reported with the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event, the function returns a [StorageFile](../windows.storage/storagefile.md) representing that file. Otherwise, the function returns **NULL**. This can happen if the current log file is empty, or if all log files have already been reported via the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event. Note that [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) might return **NULL** even if data was recorded and even if there is no [LogFileGenerated](fileloggingsession_logfilegenerated.md) event. This can happen if the log file became full and was closed, and a new log file was opened immediately before [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) was called. This function is equivalent to [FileLoggingSession.Close](fileloggingsession_close.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.CloseAndSaveToFileAsync +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.CloseAndSaveToFileAsync + +## -description +Ends the current logging session and saves it to a file. + +## -returns +When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). Returns **NULL** if there are no events in the session or if logging has just rolled over into a new file that doesn't contain events yet. + +## -remarks +[FileLoggingSession.CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) closes the current logging session. If there is a handler for the [LogFileGenerated](fileloggingsession_logfilegenerated.md) method, and it has been called but not returned, the function waits for the handler to return. If there is any data in the current log file that has not already been reported with the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event, the function returns a [StorageFile](../windows.storage/storagefile.md) representing that file. + +Otherwise, the function returns **NULL**. This can happen if the current log file is empty, or if all log files have already been reported via the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event. Note that [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) might return **NULL** even if data was recorded and even if there is no [LogFileGenerated](fileloggingsession_logfilegenerated.md) event. This can happen if the log file became full and was closed, and a new log file was opened immediately before [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) was called. + +This function is equivalent to [FileLoggingSession.Close](fileloggingsession_close.md). + + + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/fileloggingsession_fileloggingsession_290278668.md b/windows.foundation.diagnostics/fileloggingsession_fileloggingsession_290278668.md index c4a2e6824c..abb9da9fa1 100644 --- a/windows.foundation.diagnostics/fileloggingsession_fileloggingsession_290278668.md +++ b/windows.foundation.diagnostics/fileloggingsession_fileloggingsession_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.#ctor(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.FileLoggingSession.FileLoggingSession ## -description Initializes a new instance of the [FileLoggingSession](fileloggingsession.md) class. ## -parameters ### -param name The name of the logging session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.FileLoggingSession + +## -description +Initializes a new instance of the [FileLoggingSession](fileloggingsession.md) class. + +## -parameters +### -param name +The name of the logging session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/fileloggingsession_logfilegenerated.md b/windows.foundation.diagnostics/fileloggingsession_logfilegenerated.md index 7db7eed5f9..d8b7aaaf56 100644 --- a/windows.foundation.diagnostics/fileloggingsession_logfilegenerated.md +++ b/windows.foundation.diagnostics/fileloggingsession_logfilegenerated.md @@ -1,3 +1,28 @@ ---- -api-id: E:Windows.Foundation.Diagnostics.FileLoggingSession.LogFileGenerated --api-type: winrt event ---- # Windows.Foundation.Diagnostics.FileLoggingSession.LogFileGenerated ## -description Raised when a log file is saved. ## -remarks If no handler is registered for this event, log files will accumulate in the ApplicationData folder. This event is raised when the session rolls over from one log file to the next. If the file needs to be preserved, your handler must move the file to a new location before returning. The FileLoggingSession might delete or overwrite the file anytime after your handler has returned. When you register a handler for this event, if log files had been saved while there was no handler registered for this event, your newly-added handler will immediately be invoked once for each of the previously-saved log files. Your handler must do any processing necessary to preserve the file. This event is not raised for the last log file because the last log file does not roll over. Use [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) to access the last log file. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Diagnostics.FileLoggingSession.LogFileGenerated +-api-type: winrt event +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.LogFileGenerated + +## -description +Raised when a log file is saved. + +## -remarks +If no handler is registered for this event, log files will accumulate in the ApplicationData folder. + +This event is raised when the session rolls over from one log file to the next. If the file needs to be preserved, your handler must move the file to a new location before returning. The FileLoggingSession might delete or overwrite the file anytime after your handler has returned. + +When you register a handler for this event, if log files had been saved while there was no handler registered for this event, your newly-added handler will immediately be invoked once for each of the previously-saved log files. + +Your handler must do any processing necessary to preserve the file. + +This event is not raised for the last log file because the last log file does not roll over. Use [CloseAndSaveToFileAsync](fileloggingsession_closeandsavetofileasync.md) to access the last log file. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/fileloggingsession_name.md b/windows.foundation.diagnostics/fileloggingsession_name.md index ba997e5e76..f41b161496 100644 --- a/windows.foundation.diagnostics/fileloggingsession_name.md +++ b/windows.foundation.diagnostics/fileloggingsession_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.FileLoggingSession.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.FileLoggingSession.Name ## -description Gets the name of the logging session. ## -property-value The session name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.FileLoggingSession.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.Name + +## -description +Gets the name of the logging session. + +## -property-value +The session name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/fileloggingsession_removeloggingchannel_1406889906.md b/windows.foundation.diagnostics/fileloggingsession_removeloggingchannel_1406889906.md index 6057836d37..8b4adf1cc9 100644 --- a/windows.foundation.diagnostics/fileloggingsession_removeloggingchannel_1406889906.md +++ b/windows.foundation.diagnostics/fileloggingsession_removeloggingchannel_1406889906.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.FileLoggingSession.RemoveLoggingChannel ## -description Removes the specified logging channel from the current logging session. ## -parameters ### -param loggingChannel The logging channel to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.FileLoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.FileLoggingSession.RemoveLoggingChannel + +## -description +Removes the specified logging channel from the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/ierrorreportingsettings_geterroroptions.md b/windows.foundation.diagnostics/ierrorreportingsettings_geterroroptions.md index 7f6ca623cf..94974f11e3 100644 --- a/windows.foundation.diagnostics/ierrorreportingsettings_geterroroptions.md +++ b/windows.foundation.diagnostics/ierrorreportingsettings_geterroroptions.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.IErrorReportingSettings.GetErrorOptions --api-type: winrt method ---- # Windows.Foundation.Diagnostics.IErrorReportingSettings.GetErrorOptions ## -description Gets the type of error reporting for the error object. ## -returns One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.IErrorReportingSettings.GetErrorOptions +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.IErrorReportingSettings.GetErrorOptions + +## -description +Gets the type of error reporting for the error object. + +## -returns +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/ierrorreportingsettings_seterroroptions.md b/windows.foundation.diagnostics/ierrorreportingsettings_seterroroptions.md index f09ccf5efe..44260c1bb6 100644 --- a/windows.foundation.diagnostics/ierrorreportingsettings_seterroroptions.md +++ b/windows.foundation.diagnostics/ierrorreportingsettings_seterroroptions.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.IErrorReportingSettings.SetErrorOptions(Windows.Foundation.Diagnostics.ErrorOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.IErrorReportingSettings.SetErrorOptions ## -description Sets the type of error reporting for the error object. ## -parameters ### -param value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.IErrorReportingSettings.SetErrorOptions(Windows.Foundation.Diagnostics.ErrorOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.IErrorReportingSettings.SetErrorOptions + +## -description +Sets the type of error reporting for the error object. + +## -parameters +### -param value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_1409249414.md b/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_1409249414.md index f38ae16127..1460569dcb 100644 --- a/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_1409249414.md +++ b/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_1409249414.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel ## -description Adds a logging channel with the specified logging level to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ### -param maxLevel The logging level for *loggingChannel*. ## -remarks ## -examples ## -see-also [FileLoggingSession](fileloggingsession.md), [AddLoggingChannel(ILoggingChannel)](ifileloggingsession_addloggingchannel_604200962.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel + +## -description +Adds a logging channel with the specified logging level to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +### -param maxLevel +The logging level for *loggingChannel*. + +## -remarks + +## -examples + +## -see-also +[FileLoggingSession](fileloggingsession.md), [AddLoggingChannel(ILoggingChannel)](ifileloggingsession_addloggingchannel_604200962.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_604200962.md b/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_604200962.md index 70a3100bbf..a77203406e 100644 --- a/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_604200962.md +++ b/windows.foundation.diagnostics/ifileloggingsession_addloggingchannel_604200962.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel ## -description Adds a logging channel to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ## -remarks ## -examples ## -see-also [FileLoggingSession](fileloggingsession.md), [AddLoggingChannel(ILoggingChannel, LoggingLevel)](ifileloggingsession_addloggingchannel_1409249414.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.IFileLoggingSession.AddLoggingChannel + +## -description +Adds a logging channel to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +## -remarks + +## -examples + +## -see-also +[FileLoggingSession](fileloggingsession.md), [AddLoggingChannel(ILoggingChannel, LoggingLevel)](ifileloggingsession_addloggingchannel_1409249414.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/ifileloggingsession_closeandsavetofileasync.md b/windows.foundation.diagnostics/ifileloggingsession_closeandsavetofileasync.md index e09ce89810..5002b38196 100644 --- a/windows.foundation.diagnostics/ifileloggingsession_closeandsavetofileasync.md +++ b/windows.foundation.diagnostics/ifileloggingsession_closeandsavetofileasync.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.CloseAndSaveToFileAsync --api-type: winrt method ---- # Windows.Foundation.Diagnostics.IFileLoggingSession.CloseAndSaveToFileAsync ## -description Ends the current logging session and saves it to a file. ## -returns When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). ## -remarks ## -examples ## -see-also [FileLoggingSession](fileloggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.CloseAndSaveToFileAsync +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.IFileLoggingSession.CloseAndSaveToFileAsync + +## -description +Ends the current logging session and saves it to a file. + +## -returns +When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). + +## -remarks + +## -examples + +## -see-also +[FileLoggingSession](fileloggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/ifileloggingsession_logfilegenerated.md b/windows.foundation.diagnostics/ifileloggingsession_logfilegenerated.md index c85088491a..ba2887286d 100644 --- a/windows.foundation.diagnostics/ifileloggingsession_logfilegenerated.md +++ b/windows.foundation.diagnostics/ifileloggingsession_logfilegenerated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Foundation.Diagnostics.IFileLoggingSession.LogFileGenerated --api-type: winrt event ---- # Windows.Foundation.Diagnostics.IFileLoggingSession.LogFileGenerated ## -description Raised when a log file is saved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Diagnostics.IFileLoggingSession.LogFileGenerated +-api-type: winrt event +--- + + + +# Windows.Foundation.Diagnostics.IFileLoggingSession.LogFileGenerated + +## -description +Raised when a log file is saved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/ifileloggingsession_name.md b/windows.foundation.diagnostics/ifileloggingsession_name.md index a720f9bf3b..5c01991c78 100644 --- a/windows.foundation.diagnostics/ifileloggingsession_name.md +++ b/windows.foundation.diagnostics/ifileloggingsession_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.IFileLoggingSession.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.IFileLoggingSession.Name ## -description Gets the name of the logging session. ## -property-value The session name. ## -remarks ## -examples ## -see-also [FileLoggingSession](fileloggingsession.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.IFileLoggingSession.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.IFileLoggingSession.Name + +## -description +Gets the name of the logging session. + +## -property-value +The session name. + +## -remarks + +## -examples + +## -see-also +[FileLoggingSession](fileloggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/ifileloggingsession_removeloggingchannel.md b/windows.foundation.diagnostics/ifileloggingsession_removeloggingchannel.md index 595b15f5f8..a84fde0ea0 100644 --- a/windows.foundation.diagnostics/ifileloggingsession_removeloggingchannel.md +++ b/windows.foundation.diagnostics/ifileloggingsession_removeloggingchannel.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.IFileLoggingSession.RemoveLoggingChannel ## -description Removes the specified logging channel from the current logging session. ## -parameters ### -param loggingChannel The logging channel to remove. ## -remarks ## -examples ## -see-also [FileLoggingSession](fileloggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.IFileLoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.IFileLoggingSession.RemoveLoggingChannel + +## -description +Removes the specified logging channel from the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to remove. + +## -remarks + +## -examples + +## -see-also +[FileLoggingSession](fileloggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_enabled.md b/windows.foundation.diagnostics/iloggingchannel_enabled.md index 2f9ff81d70..628e460a16 100644 --- a/windows.foundation.diagnostics/iloggingchannel_enabled.md +++ b/windows.foundation.diagnostics/iloggingchannel_enabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ILoggingChannel.Enabled --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ILoggingChannel.Enabled ## -description Gets a value that indicates whether messages are being logged on the current [LoggingChannel](loggingchannel.md). ## -property-value **True** if messages are being logged on the current channel; otherwise, **false**. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ILoggingChannel.Enabled +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.Enabled + +## -description +Gets a value that indicates whether messages are being logged on the current [LoggingChannel](loggingchannel.md). + +## -property-value +**True** if messages are being logged on the current channel; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_level.md b/windows.foundation.diagnostics/iloggingchannel_level.md index 0f46fe6ec7..f284b2ec4f 100644 --- a/windows.foundation.diagnostics/iloggingchannel_level.md +++ b/windows.foundation.diagnostics/iloggingchannel_level.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ILoggingChannel.Level --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ILoggingChannel.Level ## -description Gets the level of detail for messages from the current [LoggingChannel](loggingchannel.md). ## -property-value The level of detail for messages. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ILoggingChannel.Level +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.Level + +## -description +Gets the level of detail for messages from the current [LoggingChannel](loggingchannel.md). + +## -property-value +The level of detail for messages. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_loggingenabled.md b/windows.foundation.diagnostics/iloggingchannel_loggingenabled.md index 25956c5d31..0533d48006 100644 --- a/windows.foundation.diagnostics/iloggingchannel_loggingenabled.md +++ b/windows.foundation.diagnostics/iloggingchannel_loggingenabled.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Foundation.Diagnostics.ILoggingChannel.LoggingEnabled --api-type: winrt event ---- # Windows.Foundation.Diagnostics.ILoggingChannel.LoggingEnabled ## -description Raised when the logging channel is attached to a [LoggingSession](loggingsession.md) or other event tracing and debugging tools. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md) \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Diagnostics.ILoggingChannel.LoggingEnabled +-api-type: winrt event +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.LoggingEnabled + +## -description +Raised when the logging channel is attached to a [LoggingSession](loggingsession.md) or other event tracing and debugging tools. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_logmessage_1040390993.md b/windows.foundation.diagnostics/iloggingchannel_logmessage_1040390993.md index 4d4eb9b5ed..fbd058072e 100644 --- a/windows.foundation.diagnostics/iloggingchannel_logmessage_1040390993.md +++ b/windows.foundation.diagnostics/iloggingchannel_logmessage_1040390993.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage ## -description Logs a message to the current [LoggingChannel](loggingchannel.md). ## -parameters ### -param eventString The message to log. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [LogMessage(String, LoggingLevel)](iloggingchannel_logmessage_1241451477.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage + +## -description +Logs a message to the current [LoggingChannel](loggingchannel.md). + +## -parameters +### -param eventString +The message to log. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [LogMessage(String, LoggingLevel)](iloggingchannel_logmessage_1241451477.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_logmessage_1241451477.md b/windows.foundation.diagnostics/iloggingchannel_logmessage_1241451477.md index 29e9099ea8..70aacb022d 100644 --- a/windows.foundation.diagnostics/iloggingchannel_logmessage_1241451477.md +++ b/windows.foundation.diagnostics/iloggingchannel_logmessage_1241451477.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage(System.String,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage ## -description Logs a message to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). ## -parameters ### -param eventString The message to log. ### -param level The logging level. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [LogMessage(String)](iloggingchannel_logmessage_1040390993.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage(System.String,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.LogMessage + +## -description +Logs a message to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). + +## -parameters +### -param eventString +The message to log. + +### -param level +The logging level. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [LogMessage(String)](iloggingchannel_logmessage_1040390993.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_logvaluepair_1788406125.md b/windows.foundation.diagnostics/iloggingchannel_logvaluepair_1788406125.md index adbb30aacc..29c650078f 100644 --- a/windows.foundation.diagnostics/iloggingchannel_logvaluepair_1788406125.md +++ b/windows.foundation.diagnostics/iloggingchannel_logvaluepair_1788406125.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair ## -description Logs data to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). ## -parameters ### -param value1 The string to associate with *value2*. ### -param value2 The value to associate with *value1*. ### -param level The logging level. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [LogValuePair(String, Int32)](iloggingchannel_logvaluepair_2057254811.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair + +## -description +Logs data to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). + +## -parameters +### -param value1 +The string to associate with *value2*. + +### -param value2 +The value to associate with *value1*. + +### -param level +The logging level. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [LogValuePair(String, Int32)](iloggingchannel_logvaluepair_2057254811.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_logvaluepair_2057254811.md b/windows.foundation.diagnostics/iloggingchannel_logvaluepair_2057254811.md index c9ad09489a..072ad74fa4 100644 --- a/windows.foundation.diagnostics/iloggingchannel_logvaluepair_2057254811.md +++ b/windows.foundation.diagnostics/iloggingchannel_logvaluepair_2057254811.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair(System.String,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair ## -description Logs data to the current [LoggingChannel](loggingchannel.md). ## -parameters ### -param value1 The string to associate with *value2*. ### -param value2 The value to associate with *value1*. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [LogValuePair(String, Int32, LoggingLevel)](iloggingchannel_logvaluepair_1788406125.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair(System.String,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.LogValuePair + +## -description +Logs data to the current [LoggingChannel](loggingchannel.md). + +## -parameters +### -param value1 +The string to associate with *value2*. + +### -param value2 +The value to associate with *value1*. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [LogValuePair(String, Int32, LoggingLevel)](iloggingchannel_logvaluepair_1788406125.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingchannel_name.md b/windows.foundation.diagnostics/iloggingchannel_name.md index 3f549e9670..cff8550f26 100644 --- a/windows.foundation.diagnostics/iloggingchannel_name.md +++ b/windows.foundation.diagnostics/iloggingchannel_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ILoggingChannel.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ILoggingChannel.Name ## -description Gets the name of the current [LoggingChannel](loggingchannel.md). ## -property-value The name. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ILoggingChannel.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ILoggingChannel.Name + +## -description +Gets the name of the current [LoggingChannel](loggingchannel.md). + +## -property-value +The name. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingsession_addloggingchannel_1409249414.md b/windows.foundation.diagnostics/iloggingsession_addloggingchannel_1409249414.md index c24f9d5277..f30201eabc 100644 --- a/windows.foundation.diagnostics/iloggingsession_addloggingchannel_1409249414.md +++ b/windows.foundation.diagnostics/iloggingsession_addloggingchannel_1409249414.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel ## -description Adds a logging channel with the specified logging level to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ### -param maxLevel The logging level for *loggingChannel*. ## -remarks ## -examples ## -see-also [AddLoggingChannel(ILoggingChannel)](iloggingsession_addloggingchannel_604200962.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel + +## -description +Adds a logging channel with the specified logging level to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +### -param maxLevel +The logging level for *loggingChannel*. + +## -remarks + +## -examples + +## -see-also +[AddLoggingChannel(ILoggingChannel)](iloggingsession_addloggingchannel_604200962.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingsession_addloggingchannel_604200962.md b/windows.foundation.diagnostics/iloggingsession_addloggingchannel_604200962.md index 9e8eb4d2f5..34a246bb03 100644 --- a/windows.foundation.diagnostics/iloggingsession_addloggingchannel_604200962.md +++ b/windows.foundation.diagnostics/iloggingsession_addloggingchannel_604200962.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel ## -description Adds a logging channel to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ## -remarks ## -examples ## -see-also [AddLoggingChannel(ILoggingChannel, LoggingLevel)](iloggingsession_addloggingchannel_1409249414.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingSession.AddLoggingChannel + +## -description +Adds a logging channel to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +## -remarks + +## -examples + +## -see-also +[AddLoggingChannel(ILoggingChannel, LoggingLevel)](iloggingsession_addloggingchannel_1409249414.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingsession_name.md b/windows.foundation.diagnostics/iloggingsession_name.md index 24e507ba7a..f153a5d135 100644 --- a/windows.foundation.diagnostics/iloggingsession_name.md +++ b/windows.foundation.diagnostics/iloggingsession_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.ILoggingSession.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.ILoggingSession.Name ## -description Gets the name of the logging session. ## -property-value The session name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.ILoggingSession.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.ILoggingSession.Name + +## -description +Gets the name of the logging session. + +## -property-value +The session name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/iloggingsession_removeloggingchannel.md b/windows.foundation.diagnostics/iloggingsession_removeloggingchannel.md index 6eb5198e10..3e96dcaf91 100644 --- a/windows.foundation.diagnostics/iloggingsession_removeloggingchannel.md +++ b/windows.foundation.diagnostics/iloggingsession_removeloggingchannel.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingSession.RemoveLoggingChannel ## -description Removes the specified logging channel from the current logging session. ## -parameters ### -param loggingChannel The logging channel to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingSession.RemoveLoggingChannel + +## -description +Removes the specified logging channel from the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/iloggingsession_savetofileasync.md b/windows.foundation.diagnostics/iloggingsession_savetofileasync.md index c848f8e6f3..ad2b3468ef 100644 --- a/windows.foundation.diagnostics/iloggingsession_savetofileasync.md +++ b/windows.foundation.diagnostics/iloggingsession_savetofileasync.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.SaveToFileAsync(Windows.Storage.IStorageFolder,System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingSession.SaveToFileAsync ## -description Save the current logging session to a file. ## -parameters ### -param folder The folder to save the log file in. ### -param fileName The name of the file. ## -returns When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingSession.SaveToFileAsync(Windows.Storage.IStorageFolder,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingSession.SaveToFileAsync + +## -description +Save the current logging session to a file. + +## -parameters +### -param folder +The folder to save the log file in. + +### -param fileName +The name of the file. + +## -returns +When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/iloggingtarget_isenabled_1519006295.md b/windows.foundation.diagnostics/iloggingtarget_isenabled_1519006295.md index 7b4024457d..8e55bdc68d 100644 --- a/windows.foundation.diagnostics/iloggingtarget_isenabled_1519006295.md +++ b/windows.foundation.diagnostics/iloggingtarget_isenabled_1519006295.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel,System.Int64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled ## -description Indicates whether at least one session is listening for events with the specified level and keywords from this channel. ## -parameters ### -param level The event severity level. ### -param keywords The keywords. Each bit of the keywords value represents an event category. ## -returns Returns **true** if at least one session is listening for events with the specified level and keywords from the channel, and otherwise **false**. ## -remarks ## -examples ## -see-also [IsEnabled](iloggingtarget_isenabled_180154405.md), [IsEnabled(LoggingLevel)](iloggingtarget_isenabled_826472551.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel,System.Int64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled + +## -description +Indicates whether at least one session is listening for events with the specified level and keywords from this channel. + +## -parameters +### -param level +The event severity level. + +### -param keywords +The keywords. Each bit of the keywords value represents an event category. + +## -returns +Returns **true** if at least one session is listening for events with the specified level and keywords from the channel, and otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[IsEnabled](iloggingtarget_isenabled_180154405.md), [IsEnabled(LoggingLevel)](iloggingtarget_isenabled_826472551.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_isenabled_180154405.md b/windows.foundation.diagnostics/iloggingtarget_isenabled_180154405.md index 0749fa8ccf..18cea5d0f1 100644 --- a/windows.foundation.diagnostics/iloggingtarget_isenabled_180154405.md +++ b/windows.foundation.diagnostics/iloggingtarget_isenabled_180154405.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled ## -description Indicates whether at least one session is listening for events from the channel. ## -returns Returns **true** if at least one session is listening for events from the channel, and otherwise **false**. ## -remarks ## -examples ## -see-also [IsEnabled(LoggingLevel)](iloggingtarget_isenabled_826472551.md), [IsEnabled(LoggingLevel, Int64)](iloggingtarget_isenabled_1519006295.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled + +## -description +Indicates whether at least one session is listening for events from the channel. + +## -returns +Returns **true** if at least one session is listening for events from the channel, and otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[IsEnabled(LoggingLevel)](iloggingtarget_isenabled_826472551.md), [IsEnabled(LoggingLevel, Int64)](iloggingtarget_isenabled_1519006295.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_isenabled_826472551.md b/windows.foundation.diagnostics/iloggingtarget_isenabled_826472551.md index f767ca9120..ffdae8786a 100644 --- a/windows.foundation.diagnostics/iloggingtarget_isenabled_826472551.md +++ b/windows.foundation.diagnostics/iloggingtarget_isenabled_826472551.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled ## -description Indicates whether at least one session is listening for events with the specified event severity level from the channel. ## -parameters ### -param level The event severity level. ## -returns Returns **true** if at least one session is listening for events with the specified level from the channel, and otherwise **false**. ## -remarks ## -examples ## -see-also [IsEnabled](iloggingtarget_isenabled_180154405.md), [IsEnabled(LoggingLevel, Int64)](iloggingtarget_isenabled_1519006295.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.IsEnabled + +## -description +Indicates whether at least one session is listening for events with the specified event severity level from the channel. + +## -parameters +### -param level +The event severity level. + +## -returns +Returns **true** if at least one session is listening for events with the specified level from the channel, and otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[IsEnabled](iloggingtarget_isenabled_180154405.md), [IsEnabled(LoggingLevel, Int64)](iloggingtarget_isenabled_1519006295.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_logevent_1783961521.md b/windows.foundation.diagnostics/iloggingtarget_logevent_1783961521.md index 5c6835bca5..12e287922f 100644 --- a/windows.foundation.diagnostics/iloggingtarget_logevent_1783961521.md +++ b/windows.foundation.diagnostics/iloggingtarget_logevent_1783961521.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent ## -description Logs an event with the specified name. ## -parameters ### -param eventName The name for this event. ## -remarks ## -examples ## -see-also [LogEvent(String, LoggingFields)](iloggingtarget_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](iloggingtarget_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent + +## -description +Logs an event with the specified name. + +## -parameters +### -param eventName +The name for this event. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String, LoggingFields)](iloggingtarget_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](iloggingtarget_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_logevent_1865424709.md b/windows.foundation.diagnostics/iloggingtarget_logevent_1865424709.md index 7664f4b711..cc1dcf66f8 100644 --- a/windows.foundation.diagnostics/iloggingtarget_logevent_1865424709.md +++ b/windows.foundation.diagnostics/iloggingtarget_logevent_1865424709.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent ## -description Logs an event with the specified name, fields, and level. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ## -remarks ## -examples ## -see-also [LogEvent(String)](iloggingtarget_logevent_1783961521.md), [LogEvent(String, LoggingFields)](iloggingtarget_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent + +## -description +Logs an event with the specified name, fields, and level. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](iloggingtarget_logevent_1783961521.md), [LogEvent(String, LoggingFields)](iloggingtarget_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_logevent_2134360499.md b/windows.foundation.diagnostics/iloggingtarget_logevent_2134360499.md index d3028e9b15..3754a5e17a 100644 --- a/windows.foundation.diagnostics/iloggingtarget_logevent_2134360499.md +++ b/windows.foundation.diagnostics/iloggingtarget_logevent_2134360499.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent ## -description Logs an event with the specified name and fields. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ## -remarks ## -examples ## -see-also [LogEvent(String)](iloggingtarget_logevent_1783961521.md), [LogEvent(String, LoggingFields, LoggingLevel)](iloggingtarget_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent + +## -description +Logs an event with the specified name and fields. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](iloggingtarget_logevent_1783961521.md), [LogEvent(String, LoggingFields, LoggingLevel)](iloggingtarget_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_logevent_812606037.md b/windows.foundation.diagnostics/iloggingtarget_logevent_812606037.md index 533e4b3a97..f20b07da3a 100644 --- a/windows.foundation.diagnostics/iloggingtarget_logevent_812606037.md +++ b/windows.foundation.diagnostics/iloggingtarget_logevent_812606037.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent ## -description Logs an event with the specified name, fields, level, and options. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -remarks ## -examples ## -see-also [LogEvent(String)](iloggingtarget_logevent_1783961521.md), [LogEvent(String, LoggingFields)](iloggingtarget_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](iloggingtarget_logevent_1865424709.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.LogEvent + +## -description +Logs an event with the specified name, fields, level, and options. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](iloggingtarget_logevent_1783961521.md), [LogEvent(String, LoggingFields)](iloggingtarget_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](iloggingtarget_logevent_1865424709.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_startactivity_1799218284.md b/windows.foundation.diagnostics/iloggingtarget_startactivity_1799218284.md index 07cff2459f..83f96b38fd 100644 --- a/windows.foundation.diagnostics/iloggingtarget_startactivity_1799218284.md +++ b/windows.foundation.diagnostics/iloggingtarget_startactivity_1799218284.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity ## -description Writes an activity start event with the specified fields and level and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. May be **null **. ### -param level The level of detail for this event. ## -returns An object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String)](iloggingtarget_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](iloggingtarget_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity + +## -description +Writes an activity start event with the specified fields and level and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. May be **null **. + +### -param level +The level of detail for this event. + +## -returns +An object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String)](iloggingtarget_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](iloggingtarget_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_startactivity_1851321502.md b/windows.foundation.diagnostics/iloggingtarget_startactivity_1851321502.md index 7c4bd583e4..12b7b809f7 100644 --- a/windows.foundation.diagnostics/iloggingtarget_startactivity_1851321502.md +++ b/windows.foundation.diagnostics/iloggingtarget_startactivity_1851321502.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity ## -description Writes an activity start event and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ## -returns An object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String, LoggingFields)](iloggingtarget_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](iloggingtarget_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity + +## -description +Writes an activity start event and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +## -returns +An object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String, LoggingFields)](iloggingtarget_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](iloggingtarget_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_startactivity_2067413660.md b/windows.foundation.diagnostics/iloggingtarget_startactivity_2067413660.md index 091c1b335f..410c48cc4d 100644 --- a/windows.foundation.diagnostics/iloggingtarget_startactivity_2067413660.md +++ b/windows.foundation.diagnostics/iloggingtarget_startactivity_2067413660.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity ## -description Writes an activity start event with fields and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. ## -returns An object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String)](iloggingtarget_startactivity_1851321502.md), [StartActivity(String, LoggingFields, LoggingLevel)](iloggingtarget_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity + +## -description +Writes an activity start event with fields and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. + +## -returns +An object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String)](iloggingtarget_startactivity_1851321502.md), [StartActivity(String, LoggingFields, LoggingLevel)](iloggingtarget_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](iloggingtarget_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/iloggingtarget_startactivity_878877052.md b/windows.foundation.diagnostics/iloggingtarget_startactivity_878877052.md index d9534f2975..0ccaeb0047 100644 --- a/windows.foundation.diagnostics/iloggingtarget_startactivity_878877052.md +++ b/windows.foundation.diagnostics/iloggingtarget_startactivity_878877052.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity ## -description Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -returns An object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String)](iloggingtarget_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](iloggingtarget_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](iloggingtarget_startactivity_1799218284.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.ILoggingTarget.StartActivity + +## -description +Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -returns +An object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String)](iloggingtarget_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](iloggingtarget_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](iloggingtarget_startactivity_1799218284.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/logfilegeneratedeventargs.md b/windows.foundation.diagnostics/logfilegeneratedeventargs.md index c28dfacd24..64c8eb1877 100644 --- a/windows.foundation.diagnostics/logfilegeneratedeventargs.md +++ b/windows.foundation.diagnostics/logfilegeneratedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs ## -description Provides data for the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs + +## -description +Provides data for the [LogFileGenerated](fileloggingsession_logfilegenerated.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/logfilegeneratedeventargs_file.md b/windows.foundation.diagnostics/logfilegeneratedeventargs_file.md index 70eb7ed1b7..f2512d8b5f 100644 --- a/windows.foundation.diagnostics/logfilegeneratedeventargs_file.md +++ b/windows.foundation.diagnostics/logfilegeneratedeventargs_file.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs.File --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs.File ## -description Gets the log file. ## -property-value The log file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs.File +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LogFileGeneratedEventArgs.File + +## -description +Gets the log file. + +## -property-value +The log file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingactivity.md b/windows.foundation.diagnostics/loggingactivity.md index 65c2938d6a..b8674c1dc2 100644 --- a/windows.foundation.diagnostics/loggingactivity.md +++ b/windows.foundation.diagnostics/loggingactivity.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LoggingActivity --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LoggingActivity ## -description Creates Event Tracing for Windows (ETW) events that mark the start and end of a group of related events. ## -remarks > **Windows 10** > The **LoggingActivity** class has been extended in the following ways:+ Now implements [ILoggingTarget](iloggingtarget.md) which provides activity start and stop methods that provide control over the format and contents of the Start and Stop events. + Now implements methods to log events. Events are automatically tagged with the LoggingActivity's GUID. + Activities can be nested. Every **LoggingActivity** object is attached to a [LoggingChannel](loggingchannel.md) object. All events created by the **LoggingActivity** object are written through the attached [LoggingChannel](loggingchannel.md) object. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [LoggingChannel](loggingchannel.md), [ILoggingTarget](iloggingtarget.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LoggingActivity +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity + +## -description +Creates Event Tracing for Windows (ETW) events that mark the start and end of a group of related events. + +## -remarks + + +> **Windows 10** +> The **LoggingActivity** class has been extended in the following ways:+ Now implements [ILoggingTarget](iloggingtarget.md) which provides activity start and stop methods that provide control over the format and contents of the Start and Stop events. ++ Now implements methods to log events. Events are automatically tagged with the LoggingActivity's GUID. ++ Activities can be nested. +Every **LoggingActivity** object is attached to a [LoggingChannel](loggingchannel.md) object. All events created by the **LoggingActivity** object are written through the attached [LoggingChannel](loggingchannel.md) object. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [LoggingChannel](loggingchannel.md), [ILoggingTarget](iloggingtarget.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_channel.md b/windows.foundation.diagnostics/loggingactivity_channel.md index 9bb42ea84b..d1c9425110 100644 --- a/windows.foundation.diagnostics/loggingactivity_channel.md +++ b/windows.foundation.diagnostics/loggingactivity_channel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingActivity.Channel --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingActivity.Channel ## -description Returns the channel associated with this activity. ## -property-value The channel associated with this activity. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingActivity.Channel +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.Channel + +## -description +Returns the channel associated with this activity. + +## -property-value +The channel associated with this activity. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingactivity_close_811482585.md b/windows.foundation.diagnostics/loggingactivity_close_811482585.md index 8f38997410..3464634ea2 100644 --- a/windows.foundation.diagnostics/loggingactivity_close_811482585.md +++ b/windows.foundation.diagnostics/loggingactivity_close_811482585.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.Close --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.Close ## -description Ends the current logging activity. ## -remarks > **Windows 10** > In addition to ending the current logging activity, generates a stop event for the activity. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.Close + +## -description +Ends the current logging activity. + +## -remarks +> **Windows 10** +> In addition to ending the current logging activity, generates a stop event for the activity. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingactivity_id.md b/windows.foundation.diagnostics/loggingactivity_id.md index 2b38f6c87a..66ab159f90 100644 --- a/windows.foundation.diagnostics/loggingactivity_id.md +++ b/windows.foundation.diagnostics/loggingactivity_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingActivity.Id --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingActivity.Id ## -description Gets the identifier for the current logging activity. ## -property-value The identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingActivity.Id +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.Id + +## -description +Gets the identifier for the current logging activity. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingactivity_isenabled_1519006295.md b/windows.foundation.diagnostics/loggingactivity_isenabled_1519006295.md index 91b607ed45..93dfb726d9 100644 --- a/windows.foundation.diagnostics/loggingactivity_isenabled_1519006295.md +++ b/windows.foundation.diagnostics/loggingactivity_isenabled_1519006295.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel,System.Int64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled ## -description Indicates whether at least one session is listening for events with the specified level and keywords from the channel associated with this activity. ## -parameters ### -param level The event severity level. ### -param keywords The keywords. Each bit of the keywords value represents an event category. ## -returns Returns **true** if at least one session is listening for events with the specified level and keywords from the channel associated with this activity, and otherwise **false**. ## -remarks This function is equivalent to [LoggingChannel.IsEnabled(level, keywords)](loggingchannel_isenabled_1519006295.md). ## -examples ## -see-also [IsEnabled](loggingactivity_isenabled_180154405.md), [IsEnabled(LoggingLevel)](loggingactivity_isenabled_826472551.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel,System.Int64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled + +## -description +Indicates whether at least one session is listening for events with the specified level and keywords from the channel associated with this activity. + +## -parameters +### -param level +The event severity level. + +### -param keywords +The keywords. Each bit of the keywords value represents an event category. + +## -returns +Returns **true** if at least one session is listening for events with the specified level and keywords from the channel associated with this activity, and otherwise **false**. + +## -remarks +This function is equivalent to [LoggingChannel.IsEnabled(level, keywords)](loggingchannel_isenabled_1519006295.md). + +## -examples + +## -see-also +[IsEnabled](loggingactivity_isenabled_180154405.md), [IsEnabled(LoggingLevel)](loggingactivity_isenabled_826472551.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_isenabled_180154405.md b/windows.foundation.diagnostics/loggingactivity_isenabled_180154405.md index 7b4dc9c4cf..a6378cdbfa 100644 --- a/windows.foundation.diagnostics/loggingactivity_isenabled_180154405.md +++ b/windows.foundation.diagnostics/loggingactivity_isenabled_180154405.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled ## -description Indicates whether at least one session is listening for events from the channel associated with this activity. ## -returns Returns **true** if at least one session is listening for events from the channel associated with this activity, and otherwise **false**. ## -remarks ## -examples ## -see-also [IsEnabled(LoggingLevel)](loggingactivity_isenabled_826472551.md), [IsEnabled(LoggingLevel, Int64)](loggingactivity_isenabled_1519006295.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled + +## -description +Indicates whether at least one session is listening for events from the channel associated with this activity. + +## -returns +Returns **true** if at least one session is listening for events from the channel associated with this activity, and otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[IsEnabled(LoggingLevel)](loggingactivity_isenabled_826472551.md), [IsEnabled(LoggingLevel, Int64)](loggingactivity_isenabled_1519006295.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_isenabled_826472551.md b/windows.foundation.diagnostics/loggingactivity_isenabled_826472551.md index 744d0be14f..59ee2bf116 100644 --- a/windows.foundation.diagnostics/loggingactivity_isenabled_826472551.md +++ b/windows.foundation.diagnostics/loggingactivity_isenabled_826472551.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled ## -description Indicates whether at least one session is listening for events with the specified event severity level from the channel associated with this activity. ## -parameters ### -param level The event severity level. ## -returns Returns **true** if at least one session is listening for events with the specified level from the channel associated with this activity, and otherwise **false**. ## -remarks This function is equivalent to [LoggingChannel.IsEnabled(level)](loggingchannel_isenabled_826472551.md). ## -examples ## -see-also [IsEnabled](loggingactivity_isenabled_180154405.md), [IsEnabled(LoggingLevel, Int64)](loggingactivity_isenabled_1519006295.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.IsEnabled + +## -description +Indicates whether at least one session is listening for events with the specified event severity level from the channel associated with this activity. + +## -parameters +### -param level +The event severity level. + +## -returns +Returns **true** if at least one session is listening for events with the specified level from the channel associated with this activity, and otherwise **false**. + +## -remarks +This function is equivalent to [LoggingChannel.IsEnabled(level)](loggingchannel_isenabled_826472551.md). + +## -examples + +## -see-also +[IsEnabled](loggingactivity_isenabled_180154405.md), [IsEnabled(LoggingLevel, Int64)](loggingactivity_isenabled_1519006295.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_logevent_1783961521.md b/windows.foundation.diagnostics/loggingactivity_logevent_1783961521.md index acd4f1ec96..89ca4143bb 100644 --- a/windows.foundation.diagnostics/loggingactivity_logevent_1783961521.md +++ b/windows.foundation.diagnostics/loggingactivity_logevent_1783961521.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.LogEvent ## -description Logs an event with the specified name. ## -parameters ### -param eventName The name for this event. ## -remarks ## -examples ## -see-also [LogEvent(String, LoggingFields)](loggingactivity_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingactivity_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.LogEvent + +## -description +Logs an event with the specified name. + +## -parameters +### -param eventName +The name for this event. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String, LoggingFields)](loggingactivity_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingactivity_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_logevent_1865424709.md b/windows.foundation.diagnostics/loggingactivity_logevent_1865424709.md index ff81e441b7..56764320de 100644 --- a/windows.foundation.diagnostics/loggingactivity_logevent_1865424709.md +++ b/windows.foundation.diagnostics/loggingactivity_logevent_1865424709.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.LogEvent ## -description Logs an event with the specified name, fields, and level. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The severity level for this event. ## -remarks ## -examples ## -see-also [LogEvent(String)](loggingactivity_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingactivity_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.LogEvent + +## -description +Logs an event with the specified name, fields, and level. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The severity level for this event. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](loggingactivity_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingactivity_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_logevent_2134360499.md b/windows.foundation.diagnostics/loggingactivity_logevent_2134360499.md index 3bee470051..e9ecbb8eb8 100644 --- a/windows.foundation.diagnostics/loggingactivity_logevent_2134360499.md +++ b/windows.foundation.diagnostics/loggingactivity_logevent_2134360499.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.LogEvent ## -description Logs an event with the specified name and fields. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ## -remarks The level is set to **LoggingLevel.Verbose**. Methods that accept a [LoggingFields](loggingfields.md) parameter also accept **null**. A **null** value is semantically equivalent to a newly-constructed or cleared [LoggingFields](loggingfields.md) object and represents an empty payload. ## -examples ## -see-also [LogEvent(String)](loggingactivity_logevent_1783961521.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingactivity_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.LogEvent + +## -description +Logs an event with the specified name and fields. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +## -remarks +The level is set to **LoggingLevel.Verbose**. + +Methods that accept a [LoggingFields](loggingfields.md) parameter also accept **null**. A **null** value is semantically equivalent to a newly-constructed or cleared [LoggingFields](loggingfields.md) object and represents an empty payload. + +## -examples + +## -see-also +[LogEvent(String)](loggingactivity_logevent_1783961521.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingactivity_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_logevent_812606037.md b/windows.foundation.diagnostics/loggingactivity_logevent_812606037.md index eb18d907d4..3d814d3f3a 100644 --- a/windows.foundation.diagnostics/loggingactivity_logevent_812606037.md +++ b/windows.foundation.diagnostics/loggingactivity_logevent_812606037.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.LogEvent ## -description Logs an event with the specified name, fields, level, and options. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The severity level for this event. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -remarks If you provide *options*,**LoggingOptions.ActivityId** and **LoggingOptions.RelatedActivityId** are ignored because the activity object automatically manages these values for the event. *eventName* should not be used as a payload field. For example, use `LogEvent(“MyEvent”, fieldsWithStringData)` instead of `LogEvent(stringData)`. ## -examples ## -see-also [LogEvent(String)](loggingactivity_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingactivity_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingactivity_logevent_1865424709.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.LogEvent + +## -description +Logs an event with the specified name, fields, level, and options. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The severity level for this event. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -remarks +If you provide *options*,**LoggingOptions.ActivityId** and **LoggingOptions.RelatedActivityId** are ignored because the activity object automatically manages these values for the event. + +*eventName* should not be used as a payload field. For example, use `LogEvent(“MyEvent”, fieldsWithStringData)` instead of `LogEvent(stringData)`. + +## -examples + +## -see-also +[LogEvent(String)](loggingactivity_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingactivity_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingactivity_logevent_1865424709.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_loggingactivity_1858772704.md b/windows.foundation.diagnostics/loggingactivity_loggingactivity_1858772704.md index 2cf24d9151..b444c33b16 100644 --- a/windows.foundation.diagnostics/loggingactivity_loggingactivity_1858772704.md +++ b/windows.foundation.diagnostics/loggingactivity_loggingactivity_1858772704.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.#ctor(System.String,Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.LoggingActivity ## -description Initializes a new instance of the [LoggingActivity](loggingactivity.md) class for the specified [LoggingChannel](loggingchannel.md) and [LoggingLevel](logginglevel.md) in Windows 8.1 compatibility mode. ## -parameters ### -param activityName The name of the logging activity. ### -param loggingChannel The logging channel. ### -param level The logging level. ## -remarks ## -examples ## -see-also [LoggingActivity(String, ILoggingChannel)](loggingactivity_loggingactivity_2127380504.md), [LoggingChannel](loggingchannel.md), [LoggingLevel](logginglevel.md), [StartActivity](loggingactivity_startactivity_1851321502.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.#ctor(System.String,Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.LoggingActivity + +## -description +Initializes a new instance of the [LoggingActivity](loggingactivity.md) class for the specified [LoggingChannel](loggingchannel.md) and [LoggingLevel](logginglevel.md) in Windows 8.1 compatibility mode. + +## -parameters +### -param activityName +The name of the logging activity. + +### -param loggingChannel +The logging channel. + +### -param level +The logging level. + +## -remarks + +## -examples + +## -see-also +[LoggingActivity(String, ILoggingChannel)](loggingactivity_loggingactivity_2127380504.md), [LoggingChannel](loggingchannel.md), [LoggingLevel](logginglevel.md), [StartActivity](loggingactivity_startactivity_1851321502.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_loggingactivity_2127380504.md b/windows.foundation.diagnostics/loggingactivity_loggingactivity_2127380504.md index da84f22c2c..608508b8fb 100644 --- a/windows.foundation.diagnostics/loggingactivity_loggingactivity_2127380504.md +++ b/windows.foundation.diagnostics/loggingactivity_loggingactivity_2127380504.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.#ctor(System.String,Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.LoggingActivity ## -description Initializes a new instance of the [LoggingActivity](loggingactivity.md) class for the specified [LoggingChannel](loggingchannel.md) in Windows 8.1 compatibility mode. ## -parameters ### -param activityName The name of the logging activity. ### -param loggingChannel The logging channel. ## -remarks > **Windows 10** > Two modes of operation are now supported: Windows 8.1 compatibility mode and the new behavior supported by Windows 10 and later.+ For Windows 8.1 compatibility mode, create the object using a constructor. + For Windows 10 and later specific behavior, create a LoggingActivity object by using [LoggingChannel.StartActivity](loggingchannel_startactivity.md) or [LoggingActivity.StartActivity](loggingactivity_startactivity.md). The differences between these two modes are:
Windows 8.1 compatibility modeWindows 10 and later specific behavior
The start event generated by the constructor is formatted for compatibility with the manifest used by [LoggingChannel](loggingchannel.md). The start event name is hard-coded as `“LogActivityStart” + Level`. The event will be a manifest-based event or a self-describing event depending on the operating mode of the underlying channel.The start event generated by the [StartActivity](loggingactivity_startactivity.md) method follows the conventions of [LoggingChannel.LogEvent](loggingchannel_logevent.md) and will always use a self-describing, i.e. not manifest-based, event encoding. The event name is based on the **startEventName** parameter.
The stop event generated by [Close](loggingactivity_close.md) or **Dispose()** is formatted for compatibility with the manifest used by [LoggingChannel](loggingchannel.md). The stop event name is hard-coded as `“LogActivityStop” + Level`. The event will be a manifest-based event or a self-describing event, depending on the operating mode of the underlying channel.The Stop event generated by [Close](loggingactivity_close.md) or [Dispose](loggingactivity_dispose.md) will follow the conventions of [LoggingChannel.LogEvent](loggingchannel_logevent.md) and will use the self-describing event encoding. The activity name will be used as the stop event name.
The destructor/finalizer will invoke **Close()**.The destructor/finalizer will not invoke [Close()](loggingactivity_close.md).
## -examples ## -see-also [LoggingActivity(String, ILoggingChannel, LoggingLevel)](loggingactivity_loggingactivity_1858772704.md), [LoggingChannel](loggingchannel.md), [StartActivity](loggingactivity_startactivity_1851321502.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.#ctor(System.String,Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.LoggingActivity + +## -description +Initializes a new instance of the [LoggingActivity](loggingactivity.md) class for the specified [LoggingChannel](loggingchannel.md) in Windows 8.1 compatibility mode. + +## -parameters +### -param activityName +The name of the logging activity. + +### -param loggingChannel +The logging channel. + +## -remarks +> **Windows 10** +> Two modes of operation are now supported: Windows 8.1 compatibility mode and the new behavior supported by Windows 10 and later.+ For Windows 8.1 compatibility mode, create the object using a constructor. ++ For Windows 10 and later specific behavior, create a LoggingActivity object by using [LoggingChannel.StartActivity](loggingchannel_startactivity.md) or [LoggingActivity.StartActivity](loggingactivity_startactivity.md). +The differences between these two modes are: + + + + + + +
Windows 8.1 compatibility modeWindows 10 and later specific behavior
The start event generated by the constructor is formatted for compatibility with the manifest used by [LoggingChannel](loggingchannel.md). The start event name is hard-coded as `“LogActivityStart” + Level`. The event will be a manifest-based event or a self-describing event depending on the operating mode of the underlying channel.The start event generated by the [StartActivity](loggingactivity_startactivity.md) method follows the conventions of [LoggingChannel.LogEvent](loggingchannel_logevent.md) and will always use a self-describing, i.e. not manifest-based, event encoding. The event name is based on the **startEventName** parameter.
The stop event generated by [Close](loggingactivity_close.md) or **Dispose()** is formatted for compatibility with the manifest used by [LoggingChannel](loggingchannel.md). The stop event name is hard-coded as `“LogActivityStop” + Level`. The event will be a manifest-based event or a self-describing event, depending on the operating mode of the underlying channel.The Stop event generated by [Close](loggingactivity_close.md) or [Dispose](loggingactivity_dispose.md) will follow the conventions of [LoggingChannel.LogEvent](loggingchannel_logevent.md) and will use the self-describing event encoding. The activity name will be used as the stop event name.
The destructor/finalizer will invoke **Close()**.The destructor/finalizer will not invoke [Close()](loggingactivity_close.md).
+ +## -examples + +## -see-also +[LoggingActivity(String, ILoggingChannel, LoggingLevel)](loggingactivity_loggingactivity_1858772704.md), [LoggingChannel](loggingchannel.md), [StartActivity](loggingactivity_startactivity_1851321502.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_name.md b/windows.foundation.diagnostics/loggingactivity_name.md index a84eb91921..1d2aedcf19 100644 --- a/windows.foundation.diagnostics/loggingactivity_name.md +++ b/windows.foundation.diagnostics/loggingactivity_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingActivity.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingActivity.Name ## -description Gets the name of the current logging activity. ## -property-value The name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingActivity.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.Name + +## -description +Gets the name of the current logging activity. + +## -property-value +The name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingactivity_startactivity_1799218284.md b/windows.foundation.diagnostics/loggingactivity_startactivity_1799218284.md index 523f65a00a..93510a736c 100644 --- a/windows.foundation.diagnostics/loggingactivity_startactivity_1799218284.md +++ b/windows.foundation.diagnostics/loggingactivity_startactivity_1799218284.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StartActivity ## -description Writes an activity start event with the specified fields and level and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for the start event. ### -param fields The fields for this event. May be **null **. ### -param level The level of detail for this event. ## -returns An object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String)](loggingactivity_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingactivity_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StartActivity + +## -description +Writes an activity start event with the specified fields and level and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for the start event. + +### -param fields +The fields for this event. May be **null **. + +### -param level +The level of detail for this event. + +## -returns +An object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String)](loggingactivity_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingactivity_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_startactivity_1851321502.md b/windows.foundation.diagnostics/loggingactivity_startactivity_1851321502.md index 7f34429dda..6ef644fb53 100644 --- a/windows.foundation.diagnostics/loggingactivity_startactivity_1851321502.md +++ b/windows.foundation.diagnostics/loggingactivity_startactivity_1851321502.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StartActivity ## -description Writes an activity start event and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for the start event. ## -returns An object the represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String, LoggingFields)](loggingactivity_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingactivity_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StartActivity + +## -description +Writes an activity start event and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for the start event. + +## -returns +An object the represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String, LoggingFields)](loggingactivity_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingactivity_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_startactivity_2067413660.md b/windows.foundation.diagnostics/loggingactivity_startactivity_2067413660.md index db4feeab85..67f058cbb6 100644 --- a/windows.foundation.diagnostics/loggingactivity_startactivity_2067413660.md +++ b/windows.foundation.diagnostics/loggingactivity_startactivity_2067413660.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StartActivity ## -description Writes an activity start event with fields and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for the start event. ### -param fields The fields for this event. ## -returns An object that represents the new activity. ## -remarks Methods that accept a [LoggingFields](loggingfields.md) parameter also accept **null**. A **null** value is semantically equivalent to a newly-constructed or cleared [LoggingFields](loggingfields.md) object and represents an empty payload. ## -examples ## -see-also [StartActivity(String)](loggingactivity_startactivity_1851321502.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingactivity_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StartActivity + +## -description +Writes an activity start event with fields and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for the start event. + +### -param fields +The fields for this event. + +## -returns +An object that represents the new activity. + +## -remarks +Methods that accept a [LoggingFields](loggingfields.md) parameter also accept **null**. A **null** value is semantically equivalent to a newly-constructed or cleared [LoggingFields](loggingfields.md) object and represents an empty payload. + +## -examples + +## -see-also +[StartActivity(String)](loggingactivity_startactivity_1851321502.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingactivity_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingactivity_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_startactivity_878877052.md b/windows.foundation.diagnostics/loggingactivity_startactivity_878877052.md index d587eefa25..9c137de41f 100644 --- a/windows.foundation.diagnostics/loggingactivity_startactivity_878877052.md +++ b/windows.foundation.diagnostics/loggingactivity_startactivity_878877052.md @@ -1,3 +1,43 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StartActivity ## -description Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -returns An object that represents the new activity. ## -remarks If you provide *options*, **LoggingOptions.ActivityId**, **LoggingOptions.RelatedActivityId**, and **LoggingOptions.Opcode** are ignored because the new LoggingActivity object's options will be set as follows: The **RelatedId** is set using this LoggingActivity's **Id**. The **Id** is automatically generated. The **opcode** is set to **LoggingOptions.Opcode.Start** ## -examples ## -see-also [StartActivity(String)](loggingactivity_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingactivity_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingactivity_startactivity_1799218284.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StartActivity + +## -description +Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -returns +An object that represents the new activity. + +## -remarks +If you provide *options*, **LoggingOptions.ActivityId**, **LoggingOptions.RelatedActivityId**, and **LoggingOptions.Opcode** are ignored because the new LoggingActivity object's options will be set as follows: + +The **RelatedId** is set using this LoggingActivity's **Id**. + +The **Id** is automatically generated. + +The **opcode** is set to **LoggingOptions.Opcode.Start** + +## -examples + +## -see-also +[StartActivity(String)](loggingactivity_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingactivity_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingactivity_startactivity_1799218284.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_stopactivity_1420206369.md b/windows.foundation.diagnostics/loggingactivity_stopactivity_1420206369.md index 0cd91be03a..5966edb5ed 100644 --- a/windows.foundation.diagnostics/loggingactivity_stopactivity_1420206369.md +++ b/windows.foundation.diagnostics/loggingactivity_stopactivity_1420206369.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StopActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StopActivity ## -description Marks the activity as closed/disposed and generates a stop event with the specified event name, fields, and options. ## -parameters ### -param stopEventName The name for the stop event. ### -param fields The fields for this event. May be **null**. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -remarks If you pass *LoggingOptions*: **LoggingOptions.Keywords** is ignored because the keywords for the stop event are based on the keywords for the start event. **LoggingOptions.Opcode** is ignored because the opcode is always **LoggingOptions.Stop** for a Stop event. **LoggingOptions.ActivityId** is ignored because the **Id** from this LoggingActivity is used. **LoggingOptions.RelatedActivityId** is ignored because it is only used for the start event. ## -examples ## -see-also [StopActivity(String)](loggingactivity_stopactivity_294925909.md), [StopActivity(String, LoggingFields)](loggingactivity_stopactivity_83288151.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StopActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StopActivity + +## -description +Marks the activity as closed/disposed and generates a stop event with the specified event name, fields, and options. + +## -parameters +### -param stopEventName +The name for the stop event. + +### -param fields +The fields for this event. May be **null**. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -remarks +If you pass *LoggingOptions*: + +**LoggingOptions.Keywords** is ignored because the keywords for the stop event are based on the keywords for the start event. + +**LoggingOptions.Opcode** is ignored because the opcode is always **LoggingOptions.Stop** for a Stop event. + +**LoggingOptions.ActivityId** is ignored because the **Id** from this LoggingActivity is used. + +**LoggingOptions.RelatedActivityId** is ignored because it is only used for the start event. + +## -examples + +## -see-also +[StopActivity(String)](loggingactivity_stopactivity_294925909.md), [StopActivity(String, LoggingFields)](loggingactivity_stopactivity_83288151.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_stopactivity_294925909.md b/windows.foundation.diagnostics/loggingactivity_stopactivity_294925909.md index 8a2203c0e7..57ec3ad21b 100644 --- a/windows.foundation.diagnostics/loggingactivity_stopactivity_294925909.md +++ b/windows.foundation.diagnostics/loggingactivity_stopactivity_294925909.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StopActivity(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StopActivity ## -description Marks the activity as closed/disposed and generates a stop event with the specified event name. ## -parameters ### -param stopEventName The name for the stop event. ## -remarks The level for this event is the same as the level specified for the start event. This function will fail if the activity has already been closed or disposed. ## -examples ## -see-also [StopActivity(String, LoggingFields)](loggingactivity_stopactivity_83288151.md), [StopActivity(String, LoggingFields, LoggingOptions)](loggingactivity_stopactivity_1420206369.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StopActivity(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StopActivity + +## -description +Marks the activity as closed/disposed and generates a stop event with the specified event name. + +## -parameters +### -param stopEventName +The name for the stop event. + +## -remarks +The level for this event is the same as the level specified for the start event. + +This function will fail if the activity has already been closed or disposed. + +## -examples + +## -see-also +[StopActivity(String, LoggingFields)](loggingactivity_stopactivity_83288151.md), [StopActivity(String, LoggingFields, LoggingOptions)](loggingactivity_stopactivity_1420206369.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingactivity_stopactivity_83288151.md b/windows.foundation.diagnostics/loggingactivity_stopactivity_83288151.md index c0004799c1..19c251c5ab 100644 --- a/windows.foundation.diagnostics/loggingactivity_stopactivity_83288151.md +++ b/windows.foundation.diagnostics/loggingactivity_stopactivity_83288151.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StopActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingActivity.StopActivity ## -description Marks the activity as closed/disposed and generates a stop event with the specified event name and fields. ## -parameters ### -param stopEventName The name for this event. ### -param fields The fields for this event. May be **null**. ## -remarks Methods that accept a [LoggingFields](loggingfields.md) parameter also accept **null**. A **null** value is semantically equivalent to a newly-constructed or cleared [LoggingFields](loggingfields.md) object and represents an empty payload. ## -examples ## -see-also [StopActivity(String)](loggingactivity_stopactivity_294925909.md), [StopActivity(String, LoggingFields, LoggingOptions)](loggingactivity_stopactivity_1420206369.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingActivity.StopActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingActivity.StopActivity + +## -description +Marks the activity as closed/disposed and generates a stop event with the specified event name and fields. + +## -parameters +### -param stopEventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +## -remarks +Methods that accept a [LoggingFields](loggingfields.md) parameter also accept **null**. A **null** value is semantically equivalent to a newly-constructed or cleared [LoggingFields](loggingfields.md) object and represents an empty payload. + +## -examples + +## -see-also +[StopActivity(String)](loggingactivity_stopactivity_294925909.md), [StopActivity(String, LoggingFields, LoggingOptions)](loggingactivity_stopactivity_1420206369.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel.md b/windows.foundation.diagnostics/loggingchannel.md index 4fffe527a6..894afbc10d 100644 --- a/windows.foundation.diagnostics/loggingchannel.md +++ b/windows.foundation.diagnostics/loggingchannel.md @@ -1,3 +1,38 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LoggingChannel --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LoggingChannel ## -description Represents a source of log messages. ## -remarks The default [LoggingLevel](logginglevel.md) is **Verbose**. Add [LoggingChannel](loggingchannel_loggingchannel.md) instances to a [LoggingSession](loggingsession.md) or a [FileLoggingSession](fileloggingsession.md) to enable logging in your app. > **Windows 10** > Two modes of operation are now supported: Windows 8.1 compatibility mode and the new behavior supported by Windows 10 and later which allows you to log self-describing Event Tracing for Windows (ETW) events without a manifest. + For Windows 8.1 compatibility mode, create the object using the [LoggingChannel(String)](loggingchannel_loggingchannel.md) constructor. + For Windows 10 and later specific behavior, create the object using the [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md) or [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md) constructor. The differences between these two modes are:
Windows 8.1 compatibility modeWindows 10 and later specific behavior
Some **LoggingChannel** events may reference the 4bd2826e-54a1-4ba9-bf63-92b73ea1ac4a which is the GUID for the **Microsoft-Windows-Diagnostics-LoggingChannel** manifest that is available on Windows 8.1 or later.All events are self-describing. No manifest is required.
The [Id](loggingchannel_id.md) property is always 4bd2826e-54a1-4ba9-bf63-92b73ea1ac4a, which is the GUID for the **Microsoft-Windows-Diagnostics-LoggingChannel** manifest.The [Id](loggingchannel_id.md) property varies based on how the channel is constructed. If the [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md) constructor is used, the **Id** is determined by hashing the name parameter. If the [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md) constructor is used, the specified *id* parameter is used.
Events generated by the **LogMessage**, **LogValuePair**, the [LoggingActivity](loggingactivity_loggingactivity.md) constructors or destructor, or activity.[Activity.Close ](loggingactivity_close.md) method use manifest-based event encoding. All other events use self-describing TraceLogging event encoding.All events use self-describing TraceLogging event encoding.
The channel provider name is Microsoft-Windows-Diagnostics-LoggingChannel. The channel name is recorded in each event in the payload field **LoggingChannelName**.The channel name is used as the provider name. Events will not have a **LoggingChannelName** field.
## -examples ## -see-also [LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md), [ILoggingChannel](iloggingchannel.md), [IClosable](../windows.foundation/iclosable.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LoggingChannel +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel + +## -description +Represents a source of log messages. + +## -remarks +The default [LoggingLevel](logginglevel.md) is **Verbose**. + +Add [LoggingChannel](loggingchannel_loggingchannel.md) instances to a [LoggingSession](loggingsession.md) or a [FileLoggingSession](fileloggingsession.md) to enable logging in your app. + + + +> **Windows 10** +> Two modes of operation are now supported: Windows 8.1 compatibility mode and the new behavior supported by Windows 10 and later which allows you to log self-describing Event Tracing for Windows (ETW) events without a manifest. + For Windows 8.1 compatibility mode, create the object using the [LoggingChannel(String)](loggingchannel_loggingchannel.md) constructor. ++ For Windows 10 and later specific behavior, create the object using the [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md) or [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md) constructor. +The differences between these two modes are: + + + + + + + +
Windows 8.1 compatibility modeWindows 10 and later specific behavior
Some **LoggingChannel** events may reference the 4bd2826e-54a1-4ba9-bf63-92b73ea1ac4a which is the GUID for the **Microsoft-Windows-Diagnostics-LoggingChannel** manifest that is available on Windows 8.1 or later.All events are self-describing. No manifest is required.
The [Id](loggingchannel_id.md) property is always 4bd2826e-54a1-4ba9-bf63-92b73ea1ac4a, which is the GUID for the **Microsoft-Windows-Diagnostics-LoggingChannel** manifest.The [Id](loggingchannel_id.md) property varies based on how the channel is constructed. If the [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md) constructor is used, the **Id** is determined by hashing the name parameter. If the [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md) constructor is used, the specified *id* parameter is used.
Events generated by the **LogMessage**, **LogValuePair**, the [LoggingActivity](loggingactivity_loggingactivity.md) constructors or destructor, or activity.[Activity.Close ](loggingactivity_close.md) method use manifest-based event encoding. All other events use self-describing TraceLogging event encoding.All events use self-describing TraceLogging event encoding.
The channel provider name is Microsoft-Windows-Diagnostics-LoggingChannel. The channel name is recorded in each event in the payload field **LoggingChannelName**.The channel name is used as the provider name. Events will not have a **LoggingChannelName** field.
+ +## -examples + +## -see-also +[LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md), [ILoggingChannel](iloggingchannel.md), [IClosable](../windows.foundation/iclosable.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_close_811482585.md b/windows.foundation.diagnostics/loggingchannel_close_811482585.md index 3e43b777e1..0e9dd157e0 100644 --- a/windows.foundation.diagnostics/loggingchannel_close_811482585.md +++ b/windows.foundation.diagnostics/loggingchannel_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.Close --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.Close ## -description Ends logging on the current logging channel. ## -remarks ## -examples ## -see-also [LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.Close + +## -description +Ends logging on the current logging channel. + +## -remarks + +## -examples + +## -see-also +[LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_enabled.md b/windows.foundation.diagnostics/loggingchannel_enabled.md index 4ce9d4a8a6..d01a590658 100644 --- a/windows.foundation.diagnostics/loggingchannel_enabled.md +++ b/windows.foundation.diagnostics/loggingchannel_enabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Enabled --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingChannel.Enabled ## -description Gets a value that indicates whether at least one session is logging events from this channel. ## -property-value Returns **true** if at least one session is listening for events from the channel, and otherwise **false**. ## -remarks ## -examples ## -see-also [LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Enabled +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.Enabled + +## -description +Gets a value that indicates whether at least one session is logging events from this channel. + +## -property-value +Returns **true** if at least one session is listening for events from the channel, and otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_id.md b/windows.foundation.diagnostics/loggingchannel_id.md index 298773755c..8d998fd22e 100644 --- a/windows.foundation.diagnostics/loggingchannel_id.md +++ b/windows.foundation.diagnostics/loggingchannel_id.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Id --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingChannel.Id ## -description Returns the provider identifier for this channel. ## -property-value The provider identifier for this channel. ## -remarks The value of the **Id** depends on how the **LoggingChannel** is constructed as described in the following table:
Constructor usedThe value of **Id**
[LoggingChannel(String)](loggingchannel_loggingchannel_290278668.md)The channel will be operating in Windows 8.1 compatibility mode and will return **4bd2826e-54a1-4ba9-bf63-92b73ea1ac4a** which is the GUID for the Microsoft-Windows-Diagnostics-LoggingChannel manifest.
[LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md)The GUID will be determined by hashing the *name* parameter passed to the **LoggingChannel** constructor.
[LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md)The value is the same as the *Id* parameter passed to the [LoggingChannel](loggingchannel.md) constructor.
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Id +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.Id + +## -description +Returns the provider identifier for this channel. + +## -property-value +The provider identifier for this channel. + +## -remarks +The value of the **Id** depends on how the **LoggingChannel** is constructed as described in the following table: + + + + +
Constructor usedThe value of **Id**
[LoggingChannel(String)](loggingchannel_loggingchannel_290278668.md)The channel will be operating in Windows 8.1 compatibility mode and will return **4bd2826e-54a1-4ba9-bf63-92b73ea1ac4a** which is the GUID for the Microsoft-Windows-Diagnostics-LoggingChannel manifest.
[LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md)The GUID will be determined by hashing the *name* parameter passed to the **LoggingChannel** constructor.
[LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md)The value is the same as the *Id* parameter passed to the [LoggingChannel](loggingchannel.md) constructor.
+ +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingchannel_isenabled_1519006295.md b/windows.foundation.diagnostics/loggingchannel_isenabled_1519006295.md index 23984ef792..1fb2e3ce51 100644 --- a/windows.foundation.diagnostics/loggingchannel_isenabled_1519006295.md +++ b/windows.foundation.diagnostics/loggingchannel_isenabled_1519006295.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel,System.Int64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled ## -description Indicates whether at least one session is listening for events with the specified level and keywords from this channel. ## -parameters ### -param level The event severity level. ### -param keywords The keywords. Each bit of the keywords value represents an event category. ## -returns Returns **true** if at least one session is listening for events with the specified level and keywords from the channel, and otherwise **false**. ## -remarks ## -examples ## -see-also [IsEnabled](loggingchannel_isenabled_180154405.md), [IsEnabled(LoggingLevel)](loggingchannel_isenabled_826472551.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel,System.Int64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled + +## -description +Indicates whether at least one session is listening for events with the specified level and keywords from this channel. + +## -parameters +### -param level +The event severity level. + +### -param keywords +The keywords. Each bit of the keywords value represents an event category. + +## -returns +Returns **true** if at least one session is listening for events with the specified level and keywords from the channel, and otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[IsEnabled](loggingchannel_isenabled_180154405.md), [IsEnabled(LoggingLevel)](loggingchannel_isenabled_826472551.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_isenabled_180154405.md b/windows.foundation.diagnostics/loggingchannel_isenabled_180154405.md index 8173d85910..8e89c2c885 100644 --- a/windows.foundation.diagnostics/loggingchannel_isenabled_180154405.md +++ b/windows.foundation.diagnostics/loggingchannel_isenabled_180154405.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled ## -description Indicates whether at least one session is listening for events from the channel. ## -returns Returns **true** if at least one session is listening for events from the channel, and otherwise **false**. ## -remarks This property is functionally equivalent to [Enabled](iloggingchannel_enabled.md) ## -examples ## -see-also [IsEnabled(LoggingLevel)](loggingchannel_isenabled_826472551.md), [IsEnabled(LoggingLevel, Int64)](loggingchannel_isenabled_1519006295.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled + +## -description +Indicates whether at least one session is listening for events from the channel. + +## -returns +Returns **true** if at least one session is listening for events from the channel, and otherwise **false**. + +## -remarks +This property is functionally equivalent to [Enabled](iloggingchannel_enabled.md) + +## -examples + +## -see-also +[IsEnabled(LoggingLevel)](loggingchannel_isenabled_826472551.md), [IsEnabled(LoggingLevel, Int64)](loggingchannel_isenabled_1519006295.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_isenabled_826472551.md b/windows.foundation.diagnostics/loggingchannel_isenabled_826472551.md index dbd8f66408..30118cd422 100644 --- a/windows.foundation.diagnostics/loggingchannel_isenabled_826472551.md +++ b/windows.foundation.diagnostics/loggingchannel_isenabled_826472551.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled ## -description Indicates whether at least one session is listening for events with the specified event severity level from the channel. ## -parameters ### -param level The event severity level. ## -returns Returns **true** if at least one session is listening for events with the specified level from the channel, and otherwise **false**. ## -remarks This property is equivalent to channel.Enabled && channel.Level <= level. ## -examples ## -see-also [IsEnabled](loggingchannel_isenabled_180154405.md), [IsEnabled(LoggingLevel, Int64)](loggingchannel_isenabled_1519006295.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled(Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.IsEnabled + +## -description +Indicates whether at least one session is listening for events with the specified event severity level from the channel. + +## -parameters +### -param level +The event severity level. + +## -returns +Returns **true** if at least one session is listening for events with the specified level from the channel, and otherwise **false**. + +## -remarks +This property is equivalent to channel.Enabled && channel.Level <= level. + +## -examples + +## -see-also +[IsEnabled](loggingchannel_isenabled_180154405.md), [IsEnabled(LoggingLevel, Int64)](loggingchannel_isenabled_1519006295.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_level.md b/windows.foundation.diagnostics/loggingchannel_level.md index 412eb40e23..c8e48c2e8d 100644 --- a/windows.foundation.diagnostics/loggingchannel_level.md +++ b/windows.foundation.diagnostics/loggingchannel_level.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Level --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingChannel.Level ## -description Gets the minimum level at which any session is listening to events from this channel. ## -property-value The event level required for the session to listen to an event from this channel. ## -remarks This value is only valid if the [Enabled](loggingchannel_enabled.md) property is set to **true**. ## -examples ## -see-also [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Level +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.Level + +## -description +Gets the minimum level at which any session is listening to events from this channel. + +## -property-value +The event level required for the session to listen to an event from this channel. + +## -remarks +This value is only valid if the [Enabled](loggingchannel_enabled.md) property is set to **true**. + +## -examples + +## -see-also +[LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logevent_1783961521.md b/windows.foundation.diagnostics/loggingchannel_logevent_1783961521.md index 7350a9526f..742e4b92a5 100644 --- a/windows.foundation.diagnostics/loggingchannel_logevent_1783961521.md +++ b/windows.foundation.diagnostics/loggingchannel_logevent_1783961521.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogEvent ## -description Logs an event with the specified name. ## -parameters ### -param eventName The name for this event. ## -remarks ## -examples ## -see-also [LogEvent(String, LoggingFields)](loggingchannel_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingchannel_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogEvent + +## -description +Logs an event with the specified name. + +## -parameters +### -param eventName +The name for this event. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String, LoggingFields)](loggingchannel_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingchannel_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logevent_1865424709.md b/windows.foundation.diagnostics/loggingchannel_logevent_1865424709.md index ce14929119..21e600aeaa 100644 --- a/windows.foundation.diagnostics/loggingchannel_logevent_1865424709.md +++ b/windows.foundation.diagnostics/loggingchannel_logevent_1865424709.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogEvent ## -description Logs an event with the specified name, fields, and level. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ## -remarks ## -examples ## -see-also [LogEvent(String)](loggingchannel_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingchannel_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogEvent + +## -description +Logs an event with the specified name, fields, and level. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](loggingchannel_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingchannel_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logevent_2134360499.md b/windows.foundation.diagnostics/loggingchannel_logevent_2134360499.md index d382d0c9cd..47537b5574 100644 --- a/windows.foundation.diagnostics/loggingchannel_logevent_2134360499.md +++ b/windows.foundation.diagnostics/loggingchannel_logevent_2134360499.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogEvent ## -description Logs an event with the specified name and fields. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ## -remarks ## -examples ## -see-also [LogEvent(String)](loggingchannel_logevent_1783961521.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingchannel_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_logevent_812606037.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogEvent + +## -description +Logs an event with the specified name and fields. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](loggingchannel_logevent_1783961521.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingchannel_logevent_1865424709.md), [LogEvent(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_logevent_812606037.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logevent_812606037.md b/windows.foundation.diagnostics/loggingchannel_logevent_812606037.md index 234654c2a2..bfb1922431 100644 --- a/windows.foundation.diagnostics/loggingchannel_logevent_812606037.md +++ b/windows.foundation.diagnostics/loggingchannel_logevent_812606037.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogEvent ## -description Logs an event with the specified name, fields, level, and options. ## -parameters ### -param eventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -remarks ## -examples ## -see-also [LogEvent(String)](loggingchannel_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingchannel_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingchannel_logevent_1865424709.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogEvent(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogEvent + +## -description +Logs an event with the specified name, fields, level, and options. + +## -parameters +### -param eventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -remarks + +## -examples + +## -see-also +[LogEvent(String)](loggingchannel_logevent_1783961521.md), [LogEvent(String, LoggingFields)](loggingchannel_logevent_2134360499.md), [LogEvent(String, LoggingFields, LoggingLevel)](loggingchannel_logevent_1865424709.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_loggingchannel_1496214966.md b/windows.foundation.diagnostics/loggingchannel_loggingchannel_1496214966.md index 0f92d8e834..fa36fe554e 100644 --- a/windows.foundation.diagnostics/loggingchannel_loggingchannel_1496214966.md +++ b/windows.foundation.diagnostics/loggingchannel_loggingchannel_1496214966.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.#ctor(System.String,Windows.Foundation.Diagnostics.LoggingChannelOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LoggingChannel ## -description Initializes a new instance of the [LoggingChannel](loggingchannel.md) class with the specified options. ## -parameters ### -param name The name of the logging channel. ### -param options The channel options. Pass **null** to specify the default options. ## -remarks ## -examples ## -see-also [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md), [LoggingChannel(String)](loggingchannel_loggingchannel_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.#ctor(System.String,Windows.Foundation.Diagnostics.LoggingChannelOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LoggingChannel + +## -description +Initializes a new instance of the [LoggingChannel](loggingchannel.md) class with the specified options. + +## -parameters +### -param name +The name of the logging channel. + +### -param options +The channel options. Pass **null** to specify the default options. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md), [LoggingChannel(String)](loggingchannel_loggingchannel_290278668.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_loggingchannel_2599058.md b/windows.foundation.diagnostics/loggingchannel_loggingchannel_2599058.md index 335dc2cc45..8994762862 100644 --- a/windows.foundation.diagnostics/loggingchannel_loggingchannel_2599058.md +++ b/windows.foundation.diagnostics/loggingchannel_loggingchannel_2599058.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.#ctor(System.String,Windows.Foundation.Diagnostics.LoggingChannelOptions,System.Guid) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LoggingChannel ## -description Initializes a new instance of the [LoggingChannel](loggingchannel.md) class with the specified options and channel ID. ## -parameters ### -param name The name of the logging channel. ### -param options The channel options. Pass **null** to specify the default options. ### -param id The channel identifier to use instead of the automatically generated identifier. ## -remarks ## -examples ## -see-also [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md), [LoggingChannel(String)](loggingchannel_loggingchannel_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.#ctor(System.String,Windows.Foundation.Diagnostics.LoggingChannelOptions,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LoggingChannel + +## -description +Initializes a new instance of the [LoggingChannel](loggingchannel.md) class with the specified options and channel ID. + +## -parameters +### -param name +The name of the logging channel. + +### -param options +The channel options. Pass **null** to specify the default options. + +### -param id +The channel identifier to use instead of the automatically generated identifier. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md), [LoggingChannel(String)](loggingchannel_loggingchannel_290278668.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_loggingchannel_290278668.md b/windows.foundation.diagnostics/loggingchannel_loggingchannel_290278668.md index a067dd2228..b5da78f7a2 100644 --- a/windows.foundation.diagnostics/loggingchannel_loggingchannel_290278668.md +++ b/windows.foundation.diagnostics/loggingchannel_loggingchannel_290278668.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.#ctor(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LoggingChannel ## -description This constructor creates a **LoggingChannel** in Windows 8.1 compatibility mode. ## -parameters ### -param name The name of the logging channel. ## -remarks This constructor creates a **LoggingChannel** in Windows 8.1 compatibility mode. For a description of the differences between Windows 8.1 compatibility mode and the new behavior supported by Windows 10, see [LoggingChannel](loggingchannel.md). > **Windows 10** > This constructor should only be used if you need compatibility with Windows 8.1. For Windows 10 and later, use [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md) or [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md). ## -examples ## -see-also [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md), [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md), [LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LoggingChannel + +## -description +This constructor creates a **LoggingChannel** in Windows 8.1 compatibility mode. + +## -parameters +### -param name +The name of the logging channel. + +## -remarks +This constructor creates a **LoggingChannel** in Windows 8.1 compatibility mode. For a description of the differences between Windows 8.1 compatibility mode and the new behavior supported by Windows 10, see [LoggingChannel](loggingchannel.md). + +> **Windows 10** +> This constructor should only be used if you need compatibility with Windows 8.1. For Windows 10 and later, use [LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md) or [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md). + +## -examples + +## -see-also +[LoggingChannel(String, LoggingChannelOptions)](loggingchannel_loggingchannel_1496214966.md), [LoggingChannel(String, LoggingChannelOptions, Guid)](loggingchannel_loggingchannel_2599058.md), [LoggingSession](loggingsession.md), [FileLoggingSession](fileloggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_loggingenabled.md b/windows.foundation.diagnostics/loggingchannel_loggingenabled.md index 6b4a65ee0d..a769202a62 100644 --- a/windows.foundation.diagnostics/loggingchannel_loggingenabled.md +++ b/windows.foundation.diagnostics/loggingchannel_loggingenabled.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Foundation.Diagnostics.LoggingChannel.LoggingEnabled --api-type: winrt event ---- # Windows.Foundation.Diagnostics.LoggingChannel.LoggingEnabled ## -description Raised when the logging channel is attached to a [LoggingSession](loggingsession.md) or other event tracing and debugging tools. ## -remarks The [LoggingEnabled](loggingchannel_loggingenabled.md) event is raised when a channel is consumed by a session within the app's process, or by a kernel-mode ETW session started with a debugging or performance analysis tool. ## -examples ## -see-also [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: E:Windows.Foundation.Diagnostics.LoggingChannel.LoggingEnabled +-api-type: winrt event +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LoggingEnabled + +## -description +Raised when the logging channel is attached to a [LoggingSession](loggingsession.md) or other event tracing and debugging tools. + +## -remarks +The [LoggingEnabled](loggingchannel_loggingenabled.md) event is raised when a channel is consumed by a session within the app's process, or by a kernel-mode ETW session started with a debugging or performance analysis tool. + +## -examples + +## -see-also +[LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logmessage_1040390993.md b/windows.foundation.diagnostics/loggingchannel_logmessage_1040390993.md index 434fcecfdb..36e26c5aab 100644 --- a/windows.foundation.diagnostics/loggingchannel_logmessage_1040390993.md +++ b/windows.foundation.diagnostics/loggingchannel_logmessage_1040390993.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogMessage(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogMessage ## -description Logs a message to the current [LoggingChannel](loggingchannel.md). ## -parameters ### -param eventString The message to log. ## -remarks ## -examples ## -see-also [LogMessage(String, LoggingLevel)](loggingchannel_logmessage_1241451477.md), [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogMessage(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogMessage + +## -description +Logs a message to the current [LoggingChannel](loggingchannel.md). + +## -parameters +### -param eventString +The message to log. + +## -remarks + +## -examples + +## -see-also +[LogMessage(String, LoggingLevel)](loggingchannel_logmessage_1241451477.md), [LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logmessage_1241451477.md b/windows.foundation.diagnostics/loggingchannel_logmessage_1241451477.md index d7ef966f7e..e41b1195bd 100644 --- a/windows.foundation.diagnostics/loggingchannel_logmessage_1241451477.md +++ b/windows.foundation.diagnostics/loggingchannel_logmessage_1241451477.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogMessage(System.String,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogMessage ## -description Logs a message to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). ## -parameters ### -param eventString The message to log. ### -param level The logging level. ## -remarks ## -examples ## -see-also [LogMessage(String)](loggingchannel_logmessage_1040390993.md), [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogMessage(System.String,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogMessage + +## -description +Logs a message to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). + +## -parameters +### -param eventString +The message to log. + +### -param level +The logging level. + +## -remarks + +## -examples + +## -see-also +[LogMessage(String)](loggingchannel_logmessage_1040390993.md), [LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logvaluepair_1788406125.md b/windows.foundation.diagnostics/loggingchannel_logvaluepair_1788406125.md index 92c8716e2e..b9c953c3ac 100644 --- a/windows.foundation.diagnostics/loggingchannel_logvaluepair_1788406125.md +++ b/windows.foundation.diagnostics/loggingchannel_logvaluepair_1788406125.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair ## -description Logs data to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). ## -parameters ### -param value1 The string to associate with *value2*. ### -param value2 The value to associate with *value1*. ### -param level The logging level. ## -remarks ## -examples ## -see-also [LogValuePair(String, Int32)](loggingchannel_logvaluepair_2057254811.md), [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair + +## -description +Logs data to the current [LoggingChannel](loggingchannel.md) with the specified [LoggingLevel](logginglevel.md). + +## -parameters +### -param value1 +The string to associate with *value2*. + +### -param value2 +The value to associate with *value1*. + +### -param level +The logging level. + +## -remarks + +## -examples + +## -see-also +[LogValuePair(String, Int32)](loggingchannel_logvaluepair_2057254811.md), [LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_logvaluepair_2057254811.md b/windows.foundation.diagnostics/loggingchannel_logvaluepair_2057254811.md index 16340f81b2..a20f4507c9 100644 --- a/windows.foundation.diagnostics/loggingchannel_logvaluepair_2057254811.md +++ b/windows.foundation.diagnostics/loggingchannel_logvaluepair_2057254811.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair(System.String,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair ## -description Logs data to the current [LoggingChannel](loggingchannel.md). ## -parameters ### -param value1 The string to associate with *value2*. ### -param value2 The value to associate with *value1*. ## -remarks Call the [LogValuePair](loggingchannel_logvaluepair.md) method to log data as a key-value pair to the current [LoggingChannel](loggingchannel.md). ## -examples ## -see-also [LogValuePair(String, Int32, LoggingLevel)](loggingchannel_logvaluepair_1788406125.md), [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair(System.String,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.LogValuePair + +## -description +Logs data to the current [LoggingChannel](loggingchannel.md). + +## -parameters +### -param value1 +The string to associate with *value2*. + +### -param value2 +The value to associate with *value1*. + +## -remarks +Call the [LogValuePair](loggingchannel_logvaluepair.md) method to log data as a key-value pair to the current [LoggingChannel](loggingchannel.md). + +## -examples + +## -see-also +[LogValuePair(String, Int32, LoggingLevel)](loggingchannel_logvaluepair_1788406125.md), [LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_name.md b/windows.foundation.diagnostics/loggingchannel_name.md index a0d5a141ae..344a25ca0a 100644 --- a/windows.foundation.diagnostics/loggingchannel_name.md +++ b/windows.foundation.diagnostics/loggingchannel_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingChannel.Name ## -description Gets the name of the current [LoggingChannel](loggingchannel.md). ## -property-value The name. ## -remarks ## -examples ## -see-also [LoggingSession](loggingsession.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingChannel.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.Name + +## -description +Gets the name of the current [LoggingChannel](loggingchannel.md). + +## -property-value +The name. + +## -remarks + +## -examples + +## -see-also +[LoggingSession](loggingsession.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_startactivity_1799218284.md b/windows.foundation.diagnostics/loggingchannel_startactivity_1799218284.md index ed7c279b40..ca709deced 100644 --- a/windows.foundation.diagnostics/loggingchannel_startactivity_1799218284.md +++ b/windows.foundation.diagnostics/loggingchannel_startactivity_1799218284.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.StartActivity ## -description Writes an activity start event with the specified fields and level, and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. May be **null **. ### -param level The level of detail for this event. ## -returns Returns an object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String)](loggingchannel_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingchannel_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.StartActivity + +## -description +Writes an activity start event with the specified fields and level, and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. May be **null **. + +### -param level +The level of detail for this event. + +## -returns +Returns an object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String)](loggingchannel_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingchannel_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_startactivity_1851321502.md b/windows.foundation.diagnostics/loggingchannel_startactivity_1851321502.md index 86d660af24..b9bbe8cf93 100644 --- a/windows.foundation.diagnostics/loggingchannel_startactivity_1851321502.md +++ b/windows.foundation.diagnostics/loggingchannel_startactivity_1851321502.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.StartActivity ## -description Writes an activity start event and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ## -returns Returns an object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String, LoggingFields)](loggingchannel_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingchannel_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.StartActivity + +## -description +Writes an activity start event and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +## -returns +Returns an object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String, LoggingFields)](loggingchannel_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingchannel_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_startactivity_2067413660.md b/windows.foundation.diagnostics/loggingchannel_startactivity_2067413660.md index b07784f841..dee9324f9a 100644 --- a/windows.foundation.diagnostics/loggingchannel_startactivity_2067413660.md +++ b/windows.foundation.diagnostics/loggingchannel_startactivity_2067413660.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.StartActivity ## -description Writes an activity start event with the specified fields and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. ## -returns Returns an object that represents the new activity. ## -remarks ## -examples ## -see-also [StartActivity(String)](loggingchannel_startactivity_1851321502.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingchannel_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_startactivity_878877052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.StartActivity + +## -description +Writes an activity start event with the specified fields and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. + +## -returns +Returns an object that represents the new activity. + +## -remarks + +## -examples + +## -see-also +[StartActivity(String)](loggingchannel_startactivity_1851321502.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingchannel_startactivity_1799218284.md), [StartActivity(String, LoggingFields, LoggingLevel, LoggingOptions)](loggingchannel_startactivity_878877052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchannel_startactivity_878877052.md b/windows.foundation.diagnostics/loggingchannel_startactivity_878877052.md index 0c59171105..d4c57eb197 100644 --- a/windows.foundation.diagnostics/loggingchannel_startactivity_878877052.md +++ b/windows.foundation.diagnostics/loggingchannel_startactivity_878877052.md @@ -1,3 +1,41 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannel.StartActivity ## -description Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object. ## -parameters ### -param startEventName The name for this event. ### -param fields The fields for this event. May be **null**. ### -param level The level of detail for this event. ### -param options The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. ## -returns Returns an object that represents the new activity. ## -remarks If you provide *options*, **LoggingOptions.ActivityId** and **LoggingOptions.Opcode** are ignored because the new LoggingActivity object's options will be set as follows: The **Id** is automatically generated. The **opcode** is set to **LoggingOptions.Opcode.Start** ## -examples ## -see-also [StartActivity(String)](loggingchannel_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingchannel_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingchannel_startactivity_1799218284.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannel.StartActivity(System.String,Windows.Foundation.Diagnostics.LoggingFields,Windows.Foundation.Diagnostics.LoggingLevel,Windows.Foundation.Diagnostics.LoggingOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannel.StartActivity + +## -description +Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object. + +## -parameters +### -param startEventName +The name for this event. + +### -param fields +The fields for this event. May be **null**. + +### -param level +The level of detail for this event. + +### -param options +The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. + +## -returns +Returns an object that represents the new activity. + +## -remarks +If you provide *options*, **LoggingOptions.ActivityId** and **LoggingOptions.Opcode** are ignored because the new LoggingActivity object's options will be set as follows: + +The **Id** is automatically generated. + +The **opcode** is set to **LoggingOptions.Opcode.Start** + +## -examples + +## -see-also +[StartActivity(String)](loggingchannel_startactivity_1851321502.md), [StartActivity(String, LoggingFields)](loggingchannel_startactivity_2067413660.md), [StartActivity(String, LoggingFields, LoggingLevel)](loggingchannel_startactivity_1799218284.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchanneloptions.md b/windows.foundation.diagnostics/loggingchanneloptions.md index 0c6669ceac..16cfd4bdfe 100644 --- a/windows.foundation.diagnostics/loggingchanneloptions.md +++ b/windows.foundation.diagnostics/loggingchanneloptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LoggingChannelOptions --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LoggingChannelOptions ## -description Represents advanced settings that you can use to configure a [LoggingChannel](loggingchannel.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LoggingChannelOptions +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannelOptions + +## -description +Represents advanced settings that you can use to configure a [LoggingChannel](loggingchannel.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingchanneloptions_group.md b/windows.foundation.diagnostics/loggingchanneloptions_group.md index f47177d60f..2127579d6b 100644 --- a/windows.foundation.diagnostics/loggingchanneloptions_group.md +++ b/windows.foundation.diagnostics/loggingchanneloptions_group.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingChannelOptions.Group --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingChannelOptions.Group ## -description Gets or sets the channel group identifier. ## -property-value The group identifier. ## -remarks A channel can be a member of one group. Membership in a group indicates that the channel implements a specific set of behaviors. An Event Tracing for Windows (ETW) processing tool that can process groups could locate active channels that belong to a particular group, and could use knowledge of a group’s behaviors to route or manipulate the channel’s events. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingChannelOptions.Group +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannelOptions.Group + +## -description +Gets or sets the channel group identifier. + +## -property-value +The group identifier. + +## -remarks +A channel can be a member of one group. Membership in a group indicates that the channel implements a specific set of behaviors. An Event Tracing for Windows (ETW) processing tool that can process groups could locate active channels that belong to a particular group, and could use knowledge of a group’s behaviors to route or manipulate the channel’s events. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_1221375020.md b/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_1221375020.md index a3acfe88bc..13f351e811 100644 --- a/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_1221375020.md +++ b/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannelOptions.#ctor --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannelOptions.LoggingChannelOptions ## -description Creates a [LoggingChannelOptions](loggingchanneloptions.md) object with all options set to default values. ## -remarks ## -examples ## -see-also [LoggingChannelOptions(Guid)](loggingchanneloptions_loggingchanneloptions_512673126.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannelOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannelOptions.LoggingChannelOptions + +## -description +Creates a [LoggingChannelOptions](loggingchanneloptions.md) object with all options set to default values. + +## -remarks + +## -examples + +## -see-also +[LoggingChannelOptions(Guid)](loggingchanneloptions_loggingchanneloptions_512673126.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_512673126.md b/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_512673126.md index 7d80f81314..c76486b171 100644 --- a/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_512673126.md +++ b/windows.foundation.diagnostics/loggingchanneloptions_loggingchanneloptions_512673126.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingChannelOptions.#ctor(System.Guid) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingChannelOptions.LoggingChannelOptions ## -description Creates a [LoggingChannelOptions](loggingchanneloptions.md) object with all properties set to default values except for the specified group. ## -parameters ### -param group The group identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingChannelOptions.#ctor(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingChannelOptions.LoggingChannelOptions + +## -description +Creates a [LoggingChannelOptions](loggingchanneloptions.md) object with all properties set to default values except for the specified group. + +## -parameters +### -param group +The group identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingfields.md b/windows.foundation.diagnostics/loggingfields.md index e07bb26636..5ceaa7fbe0 100644 --- a/windows.foundation.diagnostics/loggingfields.md +++ b/windows.foundation.diagnostics/loggingfields.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LoggingFields --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LoggingFields ## -description Represents a sequence of event fields and provides methods for adding fields to the sequence. ## -remarks You can pass this object to a **LoggingChannel**.[LogEvent](loggingactivity_logevent.md) method to provide the payload (data) for an event. This class is not thread-safe. Ensure that an instance of this class is not modified simultaneously by multiple threads. This class can create nested structures. To create a structure, call [BeginStruct](loggingfields_beginstruct.md) to mark the start of the structure. Then add the fields that are part of the structure. Finally, call [EndStruct ](loggingfields_endstruct.md) to mark the end of the structure. Structures can be nested up to eight levels deep. > [!TIP] > Field names and field tags should be used for infrequently-changing metadata, not for frequently-changing data. The values for field names and tags should generally be constants, not variables. Event names, event tags, field names, field tags, and field formats are part of an event’s identity, and each unique event identity is tracked by a [LoggingChannel](loggingchannel.md). Using frequently-changing values for field names and tags will lead to increased memory usage in your application, and may make event decoding or analysis more complex. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LoggingFields +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields + +## -description +Represents a sequence of event fields and provides methods for adding fields to the sequence. + +## -remarks +You can pass this object to a **LoggingChannel**.[LogEvent](loggingactivity_logevent.md) method to provide the payload (data) for an event. + +This class is not thread-safe. Ensure that an instance of this class is not modified simultaneously by multiple threads. + +This class can create nested structures. To create a structure, call [BeginStruct](loggingfields_beginstruct.md) to mark the start of the structure. Then add the fields that are part of the structure. Finally, call [EndStruct ](loggingfields_endstruct.md) to mark the end of the structure. Structures can be nested up to eight levels deep. + + + +> [!TIP] +> Field names and field tags should be used for infrequently-changing metadata, not for frequently-changing data. The values for field names and tags should generally be constants, not variables. Event names, event tags, field names, field tags, and field formats are part of an event’s identity, and each unique event identity is tracked by a [LoggingChannel](loggingchannel.md). Using frequently-changing values for field names and tags will lead to increased memory usage in your application, and may make event decoding or analysis more complex. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingfields_addboolean_1350572586.md b/windows.foundation.diagnostics/loggingfields_addboolean_1350572586.md index 1a20d9a364..5e3710251c 100644 --- a/windows.foundation.diagnostics/loggingfields_addboolean_1350572586.md +++ b/windows.foundation.diagnostics/loggingfields_addboolean_1350572586.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBoolean(System.String,System.Boolean,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddBoolean ## -description Adds a boolean field with the specified field name, format, and tags. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddBoolean(String, Boolean)](loggingfields_addboolean_974707982.md), [AddBoolean(String, Boolean, LoggingFieldFormat)](loggingfields_addboolean_1967136790.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBoolean(System.String,System.Boolean,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddBoolean + +## -description +Adds a boolean field with the specified field name, format, and tags. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddBoolean(String, Boolean)](loggingfields_addboolean_974707982.md), [AddBoolean(String, Boolean, LoggingFieldFormat)](loggingfields_addboolean_1967136790.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addboolean_1967136790.md b/windows.foundation.diagnostics/loggingfields_addboolean_1967136790.md index 649f297f39..31a9f6231d 100644 --- a/windows.foundation.diagnostics/loggingfields_addboolean_1967136790.md +++ b/windows.foundation.diagnostics/loggingfields_addboolean_1967136790.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBoolean(System.String,System.Boolean,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddBoolean ## -description Adds a boolean field with the specified field name and format. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddBoolean(String, Boolean)](loggingfields_addboolean_974707982.md), [AddBoolean(String, Boolean, LoggingFieldFormat, Int32)](loggingfields_addboolean_1350572586.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBoolean(System.String,System.Boolean,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddBoolean + +## -description +Adds a boolean field with the specified field name and format. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddBoolean(String, Boolean)](loggingfields_addboolean_974707982.md), [AddBoolean(String, Boolean, LoggingFieldFormat, Int32)](loggingfields_addboolean_1350572586.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addboolean_974707982.md b/windows.foundation.diagnostics/loggingfields_addboolean_974707982.md index bc9c78a0e2..4a7dceba1b 100644 --- a/windows.foundation.diagnostics/loggingfields_addboolean_974707982.md +++ b/windows.foundation.diagnostics/loggingfields_addboolean_974707982.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBoolean(System.String,System.Boolean) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddBoolean ## -description Adds a boolean field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ## -remarks ## -examples ## -see-also [AddBoolean(String, Boolean, LoggingFieldFormat)](loggingfields_addboolean_1967136790.md), [AddBoolean(String, Boolean, LoggingFieldFormat, Int32)](loggingfields_addboolean_1350572586.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBoolean(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddBoolean + +## -description +Adds a boolean field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddBoolean(String, Boolean, LoggingFieldFormat)](loggingfields_addboolean_1967136790.md), [AddBoolean(String, Boolean, LoggingFieldFormat, Int32)](loggingfields_addboolean_1350572586.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addbooleanarray_1862884831.md b/windows.foundation.diagnostics/loggingfields_addbooleanarray_1862884831.md index d9dc40e067..be8d1bf620 100644 --- a/windows.foundation.diagnostics/loggingfields_addbooleanarray_1862884831.md +++ b/windows.foundation.diagnostics/loggingfields_addbooleanarray_1862884831.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray(System.String,System.Boolean[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray ## -description Adds a boolean array field with the specified field name. ## -parameters ### -param name The name of the event field. ### -param value The array values for the event field. ## -remarks ## -examples ## -see-also [AddBooleanArray(String, Boolean[], LoggingFieldFormat)](loggingfields_addbooleanarray_542220485.md), [AddBooleanArray(String, Boolean[], LoggingFieldFormat, Int32)](loggingfields_addbooleanarray_93428475.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray(System.String,System.Boolean[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray + +## -description +Adds a boolean array field with the specified field name. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddBooleanArray(String, Boolean[], LoggingFieldFormat)](loggingfields_addbooleanarray_542220485.md), [AddBooleanArray(String, Boolean[], LoggingFieldFormat, Int32)](loggingfields_addbooleanarray_93428475.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addbooleanarray_542220485.md b/windows.foundation.diagnostics/loggingfields_addbooleanarray_542220485.md index bd9afd2294..e0753d8384 100644 --- a/windows.foundation.diagnostics/loggingfields_addbooleanarray_542220485.md +++ b/windows.foundation.diagnostics/loggingfields_addbooleanarray_542220485.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray(System.String,System.Boolean[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray ## -description Adds a boolean array field with the specified field name and format. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddBooleanArray(String, Boolean[])](loggingfields_addbooleanarray_1862884831.md), [AddBooleanArray(String, Boolean[], LoggingFieldFormat, Int32)](loggingfields_addbooleanarray_93428475.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray(System.String,System.Boolean[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray + +## -description +Adds a boolean array field with the specified field name and format. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddBooleanArray(String, Boolean[])](loggingfields_addbooleanarray_1862884831.md), [AddBooleanArray(String, Boolean[], LoggingFieldFormat, Int32)](loggingfields_addbooleanarray_93428475.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addbooleanarray_93428475.md b/windows.foundation.diagnostics/loggingfields_addbooleanarray_93428475.md index fa38c739a2..3d1ab8a49e 100644 --- a/windows.foundation.diagnostics/loggingfields_addbooleanarray_93428475.md +++ b/windows.foundation.diagnostics/loggingfields_addbooleanarray_93428475.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray(System.String,System.Boolean[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray ## -description Adds a boolean array field with the specified field name, format, and tag. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddBooleanArray(String, Boolean[])](loggingfields_addbooleanarray_1862884831.md), [AddBooleanArray(String, Boolean[], LoggingFieldFormat)](loggingfields_addbooleanarray_542220485.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray(System.String,System.Boolean[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddBooleanArray + +## -description +Adds a boolean array field with the specified field name, format, and tag. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddBooleanArray(String, Boolean[])](loggingfields_addbooleanarray_1862884831.md), [AddBooleanArray(String, Boolean[], LoggingFieldFormat)](loggingfields_addbooleanarray_542220485.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addchar16_1600760804.md b/windows.foundation.diagnostics/loggingfields_addchar16_1600760804.md index d25b97cbb9..c3040b4dfb 100644 --- a/windows.foundation.diagnostics/loggingfields_addchar16_1600760804.md +++ b/windows.foundation.diagnostics/loggingfields_addchar16_1600760804.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16(System.String,System.Char) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddChar16 ## -description Adds a 16-bit character field with the specified field name. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ## -remarks ## -examples ## -see-also [AddChar16(String, Char, LoggingFieldFormat)](loggingfields_addchar16_271668992.md), [AddChar16(String, Char, LoggingFieldFormat, Int32)](loggingfields_addchar16_905014464.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16(System.String,System.Char) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddChar16 + +## -description +Adds a 16-bit character field with the specified field name. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddChar16(String, Char, LoggingFieldFormat)](loggingfields_addchar16_271668992.md), [AddChar16(String, Char, LoggingFieldFormat, Int32)](loggingfields_addchar16_905014464.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addchar16_271668992.md b/windows.foundation.diagnostics/loggingfields_addchar16_271668992.md index f135971beb..4070083c8f 100644 --- a/windows.foundation.diagnostics/loggingfields_addchar16_271668992.md +++ b/windows.foundation.diagnostics/loggingfields_addchar16_271668992.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16(System.String,System.Char,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddChar16 ## -description Adds a 16-bit character field with the specified field name and format. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddChar16(String, Char)](loggingfields_addchar16_1600760804.md), [AddChar16(String, Char, LoggingFieldFormat, Int32)](loggingfields_addchar16_905014464.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16(System.String,System.Char,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddChar16 + +## -description +Adds a 16-bit character field with the specified field name and format. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddChar16(String, Char)](loggingfields_addchar16_1600760804.md), [AddChar16(String, Char, LoggingFieldFormat, Int32)](loggingfields_addchar16_905014464.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addchar16_905014464.md b/windows.foundation.diagnostics/loggingfields_addchar16_905014464.md index e725722a34..d73b698a11 100644 --- a/windows.foundation.diagnostics/loggingfields_addchar16_905014464.md +++ b/windows.foundation.diagnostics/loggingfields_addchar16_905014464.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16(System.String,System.Char,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddChar16 ## -description Adds a 16-bit character field with the specified field name, format, and tag. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddChar16(String, Char)](loggingfields_addchar16_1600760804.md), [AddChar16(String, Char, LoggingFieldFormat)](loggingfields_addchar16_271668992.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16(System.String,System.Char,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddChar16 + +## -description +Adds a 16-bit character field with the specified field name, format, and tag. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddChar16(String, Char)](loggingfields_addchar16_1600760804.md), [AddChar16(String, Char, LoggingFieldFormat)](loggingfields_addchar16_271668992.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addchar16array_1714034872.md b/windows.foundation.diagnostics/loggingfields_addchar16array_1714034872.md index 02162f8da8..445a958ff0 100644 --- a/windows.foundation.diagnostics/loggingfields_addchar16array_1714034872.md +++ b/windows.foundation.diagnostics/loggingfields_addchar16array_1714034872.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array(System.String,System.Char[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array ## -description Adds a 16-bit character array field with the specified field name. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ## -remarks ## -examples ## -see-also [AddChar16Array(String, Char[], LoggingFieldFormat)](loggingfields_addchar16array_695395748.md), [AddChar16Array(String, Char[], LoggingFieldFormat, Int32)](loggingfields_addchar16array_213049244.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array(System.String,System.Char[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array + +## -description +Adds a 16-bit character array field with the specified field name. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddChar16Array(String, Char[], LoggingFieldFormat)](loggingfields_addchar16array_695395748.md), [AddChar16Array(String, Char[], LoggingFieldFormat, Int32)](loggingfields_addchar16array_213049244.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addchar16array_213049244.md b/windows.foundation.diagnostics/loggingfields_addchar16array_213049244.md index a9eeeba622..ab54838831 100644 --- a/windows.foundation.diagnostics/loggingfields_addchar16array_213049244.md +++ b/windows.foundation.diagnostics/loggingfields_addchar16array_213049244.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array(System.String,System.Char[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array ## -description Adds a 16-bit character array field with the specified field name and format, and tags. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddChar16Array(String, Char[])](loggingfields_addchar16array_1714034872.md), [AddChar16Array(String, Char[], LoggingFieldFormat)](loggingfields_addchar16array_695395748.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array(System.String,System.Char[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array + +## -description +Adds a 16-bit character array field with the specified field name and format, and tags. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddChar16Array(String, Char[])](loggingfields_addchar16array_1714034872.md), [AddChar16Array(String, Char[], LoggingFieldFormat)](loggingfields_addchar16array_695395748.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addchar16array_695395748.md b/windows.foundation.diagnostics/loggingfields_addchar16array_695395748.md index 50f973b318..f7b5922a9b 100644 --- a/windows.foundation.diagnostics/loggingfields_addchar16array_695395748.md +++ b/windows.foundation.diagnostics/loggingfields_addchar16array_695395748.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array(System.String,System.Char[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array ## -description Adds a 16-bit character array field with the specified field name and format. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddChar16Array(String, Char[])](loggingfields_addchar16array_1714034872.md), [AddChar16Array(String, Char[], LoggingFieldFormat, Int32)](loggingfields_addchar16array_213049244.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array(System.String,System.Char[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddChar16Array + +## -description +Adds a 16-bit character array field with the specified field name and format. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddChar16Array(String, Char[])](loggingfields_addchar16array_1714034872.md), [AddChar16Array(String, Char[], LoggingFieldFormat, Int32)](loggingfields_addchar16array_213049244.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddatetime_1251332688.md b/windows.foundation.diagnostics/loggingfields_adddatetime_1251332688.md index a1e3842741..5840f220f1 100644 --- a/windows.foundation.diagnostics/loggingfields_adddatetime_1251332688.md +++ b/windows.foundation.diagnostics/loggingfields_adddatetime_1251332688.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTime(System.String,Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDateTime ## -description Adds a [DateTime](../windows.foundation/datetime.md) field with the specified field name. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ## -remarks ## -examples ## -see-also [AddDateTime(String, DateTime, LoggingFieldFormat)](loggingfields_adddatetime_97333076.md), [AddDateTime(String, DateTime, LoggingFieldFormat, Int32)](loggingfields_adddatetime_537728364.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTime(System.String,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDateTime + +## -description +Adds a [DateTime](../windows.foundation/datetime.md) field with the specified field name. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddDateTime(String, DateTime, LoggingFieldFormat)](loggingfields_adddatetime_97333076.md), [AddDateTime(String, DateTime, LoggingFieldFormat, Int32)](loggingfields_adddatetime_537728364.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddatetime_537728364.md b/windows.foundation.diagnostics/loggingfields_adddatetime_537728364.md index f8944267f0..42781b8f50 100644 --- a/windows.foundation.diagnostics/loggingfields_adddatetime_537728364.md +++ b/windows.foundation.diagnostics/loggingfields_adddatetime_537728364.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTime(System.String,Windows.Foundation.DateTime,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDateTime ## -description Adds a [DateTime](../windows.foundation/datetime.md) field with the specified field name, format, and tags. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddDateTime(String, DateTime)](loggingfields_adddatetime_1251332688.md), [AddDateTime(String, DateTime, LoggingFieldFormat)](loggingfields_adddatetime_97333076.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTime(System.String,Windows.Foundation.DateTime,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDateTime + +## -description +Adds a [DateTime](../windows.foundation/datetime.md) field with the specified field name, format, and tags. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddDateTime(String, DateTime)](loggingfields_adddatetime_1251332688.md), [AddDateTime(String, DateTime, LoggingFieldFormat)](loggingfields_adddatetime_97333076.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddatetime_97333076.md b/windows.foundation.diagnostics/loggingfields_adddatetime_97333076.md index c9a015a609..ffb8bf6254 100644 --- a/windows.foundation.diagnostics/loggingfields_adddatetime_97333076.md +++ b/windows.foundation.diagnostics/loggingfields_adddatetime_97333076.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTime(System.String,Windows.Foundation.DateTime,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDateTime ## -description Adds a [DateTime](../windows.foundation/datetime.md) field with the specified field name and format. ## -parameters ### -param name The name of the event field. ### -param value The value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddDateTime(String, DateTime)](loggingfields_adddatetime_1251332688.md), [AddDateTime(String, DateTime, LoggingFieldFormat, Int32)](loggingfields_adddatetime_537728364.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTime(System.String,Windows.Foundation.DateTime,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDateTime + +## -description +Adds a [DateTime](../windows.foundation/datetime.md) field with the specified field name and format. + +## -parameters +### -param name +The name of the event field. + +### -param value +The value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddDateTime(String, DateTime)](loggingfields_adddatetime_1251332688.md), [AddDateTime(String, DateTime, LoggingFieldFormat, Int32)](loggingfields_adddatetime_537728364.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddatetimearray_1346784142.md b/windows.foundation.diagnostics/loggingfields_adddatetimearray_1346784142.md index 41c2b24b0c..200918ea84 100644 --- a/windows.foundation.diagnostics/loggingfields_adddatetimearray_1346784142.md +++ b/windows.foundation.diagnostics/loggingfields_adddatetimearray_1346784142.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray(System.String,Windows.Foundation.DateTime[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray ## -description Adds a [DateTime](../windows.foundation/datetime.md) array field with the specified field name, format, and tags. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddDateTimeArray(String, DateTime[])](loggingfields_adddatetimearray_987663530.md), [AddDateTimeArray(String, DateTime[], LoggingFieldFormat)](loggingfields_adddatetimearray_1971745202.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray(System.String,Windows.Foundation.DateTime[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray + +## -description +Adds a [DateTime](../windows.foundation/datetime.md) array field with the specified field name, format, and tags. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddDateTimeArray(String, DateTime[])](loggingfields_adddatetimearray_987663530.md), [AddDateTimeArray(String, DateTime[], LoggingFieldFormat)](loggingfields_adddatetimearray_1971745202.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddatetimearray_1971745202.md b/windows.foundation.diagnostics/loggingfields_adddatetimearray_1971745202.md index 3b4e9edfcb..a5ee269ebf 100644 --- a/windows.foundation.diagnostics/loggingfields_adddatetimearray_1971745202.md +++ b/windows.foundation.diagnostics/loggingfields_adddatetimearray_1971745202.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray(System.String,Windows.Foundation.DateTime[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray ## -description Adds a [DateTime](../windows.foundation/datetime.md) array field with the specified field name and format. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddDateTimeArray(String, DateTime[])](loggingfields_adddatetimearray_987663530.md), [AddDateTimeArray(String, DateTime[], LoggingFieldFormat, Int32)](loggingfields_adddatetimearray_1346784142.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray(System.String,Windows.Foundation.DateTime[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray + +## -description +Adds a [DateTime](../windows.foundation/datetime.md) array field with the specified field name and format. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddDateTimeArray(String, DateTime[])](loggingfields_adddatetimearray_987663530.md), [AddDateTimeArray(String, DateTime[], LoggingFieldFormat, Int32)](loggingfields_adddatetimearray_1346784142.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddatetimearray_987663530.md b/windows.foundation.diagnostics/loggingfields_adddatetimearray_987663530.md index a7300e20a3..93aeae18ed 100644 --- a/windows.foundation.diagnostics/loggingfields_adddatetimearray_987663530.md +++ b/windows.foundation.diagnostics/loggingfields_adddatetimearray_987663530.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray(System.String,Windows.Foundation.DateTime[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray ## -description Adds a [DateTime](../windows.foundation/datetime.md) array field with the specified field name. ## -parameters ### -param name The name of the event field. ### -param value The array of values for the event field. ## -remarks ## -examples ## -see-also [AddDateTimeArray(String, DateTime[], LoggingFieldFormat)](loggingfields_adddatetimearray_1971745202.md), [AddDateTimeArray(String, DateTime[], LoggingFieldFormat, Int32)](loggingfields_adddatetimearray_1346784142.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray(System.String,Windows.Foundation.DateTime[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDateTimeArray + +## -description +Adds a [DateTime](../windows.foundation/datetime.md) array field with the specified field name. + +## -parameters +### -param name +The name of the event field. + +### -param value +The array of values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddDateTimeArray(String, DateTime[], LoggingFieldFormat)](loggingfields_adddatetimearray_1971745202.md), [AddDateTimeArray(String, DateTime[], LoggingFieldFormat, Int32)](loggingfields_adddatetimearray_1346784142.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddouble_1347352172.md b/windows.foundation.diagnostics/loggingfields_adddouble_1347352172.md index 33a0668e76..8929de6ba8 100644 --- a/windows.foundation.diagnostics/loggingfields_adddouble_1347352172.md +++ b/windows.foundation.diagnostics/loggingfields_adddouble_1347352172.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDouble(System.String,System.Double,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDouble ## -description Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddDouble(String, Double)](loggingfields_adddouble_987115848.md), [AddDouble(String, Double, LoggingFieldFormat)](loggingfields_adddouble_1972292692.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDouble(System.String,System.Double,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDouble + +## -description +Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddDouble(String, Double)](loggingfields_adddouble_987115848.md), [AddDouble(String, Double, LoggingFieldFormat)](loggingfields_adddouble_1972292692.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddouble_1972292692.md b/windows.foundation.diagnostics/loggingfields_adddouble_1972292692.md index 94ed940473..14f3252f04 100644 --- a/windows.foundation.diagnostics/loggingfields_adddouble_1972292692.md +++ b/windows.foundation.diagnostics/loggingfields_adddouble_1972292692.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDouble(System.String,System.Double,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDouble ## -description Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddDouble(String, Double)](loggingfields_adddouble_987115848.md), [AddDouble(String, Double, LoggingFieldFormat, Int32)](loggingfields_adddouble_1347352172.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDouble(System.String,System.Double,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDouble + +## -description +Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddDouble(String, Double)](loggingfields_adddouble_987115848.md), [AddDouble(String, Double, LoggingFieldFormat, Int32)](loggingfields_adddouble_1347352172.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddouble_987115848.md b/windows.foundation.diagnostics/loggingfields_adddouble_987115848.md index ee8c18909e..fbce162a64 100644 --- a/windows.foundation.diagnostics/loggingfields_adddouble_987115848.md +++ b/windows.foundation.diagnostics/loggingfields_adddouble_987115848.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDouble(System.String,System.Double) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDouble ## -description Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ## -remarks ## -examples ## -see-also [AddDouble(String, Double, LoggingFieldFormat)](loggingfields_adddouble_1972292692.md), [AddDouble(String, Double, LoggingFieldFormat, Int32)](loggingfields_adddouble_1347352172.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDouble(System.String,System.Double) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDouble + +## -description +Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddDouble(String, Double, LoggingFieldFormat)](loggingfields_adddouble_1972292692.md), [AddDouble(String, Double, LoggingFieldFormat, Int32)](loggingfields_adddouble_1347352172.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddoublearray_1358881234.md b/windows.foundation.diagnostics/loggingfields_adddoublearray_1358881234.md index 01e08a5261..fa3622a466 100644 --- a/windows.foundation.diagnostics/loggingfields_adddoublearray_1358881234.md +++ b/windows.foundation.diagnostics/loggingfields_adddoublearray_1358881234.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray(System.String,System.Double[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray ## -description Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddDoubleArray(String, Double[])](loggingfields_adddoublearray_979773174.md), [AddDoubleArray(String, Double[], LoggingFieldFormat)](loggingfields_adddoublearray_1967053806.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray(System.String,System.Double[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray + +## -description +Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddDoubleArray(String, Double[])](loggingfields_adddoublearray_979773174.md), [AddDoubleArray(String, Double[], LoggingFieldFormat)](loggingfields_adddoublearray_1967053806.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddoublearray_1967053806.md b/windows.foundation.diagnostics/loggingfields_adddoublearray_1967053806.md index aad6298f31..3e28a963ae 100644 --- a/windows.foundation.diagnostics/loggingfields_adddoublearray_1967053806.md +++ b/windows.foundation.diagnostics/loggingfields_adddoublearray_1967053806.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray(System.String,System.Double[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray ## -description Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The array of values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddDoubleArray(String, Double[])](loggingfields_adddoublearray_979773174.md), [AddDoubleArray(String, Double[], LoggingFieldFormat, Int32)](loggingfields_adddoublearray_1358881234.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray(System.String,System.Double[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray + +## -description +Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array of values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddDoubleArray(String, Double[])](loggingfields_adddoublearray_979773174.md), [AddDoubleArray(String, Double[], LoggingFieldFormat, Int32)](loggingfields_adddoublearray_1358881234.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adddoublearray_979773174.md b/windows.foundation.diagnostics/loggingfields_adddoublearray_979773174.md index cd6d81b6b0..68bb396081 100644 --- a/windows.foundation.diagnostics/loggingfields_adddoublearray_979773174.md +++ b/windows.foundation.diagnostics/loggingfields_adddoublearray_979773174.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray(System.String,System.Double[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray ## -description Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The array of values for the event field. ## -remarks ## -examples ## -see-also [AddDoubleArray(String, Double[], LoggingFieldFormat)](loggingfields_adddoublearray_1967053806.md), [AddDoubleArray(String, Double[], LoggingFieldFormat, Int32)](loggingfields_adddoublearray_1358881234.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray(System.String,System.Double[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddDoubleArray + +## -description +Adds a [Double](https://msdn.microsoft.com/library/system.double.aspx) array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array of values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddDoubleArray(String, Double[], LoggingFieldFormat)](loggingfields_adddoublearray_1967053806.md), [AddDoubleArray(String, Double[], LoggingFieldFormat, Int32)](loggingfields_adddoublearray_1358881234.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addempty_1436732370.md b/windows.foundation.diagnostics/loggingfields_addempty_1436732370.md index fe8e9afff6..16e1be52af 100644 --- a/windows.foundation.diagnostics/loggingfields_addempty_1436732370.md +++ b/windows.foundation.diagnostics/loggingfields_addempty_1436732370.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddEmpty(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddEmpty ## -description Adds an empty field. ## -parameters ### -param name Name of the event field. ## -remarks An empty field has a name, optional format and tags, but no value. ## -examples ## -see-also [AddEmpty(String, LoggingFieldFormat)](loggingfields_addempty_233917088.md), [AddEmpty(String, LoggingFieldFormat, Int32)](loggingfields_addempty_1626253376.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddEmpty(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddEmpty + +## -description +Adds an empty field. + +## -parameters +### -param name +Name of the event field. + +## -remarks +An empty field has a name, optional format and tags, but no value. + +## -examples + +## -see-also +[AddEmpty(String, LoggingFieldFormat)](loggingfields_addempty_233917088.md), [AddEmpty(String, LoggingFieldFormat, Int32)](loggingfields_addempty_1626253376.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addempty_1626253376.md b/windows.foundation.diagnostics/loggingfields_addempty_1626253376.md index 25b4604fda..ea482f9501 100644 --- a/windows.foundation.diagnostics/loggingfields_addempty_1626253376.md +++ b/windows.foundation.diagnostics/loggingfields_addempty_1626253376.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddEmpty(System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddEmpty ## -description Adds an empty field. ## -parameters ### -param name Name of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddEmpty(String)](loggingfields_addempty_1436732370.md), [AddEmpty(String, LoggingFieldFormat)](loggingfields_addempty_233917088.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddEmpty(System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddEmpty + +## -description +Adds an empty field. + +## -parameters +### -param name +Name of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddEmpty(String)](loggingfields_addempty_1436732370.md), [AddEmpty(String, LoggingFieldFormat)](loggingfields_addempty_233917088.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addempty_233917088.md b/windows.foundation.diagnostics/loggingfields_addempty_233917088.md index f0c4c3a9f5..861d609691 100644 --- a/windows.foundation.diagnostics/loggingfields_addempty_233917088.md +++ b/windows.foundation.diagnostics/loggingfields_addempty_233917088.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddEmpty(System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddEmpty ## -description Adds an empty field. ## -parameters ### -param name Name of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddEmpty(String)](loggingfields_addempty_1436732370.md), [AddEmpty(String, LoggingFieldFormat, Int32)](loggingfields_addempty_1626253376.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddEmpty(System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddEmpty + +## -description +Adds an empty field. + +## -parameters +### -param name +Name of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddEmpty(String)](loggingfields_addempty_1436732370.md), [AddEmpty(String, LoggingFieldFormat, Int32)](loggingfields_addempty_1626253376.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addguid_1099287122.md b/windows.foundation.diagnostics/loggingfields_addguid_1099287122.md index 981188f0fa..c9b75ee61a 100644 --- a/windows.foundation.diagnostics/loggingfields_addguid_1099287122.md +++ b/windows.foundation.diagnostics/loggingfields_addguid_1099287122.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuid(System.String,System.Guid,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddGuid ## -description Adds a GUID field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddGuid(String, Guid)](loggingfields_addguid_723324278.md), [AddGuid(String, Guid, LoggingFieldFormat)](loggingfields_addguid_1682305134.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuid(System.String,System.Guid,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddGuid + +## -description +Adds a GUID field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddGuid(String, Guid)](loggingfields_addguid_723324278.md), [AddGuid(String, Guid, LoggingFieldFormat)](loggingfields_addguid_1682305134.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addguid_1682305134.md b/windows.foundation.diagnostics/loggingfields_addguid_1682305134.md index 111cfb0f98..7966a14fdf 100644 --- a/windows.foundation.diagnostics/loggingfields_addguid_1682305134.md +++ b/windows.foundation.diagnostics/loggingfields_addguid_1682305134.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuid(System.String,System.Guid,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddGuid ## -description Adds a GUID field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddGuid(String, Guid)](loggingfields_addguid_723324278.md), [AddGuid(String, Guid, LoggingFieldFormat, Int32)](loggingfields_addguid_1099287122.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuid(System.String,System.Guid,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddGuid + +## -description +Adds a GUID field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddGuid(String, Guid)](loggingfields_addguid_723324278.md), [AddGuid(String, Guid, LoggingFieldFormat, Int32)](loggingfields_addguid_1099287122.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addguid_723324278.md b/windows.foundation.diagnostics/loggingfields_addguid_723324278.md index 969c7ea3b6..b6a79501df 100644 --- a/windows.foundation.diagnostics/loggingfields_addguid_723324278.md +++ b/windows.foundation.diagnostics/loggingfields_addguid_723324278.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuid(System.String,System.Guid) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddGuid ## -description Adds a GUID field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ## -remarks ## -examples ## -see-also [AddGuid(String, Guid, LoggingFieldFormat)](loggingfields_addguid_1682305134.md), [AddGuid(String, Guid, LoggingFieldFormat, Int32)](loggingfields_addguid_1099287122.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuid(System.String,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddGuid + +## -description +Adds a GUID field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddGuid(String, Guid, LoggingFieldFormat)](loggingfields_addguid_1682305134.md), [AddGuid(String, Guid, LoggingFieldFormat, Int32)](loggingfields_addguid_1099287122.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addguidarray_1097650446.md b/windows.foundation.diagnostics/loggingfields_addguidarray_1097650446.md index f5e8a0766c..c7505a44a3 100644 --- a/windows.foundation.diagnostics/loggingfields_addguidarray_1097650446.md +++ b/windows.foundation.diagnostics/loggingfields_addguidarray_1097650446.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray(System.String,System.Guid[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray ## -description Adds a GUID array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddGuidArray(String, Guid[])](loggingfields_addguidarray_737416746.md), [AddGuidArray(String, Guid[], LoggingFieldFormat)](loggingfields_addguidarray_1689054002.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray(System.String,System.Guid[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray + +## -description +Adds a GUID array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddGuidArray(String, Guid[])](loggingfields_addguidarray_737416746.md), [AddGuidArray(String, Guid[], LoggingFieldFormat)](loggingfields_addguidarray_1689054002.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addguidarray_1689054002.md b/windows.foundation.diagnostics/loggingfields_addguidarray_1689054002.md index 1e03ccfbdb..f252bd7098 100644 --- a/windows.foundation.diagnostics/loggingfields_addguidarray_1689054002.md +++ b/windows.foundation.diagnostics/loggingfields_addguidarray_1689054002.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray(System.String,System.Guid[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray ## -description Adds a GUID array field with the specified field name and format ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. ## -remarks ## -examples ## -see-also [AddGuidArray(String, Guid[])](loggingfields_addguidarray_737416746.md), [AddGuidArray(String, Guid[], LoggingFieldFormat, Int32)](loggingfields_addguidarray_1097650446.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray(System.String,System.Guid[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray + +## -description +Adds a GUID array field with the specified field name and format + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. + +## -remarks + +## -examples + +## -see-also +[AddGuidArray(String, Guid[])](loggingfields_addguidarray_737416746.md), [AddGuidArray(String, Guid[], LoggingFieldFormat, Int32)](loggingfields_addguidarray_1097650446.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addguidarray_737416746.md b/windows.foundation.diagnostics/loggingfields_addguidarray_737416746.md index 321406f754..b2914f865b 100644 --- a/windows.foundation.diagnostics/loggingfields_addguidarray_737416746.md +++ b/windows.foundation.diagnostics/loggingfields_addguidarray_737416746.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray(System.String,System.Guid[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray ## -description Adds a GUID array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ## -remarks ## -examples ## -see-also [AddGuidArray(String, Guid[], LoggingFieldFormat)](loggingfields_addguidarray_1689054002.md), [AddGuidArray(String, Guid[], LoggingFieldFormat, Int32)](loggingfields_addguidarray_1097650446.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray(System.String,System.Guid[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddGuidArray + +## -description +Adds a GUID array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddGuidArray(String, Guid[], LoggingFieldFormat)](loggingfields_addguidarray_1689054002.md), [AddGuidArray(String, Guid[], LoggingFieldFormat, Int32)](loggingfields_addguidarray_1097650446.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint16_1372865658.md b/windows.foundation.diagnostics/loggingfields_addint16_1372865658.md index 48b838bc4b..dcaf536143 100644 --- a/windows.foundation.diagnostics/loggingfields_addint16_1372865658.md +++ b/windows.foundation.diagnostics/loggingfields_addint16_1372865658.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16(System.String,System.Int16,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt16 ## -description Adds a 16-bit integer field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddInt16(String, Int16)](loggingfields_addint16_512538978.md), [AddInt16(String, Int16, LoggingFieldFormat, Int32)](loggingfields_addint16_1947500102.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16(System.String,System.Int16,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt16 + +## -description +Adds a 16-bit integer field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddInt16(String, Int16)](loggingfields_addint16_512538978.md), [AddInt16(String, Int16, LoggingFieldFormat, Int32)](loggingfields_addint16_1947500102.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint16_1947500102.md b/windows.foundation.diagnostics/loggingfields_addint16_1947500102.md index a1697d5dfa..e5315b4fdc 100644 --- a/windows.foundation.diagnostics/loggingfields_addint16_1947500102.md +++ b/windows.foundation.diagnostics/loggingfields_addint16_1947500102.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16(System.String,System.Int16,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt16 ## -description Adds a 16-bit integer field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddInt16(String, Int16)](loggingfields_addint16_512538978.md), [AddInt16(String, Int16, LoggingFieldFormat)](loggingfields_addint16_1372865658.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16(System.String,System.Int16,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt16 + +## -description +Adds a 16-bit integer field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddInt16(String, Int16)](loggingfields_addint16_512538978.md), [AddInt16(String, Int16, LoggingFieldFormat)](loggingfields_addint16_1372865658.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint16_512538978.md b/windows.foundation.diagnostics/loggingfields_addint16_512538978.md index 762c0cc2f3..e679d38970 100644 --- a/windows.foundation.diagnostics/loggingfields_addint16_512538978.md +++ b/windows.foundation.diagnostics/loggingfields_addint16_512538978.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16(System.String,System.Int16) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt16 ## -description Adds a 16-bit integer field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ## -remarks ## -examples ## -see-also [AddInt16(String, Int16, LoggingFieldFormat)](loggingfields_addint16_1372865658.md), [AddInt16(String, Int16, LoggingFieldFormat, Int32)](loggingfields_addint16_1947500102.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16(System.String,System.Int16) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt16 + +## -description +Adds a 16-bit integer field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddInt16(String, Int16, LoggingFieldFormat)](loggingfields_addint16_1372865658.md), [AddInt16(String, Int16, LoggingFieldFormat, Int32)](loggingfields_addint16_1947500102.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint16array_1566530932.md b/windows.foundation.diagnostics/loggingfields_addint16array_1566530932.md index f2bd7f8ee7..a77fd280eb 100644 --- a/windows.foundation.diagnostics/loggingfields_addint16array_1566530932.md +++ b/windows.foundation.diagnostics/loggingfields_addint16array_1566530932.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array(System.String,System.Int16[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array ## -description Adds a 16-bit integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ## -remarks ## -examples ## -see-also [AddInt16Array(String, Int16[], LoggingFieldFormat)](loggingfields_addint16array_302489712.md), [AddInt16Array(String, Int16[], LoggingFieldFormat, Int32)](loggingfields_addint16array_935828048.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array(System.String,System.Int16[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array + +## -description +Adds a 16-bit integer array field with the specified field name. + + + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddInt16Array(String, Int16[], LoggingFieldFormat)](loggingfields_addint16array_302489712.md), [AddInt16Array(String, Int16[], LoggingFieldFormat, Int32)](loggingfields_addint16array_935828048.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint16array_302489712.md b/windows.foundation.diagnostics/loggingfields_addint16array_302489712.md index 9446871196..fbb24405cc 100644 --- a/windows.foundation.diagnostics/loggingfields_addint16array_302489712.md +++ b/windows.foundation.diagnostics/loggingfields_addint16array_302489712.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array(System.String,System.Int16[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array ## -description Adds a 16-bit integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddInt16Array(String, Int16[])](loggingfields_addint16array_1566530932.md), [AddInt16Array(String, Int16[], LoggingFieldFormat, Int32)](loggingfields_addint16array_935828048.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array(System.String,System.Int16[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array + +## -description +Adds a 16-bit integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddInt16Array(String, Int16[])](loggingfields_addint16array_1566530932.md), [AddInt16Array(String, Int16[], LoggingFieldFormat, Int32)](loggingfields_addint16array_935828048.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint16array_935828048.md b/windows.foundation.diagnostics/loggingfields_addint16array_935828048.md index dc954c355f..05a71a534c 100644 --- a/windows.foundation.diagnostics/loggingfields_addint16array_935828048.md +++ b/windows.foundation.diagnostics/loggingfields_addint16array_935828048.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array(System.String,System.Int16[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array ## -description Adds a 16-bit integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddInt16Array(String, Int16[])](loggingfields_addint16array_1566530932.md), [AddInt16Array(String, Int16[], LoggingFieldFormat)](loggingfields_addint16array_302489712.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array(System.String,System.Int16[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt16Array + +## -description +Adds a 16-bit integer array field with the specified field name, format, and tags. + + + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddInt16Array(String, Int16[])](loggingfields_addint16array_1566530932.md), [AddInt16Array(String, Int16[], LoggingFieldFormat)](loggingfields_addint16array_302489712.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint32_1380222736.md b/windows.foundation.diagnostics/loggingfields_addint32_1380222736.md index d716d907bd..4937240ce9 100644 --- a/windows.foundation.diagnostics/loggingfields_addint32_1380222736.md +++ b/windows.foundation.diagnostics/loggingfields_addint32_1380222736.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt32 ## -description Adds a 32-bit integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddInt32(String, Int32)](loggingfields_addint32_953958444.md), [AddInt32(String, Int32, LoggingFieldFormat)](loggingfields_addint32_2005187888.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt32 + +## -description +Adds a 32-bit integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddInt32(String, Int32)](loggingfields_addint32_953958444.md), [AddInt32(String, Int32, LoggingFieldFormat)](loggingfields_addint32_2005187888.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint32_2005187888.md b/windows.foundation.diagnostics/loggingfields_addint32_2005187888.md index d19afbe898..3416bf9624 100644 --- a/windows.foundation.diagnostics/loggingfields_addint32_2005187888.md +++ b/windows.foundation.diagnostics/loggingfields_addint32_2005187888.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt32 ## -description Adds a 32-bit integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddInt32(String, Int32)](loggingfields_addint32_953958444.md), [AddInt32(String, Int32, LoggingFieldFormat, Int32)](loggingfields_addint32_1380222736.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32(System.String,System.Int32,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt32 + +## -description +Adds a 32-bit integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddInt32(String, Int32)](loggingfields_addint32_953958444.md), [AddInt32(String, Int32, LoggingFieldFormat, Int32)](loggingfields_addint32_1380222736.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint32_953958444.md b/windows.foundation.diagnostics/loggingfields_addint32_953958444.md index 9e22ff4c56..4c2dfccd38 100644 --- a/windows.foundation.diagnostics/loggingfields_addint32_953958444.md +++ b/windows.foundation.diagnostics/loggingfields_addint32_953958444.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32(System.String,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt32 ## -description Adds a 32-bit integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value Value of the event field. ## -remarks ## -examples ## -see-also [AddInt32(String, Int32, LoggingFieldFormat)](loggingfields_addint32_2005187888.md), [AddInt32(String, Int32, LoggingFieldFormat, Int32)](loggingfields_addint32_1380222736.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32(System.String,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt32 + +## -description +Adds a 32-bit integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +Value of the event field. + +## -remarks + +## -examples + +## -see-also +[AddInt32(String, Int32, LoggingFieldFormat)](loggingfields_addint32_2005187888.md), [AddInt32(String, Int32, LoggingFieldFormat, Int32)](loggingfields_addint32_1380222736.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint32array_1517435994.md b/windows.foundation.diagnostics/loggingfields_addint32array_1517435994.md index 8b9b6570a0..94ce8413f7 100644 --- a/windows.foundation.diagnostics/loggingfields_addint32array_1517435994.md +++ b/windows.foundation.diagnostics/loggingfields_addint32array_1517435994.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array(System.String,System.Int32[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array ## -description Adds a 32-bit integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddInt32Array(String, Int32[])](loggingfields_addint32array_355123522.md), [AddInt32Array(String, Int32[], LoggingFieldFormat, Int32)](loggingfields_addint32array_2142373478.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array(System.String,System.Int32[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array + +## -description +Adds a 32-bit integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddInt32Array(String, Int32[])](loggingfields_addint32array_355123522.md), [AddInt32Array(String, Int32[], LoggingFieldFormat, Int32)](loggingfields_addint32array_2142373478.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint32array_2142373478.md b/windows.foundation.diagnostics/loggingfields_addint32array_2142373478.md index d47e369c25..f962d927d8 100644 --- a/windows.foundation.diagnostics/loggingfields_addint32array_2142373478.md +++ b/windows.foundation.diagnostics/loggingfields_addint32array_2142373478.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array(System.String,System.Int32[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array ## -description Adds a 32-bit integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddInt32Array(String, Int32[])](loggingfields_addint32array_355123522.md), [AddInt32Array(String, Int32[], LoggingFieldFormat)](loggingfields_addint32array_1517435994.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array(System.String,System.Int32[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array + +## -description +Adds a 32-bit integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddInt32Array(String, Int32[])](loggingfields_addint32array_355123522.md), [AddInt32Array(String, Int32[], LoggingFieldFormat)](loggingfields_addint32array_1517435994.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint32array_355123522.md b/windows.foundation.diagnostics/loggingfields_addint32array_355123522.md index ef2e901ace..fcc112c937 100644 --- a/windows.foundation.diagnostics/loggingfields_addint32array_355123522.md +++ b/windows.foundation.diagnostics/loggingfields_addint32array_355123522.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array(System.String,System.Int32[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array ## -description Adds a 32-bit integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ## -remarks ## -examples ## -see-also [AddInt32Array(String, Int32[], LoggingFieldFormat)](loggingfields_addint32array_1517435994.md), [AddInt32Array(String, Int32[], LoggingFieldFormat, Int32)](loggingfields_addint32array_2142373478.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array(System.String,System.Int32[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt32Array + +## -description +Adds a 32-bit integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddInt32Array(String, Int32[], LoggingFieldFormat)](loggingfields_addint32array_1517435994.md), [AddInt32Array(String, Int32[], LoggingFieldFormat, Int32)](loggingfields_addint32array_2142373478.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint64_1268498039.md b/windows.foundation.diagnostics/loggingfields_addint64_1268498039.md index 2b1bd83f5c..ff22fdc73c 100644 --- a/windows.foundation.diagnostics/loggingfields_addint64_1268498039.md +++ b/windows.foundation.diagnostics/loggingfields_addint64_1268498039.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64(System.String,System.Int64,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt64 ## -description Adds a 64-bit integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddInt64(String, Int64)](loggingfields_addint64_79905645.md), [AddInt64(String, Int64, LoggingFieldFormat, Int32)](loggingfields_addint64_1851491401.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64(System.String,System.Int64,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt64 + +## -description +Adds a 64-bit integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddInt64(String, Int64)](loggingfields_addint64_79905645.md), [AddInt64(String, Int64, LoggingFieldFormat, Int32)](loggingfields_addint64_1851491401.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint64_1851491401.md b/windows.foundation.diagnostics/loggingfields_addint64_1851491401.md index c1d9f0d043..cf70e85096 100644 --- a/windows.foundation.diagnostics/loggingfields_addint64_1851491401.md +++ b/windows.foundation.diagnostics/loggingfields_addint64_1851491401.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64(System.String,System.Int64,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt64 ## -description Adds a 64-bit integer field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddInt64(String, Int64)](loggingfields_addint64_79905645.md), [AddInt64(String, Int64, LoggingFieldFormat)](loggingfields_addint64_1268498039.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64(System.String,System.Int64,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt64 + +## -description +Adds a 64-bit integer field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddInt64(String, Int64)](loggingfields_addint64_79905645.md), [AddInt64(String, Int64, LoggingFieldFormat)](loggingfields_addint64_1268498039.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint64_79905645.md b/windows.foundation.diagnostics/loggingfields_addint64_79905645.md index 497bda8b6a..3a4e9d0fa6 100644 --- a/windows.foundation.diagnostics/loggingfields_addint64_79905645.md +++ b/windows.foundation.diagnostics/loggingfields_addint64_79905645.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64(System.String,System.Int64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt64 ## -description Adds a 64-bit integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ## -remarks ## -examples ## -see-also [AddInt64(String, Int64, LoggingFieldFormat)](loggingfields_addint64_1268498039.md), [AddInt64(String, Int64, LoggingFieldFormat, Int32)](loggingfields_addint64_1851491401.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64(System.String,System.Int64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt64 + +## -description +Adds a 64-bit integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddInt64(String, Int64, LoggingFieldFormat)](loggingfields_addint64_1268498039.md), [AddInt64(String, Int64, LoggingFieldFormat, Int32)](loggingfields_addint64_1851491401.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint64array_1522553357.md b/windows.foundation.diagnostics/loggingfields_addint64array_1522553357.md index f71099becc..83a8ac96df 100644 --- a/windows.foundation.diagnostics/loggingfields_addint64array_1522553357.md +++ b/windows.foundation.diagnostics/loggingfields_addint64array_1522553357.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array(System.String,System.Int64[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array ## -description Adds a 64-bit integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddInt64Array(String, Int64[])](loggingfields_addint64array_811111721.md), [AddInt64Array(String, Int64[], LoggingFieldFormat)](loggingfields_addint64array_2130733107.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array(System.String,System.Int64[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array + +## -description +Adds a 64-bit integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddInt64Array(String, Int64[])](loggingfields_addint64array_811111721.md), [AddInt64Array(String, Int64[], LoggingFieldFormat)](loggingfields_addint64array_2130733107.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint64array_2130733107.md b/windows.foundation.diagnostics/loggingfields_addint64array_2130733107.md index d363d564d5..9d1bd0f4a2 100644 --- a/windows.foundation.diagnostics/loggingfields_addint64array_2130733107.md +++ b/windows.foundation.diagnostics/loggingfields_addint64array_2130733107.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array(System.String,System.Int64[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array ## -description Adds a 64-bit integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddInt64Array(String, Int64[])](loggingfields_addint64array_811111721.md), [AddInt64Array(String, Int64[], LoggingFieldFormat, Int32)](loggingfields_addint64array_1522553357.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array(System.String,System.Int64[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array + +## -description +Adds a 64-bit integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddInt64Array(String, Int64[])](loggingfields_addint64array_811111721.md), [AddInt64Array(String, Int64[], LoggingFieldFormat, Int32)](loggingfields_addint64array_1522553357.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addint64array_811111721.md b/windows.foundation.diagnostics/loggingfields_addint64array_811111721.md index f98673e968..0ce4d75db0 100644 --- a/windows.foundation.diagnostics/loggingfields_addint64array_811111721.md +++ b/windows.foundation.diagnostics/loggingfields_addint64array_811111721.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array(System.String,System.Int64[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array ## -description Adds a 64-bit integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The array values for the event field. ## -remarks ## -examples ## -see-also [AddInt64Array(String, Int64[], LoggingFieldFormat)](loggingfields_addint64array_2130733107.md), [AddInt64Array(String, Int64[], LoggingFieldFormat, Int32)](loggingfields_addint64array_1522553357.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array(System.String,System.Int64[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddInt64Array + +## -description +Adds a 64-bit integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The array values for the event field. + +## -remarks + +## -examples + +## -see-also +[AddInt64Array(String, Int64[], LoggingFieldFormat)](loggingfields_addint64array_2130733107.md), [AddInt64Array(String, Int64[], LoggingFieldFormat, Int32)](loggingfields_addint64array_1522553357.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addpoint_1384599372.md b/windows.foundation.diagnostics/loggingfields_addpoint_1384599372.md index a68ad3b4a4..a157fa07f8 100644 --- a/windows.foundation.diagnostics/loggingfields_addpoint_1384599372.md +++ b/windows.foundation.diagnostics/loggingfields_addpoint_1384599372.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPoint(System.String,Windows.Foundation.Point) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddPoint ## -description Adds a [Point](../windows.foundation/point.md) field with the specified name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddPoint(String, Point, LoggingFieldFormat)](loggingfields_addpoint_501199440.md), [AddPoint(String, Point, LoggingFieldFormat, Int32)](loggingfields_addpoint_941590640.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPoint(System.String,Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddPoint + +## -description +Adds a [Point](../windows.foundation/point.md) field with the specified name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddPoint(String, Point, LoggingFieldFormat)](loggingfields_addpoint_501199440.md), [AddPoint(String, Point, LoggingFieldFormat, Int32)](loggingfields_addpoint_941590640.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addpoint_501199440.md b/windows.foundation.diagnostics/loggingfields_addpoint_501199440.md index ac7fa2031e..2a0938d282 100644 --- a/windows.foundation.diagnostics/loggingfields_addpoint_501199440.md +++ b/windows.foundation.diagnostics/loggingfields_addpoint_501199440.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPoint(System.String,Windows.Foundation.Point,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddPoint ## -description Adds a [Point](../windows.foundation/point.md) field with the specified name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddPoint(String, Point)](loggingfields_addpoint_1384599372.md), [AddPoint(String, Point, LoggingFieldFormat, Int32)](loggingfields_addpoint_941590640.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPoint(System.String,Windows.Foundation.Point,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddPoint + +## -description +Adds a [Point](../windows.foundation/point.md) field with the specified name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddPoint(String, Point)](loggingfields_addpoint_1384599372.md), [AddPoint(String, Point, LoggingFieldFormat, Int32)](loggingfields_addpoint_941590640.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addpoint_941590640.md b/windows.foundation.diagnostics/loggingfields_addpoint_941590640.md index 524f33044b..55d92d1318 100644 --- a/windows.foundation.diagnostics/loggingfields_addpoint_941590640.md +++ b/windows.foundation.diagnostics/loggingfields_addpoint_941590640.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPoint(System.String,Windows.Foundation.Point,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddPoint ## -description Adds a [Point](../windows.foundation/point.md) field with the specified name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddPoint(String, Point)](loggingfields_addpoint_1384599372.md), [AddPoint(String, Point, LoggingFieldFormat)](loggingfields_addpoint_501199440.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPoint(System.String,Windows.Foundation.Point,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddPoint + +## -description +Adds a [Point](../windows.foundation/point.md) field with the specified name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddPoint(String, Point)](loggingfields_addpoint_1384599372.md), [AddPoint(String, Point, LoggingFieldFormat)](loggingfields_addpoint_501199440.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addpointarray_1381245052.md b/windows.foundation.diagnostics/loggingfields_addpointarray_1381245052.md index 6f3ca44ee7..98588c2fdb 100644 --- a/windows.foundation.diagnostics/loggingfields_addpointarray_1381245052.md +++ b/windows.foundation.diagnostics/loggingfields_addpointarray_1381245052.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPointArray(System.String,Windows.Foundation.Point[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddPointArray ## -description Adds a [Point](../windows.foundation/point.md) array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddPointArray(String, Point[])](loggingfields_addpointarray_487382376.md), [AddPointArray(String, Point[], LoggingFieldFormat, Int32)](loggingfields_addpointarray_2006194756.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPointArray(System.String,Windows.Foundation.Point[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddPointArray + +## -description +Adds a [Point](../windows.foundation/point.md) array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddPointArray(String, Point[])](loggingfields_addpointarray_487382376.md), [AddPointArray(String, Point[], LoggingFieldFormat, Int32)](loggingfields_addpointarray_2006194756.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addpointarray_2006194756.md b/windows.foundation.diagnostics/loggingfields_addpointarray_2006194756.md index 8e59018dd7..dd9ae62c32 100644 --- a/windows.foundation.diagnostics/loggingfields_addpointarray_2006194756.md +++ b/windows.foundation.diagnostics/loggingfields_addpointarray_2006194756.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPointArray(System.String,Windows.Foundation.Point[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddPointArray ## -description Adds a [Point](../windows.foundation/point.md) array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddPointArray(String, Point[])](loggingfields_addpointarray_487382376.md), [AddPointArray(String, Point[], LoggingFieldFormat)](loggingfields_addpointarray_1381245052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPointArray(System.String,Windows.Foundation.Point[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddPointArray + +## -description +Adds a [Point](../windows.foundation/point.md) array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddPointArray(String, Point[])](loggingfields_addpointarray_487382376.md), [AddPointArray(String, Point[], LoggingFieldFormat)](loggingfields_addpointarray_1381245052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addpointarray_487382376.md b/windows.foundation.diagnostics/loggingfields_addpointarray_487382376.md index dba42685c1..767030472e 100644 --- a/windows.foundation.diagnostics/loggingfields_addpointarray_487382376.md +++ b/windows.foundation.diagnostics/loggingfields_addpointarray_487382376.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPointArray(System.String,Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddPointArray ## -description Adds a [Point](../windows.foundation/point.md) array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddPointArray(String, Point[], LoggingFieldFormat)](loggingfields_addpointarray_1381245052.md), [AddPointArray(String, Point[], LoggingFieldFormat, Int32)](loggingfields_addpointarray_2006194756.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddPointArray(System.String,Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddPointArray + +## -description +Adds a [Point](../windows.foundation/point.md) array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddPointArray(String, Point[], LoggingFieldFormat)](loggingfields_addpointarray_1381245052.md), [AddPointArray(String, Point[], LoggingFieldFormat, Int32)](loggingfields_addpointarray_2006194756.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addrect_1299576052.md b/windows.foundation.diagnostics/loggingfields_addrect_1299576052.md index 18327c4e65..6f5c0b0786 100644 --- a/windows.foundation.diagnostics/loggingfields_addrect_1299576052.md +++ b/windows.foundation.diagnostics/loggingfields_addrect_1299576052.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRect(System.String,Windows.Foundation.Rect,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddRect ## -description Adds a [Rect](../windows.foundation/rect.md) field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddRect(String, Rect)](loggingfields_addrect_669856720.md), [AddRect(String, Rect, LoggingFieldFormat)](loggingfields_addrect_1756745420.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRect(System.String,Windows.Foundation.Rect,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddRect + +## -description +Adds a [Rect](../windows.foundation/rect.md) field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddRect(String, Rect)](loggingfields_addrect_669856720.md), [AddRect(String, Rect, LoggingFieldFormat)](loggingfields_addrect_1756745420.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addrect_1756745420.md b/windows.foundation.diagnostics/loggingfields_addrect_1756745420.md index ea6624aec7..c3682be2d1 100644 --- a/windows.foundation.diagnostics/loggingfields_addrect_1756745420.md +++ b/windows.foundation.diagnostics/loggingfields_addrect_1756745420.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRect(System.String,Windows.Foundation.Rect,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddRect ## -description Adds a [Rect](../windows.foundation/rect.md) field with the specified field name, and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddRect(String, Rect)](loggingfields_addrect_669856720.md), [AddRect(String, Rect, LoggingFieldFormat, Int32)](loggingfields_addrect_1299576052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRect(System.String,Windows.Foundation.Rect,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddRect + +## -description +Adds a [Rect](../windows.foundation/rect.md) field with the specified field name, and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddRect(String, Rect)](loggingfields_addrect_669856720.md), [AddRect(String, Rect, LoggingFieldFormat, Int32)](loggingfields_addrect_1299576052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addrect_669856720.md b/windows.foundation.diagnostics/loggingfields_addrect_669856720.md index 124f6a6382..97b0f7014b 100644 --- a/windows.foundation.diagnostics/loggingfields_addrect_669856720.md +++ b/windows.foundation.diagnostics/loggingfields_addrect_669856720.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRect(System.String,Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddRect ## -description Adds a [Rect](../windows.foundation/rect.md) field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddRect(String, Rect, LoggingFieldFormat)](loggingfields_addrect_1756745420.md), [AddRect(String, Rect, LoggingFieldFormat, Int32)](loggingfields_addrect_1299576052.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRect(System.String,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddRect + +## -description +Adds a [Rect](../windows.foundation/rect.md) field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddRect(String, Rect, LoggingFieldFormat)](loggingfields_addrect_1756745420.md), [AddRect(String, Rect, LoggingFieldFormat, Int32)](loggingfields_addrect_1299576052.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addrectarray_1518105974.md b/windows.foundation.diagnostics/loggingfields_addrectarray_1518105974.md index 24ebf8745d..9925d9c2dc 100644 --- a/windows.foundation.diagnostics/loggingfields_addrectarray_1518105974.md +++ b/windows.foundation.diagnostics/loggingfields_addrectarray_1518105974.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRectArray(System.String,Windows.Foundation.Rect[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddRectArray ## -description Adds a [Rect](../windows.foundation/rect.md) array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddRectArray(String, Rect[], LoggingFieldFormat)](loggingfields_addrectarray_354715758.md), [AddRectArray(String, Rect[], LoggingFieldFormat, Int32)](loggingfields_addrectarray_820294226.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRectArray(System.String,Windows.Foundation.Rect[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddRectArray + +## -description +Adds a [Rect](../windows.foundation/rect.md) array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddRectArray(String, Rect[], LoggingFieldFormat)](loggingfields_addrectarray_354715758.md), [AddRectArray(String, Rect[], LoggingFieldFormat, Int32)](loggingfields_addrectarray_820294226.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addrectarray_354715758.md b/windows.foundation.diagnostics/loggingfields_addrectarray_354715758.md index 679f3eae85..7d85069e23 100644 --- a/windows.foundation.diagnostics/loggingfields_addrectarray_354715758.md +++ b/windows.foundation.diagnostics/loggingfields_addrectarray_354715758.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRectArray(System.String,Windows.Foundation.Rect[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddRectArray ## -description Adds a [Rect](../windows.foundation/rect.md) array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The value for the event field. ## -remarks ## -examples ## -see-also [AddRectArray(String, Rect[])](loggingfields_addrectarray_1518105974.md), [AddRectArray(String, Rect[], LoggingFieldFormat, Int32)](loggingfields_addrectarray_820294226.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRectArray(System.String,Windows.Foundation.Rect[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddRectArray + +## -description +Adds a [Rect](../windows.foundation/rect.md) array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddRectArray(String, Rect[])](loggingfields_addrectarray_1518105974.md), [AddRectArray(String, Rect[], LoggingFieldFormat, Int32)](loggingfields_addrectarray_820294226.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addrectarray_820294226.md b/windows.foundation.diagnostics/loggingfields_addrectarray_820294226.md index 0497c7720a..eb0dc59944 100644 --- a/windows.foundation.diagnostics/loggingfields_addrectarray_820294226.md +++ b/windows.foundation.diagnostics/loggingfields_addrectarray_820294226.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRectArray(System.String,Windows.Foundation.Rect[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddRectArray ## -description Adds a [Rect](../windows.foundation/rect.md) array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddRectArray(String, Rect[])](loggingfields_addrectarray_1518105974.md), [AddRectArray(String, Rect[], LoggingFieldFormat)](loggingfields_addrectarray_354715758.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddRectArray(System.String,Windows.Foundation.Rect[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddRectArray + +## -description +Adds a [Rect](../windows.foundation/rect.md) array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddRectArray(String, Rect[])](loggingfields_addrectarray_1518105974.md), [AddRectArray(String, Rect[], LoggingFieldFormat)](loggingfields_addrectarray_354715758.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsingle_1442858195.md b/windows.foundation.diagnostics/loggingfields_addsingle_1442858195.md index 107da4da63..86082071c6 100644 --- a/windows.foundation.diagnostics/loggingfields_addsingle_1442858195.md +++ b/windows.foundation.diagnostics/loggingfields_addsingle_1442858195.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingle(System.String,System.Single,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSingle ## -description Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddSingle(String, Single)](loggingfields_addsingle_425245129.md), [AddSingle(String, Single, LoggingFieldFormat, Int32)](loggingfields_addsingle_1941995245.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingle(System.String,System.Single,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSingle + +## -description +Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddSingle(String, Single)](loggingfields_addsingle_425245129.md), [AddSingle(String, Single, LoggingFieldFormat, Int32)](loggingfields_addsingle_1941995245.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsingle_1941995245.md b/windows.foundation.diagnostics/loggingfields_addsingle_1941995245.md index 2c62f0237c..41939ad763 100644 --- a/windows.foundation.diagnostics/loggingfields_addsingle_1941995245.md +++ b/windows.foundation.diagnostics/loggingfields_addsingle_1941995245.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingle(System.String,System.Single,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSingle ## -description Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddSingle(String, Single)](loggingfields_addsingle_425245129.md), [AddSingle(String, Single, LoggingFieldFormat)](loggingfields_addsingle_1442858195.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingle(System.String,System.Single,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSingle + +## -description +Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddSingle(String, Single)](loggingfields_addsingle_425245129.md), [AddSingle(String, Single, LoggingFieldFormat)](loggingfields_addsingle_1442858195.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsingle_425245129.md b/windows.foundation.diagnostics/loggingfields_addsingle_425245129.md index 55f427da31..ed66cb6dc7 100644 --- a/windows.foundation.diagnostics/loggingfields_addsingle_425245129.md +++ b/windows.foundation.diagnostics/loggingfields_addsingle_425245129.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingle(System.String,System.Single) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSingle ## -description Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddSingle(String, Single, LoggingFieldFormat)](loggingfields_addsingle_1442858195.md), [AddSingle(String, Single, LoggingFieldFormat, Int32)](loggingfields_addsingle_1941995245.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingle(System.String,System.Single) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSingle + +## -description +Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddSingle(String, Single, LoggingFieldFormat)](loggingfields_addsingle_1442858195.md), [AddSingle(String, Single, LoggingFieldFormat, Int32)](loggingfields_addsingle_1941995245.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsinglearray_1587701985.md b/windows.foundation.diagnostics/loggingfields_addsinglearray_1587701985.md index c4887b2487..2e3c3833ad 100644 --- a/windows.foundation.diagnostics/loggingfields_addsinglearray_1587701985.md +++ b/windows.foundation.diagnostics/loggingfields_addsinglearray_1587701985.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray(System.String,System.Single[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray ## -description Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddSingleArray(String, Single[], LoggingFieldFormat)](loggingfields_addsinglearray_301635067.md), [AddSingleArray(String, Single[], LoggingFieldFormat, Int32)](loggingfields_addsinglearray_876261317.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray(System.String,System.Single[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray + +## -description +Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddSingleArray(String, Single[], LoggingFieldFormat)](loggingfields_addsinglearray_301635067.md), [AddSingleArray(String, Single[], LoggingFieldFormat, Int32)](loggingfields_addsinglearray_876261317.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsinglearray_301635067.md b/windows.foundation.diagnostics/loggingfields_addsinglearray_301635067.md index 6ab49732fe..9c002fb7d8 100644 --- a/windows.foundation.diagnostics/loggingfields_addsinglearray_301635067.md +++ b/windows.foundation.diagnostics/loggingfields_addsinglearray_301635067.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray(System.String,System.Single[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray ## -description Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddSingleArray(String, Single[])](loggingfields_addsinglearray_1587701985.md), [AddSingleArray(String, Single[], LoggingFieldFormat, Int32)](loggingfields_addsinglearray_876261317.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray(System.String,System.Single[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray + +## -description +Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddSingleArray(String, Single[])](loggingfields_addsinglearray_1587701985.md), [AddSingleArray(String, Single[], LoggingFieldFormat, Int32)](loggingfields_addsinglearray_876261317.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsinglearray_876261317.md b/windows.foundation.diagnostics/loggingfields_addsinglearray_876261317.md index 696980c888..f92015e605 100644 --- a/windows.foundation.diagnostics/loggingfields_addsinglearray_876261317.md +++ b/windows.foundation.diagnostics/loggingfields_addsinglearray_876261317.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray(System.String,System.Single[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray ## -description Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddSingleArray(String, Single[])](loggingfields_addsinglearray_1587701985.md), [AddSingleArray(String, Single[], LoggingFieldFormat)](loggingfields_addsinglearray_301635067.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray(System.String,System.Single[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSingleArray + +## -description +Adds a [Single](https://msdn.microsoft.com/library/system.single.aspx) array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddSingleArray(String, Single[])](loggingfields_addsinglearray_1587701985.md), [AddSingleArray(String, Single[], LoggingFieldFormat)](loggingfields_addsinglearray_301635067.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsize_1503205063.md b/windows.foundation.diagnostics/loggingfields_addsize_1503205063.md index 73763684c4..f440a32374 100644 --- a/windows.foundation.diagnostics/loggingfields_addsize_1503205063.md +++ b/windows.foundation.diagnostics/loggingfields_addsize_1503205063.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSize(System.String,Windows.Foundation.Size) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSize ## -description Adds a [Size](../windows.foundation/size.md) field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddSize(String, Size, LoggingFieldFormat)](loggingfields_addsize_381807581.md), [AddSize(String, Size, LoggingFieldFormat, Int32)](loggingfields_addsize_855757283.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSize(System.String,Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSize + +## -description +Adds a [Size](../windows.foundation/size.md) field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddSize(String, Size, LoggingFieldFormat)](loggingfields_addsize_381807581.md), [AddSize(String, Size, LoggingFieldFormat, Int32)](loggingfields_addsize_855757283.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsize_381807581.md b/windows.foundation.diagnostics/loggingfields_addsize_381807581.md index 6fa1898cd9..8f38c84297 100644 --- a/windows.foundation.diagnostics/loggingfields_addsize_381807581.md +++ b/windows.foundation.diagnostics/loggingfields_addsize_381807581.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSize(System.String,Windows.Foundation.Size,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSize ## -description Adds a [Size](../windows.foundation/size.md) field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddSize(String, Size)](loggingfields_addsize_1503205063.md), [AddSize(String, Size, LoggingFieldFormat, Int32)](loggingfields_addsize_855757283.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSize(System.String,Windows.Foundation.Size,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSize + +## -description +Adds a [Size](../windows.foundation/size.md) field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddSize(String, Size)](loggingfields_addsize_1503205063.md), [AddSize(String, Size, LoggingFieldFormat, Int32)](loggingfields_addsize_855757283.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsize_855757283.md b/windows.foundation.diagnostics/loggingfields_addsize_855757283.md index daf8373403..ad6463cfb8 100644 --- a/windows.foundation.diagnostics/loggingfields_addsize_855757283.md +++ b/windows.foundation.diagnostics/loggingfields_addsize_855757283.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSize(System.String,Windows.Foundation.Size,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSize ## -description Adds a [Size](../windows.foundation/size.md) field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddSize(String, Size)](loggingfields_addsize_1503205063.md), [AddSize(String, Size, LoggingFieldFormat)](loggingfields_addsize_381807581.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSize(System.String,Windows.Foundation.Size,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSize + +## -description +Adds a [Size](../windows.foundation/size.md) field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddSize(String, Size)](loggingfields_addsize_1503205063.md), [AddSize(String, Size, LoggingFieldFormat)](loggingfields_addsize_381807581.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsizearray_15142365.md b/windows.foundation.diagnostics/loggingfields_addsizearray_15142365.md index 7cbbd83275..1b6532d2c9 100644 --- a/windows.foundation.diagnostics/loggingfields_addsizearray_15142365.md +++ b/windows.foundation.diagnostics/loggingfields_addsizearray_15142365.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray(System.String,Windows.Foundation.Size[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray ## -description Adds a [Size](../windows.foundation/size.md) array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddSizeArray(String, Size[])](loggingfields_addsizearray_1786759929.md), [AddSizeArray(String, Size[], LoggingFieldFormat)](loggingfields_addsizearray_623327203.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray(System.String,Windows.Foundation.Size[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray + +## -description +Adds a [Size](../windows.foundation/size.md) array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddSizeArray(String, Size[])](loggingfields_addsizearray_1786759929.md), [AddSizeArray(String, Size[], LoggingFieldFormat)](loggingfields_addsizearray_623327203.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsizearray_1786759929.md b/windows.foundation.diagnostics/loggingfields_addsizearray_1786759929.md index 26802f6b84..d1f9a7da64 100644 --- a/windows.foundation.diagnostics/loggingfields_addsizearray_1786759929.md +++ b/windows.foundation.diagnostics/loggingfields_addsizearray_1786759929.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray(System.String,Windows.Foundation.Size[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray ## -description Adds a [Size](../windows.foundation/size.md) array field with the specified field name. ## -parameters ### -param name The name of the field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddSizeArray(String, Size[], LoggingFieldFormat)](loggingfields_addsizearray_623327203.md), [AddSizeArray(String, Size[], LoggingFieldFormat, Int32)](loggingfields_addsizearray_15142365.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray(System.String,Windows.Foundation.Size[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray + +## -description +Adds a [Size](../windows.foundation/size.md) array field with the specified field name. + +## -parameters +### -param name +The name of the field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddSizeArray(String, Size[], LoggingFieldFormat)](loggingfields_addsizearray_623327203.md), [AddSizeArray(String, Size[], LoggingFieldFormat, Int32)](loggingfields_addsizearray_15142365.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addsizearray_623327203.md b/windows.foundation.diagnostics/loggingfields_addsizearray_623327203.md index fad6ab6f8a..2be65976fb 100644 --- a/windows.foundation.diagnostics/loggingfields_addsizearray_623327203.md +++ b/windows.foundation.diagnostics/loggingfields_addsizearray_623327203.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray(System.String,Windows.Foundation.Size[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray ## -description Adds a [Size](../windows.foundation/size.md) array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddSizeArray(String, Size[])](loggingfields_addsizearray_1786759929.md), [AddSizeArray(String, Size[], LoggingFieldFormat, Int32)](loggingfields_addsizearray_15142365.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray(System.String,Windows.Foundation.Size[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddSizeArray + +## -description +Adds a [Size](../windows.foundation/size.md) array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddSizeArray(String, Size[])](loggingfields_addsizearray_1786759929.md), [AddSizeArray(String, Size[], LoggingFieldFormat, Int32)](loggingfields_addsizearray_15142365.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addstring_1708145314.md b/windows.foundation.diagnostics/loggingfields_addstring_1708145314.md index c41c2cfbab..9e7634da58 100644 --- a/windows.foundation.diagnostics/loggingfields_addstring_1708145314.md +++ b/windows.foundation.diagnostics/loggingfields_addstring_1708145314.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddString(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddString ## -description Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddString(String, String, LoggingFieldFormat)](loggingfields_addstring_713607098.md), [AddString(String, String, LoggingFieldFormat, Int32)](loggingfields_addstring_256441734.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddString(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddString + +## -description +Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddString(String, String, LoggingFieldFormat)](loggingfields_addstring_713607098.md), [AddString(String, String, LoggingFieldFormat, Int32)](loggingfields_addstring_256441734.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addstring_256441734.md b/windows.foundation.diagnostics/loggingfields_addstring_256441734.md index af6b26bb5c..5962012398 100644 --- a/windows.foundation.diagnostics/loggingfields_addstring_256441734.md +++ b/windows.foundation.diagnostics/loggingfields_addstring_256441734.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddString(System.String,System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddString ## -description Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddString(String, String)](loggingfields_addstring_1708145314.md), [AddString(String, String, LoggingFieldFormat)](loggingfields_addstring_713607098.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddString(System.String,System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddString + +## -description +Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddString(String, String)](loggingfields_addstring_1708145314.md), [AddString(String, String, LoggingFieldFormat)](loggingfields_addstring_713607098.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addstring_713607098.md b/windows.foundation.diagnostics/loggingfields_addstring_713607098.md index 63ac18c3dd..1d5d6687ca 100644 --- a/windows.foundation.diagnostics/loggingfields_addstring_713607098.md +++ b/windows.foundation.diagnostics/loggingfields_addstring_713607098.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddString(System.String,System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddString ## -description Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddString(String, String)](loggingfields_addstring_1708145314.md), [AddString(String, String, LoggingFieldFormat, Int32)](loggingfields_addstring_256441734.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddString(System.String,System.String,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddString + +## -description +Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddString(String, String)](loggingfields_addstring_1708145314.md), [AddString(String, String, LoggingFieldFormat, Int32)](loggingfields_addstring_256441734.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addstringarray_1270192757.md b/windows.foundation.diagnostics/loggingfields_addstringarray_1270192757.md index 74db07b777..145edb601a 100644 --- a/windows.foundation.diagnostics/loggingfields_addstringarray_1270192757.md +++ b/windows.foundation.diagnostics/loggingfields_addstringarray_1270192757.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddStringArray(System.String,System.String[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddStringArray ## -description Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddStringArray(String, String[])](loggingfields_addstringarray_82667375.md), [AddStringArray(String, String[], LoggingFieldFormat, Int32)](loggingfields_addstringarray_1853202507.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddStringArray(System.String,System.String[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddStringArray + +## -description +Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddStringArray(String, String[])](loggingfields_addstringarray_82667375.md), [AddStringArray(String, String[], LoggingFieldFormat, Int32)](loggingfields_addstringarray_1853202507.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addstringarray_1853202507.md b/windows.foundation.diagnostics/loggingfields_addstringarray_1853202507.md index 03ace53409..5bd5c9cd4f 100644 --- a/windows.foundation.diagnostics/loggingfields_addstringarray_1853202507.md +++ b/windows.foundation.diagnostics/loggingfields_addstringarray_1853202507.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddStringArray(System.String,System.String[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddStringArray ## -description Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddStringArray(String, String[])](loggingfields_addstringarray_82667375.md), [AddStringArray(String, String[], LoggingFieldFormat)](loggingfields_addstringarray_1270192757.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddStringArray(System.String,System.String[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddStringArray + +## -description +Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddStringArray(String, String[])](loggingfields_addstringarray_82667375.md), [AddStringArray(String, String[], LoggingFieldFormat)](loggingfields_addstringarray_1270192757.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addstringarray_82667375.md b/windows.foundation.diagnostics/loggingfields_addstringarray_82667375.md index 581986027d..988125ba0d 100644 --- a/windows.foundation.diagnostics/loggingfields_addstringarray_82667375.md +++ b/windows.foundation.diagnostics/loggingfields_addstringarray_82667375.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddStringArray(System.String,System.String[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddStringArray ## -description Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddStringArray(String, String[], LoggingFieldFormat)](loggingfields_addstringarray_1270192757.md), [AddStringArray(String, String[], LoggingFieldFormat, Int32)](loggingfields_addstringarray_1853202507.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddStringArray(System.String,System.String[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddStringArray + +## -description +Adds a [String](https://msdn.microsoft.com/library/system.string.aspx) array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddStringArray(String, String[], LoggingFieldFormat)](loggingfields_addstringarray_1270192757.md), [AddStringArray(String, String[], LoggingFieldFormat, Int32)](loggingfields_addstringarray_1853202507.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addtimespan_1113404518.md b/windows.foundation.diagnostics/loggingfields_addtimespan_1113404518.md index 73ffdd3f3b..6eeee29c87 100644 --- a/windows.foundation.diagnostics/loggingfields_addtimespan_1113404518.md +++ b/windows.foundation.diagnostics/loggingfields_addtimespan_1113404518.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan(System.String,Windows.Foundation.TimeSpan,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan ## -description Adds a time span field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddTimeSpan(String, TimeSpan)](loggingfields_addtimespan_218483070.md), [AddTimeSpan(String, TimeSpan, LoggingFieldFormat, Int32)](loggingfields_addtimespan_1738346074.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan(System.String,Windows.Foundation.TimeSpan,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan + +## -description +Adds a time span field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddTimeSpan(String, TimeSpan)](loggingfields_addtimespan_218483070.md), [AddTimeSpan(String, TimeSpan, LoggingFieldFormat, Int32)](loggingfields_addtimespan_1738346074.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addtimespan_1738346074.md b/windows.foundation.diagnostics/loggingfields_addtimespan_1738346074.md index 469a4f4bb0..b69754494d 100644 --- a/windows.foundation.diagnostics/loggingfields_addtimespan_1738346074.md +++ b/windows.foundation.diagnostics/loggingfields_addtimespan_1738346074.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan(System.String,Windows.Foundation.TimeSpan,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan ## -description Adds a time span field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddTimeSpan(String, TimeSpan)](loggingfields_addtimespan_218483070.md), [AddTimeSpan(String, TimeSpan, LoggingFieldFormat)](loggingfields_addtimespan_1113404518.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan(System.String,Windows.Foundation.TimeSpan,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan + +## -description +Adds a time span field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddTimeSpan(String, TimeSpan)](loggingfields_addtimespan_218483070.md), [AddTimeSpan(String, TimeSpan, LoggingFieldFormat)](loggingfields_addtimespan_1113404518.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addtimespan_218483070.md b/windows.foundation.diagnostics/loggingfields_addtimespan_218483070.md index 1fd21de686..faccc75b91 100644 --- a/windows.foundation.diagnostics/loggingfields_addtimespan_218483070.md +++ b/windows.foundation.diagnostics/loggingfields_addtimespan_218483070.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan(System.String,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan ## -description Adds a time span field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddTimeSpan(String, TimeSpan, LoggingFieldFormat)](loggingfields_addtimespan_1113404518.md), [AddTimeSpan(String, TimeSpan, LoggingFieldFormat, Int32)](loggingfields_addtimespan_1738346074.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan(System.String,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpan + +## -description +Adds a time span field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddTimeSpan(String, TimeSpan, LoggingFieldFormat)](loggingfields_addtimespan_1113404518.md), [AddTimeSpan(String, TimeSpan, LoggingFieldFormat, Int32)](loggingfields_addtimespan_1738346074.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addtimespanarray_120746009.md b/windows.foundation.diagnostics/loggingfields_addtimespanarray_120746009.md index 7456806816..9251c656d4 100644 --- a/windows.foundation.diagnostics/loggingfields_addtimespanarray_120746009.md +++ b/windows.foundation.diagnostics/loggingfields_addtimespanarray_120746009.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray(System.String,Windows.Foundation.TimeSpan[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray ## -description Adds a time span array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat)](loggingfields_addtimespanarray_1214942467.md), [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat, Int32)](loggingfields_addtimespanarray_1839904573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray(System.String,Windows.Foundation.TimeSpan[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray + +## -description +Adds a time span array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat)](loggingfields_addtimespanarray_1214942467.md), [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat, Int32)](loggingfields_addtimespanarray_1839904573.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addtimespanarray_1214942467.md b/windows.foundation.diagnostics/loggingfields_addtimespanarray_1214942467.md index 6f2a62345a..ed9a642bc4 100644 --- a/windows.foundation.diagnostics/loggingfields_addtimespanarray_1214942467.md +++ b/windows.foundation.diagnostics/loggingfields_addtimespanarray_1214942467.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray(System.String,Windows.Foundation.TimeSpan[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray ## -description Adds a time span array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddTimeSpanArray(String, TimeSpan[])](loggingfields_addtimespanarray_120746009.md), [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat, Int32)](loggingfields_addtimespanarray_1839904573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray(System.String,Windows.Foundation.TimeSpan[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray + +## -description +Adds a time span array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddTimeSpanArray(String, TimeSpan[])](loggingfields_addtimespanarray_120746009.md), [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat, Int32)](loggingfields_addtimespanarray_1839904573.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_addtimespanarray_1839904573.md b/windows.foundation.diagnostics/loggingfields_addtimespanarray_1839904573.md index 30c327ff12..fa784d5342 100644 --- a/windows.foundation.diagnostics/loggingfields_addtimespanarray_1839904573.md +++ b/windows.foundation.diagnostics/loggingfields_addtimespanarray_1839904573.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray(System.String,Windows.Foundation.TimeSpan[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray ## -description Adds a time span array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddTimeSpanArray(String, TimeSpan[])](loggingfields_addtimespanarray_120746009.md), [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat)](loggingfields_addtimespanarray_1214942467.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray(System.String,Windows.Foundation.TimeSpan[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddTimeSpanArray + +## -description +Adds a time span array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddTimeSpanArray(String, TimeSpan[])](loggingfields_addtimespanarray_120746009.md), [AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat)](loggingfields_addtimespanarray_1214942467.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint16_139874741.md b/windows.foundation.diagnostics/loggingfields_adduint16_139874741.md index 2b0c9f72ab..e34c900604 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint16_139874741.md +++ b/windows.foundation.diagnostics/loggingfields_adduint16_139874741.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16(System.String,System.UInt16,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt16 ## -description Adds a 16-bit unsigned integer field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt16(String, UInt16)](loggingfields_adduint16_1657706129.md), [AddUInt16(String, UInt16, LoggingFieldFormat)](loggingfields_adduint16_764832651.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16(System.String,System.UInt16,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt16 + +## -description +Adds a 16-bit unsigned integer field with the specified field name, format, and tags. + + + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt16(String, UInt16)](loggingfields_adduint16_1657706129.md), [AddUInt16(String, UInt16, LoggingFieldFormat)](loggingfields_adduint16_764832651.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint16_1657706129.md b/windows.foundation.diagnostics/loggingfields_adduint16_1657706129.md index 18a91ec73a..cfcfe57f50 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint16_1657706129.md +++ b/windows.foundation.diagnostics/loggingfields_adduint16_1657706129.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16(System.String,System.UInt16) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt16 ## -description Adds a 16-bit unsigned integer field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddUInt16(String, UInt16, LoggingFieldFormat)](loggingfields_adduint16_764832651.md), [AddUInt16(String, UInt16, LoggingFieldFormat, Int32)](loggingfields_adduint16_139874741.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16(System.String,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt16 + +## -description +Adds a 16-bit unsigned integer field with the specified field name. + + + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddUInt16(String, UInt16, LoggingFieldFormat)](loggingfields_adduint16_764832651.md), [AddUInt16(String, UInt16, LoggingFieldFormat, Int32)](loggingfields_adduint16_139874741.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint16_764832651.md b/windows.foundation.diagnostics/loggingfields_adduint16_764832651.md index ad7465dec3..807cdd0f1d 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint16_764832651.md +++ b/windows.foundation.diagnostics/loggingfields_adduint16_764832651.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16(System.String,System.UInt16,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt16 ## -description Adds a 16-bit unsigned integer field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt16(String, UInt16)](loggingfields_adduint16_1657706129.md), [AddUInt16(String, UInt16, LoggingFieldFormat, Int32)](loggingfields_adduint16_139874741.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16(System.String,System.UInt16,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt16 + +## -description +Adds a 16-bit unsigned integer field with the specified field name and format. + + + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt16(String, UInt16)](loggingfields_adduint16_1657706129.md), [AddUInt16(String, UInt16, LoggingFieldFormat, Int32)](loggingfields_adduint16_139874741.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint16array_2054668991.md b/windows.foundation.diagnostics/loggingfields_adduint16array_2054668991.md index 9f2ccfc16b..27ead123ae 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint16array_2054668991.md +++ b/windows.foundation.diagnostics/loggingfields_adduint16array_2054668991.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array(System.String,System.UInt16[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array ## -description Adds a16-bit unsigned integer field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. ## -remarks ## -examples ## -see-also [AddUInt16Array(String, UInt16[], LoggingFieldFormat)](loggingfields_adduint16array_892288933.md), [AddUInt16Array(String, UInt16[], LoggingFieldFormat, Int32)](loggingfields_adduint16array_284099995.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array(System.String,System.UInt16[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array + +## -description +Adds a16-bit unsigned integer field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. + +## -remarks + +## -examples + +## -see-also +[AddUInt16Array(String, UInt16[], LoggingFieldFormat)](loggingfields_adduint16array_892288933.md), [AddUInt16Array(String, UInt16[], LoggingFieldFormat, Int32)](loggingfields_adduint16array_284099995.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint16array_284099995.md b/windows.foundation.diagnostics/loggingfields_adduint16array_284099995.md index ab60bcd1b1..ec5deaef0f 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint16array_284099995.md +++ b/windows.foundation.diagnostics/loggingfields_adduint16array_284099995.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array(System.String,System.UInt16[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array ## -description Adds a 16-bit unsigned integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt16Array(String, UInt16[])](loggingfields_adduint16array_2054668991.md), [AddUInt16Array(String, UInt16[], LoggingFieldFormat)](loggingfields_adduint16array_892288933.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array(System.String,System.UInt16[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array + +## -description +Adds a 16-bit unsigned integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt16Array(String, UInt16[])](loggingfields_adduint16array_2054668991.md), [AddUInt16Array(String, UInt16[], LoggingFieldFormat)](loggingfields_adduint16array_892288933.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint16array_892288933.md b/windows.foundation.diagnostics/loggingfields_adduint16array_892288933.md index dba0d5b4c8..8527bad0a6 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint16array_892288933.md +++ b/windows.foundation.diagnostics/loggingfields_adduint16array_892288933.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array(System.String,System.UInt16[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array ## -description Adds a 16-bit unsigned integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt16Array(String, UInt16[])](loggingfields_adduint16array_2054668991.md), [AddUInt16Array(String, UInt16[], LoggingFieldFormat, Int32)](loggingfields_adduint16array_284099995.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array(System.String,System.UInt16[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt16Array + +## -description +Adds a 16-bit unsigned integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt16Array(String, UInt16[])](loggingfields_adduint16array_2054668991.md), [AddUInt16Array(String, UInt16[], LoggingFieldFormat, Int32)](loggingfields_adduint16array_284099995.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint32_1810590051.md b/windows.foundation.diagnostics/loggingfields_adduint32_1810590051.md index 1a890f0064..4508316c1d 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint32_1810590051.md +++ b/windows.foundation.diagnostics/loggingfields_adduint32_1810590051.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32(System.String,System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt32 ## -description Adds a 32-bit unsigned integer field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddUInt32(String, UInt32, LoggingFieldFormat)](loggingfields_adduint32_615748729.md), [AddUInt32(String, UInt32, LoggingFieldFormat, Int32)](loggingfields_adduint32_24358471.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32(System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt32 + +## -description +Adds a 32-bit unsigned integer field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddUInt32(String, UInt32, LoggingFieldFormat)](loggingfields_adduint32_615748729.md), [AddUInt32(String, UInt32, LoggingFieldFormat, Int32)](loggingfields_adduint32_24358471.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint32_24358471.md b/windows.foundation.diagnostics/loggingfields_adduint32_24358471.md index cda3ec367e..1dc7016b94 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint32_24358471.md +++ b/windows.foundation.diagnostics/loggingfields_adduint32_24358471.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32(System.String,System.UInt32,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt32 ## -description Adds a 32-bit unsigned integer field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt32(String, UInt32)](loggingfields_adduint32_1810590051.md), [AddUInt32(String, UInt32, LoggingFieldFormat)](loggingfields_adduint32_615748729.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32(System.String,System.UInt32,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt32 + +## -description +Adds a 32-bit unsigned integer field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt32(String, UInt32)](loggingfields_adduint32_1810590051.md), [AddUInt32(String, UInt32, LoggingFieldFormat)](loggingfields_adduint32_615748729.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint32_615748729.md b/windows.foundation.diagnostics/loggingfields_adduint32_615748729.md index 1044cd4cdb..1e79ffabcd 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint32_615748729.md +++ b/windows.foundation.diagnostics/loggingfields_adduint32_615748729.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32(System.String,System.UInt32,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt32 ## -description Adds a 32-bit unsigned integer field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt32(String, UInt32)](loggingfields_adduint32_1810590051.md), [AddUInt32(String, UInt32, LoggingFieldFormat, Int32)](loggingfields_adduint32_24358471.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32(System.String,System.UInt32,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt32 + +## -description +Adds a 32-bit unsigned integer field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt32(String, UInt32)](loggingfields_adduint32_1810590051.md), [AddUInt32(String, UInt32, LoggingFieldFormat, Int32)](loggingfields_adduint32_24358471.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint32array_1255816653.md b/windows.foundation.diagnostics/loggingfields_adduint32array_1255816653.md index 0fd35e834a..ee8d298ad8 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint32array_1255816653.md +++ b/windows.foundation.diagnostics/loggingfields_adduint32array_1255816653.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array(System.String,System.UInt32[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array ## -description Adds a 32-bit unsigned integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddUInt32Array(String, UInt32[], LoggingFieldFormat)](loggingfields_adduint32array_92455127.md), [AddUInt32Array(String, UInt32[], LoggingFieldFormat, Int32)](loggingfields_adduint32array_541260521.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array(System.String,System.UInt32[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array + +## -description +Adds a 32-bit unsigned integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddUInt32Array(String, UInt32[], LoggingFieldFormat)](loggingfields_adduint32array_92455127.md), [AddUInt32Array(String, UInt32[], LoggingFieldFormat, Int32)](loggingfields_adduint32array_541260521.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint32array_541260521.md b/windows.foundation.diagnostics/loggingfields_adduint32array_541260521.md index abc9d0f275..45ccf919db 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint32array_541260521.md +++ b/windows.foundation.diagnostics/loggingfields_adduint32array_541260521.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array(System.String,System.UInt32[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array ## -description Adds a 32-bit unsigned integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt32Array(String, UInt32[])](loggingfields_adduint32array_1255816653.md), [AddUInt32Array(String, UInt32[], LoggingFieldFormat)](loggingfields_adduint32array_92455127.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array(System.String,System.UInt32[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array + +## -description +Adds a 32-bit unsigned integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt32Array(String, UInt32[])](loggingfields_adduint32array_1255816653.md), [AddUInt32Array(String, UInt32[], LoggingFieldFormat)](loggingfields_adduint32array_92455127.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint32array_92455127.md b/windows.foundation.diagnostics/loggingfields_adduint32array_92455127.md index b987ad48b6..89cc78ed9f 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint32array_92455127.md +++ b/windows.foundation.diagnostics/loggingfields_adduint32array_92455127.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array(System.String,System.UInt32[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array ## -description Adds a 32-bit unsigned integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt32Array(String, UInt32[])](loggingfields_adduint32array_1255816653.md), [AddUInt32Array(String, UInt32[], LoggingFieldFormat, Int32)](loggingfields_adduint32array_541260521.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array(System.String,System.UInt32[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt32Array + +## -description +Adds a 32-bit unsigned integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt32Array(String, UInt32[])](loggingfields_adduint32array_1255816653.md), [AddUInt32Array(String, UInt32[], LoggingFieldFormat, Int32)](loggingfields_adduint32array_541260521.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint64_1003918459.md b/windows.foundation.diagnostics/loggingfields_adduint64_1003918459.md index 2ea7aeb1a4..9165870db5 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint64_1003918459.md +++ b/windows.foundation.diagnostics/loggingfields_adduint64_1003918459.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64(System.String,System.UInt64,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt64 ## -description Adds a 64-bit unsigned integer field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt64(String, UInt64)](loggingfields_adduint64_1955490145.md), [AddUInt64(String, UInt64, LoggingFieldFormat, Int32)](loggingfields_adduint64_504802885.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64(System.String,System.UInt64,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt64 + +## -description +Adds a 64-bit unsigned integer field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt64(String, UInt64)](loggingfields_adduint64_1955490145.md), [AddUInt64(String, UInt64, LoggingFieldFormat, Int32)](loggingfields_adduint64_504802885.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint64_1955490145.md b/windows.foundation.diagnostics/loggingfields_adduint64_1955490145.md index ab866ddd18..c3bc9e8f58 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint64_1955490145.md +++ b/windows.foundation.diagnostics/loggingfields_adduint64_1955490145.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64(System.String,System.UInt64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt64 ## -description Adds a 64-bit unsigned integer field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddUInt64(String, UInt64, LoggingFieldFormat)](loggingfields_adduint64_1003918459.md), [AddUInt64(String, UInt64, LoggingFieldFormat, Int32)](loggingfields_adduint64_504802885.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64(System.String,System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt64 + +## -description +Adds a 64-bit unsigned integer field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddUInt64(String, UInt64, LoggingFieldFormat)](loggingfields_adduint64_1003918459.md), [AddUInt64(String, UInt64, LoggingFieldFormat, Int32)](loggingfields_adduint64_504802885.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint64_504802885.md b/windows.foundation.diagnostics/loggingfields_adduint64_504802885.md index 3b6f65e3d3..d36155d226 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint64_504802885.md +++ b/windows.foundation.diagnostics/loggingfields_adduint64_504802885.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64(System.String,System.UInt64,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt64 ## -description Adds a 64-bit unsigned integer field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt64(String, UInt64)](loggingfields_adduint64_1955490145.md), [AddUInt64(String, UInt64, LoggingFieldFormat)](loggingfields_adduint64_1003918459.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64(System.String,System.UInt64,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt64 + +## -description +Adds a 64-bit unsigned integer field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt64(String, UInt64)](loggingfields_adduint64_1955490145.md), [AddUInt64(String, UInt64, LoggingFieldFormat)](loggingfields_adduint64_1003918459.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint64array_1001078019.md b/windows.foundation.diagnostics/loggingfields_adduint64array_1001078019.md index 4d1a3db2fb..f85b33f3f4 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint64array_1001078019.md +++ b/windows.foundation.diagnostics/loggingfields_adduint64array_1001078019.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array(System.String,System.UInt64[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array ## -description Adds a 64-bit unsigned integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddUInt64Array(String, UInt64[], LoggingFieldFormat)](loggingfields_adduint64array_1962131481.md), [AddUInt64Array(String, UInt64[], LoggingFieldFormat, Int32)](loggingfields_adduint64array_1362360871.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array(System.String,System.UInt64[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array + +## -description +Adds a 64-bit unsigned integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddUInt64Array(String, UInt64[], LoggingFieldFormat)](loggingfields_adduint64array_1962131481.md), [AddUInt64Array(String, UInt64[], LoggingFieldFormat, Int32)](loggingfields_adduint64array_1362360871.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint64array_1362360871.md b/windows.foundation.diagnostics/loggingfields_adduint64array_1362360871.md index 6762341adf..62ffc2c8e4 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint64array_1362360871.md +++ b/windows.foundation.diagnostics/loggingfields_adduint64array_1362360871.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array(System.String,System.UInt64[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array ## -description Adds a 64-bit unsigned integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt64Array(String, UInt64[])](loggingfields_adduint64array_1001078019.md), [AddUInt64Array(String, UInt64[], LoggingFieldFormat)](loggingfields_adduint64array_1962131481.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array(System.String,System.UInt64[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array + +## -description +Adds a 64-bit unsigned integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt64Array(String, UInt64[])](loggingfields_adduint64array_1001078019.md), [AddUInt64Array(String, UInt64[], LoggingFieldFormat)](loggingfields_adduint64array_1962131481.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint64array_1962131481.md b/windows.foundation.diagnostics/loggingfields_adduint64array_1962131481.md index 930a8a6cb6..5190d31a51 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint64array_1962131481.md +++ b/windows.foundation.diagnostics/loggingfields_adduint64array_1962131481.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array(System.String,System.UInt64[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array ## -description Adds a 64-bit unsigned integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt64Array(String, UInt64[])](loggingfields_adduint64array_1001078019.md), [AddUInt64Array(String, UInt64[], LoggingFieldFormat, Int32)](loggingfields_adduint64array_1362360871.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array(System.String,System.UInt64[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt64Array + +## -description +Adds a 64-bit unsigned integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt64Array(String, UInt64[])](loggingfields_adduint64array_1001078019.md), [AddUInt64Array(String, UInt64[], LoggingFieldFormat, Int32)](loggingfields_adduint64array_1362360871.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint8_2096889896.md b/windows.foundation.diagnostics/loggingfields_adduint8_2096889896.md index 77c2ebd95c..6e62b9971f 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint8_2096889896.md +++ b/windows.foundation.diagnostics/loggingfields_adduint8_2096889896.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8(System.String,System.Byte) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt8 ## -description Adds an 8-bit unsigned integer field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ## -remarks ## -examples ## -see-also [AddUInt8(String, Byte, LoggingFieldFormat)](loggingfields_adduint8_866450748.md), [AddUInt8(String, Byte, LoggingFieldFormat, Int32)](loggingfields_adduint8_375703300.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8(System.String,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt8 + +## -description +Adds an 8-bit unsigned integer field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +## -remarks + +## -examples + +## -see-also +[AddUInt8(String, Byte, LoggingFieldFormat)](loggingfields_adduint8_866450748.md), [AddUInt8(String, Byte, LoggingFieldFormat, Int32)](loggingfields_adduint8_375703300.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint8_375703300.md b/windows.foundation.diagnostics/loggingfields_adduint8_375703300.md index 3b7287cb84..33b6b82ba6 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint8_375703300.md +++ b/windows.foundation.diagnostics/loggingfields_adduint8_375703300.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8(System.String,System.Byte,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt8 ## -description Adds an 8-bit unsigned integer field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks ## -examples ## -see-also [AddUInt8(String, Byte)](loggingfields_adduint8_2096889896.md), [AddUInt8(String, Byte, LoggingFieldFormat)](loggingfields_adduint8_866450748.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8(System.String,System.Byte,Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt8 + +## -description +Adds an 8-bit unsigned integer field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks + +## -examples + +## -see-also +[AddUInt8(String, Byte)](loggingfields_adduint8_2096889896.md), [AddUInt8(String, Byte, LoggingFieldFormat)](loggingfields_adduint8_866450748.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint8_866450748.md b/windows.foundation.diagnostics/loggingfields_adduint8_866450748.md index a05bb13412..c662364528 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint8_866450748.md +++ b/windows.foundation.diagnostics/loggingfields_adduint8_866450748.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8(System.String,System.Byte,Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt8 ## -description Adds an 8-bit unsigned integer field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks ## -examples ## -see-also [AddUInt8(String, Byte)](loggingfields_adduint8_2096889896.md), [AddUInt8(String, Byte, LoggingFieldFormat, Int32)](loggingfields_adduint8_375703300.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8(System.String,System.Byte,Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt8 + +## -description +Adds an 8-bit unsigned integer field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks + +## -examples + +## -see-also +[AddUInt8(String, Byte)](loggingfields_adduint8_2096889896.md), [AddUInt8(String, Byte, LoggingFieldFormat, Int32)](loggingfields_adduint8_375703300.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint8array_1568617358.md b/windows.foundation.diagnostics/loggingfields_adduint8array_1568617358.md index b1f574dfb6..c2ec46c2e8 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint8array_1568617358.md +++ b/windows.foundation.diagnostics/loggingfields_adduint8array_1568617358.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array(System.String,System.Byte[]) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array ## -description Adds an 8-bit unsigned integer array field with the specified field name. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. The format for the array is binary. ## -remarks ## -examples ## -see-also [AddUInt8Array(String, Byte[], LoggingFieldFormat)](loggingfields_adduint8array_304598678.md), [AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)](loggingfields_adduint8array_937948330.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array(System.String,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array + +## -description +Adds an 8-bit unsigned integer array field with the specified field name. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. The format for the array is binary. + +## -remarks + +## -examples + +## -see-also +[AddUInt8Array(String, Byte[], LoggingFieldFormat)](loggingfields_adduint8array_304598678.md), [AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)](loggingfields_adduint8array_937948330.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint8array_304598678.md b/windows.foundation.diagnostics/loggingfields_adduint8array_304598678.md index 54e6510c54..0ec36979ea 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint8array_304598678.md +++ b/windows.foundation.diagnostics/loggingfields_adduint8array_304598678.md @@ -1,3 +1,44 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array(System.String,System.Byte[],Windows.Foundation.Diagnostics.LoggingFieldFormat) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array ## -description Adds an 8-bit unsigned integer array field with the specified field name and format. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ## -remarks Use the *format* parameter to specify the format of the array. You may use the following [LoggingFieldFormat](loggingfieldformat.md) formats:
DefaultNo format is specified.
BooleanData is treated as an array of boolean values
HexadecimalData is treated as an array of 8-bit integers, formatted as hexadecimal
Ipv6AddressData is treated as an IPv6 address
JsonData is treated as a Multi-Byte Character Set (MBCS) JavaScript Object Notation (JSON) string
SignedData is treated as an array of signed 8-bit integers
StringData is treated as a MBCS string
SocketAddressData is treated as a [sockaddr](http://msdn.microsoft.com/library/d1392e1c-2b20-425a-8adf-38e665fb6275)
UnsignedData is treated as an array of unsigned 8-bit integers
XMLData is treated as an MBCS XML string
## -examples ## -see-also [AddUInt8Array(String, Byte[])](loggingfields_adduint8array_1568617358.md), [AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)](loggingfields_adduint8array_937948330.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array(System.String,System.Byte[],Windows.Foundation.Diagnostics.LoggingFieldFormat) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array + +## -description +Adds an 8-bit unsigned integer array field with the specified field name and format. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +## -remarks +Use the *format* parameter to specify the format of the array. You may use the following [LoggingFieldFormat](loggingfieldformat.md) formats: + + + + + + + + + + +
DefaultNo format is specified.
BooleanData is treated as an array of boolean values
HexadecimalData is treated as an array of 8-bit integers, formatted as hexadecimal
Ipv6AddressData is treated as an IPv6 address
JsonData is treated as a Multi-Byte Character Set (MBCS) JavaScript Object Notation (JSON) string
SignedData is treated as an array of signed 8-bit integers
StringData is treated as a MBCS string
SocketAddressData is treated as a [sockaddr](http://msdn.microsoft.com/library/d1392e1c-2b20-425a-8adf-38e665fb6275)
UnsignedData is treated as an array of unsigned 8-bit integers
XMLData is treated as an MBCS XML string
+ + + +## -examples + +## -see-also +[AddUInt8Array(String, Byte[])](loggingfields_adduint8array_1568617358.md), [AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)](loggingfields_adduint8array_937948330.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_adduint8array_937948330.md b/windows.foundation.diagnostics/loggingfields_adduint8array_937948330.md index 7f35f92b78..45be93b858 100644 --- a/windows.foundation.diagnostics/loggingfields_adduint8array_937948330.md +++ b/windows.foundation.diagnostics/loggingfields_adduint8array_937948330.md @@ -1,3 +1,47 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array(System.String,System.Byte[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array ## -description Adds an 8-bit unsigned integer array field with the specified field name, format, and tags. ## -parameters ### -param name Name of the event field. ### -param value The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. ### -param format The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. ### -param tags The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). ## -remarks Use the *format* parameter to specify the format of the array. You may use the following [LoggingFieldFormat](loggingfieldformat.md) formats:
DefaultNo format is specified.
BooleanData is treated as an array of boolean values
HexadecimalData is treated as an array of 8-bit integers, formatted as hexadecimal
Ipv6AddressData is treated as an IPv6 address
JsonData is treated as a Multi-Byte Character Set (MBCS) JavaScript Object Notation (JSON) string
SignedData is treated as an array of signed 8-bit integers
StringData is treated as a MBCS string
SocketAddressData is treated as a [sockaddr](http://msdn.microsoft.com/library/d1392e1c-2b20-425a-8adf-38e665fb6275)
UnsignedData is treated as an array of unsigned 8-bit integers
XMLData is treated as an MBCS XML string
## -examples ## -see-also [AddUInt8Array(String, Byte[])](loggingfields_adduint8array_1568617358.md), [AddUInt8Array(String, Byte[], LoggingFieldFormat)](loggingfields_adduint8array_304598678.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array(System.String,System.Byte[],Windows.Foundation.Diagnostics.LoggingFieldFormat,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.AddUInt8Array + +## -description +Adds an 8-bit unsigned integer array field with the specified field name, format, and tags. + +## -parameters +### -param name +Name of the event field. + +### -param value +The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. + +### -param format +The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. + +### -param tags +The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0). + +## -remarks +Use the *format* parameter to specify the format of the array. You may use the following [LoggingFieldFormat](loggingfieldformat.md) formats: + + + + + + + + + + +
DefaultNo format is specified.
BooleanData is treated as an array of boolean values
HexadecimalData is treated as an array of 8-bit integers, formatted as hexadecimal
Ipv6AddressData is treated as an IPv6 address
JsonData is treated as a Multi-Byte Character Set (MBCS) JavaScript Object Notation (JSON) string
SignedData is treated as an array of signed 8-bit integers
StringData is treated as a MBCS string
SocketAddressData is treated as a [sockaddr](http://msdn.microsoft.com/library/d1392e1c-2b20-425a-8adf-38e665fb6275)
UnsignedData is treated as an array of unsigned 8-bit integers
XMLData is treated as an MBCS XML string
+ + + +## -examples + +## -see-also +[AddUInt8Array(String, Byte[])](loggingfields_adduint8array_1568617358.md), [AddUInt8Array(String, Byte[], LoggingFieldFormat)](loggingfields_adduint8array_304598678.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_beginstruct_359748894.md b/windows.foundation.diagnostics/loggingfields_beginstruct_359748894.md index 5754af7209..b7a1387512 100644 --- a/windows.foundation.diagnostics/loggingfields_beginstruct_359748894.md +++ b/windows.foundation.diagnostics/loggingfields_beginstruct_359748894.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.BeginStruct(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.BeginStruct ## -description Begins a new structured field with the specified field name. ## -parameters ### -param name Name of the structured field. ## -remarks ## -examples ## -see-also [BeginStruct(String, Int32)](loggingfields_beginstruct_603890798.md), [EndStruct](loggingfields_endstruct.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.BeginStruct(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.BeginStruct + +## -description +Begins a new structured field with the specified field name. + +## -parameters +### -param name +Name of the structured field. + +## -remarks + +## -examples + +## -see-also +[BeginStruct(String, Int32)](loggingfields_beginstruct_603890798.md), [EndStruct](loggingfields_endstruct.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_beginstruct_603890798.md b/windows.foundation.diagnostics/loggingfields_beginstruct_603890798.md index c9367e44cf..594f5c6697 100644 --- a/windows.foundation.diagnostics/loggingfields_beginstruct_603890798.md +++ b/windows.foundation.diagnostics/loggingfields_beginstruct_603890798.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.BeginStruct(System.String,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.BeginStruct ## -description Begins a new structured field with the specified field name and tags. ## -parameters ### -param name Name of the structured field. ### -param tags Specifies up to twenty-eight bits of user-defined field metadata. The top four bits are reserved and must be set to zero (0).The metadata may be used by a custom Event Tracing for Windows (ETW) processing tool. For example, you might define a tag that indicates that a field might contain personally-identifiable information. ## -remarks ## -examples ## -see-also [BeginStruct(String)](loggingfields_beginstruct_359748894.md), [EndStruct](loggingfields_endstruct.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.BeginStruct(System.String,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.BeginStruct + +## -description +Begins a new structured field with the specified field name and tags. + +## -parameters +### -param name +Name of the structured field. + +### -param tags +Specifies up to twenty-eight bits of user-defined field metadata. The top four bits are reserved and must be set to zero (0).The metadata may be used by a custom Event Tracing for Windows (ETW) processing tool. For example, you might define a tag that indicates that a field might contain personally-identifiable information. + +## -remarks + +## -examples + +## -see-also +[BeginStruct(String)](loggingfields_beginstruct_359748894.md), [EndStruct](loggingfields_endstruct.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_clear_556466.md b/windows.foundation.diagnostics/loggingfields_clear_556466.md index e6045d9656..e865fce0c6 100644 --- a/windows.foundation.diagnostics/loggingfields_clear_556466.md +++ b/windows.foundation.diagnostics/loggingfields_clear_556466.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.Clear --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.Clear ## -description Removes all fields stored in the object and resets the object to its newly-constructed state. ## -remarks This method allows you to reuse a **LoggingFields** instance with multiple events which improves performance by avoiding unnecessary object creation, payload buffer allocation, and garbage collection overhead. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.Clear +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.Clear + +## -description +Removes all fields stored in the object and resets the object to its newly-constructed state. + +## -remarks +This method allows you to reuse a **LoggingFields** instance with multiple events which improves performance by avoiding unnecessary object creation, payload buffer allocation, and garbage collection overhead. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingfields_endstruct_494341079.md b/windows.foundation.diagnostics/loggingfields_endstruct_494341079.md index e14dadbdd6..afdd3bf428 100644 --- a/windows.foundation.diagnostics/loggingfields_endstruct_494341079.md +++ b/windows.foundation.diagnostics/loggingfields_endstruct_494341079.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.EndStruct --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.EndStruct ## -description Ends a structured field. ## -remarks ## -examples ## -see-also [BeginStruct](loggingfields_beginstruct.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.EndStruct +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.EndStruct + +## -description +Ends a structured field. + +## -remarks + +## -examples + +## -see-also +[BeginStruct](loggingfields_beginstruct.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingfields_loggingfields_1221375020.md b/windows.foundation.diagnostics/loggingfields_loggingfields_1221375020.md index edb71a1ebe..44af263d06 100644 --- a/windows.foundation.diagnostics/loggingfields_loggingfields_1221375020.md +++ b/windows.foundation.diagnostics/loggingfields_loggingfields_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingFields.#ctor --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingFields.LoggingFields ## -description Initializes a new **LoggingFields** instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingFields.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingFields.LoggingFields + +## -description +Initializes a new **LoggingFields** instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingoptions.md b/windows.foundation.diagnostics/loggingoptions.md index 29b0bd5ca4..f508b69b71 100644 --- a/windows.foundation.diagnostics/loggingoptions.md +++ b/windows.foundation.diagnostics/loggingoptions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LoggingOptions --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LoggingOptions ## -description Represents advanced event settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LoggingOptions +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions + +## -description +Represents advanced event settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingoptions_keywords.md b/windows.foundation.diagnostics/loggingoptions_keywords.md index a91d738306..d962fc6922 100644 --- a/windows.foundation.diagnostics/loggingoptions_keywords.md +++ b/windows.foundation.diagnostics/loggingoptions_keywords.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Keywords --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingOptions.Keywords ## -description Gets or sets the keyword value that represents the different categories that an event belongs to. ## -property-value The keyword value. ## -remarks Each bit represents a category that an event belongs to. Event Tracing for Windows (ETW) tools are able to filter events based on keyword. > [!IMPORTANT] > Only the lower 48 bits are available for user-defined event categories. The top eight bits of the keyword value are reserved for future definition and must be set to zero (0). The next eight bits are reserved by Microsoft. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Keywords +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.Keywords + +## -description +Gets or sets the keyword value that represents the different categories that an event belongs to. + +## -property-value +The keyword value. + +## -remarks +Each bit represents a category that an event belongs to. Event Tracing for Windows (ETW) tools are able to filter events based on keyword. + +> [!IMPORTANT] +> Only the lower 48 bits are available for user-defined event categories. The top eight bits of the keyword value are reserved for future definition and must be set to zero (0). The next eight bits are reserved by Microsoft. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingoptions_loggingoptions_1221375020.md b/windows.foundation.diagnostics/loggingoptions_loggingoptions_1221375020.md index 574447d518..c7a2b19233 100644 --- a/windows.foundation.diagnostics/loggingoptions_loggingoptions_1221375020.md +++ b/windows.foundation.diagnostics/loggingoptions_loggingoptions_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingOptions.#ctor --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingOptions.LoggingOptions ## -description Initializes a new **LoggingOptions** instance with default option values. ## -remarks ## -examples ## -see-also [LoggingOptions(Int64)](loggingoptions_loggingoptions_2099826997.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.LoggingOptions + +## -description +Initializes a new **LoggingOptions** instance with default option values. + +## -remarks + +## -examples + +## -see-also +[LoggingOptions(Int64)](loggingoptions_loggingoptions_2099826997.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingoptions_loggingoptions_2099826997.md b/windows.foundation.diagnostics/loggingoptions_loggingoptions_2099826997.md index 3a76bfdb39..14383e84bf 100644 --- a/windows.foundation.diagnostics/loggingoptions_loggingoptions_2099826997.md +++ b/windows.foundation.diagnostics/loggingoptions_loggingoptions_2099826997.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingOptions.#ctor(System.Int64) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingOptions.LoggingOptions ## -description Initializes a new **LoggingOptions** instance with the specified keyword value. ## -parameters ### -param keywords The keyword value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingOptions.#ctor(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.LoggingOptions + +## -description +Initializes a new **LoggingOptions** instance with the specified keyword value. + +## -parameters +### -param keywords +The keyword value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingoptions_opcode.md b/windows.foundation.diagnostics/loggingoptions_opcode.md index 9deaaca66e..137cb61c17 100644 --- a/windows.foundation.diagnostics/loggingoptions_opcode.md +++ b/windows.foundation.diagnostics/loggingoptions_opcode.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Opcode --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingOptions.Opcode ## -description Gets or sets the operation code value for an event. ## -property-value The operation code. ## -remarks This value corresponds to the Event Tracing for Windows (ETW) definition of an opcode. Most events should use the **Info** opcode. The [LoggingActivity](loggingactivity.md) class will generate events with the **Opcode** set to **Start** and **Stop**. ## -examples ## -see-also [LoggingOpcode enumeration](loggingopcode.md), [Defining Tasks and Opcodes](XREF:TODO:wes.defining_tasks_and_opcodes) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Opcode +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.Opcode + +## -description +Gets or sets the operation code value for an event. + +## -property-value +The operation code. + +## -remarks +This value corresponds to the Event Tracing for Windows (ETW) definition of an opcode. Most events should use the **Info** opcode. + +The [LoggingActivity](loggingactivity.md) class will generate events with the **Opcode** set to **Start** and **Stop**. + +## -examples + +## -see-also +[LoggingOpcode enumeration](loggingopcode.md), [Defining Tasks and Opcodes](XREF:TODO:wes.defining_tasks_and_opcodes) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md b/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md index 1bb51554b6..2f1bfc7032 100644 --- a/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md +++ b/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.RelatedActivityId --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingOptions.RelatedActivityId ## -description Gets or sets a value that uniquely identifies the parent activity to which this activity is related. ## -property-value A value that uniquely identifies the parent activity to which this activity is related. ## -remarks This value corresponds to the Event Tracing for Windows (ETW) definition of a related activity id. You will normally use the [LoggingActivity](loggingactivity.md) class to automatically manage this value instead of setting it manually. ## -examples ## -see-also [EVENT_EXTENDED_ITEM_RELATED_ACTIVITYID](XREF:TODO:etw.event_extended_item_related_activityid) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.RelatedActivityId +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.RelatedActivityId + +## -description +Gets or sets a value that uniquely identifies the parent activity to which this activity is related. + +## -property-value +A value that uniquely identifies the parent activity to which this activity is related. + +## -remarks +This value corresponds to the Event Tracing for Windows (ETW) definition of a related activity id. You will normally use the [LoggingActivity](loggingactivity.md) class to automatically manage this value instead of setting it manually. + +## -examples + +## -see-also +[EVENT_EXTENDED_ITEM_RELATED_ACTIVITYID](XREF:TODO:etw.event_extended_item_related_activityid) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingoptions_tags.md b/windows.foundation.diagnostics/loggingoptions_tags.md index 387f5ae8e6..4e6b0eb12d 100644 --- a/windows.foundation.diagnostics/loggingoptions_tags.md +++ b/windows.foundation.diagnostics/loggingoptions_tags.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Tags --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingOptions.Tags ## -description Gets or sets the user-defined metadata value attached to an event. ## -property-value The tag. ## -remarks The top four bits are reserved and must be set to zero (0). Up to twenty-eight bits of user-defined information can be attached to an event as metadata. For example, user-defined metadata could be defined to act as instructions to a custom event processing tool to control event sampling, throttling, and so on. For efficiency reasons, tags should be used for infrequently-changing metadata and not frequently-changing data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Tags +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.Tags + +## -description +Gets or sets the user-defined metadata value attached to an event. + +## -property-value +The tag. + +## -remarks +The top four bits are reserved and must be set to zero (0). + +Up to twenty-eight bits of user-defined information can be attached to an event as metadata. For example, user-defined metadata could be defined to act as instructions to a custom event processing tool to control event sampling, throttling, and so on. + +For efficiency reasons, tags should be used for infrequently-changing metadata and not frequently-changing data. + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingoptions_task.md b/windows.foundation.diagnostics/loggingoptions_task.md index 904d0ae217..28076bc1f7 100644 --- a/windows.foundation.diagnostics/loggingoptions_task.md +++ b/windows.foundation.diagnostics/loggingoptions_task.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Task --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingOptions.Task ## -description Gets or sets the user-defined value that identifies a larger unit of work within an application or component. ## -property-value The task value. ## -remarks This value corresponds to the Event Tracing for Windows (ETW) definition of a task. It is a user-defined value. A task is a larger unit of work within an application or component, i.e. it identifies a scope of work that is broader than an [Opcode](loggingopcode.md). ## -examples ## -see-also [Defining Tasks and Opcodes](XREF:TODO:wes.defining_tasks_and_opcodes) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Task +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.Task + +## -description +Gets or sets the user-defined value that identifies a larger unit of work within an application or component. + +## -property-value +The task value. + +## -remarks +This value corresponds to the Event Tracing for Windows (ETW) definition of a task. It is a user-defined value. A task is a larger unit of work within an application or component, i.e. it identifies a scope of work that is broader than an [Opcode](loggingopcode.md). + +## -examples + +## -see-also +[Defining Tasks and Opcodes](XREF:TODO:wes.defining_tasks_and_opcodes) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingsession.md b/windows.foundation.diagnostics/loggingsession.md index 50aca722aa..e13623c2b2 100644 --- a/windows.foundation.diagnostics/loggingsession.md +++ b/windows.foundation.diagnostics/loggingsession.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.LoggingSession --api-type: winrt class ---- # Windows.Foundation.Diagnostics.LoggingSession ## -description Represents the destination of logged messages from [LoggingChannel](loggingchannel.md) instances. ## -remarks Use the [LoggingSession](loggingsession.md) class to log messages and data to an in-memory circular buffer as your app runs. Use the [SaveToFileAsync](loggingsession_savetofileasync.md) method to save the buffer to a file. You can view the log files by using the Windows Performance Toolkit (WPT) and other utilities like tracerpt.exe. [LoggingSession](loggingsession.md) instances keep logged messages in memory until the [SaveToFileAsync](loggingsession_savetofileasync.md) method is called. This enables on-demand saving of events until the app saves the in-memory messages. Add [LoggingChannel](loggingchannel.md) instances to a [LoggingSession](loggingsession.md), and call [LoggingSession](loggingsession.md) instance methods to remove channels, dispose, and perform other operations. [LoggingSession](loggingsession.md) records the most recent 260KB of events, after which it will begin overwriting older events. You cannot have more than one session with the same name. In addition, each app is limited to 4 sessions total. ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [ILoggingSession](iloggingsession.md), [IClosable](../windows.foundation/iclosable.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.LoggingSession +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession + +## -description +Represents the destination of logged messages from [LoggingChannel](loggingchannel.md) instances. + +## -remarks +Use the [LoggingSession](loggingsession.md) class to log messages and data to an in-memory circular buffer as your app runs. Use the [SaveToFileAsync](loggingsession_savetofileasync.md) method to save the buffer to a file. You can view the log files by using the Windows Performance Toolkit (WPT) and other utilities like tracerpt.exe. + +[LoggingSession](loggingsession.md) instances keep logged messages in memory until the [SaveToFileAsync](loggingsession_savetofileasync.md) method is called. This enables on-demand saving of events until the app saves the in-memory messages. + +Add [LoggingChannel](loggingchannel.md) instances to a [LoggingSession](loggingsession.md), and call [LoggingSession](loggingsession.md) instance methods to remove channels, dispose, and perform other operations. + +[LoggingSession](loggingsession.md) records the most recent 260KB of events, after which it will begin overwriting older events. + +You cannot have more than one session with the same name. In addition, each app is limited to 4 sessions total. + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [ILoggingSession](iloggingsession.md), [IClosable](../windows.foundation/iclosable.md), [Logging sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620565) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingsession_addloggingchannel_1409249414.md b/windows.foundation.diagnostics/loggingsession_addloggingchannel_1409249414.md index fb36106b32..53cb02e204 100644 --- a/windows.foundation.diagnostics/loggingsession_addloggingchannel_1409249414.md +++ b/windows.foundation.diagnostics/loggingsession_addloggingchannel_1409249414.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel ## -description Adds a logging channel with the specified logging level to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ### -param maxLevel The logging level for *loggingChannel*. ## -remarks You can also use this function to change the level at which a channel is added to a session; to do so, call **AddLoggingChannel**, using the existing logging channel, but with the updated level. ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [AddLoggingChannel(ILoggingChannel)](loggingsession_addloggingchannel_604200962.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel,Windows.Foundation.Diagnostics.LoggingLevel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel + +## -description +Adds a logging channel with the specified logging level to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +### -param maxLevel +The logging level for *loggingChannel*. + +## -remarks +You can also use this function to change the level at which a channel is added to a session; to do so, call **AddLoggingChannel**, using the existing logging channel, but with the updated level. + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [AddLoggingChannel(ILoggingChannel)](loggingsession_addloggingchannel_604200962.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingsession_addloggingchannel_604200962.md b/windows.foundation.diagnostics/loggingsession_addloggingchannel_604200962.md index 35624e7dda..198c0dd0bb 100644 --- a/windows.foundation.diagnostics/loggingsession_addloggingchannel_604200962.md +++ b/windows.foundation.diagnostics/loggingsession_addloggingchannel_604200962.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel ## -description Adds a logging channel to the current logging session. ## -parameters ### -param loggingChannel The logging channel to add. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md), [AddLoggingChannel(ILoggingChannel, LoggingLevel)](loggingsession_addloggingchannel_1409249414.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.AddLoggingChannel + +## -description +Adds a logging channel to the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to add. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md), [AddLoggingChannel(ILoggingChannel, LoggingLevel)](loggingsession_addloggingchannel_1409249414.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingsession_close_811482585.md b/windows.foundation.diagnostics/loggingsession_close_811482585.md index 4e0d627929..b5547b797d 100644 --- a/windows.foundation.diagnostics/loggingsession_close_811482585.md +++ b/windows.foundation.diagnostics/loggingsession_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingSession.Close --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingSession.Close ## -description Ends the current logging session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingSession.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.Close + +## -description +Ends the current logging session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingsession_loggingsession_290278668.md b/windows.foundation.diagnostics/loggingsession_loggingsession_290278668.md index e4771fa7db..5035a65fec 100644 --- a/windows.foundation.diagnostics/loggingsession_loggingsession_290278668.md +++ b/windows.foundation.diagnostics/loggingsession_loggingsession_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingSession.#ctor(System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingSession.LoggingSession ## -description Initializes a new instance of the [LoggingSession](loggingsession.md) class. ## -parameters ### -param name The name of the logging session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingSession.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.LoggingSession + +## -description +Initializes a new instance of the [LoggingSession](loggingsession.md) class. + +## -parameters +### -param name +The name of the logging session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingsession_name.md b/windows.foundation.diagnostics/loggingsession_name.md index 1634977795..c6eaa2fb33 100644 --- a/windows.foundation.diagnostics/loggingsession_name.md +++ b/windows.foundation.diagnostics/loggingsession_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.LoggingSession.Name --api-type: winrt property ---- # Windows.Foundation.Diagnostics.LoggingSession.Name ## -description Gets the name of the logging session. ## -property-value The session name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingSession.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.Name + +## -description +Gets the name of the logging session. + +## -property-value +The session name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/loggingsession_removeloggingchannel_1406889906.md b/windows.foundation.diagnostics/loggingsession_removeloggingchannel_1406889906.md index 4f0f0d8d57..c80601f6c6 100644 --- a/windows.foundation.diagnostics/loggingsession_removeloggingchannel_1406889906.md +++ b/windows.foundation.diagnostics/loggingsession_removeloggingchannel_1406889906.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingSession.RemoveLoggingChannel ## -description Removes the specified logging channel from the current logging session. ## -parameters ### -param loggingChannel The logging channel to remove. ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingSession.RemoveLoggingChannel(Windows.Foundation.Diagnostics.ILoggingChannel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.RemoveLoggingChannel + +## -description +Removes the specified logging channel from the current logging session. + +## -parameters +### -param loggingChannel +The logging channel to remove. + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingsession_savetofileasync_705962807.md b/windows.foundation.diagnostics/loggingsession_savetofileasync_705962807.md index 6e84e66a41..6b63bf0ef7 100644 --- a/windows.foundation.diagnostics/loggingsession_savetofileasync_705962807.md +++ b/windows.foundation.diagnostics/loggingsession_savetofileasync_705962807.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.LoggingSession.SaveToFileAsync(Windows.Storage.IStorageFolder,System.String) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.LoggingSession.SaveToFileAsync ## -description Saves the current logging session to a file. ## -parameters ### -param folder The folder that contains the log file. ### -param fileName The name of the log file. ## -returns When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). ## -remarks ## -examples ## -see-also [LoggingChannel](loggingchannel.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.LoggingSession.SaveToFileAsync(Windows.Storage.IStorageFolder,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.LoggingSession.SaveToFileAsync + +## -description +Saves the current logging session to a file. + +## -parameters +### -param folder +The folder that contains the log file. + +### -param fileName +The name of the log file. + +## -returns +When this method completes, it returns the new file as a [StorageFile](../windows.storage/storagefile.md). + +## -remarks + +## -examples + +## -see-also +[LoggingChannel](loggingchannel.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/runtimebrokererrorsettings_geterroroptions_955722078.md b/windows.foundation.diagnostics/runtimebrokererrorsettings_geterroroptions_955722078.md index df127acfb1..da4425dd5b 100644 --- a/windows.foundation.diagnostics/runtimebrokererrorsettings_geterroroptions_955722078.md +++ b/windows.foundation.diagnostics/runtimebrokererrorsettings_geterroroptions_955722078.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.GetErrorOptions --api-type: winrt method ---- # Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.GetErrorOptions ## -description Gets the type of error reporting for the error object. ## -returns One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.GetErrorOptions +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.GetErrorOptions + +## -description +Gets the type of error reporting for the error object. + +## -returns +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/runtimebrokererrorsettings_runtimebrokererrorsettings_1221375020.md b/windows.foundation.diagnostics/runtimebrokererrorsettings_runtimebrokererrorsettings_1221375020.md index ca0f26cfdf..a3f3534d95 100644 --- a/windows.foundation.diagnostics/runtimebrokererrorsettings_runtimebrokererrorsettings_1221375020.md +++ b/windows.foundation.diagnostics/runtimebrokererrorsettings_runtimebrokererrorsettings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.#ctor --api-type: winrt method ---- # Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.RuntimeBrokerErrorSettings ## -description Creates and initializes a new instance of the [RuntimeBrokerErrorSettings](runtimebrokererrorsettings.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.RuntimeBrokerErrorSettings + +## -description +Creates and initializes a new instance of the [RuntimeBrokerErrorSettings](runtimebrokererrorsettings.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/runtimebrokererrorsettings_seterroroptions_108183281.md b/windows.foundation.diagnostics/runtimebrokererrorsettings_seterroroptions_108183281.md index d0b8fef1fc..a25bb970a2 100644 --- a/windows.foundation.diagnostics/runtimebrokererrorsettings_seterroroptions_108183281.md +++ b/windows.foundation.diagnostics/runtimebrokererrorsettings_seterroroptions_108183281.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.SetErrorOptions(Windows.Foundation.Diagnostics.ErrorOptions) --api-type: winrt method ---- # Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.SetErrorOptions ## -description Sets the type of error reporting for the error object. ## -parameters ### -param value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.SetErrorOptions(Windows.Foundation.Diagnostics.ErrorOptions) +-api-type: winrt method +--- + + + +# Windows.Foundation.Diagnostics.RuntimeBrokerErrorSettings.SetErrorOptions + +## -description +Sets the type of error reporting for the error object. + +## -parameters +### -param value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/tracingstatuschangedeventargs.md b/windows.foundation.diagnostics/tracingstatuschangedeventargs.md index e52cc04acc..241bbeee00 100644 --- a/windows.foundation.diagnostics/tracingstatuschangedeventargs.md +++ b/windows.foundation.diagnostics/tracingstatuschangedeventargs.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs --api-type: winrt class ---- # Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs ## -description Provides data for the [TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs + +## -description +Provides data for the [TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.diagnostics/tracingstatuschangedeventargs_enabled.md b/windows.foundation.diagnostics/tracingstatuschangedeventargs_enabled.md index 79b85cbbc0..bd8b2f4132 100644 --- a/windows.foundation.diagnostics/tracingstatuschangedeventargs_enabled.md +++ b/windows.foundation.diagnostics/tracingstatuschangedeventargs_enabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.Enabled --api-type: winrt property ---- # Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.Enabled ## -description Gets a value that indicates whether tracing is active. ## -property-value **True**, if tracing is active, otherwise **false**. ## -remarks ## -examples ## -see-also [TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.Enabled +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.Enabled + +## -description +Gets a value that indicates whether tracing is active. + +## -property-value +**True**, if tracing is active, otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) \ No newline at end of file diff --git a/windows.foundation.diagnostics/tracingstatuschangedeventargs_tracelevel.md b/windows.foundation.diagnostics/tracingstatuschangedeventargs_tracelevel.md index bc54145fcf..343dc73bff 100644 --- a/windows.foundation.diagnostics/tracingstatuschangedeventargs_tracelevel.md +++ b/windows.foundation.diagnostics/tracingstatuschangedeventargs_tracelevel.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.TraceLevel --api-type: winrt property ---- # Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.TraceLevel ## -description Gets the trace level for the current tracing session. ## -property-value The trace level. ## -remarks ## -examples ## -see-also [TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.TraceLevel +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.TracingStatusChangedEventArgs.TraceLevel + +## -description +Gets the trace level for the current tracing session. + +## -property-value +The trace level. + +## -remarks + +## -examples + +## -see-also +[TracingStatusChanged](asynccausalitytracer_tracingstatuschanged.md) \ No newline at end of file diff --git a/windows.foundation.metadata/activatableattribute_activatableattribute_1177778147.md b/windows.foundation.metadata/activatableattribute_activatableattribute_1177778147.md index 8bc3d075f5..fe9e0a650e 100644 --- a/windows.foundation.metadata/activatableattribute_activatableattribute_1177778147.md +++ b/windows.foundation.metadata/activatableattribute_activatableattribute_1177778147.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.UInt32,Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param version The version of the class. ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also [ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(Type, UInt32, Platform)](activatableattribute_activatableattribute_708913573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.UInt32,Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param version +The version of the class. + +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also +[ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(Type, UInt32, Platform)](activatableattribute_activatableattribute_708913573.md) \ No newline at end of file diff --git a/windows.foundation.metadata/activatableattribute_activatableattribute_1447974729.md b/windows.foundation.metadata/activatableattribute_activatableattribute_1447974729.md index bf5d282f7e..7eaa844a0d 100644 --- a/windows.foundation.metadata/activatableattribute_activatableattribute_1447974729.md +++ b/windows.foundation.metadata/activatableattribute_activatableattribute_1447974729.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.Type,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type of the class. ### -param version The version of the API contract implementing the class. ### -param contractName A string representing the type of the API contract implementing the class. ## -remarks ## -examples ## -see-also [ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(UInt32, String)](activatableattribute_activatableattribute_2016725141.md), [ActivatableAttribute(UInt32, Platform)](activatableattribute_activatableattribute_1177778147.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(Type, UInt32, Platform)](activatableattribute_activatableattribute_708913573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.Type,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type of the class. + +### -param version +The version of the API contract implementing the class. + +### -param contractName +A string representing the type of the API contract implementing the class. + +## -remarks + +## -examples + +## -see-also +[ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(UInt32, String)](activatableattribute_activatableattribute_2016725141.md), [ActivatableAttribute(UInt32, Platform)](activatableattribute_activatableattribute_1177778147.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(Type, UInt32, Platform)](activatableattribute_activatableattribute_708913573.md) \ No newline at end of file diff --git a/windows.foundation.metadata/activatableattribute_activatableattribute_2016725141.md b/windows.foundation.metadata/activatableattribute_activatableattribute_2016725141.md index 8391b83b2b..e03530d6b6 100644 --- a/windows.foundation.metadata/activatableattribute_activatableattribute_2016725141.md +++ b/windows.foundation.metadata/activatableattribute_activatableattribute_2016725141.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.UInt32,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param version The version of the class. ### -param type A string representing the type of the factory interface. ## -remarks ## -examples ## -see-also [ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(UInt32, Platform)](activatableattribute_activatableattribute_1177778147.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(Type, UInt32, String)](activatableattribute_activatableattribute_1447974729.md), [ActivatableAttribute(Type, UInt32, Platform)](activatableattribute_activatableattribute_708913573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param version +The version of the class. + +### -param type +A string representing the type of the factory interface. + +## -remarks + +## -examples + +## -see-also +[ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(UInt32, Platform)](activatableattribute_activatableattribute_1177778147.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(Type, UInt32, String)](activatableattribute_activatableattribute_1447974729.md), [ActivatableAttribute(Type, UInt32, Platform)](activatableattribute_activatableattribute_708913573.md) \ No newline at end of file diff --git a/windows.foundation.metadata/activatableattribute_activatableattribute_708913573.md b/windows.foundation.metadata/activatableattribute_activatableattribute_708913573.md index 240b827fb4..271f2e4a3d 100644 --- a/windows.foundation.metadata/activatableattribute_activatableattribute_708913573.md +++ b/windows.foundation.metadata/activatableattribute_activatableattribute_708913573.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.Type,System.UInt32,Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type of the class. ### -param version The version of the class. ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also [ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(UInt32, Platform)](activatableattribute_activatableattribute_1177778147.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.Type,System.UInt32,Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type of the class. + +### -param version +The version of the class. + +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also +[ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md), [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md), [ActivatableAttribute(UInt32, Platform)](activatableattribute_activatableattribute_1177778147.md) \ No newline at end of file diff --git a/windows.foundation.metadata/activatableattribute_activatableattribute_810136521.md b/windows.foundation.metadata/activatableattribute_activatableattribute_810136521.md index ce18a5d83e..811df18d24 100644 --- a/windows.foundation.metadata/activatableattribute_activatableattribute_810136521.md +++ b/windows.foundation.metadata/activatableattribute_activatableattribute_810136521.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.Type,System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type of the class. ### -param version The version of the class. ## -remarks ## -examples ## -see-also [ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.Type,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type of the class. + +### -param version +The version of the class. + +## -remarks + +## -examples + +## -see-also +[ActivatableAttribute(UInt32)](activatableattribute_activatableattribute_885572907.md) \ No newline at end of file diff --git a/windows.foundation.metadata/activatableattribute_activatableattribute_885572907.md b/windows.foundation.metadata/activatableattribute_activatableattribute_885572907.md index 10b5555004..5ffbab64c0 100644 --- a/windows.foundation.metadata/activatableattribute_activatableattribute_885572907.md +++ b/windows.foundation.metadata/activatableattribute_activatableattribute_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param version The version of the class. ## -remarks ## -examples ## -see-also [ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ActivatableAttribute.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ActivatableAttribute.ActivatableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param version +The version of the class. + +## -remarks + +## -examples + +## -see-also +[ActivatableAttribute(Type, UInt32)](activatableattribute_activatableattribute_810136521.md) \ No newline at end of file diff --git a/windows.foundation.metadata/allowforwebattribute_allowforwebattribute_1221375020.md b/windows.foundation.metadata/allowforwebattribute_allowforwebattribute_1221375020.md index d7ec1f0c87..746b4eff0e 100644 --- a/windows.foundation.metadata/allowforwebattribute_allowforwebattribute_1221375020.md +++ b/windows.foundation.metadata/allowforwebattribute_allowforwebattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.AllowForWebAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.AllowForWebAttribute.AllowForWebAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.AllowForWebAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.AllowForWebAttribute.AllowForWebAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/allowmultipleattribute_allowmultipleattribute_1221375020.md b/windows.foundation.metadata/allowmultipleattribute_allowmultipleattribute_1221375020.md index ac7ef9a557..41f477f0d8 100644 --- a/windows.foundation.metadata/allowmultipleattribute_allowmultipleattribute_1221375020.md +++ b/windows.foundation.metadata/allowmultipleattribute_allowmultipleattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.AllowMultipleAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.AllowMultipleAttribute.AllowMultipleAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.AllowMultipleAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.AllowMultipleAttribute.AllowMultipleAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation.md b/windows.foundation.metadata/apiinformation.md index 7ae02af845..4faa84a898 100644 --- a/windows.foundation.metadata/apiinformation.md +++ b/windows.foundation.metadata/apiinformation.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Foundation.Metadata.ApiInformation --api-type: winrt class ---- # Windows.Foundation.Metadata.ApiInformation ## -description Enables you to detect whether a specified member, type, or API contract is present so that you can safely make API calls across a variety of devices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Metadata.ApiInformation +-api-type: winrt class +--- + + + +# Windows.Foundation.Metadata.ApiInformation + +## -description +Enables you to detect whether a specified member, type, or API contract is present so that you can safely make API calls across a variety of devices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation_isapicontractpresent_1836214132.md b/windows.foundation.metadata/apiinformation_isapicontractpresent_1836214132.md index 6763819d8c..b1dafc6504 100644 --- a/windows.foundation.metadata/apiinformation_isapicontractpresent_1836214132.md +++ b/windows.foundation.metadata/apiinformation_isapicontractpresent_1836214132.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent(System.String,System.UInt16) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent ## -description Returns true or false to indicate whether the API contract with the specified name and major version number is present. ## -parameters ### -param contractName The name of the API contract. ### -param majorVersion The major version number of the API contract. ## -returns **True** if the specified API contract is present; otherwise, **false**. ## -remarks ## -examples ## -see-also [IsApiContractPresent(String, UInt16, UInt16)](apiinformation_isapicontractpresent_642491256.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent(System.String,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent + +## -description +Returns true or false to indicate whether the API contract with the specified name and major version number is present. + +## -parameters +### -param contractName +The name of the API contract. + +### -param majorVersion +The major version number of the API contract. + +## -returns +**True** if the specified API contract is present; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[IsApiContractPresent(String, UInt16, UInt16)](apiinformation_isapicontractpresent_642491256.md) \ No newline at end of file diff --git a/windows.foundation.metadata/apiinformation_isapicontractpresent_642491256.md b/windows.foundation.metadata/apiinformation_isapicontractpresent_642491256.md index 2d20ff876b..1e50c5362d 100644 --- a/windows.foundation.metadata/apiinformation_isapicontractpresent_642491256.md +++ b/windows.foundation.metadata/apiinformation_isapicontractpresent_642491256.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent(System.String,System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent ## -description Returns true or false to indicate whether the API contract with the specified name and major and minor version number is present. ## -parameters ### -param contractName The name of the API contract. ### -param majorVersion The major version number of the API contract. ### -param minorVersion The minor version number of the API contract. ## -returns **True** if the specified API contract is present; otherwise, **false**. ## -remarks ## -examples ## -see-also [IsApiContractPresent(String, UInt16)](apiinformation_isapicontractpresent_1836214132.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent(System.String,System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsApiContractPresent + +## -description +Returns true or false to indicate whether the API contract with the specified name and major and minor version number is present. + +## -parameters +### -param contractName +The name of the API contract. + +### -param majorVersion +The major version number of the API contract. + +### -param minorVersion +The minor version number of the API contract. + +## -returns +**True** if the specified API contract is present; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[IsApiContractPresent(String, UInt16)](apiinformation_isapicontractpresent_1836214132.md) \ No newline at end of file diff --git a/windows.foundation.metadata/apiinformation_isenumnamedvaluepresent_1999014422.md b/windows.foundation.metadata/apiinformation_isenumnamedvaluepresent_1999014422.md index 2a29a6517d..7bb0f9f04f 100644 --- a/windows.foundation.metadata/apiinformation_isenumnamedvaluepresent_1999014422.md +++ b/windows.foundation.metadata/apiinformation_isenumnamedvaluepresent_1999014422.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsEnumNamedValuePresent(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsEnumNamedValuePresent ## -description Returns true or false to indicate whether a specified named constant is present for a specified enumeration. ## -parameters ### -param enumTypeName The namespace-qualified name of the type. ### -param valueName The name of the constant. ## -returns **True** if the specified constant is present; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsEnumNamedValuePresent(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsEnumNamedValuePresent + +## -description +Returns true or false to indicate whether a specified named constant is present for a specified enumeration. + +## -parameters +### -param enumTypeName +The namespace-qualified name of the type. + +### -param valueName +The name of the constant. + +## -returns +**True** if the specified constant is present; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation_iseventpresent_1406163026.md b/windows.foundation.metadata/apiinformation_iseventpresent_1406163026.md index 98ee4289eb..230759c00b 100644 --- a/windows.foundation.metadata/apiinformation_iseventpresent_1406163026.md +++ b/windows.foundation.metadata/apiinformation_iseventpresent_1406163026.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsEventPresent(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsEventPresent ## -description Returns true or false to indicate whether a specified event is present for a specified type. ## -parameters ### -param typeName The namespace-qualified name of the type. ### -param eventName The name of the event. ## -returns **True** if the specified event is present for the type; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsEventPresent(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsEventPresent + +## -description +Returns true or false to indicate whether a specified event is present for a specified type. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +### -param eventName +The name of the event. + +## -returns +**True** if the specified event is present for the type; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation_ismethodpresent_1062983651.md b/windows.foundation.metadata/apiinformation_ismethodpresent_1062983651.md index d6b09d37cf..4b1caccc22 100644 --- a/windows.foundation.metadata/apiinformation_ismethodpresent_1062983651.md +++ b/windows.foundation.metadata/apiinformation_ismethodpresent_1062983651.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsMethodPresent(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsMethodPresent ## -description Returns true or false to indicate whether a specified method is present for a specified type. ## -parameters ### -param typeName The namespace-qualified name of the type. ### -param methodName The name of the method. ## -returns **True** if the specified method is present for the type; otherwise, **false**. ## -remarks ## -examples ## -see-also [IsMethodPresent(String, String, UInt32)](apiinformation_ismethodpresent_817228807.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsMethodPresent(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsMethodPresent + +## -description +Returns true or false to indicate whether a specified method is present for a specified type. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +### -param methodName +The name of the method. + +## -returns +**True** if the specified method is present for the type; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[IsMethodPresent(String, String, UInt32)](apiinformation_ismethodpresent_817228807.md) \ No newline at end of file diff --git a/windows.foundation.metadata/apiinformation_ismethodpresent_817228807.md b/windows.foundation.metadata/apiinformation_ismethodpresent_817228807.md index 8c3ab41204..e123a1e297 100644 --- a/windows.foundation.metadata/apiinformation_ismethodpresent_817228807.md +++ b/windows.foundation.metadata/apiinformation_ismethodpresent_817228807.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsMethodPresent(System.String,System.String,System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsMethodPresent ## -description Returns true or false to indicate whether a specified method overload with the specified number of input parameters is present for a specified type. ## -parameters ### -param typeName The namespace-qualified name of the type. ### -param methodName The name of the method. ### -param inputParameterCount The number of input parameters for the overload. ## -returns **True** if the specified method is present for the type; otherwise, **false**. ## -remarks ## -examples ## -see-also [IsMethodPresent(String, String)](apiinformation_ismethodpresent_1062983651.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsMethodPresent(System.String,System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsMethodPresent + +## -description +Returns true or false to indicate whether a specified method overload with the specified number of input parameters is present for a specified type. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +### -param methodName +The name of the method. + +### -param inputParameterCount +The number of input parameters for the overload. + +## -returns +**True** if the specified method is present for the type; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[IsMethodPresent(String, String)](apiinformation_ismethodpresent_1062983651.md) \ No newline at end of file diff --git a/windows.foundation.metadata/apiinformation_ispropertypresent_963133031.md b/windows.foundation.metadata/apiinformation_ispropertypresent_963133031.md index 61d3af2f97..e9e0da2e1e 100644 --- a/windows.foundation.metadata/apiinformation_ispropertypresent_963133031.md +++ b/windows.foundation.metadata/apiinformation_ispropertypresent_963133031.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsPropertyPresent(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsPropertyPresent ## -description Returns true or false to indicate whether a specified property (writeable or read-only) is present for a specified type. ## -parameters ### -param typeName The namespace-qualified name of the type. ### -param propertyName The name of the property. ## -returns **True** if the specified property is present for the type; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsPropertyPresent(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsPropertyPresent + +## -description +Returns true or false to indicate whether a specified property (writeable or read-only) is present for a specified type. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +### -param propertyName +The name of the property. + +## -returns +**True** if the specified property is present for the type; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation_isreadonlypropertypresent_335242451.md b/windows.foundation.metadata/apiinformation_isreadonlypropertypresent_335242451.md index 8a81a857b3..3ab5aef400 100644 --- a/windows.foundation.metadata/apiinformation_isreadonlypropertypresent_335242451.md +++ b/windows.foundation.metadata/apiinformation_isreadonlypropertypresent_335242451.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsReadOnlyPropertyPresent(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsReadOnlyPropertyPresent ## -description Returns true or false to indicate whether a specified read-only property is present for a specified type. ## -parameters ### -param typeName The namespace-qualified name of the type. ### -param propertyName The name of the property. ## -returns **True** if the specified property is present for the type; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsReadOnlyPropertyPresent(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsReadOnlyPropertyPresent + +## -description +Returns true or false to indicate whether a specified read-only property is present for a specified type. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +### -param propertyName +The name of the property. + +## -returns +**True** if the specified property is present for the type; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation_istypepresent_1798021685.md b/windows.foundation.metadata/apiinformation_istypepresent_1798021685.md index eae7857e08..81d2fe3595 100644 --- a/windows.foundation.metadata/apiinformation_istypepresent_1798021685.md +++ b/windows.foundation.metadata/apiinformation_istypepresent_1798021685.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsTypePresent(System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsTypePresent ## -description Returns true or false to indicate whether a specified type is present. ## -parameters ### -param typeName The namespace-qualified name of the type. ## -returns **True** if the specified type is present; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsTypePresent(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsTypePresent + +## -description +Returns true or false to indicate whether a specified type is present. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +## -returns +**True** if the specified type is present; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/apiinformation_iswriteablepropertypresent_1126745662.md b/windows.foundation.metadata/apiinformation_iswriteablepropertypresent_1126745662.md index 7998a16459..70b236d46d 100644 --- a/windows.foundation.metadata/apiinformation_iswriteablepropertypresent_1126745662.md +++ b/windows.foundation.metadata/apiinformation_iswriteablepropertypresent_1126745662.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.Metadata.ApiInformation.IsWriteablePropertyPresent(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ApiInformation.IsWriteablePropertyPresent ## -description Returns true or false to indicate whether a specified writeable property is present for a specified type. ## -parameters ### -param typeName The namespace-qualified name of the type. ### -param propertyName The name of the property. ## -returns **True** if the specified property is present for the type; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ApiInformation.IsWriteablePropertyPresent(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiInformation.IsWriteablePropertyPresent + +## -description +Returns true or false to indicate whether a specified writeable property is present for a specified type. + +## -parameters +### -param typeName +The namespace-qualified name of the type. + +### -param propertyName +The name of the property. + +## -returns +**True** if the specified property is present for the type; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/attributeusageattribute_attributeusageattribute_2016212745.md b/windows.foundation.metadata/attributeusageattribute_attributeusageattribute_2016212745.md index e5480e35f7..aee15ac56b 100644 --- a/windows.foundation.metadata/attributeusageattribute_attributeusageattribute_2016212745.md +++ b/windows.foundation.metadata/attributeusageattribute_attributeusageattribute_2016212745.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.AttributeUsageAttribute.#ctor(Windows.Foundation.Metadata.AttributeTargets) --api-type: winrt method ---- # Windows.Foundation.Metadata.AttributeUsageAttribute.AttributeUsageAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param A_0 One or more of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.AttributeUsageAttribute.#ctor(Windows.Foundation.Metadata.AttributeTargets) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.AttributeUsageAttribute.AttributeUsageAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param A_0 +One or more of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/composableattribute_composableattribute_1123439749.md b/windows.foundation.metadata/composableattribute_composableattribute_1123439749.md index 73ed87e16b..9509c57ed7 100644 --- a/windows.foundation.metadata/composableattribute_composableattribute_1123439749.md +++ b/windows.foundation.metadata/composableattribute_composableattribute_1123439749.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Metadata.ComposableAttribute.#ctor(System.Type,Windows.Foundation.Metadata.CompositionType,System.UInt32,Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.ComposableAttribute.ComposableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type of the factory object that is used to create the programming element. ### -param compositionType One of the enumeration values. ### -param version The version. ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also [ComposableAttribute(Type, CompositionType, UInt32)](composableattribute_composableattribute_1994874973.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ComposableAttribute.#ctor(System.Type,Windows.Foundation.Metadata.CompositionType,System.UInt32,Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ComposableAttribute.ComposableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type of the factory object that is used to create the programming element. + +### -param compositionType +One of the enumeration values. + +### -param version +The version. + +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also +[ComposableAttribute(Type, CompositionType, UInt32)](composableattribute_composableattribute_1994874973.md) \ No newline at end of file diff --git a/windows.foundation.metadata/composableattribute_composableattribute_1159157411.md b/windows.foundation.metadata/composableattribute_composableattribute_1159157411.md index 8807d2af30..15a1c099bf 100644 --- a/windows.foundation.metadata/composableattribute_composableattribute_1159157411.md +++ b/windows.foundation.metadata/composableattribute_composableattribute_1159157411.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Metadata.ComposableAttribute.#ctor(System.Type,Windows.Foundation.Metadata.CompositionType,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.ComposableAttribute.ComposableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type of the factory object that is used to create the programming element. ### -param compositionType One of the enumeration values. ### -param version The version of the API contract in which the composition factory was added to the runtime class's activation factory. ### -param contract A string representing the type of the API contract implementing the class. ## -remarks ## -examples ## -see-also [ComposableAttribute(Type, CompositionType, UInt32)](composableattribute_composableattribute_1994874973.md), [ComposableAttribute(Type, CompositionType, UInt32, Platform)](composableattribute_composableattribute_1123439749.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ComposableAttribute.#ctor(System.Type,Windows.Foundation.Metadata.CompositionType,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ComposableAttribute.ComposableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type of the factory object that is used to create the programming element. + +### -param compositionType +One of the enumeration values. + +### -param version +The version of the API contract in which the composition factory was added to the runtime class's activation factory. + +### -param contract +A string representing the type of the API contract implementing the class. + +## -remarks + +## -examples + +## -see-also +[ComposableAttribute(Type, CompositionType, UInt32)](composableattribute_composableattribute_1994874973.md), [ComposableAttribute(Type, CompositionType, UInt32, Platform)](composableattribute_composableattribute_1123439749.md) \ No newline at end of file diff --git a/windows.foundation.metadata/composableattribute_composableattribute_1994874973.md b/windows.foundation.metadata/composableattribute_composableattribute_1994874973.md index 5ec5c358ee..cd2c123b4d 100644 --- a/windows.foundation.metadata/composableattribute_composableattribute_1994874973.md +++ b/windows.foundation.metadata/composableattribute_composableattribute_1994874973.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.ComposableAttribute.#ctor(System.Type,Windows.Foundation.Metadata.CompositionType,System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.ComposableAttribute.ComposableAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type of the factory object that is used to create the programming element. ### -param compositionType One of the enumeration values. ### -param version The version. ## -remarks ## -examples ## -see-also [ComposableAttribute(Type, CompositionType, UInt32, Platform)](composableattribute_composableattribute_1123439749.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ComposableAttribute.#ctor(System.Type,Windows.Foundation.Metadata.CompositionType,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ComposableAttribute.ComposableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type of the factory object that is used to create the programming element. + +### -param compositionType +One of the enumeration values. + +### -param version +The version. + +## -remarks + +## -examples + +## -see-also +[ComposableAttribute(Type, CompositionType, UInt32, Platform)](composableattribute_composableattribute_1123439749.md) \ No newline at end of file diff --git a/windows.foundation.metadata/createfromstringattribute_createfromstringattribute_1221375020.md b/windows.foundation.metadata/createfromstringattribute_createfromstringattribute_1221375020.md index 2d36be69e9..81e8511ebd 100644 --- a/windows.foundation.metadata/createfromstringattribute_createfromstringattribute_1221375020.md +++ b/windows.foundation.metadata/createfromstringattribute_createfromstringattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.CreateFromStringAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.CreateFromStringAttribute.CreateFromStringAttribute ## -description Create from string attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.CreateFromStringAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.CreateFromStringAttribute.CreateFromStringAttribute + +## -description +Create from string attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/defaultattribute_defaultattribute_1221375020.md b/windows.foundation.metadata/defaultattribute_defaultattribute_1221375020.md index 01b340291a..18bf22282b 100644 --- a/windows.foundation.metadata/defaultattribute_defaultattribute_1221375020.md +++ b/windows.foundation.metadata/defaultattribute_defaultattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.DefaultAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.DefaultAttribute.DefaultAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.DefaultAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.DefaultAttribute.DefaultAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/defaultoverloadattribute_defaultoverloadattribute_1221375020.md b/windows.foundation.metadata/defaultoverloadattribute_defaultoverloadattribute_1221375020.md index 8afafbd74a..0e16a9e5c1 100644 --- a/windows.foundation.metadata/defaultoverloadattribute_defaultoverloadattribute_1221375020.md +++ b/windows.foundation.metadata/defaultoverloadattribute_defaultoverloadattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.DefaultOverloadAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.DefaultOverloadAttribute.DefaultOverloadAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.DefaultOverloadAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.DefaultOverloadAttribute.DefaultOverloadAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1103216178.md b/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1103216178.md index 4cfa815cfb..0c7afc93ee 100644 --- a/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1103216178.md +++ b/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1103216178.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Metadata.DeprecatedAttribute.#ctor(System.String,Windows.Foundation.Metadata.DeprecationType,System.UInt32,Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.DeprecatedAttribute.DeprecatedAttribute ## -description Creates and initializes a new instance of the attribute, including a [Platform](platform.md) value for targeting. ## -parameters ### -param message A string message that can be used by compilers and other developer tools to explain the deprecation and provide the string names of alternate API. ### -param type A value of the enumeration. The default is **Deprecate**. ### -param version A constant that indicates the version that the deprecation applies to. ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also [DeprecatedAttribute(String, DeprecationType, UInt32)](deprecatedattribute_deprecatedattribute_1976601322.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.DeprecatedAttribute.#ctor(System.String,Windows.Foundation.Metadata.DeprecationType,System.UInt32,Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.DeprecatedAttribute.DeprecatedAttribute + +## -description +Creates and initializes a new instance of the attribute, including a [Platform](platform.md) value for targeting. + +## -parameters +### -param message +A string message that can be used by compilers and other developer tools to explain the deprecation and provide the string names of alternate API. + +### -param type +A value of the enumeration. The default is **Deprecate**. + +### -param version +A constant that indicates the version that the deprecation applies to. + +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also +[DeprecatedAttribute(String, DeprecationType, UInt32)](deprecatedattribute_deprecatedattribute_1976601322.md) \ No newline at end of file diff --git a/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1176550422.md b/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1176550422.md index 12f6dce547..20d9b9e9e4 100644 --- a/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1176550422.md +++ b/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1176550422.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Foundation.Metadata.DeprecatedAttribute.#ctor(System.String,Windows.Foundation.Metadata.DeprecationType,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.DeprecatedAttribute.DeprecatedAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param message A string message that can be used by compilers and other developer tools to explain the deprecation and provide the string names of alternate API. ### -param type A value of the enumeration. The default is **Deprecate**. ### -param version A constant that indicates the version that the deprecation applies to. ### -param contract A string representing the type of the API contract implementing the deprecated type or member. ## -remarks ## -examples ## -see-also [DeprecatedAttribute(String, DeprecationType, UInt32)](deprecatedattribute_deprecatedattribute_1976601322.md), [DeprecatedAttribute(String, DeprecationType, UInt32, Platform)](deprecatedattribute_deprecatedattribute_1103216178.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.DeprecatedAttribute.#ctor(System.String,Windows.Foundation.Metadata.DeprecationType,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.DeprecatedAttribute.DeprecatedAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param message +A string message that can be used by compilers and other developer tools to explain the deprecation and provide the string names of alternate API. + +### -param type +A value of the enumeration. The default is **Deprecate**. + +### -param version +A constant that indicates the version that the deprecation applies to. + +### -param contract +A string representing the type of the API contract implementing the deprecated type or member. + +## -remarks + +## -examples + +## -see-also +[DeprecatedAttribute(String, DeprecationType, UInt32)](deprecatedattribute_deprecatedattribute_1976601322.md), [DeprecatedAttribute(String, DeprecationType, UInt32, Platform)](deprecatedattribute_deprecatedattribute_1103216178.md) \ No newline at end of file diff --git a/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1976601322.md b/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1976601322.md index d4941c8eaa..392e3d40b9 100644 --- a/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1976601322.md +++ b/windows.foundation.metadata/deprecatedattribute_deprecatedattribute_1976601322.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.DeprecatedAttribute.#ctor(System.String,Windows.Foundation.Metadata.DeprecationType,System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.DeprecatedAttribute.DeprecatedAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param message A string message that can be used by compilers and other developer tools to explain the deprecation and provide the string names of alternate API. ### -param type A value of the enumeration. The default is **Deprecate**. ### -param version A constant that indicates the version that the deprecation applies to. ## -remarks ## -examples ## -see-also [DeprecatedAttribute(String, DeprecationType, UInt32, Platform)](deprecatedattribute_deprecatedattribute_1103216178.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.DeprecatedAttribute.#ctor(System.String,Windows.Foundation.Metadata.DeprecationType,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.DeprecatedAttribute.DeprecatedAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param message +A string message that can be used by compilers and other developer tools to explain the deprecation and provide the string names of alternate API. + +### -param type +A value of the enumeration. The default is **Deprecate**. + +### -param version +A constant that indicates the version that the deprecation applies to. + +## -remarks + +## -examples + +## -see-also +[DeprecatedAttribute(String, DeprecationType, UInt32, Platform)](deprecatedattribute_deprecatedattribute_1103216178.md) \ No newline at end of file diff --git a/windows.foundation.metadata/dualapipartitionattribute_dualapipartitionattribute_1221375020.md b/windows.foundation.metadata/dualapipartitionattribute_dualapipartitionattribute_1221375020.md index 4d0c7e8f51..0626774571 100644 --- a/windows.foundation.metadata/dualapipartitionattribute_dualapipartitionattribute_1221375020.md +++ b/windows.foundation.metadata/dualapipartitionattribute_dualapipartitionattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.DualApiPartitionAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.DualApiPartitionAttribute.DualApiPartitionAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.DualApiPartitionAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.DualApiPartitionAttribute.DualApiPartitionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/exclusivetoattribute_exclusivetoattribute_935243323.md b/windows.foundation.metadata/exclusivetoattribute_exclusivetoattribute_935243323.md index b20cf8bfd8..fd67011831 100644 --- a/windows.foundation.metadata/exclusivetoattribute_exclusivetoattribute_935243323.md +++ b/windows.foundation.metadata/exclusivetoattribute_exclusivetoattribute_935243323.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.ExclusiveToAttribute.#ctor(System.Type) --api-type: winrt method ---- # Windows.Foundation.Metadata.ExclusiveToAttribute.ExclusiveToAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param typeName The name of the type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ExclusiveToAttribute.#ctor(System.Type) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ExclusiveToAttribute.ExclusiveToAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param typeName +The name of the type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/experimentalattribute_experimentalattribute_1221375020.md b/windows.foundation.metadata/experimentalattribute_experimentalattribute_1221375020.md index 852f16fb02..cc8f6ea25c 100644 --- a/windows.foundation.metadata/experimentalattribute_experimentalattribute_1221375020.md +++ b/windows.foundation.metadata/experimentalattribute_experimentalattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.ExperimentalAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.ExperimentalAttribute.ExperimentalAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ExperimentalAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ExperimentalAttribute.ExperimentalAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/gcpressureattribute_gcpressureattribute_1221375020.md b/windows.foundation.metadata/gcpressureattribute_gcpressureattribute_1221375020.md index e7bde5e6f3..c1c992d2f0 100644 --- a/windows.foundation.metadata/gcpressureattribute_gcpressureattribute_1221375020.md +++ b/windows.foundation.metadata/gcpressureattribute_gcpressureattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.GCPressureAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.GCPressureAttribute.GCPressureAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.GCPressureAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.GCPressureAttribute.GCPressureAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/guidattribute_guidattribute_1914846029.md b/windows.foundation.metadata/guidattribute_guidattribute_1914846029.md index 8217870d7f..9d0f2564f0 100644 --- a/windows.foundation.metadata/guidattribute_guidattribute_1914846029.md +++ b/windows.foundation.metadata/guidattribute_guidattribute_1914846029.md @@ -1,3 +1,53 @@ ---- -api-id: M:Windows.Foundation.Metadata.GuidAttribute.#ctor(System.UInt32,System.UInt16,System.UInt16,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte) --api-type: winrt method ---- # Windows.Foundation.Metadata.GuidAttribute.GuidAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param a The first 4 bytes of the GUID. ### -param b The next 2 bytes of the GUID. ### -param c The next 2 bytes of the GUID. ### -param d The next byte of the GUID. ### -param e The next byte of the GUID. ### -param f The next byte of the GUID. ### -param g The next byte of the GUID. ### -param h The next byte of the GUID. ### -param i The next byte of the GUID. ### -param j The next byte of the GUID. ### -param k The next byte of the GUID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.GuidAttribute.#ctor(System.UInt32,System.UInt16,System.UInt16,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte,System.Byte) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.GuidAttribute.GuidAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param a +The first 4 bytes of the GUID. + +### -param b +The next 2 bytes of the GUID. + +### -param c +The next 2 bytes of the GUID. + +### -param d +The next byte of the GUID. + +### -param e +The next byte of the GUID. + +### -param f +The next byte of the GUID. + +### -param g +The next byte of the GUID. + +### -param h +The next byte of the GUID. + +### -param i +The next byte of the GUID. + +### -param j +The next byte of the GUID. + +### -param k +The next byte of the GUID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/hasvariantattribute_hasvariantattribute_1221375020.md b/windows.foundation.metadata/hasvariantattribute_hasvariantattribute_1221375020.md index 8699511c23..22624fb7c5 100644 --- a/windows.foundation.metadata/hasvariantattribute_hasvariantattribute_1221375020.md +++ b/windows.foundation.metadata/hasvariantattribute_hasvariantattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.HasVariantAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.HasVariantAttribute.HasVariantAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.HasVariantAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.HasVariantAttribute.HasVariantAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/internalattribute_internalattribute_1221375020.md b/windows.foundation.metadata/internalattribute_internalattribute_1221375020.md index dc40a8578b..4c5640b333 100644 --- a/windows.foundation.metadata/internalattribute_internalattribute_1221375020.md +++ b/windows.foundation.metadata/internalattribute_internalattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.InternalAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.InternalAttribute.InternalAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.InternalAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.InternalAttribute.InternalAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/lengthisattribute_lengthisattribute_745845612.md b/windows.foundation.metadata/lengthisattribute_lengthisattribute_745845612.md index d8fdc01ba5..28cacedbeb 100644 --- a/windows.foundation.metadata/lengthisattribute_lengthisattribute_745845612.md +++ b/windows.foundation.metadata/lengthisattribute_lengthisattribute_745845612.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.LengthIsAttribute.#ctor(System.Int32) --api-type: winrt method ---- # Windows.Foundation.Metadata.LengthIsAttribute.LengthIsAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param indexLengthParameter The number of array elements. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.LengthIsAttribute.#ctor(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.LengthIsAttribute.LengthIsAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param indexLengthParameter +The number of array elements. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/marshalingbehaviorattribute_marshalingbehaviorattribute_1487269172.md b/windows.foundation.metadata/marshalingbehaviorattribute_marshalingbehaviorattribute_1487269172.md index 386ad25d45..ff5dd1d254 100644 --- a/windows.foundation.metadata/marshalingbehaviorattribute_marshalingbehaviorattribute_1487269172.md +++ b/windows.foundation.metadata/marshalingbehaviorattribute_marshalingbehaviorattribute_1487269172.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.MarshalingBehaviorAttribute.#ctor(Windows.Foundation.Metadata.MarshalingType) --api-type: winrt method ---- # Windows.Foundation.Metadata.MarshalingBehaviorAttribute.MarshalingBehaviorAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param behavior One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.MarshalingBehaviorAttribute.#ctor(Windows.Foundation.Metadata.MarshalingType) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.MarshalingBehaviorAttribute.MarshalingBehaviorAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param behavior +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/metadatamarshalattribute_metadatamarshalattribute_1221375020.md b/windows.foundation.metadata/metadatamarshalattribute_metadatamarshalattribute_1221375020.md index 53b387cfdf..d4ae14b0a9 100644 --- a/windows.foundation.metadata/metadatamarshalattribute_metadatamarshalattribute_1221375020.md +++ b/windows.foundation.metadata/metadatamarshalattribute_metadatamarshalattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.MetadataMarshalAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.MetadataMarshalAttribute.MetadataMarshalAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.MetadataMarshalAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.MetadataMarshalAttribute.MetadataMarshalAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/museattribute_museattribute_1221375020.md b/windows.foundation.metadata/museattribute_museattribute_1221375020.md index 53b9dabcda..9a041cd402 100644 --- a/windows.foundation.metadata/museattribute_museattribute_1221375020.md +++ b/windows.foundation.metadata/museattribute_museattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.MuseAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.MuseAttribute.MuseAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.MuseAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.MuseAttribute.MuseAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/overloadattribute_overloadattribute_290278668.md b/windows.foundation.metadata/overloadattribute_overloadattribute_290278668.md index d582b2b108..ae6f4dbef6 100644 --- a/windows.foundation.metadata/overloadattribute_overloadattribute_290278668.md +++ b/windows.foundation.metadata/overloadattribute_overloadattribute_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.OverloadAttribute.#ctor(System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.OverloadAttribute.OverloadAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param method The name that represents the method in the projected language. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.OverloadAttribute.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.OverloadAttribute.OverloadAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param method +The name that represents the method in the projected language. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/overridableattribute_overridableattribute_1221375020.md b/windows.foundation.metadata/overridableattribute_overridableattribute_1221375020.md index f029d3c0ad..e809baeb38 100644 --- a/windows.foundation.metadata/overridableattribute_overridableattribute_1221375020.md +++ b/windows.foundation.metadata/overridableattribute_overridableattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.OverridableAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.OverridableAttribute.OverridableAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.OverridableAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.OverridableAttribute.OverridableAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/platformattribute_platformattribute_1907453257.md b/windows.foundation.metadata/platformattribute_platformattribute_1907453257.md index 4883673efa..29ebf66927 100644 --- a/windows.foundation.metadata/platformattribute_platformattribute_1907453257.md +++ b/windows.foundation.metadata/platformattribute_platformattribute_1907453257.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.PlatformAttribute.#ctor(Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.PlatformAttribute.PlatformAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.PlatformAttribute.#ctor(Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.PlatformAttribute.PlatformAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/protectedattribute_protectedattribute_1221375020.md b/windows.foundation.metadata/protectedattribute_protectedattribute_1221375020.md index 8fc396b225..018158007a 100644 --- a/windows.foundation.metadata/protectedattribute_protectedattribute_1221375020.md +++ b/windows.foundation.metadata/protectedattribute_protectedattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.ProtectedAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.ProtectedAttribute.ProtectedAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ProtectedAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ProtectedAttribute.ProtectedAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/rangeattribute_rangeattribute_452674076.md b/windows.foundation.metadata/rangeattribute_rangeattribute_452674076.md index e58436ee28..3f02a13c04 100644 --- a/windows.foundation.metadata/rangeattribute_rangeattribute_452674076.md +++ b/windows.foundation.metadata/rangeattribute_rangeattribute_452674076.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Metadata.RangeAttribute.#ctor(System.Int32,System.Int32) --api-type: winrt method ---- # Windows.Foundation.Metadata.RangeAttribute.RangeAttribute ## -description Creates and initializes a new instance of the attribute with the specified minimum and maximum values. ## -parameters ### -param minValue The minimum value allowed. ### -param maxValue The maximum value allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.RangeAttribute.#ctor(System.Int32,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.RangeAttribute.RangeAttribute + +## -description +Creates and initializes a new instance of the attribute with the specified minimum and maximum values. + +## -parameters +### -param minValue +The minimum value allowed. + +### -param maxValue +The maximum value allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/remoteasyncattribute_remoteasyncattribute_1221375020.md b/windows.foundation.metadata/remoteasyncattribute_remoteasyncattribute_1221375020.md index 336b75af72..4b7ca9ce44 100644 --- a/windows.foundation.metadata/remoteasyncattribute_remoteasyncattribute_1221375020.md +++ b/windows.foundation.metadata/remoteasyncattribute_remoteasyncattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.RemoteAsyncAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.RemoteAsyncAttribute.RemoteAsyncAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.RemoteAsyncAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.RemoteAsyncAttribute.RemoteAsyncAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/staticattribute_staticattribute_1447974729.md b/windows.foundation.metadata/staticattribute_staticattribute_1447974729.md index f05b34099e..8979d179c2 100644 --- a/windows.foundation.metadata/staticattribute_staticattribute_1447974729.md +++ b/windows.foundation.metadata/staticattribute_staticattribute_1447974729.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.StaticAttribute.#ctor(System.Type,System.UInt32,System.String) --api-type: winrt method ---- # Windows.Foundation.Metadata.StaticAttribute.StaticAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type that contains the static methods for the runtime class. ### -param version The version of the API Contract in which the static factory was added to the runtime class's activation factory. ### -param contractName A string representing the type of the API contract implementing the class. ## -remarks ## -examples ## -see-also [StaticAttribute(Type, UInt32)](staticattribute_staticattribute_810136521.md), [StaticAttribute(Type, UInt32, Platform)](staticattribute_staticattribute_708913573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.StaticAttribute.#ctor(System.Type,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.StaticAttribute.StaticAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type that contains the static methods for the runtime class. + +### -param version +The version of the API Contract in which the static factory was added to the runtime class's activation factory. + +### -param contractName +A string representing the type of the API contract implementing the class. + +## -remarks + +## -examples + +## -see-also +[StaticAttribute(Type, UInt32)](staticattribute_staticattribute_810136521.md), [StaticAttribute(Type, UInt32, Platform)](staticattribute_staticattribute_708913573.md) \ No newline at end of file diff --git a/windows.foundation.metadata/staticattribute_staticattribute_708913573.md b/windows.foundation.metadata/staticattribute_staticattribute_708913573.md index 42f1c5bda2..f807bb0a5d 100644 --- a/windows.foundation.metadata/staticattribute_staticattribute_708913573.md +++ b/windows.foundation.metadata/staticattribute_staticattribute_708913573.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Metadata.StaticAttribute.#ctor(System.Type,System.UInt32,Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.StaticAttribute.StaticAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type that contains the static methods for the runtime class. ### -param version The version in which the static interface was added. ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also [StaticAttribute(Type, UInt32)](staticattribute_staticattribute_810136521.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.StaticAttribute.#ctor(System.Type,System.UInt32,Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.StaticAttribute.StaticAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type that contains the static methods for the runtime class. + +### -param version +The version in which the static interface was added. + +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also +[StaticAttribute(Type, UInt32)](staticattribute_staticattribute_810136521.md) \ No newline at end of file diff --git a/windows.foundation.metadata/staticattribute_staticattribute_810136521.md b/windows.foundation.metadata/staticattribute_staticattribute_810136521.md index 9c8fe10cf4..2f3d476c01 100644 --- a/windows.foundation.metadata/staticattribute_staticattribute_810136521.md +++ b/windows.foundation.metadata/staticattribute_staticattribute_810136521.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Metadata.StaticAttribute.#ctor(System.Type,System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.StaticAttribute.StaticAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param type The type that contains the static methods for the runtime class. ### -param version The version in which the static interface was added. ## -remarks ## -examples ## -see-also [StaticAttribute(Type, UInt32, Platform)](staticattribute_staticattribute_708913573.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.StaticAttribute.#ctor(System.Type,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.StaticAttribute.StaticAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param type +The type that contains the static methods for the runtime class. + +### -param version +The version in which the static interface was added. + +## -remarks + +## -examples + +## -see-also +[StaticAttribute(Type, UInt32, Platform)](staticattribute_staticattribute_708913573.md) \ No newline at end of file diff --git a/windows.foundation.metadata/threadingattribute_threadingattribute_1386845572.md b/windows.foundation.metadata/threadingattribute_threadingattribute_1386845572.md index 1fabab636e..13ca06f029 100644 --- a/windows.foundation.metadata/threadingattribute_threadingattribute_1386845572.md +++ b/windows.foundation.metadata/threadingattribute_threadingattribute_1386845572.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Metadata.ThreadingAttribute.#ctor(Windows.Foundation.Metadata.ThreadingModel) --api-type: winrt method ---- # Windows.Foundation.Metadata.ThreadingAttribute.ThreadingAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param model One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.ThreadingAttribute.#ctor(Windows.Foundation.Metadata.ThreadingModel) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ThreadingAttribute.ThreadingAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param model +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/variantattribute_variantattribute_1221375020.md b/windows.foundation.metadata/variantattribute_variantattribute_1221375020.md index 9df595cf0a..355082deec 100644 --- a/windows.foundation.metadata/variantattribute_variantattribute_1221375020.md +++ b/windows.foundation.metadata/variantattribute_variantattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.VariantAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.VariantAttribute.VariantAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.VariantAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.VariantAttribute.VariantAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation.metadata/versionattribute_versionattribute_1177778147.md b/windows.foundation.metadata/versionattribute_versionattribute_1177778147.md index e33ca40d63..b95536f639 100644 --- a/windows.foundation.metadata/versionattribute_versionattribute_1177778147.md +++ b/windows.foundation.metadata/versionattribute_versionattribute_1177778147.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Metadata.VersionAttribute.#ctor(System.UInt32,Windows.Foundation.Metadata.Platform) --api-type: winrt method ---- # Windows.Foundation.Metadata.VersionAttribute.VersionAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param version The version to associate with the marked object. ### -param platform A value of the enumeration. The default is **Windows**. ## -remarks ## -examples ## -see-also [VersionAttribute(UInt32)](versionattribute_versionattribute_885572907.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.VersionAttribute.#ctor(System.UInt32,Windows.Foundation.Metadata.Platform) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.VersionAttribute.VersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param version +The version to associate with the marked object. + +### -param platform +A value of the enumeration. The default is **Windows**. + +## -remarks + +## -examples + +## -see-also +[VersionAttribute(UInt32)](versionattribute_versionattribute_885572907.md) \ No newline at end of file diff --git a/windows.foundation.metadata/versionattribute_versionattribute_885572907.md b/windows.foundation.metadata/versionattribute_versionattribute_885572907.md index 878a7fd541..a0159ee7c0 100644 --- a/windows.foundation.metadata/versionattribute_versionattribute_885572907.md +++ b/windows.foundation.metadata/versionattribute_versionattribute_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Metadata.VersionAttribute.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Foundation.Metadata.VersionAttribute.VersionAttribute ## -description Creates and initializes a new instance of the attribute. ## -parameters ### -param version The version to associate with the marked object. ## -remarks ## -examples ## -see-also [VersionAttribute(UInt32, Platform)](versionattribute_versionattribute_1177778147.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.VersionAttribute.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.VersionAttribute.VersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters +### -param version +The version to associate with the marked object. + +## -remarks + +## -examples + +## -see-also +[VersionAttribute(UInt32, Platform)](versionattribute_versionattribute_1177778147.md) \ No newline at end of file diff --git a/windows.foundation.metadata/webhosthiddenattribute_webhosthiddenattribute_1221375020.md b/windows.foundation.metadata/webhosthiddenattribute_webhosthiddenattribute_1221375020.md index 55f9a14cd9..96830b0aa5 100644 --- a/windows.foundation.metadata/webhosthiddenattribute_webhosthiddenattribute_1221375020.md +++ b/windows.foundation.metadata/webhosthiddenattribute_webhosthiddenattribute_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.Metadata.WebHostHiddenAttribute.#ctor --api-type: winrt method ---- # Windows.Foundation.Metadata.WebHostHiddenAttribute.WebHostHiddenAttribute ## -description Creates and initializes a new instance of the attribute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Metadata.WebHostHiddenAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.WebHostHiddenAttribute.WebHostHiddenAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/deferral.md b/windows.foundation/deferral.md index 18e202cb66..bcd3980b62 100644 --- a/windows.foundation/deferral.md +++ b/windows.foundation/deferral.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Foundation.Deferral --api-type: winrt class ---- # Windows.Foundation.Deferral ## -description Stores a [DeferralCompletedHandler](deferralcompletedhandler.md) to be invoked upon completion of the deferral and manipulates the state of the deferral. ## -remarks Javascript apps should not allow navigation before completing a [DeferralCompletedHandler](deferralcompletedhandler.md). Doing so could cause an app to crash and should be considered a programming error. ## -examples ## -see-also [IClosable](iclosable.md), [DeferralCompletedHandler](deferralcompletedhandler.md) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.Deferral +-api-type: winrt class +--- + + + +# Windows.Foundation.Deferral + +## -description +Stores a [DeferralCompletedHandler](deferralcompletedhandler.md) to be invoked upon completion of the deferral and manipulates the state of the deferral. + +## -remarks +Javascript apps should not allow navigation before completing a [DeferralCompletedHandler](deferralcompletedhandler.md). Doing so could cause an app to crash and should be considered a programming error. + +## -examples + +## -see-also +[IClosable](iclosable.md), [DeferralCompletedHandler](deferralcompletedhandler.md) \ No newline at end of file diff --git a/windows.foundation/deferral_close_811482585.md b/windows.foundation/deferral_close_811482585.md index 3e1780ca77..455f93443d 100644 --- a/windows.foundation/deferral_close_811482585.md +++ b/windows.foundation/deferral_close_811482585.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Foundation.Deferral.Close --api-type: winrt method ---- # Windows.Foundation.Deferral.Close ## -description If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. ## -remarks If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. Otherwise, since [Close](deferral_close.md) must be safe to call multiple times, this will simply succeed without doing anything. ## -examples ## -see-also [DeferralCompletedHandler](deferralcompletedhandler.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Deferral.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.Deferral.Close + +## -description +If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. + +## -remarks +If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. Otherwise, since [Close](deferral_close.md) must be safe to call multiple times, this will simply succeed without doing anything. + +## -examples + +## -see-also +[DeferralCompletedHandler](deferralcompletedhandler.md) \ No newline at end of file diff --git a/windows.foundation/deferral_complete_1807836922.md b/windows.foundation/deferral_complete_1807836922.md index 7b58c229fd..65dd936992 100644 --- a/windows.foundation/deferral_complete_1807836922.md +++ b/windows.foundation/deferral_complete_1807836922.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Foundation.Deferral.Complete --api-type: winrt method ---- # Windows.Foundation.Deferral.Complete ## -description If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. ## -remarks If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. Otherwise, it will throw a programming error exception. ## -examples ## -see-also [DeferralCompletedHandler](deferralcompletedhandler.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Deferral.Complete +-api-type: winrt method +--- + + + +# Windows.Foundation.Deferral.Complete + +## -description +If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. + +## -remarks +If the [DeferralCompletedHandler](deferralcompletedhandler.md) has not yet been invoked, this will call it and drop the reference to the delegate. Otherwise, it will throw a programming error exception. + +## -examples + +## -see-also +[DeferralCompletedHandler](deferralcompletedhandler.md) \ No newline at end of file diff --git a/windows.foundation/deferral_deferral_196094199.md b/windows.foundation/deferral_deferral_196094199.md index 47956bad27..36a86f5a00 100644 --- a/windows.foundation/deferral_deferral_196094199.md +++ b/windows.foundation/deferral_deferral_196094199.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.Deferral.#ctor(Windows.Foundation.DeferralCompletedHandler) --api-type: winrt method ---- # Windows.Foundation.Deferral.Deferral ## -description Initializes a new [Deferral](deferral.md) object and specifies a [DeferralCompletedHandler](deferralcompletedhandler.md) to be called upon completion of the deferral. ## -parameters ### -param handler A [DeferralCompletedHandler](deferralcompletedhandler.md) to be called upon completion of the deferral. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Deferral.#ctor(Windows.Foundation.DeferralCompletedHandler) +-api-type: winrt method +--- + + + +# Windows.Foundation.Deferral.Deferral + +## -description +Initializes a new [Deferral](deferral.md) object and specifies a [DeferralCompletedHandler](deferralcompletedhandler.md) to be called upon completion of the deferral. + +## -parameters +### -param handler +A [DeferralCompletedHandler](deferralcompletedhandler.md) to be called upon completion of the deferral. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/iasyncaction_completed.md b/windows.foundation/iasyncaction_completed.md index f4f1f48c06..4b86bdce42 100644 --- a/windows.foundation/iasyncaction_completed.md +++ b/windows.foundation/iasyncaction_completed.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Foundation.IAsyncAction.Completed --api-type: winrt property ---- # Windows.Foundation.IAsyncAction.Completed ## -description Gets or sets the method that handles the action completed notification. ## -property-value The method that handles the notification. ## -remarks The Windows Runtime enforces that this property can only be set once on an action. Generally, a completed [IAsyncAction](iasyncaction.md) method called using language-specific awaitable syntax does nothing further than to return **null** when it completes. If you're implementing [IAsyncAction](iasyncaction.md), then the set implementation of [Completed](iasyncaction_completed.md) should store the handler, and the surrounding logic should invoke it when [Close](iasyncinfo_close.md) is called. The implementation should set the *asyncStatus* parameter of invoked callbacks appropriately if there is a [Cancel](iasyncinfo_cancel.md) call, [Status](iasyncinfo_status.md) is not **Completed**, errors occurred, and so on. ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IAsyncAction.Completed +-api-type: winrt property +--- + + + +# Windows.Foundation.IAsyncAction.Completed + +## -description +Gets or sets the method that handles the action completed notification. + +## -property-value +The method that handles the notification. + +## -remarks +The Windows Runtime enforces that this property can only be set once on an action. + +Generally, a completed [IAsyncAction](iasyncaction.md) method called using language-specific awaitable syntax does nothing further than to return **null** when it completes. + +If you're implementing [IAsyncAction](iasyncaction.md), then the set implementation of [Completed](iasyncaction_completed.md) should store the handler, and the surrounding logic should invoke it when [Close](iasyncinfo_close.md) is called. The implementation should set the *asyncStatus* parameter of invoked callbacks appropriately if there is a [Cancel](iasyncinfo_cancel.md) call, [Status](iasyncinfo_status.md) is not **Completed**, errors occurred, and so on. + + + + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.foundation/iasyncaction_getresults.md b/windows.foundation/iasyncaction_getresults.md index 6c805324ec..d607def889 100644 --- a/windows.foundation/iasyncaction_getresults.md +++ b/windows.foundation/iasyncaction_getresults.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IAsyncAction.GetResults --api-type: winrt method ---- # Windows.Foundation.IAsyncAction.GetResults ## -description Returns the results of the action. ## -remarks The interface definition of this method has a **void** return, and **void** is what methods that use the default [IAsyncAction](iasyncaction.md) behavior will return after completing, when an awaitable syntax is used. If you want the method to return a result you probably should be using [IAsyncOperation<TResult>](iasyncoperation_1.md) instead. For [IAsyncAction](iasyncaction.md), any added logic should be in the [Completed](iasyncaction_completed.md) implementation, not [GetResults](iasyncaction_getresults.md). ## -examples ## -see-also [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IAsyncAction.GetResults +-api-type: winrt method +--- + + + +# Windows.Foundation.IAsyncAction.GetResults + +## -description +Returns the results of the action. + +## -remarks +The interface definition of this method has a **void** return, and **void** is what methods that use the default [IAsyncAction](iasyncaction.md) behavior will return after completing, when an awaitable syntax is used. + +If you want the method to return a result you probably should be using [IAsyncOperation<TResult>](iasyncoperation_1.md) instead. For [IAsyncAction](iasyncaction.md), any added logic should be in the [Completed](iasyncaction_completed.md) implementation, not [GetResults](iasyncaction_getresults.md). + +## -examples + +## -see-also +[Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.foundation/iasyncinfo_cancel.md b/windows.foundation/iasyncinfo_cancel.md index b57cae358f..ab18ca1755 100644 --- a/windows.foundation/iasyncinfo_cancel.md +++ b/windows.foundation/iasyncinfo_cancel.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.IAsyncInfo.Cancel --api-type: winrt method ---- # Windows.Foundation.IAsyncInfo.Cancel ## -description Cancels the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IAsyncInfo.Cancel +-api-type: winrt method +--- + + + +# Windows.Foundation.IAsyncInfo.Cancel + +## -description +Cancels the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/iasyncinfo_close.md b/windows.foundation/iasyncinfo_close.md index 4e82751321..0d658434f7 100644 --- a/windows.foundation/iasyncinfo_close.md +++ b/windows.foundation/iasyncinfo_close.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IAsyncInfo.Close --api-type: winrt method ---- # Windows.Foundation.IAsyncInfo.Close ## -description Closes the asynchronous operation. ## -remarks Calling this method indicates that you have finished with the results of the operation. After calling [Close](iasyncinfo_close.md), do not call the **GetResults** method again (each of the 4 [IAsyncInfo](iasyncinfo.md) derived interfaces have their own implementation of **GetResults**.) ## -examples ## -see-also [Status](iasyncinfo_status.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IAsyncInfo.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.IAsyncInfo.Close + +## -description +Closes the asynchronous operation. + +## -remarks +Calling this method indicates that you have finished with the results of the operation. After calling [Close](iasyncinfo_close.md), do not call the **GetResults** method again (each of the 4 [IAsyncInfo](iasyncinfo.md) derived interfaces have their own implementation of **GetResults**.) + + + +## -examples + +## -see-also +[Status](iasyncinfo_status.md) \ No newline at end of file diff --git a/windows.foundation/iasyncinfo_errorcode.md b/windows.foundation/iasyncinfo_errorcode.md index 2f2ca7795b..d2ca60f564 100644 --- a/windows.foundation/iasyncinfo_errorcode.md +++ b/windows.foundation/iasyncinfo_errorcode.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Foundation.IAsyncInfo.ErrorCode --api-type: winrt property ---- # Windows.Foundation.IAsyncInfo.ErrorCode ## -description Gets a string that describes an error condition of the asynchronous operation. ## -property-value The error string. ## -remarks Error codes are exposed as different types depending on the programming language you are using. Similarly, each language has different techniques for wrapping asynchronous method calls so that error conditions or cancellation can be handled. For more info see one of these topics: + [Exception handling for in C# or Visual Basic](http://msdn.microsoft.com/library/825c5d4f-5ce0-ee93-fd1e-aca1372b1670) + [Exceptions (C++/CX)](XREF:TODO:6cbdc1f1-e4d7-4707-a670-86365146432f) + [JavaScript Run-time Errors](XREF:TODO:c111469d-8f31-4bde-9d46-16d58775db7d) ## -examples ## -see-also [HResult](hresult.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IAsyncInfo.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Foundation.IAsyncInfo.ErrorCode + +## -description +Gets a string that describes an error condition of the asynchronous operation. + +## -property-value +The error string. + +## -remarks +Error codes are exposed as different types depending on the programming language you are using. Similarly, each language has different techniques for wrapping asynchronous method calls so that error conditions or cancellation can be handled. For more info see one of these topics: ++ [Exception handling for in C# or Visual Basic](http://msdn.microsoft.com/library/825c5d4f-5ce0-ee93-fd1e-aca1372b1670) ++ [Exceptions (C++/CX)](XREF:TODO:6cbdc1f1-e4d7-4707-a670-86365146432f) ++ [JavaScript Run-time Errors](XREF:TODO:c111469d-8f31-4bde-9d46-16d58775db7d) + + +## -examples + +## -see-also +[HResult](hresult.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.foundation/iasyncinfo_id.md b/windows.foundation/iasyncinfo_id.md index 69b82d049d..b99cbedb87 100644 --- a/windows.foundation/iasyncinfo_id.md +++ b/windows.foundation/iasyncinfo_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.IAsyncInfo.Id --api-type: winrt property ---- # Windows.Foundation.IAsyncInfo.Id ## -description Gets the handle of the asynchronous operation. ## -property-value The handle of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IAsyncInfo.Id +-api-type: winrt property +--- + + + +# Windows.Foundation.IAsyncInfo.Id + +## -description +Gets the handle of the asynchronous operation. + +## -property-value +The handle of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/iasyncinfo_status.md b/windows.foundation/iasyncinfo_status.md index ca0cf8aac6..5093369f48 100644 --- a/windows.foundation/iasyncinfo_status.md +++ b/windows.foundation/iasyncinfo_status.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.IAsyncInfo.Status --api-type: winrt property ---- # Windows.Foundation.IAsyncInfo.Status ## -description Gets a value that indicates the status of the asynchronous operation. ## -property-value The status of the operation, as a value of the enumeration. A value of **Completed** indicates that the method has returned. The **Started** value represents a transition state before any of the other 3 final results (**Completed**, **Error**, **Canceled**) can be determined by the method's invocation. ## -remarks ## -examples ## -see-also [AsyncStatus](asyncstatus.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IAsyncInfo.Status +-api-type: winrt property +--- + + + +# Windows.Foundation.IAsyncInfo.Status + +## -description +Gets a value that indicates the status of the asynchronous operation. + +## -property-value +The status of the operation, as a value of the enumeration. A value of **Completed** indicates that the method has returned. The **Started** value represents a transition state before any of the other 3 final results (**Completed**, **Error**, **Canceled**) can be determined by the method's invocation. + +## -remarks + +## -examples + +## -see-also +[AsyncStatus](asyncstatus.md), [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e) \ No newline at end of file diff --git a/windows.foundation/iclosable_close.md b/windows.foundation/iclosable_close.md index 15aecc1dc3..f4e4e6638f 100644 --- a/windows.foundation/iclosable_close.md +++ b/windows.foundation/iclosable_close.md @@ -1,3 +1,46 @@ ---- -api-id: M:Windows.Foundation.IClosable.Close --api-type: winrt method ---- # Windows.Foundation.IClosable.Close ## -description Releases system resources that are exposed by a Windows Runtime object. > **.NET** > This interface appears as [System.IDisposable](https://msdn.microsoft.com/library/system.idisposable.aspx). > **C++/CX** > This interface appears as [Platform::IDisposable](XREF:TODO:f4344056-7030-42ed-bc98-b140edffddcd). ## -remarks Implementation / caller notes that follow are mainly relevant for WRL. ### Notes to implementers Implement this method to release the exclusive system resources that are in use, such as file handles, streams, and network sockets. The method should also release other resources that are in use, including object references and memory, to prepare them for reuse. This method must call the [Close](iclosable_close.md) method of any object it holds that implements [IClosable](iclosable.md). The [Close](iclosable_close.md) method should release system resources as quickly as possible, without blocking for asynchronous operations to complete. To ensure that all resources are completely released, the caller must wait for all outstanding asynchronous operations to complete before calling [Close](iclosable_close.md). After [Close](iclosable_close.md) returns, the object is still in memory but without the system resources it needs; therefore, most of its members are not usable. A member that depends on a released system resource can return **RO_E_CLOSED** to indicate that the object is closed and it cannot complete the requested operation. ### Notes to callers If you call [Close](iclosable_close.md) multiple times, there is no effect; the method returns **S_OK**. [Close](iclosable_close.md) methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IClosable.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.IClosable.Close + +## -description +Releases system resources that are exposed by a Windows Runtime object. + + + +> **.NET** +> This interface appears as [System.IDisposable](https://msdn.microsoft.com/library/system.idisposable.aspx). + + + +> **C++/CX** +> This interface appears as [Platform::IDisposable](XREF:TODO:f4344056-7030-42ed-bc98-b140edffddcd). + +## -remarks +Implementation / caller notes that follow are mainly relevant for WRL. + +### Notes to implementers + +Implement this method to release the exclusive system resources that are in use, such as file handles, streams, and network sockets. The method should also release other resources that are in use, including object references and memory, to prepare them for reuse. + +This method must call the [Close](iclosable_close.md) method of any object it holds that implements [IClosable](iclosable.md). + +The [Close](iclosable_close.md) method should release system resources as quickly as possible, without blocking for asynchronous operations to complete. To ensure that all resources are completely released, the caller must wait for all outstanding asynchronous operations to complete before calling [Close](iclosable_close.md). + +After [Close](iclosable_close.md) returns, the object is still in memory but without the system resources it needs; therefore, most of its members are not usable. A member that depends on a released system resource can return **RO_E_CLOSED** to indicate that the object is closed and it cannot complete the requested operation. + +### Notes to callers + +If you call [Close](iclosable_close.md) multiple times, there is no effect; the method returns **S_OK**. + +[Close](iclosable_close.md) methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented [IClosable](iclosable.md). Instead, Visual C++ component extensions (C++/CX) code for runtime classes should call the destructor or set the last reference to **null**. + +## -examples + +## -see-also diff --git a/windows.foundation/igetactivationfactory_getactivationfactory.md b/windows.foundation/igetactivationfactory_getactivationfactory.md index b5da7ebbe4..e505e5f994 100644 --- a/windows.foundation/igetactivationfactory_getactivationfactory.md +++ b/windows.foundation/igetactivationfactory_getactivationfactory.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.IGetActivationFactory.GetActivationFactory(System.String) --api-type: winrt method ---- # Windows.Foundation.IGetActivationFactory.GetActivationFactory ## -description Retrieves the implementation of an activation factory. ## -parameters ### -param activatableClassId The Activation ID (ACID) of the activatable type produced by the factory. ## -returns An instance of an activation factory type. This type must implement [IActivationFactory](http://msdn.microsoft.com/library/c6a2ed6e-9c45-4cf3-a301-72a5daeb4dfc). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IGetActivationFactory.GetActivationFactory(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.IGetActivationFactory.GetActivationFactory + +## -description +Retrieves the implementation of an activation factory. + +## -parameters +### -param activatableClassId +The Activation ID (ACID) of the activatable type produced by the factory. + +## -returns +An instance of an activation factory type. This type must implement [IActivationFactory](http://msdn.microsoft.com/library/c6a2ed6e-9c45-4cf3-a301-72a5daeb4dfc). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/imemorybuffer_createreference.md b/windows.foundation/imemorybuffer_createreference.md index 0b5ad84aec..9138a7a02e 100644 --- a/windows.foundation/imemorybuffer_createreference.md +++ b/windows.foundation/imemorybuffer_createreference.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IMemoryBuffer.CreateReference --api-type: winrt method ---- # Windows.Foundation.IMemoryBuffer.CreateReference ## -description Returns a new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. ## -returns A new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. ## -remarks This method always successfully returns a new [IMemoryBufferReference](imemorybufferreference.md) object even after the [IMemoryBuffer](imemorybuffer.md) has been closed. In that case, the returned [IMemoryBufferReference](imemorybufferreference.md) is already closed. Therefore, the [IMemoryBufferReference](imemorybufferreference.md) instance's [Capacity](imemorybufferreference_capacity.md) property will be zero and **IMemoryBufferByteAccess::GetBuffer** method will always return a null memory pointer and zero capacity. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IMemoryBuffer.CreateReference +-api-type: winrt method +--- + + + +# Windows.Foundation.IMemoryBuffer.CreateReference + +## -description +Returns a new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. + +## -returns +A new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. + +## -remarks +This method always successfully returns a new [IMemoryBufferReference](imemorybufferreference.md) object even after the [IMemoryBuffer](imemorybuffer.md) has been closed. In that case, the returned [IMemoryBufferReference](imemorybufferreference.md) is already closed. Therefore, the [IMemoryBufferReference](imemorybufferreference.md) instance's [Capacity](imemorybufferreference_capacity.md) property will be zero and **IMemoryBufferByteAccess::GetBuffer** method will always return a null memory pointer and zero capacity. + +## -examples + +## -see-also diff --git a/windows.foundation/imemorybufferreference_capacity.md b/windows.foundation/imemorybufferreference_capacity.md index a88074ea03..f0e81ccc52 100644 --- a/windows.foundation/imemorybufferreference_capacity.md +++ b/windows.foundation/imemorybufferreference_capacity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.IMemoryBufferReference.Capacity --api-type: winrt property ---- # Windows.Foundation.IMemoryBufferReference.Capacity ## -description Gets the size of the memory buffer in bytes. ## -property-value The size of the memory buffer in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IMemoryBufferReference.Capacity +-api-type: winrt property +--- + + + +# Windows.Foundation.IMemoryBufferReference.Capacity + +## -description +Gets the size of the memory buffer in bytes. + +## -property-value +The size of the memory buffer in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/imemorybufferreference_closed.md b/windows.foundation/imemorybufferreference_closed.md index 7645c49b8a..4ba82e8894 100644 --- a/windows.foundation/imemorybufferreference_closed.md +++ b/windows.foundation/imemorybufferreference_closed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Foundation.IMemoryBufferReference.Closed --api-type: winrt event ---- # Windows.Foundation.IMemoryBufferReference.Closed ## -description Occurs when [MemoryBuffer.Close](memorybuffer_close.md) has been called and this [IMemoryBufferReference](imemorybufferreference.md) has been closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Foundation.IMemoryBufferReference.Closed +-api-type: winrt event +--- + + + +# Windows.Foundation.IMemoryBufferReference.Closed + +## -description +Occurs when [MemoryBuffer.Close](memorybuffer_close.md) has been called and this [IMemoryBufferReference](imemorybufferreference.md) has been closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getboolean.md b/windows.foundation/ipropertyvalue_getboolean.md index 5c981f6a26..93eaf6af4c 100644 --- a/windows.foundation/ipropertyvalue_getboolean.md +++ b/windows.foundation/ipropertyvalue_getboolean.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetBoolean --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetBoolean ## -description Returns the Boolean value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetBoolean +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetBoolean + +## -description +Returns the Boolean value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getbooleanarray.md b/windows.foundation/ipropertyvalue_getbooleanarray.md index 341d2ede18..8153b3b89f 100644 --- a/windows.foundation/ipropertyvalue_getbooleanarray.md +++ b/windows.foundation/ipropertyvalue_getbooleanarray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetBooleanArray(System.Boolean[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetBooleanArray ## -description Returns the array of Boolean values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetBooleanArray(System.Boolean[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetBooleanArray + +## -description +Returns the array of Boolean values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getchar16.md b/windows.foundation/ipropertyvalue_getchar16.md index e5cebbc9ba..9e9e2c296b 100644 --- a/windows.foundation/ipropertyvalue_getchar16.md +++ b/windows.foundation/ipropertyvalue_getchar16.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetChar16 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetChar16 ## -description Returns the Unicode character stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetChar16 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetChar16 + +## -description +Returns the Unicode character stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getchar16array.md b/windows.foundation/ipropertyvalue_getchar16array.md index 070d827b02..c95bda2be8 100644 --- a/windows.foundation/ipropertyvalue_getchar16array.md +++ b/windows.foundation/ipropertyvalue_getchar16array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetChar16Array(System.Char[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetChar16Array ## -description Returns the array of Unicode characters stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetChar16Array(System.Char[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetChar16Array + +## -description +Returns the array of Unicode characters stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getdatetime.md b/windows.foundation/ipropertyvalue_getdatetime.md index 404251774f..615152ff59 100644 --- a/windows.foundation/ipropertyvalue_getdatetime.md +++ b/windows.foundation/ipropertyvalue_getdatetime.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetDateTime --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetDateTime ## -description Returns the date and time value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetDateTime +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetDateTime + +## -description +Returns the date and time value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getdatetimearray.md b/windows.foundation/ipropertyvalue_getdatetimearray.md index ca5960c308..0f6b70bcd7 100644 --- a/windows.foundation/ipropertyvalue_getdatetimearray.md +++ b/windows.foundation/ipropertyvalue_getdatetimearray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetDateTimeArray(Windows.Foundation.DateTime[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetDateTimeArray ## -description Returns the array of date and time values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetDateTimeArray(Windows.Foundation.DateTime[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetDateTimeArray + +## -description +Returns the array of date and time values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getdouble.md b/windows.foundation/ipropertyvalue_getdouble.md index 3459c03a7d..ad90e661e4 100644 --- a/windows.foundation/ipropertyvalue_getdouble.md +++ b/windows.foundation/ipropertyvalue_getdouble.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetDouble --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetDouble ## -description Returns the floating-point value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetDouble +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetDouble + +## -description +Returns the floating-point value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getdoublearray.md b/windows.foundation/ipropertyvalue_getdoublearray.md index 67baee2d63..63e326e62c 100644 --- a/windows.foundation/ipropertyvalue_getdoublearray.md +++ b/windows.foundation/ipropertyvalue_getdoublearray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetDoubleArray(System.Double[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetDoubleArray ## -description Returns the array of floating-point values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetDoubleArray(System.Double[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetDoubleArray + +## -description +Returns the array of floating-point values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getguid.md b/windows.foundation/ipropertyvalue_getguid.md index ec515fc8da..60253e9e4b 100644 --- a/windows.foundation/ipropertyvalue_getguid.md +++ b/windows.foundation/ipropertyvalue_getguid.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetGuid --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetGuid ## -description Returns the GUID value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetGuid +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetGuid + +## -description +Returns the GUID value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getguidarray.md b/windows.foundation/ipropertyvalue_getguidarray.md index 7cdb0ac8e6..60fa775ad5 100644 --- a/windows.foundation/ipropertyvalue_getguidarray.md +++ b/windows.foundation/ipropertyvalue_getguidarray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetGuidArray(System.Guid[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetGuidArray ## -description Returns the array of GUID values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetGuidArray(System.Guid[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetGuidArray + +## -description +Returns the array of GUID values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getinspectablearray.md b/windows.foundation/ipropertyvalue_getinspectablearray.md index 9fb5f64726..8298aef8bc 100644 --- a/windows.foundation/ipropertyvalue_getinspectablearray.md +++ b/windows.foundation/ipropertyvalue_getinspectablearray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInspectableArray(System.Object[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInspectableArray ## -description Returns the array of inspectable objects stored as a property value. ## -parameters ### -param value The array of objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInspectableArray(System.Object[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInspectableArray + +## -description +Returns the array of inspectable objects stored as a property value. + +## -parameters +### -param value +The array of objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getint16.md b/windows.foundation/ipropertyvalue_getint16.md index 39f0a5723e..776249cc3f 100644 --- a/windows.foundation/ipropertyvalue_getint16.md +++ b/windows.foundation/ipropertyvalue_getint16.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInt16 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInt16 ## -description Returns the integer value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInt16 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInt16 + +## -description +Returns the integer value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getint16array.md b/windows.foundation/ipropertyvalue_getint16array.md index 2c53ed5794..adfde19428 100644 --- a/windows.foundation/ipropertyvalue_getint16array.md +++ b/windows.foundation/ipropertyvalue_getint16array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInt16Array(System.Int16[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInt16Array ## -description Returns the array of integer values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInt16Array(System.Int16[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInt16Array + +## -description +Returns the array of integer values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getint32.md b/windows.foundation/ipropertyvalue_getint32.md index b44b468786..21fd775a36 100644 --- a/windows.foundation/ipropertyvalue_getint32.md +++ b/windows.foundation/ipropertyvalue_getint32.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInt32 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInt32 ## -description Returns the integer value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInt32 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInt32 + +## -description +Returns the integer value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getint32array.md b/windows.foundation/ipropertyvalue_getint32array.md index dd40dfa07a..4f8f0ee96d 100644 --- a/windows.foundation/ipropertyvalue_getint32array.md +++ b/windows.foundation/ipropertyvalue_getint32array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInt32Array(System.Int32[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInt32Array ## -description Returns the array of integer values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInt32Array(System.Int32[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInt32Array + +## -description +Returns the array of integer values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getint64.md b/windows.foundation/ipropertyvalue_getint64.md index d79cf980c3..c57ec93738 100644 --- a/windows.foundation/ipropertyvalue_getint64.md +++ b/windows.foundation/ipropertyvalue_getint64.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInt64 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInt64 ## -description Returns the integer value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInt64 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInt64 + +## -description +Returns the integer value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getint64array.md b/windows.foundation/ipropertyvalue_getint64array.md index e5c7ec4ac1..01f7786fe5 100644 --- a/windows.foundation/ipropertyvalue_getint64array.md +++ b/windows.foundation/ipropertyvalue_getint64array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetInt64Array(System.Int64[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetInt64Array ## -description Returns the array of integer values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetInt64Array(System.Int64[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetInt64Array + +## -description +Returns the array of integer values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getpoint.md b/windows.foundation/ipropertyvalue_getpoint.md index 839b634f0c..901a575103 100644 --- a/windows.foundation/ipropertyvalue_getpoint.md +++ b/windows.foundation/ipropertyvalue_getpoint.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetPoint --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetPoint ## -description Returns the point structure stored as a property value. ## -returns The structure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetPoint +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetPoint + +## -description +Returns the point structure stored as a property value. + +## -returns +The structure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getpointarray.md b/windows.foundation/ipropertyvalue_getpointarray.md index b5fd66bb78..0ec040daa0 100644 --- a/windows.foundation/ipropertyvalue_getpointarray.md +++ b/windows.foundation/ipropertyvalue_getpointarray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetPointArray(Windows.Foundation.Point[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetPointArray ## -description Returns the array of point structures stored as a property value. ## -parameters ### -param value The array of structures. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetPointArray(Windows.Foundation.Point[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetPointArray + +## -description +Returns the array of point structures stored as a property value. + +## -parameters +### -param value +The array of structures. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getrect.md b/windows.foundation/ipropertyvalue_getrect.md index 4b01e8d19e..f44e17f5c4 100644 --- a/windows.foundation/ipropertyvalue_getrect.md +++ b/windows.foundation/ipropertyvalue_getrect.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetRect --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetRect ## -description Returns the rectangle structure stored as a property value. ## -returns The structure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetRect +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetRect + +## -description +Returns the rectangle structure stored as a property value. + +## -returns +The structure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getrectarray.md b/windows.foundation/ipropertyvalue_getrectarray.md index 47664bbaf3..280a0dcec9 100644 --- a/windows.foundation/ipropertyvalue_getrectarray.md +++ b/windows.foundation/ipropertyvalue_getrectarray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetRectArray(Windows.Foundation.Rect[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetRectArray ## -description Returns the array of rectangle structures stored as a property value. ## -parameters ### -param value The array of structures. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetRectArray(Windows.Foundation.Rect[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetRectArray + +## -description +Returns the array of rectangle structures stored as a property value. + +## -parameters +### -param value +The array of structures. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getsingle.md b/windows.foundation/ipropertyvalue_getsingle.md index 1b5c4eb65c..a8970e26df 100644 --- a/windows.foundation/ipropertyvalue_getsingle.md +++ b/windows.foundation/ipropertyvalue_getsingle.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetSingle --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetSingle ## -description Returns the floating-point value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetSingle +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetSingle + +## -description +Returns the floating-point value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getsinglearray.md b/windows.foundation/ipropertyvalue_getsinglearray.md index f31c0af4f9..dbf8def4bc 100644 --- a/windows.foundation/ipropertyvalue_getsinglearray.md +++ b/windows.foundation/ipropertyvalue_getsinglearray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetSingleArray(System.Single[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetSingleArray ## -description Returns the array of floating-point values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetSingleArray(System.Single[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetSingleArray + +## -description +Returns the array of floating-point values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getsize.md b/windows.foundation/ipropertyvalue_getsize.md index edc42e287a..daa1882f76 100644 --- a/windows.foundation/ipropertyvalue_getsize.md +++ b/windows.foundation/ipropertyvalue_getsize.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetSize --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetSize ## -description Returns the size structure stored as a property value. ## -returns The structure. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetSize +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetSize + +## -description +Returns the size structure stored as a property value. + +## -returns +The structure. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getsizearray.md b/windows.foundation/ipropertyvalue_getsizearray.md index 629e712487..60468d59d9 100644 --- a/windows.foundation/ipropertyvalue_getsizearray.md +++ b/windows.foundation/ipropertyvalue_getsizearray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetSizeArray(Windows.Foundation.Size[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetSizeArray ## -description Returns the array of size structures stored as a property value. ## -parameters ### -param value The array of structures. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetSizeArray(Windows.Foundation.Size[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetSizeArray + +## -description +Returns the array of size structures stored as a property value. + +## -parameters +### -param value +The array of structures. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getstring.md b/windows.foundation/ipropertyvalue_getstring.md index f7d0e86a49..bb60601b46 100644 --- a/windows.foundation/ipropertyvalue_getstring.md +++ b/windows.foundation/ipropertyvalue_getstring.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetString --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetString ## -description Returns the string value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetString +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetString + +## -description +Returns the string value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getstringarray.md b/windows.foundation/ipropertyvalue_getstringarray.md index ee110b8e40..138fe520e3 100644 --- a/windows.foundation/ipropertyvalue_getstringarray.md +++ b/windows.foundation/ipropertyvalue_getstringarray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetStringArray(System.String[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetStringArray ## -description Returns the array of string values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetStringArray(System.String[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetStringArray + +## -description +Returns the array of string values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_gettimespan.md b/windows.foundation/ipropertyvalue_gettimespan.md index 158fceecab..7dc7e8265e 100644 --- a/windows.foundation/ipropertyvalue_gettimespan.md +++ b/windows.foundation/ipropertyvalue_gettimespan.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetTimeSpan --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetTimeSpan ## -description Returns the time interval value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetTimeSpan +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetTimeSpan + +## -description +Returns the time interval value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_gettimespanarray.md b/windows.foundation/ipropertyvalue_gettimespanarray.md index 9cfe48a7fd..2a98874f9f 100644 --- a/windows.foundation/ipropertyvalue_gettimespanarray.md +++ b/windows.foundation/ipropertyvalue_gettimespanarray.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetTimeSpanArray(Windows.Foundation.TimeSpan[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetTimeSpanArray ## -description Returns the array of time interval values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetTimeSpanArray(Windows.Foundation.TimeSpan[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetTimeSpanArray + +## -description +Returns the array of time interval values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint16.md b/windows.foundation/ipropertyvalue_getuint16.md index 9e7a9a16f1..d870bd43d2 100644 --- a/windows.foundation/ipropertyvalue_getuint16.md +++ b/windows.foundation/ipropertyvalue_getuint16.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt16 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt16 ## -description Returns the unsigned integer value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt16 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt16 + +## -description +Returns the unsigned integer value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint16array.md b/windows.foundation/ipropertyvalue_getuint16array.md index 2acaac2591..1d420bbae1 100644 --- a/windows.foundation/ipropertyvalue_getuint16array.md +++ b/windows.foundation/ipropertyvalue_getuint16array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt16Array(System.UInt16[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt16Array ## -description Returns the array of unsigned integer values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt16Array(System.UInt16[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt16Array + +## -description +Returns the array of unsigned integer values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint32.md b/windows.foundation/ipropertyvalue_getuint32.md index 72047716e5..83f51a25b0 100644 --- a/windows.foundation/ipropertyvalue_getuint32.md +++ b/windows.foundation/ipropertyvalue_getuint32.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt32 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt32 ## -description Returns the unsigned integer value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt32 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt32 + +## -description +Returns the unsigned integer value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint32array.md b/windows.foundation/ipropertyvalue_getuint32array.md index c355c86d51..cc4a5aa2c5 100644 --- a/windows.foundation/ipropertyvalue_getuint32array.md +++ b/windows.foundation/ipropertyvalue_getuint32array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt32Array(System.UInt32[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt32Array ## -description Returns the array of unsigned integer values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt32Array(System.UInt32[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt32Array + +## -description +Returns the array of unsigned integer values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint64.md b/windows.foundation/ipropertyvalue_getuint64.md index 35cc4cebc1..3e80f71077 100644 --- a/windows.foundation/ipropertyvalue_getuint64.md +++ b/windows.foundation/ipropertyvalue_getuint64.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt64 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt64 ## -description Returns the unsigned integer value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt64 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt64 + +## -description +Returns the unsigned integer value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint64array.md b/windows.foundation/ipropertyvalue_getuint64array.md index 235121f250..2e3f79b793 100644 --- a/windows.foundation/ipropertyvalue_getuint64array.md +++ b/windows.foundation/ipropertyvalue_getuint64array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt64Array(System.UInt64[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt64Array ## -description Returns the array of unsigned integer values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt64Array(System.UInt64[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt64Array + +## -description +Returns the array of unsigned integer values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint8.md b/windows.foundation/ipropertyvalue_getuint8.md index df8b3d0f39..fe98190f9c 100644 --- a/windows.foundation/ipropertyvalue_getuint8.md +++ b/windows.foundation/ipropertyvalue_getuint8.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt8 --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt8 ## -description Returns the byte value stored as a property value. ## -returns The value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt8 +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt8 + +## -description +Returns the byte value stored as a property value. + +## -returns +The value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_getuint8array.md b/windows.foundation/ipropertyvalue_getuint8array.md index d9c4450ce5..2c2c9befcd 100644 --- a/windows.foundation/ipropertyvalue_getuint8array.md +++ b/windows.foundation/ipropertyvalue_getuint8array.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.IPropertyValue.GetUInt8Array(System.Byte[]@) --api-type: winrt method ---- # Windows.Foundation.IPropertyValue.GetUInt8Array ## -description Returns the array of byte values stored as a property value. ## -parameters ### -param value The array of values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IPropertyValue.GetUInt8Array(System.Byte[]@) +-api-type: winrt method +--- + + + +# Windows.Foundation.IPropertyValue.GetUInt8Array + +## -description +Returns the array of byte values stored as a property value. + +## -parameters +### -param value +The array of values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_isnumericscalar.md b/windows.foundation/ipropertyvalue_isnumericscalar.md index 3152f25313..fcfd63be6a 100644 --- a/windows.foundation/ipropertyvalue_isnumericscalar.md +++ b/windows.foundation/ipropertyvalue_isnumericscalar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.IPropertyValue.IsNumericScalar --api-type: winrt property ---- # Windows.Foundation.IPropertyValue.IsNumericScalar ## -description Gets a value that indicates whether the property value is a scalar value. ## -property-value True if the value is scalar; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IPropertyValue.IsNumericScalar +-api-type: winrt property +--- + + + +# Windows.Foundation.IPropertyValue.IsNumericScalar + +## -description +Gets a value that indicates whether the property value is a scalar value. + +## -property-value +True if the value is scalar; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/ipropertyvalue_type.md b/windows.foundation/ipropertyvalue_type.md index eedf7c6443..d73017efa3 100644 --- a/windows.foundation/ipropertyvalue_type.md +++ b/windows.foundation/ipropertyvalue_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.IPropertyValue.Type --api-type: winrt property ---- # Windows.Foundation.IPropertyValue.Type ## -description Returns the type stored in the property value. ## -property-value The type stored in the property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IPropertyValue.Type +-api-type: winrt property +--- + + + +# Windows.Foundation.IPropertyValue.Type + +## -description +Returns the type stored in the property value. + +## -property-value +The type stored in the property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/istringable_tostring.md b/windows.foundation/istringable_tostring.md index 887c3f466b..e21311d538 100644 --- a/windows.foundation/istringable_tostring.md +++ b/windows.foundation/istringable_tostring.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.IStringable.ToString --api-type: winrt method ---- # Windows.Foundation.IStringable.ToString ## -description Gets a string that represents the current object. ## -returns A string that represents the current object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.IStringable.ToString +-api-type: winrt method +--- + + + +# Windows.Foundation.IStringable.ToString + +## -description +Gets a string that represents the current object. + +## -returns +A string that represents the current object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/iwwwformurldecoderentry_name.md b/windows.foundation/iwwwformurldecoderentry_name.md index 0adb2edaac..9481028d72 100644 --- a/windows.foundation/iwwwformurldecoderentry_name.md +++ b/windows.foundation/iwwwformurldecoderentry_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.IWwwFormUrlDecoderEntry.Name --api-type: winrt property ---- # Windows.Foundation.IWwwFormUrlDecoderEntry.Name ## -description Represents the name of a parameter in a URL query string. ## -property-value The name of a query string parameter. The [Value](iwwwformurldecoderentry_value.md) property represents the corresponding value. ## -remarks ## -examples ## -see-also [WwwFormUrlDecoder](wwwformurldecoder.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IWwwFormUrlDecoderEntry.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.IWwwFormUrlDecoderEntry.Name + +## -description +Represents the name of a parameter in a URL query string. + +## -property-value +The name of a query string parameter. The [Value](iwwwformurldecoderentry_value.md) property represents the corresponding value. + +## -remarks + +## -examples + +## -see-also +[WwwFormUrlDecoder](wwwformurldecoder.md) \ No newline at end of file diff --git a/windows.foundation/iwwwformurldecoderentry_value.md b/windows.foundation/iwwwformurldecoderentry_value.md index b843481c6f..6a8bb9f723 100644 --- a/windows.foundation/iwwwformurldecoderentry_value.md +++ b/windows.foundation/iwwwformurldecoderentry_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.IWwwFormUrlDecoderEntry.Value --api-type: winrt property ---- # Windows.Foundation.IWwwFormUrlDecoderEntry.Value ## -description Represents a named value in a URL query string. ## -property-value The value of a query parameter that corresponds with the [Name](iwwwformurldecoderentry_name.md) property. ## -remarks ## -examples ## -see-also [WwwFormUrlDecoder](wwwformurldecoder.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.IWwwFormUrlDecoderEntry.Value +-api-type: winrt property +--- + + + +# Windows.Foundation.IWwwFormUrlDecoderEntry.Value + +## -description +Represents a named value in a URL query string. + +## -property-value +The value of a query parameter that corresponds with the [Name](iwwwformurldecoderentry_name.md) property. + +## -remarks + +## -examples + +## -see-also +[WwwFormUrlDecoder](wwwformurldecoder.md) \ No newline at end of file diff --git a/windows.foundation/memorybuffer.md b/windows.foundation/memorybuffer.md index 3d3fc54644..fe26eb6994 100644 --- a/windows.foundation/memorybuffer.md +++ b/windows.foundation/memorybuffer.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Foundation.MemoryBuffer --api-type: winrt class ---- # Windows.Foundation.MemoryBuffer ## -description Represents a reference counted memory buffer. ## -remarks ## -examples ## -see-also [IMemoryBuffer](imemorybuffer.md), [IClosable](iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Foundation.MemoryBuffer +-api-type: winrt class +--- + + + +# Windows.Foundation.MemoryBuffer + +## -description +Represents a reference counted memory buffer. + +## -remarks + +## -examples + +## -see-also +[IMemoryBuffer](imemorybuffer.md), [IClosable](iclosable.md) \ No newline at end of file diff --git a/windows.foundation/memorybuffer_close_811482585.md b/windows.foundation/memorybuffer_close_811482585.md index 69c3faf73c..e5ed1c1f59 100644 --- a/windows.foundation/memorybuffer_close_811482585.md +++ b/windows.foundation/memorybuffer_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Foundation.MemoryBuffer.Close --api-type: winrt method ---- # Windows.Foundation.MemoryBuffer.Close ## -description Disconnects this [MemoryBuffer](memorybuffer.md) object from the actual memory buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.MemoryBuffer.Close +-api-type: winrt method +--- + + + +# Windows.Foundation.MemoryBuffer.Close + +## -description +Disconnects this [MemoryBuffer](memorybuffer.md) object from the actual memory buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/memorybuffer_createreference_431808572.md b/windows.foundation/memorybuffer_createreference_431808572.md index 7eb563a226..ff23bdb079 100644 --- a/windows.foundation/memorybuffer_createreference_431808572.md +++ b/windows.foundation/memorybuffer_createreference_431808572.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.MemoryBuffer.CreateReference --api-type: winrt method ---- # Windows.Foundation.MemoryBuffer.CreateReference ## -description Returns a new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. ## -returns A new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. ## -remarks This method always successfully returns a new [IMemoryBufferReference](imemorybufferreference.md) object even after the [IMemoryBuffer](imemorybuffer.md) has been closed. In that case, the returned [IMemoryBufferReference](imemorybufferreference.md) is already closed. Therefore, the [IMemoryBufferReference](imemorybufferreference.md) instance's [Capacity](imemorybufferreference_capacity.md) property will be zero and **IMemoryBufferByteAccess::GetBuffer** method will always return a null memory pointer and zero capacity. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.MemoryBuffer.CreateReference +-api-type: winrt method +--- + + + +# Windows.Foundation.MemoryBuffer.CreateReference + +## -description +Returns a new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. + +## -returns +A new managed object that implements the [IMemoryBufferReference](imemorybufferreference.md) interface. + +## -remarks +This method always successfully returns a new [IMemoryBufferReference](imemorybufferreference.md) object even after the [IMemoryBuffer](imemorybuffer.md) has been closed. In that case, the returned [IMemoryBufferReference](imemorybufferreference.md) is already closed. Therefore, the [IMemoryBufferReference](imemorybufferreference.md) instance's [Capacity](imemorybufferreference_capacity.md) property will be zero and **IMemoryBufferByteAccess::GetBuffer** method will always return a null memory pointer and zero capacity. + +## -examples + +## -see-also diff --git a/windows.foundation/memorybuffer_memorybuffer_885572907.md b/windows.foundation/memorybuffer_memorybuffer_885572907.md index b776e0ebec..61ca0bc2cc 100644 --- a/windows.foundation/memorybuffer_memorybuffer_885572907.md +++ b/windows.foundation/memorybuffer_memorybuffer_885572907.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Foundation.MemoryBuffer.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Foundation.MemoryBuffer.MemoryBuffer ## -description Initializes a new [MemoryBuffer](memorybuffer.md) instance with the specified capacity. ## -parameters ### -param capacity The desired size of the new memory buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.MemoryBuffer.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.MemoryBuffer.MemoryBuffer + +## -description +Initializes a new [MemoryBuffer](memorybuffer.md) instance with the specified capacity. + +## -parameters +### -param capacity +The desired size of the new memory buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createboolean_835582776.md b/windows.foundation/propertyvalue_createboolean_835582776.md index dbbaa370d0..cdaca1a5b2 100644 --- a/windows.foundation/propertyvalue_createboolean_835582776.md +++ b/windows.foundation/propertyvalue_createboolean_835582776.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateBoolean(System.Boolean) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateBoolean ## -description Creates a property value from a Boolean value. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateBoolean(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateBoolean + +## -description +Creates a property value from a Boolean value. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createbooleanarray_2118610424.md b/windows.foundation/propertyvalue_createbooleanarray_2118610424.md index c350b723fd..e52bcca4b3 100644 --- a/windows.foundation/propertyvalue_createbooleanarray_2118610424.md +++ b/windows.foundation/propertyvalue_createbooleanarray_2118610424.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateBooleanArray(System.Boolean[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateBooleanArray ## -description Creates a property value from an array of Boolean values. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateBooleanArray(System.Boolean[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateBooleanArray + +## -description +Creates a property value from an array of Boolean values. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createchar16_1056733551.md b/windows.foundation/propertyvalue_createchar16_1056733551.md index 6174f6d8fa..82cd0b6d2c 100644 --- a/windows.foundation/propertyvalue_createchar16_1056733551.md +++ b/windows.foundation/propertyvalue_createchar16_1056733551.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateChar16(System.Char) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateChar16 ## -description Creates a property value from a Unicode character. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateChar16(System.Char) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateChar16 + +## -description +Creates a property value from a Unicode character. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createchar16array_1368416996.md b/windows.foundation/propertyvalue_createchar16array_1368416996.md index a185c9540e..d8e5de0199 100644 --- a/windows.foundation/propertyvalue_createchar16array_1368416996.md +++ b/windows.foundation/propertyvalue_createchar16array_1368416996.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateChar16Array(System.Char[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateChar16Array ## -description Creates a property value from an array of Unicode characters. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateChar16Array(System.Char[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateChar16Array + +## -description +Creates a property value from an array of Unicode characters. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createdatetime_1397834486.md b/windows.foundation/propertyvalue_createdatetime_1397834486.md index 353df6cc0e..e307192d42 100644 --- a/windows.foundation/propertyvalue_createdatetime_1397834486.md +++ b/windows.foundation/propertyvalue_createdatetime_1397834486.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateDateTime(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateDateTime ## -description Creates a property value from a date and time value. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateDateTime(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateDateTime + +## -description +Creates a property value from a date and time value. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createdatetimearray_178146613.md b/windows.foundation/propertyvalue_createdatetimearray_178146613.md index 33751c7594..c3d16382a3 100644 --- a/windows.foundation/propertyvalue_createdatetimearray_178146613.md +++ b/windows.foundation/propertyvalue_createdatetimearray_178146613.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateDateTimeArray(Windows.Foundation.DateTime[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateDateTimeArray ## -description Creates a property value from an array of date and time values. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateDateTimeArray(Windows.Foundation.DateTime[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateDateTimeArray + +## -description +Creates a property value from an array of date and time values. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createdouble_1372949072.md b/windows.foundation/propertyvalue_createdouble_1372949072.md index ed6412ac06..05c50bb600 100644 --- a/windows.foundation/propertyvalue_createdouble_1372949072.md +++ b/windows.foundation/propertyvalue_createdouble_1372949072.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateDouble(System.Double) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateDouble ## -description Creates a property value from a floating-point value. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateDouble + +## -description +Creates a property value from a floating-point value. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createdoublearray_183448826.md b/windows.foundation/propertyvalue_createdoublearray_183448826.md index 0f04de3e6f..0ffd21093a 100644 --- a/windows.foundation/propertyvalue_createdoublearray_183448826.md +++ b/windows.foundation/propertyvalue_createdoublearray_183448826.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateDoubleArray(System.Double[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateDoubleArray ## -description Creates a property value from an array of floating-point values. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateDoubleArray(System.Double[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateDoubleArray + +## -description +Creates a property value from an array of floating-point values. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createempty_1840142069.md b/windows.foundation/propertyvalue_createempty_1840142069.md index 8efcbd7064..ebbe0a6d06 100644 --- a/windows.foundation/propertyvalue_createempty_1840142069.md +++ b/windows.foundation/propertyvalue_createempty_1840142069.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateEmpty --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateEmpty ## -description Creates an empty property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateEmpty +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateEmpty + +## -description +Creates an empty property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createguid_165164614.md b/windows.foundation/propertyvalue_createguid_165164614.md index 84ff449242..afffaf16f9 100644 --- a/windows.foundation/propertyvalue_createguid_165164614.md +++ b/windows.foundation/propertyvalue_createguid_165164614.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateGuid(System.Guid) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateGuid ## -description Creates a property value from a GUID. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateGuid(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateGuid + +## -description +Creates a property value from a GUID. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createguidarray_307403823.md b/windows.foundation/propertyvalue_createguidarray_307403823.md index 71f77ec0d3..e36697d47a 100644 --- a/windows.foundation/propertyvalue_createguidarray_307403823.md +++ b/windows.foundation/propertyvalue_createguidarray_307403823.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateGuidArray(System.Guid[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateGuidArray ## -description Creates a property value from an array of GUID. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateGuidArray(System.Guid[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateGuidArray + +## -description +Creates a property value from an array of GUID. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createinspectable_409346805.md b/windows.foundation/propertyvalue_createinspectable_409346805.md index f90b904fe9..0fb3152ee0 100644 --- a/windows.foundation/propertyvalue_createinspectable_409346805.md +++ b/windows.foundation/propertyvalue_createinspectable_409346805.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInspectable(System.Object) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInspectable ## -description Creates a property value from an inspectable object. ## -parameters ### -param value The object to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInspectable(System.Object) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInspectable + +## -description +Creates a property value from an inspectable object. + +## -parameters +### -param value +The object to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createinspectablearray_1894012880.md b/windows.foundation/propertyvalue_createinspectablearray_1894012880.md index 8acb32dd0d..690848f88b 100644 --- a/windows.foundation/propertyvalue_createinspectablearray_1894012880.md +++ b/windows.foundation/propertyvalue_createinspectablearray_1894012880.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInspectableArray(System.Object[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInspectableArray ## -description Creates a property value from an array of inspectable objects. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInspectableArray(System.Object[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInspectableArray + +## -description +Creates a property value from an array of inspectable objects. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createint16_264907374.md b/windows.foundation/propertyvalue_createint16_264907374.md index c02187e9e5..265d534c50 100644 --- a/windows.foundation/propertyvalue_createint16_264907374.md +++ b/windows.foundation/propertyvalue_createint16_264907374.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInt16(System.Int16) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInt16 ## -description Creates a property value from an integer. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInt16(System.Int16) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInt16 + +## -description +Creates a property value from an integer. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createint16array_242683527.md b/windows.foundation/propertyvalue_createint16array_242683527.md index 05a2d1939f..f17cf14af9 100644 --- a/windows.foundation/propertyvalue_createint16array_242683527.md +++ b/windows.foundation/propertyvalue_createint16array_242683527.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInt16Array(System.Int16[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInt16Array ## -description Creates a property value from an array of integers. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInt16Array(System.Int16[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInt16Array + +## -description +Creates a property value from an array of integers. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createint32_1918828316.md b/windows.foundation/propertyvalue_createint32_1918828316.md index 1e23803764..81fde4da9b 100644 --- a/windows.foundation/propertyvalue_createint32_1918828316.md +++ b/windows.foundation/propertyvalue_createint32_1918828316.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInt32(System.Int32) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInt32 ## -description Creates a property value from an integer. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInt32(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInt32 + +## -description +Creates a property value from an integer. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createint32array_728873527.md b/windows.foundation/propertyvalue_createint32array_728873527.md index f6812720f9..1706d33317 100644 --- a/windows.foundation/propertyvalue_createint32array_728873527.md +++ b/windows.foundation/propertyvalue_createint32array_728873527.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInt32Array(System.Int32[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInt32Array ## -description Creates a property value from an array of integers. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInt32Array(System.Int32[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInt32Array + +## -description +Creates a property value from an array of integers. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createint64_461411779.md b/windows.foundation/propertyvalue_createint64_461411779.md index 6bb7488fc7..ecd534f6a3 100644 --- a/windows.foundation/propertyvalue_createint64_461411779.md +++ b/windows.foundation/propertyvalue_createint64_461411779.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInt64(System.Int64) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInt64 ## -description Creates a property value from an integer. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInt64(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInt64 + +## -description +Creates a property value from an integer. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createint64array_52978078.md b/windows.foundation/propertyvalue_createint64array_52978078.md index 24bba5e4b0..58262da44f 100644 --- a/windows.foundation/propertyvalue_createint64array_52978078.md +++ b/windows.foundation/propertyvalue_createint64array_52978078.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateInt64Array(System.Int64[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateInt64Array ## -description Creates a property value from an array of integers. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateInt64Array(System.Int64[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateInt64Array + +## -description +Creates a property value from an array of integers. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createpoint_1374466557.md b/windows.foundation/propertyvalue_createpoint_1374466557.md index 8a25c377db..be65a52cfd 100644 --- a/windows.foundation/propertyvalue_createpoint_1374466557.md +++ b/windows.foundation/propertyvalue_createpoint_1374466557.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreatePoint(Windows.Foundation.Point) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreatePoint ## -description Creates a property value from a point structure. ## -parameters ### -param value The structure to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreatePoint(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreatePoint + +## -description +Creates a property value from a point structure. + +## -parameters +### -param value +The structure to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createpointarray_1768269867.md b/windows.foundation/propertyvalue_createpointarray_1768269867.md index 04ad7d008d..f6162baf97 100644 --- a/windows.foundation/propertyvalue_createpointarray_1768269867.md +++ b/windows.foundation/propertyvalue_createpointarray_1768269867.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreatePointArray(Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreatePointArray ## -description Creates a property value from an array of point structures. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreatePointArray(Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreatePointArray + +## -description +Creates a property value from an array of point structures. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createrect_1127429556.md b/windows.foundation/propertyvalue_createrect_1127429556.md index cd4370cd66..265b02e1c2 100644 --- a/windows.foundation/propertyvalue_createrect_1127429556.md +++ b/windows.foundation/propertyvalue_createrect_1127429556.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateRect(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateRect ## -description Creates a property value from a rectangle structure. ## -parameters ### -param value The structure to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateRect(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateRect + +## -description +Creates a property value from a rectangle structure. + +## -parameters +### -param value +The structure to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createrectarray_881433712.md b/windows.foundation/propertyvalue_createrectarray_881433712.md index 39a83c2c15..fa601193f6 100644 --- a/windows.foundation/propertyvalue_createrectarray_881433712.md +++ b/windows.foundation/propertyvalue_createrectarray_881433712.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateRectArray(Windows.Foundation.Rect[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateRectArray ## -description Creates a property value from an array of rectangle structures. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateRectArray(Windows.Foundation.Rect[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateRectArray + +## -description +Creates a property value from an array of rectangle structures. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createsingle_544015971.md b/windows.foundation/propertyvalue_createsingle_544015971.md index d75fb4f77a..3f58561a34 100644 --- a/windows.foundation/propertyvalue_createsingle_544015971.md +++ b/windows.foundation/propertyvalue_createsingle_544015971.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateSingle(System.Single) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateSingle ## -description Creates a property value from a floating-point value. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateSingle(System.Single) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateSingle + +## -description +Creates a property value from a floating-point value. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createsinglearray_914883933.md b/windows.foundation/propertyvalue_createsinglearray_914883933.md index ec41ef251b..e0ed7a213d 100644 --- a/windows.foundation/propertyvalue_createsinglearray_914883933.md +++ b/windows.foundation/propertyvalue_createsinglearray_914883933.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateSingleArray(System.Single[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateSingleArray ## -description Creates a property value from an array of floating-point values. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateSingleArray(System.Single[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateSingleArray + +## -description +Creates a property value from an array of floating-point values. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createsize_1279888895.md b/windows.foundation/propertyvalue_createsize_1279888895.md index 792b93d2ba..98201342cc 100644 --- a/windows.foundation/propertyvalue_createsize_1279888895.md +++ b/windows.foundation/propertyvalue_createsize_1279888895.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateSize(Windows.Foundation.Size) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateSize ## -description Creates a property value from a size structure. ## -parameters ### -param value The structure to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateSize(Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateSize + +## -description +Creates a property value from a size structure. + +## -parameters +### -param value +The structure to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createsizearray_1420622301.md b/windows.foundation/propertyvalue_createsizearray_1420622301.md index 07bcc2e077..2d3ec545c1 100644 --- a/windows.foundation/propertyvalue_createsizearray_1420622301.md +++ b/windows.foundation/propertyvalue_createsizearray_1420622301.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateSizeArray(Windows.Foundation.Size[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateSizeArray ## -description Creates a property value from an array of size structures. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateSizeArray(Windows.Foundation.Size[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateSizeArray + +## -description +Creates a property value from an array of size structures. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createstring_250855876.md b/windows.foundation/propertyvalue_createstring_250855876.md index c015c1e823..063b9083d6 100644 --- a/windows.foundation/propertyvalue_createstring_250855876.md +++ b/windows.foundation/propertyvalue_createstring_250855876.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateString(System.String) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateString ## -description Creates a property value from a string. ## -parameters ### -param value The string to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateString(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateString + +## -description +Creates a property value from a string. + +## -parameters +### -param value +The string to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createstringarray_818861196.md b/windows.foundation/propertyvalue_createstringarray_818861196.md index 1294b25c0f..5b3d9efa68 100644 --- a/windows.foundation/propertyvalue_createstringarray_818861196.md +++ b/windows.foundation/propertyvalue_createstringarray_818861196.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateStringArray(System.String[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateStringArray ## -description Creates a property value from an array of strings. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateStringArray(System.String[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateStringArray + +## -description +Creates a property value from an array of strings. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createtimespan_242715367.md b/windows.foundation/propertyvalue_createtimespan_242715367.md index 60c03de509..802055b356 100644 --- a/windows.foundation/propertyvalue_createtimespan_242715367.md +++ b/windows.foundation/propertyvalue_createtimespan_242715367.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateTimeSpan(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateTimeSpan ## -description Creates a property value from a time interval. ## -parameters ### -param value The time interval to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateTimeSpan(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateTimeSpan + +## -description +Creates a property value from a time interval. + +## -parameters +### -param value +The time interval to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createtimespanarray_116629448.md b/windows.foundation/propertyvalue_createtimespanarray_116629448.md index 2699e20d9f..b614f95431 100644 --- a/windows.foundation/propertyvalue_createtimespanarray_116629448.md +++ b/windows.foundation/propertyvalue_createtimespanarray_116629448.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateTimeSpanArray(Windows.Foundation.TimeSpan[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateTimeSpanArray ## -description Creates a property value from an array of time intervals. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateTimeSpanArray(Windows.Foundation.TimeSpan[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateTimeSpanArray + +## -description +Creates a property value from an array of time intervals. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint16_1521043252.md b/windows.foundation/propertyvalue_createuint16_1521043252.md index f98a7dae2f..04dea42e5a 100644 --- a/windows.foundation/propertyvalue_createuint16_1521043252.md +++ b/windows.foundation/propertyvalue_createuint16_1521043252.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt16(System.UInt16) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt16 ## -description Creates a property value from an unsigned integer. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt16(System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt16 + +## -description +Creates a property value from an unsigned integer. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint16array_2604702.md b/windows.foundation/propertyvalue_createuint16array_2604702.md index 7984529ccf..5425ddcb60 100644 --- a/windows.foundation/propertyvalue_createuint16array_2604702.md +++ b/windows.foundation/propertyvalue_createuint16array_2604702.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt16Array(System.UInt16[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt16Array ## -description Creates a property value from an array of unsigned integers. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt16Array(System.UInt16[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt16Array + +## -description +Creates a property value from an array of unsigned integers. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint32_861389818.md b/windows.foundation/propertyvalue_createuint32_861389818.md index 694350cf5f..14c76af040 100644 --- a/windows.foundation/propertyvalue_createuint32_861389818.md +++ b/windows.foundation/propertyvalue_createuint32_861389818.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt32(System.UInt32) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt32 ## -description Creates a property value from an unsigned integer. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt32(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt32 + +## -description +Creates a property value from an unsigned integer. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint32array_1983517116.md b/windows.foundation/propertyvalue_createuint32array_1983517116.md index 0843dccc53..f36d6a5b9c 100644 --- a/windows.foundation/propertyvalue_createuint32array_1983517116.md +++ b/windows.foundation/propertyvalue_createuint32array_1983517116.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt32Array(System.UInt32[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt32Array ## -description Creates a property value from an array of unsigned integers. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt32Array(System.UInt32[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt32Array + +## -description +Creates a property value from an array of unsigned integers. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint64_1249369045.md b/windows.foundation/propertyvalue_createuint64_1249369045.md index 73546afe70..65b898806d 100644 --- a/windows.foundation/propertyvalue_createuint64_1249369045.md +++ b/windows.foundation/propertyvalue_createuint64_1249369045.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt64(System.UInt64) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt64 ## -description Creates a property value from an unsigned integer. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt64(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt64 + +## -description +Creates a property value from an unsigned integer. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint64array_1576769629.md b/windows.foundation/propertyvalue_createuint64array_1576769629.md index a063854117..169e68cc0b 100644 --- a/windows.foundation/propertyvalue_createuint64array_1576769629.md +++ b/windows.foundation/propertyvalue_createuint64array_1576769629.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt64Array(System.UInt64[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt64Array ## -description Creates a property value from an array of unsigned integers. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt64Array(System.UInt64[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt64Array + +## -description +Creates a property value from an array of unsigned integers. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint8_1610483413.md b/windows.foundation/propertyvalue_createuint8_1610483413.md index 4fd11f7e1a..64cbc1d2cf 100644 --- a/windows.foundation/propertyvalue_createuint8_1610483413.md +++ b/windows.foundation/propertyvalue_createuint8_1610483413.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt8(System.Byte) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt8 ## -description Creates a property value from a byte. ## -parameters ### -param value The value to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt8(System.Byte) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt8 + +## -description +Creates a property value from a byte. + +## -parameters +### -param value +The value to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/propertyvalue_createuint8array_1938544724.md b/windows.foundation/propertyvalue_createuint8array_1938544724.md index 11e73268f4..a7b83007e5 100644 --- a/windows.foundation/propertyvalue_createuint8array_1938544724.md +++ b/windows.foundation/propertyvalue_createuint8array_1938544724.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.PropertyValue.CreateUInt8Array(System.Byte[]) --api-type: winrt method ---- # Windows.Foundation.PropertyValue.CreateUInt8Array ## -description Creates a property value from an array of bytes. ## -parameters ### -param value The array to store in the property value. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.PropertyValue.CreateUInt8Array(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.PropertyValue.CreateUInt8Array + +## -description +Creates a property value from an array of bytes. + +## -parameters +### -param value +The array to store in the property value. + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_absolutecanonicaluri.md b/windows.foundation/uri_absolutecanonicaluri.md index 9b0813e8c1..c41dda9e21 100644 --- a/windows.foundation/uri_absolutecanonicaluri.md +++ b/windows.foundation/uri_absolutecanonicaluri.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Foundation.Uri.AbsoluteCanonicalUri --api-type: winrt property ---- # Windows.Foundation.Uri.AbsoluteCanonicalUri ## -description Gets a fully canonical RFC-compliant representation of the current URI. ## -property-value The canonical URI. ## -remarks The canonical URI has all non-US ASCII characters represented as percent-encoded UTF-8 and as *Punycode* in the hostname. Use the [DisplayIri](uri_displayiri.md) property instead if you want to decode this string so that it can be presented. ## -examples ## -see-also [DisplayIri property](uri_displayiri.md), [RFC 3492 (Punycode)](http://tools.ietf.org/html/rfc3492) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.AbsoluteCanonicalUri +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.AbsoluteCanonicalUri + +## -description +Gets a fully canonical RFC-compliant representation of the current URI. + +## -property-value +The canonical URI. + +## -remarks +The canonical URI has all non-US ASCII characters represented as percent-encoded UTF-8 and as *Punycode* in the hostname. + +Use the [DisplayIri](uri_displayiri.md) property instead if you want to decode this string so that it can be presented. + +## -examples + +## -see-also +[DisplayIri property](uri_displayiri.md), [RFC 3492 (Punycode)](http://tools.ietf.org/html/rfc3492) \ No newline at end of file diff --git a/windows.foundation/uri_absoluteuri.md b/windows.foundation/uri_absoluteuri.md index c37c5a45c9..286cbd1653 100644 --- a/windows.foundation/uri_absoluteuri.md +++ b/windows.foundation/uri_absoluteuri.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Uri.AbsoluteUri --api-type: winrt property ---- # Windows.Foundation.Uri.AbsoluteUri ## -description Gets the entire, non-canonical URI (It is non-canonical because it might actually be an IRI, per the [Windows.Foundation.Uri](uri.md) encoding behavior; see Remarks.). ## -property-value The entire, non-canonical URI. ## -remarks This property is not always strictly a URI, per either RFC 3986 or RFC 3987. If you want a strict Uniform Resource Identifier (URI), use the [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) value instead. ## -examples ## -see-also [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.AbsoluteUri +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.AbsoluteUri + +## -description +Gets the entire, non-canonical URI (It is non-canonical because it might actually be an IRI, per the [Windows.Foundation.Uri](uri.md) encoding behavior; see Remarks.). + +## -property-value +The entire, non-canonical URI. + +## -remarks +This property is not always strictly a URI, per either RFC 3986 or RFC 3987. If you want a strict Uniform Resource Identifier (URI), use the [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) value instead. + +## -examples + +## -see-also +[AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) \ No newline at end of file diff --git a/windows.foundation/uri_combineuri_1875016587.md b/windows.foundation/uri_combineuri_1875016587.md index 7194364548..58eab70176 100644 --- a/windows.foundation/uri_combineuri_1875016587.md +++ b/windows.foundation/uri_combineuri_1875016587.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.Uri.CombineUri(System.String) --api-type: winrt method ---- # Windows.Foundation.Uri.CombineUri ## -description Adds the specified Uniform Resource Identifier (URI) to the current [Uri](uri.md). ## -parameters ### -param relativeUri A relative Uniform Resource Identifier (URI) specified as a string. This relative path is evaluated using the host/authority of the [Uri](uri.md) instance where this method is called. ## -returns The combined [Uri](uri.md) value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.CombineUri(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.CombineUri + +## -description +Adds the specified Uniform Resource Identifier (URI) to the current [Uri](uri.md). + +## -parameters +### -param relativeUri +A relative Uniform Resource Identifier (URI) specified as a string. This relative path is evaluated using the host/authority of the [Uri](uri.md) instance where this method is called. + +## -returns +The combined [Uri](uri.md) value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_displayiri.md b/windows.foundation/uri_displayiri.md index 1036cdc92f..1c87aeb50a 100644 --- a/windows.foundation/uri_displayiri.md +++ b/windows.foundation/uri_displayiri.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Uri.DisplayIri --api-type: winrt property ---- # Windows.Foundation.Uri.DisplayIri ## -description Gets the decoded unicode characters that make up the current URI. ## -property-value The decoded unicode characters, when possible. Unsafe values are renamed as percent-encoded UTF-8. Characters in the hostname are decoded if they were encoded using*Punycode*. ## -remarks The [DisplayIri](uri_displayiri.md) property is an attempted decode of the string as seen in the [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) property. You might use this string for display to the user, where showing the encodings would be distracting and would make link text that parallels the Uniform Resource Identifier (URI) difficult to read as text. Unsafe values (values that can't be decoded under the user's codepage) are kept as percent-encoded UTF-8. ## -examples ## -see-also [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.DisplayIri +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.DisplayIri + +## -description +Gets the decoded unicode characters that make up the current URI. + +## -property-value +The decoded unicode characters, when possible. Unsafe values are renamed as percent-encoded UTF-8. Characters in the hostname are decoded if they were encoded using*Punycode*. + +## -remarks +The [DisplayIri](uri_displayiri.md) property is an attempted decode of the string as seen in the [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) property. You might use this string for display to the user, where showing the encodings would be distracting and would make link text that parallels the Uniform Resource Identifier (URI) difficult to read as text. Unsafe values (values that can't be decoded under the user's codepage) are kept as percent-encoded UTF-8. + +## -examples + +## -see-also +[AbsoluteCanonicalUri](uri_absolutecanonicaluri.md) \ No newline at end of file diff --git a/windows.foundation/uri_displayuri.md b/windows.foundation/uri_displayuri.md index 9d84e9ae87..d5f32af4c2 100644 --- a/windows.foundation/uri_displayuri.md +++ b/windows.foundation/uri_displayuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Uri.DisplayUri --api-type: winrt property ---- # Windows.Foundation.Uri.DisplayUri ## -description Gets a representation of the Uniform Resource Identifier (URI) that can be used for display purposes. ## -property-value The Uniform Resource Identifier (URI) for display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.DisplayUri +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.DisplayUri + +## -description +Gets a representation of the Uniform Resource Identifier (URI) that can be used for display purposes. + +## -property-value +The Uniform Resource Identifier (URI) for display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_domain.md b/windows.foundation/uri_domain.md index 5f6fc3f24f..e686071402 100644 --- a/windows.foundation/uri_domain.md +++ b/windows.foundation/uri_domain.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Uri.Domain --api-type: winrt property ---- # Windows.Foundation.Uri.Domain ## -description Gets the domain name component, including top-level domain, from a Uniform Resource Identifier (URI). ## -property-value The domain name. ## -remarks If the domain name is subject to *Punycode* encoding as shown in [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md), the [Domain](uri_domain.md) property shows the decoded value, not the *Punycode* encoded value. ## -examples ## -see-also [Path](uri_path.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Domain +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Domain + +## -description +Gets the domain name component, including top-level domain, from a Uniform Resource Identifier (URI). + +## -property-value +The domain name. + +## -remarks +If the domain name is subject to *Punycode* encoding as shown in [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md), the [Domain](uri_domain.md) property shows the decoded value, not the *Punycode* encoded value. + +## -examples + +## -see-also +[Path](uri_path.md) \ No newline at end of file diff --git a/windows.foundation/uri_equals_1381697556.md b/windows.foundation/uri_equals_1381697556.md index 3169f554e6..6d418f1e44 100644 --- a/windows.foundation/uri_equals_1381697556.md +++ b/windows.foundation/uri_equals_1381697556.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Foundation.Uri.Equals(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.Foundation.Uri.Equals ## -description Determines whether the specified [Uri](uri.md) object is equal to the current [Uri](uri.md) object. ## -parameters ### -param pUri The [Uri](uri.md) object to be compared. ## -returns **true** if the two [Uri](uri.md) values are the same; otherwise, **false**. ## -remarks Equality comparison is based on the logical content (the property values). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.Equals(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.Equals + +## -description +Determines whether the specified [Uri](uri.md) object is equal to the current [Uri](uri.md) object. + +## -parameters +### -param pUri +The [Uri](uri.md) object to be compared. + +## -returns +**true** if the two [Uri](uri.md) values are the same; otherwise, **false**. + +## -remarks +Equality comparison is based on the logical content (the property values). + + + + +## -examples + +## -see-also diff --git a/windows.foundation/uri_escapecomponent_580804330.md b/windows.foundation/uri_escapecomponent_580804330.md index 4d1027e887..e292153201 100644 --- a/windows.foundation/uri_escapecomponent_580804330.md +++ b/windows.foundation/uri_escapecomponent_580804330.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Foundation.Uri.EscapeComponent(System.String) --api-type: winrt method ---- # Windows.Foundation.Uri.EscapeComponent ## -description Converts a Uniform Resource Identifier (URI) string to its escaped representation. ## -parameters ### -param toEscape The string to convert. ## -returns The escaped representation of *toEscape*. ## -remarks Use [EscapeComponent](uri_escapecomponent.md) as a utility to escape any Uniform Resource Identifier (URI) component that requires escaping in order to construct a valid [Uri](uri.md) object. For example, if your app is using a user-provided string and adding it to a query that is sent to a service, you may need to escape that string in the Uniform Resource Identifier (URI) because the string might contain characters that are invalid in a Uniform Resource Identifier (URI). This includes characters as simple as spaces; even input that seems to be pure ASCII may still need encoding to be valid as a component of a Uniform Resource Identifier (URI). You can append the string you get from [EscapeComponent](uri_escapecomponent.md) onto other strings before calling the [Uri(String) constructor](uri_uri_290278668.md). You'll want to encode each component separately, because you do not want to escape the characters that are significant to how the [Uri(String) constructor](uri_uri_290278668.md) parses the string into components, such as the "/" between host and path or the "?" between path and query. [EscapeComponent](uri_escapecomponent.md) might also be useful for other scenarios where a Uniform Resource Identifier (URI)-escaped string is needed for an HTTP request scenario, such as using APIs in the [Windows.Web.Http](../windows.web.http/windows_web_http.md) namespace. ## -examples ## -see-also [Uri(String) constructor](uri_uri_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.EscapeComponent(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.EscapeComponent + +## -description +Converts a Uniform Resource Identifier (URI) string to its escaped representation. + +## -parameters +### -param toEscape +The string to convert. + +## -returns +The escaped representation of *toEscape*. + +## -remarks +Use [EscapeComponent](uri_escapecomponent.md) as a utility to escape any Uniform Resource Identifier (URI) component that requires escaping in order to construct a valid [Uri](uri.md) object. For example, if your app is using a user-provided string and adding it to a query that is sent to a service, you may need to escape that string in the Uniform Resource Identifier (URI) because the string might contain characters that are invalid in a Uniform Resource Identifier (URI). This includes characters as simple as spaces; even input that seems to be pure ASCII may still need encoding to be valid as a component of a Uniform Resource Identifier (URI). + +You can append the string you get from [EscapeComponent](uri_escapecomponent.md) onto other strings before calling the [Uri(String) constructor](uri_uri_290278668.md). You'll want to encode each component separately, because you do not want to escape the characters that are significant to how the [Uri(String) constructor](uri_uri_290278668.md) parses the string into components, such as the "/" between host and path or the "?" between path and query. + +[EscapeComponent](uri_escapecomponent.md) might also be useful for other scenarios where a Uniform Resource Identifier (URI)-escaped string is needed for an HTTP request scenario, such as using APIs in the [Windows.Web.Http](../windows.web.http/windows_web_http.md) namespace. + +## -examples + +## -see-also +[Uri(String) constructor](uri_uri_290278668.md) \ No newline at end of file diff --git a/windows.foundation/uri_extension.md b/windows.foundation/uri_extension.md index c0e0a52354..786b8853b1 100644 --- a/windows.foundation/uri_extension.md +++ b/windows.foundation/uri_extension.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Uri.Extension --api-type: winrt property ---- # Windows.Foundation.Uri.Extension ## -description Gets the file name extension of the resource that is referenced in the [Uri](uri.md). ## -property-value The file name extension. The dot (.) is not part of the extension. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Extension +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Extension + +## -description +Gets the file name extension of the resource that is referenced in the [Uri](uri.md). + +## -property-value +The file name extension. The dot (.) is not part of the extension. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_fragment.md b/windows.foundation/uri_fragment.md index 7d1d3cbe66..dcce0c7572 100644 --- a/windows.foundation/uri_fragment.md +++ b/windows.foundation/uri_fragment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Uri.Fragment --api-type: winrt property ---- # Windows.Foundation.Uri.Fragment ## -description Gets the text following a fragment marker (#), including the fragment marker itself. ## -property-value The text that represents the fragment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Fragment +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Fragment + +## -description +Gets the text following a fragment marker (#), including the fragment marker itself. + +## -property-value +The text that represents the fragment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_host.md b/windows.foundation/uri_host.md index 2888648787..be2c868b31 100644 --- a/windows.foundation/uri_host.md +++ b/windows.foundation/uri_host.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Uri.Host --api-type: winrt property ---- # Windows.Foundation.Uri.Host ## -description Gets the fully qualified domain name. ## -property-value The fully qualified domain name. ## -remarks If the domain name is subject to *Punycode* encoding as shown in [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md), the [Host](uri_host.md) property shows the decoded value, not the *Punycode* encoded value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Host +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Host + +## -description +Gets the fully qualified domain name. + +## -property-value +The fully qualified domain name. + +## -remarks +If the domain name is subject to *Punycode* encoding as shown in [AbsoluteCanonicalUri](uri_absolutecanonicaluri.md), the [Host](uri_host.md) property shows the decoded value, not the *Punycode* encoded value. + +## -examples + +## -see-also diff --git a/windows.foundation/uri_password.md b/windows.foundation/uri_password.md index d173c987c2..1f94d7b421 100644 --- a/windows.foundation/uri_password.md +++ b/windows.foundation/uri_password.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Uri.Password --api-type: winrt property ---- # Windows.Foundation.Uri.Password ## -description Gets the password component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. ## -property-value The password. ## -remarks > [!NOTE] > *username*:*password***@** preceding the *host* part of a URI are mainly relevant for File Transfer Protocol (FTP) URIs. File Transfer Protocol (FTP) URIs have limited support in Windows Runtime; see "Transferring data in the background" ([HTML](http://msdn.microsoft.com/library/9e2ed5b4-af57-456a-884f-1e1d2136a8e8) or [XAML](http://msdn.microsoft.com/library/dfc4d2a2-8825-4c12-87db-9743ba3bd167)). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Password +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Password + +## -description +Gets the password component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. + +## -property-value +The password. + +## -remarks +> [!NOTE] +> *username*:*password***@** preceding the *host* part of a URI are mainly relevant for File Transfer Protocol (FTP) URIs. File Transfer Protocol (FTP) URIs have limited support in Windows Runtime; see "Transferring data in the background" ([HTML](http://msdn.microsoft.com/library/9e2ed5b4-af57-456a-884f-1e1d2136a8e8) or [XAML](http://msdn.microsoft.com/library/dfc4d2a2-8825-4c12-87db-9743ba3bd167)). + +## -examples + +## -see-also diff --git a/windows.foundation/uri_path.md b/windows.foundation/uri_path.md index 62a69a07af..573f7134cb 100644 --- a/windows.foundation/uri_path.md +++ b/windows.foundation/uri_path.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Uri.Path --api-type: winrt property ---- # Windows.Foundation.Uri.Path ## -description Gets the path and resource name component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. ## -property-value The path, including the resource name, and including the extension. Does not include query or fragment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Path +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Path + +## -description +Gets the path and resource name component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. + +## -property-value +The path, including the resource name, and including the extension. Does not include query or fragment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_port.md b/windows.foundation/uri_port.md index 0a0dfc7a8d..321ee7aff1 100644 --- a/windows.foundation/uri_port.md +++ b/windows.foundation/uri_port.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Uri.Port --api-type: winrt property ---- # Windows.Foundation.Uri.Port ## -description Gets the port number component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance ## -property-value The port number. ## -remarks This property reports the implicit defaults for schemes, such as 80 for http:. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Port +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Port + +## -description +Gets the port number component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance + +## -property-value +The port number. + +## -remarks +This property reports the implicit defaults for schemes, such as 80 for http:. + +## -examples + +## -see-also diff --git a/windows.foundation/uri_query.md b/windows.foundation/uri_query.md index c390689836..549b32e75c 100644 --- a/windows.foundation/uri_query.md +++ b/windows.foundation/uri_query.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Uri.Query --api-type: winrt property ---- # Windows.Foundation.Uri.Query ## -description Gets the query string component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. ## -property-value The query string. ## -remarks [Query](uri_query.md) reports the query portion of the Uniform Resource Identifier (URI), and the subdelimiters (& characters) and key-value separators (=) are all reported as-is in that string. [QueryParsed](uri_queryparsed.md) parses this string and creates a map of key-value pairs. This map is returned as a [WwwFormUrlDecoder](wwwformurldecoder.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Query +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Query + +## -description +Gets the query string component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. + +## -property-value +The query string. + +## -remarks +[Query](uri_query.md) reports the query portion of the Uniform Resource Identifier (URI), and the subdelimiters (& characters) and key-value separators (=) are all reported as-is in that string. [QueryParsed](uri_queryparsed.md) parses this string and creates a map of key-value pairs. This map is returned as a [WwwFormUrlDecoder](wwwformurldecoder.md) object. + +## -examples + +## -see-also diff --git a/windows.foundation/uri_queryparsed.md b/windows.foundation/uri_queryparsed.md index 52056384a0..6a9887e950 100644 --- a/windows.foundation/uri_queryparsed.md +++ b/windows.foundation/uri_queryparsed.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Uri.QueryParsed --api-type: winrt property ---- # Windows.Foundation.Uri.QueryParsed ## -description Gets a parsed Uniform Resource Identifier (URI) query string. ## -property-value The parsed query, as a new [WwwFormUrlDecoder](wwwformurldecoder.md) object. This is a read-only list of all name-value pairs (the form entries) as found in the query string after parsing. ## -remarks [Query](uri_query.md) reports the query portion of the Uniform Resource Identifier (URI), and the subdelimiters (& characters) and key-value separators (=) are all reported as-is in that string. [QueryParsed](uri_queryparsed.md) parses this string and creates a read-only list (vector) of name-value pairs. This is returned as a [WwwFormUrlDecoder](wwwformurldecoder.md) object. ## -examples ## -see-also [WwwFormUrlDecoder](wwwformurldecoder.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.QueryParsed +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.QueryParsed + +## -description +Gets a parsed Uniform Resource Identifier (URI) query string. + +## -property-value +The parsed query, as a new [WwwFormUrlDecoder](wwwformurldecoder.md) object. This is a read-only list of all name-value pairs (the form entries) as found in the query string after parsing. + +## -remarks +[Query](uri_query.md) reports the query portion of the Uniform Resource Identifier (URI), and the subdelimiters (& characters) and key-value separators (=) are all reported as-is in that string. [QueryParsed](uri_queryparsed.md) parses this string and creates a read-only list (vector) of name-value pairs. This is returned as a [WwwFormUrlDecoder](wwwformurldecoder.md) object. + +## -examples + +## -see-also +[WwwFormUrlDecoder](wwwformurldecoder.md) \ No newline at end of file diff --git a/windows.foundation/uri_rawuri.md b/windows.foundation/uri_rawuri.md index b9b7638ac0..c66e5661f3 100644 --- a/windows.foundation/uri_rawuri.md +++ b/windows.foundation/uri_rawuri.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.Uri.RawUri --api-type: winrt property ---- # Windows.Foundation.Uri.RawUri ## -description Gets the entire original Uniform Resource Identifier (URI) string as used to construct this [Uri](uri.md) object, before parsing, and without any encoding applied. ## -property-value The raw Uniform Resource Identifier (URI) string. ## -remarks ## -examples ## -see-also [Uri(String) constructor](uri_uri_290278668.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.RawUri +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.RawUri + +## -description +Gets the entire original Uniform Resource Identifier (URI) string as used to construct this [Uri](uri.md) object, before parsing, and without any encoding applied. + +## -property-value +The raw Uniform Resource Identifier (URI) string. + +## -remarks + +## -examples + +## -see-also +[Uri(String) constructor](uri_uri_290278668.md) \ No newline at end of file diff --git a/windows.foundation/uri_schemename.md b/windows.foundation/uri_schemename.md index 4f1bcb5687..062ee7bf7d 100644 --- a/windows.foundation/uri_schemename.md +++ b/windows.foundation/uri_schemename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Uri.SchemeName --api-type: winrt property ---- # Windows.Foundation.Uri.SchemeName ## -description Gets the protocol scheme name component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance ## -property-value The protocol scheme name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.SchemeName +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.SchemeName + +## -description +Gets the protocol scheme name component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance + +## -property-value +The protocol scheme name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_suspicious.md b/windows.foundation/uri_suspicious.md index 4e3d30bab9..211a80fc5f 100644 --- a/windows.foundation/uri_suspicious.md +++ b/windows.foundation/uri_suspicious.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Foundation.Uri.Suspicious --api-type: winrt property ---- # Windows.Foundation.Uri.Suspicious ## -description Gets a value that indicates whether parsing determined that the Uniform Resource Identifier (URI) is not well-formed. ## -property-value **true** if the Uniform Resource Identifier (URI) is flagged as suspicious; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.Suspicious +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.Suspicious + +## -description +Gets a value that indicates whether parsing determined that the Uniform Resource Identifier (URI) is not well-formed. + +## -property-value +**true** if the Uniform Resource Identifier (URI) is flagged as suspicious; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/uri_tostring_1274845745.md b/windows.foundation/uri_tostring_1274845745.md index c4d26eb792..378ba05613 100644 --- a/windows.foundation/uri_tostring_1274845745.md +++ b/windows.foundation/uri_tostring_1274845745.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Uri.ToString --api-type: winrt method ---- # Windows.Foundation.Uri.ToString ## -description Gets a canonical string representation for the current [Uri](uri.md). ## -returns The unescaped canonical representation of the current [Uri](uri.md). All characters are unescaped, except #, ?, and %. ## -remarks This **ToString** implementation is for the [IStringable](istringable.md) interface as implemented by the [Uri](uri.md) class. [IStringable](istringable.md) is supported starting with Windows 8.1 and is also available in Windows Phone 8.1. The [IStringable](istringable.md) definition of **ToString** implementation is not literally an override of **Platform::Object** and its base API, but it does replace the **ToString** behavior. For Windows 8 and Windows Phone 8, [Uri](uri.md) does not implement [IStringable](istringable.md) (it's not available). So the **ToString** method of [Uri](uri.md) remains the one that's implemented by **Platform::Object** or JavaScript "object" support for Windows Runtime. The apparent difference in origin of the **ToString** API is only visible for Visual C++ component extensions (C++/CX) and JavaScript, and you should consider it as an implementation detail that doesn't matter as far as how you use **ToString** in either case. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.ToString +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.ToString + +## -description +Gets a canonical string representation for the current [Uri](uri.md). + +## -returns +The unescaped canonical representation of the current [Uri](uri.md). All characters are unescaped, except #, ?, and %. + +## -remarks + This **ToString** implementation is for the [IStringable](istringable.md) interface as implemented by the [Uri](uri.md) class. [IStringable](istringable.md) is supported starting with Windows 8.1 and is also available in Windows Phone 8.1. The [IStringable](istringable.md) definition of **ToString** implementation is not literally an override of **Platform::Object** and its base API, but it does replace the **ToString** behavior. + + For Windows 8 and Windows Phone 8, [Uri](uri.md) does not implement [IStringable](istringable.md) (it's not available). So the **ToString** method of [Uri](uri.md) remains the one that's implemented by **Platform::Object** or JavaScript "object" support for Windows Runtime. The apparent difference in origin of the **ToString** API is only visible for Visual C++ component extensions (C++/CX) and JavaScript, and you should consider it as an implementation detail that doesn't matter as far as how you use **ToString** in either case. + + + +## -examples + +## -see-also diff --git a/windows.foundation/uri_unescapecomponent_836887596.md b/windows.foundation/uri_unescapecomponent_836887596.md index 56625dab2e..33385968a5 100644 --- a/windows.foundation/uri_unescapecomponent_836887596.md +++ b/windows.foundation/uri_unescapecomponent_836887596.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Foundation.Uri.UnescapeComponent(System.String) --api-type: winrt method ---- # Windows.Foundation.Uri.UnescapeComponent ## -description Converts the specified string by replacing any escape sequences with their unescaped representation. ## -parameters ### -param toUnescape The string to convert. ## -returns The unescaped representation of *stringToUnescape*. ## -remarks Use [UnescapeComponent](uri_unescapecomponent.md) as a utility if you want a user-readable string of just a component, for example just the [Path](uri_path.md) value, unescaped. ## -examples ## -see-also [EscapeComponent](uri_escapecomponent.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.UnescapeComponent(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.UnescapeComponent + +## -description +Converts the specified string by replacing any escape sequences with their unescaped representation. + +## -parameters +### -param toUnescape +The string to convert. + +## -returns +The unescaped representation of *stringToUnescape*. + +## -remarks +Use [UnescapeComponent](uri_unescapecomponent.md) as a utility if you want a user-readable string of just a component, for example just the [Path](uri_path.md) value, unescaped. + +## -examples + +## -see-also +[EscapeComponent](uri_escapecomponent.md) \ No newline at end of file diff --git a/windows.foundation/uri_uri_1571897524.md b/windows.foundation/uri_uri_1571897524.md index 12f2067ad9..2e0031f093 100644 --- a/windows.foundation/uri_uri_1571897524.md +++ b/windows.foundation/uri_uri_1571897524.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Foundation.Uri.#ctor(System.String,System.String) --api-type: winrt method ---- # Windows.Foundation.Uri.Uri ## -description Initializes a new [Uri](uri.md) by combining a base Uniform Resource Identifier (URI) and a relative Uniform Resource Identifier (URI). Initializing the [Uri](uri.md) also parses the combined string and populates the [Uri](uri.md) properties that represent Uniform Resource Identifier (URI) components. ## -parameters ### -param baseUri The base Uniform Resource Identifier (URI). ### -param relativeUri The relative Uniform Resource Identifier (URI). ## -remarks ## -examples ## -see-also [Uri(String)](uri_uri_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.Uri + +## -description +Initializes a new [Uri](uri.md) by combining a base Uniform Resource Identifier (URI) and a relative Uniform Resource Identifier (URI). Initializing the [Uri](uri.md) also parses the combined string and populates the [Uri](uri.md) properties that represent Uniform Resource Identifier (URI) components. + +## -parameters +### -param baseUri +The base Uniform Resource Identifier (URI). + +### -param relativeUri +The relative Uniform Resource Identifier (URI). + +## -remarks + +## -examples + +## -see-also +[Uri(String)](uri_uri_290278668.md) \ No newline at end of file diff --git a/windows.foundation/uri_uri_290278668.md b/windows.foundation/uri_uri_290278668.md index 9f45e2ec98..f461753e9c 100644 --- a/windows.foundation/uri_uri_290278668.md +++ b/windows.foundation/uri_uri_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Foundation.Uri.#ctor(System.String) --api-type: winrt method ---- # Windows.Foundation.Uri.Uri ## -description Initializes a new [Uri](uri.md) object from the specified Uniform Resource Identifier (URI) string. Initializing the [Uri](uri.md) also parses the string and populates the [Uri](uri.md) properties that represent Uniform Resource Identifier (URI) components. ## -parameters ### -param uri The string from which the new [Uri](uri.md) object is created. ## -remarks ## -examples ## -see-also [Uri(String, String)](uri_uri_1571897524.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.Uri.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Uri.Uri + +## -description +Initializes a new [Uri](uri.md) object from the specified Uniform Resource Identifier (URI) string. Initializing the [Uri](uri.md) also parses the string and populates the [Uri](uri.md) properties that represent Uniform Resource Identifier (URI) components. + +## -parameters +### -param uri +The string from which the new [Uri](uri.md) object is created. + +## -remarks + +## -examples + +## -see-also +[Uri(String, String)](uri_uri_1571897524.md) \ No newline at end of file diff --git a/windows.foundation/uri_username.md b/windows.foundation/uri_username.md index a33eeb7b4d..cfcd0e380f 100644 --- a/windows.foundation/uri_username.md +++ b/windows.foundation/uri_username.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Foundation.Uri.UserName --api-type: winrt property ---- # Windows.Foundation.Uri.UserName ## -description Gets the user name component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. ## -property-value The user name. ## -remarks > [!NOTE] > *username*:*password***@** preceding the *host* part of a URI are mainly relevant for File Transfer Protocol (FTP) Uniform Resource Identifier (URI). File Transfer Protocol (FTP) Uniform Resource Identifier (URI) have limited support in Windows Runtime; see "Transferring data in the background" ([HTML](http://msdn.microsoft.com/library/9e2ed5b4-af57-456a-884f-1e1d2136a8e8) or [XAML](http://msdn.microsoft.com/library/dfc4d2a2-8825-4c12-87db-9743ba3bd167)). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Uri.UserName +-api-type: winrt property +--- + + + +# Windows.Foundation.Uri.UserName + +## -description +Gets the user name component of the Uniform Resource Identifier (URI) as stored in this [Uri](uri.md) instance. + +## -property-value +The user name. + +## -remarks +> [!NOTE] +> *username*:*password***@** preceding the *host* part of a URI are mainly relevant for File Transfer Protocol (FTP) Uniform Resource Identifier (URI). File Transfer Protocol (FTP) Uniform Resource Identifier (URI) have limited support in Windows Runtime; see "Transferring data in the background" ([HTML](http://msdn.microsoft.com/library/9e2ed5b4-af57-456a-884f-1e1d2136a8e8) or [XAML](http://msdn.microsoft.com/library/dfc4d2a2-8825-4c12-87db-9743ba3bd167)). + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_first_1920739956.md b/windows.foundation/wwwformurldecoder_first_1920739956.md index dd23b7dea9..dc5301fe3b 100644 --- a/windows.foundation/wwwformurldecoder_first_1920739956.md +++ b/windows.foundation/wwwformurldecoder_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Foundation.WwwFormUrlDecoder.First --api-type: winrt method ---- # Windows.Foundation.WwwFormUrlDecoder.First ## -description Gets an iterator that represents the first name-value pair in the current URL query string. ## -returns The first name-value pair. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.WwwFormUrlDecoder.First +-api-type: winrt method +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.First + +## -description +Gets an iterator that represents the first name-value pair in the current URL query string. + +## -returns +The first name-value pair. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_getat_496709656.md b/windows.foundation/wwwformurldecoder_getat_496709656.md index 60c5118fe3..5a54e21ca5 100644 --- a/windows.foundation/wwwformurldecoder_getat_496709656.md +++ b/windows.foundation/wwwformurldecoder_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Foundation.WwwFormUrlDecoder.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Foundation.WwwFormUrlDecoder.GetAt ## -description Gets the name-value pair at the specified index in the current URL query string. ## -parameters ### -param index The index of the name-value pair. ## -returns The name-value pair at the position specified by *index*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.WwwFormUrlDecoder.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.GetAt + +## -description +Gets the name-value pair at the specified index in the current URL query string. + +## -parameters +### -param index +The index of the name-value pair. + +## -returns +The name-value pair at the position specified by *index*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_getfirstvaluebyname_186006860.md b/windows.foundation/wwwformurldecoder_getfirstvaluebyname_186006860.md index 4f57cf0701..2169117b8b 100644 --- a/windows.foundation/wwwformurldecoder_getfirstvaluebyname_186006860.md +++ b/windows.foundation/wwwformurldecoder_getfirstvaluebyname_186006860.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.WwwFormUrlDecoder.GetFirstValueByName(System.String) --api-type: winrt method ---- # Windows.Foundation.WwwFormUrlDecoder.GetFirstValueByName ## -description Gets the first name-value pair that has the specified name, as obtained from the constructing Uniform Resource Identifier (URI) query string. ## -parameters ### -param name The name of the value to get. ## -returns The first value in list order that corresponds with *name*. ## -remarks This method throws an exception (an error for JavaScript) if the value specified as name doesn't exist in the [WwwFormUrlDecoder](wwwformurldecoder.md) collection. For .NET code, this is typed as **System.ArgumentException**. You'll probably want to call [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) within a **try-catch** block so you have a chance to handle the exception. What to do with duplicate names in a query string from a GET request is not specified by any Internet standard. A common practice is to process the first value and ignore the subsequent duplicates. The [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) method provides that behavior. It also provides the de-facto "index by string" behavior, which is typically what you want when you're processing a query string. Your app is expecting certain names to be present on the query string, and wants to retrieve the associated value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.WwwFormUrlDecoder.GetFirstValueByName(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.GetFirstValueByName + +## -description +Gets the first name-value pair that has the specified name, as obtained from the constructing Uniform Resource Identifier (URI) query string. + +## -parameters +### -param name +The name of the value to get. + +## -returns +The first value in list order that corresponds with *name*. + +## -remarks +This method throws an exception (an error for JavaScript) if the value specified as name doesn't exist in the [WwwFormUrlDecoder](wwwformurldecoder.md) collection. For .NET code, this is typed as **System.ArgumentException**. You'll probably want to call [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) within a **try-catch** block so you have a chance to handle the exception. + +What to do with duplicate names in a query string from a GET request is not specified by any Internet standard. A common practice is to process the first value and ignore the subsequent duplicates. The [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) method provides that behavior. It also provides the de-facto "index by string" behavior, which is typically what you want when you're processing a query string. Your app is expecting certain names to be present on the query string, and wants to retrieve the associated value. + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_getmany_2003817202.md b/windows.foundation/wwwformurldecoder_getmany_2003817202.md index 582c9974f7..ab706227ef 100644 --- a/windows.foundation/wwwformurldecoder_getmany_2003817202.md +++ b/windows.foundation/wwwformurldecoder_getmany_2003817202.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.WwwFormUrlDecoder.GetMany(System.UInt32,Windows.Foundation.IWwwFormUrlDecoderEntry[]) --api-type: winrt method ---- # Windows.Foundation.WwwFormUrlDecoder.GetMany ## -description Gets name-value pairs starting at the specified index in the current URL query string. ## -parameters ### -param startIndex The index to start getting name-value pairs at. ### -param items The name-value pairs. ## -returns The number of name-value pairs in *items*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.WwwFormUrlDecoder.GetMany(System.UInt32,Windows.Foundation.IWwwFormUrlDecoderEntry[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.GetMany + +## -description +Gets name-value pairs starting at the specified index in the current URL query string. + +## -parameters +### -param startIndex +The index to start getting name-value pairs at. + +### -param items +The name-value pairs. + +## -returns +The number of name-value pairs in *items*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_indexof_927506301.md b/windows.foundation/wwwformurldecoder_indexof_927506301.md index 9d1418aa66..b2d327a374 100644 --- a/windows.foundation/wwwformurldecoder_indexof_927506301.md +++ b/windows.foundation/wwwformurldecoder_indexof_927506301.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.WwwFormUrlDecoder.IndexOf(Windows.Foundation.IWwwFormUrlDecoderEntry,System.UInt32@) --api-type: winrt method ---- # Windows.Foundation.WwwFormUrlDecoder.IndexOf ## -description Gets a value indicating whether the specified [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) is at the specified index in the current URL query string. ## -parameters ### -param value The name-value pair to get the index of. ### -param index The position in *value*. ## -returns **true** if *value* is at the position specified by *index*; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Foundation.WwwFormUrlDecoder.IndexOf(Windows.Foundation.IWwwFormUrlDecoderEntry,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.IndexOf + +## -description +Gets a value indicating whether the specified [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) is at the specified index in the current URL query string. + +## -parameters +### -param value +The name-value pair to get the index of. + +### -param index +The position in *value*. + +## -returns +**true** if *value* is at the position specified by *index*; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_size.md b/windows.foundation/wwwformurldecoder_size.md index bf642f1ebb..63cbd77461 100644 --- a/windows.foundation/wwwformurldecoder_size.md +++ b/windows.foundation/wwwformurldecoder_size.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.WwwFormUrlDecoder.Size --api-type: winrt property ---- # Windows.Foundation.WwwFormUrlDecoder.Size ## -description Gets the number of the name-value pairs in the current URL query string. ## -property-value The number of the name-value pairs. ## -remarks Name-value pairs are represented by [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) objects. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Foundation.WwwFormUrlDecoder.Size +-api-type: winrt property +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.Size + +## -description +Gets the number of the name-value pairs in the current URL query string. + +## -property-value +The number of the name-value pairs. + +## -remarks +Name-value pairs are represented by [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) objects. + +## -examples + +## -see-also diff --git a/windows.foundation/wwwformurldecoder_wwwformurldecoder_290278668.md b/windows.foundation/wwwformurldecoder_wwwformurldecoder_290278668.md index 6b02dbc87a..d1f40dda4b 100644 --- a/windows.foundation/wwwformurldecoder_wwwformurldecoder_290278668.md +++ b/windows.foundation/wwwformurldecoder_wwwformurldecoder_290278668.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Foundation.WwwFormUrlDecoder.#ctor(System.String) --api-type: winrt method ---- # Windows.Foundation.WwwFormUrlDecoder.WwwFormUrlDecoder ## -description Creates and initializes a new instance of the [WwwFormUrlDecoder](wwwformurldecoder.md) class. ## -parameters ### -param query The URL to parse. ## -remarks The query string must start with a "?" character. Any "" character encountered represents a new name-value pair. If there is a "=" character present in the string, the substring to the left of the "=" character is the name and the right substring is the value. The constructor doesn't do much validation on the string beyond verifying that it isn't **null** or the wrong type. If your input doesn't correctly represent a query string that starts with "?" and contains name-value pairs separated by "", the collection contents are empty or invalid, and calls to [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) won't have the expected result. ## -examples ## -see-also [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) \ No newline at end of file +--- +-api-id: M:Windows.Foundation.WwwFormUrlDecoder.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.WwwFormUrlDecoder.WwwFormUrlDecoder + +## -description +Creates and initializes a new instance of the [WwwFormUrlDecoder](wwwformurldecoder.md) class. + +## -parameters +### -param query +The URL to parse. + +## -remarks +The query string must start with a "?" character. + +Any "" character encountered represents a new name-value pair. If there is a "=" character present in the string, the substring to the left of the "=" character is the name and the right substring is the value. + +The constructor doesn't do much validation on the string beyond verifying that it isn't **null** or the wrong type. If your input doesn't correctly represent a query string that starts with "?" and contains name-value pairs separated by "", the collection contents are empty or invalid, and calls to [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) won't have the expected result. + +## -examples + +## -see-also +[IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) \ No newline at end of file diff --git a/windows.foundation/wwwformurldecoderentry_name.md b/windows.foundation/wwwformurldecoderentry_name.md index 35011f3c18..ceec55abe1 100644 --- a/windows.foundation/wwwformurldecoderentry_name.md +++ b/windows.foundation/wwwformurldecoderentry_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.WwwFormUrlDecoderEntry.Name --api-type: winrt property ---- # Windows.Foundation.WwwFormUrlDecoderEntry.Name ## -description Represents the name of a parameter in a URL query string. Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface version ([IWwwFormUrlDecoderEntry.Name](iwwwformurldecoderentry_name.md)) instead; see Remarks. ## -property-value The name of a query string parameter. The [Value](wwwformurldecoderentry_value.md) property represents the corresponding value. ## -remarks ## -examples ## -see-also [IWwwFormUrlDecoderEntry.Name](iwwwformurldecoderentry_name.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.WwwFormUrlDecoderEntry.Name +-api-type: winrt property +--- + + + +# Windows.Foundation.WwwFormUrlDecoderEntry.Name + +## -description +Represents the name of a parameter in a URL query string. Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface version ([IWwwFormUrlDecoderEntry.Name](iwwwformurldecoderentry_name.md)) instead; see Remarks. + +## -property-value +The name of a query string parameter. The [Value](wwwformurldecoderentry_value.md) property represents the corresponding value. + +## -remarks + +## -examples + +## -see-also +[IWwwFormUrlDecoderEntry.Name](iwwwformurldecoderentry_name.md) \ No newline at end of file diff --git a/windows.foundation/wwwformurldecoderentry_value.md b/windows.foundation/wwwformurldecoderentry_value.md index a5c18bb56c..c5e35b148e 100644 --- a/windows.foundation/wwwformurldecoderentry_value.md +++ b/windows.foundation/wwwformurldecoderentry_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Foundation.WwwFormUrlDecoderEntry.Value --api-type: winrt property ---- # Windows.Foundation.WwwFormUrlDecoderEntry.Value ## -description Represents a named value in a URL query string. Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface version ([IWwwFormUrlDecoderEntry.Value](iwwwformurldecoderentry_value.md)) instead; see Remarks. ## -property-value The value of a query parameter that corresponds with the [Name](wwwformurldecoderentry_name.md) property. ## -remarks ## -examples ## -see-also [IWwwFormUrlDecoderEntry.Value](iwwwformurldecoderentry_value.md) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.WwwFormUrlDecoderEntry.Value +-api-type: winrt property +--- + + + +# Windows.Foundation.WwwFormUrlDecoderEntry.Value + +## -description +Represents a named value in a URL query string. Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface version ([IWwwFormUrlDecoderEntry.Value](iwwwformurldecoderentry_value.md)) instead; see Remarks. + +## -property-value +The value of a query parameter that corresponds with the [Name](wwwformurldecoderentry_name.md) property. + +## -remarks + +## -examples + +## -see-also +[IWwwFormUrlDecoderEntry.Value](iwwwformurldecoderentry_value.md) \ No newline at end of file diff --git a/windows.gaming.input.custom/gamecontrollerfactorymanager.md b/windows.gaming.input.custom/gamecontrollerfactorymanager.md index c3f5226f78..f90897a55e 100644 --- a/windows.gaming.input.custom/gamecontrollerfactorymanager.md +++ b/windows.gaming.input.custom/gamecontrollerfactorymanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.Input.Custom.GameControllerFactoryManager --api-type: winrt class ---- # Windows.Gaming.Input.Custom.GameControllerFactoryManager ## -description Manages factories for custom controllers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.Custom.GameControllerFactoryManager +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Custom.GameControllerFactoryManager + +## -description +Manages factories for custom controllers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforgipinterface_1827023401.md b/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforgipinterface_1827023401.md index 958ec61ecc..8d7c448637 100644 --- a/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforgipinterface_1827023401.md +++ b/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforgipinterface_1827023401.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForGipInterface(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,System.Guid) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForGipInterface ## -description Registers a factory for a custom Gip controller. ## -parameters ### -param factory The factory to register. ### -param interfaceId The interface ID of the factory. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForGipInterface(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForGipInterface + +## -description +Registers a factory for a custom Gip controller. + +## -parameters +### -param factory +The factory to register. + +### -param interfaceId +The interface ID of the factory. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforhardwareid_395318003.md b/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforhardwareid_395318003.md index de42a533b0..064e495e55 100644 --- a/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforhardwareid_395318003.md +++ b/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforhardwareid_395318003.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForHardwareId(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,System.UInt16,System.UInt16) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForHardwareId ## -description Registers a factory for a custom hardware ID controller. ## -parameters ### -param factory The factory to register. ### -param hardwareVendorId The hardware vendor ID. ### -param hardwareProductId The hardware product ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForHardwareId(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,System.UInt16,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForHardwareId + +## -description +Registers a factory for a custom hardware ID controller. + +## -parameters +### -param factory +The factory to register. + +### -param hardwareVendorId +The hardware vendor ID. + +### -param hardwareProductId +The hardware product ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforxusbtype_906190482.md b/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforxusbtype_906190482.md index 2f9b649c7a..3b564efd00 100644 --- a/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforxusbtype_906190482.md +++ b/windows.gaming.input.custom/gamecontrollerfactorymanager_registercustomfactoryforxusbtype_906190482.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForXusbType(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,Windows.Gaming.Input.Custom.XusbDeviceType,Windows.Gaming.Input.Custom.XusbDeviceSubtype) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForXusbType ## -description Registers a factory for a Xusb type controller. ## -parameters ### -param factory The factory to register. ### -param xusbType The Xusb device type. ### -param xusbSubtype The Xusb device subtype. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForXusbType(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,Windows.Gaming.Input.Custom.XusbDeviceType,Windows.Gaming.Input.Custom.XusbDeviceSubtype) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GameControllerFactoryManager.RegisterCustomFactoryForXusbType + +## -description +Registers a factory for a Xusb type controller. + +## -parameters +### -param factory +The factory to register. + +### -param xusbType +The Xusb device type. + +### -param xusbSubtype +The Xusb device subtype. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipfirmwareupdateresult.md b/windows.gaming.input.custom/gipfirmwareupdateresult.md index 6068d6b0c6..f55868ebef 100644 --- a/windows.gaming.input.custom/gipfirmwareupdateresult.md +++ b/windows.gaming.input.custom/gipfirmwareupdateresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult --api-type: winrt class ---- # Windows.Gaming.Input.Custom.GipFirmwareUpdateResult ## -description The result of an update operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Custom.GipFirmwareUpdateResult + +## -description +The result of an update operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipfirmwareupdateresult_extendederrorcode.md b/windows.gaming.input.custom/gipfirmwareupdateresult_extendederrorcode.md index 8b11b5dc34..d6ba089729 100644 --- a/windows.gaming.input.custom/gipfirmwareupdateresult_extendederrorcode.md +++ b/windows.gaming.input.custom/gipfirmwareupdateresult_extendederrorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.ExtendedErrorCode --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.ExtendedErrorCode ## -description The extended error code for the update operation. ## -property-value The extended error code for the update operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.ExtendedErrorCode +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.ExtendedErrorCode + +## -description +The extended error code for the update operation. + +## -property-value +The extended error code for the update operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipfirmwareupdateresult_finalcomponentid.md b/windows.gaming.input.custom/gipfirmwareupdateresult_finalcomponentid.md index 6106179ad9..e8b1046fa9 100644 --- a/windows.gaming.input.custom/gipfirmwareupdateresult_finalcomponentid.md +++ b/windows.gaming.input.custom/gipfirmwareupdateresult_finalcomponentid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.FinalComponentId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.FinalComponentId ## -description The ID of the final updated component. ## -property-value The ID of the final updated component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.FinalComponentId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.FinalComponentId + +## -description +The ID of the final updated component. + +## -property-value +The ID of the final updated component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipfirmwareupdateresult_status.md b/windows.gaming.input.custom/gipfirmwareupdateresult_status.md index 65f7c19fd6..e046526a76 100644 --- a/windows.gaming.input.custom/gipfirmwareupdateresult_status.md +++ b/windows.gaming.input.custom/gipfirmwareupdateresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.Status --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.Status ## -description Indicates the status of the firmware update operation. ## -property-value Indicates the status of the firmware update operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.Status +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipFirmwareUpdateResult.Status + +## -description +Indicates the status of the firmware update operation. + +## -property-value +Indicates the status of the firmware update operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider.md b/windows.gaming.input.custom/gipgamecontrollerprovider.md index 4b29412703..c9c695b17b 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.Custom.GipGameControllerProvider --api-type: winrt class ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider ## -description Represents a physical game controller connected to the system using GIP.SYS (for Xbox One accesories). ## -remarks ## -examples ## -see-also [IGameControllerProvider](igamecontrollerprovider.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.Custom.GipGameControllerProvider +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider + +## -description +Represents a physical game controller connected to the system using GIP.SYS (for Xbox One accesories). + +## -remarks + +## -examples + +## -see-also +[IGameControllerProvider](igamecontrollerprovider.md) \ No newline at end of file diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_firmwareversioninfo.md b/windows.gaming.input.custom/gipgamecontrollerprovider_firmwareversioninfo.md index d0531f6238..ebde2e9f4d 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_firmwareversioninfo.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_firmwareversioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.FirmwareVersionInfo --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.FirmwareVersionInfo ## -description The firmware version of the controller. ## -property-value The firmware version of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.FirmwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.FirmwareVersionInfo + +## -description +The firmware version of the controller. + +## -property-value +The firmware version of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareproductid.md b/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareproductid.md index 0283fe4c1b..cc03c09961 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareproductid.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareproductid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareProductId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareProductId ## -description The hardware product ID of the controller. ## -property-value The hardware product ID of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareProductId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareProductId + +## -description +The hardware product ID of the controller. + +## -property-value +The hardware product ID of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_hardwarevendorid.md b/windows.gaming.input.custom/gipgamecontrollerprovider_hardwarevendorid.md index b3733ea8fb..6db3429b17 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_hardwarevendorid.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_hardwarevendorid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVendorId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVendorId ## -description The hardware vendor ID of the controller. ## -property-value The hardware vendor ID of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVendorId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVendorId + +## -description +The hardware vendor ID of the controller. + +## -property-value +The hardware vendor ID of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareversioninfo.md b/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareversioninfo.md index 71711a26d4..def7d9ebb4 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareversioninfo.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_hardwareversioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVersionInfo --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVersionInfo ## -description Contains information on the hardware version of the controller. ## -property-value Contains information on the hardware version of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.HardwareVersionInfo + +## -description +Contains information on the hardware version of the controller. + +## -property-value +Contains information on the hardware version of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_isconnected.md b/windows.gaming.input.custom/gipgamecontrollerprovider_isconnected.md index e6d833cb99..92f766c154 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_isconnected.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_isconnected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.IsConnected --api-type: winrt property ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.IsConnected ## -description Boolean value indicating whether the controller is connected. ## -property-value Boolean value indicating whether the controller is connected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.GipGameControllerProvider.IsConnected +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.IsConnected + +## -description +Boolean value indicating whether the controller is connected. + +## -property-value +Boolean value indicating whether the controller is connected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_sendmessage_212925771.md b/windows.gaming.input.custom/gipgamecontrollerprovider_sendmessage_212925771.md index 88ab44eb2b..d74270b463 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_sendmessage_212925771.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_sendmessage_212925771.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.GipGameControllerProvider.SendMessage(Windows.Gaming.Input.Custom.GipMessageClass,System.Byte,System.Byte[]) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.SendMessage ## -description Sends a message. ## -parameters ### -param messageClass The class of the message. ### -param messageId The ID of the message. ### -param messageBuffer A buffer holding the message contents. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.GipGameControllerProvider.SendMessage(Windows.Gaming.Input.Custom.GipMessageClass,System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.SendMessage + +## -description +Sends a message. + +## -parameters +### -param messageClass +The class of the message. + +### -param messageId +The ID of the message. + +### -param messageBuffer +A buffer holding the message contents. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_sendreceivemessage_849024900.md b/windows.gaming.input.custom/gipgamecontrollerprovider_sendreceivemessage_849024900.md index d348b5f59c..6d6cad3162 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_sendreceivemessage_849024900.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_sendreceivemessage_849024900.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.GipGameControllerProvider.SendReceiveMessage(Windows.Gaming.Input.Custom.GipMessageClass,System.Byte,System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.SendReceiveMessage ## -description Sends a request for a message. ## -parameters ### -param messageClass The class of the message. ### -param messageId The ID of the message. ### -param requestMessageBuffer A buffer containing the request. ### -param responseMessageBuffer A buffer that will contain the request response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.GipGameControllerProvider.SendReceiveMessage(Windows.Gaming.Input.Custom.GipMessageClass,System.Byte,System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.SendReceiveMessage + +## -description +Sends a request for a message. + +## -parameters +### -param messageClass +The class of the message. + +### -param messageId +The ID of the message. + +### -param requestMessageBuffer +A buffer containing the request. + +### -param responseMessageBuffer +A buffer that will contain the request response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md b/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md index 0f04c2d44e..7e65a7375b 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.GipGameControllerProvider.UpdateFirmwareAsync(Windows.Storage.Streams.IInputStream) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.GipGameControllerProvider.UpdateFirmwareAsync ## -description Attempts to asynchronously update the firmware for the controller. ## -parameters ### -param firmwareImage A stream pointing to the firmware image to update the controller with. ## -returns Returns the result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.GipGameControllerProvider.UpdateFirmwareAsync(Windows.Storage.Streams.IInputStream) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GipGameControllerProvider.UpdateFirmwareAsync + +## -description +Attempts to asynchronously update the firmware for the controller. + +## -parameters +### -param firmwareImage +A stream pointing to the firmware image to update the controller with. + +## -returns +Returns the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller.md b/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller.md index 5971f2e9d1..438f8f6332 100644 --- a/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller.md +++ b/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.ICustomGameControllerFactory.CreateGameController(Windows.Gaming.Input.Custom.IGameControllerProvider) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.ICustomGameControllerFactory.CreateGameController ## -description Creates an instance of a game controller. ## -parameters ### -param provider The controller provider for the controller. ## -returns Returns the created object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.ICustomGameControllerFactory.CreateGameController(Windows.Gaming.Input.Custom.IGameControllerProvider) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.ICustomGameControllerFactory.CreateGameController + +## -description +Creates an instance of a game controller. + +## -parameters +### -param provider +The controller provider for the controller. + +## -returns +Returns the created object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded.md b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded.md index 41e3686c6f..d87655093f 100644 --- a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded.md +++ b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerAdded(Windows.Gaming.Input.IGameController) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerAdded ## -description Event triggered when the controller is added. ## -parameters ### -param value An interface representing the added controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerAdded(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerAdded + +## -description +Event triggered when the controller is added. + +## -parameters +### -param value +An interface representing the added controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved.md b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved.md index 139ac13e77..b6176e25f9 100644 --- a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved.md +++ b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerRemoved(Windows.Gaming.Input.IGameController) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerRemoved ## -description Event triggered when the controller is removed. ## -parameters ### -param value An interface representing the removed controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerRemoved(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerRemoved + +## -description +Event triggered when the controller is removed. + +## -parameters +### -param value +An interface representing the removed controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed.md b/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed.md index d1eadc29bd..38e2f97795 100644 --- a/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed.md +++ b/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputResumed(System.UInt64) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputResumed ## -description Event triggered when input for the controller is resumed. ## -parameters ### -param timestamp Timestamp for the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputResumed(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputResumed + +## -description +Event triggered when input for the controller is resumed. + +## -parameters +### -param timestamp +Timestamp for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended.md b/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended.md index 5040b99d42..ea5333f5b1 100644 --- a/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended.md +++ b/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputSuspended(System.UInt64) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputSuspended ## -description Event triggered when input for the controller is suspended. ## -parameters ### -param timestamp Timestamp of the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputSuspended(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputSuspended + +## -description +Event triggered when input for the controller is suspended. + +## -parameters +### -param timestamp +Timestamp of the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md b/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md index 5a35ff1ac9..bcf9dae9a7 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.FirmwareVersionInfo --api-type: winrt property ---- # Windows.Gaming.Input.Custom.IGameControllerProvider.FirmwareVersionInfo ## -description Contains information on the firmware version of the controller. ## -property-value Contains information on the firmware version of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.FirmwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerProvider.FirmwareVersionInfo + +## -description +Contains information on the firmware version of the controller. + +## -property-value +Contains information on the firmware version of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerprovider_hardwareproductid.md b/windows.gaming.input.custom/igamecontrollerprovider_hardwareproductid.md index e972371c85..24473938e6 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_hardwareproductid.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_hardwareproductid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareProductId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareProductId ## -description The hardware product ID of the controller. ## -property-value The hardware product ID of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareProductId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareProductId + +## -description +The hardware product ID of the controller. + +## -property-value +The hardware product ID of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerprovider_hardwarevendorid.md b/windows.gaming.input.custom/igamecontrollerprovider_hardwarevendorid.md index 5ed713aa87..f3b65a0793 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_hardwarevendorid.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_hardwarevendorid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVendorId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVendorId ## -description The hardware vendor ID of the controller. ## -property-value The hardware vendor ID of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVendorId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVendorId + +## -description +The hardware vendor ID of the controller. + +## -property-value +The hardware vendor ID of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md b/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md index f26b674855..fcc9713686 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVersionInfo --api-type: winrt property ---- # Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVersionInfo ## -description Contains information on the hardware version. ## -property-value Contains information on the hardware version. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerProvider.HardwareVersionInfo + +## -description +Contains information on the hardware version. + +## -property-value +Contains information on the hardware version. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igamecontrollerprovider_isconnected.md b/windows.gaming.input.custom/igamecontrollerprovider_isconnected.md index 4a3e4174be..d10f86ab63 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_isconnected.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_isconnected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.IsConnected --api-type: winrt property ---- # Windows.Gaming.Input.Custom.IGameControllerProvider.IsConnected ## -description Boolean value indicating whether the controller is connected. ## -property-value Boolean value indicating whether the controller is connected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.IGameControllerProvider.IsConnected +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.IGameControllerProvider.IsConnected + +## -description +Boolean value indicating whether the controller is connected. + +## -property-value +Boolean value indicating whether the controller is connected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived.md b/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived.md index ca26125172..7f4b7735fa 100644 --- a/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived.md +++ b/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnKeyReceived(System.UInt64,System.Byte,System.Boolean) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnKeyReceived ## -description Event triggered when a key is received. ## -parameters ### -param timestamp Timestamp for the event. ### -param keyCode The key code for the button that triggered the event.. ### -param isPressed Boolean indicating whether the key is pressed or released. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnKeyReceived(System.UInt64,System.Byte,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnKeyReceived + +## -description +Event triggered when a key is received. + +## -parameters +### -param timestamp +Timestamp for the event. + +### -param keyCode +The key code for the button that triggered the event.. + +### -param isPressed +Boolean indicating whether the key is pressed or released. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived.md b/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived.md index 9d5d5cedbb..230a43d135 100644 --- a/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived.md +++ b/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnMessageReceived(System.UInt64,Windows.Gaming.Input.Custom.GipMessageClass,System.Byte,System.Byte,System.Byte[]) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnMessageReceived ## -description Event triggered when a message is received. ## -parameters ### -param timestamp Timestamp of the event. ### -param messageClass The class of the message. ### -param messageId The ID of the message. ### -param sequenceId Sequence ID of the message. ### -param messageBuffer A buffer containing the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnMessageReceived(System.UInt64,Windows.Gaming.Input.Custom.GipMessageClass,System.Byte,System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnMessageReceived + +## -description +Event triggered when a message is received. + +## -parameters +### -param timestamp +Timestamp of the event. + +### -param messageClass +The class of the message. + +### -param messageId +The ID of the message. + +### -param sequenceId +Sequence ID of the message. + +### -param messageBuffer +A buffer containing the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived.md b/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived.md index 6d217a2693..4ac85d4940 100644 --- a/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived.md +++ b/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.IXusbGameControllerInputSink.OnInputReceived(System.UInt64,System.Byte,System.Byte[]) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.IXusbGameControllerInputSink.OnInputReceived ## -description Event triggered when input is received. ## -parameters ### -param timestamp Timestamp of the event. ### -param reportId The ID of the report. ### -param inputBuffer A buffer containing the received input. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.IXusbGameControllerInputSink.OnInputReceived(System.UInt64,System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.IXusbGameControllerInputSink.OnInputReceived + +## -description +Event triggered when input is received. + +## -parameters +### -param timestamp +Timestamp of the event. + +### -param reportId +The ID of the report. + +### -param inputBuffer +A buffer containing the received input. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider.md b/windows.gaming.input.custom/xusbgamecontrollerprovider.md index 295f2724d2..7b9080f68f 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.Custom.XusbGameControllerProvider --api-type: winrt class ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider ## -description Represents the physical game controller devices connected to the system using XUSB22.SYS (for Xbox 360 accessories). ## -remarks ## -examples ## -see-also [IGameControllerProvider](igamecontrollerprovider.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.Custom.XusbGameControllerProvider +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider + +## -description +Represents the physical game controller devices connected to the system using XUSB22.SYS (for Xbox 360 accessories). + +## -remarks + +## -examples + +## -see-also +[IGameControllerProvider](igamecontrollerprovider.md) \ No newline at end of file diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_firmwareversioninfo.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_firmwareversioninfo.md index 8cde7a8c0f..1b15675439 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_firmwareversioninfo.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_firmwareversioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.FirmwareVersionInfo --api-type: winrt property ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider.FirmwareVersionInfo ## -description The firmware version of the controller. ## -property-value The firmware version of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.FirmwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider.FirmwareVersionInfo + +## -description +The firmware version of the controller. + +## -property-value +The firmware version of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareproductid.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareproductid.md index 459b0f060c..4497c397bb 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareproductid.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareproductid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareProductId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareProductId ## -description The hardware product ID of the controller. ## -property-value The hardware product ID of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareProductId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareProductId + +## -description +The hardware product ID of the controller. + +## -property-value +The hardware product ID of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwarevendorid.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwarevendorid.md index 82662e317d..58b46cc392 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwarevendorid.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwarevendorid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVendorId --api-type: winrt property ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVendorId ## -description The hardware vendor ID of the controller. ## -property-value The hardware vendor ID of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVendorId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVendorId + +## -description +The hardware vendor ID of the controller. + +## -property-value +The hardware vendor ID of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md index 2c5bfe95f1..6ec7e26453 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVersionInfo --api-type: winrt property ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVersionInfo ## -description Contains information on the hardware version of the controller. ## -property-value Structure containing information on the hardware version of the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider.HardwareVersionInfo + +## -description +Contains information on the hardware version of the controller. + +## -property-value +Structure containing information on the hardware version of the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_isconnected.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_isconnected.md index cdd1474c16..9f595174f7 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_isconnected.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_isconnected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.IsConnected --api-type: winrt property ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider.IsConnected ## -description Boolean indicating whether the controller is connected. ## -property-value Boolean indicating whether the controller is connected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Custom.XusbGameControllerProvider.IsConnected +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider.IsConnected + +## -description +Boolean indicating whether the controller is connected. + +## -property-value +Boolean indicating whether the controller is connected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_setvibration_1363158508.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_setvibration_1363158508.md index 210039cb07..1dcbccc928 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_setvibration_1363158508.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_setvibration_1363158508.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.Custom.XusbGameControllerProvider.SetVibration(System.Double,System.Double) --api-type: winrt method ---- # Windows.Gaming.Input.Custom.XusbGameControllerProvider.SetVibration ## -description Sets the speed on the controller's vibration motor. ## -parameters ### -param lowFrequencyMotorSpeed The low frequency motor speed. ### -param highFrequencyMotorSpeed The high frequency motor speed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Custom.XusbGameControllerProvider.SetVibration(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.XusbGameControllerProvider.SetVibration + +## -description +Sets the speed on the controller's vibration motor. + +## -parameters +### -param lowFrequencyMotorSpeed +The low frequency motor speed. + +### -param highFrequencyMotorSpeed +The high frequency motor speed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect.md b/windows.gaming.input.forcefeedback/conditionforceeffect.md index 86054d8ce0..b40e46f65a 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect --api-type: winrt class ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect ## -description Conditional force effects are forces applied in response to current sensor values within the device. In other words, conditional force effects require information about device motion, such as position or velocity of a joystick handle. In general, conditional force effects are not associated with individual events during a game or other application. They represent ambient phenomena, such as the stiffness or looseness of a flight stick, or the tendency of a steering wheel to return to a straight-ahead position. A conditional force effect does not have a predefined magnitude. The magnitude is scaled in proportion to the movement or position of the input object. ## -remarks ## -examples ## -see-also [IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect + +## -description +Conditional force effects are forces applied in response to current sensor values within the device. In other words, conditional force effects require information about device motion, such as position or velocity of a joystick handle. In general, conditional force effects are not associated with individual events during a game or other application. They represent ambient phenomena, such as the stiffness or looseness of a flight stick, or the tendency of a steering wheel to return to a straight-ahead position. A conditional force effect does not have a predefined magnitude. The magnitude is scaled in proportion to the movement or position of the input object. + +## -remarks + +## -examples + +## -see-also +[IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_conditionforceeffect_1703787600.md b/windows.gaming.input.forcefeedback/conditionforceeffect_conditionforceeffect_1703787600.md index 48f065ad47..42ed76d100 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_conditionforceeffect_1703787600.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_conditionforceeffect_1703787600.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.#ctor(Windows.Gaming.Input.ForceFeedback.ConditionForceEffectKind) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.ConditionForceEffect ## -description Creates an instance of [ConditionForceEffect](conditionforceeffect.md). ## -parameters ### -param effectKind The type of effect to create. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.#ctor(Windows.Gaming.Input.ForceFeedback.ConditionForceEffectKind) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.ConditionForceEffect + +## -description +Creates an instance of [ConditionForceEffect](conditionforceeffect.md). + +## -parameters +### -param effectKind +The type of effect to create. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_gain.md b/windows.gaming.input.forcefeedback/conditionforceeffect_gain.md index 9695153b4b..c93f7a64f4 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_gain.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Gain --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Gain ## -description Specifies the percentage by which to reduce the force of the effect. ## -property-value Specifies the percentage by which to reduce the force of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Gain +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Gain + +## -description +Specifies the percentage by which to reduce the force of the effect. + +## -property-value +Specifies the percentage by which to reduce the force of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_kind.md b/windows.gaming.input.forcefeedback/conditionforceeffect_kind.md index 1f748e807c..f725ccfc94 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_kind.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Kind --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Kind ## -description The type of force feedback effect. ## -property-value The type of force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Kind +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Kind + +## -description +The type of force feedback effect. + +## -property-value +The type of force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_setparameters_2078521474.md b/windows.gaming.input.forcefeedback/conditionforceeffect_setparameters_2078521474.md index eb0e78a496..009c1f53ab 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_setparameters_2078521474.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_setparameters_2078521474.md @@ -1,3 +1,79 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.SetParameters ## -description Sets the parameters for the conditional force feedback effect. ## -parameters ### -param direction A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param positiveCoefficient The slope of the line describing how rapidly the force increases as the input moves away from the center point in the positive direction along the specified axis. Range is from -infinity to +infinity. ### -param negativeCoefficient The slope of the line describing how rapidly the force increases as the input moves away from the center point in the negative direction along the specified axis. Range is from -infinity to +infinity. ### -param maxPositiveMagnitude The maximum magnitude of the force feedback as the input moves away from the center point in the positive direction along the specified axis. Range is from 0 to 1.0. ### -param maxNegativeMagnitude The maximum magnitude of the force feedback as the input moves away from the center point in the negative direction along the specified axis. Range is from 0 to 1.0. ### -param deadZone Specifies the value below which the force feedback is not applied. Range is from 0.0 to 1.0 and is applied asymmetrically around the center point. ### -param bias The offset to the center point in effect calculations. Range is from -1.0 to 1.0. ## -remarks The following image illustrates the effects of the arguments to SetParameters: Effects of parameters on force. In the image, all coefficient values are positive.  A negative value for the coefficient will cause the force (the green line) to go negative below the orange axis line, effectively, reversing the direction of the force.  This is not recommended because unless done carefully it will typically result in a positive feedback loop that will cause the motor to saturate in that direction. Magnitude and dead zone values are always positive, and symmetrical about their respective axes.  (This is illustrated for the dead zone, but the magnitude works the same way – a value of 0.5 limits the feedback force to anywhere between -0.5 and +0.5.) The bias is shown here at 0.0, but changing the value just slides the medium orange line one way or the other.  Note that this does not affect the slope of the green lines, defined by the coefficient values. ## -examples ``` // Create a spring effect and load it into the device. This is an async operation // since it might take a brief amount of time for the driver to complete this. ConditionForceEffect ^ springEffect = ref new ConditionForceEffect(ConditionEffectKind::Spring); if (springEffect) { IAsyncAction ^ action = motor->LoadEffectAsync(springEffect); concurrency::create_task(action).then([=]() { // Make sure the effect was loaded successfully. There is a finite amount // of storage available for effects in the hardware, so this is expected // to fail if there is not enough room. Alternatively, the motor might // not support the requested effect (although this is rare). if (action->Status == AsyncStatus::Completed) { // Set the parameters for the spring effect. Note how the parameters // can be modified after the effect has been loaded into the hardware. springEffect->SetParameters( { 1.0f, 0.0f, 0.0f }, // Unit vector indicating the effect applies to the X axis 1.0f, -1.0f, // Full strength when the wheel is turned to its maximum angle 0.3f, -0.3f, // Limit the maximum feedback force to 30% 0.025f, // Apply a small dead zone when the wheel is centered 0.0f); // Equal force in both directions // Go ahead and start the effect, since we want this running all the time springEffect->StartEffect(); } }); } ``` ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.SetParameters + +## -description +Sets the parameters for the conditional force feedback effect. + +## -parameters +### -param direction +A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param positiveCoefficient +The slope of the line describing how rapidly the force increases as the input moves away from the center point in the positive direction along the specified axis. Range is from -infinity to +infinity. + +### -param negativeCoefficient +The slope of the line describing how rapidly the force increases as the input moves away from the center point in the negative direction along the specified axis. Range is from -infinity to +infinity. + +### -param maxPositiveMagnitude +The maximum magnitude of the force feedback as the input moves away from the center point in the positive direction along the specified axis. Range is from 0 to 1.0. + +### -param maxNegativeMagnitude +The maximum magnitude of the force feedback as the input moves away from the center point in the negative direction along the specified axis. Range is from 0 to 1.0. + +### -param deadZone +Specifies the value below which the force feedback is not applied. Range is from 0.0 to 1.0 and is applied asymmetrically around the center point. + +### -param bias +The offset to the center point in effect calculations. Range is from -1.0 to 1.0. + +## -remarks +The following image illustrates the effects of the arguments to SetParameters: + +Effects of parameters on force. +In the image, all coefficient values are positive.  A negative value for the coefficient will cause the force (the green line) to go negative below the orange axis line, effectively, reversing the direction of the force.  This is not recommended because unless done carefully it will typically result in a positive feedback loop that will cause the motor to saturate in that direction. Magnitude and dead zone values are always positive, and symmetrical about their respective axes.  (This is illustrated for the dead zone, but the magnitude works the same way – a value of 0.5 limits the feedback force to anywhere between -0.5 and +0.5.) The bias is shown here at 0.0, but changing the value just slides the medium orange line one way or the other.  Note that this does not affect the slope of the green lines, defined by the coefficient values. + +## -examples +``` + +// Create a spring effect and load it into the device. This is an async operation +// since it might take a brief amount of time for the driver to complete this. +ConditionForceEffect ^ springEffect = ref new ConditionForceEffect(ConditionEffectKind::Spring); +if (springEffect) +{ + IAsyncAction ^ action = motor->LoadEffectAsync(springEffect); + concurrency::create_task(action).then([=]() + { + // Make sure the effect was loaded successfully. There is a finite amount + // of storage available for effects in the hardware, so this is expected + // to fail if there is not enough room. Alternatively, the motor might + // not support the requested effect (although this is rare). + if (action->Status == AsyncStatus::Completed) + { + // Set the parameters for the spring effect. Note how the parameters + // can be modified after the effect has been loaded into the hardware. + springEffect->SetParameters( + { 1.0f, 0.0f, 0.0f }, // Unit vector indicating the effect applies to the X axis + 1.0f, -1.0f, // Full strength when the wheel is turned to its maximum angle + 0.3f, -0.3f, // Limit the maximum feedback force to 30% + 0.025f, // Apply a small dead zone when the wheel is centered + 0.0f); // Equal force in both directions + + // Go ahead and start the effect, since we want this running all the time + springEffect->StartEffect(); + } + }); +} + +``` + + + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_start_1587696324.md b/windows.gaming.input.forcefeedback/conditionforceeffect_start_1587696324.md index a069233697..0811d28609 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_start_1587696324.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Start --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Start ## -description Starts the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Start +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Start + +## -description +Starts the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_state.md b/windows.gaming.input.forcefeedback/conditionforceeffect_state.md index 9737bf3b72..2df8b5e663 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_state.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.State --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.State ## -description The current state of the effect. ## -property-value The current state of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.State +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.State + +## -description +The current state of the effect. + +## -property-value +The current state of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/conditionforceeffect_stop_1201535524.md b/windows.gaming.input.forcefeedback/conditionforceeffect_stop_1201535524.md index 44608dc8e1..6026369459 100644 --- a/windows.gaming.input.forcefeedback/conditionforceeffect_stop_1201535524.md +++ b/windows.gaming.input.forcefeedback/conditionforceeffect_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Stop --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Stop ## -description Stops the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Stop +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConditionForceEffect.Stop + +## -description +Stops the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect.md b/windows.gaming.input.forcefeedback/constantforceeffect.md index 2859ba9d8e..4799ac78ee 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect --api-type: winrt class ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect ## -description A force feedback effect which applies a constant force along a vector. ## -remarks ## -examples ## -see-also [IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect + +## -description +A force feedback effect which applies a constant force along a vector. + +## -remarks + +## -examples + +## -see-also +[IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_constantforceeffect_1221375020.md b/windows.gaming.input.forcefeedback/constantforceeffect_constantforceeffect_1221375020.md index 41af18899d..607f38149e 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_constantforceeffect_1221375020.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_constantforceeffect_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.#ctor --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.ConstantForceEffect ## -description Creates an instance of [ConstantForceEffect](constantforceeffect.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.#ctor +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.ConstantForceEffect + +## -description +Creates an instance of [ConstantForceEffect](constantforceeffect.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_gain.md b/windows.gaming.input.forcefeedback/constantforceeffect_gain.md index 29ff12cf58..1ae220ca79 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_gain.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Gain --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Gain ## -description Specifies the percentage by which to reduce the force of the effect. ## -property-value Specifies the percentage by which to reduce the force of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Gain +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Gain + +## -description +Specifies the percentage by which to reduce the force of the effect. + +## -property-value +Specifies the percentage by which to reduce the force of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_setparameters_138863040.md b/windows.gaming.input.forcefeedback/constantforceeffect_setparameters_138863040.md index 325c86fa57..d14f3edc88 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_setparameters_138863040.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_setparameters_138863040.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParameters ## -description Sets the parameters for the constant force feedback effect. ## -parameters ### -param vector A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param duration The duration of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParameters + +## -description +Sets the parameters for the constant force feedback effect. + +## -parameters +### -param vector +A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param duration +The duration of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_setparameterswithenvelope_64203659.md b/windows.gaming.input.forcefeedback/constantforceeffect_setparameterswithenvelope_64203659.md index 7fa5e77bf0..4d3ac1995d 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_setparameterswithenvelope_64203659.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_setparameterswithenvelope_64203659.md @@ -1,3 +1,47 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParametersWithEnvelope(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.UInt32) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParametersWithEnvelope ## -description Sets the parameters for the effect and sets an envelope for the effect. ## -parameters ### -param vector A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param attackGain Percentage by which to reduce the strength of the effect when it is ramping up. ### -param sustainGain Percentage by which to reduce the strength of the effect when it is sustaining. ### -param releaseGain Percentage by which to reduce the strength of the effect when it is ramping down. ### -param startDelay Time to delay the effect before starting. ### -param attackDuration Time to ramp up to the effect's full strength. ### -param sustainDuration Time to maintain the effect at full strength. ### -param releaseDuration Time to ramp down from full strength to zero. ### -param repeatCount The number of times to repeat the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParametersWithEnvelope(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.SetParametersWithEnvelope + +## -description +Sets the parameters for the effect and sets an envelope for the effect. + +## -parameters +### -param vector +A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param attackGain +Percentage by which to reduce the strength of the effect when it is ramping up. + +### -param sustainGain +Percentage by which to reduce the strength of the effect when it is sustaining. + +### -param releaseGain +Percentage by which to reduce the strength of the effect when it is ramping down. + +### -param startDelay +Time to delay the effect before starting. + +### -param attackDuration +Time to ramp up to the effect's full strength. + +### -param sustainDuration +Time to maintain the effect at full strength. + +### -param releaseDuration +Time to ramp down from full strength to zero. + +### -param repeatCount +The number of times to repeat the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_start_1587696324.md b/windows.gaming.input.forcefeedback/constantforceeffect_start_1587696324.md index 431b016306..2e20aeb63f 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_start_1587696324.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Start --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Start ## -description Starts the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Start +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Start + +## -description +Starts the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_state.md b/windows.gaming.input.forcefeedback/constantforceeffect_state.md index a8cd9a976c..b7a925508e 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_state.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.State --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.State ## -description The current state of the force feedback effect. ## -property-value The current state of the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.State +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.State + +## -description +The current state of the force feedback effect. + +## -property-value +The current state of the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/constantforceeffect_stop_1201535524.md b/windows.gaming.input.forcefeedback/constantforceeffect_stop_1201535524.md index f32702088c..3d082264e9 100644 --- a/windows.gaming.input.forcefeedback/constantforceeffect_stop_1201535524.md +++ b/windows.gaming.input.forcefeedback/constantforceeffect_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Stop --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Stop ## -description Stops the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Stop +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ConstantForceEffect.Stop + +## -description +Stops the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor.md index 7ac390c1b9..81bfdebb76 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor --api-type: winrt class ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor ## -description Encapsulates the force feedback hardware for a given input device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor + +## -description +Encapsulates the force feedback hardware for a given input device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_areeffectspaused.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_areeffectspaused.md index 08e4edf4ce..ddd6aded36 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_areeffectspaused.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_areeffectspaused.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.AreEffectsPaused --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.AreEffectsPaused ## -description Boolean indicating whether force feedback effects are paused. ## -property-value Boolean indicating whether force feedback effects are paused. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.AreEffectsPaused +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.AreEffectsPaused + +## -description +Boolean indicating whether force feedback effects are paused. + +## -property-value +Boolean indicating whether force feedback effects are paused. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_isenabled.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_isenabled.md index aaec58a631..ab8f613650 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_isenabled.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.IsEnabled --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.IsEnabled ## -description Boolean indicating whether the force feedback motor is enabled. ## -property-value Boolean indicating whether the force feedback motor is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.IsEnabled + +## -description +Boolean indicating whether the force feedback motor is enabled. + +## -property-value +Boolean indicating whether the force feedback motor is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_loadeffectasync_275430352.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_loadeffectasync_275430352.md index 44e6628378..ab8a53e8b2 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_loadeffectasync_275430352.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_loadeffectasync_275430352.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.LoadEffectAsync(Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.LoadEffectAsync ## -description Attempts to asynchronously load a feedback effect to the device's internal memory. ## -parameters ### -param effect The effect to load. ## -returns Returns the result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.LoadEffectAsync(Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.LoadEffectAsync + +## -description +Attempts to asynchronously load a feedback effect to the device's internal memory. + +## -parameters +### -param effect +The effect to load. + +## -returns +Returns the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_mastergain.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_mastergain.md index 6b0a4c79da..3030def6ae 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_mastergain.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_mastergain.md @@ -1,3 +1,45 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.MasterGain --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.MasterGain ## -description Specifies the percentage by which to reduce the force of all effects on the controller. ## -property-value Specifies the percentage by which to reduce the force of all effects on the controller. ## -remarks ## -examples ``` // The Contoso and Fabrikam motors have a very high maximum // torque output, so tone down all force feedback effects // played on those devices so they don't overwhelm the user if (motor->HardwareModelId == ContosoWheelMotorId) { // Attentuate effects by 20% for the Contoso motor motor->MasterGain = 0.2; } else if (motor->HardwareModelId == FabrikamWheelMotorId) { // Attenuate effects by 35% for the Fabrikam motor motor->MasterGain = 0.35; } // Make sure the motor is enabled motor->IsMotorEnabled = true; ``` ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.MasterGain +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.MasterGain + +## -description +Specifies the percentage by which to reduce the force of all effects on the controller. + +## -property-value +Specifies the percentage by which to reduce the force of all effects on the controller. + +## -remarks + +## -examples +``` + +// The Contoso and Fabrikam motors have a very high maximum +// torque output, so tone down all force feedback effects +// played on those devices so they don't overwhelm the user +if (motor->HardwareModelId == ContosoWheelMotorId) +{ + // Attentuate effects by 20% for the Contoso motor + motor->MasterGain = 0.2; +} +else if (motor->HardwareModelId == FabrikamWheelMotorId) +{ + // Attenuate effects by 35% for the Fabrikam motor + motor->MasterGain = 0.35; +} + +// Make sure the motor is enabled +motor->IsMotorEnabled = true; + + +``` + + + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_pausealleffects_1373024881.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_pausealleffects_1373024881.md index 6d64ee12c7..b5c58dbf34 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_pausealleffects_1373024881.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_pausealleffects_1373024881.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.PauseAllEffects --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.PauseAllEffects ## -description Pauses all force feedback effects being executed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.PauseAllEffects +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.PauseAllEffects + +## -description +Pauses all force feedback effects being executed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_resumealleffects_129467589.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_resumealleffects_129467589.md index 3db50ecc56..11c1d69a73 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_resumealleffects_129467589.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_resumealleffects_129467589.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.ResumeAllEffects --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.ResumeAllEffects ## -description Resumes all force feedback effects being executed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.ResumeAllEffects +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.ResumeAllEffects + +## -description +Resumes all force feedback effects being executed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_stopalleffects_786471122.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_stopalleffects_786471122.md index c23e38a0ba..34a7404c39 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_stopalleffects_786471122.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_stopalleffects_786471122.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.StopAllEffects --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.StopAllEffects ## -description Stops all force feedback effects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.StopAllEffects +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.StopAllEffects + +## -description +Stops all force feedback effects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_supportedaxes.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_supportedaxes.md index 664dd9ac43..334a2cae8d 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_supportedaxes.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_supportedaxes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.SupportedAxes --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.SupportedAxes ## -description The axes supported by the force feedback motor. ## -property-value The axes supported by the force feedback motor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.SupportedAxes +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.SupportedAxes + +## -description +The axes supported by the force feedback motor. + +## -property-value +The axes supported by the force feedback motor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_trydisableasync_162574545.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_trydisableasync_162574545.md index 7696f1a5e5..a16da2534c 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_trydisableasync_162574545.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_trydisableasync_162574545.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryDisableAsync --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryDisableAsync ## -description Attempts to asynchronously disable the force feedback motor. ## -returns Returns the result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryDisableAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryDisableAsync + +## -description +Attempts to asynchronously disable the force feedback motor. + +## -returns +Returns the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryenableasync_60570690.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryenableasync_60570690.md index fe9371df02..6806d61999 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryenableasync_60570690.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryenableasync_60570690.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryEnableAsync --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryEnableAsync ## -description Try to asynchronously enable the force feedback motor of the device. ## -returns Returns the result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryEnableAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryEnableAsync + +## -description +Try to asynchronously enable the force feedback motor of the device. + +## -returns +Returns the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryresetasync_1371327636.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryresetasync_1371327636.md index a313cb5c2a..7c7bb95829 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryresetasync_1371327636.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryresetasync_1371327636.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryResetAsync --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryResetAsync ## -description Attempts to asynchronously reset the device back to its initial state. ## -returns Returns the result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryResetAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryResetAsync + +## -description +Attempts to asynchronously reset the device back to its initial state. + +## -returns +Returns the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryunloadeffectasync_34732625.md b/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryunloadeffectasync_34732625.md index a5578590f2..d947e6718d 100644 --- a/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryunloadeffectasync_34732625.md +++ b/windows.gaming.input.forcefeedback/forcefeedbackmotor_tryunloadeffectasync_34732625.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryUnloadEffectAsync(Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryUnloadEffectAsync ## -description Attempts to asynchronously unload a feedback effect from the device's internal memory. ## -parameters ### -param effect The effect to unload. ## -returns Returns the result of the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryUnloadEffectAsync(Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor.TryUnloadEffectAsync + +## -description +Attempts to asynchronously unload a feedback effect from the device's internal memory. + +## -parameters +### -param effect +The effect to unload. + +## -returns +Returns the result of the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_gain.md b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_gain.md index 809cf73ae5..9948bedf97 100644 --- a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_gain.md +++ b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Gain --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Gain ## -description Specifies the percentage by which to reduce the force of the effect. ## -property-value Specifies the percentage by which to reduce the force of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Gain +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Gain + +## -description +Specifies the percentage by which to reduce the force of the effect. + +## -property-value +Specifies the percentage by which to reduce the force of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_start.md b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_start.md index 2b603795bc..3a50c93e6a 100644 --- a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_start.md +++ b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_start.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Start --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Start ## -description Starts the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Start +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Start + +## -description +Starts the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_state.md b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_state.md index 15358b028f..1c01278a75 100644 --- a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_state.md +++ b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.State --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.State ## -description The state of the effect. ## -property-value The state of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.State +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.State + +## -description +The state of the effect. + +## -property-value +The state of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_stop.md b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_stop.md index 89722a92c3..070bd422e8 100644 --- a/windows.gaming.input.forcefeedback/iforcefeedbackeffect_stop.md +++ b/windows.gaming.input.forcefeedback/iforcefeedbackeffect_stop.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Stop --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Stop ## -description Stops the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Stop +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.IForceFeedbackEffect.Stop + +## -description +Stops the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect.md b/windows.gaming.input.forcefeedback/periodicforceeffect.md index 110a4086b0..1297bab037 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect --api-type: winrt class ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect ## -description A force feedback effect which applies a varying force, defined by a waveform, along a vector. ## -remarks ## -examples ## -see-also [IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect + +## -description +A force feedback effect which applies a varying force, defined by a waveform, along a vector. + +## -remarks + +## -examples + +## -see-also +[IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_gain.md b/windows.gaming.input.forcefeedback/periodicforceeffect_gain.md index 6906d4ca3c..1fbd08af74 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_gain.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Gain --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Gain ## -description Specifies the percentage by which to reduce the force of the effect. ## -property-value Specifies the percentage by which to reduce the force of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Gain +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Gain + +## -description +Specifies the percentage by which to reduce the force of the effect. + +## -property-value +Specifies the percentage by which to reduce the force of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_kind.md b/windows.gaming.input.forcefeedback/periodicforceeffect_kind.md index 32a68268df..6ee9a6a733 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_kind.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Kind --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Kind ## -description The type of periodic force feedback effect. ## -property-value The type of periodic force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Kind +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Kind + +## -description +The type of periodic force feedback effect. + +## -property-value +The type of periodic force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_periodicforceeffect_2074549088.md b/windows.gaming.input.forcefeedback/periodicforceeffect_periodicforceeffect_2074549088.md index d41f792e25..5736a39c2c 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_periodicforceeffect_2074549088.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_periodicforceeffect_2074549088.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.#ctor(Windows.Gaming.Input.ForceFeedback.PeriodicForceEffectKind) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.PeriodicForceEffect ## -description Creates an instance of [PeriodicForceEffect](periodicforceeffect.md). ## -parameters ### -param effectKind The type of effect to create. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.#ctor(Windows.Gaming.Input.ForceFeedback.PeriodicForceEffectKind) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.PeriodicForceEffect + +## -description +Creates an instance of [PeriodicForceEffect](periodicforceeffect.md). + +## -parameters +### -param effectKind +The type of effect to create. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_setparameters_1162360590.md b/windows.gaming.input.forcefeedback/periodicforceeffect_setparameters_1162360590.md index 68a54fc197..29f54488ba 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_setparameters_1162360590.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_setparameters_1162360590.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParameters ## -description Sets the parameters for the force feedback effect. ## -parameters ### -param vector A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param frequency The number of times the periodic wave occurs in one second. ### -param phase The percent at which to start the effect. Range is between -1 and 1. ### -param bias The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1. ### -param duration The duration of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParameters + +## -description +Sets the parameters for the force feedback effect. + +## -parameters +### -param vector +A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param frequency +The number of times the periodic wave occurs in one second. + +### -param phase +The percent at which to start the effect. Range is between -1 and 1. + +### -param bias +The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1. + +### -param duration +The duration of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_setparameterswithenvelope_1535140741.md b/windows.gaming.input.forcefeedback/periodicforceeffect_setparameterswithenvelope_1535140741.md index 92960f08a7..706cea6e1b 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_setparameterswithenvelope_1535140741.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_setparameterswithenvelope_1535140741.md @@ -1,3 +1,56 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParametersWithEnvelope(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.UInt32) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParametersWithEnvelope ## -description Sets the parameters for the effect and sets an envelope for the effect. ## -parameters ### -param vector A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param frequency The number of times the periodic wave occurs in one second. ### -param phase The percent at which to start the effect. Range is between -1 and 1. ### -param bias The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1. ### -param attackGain Percentage by which to reduce the strength of the effect when it is ramping up. ### -param sustainGain Percentage by which to reduce the strength of the effect when it is sustaining. ### -param releaseGain Percentage by which to reduce the strength of the effect when it is ramping down. ### -param startDelay Time to delay the effect before starting. ### -param attackDuration Time to ramp up to the effect's full strength. ### -param sustainDuration Time to maintain the effect at full strength. ### -param releaseDuration Time to ramp down from full strength to zero. ### -param repeatCount The number of times to repeat the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParametersWithEnvelope(Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.SetParametersWithEnvelope + +## -description +Sets the parameters for the effect and sets an envelope for the effect. + +## -parameters +### -param vector +A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param frequency +The number of times the periodic wave occurs in one second. + +### -param phase +The percent at which to start the effect. Range is between -1 and 1. + +### -param bias +The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1. + +### -param attackGain +Percentage by which to reduce the strength of the effect when it is ramping up. + +### -param sustainGain +Percentage by which to reduce the strength of the effect when it is sustaining. + +### -param releaseGain +Percentage by which to reduce the strength of the effect when it is ramping down. + +### -param startDelay +Time to delay the effect before starting. + +### -param attackDuration +Time to ramp up to the effect's full strength. + +### -param sustainDuration +Time to maintain the effect at full strength. + +### -param releaseDuration +Time to ramp down from full strength to zero. + +### -param repeatCount +The number of times to repeat the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_start_1587696324.md b/windows.gaming.input.forcefeedback/periodicforceeffect_start_1587696324.md index 2439d65174..590806541e 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_start_1587696324.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Start --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Start ## -description Starts the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Start +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Start + +## -description +Starts the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_state.md b/windows.gaming.input.forcefeedback/periodicforceeffect_state.md index f7bded5f62..0ba5df388a 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_state.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.State --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.State ## -description The current state of the force feedback effect. ## -property-value The current state of the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.State +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.State + +## -description +The current state of the force feedback effect. + +## -property-value +The current state of the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/periodicforceeffect_stop_1201535524.md b/windows.gaming.input.forcefeedback/periodicforceeffect_stop_1201535524.md index c0c95f4134..86a9930d7e 100644 --- a/windows.gaming.input.forcefeedback/periodicforceeffect_stop_1201535524.md +++ b/windows.gaming.input.forcefeedback/periodicforceeffect_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Stop --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Stop ## -description Stops the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Stop +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.PeriodicForceEffect.Stop + +## -description +Stops the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect.md b/windows.gaming.input.forcefeedback/rampforceeffect.md index 6a51a4a6ef..b681e28682 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.ForceFeedback.RampForceEffect --api-type: winrt class ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect ## -description A force feedback effect which applies a linearly increasing or decreasing force along a vector. ## -remarks ## -examples ## -see-also [IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.ForceFeedback.RampForceEffect +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect + +## -description +A force feedback effect which applies a linearly increasing or decreasing force along a vector. + +## -remarks + +## -examples + +## -see-also +[IForceFeedbackEffect](iforcefeedbackeffect.md) \ No newline at end of file diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_gain.md b/windows.gaming.input.forcefeedback/rampforceeffect_gain.md index c2cbc491f4..396061ab81 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_gain.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.RampForceEffect.Gain --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.Gain ## -description Specifies the percentage by which to reduce the force of the effect. ## -property-value Specifies the percentage by which to reduce the force of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.RampForceEffect.Gain +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.Gain + +## -description +Specifies the percentage by which to reduce the force of the effect. + +## -property-value +Specifies the percentage by which to reduce the force of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_rampforceeffect_1221375020.md b/windows.gaming.input.forcefeedback/rampforceeffect_rampforceeffect_1221375020.md index fb9954d230..2f16d7c3cf 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_rampforceeffect_1221375020.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_rampforceeffect_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.#ctor --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.RampForceEffect ## -description Creates an instance of [RampForceEffect](rampforceeffect.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.#ctor +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.RampForceEffect + +## -description +Creates an instance of [RampForceEffect](rampforceeffect.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_setparameters_1798020340.md b/windows.gaming.input.forcefeedback/rampforceeffect_setparameters_1798020340.md index 7f48ce6bd4..2994b06aed 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_setparameters_1798020340.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_setparameters_1798020340.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParameters ## -description Sets the parameters for the ramp force feedback effect. ## -parameters ### -param startVector A vector describing the direction and magnitude of the effect on each axis when the effect is starting. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param endVector A vector describing the direction and magnitude of the effect on each axis when the effect is ending. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. ### -param duration The duration of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParameters(Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParameters + +## -description +Sets the parameters for the ramp force feedback effect. + +## -parameters +### -param startVector +A vector describing the direction and magnitude of the effect on each axis when the effect is starting. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param endVector +A vector describing the direction and magnitude of the effect on each axis when the effect is ending. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. + +### -param duration +The duration of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_setparameterswithenvelope_1127455597.md b/windows.gaming.input.forcefeedback/rampforceeffect_setparameterswithenvelope_1127455597.md index 8e5faa559c..7bcaaf0e26 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_setparameterswithenvelope_1127455597.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_setparameterswithenvelope_1127455597.md @@ -1,3 +1,50 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParametersWithEnvelope(Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.UInt32) --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParametersWithEnvelope ## -description Sets the parameters for the effect and sets an envelope for the effect. ## -parameters ### -param startVector The start vector of the effect. ### -param endVector The end vector of the effect. ### -param attackGain Percentage by which to reduce the strength of the effect when it is ramping up. ### -param sustainGain Percentage by which to reduce the strength of the effect when it is sustaining. ### -param releaseGain Percentage by which to reduce the strength of the effect when it is ramping down. ### -param startDelay Time to delay the effect before starting. ### -param attackDuration Time to ramp up to the effect's full strength. ### -param sustainDuration Time to maintain the effect at full strength. ### -param releaseDuration Time to ramp down from full strength to zero. ### -param repeatCount The number of times to repeat the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParametersWithEnvelope(Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,System.Single,System.Single,System.Single,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.SetParametersWithEnvelope + +## -description +Sets the parameters for the effect and sets an envelope for the effect. + +## -parameters +### -param startVector +The start vector of the effect. + +### -param endVector +The end vector of the effect. + +### -param attackGain +Percentage by which to reduce the strength of the effect when it is ramping up. + +### -param sustainGain +Percentage by which to reduce the strength of the effect when it is sustaining. + +### -param releaseGain +Percentage by which to reduce the strength of the effect when it is ramping down. + +### -param startDelay +Time to delay the effect before starting. + +### -param attackDuration +Time to ramp up to the effect's full strength. + +### -param sustainDuration +Time to maintain the effect at full strength. + +### -param releaseDuration +Time to ramp down from full strength to zero. + +### -param repeatCount +The number of times to repeat the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_start_1587696324.md b/windows.gaming.input.forcefeedback/rampforceeffect_start_1587696324.md index 62794f04d8..f5ac6db5e2 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_start_1587696324.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.Start --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.Start ## -description Starts the force feedback effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.Start +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.Start + +## -description +Starts the force feedback effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_state.md b/windows.gaming.input.forcefeedback/rampforceeffect_state.md index d06677c3ac..37191a1a15 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_state.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ForceFeedback.RampForceEffect.State --api-type: winrt property ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.State ## -description The current state of the effect. ## -property-value The current state of the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ForceFeedback.RampForceEffect.State +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.State + +## -description +The current state of the effect. + +## -property-value +The current state of the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input.forcefeedback/rampforceeffect_stop_1201535524.md b/windows.gaming.input.forcefeedback/rampforceeffect_stop_1201535524.md index fe05d759ea..9a04e85927 100644 --- a/windows.gaming.input.forcefeedback/rampforceeffect_stop_1201535524.md +++ b/windows.gaming.input.forcefeedback/rampforceeffect_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.Stop --api-type: winrt method ---- # Windows.Gaming.Input.ForceFeedback.RampForceEffect.Stop ## -description Stops the effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ForceFeedback.RampForceEffect.Stop +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ForceFeedback.RampForceEffect.Stop + +## -description +Stops the effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick.md b/windows.gaming.input/arcadestick.md index 08b756989a..8e52e2fd6f 100644 --- a/windows.gaming.input/arcadestick.md +++ b/windows.gaming.input/arcadestick.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Gaming.Input.ArcadeStick --api-type: winrt class ---- # Windows.Gaming.Input.ArcadeStick ## -description Represents an Arcade Stick. ## -remarks ### Supported Device s **ArcadeStick** supports any Xbox One certified or Xbox 360 compatible arcade stick. ## -examples ## -see-also [IGameController](igamecontroller.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.ArcadeStick +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.ArcadeStick + +## -description +Represents an Arcade Stick. + +## -remarks +### Supported Device +s + + **ArcadeStick** + supports any Xbox One certified or Xbox 360 compatible arcade stick. + +## -examples + +## -see-also +[IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_arcadestickadded.md b/windows.gaming.input/arcadestick_arcadestickadded.md index f3c27dec27..e96eef8421 100644 --- a/windows.gaming.input/arcadestick_arcadestickadded.md +++ b/windows.gaming.input/arcadestick_arcadestickadded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Gaming.Input.ArcadeStick.ArcadeStickAdded --api-type: winrt event ---- # Windows.Gaming.Input.ArcadeStick.ArcadeStickAdded ## -description Signals when a new arcade stick is connected. ## -remarks To identify controllers that have allready been added, you query the list of conected controllers using [ArcadeStick.ArcadeSticks](arcadestick_arcadesticks.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.ArcadeStick.ArcadeStickAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.ArcadeStick.ArcadeStickAdded + +## -description +Signals when a new arcade stick is connected. + +## -remarks +To identify controllers that have allready been added, you query the list of conected controllers using [ArcadeStick.ArcadeSticks](arcadestick_arcadesticks.md). + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_arcadestickremoved.md b/windows.gaming.input/arcadestick_arcadestickremoved.md index 993a062f91..ba55b72380 100644 --- a/windows.gaming.input/arcadestick_arcadestickremoved.md +++ b/windows.gaming.input/arcadestick_arcadestickremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.ArcadeStick.ArcadeStickRemoved --api-type: winrt event ---- # Windows.Gaming.Input.ArcadeStick.ArcadeStickRemoved ## -description Signals when an arcade stick is disconnected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.ArcadeStick.ArcadeStickRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.ArcadeStick.ArcadeStickRemoved + +## -description +Signals when an arcade stick is disconnected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_arcadesticks.md b/windows.gaming.input/arcadestick_arcadesticks.md index 7248c46cd9..b526bebcd6 100644 --- a/windows.gaming.input/arcadestick_arcadesticks.md +++ b/windows.gaming.input/arcadestick_arcadesticks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ArcadeStick.ArcadeSticks --api-type: winrt property ---- # Windows.Gaming.Input.ArcadeStick.ArcadeSticks ## -description The list of all connected arcade sticks. ## -property-value The list of all connected arcade sticks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ArcadeStick.ArcadeSticks +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ArcadeStick.ArcadeSticks + +## -description +The list of all connected arcade sticks. + +## -property-value +The list of all connected arcade sticks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md b/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md index 7e39963aba..38136bd756 100644 --- a/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md +++ b/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.ArcadeStick.GetButtonLabel(Windows.Gaming.Input.ArcadeStickButtons) --api-type: winrt method ---- # Windows.Gaming.Input.ArcadeStick.GetButtonLabel ## -description Retrieves the button label for the specified button. ## -parameters ### -param button The button to retrieve the label for. ## -returns Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then None is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ArcadeStick.GetButtonLabel(Windows.Gaming.Input.ArcadeStickButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ArcadeStick.GetButtonLabel + +## -description +Retrieves the button label for the specified button. + +## -parameters +### -param button +The button to retrieve the label for. + +## -returns +Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then None is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md b/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md index 2334a57261..9afc028a2a 100644 --- a/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md +++ b/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.ArcadeStick.GetCurrentReading --api-type: winrt method ---- # Windows.Gaming.Input.ArcadeStick.GetCurrentReading ## -description Gets a snapshot of the acrade stick state. ## -returns Returns an [ArcadeStickReading](arcadestickreading.md) containing the current state of the arcade stick. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.ArcadeStick.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ArcadeStick.GetCurrentReading + +## -description +Gets a snapshot of the acrade stick state. + +## -returns +Returns an [ArcadeStickReading](arcadestickreading.md) containing the current state of the arcade stick. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_headset.md b/windows.gaming.input/arcadestick_headset.md index 602abf9baa..b3015a8d80 100644 --- a/windows.gaming.input/arcadestick_headset.md +++ b/windows.gaming.input/arcadestick_headset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ArcadeStick.Headset --api-type: winrt property ---- # Windows.Gaming.Input.ArcadeStick.Headset ## -description The audio headset attached to the arcade stick. ## -property-value The audio headset attached to the arcade stick. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ArcadeStick.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ArcadeStick.Headset + +## -description +The audio headset attached to the arcade stick. + +## -property-value +The audio headset attached to the arcade stick. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_headsetconnected.md b/windows.gaming.input/arcadestick_headsetconnected.md index 3429b016de..1f2c19b412 100644 --- a/windows.gaming.input/arcadestick_headsetconnected.md +++ b/windows.gaming.input/arcadestick_headsetconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.ArcadeStick.HeadsetConnected --api-type: winrt event ---- # Windows.Gaming.Input.ArcadeStick.HeadsetConnected ## -description Signals when a headset is attached to the arcade stick. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.ArcadeStick.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.ArcadeStick.HeadsetConnected + +## -description +Signals when a headset is attached to the arcade stick. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_headsetdisconnected.md b/windows.gaming.input/arcadestick_headsetdisconnected.md index ebee1ec16e..24f9d6c601 100644 --- a/windows.gaming.input/arcadestick_headsetdisconnected.md +++ b/windows.gaming.input/arcadestick_headsetdisconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.ArcadeStick.HeadsetDisconnected --api-type: winrt event ---- # Windows.Gaming.Input.ArcadeStick.HeadsetDisconnected ## -description Signals when a headset is disconnected from the arcade stick. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.ArcadeStick.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.ArcadeStick.HeadsetDisconnected + +## -description +Signals when a headset is disconnected from the arcade stick. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_iswireless.md b/windows.gaming.input/arcadestick_iswireless.md index 7d953120a8..a0f29d027c 100644 --- a/windows.gaming.input/arcadestick_iswireless.md +++ b/windows.gaming.input/arcadestick_iswireless.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ArcadeStick.IsWireless --api-type: winrt property ---- # Windows.Gaming.Input.ArcadeStick.IsWireless ## -description Gets a value that indicates the wireless state of the arcade stick. ## -property-value True if the arcade stick is wireless. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ArcadeStick.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ArcadeStick.IsWireless + +## -description +Gets a value that indicates the wireless state of the arcade stick. + +## -property-value +True if the arcade stick is wireless. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_user.md b/windows.gaming.input/arcadestick_user.md index 84bdd0315d..cae909f435 100644 --- a/windows.gaming.input/arcadestick_user.md +++ b/windows.gaming.input/arcadestick_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.ArcadeStick.User --api-type: winrt property ---- # Windows.Gaming.Input.ArcadeStick.User ## -description The user associated with the arcade stick. ## -property-value The user associated with the arcade stick. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.ArcadeStick.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.ArcadeStick.User + +## -description +The user associated with the arcade stick. + +## -property-value +The user associated with the arcade stick. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/arcadestick_userchanged.md b/windows.gaming.input/arcadestick_userchanged.md index 3769838e2f..3f220d43ae 100644 --- a/windows.gaming.input/arcadestick_userchanged.md +++ b/windows.gaming.input/arcadestick_userchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.ArcadeStick.UserChanged --api-type: winrt event ---- # Windows.Gaming.Input.ArcadeStick.UserChanged ## -description Signals when the user associated with the arcade stick has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.ArcadeStick.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.ArcadeStick.UserChanged + +## -description +Signals when the user associated with the arcade stick has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad.md b/windows.gaming.input/gamepad.md index d778dcadb8..6aca54b411 100644 --- a/windows.gaming.input/gamepad.md +++ b/windows.gaming.input/gamepad.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Gaming.Input.Gamepad --api-type: winrt class ---- # Windows.Gaming.Input.Gamepad ## -description Represents a game controller. ## -remarks Instances of the [Gamepad](gamepad.md) class cannot be created directly, instead instances of the [Gamepad](gamepad.md) class are retrieved through the [Gamepads](gamepad_gamepads.md) property listing all connected gamepads or through the [GamepadAdded](gamepad_gamepadadded.md) event. ### Supported Device s **Gamepad** supports any Xbox One certified or Xbox 360 compatible gamepad. ## -examples ## -see-also [IGameController](igamecontroller.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.Gamepad +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Gamepad + +## -description +Represents a game controller. + +## -remarks +Instances of the [Gamepad](gamepad.md) class cannot be created directly, instead instances of the [Gamepad](gamepad.md) class are retrieved through the [Gamepads](gamepad_gamepads.md) property listing all connected gamepads or through the [GamepadAdded](gamepad_gamepadadded.md) event. + +### Supported Device +s + + **Gamepad** + supports any Xbox One certified or Xbox 360 compatible gamepad. + +## -examples + +## -see-also +[IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/gamepad_gamepadadded.md b/windows.gaming.input/gamepad_gamepadadded.md index 3a98c00565..a371fa7f4f 100644 --- a/windows.gaming.input/gamepad_gamepadadded.md +++ b/windows.gaming.input/gamepad_gamepadadded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Gaming.Input.Gamepad.GamepadAdded --api-type: winrt event ---- # Windows.Gaming.Input.Gamepad.GamepadAdded ## -description Signals when a new gamepad is connected. ## -remarks To identify controllers that have allready been added, you query the list of conected controllers using [Gamepad.Gamepads](gamepad_gamepads.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.Gamepad.GamepadAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.Gamepad.GamepadAdded + +## -description +Signals when a new gamepad is connected. + +## -remarks +To identify controllers that have allready been added, you query the list of conected controllers using [Gamepad.Gamepads](gamepad_gamepads.md). + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_gamepadremoved.md b/windows.gaming.input/gamepad_gamepadremoved.md index f7fc702a11..750aaab970 100644 --- a/windows.gaming.input/gamepad_gamepadremoved.md +++ b/windows.gaming.input/gamepad_gamepadremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.Gamepad.GamepadRemoved --api-type: winrt event ---- # Windows.Gaming.Input.Gamepad.GamepadRemoved ## -description Signals when a gamepad is disconnected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.Gamepad.GamepadRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.Gamepad.GamepadRemoved + +## -description +Signals when a gamepad is disconnected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_gamepads.md b/windows.gaming.input/gamepad_gamepads.md index d1cde4eb1e..462e018b24 100644 --- a/windows.gaming.input/gamepad_gamepads.md +++ b/windows.gaming.input/gamepad_gamepads.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Gamepad.Gamepads --api-type: winrt property ---- # Windows.Gaming.Input.Gamepad.Gamepads ## -description The list of all connected gamepads. ## -property-value The list of all connected gamepads. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Gamepad.Gamepads +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Gamepad.Gamepads + +## -description +The list of all connected gamepads. + +## -property-value +The list of all connected gamepads. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_getbuttonlabel_1287187751.md b/windows.gaming.input/gamepad_getbuttonlabel_1287187751.md index 08a8bcf66d..ffa3266c07 100644 --- a/windows.gaming.input/gamepad_getbuttonlabel_1287187751.md +++ b/windows.gaming.input/gamepad_getbuttonlabel_1287187751.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.Gamepad.GetButtonLabel(Windows.Gaming.Input.GamepadButtons) --api-type: winrt method ---- # Windows.Gaming.Input.Gamepad.GetButtonLabel ## -description Retrieves the button label for the specified button. ## -parameters ### -param button The button to retrieve the label for. ## -returns Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then None is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Gamepad.GetButtonLabel(Windows.Gaming.Input.GamepadButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Gamepad.GetButtonLabel + +## -description +Retrieves the button label for the specified button. + +## -parameters +### -param button +The button to retrieve the label for. + +## -returns +Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then None is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_getcurrentreading_1416488181.md b/windows.gaming.input/gamepad_getcurrentreading_1416488181.md index abda8dbc54..0ce84d191c 100644 --- a/windows.gaming.input/gamepad_getcurrentreading_1416488181.md +++ b/windows.gaming.input/gamepad_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.Gamepad.GetCurrentReading --api-type: winrt method ---- # Windows.Gaming.Input.Gamepad.GetCurrentReading ## -description Gets a snapshot of the gamepad state. ## -returns Returns a [GamepadReading](gamepadreading.md) containing the current state of the gamepad. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.Gamepad.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Gamepad.GetCurrentReading + +## -description +Gets a snapshot of the gamepad state. + +## -returns +Returns a [GamepadReading](gamepadreading.md) containing the current state of the gamepad. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_headset.md b/windows.gaming.input/gamepad_headset.md index 7cb5e39a2f..0337bc2605 100644 --- a/windows.gaming.input/gamepad_headset.md +++ b/windows.gaming.input/gamepad_headset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Gamepad.Headset --api-type: winrt property ---- # Windows.Gaming.Input.Gamepad.Headset ## -description The audio headset attached to the gamepad. ## -property-value The audio headset attached to the gamepad. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Gamepad.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Gamepad.Headset + +## -description +The audio headset attached to the gamepad. + +## -property-value +The audio headset attached to the gamepad. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_headsetconnected.md b/windows.gaming.input/gamepad_headsetconnected.md index 8725543f67..8c3dcbfa4b 100644 --- a/windows.gaming.input/gamepad_headsetconnected.md +++ b/windows.gaming.input/gamepad_headsetconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.Gamepad.HeadsetConnected --api-type: winrt event ---- # Windows.Gaming.Input.Gamepad.HeadsetConnected ## -description Signals when a headset is attached to the gamepad. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.Gamepad.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.Gamepad.HeadsetConnected + +## -description +Signals when a headset is attached to the gamepad. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_headsetdisconnected.md b/windows.gaming.input/gamepad_headsetdisconnected.md index 35679bee06..8cb9249f33 100644 --- a/windows.gaming.input/gamepad_headsetdisconnected.md +++ b/windows.gaming.input/gamepad_headsetdisconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.Gamepad.HeadsetDisconnected --api-type: winrt event ---- # Windows.Gaming.Input.Gamepad.HeadsetDisconnected ## -description Signals when a headset is disconnected from the gamepad. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.Gamepad.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.Gamepad.HeadsetDisconnected + +## -description +Signals when a headset is disconnected from the gamepad. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_iswireless.md b/windows.gaming.input/gamepad_iswireless.md index 79575aee99..be7856109b 100644 --- a/windows.gaming.input/gamepad_iswireless.md +++ b/windows.gaming.input/gamepad_iswireless.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Gamepad.IsWireless --api-type: winrt property ---- # Windows.Gaming.Input.Gamepad.IsWireless ## -description Gets a value that indicates the wireless state of the gamepad. ## -property-value True if the gamepad is wireless. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Gamepad.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Gamepad.IsWireless + +## -description +Gets a value that indicates the wireless state of the gamepad. + +## -property-value +True if the gamepad is wireless. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_user.md b/windows.gaming.input/gamepad_user.md index edb46ea2e7..7519e49b03 100644 --- a/windows.gaming.input/gamepad_user.md +++ b/windows.gaming.input/gamepad_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Gamepad.User --api-type: winrt property ---- # Windows.Gaming.Input.Gamepad.User ## -description The user associated with the gamepad. ## -property-value The user associated with the gamepad. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Gamepad.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Gamepad.User + +## -description +The user associated with the gamepad. + +## -property-value +The user associated with the gamepad. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_userchanged.md b/windows.gaming.input/gamepad_userchanged.md index 5fea7f3dbf..264c24f314 100644 --- a/windows.gaming.input/gamepad_userchanged.md +++ b/windows.gaming.input/gamepad_userchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.Gamepad.UserChanged --api-type: winrt event ---- # Windows.Gaming.Input.Gamepad.UserChanged ## -description Signals when the user associated with the gamepad has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.Gamepad.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.Gamepad.UserChanged + +## -description +Signals when the user associated with the gamepad has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/gamepad_vibration.md b/windows.gaming.input/gamepad_vibration.md index 398af8a9e3..a95176f6bd 100644 --- a/windows.gaming.input/gamepad_vibration.md +++ b/windows.gaming.input/gamepad_vibration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Gamepad.Vibration --api-type: winrt property ---- # Windows.Gaming.Input.Gamepad.Vibration ## -description Describes the gamepad motor speed. ## -property-value Describes the gamepad motor speed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Gamepad.Vibration +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Gamepad.Vibration + +## -description +Describes the gamepad motor speed. + +## -property-value +Describes the gamepad motor speed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/headset.md b/windows.gaming.input/headset.md index d1be9b7021..9fa2905ce7 100644 --- a/windows.gaming.input/headset.md +++ b/windows.gaming.input/headset.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.Headset --api-type: winrt class ---- # Windows.Gaming.Input.Headset ## -description Contains information about an audio headset attached to a gamepad. ## -remarks Instances of the [Headset](headset.md) class cannot be created directly, instead instances of the [Headset](headset.md) class are retrieved through the [Gamepad.Headset](gamepad_headset.md) property or the [Gamepad.HeadsetConnected](gamepad_headsetconnected.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.Headset +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Headset + +## -description +Contains information about an audio headset attached to a gamepad. + +## -remarks +Instances of the [Headset](headset.md) class cannot be created directly, instead instances of the [Headset](headset.md) class are retrieved through the [Gamepad.Headset](gamepad_headset.md) property or the [Gamepad.HeadsetConnected](gamepad_headsetconnected.md) event. + +## -examples + +## -see-also diff --git a/windows.gaming.input/headset_capturedeviceid.md b/windows.gaming.input/headset_capturedeviceid.md index c578f19f02..696bcc255c 100644 --- a/windows.gaming.input/headset_capturedeviceid.md +++ b/windows.gaming.input/headset_capturedeviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Headset.CaptureDeviceId --api-type: winrt property ---- # Windows.Gaming.Input.Headset.CaptureDeviceId ## -description The XAudio endpoint ID for the headset's audio capture device. ## -property-value The XAudio endpoint ID for the headset's audio capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Headset.CaptureDeviceId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Headset.CaptureDeviceId + +## -description +The XAudio endpoint ID for the headset's audio capture device. + +## -property-value +The XAudio endpoint ID for the headset's audio capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/headset_renderdeviceid.md b/windows.gaming.input/headset_renderdeviceid.md index edd93e842e..9ddb2ad262 100644 --- a/windows.gaming.input/headset_renderdeviceid.md +++ b/windows.gaming.input/headset_renderdeviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.Headset.RenderDeviceId --api-type: winrt property ---- # Windows.Gaming.Input.Headset.RenderDeviceId ## -description The XAudio enpoint ID for the headset's audio render device. ## -property-value The XAudio enpoint ID for the headset's audio render device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.Headset.RenderDeviceId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Headset.RenderDeviceId + +## -description +The XAudio enpoint ID for the headset's audio render device. + +## -property-value +The XAudio enpoint ID for the headset's audio render device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/igamecontroller_headset.md b/windows.gaming.input/igamecontroller_headset.md index a535d02c0a..a975ae11b7 100644 --- a/windows.gaming.input/igamecontroller_headset.md +++ b/windows.gaming.input/igamecontroller_headset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.IGameController.Headset --api-type: winrt property ---- # Windows.Gaming.Input.IGameController.Headset ## -description The audio headset attached to the controller. ## -property-value The audio headset attached to the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.IGameController.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.IGameController.Headset + +## -description +The audio headset attached to the controller. + +## -property-value +The audio headset attached to the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/igamecontroller_headsetconnected.md b/windows.gaming.input/igamecontroller_headsetconnected.md index ff95b063f7..b4493aa0b3 100644 --- a/windows.gaming.input/igamecontroller_headsetconnected.md +++ b/windows.gaming.input/igamecontroller_headsetconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.IGameController.HeadsetConnected --api-type: winrt event ---- # Windows.Gaming.Input.IGameController.HeadsetConnected ## -description Signals when a headset is attached to the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.IGameController.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.IGameController.HeadsetConnected + +## -description +Signals when a headset is attached to the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/igamecontroller_headsetdisconnected.md b/windows.gaming.input/igamecontroller_headsetdisconnected.md index 31b6a7a4ac..1395f57056 100644 --- a/windows.gaming.input/igamecontroller_headsetdisconnected.md +++ b/windows.gaming.input/igamecontroller_headsetdisconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.IGameController.HeadsetDisconnected --api-type: winrt event ---- # Windows.Gaming.Input.IGameController.HeadsetDisconnected ## -description Signals when a headset is disconnected from the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.IGameController.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.IGameController.HeadsetDisconnected + +## -description +Signals when a headset is disconnected from the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/igamecontroller_iswireless.md b/windows.gaming.input/igamecontroller_iswireless.md index c1ded866ce..9393acb7b8 100644 --- a/windows.gaming.input/igamecontroller_iswireless.md +++ b/windows.gaming.input/igamecontroller_iswireless.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.IGameController.IsWireless --api-type: winrt property ---- # Windows.Gaming.Input.IGameController.IsWireless ## -description Gets a value that indicates the wireless state of the gamepad. ## -property-value True if the gamepad is wireless. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.IGameController.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.IGameController.IsWireless + +## -description +Gets a value that indicates the wireless state of the gamepad. + +## -property-value +True if the gamepad is wireless. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/igamecontroller_user.md b/windows.gaming.input/igamecontroller_user.md index 087031d0b6..f620183ecc 100644 --- a/windows.gaming.input/igamecontroller_user.md +++ b/windows.gaming.input/igamecontroller_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.IGameController.User --api-type: winrt property ---- # Windows.Gaming.Input.IGameController.User ## -description The user associated with the controller. ## -property-value The user associated with the controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.IGameController.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.IGameController.User + +## -description +The user associated with the controller. + +## -property-value +The user associated with the controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/igamecontroller_userchanged.md b/windows.gaming.input/igamecontroller_userchanged.md index 07733d2060..aee53207ac 100644 --- a/windows.gaming.input/igamecontroller_userchanged.md +++ b/windows.gaming.input/igamecontroller_userchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.IGameController.UserChanged --api-type: winrt event ---- # Windows.Gaming.Input.IGameController.UserChanged ## -description Signals when the user associated with the controller has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.IGameController.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.IGameController.UserChanged + +## -description +Signals when the user associated with the controller has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel.md b/windows.gaming.input/racingwheel.md index 4805b41a9b..d2fa685af6 100644 --- a/windows.gaming.input/racingwheel.md +++ b/windows.gaming.input/racingwheel.md @@ -1,3 +1,61 @@ ---- -api-id: T:Windows.Gaming.Input.RacingWheel --api-type: winrt class ---- # Windows.Gaming.Input.RacingWheel ## -description Represents a racing wheel. ## -remarks ### Supported Device s **RacingWheel** supports any Xbox One certified or Xbox 360 compatible racing wheel without force feedback support. Force feedback is supported on the following device models:
ManufacturerModel
LogitechG25
G27
G29
G920
MOMO Force Feedback Racing Wheel
ThrustmasterT300RS
T500RS
RGT Force Feedback
T150
TX
TMX
FanatecCSR
HID-mode for the Xbox One
Note that to use the devices listed above you should include a HID capability declaration in your app's appxmanifest: ```xml ``` ## -examples ## -see-also [IGameController](igamecontroller.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.RacingWheel +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.RacingWheel + +## -description +Represents a racing wheel. + +## -remarks +### Supported Device +s + + **RacingWheel** + supports any Xbox One certified or Xbox 360 compatible racing wheel without force feedback support. + +Force feedback is supported on the following device models: + + + + + + + + + + + + + + + + +
ManufacturerModel
LogitechG25
G27
G29
G920
MOMO Force Feedback Racing Wheel
ThrustmasterT300RS
T500RS
RGT Force Feedback
T150
TX
TMX
FanatecCSR
HID-mode for the Xbox One
+ +Note that to use the devices listed above you should include a HID capability declaration in your app's appxmanifest: + +```xml + + + + + + + + + + +``` + + + +## -examples + +## -see-also +[IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md b/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md index 8717790fee..dd7b348966 100644 --- a/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md +++ b/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.RacingWheel.GetButtonLabel(Windows.Gaming.Input.RacingWheelButtons) --api-type: winrt method ---- # Windows.Gaming.Input.RacingWheel.GetButtonLabel ## -description Retrieves the button label for the specified button. ## -parameters ### -param button The button to retrieve the label for. ## -returns Returns the button label for the specified button. If the button label is blank or there is no known label for the controller’s button, then None is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.RacingWheel.GetButtonLabel(Windows.Gaming.Input.RacingWheelButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RacingWheel.GetButtonLabel + +## -description +Retrieves the button label for the specified button. + +## -parameters +### -param button +The button to retrieve the label for. + +## -returns +Returns the button label for the specified button. If the button label is blank or there is no known label for the controller’s button, then None is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md b/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md index 5276f3dbc0..2baba37bdc 100644 --- a/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md +++ b/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.RacingWheel.GetCurrentReading --api-type: winrt method ---- # Windows.Gaming.Input.RacingWheel.GetCurrentReading ## -description Gets a snapshot of the racing wheel state. ## -returns Returns a [RacingWheelReading](racingwheelreading.md) containing the current state of the racing wheel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.RacingWheel.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RacingWheel.GetCurrentReading + +## -description +Gets a snapshot of the racing wheel state. + +## -returns +Returns a [RacingWheelReading](racingwheelreading.md) containing the current state of the racing wheel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_hasclutch.md b/windows.gaming.input/racingwheel_hasclutch.md index 5c2274e8c2..30c39af239 100644 --- a/windows.gaming.input/racingwheel_hasclutch.md +++ b/windows.gaming.input/racingwheel_hasclutch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.HasClutch --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.HasClutch ## -description Boolean indicating whether the racing wheel has a clutch. ## -property-value Boolean indicating whether the racing wheel has a clutch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.HasClutch +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.HasClutch + +## -description +Boolean indicating whether the racing wheel has a clutch. + +## -property-value +Boolean indicating whether the racing wheel has a clutch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_hashandbrake.md b/windows.gaming.input/racingwheel_hashandbrake.md index 9d80a75b4b..83aabe30c9 100644 --- a/windows.gaming.input/racingwheel_hashandbrake.md +++ b/windows.gaming.input/racingwheel_hashandbrake.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.HasHandbrake --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.HasHandbrake ## -description Boolean indicating whether the racing wheel has a handbrake. ## -property-value Boolean indicating whether the racing wheel has a handbrake. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.HasHandbrake +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.HasHandbrake + +## -description +Boolean indicating whether the racing wheel has a handbrake. + +## -property-value +Boolean indicating whether the racing wheel has a handbrake. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_haspatternshifter.md b/windows.gaming.input/racingwheel_haspatternshifter.md index b26b08d22b..d94fcd1b6d 100644 --- a/windows.gaming.input/racingwheel_haspatternshifter.md +++ b/windows.gaming.input/racingwheel_haspatternshifter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.HasPatternShifter --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.HasPatternShifter ## -description Boolean indicating whether the racing wheel has a pattern shifter. ## -property-value Boolean indicating whether the racing wheel has a pattern shifter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.HasPatternShifter +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.HasPatternShifter + +## -description +Boolean indicating whether the racing wheel has a pattern shifter. + +## -property-value +Boolean indicating whether the racing wheel has a pattern shifter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_headset.md b/windows.gaming.input/racingwheel_headset.md index 14c7535855..69935e38d1 100644 --- a/windows.gaming.input/racingwheel_headset.md +++ b/windows.gaming.input/racingwheel_headset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.Headset --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.Headset ## -description The audio headset attached to the racing wheel. ## -property-value The audio headset attached to the racing wheel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.Headset + +## -description +The audio headset attached to the racing wheel. + +## -property-value +The audio headset attached to the racing wheel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_headsetconnected.md b/windows.gaming.input/racingwheel_headsetconnected.md index 56f2e0941d..f650459f30 100644 --- a/windows.gaming.input/racingwheel_headsetconnected.md +++ b/windows.gaming.input/racingwheel_headsetconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.RacingWheel.HeadsetConnected --api-type: winrt event ---- # Windows.Gaming.Input.RacingWheel.HeadsetConnected ## -description Signals when a headset is attached to the racing wheel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.RacingWheel.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RacingWheel.HeadsetConnected + +## -description +Signals when a headset is attached to the racing wheel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_headsetdisconnected.md b/windows.gaming.input/racingwheel_headsetdisconnected.md index 7289362977..f5754161ed 100644 --- a/windows.gaming.input/racingwheel_headsetdisconnected.md +++ b/windows.gaming.input/racingwheel_headsetdisconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.RacingWheel.HeadsetDisconnected --api-type: winrt event ---- # Windows.Gaming.Input.RacingWheel.HeadsetDisconnected ## -description Signals when a headset is disconnected from the racing wheel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.RacingWheel.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RacingWheel.HeadsetDisconnected + +## -description +Signals when a headset is disconnected from the racing wheel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_iswireless.md b/windows.gaming.input/racingwheel_iswireless.md index 1e360df18d..902abece39 100644 --- a/windows.gaming.input/racingwheel_iswireless.md +++ b/windows.gaming.input/racingwheel_iswireless.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.IsWireless --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.IsWireless ## -description Gets a value that indicates the wireless state of the racing wheel. ## -property-value True if the gamepad is wireless. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.IsWireless + +## -description +Gets a value that indicates the wireless state of the racing wheel. + +## -property-value +True if the gamepad is wireless. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_maxpatternshiftergear.md b/windows.gaming.input/racingwheel_maxpatternshiftergear.md index 7ce76b303f..539a68a70a 100644 --- a/windows.gaming.input/racingwheel_maxpatternshiftergear.md +++ b/windows.gaming.input/racingwheel_maxpatternshiftergear.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.MaxPatternShifterGear --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.MaxPatternShifterGear ## -description The highest gear of the shifter. ## -property-value The highest gear of the shifter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.MaxPatternShifterGear +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.MaxPatternShifterGear + +## -description +The highest gear of the shifter. + +## -property-value +The highest gear of the shifter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_maxwheelangle.md b/windows.gaming.input/racingwheel_maxwheelangle.md index 73b896ee53..94c7e4ef1d 100644 --- a/windows.gaming.input/racingwheel_maxwheelangle.md +++ b/windows.gaming.input/racingwheel_maxwheelangle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.MaxWheelAngle --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.MaxWheelAngle ## -description The maximum angle, in degrees, of the racing wheel. ## -property-value The maximum angle, in degrees, of the racing wheel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.MaxWheelAngle +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.MaxWheelAngle + +## -description +The maximum angle, in degrees, of the racing wheel. + +## -property-value +The maximum angle, in degrees, of the racing wheel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_racingwheeladded.md b/windows.gaming.input/racingwheel_racingwheeladded.md index 7a929cdb3d..89da5bd2b3 100644 --- a/windows.gaming.input/racingwheel_racingwheeladded.md +++ b/windows.gaming.input/racingwheel_racingwheeladded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Gaming.Input.RacingWheel.RacingWheelAdded --api-type: winrt event ---- # Windows.Gaming.Input.RacingWheel.RacingWheelAdded ## -description Signals when a new racing wheel is connected. ## -remarks To identify controllers that have allready been added, you query the list of conected controllers using [RacingWheel.RacingWheels](racingwheel_racingwheels.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.RacingWheel.RacingWheelAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RacingWheel.RacingWheelAdded + +## -description +Signals when a new racing wheel is connected. + +## -remarks +To identify controllers that have allready been added, you query the list of conected controllers using [RacingWheel.RacingWheels](racingwheel_racingwheels.md). + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_racingwheelremoved.md b/windows.gaming.input/racingwheel_racingwheelremoved.md index 4fcabbfb69..f365da7064 100644 --- a/windows.gaming.input/racingwheel_racingwheelremoved.md +++ b/windows.gaming.input/racingwheel_racingwheelremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.RacingWheel.RacingWheelRemoved --api-type: winrt event ---- # Windows.Gaming.Input.RacingWheel.RacingWheelRemoved ## -description Signals when a new racing wheel is disconnected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.RacingWheel.RacingWheelRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RacingWheel.RacingWheelRemoved + +## -description +Signals when a new racing wheel is disconnected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_racingwheels.md b/windows.gaming.input/racingwheel_racingwheels.md index 8db668742f..fd8b69de28 100644 --- a/windows.gaming.input/racingwheel_racingwheels.md +++ b/windows.gaming.input/racingwheel_racingwheels.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.RacingWheels --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.RacingWheels ## -description The list of all connected racing wheels. ## -property-value The list of all connected racing wheels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.RacingWheels +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.RacingWheels + +## -description +The list of all connected racing wheels. + +## -property-value +The list of all connected racing wheels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_user.md b/windows.gaming.input/racingwheel_user.md index 677a16d9cc..0b72ac4106 100644 --- a/windows.gaming.input/racingwheel_user.md +++ b/windows.gaming.input/racingwheel_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.User --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.User ## -description The user associated with the racing wheel. ## -property-value The user associated with the racing wheel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.User + +## -description +The user associated with the racing wheel. + +## -property-value +The user associated with the racing wheel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_userchanged.md b/windows.gaming.input/racingwheel_userchanged.md index 7f2d7df908..46fe2adcf1 100644 --- a/windows.gaming.input/racingwheel_userchanged.md +++ b/windows.gaming.input/racingwheel_userchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.RacingWheel.UserChanged --api-type: winrt event ---- # Windows.Gaming.Input.RacingWheel.UserChanged ## -description Signals when the user associated with the racing wheel has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.RacingWheel.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RacingWheel.UserChanged + +## -description +Signals when the user associated with the racing wheel has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/racingwheel_wheelmotor.md b/windows.gaming.input/racingwheel_wheelmotor.md index 62df37e507..e41f7f182a 100644 --- a/windows.gaming.input/racingwheel_wheelmotor.md +++ b/windows.gaming.input/racingwheel_wheelmotor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Gaming.Input.RacingWheel.WheelMotor --api-type: winrt property ---- # Windows.Gaming.Input.RacingWheel.WheelMotor ## -description The force feedback motor for the racing wheel. ## -property-value The force feedback motor for the racing wheel. If the controller does not support force feedback, this property will be null. ## -remarks Force feedback is only supported for selected HID controllers. Xbox 360 and Xbox One racing wheels do not support force feedback in Windows 10 at this time. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.RacingWheel.WheelMotor +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RacingWheel.WheelMotor + +## -description +The force feedback motor for the racing wheel. + +## -property-value +The force feedback motor for the racing wheel. If the controller does not support force feedback, this property will be null. + +## -remarks +Force feedback is only supported for selected HID controllers. Xbox 360 and Xbox One racing wheels do not support force feedback in Windows 10 at this time. + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller.md b/windows.gaming.input/uinavigationcontroller.md index 891558ac62..8d86112025 100644 --- a/windows.gaming.input/uinavigationcontroller.md +++ b/windows.gaming.input/uinavigationcontroller.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Input.UINavigationController --api-type: winrt class ---- # Windows.Gaming.Input.UINavigationController ## -description Represents buttons on a controller of any type that can be used for UI navigation. Most Gamepads, ArcadeSticks, and RacingWheels can also be accessed as a UINavigationController. It is recommended that games use the controller specific class during gameplay and the UINavigationController class for UI menus. ## -remarks ## -examples ## -see-also [IGameController](igamecontroller.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Input.UINavigationController +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.UINavigationController + +## -description +Represents buttons on a controller of any type that can be used for UI navigation. Most Gamepads, ArcadeSticks, and RacingWheels can also be accessed as a UINavigationController. It is recommended that games use the controller specific class during gameplay and the UINavigationController class for UI menus. + +## -remarks + +## -examples + +## -see-also +[IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md b/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md index 5ce3194c68..3603fb8c9e 100644 --- a/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md +++ b/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Input.UINavigationController.GetCurrentReading --api-type: winrt method ---- # Windows.Gaming.Input.UINavigationController.GetCurrentReading ## -description Gets a snapshot of the UI navigation controller state. ## -returns Returns a [UINavigationReading](uinavigationreading.md) containing the state of the UI navigation controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.UINavigationController.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.UINavigationController.GetCurrentReading + +## -description +Gets a snapshot of the UI navigation controller state. + +## -returns +Returns a [UINavigationReading](uinavigationreading.md) containing the state of the UI navigation controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md b/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md index ddf518e6fe..a7387882f1 100644 --- a/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md +++ b/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.UINavigationController.GetOptionalButtonLabel(Windows.Gaming.Input.OptionalUINavigationButtons) --api-type: winrt method ---- # Windows.Gaming.Input.UINavigationController.GetOptionalButtonLabel ## -description Retrieves a label for an optional UI navigation button. ## -parameters ### -param button Enumeration indicating which UI navigation button to retrieve the label for. ## -returns The label of the specified button. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.UINavigationController.GetOptionalButtonLabel(Windows.Gaming.Input.OptionalUINavigationButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.UINavigationController.GetOptionalButtonLabel + +## -description +Retrieves a label for an optional UI navigation button. + +## -parameters +### -param button +Enumeration indicating which UI navigation button to retrieve the label for. + +## -returns +The label of the specified button. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md b/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md index 798b81ba33..956cb0cfdc 100644 --- a/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md +++ b/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Input.UINavigationController.GetRequiredButtonLabel(Windows.Gaming.Input.RequiredUINavigationButtons) --api-type: winrt method ---- # Windows.Gaming.Input.UINavigationController.GetRequiredButtonLabel ## -description Retrieves a label for a required UI navigation button. ## -parameters ### -param button Enumeration indicating which UI navigation button to retrieve the label for. ## -returns The label of the specified button. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Input.UINavigationController.GetRequiredButtonLabel(Windows.Gaming.Input.RequiredUINavigationButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.UINavigationController.GetRequiredButtonLabel + +## -description +Retrieves a label for a required UI navigation button. + +## -parameters +### -param button +Enumeration indicating which UI navigation button to retrieve the label for. + +## -returns +The label of the specified button. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_headset.md b/windows.gaming.input/uinavigationcontroller_headset.md index 193e48d478..55133aec53 100644 --- a/windows.gaming.input/uinavigationcontroller_headset.md +++ b/windows.gaming.input/uinavigationcontroller_headset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.UINavigationController.Headset --api-type: winrt property ---- # Windows.Gaming.Input.UINavigationController.Headset ## -description The audio headset attached to the UI navigation controller. ## -property-value The audio headset attached to the UI navigation controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.UINavigationController.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.UINavigationController.Headset + +## -description +The audio headset attached to the UI navigation controller. + +## -property-value +The audio headset attached to the UI navigation controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_headsetconnected.md b/windows.gaming.input/uinavigationcontroller_headsetconnected.md index 7af79de7b4..c78885ffb8 100644 --- a/windows.gaming.input/uinavigationcontroller_headsetconnected.md +++ b/windows.gaming.input/uinavigationcontroller_headsetconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.UINavigationController.HeadsetConnected --api-type: winrt event ---- # Windows.Gaming.Input.UINavigationController.HeadsetConnected ## -description Signals when a headset is attached to the UI navigation controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.UINavigationController.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.UINavigationController.HeadsetConnected + +## -description +Signals when a headset is attached to the UI navigation controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md b/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md index e99ea428f0..305f972763 100644 --- a/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md +++ b/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.UINavigationController.HeadsetDisconnected --api-type: winrt event ---- # Windows.Gaming.Input.UINavigationController.HeadsetDisconnected ## -description Signals when a headset is disconnected from the UI navigation controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.UINavigationController.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.UINavigationController.HeadsetDisconnected + +## -description +Signals when a headset is disconnected from the UI navigation controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_iswireless.md b/windows.gaming.input/uinavigationcontroller_iswireless.md index 32596d0891..cd43cf6681 100644 --- a/windows.gaming.input/uinavigationcontroller_iswireless.md +++ b/windows.gaming.input/uinavigationcontroller_iswireless.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.UINavigationController.IsWireless --api-type: winrt property ---- # Windows.Gaming.Input.UINavigationController.IsWireless ## -description Gets a value that indicates the wireless state of the UI navigation controller. ## -property-value True if the gamepad is wireless. Otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.UINavigationController.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.UINavigationController.IsWireless + +## -description +Gets a value that indicates the wireless state of the UI navigation controller. + +## -property-value +True if the gamepad is wireless. Otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md b/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md index e1bcea30ef..a5d3696454 100644 --- a/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md +++ b/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Gaming.Input.UINavigationController.UINavigationControllerAdded --api-type: winrt event ---- # Windows.Gaming.Input.UINavigationController.UINavigationControllerAdded ## -description Signals when a new UI navigation controller is connected. ## -remarks To identify controllers that have allready been added, you query the list of conected controllers using [UINavigationController.UINavigationControllers](uinavigationcontroller_uinavigationcontrollers.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.UINavigationController.UINavigationControllerAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.UINavigationController.UINavigationControllerAdded + +## -description +Signals when a new UI navigation controller is connected. + +## -remarks +To identify controllers that have allready been added, you query the list of conected controllers using [UINavigationController.UINavigationControllers](uinavigationcontroller_uinavigationcontrollers.md). + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_uinavigationcontrollerremoved.md b/windows.gaming.input/uinavigationcontroller_uinavigationcontrollerremoved.md index f11ba32c9b..38ae07e4ac 100644 --- a/windows.gaming.input/uinavigationcontroller_uinavigationcontrollerremoved.md +++ b/windows.gaming.input/uinavigationcontroller_uinavigationcontrollerremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.UINavigationController.UINavigationControllerRemoved --api-type: winrt event ---- # Windows.Gaming.Input.UINavigationController.UINavigationControllerRemoved ## -description Signals when a UI navigation controller is disconnected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.UINavigationController.UINavigationControllerRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.UINavigationController.UINavigationControllerRemoved + +## -description +Signals when a UI navigation controller is disconnected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_uinavigationcontrollers.md b/windows.gaming.input/uinavigationcontroller_uinavigationcontrollers.md index 968541bb30..b1c86d85ab 100644 --- a/windows.gaming.input/uinavigationcontroller_uinavigationcontrollers.md +++ b/windows.gaming.input/uinavigationcontroller_uinavigationcontrollers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.UINavigationController.UINavigationControllers --api-type: winrt property ---- # Windows.Gaming.Input.UINavigationController.UINavigationControllers ## -description The list of all connected UI navigation controllers. ## -property-value The list of all connected UI navigation controllers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.UINavigationController.UINavigationControllers +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.UINavigationController.UINavigationControllers + +## -description +The list of all connected UI navigation controllers. + +## -property-value +The list of all connected UI navigation controllers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_user.md b/windows.gaming.input/uinavigationcontroller_user.md index 2431b76c0f..44ed6bf1f3 100644 --- a/windows.gaming.input/uinavigationcontroller_user.md +++ b/windows.gaming.input/uinavigationcontroller_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Input.UINavigationController.User --api-type: winrt property ---- # Windows.Gaming.Input.UINavigationController.User ## -description The user associated with the UI navigation controller. ## -property-value The user associated with the UI navigation controller. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Input.UINavigationController.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.UINavigationController.User + +## -description +The user associated with the UI navigation controller. + +## -property-value +The user associated with the UI navigation controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.input/uinavigationcontroller_userchanged.md b/windows.gaming.input/uinavigationcontroller_userchanged.md index 6fdd8fc4f3..2fc420502c 100644 --- a/windows.gaming.input/uinavigationcontroller_userchanged.md +++ b/windows.gaming.input/uinavigationcontroller_userchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Input.UINavigationController.UserChanged --api-type: winrt event ---- # Windows.Gaming.Input.UINavigationController.UserChanged ## -description Signals when the user associated with the UI navigation controller has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Input.UINavigationController.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.UINavigationController.UserChanged + +## -description +Signals when the user associated with the UI navigation controller has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelist.md b/windows.gaming.preview.gamesenumeration/gamelist.md index 1a20f2ea52..6a2c4507fa 100644 --- a/windows.gaming.preview.gamesenumeration/gamelist.md +++ b/windows.gaming.preview.gamesenumeration/gamelist.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.Preview.GamesEnumeration.GameList --api-type: winrt class ---- # Windows.Gaming.Preview.GamesEnumeration.GameList ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Preview.GamesEnumeration.GameList +-api-type: winrt class +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameList + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelist_findallasync_1257462890.md b/windows.gaming.preview.gamesenumeration/gamelist_findallasync_1257462890.md index 69708bacc0..338cf45d60 100644 --- a/windows.gaming.preview.gamesenumeration/gamelist_findallasync_1257462890.md +++ b/windows.gaming.preview.gamesenumeration/gamelist_findallasync_1257462890.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync(System.String) --api-type: winrt method ---- # Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param packageFamilyName This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [FindAllAsync](gamelist_findallasync_326280522.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param packageFamilyName +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync](gamelist_findallasync_326280522.md) \ No newline at end of file diff --git a/windows.gaming.preview.gamesenumeration/gamelist_findallasync_326280522.md b/windows.gaming.preview.gamesenumeration/gamelist_findallasync_326280522.md index f511746570..c076eaf309 100644 --- a/windows.gaming.preview.gamesenumeration/gamelist_findallasync_326280522.md +++ b/windows.gaming.preview.gamesenumeration/gamelist_findallasync_326280522.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync --api-type: winrt method ---- # Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [FindAllAsync(String)](gamelist_findallasync_1257462890.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[FindAllAsync(String)](gamelist_findallasync_1257462890.md) \ No newline at end of file diff --git a/windows.gaming.preview.gamesenumeration/gamelist_gameadded.md b/windows.gaming.preview.gamesenumeration/gamelist_gameadded.md index 054ebabe66..7caff6c0ce 100644 --- a/windows.gaming.preview.gamesenumeration/gamelist_gameadded.md +++ b/windows.gaming.preview.gamesenumeration/gamelist_gameadded.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Preview.GamesEnumeration.GameList.GameAdded --api-type: winrt event ---- # Windows.Gaming.Preview.GamesEnumeration.GameList.GameAdded ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Preview.GamesEnumeration.GameList.GameAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameList.GameAdded + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelist_gameremoved.md b/windows.gaming.preview.gamesenumeration/gamelist_gameremoved.md index 0308a71c16..ae0aa4d192 100644 --- a/windows.gaming.preview.gamesenumeration/gamelist_gameremoved.md +++ b/windows.gaming.preview.gamesenumeration/gamelist_gameremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Preview.GamesEnumeration.GameList.GameRemoved --api-type: winrt event ---- # Windows.Gaming.Preview.GamesEnumeration.GameList.GameRemoved ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Preview.GamesEnumeration.GameList.GameRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameList.GameRemoved + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelist_gameupdated.md b/windows.gaming.preview.gamesenumeration/gamelist_gameupdated.md index 2b8d0ed549..239ae0df5b 100644 --- a/windows.gaming.preview.gamesenumeration/gamelist_gameupdated.md +++ b/windows.gaming.preview.gamesenumeration/gamelist_gameupdated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Gaming.Preview.GamesEnumeration.GameList.GameUpdated --api-type: winrt event ---- # Windows.Gaming.Preview.GamesEnumeration.GameList.GameUpdated ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Gaming.Preview.GamesEnumeration.GameList.GameUpdated +-api-type: winrt event +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameList.GameUpdated + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelistentry.md b/windows.gaming.preview.gamesenumeration/gamelistentry.md index 0f90ca54a1..bd0eb70d4c 100644 --- a/windows.gaming.preview.gamesenumeration/gamelistentry.md +++ b/windows.gaming.preview.gamesenumeration/gamelistentry.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Gaming.Preview.GamesEnumeration.GameListEntry --api-type: winrt class ---- # Windows.Gaming.Preview.GamesEnumeration.GameListEntry ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -examples ## -see-also [IGameListEntry](igamelistentry.md) \ No newline at end of file +--- +-api-id: T:Windows.Gaming.Preview.GamesEnumeration.GameListEntry +-api-type: winrt class +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameListEntry + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -examples + +## -see-also +[IGameListEntry](igamelistentry.md) \ No newline at end of file diff --git a/windows.gaming.preview.gamesenumeration/gamelistentry_category.md b/windows.gaming.preview.gamesenumeration/gamelistentry_category.md index 016d442f10..93d1b09b03 100644 --- a/windows.gaming.preview.gamesenumeration/gamelistentry_category.md +++ b/windows.gaming.preview.gamesenumeration/gamelistentry_category.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Category --api-type: winrt property ---- # Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Category ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Category +-api-type: winrt property +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Category + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelistentry_displayinfo.md b/windows.gaming.preview.gamesenumeration/gamelistentry_displayinfo.md index fc9485546b..da8d085a6f 100644 --- a/windows.gaming.preview.gamesenumeration/gamelistentry_displayinfo.md +++ b/windows.gaming.preview.gamesenumeration/gamelistentry_displayinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.DisplayInfo --api-type: winrt property ---- # Windows.Gaming.Preview.GamesEnumeration.GameListEntry.DisplayInfo ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.DisplayInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameListEntry.DisplayInfo + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelistentry_launchasync_79233887.md b/windows.gaming.preview.gamesenumeration/gamelistentry_launchasync_79233887.md index a5f72cc458..36b8b4c3cf 100644 --- a/windows.gaming.preview.gamesenumeration/gamelistentry_launchasync_79233887.md +++ b/windows.gaming.preview.gamesenumeration/gamelistentry_launchasync_79233887.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.LaunchAsync --api-type: winrt method ---- # Windows.Gaming.Preview.GamesEnumeration.GameListEntry.LaunchAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.LaunchAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameListEntry.LaunchAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelistentry_properties.md b/windows.gaming.preview.gamesenumeration/gamelistentry_properties.md index 1cf4c4a584..1c84a25ce0 100644 --- a/windows.gaming.preview.gamesenumeration/gamelistentry_properties.md +++ b/windows.gaming.preview.gamesenumeration/gamelistentry_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Properties --api-type: winrt property ---- # Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Properties ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Properties +-api-type: winrt property +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameListEntry.Properties + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/gamelistentry_setcategoryasync_1889299267.md b/windows.gaming.preview.gamesenumeration/gamelistentry_setcategoryasync_1889299267.md index 2ca381c1bd..d7dc78f29d 100644 --- a/windows.gaming.preview.gamesenumeration/gamelistentry_setcategoryasync_1889299267.md +++ b/windows.gaming.preview.gamesenumeration/gamelistentry_setcategoryasync_1889299267.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.SetCategoryAsync(Windows.Gaming.Preview.GamesEnumeration.GameListCategory) --api-type: winrt method ---- # Windows.Gaming.Preview.GamesEnumeration.GameListEntry.SetCategoryAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Preview.GamesEnumeration.GameListEntry.SetCategoryAsync(Windows.Gaming.Preview.GamesEnumeration.GameListCategory) +-api-type: winrt method +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.GameListEntry.SetCategoryAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/igamelistentry_category.md b/windows.gaming.preview.gamesenumeration/igamelistentry_category.md index 7ddc0f8b18..eab9187bf8 100644 --- a/windows.gaming.preview.gamesenumeration/igamelistentry_category.md +++ b/windows.gaming.preview.gamesenumeration/igamelistentry_category.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Category --api-type: winrt property ---- # Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Category ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Category +-api-type: winrt property +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Category + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/igamelistentry_displayinfo.md b/windows.gaming.preview.gamesenumeration/igamelistentry_displayinfo.md index 3f3ff3ba20..0ef2547058 100644 --- a/windows.gaming.preview.gamesenumeration/igamelistentry_displayinfo.md +++ b/windows.gaming.preview.gamesenumeration/igamelistentry_displayinfo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.DisplayInfo --api-type: winrt property ---- # Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.DisplayInfo ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.DisplayInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.DisplayInfo + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/igamelistentry_launchasync.md b/windows.gaming.preview.gamesenumeration/igamelistentry_launchasync.md index 0d9239484c..c38afbd670 100644 --- a/windows.gaming.preview.gamesenumeration/igamelistentry_launchasync.md +++ b/windows.gaming.preview.gamesenumeration/igamelistentry_launchasync.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.LaunchAsync --api-type: winrt method ---- # Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.LaunchAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.LaunchAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.LaunchAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/igamelistentry_properties.md b/windows.gaming.preview.gamesenumeration/igamelistentry_properties.md index eb57f88a97..11b2ec64fb 100644 --- a/windows.gaming.preview.gamesenumeration/igamelistentry_properties.md +++ b/windows.gaming.preview.gamesenumeration/igamelistentry_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Properties --api-type: winrt property ---- # Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Properties ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Properties +-api-type: winrt property +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.Properties + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.preview.gamesenumeration/igamelistentry_setcategoryasync.md b/windows.gaming.preview.gamesenumeration/igamelistentry_setcategoryasync.md index 9c85bbc24c..94b17a22ae 100644 --- a/windows.gaming.preview.gamesenumeration/igamelistentry_setcategoryasync.md +++ b/windows.gaming.preview.gamesenumeration/igamelistentry_setcategoryasync.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.SetCategoryAsync(Windows.Gaming.Preview.GamesEnumeration.GameListCategory) --api-type: winrt method ---- # Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.SetCategoryAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.SetCategoryAsync(Windows.Gaming.Preview.GamesEnumeration.GameListCategory) +-api-type: winrt method +--- + + + +# Windows.Gaming.Preview.GamesEnumeration.IGameListEntry.SetCategoryAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.ui/gamebar.md b/windows.gaming.ui/gamebar.md index ecb47cd3bf..608a7b1e0c 100644 --- a/windows.gaming.ui/gamebar.md +++ b/windows.gaming.ui/gamebar.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Gaming.UI.GameBar --api-type: winrt class ---- # Windows.Gaming.UI.GameBar ## -description Provides notifications and information about the visibility and input redirection state of Game bar. ## -remarks The events and properties of are class static. Objects are not instantiated for this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.UI.GameBar +-api-type: winrt class +--- + + + +# Windows.Gaming.UI.GameBar + +## -description +Provides notifications and information about the visibility and input redirection state of Game bar. + +## -remarks +The events and properties of are class static. Objects are not instantiated for this class. + +## -examples + +## -see-also diff --git a/windows.gaming.ui/gamebar_isinputredirected.md b/windows.gaming.ui/gamebar_isinputredirected.md index 425abd0fce..cddfd6fd7a 100644 --- a/windows.gaming.ui/gamebar_isinputredirected.md +++ b/windows.gaming.ui/gamebar_isinputredirected.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Gaming.UI.GameBar.IsInputRedirected --api-type: winrt property ---- # Windows.Gaming.UI.GameBar.IsInputRedirected ## -description Indicates whether input is currently redirected to Game bar. After the user invokes Game bar, input may be redirected to Game bar while the player interacts with it. Games that are no longer receiving input will typically want to pause gameplay or present an idle state. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. To be notified of changes to , handle the [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md) event. ## -property-value **true** if input is currently redirected to Game bar; **false** otherwise. ## -remarks ## -examples ## -see-also [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md), [Visible](gamebar_visible.md) \ No newline at end of file +--- +-api-id: P:Windows.Gaming.UI.GameBar.IsInputRedirected +-api-type: winrt property +--- + + + +# Windows.Gaming.UI.GameBar.IsInputRedirected + +## -description +Indicates whether input is currently redirected to Game bar. + +After the user invokes Game bar, input may be redirected to Game bar while the player interacts with it. Games that are no longer receiving input will typically want to pause gameplay or present an idle state. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. + +To be notified of changes to , handle the [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md) event. + +## -property-value +**true** if input is currently redirected to Game bar; **false** otherwise. + +## -remarks + +## -examples + +## -see-also +[IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md), [Visible](gamebar_visible.md) \ No newline at end of file diff --git a/windows.gaming.ui/gamebar_isinputredirectedchanged.md b/windows.gaming.ui/gamebar_isinputredirectedchanged.md index 40fa6a7dba..b886b9537e 100644 --- a/windows.gaming.ui/gamebar_isinputredirectedchanged.md +++ b/windows.gaming.ui/gamebar_isinputredirectedchanged.md @@ -1,3 +1,27 @@ ---- -api-id: E:Windows.Gaming.UI.GameBar.IsInputRedirectedChanged --api-type: winrt event ---- # Windows.Gaming.UI.GameBar.IsInputRedirectedChanged ## -description Occurs when input is redirected to Game bar or input is restored to the game. After the user invokes Game bar, input may be redirected to Game bar while the player interacts with it. Games that are no longer receiving input will typically want to pause gameplay or present an idle state. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. > [!TIP] > This event can be raised on background (non-UI) threads. You may need to post an event to the UI thread to perform UI actions. Use [IsInputRedirected](gamebar_isinputredirected.md) to determine whether input is currently redirected to Game bar. ## -remarks ## -examples ## -see-also [IsInputRedirected](gamebar_isinputredirected.md), [VisibilityChanged](gamebar_visibilitychanged.md) \ No newline at end of file +--- +-api-id: E:Windows.Gaming.UI.GameBar.IsInputRedirectedChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.UI.GameBar.IsInputRedirectedChanged + +## -description +Occurs when input is redirected to Game bar or input is restored to the game. + +After the user invokes Game bar, input may be redirected to Game bar while the player interacts with it. Games that are no longer receiving input will typically want to pause gameplay or present an idle state. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. + +> [!TIP] +> This event can be raised on background (non-UI) threads. You may need to post an event to the UI thread to perform UI actions. + +Use [IsInputRedirected](gamebar_isinputredirected.md) to determine whether input is currently redirected to Game bar. + +## -remarks + +## -examples + +## -see-also +[IsInputRedirected](gamebar_isinputredirected.md), [VisibilityChanged](gamebar_visibilitychanged.md) \ No newline at end of file diff --git a/windows.gaming.ui/gamebar_visibilitychanged.md b/windows.gaming.ui/gamebar_visibilitychanged.md index 68f0191a48..94186a377e 100644 --- a/windows.gaming.ui/gamebar_visibilitychanged.md +++ b/windows.gaming.ui/gamebar_visibilitychanged.md @@ -1,3 +1,27 @@ ---- -api-id: E:Windows.Gaming.UI.GameBar.VisibilityChanged --api-type: winrt event ---- # Windows.Gaming.UI.GameBar.VisibilityChanged ## -description Occurs when Game bar is shown or dismissed. Use the event to monitor the visibility state of Game bar. Games can choose to pause gameplay or present an idle state when Game bar is visible and being drawn over the game. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. > [!TIP] > This event can be raised on background (non-UI) threads. You may need to post an event to the UI thread to perform UI actions. Use [Visible](gamebar_visible.md) to determine whether Game bar is currently visible. ## -remarks ## -examples ## -see-also [Visible](gamebar_visible.md), [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md) \ No newline at end of file +--- +-api-id: E:Windows.Gaming.UI.GameBar.VisibilityChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.UI.GameBar.VisibilityChanged + +## -description +Occurs when Game bar is shown or dismissed. + +Use the event to monitor the visibility state of Game bar. Games can choose to pause gameplay or present an idle state when Game bar is visible and being drawn over the game. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. + +> [!TIP] +> This event can be raised on background (non-UI) threads. You may need to post an event to the UI thread to perform UI actions. + +Use [Visible](gamebar_visible.md) to determine whether Game bar is currently visible. + +## -remarks + +## -examples + +## -see-also +[Visible](gamebar_visible.md), [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md) \ No newline at end of file diff --git a/windows.gaming.ui/gamebar_visible.md b/windows.gaming.ui/gamebar_visible.md index 36d4736246..5ebb24acb6 100644 --- a/windows.gaming.ui/gamebar_visible.md +++ b/windows.gaming.ui/gamebar_visible.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Gaming.UI.GameBar.Visible --api-type: winrt property ---- # Windows.Gaming.UI.GameBar.Visible ## -description Indicates whether Game bar is currently visible. Use the property to determine the visibility state of Game bar. Games can choose to pause gameplay or present an idle state when Game bar is visible and being drawn over the game. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. To be notified of changes to , handle the [VisibilityChanged](gamebar_visibilitychanged.md) event. ## -property-value **true** if Game bar is currently visible; **false** otherwise. ## -remarks ## -examples ## -see-also [VisibilityChanged](gamebar_visibilitychanged.md), [IsInputRedirected](gamebar_isinputredirected.md), [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md) \ No newline at end of file +--- +-api-id: P:Windows.Gaming.UI.GameBar.Visible +-api-type: winrt property +--- + + + +# Windows.Gaming.UI.GameBar.Visible + +## -description +Indicates whether Game bar is currently visible. + +Use the property to determine the visibility state of Game bar. Games can choose to pause gameplay or present an idle state when Game bar is visible and being drawn over the game. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause. + +To be notified of changes to , handle the [VisibilityChanged](gamebar_visibilitychanged.md) event. + +## -property-value +**true** if Game bar is currently visible; **false** otherwise. + +## -remarks + +## -examples + +## -see-also +[VisibilityChanged](gamebar_visibilitychanged.md), [IsInputRedirected](gamebar_isinputredirected.md), [IsInputRedirectedChanged](gamebar_isinputredirectedchanged.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesaveblobgetresult.md b/windows.gaming.xboxlive.storage/gamesaveblobgetresult.md index 53b7d94a1a..44ece44c48 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobgetresult.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobgetresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobgetresult_status.md b/windows.gaming.xboxlive.storage/gamesaveblobgetresult_status.md index 09de711369..c794a1dc55 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobgetresult_status.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobgetresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Status --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Status ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Status +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Status + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobgetresult_value.md b/windows.gaming.xboxlive.storage/gamesaveblobgetresult_value.md index 599c9326f8..9a05fd76bf 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobgetresult_value.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobgetresult_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Value --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Value ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Value +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobGetResult.Value + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfo.md b/windows.gaming.xboxlive.storage/gamesaveblobinfo.md index 05c58f54c0..98e4817913 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfo.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfo_name.md b/windows.gaming.xboxlive.storage/gamesaveblobinfo_name.md index e5deb444a0..98f59bc208 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfo_name.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfo_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Name --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Name ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Name +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Name + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfo_size.md b/windows.gaming.xboxlive.storage/gamesaveblobinfo_size.md index 0cefdc33e3..abaa069fed 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfo_size.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfo_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Size --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Size ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Size +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfo.Size + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult.md b/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult.md index 415d521481..b10ebd3a8d 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_status.md b/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_status.md index e77ea9aeed..d0e1ce4c7b 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_status.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Status --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Status ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Status +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Status + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_value.md b/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_value.md index 3634a761b5..58aebdd089 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_value.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfogetresult_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Value --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Value ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Value +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoGetResult.Value + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery.md b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery.md index abbfdc91ac..172a87263b 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_1697460829.md b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_1697460829.md index c1c6060e25..8cda1bf0dc 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_1697460829.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_1697460829.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param startIndex This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param maxNumberOfItems This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [GetBlobInfoAsync](gamesaveblobinfoquery_getblobinfoasync_517889704.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param startIndex +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param maxNumberOfItems +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[GetBlobInfoAsync](gamesaveblobinfoquery_getblobinfoasync_517889704.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_517889704.md b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_517889704.md index 5a88ab1690..177f1bef87 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_517889704.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getblobinfoasync_517889704.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [GetBlobInfoAsync(UInt32, UInt32)](gamesaveblobinfoquery_getblobinfoasync_1697460829.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetBlobInfoAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[GetBlobInfoAsync(UInt32, UInt32)](gamesaveblobinfoquery_getblobinfoasync_1697460829.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getitemcountasync_1115995255.md b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getitemcountasync_1115995255.md index e277d7d361..354b07cbdb 100644 --- a/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getitemcountasync_1115995255.md +++ b/windows.gaming.xboxlive.storage/gamesaveblobinfoquery_getitemcountasync_1115995255.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetItemCountAsync --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetItemCountAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetItemCountAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveBlobInfoQuery.GetItemCountAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer.md b/windows.gaming.xboxlive.storage/gamesavecontainer.md index 8876fd3d2e..93b30698cb 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainer --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainer +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_createblobinfoquery_1392439372.md b/windows.gaming.xboxlive.storage/gamesavecontainer_createblobinfoquery_1392439372.md index 25ca3033fb..a557cae3b4 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_createblobinfoquery_1392439372.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_createblobinfoquery_1392439372.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.CreateBlobInfoQuery(System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.CreateBlobInfoQuery ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param blobNamePrefix This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.CreateBlobInfoQuery(System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.CreateBlobInfoQuery + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param blobNamePrefix +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_getasync_465620582.md b/windows.gaming.xboxlive.storage/gamesavecontainer_getasync_465620582.md index ba7dfdaed9..732da79990 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_getasync_465620582.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_getasync_465620582.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.GetAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.GetAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param blobsToRead This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.GetAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.GetAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param blobsToRead +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_name.md b/windows.gaming.xboxlive.storage/gamesavecontainer_name.md index d9379cd100..bf643239e5 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_name.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainer.Name --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.Name ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainer.Name +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.Name + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_provider.md b/windows.gaming.xboxlive.storage/gamesavecontainer_provider.md index fd1d2e5bc5..5cf4f774ea 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_provider.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_provider.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainer.Provider --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.Provider ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainer.Provider +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.Provider + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_readasync_130997576.md b/windows.gaming.xboxlive.storage/gamesavecontainer_readasync_130997576.md index 4ad341f83a..720532a243 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_readasync_130997576.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_readasync_130997576.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.ReadAsync(Windows.Foundation.Collections.IMapView{System.String,Windows.Storage.Streams.IBuffer}) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.ReadAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param blobsToRead This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.ReadAsync(Windows.Foundation.Collections.IMapView{System.String,Windows.Storage.Streams.IBuffer}) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.ReadAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param blobsToRead +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_submitpropertysetupdatesasync_435712146.md b/windows.gaming.xboxlive.storage/gamesavecontainer_submitpropertysetupdatesasync_435712146.md index 729d9bc894..3f459ffbaf 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_submitpropertysetupdatesasync_435712146.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_submitpropertysetupdatesasync_435712146.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitPropertySetUpdatesAsync(Windows.Foundation.Collections.IPropertySet,Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitPropertySetUpdatesAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param blobsToWrite This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param blobsToDelete This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param displayName This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitPropertySetUpdatesAsync(Windows.Foundation.Collections.IPropertySet,Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitPropertySetUpdatesAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param blobsToWrite +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param blobsToDelete +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param displayName +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainer_submitupdatesasync_1002100950.md b/windows.gaming.xboxlive.storage/gamesavecontainer_submitupdatesasync_1002100950.md index c07c532638..d948ab9aa0 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainer_submitupdatesasync_1002100950.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainer_submitupdatesasync_1002100950.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitUpdatesAsync(Windows.Foundation.Collections.IMapView{System.String,Windows.Storage.Streams.IBuffer},Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitUpdatesAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param blobsToWrite This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param blobsToDelete This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param displayName This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitUpdatesAsync(Windows.Foundation.Collections.IMapView{System.String,Windows.Storage.Streams.IBuffer},Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainer.SubmitUpdatesAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param blobsToWrite +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param blobsToDelete +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param displayName +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfo.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfo.md index ad836edada..47260b736a 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfo.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_displayname.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_displayname.md index 142d9860d4..9a2e4600bf 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_displayname.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.DisplayName --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.DisplayName ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.DisplayName + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_lastmodifiedtime.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_lastmodifiedtime.md index 6256d7c87b..2af8371abd 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_lastmodifiedtime.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_lastmodifiedtime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.LastModifiedTime --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.LastModifiedTime ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.LastModifiedTime +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.LastModifiedTime + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_name.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_name.md index 3285377e16..2e70ca459b 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_name.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.Name --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.Name ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.Name +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.Name + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_needssync.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_needssync.md index 8ead666d5e..7b5ea200aa 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_needssync.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_needssync.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.NeedsSync --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.NeedsSync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.NeedsSync +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.NeedsSync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_totalsize.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_totalsize.md index f9e95193e4..2377fce2d2 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfo_totalsize.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfo_totalsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.TotalSize --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.TotalSize ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.TotalSize +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfo.TotalSize + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult.md index ffbc1544d6..2f0a1a7b46 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_status.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_status.md index 06c1c13491..f6efae95ef 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_status.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Status --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Status ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Status +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Status + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_value.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_value.md index cbf461c4df..5bf48ddb36 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_value.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfogetresult_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Value --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Value ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Value +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoGetResult.Value + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery.md index 5a60890097..66391f4b8d 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1018947810.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1018947810.md index ba53958fd6..8aecb73fa2 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1018947810.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1018947810.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync(System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param startIndex This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param maxNumberOfItems This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [GetContainerInfoAsync](gamesavecontainerinfoquery_getcontainerinfoasync_1195934741.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync(System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param startIndex +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param maxNumberOfItems +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[GetContainerInfoAsync](gamesavecontainerinfoquery_getcontainerinfoasync_1195934741.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1195934741.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1195934741.md index 2a8a1e49b2..d0c693d16b 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1195934741.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getcontainerinfoasync_1195934741.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [GetContainerInfoAsync(UInt32, UInt32)](gamesavecontainerinfoquery_getcontainerinfoasync_1018947810.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetContainerInfoAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[GetContainerInfoAsync(UInt32, UInt32)](gamesavecontainerinfoquery_getcontainerinfoasync_1018947810.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getitemcountasync_1115995255.md b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getitemcountasync_1115995255.md index 9cc28c68cc..8e2919a94b 100644 --- a/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getitemcountasync_1115995255.md +++ b/windows.gaming.xboxlive.storage/gamesavecontainerinfoquery_getitemcountasync_1115995255.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetItemCountAsync --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetItemCountAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetItemCountAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveContainerInfoQuery.GetItemCountAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveoperationresult.md b/windows.gaming.xboxlive.storage/gamesaveoperationresult.md index 01ba21d9f2..3bde265ccf 100644 --- a/windows.gaming.xboxlive.storage/gamesaveoperationresult.md +++ b/windows.gaming.xboxlive.storage/gamesaveoperationresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveOperationResult --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveOperationResult ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveOperationResult +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveOperationResult + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveoperationresult_status.md b/windows.gaming.xboxlive.storage/gamesaveoperationresult_status.md index f3e8cb4867..8099cceb54 100644 --- a/windows.gaming.xboxlive.storage/gamesaveoperationresult_status.md +++ b/windows.gaming.xboxlive.storage/gamesaveoperationresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveOperationResult.Status --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveOperationResult.Status ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveOperationResult.Status +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveOperationResult.Status + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider.md b/windows.gaming.xboxlive.storage/gamesaveprovider.md index 4bd0f2d7d9..9df3178856 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveProvider --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveProvider +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_containerschangedsincelastsync.md b/windows.gaming.xboxlive.storage/gamesaveprovider_containerschangedsincelastsync.md index 3eb3d61951..76e66149fc 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_containerschangedsincelastsync.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_containerschangedsincelastsync.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProvider.ContainersChangedSinceLastSync --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.ContainersChangedSinceLastSync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProvider.ContainersChangedSinceLastSync +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.ContainersChangedSinceLastSync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainer_1539970701.md b/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainer_1539970701.md index ff90f569ec..2ff59e8dfb 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainer_1539970701.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainer_1539970701.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainer(System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainer ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param name This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainer(System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainer + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param name +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_1087708274.md b/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_1087708274.md index a178e61da3..d16d2d6ec0 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_1087708274.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_1087708274.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery(System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param containerNamePrefix This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [CreateContainerInfoQuery](gamesaveprovider_createcontainerinfoquery_424994130.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery(System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param containerNamePrefix +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[CreateContainerInfoQuery](gamesaveprovider_createcontainerinfoquery_424994130.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_424994130.md b/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_424994130.md index 5025d7bf49..3f14ec0d69 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_424994130.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_createcontainerinfoquery_424994130.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also [CreateContainerInfoQuery(String)](gamesaveprovider_createcontainerinfoquery_1087708274.md) \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.CreateContainerInfoQuery + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also +[CreateContainerInfoQuery(String)](gamesaveprovider_createcontainerinfoquery_1087708274.md) \ No newline at end of file diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_deletecontainerasync_1360317562.md b/windows.gaming.xboxlive.storage/gamesaveprovider_deletecontainerasync_1360317562.md index 4b24406ee7..36932d382c 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_deletecontainerasync_1360317562.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_deletecontainerasync_1360317562.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.DeleteContainerAsync(System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.DeleteContainerAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param name This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.DeleteContainerAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.DeleteContainerAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param name +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_getforuserasync_1027182495.md b/windows.gaming.xboxlive.storage/gamesaveprovider_getforuserasync_1027182495.md index 794d76d359..9d4b504535 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_getforuserasync_1027182495.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_getforuserasync_1027182495.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetForUserAsync(Windows.System.User,System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetForUserAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param user This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param serviceConfigId This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetForUserAsync(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetForUserAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param user +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param serviceConfigId +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_getremainingbytesinquotaasync_1601893071.md b/windows.gaming.xboxlive.storage/gamesaveprovider_getremainingbytesinquotaasync_1601893071.md index dd7fabd08d..ca05f58707 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_getremainingbytesinquotaasync_1601893071.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_getremainingbytesinquotaasync_1601893071.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetRemainingBytesInQuotaAsync --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetRemainingBytesInQuotaAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetRemainingBytesInQuotaAsync +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetRemainingBytesInQuotaAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_getsyncondemandforuserasync_1696921570.md b/windows.gaming.xboxlive.storage/gamesaveprovider_getsyncondemandforuserasync_1696921570.md index 0d3a5fd6a5..21572db71d 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_getsyncondemandforuserasync_1696921570.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_getsyncondemandforuserasync_1696921570.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetSyncOnDemandForUserAsync(Windows.System.User,System.String) --api-type: winrt method ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetSyncOnDemandForUserAsync ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param user This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ### -param serviceConfigId This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetSyncOnDemandForUserAsync(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.GetSyncOnDemandForUserAsync + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param user +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +### -param serviceConfigId +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovider_user.md b/windows.gaming.xboxlive.storage/gamesaveprovider_user.md index bd73d0d9ba..ad93890909 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovider_user.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovider_user.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProvider.User --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveProvider.User ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProvider.User +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProvider.User + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovidergetresult.md b/windows.gaming.xboxlive.storage/gamesaveprovidergetresult.md index 41fc12f0a5..d5a1ba5814 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovidergetresult.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovidergetresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult --api-type: winrt class ---- # Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult +-api-type: winrt class +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_status.md b/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_status.md index a7358d7339..7ccb632a7f 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_status.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Status --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Status ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Status +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Status + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_value.md b/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_value.md index e213ba6210..40e41b53ab 100644 --- a/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_value.md +++ b/windows.gaming.xboxlive.storage/gamesaveprovidergetresult_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Value --api-type: winrt property ---- # Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Value ## -description This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Value +-api-type: winrt property +--- + + + +# Windows.Gaming.XboxLive.Storage.GameSaveProviderGetResult.Value + +## -description +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergrouping_first.md b/windows.globalization.collation/charactergrouping_first.md index 6bc3e3caaa..aed249a380 100644 --- a/windows.globalization.collation/charactergrouping_first.md +++ b/windows.globalization.collation/charactergrouping_first.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Collation.CharacterGrouping.First --api-type: winrt property ---- # Windows.Globalization.Collation.CharacterGrouping.First ## -description Gets the first item that appears in the grouping under this index. ## -property-value The string that defines the start of the group that has the associated [label](charactergrouping_label.md). The start of the next group implicitly determines its end. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Collation.CharacterGrouping.First +-api-type: winrt property +--- + + + +# Windows.Globalization.Collation.CharacterGrouping.First + +## -description +Gets the first item that appears in the grouping under this index. + +## -property-value +The string that defines the start of the group that has the associated [label](charactergrouping_label.md). The start of the next group implicitly determines its end. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergrouping_label.md b/windows.globalization.collation/charactergrouping_label.md index 6d61a7f571..aedfa75a9e 100644 --- a/windows.globalization.collation/charactergrouping_label.md +++ b/windows.globalization.collation/charactergrouping_label.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Collation.CharacterGrouping.Label --api-type: winrt property ---- # Windows.Globalization.Collation.CharacterGrouping.Label ## -description Gets the label that is associated with this index. ## -property-value The string to use as the label for all strings of this group. This string may be empty, in which case the label is considered to be "other". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Collation.CharacterGrouping.Label +-api-type: winrt property +--- + + + +# Windows.Globalization.Collation.CharacterGrouping.Label + +## -description +Gets the label that is associated with this index. + +## -property-value +The string to use as the label for all strings of this group. This string may be empty, in which case the label is considered to be "other". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_charactergroupings_1221375020.md b/windows.globalization.collation/charactergroupings_charactergroupings_1221375020.md index bea01f1bbc..a58790aebb 100644 --- a/windows.globalization.collation/charactergroupings_charactergroupings_1221375020.md +++ b/windows.globalization.collation/charactergroupings_charactergroupings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Globalization.Collation.CharacterGroupings.#ctor --api-type: winrt method ---- # Windows.Globalization.Collation.CharacterGroupings.CharacterGroupings ## -description Create a [CharacterGroupings](charactergroupings.md) object for the default collation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Collation.CharacterGroupings.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.CharacterGroupings + +## -description +Create a [CharacterGroupings](charactergroupings.md) object for the default collation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_first_1920739956.md b/windows.globalization.collation/charactergroupings_first_1920739956.md index 7ff84d6fc0..5e6c6edab2 100644 --- a/windows.globalization.collation/charactergroupings_first_1920739956.md +++ b/windows.globalization.collation/charactergroupings_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Collation.CharacterGroupings.First --api-type: winrt method ---- # Windows.Globalization.Collation.CharacterGroupings.First ## -description Returns an iterator to enumerate the items in the set of character groups. ## -returns The iterator. The current position of the iterator is index 0, or the end of the set of character groups if the set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Collation.CharacterGroupings.First +-api-type: winrt method +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.First + +## -description +Returns an iterator to enumerate the items in the set of character groups. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the set of character groups if the set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_getat_496709656.md b/windows.globalization.collation/charactergroupings_getat_496709656.md index c74dba2535..2d7c6fcfca 100644 --- a/windows.globalization.collation/charactergroupings_getat_496709656.md +++ b/windows.globalization.collation/charactergroupings_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Collation.CharacterGroupings.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Globalization.Collation.CharacterGroupings.GetAt ## -description Returns the [CharacterGrouping](charactergrouping.md) at the specified index in the set of character groups. ## -parameters ### -param index The zero-based index of the [CharacterGrouping](charactergrouping.md) in the set to return. ## -returns The [CharacterGrouping](charactergrouping.md) at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Collation.CharacterGroupings.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.GetAt + +## -description +Returns the [CharacterGrouping](charactergrouping.md) at the specified index in the set of character groups. + +## -parameters +### -param index +The zero-based index of the [CharacterGrouping](charactergrouping.md) in the set to return. + +## -returns +The [CharacterGrouping](charactergrouping.md) at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_getmany_607503338.md b/windows.globalization.collation/charactergroupings_getmany_607503338.md index 2b8733ab6e..7ed89220ab 100644 --- a/windows.globalization.collation/charactergroupings_getmany_607503338.md +++ b/windows.globalization.collation/charactergroupings_getmany_607503338.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Globalization.Collation.CharacterGroupings.GetMany(System.UInt32,Windows.Globalization.Collation.CharacterGrouping[]) --api-type: winrt method ---- # Windows.Globalization.Collation.CharacterGroupings.GetMany ## -description Returns the [CharacterGrouping](charactergrouping.md) objects that start at the specified index in the set of character groups. ## -parameters ### -param startIndex The zero-based index of the start of the [CharacterGrouping](charactergrouping.md) objects in the set to return. ### -param items The [CharacterGrouping](charactergrouping.md) objects in the set that start at *startIndex*. ## -returns The number of objects returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Collation.CharacterGroupings.GetMany(System.UInt32,Windows.Globalization.Collation.CharacterGrouping[]) +-api-type: winrt method +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.GetMany + +## -description +Returns the [CharacterGrouping](charactergrouping.md) objects that start at the specified index in the set of character groups. + +## -parameters +### -param startIndex +The zero-based index of the start of the [CharacterGrouping](charactergrouping.md) objects in the set to return. + +### -param items +The [CharacterGrouping](charactergrouping.md) objects in the set that start at *startIndex*. + +## -returns +The number of objects returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_indexof_1360821131.md b/windows.globalization.collation/charactergroupings_indexof_1360821131.md index cb4bd02e6d..37a1b4d8b1 100644 --- a/windows.globalization.collation/charactergroupings_indexof_1360821131.md +++ b/windows.globalization.collation/charactergroupings_indexof_1360821131.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Globalization.Collation.CharacterGroupings.IndexOf(Windows.Globalization.Collation.CharacterGrouping,System.UInt32@) --api-type: winrt method ---- # Windows.Globalization.Collation.CharacterGroupings.IndexOf ## -description Returns the index of a specified [CharacterGrouping](charactergrouping.md) object in the set of character groups. ## -parameters ### -param value The [CharacterGrouping](charactergrouping.md) object to find in the set. ### -param index The zero-based index of the [CharacterGrouping](charactergrouping.md) object, if found. The method returns zero if the object is not found. ## -returns True if the object is found, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Collation.CharacterGroupings.IndexOf(Windows.Globalization.Collation.CharacterGrouping,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.IndexOf + +## -description +Returns the index of a specified [CharacterGrouping](charactergrouping.md) object in the set of character groups. + +## -parameters +### -param value +The [CharacterGrouping](charactergrouping.md) object to find in the set. + +### -param index +The zero-based index of the [CharacterGrouping](charactergrouping.md) object, if found. The method returns zero if the object is not found. + +## -returns +True if the object is found, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_lookup_711408188.md b/windows.globalization.collation/charactergroupings_lookup_711408188.md index fc4e4d01c7..8db6cb84c2 100644 --- a/windows.globalization.collation/charactergroupings_lookup_711408188.md +++ b/windows.globalization.collation/charactergroupings_lookup_711408188.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Collation.CharacterGroupings.Lookup(System.String) --api-type: winrt method ---- # Windows.Globalization.Collation.CharacterGroupings.Lookup ## -description Gets the label under which the provided text falls. ## -parameters ### -param text The string for which to get the label. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Collation.CharacterGroupings.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.Lookup + +## -description +Gets the label under which the provided text falls. + +## -parameters +### -param text +The string for which to get the label. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.collation/charactergroupings_size.md b/windows.globalization.collation/charactergroupings_size.md index 131022827e..92ea619656 100644 --- a/windows.globalization.collation/charactergroupings_size.md +++ b/windows.globalization.collation/charactergroupings_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Collation.CharacterGroupings.Size --api-type: winrt property ---- # Windows.Globalization.Collation.CharacterGroupings.Size ## -description Gets the number of [CharacterGrouping](charactergrouping.md) objects in the set of character groups. ## -property-value The number of objects in the set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Collation.CharacterGroupings.Size +-api-type: winrt property +--- + + + +# Windows.Globalization.Collation.CharacterGroupings.Size + +## -description +Gets the number of [CharacterGrouping](charactergrouping.md) objects in the set of character groups. + +## -property-value +The number of objects in the set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_calendar.md b/windows.globalization.datetimeformatting/datetimeformatter_calendar.md index c0311f02d5..a654a678ec 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_calendar.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_calendar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Calendar --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Calendar ## -description Gets the calendar that is used when formatting dates. ## -property-value The calendar that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Calendar +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Calendar + +## -description +Gets the calendar that is used when formatting dates. + +## -property-value +The calendar that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_clock.md b/windows.globalization.datetimeformatting/datetimeformatter_clock.md index 9f0bd9ff20..d2a74a14a5 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_clock.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_clock.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Clock --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Clock ## -description Gets the clock that is used when formatting times. ## -property-value The clock that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Clock +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Clock + +## -description +Gets the clock that is used when formatting times. + +## -property-value +The clock that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1042679024.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1042679024.md index 54a6e0a0b5..256388e809 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1042679024.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1042679024.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String,System.String,System.String) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized by a format template string, language list, geographic region, calendar, and clock. ## -parameters ### -param formatTemplate A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates and format patterns. ### -param languages The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks. ### -param geographicRegion The identifier for the geographic region. This identifier is used for resolving the template to a pattern. ### -param calendar The calendar identifier to use. ### -param clock The clock identifier to use. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. ## -examples ## -see-also [DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized by a format template string, language list, geographic region, calendar, and clock. + +## -parameters +### -param formatTemplate +A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates and format patterns. + +### -param languages +The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks. + +### -param geographicRegion +The identifier for the geographic region. This identifier is used for resolving the template to a pattern. + +### -param calendar +The calendar identifier to use. + +### -param clock +The clock identifier to use. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. + +## -examples + +## -see-also +[DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1763707544.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1763707544.md index 5283223b2e..fd15b8e7bb 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1763707544.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_1763707544.md @@ -1,3 +1,48 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.YearFormat,Windows.Globalization.DateTimeFormatting.MonthFormat,Windows.Globalization.DateTimeFormatting.DayFormat,Windows.Globalization.DateTimeFormatting.DayOfWeekFormat,Windows.Globalization.DateTimeFormatting.HourFormat,Windows.Globalization.DateTimeFormatting.MinuteFormat,Windows.Globalization.DateTimeFormatting.SecondFormat,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized with year, month, day, day of week, hour, minute, and second formats, and a language list. ## -parameters ### -param yearFormat The year format to include in the template. ### -param monthFormat The month format to include in the template. ### -param dayFormat The day format to include in the template. ### -param dayOfWeekFormat The day of week format to include in the template. ### -param hourFormat The hour format to include in the template. ### -param minuteFormat The minute format to include in the template. ### -param secondFormat The second format to include in the template. ### -param languages The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern and for formatting. See Remarks. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. ## -examples ## -see-also [DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable(String))](datetimeformatter_datetimeformatter_204585840.md), [DateTimeFormatter(String, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.YearFormat,Windows.Globalization.DateTimeFormatting.MonthFormat,Windows.Globalization.DateTimeFormatting.DayFormat,Windows.Globalization.DateTimeFormatting.DayOfWeekFormat,Windows.Globalization.DateTimeFormatting.HourFormat,Windows.Globalization.DateTimeFormatting.MinuteFormat,Windows.Globalization.DateTimeFormatting.SecondFormat,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized with year, month, day, day of week, hour, minute, and second formats, and a language list. + +## -parameters +### -param yearFormat +The year format to include in the template. + +### -param monthFormat +The month format to include in the template. + +### -param dayFormat +The day format to include in the template. + +### -param dayOfWeekFormat +The day of week format to include in the template. + +### -param hourFormat +The hour format to include in the template. + +### -param minuteFormat +The minute format to include in the template. + +### -param secondFormat +The second format to include in the template. + +### -param languages +The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern and for formatting. See Remarks. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. + +## -examples + +## -see-also +[DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable(String))](datetimeformatter_datetimeformatter_204585840.md), [DateTimeFormatter(String, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_204585840.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_204585840.md index 5b4966fd91..261a076e43 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_204585840.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_204585840.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized by a format template string and language list. ## -parameters ### -param formatTemplate A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates and format patterns. ### -param languages The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern and for formatting. See Remarks. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. ## -examples ## -see-also [DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable(String))](datetimeformatter_datetimeformatter_1763707544.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized by a format template string and language list. + +## -parameters +### -param formatTemplate +A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates and format patterns. + +### -param languages +The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern and for formatting. See Remarks. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. + +## -examples + +## -see-also +[DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable(String))](datetimeformatter_datetimeformatter_1763707544.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable(String), String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_242098968.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_242098968.md index 69c5c7e87f..0d455b1cb5 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_242098968.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_242098968.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.YearFormat,Windows.Globalization.DateTimeFormatting.MonthFormat,Windows.Globalization.DateTimeFormatting.DayFormat,Windows.Globalization.DateTimeFormatting.DayOfWeekFormat) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized with year, month, day, and day of week formats. ## -parameters ### -param yearFormat The desired year format to include in the template. ### -param monthFormat The desired month format to include in the template. ### -param dayFormat The desired day format to include in the template. ### -param dayOfWeekFormat The desired day of week format to include in the template. ## -remarks ## -examples ## -see-also [DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.YearFormat,Windows.Globalization.DateTimeFormatting.MonthFormat,Windows.Globalization.DateTimeFormatting.DayFormat,Windows.Globalization.DateTimeFormatting.DayOfWeekFormat) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized with year, month, day, and day of week formats. + +## -parameters +### -param yearFormat +The desired year format to include in the template. + +### -param monthFormat +The desired month format to include in the template. + +### -param dayFormat +The desired day format to include in the template. + +### -param dayOfWeekFormat +The desired day of week format to include in the template. + +## -remarks + +## -examples + +## -see-also +[DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_290278668.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_290278668.md index 853956d379..00cf5fe315 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_290278668.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(System.String) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized by a format template string. ## -parameters ### -param formatTemplate A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates and format patterns. ## -remarks ## -examples ## -see-also [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized by a format template string. + +## -parameters +### -param formatTemplate +A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates and format patterns. + +## -remarks + +## -examples + +## -see-also +[DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md), [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_321918312.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_321918312.md index f26b9f95a6..297732c8fd 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_321918312.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_321918312.md @@ -1,3 +1,57 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.YearFormat,Windows.Globalization.DateTimeFormatting.MonthFormat,Windows.Globalization.DateTimeFormatting.DayFormat,Windows.Globalization.DateTimeFormatting.DayOfWeekFormat,Windows.Globalization.DateTimeFormatting.HourFormat,Windows.Globalization.DateTimeFormatting.MinuteFormat,Windows.Globalization.DateTimeFormatting.SecondFormat,Windows.Foundation.Collections.IIterable{System.String},System.String,System.String,System.String) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object with all formats and identifiers specified. ## -parameters ### -param yearFormat The desired year format to include in the template. ### -param monthFormat The desired month format to include in the template. ### -param dayFormat The desired day format to include in the template. ### -param dayOfWeekFormat The desired day of week format to include in the template. ### -param hourFormat The desired hour format to include in the template. ### -param minuteFormat The desired minute format to include in the template. ### -param secondFormat The desired second format to include in the template. ### -param languages The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks. ### -param geographicRegion The identifier for the geographic region. This identifier is used for resolving the template to a pattern. ### -param calendar The calendar identifier to use. ### -param clock The clock identifier to use. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. ## -examples ## -see-also [DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.YearFormat,Windows.Globalization.DateTimeFormatting.MonthFormat,Windows.Globalization.DateTimeFormatting.DayFormat,Windows.Globalization.DateTimeFormatting.DayOfWeekFormat,Windows.Globalization.DateTimeFormatting.HourFormat,Windows.Globalization.DateTimeFormatting.MinuteFormat,Windows.Globalization.DateTimeFormatting.SecondFormat,Windows.Foundation.Collections.IIterable{System.String},System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object with all formats and identifiers specified. + +## -parameters +### -param yearFormat +The desired year format to include in the template. + +### -param monthFormat +The desired month format to include in the template. + +### -param dayFormat +The desired day format to include in the template. + +### -param dayOfWeekFormat +The desired day of week format to include in the template. + +### -param hourFormat +The desired hour format to include in the template. + +### -param minuteFormat +The desired minute format to include in the template. + +### -param secondFormat +The desired second format to include in the template. + +### -param languages +The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks. + +### -param geographicRegion +The identifier for the geographic region. This identifier is used for resolving the template to a pattern. + +### -param calendar +The calendar identifier to use. + +### -param clock +The clock identifier to use. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "ca-" extension can affect the calendar used by [DateTimeFormatter](datetimeformatter.md) objects. + +## -examples + +## -see-also +[DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)](datetimeformatter_datetimeformatter_884240580.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_884240580.md b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_884240580.md index e02dd265c7..e954e5b75c 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_884240580.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_datetimeformatter_884240580.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.HourFormat,Windows.Globalization.DateTimeFormatting.MinuteFormat,Windows.Globalization.DateTimeFormatting.SecondFormat) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter ## -description Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized with hour, minute, and second formats. ## -parameters ### -param hourFormat The desired hour format to include in the template. ### -param minuteFormat The desired minute format to include in the template. ### -param secondFormat The desired second format to include in the template. ## -remarks ## -examples ## -see-also [DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.#ctor(Windows.Globalization.DateTimeFormatting.HourFormat,Windows.Globalization.DateTimeFormatting.MinuteFormat,Windows.Globalization.DateTimeFormatting.SecondFormat) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.DateTimeFormatter + +## -description +Creates a [DateTimeFormatter](datetimeformatter.md) object that is initialized with hour, minute, and second formats. + +## -parameters +### -param hourFormat +The desired hour format to include in the template. + +### -param minuteFormat +The desired minute format to include in the template. + +### -param secondFormat +The desired second format to include in the template. + +## -remarks + +## -examples + +## -see-also +[DateTimeFormatter(String)](datetimeformatter_datetimeformatter_290278668.md), [DateTimeFormatter(String, IIterable, String, String, String)](datetimeformatter_datetimeformatter_1042679024.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)](datetimeformatter_datetimeformatter_242098968.md), [DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)](datetimeformatter_datetimeformatter_321918312.md) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_format_1437572336.md b/windows.globalization.datetimeformatting/datetimeformatter_format_1437572336.md index 238ed8d744..d4f97c6ae4 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_format_1437572336.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_format_1437572336.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format ## -description Returns a string representation of the provided date and time. ## -parameters ### -param value The date and time to be formatted. ## -returns A string that represents the date and time. ## -remarks ## -examples ## -see-also [Format(DateTime, String)](datetimeformatter_format_424907088.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format + +## -description +Returns a string representation of the provided date and time. + +## -parameters +### -param value +The date and time to be formatted. + +## -returns +A string that represents the date and time. + +## -remarks + +## -examples + +## -see-also +[Format(DateTime, String)](datetimeformatter_format_424907088.md) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_format_424907088.md b/windows.globalization.datetimeformatting/datetimeformatter_format_424907088.md index 2d93467256..738f241147 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_format_424907088.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_format_424907088.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format(Windows.Foundation.DateTime,System.String) --api-type: winrt method ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format ## -description Returns a string that represents the given date and time in the given time zone, conforming to the template the formatter is currently using. ## -parameters ### -param datetime The date and time to be formatted. ### -param timeZoneId An identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) which identifies the time zone that should be used (for example, "Americas/Los_Angeles" for Pacific Time). ## -returns A string that represents the date, time, and time zone. ## -remarks ## -examples ## -see-also [Format(DateTime)](datetimeformatter_format_1437572336.md), [Date and time formatting sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624044) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format(Windows.Foundation.DateTime,System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Format + +## -description +Returns a string that represents the given date and time in the given time zone, conforming to the template the formatter is currently using. + +## -parameters +### -param datetime +The date and time to be formatted. + +### -param timeZoneId +An identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) which identifies the time zone that should be used (for example, "Americas/Los_Angeles" for Pacific Time). + +## -returns +A string that represents the date, time, and time zone. + +## -remarks + +## -examples + +## -see-also +[Format(DateTime)](datetimeformatter_format_1437572336.md), [Date and time formatting sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624044) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_geographicregion.md b/windows.globalization.datetimeformatting/datetimeformatter_geographicregion.md index 8d9e236bf0..72eca02a22 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_geographicregion.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.GeographicRegion --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.GeographicRegion ## -description Gets or sets the region that is used when formatting dates and times. ## -property-value The region that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.GeographicRegion + +## -description +Gets or sets the region that is used when formatting dates and times. + +## -property-value +The region that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includeday.md b/windows.globalization.datetimeformatting/datetimeformatter_includeday.md index 96447cdd7a..774636e9ea 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includeday.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includeday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDay --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDay ## -description Gets the [DayFormat](dayformat.md) in the template. ## -property-value Specifies whether the day is included. If it is, this property specifies the format for the day in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDay +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDay + +## -description +Gets the [DayFormat](dayformat.md) in the template. + +## -property-value +Specifies whether the day is included. If it is, this property specifies the format for the day in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includedayofweek.md b/windows.globalization.datetimeformatting/datetimeformatter_includedayofweek.md index eccb83846f..22b2919ac6 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includedayofweek.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includedayofweek.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDayOfWeek --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDayOfWeek ## -description Gets the [DayOfWeekFormat](dayofweekformat.md) in the template. ## -property-value Specifies whether the day of week is included. If it is, this property specifies the format for the day of week in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDayOfWeek +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeDayOfWeek + +## -description +Gets the [DayOfWeekFormat](dayofweekformat.md) in the template. + +## -property-value +Specifies whether the day of week is included. If it is, this property specifies the format for the day of week in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includehour.md b/windows.globalization.datetimeformatting/datetimeformatter_includehour.md index bb876ca53e..35c4ff1b32 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includehour.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includehour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeHour --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeHour ## -description Gets the [HourFormat](hourformat.md) in the template. ## -property-value Specifies whether the hour is included. If it is, this property specifies the format for the hour in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeHour +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeHour + +## -description +Gets the [HourFormat](hourformat.md) in the template. + +## -property-value +Specifies whether the hour is included. If it is, this property specifies the format for the hour in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includeminute.md b/windows.globalization.datetimeformatting/datetimeformatter_includeminute.md index cdbb7a0991..fce07b4db0 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includeminute.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includeminute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMinute --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMinute ## -description Gets the [MinuteFormat](minuteformat.md) in the template. ## -property-value Specifies whether the minute is included. If it is, this property specifies the format for the minute in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMinute +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMinute + +## -description +Gets the [MinuteFormat](minuteformat.md) in the template. + +## -property-value +Specifies whether the minute is included. If it is, this property specifies the format for the minute in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includemonth.md b/windows.globalization.datetimeformatting/datetimeformatter_includemonth.md index 7cfc6d45e4..322c202d1f 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includemonth.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includemonth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMonth --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMonth ## -description Gets the [MonthFormat](monthformat.md) in the template. ## -property-value Specifies whether the month is included. If it is, this property specifies the format for the month in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMonth +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeMonth + +## -description +Gets the [MonthFormat](monthformat.md) in the template. + +## -property-value +Specifies whether the month is included. If it is, this property specifies the format for the month in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includesecond.md b/windows.globalization.datetimeformatting/datetimeformatter_includesecond.md index 859c09e550..8c1a96869d 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includesecond.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includesecond.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeSecond --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeSecond ## -description Gets the [SecondFormat](secondformat.md) in the template. ## -property-value Specifies whether the second is included. If it is, this property specifies the format for the second in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeSecond +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeSecond + +## -description +Gets the [SecondFormat](secondformat.md) in the template. + +## -property-value +Specifies whether the second is included. If it is, this property specifies the format for the second in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_includeyear.md b/windows.globalization.datetimeformatting/datetimeformatter_includeyear.md index dc491815a5..c18cfb5162 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_includeyear.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_includeyear.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeYear --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeYear ## -description Gets the [YearFormat](yearformat.md) in the template. ## -property-value Specifies whether the year is included. If it is, this format specifies the format for the year in the template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeYear +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.IncludeYear + +## -description +Gets the [YearFormat](yearformat.md) in the template. + +## -property-value +Specifies whether the year is included. If it is, this format specifies the format for the year in the template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_languages.md b/windows.globalization.datetimeformatting/datetimeformatter_languages.md index c689ad2abf..96c5e42bcf 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_languages.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_languages.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Languages --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Languages ## -description Gets the priority list of language identifiers that is used when formatting dates and times. ## -property-value The list of languages that is used. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DateTimeFormatter(String, IIterable(String))](datetimeformatter_datetimeformatter_204585840.md) constructor. ## -remarks Initialize this class with a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. For example, to work with the best current user-preferred language, pass in the top value from [Windows.System.UserProfile.GlobalizationPreferences](../windows.system.userprofile/globalizationpreferences.md). > [!NOTE] > If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting dates and times. + +## -property-value +The list of languages that is used. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DateTimeFormatter(String, IIterable(String))](datetimeformatter_datetimeformatter_204585840.md) constructor. + +## -remarks +Initialize this class with a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. For example, to work with the best current user-preferred language, pass in the top value from [Windows.System.UserProfile.GlobalizationPreferences](../windows.system.userprofile/globalizationpreferences.md). + +> [!NOTE] +> If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_longdate.md b/windows.globalization.datetimeformatting/datetimeformatter_longdate.md index 71f6cd1ed1..1a28cda448 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_longdate.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_longdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongDate --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongDate ## -description Gets the [DateTimeFormatter](datetimeformatter.md) object that formats dates according to the user's choice of long date pattern. ## -property-value A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "longdate" template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongDate +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongDate + +## -description +Gets the [DateTimeFormatter](datetimeformatter.md) object that formats dates according to the user's choice of long date pattern. + +## -property-value +A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "longdate" template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_longtime.md b/windows.globalization.datetimeformatting/datetimeformatter_longtime.md index 55ea57b8d9..8354d61968 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_longtime.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_longtime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongTime --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongTime ## -description Gets the [DateTimeFormatter](datetimeformatter.md) object that formats times according to the user's choice of long time pattern. ## -property-value A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "longtime" template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongTime +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.LongTime + +## -description +Gets the [DateTimeFormatter](datetimeformatter.md) object that formats times according to the user's choice of long time pattern. + +## -property-value +A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "longtime" template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_numeralsystem.md b/windows.globalization.datetimeformatting/datetimeformatter_numeralsystem.md index 58c9f1606e..dfab8c103d 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_numeralsystem.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_numeralsystem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.NumeralSystem ## -description Gets or sets the numbering system that is used to format dates and times. ## -property-value A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥ ٦٧٨٩). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.NumeralSystem + +## -description +Gets or sets the numbering system that is used to format dates and times. + +## -property-value +A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥ ٦٧٨٩). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_patterns.md b/windows.globalization.datetimeformatting/datetimeformatter_patterns.md index b86e97091c..ef7bf15486 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_patterns.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_patterns.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Patterns --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Patterns ## -description Gets the patterns corresponding to this template that are used when formatting dates and times. ## -property-value The pattern that provides the requested components in the template. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format patterns. ## -remarks ## -examples ## -see-also [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Patterns +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Patterns + +## -description +Gets the patterns corresponding to this template that are used when formatting dates and times. + +## -property-value +The pattern that provides the requested components in the template. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format patterns. + +## -remarks + +## -examples + +## -see-also +[Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618) \ No newline at end of file diff --git a/windows.globalization.datetimeformatting/datetimeformatter_resolvedgeographicregion.md b/windows.globalization.datetimeformatting/datetimeformatter_resolvedgeographicregion.md index d50f5cee33..9c4ae25371 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_resolvedgeographicregion.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_resolvedgeographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedGeographicRegion --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedGeographicRegion ## -description Gets the geographic region that was most recently used to format dates and times. ## -property-value The geographic region that was most recently used to format dates and times. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedGeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedGeographicRegion + +## -description +Gets the geographic region that was most recently used to format dates and times. + +## -property-value +The geographic region that was most recently used to format dates and times. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_resolvedlanguage.md b/windows.globalization.datetimeformatting/datetimeformatter_resolvedlanguage.md index 88139edcee..676db253e1 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_resolvedlanguage.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_resolvedlanguage.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedLanguage ## -description Gets the language that was most recently used to format dates and times. ## -property-value The language from the [priority list of language identifiers](datetimeformatter_languages.md) that was most recently used to format dates and times. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DateTimeFormatter(String, IIterable(String))](datetimeformatter_datetimeformatter_204585840.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ResolvedLanguage + +## -description +Gets the language that was most recently used to format dates and times. + +## -property-value +The language from the [priority list of language identifiers](datetimeformatter_languages.md) that was most recently used to format dates and times. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DateTimeFormatter(String, IIterable(String))](datetimeformatter_datetimeformatter_204585840.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_shortdate.md b/windows.globalization.datetimeformatting/datetimeformatter_shortdate.md index 140447c23f..996bd743d6 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_shortdate.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_shortdate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortDate --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortDate ## -description Gets the [DateTimeFormatter](datetimeformatter.md) object that formats dates according to the user's choice of short date pattern. ## -property-value A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "shortdate" template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortDate +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortDate + +## -description +Gets the [DateTimeFormatter](datetimeformatter.md) object that formats dates according to the user's choice of short date pattern. + +## -property-value +A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "shortdate" template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_shorttime.md b/windows.globalization.datetimeformatting/datetimeformatter_shorttime.md index 1987bb2c54..7e6a53f458 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_shorttime.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_shorttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortTime --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortTime ## -description Gets the [DateTimeFormatter](datetimeformatter.md) object that formats times according to the user's choice of short time pattern. ## -property-value A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "shorttime" template. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortTime +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.ShortTime + +## -description +Gets the [DateTimeFormatter](datetimeformatter.md) object that formats times according to the user's choice of short time pattern. + +## -property-value +A [DateTimeFormatter](datetimeformatter.md) object equivalent to one constructed with the "shorttime" template. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.datetimeformatting/datetimeformatter_template.md b/windows.globalization.datetimeformatting/datetimeformatter_template.md index 6cd78de04b..dea7c277af 100644 --- a/windows.globalization.datetimeformatting/datetimeformatter_template.md +++ b/windows.globalization.datetimeformatting/datetimeformatter_template.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Template --api-type: winrt property ---- # Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Template ## -description Gets a string representation of this format template. ## -property-value A string that represents this format template. If the [DateTimeFormatter](datetimeformatter.md) object was constructed with a format template or format enumerations, the string can be used to construct the same [DateTimeFormatter](datetimeformatter.md). If a pattern was used to construct the [DateTimeFormatter](datetimeformatter.md), this property returns the empty string. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates. ## -remarks ## -examples ## -see-also [Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Template +-api-type: winrt property +--- + + + +# Windows.Globalization.DateTimeFormatting.DateTimeFormatter.Template + +## -description +Gets a string representation of this format template. + +## -property-value +A string that represents this format template. If the [DateTimeFormatter](datetimeformatter.md) object was constructed with a format template or format enumerations, the string can be used to construct the same [DateTimeFormatter](datetimeformatter.md). If a pattern was used to construct the [DateTimeFormatter](datetimeformatter.md), this property returns the empty string. See the remarks for the [DateTimeFormatter](datetimeformatter.md) class for a list of valid format templates. + +## -remarks + +## -examples + +## -see-also +[Date and time formatting sample](http://go.microsoft.com/fwlink/p/?LinkId=231618) \ No newline at end of file diff --git a/windows.globalization.fonts/languagefont_fontfamily.md b/windows.globalization.fonts/languagefont_fontfamily.md index 2edb05d751..c408517d5d 100644 --- a/windows.globalization.fonts/languagefont_fontfamily.md +++ b/windows.globalization.fonts/languagefont_fontfamily.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFont.FontFamily --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFont.FontFamily ## -description Gets the family name of the font. ## -property-value The font family name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFont.FontFamily +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFont.FontFamily + +## -description +Gets the family name of the font. + +## -property-value +The font family name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefont_fontstretch.md b/windows.globalization.fonts/languagefont_fontstretch.md index 0ff80a3563..c67383f143 100644 --- a/windows.globalization.fonts/languagefont_fontstretch.md +++ b/windows.globalization.fonts/languagefont_fontstretch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFont.FontStretch --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFont.FontStretch ## -description Gets the [FontStretch](../windows.ui.text/fontstretch.md) property of the font. ## -property-value The [FontStretch](../windows.ui.text/fontstretch.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFont.FontStretch +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFont.FontStretch + +## -description +Gets the [FontStretch](../windows.ui.text/fontstretch.md) property of the font. + +## -property-value +The [FontStretch](../windows.ui.text/fontstretch.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefont_fontstyle.md b/windows.globalization.fonts/languagefont_fontstyle.md index 62591dc71b..8cb6858ad4 100644 --- a/windows.globalization.fonts/languagefont_fontstyle.md +++ b/windows.globalization.fonts/languagefont_fontstyle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFont.FontStyle --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFont.FontStyle ## -description Gets the [FontStyle](../windows.ui.text/fontstyle.md) property of the font. ## -property-value The [FontStyle](../windows.ui.text/fontstyle.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFont.FontStyle +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFont.FontStyle + +## -description +Gets the [FontStyle](../windows.ui.text/fontstyle.md) property of the font. + +## -property-value +The [FontStyle](../windows.ui.text/fontstyle.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefont_fontweight.md b/windows.globalization.fonts/languagefont_fontweight.md index 47f0eac6c7..c9823c2d62 100644 --- a/windows.globalization.fonts/languagefont_fontweight.md +++ b/windows.globalization.fonts/languagefont_fontweight.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFont.FontWeight --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFont.FontWeight ## -description Gets the weight of the font ([FontWeight](../windows.ui.text/fontweight.md)). The weight of the font is the lightness or heaviness of the strokes. ## -property-value The weight of the font. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFont.FontWeight +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFont.FontWeight + +## -description +Gets the weight of the font ([FontWeight](../windows.ui.text/fontweight.md)). + +The weight of the font is the lightness or heaviness of the strokes. + +## -property-value +The weight of the font. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefont_scalefactor.md b/windows.globalization.fonts/languagefont_scalefactor.md index fc793ef9ca..ff69fdeb56 100644 --- a/windows.globalization.fonts/languagefont_scalefactor.md +++ b/windows.globalization.fonts/languagefont_scalefactor.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFont.ScaleFactor --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFont.ScaleFactor ## -description Gets a recommended font size scaling factor for the font. The factor can be used to adjust relative sizes when two or more fonts are used for different runs within the same text element. ## -property-value The recommended font size scaling factor. ## -remarks The [ScaleFactor](languagefont_scalefactor.md) property provides a multiplier that can be applied to a nominal font size. Scale factors are intended to be used within a single [LanguageFontGroup](languagefontgroup.md) usage case so that text in different languages and scripts (that is, using different recommended fonts) will appear at complementary sizes. Scale factors within a single [LanguageFontGroup](languagefontgroup.md) usage case may be compared, but it is not appropriate to compare scale factors between different [LanguageFontGroup](languagefontgroup.md) usage cases. For example, suppose a user interface heading element is nominally set at 36 pt. Suppose further that instances of that element are displayed side-by-side in Korean and English. An application can construct [LanguageFontGroup](languagefontgroup.md) objects for Korean and for English, and then obtain the [UIHeadingFont](languagefontgroup_uiheadingfont.md) [LanguageFont ](languagefont.md) for each language. The [LanguageFont](languagefont.md) for English might have a scale factor of 1.0, while the [LanguageFont](languagefont.md) for Korean might have a scale factor of 0.96. If the English text is set at 36 pt and the Korean text is set at 34.56 pt (= 36 × 0.96), then the two text elements will appear better side-by-side than if both had been displayed at 36 pt. For most [LanguageFontGroup](languagefontgroup.md) usage cases, the scale factor is chosen to make the size and weight of the different fonts more compatible with one another. For the [FixedWidthTextFont](languagefontgroup_fixedwidthtextfont.md) usage case, however, the scale factor is chosen to make the widths of characters in different fixed-width fonts more compatible with one another. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFont.ScaleFactor +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFont.ScaleFactor + +## -description +Gets a recommended font size scaling factor for the font. + +The factor can be used to adjust relative sizes when two or more fonts are used for different runs within the same text element. + +## -property-value +The recommended font size scaling factor. + +## -remarks +The [ScaleFactor](languagefont_scalefactor.md) property provides a multiplier that can be applied to a nominal font size. Scale factors are intended to be used within a single [LanguageFontGroup](languagefontgroup.md) usage case so that text in different languages and scripts (that is, using different recommended fonts) will appear at complementary sizes. Scale factors within a single [LanguageFontGroup](languagefontgroup.md) usage case may be compared, but it is not appropriate to compare scale factors between different [LanguageFontGroup](languagefontgroup.md) usage cases. + +For example, suppose a user interface heading element is nominally set at 36 pt. Suppose further that instances of that element are displayed side-by-side in Korean and English. An application can construct [LanguageFontGroup](languagefontgroup.md) objects for Korean and for English, and then obtain the [UIHeadingFont](languagefontgroup_uiheadingfont.md) [LanguageFont ](languagefont.md) for each language. The [LanguageFont](languagefont.md) for English might have a scale factor of 1.0, while the [LanguageFont](languagefont.md) for Korean might have a scale factor of 0.96. If the English text is set at 36 pt and the Korean text is set at 34.56 pt (= 36 × 0.96), then the two text elements will appear better side-by-side than if both had been displayed at 36 pt. + +For most [LanguageFontGroup](languagefontgroup.md) usage cases, the scale factor is chosen to make the size and weight of the different fonts more compatible with one another. For the [FixedWidthTextFont](languagefontgroup_fixedwidthtextfont.md) usage case, however, the scale factor is chosen to make the widths of characters in different fixed-width fonts more compatible with one another. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_documentalternate1font.md b/windows.globalization.fonts/languagefontgroup_documentalternate1font.md index 7ceaa91660..24cd116662 100644 --- a/windows.globalization.fonts/languagefontgroup_documentalternate1font.md +++ b/windows.globalization.fonts/languagefontgroup_documentalternate1font.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate1Font --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate1Font ## -description Gets a font that is recommended as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). ## -property-value The recommended [LanguageFont](languagefont.md), or **NULL** if no font recommendation is available. ## -remarks The [DocumentAlternate1Font](languagefontgroup_documentalternate1font.md) property provides a font recommendation as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). These fonts could be used in body text or other text elements. The app scenario for which this is most likely to be useful is in populating a font-picker list in an authoring tool with a set of fonts designed for a particular language or script. The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. A [DocumentAlternate1Font](languagefontgroup_documentalternate1font.md) recommendation is available for certain languages and scripts only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate1Font +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate1Font + +## -description +Gets a font that is recommended as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). + +## -property-value +The recommended [LanguageFont](languagefont.md), or **NULL** if no font recommendation is available. + +## -remarks +The [DocumentAlternate1Font](languagefontgroup_documentalternate1font.md) property provides a font recommendation as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). These fonts could be used in body text or other text elements. The app scenario for which this is most likely to be useful is in populating a font-picker list in an authoring tool with a set of fonts designed for a particular language or script. + +The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. + +A [DocumentAlternate1Font](languagefontgroup_documentalternate1font.md) recommendation is available for certain languages and scripts only. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_documentalternate2font.md b/windows.globalization.fonts/languagefontgroup_documentalternate2font.md index 1485c79995..3f42f1222b 100644 --- a/windows.globalization.fonts/languagefontgroup_documentalternate2font.md +++ b/windows.globalization.fonts/languagefontgroup_documentalternate2font.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate2Font --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate2Font ## -description Gets a font that is recommended as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). ## -property-value The recommended [LanguageFont](languagefont.md), or **NULL** if no font recommendation is available. ## -remarks The [DocumentAlternate2Font](languagefontgroup_documentalternate2font.md) property provides a font recommendation as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). These fonts could be used in body text or other text elements. The app scenario for which this is most likely to be useful is in populating a font-picker list in an authoring tool with a set of fonts designed for a particular language or script. The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. A [DocumentAlternate2Font](languagefontgroup_documentalternate2font.md) recommendation is available for certain languages and scripts only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate2Font +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.DocumentAlternate2Font + +## -description +Gets a font that is recommended as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). + +## -property-value +The recommended [LanguageFont](languagefont.md), or **NULL** if no font recommendation is available. + +## -remarks +The [DocumentAlternate2Font](languagefontgroup_documentalternate2font.md) property provides a font recommendation as an additional option for use in documents beyond the recommendations provided by [DocumentHeadingFont](languagefontgroup_documentheadingfont.md), [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md). These fonts could be used in body text or other text elements. The app scenario for which this is most likely to be useful is in populating a font-picker list in an authoring tool with a set of fonts designed for a particular language or script. + +The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. + +A [DocumentAlternate2Font](languagefontgroup_documentalternate2font.md) recommendation is available for certain languages and scripts only. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_documentheadingfont.md b/windows.globalization.fonts/languagefontgroup_documentheadingfont.md index 617b6aabb4..f09c1b8edb 100644 --- a/windows.globalization.fonts/languagefontgroup_documentheadingfont.md +++ b/windows.globalization.fonts/languagefontgroup_documentheadingfont.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.DocumentHeadingFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.DocumentHeadingFont ## -description Gets a font that is recommended for use in document headings. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [DocumentHeadingFont](languagefontgroup_documentheadingfont.md) property provides a font recommendation for document text elements such as headings. These fonts could also be used in body text, but use for long runs of body text is not generally recommended. The recommended font may be a display face that is significantly different from the [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md) recommendations. The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. A [DocumentHeadingFont](languagefontgroup_documentheadingfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.DocumentHeadingFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.DocumentHeadingFont + +## -description +Gets a font that is recommended for use in document headings. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [DocumentHeadingFont](languagefontgroup_documentheadingfont.md) property provides a font recommendation for document text elements such as headings. These fonts could also be used in body text, but use for long runs of body text is not generally recommended. The recommended font may be a display face that is significantly different from the [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) and [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md) recommendations. + +The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. + +A [DocumentHeadingFont](languagefontgroup_documentheadingfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_fixedwidthtextfont.md b/windows.globalization.fonts/languagefontgroup_fixedwidthtextfont.md index 4e18b66e4b..a04edb56b0 100644 --- a/windows.globalization.fonts/languagefontgroup_fixedwidthtextfont.md +++ b/windows.globalization.fonts/languagefontgroup_fixedwidthtextfont.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.FixedWidthTextFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.FixedWidthTextFont ## -description Gets a font that is recommended for displaying fixed-width characters. ## -property-value The recommended [LanguageFont](languagefont.md), or **NULL** if no font recommendation is available. ## -remarks The [FixedWidthTextFont](languagefontgroup_fixedwidthtextfont.md) property provides a font recommendation for displaying fixed-width characters. The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. A [FixedWidthTextFont](languagefontgroup_fixedwidthtextfont.md) recommendation is available for certain languages and scripts only. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.FixedWidthTextFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.FixedWidthTextFont + +## -description +Gets a font that is recommended for displaying fixed-width characters. + +## -property-value +The recommended [LanguageFont](languagefont.md), or **NULL** if no font recommendation is available. + +## -remarks +The [FixedWidthTextFont](languagefontgroup_fixedwidthtextfont.md) property provides a font recommendation for displaying fixed-width characters. + +The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. + +A [FixedWidthTextFont](languagefontgroup_fixedwidthtextfont.md) recommendation is available for certain languages and scripts only. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_languagefontgroup_290278668.md b/windows.globalization.fonts/languagefontgroup_languagefontgroup_290278668.md index 7c7269da3e..87bae884f2 100644 --- a/windows.globalization.fonts/languagefontgroup_languagefontgroup_290278668.md +++ b/windows.globalization.fonts/languagefontgroup_languagefontgroup_290278668.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.Fonts.LanguageFontGroup.#ctor(System.String) --api-type: winrt method ---- # Windows.Globalization.Fonts.LanguageFontGroup.LanguageFontGroup ## -description Creates a [LanguageFontGroup](languagefontgroup.md) object for a given language or script. ## -parameters ### -param languageTag A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag, or an [ISO 15924](http://www.unicode.org/iso15924/) script identifier. ## -remarks The *languageTag* parameter can be any valid [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag, such as "en", "de-CH", or "zh-Hans". The only limitations are that the language tag must include an explicit script subtag or be for a language for which the script is implicitly known. (For instance, "en" is assumed to imply Latin script.) Moreover, the script must be one that Windows supports. The *languageTag* parameter can also be a valid ISO 15924 script identifier, such as "Latn", "Cyrl", or "Deva". The only limitation is that the script must be one that Windows supports. > [!NOTE] > If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Fonts.LanguageFontGroup.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.LanguageFontGroup + +## -description +Creates a [LanguageFontGroup](languagefontgroup.md) object for a given language or script. + +## -parameters +### -param languageTag +A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag, or an [ISO 15924](http://www.unicode.org/iso15924/) script identifier. + +## -remarks +The *languageTag* parameter can be any valid [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag, such as "en", "de-CH", or "zh-Hans". The only limitations are that the language tag must include an explicit script subtag or be for a language for which the script is implicitly known. (For instance, "en" is assumed to imply Latin script.) Moreover, the script must be one that Windows supports. + +The *languageTag* parameter can also be a valid ISO 15924 script identifier, such as "Latn", "Cyrl", or "Deva". The only limitation is that the script must be one that Windows supports. + +> [!NOTE] +> If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization.fonts/languagefontgroup_moderndocumentfont.md b/windows.globalization.fonts/languagefontgroup_moderndocumentfont.md index c9f5816bee..9d5d994da9 100644 --- a/windows.globalization.fonts/languagefontgroup_moderndocumentfont.md +++ b/windows.globalization.fonts/languagefontgroup_moderndocumentfont.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.ModernDocumentFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.ModernDocumentFont ## -description Gets a font that is recommended for typical document body text following modern style conventions. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) property provides a font recommendation for typical document body text following modern style conventions. These fonts can also be used in headings or other document elements. The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. A [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.ModernDocumentFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.ModernDocumentFont + +## -description +Gets a font that is recommended for typical document body text following modern style conventions. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) property provides a font recommendation for typical document body text following modern style conventions. These fonts can also be used in headings or other document elements. + +The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. + +A [ModernDocumentFont](languagefontgroup_moderndocumentfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_traditionaldocumentfont.md b/windows.globalization.fonts/languagefontgroup_traditionaldocumentfont.md index 65a5f5a01a..8d1e90cded 100644 --- a/windows.globalization.fonts/languagefontgroup_traditionaldocumentfont.md +++ b/windows.globalization.fonts/languagefontgroup_traditionaldocumentfont.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.TraditionalDocumentFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.TraditionalDocumentFont ## -description Gets a font that is recommended for typical document body text following traditional style conventions. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md) property provides a font recommendation for typical document body text following traditional styling conventions. These fonts can also be used in headings or other document elements. The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. A [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.TraditionalDocumentFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.TraditionalDocumentFont + +## -description +Gets a font that is recommended for typical document body text following traditional style conventions. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md) property provides a font recommendation for typical document body text following traditional styling conventions. These fonts can also be used in headings or other document elements. + +The font recommended for this usage case will always be a "regular" font (regular weight, normal style, normal stretch). Apps might want to apply other weight/style/stretch formatting, as may be appropriate for the app scenario. + +A [TraditionalDocumentFont](languagefontgroup_traditionaldocumentfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also diff --git a/windows.globalization.fonts/languagefontgroup_uicaptionfont.md b/windows.globalization.fonts/languagefontgroup_uicaptionfont.md index 1d8191e003..705c5026a2 100644 --- a/windows.globalization.fonts/languagefontgroup_uicaptionfont.md +++ b/windows.globalization.fonts/languagefontgroup_uicaptionfont.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UICaptionFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.UICaptionFont ## -description Gets a font that is recommended for special UI elements, such as captions, that are displayed at sizes smaller than typical UI body text. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [UICaptionFont](languagefontgroup_uicaptionfont.md) property provides a font recommendation for special UI elements, such as captions, that are displayed at sizes smaller than typical UI body text. The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. A [UICaptionFont](languagefontgroup_uicaptionfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also [Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UICaptionFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.UICaptionFont + +## -description +Gets a font that is recommended for special UI elements, such as captions, that are displayed at sizes smaller than typical UI body text. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [UICaptionFont](languagefontgroup_uicaptionfont.md) property provides a font recommendation for special UI elements, such as captions, that are displayed at sizes smaller than typical UI body text. + +The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. + +A [UICaptionFont](languagefontgroup_uicaptionfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also +[Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file diff --git a/windows.globalization.fonts/languagefontgroup_uiheadingfont.md b/windows.globalization.fonts/languagefontgroup_uiheadingfont.md index 1f43e3b2f2..3248940ee1 100644 --- a/windows.globalization.fonts/languagefontgroup_uiheadingfont.md +++ b/windows.globalization.fonts/languagefontgroup_uiheadingfont.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UIHeadingFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.UIHeadingFont ## -description Gets a font that is recommended for special UI elements, such as headings, that are displayed at sizes somewhat larger than typical UI body text. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [UIHeadingFont](languagefontgroup_uiheadingfont.md) property provides a font recommendation for special UI elements, such as headings, that are displayed at sizes somewhat larger than typical UI body text. The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. A [UIHeadingFont](languagefontgroup_uiheadingfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also [Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UIHeadingFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.UIHeadingFont + +## -description +Gets a font that is recommended for special UI elements, such as headings, that are displayed at sizes somewhat larger than typical UI body text. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [UIHeadingFont](languagefontgroup_uiheadingfont.md) property provides a font recommendation for special UI elements, such as headings, that are displayed at sizes somewhat larger than typical UI body text. + +The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. + +A [UIHeadingFont](languagefontgroup_uiheadingfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also +[Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file diff --git a/windows.globalization.fonts/languagefontgroup_uinotificationheadingfont.md b/windows.globalization.fonts/languagefontgroup_uinotificationheadingfont.md index 6c70232e90..59a07864be 100644 --- a/windows.globalization.fonts/languagefontgroup_uinotificationheadingfont.md +++ b/windows.globalization.fonts/languagefontgroup_uinotificationheadingfont.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UINotificationHeadingFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.UINotificationHeadingFont ## -description Gets a font that is recommended for special UI elements, such as headings in notifications or other app messages, that are displayed at UI  body text size or only slightly larger yet need to be differentiated from UI body text. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [UINotificationHeadingFont](languagefontgroup_uinotificationheadingfont.md) property provides a font recommendation for special UI elements, such as headings in notifications or other app messages, that are displayed at UI body text size or only slightly larger yet need to be differentiated from UI body text. The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. A [UINotificationHeadingFont](languagefontgroup_uinotificationheadingfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also [Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UINotificationHeadingFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.UINotificationHeadingFont + +## -description +Gets a font that is recommended for special UI elements, such as headings in notifications or other app messages, that are displayed at UI  body text size or only slightly larger yet need to be differentiated from UI body text. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [UINotificationHeadingFont](languagefontgroup_uinotificationheadingfont.md) property provides a font recommendation for special UI elements, such as headings in notifications or other app messages, that are displayed at UI body text size or only slightly larger yet need to be differentiated from UI body text. + +The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. + +A [UINotificationHeadingFont](languagefontgroup_uinotificationheadingfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also +[Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file diff --git a/windows.globalization.fonts/languagefontgroup_uitextfont.md b/windows.globalization.fonts/languagefontgroup_uitextfont.md index 0ffe2d2b94..1bdcd15da9 100644 --- a/windows.globalization.fonts/languagefontgroup_uitextfont.md +++ b/windows.globalization.fonts/languagefontgroup_uitextfont.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UITextFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.UITextFont ## -description Gets a font that is recommended for typical UI body text. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [UITextFont](languagefontgroup_uitextfont.md) property provides a font recommendation for typical UI body text. The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. A [UITextFont](languagefontgroup_uitextfont.md) recommendation is available for every supported language or script. ## -examples ## -see-also [Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UITextFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.UITextFont + +## -description +Gets a font that is recommended for typical UI body text. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [UITextFont](languagefontgroup_uitextfont.md) property provides a font recommendation for typical UI body text. + +The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. + +A [UITextFont](languagefontgroup_uitextfont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also +[Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file diff --git a/windows.globalization.fonts/languagefontgroup_uititlefont.md b/windows.globalization.fonts/languagefontgroup_uititlefont.md index a93f60e299..b7eb6142c1 100644 --- a/windows.globalization.fonts/languagefontgroup_uititlefont.md +++ b/windows.globalization.fonts/languagefontgroup_uititlefont.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UITitleFont --api-type: winrt property ---- # Windows.Globalization.Fonts.LanguageFontGroup.UITitleFont ## -description Gets a font that is recommended for special UI elements set at sizes much larger than typical UI body text. ## -property-value The recommended [LanguageFont](languagefont.md). ## -remarks The [UITitleFont](languagefontgroup_uititlefont.md) property provides a font recommendation for special UI elements set at sizes much larger than typical UI body text—typically 36 pt. or above. The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. A [UITitleFont](languagefontgroup_uititlefont.md) recommendation is available for every supported language or script. ## -examples ## -see-also [Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Fonts.LanguageFontGroup.UITitleFont +-api-type: winrt property +--- + + + +# Windows.Globalization.Fonts.LanguageFontGroup.UITitleFont + +## -description +Gets a font that is recommended for special UI elements set at sizes much larger than typical UI body text. + +## -property-value +The recommended [LanguageFont](languagefont.md). + +## -remarks +The [UITitleFont](languagefontgroup_uititlefont.md) property provides a font recommendation for special UI elements set at sizes much larger than typical UI body text—typically 36 pt. or above. + +The font recommended for this usage case may be differentiated from other UI usage cases in font weight, style or stretch values. Those attributes are significant aspects of the font recommendation being provided. + +A [UITitleFont](languagefontgroup_uititlefont.md) recommendation is available for every supported language or script. + +## -examples + +## -see-also +[Guidelines and checklist for text and typography](http://msdn.microsoft.com/library/1b8b90ad-cdc4-4997-acde-871c1e94a929), [Understanding the Windows 8 silhouette](http://msdn.microsoft.com/library/2d4ec23b-185e-4f44-a302-02b77b0d4cee) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter.md b/windows.globalization.numberformatting/currencyformatter.md index c6b0fa797f..b31c3f4bbd 100644 --- a/windows.globalization.numberformatting/currencyformatter.md +++ b/windows.globalization.numberformatting/currencyformatter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Globalization.NumberFormatting.CurrencyFormatter --api-type: winrt class ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter ## -description Formats and parses currencies. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumberFormatting.CurrencyFormatter +-api-type: winrt class +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter + +## -description +Formats and parses currencies. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_applyroundingforcurrency_1365585652.md b/windows.globalization.numberformatting/currencyformatter_applyroundingforcurrency_1365585652.md index 13cf4f4f79..aebc460874 100644 --- a/windows.globalization.numberformatting/currencyformatter_applyroundingforcurrency_1365585652.md +++ b/windows.globalization.numberformatting/currencyformatter_applyroundingforcurrency_1365585652.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ApplyRoundingForCurrency(Windows.Globalization.NumberFormatting.RoundingAlgorithm) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.ApplyRoundingForCurrency ## -description Prepares the [CurrencyFormatter](currencyformatter.md) object to format currency values with a specified rounding algorithm. ## -parameters ### -param roundingAlgorithm The desired rounding algorithm for the currency. This must be one of the members of [RoundingAlgorithm](roundingalgorithm.md), excluding **None**. ## -remarks [ApplyRoundingForCurrency](currencyformatter_applyroundingforcurrency.md) initializes [NumberRounder](currencyformatter_numberrounder.md) to an [IncrementNumberRounder](incrementnumberrounder.md) object whose increment is set such that the inputs to [Format](currencyformatter_format.md) will be rounded to the number of fraction digits established by [Currency](currencyformatter_currency.md). The number of fraction digits can be obtained from the default value of the [FractionDigits](currencyformatter_fractiondigits.md) property. ## -examples ## -see-also [RoundingAlgorithm](roundingalgorithm.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ApplyRoundingForCurrency(Windows.Globalization.NumberFormatting.RoundingAlgorithm) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.ApplyRoundingForCurrency + +## -description +Prepares the [CurrencyFormatter](currencyformatter.md) object to format currency values with a specified rounding algorithm. + +## -parameters +### -param roundingAlgorithm +The desired rounding algorithm for the currency. This must be one of the members of [RoundingAlgorithm](roundingalgorithm.md), excluding **None**. + +## -remarks +[ApplyRoundingForCurrency](currencyformatter_applyroundingforcurrency.md) initializes [NumberRounder](currencyformatter_numberrounder.md) to an [IncrementNumberRounder](incrementnumberrounder.md) object whose increment is set such that the inputs to [Format](currencyformatter_format.md) will be rounded to the number of fraction digits established by [Currency](currencyformatter_currency.md). The number of fraction digits can be obtained from the default value of the [FractionDigits](currencyformatter_fractiondigits.md) property. + +## -examples + +## -see-also +[RoundingAlgorithm](roundingalgorithm.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_currency.md b/windows.globalization.numberformatting/currencyformatter_currency.md index 76bb26a746..320394f1f0 100644 --- a/windows.globalization.numberformatting/currencyformatter_currency.md +++ b/windows.globalization.numberformatting/currencyformatter_currency.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.Currency --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.Currency ## -description > [!NOTE] > Currency may be read-only for releases after Windows 8.1. Instead, use a new [CurrencyFormatter](currencyformatter.md). Gets the identifier for the currency to be used for formatting and parsing currency values. ## -property-value The currency identifier to use when formatting and parsing currency values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.Currency +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.Currency + +## -description +> [!NOTE] +> Currency may be read-only for releases after Windows 8.1. Instead, use a new [CurrencyFormatter](currencyformatter.md). + +Gets the identifier for the currency to be used for formatting and parsing currency values. + +## -property-value +The currency identifier to use when formatting and parsing currency values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_currencyformatter_1781948400.md b/windows.globalization.numberformatting/currencyformatter_currencyformatter_1781948400.md index b4ff89a916..b90d7a8d1b 100644 --- a/windows.globalization.numberformatting/currencyformatter_currencyformatter_1781948400.md +++ b/windows.globalization.numberformatting/currencyformatter_currencyformatter_1781948400.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.CurrencyFormatter ## -description Creates a [CurrencyFormatter](currencyformatter.md) object initialized with a currency identifier, language list, and geographic region. ## -parameters ### -param currencyCode The currency identifier to use when formatting and parsing currency values. ### -param languages The list of language identifiers, in priority order, representing the choice of languages. See Remarks. ### -param geographicRegion The identifier for the geographic region. ## -remarks In the case that the symbol for the provided currency is the same symbol as that of a different currency in the provided region (or the home region if none is provided), formatting may use a currency code even if the [Mode](currencyformatter_mode.md) property is **UseSymbol**. This is to avoid ambiguity. For example, [CurrencyFormatter](currencyformatter_currencyformatter_1781948400.md) ("USD", ["en"], "CA") creates a formatter that formats 3 as 3 CAD, even if the [Mode](currencyformatter_mode.md) property is **UseSymbol**. Similarly, [CurrencyFormatter](currencyformatter_currencyformatter_1781948400.md) ("CAD", ["en"], "US") creates a formatter that formats 3 as 3 USD. If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [CurrencyFormatter](currencyformatter.md) objects. ## -examples ## -see-also [CurrencyFormatter(String)](currencyformatter_currencyformatter_290278668.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.CurrencyFormatter + +## -description +Creates a [CurrencyFormatter](currencyformatter.md) object initialized with a currency identifier, language list, and geographic region. + +## -parameters +### -param currencyCode +The currency identifier to use when formatting and parsing currency values. + +### -param languages +The list of language identifiers, in priority order, representing the choice of languages. See Remarks. + +### -param geographicRegion +The identifier for the geographic region. + +## -remarks +In the case that the symbol for the provided currency is the same symbol as that of a different currency in the provided region (or the home region if none is provided), formatting may use a currency code even if the [Mode](currencyformatter_mode.md) property is **UseSymbol**. This is to avoid ambiguity. For example, [CurrencyFormatter](currencyformatter_currencyformatter_1781948400.md) ("USD", ["en"], "CA") creates a formatter that formats 3 as 3 CAD, even if the [Mode](currencyformatter_mode.md) property is **UseSymbol**. Similarly, [CurrencyFormatter](currencyformatter_currencyformatter_1781948400.md) ("CAD", ["en"], "US") creates a formatter that formats 3 as 3 USD. + +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [CurrencyFormatter](currencyformatter.md) objects. + +## -examples + +## -see-also +[CurrencyFormatter(String)](currencyformatter_currencyformatter_290278668.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_currencyformatter_290278668.md b/windows.globalization.numberformatting/currencyformatter_currencyformatter_290278668.md index 6fc10436fa..c0db59dacd 100644 --- a/windows.globalization.numberformatting/currencyformatter_currencyformatter_290278668.md +++ b/windows.globalization.numberformatting/currencyformatter_currencyformatter_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.CurrencyFormatter ## -description Creates a [CurrencyFormatter](currencyformatter.md) object that is initialized with a currency identifier. ## -parameters ### -param currencyCode The currency identifier to use when formatting and parsing currency values. ## -remarks ## -examples ## -see-also [CurrencyFormatter(String, IIterable(String), String)](currencyformatter_currencyformatter_1781948400.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.CurrencyFormatter + +## -description +Creates a [CurrencyFormatter](currencyformatter.md) object that is initialized with a currency identifier. + +## -parameters +### -param currencyCode +The currency identifier to use when formatting and parsing currency values. + +## -remarks + +## -examples + +## -see-also +[CurrencyFormatter(String, IIterable(String), String)](currencyformatter_currencyformatter_1781948400.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_format_339880429.md b/windows.globalization.numberformatting/currencyformatter_format_339880429.md index c42cba1401..9f315a529a 100644 --- a/windows.globalization.numberformatting/currencyformatter_format_339880429.md +++ b/windows.globalization.numberformatting/currencyformatter_format_339880429.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.Format(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.Format ## -description Returns a string representation of a **Double** currency value. ## -parameters ### -param value The **Double** currency value to be formatted. ## -returns A string that represents the value. ## -remarks See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous. ## -examples ## -see-also [Format(Int64)](currencyformatter_format_796110984.md), [Format(UInt64)](currencyformatter_format_77898908.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.Format(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.Format + +## -description +Returns a string representation of a **Double** currency value. + +## -parameters +### -param value +The **Double** currency value to be formatted. + +## -returns +A string that represents the value. + +## -remarks +See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous. + +## -examples + +## -see-also +[Format(Int64)](currencyformatter_format_796110984.md), [Format(UInt64)](currencyformatter_format_77898908.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_format_77898908.md b/windows.globalization.numberformatting/currencyformatter_format_77898908.md index 4c990dab54..4fe20616f5 100644 --- a/windows.globalization.numberformatting/currencyformatter_format_77898908.md +++ b/windows.globalization.numberformatting/currencyformatter_format_77898908.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.Format(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.Format ## -description Returns a string representation of a **UInt64** currency value. ## -parameters ### -param value The **UInt64** currency value to be formatted. ## -returns A string that represents the value. ## -remarks See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous. ## -examples ## -see-also [Format(Int64)](currencyformatter_format_796110984.md), [Format(Double)](currencyformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.Format(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.Format + +## -description +Returns a string representation of a **UInt64** currency value. + +## -parameters +### -param value +The **UInt64** currency value to be formatted. + +## -returns +A string that represents the value. + +## -remarks +See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous. + +## -examples + +## -see-also +[Format(Int64)](currencyformatter_format_796110984.md), [Format(Double)](currencyformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_format_796110984.md b/windows.globalization.numberformatting/currencyformatter_format_796110984.md index 4efe5b36fe..733fed5848 100644 --- a/windows.globalization.numberformatting/currencyformatter_format_796110984.md +++ b/windows.globalization.numberformatting/currencyformatter_format_796110984.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.Format(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.Format ## -description Returns a string representation of an **Int64** currency value. ## -parameters ### -param value The **Int64** currency value to be formatted. ## -returns A string that represents the value. ## -remarks See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous. ## -examples ## -see-also [Format(UInt64)](currencyformatter_format_77898908.md), [Format(Double)](currencyformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.Format(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.Format + +## -description +Returns a string representation of an **Int64** currency value. + +## -parameters +### -param value +The **Int64** currency value to be formatted. + +## -returns +A string that represents the value. + +## -remarks +See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous. + +## -examples + +## -see-also +[Format(UInt64)](currencyformatter_format_77898908.md), [Format(Double)](currencyformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_formatdouble_438054348.md b/windows.globalization.numberformatting/currencyformatter_formatdouble_438054348.md index 1433eec225..a31a9b6b8a 100644 --- a/windows.globalization.numberformatting/currencyformatter_formatdouble_438054348.md +++ b/windows.globalization.numberformatting/currencyformatter_formatdouble_438054348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatDouble ## -description Returns a string representation of a **Double** currency value. ## -parameters ### -param value The **Double** currency value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatDouble + +## -description +Returns a string representation of a **Double** currency value. + +## -parameters +### -param value +The **Double** currency value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_formatint_65483418.md b/windows.globalization.numberformatting/currencyformatter_formatint_65483418.md index 5dfb079312..85c77fab1d 100644 --- a/windows.globalization.numberformatting/currencyformatter_formatint_65483418.md +++ b/windows.globalization.numberformatting/currencyformatter_formatint_65483418.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatInt(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatInt ## -description Returns a string representation of an **Int64** currency value. ## -parameters ### -param value The **Int64** currency value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatInt(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatInt + +## -description +Returns a string representation of an **Int64** currency value. + +## -parameters +### -param value +The **Int64** currency value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_formatuint_382789512.md b/windows.globalization.numberformatting/currencyformatter_formatuint_382789512.md index bc842a7ad2..09313e49b0 100644 --- a/windows.globalization.numberformatting/currencyformatter_formatuint_382789512.md +++ b/windows.globalization.numberformatting/currencyformatter_formatuint_382789512.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatUInt(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatUInt ## -description Returns a string representation of a **UInt64** currency value. ## -parameters ### -param value The **UInt64** currency value to be formatted. ## -returns The **UInt64** currency value to be formatted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatUInt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.FormatUInt + +## -description +Returns a string representation of a **UInt64** currency value. + +## -parameters +### -param value +The **UInt64** currency value to be formatted. + +## -returns +The **UInt64** currency value to be formatted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_fractiondigits.md b/windows.globalization.numberformatting/currencyformatter_fractiondigits.md index 5571c4deaf..b5826b7788 100644 --- a/windows.globalization.numberformatting/currencyformatter_fractiondigits.md +++ b/windows.globalization.numberformatting/currencyformatter_fractiondigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.FractionDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.FractionDigits ## -description Gets or sets the minimum number of digits to display for the fraction part of the currency value. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.FractionDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.FractionDigits + +## -description +Gets or sets the minimum number of digits to display for the fraction part of the currency value. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_geographicregion.md b/windows.globalization.numberformatting/currencyformatter_geographicregion.md index a46a18499f..d644c66712 100644 --- a/windows.globalization.numberformatting/currencyformatter_geographicregion.md +++ b/windows.globalization.numberformatting/currencyformatter_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.GeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.GeographicRegion ## -description Gets the region that is used when formatting and parsing currency values. ## -property-value The region that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.GeographicRegion + +## -description +Gets the region that is used when formatting and parsing currency values. + +## -property-value +The region that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_integerdigits.md b/windows.globalization.numberformatting/currencyformatter_integerdigits.md index 93ed5cf727..504ff8ed0c 100644 --- a/windows.globalization.numberformatting/currencyformatter_integerdigits.md +++ b/windows.globalization.numberformatting/currencyformatter_integerdigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IntegerDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.IntegerDigits ## -description Gets or sets the minimum number of digits to display for the integer part of the currency value. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IntegerDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.IntegerDigits + +## -description +Gets or sets the minimum number of digits to display for the integer part of the currency value. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_isdecimalpointalwaysdisplayed.md b/windows.globalization.numberformatting/currencyformatter_isdecimalpointalwaysdisplayed.md index 1084961252..3624427891 100644 --- a/windows.globalization.numberformatting/currencyformatter_isdecimalpointalwaysdisplayed.md +++ b/windows.globalization.numberformatting/currencyformatter_isdecimalpointalwaysdisplayed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IsDecimalPointAlwaysDisplayed --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.IsDecimalPointAlwaysDisplayed ## -description Gets or sets whether the decimal point of the currency value should always be displayed. ## -property-value **True** if the decimal point of the value should always be displayed, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IsDecimalPointAlwaysDisplayed +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.IsDecimalPointAlwaysDisplayed + +## -description +Gets or sets whether the decimal point of the currency value should always be displayed. + +## -property-value + **True** if the decimal point of the value should always be displayed, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_isgrouped.md b/windows.globalization.numberformatting/currencyformatter_isgrouped.md index 29b3644301..72322c759d 100644 --- a/windows.globalization.numberformatting/currencyformatter_isgrouped.md +++ b/windows.globalization.numberformatting/currencyformatter_isgrouped.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IsGrouped --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.IsGrouped ## -description Gets or sets whether the integer part of the currency value should be grouped. ## -property-value **True** if the integer part of the value should be grouped, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IsGrouped +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.IsGrouped + +## -description +Gets or sets whether the integer part of the currency value should be grouped. + + + + +## -property-value + **True** if the integer part of the value should be grouped, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_iszerosigned.md b/windows.globalization.numberformatting/currencyformatter_iszerosigned.md index cf8e632927..95019c4f48 100644 --- a/windows.globalization.numberformatting/currencyformatter_iszerosigned.md +++ b/windows.globalization.numberformatting/currencyformatter_iszerosigned.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IsZeroSigned --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.IsZeroSigned ## -description Gets or sets whether -0 is formatted using the conventions for negative numbers or for positive numbers. (In the Latin numeral system, the choice is "-0" or "0".) ## -property-value **True** if -0 is formatted as a negative number, and **false** if -0 is formatted as a positive number ("-0" or "0" in the Latin numeral system). ## -remarks You can set this property to specify that [CurrencyFormatter](currencyformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.IsZeroSigned +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.IsZeroSigned + +## -description +Gets or sets whether -0 is formatted using the conventions for negative numbers or for positive numbers. (In the Latin numeral system, the choice is "-0" or "0".) + +## -property-value + **True** if -0 is formatted as a negative number, and **false** if -0 is formatted as a positive number ("-0" or "0" in the Latin numeral system). + +## -remarks +You can set this property to specify that [CurrencyFormatter](currencyformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). + +This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_languages.md b/windows.globalization.numberformatting/currencyformatter_languages.md index 58909bb0e7..b861100871 100644 --- a/windows.globalization.numberformatting/currencyformatter_languages.md +++ b/windows.globalization.numberformatting/currencyformatter_languages.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.Languages --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.Languages ## -description Gets the priority list of language identifiers that is used when formatting and parsing currency values. ## -property-value The priority list of language identifiers. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [CurrencyFormatter(String, IIterable(String), String)](currencyformatter_currencyformatter_1781948400.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting and parsing currency values. + +## -property-value +The priority list of language identifiers. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [CurrencyFormatter(String, IIterable(String), String)](currencyformatter_currencyformatter_1781948400.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_mode.md b/windows.globalization.numberformatting/currencyformatter_mode.md index 78390fc795..49183c76ab 100644 --- a/windows.globalization.numberformatting/currencyformatter_mode.md +++ b/windows.globalization.numberformatting/currencyformatter_mode.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.Mode --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.Mode ## -description Gets or sets whether the currency is formatted with the currency symbol or currency code. ## -property-value The [CurrencyFormatterMode](currencyformattermode.md) value which specifies how the currency is formatted. ## -remarks See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous even if the [Mode](currencyformatter_mode.md) property is **UseSymbol**. ## -examples ## -see-also [CurrencyFormatterMode](currencyformattermode.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.Mode +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.Mode + +## -description +Gets or sets whether the currency is formatted with the currency symbol or currency code. + +## -property-value +The [CurrencyFormatterMode](currencyformattermode.md) value which specifies how the currency is formatted. + +## -remarks +See the remarks for [CurrencyFormatter((String, IIterable(String), String))](currencyformatter_currencyformatter_1781948400.md) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous even if the [Mode](currencyformatter_mode.md) property is **UseSymbol**. + +## -examples + +## -see-also +[CurrencyFormatterMode](currencyformattermode.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_numberrounder.md b/windows.globalization.numberformatting/currencyformatter_numberrounder.md index ef68e49626..b52de2db97 100644 --- a/windows.globalization.numberformatting/currencyformatter_numberrounder.md +++ b/windows.globalization.numberformatting/currencyformatter_numberrounder.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.NumberRounder --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.NumberRounder ## -description Gets or sets the current rounding strategy to be used when formatting currency amounts. ## -property-value A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). ## -remarks When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.NumberRounder +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.NumberRounder + +## -description +Gets or sets the current rounding strategy to be used when formatting currency amounts. + +## -property-value +A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). + +## -remarks +When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_numeralsystem.md b/windows.globalization.numberformatting/currencyformatter_numeralsystem.md index c6b6857762..772c24d94d 100644 --- a/windows.globalization.numberformatting/currencyformatter_numeralsystem.md +++ b/windows.globalization.numberformatting/currencyformatter_numeralsystem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.NumeralSystem ## -description Gets or sets the numbering system that is used to format and parse currency values. ## -property-value A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.NumeralSystem + +## -description +Gets or sets the numbering system that is used to format and parse currency values. + +## -property-value +A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization.numberformatting/currencyformatter_parsedouble_1368702614.md b/windows.globalization.numberformatting/currencyformatter_parsedouble_1368702614.md index d9b553a773..e874c6c6b0 100644 --- a/windows.globalization.numberformatting/currencyformatter_parsedouble_1368702614.md +++ b/windows.globalization.numberformatting/currencyformatter_parsedouble_1368702614.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseDouble(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseDouble ## -description Attempts to parse a string representation of a **Double** currency value. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **Double** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseDouble(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseDouble + +## -description +Attempts to parse a string representation of a **Double** currency value. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **Double** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_parseint_1447535745.md b/windows.globalization.numberformatting/currencyformatter_parseint_1447535745.md index e589eae605..bc4edbe18c 100644 --- a/windows.globalization.numberformatting/currencyformatter_parseint_1447535745.md +++ b/windows.globalization.numberformatting/currencyformatter_parseint_1447535745.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseInt ## -description Attempts to parse a string representation of an integer currency value. ## -parameters ### -param text The text to be parsed. ## -returns If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseInt + +## -description +Attempts to parse a string representation of an integer currency value. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_parseuint_168772619.md b/windows.globalization.numberformatting/currencyformatter_parseuint_168772619.md index e0660db4be..f5910aafe6 100644 --- a/windows.globalization.numberformatting/currencyformatter_parseuint_168772619.md +++ b/windows.globalization.numberformatting/currencyformatter_parseuint_168772619.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseUInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseUInt ## -description Attempts to parse a string representation of an unsigned integer currency value. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseUInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.ParseUInt + +## -description +Attempts to parse a string representation of an unsigned integer currency value. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_resolvedgeographicregion.md b/windows.globalization.numberformatting/currencyformatter_resolvedgeographicregion.md index 5a9f15e127..4888660c09 100644 --- a/windows.globalization.numberformatting/currencyformatter_resolvedgeographicregion.md +++ b/windows.globalization.numberformatting/currencyformatter_resolvedgeographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedGeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedGeographicRegion ## -description Gets the geographic region that was most recently used to format or parse currency values. ## -property-value The geographic region that was most recently used to format or parse currency values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedGeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedGeographicRegion + +## -description +Gets the geographic region that was most recently used to format or parse currency values. + +## -property-value +The geographic region that was most recently used to format or parse currency values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_resolvedlanguage.md b/windows.globalization.numberformatting/currencyformatter_resolvedlanguage.md index 25f4d6237b..dc771d93f0 100644 --- a/windows.globalization.numberformatting/currencyformatter_resolvedlanguage.md +++ b/windows.globalization.numberformatting/currencyformatter_resolvedlanguage.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedLanguage ## -description Gets the language that was most recently used to format or parse currency values. ## -property-value The language from the [priority list of language identifiers](currencyformatter_languages.md) that was most recently used to format or parse currency values. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [CurrencyFormatter(String, IIterable(String), String)](currencyformatter_currencyformatter_1781948400.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.ResolvedLanguage + +## -description +Gets the language that was most recently used to format or parse currency values. + +## -property-value +The language from the [priority list of language identifiers](currencyformatter_languages.md) that was most recently used to format or parse currency values. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [CurrencyFormatter(String, IIterable(String), String)](currencyformatter_currencyformatter_1781948400.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/currencyformatter_significantdigits.md b/windows.globalization.numberformatting/currencyformatter_significantdigits.md index 2280297435..58aa230654 100644 --- a/windows.globalization.numberformatting/currencyformatter_significantdigits.md +++ b/windows.globalization.numberformatting/currencyformatter_significantdigits.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.SignificantDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.CurrencyFormatter.SignificantDigits ## -description Gets or sets the current padding to significant digits when a currency amount is formatted. ## -property-value The number of significant digits. ## -remarks Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.CurrencyFormatter.SignificantDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.CurrencyFormatter.SignificantDigits + +## -description +Gets or sets the current padding to significant digits when a currency amount is formatted. + +## -property-value +The number of significant digits. + +## -remarks +Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter.md b/windows.globalization.numberformatting/decimalformatter.md index d9d9c55500..d253db65b2 100644 --- a/windows.globalization.numberformatting/decimalformatter.md +++ b/windows.globalization.numberformatting/decimalformatter.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Globalization.NumberFormatting.DecimalFormatter --api-type: winrt class ---- # Windows.Globalization.NumberFormatting.DecimalFormatter ## -description Formats and parses decimal numbers. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumberFormatting.DecimalFormatter +-api-type: winrt class +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter + +## -description +Formats and parses decimal numbers. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_decimalformatter_1221375020.md b/windows.globalization.numberformatting/decimalformatter_decimalformatter_1221375020.md index b4230d1f6a..09fbd56861 100644 --- a/windows.globalization.numberformatting/decimalformatter_decimalformatter_1221375020.md +++ b/windows.globalization.numberformatting/decimalformatter_decimalformatter_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.#ctor --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.DecimalFormatter ## -description Creates a [DecimalFormatter](decimalformatter.md) object and initializes it to default values. ## -remarks ## -examples ## -see-also [DecimalFormatter(IIterable(String), String)](decimalformatter_decimalformatter_177128098.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.DecimalFormatter + +## -description +Creates a [DecimalFormatter](decimalformatter.md) object and initializes it to default values. + +## -remarks + +## -examples + +## -see-also +[DecimalFormatter(IIterable(String), String)](decimalformatter_decimalformatter_177128098.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_decimalformatter_177128098.md b/windows.globalization.numberformatting/decimalformatter_decimalformatter_177128098.md index 7e093c876e..281f2ce474 100644 --- a/windows.globalization.numberformatting/decimalformatter_decimalformatter_177128098.md +++ b/windows.globalization.numberformatting/decimalformatter_decimalformatter_177128098.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.DecimalFormatter ## -description Creates a [DecimalFormatter](decimalformatter.md) object initialized by a language list and a geographic region. ## -parameters ### -param languages The list of language identifiers, in priority order, representing the choice of languages. See Remarks. ### -param geographicRegion The identifier for the geographic region. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [DecimalFormatter](decimalformatter.md) objects. ## -examples ## -see-also [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.DecimalFormatter + +## -description +Creates a [DecimalFormatter](decimalformatter.md) object initialized by a language list and a geographic region. + +## -parameters +### -param languages +The list of language identifiers, in priority order, representing the choice of languages. See Remarks. + +### -param geographicRegion +The identifier for the geographic region. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [DecimalFormatter](decimalformatter.md) objects. + +## -examples + +## -see-also +[Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_format_339880429.md b/windows.globalization.numberformatting/decimalformatter_format_339880429.md index 5784e66988..384b8073bf 100644 --- a/windows.globalization.numberformatting/decimalformatter_format_339880429.md +++ b/windows.globalization.numberformatting/decimalformatter_format_339880429.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.Format(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.Format ## -description Returns a string representation of a **Double** number. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the number. ## -remarks ## -examples ## -see-also [Format(Int64)](decimalformatter_format_796110984.md), [Format(UInt64)](decimalformatter_format_77898908.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.Format(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.Format + +## -description +Returns a string representation of a **Double** number. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the number. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](decimalformatter_format_796110984.md), [Format(UInt64)](decimalformatter_format_77898908.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_format_77898908.md b/windows.globalization.numberformatting/decimalformatter_format_77898908.md index f07a738cb7..ec9d804fcf 100644 --- a/windows.globalization.numberformatting/decimalformatter_format_77898908.md +++ b/windows.globalization.numberformatting/decimalformatter_format_77898908.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.Format(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.Format ## -description Returns a string representation of a **UInt64** number. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the number. ## -remarks ## -examples ## -see-also [Format(Int64)](decimalformatter_format_796110984.md), [Format(Double)](decimalformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.Format(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.Format + +## -description +Returns a string representation of a **UInt64** number. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the number. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](decimalformatter_format_796110984.md), [Format(Double)](decimalformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_format_796110984.md b/windows.globalization.numberformatting/decimalformatter_format_796110984.md index 08c6bdb794..c69d6fc5d3 100644 --- a/windows.globalization.numberformatting/decimalformatter_format_796110984.md +++ b/windows.globalization.numberformatting/decimalformatter_format_796110984.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.Format(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.Format ## -description Returns a string representation of an **Int64** number. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the number. ## -remarks ## -examples ## -see-also [Format(UInt64)](decimalformatter_format_77898908.md), [Format(Double)](decimalformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.Format(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.Format + +## -description +Returns a string representation of an **Int64** number. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the number. + +## -remarks + +## -examples + +## -see-also +[Format(UInt64)](decimalformatter_format_77898908.md), [Format(Double)](decimalformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_formatdouble_438054348.md b/windows.globalization.numberformatting/decimalformatter_formatdouble_438054348.md index 2cd3166cf6..1aaa291615 100644 --- a/windows.globalization.numberformatting/decimalformatter_formatdouble_438054348.md +++ b/windows.globalization.numberformatting/decimalformatter_formatdouble_438054348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.FormatDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.FormatDouble ## -description Returns a string representation of a **Double** number. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.FormatDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.FormatDouble + +## -description +Returns a string representation of a **Double** number. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_formatint_65483418.md b/windows.globalization.numberformatting/decimalformatter_formatint_65483418.md index 41b30b981a..a549ed8ff1 100644 --- a/windows.globalization.numberformatting/decimalformatter_formatint_65483418.md +++ b/windows.globalization.numberformatting/decimalformatter_formatint_65483418.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.FormatInt(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.FormatInt ## -description Returns a string representation of an **Int64** number. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.FormatInt(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.FormatInt + +## -description +Returns a string representation of an **Int64** number. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_formatuint_382789512.md b/windows.globalization.numberformatting/decimalformatter_formatuint_382789512.md index 3d38c053a6..9c405dfd49 100644 --- a/windows.globalization.numberformatting/decimalformatter_formatuint_382789512.md +++ b/windows.globalization.numberformatting/decimalformatter_formatuint_382789512.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.FormatUInt(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.FormatUInt ## -description Returns a string representation of a **UInt64** number. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.FormatUInt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.FormatUInt + +## -description +Returns a string representation of a **UInt64** number. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_fractiondigits.md b/windows.globalization.numberformatting/decimalformatter_fractiondigits.md index 8ab6cf0e3d..6e64232c2f 100644 --- a/windows.globalization.numberformatting/decimalformatter_fractiondigits.md +++ b/windows.globalization.numberformatting/decimalformatter_fractiondigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.FractionDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.FractionDigits ## -description Gets or sets the minimum number of digits to display for the fraction part of the number. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.FractionDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.FractionDigits + +## -description +Gets or sets the minimum number of digits to display for the fraction part of the number. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_geographicregion.md b/windows.globalization.numberformatting/decimalformatter_geographicregion.md index bdbc821b85..8b17ba3aec 100644 --- a/windows.globalization.numberformatting/decimalformatter_geographicregion.md +++ b/windows.globalization.numberformatting/decimalformatter_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.GeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.GeographicRegion ## -description Gets the region that is used when formatting and parsing decimal numbers. ## -property-value The region that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.GeographicRegion + +## -description +Gets the region that is used when formatting and parsing decimal numbers. + +## -property-value +The region that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_integerdigits.md b/windows.globalization.numberformatting/decimalformatter_integerdigits.md index 3e97a33683..2cecd67e01 100644 --- a/windows.globalization.numberformatting/decimalformatter_integerdigits.md +++ b/windows.globalization.numberformatting/decimalformatter_integerdigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IntegerDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.IntegerDigits ## -description Gets or sets the minimum number of digits to display for the integer part of the number. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IntegerDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.IntegerDigits + +## -description +Gets or sets the minimum number of digits to display for the integer part of the number. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_isdecimalpointalwaysdisplayed.md b/windows.globalization.numberformatting/decimalformatter_isdecimalpointalwaysdisplayed.md index 82e584bba2..4eb8964e3b 100644 --- a/windows.globalization.numberformatting/decimalformatter_isdecimalpointalwaysdisplayed.md +++ b/windows.globalization.numberformatting/decimalformatter_isdecimalpointalwaysdisplayed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IsDecimalPointAlwaysDisplayed --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.IsDecimalPointAlwaysDisplayed ## -description Gets or sets whether the decimal point of the number should always be displayed. ## -property-value **True** if the decimal point of the number should always be displayed, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IsDecimalPointAlwaysDisplayed +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.IsDecimalPointAlwaysDisplayed + +## -description +Gets or sets whether the decimal point of the number should always be displayed. + +## -property-value + **True** if the decimal point of the number should always be displayed, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_isgrouped.md b/windows.globalization.numberformatting/decimalformatter_isgrouped.md index c587ab194a..3fbe3e4635 100644 --- a/windows.globalization.numberformatting/decimalformatter_isgrouped.md +++ b/windows.globalization.numberformatting/decimalformatter_isgrouped.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IsGrouped --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.IsGrouped ## -description Gets or sets whether the integer part of the number should be grouped. ## -property-value **True** if the integer part of the number should be grouped, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IsGrouped +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.IsGrouped + +## -description +Gets or sets whether the integer part of the number should be grouped. + +## -property-value + **True** if the integer part of the number should be grouped, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_iszerosigned.md b/windows.globalization.numberformatting/decimalformatter_iszerosigned.md index bd5412f2f3..44c4c23121 100644 --- a/windows.globalization.numberformatting/decimalformatter_iszerosigned.md +++ b/windows.globalization.numberformatting/decimalformatter_iszerosigned.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IsZeroSigned --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.IsZeroSigned ## -description Gets or sets whether -0 is formatted as "-0" or "0". ## -property-value **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". ## -remarks You can set this property to specify that [DecimalFormatter](decimalformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.IsZeroSigned +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.IsZeroSigned + +## -description +Gets or sets whether -0 is formatted as "-0" or "0". + +## -property-value + **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". + +## -remarks +You can set this property to specify that [DecimalFormatter](decimalformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). + +This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_languages.md b/windows.globalization.numberformatting/decimalformatter_languages.md index f2c308fb19..11562e1ad1 100644 --- a/windows.globalization.numberformatting/decimalformatter_languages.md +++ b/windows.globalization.numberformatting/decimalformatter_languages.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.Languages --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.Languages ## -description Gets the priority list of language identifiers that is used when formatting and parsing decimal numbers. ## -property-value The priority list of language identifiers. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DecimalFormatter(IIterable(String), String)](decimalformatter_decimalformatter_177128098.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting and parsing decimal numbers. + +## -property-value +The priority list of language identifiers. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DecimalFormatter(IIterable(String), String)](decimalformatter_decimalformatter_177128098.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_numberrounder.md b/windows.globalization.numberformatting/decimalformatter_numberrounder.md index 08ed0ef5ba..ac17bde1ec 100644 --- a/windows.globalization.numberformatting/decimalformatter_numberrounder.md +++ b/windows.globalization.numberformatting/decimalformatter_numberrounder.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.NumberRounder --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.NumberRounder ## -description Gets or sets the current rounding strategy to be used when formatting numbers. ## -property-value A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). ## -remarks When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.NumberRounder +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.NumberRounder + +## -description +Gets or sets the current rounding strategy to be used when formatting numbers. + +## -property-value +A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). + +## -remarks +When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_numeralsystem.md b/windows.globalization.numberformatting/decimalformatter_numeralsystem.md index 6c3c5d5f3a..ab74fc09a3 100644 --- a/windows.globalization.numberformatting/decimalformatter_numeralsystem.md +++ b/windows.globalization.numberformatting/decimalformatter_numeralsystem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.NumeralSystem ## -description Gets or sets the numbering system that is used to format and parse decimal numbers. ## -property-value A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.NumeralSystem + +## -description +Gets or sets the numbering system that is used to format and parse decimal numbers. + +## -property-value +A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization.numberformatting/decimalformatter_parsedouble_1368702614.md b/windows.globalization.numberformatting/decimalformatter_parsedouble_1368702614.md index 315a1ed8e8..ea2351eca8 100644 --- a/windows.globalization.numberformatting/decimalformatter_parsedouble_1368702614.md +++ b/windows.globalization.numberformatting/decimalformatter_parsedouble_1368702614.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.ParseDouble(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.ParseDouble ## -description Attempts to parse a string representation of a **Double** number. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **Double** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.ParseDouble(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.ParseDouble + +## -description +Attempts to parse a string representation of a **Double** number. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **Double** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_parseint_1447535745.md b/windows.globalization.numberformatting/decimalformatter_parseint_1447535745.md index eb2a3d17b6..8cd68f1b8e 100644 --- a/windows.globalization.numberformatting/decimalformatter_parseint_1447535745.md +++ b/windows.globalization.numberformatting/decimalformatter_parseint_1447535745.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.ParseInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.ParseInt ## -description Attempts to parse a string representation of an integer. ## -parameters ### -param text The text to be parsed. ## -returns If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.ParseInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.ParseInt + +## -description +Attempts to parse a string representation of an integer. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_parseuint_168772619.md b/windows.globalization.numberformatting/decimalformatter_parseuint_168772619.md index 4634d7f340..4dbf035c02 100644 --- a/windows.globalization.numberformatting/decimalformatter_parseuint_168772619.md +++ b/windows.globalization.numberformatting/decimalformatter_parseuint_168772619.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.ParseUInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.ParseUInt ## -description Attempts to parse a string representation of an unsigned integer. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.DecimalFormatter.ParseUInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.ParseUInt + +## -description +Attempts to parse a string representation of an unsigned integer. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_resolvedgeographicregion.md b/windows.globalization.numberformatting/decimalformatter_resolvedgeographicregion.md index 9f39dbfe85..3202232f42 100644 --- a/windows.globalization.numberformatting/decimalformatter_resolvedgeographicregion.md +++ b/windows.globalization.numberformatting/decimalformatter_resolvedgeographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedGeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedGeographicRegion ## -description Gets the geographic region that was most recently used to format or parse decimal values. ## -property-value The geographic region that was most recently used to format or parse decimal values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedGeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedGeographicRegion + +## -description +Gets the geographic region that was most recently used to format or parse decimal values. + +## -property-value +The geographic region that was most recently used to format or parse decimal values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_resolvedlanguage.md b/windows.globalization.numberformatting/decimalformatter_resolvedlanguage.md index 1363e87fc6..4b341ede93 100644 --- a/windows.globalization.numberformatting/decimalformatter_resolvedlanguage.md +++ b/windows.globalization.numberformatting/decimalformatter_resolvedlanguage.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedLanguage ## -description Gets the language that was most recently used to format or parse decimal values. ## -property-value The language from the [priority list of language identifiers](decimalformatter_languages.md) that was most recently used to format or parse decimal values. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DecimalFormatter(IIterable(String), String)](decimalformatter_decimalformatter_177128098.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.ResolvedLanguage + +## -description +Gets the language that was most recently used to format or parse decimal values. + +## -property-value +The language from the [priority list of language identifiers](decimalformatter_languages.md) that was most recently used to format or parse decimal values. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [DecimalFormatter(IIterable(String), String)](decimalformatter_decimalformatter_177128098.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/decimalformatter_significantdigits.md b/windows.globalization.numberformatting/decimalformatter_significantdigits.md index 5213f9a000..b81e2f8e1e 100644 --- a/windows.globalization.numberformatting/decimalformatter_significantdigits.md +++ b/windows.globalization.numberformatting/decimalformatter_significantdigits.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.SignificantDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.DecimalFormatter.SignificantDigits ## -description Gets or sets the current padding to significant digits when a decimal number is formatted. ## -property-value The number of significant digits. ## -remarks Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.DecimalFormatter.SignificantDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.DecimalFormatter.SignificantDigits + +## -description +Gets or sets the current padding to significant digits when a decimal number is formatted. + +## -property-value +The number of significant digits. + +## -remarks +Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder.md b/windows.globalization.numberformatting/incrementnumberrounder.md index 2b2a141ce9..3f3b719633 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder.md +++ b/windows.globalization.numberformatting/incrementnumberrounder.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Globalization.NumberFormatting.IncrementNumberRounder --api-type: winrt class ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder ## -description Rounds numbers to a specified increment. For example, this class can be used to round a number to the nearest 0.01. ## -remarks ## -examples ## -see-also [INumberRounder](inumberrounder.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumberFormatting.IncrementNumberRounder +-api-type: winrt class +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder + +## -description +Rounds numbers to a specified increment. + +For example, this class can be used to round a number to the nearest 0.01. + +## -remarks + +## -examples + +## -see-also +[INumberRounder](inumberrounder.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file diff --git a/windows.globalization.numberformatting/incrementnumberrounder_increment.md b/windows.globalization.numberformatting/incrementnumberrounder_increment.md index 3b6e692557..e52098f3b1 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_increment.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_increment.md @@ -1,3 +1,37 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.IncrementNumberRounder.Increment --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.Increment ## -description Gets or sets the increment this [IncrementNumberRounder](incrementnumberrounder.md) object uses for rounding. ## -property-value The increment used for rounding. ## -remarks This property can be one of the following: + An integer greater than 0. + A fraction of the form 1/n, where n is an integer between 2 and 10000000000, inclusive. + 1.0e-11, 1.0e-12, 1.0e-13, 1.0e-14, 1.0e-15, 1.0e-16, 1.0e-17, 1.0e-18, 1.0e-19, or 1.0e-20. This property is initialized to a default value of 1. When rounding is performed, the result is produced in this manner: 1. Divide the input by the [Increment](incrementnumberrounder_increment.md). 1. Round the result to an integer using the rounding strategy of [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). 1. Multiply the result by the [Increment](incrementnumberrounder_increment.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.IncrementNumberRounder.Increment +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.Increment + +## -description +Gets or sets the increment this [IncrementNumberRounder](incrementnumberrounder.md) object uses for rounding. + +## -property-value +The increment used for rounding. + +## -remarks + +This property can be one of the following: + ++ An integer greater than 0. ++ A fraction of the form 1/n, where n is an integer between 2 and 10000000000, inclusive. ++ 1.0e-11, 1.0e-12, 1.0e-13, 1.0e-14, 1.0e-15, 1.0e-16, 1.0e-17, 1.0e-18, 1.0e-19, or 1.0e-20. + + +This property is initialized to a default value of 1. + +When rounding is performed, the result is produced in this manner: +1. Divide the input by the [Increment](incrementnumberrounder_increment.md). +1. Round the result to an integer using the rounding strategy of [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). +1. Multiply the result by the [Increment](incrementnumberrounder_increment.md). + + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_incrementnumberrounder_1221375020.md b/windows.globalization.numberformatting/incrementnumberrounder_incrementnumberrounder_1221375020.md index 559a68a5ea..c206a6af40 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_incrementnumberrounder_1221375020.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_incrementnumberrounder_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.#ctor --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.IncrementNumberRounder ## -description Creates an [IncrementNumberRounder](incrementnumberrounder.md) object. This constructor initializes [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md) to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**, and [Increment](incrementnumberrounder_increment.md) to 1. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.IncrementNumberRounder + +## -description +Creates an [IncrementNumberRounder](incrementnumberrounder.md) object. + +This constructor initializes [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md) to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**, and [Increment](incrementnumberrounder_increment.md) to 1. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_rounddouble_1880232351.md b/windows.globalization.numberformatting/incrementnumberrounder_rounddouble_1880232351.md index 20cf974981..96fc4b1b00 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_rounddouble_1880232351.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_rounddouble_1880232351.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundDouble ## -description Rounds a **Double** number to the specified increment. ## -parameters ### -param value The **Double** value to be rounded. ## -returns The rounded number. This result is a double precision floating point number, which is not necessarily an integer. ## -remarks The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). > [!NOTE] > This method is precise only within the limits of the [Double](https://msdn.microsoft.com/library/system.double.aspx) data type: approximately 15 digits. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundDouble + +## -description +Rounds a **Double** number to the specified increment. + +## -parameters +### -param value +The **Double** value to be rounded. + +## -returns +The rounded number. This result is a double precision floating point number, which is not necessarily an integer. + +## -remarks +The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). + +> [!NOTE] +> This method is precise only within the limits of the [Double](https://msdn.microsoft.com/library/system.double.aspx) data type: approximately 15 digits. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_roundingalgorithm.md b/windows.globalization.numberformatting/incrementnumberrounder_roundingalgorithm.md index 56e9631872..49130cd8cd 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_roundingalgorithm.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_roundingalgorithm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundingAlgorithm --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundingAlgorithm ## -description Gets or sets the rounding strategy value for this [IncrementNumberRounder](incrementnumberrounder.md) object. ## -property-value A value of the [RoundingAlgorithm](roundingalgorithm.md) enumeration. ## -remarks This property is initialized to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundingAlgorithm +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundingAlgorithm + +## -description +Gets or sets the rounding strategy value for this [IncrementNumberRounder](incrementnumberrounder.md) object. + +## -property-value +A value of the [RoundingAlgorithm](roundingalgorithm.md) enumeration. + +## -remarks +This property is initialized to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_roundint32_1088866923.md b/windows.globalization.numberformatting/incrementnumberrounder_roundint32_1088866923.md index eb030c5948..ed9f473dee 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_roundint32_1088866923.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_roundint32_1088866923.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt32(System.Int32) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt32 ## -description Rounds an **Int32** number to the specified increment. ## -parameters ### -param value The **Int32** value to be rounded. ## -returns The rounded 32 bit integer. ## -remarks The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt32(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt32 + +## -description +Rounds an **Int32** number to the specified increment. + +## -parameters +### -param value +The **Int32** value to be rounded. + +## -returns +The rounded 32 bit integer. + +## -remarks +The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_roundint64_297576497.md b/windows.globalization.numberformatting/incrementnumberrounder_roundint64_297576497.md index 818030d433..8725c0ca50 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_roundint64_297576497.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_roundint64_297576497.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt64(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt64 ## -description Rounds an **Int64** number to the specified increment. ## -parameters ### -param value The **Int64** value to be rounded. ## -returns The rounded 64 bit integer. ## -remarks The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt64(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundInt64 + +## -description +Rounds an **Int64** number to the specified increment. + +## -parameters +### -param value +The **Int64** value to be rounded. + +## -returns +The rounded 64 bit integer. + +## -remarks +The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_roundsingle_239288903.md b/windows.globalization.numberformatting/incrementnumberrounder_roundsingle_239288903.md index 30a06ec1f9..56196190bb 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_roundsingle_239288903.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_roundsingle_239288903.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundSingle(System.Single) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundSingle ## -description Rounds a **Single** number to the specified increment. ## -parameters ### -param value The **Single** value to be rounded. ## -returns The rounded number. This result is a single precision floating point number, which is not necessarily an integer. ## -remarks The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). > [!NOTE] > This method is precise only within the limits of the **Single** data type: approximately 7 digits. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundSingle(System.Single) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundSingle + +## -description +Rounds a **Single** number to the specified increment. + +## -parameters +### -param value +The **Single** value to be rounded. + +## -returns +The rounded number. This result is a single precision floating point number, which is not necessarily an integer. + +## -remarks +The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). + +> [!NOTE] +> This method is precise only within the limits of the **Single** data type: approximately 7 digits. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_rounduint32_709102605.md b/windows.globalization.numberformatting/incrementnumberrounder_rounduint32_709102605.md index 6da4143f30..77796c6369 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_rounduint32_709102605.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_rounduint32_709102605.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt32(System.UInt32) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt32 ## -description Rounds a **UInt32** number to the specified increment. ## -parameters ### -param value The **UInt32** value to be rounded. ## -returns The rounded unsigned 32 bit integer. ## -remarks The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt32(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt32 + +## -description +Rounds a **UInt32** number to the specified increment. + +## -parameters +### -param value +The **UInt32** value to be rounded. + +## -returns +The rounded unsigned 32 bit integer. + +## -remarks +The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/incrementnumberrounder_rounduint64_249553617.md b/windows.globalization.numberformatting/incrementnumberrounder_rounduint64_249553617.md index 1369bf5fdc..e70ed90337 100644 --- a/windows.globalization.numberformatting/incrementnumberrounder_rounduint64_249553617.md +++ b/windows.globalization.numberformatting/incrementnumberrounder_rounduint64_249553617.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt64(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt64 ## -description Rounds a **UInt64** number to the specified increment. ## -parameters ### -param value The **UInt64** value to be rounded. ## -returns The rounded unsigned 64 bit integer. ## -remarks The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt64(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.IncrementNumberRounder.RoundUInt64 + +## -description +Rounds a **UInt64** number to the specified increment. + +## -parameters +### -param value +The **UInt64** value to be rounded. + +## -returns +The rounded unsigned 64 bit integer. + +## -remarks +The rounding strategy is based on the values of [Increment](incrementnumberrounder_increment.md) and [RoundingAlgorithm](incrementnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatter2_formatdouble.md b/windows.globalization.numberformatting/inumberformatter2_formatdouble.md index 0115eeb7fa..bdf0d0281c 100644 --- a/windows.globalization.numberformatting/inumberformatter2_formatdouble.md +++ b/windows.globalization.numberformatting/inumberformatter2_formatdouble.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter2.FormatDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberFormatter2.FormatDouble ## -description Returns a string representation of a **Double** value. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter2.FormatDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatter2.FormatDouble + +## -description +Returns a string representation of a **Double** value. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatter2_formatint.md b/windows.globalization.numberformatting/inumberformatter2_formatint.md index 19ea134f90..962fe32ff0 100644 --- a/windows.globalization.numberformatting/inumberformatter2_formatint.md +++ b/windows.globalization.numberformatting/inumberformatter2_formatint.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter2.FormatInt(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberFormatter2.FormatInt ## -description Returns a string representation of an **Int64** value. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter2.FormatInt(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatter2.FormatInt + +## -description +Returns a string representation of an **Int64** value. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatter2_formatuint.md b/windows.globalization.numberformatting/inumberformatter2_formatuint.md index c957f7d939..1f69b7deb5 100644 --- a/windows.globalization.numberformatting/inumberformatter2_formatuint.md +++ b/windows.globalization.numberformatting/inumberformatter2_formatuint.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter2.FormatUInt(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberFormatter2.FormatUInt ## -description Returns a string representation of a **UInt64** value. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter2.FormatUInt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatter2.FormatUInt + +## -description +Returns a string representation of a **UInt64** value. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatter_format_339880429.md b/windows.globalization.numberformatting/inumberformatter_format_339880429.md index cb498205e0..73e8ba291e 100644 --- a/windows.globalization.numberformatting/inumberformatter_format_339880429.md +++ b/windows.globalization.numberformatting/inumberformatter_format_339880429.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter.Format(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberFormatter.Format ## -description Returns a string representation of a **Double** value. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also [Format(Int64)](inumberformatter_format_796110984.md), [Format(UInt64)](inumberformatter_format_77898908.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter.Format(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatter.Format + +## -description +Returns a string representation of a **Double** value. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](inumberformatter_format_796110984.md), [Format(UInt64)](inumberformatter_format_77898908.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/inumberformatter_format_77898908.md b/windows.globalization.numberformatting/inumberformatter_format_77898908.md index ac4a3ded33..f299f84ef7 100644 --- a/windows.globalization.numberformatting/inumberformatter_format_77898908.md +++ b/windows.globalization.numberformatting/inumberformatter_format_77898908.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter.Format(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberFormatter.Format ## -description Returns a string representation of a **UInt64** value. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also [Format(Int64)](inumberformatter_format_796110984.md), [Format(Double)](inumberformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter.Format(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatter.Format + +## -description +Returns a string representation of a **UInt64** value. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](inumberformatter_format_796110984.md), [Format(Double)](inumberformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/inumberformatter_format_796110984.md b/windows.globalization.numberformatting/inumberformatter_format_796110984.md index ce25867eac..7adddbeaf4 100644 --- a/windows.globalization.numberformatting/inumberformatter_format_796110984.md +++ b/windows.globalization.numberformatting/inumberformatter_format_796110984.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter.Format(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberFormatter.Format ## -description Returns a string representation of an **Int64** value. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the value. ## -remarks ## -examples ## -see-also [Format(UInt64)](inumberformatter_format_77898908.md), [Format(Double)](inumberformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberFormatter.Format(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatter.Format + +## -description +Returns a string representation of an **Int64** value. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the value. + +## -remarks + +## -examples + +## -see-also +[Format(UInt64)](inumberformatter_format_77898908.md), [Format(Double)](inumberformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/inumberformatteroptions_fractiondigits.md b/windows.globalization.numberformatting/inumberformatteroptions_fractiondigits.md index b07a556d7f..dbcbe5f979 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_fractiondigits.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_fractiondigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.FractionDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.FractionDigits ## -description Gets or sets the minimum number of digits to display for the fraction part of the number. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.FractionDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.FractionDigits + +## -description +Gets or sets the minimum number of digits to display for the fraction part of the number. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_geographicregion.md b/windows.globalization.numberformatting/inumberformatteroptions_geographicregion.md index c8d05e7de9..2373009e93 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_geographicregion.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.GeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.GeographicRegion ## -description Gets the region that is used when formatting and parsing numbers. ## -property-value The region that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.GeographicRegion + +## -description +Gets the region that is used when formatting and parsing numbers. + +## -property-value +The region that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_integerdigits.md b/windows.globalization.numberformatting/inumberformatteroptions_integerdigits.md index 5bb3d70bf0..07839314c4 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_integerdigits.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_integerdigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.IntegerDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.IntegerDigits ## -description Gets or sets the minimum number of digits to display for the integer part of the number. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.IntegerDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.IntegerDigits + +## -description +Gets or sets the minimum number of digits to display for the integer part of the number. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_isdecimalpointalwaysdisplayed.md b/windows.globalization.numberformatting/inumberformatteroptions_isdecimalpointalwaysdisplayed.md index 3cd3d174fd..663fa43a53 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_isdecimalpointalwaysdisplayed.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_isdecimalpointalwaysdisplayed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsDecimalPointAlwaysDisplayed --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsDecimalPointAlwaysDisplayed ## -description Gets or sets whether the decimal point of the number should always be displayed. ## -property-value **True** if the decimal point of the number should always be displayed, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsDecimalPointAlwaysDisplayed +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsDecimalPointAlwaysDisplayed + +## -description +Gets or sets whether the decimal point of the number should always be displayed. + +## -property-value + **True** if the decimal point of the number should always be displayed, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_isgrouped.md b/windows.globalization.numberformatting/inumberformatteroptions_isgrouped.md index 2e17ef57e6..c81945d558 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_isgrouped.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_isgrouped.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsGrouped --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsGrouped ## -description Gets or sets whether the integer part of the number should be grouped. ## -property-value **True** if the integer part of the number should be grouped, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsGrouped +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.IsGrouped + +## -description +Gets or sets whether the integer part of the number should be grouped. + +## -property-value + **True** if the integer part of the number should be grouped, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_languages.md b/windows.globalization.numberformatting/inumberformatteroptions_languages.md index 2c1386d004..f82d8a587f 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_languages.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_languages.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.Languages --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.Languages ## -description Gets the priority list of language identifiers that is used when formatting and parsing numbers. ## -property-value The priority list of language identifiers. ## -remarks If your app passes language tags from this interface to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting and parsing numbers. + +## -property-value +The priority list of language identifiers. + +## -remarks +If your app passes language tags from this interface to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_numeralsystem.md b/windows.globalization.numberformatting/inumberformatteroptions_numeralsystem.md index 87fd4a9cfd..af70055c45 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_numeralsystem.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_numeralsystem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.NumeralSystem ## -description Gets or sets the numbering system that is used to format and parse numbers. ## -property-value A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.NumeralSystem + +## -description +Gets or sets the numbering system that is used to format and parse numbers. + +## -property-value +A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization.numberformatting/inumberformatteroptions_resolvedgeographicregion.md b/windows.globalization.numberformatting/inumberformatteroptions_resolvedgeographicregion.md index 5a44d39715..d23f95645e 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_resolvedgeographicregion.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_resolvedgeographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedGeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedGeographicRegion ## -description Gets the geographic region that was most recently used to format or parse numbers. ## -property-value The geographic region that was most recently used to format or parse numbers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedGeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedGeographicRegion + +## -description +Gets the geographic region that was most recently used to format or parse numbers. + +## -property-value +The geographic region that was most recently used to format or parse numbers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberformatteroptions_resolvedlanguage.md b/windows.globalization.numberformatting/inumberformatteroptions_resolvedlanguage.md index e4b2962b1d..6894a0030a 100644 --- a/windows.globalization.numberformatting/inumberformatteroptions_resolvedlanguage.md +++ b/windows.globalization.numberformatting/inumberformatteroptions_resolvedlanguage.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedLanguage ## -description Gets the language that was most recently used to format or parse numbers. ## -property-value The language from the [priority list of language identifiers](inumberformatteroptions_languages.md) that was most recently used to format or parse numbers. ## -remarks If your app passes language tags from this interface to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberFormatterOptions.ResolvedLanguage + +## -description +Gets the language that was most recently used to format or parse numbers. + +## -property-value +The language from the [priority list of language identifiers](inumberformatteroptions_languages.md) that was most recently used to format or parse numbers. + +## -remarks +If your app passes language tags from this interface to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberparser_parsedouble.md b/windows.globalization.numberformatting/inumberparser_parsedouble.md index 29e22bcdb6..9fb38ef649 100644 --- a/windows.globalization.numberformatting/inumberparser_parsedouble.md +++ b/windows.globalization.numberformatting/inumberparser_parsedouble.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberParser.ParseDouble(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberParser.ParseDouble ## -description Attempts to parse a string representation of a **Double** numeric value. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **Double** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberParser.ParseDouble(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberParser.ParseDouble + +## -description +Attempts to parse a string representation of a **Double** numeric value. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **Double** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberparser_parseint.md b/windows.globalization.numberformatting/inumberparser_parseint.md index 7384bac3dd..986fe709da 100644 --- a/windows.globalization.numberformatting/inumberparser_parseint.md +++ b/windows.globalization.numberformatting/inumberparser_parseint.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberParser.ParseInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberParser.ParseInt ## -description Attempts to parse a string representation of an integer numeric value. ## -parameters ### -param text The text to be parsed. ## -returns If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberParser.ParseInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberParser.ParseInt + +## -description +Attempts to parse a string representation of an integer numeric value. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberparser_parseuint.md b/windows.globalization.numberformatting/inumberparser_parseuint.md index 80f66b6d7e..78a2f0d4ff 100644 --- a/windows.globalization.numberformatting/inumberparser_parseuint.md +++ b/windows.globalization.numberformatting/inumberparser_parseuint.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberParser.ParseUInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberParser.ParseUInt ## -description Attempts to parse a string representation of an unsigned integer numeric value. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberParser.ParseUInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberParser.ParseUInt + +## -description +Attempts to parse a string representation of an unsigned integer numeric value. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounder_rounddouble.md b/windows.globalization.numberformatting/inumberrounder_rounddouble.md index a36fd2aaff..92aafaebfb 100644 --- a/windows.globalization.numberformatting/inumberrounder_rounddouble.md +++ b/windows.globalization.numberformatting/inumberrounder_rounddouble.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberRounder.RoundDouble ## -description Rounds a **Double** number. ## -parameters ### -param value The **Double** value to be rounded. ## -returns The rounded number. This result is a double precision floating point number, which is not necessarily an integer. ## -remarks > [!NOTE] > This method is precise only within the limits of the [Double](https://msdn.microsoft.com/library/system.double.aspx) data type: approximately 15 digits. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounder.RoundDouble + +## -description +Rounds a **Double** number. + +## -parameters +### -param value +The **Double** value to be rounded. + +## -returns +The rounded number. This result is a double precision floating point number, which is not necessarily an integer. + +## -remarks +> [!NOTE] +> This method is precise only within the limits of the [Double](https://msdn.microsoft.com/library/system.double.aspx) data type: approximately 15 digits. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounder_roundint32.md b/windows.globalization.numberformatting/inumberrounder_roundint32.md index 2d4e4e48d7..b09e4a0414 100644 --- a/windows.globalization.numberformatting/inumberrounder_roundint32.md +++ b/windows.globalization.numberformatting/inumberrounder_roundint32.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundInt32(System.Int32) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberRounder.RoundInt32 ## -description Rounds an **Int32** number. ## -parameters ### -param value The **Int32** value to be rounded. ## -returns The rounded 32 bit integer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundInt32(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounder.RoundInt32 + +## -description +Rounds an **Int32** number. + +## -parameters +### -param value +The **Int32** value to be rounded. + +## -returns +The rounded 32 bit integer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounder_roundint64.md b/windows.globalization.numberformatting/inumberrounder_roundint64.md index a4df75f4dd..3a21ab5796 100644 --- a/windows.globalization.numberformatting/inumberrounder_roundint64.md +++ b/windows.globalization.numberformatting/inumberrounder_roundint64.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundInt64(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberRounder.RoundInt64 ## -description Rounds an **Int64** number. ## -parameters ### -param value The **Int64** value to be rounded. ## -returns The rounded 64 bit integer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundInt64(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounder.RoundInt64 + +## -description +Rounds an **Int64** number. + +## -parameters +### -param value +The **Int64** value to be rounded. + +## -returns +The rounded 64 bit integer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounder_roundsingle.md b/windows.globalization.numberformatting/inumberrounder_roundsingle.md index 425f5e4ec7..ee1693aa9b 100644 --- a/windows.globalization.numberformatting/inumberrounder_roundsingle.md +++ b/windows.globalization.numberformatting/inumberrounder_roundsingle.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundSingle(System.Single) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberRounder.RoundSingle ## -description Rounds a **Single** number. ## -parameters ### -param value The **Single** value to be rounded. ## -returns The rounded number. This result is a single precision floating point number, which is not necessarily an integer. ## -remarks > [!NOTE] > This method is precise only within the limits of the **Single** data type: approximately 7 digits. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundSingle(System.Single) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounder.RoundSingle + +## -description +Rounds a **Single** number. + +## -parameters +### -param value +The **Single** value to be rounded. + +## -returns +The rounded number. This result is a single precision floating point number, which is not necessarily an integer. + +## -remarks +> [!NOTE] +> This method is precise only within the limits of the **Single** data type: approximately 7 digits. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounder_rounduint32.md b/windows.globalization.numberformatting/inumberrounder_rounduint32.md index b3bb079dde..7f8ca74562 100644 --- a/windows.globalization.numberformatting/inumberrounder_rounduint32.md +++ b/windows.globalization.numberformatting/inumberrounder_rounduint32.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt32(System.UInt32) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt32 ## -description Rounds a **UInt32** number. ## -parameters ### -param value The **UInt32** value to be rounded. ## -returns The rounded unsigned 32 bit integer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt32(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt32 + +## -description +Rounds a **UInt32** number. + +## -parameters +### -param value +The **UInt32** value to be rounded. + +## -returns +The rounded unsigned 32 bit integer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounder_rounduint64.md b/windows.globalization.numberformatting/inumberrounder_rounduint64.md index 01715a3362..1806ee8740 100644 --- a/windows.globalization.numberformatting/inumberrounder_rounduint64.md +++ b/windows.globalization.numberformatting/inumberrounder_rounduint64.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt64(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt64 ## -description Rounds a **UInt64** number. ## -parameters ### -param value The **UInt64** value to be rounded. ## -returns The rounded unsigned 64 bit integer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt64(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounder.RoundUInt64 + +## -description +Rounds a **UInt64** number. + +## -parameters +### -param value +The **UInt64** value to be rounded. + +## -returns +The rounded unsigned 64 bit integer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/inumberrounderoption_numberrounder.md b/windows.globalization.numberformatting/inumberrounderoption_numberrounder.md index fa3d6c7f3a..38be3f4cc3 100644 --- a/windows.globalization.numberformatting/inumberrounderoption_numberrounder.md +++ b/windows.globalization.numberformatting/inumberrounderoption_numberrounder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.INumberRounderOption.NumberRounder --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.INumberRounderOption.NumberRounder ## -description Gets or sets the interface used to return rounded numbers. ## -property-value An interface for returning rounded numbers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.INumberRounderOption.NumberRounder +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.INumberRounderOption.NumberRounder + +## -description +Gets or sets the interface used to return rounded numbers. + +## -property-value +An interface for returning rounded numbers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/isignedzerooption_iszerosigned.md b/windows.globalization.numberformatting/isignedzerooption_iszerosigned.md index d8b37b8b0f..a961f94240 100644 --- a/windows.globalization.numberformatting/isignedzerooption_iszerosigned.md +++ b/windows.globalization.numberformatting/isignedzerooption_iszerosigned.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.ISignedZeroOption.IsZeroSigned --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.ISignedZeroOption.IsZeroSigned ## -description Gets or sets whether -0 is formatted as "-0" or "0". ## -property-value **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". ## -remarks You can set this property to specify that a formatter class display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.ISignedZeroOption.IsZeroSigned +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.ISignedZeroOption.IsZeroSigned + +## -description +Gets or sets whether -0 is formatted as "-0" or "0". + +## -property-value + **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". + +## -remarks +You can set this property to specify that a formatter class display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). + +This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/isignificantdigitsoption_significantdigits.md b/windows.globalization.numberformatting/isignificantdigitsoption_significantdigits.md index 0da7f0d837..1682718608 100644 --- a/windows.globalization.numberformatting/isignificantdigitsoption_significantdigits.md +++ b/windows.globalization.numberformatting/isignificantdigitsoption_significantdigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.ISignificantDigitsOption.SignificantDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.ISignificantDigitsOption.SignificantDigits ## -description Gets or sets the number of significant digits used in formatting or rounding numbers. ## -property-value The number of significant digits. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.ISignificantDigitsOption.SignificantDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.ISignificantDigitsOption.SignificantDigits + +## -description +Gets or sets the number of significant digits used in formatting or rounding numbers. + +## -property-value +The number of significant digits. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/numeralsystemtranslator.md b/windows.globalization.numberformatting/numeralsystemtranslator.md index 563f001445..e4bf1f57c5 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Globalization.NumberFormatting.NumeralSystemTranslator --api-type: winrt class ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator ## -description Translates digits of the Latin numerical system into digits of another numerical system. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumberFormatting.NumeralSystemTranslator +-api-type: winrt class +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator + +## -description +Translates digits of the Latin numerical system into digits of another numerical system. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file diff --git a/windows.globalization.numberformatting/numeralsystemtranslator_languages.md b/windows.globalization.numberformatting/numeralsystemtranslator_languages.md index 42a2834927..38a25a29d3 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator_languages.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator_languages.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.Languages --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator.Languages ## -description Gets the [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag(s) used to initialize this [NumeralSystemTranslator](numeralsystemtranslator.md) object. ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag(s) used to initialize this [NumeralSystemTranslator](numeralsystemtranslator.md) object. There is always at least one. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator.Languages + +## -description +Gets the [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag(s) used to initialize this [NumeralSystemTranslator](numeralsystemtranslator.md) object. + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag(s) used to initialize this [NumeralSystemTranslator](numeralsystemtranslator.md) object. There is always at least one. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystem.md b/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystem.md index c4299ac358..27afebdc03 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystem.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystem.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystem ## -description Gets or sets the numeral system that Latin digits will be converted to on calls to [TranslateNumerals](numeralsystemtranslator_translatenumerals.md). ## -property-value A string that indicates the target numeral system of the translator, such as "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks > [!NOTE] > For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). + A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). + A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). + A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystem + +## -description +Gets or sets the numeral system that Latin digits will be converted to on calls to [TranslateNumerals](numeralsystemtranslator_translatenumerals.md). + +## -property-value +A string that indicates the target numeral system of the translator, such as "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks +> [!NOTE] +> For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). ++ A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). ++ A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). ++ A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). + + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1181929246.md b/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1181929246.md index b9211f200a..91a964af2e 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1181929246.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1181929246.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.#ctor(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystemTranslator ## -description Creates a [NumeralSystemTranslator](numeralsystemtranslator.md) object initialized by a language list. ## -parameters ### -param languages A list of [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tags, in priority order, representing the choice of languages. They must all be well-formed according to [Windows.Globalization.Language.isWellFormed](../windows.globalization/language_iswellformed.md). ## -remarks This constructor creates an object initialized to use the default numeral system of the first language in *languages* which is known to the system. If none are known, it uses the current runtime language preferred by the user. If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [NumeralSystemTranslator()](numeralsystemtranslator_numeralsystemtranslator_1221375020.md), [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.#ctor(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystemTranslator + +## -description +Creates a [NumeralSystemTranslator](numeralsystemtranslator.md) object initialized by a language list. + +## -parameters +### -param languages +A list of [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tags, in priority order, representing the choice of languages. They must all be well-formed according to [Windows.Globalization.Language.isWellFormed](../windows.globalization/language_iswellformed.md). + +## -remarks +This constructor creates an object initialized to use the default numeral system of the first language in *languages* which is known to the system. If none are known, it uses the current runtime language preferred by the user. + +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[NumeralSystemTranslator()](numeralsystemtranslator_numeralsystemtranslator_1221375020.md), [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1221375020.md b/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1221375020.md index dc6869923a..cb23e38c25 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1221375020.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator_numeralsystemtranslator_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.#ctor --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystemTranslator ## -description Creates a [NumeralSystemTranslator](numeralsystemtranslator.md) object initialized by the list of current runtime language values preferred by the user. ## -remarks This default constructor is equivalent to the use of [NumeralSystemTranslator](numeralsystemtranslator_numeralsystemtranslator_1181929246.md) ([Windows.Globalization.ApplicationLanguages.languages](../windows.globalization/applicationlanguages_languages.md)). ## -examples ## -see-also [NumeralSystemTranslator(IIterable(String))](numeralsystemtranslator_numeralsystemtranslator_1181929246.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator.NumeralSystemTranslator + +## -description +Creates a [NumeralSystemTranslator](numeralsystemtranslator.md) object initialized by the list of current runtime language values preferred by the user. + +## -remarks +This default constructor is equivalent to the use of [NumeralSystemTranslator](numeralsystemtranslator_numeralsystemtranslator_1181929246.md) ([Windows.Globalization.ApplicationLanguages.languages](../windows.globalization/applicationlanguages_languages.md)). + +## -examples + +## -see-also +[NumeralSystemTranslator(IIterable(String))](numeralsystemtranslator_numeralsystemtranslator_1181929246.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/numeralsystemtranslator_resolvedlanguage.md b/windows.globalization.numberformatting/numeralsystemtranslator_resolvedlanguage.md index bfbe224bbf..80fd928f11 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator_resolvedlanguage.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator_resolvedlanguage.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator.ResolvedLanguage ## -description Gets the language used to determine the numeral system when this object was initialized. ## -property-value The particular [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag used during the construction of this object to determine the initial value of [NumeralSystem](numeralsystemtranslator_numeralsystem.md). ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also [NumeralSystem](numeralsystemtranslator_numeralsystem.md), [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator.ResolvedLanguage + +## -description +Gets the language used to determine the numeral system when this object was initialized. + +## -property-value +The particular [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag used during the construction of this object to determine the initial value of [NumeralSystem](numeralsystemtranslator_numeralsystem.md). + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also +[NumeralSystem](numeralsystemtranslator_numeralsystem.md), [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization.numberformatting/numeralsystemtranslator_translatenumerals_1419744509.md b/windows.globalization.numberformatting/numeralsystemtranslator_translatenumerals_1419744509.md index e6ae904edd..015bbe55f9 100644 --- a/windows.globalization.numberformatting/numeralsystemtranslator_translatenumerals_1419744509.md +++ b/windows.globalization.numberformatting/numeralsystemtranslator_translatenumerals_1419744509.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.TranslateNumerals(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.NumeralSystemTranslator.TranslateNumerals ## -description Converts a string of characters containing Latin digits to a string containing the corresponding digits of [NumeralSystem](numeralsystemtranslator_numeralsystem.md). ## -parameters ### -param value A string of characters containing Latin digits to be converted. ## -returns A string containing the converted digits. This string may be a different length than *value*. ## -remarks Characters in *value* that are not Latin digits are not converted, but pass through unchanged. If *value* is **null** (representing an empty string) the result is **null**. If [NumeralSystem](numeralsystemtranslator_numeralsystem.md) is "Latn", *value* is passed through unchanged. > [!NOTE] > For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). + A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). + A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). + A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). ## -examples ## -see-also [NumeralSystem](numeralsystemtranslator_numeralsystem.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.NumeralSystemTranslator.TranslateNumerals(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.NumeralSystemTranslator.TranslateNumerals + +## -description +Converts a string of characters containing Latin digits to a string containing the corresponding digits of [NumeralSystem](numeralsystemtranslator_numeralsystem.md). + +## -parameters +### -param value +A string of characters containing Latin digits to be converted. + +## -returns +A string containing the converted digits. This string may be a different length than *value*. + +## -remarks +Characters in *value* that are not Latin digits are not converted, but pass through unchanged. If *value* is **null** (representing an empty string) the result is **null**. If [NumeralSystem](numeralsystemtranslator_numeralsystem.md) is "Latn", *value* is passed through unchanged. + +> [!NOTE] +> For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). ++ A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). ++ A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). ++ A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). + + +## -examples + +## -see-also +[NumeralSystem](numeralsystemtranslator_numeralsystem.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter.md b/windows.globalization.numberformatting/percentformatter.md index c53f15b468..329f3b720a 100644 --- a/windows.globalization.numberformatting/percentformatter.md +++ b/windows.globalization.numberformatting/percentformatter.md @@ -1,3 +1,127 @@ ---- -api-id: T:Windows.Globalization.NumberFormatting.PercentFormatter --api-type: winrt class ---- # Windows.Globalization.NumberFormatting.PercentFormatter ## -description Formats and parses percentages. ## -remarks > [!NOTE] > If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ```javascript // This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and // the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers // as a percent or a permille. // Create formatters initialized using the current user's preference settings. var percentFormat = new Windows.Globalization.NumberFormatting.PercentFormatter(); var permilleFormat = new Windows.Globalization.NumberFormatting.PermilleFormatter(); // Make a random number. var randomNumber = Math.random(); // Format with current user preferences. var percent = percentFormat.format(randomNumber); var permille = permilleFormat.format(randomNumber); // Get a fixed number. var fixedNumber = 500; // Format with grouping using default. var percentFormat1 = new Windows.Globalization.NumberFormatting.PercentFormatter(); percentFormat1.isGrouped = true; var percent1 = percentFormat1.format(fixedNumber); // Format with grouping using French. var percentFormatFR = new Windows.Globalization.NumberFormatting.PercentFormatter(["fr-FR"], "FR"); percentFormatFR.isGrouped = true; var percentFR = percentFormatFR.format(fixedNumber); // Format with no fractional digits using default. var percentFormat2 = new Windows.Globalization.NumberFormatting.PercentFormatter(); percentFormat2.fractionDigits = 0; var percent2 = percentFormat2.format(fixedNumber); // Format always with a decimal point. var percentFormat3 = new Windows.Globalization.NumberFormatting.PercentFormatter(); percentFormat3.isDecimalPointAlwaysDisplayed = true; percentFormat3.fractionDigits = 0; var percent3 = percentFormat3.format(fixedNumber); // Display the results. var results = "Random number (" + randomNumber + ")\n" + "Percent formatted: " + percent + "\n" + "Permille formatted: " + permille + "\n\n" + "Fixed number (" + fixedNumber + ")\n" + "Percent formatted (grouped): " + percent1 + "\n" + "Percent formatted (grouped as fr-FR): " + percentFR + "\n" + "Percent formatted (no fractional digits): " + percent2 + "\n" + "Percent formatted (always with a decimal point): " + percent3; ``` ```csharp // This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and // the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers // as a percent or a permille. //using System.Text; //using Windows.Globalization.NumberFormatting; StringBuilder sb = new StringBuilder(); // Create numbers to format. double randomNumber = new Random().NextDouble(); ulong fixedNumber = 500; // Create percent formatters. PercentFormatter defaultPercentFormatter = new PercentFormatter(); PercentFormatter languagePercentFormatter = new PercentFormatter(new[] { "fr-FR" }, "ZZ"); // Create permille formatters. PermilleFormatter defaultPermilleFormatter = new PermilleFormatter(); PermilleFormatter languagePermilleFormatter = new PermilleFormatter(new[] { "ar" }, "ZZ"); // Format random numbers as percent or permille. sb.AppendLine("Random number: " + randomNumber); sb.AppendLine("Percent formatted: " + defaultPercentFormatter.Format(randomNumber)); sb.AppendLine("Permille formatted: " + defaultPermilleFormatter.Format(randomNumber)); sb.AppendLine(); sb.AppendLine("Language-specific percent formatted: " + languagePercentFormatter.Format(randomNumber)); sb.AppendLine("Language-specific permille formatted: " + languagePermilleFormatter.Format(randomNumber)); sb.AppendLine(); sb.AppendLine("Fixed number: " + fixedNumber); // Format fixed number with grouping. defaultPercentFormatter.IsGrouped = true; sb.AppendLine("Percent formatted (grouped): " + defaultPercentFormatter.Format(fixedNumber)); //Format with grouping using French language. languagePercentFormatter.IsGrouped = true; sb.AppendLine("Percent formatted (grouped as fr-FR): " + defaultPercentFormatter.Format(fixedNumber)); // Format with no fraction digits. defaultPercentFormatter.FractionDigits = 0; sb.AppendLine("Percent formatted (no fractional digits): " + defaultPercentFormatter.Format(fixedNumber)); // Format always with a decimal point. defaultPercentFormatter.IsDecimalPointAlwaysDisplayed = true; sb.AppendLine("Percent formatted (always with a decimal point): " + defaultPercentFormatter.Format(fixedNumber)); ``` ## -see-also [Number formatting and parsing sample](http://go.microsoft.com/fwlink/p/?linkid=231620), [INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumberFormatting.PercentFormatter +-api-type: winrt class +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter + +## -description +Formats and parses percentages. + +## -remarks +> [!NOTE] +> If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + + +```javascript +// This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and +// the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers +// as a percent or a permille. + +// Create formatters initialized using the current user's preference settings. +var percentFormat = new Windows.Globalization.NumberFormatting.PercentFormatter(); +var permilleFormat = new Windows.Globalization.NumberFormatting.PermilleFormatter(); + +// Make a random number. +var randomNumber = Math.random(); + +// Format with current user preferences. +var percent = percentFormat.format(randomNumber); +var permille = permilleFormat.format(randomNumber); + +// Get a fixed number. +var fixedNumber = 500; + +// Format with grouping using default. +var percentFormat1 = new Windows.Globalization.NumberFormatting.PercentFormatter(); +percentFormat1.isGrouped = true; +var percent1 = percentFormat1.format(fixedNumber); + +// Format with grouping using French. +var percentFormatFR = new Windows.Globalization.NumberFormatting.PercentFormatter(["fr-FR"], "FR"); +percentFormatFR.isGrouped = true; +var percentFR = percentFormatFR.format(fixedNumber); + +// Format with no fractional digits using default. +var percentFormat2 = new Windows.Globalization.NumberFormatting.PercentFormatter(); +percentFormat2.fractionDigits = 0; +var percent2 = percentFormat2.format(fixedNumber); + +// Format always with a decimal point. +var percentFormat3 = new Windows.Globalization.NumberFormatting.PercentFormatter(); +percentFormat3.isDecimalPointAlwaysDisplayed = true; +percentFormat3.fractionDigits = 0; +var percent3 = percentFormat3.format(fixedNumber); + +// Display the results. +var results = "Random number (" + randomNumber + ")\n" + + "Percent formatted: " + percent + "\n" + + "Permille formatted: " + permille + "\n\n" + + "Fixed number (" + fixedNumber + ")\n" + + "Percent formatted (grouped): " + percent1 + "\n" + + "Percent formatted (grouped as fr-FR): " + percentFR + "\n" + + "Percent formatted (no fractional digits): " + percent2 + "\n" + + "Percent formatted (always with a decimal point): " + percent3; +``` + + + +```csharp +// This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and +// the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers +// as a percent or a permille. + +//using System.Text; +//using Windows.Globalization.NumberFormatting; + +StringBuilder sb = new StringBuilder(); + +// Create numbers to format. +double randomNumber = new Random().NextDouble(); +ulong fixedNumber = 500; + +// Create percent formatters. +PercentFormatter defaultPercentFormatter = new PercentFormatter(); +PercentFormatter languagePercentFormatter = new PercentFormatter(new[] { "fr-FR" }, "ZZ"); + +// Create permille formatters. +PermilleFormatter defaultPermilleFormatter = new PermilleFormatter(); +PermilleFormatter languagePermilleFormatter = new PermilleFormatter(new[] { "ar" }, "ZZ"); + +// Format random numbers as percent or permille. +sb.AppendLine("Random number: " + randomNumber); +sb.AppendLine("Percent formatted: " + defaultPercentFormatter.Format(randomNumber)); +sb.AppendLine("Permille formatted: " + defaultPermilleFormatter.Format(randomNumber)); +sb.AppendLine(); +sb.AppendLine("Language-specific percent formatted: " + languagePercentFormatter.Format(randomNumber)); +sb.AppendLine("Language-specific permille formatted: " + languagePermilleFormatter.Format(randomNumber)); +sb.AppendLine(); +sb.AppendLine("Fixed number: " + fixedNumber); + +// Format fixed number with grouping. +defaultPercentFormatter.IsGrouped = true; +sb.AppendLine("Percent formatted (grouped): " + defaultPercentFormatter.Format(fixedNumber)); + +//Format with grouping using French language. +languagePercentFormatter.IsGrouped = true; +sb.AppendLine("Percent formatted (grouped as fr-FR): " + defaultPercentFormatter.Format(fixedNumber)); + +// Format with no fraction digits. +defaultPercentFormatter.FractionDigits = 0; +sb.AppendLine("Percent formatted (no fractional digits): " + defaultPercentFormatter.Format(fixedNumber)); + +// Format always with a decimal point. +defaultPercentFormatter.IsDecimalPointAlwaysDisplayed = true; +sb.AppendLine("Percent formatted (always with a decimal point): " + defaultPercentFormatter.Format(fixedNumber)); +``` + + + +## -see-also +[Number formatting and parsing sample](http://go.microsoft.com/fwlink/p/?linkid=231620), [INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_format_339880429.md b/windows.globalization.numberformatting/percentformatter_format_339880429.md index 7770179b70..97ab7b6bb4 100644 --- a/windows.globalization.numberformatting/percentformatter_format_339880429.md +++ b/windows.globalization.numberformatting/percentformatter_format_339880429.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.Format(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.Format ## -description Returns a string representation of a **Double** percentage. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the percentage. ## -remarks ## -examples ## -see-also [Format(Int64)](percentformatter_format_796110984.md), [Format(UInt64)](percentformatter_format_77898908.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.Format(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.Format + +## -description +Returns a string representation of a **Double** percentage. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the percentage. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](percentformatter_format_796110984.md), [Format(UInt64)](percentformatter_format_77898908.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_format_77898908.md b/windows.globalization.numberformatting/percentformatter_format_77898908.md index def1395bf3..228cad417a 100644 --- a/windows.globalization.numberformatting/percentformatter_format_77898908.md +++ b/windows.globalization.numberformatting/percentformatter_format_77898908.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.Format(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.Format ## -description Returns a string representation of a **UInt64** percentage. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the percentage. ## -remarks ## -examples ## -see-also [Format(Int64)](percentformatter_format_796110984.md), [Format(Double)](percentformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.Format(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.Format + +## -description +Returns a string representation of a **UInt64** percentage. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the percentage. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](percentformatter_format_796110984.md), [Format(Double)](percentformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_format_796110984.md b/windows.globalization.numberformatting/percentformatter_format_796110984.md index 80a9bb7f54..a34d5a3d19 100644 --- a/windows.globalization.numberformatting/percentformatter_format_796110984.md +++ b/windows.globalization.numberformatting/percentformatter_format_796110984.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.Format(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.Format ## -description Returns a string representation of an **Int64** percentage. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the percentage. ## -remarks ## -examples ## -see-also [Format(UInt64)](percentformatter_format_77898908.md), [Format(Double)](percentformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.Format(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.Format + +## -description +Returns a string representation of an **Int64** percentage. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the percentage. + +## -remarks + +## -examples + +## -see-also +[Format(UInt64)](percentformatter_format_77898908.md), [Format(Double)](percentformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_formatdouble_438054348.md b/windows.globalization.numberformatting/percentformatter_formatdouble_438054348.md index 5e4bd07063..6db1ca2f19 100644 --- a/windows.globalization.numberformatting/percentformatter_formatdouble_438054348.md +++ b/windows.globalization.numberformatting/percentformatter_formatdouble_438054348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.FormatDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.FormatDouble ## -description Returns a string representation of a **Double** percentage. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the percentage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.FormatDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.FormatDouble + +## -description +Returns a string representation of a **Double** percentage. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the percentage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_formatint_65483418.md b/windows.globalization.numberformatting/percentformatter_formatint_65483418.md index 8bc5717458..a530a05a6f 100644 --- a/windows.globalization.numberformatting/percentformatter_formatint_65483418.md +++ b/windows.globalization.numberformatting/percentformatter_formatint_65483418.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.FormatInt(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.FormatInt ## -description Returns a string representation of an **Int64** percentage. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the percentage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.FormatInt(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.FormatInt + +## -description +Returns a string representation of an **Int64** percentage. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the percentage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_formatuint_382789512.md b/windows.globalization.numberformatting/percentformatter_formatuint_382789512.md index 3dc699e45b..2853ea4d87 100644 --- a/windows.globalization.numberformatting/percentformatter_formatuint_382789512.md +++ b/windows.globalization.numberformatting/percentformatter_formatuint_382789512.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.FormatUInt(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.FormatUInt ## -description Returns a string representation of a **UInt64** percentage. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the percentage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.FormatUInt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.FormatUInt + +## -description +Returns a string representation of a **UInt64** percentage. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the percentage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_fractiondigits.md b/windows.globalization.numberformatting/percentformatter_fractiondigits.md index 41635ea41a..cec95815eb 100644 --- a/windows.globalization.numberformatting/percentformatter_fractiondigits.md +++ b/windows.globalization.numberformatting/percentformatter_fractiondigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.FractionDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.FractionDigits ## -description Gets or sets the minimum number of digits to display for the fraction part of the percentage. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.FractionDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.FractionDigits + +## -description +Gets or sets the minimum number of digits to display for the fraction part of the percentage. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_geographicregion.md b/windows.globalization.numberformatting/percentformatter_geographicregion.md index 64f8e63402..f6ecfec377 100644 --- a/windows.globalization.numberformatting/percentformatter_geographicregion.md +++ b/windows.globalization.numberformatting/percentformatter_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.GeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.GeographicRegion ## -description Gets the region that is used when formatting and parsing percentages. ## -property-value The region that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.GeographicRegion + +## -description +Gets the region that is used when formatting and parsing percentages. + +## -property-value +The region that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_integerdigits.md b/windows.globalization.numberformatting/percentformatter_integerdigits.md index a2a1ed744f..68aa2062b3 100644 --- a/windows.globalization.numberformatting/percentformatter_integerdigits.md +++ b/windows.globalization.numberformatting/percentformatter_integerdigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IntegerDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.IntegerDigits ## -description Gets or sets the minimum number of digits to display for the integer part of the percentage. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IntegerDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.IntegerDigits + +## -description +Gets or sets the minimum number of digits to display for the integer part of the percentage. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_isdecimalpointalwaysdisplayed.md b/windows.globalization.numberformatting/percentformatter_isdecimalpointalwaysdisplayed.md index 1efc9649cd..c1c8271e3d 100644 --- a/windows.globalization.numberformatting/percentformatter_isdecimalpointalwaysdisplayed.md +++ b/windows.globalization.numberformatting/percentformatter_isdecimalpointalwaysdisplayed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IsDecimalPointAlwaysDisplayed --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.IsDecimalPointAlwaysDisplayed ## -description Gets or sets whether the decimal point of the percentage should always be displayed. ## -property-value **True** if the decimal point of the percentage should always be displayed, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IsDecimalPointAlwaysDisplayed +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.IsDecimalPointAlwaysDisplayed + +## -description +Gets or sets whether the decimal point of the percentage should always be displayed. + +## -property-value + **True** if the decimal point of the percentage should always be displayed, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_isgrouped.md b/windows.globalization.numberformatting/percentformatter_isgrouped.md index 94b9878a8f..eda0b2edb1 100644 --- a/windows.globalization.numberformatting/percentformatter_isgrouped.md +++ b/windows.globalization.numberformatting/percentformatter_isgrouped.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IsGrouped --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.IsGrouped ## -description Gets or sets whether the integer part of the percentage should be grouped. ## -property-value **True** if the integer part of the percentage should be grouped, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IsGrouped +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.IsGrouped + +## -description +Gets or sets whether the integer part of the percentage should be grouped. + +## -property-value + **True** if the integer part of the percentage should be grouped, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_iszerosigned.md b/windows.globalization.numberformatting/percentformatter_iszerosigned.md index 71b456ee54..aedac940cd 100644 --- a/windows.globalization.numberformatting/percentformatter_iszerosigned.md +++ b/windows.globalization.numberformatting/percentformatter_iszerosigned.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IsZeroSigned --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.IsZeroSigned ## -description Gets or sets whether -0 is formatted as "-0" or "0". ## -property-value **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". ## -remarks You can set this property to specify that [PercentFormatter](percentformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.IsZeroSigned +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.IsZeroSigned + +## -description +Gets or sets whether -0 is formatted as "-0" or "0". + +## -property-value + **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". + +## -remarks +You can set this property to specify that [PercentFormatter](percentformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). + +This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_languages.md b/windows.globalization.numberformatting/percentformatter_languages.md index bdfe790c12..c66bf8d367 100644 --- a/windows.globalization.numberformatting/percentformatter_languages.md +++ b/windows.globalization.numberformatting/percentformatter_languages.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.Languages --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.Languages ## -description Gets the priority list of language identifiers that is used when formatting and parsing percentages. ## -property-value The priority list of language identifiers. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PercentFormatter(IIterable(String), String)](percentformatter_percentformatter_177128098.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting and parsing percentages. + +## -property-value +The priority list of language identifiers. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PercentFormatter(IIterable(String), String)](percentformatter_percentformatter_177128098.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_numberrounder.md b/windows.globalization.numberformatting/percentformatter_numberrounder.md index a322619521..0b2c190f90 100644 --- a/windows.globalization.numberformatting/percentformatter_numberrounder.md +++ b/windows.globalization.numberformatting/percentformatter_numberrounder.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.NumberRounder --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.NumberRounder ## -description Gets or sets the current rounding strategy to be used when formatting percents. ## -property-value A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). ## -remarks When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.NumberRounder +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.NumberRounder + +## -description +Gets or sets the current rounding strategy to be used when formatting percents. + +## -property-value +A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). + +## -remarks +When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_numeralsystem.md b/windows.globalization.numberformatting/percentformatter_numeralsystem.md index a09e1762b5..e160d15865 100644 --- a/windows.globalization.numberformatting/percentformatter_numeralsystem.md +++ b/windows.globalization.numberformatting/percentformatter_numeralsystem.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.NumeralSystem ## -description Gets or sets the numbering system that is used to format and parse percentages. ## -property-value A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks > [!NOTE] > For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). + A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). + A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). + A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.NumeralSystem + +## -description +Gets or sets the numbering system that is used to format and parse percentages. + +## -property-value +A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks +> [!NOTE] +> For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). ++ A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). ++ A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). ++ A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). + + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_parsedouble_1368702614.md b/windows.globalization.numberformatting/percentformatter_parsedouble_1368702614.md index 5857feb578..596102e3bd 100644 --- a/windows.globalization.numberformatting/percentformatter_parsedouble_1368702614.md +++ b/windows.globalization.numberformatting/percentformatter_parsedouble_1368702614.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.ParseDouble(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.ParseDouble ## -description Attempts to parse a string representation of a **Double** percentage. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **Double** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.ParseDouble(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.ParseDouble + +## -description +Attempts to parse a string representation of a **Double** percentage. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **Double** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_parseint_1447535745.md b/windows.globalization.numberformatting/percentformatter_parseint_1447535745.md index 3829d92751..201db255ea 100644 --- a/windows.globalization.numberformatting/percentformatter_parseint_1447535745.md +++ b/windows.globalization.numberformatting/percentformatter_parseint_1447535745.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.ParseInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.ParseInt ## -description Attempts to parse a string representation of an integer percentage. ## -parameters ### -param text The text to be parsed. ## -returns If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.ParseInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.ParseInt + +## -description +Attempts to parse a string representation of an integer percentage. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_parseuint_168772619.md b/windows.globalization.numberformatting/percentformatter_parseuint_168772619.md index 71502fb47e..649de5a27c 100644 --- a/windows.globalization.numberformatting/percentformatter_parseuint_168772619.md +++ b/windows.globalization.numberformatting/percentformatter_parseuint_168772619.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.ParseUInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.ParseUInt ## -description Attempts to parse a string representation of an unsigned integer percentage. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.ParseUInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.ParseUInt + +## -description + Attempts to parse a string representation of an unsigned integer percentage. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_percentformatter_1221375020.md b/windows.globalization.numberformatting/percentformatter_percentformatter_1221375020.md index edbda85908..62e120968a 100644 --- a/windows.globalization.numberformatting/percentformatter_percentformatter_1221375020.md +++ b/windows.globalization.numberformatting/percentformatter_percentformatter_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.#ctor --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.PercentFormatter ## -description Creates a [PercentFormatter](percentformatter.md) object and initializes it to default values. ## -remarks ## -examples ## -see-also [PercentFormatter(IIterable(String), String)](percentformatter_percentformatter_177128098.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.PercentFormatter + +## -description +Creates a [PercentFormatter](percentformatter.md) object and initializes it to default values. + +## -remarks + +## -examples + +## -see-also +[PercentFormatter(IIterable(String), String)](percentformatter_percentformatter_177128098.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_percentformatter_177128098.md b/windows.globalization.numberformatting/percentformatter_percentformatter_177128098.md index 963b4ce249..eb9bb6b576 100644 --- a/windows.globalization.numberformatting/percentformatter_percentformatter_177128098.md +++ b/windows.globalization.numberformatting/percentformatter_percentformatter_177128098.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PercentFormatter.PercentFormatter ## -description Creates a [PercentFormatter](percentformatter.md) object initialized by a language list and a geographic region. ## -parameters ### -param languages The list of language identifiers, in priority order, representing the choice of languages. See Remarks. ### -param geographicRegion The identifier for the geographic region. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [PercentFormatter](percentformatter.md) objects. ## -examples ## -see-also [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PercentFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.PercentFormatter + +## -description +Creates a [PercentFormatter](percentformatter.md) object initialized by a language list and a geographic region. + +## -parameters +### -param languages +The list of language identifiers, in priority order, representing the choice of languages. See Remarks. + +### -param geographicRegion +The identifier for the geographic region. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [PercentFormatter](percentformatter.md) objects. + +## -examples + +## -see-also +[Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.numberformatting/percentformatter_resolvedgeographicregion.md b/windows.globalization.numberformatting/percentformatter_resolvedgeographicregion.md index 4758114fef..bce929bb95 100644 --- a/windows.globalization.numberformatting/percentformatter_resolvedgeographicregion.md +++ b/windows.globalization.numberformatting/percentformatter_resolvedgeographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedGeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedGeographicRegion ## -description Gets the geographic region that was most recently used to format or parse percent values. ## -property-value The geographic region that was most recently used to format or parse percent values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedGeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedGeographicRegion + +## -description +Gets the geographic region that was most recently used to format or parse percent values. + +## -property-value +The geographic region that was most recently used to format or parse percent values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_resolvedlanguage.md b/windows.globalization.numberformatting/percentformatter_resolvedlanguage.md index a917d4d8ea..fbd8cfa309 100644 --- a/windows.globalization.numberformatting/percentformatter_resolvedlanguage.md +++ b/windows.globalization.numberformatting/percentformatter_resolvedlanguage.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedLanguage ## -description Gets the language that was most recently used to format or parse percent values. ## -property-value The language from the [priority list of language identifiers](percentformatter_languages.md) that was most recently used to format or parse percent values. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PercentFormatter(IIterable(String), String)](percentformatter_percentformatter_177128098.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.ResolvedLanguage + +## -description +Gets the language that was most recently used to format or parse percent values. + +## -property-value +The language from the [priority list of language identifiers](percentformatter_languages.md) that was most recently used to format or parse percent values. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PercentFormatter(IIterable(String), String)](percentformatter_percentformatter_177128098.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/percentformatter_significantdigits.md b/windows.globalization.numberformatting/percentformatter_significantdigits.md index 21dea2d36b..34397b4eac 100644 --- a/windows.globalization.numberformatting/percentformatter_significantdigits.md +++ b/windows.globalization.numberformatting/percentformatter_significantdigits.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.SignificantDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PercentFormatter.SignificantDigits ## -description Gets or sets the current padding to significant digits when a percent is formatted. ## -property-value The number of significant digits. ## -remarks Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PercentFormatter.SignificantDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PercentFormatter.SignificantDigits + +## -description +Gets or sets the current padding to significant digits when a percent is formatted. + +## -property-value +The number of significant digits. + +## -remarks +Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter.md b/windows.globalization.numberformatting/permilleformatter.md index e3472726a3..e601efd0f8 100644 --- a/windows.globalization.numberformatting/permilleformatter.md +++ b/windows.globalization.numberformatting/permilleformatter.md @@ -1,3 +1,127 @@ ---- -api-id: T:Windows.Globalization.NumberFormatting.PermilleFormatter --api-type: winrt class ---- # Windows.Globalization.NumberFormatting.PermilleFormatter ## -description Formats and parses permillages. ## -remarks > [!NOTE] > If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ```javascript // This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and // the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers // as a percent or a permille. // Create formatters initialized using the current user's preference settings. var percentFormat = new Windows.Globalization.NumberFormatting.PercentFormatter(); var permilleFormat = new Windows.Globalization.NumberFormatting.PermilleFormatter(); // Make a random number. var randomNumber = Math.random(); // Format with current user preferences. var percent = percentFormat.format(randomNumber); var permille = permilleFormat.format(randomNumber); // Get a fixed number. var fixedNumber = 500; // Format with grouping using default. var percentFormat1 = new Windows.Globalization.NumberFormatting.PercentFormatter(); percentFormat1.isGrouped = true; var percent1 = percentFormat1.format(fixedNumber); // Format with grouping using French. var percentFormatFR = new Windows.Globalization.NumberFormatting.PercentFormatter(["fr-FR"], "FR"); percentFormatFR.isGrouped = true; var percentFR = percentFormatFR.format(fixedNumber); // Format with no fractional digits using default. var percentFormat2 = new Windows.Globalization.NumberFormatting.PercentFormatter(); percentFormat2.fractionDigits = 0; var percent2 = percentFormat2.format(fixedNumber); // Format always with a decimal point. var percentFormat3 = new Windows.Globalization.NumberFormatting.PercentFormatter(); percentFormat3.isDecimalPointAlwaysDisplayed = true; percentFormat3.fractionDigits = 0; var percent3 = percentFormat3.format(fixedNumber); // Display the results. var results = "Random number (" + randomNumber + ")\n" + "Percent formatted: " + percent + "\n" + "Permille formatted: " + permille + "\n\n" + "Fixed number (" + fixedNumber + ")\n" + "Percent formatted (grouped): " + percent1 + "\n" + "Percent formatted (grouped as fr-FR): " + percentFR + "\n" + "Percent formatted (no fractional digits): " + percent2 + "\n" + "Percent formatted (always with a decimal point): " + percent3; ``` ```csharp // This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and // the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers // as a percent or a permille. //using System.Text; //using Windows.Globalization.NumberFormatting; StringBuilder sb = new StringBuilder(); // Create numbers to format. double randomNumber = new Random().NextDouble(); ulong fixedNumber = 500; // Create percent formatters. PercentFormatter defaultPercentFormatter = new PercentFormatter(); PercentFormatter languagePercentFormatter = new PercentFormatter(new[] { "fr-FR" }, "ZZ"); // Create permille formatters. PermilleFormatter defaultPermilleFormatter = new PermilleFormatter(); PermilleFormatter languagePermilleFormatter = new PermilleFormatter(new[] { "ar" }, "ZZ"); // Format random numbers as percent or permille. sb.AppendLine("Random number: " + randomNumber); sb.AppendLine("Percent formatted: " + defaultPercentFormatter.Format(randomNumber)); sb.AppendLine("Permille formatted: " + defaultPermilleFormatter.Format(randomNumber)); sb.AppendLine(); sb.AppendLine("Language-specific percent formatted: " + languagePercentFormatter.Format(randomNumber)); sb.AppendLine("Language-specific permille formatted: " + languagePermilleFormatter.Format(randomNumber)); sb.AppendLine(); sb.AppendLine("Fixed number: " + fixedNumber); // Format fixed number with grouping. defaultPercentFormatter.IsGrouped = true; sb.AppendLine("Percent formatted (grouped): " + defaultPercentFormatter.Format(fixedNumber)); //Format with grouping using French language. languagePercentFormatter.IsGrouped = true; sb.AppendLine("Percent formatted (grouped as fr-FR): " + defaultPercentFormatter.Format(fixedNumber)); // Format with no fraction digits. defaultPercentFormatter.FractionDigits = 0; sb.AppendLine("Percent formatted (no fractional digits): " + defaultPercentFormatter.Format(fixedNumber)); // Format always with a decimal point. defaultPercentFormatter.IsDecimalPointAlwaysDisplayed = true; sb.AppendLine("Percent formatted (always with a decimal point): " + defaultPercentFormatter.Format(fixedNumber)); ``` ## -see-also [Number formatting and parsing sample](http://go.microsoft.com/fwlink/p/?linkid=231620), [INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumberFormatting.PermilleFormatter +-api-type: winrt class +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter + +## -description +Formats and parses permillages. + +## -remarks +> [!NOTE] +> If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + + +```javascript +// This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and +// the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers +// as a percent or a permille. + +// Create formatters initialized using the current user's preference settings. +var percentFormat = new Windows.Globalization.NumberFormatting.PercentFormatter(); +var permilleFormat = new Windows.Globalization.NumberFormatting.PermilleFormatter(); + +// Make a random number. +var randomNumber = Math.random(); + +// Format with current user preferences. +var percent = percentFormat.format(randomNumber); +var permille = permilleFormat.format(randomNumber); + +// Get a fixed number. +var fixedNumber = 500; + +// Format with grouping using default. +var percentFormat1 = new Windows.Globalization.NumberFormatting.PercentFormatter(); +percentFormat1.isGrouped = true; +var percent1 = percentFormat1.format(fixedNumber); + +// Format with grouping using French. +var percentFormatFR = new Windows.Globalization.NumberFormatting.PercentFormatter(["fr-FR"], "FR"); +percentFormatFR.isGrouped = true; +var percentFR = percentFormatFR.format(fixedNumber); + +// Format with no fractional digits using default. +var percentFormat2 = new Windows.Globalization.NumberFormatting.PercentFormatter(); +percentFormat2.fractionDigits = 0; +var percent2 = percentFormat2.format(fixedNumber); + +// Format always with a decimal point. +var percentFormat3 = new Windows.Globalization.NumberFormatting.PercentFormatter(); +percentFormat3.isDecimalPointAlwaysDisplayed = true; +percentFormat3.fractionDigits = 0; +var percent3 = percentFormat3.format(fixedNumber); + +// Display the results. +var results = "Random number (" + randomNumber + ")\n" + + "Percent formatted: " + percent + "\n" + + "Permille formatted: " + permille + "\n\n" + + "Fixed number (" + fixedNumber + ")\n" + + "Percent formatted (grouped): " + percent1 + "\n" + + "Percent formatted (grouped as fr-FR): " + percentFR + "\n" + + "Percent formatted (no fractional digits): " + percent2 + "\n" + + "Percent formatted (always with a decimal point): " + percent3; +``` + + + +```csharp +// This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and +// the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers +// as a percent or a permille. + +//using System.Text; +//using Windows.Globalization.NumberFormatting; + +StringBuilder sb = new StringBuilder(); + +// Create numbers to format. +double randomNumber = new Random().NextDouble(); +ulong fixedNumber = 500; + +// Create percent formatters. +PercentFormatter defaultPercentFormatter = new PercentFormatter(); +PercentFormatter languagePercentFormatter = new PercentFormatter(new[] { "fr-FR" }, "ZZ"); + +// Create permille formatters. +PermilleFormatter defaultPermilleFormatter = new PermilleFormatter(); +PermilleFormatter languagePermilleFormatter = new PermilleFormatter(new[] { "ar" }, "ZZ"); + +// Format random numbers as percent or permille. +sb.AppendLine("Random number: " + randomNumber); +sb.AppendLine("Percent formatted: " + defaultPercentFormatter.Format(randomNumber)); +sb.AppendLine("Permille formatted: " + defaultPermilleFormatter.Format(randomNumber)); +sb.AppendLine(); +sb.AppendLine("Language-specific percent formatted: " + languagePercentFormatter.Format(randomNumber)); +sb.AppendLine("Language-specific permille formatted: " + languagePermilleFormatter.Format(randomNumber)); +sb.AppendLine(); +sb.AppendLine("Fixed number: " + fixedNumber); + +// Format fixed number with grouping. +defaultPercentFormatter.IsGrouped = true; +sb.AppendLine("Percent formatted (grouped): " + defaultPercentFormatter.Format(fixedNumber)); + +//Format with grouping using French language. +languagePercentFormatter.IsGrouped = true; +sb.AppendLine("Percent formatted (grouped as fr-FR): " + defaultPercentFormatter.Format(fixedNumber)); + +// Format with no fraction digits. +defaultPercentFormatter.FractionDigits = 0; +sb.AppendLine("Percent formatted (no fractional digits): " + defaultPercentFormatter.Format(fixedNumber)); + +// Format always with a decimal point. +defaultPercentFormatter.IsDecimalPointAlwaysDisplayed = true; +sb.AppendLine("Percent formatted (always with a decimal point): " + defaultPercentFormatter.Format(fixedNumber)); +``` + + + +## -see-also +[Number formatting and parsing sample](http://go.microsoft.com/fwlink/p/?linkid=231620), [INumberFormatterOptions](inumberformatteroptions.md), [INumberFormatter](inumberformatter.md), [INumberFormatter2](inumberformatter2.md), [INumberParser](inumberparser.md), [ISignificantDigitsOption](isignificantdigitsoption.md), [INumberRounderOption](inumberrounderoption.md), [Number formatting and parsing sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620578) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_format_339880429.md b/windows.globalization.numberformatting/permilleformatter_format_339880429.md index bcd9629eee..ce75d5838a 100644 --- a/windows.globalization.numberformatting/permilleformatter_format_339880429.md +++ b/windows.globalization.numberformatting/permilleformatter_format_339880429.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.Format(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.Format ## -description Returns a string representation of a **Double** permillage. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the permillage. ## -remarks ## -examples ## -see-also [Format(Int64)](permilleformatter_format_796110984.md), [Format(UInt64)](permilleformatter_format_77898908.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.Format(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.Format + +## -description +Returns a string representation of a **Double** permillage. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the permillage. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](permilleformatter_format_796110984.md), [Format(UInt64)](permilleformatter_format_77898908.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_format_77898908.md b/windows.globalization.numberformatting/permilleformatter_format_77898908.md index eb12bc77c6..1453427064 100644 --- a/windows.globalization.numberformatting/permilleformatter_format_77898908.md +++ b/windows.globalization.numberformatting/permilleformatter_format_77898908.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.Format(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.Format ## -description Returns a string representation of a **UInt64** permillage. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the permillage. ## -remarks ## -examples ## -see-also [Format(Int64)](permilleformatter_format_796110984.md), [Format(Double)](permilleformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.Format(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.Format + +## -description +Returns a string representation of a **UInt64** permillage. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the permillage. + +## -remarks + +## -examples + +## -see-also +[Format(Int64)](permilleformatter_format_796110984.md), [Format(Double)](permilleformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_format_796110984.md b/windows.globalization.numberformatting/permilleformatter_format_796110984.md index c1b2463146..6aceedba84 100644 --- a/windows.globalization.numberformatting/permilleformatter_format_796110984.md +++ b/windows.globalization.numberformatting/permilleformatter_format_796110984.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.Format(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.Format ## -description Returns a string representation of an **Int64** permillage. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the permillage. ## -remarks ## -examples ## -see-also [Format(UInt64)](permilleformatter_format_77898908.md), [Format(Double)](permilleformatter_format_339880429.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.Format(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.Format + +## -description +Returns a string representation of an **Int64** permillage. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the permillage. + +## -remarks + +## -examples + +## -see-also +[Format(UInt64)](permilleformatter_format_77898908.md), [Format(Double)](permilleformatter_format_339880429.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_formatdouble_438054348.md b/windows.globalization.numberformatting/permilleformatter_formatdouble_438054348.md index faba620fab..1ba5dcdabd 100644 --- a/windows.globalization.numberformatting/permilleformatter_formatdouble_438054348.md +++ b/windows.globalization.numberformatting/permilleformatter_formatdouble_438054348.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.FormatDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.FormatDouble ## -description Returns a string representation of a **Double** permillage. ## -parameters ### -param value The **Double** value to be formatted. ## -returns A string that represents the permillage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.FormatDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.FormatDouble + +## -description +Returns a string representation of a **Double** permillage. + +## -parameters +### -param value +The **Double** value to be formatted. + +## -returns +A string that represents the permillage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_formatint_65483418.md b/windows.globalization.numberformatting/permilleformatter_formatint_65483418.md index 94b5842324..9cb2e0e653 100644 --- a/windows.globalization.numberformatting/permilleformatter_formatint_65483418.md +++ b/windows.globalization.numberformatting/permilleformatter_formatint_65483418.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.FormatInt(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.FormatInt ## -description Returns a string representation of an **Int64** permillage. ## -parameters ### -param value The **Int64** value to be formatted. ## -returns A string that represents the permillage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.FormatInt(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.FormatInt + +## -description +Returns a string representation of an **Int64** permillage. + +## -parameters +### -param value +The **Int64** value to be formatted. + +## -returns +A string that represents the permillage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_formatuint_382789512.md b/windows.globalization.numberformatting/permilleformatter_formatuint_382789512.md index 2fbbcc3ddf..a246641338 100644 --- a/windows.globalization.numberformatting/permilleformatter_formatuint_382789512.md +++ b/windows.globalization.numberformatting/permilleformatter_formatuint_382789512.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.FormatUInt(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.FormatUInt ## -description Returns a string representation of a **UInt64** permillage. ## -parameters ### -param value The **UInt64** value to be formatted. ## -returns A string that represents the permillage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.FormatUInt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.FormatUInt + +## -description +Returns a string representation of a **UInt64** permillage. + +## -parameters +### -param value +The **UInt64** value to be formatted. + +## -returns +A string that represents the permillage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_fractiondigits.md b/windows.globalization.numberformatting/permilleformatter_fractiondigits.md index f991d3f5b1..ac77b356e2 100644 --- a/windows.globalization.numberformatting/permilleformatter_fractiondigits.md +++ b/windows.globalization.numberformatting/permilleformatter_fractiondigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.FractionDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.FractionDigits ## -description Gets or sets the minimum number of digits to display for the fraction part of the permillage. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.FractionDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.FractionDigits + +## -description +Gets or sets the minimum number of digits to display for the fraction part of the permillage. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_geographicregion.md b/windows.globalization.numberformatting/permilleformatter_geographicregion.md index c30b6900b8..ca861c43dc 100644 --- a/windows.globalization.numberformatting/permilleformatter_geographicregion.md +++ b/windows.globalization.numberformatting/permilleformatter_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.GeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.GeographicRegion ## -description Gets the region that is used when formatting and parsing permille values. ## -property-value The region that is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.GeographicRegion + +## -description +Gets the region that is used when formatting and parsing permille values. + +## -property-value +The region that is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_integerdigits.md b/windows.globalization.numberformatting/permilleformatter_integerdigits.md index 5e6962aa9a..148f9f6c4d 100644 --- a/windows.globalization.numberformatting/permilleformatter_integerdigits.md +++ b/windows.globalization.numberformatting/permilleformatter_integerdigits.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IntegerDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.IntegerDigits ## -description Gets or sets the minimum number of digits to display for the integer part of the permillage. ## -property-value The minimum number of digits to display. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IntegerDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.IntegerDigits + +## -description +Gets or sets the minimum number of digits to display for the integer part of the permillage. + +## -property-value +The minimum number of digits to display. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_isdecimalpointalwaysdisplayed.md b/windows.globalization.numberformatting/permilleformatter_isdecimalpointalwaysdisplayed.md index 0cf7d36567..60fd662b25 100644 --- a/windows.globalization.numberformatting/permilleformatter_isdecimalpointalwaysdisplayed.md +++ b/windows.globalization.numberformatting/permilleformatter_isdecimalpointalwaysdisplayed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IsDecimalPointAlwaysDisplayed --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.IsDecimalPointAlwaysDisplayed ## -description Gets or sets whether the decimal point of the permillage should always be displayed. ## -property-value **True** if the decimal point of the permillage should always be displayed, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IsDecimalPointAlwaysDisplayed +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.IsDecimalPointAlwaysDisplayed + +## -description +Gets or sets whether the decimal point of the permillage should always be displayed. + +## -property-value + **True** if the decimal point of the permillage should always be displayed, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_isgrouped.md b/windows.globalization.numberformatting/permilleformatter_isgrouped.md index 77cd43ce9c..d15de4982e 100644 --- a/windows.globalization.numberformatting/permilleformatter_isgrouped.md +++ b/windows.globalization.numberformatting/permilleformatter_isgrouped.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IsGrouped --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.IsGrouped ## -description Gets or sets whether the integer part of the permillage should be grouped. ## -property-value **True** if the integer part of the permillage should be grouped, and **false** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IsGrouped +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.IsGrouped + +## -description +Gets or sets whether the integer part of the permillage should be grouped. + +## -property-value + **True** if the integer part of the permillage should be grouped, and **false** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_iszerosigned.md b/windows.globalization.numberformatting/permilleformatter_iszerosigned.md index 5dd13a3df2..b37c96c769 100644 --- a/windows.globalization.numberformatting/permilleformatter_iszerosigned.md +++ b/windows.globalization.numberformatting/permilleformatter_iszerosigned.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IsZeroSigned --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.IsZeroSigned ## -description Gets or sets whether -0 is formatted as "-0" or "0". ## -property-value **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". ## -remarks You can set this property to specify that [PermilleFormatter](permilleformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.IsZeroSigned +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.IsZeroSigned + +## -description +Gets or sets whether -0 is formatted as "-0" or "0". + +## -property-value + **True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0". + +## -remarks +You can set this property to specify that [PermilleFormatter](permilleformatter.md) display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001). + +This property defaults to **false** to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0". + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_languages.md b/windows.globalization.numberformatting/permilleformatter_languages.md index ae779b8c3c..f8085c281d 100644 --- a/windows.globalization.numberformatting/permilleformatter_languages.md +++ b/windows.globalization.numberformatting/permilleformatter_languages.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.Languages --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.Languages ## -description Gets the priority list of language identifiers that is used when formatting and parsing permille values. ## -property-value The priority list of language identifiers. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PermilleFormatter(IIterable(String), String)](permilleformatter_permilleformatter_177128098.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting and parsing permille values. + +## -property-value +The priority list of language identifiers. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PermilleFormatter(IIterable(String), String)](permilleformatter_permilleformatter_177128098.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_numberrounder.md b/windows.globalization.numberformatting/permilleformatter_numberrounder.md index e0b064497a..7df4e3b9b7 100644 --- a/windows.globalization.numberformatting/permilleformatter_numberrounder.md +++ b/windows.globalization.numberformatting/permilleformatter_numberrounder.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.NumberRounder --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.NumberRounder ## -description Gets or sets the current rounding strategy to be used when formatting permilles. ## -property-value A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). ## -remarks When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.NumberRounder +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.NumberRounder + +## -description +Gets or sets the current rounding strategy to be used when formatting permilles. + +## -property-value +A number rounder object: [IncrementNumberRounder](incrementnumberrounder.md) or [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md). + +## -remarks +When a **Format** method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_numeralsystem.md b/windows.globalization.numberformatting/permilleformatter_numeralsystem.md index 052de97ce8..41c4982604 100644 --- a/windows.globalization.numberformatting/permilleformatter_numeralsystem.md +++ b/windows.globalization.numberformatting/permilleformatter_numeralsystem.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.NumeralSystem ## -description Gets or sets the numbering system that is used to format and parse permille values. ## -property-value A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks > [!NOTE] > For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). + A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). + A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). + A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.NumeralSystem + +## -description +Gets or sets the numbering system that is used to format and parse permille values. + +## -property-value +A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks +> [!NOTE] +> For Arabic numeral systems ("Arab" and "ArabExt" or any numeral systems which use a combination of those characters):+ A period (.) immediately before a Latin digit is converted to the Arabic Decimal Separator (u+66b). ++ A comma (,) immediately before a Latin digit is converted to Arabic Thousand Separator (u+66c). ++ A percent (%) adjacent to a Latin digit is converted to Arabic Per Cent Symbol (u+66a). ++ A permille (u+2030) adjacent to a Latin digit is converted to Arabic Per Mille Symbol (u+609). + + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_parsedouble_1368702614.md b/windows.globalization.numberformatting/permilleformatter_parsedouble_1368702614.md index adb2e545db..fce4a2b654 100644 --- a/windows.globalization.numberformatting/permilleformatter_parsedouble_1368702614.md +++ b/windows.globalization.numberformatting/permilleformatter_parsedouble_1368702614.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.ParseDouble(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.ParseDouble ## -description Attempts to parse a string representation of a **Double** permillage. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **Double** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.ParseDouble(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.ParseDouble + +## -description +Attempts to parse a string representation of a **Double** permillage. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **Double** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_parseint_1447535745.md b/windows.globalization.numberformatting/permilleformatter_parseint_1447535745.md index aabbed5496..9465bcbfd9 100644 --- a/windows.globalization.numberformatting/permilleformatter_parseint_1447535745.md +++ b/windows.globalization.numberformatting/permilleformatter_parseint_1447535745.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.ParseInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.ParseInt ## -description Attempts to parse a string representation of an integer permillage. ## -parameters ### -param text The text to be parsed. ## -returns If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.ParseInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.ParseInt + +## -description +Attempts to parse a string representation of an integer permillage. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, an **Int64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_parseuint_168772619.md b/windows.globalization.numberformatting/permilleformatter_parseuint_168772619.md index 34103e1f86..11f03dbc4a 100644 --- a/windows.globalization.numberformatting/permilleformatter_parseuint_168772619.md +++ b/windows.globalization.numberformatting/permilleformatter_parseuint_168772619.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.ParseUInt(System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.ParseUInt ## -description Attempts to parse a string representation of an unsigned integer permillage. ## -parameters ### -param text The text to be parsed. ## -returns If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.ParseUInt(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.ParseUInt + +## -description +Attempts to parse a string representation of an unsigned integer permillage. + +## -parameters +### -param text +The text to be parsed. + +## -returns +If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_permilleformatter_1221375020.md b/windows.globalization.numberformatting/permilleformatter_permilleformatter_1221375020.md index d563575723..2a5f0a2090 100644 --- a/windows.globalization.numberformatting/permilleformatter_permilleformatter_1221375020.md +++ b/windows.globalization.numberformatting/permilleformatter_permilleformatter_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.#ctor --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.PermilleFormatter ## -description Creates a [PermilleFormatter](permilleformatter.md) object and initializes it to default values. ## -remarks ## -examples ## -see-also [PermilleFormatter(IIterable(String), String)](permilleformatter_permilleformatter_177128098.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.PermilleFormatter + +## -description +Creates a [PermilleFormatter](permilleformatter.md) object and initializes it to default values. + +## -remarks + +## -examples + +## -see-also +[PermilleFormatter(IIterable(String), String)](permilleformatter_permilleformatter_177128098.md) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_permilleformatter_177128098.md b/windows.globalization.numberformatting/permilleformatter_permilleformatter_177128098.md index 946d508e52..aa7c4e55d1 100644 --- a/windows.globalization.numberformatting/permilleformatter_permilleformatter_177128098.md +++ b/windows.globalization.numberformatting/permilleformatter_permilleformatter_177128098.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.PermilleFormatter ## -description Creates a [PermilleFormatter](permilleformatter.md) object initialized by a language list and a geographic region. ## -parameters ### -param languages The list of language identifiers, in priority order, representing the choice of languages. See Remarks. ### -param geographicRegion The identifier for the geographic region. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [PermilleFormatter](permilleformatter.md) objects. ## -examples ## -see-also [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.PermilleFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.PermilleFormatter + +## -description +Creates a [PermilleFormatter](permilleformatter.md) object initialized by a language list and a geographic region. + +## -parameters +### -param languages +The list of language identifiers, in priority order, representing the choice of languages. See Remarks. + +### -param geographicRegion +The identifier for the geographic region. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that the "nu-" extension can affect the numeral system used by [PermilleFormatter](permilleformatter.md) objects. + +## -examples + +## -see-also +[Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization.numberformatting/permilleformatter_resolvedgeographicregion.md b/windows.globalization.numberformatting/permilleformatter_resolvedgeographicregion.md index 2bc88ce606..f310d439f4 100644 --- a/windows.globalization.numberformatting/permilleformatter_resolvedgeographicregion.md +++ b/windows.globalization.numberformatting/permilleformatter_resolvedgeographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedGeographicRegion --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedGeographicRegion ## -description Gets the geographic region that was most recently used to format or parse permille values. ## -property-value The geographic region that was most recently used to format or parse permille values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedGeographicRegion +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedGeographicRegion + +## -description +Gets the geographic region that was most recently used to format or parse permille values. + +## -property-value +The geographic region that was most recently used to format or parse permille values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_resolvedlanguage.md b/windows.globalization.numberformatting/permilleformatter_resolvedlanguage.md index 101bf6329b..c72ab9692f 100644 --- a/windows.globalization.numberformatting/permilleformatter_resolvedlanguage.md +++ b/windows.globalization.numberformatting/permilleformatter_resolvedlanguage.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedLanguage ## -description Gets the language that was most recently used to format or parse permille values. ## -property-value The language from the [priority list of language identifiers](permilleformatter_languages.md) that was most recently used to format or parse permille values. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PermilleFormatter(IIterable(String), String)](permilleformatter_permilleformatter_177128098.md) constructor. ## -remarks If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.ResolvedLanguage + +## -description +Gets the language that was most recently used to format or parse permille values. + +## -property-value +The language from the [priority list of language identifiers](permilleformatter_languages.md) that was most recently used to format or parse permille values. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [PermilleFormatter(IIterable(String), String)](permilleformatter_permilleformatter_177128098.md) constructor. + +## -remarks +If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/permilleformatter_significantdigits.md b/windows.globalization.numberformatting/permilleformatter_significantdigits.md index f2263d0f2e..09dd14c512 100644 --- a/windows.globalization.numberformatting/permilleformatter_significantdigits.md +++ b/windows.globalization.numberformatting/permilleformatter_significantdigits.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.SignificantDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.PermilleFormatter.SignificantDigits ## -description Gets or sets the current padding to significant digits when a permille is formatted. ## -property-value The number of significant digits. ## -remarks Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.PermilleFormatter.SignificantDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.PermilleFormatter.SignificantDigits + +## -description +Gets or sets the current padding to significant digits when a permille is formatted. + +## -property-value +The number of significant digits. + +## -remarks +Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_rounddouble_1880232351.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_rounddouble_1880232351.md index 3b05088be0..1bf8969034 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_rounddouble_1880232351.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_rounddouble_1880232351.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundDouble(System.Double) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundDouble ## -description Rounds a **Double** number to the specified number of significant digits. ## -parameters ### -param value The **Double** value to be rounded. ## -returns The rounded number. This result is a double precision floating point number, which is not necessarily an integer. ## -remarks The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). > [!NOTE] > This method is precise only within the limits of the [Double](https://msdn.microsoft.com/library/system.double.aspx) data type: approximately 15 digits. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundDouble(System.Double) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundDouble + +## -description +Rounds a **Double** number to the specified number of significant digits. + +## -parameters +### -param value +The **Double** value to be rounded. + +## -returns +The rounded number. This result is a double precision floating point number, which is not necessarily an integer. + +## -remarks +The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). + +> [!NOTE] +> This method is precise only within the limits of the [Double](https://msdn.microsoft.com/library/system.double.aspx) data type: approximately 15 digits. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundingalgorithm.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundingalgorithm.md index 3ff9fea0b4..579e39a3f7 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundingalgorithm.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundingalgorithm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundingAlgorithm --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundingAlgorithm ## -description Gets or sets the rounding strategy value for this [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object. ## -property-value A value of the [RoundingAlgorithm](roundingalgorithm.md) enumeration. ## -remarks This property is initialized to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundingAlgorithm +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundingAlgorithm + +## -description +Gets or sets the rounding strategy value for this [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object. + +## -property-value +A value of the [RoundingAlgorithm](roundingalgorithm.md) enumeration. + +## -remarks +This property is initialized to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint32_1088866923.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint32_1088866923.md index c7572435ce..ab4a7c08d1 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint32_1088866923.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint32_1088866923.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt32(System.Int32) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt32 ## -description Rounds an **Int32** number to the specified number of significant digits. ## -parameters ### -param value The **Int32** value to be rounded. ## -returns The rounded 32 bit integer. ## -remarks The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt32(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt32 + +## -description +Rounds an **Int32** number to the specified number of significant digits. + +## -parameters +### -param value +The **Int32** value to be rounded. + +## -returns +The rounded 32 bit integer. + +## -remarks +The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint64_297576497.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint64_297576497.md index 498c55bb9c..ca18829101 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint64_297576497.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundint64_297576497.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt64(System.Int64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt64 ## -description Rounds an **Int64** number to the specified number of significant digits. ## -parameters ### -param value The **Int64** value to be rounded. ## -returns The rounded 64 bit integer. ## -remarks The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt64(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundInt64 + +## -description +Rounds an **Int64** number to the specified number of significant digits. + +## -parameters +### -param value +The **Int64** value to be rounded. + +## -returns +The rounded 64 bit integer. + +## -remarks +The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundsingle_239288903.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundsingle_239288903.md index 724490d086..569232137e 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_roundsingle_239288903.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_roundsingle_239288903.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundSingle(System.Single) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundSingle ## -description Rounds a **Single** number to the specified number of significant digits. ## -parameters ### -param value The **Single** value to be rounded. ## -returns The rounded number. This result is a single precision floating point number, which is not necessarily an integer. ## -remarks The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). > [!NOTE] > This method is precise only within the limits of the **Single** data type: approximately 7 digits. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundSingle(System.Single) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundSingle + +## -description +Rounds a **Single** number to the specified number of significant digits. + +## -parameters +### -param value +The **Single** value to be rounded. + +## -returns +The rounded number. This result is a single precision floating point number, which is not necessarily an integer. + +## -remarks +The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). + +> [!NOTE] +> This method is precise only within the limits of the **Single** data type: approximately 7 digits. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint32_709102605.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint32_709102605.md index 089d3634a1..b71a3870cd 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint32_709102605.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint32_709102605.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt32(System.UInt32) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt32 ## -description Rounds a **UInt32** number to the specified number of significant digits. ## -parameters ### -param value The **UInt32** value to be rounded. ## -returns The rounded unsigned 32 bit integer. ## -remarks The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt32(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt32 + +## -description +Rounds a **UInt32** number to the specified number of significant digits. + +## -parameters +### -param value +The **UInt32** value to be rounded. + +## -returns +The rounded unsigned 32 bit integer. + +## -remarks +The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint64_249553617.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint64_249553617.md index c7b16cb213..58158c5c43 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint64_249553617.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_rounduint64_249553617.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt64(System.UInt64) --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt64 ## -description Rounds a **UInt64** number to the specified number of significant digits. ## -parameters ### -param value The **UInt64** value to be rounded. ## -returns The rounded unsigned 64 bit integer. ## -remarks The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt64(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.RoundUInt64 + +## -description +Rounds a **UInt64** number to the specified number of significant digits. + +## -parameters +### -param value +The **UInt64** value to be rounded. + +## -returns +The rounded unsigned 64 bit integer. + +## -remarks +The rounding strategy is based on the values of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) and [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md). + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigits.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigits.md index b829fb73f3..6702cfbbf8 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigits.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigits.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.SignificantDigits --api-type: winrt property ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.SignificantDigits ## -description Gets or sets the number of significant digits this [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object uses for rounding. ## -property-value The number of significant digits used for rounding. ## -remarks This property is initialized to a default value of 1. If this property is 0, no rounding is performed by the [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object. When rounding is performed, leading 0s in the input are not considered. Significant digits are counted beginning with the first non-zero digit until the number of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) occurs, and then [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md) is used to round at that position. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.SignificantDigits +-api-type: winrt property +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.SignificantDigits + +## -description +Gets or sets the number of significant digits this [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object uses for rounding. + +## -property-value +The number of significant digits used for rounding. + +## -remarks +This property is initialized to a default value of 1. + +If this property is 0, no rounding is performed by the [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object. + +When rounding is performed, leading 0s in the input are not considered. Significant digits are counted beginning with the first non-zero digit until the number of [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) occurs, and then [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md) is used to round at that position. + +## -examples + +## -see-also diff --git a/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigitsnumberrounder_1221375020.md b/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigitsnumberrounder_1221375020.md index ae39659b75..105a0c3324 100644 --- a/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigitsnumberrounder_1221375020.md +++ b/windows.globalization.numberformatting/significantdigitsnumberrounder_significantdigitsnumberrounder_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.#ctor --api-type: winrt method ---- # Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.SignificantDigitsNumberRounder ## -description Creates a [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object. This constructor initializes [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md) to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**, and [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) to 0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.NumberFormatting.SignificantDigitsNumberRounder.SignificantDigitsNumberRounder + +## -description +Creates a [SignificantDigitsNumberRounder](significantdigitsnumberrounder.md) object. + +This constructor initializes [RoundingAlgorithm](significantdigitsnumberrounder_roundingalgorithm.md) to a default value of [RoundingAlgorithm](roundingalgorithm.md).**RoundHalfUp**, and [SignificantDigits](significantdigitsnumberrounder_significantdigits.md) to 0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter.md b/windows.globalization.phonenumberformatting/phonenumberformatter.md index 4ab3322230..858aef820f 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter --api-type: winrt class ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter ## -description Formats phone numbers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter +-api-type: winrt class +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter + +## -description +Formats phone numbers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_format_1069764127.md b/windows.globalization.phonenumberformatting/phonenumberformatter_format_1069764127.md index 0c6d01e88e..43f3ee0243 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_format_1069764127.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_format_1069764127.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format(Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo,Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormat) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format ## -description Returns a string representing the given phone number, using the given format. ## -parameters ### -param number The phone number to be formatted. The [PhoneNumberInfo](phonenumberinfo.md) specifies not just the subscriber number, but also other relevant information such as country code. ### -param numberFormat The specific format to be used. ## -returns A string containing the phone number, in the specified format. ## -remarks ## -examples ## -see-also [Format(PhoneNumberInfo)](phonenumberformatter_format_754257055.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format(Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo,Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormat) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format + +## -description +Returns a string representing the given phone number, using the given format. + +## -parameters +### -param number +The phone number to be formatted. The [PhoneNumberInfo](phonenumberinfo.md) specifies not just the subscriber number, but also other relevant information such as country code. + +### -param numberFormat +The specific format to be used. + +## -returns +A string containing the phone number, in the specified format. + +## -remarks + +## -examples + +## -see-also +[Format(PhoneNumberInfo)](phonenumberformatter_format_754257055.md) \ No newline at end of file diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_format_754257055.md b/windows.globalization.phonenumberformatting/phonenumberformatter_format_754257055.md index cd9377397a..49df5e25b3 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_format_754257055.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_format_754257055.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format(Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format ## -description Returns a string representation of the provided phone number. ## -parameters ### -param number The phone number to be formatted. The [PhoneNumberInfo](phonenumberinfo.md) specifies not just the subscriber number, but also other relevant information such as country code. ## -returns A string containing the formatted phone number, using the default format for the region specified when this PhoneNumberFormatter was created. ## -remarks ## -examples ## -see-also [Format(PhoneNumberInfo, PhoneNumberFormat)](phonenumberformatter_format_1069764127.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format(Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.Format + +## -description +Returns a string representation of the provided phone number. + +## -parameters +### -param number +The phone number to be formatted. The [PhoneNumberInfo](phonenumberinfo.md) specifies not just the subscriber number, but also other relevant information such as country code. + +## -returns +A string containing the formatted phone number, using the default format for the region specified when this PhoneNumberFormatter was created. + +## -remarks + +## -examples + +## -see-also +[Format(PhoneNumberInfo, PhoneNumberFormat)](phonenumberformatter_format_1069764127.md) \ No newline at end of file diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_formatpartialstring_2049344917.md b/windows.globalization.phonenumberformatting/phonenumberformatter_formatpartialstring_2049344917.md index bc665a0643..2c8ca15751 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_formatpartialstring_2049344917.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_formatpartialstring_2049344917.md @@ -1,3 +1,65 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatPartialString(System.String) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatPartialString ## -description Returns a string representing the formatted partial phone number given. Use this method to format phone numbers as they are being entered by a user, to help the user visualize the complete, formatted number. ## -parameters ### -param number A string representing a partial phone number. ## -returns The input string, formatted as a partial phone number. ## -remarks The following table shows the results of repeatedly calling this method as a user enters digits from a phone number, using a formatter set to the "US" region.
Digits passed to FormatPartialStringFormatted output
11
1414
142142
14251 425
14255551 425-555
142555581 425-555-8
142555580801 425-555-8080
The following code snippet demonstrates a TextChanged event handler that updates a TextBlock with the formatted partial number whenever the number typed into the event handler's TextBox changes. ```csharp using Windows.Globalization.PhoneNumberFormatting; PhoneNumberFormatter currentFormatter; public MainPage() { this.InitializeComponent(); // Using the current default region currentFormatter = new PhoneNumberFormatter(); } private void gradualInput_TextChanged(object sender, TextChangedEventArgs e) { outBlock.Text = currentFormatter.FormatPartialString(gradualInput.Text); } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatPartialString(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatPartialString + +## -description +Returns a string representing the formatted partial phone number given. + +Use this method to format phone numbers as they are being entered by a user, to help the user visualize the complete, formatted number. + +## -parameters +### -param number +A string representing a partial phone number. + +## -returns +The input string, formatted as a partial phone number. + +## -remarks +The following table shows the results of repeatedly calling this method as a user enters digits from a phone number, using a formatter set to the "US" region. + + + + + + + + + + +
Digits passed to FormatPartialStringFormatted output
11
1414
142142
14251 425
14255551 425-555
142555581 425-555-8
142555580801 425-555-8080
+ +The following code snippet demonstrates a TextChanged event handler that updates a TextBlock with the formatted partial number whenever the number typed into the event handler's TextBox changes. + +```csharp + +using Windows.Globalization.PhoneNumberFormatting; + +PhoneNumberFormatter currentFormatter; + +public MainPage() +{ + this.InitializeComponent(); + + // Using the current default region + currentFormatter = new PhoneNumberFormatter(); +} + +private void gradualInput_TextChanged(object sender, TextChangedEventArgs e) +{ + outBlock.Text = currentFormatter.FormatPartialString(gradualInput.Text); +} + +``` + + + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_formatstring_1225914408.md b/windows.globalization.phonenumberformatting/phonenumberformatter_formatstring_1225914408.md index a00ae33a9b..66b265f70b 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_formatstring_1225914408.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_formatstring_1225914408.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatString(System.String) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatString ## -description Returns the input string, formatted as a phone number. ## -parameters ### -param number The input string to be formatted. ## -returns The input string, formatted as a phone number, using the region specified when this PhoneNumberFormatter was created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatString(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatString + +## -description +Returns the input string, formatted as a phone number. + +## -parameters +### -param number +The input string to be formatted. + +## -returns +The input string, formatted as a phone number, using the region specified when this PhoneNumberFormatter was created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_formatstringwithlefttorightmarkers_2112598986.md b/windows.globalization.phonenumberformatting/phonenumberformatter_formatstringwithlefttorightmarkers_2112598986.md index 92f143ebbc..fef33f0654 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_formatstringwithlefttorightmarkers_2112598986.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_formatstringwithlefttorightmarkers_2112598986.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatStringWithLeftToRightMarkers(System.String) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatStringWithLeftToRightMarkers ## -description Returns the input string, formatted as a phone number, surrounded by Unicode Left to Right (LTR) markers. ## -parameters ### -param number The input string to be formatted. ## -returns The input string, formatted as a phone number, using the region specified when this PhoneNumberFormatter was created. The string is surrounded by Unicode Left to Right (LTR) markers. ## -remarks Use this method when rendering a phone number for display and the current region settings specify a Right to Left (RTL) language. Phone numbers should still be rendered Left to Right, even when rendered in RTL languages. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatStringWithLeftToRightMarkers(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.FormatStringWithLeftToRightMarkers + +## -description +Returns the input string, formatted as a phone number, surrounded by Unicode Left to Right (LTR) markers. + +## -parameters +### -param number +The input string to be formatted. + +## -returns +The input string, formatted as a phone number, using the region specified when this PhoneNumberFormatter was created. The string is surrounded by Unicode Left to Right (LTR) markers. + +## -remarks +Use this method when rendering a phone number for display and the current region settings specify a Right to Left (RTL) language. Phone numbers should still be rendered Left to Right, even when rendered in RTL languages. + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_getcountrycodeforregion_260950071.md b/windows.globalization.phonenumberformatting/phonenumberformatter_getcountrycodeforregion_260950071.md index dae730b6ab..1b23ba663e 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_getcountrycodeforregion_260950071.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_getcountrycodeforregion_260950071.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetCountryCodeForRegion(System.String) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetCountryCodeForRegion ## -description Static method that returns the country code for a given region code. ## -parameters ### -param regionCode The two-letter ISO region code. ## -returns The telephone country code, as an integer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetCountryCodeForRegion(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetCountryCodeForRegion + +## -description +Static method that returns the country code for a given region code. + +## -parameters +### -param regionCode +The two-letter ISO region code. + +## -returns +The telephone country code, as an integer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_getnationaldirectdialingprefixforregion_1479748013.md b/windows.globalization.phonenumberformatting/phonenumberformatter_getnationaldirectdialingprefixforregion_1479748013.md index a96abb08d4..9d66dc7edf 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_getnationaldirectdialingprefixforregion_1479748013.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_getnationaldirectdialingprefixforregion_1479748013.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetNationalDirectDialingPrefixForRegion(System.String,System.Boolean) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetNationalDirectDialingPrefixForRegion ## -description Static method that returns the national direct dialing prefix for the given region. ## -parameters ### -param regionCode The region code of interest. ### -param stripNonDigit When **true**, all non-digit characters are stripped from the returned string. ## -returns The national direct dialing prefix for the given region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetNationalDirectDialingPrefixForRegion(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.GetNationalDirectDialingPrefixForRegion + +## -description +Static method that returns the national direct dialing prefix for the given region. + +## -parameters +### -param regionCode +The region code of interest. + +### -param stripNonDigit +When **true**, all non-digit characters are stripped from the returned string. + +## -returns +The national direct dialing prefix for the given region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_phonenumberformatter_1221375020.md b/windows.globalization.phonenumberformatting/phonenumberformatter_phonenumberformatter_1221375020.md index 8d2bd8ab14..e30c3e524b 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_phonenumberformatter_1221375020.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_phonenumberformatter_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.#ctor --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.PhoneNumberFormatter ## -description Creates a PhoneNumberFormatter object, using the current default region. ## -remarks Note that you can also create PhoneNumberFormatter objects using [PhoneNumberFormatter.TryCreate](phonenumberformatter_trycreate.md), which takes a two-letter ISO region name as an argument and attempts to create a PhoneNumberFormatter for the given region. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.PhoneNumberFormatter + +## -description +Creates a PhoneNumberFormatter object, using the current default region. + +## -remarks +Note that you can also create PhoneNumberFormatter objects using [PhoneNumberFormatter.TryCreate](phonenumberformatter_trycreate.md), which takes a two-letter ISO region name as an argument and attempts to create a PhoneNumberFormatter for the given region. + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_trycreate_1887286499.md b/windows.globalization.phonenumberformatting/phonenumberformatter_trycreate_1887286499.md index cf70680e8a..9435a1237d 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_trycreate_1887286499.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_trycreate_1887286499.md @@ -1,3 +1,50 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.TryCreate(System.String,Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter@) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.TryCreate ## -description Attempts to create a [PhoneNumberFormatter](phonenumberformatter.md) for a given region code, and doesn't throw on failure. ## -parameters ### -param regionCode The region code of the new [PhoneNumberFormatter](phonenumberformatter.md). ### -param phoneNumber On success, a new [PhoneNumberFormatter](phonenumberformatter.md) for the requested region code. On failure, this value is **null**. ## -remarks The following code snippet demonstrates how to use this method to create a [PhoneNumberFormatter](phonenumberformatter.md) for the "BR" region. ```csharp using Windows.Globalization.PhoneNumberFormatting; PhoneNumberFormatter currentFormatter = null; PhoneNumberFormatter.TryCreate("BR", out currentFormatter); if (currentFormatter != null) { // use the formatter } else { // formatter could not be created for the given region. // put your fallback logic here. } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.TryCreate(System.String,Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter@) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.TryCreate + +## -description +Attempts to create a [PhoneNumberFormatter](phonenumberformatter.md) for a given region code, and doesn't throw on failure. + +## -parameters +### -param regionCode +The region code of the new [PhoneNumberFormatter](phonenumberformatter.md). + +### -param phoneNumber +On success, a new [PhoneNumberFormatter](phonenumberformatter.md) for the requested region code. + +On failure, this value is **null**. + +## -remarks +The following code snippet demonstrates how to use this method to create a [PhoneNumberFormatter](phonenumberformatter.md) for the "BR" region. + +```csharp + + using Windows.Globalization.PhoneNumberFormatting; + + PhoneNumberFormatter currentFormatter = null; + + PhoneNumberFormatter.TryCreate("BR", out currentFormatter); + if (currentFormatter != null) + { + // use the formatter + } + else + { + // formatter could not be created for the given region. + // put your fallback logic here. + } + +``` + + + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberformatter_wrapwithlefttorightmarkers_736051790.md b/windows.globalization.phonenumberformatting/phonenumberformatter_wrapwithlefttorightmarkers_736051790.md index 4621670447..371142e02c 100644 --- a/windows.globalization.phonenumberformatting/phonenumberformatter_wrapwithlefttorightmarkers_736051790.md +++ b/windows.globalization.phonenumberformatting/phonenumberformatter_wrapwithlefttorightmarkers_736051790.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.WrapWithLeftToRightMarkers(System.String) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.WrapWithLeftToRightMarkers ## -description Wraps a string with Unicode Left to Right (LTR) markers. ## -parameters ### -param number The string to be surrounded with LTR markers. ## -returns The input string, surrounded with LTR markers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.WrapWithLeftToRightMarkers(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberFormatter.WrapWithLeftToRightMarkers + +## -description +Wraps a string with Unicode Left to Right (LTR) markers. + +## -parameters +### -param number +The string to be surrounded with LTR markers. + +## -returns +The input string, surrounded with LTR markers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo.md b/windows.globalization.phonenumberformatting/phonenumberinfo.md index 62f60911f9..aafa5518f4 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo --api-type: winrt class ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo ## -description Information about a phone number. ## -remarks ## -examples ## -see-also [IStringable](../windows.foundation/istringable.md) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo +-api-type: winrt class +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo + +## -description +Information about a phone number. + +## -remarks + +## -examples + +## -see-also +[IStringable](../windows.foundation/istringable.md) \ No newline at end of file diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_checknumbermatch_849235604.md b/windows.globalization.phonenumberformatting/phonenumberinfo_checknumbermatch_849235604.md index a4539ef6b3..7e7ac3169e 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_checknumbermatch_849235604.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_checknumbermatch_849235604.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CheckNumberMatch(Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CheckNumberMatch ## -description Compares two [PhoneNumberInfo](phonenumberinfo.md) objects. ## -parameters ### -param otherNumber The number to be compared to this object. ## -returns An enumeration value describing the result of the comparison. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CheckNumberMatch(Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CheckNumberMatch + +## -description +Compares two [PhoneNumberInfo](phonenumberinfo.md) objects. + +## -parameters +### -param otherNumber +The number to be compared to this object. + +## -returns +An enumeration value describing the result of the comparison. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_countrycode.md b/windows.globalization.phonenumberformatting/phonenumberinfo_countrycode.md index 61986f262b..1d7041ac47 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_countrycode.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_countrycode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CountryCode --api-type: winrt property ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CountryCode ## -description Gets the two-letter country code for this phone number. ## -property-value A country code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CountryCode +-api-type: winrt property +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.CountryCode + +## -description +Gets the two-letter country code for this phone number. + +## -property-value +A country code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_getgeographicregioncode_94671592.md b/windows.globalization.phonenumberformatting/phonenumberinfo_getgeographicregioncode_94671592.md index 787cb9dc54..dc17ae77f1 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_getgeographicregioncode_94671592.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_getgeographicregioncode_94671592.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetGeographicRegionCode --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetGeographicRegionCode ## -description Gets the geographic region code for this number. ## -returns A string representing the geographic region code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetGeographicRegionCode +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetGeographicRegionCode + +## -description +Gets the geographic region code for this number. + +## -returns +A string representing the geographic region code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofgeographicalareacode_909465023.md b/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofgeographicalareacode_909465023.md index 895cd64cba..6b49f6ebad 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofgeographicalareacode_909465023.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofgeographicalareacode_909465023.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfGeographicalAreaCode --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfGeographicalAreaCode ## -description Gets the length in characters of the geographical area code. ## -returns Length, in characters, of the area code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfGeographicalAreaCode +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfGeographicalAreaCode + +## -description +Gets the length in characters of the geographical area code. + +## -returns +Length, in characters, of the area code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofnationaldestinationcode_1859319380.md b/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofnationaldestinationcode_1859319380.md index e073018119..6ebd843edd 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofnationaldestinationcode_1859319380.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_getlengthofnationaldestinationcode_1859319380.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfNationalDestinationCode --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfNationalDestinationCode ## -description Gets the length, in characters, of the national destination code. ## -returns The length of the national destination code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfNationalDestinationCode +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetLengthOfNationalDestinationCode + +## -description +Gets the length, in characters, of the national destination code. + +## -returns +The length of the national destination code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_getnationalsignificantnumber_875463368.md b/windows.globalization.phonenumberformatting/phonenumberinfo_getnationalsignificantnumber_875463368.md index 4d3dc5cb5d..9dc46ea400 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_getnationalsignificantnumber_875463368.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_getnationalsignificantnumber_875463368.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetNationalSignificantNumber --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetNationalSignificantNumber ## -description Gets the national significant number of this object. ## -returns The national significant number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetNationalSignificantNumber +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.GetNationalSignificantNumber + +## -description +Gets the national significant number of this object. + +## -returns +The national significant number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumber.md b/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumber.md index 6aaf3759c2..37f38d213e 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumber.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PhoneNumber --api-type: winrt property ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PhoneNumber ## -description Gets the phone number. ## -property-value The phone number. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PhoneNumber +-api-type: winrt property +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PhoneNumber + +## -description +Gets the phone number. + +## -property-value +The phone number. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumberinfo_290278668.md b/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumberinfo_290278668.md index d7c421b90d..ca84a77db6 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumberinfo_290278668.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_phonenumberinfo_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.#ctor(System.String) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PhoneNumberInfo ## -description Constructor. ## -parameters ### -param number A phone number that the created object will encapsulate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PhoneNumberInfo + +## -description +Constructor. + +## -parameters +### -param number +A phone number that the created object will encapsulate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_predictnumberkind_261207465.md b/windows.globalization.phonenumberformatting/phonenumberinfo_predictnumberkind_261207465.md index 643712adf3..81713f04c2 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_predictnumberkind_261207465.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_predictnumberkind_261207465.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PredictNumberKind --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PredictNumberKind ## -description Heuristically predicts what kind of number is represented in this object. ## -returns An enumeration value describing the kind of phone number this object represents. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PredictNumberKind +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.PredictNumberKind + +## -description +Heuristically predicts what kind of number is represented in this object. + +## -returns +An enumeration value describing the kind of phone number this object represents. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_tostring_1274845745.md b/windows.globalization.phonenumberformatting/phonenumberinfo_tostring_1274845745.md index 86ca52b221..89a9910605 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_tostring_1274845745.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_tostring_1274845745.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.ToString --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.ToString ## -description Renders the phone number as a string. ## -returns The number, rendered as a string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.ToString +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.ToString + +## -description +Renders the phone number as a string. + +## -returns +The number, rendered as a string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_154311273.md b/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_154311273.md index f7209d4ff3..3594e7b747 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_154311273.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_154311273.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse(System.String,Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo@) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse ## -description Static method that attempts to parse a given input string as a phone number, and creates a [PhoneNumberInfo](phonenumberinfo.md) encapsulating it. ## -parameters ### -param input A phone number, in string form. ### -param phoneNumber On success, this object encapsulates the given phone number. ## -returns An enumeration value giving details of the attempt to parse *input*. ## -remarks ## -examples ## -see-also [TryParse(String, String, PhoneNumberInfo)](phonenumberinfo_tryparse_337886765.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse(System.String,Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo@) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse + +## -description +Static method that attempts to parse a given input string as a phone number, and creates a [PhoneNumberInfo](phonenumberinfo.md) encapsulating it. + +## -parameters +### -param input +A phone number, in string form. + +### -param phoneNumber +On success, this object encapsulates the given phone number. + +## -returns +An enumeration value giving details of the attempt to parse *input*. + +## -remarks + +## -examples + +## -see-also +[TryParse(String, String, PhoneNumberInfo)](phonenumberinfo_tryparse_337886765.md) \ No newline at end of file diff --git a/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_337886765.md b/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_337886765.md index 9b379cdaad..df888a2c83 100644 --- a/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_337886765.md +++ b/windows.globalization.phonenumberformatting/phonenumberinfo_tryparse_337886765.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse(System.String,System.String,Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo@) --api-type: winrt method ---- # Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse ## -description Static method that attempts to parse a given input string as a phone number (using a given region code) and creates a [PhoneNumberInfo](phonenumberinfo.md) encapsulating it. ## -parameters ### -param input A phone number, in string form. ### -param regionCode The two-letter region code to be used to parse *input*. Region codes should use upper-case letters. ### -param phoneNumber On success, this object encapsulates the given phone number. ## -returns An enumeration value giving details of the attempt to parse *input*. ## -remarks ## -examples ## -see-also [TryParse(String, PhoneNumberInfo)](phonenumberinfo_tryparse_154311273.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse(System.String,System.String,Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo@) +-api-type: winrt method +--- + + + +# Windows.Globalization.PhoneNumberFormatting.PhoneNumberInfo.TryParse + +## -description +Static method that attempts to parse a given input string as a phone number (using a given region code) and creates a [PhoneNumberInfo](phonenumberinfo.md) encapsulating it. + +## -parameters +### -param input +A phone number, in string form. + +### -param regionCode +The two-letter region code to be used to parse *input*. Region codes should use upper-case letters. + +### -param phoneNumber +On success, this object encapsulates the given phone number. + +## -returns +An enumeration value giving details of the attempt to parse *input*. + +## -remarks + +## -examples + +## -see-also +[TryParse(String, PhoneNumberInfo)](phonenumberinfo_tryparse_154311273.md) \ No newline at end of file diff --git a/windows.globalization/applicationlanguages.md b/windows.globalization/applicationlanguages.md index b959dab474..bc7d063540 100644 --- a/windows.globalization/applicationlanguages.md +++ b/windows.globalization/applicationlanguages.md @@ -1,3 +1,46 @@ ---- -api-id: T:Windows.Globalization.ApplicationLanguages --api-type: winrt class ---- # Windows.Globalization.ApplicationLanguages ## -description Specifies the language-related preferences that the app can use and maintain. ## -remarks The languages referenced in this class are represented by [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302). Each of these is a language identifier and not a locale name, although the two structurally can be the same. As a language tag, "en-US" means American English (or the dialect of English spoken in the United States). It makes no claims about the actual location of the speakers (though many of them do reside in the US) and no other claims about conventions that are used in the US such as the measurement system or currency. Example: ```javascript Windows.Globalization.ApplicationLanguages.PrimaryLanguageOverride = "en-US" ``` > [!NOTE] > If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). ### **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that these extensions can affect the numeral system or calendar used by globalization objects. Windows Store app can be deployed using resource packages. When language resource packages are used, the packages that are installed and registered for a given user are determined by the languages in the user's language profile. As a result, not all of the languages included in the app bundle that was submitted to the Windows Store will necessarily be available for use at runtime. The [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property should only be set to languages that are available for the user. The languages available for the app to use as an [ApplicationLanguages](applicationlanguages.md) object at runtime are limited to those languages included in the main app package manifest and the languages corresponding to language resource packages that are applicable for the user (determined by matching languages in the user's preferences), and that are installed and registered for the user. The [ApplicationLanguages.ManifestLanguages](applicationlanguages_manifestlanguages.md) property reflects language resource packs that are available for the user, and hence returns an appropriate set of languages that can be used for setting the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property. The [ApplicationLanguages.Languages](applicationlanguages_languages.md) property will return a very similar list to the [ManifestLanguages](applicationlanguages_manifestlanguages.md) property. It may differ in including regional language variations not listed in any package manifest; for example, "en-CA" (English (Canada)) can be returned by the [Languages](applicationlanguages_languages.md) property if the user has "en-CA" in their profile and the app supports any regional variety of English. Such user-derived regional language variations can be preferable for setting the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property since the app will then provide globalization behaviors more appropriate for the user. If a language is in the main app package but is not a match for any language in the user's preference, it is returned by the [ManifestLanguages](applicationlanguages_manifestlanguages.md) property but not the [Languages](applicationlanguages_languages.md) property. These can also be used for setting the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property. However, since these languages are not reflected in the user's preferences, the user might not understand those languages. Such settings should be used only when chosen directly by the user. ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.ApplicationLanguages +-api-type: winrt class +--- + + + +# Windows.Globalization.ApplicationLanguages + +## -description +Specifies the language-related preferences that the app can use and maintain. + +## -remarks +The languages referenced in this class are represented by [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302). Each of these is a language identifier and not a locale name, although the two structurally can be the same. As a language tag, "en-US" means American English (or the dialect of English spoken in the United States). It makes no claims about the actual location of the speakers (though many of them do reside in the US) and no other claims about conventions that are used in the US such as the measurement system or currency. + + + +Example: + +```javascript +Windows.Globalization.ApplicationLanguages.PrimaryLanguageOverride = "en-US" +``` + + + +> [!NOTE] +> If your app passes language tags from this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +### **Starting in :** + +Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that these extensions can affect the numeral system or calendar used by globalization objects. + +Windows Store app can be deployed using resource packages. When language resource packages are used, the packages that are installed and registered for a given user are determined by the languages in the user's language profile. As a result, not all of the languages included in the app bundle that was submitted to the Windows Store will necessarily be available for use at runtime. The [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property should only be set to languages that are available for the user. + +The languages available for the app to use as an [ApplicationLanguages](applicationlanguages.md) object at runtime are limited to those languages included in the main app package manifest and the languages corresponding to language resource packages that are applicable for the user (determined by matching languages in the user's preferences), and that are installed and registered for the user. The [ApplicationLanguages.ManifestLanguages](applicationlanguages_manifestlanguages.md) property reflects language resource packs that are available for the user, and hence returns an appropriate set of languages that can be used for setting the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property. + +The [ApplicationLanguages.Languages](applicationlanguages_languages.md) property will return a very similar list to the [ManifestLanguages](applicationlanguages_manifestlanguages.md) property. It may differ in including regional language variations not listed in any package manifest; for example, "en-CA" (English (Canada)) can be returned by the [Languages](applicationlanguages_languages.md) property if the user has "en-CA" in their profile and the app supports any regional variety of English. Such user-derived regional language variations can be preferable for setting the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property since the app will then provide globalization behaviors more appropriate for the user. + +If a language is in the main app package but is not a match for any language in the user's preference, it is returned by the [ManifestLanguages](applicationlanguages_manifestlanguages.md) property but not the [Languages](applicationlanguages_languages.md) property. These can also be used for setting the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property. However, since these languages are not reflected in the user's preferences, the user might not understand those languages. Such settings should be used only when chosen directly by the user. + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization/applicationlanguages_languages.md b/windows.globalization/applicationlanguages_languages.md index 1245c51329..67d7ad6c96 100644 --- a/windows.globalization/applicationlanguages_languages.md +++ b/windows.globalization/applicationlanguages_languages.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.ApplicationLanguages.Languages --api-type: winrt property ---- # Windows.Globalization.ApplicationLanguages.Languages ## -description Gets the ranked list of current runtime language values preferred by the user. ## -property-value A computed list of languages that merges the app's declared supported languages ([ApplicationLanguages.ManifestLanguages](applicationlanguages_manifestlanguages.md)) with the user's ranked list of preferred languages. ## -remarks This list is the recommended source of the best current runtime language value(s) preferred by the user. > [!NOTE] > This property yields the same values as the language list exposed by [Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext.Languages](../windows.applicationmodel.resources.core/resourcecontext_languages.md). ## -examples ## -see-also [ApplicationLanguages.ManifestLanguages](applicationlanguages_manifestlanguages.md), [Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext.Languages](../windows.applicationmodel.resources.core/resourcecontext_languages.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.ApplicationLanguages.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.ApplicationLanguages.Languages + +## -description +Gets the ranked list of current runtime language values preferred by the user. + +## -property-value +A computed list of languages that merges the app's declared supported languages ([ApplicationLanguages.ManifestLanguages](applicationlanguages_manifestlanguages.md)) with the user's ranked list of preferred languages. + +## -remarks +This list is the recommended source of the best current runtime language value(s) preferred by the user. + +> [!NOTE] +> This property yields the same values as the language list exposed by [Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext.Languages](../windows.applicationmodel.resources.core/resourcecontext_languages.md). + +## -examples + +## -see-also +[ApplicationLanguages.ManifestLanguages](applicationlanguages_manifestlanguages.md), [Windows.ApplicationModel.Resources.Core.ResourceManager.DefaultContext.Languages](../windows.applicationmodel.resources.core/resourcecontext_languages.md) \ No newline at end of file diff --git a/windows.globalization/applicationlanguages_manifestlanguages.md b/windows.globalization/applicationlanguages_manifestlanguages.md index 88d2cf0caf..ba6adc50b8 100644 --- a/windows.globalization/applicationlanguages_manifestlanguages.md +++ b/windows.globalization/applicationlanguages_manifestlanguages.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Globalization.ApplicationLanguages.ManifestLanguages --api-type: winrt property ---- # Windows.Globalization.ApplicationLanguages.ManifestLanguages ## -description Gets the app's declared list of supported languages. ## -property-value The list of supported languages declared in the app's manifest. ## -remarks ### **Starting in :** Windows Store app can be deployed using resource packages. When language resource packages are used, the packages that are installed and registered for a given user are determined by the languages in the user's language profile. The set of languages returned by the [ManifestLanguages](applicationlanguages_manifestlanguages.md) property is limited to the languages currently available on the system for the user. Languages included in the main app package manifest will always be returned; languages from resource packs will be returned only if the language is applicable for the user (that is, is in the user's preferences) and that resource package has been installed and registered for the user at the time the property is accessed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.ApplicationLanguages.ManifestLanguages +-api-type: winrt property +--- + + + +# Windows.Globalization.ApplicationLanguages.ManifestLanguages + +## -description +Gets the app's declared list of supported languages. + +## -property-value +The list of supported languages declared in the app's manifest. + +## -remarks +### **Starting in :** + +Windows Store app can be deployed using resource packages. When language resource packages are used, the packages that are installed and registered for a given user are determined by the languages in the user's language profile. The set of languages returned by the [ManifestLanguages](applicationlanguages_manifestlanguages.md) property is limited to the languages currently available on the system for the user. Languages included in the main app package manifest will always be returned; languages from resource packs will be returned only if the language is applicable for the user (that is, is in the user's preferences) and that resource package has been installed and registered for the user at the time the property is accessed. + +## -examples + +## -see-also diff --git a/windows.globalization/applicationlanguages_primarylanguageoverride.md b/windows.globalization/applicationlanguages_primarylanguageoverride.md index 714820faf5..18905246b3 100644 --- a/windows.globalization/applicationlanguages_primarylanguageoverride.md +++ b/windows.globalization/applicationlanguages_primarylanguageoverride.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Globalization.ApplicationLanguages.PrimaryLanguageOverride --api-type: winrt property ---- # Windows.Globalization.ApplicationLanguages.PrimaryLanguageOverride ## -description Gets or sets an override for the app's preferred language, expressed as a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. This setting is persisted. ## -property-value A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. The app can set it to override the top language of the user's ranked list of preferred languages ([ApplicationLanguages.Languages](applicationlanguages_languages.md)), and its value will persist between app sessions. It must be a single language tag; a delimited list of language tags will fail. When your app gets the value, [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) returns either a single language tag (if your app has previously set the property) or an empty string. ## -remarks Apps normally run with language settings determined by the system by comparing the languages supported by the app with the language preferences of the user. The settings for that system behavior can be obtained using the [ApplicationLanguages.Languages](applicationlanguages_languages.md) property. The [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property is used to override that behavior by setting a specific language as the first language in the Languages list. The [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) setting is persisted between sessions. It should not be set each time the app is loaded. It should only be set based on user input presented in settings UI. The property can be read at any time. If the property has never been set, it returns an empty string. When you set the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md), this is immediately reflected in the [ApplicationLanguages.Languages](applicationlanguages_languages.md) property. However, this change may not take effect immediately on resources loaded in the app UI. To make sure the app responds to such changes, you can listen to the [QualifierValues](../windows.applicationmodel.resources.core/resourcecontext_qualifiervalues.md) property on a default resource context and take whatever actions may be needed to reload resources. Those requirements may vary depending on the UI framework used by the app, and it may be necessary to restart the app. ## -examples ## -see-also [ApplicationLanguages.Languages](applicationlanguages_languages.md), [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.ApplicationLanguages.PrimaryLanguageOverride +-api-type: winrt property +--- + + + +# Windows.Globalization.ApplicationLanguages.PrimaryLanguageOverride + +## -description +Gets or sets an override for the app's preferred language, expressed as a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. This setting is persisted. + +## -property-value +A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. The app can set it to override the top language of the user's ranked list of preferred languages ([ApplicationLanguages.Languages](applicationlanguages_languages.md)), and its value will persist between app sessions. It must be a single language tag; a delimited list of language tags will fail. + +When your app gets the value, [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) returns either a single language tag (if your app has previously set the property) or an empty string. + +## -remarks +Apps normally run with language settings determined by the system by comparing the languages supported by the app with the language preferences of the user. The settings for that system behavior can be obtained using the [ApplicationLanguages.Languages](applicationlanguages_languages.md) property. The [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) property is used to override that behavior by setting a specific language as the first language in the Languages list. + +The [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md) setting is persisted between sessions. It should not be set each time the app is loaded. It should only be set based on user input presented in settings UI. The property can be read at any time. If the property has never been set, it returns an empty string. + +When you set the [PrimaryLanguageOverride](applicationlanguages_primarylanguageoverride.md), this is immediately reflected in the [ApplicationLanguages.Languages](applicationlanguages_languages.md) property. However, this change may not take effect immediately on resources loaded in the app UI. To make sure the app responds to such changes, you can listen to the [QualifierValues](../windows.applicationmodel.resources.core/resourcecontext_qualifiervalues.md) property on a default resource context and take whatever actions may be needed to reload resources. Those requirements may vary depending on the UI framework used by the app, and it may be necessary to restart the app. + +## -examples + +## -see-also +[ApplicationLanguages.Languages](applicationlanguages_languages.md), [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization/calendar_adddays_2028771209.md b/windows.globalization/calendar_adddays_2028771209.md index 7bf254185f..e499e9230f 100644 --- a/windows.globalization/calendar_adddays_2028771209.md +++ b/windows.globalization/calendar_adddays_2028771209.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddDays(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddDays ## -description Increments or decrements the day. ## -parameters ### -param days The number of days by which to increment the day (if the value is positive) or decrement the day (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddDays(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddDays + +## -description +Increments or decrements the day. + +## -parameters +### -param days +The number of days by which to increment the day (if the value is positive) or decrement the day (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_adderas_1088395144.md b/windows.globalization/calendar_adderas_1088395144.md index a0770ceab9..f9bf9c2bba 100644 --- a/windows.globalization/calendar_adderas_1088395144.md +++ b/windows.globalization/calendar_adderas_1088395144.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddEras(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddEras ## -description Increments or decrements the era. ## -parameters ### -param eras The number of eras by which to increment the era (if the value is positive) or decrement the era (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddEras(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddEras + +## -description +Increments or decrements the era. + +## -parameters +### -param eras +The number of eras by which to increment the era (if the value is positive) or decrement the era (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addhours_1682433170.md b/windows.globalization/calendar_addhours_1682433170.md index 2e394bc3bd..2638cf6e3a 100644 --- a/windows.globalization/calendar_addhours_1682433170.md +++ b/windows.globalization/calendar_addhours_1682433170.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddHours(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddHours ## -description Increments or decrements the hour. ## -parameters ### -param hours The number of hours by which to increment the hour (if the value is positive) or decrement the hour (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddHours(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddHours + +## -description +Increments or decrements the hour. + +## -parameters +### -param hours +The number of hours by which to increment the hour (if the value is positive) or decrement the hour (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addminutes_2080177883.md b/windows.globalization/calendar_addminutes_2080177883.md index b636968b16..cf6feadadd 100644 --- a/windows.globalization/calendar_addminutes_2080177883.md +++ b/windows.globalization/calendar_addminutes_2080177883.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddMinutes(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddMinutes ## -description Increments or decrements the minute. ## -parameters ### -param minutes The number of minutes by which to increment the minute (if the value is positive) or decrement the minute (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddMinutes(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddMinutes + +## -description +Increments or decrements the minute. + +## -parameters +### -param minutes +The number of minutes by which to increment the minute (if the value is positive) or decrement the minute (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addmonths_787442092.md b/windows.globalization/calendar_addmonths_787442092.md index 9cfb14162f..11e205034d 100644 --- a/windows.globalization/calendar_addmonths_787442092.md +++ b/windows.globalization/calendar_addmonths_787442092.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddMonths(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddMonths ## -description Increments or decrements the month. ## -parameters ### -param months The number of months by which to increment the month (if the value is positive) or decrement the month (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddMonths(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddMonths + +## -description +Increments or decrements the month. + +## -parameters +### -param months +The number of months by which to increment the month (if the value is positive) or decrement the month (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addnanoseconds_297230193.md b/windows.globalization/calendar_addnanoseconds_297230193.md index c2bae58403..8a5d0bcfd8 100644 --- a/windows.globalization/calendar_addnanoseconds_297230193.md +++ b/windows.globalization/calendar_addnanoseconds_297230193.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddNanoseconds(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddNanoseconds ## -description Increments or decrements the nanosecond. ## -parameters ### -param nanoseconds The number of nanoseconds by which to increment the nanosecond (if the value is positive) or decrement the nanosecond (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddNanoseconds(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddNanoseconds + +## -description +Increments or decrements the nanosecond. + +## -parameters +### -param nanoseconds +The number of nanoseconds by which to increment the nanosecond (if the value is positive) or decrement the nanosecond (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addperiods_2132095798.md b/windows.globalization/calendar_addperiods_2132095798.md index d16dbd553b..b0cb104c59 100644 --- a/windows.globalization/calendar_addperiods_2132095798.md +++ b/windows.globalization/calendar_addperiods_2132095798.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddPeriods(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddPeriods ## -description Increments or decrements the period. ## -parameters ### -param periods The number of periods by which to increment the period (if the value is positive) or decrement the period (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddPeriods(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddPeriods + +## -description +Increments or decrements the period. + +## -parameters +### -param periods +The number of periods by which to increment the period (if the value is positive) or decrement the period (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addseconds_1497661544.md b/windows.globalization/calendar_addseconds_1497661544.md index 87714dfb0c..8ef9182e85 100644 --- a/windows.globalization/calendar_addseconds_1497661544.md +++ b/windows.globalization/calendar_addseconds_1497661544.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddSeconds(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddSeconds ## -description Increments or decrements the second. ## -parameters ### -param seconds The number of seconds by which to increment the second (if the value is positive) or decrement the second (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddSeconds(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddSeconds + +## -description +Increments or decrements the second. + +## -parameters +### -param seconds +The number of seconds by which to increment the second (if the value is positive) or decrement the second (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addweeks_1647383371.md b/windows.globalization/calendar_addweeks_1647383371.md index f33f4f50a4..f0a8a41b36 100644 --- a/windows.globalization/calendar_addweeks_1647383371.md +++ b/windows.globalization/calendar_addweeks_1647383371.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddWeeks(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddWeeks ## -description Increments or decrements the day by the specified number of weeks. ## -parameters ### -param weeks The number of weeks by which to increment the day (if the value is positive) or decrement the day (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddWeeks(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddWeeks + +## -description +Increments or decrements the day by the specified number of weeks. + +## -parameters +### -param weeks +The number of weeks by which to increment the day (if the value is positive) or decrement the day (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_addyears_1853430648.md b/windows.globalization/calendar_addyears_1853430648.md index 848e731595..9c70e7e9c2 100644 --- a/windows.globalization/calendar_addyears_1853430648.md +++ b/windows.globalization/calendar_addyears_1853430648.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.AddYears(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.AddYears ## -description Increments or decrements the year. ## -parameters ### -param years The number of years by which to increment the year (if the value is positive) or decrement the year (if the value is negative). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.AddYears(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.AddYears + +## -description +Increments or decrements the year. + +## -parameters +### -param years +The number of years by which to increment the year (if the value is positive) or decrement the year (if the value is negative). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_calendar_1181929246.md b/windows.globalization/calendar_calendar_1181929246.md index f02ead0c35..2b61632d51 100644 --- a/windows.globalization/calendar_calendar_1181929246.md +++ b/windows.globalization/calendar_calendar_1181929246.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Globalization.Calendar.#ctor(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Globalization.Calendar.Calendar ## -description Creates a [Calendar](calendar.md) object that is initialized with a language list. ## -parameters ### -param languages The list of language identifiers, in priority order, that represents the choice of languages. These are used for resolving patterns to strings. See Remarks. ## -remarks ## -examples ## -see-also [Calendar(IIterable(String), String, String)](calendar_calendar_1820927522.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.#ctor(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.Calendar + +## -description +Creates a [Calendar](calendar.md) object that is initialized with a language list. + +## -parameters +### -param languages +The list of language identifiers, in priority order, that represents the choice of languages. These are used for resolving patterns to strings. See Remarks. + +## -remarks + +## -examples + +## -see-also +[Calendar(IIterable(String), String, String)](calendar_calendar_1820927522.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization/calendar_calendar_1221375020.md b/windows.globalization/calendar_calendar_1221375020.md index eda029dce6..bcc3185f01 100644 --- a/windows.globalization/calendar_calendar_1221375020.md +++ b/windows.globalization/calendar_calendar_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Globalization.Calendar.#ctor --api-type: winrt method ---- # Windows.Globalization.Calendar.Calendar ## -description Creates a [Calendar](calendar.md) object and initializes it to the current date and time. ## -remarks ## -examples ## -see-also [Calendar(IIterable_1, String, String)](calendar_calendar_1820927522.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.Calendar + +## -description +Creates a [Calendar](calendar.md) object and initializes it to the current date and time. + +## -remarks + +## -examples + +## -see-also +[Calendar(IIterable_1, String, String)](calendar_calendar_1820927522.md) \ No newline at end of file diff --git a/windows.globalization/calendar_calendar_1601769694.md b/windows.globalization/calendar_calendar_1601769694.md index 7a9829ed98..38c03ba18a 100644 --- a/windows.globalization/calendar_calendar_1601769694.md +++ b/windows.globalization/calendar_calendar_1601769694.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Globalization.Calendar.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String,System.String,System.String) --api-type: winrt method ---- # Windows.Globalization.Calendar.Calendar ## -description Creates a [Calendar](calendar.md) object that is initialized with a language list, calendar, clock, and time zone. ## -parameters ### -param languages The list of language identifiers, in priority order, representing the choice of languages. These are used for resolving patterns to strings. See Remarks. ### -param calendar The calendar identifier to use. ### -param clock The clock identifier to use. ### -param timeZoneId An identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) which identifies the time zone that should be used (for example, "America/Los_Angeles" for Pacific Time). ## -remarks ## -examples ## -see-also [Calendar(IIterable(String))](calendar_calendar_1181929246.md), [Calendar(IIterable(String), String, String)](calendar_calendar_1820927522.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.Calendar + +## -description +Creates a [Calendar](calendar.md) object that is initialized with a language list, calendar, clock, and time zone. + +## -parameters +### -param languages +The list of language identifiers, in priority order, representing the choice of languages. These are used for resolving patterns to strings. See Remarks. + +### -param calendar +The calendar identifier to use. + +### -param clock +The clock identifier to use. + +### -param timeZoneId +An identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) which identifies the time zone that should be used (for example, "America/Los_Angeles" for Pacific Time). + +## -remarks + +## -examples + +## -see-also +[Calendar(IIterable(String))](calendar_calendar_1181929246.md), [Calendar(IIterable(String), String, String)](calendar_calendar_1820927522.md), [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization/calendar_calendar_1820927522.md b/windows.globalization/calendar_calendar_1820927522.md index d042ef4222..f425121ef0 100644 --- a/windows.globalization/calendar_calendar_1820927522.md +++ b/windows.globalization/calendar_calendar_1820927522.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.Calendar.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String,System.String) --api-type: winrt method ---- # Windows.Globalization.Calendar.Calendar ## -description Creates a [Calendar](calendar.md) object that is initialized with a language list, calendar, and clock. ## -parameters ### -param languages The list of language identifiers, in priority order, representing the choice of languages. These are used for resolving patterns to strings. See Remarks. ### -param calendar The calendar identifier to use. ### -param clock The clock identifier to use. ## -remarks ## -examples ## -see-also [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.Calendar + +## -description +Creates a [Calendar](calendar.md) object that is initialized with a language list, calendar, and clock. + +## -parameters +### -param languages +The list of language identifiers, in priority order, representing the choice of languages. These are used for resolving patterns to strings. See Remarks. + +### -param calendar +The calendar identifier to use. + +### -param clock +The clock identifier to use. + +## -remarks + +## -examples + +## -see-also +[Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization/calendar_changecalendarsystem_1371050862.md b/windows.globalization/calendar_changecalendarsystem_1371050862.md index d885f568e6..c1a66947e1 100644 --- a/windows.globalization/calendar_changecalendarsystem_1371050862.md +++ b/windows.globalization/calendar_changecalendarsystem_1371050862.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.ChangeCalendarSystem(System.String) --api-type: winrt method ---- # Windows.Globalization.Calendar.ChangeCalendarSystem ## -description Sets a new calendar system to be used by this [Calendar](calendar.md) object. ## -parameters ### -param value The calendar identifier to use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.ChangeCalendarSystem(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.ChangeCalendarSystem + +## -description +Sets a new calendar system to be used by this [Calendar](calendar.md) object. + +## -parameters +### -param value +The calendar identifier to use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_changeclock_998984104.md b/windows.globalization/calendar_changeclock_998984104.md index 012260a3ed..61a50345be 100644 --- a/windows.globalization/calendar_changeclock_998984104.md +++ b/windows.globalization/calendar_changeclock_998984104.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.ChangeClock(System.String) --api-type: winrt method ---- # Windows.Globalization.Calendar.ChangeClock ## -description Sets a new clock to be used by this [Calendar](calendar.md) object. ## -parameters ### -param value The clock identifier to use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.ChangeClock(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.ChangeClock + +## -description +Sets a new clock to be used by this [Calendar](calendar.md) object. + +## -parameters +### -param value +The clock identifier to use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_changetimezone_1072791752.md b/windows.globalization/calendar_changetimezone_1072791752.md index 309f7776a9..c37501ac90 100644 --- a/windows.globalization/calendar_changetimezone_1072791752.md +++ b/windows.globalization/calendar_changetimezone_1072791752.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Globalization.Calendar.ChangeTimeZone(System.String) --api-type: winrt method ---- # Windows.Globalization.Calendar.ChangeTimeZone ## -description Sets a new time zone to be used by this [Calendar](calendar.md) object. ## -parameters ### -param timeZoneId An identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) which identifies the time zone that should be used (for example, "America/Los_Angeles" for Pacific Time). ## -remarks The values of other properties of this [Calendar](calendar.md) object may change as a result. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.ChangeTimeZone(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.ChangeTimeZone + +## -description +Sets a new time zone to be used by this [Calendar](calendar.md) object. + +## -parameters +### -param timeZoneId +An identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) which identifies the time zone that should be used (for example, "America/Los_Angeles" for Pacific Time). + +## -remarks +The values of other properties of this [Calendar](calendar.md) object may change as a result. + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_clone_766852569.md b/windows.globalization/calendar_clone_766852569.md index d6e709d7f0..e2d05c08a3 100644 --- a/windows.globalization/calendar_clone_766852569.md +++ b/windows.globalization/calendar_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.Clone --api-type: winrt method ---- # Windows.Globalization.Calendar.Clone ## -description Creates a copy of the [Calendar](calendar.md) object. ## -returns A copy of the [Calendar](calendar.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.Clone +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.Clone + +## -description +Creates a copy of the [Calendar](calendar.md) object. + +## -returns +A copy of the [Calendar](calendar.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_compare_726932726.md b/windows.globalization/calendar_compare_726932726.md index c5785cae10..92e9aa3fcc 100644 --- a/windows.globalization/calendar_compare_726932726.md +++ b/windows.globalization/calendar_compare_726932726.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Globalization.Calendar.Compare(Windows.Globalization.Calendar) --api-type: winrt method ---- # Windows.Globalization.Calendar.Compare ## -description Compares this calendar to another [Calendar](calendar.md) object and indicates whether the date and time of one is earlier, equal to, or later than that of the other. ## -parameters ### -param other The [Calendar](calendar.md) object to compare to the current calendar. ## -returns One of the following values:
Return valueDescription
Less than zeroThe date and time of this calendar is earlier than that of *other*.
ZeroThe date and times are equal.
Greater than zeroThe date and time of this calendar is later than that of *other*.
## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.Compare(Windows.Globalization.Calendar) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.Compare + +## -description +Compares this calendar to another [Calendar](calendar.md) object and indicates whether the date and time of one is earlier, equal to, or later than that of the other. + +## -parameters +### -param other +The [Calendar](calendar.md) object to compare to the current calendar. + +## -returns +One of the following values: + + + + + + +
Return valueDescription
Less than zeroThe date and time of this calendar is earlier than that of *other*.
ZeroThe date and times are equal.
Greater than zeroThe date and time of this calendar is later than that of *other*.
+ +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_comparedatetime_356946824.md b/windows.globalization/calendar_comparedatetime_356946824.md index 73c0b0bfc8..d5f0c6758f 100644 --- a/windows.globalization/calendar_comparedatetime_356946824.md +++ b/windows.globalization/calendar_comparedatetime_356946824.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Globalization.Calendar.CompareDateTime(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Globalization.Calendar.CompareDateTime ## -description Compares this calendar to a [DateTime](../windows.foundation/datetime.md) object and indicates whether the date and time of one is earlier, equal to, or later than that of the other. ## -parameters ### -param other The [DateTime](../windows.foundation/datetime.md) object to compare to the current calendar. ## -returns One of the following values:
Return valueDescription
Less than zeroThe date and time of this calendar is earlier than that of *other*.
ZeroThe date and times are equal.
Greater than zeroThe date and time of this calendar is later than that of *other*.
## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.CompareDateTime(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.CompareDateTime + +## -description +Compares this calendar to a [DateTime](../windows.foundation/datetime.md) object and indicates whether the date and time of one is earlier, equal to, or later than that of the other. + +## -parameters +### -param other +The [DateTime](../windows.foundation/datetime.md) object to compare to the current calendar. + +## -returns +One of the following values: + + + + + + +
Return valueDescription
Less than zeroThe date and time of this calendar is earlier than that of *other*.
ZeroThe date and times are equal.
Greater than zeroThe date and time of this calendar is later than that of *other*.
+ +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_copyto_1875457021.md b/windows.globalization/calendar_copyto_1875457021.md index 14ff595a81..ed6d46429e 100644 --- a/windows.globalization/calendar_copyto_1875457021.md +++ b/windows.globalization/calendar_copyto_1875457021.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.CopyTo(Windows.Globalization.Calendar) --api-type: winrt method ---- # Windows.Globalization.Calendar.CopyTo ## -description Copies the values from another [Calendar](calendar.md) object into this [Calendar](calendar.md). ## -parameters ### -param other The [Calendar](calendar.md) object to be copied. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.CopyTo(Windows.Globalization.Calendar) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.CopyTo + +## -description +Copies the values from another [Calendar](calendar.md) object into this [Calendar](calendar.md). + +## -parameters +### -param other +The [Calendar](calendar.md) object to be copied. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_day.md b/windows.globalization/calendar_day.md index e17c21f62f..8cc012a967 100644 --- a/windows.globalization/calendar_day.md +++ b/windows.globalization/calendar_day.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Day --api-type: winrt property ---- # Windows.Globalization.Calendar.Day ## -description Gets or sets the day. ## -property-value The day. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Day +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Day + +## -description +Gets or sets the day. + +## -property-value +The day. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_dayaspaddedstring_11483621.md b/windows.globalization/calendar_dayaspaddedstring_11483621.md index dd23b55bb1..9b6b1cd31e 100644 --- a/windows.globalization/calendar_dayaspaddedstring_11483621.md +++ b/windows.globalization/calendar_dayaspaddedstring_11483621.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.DayAsPaddedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.DayAsPaddedString ## -description Returns a string representation of the day, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the day does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the day 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. ## -returns A string representation of the day. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.DayAsPaddedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.DayAsPaddedString + +## -description +Returns a string representation of the day, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the day does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the day 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. + +## -returns +A string representation of the day. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_dayasstring_2031719947.md b/windows.globalization/calendar_dayasstring_2031719947.md index 31f8c5c13c..0294c57184 100644 --- a/windows.globalization/calendar_dayasstring_2031719947.md +++ b/windows.globalization/calendar_dayasstring_2031719947.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.DayAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.DayAsString ## -description Returns a string that contains the numeric representation of the day. ## -returns A string representation of the day. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.DayAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.DayAsString + +## -description +Returns a string that contains the numeric representation of the day. + +## -returns +A string representation of the day. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_dayofweek.md b/windows.globalization/calendar_dayofweek.md index a577ec2a9b..2fcbb32d61 100644 --- a/windows.globalization/calendar_dayofweek.md +++ b/windows.globalization/calendar_dayofweek.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.DayOfWeek --api-type: winrt property ---- # Windows.Globalization.Calendar.DayOfWeek ## -description Gets the day of the week. ## -property-value The day of the week. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.DayOfWeek +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.DayOfWeek + +## -description +Gets the day of the week. + +## -property-value +The day of the week. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_dayofweekassolostring_158875511.md b/windows.globalization/calendar_dayofweekassolostring_158875511.md index 0616e80e13..c71adc683f 100644 --- a/windows.globalization/calendar_dayofweekassolostring_158875511.md +++ b/windows.globalization/calendar_dayofweekassolostring_158875511.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.DayOfWeekAsSoloString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.DayOfWeekAsSoloString ## -description Returns a string representation of the day of the week suitable for stand-alone display. ## -parameters ### -param idealLength A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. ## -returns A string representation of the day of the week. ## -remarks ## -examples ## -see-also [DayOfWeekAsSoloString](calendar_dayofweekassolostring_1841313841.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.DayOfWeekAsSoloString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.DayOfWeekAsSoloString + +## -description +Returns a string representation of the day of the week suitable for stand-alone display. + +## -parameters +### -param idealLength +A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. + +## -returns +A string representation of the day of the week. + +## -remarks + +## -examples + +## -see-also +[DayOfWeekAsSoloString](calendar_dayofweekassolostring_1841313841.md) \ No newline at end of file diff --git a/windows.globalization/calendar_dayofweekassolostring_1841313841.md b/windows.globalization/calendar_dayofweekassolostring_1841313841.md index b07aa18c19..9e3ce3d478 100644 --- a/windows.globalization/calendar_dayofweekassolostring_1841313841.md +++ b/windows.globalization/calendar_dayofweekassolostring_1841313841.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.DayOfWeekAsSoloString --api-type: winrt method ---- # Windows.Globalization.Calendar.DayOfWeekAsSoloString ## -description Returns a string representation of the day of the week suitable for stand-alone display. ## -returns A string representation of the day of the week, using the most common abbreviation available. ## -remarks ## -examples ## -see-also [DayOfWeekAsSoloString(Int32)](calendar_dayofweekassolostring_158875511.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.DayOfWeekAsSoloString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.DayOfWeekAsSoloString + +## -description +Returns a string representation of the day of the week suitable for stand-alone display. + +## -returns +A string representation of the day of the week, using the most common abbreviation available. + +## -remarks + +## -examples + +## -see-also +[DayOfWeekAsSoloString(Int32)](calendar_dayofweekassolostring_158875511.md) \ No newline at end of file diff --git a/windows.globalization/calendar_dayofweekasstring_1060814738.md b/windows.globalization/calendar_dayofweekasstring_1060814738.md index 624ea9931b..3a07d8e8bc 100644 --- a/windows.globalization/calendar_dayofweekasstring_1060814738.md +++ b/windows.globalization/calendar_dayofweekasstring_1060814738.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.DayOfWeekAsString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.DayOfWeekAsString ## -description Returns a string representation of the day of the week suitable for inclusion with other date components. ## -parameters ### -param idealLength A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. ## -returns A string representation of the day of the week. ## -remarks ## -examples ## -see-also [DayOfWeekAsString](calendar_dayofweekasstring_1535293654.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.DayOfWeekAsString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.DayOfWeekAsString + +## -description +Returns a string representation of the day of the week suitable for inclusion with other date components. + +## -parameters +### -param idealLength +A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. + +## -returns +A string representation of the day of the week. + +## -remarks + +## -examples + +## -see-also +[DayOfWeekAsString](calendar_dayofweekasstring_1535293654.md) \ No newline at end of file diff --git a/windows.globalization/calendar_dayofweekasstring_1535293654.md b/windows.globalization/calendar_dayofweekasstring_1535293654.md index 40238d0eae..42497780e6 100644 --- a/windows.globalization/calendar_dayofweekasstring_1535293654.md +++ b/windows.globalization/calendar_dayofweekasstring_1535293654.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.DayOfWeekAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.DayOfWeekAsString ## -description Returns a string representation of the day of the week suitable for inclusion with other date components. ## -returns A string representation of the day of the week, using the most common abbreviation available. ## -remarks ## -examples ## -see-also [DayOfWeekAsString(Int32)](calendar_dayofweekasstring_1060814738.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.DayOfWeekAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.DayOfWeekAsString + +## -description +Returns a string representation of the day of the week suitable for inclusion with other date components. + +## -returns +A string representation of the day of the week, using the most common abbreviation available. + +## -remarks + +## -examples + +## -see-also +[DayOfWeekAsString(Int32)](calendar_dayofweekasstring_1060814738.md) \ No newline at end of file diff --git a/windows.globalization/calendar_era.md b/windows.globalization/calendar_era.md index 9177aec058..84e52caa96 100644 --- a/windows.globalization/calendar_era.md +++ b/windows.globalization/calendar_era.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Era --api-type: winrt property ---- # Windows.Globalization.Calendar.Era ## -description Gets or sets the era. ## -property-value The integer that represents the era. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Era +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Era + +## -description +Gets or sets the era. + +## -property-value +The integer that represents the era. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_eraasstring_1742852677.md b/windows.globalization/calendar_eraasstring_1742852677.md index fd48440dda..723d6f98f3 100644 --- a/windows.globalization/calendar_eraasstring_1742852677.md +++ b/windows.globalization/calendar_eraasstring_1742852677.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.EraAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.EraAsString ## -description Returns a string representation of the era. ## -returns A string representation of the era, using the most common abbreviation available. ## -remarks ## -examples ## -see-also [EraAsString(Int32)](calendar_eraasstring_56218883.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.EraAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.EraAsString + +## -description +Returns a string representation of the era. + +## -returns +A string representation of the era, using the most common abbreviation available. + +## -remarks + +## -examples + +## -see-also +[EraAsString(Int32)](calendar_eraasstring_56218883.md) \ No newline at end of file diff --git a/windows.globalization/calendar_eraasstring_56218883.md b/windows.globalization/calendar_eraasstring_56218883.md index 0677059ecc..5b8edc66e6 100644 --- a/windows.globalization/calendar_eraasstring_56218883.md +++ b/windows.globalization/calendar_eraasstring_56218883.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.EraAsString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.EraAsString ## -description Returns a string representation of the era. The string chosen is closest in length to the ideal length. ## -parameters ### -param idealLength A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. ## -returns A string representation of the era. ## -remarks ## -examples ## -see-also [EraAsString](calendar_eraasstring_1742852677.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.EraAsString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.EraAsString + +## -description +Returns a string representation of the era. The string chosen is closest in length to the ideal length. + +## -parameters +### -param idealLength +A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. + +## -returns +A string representation of the era. + +## -remarks + +## -examples + +## -see-also +[EraAsString](calendar_eraasstring_1742852677.md) \ No newline at end of file diff --git a/windows.globalization/calendar_firstdayinthismonth.md b/windows.globalization/calendar_firstdayinthismonth.md index d6b7d147d8..caf1ddaf90 100644 --- a/windows.globalization/calendar_firstdayinthismonth.md +++ b/windows.globalization/calendar_firstdayinthismonth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstDayInThisMonth --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstDayInThisMonth ## -description Gets the first [Day](calendar_day.md) of the current [Month](calendar_month.md). ## -property-value The first [Day](calendar_day.md) of the current [Month](calendar_month.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstDayInThisMonth +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstDayInThisMonth + +## -description +Gets the first [Day](calendar_day.md) of the current [Month](calendar_month.md). + +## -property-value +The first [Day](calendar_day.md) of the current [Month](calendar_month.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firstera.md b/windows.globalization/calendar_firstera.md index 8890b24010..a7e354996e 100644 --- a/windows.globalization/calendar_firstera.md +++ b/windows.globalization/calendar_firstera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstEra --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstEra ## -description Gets the first [Era](calendar_era.md) available in the calendar. ## -property-value The first [Era](calendar_era.md) in the calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstEra +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstEra + +## -description +Gets the first [Era](calendar_era.md) available in the calendar. + +## -property-value +The first [Era](calendar_era.md) in the calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firsthourinthisperiod.md b/windows.globalization/calendar_firsthourinthisperiod.md index 30581bc932..e358fcb5c8 100644 --- a/windows.globalization/calendar_firsthourinthisperiod.md +++ b/windows.globalization/calendar_firsthourinthisperiod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstHourInThisPeriod --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstHourInThisPeriod ## -description Gets the first [Hour](calendar_hour.md) of the current [Period](calendar_period.md). ## -property-value The first [Hour](calendar_hour.md) of the current [Period](calendar_period.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstHourInThisPeriod +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstHourInThisPeriod + +## -description +Gets the first [Hour](calendar_hour.md) of the current [Period](calendar_period.md). + +## -property-value +The first [Hour](calendar_hour.md) of the current [Period](calendar_period.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firstminuteinthishour.md b/windows.globalization/calendar_firstminuteinthishour.md index 427b9cde89..8ecc5371c4 100644 --- a/windows.globalization/calendar_firstminuteinthishour.md +++ b/windows.globalization/calendar_firstminuteinthishour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstMinuteInThisHour --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstMinuteInThisHour ## -description Gets the first [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). ## -property-value The first [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstMinuteInThisHour +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstMinuteInThisHour + +## -description +Gets the first [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). + +## -property-value +The first [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firstmonthinthisyear.md b/windows.globalization/calendar_firstmonthinthisyear.md index 92683c8e37..95f16f6b78 100644 --- a/windows.globalization/calendar_firstmonthinthisyear.md +++ b/windows.globalization/calendar_firstmonthinthisyear.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstMonthInThisYear --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstMonthInThisYear ## -description Gets the first [Month](calendar_month.md) of the current [Year](calendar_year.md). ## -property-value The first [Month](calendar_month.md) of the current [Year](calendar_year.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstMonthInThisYear +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstMonthInThisYear + +## -description +Gets the first [Month](calendar_month.md) of the current [Year](calendar_year.md). + +## -property-value +The first [Month](calendar_month.md) of the current [Year](calendar_year.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firstperiodinthisday.md b/windows.globalization/calendar_firstperiodinthisday.md index c6d5022a7c..18cfff8d18 100644 --- a/windows.globalization/calendar_firstperiodinthisday.md +++ b/windows.globalization/calendar_firstperiodinthisday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstPeriodInThisDay --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstPeriodInThisDay ## -description Gets the first [Period](calendar_period.md) of the current [Day](calendar_day.md). ## -property-value The first [Period](calendar_period.md) of the current [Day](calendar_day.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstPeriodInThisDay +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstPeriodInThisDay + +## -description +Gets the first [Period](calendar_period.md) of the current [Day](calendar_day.md). + +## -property-value +The first [Period](calendar_period.md) of the current [Day](calendar_day.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firstsecondinthisminute.md b/windows.globalization/calendar_firstsecondinthisminute.md index 162f332b08..d7ad3d5045 100644 --- a/windows.globalization/calendar_firstsecondinthisminute.md +++ b/windows.globalization/calendar_firstsecondinthisminute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstSecondInThisMinute --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstSecondInThisMinute ## -description Gets the first [Second](calendar_second.md) of the current [Minute](calendar_minute.md). ## -property-value The first [Second](calendar_second.md) of the current [Minute](calendar_minute.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstSecondInThisMinute +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstSecondInThisMinute + +## -description +Gets the first [Second](calendar_second.md) of the current [Minute](calendar_minute.md). + +## -property-value +The first [Second](calendar_second.md) of the current [Minute](calendar_minute.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_firstyearinthisera.md b/windows.globalization/calendar_firstyearinthisera.md index dcadbb2250..5a67498c58 100644 --- a/windows.globalization/calendar_firstyearinthisera.md +++ b/windows.globalization/calendar_firstyearinthisera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.FirstYearInThisEra --api-type: winrt property ---- # Windows.Globalization.Calendar.FirstYearInThisEra ## -description Gets the first [Year](calendar_year.md) of the current [Era](calendar_era.md). ## -property-value The first [Year](calendar_year.md) of the current [Era](calendar_era.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.FirstYearInThisEra +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.FirstYearInThisEra + +## -description +Gets the first [Year](calendar_year.md) of the current [Era](calendar_era.md). + +## -property-value +The first [Year](calendar_year.md) of the current [Era](calendar_era.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_getcalendarsystem_489887639.md b/windows.globalization/calendar_getcalendarsystem_489887639.md index ad12559b08..6ea0dfe637 100644 --- a/windows.globalization/calendar_getcalendarsystem_489887639.md +++ b/windows.globalization/calendar_getcalendarsystem_489887639.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.GetCalendarSystem --api-type: winrt method ---- # Windows.Globalization.Calendar.GetCalendarSystem ## -description Gets the calendar system that is used by this [Calendar](calendar.md) object. ## -returns The identifier of the calendar system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.GetCalendarSystem +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.GetCalendarSystem + +## -description +Gets the calendar system that is used by this [Calendar](calendar.md) object. + +## -returns +The identifier of the calendar system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_getclock_681906964.md b/windows.globalization/calendar_getclock_681906964.md index 2935e68c52..e06f5683c4 100644 --- a/windows.globalization/calendar_getclock_681906964.md +++ b/windows.globalization/calendar_getclock_681906964.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.GetClock --api-type: winrt method ---- # Windows.Globalization.Calendar.GetClock ## -description Gets the clock that is used by this [Calendar](calendar.md) object. ## -returns The identifier of the clock. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.GetClock +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.GetClock + +## -description +Gets the clock that is used by this [Calendar](calendar.md) object. + +## -returns +The identifier of the clock. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_getdatetime_624256552.md b/windows.globalization/calendar_getdatetime_624256552.md index ee0abe1916..c145305df7 100644 --- a/windows.globalization/calendar_getdatetime_624256552.md +++ b/windows.globalization/calendar_getdatetime_624256552.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.GetDateTime --api-type: winrt method ---- # Windows.Globalization.Calendar.GetDateTime ## -description Builds a date and time, given the components of this [Calendar](calendar.md) object. ## -returns The [DateTime](../windows.foundation/datetime.md) representing the date and time of this [Calendar](calendar.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.GetDateTime +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.GetDateTime + +## -description +Builds a date and time, given the components of this [Calendar](calendar.md) object. + +## -returns +The [DateTime](../windows.foundation/datetime.md) representing the date and time of this [Calendar](calendar.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_gettimezone_550856478.md b/windows.globalization/calendar_gettimezone_550856478.md index 0f5a536584..fcd79204e5 100644 --- a/windows.globalization/calendar_gettimezone_550856478.md +++ b/windows.globalization/calendar_gettimezone_550856478.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.GetTimeZone --api-type: winrt method ---- # Windows.Globalization.Calendar.GetTimeZone ## -description Gets the identifier that identifies the time zone that is used by this [Calendar](calendar.md) object. ## -returns The identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) that identifies the time zone that is used by this [Calendar](calendar.md) object. (An example is "America/Los_Angeles" for Pacific Time.) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.GetTimeZone +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.GetTimeZone + +## -description +Gets the identifier that identifies the time zone that is used by this [Calendar](calendar.md) object. + +## -returns +The identifier from the [IANA Time Zone Database](http://go.microsoft.com/fwlink/p/?LinkId=302107) that identifies the time zone that is used by this [Calendar](calendar.md) object. (An example is "America/Los_Angeles" for Pacific Time.) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_hour.md b/windows.globalization/calendar_hour.md index a3cff9343b..70df54dffc 100644 --- a/windows.globalization/calendar_hour.md +++ b/windows.globalization/calendar_hour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Hour --api-type: winrt property ---- # Windows.Globalization.Calendar.Hour ## -description Gets or sets the hour. ## -property-value The hour. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Hour +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Hour + +## -description +Gets or sets the hour. + +## -property-value +The hour. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_houraspaddedstring_968487460.md b/windows.globalization/calendar_houraspaddedstring_968487460.md index edf9c9113c..02759e315b 100644 --- a/windows.globalization/calendar_houraspaddedstring_968487460.md +++ b/windows.globalization/calendar_houraspaddedstring_968487460.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.HourAsPaddedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.HourAsPaddedString ## -description Returns a string representation of the hour, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the hour does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the hour 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. ## -returns A string representation of the hour. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.HourAsPaddedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.HourAsPaddedString + +## -description +Returns a string representation of the hour, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the hour does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the hour 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. + +## -returns +A string representation of the hour. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_hourasstring_1431657030.md b/windows.globalization/calendar_hourasstring_1431657030.md index 3e820c7b91..263c23e0f3 100644 --- a/windows.globalization/calendar_hourasstring_1431657030.md +++ b/windows.globalization/calendar_hourasstring_1431657030.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.HourAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.HourAsString ## -description Returns a string that contains the numeric representation of the hour. ## -returns A string representation of the hour. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.HourAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.HourAsString + +## -description +Returns a string that contains the numeric representation of the hour. + +## -returns +A string representation of the hour. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_isdaylightsavingtime.md b/windows.globalization/calendar_isdaylightsavingtime.md index 63ecf9c648..c733cae639 100644 --- a/windows.globalization/calendar_isdaylightsavingtime.md +++ b/windows.globalization/calendar_isdaylightsavingtime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.IsDaylightSavingTime --api-type: winrt property ---- # Windows.Globalization.Calendar.IsDaylightSavingTime ## -description Gets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) indicating if Daylight Saving Time is in effect for the date of this [Calendar](calendar.md) object. ## -property-value **True** if Daylight Saving Time is in effect for the date; otherwise, **False**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.IsDaylightSavingTime +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.IsDaylightSavingTime + +## -description +Gets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) indicating if Daylight Saving Time is in effect for the date of this [Calendar](calendar.md) object. + +## -property-value +**True** if Daylight Saving Time is in effect for the date; otherwise, **False**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_languages.md b/windows.globalization/calendar_languages.md index 27c5e142b3..550cd4f63a 100644 --- a/windows.globalization/calendar_languages.md +++ b/windows.globalization/calendar_languages.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.Calendar.Languages --api-type: winrt property ---- # Windows.Globalization.Calendar.Languages ## -description Gets the priority list of language identifiers that is used when formatting components as strings. ## -property-value The list of language identifiers. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Calendar(IIterable(String))](calendar_calendar_1181929246.md) constructor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Languages +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Languages + +## -description +Gets the priority list of language identifiers that is used when formatting components as strings. + +## -property-value +The list of language identifiers. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Calendar(IIterable(String))](calendar_calendar_1181929246.md) constructor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastdayinthismonth.md b/windows.globalization/calendar_lastdayinthismonth.md index 787eaf2ccb..30891e1cd8 100644 --- a/windows.globalization/calendar_lastdayinthismonth.md +++ b/windows.globalization/calendar_lastdayinthismonth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastDayInThisMonth --api-type: winrt property ---- # Windows.Globalization.Calendar.LastDayInThisMonth ## -description Gets the last [Day](calendar_day.md) of the current [Month](calendar_month.md). ## -property-value The last [Day](calendar_day.md) of the current [Month](calendar_month.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastDayInThisMonth +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastDayInThisMonth + +## -description +Gets the last [Day](calendar_day.md) of the current [Month](calendar_month.md). + +## -property-value +The last [Day](calendar_day.md) of the current [Month](calendar_month.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastera.md b/windows.globalization/calendar_lastera.md index 233103cd7b..8c055fd34f 100644 --- a/windows.globalization/calendar_lastera.md +++ b/windows.globalization/calendar_lastera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastEra --api-type: winrt property ---- # Windows.Globalization.Calendar.LastEra ## -description Gets the last [Era](calendar_era.md) available in the calendar. ## -property-value The last [Era](calendar_era.md) in the calendar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastEra +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastEra + +## -description +Gets the last [Era](calendar_era.md) available in the calendar. + +## -property-value +The last [Era](calendar_era.md) in the calendar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lasthourinthisperiod.md b/windows.globalization/calendar_lasthourinthisperiod.md index b0d10da012..00e8e66532 100644 --- a/windows.globalization/calendar_lasthourinthisperiod.md +++ b/windows.globalization/calendar_lasthourinthisperiod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastHourInThisPeriod --api-type: winrt property ---- # Windows.Globalization.Calendar.LastHourInThisPeriod ## -description Gets the last [Hour](calendar_hour.md) of the current [Period](calendar_period.md). ## -property-value The last [Hour](calendar_hour.md) of the current [Period](calendar_period.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastHourInThisPeriod +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastHourInThisPeriod + +## -description +Gets the last [Hour](calendar_hour.md) of the current [Period](calendar_period.md). + +## -property-value +The last [Hour](calendar_hour.md) of the current [Period](calendar_period.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastminuteinthishour.md b/windows.globalization/calendar_lastminuteinthishour.md index 1d09deb145..8945c5d3c9 100644 --- a/windows.globalization/calendar_lastminuteinthishour.md +++ b/windows.globalization/calendar_lastminuteinthishour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastMinuteInThisHour --api-type: winrt property ---- # Windows.Globalization.Calendar.LastMinuteInThisHour ## -description Gets the last [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). ## -property-value The last [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastMinuteInThisHour +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastMinuteInThisHour + +## -description +Gets the last [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). + +## -property-value +The last [Minute](calendar_minute.md) of the current [Hour](calendar_hour.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastmonthinthisyear.md b/windows.globalization/calendar_lastmonthinthisyear.md index 960ad5868b..5783769f52 100644 --- a/windows.globalization/calendar_lastmonthinthisyear.md +++ b/windows.globalization/calendar_lastmonthinthisyear.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastMonthInThisYear --api-type: winrt property ---- # Windows.Globalization.Calendar.LastMonthInThisYear ## -description Gets the last [Month](calendar_month.md) of the current [Year](calendar_year.md). ## -property-value The last [Month](calendar_month.md) of the current [Year](calendar_year.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastMonthInThisYear +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastMonthInThisYear + +## -description +Gets the last [Month](calendar_month.md) of the current [Year](calendar_year.md). + +## -property-value +The last [Month](calendar_month.md) of the current [Year](calendar_year.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastperiodinthisday.md b/windows.globalization/calendar_lastperiodinthisday.md index e442d684a9..b30e70ab4a 100644 --- a/windows.globalization/calendar_lastperiodinthisday.md +++ b/windows.globalization/calendar_lastperiodinthisday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastPeriodInThisDay --api-type: winrt property ---- # Windows.Globalization.Calendar.LastPeriodInThisDay ## -description Gets the last [Period](calendar_period.md) of the current [Day](calendar_day.md). ## -property-value The last [Period](calendar_period.md) of the current [Day](calendar_day.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastPeriodInThisDay +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastPeriodInThisDay + +## -description +Gets the last [Period](calendar_period.md) of the current [Day](calendar_day.md). + +## -property-value +The last [Period](calendar_period.md) of the current [Day](calendar_day.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastsecondinthisminute.md b/windows.globalization/calendar_lastsecondinthisminute.md index fdaeb97cd5..eff857e792 100644 --- a/windows.globalization/calendar_lastsecondinthisminute.md +++ b/windows.globalization/calendar_lastsecondinthisminute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastSecondInThisMinute --api-type: winrt property ---- # Windows.Globalization.Calendar.LastSecondInThisMinute ## -description Gets the last [Second](calendar_second.md) of the current [Minute](calendar_minute.md). ## -property-value The last [Second](calendar_second.md) of the current [Minute](calendar_minute.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastSecondInThisMinute +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastSecondInThisMinute + +## -description +Gets the last [Second](calendar_second.md) of the current [Minute](calendar_minute.md). + +## -property-value +The last [Second](calendar_second.md) of the current [Minute](calendar_minute.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_lastyearinthisera.md b/windows.globalization/calendar_lastyearinthisera.md index 1223b7461f..73bc95bbe7 100644 --- a/windows.globalization/calendar_lastyearinthisera.md +++ b/windows.globalization/calendar_lastyearinthisera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.LastYearInThisEra --api-type: winrt property ---- # Windows.Globalization.Calendar.LastYearInThisEra ## -description Gets the last [Year](calendar_year.md) of the current [Era](calendar_era.md). ## -property-value The last [Year](calendar_year.md) of the current [Era](calendar_era.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.LastYearInThisEra +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.LastYearInThisEra + +## -description +Gets the last [Year](calendar_year.md) of the current [Era](calendar_era.md). + +## -property-value +The last [Year](calendar_year.md) of the current [Era](calendar_era.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_minute.md b/windows.globalization/calendar_minute.md index 73024a6eba..4ede4807b6 100644 --- a/windows.globalization/calendar_minute.md +++ b/windows.globalization/calendar_minute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Minute --api-type: winrt property ---- # Windows.Globalization.Calendar.Minute ## -description Gets or sets the minute. ## -property-value The minute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Minute +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Minute + +## -description +Gets or sets the minute. + +## -property-value +The minute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_minuteaspaddedstring_1211535669.md b/windows.globalization/calendar_minuteaspaddedstring_1211535669.md index ade72dd335..458bdcdef5 100644 --- a/windows.globalization/calendar_minuteaspaddedstring_1211535669.md +++ b/windows.globalization/calendar_minuteaspaddedstring_1211535669.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.MinuteAsPaddedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.MinuteAsPaddedString ## -description Returns a string representation of the minute, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the minute does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the minute 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. ## -returns A string representation of the minute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MinuteAsPaddedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MinuteAsPaddedString + +## -description +Returns a string representation of the minute, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the minute does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the minute 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. + +## -returns +A string representation of the minute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_minuteasstring_1041829018.md b/windows.globalization/calendar_minuteasstring_1041829018.md index a193aae657..626aa5f442 100644 --- a/windows.globalization/calendar_minuteasstring_1041829018.md +++ b/windows.globalization/calendar_minuteasstring_1041829018.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.MinuteAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.MinuteAsString ## -description Returns a string that contains the numeric representation of the minute. ## -returns A string representation of the minute. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MinuteAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MinuteAsString + +## -description +Returns a string that contains the numeric representation of the minute. + +## -returns +A string representation of the minute. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_month.md b/windows.globalization/calendar_month.md index 58ba55afa5..ab43bdf67c 100644 --- a/windows.globalization/calendar_month.md +++ b/windows.globalization/calendar_month.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Month --api-type: winrt property ---- # Windows.Globalization.Calendar.Month ## -description Gets or sets the month. ## -property-value The month. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Month +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Month + +## -description +Gets or sets the month. + +## -property-value +The month. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_monthasnumericstring_952914344.md b/windows.globalization/calendar_monthasnumericstring_952914344.md index 96b5d7da34..83fc974aa7 100644 --- a/windows.globalization/calendar_monthasnumericstring_952914344.md +++ b/windows.globalization/calendar_monthasnumericstring_952914344.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.MonthAsNumericString --api-type: winrt method ---- # Windows.Globalization.Calendar.MonthAsNumericString ## -description Returns a string that contains the numeric representation of the month. ## -returns A string representation of the month. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MonthAsNumericString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MonthAsNumericString + +## -description +Returns a string that contains the numeric representation of the month. + +## -returns +A string representation of the month. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_monthaspaddednumericstring_1095517048.md b/windows.globalization/calendar_monthaspaddednumericstring_1095517048.md index 57f1148522..7ee5d66fef 100644 --- a/windows.globalization/calendar_monthaspaddednumericstring_1095517048.md +++ b/windows.globalization/calendar_monthaspaddednumericstring_1095517048.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.MonthAsPaddedNumericString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.MonthAsPaddedNumericString ## -description Returns a string representation of the month, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the month does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the month 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. ## -returns A string representation of the month. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MonthAsPaddedNumericString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MonthAsPaddedNumericString + +## -description +Returns a string representation of the month, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the month does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the month 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. + +## -returns +A string representation of the month. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_monthassolostring_1163050283.md b/windows.globalization/calendar_monthassolostring_1163050283.md index 93c0c3a792..1cb3bed0f1 100644 --- a/windows.globalization/calendar_monthassolostring_1163050283.md +++ b/windows.globalization/calendar_monthassolostring_1163050283.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.MonthAsSoloString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.MonthAsSoloString ## -description Returns a string representation of the month suitable for stand-alone display. ## -parameters ### -param idealLength A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. ## -returns A string representation of the month. ## -remarks ## -examples ## -see-also [MonthAsSoloString](calendar_monthassolostring_569031277.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MonthAsSoloString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MonthAsSoloString + +## -description +Returns a string representation of the month suitable for stand-alone display. + +## -parameters +### -param idealLength +A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. + +## -returns +A string representation of the month. + +## -remarks + +## -examples + +## -see-also +[MonthAsSoloString](calendar_monthassolostring_569031277.md) \ No newline at end of file diff --git a/windows.globalization/calendar_monthassolostring_569031277.md b/windows.globalization/calendar_monthassolostring_569031277.md index 140d5ad3e0..b0b1c5e097 100644 --- a/windows.globalization/calendar_monthassolostring_569031277.md +++ b/windows.globalization/calendar_monthassolostring_569031277.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.MonthAsSoloString --api-type: winrt method ---- # Windows.Globalization.Calendar.MonthAsSoloString ## -description Returns a string representation of the month suitable for stand-alone display. ## -returns A string representation of the month, using the most common abbreviation available. ## -remarks ## -examples ## -see-also [MonthAsSoloString(Int32)](calendar_monthassolostring_1163050283.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MonthAsSoloString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MonthAsSoloString + +## -description +Returns a string representation of the month suitable for stand-alone display. + +## -returns +A string representation of the month, using the most common abbreviation available. + +## -remarks + +## -examples + +## -see-also +[MonthAsSoloString(Int32)](calendar_monthassolostring_1163050283.md) \ No newline at end of file diff --git a/windows.globalization/calendar_monthasstring_14902765.md b/windows.globalization/calendar_monthasstring_14902765.md index 79c8c5393b..10c9b7f52a 100644 --- a/windows.globalization/calendar_monthasstring_14902765.md +++ b/windows.globalization/calendar_monthasstring_14902765.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.MonthAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.MonthAsString ## -description Returns a string representation of the month suitable for inclusion with other date components. ## -returns A string representation of the month, using the most common abbreviation available. ## -remarks ## -examples ## -see-also [MonthAsString(Int32)](calendar_monthasstring_1683710635.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MonthAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MonthAsString + +## -description +Returns a string representation of the month suitable for inclusion with other date components. + +## -returns +A string representation of the month, using the most common abbreviation available. + +## -remarks + +## -examples + +## -see-also +[MonthAsString(Int32)](calendar_monthasstring_1683710635.md) \ No newline at end of file diff --git a/windows.globalization/calendar_monthasstring_1683710635.md b/windows.globalization/calendar_monthasstring_1683710635.md index 139df1742a..07b3e31300 100644 --- a/windows.globalization/calendar_monthasstring_1683710635.md +++ b/windows.globalization/calendar_monthasstring_1683710635.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.MonthAsString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.MonthAsString ## -description Returns a string representation of the month suitable for inclusion with other date components. ## -parameters ### -param idealLength A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. ## -returns A string representation of the month. ## -remarks ## -examples ## -see-also [MonthAsString](calendar_monthasstring_14902765.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.MonthAsString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.MonthAsString + +## -description +Returns a string representation of the month suitable for inclusion with other date components. + +## -parameters +### -param idealLength +A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. + +## -returns +A string representation of the month. + +## -remarks + +## -examples + +## -see-also +[MonthAsString](calendar_monthasstring_14902765.md) \ No newline at end of file diff --git a/windows.globalization/calendar_nanosecond.md b/windows.globalization/calendar_nanosecond.md index 2f04901f58..969e79958f 100644 --- a/windows.globalization/calendar_nanosecond.md +++ b/windows.globalization/calendar_nanosecond.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Nanosecond --api-type: winrt property ---- # Windows.Globalization.Calendar.Nanosecond ## -description Gets or sets the nanosecond. ## -property-value The nanosecond. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Nanosecond +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Nanosecond + +## -description +Gets or sets the nanosecond. + +## -property-value +The nanosecond. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_nanosecondaspaddedstring_1272491220.md b/windows.globalization/calendar_nanosecondaspaddedstring_1272491220.md index 4641f921d5..09b2a4ebcf 100644 --- a/windows.globalization/calendar_nanosecondaspaddedstring_1272491220.md +++ b/windows.globalization/calendar_nanosecondaspaddedstring_1272491220.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.NanosecondAsPaddedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.NanosecondAsPaddedString ## -description Returns a string representation of the nanosecond, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the nanosecond does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the nanosecond 42, a parameter of 1 or 2 returns 42, and a parameter of 3 returns 042. ## -returns A string representation of the nanosecond. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.NanosecondAsPaddedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.NanosecondAsPaddedString + +## -description +Returns a string representation of the nanosecond, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the nanosecond does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the nanosecond 42, a parameter of 1 or 2 returns 42, and a parameter of 3 returns 042. + +## -returns +A string representation of the nanosecond. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_nanosecondasstring_332323234.md b/windows.globalization/calendar_nanosecondasstring_332323234.md index 9b9222f854..02dd8c9af5 100644 --- a/windows.globalization/calendar_nanosecondasstring_332323234.md +++ b/windows.globalization/calendar_nanosecondasstring_332323234.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.NanosecondAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.NanosecondAsString ## -description Returns a string that contains the numeric representation of the nanosecond. ## -returns A string representation of the nanosecond. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.NanosecondAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.NanosecondAsString + +## -description +Returns a string that contains the numeric representation of the nanosecond. + +## -returns +A string representation of the nanosecond. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofdaysinthismonth.md b/windows.globalization/calendar_numberofdaysinthismonth.md index 3720f70940..d84b7af35e 100644 --- a/windows.globalization/calendar_numberofdaysinthismonth.md +++ b/windows.globalization/calendar_numberofdaysinthismonth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfDaysInThisMonth --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfDaysInThisMonth ## -description Gets the number of days in the current month of this [Calendar](calendar.md) object. ## -property-value The number of days in the current month, or – 1 if the number of days in the current month is unknown. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfDaysInThisMonth +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfDaysInThisMonth + +## -description +Gets the number of days in the current month of this [Calendar](calendar.md) object. + +## -property-value +The number of days in the current month, or – 1 if the number of days in the current month is unknown. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberoferas.md b/windows.globalization/calendar_numberoferas.md index 47117f195e..985670e835 100644 --- a/windows.globalization/calendar_numberoferas.md +++ b/windows.globalization/calendar_numberoferas.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfEras --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfEras ## -description Gets the number of eras in this [Calendar](calendar.md) object. ## -property-value The number of eras in the [Calendar](calendar.md), or – 1 if the number of eras in the [Calendar](calendar.md) is unknown. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfEras +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfEras + +## -description +Gets the number of eras in this [Calendar](calendar.md) object. + +## -property-value +The number of eras in the [Calendar](calendar.md), or – 1 if the number of eras in the [Calendar](calendar.md) is unknown. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofhoursinthisperiod.md b/windows.globalization/calendar_numberofhoursinthisperiod.md index dbae579b74..4f8bb02034 100644 --- a/windows.globalization/calendar_numberofhoursinthisperiod.md +++ b/windows.globalization/calendar_numberofhoursinthisperiod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfHoursInThisPeriod --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfHoursInThisPeriod ## -description Gets the number of hours in the current day period of this [Calendar](calendar.md) object. ## -property-value The number of hours in the current day period, or – 1 if the number of hours in the current day period is unknown. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfHoursInThisPeriod +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfHoursInThisPeriod + +## -description +Gets the number of hours in the current day period of this [Calendar](calendar.md) object. + +## -property-value +The number of hours in the current day period, or – 1 if the number of hours in the current day period is unknown. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofminutesinthishour.md b/windows.globalization/calendar_numberofminutesinthishour.md index c303a69032..6689ea6f0e 100644 --- a/windows.globalization/calendar_numberofminutesinthishour.md +++ b/windows.globalization/calendar_numberofminutesinthishour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfMinutesInThisHour --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfMinutesInThisHour ## -description Gets the number of [Minute](calendar_minute.md) s in the current [Hour](calendar_hour.md). ## -property-value The number of [Minute](calendar_minute.md) s in the current [Hour](calendar_hour.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfMinutesInThisHour +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfMinutesInThisHour + +## -description +Gets the number of [Minute](calendar_minute.md) s in the current [Hour](calendar_hour.md). + +## -property-value +The number of [Minute](calendar_minute.md) s in the current [Hour](calendar_hour.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofmonthsinthisyear.md b/windows.globalization/calendar_numberofmonthsinthisyear.md index 7a4084da26..fa7c7d26ef 100644 --- a/windows.globalization/calendar_numberofmonthsinthisyear.md +++ b/windows.globalization/calendar_numberofmonthsinthisyear.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfMonthsInThisYear --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfMonthsInThisYear ## -description Gets the number of months in the current year of this [Calendar](calendar.md) object. ## -property-value The number of months in the current year, or – 1 if the number of months in the current year is unknown. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfMonthsInThisYear +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfMonthsInThisYear + +## -description +Gets the number of months in the current year of this [Calendar](calendar.md) object. + +## -property-value +The number of months in the current year, or – 1 if the number of months in the current year is unknown. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofperiodsinthisday.md b/windows.globalization/calendar_numberofperiodsinthisday.md index c8b1214190..a21a0f1ca2 100644 --- a/windows.globalization/calendar_numberofperiodsinthisday.md +++ b/windows.globalization/calendar_numberofperiodsinthisday.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfPeriodsInThisDay --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfPeriodsInThisDay ## -description Gets the number of periods in the current day of this [Calendar](calendar.md) object. ## -property-value The number of periods in the current day, or – 1 if the number of periods in the current day is unknown. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfPeriodsInThisDay +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfPeriodsInThisDay + +## -description +Gets the number of periods in the current day of this [Calendar](calendar.md) object. + +## -property-value +The number of periods in the current day, or – 1 if the number of periods in the current day is unknown. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofsecondsinthisminute.md b/windows.globalization/calendar_numberofsecondsinthisminute.md index c4f235cd72..b39f42bc5c 100644 --- a/windows.globalization/calendar_numberofsecondsinthisminute.md +++ b/windows.globalization/calendar_numberofsecondsinthisminute.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfSecondsInThisMinute --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfSecondsInThisMinute ## -description Gets the number of [Second](calendar_second.md) s in the current [Minute](calendar_minute.md). ## -property-value The number of [Second](calendar_second.md) s in the current [Minute](calendar_minute.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfSecondsInThisMinute +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfSecondsInThisMinute + +## -description +Gets the number of [Second](calendar_second.md) s in the current [Minute](calendar_minute.md). + +## -property-value +The number of [Second](calendar_second.md) s in the current [Minute](calendar_minute.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numberofyearsinthisera.md b/windows.globalization/calendar_numberofyearsinthisera.md index cc7881d9e6..a7b116fb67 100644 --- a/windows.globalization/calendar_numberofyearsinthisera.md +++ b/windows.globalization/calendar_numberofyearsinthisera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumberOfYearsInThisEra --api-type: winrt property ---- # Windows.Globalization.Calendar.NumberOfYearsInThisEra ## -description Gets the number of years in the current era of this [Calendar](calendar.md) object. ## -property-value The number of years in the current era, or – 1 if there is no known bound to the number of years in the current era. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumberOfYearsInThisEra +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumberOfYearsInThisEra + +## -description +Gets the number of years in the current era of this [Calendar](calendar.md) object. + +## -property-value +The number of years in the current era, or – 1 if there is no known bound to the number of years in the current era. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_numeralsystem.md b/windows.globalization/calendar_numeralsystem.md index 0b88fdd8dd..9d48135b54 100644 --- a/windows.globalization/calendar_numeralsystem.md +++ b/windows.globalization/calendar_numeralsystem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.Calendar.NumeralSystem --api-type: winrt property ---- # Windows.Globalization.Calendar.NumeralSystem ## -description Gets or sets the numbering system that is used when formatting components as strings. ## -property-value A string that indicates the numeral system of the calendar, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.NumeralSystem +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.NumeralSystem + +## -description +Gets or sets the numbering system that is used when formatting components as strings. + +## -property-value +A string that indicates the numeral system of the calendar, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f). + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/calendar_period.md b/windows.globalization/calendar_period.md index c87dbf28f8..7680f9aab2 100644 --- a/windows.globalization/calendar_period.md +++ b/windows.globalization/calendar_period.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Period --api-type: winrt property ---- # Windows.Globalization.Calendar.Period ## -description Gets or sets the period of the current day. ## -property-value A numeric representation of the current day period. With a 12-hour clock, for example, the first period of the day is 1, representing AM, and the second period is 2, representing PM. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Period +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Period + +## -description +Gets or sets the period of the current day. + +## -property-value +A numeric representation of the current day period. With a 12-hour clock, for example, the first period of the day is 1, representing AM, and the second period is 2, representing PM. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_periodasstring_1590229662.md b/windows.globalization/calendar_periodasstring_1590229662.md index 1b38a35873..7840df9eae 100644 --- a/windows.globalization/calendar_periodasstring_1590229662.md +++ b/windows.globalization/calendar_periodasstring_1590229662.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.PeriodAsString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.PeriodAsString ## -description Returns a string representation of the day period, such as AM or PM. ## -parameters ### -param idealLength A positive integer that specifies the ideal length, in characters, for the returned string; or a zero that specifies the most common abbreviation available. ## -returns A string representation for the day period. ## -remarks ## -examples ## -see-also [PeriodAsString](calendar_periodasstring_980483546.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.PeriodAsString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.PeriodAsString + +## -description +Returns a string representation of the day period, such as AM or PM. + +## -parameters +### -param idealLength +A positive integer that specifies the ideal length, in characters, for the returned string; or a zero that specifies the most common abbreviation available. + +## -returns +A string representation for the day period. + +## -remarks + +## -examples + +## -see-also +[PeriodAsString](calendar_periodasstring_980483546.md) \ No newline at end of file diff --git a/windows.globalization/calendar_periodasstring_980483546.md b/windows.globalization/calendar_periodasstring_980483546.md index 111c7f5f1b..8262e7d72b 100644 --- a/windows.globalization/calendar_periodasstring_980483546.md +++ b/windows.globalization/calendar_periodasstring_980483546.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.PeriodAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.PeriodAsString ## -description Returns a string representation of the day period, such as AM or PM, that uses the most common abbreviation available. ## -returns A string representation of the day period. ## -remarks ## -examples ## -see-also [PeriodAsString(Int32)](calendar_periodasstring_1590229662.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.PeriodAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.PeriodAsString + +## -description +Returns a string representation of the day period, such as AM or PM, that uses the most common abbreviation available. + +## -returns +A string representation of the day period. + +## -remarks + +## -examples + +## -see-also +[PeriodAsString(Int32)](calendar_periodasstring_1590229662.md) \ No newline at end of file diff --git a/windows.globalization/calendar_resolvedlanguage.md b/windows.globalization/calendar_resolvedlanguage.md index 17d0dbbf25..f9487ee938 100644 --- a/windows.globalization/calendar_resolvedlanguage.md +++ b/windows.globalization/calendar_resolvedlanguage.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.Calendar.ResolvedLanguage --api-type: winrt property ---- # Windows.Globalization.Calendar.ResolvedLanguage ## -description Gets the language that was most recently used to perform calendar formatting or operations. ## -property-value The language from the [priority list of language identifiers](calendar_languages.md) that was most recently used to perform calendar formatting or operations. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Calendar(IIterable(String))](calendar_calendar_1181929246.md) constructor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.ResolvedLanguage +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.ResolvedLanguage + +## -description +Gets the language that was most recently used to perform calendar formatting or operations. + +## -property-value +The language from the [priority list of language identifiers](calendar_languages.md) that was most recently used to perform calendar formatting or operations. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Calendar(IIterable(String))](calendar_calendar_1181929246.md) constructor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_second.md b/windows.globalization/calendar_second.md index 5e11697742..eb4f38101c 100644 --- a/windows.globalization/calendar_second.md +++ b/windows.globalization/calendar_second.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Second --api-type: winrt property ---- # Windows.Globalization.Calendar.Second ## -description Gets or sets the second. ## -property-value The second. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Second +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Second + +## -description +Gets or sets the second. + +## -property-value +The second. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_secondaspaddedstring_1103733298.md b/windows.globalization/calendar_secondaspaddedstring_1103733298.md index 9fca221737..39aad7f360 100644 --- a/windows.globalization/calendar_secondaspaddedstring_1103733298.md +++ b/windows.globalization/calendar_secondaspaddedstring_1103733298.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.SecondAsPaddedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.SecondAsPaddedString ## -description Returns a string representation of the second, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the second does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the second 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. ## -returns A string representation of the second. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.SecondAsPaddedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.SecondAsPaddedString + +## -description +Returns a string representation of the second, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the second does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the second 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. + +## -returns +A string representation of the second. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_secondasstring_1349744937.md b/windows.globalization/calendar_secondasstring_1349744937.md index 504fd5a716..0b7a182fee 100644 --- a/windows.globalization/calendar_secondasstring_1349744937.md +++ b/windows.globalization/calendar_secondasstring_1349744937.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.SecondAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.SecondAsString ## -description Returns a string that contains the numeric representation of the second. ## -returns A string representation of the second. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.SecondAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.SecondAsString + +## -description +Returns a string that contains the numeric representation of the second. + +## -returns +A string representation of the second. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_setdatetime_1779301149.md b/windows.globalization/calendar_setdatetime_1779301149.md index 8129a3e055..50e2b45eb0 100644 --- a/windows.globalization/calendar_setdatetime_1779301149.md +++ b/windows.globalization/calendar_setdatetime_1779301149.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.SetDateTime(Windows.Foundation.DateTime) --api-type: winrt method ---- # Windows.Globalization.Calendar.SetDateTime ## -description Sets all the date and time fields to the date and time represented by the [DateTime](../windows.foundation/datetime.md) parameter. ## -parameters ### -param value The [DateTime](../windows.foundation/datetime.md) that is used to set all of the date and time fields. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.SetDateTime(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.SetDateTime + +## -description +Sets all the date and time fields to the date and time represented by the [DateTime](../windows.foundation/datetime.md) parameter. + +## -parameters +### -param value +The [DateTime](../windows.foundation/datetime.md) that is used to set all of the date and time fields. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_settomax_44967827.md b/windows.globalization/calendar_settomax_44967827.md index bdd8423712..92b4378ede 100644 --- a/windows.globalization/calendar_settomax_44967827.md +++ b/windows.globalization/calendar_settomax_44967827.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Globalization.Calendar.SetToMax --api-type: winrt method ---- # Windows.Globalization.Calendar.SetToMax ## -description Sets the components of this [Calendar](calendar.md) object to the latest date and time that are supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.SetToMax +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.SetToMax + +## -description +Sets the components of this [Calendar](calendar.md) object to the latest date and time that are supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_settomin_1929870661.md b/windows.globalization/calendar_settomin_1929870661.md index 32394d4ab0..1d0fe63e27 100644 --- a/windows.globalization/calendar_settomin_1929870661.md +++ b/windows.globalization/calendar_settomin_1929870661.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Globalization.Calendar.SetToMin --api-type: winrt method ---- # Windows.Globalization.Calendar.SetToMin ## -description Sets the components of this [Calendar](calendar.md) object to the earliest date and time that are supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.SetToMin +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.SetToMin + +## -description +Sets the components of this [Calendar](calendar.md) object to the earliest date and time that are supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_settonow_1073398179.md b/windows.globalization/calendar_settonow_1073398179.md index eb9ea681f7..cce1bf4798 100644 --- a/windows.globalization/calendar_settonow_1073398179.md +++ b/windows.globalization/calendar_settonow_1073398179.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Globalization.Calendar.SetToNow --api-type: winrt method ---- # Windows.Globalization.Calendar.SetToNow ## -description Sets the components of this [Calendar](calendar.md) object to the current date and time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.SetToNow +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.SetToNow + +## -description +Sets the components of this [Calendar](calendar.md) object to the current date and time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_timezoneasstring_1880050689.md b/windows.globalization/calendar_timezoneasstring_1880050689.md index 00072a4eff..29670f8e39 100644 --- a/windows.globalization/calendar_timezoneasstring_1880050689.md +++ b/windows.globalization/calendar_timezoneasstring_1880050689.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.Calendar.TimeZoneAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.TimeZoneAsString ## -description Returns the full time zone name applicable at the instant of time that this [Calendar](calendar.md) object represents. ## -returns The full time zone name. This usually differs depending on whether the time zone is observing Daylight Saving Time or not. It also may differ due to historical changes. (An example is "America/Los_Angeles" for Pacific Time.) ## -remarks ## -examples ## -see-also [TimeZoneAsString(Int32)](calendar_timezoneasstring_347556679.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.TimeZoneAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.TimeZoneAsString + +## -description +Returns the full time zone name applicable at the instant of time that this [Calendar](calendar.md) object represents. + +## -returns +The full time zone name. This usually differs depending on whether the time zone is observing Daylight Saving Time or not. It also may differ due to historical changes. (An example is "America/Los_Angeles" for Pacific Time.) + +## -remarks + +## -examples + +## -see-also +[TimeZoneAsString(Int32)](calendar_timezoneasstring_347556679.md) \ No newline at end of file diff --git a/windows.globalization/calendar_timezoneasstring_347556679.md b/windows.globalization/calendar_timezoneasstring_347556679.md index 3011445b98..388ddc0570 100644 --- a/windows.globalization/calendar_timezoneasstring_347556679.md +++ b/windows.globalization/calendar_timezoneasstring_347556679.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.Calendar.TimeZoneAsString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.TimeZoneAsString ## -description Returns the abbreviated time zone name applicable at the instant of time that this [Calendar](calendar.md) object represents. ## -parameters ### -param idealLength The desired length of the abbreviation to be returned. Use 0 to request the abbreviation in most common use. ## -returns The time zone abbreviation that is closest in length to *idealLength*. If there is a tie, the shorter abbreviation is returned. If *idealLength* is 0, the abbreviation in most common use is returned. (An example is "America/Los_Angeles" for Pacific Time.) ## -remarks ## -examples ## -see-also [TimeZoneAsString](calendar_timezoneasstring_1880050689.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.TimeZoneAsString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.TimeZoneAsString + +## -description +Returns the abbreviated time zone name applicable at the instant of time that this [Calendar](calendar.md) object represents. + +## -parameters +### -param idealLength +The desired length of the abbreviation to be returned. Use 0 to request the abbreviation in most common use. + +## -returns +The time zone abbreviation that is closest in length to *idealLength*. If there is a tie, the shorter abbreviation is returned. If *idealLength* is 0, the abbreviation in most common use is returned. (An example is "America/Los_Angeles" for Pacific Time.) + +## -remarks + +## -examples + +## -see-also +[TimeZoneAsString](calendar_timezoneasstring_1880050689.md) \ No newline at end of file diff --git a/windows.globalization/calendar_year.md b/windows.globalization/calendar_year.md index a0eecdb724..c12841f65f 100644 --- a/windows.globalization/calendar_year.md +++ b/windows.globalization/calendar_year.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Calendar.Year --api-type: winrt property ---- # Windows.Globalization.Calendar.Year ## -description Gets or sets the year. ## -property-value The year. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Calendar.Year +-api-type: winrt property +--- + + + +# Windows.Globalization.Calendar.Year + +## -description +Gets or sets the year. + +## -property-value +The year. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_yearaspaddedstring_124899132.md b/windows.globalization/calendar_yearaspaddedstring_124899132.md index 3b92dcd5c2..8188304296 100644 --- a/windows.globalization/calendar_yearaspaddedstring_124899132.md +++ b/windows.globalization/calendar_yearaspaddedstring_124899132.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.YearAsPaddedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.YearAsPaddedString ## -description Returns a string representation of the year, optionally zero-padded. ## -parameters ### -param minDigits The minimum number of integer digits to be displayed. If the year does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the year 42, a parameter of 1 or 2 returns 42, and a parameter of 3 returns 042. ## -returns A string representation of the year. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.YearAsPaddedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.YearAsPaddedString + +## -description +Returns a string representation of the year, optionally zero-padded. + +## -parameters +### -param minDigits +The minimum number of integer digits to be displayed. If the year does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the year 42, a parameter of 1 or 2 returns 42, and a parameter of 3 returns 042. + +## -returns +A string representation of the year. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_yearasstring_936618193.md b/windows.globalization/calendar_yearasstring_936618193.md index 9509de06be..23b9d1a677 100644 --- a/windows.globalization/calendar_yearasstring_936618193.md +++ b/windows.globalization/calendar_yearasstring_936618193.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Globalization.Calendar.YearAsString --api-type: winrt method ---- # Windows.Globalization.Calendar.YearAsString ## -description Returns a string representation of the year without any initial zero padding. ## -returns A string representation of the year. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.YearAsString +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.YearAsString + +## -description +Returns a string representation of the year without any initial zero padding. + +## -returns +A string representation of the year. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendar_yearastruncatedstring_869845553.md b/windows.globalization/calendar_yearastruncatedstring_869845553.md index 20f522c399..f07171a318 100644 --- a/windows.globalization/calendar_yearastruncatedstring_869845553.md +++ b/windows.globalization/calendar_yearastruncatedstring_869845553.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.Calendar.YearAsTruncatedString(System.Int32) --api-type: winrt method ---- # Windows.Globalization.Calendar.YearAsTruncatedString ## -description Returns a string representation of the year, optionally truncated. ## -parameters ### -param remainingDigits A positive integer that represents the number of least significant digits that should be included. For example, for the year 1234, a parameter of 2 returns 34, and a parameter of 4 or larger returns 1234. ## -returns A string representation of the year. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Calendar.YearAsTruncatedString(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Globalization.Calendar.YearAsTruncatedString + +## -description +Returns a string representation of the year, optionally truncated. + +## -parameters +### -param remainingDigits +A positive integer that represents the number of least significant digits that should be included. For example, for the year 1234, a parameter of 2 returns 34, and a parameter of 4 or larger returns 1234. + +## -returns +A string representation of the year. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/calendaridentifiers_chineselunar.md b/windows.globalization/calendaridentifiers_chineselunar.md index 1e263e4559..352eba35ee 100644 --- a/windows.globalization/calendaridentifiers_chineselunar.md +++ b/windows.globalization/calendaridentifiers_chineselunar.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.ChineseLunar --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.ChineseLunar ## -description Gets the identifier for the Chinese lunisolar calendar. ## -property-value The string "ChineseLunarCalendar", which is the identifier for the Chinese lunar calendar. ## -remarks This calendar supports the sexagenary year cycle (which repeats every 60 years) in addition to solar years and lunar months. Each solar year in the calendar is associated with a Sexagenary Year, a Celestial Stem, and a Terrestrial Branch, and these calendars can have leap months after any month of the year. The calendar calculates years based on solar calculations, and months and days based on lunar calculations. A leap month can occur after any month in a year. For example, when you get a month from this calendar, you get a number between 1 and 13 that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, getting the month returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month. Currently, this calendar is not used by any of the supported cultures. Therefore, this value can be used only to calculate dates in the Chinese lunisolar calendar. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.ChineseLunar +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.ChineseLunar + +## -description +Gets the identifier for the Chinese lunisolar calendar. + +## -property-value +The string "ChineseLunarCalendar", which is the identifier for the Chinese lunar calendar. + +## -remarks + +This calendar supports the sexagenary year cycle (which repeats every 60 years) in addition to solar years and lunar months. Each solar year in the calendar is associated with a Sexagenary Year, a Celestial Stem, and a Terrestrial Branch, and these calendars can have leap months after any month of the year. The calendar calculates years based on solar calculations, and months and days based on lunar calculations. + +A leap month can occur after any month in a year. For example, when you get a month from this calendar, you get a number between 1 and 13 that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, getting the month returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month. + +Currently, this calendar is not used by any of the supported cultures. Therefore, this value can be used only to calculate dates in the Chinese lunisolar calendar. + +## -examples + +## -see-also diff --git a/windows.globalization/calendaridentifiers_gregorian.md b/windows.globalization/calendaridentifiers_gregorian.md index 74a545daa0..0733255276 100644 --- a/windows.globalization/calendaridentifiers_gregorian.md +++ b/windows.globalization/calendaridentifiers_gregorian.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Gregorian --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Gregorian ## -description Gets the identifier for the Gregorian calendar. ## -property-value The string "GregorianCalendar", which is the identifier for the Gregorian calendar. ## -remarks The returned identifier is suitable for use anywhere a calendar identifier is required. The Gregorian calendar recognizes two eras: B.C. or B.C.E., and A.D. or C.E. This implementation of the Gregorian calendar system recognizes only the current era (A.D.). A leap year in the Gregorian calendar is defined as a year that is evenly divisible by four, except if it is divisible by 100. However, years that are divisible by 400 are leap years. For example, the year 1900 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. The Gregorian calendar has 12 months with 28 to 31 days each: January (31 days), February (28 or 29 days), March (31 days), April (30 days), May (31 days), June (30 days), July (31 days), August (31 days), September (30 days), October (31 days), November (30 days), and December (31 days). February has 29 days during leap years and 28 during common years. Gregorian calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Gregorian +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Gregorian + +## -description +Gets the identifier for the Gregorian calendar. + +## -property-value +The string "GregorianCalendar", which is the identifier for the Gregorian calendar. + +## -remarks +The returned identifier is suitable for use anywhere a calendar identifier is required. + + + +The Gregorian calendar recognizes two eras: B.C. or B.C.E., and A.D. or C.E. This implementation of the Gregorian calendar system recognizes only the current era (A.D.). + +A leap year in the Gregorian calendar is defined as a year that is evenly divisible by four, except if it is divisible by 100. However, years that are divisible by 400 are leap years. For example, the year 1900 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. + +The Gregorian calendar has 12 months with 28 to 31 days each: January (31 days), February (28 or 29 days), March (31 days), April (30 days), May (31 days), June (30 days), July (31 days), August (31 days), September (30 days), October (31 days), November (30 days), and December (31 days). February has 29 days during leap years and 28 during common years. + +Gregorian calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_hebrew.md b/windows.globalization/calendaridentifiers_hebrew.md index 8fa1887800..fd9c0a6a90 100644 --- a/windows.globalization/calendaridentifiers_hebrew.md +++ b/windows.globalization/calendaridentifiers_hebrew.md @@ -1,3 +1,51 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Hebrew --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Hebrew ## -description Gets the identifier for the Hebrew calendar. ## -property-value The string "HebrewCalendar", which is the identifier for the Hebrew calendar. ## -remarks The Hebrew calendar recognizes two eras: B.C.E. (before the common era) and C.E. (current era). This implementation of the Hebrew calendar system recognizes only the current era (C.E.) and the Hebrew years 5343 to 5999 (1583 to 2239 in the [Gregorian](calendaridentifiers_gregorian.md) calendar). In every 19-year cycle that ends with a year that is evenly divisible by 19, the 3rd, 6th, 8th, 11th, 14th, 17th, and 19th years are leap years. A common year can have from 353 to 355 days, depending on the placement of Jewish holidays. A leap year can have from 383 to 385 days. The Hebrew calendar has 12 months during common years and 13 months during leap years:
[MonthAsNumericString](calendar_monthasnumericstring.md) (common year)[MonthAsNumericString](calendar_monthasnumericstring.md) (leap year)MonthDays in common yearsDays in leap years
11תשרי (Tishrei)3030
22חשון (Cheshvan)29/3029/30
33כסלו (Kislev)29/3029/30
44טבת (Tevet)2929
55שבט (Shevat)3030
6-אדר (Adar)29-
-6אדר א (Adar Alef)-30
-7אדר ב (Adar Beit)-29
78ניסן (Nissan)3030
89אייר (Iyar)2929
910סיון (Sivan)3030
1011תמוז (Tamuz)2929
1112אב (Av)3030
1213אלול (Elul)2929
The days in Cheshvan and Kislev vary depending on the placement of Jewish holidays. During leap years, Adar is replaced by Adar Alef with 30 days and Adar Beit with 29 days. Adar Beit is considered the leap month. The last day of Adar Alef and all the days in Adar Beit are considered leap days. The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the sixth day of Tevet in the year 5772 C.E. in the Hebrew calendar. Hebrew calendar strings for day of the week names and month names are not localized and hence will appear in Hebrew regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Hebrew +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Hebrew + +## -description +Gets the identifier for the Hebrew calendar. + +## -property-value +The string "HebrewCalendar", which is the identifier for the Hebrew calendar. + +## -remarks + +The Hebrew calendar recognizes two eras: B.C.E. (before the common era) and C.E. (current era). This implementation of the Hebrew calendar system recognizes only the current era (C.E.) and the Hebrew years 5343 to 5999 (1583 to 2239 in the [Gregorian](calendaridentifiers_gregorian.md) calendar). + +In every 19-year cycle that ends with a year that is evenly divisible by 19, the 3rd, 6th, 8th, 11th, 14th, 17th, and 19th years are leap years. A common year can have from 353 to 355 days, depending on the placement of Jewish holidays. A leap year can have from 383 to 385 days. + +The Hebrew calendar has 12 months during common years and 13 months during leap years: + + + + + + + + + + + + + + + +
[MonthAsNumericString](calendar_monthasnumericstring.md) (common year)[MonthAsNumericString](calendar_monthasnumericstring.md) (leap year)MonthDays in common yearsDays in leap years
11תשרי (Tishrei)3030
22חשון (Cheshvan)29/3029/30
33כסלו (Kislev)29/3029/30
44טבת (Tevet)2929
55שבט (Shevat)3030
6-אדר (Adar)29-
-6אדר א (Adar Alef)-30
-7אדר ב (Adar Beit)-29
78ניסן (Nissan)3030
89אייר (Iyar)2929
910סיון (Sivan)3030
1011תמוז (Tamuz)2929
1112אב (Av)3030
1213אלול (Elul)2929
+ +The days in Cheshvan and Kislev vary depending on the placement of Jewish holidays. During leap years, Adar is replaced by Adar Alef with 30 days and Adar Beit with 29 days. Adar Beit is considered the leap month. The last day of Adar Alef and all the days in Adar Beit are considered leap days. + +The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the sixth day of Tevet in the year 5772 C.E. in the Hebrew calendar. + +Hebrew calendar strings for day of the week names and month names are not localized and hence will appear in Hebrew regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_hijri.md b/windows.globalization/calendaridentifiers_hijri.md index 6b0498b5ef..90395be4cc 100644 --- a/windows.globalization/calendaridentifiers_hijri.md +++ b/windows.globalization/calendaridentifiers_hijri.md @@ -1,3 +1,49 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Hijri --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Hijri ## -description Gets the identifier for the Hijri calendar. ## -property-value The string "HijriCalendar", which is the identifier for the Hijri calendar. ## -remarks The Hijri calendar system recognizes one era: A.H. (Latin "Anno Hegirae", which means "the year of the migration", in reference to the migration of Muhammad from Mecca). In every 30-year cycle that ends with a year that is evenly divisible by 30, the 2nd, 5th, 7th, 10th, 13th, 16th, 18th, 21st, 24th, 26th, and 29th years are leap years. A common year has 354 days and a leap year has 355 days. The Hijri calendar has 12 months with 29 to 30 days each:
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
1محرم (Muharram)3030
2صفر (Safar)2929
3‏ربيع الاول (Rabi I)3030
4‏ربيع الثاني (Rabi II)2929
5جمادى الاولى (Jumada I)3030
6جمادى الثانية (Jumada II)2929
7رجب (Rajab)3030
8شعبان (Shaban)2929
9رمضان (Ramadan)3030
10شوال (Shawwal)2929
11ذو القعدة (Zulkadah)3030
12ذو الحجة (Zulhijjah)2930
Ramadan, the month of fasting in the Muslim world, officially starts and ends according to a decree that is based on the observation of the new moon. Therefore, the number of days in Shaban and the number of days in Ramadan vary. The date January 1, 2012 A.D. in the [Gregorian](calendaridentifiers_gregorian.md) calendar is roughly equivalent to the seventh day of Safar in the year 1433 A.H. in the Hijri calendar. Hijri calendar strings for day of the week names and month names are not localized and hence will appear in Arabic regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Hijri +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Hijri + +## -description +Gets the identifier for the Hijri calendar. + +## -property-value +The string "HijriCalendar", which is the identifier for the Hijri calendar. + +## -remarks + +The Hijri calendar system recognizes one era: A.H. (Latin "Anno Hegirae", which means "the year of the migration", in reference to the migration of Muhammad from Mecca). + +In every 30-year cycle that ends with a year that is evenly divisible by 30, the 2nd, 5th, 7th, 10th, 13th, 16th, 18th, 21st, 24th, 26th, and 29th years are leap years. A common year has 354 days and a leap year has 355 days. + +The Hijri calendar has 12 months with 29 to 30 days each: + + + + + + + + + + + + + +
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
1محرم (Muharram)3030
2صفر (Safar)2929
3‏ربيع الاول (Rabi I)3030
4‏ربيع الثاني (Rabi II)2929
5جمادى الاولى (Jumada I)3030
6جمادى الثانية (Jumada II)2929
7رجب (Rajab)3030
8شعبان (Shaban)2929
9رمضان (Ramadan)3030
10شوال (Shawwal)2929
11ذو القعدة (Zulkadah)3030
12ذو الحجة (Zulhijjah)2930
+ +Ramadan, the month of fasting in the Muslim world, officially starts and ends according to a decree that is based on the observation of the new moon. Therefore, the number of days in Shaban and the number of days in Ramadan vary. + +The date January 1, 2012 A.D. in the [Gregorian](calendaridentifiers_gregorian.md) calendar is roughly equivalent to the seventh day of Safar in the year 1433 A.H. in the Hijri calendar. + +Hijri calendar strings for day of the week names and month names are not localized and hence will appear in Arabic regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_japanese.md b/windows.globalization/calendaridentifiers_japanese.md index 9d86ab26d6..092d8cc13e 100644 --- a/windows.globalization/calendaridentifiers_japanese.md +++ b/windows.globalization/calendaridentifiers_japanese.md @@ -1,3 +1,61 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Japanese --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Japanese ## -description Gets the identifier for the Japanese calendar. ## -property-value The string "JapaneseCalendar", which is the identifier for the Japanese calendar. ## -remarks The Japanese calendar, also known as the Wareki calendar, works exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. The Japanese calendar recognizes one era for every emperor's reign. The current era is the Heisei era, which began in the Gregorian calendar year 1989. The era name is typically displayed before the year. For example, the Gregorian calendar year 2012 is the Japanese calendar year Heisei 24. The [CalendarIdentifiers](calendaridentifiers.md) class assigns numbers to the Japanese eras as follows:
[Era](calendar_era.md) value[EraAsString](calendar_eraasstring.md)Gregorian Dates
4平成 (Heisei)January 8, 1989 to present
3昭和 (Showa)December 25, 1926 to January 7, 1989
2大正 (Taisho)July 30, 1912 to December 24, 1926
1明治 (Meiji)January 1, 1868 to July 29, 1912
The [CalendarIdentifiers](calendaridentifiers.md) class handles dates only from the first day of the first month in the year Meiji 1 (January 1, 1868 of the Gregorian calendar). Although the Japanese calendar was switched from a lunar calendar to a solar calendar in the year Meiji 6 (1873 of the Gregorian calendar), this implementation is based on the solar calendar only. Leap years in the Japanese calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. The Japanese calendar has 12 months with 28 to 31 days each:
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthEnglishDays in common yearsDays in leap years
11月 (Ichigatsu)January3131
22月 (Nigatsu)February2829
33月 (Sangatsu)March3131
44月 (Shigatsu)April3030
55月 (Gogatsu)May3131
66月 (Rokugatsu)June3030
77月 (Shichigatsu)July3131
88月 (Hachigatsu)August3131
99月 (Kugatsu)September3030
1010月 (Juugatsu)October3131
1111月 (Juuichigatsu)November3030
1212月 (Juunigatsu)December3131
Nigatsu, which is equivalent to the Gregorian calendar month of February, has 29 days during leap years and 28 during common years. The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the first day of Ichigatsu in the year Heisei 24 in the Japanese calendar. Japanese calendar strings for era, day of the week names and month names are not localized and hence will appear in Japanese regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Japanese +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Japanese + +## -description +Gets the identifier for the Japanese calendar. + +## -property-value +The string "JapaneseCalendar", which is the identifier for the Japanese calendar. + +## -remarks + +The Japanese calendar, also known as the Wareki calendar, works exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. + +The Japanese calendar recognizes one era for every emperor's reign. The current era is the Heisei era, which began in the Gregorian calendar year 1989. The era name is typically displayed before the year. For example, the Gregorian calendar year 2012 is the Japanese calendar year Heisei 24. + +The [CalendarIdentifiers](calendaridentifiers.md) class assigns numbers to the Japanese eras as follows: + + + + + +
[Era](calendar_era.md) value[EraAsString](calendar_eraasstring.md)Gregorian Dates
4平成 (Heisei)January 8, 1989 to present
3昭和 (Showa)December 25, 1926 to January 7, 1989
2大正 (Taisho)July 30, 1912 to December 24, 1926
1明治 (Meiji)January 1, 1868 to July 29, 1912
+ +The [CalendarIdentifiers](calendaridentifiers.md) class handles dates only from the first day of the first month in the year Meiji 1 (January 1, 1868 of the Gregorian calendar). Although the Japanese calendar was switched from a lunar calendar to a solar calendar in the year Meiji 6 (1873 of the Gregorian calendar), this implementation is based on the solar calendar only. + +Leap years in the Japanese calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. + +The Japanese calendar has 12 months with 28 to 31 days each: + + + + + + + + + + + + + +
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthEnglishDays in common yearsDays in leap years
11月 (Ichigatsu)January3131
22月 (Nigatsu)February2829
33月 (Sangatsu)March3131
44月 (Shigatsu)April3030
55月 (Gogatsu)May3131
66月 (Rokugatsu)June3030
77月 (Shichigatsu)July3131
88月 (Hachigatsu)August3131
99月 (Kugatsu)September3030
1010月 (Juugatsu)October3131
1111月 (Juuichigatsu)November3030
1212月 (Juunigatsu)December3131
+ +Nigatsu, which is equivalent to the Gregorian calendar month of February, has 29 days during leap years and 28 during common years. + +The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the first day of Ichigatsu in the year Heisei 24 in the Japanese calendar. + +Japanese calendar strings for era, day of the week names and month names are not localized and hence will appear in Japanese regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_japaneselunar.md b/windows.globalization/calendaridentifiers_japaneselunar.md index cdc220f49f..73f0da4b9d 100644 --- a/windows.globalization/calendaridentifiers_japaneselunar.md +++ b/windows.globalization/calendaridentifiers_japaneselunar.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.JapaneseLunar --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.JapaneseLunar ## -description This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -property-value The string "JapaneseLunarCalendar", which is the identifier for the Japanese lunar calendar. ## -remarks This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.JapaneseLunar +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.JapaneseLunar + +## -description +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + + + + +## -property-value +The string "JapaneseLunarCalendar", which is the identifier for the Japanese lunar calendar. + +## -remarks + +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + +## -examples + +## -see-also diff --git a/windows.globalization/calendaridentifiers_julian.md b/windows.globalization/calendaridentifiers_julian.md index 19aba13f5f..31ebd700fb 100644 --- a/windows.globalization/calendaridentifiers_julian.md +++ b/windows.globalization/calendaridentifiers_julian.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Julian --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Julian ## -description Gets the identifier for the Julian calendar. ## -property-value The string "JulianCalendar", which is the identifier for the Julian calendar. ## -remarks In 45 B.C., Julius Caesar ordered a calendar reform, which resulted in the calendar called the Julian calendar. The Julian calendar is the predecessor of the [Gregorian](calendaridentifiers_gregorian.md) calendar. The Julian calendar system recognizes only the current era. Unlike the Gregorian calendar, the Julian calendar defines a leap year as a year that is evenly divisible by four with no exceptions. Therefore, the calendar is inaccurate by one day every 128 years. A common year has 365 days and a leap year has 366 days. Like the Gregorian calendar, the Julian calendar has 12 months with 28 to 31 days each: January (31 days), February (28 or 29 days), March (31 days), April (30 days), May (31 days), June (30 days), July (31 days), August (31 days), September (30 days), October (31 days), November (30 days), and December (31 days). February has 29 days during leap years and 28 during common years. The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the 19th day of December in the year 2011 in the Julian calendar. Julian calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Julian +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Julian + +## -description +Gets the identifier for the Julian calendar. + +## -property-value +The string "JulianCalendar", which is the identifier for the Julian calendar. + +## -remarks + +In 45 B.C., Julius Caesar ordered a calendar reform, which resulted in the calendar called the Julian calendar. The Julian calendar is the predecessor of the [Gregorian](calendaridentifiers_gregorian.md) calendar. + +The Julian calendar system recognizes only the current era. + +Unlike the Gregorian calendar, the Julian calendar defines a leap year as a year that is evenly divisible by four with no exceptions. Therefore, the calendar is inaccurate by one day every 128 years. A common year has 365 days and a leap year has 366 days. + +Like the Gregorian calendar, the Julian calendar has 12 months with 28 to 31 days each: January (31 days), February (28 or 29 days), March (31 days), April (30 days), May (31 days), June (30 days), July (31 days), August (31 days), September (30 days), October (31 days), November (30 days), and December (31 days). February has 29 days during leap years and 28 during common years. + +The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the 19th day of December in the year 2011 in the Julian calendar. + +Julian calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_korean.md b/windows.globalization/calendaridentifiers_korean.md index 6b823d8193..0af922188e 100644 --- a/windows.globalization/calendaridentifiers_korean.md +++ b/windows.globalization/calendaridentifiers_korean.md @@ -1,3 +1,51 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Korean --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Korean ## -description Gets the identifier for the Korean calendar. ## -property-value The string "KoreanCalendar", which is the identifier for the Korean calendar. ## -remarks The Korean calendar is exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. The Korean calendar system recognizes only the current era. Leap years in the Korean calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. The Korean calendar has 12 months with 28 to 31 days each:
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
11월 (January)3131
22월 (February)2829
33월 (March)3131
44월 (April)3030
55월 (May)3131
66월 (June)3030
77월 (July)3131
88월 (August)3131
99월 (September)3030
1010월 (October)3131
1111월 (November)3030
1212월 (December)3131
February has 29 days during leap years and 28 days during common years. The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the first day of January in the year 4345 of the current era in the Korean calendar. Because the Korean calendar corresponds to the Gregorian calendar, Korean calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Korean +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Korean + +## -description +Gets the identifier for the Korean calendar. + +## -property-value +The string "KoreanCalendar", which is the identifier for the Korean calendar. + +## -remarks + +The Korean calendar is exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. + +The Korean calendar system recognizes only the current era. + +Leap years in the Korean calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. + +The Korean calendar has 12 months with 28 to 31 days each: + + + + + + + + + + + + + +
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
11월 (January)3131
22월 (February)2829
33월 (March)3131
44월 (April)3030
55월 (May)3131
66월 (June)3030
77월 (July)3131
88월 (August)3131
99월 (September)3030
1010월 (October)3131
1111월 (November)3030
1212월 (December)3131
+ +February has 29 days during leap years and 28 days during common years. + +The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the first day of January in the year 4345 of the current era in the Korean calendar. + +Because the Korean calendar corresponds to the Gregorian calendar, Korean calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_koreanlunar.md b/windows.globalization/calendaridentifiers_koreanlunar.md index e4d6f8d276..09f81264ca 100644 --- a/windows.globalization/calendaridentifiers_koreanlunar.md +++ b/windows.globalization/calendaridentifiers_koreanlunar.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.KoreanLunar --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.KoreanLunar ## -description This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -property-value The string "KoreanLunarCalendar", which is the identifier for the Korean lunar calendar. ## -remarks This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.KoreanLunar +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.KoreanLunar + +## -description +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + + + + +## -property-value +The string "KoreanLunarCalendar", which is the identifier for the Korean lunar calendar. + +## -remarks + +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + +## -examples + +## -see-also diff --git a/windows.globalization/calendaridentifiers_persian.md b/windows.globalization/calendaridentifiers_persian.md index ed0573d084..50e59b66b1 100644 --- a/windows.globalization/calendaridentifiers_persian.md +++ b/windows.globalization/calendaridentifiers_persian.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Persian --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Persian ## -description Gets the identifier for the Persian calendar. ## -property-value The string "PersianCalendar", which is the identifier for the Persian calendar. ## -remarks The Persian calendar is used in most countries where Persian is spoken, although some regions use different month names. The Persian calendar is the official calendar of Iran and Afghanistan, and it is one of the alternative calendars in regions such as Kazakhstan and Tajikistan. Dates in the Persian calendar start from the year of the Hijra, which corresponds to 622 C.E. and is the year when Muhammad (PBUH) migrated from Mecca to Medina. For example, the date March 21, 2002 C.E. corresponds to the first day of the month of Farvardeen in the year 1381 Anno Persico. The Persian calendar is based on a solar year and is approximately 365 days long. A year cycles through four seasons, and a new year begins when the sun appears to cross the equator from the southern hemisphere to the northern hemisphere as viewed from the center of the Earth. The new year marks the first day of the month of Farvardeen, which is the first day of spring in the northern hemisphere. Each of the first six months in the Persian calendar has 31 days, each of the next five months has 30 days, and the last month has 29 days in a common year and 30 days in a leap year. A leap year is a year that, when divided by 33, has a remainder of 1, 5, 9, 13, 17, 22, 26, or 30. For example, the year 1370 is a leap year because dividing it by 33 yields a remainder of 17. There are approximately eight leap years in every 33-year cycle. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Persian +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Persian + +## -description +Gets the identifier for the Persian calendar. + +## -property-value +The string "PersianCalendar", which is the identifier for the Persian calendar. + +## -remarks + +The Persian calendar is used in most countries where Persian is spoken, although some regions use different month names. The Persian calendar is the official calendar of Iran and Afghanistan, and it is one of the alternative calendars in regions such as Kazakhstan and Tajikistan. + +Dates in the Persian calendar start from the year of the Hijra, which corresponds to 622 C.E. and is the year when Muhammad (PBUH) migrated from Mecca to Medina. For example, the date March 21, 2002 C.E. corresponds to the first day of the month of Farvardeen in the year 1381 Anno Persico. + +The Persian calendar is based on a solar year and is approximately 365 days long. A year cycles through four seasons, and a new year begins when the sun appears to cross the equator from the southern hemisphere to the northern hemisphere as viewed from the center of the Earth. The new year marks the first day of the month of Farvardeen, which is the first day of spring in the northern hemisphere. + +Each of the first six months in the Persian calendar has 31 days, each of the next five months has 30 days, and the last month has 29 days in a common year and 30 days in a leap year. A leap year is a year that, when divided by 33, has a remainder of 1, 5, 9, 13, 17, 22, 26, or 30. For example, the year 1370 is a leap year because dividing it by 33 yields a remainder of 17. There are approximately eight leap years in every 33-year cycle. + +## -examples + +## -see-also diff --git a/windows.globalization/calendaridentifiers_taiwan.md b/windows.globalization/calendaridentifiers_taiwan.md index 960841c439..7d88ce2c8a 100644 --- a/windows.globalization/calendaridentifiers_taiwan.md +++ b/windows.globalization/calendaridentifiers_taiwan.md @@ -1,3 +1,49 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Taiwan --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Taiwan ## -description Gets the identifier for the Taiwan calendar. ## -property-value The string "TaiwanCalendar", which is the identifier for the Taiwan calendar. ## -remarks The Taiwan calendar works exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. The Taiwan calendar system recognizes only the current era. Leap years in the Taiwan calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. The Taiwan calendar has 12 months with 28 to 31 days each:
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
11月 (January)3131
22月 (February)2829
33月 (March)3131
44月 (April)3030
55月 (May)3131
66月 (June)3030
77月 (July)3131
88月 (August)3131
99月 (September)3030
1010月 (October)3131
1111月 (November)3030
1212月 (December)3131
February has 29 days during leap years and 28 during common years. The date January 1, 2012 C.E. in the Gregorian calendar is equivalent to the first day of January in the year 101 of the current era in the Taiwan calendar. Because the Taiwan calendar corresponds to the Gregorian calendar, Taiwan calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Taiwan +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Taiwan + +## -description +Gets the identifier for the Taiwan calendar. + +## -property-value +The string "TaiwanCalendar", which is the identifier for the Taiwan calendar. + +## -remarks + +The Taiwan calendar works exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. The Taiwan calendar system recognizes only the current era. + +Leap years in the Taiwan calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. + +The Taiwan calendar has 12 months with 28 to 31 days each: + + + + + + + + + + + + + +
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
11月 (January)3131
22月 (February)2829
33月 (March)3131
44月 (April)3030
55月 (May)3131
66月 (June)3030
77月 (July)3131
88月 (August)3131
99月 (September)3030
1010月 (October)3131
1111月 (November)3030
1212月 (December)3131
+ +February has 29 days during leap years and 28 during common years. + +The date January 1, 2012 C.E. in the Gregorian calendar is equivalent to the first day of January in the year 101 of the current era in the Taiwan calendar. + +Because the Taiwan calendar corresponds to the Gregorian calendar, Taiwan calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_taiwanlunar.md b/windows.globalization/calendaridentifiers_taiwanlunar.md index 91217212e8..8c332b079b 100644 --- a/windows.globalization/calendaridentifiers_taiwanlunar.md +++ b/windows.globalization/calendaridentifiers_taiwanlunar.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.TaiwanLunar --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.TaiwanLunar ## -description This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -property-value The string "TaiwanLunarCalendar", which is the identifier for the Taiwan Lunar calendar. ## -remarks This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.TaiwanLunar +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.TaiwanLunar + +## -description +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + + + + +## -property-value +The string "TaiwanLunarCalendar", which is the identifier for the Taiwan Lunar calendar. + +## -remarks + +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + +## -examples + +## -see-also diff --git a/windows.globalization/calendaridentifiers_thai.md b/windows.globalization/calendaridentifiers_thai.md index 6b2e17a206..8efdbf3dfa 100644 --- a/windows.globalization/calendaridentifiers_thai.md +++ b/windows.globalization/calendaridentifiers_thai.md @@ -1,3 +1,49 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.Thai --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.Thai ## -description Gets the identifier for the Thai calendar. ## -property-value The string "ThaiCalendar", which is the identifier for the Thai calendar. ## -remarks The Thai calendar works exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. The Thai calendar system recognizes only the current era. Leap years in the Thai calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. The Thai calendar has 12 months with 28 to 31 days each:
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
1มกราคม (January)3131
2กุมภาพันธ์ (February)2829
3มีนาคม (March)3131
4เมษายน (April)3030
5พฤษภาคม (May)3131
6มิถุนายน (June)3030
7กรกฎาคม (July)3131
8สิงหาคม (August)3131
9กันยายน (September)3030
10ตุลาคม (October)3131
11พฤศจิกายน (November)3030
12ธันวาคม (December)3131
February has 29 days during leap years and 28 during common years. The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the first day of January in the year 2555 of the current era in the Thai calendar. Because the Thai calendar corresponds to the Gregorian calendar, Thai calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.Thai +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.Thai + +## -description +Gets the identifier for the Thai calendar. + +## -property-value +The string "ThaiCalendar", which is the identifier for the Thai calendar. + +## -remarks + +The Thai calendar works exactly like the [Gregorian](calendaridentifiers_gregorian.md) calendar, except that the year and era are different. + +The Thai calendar system recognizes only the current era. + +Leap years in the Thai calendar correspond to the same leap years in the Gregorian calendar. A leap year in the Gregorian calendar is defined as a Gregorian year that is evenly divisible by four, except if it is divisible by 100. However, Gregorian years that are divisible by 400 are leap years. A common year has 365 days and a leap year has 366 days. The Thai calendar has 12 months with 28 to 31 days each: + + + + + + + + + + + + + +
[MonthAsNumericString](calendar_monthasnumericstring.md)MonthDays in common yearsDays in leap years
1มกราคม (January)3131
2กุมภาพันธ์ (February)2829
3มีนาคม (March)3131
4เมษายน (April)3030
5พฤษภาคม (May)3131
6มิถุนายน (June)3030
7กรกฎาคม (July)3131
8สิงหาคม (August)3131
9กันยายน (September)3030
10ตุลาคม (October)3131
11พฤศจิกายน (November)3030
12ธันวาคม (December)3131
+ +February has 29 days during leap years and 28 during common years. + +The date January 1, 2012 A.D. in the Gregorian calendar is equivalent to the first day of January in the year 2555 of the current era in the Thai calendar. + +Because the Thai calendar corresponds to the Gregorian calendar, Thai calendar strings for day of the week names and month names are localized for all supported locales and hence will appear in the language corresponding to the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_umalqura.md b/windows.globalization/calendaridentifiers_umalqura.md index 89ba62c5ef..1a581192a8 100644 --- a/windows.globalization/calendaridentifiers_umalqura.md +++ b/windows.globalization/calendaridentifiers_umalqura.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.UmAlQura --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.UmAlQura ## -description Gets the identifier for the Um Al-Qura calendar. ## -property-value The string "UmAlQuraCalendar", which is the identifier for the Um Al-Qura calendar. ## -remarks The Um Al-Qura calendar or Saudi Hijri system is nearly identical to the [Hijri](calendaridentifiers_hijri.md) calendar system, except in using a table-based algorithm licensed from the Saudi government to calculate dates, and in supporting dates only for the years 1318 to 1500 (corresponding approximately to Gregorian dates April 30, 1900 through November 16, 2077). For the Um Al-Qura calendar, each month has either 29 or 30 days, but usually in no discernible order. Whereas the documentation for the Hijri calendar gives a table that shows the corresponding days in each month, no such general table can be produced for the Um Al-Qura calendar. Like the Hijri calendar, Um Al-Qura calendar strings for day of the week names and month names are not localized and hence will appear in Arabic regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. ## -examples ## -see-also [ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.UmAlQura +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.UmAlQura + +## -description +Gets the identifier for the Um Al-Qura calendar. + + +## -property-value +The string "UmAlQuraCalendar", which is the identifier for the Um Al-Qura calendar. + +## -remarks + +The Um Al-Qura calendar or Saudi Hijri system is nearly identical to the [Hijri](calendaridentifiers_hijri.md) calendar system, except in using a table-based algorithm licensed from the Saudi government to calculate dates, and in supporting dates only for the years 1318 to 1500 (corresponding approximately to Gregorian dates April 30, 1900 through November 16, 2077). + +For the Um Al-Qura calendar, each month has either 29 or 30 days, but usually in no discernible order. Whereas the documentation for the Hijri calendar gives a table that shows the corresponding days in each month, no such general table can be produced for the Um Al-Qura calendar. + +Like the Hijri calendar, Um Al-Qura calendar strings for day of the week names and month names are not localized and hence will appear in Arabic regardless of the current value of the [ResolvedLanguage](calendar_resolvedlanguage.md) property of the calendar object. + +## -examples + +## -see-also +[ResolvedLanguage](calendar_resolvedlanguage.md) \ No newline at end of file diff --git a/windows.globalization/calendaridentifiers_vietnameselunar.md b/windows.globalization/calendaridentifiers_vietnameselunar.md index 7e87b663e3..cae3765d64 100644 --- a/windows.globalization/calendaridentifiers_vietnameselunar.md +++ b/windows.globalization/calendaridentifiers_vietnameselunar.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Globalization.CalendarIdentifiers.VietnameseLunar --api-type: winrt property ---- # Windows.Globalization.CalendarIdentifiers.VietnameseLunar ## -description This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -property-value The string "VietnameseLunarCalendar", which is the identifier for the Vietnamese lunar calendar. ## -remarks This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CalendarIdentifiers.VietnameseLunar +-api-type: winrt property +--- + + + +# Windows.Globalization.CalendarIdentifiers.VietnameseLunar + +## -description +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + + + + +## -property-value +The string "VietnameseLunarCalendar", which is the identifier for the Vietnamese lunar calendar. + +## -remarks + +This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown. + +## -examples + +## -see-also diff --git a/windows.globalization/clockidentifiers_twelvehour.md b/windows.globalization/clockidentifiers_twelvehour.md index c2aec33e83..f1950215d6 100644 --- a/windows.globalization/clockidentifiers_twelvehour.md +++ b/windows.globalization/clockidentifiers_twelvehour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.ClockIdentifiers.TwelveHour --api-type: winrt property ---- # Windows.Globalization.ClockIdentifiers.TwelveHour ## -description Gets the identifier for a 12-hour clock. ## -property-value The string "12HourClock", which is the identifier for a 12-hour clock. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.ClockIdentifiers.TwelveHour +-api-type: winrt property +--- + + + +# Windows.Globalization.ClockIdentifiers.TwelveHour + +## -description +Gets the identifier for a 12-hour clock. + +## -property-value +The string "12HourClock", which is the identifier for a 12-hour clock. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/clockidentifiers_twentyfourhour.md b/windows.globalization/clockidentifiers_twentyfourhour.md index 0bdfcce08b..60f1017d48 100644 --- a/windows.globalization/clockidentifiers_twentyfourhour.md +++ b/windows.globalization/clockidentifiers_twentyfourhour.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.ClockIdentifiers.TwentyFourHour --api-type: winrt property ---- # Windows.Globalization.ClockIdentifiers.TwentyFourHour ## -description Gets the identifier for a 24-hour clock. ## -property-value The string "24HourClock", which is the identifier for a 24-hour clock. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.ClockIdentifiers.TwentyFourHour +-api-type: winrt property +--- + + + +# Windows.Globalization.ClockIdentifiers.TwentyFourHour + +## -description +Gets the identifier for a 24-hour clock. + +## -property-value +The string "24HourClock", which is the identifier for a 24-hour clock. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers.md b/windows.globalization/currencyidentifiers.md index 2594171817..6fe19bac07 100644 --- a/windows.globalization/currencyidentifiers.md +++ b/windows.globalization/currencyidentifiers.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Globalization.CurrencyIdentifiers --api-type: winrt class ---- # Windows.Globalization.CurrencyIdentifiers ## -description Contains the currency identifiers for the supported currencies, as static properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Globalization.CurrencyIdentifiers +-api-type: winrt class +--- + + + +# Windows.Globalization.CurrencyIdentifiers + +## -description +Contains the currency identifiers for the supported currencies, as static properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_aed.md b/windows.globalization/currencyidentifiers_aed.md index ed6f7a23e0..d414855cbc 100644 --- a/windows.globalization/currencyidentifiers_aed.md +++ b/windows.globalization/currencyidentifiers_aed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AED --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AED ## -description Gets the currency identifier for the United Arab Emirates Dirham. ## -property-value The string "AED", which identifies the United Arab Emirates Dirham. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AED +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AED + +## -description +Gets the currency identifier for the United Arab Emirates Dirham. + +## -property-value +The string "AED", which identifies the United Arab Emirates Dirham. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_afn.md b/windows.globalization/currencyidentifiers_afn.md index 6399dddae4..314deddffc 100644 --- a/windows.globalization/currencyidentifiers_afn.md +++ b/windows.globalization/currencyidentifiers_afn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AFN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AFN ## -description Gets the currency identifier for the Afghan Afghani. ## -property-value The string "AFN", which identifies the Afghan Afghani. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AFN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AFN + +## -description +Gets the currency identifier for the Afghan Afghani. + +## -property-value +The string "AFN", which identifies the Afghan Afghani. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_all.md b/windows.globalization/currencyidentifiers_all.md index 9019f49d83..302066a784 100644 --- a/windows.globalization/currencyidentifiers_all.md +++ b/windows.globalization/currencyidentifiers_all.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ALL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ALL ## -description Gets the currency identifier for the Albanian Lek. ## -property-value The string "ALL", which identifies the Albanian Lek. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ALL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ALL + +## -description +Gets the currency identifier for the Albanian Lek. + +## -property-value +The string "ALL", which identifies the Albanian Lek. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_amd.md b/windows.globalization/currencyidentifiers_amd.md index e8e6845c7b..305688a9c2 100644 --- a/windows.globalization/currencyidentifiers_amd.md +++ b/windows.globalization/currencyidentifiers_amd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AMD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AMD ## -description Gets the currency identifier for the Armenian Dram. ## -property-value The string "AMD", which identifies the Armenian Dram. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AMD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AMD + +## -description +Gets the currency identifier for the Armenian Dram. + +## -property-value +The string "AMD", which identifies the Armenian Dram. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ang.md b/windows.globalization/currencyidentifiers_ang.md index 4d451d4d03..9faf207671 100644 --- a/windows.globalization/currencyidentifiers_ang.md +++ b/windows.globalization/currencyidentifiers_ang.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ANG --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ANG ## -description Gets the currency identifier for the Netherlands Antilles Guilder. ## -property-value The string "ANG", which identifies the Netherlands Antilles Guilder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ANG +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ANG + +## -description +Gets the currency identifier for the Netherlands Antilles Guilder. + +## -property-value +The string "ANG", which identifies the Netherlands Antilles Guilder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_aoa.md b/windows.globalization/currencyidentifiers_aoa.md index b168fc3216..4bd7528d03 100644 --- a/windows.globalization/currencyidentifiers_aoa.md +++ b/windows.globalization/currencyidentifiers_aoa.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AOA --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AOA ## -description Gets the currency identifier for the Angolan Kwanza. ## -property-value The string "AOA", which identifies the Angolan Kwanza. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AOA +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AOA + +## -description +Gets the currency identifier for the Angolan Kwanza. + +## -property-value +The string "AOA", which identifies the Angolan Kwanza. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ars.md b/windows.globalization/currencyidentifiers_ars.md index 3fd2e94b0f..9e54df0f05 100644 --- a/windows.globalization/currencyidentifiers_ars.md +++ b/windows.globalization/currencyidentifiers_ars.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ARS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ARS ## -description Gets the currency identifier for the Argentine Peso. ## -property-value The string "ARS", which identifies the Argentine Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ARS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ARS + +## -description +Gets the currency identifier for the Argentine Peso. + +## -property-value +The string "ARS", which identifies the Argentine Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_aud.md b/windows.globalization/currencyidentifiers_aud.md index d0d8703ee9..01abb196d7 100644 --- a/windows.globalization/currencyidentifiers_aud.md +++ b/windows.globalization/currencyidentifiers_aud.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AUD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AUD ## -description Gets the currency identifier for the Australian Dollar. ## -property-value The string "AUD", which identifies the Australian Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AUD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AUD + +## -description +Gets the currency identifier for the Australian Dollar. + +## -property-value +The string "AUD", which identifies the Australian Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_awg.md b/windows.globalization/currencyidentifiers_awg.md index d741f0ee6b..20b180d3b4 100644 --- a/windows.globalization/currencyidentifiers_awg.md +++ b/windows.globalization/currencyidentifiers_awg.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AWG --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AWG ## -description Gets the currency identifier for the Aruban Florin. ## -property-value The string "AWG", which identifies the Aruban Florin. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AWG +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AWG + +## -description +Gets the currency identifier for the Aruban Florin. + +## -property-value +The string "AWG", which identifies the Aruban Florin. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_azn.md b/windows.globalization/currencyidentifiers_azn.md index 7236ba2060..2b3daf818b 100644 --- a/windows.globalization/currencyidentifiers_azn.md +++ b/windows.globalization/currencyidentifiers_azn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.AZN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.AZN ## -description Gets the currency identifier for the Azerbaijani Manat. ## -property-value The string "AZN", which identifies the Azerbaijani Manat. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.AZN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.AZN + +## -description +Gets the currency identifier for the Azerbaijani Manat. + +## -property-value +The string "AZN", which identifies the Azerbaijani Manat. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bam.md b/windows.globalization/currencyidentifiers_bam.md index 92daea3095..3b9263a40c 100644 --- a/windows.globalization/currencyidentifiers_bam.md +++ b/windows.globalization/currencyidentifiers_bam.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BAM --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BAM ## -description Gets the currency identifier for the Bosnia and Herzegovina Convertible Mark. ## -property-value The string "BAM", which identifies the Bosnia and Herzegovina Convertible Mark. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BAM +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BAM + +## -description +Gets the currency identifier for the Bosnia and Herzegovina Convertible Mark. + +## -property-value +The string "BAM", which identifies the Bosnia and Herzegovina Convertible Mark. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bbd.md b/windows.globalization/currencyidentifiers_bbd.md index d56d848e0c..96e672cd87 100644 --- a/windows.globalization/currencyidentifiers_bbd.md +++ b/windows.globalization/currencyidentifiers_bbd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BBD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BBD ## -description Gets the currency identifier for the Barbados Dollar. ## -property-value The string "BBD", which identifies the Barbados Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BBD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BBD + +## -description +Gets the currency identifier for the Barbados Dollar. + +## -property-value +The string "BBD", which identifies the Barbados Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bdt.md b/windows.globalization/currencyidentifiers_bdt.md index b0ddd779b3..9fb76786f0 100644 --- a/windows.globalization/currencyidentifiers_bdt.md +++ b/windows.globalization/currencyidentifiers_bdt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BDT --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BDT ## -description Gets the currency identifier for the Bangladeshi Taka. ## -property-value The string "BDT", which identifies the Bangladeshi Taka. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BDT +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BDT + +## -description +Gets the currency identifier for the Bangladeshi Taka. + +## -property-value +The string "BDT", which identifies the Bangladeshi Taka. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bgn.md b/windows.globalization/currencyidentifiers_bgn.md index 97e1401d05..84ed833b05 100644 --- a/windows.globalization/currencyidentifiers_bgn.md +++ b/windows.globalization/currencyidentifiers_bgn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BGN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BGN ## -description Gets the currency identifier for the Bulgarian Lev. ## -property-value The string "BGN", which identifies the Bulgarian Lev. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BGN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BGN + +## -description +Gets the currency identifier for the Bulgarian Lev. + +## -property-value +The string "BGN", which identifies the Bulgarian Lev. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bhd.md b/windows.globalization/currencyidentifiers_bhd.md index edf8a5f75b..038f2cb480 100644 --- a/windows.globalization/currencyidentifiers_bhd.md +++ b/windows.globalization/currencyidentifiers_bhd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BHD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BHD ## -description Gets the currency identifier for the Bahraini Dinar. ## -property-value The string "BHD", which identifies the Bahraini Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BHD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BHD + +## -description +Gets the currency identifier for the Bahraini Dinar. + +## -property-value +The string "BHD", which identifies the Bahraini Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bif.md b/windows.globalization/currencyidentifiers_bif.md index 6b6f7aed72..17ae0d229c 100644 --- a/windows.globalization/currencyidentifiers_bif.md +++ b/windows.globalization/currencyidentifiers_bif.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BIF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BIF ## -description Gets the currency identifier for the Burundian Franc. ## -property-value The string "BIF", which identifies the Burundian Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BIF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BIF + +## -description +Gets the currency identifier for the Burundian Franc. + +## -property-value +The string "BIF", which identifies the Burundian Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bmd.md b/windows.globalization/currencyidentifiers_bmd.md index e3792805bb..c30b9591e8 100644 --- a/windows.globalization/currencyidentifiers_bmd.md +++ b/windows.globalization/currencyidentifiers_bmd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BMD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BMD ## -description Gets the currency identifier for the Bermuda Dollar. ## -property-value The string "BMD", which identifies the Bermuda Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BMD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BMD + +## -description +Gets the currency identifier for the Bermuda Dollar. + +## -property-value +The string "BMD", which identifies the Bermuda Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bnd.md b/windows.globalization/currencyidentifiers_bnd.md index 2fe1573022..96ae521954 100644 --- a/windows.globalization/currencyidentifiers_bnd.md +++ b/windows.globalization/currencyidentifiers_bnd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BND --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BND ## -description Gets the currency identifier for the Brunei Dollar. ## -property-value The string "BND", which identifies the Brunei Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BND +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BND + +## -description +Gets the currency identifier for the Brunei Dollar. + +## -property-value +The string "BND", which identifies the Brunei Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bob.md b/windows.globalization/currencyidentifiers_bob.md index f4547a871e..8c915031b0 100644 --- a/windows.globalization/currencyidentifiers_bob.md +++ b/windows.globalization/currencyidentifiers_bob.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BOB --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BOB ## -description Gets the currency identifier for the Bolivian Boliviano. ## -property-value The string "BOB", which identifies the Bolivian Boliviano. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BOB +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BOB + +## -description +Gets the currency identifier for the Bolivian Boliviano. + +## -property-value +The string "BOB", which identifies the Bolivian Boliviano. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_brl.md b/windows.globalization/currencyidentifiers_brl.md index f5c24cf5b8..08c6e30e01 100644 --- a/windows.globalization/currencyidentifiers_brl.md +++ b/windows.globalization/currencyidentifiers_brl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BRL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BRL ## -description Gets the currency identifier for the Brazilian Real. ## -property-value The string "BRL", which identifies the Brazilian Real. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BRL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BRL + +## -description +Gets the currency identifier for the Brazilian Real. + +## -property-value +The string "BRL", which identifies the Brazilian Real. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bsd.md b/windows.globalization/currencyidentifiers_bsd.md index 02d35a5c3e..babdcb3f6b 100644 --- a/windows.globalization/currencyidentifiers_bsd.md +++ b/windows.globalization/currencyidentifiers_bsd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BSD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BSD ## -description Gets the currency identifier for the Bahamian Dollar. ## -property-value The string "BSD", which identifies the Bahamian Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BSD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BSD + +## -description +Gets the currency identifier for the Bahamian Dollar. + +## -property-value +The string "BSD", which identifies the Bahamian Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_btn.md b/windows.globalization/currencyidentifiers_btn.md index 8ad7606915..71ea34de25 100644 --- a/windows.globalization/currencyidentifiers_btn.md +++ b/windows.globalization/currencyidentifiers_btn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BTN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BTN ## -description Gets the currency identifier for the Bhutanese Ngultrum. ## -property-value The string "BTN", which identifies the Bhutanese Ngultrum. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BTN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BTN + +## -description +Gets the currency identifier for the Bhutanese Ngultrum. + +## -property-value +The string "BTN", which identifies the Bhutanese Ngultrum. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bwp.md b/windows.globalization/currencyidentifiers_bwp.md index a7796b980b..de39593c97 100644 --- a/windows.globalization/currencyidentifiers_bwp.md +++ b/windows.globalization/currencyidentifiers_bwp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BWP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BWP ## -description Gets the currency identifier for the Botswana Pula. ## -property-value The string "BWP", which identifies the Botswana Pula. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BWP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BWP + +## -description +Gets the currency identifier for the Botswana Pula. + +## -property-value +The string "BWP", which identifies the Botswana Pula. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_byr.md b/windows.globalization/currencyidentifiers_byr.md index e03ae13db0..05f3d5f0e0 100644 --- a/windows.globalization/currencyidentifiers_byr.md +++ b/windows.globalization/currencyidentifiers_byr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BYR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BYR ## -description Gets the currency identifier for the Belarusian Ruble. ## -property-value The string "BYR", which identifies the Belarusian Ruble. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BYR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BYR + +## -description +Gets the currency identifier for the Belarusian Ruble. + +## -property-value +The string "BYR", which identifies the Belarusian Ruble. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_bzd.md b/windows.globalization/currencyidentifiers_bzd.md index f7c8ce65d6..3280272cd0 100644 --- a/windows.globalization/currencyidentifiers_bzd.md +++ b/windows.globalization/currencyidentifiers_bzd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.BZD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.BZD ## -description Gets the currency identifier for the Belize Dollar. ## -property-value The string "BZD", which identifies the Belize Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.BZD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.BZD + +## -description +Gets the currency identifier for the Belize Dollar. + +## -property-value +The string "BZD", which identifies the Belize Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_cad.md b/windows.globalization/currencyidentifiers_cad.md index 86456c091f..a885f7c409 100644 --- a/windows.globalization/currencyidentifiers_cad.md +++ b/windows.globalization/currencyidentifiers_cad.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CAD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CAD ## -description Gets the currency identifier for the Canadian Dollar. ## -property-value The string "CAD", which identifies the Canadian Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CAD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CAD + +## -description +Gets the currency identifier for the Canadian Dollar. + +## -property-value +The string "CAD", which identifies the Canadian Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_cdf.md b/windows.globalization/currencyidentifiers_cdf.md index 364c4ccabd..2551cca369 100644 --- a/windows.globalization/currencyidentifiers_cdf.md +++ b/windows.globalization/currencyidentifiers_cdf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CDF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CDF ## -description Gets the currency identifier for the Congolese Franc. ## -property-value The string "CDF", which identifies the Congolese Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CDF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CDF + +## -description +Gets the currency identifier for the Congolese Franc. + +## -property-value +The string "CDF", which identifies the Congolese Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_chf.md b/windows.globalization/currencyidentifiers_chf.md index e8064cc2ef..b8554c90af 100644 --- a/windows.globalization/currencyidentifiers_chf.md +++ b/windows.globalization/currencyidentifiers_chf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CHF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CHF ## -description Gets the currency identifier for the Swiss Franc. ## -property-value The string "CHF", which identifies the Swiss Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CHF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CHF + +## -description +Gets the currency identifier for the Swiss Franc. + +## -property-value +The string "CHF", which identifies the Swiss Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_clp.md b/windows.globalization/currencyidentifiers_clp.md index f09848f8f3..ea67412c89 100644 --- a/windows.globalization/currencyidentifiers_clp.md +++ b/windows.globalization/currencyidentifiers_clp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CLP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CLP ## -description Gets the currency identifier for the Chilean Peso. ## -property-value The string "CLP", which identifies the Chilean Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CLP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CLP + +## -description +Gets the currency identifier for the Chilean Peso. + +## -property-value +The string "CLP", which identifies the Chilean Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_cny.md b/windows.globalization/currencyidentifiers_cny.md index bb1e72cad9..c4478c77ad 100644 --- a/windows.globalization/currencyidentifiers_cny.md +++ b/windows.globalization/currencyidentifiers_cny.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CNY --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CNY ## -description Gets the currency identifier for the Chinese Yuan. ## -property-value The string "CNY", which identifies the Chinese Yuan. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CNY +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CNY + +## -description +Gets the currency identifier for the Chinese Yuan. + +## -property-value +The string "CNY", which identifies the Chinese Yuan. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_cop.md b/windows.globalization/currencyidentifiers_cop.md index efcb411fd1..de0ee79540 100644 --- a/windows.globalization/currencyidentifiers_cop.md +++ b/windows.globalization/currencyidentifiers_cop.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.COP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.COP ## -description Gets the currency identifier for the Colombian Peso. ## -property-value The string "COP", which identifies the Colombian Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.COP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.COP + +## -description +Gets the currency identifier for the Colombian Peso. + +## -property-value +The string "COP", which identifies the Colombian Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_crc.md b/windows.globalization/currencyidentifiers_crc.md index ef7dfb0ad9..cddb6cc6c9 100644 --- a/windows.globalization/currencyidentifiers_crc.md +++ b/windows.globalization/currencyidentifiers_crc.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CRC --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CRC ## -description Gets the currency identifier for the Costa Rican Colon. ## -property-value The string "CRC", which identifies the Costa Rican Colon. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CRC +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CRC + +## -description +Gets the currency identifier for the Costa Rican Colon. + +## -property-value +The string "CRC", which identifies the Costa Rican Colon. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_cup.md b/windows.globalization/currencyidentifiers_cup.md index ceb396ec5f..9a97291953 100644 --- a/windows.globalization/currencyidentifiers_cup.md +++ b/windows.globalization/currencyidentifiers_cup.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CUP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CUP ## -description Gets the currency identifier for the Cuban Peso. ## -property-value The string "yyy", which identifies the Cuban Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CUP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CUP + +## -description +Gets the currency identifier for the Cuban Peso. + +## -property-value +The string "yyy", which identifies the Cuban Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_cve.md b/windows.globalization/currencyidentifiers_cve.md index 779b6f22c7..669c60bef2 100644 --- a/windows.globalization/currencyidentifiers_cve.md +++ b/windows.globalization/currencyidentifiers_cve.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CVE --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CVE ## -description Gets the currency identifier for the Cabo Verde Escudo. ## -property-value The string "CVE", which identifies the Cabo Verde Escudo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CVE +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CVE + +## -description +Gets the currency identifier for the Cabo Verde Escudo. + +## -property-value +The string "CVE", which identifies the Cabo Verde Escudo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_czk.md b/windows.globalization/currencyidentifiers_czk.md index 9e92eb4dcc..795884083d 100644 --- a/windows.globalization/currencyidentifiers_czk.md +++ b/windows.globalization/currencyidentifiers_czk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.CZK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.CZK ## -description Gets the currency identifier for the Czech Koruna. ## -property-value The string "CZK", which identifies the Czech Koruna. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.CZK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.CZK + +## -description +Gets the currency identifier for the Czech Koruna. + +## -property-value +The string "CZK", which identifies the Czech Koruna. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_djf.md b/windows.globalization/currencyidentifiers_djf.md index 73309ed990..a07ca4a597 100644 --- a/windows.globalization/currencyidentifiers_djf.md +++ b/windows.globalization/currencyidentifiers_djf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.DJF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.DJF ## -description Gets the currency identifier for the Djiboutian Franc. ## -property-value The string "DJF", which identifies the Djiboutian Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.DJF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.DJF + +## -description +Gets the currency identifier for the Djiboutian Franc. + +## -property-value +The string "DJF", which identifies the Djiboutian Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_dkk.md b/windows.globalization/currencyidentifiers_dkk.md index 265e36e145..9b1ccb294d 100644 --- a/windows.globalization/currencyidentifiers_dkk.md +++ b/windows.globalization/currencyidentifiers_dkk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.DKK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.DKK ## -description Gets the currency identifier for the Danish Krone. ## -property-value The string "DKK", which identifies the Danish Krone. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.DKK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.DKK + +## -description +Gets the currency identifier for the Danish Krone. + +## -property-value +The string "DKK", which identifies the Danish Krone. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_dop.md b/windows.globalization/currencyidentifiers_dop.md index 753ab83225..fe898150f4 100644 --- a/windows.globalization/currencyidentifiers_dop.md +++ b/windows.globalization/currencyidentifiers_dop.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.DOP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.DOP ## -description Gets the currency identifier for the Dominican Peso. ## -property-value The string "DOP", which identifies the Dominican Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.DOP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.DOP + +## -description +Gets the currency identifier for the Dominican Peso. + +## -property-value +The string "DOP", which identifies the Dominican Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_dzd.md b/windows.globalization/currencyidentifiers_dzd.md index 9d1c1dde95..323b214aff 100644 --- a/windows.globalization/currencyidentifiers_dzd.md +++ b/windows.globalization/currencyidentifiers_dzd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.DZD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.DZD ## -description Gets the currency identifier for the Algerian Dinar. ## -property-value The string "DZD", which identifies the Algerian Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.DZD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.DZD + +## -description +Gets the currency identifier for the Algerian Dinar. + +## -property-value +The string "DZD", which identifies the Algerian Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_egp.md b/windows.globalization/currencyidentifiers_egp.md index 2891315c10..c66c2b9389 100644 --- a/windows.globalization/currencyidentifiers_egp.md +++ b/windows.globalization/currencyidentifiers_egp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.EGP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.EGP ## -description Gets the currency identifier for the Egyptian Pound. ## -property-value The string "EGP", which identifies the Egyptian Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.EGP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.EGP + +## -description +Gets the currency identifier for the Egyptian Pound. + +## -property-value +The string "EGP", which identifies the Egyptian Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ern.md b/windows.globalization/currencyidentifiers_ern.md index d578874f99..3d7cae72f9 100644 --- a/windows.globalization/currencyidentifiers_ern.md +++ b/windows.globalization/currencyidentifiers_ern.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ERN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ERN ## -description Gets the currency identifier for the Eritrean Nakfa. ## -property-value The string "ERN", which identifies the Eritrean Nakfa. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ERN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ERN + +## -description +Gets the currency identifier for the Eritrean Nakfa. + +## -property-value +The string "ERN", which identifies the Eritrean Nakfa. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_etb.md b/windows.globalization/currencyidentifiers_etb.md index 1443d369ef..0829a09276 100644 --- a/windows.globalization/currencyidentifiers_etb.md +++ b/windows.globalization/currencyidentifiers_etb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ETB --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ETB ## -description Gets the currency identifier for the Ethiopian Birr. ## -property-value The string "ETB", which identifies the Ethiopian Birr. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ETB +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ETB + +## -description +Gets the currency identifier for the Ethiopian Birr. + +## -property-value +The string "ETB", which identifies the Ethiopian Birr. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_eur.md b/windows.globalization/currencyidentifiers_eur.md index e59634f18f..8e7cd302bc 100644 --- a/windows.globalization/currencyidentifiers_eur.md +++ b/windows.globalization/currencyidentifiers_eur.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.EUR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.EUR ## -description Gets the currency identifier for the Euro. ## -property-value The string "EUR", which identifies the Euro. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.EUR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.EUR + +## -description +Gets the currency identifier for the Euro. + +## -property-value +The string "EUR", which identifies the Euro. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_fjd.md b/windows.globalization/currencyidentifiers_fjd.md index da545338aa..b775d771c5 100644 --- a/windows.globalization/currencyidentifiers_fjd.md +++ b/windows.globalization/currencyidentifiers_fjd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.FJD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.FJD ## -description Gets the currency identifier for the Fiji Dollar. ## -property-value The string "FJD", which identifies the Fiji Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.FJD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.FJD + +## -description +Gets the currency identifier for the Fiji Dollar. + +## -property-value +The string "FJD", which identifies the Fiji Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_fkp.md b/windows.globalization/currencyidentifiers_fkp.md index 3529b84ecb..ad4f722efa 100644 --- a/windows.globalization/currencyidentifiers_fkp.md +++ b/windows.globalization/currencyidentifiers_fkp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.FKP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.FKP ## -description Gets the currency identifier for the Falkland Islands Pound. ## -property-value The string "FKP", which identifies the Falkland Islands Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.FKP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.FKP + +## -description +Gets the currency identifier for the Falkland Islands Pound. + +## -property-value +The string "FKP", which identifies the Falkland Islands Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gbp.md b/windows.globalization/currencyidentifiers_gbp.md index 8f4641ea9a..04148b6bde 100644 --- a/windows.globalization/currencyidentifiers_gbp.md +++ b/windows.globalization/currencyidentifiers_gbp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GBP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GBP ## -description Gets the currency identifier for the Pound Sterling. ## -property-value The string "GBP", which identifies the Pound Sterling. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GBP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GBP + +## -description +Gets the currency identifier for the Pound Sterling. + +## -property-value +The string "GBP", which identifies the Pound Sterling. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gel.md b/windows.globalization/currencyidentifiers_gel.md index 9c5fbfe9db..6ad0d8f52b 100644 --- a/windows.globalization/currencyidentifiers_gel.md +++ b/windows.globalization/currencyidentifiers_gel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GEL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GEL ## -description Gets the currency identifier for the Georgian Lari. ## -property-value The string "GEL", which identifies the Georgian Lari. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GEL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GEL + +## -description +Gets the currency identifier for the Georgian Lari. + +## -property-value +The string "GEL", which identifies the Georgian Lari. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ghs.md b/windows.globalization/currencyidentifiers_ghs.md index 0908151fc1..3231e42520 100644 --- a/windows.globalization/currencyidentifiers_ghs.md +++ b/windows.globalization/currencyidentifiers_ghs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GHS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GHS ## -description Gets the currency identifier for the Ghanaian Cedi. ## -property-value The string "GHS", which identifies the Ghanaian Cedi. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GHS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GHS + +## -description +Gets the currency identifier for the Ghanaian Cedi. + +## -property-value +The string "GHS", which identifies the Ghanaian Cedi. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gip.md b/windows.globalization/currencyidentifiers_gip.md index 75abc54ba5..5d16d79169 100644 --- a/windows.globalization/currencyidentifiers_gip.md +++ b/windows.globalization/currencyidentifiers_gip.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GIP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GIP ## -description Gets the currency identifier for the Gibraltar Pound. ## -property-value The string "GIP", which identifies the Gibraltar Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GIP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GIP + +## -description +Gets the currency identifier for the Gibraltar Pound. + +## -property-value +The string "GIP", which identifies the Gibraltar Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gmd.md b/windows.globalization/currencyidentifiers_gmd.md index 8cca7eaac1..1d5430d1f1 100644 --- a/windows.globalization/currencyidentifiers_gmd.md +++ b/windows.globalization/currencyidentifiers_gmd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GMD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GMD ## -description Gets the currency identifier for the Gambian Dalasi. ## -property-value The string "GMD", which identifies the Gambian Dalasi. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GMD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GMD + +## -description +Gets the currency identifier for the Gambian Dalasi. + +## -property-value +The string "GMD", which identifies the Gambian Dalasi. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gnf.md b/windows.globalization/currencyidentifiers_gnf.md index 6a5732a060..d9a921173e 100644 --- a/windows.globalization/currencyidentifiers_gnf.md +++ b/windows.globalization/currencyidentifiers_gnf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GNF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GNF ## -description Gets the currency identifier for the Guinean Franc. ## -property-value The string "GNF", which identifies the Guinean Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GNF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GNF + +## -description +Gets the currency identifier for the Guinean Franc. + +## -property-value +The string "GNF", which identifies the Guinean Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gtq.md b/windows.globalization/currencyidentifiers_gtq.md index 78f52cf681..5a3b8e4f7d 100644 --- a/windows.globalization/currencyidentifiers_gtq.md +++ b/windows.globalization/currencyidentifiers_gtq.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GTQ --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GTQ ## -description Gets the currency identifier for the Guatemalan Quetzal. ## -property-value The string "GTQ", which identifies the Guatemalan Quetzal. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GTQ +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GTQ + +## -description +Gets the currency identifier for the Guatemalan Quetzal. + +## -property-value +The string "GTQ", which identifies the Guatemalan Quetzal. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_gyd.md b/windows.globalization/currencyidentifiers_gyd.md index 6dbcf7a000..99c04ac65c 100644 --- a/windows.globalization/currencyidentifiers_gyd.md +++ b/windows.globalization/currencyidentifiers_gyd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.GYD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.GYD ## -description Gets the currency identifier for the Guyanese Dollar. ## -property-value The string "GYD", which identifies the Guyanese Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.GYD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.GYD + +## -description +Gets the currency identifier for the Guyanese Dollar. + +## -property-value +The string "GYD", which identifies the Guyanese Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_hkd.md b/windows.globalization/currencyidentifiers_hkd.md index f2e8737a97..c81b0484ad 100644 --- a/windows.globalization/currencyidentifiers_hkd.md +++ b/windows.globalization/currencyidentifiers_hkd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.HKD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.HKD ## -description Gets the currency identifier for the Hong Kong Dollar. ## -property-value The string "HKD", which identifies the Hong Kong Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.HKD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.HKD + +## -description +Gets the currency identifier for the Hong Kong Dollar. + +## -property-value +The string "HKD", which identifies the Hong Kong Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_hnl.md b/windows.globalization/currencyidentifiers_hnl.md index 6d4317151c..e8d4df6c27 100644 --- a/windows.globalization/currencyidentifiers_hnl.md +++ b/windows.globalization/currencyidentifiers_hnl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.HNL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.HNL ## -description Gets the currency identifier for the Honduran Lempira. ## -property-value The string "HNL", which identifies the Honduran Lempira. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.HNL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.HNL + +## -description +Gets the currency identifier for the Honduran Lempira. + +## -property-value +The string "HNL", which identifies the Honduran Lempira. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_hrk.md b/windows.globalization/currencyidentifiers_hrk.md index 07d69072ed..b683949879 100644 --- a/windows.globalization/currencyidentifiers_hrk.md +++ b/windows.globalization/currencyidentifiers_hrk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.HRK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.HRK ## -description Gets the currency identifier for the Croatian Kuna. ## -property-value The string "HRK", which identifies the Croatian Kuna. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.HRK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.HRK + +## -description +Gets the currency identifier for the Croatian Kuna. + +## -property-value +The string "HRK", which identifies the Croatian Kuna. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_htg.md b/windows.globalization/currencyidentifiers_htg.md index 8f11f97dd1..6c230569c0 100644 --- a/windows.globalization/currencyidentifiers_htg.md +++ b/windows.globalization/currencyidentifiers_htg.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.HTG --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.HTG ## -description Gets the currency identifier for the Haitian Gourde. ## -property-value The string "HTG", which identifies the Haitian Gourde. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.HTG +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.HTG + +## -description +Gets the currency identifier for the Haitian Gourde. + +## -property-value +The string "HTG", which identifies the Haitian Gourde. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_huf.md b/windows.globalization/currencyidentifiers_huf.md index a259a81c27..f93e7d60a7 100644 --- a/windows.globalization/currencyidentifiers_huf.md +++ b/windows.globalization/currencyidentifiers_huf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.HUF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.HUF ## -description Gets the currency identifier for the Hungarian Forint. ## -property-value The string "HUF", which identifies the Hungarian Forint. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.HUF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.HUF + +## -description +Gets the currency identifier for the Hungarian Forint. + +## -property-value +The string "HUF", which identifies the Hungarian Forint. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_idr.md b/windows.globalization/currencyidentifiers_idr.md index 71a780cc5f..8b15352a3e 100644 --- a/windows.globalization/currencyidentifiers_idr.md +++ b/windows.globalization/currencyidentifiers_idr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.IDR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.IDR ## -description Gets the currency identifier for the Indonesian Rupiah. ## -property-value The string "IDR", which identifies the Indonesian Rupiah. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.IDR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.IDR + +## -description +Gets the currency identifier for the Indonesian Rupiah. + +## -property-value +The string "IDR", which identifies the Indonesian Rupiah. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ils.md b/windows.globalization/currencyidentifiers_ils.md index ecf39f987a..08f75827a4 100644 --- a/windows.globalization/currencyidentifiers_ils.md +++ b/windows.globalization/currencyidentifiers_ils.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ILS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ILS ## -description Gets the currency identifier for the Israeli New Shekel. ## -property-value The string "ILS", which identifies the Israeli New Shekel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ILS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ILS + +## -description +Gets the currency identifier for the Israeli New Shekel. + +## -property-value +The string "ILS", which identifies the Israeli New Shekel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_inr.md b/windows.globalization/currencyidentifiers_inr.md index ab716b1103..f344db6b50 100644 --- a/windows.globalization/currencyidentifiers_inr.md +++ b/windows.globalization/currencyidentifiers_inr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.INR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.INR ## -description Gets the currency identifier for the Indian Rupee. ## -property-value The string "INR", which identifies the Indian Rupee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.INR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.INR + +## -description +Gets the currency identifier for the Indian Rupee. + +## -property-value +The string "INR", which identifies the Indian Rupee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_iqd.md b/windows.globalization/currencyidentifiers_iqd.md index ddb372e9f8..5e1937224e 100644 --- a/windows.globalization/currencyidentifiers_iqd.md +++ b/windows.globalization/currencyidentifiers_iqd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.IQD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.IQD ## -description Gets the currency identifier for the Iraqi Dinar. ## -property-value The string "IQD", which identifies the Iraqi Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.IQD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.IQD + +## -description +Gets the currency identifier for the Iraqi Dinar. + +## -property-value +The string "IQD", which identifies the Iraqi Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_irr.md b/windows.globalization/currencyidentifiers_irr.md index c8f8b0eb74..13f4204dca 100644 --- a/windows.globalization/currencyidentifiers_irr.md +++ b/windows.globalization/currencyidentifiers_irr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.IRR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.IRR ## -description Gets the currency identifier for the Iranian Rial. ## -property-value The string "IRR", which identifies the Iranian Rial. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.IRR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.IRR + +## -description +Gets the currency identifier for the Iranian Rial. + +## -property-value +The string "IRR", which identifies the Iranian Rial. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_isk.md b/windows.globalization/currencyidentifiers_isk.md index d63d2a7b32..6539c11387 100644 --- a/windows.globalization/currencyidentifiers_isk.md +++ b/windows.globalization/currencyidentifiers_isk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ISK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ISK ## -description Gets the currency identifier for the Icelandic Krona. ## -property-value The string "ISK", which identifies the Icelandic Krona. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ISK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ISK + +## -description +Gets the currency identifier for the Icelandic Krona. + +## -property-value +The string "ISK", which identifies the Icelandic Krona. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_jmd.md b/windows.globalization/currencyidentifiers_jmd.md index 7eb20408db..a7369fd3d8 100644 --- a/windows.globalization/currencyidentifiers_jmd.md +++ b/windows.globalization/currencyidentifiers_jmd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.JMD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.JMD ## -description Gets the currency identifier for the Jamaican Dollar. ## -property-value The string "JMD", which identifies the Jamaican Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.JMD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.JMD + +## -description +Gets the currency identifier for the Jamaican Dollar. + +## -property-value +The string "JMD", which identifies the Jamaican Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_jod.md b/windows.globalization/currencyidentifiers_jod.md index 48a6da140b..15b7d4adb8 100644 --- a/windows.globalization/currencyidentifiers_jod.md +++ b/windows.globalization/currencyidentifiers_jod.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.JOD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.JOD ## -description Gets the currency identifier for the Jordanian Dinar. ## -property-value The string "JOD", which identifies the Jordanian Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.JOD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.JOD + +## -description +Gets the currency identifier for the Jordanian Dinar. + +## -property-value +The string "JOD", which identifies the Jordanian Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_jpy.md b/windows.globalization/currencyidentifiers_jpy.md index 27adeedb52..13bcf1bc5f 100644 --- a/windows.globalization/currencyidentifiers_jpy.md +++ b/windows.globalization/currencyidentifiers_jpy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.JPY --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.JPY ## -description Gets the currency identifier for the Japanese Yen. ## -property-value The string "JPY", which identifies the Japanese Yen. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.JPY +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.JPY + +## -description +Gets the currency identifier for the Japanese Yen. + +## -property-value +The string "JPY", which identifies the Japanese Yen. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kes.md b/windows.globalization/currencyidentifiers_kes.md index ca4be6faa0..3f75644529 100644 --- a/windows.globalization/currencyidentifiers_kes.md +++ b/windows.globalization/currencyidentifiers_kes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KES --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KES ## -description Gets the currency identifier for the Kenyan Shilling. ## -property-value The string "KES", which identifies the Kenyan Shilling. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KES +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KES + +## -description +Gets the currency identifier for the Kenyan Shilling. + +## -property-value +The string "KES", which identifies the Kenyan Shilling. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kgs.md b/windows.globalization/currencyidentifiers_kgs.md index 75f2481960..08d17c3dc8 100644 --- a/windows.globalization/currencyidentifiers_kgs.md +++ b/windows.globalization/currencyidentifiers_kgs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KGS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KGS ## -description Gets the currency identifier for the Kyrgyzstani Som. ## -property-value The string "KGS", which identifies the Kyrgyzstani Som. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KGS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KGS + +## -description +Gets the currency identifier for the Kyrgyzstani Som. + +## -property-value +The string "KGS", which identifies the Kyrgyzstani Som. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_khr.md b/windows.globalization/currencyidentifiers_khr.md index c3e9dd49d0..a880c948bc 100644 --- a/windows.globalization/currencyidentifiers_khr.md +++ b/windows.globalization/currencyidentifiers_khr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KHR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KHR ## -description Gets the currency identifier for the Cambodian Riel. ## -property-value The string "KHR", which identifies the Cambodian Riel. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KHR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KHR + +## -description +Gets the currency identifier for the Cambodian Riel. + +## -property-value +The string "KHR", which identifies the Cambodian Riel. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kmf.md b/windows.globalization/currencyidentifiers_kmf.md index 78535ed6ea..fec54f962c 100644 --- a/windows.globalization/currencyidentifiers_kmf.md +++ b/windows.globalization/currencyidentifiers_kmf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KMF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KMF ## -description Gets the currency identifier for the Comorian Franc. ## -property-value The string "KMF", which identifies the Comorian Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KMF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KMF + +## -description +Gets the currency identifier for the Comorian Franc. + +## -property-value +The string "KMF", which identifies the Comorian Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kpw.md b/windows.globalization/currencyidentifiers_kpw.md index 999ccad16e..0ccb768c53 100644 --- a/windows.globalization/currencyidentifiers_kpw.md +++ b/windows.globalization/currencyidentifiers_kpw.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KPW --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KPW ## -description Gets the currency identifier for the North Korean Won. ## -property-value The string "KPW", which identifies the North Korean Won. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KPW +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KPW + +## -description +Gets the currency identifier for the North Korean Won. + +## -property-value +The string "KPW", which identifies the North Korean Won. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_krw.md b/windows.globalization/currencyidentifiers_krw.md index 21ea44b596..187890e879 100644 --- a/windows.globalization/currencyidentifiers_krw.md +++ b/windows.globalization/currencyidentifiers_krw.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KRW --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KRW ## -description Gets the currency identifier for the Korean Won. ## -property-value The string "KRW", which identifies the Korean Won. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KRW +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KRW + +## -description +Gets the currency identifier for the Korean Won. + +## -property-value +The string "KRW", which identifies the Korean Won. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kwd.md b/windows.globalization/currencyidentifiers_kwd.md index a290ee7f50..dfbf23eb30 100644 --- a/windows.globalization/currencyidentifiers_kwd.md +++ b/windows.globalization/currencyidentifiers_kwd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KWD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KWD ## -description Gets the currency identifier for the Kuwaiti Dinar. ## -property-value The string "KWD", which identifies the Kuwaiti Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KWD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KWD + +## -description +Gets the currency identifier for the Kuwaiti Dinar. + +## -property-value +The string "KWD", which identifies the Kuwaiti Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kyd.md b/windows.globalization/currencyidentifiers_kyd.md index b90247eeb3..8da611b016 100644 --- a/windows.globalization/currencyidentifiers_kyd.md +++ b/windows.globalization/currencyidentifiers_kyd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KYD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KYD ## -description Gets the currency identifier for the Cayman Islands Dollar. ## -property-value The string "KYD", which identifies the Cayman Islands Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KYD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KYD + +## -description +Gets the currency identifier for the Cayman Islands Dollar. + +## -property-value +The string "KYD", which identifies the Cayman Islands Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_kzt.md b/windows.globalization/currencyidentifiers_kzt.md index 1fd2bec486..ea90512cc0 100644 --- a/windows.globalization/currencyidentifiers_kzt.md +++ b/windows.globalization/currencyidentifiers_kzt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.KZT --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.KZT ## -description Gets the currency identifier for the Kazakhstani Tenge. ## -property-value The string "KZT", which identifies the Kazakhstani Tenge. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.KZT +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.KZT + +## -description +Gets the currency identifier for the Kazakhstani Tenge. + +## -property-value +The string "KZT", which identifies the Kazakhstani Tenge. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lak.md b/windows.globalization/currencyidentifiers_lak.md index ab7e1d382e..eb68330366 100644 --- a/windows.globalization/currencyidentifiers_lak.md +++ b/windows.globalization/currencyidentifiers_lak.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LAK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LAK ## -description Gets the currency identifier for the Lao Kip. ## -property-value The string "LAK", which identifies the Lao Kip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LAK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LAK + +## -description +Gets the currency identifier for the Lao Kip. + +## -property-value +The string "LAK", which identifies the Lao Kip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lbp.md b/windows.globalization/currencyidentifiers_lbp.md index f80601a290..78eead9dc8 100644 --- a/windows.globalization/currencyidentifiers_lbp.md +++ b/windows.globalization/currencyidentifiers_lbp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LBP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LBP ## -description Gets the currency identifier for the Lebanese Pound. ## -property-value The string "LBP", which identifies the Lebanese Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LBP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LBP + +## -description +Gets the currency identifier for the Lebanese Pound. + +## -property-value +The string "LBP", which identifies the Lebanese Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lkr.md b/windows.globalization/currencyidentifiers_lkr.md index d596680e60..50498b65da 100644 --- a/windows.globalization/currencyidentifiers_lkr.md +++ b/windows.globalization/currencyidentifiers_lkr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LKR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LKR ## -description Gets the currency identifier for the Sri Lankan Rupee. ## -property-value The string "LKR", which identifies the Sri Lankan Rupee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LKR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LKR + +## -description +Gets the currency identifier for the Sri Lankan Rupee. + +## -property-value +The string "LKR", which identifies the Sri Lankan Rupee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lrd.md b/windows.globalization/currencyidentifiers_lrd.md index 893f65b806..018a2bdb47 100644 --- a/windows.globalization/currencyidentifiers_lrd.md +++ b/windows.globalization/currencyidentifiers_lrd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LRD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LRD ## -description Gets the currency identifier for the Liberian Dollar. ## -property-value The string "LRD", which identifies the Liberian Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LRD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LRD + +## -description +Gets the currency identifier for the Liberian Dollar. + +## -property-value +The string "LRD", which identifies the Liberian Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lsl.md b/windows.globalization/currencyidentifiers_lsl.md index b4035a489f..ca88a821f6 100644 --- a/windows.globalization/currencyidentifiers_lsl.md +++ b/windows.globalization/currencyidentifiers_lsl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LSL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LSL ## -description Gets the currency identifier for the Lesotho Loti. ## -property-value The string "LSL", which identifies the Lesotho Loti. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LSL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LSL + +## -description +Gets the currency identifier for the Lesotho Loti. + +## -property-value +The string "LSL", which identifies the Lesotho Loti. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ltl.md b/windows.globalization/currencyidentifiers_ltl.md index 7c33bf89de..d25f2e639d 100644 --- a/windows.globalization/currencyidentifiers_ltl.md +++ b/windows.globalization/currencyidentifiers_ltl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LTL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LTL ## -description Gets the currency identifier for the Lithuanian Litas. ## -property-value The string "LTL", which identifies the Lithuanian Litas. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LTL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LTL + +## -description +Gets the currency identifier for the Lithuanian Litas. + +## -property-value +The string "LTL", which identifies the Lithuanian Litas. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lvl.md b/windows.globalization/currencyidentifiers_lvl.md index 3a23f0fcb3..44e64a9f44 100644 --- a/windows.globalization/currencyidentifiers_lvl.md +++ b/windows.globalization/currencyidentifiers_lvl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LVL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LVL ## -description Gets the currency identifier for the Latvian Lats. ## -property-value The string "LVL", which identifies the Latvian Lats. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LVL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LVL + +## -description +Gets the currency identifier for the Latvian Lats. + +## -property-value +The string "LVL", which identifies the Latvian Lats. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_lyd.md b/windows.globalization/currencyidentifiers_lyd.md index 7639457839..86a89c0810 100644 --- a/windows.globalization/currencyidentifiers_lyd.md +++ b/windows.globalization/currencyidentifiers_lyd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.LYD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.LYD ## -description Gets the currency identifier for the Libyan Dinar. ## -property-value The string "LYD", which identifies the Libyan Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.LYD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.LYD + +## -description +Gets the currency identifier for the Libyan Dinar. + +## -property-value +The string "LYD", which identifies the Libyan Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mad.md b/windows.globalization/currencyidentifiers_mad.md index fc26e73651..4ee163cdbe 100644 --- a/windows.globalization/currencyidentifiers_mad.md +++ b/windows.globalization/currencyidentifiers_mad.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MAD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MAD ## -description Gets the currency identifier for the Moroccan Dirham. ## -property-value The string "MAD", which identifies the Moroccan Dirham. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MAD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MAD + +## -description +Gets the currency identifier for the Moroccan Dirham. + +## -property-value +The string "MAD", which identifies the Moroccan Dirham. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mdl.md b/windows.globalization/currencyidentifiers_mdl.md index 649a5d3ff7..251d57b987 100644 --- a/windows.globalization/currencyidentifiers_mdl.md +++ b/windows.globalization/currencyidentifiers_mdl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MDL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MDL ## -description Gets the currency identifier for the Moldovan Leu. ## -property-value The string "MDL", which identifies the Moldovan Leu. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MDL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MDL + +## -description +Gets the currency identifier for the Moldovan Leu. + +## -property-value +The string "MDL", which identifies the Moldovan Leu. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mga.md b/windows.globalization/currencyidentifiers_mga.md index 55d81729e6..8ebf56dd2a 100644 --- a/windows.globalization/currencyidentifiers_mga.md +++ b/windows.globalization/currencyidentifiers_mga.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MGA --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MGA ## -description Gets the currency identifier for the Malagasy Ariary. ## -property-value The string "MGA", which identifies the Malagasy Ariary. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MGA +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MGA + +## -description +Gets the currency identifier for the Malagasy Ariary. + +## -property-value +The string "MGA", which identifies the Malagasy Ariary. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mkd.md b/windows.globalization/currencyidentifiers_mkd.md index 037acff0d2..29e5235151 100644 --- a/windows.globalization/currencyidentifiers_mkd.md +++ b/windows.globalization/currencyidentifiers_mkd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MKD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MKD ## -description Gets the currency identifier for the Macedonia (FYROM) Denar. ## -property-value The string "MKD", which identifies the Macedonia (FYROM) Denar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MKD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MKD + +## -description +Gets the currency identifier for the Macedonia (FYROM) Denar. + +## -property-value +The string "MKD", which identifies the Macedonia (FYROM) Denar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mmk.md b/windows.globalization/currencyidentifiers_mmk.md index 5e14816f10..3fb15c91ba 100644 --- a/windows.globalization/currencyidentifiers_mmk.md +++ b/windows.globalization/currencyidentifiers_mmk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MMK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MMK ## -description Gets the currency identifier for the Myanmar Kyat. ## -property-value The string "MMK", which identifies the Myanmar Kyat. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MMK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MMK + +## -description +Gets the currency identifier for the Myanmar Kyat. + +## -property-value +The string "MMK", which identifies the Myanmar Kyat. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mnt.md b/windows.globalization/currencyidentifiers_mnt.md index fd7d7e2dd2..214213da57 100644 --- a/windows.globalization/currencyidentifiers_mnt.md +++ b/windows.globalization/currencyidentifiers_mnt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MNT --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MNT ## -description Gets the currency identifier for the Mongolian Tugrik. ## -property-value The string "MNT", which identifies the Mongolian Tugrik. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MNT +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MNT + +## -description +Gets the currency identifier for the Mongolian Tugrik. + +## -property-value +The string "MNT", which identifies the Mongolian Tugrik. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mop.md b/windows.globalization/currencyidentifiers_mop.md index c2df597eac..a1d8dbb3ae 100644 --- a/windows.globalization/currencyidentifiers_mop.md +++ b/windows.globalization/currencyidentifiers_mop.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MOP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MOP ## -description Gets the currency identifier for the Macao SAR Pataca. ## -property-value The string "MOP", which identifies the Macao SAR Pataca. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MOP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MOP + +## -description +Gets the currency identifier for the Macao SAR Pataca. + +## -property-value +The string "MOP", which identifies the Macao SAR Pataca. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mro.md b/windows.globalization/currencyidentifiers_mro.md index e2b43adb40..00ee116873 100644 --- a/windows.globalization/currencyidentifiers_mro.md +++ b/windows.globalization/currencyidentifiers_mro.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MRO --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MRO ## -description Gets the currency identifier for the Mauritania Ouguiya. ## -property-value The string "MRO", which identifies the Mauritania Ouguiya. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MRO +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MRO + +## -description +Gets the currency identifier for the Mauritania Ouguiya. + +## -property-value +The string "MRO", which identifies the Mauritania Ouguiya. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mur.md b/windows.globalization/currencyidentifiers_mur.md index 7042f74f8d..1009317845 100644 --- a/windows.globalization/currencyidentifiers_mur.md +++ b/windows.globalization/currencyidentifiers_mur.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MUR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MUR ## -description Gets the currency identifier for the Mauritian Rupee. ## -property-value The string "MUR", which identifies the Mauritian Rupee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MUR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MUR + +## -description +Gets the currency identifier for the Mauritian Rupee. + +## -property-value +The string "MUR", which identifies the Mauritian Rupee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mvr.md b/windows.globalization/currencyidentifiers_mvr.md index 03b24e818d..eae2649c66 100644 --- a/windows.globalization/currencyidentifiers_mvr.md +++ b/windows.globalization/currencyidentifiers_mvr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MVR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MVR ## -description Gets the currency identifier for the Maldives Rufiyaa. ## -property-value The string "MVR", which identifies the Maldives Rufiyaa. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MVR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MVR + +## -description +Gets the currency identifier for the Maldives Rufiyaa. + +## -property-value +The string "MVR", which identifies the Maldives Rufiyaa. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mwk.md b/windows.globalization/currencyidentifiers_mwk.md index 572152b351..6b4a93fa22 100644 --- a/windows.globalization/currencyidentifiers_mwk.md +++ b/windows.globalization/currencyidentifiers_mwk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MWK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MWK ## -description Gets the currency identifier for the Malawian Kwacha. ## -property-value The string "MWK", which identifies the Malawian Kwacha. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MWK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MWK + +## -description +Gets the currency identifier for the Malawian Kwacha. + +## -property-value +The string "MWK", which identifies the Malawian Kwacha. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mxn.md b/windows.globalization/currencyidentifiers_mxn.md index 1ddd1ec3ad..51ff0f6741 100644 --- a/windows.globalization/currencyidentifiers_mxn.md +++ b/windows.globalization/currencyidentifiers_mxn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MXN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MXN ## -description Gets the currency identifier for the Mexican Peso. ## -property-value The string "MXN", which identifies the Mexican Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MXN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MXN + +## -description +Gets the currency identifier for the Mexican Peso. + +## -property-value +The string "MXN", which identifies the Mexican Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_myr.md b/windows.globalization/currencyidentifiers_myr.md index a8ad07043c..8c3a3caf0e 100644 --- a/windows.globalization/currencyidentifiers_myr.md +++ b/windows.globalization/currencyidentifiers_myr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MYR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MYR ## -description Gets the currency identifier for the Malaysian Ringgit. ## -property-value The string "MYR", which identifies the Malaysian Ringgit. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MYR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MYR + +## -description +Gets the currency identifier for the Malaysian Ringgit. + +## -property-value +The string "MYR", which identifies the Malaysian Ringgit. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_mzn.md b/windows.globalization/currencyidentifiers_mzn.md index 9bb25bce12..2bbbffa7d8 100644 --- a/windows.globalization/currencyidentifiers_mzn.md +++ b/windows.globalization/currencyidentifiers_mzn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.MZN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.MZN ## -description Gets the currency identifier for the New Mozambican Metical. ## -property-value The string "MZN", which identifies the New Mozambican Metical. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.MZN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.MZN + +## -description +Gets the currency identifier for the New Mozambican Metical. + +## -property-value +The string "MZN", which identifies the New Mozambican Metical. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_nad.md b/windows.globalization/currencyidentifiers_nad.md index e69e096485..38edaff715 100644 --- a/windows.globalization/currencyidentifiers_nad.md +++ b/windows.globalization/currencyidentifiers_nad.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.NAD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.NAD ## -description Gets the currency identifier for the Namibian Dollar. ## -property-value The string "NAD", which identifies the Namibian Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.NAD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.NAD + +## -description +Gets the currency identifier for the Namibian Dollar. + +## -property-value +The string "NAD", which identifies the Namibian Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ngn.md b/windows.globalization/currencyidentifiers_ngn.md index 6430048f2d..6a8ac383d2 100644 --- a/windows.globalization/currencyidentifiers_ngn.md +++ b/windows.globalization/currencyidentifiers_ngn.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.NGN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.NGN ## -description Gets the currency identifier for the Nigerian Naira. ## -property-value The string "NGN", which identifies the Nigerian Naira. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.NGN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.NGN + +## -description +Gets the currency identifier for the Nigerian Naira. + +## -property-value +The string "NGN", which identifies the Nigerian Naira. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_nio.md b/windows.globalization/currencyidentifiers_nio.md index d7ea8515b3..e2f39415ba 100644 --- a/windows.globalization/currencyidentifiers_nio.md +++ b/windows.globalization/currencyidentifiers_nio.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.NIO --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.NIO ## -description Gets the currency identifier for the Nicaraguan Cordoba Oro. ## -property-value The string "NIO", which identifies the Nicaraguan Cordoba Oro. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.NIO +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.NIO + +## -description +Gets the currency identifier for the Nicaraguan Cordoba Oro. + +## -property-value +The string "NIO", which identifies the Nicaraguan Cordoba Oro. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_nok.md b/windows.globalization/currencyidentifiers_nok.md index 896e0b7f73..df3853c442 100644 --- a/windows.globalization/currencyidentifiers_nok.md +++ b/windows.globalization/currencyidentifiers_nok.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.NOK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.NOK ## -description Gets the currency identifier for the Norwegian Krone. ## -property-value The string "NOK", which identifies the Norwegian Krone. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.NOK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.NOK + +## -description +Gets the currency identifier for the Norwegian Krone. + +## -property-value +The string "NOK", which identifies the Norwegian Krone. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_npr.md b/windows.globalization/currencyidentifiers_npr.md index 689026c10d..9b442917d0 100644 --- a/windows.globalization/currencyidentifiers_npr.md +++ b/windows.globalization/currencyidentifiers_npr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.NPR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.NPR ## -description Gets the currency identifier for the Nepalese Rupee. ## -property-value The string "NPR", which identifies the Nepalese Rupee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.NPR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.NPR + +## -description +Gets the currency identifier for the Nepalese Rupee. + +## -property-value +The string "NPR", which identifies the Nepalese Rupee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_nzd.md b/windows.globalization/currencyidentifiers_nzd.md index 241399de2f..118603fc25 100644 --- a/windows.globalization/currencyidentifiers_nzd.md +++ b/windows.globalization/currencyidentifiers_nzd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.NZD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.NZD ## -description Gets the currency identifier for the New Zealand Dollar. ## -property-value The string "NZD", which identifies the New Zealand Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.NZD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.NZD + +## -description +Gets the currency identifier for the New Zealand Dollar. + +## -property-value +The string "NZD", which identifies the New Zealand Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_omr.md b/windows.globalization/currencyidentifiers_omr.md index 8ffbbd5caa..6d3055eb0e 100644 --- a/windows.globalization/currencyidentifiers_omr.md +++ b/windows.globalization/currencyidentifiers_omr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.OMR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.OMR ## -description Gets the currency identifier for the Omani Rial. ## -property-value The string "OMR", which identifies the Omani Rial. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.OMR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.OMR + +## -description +Gets the currency identifier for the Omani Rial. + +## -property-value +The string "OMR", which identifies the Omani Rial. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_pab.md b/windows.globalization/currencyidentifiers_pab.md index d354ebedc4..bdbbec30dc 100644 --- a/windows.globalization/currencyidentifiers_pab.md +++ b/windows.globalization/currencyidentifiers_pab.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PAB --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PAB ## -description Gets the currency identifier for the Panamanian Balboa. ## -property-value The string "PAB", which identifies the Panamanian Balboa. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PAB +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PAB + +## -description +Gets the currency identifier for the Panamanian Balboa. + +## -property-value +The string "PAB", which identifies the Panamanian Balboa. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_pen.md b/windows.globalization/currencyidentifiers_pen.md index da439c9c76..75871404da 100644 --- a/windows.globalization/currencyidentifiers_pen.md +++ b/windows.globalization/currencyidentifiers_pen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PEN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PEN ## -description Gets the currency identifier for the Peruvian Nuevo Sol. ## -property-value The string "PEN", which identifies the Peruvian Nuevo Sol. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PEN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PEN + +## -description +Gets the currency identifier for the Peruvian Nuevo Sol. + +## -property-value +The string "PEN", which identifies the Peruvian Nuevo Sol. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_pgk.md b/windows.globalization/currencyidentifiers_pgk.md index 51a858ade4..a98bf9cc1c 100644 --- a/windows.globalization/currencyidentifiers_pgk.md +++ b/windows.globalization/currencyidentifiers_pgk.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PGK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PGK ## -description Gets the currency identifier for the Papua New Guinea Kina. ## -property-value The string "PGK", which identifies the Papua New Guinea Kina. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PGK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PGK + +## -description +Gets the currency identifier for the Papua New Guinea Kina. + +## -property-value +The string "PGK", which identifies the Papua New Guinea Kina. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_php.md b/windows.globalization/currencyidentifiers_php.md index 617e5f6d4b..3b152dd582 100644 --- a/windows.globalization/currencyidentifiers_php.md +++ b/windows.globalization/currencyidentifiers_php.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PHP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PHP ## -description Gets the currency identifier for the Philippine Peso. ## -property-value The string "PHP", which identifies the Philippine Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PHP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PHP + +## -description +Gets the currency identifier for the Philippine Peso. + +## -property-value +The string "PHP", which identifies the Philippine Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_pkr.md b/windows.globalization/currencyidentifiers_pkr.md index 75c7c44170..52bd440a76 100644 --- a/windows.globalization/currencyidentifiers_pkr.md +++ b/windows.globalization/currencyidentifiers_pkr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PKR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PKR ## -description Gets the currency identifier for the Pakistan Rupee. ## -property-value The string "PKR", which identifies the Pakistan Rupee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PKR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PKR + +## -description +Gets the currency identifier for the Pakistan Rupee. + +## -property-value +The string "PKR", which identifies the Pakistan Rupee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_pln.md b/windows.globalization/currencyidentifiers_pln.md index a6772ae249..82b564974d 100644 --- a/windows.globalization/currencyidentifiers_pln.md +++ b/windows.globalization/currencyidentifiers_pln.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PLN --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PLN ## -description Gets the currency identifier for the Polish Zloty. ## -property-value The string "PLN", which identifies the Polish Zloty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PLN +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PLN + +## -description +Gets the currency identifier for the Polish Zloty. + +## -property-value +The string "PLN", which identifies the Polish Zloty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_pyg.md b/windows.globalization/currencyidentifiers_pyg.md index 4bae7c5794..2193970497 100644 --- a/windows.globalization/currencyidentifiers_pyg.md +++ b/windows.globalization/currencyidentifiers_pyg.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.PYG --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.PYG ## -description Gets the currency identifier for the Paraguay Guarani. ## -property-value The string "PYG", which identifies the Paraguay Guarani. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.PYG +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.PYG + +## -description +Gets the currency identifier for the Paraguay Guarani. + +## -property-value +The string "PYG", which identifies the Paraguay Guarani. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_qar.md b/windows.globalization/currencyidentifiers_qar.md index be958e781d..f629f8c189 100644 --- a/windows.globalization/currencyidentifiers_qar.md +++ b/windows.globalization/currencyidentifiers_qar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.QAR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.QAR ## -description Gets the currency identifier for the Qatari Riyal. ## -property-value The string "QAR", which identifies the Qatari Riyal. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.QAR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.QAR + +## -description +Gets the currency identifier for the Qatari Riyal. + +## -property-value +The string "QAR", which identifies the Qatari Riyal. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ron.md b/windows.globalization/currencyidentifiers_ron.md index ff3d72c2c7..250051d3a6 100644 --- a/windows.globalization/currencyidentifiers_ron.md +++ b/windows.globalization/currencyidentifiers_ron.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.RON --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.RON ## -description Gets the currency identifier for the Romanian Leu. ## -property-value The string "RON", which identifies the Romanian Leu. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.RON +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.RON + +## -description +Gets the currency identifier for the Romanian Leu. + +## -property-value +The string "RON", which identifies the Romanian Leu. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_rsd.md b/windows.globalization/currencyidentifiers_rsd.md index 4e625be55c..0ec0a2951e 100644 --- a/windows.globalization/currencyidentifiers_rsd.md +++ b/windows.globalization/currencyidentifiers_rsd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.RSD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.RSD ## -description Gets the currency identifier for the Serbian Dinar. ## -property-value The string "RSD", which identifies the Serbian Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.RSD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.RSD + +## -description +Gets the currency identifier for the Serbian Dinar. + +## -property-value +The string "RSD", which identifies the Serbian Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_rub.md b/windows.globalization/currencyidentifiers_rub.md index bc7318d05d..68b06d0405 100644 --- a/windows.globalization/currencyidentifiers_rub.md +++ b/windows.globalization/currencyidentifiers_rub.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.RUB --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.RUB ## -description Gets the currency identifier for the Russian Ruble. ## -property-value The string "RUB", which identifies the Russian Ruble. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.RUB +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.RUB + +## -description +Gets the currency identifier for the Russian Ruble. + +## -property-value +The string "RUB", which identifies the Russian Ruble. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_rwf.md b/windows.globalization/currencyidentifiers_rwf.md index 7deeedc826..de5ea384d9 100644 --- a/windows.globalization/currencyidentifiers_rwf.md +++ b/windows.globalization/currencyidentifiers_rwf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.RWF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.RWF ## -description Gets the currency identifier for the Rwandan Franc. ## -property-value The string "RWF", which identifies the Rwandan Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.RWF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.RWF + +## -description +Gets the currency identifier for the Rwandan Franc. + +## -property-value +The string "RWF", which identifies the Rwandan Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sar.md b/windows.globalization/currencyidentifiers_sar.md index fa39c16d0a..d71e0bf76e 100644 --- a/windows.globalization/currencyidentifiers_sar.md +++ b/windows.globalization/currencyidentifiers_sar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SAR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SAR ## -description Gets the currency identifier for the Saudi Arabian Riyal. ## -property-value The string "SAR", which identifies the Saudi Arabian Riyal. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SAR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SAR + +## -description +Gets the currency identifier for the Saudi Arabian Riyal. + +## -property-value +The string "SAR", which identifies the Saudi Arabian Riyal. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sbd.md b/windows.globalization/currencyidentifiers_sbd.md index 13c8a402b9..821afaf224 100644 --- a/windows.globalization/currencyidentifiers_sbd.md +++ b/windows.globalization/currencyidentifiers_sbd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SBD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SBD ## -description Gets the currency identifier for the Solomon Islands Dollar. ## -property-value The string "SBD", which identifies the Solomon Islands Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SBD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SBD + +## -description +Gets the currency identifier for the Solomon Islands Dollar. + +## -property-value +The string "SBD", which identifies the Solomon Islands Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_scr.md b/windows.globalization/currencyidentifiers_scr.md index cf86670612..3190d9ffb7 100644 --- a/windows.globalization/currencyidentifiers_scr.md +++ b/windows.globalization/currencyidentifiers_scr.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SCR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SCR ## -description Gets the currency identifier for the Seychelles Rupee. ## -property-value The string "SCR", which identifies the Seychelles Rupee. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SCR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SCR + +## -description +Gets the currency identifier for the Seychelles Rupee. + +## -property-value +The string "SCR", which identifies the Seychelles Rupee. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sdg.md b/windows.globalization/currencyidentifiers_sdg.md index 7ca3ac0474..bf00e915ad 100644 --- a/windows.globalization/currencyidentifiers_sdg.md +++ b/windows.globalization/currencyidentifiers_sdg.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SDG --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SDG ## -description Gets the currency identifier for the Sudanese Pound. ## -property-value The string "SDG", which identifies the Sudanese Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SDG +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SDG + +## -description +Gets the currency identifier for the Sudanese Pound. + +## -property-value +The string "SDG", which identifies the Sudanese Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sek.md b/windows.globalization/currencyidentifiers_sek.md index 85f397e342..fae9ecc024 100644 --- a/windows.globalization/currencyidentifiers_sek.md +++ b/windows.globalization/currencyidentifiers_sek.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SEK --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SEK ## -description Gets the currency identifier for the Swedish Krona. ## -property-value The string "SEK", which identifies the Swedish Krona. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SEK +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SEK + +## -description +Gets the currency identifier for the Swedish Krona. + +## -property-value +The string "SEK", which identifies the Swedish Krona. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sgd.md b/windows.globalization/currencyidentifiers_sgd.md index 4613f81b01..274200567d 100644 --- a/windows.globalization/currencyidentifiers_sgd.md +++ b/windows.globalization/currencyidentifiers_sgd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SGD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SGD ## -description Gets the currency identifier for the Singapore Dollar. ## -property-value The string "SGD", which identifies the Singapore Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SGD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SGD + +## -description +Gets the currency identifier for the Singapore Dollar. + +## -property-value +The string "SGD", which identifies the Singapore Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_shp.md b/windows.globalization/currencyidentifiers_shp.md index 213906693f..9d9c36919c 100644 --- a/windows.globalization/currencyidentifiers_shp.md +++ b/windows.globalization/currencyidentifiers_shp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SHP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SHP ## -description Gets the currency identifier for the Saint Helena Pound. ## -property-value The string "SHP", which identifies the Saint Helena Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SHP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SHP + +## -description +Gets the currency identifier for the Saint Helena Pound. + +## -property-value +The string "SHP", which identifies the Saint Helena Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sll.md b/windows.globalization/currencyidentifiers_sll.md index ba13976f5b..d4c574b1d9 100644 --- a/windows.globalization/currencyidentifiers_sll.md +++ b/windows.globalization/currencyidentifiers_sll.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SLL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SLL ## -description Gets the currency identifier for the Sierra Leone Leone. ## -property-value The string "SLL", which identifies the Sierra Leone Leone. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SLL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SLL + +## -description +Gets the currency identifier for the Sierra Leone Leone. + +## -property-value +The string "SLL", which identifies the Sierra Leone Leone. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_sos.md b/windows.globalization/currencyidentifiers_sos.md index e0e38aaf77..b4f39dff19 100644 --- a/windows.globalization/currencyidentifiers_sos.md +++ b/windows.globalization/currencyidentifiers_sos.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SOS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SOS ## -description Gets the currency identifier for the Somali Shilling. ## -property-value The string "SOS", which identifies the Somali Shilling. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SOS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SOS + +## -description +Gets the currency identifier for the Somali Shilling. + +## -property-value +The string "SOS", which identifies the Somali Shilling. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_srd.md b/windows.globalization/currencyidentifiers_srd.md index a49deca921..526bc7d98b 100644 --- a/windows.globalization/currencyidentifiers_srd.md +++ b/windows.globalization/currencyidentifiers_srd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SRD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SRD ## -description Gets the currency identifier for the Suriname Dollar. ## -property-value The string "SRD", which identifies the Suriname Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SRD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SRD + +## -description +Gets the currency identifier for the Suriname Dollar. + +## -property-value +The string "SRD", which identifies the Suriname Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_std.md b/windows.globalization/currencyidentifiers_std.md index 77de346a15..5b69572738 100644 --- a/windows.globalization/currencyidentifiers_std.md +++ b/windows.globalization/currencyidentifiers_std.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.STD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.STD ## -description Gets the currency identifier for the Sao Tome Dobra. ## -property-value The string "STD", which identifies the Sao Tome Dobra. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.STD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.STD + +## -description +Gets the currency identifier for the Sao Tome Dobra. + +## -property-value +The string "STD", which identifies the Sao Tome Dobra. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_syp.md b/windows.globalization/currencyidentifiers_syp.md index f2e7f2002e..7ae4c8590d 100644 --- a/windows.globalization/currencyidentifiers_syp.md +++ b/windows.globalization/currencyidentifiers_syp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SYP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SYP ## -description Gets the currency identifier for the Syrian Pound. ## -property-value The string "SYP", which identifies the Syrian Pound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SYP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SYP + +## -description +Gets the currency identifier for the Syrian Pound. + +## -property-value +The string "SYP", which identifies the Syrian Pound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_szl.md b/windows.globalization/currencyidentifiers_szl.md index 9317ee9b52..2e6e9b8ef5 100644 --- a/windows.globalization/currencyidentifiers_szl.md +++ b/windows.globalization/currencyidentifiers_szl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.SZL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.SZL ## -description Gets the currency identifier for the Swazi Lilangeni. ## -property-value The string "SZL", which identifies the Swazi Lilangeni. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.SZL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.SZL + +## -description +Gets the currency identifier for the Swazi Lilangeni. + +## -property-value +The string "SZL", which identifies the Swazi Lilangeni. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_thb.md b/windows.globalization/currencyidentifiers_thb.md index 1e7c45cecf..b664c1df60 100644 --- a/windows.globalization/currencyidentifiers_thb.md +++ b/windows.globalization/currencyidentifiers_thb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.THB --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.THB ## -description Gets the currency identifier for the Thai Baht. ## -property-value The string "THB", which identifies the Thai Baht. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.THB +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.THB + +## -description +Gets the currency identifier for the Thai Baht. + +## -property-value +The string "THB", which identifies the Thai Baht. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_tjs.md b/windows.globalization/currencyidentifiers_tjs.md index 49f2c3f90d..ab724416fb 100644 --- a/windows.globalization/currencyidentifiers_tjs.md +++ b/windows.globalization/currencyidentifiers_tjs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TJS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TJS ## -description Gets the currency identifier for the Tajikistani Somoni. ## -property-value The string "TJS", which identifies the Tajikistani Somoni. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TJS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TJS + +## -description +Gets the currency identifier for the Tajikistani Somoni. + +## -property-value +The string "TJS", which identifies the Tajikistani Somoni. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_tmt.md b/windows.globalization/currencyidentifiers_tmt.md index e653cd9850..f37a4f1538 100644 --- a/windows.globalization/currencyidentifiers_tmt.md +++ b/windows.globalization/currencyidentifiers_tmt.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TMT --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TMT ## -description Gets the currency identifier for the Turkmenistan Manat. ## -property-value The string "TMT", which identifies the Turkmenistan Manat. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TMT +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TMT + +## -description +Gets the currency identifier for the Turkmenistan Manat. + +## -property-value +The string "TMT", which identifies the Turkmenistan Manat. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_tnd.md b/windows.globalization/currencyidentifiers_tnd.md index 396b8543d0..5396dc9d49 100644 --- a/windows.globalization/currencyidentifiers_tnd.md +++ b/windows.globalization/currencyidentifiers_tnd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TND --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TND ## -description Gets the currency identifier for the Tunisian Dinar. ## -property-value The string "TND", which identifies the Tunisian Dinar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TND +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TND + +## -description +Gets the currency identifier for the Tunisian Dinar. + +## -property-value +The string "TND", which identifies the Tunisian Dinar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_top.md b/windows.globalization/currencyidentifiers_top.md index 0551b5f79c..ddb1b0ecf1 100644 --- a/windows.globalization/currencyidentifiers_top.md +++ b/windows.globalization/currencyidentifiers_top.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TOP --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TOP ## -description Gets the currency identifier for the Tongan Pa'Anga. ## -property-value The string "TOP", which identifies the Tongan Pa'Anga. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TOP +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TOP + +## -description +Gets the currency identifier for the Tongan Pa'Anga. + +## -property-value +The string "TOP", which identifies the Tongan Pa'Anga. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_try.md b/windows.globalization/currencyidentifiers_try.md index c2a414e888..bbe0c8572c 100644 --- a/windows.globalization/currencyidentifiers_try.md +++ b/windows.globalization/currencyidentifiers_try.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TRY --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TRY ## -description Gets the currency identifier for the Turkish Lira. ## -property-value The string "TRY", which identifies the Turkish Lira. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TRY +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TRY + +## -description +Gets the currency identifier for the Turkish Lira. + +## -property-value +The string "TRY", which identifies the Turkish Lira. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ttd.md b/windows.globalization/currencyidentifiers_ttd.md index 16d041c394..72e0999d52 100644 --- a/windows.globalization/currencyidentifiers_ttd.md +++ b/windows.globalization/currencyidentifiers_ttd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TTD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TTD ## -description Gets the currency identifier for the Trinidad and Tobago Dollar. ## -property-value The string "TTD", which identifies the Trinidad and Tobago Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TTD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TTD + +## -description +Gets the currency identifier for the Trinidad and Tobago Dollar. + +## -property-value +The string "TTD", which identifies the Trinidad and Tobago Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_twd.md b/windows.globalization/currencyidentifiers_twd.md index ae9cd7a4ed..2b3d47f024 100644 --- a/windows.globalization/currencyidentifiers_twd.md +++ b/windows.globalization/currencyidentifiers_twd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TWD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TWD ## -description Gets the currency identifier for the New Taiwan Dollar. ## -property-value The string "TWD", which identifies the New Taiwan Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TWD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TWD + +## -description +Gets the currency identifier for the New Taiwan Dollar. + +## -property-value +The string "TWD", which identifies the New Taiwan Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_tzs.md b/windows.globalization/currencyidentifiers_tzs.md index 3f7843469d..fa8e54e71a 100644 --- a/windows.globalization/currencyidentifiers_tzs.md +++ b/windows.globalization/currencyidentifiers_tzs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.TZS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.TZS ## -description Gets the currency identifier for the Tanzanian Shilling. ## -property-value The string "TZS", which identifies the Tanzanian Shilling. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.TZS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.TZS + +## -description +Gets the currency identifier for the Tanzanian Shilling. + +## -property-value +The string "TZS", which identifies the Tanzanian Shilling. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_uah.md b/windows.globalization/currencyidentifiers_uah.md index ce14300249..36571da3ac 100644 --- a/windows.globalization/currencyidentifiers_uah.md +++ b/windows.globalization/currencyidentifiers_uah.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.UAH --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.UAH ## -description Gets the currency identifier for the Ukrainian Hryvnia. ## -property-value The string "UAH", which identifies the Ukrainian Hryvnia. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.UAH +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.UAH + +## -description +Gets the currency identifier for the Ukrainian Hryvnia. + +## -property-value +The string "UAH", which identifies the Ukrainian Hryvnia. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_ugx.md b/windows.globalization/currencyidentifiers_ugx.md index 6484b71dda..5ad16b7389 100644 --- a/windows.globalization/currencyidentifiers_ugx.md +++ b/windows.globalization/currencyidentifiers_ugx.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.UGX --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.UGX ## -description Gets the currency identifier for the Uganda Shilling. ## -property-value The string "UGX", which identifies the Uganda Shilling. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.UGX +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.UGX + +## -description +Gets the currency identifier for the Uganda Shilling. + +## -property-value +The string "UGX", which identifies the Uganda Shilling. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_usd.md b/windows.globalization/currencyidentifiers_usd.md index 15498545c8..cf8c95b18e 100644 --- a/windows.globalization/currencyidentifiers_usd.md +++ b/windows.globalization/currencyidentifiers_usd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.USD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.USD ## -description Gets the currency identifier for the United States Dollar. ## -property-value The string "USD", which identifies the United States Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.USD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.USD + +## -description +Gets the currency identifier for the United States Dollar. + +## -property-value +The string "USD", which identifies the United States Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_uyu.md b/windows.globalization/currencyidentifiers_uyu.md index a363ba0cf3..9b9f04bb02 100644 --- a/windows.globalization/currencyidentifiers_uyu.md +++ b/windows.globalization/currencyidentifiers_uyu.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.UYU --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.UYU ## -description Gets the currency identifier for the Uruguayan Peso. ## -property-value The string "UYU", which identifies the Uruguayan Peso. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.UYU +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.UYU + +## -description +Gets the currency identifier for the Uruguayan Peso. + +## -property-value +The string "UYU", which identifies the Uruguayan Peso. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_uzs.md b/windows.globalization/currencyidentifiers_uzs.md index dc04b3f0f2..aa1395c6f0 100644 --- a/windows.globalization/currencyidentifiers_uzs.md +++ b/windows.globalization/currencyidentifiers_uzs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.UZS --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.UZS ## -description Gets the currency identifier for the Uzbekistani Som. ## -property-value The string "UZS", which identifies the Uzbekistani Som. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.UZS +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.UZS + +## -description +Gets the currency identifier for the Uzbekistani Som. + +## -property-value +The string "UZS", which identifies the Uzbekistani Som. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_vef.md b/windows.globalization/currencyidentifiers_vef.md index 42d8490853..a37b26c5d8 100644 --- a/windows.globalization/currencyidentifiers_vef.md +++ b/windows.globalization/currencyidentifiers_vef.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.VEF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.VEF ## -description Gets the currency identifier for the Venezuelan Bolivar Fuerte. ## -property-value The string "VEF", which identifies the Venezuelan Bolivar Fuerte. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.VEF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.VEF + +## -description +Gets the currency identifier for the Venezuelan Bolivar Fuerte. + +## -property-value +The string "VEF", which identifies the Venezuelan Bolivar Fuerte. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_vnd.md b/windows.globalization/currencyidentifiers_vnd.md index f7f6d74950..21a61b5683 100644 --- a/windows.globalization/currencyidentifiers_vnd.md +++ b/windows.globalization/currencyidentifiers_vnd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.VND --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.VND ## -description Gets the currency identifier for the Viet Nam Dong. ## -property-value The string "VND", which identifies the Viet Nam Dong. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.VND +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.VND + +## -description +Gets the currency identifier for the Viet Nam Dong. + +## -property-value +The string "VND", which identifies the Viet Nam Dong. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_vuv.md b/windows.globalization/currencyidentifiers_vuv.md index 7295897fed..3ade3f8bb7 100644 --- a/windows.globalization/currencyidentifiers_vuv.md +++ b/windows.globalization/currencyidentifiers_vuv.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.VUV --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.VUV ## -description Gets the currency identifier for the Vanuatu Vatu. ## -property-value The string "VUV", which identifies the Vanuatu Vatu. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.VUV +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.VUV + +## -description +Gets the currency identifier for the Vanuatu Vatu. + +## -property-value +The string "VUV", which identifies the Vanuatu Vatu. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_wst.md b/windows.globalization/currencyidentifiers_wst.md index f55141fdf2..1ec59eca0c 100644 --- a/windows.globalization/currencyidentifiers_wst.md +++ b/windows.globalization/currencyidentifiers_wst.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.WST --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.WST ## -description Gets the currency identifier for the Samoa Tala. ## -property-value The string "WST", which identifies the Samoa Tala. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.WST +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.WST + +## -description +Gets the currency identifier for the Samoa Tala. + +## -property-value +The string "WST", which identifies the Samoa Tala. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_xaf.md b/windows.globalization/currencyidentifiers_xaf.md index 0486c2287a..c75f131475 100644 --- a/windows.globalization/currencyidentifiers_xaf.md +++ b/windows.globalization/currencyidentifiers_xaf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.XAF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.XAF ## -description Gets the currency identifier for the Central African CFA. ## -property-value The string "XAF", which identifies the Central African CFA. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.XAF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.XAF + +## -description +Gets the currency identifier for the Central African CFA. + +## -property-value +The string "XAF", which identifies the Central African CFA. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_xcd.md b/windows.globalization/currencyidentifiers_xcd.md index 9c19ed1f39..37fa6c2f90 100644 --- a/windows.globalization/currencyidentifiers_xcd.md +++ b/windows.globalization/currencyidentifiers_xcd.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.XCD --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.XCD ## -description Gets the currency identifier for the East Caribbean Dollar. ## -property-value The string "XCD", which identifies the East Caribbean Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.XCD +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.XCD + +## -description +Gets the currency identifier for the East Caribbean Dollar. + +## -property-value +The string "XCD", which identifies the East Caribbean Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_xof.md b/windows.globalization/currencyidentifiers_xof.md index 080cd093a6..2eb51bf56d 100644 --- a/windows.globalization/currencyidentifiers_xof.md +++ b/windows.globalization/currencyidentifiers_xof.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.XOF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.XOF ## -description Gets the currency identifier for the West African CFA. ## -property-value The string "XOF", which identifies the West African CFA. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.XOF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.XOF + +## -description +Gets the currency identifier for the West African CFA. + +## -property-value +The string "XOF", which identifies the West African CFA. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_xpf.md b/windows.globalization/currencyidentifiers_xpf.md index fb3ba5e78c..6bed965e09 100644 --- a/windows.globalization/currencyidentifiers_xpf.md +++ b/windows.globalization/currencyidentifiers_xpf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.XPF --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.XPF ## -description Gets the currency identifier for the French Pacific Franc. ## -property-value The string "XPF", which identifies the French Pacific Franc. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.XPF +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.XPF + +## -description +Gets the currency identifier for the French Pacific Franc. + +## -property-value +The string "XPF", which identifies the French Pacific Franc. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_xxx.md b/windows.globalization/currencyidentifiers_xxx.md index 17f074d62c..d318f6ab92 100644 --- a/windows.globalization/currencyidentifiers_xxx.md +++ b/windows.globalization/currencyidentifiers_xxx.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.XXX --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.XXX ## -description Gets the currency identifier that represents no currency. ## -property-value The string "XXX", which represents no currency. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.XXX +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.XXX + +## -description +Gets the currency identifier that represents no currency. + +## -property-value +The string "XXX", which represents no currency. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_yer.md b/windows.globalization/currencyidentifiers_yer.md index 730a4b23f9..d5ae73bbb8 100644 --- a/windows.globalization/currencyidentifiers_yer.md +++ b/windows.globalization/currencyidentifiers_yer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.YER --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.YER ## -description Gets the currency identifier for the Yemeni Rial. ## -property-value The string "YER", which identifies the Yemeni Rial. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.YER +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.YER + +## -description +Gets the currency identifier for the Yemeni Rial. + +## -property-value +The string "YER", which identifies the Yemeni Rial. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_zar.md b/windows.globalization/currencyidentifiers_zar.md index 4c70ec545f..da546281a5 100644 --- a/windows.globalization/currencyidentifiers_zar.md +++ b/windows.globalization/currencyidentifiers_zar.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ZAR --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ZAR ## -description Gets the currency identifier for the South African Rand. ## -property-value The string "ZAR", which identifies the South African Rand. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ZAR +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ZAR + +## -description +Gets the currency identifier for the South African Rand. + +## -property-value +The string "ZAR", which identifies the South African Rand. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_zmw.md b/windows.globalization/currencyidentifiers_zmw.md index 4a0ddcd843..6a13184c3c 100644 --- a/windows.globalization/currencyidentifiers_zmw.md +++ b/windows.globalization/currencyidentifiers_zmw.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ZMW --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ZMW ## -description Gets the currency identifier for the Zambian Kwacha. ## -property-value The string "ZMW", which identifies the Zambian Kwacha. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ZMW +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ZMW + +## -description +Gets the currency identifier for the Zambian Kwacha. + +## -property-value +The string "ZMW", which identifies the Zambian Kwacha. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/currencyidentifiers_zwl.md b/windows.globalization/currencyidentifiers_zwl.md index 86227b8528..7a45b838cb 100644 --- a/windows.globalization/currencyidentifiers_zwl.md +++ b/windows.globalization/currencyidentifiers_zwl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.CurrencyIdentifiers.ZWL --api-type: winrt property ---- # Windows.Globalization.CurrencyIdentifiers.ZWL ## -description Gets the currency identifier for the Zimbabwean Dollar. ## -property-value The string "ZWL", which identifies the Zimbabwean Dollar. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.CurrencyIdentifiers.ZWL +-api-type: winrt property +--- + + + +# Windows.Globalization.CurrencyIdentifiers.ZWL + +## -description +Gets the currency identifier for the Zimbabwean Dollar. + +## -property-value +The string "ZWL", which identifies the Zimbabwean Dollar. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_code.md b/windows.globalization/geographicregion_code.md index 4c57b9ee4f..f2c9cce97b 100644 --- a/windows.globalization/geographicregion_code.md +++ b/windows.globalization/geographicregion_code.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.Code --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.Code ## -description Gets the string that contains the best available identifier that represents the region. ## -property-value Returns a string that contains: + The two-letter identifier code, if one exists (and is not "ZZ"); + otherwise, the three-letter identifier code, if one exists (and is not "ZZZ"); + otherwise, the three-digit numeric identifier code, if one exists (and is not "999"); + otherwise, "ZZ". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.Code +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.Code + +## -description +Gets the string that contains the best available identifier that represents the region. + +## -property-value + +Returns a string that contains: + ++ The two-letter identifier code, if one exists (and is not "ZZ"); ++ otherwise, the three-letter identifier code, if one exists (and is not "ZZZ"); ++ otherwise, the three-digit numeric identifier code, if one exists (and is not "999"); ++ otherwise, "ZZ". + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_codethreedigit.md b/windows.globalization/geographicregion_codethreedigit.md index 10c5c72a66..5595f01033 100644 --- a/windows.globalization/geographicregion_codethreedigit.md +++ b/windows.globalization/geographicregion_codethreedigit.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.CodeThreeDigit --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.CodeThreeDigit ## -description Gets the three-digit identifier for this region, as a string. ## -property-value Returns as a string the ISO-3166-1 numeric three-digit code for the region, or the UN-M49 code. If the region is unknown, returns "999". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.CodeThreeDigit +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.CodeThreeDigit + +## -description +Gets the three-digit identifier for this region, as a string. + +## -property-value +Returns as a string the ISO-3166-1 numeric three-digit code for the region, or the UN-M49 code. If the region is unknown, returns "999". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_codethreeletter.md b/windows.globalization/geographicregion_codethreeletter.md index 823834c5d5..11782a92e3 100644 --- a/windows.globalization/geographicregion_codethreeletter.md +++ b/windows.globalization/geographicregion_codethreeletter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.CodeThreeLetter --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.CodeThreeLetter ## -description Gets the three-letter identifier for this region. ## -property-value Returns the three-letter ISO 3166-1 alpha-3 code for this region, if one exists; otherwise, returns "ZZZ". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.CodeThreeLetter +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.CodeThreeLetter + +## -description +Gets the three-letter identifier for this region. + +## -property-value +Returns the three-letter ISO 3166-1 alpha-3 code for this region, if one exists; otherwise, returns "ZZZ". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_codetwoletter.md b/windows.globalization/geographicregion_codetwoletter.md index b789bf80db..cb3b27516c 100644 --- a/windows.globalization/geographicregion_codetwoletter.md +++ b/windows.globalization/geographicregion_codetwoletter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.CodeTwoLetter --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.CodeTwoLetter ## -description Gets the two-letter identifier for this region. ## -property-value Returns the two-letter ISO 3166-1 alpha-2 code for this region, if one exists; otherwise, returns "ZZ". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.CodeTwoLetter +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.CodeTwoLetter + +## -description +Gets the two-letter identifier for this region. + +## -property-value +Returns the two-letter ISO 3166-1 alpha-2 code for this region, if one exists; otherwise, returns "ZZ". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_currenciesinuse.md b/windows.globalization/geographicregion_currenciesinuse.md index 9b744ca405..b0e761075d 100644 --- a/windows.globalization/geographicregion_currenciesinuse.md +++ b/windows.globalization/geographicregion_currenciesinuse.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.CurrenciesInUse --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.CurrenciesInUse ## -description Gets the set of currencies in use in this region. ## -property-value The set of ISO 4217 3-letter codes for the currencies that are used in the region. ## -remarks If the region is a country, there is typically one currency, although some countries do have more than one currency in use. If the region is larger, the returned set includes the currencies in use in each of the contained regions/countries. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.CurrenciesInUse +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.CurrenciesInUse + +## -description +Gets the set of currencies in use in this region. + +## -property-value +The set of ISO 4217 3-letter codes for the currencies that are used in the region. + +## -remarks +If the region is a country, there is typically one currency, although some countries do have more than one currency in use. If the region is larger, the returned set includes the currencies in use in each of the contained regions/countries. + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_displayname.md b/windows.globalization/geographicregion_displayname.md index ed3bcbaaa7..6d918cfe03 100644 --- a/windows.globalization/geographicregion_displayname.md +++ b/windows.globalization/geographicregion_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.DisplayName --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.DisplayName ## -description Gets a localized string that is suitable for display to the user for identifying the region. ## -property-value The localized name of the region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.DisplayName +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.DisplayName + +## -description +Gets a localized string that is suitable for display to the user for identifying the region. + +## -property-value +The localized name of the region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_geographicregion_1221375020.md b/windows.globalization/geographicregion_geographicregion_1221375020.md index 52c4d6830e..c1db89a849 100644 --- a/windows.globalization/geographicregion_geographicregion_1221375020.md +++ b/windows.globalization/geographicregion_geographicregion_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Globalization.GeographicRegion.#ctor --api-type: winrt method ---- # Windows.Globalization.GeographicRegion.GeographicRegion ## -description Creates a [GeographicRegion](geographicregion.md) object that defaults to the user's home region. ## -remarks ## -examples ## -see-also [GeographicRegion(String)](geographicregion_geographicregion_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.GeographicRegion.#ctor +-api-type: winrt method +--- + + + +# Windows.Globalization.GeographicRegion.GeographicRegion + +## -description +Creates a [GeographicRegion](geographicregion.md) object that defaults to the user's home region. + +## -remarks + +## -examples + +## -see-also +[GeographicRegion(String)](geographicregion_geographicregion_290278668.md) \ No newline at end of file diff --git a/windows.globalization/geographicregion_geographicregion_290278668.md b/windows.globalization/geographicregion_geographicregion_290278668.md index b0b2475f8b..685b8706b2 100644 --- a/windows.globalization/geographicregion_geographicregion_290278668.md +++ b/windows.globalization/geographicregion_geographicregion_290278668.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Globalization.GeographicRegion.#ctor(System.String) --api-type: winrt method ---- # Windows.Globalization.GeographicRegion.GeographicRegion ## -description Creates a [GeographicRegion](geographicregion.md) object. ## -parameters ### -param geographicRegionCode One of the ISO 3166-1 two-letter or three-letter codes that identify the country, or one of the three-digit UN-M49 codes that identify the geographical region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.GeographicRegion.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.GeographicRegion.GeographicRegion + +## -description +Creates a [GeographicRegion](geographicregion.md) object. + +## -parameters +### -param geographicRegionCode +One of the ISO 3166-1 two-letter or three-letter codes that identify the country, or one of the three-digit UN-M49 codes that identify the geographical region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_issupported_1861401289.md b/windows.globalization/geographicregion_issupported_1861401289.md index 2e6f051694..660af4ca73 100644 --- a/windows.globalization/geographicregion_issupported_1861401289.md +++ b/windows.globalization/geographicregion_issupported_1861401289.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Globalization.GeographicRegion.IsSupported(System.String) --api-type: winrt method ---- # Windows.Globalization.GeographicRegion.IsSupported ## -description Determines whether a geographic region identifier is supported. ## -parameters ### -param geographicRegionCode One of the ISO 3166-1 two-letter or three-letter codes that identify the country, or one of the three-digit UN-M49 codes that identify the geographical region. ## -returns **True** if the ID is known; otherwise, ** false**. If this method returns **true**, an app can safely construct a region by using this region identifier. If it returns **false**, attempting to construct a region for the given code will throw an exception. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Globalization.GeographicRegion.IsSupported(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.GeographicRegion.IsSupported + +## -description +Determines whether a geographic region identifier is supported. + +## -parameters +### -param geographicRegionCode +One of the ISO 3166-1 two-letter or three-letter codes that identify the country, or one of the three-digit UN-M49 codes that identify the geographical region. + +## -returns +**True** if the ID is known; otherwise, ** false**. If this method returns **true**, an app can safely construct a region by using this region identifier. If it returns **false**, attempting to construct a region for the given code will throw an exception. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/geographicregion_nativename.md b/windows.globalization/geographicregion_nativename.md index 711593a4cc..c5089ce3eb 100644 --- a/windows.globalization/geographicregion_nativename.md +++ b/windows.globalization/geographicregion_nativename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.GeographicRegion.NativeName --api-type: winrt property ---- # Windows.Globalization.GeographicRegion.NativeName ## -description Gets the name of the region in the primary language spoken in this region. ## -property-value The name of the region in the primary language spoken in this region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.GeographicRegion.NativeName +-api-type: winrt property +--- + + + +# Windows.Globalization.GeographicRegion.NativeName + +## -description +Gets the name of the region in the primary language spoken in this region. + +## -property-value +The name of the region in the primary language spoken in this region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/japanesephoneme.md b/windows.globalization/japanesephoneme.md index e02b58a913..636670161f 100644 --- a/windows.globalization/japanesephoneme.md +++ b/windows.globalization/japanesephoneme.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Globalization.JapanesePhoneme --api-type: winrt class ---- # Windows.Globalization.JapanesePhoneme ## -description Represents a single Japanese word (a "reading") that has been extracted from a Japanese string by [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md). ## -remarks [JapanesePhoneme](japanesephoneme.md) objects are created by calls to [JapanesePhoneticAnalyzer.GetWords(String)](japanesephoneticanalyzer_getwords_1967945274.md) or [JapanesePhoneticAnalyzer.GetWords(String, Boolean)](japanesephoneticanalyzer_getwords_1758641726.md). See the remarks for [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) for a more complete discussion and example. ## -examples ## -see-also [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md), [JapanesePhoneticAnalyzer.GetWords(String)](japanesephoneticanalyzer_getwords_1967945274.md), [JapanesePhoneticAnalyzer.GetWords(String, Boolean)](japanesephoneticanalyzer_getwords_1758641726.md) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.JapanesePhoneme +-api-type: winrt class +--- + + + +# Windows.Globalization.JapanesePhoneme + +## -description +Represents a single Japanese word (a "reading") that has been extracted from a Japanese string by [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md). + +## -remarks +[JapanesePhoneme](japanesephoneme.md) objects are created by calls to [JapanesePhoneticAnalyzer.GetWords(String)](japanesephoneticanalyzer_getwords_1967945274.md) or [JapanesePhoneticAnalyzer.GetWords(String, Boolean)](japanesephoneticanalyzer_getwords_1758641726.md). + +See the remarks for [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) for a more complete discussion and example. + +## -examples + +## -see-also +[JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md), [JapanesePhoneticAnalyzer.GetWords(String)](japanesephoneticanalyzer_getwords_1967945274.md), [JapanesePhoneticAnalyzer.GetWords(String, Boolean)](japanesephoneticanalyzer_getwords_1758641726.md) \ No newline at end of file diff --git a/windows.globalization/japanesephoneme_displaytext.md b/windows.globalization/japanesephoneme_displaytext.md index a76fda3208..26113da353 100644 --- a/windows.globalization/japanesephoneme_displaytext.md +++ b/windows.globalization/japanesephoneme_displaytext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.JapanesePhoneme.DisplayText --api-type: winrt property ---- # Windows.Globalization.JapanesePhoneme.DisplayText ## -description Gets the text to display for this Japanese word. ## -property-value The display text of this Japanese word. It is a sub-string of the Japanese string originally analyzed by [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md). ## -remarks ## -examples ## -see-also [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.JapanesePhoneme.DisplayText +-api-type: winrt property +--- + + + +# Windows.Globalization.JapanesePhoneme.DisplayText + +## -description +Gets the text to display for this Japanese word. + +## -property-value +The display text of this Japanese word. It is a sub-string of the Japanese string originally analyzed by [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md). + +## -remarks + +## -examples + +## -see-also +[JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) \ No newline at end of file diff --git a/windows.globalization/japanesephoneme_isphrasestart.md b/windows.globalization/japanesephoneme_isphrasestart.md index 8b2a9c8755..2941c8ca90 100644 --- a/windows.globalization/japanesephoneme_isphrasestart.md +++ b/windows.globalization/japanesephoneme_isphrasestart.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.JapanesePhoneme.IsPhraseStart --api-type: winrt property ---- # Windows.Globalization.JapanesePhoneme.IsPhraseStart ## -description Gets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) that indicates if this Japanese word is the start of a phrase. ## -property-value **true** if this Japanese word is the start of a phrase, otherwise **false**. ## -remarks ## -examples ## -see-also [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.JapanesePhoneme.IsPhraseStart +-api-type: winrt property +--- + + + +# Windows.Globalization.JapanesePhoneme.IsPhraseStart + +## -description +Gets a [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) that indicates if this Japanese word is the start of a phrase. + +## -property-value +**true** if this Japanese word is the start of a phrase, otherwise **false**. + +## -remarks + +## -examples + +## -see-also +[JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) \ No newline at end of file diff --git a/windows.globalization/japanesephoneme_yomitext.md b/windows.globalization/japanesephoneme_yomitext.md index b0b3eb2961..ac11224680 100644 --- a/windows.globalization/japanesephoneme_yomitext.md +++ b/windows.globalization/japanesephoneme_yomitext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.JapanesePhoneme.YomiText --api-type: winrt property ---- # Windows.Globalization.JapanesePhoneme.YomiText ## -description Gets the "reading" (the pronunciation of [DisplayText](japanesephoneme_displaytext.md)) for this Japanese word. ## -property-value The "reading" (the pronunciation of [DisplayText](japanesephoneme_displaytext.md), represented by a sequence of Hiragana characters). ## -remarks ## -examples ## -see-also [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.JapanesePhoneme.YomiText +-api-type: winrt property +--- + + + +# Windows.Globalization.JapanesePhoneme.YomiText + +## -description +Gets the "reading" (the pronunciation of [DisplayText](japanesephoneme_displaytext.md)) for this Japanese word. + +## -property-value +The "reading" (the pronunciation of [DisplayText](japanesephoneme_displaytext.md), represented by a sequence of Hiragana characters). + +## -remarks + +## -examples + +## -see-also +[JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) \ No newline at end of file diff --git a/windows.globalization/japanesephoneticanalyzer.md b/windows.globalization/japanesephoneticanalyzer.md index 4274f5a8c1..ab547f32ca 100644 --- a/windows.globalization/japanesephoneticanalyzer.md +++ b/windows.globalization/japanesephoneticanalyzer.md @@ -1,3 +1,38 @@ ---- -api-id: T:Windows.Globalization.JapanesePhoneticAnalyzer --api-type: winrt class ---- # Windows.Globalization.JapanesePhoneticAnalyzer ## -description Reads a Japanese string that is a combination of Kanji characters and Hiragana characters, and returns a collection of proper readings from the string with word breaks. ## -remarks Analyzing Japanese strings and generating readings and word breaks is not a straightforward task, as one Kanji character can be read in multiple ways depending on context. Japanese strings also don't have explicit word breaks such as whitespace. [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) breaks an input string into an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of [JapanesePhoneme](japanesephoneme.md) objects. Each [JapanesePhoneme](japanesephoneme.md) object represents a single Japanese word, and has properties for its display, its "reading" (the pronunciation of the display string, represented by a sequence of Hiragana characters), and whether or not it is the start of a phrase. **Example** When the method [JapanesePhoneticAnalyzer.GetWords(input)](japanesephoneticanalyzer_getwords_1967945274.md) analyzes the string "今日はいい天気です", it returns a vector of [JapanesePhoneme](japanesephoneme.md) with these properties:
01234
[DisplayText](japanesephoneme_displaytext.md)今日いい天気です
[YomiText](japanesephoneme_yomitext.md) (reading)きょういいてんきです
[IsPhraseStart](japanesephoneme_isphrasestart.md)truefalsetruetruefalse
You can also use the method overload [JapanesePhoneticAnalyzer.GetWords(input, monoRuby)](japanesephoneticanalyzer_getwords_1758641726.md) to specify the use of a word-breaking strategy called "Mono Ruby", which more aggressively attempts to break multi-Kanji words into multiple Kanji words. In the above example, using Mono Ruby, "天気" is further broken into "天" and "気". However, "今日" still remains unbroken due to the nature of the Japanese language. ## -examples ## -see-also [JapanesePhoneme](japanesephoneme.md), [Japanese phonetic analysis sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620555) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.JapanesePhoneticAnalyzer +-api-type: winrt class +--- + + + +# Windows.Globalization.JapanesePhoneticAnalyzer + +## -description +Reads a Japanese string that is a combination of Kanji characters and Hiragana characters, and returns a collection of proper readings from the string with word breaks. + + + +## -remarks +Analyzing Japanese strings and generating readings and word breaks is not a straightforward task, as one Kanji character can be read in multiple ways depending on context. Japanese strings also don't have explicit word breaks such as whitespace. [JapanesePhoneticAnalyzer](japanesephoneticanalyzer.md) breaks an input string into an [IVectorView](http://msdn.microsoft.com/library/644aa3d0-6f4d-406e-9adc-7f02fe575e90) of [JapanesePhoneme](japanesephoneme.md) objects. + +Each [JapanesePhoneme](japanesephoneme.md) object represents a single Japanese word, and has properties for its display, its "reading" (the pronunciation of the display string, represented by a sequence of Hiragana characters), and whether or not it is the start of a phrase. + + + +**Example** + +When the method [JapanesePhoneticAnalyzer.GetWords(input)](japanesephoneticanalyzer_getwords_1967945274.md) analyzes the string "今日はいい天気です", it returns a vector of [JapanesePhoneme](japanesephoneme.md) with these properties: + + + + +
01234
[DisplayText](japanesephoneme_displaytext.md)今日いい天気です
[YomiText](japanesephoneme_yomitext.md) (reading)きょういいてんきです
[IsPhraseStart](japanesephoneme_isphrasestart.md)truefalsetruetruefalse
+ +You can also use the method overload [JapanesePhoneticAnalyzer.GetWords(input, monoRuby)](japanesephoneticanalyzer_getwords_1758641726.md) to specify the use of a word-breaking strategy called "Mono Ruby", which more aggressively attempts to break multi-Kanji words into multiple Kanji words. In the above example, using Mono Ruby, "天気" is further broken into "天" and "気". However, "今日" still remains unbroken due to the nature of the Japanese language. + +## -examples + +## -see-also +[JapanesePhoneme](japanesephoneme.md), [Japanese phonetic analysis sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620555) \ No newline at end of file diff --git a/windows.globalization/japanesephoneticanalyzer_getwords_1758641726.md b/windows.globalization/japanesephoneticanalyzer_getwords_1758641726.md index aaeaeefa8c..d388ca54ca 100644 --- a/windows.globalization/japanesephoneticanalyzer_getwords_1758641726.md +++ b/windows.globalization/japanesephoneticanalyzer_getwords_1758641726.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Globalization.JapanesePhoneticAnalyzer.GetWords(System.String,System.Boolean) --api-type: winrt method ---- # Windows.Globalization.JapanesePhoneticAnalyzer.GetWords ## -description Reads a Japanese string that is a combination of Kanji characters and Hiragana characters, and returns a collection of proper readings from the string with word breaks. Optionally uses the "Mono Ruby" strategy in breaking multi-Kanji words into multiple Kanji words. ## -parameters ### -param input A Japanese string that is a combination of Kanji characters and Hiragana characters. ### -param monoRuby Specifies the use of the word-breaking strategy "Mono Ruby". If **true**, the word-breaking strategy "Mono Ruby" is used. "Mono Ruby" more aggressively attempts to break multi-Kanji words into multiple Kanji words. If **false**, "Mono Ruby" is not used. ## -returns A collection of [JapanesePhoneme](japanesephoneme.md) objects that represent proper readings from the string with word breaks. ## -remarks ## -examples ## -see-also [JapanesePhoneme](japanesephoneme.md), [GetWords(String)](japanesephoneticanalyzer_getwords_1967945274.md) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.JapanesePhoneticAnalyzer.GetWords(System.String,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Globalization.JapanesePhoneticAnalyzer.GetWords + +## -description +Reads a Japanese string that is a combination of Kanji characters and Hiragana characters, and returns a collection of proper readings from the string with word breaks. Optionally uses the "Mono Ruby" strategy in breaking multi-Kanji words into multiple Kanji words. + +## -parameters +### -param input +A Japanese string that is a combination of Kanji characters and Hiragana characters. + +### -param monoRuby +Specifies the use of the word-breaking strategy "Mono Ruby". If **true**, the word-breaking strategy "Mono Ruby" is used. "Mono Ruby" more aggressively attempts to break multi-Kanji words into multiple Kanji words. + +If **false**, "Mono Ruby" is not used. + +## -returns +A collection of [JapanesePhoneme](japanesephoneme.md) objects that represent proper readings from the string with word breaks. + +## -remarks + +## -examples + +## -see-also +[JapanesePhoneme](japanesephoneme.md), [GetWords(String)](japanesephoneticanalyzer_getwords_1967945274.md) \ No newline at end of file diff --git a/windows.globalization/japanesephoneticanalyzer_getwords_1967945274.md b/windows.globalization/japanesephoneticanalyzer_getwords_1967945274.md index 549fa99caa..fa40f62348 100644 --- a/windows.globalization/japanesephoneticanalyzer_getwords_1967945274.md +++ b/windows.globalization/japanesephoneticanalyzer_getwords_1967945274.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Globalization.JapanesePhoneticAnalyzer.GetWords(System.String) --api-type: winrt method ---- # Windows.Globalization.JapanesePhoneticAnalyzer.GetWords ## -description Reads a Japanese string that is a combination of Kanji characters and Hiragana characters, and returns a collection of proper readings from the string with word breaks. ## -parameters ### -param input A Japanese string that is a combination of Kanji characters and Hiragana characters. ## -returns A collection of [JapanesePhoneme](japanesephoneme.md) objects that represent proper readings from the string with word breaks. ## -remarks ## -examples ## -see-also [JapanesePhoneme](japanesephoneme.md), [GetWords(String, Boolean)](japanesephoneticanalyzer_getwords_1758641726.md), [Japanese phonetic analysis sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620555) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.JapanesePhoneticAnalyzer.GetWords(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.JapanesePhoneticAnalyzer.GetWords + +## -description +Reads a Japanese string that is a combination of Kanji characters and Hiragana characters, and returns a collection of proper readings from the string with word breaks. + +## -parameters +### -param input +A Japanese string that is a combination of Kanji characters and Hiragana characters. + +## -returns +A collection of [JapanesePhoneme](japanesephoneme.md) objects that represent proper readings from the string with word breaks. + +## -remarks + +## -examples + +## -see-also +[JapanesePhoneme](japanesephoneme.md), [GetWords(String, Boolean)](japanesephoneticanalyzer_getwords_1758641726.md), [Japanese phonetic analysis sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620555) \ No newline at end of file diff --git a/windows.globalization/language.md b/windows.globalization/language.md index 19dfbdbfee..e91232b446 100644 --- a/windows.globalization/language.md +++ b/windows.globalization/language.md @@ -1,3 +1,40 @@ ---- -api-id: T:Windows.Globalization.Language --api-type: winrt class ---- # Windows.Globalization.Language ## -description A class that provides information related to [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tags such as the language name and the script. ## -remarks If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). Initialize this class with a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. For example, to work with the best current user-preferred language, pass in the top value from [Windows.System.UserProfile.GlobalizationPreferences](../windows.system.userprofile/globalizationpreferences.md): **Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that these extensions can affect the numeral system or calendar used by globalization objects. ## -examples ```javascript // Get the top user-preferred language and its display name. var topUserLanguage = Windows.System.UserProfile.GlobalizationPreferences.languages[0]; var language = new Windows.Globalization.Language(topUserLanguage); var displayName = language.displayName; ``` ```csharp // Get the top user-preferred language and its display name. var topUserLanguage = Windows.System.UserProfile.GlobalizationPreferences.Languages[0]; var language = new Windows.Globalization.Language(topUserLanguage); var displayName = language.DisplayName; ``` ## -see-also [OCR sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620579), [Globalization preferences sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624045) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.Language +-api-type: winrt class +--- + + + +# Windows.Globalization.Language + +## -description +A class that provides information related to [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tags such as the language name and the script. + +## -remarks +If your app passes language tags used in this class to any [National Language Support](http://msdn.microsoft.com/library/7a548074-0782-45e1-8051-80c3b9d81885) functions, it must first convert the tags by calling [ResolveLocaleName](http://msdn.microsoft.com/library/99264b22-3fb5-47e2-b0b9-42a6768e67c1). + +Initialize this class with a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. For example, to work with the best current user-preferred language, pass in the top value from [Windows.System.UserProfile.GlobalizationPreferences](../windows.system.userprofile/globalizationpreferences.md): + +**Starting in :** Language tags support the Unicode extensions "ca-" and "nu-". (See [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919).) Note that these extensions can affect the numeral system or calendar used by globalization objects. + +## -examples +```javascript +// Get the top user-preferred language and its display name. +var topUserLanguage = Windows.System.UserProfile.GlobalizationPreferences.languages[0]; +var language = new Windows.Globalization.Language(topUserLanguage); +var displayName = language.displayName; +``` + +```csharp +// Get the top user-preferred language and its display name. +var topUserLanguage = Windows.System.UserProfile.GlobalizationPreferences.Languages[0]; +var language = new Windows.Globalization.Language(topUserLanguage); +var displayName = language.DisplayName; +``` + + + +## -see-also +[OCR sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620579), [Globalization preferences sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624045) \ No newline at end of file diff --git a/windows.globalization/language_currentinputmethodlanguagetag.md b/windows.globalization/language_currentinputmethodlanguagetag.md index f5b77cfdf2..497ba7c7a6 100644 --- a/windows.globalization/language_currentinputmethodlanguagetag.md +++ b/windows.globalization/language_currentinputmethodlanguagetag.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Globalization.Language.CurrentInputMethodLanguageTag --api-type: winrt property ---- # Windows.Globalization.Language.CurrentInputMethodLanguageTag ## -description Gets the [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag for the currently enabled keyboard layout or Input Method Editor (IME). ## -property-value The [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. ## -remarks ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Language.CurrentInputMethodLanguageTag +-api-type: winrt property +--- + + + +# Windows.Globalization.Language.CurrentInputMethodLanguageTag + +## -description +Gets the [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag for the currently enabled keyboard layout or Input Method Editor (IME). + +## -property-value +The [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. + +## -remarks + + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization/language_displayname.md b/windows.globalization/language_displayname.md index a5286ccf3f..1fb8f30414 100644 --- a/windows.globalization/language_displayname.md +++ b/windows.globalization/language_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Language.DisplayName --api-type: winrt property ---- # Windows.Globalization.Language.DisplayName ## -description Gets a localized string that is suitable for display to the user for identifying the language. ## -property-value The localized name of the language. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Language.DisplayName +-api-type: winrt property +--- + + + +# Windows.Globalization.Language.DisplayName + +## -description +Gets a localized string that is suitable for display to the user for identifying the language. + +## -property-value +The localized name of the language. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/language_getextensionsubtags_1881697505.md b/windows.globalization/language_getextensionsubtags_1881697505.md index be7e46d1f6..2d5e46bc82 100644 --- a/windows.globalization/language_getextensionsubtags_1881697505.md +++ b/windows.globalization/language_getextensionsubtags_1881697505.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Globalization.Language.GetExtensionSubtags(System.String) --api-type: winrt method ---- # Windows.Globalization.Language.GetExtensionSubtags ## -description Retrieves a vector of extension subtags in the current language for the given extension identified by singleton. ## -parameters ### -param singleton A single-character subtag for the [LanguageTag](language_languagetag.md) of the current language. See [BCP-47 language tags, Extensions and the Extensions Registry](http://go.microsoft.com/fwlink/p/?LinkId=282719). ## -returns The list of extension subtags identified by *singleton*. ## -remarks If *singleton* does not exist for the current language, the returned vector is empty. If *singleton* is a known system (such as "u", the Unicode extension), the returned subtags may be combined into logical units. For example, "de-DE-u-attr-co-phonebk" returns a vector with two items: "attr" and "co-phonebk". If *singleton* is unknown, each subtag is returned in a separate item. ## -examples ## -see-also [LanguageTag](language_languagetag.md), [BCP-47 language tags, Extensions and the Extensions Registry](http://go.microsoft.com/fwlink/p/?LinkId=282719), [BCP-47 language tags, Extension Subtags](http://go.microsoft.com/fwlink/p/?LinkId=282718) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Language.GetExtensionSubtags(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Language.GetExtensionSubtags + +## -description +Retrieves a vector of extension subtags in the current language for the given extension identified by singleton. + +## -parameters +### -param singleton +A single-character subtag for the [LanguageTag](language_languagetag.md) of the current language. See [BCP-47 language tags, Extensions and the Extensions Registry](http://go.microsoft.com/fwlink/p/?LinkId=282719). + +## -returns +The list of extension subtags identified by *singleton*. + +## -remarks +If *singleton* does not exist for the current language, the returned vector is empty. + +If *singleton* is a known system (such as "u", the Unicode extension), the returned subtags may be combined into logical units. For example, "de-DE-u-attr-co-phonebk" returns a vector with two items: "attr" and "co-phonebk". If *singleton* is unknown, each subtag is returned in a separate item. + +## -examples + +## -see-also +[LanguageTag](language_languagetag.md), [BCP-47 language tags, Extensions and the Extensions Registry](http://go.microsoft.com/fwlink/p/?LinkId=282719), [BCP-47 language tags, Extension Subtags](http://go.microsoft.com/fwlink/p/?LinkId=282718) \ No newline at end of file diff --git a/windows.globalization/language_iswellformed_1733554260.md b/windows.globalization/language_iswellformed_1733554260.md index 5e2c8487a4..62ca4fd8d1 100644 --- a/windows.globalization/language_iswellformed_1733554260.md +++ b/windows.globalization/language_iswellformed_1733554260.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Globalization.Language.IsWellFormed(System.String) --api-type: winrt method ---- # Windows.Globalization.Language.IsWellFormed ## -description Determines whether a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag is well-formed. ## -parameters ### -param languageTag A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. ## -returns **True** if the language tag is well-formed as defined by [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302), except when the language tag can never be valid according to [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302). Otherwise it returns **false**. If this method returns **true**, an application can safely construct a language by using this tag. If it returns **false**, attempting to construct a language for the given tag will throw an exception. ## -remarks ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Language.IsWellFormed(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Language.IsWellFormed + +## -description +Determines whether a [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag is well-formed. + +## -parameters +### -param languageTag +A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. + +## -returns +**True** if the language tag is well-formed as defined by [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302), except when the language tag can never be valid according to [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302). Otherwise it returns **false**. If this method returns **true**, an application can safely construct a language by using this tag. If it returns **false**, attempting to construct a language for the given tag will throw an exception. + +## -remarks + + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization/language_language_290278668.md b/windows.globalization/language_language_290278668.md index 12a18b36c2..70f57d36f8 100644 --- a/windows.globalization/language_language_290278668.md +++ b/windows.globalization/language_language_290278668.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Globalization.Language.#ctor(System.String) --api-type: winrt method ---- # Windows.Globalization.Language.Language ## -description Creates a [Language](language.md) object. ## -parameters ### -param languageTag A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. See Remarks. ## -remarks ## -examples ## -see-also [Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Language.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Language.Language + +## -description +Creates a [Language](language.md) object. + +## -parameters +### -param languageTag +A [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. See Remarks. + +## -remarks + + +## -examples + +## -see-also +[Unicode Key/Type Definitions](http://go.microsoft.com/fwlink/p/?LinkId=308919) \ No newline at end of file diff --git a/windows.globalization/language_languagetag.md b/windows.globalization/language_languagetag.md index 4b94f0faf6..65f857d26f 100644 --- a/windows.globalization/language_languagetag.md +++ b/windows.globalization/language_languagetag.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Globalization.Language.LanguageTag --api-type: winrt property ---- # Windows.Globalization.Language.LanguageTag ## -description Gets the normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag for this language. ## -property-value The normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Language](language_language.md) constructor. ## -remarks ## -examples ## -see-also [BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Language.LanguageTag +-api-type: winrt property +--- + + + +# Windows.Globalization.Language.LanguageTag + +## -description +Gets the normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag for this language. + +## -property-value +The normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Language](language_language.md) constructor. + +## -remarks + + +## -examples + +## -see-also +[BCP-47 language tags](http://go.microsoft.com/fwlink/p/?linkid=227302) \ No newline at end of file diff --git a/windows.globalization/language_nativename.md b/windows.globalization/language_nativename.md index e9a8af1135..09e6b89e0a 100644 --- a/windows.globalization/language_nativename.md +++ b/windows.globalization/language_nativename.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Language.NativeName --api-type: winrt property ---- # Windows.Globalization.Language.NativeName ## -description Gets the name of the language in the language itself. ## -property-value The name of the language in the language itself. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Language.NativeName +-api-type: winrt property +--- + + + +# Windows.Globalization.Language.NativeName + +## -description +Gets the name of the language in the language itself. + +## -property-value +The name of the language in the language itself. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/language_script.md b/windows.globalization/language_script.md index b170bcceb7..c2f21eff37 100644 --- a/windows.globalization/language_script.md +++ b/windows.globalization/language_script.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.Language.Script --api-type: winrt property ---- # Windows.Globalization.Language.Script ## -description Gets the four-letter ISO 15924 script code of the language. ## -property-value A string with the script code of the language. If the script code cannot be identified or inferred from the [language tag](language_languagetag.md), "Zyyy" is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.Language.Script +-api-type: winrt property +--- + + + +# Windows.Globalization.Language.Script + +## -description +Gets the four-letter ISO 15924 script code of the language. + +## -property-value +A string with the script code of the language. If the script code cannot be identified or inferred from the [language tag](language_languagetag.md), "Zyyy" is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/language_trysetinputmethodlanguagetag_1455010016.md b/windows.globalization/language_trysetinputmethodlanguagetag_1455010016.md index 6b8a2858a0..ac897056be 100644 --- a/windows.globalization/language_trysetinputmethodlanguagetag_1455010016.md +++ b/windows.globalization/language_trysetinputmethodlanguagetag_1455010016.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Globalization.Language.TrySetInputMethodLanguageTag(System.String) --api-type: winrt method ---- # Windows.Globalization.Language.TrySetInputMethodLanguageTag ## -description Tries to set the normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag of this language. ## -parameters ### -param languageTag The normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. **Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Language](language_language.md) constructor. ## -returns **true** if the value is successfully set, otherwise **false**. This method will only attempt to change the input language if the application is running on an IoT device. On non-IoT devices, the return value is always **false**. ## -remarks ## -examples ## -see-also ## -capabilities systemManagement \ No newline at end of file +--- +-api-id: M:Windows.Globalization.Language.TrySetInputMethodLanguageTag(System.String) +-api-type: winrt method +--- + + + +# Windows.Globalization.Language.TrySetInputMethodLanguageTag + +## -description +Tries to set the normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag of this language. + +## -parameters +### -param languageTag +The normalized [BCP-47](http://go.microsoft.com/fwlink/p/?linkid=227302) language tag. + +**Starting in :** Language tags can support Unicode extensions. See the Remarks for the [Language](language_language.md) constructor. + +## -returns +**true** if the value is successfully set, otherwise **false**. + +This method will only attempt to change the input language if the application is running on an IoT device. On non-IoT devices, the return value is always **false**. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +systemManagement \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers.md b/windows.globalization/numeralsystemidentifiers.md index 52af7ff206..399c102d8c 100644 --- a/windows.globalization/numeralsystemidentifiers.md +++ b/windows.globalization/numeralsystemidentifiers.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Globalization.NumeralSystemIdentifiers --api-type: winrt class ---- # Windows.Globalization.NumeralSystemIdentifiers ## -description Contains the numeral system identifiers for the supported numeral systems, as static properties. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: T:Windows.Globalization.NumeralSystemIdentifiers +-api-type: winrt class +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers + +## -description +Contains the numeral system identifiers for the supported numeral systems, as static properties. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_arab.md b/windows.globalization/numeralsystemidentifiers_arab.md index 42ce8a1fe7..2197a33d4a 100644 --- a/windows.globalization/numeralsystemidentifiers_arab.md +++ b/windows.globalization/numeralsystemidentifiers_arab.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Arab --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Arab ## -description Gets the identifier for the Arabic-Indic decimal numeral system. ## -property-value The string "Arab", which identifies the Arabic-Indic decimal numeral system. This system has the digits ٠١٢٣٤٥٦٧٨٩ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Arab +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Arab + +## -description +Gets the identifier for the Arabic-Indic decimal numeral system. + +## -property-value +The string "Arab", which identifies the Arabic-Indic decimal numeral system. This system has the digits ٠١٢٣٤٥٦٧٨٩ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_arabext.md b/windows.globalization/numeralsystemidentifiers_arabext.md index 48d5e463c4..b482baa9aa 100644 --- a/windows.globalization/numeralsystemidentifiers_arabext.md +++ b/windows.globalization/numeralsystemidentifiers_arabext.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ArabExt --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.ArabExt ## -description Gets the identifier for the Extended Arabic-Indic decimal numeral system. ## -property-value The string "ArabExt", which identifies the Extended Arabic-Indic decimal numeral system. This system has the digits ۰۱۲۳۴۵۶۷۸۹ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ArabExt +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.ArabExt + +## -description +Gets the identifier for the Extended Arabic-Indic decimal numeral system. + +## -property-value +The string "ArabExt", which identifies the Extended Arabic-Indic decimal numeral system. This system has the digits ۰۱۲۳۴۵۶۷۸۹ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_bali.md b/windows.globalization/numeralsystemidentifiers_bali.md index 639017e65d..2cce67c570 100644 --- a/windows.globalization/numeralsystemidentifiers_bali.md +++ b/windows.globalization/numeralsystemidentifiers_bali.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Bali --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Bali ## -description Gets the identifier for the Balinese decimal numeral system. ## -property-value The string "Bali", which identifies the Balinese decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+1B500
U+1B511
U+1B522
U+1B533
U+1B544
U+1B555
U+1B566
U+1B577
U+1B588
U+1B599
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Bali +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Bali + +## -description +Gets the identifier for the Balinese decimal numeral system. + +## -property-value +The string "Bali", which identifies the Balinese decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+1B500
U+1B511
U+1B522
U+1B533
U+1B544
U+1B555
U+1B566
U+1B577
U+1B588
U+1B599
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_beng.md b/windows.globalization/numeralsystemidentifiers_beng.md index 0b40b595c8..2a00ef9d5d 100644 --- a/windows.globalization/numeralsystemidentifiers_beng.md +++ b/windows.globalization/numeralsystemidentifiers_beng.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Beng --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Beng ## -description Gets the identifier for the Bangla decimal numeral system. ## -property-value The string "Beng", which identifies the Bangla decimal numeral system. This system has the digits ০১২৩৪৫৬৭৮৯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Beng +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Beng + +## -description +Gets the identifier for the Bangla decimal numeral system. + +## -property-value +The string "Beng", which identifies the Bangla decimal numeral system. This system has the digits ০১২৩৪৫৬৭৮৯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_brah.md b/windows.globalization/numeralsystemidentifiers_brah.md index 7d1454bb20..087ac706d5 100644 --- a/windows.globalization/numeralsystemidentifiers_brah.md +++ b/windows.globalization/numeralsystemidentifiers_brah.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Brah --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Brah ## -description Gets the identifier for the Brahmi decimal numeral system. ## -property-value The string "Brah", which identifies the Brahmi decimal numeral system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Brah +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Brah + +## -description +Gets the identifier for the Brahmi decimal numeral system. + +## -property-value +The string "Brah", which identifies the Brahmi decimal numeral system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_cham.md b/windows.globalization/numeralsystemidentifiers_cham.md index 6f4845509e..17b9d9738b 100644 --- a/windows.globalization/numeralsystemidentifiers_cham.md +++ b/windows.globalization/numeralsystemidentifiers_cham.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Cham --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Cham ## -description Gets the identifier for the Cham decimal numeral system. ## -property-value The string "Cham", which identifies the Cham decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+AA500
U+AA511
U+AA522
U+AA533
U+AA544
U+AA555
U+AA566
U+AA577
U+AA588
U+AA599
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Cham +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Cham + +## -description +Gets the identifier for the Cham decimal numeral system. + +## -property-value +The string "Cham", which identifies the Cham decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+AA500
U+AA511
U+AA522
U+AA533
U+AA544
U+AA555
U+AA566
U+AA577
U+AA588
U+AA599
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_deva.md b/windows.globalization/numeralsystemidentifiers_deva.md index 2fb12fc078..b00fc1e298 100644 --- a/windows.globalization/numeralsystemidentifiers_deva.md +++ b/windows.globalization/numeralsystemidentifiers_deva.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Deva --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Deva ## -description Gets the identifier for the Devanagari decimal numeral system. ## -property-value The string "Deva", which identifies the Devanagari decimal numeral system. This system has the digits ०१२३४५६७८९ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Deva +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Deva + +## -description +Gets the identifier for the Devanagari decimal numeral system. + +## -property-value +The string "Deva", which identifies the Devanagari decimal numeral system. This system has the digits ०१२३४५६७८९ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_fullwide.md b/windows.globalization/numeralsystemidentifiers_fullwide.md index 647311c3b9..64fb3480a1 100644 --- a/windows.globalization/numeralsystemidentifiers_fullwide.md +++ b/windows.globalization/numeralsystemidentifiers_fullwide.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.FullWide --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.FullWide ## -description Gets the identifier for the Latin decimal numeral system using full-width characters. ## -property-value The string "FullWide", which identifies the Latin decimal numeral system using full-width characters. This system has the digits 0123456789 which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.FullWide +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.FullWide + +## -description +Gets the identifier for the Latin decimal numeral system using full-width characters. + +## -property-value +The string "FullWide", which identifies the Latin decimal numeral system using full-width characters. This system has the digits 0123456789 which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_gujr.md b/windows.globalization/numeralsystemidentifiers_gujr.md index 34eb6d2712..6ebc312f86 100644 --- a/windows.globalization/numeralsystemidentifiers_gujr.md +++ b/windows.globalization/numeralsystemidentifiers_gujr.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Gujr --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Gujr ## -description Gets the identifier for the Gujarati decimal numeral system. ## -property-value The string "Gujr", which identifies the Gujarati decimal numeral system. This system has the digits ૦૧૨૩૪૫૬૭૮૯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Gujr +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Gujr + +## -description +Gets the identifier for the Gujarati decimal numeral system. + +## -property-value +The string "Gujr", which identifies the Gujarati decimal numeral system. This system has the digits ૦૧૨૩૪૫૬૭૮૯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_guru.md b/windows.globalization/numeralsystemidentifiers_guru.md index 88b9803d26..0dfa0577e3 100644 --- a/windows.globalization/numeralsystemidentifiers_guru.md +++ b/windows.globalization/numeralsystemidentifiers_guru.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Guru --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Guru ## -description Gets the identifier for the Gurmukhi decimal numeral system. ## -property-value The string "Guru", which identifies the Gurmukhi decimal numeral system. This system has the digits ੦੧੨੩੪੫੬੭੮੯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Guru +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Guru + +## -description +Gets the identifier for the Gurmukhi decimal numeral system. + +## -property-value +The string "Guru", which identifies the Gurmukhi decimal numeral system. This system has the digits ੦੧੨੩੪੫੬੭੮੯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_hanidec.md b/windows.globalization/numeralsystemidentifiers_hanidec.md index 6a2bcccadd..d192a62e17 100644 --- a/windows.globalization/numeralsystemidentifiers_hanidec.md +++ b/windows.globalization/numeralsystemidentifiers_hanidec.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.HaniDec --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.HaniDec ## -description Gets the identifier for the Han decimal numeral system. ## -property-value The string "HaniDec", which identifies the Han decimal numeral system. This system has the digits 〇一二三四五六七八九 which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.HaniDec +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.HaniDec + +## -description +Gets the identifier for the Han decimal numeral system. + +## -property-value +The string "HaniDec", which identifies the Han decimal numeral system. This system has the digits 〇一二三四五六七八九 which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_java.md b/windows.globalization/numeralsystemidentifiers_java.md index 3adafcab12..cf03d03e9a 100644 --- a/windows.globalization/numeralsystemidentifiers_java.md +++ b/windows.globalization/numeralsystemidentifiers_java.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Java --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Java ## -description Gets the identifier for the Javanese decimal numeral system. ## -property-value The string "Java", which identifies the Javanese decimal numeral system. This system has the digits ꧐꧑꧒꧓꧔꧕꧖꧗꧘꧙ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Java +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Java + +## -description +Gets the identifier for the Javanese decimal numeral system. + +## -property-value +The string "Java", which identifies the Javanese decimal numeral system. This system has the digits ꧐꧑꧒꧓꧔꧕꧖꧗꧘꧙ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_kali.md b/windows.globalization/numeralsystemidentifiers_kali.md index d054b89a2a..5e129037ae 100644 --- a/windows.globalization/numeralsystemidentifiers_kali.md +++ b/windows.globalization/numeralsystemidentifiers_kali.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Kali --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Kali ## -description Gets the identifier for the Kayah Li decimal numeral system. ## -property-value The string "Kali", which identifies the Kayah Li decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+A9000
U+A9011
U+A9022
U+A9033
U+A9044
U+A9055
U+A9066
U+A9077
U+A9088
U+A9099
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Kali +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Kali + +## -description +Gets the identifier for the Kayah Li decimal numeral system. + +## -property-value +The string "Kali", which identifies the Kayah Li decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+A9000
U+A9011
U+A9022
U+A9033
U+A9044
U+A9055
U+A9066
U+A9077
U+A9088
U+A9099
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_khmr.md b/windows.globalization/numeralsystemidentifiers_khmr.md index 771a35ce12..3b4b163fa7 100644 --- a/windows.globalization/numeralsystemidentifiers_khmr.md +++ b/windows.globalization/numeralsystemidentifiers_khmr.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Khmr --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Khmr ## -description Gets the identifier for the Khmer decimal numeral system. ## -property-value The string "Khmr", which identifies the Khmer decimal numeral system. This system has the digits ០១២៣៤៥៦៧៨៩ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Khmr +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Khmr + +## -description +Gets the identifier for the Khmer decimal numeral system. + +## -property-value +The string "Khmr", which identifies the Khmer decimal numeral system. This system has the digits ០១២៣៤៥៦៧៨៩ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_knda.md b/windows.globalization/numeralsystemidentifiers_knda.md index 8ce87ff792..a5fb59427f 100644 --- a/windows.globalization/numeralsystemidentifiers_knda.md +++ b/windows.globalization/numeralsystemidentifiers_knda.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Knda --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Knda ## -description Gets the identifier for the Kannada decimal numeral system. ## -property-value The string "Knda", which identifies the Kannada decimal numeral system. This system has the digits ೦೧೨೩೪೫೬೭೮೯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Knda +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Knda + +## -description +Gets the identifier for the Kannada decimal numeral system. + +## -property-value +The string "Knda", which identifies the Kannada decimal numeral system. This system has the digits ೦೧೨೩೪೫೬೭೮೯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_lana.md b/windows.globalization/numeralsystemidentifiers_lana.md index 23c346aac4..ad9bdb091f 100644 --- a/windows.globalization/numeralsystemidentifiers_lana.md +++ b/windows.globalization/numeralsystemidentifiers_lana.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Lana --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Lana ## -description Gets the identifier for the Tai Tham Hora decimal numeral system. ## -property-value The string "Lana", which identifies the Tai Tham Hora decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+1A800
U+1A811
U+1A822
U+1A833
U+1A844
U+1A855
U+1A866
U+1A877
U+1A888
U+1A899
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Lana +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Lana + +## -description +Gets the identifier for the Tai Tham Hora decimal numeral system. + +## -property-value +The string "Lana", which identifies the Tai Tham Hora decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+1A800
U+1A811
U+1A822
U+1A833
U+1A844
U+1A855
U+1A866
U+1A877
U+1A888
U+1A899
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_lanatham.md b/windows.globalization/numeralsystemidentifiers_lanatham.md index 20e315dab1..6b82d2be65 100644 --- a/windows.globalization/numeralsystemidentifiers_lanatham.md +++ b/windows.globalization/numeralsystemidentifiers_lanatham.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.LanaTham --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.LanaTham ## -description Gets the identifier for the Tai Tham Tham decimal numeral system. ## -property-value The string "LanaTham", which identifies the Tai Tham Tham decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+1A900
U+1A911
U+1A922
U+1A933
U+1A944
U+1A955
U+1A966
U+1A977
U+1A988
U+1A999
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.LanaTham +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.LanaTham + +## -description +Gets the identifier for the Tai Tham Tham decimal numeral system. + +## -property-value +The string "LanaTham", which identifies the Tai Tham Tham decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+1A900
U+1A911
U+1A922
U+1A933
U+1A944
U+1A955
U+1A966
U+1A977
U+1A988
U+1A999
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_laoo.md b/windows.globalization/numeralsystemidentifiers_laoo.md index 3915f1092f..03890c76c5 100644 --- a/windows.globalization/numeralsystemidentifiers_laoo.md +++ b/windows.globalization/numeralsystemidentifiers_laoo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Laoo --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Laoo ## -description Gets the identifier for the Laoo decimal numeral system. ## -property-value The string "Laoo", which identifies the Laoo decimal numeral system. This system has the digits ۰۱۲۳۴۵۶۷۸۹ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Laoo +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Laoo + +## -description +Gets the identifier for the Laoo decimal numeral system. + +## -property-value +The string "Laoo", which identifies the Laoo decimal numeral system. This system has the digits ۰۱۲۳۴۵۶۷۸۹ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_latn.md b/windows.globalization/numeralsystemidentifiers_latn.md index f6c37f2461..f5a92ea276 100644 --- a/windows.globalization/numeralsystemidentifiers_latn.md +++ b/windows.globalization/numeralsystemidentifiers_latn.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Latn --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Latn ## -description Gets the identifier for the Latin decimal numeral system. ## -property-value The string "Latn", which identifies the Latin decimal numeral system. This system has the Latin digits 0123456789. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Latn +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Latn + +## -description +Gets the identifier for the Latin decimal numeral system. + +## -property-value +The string "Latn", which identifies the Latin decimal numeral system. This system has the Latin digits 0123456789. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_lepc.md b/windows.globalization/numeralsystemidentifiers_lepc.md index 7c5a5a0fa0..4326322c21 100644 --- a/windows.globalization/numeralsystemidentifiers_lepc.md +++ b/windows.globalization/numeralsystemidentifiers_lepc.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Lepc --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Lepc ## -description Gets the identifier for the Lepcha decimal numeral system. ## -property-value The string "Lepc", which identifies the Lepcha decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+1C400
U+1C411
U+1C422
U+1C433
U+1C444
U+1C455
U+1C466
U+1C477
U+1C488
U+1C499
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Lepc +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Lepc + +## -description +Gets the identifier for the Lepcha decimal numeral system. + +## -property-value +The string "Lepc", which identifies the Lepcha decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+1C400
U+1C411
U+1C422
U+1C433
U+1C444
U+1C455
U+1C466
U+1C477
U+1C488
U+1C499
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_limb.md b/windows.globalization/numeralsystemidentifiers_limb.md index a2399156c6..11729854e7 100644 --- a/windows.globalization/numeralsystemidentifiers_limb.md +++ b/windows.globalization/numeralsystemidentifiers_limb.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Limb --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Limb ## -description Gets the identifier for the Limbu decimal numeral system. ## -property-value The string "Limb", which identifies the Limbu decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+19460
U+19471
U+19482
U+19493
U+194A4
U+194B5
U+194C6
U+194D7
U+194E8
U+194F9
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Limb +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Limb + +## -description +Gets the identifier for the Limbu decimal numeral system. + +## -property-value +The string "Limb", which identifies the Limbu decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+19460
U+19471
U+19482
U+19493
U+194A4
U+194B5
U+194C6
U+194D7
U+194E8
U+194F9
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_mathbold.md b/windows.globalization/numeralsystemidentifiers_mathbold.md index f7f9e5c023..6b00311f08 100644 --- a/windows.globalization/numeralsystemidentifiers_mathbold.md +++ b/windows.globalization/numeralsystemidentifiers_mathbold.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathBold --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.MathBold ## -description Gets the identifier for the decimal numeral system using MathBold characters. ## -property-value The string "MathBold", which identifies the decimal numeral system using MathBold characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathBold +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.MathBold + +## -description +Gets the identifier for the decimal numeral system using MathBold characters. + +## -property-value +The string "MathBold", which identifies the decimal numeral system using MathBold characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_mathdbl.md b/windows.globalization/numeralsystemidentifiers_mathdbl.md index 1f5a4f1fea..8f42ed3116 100644 --- a/windows.globalization/numeralsystemidentifiers_mathdbl.md +++ b/windows.globalization/numeralsystemidentifiers_mathdbl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathDbl --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.MathDbl ## -description Gets the identifier for the decimal numeral system using MathDbl characters. ## -property-value The string "MathDbl", which identifies the decimal numeral system using MathDbl characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathDbl +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.MathDbl + +## -description +Gets the identifier for the decimal numeral system using MathDbl characters. + +## -property-value +The string "MathDbl", which identifies the decimal numeral system using MathDbl characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_mathmono.md b/windows.globalization/numeralsystemidentifiers_mathmono.md index 2f49215e4d..3d6a8a3005 100644 --- a/windows.globalization/numeralsystemidentifiers_mathmono.md +++ b/windows.globalization/numeralsystemidentifiers_mathmono.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathMono --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.MathMono ## -description Gets the identifier for the decimal numeral system using MathMono characters. ## -property-value The string "MathMono", which identifies the decimal numeral system using MathMono characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathMono +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.MathMono + +## -description +Gets the identifier for the decimal numeral system using MathMono characters. + +## -property-value +The string "MathMono", which identifies the decimal numeral system using MathMono characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_mathsanb.md b/windows.globalization/numeralsystemidentifiers_mathsanb.md index 3a16ae7b70..239902a4ae 100644 --- a/windows.globalization/numeralsystemidentifiers_mathsanb.md +++ b/windows.globalization/numeralsystemidentifiers_mathsanb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathSanb --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.MathSanb ## -description Gets the identifier for the decimal numeral system using MathSanb characters. ## -property-value The string "MathSanb", which identifies the decimal numeral system using MathSanb characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathSanb +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.MathSanb + +## -description +Gets the identifier for the decimal numeral system using MathSanb characters. + +## -property-value +The string "MathSanb", which identifies the decimal numeral system using MathSanb characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_mathsans.md b/windows.globalization/numeralsystemidentifiers_mathsans.md index cec82ea382..7d9091bb62 100644 --- a/windows.globalization/numeralsystemidentifiers_mathsans.md +++ b/windows.globalization/numeralsystemidentifiers_mathsans.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathSans --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.MathSans ## -description Gets the identifier for the decimal numeral system using MathSans characters. ## -property-value The string "MathSans", which identifies the decimal numeral system using MathSans characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MathSans +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.MathSans + +## -description +Gets the identifier for the decimal numeral system using MathSans characters. + +## -property-value +The string "MathSans", which identifies the decimal numeral system using MathSans characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_mlym.md b/windows.globalization/numeralsystemidentifiers_mlym.md index bca1fdd04f..7938a03225 100644 --- a/windows.globalization/numeralsystemidentifiers_mlym.md +++ b/windows.globalization/numeralsystemidentifiers_mlym.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mlym --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Mlym ## -description Gets the identifier for the Malayalam decimal numeral system. ## -property-value The string "Mlym", which identifies the Malayalam decimal numeral system. This system has the digits ൦൧൨൩൪൫൬൭൮൯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mlym +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Mlym + +## -description +Gets the identifier for the Malayalam decimal numeral system. + +## -property-value +The string "Mlym", which identifies the Malayalam decimal numeral system. This system has the digits ൦൧൨൩൪൫൬൭൮൯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_mong.md b/windows.globalization/numeralsystemidentifiers_mong.md index 086e65225c..b92b104bb1 100644 --- a/windows.globalization/numeralsystemidentifiers_mong.md +++ b/windows.globalization/numeralsystemidentifiers_mong.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mong --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Mong ## -description Gets the identifier for the Mongolian decimal numeral system. ## -property-value The string "Mong", which identifies the Mongolian decimal numeral system. This system has the digits ᠐᠑᠒᠓᠔᠕᠖᠗᠘᠙ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mong +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Mong + +## -description +Gets the identifier for the Mongolian decimal numeral system. + +## -property-value +The string "Mong", which identifies the Mongolian decimal numeral system. This system has the digits ᠐᠑᠒᠓᠔᠕᠖᠗᠘᠙ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_mtei.md b/windows.globalization/numeralsystemidentifiers_mtei.md index e2c81ad2b2..51bc918eed 100644 --- a/windows.globalization/numeralsystemidentifiers_mtei.md +++ b/windows.globalization/numeralsystemidentifiers_mtei.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mtei --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Mtei ## -description Gets the identifier for the Meetei Mayek decimal numeral system. ## -property-value The string "Mtei", which identifies the Meetei Mayek decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+ABF00
U+ABF11
U+ABF22
U+ABF33
U+ABF44
U+ABF55
U+ABF66
U+ABF77
U+ABF88
U+ABF99
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mtei +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Mtei + +## -description +Gets the identifier for the Meetei Mayek decimal numeral system. + +## -property-value +The string "Mtei", which identifies the Meetei Mayek decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+ABF00
U+ABF11
U+ABF22
U+ABF33
U+ABF44
U+ABF55
U+ABF66
U+ABF77
U+ABF88
U+ABF99
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_mymr.md b/windows.globalization/numeralsystemidentifiers_mymr.md index f0e0f2cfbe..43a2256110 100644 --- a/windows.globalization/numeralsystemidentifiers_mymr.md +++ b/windows.globalization/numeralsystemidentifiers_mymr.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mymr --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Mymr ## -description Gets the identifier for the Myanmar decimal numeral system. ## -property-value The string "Mymr", which identifies the Myanmar decimal numeral system. This system has the digits ၀၁၂၃၄၅၆၇၈၉ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Mymr +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Mymr + +## -description +Gets the identifier for the Myanmar decimal numeral system. + +## -property-value +The string "Mymr", which identifies the Myanmar decimal numeral system. This system has the digits ၀၁၂၃၄၅၆၇၈၉ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_mymrshan.md b/windows.globalization/numeralsystemidentifiers_mymrshan.md index c28be0d232..d47a4a690e 100644 --- a/windows.globalization/numeralsystemidentifiers_mymrshan.md +++ b/windows.globalization/numeralsystemidentifiers_mymrshan.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MymrShan --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.MymrShan ## -description Gets the identifier for the Myanmar Shan decimal numeral system. ## -property-value The string "MymrShan", which identifies the Myanmar Shan decimal numeral system. This system has the digits ႐႑႒႓႔႕႖႗႘႙ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.MymrShan +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.MymrShan + +## -description +Gets the identifier for the Myanmar Shan decimal numeral system. + +## -property-value +The string "MymrShan", which identifies the Myanmar Shan decimal numeral system. This system has the digits ႐႑႒႓႔႕႖႗႘႙ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_nkoo.md b/windows.globalization/numeralsystemidentifiers_nkoo.md index 1da81240aa..7328ffbb22 100644 --- a/windows.globalization/numeralsystemidentifiers_nkoo.md +++ b/windows.globalization/numeralsystemidentifiers_nkoo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Nkoo --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Nkoo ## -description Gets the identifier for the Nko decimal numeral system. ## -property-value The string "Nkoo", which identifies the Nko decimal numeral system. This system has the digits ߀߁߂߃߄߅߆߇߈߉ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Nkoo +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Nkoo + +## -description +Gets the identifier for the Nko decimal numeral system. + +## -property-value +The string "Nkoo", which identifies the Nko decimal numeral system. This system has the digits ߀߁߂߃߄߅߆߇߈߉ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_olck.md b/windows.globalization/numeralsystemidentifiers_olck.md index aa10c62724..2f5bbef9c6 100644 --- a/windows.globalization/numeralsystemidentifiers_olck.md +++ b/windows.globalization/numeralsystemidentifiers_olck.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Olck --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Olck ## -description Gets the identifier for the Ol Chiki decimal numeral system. ## -property-value The string "Olck", which identifies the Ol Chiki decimal numeral system. This system has the digits ᱐᱑᱒᱓᱔᱕᱖᱗᱘᱙ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Olck +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Olck + +## -description +Gets the identifier for the Ol Chiki decimal numeral system. + +## -property-value +The string "Olck", which identifies the Ol Chiki decimal numeral system. This system has the digits ᱐᱑᱒᱓᱔᱕᱖᱗᱘᱙ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_orya.md b/windows.globalization/numeralsystemidentifiers_orya.md index dcef70d83f..9203baca3a 100644 --- a/windows.globalization/numeralsystemidentifiers_orya.md +++ b/windows.globalization/numeralsystemidentifiers_orya.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Orya --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Orya ## -description Gets the identifier for the Odia decimal numeral system. ## -property-value The string "Orya", which identifies the Odia decimal numeral system. This system has the digits ୦୧୨୩୪୫୬୭୮୯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Orya +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Orya + +## -description +Gets the identifier for the Odia decimal numeral system. + +## -property-value +The string "Orya", which identifies the Odia decimal numeral system. This system has the digits ୦୧୨୩୪୫୬୭୮୯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_osma.md b/windows.globalization/numeralsystemidentifiers_osma.md index c30e56fa14..dbc63a6e02 100644 --- a/windows.globalization/numeralsystemidentifiers_osma.md +++ b/windows.globalization/numeralsystemidentifiers_osma.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Osma --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Osma ## -description Gets the identifier for the Osmanya decimal numeral system. ## -property-value The string "Osma", which identifies the Osmanya decimal numeral system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Osma +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Osma + +## -description +Gets the identifier for the Osmanya decimal numeral system. + +## -property-value +The string "Osma", which identifies the Osmanya decimal numeral system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_saur.md b/windows.globalization/numeralsystemidentifiers_saur.md index 299390f6be..fb70c8eda9 100644 --- a/windows.globalization/numeralsystemidentifiers_saur.md +++ b/windows.globalization/numeralsystemidentifiers_saur.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Saur --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Saur ## -description Gets the identifier for the Saurashtra decimal numeral system. ## -property-value The string "Saur", which identifies the Saurashtra decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+A8D00
U+A8D11
U+A8D22
U+A8D33
U+A8D44
U+A8D55
U+A8D66
U+A8D77
U+A8D88
U+A8D99
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Saur +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Saur + +## -description +Gets the identifier for the Saurashtra decimal numeral system. + +## -property-value +The string "Saur", which identifies the Saurashtra decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+A8D00
U+A8D11
U+A8D22
U+A8D33
U+A8D44
U+A8D55
U+A8D66
U+A8D77
U+A8D88
U+A8D99
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_sund.md b/windows.globalization/numeralsystemidentifiers_sund.md index 84479c0976..47e250184b 100644 --- a/windows.globalization/numeralsystemidentifiers_sund.md +++ b/windows.globalization/numeralsystemidentifiers_sund.md @@ -1,3 +1,37 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Sund --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Sund ## -description Gets the identifier for the Sundanese decimal numeral system. ## -property-value The string "Sund", which identifies the Sundanese decimal numeral system. This system uses the following Unicode values:
Unicode code pointCorresponding Latin digit
U+1BB00
U+1BB11
U+1BB22
U+1BB33
U+1BB44
U+1BB55
U+1BB66
U+1BB77
U+1BB88
U+1BB99
## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Sund +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Sund + +## -description +Gets the identifier for the Sundanese decimal numeral system. + +## -property-value +The string "Sund", which identifies the Sundanese decimal numeral system. This system uses the following Unicode values: + + + + + + + + + + + + + +
Unicode code pointCorresponding Latin digit
U+1BB00
U+1BB11
U+1BB22
U+1BB33
U+1BB44
U+1BB55
U+1BB66
U+1BB77
U+1BB88
U+1BB99
+ +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_talu.md b/windows.globalization/numeralsystemidentifiers_talu.md index 3811a16148..315fd79759 100644 --- a/windows.globalization/numeralsystemidentifiers_talu.md +++ b/windows.globalization/numeralsystemidentifiers_talu.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Talu --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Talu ## -description Gets the identifier for the New Tai Lue decimal numeral system. ## -property-value The string "Talu", which identifies the New Tai Lue decimal numeral system. This system has the digits ᧐᧑᧒᧓᧔᧕᧖᧗᧘᧙ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Talu +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Talu + +## -description +Gets the identifier for the New Tai Lue decimal numeral system. + +## -property-value +The string "Talu", which identifies the New Tai Lue decimal numeral system. This system has the digits ᧐᧑᧒᧓᧔᧕᧖᧗᧘᧙ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_tamldec.md b/windows.globalization/numeralsystemidentifiers_tamldec.md index 599b66bd81..4369472659 100644 --- a/windows.globalization/numeralsystemidentifiers_tamldec.md +++ b/windows.globalization/numeralsystemidentifiers_tamldec.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.TamlDec --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.TamlDec ## -description Gets the identifier for the Tamil decimal numeral system. ## -property-value The string "TamlDec", which identifies the Tamil decimal numeral system. This system has the digits ௦௧௨௩௪௫௬௭௮௯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.TamlDec +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.TamlDec + +## -description +Gets the identifier for the Tamil decimal numeral system. + +## -property-value +The string "TamlDec", which identifies the Tamil decimal numeral system. This system has the digits ௦௧௨௩௪௫௬௭௮௯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_telu.md b/windows.globalization/numeralsystemidentifiers_telu.md index ea19c2ee39..1293a75001 100644 --- a/windows.globalization/numeralsystemidentifiers_telu.md +++ b/windows.globalization/numeralsystemidentifiers_telu.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Telu --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Telu ## -description Gets the identifier for the Telugu decimal numeral system. ## -property-value The string "Telu", which identifies the Telugu decimal numeral system. This system has the digits ౦౧౨౩౪౫౬౭౮౯ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Telu +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Telu + +## -description +Gets the identifier for the Telugu decimal numeral system. + +## -property-value +The string "Telu", which identifies the Telugu decimal numeral system. This system has the digits ౦౧౨౩౪౫౬౭౮౯ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_thai.md b/windows.globalization/numeralsystemidentifiers_thai.md index a9f4ff094b..b125442503 100644 --- a/windows.globalization/numeralsystemidentifiers_thai.md +++ b/windows.globalization/numeralsystemidentifiers_thai.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Thai --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Thai ## -description Gets the identifier for the Thai decimal numeral system. ## -property-value The string "Thai", which identifies the Thai decimal numeral system. This system has the digits ๐๑๒๓๔๕๖๗๘๙ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Thai +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Thai + +## -description +Gets the identifier for the Thai decimal numeral system. + +## -property-value +The string "Thai", which identifies the Thai decimal numeral system. This system has the digits ๐๑๒๓๔๕๖๗๘๙ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_tibt.md b/windows.globalization/numeralsystemidentifiers_tibt.md index e754083ade..f5b6c4db6d 100644 --- a/windows.globalization/numeralsystemidentifiers_tibt.md +++ b/windows.globalization/numeralsystemidentifiers_tibt.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Tibt --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Tibt ## -description Gets the identifier for the Tibetan decimal numeral system. ## -property-value The string "Tibt", which identifies the Tibetan decimal numeral system. This system has the digits ༠༡༢༣༤༥༦༧༨༩ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Tibt +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Tibt + +## -description +Gets the identifier for the Tibetan decimal numeral system. + +## -property-value +The string "Tibt", which identifies the Tibetan decimal numeral system. This system has the digits ༠༡༢༣༤༥༦༧༨༩ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_vaii.md b/windows.globalization/numeralsystemidentifiers_vaii.md index ad24165f4b..552edc69ea 100644 --- a/windows.globalization/numeralsystemidentifiers_vaii.md +++ b/windows.globalization/numeralsystemidentifiers_vaii.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Vaii --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.Vaii ## -description Gets the identifier for the Vai decimal numeral system. ## -property-value The string "Vaii", which identifies the Vai decimal numeral system. This system has the digits ꘠꘡꘢꘣꘤꘥꘦꘧꘨꘩ which correspond to the Latin digits 0-9. ## -remarks ## -examples ## -see-also [NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.Vaii +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.Vaii + +## -description +Gets the identifier for the Vai decimal numeral system. + +## -property-value +The string "Vaii", which identifies the Vai decimal numeral system. This system has the digits ꘠꘡꘢꘣꘤꘥꘦꘧꘨꘩ which correspond to the Latin digits 0-9. + +## -remarks + +## -examples + +## -see-also +[NumeralSystem values](http://msdn.microsoft.com/library/69ef3b67-7c16-4d44-9e6a-2c5fde0fdc8f) \ No newline at end of file diff --git a/windows.globalization/numeralsystemidentifiers_zmthbold.md b/windows.globalization/numeralsystemidentifiers_zmthbold.md index a07248c798..3a56e04b55 100644 --- a/windows.globalization/numeralsystemidentifiers_zmthbold.md +++ b/windows.globalization/numeralsystemidentifiers_zmthbold.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthBold --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.ZmthBold ## -description Gets the identifier for the decimal numeral system using ZmthBold (Mathematical notation) characters. ## -property-value The string "ZmthBold", which identifies the decimal numeral system using ZmthBold (Mathematical notation) characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthBold +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.ZmthBold + +## -description +Gets the identifier for the decimal numeral system using ZmthBold (Mathematical notation) characters. + +## -property-value +The string "ZmthBold", which identifies the decimal numeral system using ZmthBold (Mathematical notation) characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_zmthdbl.md b/windows.globalization/numeralsystemidentifiers_zmthdbl.md index 8be6e5726a..6a788af4fc 100644 --- a/windows.globalization/numeralsystemidentifiers_zmthdbl.md +++ b/windows.globalization/numeralsystemidentifiers_zmthdbl.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthDbl --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.ZmthDbl ## -description Gets the identifier for the decimal numeral system using ZmthDbl (Mathematical notation) characters. ## -property-value The string "ZmthDbl", which identifies the decimal numeral system using ZmthDbl (Mathematical notation) characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthDbl +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.ZmthDbl + +## -description +Gets the identifier for the decimal numeral system using ZmthDbl (Mathematical notation) characters. + +## -property-value +The string "ZmthDbl", which identifies the decimal numeral system using ZmthDbl (Mathematical notation) characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_zmthmono.md b/windows.globalization/numeralsystemidentifiers_zmthmono.md index 3896712bbb..823ca00180 100644 --- a/windows.globalization/numeralsystemidentifiers_zmthmono.md +++ b/windows.globalization/numeralsystemidentifiers_zmthmono.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthMono --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.ZmthMono ## -description Gets the identifier for the decimal numeral system using ZmthMono (Mathematical notation) characters. ## -property-value The string "ZmthMono", which identifies the decimal numeral system using ZmthMono (Mathematical notation) characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthMono +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.ZmthMono + +## -description +Gets the identifier for the decimal numeral system using ZmthMono (Mathematical notation) characters. + +## -property-value +The string "ZmthMono", which identifies the decimal numeral system using ZmthMono (Mathematical notation) characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_zmthsanb.md b/windows.globalization/numeralsystemidentifiers_zmthsanb.md index 1e11669b0a..f9db58055e 100644 --- a/windows.globalization/numeralsystemidentifiers_zmthsanb.md +++ b/windows.globalization/numeralsystemidentifiers_zmthsanb.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthSanb --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.ZmthSanb ## -description Gets the identifier for the decimal numeral system using ZmthSanb (Mathematical notation) characters. ## -property-value The string "ZmthSanb", which identifies the decimal numeral system using ZmthSanb (Mathematical notation) characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthSanb +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.ZmthSanb + +## -description +Gets the identifier for the decimal numeral system using ZmthSanb (Mathematical notation) characters. + +## -property-value +The string "ZmthSanb", which identifies the decimal numeral system using ZmthSanb (Mathematical notation) characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.globalization/numeralsystemidentifiers_zmthsans.md b/windows.globalization/numeralsystemidentifiers_zmthsans.md index b8f98a2f59..978fa3762f 100644 --- a/windows.globalization/numeralsystemidentifiers_zmthsans.md +++ b/windows.globalization/numeralsystemidentifiers_zmthsans.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthSans --api-type: winrt property ---- # Windows.Globalization.NumeralSystemIdentifiers.ZmthSans ## -description Gets the identifier for the decimal numeral system using ZmthSans (Mathematical notation) characters. ## -property-value The string "ZmthSans", which identifies the decimal numeral system using ZmthSans (Mathematical notation) characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Globalization.NumeralSystemIdentifiers.ZmthSans +-api-type: winrt property +--- + + + +# Windows.Globalization.NumeralSystemIdentifiers.ZmthSans + +## -description +Gets the identifier for the decimal numeral system using ZmthSans (Mathematical notation) characters. + +## -property-value +The string "ZmthSans", which identifies the decimal numeral system using ZmthSans (Mathematical notation) characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.directx.direct3d11/idirect3ddevice.md b/windows.graphics.directx.direct3d11/idirect3ddevice.md index ca60fbc0e8..dc0edd8c91 100644 --- a/windows.graphics.directx.direct3d11/idirect3ddevice.md +++ b/windows.graphics.directx.direct3d11/idirect3ddevice.md @@ -1,3 +1,49 @@ ---- -api-id: T:Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice --api-type: winrt interface ---- # Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice ## -description This represents an [IDXGIDevice](http://msdn.microsoft.com/library/83b24b82-9044-4c99-8d50-63f1e8aef8db) and can be used to interop between Windows Runtime components that need to exchange [IDXGIDevice](http://msdn.microsoft.com/library/83b24b82-9044-4c99-8d50-63f1e8aef8db) references. ## -remarks To move back and forth between [IDirect3DDevice](direct3ddevice.md) and [IDXGIDevice](http://msdn.microsoft.com/library/83b24b82-9044-4c99-8d50-63f1e8aef8db), use the [CreateDirect3DDevice](createdirect3ddevice.md) and [GetDXGIInterface(IDirect3DDevice^, DXGIType**)](getdxgiinterface.md) functions. ## -examples First include the necessary headers and namespaces: ```cpp #include #include using namespace Windows::Graphics::DirectX::Direct3D11; using namespace Microsoft::WRL; ``` To get the native DirectX device that is wrapped by a Direct3DDevice: ```cpp IDirect3DDevice^ d3dDevice = ...; ComPtr nativeDevice; HRESULT hr = GetDXGIInterface(d3dDevice, nativeDevice.GetAddressOf()); ``` To create a new Direct3DDevice object wrapping a native DirectX device: ```cpp ComPtr nativeDevice = ...; IDirect3DDevice^ winRTDevice = CreateDirect3DDevice(nativeDevice.Get()); ``` ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice +-api-type: winrt interface +--- + + + +# Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice + +## -description +This represents an [IDXGIDevice](http://msdn.microsoft.com/library/83b24b82-9044-4c99-8d50-63f1e8aef8db) and can be used to interop between Windows Runtime components that need to exchange [IDXGIDevice](http://msdn.microsoft.com/library/83b24b82-9044-4c99-8d50-63f1e8aef8db) references. + +## -remarks +To move back and forth between [IDirect3DDevice](direct3ddevice.md) and [IDXGIDevice](http://msdn.microsoft.com/library/83b24b82-9044-4c99-8d50-63f1e8aef8db), use the [CreateDirect3DDevice](createdirect3ddevice.md) and [GetDXGIInterface(IDirect3DDevice^, DXGIType**)](getdxgiinterface.md) functions. + +## -examples +First include the necessary headers and namespaces: + +```cpp +#include +#include + +using namespace Windows::Graphics::DirectX::Direct3D11; +using namespace Microsoft::WRL; +``` + +To get the native DirectX device that is wrapped by a Direct3DDevice: + +```cpp +IDirect3DDevice^ d3dDevice = ...; +ComPtr nativeDevice; + +HRESULT hr = GetDXGIInterface(d3dDevice, nativeDevice.GetAddressOf()); +``` + +To create a new Direct3DDevice object wrapping a native DirectX device: + +```cpp +ComPtr nativeDevice = ...; +IDirect3DDevice^ winRTDevice = CreateDirect3DDevice(nativeDevice.Get()); + +``` + + + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.graphics.directx.direct3d11/idirect3dsurface.md b/windows.graphics.directx.direct3d11/idirect3dsurface.md index 2d942f0104..191a9dee01 100644 --- a/windows.graphics.directx.direct3d11/idirect3dsurface.md +++ b/windows.graphics.directx.direct3d11/idirect3dsurface.md @@ -1,3 +1,47 @@ ---- -api-id: T:Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface --api-type: winrt interface ---- # Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface ## -description This represents an [IDXGISurface](http://msdn.microsoft.com/library/9210b966-9e9a-4cd1-ba70-6f1a9fda9d80) and can be used to interop between Windows Runtime components that need to exchange [IDXGISurface](http://msdn.microsoft.com/library/9210b966-9e9a-4cd1-ba70-6f1a9fda9d80) references. ## -remarks To move back and forth between [IDirect3DSurface](idirect3dsurface.md) and [IDXGISurface](http://msdn.microsoft.com/library/9210b966-9e9a-4cd1-ba70-6f1a9fda9d80), use the [CreateDirect3DSurface](createdirect3dsurface.md) and [GetDXGIInterface(IDirect3DSurface^, DXGIType**)](getdxgiinterface_2.md) functions. ## -examples First include the necessary headers and namespaces: ```cpp #include #include using namespace Windows::Graphics::DirectX::Direct3D11; using namespace Microsoft::WRL; ``` To get the native DirectX surface that is wrapped by a Direct3DSurface: ```cpp IDirect3DSurface^ d3dSurface = ...; ComPtr nativeSurface; HRESULT hr = GetDXGIInterface(d3dSurface, nativeSurface.GetAddressOf()); ``` To create a new Direct3DSurface object wrapping a native DirectX surface: ```cpp ComPtr nativeSurface = ...; IDirect3DSurface^ d3dSurface = CreateDirect3DSurface(nativeSurface.Get()); ``` ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface +-api-type: winrt interface +--- + + + +# Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface + +## -description +This represents an [IDXGISurface](http://msdn.microsoft.com/library/9210b966-9e9a-4cd1-ba70-6f1a9fda9d80) and can be used to interop between Windows Runtime components that need to exchange [IDXGISurface](http://msdn.microsoft.com/library/9210b966-9e9a-4cd1-ba70-6f1a9fda9d80) references. + +## -remarks +To move back and forth between [IDirect3DSurface](idirect3dsurface.md) and [IDXGISurface](http://msdn.microsoft.com/library/9210b966-9e9a-4cd1-ba70-6f1a9fda9d80), use the [CreateDirect3DSurface](createdirect3dsurface.md) and [GetDXGIInterface(IDirect3DSurface^, DXGIType**)](getdxgiinterface_2.md) functions. + +## -examples +First include the necessary headers and namespaces: + +```cpp +#include +#include +using namespace Windows::Graphics::DirectX::Direct3D11; +using namespace Microsoft::WRL; +``` + +To get the native DirectX surface that is wrapped by a Direct3DSurface: + +```cpp +IDirect3DSurface^ d3dSurface = ...; +ComPtr nativeSurface; +HRESULT hr = GetDXGIInterface(d3dSurface, nativeSurface.GetAddressOf()); +``` + +To create a new Direct3DSurface object wrapping a native DirectX surface: + +```cpp +ComPtr nativeSurface = ...; +IDirect3DSurface^ d3dSurface = CreateDirect3DSurface(nativeSurface.Get()); + +``` + + + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.graphics.directx.direct3d11/idirect3dsurface_description.md b/windows.graphics.directx.direct3d11/idirect3dsurface_description.md index 4389e7baec..d10f2be7b2 100644 --- a/windows.graphics.directx.direct3d11/idirect3dsurface_description.md +++ b/windows.graphics.directx.direct3d11/idirect3dsurface_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface.Description --api-type: winrt property ---- # Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface.Description ## -description Gets a [Direct3DSurfaceDescription](direct3dsurfacedescription.md) describing the surface. ## -property-value A [Direct3DSurfaceDescription](direct3dsurfacedescription.md) describing the surface. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface.Description +-api-type: winrt property +--- + + + +# Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface.Description + +## -description +Gets a [Direct3DSurfaceDescription](direct3dsurfacedescription.md) describing the surface. + +## -property-value +A [Direct3DSurfaceDescription](direct3dsurfacedescription.md) describing the surface. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation.md b/windows.graphics.display/displayinformation.md index b878a5e4a5..3f731b796d 100644 --- a/windows.graphics.display/displayinformation.md +++ b/windows.graphics.display/displayinformation.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Graphics.Display.DisplayInformation --api-type: winrt class ---- # Windows.Graphics.Display.DisplayInformation ## -description Monitors and controls physical display information. The class provides events to allow clients to monitor for changes in the display. ## -remarks To handle [DisplayInformation](displayinformation.md) events, use an event handler for the specific event. For example, for [DisplayInformation.DpiChanged](displayinformation_dpichanged.md), use "TypedEventHandler<DisplayInformation, Object> DpiChanged." Any property change event of [DisplayInformation](displayinformation.md) might trigger if your app is moved from one monitor to another monitor. [ColorProfileChanged](displayinformation_colorprofilechanged.md) is triggered when the display’s color profile changes. [DpiChanged](displayinformation_dpichanged.md) is triggered when either the [LogicalDpi](displayinformation_logicaldpi.md) or [ResolutionScale](displayinformation_resolutionscale.md) property changes because a user selected a different zoom level or changed the screen resolution. [OrientationChanged](displayinformation_orientationchanged.md) is triggered if a user changes the screen orientation. ## -examples ## -see-also [Display orientation sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624042), [Scaling according to DPI sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620537), [Camera preview frame sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620516), [Basic camera app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619479), [Video stabilization sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620519), [Camera face detection sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619486), [Manual camera controls sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=627611), [High dynamic range sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620517) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Display.DisplayInformation +-api-type: winrt class +--- + + + +# Windows.Graphics.Display.DisplayInformation + +## -description +Monitors and controls physical display information. The class provides events to allow clients to monitor for changes in the display. + +## -remarks +To handle [DisplayInformation](displayinformation.md) events, use an event handler for the specific event. For example, for [DisplayInformation.DpiChanged](displayinformation_dpichanged.md), use "TypedEventHandler<DisplayInformation, Object> DpiChanged." + +Any property change event of [DisplayInformation](displayinformation.md) might trigger if your app is moved from one monitor to another monitor. [ColorProfileChanged](displayinformation_colorprofilechanged.md) is triggered when the display’s color profile changes. [DpiChanged](displayinformation_dpichanged.md) is triggered when either the [LogicalDpi](displayinformation_logicaldpi.md) or [ResolutionScale](displayinformation_resolutionscale.md) property changes because a user selected a different zoom level or changed the screen resolution. [OrientationChanged](displayinformation_orientationchanged.md) is triggered if a user changes the screen orientation. + +## -examples + +## -see-also +[Display orientation sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624042), [Scaling according to DPI sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620537), [Camera preview frame sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620516), [Basic camera app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619479), [Video stabilization sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620519), [Camera face detection sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619486), [Manual camera controls sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=627611), [High dynamic range sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620517) \ No newline at end of file diff --git a/windows.graphics.display/displayinformation_autorotationpreferences.md b/windows.graphics.display/displayinformation_autorotationpreferences.md index 2bb2b77f62..1126c7f57f 100644 --- a/windows.graphics.display/displayinformation_autorotationpreferences.md +++ b/windows.graphics.display/displayinformation_autorotationpreferences.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.AutoRotationPreferences --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.AutoRotationPreferences ## -description Gets and sets the preferred orientation of the app. ## -property-value The orientation of a rectangular monitor. ## -remarks This property is static. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.AutoRotationPreferences +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.AutoRotationPreferences + +## -description +Gets and sets the preferred orientation of the app. + +## -property-value +The orientation of a rectangular monitor. + +## -remarks +This property is static. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_colorprofilechanged.md b/windows.graphics.display/displayinformation_colorprofilechanged.md index 3e653b06fa..932cd16bee 100644 --- a/windows.graphics.display/displayinformation_colorprofilechanged.md +++ b/windows.graphics.display/displayinformation_colorprofilechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayInformation.ColorProfileChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayInformation.ColorProfileChanged ## -description Occurs when the physical display's color profile changes. ## -remarks The [ColorProfileChanged](displayinformation_colorprofilechanged.md) event is only triggered when the display’s color profile changes. You must then call the [DisplayInformation::GetColorProfileAsync](displayinformation_getcolorprofileasync.md) method to asynchronously retrieve the new color profile. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayInformation.ColorProfileChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayInformation.ColorProfileChanged + +## -description +Occurs when the physical display's color profile changes. + +## -remarks +The [ColorProfileChanged](displayinformation_colorprofilechanged.md) event is only triggered when the display’s color profile changes. You must then call the [DisplayInformation::GetColorProfileAsync](displayinformation_getcolorprofileasync.md) method to asynchronously retrieve the new color profile. + + + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_currentorientation.md b/windows.graphics.display/displayinformation_currentorientation.md index 64fefbeaad..d7a3494386 100644 --- a/windows.graphics.display/displayinformation_currentorientation.md +++ b/windows.graphics.display/displayinformation_currentorientation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.CurrentOrientation --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.CurrentOrientation ## -description Gets the current orientation of a rectangular monitor. ## -property-value The current orientation of a rectangular monitor. ## -remarks The value of the [DisplayInformation::CurrentOrientation](displayinformation_currentorientation.md) property corresponds to the orientation of the display or monitor and not necessarily to the orientation of your app. To determine the orientation of your app for layout purposes, use the [ApplicationView.Value](../windows.ui.viewmanagement/applicationview_value.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.CurrentOrientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.CurrentOrientation + +## -description +Gets the current orientation of a rectangular monitor. + +## -property-value +The current orientation of a rectangular monitor. + +## -remarks +The value of the [DisplayInformation::CurrentOrientation](displayinformation_currentorientation.md) property corresponds to the orientation of the display or monitor and not necessarily to the orientation of your app. To determine the orientation of your app for layout purposes, use the [ApplicationView.Value](../windows.ui.viewmanagement/applicationview_value.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_diagonalsizeininches.md b/windows.graphics.display/displayinformation_diagonalsizeininches.md index 497d456b3c..dae61b2967 100644 --- a/windows.graphics.display/displayinformation_diagonalsizeininches.md +++ b/windows.graphics.display/displayinformation_diagonalsizeininches.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.DiagonalSizeInInches --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.DiagonalSizeInInches ## -description Diagonal size of the display in inches. ## -property-value Returns the diagonal size of the display in inches. May return null when display size information is not available or undetermined (when connected to a projector, or displays are duplicated). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.DiagonalSizeInInches +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.DiagonalSizeInInches + +## -description +Diagonal size of the display in inches. + +## -property-value +Returns the diagonal size of the display in inches. May return null when display size information is not available or undetermined (when connected to a projector, or displays are duplicated). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_displaycontentsinvalidated.md b/windows.graphics.display/displayinformation_displaycontentsinvalidated.md index 13376670b6..843780e3b0 100644 --- a/windows.graphics.display/displayinformation_displaycontentsinvalidated.md +++ b/windows.graphics.display/displayinformation_displaycontentsinvalidated.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayInformation.DisplayContentsInvalidated --api-type: winrt event ---- # Windows.Graphics.Display.DisplayInformation.DisplayContentsInvalidated ## -description Occurs when the display requires redrawing. ## -remarks This event is static. Because this event is static, we recommend that you directly access it from the [DisplayInformation](displayinformation.md) object and not from the current physical display info that you get from a call to the [DisplayInformation.GetForCurrentView](displayinformation_getforcurrentview.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayInformation.DisplayContentsInvalidated +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayInformation.DisplayContentsInvalidated + +## -description +Occurs when the display requires redrawing. + +## -remarks +This event is static. + +Because this event is static, we recommend that you directly access it from the [DisplayInformation](displayinformation.md) object and not from the current physical display info that you get from a call to the [DisplayInformation.GetForCurrentView](displayinformation_getforcurrentview.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_dpichanged.md b/windows.graphics.display/displayinformation_dpichanged.md index 09d7279ee8..33b50fd74e 100644 --- a/windows.graphics.display/displayinformation_dpichanged.md +++ b/windows.graphics.display/displayinformation_dpichanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayInformation.DpiChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayInformation.DpiChanged ## -description Occurs when the [LogicalDpi](displayinformation_logicaldpi.md) property changes because the pixels per inch (PPI) of the display changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayInformation.DpiChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayInformation.DpiChanged + +## -description +Occurs when the [LogicalDpi](displayinformation_logicaldpi.md) property changes because the pixels per inch (PPI) of the display changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_getcolorprofileasync_1815252224.md b/windows.graphics.display/displayinformation_getcolorprofileasync_1815252224.md index e968f27151..7e15944a23 100644 --- a/windows.graphics.display/displayinformation_getcolorprofileasync_1815252224.md +++ b/windows.graphics.display/displayinformation_getcolorprofileasync_1815252224.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Graphics.Display.DisplayInformation.GetColorProfileAsync --api-type: winrt method ---- # Windows.Graphics.Display.DisplayInformation.GetColorProfileAsync ## -description Asynchronously gets the default International Color Consortium (ICC) color profile that is associated with the physical display. ## -returns Object that manages the asynchronous retrieval of the color profile. ## -remarks The asynchronous operation fails if no physical display is attached to the computer on which the app is running (for example, if the app is running over Remote Desktop Connection), if no color profile is associated with the display, or if the profile doesn't match the signature of an ICC color profile. Additionally, not all device families support returning the display's color profile; currently only the Desktop device family implements this API. Applications should catch any exceptions thrown by this API. In these cases, there is no valid ICC color profile associated with the display, and the app should handle this by assuming a default color space such as sRGB. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Display.DisplayInformation.GetColorProfileAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.DisplayInformation.GetColorProfileAsync + +## -description +Asynchronously gets the default International Color Consortium (ICC) color profile that is associated with the physical display. + +## -returns +Object that manages the asynchronous retrieval of the color profile. + +## -remarks +The asynchronous operation fails if no physical display is attached to the computer on which the app is running (for example, if the app is running over Remote Desktop Connection), if no color profile is associated with the display, or if the profile doesn't match the signature of an ICC color profile. Additionally, not all device families support returning the display's color profile; currently only the Desktop device family implements this API. + +Applications should catch any exceptions thrown by this API. In these cases, there is no valid ICC color profile associated with the display, and the app should handle this by assuming a default color space such as sRGB. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_getforcurrentview_1363600702.md b/windows.graphics.display/displayinformation_getforcurrentview_1363600702.md index 3c23085a17..afcfa9da54 100644 --- a/windows.graphics.display/displayinformation_getforcurrentview_1363600702.md +++ b/windows.graphics.display/displayinformation_getforcurrentview_1363600702.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Display.DisplayInformation.GetForCurrentView --api-type: winrt method ---- # Windows.Graphics.Display.DisplayInformation.GetForCurrentView ## -description Gets the current physical display information. ## -returns A [DisplayInformation](displayinformation.md) object that contains the current physical display information. ## -remarks This method is static. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Display.DisplayInformation.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.DisplayInformation.GetForCurrentView + +## -description +Gets the current physical display information. + +## -returns +A [DisplayInformation](displayinformation.md) object that contains the current physical display information. + +## -remarks +This method is static. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_logicaldpi.md b/windows.graphics.display/displayinformation_logicaldpi.md index 8b98929c75..56a6edd72b 100644 --- a/windows.graphics.display/displayinformation_logicaldpi.md +++ b/windows.graphics.display/displayinformation_logicaldpi.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.LogicalDpi --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.LogicalDpi ## -description Gets the pixels per logical inch of the current environment. ## -property-value The pixels per logical inch of the current environment. ## -remarks The logical dots per inch (DPI) can change based on scaling. For info about the meaning of logical DPI, see [DPI and Device-Independent Pixels](XREF:TODO:learnwin32.dpi_and_device-independent_pixels). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.LogicalDpi +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.LogicalDpi + +## -description +Gets the pixels per logical inch of the current environment. + +## -property-value +The pixels per logical inch of the current environment. + +## -remarks +The logical dots per inch (DPI) can change based on scaling. For info about the meaning of logical DPI, see [DPI and Device-Independent Pixels](XREF:TODO:learnwin32.dpi_and_device-independent_pixels). + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_nativeorientation.md b/windows.graphics.display/displayinformation_nativeorientation.md index 2f84bb7049..b307ceb6a9 100644 --- a/windows.graphics.display/displayinformation_nativeorientation.md +++ b/windows.graphics.display/displayinformation_nativeorientation.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.NativeOrientation --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.NativeOrientation ## -description Gets the native orientation of the display monitor, which is typically the orientation where the buttons on the device match the orientation of the monitor. ## -property-value The native orientation of the display monitor. ## -remarks [NativeOrientation](displayinformation_nativeorientation.md) returns only the **Landscape** or **Portrait** value. [NativeOrientation](displayinformation_nativeorientation.md) never returns the **LandscapeFlipped** or **PortraitFlipped** value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.NativeOrientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.NativeOrientation + +## -description +Gets the native orientation of the display monitor, which is typically the orientation where the buttons on the device match the orientation of the monitor. + +## -property-value +The native orientation of the display monitor. + +## -remarks +[NativeOrientation](displayinformation_nativeorientation.md) returns only the **Landscape** or **Portrait** value. [NativeOrientation](displayinformation_nativeorientation.md) never returns the **LandscapeFlipped** or **PortraitFlipped** value. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_orientationchanged.md b/windows.graphics.display/displayinformation_orientationchanged.md index 5b127c3274..264e35ba5d 100644 --- a/windows.graphics.display/displayinformation_orientationchanged.md +++ b/windows.graphics.display/displayinformation_orientationchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayInformation.OrientationChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayInformation.OrientationChanged ## -description Occurs when either the [CurrentOrientation](displayinformation_currentorientation.md) or [NativeOrientation](displayinformation_nativeorientation.md) property changes because of a mode change or a monitor change. ## -remarks The [OrientationChanged](displayinformation_orientationchanged.md) event occurs only when orientation of the display or monitor changes and not necessarily when the orientation of your app changes. To determine the orientation of your app for layout purposes, use the [ApplicationView.Value](../windows.ui.viewmanagement/applicationview_value.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayInformation.OrientationChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayInformation.OrientationChanged + +## -description +Occurs when either the [CurrentOrientation](displayinformation_currentorientation.md) or [NativeOrientation](displayinformation_nativeorientation.md) property changes because of a mode change or a monitor change. + +## -remarks +The [OrientationChanged](displayinformation_orientationchanged.md) event occurs only when orientation of the display or monitor changes and not necessarily when the orientation of your app changes. To determine the orientation of your app for layout purposes, use the [ApplicationView.Value](../windows.ui.viewmanagement/applicationview_value.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_rawdpix.md b/windows.graphics.display/displayinformation_rawdpix.md index c01d677af6..7e960cc5e7 100644 --- a/windows.graphics.display/displayinformation_rawdpix.md +++ b/windows.graphics.display/displayinformation_rawdpix.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.RawDpiX --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.RawDpiX ## -description Gets the raw dots per inch (DPI) along the x axis of the display monitor. ## -property-value The raw dots per inch (DPI) along the x axis of the display monitor. ## -remarks This property can return 0 when the monitor doesn't provide physical dimensions and when the user is in a clone or duplicate multiple-monitor setup. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.RawDpiX +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.RawDpiX + +## -description +Gets the raw dots per inch (DPI) along the x axis of the display monitor. + +## -property-value +The raw dots per inch (DPI) along the x axis of the display monitor. + +## -remarks +This property can return 0 when the monitor doesn't provide physical dimensions and when the user is in a clone or duplicate multiple-monitor setup. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_rawdpiy.md b/windows.graphics.display/displayinformation_rawdpiy.md index 248cf4b7fa..0b2644411f 100644 --- a/windows.graphics.display/displayinformation_rawdpiy.md +++ b/windows.graphics.display/displayinformation_rawdpiy.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.RawDpiY --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.RawDpiY ## -description Gets the raw dots per inch (DPI) along the y axis of the display monitor. ## -property-value The raw dots per inch (DPI) along the y axis of the display monitor. ## -remarks This property can return 0 when the monitor doesn't provide physical dimensions and when the user is in a clone or duplicate multiple-monitor setup. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.RawDpiY +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.RawDpiY + +## -description +Gets the raw dots per inch (DPI) along the y axis of the display monitor. + +## -property-value +The raw dots per inch (DPI) along the y axis of the display monitor. + +## -remarks +This property can return 0 when the monitor doesn't provide physical dimensions and when the user is in a clone or duplicate multiple-monitor setup. + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_rawpixelsperviewpixel.md b/windows.graphics.display/displayinformation_rawpixelsperviewpixel.md index 8d487ae55a..87a80654b9 100644 --- a/windows.graphics.display/displayinformation_rawpixelsperviewpixel.md +++ b/windows.graphics.display/displayinformation_rawpixelsperviewpixel.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.RawPixelsPerViewPixel --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.RawPixelsPerViewPixel ## -description Gets a value representing the number of raw (physical) pixels for each view (layout) pixel. ## -property-value A value representing the number of raw (physical) pixels for each view (layout) pixel. ## -remarks ## -examples ## -see-also [Scaling according to DPI sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620537) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.RawPixelsPerViewPixel +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.RawPixelsPerViewPixel + +## -description +Gets a value representing the number of raw (physical) pixels for each view (layout) pixel. + +## -property-value +A value representing the number of raw (physical) pixels for each view (layout) pixel. + +## -remarks + +## -examples + +## -see-also +[Scaling according to DPI sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620537) \ No newline at end of file diff --git a/windows.graphics.display/displayinformation_resolutionscale.md b/windows.graphics.display/displayinformation_resolutionscale.md index 2ca817126d..c911b0d6a5 100644 --- a/windows.graphics.display/displayinformation_resolutionscale.md +++ b/windows.graphics.display/displayinformation_resolutionscale.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.ResolutionScale --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.ResolutionScale ## -description Gets the scale factor of the immersive environment. ## -property-value The scale factor of the immersive environment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.ResolutionScale +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.ResolutionScale + +## -description +Gets the scale factor of the immersive environment. + +## -property-value +The scale factor of the immersive environment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_screenheightinrawpixels.md b/windows.graphics.display/displayinformation_screenheightinrawpixels.md index 1a181af7b2..940cc6b263 100644 --- a/windows.graphics.display/displayinformation_screenheightinrawpixels.md +++ b/windows.graphics.display/displayinformation_screenheightinrawpixels.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.ScreenHeightInRawPixels --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.ScreenHeightInRawPixels ## -description Returns the current height resolution of the logical monitor. ## -property-value Returns the current resolution of the logical monitor containing the application’s view. When the application’s view is moved to another logical monitor, this property will reflect the new logical monitor’s resolution. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.ScreenHeightInRawPixels +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.ScreenHeightInRawPixels + +## -description +Returns the current height resolution of the logical monitor. + +## -property-value +Returns the current resolution of the logical monitor containing the application’s view. When the application’s view is moved to another logical monitor, this property will reflect the new logical monitor’s resolution. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_screenwidthinrawpixels.md b/windows.graphics.display/displayinformation_screenwidthinrawpixels.md index 319e3b6cda..d4c396b580 100644 --- a/windows.graphics.display/displayinformation_screenwidthinrawpixels.md +++ b/windows.graphics.display/displayinformation_screenwidthinrawpixels.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.ScreenWidthInRawPixels --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.ScreenWidthInRawPixels ## -description Returns the current width resolution of the logical monitor. ## -property-value Returns the current resolution of the logical monitor containing the application’s view. When the application’s view is moved to another logical monitor, this property will reflect the new logical monitor’s resolution. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.ScreenWidthInRawPixels +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.ScreenWidthInRawPixels + +## -description +Returns the current width resolution of the logical monitor. + +## -property-value +Returns the current resolution of the logical monitor containing the application’s view. When the application’s view is moved to another logical monitor, this property will reflect the new logical monitor’s resolution. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_stereoenabled.md b/windows.graphics.display/displayinformation_stereoenabled.md index 254f822e9b..04eb6755e0 100644 --- a/windows.graphics.display/displayinformation_stereoenabled.md +++ b/windows.graphics.display/displayinformation_stereoenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayInformation.StereoEnabled --api-type: winrt property ---- # Windows.Graphics.Display.DisplayInformation.StereoEnabled ## -description Gets a value that indicates whether the device supports stereoscopic 3D. ## -property-value **TRUE** if the device is capable of stereoscopic 3D and stereoscopic 3D is currently enabled; **FALSE** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayInformation.StereoEnabled +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayInformation.StereoEnabled + +## -description +Gets a value that indicates whether the device supports stereoscopic 3D. + +## -property-value +**TRUE** if the device is capable of stereoscopic 3D and stereoscopic 3D is currently enabled; **FALSE** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayinformation_stereoenabledchanged.md b/windows.graphics.display/displayinformation_stereoenabledchanged.md index 830e9d23b5..329800d2fb 100644 --- a/windows.graphics.display/displayinformation_stereoenabledchanged.md +++ b/windows.graphics.display/displayinformation_stereoenabledchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayInformation.StereoEnabledChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayInformation.StereoEnabledChanged ## -description Occurs when the [StereoEnabled](displayinformation_stereoenabled.md) property changes because support for stereoscopic 3D changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayInformation.StereoEnabledChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayInformation.StereoEnabledChanged + +## -description +Occurs when the [StereoEnabled](displayinformation_stereoenabled.md) property changes because support for stereoscopic 3D changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties.md b/windows.graphics.display/displayproperties.md index b70851bb88..dcc4394d07 100644 --- a/windows.graphics.display/displayproperties.md +++ b/windows.graphics.display/displayproperties.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Display.DisplayProperties --api-type: winrt class ---- # Windows.Graphics.Display.DisplayProperties ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Provides various properties that are related to the physical display. For most of these properties, the class provides events to allow clients to monitor for changes in the properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Display.DisplayProperties +-api-type: winrt class +--- + + + +# Windows.Graphics.Display.DisplayProperties + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Provides various properties that are related to the physical display. For most of these properties, the class provides events to allow clients to monitor for changes in the properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_autorotationpreferences.md b/windows.graphics.display/displayproperties_autorotationpreferences.md index 55541553ab..c6f7e78f02 100644 --- a/windows.graphics.display/displayproperties_autorotationpreferences.md +++ b/windows.graphics.display/displayproperties_autorotationpreferences.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayProperties.AutoRotationPreferences --api-type: winrt property ---- # Windows.Graphics.Display.DisplayProperties.AutoRotationPreferences ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Gets and sets the preferred orientation of the app. ## -property-value The orientation of a rectangular monitor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayProperties.AutoRotationPreferences +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayProperties.AutoRotationPreferences + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Gets and sets the preferred orientation of the app. + +## -property-value +The orientation of a rectangular monitor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_colorprofilechanged.md b/windows.graphics.display/displayproperties_colorprofilechanged.md index 80c90f3f50..451928ccc4 100644 --- a/windows.graphics.display/displayproperties_colorprofilechanged.md +++ b/windows.graphics.display/displayproperties_colorprofilechanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayProperties.ColorProfileChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayProperties.ColorProfileChanged ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Occurs when the physical display's color profile changes. ## -remarks ## -examples ## -see-also [DisplayProperties::GetColorProfileAsync](displayproperties_getcolorprofileasync.md) \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayProperties.ColorProfileChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayProperties.ColorProfileChanged + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Occurs when the physical display's color profile changes. + +## -remarks + +## -examples + +## -see-also +[DisplayProperties::GetColorProfileAsync](displayproperties_getcolorprofileasync.md) \ No newline at end of file diff --git a/windows.graphics.display/displayproperties_currentorientation.md b/windows.graphics.display/displayproperties_currentorientation.md index 3ca71499fe..c50fb97fea 100644 --- a/windows.graphics.display/displayproperties_currentorientation.md +++ b/windows.graphics.display/displayproperties_currentorientation.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayProperties.CurrentOrientation --api-type: winrt property ---- # Windows.Graphics.Display.DisplayProperties.CurrentOrientation ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Gets the current orientation of a rectangular monitor. ## -property-value The current orientation of a rectangular monitor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayProperties.CurrentOrientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayProperties.CurrentOrientation + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Gets the current orientation of a rectangular monitor. + +## -property-value +The current orientation of a rectangular monitor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_displaycontentsinvalidated.md b/windows.graphics.display/displayproperties_displaycontentsinvalidated.md index 7a49ea4623..6d942f99ec 100644 --- a/windows.graphics.display/displayproperties_displaycontentsinvalidated.md +++ b/windows.graphics.display/displayproperties_displaycontentsinvalidated.md @@ -1,3 +1,32 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayProperties.DisplayContentsInvalidated --api-type: winrt event ---- # Windows.Graphics.Display.DisplayProperties.DisplayContentsInvalidated ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Occurs when the display requires redrawing. ## -remarks ## -examples ```cpp DisplayProperties::DisplayContentsInvalidated += ref new DisplayPropertiesEventHandler(this, &ShapesPuzzle::OnDisplayContentsInvalidated); ``` ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayProperties.DisplayContentsInvalidated +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayProperties.DisplayContentsInvalidated + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Occurs when the display requires redrawing. + +## -remarks + +## -examples + + +```cpp + + DisplayProperties::DisplayContentsInvalidated += + ref new DisplayPropertiesEventHandler(this, &ShapesPuzzle::OnDisplayContentsInvalidated); + +``` + + + +## -see-also diff --git a/windows.graphics.display/displayproperties_getcolorprofileasync_1815252224.md b/windows.graphics.display/displayproperties_getcolorprofileasync_1815252224.md index b68b0f9d36..dc86e51969 100644 --- a/windows.graphics.display/displayproperties_getcolorprofileasync_1815252224.md +++ b/windows.graphics.display/displayproperties_getcolorprofileasync_1815252224.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Display.DisplayProperties.GetColorProfileAsync --api-type: winrt method ---- # Windows.Graphics.Display.DisplayProperties.GetColorProfileAsync ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Asynchronously gets the default International Color Consortium (ICC) color profile that is associated with the physical display. ## -returns Object that manages the asynchronous retrieval of the color profile. ## -remarks ## -examples ## -see-also [DisplayProperties::ColorProfileChanged](displayproperties_colorprofilechanged.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Display.DisplayProperties.GetColorProfileAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.DisplayProperties.GetColorProfileAsync + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Asynchronously gets the default International Color Consortium (ICC) color profile that is associated with the physical display. + +## -returns +Object that manages the asynchronous retrieval of the color profile. + +## -remarks + +## -examples + +## -see-also +[DisplayProperties::ColorProfileChanged](displayproperties_colorprofilechanged.md) \ No newline at end of file diff --git a/windows.graphics.display/displayproperties_logicaldpi.md b/windows.graphics.display/displayproperties_logicaldpi.md index 06161a3318..ca352be5d5 100644 --- a/windows.graphics.display/displayproperties_logicaldpi.md +++ b/windows.graphics.display/displayproperties_logicaldpi.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayProperties.LogicalDpi --api-type: winrt property ---- # Windows.Graphics.Display.DisplayProperties.LogicalDpi ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Gets the pixels per logical inch of the current environment. ## -property-value The pixels per logical inch of the current environment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayProperties.LogicalDpi +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayProperties.LogicalDpi + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Gets the pixels per logical inch of the current environment. + +## -property-value +The pixels per logical inch of the current environment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_logicaldpichanged.md b/windows.graphics.display/displayproperties_logicaldpichanged.md index 3fc79d347a..4da5285c6f 100644 --- a/windows.graphics.display/displayproperties_logicaldpichanged.md +++ b/windows.graphics.display/displayproperties_logicaldpichanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayProperties.LogicalDpiChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayProperties.LogicalDpiChanged ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Occurs when the [LogicalDpi](displayproperties_logicaldpi.md) property changes because the pixels per inch (PPI) of the display changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayProperties.LogicalDpiChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayProperties.LogicalDpiChanged + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Occurs when the [LogicalDpi](displayproperties_logicaldpi.md) property changes because the pixels per inch (PPI) of the display changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_nativeorientation.md b/windows.graphics.display/displayproperties_nativeorientation.md index d904debe88..e6b57a0462 100644 --- a/windows.graphics.display/displayproperties_nativeorientation.md +++ b/windows.graphics.display/displayproperties_nativeorientation.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayProperties.NativeOrientation --api-type: winrt property ---- # Windows.Graphics.Display.DisplayProperties.NativeOrientation ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Gets the native orientation of the display monitor, which is typically the orientation where the buttons on the device match the orientation of the monitor. ## -property-value The native orientation of the display monitor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayProperties.NativeOrientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayProperties.NativeOrientation + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Gets the native orientation of the display monitor, which is typically the orientation where the buttons on the device match the orientation of the monitor. + +## -property-value +The native orientation of the display monitor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_orientationchanged.md b/windows.graphics.display/displayproperties_orientationchanged.md index 6ca8538539..1a849b0ecd 100644 --- a/windows.graphics.display/displayproperties_orientationchanged.md +++ b/windows.graphics.display/displayproperties_orientationchanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayProperties.OrientationChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayProperties.OrientationChanged ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Occurs when either the [CurrentOrientation](displayproperties_currentorientation.md) or [NativeOrientation](displayproperties_nativeorientation.md) property changes because of a mode change or a monitor change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayProperties.OrientationChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayProperties.OrientationChanged + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Occurs when either the [CurrentOrientation](displayproperties_currentorientation.md) or [NativeOrientation](displayproperties_nativeorientation.md) property changes because of a mode change or a monitor change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_resolutionscale.md b/windows.graphics.display/displayproperties_resolutionscale.md index 3f3fc47bc4..a035011a78 100644 --- a/windows.graphics.display/displayproperties_resolutionscale.md +++ b/windows.graphics.display/displayproperties_resolutionscale.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayProperties.ResolutionScale --api-type: winrt property ---- # Windows.Graphics.Display.DisplayProperties.ResolutionScale ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Gets the scale factor of the immersive environment. ## -property-value The scale factor of the immersive environment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayProperties.ResolutionScale +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayProperties.ResolutionScale + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Gets the scale factor of the immersive environment. + +## -property-value +The scale factor of the immersive environment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_stereoenabled.md b/windows.graphics.display/displayproperties_stereoenabled.md index 84f53c0436..fb47e71ab9 100644 --- a/windows.graphics.display/displayproperties_stereoenabled.md +++ b/windows.graphics.display/displayproperties_stereoenabled.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Display.DisplayProperties.StereoEnabled --api-type: winrt property ---- # Windows.Graphics.Display.DisplayProperties.StereoEnabled ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Gets a value that indicates whether the device supports stereoscopic 3D. ## -property-value **TRUE** if the device is capable of stereoscopic 3D and stereoscopic 3D is currently enabled; **FALSE** otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Display.DisplayProperties.StereoEnabled +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.DisplayProperties.StereoEnabled + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Gets a value that indicates whether the device supports stereoscopic 3D. + +## -property-value +**TRUE** if the device is capable of stereoscopic 3D and stereoscopic 3D is currently enabled; **FALSE** otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.display/displayproperties_stereoenabledchanged.md b/windows.graphics.display/displayproperties_stereoenabledchanged.md index 2d92e766a5..da36e0f36f 100644 --- a/windows.graphics.display/displayproperties_stereoenabledchanged.md +++ b/windows.graphics.display/displayproperties_stereoenabledchanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Graphics.Display.DisplayProperties.StereoEnabledChanged --api-type: winrt event ---- # Windows.Graphics.Display.DisplayProperties.StereoEnabledChanged ## -description > [!NOTE] > [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). Occurs when the [StereoEnabled](displayproperties_stereoenabled.md) property changes because support for stereoscopic 3D changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Display.DisplayProperties.StereoEnabledChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.DisplayProperties.StereoEnabledChanged + +## -description +> [!NOTE] +> [DisplayProperties](displayproperties.md) may be altered or unavailable for releases after Windows 8.1. Instead, use [DisplayInformation](displayinformation.md). + + Occurs when the [StereoEnabled](displayproperties_stereoenabled.md) property changes because support for stereoscopic 3D changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.effects/igraphicseffect_name.md b/windows.graphics.effects/igraphicseffect_name.md index ea7f950609..7ae9a6c988 100644 --- a/windows.graphics.effects/igraphicseffect_name.md +++ b/windows.graphics.effects/igraphicseffect_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Effects.IGraphicsEffect.Name --api-type: winrt property ---- # Windows.Graphics.Effects.IGraphicsEffect.Name ## -description The name of the graphics effect. ## -property-value The name of the graphics effect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Effects.IGraphicsEffect.Name +-api-type: winrt property +--- + + + +# Windows.Graphics.Effects.IGraphicsEffect.Name + +## -description +The name of the graphics effect. + +## -property-value +The name of the graphics effect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera.md b/windows.graphics.holographic/holographiccamera.md index 65ebb3d6ba..240f429ec9 100644 --- a/windows.graphics.holographic/holographiccamera.md +++ b/windows.graphics.holographic/holographiccamera.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicCamera --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicCamera ## -description Represents a display that requires an app to render the holographic space from a particular perspective. An app must render to each HolographicCamera each frame. ## -remarks An app must render to each HolographicCamera each frame. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicCamera +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicCamera + +## -description +Represents a display that requires an app to render the holographic space from a particular perspective. An app must render to each HolographicCamera each frame. + +## -remarks +An app must render to each HolographicCamera each frame. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_id.md b/windows.graphics.holographic/holographiccamera_id.md index 2d4a35a642..2a0670e3e5 100644 --- a/windows.graphics.holographic/holographiccamera_id.md +++ b/windows.graphics.holographic/holographiccamera_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCamera.Id --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCamera.Id ## -description Gets the unique identifier for the HolographicCamera. ## -property-value The unique identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.Id +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.Id + +## -description +Gets the unique identifier for the HolographicCamera. + +## -property-value +The unique identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_isstereo.md b/windows.graphics.holographic/holographiccamera_isstereo.md index 371bf16d4b..bdabc41349 100644 --- a/windows.graphics.holographic/holographiccamera_isstereo.md +++ b/windows.graphics.holographic/holographiccamera_isstereo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCamera.IsStereo --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCamera.IsStereo ## -description Gets whether the current display is stereo rather than mono. ## -property-value True, if the current display is stereo; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.IsStereo +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.IsStereo + +## -description +Gets whether the current display is stereo rather than mono. + +## -property-value +True, if the current display is stereo; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_rendertargetsize.md b/windows.graphics.holographic/holographiccamera_rendertargetsize.md index 2e45841ec8..ca0e1ab7a0 100644 --- a/windows.graphics.holographic/holographiccamera_rendertargetsize.md +++ b/windows.graphics.holographic/holographiccamera_rendertargetsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCamera.RenderTargetSize --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCamera.RenderTargetSize ## -description Gets the dimensions of the render target. ## -property-value The size ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.RenderTargetSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.RenderTargetSize + +## -description +Gets the dimensions of the render target. + +## -property-value +The size + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_setfarplanedistance_666561029.md b/windows.graphics.holographic/holographiccamera_setfarplanedistance_666561029.md index cab60e3960..43db152ea0 100644 --- a/windows.graphics.holographic/holographiccamera_setfarplanedistance_666561029.md +++ b/windows.graphics.holographic/holographiccamera_setfarplanedistance_666561029.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCamera.SetFarPlaneDistance(System.Double) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCamera.SetFarPlaneDistance ## -description Sets the distance, along the z-axis, from the origin of view space to the far plane of the view frustum. ## -parameters ### -param value The far plane distance, in meters. By default, this is set to 20 meters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCamera.SetFarPlaneDistance(System.Double) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.SetFarPlaneDistance + +## -description +Sets the distance, along the z-axis, from the origin of view space to the far plane of the view frustum. + +## -parameters +### -param value +The far plane distance, in meters. By default, this is set to 20 meters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_setnearplanedistance_1406152928.md b/windows.graphics.holographic/holographiccamera_setnearplanedistance_1406152928.md index 20539f7c6a..b635cc73c6 100644 --- a/windows.graphics.holographic/holographiccamera_setnearplanedistance_1406152928.md +++ b/windows.graphics.holographic/holographiccamera_setnearplanedistance_1406152928.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCamera.SetNearPlaneDistance(System.Double) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCamera.SetNearPlaneDistance ## -description Sets the distance, along the z-axis, from the origin of view space to the near plane of the view frustum. ## -parameters ### -param value The near plane distance, in meters. By default, this is set to 0.1 meters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCamera.SetNearPlaneDistance(System.Double) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.SetNearPlaneDistance + +## -description +Sets the distance, along the z-axis, from the origin of view space to the near plane of the view frustum. + +## -parameters +### -param value +The near plane distance, in meters. By default, this is set to 0.1 meters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_viewportscalefactor.md b/windows.graphics.holographic/holographiccamera_viewportscalefactor.md index 1f6b19a98c..430bc12e21 100644 --- a/windows.graphics.holographic/holographiccamera_viewportscalefactor.md +++ b/windows.graphics.holographic/holographiccamera_viewportscalefactor.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor ## -description Gets or sets the scale factor to apply to the default viewport size. Each frame, the system decides the size of the viewport within the render target that the app must render that frame. Sometimes the system may lower this to free up system resources, for example when video capture is occurring. Regardless of the viewport size, the rendered image is always scaled up to the full size of the displays. An app looking to lower its rendering cost for other reasons can request a smaller viewport. You can specify a scale factor between 0.0 and 1.0, which is multiplied by the default viewport size. In future frames, the system will specify that you render to the nearest valid viewport size to this requested size. ## -property-value The viewport scale factor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor + +## -description +Gets or sets the scale factor to apply to the default viewport size. + +Each frame, the system decides the size of the viewport within the render target that the app must render that frame. Sometimes the system may lower this to free up system resources, for example when video capture is occurring. Regardless of the viewport size, the rendered image is always scaled up to the full size of the displays. An app looking to lower its rendering cost for other reasons can request a smaller viewport. + +You can specify a scale factor between 0.0 and 1.0, which is multiplied by the default viewport size. In future frames, the system will specify that you render to the nearest valid viewport size to this requested size. + +## -property-value +The viewport scale factor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose.md b/windows.graphics.holographic/holographiccamerapose.md index 9963d86f86..83dd42c37d 100644 --- a/windows.graphics.holographic/holographiccamerapose.md +++ b/windows.graphics.holographic/holographiccamerapose.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicCameraPose --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicCameraPose ## -description Represents the predicted location of a holographic camera for a particular frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicCameraPose +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose + +## -description +Represents the predicted location of a holographic camera for a particular frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_farplanedistance.md b/windows.graphics.holographic/holographiccamerapose_farplanedistance.md index 34470ab49f..8fed5c2971 100644 --- a/windows.graphics.holographic/holographiccamerapose_farplanedistance.md +++ b/windows.graphics.holographic/holographiccamerapose_farplanedistance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.FarPlaneDistance --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraPose.FarPlaneDistance ## -description Gets the far plane distance for this frame, which is set by calling the HolographicCamera.SetFarPlaneDistance method. ## -property-value The far plane distance for this frame, in meters. By default, this is set to 20 meters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.FarPlaneDistance +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.FarPlaneDistance + +## -description +Gets the far plane distance for this frame, which is set by calling the HolographicCamera.SetFarPlaneDistance method. + +## -property-value +The far plane distance for this frame, in meters. By default, this is set to 20 meters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_holographiccamera.md b/windows.graphics.holographic/holographiccamerapose_holographiccamera.md index 9ef685c2ac..0836c79032 100644 --- a/windows.graphics.holographic/holographiccamerapose_holographiccamera.md +++ b/windows.graphics.holographic/holographiccamerapose_holographiccamera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.HolographicCamera --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraPose.HolographicCamera ## -description Gets the HolographicCamera that's described by this camera pose. ## -property-value The HolographicCamera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.HolographicCamera +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.HolographicCamera + +## -description +Gets the HolographicCamera that's described by this camera pose. + +## -property-value +The HolographicCamera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_nearplanedistance.md b/windows.graphics.holographic/holographiccamerapose_nearplanedistance.md index 0ed609e199..85c66ab0a1 100644 --- a/windows.graphics.holographic/holographiccamerapose_nearplanedistance.md +++ b/windows.graphics.holographic/holographiccamerapose_nearplanedistance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.NearPlaneDistance --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraPose.NearPlaneDistance ## -description Gets the near plane distance for this frame, which you set by calling the HolographicCamera.SetNearPlaneDistance method. ## -property-value The near plane distance for this frame, in meters. By default, this is set to 0.01 meters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.NearPlaneDistance +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.NearPlaneDistance + +## -description +Gets the near plane distance for this frame, which you set by calling the HolographicCamera.SetNearPlaneDistance method. + +## -property-value +The near plane distance for this frame, in meters. By default, this is set to 0.01 meters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_projectiontransform.md b/windows.graphics.holographic/holographiccamerapose_projectiontransform.md index 94525d46f6..acc6e863ce 100644 --- a/windows.graphics.holographic/holographiccamerapose_projectiontransform.md +++ b/windows.graphics.holographic/holographiccamerapose_projectiontransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.ProjectionTransform --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraPose.ProjectionTransform ## -description Gets the stereo projection transform for this camera pose. ## -property-value The transforms. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.ProjectionTransform +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.ProjectionTransform + +## -description +Gets the stereo projection transform for this camera pose. + +## -property-value +The transforms. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_trygetcullingfrustum_561986829.md b/windows.graphics.holographic/holographiccamerapose_trygetcullingfrustum_561986829.md index cb33dd895a..13fe83899e 100644 --- a/windows.graphics.holographic/holographiccamerapose_trygetcullingfrustum_561986829.md +++ b/windows.graphics.holographic/holographiccamerapose_trygetcullingfrustum_561986829.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetCullingFrustum(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCameraPose.TryGetCullingFrustum ## -description Gets the predicted conservative culling frustum for this camera pose, expressed in the specified coordinate system. ## -parameters ### -param coordinateSystem The coordinate system in which to express the culling frustum. ## -returns The culling frustum. ## -remarks This frustum is wider than the displays to account for uncertainty in the camera's pose prediction. As you get closer to the target frame time, this uncertainty reduces and the culling frustum gets smaller in size. This method will return null if the specified coordinate system cannot be located at the moment. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetCullingFrustum(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.TryGetCullingFrustum + +## -description +Gets the predicted conservative culling frustum for this camera pose, expressed in the specified coordinate system. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the culling frustum. + +## -returns +The culling frustum. + +## -remarks +This frustum is wider than the displays to account for uncertainty in the camera's pose prediction. As you get closer to the target frame time, this uncertainty reduces and the culling frustum gets smaller in size. This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_trygetviewtransform_1213971379.md b/windows.graphics.holographic/holographiccamerapose_trygetviewtransform_1213971379.md index 14fcd980ff..1c8d05a890 100644 --- a/windows.graphics.holographic/holographiccamerapose_trygetviewtransform_1213971379.md +++ b/windows.graphics.holographic/holographiccamerapose_trygetviewtransform_1213971379.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetViewTransform(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCameraPose.TryGetViewTransform ## -description Gets the stereo view transform for this camera pose, expressed as a transform from the specified coordinate system. This method will return null if the specified coordinate system cannot be located at the moment. ## -parameters ### -param coordinateSystem The coordinate system from which the rendered geometry should be transformed. ## -returns The transforms. ## -remarks This method will return null if the specified coordinate system cannot be located at the moment. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetViewTransform(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.TryGetViewTransform + +## -description +Gets the stereo view transform for this camera pose, expressed as a transform from the specified coordinate system. This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system from which the rendered geometry should be transformed. + +## -returns +The transforms. + +## -remarks +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md b/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md index 55d3fee08b..1d5cfff3ec 100644 --- a/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md +++ b/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum ## -description Gets the predicted view frustum for the current pose, expressed in the specified coordinate system. If this is a stereo display, this is the combined frustum of both stereo views, including the left and right view and projection matrices. This frustum shares the same dimensions as the true view frustum at the time of rendering, although it may be off by some amount due to prediction error. Call TryGetCullingFrustum to get a conservative frustum that takes this uncertainty into account. This method will return null if the specified coordinate system cannot be located at the moment. ## -parameters ### -param coordinateSystem The coordinate system in which to express the visible frustum. ## -returns The visible frustum. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum + +## -description +Gets the predicted view frustum for the current pose, expressed in the specified coordinate system. + +If this is a stereo display, this is the combined frustum of both stereo views, including the left and right view and projection matrices. + +This frustum shares the same dimensions as the true view frustum at the time of rendering, although it may be off by some amount due to prediction error. Call TryGetCullingFrustum to get a conservative frustum that takes this uncertainty into account. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the visible frustum. + +## -returns +The visible frustum. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_viewport.md b/windows.graphics.holographic/holographiccamerapose_viewport.md index 2f7b729917..e228b0430d 100644 --- a/windows.graphics.holographic/holographiccamerapose_viewport.md +++ b/windows.graphics.holographic/holographiccamerapose_viewport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.Viewport --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraPose.Viewport ## -description Gets the viewport rectangle that the app must render to for this camera in this frame. To shrink this viewport for future frames, set the ViewportScaleFactor on the HolographicCamera. ## -property-value The viewport rect. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.Viewport +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.Viewport + +## -description +Gets the viewport rectangle that the app must render to for this camera in this frame. To shrink this viewport for future frames, set the ViewportScaleFactor on the HolographicCamera. + +## -property-value +The viewport rect. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters.md b/windows.graphics.holographic/holographiccamerarenderingparameters.md index 8be7be9ef7..572d34ed7e 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicCameraRenderingParameters --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicCameraRenderingParameters ## -description Represents per-camera parameters for rendering holographic content. An app can call the SetFocusPoint method each frame to improve holographic image quality. The app can specify the position, normal, and velocity of the user's likely focus point within the scene. Holograms will be most stable both at the specified position, and along the plane defined by that position and the normal. If the content does not have an obvious normal, omit it or have it face the user. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicCameraRenderingParameters +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters + +## -description +Represents per-camera parameters for rendering holographic content. + +An app can call the SetFocusPoint method each frame to improve holographic image quality. The app can specify the position, normal, and velocity of the user's likely focus point within the scene. Holograms will be most stable both at the specified position, and along the plane defined by that position and the normal. If the content does not have an obvious normal, omit it or have it face the user. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11backbuffer.md b/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11backbuffer.md index d5f089f5de..b2197c0642 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11backbuffer.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11backbuffer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11BackBuffer --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11BackBuffer ## -description Gets the Direct3D 11 back buffer surface for this camera. Apps must retrieve a new back buffer surface for rendering each frame. ## -property-value The Direct3D 11 surface that holds the back buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11BackBuffer +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11BackBuffer + +## -description +Gets the Direct3D 11 back buffer surface for this camera. Apps must retrieve a new back buffer surface for rendering each frame. + +## -property-value +The Direct3D 11 surface that holds the back buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11device.md b/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11device.md index 4b43195622..fdc76d0882 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11device.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_direct3d11device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11Device --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11Device ## -description Gets the Direct3D 11 device for this camera. ## -property-value The Direct3D 11 device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11Device +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.Direct3D11Device + +## -description +Gets the Direct3D 11 device for this camera. + +## -property-value +The Direct3D 11 device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md index 147ad21292..e2ae0a47a3 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint ## -description Sets the moving point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. This is used to improve image quality at the moving focus point and along its focus plane. You must set the focus point each frame, or it will reset to its default. ## -parameters ### -param coordinateSystem The coordinate system of the position, normal and velocity vectors. ### -param position The location of the focus point in the specified coordinate system. ### -param normal The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. ### -param linearVelocity The velocity vector of the focus point in the specified coordinate system. ## -remarks ## -examples ## -see-also [SetFocusPoint(SpatialCoordinateSystem, Vector3)](holographiccamerarenderingparameters_setfocuspoint_184506220.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1275160748.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint + +## -description +Sets the moving point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. + +This is used to improve image quality at the moving focus point and along its focus plane. + +You must set the focus point each frame, or it will reset to its default. + +## -parameters +### -param coordinateSystem +The coordinate system of the position, normal and velocity vectors. + +### -param position +The location of the focus point in the specified coordinate system. + +### -param normal +The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. + +### -param linearVelocity +The velocity vector of the focus point in the specified coordinate system. + +## -remarks + +## -examples + +## -see-also +[SetFocusPoint(SpatialCoordinateSystem, Vector3)](holographiccamerarenderingparameters_setfocuspoint_184506220.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1275160748.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md index c1fa9c2fdf..4ba0dd1e5e 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint ## -description Sets the stationary point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. This is used to improve image quality at the focus point and along its focus plane. You must set the focus point each frame, or it will reset to its default. ## -parameters ### -param coordinateSystem The coordinate system of the position and normal vectors. ### -param position The location of the focus point in the specified coordinate system. ### -param normal The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. ## -remarks ## -examples ## -see-also [SetFocusPoint(SpatialCoordinateSystem, Vector3)](holographiccamerarenderingparameters_setfocuspoint_184506220.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1040378076.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint + +## -description +Sets the stationary point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. + +This is used to improve image quality at the focus point and along its focus plane. + +You must set the focus point each frame, or it will reset to its default. + +## -parameters +### -param coordinateSystem +The coordinate system of the position and normal vectors. + +### -param position +The location of the focus point in the specified coordinate system. + +### -param normal +The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. + +## -remarks + +## -examples + +## -see-also +[SetFocusPoint(SpatialCoordinateSystem, Vector3)](holographiccamerarenderingparameters_setfocuspoint_184506220.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1040378076.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md index 6313644ec7..0b32094688 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint ## -description Sets the stationary point in the holographic space that the user will likely focus on for the current frame. This is used to improve image quality at the focus point and along a default focus plane that faces the user. You must set the focus point each frame, or it will reset to its default. ## -parameters ### -param coordinateSystem The coordinate system of the position vector. ### -param position The location of the focus point in the specified coordinate system. ## -remarks ## -examples ## -see-also [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1275160748.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1040378076.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint + +## -description +Sets the stationary point in the holographic space that the user will likely focus on for the current frame. + +This is used to improve image quality at the focus point and along a default focus plane that faces the user. + +You must set the focus point each frame, or it will reset to its default. + +## -parameters +### -param coordinateSystem +The coordinate system of the position vector. + +### -param position +The location of the focus point in the specified coordinate system. + +## -remarks + +## -examples + +## -see-also +[SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1275160748.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1040378076.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographicframe.md b/windows.graphics.holographic/holographicframe.md index dd5b29c605..eaf7bcbcad 100644 --- a/windows.graphics.holographic/holographicframe.md +++ b/windows.graphics.holographic/holographicframe.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicFrame --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicFrame ## -description Represents a frame of holographic content that an app must render to all cameras. Each HolographicFrame tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicFrame +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicFrame + +## -description +Represents a frame of holographic content that an app must render to all cameras. + +Each HolographicFrame tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_addedcameras.md b/windows.graphics.holographic/holographicframe_addedcameras.md index 6823a8f88c..e000af57c6 100644 --- a/windows.graphics.holographic/holographicframe_addedcameras.md +++ b/windows.graphics.holographic/holographicframe_addedcameras.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicFrame.AddedCameras --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicFrame.AddedCameras ## -description Gets the list of HolographicCamera objects that were added since last frame. Cameras only show up in this list after they surface in the CameraAdded event to //! let apps initialize any per-camera buffers on a background thread. ## -property-value A collection of HolographicCamera objects that were added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFrame.AddedCameras +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.AddedCameras + +## -description +Gets the list of HolographicCamera objects that were added since last frame. + +Cameras only show up in this list after they surface in the CameraAdded event to //! let apps initialize any per-camera buffers on a background thread. + +## -property-value +A collection of HolographicCamera objects that were added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_currentprediction.md b/windows.graphics.holographic/holographicframe_currentprediction.md index 3a7ad3fd08..57c78d13ce 100644 --- a/windows.graphics.holographic/holographicframe_currentprediction.md +++ b/windows.graphics.holographic/holographicframe_currentprediction.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicFrame.CurrentPrediction --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicFrame.CurrentPrediction ## -description Gets the most recent camera location prediction for the current HolographicFrame. ## -property-value The prediction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFrame.CurrentPrediction +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.CurrentPrediction + +## -description +Gets the most recent camera location prediction for the current HolographicFrame. + +## -property-value +The prediction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_duration.md b/windows.graphics.holographic/holographicframe_duration.md index d921dd42dc..ec09f5267c 100644 --- a/windows.graphics.holographic/holographicframe_duration.md +++ b/windows.graphics.holographic/holographicframe_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicFrame.Duration --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicFrame.Duration ## -description Gets the duration of time that the frame will be on the screen. ## -property-value The time span. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFrame.Duration +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.Duration + +## -description +Gets the duration of time that the frame will be on the screen. + +## -property-value +The time span. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_getrenderingparameters_2127053540.md b/windows.graphics.holographic/holographicframe_getrenderingparameters_2127053540.md index 94901a0701..43df04cde5 100644 --- a/windows.graphics.holographic/holographicframe_getrenderingparameters_2127053540.md +++ b/windows.graphics.holographic/holographicframe_getrenderingparameters_2127053540.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicFrame.GetRenderingParameters(Windows.Graphics.Holographic.HolographicCameraPose) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicFrame.GetRenderingParameters ## -description Gets the parameters needed to render the current frame with the specified camera pose. ## -parameters ### -param cameraPose The camera pose. ## -returns The rendering parameters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicFrame.GetRenderingParameters(Windows.Graphics.Holographic.HolographicCameraPose) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.GetRenderingParameters + +## -description +Gets the parameters needed to render the current frame with the specified camera pose. + +## -parameters +### -param cameraPose +The camera pose. + +## -returns +The rendering parameters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_1384220218.md b/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_1384220218.md index 020adb7ced..f0efb27b3b 100644 --- a/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_1384220218.md +++ b/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_1384220218.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction ## -description Present the current frame for all cameras and then wait until the next frame. ## -returns The result of the Present call. ## -remarks ## -examples ## -see-also [PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior)](holographicframe_presentusingcurrentprediction_19613915.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction + +## -description +Present the current frame for all cameras and then wait until the next frame. + +## -returns +The result of the Present call. + +## -remarks + +## -examples + +## -see-also +[PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior)](holographicframe_presentusingcurrentprediction_19613915.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_19613915.md b/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_19613915.md index 6bd9eda3ac..41f60cd8ad 100644 --- a/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_19613915.md +++ b/windows.graphics.holographic/holographicframe_presentusingcurrentprediction_19613915.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction(Windows.Graphics.Holographic.HolographicFramePresentWaitBehavior) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction ## -description Presents the current frame for all cameras with the specified waiting behavior. ## -parameters ### -param waitBehavior The wait behavior. ## -returns The result of the Present call. ## -remarks ## -examples ## -see-also [PresentUsingCurrentPrediction](holographicframe_presentusingcurrentprediction_1384220218.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction(Windows.Graphics.Holographic.HolographicFramePresentWaitBehavior) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.PresentUsingCurrentPrediction + +## -description +Presents the current frame for all cameras with the specified waiting behavior. + +## -parameters +### -param waitBehavior +The wait behavior. + +## -returns +The result of the Present call. + +## -remarks + +## -examples + +## -see-also +[PresentUsingCurrentPrediction](holographicframe_presentusingcurrentprediction_1384220218.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographicframe_removedcameras.md b/windows.graphics.holographic/holographicframe_removedcameras.md index 067aba1657..c3a111903a 100644 --- a/windows.graphics.holographic/holographicframe_removedcameras.md +++ b/windows.graphics.holographic/holographicframe_removedcameras.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicFrame.RemovedCameras --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicFrame.RemovedCameras ## -description Gets the list of HolographicCamera objects that were removed since last frame. ## -property-value A collection of HolographicCamera objects that were removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFrame.RemovedCameras +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.RemovedCameras + +## -description +Gets the list of HolographicCamera objects that were removed since last frame. + +## -property-value +A collection of HolographicCamera objects that were removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_updatecurrentprediction_1615759558.md b/windows.graphics.holographic/holographicframe_updatecurrentprediction_1615759558.md index 6da8b81eb4..933e1bd1e9 100644 --- a/windows.graphics.holographic/holographicframe_updatecurrentprediction_1615759558.md +++ b/windows.graphics.holographic/holographicframe_updatecurrentprediction_1615759558.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicFrame.UpdateCurrentPrediction --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicFrame.UpdateCurrentPrediction ## -description Computes an updated prediction for the CurrentPrediction property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicFrame.UpdateCurrentPrediction +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.UpdateCurrentPrediction + +## -description +Computes an updated prediction for the CurrentPrediction property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md b/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md index 578a98c178..a08257d0e5 100644 --- a/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md +++ b/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish ## -description Blocks the current thread until this frame has finished and is showing on the displays. Note that the default wait behavior of PresentUsingCurrentPrediction already waits for the frame to finish. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish + +## -description +Blocks the current thread until this frame has finished and is showing on the displays. + +Note that the default wait behavior of PresentUsingCurrentPrediction already waits for the frame to finish. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframeprediction.md b/windows.graphics.holographic/holographicframeprediction.md index 982d07f541..0266660d15 100644 --- a/windows.graphics.holographic/holographicframeprediction.md +++ b/windows.graphics.holographic/holographicframeprediction.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicFramePrediction --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicFramePrediction ## -description holographicframeprediction ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicFramePrediction +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicFramePrediction + +## -description +holographicframeprediction + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframeprediction_cameraposes.md b/windows.graphics.holographic/holographicframeprediction_cameraposes.md index a2cacee254..0ab71a6ef5 100644 --- a/windows.graphics.holographic/holographicframeprediction_cameraposes.md +++ b/windows.graphics.holographic/holographicframeprediction_cameraposes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicFramePrediction.CameraPoses --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicFramePrediction.CameraPoses ## -description Gets the camera poses that correspond with the time specified by Timestamp. ## -property-value The camera poses. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFramePrediction.CameraPoses +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFramePrediction.CameraPoses + +## -description +Gets the camera poses that correspond with the time specified by Timestamp. + +## -property-value +The camera poses. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframeprediction_timestamp.md b/windows.graphics.holographic/holographicframeprediction_timestamp.md index a40f8e8076..ecd4cf6e81 100644 --- a/windows.graphics.holographic/holographicframeprediction_timestamp.md +++ b/windows.graphics.holographic/holographicframeprediction_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicFramePrediction.Timestamp --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicFramePrediction.Timestamp ## -description Gets the time when the camera poses are predicted to be displayed. ## -property-value The timestamp. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFramePrediction.Timestamp +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFramePrediction.Timestamp + +## -description +Gets the time when the camera poses are predicted to be displayed. + +## -property-value +The timestamp. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace.md b/windows.graphics.holographic/holographicspace.md index 7e0e6fb1d7..85dc9f3ab7 100644 --- a/windows.graphics.holographic/holographicspace.md +++ b/windows.graphics.holographic/holographicspace.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicSpace --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicSpace ## -description Represents a holographic scene, with one or more holographic cameras rendering its content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicSpace +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicSpace + +## -description +Represents a holographic scene, with one or more holographic cameras rendering its content. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_cameraadded.md b/windows.graphics.holographic/holographicspace_cameraadded.md index 86ad4b8a82..d650317017 100644 --- a/windows.graphics.holographic/holographicspace_cameraadded.md +++ b/windows.graphics.holographic/holographicspace_cameraadded.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraAdded --api-type: winrt event ---- # Windows.Graphics.Holographic.HolographicSpace.CameraAdded ## -description Occurs when a HolographicCamera is added to the current HolographicSpace. Apps can use this event to set up any per-camera resources they may need. Unless the deferral is taken, once all event handlers are complete, the system will include this camera in the list of cameras that the app must render to each frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraAdded +-api-type: winrt event +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CameraAdded + +## -description +Occurs when a HolographicCamera is added to the current HolographicSpace. + +Apps can use this event to set up any per-camera resources they may need. + +Unless the deferral is taken, once all event handlers are complete, the system will include this camera in the list of cameras that the app must render to each frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_cameraremoved.md b/windows.graphics.holographic/holographicspace_cameraremoved.md index 9106008106..bb402d76f2 100644 --- a/windows.graphics.holographic/holographicspace_cameraremoved.md +++ b/windows.graphics.holographic/holographicspace_cameraremoved.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraRemoved --api-type: winrt event ---- # Windows.Graphics.Holographic.HolographicSpace.CameraRemoved ## -description Occurs when a HolographicCamera is removed from the current HolographicSpace. Apps can use this event to tear down any per-camera resources they may have set up during CameraAdded. The system will no longer require that the app render to this camera, starting in the next frame after this event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraRemoved +-api-type: winrt event +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CameraRemoved + +## -description +Occurs when a HolographicCamera is removed from the current HolographicSpace. + +Apps can use this event to tear down any per-camera resources they may have set up during CameraAdded. + +The system will no longer require that the app render to this camera, starting in the next frame after this event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md b/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md index 3c95f42fa4..df77e60b27 100644 --- a/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md +++ b/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow(Windows.UI.Core.CoreWindow) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow ## -description Creates a HolographicSpace that corresponds with the specified window's CoreApplicationView. Calling this method permanently assigns the CoreApplicationView to be holographic. You may no longer call IDXGIFactory2::CreateSwapChainForCoreWindow after calling this method, or vice versa. ## -parameters ### -param window The window to create a HolographicSpace for. ## -returns The HolographicSpace. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow(Windows.UI.Core.CoreWindow) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow + +## -description +Creates a HolographicSpace that corresponds with the specified window's CoreApplicationView. + +Calling this method permanently assigns the CoreApplicationView to be holographic. You may no longer call IDXGIFactory2::CreateSwapChainForCoreWindow after calling this method, or vice versa. + +## -parameters +### -param window +The window to create a HolographicSpace for. + +## -returns +The HolographicSpace. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_createnextframe_767085077.md b/windows.graphics.holographic/holographicspace_createnextframe_767085077.md index cf1697d8af..702971c100 100644 --- a/windows.graphics.holographic/holographicspace_createnextframe_767085077.md +++ b/windows.graphics.holographic/holographicspace_createnextframe_767085077.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame ## -description Creates a HolographicFrame for the next frame to display. Apps use the HolographicFrame returned here to find out the predicted positions of each HolographicCamera at the time of frame display, render their views based on that prediction, and then call the PresentUsingCurrentPrediction method to send them to the displays. The system tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. ## -returns The next frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame + +## -description +Creates a HolographicFrame for the next frame to display. + +Apps use the HolographicFrame returned here to find out the predicted positions of each HolographicCamera at the time of frame display, render their views based on that prediction, and then call the PresentUsingCurrentPrediction method to send them to the displays. + +The system tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. + +## -returns +The next frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_primaryadapterid.md b/windows.graphics.holographic/holographicspace_primaryadapterid.md index 3bf795e392..dde73362f5 100644 --- a/windows.graphics.holographic/holographicspace_primaryadapterid.md +++ b/windows.graphics.holographic/holographicspace_primaryadapterid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId ## -description Gets the identifier of the graphics adapter to be used when displaying holographic content. ## -property-value The identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId + +## -description +Gets the identifier of the graphics adapter to be used when displaying holographic content. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_setdirect3d11device_1611033311.md b/windows.graphics.holographic/holographicspace_setdirect3d11device_1611033311.md index da5a778cdd..f8e45be536 100644 --- a/windows.graphics.holographic/holographicspace_setdirect3d11device_1611033311.md +++ b/windows.graphics.holographic/holographicspace_setdirect3d11device_1611033311.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicSpace.SetDirect3D11Device(Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice) --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicSpace.SetDirect3D11Device ## -description Assigns the IDirect3DDevice that will display holographic content. An error will occur if the app creates an inappropriate device. ## -parameters ### -param value The Direct3D device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicSpace.SetDirect3D11Device(Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.SetDirect3D11Device + +## -description +Assigns the IDirect3DDevice that will display holographic content. An error will occur if the app creates an inappropriate device. + +## -parameters +### -param value +The Direct3D device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspacecameraaddedeventargs.md b/windows.graphics.holographic/holographicspacecameraaddedeventargs.md index 557322ec98..76e25d1e20 100644 --- a/windows.graphics.holographic/holographicspacecameraaddedeventargs.md +++ b/windows.graphics.holographic/holographicspacecameraaddedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs ## -description Provides data for the HolographicSpace.CameraAdded event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs + +## -description +Provides data for the HolographicSpace.CameraAdded event. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspacecameraaddedeventargs_camera.md b/windows.graphics.holographic/holographicspacecameraaddedeventargs_camera.md index 41ef8b4db6..729175d26d 100644 --- a/windows.graphics.holographic/holographicspacecameraaddedeventargs_camera.md +++ b/windows.graphics.holographic/holographicspacecameraaddedeventargs_camera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.Camera --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.Camera ## -description Gets the HolographicCamera that is being added. The app should set up any per-camera resources it may need for this camera. ## -property-value The camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.Camera +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.Camera + +## -description +Gets the HolographicCamera that is being added. The app should set up any per-camera resources it may need for this camera. + +## -property-value +The camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspacecameraaddedeventargs_getdeferral_254836512.md b/windows.graphics.holographic/holographicspacecameraaddedeventargs_getdeferral_254836512.md index 7cb07e9723..61c363b23a 100644 --- a/windows.graphics.holographic/holographicspacecameraaddedeventargs_getdeferral_254836512.md +++ b/windows.graphics.holographic/holographicspacecameraaddedeventargs_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.GetDeferral ## -description Requests that addition of this camera be delayed until the deferral is completed. ## -returns The deferral. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicSpaceCameraAddedEventArgs.GetDeferral + +## -description +Requests that addition of this camera be delayed until the deferral is completed. + +## -returns +The deferral. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspacecameraremovedeventargs.md b/windows.graphics.holographic/holographicspacecameraremovedeventargs.md index 84bc1d242e..81577d8e04 100644 --- a/windows.graphics.holographic/holographicspacecameraremovedeventargs.md +++ b/windows.graphics.holographic/holographicspacecameraremovedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs --api-type: winrt class ---- # Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs ## -description Provides data for the HolographicSpace.CameraRemoved event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs + +## -description +Provides data for the HolographicSpace.CameraRemoved event. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspacecameraremovedeventargs_camera.md b/windows.graphics.holographic/holographicspacecameraremovedeventargs_camera.md index 6a8434eb7a..2127b886f9 100644 --- a/windows.graphics.holographic/holographicspacecameraremovedeventargs_camera.md +++ b/windows.graphics.holographic/holographicspacecameraremovedeventargs_camera.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs.Camera --api-type: winrt property ---- # Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs.Camera ## -description Gets the HolographicCamera that was removed. The app should dispose of any per-camera resources it may have set up for this camera. ## -property-value The camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs.Camera +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicSpaceCameraRemovedEventArgs.Camera + +## -description +Gets the HolographicCamera that was removed. The app should dispose of any per-camera resources it may have set up for this camera. + +## -property-value +The camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapbuffer.md b/windows.graphics.imaging/bitmapbuffer.md index b836699e9f..ffc5944b93 100644 --- a/windows.graphics.imaging/bitmapbuffer.md +++ b/windows.graphics.imaging/bitmapbuffer.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Graphics.Imaging.BitmapBuffer --api-type: winrt class ---- # Windows.Graphics.Imaging.BitmapBuffer ## -description Represents the pixel data buffer of a bitmap. ## -remarks Get an instance of this class by calling [SoftwareBitmap::LockBuffer](softwarebitmap_lockbuffer.md). ## -examples ## -see-also [IMemoryBuffer](../windows.foundation/imemorybuffer.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Imaging.BitmapBuffer +-api-type: winrt class +--- + + + +# Windows.Graphics.Imaging.BitmapBuffer + +## -description +Represents the pixel data buffer of a bitmap. + +## -remarks +Get an instance of this class by calling [SoftwareBitmap::LockBuffer](softwarebitmap_lockbuffer.md). + +## -examples + +## -see-also +[IMemoryBuffer](../windows.foundation/imemorybuffer.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapbuffer_close_811482585.md b/windows.graphics.imaging/bitmapbuffer_close_811482585.md index 32114ce18d..d938bbdc09 100644 --- a/windows.graphics.imaging/bitmapbuffer_close_811482585.md +++ b/windows.graphics.imaging/bitmapbuffer_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapBuffer.Close --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapBuffer.Close ## -description Disposes of the object and associated resources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapBuffer.Close +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapBuffer.Close + +## -description +Disposes of the object and associated resources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapbuffer_createreference_431808572.md b/windows.graphics.imaging/bitmapbuffer_createreference_431808572.md index c051d54cbd..0bc09db78f 100644 --- a/windows.graphics.imaging/bitmapbuffer_createreference_431808572.md +++ b/windows.graphics.imaging/bitmapbuffer_createreference_431808572.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapBuffer.CreateReference --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapBuffer.CreateReference ## -description Creates a reference to the underlying memory buffer. ## -returns A reference to the underlying memory buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapBuffer.CreateReference +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapBuffer.CreateReference + +## -description +Creates a reference to the underlying memory buffer. + +## -returns +A reference to the underlying memory buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapbuffer_getplanecount_1555523583.md b/windows.graphics.imaging/bitmapbuffer_getplanecount_1555523583.md index 8e1c21ea23..c47914086a 100644 --- a/windows.graphics.imaging/bitmapbuffer_getplanecount_1555523583.md +++ b/windows.graphics.imaging/bitmapbuffer_getplanecount_1555523583.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapBuffer.GetPlaneCount --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapBuffer.GetPlaneCount ## -description Gets the number of bit planes in the bitmap buffer. ## -returns The number of bit planes in the bitmap buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapBuffer.GetPlaneCount +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapBuffer.GetPlaneCount + +## -description +Gets the number of bit planes in the bitmap buffer. + +## -returns +The number of bit planes in the bitmap buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapbuffer_getplanedescription_991520149.md b/windows.graphics.imaging/bitmapbuffer_getplanedescription_991520149.md index cf92e57f4b..aae3125997 100644 --- a/windows.graphics.imaging/bitmapbuffer_getplanedescription_991520149.md +++ b/windows.graphics.imaging/bitmapbuffer_getplanedescription_991520149.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapBuffer.GetPlaneDescription(System.Int32) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapBuffer.GetPlaneDescription ## -description Gets a BitmapPlaneDescription object that describes the size, offset, and stride of the bitmap data in the bit plane with the specified index. ## -parameters ### -param index The index of the bit plane for which the description is retrieved. ## -returns The bit plane description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapBuffer.GetPlaneDescription(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapBuffer.GetPlaneDescription + +## -description +Gets a BitmapPlaneDescription object that describes the size, offset, and stride of the bitmap data in the bit plane with the specified index. + +## -parameters +### -param index +The index of the bit plane for which the description is retrieved. + +## -returns +The bit plane description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapcodecinformation_codecid.md b/windows.graphics.imaging/bitmapcodecinformation_codecid.md index ba4e884db5..bb2391683a 100644 --- a/windows.graphics.imaging/bitmapcodecinformation_codecid.md +++ b/windows.graphics.imaging/bitmapcodecinformation_codecid.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.CodecId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapCodecInformation.CodecId ## -description The unique identifier of the decoder or encoder. Methods like [BitmapDecoder::CreateAsync](bitmapdecoder_createasync.md) and [BitmapEncoder::CreateAsync](bitmapencoder_createasync.md) use the codec identifier to determine which codec to create. ## -property-value The codec unique identifier. ## -remarks The encoder and decoder of an image format are separate, and their codec IDs are distinct. ## -examples ## -see-also [BitmapDecoder::CreateAsync](bitmapdecoder_createasync.md), [BitmapEncoder::CreateAsync](bitmapencoder_createasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.CodecId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapCodecInformation.CodecId + +## -description +The unique identifier of the decoder or encoder. Methods like [BitmapDecoder::CreateAsync](bitmapdecoder_createasync.md) and [BitmapEncoder::CreateAsync](bitmapencoder_createasync.md) use the codec identifier to determine which codec to create. + +## -property-value +The codec unique identifier. + +## -remarks +The encoder and decoder of an image format are separate, and their codec IDs are distinct. + +## -examples + +## -see-also +[BitmapDecoder::CreateAsync](bitmapdecoder_createasync.md), [BitmapEncoder::CreateAsync](bitmapencoder_createasync.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapcodecinformation_fileextensions.md b/windows.graphics.imaging/bitmapcodecinformation_fileextensions.md index 03b85ffa59..a0b1471b75 100644 --- a/windows.graphics.imaging/bitmapcodecinformation_fileextensions.md +++ b/windows.graphics.imaging/bitmapcodecinformation_fileextensions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.FileExtensions --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapCodecInformation.FileExtensions ## -description A collection of all the file extensions supported by the decoder or encoder. ## -property-value The list of supported file extensions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.FileExtensions +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapCodecInformation.FileExtensions + +## -description +A collection of all the file extensions supported by the decoder or encoder. + +## -property-value +The list of supported file extensions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapcodecinformation_friendlyname.md b/windows.graphics.imaging/bitmapcodecinformation_friendlyname.md index c5f6d63b99..d774b398a2 100644 --- a/windows.graphics.imaging/bitmapcodecinformation_friendlyname.md +++ b/windows.graphics.imaging/bitmapcodecinformation_friendlyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.FriendlyName --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapCodecInformation.FriendlyName ## -description The friendly name of the decoder or encoder. ## -property-value The friendly name of the codec. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.FriendlyName +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapCodecInformation.FriendlyName + +## -description +The friendly name of the decoder or encoder. + +## -property-value +The friendly name of the codec. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapcodecinformation_mimetypes.md b/windows.graphics.imaging/bitmapcodecinformation_mimetypes.md index 1f737c62fd..174254e842 100644 --- a/windows.graphics.imaging/bitmapcodecinformation_mimetypes.md +++ b/windows.graphics.imaging/bitmapcodecinformation_mimetypes.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.MimeTypes --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapCodecInformation.MimeTypes ## -description A collection of all the MIME/content types supported by the decoder or encoder. MIME type is synonymous with [content type](../windows.storage.streams/icontenttypeprovider_contenttype.md). ## -property-value The list of supported MIME/content types. ## -remarks ## -examples ## -see-also [IContentTypeProvider::ContentType](../windows.storage.streams/icontenttypeprovider_contenttype.md) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapCodecInformation.MimeTypes +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapCodecInformation.MimeTypes + +## -description +A collection of all the MIME/content types supported by the decoder or encoder. MIME type is synonymous with [content type](../windows.storage.streams/icontenttypeprovider_contenttype.md). + +## -property-value +The list of supported MIME/content types. + +## -remarks + +## -examples + +## -see-also +[IContentTypeProvider::ContentType](../windows.storage.streams/icontenttypeprovider_contenttype.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_bitmapalphamode.md b/windows.graphics.imaging/bitmapdecoder_bitmapalphamode.md index 09e8afb8dc..001e5f25a2 100644 --- a/windows.graphics.imaging/bitmapdecoder_bitmapalphamode.md +++ b/windows.graphics.imaging/bitmapdecoder_bitmapalphamode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapAlphaMode --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.BitmapAlphaMode ## -description The default alpha mode of the first frame. ## -property-value The default alpha mode of the first frame. ## -remarks This is the alpha mode used when calling the [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.BitmapAlphaMode + +## -description +The default alpha mode of the first frame. + +## -property-value +The default alpha mode of the first frame. + +## -remarks +This is the alpha mode used when calling the [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_bitmapcontainerproperties.md b/windows.graphics.imaging/bitmapdecoder_bitmapcontainerproperties.md index c782c969e5..ec8ff8500f 100644 --- a/windows.graphics.imaging/bitmapdecoder_bitmapcontainerproperties.md +++ b/windows.graphics.imaging/bitmapdecoder_bitmapcontainerproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapContainerProperties --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.BitmapContainerProperties ## -description Provides access to the container bitmap properties. ## -property-value The container bitmap properties. ## -remarks Many image file formats do not have container level metadata. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapContainerProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.BitmapContainerProperties + +## -description +Provides access to the container bitmap properties. + +## -property-value +The container bitmap properties. + +## -remarks +Many image file formats do not have container level metadata. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_bitmappixelformat.md b/windows.graphics.imaging/bitmapdecoder_bitmappixelformat.md index ffabd12e20..a9e53e96ac 100644 --- a/windows.graphics.imaging/bitmapdecoder_bitmappixelformat.md +++ b/windows.graphics.imaging/bitmapdecoder_bitmappixelformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapPixelFormat --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.BitmapPixelFormat ## -description The pixel format that best fits the first frame. ## -property-value The pixel format that best fits the first frame. ## -remarks This is the pixel format used when calling the [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.BitmapPixelFormat + +## -description +The pixel format that best fits the first frame. + +## -property-value +The pixel format that best fits the first frame. + +## -remarks +This is the pixel format used when calling the [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_bitmapproperties.md b/windows.graphics.imaging/bitmapdecoder_bitmapproperties.md index 1c2126b67d..c9c304d22c 100644 --- a/windows.graphics.imaging/bitmapdecoder_bitmapproperties.md +++ b/windows.graphics.imaging/bitmapdecoder_bitmapproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapProperties --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.BitmapProperties ## -description A read-only view of the metadata within the first frame. ## -property-value A read-only view of the metadata within the first frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BitmapProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.BitmapProperties + +## -description +A read-only view of the metadata within the first frame. + +## -property-value +A read-only view of the metadata within the first frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_bmpdecoderid.md b/windows.graphics.imaging/bitmapdecoder_bmpdecoderid.md index 34bf8f348b..2123cb49f2 100644 --- a/windows.graphics.imaging/bitmapdecoder_bmpdecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_bmpdecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BmpDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.BmpDecoderId ## -description The unique identifier of the BMP decoder. ## -property-value The unique identifier of the BMP decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.BmpDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.BmpDecoderId + +## -description +The unique identifier of the BMP decoder. + +## -property-value +The unique identifier of the BMP decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_createasync_1315566040.md b/windows.graphics.imaging/bitmapdecoder_createasync_1315566040.md index a0c7902b2e..4c96231884 100644 --- a/windows.graphics.imaging/bitmapdecoder_createasync_1315566040.md +++ b/windows.graphics.imaging/bitmapdecoder_createasync_1315566040.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.CreateAsync(System.Guid,Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.CreateAsync ## -description Asynchronously creates a new [BitmapDecoder](bitmapdecoder.md) using a specific bitmap codec and initializes it using a stream. ## -parameters ### -param decoderId The unique identifier of the specified bitmap codec. ### -param stream The stream containing the image file to be decoded. ## -returns An object that manages the asynchronous creation of a new [BitmapDecoder](bitmapdecoder.md). ## -remarks This method allows the application to explicitly select the bitmap decoder to be used and bypass any automatic codec arbitration. The unique identifiers of the built-in decoders are available as properties on [BitmapDecoder](bitmapdecoder.md). In addition, the unique identifier of any installed decoder can be obtained using the [GetDecoderInformationEnumerator](bitmapdecoder_getdecoderinformationenumerator.md) method. ## -examples ## -see-also [CreateAsync(IRandomAccessStream)](bitmapdecoder_createasync_989183434.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.CreateAsync(System.Guid,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.CreateAsync + +## -description +Asynchronously creates a new [BitmapDecoder](bitmapdecoder.md) using a specific bitmap codec and initializes it using a stream. + +## -parameters +### -param decoderId +The unique identifier of the specified bitmap codec. + +### -param stream +The stream containing the image file to be decoded. + +## -returns +An object that manages the asynchronous creation of a new [BitmapDecoder](bitmapdecoder.md). + +## -remarks +This method allows the application to explicitly select the bitmap decoder to be used and bypass any automatic codec arbitration. The unique identifiers of the built-in decoders are available as properties on [BitmapDecoder](bitmapdecoder.md). In addition, the unique identifier of any installed decoder can be obtained using the [GetDecoderInformationEnumerator](bitmapdecoder_getdecoderinformationenumerator.md) method. + +## -examples + +## -see-also +[CreateAsync(IRandomAccessStream)](bitmapdecoder_createasync_989183434.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_createasync_989183434.md b/windows.graphics.imaging/bitmapdecoder_createasync_989183434.md index 51eae963f2..1ea0590ba9 100644 --- a/windows.graphics.imaging/bitmapdecoder_createasync_989183434.md +++ b/windows.graphics.imaging/bitmapdecoder_createasync_989183434.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.CreateAsync(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.CreateAsync ## -description Asynchronously creates a new [BitmapDecoder](bitmapdecoder.md) and initializes it using a stream. ## -parameters ### -param stream The stream containing the image file to be decoded. ## -returns An object that manages the asynchronous creation of a new [BitmapDecoder](bitmapdecoder.md). ## -remarks [Windows.Graphics.Imaging](windows_graphics_imaging.md) automatically determines the correct bitmap decoder to decode the stream. ## -examples ## -see-also [CreateAsync(Guid, IRandomAccessStream)](bitmapdecoder_createasync_1315566040.md), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.CreateAsync(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.CreateAsync + +## -description +Asynchronously creates a new [BitmapDecoder](bitmapdecoder.md) and initializes it using a stream. + +## -parameters +### -param stream +The stream containing the image file to be decoded. + +## -returns +An object that manages the asynchronous creation of a new [BitmapDecoder](bitmapdecoder.md). + +## -remarks +[Windows.Graphics.Imaging](windows_graphics_imaging.md) automatically determines the correct bitmap decoder to decode the stream. + +## -examples + +## -see-also +[CreateAsync(Guid, IRandomAccessStream)](bitmapdecoder_createasync_1315566040.md), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_decoderinformation.md b/windows.graphics.imaging/bitmapdecoder_decoderinformation.md index fe24c1b63b..c708f6ce7d 100644 --- a/windows.graphics.imaging/bitmapdecoder_decoderinformation.md +++ b/windows.graphics.imaging/bitmapdecoder_decoderinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.DecoderInformation --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.DecoderInformation ## -description Information about the bitmap decoder. ## -property-value The bitmap decoder information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.DecoderInformation +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.DecoderInformation + +## -description +Information about the bitmap decoder. + +## -property-value +The bitmap decoder information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_dpix.md b/windows.graphics.imaging/bitmapdecoder_dpix.md index afb8c66e02..3a64282007 100644 --- a/windows.graphics.imaging/bitmapdecoder_dpix.md +++ b/windows.graphics.imaging/bitmapdecoder_dpix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.DpiX --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.DpiX ## -description The horizontal resolution of the first frame in dots per inch. ## -property-value The horizontal resolution of the first frame in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.DpiX +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.DpiX + +## -description +The horizontal resolution of the first frame in dots per inch. + +## -property-value +The horizontal resolution of the first frame in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_dpiy.md b/windows.graphics.imaging/bitmapdecoder_dpiy.md index ccb148d3da..adde80fc48 100644 --- a/windows.graphics.imaging/bitmapdecoder_dpiy.md +++ b/windows.graphics.imaging/bitmapdecoder_dpiy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.DpiY --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.DpiY ## -description The vertical resolution of the first frame in dots per inch. ## -property-value The vertical resolution of the first frame in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.DpiY +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.DpiY + +## -description +The vertical resolution of the first frame in dots per inch. + +## -property-value +The vertical resolution of the first frame in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_framecount.md b/windows.graphics.imaging/bitmapdecoder_framecount.md index 25ca4e36c4..963479463e 100644 --- a/windows.graphics.imaging/bitmapdecoder_framecount.md +++ b/windows.graphics.imaging/bitmapdecoder_framecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.FrameCount --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.FrameCount ## -description The number of frames within the image file. ## -property-value The number of frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.FrameCount +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.FrameCount + +## -description +The number of frames within the image file. + +## -property-value +The number of frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_getdecoderinformationenumerator_1302740057.md b/windows.graphics.imaging/bitmapdecoder_getdecoderinformationenumerator_1302740057.md index 87b6f7fe15..c66b7bfb34 100644 --- a/windows.graphics.imaging/bitmapdecoder_getdecoderinformationenumerator_1302740057.md +++ b/windows.graphics.imaging/bitmapdecoder_getdecoderinformationenumerator_1302740057.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetDecoderInformationEnumerator --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetDecoderInformationEnumerator ## -description The bitmap decoders installed on the system and information about them. ## -returns A list of [BitmapCodecInformation](bitmapcodecinformation.md) objects containing information about each decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetDecoderInformationEnumerator +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetDecoderInformationEnumerator + +## -description +The bitmap decoders installed on the system and information about them. + +## -returns +A list of [BitmapCodecInformation](bitmapcodecinformation.md) objects containing information about each decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_getframeasync_2007262834.md b/windows.graphics.imaging/bitmapdecoder_getframeasync_2007262834.md index 871825c610..a70b494447 100644 --- a/windows.graphics.imaging/bitmapdecoder_getframeasync_2007262834.md +++ b/windows.graphics.imaging/bitmapdecoder_getframeasync_2007262834.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetFrameAsync(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetFrameAsync ## -description Asynchronously retrieves a frame from the image file. ## -parameters ### -param frameIndex The zero-based index of the frame to be retrieved. ## -returns Object that manages the asynchronous retrieval of the frame. ## -remarks You don't need to use this method to access data from the first frame in an image file. [BitmapDecoder](bitmapdecoder.md) already provides a method to access the first frame. You can get the total number of frames on the image using the [FrameCount](bitmapdecoder_framecount.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetFrameAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetFrameAsync + +## -description +Asynchronously retrieves a frame from the image file. + +## -parameters +### -param frameIndex +The zero-based index of the frame to be retrieved. + +## -returns +Object that manages the asynchronous retrieval of the frame. + +## -remarks +You don't need to use this method to access data from the first frame in an image file. [BitmapDecoder](bitmapdecoder.md) already provides a method to access the first frame. + +You can get the total number of frames on the image using the [FrameCount](bitmapdecoder_framecount.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_1391309547.md b/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_1391309547.md index 6e8c24fb2b..395f6616ba 100644 --- a/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_1391309547.md +++ b/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_1391309547.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync ## -description Asynchronously requests the pixel data for the frame. ## -returns Object that manages the asynchronous retrieval of the pixel data. ## -remarks The pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) and [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied. An application should not assume that pixel data returned by this method uses any particular pixel format or alpha mode (like Rgba8 with premultiplied alpha). Instead, it should always check the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) and [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) properties and handle the data accordingly. As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data. In order to retrieve the correct bitmap pixel width and height, the application should read the [OrientedPixelWidth](bitmapdecoder_orientedpixelwidth.md) and [OrientedPixelHeight](bitmapdecoder_orientedpixelheight.md) properties, instead of the [PixelWidth](bitmapdecoder_pixelwidth.md) and [PixelHeight](bitmapdecoder_pixelheight.md) properties. This method is equivalent to calling the [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getpixeldataasync_580908657.md) method with the following arguments:
ArgumentValue
*pixelFormat*The value of the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) property.
*alphaMode*The value of the [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) property
*transform*A new [BitmapTransform](bitmaptransform.md).
*exifOrientationMode*The [ExifOrientationMode](exiforientationmode.md) value **RespectExifOrientation**.
*colorManagementMode*The [ColorManagementMode](colormanagementmode.md) value **ColorManageToSRgb**.
## -examples ## -see-also [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getpixeldataasync_580908657.md), [PixelDataProvider](pixeldataprovider.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync + +## -description +Asynchronously requests the pixel data for the frame. + +## -returns +Object that manages the asynchronous retrieval of the pixel data. + +## -remarks +The pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) and [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied. + +An application should not assume that pixel data returned by this method uses any particular pixel format or alpha mode (like Rgba8 with premultiplied alpha). Instead, it should always check the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) and [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) properties and handle the data accordingly. + +As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data. + +In order to retrieve the correct bitmap pixel width and height, the application should read the [OrientedPixelWidth](bitmapdecoder_orientedpixelwidth.md) and [OrientedPixelHeight](bitmapdecoder_orientedpixelheight.md) properties, instead of the [PixelWidth](bitmapdecoder_pixelwidth.md) and [PixelHeight](bitmapdecoder_pixelheight.md) properties. + +This method is equivalent to calling the [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getpixeldataasync_580908657.md) method with the following arguments: + + + + + + +
ArgumentValue
*pixelFormat*The value of the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) property.
*alphaMode*The value of the [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) property
*transform*A new [BitmapTransform](bitmaptransform.md).
*exifOrientationMode*The [ExifOrientationMode](exiforientationmode.md) value **RespectExifOrientation**.
*colorManagementMode*The [ColorManagementMode](colormanagementmode.md) value **ColorManageToSRgb**.
+ +## -examples + +## -see-also +[Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getpixeldataasync_580908657.md), [PixelDataProvider](pixeldataprovider.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_580908657.md b/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_580908657.md index c063d4906b..ebfbc47415 100644 --- a/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_580908657.md +++ b/windows.graphics.imaging/bitmapdecoder_getpixeldataasync_580908657.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync ## -description Asynchronously requests the pixel data for the frame using the specified parameters. ## -parameters ### -param pixelFormat The specified pixel format. ### -param alphaMode The specified alpha mode. ### -param transform The set of transformations to be applied to the frame. ### -param exifOrientationMode Indicates whether the EXIF orientation flag should be ignored or respected. ### -param colorManagementMode Indicates whether the pixel data should be color managed to the sRGB color space. ## -returns Object that manages the asynchronous retrieval of the pixel data. ## -remarks This method should be used instead of [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) if the application needs finer grained control over the pixel data array. ## -examples ## -see-also [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetPixelDataAsync + +## -description +Asynchronously requests the pixel data for the frame using the specified parameters. + +## -parameters +### -param pixelFormat +The specified pixel format. + +### -param alphaMode +The specified alpha mode. + +### -param transform +The set of transformations to be applied to the frame. + +### -param exifOrientationMode +Indicates whether the EXIF orientation flag should be ignored or respected. + +### -param colorManagementMode +Indicates whether the pixel data should be color managed to the sRGB color space. + +## -returns +Object that manages the asynchronous retrieval of the pixel data. + +## -remarks +This method should be used instead of [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) if the application needs finer grained control over the pixel data array. + +## -examples + +## -see-also +[Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync](bitmapdecoder_getpixeldataasync_1391309547.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_getpreviewasync_908958483.md b/windows.graphics.imaging/bitmapdecoder_getpreviewasync_908958483.md index d4d29fde94..10fdb52cb7 100644 --- a/windows.graphics.imaging/bitmapdecoder_getpreviewasync_908958483.md +++ b/windows.graphics.imaging/bitmapdecoder_getpreviewasync_908958483.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetPreviewAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetPreviewAsync ## -description Asynchronously returns a stream containing the preview image. ## -returns Object that manages the asynchronous retrieval of the bitmap preview data. The preview data is returned in the form of an image stream. You can display it using an image control, or read and edit it using [BitmapDecoder](bitmapdecoder.md) and [BitmapEncoder](bitmapencoder.md). ## -remarks Some image formats, like JPEG-XR and camera RAW formats, contain an image preview. The preview is generally higher resolution than a thumbnail. This is an advantage because decoding the preview can be faster than decoding the full RAW image, but provides comparable fidelity when displaying images If the image does not contain a preview, this operation fails with HRESULT [WINCODEC_ERR_UNSUPPORTEDOPERATION](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetPreviewAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetPreviewAsync + +## -description +Asynchronously returns a stream containing the preview image. + +## -returns +Object that manages the asynchronous retrieval of the bitmap preview data. + +The preview data is returned in the form of an image stream. You can display it using an image control, or read and edit it using [BitmapDecoder](bitmapdecoder.md) and [BitmapEncoder](bitmapencoder.md). + +## -remarks +Some image formats, like JPEG-XR and camera RAW formats, contain an image preview. The preview is generally higher resolution than a thumbnail. This is an advantage because decoding the preview can be faster than decoding the full RAW image, but provides comparable fidelity when displaying images + +If the image does not contain a preview, this operation fails with HRESULT [WINCODEC_ERR_UNSUPPORTEDOPERATION](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_1163471917.md b/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_1163471917.md index 9f06d41e4c..69661c1d87 100644 --- a/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_1163471917.md +++ b/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_1163471917.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync ## -description Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the decoded bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapdecoder_getsoftwarebitmapasync_994797489.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getsoftwarebitmapasync_892037303.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync + +## -description +Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the decoded bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapdecoder_getsoftwarebitmapasync_994797489.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getsoftwarebitmapasync_892037303.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_892037303.md b/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_892037303.md index 43114bf264..7541a8b3bd 100644 --- a/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_892037303.md +++ b/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_892037303.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync ## -description Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the decoded bitmap. ## -parameters ### -param pixelFormat The pixel format of the software bitmap. ### -param alphaMode The alpha mode of the software bitmap. ### -param transform The transform of the software bitmap. ### -param exifOrientationMode The EXIF orientation mode of the software bitmap. ### -param colorManagementMode The color management mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync](bitmapdecoder_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapdecoder_getsoftwarebitmapasync_994797489.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync + +## -description +Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the decoded bitmap. + +## -parameters +### -param pixelFormat +The pixel format of the software bitmap. + +### -param alphaMode +The alpha mode of the software bitmap. + +### -param transform +The transform of the software bitmap. + +### -param exifOrientationMode +The EXIF orientation mode of the software bitmap. + +### -param colorManagementMode +The color management mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync](bitmapdecoder_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapdecoder_getsoftwarebitmapasync_994797489.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_994797489.md b/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_994797489.md index 1d0094f8fc..a3b7e88168 100644 --- a/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_994797489.md +++ b/windows.graphics.imaging/bitmapdecoder_getsoftwarebitmapasync_994797489.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync ## -description Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the decoded bitmap. ## -parameters ### -param pixelFormat The pixel format of the software bitmap. ### -param alphaMode The alpha mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync](bitmapdecoder_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getsoftwarebitmapasync_892037303.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetSoftwareBitmapAsync + +## -description +Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the decoded bitmap. + +## -parameters +### -param pixelFormat +The pixel format of the software bitmap. + +### -param alphaMode +The alpha mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync](bitmapdecoder_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapdecoder_getsoftwarebitmapasync_892037303.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapdecoder_getthumbnailasync_241227233.md b/windows.graphics.imaging/bitmapdecoder_getthumbnailasync_241227233.md index f6100fb968..eebaa570a3 100644 --- a/windows.graphics.imaging/bitmapdecoder_getthumbnailasync_241227233.md +++ b/windows.graphics.imaging/bitmapdecoder_getthumbnailasync_241227233.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetThumbnailAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapDecoder.GetThumbnailAsync ## -description Asynchronously returns a stream containing the thumbnail image. ## -returns Object that manages the asynchronous retrieval of the thumbnail stream. The thumbnail data is returned in the form of an image stream. You can display it using an image control, or read and edit it using [BitmapDecoder](bitmapdecoder.md) and [BitmapEncoder](bitmapencoder.md) ## -remarks Many image formats, like JPEG and TIFF, allow a small sized thumbnail of the full image to be embedded within a frame. If the image does not contain a thumbnail, then this operation will fail with HRESULT [WINCODEC_ERR_CODECNOTHUMBNAIL](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). If it exists, the EXIF orientation flag on the frame is automatically applied to the thumbnail before it is returned. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapDecoder.GetThumbnailAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GetThumbnailAsync + +## -description +Asynchronously returns a stream containing the thumbnail image. + +## -returns +Object that manages the asynchronous retrieval of the thumbnail stream. + +The thumbnail data is returned in the form of an image stream. You can display it using an image control, or read and edit it using [BitmapDecoder](bitmapdecoder.md) and [BitmapEncoder](bitmapencoder.md) + +## -remarks +Many image formats, like JPEG and TIFF, allow a small sized thumbnail of the full image to be embedded within a frame. If the image does not contain a thumbnail, then this operation will fail with HRESULT [WINCODEC_ERR_CODECNOTHUMBNAIL](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). If it exists, the EXIF orientation flag on the frame is automatically applied to the thumbnail before it is returned. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_gifdecoderid.md b/windows.graphics.imaging/bitmapdecoder_gifdecoderid.md index 4a1ba6e5ba..9d1fb9be26 100644 --- a/windows.graphics.imaging/bitmapdecoder_gifdecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_gifdecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.GifDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.GifDecoderId ## -description The unique identifier of the GIF decoder. ## -property-value The unique identifier of the GIF decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.GifDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.GifDecoderId + +## -description +The unique identifier of the GIF decoder. + +## -property-value +The unique identifier of the GIF decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_icodecoderid.md b/windows.graphics.imaging/bitmapdecoder_icodecoderid.md index 6c8c3208e4..b5be90bc80 100644 --- a/windows.graphics.imaging/bitmapdecoder_icodecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_icodecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.IcoDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.IcoDecoderId ## -description The unique identifier of the ICO decoder. ## -property-value The unique identifier of the ICO decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.IcoDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.IcoDecoderId + +## -description +The unique identifier of the ICO decoder. + +## -property-value +The unique identifier of the ICO decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_jpegdecoderid.md b/windows.graphics.imaging/bitmapdecoder_jpegdecoderid.md index 7b1851f846..933cb27038 100644 --- a/windows.graphics.imaging/bitmapdecoder_jpegdecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_jpegdecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.JpegDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.JpegDecoderId ## -description The unique identifier of the JPEG decoder. ## -property-value The unique identifier of the JPEG decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.JpegDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.JpegDecoderId + +## -description +The unique identifier of the JPEG decoder. + +## -property-value +The unique identifier of the JPEG decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_jpegxrdecoderid.md b/windows.graphics.imaging/bitmapdecoder_jpegxrdecoderid.md index 09f9bc7729..395db2efbb 100644 --- a/windows.graphics.imaging/bitmapdecoder_jpegxrdecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_jpegxrdecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.JpegXRDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.JpegXRDecoderId ## -description The unique identifier of the JPEG-XR decoder. ## -property-value The unique identifier of the JPEG-XR decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.JpegXRDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.JpegXRDecoderId + +## -description +The unique identifier of the JPEG-XR decoder. + +## -property-value +The unique identifier of the JPEG-XR decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_orientedpixelheight.md b/windows.graphics.imaging/bitmapdecoder_orientedpixelheight.md index cda992b2fc..2e4008313b 100644 --- a/windows.graphics.imaging/bitmapdecoder_orientedpixelheight.md +++ b/windows.graphics.imaging/bitmapdecoder_orientedpixelheight.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelHeight ## -description The height of the first frame in pixels, after any EXIF orientation has been applied to the bitmap. ## -property-value The height of the first frame in pixels, after any EXIF orientation has been applied. ## -remarks Use this property if you need to know the height of an image or of pixel data that has EXIF orientation applied, for example, if you call [GetPixelDataAsync](bitmapdecoder_getpixeldataasync.md) and specify **RespectExifOrientation**. Also, the [HTML img element](XREF:TODO:wwa.images_Object) in Windows app using JavaScript, and [Windows.UI.Xaml.Controls.Image](../windows.ui.xaml.controls/image.md) respect EXIF orientation. If you need pixel dimensions of the image as it is natively stored, use the [PixelHeight](bitmapdecoder_pixelheight.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelHeight + +## -description +The height of the first frame in pixels, after any EXIF orientation has been applied to the bitmap. + +## -property-value +The height of the first frame in pixels, after any EXIF orientation has been applied. + +## -remarks +Use this property if you need to know the height of an image or of pixel data that has EXIF orientation applied, for example, if you call [GetPixelDataAsync](bitmapdecoder_getpixeldataasync.md) and specify **RespectExifOrientation**. Also, the [HTML img element](XREF:TODO:wwa.images_Object) in Windows app using JavaScript, and [Windows.UI.Xaml.Controls.Image](../windows.ui.xaml.controls/image.md) respect EXIF orientation. + +If you need pixel dimensions of the image as it is natively stored, use the [PixelHeight](bitmapdecoder_pixelheight.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_orientedpixelwidth.md b/windows.graphics.imaging/bitmapdecoder_orientedpixelwidth.md index 0162541b0e..46d00ce507 100644 --- a/windows.graphics.imaging/bitmapdecoder_orientedpixelwidth.md +++ b/windows.graphics.imaging/bitmapdecoder_orientedpixelwidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelWidth ## -description The width of the first frame in pixels, after any EXIF orientation has been applied to the bitmap. ## -property-value The width of the first frame in pixels, after any EXIF orientation has been applied. ## -remarks Use this property in the same way as [OrientedPixelHeight](bitmapdecoder_orientedpixelheight.md) is used if you need to know the width of an image or of pixel data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.OrientedPixelWidth + +## -description +The width of the first frame in pixels, after any EXIF orientation has been applied to the bitmap. + +## -property-value +The width of the first frame in pixels, after any EXIF orientation has been applied. + +## -remarks +Use this property in the same way as [OrientedPixelHeight](bitmapdecoder_orientedpixelheight.md) is used if you need to know the width of an image or of pixel data. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_pixelheight.md b/windows.graphics.imaging/bitmapdecoder_pixelheight.md index 0d741cb580..e8f17c1780 100644 --- a/windows.graphics.imaging/bitmapdecoder_pixelheight.md +++ b/windows.graphics.imaging/bitmapdecoder_pixelheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.PixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.PixelHeight ## -description The height of the first frame in pixels. ## -property-value The height of the first frame in pixels. ## -remarks Use [PixelHeight](bitmapdecoder_pixelheight.md) for pixel dimensions of the image as it is natively stored. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.PixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.PixelHeight + +## -description +The height of the first frame in pixels. + +## -property-value +The height of the first frame in pixels. + +## -remarks +Use [PixelHeight](bitmapdecoder_pixelheight.md) for pixel dimensions of the image as it is natively stored. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_pixelwidth.md b/windows.graphics.imaging/bitmapdecoder_pixelwidth.md index 1b62454aed..4c063a2fef 100644 --- a/windows.graphics.imaging/bitmapdecoder_pixelwidth.md +++ b/windows.graphics.imaging/bitmapdecoder_pixelwidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.PixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.PixelWidth ## -description The width of the first frame in pixels. ## -property-value The width of the first frame in pixels. ## -remarks Use [PixelWidth](bitmapdecoder_pixelwidth.md) for pixel dimensions of the image as it is natively stored. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.PixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.PixelWidth + +## -description +The width of the first frame in pixels. + +## -property-value +The width of the first frame in pixels. + +## -remarks +Use [PixelWidth](bitmapdecoder_pixelwidth.md) for pixel dimensions of the image as it is natively stored. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_pngdecoderid.md b/windows.graphics.imaging/bitmapdecoder_pngdecoderid.md index 74169f1b82..e48dec8b92 100644 --- a/windows.graphics.imaging/bitmapdecoder_pngdecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_pngdecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.PngDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.PngDecoderId ## -description The unique identifier of the PNG decoder. ## -property-value The unique identifier of the PNG decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.PngDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.PngDecoderId + +## -description +The unique identifier of the PNG decoder. + +## -property-value +The unique identifier of the PNG decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapdecoder_tiffdecoderid.md b/windows.graphics.imaging/bitmapdecoder_tiffdecoderid.md index 9eab6176da..2ab3f536b8 100644 --- a/windows.graphics.imaging/bitmapdecoder_tiffdecoderid.md +++ b/windows.graphics.imaging/bitmapdecoder_tiffdecoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapDecoder.TiffDecoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapDecoder.TiffDecoderId ## -description The unique identifier of the TIFF decoder. ## -property-value The unique identifier of the TIFF decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapDecoder.TiffDecoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapDecoder.TiffDecoderId + +## -description +The unique identifier of the TIFF decoder. + +## -property-value +The unique identifier of the TIFF decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_bitmapcontainerproperties.md b/windows.graphics.imaging/bitmapencoder_bitmapcontainerproperties.md index fd9859fbb1..7f1e22bec0 100644 --- a/windows.graphics.imaging/bitmapencoder_bitmapcontainerproperties.md +++ b/windows.graphics.imaging/bitmapencoder_bitmapcontainerproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BitmapContainerProperties --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.BitmapContainerProperties ## -description The metadata for the container. ## -property-value A [BitmapProperties](bitmapproperties.md) object that provides both read and write access to the metadata for the container. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BitmapContainerProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.BitmapContainerProperties + +## -description +The metadata for the container. + +## -property-value +A [BitmapProperties](bitmapproperties.md) object that provides both read and write access to the metadata for the container. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_bitmapproperties.md b/windows.graphics.imaging/bitmapencoder_bitmapproperties.md index b04d42178a..e16f787761 100644 --- a/windows.graphics.imaging/bitmapencoder_bitmapproperties.md +++ b/windows.graphics.imaging/bitmapencoder_bitmapproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BitmapProperties --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.BitmapProperties ## -description The metadata for the selected frame. ## -property-value A [BitmapProperties](bitmapproperties.md) object that provides both read and write access to the metadata for the selected frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BitmapProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.BitmapProperties + +## -description +The metadata for the selected frame. + +## -property-value +A [BitmapProperties](bitmapproperties.md) object that provides both read and write access to the metadata for the selected frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_bitmaptransform.md b/windows.graphics.imaging/bitmapencoder_bitmaptransform.md index ca2bc07506..33c54f11f0 100644 --- a/windows.graphics.imaging/bitmapencoder_bitmaptransform.md +++ b/windows.graphics.imaging/bitmapencoder_bitmaptransform.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BitmapTransform --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.BitmapTransform ## -description A [BitmapTransform](bitmaptransform.md) object that is used to specify how the frame bitmap is to be transformed. ## -property-value A [BitmapTransform](bitmaptransform.md) object that is used to specify how the frame bitmap is to be transformed. ## -remarks If you try scale an image stored in an indexed pixel format using the [BitmapTransform](bitmaptransform.md) member, [FlushAsync](bitmapencoder_flushasync.md) fails with HRESULT [WINCODEC_ERR_INVALIDPARAMETER](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6) . Instead, you must use [GetPixelDataAsync](bitmapdecoder_getpixeldataasync.md) to obtain the scaled pixel data and then use [SetPixelData](bitmapencoder_setpixeldata.md) to set it on the encoder. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BitmapTransform +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.BitmapTransform + +## -description +A [BitmapTransform](bitmaptransform.md) object that is used to specify how the frame bitmap is to be transformed. + +## -property-value +A [BitmapTransform](bitmaptransform.md) object that is used to specify how the frame bitmap is to be transformed. + +## -remarks +If you try scale an image stored in an indexed pixel format using the [BitmapTransform](bitmaptransform.md) member, [FlushAsync](bitmapencoder_flushasync.md) fails with HRESULT [WINCODEC_ERR_INVALIDPARAMETER](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6) . Instead, you must use [GetPixelDataAsync](bitmapdecoder_getpixeldataasync.md) to obtain the scaled pixel data and then use [SetPixelData](bitmapencoder_setpixeldata.md) to set it on the encoder. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_bmpencoderid.md b/windows.graphics.imaging/bitmapencoder_bmpencoderid.md index 37fe4cb727..5e28b7c8b1 100644 --- a/windows.graphics.imaging/bitmapencoder_bmpencoderid.md +++ b/windows.graphics.imaging/bitmapencoder_bmpencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BmpEncoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.BmpEncoderId ## -description The unique identifier of the built-in BMP encoder. ## -property-value The unique identifier of the built-in BMP encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.BmpEncoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.BmpEncoderId + +## -description +The unique identifier of the built-in BMP encoder. + +## -property-value +The unique identifier of the built-in BMP encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_createasync_1315566040.md b/windows.graphics.imaging/bitmapencoder_createasync_1315566040.md index 54549c68ce..f6dc4fc508 100644 --- a/windows.graphics.imaging/bitmapencoder_createasync_1315566040.md +++ b/windows.graphics.imaging/bitmapencoder_createasync_1315566040.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateAsync(System.Guid,Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.CreateAsync ## -description Asynchronously creates a new [BitmapEncoder](bitmapencoder.md). ## -parameters ### -param encoderId The unique identifier of the specified encoder. ### -param stream The output stream. ## -returns An object that manages the asynchronous creation of a new [BitmapEncoder](bitmapencoder.md). ## -remarks An application must always specify the *encoderId* in order to create a [BitmapEncoder](bitmapencoder.md). The unique identifiers of the built-in encoders are available as properties on [BitmapEncoder](bitmapencoder.md). In addition, the unique identifier of any installed encoder can be obtained by using the [GetEncoderInformationEnumerator](bitmapencoder_getencoderinformationenumerator.md) method. [BitmapEncoder](bitmapencoder.md) expects that the output stream is empty. You can ensure that the stream is empty by setting its [Size](../windows.storage.streams/irandomaccessstream_size.md) property to 0. ## -examples ## -see-also [CreateAsync(Guid, IRandomAccessStream,IIterable(IKeyValuePair))](bitmapencoder_createasync_415643468.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateAsync(System.Guid,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.CreateAsync + +## -description +Asynchronously creates a new [BitmapEncoder](bitmapencoder.md). + +## -parameters +### -param encoderId +The unique identifier of the specified encoder. + +### -param stream +The output stream. + +## -returns +An object that manages the asynchronous creation of a new [BitmapEncoder](bitmapencoder.md). + +## -remarks +An application must always specify the *encoderId* in order to create a [BitmapEncoder](bitmapencoder.md). The unique identifiers of the built-in encoders are available as properties on [BitmapEncoder](bitmapencoder.md). In addition, the unique identifier of any installed encoder can be obtained by using the [GetEncoderInformationEnumerator](bitmapencoder_getencoderinformationenumerator.md) method. + +[BitmapEncoder](bitmapencoder.md) expects that the output stream is empty. You can ensure that the stream is empty by setting its [Size](../windows.storage.streams/irandomaccessstream_size.md) property to 0. + +## -examples + +## -see-also +[CreateAsync(Guid, IRandomAccessStream,IIterable(IKeyValuePair))](bitmapencoder_createasync_415643468.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapencoder_createasync_415643468.md b/windows.graphics.imaging/bitmapencoder_createasync_415643468.md index f25125f6df..f939b2befd 100644 --- a/windows.graphics.imaging/bitmapencoder_createasync_415643468.md +++ b/windows.graphics.imaging/bitmapencoder_createasync_415643468.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateAsync(System.Guid,Windows.Storage.Streams.IRandomAccessStream,Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Graphics.Imaging.BitmapTypedValue}}) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.CreateAsync ## -description Asynchronously creates a new [BitmapEncoder](bitmapencoder.md) for the specified codec with the specified encoding options and initializes it on a stream. ## -parameters ### -param encoderId The unique identifier of the specified encoder. ### -param stream A stream representing where the image file is to be written. ### -param encodingOptions A collection of key-value pairs containing one or more codec-specific encoding options and the desired values. ## -returns An object that manages the asynchronous creation of a new [BitmapEncoder](bitmapencoder.md). ## -remarks ## -examples ## -see-also [BitmapPropertySet](bitmappropertyset.md), [BitmapTypedValue](bitmaptypedvalue.md), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [CreateAsync(Guid, IRandomAccessStream)](bitmapencoder_createasync_1315566040.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateAsync(System.Guid,Windows.Storage.Streams.IRandomAccessStream,Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Graphics.Imaging.BitmapTypedValue}}) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.CreateAsync + +## -description +Asynchronously creates a new [BitmapEncoder](bitmapencoder.md) for the specified codec with the specified encoding options and initializes it on a stream. + +## -parameters +### -param encoderId +The unique identifier of the specified encoder. + +### -param stream +A stream representing where the image file is to be written. + +### -param encodingOptions +A collection of key-value pairs containing one or more codec-specific encoding options and the desired values. + +## -returns +An object that manages the asynchronous creation of a new [BitmapEncoder](bitmapencoder.md). + +## -remarks + +## -examples + +## -see-also +[BitmapPropertySet](bitmappropertyset.md), [BitmapTypedValue](bitmaptypedvalue.md), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [CreateAsync(Guid, IRandomAccessStream)](bitmapencoder_createasync_1315566040.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapencoder_createforinplacepropertyencodingasync_1069000443.md b/windows.graphics.imaging/bitmapencoder_createforinplacepropertyencodingasync_1069000443.md index 81d14d7556..9adf41a5bf 100644 --- a/windows.graphics.imaging/bitmapencoder_createforinplacepropertyencodingasync_1069000443.md +++ b/windows.graphics.imaging/bitmapencoder_createforinplacepropertyencodingasync_1069000443.md @@ -1,3 +1,49 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateForInPlacePropertyEncodingAsync(Windows.Graphics.Imaging.BitmapDecoder) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.CreateForInPlacePropertyEncodingAsync ## -description Asynchronously creates a new [BitmapEncoder](bitmapencoder.md) for in-place property and metadata editing. The new encoder can only edit bitmap properties in-place and will fail for any other uses. ## -parameters ### -param bitmapDecoder A [BitmapDecoder](bitmapdecoder.md) containing the image data to be edited. This parameter must be created on a stream with an access mode of [ReadWrite](../windows.storage/fileaccessmode.md). > [!NOTE] > The encoder writes to the stream that the original [BitmapDecoder](bitmapdecoder.md) was created on. You can't specify an output stream. ## -returns An object that manages the asynchronous initialization of a new [BitmapEncoder](bitmapencoder.md) using data from an existing [BitmapDecoder](bitmapdecoder.md). ## -remarks Use this method to retrieve an encoder when you are only going to use it to edit or write a limited amount of properties to the image. An encoder retrieved this way can provide a performance advantage over an encoder returned by [CreateForTranscodingAsync](bitmapencoder_createfortranscodingasync.md) because it writes the new properties to empty padding space instead of encoding the entire image again. Here are several limitations to an encoder retrieved this way: + You can only use these methods on the encoder: + [BitmapEncoder::BitmapProperties::GetPropertiesAsync](bitmapproperties_getpropertiesasync.md) + [BitmapEncoder::BitmapProperties::SetPropertiesAsync](bitmapproperties_setpropertiesasync.md) + [BitmapEncoder::FlushAsync](bitmapencoder_flushasync.md) Any other methods will fail if you call them. + The input [BitmapDecoder](bitmapdecoder.md) must be an encoder created on a stream with [ReadWrite](../windows.storage/fileaccessmode.md) access. + Not all metadata formats support fast metadata encoding. The native metadata handlers that support metadata are IFD, Exif, XMP, and GPS. + The metadata block must have enough padding to store the properties that you are trying to edit. If an encoding operation fails for any reason, you will have to use [CreateForTranscodingAsync](bitmapencoder_createfortranscodingasync.md) to edit the metadata and re-encode the image. When you re-encode, you can also add new or additional padding to enable in-place property encoding in the future. To do this, create a new [BitmapTypedValue](bitmaptypedvalue.md) with Type set to UInt32 and Value set to the number of bytes of padding you wish to add. A typical value is 4096 bytes. Set this metadata item on one or more of the metadata query locations in this table.
Metadata formatJPEG metadata queryTIFF, JPEG-XR metadata query
IFD/app1/ifd/PaddingSchema:Padding/ifd/PaddingSchema:Padding
EXIF/app1/ifd/exif/PaddingSchema:Padding/ifd/exif/PaddingSchema:Padding
XMP/xmp/PaddingSchema:Padding/ifd/xmp/PaddingSchema:Padding
GPS/app1/ifd/gps/PaddingSchema:Padding/ifd/gps/PaddingSchema:Padding
## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateForInPlacePropertyEncodingAsync(Windows.Graphics.Imaging.BitmapDecoder) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.CreateForInPlacePropertyEncodingAsync + +## -description +Asynchronously creates a new [BitmapEncoder](bitmapencoder.md) for in-place property and metadata editing. The new encoder can only edit bitmap properties in-place and will fail for any other uses. + +## -parameters +### -param bitmapDecoder +A [BitmapDecoder](bitmapdecoder.md) containing the image data to be edited. This parameter must be created on a stream with an access mode of [ReadWrite](../windows.storage/fileaccessmode.md). + +> [!NOTE] +> The encoder writes to the stream that the original [BitmapDecoder](bitmapdecoder.md) was created on. You can't specify an output stream. + +## -returns +An object that manages the asynchronous initialization of a new [BitmapEncoder](bitmapencoder.md) using data from an existing [BitmapDecoder](bitmapdecoder.md). + +## -remarks +Use this method to retrieve an encoder when you are only going to use it to edit or write a limited amount of properties to the image. An encoder retrieved this way can provide a performance advantage over an encoder returned by [CreateForTranscodingAsync](bitmapencoder_createfortranscodingasync.md) because it writes the new properties to empty padding space instead of encoding the entire image again. + +Here are several limitations to an encoder retrieved this way: + + ++ You can only use these methods on the encoder: + + [BitmapEncoder::BitmapProperties::GetPropertiesAsync](bitmapproperties_getpropertiesasync.md) + + [BitmapEncoder::BitmapProperties::SetPropertiesAsync](bitmapproperties_setpropertiesasync.md) + + [BitmapEncoder::FlushAsync](bitmapencoder_flushasync.md) + Any other methods will fail if you call them. ++ The input [BitmapDecoder](bitmapdecoder.md) must be an encoder created on a stream with [ReadWrite](../windows.storage/fileaccessmode.md) access. ++ Not all metadata formats support fast metadata encoding. The native metadata handlers that support metadata are IFD, Exif, XMP, and GPS. ++ The metadata block must have enough padding to store the properties that you are trying to edit. +If an encoding operation fails for any reason, you will have to use [CreateForTranscodingAsync](bitmapencoder_createfortranscodingasync.md) to edit the metadata and re-encode the image. When you re-encode, you can also add new or additional padding to enable in-place property encoding in the future. To do this, create a new [BitmapTypedValue](bitmaptypedvalue.md) with Type set to UInt32 and Value set to the number of bytes of padding you wish to add. A typical value is 4096 bytes. Set this metadata item on one or more of the metadata query locations in this table. + + + + + +
Metadata formatJPEG metadata queryTIFF, JPEG-XR metadata query
IFD/app1/ifd/PaddingSchema:Padding/ifd/PaddingSchema:Padding
EXIF/app1/ifd/exif/PaddingSchema:Padding/ifd/exif/PaddingSchema:Padding
XMP/xmp/PaddingSchema:Padding/ifd/xmp/PaddingSchema:Padding
GPS/app1/ifd/gps/PaddingSchema:Padding/ifd/gps/PaddingSchema:Padding
+ +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_createfortranscodingasync_1673967352.md b/windows.graphics.imaging/bitmapencoder_createfortranscodingasync_1673967352.md index 0220d10e5f..51fe40df40 100644 --- a/windows.graphics.imaging/bitmapencoder_createfortranscodingasync_1673967352.md +++ b/windows.graphics.imaging/bitmapencoder_createfortranscodingasync_1673967352.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateForTranscodingAsync(Windows.Storage.Streams.IRandomAccessStream,Windows.Graphics.Imaging.BitmapDecoder) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.CreateForTranscodingAsync ## -description Asynchronously creates a new [BitmapEncoder](bitmapencoder.md) and initializes it using data from an existing [BitmapDecoder](bitmapdecoder.md). ## -parameters ### -param stream The output stream. ### -param bitmapDecoder A [BitmapDecoder](bitmapdecoder.md) containing the image data to be copied. ## -returns An object that manages the asynchronous creation of a new [BitmapEncoder](bitmapencoder.md) using data from an existing [BitmapDecoder](bitmapdecoder.md). ## -remarks Call this method when you want to edit some elements in an image but want to preserve the rest of the data intact. For example, if you want to write some metadata or properties but don't want to touch the image itself. When you create a [BitmapEncoder](bitmapencoder.md) using this method, it is initialized using data from the *bitmapDecoder* argument. Any data that you set on the encoder will overwrite the existing data, and all other data is preserved unchanged. This method only allows you to create an encoder of the same image format as the decoder. ## -examples ## -see-also [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.CreateForTranscodingAsync(Windows.Storage.Streams.IRandomAccessStream,Windows.Graphics.Imaging.BitmapDecoder) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.CreateForTranscodingAsync + +## -description +Asynchronously creates a new [BitmapEncoder](bitmapencoder.md) and initializes it using data from an existing [BitmapDecoder](bitmapdecoder.md). + +## -parameters +### -param stream +The output stream. + +### -param bitmapDecoder +A [BitmapDecoder](bitmapdecoder.md) containing the image data to be copied. + +## -returns +An object that manages the asynchronous creation of a new [BitmapEncoder](bitmapencoder.md) using data from an existing [BitmapDecoder](bitmapdecoder.md). + +## -remarks +Call this method when you want to edit some elements in an image but want to preserve the rest of the data intact. For example, if you want to write some metadata or properties but don't want to touch the image itself. When you create a [BitmapEncoder](bitmapencoder.md) using this method, it is initialized using data from the *bitmapDecoder* argument. Any data that you set on the encoder will overwrite the existing data, and all other data is preserved unchanged. + +This method only allows you to create an encoder of the same image format as the decoder. + +## -examples + +## -see-also +[Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapencoder_encoderinformation.md b/windows.graphics.imaging/bitmapencoder_encoderinformation.md index c0a6c66b1c..66f617110f 100644 --- a/windows.graphics.imaging/bitmapencoder_encoderinformation.md +++ b/windows.graphics.imaging/bitmapencoder_encoderinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.EncoderInformation --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.EncoderInformation ## -description Information about the bitmap encoder. ## -property-value An object containing information about the bitmap encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.EncoderInformation +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.EncoderInformation + +## -description +Information about the bitmap encoder. + +## -property-value +An object containing information about the bitmap encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_flushasync_491532439.md b/windows.graphics.imaging/bitmapencoder_flushasync_491532439.md index 000ef6a429..abc2d7cbd2 100644 --- a/windows.graphics.imaging/bitmapencoder_flushasync_491532439.md +++ b/windows.graphics.imaging/bitmapencoder_flushasync_491532439.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.FlushAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.FlushAsync ## -description Asynchronously commits and flushes all of the image data. ## -returns An object that manages the asynchronous flush operation. ## -remarks Call this method when you are done encoding and before you close the output stream. The minimum data you need to set on a new image before calling [FlushAsync](bitmapencoder_flushasync.md) is the pixel data ([SetPixelData](bitmapencoder_setpixeldata.md)). After this method is called, any subsequent calls to [BitmapEncoder](bitmapencoder.md) methods will fail. If, after encoding is complete, you want to reuse the [IRandomAccessStream](http://msdn.microsoft.com/library/d2eceb3d-d13e-44c1-bfe2-1aa57f7432c6) from which the [BitmapEncoder](bitmapencoder.md) was created, such as passing it to the [Windows.Storage.Compression](../windows.storage.compression/windows_storage_compression.md) APIs, you must first reset the stream's seek position to 0, the start of the stream, by calling [IRandomAccessStream::Seek](../windows.storage.streams/irandomaccessstream_seek.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.FlushAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.FlushAsync + +## -description +Asynchronously commits and flushes all of the image data. + +## -returns +An object that manages the asynchronous flush operation. + +## -remarks +Call this method when you are done encoding and before you close the output stream. The minimum data you need to set on a new image before calling [FlushAsync](bitmapencoder_flushasync.md) is the pixel data ([SetPixelData](bitmapencoder_setpixeldata.md)). After this method is called, any subsequent calls to [BitmapEncoder](bitmapencoder.md) methods will fail. + +If, after encoding is complete, you want to reuse the [IRandomAccessStream](http://msdn.microsoft.com/library/d2eceb3d-d13e-44c1-bfe2-1aa57f7432c6) from which the [BitmapEncoder](bitmapencoder.md) was created, such as passing it to the [Windows.Storage.Compression](../windows.storage.compression/windows_storage_compression.md) APIs, you must first reset the stream's seek position to 0, the start of the stream, by calling [IRandomAccessStream::Seek](../windows.storage.streams/irandomaccessstream_seek.md). + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_generatedthumbnailheight.md b/windows.graphics.imaging/bitmapencoder_generatedthumbnailheight.md index 358d725ceb..24c7214352 100644 --- a/windows.graphics.imaging/bitmapencoder_generatedthumbnailheight.md +++ b/windows.graphics.imaging/bitmapencoder_generatedthumbnailheight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailHeight ## -description The height, in pixels, of any generated thumbnail. ## -property-value The height of the thumbnail, in pixels. The default value is 120 pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailHeight + +## -description +The height, in pixels, of any generated thumbnail. + +## -property-value +The height of the thumbnail, in pixels. The default value is 120 pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_generatedthumbnailwidth.md b/windows.graphics.imaging/bitmapencoder_generatedthumbnailwidth.md index b2e14b6e99..000d219370 100644 --- a/windows.graphics.imaging/bitmapencoder_generatedthumbnailwidth.md +++ b/windows.graphics.imaging/bitmapencoder_generatedthumbnailwidth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailWidth ## -description The width, in pixels, of any generated thumbnail. ## -property-value The width of the thumbnail, in pixels. The default value is 160 pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.GeneratedThumbnailWidth + +## -description +The width, in pixels, of any generated thumbnail. + +## -property-value +The width of the thumbnail, in pixels. The default value is 160 pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_getencoderinformationenumerator_1011982973.md b/windows.graphics.imaging/bitmapencoder_getencoderinformationenumerator_1011982973.md index 283ce59222..c5b4b7d1cd 100644 --- a/windows.graphics.imaging/bitmapencoder_getencoderinformationenumerator_1011982973.md +++ b/windows.graphics.imaging/bitmapencoder_getencoderinformationenumerator_1011982973.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.GetEncoderInformationEnumerator --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.GetEncoderInformationEnumerator ## -description A list of the bitmap encoders installed on the system and information about them. ## -returns A list of [BitmapCodecInformation](bitmapcodecinformation.md) objects containing information about each encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.GetEncoderInformationEnumerator +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.GetEncoderInformationEnumerator + +## -description +A list of the bitmap encoders installed on the system and information about them. + +## -returns +A list of [BitmapCodecInformation](bitmapcodecinformation.md) objects containing information about each encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_gifencoderid.md b/windows.graphics.imaging/bitmapencoder_gifencoderid.md index 2a2a76fda3..dec35a5f97 100644 --- a/windows.graphics.imaging/bitmapencoder_gifencoderid.md +++ b/windows.graphics.imaging/bitmapencoder_gifencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.GifEncoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.GifEncoderId ## -description The unique identifier of the built-in GIF encoder. ## -property-value The unique identifier of the built-in GIF encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.GifEncoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.GifEncoderId + +## -description +The unique identifier of the built-in GIF encoder. + +## -property-value +The unique identifier of the built-in GIF encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_gotonextframeasync_1063265177.md b/windows.graphics.imaging/bitmapencoder_gotonextframeasync_1063265177.md index fd5240ee1c..ffdad647cb 100644 --- a/windows.graphics.imaging/bitmapencoder_gotonextframeasync_1063265177.md +++ b/windows.graphics.imaging/bitmapencoder_gotonextframeasync_1063265177.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Graphics.Imaging.BitmapTypedValue}}) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync ## -description Asynchronously commits the current frame data and appends a new empty frame, with the specified encoding options, to be edited. ## -parameters ### -param encodingOptions The specified encoding options. A collection of key-value pairs containing one or more codec-specific encoding options and the desired values. ## -returns An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited. ## -remarks You can obtain a collection of key-value pairs that you can pass to the *encodingOptions* parameter by creating a new [BitmapPropertySet](bitmappropertyset.md). See [CreateAsync(Guid, IRandomAccessStream, IIterable(IKeyValuePair))](bitmapencoder_createasync_415643468.md) for more information about using encoding options. ## -examples ## -see-also [BitmapPropertySet](bitmappropertyset.md), [GoToNextFrameAsync](bitmapencoder_gotonextframeasync_718000702.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Graphics.Imaging.BitmapTypedValue}}) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync + +## -description +Asynchronously commits the current frame data and appends a new empty frame, with the specified encoding options, to be edited. + +## -parameters +### -param encodingOptions +The specified encoding options. A collection of key-value pairs containing one or more codec-specific encoding options and the desired values. + +## -returns +An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited. + +## -remarks +You can obtain a collection of key-value pairs that you can pass to the *encodingOptions* parameter by creating a new [BitmapPropertySet](bitmappropertyset.md). + +See [CreateAsync(Guid, IRandomAccessStream, IIterable(IKeyValuePair))](bitmapencoder_createasync_415643468.md) for more information about using encoding options. + +## -examples + +## -see-also +[BitmapPropertySet](bitmappropertyset.md), [GoToNextFrameAsync](bitmapencoder_gotonextframeasync_718000702.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapencoder_gotonextframeasync_718000702.md b/windows.graphics.imaging/bitmapencoder_gotonextframeasync_718000702.md index 5adc745658..55fc767341 100644 --- a/windows.graphics.imaging/bitmapencoder_gotonextframeasync_718000702.md +++ b/windows.graphics.imaging/bitmapencoder_gotonextframeasync_718000702.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync ## -description Asynchronously commits the current frame data and appends a new empty frame to be edited. ## -returns An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited. ## -remarks After this method is called, data on the just-committed frame is no longer accessible. Instead, a new, empty frame is appended to the image and subsequent reads and writes on the [BitmapEncoder](bitmapencoder.md) will access this frame. You can't "rewind" to a previously committed frame. Don't call this method if the current frame is intended to be the last frame in the image, as this will result in a superfluous, empty frame at the end of the image. Instead, call [FlushAsync](bitmapencoder_flushasync.md) which will commit the frame and close the entire [BitmapEncoder](bitmapencoder.md). For example, in most scenarios the application only needs to save a single-frame image. In these cases [GoToNextFrameAsync](bitmapencoder_gotonextframeasync_718000702.md) should never be called. The first time this method is called, all container level data as well as the first frame data is committed. Afterwards, any attempts to access container level data will fail. ## -examples ## -see-also [GoToNextFrameAsync(IIterable(IKeyValuePair))](bitmapencoder_gotonextframeasync_1063265177.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.GoToNextFrameAsync + +## -description +Asynchronously commits the current frame data and appends a new empty frame to be edited. + +## -returns +An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited. + +## -remarks +After this method is called, data on the just-committed frame is no longer accessible. Instead, a new, empty frame is appended to the image and subsequent reads and writes on the [BitmapEncoder](bitmapencoder.md) will access this frame. You can't "rewind" to a previously committed frame. + +Don't call this method if the current frame is intended to be the last frame in the image, as this will result in a superfluous, empty frame at the end of the image. Instead, call [FlushAsync](bitmapencoder_flushasync.md) which will commit the frame and close the entire [BitmapEncoder](bitmapencoder.md). For example, in most scenarios the application only needs to save a single-frame image. In these cases [GoToNextFrameAsync](bitmapencoder_gotonextframeasync_718000702.md) should never be called. + +The first time this method is called, all container level data as well as the first frame data is committed. Afterwards, any attempts to access container level data will fail. + +## -examples + +## -see-also +[GoToNextFrameAsync(IIterable(IKeyValuePair))](bitmapencoder_gotonextframeasync_1063265177.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapencoder_isthumbnailgenerated.md b/windows.graphics.imaging/bitmapencoder_isthumbnailgenerated.md index 7da39589c9..c1b1890fc0 100644 --- a/windows.graphics.imaging/bitmapencoder_isthumbnailgenerated.md +++ b/windows.graphics.imaging/bitmapencoder_isthumbnailgenerated.md @@ -1,3 +1,58 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.IsThumbnailGenerated --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.IsThumbnailGenerated ## -description Indicates whether or not a new thumbnail is automatically generated. ## -property-value A value that indicates whether or not the bitmap encoder will automatically generate a new thumbnail. The default value is False. ## -remarks When this value is true, the bitmap encoder will generate a new thumbnail by downscaling the frame bitmap. The thumbnail size is determined by the [GeneratedThumbnailWidth](bitmapencoder_generatedthumbnailwidth.md) and [GeneratedThumbnailHeight](bitmapencoder_generatedthumbnailheight.md) properties. When this value is false, no thumbnail is written to the file. If the [BitmapEncoder](bitmapencoder.md) was created using the [CreateForTranscodingAsync](bitmapencoder_createfortranscodingasync.md) method and **IsThumbnailGenerated** is false, the bitmap encoder will leave any existing thumbnail data untouched. In this case, if the bitmap was modified before encoding, it's possible for the output file to have a thumbnail that does not match the new contents of the image. Only JPEG, TIFF and JPEG-XR image types support encoding thumbnails. If the image format being encoded does not support thumbnails and you set **IsThumbnailGenerated** to true, then the call to [FlushAsync](bitmapencoder_flushasync.md) will fail with HRESULT [WINCODEC_ERR_UNSUPPORTEDOPERATION](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). You should catch this exception and retry encoding with thumbnail generation disabled. If your app only encodes image formats that support thumbnails, you can skip this step. ```csharp try { await encoder.FlushAsync(); } catch (Exception err) { switch (err.HResult) { case unchecked ((int) 0x88982F81): //WINCODEC_ERR_UNSUPPORTEDOPERATION // If the encoder does not support writing a thumbnail, then try again // but disable thumbnail generation. encoder.IsThumbnailGenerated = false; break; default: throw err; } } if (encoder.IsThumbnailGenerated == false) { await encoder.FlushAsync(); } ``` ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.IsThumbnailGenerated +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.IsThumbnailGenerated + +## -description +Indicates whether or not a new thumbnail is automatically generated. + +## -property-value +A value that indicates whether or not the bitmap encoder will automatically generate a new thumbnail. The default value is False. + +## -remarks +When this value is true, the bitmap encoder will generate a new thumbnail by downscaling the frame bitmap. The thumbnail size is determined by the [GeneratedThumbnailWidth](bitmapencoder_generatedthumbnailwidth.md) and [GeneratedThumbnailHeight](bitmapencoder_generatedthumbnailheight.md) properties. When this value is false, no thumbnail is written to the file. + +If the [BitmapEncoder](bitmapencoder.md) was created using the [CreateForTranscodingAsync](bitmapencoder_createfortranscodingasync.md) method and **IsThumbnailGenerated** is false, the bitmap encoder will leave any existing thumbnail data untouched. In this case, if the bitmap was modified before encoding, it's possible for the output file to have a thumbnail that does not match the new contents of the image. + +Only JPEG, TIFF and JPEG-XR image types support encoding thumbnails. If the image format being encoded does not support thumbnails and you set **IsThumbnailGenerated** to true, then the call to [FlushAsync](bitmapencoder_flushasync.md) will fail with HRESULT [WINCODEC_ERR_UNSUPPORTEDOPERATION](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). You should catch this exception and retry encoding with thumbnail generation disabled. If your app only encodes image formats that support thumbnails, you can skip this step. + + + +```csharp + + try + { + await encoder.FlushAsync(); + } + catch (Exception err) + { + switch (err.HResult) + { + case unchecked ((int) 0x88982F81): //WINCODEC_ERR_UNSUPPORTEDOPERATION + // If the encoder does not support writing a thumbnail, then try again + // but disable thumbnail generation. + encoder.IsThumbnailGenerated = false; + break; + default: + throw err; + } + } + + if (encoder.IsThumbnailGenerated == false) + { + await encoder.FlushAsync(); + } + +``` + + + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_jpegencoderid.md b/windows.graphics.imaging/bitmapencoder_jpegencoderid.md index bc726d3ff3..3db5e3c1d6 100644 --- a/windows.graphics.imaging/bitmapencoder_jpegencoderid.md +++ b/windows.graphics.imaging/bitmapencoder_jpegencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.JpegEncoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.JpegEncoderId ## -description The unique identifier of the built-in JPEG encoder. ## -property-value The unique identifier of the built-in JPEG encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.JpegEncoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.JpegEncoderId + +## -description +The unique identifier of the built-in JPEG encoder. + +## -property-value +The unique identifier of the built-in JPEG encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_jpegxrencoderid.md b/windows.graphics.imaging/bitmapencoder_jpegxrencoderid.md index eac842ea27..144b8234f3 100644 --- a/windows.graphics.imaging/bitmapencoder_jpegxrencoderid.md +++ b/windows.graphics.imaging/bitmapencoder_jpegxrencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.JpegXREncoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.JpegXREncoderId ## -description The unique identifier of the built-in JPEG-XR encoder. ## -property-value The unique identifier of the built-in JPEG-XR encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.JpegXREncoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.JpegXREncoderId + +## -description +The unique identifier of the built-in JPEG-XR encoder. + +## -property-value +The unique identifier of the built-in JPEG-XR encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_pngencoderid.md b/windows.graphics.imaging/bitmapencoder_pngencoderid.md index 81dfda2c71..77eac49dcc 100644 --- a/windows.graphics.imaging/bitmapencoder_pngencoderid.md +++ b/windows.graphics.imaging/bitmapencoder_pngencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.PngEncoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.PngEncoderId ## -description The unique identifier of the built-in PNG encoder. ## -property-value The unique identifier of the built-in PNG encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.PngEncoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.PngEncoderId + +## -description +The unique identifier of the built-in PNG encoder. + +## -property-value +The unique identifier of the built-in PNG encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_setpixeldata_644328650.md b/windows.graphics.imaging/bitmapencoder_setpixeldata_644328650.md index 7e8f878dcf..831e918433 100644 --- a/windows.graphics.imaging/bitmapencoder_setpixeldata_644328650.md +++ b/windows.graphics.imaging/bitmapencoder_setpixeldata_644328650.md @@ -1,3 +1,48 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.SetPixelData(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,System.UInt32,System.UInt32,System.Double,System.Double,System.Byte[]) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.SetPixelData ## -description Sets pixel data on the frame. ## -parameters ### -param pixelFormat The pixel format of the pixel data. ### -param alphaMode The alpha mode of the pixel data. ### -param width The width, in pixels, of the pixel data. ### -param height The height, in pixels, of the pixel data. ### -param dpiX The horizontal resolution, in dots per inch, of the pixel data. ### -param dpiY The vertical resolution, in dots per inch, of the pixel data. ### -param pixels The pixel data. ## -remarks This method is synchronous because data is not committed until [FlushAsync](bitmapencoder_flushasync.md), [GoToNextFrameAsync](bitmapencoder_gotonextframeasync_718000702.md) or [GoToNextFrameAsync(IIterable(IKeyValuePair))](bitmapencoder_gotonextframeasync_1063265177.md) is called. Setting a pixel format of **Unknown** will result in failure. This method treats all pixel data as being in the sRGB color space. When you call this method it automatically clears any existing color space information from the frame, including embedded color profiles. When you are encoding a new image, before you call [FlushAsync](bitmapencoder_flushasync.md) at the minimum you must set pixel data using this method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.SetPixelData(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,System.UInt32,System.UInt32,System.Double,System.Double,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.SetPixelData + +## -description +Sets pixel data on the frame. + +## -parameters +### -param pixelFormat +The pixel format of the pixel data. + +### -param alphaMode +The alpha mode of the pixel data. + +### -param width +The width, in pixels, of the pixel data. + +### -param height +The height, in pixels, of the pixel data. + +### -param dpiX +The horizontal resolution, in dots per inch, of the pixel data. + +### -param dpiY +The vertical resolution, in dots per inch, of the pixel data. + +### -param pixels +The pixel data. + +## -remarks +This method is synchronous because data is not committed until [FlushAsync](bitmapencoder_flushasync.md), [GoToNextFrameAsync](bitmapencoder_gotonextframeasync_718000702.md) or [GoToNextFrameAsync(IIterable(IKeyValuePair))](bitmapencoder_gotonextframeasync_1063265177.md) is called. + +Setting a pixel format of **Unknown** will result in failure. + +This method treats all pixel data as being in the sRGB color space. When you call this method it automatically clears any existing color space information from the frame, including embedded color profiles. + +When you are encoding a new image, before you call [FlushAsync](bitmapencoder_flushasync.md) at the minimum you must set pixel data using this method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_setsoftwarebitmap_1554527375.md b/windows.graphics.imaging/bitmapencoder_setsoftwarebitmap_1554527375.md index 122546b642..f226cdfdf7 100644 --- a/windows.graphics.imaging/bitmapencoder_setsoftwarebitmap_1554527375.md +++ b/windows.graphics.imaging/bitmapencoder_setsoftwarebitmap_1554527375.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapEncoder.SetSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapEncoder.SetSoftwareBitmap ## -description Sets the image data of the current frame using the specified [SoftwareBitmap](softwarebitmap.md). ## -parameters ### -param bitmap The software bitmap containing the image data. ## -remarks [BitmapEncoder](bitmapencoder.md) only supports software bitmaps that have a [BitmapPixelFormat](bitmappixelformat.md) of **Rgba16**, **Rgba8**, or **Bgra8**. Attempting to call **SetSoftwareBitmap** with a software bitmap that has a different pixel format results in a format unsupported error. Use the [SoftwareBitmap.Convert](softwarebitmap_convert.md) method to create a copy of an existing software bitmap with a different pixel format. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapEncoder.SetSoftwareBitmap(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.SetSoftwareBitmap + +## -description +Sets the image data of the current frame using the specified [SoftwareBitmap](softwarebitmap.md). + +## -parameters +### -param bitmap +The software bitmap containing the image data. + +## -remarks +[BitmapEncoder](bitmapencoder.md) only supports software bitmaps that have a [BitmapPixelFormat](bitmappixelformat.md) of **Rgba16**, **Rgba8**, or **Bgra8**. Attempting to call **SetSoftwareBitmap** with a software bitmap that has a different pixel format results in a format unsupported error. Use the [SoftwareBitmap.Convert](softwarebitmap_convert.md) method to create a copy of an existing software bitmap with a different pixel format. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapencoder_tiffencoderid.md b/windows.graphics.imaging/bitmapencoder_tiffencoderid.md index 657c408caa..cdea9acd09 100644 --- a/windows.graphics.imaging/bitmapencoder_tiffencoderid.md +++ b/windows.graphics.imaging/bitmapencoder_tiffencoderid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapEncoder.TiffEncoderId --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapEncoder.TiffEncoderId ## -description The unique identifier of the built-in TIFF encoder. ## -property-value The unique identifier of the built-in TIFF encoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapEncoder.TiffEncoderId +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapEncoder.TiffEncoderId + +## -description +The unique identifier of the built-in TIFF encoder. + +## -property-value +The unique identifier of the built-in TIFF encoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_bitmapalphamode.md b/windows.graphics.imaging/bitmapframe_bitmapalphamode.md index a5031596bc..f52fdfe104 100644 --- a/windows.graphics.imaging/bitmapframe_bitmapalphamode.md +++ b/windows.graphics.imaging/bitmapframe_bitmapalphamode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.BitmapAlphaMode --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.BitmapAlphaMode ## -description The default alpha mode of the frame. ## -property-value The default alpha mode of the frame. ## -remarks This is the alpha mode used when calling the [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.BitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.BitmapAlphaMode + +## -description +The default alpha mode of the frame. + +## -property-value +The default alpha mode of the frame. + +## -remarks +This is the alpha mode used when calling the [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_bitmappixelformat.md b/windows.graphics.imaging/bitmapframe_bitmappixelformat.md index 41bee7f098..06071a4eff 100644 --- a/windows.graphics.imaging/bitmapframe_bitmappixelformat.md +++ b/windows.graphics.imaging/bitmapframe_bitmappixelformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.BitmapPixelFormat --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.BitmapPixelFormat ## -description The pixel format that best fits the frame. ## -property-value The pixel format that best fits the first frame. ## -remarks This is the pixel format used when calling the [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.BitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.BitmapPixelFormat + +## -description +The pixel format that best fits the frame. + +## -property-value +The pixel format that best fits the first frame. + +## -remarks +This is the pixel format used when calling the [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_bitmapproperties.md b/windows.graphics.imaging/bitmapframe_bitmapproperties.md index 8bc0f3a97b..be3ada31be 100644 --- a/windows.graphics.imaging/bitmapframe_bitmapproperties.md +++ b/windows.graphics.imaging/bitmapframe_bitmapproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.BitmapProperties --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.BitmapProperties ## -description A read-only view of the metadata within the frame. ## -property-value A read-only view of the metadata within the frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.BitmapProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.BitmapProperties + +## -description +A read-only view of the metadata within the frame. + +## -property-value +A read-only view of the metadata within the frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_dpix.md b/windows.graphics.imaging/bitmapframe_dpix.md index 3e1e38ab85..b8bc10eb88 100644 --- a/windows.graphics.imaging/bitmapframe_dpix.md +++ b/windows.graphics.imaging/bitmapframe_dpix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.DpiX --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.DpiX ## -description The horizontal resolution of the frame in dots per inch. ## -property-value The horizontal resolution of the frame in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.DpiX +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.DpiX + +## -description +The horizontal resolution of the frame in dots per inch. + +## -property-value +The horizontal resolution of the frame in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_dpiy.md b/windows.graphics.imaging/bitmapframe_dpiy.md index 94018a222f..25dced1de9 100644 --- a/windows.graphics.imaging/bitmapframe_dpiy.md +++ b/windows.graphics.imaging/bitmapframe_dpiy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.DpiY --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.DpiY ## -description The vertical resolution of the frame in dots per inch. ## -property-value The vertical resolution of the frame in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.DpiY +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.DpiY + +## -description +The vertical resolution of the frame in dots per inch. + +## -property-value +The vertical resolution of the frame in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_getpixeldataasync_1391309547.md b/windows.graphics.imaging/bitmapframe_getpixeldataasync_1391309547.md index 55357553a3..28c5542da6 100644 --- a/windows.graphics.imaging/bitmapframe_getpixeldataasync_1391309547.md +++ b/windows.graphics.imaging/bitmapframe_getpixeldataasync_1391309547.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync ## -description Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](bitmapframe_bitmappixelformat.md) and [BitmapAlphaMode](bitmapframe_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information). ## -returns Object that manages the asynchronous retrieval of the pixel data. ## -remarks The pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) and [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied. As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data. In order to retrieve the correct bitmap pixel width and height, the application should read the [OrientedPixelWidth](bitmapframe_orientedpixelwidth.md) and [OrientedPixelHeight](bitmapframe_orientedpixelheight.md) properties, instead of the [PixelWidth](bitmapframe_pixelwidth.md) and [PixelHeight](bitmapframe_pixelheight.md) properties. This method is equivalent to calling the [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getpixeldataasync_580908657.md) method with the following arguments:
ArgumentValue
*pixelFormat*The value of the [BitmapPixelFormat](bitmapframe_bitmappixelformat.md) property.
*alphaMode*The value of the [BitmapAlphaMode](bitmapframe_bitmapalphamode.md) property
*transform*An empty transform.
*exifOrientationMode*The [ExifOrientationMode](exiforientationmode.md) value **RespectExifOrientation**.
*colorManagementMode*The [ColorManagementMode](colormanagementmode.md) value **ColorManageToSRgb**.
## -examples ## -see-also [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getpixeldataasync_580908657.md), [PixelDataProvider](pixeldataprovider.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync + +## -description +Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](bitmapframe_bitmappixelformat.md) and [BitmapAlphaMode](bitmapframe_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information). + +## -returns +Object that manages the asynchronous retrieval of the pixel data. + +## -remarks +The pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](bitmapdecoder_bitmappixelformat.md) and [BitmapAlphaMode](bitmapdecoder_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied. + +As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data. + +In order to retrieve the correct bitmap pixel width and height, the application should read the [OrientedPixelWidth](bitmapframe_orientedpixelwidth.md) and [OrientedPixelHeight](bitmapframe_orientedpixelheight.md) properties, instead of the [PixelWidth](bitmapframe_pixelwidth.md) and [PixelHeight](bitmapframe_pixelheight.md) properties. + +This method is equivalent to calling the [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getpixeldataasync_580908657.md) method with the following arguments: + + + + + + +
ArgumentValue
*pixelFormat*The value of the [BitmapPixelFormat](bitmapframe_bitmappixelformat.md) property.
*alphaMode*The value of the [BitmapAlphaMode](bitmapframe_bitmapalphamode.md) property
*transform*An empty transform.
*exifOrientationMode*The [ExifOrientationMode](exiforientationmode.md) value **RespectExifOrientation**.
*colorManagementMode*The [ColorManagementMode](colormanagementmode.md) value **ColorManageToSRgb**.
+ +## -examples + +## -see-also +[Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getpixeldataasync_580908657.md), [PixelDataProvider](pixeldataprovider.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapframe_getpixeldataasync_580908657.md b/windows.graphics.imaging/bitmapframe_getpixeldataasync_580908657.md index 09886e3c7f..23b6ae59e7 100644 --- a/windows.graphics.imaging/bitmapframe_getpixeldataasync_580908657.md +++ b/windows.graphics.imaging/bitmapframe_getpixeldataasync_580908657.md @@ -1,3 +1,42 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync ## -description Asynchronously requests the pixel data for the frame using the specified parameters. ## -parameters ### -param pixelFormat The specified pixel format. ### -param alphaMode The specified alpha mode. ### -param transform The set of transformations to be applied to the frame. ### -param exifOrientationMode Indicates whether the EXIF orientation flag should be ignored or respected. ### -param colorManagementMode Indicates whether the pixel data should be color managed to the sRGB color space. ## -returns Object that manages the asynchronous retrieval of the pixel data. ## -remarks This method should be used instead of [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) if the application needs finer grained control over the pixel data array. If you set the *exifOrientationMode* parameter to **RespectExifOrientation**, the resulting pixel data will have dimensions that are defined by [OrientedPixelWidth](bitmapframe_orientedpixelwidth.md) and [OrientedPixelHeight](bitmapframe_orientedpixelheight.md) instead of the [PixelWidth](bitmapframe_pixelwidth.md) and [PixelHeight](bitmapframe_pixelheight.md). If you are also applying a transformation, refer to [BitmapTransform](bitmaptransform.md) for information about correctly handling coordinate spaces. ## -examples ## -see-also [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.GetPixelDataAsync + +## -description +Asynchronously requests the pixel data for the frame using the specified parameters. + +## -parameters +### -param pixelFormat +The specified pixel format. + +### -param alphaMode +The specified alpha mode. + +### -param transform +The set of transformations to be applied to the frame. + +### -param exifOrientationMode +Indicates whether the EXIF orientation flag should be ignored or respected. + +### -param colorManagementMode +Indicates whether the pixel data should be color managed to the sRGB color space. + +## -returns +Object that manages the asynchronous retrieval of the pixel data. + +## -remarks +This method should be used instead of [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) if the application needs finer grained control over the pixel data array. + +If you set the *exifOrientationMode* parameter to **RespectExifOrientation**, the resulting pixel data will have dimensions that are defined by [OrientedPixelWidth](bitmapframe_orientedpixelwidth.md) and [OrientedPixelHeight](bitmapframe_orientedpixelheight.md) instead of the [PixelWidth](bitmapframe_pixelwidth.md) and [PixelHeight](bitmapframe_pixelheight.md). If you are also applying a transformation, refer to [BitmapTransform](bitmaptransform.md) for information about correctly handling coordinate spaces. + +## -examples + +## -see-also +[Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [Imaging](http://msdn.microsoft.com/library/3fd2aa71-ef67-47b2-9332-3ffa5d3703ea), [GetPixelDataAsync](bitmapframe_getpixeldataasync_1391309547.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_1163471917.md b/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_1163471917.md index ca8a33b129..52cb908e63 100644 --- a/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_1163471917.md +++ b/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_1163471917.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync ## -description Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the bitmap frame. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapframe_getsoftwarebitmapasync_994797489.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getsoftwarebitmapasync_892037303.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync + +## -description +Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the bitmap frame. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapframe_getsoftwarebitmapasync_994797489.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getsoftwarebitmapasync_892037303.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_892037303.md b/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_892037303.md index b5de9230ab..fe85010004 100644 --- a/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_892037303.md +++ b/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_892037303.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync ## -description Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the bitmap frame. ## -parameters ### -param pixelFormat The pixel format of the software bitmap. ### -param alphaMode The alpha mode of the software bitmap. ### -param transform The transform of the software bitmap. ### -param exifOrientationMode The EXIF orientation mode of the software bitmap. ### -param colorManagementMode The color management mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync](bitmapframe_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapframe_getsoftwarebitmapasync_994797489.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync + +## -description +Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the bitmap frame. + +## -parameters +### -param pixelFormat +The pixel format of the software bitmap. + +### -param alphaMode +The alpha mode of the software bitmap. + +### -param transform +The transform of the software bitmap. + +### -param exifOrientationMode +The EXIF orientation mode of the software bitmap. + +### -param colorManagementMode +The color management mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync](bitmapframe_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](bitmapframe_getsoftwarebitmapasync_994797489.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_994797489.md b/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_994797489.md index 1a818c7daf..44a0424315 100644 --- a/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_994797489.md +++ b/windows.graphics.imaging/bitmapframe_getsoftwarebitmapasync_994797489.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync ## -description Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the bitmap frame. ## -parameters ### -param pixelFormat The pixel format of the software bitmap. ### -param alphaMode The alpha mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync](bitmapframe_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getsoftwarebitmapasync_892037303.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.GetSoftwareBitmapAsync + +## -description +Asynchronously gets a [SoftwareBitmap](softwarebitmap.md) representation of the bitmap frame. + +## -parameters +### -param pixelFormat +The pixel format of the software bitmap. + +### -param alphaMode +The alpha mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync](bitmapframe_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getsoftwarebitmapasync_892037303.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapframe_getthumbnailasync_241227233.md b/windows.graphics.imaging/bitmapframe_getthumbnailasync_241227233.md index 8019f5da93..0d4f4adc3a 100644 --- a/windows.graphics.imaging/bitmapframe_getthumbnailasync_241227233.md +++ b/windows.graphics.imaging/bitmapframe_getthumbnailasync_241227233.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetThumbnailAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapFrame.GetThumbnailAsync ## -description Asynchronously returns a stream containing the thumbnail image. ## -returns Object that manages the asynchronous retrieval of the thumbnail data. ## -remarks Many image formats, like JPEG and TIFF, allow a small sized thumbnail of the full image to be embedded within a frame. If the image does not contain a thumbnail, then this operation will fail with HRESULT [WINCODEC_ERR_CODECNOTHUMBNAIL](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). If it exists, the EXIF orientation flag on the frame is automatically applied to the thumbnail before it is returned. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapFrame.GetThumbnailAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.GetThumbnailAsync + +## -description +Asynchronously returns a stream containing the thumbnail image. + +## -returns +Object that manages the asynchronous retrieval of the thumbnail data. + +## -remarks +Many image formats, like JPEG and TIFF, allow a small sized thumbnail of the full image to be embedded within a frame. If the image does not contain a thumbnail, then this operation will fail with HRESULT [WINCODEC_ERR_CODECNOTHUMBNAIL](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). If it exists, the EXIF orientation flag on the frame is automatically applied to the thumbnail before it is returned. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_orientedpixelheight.md b/windows.graphics.imaging/bitmapframe_orientedpixelheight.md index 086313eedf..107595459a 100644 --- a/windows.graphics.imaging/bitmapframe_orientedpixelheight.md +++ b/windows.graphics.imaging/bitmapframe_orientedpixelheight.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.OrientedPixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.OrientedPixelHeight ## -description The height of the frame in pixels, after any EXIF orientation has been applied to the bitmap. ## -property-value The height of the frame in pixels, after any EXIF orientation has been applied. ## -remarks Use this property if you need to know the height of an image or of pixel data that has EXIF orientation applied, for example, if you call [GetPixelDataAsync](bitmapframe_getpixeldataasync.md) and specify **RespectExifOrientation**. Also, the [HTML img element](XREF:TODO:wwa.images_Object) in Windows app using JavaScript, and [Windows.UI.Xaml.Controls.Image](../windows.ui.xaml.controls/image.md) respect EXIF orientation. If you need pixel dimensions of the image as it is natively stored, use the [PixelHeight](bitmapdecoder_pixelheight.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.OrientedPixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.OrientedPixelHeight + +## -description +The height of the frame in pixels, after any EXIF orientation has been applied to the bitmap. + +## -property-value +The height of the frame in pixels, after any EXIF orientation has been applied. + +## -remarks +Use this property if you need to know the height of an image or of pixel data that has EXIF orientation applied, for example, if you call [GetPixelDataAsync](bitmapframe_getpixeldataasync.md) and specify **RespectExifOrientation**. Also, the [HTML img element](XREF:TODO:wwa.images_Object) in Windows app using JavaScript, and [Windows.UI.Xaml.Controls.Image](../windows.ui.xaml.controls/image.md) respect EXIF orientation. + +If you need pixel dimensions of the image as it is natively stored, use the [PixelHeight](bitmapdecoder_pixelheight.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_orientedpixelwidth.md b/windows.graphics.imaging/bitmapframe_orientedpixelwidth.md index 61cbb69c8d..e5364c0fcd 100644 --- a/windows.graphics.imaging/bitmapframe_orientedpixelwidth.md +++ b/windows.graphics.imaging/bitmapframe_orientedpixelwidth.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.OrientedPixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.OrientedPixelWidth ## -description The width of the frame in pixels, after any EXIF orientation has been applied to the bitmap. ## -property-value The width of the frame in pixels, after any EXIF orientation has been applied. ## -remarks Use this property in the same way as [OrientedPixelWidth](bitmapframe_orientedpixelwidth.md) is used if you need to know the width of an image or of pixel data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.OrientedPixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.OrientedPixelWidth + +## -description +The width of the frame in pixels, after any EXIF orientation has been applied to the bitmap. + +## -property-value +The width of the frame in pixels, after any EXIF orientation has been applied. + +## -remarks +Use this property in the same way as [OrientedPixelWidth](bitmapframe_orientedpixelwidth.md) is used if you need to know the width of an image or of pixel data. + + + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_pixelheight.md b/windows.graphics.imaging/bitmapframe_pixelheight.md index a4e14195ab..bf34d7f45e 100644 --- a/windows.graphics.imaging/bitmapframe_pixelheight.md +++ b/windows.graphics.imaging/bitmapframe_pixelheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.PixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.PixelHeight ## -description The height of the frame in pixels. ## -property-value The height of the frame in pixels. ## -remarks If you need pixel dimensions of the image as it is natively stored, use the [PixelHeight](bitmapdecoder_pixelheight.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.PixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.PixelHeight + +## -description +The height of the frame in pixels. + +## -property-value +The height of the frame in pixels. + +## -remarks +If you need pixel dimensions of the image as it is natively stored, use the [PixelHeight](bitmapdecoder_pixelheight.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapframe_pixelwidth.md b/windows.graphics.imaging/bitmapframe_pixelwidth.md index c87c1edf9c..13ecd86357 100644 --- a/windows.graphics.imaging/bitmapframe_pixelwidth.md +++ b/windows.graphics.imaging/bitmapframe_pixelwidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapFrame.PixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapFrame.PixelWidth ## -description The width of the frame in pixels. ## -property-value The width of the frame in pixels. ## -remarks If you need pixel dimensions of the image as it is natively stored, use the [PixelWidth](bitmapframe_pixelwidth.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapFrame.PixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapFrame.PixelWidth + +## -description +The width of the frame in pixels. + +## -property-value +The width of the frame in pixels. + +## -remarks +If you need pixel dimensions of the image as it is natively stored, use the [PixelWidth](bitmapframe_pixelwidth.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmapproperties_getpropertiesasync_1829853186.md b/windows.graphics.imaging/bitmapproperties_getpropertiesasync_1829853186.md index e4a4f01354..bd0b6f579d 100644 --- a/windows.graphics.imaging/bitmapproperties_getpropertiesasync_1829853186.md +++ b/windows.graphics.imaging/bitmapproperties_getpropertiesasync_1829853186.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapProperties.GetPropertiesAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapProperties.GetPropertiesAsync ## -description Asynchronously retrieves one or more bitmap properties. ## -parameters ### -param propertiesToRetrieve A collection of strings containing the specified property keys. ## -returns Object that manages the asynchronous retrieval of the bitmap properties. ## -remarks This method is identical to [BitmapPropertiesView::GetPropertiesAsync](bitmappropertiesview_getpropertiesasync.md). ## -examples ## -see-also [BitmapPropertySet](bitmappropertyset.md), [BitmapPropertiesView::GetPropertiesAsync](bitmappropertiesview_getpropertiesasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapProperties.GetPropertiesAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapProperties.GetPropertiesAsync + +## -description +Asynchronously retrieves one or more bitmap properties. + +## -parameters +### -param propertiesToRetrieve +A collection of strings containing the specified property keys. + +## -returns +Object that manages the asynchronous retrieval of the bitmap properties. + +## -remarks +This method is identical to [BitmapPropertiesView::GetPropertiesAsync](bitmappropertiesview_getpropertiesasync.md). + +## -examples + +## -see-also +[BitmapPropertySet](bitmappropertyset.md), [BitmapPropertiesView::GetPropertiesAsync](bitmappropertiesview_getpropertiesasync.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmapproperties_setpropertiesasync_1991487715.md b/windows.graphics.imaging/bitmapproperties_setpropertiesasync_1991487715.md index e3d3b23a6e..de2e8cba0a 100644 --- a/windows.graphics.imaging/bitmapproperties_setpropertiesasync_1991487715.md +++ b/windows.graphics.imaging/bitmapproperties_setpropertiesasync_1991487715.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapProperties.SetPropertiesAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Graphics.Imaging.BitmapTypedValue}}) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapProperties.SetPropertiesAsync ## -description Asynchronously sets one or more bitmap properties. ## -parameters ### -param propertiesToSet A collection of key-value pairs representing the bitmap properties to be set. Each key is a string containing the Windows property or metadata query, and the corresponding value is a [BitmapTypedValue](bitmaptypedvalue.md) with the data and the correct [PropertyType](../windows.foundation/propertytype.md). ## -returns Object that manages the setting of the bitmap properties asynchronously. ## -remarks Use a [BitmapPropertySet](bitmappropertyset.md) to store metadata items that you want to set on the encoder. Each metadata item is a key-value pair. The key is a string that identifies the metadata item to set. [BitmapEncoder](bitmapencoder.md) accepts some Windows properties as well as queries constructed using the WIC metadata query language. For a list of supported Windows properties, see [Supported Windows Properties](http://msdn.microsoft.com/library/7532e58f-bbf2-4e36-9d81-c8e04b92cb7c). For a summary of supported WIC metadata queries, see the [WIC Native Image Format Metadata Queries](http://msdn.microsoft.com/library/a6ab1708-dd82-4960-b908-f1daef7374ef) topic. The value is a [BitmapTypedValue](bitmaptypedvalue.md) which allows you to associate the actual metadata value with an explicit data type ([Windows.Foundation.PropertyType](../windows.foundation/propertytype.md)). Each image format has specific requirements around the type of every bitmap property, and you must ensure that the [Type](bitmaptypedvalue_type.md) field of each [BitmapTypedValue](bitmaptypedvalue.md) is correctly set for the selected property. For example, the [System.Photo.Orientation](XREF:TODO:properties.props_System_Photo_Orientation) Windows property is stored in the file as a UInt16, and therefore the [Type](bitmaptypedvalue_type.md) field must be set to UInt16. For more info about Windows property types, see [Photo Metadata Policies](http://msdn.microsoft.com/library/ac71889b-94e5-4135-abd4-5d96690e41ea). For more info about Windows Imaging Component metadata query types, see [Native Image Format Metadata Queries](http://msdn.microsoft.com/library/a6ab1708-dd82-4960-b908-f1daef7374ef). ## -examples ## -see-also [BitmapPropertySet](bitmappropertyset.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapProperties.SetPropertiesAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Graphics.Imaging.BitmapTypedValue}}) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapProperties.SetPropertiesAsync + +## -description +Asynchronously sets one or more bitmap properties. + +## -parameters +### -param propertiesToSet +A collection of key-value pairs representing the bitmap properties to be set. Each key is a string containing the Windows property or metadata query, and the corresponding value is a [BitmapTypedValue](bitmaptypedvalue.md) with the data and the correct [PropertyType](../windows.foundation/propertytype.md). + +## -returns +Object that manages the setting of the bitmap properties asynchronously. + +## -remarks +Use a [BitmapPropertySet](bitmappropertyset.md) to store metadata items that you want to set on the encoder. Each metadata item is a key-value pair. + +The key is a string that identifies the metadata item to set. [BitmapEncoder](bitmapencoder.md) accepts some Windows properties as well as queries constructed using the WIC metadata query language. For a list of supported Windows properties, see [Supported Windows Properties](http://msdn.microsoft.com/library/7532e58f-bbf2-4e36-9d81-c8e04b92cb7c). For a summary of supported WIC metadata queries, see the [WIC Native Image Format Metadata Queries](http://msdn.microsoft.com/library/a6ab1708-dd82-4960-b908-f1daef7374ef) topic. + +The value is a [BitmapTypedValue](bitmaptypedvalue.md) which allows you to associate the actual metadata value with an explicit data type ([Windows.Foundation.PropertyType](../windows.foundation/propertytype.md)). + +Each image format has specific requirements around the type of every bitmap property, and you must ensure that the [Type](bitmaptypedvalue_type.md) field of each [BitmapTypedValue](bitmaptypedvalue.md) is correctly set for the selected property. For example, the [System.Photo.Orientation](XREF:TODO:properties.props_System_Photo_Orientation) Windows property is stored in the file as a UInt16, and therefore the [Type](bitmaptypedvalue_type.md) field must be set to UInt16. For more info about Windows property types, see [Photo Metadata Policies](http://msdn.microsoft.com/library/ac71889b-94e5-4135-abd4-5d96690e41ea). For more info about Windows Imaging Component metadata query types, see [Native Image Format Metadata Queries](http://msdn.microsoft.com/library/a6ab1708-dd82-4960-b908-f1daef7374ef). + +## -examples + +## -see-also +[BitmapPropertySet](bitmappropertyset.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmappropertiesview_getpropertiesasync_1829853186.md b/windows.graphics.imaging/bitmappropertiesview_getpropertiesasync_1829853186.md index d1e378279c..5f1e393187 100644 --- a/windows.graphics.imaging/bitmappropertiesview_getpropertiesasync_1829853186.md +++ b/windows.graphics.imaging/bitmappropertiesview_getpropertiesasync_1829853186.md @@ -1,3 +1,79 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertiesView.GetPropertiesAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertiesView.GetPropertiesAsync ## -description Asynchronously retrieves one or more bitmap properties. ## -parameters ### -param propertiesToRetrieve A collection of strings representing the property keys or queries that are being requested. Valid strings include [Windows properties](http://msdn.microsoft.com/library/ac71889b-94e5-4135-abd4-5d96690e41ea) and [Windows Imaging Component metadata queries](http://msdn.microsoft.com/library/a6ab1708-dd82-4960-b908-f1daef7374ef). ## -returns Object that manages the asynchronous retrieval of the bitmap properties. ## -remarks The asynchronous operation produces a collection representing the requested image property keys and their values. The values are stored as [BitmapTypedValue](bitmaptypedvalue.md), which contains both the actual data as well as the [PropertyType](http://msdn.microsoft.com/library/a4dc4348-88ee-48fb-91ed-f1d12fc89ee1) of the data. A particular image may only contain some (or none) of the requested properties. In this case the collection will only have key-value pairs for the properties which were found in the image. You need to check for the existence of the property before you attempt to get data from it: ```javascript bitmapPropertiesView.getPropertiesAsync(["System.Title"]).done(function (retrievedProperties) { if (retrievedProperties.hasKey("System.Title")) { var titleProperty = retrievedProperties.lookup("System.Title"); var title = titleProperty.value; } }); ``` ### Querying for a metadata block If you use the metadata query language to request a metadata block instead of a property, the returned value is a [BitmapPropertiesView](bitmappropertiesview.md) representing the metadata within that block. You can request any metadata contained within the block from the [BitmapPropertiesView](bitmappropertiesview.md): ```javascript // this is equivalent to directly requesting "/app1/ifd/{ushort=274}" from bitmapPropertiesView bitmapPropertiesView.getPropertiesAsync(["/app1/ifd"]).done(function (retrievedProperties) { // var ifdBlock is a BitmapPropertiesView var ifdBlock = retrievedProperties.lookup("/app1/ifd").value; return ifdBlock.getPropertiesAsync(["/{ushort=274}"); }).then(function (retrievedProperties) { var orientation = retrievedProperties.lookup("/{ushort=274}").value; }); ``` ### Enumerating through all the metadata within a frame You can request all of the contents of a metadata block, including sub-blocks and properties, by passing in an empty (zero length) collection of strings. This produces a collection containing every sub-block and property within the [BitmapPropertiesView](bitmappropertiesview.md) ’s scope. In this way, you are able to iteratively retrieve all of the metadata contained within an image frame. ```javascript bitmapPropertiesView.getPropertiesAsync([]).done(function (retrievedProperties) { var iterator = retrievedProps.first(); while (iterator.hasCurrent) { // iterator.current gives a key-value pair of string, BitmapTypedValue // nextMetadataBlock is a BitmapPropertiesView containing the sub-block var nextMetadataBlock = iterator.current.value.value; iterator.moveNext(); } }); ``` If the image format does not support metadata, it will fail with HRESULT [WINCODEC_ERR_UNSUPPORTEDOPERATION](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). ## -examples ## -see-also [BitmapPropertySet](bitmappropertyset.md), [BitmapTypedValue](bitmaptypedvalue.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertiesView.GetPropertiesAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertiesView.GetPropertiesAsync + +## -description +Asynchronously retrieves one or more bitmap properties. + +## -parameters +### -param propertiesToRetrieve +A collection of strings representing the property keys or queries that are being requested. Valid strings include [Windows properties](http://msdn.microsoft.com/library/ac71889b-94e5-4135-abd4-5d96690e41ea) and [Windows Imaging Component metadata queries](http://msdn.microsoft.com/library/a6ab1708-dd82-4960-b908-f1daef7374ef). + +## -returns +Object that manages the asynchronous retrieval of the bitmap properties. + +## -remarks +The asynchronous operation produces a collection representing the requested image property keys and their values. The values are stored as [BitmapTypedValue](bitmaptypedvalue.md), which contains both the actual data as well as the [PropertyType](http://msdn.microsoft.com/library/a4dc4348-88ee-48fb-91ed-f1d12fc89ee1) of the data. + +A particular image may only contain some (or none) of the requested properties. In this case the collection will only have key-value pairs for the properties which were found in the image. You need to check for the existence of the property before you attempt to get data from it: + +```javascript +bitmapPropertiesView.getPropertiesAsync(["System.Title"]).done(function (retrievedProperties) { + if (retrievedProperties.hasKey("System.Title")) { + var titleProperty = retrievedProperties.lookup("System.Title"); + var title = titleProperty.value; + } +}); +``` + + + +### Querying for a metadata block + +If you use the metadata query language to request a metadata block instead of a property, the returned value is a [BitmapPropertiesView](bitmappropertiesview.md) representing the metadata within that block. You can request any metadata contained within the block from the [BitmapPropertiesView](bitmappropertiesview.md): + +```javascript +// this is equivalent to directly requesting "/app1/ifd/{ushort=274}" from bitmapPropertiesView +bitmapPropertiesView.getPropertiesAsync(["/app1/ifd"]).done(function (retrievedProperties) { + // var ifdBlock is a BitmapPropertiesView + var ifdBlock = retrievedProperties.lookup("/app1/ifd").value; + return ifdBlock.getPropertiesAsync(["/{ushort=274}"); +}).then(function (retrievedProperties) { + var orientation = retrievedProperties.lookup("/{ushort=274}").value; +}); +``` + + + +### Enumerating through all the metadata within a frame + +You can request all of the contents of a metadata block, including sub-blocks and properties, by passing in an empty (zero length) collection of strings. This produces a collection containing every sub-block and property within the [BitmapPropertiesView](bitmappropertiesview.md) ’s scope. In this way, you are able to iteratively retrieve all of the metadata contained within an image frame. + +```javascript +bitmapPropertiesView.getPropertiesAsync([]).done(function (retrievedProperties) { + var iterator = retrievedProps.first(); + while (iterator.hasCurrent) { + // iterator.current gives a key-value pair of string, BitmapTypedValue + // nextMetadataBlock is a BitmapPropertiesView containing the sub-block + var nextMetadataBlock = iterator.current.value.value; + iterator.moveNext(); + } +}); + +``` + + + +If the image format does not support metadata, it will fail with HRESULT [WINCODEC_ERR_UNSUPPORTEDOPERATION](http://msdn.microsoft.com/library/1ded909c-311b-49e3-ba23-b22cd7a77bc6). + +## -examples + +## -see-also +[BitmapPropertySet](bitmappropertyset.md), [BitmapTypedValue](bitmaptypedvalue.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmappropertyset_bitmappropertyset_1221375020.md b/windows.graphics.imaging/bitmappropertyset_bitmappropertyset_1221375020.md index 74d1c98906..4103fdb4ab 100644 --- a/windows.graphics.imaging/bitmappropertyset_bitmappropertyset_1221375020.md +++ b/windows.graphics.imaging/bitmappropertyset_bitmappropertyset_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.#ctor --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.BitmapPropertySet ## -description Creates and initializes a new instance of the bitmap property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.BitmapPropertySet + +## -description +Creates and initializes a new instance of the bitmap property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmappropertyset_clear_556466.md b/windows.graphics.imaging/bitmappropertyset_clear_556466.md index da8d1fbf3b..f66d3718f5 100644 --- a/windows.graphics.imaging/bitmappropertyset_clear_556466.md +++ b/windows.graphics.imaging/bitmappropertyset_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.Clear --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.Clear ## -description Removes all items from the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.Clear +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.Clear + +## -description +Removes all items from the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmappropertyset_first_1920739956.md b/windows.graphics.imaging/bitmappropertyset_first_1920739956.md index c140a539cf..5c2eeafb31 100644 --- a/windows.graphics.imaging/bitmappropertyset_first_1920739956.md +++ b/windows.graphics.imaging/bitmappropertyset_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.First --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.First ## -description Returns an iterator to enumerate the items in the property set. ## -returns The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.First +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.First + +## -description +Returns an iterator to enumerate the items in the property set. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmappropertyset_getview_37498667.md b/windows.graphics.imaging/bitmappropertyset_getview_37498667.md index dc229bf1ad..73ca0c9fd6 100644 --- a/windows.graphics.imaging/bitmappropertyset_getview_37498667.md +++ b/windows.graphics.imaging/bitmappropertyset_getview_37498667.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.GetView --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.GetView ## -description Gets an immutable view of the property set. ## -returns The immutable view. ## -remarks ## -examples ## -see-also [BitmapTypedValue](bitmaptypedvalue.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.GetView +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.GetView + +## -description +Gets an immutable view of the property set. + +## -returns +The immutable view. + +## -remarks + +## -examples + +## -see-also +[BitmapTypedValue](bitmaptypedvalue.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmappropertyset_haskey_425964900.md b/windows.graphics.imaging/bitmappropertyset_haskey_425964900.md index 16e5c6c8c4..be7ac3ad97 100644 --- a/windows.graphics.imaging/bitmappropertyset_haskey_425964900.md +++ b/windows.graphics.imaging/bitmappropertyset_haskey_425964900.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.HasKey(System.String) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.HasKey ## -description Indicates whether the property set has an item with the specified key. ## -parameters ### -param key The key. ## -returns True if the property set has an item with the specified key; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.HasKey + +## -description +Indicates whether the property set has an item with the specified key. + +## -parameters +### -param key +The key. + +## -returns +True if the property set has an item with the specified key; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmappropertyset_insert_663015008.md b/windows.graphics.imaging/bitmappropertyset_insert_663015008.md index ad7f6c04c5..24aec20d00 100644 --- a/windows.graphics.imaging/bitmappropertyset_insert_663015008.md +++ b/windows.graphics.imaging/bitmappropertyset_insert_663015008.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.Insert(System.String,Windows.Graphics.Imaging.BitmapTypedValue) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.Insert ## -description Adds an item to the property set. ## -parameters ### -param key The key to insert. ### -param value The value to insert. ## -returns True if the method replaces a value that already exists for the key; false if this is a new key. ## -remarks ## -examples ## -see-also [BitmapTypedValue](bitmaptypedvalue.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.Insert(System.String,Windows.Graphics.Imaging.BitmapTypedValue) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.Insert + +## -description +Adds an item to the property set. + +## -parameters +### -param key +The key to insert. + +### -param value +The value to insert. + +## -returns +True if the method replaces a value that already exists for the key; false if this is a new key. + +## -remarks + +## -examples + +## -see-also +[BitmapTypedValue](bitmaptypedvalue.md) \ No newline at end of file diff --git a/windows.graphics.imaging/bitmappropertyset_remove_1498489487.md b/windows.graphics.imaging/bitmappropertyset_remove_1498489487.md index 2e646efe7d..b09c6147f3 100644 --- a/windows.graphics.imaging/bitmappropertyset_remove_1498489487.md +++ b/windows.graphics.imaging/bitmappropertyset_remove_1498489487.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.Remove(System.String) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapPropertySet.Remove ## -description Removes an item from the property set. ## -parameters ### -param key The key. ## -remarks For the C# or Microsoft Visual Basic version of the **Remove(String)** method, see [Remove](bitmappropertyset_remove_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapPropertySet.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.Remove + +## -description +Removes an item from the property set. + +## -parameters +### -param key +The key. + +## -remarks +For the C# or Microsoft Visual Basic version of the **Remove(String)** method, see [Remove](bitmappropertyset_remove_2.md). + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmappropertyset_size.md b/windows.graphics.imaging/bitmappropertyset_size.md index f0452e2c2e..c6702ee6c7 100644 --- a/windows.graphics.imaging/bitmappropertyset_size.md +++ b/windows.graphics.imaging/bitmappropertyset_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapPropertySet.Size --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapPropertySet.Size ## -description Gets the number of items contained in the property set. ## -property-value The number of items in the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapPropertySet.Size +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapPropertySet.Size + +## -description +Gets the number of items contained in the property set. + +## -property-value +The number of items in the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_bitmaptransform_1221375020.md b/windows.graphics.imaging/bitmaptransform_bitmaptransform_1221375020.md index cb49942996..6b728240c8 100644 --- a/windows.graphics.imaging/bitmaptransform_bitmaptransform_1221375020.md +++ b/windows.graphics.imaging/bitmaptransform_bitmaptransform_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapTransform.#ctor --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapTransform.BitmapTransform ## -description Creates a new [BitmapTransform](bitmaptransform_bitmaptransform.md) object. ## -remarks The default values of [BitmapTransform](bitmaptransform_bitmaptransform.md) result in a pass-through operation. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapTransform.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.BitmapTransform + +## -description +Creates a new [BitmapTransform](bitmaptransform_bitmaptransform.md) object. + +## -remarks +The default values of [BitmapTransform](bitmaptransform_bitmaptransform.md) result in a pass-through operation. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_bounds.md b/windows.graphics.imaging/bitmaptransform_bounds.md index 6c3bd80495..0380b884e9 100644 --- a/windows.graphics.imaging/bitmaptransform_bounds.md +++ b/windows.graphics.imaging/bitmaptransform_bounds.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTransform.Bounds --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTransform.Bounds ## -description Specifies the bounding rectangle that is used to crop the bitmap. This rectangle is defined in the coordinate space after scale, rotation, and flip are applied. ## -property-value A structure that specifies the bounding rectangle. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTransform.Bounds +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.Bounds + +## -description +Specifies the bounding rectangle that is used to crop the bitmap. This rectangle is defined in the coordinate space after scale, rotation, and flip are applied. + +## -property-value +A structure that specifies the bounding rectangle. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_flip.md b/windows.graphics.imaging/bitmaptransform_flip.md index 978f68f36b..6c8d48ef93 100644 --- a/windows.graphics.imaging/bitmaptransform_flip.md +++ b/windows.graphics.imaging/bitmaptransform_flip.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTransform.Flip --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTransform.Flip ## -description Specifies the flip operation that is used to transform the bitmap. ## -property-value The type of flip operation. One of the values of the [BitmapFlip](bitmapflip.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTransform.Flip +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.Flip + +## -description +Specifies the flip operation that is used to transform the bitmap. + +## -property-value +The type of flip operation. One of the values of the [BitmapFlip](bitmapflip.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_interpolationmode.md b/windows.graphics.imaging/bitmaptransform_interpolationmode.md index 5b44981ad1..11a9ec18ee 100644 --- a/windows.graphics.imaging/bitmaptransform_interpolationmode.md +++ b/windows.graphics.imaging/bitmaptransform_interpolationmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTransform.InterpolationMode --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTransform.InterpolationMode ## -description Specifies the interpolation mode that is used to scale the bitmap. ## -property-value The interpolation mode. One of the values of the [BitmapInterpolationMode](bitmapinterpolationmode.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTransform.InterpolationMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.InterpolationMode + +## -description +Specifies the interpolation mode that is used to scale the bitmap. + +## -property-value +The interpolation mode. One of the values of the [BitmapInterpolationMode](bitmapinterpolationmode.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_rotation.md b/windows.graphics.imaging/bitmaptransform_rotation.md index d6b8b04007..0cd4b26a95 100644 --- a/windows.graphics.imaging/bitmaptransform_rotation.md +++ b/windows.graphics.imaging/bitmaptransform_rotation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTransform.Rotation --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTransform.Rotation ## -description Specifies the rotation operation that is used to transform the bitmap. ## -property-value The type of rotation. One of the values of the [BitmapRotation](bitmaprotation.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTransform.Rotation +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.Rotation + +## -description +Specifies the rotation operation that is used to transform the bitmap. + +## -property-value +The type of rotation. One of the values of the [BitmapRotation](bitmaprotation.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_scaledheight.md b/windows.graphics.imaging/bitmaptransform_scaledheight.md index 841ef5ad9f..99f320f0f3 100644 --- a/windows.graphics.imaging/bitmaptransform_scaledheight.md +++ b/windows.graphics.imaging/bitmaptransform_scaledheight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTransform.ScaledHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTransform.ScaledHeight ## -description Specifies the height, in pixels, of the bitmap after it is scaled. This is defined in the coordinate space of the source image, before rotation and flip are applied. ## -property-value The height of the bitmap, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTransform.ScaledHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.ScaledHeight + +## -description +Specifies the height, in pixels, of the bitmap after it is scaled. This is defined in the coordinate space of the source image, before rotation and flip are applied. + +## -property-value +The height of the bitmap, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptransform_scaledwidth.md b/windows.graphics.imaging/bitmaptransform_scaledwidth.md index 008dea9840..a4e98c9347 100644 --- a/windows.graphics.imaging/bitmaptransform_scaledwidth.md +++ b/windows.graphics.imaging/bitmaptransform_scaledwidth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTransform.ScaledWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTransform.ScaledWidth ## -description Specifies the width, in pixels, of the bitmap after it is scaled. This is defined in the coordinate space of the source image, before rotation and flip are applied. ## -property-value The width of the bitmap, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTransform.ScaledWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTransform.ScaledWidth + +## -description +Specifies the width, in pixels, of the bitmap after it is scaled. This is defined in the coordinate space of the source image, before rotation and flip are applied. + +## -property-value +The width of the bitmap, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptypedvalue_bitmaptypedvalue_393477553.md b/windows.graphics.imaging/bitmaptypedvalue_bitmaptypedvalue_393477553.md index 97a988b73a..9325aa6658 100644 --- a/windows.graphics.imaging/bitmaptypedvalue_bitmaptypedvalue_393477553.md +++ b/windows.graphics.imaging/bitmaptypedvalue_bitmaptypedvalue_393477553.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.BitmapTypedValue.#ctor(System.Object,Windows.Foundation.PropertyType) --api-type: winrt method ---- # Windows.Graphics.Imaging.BitmapTypedValue.BitmapTypedValue ## -description Creates a new [BitmapTypedValue](bitmaptypedvalue.md) object. ## -parameters ### -param value The value to store. ### -param type The type of the *value* parameter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.BitmapTypedValue.#ctor(System.Object,Windows.Foundation.PropertyType) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.BitmapTypedValue.BitmapTypedValue + +## -description +Creates a new [BitmapTypedValue](bitmaptypedvalue.md) object. + +## -parameters +### -param value +The value to store. + +### -param type +The type of the *value* parameter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptypedvalue_type.md b/windows.graphics.imaging/bitmaptypedvalue_type.md index 8e6a4fac80..0bcc13f8eb 100644 --- a/windows.graphics.imaging/bitmaptypedvalue_type.md +++ b/windows.graphics.imaging/bitmaptypedvalue_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTypedValue.Type --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTypedValue.Type ## -description Gets the [PropertyType](../windows.foundation/propertytype.md) of the stored value. ## -property-value The [PropertyType](../windows.foundation/propertytype.md) of the stored value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTypedValue.Type +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTypedValue.Type + +## -description +Gets the [PropertyType](../windows.foundation/propertytype.md) of the stored value. + +## -property-value +The [PropertyType](../windows.foundation/propertytype.md) of the stored value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/bitmaptypedvalue_value.md b/windows.graphics.imaging/bitmaptypedvalue_value.md index 7f0f6a149c..e64d5c71cf 100644 --- a/windows.graphics.imaging/bitmaptypedvalue_value.md +++ b/windows.graphics.imaging/bitmaptypedvalue_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.BitmapTypedValue.Value --api-type: winrt property ---- # Windows.Graphics.Imaging.BitmapTypedValue.Value ## -description Gets the stored value. ## -property-value The stored value [Object](https://msdn.microsoft.com/library/system.object.aspx). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.BitmapTypedValue.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.BitmapTypedValue.Value + +## -description +Gets the stored value. + +## -property-value +The stored value [Object](https://msdn.microsoft.com/library/system.object.aspx). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_bitmapalphamode.md b/windows.graphics.imaging/ibitmapframe_bitmapalphamode.md index 198266e3aa..7bb8ad98be 100644 --- a/windows.graphics.imaging/ibitmapframe_bitmapalphamode.md +++ b/windows.graphics.imaging/ibitmapframe_bitmapalphamode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.BitmapAlphaMode --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.BitmapAlphaMode ## -description Returns the default alpha mode of the frame. ## -property-value The default alpha mode of the frame. ## -remarks This is the alpha mode used when calling the [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.BitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.BitmapAlphaMode + +## -description +Returns the default alpha mode of the frame. + +## -property-value +The default alpha mode of the frame. + +## -remarks +This is the alpha mode used when calling the [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_bitmappixelformat.md b/windows.graphics.imaging/ibitmapframe_bitmappixelformat.md index 326cd74dd2..e3089d3125 100644 --- a/windows.graphics.imaging/ibitmapframe_bitmappixelformat.md +++ b/windows.graphics.imaging/ibitmapframe_bitmappixelformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.BitmapPixelFormat --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.BitmapPixelFormat ## -description Returns the default pixel format of the frame. ## -property-value The default pixel format of the frame. ## -remarks This is the pixel format used when calling the [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.BitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.BitmapPixelFormat + +## -description +Returns the default pixel format of the frame. + +## -property-value +The default pixel format of the frame. + +## -remarks +This is the pixel format used when calling the [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) method. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_bitmapproperties.md b/windows.graphics.imaging/ibitmapframe_bitmapproperties.md index b35fb5fc92..7472313b75 100644 --- a/windows.graphics.imaging/ibitmapframe_bitmapproperties.md +++ b/windows.graphics.imaging/ibitmapframe_bitmapproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.BitmapProperties --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.BitmapProperties ## -description Returns a read-only view of the metadata within the frame. ## -property-value A read-only view of the metadata within the frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.BitmapProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.BitmapProperties + +## -description +Returns a read-only view of the metadata within the frame. + +## -property-value +A read-only view of the metadata within the frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_dpix.md b/windows.graphics.imaging/ibitmapframe_dpix.md index d092ad6101..23c9dd85ae 100644 --- a/windows.graphics.imaging/ibitmapframe_dpix.md +++ b/windows.graphics.imaging/ibitmapframe_dpix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.DpiX --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.DpiX ## -description Returns the horizontal resolution of the frame in dots per inch. ## -property-value The horizontal resolution of the frame in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.DpiX +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.DpiX + +## -description +Returns the horizontal resolution of the frame in dots per inch. + +## -property-value +The horizontal resolution of the frame in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_dpiy.md b/windows.graphics.imaging/ibitmapframe_dpiy.md index d369a4ab31..5fd5ba4a0d 100644 --- a/windows.graphics.imaging/ibitmapframe_dpiy.md +++ b/windows.graphics.imaging/ibitmapframe_dpiy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.DpiY --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.DpiY ## -description Returns the vertical resolution of the frame in dots per inch. ## -property-value The vertical resolution of the frame in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.DpiY +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.DpiY + +## -description +Returns the vertical resolution of the frame in dots per inch. + +## -property-value +The vertical resolution of the frame in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_getpixeldataasync_1391309547.md b/windows.graphics.imaging/ibitmapframe_getpixeldataasync_1391309547.md index f93d564c6b..c5ad1d588d 100644 --- a/windows.graphics.imaging/ibitmapframe_getpixeldataasync_1391309547.md +++ b/windows.graphics.imaging/ibitmapframe_getpixeldataasync_1391309547.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync ## -description Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](ibitmapframe_bitmappixelformat.md) and [BitmapAlphaMode](ibitmapframe_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information). ## -returns Object that manages the asynchronous retrieval of the pixel data. ## -remarks An application should not assume that pixel data returned by this method uses any particular pixel format or alpha mode (i.e. Rgba8 with premultiplied alpha). Instead, it should always check the [BitmapPixelFormat](ibitmapframe_bitmappixelformat.md) and [BitmapAlphaMode](ibitmapframe_bitmapalphamode.md) properties and handle the data accordingly. As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data. In order to retrieve the correct bitmap pixel width and height, the application should read the [OrientedPixelWidth](ibitmapframe_orientedpixelwidth.md) and [OrientedPixelHeight](ibitmapframe_orientedpixelheight.md) properties, instead of the [PixelWidth](ibitmapframe_pixelwidth.md) and [PixelHeight](ibitmapframe_pixelheight.md) properties. This method is equivalent to calling the [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getpixeldataasync_580908657.md) method with the following arguments:
ArgumentValue
*pixelFormat*The value of the [BitmapPixelFormat](ibitmapframe_bitmappixelformat.md) property.
*alphaMode*The value of the [BitmapAlphaMode](ibitmapframe_bitmapalphamode.md) property
*transform*An empty transform.
*exifOrientationMode*The [ExifOrientationMode](exiforientationmode.md) value **RespectExifOrientation**.
*colorManagementMode*The [ColorManagementMode](colormanagementmode.md) value **ColorManageToSRgb**.
## -examples ## -see-also [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](ibitmapframe_getpixeldataasync_580908657.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync + +## -description +Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the [BitmapPixelFormat](ibitmapframe_bitmappixelformat.md) and [BitmapAlphaMode](ibitmapframe_bitmapalphamode.md) properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information). + +## -returns +Object that manages the asynchronous retrieval of the pixel data. + +## -remarks +An application should not assume that pixel data returned by this method uses any particular pixel format or alpha mode (i.e. Rgba8 with premultiplied alpha). Instead, it should always check the [BitmapPixelFormat](ibitmapframe_bitmappixelformat.md) and [BitmapAlphaMode](ibitmapframe_bitmapalphamode.md) properties and handle the data accordingly. + +As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data. + +In order to retrieve the correct bitmap pixel width and height, the application should read the [OrientedPixelWidth](ibitmapframe_orientedpixelwidth.md) and [OrientedPixelHeight](ibitmapframe_orientedpixelheight.md) properties, instead of the [PixelWidth](ibitmapframe_pixelwidth.md) and [PixelHeight](ibitmapframe_pixelheight.md) properties. + +This method is equivalent to calling the [GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](bitmapframe_getpixeldataasync_580908657.md) method with the following arguments: + + + + + + +
ArgumentValue
*pixelFormat*The value of the [BitmapPixelFormat](ibitmapframe_bitmappixelformat.md) property.
*alphaMode*The value of the [BitmapAlphaMode](ibitmapframe_bitmapalphamode.md) property
*transform*An empty transform.
*exifOrientationMode*The [ExifOrientationMode](exiforientationmode.md) value **RespectExifOrientation**.
*colorManagementMode*The [ColorManagementMode](colormanagementmode.md) value **ColorManageToSRgb**.
+ +## -examples + +## -see-also +[GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](ibitmapframe_getpixeldataasync_580908657.md) \ No newline at end of file diff --git a/windows.graphics.imaging/ibitmapframe_getpixeldataasync_580908657.md b/windows.graphics.imaging/ibitmapframe_getpixeldataasync_580908657.md index feb10badea..d388e93821 100644 --- a/windows.graphics.imaging/ibitmapframe_getpixeldataasync_580908657.md +++ b/windows.graphics.imaging/ibitmapframe_getpixeldataasync_580908657.md @@ -1,3 +1,40 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync ## -description Asynchronously requests the pixel data for the frame using the specified parameters. ## -parameters ### -param pixelFormat The specified pixel format. ### -param alphaMode The specified alpha mode. ### -param transform The set of transformations to be applied to the frame. ### -param exifOrientationMode Indicates whether the EXIF orientation flag should be ignored or respected. ### -param colorManagementMode Indicates whether the pixel data should be color managed to the sRGB color space. ## -returns Object that manages the asynchronous retrieval of the pixel data. ## -remarks This method should be used instead of [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) if the application needs finer grained control over the pixel data array. ## -examples ## -see-also [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.GetPixelDataAsync + +## -description +Asynchronously requests the pixel data for the frame using the specified parameters. + +## -parameters +### -param pixelFormat +The specified pixel format. + +### -param alphaMode +The specified alpha mode. + +### -param transform +The set of transformations to be applied to the frame. + +### -param exifOrientationMode +Indicates whether the EXIF orientation flag should be ignored or respected. + +### -param colorManagementMode +Indicates whether the pixel data should be color managed to the sRGB color space. + +## -returns +Object that manages the asynchronous retrieval of the pixel data. + +## -remarks +This method should be used instead of [GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) if the application needs finer grained control over the pixel data array. + +## -examples + +## -see-also +[GetPixelDataAsync](ibitmapframe_getpixeldataasync_1391309547.md) \ No newline at end of file diff --git a/windows.graphics.imaging/ibitmapframe_getthumbnailasync.md b/windows.graphics.imaging/ibitmapframe_getthumbnailasync.md index 52997ea7a5..e33a34928b 100644 --- a/windows.graphics.imaging/ibitmapframe_getthumbnailasync.md +++ b/windows.graphics.imaging/ibitmapframe_getthumbnailasync.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapFrame.GetThumbnailAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapFrame.GetThumbnailAsync ## -description Asynchronously retrieves the thumbnail data for the frame. ## -returns Object that manages the asynchronous retrieval of the thumbnail data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapFrame.GetThumbnailAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.GetThumbnailAsync + +## -description +Asynchronously retrieves the thumbnail data for the frame. + +## -returns +Object that manages the asynchronous retrieval of the thumbnail data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_orientedpixelheight.md b/windows.graphics.imaging/ibitmapframe_orientedpixelheight.md index 151d9d55ca..6640d2f17f 100644 --- a/windows.graphics.imaging/ibitmapframe_orientedpixelheight.md +++ b/windows.graphics.imaging/ibitmapframe_orientedpixelheight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelHeight ## -description Returns the height of the frame in pixels, after any EXIF orientation has been applied to the bitmap. ## -property-value The height of the frame in pixels, after any EXIF orientation has been applied. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelHeight + +## -description +Returns the height of the frame in pixels, after any EXIF orientation has been applied to the bitmap. + +## -property-value +The height of the frame in pixels, after any EXIF orientation has been applied. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_orientedpixelwidth.md b/windows.graphics.imaging/ibitmapframe_orientedpixelwidth.md index 426e141bc1..41654c5b6f 100644 --- a/windows.graphics.imaging/ibitmapframe_orientedpixelwidth.md +++ b/windows.graphics.imaging/ibitmapframe_orientedpixelwidth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelWidth ## -description Returns the width of the frame in pixels, after any EXIF orientation has been applied to the bitmap. ## -property-value The width of the frame in pixels, after any EXIF orientation has been applied. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.OrientedPixelWidth + +## -description +Returns the width of the frame in pixels, after any EXIF orientation has been applied to the bitmap. + +## -property-value +The width of the frame in pixels, after any EXIF orientation has been applied. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_pixelheight.md b/windows.graphics.imaging/ibitmapframe_pixelheight.md index 8c4b24e394..3c4d47f611 100644 --- a/windows.graphics.imaging/ibitmapframe_pixelheight.md +++ b/windows.graphics.imaging/ibitmapframe_pixelheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.PixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.PixelHeight ## -description Returns the height of the frame in pixels. ## -property-value The height of the frame in pixels. ## -remarks This property ignores any EXIF orientation flag value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.PixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.PixelHeight + +## -description +Returns the height of the frame in pixels. + +## -property-value +The height of the frame in pixels. + +## -remarks +This property ignores any EXIF orientation flag value. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframe_pixelwidth.md b/windows.graphics.imaging/ibitmapframe_pixelwidth.md index 244eb54d4e..f9524c5d64 100644 --- a/windows.graphics.imaging/ibitmapframe_pixelwidth.md +++ b/windows.graphics.imaging/ibitmapframe_pixelwidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.IBitmapFrame.PixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.IBitmapFrame.PixelWidth ## -description Returns the width of the frame in pixels. ## -property-value The width of the frame in pixels. ## -remarks This property ignores any EXIF orientation flag value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.IBitmapFrame.PixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.IBitmapFrame.PixelWidth + +## -description +Returns the width of the frame in pixels. + +## -property-value +The width of the frame in pixels. + +## -remarks +This property ignores any EXIF orientation flag value. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md b/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md index 72c30503db..5db57fe98f 100644 --- a/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md +++ b/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync ## -description Asynchronously retrieves a SoftwareBitmap representation of an [BitmapFrame](bitmapframe.md). ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync + +## -description +Asynchronously retrieves a SoftwareBitmap representation of an [BitmapFrame](bitmapframe.md). + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md) \ No newline at end of file diff --git a/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md b/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md index 41c62d1c41..e76ae94c2a 100644 --- a/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md +++ b/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync ## -description Asynchronously retrieves a SoftwareBitmap representation of an [BitmapFrame](bitmapframe.md). ## -parameters ### -param pixelFormat The pixel format of the software bitmap. ### -param alphaMode The alpha mode of the software bitmap. ### -param transform The transform of the software bitmap. ### -param exifOrientationMode The EXIF orientation mode of the software bitmap. ### -param colorManagementMode The color management mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode,Windows.Graphics.Imaging.BitmapTransform,Windows.Graphics.Imaging.ExifOrientationMode,Windows.Graphics.Imaging.ColorManagementMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync + +## -description +Asynchronously retrieves a SoftwareBitmap representation of an [BitmapFrame](bitmapframe.md). + +## -parameters +### -param pixelFormat +The pixel format of the software bitmap. + +### -param alphaMode +The alpha mode of the software bitmap. + +### -param transform +The transform of the software bitmap. + +### -param exifOrientationMode +The EXIF orientation mode of the software bitmap. + +### -param colorManagementMode +The color management mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md) \ No newline at end of file diff --git a/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md b/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md index 39c93bb30d..a4afe1a44b 100644 --- a/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md +++ b/windows.graphics.imaging/ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_994797489.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync ## -description Asynchronously retrieves a SoftwareBitmap representation of an [BitmapFrame](bitmapframe.md). ## -parameters ### -param pixelFormat The pixel format of the software bitmap. ### -param alphaMode The alpha mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [GetSoftwareBitmapAsync](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync(Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapFrameWithSoftwareBitmap.GetSoftwareBitmapAsync + +## -description +Asynchronously retrieves a SoftwareBitmap representation of an [BitmapFrame](bitmapframe.md). + +## -parameters +### -param pixelFormat +The pixel format of the software bitmap. + +### -param alphaMode +The alpha mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[GetSoftwareBitmapAsync](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_1163471917.md), [GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)](ibitmapframewithsoftwarebitmap_getsoftwarebitmapasync_892037303.md) \ No newline at end of file diff --git a/windows.graphics.imaging/ibitmappropertiesview_getpropertiesasync.md b/windows.graphics.imaging/ibitmappropertiesview_getpropertiesasync.md index 17e7a42cd7..0297ae7f55 100644 --- a/windows.graphics.imaging/ibitmappropertiesview_getpropertiesasync.md +++ b/windows.graphics.imaging/ibitmappropertiesview_getpropertiesasync.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Imaging.IBitmapPropertiesView.GetPropertiesAsync(Windows.Foundation.Collections.IIterable{System.String}) --api-type: winrt method ---- # Windows.Graphics.Imaging.IBitmapPropertiesView.GetPropertiesAsync ## -description Asynchronously retrieves one or more bitmap properties. ## -parameters ### -param propertiesToRetrieve A collection of strings containing the specified property keys. ## -returns Object that manages the asynchronous retrieval of the bitmap properties. ## -remarks ## -examples ## -see-also [BitmapPropertySet](bitmappropertyset.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.IBitmapPropertiesView.GetPropertiesAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.IBitmapPropertiesView.GetPropertiesAsync + +## -description +Asynchronously retrieves one or more bitmap properties. + +## -parameters +### -param propertiesToRetrieve +A collection of strings containing the specified property keys. + +## -returns +Object that manages the asynchronous retrieval of the bitmap properties. + +## -remarks + +## -examples + +## -see-also +[BitmapPropertySet](bitmappropertyset.md) \ No newline at end of file diff --git a/windows.graphics.imaging/imagestream_canread.md b/windows.graphics.imaging/imagestream_canread.md index a851bf5b03..1b48458d23 100644 --- a/windows.graphics.imaging/imagestream_canread.md +++ b/windows.graphics.imaging/imagestream_canread.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.ImageStream.CanRead --api-type: winrt property ---- # Windows.Graphics.Imaging.ImageStream.CanRead ## -description Indicates if you can read the stream. ## -property-value Indicates whether or not you can read the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.ImageStream.CanRead +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.ImageStream.CanRead + +## -description +Indicates if you can read the stream. + +## -property-value +Indicates whether or not you can read the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_canwrite.md b/windows.graphics.imaging/imagestream_canwrite.md index 52d71a8058..909b8aa09d 100644 --- a/windows.graphics.imaging/imagestream_canwrite.md +++ b/windows.graphics.imaging/imagestream_canwrite.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.ImageStream.CanWrite --api-type: winrt property ---- # Windows.Graphics.Imaging.ImageStream.CanWrite ## -description Indicates if you can write to the stream. ## -property-value Indicates whether or not you can write to the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.ImageStream.CanWrite +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.ImageStream.CanWrite + +## -description +Indicates if you can write to the stream. + +## -property-value +Indicates whether or not you can write to the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_clonestream_242904981.md b/windows.graphics.imaging/imagestream_clonestream_242904981.md index 0b6dc187ae..5fa3db06a9 100644 --- a/windows.graphics.imaging/imagestream_clonestream_242904981.md +++ b/windows.graphics.imaging/imagestream_clonestream_242904981.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.CloneStream --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.CloneStream ## -description Returns the file stream for the [ImageStream](imagestream.md). ## -returns The file stream for the image. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.CloneStream +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.CloneStream + +## -description +Returns the file stream for the [ImageStream](imagestream.md). + +## -returns +The file stream for the image. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_close_811482585.md b/windows.graphics.imaging/imagestream_close_811482585.md index 0abd9ddd14..aa660fcafc 100644 --- a/windows.graphics.imaging/imagestream_close_811482585.md +++ b/windows.graphics.imaging/imagestream_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.Close --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.Close ## -description Closes the [ImageStream](imagestream.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.Close +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.Close + +## -description +Closes the [ImageStream](imagestream.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_contenttype.md b/windows.graphics.imaging/imagestream_contenttype.md index 4723a3a595..8774e1c926 100644 --- a/windows.graphics.imaging/imagestream_contenttype.md +++ b/windows.graphics.imaging/imagestream_contenttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.ImageStream.ContentType --api-type: winrt property ---- # Windows.Graphics.Imaging.ImageStream.ContentType ## -description Returns the data format of the stream. ## -property-value The data format of the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.ImageStream.ContentType +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.ImageStream.ContentType + +## -description +Returns the data format of the stream. + +## -property-value +The data format of the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_flushasync_491532439.md b/windows.graphics.imaging/imagestream_flushasync_491532439.md index 1ecb6dcdb4..4ca884366e 100644 --- a/windows.graphics.imaging/imagestream_flushasync_491532439.md +++ b/windows.graphics.imaging/imagestream_flushasync_491532439.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.FlushAsync --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.FlushAsync ## -description Asynchronously commits the current frame data and flushes all of the data on the image stream. ## -returns An object that manages the asynchronous flush operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.FlushAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.FlushAsync + +## -description +Asynchronously commits the current frame data and flushes all of the data on the image stream. + +## -returns +An object that manages the asynchronous flush operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_getinputstreamat_1916887525.md b/windows.graphics.imaging/imagestream_getinputstreamat_1916887525.md index 18688ae996..8a9e5ac7b4 100644 --- a/windows.graphics.imaging/imagestream_getinputstreamat_1916887525.md +++ b/windows.graphics.imaging/imagestream_getinputstreamat_1916887525.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.GetInputStreamAt(System.UInt64) --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.GetInputStreamAt ## -description Returns an input stream at a specified location in a stream. ## -parameters ### -param position The location in the stream at which to begin. ## -returns The input stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.GetInputStreamAt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.GetInputStreamAt + +## -description +Returns an input stream at a specified location in a stream. + +## -parameters +### -param position +The location in the stream at which to begin. + +## -returns +The input stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_getoutputstreamat_379282997.md b/windows.graphics.imaging/imagestream_getoutputstreamat_379282997.md index 6eacdce3a1..21a020af27 100644 --- a/windows.graphics.imaging/imagestream_getoutputstreamat_379282997.md +++ b/windows.graphics.imaging/imagestream_getoutputstreamat_379282997.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.GetOutputStreamAt(System.UInt64) --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.GetOutputStreamAt ## -description Returns an output stream at a specified location in a stream. ## -parameters ### -param position The location in the output stream at which to begin. ## -returns The output stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.GetOutputStreamAt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.GetOutputStreamAt + +## -description +Returns an output stream at a specified location in a stream. + +## -parameters +### -param position +The location in the output stream at which to begin. + +## -returns +The output stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_position.md b/windows.graphics.imaging/imagestream_position.md index 526ef39f4f..f91ffdb5e5 100644 --- a/windows.graphics.imaging/imagestream_position.md +++ b/windows.graphics.imaging/imagestream_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.ImageStream.Position --api-type: winrt property ---- # Windows.Graphics.Imaging.ImageStream.Position ## -description Gets the byte offset of the stream. ## -property-value The number of bytes from the start of the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.ImageStream.Position +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.ImageStream.Position + +## -description +Gets the byte offset of the stream. + +## -property-value +The number of bytes from the start of the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_readasync_1012630619.md b/windows.graphics.imaging/imagestream_readasync_1012630619.md index e4ecdde8ce..19aff21522 100644 --- a/windows.graphics.imaging/imagestream_readasync_1012630619.md +++ b/windows.graphics.imaging/imagestream_readasync_1012630619.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.ReadAsync(Windows.Storage.Streams.IBuffer,System.UInt32,Windows.Storage.Streams.InputStreamOptions) --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.ReadAsync ## -description Reads data asynchronously from a sequential stream. ## -parameters ### -param buffer The buffer into which the asynchronous read operation stores the data. ### -param count The size of the buffer. ### -param options The options for the stream to be read. ## -returns The byte reader operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.ReadAsync(Windows.Storage.Streams.IBuffer,System.UInt32,Windows.Storage.Streams.InputStreamOptions) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.ReadAsync + +## -description +Reads data asynchronously from a sequential stream. + +## -parameters +### -param buffer +The buffer into which the asynchronous read operation stores the data. + +### -param count +The size of the buffer. + +### -param options +The options for the stream to be read. + +## -returns +The byte reader operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_seek_1797934981.md b/windows.graphics.imaging/imagestream_seek_1797934981.md index dfd865f9da..6c3a348f30 100644 --- a/windows.graphics.imaging/imagestream_seek_1797934981.md +++ b/windows.graphics.imaging/imagestream_seek_1797934981.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.Seek(System.UInt64) --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.Seek ## -description Sets the position of the stream to the specified value. ## -parameters ### -param position The new position of the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.Seek(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.Seek + +## -description +Sets the position of the stream to the specified value. + +## -parameters +### -param position +The new position of the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_size.md b/windows.graphics.imaging/imagestream_size.md index 5896b042df..711e0b6b6c 100644 --- a/windows.graphics.imaging/imagestream_size.md +++ b/windows.graphics.imaging/imagestream_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.ImageStream.Size --api-type: winrt property ---- # Windows.Graphics.Imaging.ImageStream.Size ## -description Gets or sets the size of the random access stream. ## -property-value The size of the stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.ImageStream.Size +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.ImageStream.Size + +## -description +Gets or sets the size of the random access stream. + +## -property-value +The size of the stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/imagestream_writeasync_897036872.md b/windows.graphics.imaging/imagestream_writeasync_897036872.md index 9d90455ed3..e58a8f22bf 100644 --- a/windows.graphics.imaging/imagestream_writeasync_897036872.md +++ b/windows.graphics.imaging/imagestream_writeasync_897036872.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.ImageStream.WriteAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Graphics.Imaging.ImageStream.WriteAsync ## -description Writes data asynchronously in a sequential stream. ## -parameters ### -param buffer The buffer into which the asynchronous writer operation writes. ## -returns The byte writer operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.ImageStream.WriteAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.ImageStream.WriteAsync + +## -description +Writes data asynchronously in a sequential stream. + +## -parameters +### -param buffer +The buffer into which the asynchronous writer operation writes. + +## -returns +The byte writer operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/pixeldataprovider_detachpixeldata_1386564001.md b/windows.graphics.imaging/pixeldataprovider_detachpixeldata_1386564001.md index 782ca163a7..06c0dc95ff 100644 --- a/windows.graphics.imaging/pixeldataprovider_detachpixeldata_1386564001.md +++ b/windows.graphics.imaging/pixeldataprovider_detachpixeldata_1386564001.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Graphics.Imaging.PixelDataProvider.DetachPixelData --api-type: winrt method ---- # Windows.Graphics.Imaging.PixelDataProvider.DetachPixelData ## -description Returns the internally-stored pixel data. ## -returns The pixel data. ## -remarks [PixelDataProvider](pixeldataprovider.md) doesn't retain a copy of the pixel data after a successful call to this method. This means that subsequent calls to the method will fail. The return value is an array of 8 bit unsigned values. However, depending on the requested pixel format, the pixel data may represent another type. For example, if the pixel format is Rgba16, then each color value is a 16 bit unsigned integer that takes up two 8 bit elements of the array. You must convert the array to the correct type before you use it. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.PixelDataProvider.DetachPixelData +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.PixelDataProvider.DetachPixelData + +## -description +Returns the internally-stored pixel data. + +## -returns +The pixel data. + +## -remarks +[PixelDataProvider](pixeldataprovider.md) doesn't retain a copy of the pixel data after a successful call to this method. This means that subsequent calls to the method will fail. + +The return value is an array of 8 bit unsigned values. However, depending on the requested pixel format, the pixel data may represent another type. For example, if the pixel format is Rgba16, then each color value is a 16 bit unsigned integer that takes up two 8 bit elements of the array. You must convert the array to the correct type before you use it. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap.md b/windows.graphics.imaging/softwarebitmap.md index f9d79e7155..a9bd1fe27a 100644 --- a/windows.graphics.imaging/softwarebitmap.md +++ b/windows.graphics.imaging/softwarebitmap.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Graphics.Imaging.SoftwareBitmap --api-type: winrt class ---- # Windows.Graphics.Imaging.SoftwareBitmap ## -description Represents an uncompressed bitmap. ## -remarks This class provides a representation of a bitmap that makes it easy to use with different imaging APIs. Use [GetSoftwareBitmapAsync](bitmapdecoder_getsoftwarebitmapasync.md) to create a [SoftwareBitmap](softwarebitmap.md) from a stream resource such as an image file. Use [CopyToBuffer](softwarebitmap_copytobuffer.md) and [CopyFromBuffer](softwarebitmap_copyfrombuffer.md) to copy pixel data back and forth between a [SoftwareBitmap](softwarebitmap.md) and the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md). Use [CreateCopyFromSurfaceAsync](softwarebitmap_createcopyfromsurfaceasync.md) to create a [SoftwareBitmap](softwarebitmap.md) from a [Direct3DSurface](softwarebitmap_createcopyfromsurfaceasync_1413621451.md) object. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Imaging.SoftwareBitmap +-api-type: winrt class +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap + +## -description +Represents an uncompressed bitmap. + +## -remarks +This class provides a representation of a bitmap that makes it easy to use with different imaging APIs. Use [GetSoftwareBitmapAsync](bitmapdecoder_getsoftwarebitmapasync.md) to create a [SoftwareBitmap](softwarebitmap.md) from a stream resource such as an image file. Use [CopyToBuffer](softwarebitmap_copytobuffer.md) and [CopyFromBuffer](softwarebitmap_copyfrombuffer.md) to copy pixel data back and forth between a [SoftwareBitmap](softwarebitmap.md) and the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md). Use [CreateCopyFromSurfaceAsync](softwarebitmap_createcopyfromsurfaceasync.md) to create a [SoftwareBitmap](softwarebitmap.md) from a [Direct3DSurface](softwarebitmap_createcopyfromsurfaceasync_1413621451.md) object. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_bitmapalphamode.md b/windows.graphics.imaging/softwarebitmap_bitmapalphamode.md index 290424277c..4992df82ae 100644 --- a/windows.graphics.imaging/softwarebitmap_bitmapalphamode.md +++ b/windows.graphics.imaging/softwarebitmap_bitmapalphamode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.BitmapAlphaMode --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.BitmapAlphaMode ## -description Gets the alpha mode of the software bitmap. ## -property-value The alpha mode of the software bitmap. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.BitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.BitmapAlphaMode + +## -description +Gets the alpha mode of the software bitmap. + +## -property-value +The alpha mode of the software bitmap. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_bitmappixelformat.md b/windows.graphics.imaging/softwarebitmap_bitmappixelformat.md index 9b1f50da40..25deb07adb 100644 --- a/windows.graphics.imaging/softwarebitmap_bitmappixelformat.md +++ b/windows.graphics.imaging/softwarebitmap_bitmappixelformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.BitmapPixelFormat --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.BitmapPixelFormat ## -description Gets the pixel format of the software bitmap. ## -property-value The pixel format of the software bitmap. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.BitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.BitmapPixelFormat + +## -description +Gets the pixel format of the software bitmap. + +## -property-value +The pixel format of the software bitmap. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_close_811482585.md b/windows.graphics.imaging/softwarebitmap_close_811482585.md index aebbd18d4a..9c4f3811cc 100644 --- a/windows.graphics.imaging/softwarebitmap_close_811482585.md +++ b/windows.graphics.imaging/softwarebitmap_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Close --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.Close ## -description Disposes of the object and associated resources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Close +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.Close + +## -description +Disposes of the object and associated resources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_convert_1409636469.md b/windows.graphics.imaging/softwarebitmap_convert_1409636469.md index d51298392a..c443dd1352 100644 --- a/windows.graphics.imaging/softwarebitmap_convert_1409636469.md +++ b/windows.graphics.imaging/softwarebitmap_convert_1409636469.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Convert(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.Convert ## -description Converts an existing [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) to a [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) with a different pixel format or alpha mode. ## -parameters ### -param source The software bitmap to convert. ### -param format The pixel format of the new software bitmap. ### -param alpha The alpha mode of the new software bitmap. ## -returns The converted software bitmap. ## -remarks ## -examples ## -see-also [Convert(SoftwareBitmap, BitmapPixelFormat)](softwarebitmap_convert_1795986323.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Convert(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Graphics.Imaging.BitmapPixelFormat,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.Convert + +## -description +Converts an existing [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) to a [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) with a different pixel format or alpha mode. + +## -parameters +### -param source +The software bitmap to convert. + +### -param format +The pixel format of the new software bitmap. + +### -param alpha +The alpha mode of the new software bitmap. + +## -returns +The converted software bitmap. + +## -remarks + +## -examples + +## -see-also +[Convert(SoftwareBitmap, BitmapPixelFormat)](softwarebitmap_convert_1795986323.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_convert_1795986323.md b/windows.graphics.imaging/softwarebitmap_convert_1795986323.md index 63e8e9f4e6..59229f67f6 100644 --- a/windows.graphics.imaging/softwarebitmap_convert_1795986323.md +++ b/windows.graphics.imaging/softwarebitmap_convert_1795986323.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Convert(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Graphics.Imaging.BitmapPixelFormat) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.Convert ## -description Converts an existing [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) to a [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) with a different pixel format. ## -parameters ### -param source The software bitmap to convert. ### -param format The pixel format of the new software bitmap. ## -returns The converted software bitmap. ## -remarks ## -examples ## -see-also [Convert(SoftwareBitmap, BitmapPixelFormat, BitmapAlphaMode)](softwarebitmap_convert_1409636469.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Convert(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Graphics.Imaging.BitmapPixelFormat) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.Convert + +## -description +Converts an existing [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) to a [SoftwareBitmap](bitmapdecoder_getsoftwarebitmapasync.md) with a different pixel format. + +## -parameters +### -param source +The software bitmap to convert. + +### -param format +The pixel format of the new software bitmap. + +## -returns +The converted software bitmap. + +## -remarks + +## -examples + +## -see-also +[Convert(SoftwareBitmap, BitmapPixelFormat, BitmapAlphaMode)](softwarebitmap_convert_1409636469.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_copy_139195570.md b/windows.graphics.imaging/softwarebitmap_copy_139195570.md index 76a700f487..470ed40425 100644 --- a/windows.graphics.imaging/softwarebitmap_copy_139195570.md +++ b/windows.graphics.imaging/softwarebitmap_copy_139195570.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Copy(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.Copy ## -description Creates a copy of the provided [SoftwareBitmap](softwarebitmap.md) object. ## -parameters ### -param source The software bitmap to copy. ## -returns The newly created copy of the software bitmap. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.Copy(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.Copy + +## -description +Creates a copy of the provided [SoftwareBitmap](softwarebitmap.md) object. + +## -parameters +### -param source +The software bitmap to copy. + +## -returns +The newly created copy of the software bitmap. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_copyfrombuffer_50356126.md b/windows.graphics.imaging/softwarebitmap_copyfrombuffer_50356126.md index 0fc78ca606..fdb0defe57 100644 --- a/windows.graphics.imaging/softwarebitmap_copyfrombuffer_50356126.md +++ b/windows.graphics.imaging/softwarebitmap_copyfrombuffer_50356126.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CopyFromBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CopyFromBuffer ## -description Copies the pixel data from an IBuffer into the [SoftwareBitmap](softwarebitmap.md). ## -parameters ### -param buffer The buffer containing the pixel data to be copied. ## -remarks Use this method to copy data from the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md) into an existing [SoftwareBitmap](softwarebitmap.md). This method assumes that the input buffer has the same pixel format, width, height, color space, alpha mode, and DPI. It also assumes that the data in the buffer is contiguous, meaning that no IBuffer implicitly has the same format/width/height/color-space/alpha-mode/dpi. In other words, it expects that the stride of the image is equal to the width, with no additional padding. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CopyFromBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CopyFromBuffer + +## -description +Copies the pixel data from an IBuffer into the [SoftwareBitmap](softwarebitmap.md). + +## -parameters +### -param buffer +The buffer containing the pixel data to be copied. + +## -remarks +Use this method to copy data from the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md) into an existing [SoftwareBitmap](softwarebitmap.md). + +This method assumes that the input buffer has the same pixel format, width, height, color space, alpha mode, and DPI. It also assumes that the data in the buffer is contiguous, meaning that no IBuffer implicitly has the same format/width/height/color-space/alpha-mode/dpi. In other words, it expects that the stride of the image is equal to the width, with no additional padding. + + + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_copyto_1322243868.md b/windows.graphics.imaging/softwarebitmap_copyto_1322243868.md index a9833236e7..113d24084f 100644 --- a/windows.graphics.imaging/softwarebitmap_copyto_1322243868.md +++ b/windows.graphics.imaging/softwarebitmap_copyto_1322243868.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CopyTo(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CopyTo ## -description Copies the current [SoftwareBitmap](softwarebitmap.md) into the provided [SoftwareBitmap](softwarebitmap.md) object. ## -parameters ### -param bitmap The target software bitmap into which the data will be copied. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CopyTo(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CopyTo + +## -description +Copies the current [SoftwareBitmap](softwarebitmap.md) into the provided [SoftwareBitmap](softwarebitmap.md) object. + +## -parameters +### -param bitmap +The target software bitmap into which the data will be copied. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_copytobuffer_1167750415.md b/windows.graphics.imaging/softwarebitmap_copytobuffer_1167750415.md index a1b7508337..26477ee04f 100644 --- a/windows.graphics.imaging/softwarebitmap_copytobuffer_1167750415.md +++ b/windows.graphics.imaging/softwarebitmap_copytobuffer_1167750415.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CopyToBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CopyToBuffer ## -description Copies the software bitmap pixel data into the specified [IBuffer](../windows.storage.streams/ibuffer.md). ## -parameters ### -param buffer The target buffer to which the pixel data will be copied. ## -remarks Use this method to copy pixel data from a [SoftwareBitmap](softwarebitmap.md) into the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CopyToBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CopyToBuffer + +## -description +Copies the software bitmap pixel data into the specified [IBuffer](../windows.storage.streams/ibuffer.md). + +## -parameters +### -param buffer +The target buffer to which the pixel data will be copied. + +## -remarks +Use this method to copy pixel data from a [SoftwareBitmap](softwarebitmap.md) into the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md). + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1229594131.md b/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1229594131.md index 5b404b73d7..23fbc06439 100644 --- a/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1229594131.md +++ b/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1229594131.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer ## -description Creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided buffer. Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the buffer from which it was created. ## -parameters ### -param source The source buffer from which the copy will be created. ### -param format The pixel format of the software bitmap. ### -param width The width of the software bitmap, in pixels. ### -param height The height of the software bitmap, in pixels. ## -returns The new software bitmap. ## -remarks Use this method and its overloads to copy data from the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md) into an existing [SoftwareBitmap](softwarebitmap.md). ## -examples ## -see-also [CreateCopyFromBuffer(IBuffer, BitmapPixelFormat, Int32, Int32, BitmapAlphaMode)](softwarebitmap_createcopyfrombuffer_1251135091.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer + +## -description +Creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided buffer. Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the buffer from which it was created. + +## -parameters +### -param source +The source buffer from which the copy will be created. + +### -param format +The pixel format of the software bitmap. + +### -param width +The width of the software bitmap, in pixels. + +### -param height +The height of the software bitmap, in pixels. + +## -returns +The new software bitmap. + +## -remarks +Use this method and its overloads to copy data from the [PixelBuffer](../windows.ui.xaml.media.imaging/writeablebitmap_pixelbuffer.md) of a [WriteableBitmap](../windows.ui.xaml.media.imaging/writeablebitmap.md) into an existing [SoftwareBitmap](softwarebitmap.md). + + + +## -examples + +## -see-also +[CreateCopyFromBuffer(IBuffer, BitmapPixelFormat, Int32, Int32, BitmapAlphaMode)](softwarebitmap_createcopyfrombuffer_1251135091.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1251135091.md b/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1251135091.md index 1a9a9df3cf..583508000e 100644 --- a/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1251135091.md +++ b/windows.graphics.imaging/softwarebitmap_createcopyfrombuffer_1251135091.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer ## -description Creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided buffer. Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the buffer from which it was created. ## -parameters ### -param source The source buffer from which the copy will be created. ### -param format The pixel format of the software bitmap. ### -param width The width of the software bitmap, in pixels. ### -param height The height of the software bitmap, in pixels. ### -param alpha The alpha mode of the software bitmap. ## -returns The new software bitmap. ## -remarks ## -examples ## -see-also [CreateCopyFromBuffer(IBuffer, BitmapPixelFormat, Int32, Int32)](softwarebitmap_createcopyfrombuffer_1229594131.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromBuffer + +## -description +Creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided buffer. Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the buffer from which it was created. + +## -parameters +### -param source +The source buffer from which the copy will be created. + +### -param format +The pixel format of the software bitmap. + +### -param width +The width of the software bitmap, in pixels. + +### -param height +The height of the software bitmap, in pixels. + +### -param alpha +The alpha mode of the software bitmap. + +## -returns +The new software bitmap. + +## -remarks + +## -examples + +## -see-also +[CreateCopyFromBuffer(IBuffer, BitmapPixelFormat, Int32, Int32)](softwarebitmap_createcopyfrombuffer_1229594131.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_1666076722.md b/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_1666076722.md index d4967e011a..812c741e57 100644 --- a/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_1666076722.md +++ b/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_1666076722.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync ## -description Asynchronously creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) . Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the surface from which it was created. ## -parameters ### -param surface The source surface from which the copy will be created. ### -param alpha The alpha mode of the software bitmap. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [CreateCopyFromSurfaceAsync(IDirect3DSurface)](softwarebitmap_createcopyfromsurfaceasync_1413621451.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync + +## -description +Asynchronously creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) . Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the surface from which it was created. + +## -parameters +### -param surface +The source surface from which the copy will be created. + +### -param alpha +The alpha mode of the software bitmap. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[CreateCopyFromSurfaceAsync(IDirect3DSurface)](softwarebitmap_createcopyfromsurfaceasync_1413621451.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_53824062.md b/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_53824062.md index 70cdbd207a..602cbf96f1 100644 --- a/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_53824062.md +++ b/windows.graphics.imaging/softwarebitmap_createcopyfromsurfaceasync_53824062.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync ## -description Asynchronously creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md). Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the surface from which it was created. ## -parameters ### -param surface The source surface from which the copy will be created. ## -returns An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. ## -remarks ## -examples ## -see-also [CreateCopyFromSurfaceAsync(IDirect3DSurface, BitmapAlphaMode)](softwarebitmap_createcopyfromsurfaceasync_876166343.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.CreateCopyFromSurfaceAsync + +## -description +Asynchronously creates a new [SoftwareBitmap](softwarebitmap.md) by performing a deep copy of the provided [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md). Modifications to the data in the new [SoftwareBitmap](softwarebitmap.md) will not effect the surface from which it was created. + +## -parameters +### -param surface +The source surface from which the copy will be created. + +## -returns +An asynchronous operation that returns a [SoftwareBitmap](softwarebitmap.md) on successful completion. + +## -remarks + +## -examples + +## -see-also +[CreateCopyFromSurfaceAsync(IDirect3DSurface, BitmapAlphaMode)](softwarebitmap_createcopyfromsurfaceasync_876166343.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_dpix.md b/windows.graphics.imaging/softwarebitmap_dpix.md index 6c1aee51fb..0d3f829777 100644 --- a/windows.graphics.imaging/softwarebitmap_dpix.md +++ b/windows.graphics.imaging/softwarebitmap_dpix.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.DpiX --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.DpiX ## -description Gets or sets the dots per inch of the software bitmap in the X direction. ## -property-value The dots per inch of the software bitmap in the X direction. ## -remarks [DpiX](softwarebitmap_dpix.md) and [DpiY](softwarebitmap_dpiy.md) are metadata about the bitmap. Modifying these values does not scale the image. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.DpiX +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.DpiX + +## -description +Gets or sets the dots per inch of the software bitmap in the X direction. + +## -property-value +The dots per inch of the software bitmap in the X direction. + +## -remarks +[DpiX](softwarebitmap_dpix.md) and [DpiY](softwarebitmap_dpiy.md) are metadata about the bitmap. Modifying these values does not scale the image. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_dpiy.md b/windows.graphics.imaging/softwarebitmap_dpiy.md index 0f5844cc97..4a07c2a153 100644 --- a/windows.graphics.imaging/softwarebitmap_dpiy.md +++ b/windows.graphics.imaging/softwarebitmap_dpiy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.DpiY --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.DpiY ## -description Gets or sets the dots per inch of the software bitmap in the Y direction. ## -property-value The dots per inch of the software bitmap in the Y direction. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.DpiY +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.DpiY + +## -description +Gets or sets the dots per inch of the software bitmap in the Y direction. + +## -property-value +The dots per inch of the software bitmap in the Y direction. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_getreadonlyview_61352165.md b/windows.graphics.imaging/softwarebitmap_getreadonlyview_61352165.md index f90a9f4ab4..0b3084199a 100644 --- a/windows.graphics.imaging/softwarebitmap_getreadonlyview_61352165.md +++ b/windows.graphics.imaging/softwarebitmap_getreadonlyview_61352165.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.GetReadOnlyView --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.GetReadOnlyView ## -description Gets a read-only representation of the [SoftwareBitmap](softwarebitmap.md) object. ## -returns A read-only representation of the [SoftwareBitmap](softwarebitmap.md) object. ## -remarks Determine if a software bitmap can be modified by checking the [IsReadOnly](softwarebitmap_isreadonly.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.GetReadOnlyView +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.GetReadOnlyView + +## -description +Gets a read-only representation of the [SoftwareBitmap](softwarebitmap.md) object. + +## -returns +A read-only representation of the [SoftwareBitmap](softwarebitmap.md) object. + +## -remarks +Determine if a software bitmap can be modified by checking the [IsReadOnly](softwarebitmap_isreadonly.md) property. + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_isreadonly.md b/windows.graphics.imaging/softwarebitmap_isreadonly.md index 303a3fa44e..4a779d06ca 100644 --- a/windows.graphics.imaging/softwarebitmap_isreadonly.md +++ b/windows.graphics.imaging/softwarebitmap_isreadonly.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.IsReadOnly --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.IsReadOnly ## -description Gets a value indicating whether the software bitmap can be modified. ## -property-value True if the software bitmap is read-only; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.IsReadOnly +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.IsReadOnly + +## -description +Gets a value indicating whether the software bitmap can be modified. + +## -property-value +True if the software bitmap is read-only; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_lockbuffer_109667063.md b/windows.graphics.imaging/softwarebitmap_lockbuffer_109667063.md index 4dd08fc3e7..f256cbd169 100644 --- a/windows.graphics.imaging/softwarebitmap_lockbuffer_109667063.md +++ b/windows.graphics.imaging/softwarebitmap_lockbuffer_109667063.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.LockBuffer(Windows.Graphics.Imaging.BitmapBufferAccessMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.LockBuffer ## -description Gets a [BitmapBuffer](bitmapbuffer.md) object that allows you to operate directly on the software bitmap's pixel data. ## -parameters ### -param mode A value indicating the access mode of the returned buffer. ## -returns The buffer containing pixel data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.LockBuffer(Windows.Graphics.Imaging.BitmapBufferAccessMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.LockBuffer + +## -description +Gets a [BitmapBuffer](bitmapbuffer.md) object that allows you to operate directly on the software bitmap's pixel data. + +## -parameters +### -param mode +A value indicating the access mode of the returned buffer. + +## -returns +The buffer containing pixel data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_pixelheight.md b/windows.graphics.imaging/softwarebitmap_pixelheight.md index c3f1127b0a..8da79fe716 100644 --- a/windows.graphics.imaging/softwarebitmap_pixelheight.md +++ b/windows.graphics.imaging/softwarebitmap_pixelheight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.PixelHeight --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.PixelHeight ## -description Gets the height of the software bitmap, in pixels. ## -property-value The height of the software bitmap, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.PixelHeight +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.PixelHeight + +## -description +Gets the height of the software bitmap, in pixels. + +## -property-value +The height of the software bitmap, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_pixelwidth.md b/windows.graphics.imaging/softwarebitmap_pixelwidth.md index 44cc34faf1..aa2e16cb4a 100644 --- a/windows.graphics.imaging/softwarebitmap_pixelwidth.md +++ b/windows.graphics.imaging/softwarebitmap_pixelwidth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.PixelWidth --api-type: winrt property ---- # Windows.Graphics.Imaging.SoftwareBitmap.PixelWidth ## -description Gets the width of the software bitmap, in pixels. ## -property-value The width of the software bitmap, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Imaging.SoftwareBitmap.PixelWidth +-api-type: winrt property +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.PixelWidth + +## -description +Gets the width of the software bitmap, in pixels. + +## -property-value +The width of the software bitmap, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.imaging/softwarebitmap_softwarebitmap_1931895268.md b/windows.graphics.imaging/softwarebitmap_softwarebitmap_1931895268.md index db3a032505..21f078e047 100644 --- a/windows.graphics.imaging/softwarebitmap_softwarebitmap_1931895268.md +++ b/windows.graphics.imaging/softwarebitmap_softwarebitmap_1931895268.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.#ctor(Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32,Windows.Graphics.Imaging.BitmapAlphaMode) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.SoftwareBitmap ## -description Initializes a new instance of the [SoftwareBitmap](softwarebitmap.md) class. ## -parameters ### -param format The pixel format of the new software bitmap. ### -param width The width of the new software bitmap, in pixels. ### -param height The height of the new software bitmap, in pixels. ### -param alpha The alpha mode of the new software bitmap. ## -remarks ## -examples ## -see-also [SoftwareBitmap(BitmapPixelFormat, Int32, Int32)](softwarebitmap_softwarebitmap_221640236.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.#ctor(Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32,Windows.Graphics.Imaging.BitmapAlphaMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.SoftwareBitmap + +## -description +Initializes a new instance of the [SoftwareBitmap](softwarebitmap.md) class. + +## -parameters +### -param format +The pixel format of the new software bitmap. + +### -param width +The width of the new software bitmap, in pixels. + +### -param height +The height of the new software bitmap, in pixels. + +### -param alpha +The alpha mode of the new software bitmap. + +## -remarks + +## -examples + +## -see-also +[SoftwareBitmap(BitmapPixelFormat, Int32, Int32)](softwarebitmap_softwarebitmap_221640236.md) \ No newline at end of file diff --git a/windows.graphics.imaging/softwarebitmap_softwarebitmap_221640236.md b/windows.graphics.imaging/softwarebitmap_softwarebitmap_221640236.md index 09bc9f0aa1..99529e3070 100644 --- a/windows.graphics.imaging/softwarebitmap_softwarebitmap_221640236.md +++ b/windows.graphics.imaging/softwarebitmap_softwarebitmap_221640236.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.#ctor(Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32) --api-type: winrt method ---- # Windows.Graphics.Imaging.SoftwareBitmap.SoftwareBitmap ## -description Initializes a new instance of the [SoftwareBitmap](softwarebitmap.md) class. ## -parameters ### -param format The pixel format of the new software bitmap. ### -param width The width of the new software bitmap, in pixels. ### -param height The height of the new software bitmap, in pixels. ## -remarks ## -examples ## -see-also [SoftwareBitmap(BitmapPixelFormat, Int32, Int32, BitmapAlphaMode)](softwarebitmap_softwarebitmap_1931895268.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Imaging.SoftwareBitmap.#ctor(Windows.Graphics.Imaging.BitmapPixelFormat,System.Int32,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Imaging.SoftwareBitmap.SoftwareBitmap + +## -description +Initializes a new instance of the [SoftwareBitmap](softwarebitmap.md) class. + +## -parameters +### -param format +The pixel format of the new software bitmap. + +### -param width +The width of the new software bitmap, in pixels. + +### -param height +The height of the new software bitmap, in pixels. + +## -remarks + +## -examples + +## -see-also +[SoftwareBitmap(BitmapPixelFormat, Int32, Int32, BitmapAlphaMode)](softwarebitmap_softwarebitmap_1931895268.md) \ No newline at end of file diff --git a/windows.graphics.printing.optiondetails/iprintcustomoptiondetails_displayname.md b/windows.graphics.printing.optiondetails/iprintcustomoptiondetails_displayname.md index 595bf01aed..eaab63044c 100644 --- a/windows.graphics.printing.optiondetails/iprintcustomoptiondetails_displayname.md +++ b/windows.graphics.printing.optiondetails/iprintcustomoptiondetails_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails.DisplayName --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails.DisplayName ## -description Gets or sets the display name of the custom print task option. ## -property-value The display name of the custom print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails.DisplayName +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails.DisplayName + +## -description +Gets or sets the display name of the custom print task option. + +## -property-value +The display name of the custom print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintitemlistoptiondetails_items.md b/windows.graphics.printing.optiondetails/iprintitemlistoptiondetails_items.md index 310d837ec5..415225c22b 100644 --- a/windows.graphics.printing.optiondetails/iprintitemlistoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/iprintitemlistoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails.Items ## -description Gets a list of the print task option items. ## -property-value A pointer to the list of the print task option items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails.Items + +## -description +Gets a list of the print task option items. + +## -property-value +A pointer to the list of the print task option items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_maxvalue.md b/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_maxvalue.md index 1157743c90..a811d9c29f 100644 --- a/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_maxvalue.md +++ b/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_maxvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MaxValue --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MaxValue ## -description Gets the maximum enumerated value of the print task option. ## -property-value The maximum enumerated value of the print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MaxValue +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MaxValue + +## -description +Gets the maximum enumerated value of the print task option. + +## -property-value +The maximum enumerated value of the print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_minvalue.md b/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_minvalue.md index 9c88f798af..8f1d8e666a 100644 --- a/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_minvalue.md +++ b/windows.graphics.printing.optiondetails/iprintnumberoptiondetails_minvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MinValue --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MinValue ## -description Gets the minimum enumerated value of the print task option. ## -property-value The minimum enumerated value of the print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MinValue +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails.MinValue + +## -description +Gets the minimum enumerated value of the print task option. + +## -property-value +The minimum enumerated value of the print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/iprintoptiondetails_errortext.md index cda934cbfa..23eb201e0c 100644 --- a/windows.graphics.printing.optiondetails/iprintoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/iprintoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/iprintoptiondetails_optionid.md index 60a48be95c..6fafcc6ae0 100644 --- a/windows.graphics.printing.optiondetails/iprintoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/iprintoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionId ## -description Gets the ID for a print task option. ## -property-value The ID for the print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionId + +## -description +Gets the ID for a print task option. + +## -property-value +The ID for the print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/iprintoptiondetails_optiontype.md index 6881de87db..efce42344d 100644 --- a/windows.graphics.printing.optiondetails/iprintoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/iprintoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionType ## -description Gets the option type for a print task option. ## -property-value The option type for a print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.OptionType + +## -description +Gets the option type for a print task option. + +## -property-value +The option type for a print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintoptiondetails_state.md b/windows.graphics.printing.optiondetails/iprintoptiondetails_state.md index 47d9a024d5..56970bfeaa 100644 --- a/windows.graphics.printing.optiondetails/iprintoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/iprintoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.State ## -description Gets or sets the state of a print task option. ## -property-value The state of a print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.State + +## -description +Gets or sets the state of a print task option. + +## -property-value +The state of a print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintoptiondetails_trysetvalue.md b/windows.graphics.printing.optiondetails/iprintoptiondetails_trysetvalue.md index 6c557faef6..a3c0804a9f 100644 --- a/windows.graphics.printing.optiondetails/iprintoptiondetails_trysetvalue.md +++ b/windows.graphics.printing.optiondetails/iprintoptiondetails_trysetvalue.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.TrySetValue ## -description Sets the value for the print task option. ## -parameters ### -param value Value for the print task option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.TrySetValue + +## -description +Sets the value for the print task option. + +## -parameters +### -param value +Value for the print task option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprintoptiondetails_value.md b/windows.graphics.printing.optiondetails/iprintoptiondetails_value.md index d7e09dc664..b003472cf9 100644 --- a/windows.graphics.printing.optiondetails/iprintoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/iprintoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.Value ## -description Gets the enumerated value of a print task option. ## -property-value The enumerated value of a print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails.Value + +## -description +Gets the enumerated value of a print task option. + +## -property-value +The enumerated value of a print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/iprinttextoptiondetails_maxcharacters.md b/windows.graphics.printing.optiondetails/iprinttextoptiondetails_maxcharacters.md index da80b28fc8..5ae2beb08d 100644 --- a/windows.graphics.printing.optiondetails/iprinttextoptiondetails_maxcharacters.md +++ b/windows.graphics.printing.optiondetails/iprinttextoptiondetails_maxcharacters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintTextOptionDetails.MaxCharacters --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.IPrintTextOptionDetails.MaxCharacters ## -description Gets the maximum allowed number of characters for the text of a print task option. ## -property-value The maximum allowed number of characters for the text of a print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.IPrintTextOptionDetails.MaxCharacters +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.IPrintTextOptionDetails.MaxCharacters + +## -description +Gets the maximum allowed number of characters for the text of a print task option. + +## -property-value +The maximum allowed number of characters for the text of a print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_errortext.md index 49e3a4f2a2..d4592e2abd 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_items.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_items.md index d2d6b18c91..b1368eb1e0 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Items ## -description Gets the list of items for the print binding options. ## -property-value A pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Items + +## -description +Gets the list of items for the print binding options. + +## -property-value +A pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_optionid.md index a5c7e1d9d3..da27372db3 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionId ## -description Gets the ID of the print binding option. ## -property-value The ID of the print binding option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionId + +## -description +Gets the ID of the print binding option. + +## -property-value +The ID of the print binding option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_optiontype.md index 079be45eaa..62075db416 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionType ## -description Gets the option type of the print binding option. ## -property-value The binding option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.OptionType + +## -description +Gets the option type of the print binding option. + +## -property-value +The binding option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_state.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_state.md index 833fc03916..a225066ca4 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.State ## -description Gets or sets the state of the print binding option. ## -property-value The binding option state. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.State + +## -description +Gets or sets the state of the print binding option. + +## -property-value +The binding option state. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_trysetvalue_1013845356.md index 8b3e2ae996..b899093cbd 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.TrySetValue ## -description Sets the value for the print binding option. ## -parameters ### -param value Value for the print binding option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.TrySetValue + +## -description +Sets the value for the print binding option. + +## -parameters +### -param value +Value for the print binding option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printbindingoptiondetails_value.md b/windows.graphics.printing.optiondetails/printbindingoptiondetails_value.md index 7ecd1359fd..5965719f6d 100644 --- a/windows.graphics.printing.optiondetails/printbindingoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printbindingoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Value ## -description Gets or sets the enumerated value of the print binding option. ## -property-value The binding option value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBindingOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print binding option. + +## -property-value +The binding option value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails.md index 2587bcb6b5..8a7bea6726 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails.md @@ -1,3 +1,38 @@ ---- -api-id: T:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails --api-type: winrt class ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails ## -description Represents the list of print bordering options. ## -remarks Here is a JavaScript code snippet that shows how to retrieve the object: ```javascript // Retrieve the advanced Print Task Options var printDetailedOptions = Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.getFromPrintTaskOptions(printTask.options); // get the object var printBorderingOptionDetails = printDetailedOptions.options.lookup(Windows.Graphics.Printing.StandardPrintTaskOptions.bordering); ``` ## -examples ## -see-also [IPrintOptionDetails](iprintoptiondetails.md), [IPrintItemListOptionDetails](iprintitemlistoptiondetails.md) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails + +## -description +Represents the list of print bordering options. + +## -remarks +Here is a JavaScript code snippet that shows how to retrieve the object: + + + + + +```javascript +// Retrieve the advanced Print Task Options +var printDetailedOptions = + Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.getFromPrintTaskOptions(printTask.options); + +// get the object +var printBorderingOptionDetails = + printDetailedOptions.options.lookup(Windows.Graphics.Printing.StandardPrintTaskOptions.bordering); + +``` + + + +## -examples + +## -see-also +[IPrintOptionDetails](iprintoptiondetails.md), [IPrintItemListOptionDetails](iprintitemlistoptiondetails.md) \ No newline at end of file diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_errortext.md index 80ad01078e..85b3db0527 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_items.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_items.md index 8d6213e8e7..64a5d74b85 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Items ## -description Gets the list of items for the print bordering options. ## -property-value A pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Items + +## -description +Gets the list of items for the print bordering options. + +## -property-value +A pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_optionid.md index bf8f675ffc..f0b8635888 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionId ## -description Gets the ID of the print bordering option. ## -property-value The ID of the print bordering option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionId + +## -description +Gets the ID of the print bordering option. + +## -property-value +The ID of the print bordering option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_optiontype.md index 3db11579c9..3501f2b1a7 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionType ## -description Gets the option type of the print bordering option. ## -property-value The bordering option type ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.OptionType + +## -description +Gets the option type of the print bordering option. + +## -property-value +The bordering option type + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_state.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_state.md index 0281055fc9..06e9c50f8b 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.State ## -description Gets or sets the state of the print bordering option. ## -property-value The print bordering option state. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.State + +## -description +Gets or sets the state of the print bordering option. + +## -property-value +The print bordering option state. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_trysetvalue_1013845356.md index 24293169cb..b3d28a591d 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.TrySetValue ## -description Sets the value for the print bordering option. ## -parameters ### -param value Value for the print bordering option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.TrySetValue + +## -description +Sets the value for the print bordering option. + +## -parameters +### -param value +Value for the print bordering option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printborderingoptiondetails_value.md b/windows.graphics.printing.optiondetails/printborderingoptiondetails_value.md index cd927e4574..f7419b91b9 100644 --- a/windows.graphics.printing.optiondetails/printborderingoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printborderingoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Value ## -description Gets or sets the enumerated value of the print bordering option. ## -property-value The bordering option value ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintBorderingOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print bordering option. + +## -property-value +The bordering option value + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_errortext.md index 8398219ef8..7205d9aebf 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_items.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_items.md index ea80b8d746..b101367b15 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Items ## -description Gets the list of items for the print collation option. ## -property-value Pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Items + +## -description +Gets the list of items for the print collation option. + +## -property-value +Pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_optionid.md index 1361ee68c3..7c88ec263c 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionId ## -description Gets the ID of the print collation option. ## -property-value The ID of the collation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionId + +## -description +Gets the ID of the print collation option. + +## -property-value +The ID of the collation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_optiontype.md index c031230130..e7494c2e10 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionType ## -description Gets the option type for the print collation option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.OptionType + +## -description +Gets the option type for the print collation option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_state.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_state.md index 986c67b23b..b0944cc086 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.State ## -description Gets or sets the state of the print collation option. ## -property-value The state of the collation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.State + +## -description +Gets or sets the state of the print collation option. + +## -property-value +The state of the collation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_trysetvalue_1013845356.md index 3e3c0801fd..074a77596d 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.TrySetValue ## -description Sets the value for the print collation option. ## -parameters ### -param value Value for the print collation option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.TrySetValue + +## -description +Sets the value for the print collation option. + +## -parameters +### -param value +Value for the print collation option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcollationoptiondetails_value.md b/windows.graphics.printing.optiondetails/printcollationoptiondetails_value.md index 10dbd765f3..e94fb6de11 100644 --- a/windows.graphics.printing.optiondetails/printcollationoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printcollationoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Value ## -description Gets or sets the enumerated value of the print collation option. ## -property-value The value of the print collation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCollationOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print collation option. + +## -property-value +The value of the print collation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_errortext.md index 47cb9935fc..e73d14214b 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_items.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_items.md index 588b584282..c6570e3fc5 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Items ## -description Gets the list of items for the print color mode option. ## -property-value Pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Items + +## -description +Gets the list of items for the print color mode option. + +## -property-value +Pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optionid.md index c7683ae980..c8b6889512 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionId ## -description Gets the ID for the print color mode option. ## -property-value The ID of the color mode option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionId + +## -description +Gets the ID for the print color mode option. + +## -property-value +The ID of the color mode option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optiontype.md index 093935c865..fb299e8193 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionType ## -description Gets the option type for the print color mode option. ## -property-value The color mode option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.OptionType + +## -description +Gets the option type for the print color mode option. + +## -property-value +The color mode option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_state.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_state.md index 1375bf7d97..e6f9490cc1 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.State ## -description Gets or sets the state of the print color mode option. ## -property-value The state of the print color mode option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.State + +## -description +Gets or sets the state of the print color mode option. + +## -property-value +The state of the print color mode option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_trysetvalue_1013845356.md index efa2b4395a..36ba2cbd04 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.TrySetValue ## -description Sets the value for the print color mode option. ## -parameters ### -param value Value for the print color mode option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.TrySetValue + +## -description +Sets the value for the print color mode option. + +## -parameters +### -param value +Value for the print color mode option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_value.md b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_value.md index 75b09eb4b7..3b5ab67799 100644 --- a/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printcolormodeoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Value ## -description Gets or sets the enumerated value of the print color mode option. ## -property-value The state of the print color mode option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintColorModeOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print color mode option. + +## -property-value +The state of the print color mode option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_errortext.md index 5f980cde59..59bea1fd3a 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_maxvalue.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_maxvalue.md index c8883ce2d9..be1416dce5 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_maxvalue.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_maxvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MaxValue --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MaxValue ## -description Gets the value for the maximum number of printed copies allowed. ## -property-value The maximum number of printed copies allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MaxValue +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MaxValue + +## -description +Gets the value for the maximum number of printed copies allowed. + +## -property-value +The maximum number of printed copies allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_minvalue.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_minvalue.md index 29dbaea908..49860be0e8 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_minvalue.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_minvalue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MinValue --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MinValue ## -description Gets the value for the minimum number of printed copies allowed. ## -property-value The minimum number of printed copies allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MinValue +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.MinValue + +## -description +Gets the value for the minimum number of printed copies allowed. + +## -property-value +The minimum number of printed copies allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optionid.md index 858002053a..7fdcc70472 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionId ## -description Gets the ID for the option for the number of printed copies. ## -property-value The ID of the option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionId + +## -description +Gets the ID for the option for the number of printed copies. + +## -property-value +The ID of the option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optiontype.md index 489fd2bef2..40a3a129b1 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionType ## -description Gets the option type for the option for the number of printed copies. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.OptionType + +## -description +Gets the option type for the option for the number of printed copies. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_state.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_state.md index cc690ca82a..086469e54f 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.State ## -description Gets or sets the state of the option for the number of printed copies. ## -property-value The state of the option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.State + +## -description +Gets or sets the state of the option for the number of printed copies. + +## -property-value +The state of the option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_trysetvalue_1013845356.md index 46364b540e..670b0935a4 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.TrySetValue ## -description Sets the value for the print copies option. ## -parameters ### -param value Value for the print copies option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.TrySetValue + +## -description +Sets the value for the print copies option. + +## -parameters +### -param value +Value for the print copies option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_value.md b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_value.md index 283d1adbc8..67f86fa201 100644 --- a/windows.graphics.printing.optiondetails/printcopiesoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printcopiesoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.Value ## -description Gets or sets the number of copies for a print task. ## -property-value The number of copies for a print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCopiesOptionDetails.Value + +## -description +Gets or sets the number of copies for a print task. + +## -property-value +The number of copies for a print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemdetails_itemdisplayname.md b/windows.graphics.printing.optiondetails/printcustomitemdetails_itemdisplayname.md index 4f6a51bdfd..7531f54cfe 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemdetails_itemdisplayname.md +++ b/windows.graphics.printing.optiondetails/printcustomitemdetails_itemdisplayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemDisplayName --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemDisplayName ## -description Gets or sets the display name of the custom print task option item. ## -property-value The display name of the option item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemDisplayName +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemDisplayName + +## -description +Gets or sets the display name of the custom print task option item. + +## -property-value +The display name of the option item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemdetails_itemid.md b/windows.graphics.printing.optiondetails/printcustomitemdetails_itemid.md index 7f32baa5d8..dc58ffc7e2 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemdetails_itemid.md +++ b/windows.graphics.printing.optiondetails/printcustomitemdetails_itemid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemId ## -description Gets the ID of the custom print task option item. ## -property-value The ID of the print task option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemDetails.ItemId + +## -description +Gets the ID of the custom print task option item. + +## -property-value +The ID of the print task option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_additem_2137060916.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_additem_2137060916.md index 9d48a86618..c8b75ee607 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_additem_2137060916.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_additem_2137060916.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.AddItem(System.String,System.String) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.AddItem ## -description Sets the ID or display name of an item in the list of custom print task options. ## -parameters ### -param itemId The ID of the option item. ### -param displayName The display name of the option item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.AddItem(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.AddItem + +## -description +Sets the ID or display name of an item in the list of custom print task options. + +## -parameters +### -param itemId +The ID of the option item. + +### -param displayName +The display name of the option item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_displayname.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_displayname.md index 58fae8c2ea..79cdd706af 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_displayname.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.DisplayName --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.DisplayName ## -description Gets or sets the display name of an item in the list of custom print task options. ## -property-value The display name of the option item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.DisplayName +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.DisplayName + +## -description +Gets or sets the display name of an item in the list of custom print task options. + +## -property-value +The display name of the option item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_errortext.md index ed49879235..7c16eb620f 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_items.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_items.md index 16a312db75..5b58048230 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Items ## -description Gets an item from the list of custom print tasks. ## -property-value Pointer to the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Items + +## -description +Gets an item from the list of custom print tasks. + +## -property-value +Pointer to the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optionid.md index dd3f9dbe7c..f718dd3891 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionId ## -description Gets the ID of a custom print task option. ## -property-value The option ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionId + +## -description +Gets the ID of a custom print task option. + +## -property-value +The option ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optiontype.md index 513d62f8f1..38ecfd4a4e 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionType ## -description Gets the option type for a custom print task option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.OptionType + +## -description +Gets the option type for a custom print task option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_state.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_state.md index bc13f61880..4c327bbea2 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.State ## -description Gets or sets the state of the list of custom print task option items. ## -property-value The state value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.State + +## -description +Gets or sets the state of the list of custom print task option items. + +## -property-value +The state value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_trysetvalue_1013845356.md index db09420000..37efaaed8f 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.TrySetValue ## -description Sets the value for the item ID or the display name of the custom item. ## -parameters ### -param value Value for the item ID or the display name of the custom item. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks To set the default value for a custom dropdown list of options, set the value explicitly. Otherwise, the adding order will be used. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.TrySetValue + +## -description +Sets the value for the item ID or the display name of the custom item. + +## -parameters +### -param value +Value for the item ID or the display name of the custom item. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks +To set the default value for a custom dropdown list of options, set the value explicitly. Otherwise, the adding order will be used. + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_value.md b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_value.md index 6cd9360963..bc2258688a 100644 --- a/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printcustomitemlistoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Value ## -description Gets or sets the value of the list of custom print tasks. ## -property-value The value of the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails.Value + +## -description +Gets or sets the value of the list of custom print tasks. + +## -property-value +The value of the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_displayname.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_displayname.md index e3cef7470a..f6b70b521f 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_displayname.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.DisplayName --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.DisplayName ## -description Gets or sets the display name of the custom print task option. ## -property-value The display name of the option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.DisplayName +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.DisplayName + +## -description +Gets or sets the display name of the custom print task option. + +## -property-value +The display name of the option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_errortext.md index 8efa7db7da..c2dd20ff6d 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_maxcharacters.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_maxcharacters.md index 32ba66bf33..d735c7bae3 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_maxcharacters.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_maxcharacters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.MaxCharacters --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.MaxCharacters ## -description Gets or sets the maximum number of characters for the display name of the custom print task option. ## -property-value The maximum number of characters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.MaxCharacters +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.MaxCharacters + +## -description +Gets or sets the maximum number of characters for the display name of the custom print task option. + +## -property-value +The maximum number of characters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optionid.md index fb56a475c2..720bbb7ea5 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionId ## -description Gets the ID of the custom print task option. ## -property-value The ID of the custom option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionId + +## -description +Gets the ID of the custom print task option. + +## -property-value +The ID of the custom option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optiontype.md index bff7124760..ac0665a004 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionType ## -description Gets the option type for the custom print task option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.OptionType + +## -description +Gets the option type for the custom print task option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_state.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_state.md index d18fed84f8..17ebde83dc 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.State ## -description Gets or sets the state of a custom print task option. ## -property-value The state of the custom option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.State + +## -description +Gets or sets the state of a custom print task option. + +## -property-value +The state of the custom option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_trysetvalue_1013845356.md index 6ef839f0d4..74d36bf50e 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.TrySetValue ## -description Sets the value for the custom print task. ## -parameters ### -param value Value for the custom print task. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.TrySetValue + +## -description +Sets the value for the custom print task. + +## -parameters +### -param value +Value for the custom print task. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_value.md b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_value.md index 9d5db2e3b1..c718231727 100644 --- a/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printcustomtextoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.Value ## -description Gets or sets the value of a custom print task option. ## -property-value The value of the custom option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails.Value + +## -description +Gets or sets the value of a custom print task option. + +## -property-value +The value of the custom option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_errortext.md index fa5fadd3a2..b5834a026d 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_items.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_items.md index 79b5ecd1b4..43e44ca165 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Items ## -description Gets the list of print duplex options. ## -property-value The list of print duplex options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Items + +## -description +Gets the list of print duplex options. + +## -property-value +The list of print duplex options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_optionid.md index 4c73bd97be..45e206adb8 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionId ## -description Gets the ID of the print duplex option. ## -property-value The ID of the print duplex option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionId + +## -description +Gets the ID of the print duplex option. + +## -property-value +The ID of the print duplex option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_optiontype.md index e881c442da..b6ace6942d 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionType ## -description Gets the option type of the print duplex option. ## -property-value The option type of the print duplex option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.OptionType + +## -description +Gets the option type of the print duplex option. + +## -property-value +The option type of the print duplex option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_state.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_state.md index 4d1fa7d211..fb9ade016e 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.State ## -description Gets or sets the state of the print duplex options. ## -property-value The state of the print duplex option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.State + +## -description +Gets or sets the state of the print duplex options. + +## -property-value +The state of the print duplex option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_trysetvalue_1013845356.md index ce09069792..a724daa2ce 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.TrySetValue ## -description Sets the value for the duplex option. ## -parameters ### -param value Value for the duplex option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.TrySetValue + +## -description +Sets the value for the duplex option. + +## -parameters +### -param value +Value for the duplex option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printduplexoptiondetails_value.md b/windows.graphics.printing.optiondetails/printduplexoptiondetails_value.md index 3383f3fbda..826fc12897 100644 --- a/windows.graphics.printing.optiondetails/printduplexoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printduplexoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Value ## -description Gets or sets the enumerated vlaue of the print duplex option. ## -property-value The enumerated value of the print duplex option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintDuplexOptionDetails.Value + +## -description +Gets or sets the enumerated vlaue of the print duplex option. + +## -property-value +The enumerated value of the print duplex option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_errortext.md index 0ab3a4b17c..0f79588528 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_items.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_items.md index b8ec16f47e..920cc302ef 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Items ## -description Gets the list of items for the hole punch option. ## -property-value A pointer to the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Items + +## -description +Gets the list of items for the hole punch option. + +## -property-value +A pointer to the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optionid.md index 27e84ec798..47077130e9 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionId ## -description Gets the ID for the hole punch option. ## -property-value The ID for the option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionId + +## -description +Gets the ID for the hole punch option. + +## -property-value +The ID for the option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optiontype.md index fc5d6c7d23..75fdb7062e 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionType ## -description Gets the option type for the hole punch option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.OptionType + +## -description +Gets the option type for the hole punch option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_state.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_state.md index cf06cb0122..f5a05c404b 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.State ## -description Gets or sets the state of the hole punch option. ## -property-value The state of the hole punch option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.State + +## -description +Gets or sets the state of the hole punch option. + +## -property-value +The state of the hole punch option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_trysetvalue_1013845356.md index 0a9f3a532a..f879b22bf4 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.TrySetValue ## -description Sets the value for the hole punch option. ## -parameters ### -param value Value for the hole punch option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.TrySetValue + +## -description +Sets the value for the hole punch option. + +## -parameters +### -param value +Value for the hole punch option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_value.md b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_value.md index 8131245727..1ee11a02e4 100644 --- a/windows.graphics.printing.optiondetails/printholepunchoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printholepunchoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Value ## -description Gets or sets the enumerated value of the hole punch option. ## -property-value The enumerated value of the hole punch option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintHolePunchOptionDetails.Value + +## -description +Gets or sets the enumerated value of the hole punch option. + +## -property-value +The enumerated value of the hole punch option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_errortext.md index ea9defdb18..47301a97ea 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_items.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_items.md index a5a7673c9c..d113eea548 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Items ## -description Gets the list of print media size option items. ## -property-value A pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Items + +## -description +Gets the list of print media size option items. + +## -property-value +A pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optionid.md index 30dd144dfd..4fdd02af6a 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionId ## -description Gets the ID for the print media size option. ## -property-value The ID for the media size option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionId + +## -description +Gets the ID for the print media size option. + +## -property-value +The ID for the media size option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optiontype.md index f6fc694840..5bdf0f2d4d 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionType ## -description Gets the option type for the option for the number of printed copies. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.OptionType + +## -description +Gets the option type for the option for the number of printed copies. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_state.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_state.md index 00c8094a63..ebff8f6ed5 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.State ## -description Gets or sets the state of the option for the number of printed copies. ## -property-value The state of the option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.State + +## -description +Gets or sets the state of the option for the number of printed copies. + +## -property-value +The state of the option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_trysetvalue_1013845356.md index 6f74beea95..267c055259 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.TrySetValue ## -description Sets the value for the media size option. ## -parameters ### -param value Value for the media size option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.TrySetValue + +## -description +Sets the value for the media size option. + +## -parameters +### -param value +Value for the media size option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_value.md b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_value.md index 56ec0e10f6..263495c19b 100644 --- a/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printmediasizeoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Value ## -description Gets or sets the number of copies for a print task. ## -property-value The number of copies for a print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaSizeOptionDetails.Value + +## -description +Gets or sets the number of copies for a print task. + +## -property-value +The number of copies for a print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_errortext.md index ca8b4c2ad8..722c036d37 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_items.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_items.md index 502334617c..4858be130f 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Items ## -description Gets the list of items for the print media type options. ## -property-value A pointer to the list of media type options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Items + +## -description +Gets the list of items for the print media type options. + +## -property-value +A pointer to the list of media type options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optionid.md index 831108faa3..4efd081528 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionId ## -description Gets the ID for the print media type option. ## -property-value The ID for the media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionId + +## -description +Gets the ID for the print media type option. + +## -property-value +The ID for the media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optiontype.md index 2081cefc9f..2bf4df64cb 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionType ## -description Gets the option type for the print media type option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.OptionType + +## -description +Gets the option type for the print media type option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_state.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_state.md index e41ccb94a1..0e1909deb2 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.State ## -description Gets or sets the state for the print media type option. ## -property-value The state of the media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.State + +## -description +Gets or sets the state for the print media type option. + +## -property-value +The state of the media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_trysetvalue_1013845356.md index 0f1bc9adb7..6ac629f60b 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.TrySetValue ## -description Sets the value for the media type option. ## -parameters ### -param value Value for the media type option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.TrySetValue + +## -description +Sets the value for the media type option. + +## -parameters +### -param value +Value for the media type option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_value.md b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_value.md index d97438a3fc..e84c2f401b 100644 --- a/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printmediatypeoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Value ## -description Gets or sets the enumerated value of the print media type option. ## -property-value The enumerated value of the media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintMediaTypeOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print media type option. + +## -property-value +The enumerated value of the media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_errortext.md index 95e3e21e5f..ddc740ce4c 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_items.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_items.md index 2ab2812129..7eac64c593 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Items ## -description Gets the list of items for the print media type options. ## -property-value A pointer to the list of media type options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Items + +## -description +Gets the list of items for the print media type options. + +## -property-value +A pointer to the list of media type options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_optionid.md index 9777696ac8..051329c8d0 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionId ## -description Gets the ID for the print orientation option. ## -property-value The ID for the print orientation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionId + +## -description +Gets the ID for the print orientation option. + +## -property-value +The ID for the print orientation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_optiontype.md index f438fcb39e..3dd5810518 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionType ## -description Gets the option type for the print media type option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.OptionType + +## -description +Gets the option type for the print media type option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_state.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_state.md index 02bbe22769..d162e50693 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.State ## -description Gets or sets the state for the print media type option. ## -property-value The state of the media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.State + +## -description +Gets or sets the state for the print media type option. + +## -property-value +The state of the media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_trysetvalue_1013845356.md index f6c41ff920..2ed3b034e4 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.TrySetValue ## -description Sets the value for the print orientation option. ## -parameters ### -param value Value for the print orientation option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.TrySetValue + +## -description +Sets the value for the print orientation option. + +## -parameters +### -param value +Value for the print orientation option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printorientationoptiondetails_value.md b/windows.graphics.printing.optiondetails/printorientationoptiondetails_value.md index 608ddf281a..3f524eac3b 100644 --- a/windows.graphics.printing.optiondetails/printorientationoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printorientationoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Value ## -description Gets or sets the enumerated value of the print media type option. ## -property-value The enumerated value of the media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintOrientationOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print media type option. + +## -property-value +The enumerated value of the media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_errortext.md index 9e84ff1735..4706f877f8 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_items.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_items.md index 3062499d52..c9c09a7d23 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Items ## -description Gets the list of items for the print quality options. ## -property-value A pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Items + +## -description +Gets the list of items for the print quality options. + +## -property-value +A pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_optionid.md index 1e256eb2f7..cca452a423 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionId ## -description Gets the ID for the print quality option. ## -property-value The ID for the print quality option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionId + +## -description +Gets the ID for the print quality option. + +## -property-value +The ID for the print quality option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_optiontype.md index 4f99a3e576..3e176494f6 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionType ## -description Gets the option type for the print quality option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.OptionType + +## -description +Gets the option type for the print quality option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_state.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_state.md index 66d4c55e72..2d864c5908 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.State ## -description Gets or sets the state of the print quality option. ## -property-value The state of the print quality option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.State + +## -description +Gets or sets the state of the print quality option. + +## -property-value +The state of the print quality option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_trysetvalue_1013845356.md index 12cdbffc26..fc94ebf1b5 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.TrySetValue ## -description Sets the value for the print quality option. ## -parameters ### -param value Value for the print quality option. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.TrySetValue + +## -description +Sets the value for the print quality option. + +## -parameters +### -param value +Value for the print quality option. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printqualityoptiondetails_value.md b/windows.graphics.printing.optiondetails/printqualityoptiondetails_value.md index 7dd73bebcd..ffe3b51d7c 100644 --- a/windows.graphics.printing.optiondetails/printqualityoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printqualityoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Value ## -description Gets or sets the enumerated value of the print quality option. ## -property-value The enumerated value of the print quality option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintQualityOptionDetails.Value + +## -description +Gets or sets the enumerated value of the print quality option. + +## -property-value +The enumerated value of the print quality option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_errortext.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_errortext.md index e0c1c3380b..6786173467 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_errortext.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.ErrorText --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.ErrorText ## -description Gets or sets the string for an error condition. ## -property-value String that describes the error condition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.ErrorText +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.ErrorText + +## -description +Gets or sets the string for an error condition. + +## -property-value +String that describes the error condition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_items.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_items.md index e01b1797ee..039f992ee6 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_items.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Items --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Items ## -description Gets the list of items for the stapling options. ## -property-value A pointer to the list of items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Items +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Items + +## -description +Gets the list of items for the stapling options. + +## -property-value +A pointer to the list of items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_optionid.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_optionid.md index f7d1fd9c7e..eb455ec42e 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_optionid.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionId ## -description Gets the ID for the stapling option. ## -property-value The ID for the stapling option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionId + +## -description +Gets the ID for the stapling option. + +## -property-value +The ID for the stapling option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_optiontype.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_optiontype.md index f2484aeb58..33fe717bec 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_optiontype.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_optiontype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionType --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionType ## -description Gets the option type for the stapling option. ## -property-value The option type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.OptionType + +## -description +Gets the option type for the stapling option. + +## -property-value +The option type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_state.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_state.md index 60bf2798b3..0d707bf39f 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_state.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.State --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.State ## -description Gets or sets the state of the stapling option. ## -property-value The state of the stapling option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.State +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.State + +## -description +Gets or sets the state of the stapling option. + +## -property-value +The state of the stapling option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_trysetvalue_1013845356.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_trysetvalue_1013845356.md index ae57369447..23c4abf03a 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_trysetvalue_1013845356.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_trysetvalue_1013845356.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.TrySetValue(System.Object) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.TrySetValue ## -description Sets the value for the staple opiton. ## -parameters ### -param value Value for the staple opiton. ## -returns Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.TrySetValue(System.Object) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.TrySetValue + +## -description +Sets the value for the staple opiton. + +## -parameters +### -param value +Value for the staple opiton. + +## -returns +Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printstapleoptiondetails_value.md b/windows.graphics.printing.optiondetails/printstapleoptiondetails_value.md index 5da3fdf967..2f1f1636a9 100644 --- a/windows.graphics.printing.optiondetails/printstapleoptiondetails_value.md +++ b/windows.graphics.printing.optiondetails/printstapleoptiondetails_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Value --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Value ## -description Gets or sets the enumerated value of the stapling option. ## -property-value The enumerated value of the stapling option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintStapleOptionDetails.Value + +## -description +Gets or sets the enumerated value of the stapling option. + +## -property-value +The enumerated value of the stapling option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptionchangedeventargs_optionid.md b/windows.graphics.printing.optiondetails/printtaskoptionchangedeventargs_optionid.md index 560ad73f97..79d69e60e7 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptionchangedeventargs_optionid.md +++ b/windows.graphics.printing.optiondetails/printtaskoptionchangedeventargs_optionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionChangedEventArgs.OptionId --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionChangedEventArgs.OptionId ## -description Gets the ID of the print task option that changed. ## -property-value The ID of the property that changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionChangedEventArgs.OptionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionChangedEventArgs.OptionId + +## -description +Gets the ID of the print task option that changed. + +## -property-value +The ID of the property that changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_beginvalidation.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_beginvalidation.md index 981c8aeff9..39d96db328 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_beginvalidation.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_beginvalidation.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.BeginValidation --api-type: winrt event ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.BeginValidation ## -description Raised when the print system begins a validation pass on the current state of the print ticket. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.BeginValidation +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.BeginValidation + +## -description +Raised when the print system begins a validation pass on the current state of the print ticket. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_createitemlistoption_1892925232.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_createitemlistoption_1892925232.md index a4bbc4c36f..e1cc14b4a3 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_createitemlistoption_1892925232.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_createitemlistoption_1892925232.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateItemListOption(System.String,System.String) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateItemListOption ## -description Creates a custom list of items that allow the user to choose the page format. ## -parameters ### -param optionId The ID for the custom item. ### -param displayName The display name for the custom item. ## -returns The list of custom items. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateItemListOption(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateItemListOption + +## -description +Creates a custom list of items that allow the user to choose the page format. + +## -parameters +### -param optionId +The ID for the custom item. + +### -param displayName +The display name for the custom item. + +## -returns +The list of custom items. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_createtextoption_561980815.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_createtextoption_561980815.md index 743449ded8..2360ef26e5 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_createtextoption_561980815.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_createtextoption_561980815.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateTextOption(System.String,System.String) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateTextOption ## -description Creates a [CustomPrintTaskOptionText](printcustomtextoptiondetails.md) object to handle the display name and other parameters of the advanced print task option item. ## -parameters ### -param optionId The ID of the print task option. ### -param displayName The display name of the print task option. ## -returns The **CustomPrintTaskOptionText** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateTextOption(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.CreateTextOption + +## -description +Creates a [CustomPrintTaskOptionText](printcustomtextoptiondetails.md) object to handle the display name and other parameters of the advanced print task option item. + +## -parameters +### -param optionId +The ID of the print task option. + +### -param displayName +The display name of the print task option. + +## -returns +The **CustomPrintTaskOptionText** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_displayedoptions.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_displayedoptions.md index 6f9089533a..27815df5be 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_displayedoptions.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_displayedoptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.DisplayedOptions --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.DisplayedOptions ## -description Gets the list of print task options that are currently displayed. ## -property-value A pointer to the list of options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.DisplayedOptions +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.DisplayedOptions + +## -description +Gets the list of print task options that are currently displayed. + +## -property-value +A pointer to the list of options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_getfromprinttaskoptions_55978790.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_getfromprinttaskoptions_55978790.md index c6e27f447f..fa134d84a6 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_getfromprinttaskoptions_55978790.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_getfromprinttaskoptions_55978790.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetFromPrintTaskOptions(Windows.Graphics.Printing.PrintTaskOptions) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetFromPrintTaskOptions ## -description Used to retrieve the available options for a print task. ## -parameters ### -param printTaskOptions Pointer to a **PrintTaskOptions** object. ## -returns Pointer to a **PrintTaskOptionDetails** object. ## -remarks ## -examples ## -see-also [PrintTaskOptions](../windows.graphics.printing/printtaskoptions.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetFromPrintTaskOptions(Windows.Graphics.Printing.PrintTaskOptions) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetFromPrintTaskOptions + +## -description +Used to retrieve the available options for a print task. + +## -parameters +### -param printTaskOptions +Pointer to a **PrintTaskOptions** object. + +## -returns +Pointer to a **PrintTaskOptionDetails** object. + +## -remarks + +## -examples + +## -see-also +[PrintTaskOptions](../windows.graphics.printing/printtaskoptions.md) \ No newline at end of file diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_getpagedescription_1541239181.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_getpagedescription_1541239181.md index 46eca1e212..69dd2e0af6 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_getpagedescription_1541239181.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_getpagedescription_1541239181.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetPageDescription(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetPageDescription ## -description Returns a **PrintPageDescription** object for the referenced page number. ## -parameters ### -param jobPageNumber The page number. ## -returns The **PrintPageDescription** object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetPageDescription(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.GetPageDescription + +## -description +Returns a **PrintPageDescription** object for the referenced page number. + +## -parameters +### -param jobPageNumber +The page number. + +## -returns +The **PrintPageDescription** object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_optionchanged.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_optionchanged.md index fdc5782ba3..827fe3e2e8 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_optionchanged.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_optionchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.OptionChanged --api-type: winrt event ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.OptionChanged ## -description Raised when any one of the advanced print task options is changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.OptionChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.OptionChanged + +## -description +Raised when any one of the advanced print task options is changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing.optiondetails/printtaskoptiondetails_options.md b/windows.graphics.printing.optiondetails/printtaskoptiondetails_options.md index ebdec6e2c1..937bed8cac 100644 --- a/windows.graphics.printing.optiondetails/printtaskoptiondetails_options.md +++ b/windows.graphics.printing.optiondetails/printtaskoptiondetails_options.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.Options --api-type: winrt property ---- # Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.Options ## -description Gets the list of options for the advanced print task. ## -property-value The list of options for the advanced print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.Options +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.Options + +## -description +Gets the list of options for the advanced print task. + +## -property-value +The list of options for the advanced print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscore_getpagedescription.md b/windows.graphics.printing/iprinttaskoptionscore_getpagedescription.md index 9ed59f87b7..7b565feb8d 100644 --- a/windows.graphics.printing/iprinttaskoptionscore_getpagedescription.md +++ b/windows.graphics.printing/iprinttaskoptionscore_getpagedescription.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.IPrintTaskOptionsCore.GetPageDescription(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing.IPrintTaskOptionsCore.GetPageDescription ## -description Gets the page description for a print job. ## -parameters ### -param jobPageNumber The job page number. ## -returns The page description data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.IPrintTaskOptionsCore.GetPageDescription(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCore.GetPageDescription + +## -description +Gets the page description for a print job. + +## -parameters +### -param jobPageNumber +The job page number. + +## -returns +The page description data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_binding.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_binding.md index 14de40c7f5..758f3b11f5 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_binding.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_binding.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Binding --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Binding ## -description Gets or sets the binding option for a print task. ## -property-value The binding option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Binding +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Binding + +## -description +Gets or sets the binding option for a print task. + +## -property-value +The binding option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_collation.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_collation.md index 724e4d0fa3..e6f0690cf6 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_collation.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_collation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Collation --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Collation ## -description Gets or sets the collation option for a print task. ## -property-value The collation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Collation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Collation + +## -description +Gets or sets the collation option for a print task. + +## -property-value +The collation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_colormode.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_colormode.md index 8daf44be73..3145f1adea 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_colormode.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_colormode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.ColorMode --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.ColorMode ## -description Gets or sets the color mode option for the print task. ## -property-value The color mode option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.ColorMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.ColorMode + +## -description +Gets or sets the color mode option for the print task. + +## -property-value +The color mode option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_duplex.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_duplex.md index a9117f99c5..a3ab2d1893 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_duplex.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_duplex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Duplex --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Duplex ## -description Gets or sets the duplex option for a print task. ## -property-value The duplex option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Duplex +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Duplex + +## -description +Gets or sets the duplex option for a print task. + +## -property-value +The duplex option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_holepunch.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_holepunch.md index 7f456b3872..6ad1104cdb 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_holepunch.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_holepunch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.HolePunch --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.HolePunch ## -description Gets or sets the hole punch option for the print task. ## -property-value The hole punch option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.HolePunch +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.HolePunch + +## -description +Gets or sets the hole punch option for the print task. + +## -property-value +The hole punch option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_maxcopies.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_maxcopies.md index c86feeec82..7a80bc186f 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_maxcopies.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_maxcopies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MaxCopies --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MaxCopies ## -description Gets the **MaxCopies** option for the print task. ## -property-value The MaxCopies option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MaxCopies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MaxCopies + +## -description +Gets the **MaxCopies** option for the print task. + +## -property-value +The MaxCopies option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_mediasize.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_mediasize.md index 90343e26e3..f340fd33aa 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_mediasize.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_mediasize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaSize --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaSize ## -description Gets or sets the media size option of the print task. ## -property-value The media size option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaSize + +## -description +Gets or sets the media size option of the print task. + +## -property-value +The media size option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_mediatype.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_mediatype.md index 4e2f1181ad..63ea41ca83 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_mediatype.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_mediatype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaType --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaType ## -description Gets or sets the media type option for the print task. ## -property-value The media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MediaType + +## -description +Gets or sets the media type option for the print task. + +## -property-value +The media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_mincopies.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_mincopies.md index c8bc56522d..d40c2386de 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_mincopies.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_mincopies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MinCopies --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MinCopies ## -description Gets the **MinCopies** option for the print task. ## -property-value The MinCopies option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MinCopies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.MinCopies + +## -description +Gets the **MinCopies** option for the print task. + +## -property-value +The MinCopies option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_numberofcopies.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_numberofcopies.md index 70738894e7..057871f296 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_numberofcopies.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_numberofcopies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.NumberOfCopies --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.NumberOfCopies ## -description Gets or sets the **NumberOfCopies** option for a print task. ## -property-value The NumberOfCopies option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.NumberOfCopies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.NumberOfCopies + +## -description +Gets or sets the **NumberOfCopies** option for a print task. + +## -property-value +The NumberOfCopies option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_orientation.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_orientation.md index 230ab52536..ccbcd07850 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_orientation.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Orientation --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Orientation ## -description Gets or sets the orientation option for a print task. ## -property-value The orientation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Orientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Orientation + +## -description +Gets or sets the orientation option for a print task. + +## -property-value +The orientation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_printquality.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_printquality.md index de603e97da..d2f984529d 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_printquality.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_printquality.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.PrintQuality --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.PrintQuality ## -description Gets or sets the print quality option for a print task. ## -property-value The print quality option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.PrintQuality +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.PrintQuality + +## -description +Gets or sets the print quality option for a print task. + +## -property-value +The print quality option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreproperties_staple.md b/windows.graphics.printing/iprinttaskoptionscoreproperties_staple.md index e560422b3b..fb065f5bfe 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreproperties_staple.md +++ b/windows.graphics.printing/iprinttaskoptionscoreproperties_staple.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Staple --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Staple ## -description Gets or sets the staple option for a print task. ## -property-value The staple option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Staple +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties.Staple + +## -description +Gets or sets the staple option for a print task. + +## -property-value +The staple option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/iprinttaskoptionscoreuiconfiguration_displayedoptions.md b/windows.graphics.printing/iprinttaskoptionscoreuiconfiguration_displayedoptions.md index 673843bd02..6754ccf357 100644 --- a/windows.graphics.printing/iprinttaskoptionscoreuiconfiguration_displayedoptions.md +++ b/windows.graphics.printing/iprinttaskoptionscoreuiconfiguration_displayedoptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreUIConfiguration.DisplayedOptions --api-type: winrt property ---- # Windows.Graphics.Printing.IPrintTaskOptionsCoreUIConfiguration.DisplayedOptions ## -description Gets the **DisplayedOptions** option for a print task. ## -property-value The DisplayedOptions option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.IPrintTaskOptionsCoreUIConfiguration.DisplayedOptions +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.IPrintTaskOptionsCoreUIConfiguration.DisplayedOptions + +## -description +Gets the **DisplayedOptions** option for a print task. + +## -property-value +The DisplayedOptions option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printmanager_getforcurrentview_1363600702.md b/windows.graphics.printing/printmanager_getforcurrentview_1363600702.md index 396f87274c..9314e76dc1 100644 --- a/windows.graphics.printing/printmanager_getforcurrentview_1363600702.md +++ b/windows.graphics.printing/printmanager_getforcurrentview_1363600702.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintManager.GetForCurrentView --api-type: winrt method ---- # Windows.Graphics.Printing.PrintManager.GetForCurrentView ## -description Retrieves the **PrintManager** object associated with the current window. ## -returns The **PrintManager** object. ## -remarks ## -examples ## -see-also [Authoring a for Printers](http://msdn.microsoft.com/library/windows/hardware/br259129), [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintManager.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintManager.GetForCurrentView + +## -description +Retrieves the **PrintManager** object associated with the current window. + +## -returns +The **PrintManager** object. + +## -remarks + +## -examples + +## -see-also +[Authoring a for Printers](http://msdn.microsoft.com/library/windows/hardware/br259129), [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx) \ No newline at end of file diff --git a/windows.graphics.printing/printmanager_issupported_930300905.md b/windows.graphics.printing/printmanager_issupported_930300905.md index 78868b5bc2..8e4f13e8b2 100644 --- a/windows.graphics.printing/printmanager_issupported_930300905.md +++ b/windows.graphics.printing/printmanager_issupported_930300905.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintManager.IsSupported --api-type: winrt method ---- # Windows.Graphics.Printing.PrintManager.IsSupported ## -description Indicates whether or not the app is running on a device that supports printing. ## -returns Returns **true** if on a device that supports printing, returns **false** if not. ## -remarks A Universal Windows app should use this method to determine whether to show or hide certain UI elements related to the printing task. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintManager.IsSupported +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintManager.IsSupported + +## -description +Indicates whether or not the app is running on a device that supports printing. + +## -returns +Returns **true** if on a device that supports printing, returns **false** if not. + +## -remarks +A Universal Windows app should use this method to determine whether to show or hide certain UI elements related to the printing task. + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printmanager_printtaskrequested.md b/windows.graphics.printing/printmanager_printtaskrequested.md index 410a1a37eb..5c5c82ad0d 100644 --- a/windows.graphics.printing/printmanager_printtaskrequested.md +++ b/windows.graphics.printing/printmanager_printtaskrequested.md @@ -1,3 +1,37 @@ ---- -api-id: E:Windows.Graphics.Printing.PrintManager.PrintTaskRequested --api-type: winrt event ---- # Windows.Graphics.Printing.PrintManager.PrintTaskRequested ## -description Raised when a request to print has occurred. This event may be triggered by user action or via programmatic invocation of printing via the [ShowPrintUIAsync](printmanager_showprintuiasync.md) method. ## -remarks When you add print capabilities to your Windows Store app, you have to implement an event handler to process this event when it is raised. Here is a JavaScript code snippet that shows how to handle this event: ```javascript // Print event handler for printing via the PrintManager API. // printEvent contains the print task request object function onPrintTaskRequested(printEvent) { var printTask = printEvent.request.createPrintTask("Print Sample", function (args) { args.setSource(MSApp.getHtmlPrintDocumentSource(document)); }); ``` To see the complete listing for this and other printing scenarios using **PrintTaskRequested**, see [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx). ## -examples ## -see-also [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx) \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.PrintManager.PrintTaskRequested +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.PrintManager.PrintTaskRequested + +## -description +Raised when a request to print has occurred. This event may be triggered by user action or via programmatic invocation of printing via the [ShowPrintUIAsync](printmanager_showprintuiasync.md) method. + +## -remarks +When you add print capabilities to your Windows Store app, you have to implement an event handler to process this event when it is raised. Here is a JavaScript code snippet that shows how to handle this event: + + + + + +```javascript +// Print event handler for printing via the PrintManager API. +// printEvent contains the print task request object + function onPrintTaskRequested(printEvent) { + var printTask = printEvent.request.createPrintTask("Print Sample", function (args) { + args.setSource(MSApp.getHtmlPrintDocumentSource(document)); + }); + +``` + +To see the complete listing for this and other printing scenarios using **PrintTaskRequested**, see [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx). + +## -examples + +## -see-also +[Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx) \ No newline at end of file diff --git a/windows.graphics.printing/printmanager_showprintuiasync_1397448831.md b/windows.graphics.printing/printmanager_showprintuiasync_1397448831.md index 57760f1078..fd569b52d9 100644 --- a/windows.graphics.printing/printmanager_showprintuiasync_1397448831.md +++ b/windows.graphics.printing/printmanager_showprintuiasync_1397448831.md @@ -1,3 +1,52 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintManager.ShowPrintUIAsync --api-type: winrt method ---- # Windows.Graphics.Printing.PrintManager.ShowPrintUIAsync ## -description Programmatically initiates the user interface for printing content. ## -returns A Boolean value to indicate a TRUE for success or a FALSE for a failure. ## -remarks This method may be used by an application which has already used **GetForCurrentView** to retrieve the **PrintManager** instance and has registered a listener for the **PrintTaskRequested** event to initiate the printing user experience. In general, applications are encouraged to let users print content via the Devices charm. For this reason, using the [ShowPrintUIAsync](printmanager_showprintuiasync.md) method is discouraged. **ShowPrintUIAsync** is provided mainly for scenarios in which the app is to provide guidance for users to help users complete a printing-related process. For example, guidance at the end of a ticket purchasing process, or after checking in for a flight, and then printing a boarding pass. [ShowPrintUIAsync](printmanager_showprintuiasync.md) displays the appropriate printing window. If printing can't be performed at that time, the method will throw an exception. We recommend catching these exceptions and letting the user know when printing can't proceed, as shown here. ```csharp async private void printButton_Click(object sender, RoutedEventArgs e) { try { // Show print UI await Windows.Graphics.Printing.PrintManager.ShowPrintUIAsync(); } catch { // Printing cannot proceed at this time ContentDialog noPrintingDialog = new ContentDialog() { Title = "Printing error", Content = "\nSorry, printing can't proceed at this time.", PrimaryButtonText = "OK" }; await noPrintingDialog.ShowAsync(); } } ``` In this example, a print window is displayed in the event handler for a button click. If the method throws an exception (because printing can't be performed at that time), a [ContentDialog](../windows.ui.xaml.controls/contentdialog.md) control informs the user of the situation. For more info about printing from your app, see [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx). ## -examples ## -see-also [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintManager.ShowPrintUIAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintManager.ShowPrintUIAsync + +## -description +Programmatically initiates the user interface for printing content. + +## -returns +A Boolean value to indicate a TRUE for success or a FALSE for a failure. + +## -remarks +This method may be used by an application which has already used **GetForCurrentView** to retrieve the **PrintManager** instance and has registered a listener for the **PrintTaskRequested** event to initiate the printing user experience. In general, applications are encouraged to let users print content via the Devices charm. For this reason, using the [ShowPrintUIAsync](printmanager_showprintuiasync.md) method is discouraged. **ShowPrintUIAsync** is provided mainly for scenarios in which the app is to provide guidance for users to help users complete a printing-related process. For example, guidance at the end of a ticket purchasing process, or after checking in for a flight, and then printing a boarding pass. + +[ShowPrintUIAsync](printmanager_showprintuiasync.md) displays the appropriate printing window. If printing can't be performed at that time, the method will throw an exception. We recommend catching these exceptions and letting the user know when printing can't proceed, as shown here. + + + +```csharp +async private void printButton_Click(object sender, RoutedEventArgs e) +{ + try + { + // Show print UI + await Windows.Graphics.Printing.PrintManager.ShowPrintUIAsync(); + + } + catch + { + // Printing cannot proceed at this time + ContentDialog noPrintingDialog = new ContentDialog() + { + Title = "Printing error", + Content = "\nSorry, printing can't proceed at this time.", PrimaryButtonText = "OK" + }; + await noPrintingDialog.ShowAsync(); + } +} +``` + +In this example, a print window is displayed in the event handler for a button click. If the method throws an exception (because printing can't be performed at that time), a [ContentDialog](../windows.ui.xaml.controls/contentdialog.md) control informs the user of the situation. For more info about printing from your app, see [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx). + +## -examples + +## -see-also +[Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx) \ No newline at end of file diff --git a/windows.graphics.printing/printpageinfo.md b/windows.graphics.printing/printpageinfo.md index e13a0f07b5..9044e26a09 100644 --- a/windows.graphics.printing/printpageinfo.md +++ b/windows.graphics.printing/printpageinfo.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Graphics.Printing.PrintPageInfo --api-type: winrt class ---- # Windows.Graphics.Printing.PrintPageInfo ## -description Stores formatting data for a single section of printable pages. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing.PrintPageInfo +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing.PrintPageInfo + +## -description +Stores formatting data for a single section of printable pages. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printpageinfo_dpix.md b/windows.graphics.printing/printpageinfo_dpix.md index fa3e19e826..e370ebe8df 100644 --- a/windows.graphics.printing/printpageinfo_dpix.md +++ b/windows.graphics.printing/printpageinfo_dpix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintPageInfo.DpiX --api-type: winrt property ---- # Windows.Graphics.Printing.PrintPageInfo.DpiX ## -description Gets the print resolution on the horizontal axis for the given print section. ## -property-value Print resolution in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintPageInfo.DpiX +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintPageInfo.DpiX + +## -description +Gets the print resolution on the horizontal axis for the given print section. + +## -property-value +Print resolution in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printpageinfo_dpiy.md b/windows.graphics.printing/printpageinfo_dpiy.md index 221910210e..d19b783f29 100644 --- a/windows.graphics.printing/printpageinfo_dpiy.md +++ b/windows.graphics.printing/printpageinfo_dpiy.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintPageInfo.DpiY --api-type: winrt property ---- # Windows.Graphics.Printing.PrintPageInfo.DpiY ## -description Gets the print resolution on the vertical axis for the given print section. ## -property-value Print resolution in dots per inch. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintPageInfo.DpiY +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintPageInfo.DpiY + +## -description +Gets the print resolution on the vertical axis for the given print section. + +## -property-value +Print resolution in dots per inch. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printpageinfo_mediasize.md b/windows.graphics.printing/printpageinfo_mediasize.md index c2f964392d..ba4d7b5d23 100644 --- a/windows.graphics.printing/printpageinfo_mediasize.md +++ b/windows.graphics.printing/printpageinfo_mediasize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintPageInfo.MediaSize --api-type: winrt property ---- # Windows.Graphics.Printing.PrintPageInfo.MediaSize ## -description Gets or sets the media size option of the given print section. ## -property-value The media size option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintPageInfo.MediaSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintPageInfo.MediaSize + +## -description +Gets or sets the media size option of the given print section. + +## -property-value +The media size option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printpageinfo_orientation.md b/windows.graphics.printing/printpageinfo_orientation.md index 7d6afac53a..f840de8a12 100644 --- a/windows.graphics.printing/printpageinfo_orientation.md +++ b/windows.graphics.printing/printpageinfo_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintPageInfo.Orientation --api-type: winrt property ---- # Windows.Graphics.Printing.PrintPageInfo.Orientation ## -description Gets or sets the orientation option for the given print section. ## -property-value The orientation for the section. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintPageInfo.Orientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintPageInfo.Orientation + +## -description +Gets or sets the orientation option for the given print section. + +## -property-value +The orientation for the section. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printpageinfo_pagesize.md b/windows.graphics.printing/printpageinfo_pagesize.md index 9215250530..27216d8f4f 100644 --- a/windows.graphics.printing/printpageinfo_pagesize.md +++ b/windows.graphics.printing/printpageinfo_pagesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintPageInfo.PageSize --api-type: winrt property ---- # Windows.Graphics.Printing.PrintPageInfo.PageSize ## -description Gets or sets the intended paper size on which to print the given section. ## -property-value The page size of the print section. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintPageInfo.PageSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintPageInfo.PageSize + +## -description +Gets or sets the intended paper size on which to print the given section. + +## -property-value +The page size of the print section. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printpageinfo_printpageinfo_1221375020.md b/windows.graphics.printing/printpageinfo_printpageinfo_1221375020.md index 0bd29c0ff1..01cd4f3233 100644 --- a/windows.graphics.printing/printpageinfo_printpageinfo_1221375020.md +++ b/windows.graphics.printing/printpageinfo_printpageinfo_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintPageInfo.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing.PrintPageInfo.PrintPageInfo ## -description Initializes an instance of the [PrintPageInfo](printpageinfo.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintPageInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintPageInfo.PrintPageInfo + +## -description +Initializes an instance of the [PrintPageInfo](printpageinfo.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_completed.md b/windows.graphics.printing/printtask_completed.md index 0930ccc7da..7c8d2e6ac1 100644 --- a/windows.graphics.printing/printtask_completed.md +++ b/windows.graphics.printing/printtask_completed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing.PrintTask.Completed --api-type: winrt event ---- # Windows.Graphics.Printing.PrintTask.Completed ## -description Raised when the print task is completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.PrintTask.Completed +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.PrintTask.Completed + +## -description +Raised when the print task is completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_is3dmanufacturingtargetenabled.md b/windows.graphics.printing/printtask_is3dmanufacturingtargetenabled.md index c4f48efe8e..438ed43a66 100644 --- a/windows.graphics.printing/printtask_is3dmanufacturingtargetenabled.md +++ b/windows.graphics.printing/printtask_is3dmanufacturingtargetenabled.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTask.Is3DManufacturingTargetEnabled --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTask.Is3DManufacturingTargetEnabled ## -description Gets or sets a value that indicates whether the [PrintTask](printtask.md) supports 3D manufacturing devices, like a 3D printer. ## -property-value True, if 3D manufacturing devices are supported. ## -remarks This property works together with [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) to determine which devices are enumerated when the user extends the print charm. When [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true**, the print charm displays conventional printing devices, like 2D printers. When [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **true**, the print charm displays 3D devices like 3D printers. When both [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) are **true**, the print charm displays both 2D printers and 3D printers. By default, [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true** and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **false**. > [!NOTE] > Windows Store app that support 3D printing in Windows 8.1 must set [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) to **false** and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) to **true** in order to enumerate only 3D printers in the print charm. ## -examples ## -see-also [3D printing](http://go.microsoft.com/fwlink/p/?LinkID=304231) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTask.Is3DManufacturingTargetEnabled +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTask.Is3DManufacturingTargetEnabled + +## -description +Gets or sets a value that indicates whether the [PrintTask](printtask.md) supports 3D manufacturing devices, like a 3D printer. + +## -property-value +True, if 3D manufacturing devices are supported. + +## -remarks +This property works together with [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) to determine which devices are enumerated when the user extends the print charm. When [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true**, the print charm displays conventional printing devices, like 2D printers. When [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **true**, the print charm displays 3D devices like 3D printers. When both [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) are **true**, the print charm displays both 2D printers and 3D printers. + +By default, [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true** and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **false**. + + + +> [!NOTE] +> Windows Store app that support 3D printing in Windows 8.1 must set [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) to **false** and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) to **true** in order to enumerate only 3D printers in the print charm. + +## -examples + +## -see-also +[3D printing](http://go.microsoft.com/fwlink/p/?LinkID=304231) \ No newline at end of file diff --git a/windows.graphics.printing/printtask_ispreviewenabled.md b/windows.graphics.printing/printtask_ispreviewenabled.md index e6e30bc66e..babddb3604 100644 --- a/windows.graphics.printing/printtask_ispreviewenabled.md +++ b/windows.graphics.printing/printtask_ispreviewenabled.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTask.IsPreviewEnabled --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTask.IsPreviewEnabled ## -description Gets or sets a value that indicates whether the [PrintTask](printtask.md) will show a print preview. ## -property-value True, if print preview is enabled. ## -remarks In some situations, displaying the print preview will take too much time and disrupt the user experience of a Universal Windows app. For this reason, the developer may wish to disable the print preview feature in favor of a smoother control flow. By default, **isPreviewEnabled** is **true**. Windows Store app that are meant to print in the background must set **isPreviewEnabled** to **false**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTask.IsPreviewEnabled +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTask.IsPreviewEnabled + +## -description +Gets or sets a value that indicates whether the [PrintTask](printtask.md) will show a print preview. + +## -property-value +True, if print preview is enabled. + +## -remarks +In some situations, displaying the print preview will take too much time and disrupt the user experience of a Universal Windows app. For this reason, the developer may wish to disable the print preview feature in favor of a smoother control flow. + +By default, **isPreviewEnabled** is **true**. Windows Store app that are meant to print in the background must set **isPreviewEnabled** to **false**. + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_isprintertargetenabled.md b/windows.graphics.printing/printtask_isprintertargetenabled.md index c4a6f388cb..0ef49df1a1 100644 --- a/windows.graphics.printing/printtask_isprintertargetenabled.md +++ b/windows.graphics.printing/printtask_isprintertargetenabled.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTask.IsPrinterTargetEnabled --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTask.IsPrinterTargetEnabled ## -description Gets or sets a value indicating whether the [PrintTask](printtask.md) supports printer targets. ## -property-value True if the [PrintTask](printtask.md) supports printer targets. ## -remarks This property works together with [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) to determine which devices are enumerated when the user extends the print charm. When [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true**, the print charm displays conventional printing devices, like 2D printers. When [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **true**, the print charm displays 3D devices like 3D printers. When both [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) are **true**, the print charm displays both 2D printers and 3D printers. By default, [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true** and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **false**. Windows Store app that support 2D printing in Windows 8 are not required to make a change in Windows 8.1 to add this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTask.IsPrinterTargetEnabled +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTask.IsPrinterTargetEnabled + +## -description +Gets or sets a value indicating whether the [PrintTask](printtask.md) supports printer targets. + +## -property-value +True if the [PrintTask](printtask.md) supports printer targets. + +## -remarks +This property works together with [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) to determine which devices are enumerated when the user extends the print charm. When [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true**, the print charm displays conventional printing devices, like 2D printers. When [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **true**, the print charm displays 3D devices like 3D printers. When both [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) are **true**, the print charm displays both 2D printers and 3D printers. + +By default, [IsPrinterTargetEnabled](printtask_isprintertargetenabled.md) is **true** and [Is3DManufacturingTargetEnabled](printtask_is3dmanufacturingtargetenabled.md) is **false**. + +Windows Store app that support 2D printing in Windows 8 are not required to make a change in Windows 8.1 to add this property. + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_options.md b/windows.graphics.printing/printtask_options.md index f4c9f4a5a8..5da80813a4 100644 --- a/windows.graphics.printing/printtask_options.md +++ b/windows.graphics.printing/printtask_options.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTask.Options --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTask.Options ## -description Retrieves the [PrintTaskOptions](printtaskoptions.md) for the print task that defines how the content is to be formatted for printing. ## -property-value The list of print task options. ## -remarks An app can use [PrintTaskOptions](printtaskoptions.md), for example, to determine the size of media on which the content is to be printed. **PrintTaskOptions** may also be used to customize the selection of options that are visible by default for the printing user experience. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTask.Options +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTask.Options + +## -description +Retrieves the [PrintTaskOptions](printtaskoptions.md) for the print task that defines how the content is to be formatted for printing. + +## -property-value +The list of print task options. + +## -remarks +An app can use [PrintTaskOptions](printtaskoptions.md), for example, to determine the size of media on which the content is to be printed. **PrintTaskOptions** may also be used to customize the selection of options that are visible by default for the printing user experience. + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_previewing.md b/windows.graphics.printing/printtask_previewing.md index f88d10cc0e..68a89d1cae 100644 --- a/windows.graphics.printing/printtask_previewing.md +++ b/windows.graphics.printing/printtask_previewing.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing.PrintTask.Previewing --api-type: winrt event ---- # Windows.Graphics.Printing.PrintTask.Previewing ## -description Raised when the print system initializes print preview mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.PrintTask.Previewing +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.PrintTask.Previewing + +## -description +Raised when the print system initializes print preview mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_progressing.md b/windows.graphics.printing/printtask_progressing.md index 4d74a80ed9..8d98ec3b37 100644 --- a/windows.graphics.printing/printtask_progressing.md +++ b/windows.graphics.printing/printtask_progressing.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing.PrintTask.Progressing --api-type: winrt event ---- # Windows.Graphics.Printing.PrintTask.Progressing ## -description Raised to provide progress information about how much of the printed content has been submitted to the print subsystem for printing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.PrintTask.Progressing +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.PrintTask.Progressing + +## -description +Raised to provide progress information about how much of the printed content has been submitted to the print subsystem for printing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_properties.md b/windows.graphics.printing/printtask_properties.md index e27c1c7917..9353b9f997 100644 --- a/windows.graphics.printing/printtask_properties.md +++ b/windows.graphics.printing/printtask_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTask.Properties --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTask.Properties ## -description Retrieves a set of properties associated with the [PrintTask](printtask.md). ## -property-value The data package property set. ## -remarks As an example, the title of the print task that was provided when the print task was created is available as a property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTask.Properties +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTask.Properties + +## -description +Retrieves a set of properties associated with the [PrintTask](printtask.md). + +## -property-value +The data package property set. + +## -remarks +As an example, the title of the print task that was provided when the print task was created is available as a property. + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_source.md b/windows.graphics.printing/printtask_source.md index c112ce52fc..5d896e3911 100644 --- a/windows.graphics.printing/printtask_source.md +++ b/windows.graphics.printing/printtask_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTask.Source --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTask.Source ## -description Returns a pointer to the app-provided object that represents the content to be printed. This object must support the [IPrintDocumentSource](iprintdocumentsource.md) interface. ## -property-value The print task object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTask.Source +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTask.Source + +## -description +Returns a pointer to the app-provided object that represents the content to be printed. This object must support the [IPrintDocumentSource](iprintdocumentsource.md) interface. + +## -property-value +The print task object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtask_submitting.md b/windows.graphics.printing/printtask_submitting.md index be4791fd80..93fe91c677 100644 --- a/windows.graphics.printing/printtask_submitting.md +++ b/windows.graphics.printing/printtask_submitting.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing.PrintTask.Submitting --api-type: winrt event ---- # Windows.Graphics.Printing.PrintTask.Submitting ## -description Raised when a print task begins submitting content to the print subsystem to be printed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing.PrintTask.Submitting +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing.PrintTask.Submitting + +## -description +Raised when a print task begins submitting content to the print subsystem to be printed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskcompletedeventargs_completion.md b/windows.graphics.printing/printtaskcompletedeventargs_completion.md index 9c0a401187..2735157814 100644 --- a/windows.graphics.printing/printtaskcompletedeventargs_completion.md +++ b/windows.graphics.printing/printtaskcompletedeventargs_completion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskCompletedEventArgs.Completion --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskCompletedEventArgs.Completion ## -description Gets the completion status of the print task. ## -property-value The completion status of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskCompletedEventArgs.Completion +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskCompletedEventArgs.Completion + +## -description +Gets the completion status of the print task. + +## -property-value +The completion status of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_binding.md b/windows.graphics.printing/printtaskoptions_binding.md index 89d69c865b..bec85926e1 100644 --- a/windows.graphics.printing/printtaskoptions_binding.md +++ b/windows.graphics.printing/printtaskoptions_binding.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Binding --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.Binding ## -description Gets or sets the binding option for the print task. ## -property-value The binding option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Binding +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.Binding + +## -description +Gets or sets the binding option for the print task. + +## -property-value +The binding option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_bordering.md b/windows.graphics.printing/printtaskoptions_bordering.md index 51c666df7e..53fffaff5b 100644 --- a/windows.graphics.printing/printtaskoptions_bordering.md +++ b/windows.graphics.printing/printtaskoptions_bordering.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Bordering --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.Bordering ## -description Gets or sets the bordering option for the print task. ## -property-value The bordering option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Bordering +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.Bordering + +## -description +Gets or sets the bordering option for the print task. + +## -property-value +The bordering option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_collation.md b/windows.graphics.printing/printtaskoptions_collation.md index e86cd73dbe..7eb6d41e74 100644 --- a/windows.graphics.printing/printtaskoptions_collation.md +++ b/windows.graphics.printing/printtaskoptions_collation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Collation --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.Collation ## -description Gets or sets the collation option of the print tasks. ## -property-value The collation option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Collation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.Collation + +## -description +Gets or sets the collation option of the print tasks. + +## -property-value +The collation option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_colormode.md b/windows.graphics.printing/printtaskoptions_colormode.md index 95e536bfd2..a98a35f837 100644 --- a/windows.graphics.printing/printtaskoptions_colormode.md +++ b/windows.graphics.printing/printtaskoptions_colormode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.ColorMode --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.ColorMode ## -description Gets or sets the color mode option of the print task. ## -property-value The color mode option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.ColorMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.ColorMode + +## -description +Gets or sets the color mode option of the print task. + +## -property-value +The color mode option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_displayedoptions.md b/windows.graphics.printing/printtaskoptions_displayedoptions.md index 783b43a64c..3e1dc8f056 100644 --- a/windows.graphics.printing/printtaskoptions_displayedoptions.md +++ b/windows.graphics.printing/printtaskoptions_displayedoptions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.DisplayedOptions --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.DisplayedOptions ## -description Gets the list of options displayed for the print experience. ## -property-value The list of displayed options. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.DisplayedOptions +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.DisplayedOptions + +## -description +Gets the list of options displayed for the print experience. + +## -property-value +The list of displayed options. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_duplex.md b/windows.graphics.printing/printtaskoptions_duplex.md index dd8723ac61..36db9a4058 100644 --- a/windows.graphics.printing/printtaskoptions_duplex.md +++ b/windows.graphics.printing/printtaskoptions_duplex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Duplex --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.Duplex ## -description Gets or sets the duplex option of the print task. ## -property-value The duplex option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Duplex +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.Duplex + +## -description +Gets or sets the duplex option of the print task. + +## -property-value +The duplex option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_getpagedescription_1541239181.md b/windows.graphics.printing/printtaskoptions_getpagedescription_1541239181.md index 6e74fd62c1..3946d4ceb0 100644 --- a/windows.graphics.printing/printtaskoptions_getpagedescription_1541239181.md +++ b/windows.graphics.printing/printtaskoptions_getpagedescription_1541239181.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskOptions.GetPageDescription(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskOptions.GetPageDescription ## -description Retrieves the physical dimensions of the printed page. ## -parameters ### -param jobPageNumber The page number. ## -returns The page description data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskOptions.GetPageDescription(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.GetPageDescription + +## -description +Retrieves the physical dimensions of the printed page. + +## -parameters +### -param jobPageNumber +The page number. + +## -returns +The page description data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_getpageprintticket_2045377986.md b/windows.graphics.printing/printtaskoptions_getpageprintticket_2045377986.md index 73441dfa25..8313efefb1 100644 --- a/windows.graphics.printing/printtaskoptions_getpageprintticket_2045377986.md +++ b/windows.graphics.printing/printtaskoptions_getpageprintticket_2045377986.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskOptions.GetPagePrintTicket(Windows.Graphics.Printing.PrintPageInfo) --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskOptions.GetPagePrintTicket ## -description Retrieves the physical dimensions and formatting data of a printed page. ## -parameters ### -param printPageInfo The formatting data for a given print section. ## -returns The print ticket data for the given page(s), to be sent down the print pipeline. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskOptions.GetPagePrintTicket(Windows.Graphics.Printing.PrintPageInfo) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.GetPagePrintTicket + +## -description +Retrieves the physical dimensions and formatting data of a printed page. + +## -parameters +### -param printPageInfo +The formatting data for a given print section. + +## -returns +The print ticket data for the given page(s), to be sent down the print pipeline. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_holepunch.md b/windows.graphics.printing/printtaskoptions_holepunch.md index 40b35bfc2e..cfa2904597 100644 --- a/windows.graphics.printing/printtaskoptions_holepunch.md +++ b/windows.graphics.printing/printtaskoptions_holepunch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.HolePunch --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.HolePunch ## -description Gets or sets the hole punch option of the print task. ## -property-value The hole punch option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.HolePunch +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.HolePunch + +## -description +Gets or sets the hole punch option of the print task. + +## -property-value +The hole punch option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_maxcopies.md b/windows.graphics.printing/printtaskoptions_maxcopies.md index 8c4044e915..f70888e490 100644 --- a/windows.graphics.printing/printtaskoptions_maxcopies.md +++ b/windows.graphics.printing/printtaskoptions_maxcopies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MaxCopies --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.MaxCopies ## -description Gets the maximum number of copies supported for the print task. ## -property-value The maximum number of copies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MaxCopies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.MaxCopies + +## -description +Gets the maximum number of copies supported for the print task. + +## -property-value +The maximum number of copies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_mediasize.md b/windows.graphics.printing/printtaskoptions_mediasize.md index 6c3f58b6ba..a43af95cfa 100644 --- a/windows.graphics.printing/printtaskoptions_mediasize.md +++ b/windows.graphics.printing/printtaskoptions_mediasize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MediaSize --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.MediaSize ## -description Gets or sets the media size option of the print task. ## -property-value The media size option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MediaSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.MediaSize + +## -description +Gets or sets the media size option of the print task. + +## -property-value +The media size option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_mediatype.md b/windows.graphics.printing/printtaskoptions_mediatype.md index 6453daf93e..f61966089d 100644 --- a/windows.graphics.printing/printtaskoptions_mediatype.md +++ b/windows.graphics.printing/printtaskoptions_mediatype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MediaType --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.MediaType ## -description Gets or sets the media type option for the print task. ## -property-value The media type option. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MediaType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.MediaType + +## -description +Gets or sets the media type option for the print task. + +## -property-value +The media type option. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_mincopies.md b/windows.graphics.printing/printtaskoptions_mincopies.md index c84998b92f..bd0b675dd2 100644 --- a/windows.graphics.printing/printtaskoptions_mincopies.md +++ b/windows.graphics.printing/printtaskoptions_mincopies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MinCopies --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.MinCopies ## -description Gets the minimum number of copies allowed for the print task. ## -property-value The minimum number of copies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.MinCopies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.MinCopies + +## -description +Gets the minimum number of copies allowed for the print task. + +## -property-value +The minimum number of copies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_numberofcopies.md b/windows.graphics.printing/printtaskoptions_numberofcopies.md index 29c93475d3..0f522ad9de 100644 --- a/windows.graphics.printing/printtaskoptions_numberofcopies.md +++ b/windows.graphics.printing/printtaskoptions_numberofcopies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.NumberOfCopies --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.NumberOfCopies ## -description Gets or sets the value for the number of copies for the print task. ## -property-value The value for the number of copies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.NumberOfCopies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.NumberOfCopies + +## -description +Gets or sets the value for the number of copies for the print task. + +## -property-value +The value for the number of copies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_orientation.md b/windows.graphics.printing/printtaskoptions_orientation.md index 1d7043d8ce..e65af9bf5f 100644 --- a/windows.graphics.printing/printtaskoptions_orientation.md +++ b/windows.graphics.printing/printtaskoptions_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Orientation --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.Orientation ## -description Gets or sets the orientation option for the print task. ## -property-value The orientation for the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Orientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.Orientation + +## -description +Gets or sets the orientation option for the print task. + +## -property-value +The orientation for the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_printquality.md b/windows.graphics.printing/printtaskoptions_printquality.md index 1ca5023605..e49cb2f0b0 100644 --- a/windows.graphics.printing/printtaskoptions_printquality.md +++ b/windows.graphics.printing/printtaskoptions_printquality.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.PrintQuality --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.PrintQuality ## -description Gets or sets the print quality option for the print task. ## -property-value The print quality for the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.PrintQuality +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.PrintQuality + +## -description +Gets or sets the print quality option for the print task. + +## -property-value +The print quality for the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskoptions_staple.md b/windows.graphics.printing/printtaskoptions_staple.md index 46e89c4f70..c356e87b68 100644 --- a/windows.graphics.printing/printtaskoptions_staple.md +++ b/windows.graphics.printing/printtaskoptions_staple.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Staple --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskOptions.Staple ## -description Gets or sets the staple option for the print task. ## -property-value The staple option for the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskOptions.Staple +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskOptions.Staple + +## -description +Gets or sets the staple option for the print task. + +## -property-value +The staple option for the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskprogressingeventargs_documentpagecount.md b/windows.graphics.printing/printtaskprogressingeventargs_documentpagecount.md index 5b68efd5ad..8e3867b850 100644 --- a/windows.graphics.printing/printtaskprogressingeventargs_documentpagecount.md +++ b/windows.graphics.printing/printtaskprogressingeventargs_documentpagecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskProgressingEventArgs.DocumentPageCount --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskProgressingEventArgs.DocumentPageCount ## -description Gets the page count for a print task. ## -property-value The page count for a print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskProgressingEventArgs.DocumentPageCount +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskProgressingEventArgs.DocumentPageCount + +## -description +Gets the page count for a print task. + +## -property-value +The page count for a print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskrequest_createprinttask_356827780.md b/windows.graphics.printing/printtaskrequest_createprinttask_356827780.md index b1eaf625fa..803ecc4d50 100644 --- a/windows.graphics.printing/printtaskrequest_createprinttask_356827780.md +++ b/windows.graphics.printing/printtaskrequest_createprinttask_356827780.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskRequest.CreatePrintTask(System.String,Windows.Graphics.Printing.PrintTaskSourceRequestedHandler) --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskRequest.CreatePrintTask ## -description Creates a new [PrintTask](printtask.md) which indicates that the app has content to be printed. ## -parameters ### -param title Title for the print task. ### -param handler Pointer to a **PrintTaskSourceRequestedHandler** delegate for the print task. ## -returns Pointer to the print task that was created. ## -remarks ## -examples ## -see-also [Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx), [PrintTask](printtask.md), [PrintTaskSourceRequestedHandler](printtasksourcerequestedhandler.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskRequest.CreatePrintTask(System.String,Windows.Graphics.Printing.PrintTaskSourceRequestedHandler) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskRequest.CreatePrintTask + +## -description +Creates a new [PrintTask](printtask.md) which indicates that the app has content to be printed. + +## -parameters +### -param title +Title for the print task. + +### -param handler +Pointer to a **PrintTaskSourceRequestedHandler** delegate for the print task. + +## -returns +Pointer to the print task that was created. + +## -remarks + +## -examples + +## -see-also +[Printing](http://msdn.microsoft.com/library/windows/apps/hh465225.aspx), [PrintTask](printtask.md), [PrintTaskSourceRequestedHandler](printtasksourcerequestedhandler.md) \ No newline at end of file diff --git a/windows.graphics.printing/printtaskrequest_deadline.md b/windows.graphics.printing/printtaskrequest_deadline.md index 5e5ca680e2..5708ac99ec 100644 --- a/windows.graphics.printing/printtaskrequest_deadline.md +++ b/windows.graphics.printing/printtaskrequest_deadline.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskRequest.Deadline --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskRequest.Deadline ## -description Gets a [DateTime](../windows.foundation/datetime.md) value that indicates how long an app has to respond to the [PrintTaskRequested](printmanager_printtaskrequested.md) event. If the system has not received a response from the [PrintTaskRequested](printmanager_printtaskrequested.md) event handler by the time the deadline is reached, then the print task is ignored. ## -property-value A value that indicates how long an app has to respond to the [PrintTaskRequested](printmanager_printtaskrequested.md) event. ## -remarks ## -examples ## -see-also [DateTime](../windows.foundation/datetime.md) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskRequest.Deadline +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskRequest.Deadline + +## -description +Gets a [DateTime](../windows.foundation/datetime.md) value that indicates how long an app has to respond to the [PrintTaskRequested](printmanager_printtaskrequested.md) event. If the system has not received a response from the [PrintTaskRequested](printmanager_printtaskrequested.md) event handler by the time the deadline is reached, then the print task is ignored. + +## -property-value +A value that indicates how long an app has to respond to the [PrintTaskRequested](printmanager_printtaskrequested.md) event. + +## -remarks + +## -examples + +## -see-also +[DateTime](../windows.foundation/datetime.md) \ No newline at end of file diff --git a/windows.graphics.printing/printtaskrequest_getdeferral_254836512.md b/windows.graphics.printing/printtaskrequest_getdeferral_254836512.md index 7e573ee432..bdf3dab35b 100644 --- a/windows.graphics.printing/printtaskrequest_getdeferral_254836512.md +++ b/windows.graphics.printing/printtaskrequest_getdeferral_254836512.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskRequest.GetDeferral --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskRequest.GetDeferral ## -description Retrieves the deferral object associated with the [PrintTaskRequest](printtaskrequest.md). The deferral object is used to handle asynchronous calls in the [PrintTaskRequested](printmanager_printtaskrequested.md) event handler. ## -returns The **PrintTaskRequestedDeferral** for a print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskRequest.GetDeferral + +## -description +Retrieves the deferral object associated with the [PrintTaskRequest](printtaskrequest.md). The deferral object is used to handle asynchronous calls in the [PrintTaskRequested](printmanager_printtaskrequested.md) event handler. + +## -returns +The **PrintTaskRequestedDeferral** for a print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskrequesteddeferral_complete_1807836922.md b/windows.graphics.printing/printtaskrequesteddeferral_complete_1807836922.md index e95a450a6d..4c054d7a25 100644 --- a/windows.graphics.printing/printtaskrequesteddeferral_complete_1807836922.md +++ b/windows.graphics.printing/printtaskrequesteddeferral_complete_1807836922.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskRequestedDeferral.Complete --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskRequestedDeferral.Complete ## -description Indicates when the deferral for the print task request is over. ## -remarks Although this method does not have a return value, it uses the appropriate HRESULT value to indicate a successful or a failed method call. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskRequestedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskRequestedDeferral.Complete + +## -description +Indicates when the deferral for the print task request is over. + +## -remarks +Although this method does not have a return value, it uses the appropriate HRESULT value to indicate a successful or a failed method call. + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtaskrequestedeventargs_request.md b/windows.graphics.printing/printtaskrequestedeventargs_request.md index fcc47bf423..f63b9069e8 100644 --- a/windows.graphics.printing/printtaskrequestedeventargs_request.md +++ b/windows.graphics.printing/printtaskrequestedeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskRequestedEventArgs.Request --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskRequestedEventArgs.Request ## -description Gets the [PrintTaskRequest](printtaskrequest.md) object for a print task. ## -property-value The [PrintTaskRequest](printtaskrequest.md) object for a print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskRequestedEventArgs.Request + +## -description +Gets the [PrintTaskRequest](printtaskrequest.md) object for a print task. + +## -property-value +The [PrintTaskRequest](printtaskrequest.md) object for a print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtasksourcerequestedargs_deadline.md b/windows.graphics.printing/printtasksourcerequestedargs_deadline.md index d2d697d33a..29b6eef6f8 100644 --- a/windows.graphics.printing/printtasksourcerequestedargs_deadline.md +++ b/windows.graphics.printing/printtasksourcerequestedargs_deadline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.Deadline --api-type: winrt property ---- # Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.Deadline ## -description Gets the **DateTime** object that indicates the deadline for a print task source request. ## -property-value The deadline for a print task source request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.Deadline +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.Deadline + +## -description +Gets the **DateTime** object that indicates the deadline for a print task source request. + +## -property-value +The deadline for a print task source request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/printtasksourcerequestedargs_getdeferral_254836512.md b/windows.graphics.printing/printtasksourcerequestedargs_getdeferral_254836512.md index bcc4327762..1f8d673992 100644 --- a/windows.graphics.printing/printtasksourcerequestedargs_getdeferral_254836512.md +++ b/windows.graphics.printing/printtasksourcerequestedargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.GetDeferral --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.GetDeferral ## -description Gets a [PrintTaskSourceRequestedDeferral](printtasksourcerequesteddeferral.md) object that provides access to a [Complete](printtasksourcerequesteddeferral_complete.md) method. This method indicates then the deferral is over. ## -returns Provides access to a **Complete** method. ## -remarks ## -examples ## -see-also [Complete](printtasksourcerequesteddeferral_complete.md), [PrintTaskSourceRequestedDeferral](printtasksourcerequesteddeferral.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.GetDeferral + +## -description +Gets a [PrintTaskSourceRequestedDeferral](printtasksourcerequesteddeferral.md) object that provides access to a [Complete](printtasksourcerequesteddeferral_complete.md) method. This method indicates then the deferral is over. + +## -returns +Provides access to a **Complete** method. + +## -remarks + +## -examples + +## -see-also +[Complete](printtasksourcerequesteddeferral_complete.md), [PrintTaskSourceRequestedDeferral](printtasksourcerequesteddeferral.md) \ No newline at end of file diff --git a/windows.graphics.printing/printtasksourcerequestedargs_setsource_1925283600.md b/windows.graphics.printing/printtasksourcerequestedargs_setsource_1925283600.md index 929001d452..4bbb938dd3 100644 --- a/windows.graphics.printing/printtasksourcerequestedargs_setsource_1925283600.md +++ b/windows.graphics.printing/printtasksourcerequestedargs_setsource_1925283600.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.SetSource(Windows.Graphics.Printing.IPrintDocumentSource) --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.SetSource ## -description Informs the print task of the content to be printed. ## -parameters ### -param source A pointer to the **IPrintDocumentSource** interface. ## -remarks Content source information for the print task can come from either HTML (via [MSApp.GetHtmlPrintDocumentSource](http://msdn.microsoft.com/library/windows/apps/hh831251.aspx)) or from XAML (via the XAML [PrintDocument.DocumentSource](http://msdn.microsoft.com/library/windows/apps/windows.ui.xaml.printing.printdocument.documentsource.aspx)). Or you can create your own method to provide content source information to the print task. For information about how to create your own method, see the [Direct2D printing sample](http://code.msdn.microsoft.com/windowsapps/Direct2Dapp-printing-sample-9869f99c). ## -examples ## -see-also [Direct2D printing sample](http://code.msdn.microsoft.com/windowsapps/Direct2Dapp-printing-sample-9869f99c), [IPrintDocumentSource](iprintdocumentsource.md), [MSApp.GetHtmlPrintDocumentSource](http://msdn.microsoft.com/library/windows/apps/hh831251.aspx), [PrintDocument.DocumentSource](http://msdn.microsoft.com/library/windows/apps/windows.ui.xaml.printing.printdocument.documentsource.aspx) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.SetSource(Windows.Graphics.Printing.IPrintDocumentSource) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskSourceRequestedArgs.SetSource + +## -description +Informs the print task of the content to be printed. + +## -parameters +### -param source +A pointer to the **IPrintDocumentSource** interface. + +## -remarks +Content source information for the print task can come from either HTML (via [MSApp.GetHtmlPrintDocumentSource](http://msdn.microsoft.com/library/windows/apps/hh831251.aspx)) or from XAML (via the XAML [PrintDocument.DocumentSource](http://msdn.microsoft.com/library/windows/apps/windows.ui.xaml.printing.printdocument.documentsource.aspx)). Or you can create your own method to provide content source information to the print task. For information about how to create your own method, see the [Direct2D printing sample](http://code.msdn.microsoft.com/windowsapps/Direct2Dapp-printing-sample-9869f99c). + +## -examples + +## -see-also +[Direct2D printing sample](http://code.msdn.microsoft.com/windowsapps/Direct2Dapp-printing-sample-9869f99c), [IPrintDocumentSource](iprintdocumentsource.md), [MSApp.GetHtmlPrintDocumentSource](http://msdn.microsoft.com/library/windows/apps/hh831251.aspx), [PrintDocument.DocumentSource](http://msdn.microsoft.com/library/windows/apps/windows.ui.xaml.printing.printdocument.documentsource.aspx) \ No newline at end of file diff --git a/windows.graphics.printing/printtasksourcerequesteddeferral_complete_1807836922.md b/windows.graphics.printing/printtasksourcerequesteddeferral_complete_1807836922.md index 08ea862b87..3cfdab126d 100644 --- a/windows.graphics.printing/printtasksourcerequesteddeferral_complete_1807836922.md +++ b/windows.graphics.printing/printtasksourcerequesteddeferral_complete_1807836922.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Graphics.Printing.PrintTaskSourceRequestedDeferral.Complete --api-type: winrt method ---- # Windows.Graphics.Printing.PrintTaskSourceRequestedDeferral.Complete ## -description Indicates when the deferral for a print task source request is over. ## -remarks Although **Complete** does not have a return value, it uses the appropriate HRESULT message to indicate a successful or a failed method call. ## -examples ## -see-also [GetDeferral](printtasksourcerequestedargs_getdeferral.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing.PrintTaskSourceRequestedDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing.PrintTaskSourceRequestedDeferral.Complete + +## -description +Indicates when the deferral for a print task source request is over. + +## -remarks +Although **Complete** does not have a return value, it uses the appropriate HRESULT message to indicate a successful or a failed method call. + +## -examples + +## -see-also +[GetDeferral](printtasksourcerequestedargs_getdeferral.md) \ No newline at end of file diff --git a/windows.graphics.printing/standardprinttaskoptions_binding.md b/windows.graphics.printing/standardprinttaskoptions_binding.md index 7637f58190..713423e43c 100644 --- a/windows.graphics.printing/standardprinttaskoptions_binding.md +++ b/windows.graphics.printing/standardprinttaskoptions_binding.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Binding --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Binding ## -description Gets the canonical name for the binding option of the print task. ## -property-value The canonical name for the binding option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Binding +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Binding + +## -description +Gets the canonical name for the binding option of the print task. + +## -property-value +The canonical name for the binding option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_bordering.md b/windows.graphics.printing/standardprinttaskoptions_bordering.md index 529d8c675a..be0c392582 100644 --- a/windows.graphics.printing/standardprinttaskoptions_bordering.md +++ b/windows.graphics.printing/standardprinttaskoptions_bordering.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Bordering --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Bordering ## -description Gets the canonical name of the bordering option for the print task. ## -property-value The canonical name of the bordering option for the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Bordering +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Bordering + +## -description +Gets the canonical name of the bordering option for the print task. + +## -property-value +The canonical name of the bordering option for the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_collation.md b/windows.graphics.printing/standardprinttaskoptions_collation.md index c4c9f0e30a..124b1dfd49 100644 --- a/windows.graphics.printing/standardprinttaskoptions_collation.md +++ b/windows.graphics.printing/standardprinttaskoptions_collation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Collation --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Collation ## -description Gets the canonical name for collation option of the print task. ## -property-value The canonical name for collation option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Collation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Collation + +## -description +Gets the canonical name for collation option of the print task. + +## -property-value +The canonical name for collation option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_colormode.md b/windows.graphics.printing/standardprinttaskoptions_colormode.md index edb26379f2..94b32159dd 100644 --- a/windows.graphics.printing/standardprinttaskoptions_colormode.md +++ b/windows.graphics.printing/standardprinttaskoptions_colormode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.ColorMode --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.ColorMode ## -description Gets the canonical name for color mode option of the print task. ## -property-value The canonical name for color mode option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.ColorMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.ColorMode + +## -description +Gets the canonical name for color mode option of the print task. + +## -property-value +The canonical name for color mode option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_copies.md b/windows.graphics.printing/standardprinttaskoptions_copies.md index c29aba6a26..2748818d80 100644 --- a/windows.graphics.printing/standardprinttaskoptions_copies.md +++ b/windows.graphics.printing/standardprinttaskoptions_copies.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Copies --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Copies ## -description Gets the canonical name for the copies option of the print task. ## -property-value The canonical name for the copies option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Copies +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Copies + +## -description +Gets the canonical name for the copies option of the print task. + +## -property-value +The canonical name for the copies option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_duplex.md b/windows.graphics.printing/standardprinttaskoptions_duplex.md index 6abef9a7c9..46f8590b26 100644 --- a/windows.graphics.printing/standardprinttaskoptions_duplex.md +++ b/windows.graphics.printing/standardprinttaskoptions_duplex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Duplex --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Duplex ## -description Gets the canonical name for the duplex option of the print task. ## -property-value The canonical name for the duplex option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Duplex +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Duplex + +## -description +Gets the canonical name for the duplex option of the print task. + +## -property-value +The canonical name for the duplex option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_holepunch.md b/windows.graphics.printing/standardprinttaskoptions_holepunch.md index 1cb76c92a9..1883647b4b 100644 --- a/windows.graphics.printing/standardprinttaskoptions_holepunch.md +++ b/windows.graphics.printing/standardprinttaskoptions_holepunch.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.HolePunch --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.HolePunch ## -description Gets the canonical name for the hole punch option of the print task. ## -property-value The canonical name for the hole punch option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.HolePunch +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.HolePunch + +## -description +Gets the canonical name for the hole punch option of the print task. + +## -property-value +The canonical name for the hole punch option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_inputbin.md b/windows.graphics.printing/standardprinttaskoptions_inputbin.md index 300586fbc3..dada2b21d7 100644 --- a/windows.graphics.printing/standardprinttaskoptions_inputbin.md +++ b/windows.graphics.printing/standardprinttaskoptions_inputbin.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.InputBin --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.InputBin ## -description Gets the canonical name for the input bin option of the print task. ## -property-value The canonical name for the input bin option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.InputBin +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.InputBin + +## -description +Gets the canonical name for the input bin option of the print task. + +## -property-value +The canonical name for the input bin option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_mediasize.md b/windows.graphics.printing/standardprinttaskoptions_mediasize.md index 385f2dc18f..338432aedb 100644 --- a/windows.graphics.printing/standardprinttaskoptions_mediasize.md +++ b/windows.graphics.printing/standardprinttaskoptions_mediasize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.MediaSize --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.MediaSize ## -description Gets the canonical name for the media size option of the print task. ## -property-value The canonical name for the media size option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.MediaSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.MediaSize + +## -description +Gets the canonical name for the media size option of the print task. + +## -property-value +The canonical name for the media size option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_mediatype.md b/windows.graphics.printing/standardprinttaskoptions_mediatype.md index 3d4e26c326..42ae7eba7d 100644 --- a/windows.graphics.printing/standardprinttaskoptions_mediatype.md +++ b/windows.graphics.printing/standardprinttaskoptions_mediatype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.MediaType --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.MediaType ## -description Gets the canonical name for the media type option of the print task. ## -property-value The canonical name for the media type option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.MediaType +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.MediaType + +## -description +Gets the canonical name for the media type option of the print task. + +## -property-value +The canonical name for the media type option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_nup.md b/windows.graphics.printing/standardprinttaskoptions_nup.md index 5c6d2a87c8..6e84cd10d2 100644 --- a/windows.graphics.printing/standardprinttaskoptions_nup.md +++ b/windows.graphics.printing/standardprinttaskoptions_nup.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.NUp --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.NUp ## -description Gets the canonical name for the NUp option of the print task. ## -property-value The canonical name for the NUp option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.NUp +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.NUp + +## -description +Gets the canonical name for the NUp option of the print task. + +## -property-value +The canonical name for the NUp option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_orientation.md b/windows.graphics.printing/standardprinttaskoptions_orientation.md index e20168d89e..7f742927ee 100644 --- a/windows.graphics.printing/standardprinttaskoptions_orientation.md +++ b/windows.graphics.printing/standardprinttaskoptions_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Orientation --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Orientation ## -description Gets the canonical name for the orientation option of the print task. ## -property-value The canonical name for the orientation option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Orientation +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Orientation + +## -description +Gets the canonical name for the orientation option of the print task. + +## -property-value +The canonical name for the orientation option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_printquality.md b/windows.graphics.printing/standardprinttaskoptions_printquality.md index 42527d6ce0..ae9a65cbcf 100644 --- a/windows.graphics.printing/standardprinttaskoptions_printquality.md +++ b/windows.graphics.printing/standardprinttaskoptions_printquality.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.PrintQuality --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.PrintQuality ## -description Gets the canonical name for the print quality option of the print task. ## -property-value The canonical name for the print quality option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.PrintQuality +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.PrintQuality + +## -description +Gets the canonical name for the print quality option of the print task. + +## -property-value +The canonical name for the print quality option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing/standardprinttaskoptions_staple.md b/windows.graphics.printing/standardprinttaskoptions_staple.md index b80b92cca2..a6f86bb2dc 100644 --- a/windows.graphics.printing/standardprinttaskoptions_staple.md +++ b/windows.graphics.printing/standardprinttaskoptions_staple.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Staple --api-type: winrt property ---- # Windows.Graphics.Printing.StandardPrintTaskOptions.Staple ## -description Gets the canonical name for the staple option of the print task. ## -property-value The canonical name for the staple option of the print task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing.StandardPrintTaskOptions.Staple +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.StandardPrintTaskOptions.Staple + +## -description +Gets the canonical name for the staple option of the print task. + +## -property-value +The canonical name for the staple option of the print task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dmanager.md b/windows.graphics.printing3d/print3dmanager.md index be5cc55a64..8eadbd5170 100644 --- a/windows.graphics.printing3d/print3dmanager.md +++ b/windows.graphics.printing3d/print3dmanager.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DManager --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DManager ## -description Creates the 3D printing experience. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also [3D Printing from Unity sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=722936) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DManager +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DManager + +## -description +Creates the 3D printing experience. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also +[3D Printing from Unity sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=722936) \ No newline at end of file diff --git a/windows.graphics.printing3d/print3dmanager_getforcurrentview_1363600702.md b/windows.graphics.printing3d/print3dmanager_getforcurrentview_1363600702.md index 64dd3bd45d..39563fabe3 100644 --- a/windows.graphics.printing3d/print3dmanager_getforcurrentview_1363600702.md +++ b/windows.graphics.printing3d/print3dmanager_getforcurrentview_1363600702.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Print3DManager.GetForCurrentView --api-type: winrt method ---- # Windows.Graphics.Printing3D.Print3DManager.GetForCurrentView ## -description Gets a 3D print manager. ## -returns The 3D print manager. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Print3DManager.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Print3DManager.GetForCurrentView + +## -description +Gets a 3D print manager. + +## -returns +The 3D print manager. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dmanager_showprintuiasync_1397448831.md b/windows.graphics.printing3d/print3dmanager_showprintuiasync_1397448831.md index f2ec515392..10a8bc1d3c 100644 --- a/windows.graphics.printing3d/print3dmanager_showprintuiasync_1397448831.md +++ b/windows.graphics.printing3d/print3dmanager_showprintuiasync_1397448831.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Print3DManager.ShowPrintUIAsync --api-type: winrt method ---- # Windows.Graphics.Printing3D.Print3DManager.ShowPrintUIAsync ## -description Programmatically initiates the 3D printing user interface. ## -returns **true** if the operation completes successfully; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Print3DManager.ShowPrintUIAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Print3DManager.ShowPrintUIAsync + +## -description +Programmatically initiates the 3D printing user interface. + +## -returns +**true** if the operation completes successfully; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dmanager_taskrequested.md b/windows.graphics.printing3d/print3dmanager_taskrequested.md index 3110f32b2e..8e02d9b041 100644 --- a/windows.graphics.printing3d/print3dmanager_taskrequested.md +++ b/windows.graphics.printing3d/print3dmanager_taskrequested.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing3D.Print3DManager.TaskRequested --api-type: winrt event ---- # Windows.Graphics.Printing3D.Print3DManager.TaskRequested ## -description Occurs when a new 3D print job has been created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing3D.Print3DManager.TaskRequested +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing3D.Print3DManager.TaskRequested + +## -description +Occurs when a new 3D print job has been created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtask.md b/windows.graphics.printing3d/print3dtask.md index 9dfab44f65..4f25048bc7 100644 --- a/windows.graphics.printing3d/print3dtask.md +++ b/windows.graphics.printing3d/print3dtask.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DTask --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DTask ## -description Represents a 3D print job. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DTask +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DTask + +## -description +Represents a 3D print job. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtask_completed.md b/windows.graphics.printing3d/print3dtask_completed.md index 1545e1dfe9..3879e946c8 100644 --- a/windows.graphics.printing3d/print3dtask_completed.md +++ b/windows.graphics.printing3d/print3dtask_completed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing3D.Print3DTask.Completed --api-type: winrt event ---- # Windows.Graphics.Printing3D.Print3DTask.Completed ## -description Occurs when the print request has been sent to the 3D printer and the 3D print job has been created. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing3D.Print3DTask.Completed +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing3D.Print3DTask.Completed + +## -description +Occurs when the print request has been sent to the 3D printer and the 3D print job has been created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtask_source.md b/windows.graphics.printing3d/print3dtask_source.md index 3b7e37fdd5..acb7894028 100644 --- a/windows.graphics.printing3d/print3dtask_source.md +++ b/windows.graphics.printing3d/print3dtask_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Print3DTask.Source --api-type: winrt property ---- # Windows.Graphics.Printing3D.Print3DTask.Source ## -description Gets the 3D print package to be printed. ## -property-value The 3D print package to be printed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Print3DTask.Source +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Print3DTask.Source + +## -description +Gets the 3D print package to be printed. + +## -property-value +The 3D print package to be printed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtask_sourcechanged.md b/windows.graphics.printing3d/print3dtask_sourcechanged.md index 9a399e9dd2..c2b1a88c4e 100644 --- a/windows.graphics.printing3d/print3dtask_sourcechanged.md +++ b/windows.graphics.printing3d/print3dtask_sourcechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing3D.Print3DTask.SourceChanged --api-type: winrt event ---- # Windows.Graphics.Printing3D.Print3DTask.SourceChanged ## -description Occurs when the workflow modifies the 3D print package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing3D.Print3DTask.SourceChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing3D.Print3DTask.SourceChanged + +## -description +Occurs when the workflow modifies the 3D print package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtask_submitting.md b/windows.graphics.printing3d/print3dtask_submitting.md index ad8faab6b2..bf8f5f9428 100644 --- a/windows.graphics.printing3d/print3dtask_submitting.md +++ b/windows.graphics.printing3d/print3dtask_submitting.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Graphics.Printing3D.Print3DTask.Submitting --api-type: winrt event ---- # Windows.Graphics.Printing3D.Print3DTask.Submitting ## -description Occurs when the 3D print package has been submitted to the 3D printer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Graphics.Printing3D.Print3DTask.Submitting +-api-type: winrt event +--- + + + +# Windows.Graphics.Printing3D.Print3DTask.Submitting + +## -description +Occurs when the 3D print package has been submitted to the 3D printer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskcompletedeventargs.md b/windows.graphics.printing3d/print3dtaskcompletedeventargs.md index 1a8c7b43e4..9258ac4cce 100644 --- a/windows.graphics.printing3d/print3dtaskcompletedeventargs.md +++ b/windows.graphics.printing3d/print3dtaskcompletedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs ## -description Provides data for the [Completed](print3dtask_completed.md) event of the 3D print request. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs + +## -description +Provides data for the [Completed](print3dtask_completed.md) event of the 3D print request. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskcompletedeventargs_completion.md b/windows.graphics.printing3d/print3dtaskcompletedeventargs_completion.md index 81737e134f..695f016078 100644 --- a/windows.graphics.printing3d/print3dtaskcompletedeventargs_completion.md +++ b/windows.graphics.printing3d/print3dtaskcompletedeventargs_completion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.Completion --api-type: winrt property ---- # Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.Completion ## -description Gets the status of the 3D print request. ## -property-value The completion status of the 3D print request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.Completion +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.Completion + +## -description +Gets the status of the 3D print request. + +## -property-value +The completion status of the 3D print request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskcompletedeventargs_extendedstatus.md b/windows.graphics.printing3d/print3dtaskcompletedeventargs_extendedstatus.md index e8ce6da831..320e0c496e 100644 --- a/windows.graphics.printing3d/print3dtaskcompletedeventargs_extendedstatus.md +++ b/windows.graphics.printing3d/print3dtaskcompletedeventargs_extendedstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.ExtendedStatus --api-type: winrt property ---- # Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.ExtendedStatus ## -description Gets the type of error encountered during the 3D print request. ## -property-value The type of error encountered during the 3D print request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.ExtendedStatus +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskCompletedEventArgs.ExtendedStatus + +## -description +Gets the type of error encountered during the 3D print request. + +## -property-value +The type of error encountered during the 3D print request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskrequest.md b/windows.graphics.printing3d/print3dtaskrequest.md index 6aa36a2f86..176ae21021 100644 --- a/windows.graphics.printing3d/print3dtaskrequest.md +++ b/windows.graphics.printing3d/print3dtaskrequest.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DTaskRequest --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DTaskRequest ## -description Represents a 3D print job request. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DTaskRequest +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskRequest + +## -description +Represents a 3D print job request. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskrequest_createtask_1838664787.md b/windows.graphics.printing3d/print3dtaskrequest_createtask_1838664787.md index 78dc129b0b..0658a9303f 100644 --- a/windows.graphics.printing3d/print3dtaskrequest_createtask_1838664787.md +++ b/windows.graphics.printing3d/print3dtaskrequest_createtask_1838664787.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Print3DTaskRequest.CreateTask(System.String,System.String,Windows.Graphics.Printing3D.Print3DTaskSourceRequestedHandler) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Print3DTaskRequest.CreateTask ## -description Creates a 3D print job. ## -parameters ### -param title The name of the print job. ### -param printerId The identifier of the 3D printer. ### -param handler The callback for the source of the print job request. ## -returns The 3D print job. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Print3DTaskRequest.CreateTask(System.String,System.String,Windows.Graphics.Printing3D.Print3DTaskSourceRequestedHandler) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskRequest.CreateTask + +## -description +Creates a 3D print job. + +## -parameters +### -param title +The name of the print job. + +### -param printerId +The identifier of the 3D printer. + +### -param handler +The callback for the source of the print job request. + +## -returns +The 3D print job. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskrequestedeventargs.md b/windows.graphics.printing3d/print3dtaskrequestedeventargs.md index e8ed6dc8b9..4d8eed00ab 100644 --- a/windows.graphics.printing3d/print3dtaskrequestedeventargs.md +++ b/windows.graphics.printing3d/print3dtaskrequestedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs ## -description Provides data for the [TaskRequested](print3dmanager_taskrequested.md) event. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs + +## -description +Provides data for the [TaskRequested](print3dmanager_taskrequested.md) event. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtaskrequestedeventargs_request.md b/windows.graphics.printing3d/print3dtaskrequestedeventargs_request.md index b32e89851e..ce0a83424c 100644 --- a/windows.graphics.printing3d/print3dtaskrequestedeventargs_request.md +++ b/windows.graphics.printing3d/print3dtaskrequestedeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs.Request --api-type: winrt property ---- # Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs.Request ## -description Gets the 3D print job request associated with the [Print3DManager](print3dmanager.md). ## -property-value The 3D print job request. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskRequestedEventArgs.Request + +## -description +Gets the 3D print job request associated with the [Print3DManager](print3dmanager.md). + +## -property-value +The 3D print job request. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtasksourcechangedeventargs.md b/windows.graphics.printing3d/print3dtasksourcechangedeventargs.md index 93b7e4571c..9bcc136419 100644 --- a/windows.graphics.printing3d/print3dtasksourcechangedeventargs.md +++ b/windows.graphics.printing3d/print3dtasksourcechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs ## -description Provides data for the [SourceChanged](print3dtask_sourcechanged.md) event. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs + +## -description +Provides data for the [SourceChanged](print3dtask_sourcechanged.md) event. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtasksourcechangedeventargs_source.md b/windows.graphics.printing3d/print3dtasksourcechangedeventargs_source.md index fcf3234d71..b3623b0fa7 100644 --- a/windows.graphics.printing3d/print3dtasksourcechangedeventargs_source.md +++ b/windows.graphics.printing3d/print3dtasksourcechangedeventargs_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs.Source --api-type: winrt property ---- # Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs.Source ## -description Gets the updated 3D print package from the workflow. ## -property-value The updated 3D print package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs.Source +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskSourceChangedEventArgs.Source + +## -description +Gets the updated 3D print package from the workflow. + +## -property-value +The updated 3D print package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtasksourcerequestedargs.md b/windows.graphics.printing3d/print3dtasksourcerequestedargs.md index 2f2e69a51b..1d29b04922 100644 --- a/windows.graphics.printing3d/print3dtasksourcerequestedargs.md +++ b/windows.graphics.printing3d/print3dtasksourcerequestedargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs --api-type: winrt class ---- # Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs ## -description Provides data for the [Print3DTaskSourceRequestedHandler](print3dtasksourcerequestedhandler.md) delegate. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs + +## -description +Provides data for the [Print3DTaskSourceRequestedHandler](print3dtasksourcerequestedhandler.md) delegate. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/print3dtasksourcerequestedargs_setsource_459917786.md b/windows.graphics.printing3d/print3dtasksourcerequestedargs_setsource_459917786.md index 917feaef7c..6e84d1a665 100644 --- a/windows.graphics.printing3d/print3dtasksourcerequestedargs_setsource_459917786.md +++ b/windows.graphics.printing3d/print3dtasksourcerequestedargs_setsource_459917786.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs.SetSource(Windows.Graphics.Printing3D.Printing3D3MFPackage) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs.SetSource ## -description Specifies the 3D Manufacturing Format (3MF) package to use in the print job. ## -parameters ### -param source The 3D Manufacturing Format (3MF) package to use in the print job. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs.SetSource(Windows.Graphics.Printing3D.Printing3D3MFPackage) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Print3DTaskSourceRequestedArgs.SetSource + +## -description +Specifies the 3D Manufacturing Format (3MF) package to use in the print job. + +## -parameters +### -param source +The 3D Manufacturing Format (3MF) package to use in the print job. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage.md b/windows.graphics.printing3d/printing3d3mfpackage.md index 9e4952d628..0ea92874a3 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage.md +++ b/windows.graphics.printing3d/printing3d3mfpackage.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3D3MFPackage --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage ## -description Represents a 3D Manufacturing Format (3MF) package. ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also [3D Printing from Unity sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=722936) \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3D3MFPackage +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage + +## -description +Represents a 3D Manufacturing Format (3MF) package. + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also +[3D Printing from Unity sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=722936) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3d3mfpackage_loadasync_1538582191.md b/windows.graphics.printing3d/printing3d3mfpackage_loadasync_1538582191.md index 775327b176..cc3b970b83 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_loadasync_1538582191.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_loadasync_1538582191.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadAsync(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadAsync ## -description Creates a [Printing3D3MFPackage](printing3d3mfpackage.md) object from a 3D Manufacturing Format (3MF) file stream. ## -parameters ### -param value A 3MF file stream. ## -returns A [Printing3D3MFPackage](printing3d3mfpackage.md) created from the specified 3MF package stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadAsync(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadAsync + +## -description +Creates a [Printing3D3MFPackage](printing3d3mfpackage.md) object from a 3D Manufacturing Format (3MF) file stream. + +## -parameters +### -param value +A 3MF file stream. + +## -returns +A [Printing3D3MFPackage](printing3d3mfpackage.md) created from the specified 3MF package stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_loadmodelfrompackageasync_131803179.md b/windows.graphics.printing3d/printing3d3mfpackage_loadmodelfrompackageasync_131803179.md index 377a69c3c1..3c0cf905f3 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_loadmodelfrompackageasync_131803179.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_loadmodelfrompackageasync_131803179.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadModelFromPackageAsync(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadModelFromPackageAsync ## -description Creates a [Printing3DModel](printing3dmodel.md) object from a 3D Manufacturing Format (3MF) file stream. ## -parameters ### -param value A 3MF file stream. ## -returns A [Printing3DModel](printing3dmodel.md) object created from the specified 3MF object stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadModelFromPackageAsync(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.LoadModelFromPackageAsync + +## -description +Creates a [Printing3DModel](printing3dmodel.md) object from a 3D Manufacturing Format (3MF) file stream. + +## -parameters +### -param value +A 3MF file stream. + +## -returns +A [Printing3DModel](printing3dmodel.md) object created from the specified 3MF object stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_modelpart.md b/windows.graphics.printing3d/printing3d3mfpackage_modelpart.md index 20c2108c1d..addf9ec105 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_modelpart.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_modelpart.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.ModelPart --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.ModelPart ## -description Gets or sets an XML stream to the 3D model in the 3D Manufacturing Format (3MF) package. ## -property-value An XML stream to the 3D model in the 3MF package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.ModelPart +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.ModelPart + +## -description +Gets or sets an XML stream to the 3D model in the 3D Manufacturing Format (3MF) package. + +## -property-value +An XML stream to the 3D model in the 3MF package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_printing3d3mfpackage_1221375020.md b/windows.graphics.printing3d/printing3d3mfpackage_printing3d3mfpackage_1221375020.md index afb095c0cf..2df4a4054f 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_printing3d3mfpackage_1221375020.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_printing3d3mfpackage_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.Printing3D3MFPackage ## -description Creates a [Printing3D3MFPackage](printing3d3mfpackage.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.Printing3D3MFPackage + +## -description +Creates a [Printing3D3MFPackage](printing3d3mfpackage.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_printticket.md b/windows.graphics.printing3d/printing3d3mfpackage_printticket.md index 1ff0679c9a..c1d9520c20 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_printticket.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_printticket.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.PrintTicket --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.PrintTicket ## -description Gets or sets a stream to the print ticket in the 3D Manufacturing Format (3MF) package. ## -property-value A stream to the print ticket in the 3MF package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.PrintTicket +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.PrintTicket + +## -description +Gets or sets a stream to the print ticket in the 3D Manufacturing Format (3MF) package. + +## -property-value +A stream to the print ticket in the 3MF package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_saveasync_2143735121.md b/windows.graphics.printing3d/printing3d3mfpackage_saveasync_2143735121.md index 8ffc913289..bb904babe6 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_saveasync_2143735121.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_saveasync_2143735121.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveAsync --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveAsync ## -description Saves the [Printing3D3MFPackage](printing3d3mfpackage.md) object to a 3D Manufacturing Format (3MF) file stream. ## -returns A stream to the 3MF file where the package is to be saved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveAsync + +## -description +Saves the [Printing3D3MFPackage](printing3d3mfpackage.md) object to a 3D Manufacturing Format (3MF) file stream. + +## -returns +A stream to the 3MF file where the package is to be saved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_savemodeltopackageasync_2108954213.md b/windows.graphics.printing3d/printing3d3mfpackage_savemodeltopackageasync_2108954213.md index e66622a3a3..778019811e 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_savemodeltopackageasync_2108954213.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_savemodeltopackageasync_2108954213.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveModelToPackageAsync(Windows.Graphics.Printing3D.Printing3DModel) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveModelToPackageAsync ## -description Saves the specified 3D model to the 3D Manufacturing Format (3MF) package. ## -parameters ### -param value The 3D model to be saved to the 3MF package. ## -returns The results of the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveModelToPackageAsync(Windows.Graphics.Printing3D.Printing3DModel) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.SaveModelToPackageAsync + +## -description +Saves the specified 3D model to the 3D Manufacturing Format (3MF) package. + +## -parameters +### -param value +The 3D model to be saved to the 3MF package. + +## -returns +The results of the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_textures.md b/windows.graphics.printing3d/printing3d3mfpackage_textures.md index ecc67745aa..6d94b79ec4 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_textures.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_textures.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.Textures --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.Textures ## -description Gets or sets the textures in the 3D Manufacturing Format (3MF) package. ## -property-value The textures in the 3MF package, of type [Printing3DTextureResource](printing3dtextureresource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.Textures +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.Textures + +## -description +Gets or sets the textures in the 3D Manufacturing Format (3MF) package. + +## -property-value +The textures in the 3MF package, of type [Printing3DTextureResource](printing3dtextureresource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3d3mfpackage_thumbnail.md b/windows.graphics.printing3d/printing3d3mfpackage_thumbnail.md index 45d0b24e3d..e98c9b8646 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_thumbnail.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.Thumbnail --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3D3MFPackage.Thumbnail ## -description Gets or sets a thumbnail image that represents the contents of the 3D Manufacturing Format (3MF) package. ## -property-value A thumbnail image that represents the contents of the 3MF package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3D3MFPackage.Thumbnail + +## -description +Gets or sets a thumbnail image that represents the contents of the 3D Manufacturing Format (3MF) package. + +## -property-value +A thumbnail image that represents the contents of the 3MF package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerial.md b/windows.graphics.printing3d/printing3dbasematerial.md index d049a053ea..e6bc9c21b0 100644 --- a/windows.graphics.printing3d/printing3dbasematerial.md +++ b/windows.graphics.printing3d/printing3dbasematerial.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DBaseMaterial --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterial ## -description Represents the base material used for manufacturing certain objects in the 3D model. ## -remarks The [Printing3DBaseMaterial](printing3dbasematerial.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DBaseMaterial +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterial + +## -description +Represents the base material used for manufacturing certain objects in the 3D model. + +## -remarks +The [Printing3DBaseMaterial](printing3dbasematerial.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerial_abs.md b/windows.graphics.printing3d/printing3dbasematerial_abs.md index 3c96ca951f..0cd3562400 100644 --- a/windows.graphics.printing3d/printing3dbasematerial_abs.md +++ b/windows.graphics.printing3d/printing3dbasematerial_abs.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Abs --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterial.Abs ## -description Gets the name the acrylonitrile butadiene styrene (ABS) thermoplastic used in the base material. ## -property-value The name the ABS thermoplastic used in the base material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Abs +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterial.Abs + +## -description +Gets the name the acrylonitrile butadiene styrene (ABS) thermoplastic used in the base material. + +## -property-value +The name the ABS thermoplastic used in the base material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerial_color.md b/windows.graphics.printing3d/printing3dbasematerial_color.md index 454ed9f983..4682d7693e 100644 --- a/windows.graphics.printing3d/printing3dbasematerial_color.md +++ b/windows.graphics.printing3d/printing3dbasematerial_color.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Color --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterial.Color ## -description Gets or sets the color of the base material. ## -property-value The color of the base material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Color +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterial.Color + +## -description +Gets or sets the color of the base material. + +## -property-value +The color of the base material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerial_name.md b/windows.graphics.printing3d/printing3dbasematerial_name.md index ab140ab8a8..4a94aa4bf5 100644 --- a/windows.graphics.printing3d/printing3dbasematerial_name.md +++ b/windows.graphics.printing3d/printing3dbasematerial_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Name --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterial.Name ## -description Gets or sets the name of the base material. ## -property-value The name of the base material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Name +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterial.Name + +## -description +Gets or sets the name of the base material. + +## -property-value +The name of the base material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerial_pla.md b/windows.graphics.printing3d/printing3dbasematerial_pla.md index d9b153f01c..fa5f077b8c 100644 --- a/windows.graphics.printing3d/printing3dbasematerial_pla.md +++ b/windows.graphics.printing3d/printing3dbasematerial_pla.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Pla --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterial.Pla ## -description Gets the name the polylactic acid (PLA) thermoplastic used in the base material. ## -property-value The PLA thermoplastic used in the base material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterial.Pla +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterial.Pla + +## -description +Gets the name the polylactic acid (PLA) thermoplastic used in the base material. + +## -property-value +The PLA thermoplastic used in the base material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerial_printing3dbasematerial_1221375020.md b/windows.graphics.printing3d/printing3dbasematerial_printing3dbasematerial_1221375020.md index 9e41060b0c..e786e53dbf 100644 --- a/windows.graphics.printing3d/printing3dbasematerial_printing3dbasematerial_1221375020.md +++ b/windows.graphics.printing3d/printing3dbasematerial_printing3dbasematerial_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DBaseMaterial.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterial.Printing3DBaseMaterial ## -description Creates an instance of the [Printing3DBaseMaterial](printing3dbasematerial.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DBaseMaterial.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterial.Printing3DBaseMaterial + +## -description +Creates an instance of the [Printing3DBaseMaterial](printing3dbasematerial.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerialgroup.md b/windows.graphics.printing3d/printing3dbasematerialgroup.md index ac2e86cf21..fc0200425f 100644 --- a/windows.graphics.printing3d/printing3dbasematerialgroup.md +++ b/windows.graphics.printing3d/printing3dbasematerialgroup.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup ## -description Represents a group of base materials used in the 3D model. ## -remarks The [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup + +## -description +Represents a group of base materials used in the 3D model. + +## -remarks +The [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerialgroup_bases.md b/windows.graphics.printing3d/printing3dbasematerialgroup_bases.md index 1b882a8268..87a6ca8585 100644 --- a/windows.graphics.printing3d/printing3dbasematerialgroup_bases.md +++ b/windows.graphics.printing3d/printing3dbasematerialgroup_bases.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.Bases --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.Bases ## -description Gets a group of base materials used in the 3D model. ## -property-value The base materials used in the 3D model, of type [Printing3DBaseMaterial](printing3dbasematerial.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.Bases +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.Bases + +## -description +Gets a group of base materials used in the 3D model. + +## -property-value +The base materials used in the 3D model, of type [Printing3DBaseMaterial](printing3dbasematerial.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerialgroup_materialgroupid.md b/windows.graphics.printing3d/printing3dbasematerialgroup_materialgroupid.md index 632c5c597a..3e0c0cb686 100644 --- a/windows.graphics.printing3d/printing3dbasematerialgroup_materialgroupid.md +++ b/windows.graphics.printing3d/printing3dbasematerialgroup_materialgroupid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.MaterialGroupId --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.MaterialGroupId ## -description Gets the identifier (ID) of the base material group. ## -property-value The ID of the base material group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.MaterialGroupId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.MaterialGroupId + +## -description +Gets the identifier (ID) of the base material group. + +## -property-value +The ID of the base material group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dbasematerialgroup_printing3dbasematerialgroup_885572907.md b/windows.graphics.printing3d/printing3dbasematerialgroup_printing3dbasematerialgroup_885572907.md index c0b98a2677..61eae019bd 100644 --- a/windows.graphics.printing3d/printing3dbasematerialgroup_printing3dbasematerialgroup_885572907.md +++ b/windows.graphics.printing3d/printing3dbasematerialgroup_printing3dbasematerialgroup_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.Printing3DBaseMaterialGroup ## -description Creates an instance of the [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) class. ## -parameters ### -param MaterialGroupId The identifier for the group of base materials used in the 3D model; a value greater than zero. ## -remarks Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DBaseMaterialGroup.Printing3DBaseMaterialGroup + +## -description +Creates an instance of the [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) class. + +## -parameters +### -param MaterialGroupId +The identifier for the group of base materials used in the 3D model; a value greater than zero. + +## -remarks +Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterial.md b/windows.graphics.printing3d/printing3dcolormaterial.md index 530f426507..46258efd30 100644 --- a/windows.graphics.printing3d/printing3dcolormaterial.md +++ b/windows.graphics.printing3d/printing3dcolormaterial.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DColorMaterial --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DColorMaterial ## -description Represents a color material used in the 3D model. ## -remarks The [Printing3DColorMaterial](printing3dcolormaterial.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DColorMaterial +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterial + +## -description +Represents a color material used in the 3D model. + +## -remarks +The [Printing3DColorMaterial](printing3dcolormaterial.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterial_color.md b/windows.graphics.printing3d/printing3dcolormaterial_color.md index 7a14a2a6b1..e32f612990 100644 --- a/windows.graphics.printing3d/printing3dcolormaterial_color.md +++ b/windows.graphics.printing3d/printing3dcolormaterial_color.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterial.Color --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DColorMaterial.Color ## -description Gets or sets the color of the material. ## -property-value The color of the material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterial.Color +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterial.Color + +## -description +Gets or sets the color of the material. + +## -property-value +The color of the material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterial_printing3dcolormaterial_1221375020.md b/windows.graphics.printing3d/printing3dcolormaterial_printing3dcolormaterial_1221375020.md index 490a7450b1..2dd3f9a00b 100644 --- a/windows.graphics.printing3d/printing3dcolormaterial_printing3dcolormaterial_1221375020.md +++ b/windows.graphics.printing3d/printing3dcolormaterial_printing3dcolormaterial_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DColorMaterial.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DColorMaterial.Printing3DColorMaterial ## -description Creates an instance of the [Printing3DColorMaterial](printing3dcolormaterial.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DColorMaterial.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterial.Printing3DColorMaterial + +## -description +Creates an instance of the [Printing3DColorMaterial](printing3dcolormaterial.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterial_value.md b/windows.graphics.printing3d/printing3dcolormaterial_value.md index 357ba0b7d6..7c929007b8 100644 --- a/windows.graphics.printing3d/printing3dcolormaterial_value.md +++ b/windows.graphics.printing3d/printing3dcolormaterial_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterial.Value --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DColorMaterial.Value ## -description Gets or sets the color value of the material. ## -property-value The color value of the material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterial.Value +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterial.Value + +## -description +Gets or sets the color value of the material. + +## -property-value +The color value of the material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterialgroup.md b/windows.graphics.printing3d/printing3dcolormaterialgroup.md index f986899b92..d12cd89c98 100644 --- a/windows.graphics.printing3d/printing3dcolormaterialgroup.md +++ b/windows.graphics.printing3d/printing3dcolormaterialgroup.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DColorMaterialGroup ## -description Represents a group of color materials used in the 3D model. ## -remarks The [Printing3DColorMaterialGroup](printing3dcolormaterialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterialGroup + +## -description +Represents a group of color materials used in the 3D model. + +## -remarks +The [Printing3DColorMaterialGroup](printing3dcolormaterialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterialgroup_colors.md b/windows.graphics.printing3d/printing3dcolormaterialgroup_colors.md index 8990b9df7f..a8026c7069 100644 --- a/windows.graphics.printing3d/printing3dcolormaterialgroup_colors.md +++ b/windows.graphics.printing3d/printing3dcolormaterialgroup_colors.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.Colors --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.Colors ## -description Gets a group of color materials used in the 3D model. ## -property-value A group of color materials used in the 3D model, of type [Printing3DColorMaterial](printing3dcolormaterial.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.Colors +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.Colors + +## -description +Gets a group of color materials used in the 3D model. + +## -property-value +A group of color materials used in the 3D model, of type [Printing3DColorMaterial](printing3dcolormaterial.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterialgroup_materialgroupid.md b/windows.graphics.printing3d/printing3dcolormaterialgroup_materialgroupid.md index 2a58831688..a8bb21a836 100644 --- a/windows.graphics.printing3d/printing3dcolormaterialgroup_materialgroupid.md +++ b/windows.graphics.printing3d/printing3dcolormaterialgroup_materialgroupid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.MaterialGroupId --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.MaterialGroupId ## -description Gets the identifier (ID) for the color material group. ## -property-value The ID for the color material group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.MaterialGroupId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.MaterialGroupId + +## -description +Gets the identifier (ID) for the color material group. + +## -property-value +The ID for the color material group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcolormaterialgroup_printing3dcolormaterialgroup_885572907.md b/windows.graphics.printing3d/printing3dcolormaterialgroup_printing3dcolormaterialgroup_885572907.md index af5c0dc4e4..a0aaaff758 100644 --- a/windows.graphics.printing3d/printing3dcolormaterialgroup_printing3dcolormaterialgroup_885572907.md +++ b/windows.graphics.printing3d/printing3dcolormaterialgroup_printing3dcolormaterialgroup_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.Printing3DColorMaterialGroup ## -description Creates an instance of the [Printing3DColorMaterialGroup](printing3dcolormaterialgroup.md) class. ## -parameters ### -param MaterialGroupId The identifier for the group of color materials used in the 3D model; a value greater than zero. ## -remarks Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DColorMaterialGroup.Printing3DColorMaterialGroup + +## -description +Creates an instance of the [Printing3DColorMaterialGroup](printing3dcolormaterialgroup.md) class. + +## -parameters +### -param MaterialGroupId +The identifier for the group of color materials used in the 3D model; a value greater than zero. + +## -remarks +Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent.md b/windows.graphics.printing3d/printing3dcomponent.md index 169df82996..49c6c5aee3 100644 --- a/windows.graphics.printing3d/printing3dcomponent.md +++ b/windows.graphics.printing3d/printing3dcomponent.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DComponent --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DComponent ## -description Represents a 3D Manufacturing Format (3MF) component. Acts as a container of other components. ## -remarks A component is a translation applied to an underlying mesh or arrangement of translations on a set of other components. The [Printing3DComponent](printing3dcomponent.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DComponent +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent + +## -description +Represents a 3D Manufacturing Format (3MF) component. Acts as a container of other components. + +## -remarks +A component is a translation applied to an underlying mesh or arrangement of translations on a set of other components. + +The [Printing3DComponent](printing3dcomponent.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_components.md b/windows.graphics.printing3d/printing3dcomponent_components.md index 13040c221d..5e6120c26f 100644 --- a/windows.graphics.printing3d/printing3dcomponent_components.md +++ b/windows.graphics.printing3d/printing3dcomponent_components.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Components --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponent.Components ## -description Gets the other components contained within the component. ## -property-value The other components contained within the component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Components +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.Components + +## -description +Gets the other components contained within the component. + +## -property-value +The other components contained within the component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_mesh.md b/windows.graphics.printing3d/printing3dcomponent_mesh.md index 8f64c772eb..121b21917f 100644 --- a/windows.graphics.printing3d/printing3dcomponent_mesh.md +++ b/windows.graphics.printing3d/printing3dcomponent_mesh.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Mesh --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponent.Mesh ## -description Gets or sets the 3D mesh of the component. ## -property-value The 3D mesh of the component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Mesh +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.Mesh + +## -description +Gets or sets the 3D mesh of the component. + +## -property-value +The 3D mesh of the component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_name.md b/windows.graphics.printing3d/printing3dcomponent_name.md index a6d415e494..510fe45ba1 100644 --- a/windows.graphics.printing3d/printing3dcomponent_name.md +++ b/windows.graphics.printing3d/printing3dcomponent_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Name --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponent.Name ## -description Gets or sets the name of the 3D Manufacturing Format (3MF) component. ## -property-value The name of the 3MF component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Name +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.Name + +## -description +Gets or sets the name of the 3D Manufacturing Format (3MF) component. + +## -property-value +The name of the 3MF component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_partnumber.md b/windows.graphics.printing3d/printing3dcomponent_partnumber.md index 4c61fed218..21375467ab 100644 --- a/windows.graphics.printing3d/printing3dcomponent_partnumber.md +++ b/windows.graphics.printing3d/printing3dcomponent_partnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.PartNumber --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponent.PartNumber ## -description Gets or sets the part number of the 3D Manufacturing Format (3MF) component. ## -property-value The part number of the 3MF component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.PartNumber +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.PartNumber + +## -description +Gets or sets the part number of the 3D Manufacturing Format (3MF) component. + +## -property-value +The part number of the 3MF component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_printing3dcomponent_1221375020.md b/windows.graphics.printing3d/printing3dcomponent_printing3dcomponent_1221375020.md index 9fe65a5865..80a371ae83 100644 --- a/windows.graphics.printing3d/printing3dcomponent_printing3dcomponent_1221375020.md +++ b/windows.graphics.printing3d/printing3dcomponent_printing3dcomponent_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DComponent.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DComponent.Printing3DComponent ## -description Creates an instance of the [Printing3DComponent](printing3dcomponent.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DComponent.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.Printing3DComponent + +## -description +Creates an instance of the [Printing3DComponent](printing3dcomponent.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_thumbnail.md b/windows.graphics.printing3d/printing3dcomponent_thumbnail.md index b4b9f7f02e..ad9dde8ce7 100644 --- a/windows.graphics.printing3d/printing3dcomponent_thumbnail.md +++ b/windows.graphics.printing3d/printing3dcomponent_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Thumbnail --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponent.Thumbnail ## -description Gets or sets the thumbnail image of the 3D Manufacturing Format (3MF) component. ## -property-value The thumbnail image of the 3MF component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.Thumbnail + +## -description +Gets or sets the thumbnail image of the 3D Manufacturing Format (3MF) component. + +## -property-value +The thumbnail image of the 3MF component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponent_type.md b/windows.graphics.printing3d/printing3dcomponent_type.md index 224eb78655..c573809058 100644 --- a/windows.graphics.printing3d/printing3dcomponent_type.md +++ b/windows.graphics.printing3d/printing3dcomponent_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Type --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponent.Type ## -description Gets or sets the type of the 3D Manufacturing Format (3MF) component. ## -property-value The type of the 3MF component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponent.Type +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponent.Type + +## -description +Gets or sets the type of the 3D Manufacturing Format (3MF) component. + +## -property-value +The type of the 3MF component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponentwithmatrix.md b/windows.graphics.printing3d/printing3dcomponentwithmatrix.md index 29b366bfa5..90a82ea889 100644 --- a/windows.graphics.printing3d/printing3dcomponentwithmatrix.md +++ b/windows.graphics.printing3d/printing3dcomponentwithmatrix.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DComponentWithMatrix ## -description Represents a 3D Manufacturing Format (3MF) component that's applied to the object definition with a matrix transform. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponentWithMatrix + +## -description +Represents a 3D Manufacturing Format (3MF) component that's applied to the object definition with a matrix transform. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponentwithmatrix_component.md b/windows.graphics.printing3d/printing3dcomponentwithmatrix_component.md index 3552c43fa9..c1e7dfbc5f 100644 --- a/windows.graphics.printing3d/printing3dcomponentwithmatrix_component.md +++ b/windows.graphics.printing3d/printing3dcomponentwithmatrix_component.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Component --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Component ## -description Gets or sets the 3D Manufacturing Format (3MF) primitive component that's applied to the object definition with a matrix transform. ## -property-value The 3MF primitive component that's applied to the object definition with a matrix transform. ## -remarks The [Printing3DComponent](printing3dcomponent.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Component +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Component + +## -description +Gets or sets the 3D Manufacturing Format (3MF) primitive component that's applied to the object definition with a matrix transform. + +## -property-value +The 3MF primitive component that's applied to the object definition with a matrix transform. + +## -remarks +The [Printing3DComponent](printing3dcomponent.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponentwithmatrix_matrix.md b/windows.graphics.printing3d/printing3dcomponentwithmatrix_matrix.md index 54fd7fd63a..3b3455a2a3 100644 --- a/windows.graphics.printing3d/printing3dcomponentwithmatrix_matrix.md +++ b/windows.graphics.printing3d/printing3dcomponentwithmatrix_matrix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Matrix --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Matrix ## -description Gets or sets the matrix transform that's applied to the 3D Manufacturing Format (3MF) primitive component. ## -property-value The matrix transform that's applied to the 3D Manufacturing Format (3MF) primitive component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Matrix +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Matrix + +## -description +Gets or sets the matrix transform that's applied to the 3D Manufacturing Format (3MF) primitive component. + +## -property-value +The matrix transform that's applied to the 3D Manufacturing Format (3MF) primitive component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcomponentwithmatrix_printing3dcomponentwithmatrix_1221375020.md b/windows.graphics.printing3d/printing3dcomponentwithmatrix_printing3dcomponentwithmatrix_1221375020.md index 3440b15764..332596cccc 100644 --- a/windows.graphics.printing3d/printing3dcomponentwithmatrix_printing3dcomponentwithmatrix_1221375020.md +++ b/windows.graphics.printing3d/printing3dcomponentwithmatrix_printing3dcomponentwithmatrix_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Printing3DComponentWithMatrix ## -description Creates an instance of the [Printing3DComponentWithMatrix](printing3dcomponentwithmatrix.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DComponentWithMatrix.Printing3DComponentWithMatrix + +## -description +Creates an instance of the [Printing3DComponentWithMatrix](printing3dcomponentwithmatrix.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerial.md b/windows.graphics.printing3d/printing3dcompositematerial.md index 0ff75adff1..59209ccfd3 100644 --- a/windows.graphics.printing3d/printing3dcompositematerial.md +++ b/windows.graphics.printing3d/printing3dcompositematerial.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DCompositeMaterial --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterial ## -description Represents a composite material that's defined by a mixture of base materials. ## -remarks Each composite material is defined by a mixture of base materials that are listed in the specified base material group ([MaterialGroupId](printing3dcompositematerialgroup_materialgroupid.md)). The index values of possible base materials from that material group are specified in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1). The mixtures of base materials are specified in [Composites](printing3dcompositematerialgroup_composites.md), where the proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). This class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DCompositeMaterial +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterial + +## -description +Represents a composite material that's defined by a mixture of base materials. + +## -remarks +Each composite material is defined by a mixture of base materials that are listed in the specified base material group ([MaterialGroupId](printing3dcompositematerialgroup_materialgroupid.md)). The index values of possible base materials from that material group are specified in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1). The mixtures of base materials are specified in [Composites](printing3dcompositematerialgroup_composites.md), where the proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). + +This class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerial_printing3dcompositematerial_1221375020.md b/windows.graphics.printing3d/printing3dcompositematerial_printing3dcompositematerial_1221375020.md index 2bd4f0bc06..4f800fe3ea 100644 --- a/windows.graphics.printing3d/printing3dcompositematerial_printing3dcompositematerial_1221375020.md +++ b/windows.graphics.printing3d/printing3dcompositematerial_printing3dcompositematerial_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DCompositeMaterial.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterial.Printing3DCompositeMaterial ## -description Creates an instance of the [Printing3DCompositeMaterial](printing3dcompositematerial.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DCompositeMaterial.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterial.Printing3DCompositeMaterial + +## -description +Creates an instance of the [Printing3DCompositeMaterial](printing3dcompositematerial.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerial_values.md b/windows.graphics.printing3d/printing3dcompositematerial_values.md index af102e45da..c5af19f00c 100644 --- a/windows.graphics.printing3d/printing3dcompositematerial_values.md +++ b/windows.graphics.printing3d/printing3dcompositematerial_values.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterial.Values --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterial.Values ## -description Gets the mixture of base materials used in the composite material. Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1). ## -property-value The proportions of base materials used in the composite material (values between 0 and 1). Proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterial.Values +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterial.Values + +## -description +Gets the mixture of base materials used in the composite material. Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1). + +## -property-value +The proportions of base materials used in the composite material (values between 0 and 1). Proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerialgroup.md b/windows.graphics.printing3d/printing3dcompositematerialgroup.md index 0c28cb9736..c025f2f1e1 100644 --- a/windows.graphics.printing3d/printing3dcompositematerialgroup.md +++ b/windows.graphics.printing3d/printing3dcompositematerialgroup.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup ## -description Represents a group of composite materials. ## -remarks Each composite material is defined by a mixture of base materials that are listed in the specified base material group ([MaterialGroupId](printing3dcompositematerialgroup_materialgroupid.md)). The index values of possible base materials from that material group are specified in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1). The mixtures of base materials are specified in [Composites](printing3dcompositematerialgroup_composites.md), where the proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). This class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup + +## -description +Represents a group of composite materials. + +## -remarks +Each composite material is defined by a mixture of base materials that are listed in the specified base material group ([MaterialGroupId](printing3dcompositematerialgroup_materialgroupid.md)). The index values of possible base materials from that material group are specified in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1). The mixtures of base materials are specified in [Composites](printing3dcompositematerialgroup_composites.md), where the proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). + +This class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerialgroup_basematerialgroup.md b/windows.graphics.printing3d/printing3dcompositematerialgroup_basematerialgroup.md index fd622ce7c4..860af52ee9 100644 --- a/windows.graphics.printing3d/printing3dcompositematerialgroup_basematerialgroup.md +++ b/windows.graphics.printing3d/printing3dcompositematerialgroup_basematerialgroup.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.BaseMaterialGroup --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.BaseMaterialGroup ## -description Gets the existing [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) whose [Printing3DBaseMaterial](printing3dbasematerial.md) members will be used to produce composite materials. ## -property-value The [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) from which to produce composite materials. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.BaseMaterialGroup +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.BaseMaterialGroup + +## -description +Gets the existing [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) whose [Printing3DBaseMaterial](printing3dbasematerial.md) members will be used to produce composite materials. + +## -property-value +The [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md) from which to produce composite materials. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerialgroup_composites.md b/windows.graphics.printing3d/printing3dcompositematerialgroup_composites.md index e94e522709..13094028ea 100644 --- a/windows.graphics.printing3d/printing3dcompositematerialgroup_composites.md +++ b/windows.graphics.printing3d/printing3dcompositematerialgroup_composites.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.Composites --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.Composites ## -description Gets an list of mixtures that define individual composite materials. Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1), where the proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). ## -property-value A list of mixtures that define individual composite materials. ## -remarks ## -examples ## -see-also [MaterialIndices](printing3dcompositematerialgroup_materialindices.md) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.Composites +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.Composites + +## -description +Gets an list of mixtures that define individual composite materials. Each mixture is defined by listing the proportion of the overall mixture for each base material (values between 0 and 1), where the proportion values are specified in the same order as the base materials in [MaterialIndices](printing3dcompositematerialgroup_materialindices.md). + +## -property-value +A list of mixtures that define individual composite materials. + +## -remarks + +## -examples + +## -see-also +[MaterialIndices](printing3dcompositematerialgroup_materialindices.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dcompositematerialgroup_materialgroupid.md b/windows.graphics.printing3d/printing3dcompositematerialgroup_materialgroupid.md index 765cbe51a4..a051ebac24 100644 --- a/windows.graphics.printing3d/printing3dcompositematerialgroup_materialgroupid.md +++ b/windows.graphics.printing3d/printing3dcompositematerialgroup_materialgroupid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialGroupId --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialGroupId ## -description Gets the identifier (ID) of the base material group that defines the materials used in the composite material group. ## -property-value The ID of the base material group that defines the materials used in the composite material group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialGroupId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialGroupId + +## -description +Gets the identifier (ID) of the base material group that defines the materials used in the composite material group. + +## -property-value +The ID of the base material group that defines the materials used in the composite material group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dcompositematerialgroup_materialindices.md b/windows.graphics.printing3d/printing3dcompositematerialgroup_materialindices.md index 22551fc071..3c12aa091d 100644 --- a/windows.graphics.printing3d/printing3dcompositematerialgroup_materialindices.md +++ b/windows.graphics.printing3d/printing3dcompositematerialgroup_materialindices.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialIndices --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialIndices ## -description Gets an ordered list of base materials that are used to make the composite materials in the group. The order of base materials is maintained in the mixture values defined by [Composites](printing3dcompositematerialgroup_composites.md). ## -property-value Index values of base materials from the base material group specified by [MaterialGroupId](printing3dcompositematerialgroup_materialgroupid.md). ## -remarks ## -examples ## -see-also [Composites](printing3dcompositematerialgroup_composites.md) \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialIndices +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.MaterialIndices + +## -description +Gets an ordered list of base materials that are used to make the composite materials in the group. The order of base materials is maintained in the mixture values defined by [Composites](printing3dcompositematerialgroup_composites.md). + +## -property-value +Index values of base materials from the base material group specified by [MaterialGroupId](printing3dcompositematerialgroup_materialgroupid.md). + +## -remarks + +## -examples + +## -see-also +[Composites](printing3dcompositematerialgroup_composites.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dcompositematerialgroup_printing3dcompositematerialgroup_885572907.md b/windows.graphics.printing3d/printing3dcompositematerialgroup_printing3dcompositematerialgroup_885572907.md index 6ada3d1a2a..d952d6ebd2 100644 --- a/windows.graphics.printing3d/printing3dcompositematerialgroup_printing3dcompositematerialgroup_885572907.md +++ b/windows.graphics.printing3d/printing3dcompositematerialgroup_printing3dcompositematerialgroup_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.Printing3DCompositeMaterialGroup ## -description Creates an instance of the [Printing3DCompositeMaterialGroup](printing3dcompositematerialgroup.md) class. ## -parameters ### -param MaterialGroupId The identifier (ID) of the composite material group; a value greater than zero. ## -remarks Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DCompositeMaterialGroup.Printing3DCompositeMaterialGroup + +## -description +Creates an instance of the [Printing3DCompositeMaterialGroup](printing3dcompositematerialgroup.md) class. + +## -parameters +### -param MaterialGroupId +The identifier (ID) of the composite material group; a value greater than zero. + +## -remarks +Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dfacereductionoptions.md b/windows.graphics.printing3d/printing3dfacereductionoptions.md index 3eb341357a..34a1787745 100644 --- a/windows.graphics.printing3d/printing3dfacereductionoptions.md +++ b/windows.graphics.printing3d/printing3dfacereductionoptions.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DFaceReductionOptions ## -description Provides additional information for the [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method in the [Printing3DModel](printing3dmodel.md) class ## -remarks This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DFaceReductionOptions + +## -description +Provides additional information for the [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method in the [Printing3DModel](printing3dmodel.md) class + +## -remarks +This API is designed for use with 3D Manufacturing Format (3MF) packages. For more info about 3MF, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dfacereductionoptions_maxedgelength.md b/windows.graphics.printing3d/printing3dfacereductionoptions_maxedgelength.md index 2561017e08..cda00d3ad0 100644 --- a/windows.graphics.printing3d/printing3dfacereductionoptions_maxedgelength.md +++ b/windows.graphics.printing3d/printing3dfacereductionoptions_maxedgelength.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxEdgeLength --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxEdgeLength ## -description Sets the maximum length of an edge for which the triangles that share said edge can be merged via the [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method. If set to zero, a built-in default value is used. ## -property-value Maximum length of an edge for which the triangles that share said edge can be merged. ## -remarks The units of length are derived from the [Unit](printing3dmodel_unit.md) property in the [Printing3DModel](printing3dmodel.md) object from which [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) is called. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxEdgeLength +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxEdgeLength + +## -description +Sets the maximum length of an edge for which the triangles that share said edge can be merged via the [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method. If set to zero, a built-in default value is used. + +## -property-value +Maximum length of an edge for which the triangles that share said edge can be merged. + +## -remarks +The units of length are derived from the [Unit](printing3dmodel_unit.md) property in the [Printing3DModel](printing3dmodel.md) object from which [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) is called. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dfacereductionoptions_maxreductionarea.md b/windows.graphics.printing3d/printing3dfacereductionoptions_maxreductionarea.md index 424887d3b9..6a11c8380b 100644 --- a/windows.graphics.printing3d/printing3dfacereductionoptions_maxreductionarea.md +++ b/windows.graphics.printing3d/printing3dfacereductionoptions_maxreductionarea.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxReductionArea --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxReductionArea ## -description Sets the area of a triangle above which said triangle cannot be merged via the [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method. If set to zero, a built-in default value is used. ## -property-value Maximum area at which a triangle can be merged. ## -remarks The units of area are derived from the [Unit](printing3dmodel_unit.md) property in the [Printing3DModel](printing3dmodel.md) object from which [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync_2097932692.md) is called. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxReductionArea +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.MaxReductionArea + +## -description +Sets the area of a triangle above which said triangle cannot be merged via the [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method. If set to zero, a built-in default value is used. + +## -property-value +Maximum area at which a triangle can be merged. + +## -remarks +The units of area are derived from the [Unit](printing3dmodel_unit.md) property in the [Printing3DModel](printing3dmodel.md) object from which [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync_2097932692.md) is called. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dfacereductionoptions_printing3dfacereductionoptions_1221375020.md b/windows.graphics.printing3d/printing3dfacereductionoptions_printing3dfacereductionoptions_1221375020.md index b880ef9c45..e8fc79485a 100644 --- a/windows.graphics.printing3d/printing3dfacereductionoptions_printing3dfacereductionoptions_1221375020.md +++ b/windows.graphics.printing3d/printing3dfacereductionoptions_printing3dfacereductionoptions_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.Printing3DFaceReductionOptions ## -description Creates an instance of the [Printing3DFaceReductionOptions](printing3dfacereductionoptions.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.Printing3DFaceReductionOptions + +## -description +Creates an instance of the [Printing3DFaceReductionOptions](printing3dfacereductionoptions.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dfacereductionoptions_targettrianglecount.md b/windows.graphics.printing3d/printing3dfacereductionoptions_targettrianglecount.md index de001eeaaf..5cdacb4acc 100644 --- a/windows.graphics.printing3d/printing3dfacereductionoptions_targettrianglecount.md +++ b/windows.graphics.printing3d/printing3dfacereductionoptions_targettrianglecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.TargetTriangleCount --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.TargetTriangleCount ## -description Sets the desired number of triangles on a mesh. The [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method will stop merging faces if the triangle count is less than or equal to this number. If set to zero, the algorithm will run until the number of triangles is reduced by half. ## -property-value Desired number of triangles on a mesh. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.TargetTriangleCount +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DFaceReductionOptions.TargetTriangleCount + +## -description +Sets the desired number of triangles on a mesh. The [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync.md) method will stop merging faces if the triangle count is less than or equal to this number. If set to zero, the algorithm will run until the number of triangles is reduced by half. + +## -property-value +Desired number of triangles on a mesh. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial.md b/windows.graphics.printing3d/printing3dmaterial.md index 82a2e87693..3f492ee057 100644 --- a/windows.graphics.printing3d/printing3dmaterial.md +++ b/windows.graphics.printing3d/printing3dmaterial.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DMaterial --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DMaterial ## -description Represents all material resources in the 3D model. ## -remarks The [Printing3DMaterial](printing3dmaterial.md) class roughly corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DMaterial +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial + +## -description +Represents all material resources in the 3D model. + +## -remarks +The [Printing3DMaterial](printing3dmaterial.md) class roughly corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial_basegroups.md b/windows.graphics.printing3d/printing3dmaterial_basegroups.md index 93b089fe0f..1cf4ea361d 100644 --- a/windows.graphics.printing3d/printing3dmaterial_basegroups.md +++ b/windows.graphics.printing3d/printing3dmaterial_basegroups.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.BaseGroups --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMaterial.BaseGroups ## -description Gets all base material groups used in the 3D model. ## -property-value All base material groups used in the 3D model, of type [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.BaseGroups +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial.BaseGroups + +## -description +Gets all base material groups used in the 3D model. + +## -property-value +All base material groups used in the 3D model, of type [Printing3DBaseMaterialGroup](printing3dbasematerialgroup.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial_colorgroups.md b/windows.graphics.printing3d/printing3dmaterial_colorgroups.md index cf9fdaf87f..280449a6ec 100644 --- a/windows.graphics.printing3d/printing3dmaterial_colorgroups.md +++ b/windows.graphics.printing3d/printing3dmaterial_colorgroups.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.ColorGroups --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMaterial.ColorGroups ## -description Gets all color material groups used in the 3D model. ## -property-value All color material groups used in the 3D model, of type [Printing3DColorMaterialGroup](printing3dcolormaterialgroup.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.ColorGroups +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial.ColorGroups + +## -description +Gets all color material groups used in the 3D model. + +## -property-value +All color material groups used in the 3D model, of type [Printing3DColorMaterialGroup](printing3dcolormaterialgroup.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial_compositegroups.md b/windows.graphics.printing3d/printing3dmaterial_compositegroups.md index d36cc284b8..13dc900922 100644 --- a/windows.graphics.printing3d/printing3dmaterial_compositegroups.md +++ b/windows.graphics.printing3d/printing3dmaterial_compositegroups.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.CompositeGroups --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMaterial.CompositeGroups ## -description Gets all composite material groups used in the 3D model. ## -property-value All composite material groups used in the 3D model, of type [Printing3DCompositeMaterialGroup](printing3dcompositematerialgroup.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.CompositeGroups +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial.CompositeGroups + +## -description +Gets all composite material groups used in the 3D model. + +## -property-value +All composite material groups used in the 3D model, of type [Printing3DCompositeMaterialGroup](printing3dcompositematerialgroup.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial_multiplepropertygroups.md b/windows.graphics.printing3d/printing3dmaterial_multiplepropertygroups.md index 755d9b5458..2d3eea3d25 100644 --- a/windows.graphics.printing3d/printing3dmaterial_multiplepropertygroups.md +++ b/windows.graphics.printing3d/printing3dmaterial_multiplepropertygroups.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.MultiplePropertyGroups --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMaterial.MultiplePropertyGroups ## -description Gets all multi-property groups used in the 3D model. ## -property-value All multi-property groups used in the 3D model, of type [Printing3DMultiplePropertyMaterialGroup](printing3dmultiplepropertymaterialgroup.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.MultiplePropertyGroups +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial.MultiplePropertyGroups + +## -description +Gets all multi-property groups used in the 3D model. + +## -property-value +All multi-property groups used in the 3D model, of type [Printing3DMultiplePropertyMaterialGroup](printing3dmultiplepropertymaterialgroup.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial_printing3dmaterial_1221375020.md b/windows.graphics.printing3d/printing3dmaterial_printing3dmaterial_1221375020.md index c10a17c1e5..e6325c98f9 100644 --- a/windows.graphics.printing3d/printing3dmaterial_printing3dmaterial_1221375020.md +++ b/windows.graphics.printing3d/printing3dmaterial_printing3dmaterial_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMaterial.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMaterial.Printing3DMaterial ## -description Creates an instance of the [Printing3DMaterial](printing3dmaterial.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMaterial.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial.Printing3DMaterial + +## -description +Creates an instance of the [Printing3DMaterial](printing3dmaterial.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmaterial_texture2coordgroups.md b/windows.graphics.printing3d/printing3dmaterial_texture2coordgroups.md index 30bd81fdb7..c36e0d44c3 100644 --- a/windows.graphics.printing3d/printing3dmaterial_texture2coordgroups.md +++ b/windows.graphics.printing3d/printing3dmaterial_texture2coordgroups.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.Texture2CoordGroups --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMaterial.Texture2CoordGroups ## -description Gets all 2D texture material groups used in the 3D model. ## -property-value All 2D texture material groups used in the 3D model, of type [Printing3DTexture2CoordMaterialGroup](printing3dtexture2coordmaterialgroup.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMaterial.Texture2CoordGroups +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMaterial.Texture2CoordGroups + +## -description +Gets all 2D texture material groups used in the 3D model. + +## -property-value +All 2D texture material groups used in the 3D model, of type [Printing3DTexture2CoordMaterialGroup](printing3dtexture2coordmaterialgroup.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh.md b/windows.graphics.printing3d/printing3dmesh.md index b14845b1cc..59d27e8f9e 100644 --- a/windows.graphics.printing3d/printing3dmesh.md +++ b/windows.graphics.printing3d/printing3dmesh.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DMesh --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DMesh ## -description Represents a mesh in the 3D model. ## -remarks The [Printing3DMesh](printing3dmesh.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DMesh +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh + +## -description +Represents a mesh in the 3D model. + +## -remarks +The [Printing3DMesh](printing3dmesh.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_bufferdescriptionset.md b/windows.graphics.printing3d/printing3dmesh_bufferdescriptionset.md index 3961568089..dc84995596 100644 --- a/windows.graphics.printing3d/printing3dmesh_bufferdescriptionset.md +++ b/windows.graphics.printing3d/printing3dmesh_bufferdescriptionset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.BufferDescriptionSet --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.BufferDescriptionSet ## -description Gets a set of mesh buffer descriptions. ## -property-value A set of mesh buffer descriptions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.BufferDescriptionSet +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.BufferDescriptionSet + +## -description +Gets a set of mesh buffer descriptions. + +## -property-value +A set of mesh buffer descriptions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_bufferset.md b/windows.graphics.printing3d/printing3dmesh_bufferset.md index c8c6116e6e..65c64ade92 100644 --- a/windows.graphics.printing3d/printing3dmesh_bufferset.md +++ b/windows.graphics.printing3d/printing3dmesh_bufferset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.BufferSet --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.BufferSet ## -description Gets a set of mesh buffers. ## -property-value A set of mesh buffers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.BufferSet +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.BufferSet + +## -description +Gets a set of mesh buffers. + +## -property-value +A set of mesh buffers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_createtriangleindices_1991559687.md b/windows.graphics.printing3d/printing3dmesh_createtriangleindices_1991559687.md index 0f8c877c69..9b80501153 100644 --- a/windows.graphics.printing3d/printing3dmesh_createtriangleindices_1991559687.md +++ b/windows.graphics.printing3d/printing3dmesh_createtriangleindices_1991559687.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleIndices(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleIndices ## -description Creates the buffer for triangle indices. ## -parameters ### -param value The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. ## -remarks To access the buffer for triangle indices, use [GetTriangleIndices](printing3dmesh_gettriangleindices.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleIndices(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleIndices + +## -description +Creates the buffer for triangle indices. + +## -parameters +### -param value +The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. + +## -remarks +To access the buffer for triangle indices, use [GetTriangleIndices](printing3dmesh_gettriangleindices.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_createtrianglematerialindices_1629565064.md b/windows.graphics.printing3d/printing3dmesh_createtrianglematerialindices_1629565064.md index 15538f0998..e8fdef4470 100644 --- a/windows.graphics.printing3d/printing3dmesh_createtrianglematerialindices_1629565064.md +++ b/windows.graphics.printing3d/printing3dmesh_createtrianglematerialindices_1629565064.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleMaterialIndices(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleMaterialIndices ## -description Creates the buffer for triangle material indices. ## -parameters ### -param value The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. ## -remarks To access the buffer for triangle material indices, use [GetTriangleMaterialIndices](printing3dmesh_gettrianglematerialindices.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleMaterialIndices(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.CreateTriangleMaterialIndices + +## -description +Creates the buffer for triangle material indices. + +## -parameters +### -param value +The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. + +## -remarks +To access the buffer for triangle material indices, use [GetTriangleMaterialIndices](printing3dmesh_gettrianglematerialindices.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_createvertexnormals_1326037651.md b/windows.graphics.printing3d/printing3dmesh_createvertexnormals_1326037651.md index 64d0a198a9..7d4f7077e8 100644 --- a/windows.graphics.printing3d/printing3dmesh_createvertexnormals_1326037651.md +++ b/windows.graphics.printing3d/printing3dmesh_createvertexnormals_1326037651.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexNormals(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexNormals ## -description Creates the buffer for vertex normals. ## -parameters ### -param value The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. ## -remarks To access the buffer for vertex normals, use [GetVertexNormals](printing3dmesh_getvertexnormals.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexNormals(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexNormals + +## -description +Creates the buffer for vertex normals. + +## -parameters +### -param value +The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. + +## -remarks +To access the buffer for vertex normals, use [GetVertexNormals](printing3dmesh_getvertexnormals.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_createvertexpositions_738967062.md b/windows.graphics.printing3d/printing3dmesh_createvertexpositions_738967062.md index 801204c484..000c7b396d 100644 --- a/windows.graphics.printing3d/printing3dmesh_createvertexpositions_738967062.md +++ b/windows.graphics.printing3d/printing3dmesh_createvertexpositions_738967062.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexPositions(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexPositions ## -description Creates the buffer for vertex positions. ## -parameters ### -param value The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. ## -remarks To access the buffer for vertex positions, use [GetVertexPositions](printing3dmesh_getvertexpositions.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexPositions(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.CreateVertexPositions + +## -description +Creates the buffer for vertex positions. + +## -parameters +### -param value +The capacity of the buffer, the maximum number of bytes that the [IBuffer](../windows.storage.streams/ibuffer.md) can hold. + +## -remarks +To access the buffer for vertex positions, use [GetVertexPositions](printing3dmesh_getvertexpositions.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_gettriangleindices_227173511.md b/windows.graphics.printing3d/printing3dmesh_gettriangleindices_227173511.md index a4cf4c4715..785902f593 100644 --- a/windows.graphics.printing3d/printing3dmesh_gettriangleindices_227173511.md +++ b/windows.graphics.printing3d/printing3dmesh_gettriangleindices_227173511.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleIndices --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleIndices ## -description Gets the buffer for triangle indices. ## -returns The buffer for triangle indices. ## -remarks To create the buffer for triangle indices, use [CreateTriangleIndices](printing3dmesh_createtriangleindices.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleIndices +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleIndices + +## -description +Gets the buffer for triangle indices. + +## -returns +The buffer for triangle indices. + +## -remarks +To create the buffer for triangle indices, use [CreateTriangleIndices](printing3dmesh_createtriangleindices.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_gettrianglematerialindices_378308768.md b/windows.graphics.printing3d/printing3dmesh_gettrianglematerialindices_378308768.md index d99dc10e5f..ce21b044c9 100644 --- a/windows.graphics.printing3d/printing3dmesh_gettrianglematerialindices_378308768.md +++ b/windows.graphics.printing3d/printing3dmesh_gettrianglematerialindices_378308768.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleMaterialIndices --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleMaterialIndices ## -description Gets the buffer for triangle material indices. ## -returns The buffer for triangle material indices. ## -remarks To create the buffer for triangle material indices, use [CreateTriangleMaterialIndices](printing3dmesh_createtrianglematerialindices.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleMaterialIndices +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.GetTriangleMaterialIndices + +## -description +Gets the buffer for triangle material indices. + +## -returns +The buffer for triangle material indices. + +## -remarks +To create the buffer for triangle material indices, use [CreateTriangleMaterialIndices](printing3dmesh_createtrianglematerialindices.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_getvertexnormals_997243037.md b/windows.graphics.printing3d/printing3dmesh_getvertexnormals_997243037.md index 770d1d155f..f5e17abb26 100644 --- a/windows.graphics.printing3d/printing3dmesh_getvertexnormals_997243037.md +++ b/windows.graphics.printing3d/printing3dmesh_getvertexnormals_997243037.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetVertexNormals --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.GetVertexNormals ## -description Gets the buffer for vertex normals. ## -returns The buffer for vertex normals. ## -remarks To create the buffer for vertex normals, use [CreateVertexNormals](printing3dmesh_createvertexnormals.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetVertexNormals +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.GetVertexNormals + +## -description +Gets the buffer for vertex normals. + +## -returns +The buffer for vertex normals. + +## -remarks +To create the buffer for vertex normals, use [CreateVertexNormals](printing3dmesh_createvertexnormals.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_getvertexpositions_2133105161.md b/windows.graphics.printing3d/printing3dmesh_getvertexpositions_2133105161.md index c9371e43e4..71f014cc25 100644 --- a/windows.graphics.printing3d/printing3dmesh_getvertexpositions_2133105161.md +++ b/windows.graphics.printing3d/printing3dmesh_getvertexpositions_2133105161.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetVertexPositions --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.GetVertexPositions ## -description Gets the buffer for vertex positions. ## -returns The buffer for vertex positions. ## -remarks To create the buffer for vertex positions, use [CreateVertexPositions](printing3dmesh_createvertexpositions.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.GetVertexPositions +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.GetVertexPositions + +## -description +Gets the buffer for vertex positions. + +## -returns +The buffer for vertex positions. + +## -remarks +To create the buffer for vertex positions, use [CreateVertexPositions](printing3dmesh_createvertexpositions.md). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_indexcount.md b/windows.graphics.printing3d/printing3dmesh_indexcount.md index 31086d2d9c..3db2c55927 100644 --- a/windows.graphics.printing3d/printing3dmesh_indexcount.md +++ b/windows.graphics.printing3d/printing3dmesh_indexcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.IndexCount --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.IndexCount ## -description Gets or sets the number of triangle indices. ## -property-value The number of triangle indices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.IndexCount +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.IndexCount + +## -description +Gets or sets the number of triangle indices. + +## -property-value +The number of triangle indices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_printing3dmesh_1221375020.md b/windows.graphics.printing3d/printing3dmesh_printing3dmesh_1221375020.md index d4434f5a7c..6bc51982e2 100644 --- a/windows.graphics.printing3d/printing3dmesh_printing3dmesh_1221375020.md +++ b/windows.graphics.printing3d/printing3dmesh_printing3dmesh_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.Printing3DMesh ## -description Creates an instance of the [Printing3DMesh](printing3dmesh.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.Printing3DMesh + +## -description +Creates an instance of the [Printing3DMesh](printing3dmesh.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_triangleindicesdescription.md b/windows.graphics.printing3d/printing3dmesh_triangleindicesdescription.md index d8764f8509..4b248c3931 100644 --- a/windows.graphics.printing3d/printing3dmesh_triangleindicesdescription.md +++ b/windows.graphics.printing3d/printing3dmesh_triangleindicesdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.TriangleIndicesDescription --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.TriangleIndicesDescription ## -description Gets or sets the buffer description for triangle indices. ## -property-value The buffer description for triangle indices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.TriangleIndicesDescription +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.TriangleIndicesDescription + +## -description +Gets or sets the buffer description for triangle indices. + +## -property-value +The buffer description for triangle indices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_trianglematerialindicesdescription.md b/windows.graphics.printing3d/printing3dmesh_trianglematerialindicesdescription.md index ac7c8eeb8b..5660d647a9 100644 --- a/windows.graphics.printing3d/printing3dmesh_trianglematerialindicesdescription.md +++ b/windows.graphics.printing3d/printing3dmesh_trianglematerialindicesdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.TriangleMaterialIndicesDescription --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.TriangleMaterialIndicesDescription ## -description Gets or sets the buffer description for triangle material indices. ## -property-value The buffer description for triangle material indices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.TriangleMaterialIndicesDescription +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.TriangleMaterialIndicesDescription + +## -description +Gets or sets the buffer description for triangle material indices. + +## -property-value +The buffer description for triangle material indices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_verifyasync_784165027.md b/windows.graphics.printing3d/printing3dmesh_verifyasync_784165027.md index fb945f884a..89a5d4de9b 100644 --- a/windows.graphics.printing3d/printing3dmesh_verifyasync_784165027.md +++ b/windows.graphics.printing3d/printing3dmesh_verifyasync_784165027.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.VerifyAsync(Windows.Graphics.Printing3D.Printing3DMeshVerificationMode) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMesh.VerifyAsync ## -description Verifies the mesh has manifold edges and normal triangles. ## -parameters ### -param value Specifies how the mesh is verified. ## -returns The results of the verification, of type [Printing3DMeshVerificationResult](printing3dmeshverificationresult.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMesh.VerifyAsync(Windows.Graphics.Printing3D.Printing3DMeshVerificationMode) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.VerifyAsync + +## -description +Verifies the mesh has manifold edges and normal triangles. + +## -parameters +### -param value +Specifies how the mesh is verified. + +## -returns +The results of the verification, of type [Printing3DMeshVerificationResult](printing3dmeshverificationresult.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_vertexcount.md b/windows.graphics.printing3d/printing3dmesh_vertexcount.md index 6ac89f8e06..daccee590e 100644 --- a/windows.graphics.printing3d/printing3dmesh_vertexcount.md +++ b/windows.graphics.printing3d/printing3dmesh_vertexcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.VertexCount --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.VertexCount ## -description Gets or sets the number of triangle vertices. ## -property-value The number of triangle vertices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.VertexCount +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.VertexCount + +## -description +Gets or sets the number of triangle vertices. + +## -property-value +The number of triangle vertices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_vertexnormalsdescription.md b/windows.graphics.printing3d/printing3dmesh_vertexnormalsdescription.md index 86868d5bc7..6d94ee59f4 100644 --- a/windows.graphics.printing3d/printing3dmesh_vertexnormalsdescription.md +++ b/windows.graphics.printing3d/printing3dmesh_vertexnormalsdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.VertexNormalsDescription --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.VertexNormalsDescription ## -description Gets or sets the buffer description for vertex normals. ## -property-value The buffer description for vertex normals. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.VertexNormalsDescription +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.VertexNormalsDescription + +## -description +Gets or sets the buffer description for vertex normals. + +## -property-value +The buffer description for vertex normals. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmesh_vertexpositionsdescription.md b/windows.graphics.printing3d/printing3dmesh_vertexpositionsdescription.md index cabbf849aa..8db8533b19 100644 --- a/windows.graphics.printing3d/printing3dmesh_vertexpositionsdescription.md +++ b/windows.graphics.printing3d/printing3dmesh_vertexpositionsdescription.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.VertexPositionsDescription --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMesh.VertexPositionsDescription ## -description Gets or sets the buffer description for vertex positions. ## -property-value The buffer description for vertex positions. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMesh.VertexPositionsDescription +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMesh.VertexPositionsDescription + +## -description +Gets or sets the buffer description for vertex positions. + +## -property-value +The buffer description for vertex positions. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmeshverificationresult.md b/windows.graphics.printing3d/printing3dmeshverificationresult.md index 473278ff78..a46cef811a 100644 --- a/windows.graphics.printing3d/printing3dmeshverificationresult.md +++ b/windows.graphics.printing3d/printing3dmeshverificationresult.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DMeshVerificationResult ## -description Provides data for the [VerifyAsync](printing3dmesh_verifyasync.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DMeshVerificationResult + +## -description +Provides data for the [VerifyAsync](printing3dmesh_verifyasync.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmeshverificationresult_isvalid.md b/windows.graphics.printing3d/printing3dmeshverificationresult_isvalid.md index b262181be4..85bb225bce 100644 --- a/windows.graphics.printing3d/printing3dmeshverificationresult_isvalid.md +++ b/windows.graphics.printing3d/printing3dmeshverificationresult_isvalid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.IsValid --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.IsValid ## -description Gets a value that indicates if the mesh is valid. ## -property-value **true** if the mesh is valid; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.IsValid +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.IsValid + +## -description +Gets a value that indicates if the mesh is valid. + +## -property-value +**true** if the mesh is valid; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmeshverificationresult_nonmanifoldtriangles.md b/windows.graphics.printing3d/printing3dmeshverificationresult_nonmanifoldtriangles.md index f4f3f659b3..f08ed49137 100644 --- a/windows.graphics.printing3d/printing3dmeshverificationresult_nonmanifoldtriangles.md +++ b/windows.graphics.printing3d/printing3dmeshverificationresult_nonmanifoldtriangles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.NonmanifoldTriangles --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.NonmanifoldTriangles ## -description Gets the triangles with non-manifold edges, if applicable. ## -property-value The triangles with non-manifold edges. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.NonmanifoldTriangles +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.NonmanifoldTriangles + +## -description +Gets the triangles with non-manifold edges, if applicable. + +## -property-value +The triangles with non-manifold edges. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmeshverificationresult_reversednormaltriangles.md b/windows.graphics.printing3d/printing3dmeshverificationresult_reversednormaltriangles.md index 604d1a8f40..d516626e81 100644 --- a/windows.graphics.printing3d/printing3dmeshverificationresult_reversednormaltriangles.md +++ b/windows.graphics.printing3d/printing3dmeshverificationresult_reversednormaltriangles.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.ReversedNormalTriangles --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.ReversedNormalTriangles ## -description Gets the reverse normal triangles, if applicable. ## -property-value The reverse normal triangles. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.ReversedNormalTriangles +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMeshVerificationResult.ReversedNormalTriangles + +## -description +Gets the reverse normal triangles, if applicable. + +## -property-value +The reverse normal triangles. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel.md b/windows.graphics.printing3d/printing3dmodel.md index 6d8c3e49aa..4747e8ad29 100644 --- a/windows.graphics.printing3d/printing3dmodel.md +++ b/windows.graphics.printing3d/printing3dmodel.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DModel --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DModel ## -description Represents the 3D model in a 3D Manufacturing Format (3MF) package. ## -remarks The [Printing3DModel](printing3dmodel.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DModel +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel + +## -description +Represents the 3D model in a 3D Manufacturing Format (3MF) package. + +## -remarks +The [Printing3DModel](printing3dmodel.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_build.md b/windows.graphics.printing3d/printing3dmodel_build.md index b0e1fa5d45..77bb9b267f 100644 --- a/windows.graphics.printing3d/printing3dmodel_build.md +++ b/windows.graphics.printing3d/printing3dmodel_build.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Build --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Build ## -description Gets or sets the root 3D Manufacturing Format (3MF) component. It represents the build plate on a 3D printer and defines what will be printed. ## -property-value The root 3MF component. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Build +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Build + +## -description +Gets or sets the root 3D Manufacturing Format (3MF) component. It represents the build plate on a 3D printer and defines what will be printed. + +## -property-value +The root 3MF component. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_clone_766852569.md b/windows.graphics.printing3d/printing3dmodel_clone_766852569.md index ae52350401..f8328d6d98 100644 --- a/windows.graphics.printing3d/printing3dmodel_clone_766852569.md +++ b/windows.graphics.printing3d/printing3dmodel_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.Clone --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.Clone ## -description Gets a copy of the current 3D model. ## -returns A copy of the current 3D model. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.Clone +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Clone + +## -description +Gets a copy of the current 3D model. + +## -returns +A copy of the current 3D model. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_components.md b/windows.graphics.printing3d/printing3dmodel_components.md index 04f099df99..d72b28f0ff 100644 --- a/windows.graphics.printing3d/printing3dmodel_components.md +++ b/windows.graphics.printing3d/printing3dmodel_components.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Components --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Components ## -description Gets all 3D Manufacturing Format (3MF) components used in the 3D model. ## -property-value All 3MF components used in the 3D model, of type [Printing3DComponent](printing3dcomponent.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Components +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Components + +## -description +Gets all 3D Manufacturing Format (3MF) components used in the 3D model. + +## -property-value +All 3MF components used in the 3D model, of type [Printing3DComponent](printing3dcomponent.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_material.md b/windows.graphics.printing3d/printing3dmodel_material.md index f8c334f49e..3eb58f182c 100644 --- a/windows.graphics.printing3d/printing3dmodel_material.md +++ b/windows.graphics.printing3d/printing3dmodel_material.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Material --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Material ## -description Gets or sets the root material container for the 3D model. ## -property-value The root material container for the 3D model. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Material +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Material + +## -description +Gets or sets the root material container for the 3D model. + +## -property-value +The root material container for the 3D model. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_meshes.md b/windows.graphics.printing3d/printing3dmodel_meshes.md index 335d2e8d03..63139945a3 100644 --- a/windows.graphics.printing3d/printing3dmodel_meshes.md +++ b/windows.graphics.printing3d/printing3dmodel_meshes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Meshes --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Meshes ## -description Gets all meshes used in the 3D model. ## -property-value All meshes used in the 3D model, of type [Printing3DMesh](printing3dmesh.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Meshes +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Meshes + +## -description +Gets all meshes used in the 3D model. + +## -property-value +All meshes used in the 3D model, of type [Printing3DMesh](printing3dmesh.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_metadata.md b/windows.graphics.printing3d/printing3dmodel_metadata.md index 9b29e4dd27..5e1255b312 100644 --- a/windows.graphics.printing3d/printing3dmodel_metadata.md +++ b/windows.graphics.printing3d/printing3dmodel_metadata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Metadata --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Metadata ## -description Gets the metadata for the 3D Manufacturing Format (3MF) package. ## -property-value The metadata for the 3MF package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Metadata +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Metadata + +## -description +Gets the metadata for the 3D Manufacturing Format (3MF) package. + +## -property-value +The metadata for the 3MF package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_printing3dmodel_1221375020.md b/windows.graphics.printing3d/printing3dmodel_printing3dmodel_1221375020.md index b45cf1863c..b893c87921 100644 --- a/windows.graphics.printing3d/printing3dmodel_printing3dmodel_1221375020.md +++ b/windows.graphics.printing3d/printing3dmodel_printing3dmodel_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.Printing3DModel ## -description Creates an instance of the [Printing3DModel](printing3dmodel.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Printing3DModel + +## -description +Creates an instance of the [Printing3DModel](printing3dmodel.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_repairasync_774913944.md b/windows.graphics.printing3d/printing3dmodel_repairasync_774913944.md index dc5b5ad456..d14c377aaa 100644 --- a/windows.graphics.printing3d/printing3dmodel_repairasync_774913944.md +++ b/windows.graphics.printing3d/printing3dmodel_repairasync_774913944.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.RepairAsync --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.RepairAsync ## -description Executes the 3D model repair algorithm on the model. ## -returns Results of the operation. ## -remarks To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). ## -examples ## -see-also [3D Model Repair service](http://aka.ms/modelrepair) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.RepairAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.RepairAsync + +## -description +Executes the 3D model repair algorithm on the model. + +## -returns +Results of the operation. + +## -remarks +To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). + +## -examples + +## -see-also +[3D Model Repair service](http://aka.ms/modelrepair) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_repairwithprogressasync_1283033613.md b/windows.graphics.printing3d/printing3dmodel_repairwithprogressasync_1283033613.md index 49ccbfe36d..d11111a36a 100644 --- a/windows.graphics.printing3d/printing3dmodel_repairwithprogressasync_1283033613.md +++ b/windows.graphics.printing3d/printing3dmodel_repairwithprogressasync_1283033613.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.RepairWithProgressAsync --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.RepairWithProgressAsync ## -description Executes the 3D model repair algorithm, with the ability to report the progress of the operation. ## -returns A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. ## -remarks To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). ## -examples ## -see-also [3D Model Repair service](http://aka.ms/modelrepair) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.RepairWithProgressAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.RepairWithProgressAsync + +## -description +Executes the 3D model repair algorithm, with the ability to report the progress of the operation. + +## -returns +A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. + +## -remarks +To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). + +## -examples + +## -see-also +[3D Model Repair service](http://aka.ms/modelrepair) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_requiredextensions.md b/windows.graphics.printing3d/printing3dmodel_requiredextensions.md index 2750e53df7..365819db5f 100644 --- a/windows.graphics.printing3d/printing3dmodel_requiredextensions.md +++ b/windows.graphics.printing3d/printing3dmodel_requiredextensions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.RequiredExtensions --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.RequiredExtensions ## -description Gets a list of the extensions required by the 3D Manufacturing Format (3MF) package. ## -property-value The extensions required by the 3MF package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.RequiredExtensions +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.RequiredExtensions + +## -description +Gets a list of the extensions required by the 3D Manufacturing Format (3MF) package. + +## -property-value +The extensions required by the 3MF package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_textures.md b/windows.graphics.printing3d/printing3dmodel_textures.md index e588e8746b..7d183838c8 100644 --- a/windows.graphics.printing3d/printing3dmodel_textures.md +++ b/windows.graphics.printing3d/printing3dmodel_textures.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Textures --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Textures ## -description Gets all textures used in the 3D model. ## -property-value All textures used in the 3D model, of type [Printing3DModelTexture](printing3dmodeltexture.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Textures +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Textures + +## -description +Gets all textures used in the 3D model. + +## -property-value +All textures used in the 3D model, of type [Printing3DModelTexture](printing3dmodeltexture.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_1499288276.md b/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_1499288276.md index 290a6a22ab..8e9e55ee2a 100644 --- a/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_1499288276.md +++ b/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_1499288276.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync ## -description Begins the 3D model repair algorithm, but exits if the time limit is reached. ## -parameters ### -param maxWaitTime Defines the amount of time (in seconds) that the algorithm can run for. A value of 0 will cause the algorithm to run until another end condition is met. ## -returns **true** if the asynchronous operation succeeded; otherwise, **false**. ## -remarks To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). ## -examples ## -see-also [TryPartialRepairAsync](printing3dmodel_trypartialrepairasync_334555296.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync + +## -description +Begins the 3D model repair algorithm, but exits if the time limit is reached. + +## -parameters +### -param maxWaitTime +Defines the amount of time (in seconds) that the algorithm can run for. A value of 0 will cause the algorithm to run until another end condition is met. + +## -returns +**true** if the asynchronous operation succeeded; otherwise, **false**. + +## -remarks +To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). + +## -examples + +## -see-also +[TryPartialRepairAsync](printing3dmodel_trypartialrepairasync_334555296.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_334555296.md b/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_334555296.md index 715c7e3788..32dbc64627 100644 --- a/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_334555296.md +++ b/windows.graphics.printing3d/printing3dmodel_trypartialrepairasync_334555296.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync ## -description Executes the 3D model repair algorithm until complete or an exception is thrown. ## -returns **true** if the asynchronous operation succeeded; otherwise, **false**. ## -remarks To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). ## -examples ## -see-also [TryPartialRepairAsync(TimeSpan)](printing3dmodel_trypartialrepairasync_1499288276.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.TryPartialRepairAsync + +## -description +Executes the 3D model repair algorithm until complete or an exception is thrown. + +## -returns +**true** if the asynchronous operation succeeded; otherwise, **false**. + +## -remarks +To learn more about the 3D model repair algorithm and test it out quickly, go to the [3D Model Repair service](http://aka.ms/modelrepair). + +## -examples + +## -see-also +[TryPartialRepairAsync(TimeSpan)](printing3dmodel_trypartialrepairasync_1499288276.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_1526716101.md b/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_1526716101.md index 8abf7e10ac..64ca327012 100644 --- a/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_1526716101.md +++ b/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_1526716101.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync(Windows.Graphics.Printing3D.Printing3DFaceReductionOptions,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync ## -description Runs an algorithm that reduces the number of triangle faces in all of the meshes within the [Printing3DModel](printing3dmodel.md) by merging nearby vertices. Stops according to the specified options or when the *maxWait* time is reached. ## -parameters ### -param printing3DFaceReductionOptions Defines the conditions which will trigger the end of the operation. ### -param maxWait Defines the amount of time (in seconds) that the algorithm can run for. A value of 0 will cause the algorithm to run until another end condition is met. ## -returns A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. ## -remarks ## -examples ## -see-also [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync_2097932692.md), [TryReduceFacesAsync(Printing3DFaceReductionOptions)](printing3dmodel_tryreducefacesasync_811294173.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync(Windows.Graphics.Printing3D.Printing3DFaceReductionOptions,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync + +## -description +Runs an algorithm that reduces the number of triangle faces in all of the meshes within the [Printing3DModel](printing3dmodel.md) by merging nearby vertices. Stops according to the specified options or when the *maxWait* time is reached. + +## -parameters +### -param printing3DFaceReductionOptions +Defines the conditions which will trigger the end of the operation. + +### -param maxWait +Defines the amount of time (in seconds) that the algorithm can run for. A value of 0 will cause the algorithm to run until another end condition is met. + +## -returns +A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. + +## -remarks + +## -examples + +## -see-also +[TryReduceFacesAsync](printing3dmodel_tryreducefacesasync_2097932692.md), [TryReduceFacesAsync(Printing3DFaceReductionOptions)](printing3dmodel_tryreducefacesasync_811294173.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_2097932692.md b/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_2097932692.md index ab66b67a68..836126eabb 100644 --- a/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_2097932692.md +++ b/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_2097932692.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync ## -description Runs an algorithm that reduces the number of triangle faces in all of the meshes within the [Printing3DModel](printing3dmodel.md) by merging nearby vertices. Stops when the total number of triangles is reduced by half. ## -returns A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. ## -remarks ## -examples ## -see-also [TryReduceFacesAsync(Printing3DFaceReductionOptions)](printing3dmodel_tryreducefacesasync_811294173.md), [TryReduceFacesAsync(Printing3DFaceReductionOptions, TimeSpan)](printing3dmodel_tryreducefacesasync_1526716101.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync + +## -description +Runs an algorithm that reduces the number of triangle faces in all of the meshes within the [Printing3DModel](printing3dmodel.md) by merging nearby vertices. Stops when the total number of triangles is reduced by half. + +## -returns +A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. + +## -remarks + +## -examples + +## -see-also +[TryReduceFacesAsync(Printing3DFaceReductionOptions)](printing3dmodel_tryreducefacesasync_811294173.md), [TryReduceFacesAsync(Printing3DFaceReductionOptions, TimeSpan)](printing3dmodel_tryreducefacesasync_1526716101.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_811294173.md b/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_811294173.md index 2eadc8c381..5d69c02d7b 100644 --- a/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_811294173.md +++ b/windows.graphics.printing3d/printing3dmodel_tryreducefacesasync_811294173.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync(Windows.Graphics.Printing3D.Printing3DFaceReductionOptions) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync ## -description Runs an algorithm that reduces the number of triangle faces in all of the meshes within the [Printing3DModel](printing3dmodel.md) by merging nearby vertices. Stops according to the specified options. ## -parameters ### -param printing3DFaceReductionOptions Defines the conditions which will trigger the end of the operation. ## -returns A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. ## -remarks ## -examples ## -see-also [TryReduceFacesAsync](printing3dmodel_tryreducefacesasync_2097932692.md), [TryReduceFacesAsync(Printing3DFaceReductionOptions, TimeSpan)](printing3dmodel_tryreducefacesasync_1526716101.md) \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync(Windows.Graphics.Printing3D.Printing3DFaceReductionOptions) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.TryReduceFacesAsync + +## -description +Runs an algorithm that reduces the number of triangle faces in all of the meshes within the [Printing3DModel](printing3dmodel.md) by merging nearby vertices. Stops according to the specified options. + +## -parameters +### -param printing3DFaceReductionOptions +Defines the conditions which will trigger the end of the operation. + +## -returns +A **Boolean** value indicating whether the asynchronous operation succeeded, and a **Double** value reporting the progress as a decimal number between zero and one. + +## -remarks + +## -examples + +## -see-also +[TryReduceFacesAsync](printing3dmodel_tryreducefacesasync_2097932692.md), [TryReduceFacesAsync(Printing3DFaceReductionOptions, TimeSpan)](printing3dmodel_tryreducefacesasync_1526716101.md) \ No newline at end of file diff --git a/windows.graphics.printing3d/printing3dmodel_unit.md b/windows.graphics.printing3d/printing3dmodel_unit.md index 072221aabd..be8760cd7b 100644 --- a/windows.graphics.printing3d/printing3dmodel_unit.md +++ b/windows.graphics.printing3d/printing3dmodel_unit.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Unit --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Unit ## -description Gets or sets the units of measure used in the 3D model. ## -property-value The units of measure used in the 3D model. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Unit +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Unit + +## -description +Gets or sets the units of measure used in the 3D model. + +## -property-value +The units of measure used in the 3D model. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodel_version.md b/windows.graphics.printing3d/printing3dmodel_version.md index 0291772832..fba4f55db4 100644 --- a/windows.graphics.printing3d/printing3dmodel_version.md +++ b/windows.graphics.printing3d/printing3dmodel_version.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Version --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModel.Version ## -description Gets or sets the version of the 3D Manufacturing Format (3MF) package. ## -property-value The version of the 3MF package. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModel.Version +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModel.Version + +## -description +Gets or sets the version of the 3D Manufacturing Format (3MF) package. + +## -property-value +The version of the 3MF package. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodeltexture.md b/windows.graphics.printing3d/printing3dmodeltexture.md index 10344c531d..25c7c92b22 100644 --- a/windows.graphics.printing3d/printing3dmodeltexture.md +++ b/windows.graphics.printing3d/printing3dmodeltexture.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DModelTexture --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DModelTexture ## -description Represents a texture used in the 3D model. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DModelTexture +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DModelTexture + +## -description +Represents a texture used in the 3D model. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodeltexture_printing3dmodeltexture_1221375020.md b/windows.graphics.printing3d/printing3dmodeltexture_printing3dmodeltexture_1221375020.md index dc8bf74734..c473813c02 100644 --- a/windows.graphics.printing3d/printing3dmodeltexture_printing3dmodeltexture_1221375020.md +++ b/windows.graphics.printing3d/printing3dmodeltexture_printing3dmodeltexture_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DModelTexture.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DModelTexture.Printing3DModelTexture ## -description Creates an instance of the [Printing3DModelTexture](printing3dmodeltexture.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DModelTexture.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DModelTexture.Printing3DModelTexture + +## -description +Creates an instance of the [Printing3DModelTexture](printing3dmodeltexture.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodeltexture_textureresource.md b/windows.graphics.printing3d/printing3dmodeltexture_textureresource.md index 3b46d66a17..de603101ea 100644 --- a/windows.graphics.printing3d/printing3dmodeltexture_textureresource.md +++ b/windows.graphics.printing3d/printing3dmodeltexture_textureresource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModelTexture.TextureResource --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModelTexture.TextureResource ## -description Gets or sets the texture resource used by the texture. ## -property-value The texture resource used by the texture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModelTexture.TextureResource +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModelTexture.TextureResource + +## -description +Gets or sets the texture resource used by the texture. + +## -property-value +The texture resource used by the texture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodeltexture_tilestyleu.md b/windows.graphics.printing3d/printing3dmodeltexture_tilestyleu.md index a5482a5e5b..9c414297a2 100644 --- a/windows.graphics.printing3d/printing3dmodeltexture_tilestyleu.md +++ b/windows.graphics.printing3d/printing3dmodeltexture_tilestyleu.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleU --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleU ## -description Get or sets a value that indicates how tiling should occur in the U axis in order to fill the overall requested area. ## -property-value A value that indicates how tiling should occur in the U axis in order to fill the overall requested area. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleU +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleU + +## -description +Get or sets a value that indicates how tiling should occur in the U axis in order to fill the overall requested area. + +## -property-value +A value that indicates how tiling should occur in the U axis in order to fill the overall requested area. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmodeltexture_tilestylev.md b/windows.graphics.printing3d/printing3dmodeltexture_tilestylev.md index 9a045c78f0..868756602e 100644 --- a/windows.graphics.printing3d/printing3dmodeltexture_tilestylev.md +++ b/windows.graphics.printing3d/printing3dmodeltexture_tilestylev.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleV --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleV ## -description Gets or sets a value that indicates how tiling should occur in the V axis in order to fill the overall requested area. ## -property-value A value that indicates how tiling should occur in the V axis in order to fill the overall requested area. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleV +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DModelTexture.TileStyleV + +## -description +Gets or sets a value that indicates how tiling should occur in the V axis in order to fill the overall requested area. + +## -property-value +A value that indicates how tiling should occur in the V axis in order to fill the overall requested area. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterial.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterial.md index fdc0949d98..076a77e3d1 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterial.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterial.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial ## -description Represents a combination of properties and/or materials from the material groups specified in ([MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md)). ## -remarks Each multi-property material is defined by a combination of properties and/or materials that are listed in the specified material groups ([MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md)). Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The combinations are specified in [MultipleProperties](printing3dmultiplepropertymaterialgroup_multipleproperties.md), where the index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). This class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial + +## -description +Represents a combination of properties and/or materials from the material groups specified in ([MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md)). + +## -remarks +Each multi-property material is defined by a combination of properties and/or materials that are listed in the specified material groups ([MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md)). Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The combinations are specified in [MultipleProperties](printing3dmultiplepropertymaterialgroup_multipleproperties.md), where the index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). + +This class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterial_materialindices.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterial_materialindices.md index 0694bd1479..ed2d71558b 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterial_materialindices.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterial_materialindices.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.MaterialIndices --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.MaterialIndices ## -description Gets the indices of the properties and/or materials combined in the multi-property material. Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). ## -property-value The indices of the properties or materials combined in the multi-property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.MaterialIndices +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.MaterialIndices + +## -description +Gets the indices of the properties and/or materials combined in the multi-property material. Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). + +## -property-value +The indices of the properties or materials combined in the multi-property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterial_printing3dmultiplepropertymaterial_1221375020.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterial_printing3dmultiplepropertymaterial_1221375020.md index 95f9c483db..49e4aef6db 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterial_printing3dmultiplepropertymaterial_1221375020.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterial_printing3dmultiplepropertymaterial_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.Printing3DMultiplePropertyMaterial ## -description Creates an instance of the [Printing3DMultiplePropertyMaterial](printing3dmultiplepropertymaterial.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterial.Printing3DMultiplePropertyMaterial + +## -description +Creates an instance of the [Printing3DMultiplePropertyMaterial](printing3dmultiplepropertymaterial.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup.md index 1e613a1cf8..71c68edf39 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup ## -description Represents a multi-property material group. ## -remarks Each multi-property material is defined by a combination of properties and/or materials that are listed in the specified material groups ([MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md)). Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The combinations are specified in [MultipleProperties](printing3dmultiplepropertymaterialgroup_multipleproperties.md), where the index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). The [Printing3DMultiplePropertyMaterialGroup](printing3dmultiplepropertymaterialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup + +## -description +Represents a multi-property material group. + +## -remarks +Each multi-property material is defined by a combination of properties and/or materials that are listed in the specified material groups ([MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md)). Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The combinations are specified in [MultipleProperties](printing3dmultiplepropertymaterialgroup_multipleproperties.md), where the index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). + +The [Printing3DMultiplePropertyMaterialGroup](printing3dmultiplepropertymaterialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupid.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupid.md index 5406ec329c..f0ec175101 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupid.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupId --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupId ## -description Gets the identifier (ID) of the multi-property material group. ## -property-value The ID of the multi-property material group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupId + +## -description +Gets the identifier (ID) of the multi-property material group. + +## -property-value +The ID of the multi-property material group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupindices.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupindices.md index cf45bdc3cf..5ae3055541 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupindices.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_materialgroupindices.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupIndices --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupIndices ## -description Gets an ordered list of material groups (**MaterialGroupId** values) that are used to define property-material combinations in the multi-property group. The order of material groups is maintained in the combinations defined by [MultipleProperties](printing3dmultiplepropertymaterialgroup_multipleproperties.md). ## -property-value The indices of the properties or materials in the group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupIndices +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MaterialGroupIndices + +## -description +Gets an ordered list of material groups (**MaterialGroupId** values) that are used to define property-material combinations in the multi-property group. The order of material groups is maintained in the combinations defined by [MultipleProperties](printing3dmultiplepropertymaterialgroup_multipleproperties.md). + +## -property-value +The indices of the properties or materials in the group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_multipleproperties.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_multipleproperties.md index fd8df2afbf..f690cb231a 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_multipleproperties.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_multipleproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MultipleProperties --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MultipleProperties ## -description Gets a list of property-material combinations. Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). ## -property-value A list of property-material combinations . ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MultipleProperties +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.MultipleProperties + +## -description +Gets a list of property-material combinations. Each combination is defined by listing the index of an item from one material group with the index of an item from a secondary material group. The index values are specified in the same order as the material groups listed in [MaterialGroupIndices](printing3dmultiplepropertymaterialgroup_materialgroupindices.md). + +## -property-value +A list of property-material combinations . + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_printing3dmultiplepropertymaterialgroup_885572907.md b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_printing3dmultiplepropertymaterialgroup_885572907.md index fd9a857cbd..c22872f77f 100644 --- a/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_printing3dmultiplepropertymaterialgroup_885572907.md +++ b/windows.graphics.printing3d/printing3dmultiplepropertymaterialgroup_printing3dmultiplepropertymaterialgroup_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.Printing3DMultiplePropertyMaterialGroup ## -description Creates a new instance of the [Printing3DMultiplePropertyMaterialGroup](printing3dmultiplepropertymaterialgroup.md) class. ## -parameters ### -param MaterialGroupId The identifier (ID) of the multi-property material group; a value greater than zero. ## -remarks Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DMultiplePropertyMaterialGroup.Printing3DMultiplePropertyMaterialGroup + +## -description +Creates a new instance of the [Printing3DMultiplePropertyMaterialGroup](printing3dmultiplepropertymaterialgroup.md) class. + +## -parameters +### -param MaterialGroupId +The identifier (ID) of the multi-property material group; a value greater than zero. + +## -remarks +Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterial.md b/windows.graphics.printing3d/printing3dtexture2coordmaterial.md index ee38cee21a..340aed98d6 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterial.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterial.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial ## -description Represents a 2D texture material used in the 3D model. ## -remarks The [Printing3DTexture2CoordMaterial](printing3dtexture2coordmaterial.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial + +## -description +Represents a 2D texture material used in the 3D model. + +## -remarks +The [Printing3DTexture2CoordMaterial](printing3dtexture2coordmaterial.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterial_printing3dtexture2coordmaterial_1221375020.md b/windows.graphics.printing3d/printing3dtexture2coordmaterial_printing3dtexture2coordmaterial_1221375020.md index 993208628b..2011c6e7be 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterial_printing3dtexture2coordmaterial_1221375020.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterial_printing3dtexture2coordmaterial_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.Printing3DTexture2CoordMaterial ## -description Creates an instance of the [Printing3DTexture2CoordMaterial](printing3dtexture2coordmaterial.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.Printing3DTexture2CoordMaterial + +## -description +Creates an instance of the [Printing3DTexture2CoordMaterial](printing3dtexture2coordmaterial.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterial_texture.md b/windows.graphics.printing3d/printing3dtexture2coordmaterial_texture.md index 9042a9830a..434716217f 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterial_texture.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterial_texture.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.Texture --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.Texture ## -description Gets or sets the texture used in the 2D texture material. ## -property-value The texture used in the 2D texture material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.Texture +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.Texture + +## -description +Gets or sets the texture used in the 2D texture material. + +## -property-value +The texture used in the 2D texture material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterial_u.md b/windows.graphics.printing3d/printing3dtexture2coordmaterial_u.md index acc7e98935..3150c23eca 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterial_u.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterial_u.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.U --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.U ## -description Gets or sets the U-coordinate within the texture, horizontally right from the origin in the upper left of the texture. ## -property-value The U-coordinate within the texture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.U +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.U + +## -description +Gets or sets the U-coordinate within the texture, horizontally right from the origin in the upper left of the texture. + +## -property-value +The U-coordinate within the texture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterial_v.md b/windows.graphics.printing3d/printing3dtexture2coordmaterial_v.md index 67daf319b2..f10b4c40a2 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterial_v.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterial_v.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.V --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.V ## -description Gets or sets the V-coordinate within the texture, vertically down from the origin in the upper left of the texture. ## -property-value The V-coordinate within the texture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.V +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterial.V + +## -description +Gets or sets the V-coordinate within the texture, vertically down from the origin in the upper left of the texture. + +## -property-value +The V-coordinate within the texture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup.md b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup.md index 96b486ad5f..807c60991a 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup ## -description Represents a group of 2D texture materials used in the 3D model. ## -remarks The [Printing3DTexture2CoordMaterialGroup](printing3dtexture2coordmaterialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup + +## -description +Represents a group of 2D texture materials used in the 3D model. + +## -remarks +The [Printing3DTexture2CoordMaterialGroup](printing3dtexture2coordmaterialgroup.md) class corresponds to the `` element in the 3D Manufacturing Format (3MF) specification. For more info, see the [3MF Specification](http://go.microsoft.com/fwlink/p/?LinkId=616252). + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_materialgroupid.md b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_materialgroupid.md index 3a023d669b..a51454381d 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_materialgroupid.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_materialgroupid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.MaterialGroupId --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.MaterialGroupId ## -description Gets the identifier (ID) of the 2D texture material group. ## -property-value The ID of the 2D texture material group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.MaterialGroupId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.MaterialGroupId + +## -description +Gets the identifier (ID) of the 2D texture material group. + +## -property-value +The ID of the 2D texture material group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_printing3dtexture2coordmaterialgroup_885572907.md b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_printing3dtexture2coordmaterialgroup_885572907.md index 4baa622600..b7addbf15b 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_printing3dtexture2coordmaterialgroup_885572907.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_printing3dtexture2coordmaterialgroup_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Printing3DTexture2CoordMaterialGroup ## -description Creates a instance of the [Printing3DTexture2CoordMaterialGroup](printing3dtexture2coordmaterialgroup.md) class. ## -parameters ### -param MaterialGroupId The identifier for a group of 2D texture materials used in the 3D model; a value greater than zero. ## -remarks Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Printing3DTexture2CoordMaterialGroup + +## -description +Creates a instance of the [Printing3DTexture2CoordMaterialGroup](printing3dtexture2coordmaterialgroup.md) class. + +## -parameters +### -param MaterialGroupId +The identifier for a group of 2D texture materials used in the 3D model; a value greater than zero. + +## -remarks +Set *MaterialGroupId* to a value greater than zero. A value of zero is not valid and triggers an **E_INVALIADARG** error. + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture.md b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture.md index 91a7d69f3f..7795aab544 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture ## -description Gets or sets the texture of the material group. ## -property-value The texture of the material group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture + +## -description +Gets or sets the texture of the material group. + +## -property-value +The texture of the material group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture2coords.md b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture2coords.md index 5edb6aaaa1..44d0d4ae0b 100644 --- a/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture2coords.md +++ b/windows.graphics.printing3d/printing3dtexture2coordmaterialgroup_texture2coords.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture2Coords --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture2Coords ## -description Gets a group of 2D texture materials used in the 3D model. ## -property-value A group of 2D texture materials used in the 3D model, of type [Printing3DTexture2CoordMaterial](printing3dtexture2coordmaterial.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture2Coords +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTexture2CoordMaterialGroup.Texture2Coords + +## -description +Gets a group of 2D texture materials used in the 3D model. + +## -property-value +A group of 2D texture materials used in the 3D model, of type [Printing3DTexture2CoordMaterial](printing3dtexture2coordmaterial.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtextureresource.md b/windows.graphics.printing3d/printing3dtextureresource.md index f2617e91c0..8b961715de 100644 --- a/windows.graphics.printing3d/printing3dtextureresource.md +++ b/windows.graphics.printing3d/printing3dtextureresource.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Graphics.Printing3D.Printing3DTextureResource --api-type: winrt class ---- # Windows.Graphics.Printing3D.Printing3DTextureResource ## -description Specifies the texture resource used in a 2D texture material. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DTextureResource +-api-type: winrt class +--- + + + +# Windows.Graphics.Printing3D.Printing3DTextureResource + +## -description +Specifies the texture resource used in a 2D texture material. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtextureresource_name.md b/windows.graphics.printing3d/printing3dtextureresource_name.md index 1dad3e13c8..8ecb5b9d7f 100644 --- a/windows.graphics.printing3d/printing3dtextureresource_name.md +++ b/windows.graphics.printing3d/printing3dtextureresource_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTextureResource.Name --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTextureResource.Name ## -description Gets or sets the name of the texture resource. ## -property-value The name of the texture resource. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTextureResource.Name +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTextureResource.Name + +## -description +Gets or sets the name of the texture resource. + +## -property-value +The name of the texture resource. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtextureresource_printing3dtextureresource_1221375020.md b/windows.graphics.printing3d/printing3dtextureresource_printing3dtextureresource_1221375020.md index 495be77178..0a2a1eb380 100644 --- a/windows.graphics.printing3d/printing3dtextureresource_printing3dtextureresource_1221375020.md +++ b/windows.graphics.printing3d/printing3dtextureresource_printing3dtextureresource_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Graphics.Printing3D.Printing3DTextureResource.#ctor --api-type: winrt method ---- # Windows.Graphics.Printing3D.Printing3DTextureResource.Printing3DTextureResource ## -description Creates an instance of the [Printing3DTextureResource](printing3dtextureresource.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Graphics.Printing3D.Printing3DTextureResource.#ctor +-api-type: winrt method +--- + + + +# Windows.Graphics.Printing3D.Printing3DTextureResource.Printing3DTextureResource + +## -description +Creates an instance of the [Printing3DTextureResource](printing3dtextureresource.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics.printing3d/printing3dtextureresource_texturedata.md b/windows.graphics.printing3d/printing3dtextureresource_texturedata.md index 63acb94ba4..175f3dd4c5 100644 --- a/windows.graphics.printing3d/printing3dtextureresource_texturedata.md +++ b/windows.graphics.printing3d/printing3dtextureresource_texturedata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Graphics.Printing3D.Printing3DTextureResource.TextureData --api-type: winrt property ---- # Windows.Graphics.Printing3D.Printing3DTextureResource.TextureData ## -description Gets or sets the image stream of the texture resource. ## -property-value The image stream of the texture resource. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3DTextureResource.TextureData +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing3D.Printing3DTextureResource.TextureData + +## -description +Gets or sets the image stream of the texture resource. + +## -property-value +The image stream of the texture resource. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.core/applicationdatamanager_createforpackagefamily_1275768569.md b/windows.management.core/applicationdatamanager_createforpackagefamily_1275768569.md index af7a8ab572..1c41d7af8e 100644 --- a/windows.management.core/applicationdatamanager_createforpackagefamily_1275768569.md +++ b/windows.management.core/applicationdatamanager_createforpackagefamily_1275768569.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Management.Core.ApplicationDataManager.CreateForPackageFamily(System.String) --api-type: winrt method ---- # Windows.Management.Core.ApplicationDataManager.CreateForPackageFamily ## -description Provides access to the app data store for the specified package family. ## -parameters ### -param packageFamilyName The package family name. ## -returns The app data store. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Core.ApplicationDataManager.CreateForPackageFamily(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Core.ApplicationDataManager.CreateForPackageFamily + +## -description +Provides access to the app data store for the specified package family. + +## -parameters +### -param packageFamilyName +The package family name. + +## -returns +The app data store. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment.preview/classicappmanager.md b/windows.management.deployment.preview/classicappmanager.md index 0674a854fc..491f05acf5 100644 --- a/windows.management.deployment.preview/classicappmanager.md +++ b/windows.management.deployment.preview/classicappmanager.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Management.Deployment.Preview.ClassicAppManager --api-type: winrt class ---- # Windows.Management.Deployment.Preview.ClassicAppManager ## -description A static class that is used to find installed classic desktop apps. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Management.Deployment.Preview.ClassicAppManager +-api-type: winrt class +--- + + + +# Windows.Management.Deployment.Preview.ClassicAppManager + +## -description +A static class that is used to find installed classic desktop apps. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment.preview/classicappmanager_findinstalledapp_388394577.md b/windows.management.deployment.preview/classicappmanager_findinstalledapp_388394577.md index 578238adad..5372817ab8 100644 --- a/windows.management.deployment.preview/classicappmanager_findinstalledapp_388394577.md +++ b/windows.management.deployment.preview/classicappmanager_findinstalledapp_388394577.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Management.Deployment.Preview.ClassicAppManager.FindInstalledApp(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.Preview.ClassicAppManager.FindInstalledApp ## -description Finds and returns info for an installed classic desktop app. ## -parameters ### -param appUninstallKey The uninstall registry key for the app. ## -returns Info for the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.Preview.ClassicAppManager.FindInstalledApp(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.Preview.ClassicAppManager.FindInstalledApp + +## -description +Finds and returns info for an installed classic desktop app. + +## -parameters +### -param appUninstallKey +The uninstall registry key for the app. + +## -returns +Info for the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment.preview/installedclassicappinfo_displayname.md b/windows.management.deployment.preview/installedclassicappinfo_displayname.md index 9e52b0e8db..338f6cfeab 100644 --- a/windows.management.deployment.preview/installedclassicappinfo_displayname.md +++ b/windows.management.deployment.preview/installedclassicappinfo_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayName --api-type: winrt property ---- # Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayName ## -description Gets the display name for an installed classic desktop app. ## -property-value The name of the app as a [String](https://msdn.microsoft.com/library/system.string.aspx) that can be displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayName + +## -description +Gets the display name for an installed classic desktop app. + +## -property-value +The name of the app as a [String](https://msdn.microsoft.com/library/system.string.aspx) that can be displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment.preview/installedclassicappinfo_displayversion.md b/windows.management.deployment.preview/installedclassicappinfo_displayversion.md index c560782a52..9d771f52b4 100644 --- a/windows.management.deployment.preview/installedclassicappinfo_displayversion.md +++ b/windows.management.deployment.preview/installedclassicappinfo_displayversion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayVersion --api-type: winrt property ---- # Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayVersion ## -description Gets the display version for an installed classic desktop app. ## -property-value The version of the app as a [String](https://msdn.microsoft.com/library/system.string.aspx) that can be displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayVersion +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.Preview.InstalledClassicAppInfo.DisplayVersion + +## -description +Gets the display version for an installed classic desktop app. + +## -property-value +The version of the app as a [String](https://msdn.microsoft.com/library/system.string.aspx) that can be displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/deploymentresult_activityid.md b/windows.management.deployment/deploymentresult_activityid.md index a0493f97f8..57fd73a8bf 100644 --- a/windows.management.deployment/deploymentresult_activityid.md +++ b/windows.management.deployment/deploymentresult_activityid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.DeploymentResult.ActivityId --api-type: winrt property ---- # Windows.Management.Deployment.DeploymentResult.ActivityId ## -description Gets the activity identifier used to look up an event in Windows Event Viewer. Gets the activity identifier used to look up an event. All events of a deployment operation are logged with the same **activityId**. ## -property-value The activity identifier. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.DeploymentResult.ActivityId +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.DeploymentResult.ActivityId + +## -description +Gets the activity identifier used to look up an event in Windows Event Viewer. Gets the activity identifier used to look up an event. All events of a deployment operation are logged with the same **activityId**. + +## -property-value +The activity identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/deploymentresult_errortext.md b/windows.management.deployment/deploymentresult_errortext.md index 3505157b22..d81d2e0fe7 100644 --- a/windows.management.deployment/deploymentresult_errortext.md +++ b/windows.management.deployment/deploymentresult_errortext.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.DeploymentResult.ErrorText --api-type: winrt property ---- # Windows.Management.Deployment.DeploymentResult.ErrorText ## -description Gets extended error text for the error if the deployment operation is not successful. ## -property-value The extended error text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.DeploymentResult.ErrorText +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.DeploymentResult.ErrorText + +## -description +Gets extended error text for the error if the deployment operation is not successful. + +## -property-value +The extended error text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/deploymentresult_extendederrorcode.md b/windows.management.deployment/deploymentresult_extendederrorcode.md index 899a5e7ab8..ef6b9b71d6 100644 --- a/windows.management.deployment/deploymentresult_extendederrorcode.md +++ b/windows.management.deployment/deploymentresult_extendederrorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.DeploymentResult.ExtendedErrorCode --api-type: winrt property ---- # Windows.Management.Deployment.DeploymentResult.ExtendedErrorCode ## -description The extended error code can be used to distinguish a specific error condition which needs to be handled differently from the general error indicated by the return code. The extended error code may provide a more specific reason for the failure that caused the general error. Also, it usually corresponds directly to the specific message in the [ErrorText](deploymentresult_errortext.md). ## -property-value The error code. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.DeploymentResult.ExtendedErrorCode +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.DeploymentResult.ExtendedErrorCode + +## -description +The extended error code can be used to distinguish a specific error condition which needs to be handled differently from the general error indicated by the return code. The extended error code may provide a more specific reason for the failure that caused the general error. Also, it usually corresponds directly to the specific message in the [ErrorText](deploymentresult_errortext.md). + +## -property-value +The error code. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagemanager_addpackageasync_2048203939.md b/windows.management.deployment/packagemanager_addpackageasync_2048203939.md index 9b62450612..a4ce9264fa 100644 --- a/windows.management.deployment/packagemanager_addpackageasync_2048203939.md +++ b/windows.management.deployment/packagemanager_addpackageasync_2048203939.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.AddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.AddPackageAsync ## -description Adds a package (the main package) and its dependency packages to the specified volume for the current user, using the specified deployment options. ## -parameters ### -param packageUri The Uri of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. ### -param dependencyPackageUris The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. ### -param deploymentOptions A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. ### -param targetVolume The volume to which the package is added. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks ## -examples ## -see-also [Add app package sample](http://go.microsoft.com/fwlink/p/?linkid=236968), [AddPackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_addpackageasync_973949101.md) ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.AddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.AddPackageAsync + +## -description +Adds a package (the main package) and its dependency packages to the specified volume for the current user, using the specified deployment options. + +## -parameters +### -param packageUri +The Uri of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. + +### -param dependencyPackageUris +The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. + +### -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. + +### -param targetVolume +The volume to which the package is added. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks + +## -examples + +## -see-also +[Add app package sample](http://go.microsoft.com/fwlink/p/?linkid=236968), [AddPackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_addpackageasync_973949101.md) + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_addpackageasync_973949101.md b/windows.management.deployment/packagemanager_addpackageasync_973949101.md index 8ce118f15b..9f8c313e18 100644 --- a/windows.management.deployment/packagemanager_addpackageasync_973949101.md +++ b/windows.management.deployment/packagemanager_addpackageasync_973949101.md @@ -1,3 +1,154 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.AddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.AddPackageAsync ## -description Adds a package (the main package) and its dependency packages for the current user, using the specified deployment options. ## -parameters ### -param packageUri The Uri of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. ### -param dependencyPackageUris The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. ### -param deploymentOptions A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks ## -examples The following example uses the [PackageManager.AddPackageAsync](packagemanager_addpackageasync.md) method to install a package that has no dependencies or whose dependencies are already installed. Note that the path of the main package is passed as an argument in the example. [AddPackageAsync](packagemanager_addpackageasync.md) returns an object that can be used to manage the asynchronous operation. The example uses the [Completed](../windows.foundation/iasyncoperationwithprogress_2_completed.md) property to set the [delegate](../windows.foundation/asyncoperationwithprogresscompletedhandler_2.md) and checks the [Status](../windows.foundation/iasyncinfo_status.md) property to determine the status of the deployment operation. If the status is **Error**, the example calls the [GetResults](../windows.foundation/iasyncoperationwithprogress_2_getresults.md) method to get additional error information. ```csharp using Windows.Foundation; using Windows.Management.Deployment; public static int Main(string[] args) { string inputPackageUri = args[0]; int returnValue=0; Uri packageUri = new Uri(inputPackageUri); PackageManager packageManager = new PackageManager(); IAsyncOperationWithProgress deploymentOperation = packageManager.AddPackageAsync( packageUri, null, DeploymentOptions.None); // This event is signaled when the operation completes ManualResetEvent opCompletedEvent = new ManualResetEvent(false); // Define the delegate using a statement lambda deploymentOperation.Completed = (depProgress, status) => { opCompletedEvent.Set(); }; // Wait until the operation completes opCompletedEvent.WaitOne(); // Check the status of the operation if (deploymentOperation.Status == AsyncStatus.Error) { DeploymentResult deploymentResult = deploymentOperation.GetResults(); Console.WriteLine("Error code: {0}", deploymentOperation.ErrorCode); Console.WriteLine("Error text: {0}", deploymentResult.ErrorText); returnValue = 1; } else if (deploymentOperation.Status == AsyncStatus.Canceled) { Console.WriteLine("Installation canceled"); } else if (deploymentOperation.Status == AsyncStatus.Completed) { Console.WriteLine("Installation succeeded"); } else { returnValue = 1; Console.WriteLine("Installation status unknown"); } return returnValue; } ``` ```cpp using namespace Windows::Foundation; using namespace Windows::Management::Deployment; [STAThread] int __cdecl main(Platform::Array^ args) { String^ inputPackageUri = args[1]; int returnValue=0; Uri^ packageUri = ref new Uri(inputPackageUri); PackageManager^ packageManager = ref new PackageManager(); auto deploymentOperation = packageManager->AddPackageAsync( packageUri, nullptr, DeploymentOptions::None); DeploymentResult^ deploymentOperationResult; // This event is signaled when the operation completes opCompletedEvent = CreateEvent(NULL, TRUE, FALSE, NULL); // Define the delegate deploymentOperation->Completed = ref new AsyncOperationWithProgressCompletedHandler( [&](IAsyncOperationWithProgress^ operation, AsyncStatus) { SetEvent(opCompletedEvent); }); // Wait until the operation completes WaitForSingleObject(opCompletedEvent, INFINITE); // Check the status of the operation if ( deploymentOperation->Status == AsyncStatus::Error ) { auto deploymentResult = deploymentOperation->GetResults(); wcout << L"Error code: " << deploymentOperation->ErrorCode.Value << endl; wcout << L"Error text: " << deploymentResult->ErrorText->Data() << endl; returnValue = 1; } else if ( deploymentOperation->Status == AsyncStatus::Canceled ) { wcout << L"Installation canceled" << endl; } else if ( deploymentOperation->Status == AsyncStatus::Completed ) { wcout << L"Installation succeeded" << endl; } else { wcout << L"Installation status unknown" << endl; returnValue = 1; } return returnValue; } ``` ## -see-also [Add app package sample](http://go.microsoft.com/fwlink/p/?linkid=236968), [AddPackageAsync(Uri, IIterable(Uri), DeploymentOptions, PackageVolume)](packagemanager_addpackageasync_2048203939.md) ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.AddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.AddPackageAsync + +## -description +Adds a package (the main package) and its dependency packages for the current user, using the specified deployment options. + +## -parameters +### -param packageUri +The Uri of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. + +### -param dependencyPackageUris +The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. + +### -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks + +## -examples +The following example uses the [PackageManager.AddPackageAsync](packagemanager_addpackageasync.md) method to install a package that has no dependencies or whose dependencies are already installed. Note that the path of the main package is passed as an argument in the example. [AddPackageAsync](packagemanager_addpackageasync.md) returns an object that can be used to manage the asynchronous operation. The example uses the [Completed](../windows.foundation/iasyncoperationwithprogress_2_completed.md) property to set the [delegate](../windows.foundation/asyncoperationwithprogresscompletedhandler_2.md) and checks the [Status](../windows.foundation/iasyncinfo_status.md) property to determine the status of the deployment operation. If the status is **Error**, the example calls the [GetResults](../windows.foundation/iasyncoperationwithprogress_2_getresults.md) method to get additional error information. + +```csharp +using Windows.Foundation; +using Windows.Management.Deployment; + +public static int Main(string[] args) +{ + string inputPackageUri = args[0]; + int returnValue=0; + + Uri packageUri = new Uri(inputPackageUri); + + PackageManager packageManager = new PackageManager(); + + IAsyncOperationWithProgress deploymentOperation = + packageManager.AddPackageAsync( + packageUri, + null, + DeploymentOptions.None); + + // This event is signaled when the operation completes + ManualResetEvent opCompletedEvent = new ManualResetEvent(false); + + // Define the delegate using a statement lambda + deploymentOperation.Completed = (depProgress, status) => { opCompletedEvent.Set(); }; + + // Wait until the operation completes + opCompletedEvent.WaitOne(); + + // Check the status of the operation + if (deploymentOperation.Status == AsyncStatus.Error) + { + DeploymentResult deploymentResult = deploymentOperation.GetResults(); + Console.WriteLine("Error code: {0}", deploymentOperation.ErrorCode); + Console.WriteLine("Error text: {0}", deploymentResult.ErrorText); + returnValue = 1; + } + else if (deploymentOperation.Status == AsyncStatus.Canceled) + { + Console.WriteLine("Installation canceled"); + } + else if (deploymentOperation.Status == AsyncStatus.Completed) + { + Console.WriteLine("Installation succeeded"); + } + else + { + returnValue = 1; + Console.WriteLine("Installation status unknown"); + } + + return returnValue; +} +``` + +```cpp + +using namespace Windows::Foundation; +using namespace Windows::Management::Deployment; + +[STAThread] +int __cdecl main(Platform::Array^ args) +{ + String^ inputPackageUri = args[1]; + int returnValue=0; + + Uri^ packageUri = ref new Uri(inputPackageUri); + + PackageManager^ packageManager = ref new PackageManager(); + + auto deploymentOperation = packageManager->AddPackageAsync( + packageUri, + nullptr, + DeploymentOptions::None); + + DeploymentResult^ deploymentOperationResult; + + // This event is signaled when the operation completes + opCompletedEvent = CreateEvent(NULL, TRUE, FALSE, NULL); + + // Define the delegate + deploymentOperation->Completed = + ref new AsyncOperationWithProgressCompletedHandler( + [&](IAsyncOperationWithProgress^ operation, AsyncStatus) + { + SetEvent(opCompletedEvent); + }); + + // Wait until the operation completes + WaitForSingleObject(opCompletedEvent, INFINITE); + + // Check the status of the operation + if ( deploymentOperation->Status == AsyncStatus::Error ) + { + auto deploymentResult = deploymentOperation->GetResults(); + wcout << L"Error code: " << deploymentOperation->ErrorCode.Value << endl; + wcout << L"Error text: " << deploymentResult->ErrorText->Data() << endl; + returnValue = 1; + } + else if ( deploymentOperation->Status == AsyncStatus::Canceled ) + { + wcout << L"Installation canceled" << endl; + } + else if ( deploymentOperation->Status == AsyncStatus::Completed ) + { + wcout << L"Installation succeeded" << endl; + } + else + { + wcout << L"Installation status unknown" << endl; + returnValue = 1; + } + return returnValue; +} +``` + + + +## -see-also +[Add app package sample](http://go.microsoft.com/fwlink/p/?linkid=236968), [AddPackageAsync(Uri, IIterable(Uri), DeploymentOptions, PackageVolume)](packagemanager_addpackageasync_2048203939.md) + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_addpackagevolumeasync_960401294.md b/windows.management.deployment/packagemanager_addpackagevolumeasync_960401294.md index 3460067806..e641fb6833 100644 --- a/windows.management.deployment/packagemanager_addpackagevolumeasync_960401294.md +++ b/windows.management.deployment/packagemanager_addpackagevolumeasync_960401294.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.AddPackageVolumeAsync(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.AddPackageVolumeAsync ## -description Creates a new volume. The caller must be a member of the administrators group. ## -parameters ### -param packageStorePath The absolute path of the package store. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperation** interface and returns the newly added [PackageVolume](packagevolume.md). ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.AddPackageVolumeAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.AddPackageVolumeAsync + +## -description +Creates a new volume. The caller must be a member of the administrators group. + +## -parameters +### -param packageStorePath +The absolute path of the package store. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperation** interface and returns the newly added [PackageVolume](packagevolume.md). + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_cleanuppackageforuserasync_270500303.md b/windows.management.deployment/packagemanager_cleanuppackageforuserasync_270500303.md index 7b5e8d4bbf..556b5c8af9 100644 --- a/windows.management.deployment/packagemanager_cleanuppackageforuserasync_270500303.md +++ b/windows.management.deployment/packagemanager_cleanuppackageforuserasync_270500303.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.CleanupPackageForUserAsync(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.CleanupPackageForUserAsync ## -description Cleans up a specified package for a specified user. Used to cleanup packages installed for a user after their user profile is deleted. ## -parameters ### -param packageName The package name. ### -param userSecurityId The user security identifier (SID). ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks The app binaries are not cleaned up unless the app is installed for has no other users. This method does not clear the registration of the app from the user's profile. Before you call this method, be sure that the user's profile is deleted. If the user profile is not deleted and the user logs back to the profile, the profile may show traces of the app. There may also be broken file type associations and broken tile links for the app. The caller must have administrative privilege or the call fails. In addition, the policy to allow deployment operations in special profiles must be enabled. By default, this policy is disabled. ## -examples ## -see-also [Deploy Roaming User Profiles](XREF:TODO:65840ed4-02af-49fc-a99d-292a4b50dfd4) ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.CleanupPackageForUserAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.CleanupPackageForUserAsync + +## -description +Cleans up a specified package for a specified user. Used to cleanup packages installed for a user after their user profile is deleted. + +## -parameters +### -param packageName +The package name. + +### -param userSecurityId +The user security identifier (SID). + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks +The app binaries are not cleaned up unless the app is installed for has no other users. This method does not clear the registration of the app from the user's profile. Before you call this method, be sure that the user's profile is deleted. If the user profile is not deleted and the user logs back to the profile, the profile may show traces of the app. There may also be broken file type associations and broken tile links for the app. The caller must have administrative privilege or the call fails. In addition, the policy to allow deployment operations in special profiles must be enabled. By default, this policy is disabled. + +## -examples + +## -see-also +[Deploy Roaming User Profiles](XREF:TODO:65840ed4-02af-49fc-a99d-292a4b50dfd4) + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_clearpackagestatus_2106290289.md b/windows.management.deployment/packagemanager_clearpackagestatus_2106290289.md index 6439c26f84..c4dee5410f 100644 --- a/windows.management.deployment/packagemanager_clearpackagestatus_2106290289.md +++ b/windows.management.deployment/packagemanager_clearpackagestatus_2106290289.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.ClearPackageStatus(System.String,Windows.Management.Deployment.PackageStatus) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.ClearPackageStatus ## -description Clears the status of a package. ## -parameters ### -param packageFullName The full name of the package. ### -param status One of the enumeration values that specifies the status to clear. ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.ClearPackageStatus(System.String,Windows.Management.Deployment.PackageStatus) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.ClearPackageStatus + +## -description +Clears the status of a package. + +## -parameters +### -param packageFullName +The full name of the package. + +### -param status +One of the enumeration values that specifies the status to clear. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackage_1322794127.md b/windows.management.deployment/packagemanager_findpackage_1322794127.md index 4f882207a2..c00bc7aebe 100644 --- a/windows.management.deployment/packagemanager_findpackage_1322794127.md +++ b/windows.management.deployment/packagemanager_findpackage_1322794127.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackage(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackage ## -description Retrieves information about the specified package installed for any user. ## -parameters ### -param packageFullName The full name of the package. This parameter cannot be null. ## -returns If this method succeeds it returns a package object that contains information about the specified package, including but not limited to its name, publisher, version, and install location. If the specified package is not found, this method returns **null**. ## -remarks This method requires administrative privileges. The returned package may be installed for the current user or for another user. ## -examples ## -see-also ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackage(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackage + +## -description +Retrieves information about the specified package installed for any user. + +## -parameters +### -param packageFullName +The full name of the package. This parameter cannot be null. + +## -returns +If this method succeeds it returns a package object that contains information about the specified package, including but not limited to its name, publisher, version, and install location. If the specified package is not found, this method returns **null**. + +## -remarks +This method requires administrative privileges. The returned package may be installed for the current user or for another user. + +## -examples + +## -see-also + + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackageforuser_526853699.md b/windows.management.deployment/packagemanager_findpackageforuser_526853699.md index 4cf663bd60..8a978540a1 100644 --- a/windows.management.deployment/packagemanager_findpackageforuser_526853699.md +++ b/windows.management.deployment/packagemanager_findpackageforuser_526853699.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackageForUser(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackageForUser ## -description Retrieves information about a specific package installed for a specific user or for all users. ## -parameters ### -param userSecurityId This user security ID of the user for whom the specified package is being retrieved. If this parameter is **null**, the specified package is retrieved for the current user. ### -param packageFullName The full name of the package. ## -returns The package. ## -remarks This method requires administrative privileges if the user security ID specified is different from the user security ID of the calling user. Otherwise, an AccessDeniedException is thrown. ## -examples ## -see-also ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackageForUser(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackageForUser + +## -description +Retrieves information about a specific package installed for a specific user or for all users. + +## -parameters +### -param userSecurityId +This user security ID of the user for whom the specified package is being retrieved. If this parameter is **null**, the specified package is retrieved for the current user. + +### -param packageFullName +The full name of the package. + +## -returns +The package. + +## -remarks +This method requires administrative privileges if the user security ID specified is different from the user security ID of the calling user. Otherwise, an AccessDeniedException is thrown. + +## -examples + +## -see-also + + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackages_1246181969.md b/windows.management.deployment/packagemanager_findpackages_1246181969.md index d6db907b03..42de8288b2 100644 --- a/windows.management.deployment/packagemanager_findpackages_1246181969.md +++ b/windows.management.deployment/packagemanager_findpackages_1246181969.md @@ -1,3 +1,113 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackages --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackages ## -description Retrieves information about a specified family of packages installed across all users. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. ## -remarks ## -examples This example uses [FindPackages()](packagemanager_findpackages_1246181969.md) to enumerate the installed packages for all users. ```csharp using Windows.Management.Deployment; public static int Main(string[] args) { PackageManager packageManager = new PackageManager(); IEnumerable packages = (IEnumerable) packageManager.FindPackages(); int packageCount = 0; foreach (var package in packages) { DisplayPackageInfo(package); packageCount += 1; } if (packageCount < 1) { Console.WriteLine("No packages were found."); } } private static void DisplayPackageInfo(Windows.ApplicationModel.Package package) { Console.WriteLine("Name: {0}", package.Id.Name); Console.WriteLine("FullName: {0}", package.Id.FullName); Console.WriteLine("Version: {0}.{1}.{2}.{3}", package.Id.Version.Major, package.Id.Version.Minor, package.Id.Version.Build, package.Id.Version.Revision); Console.WriteLine("Publisher: {0}", package.Id.Publisher); Console.WriteLine("PublisherId: {0}", package.Id.PublisherId); Console.WriteLine("Installed Location: {0}", package.InstalledLocation.Path); Console.WriteLine("IsFramework: {0}", package.IsFramework); } ``` ```cpp using namespace Windows::Management::Deployment; [STAThread] int __cdecl main(Platform::Array^ args) { PackageManager^ packageManager = ref new PackageManager(); IIterable^ packages = packageManager->FindPackages(); int packageCount = 0; std::for_each(Windows::Foundation::Collections::begin(packages), Windows::Foundation::Collections::end(packages), [&](Windows::ApplicationModel::Package^ package) { DisplayPackageInfo(package); packageCount += 1; }); if ( packageCount < 1 ) { wcout << L"No packages were found." << endl; } return 0; } void DisplayPackageInfo(Windows::ApplicationModel::Package^ package) { wcout << L"Name: " << package->Id->Name->Data() << endl; wcout << L"FullName: " << package->Id->FullName->Data() << endl; wcout << L"Version: " << package->Id->Version.Major << "." << package->Id->Version.Minor << "." << package->Id->Version.Build << "." << package->Id->Version.Revision << endl; wcout << L"Publisher: " << package->Id->Publisher->Data() << endl; wcout << L"PublisherId: " << package->Id->PublisherId->Data() << endl; wcout << L"Installed Location: " << package->InstalledLocation->Path->Data() << endl; wcout << L"IsFramework: " << (package->IsFramework ? L"True" : L"False") << endl; } ``` ## -see-also [Enumerate app packages sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-ee821079), [FindPackages(String)](packagemanager_findpackages_331793265.md), [FindPackages(String, String)](packagemanager_findpackages_1597689551.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackages +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackages + +## -description +Retrieves information about a specified family of packages installed across all users. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. + +## -remarks + +## -examples +This example uses [FindPackages()](packagemanager_findpackages_1246181969.md) to enumerate the installed packages for all users. + +```csharp +using Windows.Management.Deployment; + +public static int Main(string[] args) +{ + PackageManager packageManager = new PackageManager(); + + IEnumerable packages = + (IEnumerable) packageManager.FindPackages(); + + int packageCount = 0; + foreach (var package in packages) + { + DisplayPackageInfo(package); + + packageCount += 1; + } + + if (packageCount < 1) + { + Console.WriteLine("No packages were found."); + } +} + +private static void DisplayPackageInfo(Windows.ApplicationModel.Package package) +{ + Console.WriteLine("Name: {0}", package.Id.Name); + + Console.WriteLine("FullName: {0}", package.Id.FullName); + + Console.WriteLine("Version: {0}.{1}.{2}.{3}", package.Id.Version.Major, package.Id.Version.Minor, + package.Id.Version.Build, package.Id.Version.Revision); + + Console.WriteLine("Publisher: {0}", package.Id.Publisher); + + Console.WriteLine("PublisherId: {0}", package.Id.PublisherId); + + Console.WriteLine("Installed Location: {0}", package.InstalledLocation.Path); + + Console.WriteLine("IsFramework: {0}", package.IsFramework); +} +``` + +```cpp +using namespace Windows::Management::Deployment; + +[STAThread] +int __cdecl main(Platform::Array^ args) +{ + PackageManager^ packageManager = ref new PackageManager(); + + IIterable^ packages = packageManager->FindPackages(); + + int packageCount = 0; + std::for_each(Windows::Foundation::Collections::begin(packages), Windows::Foundation::Collections::end(packages), + [&](Windows::ApplicationModel::Package^ package) + { + DisplayPackageInfo(package); + + packageCount += 1; + }); + + if ( packageCount < 1 ) + { + wcout << L"No packages were found." << endl; + } + + return 0; +} + +void DisplayPackageInfo(Windows::ApplicationModel::Package^ package) +{ + wcout << L"Name: " << package->Id->Name->Data() << endl; + wcout << L"FullName: " << package->Id->FullName->Data() << endl; + wcout << L"Version: " << package->Id->Version.Major << "." << + package->Id->Version.Minor << "." << package->Id->Version.Build << + "." << package->Id->Version.Revision << endl; + wcout << L"Publisher: " << package->Id->Publisher->Data() << endl; + wcout << L"PublisherId: " << package->Id->PublisherId->Data() << endl; + wcout << L"Installed Location: " << package->InstalledLocation->Path->Data() << endl; + wcout << L"IsFramework: " << (package->IsFramework ? L"True" : L"False") << endl; +} +``` + + + +## -see-also +[Enumerate app packages sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-ee821079), [FindPackages(String)](packagemanager_findpackages_331793265.md), [FindPackages(String, String)](packagemanager_findpackages_1597689551.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackages_1597689551.md b/windows.management.deployment/packagemanager_findpackages_1597689551.md index e9a0f093b8..a3d1bb9ba6 100644 --- a/windows.management.deployment/packagemanager_findpackages_1597689551.md +++ b/windows.management.deployment/packagemanager_findpackages_1597689551.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackages(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackages ## -description Finds all installed packages with the specified name and publisher. ## -parameters ### -param packageName The package name. This parameter cannot be **null**. ### -param packagePublisher The package publisher. This parameter cannot be **null**. ## -returns If the method succeeds, an enumerable collection of package objects with the same package name and publisher name is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. ## -remarks ## -examples ## -see-also [Enumerate app packages by name and publisher sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-fe747b8a), [FindPackages()](packagemanager_findpackages_1246181969.md), [FindPackages(String)](packagemanager_findpackages_331793265.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackages(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackages + +## -description +Finds all installed packages with the specified name and publisher. + +## -parameters +### -param packageName +The package name. This parameter cannot be **null**. + +### -param packagePublisher +The package publisher. This parameter cannot be **null**. + +## -returns +If the method succeeds, an enumerable collection of package objects with the same package name and publisher name is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. + +## -remarks + +## -examples + +## -see-also +[Enumerate app packages by name and publisher sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-fe747b8a), [FindPackages()](packagemanager_findpackages_1246181969.md), [FindPackages(String)](packagemanager_findpackages_331793265.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackages_331793265.md b/windows.management.deployment/packagemanager_findpackages_331793265.md index 96c053f3c7..c25dc40a6b 100644 --- a/windows.management.deployment/packagemanager_findpackages_331793265.md +++ b/windows.management.deployment/packagemanager_findpackages_331793265.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackages(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackages ## -description Retrieves information about a specified family of packages installed across all users. ## -parameters ### -param packageFamilyName The package family name. This parameter cannot be **null**. ## -returns If the method succeeds, an enumerable collection of package objects with the same package family name will be returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. ## -remarks This method requires administrative privileges. Each package in the [IIterable(Package)](../windows.foundation.collections/iiterable_1.md) collection may be installed for the current user or for another user. This method differs from [FindPackages(String packageName, String pulisherName)](packagemanager_findpackages_1597689551.md) method. Here the *packageFamilyName* parameter is a single string, comprised of the package name and package publisher hash. ## -examples ## -see-also [FindPackages()](packagemanager_findpackages_1246181969.md), [FindPackages(String, String)](packagemanager_findpackages_1597689551.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackages(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackages + +## -description +Retrieves information about a specified family of packages installed across all users. + +## -parameters +### -param packageFamilyName +The package family name. This parameter cannot be **null**. + +## -returns +If the method succeeds, an enumerable collection of package objects with the same package family name will be returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. + +## -remarks +This method requires administrative privileges. Each package in the [IIterable(Package)](../windows.foundation.collections/iiterable_1.md) collection may be installed for the current user or for another user. This method differs from [FindPackages(String packageName, String pulisherName)](packagemanager_findpackages_1597689551.md) method. Here the *packageFamilyName* parameter is a single string, comprised of the package name and package publisher hash. + +## -examples + +## -see-also +[FindPackages()](packagemanager_findpackages_1246181969.md), [FindPackages(String, String)](packagemanager_findpackages_1597689551.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagesforuser_2003648348.md b/windows.management.deployment/packagemanager_findpackagesforuser_2003648348.md index a554a3fdf0..5a65bf9428 100644 --- a/windows.management.deployment/packagemanager_findpackagesforuser_2003648348.md +++ b/windows.management.deployment/packagemanager_findpackagesforuser_2003648348.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUser(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesForUser ## -description Retrieves information about a specified family of packages installed for a specific user. ## -parameters ### -param userSecurityId The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. ### -param packageFamilyName The family name of packages to find. This parameter cannot be **null**. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. ## -remarks ## -examples ## -see-also [FindPackagesForUser(String)](packagemanager_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String, String)](packagemanager_findpackagesforuser_292215772.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUser(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesForUser + +## -description +Retrieves information about a specified family of packages installed for a specific user. + +## -parameters +### -param userSecurityId +The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. + +### -param packageFamilyName +The family name of packages to find. This parameter cannot be **null**. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUser(String)](packagemanager_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String, String)](packagemanager_findpackagesforuser_292215772.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagesforuser_292215772.md b/windows.management.deployment/packagemanager_findpackagesforuser_292215772.md index 9e76d20a99..dcb81e4dde 100644 --- a/windows.management.deployment/packagemanager_findpackagesforuser_292215772.md +++ b/windows.management.deployment/packagemanager_findpackagesforuser_292215772.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUser(System.String,System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesForUser ## -description Retrieves information about all packages with the specified package name and publisher name, installed for a specific user. ## -parameters ### -param userSecurityId The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. ### -param packageName The package name. This parameter cannot be **null**. ### -param packagePublisher The package publisher. This parameter cannot be **null**. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. ## -remarks ## -examples ## -see-also [FindPackagesForUser(String)](packagemanager_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String)](packagemanager_findpackagesforuser_2003648348.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUser(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesForUser + +## -description +Retrieves information about all packages with the specified package name and publisher name, installed for a specific user. + +## -parameters +### -param userSecurityId +The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. + +### -param packageName +The package name. This parameter cannot be **null**. + +### -param packagePublisher +The package publisher. This parameter cannot be **null**. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUser(String)](packagemanager_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String)](packagemanager_findpackagesforuser_2003648348.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagesforuser_999371492.md b/windows.management.deployment/packagemanager_findpackagesforuser_999371492.md index 9744aff01c..63f34cb9f1 100644 --- a/windows.management.deployment/packagemanager_findpackagesforuser_999371492.md +++ b/windows.management.deployment/packagemanager_findpackagesforuser_999371492.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUser(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesForUser ## -description Finds all packages installed for the specified user. ## -parameters ### -param userSecurityId The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. ## -remarks This method and its overloads require administrative privileges if the user security ID specified is different from the user security ID of the calling user. Otherwise, an AccessDeniedException is thrown. Similar to the [FindPackages](packagemanager_findpackages_1246181969.md) method, this method and its overloads can be used to enumerate the installed packages for a particular user. ## -examples ## -see-also [Enumerate app packages by user SID sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-5bee970a), [FindPackagesForUser(String, String)](packagemanager_findpackagesforuser_2003648348.md), [FindPackagesForUser(String, String, String)](packagemanager_findpackagesforuser_292215772.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUser(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesForUser + +## -description +Finds all packages installed for the specified user. + +## -parameters +### -param userSecurityId +The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. + +## -remarks +This method and its overloads require administrative privileges if the user security ID specified is different from the user security ID of the calling user. Otherwise, an AccessDeniedException is thrown. Similar to the [FindPackages](packagemanager_findpackages_1246181969.md) method, this method and its overloads can be used to enumerate the installed packages for a particular user. + +## -examples + +## -see-also +[Enumerate app packages by user SID sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-5bee970a), [FindPackagesForUser(String, String)](packagemanager_findpackagesforuser_2003648348.md), [FindPackagesForUser(String, String, String)](packagemanager_findpackagesforuser_292215772.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1110730286.md b/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1110730286.md index c782b5daf7..1832e9aa83 100644 --- a/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1110730286.md +++ b/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1110730286.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes(System.String,System.String,Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes ## -description Retrieves information about a specified family of packages and of specific types that are installed for the specified user. ## -parameters ### -param userSecurityId The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. ### -param packageFamilyName The family name of packages to find. This parameter can't be **null**. ### -param packageTypes A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. ## -remarks ## -examples ## -see-also [FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1875427314.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes(System.String,System.String,Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes + +## -description +Retrieves information about a specified family of packages and of specific types that are installed for the specified user. + +## -parameters +### -param userSecurityId +The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. + +### -param packageFamilyName +The family name of packages to find. This parameter can't be **null**. + +### -param packageTypes +A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1875427314.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1422527170.md b/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1422527170.md index 4c0fdea536..2287d267b5 100644 --- a/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1422527170.md +++ b/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1422527170.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes ## -description Finds packages of specific types that are installed for the specified user. ## -parameters ### -param userSecurityId The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. ### -param packageTypes A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. The *packageTypes* parameter determines the types of packages to return. ## -remarks This method and its overloads require administrative privileges if the user SID specified is different from the user SID of the calling user. Otherwise, an **AccessDeniedException** is thrown. ## -examples ## -see-also [FindPackagesForUserWithPackageTypes(String, String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1875427314.md), [FindPackagesForUserWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1110730286.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes + +## -description +Finds packages of specific types that are installed for the specified user. + +## -parameters +### -param userSecurityId +The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. + +### -param packageTypes +A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. The *packageTypes* parameter determines the types of packages to return. + +## -remarks +This method and its overloads require administrative privileges if the user SID specified is different from the user SID of the calling user. Otherwise, an **AccessDeniedException** is thrown. + +## -examples + +## -see-also +[FindPackagesForUserWithPackageTypes(String, String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1875427314.md), [FindPackagesForUserWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1110730286.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1875427314.md b/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1875427314.md index b5772ee0d0..04e1108f26 100644 --- a/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1875427314.md +++ b/windows.management.deployment/packagemanager_findpackagesforuserwithpackagetypes_1875427314.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes(System.String,System.String,System.String,Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes ## -description Retrieves information about packages of specific types with the specified package name and publisher name, installed for a specific user. ## -parameters ### -param userSecurityId The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. ### -param packageName The package name. This parameter can't be **null**. ### -param packagePublisher The package publisher. This parameter can't be **null**. ### -param packageTypes A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package publisher and family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. ## -remarks ## -examples ## -see-also [FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1110730286.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes(System.String,System.String,System.String,Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesForUserWithPackageTypes + +## -description +Retrieves information about packages of specific types with the specified package name and publisher name, installed for a specific user. + +## -parameters +### -param userSecurityId +The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. + +### -param packageName +The package name. This parameter can't be **null**. + +### -param packagePublisher +The package publisher. This parameter can't be **null**. + +### -param packageTypes +A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package publisher and family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackagesforuserwithpackagetypes_1110730286.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackageswithpackagetypes_1848672836.md b/windows.management.deployment/packagemanager_findpackageswithpackagetypes_1848672836.md index bba4d4274a..003125205b 100644 --- a/windows.management.deployment/packagemanager_findpackageswithpackagetypes_1848672836.md +++ b/windows.management.deployment/packagemanager_findpackageswithpackagetypes_1848672836.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes ## -description Retrieves information about a specified family of packages and specific package types that are installed across all users. ## -parameters ### -param packageFamilyName The package family name. This parameter can't be **null**. ### -param packageTypes A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. ## -returns If the method succeeds, an enumerable collection of package objects with the same package family name is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. ## -remarks ## -examples ## -see-also [FindPackagesWithPackageTypes(PackageTypes)](packagemanager_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackageswithpackagetypes_2026827436.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes + +## -description +Retrieves information about a specified family of packages and specific package types that are installed across all users. + +## -parameters +### -param packageFamilyName +The package family name. This parameter can't be **null**. + +### -param packageTypes +A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. + +## -returns +If the method succeeds, an enumerable collection of package objects with the same package family name is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. + +## -remarks + +## -examples + +## -see-also +[FindPackagesWithPackageTypes(PackageTypes)](packagemanager_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackageswithpackagetypes_2026827436.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackageswithpackagetypes_2026827436.md b/windows.management.deployment/packagemanager_findpackageswithpackagetypes_2026827436.md index c33bcdd444..29ce55d43e 100644 --- a/windows.management.deployment/packagemanager_findpackageswithpackagetypes_2026827436.md +++ b/windows.management.deployment/packagemanager_findpackageswithpackagetypes_2026827436.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes(System.String,System.String,Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes ## -description Finds all installed packages of specific types with the specified name and publisher. ## -parameters ### -param packageName The package name. This parameter can't be **null**. ### -param packagePublisher The package publisher. This parameter can't be **null**. ### -param packageTypes A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. ## -returns If the method succeeds, an enumerable collection of package objects with the same package name and publisher name is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. ## -remarks ## -examples ## -see-also [FindPackagesWithPackageTypes(PackageTypes)](packagemanager_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(String, PackageTypes)](packagemanager_findpackageswithpackagetypes_1848672836.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes(System.String,System.String,Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes + +## -description +Finds all installed packages of specific types with the specified name and publisher. + +## -parameters +### -param packageName +The package name. This parameter can't be **null**. + +### -param packagePublisher +The package publisher. This parameter can't be **null**. + +### -param packageTypes +A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. + +## -returns +If the method succeeds, an enumerable collection of package objects with the same package name and publisher name is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return. + +## -remarks + +## -examples + +## -see-also +[FindPackagesWithPackageTypes(PackageTypes)](packagemanager_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(String, PackageTypes)](packagemanager_findpackageswithpackagetypes_1848672836.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackageswithpackagetypes_447761356.md b/windows.management.deployment/packagemanager_findpackageswithpackagetypes_447761356.md index c1c5a38be2..75cafc4114 100644 --- a/windows.management.deployment/packagemanager_findpackageswithpackagetypes_447761356.md +++ b/windows.management.deployment/packagemanager_findpackageswithpackagetypes_447761356.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes ## -description Retrieves information about specific package types that are installed across all users. ## -parameters ### -param packageTypes A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. ## -returns If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. The *packageTypes* parameter determines the types of packages to return. ## -remarks This method and its overloads require administrative privileges. ## -examples ## -see-also [FindPackagesWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackageswithpackagetypes_2026827436.md), [FindPackagesWithPackageTypes(String, PackageTypes)](packagemanager_findpackageswithpackagetypes_1848672836.md) ## -capabilities packageQuery \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackagesWithPackageTypes + +## -description +Retrieves information about specific package types that are installed across all users. + +## -parameters +### -param packageTypes +A combination of [PackageTypes](packagetypes.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. + +## -returns +If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. The *packageTypes* parameter determines the types of packages to return. + +## -remarks +This method and its overloads require administrative privileges. + +## -examples + +## -see-also +[FindPackagesWithPackageTypes(String, String, PackageTypes)](packagemanager_findpackageswithpackagetypes_2026827436.md), [FindPackagesWithPackageTypes(String, PackageTypes)](packagemanager_findpackageswithpackagetypes_1848672836.md) + +## -capabilities +packageQuery \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_findpackagevolume_953508067.md b/windows.management.deployment/packagemanager_findpackagevolume_953508067.md index 6fce843363..2609a9f50a 100644 --- a/windows.management.deployment/packagemanager_findpackagevolume_953508067.md +++ b/windows.management.deployment/packagemanager_findpackagevolume_953508067.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackageVolume(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackageVolume ## -description Gets the specified volume. ## -parameters ### -param volumeName The volume media ID, which is a GUID value. ## -returns The requested volume. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackageVolume(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackageVolume + +## -description +Gets the specified volume. + +## -parameters +### -param volumeName +The volume media ID, which is a GUID value. + +## -returns +The requested volume. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagemanager_findpackagevolumes_1636276675.md b/windows.management.deployment/packagemanager_findpackagevolumes_1636276675.md index a97c601ac4..0f8e13f2a3 100644 --- a/windows.management.deployment/packagemanager_findpackagevolumes_1636276675.md +++ b/windows.management.deployment/packagemanager_findpackagevolumes_1636276675.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindPackageVolumes --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindPackageVolumes ## -description Gets all the known volumes, regardless of their current state. ## -returns All the known volumes, regardless of their current state. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindPackageVolumes +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindPackageVolumes + +## -description +Gets all the known volumes, regardless of their current state. + +## -returns +All the known volumes, regardless of their current state. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagemanager_findusers_1161384994.md b/windows.management.deployment/packagemanager_findusers_1161384994.md index f46c626677..cf9b2fd366 100644 --- a/windows.management.deployment/packagemanager_findusers_1161384994.md +++ b/windows.management.deployment/packagemanager_findusers_1161384994.md @@ -1,3 +1,139 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.FindUsers(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.FindUsers ## -description Finds the users who have installed the specified package. ## -parameters ### -param packageFullName The full name of the package. This parameter cannot be **null**. ## -returns If the method succeeds, an enumerable collection of package user information objects is returned. Each [PackageUserInformation](packageuserinformation.md) object in this collection contains the user security identifier (user SID) of a user for whom the specified package is installed. If no packages with the specified package full name are found, this method returns an empty list. ## -remarks This method requires administrative privileges. ## -examples Call the [PackageManager.FindUsers](packagemanager_findusers.md) method to enumerate the users who have installed a package. This example displays the information in the [PackageUserInformation.UserSecurityId](packageuserinformation_usersecurityid.md) property. ```csharp using System.Security.Principal; using Windows.Deployment.PackageManager; private static void DisplayPackageUsers( PackageManager packageManager, Windows.ApplicationModel.Package package) { IEnumerable packageUsers = packageManager.FindUsers( package.Id.FullName); Console.Write("Users: "); foreach (var packageUser in packageUsers) { Console.Write("{0} ", SidToAccountName(packageUser.UserSecurityId)); } Console.WriteLine(); } private static string SidToAccountName(string sidString) { SecurityIdentifier sid = new SecurityIdentifier(sidString); try { NTAccount account = (NTAccount)sid.Translate(typeof(NTAccount)); return account.ToString(); } catch (IdentityNotMappedException) { return sidString; } } ``` ```cpp using Windows::Management::Deployment; void DisplayPackageUsers( PackageManager^ packageManager, Windows::ApplicationModel::Package^ package) { IIterable^ packageUsers = packageManager->FindUsers( package->Id->FullName); wcout << L"Users: "; std::for_each(begin(packageUsers), end(packageUsers), [&](PackageUserInformation^ packageUser) { wstring stringSid; SidToAccountName(packageUser->UserSecurityId->Data(), stringSid); wcout << stringSid << L" "; }); wcout << endl; } void SidToAccountName(wstring sidString, wstring& stringSid) { PSID sid = NULL; if ( ConvertStringSidToSid(sidString.c_str(), &sid) ) { DWORD nameCharCount = 0; DWORD domainNameCharCount = 0; SID_NAME_USE sidType; // determine how much space is required to store the name and domainName LookupAccountSid(NULL, sid, NULL, &nameCharCount, NULL, &domainNameCharCount, &sidType); wchar_t *name = new wchar_t[nameCharCount + 1]; // leave space for terminating null wchar_t *domainName = new wchar_t[domainNameCharCount + 1]; ZeroMemory(name, (nameCharCount + 1) * sizeof(wchar_t)); ZeroMemory(domainName, (domainNameCharCount + 1) * sizeof(wchar_t)); try { if ( LookupAccountSid(NULL, sid, name, &nameCharCount, domainName, &domainNameCharCount, &sidType) ) { stringSid = domainName; stringSid = stringSid + L"\\" + name; } } catch ( ... ) { // do nothing, original SID will be used. } delete [] domainName; delete [] name; } if ( stringSid.length() == 0 ) stringSid = sidString; if ( sid != NULL ) LocalFree(sid); } ``` ## -see-also [Enumerate app packages sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-ee821079), [Enumerate app packages by name and publisher sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-fe747b8a) ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.FindUsers(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.FindUsers + +## -description +Finds the users who have installed the specified package. + +## -parameters +### -param packageFullName +The full name of the package. This parameter cannot be **null**. + +## -returns +If the method succeeds, an enumerable collection of package user information objects is returned. Each [PackageUserInformation](packageuserinformation.md) object in this collection contains the user security identifier (user SID) of a user for whom the specified package is installed. If no packages with the specified package full name are found, this method returns an empty list. + +## -remarks +This method requires administrative privileges. + +## -examples +Call the [PackageManager.FindUsers](packagemanager_findusers.md) method to enumerate the users who have installed a package. This example displays the information in the [PackageUserInformation.UserSecurityId](packageuserinformation_usersecurityid.md) property. + +```csharp + +using System.Security.Principal; +using Windows.Deployment.PackageManager; + +private static void DisplayPackageUsers( + PackageManager packageManager, + Windows.ApplicationModel.Package package) +{ + IEnumerable packageUsers = packageManager.FindUsers( + package.Id.FullName); + + Console.Write("Users: "); + + foreach (var packageUser in packageUsers) + { + Console.Write("{0} ", SidToAccountName(packageUser.UserSecurityId)); + } + + Console.WriteLine(); +} + +private static string SidToAccountName(string sidString) +{ + SecurityIdentifier sid = new SecurityIdentifier(sidString); + try + { + NTAccount account = (NTAccount)sid.Translate(typeof(NTAccount)); + return account.ToString(); + } + catch (IdentityNotMappedException) + { + return sidString; + } +} +``` + +```cpp +using Windows::Management::Deployment; + +void DisplayPackageUsers( + PackageManager^ packageManager, + Windows::ApplicationModel::Package^ package) +{ + IIterable^ packageUsers = packageManager->FindUsers( + package->Id->FullName); + + wcout << L"Users: "; + + std::for_each(begin(packageUsers), end(packageUsers), + [&](PackageUserInformation^ packageUser) + { + wstring stringSid; + + SidToAccountName(packageUser->UserSecurityId->Data(), stringSid); + + wcout << stringSid << L" "; + }); + wcout << endl; +} + +void SidToAccountName(wstring sidString, wstring& stringSid) +{ + PSID sid = NULL; + + if ( ConvertStringSidToSid(sidString.c_str(), &sid) ) + { + DWORD nameCharCount = 0; + DWORD domainNameCharCount = 0; + SID_NAME_USE sidType; + + // determine how much space is required to store the name and domainName + LookupAccountSid(NULL, sid, NULL, &nameCharCount, NULL, &domainNameCharCount, &sidType); + + wchar_t *name = new wchar_t[nameCharCount + 1]; // leave space for terminating null + wchar_t *domainName = new wchar_t[domainNameCharCount + 1]; + + ZeroMemory(name, (nameCharCount + 1) * sizeof(wchar_t)); + ZeroMemory(domainName, (domainNameCharCount + 1) * sizeof(wchar_t)); + + try + { + if ( LookupAccountSid(NULL, sid, name, &nameCharCount, domainName, &domainNameCharCount, &sidType) ) + { + stringSid = domainName; + stringSid = stringSid + L"\\" + name; + } + } + catch ( ... ) + { + // do nothing, original SID will be used. + } + + delete [] domainName; + delete [] name; + } + + if ( stringSid.length() == 0 ) + stringSid = sidString; + + if ( sid != NULL ) + LocalFree(sid); +} +``` + + + +## -see-also +[Enumerate app packages sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-ee821079), [Enumerate app packages by name and publisher sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-fe747b8a) + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_getdefaultpackagevolume_890507201.md b/windows.management.deployment/packagemanager_getdefaultpackagevolume_890507201.md index bc39035270..3573197db2 100644 --- a/windows.management.deployment/packagemanager_getdefaultpackagevolume_890507201.md +++ b/windows.management.deployment/packagemanager_getdefaultpackagevolume_890507201.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.GetDefaultPackageVolume --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.GetDefaultPackageVolume ## -description Gets the default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. ## -returns The default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.GetDefaultPackageVolume +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.GetDefaultPackageVolume + +## -description +Gets the default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. + +## -returns +The default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_getpackagevolumesasync_766060862.md b/windows.management.deployment/packagemanager_getpackagevolumesasync_766060862.md index 5ff61451d8..d687be9d34 100644 --- a/windows.management.deployment/packagemanager_getpackagevolumesasync_766060862.md +++ b/windows.management.deployment/packagemanager_getpackagevolumesasync_766060862.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.GetPackageVolumesAsync --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.GetPackageVolumesAsync ## -description Gets the package volumes on the device. ## -returns Returns an asynchronous operation that completes with the package volumes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.GetPackageVolumesAsync +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.GetPackageVolumesAsync + +## -description +Gets the package volumes on the device. + +## -returns +Returns an asynchronous operation that completes with the package volumes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagemanager_movepackagetovolumeasync_1514431521.md b/windows.management.deployment/packagemanager_movepackagetovolumeasync_1514431521.md index b02fbc798f..ceb71b0b52 100644 --- a/windows.management.deployment/packagemanager_movepackagetovolumeasync_1514431521.md +++ b/windows.management.deployment/packagemanager_movepackagetovolumeasync_1514431521.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.MovePackageToVolumeAsync(System.String,Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.MovePackageToVolumeAsync ## -description Moves the specified package to the specified volume using the specified deployment options. ## -parameters ### -param packageFullName The full name of the package to move. ### -param deploymentOptions One of the enumeration values that specifies a deployment option. ### -param targetVolume The target volume. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks This method lets the caller move a package from one logical volume to another. ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.MovePackageToVolumeAsync(System.String,Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.MovePackageToVolumeAsync + +## -description +Moves the specified package to the specified volume using the specified deployment options. + +## -parameters +### -param packageFullName +The full name of the package to move. + +### -param deploymentOptions +One of the enumeration values that specifies a deployment option. + +### -param targetVolume +The target volume. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks +This method lets the caller move a package from one logical volume to another. + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_packagemanager_1221375020.md b/windows.management.deployment/packagemanager_packagemanager_1221375020.md index eb4290d63a..56eec5ef51 100644 --- a/windows.management.deployment/packagemanager_packagemanager_1221375020.md +++ b/windows.management.deployment/packagemanager_packagemanager_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.#ctor --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.PackageManager ## -description Creates and initializes a new instance of the object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.#ctor +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.PackageManager + +## -description +Creates and initializes a new instance of the object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagemanager_registerpackageasync_1668904418.md b/windows.management.deployment/packagemanager_registerpackageasync_1668904418.md index 153dcc8151..0e57a13c64 100644 --- a/windows.management.deployment/packagemanager_registerpackageasync_1668904418.md +++ b/windows.management.deployment/packagemanager_registerpackageasync_1668904418.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.RegisterPackageAsync ## -description Registers a package (the main package) and its dependency packages on the specified volume for the current user, using the specified deployment options. ## -parameters ### -param manifestUri The Uri of the main package. ### -param dependencyPackageUris The Uris of the dependency packages. ### -param deploymentOptions A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration that specify deployment options. ### -param appDataVolume The volume on which the app stores data for the current user. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also [RegisterPackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_registerpackageasync_593568238.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RegisterPackageAsync + +## -description +Registers a package (the main package) and its dependency packages on the specified volume for the current user, using the specified deployment options. + +## -parameters +### -param manifestUri +The Uri of the main package. + +### -param dependencyPackageUris +The Uris of the dependency packages. + +### -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration that specify deployment options. + +### -param appDataVolume +The volume on which the app stores data for the current user. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also +[RegisterPackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_registerpackageasync_593568238.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_registerpackageasync_593568238.md b/windows.management.deployment/packagemanager_registerpackageasync_593568238.md index 95af1e2f98..188431840e 100644 --- a/windows.management.deployment/packagemanager_registerpackageasync_593568238.md +++ b/windows.management.deployment/packagemanager_registerpackageasync_593568238.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.RegisterPackageAsync ## -description Registers a package (the main package) and its dependency packages for the current user, using the specified deployment options. ## -parameters ### -param manifestUri The Uri of the main package. ### -param dependencyPackageUris The Uris of the dependency packages. ### -param deploymentOptions A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration that specify deployment options. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also [RegisterPackageAsync(Uri, IIterable(Uri), DeploymentOptions, PackageVolume)](packagemanager_registerpackageasync_1668904418.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RegisterPackageAsync + +## -description +Registers a package (the main package) and its dependency packages for the current user, using the specified deployment options. + +## -parameters +### -param manifestUri +The Uri of the main package. + +### -param dependencyPackageUris +The Uris of the dependency packages. + +### -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration that specify deployment options. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also +[RegisterPackageAsync(Uri, IIterable(Uri), DeploymentOptions, PackageVolume)](packagemanager_registerpackageasync_1668904418.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_registerpackagebyfullnameasync_828314124.md b/windows.management.deployment/packagemanager_registerpackagebyfullnameasync_828314124.md index d0c982ed12..af9f7630c7 100644 --- a/windows.management.deployment/packagemanager_registerpackagebyfullnameasync_828314124.md +++ b/windows.management.deployment/packagemanager_registerpackagebyfullnameasync_828314124.md @@ -1,3 +1,39 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageByFullNameAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Management.Deployment.DeploymentOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.RegisterPackageByFullNameAsync ## -description Registers a package (the main package) by its full name and its dependency packages for the current user. ## -parameters ### -param mainPackageFullName A string that specifies the full name of the main package to be registered. ### -param dependencyPackageFullNames Strings that specify the full names of the dependency packages to be registered. ### -param deploymentOptions A [DeploymentOptions](deploymentoptions.md)-typed value that specifies the package deployment option. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks To hide specifics about the manifest of a bundle package, instead of calling [RegisterPackageAsync](packagemanager_registerpackageasync.md), you can call [RegisterPackageByFullNameAsync](packagemanager_registerpackagebyfullnameasync.md) to register a package by its full name. Bundle packages and regular packages are both referenced by the common package full name and thus registration by full name reduces the amount of domain knowledge required by the caller. [RegisterPackageByFullNameAsync](packagemanager_registerpackagebyfullnameasync.md) can't install a package for any user other than the caller. The *dependencyPackageFullNames* can contain 0 elements if there aren't any dependency packages. ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageByFullNameAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Management.Deployment.DeploymentOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RegisterPackageByFullNameAsync + +## -description +Registers a package (the main package) by its full name and its dependency packages for the current user. + +## -parameters +### -param mainPackageFullName +A string that specifies the full name of the main package to be registered. + +### -param dependencyPackageFullNames +Strings that specify the full names of the dependency packages to be registered. + +### -param deploymentOptions +A [DeploymentOptions](deploymentoptions.md)-typed value that specifies the package deployment option. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks +To hide specifics about the manifest of a bundle package, instead of calling [RegisterPackageAsync](packagemanager_registerpackageasync.md), you can call [RegisterPackageByFullNameAsync](packagemanager_registerpackagebyfullnameasync.md) to register a package by its full name. Bundle packages and regular packages are both referenced by the common package full name and thus registration by full name reduces the amount of domain knowledge required by the caller. + +[RegisterPackageByFullNameAsync](packagemanager_registerpackagebyfullnameasync.md) can't install a package for any user other than the caller. The *dependencyPackageFullNames* can contain 0 elements if there aren't any dependency packages. + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_removepackageasync_1124236459.md b/windows.management.deployment/packagemanager_removepackageasync_1124236459.md index e3091a315b..6001a08995 100644 --- a/windows.management.deployment/packagemanager_removepackageasync_1124236459.md +++ b/windows.management.deployment/packagemanager_removepackageasync_1124236459.md @@ -1,3 +1,139 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.RemovePackageAsync(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.RemovePackageAsync ## -description Removes a package for the current user asynchronously and receives progress and status messages on the removal operation. Dependency packages are also removed for the user if no other packages installed for the user depend on them. ## -parameters ### -param packageFullName A string representation of the package identity to identify the package to be removed. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks This request cannot be canceled. The package full name is an alternate form of the package identity that is shorter and is suitable for naming objects such as files and directories. A package identity is represented by the [Identity](http://msdn.microsoft.com/library/45524773-3b61-44ac-a417-cfaac92af0a0) element of the package manifest. When a package is removed it is removed for the current user, which means that the package payload continues to exist if other users have installed the package, but it will not be accessible to the current user. If no other users have the specified package installed, its payload will be removed from the %ProgramFiles%\WindowsApps directory. Any app associated with the package that is being removed will be shutdown automatically as part of the package removal. ## -examples Call the [RemovePackageAsync(String)](packagemanager_removepackageasync_1124236459.md) method to uninstall the app package. Notice that the package full name in *packageFullName* comes from a command-line argument. [RemovePackageAsync(String)](packagemanager_removepackageasync_1124236459.md) returns an object that can be used to manage the asynchronous operation. Use the [Completed](../windows.foundation/iasyncoperationwithprogress_2_completed.md) property to set the [delegate](../windows.foundation/asyncoperationwithprogresscompletedhandler_2.md). Check the [Status](../windows.foundation/iasyncinfo_status.md) property to determine the status of the deployment operation. If the status is **Error**, the example calls the [GetResults](../windows.foundation/iasyncoperationwithprogress_2_getresults.md) method to get additional error information. ```csharp using Windows.Foundation; using Windows.Management.Deployment; [STAThread] public static int Main(string[] args) { string inputPackageFullName = args[0]; int returnValue = 0; PackageManager packageManager = new Windows.Management.Deployment.PackageManager(); IAsyncOperationWithProgress deploymentOperation = packageManager.RemovePackageAsync(inputPackageFullName); // This event is signaled when the operation completes ManualResetEvent opCompletedEvent = new ManualResetEvent(false); // Define the delegate using a statement lambda deploymentOperation.Completed = (depProgress, status) => { opCompletedEvent.Set(); }; // Wait until the operation completes opCompletedEvent.WaitOne(); // Check the status of the operation if (deploymentOperation.Status == AsyncStatus.Error) { DeploymentResult deploymentResult = deploymentOperation.GetResults(); Console.WriteLine("Error code: {0}", deploymentOperation.ErrorCode); Console.WriteLine("Error text: {0}", deploymentResult.ErrorText); returnValue = 1; } else if (deploymentOperation.Status == AsyncStatus.Canceled) { Console.WriteLine("Removal canceled"); } else if (deploymentOperation.Status == AsyncStatus.Completed) { Console.WriteLine("Removal succeeded"); } else { returnValue = 1; Console.WriteLine("Removal status unknown"); } return returnValue; } ``` ```cpp using namespace Platform; using namespace Windows::Foundation; using namespace Windows::Management::Deployment; int __cdecl main(Platform::Array^ args) { String^ inputPackageFullName = args[1]; int returnValue = 0; PackageManager^ packageManager = ref new PackageManager(); auto deploymentOperation = packageManager->RemovePackageAsync(inputPackageFullName); DeploymentResult^ deploymentOperationResult; // This event is signaled when the operation completes opCompletedEvent = CreateEvent(NULL, TRUE, FALSE, NULL); // Define the delegate deploymentOperation->Completed = ref new AsyncOperationWithProgressCompletedHandler( [&](IAsyncOperationWithProgress^ operation, AsyncStatus) { SetEvent(opCompletedEvent); }); // Wait until the operation completes WaitForSingleObject(opCompletedEvent, INFINITE); // Check the status of the operation if ( deploymentOperation->Status == AsyncStatus::Error ) { auto deploymentResult = deploymentOperation->GetResults(); wcout << L"Removal Error: " << deploymentOperation->ErrorCode.Value << endl; wcout << L"Detailed Error Text: " << deploymentResult->ErrorText->Data() << endl; returnValue = 1; } else if ( deploymentOperation->Status == AsyncStatus::Canceled ) { wcout << L"Removal Canceled" << endl; } else if ( deploymentOperation->Status == AsyncStatus::Completed ) { wcout << L"Removal succeeded!" << endl; } else { wcout << L"Removal status unknown" << endl; returnValue = 1; } return returnValue; } ``` ## -see-also [RemovePackageAsync(String, RemovalOptions)](packagemanager_removepackageasync_1331217245.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RemovePackageAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RemovePackageAsync + +## -description +Removes a package for the current user asynchronously and receives progress and status messages on the removal operation. Dependency packages are also removed for the user if no other packages installed for the user depend on them. + +## -parameters +### -param packageFullName +A string representation of the package identity to identify the package to be removed. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks +This request cannot be canceled. The package full name is an alternate form of the package identity that is shorter and is suitable for naming objects such as files and directories. A package identity is represented by the [Identity](http://msdn.microsoft.com/library/45524773-3b61-44ac-a417-cfaac92af0a0) element of the package manifest. When a package is removed it is removed for the current user, which means that the package payload continues to exist if other users have installed the package, but it will not be accessible to the current user. If no other users have the specified package installed, its payload will be removed from the %ProgramFiles%\WindowsApps directory. Any app associated with the package that is being removed will be shutdown automatically as part of the package removal. + +## -examples +Call the [RemovePackageAsync(String)](packagemanager_removepackageasync_1124236459.md) method to uninstall the app package. Notice that the package full name in *packageFullName* comes from a command-line argument. + +[RemovePackageAsync(String)](packagemanager_removepackageasync_1124236459.md) returns an object that can be used to manage the asynchronous operation. Use the [Completed](../windows.foundation/iasyncoperationwithprogress_2_completed.md) property to set the [delegate](../windows.foundation/asyncoperationwithprogresscompletedhandler_2.md). Check the [Status](../windows.foundation/iasyncinfo_status.md) property to determine the status of the deployment operation. If the status is **Error**, the example calls the [GetResults](../windows.foundation/iasyncoperationwithprogress_2_getresults.md) method to get additional error information. + +```csharp + +using Windows.Foundation; +using Windows.Management.Deployment; + +[STAThread] +public static int Main(string[] args) +{ + string inputPackageFullName = args[0]; + int returnValue = 0; + + PackageManager packageManager = new Windows.Management.Deployment.PackageManager(); + + IAsyncOperationWithProgress deploymentOperation = + packageManager.RemovePackageAsync(inputPackageFullName); + // This event is signaled when the operation completes + ManualResetEvent opCompletedEvent = new ManualResetEvent(false); + + // Define the delegate using a statement lambda + deploymentOperation.Completed = (depProgress, status) => { opCompletedEvent.Set(); }; + + // Wait until the operation completes + opCompletedEvent.WaitOne(); + + // Check the status of the operation + if (deploymentOperation.Status == AsyncStatus.Error) + { + DeploymentResult deploymentResult = deploymentOperation.GetResults(); + Console.WriteLine("Error code: {0}", deploymentOperation.ErrorCode); + Console.WriteLine("Error text: {0}", deploymentResult.ErrorText); + returnValue = 1; + } + else if (deploymentOperation.Status == AsyncStatus.Canceled) + { + Console.WriteLine("Removal canceled"); + } + else if (deploymentOperation.Status == AsyncStatus.Completed) + { + Console.WriteLine("Removal succeeded"); + } + else + { + returnValue = 1; + Console.WriteLine("Removal status unknown"); + } + + return returnValue; +} +``` + +```cpp +using namespace Platform; +using namespace Windows::Foundation; +using namespace Windows::Management::Deployment; + +int __cdecl main(Platform::Array^ args) +{ + String^ inputPackageFullName = args[1]; + int returnValue = 0; + + PackageManager^ packageManager = ref new PackageManager(); + + auto deploymentOperation = packageManager->RemovePackageAsync(inputPackageFullName); + + DeploymentResult^ deploymentOperationResult; + + // This event is signaled when the operation completes + opCompletedEvent = CreateEvent(NULL, TRUE, FALSE, NULL); + + // Define the delegate + deploymentOperation->Completed = + ref new AsyncOperationWithProgressCompletedHandler( + [&](IAsyncOperationWithProgress^ operation, AsyncStatus) + { + SetEvent(opCompletedEvent); + }); + + // Wait until the operation completes + WaitForSingleObject(opCompletedEvent, INFINITE); + + // Check the status of the operation + if ( deploymentOperation->Status == AsyncStatus::Error ) + { + auto deploymentResult = deploymentOperation->GetResults(); + wcout << L"Removal Error: " << deploymentOperation->ErrorCode.Value << endl; + wcout << L"Detailed Error Text: " << deploymentResult->ErrorText->Data() << endl; + returnValue = 1; + } + else if ( deploymentOperation->Status == AsyncStatus::Canceled ) + { + wcout << L"Removal Canceled" << endl; + } + else if ( deploymentOperation->Status == AsyncStatus::Completed ) + { + wcout << L"Removal succeeded!" << endl; + } + else + { + wcout << L"Removal status unknown" << endl; + returnValue = 1; + } + + return returnValue; +} +``` + + + +## -see-also +[RemovePackageAsync(String, RemovalOptions)](packagemanager_removepackageasync_1331217245.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_removepackageasync_1331217245.md b/windows.management.deployment/packagemanager_removepackageasync_1331217245.md index 659e5be866..97de69b432 100644 --- a/windows.management.deployment/packagemanager_removepackageasync_1331217245.md +++ b/windows.management.deployment/packagemanager_removepackageasync_1331217245.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.RemovePackageAsync(System.String,Windows.Management.Deployment.RemovalOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.RemovePackageAsync ## -description Removes a package for the current user asynchronously and receives progress and status messages on the removal operation. Dependency packages are also removed for the user if no other packages installed for the user depend on them. ## -parameters ### -param packageFullName A string representation of the package identity to identify the package to be removed. ### -param removalOptions A [RemovalOptions](removaloptions.md)-typed value that modifies the removal operation. ## -returns A pointer that receives the address of an object that implements the [IAsyncOperationWithProgress](../windows.foundation/iasyncoperationwithprogress_2.md) interface. ## -remarks ## -examples ## -see-also [RemovePackageAsync(String)](packagemanager_removepackageasync_1124236459.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RemovePackageAsync(System.String,Windows.Management.Deployment.RemovalOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RemovePackageAsync + +## -description +Removes a package for the current user asynchronously and receives progress and status messages on the removal operation. Dependency packages are also removed for the user if no other packages installed for the user depend on them. + +## -parameters +### -param packageFullName +A string representation of the package identity to identify the package to be removed. + +### -param removalOptions +A [RemovalOptions](removaloptions.md)-typed value that modifies the removal operation. + +## -returns +A pointer that receives the address of an object that implements the [IAsyncOperationWithProgress](../windows.foundation/iasyncoperationwithprogress_2.md) interface. + +## -remarks + +## -examples + +## -see-also +[RemovePackageAsync(String)](packagemanager_removepackageasync_1124236459.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_removepackagevolumeasync_1461863565.md b/windows.management.deployment/packagemanager_removepackagevolumeasync_1461863565.md index 6f332bbfe9..a3aaede73c 100644 --- a/windows.management.deployment/packagemanager_removepackagevolumeasync_1461863565.md +++ b/windows.management.deployment/packagemanager_removepackagevolumeasync_1461863565.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.RemovePackageVolumeAsync(Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.RemovePackageVolumeAsync ## -description Removes the specified volume. ## -parameters ### -param volume The volume to remove. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RemovePackageVolumeAsync(Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RemovePackageVolumeAsync + +## -description +Removes the specified volume. + +## -parameters +### -param volume +The volume to remove. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagemanager_setdefaultpackagevolume_307650699.md b/windows.management.deployment/packagemanager_setdefaultpackagevolume_307650699.md index dfc7196805..35ac2a4638 100644 --- a/windows.management.deployment/packagemanager_setdefaultpackagevolume_307650699.md +++ b/windows.management.deployment/packagemanager_setdefaultpackagevolume_307650699.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.SetDefaultPackageVolume(Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.SetDefaultPackageVolume ## -description Sets the default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. ## -parameters ### -param volume The default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.SetDefaultPackageVolume(Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.SetDefaultPackageVolume + +## -description +Sets the default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. + +## -parameters +### -param volume +The default package volume, which is the target of deployment operations such as the [AddPackageAsync](packagemanager_addpackageasync.md) method. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_setpackagestate_175933383.md b/windows.management.deployment/packagemanager_setpackagestate_175933383.md index 86df8b92e9..4051769477 100644 --- a/windows.management.deployment/packagemanager_setpackagestate_175933383.md +++ b/windows.management.deployment/packagemanager_setpackagestate_175933383.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.SetPackageState(System.String,Windows.Management.Deployment.PackageState) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.SetPackageState ## -description Sets the state of a package, for example, to usable, tampered with, and so on. ## -parameters ### -param packageFullName The full name of the package. ### -param packageState One of the enumeration values. ## -remarks When [SetPackageState](packagemanager_setpackagestate.md) is used with a [PackageState](packagestate.md) of **Tampered**, all processes that are part of the package are terminated. If the package is a framework package, all processes for all packages that depend on the framework are also terminated. This method requires administrative privileges and alters the status for all users. ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.SetPackageState(System.String,Windows.Management.Deployment.PackageState) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.SetPackageState + +## -description +Sets the state of a package, for example, to usable, tampered with, and so on. + +## -parameters +### -param packageFullName +The full name of the package. + +### -param packageState +One of the enumeration values. + +## -remarks +When [SetPackageState](packagemanager_setpackagestate.md) is used with a [PackageState](packagestate.md) of **Tampered**, all processes that are part of the package are terminated. If the package is a framework package, all processes for all packages that depend on the framework are also terminated. This method requires administrative privileges + +and alters the status for all users. + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_setpackagestatus_823303881.md b/windows.management.deployment/packagemanager_setpackagestatus_823303881.md index 58e79eafe1..f6cc4386d2 100644 --- a/windows.management.deployment/packagemanager_setpackagestatus_823303881.md +++ b/windows.management.deployment/packagemanager_setpackagestatus_823303881.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.SetPackageStatus(System.String,Windows.Management.Deployment.PackageStatus) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.SetPackageStatus ## -description Sets the status of the specified package. ## -parameters ### -param packageFullName The full name of the package. ### -param status One of the enumeration values that describes the status of the package. ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.SetPackageStatus(System.String,Windows.Management.Deployment.PackageStatus) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.SetPackageStatus + +## -description +Sets the status of the specified package. + +## -parameters +### -param packageFullName +The full name of the package. + +### -param status +One of the enumeration values that describes the status of the package. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_setpackagevolumeofflineasync_527141871.md b/windows.management.deployment/packagemanager_setpackagevolumeofflineasync_527141871.md index 6173dd2ec8..95602de014 100644 --- a/windows.management.deployment/packagemanager_setpackagevolumeofflineasync_527141871.md +++ b/windows.management.deployment/packagemanager_setpackagevolumeofflineasync_527141871.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.SetPackageVolumeOfflineAsync(Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.SetPackageVolumeOfflineAsync ## -description Sets the specified volume to an offline state. The caller must be a member of the administrators group. ## -parameters ### -param packageVolume The volume to take offline. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.SetPackageVolumeOfflineAsync(Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.SetPackageVolumeOfflineAsync + +## -description +Sets the specified volume to an offline state. The caller must be a member of the administrators group. + +## -parameters +### -param packageVolume +The volume to take offline. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_setpackagevolumeonlineasync_1263659823.md b/windows.management.deployment/packagemanager_setpackagevolumeonlineasync_1263659823.md index f116ab2093..90400b3282 100644 --- a/windows.management.deployment/packagemanager_setpackagevolumeonlineasync_1263659823.md +++ b/windows.management.deployment/packagemanager_setpackagevolumeonlineasync_1263659823.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.SetPackageVolumeOnlineAsync(Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.SetPackageVolumeOnlineAsync ## -description Sets the specified volume to an online state. The caller must be a member of the administrators group. ## -parameters ### -param packageVolume The volume to bring online. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.SetPackageVolumeOnlineAsync(Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.SetPackageVolumeOnlineAsync + +## -description +Sets the specified volume to an online state. The caller must be a member of the administrators group. + +## -parameters +### -param packageVolume +The volume to bring online. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_stagepackageasync_1546392990.md b/windows.management.deployment/packagemanager_stagepackageasync_1546392990.md index 69d88899ab..727f2b848d 100644 --- a/windows.management.deployment/packagemanager_stagepackageasync_1546392990.md +++ b/windows.management.deployment/packagemanager_stagepackageasync_1546392990.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.StagePackageAsync ## -description Stages a package to the system without registering it. ## -parameters ### -param packageUri The source URI of the main package. ### -param dependencyPackageUris The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. ### -param deploymentOptions A combination of [DeploymentOptions](deploymentoptions.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the package deployment options. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks ## -examples ## -see-also [StagePackageAsync(Uri, IIterable(Uri))](packagemanager_stagepackageasync_1881962702.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StagePackageAsync + +## -description +Stages a package to the system without registering it. + +## -parameters +### -param packageUri +The source URI of the main package. + +### -param dependencyPackageUris +The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. + +### -param deploymentOptions +A combination of [DeploymentOptions](deploymentoptions.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies the package deployment options. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks + +## -examples + +## -see-also +[StagePackageAsync(Uri, IIterable(Uri))](packagemanager_stagepackageasync_1881962702.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_stagepackageasync_1881962702.md b/windows.management.deployment/packagemanager_stagepackageasync_1881962702.md index 947ab349b5..0e979f0716 100644 --- a/windows.management.deployment/packagemanager_stagepackageasync_1881962702.md +++ b/windows.management.deployment/packagemanager_stagepackageasync_1881962702.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.StagePackageAsync ## -description Stages a package to the system without registering it. ## -parameters ### -param packageUri The source URI of the main package. ### -param dependencyPackageUris The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks The stage operation will extract the package payload to disk under %ProgramFiles%\WindowsApps. ## -examples ## -see-also [StagePackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_stagepackageasync_1546392990.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StagePackageAsync + +## -description +Stages a package to the system without registering it. + +## -parameters +### -param packageUri +The source URI of the main package. + +### -param dependencyPackageUris +The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks +The stage operation will extract the package payload to disk under %ProgramFiles%\WindowsApps. + +## -examples + +## -see-also +[StagePackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_stagepackageasync_1546392990.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_stagepackageasync_473186706.md b/windows.management.deployment/packagemanager_stagepackageasync_473186706.md index 22992123f8..364192329d 100644 --- a/windows.management.deployment/packagemanager_stagepackageasync_473186706.md +++ b/windows.management.deployment/packagemanager_stagepackageasync_473186706.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.StagePackageAsync ## -description Stages a package to the system without registering it. ## -parameters ### -param packageUri The source URI of the main package. ### -param dependencyPackageUris The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. ### -param deploymentOptions A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. The resulting value specifies the package deployment options. ### -param targetVolume The target volume on which to stage the package. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also [StagePackageAsync(Uri, IIterable(Uri))](packagemanager_stagepackageasync_1881962702.md), [StagePackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_stagepackageasync_1546392990.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StagePackageAsync + +## -description +Stages a package to the system without registering it. + +## -parameters +### -param packageUri +The source URI of the main package. + +### -param dependencyPackageUris +The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. + +### -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. The resulting value specifies the package deployment options. + +### -param targetVolume +The target volume on which to stage the package. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also +[StagePackageAsync(Uri, IIterable(Uri))](packagemanager_stagepackageasync_1881962702.md), [StagePackageAsync(Uri, IIterable(Uri), DeploymentOptions)](packagemanager_stagepackageasync_1546392990.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_stageuserdataasync_1037604209.md b/windows.management.deployment/packagemanager_stageuserdataasync_1037604209.md index 69cdb4d179..d986426df2 100644 --- a/windows.management.deployment/packagemanager_stageuserdataasync_1037604209.md +++ b/windows.management.deployment/packagemanager_stageuserdataasync_1037604209.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.StageUserDataAsync(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.StageUserDataAsync ## -description Stages a package's roaming data to the system without registering the package. Call this method after staging the package but before registering the package for a particular user. ## -parameters ### -param packageFullName The full name of the package. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also [StageUserDataAsync(String, DeploymentOptions)](packagemanager_stageuserdataasync_1411865639.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StageUserDataAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StageUserDataAsync + +## -description +Stages a package's roaming data to the system without registering the package. Call this method after staging the package but before registering the package for a particular user. + +## -parameters +### -param packageFullName +The full name of the package. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also +[StageUserDataAsync(String, DeploymentOptions)](packagemanager_stageuserdataasync_1411865639.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_stageuserdataasync_1411865639.md b/windows.management.deployment/packagemanager_stageuserdataasync_1411865639.md index ec2af2ec4a..cc36ae1d26 100644 --- a/windows.management.deployment/packagemanager_stageuserdataasync_1411865639.md +++ b/windows.management.deployment/packagemanager_stageuserdataasync_1411865639.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.StageUserDataAsync(System.String,Windows.Management.Deployment.DeploymentOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.StageUserDataAsync ## -description Stages a package's roaming data to the system without registering the package. Call this method after staging the package but before registering the package for a particular user. ## -parameters ### -param packageFullName The full name of the package. ### -param deploymentOptions A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration that specify deployment options. ## -returns An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. ## -remarks ## -examples ## -see-also [StageUserDataAsync(String)](packagemanager_stageuserdataasync_1037604209.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StageUserDataAsync(System.String,Windows.Management.Deployment.DeploymentOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StageUserDataAsync + +## -description +Stages a package's roaming data to the system without registering the package. Call this method after staging the package but before registering the package for a particular user. + +## -parameters +### -param packageFullName +The full name of the package. + +### -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration that specify deployment options. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -examples + +## -see-also +[StageUserDataAsync(String)](packagemanager_stageuserdataasync_1037604209.md) \ No newline at end of file diff --git a/windows.management.deployment/packagemanager_updatepackageasync_1181217661.md b/windows.management.deployment/packagemanager_updatepackageasync_1181217661.md index 6a87a60456..3d39f9b454 100644 --- a/windows.management.deployment/packagemanager_updatepackageasync_1181217661.md +++ b/windows.management.deployment/packagemanager_updatepackageasync_1181217661.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Management.Deployment.PackageManager.UpdatePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) --api-type: winrt method ---- # Windows.Management.Deployment.PackageManager.UpdatePackageAsync ## -description Updates an installed package or its dependency packages for the current user. ## -parameters ### -param packageUri The source URI of the main package. ### -param dependencyPackageUris The source URIs of the dependency packages. ### -param deploymentOptions One of the permitted enumeration values. **ForceApplicationShutdown** and **None** are the only valid options for this method and specifying any other deployment option results in an E_INVALIDARG return value. ## -returns The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. ## -remarks An installed package can be updated only if the version of the update package is higher than that of the installed package. If no previous version of the package exists, the operation fails. ## -examples ## -see-also ## -capabilities packageManagement \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageManager.UpdatePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.UpdatePackageAsync + +## -description +Updates an installed package or its dependency packages for the current user. + +## -parameters +### -param packageUri +The source URI of the main package. + +### -param dependencyPackageUris +The source URIs of the dependency packages. + +### -param deploymentOptions +One of the permitted enumeration values. **ForceApplicationShutdown** and **None** are the only valid options for this method and specifying any other deployment option results in an E_INVALIDARG return value. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks +An installed package can be updated only if the version of the update package is higher than that of the installed package. If no previous version of the package exists, the operation fails. + +## -examples + +## -see-also + + +## -capabilities +packageManagement \ No newline at end of file diff --git a/windows.management.deployment/packageuserinformation_installstate.md b/windows.management.deployment/packageuserinformation_installstate.md index 2f619622c5..c9ef1c48e4 100644 --- a/windows.management.deployment/packageuserinformation_installstate.md +++ b/windows.management.deployment/packageuserinformation_installstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageUserInformation.InstallState --api-type: winrt property ---- # Windows.Management.Deployment.PackageUserInformation.InstallState ## -description Gets the install state of the package for the user. ## -property-value One of the enumeration values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageUserInformation.InstallState +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageUserInformation.InstallState + +## -description +Gets the install state of the package for the user. + +## -property-value +One of the enumeration values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packageuserinformation_usersecurityid.md b/windows.management.deployment/packageuserinformation_usersecurityid.md index 6981109783..f16fe2cbf4 100644 --- a/windows.management.deployment/packageuserinformation_usersecurityid.md +++ b/windows.management.deployment/packageuserinformation_usersecurityid.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Management.Deployment.PackageUserInformation.UserSecurityId --api-type: winrt property ---- # Windows.Management.Deployment.PackageUserInformation.UserSecurityId ## -description Gets the security identifier (SID) of the package user. ## -property-value The SID. ## -remarks ## -examples ## -see-also [Enumerate app packages sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-ee821079), [Enumerate app packages by name and publisher sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-fe747b8a) \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageUserInformation.UserSecurityId +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageUserInformation.UserSecurityId + +## -description +Gets the security identifier (SID) of the package user. + +## -property-value +The SID. + +## -remarks + +## -examples + +## -see-also +[Enumerate app packages sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-ee821079), [Enumerate app packages by name and publisher sample](http://code.msdn.microsoft.com/windowsdesktop/Package-Manager-Inventory-fe747b8a) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume.md b/windows.management.deployment/packagevolume.md index 735a5d712b..03cf992817 100644 --- a/windows.management.deployment/packagevolume.md +++ b/windows.management.deployment/packagevolume.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Management.Deployment.PackageVolume --api-type: winrt class ---- # Windows.Management.Deployment.PackageVolume ## -description Represents a package storage volume. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Management.Deployment.PackageVolume +-api-type: winrt class +--- + + + +# Windows.Management.Deployment.PackageVolume + +## -description +Represents a package storage volume. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_findpackage_1322794127.md b/windows.management.deployment/packagevolume_findpackage_1322794127.md index ca0fd90494..bebd684175 100644 --- a/windows.management.deployment/packagevolume_findpackage_1322794127.md +++ b/windows.management.deployment/packagevolume_findpackage_1322794127.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackage(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackage ## -description Gets a collection of info about all installed instances of the specified package for all registered users. ## -parameters ### -param packageFullName The full name of the package. ## -returns A collection of info about all installed instances of the specified package for all registered users. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackage(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackage + +## -description +Gets a collection of info about all installed instances of the specified package for all registered users. + +## -parameters +### -param packageFullName +The full name of the package. + +## -returns +A collection of info about all installed instances of the specified package for all registered users. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_findpackageforuser_526853699.md b/windows.management.deployment/packagevolume_findpackageforuser_526853699.md index 9d2320eb0c..3b0ad4f477 100644 --- a/windows.management.deployment/packagevolume_findpackageforuser_526853699.md +++ b/windows.management.deployment/packagevolume_findpackageforuser_526853699.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackageForUser(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackageForUser ## -description Gets a collection of info about the installed instances of the specified package for the specified user or users. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ### -param packageFullName The full name of the package. ## -returns A collection of info about all installed instances of the specified package for the specified user or users. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackageForUser(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackageForUser + +## -description +Gets a collection of info about the installed instances of the specified package for the specified user or users. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +### -param packageFullName +The full name of the package. + +## -returns +A collection of info about all installed instances of the specified package for the specified user or users. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_findpackages_1246181969.md b/windows.management.deployment/packagevolume_findpackages_1246181969.md index 9fcb18fe9c..f535f4296a 100644 --- a/windows.management.deployment/packagevolume_findpackages_1246181969.md +++ b/windows.management.deployment/packagevolume_findpackages_1246181969.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackages --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackages ## -description Gets a collection of info about all installed instances of all packages for all registered users. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackages(String, String)](packagevolume_findpackages_1597689551.md), [FindPackages(String)](packagevolume_findpackages_331793265.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackages +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackages + +## -description +Gets a collection of info about all installed instances of all packages for all registered users. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackages(String, String)](packagevolume_findpackages_1597689551.md), [FindPackages(String)](packagevolume_findpackages_331793265.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackages_1597689551.md b/windows.management.deployment/packagevolume_findpackages_1597689551.md index 0759260714..e79bd01f11 100644 --- a/windows.management.deployment/packagevolume_findpackages_1597689551.md +++ b/windows.management.deployment/packagevolume_findpackages_1597689551.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackages(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackages ## -description Gets a collection of info about all installed instances of the specified package from the specified publisher for all registered users. ## -parameters ### -param packageName The full name of the package. ### -param packagePublisher The publisher of the package. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackages](packagevolume_findpackages_1246181969.md), [FindPackages(String)](packagevolume_findpackages_331793265.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackages(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackages + +## -description +Gets a collection of info about all installed instances of the specified package from the specified publisher for all registered users. + +## -parameters +### -param packageName +The full name of the package. + +### -param packagePublisher +The publisher of the package. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackages](packagevolume_findpackages_1246181969.md), [FindPackages(String)](packagevolume_findpackages_331793265.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackages_331793265.md b/windows.management.deployment/packagevolume_findpackages_331793265.md index b9bea934b7..26c748877c 100644 --- a/windows.management.deployment/packagevolume_findpackages_331793265.md +++ b/windows.management.deployment/packagevolume_findpackages_331793265.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackages(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackages ## -description Gets a collection of info about all installed instances of the specified package for all registered users. ## -parameters ### -param packageFamilyName The package family name of the package. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackages](packagevolume_findpackages_1246181969.md), [FindPackages(String, String)](packagevolume_findpackages_1597689551.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackages(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackages + +## -description +Gets a collection of info about all installed instances of the specified package for all registered users. + +## -parameters +### -param packageFamilyName +The package family name of the package. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackages](packagevolume_findpackages_1246181969.md), [FindPackages(String, String)](packagevolume_findpackages_1597689551.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackagesforuser_2003648348.md b/windows.management.deployment/packagevolume_findpackagesforuser_2003648348.md index 556cb0e25a..6a9fb9c9b8 100644 --- a/windows.management.deployment/packagevolume_findpackagesforuser_2003648348.md +++ b/windows.management.deployment/packagevolume_findpackagesforuser_2003648348.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUser(System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesForUser ## -description Gets a collection of info about all installed instances of the specified package for the specified user or users. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ### -param packageFamilyName The package family name. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesForUser(String)](packagevolume_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String, String)](packagevolume_findpackagesforuser_292215772.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUser(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesForUser + +## -description +Gets a collection of info about all installed instances of the specified package for the specified user or users. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +### -param packageFamilyName +The package family name. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUser(String)](packagevolume_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String, String)](packagevolume_findpackagesforuser_292215772.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackagesforuser_292215772.md b/windows.management.deployment/packagevolume_findpackagesforuser_292215772.md index 79127dacb2..913d1ec169 100644 --- a/windows.management.deployment/packagevolume_findpackagesforuser_292215772.md +++ b/windows.management.deployment/packagevolume_findpackagesforuser_292215772.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUser(System.String,System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesForUser ## -description Gets a collection of info about all installed instances of the specified package from the specified publisher for the specified user or users. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ### -param packageName The full name of the package. ### -param packagePublisher The publisher of the package. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesForUser(String)](packagevolume_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String)](packagevolume_findpackagesforuser_2003648348.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUser(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesForUser + +## -description +Gets a collection of info about all installed instances of the specified package from the specified publisher for the specified user or users. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +### -param packageName +The full name of the package. + +### -param packagePublisher +The publisher of the package. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUser(String)](packagevolume_findpackagesforuser_999371492.md), [FindPackagesForUser(String, String)](packagevolume_findpackagesforuser_2003648348.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackagesforuser_999371492.md b/windows.management.deployment/packagevolume_findpackagesforuser_999371492.md index 3d3361f7a3..29bd3f5d12 100644 --- a/windows.management.deployment/packagevolume_findpackagesforuser_999371492.md +++ b/windows.management.deployment/packagevolume_findpackagesforuser_999371492.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUser(System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesForUser ## -description Gets a collection of info about all installed instances of all packages for the specified user or users. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesForUser(String, String, String)](packagevolume_findpackagesforuser_292215772.md), [FindPackagesForUser(String, String)](packagevolume_findpackagesforuser_2003648348.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUser(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesForUser + +## -description +Gets a collection of info about all installed instances of all packages for the specified user or users. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUser(String, String, String)](packagevolume_findpackagesforuser_292215772.md), [FindPackagesForUser(String, String)](packagevolume_findpackagesforuser_2003648348.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_1422527170.md b/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_1422527170.md index 8c6bfb04a7..7024aa8a2f 100644 --- a/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_1422527170.md +++ b/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_1422527170.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes ## -description Gets a collection of info about all installed instances of all packages for the specified user or users and with the specified package types. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ### -param packageTypes A bitwise combination of the enumeration values that specifies the types of packages to return. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String)](packagevolume_findpackagesforuserwithpackagetypes_20830398.md), [FindPackagesForUserWithPackageTypes(String, PackageTypes, String)](packagevolume_findpackagesforuserwithpackagetypes_852356674.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes + +## -description +Gets a collection of info about all installed instances of all packages for the specified user or users and with the specified package types. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +### -param packageTypes +A bitwise combination of the enumeration values that specifies the types of packages to return. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String)](packagevolume_findpackagesforuserwithpackagetypes_20830398.md), [FindPackagesForUserWithPackageTypes(String, PackageTypes, String)](packagevolume_findpackagesforuserwithpackagetypes_852356674.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_20830398.md b/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_20830398.md index 04e1aa6362..d74f70dc60 100644 --- a/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_20830398.md +++ b/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_20830398.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes,System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes ## -description Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ### -param packageTypes A bitwise combination of the enumeration values that specifies the types of packages to return. ### -param packageName The full name of the package. ### -param packagePublisher The publisher of the package. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagevolume_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, PackageTypes, String)](packagevolume_findpackagesforuserwithpackagetypes_852356674.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes + +## -description +Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +### -param packageTypes +A bitwise combination of the enumeration values that specifies the types of packages to return. + +### -param packageName +The full name of the package. + +### -param packagePublisher +The publisher of the package. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagevolume_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, PackageTypes, String)](packagevolume_findpackagesforuserwithpackagetypes_852356674.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_852356674.md b/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_852356674.md index 2ce6ea8e1a..dd6dfe7ed0 100644 --- a/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_852356674.md +++ b/windows.management.deployment/packagevolume_findpackagesforuserwithpackagetypes_852356674.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes ## -description Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types. ## -parameters ### -param userSecurityId The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. ### -param packageTypes A bitwise combination of the enumeration values that specifies the types of packages to return. ### -param packageFamilyName The package family name. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagevolume_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String)](packagevolume_findpackagesforuserwithpackagetypes_20830398.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes(System.String,Windows.Management.Deployment.PackageTypes,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesForUserWithPackageTypes + +## -description +Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types. + +## -parameters +### -param userSecurityId +The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. + +### -param packageTypes +A bitwise combination of the enumeration values that specifies the types of packages to return. + +### -param packageFamilyName +The package family name. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesForUserWithPackageTypes(String, PackageTypes)](packagevolume_findpackagesforuserwithpackagetypes_1422527170.md), [FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String)](packagevolume_findpackagesforuserwithpackagetypes_20830398.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackageswithpackagetypes_1447839348.md b/windows.management.deployment/packagevolume_findpackageswithpackagetypes_1447839348.md index 7aeac79834..28dd339eb6 100644 --- a/windows.management.deployment/packagevolume_findpackageswithpackagetypes_1447839348.md +++ b/windows.management.deployment/packagevolume_findpackageswithpackagetypes_1447839348.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes ## -description Gets a collection of info about all installed instances of the specified package with the specified package types for all registered users. ## -parameters ### -param packageTypes A bitwise combination of the enumeration values that specifies the types of packages to return. ### -param packageFamilyName The package family name. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesWithPackageTypes(PackageTypes)](packagevolume_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(PackageTypes, String, String)](packagevolume_findpackageswithpackagetypes_810263284.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes + +## -description +Gets a collection of info about all installed instances of the specified package with the specified package types for all registered users. + +## -parameters +### -param packageTypes +A bitwise combination of the enumeration values that specifies the types of packages to return. + +### -param packageFamilyName +The package family name. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesWithPackageTypes(PackageTypes)](packagevolume_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(PackageTypes, String, String)](packagevolume_findpackageswithpackagetypes_810263284.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackageswithpackagetypes_447761356.md b/windows.management.deployment/packagevolume_findpackageswithpackagetypes_447761356.md index 625e4da4ad..b555048f35 100644 --- a/windows.management.deployment/packagevolume_findpackageswithpackagetypes_447761356.md +++ b/windows.management.deployment/packagevolume_findpackageswithpackagetypes_447761356.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes ## -description Gets a collection of info about all installed instances of all packages with the specified package types for all registered users. ## -parameters ### -param packageTypes A bitwise combination of the enumeration values that specifies the types of packages to return. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesWithPackageTypes(PackageTypes, String, String)](packagevolume_findpackageswithpackagetypes_810263284.md), [FindPackagesWithPackageTypes(PackageTypes, String)](packagevolume_findpackageswithpackagetypes_1447839348.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes + +## -description +Gets a collection of info about all installed instances of all packages with the specified package types for all registered users. + +## -parameters +### -param packageTypes +A bitwise combination of the enumeration values that specifies the types of packages to return. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesWithPackageTypes(PackageTypes, String, String)](packagevolume_findpackageswithpackagetypes_810263284.md), [FindPackagesWithPackageTypes(PackageTypes, String)](packagevolume_findpackageswithpackagetypes_1447839348.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_findpackageswithpackagetypes_810263284.md b/windows.management.deployment/packagevolume_findpackageswithpackagetypes_810263284.md index f28a876b53..fa44c6e4e7 100644 --- a/windows.management.deployment/packagevolume_findpackageswithpackagetypes_810263284.md +++ b/windows.management.deployment/packagevolume_findpackageswithpackagetypes_810263284.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes,System.String,System.String) --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes ## -description Gets a collection of info about all installed instances of the specified package from the specified publisher with the specified package types for all registered users. ## -parameters ### -param packageTypes A bitwise combination of the enumeration values that specifies the types of packages to return. ### -param packageName The full name of the package. ### -param packagePublisher The publisher of the package. ## -returns A collection of info about the specified packages. ## -remarks ## -examples ## -see-also [FindPackagesWithPackageTypes(PackageTypes)](packagevolume_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(PackageTypes, String)](packagevolume_findpackageswithpackagetypes_1447839348.md) \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes(Windows.Management.Deployment.PackageTypes,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.FindPackagesWithPackageTypes + +## -description +Gets a collection of info about all installed instances of the specified package from the specified publisher with the specified package types for all registered users. + +## -parameters +### -param packageTypes +A bitwise combination of the enumeration values that specifies the types of packages to return. + +### -param packageName +The full name of the package. + +### -param packagePublisher +The publisher of the package. + +## -returns +A collection of info about the specified packages. + +## -remarks + +## -examples + +## -see-also +[FindPackagesWithPackageTypes(PackageTypes)](packagevolume_findpackageswithpackagetypes_447761356.md), [FindPackagesWithPackageTypes(PackageTypes, String)](packagevolume_findpackageswithpackagetypes_1447839348.md) \ No newline at end of file diff --git a/windows.management.deployment/packagevolume_getavailablespaceasync_1213844579.md b/windows.management.deployment/packagevolume_getavailablespaceasync_1213844579.md index b9c3d6310d..4a5a692c30 100644 --- a/windows.management.deployment/packagevolume_getavailablespaceasync_1213844579.md +++ b/windows.management.deployment/packagevolume_getavailablespaceasync_1213844579.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Deployment.PackageVolume.GetAvailableSpaceAsync --api-type: winrt method ---- # Windows.Management.Deployment.PackageVolume.GetAvailableSpaceAsync ## -description Gets the available space. ## -returns Returns an asynchronous operation that will complete with the available space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Deployment.PackageVolume.GetAvailableSpaceAsync +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageVolume.GetAvailableSpaceAsync + +## -description +Gets the available space. + +## -returns +Returns an asynchronous operation that will complete with the available space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_isappxinstallsupported.md b/windows.management.deployment/packagevolume_isappxinstallsupported.md index aa2dd414d3..fbabd92b37 100644 --- a/windows.management.deployment/packagevolume_isappxinstallsupported.md +++ b/windows.management.deployment/packagevolume_isappxinstallsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.IsAppxInstallSupported --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.IsAppxInstallSupported ## -description Gets a boolean that indicates if APPX installing is supported. ## -property-value The boolean that indicates that APPX installing is supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.IsAppxInstallSupported +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.IsAppxInstallSupported + +## -description +Gets a boolean that indicates if APPX installing is supported. + +## -property-value +The boolean that indicates that APPX installing is supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_isfulltrustpackagesupported.md b/windows.management.deployment/packagevolume_isfulltrustpackagesupported.md index c9ec69caf1..75d136e410 100644 --- a/windows.management.deployment/packagevolume_isfulltrustpackagesupported.md +++ b/windows.management.deployment/packagevolume_isfulltrustpackagesupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.IsFullTrustPackageSupported --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.IsFullTrustPackageSupported ## -description Gets a boolean that indicates if full-trust packages are supported. ## -property-value A boolean that indicates if full-trust packages are supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.IsFullTrustPackageSupported +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.IsFullTrustPackageSupported + +## -description +Gets a boolean that indicates if full-trust packages are supported. + +## -property-value +A boolean that indicates if full-trust packages are supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_isoffline.md b/windows.management.deployment/packagevolume_isoffline.md index 1c4f37c432..03eae3d91f 100644 --- a/windows.management.deployment/packagevolume_isoffline.md +++ b/windows.management.deployment/packagevolume_isoffline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.IsOffline --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.IsOffline ## -description Describes whether a volume is in an offline state. ## -property-value true if the volume is in an offline state; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.IsOffline +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.IsOffline + +## -description +Describes whether a volume is in an offline state. + +## -property-value +true if the volume is in an offline state; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_issystemvolume.md b/windows.management.deployment/packagevolume_issystemvolume.md index d7304f05c6..059262b9f5 100644 --- a/windows.management.deployment/packagevolume_issystemvolume.md +++ b/windows.management.deployment/packagevolume_issystemvolume.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.IsSystemVolume --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.IsSystemVolume ## -description Describes whether a volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable. ## -property-value true if the volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.IsSystemVolume +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.IsSystemVolume + +## -description +Describes whether a volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable. + +## -property-value +true if the volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_mountpoint.md b/windows.management.deployment/packagevolume_mountpoint.md index 2501f6279b..5273337262 100644 --- a/windows.management.deployment/packagevolume_mountpoint.md +++ b/windows.management.deployment/packagevolume_mountpoint.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.MountPoint --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.MountPoint ## -description Gets the path of the last known volume mount point. ## -property-value The path of the last known volume mount point. ## -remarks This is a cached value. It may not represent the current state of the device or the volume. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.MountPoint +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.MountPoint + +## -description +Gets the path of the last known volume mount point. + +## -property-value +The path of the last known volume mount point. + +## -remarks +This is a cached value. It may not represent the current state of the device or the volume. + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_name.md b/windows.management.deployment/packagevolume_name.md index 1f96831c71..84e770ce18 100644 --- a/windows.management.deployment/packagevolume_name.md +++ b/windows.management.deployment/packagevolume_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.Name --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.Name ## -description Gets the media ID of the volume. ## -property-value The media ID of the volume. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.Name +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.Name + +## -description +Gets the media ID of the volume. + +## -property-value +The media ID of the volume. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_packagestorepath.md b/windows.management.deployment/packagevolume_packagestorepath.md index 8b5868b062..770eced750 100644 --- a/windows.management.deployment/packagevolume_packagestorepath.md +++ b/windows.management.deployment/packagevolume_packagestorepath.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.PackageStorePath --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.PackageStorePath ## -description Gets the absolute path for the package store on the volume. ## -property-value The absolute path for the package store on the volume. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.PackageStorePath +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.PackageStorePath + +## -description +Gets the absolute path for the package store on the volume. + +## -property-value +The absolute path for the package store on the volume. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.deployment/packagevolume_supportshardlinks.md b/windows.management.deployment/packagevolume_supportshardlinks.md index c86191bc94..c027db970e 100644 --- a/windows.management.deployment/packagevolume_supportshardlinks.md +++ b/windows.management.deployment/packagevolume_supportshardlinks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Management.Deployment.PackageVolume.SupportsHardLinks --api-type: winrt property ---- # Windows.Management.Deployment.PackageVolume.SupportsHardLinks ## -description Gets a value that specifies whether the volume supports the creation of hard links in its file system. ## -property-value true if the volume supports the creation of hard links in its file system; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Deployment.PackageVolume.SupportsHardLinks +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageVolume.SupportsHardLinks + +## -description +Gets a value that specifies whether the volume supports the creation of hard links in its file system. + +## -property-value +true if the volume supports the creation of hard links in its file system; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.orchestration/currentapporchestration.md b/windows.management.orchestration/currentapporchestration.md index a15d4b0f02..f5206cbf04 100644 --- a/windows.management.orchestration/currentapporchestration.md +++ b/windows.management.orchestration/currentapporchestration.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Management.Orchestration.CurrentAppOrchestration --api-type: winrt class ---- # Windows.Management.Orchestration.CurrentAppOrchestration ## -description Represents the orchestration for the current app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Management.Orchestration.CurrentAppOrchestration +-api-type: winrt class +--- + + + +# Windows.Management.Orchestration.CurrentAppOrchestration + +## -description +Represents the orchestration for the current app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.orchestration/currentapporchestration_getforcurrentview_1363600702.md b/windows.management.orchestration/currentapporchestration_getforcurrentview_1363600702.md index 43a09b4b87..1cf3a6dc80 100644 --- a/windows.management.orchestration/currentapporchestration_getforcurrentview_1363600702.md +++ b/windows.management.orchestration/currentapporchestration_getforcurrentview_1363600702.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Orchestration.CurrentAppOrchestration.GetForCurrentView --api-type: winrt method ---- # Windows.Management.Orchestration.CurrentAppOrchestration.GetForCurrentView ## -description Gets the current app orchestration for the current view. ## -returns The current app orchestration for the current view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Orchestration.CurrentAppOrchestration.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Management.Orchestration.CurrentAppOrchestration.GetForCurrentView + +## -description +Gets the current app orchestration for the current view. + +## -returns +The current app orchestration for the current view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.orchestration/currentapporchestration_startsingleappmode_1648665854.md b/windows.management.orchestration/currentapporchestration_startsingleappmode_1648665854.md index ad1578bab1..818b9d15ef 100644 --- a/windows.management.orchestration/currentapporchestration_startsingleappmode_1648665854.md +++ b/windows.management.orchestration/currentapporchestration_startsingleappmode_1648665854.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Orchestration.CurrentAppOrchestration.StartSingleAppMode --api-type: winrt method ---- # Windows.Management.Orchestration.CurrentAppOrchestration.StartSingleAppMode ## -description Start the current app orchestration in single app mode. ## -returns The context in which the current app orchestration has been started. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Orchestration.CurrentAppOrchestration.StartSingleAppMode +-api-type: winrt method +--- + + + +# Windows.Management.Orchestration.CurrentAppOrchestration.StartSingleAppMode + +## -description +Start the current app orchestration in single app mode. + +## -returns +The context in which the current app orchestration has been started. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.orchestration/singleappmodecontext.md b/windows.management.orchestration/singleappmodecontext.md index 1d17d2e23c..80db73890b 100644 --- a/windows.management.orchestration/singleappmodecontext.md +++ b/windows.management.orchestration/singleappmodecontext.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Management.Orchestration.SingleAppModeContext --api-type: winrt class ---- # Windows.Management.Orchestration.SingleAppModeContext ## -description The context in which the [CurrentAppOrchestration](currentapporchestration.md) has been started. ## -remarks Returned from [StartSingleAppMode](currentapporchestration_startsingleappmode.md). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Management.Orchestration.SingleAppModeContext +-api-type: winrt class +--- + + + +# Windows.Management.Orchestration.SingleAppModeContext + +## -description +The context in which the [CurrentAppOrchestration](currentapporchestration.md) has been started. + +## -remarks +Returned from [StartSingleAppMode](currentapporchestration_startsingleappmode.md). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.management.orchestration/singleappmodecontext_close_811482585.md b/windows.management.orchestration/singleappmodecontext_close_811482585.md index 080000de56..79faeb87cf 100644 --- a/windows.management.orchestration/singleappmodecontext_close_811482585.md +++ b/windows.management.orchestration/singleappmodecontext_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Management.Orchestration.SingleAppModeContext.Close --api-type: winrt method ---- # Windows.Management.Orchestration.SingleAppModeContext.Close ## -description Closes the single app mode context. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Orchestration.SingleAppModeContext.Close +-api-type: winrt method +--- + + + +# Windows.Management.Orchestration.SingleAppModeContext.Close + +## -description +Closes the single app mode context. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.workplace/mdmpolicy.md b/windows.management.workplace/mdmpolicy.md index bb7da4e0a1..883b209174 100644 --- a/windows.management.workplace/mdmpolicy.md +++ b/windows.management.workplace/mdmpolicy.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Management.Workplace.MdmPolicy --api-type: winrt class ---- # Windows.Management.Workplace.MdmPolicy ## -description MDM (Mobile Device Management) policy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Management.Workplace.MdmPolicy +-api-type: winrt class +--- + + + +# Windows.Management.Workplace.MdmPolicy + +## -description +MDM (Mobile Device Management) policy. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.management.workplace/mdmpolicy_getmessagingsyncpolicy_1337286238.md b/windows.management.workplace/mdmpolicy_getmessagingsyncpolicy_1337286238.md index f800b88f9c..bde9bd6a42 100644 --- a/windows.management.workplace/mdmpolicy_getmessagingsyncpolicy_1337286238.md +++ b/windows.management.workplace/mdmpolicy_getmessagingsyncpolicy_1337286238.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Workplace.MdmPolicy.GetMessagingSyncPolicy --api-type: winrt method ---- # Windows.Management.Workplace.MdmPolicy.GetMessagingSyncPolicy ## -description Gets the current messaging sync policy. ## -returns The messaging sync policy. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Workplace.MdmPolicy.GetMessagingSyncPolicy +-api-type: winrt method +--- + + + +# Windows.Management.Workplace.MdmPolicy.GetMessagingSyncPolicy + +## -description +Gets the current messaging sync policy. + +## -returns +The messaging sync policy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.workplace/mdmpolicy_isbrowserallowed_789589020.md b/windows.management.workplace/mdmpolicy_isbrowserallowed_789589020.md index 7c8d81cc82..c3c3642463 100644 --- a/windows.management.workplace/mdmpolicy_isbrowserallowed_789589020.md +++ b/windows.management.workplace/mdmpolicy_isbrowserallowed_789589020.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Workplace.MdmPolicy.IsBrowserAllowed --api-type: winrt method ---- # Windows.Management.Workplace.MdmPolicy.IsBrowserAllowed ## -description Returns **true** if a browser is allowed. ## -returns **true** if a browser is allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Workplace.MdmPolicy.IsBrowserAllowed +-api-type: winrt method +--- + + + +# Windows.Management.Workplace.MdmPolicy.IsBrowserAllowed + +## -description +Returns **true** if a browser is allowed. + +## -returns +**true** if a browser is allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.workplace/mdmpolicy_iscameraallowed_1979361969.md b/windows.management.workplace/mdmpolicy_iscameraallowed_1979361969.md index a69805b86a..5172abd518 100644 --- a/windows.management.workplace/mdmpolicy_iscameraallowed_1979361969.md +++ b/windows.management.workplace/mdmpolicy_iscameraallowed_1979361969.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Workplace.MdmPolicy.IsCameraAllowed --api-type: winrt method ---- # Windows.Management.Workplace.MdmPolicy.IsCameraAllowed ## -description Returns **true** if a camera is allowed. ## -returns **true** if a camera is allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Workplace.MdmPolicy.IsCameraAllowed +-api-type: winrt method +--- + + + +# Windows.Management.Workplace.MdmPolicy.IsCameraAllowed + +## -description +Returns **true** if a camera is allowed. + +## -returns +**true** if a camera is allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.workplace/mdmpolicy_ismicrosoftaccountallowed_1007989808.md b/windows.management.workplace/mdmpolicy_ismicrosoftaccountallowed_1007989808.md index a85bc69ef4..a9a3b13f43 100644 --- a/windows.management.workplace/mdmpolicy_ismicrosoftaccountallowed_1007989808.md +++ b/windows.management.workplace/mdmpolicy_ismicrosoftaccountallowed_1007989808.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Workplace.MdmPolicy.IsMicrosoftAccountAllowed --api-type: winrt method ---- # Windows.Management.Workplace.MdmPolicy.IsMicrosoftAccountAllowed ## -description Returns **true** if a Microsoft Account is allowed. ## -returns **true** if a Microsoft Account is allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Workplace.MdmPolicy.IsMicrosoftAccountAllowed +-api-type: winrt method +--- + + + +# Windows.Management.Workplace.MdmPolicy.IsMicrosoftAccountAllowed + +## -description +Returns **true** if a Microsoft Account is allowed. + +## -returns +**true** if a Microsoft Account is allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.workplace/mdmpolicy_isstoreallowed_121291008.md b/windows.management.workplace/mdmpolicy_isstoreallowed_121291008.md index 3ffa352a49..7eb167723e 100644 --- a/windows.management.workplace/mdmpolicy_isstoreallowed_121291008.md +++ b/windows.management.workplace/mdmpolicy_isstoreallowed_121291008.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Management.Workplace.MdmPolicy.IsStoreAllowed --api-type: winrt method ---- # Windows.Management.Workplace.MdmPolicy.IsStoreAllowed ## -description Returns **true** if a Store is allowed. ## -returns **true** if a Store is allowed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Management.Workplace.MdmPolicy.IsStoreAllowed +-api-type: winrt method +--- + + + +# Windows.Management.Workplace.MdmPolicy.IsStoreAllowed + +## -description +Returns **true** if a Store is allowed. + +## -returns +**true** if a Store is allowed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.management.workplace/workplacesettings.md b/windows.management.workplace/workplacesettings.md index 9d9f729530..4355b84099 100644 --- a/windows.management.workplace/workplacesettings.md +++ b/windows.management.workplace/workplacesettings.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Management.Workplace.WorkplaceSettings --api-type: winrt class ---- # Windows.Management.Workplace.WorkplaceSettings ## -description Enables Windows Store app to access select enterprise settings that are managed through group policy or other management services. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Management.Workplace.WorkplaceSettings +-api-type: winrt class +--- + + + +# Windows.Management.Workplace.WorkplaceSettings + +## -description +Enables Windows Store app to access select enterprise settings that are managed through group policy or other management services. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.management.workplace/workplacesettings_ismicrosoftaccountoptional.md b/windows.management.workplace/workplacesettings_ismicrosoftaccountoptional.md index c99c3a0213..064a952386 100644 --- a/windows.management.workplace/workplacesettings_ismicrosoftaccountoptional.md +++ b/windows.management.workplace/workplacesettings_ismicrosoftaccountoptional.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Management.Workplace.WorkplaceSettings.IsMicrosoftAccountOptional --api-type: winrt property ---- # Windows.Management.Workplace.WorkplaceSettings.IsMicrosoftAccountOptional ## -description Gets a value that indicates whether an enterprise ID can be used instead of a Microsoft account. ## -property-value **true** if an enterprise ID can be used instead of a Microsoft account; otherwise, **false**. ## -remarks Some apps, such as the Mail app, require that a user sign in with a Microsoft account. If [IsMicrosoftAccountOptional](workplacesettings_ismicrosoftaccountoptional.md) is **true**, the app can provide a different experience in an enterprise setting, and let a user sign in with an enterprise ID instead of a Microsoft account. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Management.Workplace.WorkplaceSettings.IsMicrosoftAccountOptional +-api-type: winrt property +--- + + + +# Windows.Management.Workplace.WorkplaceSettings.IsMicrosoftAccountOptional + +## -description +Gets a value that indicates whether an enterprise ID can be used instead of a Microsoft account. + +## -property-value +**true** if an enterprise ID can be used instead of a Microsoft account; otherwise, **false**. + +## -remarks +Some apps, such as the Mail app, require that a user sign in with a Microsoft account. If [IsMicrosoftAccountOptional](workplacesettings_ismicrosoftaccountoptional.md) is **true**, the app can provide a different experience in an enterprise setting, and let a user sign in with an enterprise ID instead of a Microsoft account. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode.md b/windows.media.audio/audiodeviceinputnode.md index 974a5ebf81..243e8bf4c8 100644 --- a/windows.media.audio/audiodeviceinputnode.md +++ b/windows.media.audio/audiodeviceinputnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioDeviceInputNode --api-type: winrt class ---- # Windows.Media.Audio.AudioDeviceInputNode ## -description Represents an audio device input node. ## -remarks Get an instance of this class by calling [AudioGraph::CreateDeviceInputNodeAsync](audiograph_createdeviceinputnodeasync.md) and then accessing the [CreateAudioDeviceInputNodeResult::DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property. ## -examples ## -see-also [IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioDeviceInputNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode + +## -description +Represents an audio device input node. + +## -remarks +Get an instance of this class by calling [AudioGraph::CreateDeviceInputNodeAsync](audiograph_createdeviceinputnodeasync.md) and then accessing the [CreateAudioDeviceInputNodeResult::DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property. + +## -examples + +## -see-also +[IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_702981438.md b/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_702981438.md index d4dd12e39c..2259a0e725 100644 --- a/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_702981438.md +++ b/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_702981438.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection ## -description Adds an outgoing connection with gain to the audio device input node. ## -parameters ### -param destination The destination node for the connection. ### -param gain A value indicating the gain associated with the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode)](audiodeviceinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection with gain to the audio device input node. + +## -parameters +### -param destination +The destination node for the connection. + +### -param gain +A value indicating the gain associated with the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode)](audiodeviceinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file diff --git a/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_877485530.md b/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_877485530.md index 10a2e7f954..7228c2b160 100644 --- a/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_877485530.md +++ b/windows.media.audio/audiodeviceinputnode_addoutgoingconnection_877485530.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection ## -description Adds an outgoing connection to the audio device input node. ## -parameters ### -param destination The destination node for the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode, Double)](audiodeviceinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection to the audio device input node. + +## -parameters +### -param destination +The destination node for the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode, Double)](audiodeviceinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file diff --git a/windows.media.audio/audiodeviceinputnode_close_811482585.md b/windows.media.audio/audiodeviceinputnode_close_811482585.md index 5138eab2b3..d27ec1a328 100644 --- a/windows.media.audio/audiodeviceinputnode_close_811482585.md +++ b/windows.media.audio/audiodeviceinputnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.Close ## -description Closes the audio device input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.Close + +## -description +Closes the audio device input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_consumeinput.md b/windows.media.audio/audiodeviceinputnode_consumeinput.md index 37668b625a..3551a56220 100644 --- a/windows.media.audio/audiodeviceinputnode_consumeinput.md +++ b/windows.media.audio/audiodeviceinputnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.ConsumeInput ## -description Gets or sets a value indicating if the audio device input node consumes input. ## -property-value True if the audio device input node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio device input node consumes input. + +## -property-value +True if the audio device input node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_device.md b/windows.media.audio/audiodeviceinputnode_device.md index 360dbd0b79..adf3a78045 100644 --- a/windows.media.audio/audiodeviceinputnode_device.md +++ b/windows.media.audio/audiodeviceinputnode_device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.Device --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.Device ## -description Gets information about the audio device. ## -property-value A [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.Device +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.Device + +## -description +Gets information about the audio device. + +## -property-value +A [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audiodeviceinputnode_disableeffectsbydefinition_730128310.md index 1f7f7550dd..2622486bbc 100644 --- a/windows.media.audio/audiodeviceinputnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audiodeviceinputnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audiodeviceinputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audiodeviceinputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_effectdefinitions.md b/windows.media.audio/audiodeviceinputnode_effectdefinitions.md index e210042811..f127ca3eb1 100644 --- a/windows.media.audio/audiodeviceinputnode_effectdefinitions.md +++ b/windows.media.audio/audiodeviceinputnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio device input node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio device input node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audiodeviceinputnode_emitter.md b/windows.media.audio/audiodeviceinputnode_emitter.md index a459b05fd2..07b1e148d4 100644 --- a/windows.media.audio/audiodeviceinputnode_emitter.md +++ b/windows.media.audio/audiodeviceinputnode_emitter.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.Emitter --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.Emitter ## -description Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioDeviceInputNode](audiodeviceinputnode.md) audio is emitted when spatial audio processing is used. ## -property-value The spatial audio emitter associated with the [AudioDeviceInputNode](audiodeviceinputnode.md). ## -remarks Create an [AudioDeviceInputNode](audiodeviceinputnode.md) with an [AudioNodeEmitter](audionodeemitter.md) by calling the overload of [CreateDeviceInputNodeAsync](audiograph_createdeviceinputnodeasync_2137015807.md) that accepts an emitter as an argument. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.Emitter +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.Emitter + +## -description +Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioDeviceInputNode](audiodeviceinputnode.md) audio is emitted when spatial audio processing is used. + +## -property-value +The spatial audio emitter associated with the [AudioDeviceInputNode](audiodeviceinputnode.md). + +## -remarks +Create an [AudioDeviceInputNode](audiodeviceinputnode.md) with an [AudioNodeEmitter](audionodeemitter.md) by calling the overload of [CreateDeviceInputNodeAsync](audiograph_createdeviceinputnodeasync_2137015807.md) that accepts an emitter as an argument. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audiodeviceinputnode_enableeffectsbydefinition_1376948293.md index 490b980b3f..6ee9e04231 100644 --- a/windows.media.audio/audiodeviceinputnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audiodeviceinputnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audiodeviceinputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audiodeviceinputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_encodingproperties.md b/windows.media.audio/audiodeviceinputnode_encodingproperties.md index 66d7899a4f..055a41e438 100644 --- a/windows.media.audio/audiodeviceinputnode_encodingproperties.md +++ b/windows.media.audio/audiodeviceinputnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.EncodingProperties ## -description Gets the encoding properties for the audio device input node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.EncodingProperties + +## -description +Gets the encoding properties for the audio device input node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_outgoingconnections.md b/windows.media.audio/audiodeviceinputnode_outgoingconnections.md index 173094ae41..bfe44b72ba 100644 --- a/windows.media.audio/audiodeviceinputnode_outgoingconnections.md +++ b/windows.media.audio/audiodeviceinputnode_outgoingconnections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.OutgoingConnections --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.OutgoingConnections ## -description Gets the list of outgoing connections from the audio device input node to other nodes in the audio graph. ## -property-value A collection of [AudioGraphConnection](audiographconnection.md) objects representing the supported connections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.OutgoingConnections +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.OutgoingConnections + +## -description +Gets the list of outgoing connections from the audio device input node to other nodes in the audio graph. + +## -property-value +A collection of [AudioGraphConnection](audiographconnection.md) objects representing the supported connections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_outgoinggain.md b/windows.media.audio/audiodeviceinputnode_outgoinggain.md index b6adb8eccd..8727269e77 100644 --- a/windows.media.audio/audiodeviceinputnode_outgoinggain.md +++ b/windows.media.audio/audiodeviceinputnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceInputNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceInputNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio device input node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceInputNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio device input node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_removeoutgoingconnection_1321353886.md b/windows.media.audio/audiodeviceinputnode_removeoutgoingconnection_1321353886.md index b64026a9a7..97598b1028 100644 --- a/windows.media.audio/audiodeviceinputnode_removeoutgoingconnection_1321353886.md +++ b/windows.media.audio/audiodeviceinputnode_removeoutgoingconnection_1321353886.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.RemoveOutgoingConnection ## -description Removes the outgoing connection for the audio device input node. ## -parameters ### -param destination The destination for the outgoing connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.RemoveOutgoingConnection + +## -description +Removes the outgoing connection for the audio device input node. + +## -parameters +### -param destination +The destination for the outgoing connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_reset_1636126115.md b/windows.media.audio/audiodeviceinputnode_reset_1636126115.md index 07b25aa84b..a6312f3c26 100644 --- a/windows.media.audio/audiodeviceinputnode_reset_1636126115.md +++ b/windows.media.audio/audiodeviceinputnode_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.Reset ## -description Resets the audio device input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.Reset + +## -description +Resets the audio device input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_start_1587696324.md b/windows.media.audio/audiodeviceinputnode_start_1587696324.md index f28ae75df8..7eb7fb845b 100644 --- a/windows.media.audio/audiodeviceinputnode_start_1587696324.md +++ b/windows.media.audio/audiodeviceinputnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.Start ## -description Starts the audio device input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.Start + +## -description +Starts the audio device input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceinputnode_stop_1201535524.md b/windows.media.audio/audiodeviceinputnode_stop_1201535524.md index 81aa1b2d39..5226c41e09 100644 --- a/windows.media.audio/audiodeviceinputnode_stop_1201535524.md +++ b/windows.media.audio/audiodeviceinputnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceInputNode.Stop ## -description Stops the audio device input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceInputNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceInputNode.Stop + +## -description +Stops the audio device input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode.md b/windows.media.audio/audiodeviceoutputnode.md index 0e1b54d999..2ad759f5d9 100644 --- a/windows.media.audio/audiodeviceoutputnode.md +++ b/windows.media.audio/audiodeviceoutputnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioDeviceOutputNode --api-type: winrt class ---- # Windows.Media.Audio.AudioDeviceOutputNode ## -description Represents an audio device output node. ## -remarks Get an instance of this class by calling [AudioGraph::CreateDeviceOutputNodeAsync](audiograph_createdeviceoutputnodeasync.md) and then accessing the [CreateAudioDeviceOutputNodeResult::DeviceOutputNode](createaudiodeviceoutputnoderesult_deviceoutputnode.md) property. ## -examples ## -see-also [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioDeviceOutputNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode + +## -description +Represents an audio device output node. + +## -remarks +Get an instance of this class by calling [AudioGraph::CreateDeviceOutputNodeAsync](audiograph_createdeviceoutputnodeasync.md) and then accessing the [CreateAudioDeviceOutputNodeResult::DeviceOutputNode](createaudiodeviceoutputnoderesult_deviceoutputnode.md) property. + +## -examples + +## -see-also +[IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audiodeviceoutputnode_close_811482585.md b/windows.media.audio/audiodeviceoutputnode_close_811482585.md index 50e90d3b22..6bd3acf215 100644 --- a/windows.media.audio/audiodeviceoutputnode_close_811482585.md +++ b/windows.media.audio/audiodeviceoutputnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceOutputNode.Close ## -description Closes the audio device output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.Close + +## -description +Closes the audio device output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_consumeinput.md b/windows.media.audio/audiodeviceoutputnode_consumeinput.md index aad0500ee8..746405ef41 100644 --- a/windows.media.audio/audiodeviceoutputnode_consumeinput.md +++ b/windows.media.audio/audiodeviceoutputnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceOutputNode.ConsumeInput ## -description Gets or sets a value indicating if the audio device output node consumes input. ## -property-value True if the audio device output node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio device output node consumes input. + +## -property-value +True if the audio device output node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_device.md b/windows.media.audio/audiodeviceoutputnode_device.md index 80b5b8ad00..9c1702cc14 100644 --- a/windows.media.audio/audiodeviceoutputnode_device.md +++ b/windows.media.audio/audiodeviceoutputnode_device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.Device --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceOutputNode.Device ## -description Gets information about the audio device. ## -property-value A [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.Device +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.Device + +## -description +Gets information about the audio device. + +## -property-value +A [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audiodeviceoutputnode_disableeffectsbydefinition_730128310.md index bd492eec9a..87b157c529 100644 --- a/windows.media.audio/audiodeviceoutputnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audiodeviceoutputnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceOutputNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audiodeviceoutputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audiodeviceoutputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_effectdefinitions.md b/windows.media.audio/audiodeviceoutputnode_effectdefinitions.md index 64439925dd..41ae42d640 100644 --- a/windows.media.audio/audiodeviceoutputnode_effectdefinitions.md +++ b/windows.media.audio/audiodeviceoutputnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceOutputNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio device output node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio device output node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audiodeviceoutputnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audiodeviceoutputnode_enableeffectsbydefinition_1376948293.md index c0ac1f5115..189cd9764a 100644 --- a/windows.media.audio/audiodeviceoutputnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audiodeviceoutputnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceOutputNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audiodeviceoutputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audiodeviceoutputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_encodingproperties.md b/windows.media.audio/audiodeviceoutputnode_encodingproperties.md index c7263f173c..9a742d833e 100644 --- a/windows.media.audio/audiodeviceoutputnode_encodingproperties.md +++ b/windows.media.audio/audiodeviceoutputnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceOutputNode.EncodingProperties ## -description Gets the encoding properties for the audio device output node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.EncodingProperties + +## -description +Gets the encoding properties for the audio device output node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_listener.md b/windows.media.audio/audiodeviceoutputnode_listener.md index 5308e3083e..da9bf33bff 100644 --- a/windows.media.audio/audiodeviceoutputnode_listener.md +++ b/windows.media.audio/audiodeviceoutputnode_listener.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.Listener --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceOutputNode.Listener ## -description Gets or sets the [AudioNodeListener](audionodelistener.md) that describes the position and other characteristics of the listener from which the [AudioDeviceOutputNode](audiodeviceoutputnode.md) audio is heard when spatial audio processing is used. ## -property-value The spatial audio listener associated with the [AudioDeviceInputNode](audiodeviceinputnode.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.Listener +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.Listener + +## -description +Gets or sets the [AudioNodeListener](audionodelistener.md) that describes the position and other characteristics of the listener from which the [AudioDeviceOutputNode](audiodeviceoutputnode.md) audio is heard when spatial audio processing is used. + +## -property-value +The spatial audio listener associated with the [AudioDeviceInputNode](audiodeviceinputnode.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_outgoinggain.md b/windows.media.audio/audiodeviceoutputnode_outgoinggain.md index cbaa4a78f8..b2bb859c20 100644 --- a/windows.media.audio/audiodeviceoutputnode_outgoinggain.md +++ b/windows.media.audio/audiodeviceoutputnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioDeviceOutputNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio device output node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioDeviceOutputNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio device output node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_reset_1636126115.md b/windows.media.audio/audiodeviceoutputnode_reset_1636126115.md index 58d3163e72..4645e3bc9d 100644 --- a/windows.media.audio/audiodeviceoutputnode_reset_1636126115.md +++ b/windows.media.audio/audiodeviceoutputnode_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceOutputNode.Reset ## -description Resets the audio device output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.Reset + +## -description +Resets the audio device output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_start_1587696324.md b/windows.media.audio/audiodeviceoutputnode_start_1587696324.md index 4f2ffa40c3..68c1496716 100644 --- a/windows.media.audio/audiodeviceoutputnode_start_1587696324.md +++ b/windows.media.audio/audiodeviceoutputnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceOutputNode.Start ## -description Starts the audio device output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.Start + +## -description +Starts the audio device output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiodeviceoutputnode_stop_1201535524.md b/windows.media.audio/audiodeviceoutputnode_stop_1201535524.md index 212c81232e..943827e3a9 100644 --- a/windows.media.audio/audiodeviceoutputnode_stop_1201535524.md +++ b/windows.media.audio/audiodeviceoutputnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioDeviceOutputNode.Stop ## -description Stops the audio device output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioDeviceOutputNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioDeviceOutputNode.Stop + +## -description +Stops the audio device output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode.md b/windows.media.audio/audiofileinputnode.md index 964195cb5c..e78b3c004f 100644 --- a/windows.media.audio/audiofileinputnode.md +++ b/windows.media.audio/audiofileinputnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioFileInputNode --api-type: winrt class ---- # Windows.Media.Audio.AudioFileInputNode ## -description Represents an audio file input node. ## -remarks Get an instance of this class by calling [AudioGraph::CreateFileInputNodeAsync](audiograph_createfileinputnodeasync.md) and then accessing the [CreateFileInputNodeResult::FileInputNode](createaudiofileinputnoderesult_fileinputnode.md) property. ## -examples ## -see-also [IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioFileInputNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioFileInputNode + +## -description +Represents an audio file input node. + +## -remarks +Get an instance of this class by calling [AudioGraph::CreateFileInputNodeAsync](audiograph_createfileinputnodeasync.md) and then accessing the [CreateFileInputNodeResult::FileInputNode](createaudiofileinputnoderesult_fileinputnode.md) property. + +## -examples + +## -see-also +[IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audiofileinputnode_addoutgoingconnection_702981438.md b/windows.media.audio/audiofileinputnode_addoutgoingconnection_702981438.md index 2d393919bd..99192eaeed 100644 --- a/windows.media.audio/audiofileinputnode_addoutgoingconnection_702981438.md +++ b/windows.media.audio/audiofileinputnode_addoutgoingconnection_702981438.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection ## -description Adds an outgoing connection with gain to the audio file input node. ## -parameters ### -param destination The destination node for the connection. ### -param gain A value indicating the gain associated with the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode)](audiofileinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection with gain to the audio file input node. + +## -parameters +### -param destination +The destination node for the connection. + +### -param gain +A value indicating the gain associated with the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode)](audiofileinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file diff --git a/windows.media.audio/audiofileinputnode_addoutgoingconnection_877485530.md b/windows.media.audio/audiofileinputnode_addoutgoingconnection_877485530.md index cbed61d66e..bc72925eba 100644 --- a/windows.media.audio/audiofileinputnode_addoutgoingconnection_877485530.md +++ b/windows.media.audio/audiofileinputnode_addoutgoingconnection_877485530.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection ## -description Adds an outgoing connection to the audio file input node. ## -parameters ### -param destination The destination node for the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode, Double)](audiofileinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection to the audio file input node. + +## -parameters +### -param destination +The destination node for the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode, Double)](audiofileinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file diff --git a/windows.media.audio/audiofileinputnode_close_811482585.md b/windows.media.audio/audiofileinputnode_close_811482585.md index fb79ffed82..4ddba18359 100644 --- a/windows.media.audio/audiofileinputnode_close_811482585.md +++ b/windows.media.audio/audiofileinputnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.Close ## -description Closes the audio file input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Close + +## -description +Closes the audio file input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_consumeinput.md b/windows.media.audio/audiofileinputnode_consumeinput.md index 10c959ae37..8564d9a104 100644 --- a/windows.media.audio/audiofileinputnode_consumeinput.md +++ b/windows.media.audio/audiofileinputnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.ConsumeInput ## -description Gets or sets a value indicating if the audio file input node consumes input. ## -property-value True if the audio file input node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio file input node consumes input. + +## -property-value +True if the audio file input node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audiofileinputnode_disableeffectsbydefinition_730128310.md index 72e7cd5abc..5987c27d35 100644 --- a/windows.media.audio/audiofileinputnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audiofileinputnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audiofileinputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audiofileinputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_duration.md b/windows.media.audio/audiofileinputnode_duration.md index 3b825c12ba..9a82abcbc9 100644 --- a/windows.media.audio/audiofileinputnode_duration.md +++ b/windows.media.audio/audiofileinputnode_duration.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.Duration --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.Duration ## -description Gets the duration for the audio input file. ## -property-value A value indicating the duration for the audio input file. ## -remarks The **Duration** property represents the duration of the audio input file. The [StartTime](audiofileinputnode_starttime.md) and [EndTime](audiofileinputnode_endtime.md) properties can be used to set the range of the file that is used for playback, but setting these properties does not cause the value returned by **Duration** to change. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Duration + +## -description +Gets the duration for the audio input file. + +## -property-value +A value indicating the duration for the audio input file. + +## -remarks +The **Duration** property represents the duration of the audio input file. The [StartTime](audiofileinputnode_starttime.md) and [EndTime](audiofileinputnode_endtime.md) properties can be used to set the range of the file that is used for playback, but setting these properties does not cause the value returned by **Duration** to change. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_effectdefinitions.md b/windows.media.audio/audiofileinputnode_effectdefinitions.md index ac0e96eeb9..53b6dcf87e 100644 --- a/windows.media.audio/audiofileinputnode_effectdefinitions.md +++ b/windows.media.audio/audiofileinputnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio file input node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio file input node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audiofileinputnode_emitter.md b/windows.media.audio/audiofileinputnode_emitter.md index a332264295..f2cad3d13b 100644 --- a/windows.media.audio/audiofileinputnode_emitter.md +++ b/windows.media.audio/audiofileinputnode_emitter.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.Emitter --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.Emitter ## -description Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioFileInputNode](audiofileinputnode.md) audio is emitted when spatial audio processing is used. ## -property-value The spatial audio emitter associated with the [AudioFileInputNode](audiofileinputnode.md). ## -remarks Create an [AudioFileInputNode](audiofileinputnode.md) with an [AudioNodeEmitter](audionodeemitter.md) by calling the overload of [CreateFileInputNodeAsync](audiograph_createfileinputnodeasync_1569331208.md) that accepts an emitter as an argument. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.Emitter +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Emitter + +## -description +Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioFileInputNode](audiofileinputnode.md) audio is emitted when spatial audio processing is used. + +## -property-value +The spatial audio emitter associated with the [AudioFileInputNode](audiofileinputnode.md). + +## -remarks +Create an [AudioFileInputNode](audiofileinputnode.md) with an [AudioNodeEmitter](audionodeemitter.md) by calling the overload of [CreateFileInputNodeAsync](audiograph_createfileinputnodeasync_1569331208.md) that accepts an emitter as an argument. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audiofileinputnode_enableeffectsbydefinition_1376948293.md index 81427de326..3d8610e724 100644 --- a/windows.media.audio/audiofileinputnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audiofileinputnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audiofileinputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audiofileinputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_encodingproperties.md b/windows.media.audio/audiofileinputnode_encodingproperties.md index 4c48b8ce08..f4fc35fb69 100644 --- a/windows.media.audio/audiofileinputnode_encodingproperties.md +++ b/windows.media.audio/audiofileinputnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.EncodingProperties ## -description Gets the encoding properties for the audio file input node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.EncodingProperties + +## -description +Gets the encoding properties for the audio file input node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_endtime.md b/windows.media.audio/audiofileinputnode_endtime.md index 6e398cd2c0..b5e87d846f 100644 --- a/windows.media.audio/audiofileinputnode_endtime.md +++ b/windows.media.audio/audiofileinputnode_endtime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.EndTime --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.EndTime ## -description Gets or sets the end time for the audio file input node. ## -property-value A value indicating the end time. ## -remarks **EndTime** defines where in the file playback ends. If **EndTime** is **null**, playback will end at the end of the file. **EndTime** can't be set to a time greater than the duration of the file. Attempting to do so will result in an invalid argument error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.EndTime +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.EndTime + +## -description +Gets or sets the end time for the audio file input node. + +## -property-value +A value indicating the end time. + +## -remarks +**EndTime** defines where in the file playback ends. If **EndTime** is **null**, playback will end at the end of the file. **EndTime** can't be set to a time greater than the duration of the file. Attempting to do so will result in an invalid argument error. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_filecompleted.md b/windows.media.audio/audiofileinputnode_filecompleted.md index 1591de2398..85d7596fae 100644 --- a/windows.media.audio/audiofileinputnode_filecompleted.md +++ b/windows.media.audio/audiofileinputnode_filecompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Audio.AudioFileInputNode.FileCompleted --api-type: winrt event ---- # Windows.Media.Audio.AudioFileInputNode.FileCompleted ## -description Notifies of completion of the file associated with the audio file input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Audio.AudioFileInputNode.FileCompleted +-api-type: winrt event +--- + + + +# Windows.Media.Audio.AudioFileInputNode.FileCompleted + +## -description +Notifies of completion of the file associated with the audio file input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_loopcount.md b/windows.media.audio/audiofileinputnode_loopcount.md index 3551bee107..cdcf1f3488 100644 --- a/windows.media.audio/audiofileinputnode_loopcount.md +++ b/windows.media.audio/audiofileinputnode_loopcount.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.LoopCount --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.LoopCount ## -description Gets or sets the loop count of the audio file input node. ## -property-value A reference to the loop count. ## -remarks The **LoopCount** property specifies the number of times that the node will seek back to the [StartTime](audiofileinputnode_starttime.md), or the beginning of the file if [StartTime](audiofileinputnode_starttime.md) is not set, and replay the content of the file. This value does not include the initial playback of the file, so using the default value of 0 will result in the file being played once, and setting the value to 5 will result in the file being played 6 times in total. Setting this value to **null** will cause the file to be looped indefinitely. To break out of the infinite loop, set **LoopCount** back to 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.LoopCount +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.LoopCount + +## -description +Gets or sets the loop count of the audio file input node. + +## -property-value +A reference to the loop count. + +## -remarks +The **LoopCount** property specifies the number of times that the node will seek back to the [StartTime](audiofileinputnode_starttime.md), or the beginning of the file if [StartTime](audiofileinputnode_starttime.md) is not set, and replay the content of the file. This value does not include the initial playback of the file, so using the default value of 0 will result in the file being played once, and setting the value to 5 will result in the file being played 6 times in total. Setting this value to **null** will cause the file to be looped indefinitely. To break out of the infinite loop, set **LoopCount** back to 0. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_outgoingconnections.md b/windows.media.audio/audiofileinputnode_outgoingconnections.md index 4c79cfa2f9..25aa9d0c68 100644 --- a/windows.media.audio/audiofileinputnode_outgoingconnections.md +++ b/windows.media.audio/audiofileinputnode_outgoingconnections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.OutgoingConnections --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.OutgoingConnections ## -description Gets the list of outgoing connections from the audio file input node to other nodes in the audio graph. ## -property-value A collection of [AudioGraphConnection](audiographconnection.md) objects representing the supported connections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.OutgoingConnections +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.OutgoingConnections + +## -description +Gets the list of outgoing connections from the audio file input node to other nodes in the audio graph. + +## -property-value +A collection of [AudioGraphConnection](audiographconnection.md) objects representing the supported connections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_outgoinggain.md b/windows.media.audio/audiofileinputnode_outgoinggain.md index e0674d2039..ebae36ee77 100644 --- a/windows.media.audio/audiofileinputnode_outgoinggain.md +++ b/windows.media.audio/audiofileinputnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio file input node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio file input node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_playbackspeedfactor.md b/windows.media.audio/audiofileinputnode_playbackspeedfactor.md index 37dede0032..631cfb581f 100644 --- a/windows.media.audio/audiofileinputnode_playbackspeedfactor.md +++ b/windows.media.audio/audiofileinputnode_playbackspeedfactor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.PlaybackSpeedFactor --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.PlaybackSpeedFactor ## -description Gets or sets the playback speed factor for the audio file input node. ## -property-value A value indicating the playback speed factor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.PlaybackSpeedFactor +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.PlaybackSpeedFactor + +## -description +Gets or sets the playback speed factor for the audio file input node. + +## -property-value +A value indicating the playback speed factor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_position.md b/windows.media.audio/audiofileinputnode_position.md index 0b79379e31..5c5e85c93a 100644 --- a/windows.media.audio/audiofileinputnode_position.md +++ b/windows.media.audio/audiofileinputnode_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.Position --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.Position ## -description Gets the position of the audio file input node. ## -property-value The position of the audio file input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.Position +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Position + +## -description +Gets the position of the audio file input node. + +## -property-value +The position of the audio file input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_removeoutgoingconnection_1321353886.md b/windows.media.audio/audiofileinputnode_removeoutgoingconnection_1321353886.md index 92e2614940..eb101e98b5 100644 --- a/windows.media.audio/audiofileinputnode_removeoutgoingconnection_1321353886.md +++ b/windows.media.audio/audiofileinputnode_removeoutgoingconnection_1321353886.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.RemoveOutgoingConnection ## -description Removes the outgoing connection for the audio file input node. ## -parameters ### -param destination The destination for the outgoing connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.RemoveOutgoingConnection + +## -description +Removes the outgoing connection for the audio file input node. + +## -parameters +### -param destination +The destination for the outgoing connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_reset_1636126115.md b/windows.media.audio/audiofileinputnode_reset_1636126115.md index ac799e49a9..c4a53e5f92 100644 --- a/windows.media.audio/audiofileinputnode_reset_1636126115.md +++ b/windows.media.audio/audiofileinputnode_reset_1636126115.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.Reset ## -description Resets the audio file input node. ## -remarks This method causes the node to reset the playback position back to the beginning of the file, or to the time specified by the [StartTime](audiofileinputnode_starttime.md) property if it has been set. Calling this method causes [DiscardQueuedFrames](../windows.media.effects/ibasicaudioeffect_discardqueuedframes.md) to be called on any audio effects applied to the [AudioFileInputNode](audiofileinputnode.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Reset + +## -description +Resets the audio file input node. + +## -remarks +This method causes the node to reset the playback position back to the beginning of the file, or to the time specified by the [StartTime](audiofileinputnode_starttime.md) property if it has been set. Calling this method causes [DiscardQueuedFrames](../windows.media.effects/ibasicaudioeffect_discardqueuedframes.md) to be called on any audio effects applied to the [AudioFileInputNode](audiofileinputnode.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_seek_1068795122.md b/windows.media.audio/audiofileinputnode_seek_1068795122.md index d4b0aeffd5..ba2b6501a8 100644 --- a/windows.media.audio/audiofileinputnode_seek_1068795122.md +++ b/windows.media.audio/audiofileinputnode_seek_1068795122.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.Seek(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.Seek ## -description Moves the playback position of the node to the specified time within the audio input file. ## -parameters ### -param position A value indicating the position to which the node should seek. ## -remarks You can't seek to a time that is greater than the duration of the file. If the [StartTime](audiofileinputnode_starttime.md) or [EndTime](audiofileinputnode_endtime.md) properties have been set, you can't seek to a position before the [StartTime](audiofileinputnode_starttime.md) or after the [EndTime](audiofileinputnode_endtime.md). Attempting to do so will result in an illegal argument error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.Seek(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Seek + +## -description +Moves the playback position of the node to the specified time within the audio input file. + +## -parameters +### -param position +A value indicating the position to which the node should seek. + +## -remarks +You can't seek to a time that is greater than the duration of the file. If the [StartTime](audiofileinputnode_starttime.md) or [EndTime](audiofileinputnode_endtime.md) properties have been set, you can't seek to a position before the [StartTime](audiofileinputnode_starttime.md) or after the [EndTime](audiofileinputnode_endtime.md). Attempting to do so will result in an illegal argument error. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_sourcefile.md b/windows.media.audio/audiofileinputnode_sourcefile.md index 00200d3268..30168fa536 100644 --- a/windows.media.audio/audiofileinputnode_sourcefile.md +++ b/windows.media.audio/audiofileinputnode_sourcefile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.SourceFile --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.SourceFile ## -description Gets the source audio file for the audio file input node. ## -property-value A [StorageFile](../windows.storage/storagefile.md) object representing the source audio file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.SourceFile +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.SourceFile + +## -description +Gets the source audio file for the audio file input node. + +## -property-value +A [StorageFile](../windows.storage/storagefile.md) object representing the source audio file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_start_1587696324.md b/windows.media.audio/audiofileinputnode_start_1587696324.md index 7eb34f0303..96a96206b0 100644 --- a/windows.media.audio/audiofileinputnode_start_1587696324.md +++ b/windows.media.audio/audiofileinputnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.Start ## -description Starts the audio file input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Start + +## -description +Starts the audio file input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_starttime.md b/windows.media.audio/audiofileinputnode_starttime.md index 7fb589e578..ec7256e777 100644 --- a/windows.media.audio/audiofileinputnode_starttime.md +++ b/windows.media.audio/audiofileinputnode_starttime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileInputNode.StartTime --api-type: winrt property ---- # Windows.Media.Audio.AudioFileInputNode.StartTime ## -description Gets or sets the start time for the audio file input node. ## -property-value A value indicating the start time. ## -remarks **StartTime** defines where in the file playback begins. If **StartTime** is **null**, playback will start at the beginning of the file. **StartTime** can't be set to a time greater than the duration of the file. Attempting to do so will result in an invalid argument error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileInputNode.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileInputNode.StartTime + +## -description +Gets or sets the start time for the audio file input node. + +## -property-value +A value indicating the start time. + +## -remarks +**StartTime** defines where in the file playback begins. If **StartTime** is **null**, playback will start at the beginning of the file. **StartTime** can't be set to a time greater than the duration of the file. Attempting to do so will result in an invalid argument error. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileinputnode_stop_1201535524.md b/windows.media.audio/audiofileinputnode_stop_1201535524.md index 3d2a0af5e8..9ca45c1177 100644 --- a/windows.media.audio/audiofileinputnode_stop_1201535524.md +++ b/windows.media.audio/audiofileinputnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileInputNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioFileInputNode.Stop ## -description Stops the audio file input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileInputNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileInputNode.Stop + +## -description +Stops the audio file input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode.md b/windows.media.audio/audiofileoutputnode.md index c378f196e1..9f50b7434c 100644 --- a/windows.media.audio/audiofileoutputnode.md +++ b/windows.media.audio/audiofileoutputnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioFileOutputNode --api-type: winrt class ---- # Windows.Media.Audio.AudioFileOutputNode ## -description Represents an audio file output node. ## -remarks Get an instance of this class by calling [AudioGraph::CreateFileOutputNodeAsync](audiograph_createfileoutputnodeasync.md) and then accessing the [CreateFileOutputNodeResult::FileOutputNode](createaudiofileoutputnoderesult_fileoutputnode.md) property. ## -examples ## -see-also [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioFileOutputNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioFileOutputNode + +## -description +Represents an audio file output node. + +## -remarks +Get an instance of this class by calling [AudioGraph::CreateFileOutputNodeAsync](audiograph_createfileoutputnodeasync.md) and then accessing the [CreateFileOutputNodeResult::FileOutputNode](createaudiofileoutputnoderesult_fileoutputnode.md) property. + +## -examples + +## -see-also +[IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audiofileoutputnode_close_811482585.md b/windows.media.audio/audiofileoutputnode_close_811482585.md index 85f9c9a18a..b06ed796ed 100644 --- a/windows.media.audio/audiofileoutputnode_close_811482585.md +++ b/windows.media.audio/audiofileoutputnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.Close ## -description Closes the audio file output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.Close + +## -description +Closes the audio file output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_consumeinput.md b/windows.media.audio/audiofileoutputnode_consumeinput.md index cd0c476bb1..eb0b30d82a 100644 --- a/windows.media.audio/audiofileoutputnode_consumeinput.md +++ b/windows.media.audio/audiofileoutputnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileOutputNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioFileOutputNode.ConsumeInput ## -description Gets or sets a value indicating if the audio file output node consumes input. ## -property-value True if the audio file output node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileOutputNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio file output node consumes input. + +## -property-value +True if the audio file output node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audiofileoutputnode_disableeffectsbydefinition_730128310.md index 248bc22fdc..5f058f0c67 100644 --- a/windows.media.audio/audiofileoutputnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audiofileoutputnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audiofileoutputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audiofileoutputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_effectdefinitions.md b/windows.media.audio/audiofileoutputnode_effectdefinitions.md index d145835f81..c4dcbba9f6 100644 --- a/windows.media.audio/audiofileoutputnode_effectdefinitions.md +++ b/windows.media.audio/audiofileoutputnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileOutputNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioFileOutputNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio file output node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileOutputNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio file output node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audiofileoutputnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audiofileoutputnode_enableeffectsbydefinition_1376948293.md index 13a2af94fc..bae0d9d5de 100644 --- a/windows.media.audio/audiofileoutputnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audiofileoutputnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audiofileoutputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audiofileoutputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_encodingproperties.md b/windows.media.audio/audiofileoutputnode_encodingproperties.md index 412fb8166a..729194d236 100644 --- a/windows.media.audio/audiofileoutputnode_encodingproperties.md +++ b/windows.media.audio/audiofileoutputnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileOutputNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioFileOutputNode.EncodingProperties ## -description Gets the encoding properties for the audio file output node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileOutputNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.EncodingProperties + +## -description +Gets the encoding properties for the audio file output node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_file.md b/windows.media.audio/audiofileoutputnode_file.md index dacb84e721..85436d34ad 100644 --- a/windows.media.audio/audiofileoutputnode_file.md +++ b/windows.media.audio/audiofileoutputnode_file.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileOutputNode.File --api-type: winrt property ---- # Windows.Media.Audio.AudioFileOutputNode.File ## -description Gets the file associated with the audio file output node. ## -property-value A [StorageFile](../windows.storage/storagefile.md) object representing the file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileOutputNode.File +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.File + +## -description +Gets the file associated with the audio file output node. + +## -property-value +A [StorageFile](../windows.storage/storagefile.md) object representing the file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_fileencodingprofile.md b/windows.media.audio/audiofileoutputnode_fileencodingprofile.md index 5a4a83732a..8f6d9d2161 100644 --- a/windows.media.audio/audiofileoutputnode_fileencodingprofile.md +++ b/windows.media.audio/audiofileoutputnode_fileencodingprofile.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileOutputNode.FileEncodingProfile --api-type: winrt property ---- # Windows.Media.Audio.AudioFileOutputNode.FileEncodingProfile ## -description Gets the file encoding profile supported by the audio file output node. ## -property-value A [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md) object representing the encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileOutputNode.FileEncodingProfile +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.FileEncodingProfile + +## -description +Gets the file encoding profile supported by the audio file output node. + +## -property-value +A [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md) object representing the encoding profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_finalizeasync_809425140.md b/windows.media.audio/audiofileoutputnode_finalizeasync_809425140.md index 53d55db491..c60f215ab1 100644 --- a/windows.media.audio/audiofileoutputnode_finalizeasync_809425140.md +++ b/windows.media.audio/audiofileoutputnode_finalizeasync_809425140.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.FinalizeAsync --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.FinalizeAsync ## -description Finalizes the asynchronous operation of the audio file output node. ## -returns When this operation completes, a [TranscodeFailureReason](../windows.media.transcoding/transcodefailurereason.md) value is returned. ## -remarks You must call the [AudioFileOutputNode.Stop](audiofileoutputnode_stop.md) method to stop the node before calling **FinalizeAsync** or an exception will be thrown. Upon completion of **FinalizeAsync**, this node transitions itself into the closed state. Further calls into this node will result in a RO_E_CLOSED exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.FinalizeAsync +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.FinalizeAsync + +## -description +Finalizes the asynchronous operation of the audio file output node. + +## -returns +When this operation completes, a [TranscodeFailureReason](../windows.media.transcoding/transcodefailurereason.md) value is returned. + +## -remarks +You must call the [AudioFileOutputNode.Stop](audiofileoutputnode_stop.md) method to stop the node before calling **FinalizeAsync** or an exception will be thrown. + +Upon completion of **FinalizeAsync**, this node transitions itself into the closed state. Further calls into this node will result in a RO_E_CLOSED exception. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_outgoinggain.md b/windows.media.audio/audiofileoutputnode_outgoinggain.md index 1c13bc9403..6bd35ca77b 100644 --- a/windows.media.audio/audiofileoutputnode_outgoinggain.md +++ b/windows.media.audio/audiofileoutputnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFileOutputNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioFileOutputNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio file output node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFileOutputNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio file output node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_reset_1636126115.md b/windows.media.audio/audiofileoutputnode_reset_1636126115.md index 24abfead23..de948f23dc 100644 --- a/windows.media.audio/audiofileoutputnode_reset_1636126115.md +++ b/windows.media.audio/audiofileoutputnode_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.Reset ## -description Resets the audio file output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.Reset + +## -description +Resets the audio file output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_start_1587696324.md b/windows.media.audio/audiofileoutputnode_start_1587696324.md index 34e6b86076..786ee24a3b 100644 --- a/windows.media.audio/audiofileoutputnode_start_1587696324.md +++ b/windows.media.audio/audiofileoutputnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.Start ## -description Starts the audio file output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.Start + +## -description +Starts the audio file output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiofileoutputnode_stop_1201535524.md b/windows.media.audio/audiofileoutputnode_stop_1201535524.md index 16b8f65aa6..31f161328c 100644 --- a/windows.media.audio/audiofileoutputnode_stop_1201535524.md +++ b/windows.media.audio/audiofileoutputnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFileOutputNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioFileOutputNode.Stop ## -description Stops the audio file output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFileOutputNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFileOutputNode.Stop + +## -description +Stops the audio file output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframecompletedeventargs.md b/windows.media.audio/audioframecompletedeventargs.md index f247056a8d..db1d6f6c29 100644 --- a/windows.media.audio/audioframecompletedeventargs.md +++ b/windows.media.audio/audioframecompletedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.AudioFrameCompletedEventArgs --api-type: winrt class ---- # Windows.Media.Audio.AudioFrameCompletedEventArgs ## -description Represents arguments for an [AudioFrameCompleted](audioframeinputnode_audioframecompleted.md) event. ## -remarks Get an instance of this class by handling the [AudioFrameInputNode.AudioFrameCompleted](audioframeinputnode_audioframecompleted.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioFrameCompletedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioFrameCompletedEventArgs + +## -description +Represents arguments for an [AudioFrameCompleted](audioframeinputnode_audioframecompleted.md) event. + +## -remarks +Get an instance of this class by handling the [AudioFrameInputNode.AudioFrameCompleted](audioframeinputnode_audioframecompleted.md) event. + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframecompletedeventargs_frame.md b/windows.media.audio/audioframecompletedeventargs_frame.md index c42ac1ef80..a50ec28e34 100644 --- a/windows.media.audio/audioframecompletedeventargs_frame.md +++ b/windows.media.audio/audioframecompletedeventargs_frame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameCompletedEventArgs.Frame --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameCompletedEventArgs.Frame ## -description Gets the audio frame that was just completed by the [AudioFrameInputNode](audioframeinputnode.md). A frame is completed when all of the audio in the frame has been consumed by the audio graph. ## -property-value An [AudioFrame](../windows.media/audioframe.md) object representing the audio frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameCompletedEventArgs.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameCompletedEventArgs.Frame + +## -description +Gets the audio frame that was just completed by the [AudioFrameInputNode](audioframeinputnode.md). A frame is completed when all of the audio in the frame has been consumed by the audio graph. + +## -property-value +An [AudioFrame](../windows.media/audioframe.md) object representing the audio frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode.md b/windows.media.audio/audioframeinputnode.md index d3c3d5c02d..e9d057fe22 100644 --- a/windows.media.audio/audioframeinputnode.md +++ b/windows.media.audio/audioframeinputnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioFrameInputNode --api-type: winrt class ---- # Windows.Media.Audio.AudioFrameInputNode ## -description Represents an audio frame input node. ## -remarks Get an instance of this class by calling [CreateFrameInputNode](audiograph_createframeinputnode.md). ## -examples ## -see-also [IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioFrameInputNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioFrameInputNode + +## -description +Represents an audio frame input node. + +## -remarks +Get an instance of this class by calling [CreateFrameInputNode](audiograph_createframeinputnode.md). + +## -examples + +## -see-also +[IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audioframeinputnode_addframe_561479871.md b/windows.media.audio/audioframeinputnode_addframe_561479871.md index e802b71adb..2d17ae1186 100644 --- a/windows.media.audio/audioframeinputnode_addframe_561479871.md +++ b/windows.media.audio/audioframeinputnode_addframe_561479871.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.AddFrame(Windows.Media.AudioFrame) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.AddFrame ## -description Adds an audio frame to the audio frame input node. ## -parameters ### -param frame An [AudioFrame](../windows.media/audioframe.md) object representing the frame. ## -remarks The provided [AudioFrame](../windows.media/audioframe.md) object must have an underlying [AudioBuffer](../windows.media/audiobuffer.md) with a [Length](../windows.media/audiobuffer_length.md) greater than 0 or an E_INVALIDARG error will result. Also, the underlying [IMemoryBuffer](../windows.foundation/imemorybuffer.md) containing the raw audio data must be block-aligned based on the bit depth per sample and number of channels. This means that the size of the buffer, in bytes, must be an integral multiple of ([BitsPerSample](../windows.media.mediaproperties/audioencodingproperties_bitspersample.md) / 8) * [ChannelCount](../windows.media.mediaproperties/audioencodingproperties_channelcount.md) of the [EncodingProperties](audioframeinputnode_encodingproperties.md) property for the node. Attempting to add a frame with a non-aligned audio buffer will result in an E_INVALIDARG error. A maximum of 64 frames can be queued in the [AudioFrameInputNode](audioframeinputnode.md) at one time. Attempting to queue more than 64 frames will result in an error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.AddFrame(Windows.Media.AudioFrame) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.AddFrame + +## -description +Adds an audio frame to the audio frame input node. + +## -parameters +### -param frame +An [AudioFrame](../windows.media/audioframe.md) object representing the frame. + +## -remarks +The provided [AudioFrame](../windows.media/audioframe.md) object must have an underlying [AudioBuffer](../windows.media/audiobuffer.md) with a [Length](../windows.media/audiobuffer_length.md) greater than 0 or an E_INVALIDARG error will result. Also, the underlying [IMemoryBuffer](../windows.foundation/imemorybuffer.md) containing the raw audio data must be block-aligned based on the bit depth per sample and number of channels. This means that the size of the buffer, in bytes, must be an integral multiple of ([BitsPerSample](../windows.media.mediaproperties/audioencodingproperties_bitspersample.md) / 8) * [ChannelCount](../windows.media.mediaproperties/audioencodingproperties_channelcount.md) of the [EncodingProperties](audioframeinputnode_encodingproperties.md) property for the node. Attempting to add a frame with a non-aligned audio buffer will result in an E_INVALIDARG error. + +A maximum of 64 frames can be queued in the [AudioFrameInputNode](audioframeinputnode.md) at one time. Attempting to queue more than 64 frames will result in an error. + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_addoutgoingconnection_702981438.md b/windows.media.audio/audioframeinputnode_addoutgoingconnection_702981438.md index d80e21e320..4389234890 100644 --- a/windows.media.audio/audioframeinputnode_addoutgoingconnection_702981438.md +++ b/windows.media.audio/audioframeinputnode_addoutgoingconnection_702981438.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection ## -description Adds an outgoing connection with gain to the audio frame input node. ## -parameters ### -param destination The destination node for the connection. ### -param gain A value indicating the gain associated with the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode)](audioframeinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection with gain to the audio frame input node. + +## -parameters +### -param destination +The destination node for the connection. + +### -param gain +A value indicating the gain associated with the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode)](audioframeinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file diff --git a/windows.media.audio/audioframeinputnode_addoutgoingconnection_877485530.md b/windows.media.audio/audioframeinputnode_addoutgoingconnection_877485530.md index dbf5e06c92..9232ca9042 100644 --- a/windows.media.audio/audioframeinputnode_addoutgoingconnection_877485530.md +++ b/windows.media.audio/audioframeinputnode_addoutgoingconnection_877485530.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection ## -description Adds an outgoing connection to the audio frame input node. ## -parameters ### -param destination The destination node for the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode, Double)](audioframeinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection to the audio frame input node. + +## -parameters +### -param destination +The destination node for the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode, Double)](audioframeinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file diff --git a/windows.media.audio/audioframeinputnode_audioframecompleted.md b/windows.media.audio/audioframeinputnode_audioframecompleted.md index 32cbc59aef..5c435ded78 100644 --- a/windows.media.audio/audioframeinputnode_audioframecompleted.md +++ b/windows.media.audio/audioframeinputnode_audioframecompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Audio.AudioFrameInputNode.AudioFrameCompleted --api-type: winrt event ---- # Windows.Media.Audio.AudioFrameInputNode.AudioFrameCompleted ## -description Notifies of a completed audio frame that has been submitted to the graph with a call to [AddFrame](audioframeinputnode_addframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Audio.AudioFrameInputNode.AudioFrameCompleted +-api-type: winrt event +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.AudioFrameCompleted + +## -description +Notifies of a completed audio frame that has been submitted to the graph with a call to [AddFrame](audioframeinputnode_addframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_close_811482585.md b/windows.media.audio/audioframeinputnode_close_811482585.md index 097cd04f35..608c85b6e6 100644 --- a/windows.media.audio/audioframeinputnode_close_811482585.md +++ b/windows.media.audio/audioframeinputnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.Close ## -description Closes the audio frame input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.Close + +## -description +Closes the audio frame input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_consumeinput.md b/windows.media.audio/audioframeinputnode_consumeinput.md index 03b6c7101c..f2b4ddc39b 100644 --- a/windows.media.audio/audioframeinputnode_consumeinput.md +++ b/windows.media.audio/audioframeinputnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.ConsumeInput ## -description Gets or sets a value indicating if the audio frame input node consumes input. ## -property-value True if the audio frame input node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio frame input node consumes input. + +## -property-value +True if the audio frame input node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audioframeinputnode_disableeffectsbydefinition_730128310.md index 7182c24754..beb3406a54 100644 --- a/windows.media.audio/audioframeinputnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audioframeinputnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audioframeinputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audioframeinputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_discardqueuedframes_1358903059.md b/windows.media.audio/audioframeinputnode_discardqueuedframes_1358903059.md index 56f83b6b43..356769e7d6 100644 --- a/windows.media.audio/audioframeinputnode_discardqueuedframes_1358903059.md +++ b/windows.media.audio/audioframeinputnode_discardqueuedframes_1358903059.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.DiscardQueuedFrames --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.DiscardQueuedFrames ## -description Removes queued frames from the audio frame input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.DiscardQueuedFrames +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.DiscardQueuedFrames + +## -description +Removes queued frames from the audio frame input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_effectdefinitions.md b/windows.media.audio/audioframeinputnode_effectdefinitions.md index f372220388..e497dfb5b5 100644 --- a/windows.media.audio/audioframeinputnode_effectdefinitions.md +++ b/windows.media.audio/audioframeinputnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio frame input node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio frame input node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audioframeinputnode_emitter.md b/windows.media.audio/audioframeinputnode_emitter.md index ae6f1721e7..fa5e9912a1 100644 --- a/windows.media.audio/audioframeinputnode_emitter.md +++ b/windows.media.audio/audioframeinputnode_emitter.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.Emitter --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.Emitter ## -description Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioFrameInputNode](audioframeinputnode.md) audio is emitted when spatial audio processing is used. ## -property-value The spatial audio emitter associated with the [AudioFrameInputNode](audioframeinputnode.md). ## -remarks Create an [AudioFrameInputNode](audioframeinputnode.md) with an [AudioNodeEmitter](audionodeemitter.md) by calling the overload of [CreateFrameInputNode](audiograph_createframeinputnode_2056779528.md) that accepts an emitter as an argument. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.Emitter +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.Emitter + +## -description +Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioFrameInputNode](audioframeinputnode.md) audio is emitted when spatial audio processing is used. + +## -property-value +The spatial audio emitter associated with the [AudioFrameInputNode](audioframeinputnode.md). + +## -remarks +Create an [AudioFrameInputNode](audioframeinputnode.md) with an [AudioNodeEmitter](audionodeemitter.md) by calling the overload of [CreateFrameInputNode](audiograph_createframeinputnode_2056779528.md) that accepts an emitter as an argument. + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audioframeinputnode_enableeffectsbydefinition_1376948293.md index aa18119ad8..90cb8bd3de 100644 --- a/windows.media.audio/audioframeinputnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audioframeinputnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audioframeinputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audioframeinputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_encodingproperties.md b/windows.media.audio/audioframeinputnode_encodingproperties.md index 5acb680bdb..93f276c8c6 100644 --- a/windows.media.audio/audioframeinputnode_encodingproperties.md +++ b/windows.media.audio/audioframeinputnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.EncodingProperties ## -description Gets the encoding properties for the audio frame input node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.EncodingProperties + +## -description +Gets the encoding properties for the audio frame input node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_outgoingconnections.md b/windows.media.audio/audioframeinputnode_outgoingconnections.md index 29fa90e42c..69331479c0 100644 --- a/windows.media.audio/audioframeinputnode_outgoingconnections.md +++ b/windows.media.audio/audioframeinputnode_outgoingconnections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.OutgoingConnections --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.OutgoingConnections ## -description Gets the list of outgoing connections from the audio frame input node to other nodes in the audio graph. ## -property-value A collection of [AudioGraphConnection](audiographconnection.md) objects representing the supported connections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.OutgoingConnections +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.OutgoingConnections + +## -description +Gets the list of outgoing connections from the audio frame input node to other nodes in the audio graph. + +## -property-value +A collection of [AudioGraphConnection](audiographconnection.md) objects representing the supported connections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_outgoinggain.md b/windows.media.audio/audioframeinputnode_outgoinggain.md index 9397c7eda3..008d0ac7d2 100644 --- a/windows.media.audio/audioframeinputnode_outgoinggain.md +++ b/windows.media.audio/audioframeinputnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio frame input node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio frame input node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_playbackspeedfactor.md b/windows.media.audio/audioframeinputnode_playbackspeedfactor.md index 23ddbfaf47..49aa0f8c8c 100644 --- a/windows.media.audio/audioframeinputnode_playbackspeedfactor.md +++ b/windows.media.audio/audioframeinputnode_playbackspeedfactor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.PlaybackSpeedFactor --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.PlaybackSpeedFactor ## -description Gets or sets the playback speed factor for the audio frame input node. ## -property-value A value indicating the playback speed factor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.PlaybackSpeedFactor +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.PlaybackSpeedFactor + +## -description +Gets or sets the playback speed factor for the audio frame input node. + +## -property-value +A value indicating the playback speed factor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_quantumstarted.md b/windows.media.audio/audioframeinputnode_quantumstarted.md index 23b04a8dbc..6bfb7bbea4 100644 --- a/windows.media.audio/audioframeinputnode_quantumstarted.md +++ b/windows.media.audio/audioframeinputnode_quantumstarted.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Audio.AudioFrameInputNode.QuantumStarted --api-type: winrt event ---- # Windows.Media.Audio.AudioFrameInputNode.QuantumStarted ## -description Raised when the audio graph is ready to begin processing a new quantum of data. ## -remarks Use the [FrameInputNodeQuantumStartedEventArgs.RequiredSamples](frameinputnodequantumstartedeventargs_requiredsamples.md) property to determine how many samples are required to fill the quantum with data. Pass an [AudioFrame](audioframecompletedeventargs.md) into the [AddFrame](audioframeinputnode_addframe.md) method to provide the required audio samples. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Audio.AudioFrameInputNode.QuantumStarted +-api-type: winrt event +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.QuantumStarted + +## -description +Raised when the audio graph is ready to begin processing a new quantum of data. + +## -remarks +Use the [FrameInputNodeQuantumStartedEventArgs.RequiredSamples](frameinputnodequantumstartedeventargs_requiredsamples.md) property to determine how many samples are required to fill the quantum with data. Pass an [AudioFrame](audioframecompletedeventargs.md) into the [AddFrame](audioframeinputnode_addframe.md) method to provide the required audio samples. + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_queuedsamplecount.md b/windows.media.audio/audioframeinputnode_queuedsamplecount.md index 3a0b1f70c7..bad68f8920 100644 --- a/windows.media.audio/audioframeinputnode_queuedsamplecount.md +++ b/windows.media.audio/audioframeinputnode_queuedsamplecount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameInputNode.QueuedSampleCount --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameInputNode.QueuedSampleCount ## -description Gets the queued sample count for the audio frame input node. ## -property-value A value indicating the queued sample count. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameInputNode.QueuedSampleCount +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.QueuedSampleCount + +## -description +Gets the queued sample count for the audio frame input node. + +## -property-value +A value indicating the queued sample count. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_removeoutgoingconnection_1321353886.md b/windows.media.audio/audioframeinputnode_removeoutgoingconnection_1321353886.md index cdfd86cd99..f5c1b12f1c 100644 --- a/windows.media.audio/audioframeinputnode_removeoutgoingconnection_1321353886.md +++ b/windows.media.audio/audioframeinputnode_removeoutgoingconnection_1321353886.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.RemoveOutgoingConnection ## -description Removes an outgoing connection from the audio frame input node. ## -parameters ### -param destination The destination for the outgoing connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.RemoveOutgoingConnection + +## -description +Removes an outgoing connection from the audio frame input node. + +## -parameters +### -param destination +The destination for the outgoing connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_reset_1636126115.md b/windows.media.audio/audioframeinputnode_reset_1636126115.md index 65e210a779..af2968663e 100644 --- a/windows.media.audio/audioframeinputnode_reset_1636126115.md +++ b/windows.media.audio/audioframeinputnode_reset_1636126115.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.Reset ## -description Resets the audio frame input node. ## -remarks Calling this method will discard all queued frames and will cause [DiscardQueuedFrames](../windows.media.effects/ibasicaudioeffect_discardqueuedframes.md) to be called on any audio effects applied to the [AudioFrameInputNode](audioframeinputnode.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.Reset + +## -description +Resets the audio frame input node. + +## -remarks +Calling this method will discard all queued frames and will cause [DiscardQueuedFrames](../windows.media.effects/ibasicaudioeffect_discardqueuedframes.md) to be called on any audio effects applied to the [AudioFrameInputNode](audioframeinputnode.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_start_1587696324.md b/windows.media.audio/audioframeinputnode_start_1587696324.md index bca03a25d0..36a5c9fd97 100644 --- a/windows.media.audio/audioframeinputnode_start_1587696324.md +++ b/windows.media.audio/audioframeinputnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.Start ## -description Starts the audio frame input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.Start + +## -description +Starts the audio frame input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeinputnode_stop_1201535524.md b/windows.media.audio/audioframeinputnode_stop_1201535524.md index 767fd4c982..9f19d67750 100644 --- a/windows.media.audio/audioframeinputnode_stop_1201535524.md +++ b/windows.media.audio/audioframeinputnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameInputNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameInputNode.Stop ## -description Stops the audio frame input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameInputNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameInputNode.Stop + +## -description +Stops the audio frame input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode.md b/windows.media.audio/audioframeoutputnode.md index 3165513cbd..cc7e6426b4 100644 --- a/windows.media.audio/audioframeoutputnode.md +++ b/windows.media.audio/audioframeoutputnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioFrameOutputNode --api-type: winrt class ---- # Windows.Media.Audio.AudioFrameOutputNode ## -description Represents an audio frame output node. ## -remarks Get an instance of this class by calling [CreateFrameOutputNode](audiograph_createframeoutputnode.md). ## -examples ## -see-also [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioFrameOutputNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode + +## -description +Represents an audio frame output node. + +## -remarks +Get an instance of this class by calling [CreateFrameOutputNode](audiograph_createframeoutputnode.md). + +## -examples + +## -see-also +[IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audioframeoutputnode_close_811482585.md b/windows.media.audio/audioframeoutputnode_close_811482585.md index a75dd93e80..f4706c62c5 100644 --- a/windows.media.audio/audioframeoutputnode_close_811482585.md +++ b/windows.media.audio/audioframeoutputnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.Close ## -description Closes the audio frame output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.Close + +## -description +Closes the audio frame output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_consumeinput.md b/windows.media.audio/audioframeoutputnode_consumeinput.md index 1b5bed532c..8c7d0cee8c 100644 --- a/windows.media.audio/audioframeoutputnode_consumeinput.md +++ b/windows.media.audio/audioframeoutputnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameOutputNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameOutputNode.ConsumeInput ## -description Gets or sets a value indicating if the audio frame output node consumes input. ## -property-value True if the audio frame output node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameOutputNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio frame output node consumes input. + +## -property-value +True if the audio frame output node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audioframeoutputnode_disableeffectsbydefinition_730128310.md index 0c1cfe2ba7..689b840ae6 100644 --- a/windows.media.audio/audioframeoutputnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audioframeoutputnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audioframeoutputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audioframeoutputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_effectdefinitions.md b/windows.media.audio/audioframeoutputnode_effectdefinitions.md index 5605e6e53f..aa7e54c466 100644 --- a/windows.media.audio/audioframeoutputnode_effectdefinitions.md +++ b/windows.media.audio/audioframeoutputnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameOutputNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameOutputNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio frame output node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameOutputNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio frame output node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audioframeoutputnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audioframeoutputnode_enableeffectsbydefinition_1376948293.md index d65beb4ad8..741ff2ee8d 100644 --- a/windows.media.audio/audioframeoutputnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audioframeoutputnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audioframeoutputnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audioframeoutputnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_encodingproperties.md b/windows.media.audio/audioframeoutputnode_encodingproperties.md index ace776f3db..2a0d19613d 100644 --- a/windows.media.audio/audioframeoutputnode_encodingproperties.md +++ b/windows.media.audio/audioframeoutputnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameOutputNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameOutputNode.EncodingProperties ## -description Gets the encoding properties for the audio frame output node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameOutputNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.EncodingProperties + +## -description +Gets the encoding properties for the audio frame output node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_getframe_21670008.md b/windows.media.audio/audioframeoutputnode_getframe_21670008.md index 814b6c5f13..b479aa6776 100644 --- a/windows.media.audio/audioframeoutputnode_getframe_21670008.md +++ b/windows.media.audio/audioframeoutputnode_getframe_21670008.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.GetFrame --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.GetFrame ## -description Gets an audio frame containing all of the data accumulated by this node since the previous call to **GetFrame**. If **GetFrame** has not yet been called, the audio frame will contain all of the data accumulated since the node was created. ## -returns An [AudioFrame](../windows.media/audioframe.md) object representing the frame. ## -remarks If you want to retrieve audio frames on a regular cadence, synchronized with the audio graph, you can call this method from within the synchronous [QuantumStarted](audiograph_quantumstarted.md) event handler. The [QuantumProcessed](audiograph_quantumprocessed.md) event is raised asynchronously after the audio engine has completed audio processing, which means its cadence may be irregular. Therefore you should not use the **QuantumProcessed** event for synchronized processing of audio frame data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.GetFrame +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.GetFrame + +## -description +Gets an audio frame containing all of the data accumulated by this node since the previous call to **GetFrame**. If **GetFrame** has not yet been called, the audio frame will contain all of the data accumulated since the node was created. + +## -returns +An [AudioFrame](../windows.media/audioframe.md) object representing the frame. + +## -remarks +If you want to retrieve audio frames on a regular cadence, synchronized with the audio graph, you can call this method from within the synchronous [QuantumStarted](audiograph_quantumstarted.md) event handler. The [QuantumProcessed](audiograph_quantumprocessed.md) event is raised asynchronously after the audio engine has completed audio processing, which means its cadence may be irregular. Therefore you should not use the **QuantumProcessed** event for synchronized processing of audio frame data. + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_outgoinggain.md b/windows.media.audio/audioframeoutputnode_outgoinggain.md index 3ea4eeebad..e28e24bbe1 100644 --- a/windows.media.audio/audioframeoutputnode_outgoinggain.md +++ b/windows.media.audio/audioframeoutputnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioFrameOutputNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioFrameOutputNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio frame output node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioFrameOutputNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio frame output node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_reset_1636126115.md b/windows.media.audio/audioframeoutputnode_reset_1636126115.md index 992f7d47c2..fe537fdc7e 100644 --- a/windows.media.audio/audioframeoutputnode_reset_1636126115.md +++ b/windows.media.audio/audioframeoutputnode_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.Reset ## -description Resets the audio frame output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.Reset + +## -description +Resets the audio frame output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_start_1587696324.md b/windows.media.audio/audioframeoutputnode_start_1587696324.md index 3ff26f6af3..d3cfebe8ff 100644 --- a/windows.media.audio/audioframeoutputnode_start_1587696324.md +++ b/windows.media.audio/audioframeoutputnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.Start ## -description Starts the audio frame output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.Start + +## -description +Starts the audio frame output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audioframeoutputnode_stop_1201535524.md b/windows.media.audio/audioframeoutputnode_stop_1201535524.md index 6861565441..e2e7fd4595 100644 --- a/windows.media.audio/audioframeoutputnode_stop_1201535524.md +++ b/windows.media.audio/audioframeoutputnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioFrameOutputNode.Stop ## -description Stops the audio frame output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioFrameOutputNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioFrameOutputNode.Stop + +## -description +Stops the audio frame output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph.md b/windows.media.audio/audiograph.md index c150b3798c..807c34c30c 100644 --- a/windows.media.audio/audiograph.md +++ b/windows.media.audio/audiograph.md @@ -1,3 +1,30 @@ ---- -api-id: T:Windows.Media.Audio.AudioGraph --api-type: winrt class ---- # Windows.Media.Audio.AudioGraph ## -description Represents an audio graph of connected input, output, and submix nodes that manipulate and route audio. ## -remarks The audio graph is made up of input nodes, output nodes, and submix nodes. Input nodes include audio files, audio devices, and code that generates audio data. Output nodes also include audio files, audio devices, and code that processes audio data. When the graph is started, audio data flows through the graph from the input nodes, through any submix nodes, to the output nodes. Each node can have zero or more audio effects that are applied to the audio data before it is passed to the next node. This class and related APIs enable you to develop audio applications more quickly and easily than the low-level COM XAudio2 APIs. For how-to guidance on using audio graphs, see [Audio graphs](https://msdn.microsoft.com/windows/uwp/audio-video-camera/audio-graphs). Get an instance of this class by calling [AudioGraph.CreateAsync](audiograph_createasync.md). The entire audio graph must operate at the same sample rate. Sources can have different sample rates, but are resampled immediately. > [!NOTE] > If no audio devices are available, the audio graph cannot be instantiated. ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Audio graphs](https://msdn.microsoft.com/windows/uwp/audio-video-camera/audio-graphs) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioGraph +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioGraph + +## -description +Represents an audio graph of connected input, output, and submix nodes that manipulate and route audio. + +## -remarks +The audio graph is made up of input nodes, output nodes, and submix nodes. Input nodes include audio files, audio devices, and code that generates audio data. Output nodes also include audio files, audio devices, and code that processes audio data. When the graph is started, audio data flows through the graph from the input nodes, through any submix nodes, to the output nodes. Each node can have zero or more audio effects that are applied to the audio data before it is passed to the next node. This class and related APIs enable you to develop audio applications more quickly and easily than the low-level COM XAudio2 APIs. For how-to guidance on using audio graphs, see [Audio graphs](https://msdn.microsoft.com/windows/uwp/audio-video-camera/audio-graphs). + +Get an instance of this class by calling [AudioGraph.CreateAsync](audiograph_createasync.md). + +The entire audio graph must operate at the same sample rate. Sources can have different sample rates, but are resampled immediately. + + + +> [!NOTE] +> If no audio devices are available, the audio graph cannot be instantiated. + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Audio graphs](https://msdn.microsoft.com/windows/uwp/audio-video-camera/audio-graphs) \ No newline at end of file diff --git a/windows.media.audio/audiograph_close_811482585.md b/windows.media.audio/audiograph_close_811482585.md index 79bc924ef4..f5375f40e4 100644 --- a/windows.media.audio/audiograph_close_811482585.md +++ b/windows.media.audio/audiograph_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.Close ## -description Closes the audio graph. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.Close + +## -description +Closes the audio graph. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_completedquantumcount.md b/windows.media.audio/audiograph_completedquantumcount.md index 8cd245cce4..03473670e9 100644 --- a/windows.media.audio/audiograph_completedquantumcount.md +++ b/windows.media.audio/audiograph_completedquantumcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraph.CompletedQuantumCount --api-type: winrt property ---- # Windows.Media.Audio.AudioGraph.CompletedQuantumCount ## -description Gets the completed quantum count for the audio graph. ## -property-value A value indicating the completed quantum count. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraph.CompletedQuantumCount +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraph.CompletedQuantumCount + +## -description +Gets the completed quantum count for the audio graph. + +## -property-value +A value indicating the completed quantum count. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_createasync_145006550.md b/windows.media.audio/audiograph_createasync_145006550.md index 1e2fff9a72..db6d275c11 100644 --- a/windows.media.audio/audiograph_createasync_145006550.md +++ b/windows.media.audio/audiograph_createasync_145006550.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateAsync(Windows.Media.Audio.AudioGraphSettings) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateAsync ## -description Creates an audio graph with specific settings. ## -parameters ### -param settings An [AudioGraphSettings](audiographsettings.md) object representing the source audio file. ## -returns When this operation completes, a [CreateAudioGraphResult](createaudiographresult.md) object is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateAsync(Windows.Media.Audio.AudioGraphSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateAsync + +## -description +Creates an audio graph with specific settings. + +## -parameters +### -param settings +An [AudioGraphSettings](audiographsettings.md) object representing the source audio file. + +## -returns +When this operation completes, a [CreateAudioGraphResult](createaudiographresult.md) object is returned. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_createbatchupdater_98890190.md b/windows.media.audio/audiograph_createbatchupdater_98890190.md index 211ad39bac..1b218008a1 100644 --- a/windows.media.audio/audiograph_createbatchupdater_98890190.md +++ b/windows.media.audio/audiograph_createbatchupdater_98890190.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateBatchUpdater --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateBatchUpdater ## -description Creates a new [AudioGraphBatchUpdater](audiographbatchupdater.md) for the [AudioGraph](audiograph.md) which causes all subsequent modifications to all nodes in the audio graph to be accumulated and then committed once your app closes or disposes of the batch updater object. ## -returns A new batch updater for the audio graph. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateBatchUpdater +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateBatchUpdater + +## -description +Creates a new [AudioGraphBatchUpdater](audiographbatchupdater.md) for the [AudioGraph](audiograph.md) which causes all subsequent modifications to all nodes in the audio graph to be accumulated and then committed once your app closes or disposes of the batch updater object. + +## -returns +A new batch updater for the audio graph. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_createdeviceinputnodeasync_1285412965.md b/windows.media.audio/audiograph_createdeviceinputnodeasync_1285412965.md index 7dcf82f7ed..d3e62ead1d 100644 --- a/windows.media.audio/audiograph_createdeviceinputnodeasync_1285412965.md +++ b/windows.media.audio/audiograph_createdeviceinputnodeasync_1285412965.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory,Windows.Media.MediaProperties.AudioEncodingProperties) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync ## -description Creates a device input node for the indicated media and audio encoding properties. ## -parameters ### -param category An enumeration value indicating the category of the media processed by this node. ### -param encodingProperties An object representing the audio encoding properties for the device input node. ## -returns An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. ## -remarks The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. ## -examples ## -see-also [CreateDeviceInputNodeAsync(MediaCategory)](audiograph_createdeviceinputnodeasync_420106269.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties, DeviceInformation)](audiograph_createdeviceinputnodeasync_757181607.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory,Windows.Media.MediaProperties.AudioEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync + +## -description +Creates a device input node for the indicated media and audio encoding properties. + +## -parameters +### -param category +An enumeration value indicating the category of the media processed by this node. + +### -param encodingProperties +An object representing the audio encoding properties for the device input node. + +## -returns +An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. + +## -remarks +The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. + +## -examples + +## -see-also +[CreateDeviceInputNodeAsync(MediaCategory)](audiograph_createdeviceinputnodeasync_420106269.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties, DeviceInformation)](audiograph_createdeviceinputnodeasync_757181607.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createdeviceinputnodeasync_2137015807.md b/windows.media.audio/audiograph_createdeviceinputnodeasync_2137015807.md index d596d4a923..9046fe46ec 100644 --- a/windows.media.audio/audiograph_createdeviceinputnodeasync_2137015807.md +++ b/windows.media.audio/audiograph_createdeviceinputnodeasync_2137015807.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory,Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Devices.Enumeration.DeviceInformation,Windows.Media.Audio.AudioNodeEmitter) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync ## -description Creates a device input node that supports spatial audio for the indicated media, audio encoding properties, and device information. ## -parameters ### -param category An enumeration value indicating the category of the media processed by this node. ### -param encodingProperties An object representing the audio encoding properties for the device input node. ### -param device An object representing the device associated with the device input node. ### -param emitter An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. ## -returns An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. ## -remarks ## -examples ## -see-also [CreateDeviceInputNodeAsync(MediaCategory)](audiograph_createdeviceinputnodeasync_420106269.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties)](audiograph_createdeviceinputnodeasync_1285412965.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties, DeviceInformation)](audiograph_createdeviceinputnodeasync_757181607.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory,Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Devices.Enumeration.DeviceInformation,Windows.Media.Audio.AudioNodeEmitter) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync + +## -description +Creates a device input node that supports spatial audio for the indicated media, audio encoding properties, and device information. + +## -parameters +### -param category +An enumeration value indicating the category of the media processed by this node. + +### -param encodingProperties +An object representing the audio encoding properties for the device input node. + +### -param device +An object representing the device associated with the device input node. + +### -param emitter +An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. + +## -returns +An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. + +## -remarks + +## -examples + +## -see-also +[CreateDeviceInputNodeAsync(MediaCategory)](audiograph_createdeviceinputnodeasync_420106269.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties)](audiograph_createdeviceinputnodeasync_1285412965.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties, DeviceInformation)](audiograph_createdeviceinputnodeasync_757181607.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createdeviceinputnodeasync_420106269.md b/windows.media.audio/audiograph_createdeviceinputnodeasync_420106269.md index 3dab833dae..f9b814a90a 100644 --- a/windows.media.audio/audiograph_createdeviceinputnodeasync_420106269.md +++ b/windows.media.audio/audiograph_createdeviceinputnodeasync_420106269.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync ## -description Creates a device input node for the indicated media. ## -parameters ### -param category An enumeration value indicating the category of the media processed by this node. ## -returns An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. ## -remarks ## -examples ## -see-also [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties)](audiograph_createdeviceinputnodeasync_1285412965.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties, DeviceInformation)](audiograph_createdeviceinputnodeasync_757181607.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync + +## -description +Creates a device input node for the indicated media. + +## -parameters +### -param category +An enumeration value indicating the category of the media processed by this node. + +## -returns +An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. + +## -remarks + +## -examples + +## -see-also +[CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties)](audiograph_createdeviceinputnodeasync_1285412965.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties, DeviceInformation)](audiograph_createdeviceinputnodeasync_757181607.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createdeviceinputnodeasync_757181607.md b/windows.media.audio/audiograph_createdeviceinputnodeasync_757181607.md index fc335f5727..44a727eb7a 100644 --- a/windows.media.audio/audiograph_createdeviceinputnodeasync_757181607.md +++ b/windows.media.audio/audiograph_createdeviceinputnodeasync_757181607.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory,Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync ## -description Creates a device input node for the indicated media, audio encoding properties, and device information. ## -parameters ### -param category An enumeration value indicating the category of the media processed by this node. ### -param encodingProperties An object representing the audio encoding properties for the device input node. ### -param device An object representing the device associated with the device input node. ## -returns An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. ## -remarks The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. ## -examples ## -see-also [CreateDeviceInputNodeAsync(MediaCategory)](audiograph_createdeviceinputnodeasync_420106269.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties)](audiograph_createdeviceinputnodeasync_1285412965.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync(Windows.Media.Capture.MediaCategory,Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateDeviceInputNodeAsync + +## -description +Creates a device input node for the indicated media, audio encoding properties, and device information. + +## -parameters +### -param category +An enumeration value indicating the category of the media processed by this node. + +### -param encodingProperties +An object representing the audio encoding properties for the device input node. + +### -param device +An object representing the device associated with the device input node. + +## -returns +An asynchronous operation that returns a [CreateAudioDeviceInputNodeResult](createaudiodeviceinputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceInputNode](createaudiodeviceinputnoderesult_deviceinputnode.md) property provides a reference to the created input node on success. + +## -remarks +The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. + +## -examples + +## -see-also +[CreateDeviceInputNodeAsync(MediaCategory)](audiograph_createdeviceinputnodeasync_420106269.md), [CreateDeviceInputNodeAsync(MediaCategory, AudioEncodingProperties)](audiograph_createdeviceinputnodeasync_1285412965.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createdeviceoutputnodeasync_954542725.md b/windows.media.audio/audiograph_createdeviceoutputnodeasync_954542725.md index 45d89e4bb3..13e98966a6 100644 --- a/windows.media.audio/audiograph_createdeviceoutputnodeasync_954542725.md +++ b/windows.media.audio/audiograph_createdeviceoutputnodeasync_954542725.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceOutputNodeAsync --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateDeviceOutputNodeAsync ## -description Creates a new device output node for the audio graph. ## -returns An asynchronous operation that returns a [CreateAudioDeviceOutputNodeResult](createaudiodeviceoutputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceoutputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceOutputNode](createaudiodeviceoutputnoderesult.md) property provides a reference to the created output node on success. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateDeviceOutputNodeAsync +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateDeviceOutputNodeAsync + +## -description +Creates a new device output node for the audio graph. + +## -returns +An asynchronous operation that returns a [CreateAudioDeviceOutputNodeResult](createaudiodeviceoutputnoderesult.md) on completion. This object exposes a [Status](createaudiodeviceoutputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [DeviceOutputNode](createaudiodeviceoutputnoderesult.md) property provides a reference to the created output node on success. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_createfileinputnodeasync_152724062.md b/windows.media.audio/audiograph_createfileinputnodeasync_152724062.md index ea3d7a1187..23e5a7e561 100644 --- a/windows.media.audio/audiograph_createfileinputnodeasync_152724062.md +++ b/windows.media.audio/audiograph_createfileinputnodeasync_152724062.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync ## -description Creates a file input node for the audio graph. ## -parameters ### -param file A [StorageFile](../windows.storage/storagefile.md) object representing the file associated with the file input node. ## -returns When this operation completes, a **CreateAudioFileInputNodeResult** object is returned. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync + +## -description +Creates a file input node for the audio graph. + +## -parameters +### -param file +A [StorageFile](../windows.storage/storagefile.md) object representing the file associated with the file input node. + +## -returns +When this operation completes, a **CreateAudioFileInputNodeResult** object is returned. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_createfileinputnodeasync_1569331208.md b/windows.media.audio/audiograph_createfileinputnodeasync_1569331208.md index fb674d316a..d23520fa09 100644 --- a/windows.media.audio/audiograph_createfileinputnodeasync_1569331208.md +++ b/windows.media.audio/audiograph_createfileinputnodeasync_1569331208.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync(Windows.Storage.IStorageFile,Windows.Media.Audio.AudioNodeEmitter) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync ## -description Creates a file input node that supports spatial audio. ## -parameters ### -param file A [IStorageFile](../windows.storage/istoragefile.md) object representing the file associated with the file input node. ### -param emitter An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. ## -returns An asynchronous operation that returns a [CreateAudioFileInputNodeResult](createaudiofileinputnoderesult.md) on completion. This object exposes a [Status](createaudiofileinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [FileInputNode](createaudiofileinputnoderesult_fileinputnode.md) property provides a reference to the created input node on success. ## -remarks To create a file input node with an emitter, the audio file must be encoded in mono at 48kHz. ## -examples ## -see-also [CreateFileInputNodeAsync(IStorageFile)](audiograph_createfileinputnodeasync_152724062.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync(Windows.Storage.IStorageFile,Windows.Media.Audio.AudioNodeEmitter) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFileInputNodeAsync + +## -description +Creates a file input node that supports spatial audio. + +## -parameters +### -param file +A [IStorageFile](../windows.storage/istoragefile.md) object representing the file associated with the file input node. + +### -param emitter +An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. + +## -returns +An asynchronous operation that returns a [CreateAudioFileInputNodeResult](createaudiofileinputnoderesult.md) on completion. This object exposes a [Status](createaudiofileinputnoderesult_status.md) property, that indicates either that the operation was successful or the reason why the operation failed. The [FileInputNode](createaudiofileinputnoderesult_fileinputnode.md) property provides a reference to the created input node on success. + +## -remarks +To create a file input node with an emitter, the audio file must be encoded in mono at 48kHz. + +## -examples + +## -see-also +[CreateFileInputNodeAsync(IStorageFile)](audiograph_createfileinputnodeasync_152724062.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createfileoutputnodeasync_1127853521.md b/windows.media.audio/audiograph_createfileoutputnodeasync_1127853521.md index 2fee3736e1..97620f2e6e 100644 --- a/windows.media.audio/audiograph_createfileoutputnodeasync_1127853521.md +++ b/windows.media.audio/audiograph_createfileoutputnodeasync_1127853521.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync ## -description Creates a file output node for the indicated file. ## -parameters ### -param file A [StorageFile](../windows.storage/storagefile.md) object representing the file. ## -returns When this operation completes, a **CreateAudioFileOutputNodeResult** object is returned. ## -remarks The file output node created by this method defaults to a WAV file format with the same [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) properties as the [AudioGraph](audiograph.md) to which it belongs. To create a file output node with custom encoding properties use the [CreateFileOutputNodeAsync(IStorageFile, MediaEncodingProfile)](audiograph_createfileoutputnodeasync_870871467.md) overload. ## -examples ## -see-also [CreateFileOutputNodeAsync(IStorageFile, AudioEncodingProperties)](audiograph_createfileoutputnodeasync_870871467.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync + +## -description +Creates a file output node for the indicated file. + +## -parameters +### -param file +A [StorageFile](../windows.storage/storagefile.md) object representing the file. + +## -returns +When this operation completes, a **CreateAudioFileOutputNodeResult** object is returned. + +## -remarks +The file output node created by this method defaults to a WAV file format with the same [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) properties as the [AudioGraph](audiograph.md) to which it belongs. To create a file output node with custom encoding properties use the [CreateFileOutputNodeAsync(IStorageFile, MediaEncodingProfile)](audiograph_createfileoutputnodeasync_870871467.md) overload. + +## -examples + +## -see-also +[CreateFileOutputNodeAsync(IStorageFile, AudioEncodingProperties)](audiograph_createfileoutputnodeasync_870871467.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createfileoutputnodeasync_870871467.md b/windows.media.audio/audiograph_createfileoutputnodeasync_870871467.md index cfe7894a25..648a3fc5f2 100644 --- a/windows.media.audio/audiograph_createfileoutputnodeasync_870871467.md +++ b/windows.media.audio/audiograph_createfileoutputnodeasync_870871467.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync(Windows.Storage.IStorageFile,Windows.Media.MediaProperties.MediaEncodingProfile) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync ## -description Creates a file output node for the indicated file and media encoding profile. ## -parameters ### -param file A [StorageFile](../windows.storage/storagefile.md) object representing the file. ### -param fileEncodingProfile An objecting representing the media encoding profile. ## -returns When this operation completes, a **CreateAudioFileOutputNodeResult** object is returned. ## -remarks The *fileEncodingProfile* parameter specifies the [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md) with which the output file will be created. If this parameter is null, the encoding profile defaults to a WAV file format with the same [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) as the [AudioGraph](audiograph.md) to which it belongs. ## -examples ## -see-also [CreateFileOutputNodeAsync(IStorageFile)](audiograph_createfileoutputnodeasync_1127853521.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync(Windows.Storage.IStorageFile,Windows.Media.MediaProperties.MediaEncodingProfile) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFileOutputNodeAsync + +## -description +Creates a file output node for the indicated file and media encoding profile. + +## -parameters +### -param file +A [StorageFile](../windows.storage/storagefile.md) object representing the file. + +### -param fileEncodingProfile +An objecting representing the media encoding profile. + +## -returns +When this operation completes, a **CreateAudioFileOutputNodeResult** object is returned. + +## -remarks +The *fileEncodingProfile* parameter specifies the [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md) with which the output file will be created. If this parameter is null, the encoding profile defaults to a WAV file format with the same [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) as the [AudioGraph](audiograph.md) to which it belongs. + +## -examples + +## -see-also +[CreateFileOutputNodeAsync(IStorageFile)](audiograph_createfileoutputnodeasync_1127853521.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createframeinputnode_2056779528.md b/windows.media.audio/audiograph_createframeinputnode_2056779528.md index e6e991a020..424d75ab15 100644 --- a/windows.media.audio/audiograph_createframeinputnode_2056779528.md +++ b/windows.media.audio/audiograph_createframeinputnode_2056779528.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameInputNode(Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Media.Audio.AudioNodeEmitter) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFrameInputNode ## -description Creates an audio frame input node with the specified encoding properties that supports spatial audio. ## -parameters ### -param encodingProperties An object representing encoding properties. ### -param emitter An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. ## -returns An audio frame input node. ## -remarks The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. ## -examples ## -see-also [CreateFrameInputNode](audiograph_createframeinputnode_80496994.md), [CreateFrameInputNode(AudioEncodingProperties)](audiograph_createframeinputnode_772246878.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameInputNode(Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Media.Audio.AudioNodeEmitter) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFrameInputNode + +## -description +Creates an audio frame input node with the specified encoding properties that supports spatial audio. + +## -parameters +### -param encodingProperties +An object representing encoding properties. + +### -param emitter +An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. + +## -returns +An audio frame input node. + +## -remarks +The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. + +## -examples + +## -see-also +[CreateFrameInputNode](audiograph_createframeinputnode_80496994.md), [CreateFrameInputNode(AudioEncodingProperties)](audiograph_createframeinputnode_772246878.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createframeinputnode_772246878.md b/windows.media.audio/audiograph_createframeinputnode_772246878.md index 5f96679728..aa01f8f021 100644 --- a/windows.media.audio/audiograph_createframeinputnode_772246878.md +++ b/windows.media.audio/audiograph_createframeinputnode_772246878.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameInputNode(Windows.Media.MediaProperties.AudioEncodingProperties) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFrameInputNode ## -description Creates an audio frame input node with the specified encoding properties. ## -parameters ### -param encodingProperties An object representing encoding properties. ## -returns An audio frame input node. ## -remarks The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. ## -examples ## -see-also [CreateFrameInputNode](audiograph_createframeinputnode_80496994.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameInputNode(Windows.Media.MediaProperties.AudioEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFrameInputNode + +## -description +Creates an audio frame input node with the specified encoding properties. + +## -parameters +### -param encodingProperties +An object representing encoding properties. + +## -returns +An audio frame input node. + +## -remarks +The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. + +## -examples + +## -see-also +[CreateFrameInputNode](audiograph_createframeinputnode_80496994.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createframeinputnode_80496994.md b/windows.media.audio/audiograph_createframeinputnode_80496994.md index e3c976a394..db4be7a77c 100644 --- a/windows.media.audio/audiograph_createframeinputnode_80496994.md +++ b/windows.media.audio/audiograph_createframeinputnode_80496994.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameInputNode --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFrameInputNode ## -description Creates a simple audio frame input node for the audio graph. ## -returns An audio frame input node. ## -remarks ## -examples ## -see-also [CreateFrameInputNode(AudioEncodingProperties)](audiograph_createframeinputnode_772246878.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameInputNode +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFrameInputNode + +## -description +Creates a simple audio frame input node for the audio graph. + +## -returns +An audio frame input node. + +## -remarks + +## -examples + +## -see-also +[CreateFrameInputNode(AudioEncodingProperties)](audiograph_createframeinputnode_772246878.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createframeoutputnode_1505747890.md b/windows.media.audio/audiograph_createframeoutputnode_1505747890.md index 5dde5bf51a..87d6c89efd 100644 --- a/windows.media.audio/audiograph_createframeoutputnode_1505747890.md +++ b/windows.media.audio/audiograph_createframeoutputnode_1505747890.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameOutputNode(Windows.Media.MediaProperties.AudioEncodingProperties) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFrameOutputNode ## -description Creates a frame output node from encoding properties. ## -parameters ### -param encodingProperties An object representing audio encoding properties. ## -returns An audio frame output node. ## -remarks The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. ## -examples ## -see-also [CreateFrameOutputNode](audiograph_createframeoutputnode_1936992142.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameOutputNode(Windows.Media.MediaProperties.AudioEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFrameOutputNode + +## -description +Creates a frame output node from encoding properties. + +## -parameters +### -param encodingProperties +An object representing audio encoding properties. + +## -returns +An audio frame output node. + +## -remarks +The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. + +## -examples + +## -see-also +[CreateFrameOutputNode](audiograph_createframeoutputnode_1936992142.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createframeoutputnode_1936992142.md b/windows.media.audio/audiograph_createframeoutputnode_1936992142.md index a779ded93a..b118d4e097 100644 --- a/windows.media.audio/audiograph_createframeoutputnode_1936992142.md +++ b/windows.media.audio/audiograph_createframeoutputnode_1936992142.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameOutputNode --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateFrameOutputNode ## -description Creates a simple frame output node for the audio graph. ## -returns An audio frame output node. ## -remarks ## -examples ## -see-also [CreateFrameOutputNode(AudioEncodingProperties)](audiograph_createframeoutputnode_1505747890.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateFrameOutputNode +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateFrameOutputNode + +## -description +Creates a simple frame output node for the audio graph. + +## -returns +An audio frame output node. + +## -remarks + +## -examples + +## -see-also +[CreateFrameOutputNode(AudioEncodingProperties)](audiograph_createframeoutputnode_1505747890.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createsubmixnode_1505743305.md b/windows.media.audio/audiograph_createsubmixnode_1505743305.md index 5f408cc29d..8827288c7e 100644 --- a/windows.media.audio/audiograph_createsubmixnode_1505743305.md +++ b/windows.media.audio/audiograph_createsubmixnode_1505743305.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateSubmixNode --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateSubmixNode ## -description Creates an audio graph submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes. ## -returns An audio submix node. ## -remarks ## -examples ## -see-also [CreateSubmixNode(AudioEncodingProperties)](audiograph_createsubmixnode_1936987637.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateSubmixNode +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateSubmixNode + +## -description +Creates an audio graph submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes. + +## -returns +An audio submix node. + +## -remarks + +## -examples + +## -see-also +[CreateSubmixNode(AudioEncodingProperties)](audiograph_createsubmixnode_1936987637.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createsubmixnode_1936987637.md b/windows.media.audio/audiograph_createsubmixnode_1936987637.md index 26b0b42a34..b9a6f968b5 100644 --- a/windows.media.audio/audiograph_createsubmixnode_1936987637.md +++ b/windows.media.audio/audiograph_createsubmixnode_1936987637.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateSubmixNode(Windows.Media.MediaProperties.AudioEncodingProperties) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateSubmixNode ## -description Creates an audio graph submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes. ## -parameters ### -param encodingProperties An object representing audio encoding properties. ## -returns An audio submix node. ## -remarks The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. ## -examples ## -see-also [CreateSubmixNode](audiograph_createsubmixnode_1505743305.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateSubmixNode(Windows.Media.MediaProperties.AudioEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateSubmixNode + +## -description +Creates an audio graph submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes. + +## -parameters +### -param encodingProperties +An object representing audio encoding properties. + +## -returns +An audio submix node. + +## -remarks +The *encodingProperties* parameter specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. + +## -examples + +## -see-also +[CreateSubmixNode](audiograph_createsubmixnode_1505743305.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_createsubmixnode_669282211.md b/windows.media.audio/audiograph_createsubmixnode_669282211.md index 84488c2e37..ea72ce4d32 100644 --- a/windows.media.audio/audiograph_createsubmixnode_669282211.md +++ b/windows.media.audio/audiograph_createsubmixnode_669282211.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.CreateSubmixNode(Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Media.Audio.AudioNodeEmitter) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.CreateSubmixNode ## -description Creates an audio graph submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes and that supports spatial audio. ## -parameters ### -param encodingProperties An object representing audio encoding properties. ### -param emitter An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. ## -returns An audio submix node. ## -remarks ## -examples ## -see-also [CreateSubmixNode](audiograph_createsubmixnode_1505743305.md), [CreateSubmixNode(AudioEncodingProperties)](audiograph_createsubmixnode_1936987637.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.CreateSubmixNode(Windows.Media.MediaProperties.AudioEncodingProperties,Windows.Media.Audio.AudioNodeEmitter) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.CreateSubmixNode + +## -description +Creates an audio graph submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes and that supports spatial audio. + +## -parameters +### -param encodingProperties +An object representing audio encoding properties. + +### -param emitter +An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. + +## -returns +An audio submix node. + +## -remarks + +## -examples + +## -see-also +[CreateSubmixNode](audiograph_createsubmixnode_1505743305.md), [CreateSubmixNode(AudioEncodingProperties)](audiograph_createsubmixnode_1936987637.md) \ No newline at end of file diff --git a/windows.media.audio/audiograph_encodingproperties.md b/windows.media.audio/audiograph_encodingproperties.md index 13216ced85..497fe45af6 100644 --- a/windows.media.audio/audiograph_encodingproperties.md +++ b/windows.media.audio/audiograph_encodingproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraph.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioGraph.EncodingProperties ## -description Gets the encoding properties for the audio graph. ## -property-value The encoding properties for the audio graph. ## -remarks Specify the encoding properties for an audio graph by setting the [AudioGraphSettings::EncodingProperties](audiographsettings_encodingproperties.md) property before creating the audio graph with a call to [CreateAsync](audiograph_createasync_145006550.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraph.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraph.EncodingProperties + +## -description +Gets the encoding properties for the audio graph. + +## -property-value +The encoding properties for the audio graph. + +## -remarks +Specify the encoding properties for an audio graph by setting the [AudioGraphSettings::EncodingProperties](audiographsettings_encodingproperties.md) property before creating the audio graph with a call to [CreateAsync](audiograph_createasync_145006550.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_latencyinsamples.md b/windows.media.audio/audiograph_latencyinsamples.md index ab3e1b78a3..2f4b2b4552 100644 --- a/windows.media.audio/audiograph_latencyinsamples.md +++ b/windows.media.audio/audiograph_latencyinsamples.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraph.LatencyInSamples --api-type: winrt property ---- # Windows.Media.Audio.AudioGraph.LatencyInSamples ## -description Gets the latency in samples that the audio graph supports. ## -property-value A value indicating the sample latency. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraph.LatencyInSamples +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraph.LatencyInSamples + +## -description +Gets the latency in samples that the audio graph supports. + +## -property-value +A value indicating the sample latency. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_primaryrenderdevice.md b/windows.media.audio/audiograph_primaryrenderdevice.md index 36e4fb089c..8b1c3a88b8 100644 --- a/windows.media.audio/audiograph_primaryrenderdevice.md +++ b/windows.media.audio/audiograph_primaryrenderdevice.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraph.PrimaryRenderDevice --api-type: winrt property ---- # Windows.Media.Audio.AudioGraph.PrimaryRenderDevice ## -description Gets the primary render device for the audio graph. ## -property-value The primary render device for the audio graph. ## -remarks Specify the primary rendering device for an audio graph by setting the [AudioGraphSettings::PrimaryRenderDevice](audiographsettings_primaryrenderdevice.md) property before creating the audio graph with a call to [CreateAsync](audiograph_createasync_145006550.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraph.PrimaryRenderDevice +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraph.PrimaryRenderDevice + +## -description +Gets the primary render device for the audio graph. + +## -property-value +The primary render device for the audio graph. + +## -remarks +Specify the primary rendering device for an audio graph by setting the [AudioGraphSettings::PrimaryRenderDevice](audiographsettings_primaryrenderdevice.md) property before creating the audio graph with a call to [CreateAsync](audiograph_createasync_145006550.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_quantumprocessed.md b/windows.media.audio/audiograph_quantumprocessed.md index e5b95a7058..446af516fa 100644 --- a/windows.media.audio/audiograph_quantumprocessed.md +++ b/windows.media.audio/audiograph_quantumprocessed.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Audio.AudioGraph.QuantumProcessed --api-type: winrt event ---- # Windows.Media.Audio.AudioGraph.QuantumProcessed ## -description Notifies that the audio graph has processed the specified quantum. ## -remarks The **QuantumProcessed** event is asynchronous, which means that you can update the properties and state of the [AudioGraph](audiograph.md) and individual audio nodes in the handler for this event. However, because this event is asynchronous and raised only after the audio engine has completed processing, it is not raised on a regular cadence and it should not be used for synchronized processing of audio data such as that obtained from the [AudioFrameOutputNode.GetFrame](audioframeoutputnode_getframe.md) method. Instead, it is recommended that you use the [QuantumStarted](audiograph_quantumstarted.md) event for synchronized audio processing. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Audio.AudioGraph.QuantumProcessed +-api-type: winrt event +--- + + + +# Windows.Media.Audio.AudioGraph.QuantumProcessed + +## -description +Notifies that the audio graph has processed the specified quantum. + +## -remarks +The **QuantumProcessed** event is asynchronous, which means that you can update the properties and state of the [AudioGraph](audiograph.md) and individual audio nodes in the handler for this event. However, because this event is asynchronous and raised only after the audio engine has completed processing, it is not raised on a regular cadence and it should not be used for synchronized processing of audio data such as that obtained from the [AudioFrameOutputNode.GetFrame](audioframeoutputnode_getframe.md) method. Instead, it is recommended that you use the [QuantumStarted](audiograph_quantumstarted.md) event for synchronized audio processing. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_quantumstarted.md b/windows.media.audio/audiograph_quantumstarted.md index a7b02aa698..12f6207435 100644 --- a/windows.media.audio/audiograph_quantumstarted.md +++ b/windows.media.audio/audiograph_quantumstarted.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Audio.AudioGraph.QuantumStarted --api-type: winrt event ---- # Windows.Media.Audio.AudioGraph.QuantumStarted ## -description Notifies that the audio graph has started processing a new quantum. ## -remarks The **QuantumStarted** event is synchronous, which means that you can't update the properties or state of the [AudioGraph](audiograph.md) or the individual audio nodes in the handler for this event. Attempting perform an operation such as stopping the audio graph or adding, removing, or starting an individual audio node will result in an exception being thrown. You can change the state of the graph and its nodes from within the asynchronous [QuantumProcessed](audiograph_quantumprocessed.md) event handler. Because this event is synchronous and fires regularly on the processing cadence of the audio graph, the event handler can be used for synchronized processing of audio data, such as that obtained from the [AudioFrameOutputNode.GetFrame](audioframeoutputnode_getframe.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Audio.AudioGraph.QuantumStarted +-api-type: winrt event +--- + + + +# Windows.Media.Audio.AudioGraph.QuantumStarted + +## -description +Notifies that the audio graph has started processing a new quantum. + +## -remarks +The **QuantumStarted** event is synchronous, which means that you can't update the properties or state of the [AudioGraph](audiograph.md) or the individual audio nodes in the handler for this event. Attempting perform an operation such as stopping the audio graph or adding, removing, or starting an individual audio node will result in an exception being thrown. You can change the state of the graph and its nodes from within the asynchronous [QuantumProcessed](audiograph_quantumprocessed.md) event handler. + +Because this event is synchronous and fires regularly on the processing cadence of the audio graph, the event handler can be used for synchronized processing of audio data, such as that obtained from the [AudioFrameOutputNode.GetFrame](audioframeoutputnode_getframe.md) method. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_renderdeviceaudioprocessing.md b/windows.media.audio/audiograph_renderdeviceaudioprocessing.md index f72e3d8fab..b6f498d81c 100644 --- a/windows.media.audio/audiograph_renderdeviceaudioprocessing.md +++ b/windows.media.audio/audiograph_renderdeviceaudioprocessing.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraph.RenderDeviceAudioProcessing --api-type: winrt property ---- # Windows.Media.Audio.AudioGraph.RenderDeviceAudioProcessing ## -description Gets a value that indicates the audio processing mode for the audio graph. ## -property-value A value that indicates the audio processing mode for the audio graph. ## -remarks Specify the audio processing mode for an audio graph by setting the [AudioGraphSettings.AudioProcessing](audiographsettings_desiredrenderdeviceaudioprocessing.md) property before creating the audio graph with a call to [CreateAsync](audiograph_createasync_145006550.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraph.RenderDeviceAudioProcessing +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraph.RenderDeviceAudioProcessing + +## -description +Gets a value that indicates the audio processing mode for the audio graph. + +## -property-value +A value that indicates the audio processing mode for the audio graph. + +## -remarks +Specify the audio processing mode for an audio graph by setting the [AudioGraphSettings.AudioProcessing](audiographsettings_desiredrenderdeviceaudioprocessing.md) property before creating the audio graph with a call to [CreateAsync](audiograph_createasync_145006550.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_resetallnodes_1223908051.md b/windows.media.audio/audiograph_resetallnodes_1223908051.md index 099b0f47f4..b6d22878a9 100644 --- a/windows.media.audio/audiograph_resetallnodes_1223908051.md +++ b/windows.media.audio/audiograph_resetallnodes_1223908051.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.ResetAllNodes --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.ResetAllNodes ## -description Resets all nodes in the audio graph. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.ResetAllNodes +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.ResetAllNodes + +## -description +Resets all nodes in the audio graph. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_samplesperquantum.md b/windows.media.audio/audiograph_samplesperquantum.md index 43c0a4fcdb..49b0ef506e 100644 --- a/windows.media.audio/audiograph_samplesperquantum.md +++ b/windows.media.audio/audiograph_samplesperquantum.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraph.SamplesPerQuantum --api-type: winrt property ---- # Windows.Media.Audio.AudioGraph.SamplesPerQuantum ## -description Gets the number of samples per quantum at which the audio graph is currently operating. ## -property-value A value indicating the number of samples per quantum. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraph.SamplesPerQuantum +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraph.SamplesPerQuantum + +## -description +Gets the number of samples per quantum at which the audio graph is currently operating. + +## -property-value +A value indicating the number of samples per quantum. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_start_1587696324.md b/windows.media.audio/audiograph_start_1587696324.md index 1c52779568..c642f45f0e 100644 --- a/windows.media.audio/audiograph_start_1587696324.md +++ b/windows.media.audio/audiograph_start_1587696324.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.Start ## -description Starts the audio graph. ## -remarks Starting and stopping the audio graph does not affect the state of the individual nodes in the graph. Calling **Start** on the audio graph causes all nodes that are in the started state to be processed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.Start + +## -description +Starts the audio graph. + +## -remarks +Starting and stopping the audio graph does not affect the state of the individual nodes in the graph. Calling **Start** on the audio graph causes all nodes that are in the started state to be processed. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_stop_1201535524.md b/windows.media.audio/audiograph_stop_1201535524.md index 29a8689466..f3431fa19d 100644 --- a/windows.media.audio/audiograph_stop_1201535524.md +++ b/windows.media.audio/audiograph_stop_1201535524.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraph.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioGraph.Stop ## -description Stops the audio graph. ## -remarks Starting and stopping the audio graph does not affect the state of the individual nodes in the graph. Calling [Start](audiograph_start.md) on the audio graph causes all nodes that are in the started state to be processed. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraph.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraph.Stop + +## -description +Stops the audio graph. + +## -remarks +Starting and stopping the audio graph does not affect the state of the individual nodes in the graph. Calling [Start](audiograph_start.md) on the audio graph causes all nodes that are in the started state to be processed. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiograph_unrecoverableerroroccurred.md b/windows.media.audio/audiograph_unrecoverableerroroccurred.md index 05eba6d551..b72d6931d7 100644 --- a/windows.media.audio/audiograph_unrecoverableerroroccurred.md +++ b/windows.media.audio/audiograph_unrecoverableerroroccurred.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Audio.AudioGraph.UnrecoverableErrorOccurred --api-type: winrt event ---- # Windows.Media.Audio.AudioGraph.UnrecoverableErrorOccurred ## -description Notifies of an unrecoverable audio error in audio graph operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Audio.AudioGraph.UnrecoverableErrorOccurred +-api-type: winrt event +--- + + + +# Windows.Media.Audio.AudioGraph.UnrecoverableErrorOccurred + +## -description +Notifies of an unrecoverable audio error in audio graph operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographbatchupdater.md b/windows.media.audio/audiographbatchupdater.md index 05aaf82d9c..40b088acca 100644 --- a/windows.media.audio/audiographbatchupdater.md +++ b/windows.media.audio/audiographbatchupdater.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioGraphBatchUpdater --api-type: winrt class ---- # Windows.Media.Audio.AudioGraphBatchUpdater ## -description An object that, upon creation with [CreateBatchUpdater](audiograph_createbatchupdater.md), causes all subsequent modifications to all nodes in an [AudioGraph](audiograph.md) to be accumulated and then committed once your app closes or disposes of the batch updater object. ## -remarks Get an instance of this class by calling [AudioGraph.CreateBatchUpdater](audiograph_createbatchupdater.md). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioGraphBatchUpdater +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioGraphBatchUpdater + +## -description +An object that, upon creation with [CreateBatchUpdater](audiograph_createbatchupdater.md), causes all subsequent modifications to all nodes in an [AudioGraph](audiograph.md) to be accumulated and then committed once your app closes or disposes of the batch updater object. + +## -remarks +Get an instance of this class by calling [AudioGraph.CreateBatchUpdater](audiograph_createbatchupdater.md). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audiographbatchupdater_close_811482585.md b/windows.media.audio/audiographbatchupdater_close_811482585.md index 110ee5e098..abc7b57cce 100644 --- a/windows.media.audio/audiographbatchupdater_close_811482585.md +++ b/windows.media.audio/audiographbatchupdater_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraphBatchUpdater.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioGraphBatchUpdater.Close ## -description Closes the [CreateBatchUpdater](audiograph_createbatchupdater.md), causing all audio graph node modifications accumulated since the object was created to be committed. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [AudioGraphBatchUpdater](audiographbatchupdater.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraphBatchUpdater.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraphBatchUpdater.Close + +## -description +Closes the [CreateBatchUpdater](audiograph_createbatchupdater.md), causing all audio graph node modifications accumulated since the object was created to be committed. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [AudioGraphBatchUpdater](audiographbatchupdater.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographconnection.md b/windows.media.audio/audiographconnection.md index 98d63784a8..43fea2c09b 100644 --- a/windows.media.audio/audiographconnection.md +++ b/windows.media.audio/audiographconnection.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.Media.Audio.AudioGraphConnection --api-type: winrt class ---- # Windows.Media.Audio.AudioGraphConnection ## -description Represents a connection within an audio graph. ## -remarks Get an instance of this class with the [OutgoingConnections](iaudioinputnode_outgoingconnections.md) property of a class that implements [IAudioInputNode](iaudioinputnode.md). These include: + [AudioDeviceInputNode](audiodeviceinputnode.md) + [AudioFileInputNode](audiofileinputnode.md) + [AudioFrameInputNode](audioframeinputnode.md) + [AudioSubmixNode](audiosubmixnode.md) ## -examples ## -see-also [IAudioInputNode](iaudioinputnode.md), [AudioDeviceInputNode](audiodeviceinputnode.md), [AudioFileInputNode](audiofileinputnode.md), [AudioFrameInputNode](audioframeinputnode.md), [AudioSubmixNode](audiosubmixnode.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioGraphConnection +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioGraphConnection + +## -description +Represents a connection within an audio graph. + +## -remarks +Get an instance of this class with the [OutgoingConnections](iaudioinputnode_outgoingconnections.md) property of a class that implements [IAudioInputNode](iaudioinputnode.md). These include: + + ++ [AudioDeviceInputNode](audiodeviceinputnode.md) ++ [AudioFileInputNode](audiofileinputnode.md) ++ [AudioFrameInputNode](audioframeinputnode.md) ++ [AudioSubmixNode](audiosubmixnode.md) + + +## -examples + +## -see-also +[IAudioInputNode](iaudioinputnode.md), [AudioDeviceInputNode](audiodeviceinputnode.md), [AudioFileInputNode](audiofileinputnode.md), [AudioFrameInputNode](audioframeinputnode.md), [AudioSubmixNode](audiosubmixnode.md) \ No newline at end of file diff --git a/windows.media.audio/audiographconnection_destination.md b/windows.media.audio/audiographconnection_destination.md index b62c8140b8..0d2b7ba9ee 100644 --- a/windows.media.audio/audiographconnection_destination.md +++ b/windows.media.audio/audiographconnection_destination.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphConnection.Destination --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphConnection.Destination ## -description Gets the destination node for the connection. ## -property-value The **IAudioNode** interface for the destination node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphConnection.Destination +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphConnection.Destination + +## -description +Gets the destination node for the connection. + +## -property-value +The **IAudioNode** interface for the destination node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographconnection_gain.md b/windows.media.audio/audiographconnection_gain.md index 865359a645..f7599fa032 100644 --- a/windows.media.audio/audiographconnection_gain.md +++ b/windows.media.audio/audiographconnection_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphConnection.Gain --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphConnection.Gain ## -description Gets the gain associated with the audio graph connection. ## -property-value A value indicating the gain. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphConnection.Gain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphConnection.Gain + +## -description +Gets the gain associated with the audio graph connection. + +## -property-value +A value indicating the gain. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings.md b/windows.media.audio/audiographsettings.md index 27ad983b33..27a19b6d81 100644 --- a/windows.media.audio/audiographsettings.md +++ b/windows.media.audio/audiographsettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Audio.AudioGraphSettings --api-type: winrt class ---- # Windows.Media.Audio.AudioGraphSettings ## -description Represents initialization settings for an audio graph. Set the properties of this object to your desired values and then call [AudioGraph::CreateAsync](audiograph_createasync_145006550.md) to create a new audio graph instance with the specified settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioGraphSettings +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioGraphSettings + +## -description +Represents initialization settings for an audio graph. Set the properties of this object to your desired values and then call [AudioGraph::CreateAsync](audiograph_createasync_145006550.md) to create a new audio graph instance with the specified settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_audiographsettings_898426626.md b/windows.media.audio/audiographsettings_audiographsettings_898426626.md index 9bfe687635..b61550e590 100644 --- a/windows.media.audio/audiographsettings_audiographsettings_898426626.md +++ b/windows.media.audio/audiographsettings_audiographsettings_898426626.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioGraphSettings.#ctor(Windows.Media.Render.AudioRenderCategory) --api-type: winrt method ---- # Windows.Media.Audio.AudioGraphSettings.AudioGraphSettings ## -description Initializes a new instance of the [AudioGraphSettings](audiographsettings.md) class with initial settings values optimized for the specified [AudioRenderCategory](audiographsettings_audiorendercategory.md). ## -parameters ### -param audioRenderCategory The [AudioRenderCategory](audiographsettings_audiorendercategory.md) that determines the initial settings values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioGraphSettings.#ctor(Windows.Media.Render.AudioRenderCategory) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioGraphSettings.AudioGraphSettings + +## -description +Initializes a new instance of the [AudioGraphSettings](audiographsettings.md) class with initial settings values optimized for the specified [AudioRenderCategory](audiographsettings_audiorendercategory.md). + +## -parameters +### -param audioRenderCategory +The [AudioRenderCategory](audiographsettings_audiorendercategory.md) that determines the initial settings values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_audiorendercategory.md b/windows.media.audio/audiographsettings_audiorendercategory.md index bf2b5152e8..24df952a35 100644 --- a/windows.media.audio/audiographsettings_audiorendercategory.md +++ b/windows.media.audio/audiographsettings_audiorendercategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphSettings.AudioRenderCategory --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphSettings.AudioRenderCategory ## -description Gets or sets a value that indicates the audio render category setting for the audio graph. ## -property-value A value that indicates the audio render category setting for an audio graph. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphSettings.AudioRenderCategory +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphSettings.AudioRenderCategory + +## -description +Gets or sets a value that indicates the audio render category setting for the audio graph. + +## -property-value +A value that indicates the audio render category setting for an audio graph. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_desiredrenderdeviceaudioprocessing.md b/windows.media.audio/audiographsettings_desiredrenderdeviceaudioprocessing.md index 43c30c7ba3..596905bfce 100644 --- a/windows.media.audio/audiographsettings_desiredrenderdeviceaudioprocessing.md +++ b/windows.media.audio/audiographsettings_desiredrenderdeviceaudioprocessing.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphSettings.DesiredRenderDeviceAudioProcessing --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphSettings.DesiredRenderDeviceAudioProcessing ## -description Gets or sets a value that indicates the desired audio processing mode setting for the audio graph. ## -property-value A value that indicates the desired audio processing mode setting for the audio graph. ## -remarks Setting this property does not guarantee that the specified value will be used by the created audio graph. To determine the actual value used, check the [AudioGraph.RenderDeviceAudioProcessing](audiograph_renderdeviceaudioprocessing.md) property of the audio graph after it has been created. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphSettings.DesiredRenderDeviceAudioProcessing +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphSettings.DesiredRenderDeviceAudioProcessing + +## -description +Gets or sets a value that indicates the desired audio processing mode setting for the audio graph. + +## -property-value +A value that indicates the desired audio processing mode setting for the audio graph. + +## -remarks +Setting this property does not guarantee that the specified value will be used by the created audio graph. To determine the actual value used, check the [AudioGraph.RenderDeviceAudioProcessing](audiograph_renderdeviceaudioprocessing.md) property of the audio graph after it has been created. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_desiredsamplesperquantum.md b/windows.media.audio/audiographsettings_desiredsamplesperquantum.md index 4da1a57d1e..d9f1d0e54d 100644 --- a/windows.media.audio/audiographsettings_desiredsamplesperquantum.md +++ b/windows.media.audio/audiographsettings_desiredsamplesperquantum.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphSettings.DesiredSamplesPerQuantum --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphSettings.DesiredSamplesPerQuantum ## -description Gets or sets the desired number of samples per quantum defined for the audio graph. ## -property-value The number of samples per quantum. ## -remarks Note that this property value is only valid if the [QuantumSizeSelectionMode](audiographsettings_quantumsizeselectionmode.md) property is set to **ClosestToDesired**. If the audio graph you created is intended to be used exclusively with files, it is strongly recommended that you set the [QuantumSizeSelectionMode](audiographsettings_quantumsizeselectionmode.md) to **SystemDefault**. Setting this property does not guarantee that the specified value will be used by the created audio graph. To determine the actual value used, check the [AudioGraph.SamplesPerQuantum](audiograph_samplesperquantum.md) property of the audio graph after it has been created. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphSettings.DesiredSamplesPerQuantum +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphSettings.DesiredSamplesPerQuantum + +## -description +Gets or sets the desired number of samples per quantum defined for the audio graph. + +## -property-value +The number of samples per quantum. + +## -remarks +Note that this property value is only valid if the [QuantumSizeSelectionMode](audiographsettings_quantumsizeselectionmode.md) property is set to **ClosestToDesired**. + +If the audio graph you created is intended to be used exclusively with files, it is strongly recommended that you set the [QuantumSizeSelectionMode](audiographsettings_quantumsizeselectionmode.md) to **SystemDefault**. + +Setting this property does not guarantee that the specified value will be used by the created audio graph. To determine the actual value used, check the [AudioGraph.SamplesPerQuantum](audiograph_samplesperquantum.md) property of the audio graph after it has been created. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_encodingproperties.md b/windows.media.audio/audiographsettings_encodingproperties.md index 7f6731d239..c88f36e05a 100644 --- a/windows.media.audio/audiographsettings_encodingproperties.md +++ b/windows.media.audio/audiographsettings_encodingproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphSettings.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphSettings.EncodingProperties ## -description Gets or sets the audio encoding properties setting for the audio graph. ## -property-value The audio encoding properties for the audio graph. ## -remarks Audio graphs always operate using 32-bit float encoding, regardless of the [Subtype](../windows.media.mediaproperties/audioencodingproperties_subtype.md) value in the specified [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphSettings.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphSettings.EncodingProperties + +## -description +Gets or sets the audio encoding properties setting for the audio graph. + +## -property-value +The audio encoding properties for the audio graph. + +## -remarks +Audio graphs always operate using 32-bit float encoding, regardless of the [Subtype](../windows.media.mediaproperties/audioencodingproperties_subtype.md) value in the specified [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_primaryrenderdevice.md b/windows.media.audio/audiographsettings_primaryrenderdevice.md index a5a2715175..deed0029c6 100644 --- a/windows.media.audio/audiographsettings_primaryrenderdevice.md +++ b/windows.media.audio/audiographsettings_primaryrenderdevice.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphSettings.PrimaryRenderDevice --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphSettings.PrimaryRenderDevice ## -description Gets or sets an object that represents the primary render device for the audio graph. ## -property-value An object that represents the primary render device for the audio graph. ## -remarks If **PrimaryRenderDevice** is null, the default playback device will be used. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphSettings.PrimaryRenderDevice +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphSettings.PrimaryRenderDevice + +## -description +Gets or sets an object that represents the primary render device for the audio graph. + +## -property-value +An object that represents the primary render device for the audio graph. + +## -remarks +If **PrimaryRenderDevice** is null, the default playback device will be used. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographsettings_quantumsizeselectionmode.md b/windows.media.audio/audiographsettings_quantumsizeselectionmode.md index 301eb222b1..0c0a0f1c4c 100644 --- a/windows.media.audio/audiographsettings_quantumsizeselectionmode.md +++ b/windows.media.audio/audiographsettings_quantumsizeselectionmode.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphSettings.QuantumSizeSelectionMode --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphSettings.QuantumSizeSelectionMode ## -description Gets or sets the quantum size selection mode for the audio graph. ## -property-value An enumeration value indicating the quantum size selection mode. If the audio graph is only to be used with files, it is strongly recommended to use the value SystemDefault. ## -remarks If the audio graph you created is intended to be used exclusively with files, it is strongly recommended that you set the [QuantumSizeSelectionMode](audiographsettings_quantumsizeselectionmode.md) to **SystemDefault**. Selecting **QuantumSizeSelectionMode.LowestLatency** can result in different quantum sizes across different devices or audio endpoints. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphSettings.QuantumSizeSelectionMode +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphSettings.QuantumSizeSelectionMode + +## -description +Gets or sets the quantum size selection mode for the audio graph. + +## -property-value +An enumeration value indicating the quantum size selection mode. If the audio graph is only to be used with files, it is strongly recommended to use the value SystemDefault. + +## -remarks +If the audio graph you created is intended to be used exclusively with files, it is strongly recommended that you set the [QuantumSizeSelectionMode](audiographsettings_quantumsizeselectionmode.md) to **SystemDefault**. + +Selecting **QuantumSizeSelectionMode.LowestLatency** can result in different quantum sizes across different devices or audio endpoints. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographunrecoverableerroroccurredeventargs.md b/windows.media.audio/audiographunrecoverableerroroccurredeventargs.md index 71e1af1cfd..76be289e7e 100644 --- a/windows.media.audio/audiographunrecoverableerroroccurredeventargs.md +++ b/windows.media.audio/audiographunrecoverableerroroccurredeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs --api-type: winrt class ---- # Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs ## -description Represents arguments for an [UnrecoverableErrorOccurred](audiograph_unrecoverableerroroccurred.md) event. ## -remarks Get an instance of this class by handling the [UnrecoverableErrorOccurred](audiograph_unrecoverableerroroccurred.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs + +## -description +Represents arguments for an [UnrecoverableErrorOccurred](audiograph_unrecoverableerroroccurred.md) event. + +## -remarks +Get an instance of this class by handling the [UnrecoverableErrorOccurred](audiograph_unrecoverableerroroccurred.md) event. + +## -examples + +## -see-also diff --git a/windows.media.audio/audiographunrecoverableerroroccurredeventargs_error.md b/windows.media.audio/audiographunrecoverableerroroccurredeventargs_error.md index c69f420a6d..303822522b 100644 --- a/windows.media.audio/audiographunrecoverableerroroccurredeventargs_error.md +++ b/windows.media.audio/audiographunrecoverableerroroccurredeventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs.Error --api-type: winrt property ---- # Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs.Error ## -description Gets the error associated with the event. ## -property-value An enumeration value indicating the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioGraphUnrecoverableErrorOccurredEventArgs.Error + +## -description +Gets the error associated with the event. + +## -property-value +An enumeration value indicating the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter.md b/windows.media.audio/audionodeemitter.md index 65a486014b..c936f163c9 100644 --- a/windows.media.audio/audionodeemitter.md +++ b/windows.media.audio/audionodeemitter.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Audio.AudioNodeEmitter --api-type: winrt class ---- # Windows.Media.Audio.AudioNodeEmitter ## -description Describes the position and other physical characteristics of an emitter from which the audio of an [AudioGraph](audiograph.md) node is emitted when spatial audio processing is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioNodeEmitter +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioNodeEmitter + +## -description +Describes the position and other physical characteristics of an emitter from which the audio of an [AudioGraph](audiograph.md) node is emitted when spatial audio processing is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_audionodeemitter_1221375020.md b/windows.media.audio/audionodeemitter_audionodeemitter_1221375020.md index 694f9490f3..e6ef77208f 100644 --- a/windows.media.audio/audionodeemitter_audionodeemitter_1221375020.md +++ b/windows.media.audio/audionodeemitter_audionodeemitter_1221375020.md @@ -1,3 +1,21 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeEmitter.#ctor --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeEmitter.AudioNodeEmitter ## -description Initializes a new instance of the [AudioNodeEmitter](audionodeemitter.md) class. ## -remarks If the constructor with no parameters is used, the default emitter shape is omnidirectional, the default decay model is natural, and doppler processing is enabled. ## -examples ## -see-also [AudioNodeEmitter(AudioNodeEmitterShape, AudioNodeEmitterDecayModel, AudioNodeEmitterSettings)](audionodeemitter_audionodeemitter_695720720.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeEmitter.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.AudioNodeEmitter + +## -description +Initializes a new instance of the [AudioNodeEmitter](audionodeemitter.md) class. + +## -remarks +If the constructor with no parameters is used, the default emitter shape is omnidirectional, the default decay model is natural, and doppler processing is enabled. + +## -examples + +## -see-also +[AudioNodeEmitter(AudioNodeEmitterShape, AudioNodeEmitterDecayModel, AudioNodeEmitterSettings)](audionodeemitter_audionodeemitter_695720720.md) \ No newline at end of file diff --git a/windows.media.audio/audionodeemitter_audionodeemitter_695720720.md b/windows.media.audio/audionodeemitter_audionodeemitter_695720720.md index 8917c81af4..6f7492813d 100644 --- a/windows.media.audio/audionodeemitter_audionodeemitter_695720720.md +++ b/windows.media.audio/audionodeemitter_audionodeemitter_695720720.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeEmitter.#ctor(Windows.Media.Audio.AudioNodeEmitterShape,Windows.Media.Audio.AudioNodeEmitterDecayModel,Windows.Media.Audio.AudioNodeEmitterSettings) --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeEmitter.AudioNodeEmitter ## -description Initializes a new instance of the [AudioNodeEmitter](audionodeemitter.md) class with the specified emitter characteristics. ## -parameters ### -param shape An object describing the shape in which audio is emitted. ### -param decayModel An object describing the decay model for emitted audio. ### -param settings Flags specifying additional settings for the emitter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeEmitter.#ctor(Windows.Media.Audio.AudioNodeEmitterShape,Windows.Media.Audio.AudioNodeEmitterDecayModel,Windows.Media.Audio.AudioNodeEmitterSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.AudioNodeEmitter + +## -description +Initializes a new instance of the [AudioNodeEmitter](audionodeemitter.md) class with the specified emitter characteristics. + +## -parameters +### -param shape +An object describing the shape in which audio is emitted. + +### -param decayModel +An object describing the decay model for emitted audio. + +### -param settings +Flags specifying additional settings for the emitter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_decaymodel.md b/windows.media.audio/audionodeemitter_decaymodel.md index c6665f95c2..2f257774b7 100644 --- a/windows.media.audio/audionodeemitter_decaymodel.md +++ b/windows.media.audio/audionodeemitter_decaymodel.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.DecayModel --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.DecayModel ## -description Gets an object describing the decay model for the [AudioNodeEmitter](audionodeemitter.md). ## -property-value An object describing the decay model for the emitter. ## -remarks Create an [AudioNodeEmitter](audionodeemitter.md) with a decay model by using the overload of the [AudioNodeEmitter constructor](audionodeemitter_audionodeemitter_695720720.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.DecayModel +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.DecayModel + +## -description +Gets an object describing the decay model for the [AudioNodeEmitter](audionodeemitter.md). + +## -property-value +An object describing the decay model for the emitter. + +## -remarks +Create an [AudioNodeEmitter](audionodeemitter.md) with a decay model by using the overload of the [AudioNodeEmitter constructor](audionodeemitter_audionodeemitter_695720720.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_direction.md b/windows.media.audio/audionodeemitter_direction.md index b823a61011..7c38ea6465 100644 --- a/windows.media.audio/audionodeemitter_direction.md +++ b/windows.media.audio/audionodeemitter_direction.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.Direction --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.Direction ## -description A vector expressing the direction in which audio is emitted from the [AudioNodeEmitter](audionodeemitter.md). ## -property-value The direction in which audio is emitted from the emitter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.Direction +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.Direction + +## -description +A vector expressing the direction in which audio is emitted from the [AudioNodeEmitter](audionodeemitter.md). + +## -property-value +The direction in which audio is emitted from the emitter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_distancescale.md b/windows.media.audio/audionodeemitter_distancescale.md index 7a6c6fe474..a2ad676cfe 100644 --- a/windows.media.audio/audionodeemitter_distancescale.md +++ b/windows.media.audio/audionodeemitter_distancescale.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.DistanceScale --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.DistanceScale ## -description Gets or sets the scale of the position of the emitter. All distances used when calculating spatial audio effects are expressed in meters. Setting this value allows you to automatically scale the calculations to use some other unit. ## -property-value The scale of the position of the emitter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.DistanceScale +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.DistanceScale + +## -description +Gets or sets the scale of the position of the emitter. All distances used when calculating spatial audio effects are expressed in meters. Setting this value allows you to automatically scale the calculations to use some other unit. + +## -property-value +The scale of the position of the emitter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_dopplerscale.md b/windows.media.audio/audionodeemitter_dopplerscale.md index 050a53af40..83436c5831 100644 --- a/windows.media.audio/audionodeemitter_dopplerscale.md +++ b/windows.media.audio/audionodeemitter_dopplerscale.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.DopplerScale --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.DopplerScale ## -description Gets or sets the scale of the doppler velocity of the emitter. The [DopplerVelocity](audionodeemitter_dopplervelocity.md) of an emitter is expressed in meters per second. Setting this value allows you to automatically scale the velocity to some other unit. ## -property-value The scale of the doppler velocity of the emitter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.DopplerScale +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.DopplerScale + +## -description +Gets or sets the scale of the doppler velocity of the emitter. The [DopplerVelocity](audionodeemitter_dopplervelocity.md) of an emitter is expressed in meters per second. Setting this value allows you to automatically scale the velocity to some other unit. + +## -property-value +The scale of the doppler velocity of the emitter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_dopplervelocity.md b/windows.media.audio/audionodeemitter_dopplervelocity.md index 1dea824cae..1a0150460e 100644 --- a/windows.media.audio/audionodeemitter_dopplervelocity.md +++ b/windows.media.audio/audionodeemitter_dopplervelocity.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.DopplerVelocity --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.DopplerVelocity ## -description Gets or sets a [Vector3](../windows.foundation.numerics/vector3.md) expressing the velocity at which the emitter is moving in 3D space, expressed in meters per second. ## -property-value A [Vector3](../windows.foundation.numerics/vector3.md) expressing the velocity at which the emitter is moving. ## -remarks By default, the doppler velocity is expressed in meters per second. Set the [DopplerScale](audionodeemitter_dopplerscale.md) property to scale the value to use other units. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.DopplerVelocity +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.DopplerVelocity + +## -description +Gets or sets a [Vector3](../windows.foundation.numerics/vector3.md) expressing the velocity at which the emitter is moving in 3D space, expressed in meters per second. + +## -property-value +A [Vector3](../windows.foundation.numerics/vector3.md) expressing the velocity at which the emitter is moving. + +## -remarks +By default, the doppler velocity is expressed in meters per second. Set the [DopplerScale](audionodeemitter_dopplerscale.md) property to scale the value to use other units. + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_gain.md b/windows.media.audio/audionodeemitter_gain.md index 929a096844..e1244fc80b 100644 --- a/windows.media.audio/audionodeemitter_gain.md +++ b/windows.media.audio/audionodeemitter_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.Gain --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.Gain ## -description Gets or sets a value indicating the gain applied to the signal by the emitter. ## -property-value A value indicating the gain applied to the signal by the emitter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.Gain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.Gain + +## -description +Gets or sets a value indicating the gain applied to the signal by the emitter. + +## -property-value +A value indicating the gain applied to the signal by the emitter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_isdopplerdisabled.md b/windows.media.audio/audionodeemitter_isdopplerdisabled.md index 2dc2ee1b3a..00bb6b8ed2 100644 --- a/windows.media.audio/audionodeemitter_isdopplerdisabled.md +++ b/windows.media.audio/audionodeemitter_isdopplerdisabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.IsDopplerDisabled --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.IsDopplerDisabled ## -description Gets a value indicating whether Doppler processing is disabled for the emitter. ## -property-value True if Doppler processing is disabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.IsDopplerDisabled +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.IsDopplerDisabled + +## -description +Gets a value indicating whether Doppler processing is disabled for the emitter. + +## -property-value +True if Doppler processing is disabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_position.md b/windows.media.audio/audionodeemitter_position.md index 89ef2bf5ea..d22c676a2a 100644 --- a/windows.media.audio/audionodeemitter_position.md +++ b/windows.media.audio/audionodeemitter_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.Position --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.Position ## -description Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters. ## -property-value A vector representing the position of the emitter in 3D space ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.Position +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.Position + +## -description +Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters. + +## -property-value +A vector representing the position of the emitter in 3D space + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_shape.md b/windows.media.audio/audionodeemitter_shape.md index c6a19d22d3..a62d043396 100644 --- a/windows.media.audio/audionodeemitter_shape.md +++ b/windows.media.audio/audionodeemitter_shape.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitter.Shape --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitter.Shape ## -description Gets an object describing the shape in which the emitter emits audio. ## -property-value An object describing the shape in which the emitter emits audio. ## -remarks Create an [AudioNodeEmitter](audionodeemitter.md) with a particular shape by using the overload of the [AudioNodeEmitter constructor](audionodeemitter_audionodeemitter_695720720.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.Shape +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.Shape + +## -description +Gets an object describing the shape in which the emitter emits audio. + +## -property-value +An object describing the shape in which the emitter emits audio. + +## -remarks +Create an [AudioNodeEmitter](audionodeemitter.md) with a particular shape by using the overload of the [AudioNodeEmitter constructor](audionodeemitter_audionodeemitter_695720720.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitter_spatialaudiomodel.md b/windows.media.audio/audionodeemitter_spatialaudiomodel.md index 3112e362ec..6ee0dc262b 100644 --- a/windows.media.audio/audionodeemitter_spatialaudiomodel.md +++ b/windows.media.audio/audionodeemitter_spatialaudiomodel.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.Media.Audio.AudioNodeEmitter.SpatialAudioModel --api-type: winrt property ---- - - - -# Windows.Media.Audio.AudioNodeEmitter.SpatialAudioModel - -## -description -Gets or sets a value that specifies the spatial audio processing model used by the emitter. - -## -property-value -A value that specifies the spatial audio processing model used by the emitter. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitter.SpatialAudioModel +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitter.SpatialAudioModel + +## -description +Gets or sets a value that specifies the spatial audio processing model used by the emitter. + +## -property-value +A value that specifies the spatial audio processing model used by the emitter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterconeproperties.md b/windows.media.audio/audionodeemitterconeproperties.md index f6539fa50a..125bacb160 100644 --- a/windows.media.audio/audionodeemitterconeproperties.md +++ b/windows.media.audio/audionodeemitterconeproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.AudioNodeEmitterConeProperties --api-type: winrt class ---- # Windows.Media.Audio.AudioNodeEmitterConeProperties ## -description Describes the cone shape used by an [AudioNodeEmitterShape](audionodeemittershape.md). At the inner angle of the cone, audio is not attenuated at all. At the outer angle of the cone, audio is fully attenuated. ## -remarks Set the audio emitter cone properties by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). Get an instance of this class by accessing the [AudioNodeEmitterShape.ConeProperties](audionodeemittershape_coneproperties.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioNodeEmitterConeProperties +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioNodeEmitterConeProperties + +## -description +Describes the cone shape used by an [AudioNodeEmitterShape](audionodeemittershape.md). At the inner angle of the cone, audio is not attenuated at all. At the outer angle of the cone, audio is fully attenuated. + +## -remarks +Set the audio emitter cone properties by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). Get an instance of this class by accessing the [AudioNodeEmitterShape.ConeProperties](audionodeemittershape_coneproperties.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterconeproperties_innerangle.md b/windows.media.audio/audionodeemitterconeproperties_innerangle.md index ca1393e065..37e27f3951 100644 --- a/windows.media.audio/audionodeemitterconeproperties_innerangle.md +++ b/windows.media.audio/audionodeemitterconeproperties_innerangle.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterConeProperties.InnerAngle --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterConeProperties.InnerAngle ## -description Gets the inner angle of an audio node emitter cone shape. This is the angle at which the audio is not attenuated at all. ## -property-value The inner angle of a an audio node emitter cone shape. ## -remarks Set the inner angle of an emitter cone shape by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterConeProperties.InnerAngle +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterConeProperties.InnerAngle + +## -description +Gets the inner angle of an audio node emitter cone shape. This is the angle at which the audio is not attenuated at all. + +## -property-value +The inner angle of a an audio node emitter cone shape. + +## -remarks +Set the inner angle of an emitter cone shape by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterconeproperties_outerangle.md b/windows.media.audio/audionodeemitterconeproperties_outerangle.md index 0fd1bfd933..25e12c2b47 100644 --- a/windows.media.audio/audionodeemitterconeproperties_outerangle.md +++ b/windows.media.audio/audionodeemitterconeproperties_outerangle.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngle --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngle ## -description Gets the outer angle of a an audio node emitter cone shape, expressed in radians. This is the angle at which the audio is fully attenuated. ## -property-value The outer angle of a an audio node emitter cone shape ## -remarks Set the outer angle of an emitter cone shape by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngle +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngle + +## -description +Gets the outer angle of a an audio node emitter cone shape, expressed in radians. This is the angle at which the audio is fully attenuated. + +## -property-value +The outer angle of a an audio node emitter cone shape + +## -remarks +Set the outer angle of an emitter cone shape by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterconeproperties_outeranglegain.md b/windows.media.audio/audionodeemitterconeproperties_outeranglegain.md index 04450daf5d..f1a0f99592 100644 --- a/windows.media.audio/audionodeemitterconeproperties_outeranglegain.md +++ b/windows.media.audio/audionodeemitterconeproperties_outeranglegain.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngleGain --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngleGain ## -description Gets a value indicating the gain applied at the outer angle of the cone. ## -property-value A value indicating the gain applied at the outer angle of the cone. ## -remarks Set the outer angle gain of an emitter cone shape by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngleGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterConeProperties.OuterAngleGain + +## -description +Gets a value indicating the gain applied at the outer angle of the cone. + +## -property-value +A value indicating the gain applied at the outer angle of the cone. + +## -remarks +Set the outer angle gain of an emitter cone shape by calling [AudioNodeEmitterShape.CreateCone](audionodeemittershape_createcone.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel.md b/windows.media.audio/audionodeemitterdecaymodel.md index 6f82e4f1a7..beabf45ef3 100644 --- a/windows.media.audio/audionodeemitterdecaymodel.md +++ b/windows.media.audio/audionodeemitterdecaymodel.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.AudioNodeEmitterDecayModel --api-type: winrt class ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel ## -description Represents the model used to compute the distance-based attenuation of a signal from an [AudioNodeEmitter](audionodeemitter.md). ## -remarks Create an instance of this class by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md) or [CreateNatural](audionodeemitterdecaymodel_createnatural.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioNodeEmitterDecayModel +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel + +## -description +Represents the model used to compute the distance-based attenuation of a signal from an [AudioNodeEmitter](audionodeemitter.md). + +## -remarks +Create an instance of this class by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md) or [CreateNatural](audionodeemitterdecaymodel_createnatural.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel_createcustom_675347716.md b/windows.media.audio/audionodeemitterdecaymodel_createcustom_675347716.md index 6d129d3e1e..a8172d8f0a 100644 --- a/windows.media.audio/audionodeemitterdecaymodel_createcustom_675347716.md +++ b/windows.media.audio/audionodeemitterdecaymodel_createcustom_675347716.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateCustom(System.Double,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateCustom ## -description Creates a new [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) that uses the specified minimum and maximum gain values to compute distance-based attenuation of a signal from an [AudioNodeEmitter](audionodeemitter.md). ## -parameters ### -param minGain The minimum gain level for the signal. ### -param maxGain The maximum gain level for the signal. ## -returns The created decay model. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateCustom(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateCustom + +## -description +Creates a new [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) that uses the specified minimum and maximum gain values to compute distance-based attenuation of a signal from an [AudioNodeEmitter](audionodeemitter.md). + +## -parameters +### -param minGain +The minimum gain level for the signal. + +### -param maxGain +The maximum gain level for the signal. + +## -returns +The created decay model. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel_createnatural_887095524.md b/windows.media.audio/audionodeemitterdecaymodel_createnatural_887095524.md index b46f6a7caf..26c44fc7ba 100644 --- a/windows.media.audio/audionodeemitterdecaymodel_createnatural_887095524.md +++ b/windows.media.audio/audionodeemitterdecaymodel_createnatural_887095524.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateNatural(System.Double,System.Double,System.Double,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateNatural ## -description Creates an [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) with a natural roll-off model using a distance-squared formula. ## -parameters ### -param minGain The minimum gain applied to the signal. ### -param maxGain The maximum gain applied to the signal. ### -param unityGainDistance The distance at which the gain of the signal is unaffected by decay. ### -param cutoffDistance The distance at which the gain is *minGain*. ## -returns The created decay model. ## -remarks The distance values for *unityGainDistance* and *cutoffDistance* are expressed in meters, but can be scaled by setting the [AudioNodeEmitter.DistanceScale](audionodeemitter_distancescale.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateNatural(System.Double,System.Double,System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel.CreateNatural + +## -description +Creates an [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) with a natural roll-off model using a distance-squared formula. + +## -parameters +### -param minGain +The minimum gain applied to the signal. + +### -param maxGain +The maximum gain applied to the signal. + +### -param unityGainDistance +The distance at which the gain of the signal is unaffected by decay. + +### -param cutoffDistance +The distance at which the gain is *minGain*. + +## -returns +The created decay model. + +## -remarks +The distance values for *unityGainDistance* and *cutoffDistance* are expressed in meters, but can be scaled by setting the [AudioNodeEmitter.DistanceScale](audionodeemitter_distancescale.md) property. + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel_kind.md b/windows.media.audio/audionodeemitterdecaymodel_kind.md index 891e9ba255..2ad502a511 100644 --- a/windows.media.audio/audionodeemitterdecaymodel_kind.md +++ b/windows.media.audio/audionodeemitterdecaymodel_kind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.Kind --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel.Kind ## -description Gets a value indicating the type of the decay model. ## -property-value A value indicating the type of the decay model. ## -remarks Create a [Natural](audionodeemitterdecaykind.md) decay model by calling [CreateNatural](audionodeemitterdecaymodel_createnatural.md). Create a [Custom](audionodeemitterdecaykind.md) decay model by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.Kind +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel.Kind + +## -description +Gets a value indicating the type of the decay model. + +## -property-value +A value indicating the type of the decay model. + +## -remarks +Create a [Natural](audionodeemitterdecaykind.md) decay model by calling [CreateNatural](audionodeemitterdecaymodel_createnatural.md). Create a [Custom](audionodeemitterdecaykind.md) decay model by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel_maxgain.md b/windows.media.audio/audionodeemitterdecaymodel_maxgain.md index 96c1a09373..94dc053e1f 100644 --- a/windows.media.audio/audionodeemitterdecaymodel_maxgain.md +++ b/windows.media.audio/audionodeemitterdecaymodel_maxgain.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.MaxGain --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel.MaxGain ## -description Gets the maximum gain applied to the signal as a result of the decay model. ## -property-value The maximum gain applied to the signal as a result of the decay model. ## -remarks Specify the maximum gain of an [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md) or [CreateNatural](audionodeemitterdecaymodel_createnatural.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.MaxGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel.MaxGain + +## -description +Gets the maximum gain applied to the signal as a result of the decay model. + +## -property-value +The maximum gain applied to the signal as a result of the decay model. + +## -remarks +Specify the maximum gain of an [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md) or [CreateNatural](audionodeemitterdecaymodel_createnatural.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel_mingain.md b/windows.media.audio/audionodeemitterdecaymodel_mingain.md index acfab54acc..fa44a6523e 100644 --- a/windows.media.audio/audionodeemitterdecaymodel_mingain.md +++ b/windows.media.audio/audionodeemitterdecaymodel_mingain.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.MinGain --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel.MinGain ## -description Gets the minimum gain applied to the signal as a result of the decay model. ## -property-value The minimum gain applied to the signal as a result of the decay model. ## -remarks Specify the minimum gain of an [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md) or [CreateNatural](audionodeemitterdecaymodel_createnatural.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.MinGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel.MinGain + +## -description +Gets the minimum gain applied to the signal as a result of the decay model. + +## -property-value +The minimum gain applied to the signal as a result of the decay model. + +## -remarks +Specify the minimum gain of an [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md) by calling [CreateCustom](audionodeemitterdecaymodel_createcustom.md) or [CreateNatural](audionodeemitterdecaymodel_createnatural.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitterdecaymodel_naturalproperties.md b/windows.media.audio/audionodeemitterdecaymodel_naturalproperties.md index a5369f3480..2dcb1dc909 100644 --- a/windows.media.audio/audionodeemitterdecaymodel_naturalproperties.md +++ b/windows.media.audio/audionodeemitterdecaymodel_naturalproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.NaturalProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterDecayModel.NaturalProperties ## -description Gets the properties of a natural [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md). ## -property-value The properties of a natural decay model. ## -remarks Set the properties of a natural decay model by calling [CreateNatural](audionodeemitterdecaymodel_createnatural.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterDecayModel.NaturalProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterDecayModel.NaturalProperties + +## -description +Gets the properties of a natural [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md). + +## -property-value +The properties of a natural decay model. + +## -remarks +Set the properties of a natural decay model by calling [CreateNatural](audionodeemitterdecaymodel_createnatural.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitternaturaldecaymodelproperties.md b/windows.media.audio/audionodeemitternaturaldecaymodelproperties.md index 07e15ef59d..7291652b83 100644 --- a/windows.media.audio/audionodeemitternaturaldecaymodelproperties.md +++ b/windows.media.audio/audionodeemitternaturaldecaymodelproperties.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties --api-type: winrt class ---- # Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties ## -description Describes the characteristics of a natural [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md). ## -remarks Create a natural emitter decay model by calling [AudioNodeEmitterDecayModel.CreateNatural](audionodeemitterdecaymodel_createnatural.md). After creating the model, read-only access to the natural decay model properties is provided by the [NaturalProperties](audionodeemitterdecaymodel_naturalproperties.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties + +## -description +Describes the characteristics of a natural [AudioNodeEmitterDecayModel](audionodeemitterdecaymodel.md). + +## -remarks +Create a natural emitter decay model by calling [AudioNodeEmitterDecayModel.CreateNatural](audionodeemitterdecaymodel_createnatural.md). After creating the model, read-only access to the natural decay model properties is provided by the [NaturalProperties](audionodeemitterdecaymodel_naturalproperties.md) property. + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitternaturaldecaymodelproperties_cutoffdistance.md b/windows.media.audio/audionodeemitternaturaldecaymodelproperties_cutoffdistance.md index 0327cfefaa..2d76e9e4fc 100644 --- a/windows.media.audio/audionodeemitternaturaldecaymodelproperties_cutoffdistance.md +++ b/windows.media.audio/audionodeemitternaturaldecaymodelproperties_cutoffdistance.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.CutoffDistance --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.CutoffDistance ## -description Gets a value indicating the distance at which the gain reaches the minimum gain value specified when the model was created with a call to [AudioNodeEmitterDecayModel.CreateNatural](audionodeemitterdecaymodel_createnatural.md). ## -property-value A value indicating the distance at which the gain reaches the model's minimum gain value. ## -remarks The distance value is expressed in meters, but can be scaled by setting the [AudioNodeEmitter.DistanceScale](audionodeemitter_distancescale.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.CutoffDistance +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.CutoffDistance + +## -description +Gets a value indicating the distance at which the gain reaches the minimum gain value specified when the model was created with a call to [AudioNodeEmitterDecayModel.CreateNatural](audionodeemitterdecaymodel_createnatural.md). + +## -property-value +A value indicating the distance at which the gain reaches the model's minimum gain value. + +## -remarks +The distance value is expressed in meters, but can be scaled by setting the [AudioNodeEmitter.DistanceScale](audionodeemitter_distancescale.md) property. + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemitternaturaldecaymodelproperties_unitygaindistance.md b/windows.media.audio/audionodeemitternaturaldecaymodelproperties_unitygaindistance.md index a02583f5e0..505bef7ef2 100644 --- a/windows.media.audio/audionodeemitternaturaldecaymodelproperties_unitygaindistance.md +++ b/windows.media.audio/audionodeemitternaturaldecaymodelproperties_unitygaindistance.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.UnityGainDistance --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.UnityGainDistance ## -description Gets a value indicating the distance at which the signal gain is unaffected by the decay model. ## -property-value A value indicating the distance at which the signal gain is unaffected by the decay model. ## -remarks The distance value is expressed in meters, but can be scaled by setting the [AudioNodeEmitter.DistanceScale](audionodeemitter_distancescale.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.UnityGainDistance +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterNaturalDecayModelProperties.UnityGainDistance + +## -description +Gets a value indicating the distance at which the signal gain is unaffected by the decay model. + +## -property-value +A value indicating the distance at which the signal gain is unaffected by the decay model. + +## -remarks +The distance value is expressed in meters, but can be scaled by setting the [AudioNodeEmitter.DistanceScale](audionodeemitter_distancescale.md) property. + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemittershape.md b/windows.media.audio/audionodeemittershape.md index 567ee71f04..b501bffb6b 100644 --- a/windows.media.audio/audionodeemittershape.md +++ b/windows.media.audio/audionodeemittershape.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.AudioNodeEmitterShape --api-type: winrt class ---- # Windows.Media.Audio.AudioNodeEmitterShape ## -description Describes the shape in which an [AudioNodeEmitter](audionodeemitter.md) emits audio. ## -remarks Create a cone emitter shape by calling [CreateCone](audionodeemittershape_createcone.md). Create an omnidirectional emitter by calling [CreateOmnidirectional](audionodeemittershape_createomnidirectional.md). Assign an emitter shape to an emitter by calling the overload of the [AudioNodeEmitter](audionodeemitter_audionodeemitter_695720720.md) constructor. After the emitter has been created, retrieve the associated **AudioEmitterShape** object with the [AudioNodeEmitter.Shape](audionodeemitter_shape.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioNodeEmitterShape +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioNodeEmitterShape + +## -description +Describes the shape in which an [AudioNodeEmitter](audionodeemitter.md) emits audio. + +## -remarks +Create a cone emitter shape by calling [CreateCone](audionodeemittershape_createcone.md). Create an omnidirectional emitter by calling [CreateOmnidirectional](audionodeemittershape_createomnidirectional.md). Assign an emitter shape to an emitter by calling the overload of the [AudioNodeEmitter](audionodeemitter_audionodeemitter_695720720.md) constructor. After the emitter has been created, retrieve the associated **AudioEmitterShape** object with the [AudioNodeEmitter.Shape](audionodeemitter_shape.md) property. + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemittershape_coneproperties.md b/windows.media.audio/audionodeemittershape_coneproperties.md index e070b21bc1..c3d660c393 100644 --- a/windows.media.audio/audionodeemittershape_coneproperties.md +++ b/windows.media.audio/audionodeemittershape_coneproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterShape.ConeProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterShape.ConeProperties ## -description Gets an object that defines the characteristics of an emitter's cone shape, including the inner and outer angle of the cone and the gain applied to the signal at the outer angle. ## -property-value An object that defines the characteristics of the cone shape ## -remarks Create a cone emitter shape by calling [CreateCone](audionodeemittershape_createcone.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterShape.ConeProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterShape.ConeProperties + +## -description +Gets an object that defines the characteristics of an emitter's cone shape, including the inner and outer angle of the cone and the gain applied to the signal at the outer angle. + +## -property-value +An object that defines the characteristics of the cone shape + +## -remarks +Create a cone emitter shape by calling [CreateCone](audionodeemittershape_createcone.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemittershape_createcone_1260552697.md b/windows.media.audio/audionodeemittershape_createcone_1260552697.md index 7cc002a0b7..bc3044a4d8 100644 --- a/windows.media.audio/audionodeemittershape_createcone_1260552697.md +++ b/windows.media.audio/audionodeemittershape_createcone_1260552697.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeEmitterShape.CreateCone(System.Double,System.Double,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeEmitterShape.CreateCone ## -description Creates an instance of [AudioNodeEmitterShape](audionodeemittershape.md) representing a cone shape. ## -parameters ### -param innerAngle The inner angle of an audio node emitter cone shape, where the audio signal is not attenuated at all, expressed in radians. ### -param outerAngle The outer angle of an audio node emitter cone shape, where the audio signal is fully attenuated, expressed in radians. ### -param outerAngleGain A value indicating the gain applied at the outer angle of the cone. ## -returns A cone-shaped [AudioNodeEmitterShape](audionodeemittershape.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeEmitterShape.CreateCone(System.Double,System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeEmitterShape.CreateCone + +## -description +Creates an instance of [AudioNodeEmitterShape](audionodeemittershape.md) representing a cone shape. + +## -parameters +### -param innerAngle +The inner angle of an audio node emitter cone shape, where the audio signal is not attenuated at all, expressed in radians. + +### -param outerAngle +The outer angle of an audio node emitter cone shape, where the audio signal is fully attenuated, expressed in radians. + +### -param outerAngleGain +A value indicating the gain applied at the outer angle of the cone. + +## -returns +A cone-shaped [AudioNodeEmitterShape](audionodeemittershape.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemittershape_createomnidirectional_200506124.md b/windows.media.audio/audionodeemittershape_createomnidirectional_200506124.md index 30b2a9d5e0..c7be407699 100644 --- a/windows.media.audio/audionodeemittershape_createomnidirectional_200506124.md +++ b/windows.media.audio/audionodeemittershape_createomnidirectional_200506124.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeEmitterShape.CreateOmnidirectional --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeEmitterShape.CreateOmnidirectional ## -description Creates an instance of [AudioNodeEmitterShape](audionodeemittershape.md) that is omnidirectional, meaning that the audio signal attenuation is the same regardless of the emitter's [Direction](audionodeemitter_direction.md). ## -returns An omnidirectional [AudioNodeEmitterShape](audionodeemittershape.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeEmitterShape.CreateOmnidirectional +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeEmitterShape.CreateOmnidirectional + +## -description +Creates an instance of [AudioNodeEmitterShape](audionodeemittershape.md) that is omnidirectional, meaning that the audio signal attenuation is the same regardless of the emitter's [Direction](audionodeemitter_direction.md). + +## -returns +An omnidirectional [AudioNodeEmitterShape](audionodeemittershape.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodeemittershape_kind.md b/windows.media.audio/audionodeemittershape_kind.md index 77063b9942..f3b07c612a 100644 --- a/windows.media.audio/audionodeemittershape_kind.md +++ b/windows.media.audio/audionodeemittershape_kind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeEmitterShape.Kind --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeEmitterShape.Kind ## -description Gets a value indicating the kind of shape represented by the [AudioNodeEmitterShape](audionodeemittershape.md). ## -property-value A value indicating the kind of shape represented by the [AudioNodeEmitterShape](audionodeemittershape.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeEmitterShape.Kind +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeEmitterShape.Kind + +## -description +Gets a value indicating the kind of shape represented by the [AudioNodeEmitterShape](audionodeemittershape.md). + +## -property-value +A value indicating the kind of shape represented by the [AudioNodeEmitterShape](audionodeemittershape.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodelistener.md b/windows.media.audio/audionodelistener.md index 1e493d78a2..c13dc91ca2 100644 --- a/windows.media.audio/audionodelistener.md +++ b/windows.media.audio/audionodelistener.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Audio.AudioNodeListener --api-type: winrt class ---- # Windows.Media.Audio.AudioNodeListener ## -description Describes the position and other physical characteristics of a listener from which the audio output of an [AudioGraph](audiograph.md) node is heard when spatial audio processing is used. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioNodeListener +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioNodeListener + +## -description +Describes the position and other physical characteristics of a listener from which the audio output of an [AudioGraph](audiograph.md) node is heard when spatial audio processing is used. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodelistener_audionodelistener_1221375020.md b/windows.media.audio/audionodelistener_audionodelistener_1221375020.md index a8e46f87d5..fedaecd51e 100644 --- a/windows.media.audio/audionodelistener_audionodelistener_1221375020.md +++ b/windows.media.audio/audionodelistener_audionodelistener_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioNodeListener.#ctor --api-type: winrt method ---- # Windows.Media.Audio.AudioNodeListener.AudioNodeListener ## -description Creates a new instance of the [AudioNodeListener](audionodelistener.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioNodeListener.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioNodeListener.AudioNodeListener + +## -description +Creates a new instance of the [AudioNodeListener](audionodelistener.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodelistener_dopplervelocity.md b/windows.media.audio/audionodelistener_dopplervelocity.md index fefb7c953b..224ba79312 100644 --- a/windows.media.audio/audionodelistener_dopplervelocity.md +++ b/windows.media.audio/audionodelistener_dopplervelocity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeListener.DopplerVelocity --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeListener.DopplerVelocity ## -description Gets or sets a [Vector3](../windows.foundation.numerics/vector3.md) expressing the velocity at which the listener is moving in 3D space, expressed in meters per second. ## -property-value The velocity at which the listener is moving. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeListener.DopplerVelocity +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeListener.DopplerVelocity + +## -description +Gets or sets a [Vector3](../windows.foundation.numerics/vector3.md) expressing the velocity at which the listener is moving in 3D space, expressed in meters per second. + +## -property-value +The velocity at which the listener is moving. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodelistener_orientation.md b/windows.media.audio/audionodelistener_orientation.md index 289189e918..8cb5e939de 100644 --- a/windows.media.audio/audionodelistener_orientation.md +++ b/windows.media.audio/audionodelistener_orientation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeListener.Orientation --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeListener.Orientation ## -description Gets or sets a [Quaternion](../windows.foundation.numerics/quaternion.md) expressing the rotation of the listener in 3D space. ## -property-value The rotation of the listener in 3D space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeListener.Orientation +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeListener.Orientation + +## -description +Gets or sets a [Quaternion](../windows.foundation.numerics/quaternion.md) expressing the rotation of the listener in 3D space. + +## -property-value +The rotation of the listener in 3D space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodelistener_position.md b/windows.media.audio/audionodelistener_position.md index 59874ca00e..ff64b77d98 100644 --- a/windows.media.audio/audionodelistener_position.md +++ b/windows.media.audio/audionodelistener_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeListener.Position --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeListener.Position ## -description Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters. ## -property-value A vector representing the position of the emitter in 3D space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeListener.Position +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeListener.Position + +## -description +Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters. + +## -property-value +A vector representing the position of the emitter in 3D space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audionodelistener_speedofsound.md b/windows.media.audio/audionodelistener_speedofsound.md index 0a0fdc7df7..e735ee5d84 100644 --- a/windows.media.audio/audionodelistener_speedofsound.md +++ b/windows.media.audio/audionodelistener_speedofsound.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioNodeListener.SpeedOfSound --api-type: winrt property ---- # Windows.Media.Audio.AudioNodeListener.SpeedOfSound ## -description Gets or sets the speed of sound used for computing spatial audio, expressed in meters per second. ## -property-value The speed of sound used for computing spatial audio. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioNodeListener.SpeedOfSound +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioNodeListener.SpeedOfSound + +## -description +Gets or sets the speed of sound used for computing spatial audio, expressed in meters per second. + +## -property-value +The speed of sound used for computing spatial audio. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode.md b/windows.media.audio/audiosubmixnode.md index 3e50515761..f7f69e2cf0 100644 --- a/windows.media.audio/audiosubmixnode.md +++ b/windows.media.audio/audiosubmixnode.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Audio.AudioSubmixNode --api-type: winrt class ---- # Windows.Media.Audio.AudioSubmixNode ## -description Represents an audio submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes. ## -remarks Get an instance of this class by calling [CreateSubmixNode](audiograph_createsubmixnode.md). ## -examples ## -see-also [IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.AudioSubmixNode +-api-type: winrt class +--- + + + +# Windows.Media.Audio.AudioSubmixNode + +## -description +Represents an audio submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes. + +## -remarks +Get an instance of this class by calling [CreateSubmixNode](audiograph_createsubmixnode.md). + +## -examples + +## -see-also +[IAudioInputNode](iaudioinputnode.md), [IAudioNode](iaudionode.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.audio/audiosubmixnode_addoutgoingconnection_702981438.md b/windows.media.audio/audiosubmixnode_addoutgoingconnection_702981438.md index af9dd6939c..188f308195 100644 --- a/windows.media.audio/audiosubmixnode_addoutgoingconnection_702981438.md +++ b/windows.media.audio/audiosubmixnode_addoutgoingconnection_702981438.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection ## -description Adds an outgoing connection with gain to the audio submix node. ## -parameters ### -param destination The destination node for the connection. ### -param gain A value indicating the gain associated with the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode)](audiosubmixnode_addoutgoingconnection_877485530.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection + +## -description +Adds an outgoing connection with gain to the audio submix node. + +## -parameters +### -param destination +The destination node for the connection. + +### -param gain +A value indicating the gain associated with the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode)](audiosubmixnode_addoutgoingconnection_877485530.md) \ No newline at end of file diff --git a/windows.media.audio/audiosubmixnode_addoutgoingconnection_877485530.md b/windows.media.audio/audiosubmixnode_addoutgoingconnection_877485530.md index 4f4fc6466d..dd19ca2adb 100644 --- a/windows.media.audio/audiosubmixnode_addoutgoingconnection_877485530.md +++ b/windows.media.audio/audiosubmixnode_addoutgoingconnection_877485530.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection ## -description Adds an outgoing connection to the audio submix node. ## -parameters ### -param destination The destination node for the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode, Double)](audiosubmixnode_addoutgoingconnection_702981438.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.AddOutgoingConnection + +## -description +Adds an outgoing connection to the audio submix node. + +## -parameters +### -param destination +The destination node for the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode, Double)](audiosubmixnode_addoutgoingconnection_702981438.md) \ No newline at end of file diff --git a/windows.media.audio/audiosubmixnode_close_811482585.md b/windows.media.audio/audiosubmixnode_close_811482585.md index b3072618ea..71ecb5846a 100644 --- a/windows.media.audio/audiosubmixnode_close_811482585.md +++ b/windows.media.audio/audiosubmixnode_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.Close --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.Close ## -description Closes the audio submix node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.Close +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.Close + +## -description +Closes the audio submix node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_consumeinput.md b/windows.media.audio/audiosubmixnode_consumeinput.md index 428900e957..5c358f83f8 100644 --- a/windows.media.audio/audiosubmixnode_consumeinput.md +++ b/windows.media.audio/audiosubmixnode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioSubmixNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.AudioSubmixNode.ConsumeInput ## -description Gets or sets a value indicating if the audio submix node consumes input. ## -property-value True if the audio submix node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioSubmixNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioSubmixNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio submix node consumes input. + +## -property-value +True if the audio submix node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_disableeffectsbydefinition_730128310.md b/windows.media.audio/audiosubmixnode_disableeffectsbydefinition_730128310.md index dd9a0e7c00..3f461f0ebe 100644 --- a/windows.media.audio/audiosubmixnode_disableeffectsbydefinition_730128310.md +++ b/windows.media.audio/audiosubmixnode_disableeffectsbydefinition_730128310.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](audiosubmixnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](audiosubmixnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_effectdefinitions.md b/windows.media.audio/audiosubmixnode_effectdefinitions.md index 53b7c2ccd4..cf138e9e06 100644 --- a/windows.media.audio/audiosubmixnode_effectdefinitions.md +++ b/windows.media.audio/audiosubmixnode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.AudioSubmixNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.AudioSubmixNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio submix node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioSubmixNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioSubmixNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio submix node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/audiosubmixnode_emitter.md b/windows.media.audio/audiosubmixnode_emitter.md index d8e2b3ced2..d1b4f088d3 100644 --- a/windows.media.audio/audiosubmixnode_emitter.md +++ b/windows.media.audio/audiosubmixnode_emitter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioSubmixNode.Emitter --api-type: winrt property ---- # Windows.Media.Audio.AudioSubmixNode.Emitter ## -description Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioSubmixNode](audiosubmixnode.md) output audio is emitted when spatial audio processing is used. ## -property-value The spatial audio emitter associated with the [AudioSubmixNode](audiosubmixnode.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioSubmixNode.Emitter +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioSubmixNode.Emitter + +## -description +Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the [AudioSubmixNode](audiosubmixnode.md) output audio is emitted when spatial audio processing is used. + +## -property-value +The spatial audio emitter associated with the [AudioSubmixNode](audiosubmixnode.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_enableeffectsbydefinition_1376948293.md b/windows.media.audio/audiosubmixnode_enableeffectsbydefinition_1376948293.md index 82149afa2c..c10566782d 100644 --- a/windows.media.audio/audiosubmixnode_enableeffectsbydefinition_1376948293.md +++ b/windows.media.audio/audiosubmixnode_enableeffectsbydefinition_1376948293.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](audiosubmixnode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](audiosubmixnode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_encodingproperties.md b/windows.media.audio/audiosubmixnode_encodingproperties.md index 7d9b217166..a1465c617e 100644 --- a/windows.media.audio/audiosubmixnode_encodingproperties.md +++ b/windows.media.audio/audiosubmixnode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioSubmixNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.AudioSubmixNode.EncodingProperties ## -description Gets the encoding properties for the audio device submix node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioSubmixNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioSubmixNode.EncodingProperties + +## -description +Gets the encoding properties for the audio device submix node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_outgoingconnections.md b/windows.media.audio/audiosubmixnode_outgoingconnections.md index afca1b3b25..277827ebc5 100644 --- a/windows.media.audio/audiosubmixnode_outgoingconnections.md +++ b/windows.media.audio/audiosubmixnode_outgoingconnections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioSubmixNode.OutgoingConnections --api-type: winrt property ---- # Windows.Media.Audio.AudioSubmixNode.OutgoingConnections ## -description Gets outgoing connections from the audio submix node to other nodes in the audio graph. ## -property-value A collection of objects representing audio graph connections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioSubmixNode.OutgoingConnections +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioSubmixNode.OutgoingConnections + +## -description +Gets outgoing connections from the audio submix node to other nodes in the audio graph. + +## -property-value +A collection of objects representing audio graph connections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_outgoinggain.md b/windows.media.audio/audiosubmixnode_outgoinggain.md index 41e13cb9e3..23f57c8299 100644 --- a/windows.media.audio/audiosubmixnode_outgoinggain.md +++ b/windows.media.audio/audiosubmixnode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.AudioSubmixNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.AudioSubmixNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio submix node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.AudioSubmixNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.AudioSubmixNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio submix node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_removeoutgoingconnection_1321353886.md b/windows.media.audio/audiosubmixnode_removeoutgoingconnection_1321353886.md index 0d12de7131..9e70626233 100644 --- a/windows.media.audio/audiosubmixnode_removeoutgoingconnection_1321353886.md +++ b/windows.media.audio/audiosubmixnode_removeoutgoingconnection_1321353886.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.RemoveOutgoingConnection ## -description Removes an outgoing connection from the audio submix node. ## -parameters ### -param destination The destination for the outgoing connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.RemoveOutgoingConnection + +## -description +Removes an outgoing connection from the audio submix node. + +## -parameters +### -param destination +The destination for the outgoing connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_reset_1636126115.md b/windows.media.audio/audiosubmixnode_reset_1636126115.md index 78ee37e5d6..a885b82313 100644 --- a/windows.media.audio/audiosubmixnode_reset_1636126115.md +++ b/windows.media.audio/audiosubmixnode_reset_1636126115.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.Reset ## -description Resets the audio submix node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.Reset + +## -description +Resets the audio submix node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_start_1587696324.md b/windows.media.audio/audiosubmixnode_start_1587696324.md index 261d29a159..1c45b674f6 100644 --- a/windows.media.audio/audiosubmixnode_start_1587696324.md +++ b/windows.media.audio/audiosubmixnode_start_1587696324.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.Start --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.Start ## -description Starts the audio submix node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.Start + +## -description +Starts the audio submix node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/audiosubmixnode_stop_1201535524.md b/windows.media.audio/audiosubmixnode_stop_1201535524.md index ec6b7fd2aa..06a82b71b3 100644 --- a/windows.media.audio/audiosubmixnode_stop_1201535524.md +++ b/windows.media.audio/audiosubmixnode_stop_1201535524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.AudioSubmixNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.AudioSubmixNode.Stop ## -description Stops the audio submix node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.AudioSubmixNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.AudioSubmixNode.Stop + +## -description +Stops the audio submix node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiodeviceinputnoderesult.md b/windows.media.audio/createaudiodeviceinputnoderesult.md index ed5355ab41..74357d58ba 100644 --- a/windows.media.audio/createaudiodeviceinputnoderesult.md +++ b/windows.media.audio/createaudiodeviceinputnoderesult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.CreateAudioDeviceInputNodeResult --api-type: winrt class ---- # Windows.Media.Audio.CreateAudioDeviceInputNodeResult ## -description Represents the result of creating an audio device input node. ## -remarks Get an instance of this class by calling [AudioGraph.CreateDeviceInputNodeAsync](audiograph_createdeviceinputnodeasync.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.CreateAudioDeviceInputNodeResult +-api-type: winrt class +--- + + + +# Windows.Media.Audio.CreateAudioDeviceInputNodeResult + +## -description +Represents the result of creating an audio device input node. + +## -remarks +Get an instance of this class by calling [AudioGraph.CreateDeviceInputNodeAsync](audiograph_createdeviceinputnodeasync.md) + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiodeviceinputnoderesult_deviceinputnode.md b/windows.media.audio/createaudiodeviceinputnoderesult_deviceinputnode.md index c538bcfacb..80a57c585f 100644 --- a/windows.media.audio/createaudiodeviceinputnoderesult_deviceinputnode.md +++ b/windows.media.audio/createaudiodeviceinputnoderesult_deviceinputnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioDeviceInputNodeResult.DeviceInputNode --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioDeviceInputNodeResult.DeviceInputNode ## -description Gets the audio device input node. ## -property-value An object representing the audio device input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioDeviceInputNodeResult.DeviceInputNode +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioDeviceInputNodeResult.DeviceInputNode + +## -description +Gets the audio device input node. + +## -property-value +An object representing the audio device input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiodeviceinputnoderesult_status.md b/windows.media.audio/createaudiodeviceinputnoderesult_status.md index f425b993b0..f9d9378036 100644 --- a/windows.media.audio/createaudiodeviceinputnoderesult_status.md +++ b/windows.media.audio/createaudiodeviceinputnoderesult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioDeviceInputNodeResult.Status --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioDeviceInputNodeResult.Status ## -description Gets the status of audio device input node creation. ## -property-value An enumeration value indicating node creation status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioDeviceInputNodeResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioDeviceInputNodeResult.Status + +## -description +Gets the status of audio device input node creation. + +## -property-value +An enumeration value indicating node creation status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiodeviceoutputnoderesult.md b/windows.media.audio/createaudiodeviceoutputnoderesult.md index 2d310ca3bb..56257dc65f 100644 --- a/windows.media.audio/createaudiodeviceoutputnoderesult.md +++ b/windows.media.audio/createaudiodeviceoutputnoderesult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.CreateAudioDeviceOutputNodeResult --api-type: winrt class ---- # Windows.Media.Audio.CreateAudioDeviceOutputNodeResult ## -description Represents the result of creating an audio device output node. ## -remarks Get an instance of this class by calling [AudioGraph.CreateDeviceOutputNodeAsync](audiograph_createdeviceoutputnodeasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.CreateAudioDeviceOutputNodeResult +-api-type: winrt class +--- + + + +# Windows.Media.Audio.CreateAudioDeviceOutputNodeResult + +## -description +Represents the result of creating an audio device output node. + +## -remarks +Get an instance of this class by calling [AudioGraph.CreateDeviceOutputNodeAsync](audiograph_createdeviceoutputnodeasync.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiodeviceoutputnoderesult_deviceoutputnode.md b/windows.media.audio/createaudiodeviceoutputnoderesult_deviceoutputnode.md index 9878ba46c0..40a276d9ee 100644 --- a/windows.media.audio/createaudiodeviceoutputnoderesult_deviceoutputnode.md +++ b/windows.media.audio/createaudiodeviceoutputnoderesult_deviceoutputnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.DeviceOutputNode --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.DeviceOutputNode ## -description Gets the audio device output node. ## -property-value An object representing the audio device output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.DeviceOutputNode +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.DeviceOutputNode + +## -description +Gets the audio device output node. + +## -property-value +An object representing the audio device output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiodeviceoutputnoderesult_status.md b/windows.media.audio/createaudiodeviceoutputnoderesult_status.md index 643e9470f8..1219de7284 100644 --- a/windows.media.audio/createaudiodeviceoutputnoderesult_status.md +++ b/windows.media.audio/createaudiodeviceoutputnoderesult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.Status --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.Status ## -description Gets the status of audio device output node creation. ## -property-value An enumeration value indicating node creation status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioDeviceOutputNodeResult.Status + +## -description +Gets the status of audio device output node creation. + +## -property-value +An enumeration value indicating node creation status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiofileinputnoderesult.md b/windows.media.audio/createaudiofileinputnoderesult.md index ea2791be40..01be849e98 100644 --- a/windows.media.audio/createaudiofileinputnoderesult.md +++ b/windows.media.audio/createaudiofileinputnoderesult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.CreateAudioFileInputNodeResult --api-type: winrt class ---- # Windows.Media.Audio.CreateAudioFileInputNodeResult ## -description Represents the result of creating an audio file input node. ## -remarks Get an instance of this class by calling [AudioGraph.CreateFileInputNodeAsync](audiograph_createfileinputnodeasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.CreateAudioFileInputNodeResult +-api-type: winrt class +--- + + + +# Windows.Media.Audio.CreateAudioFileInputNodeResult + +## -description +Represents the result of creating an audio file input node. + +## -remarks +Get an instance of this class by calling [AudioGraph.CreateFileInputNodeAsync](audiograph_createfileinputnodeasync.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiofileinputnoderesult_fileinputnode.md b/windows.media.audio/createaudiofileinputnoderesult_fileinputnode.md index 3580a52ac8..d334f210f7 100644 --- a/windows.media.audio/createaudiofileinputnoderesult_fileinputnode.md +++ b/windows.media.audio/createaudiofileinputnoderesult_fileinputnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioFileInputNodeResult.FileInputNode --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioFileInputNodeResult.FileInputNode ## -description Gets the audio file input node. ## -property-value An object representing the audio file input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioFileInputNodeResult.FileInputNode +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioFileInputNodeResult.FileInputNode + +## -description +Gets the audio file input node. + +## -property-value +An object representing the audio file input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiofileinputnoderesult_status.md b/windows.media.audio/createaudiofileinputnoderesult_status.md index 89549c371b..f37d636998 100644 --- a/windows.media.audio/createaudiofileinputnoderesult_status.md +++ b/windows.media.audio/createaudiofileinputnoderesult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioFileInputNodeResult.Status --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioFileInputNodeResult.Status ## -description Gets the status of audio file input node creation. ## -property-value An enumeration value indicating file node creation status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioFileInputNodeResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioFileInputNodeResult.Status + +## -description +Gets the status of audio file input node creation. + +## -property-value +An enumeration value indicating file node creation status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiofileoutputnoderesult.md b/windows.media.audio/createaudiofileoutputnoderesult.md index 213cc160bb..ea2213c504 100644 --- a/windows.media.audio/createaudiofileoutputnoderesult.md +++ b/windows.media.audio/createaudiofileoutputnoderesult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.CreateAudioFileOutputNodeResult --api-type: winrt class ---- # Windows.Media.Audio.CreateAudioFileOutputNodeResult ## -description Represents the result of creating an audio file output node. ## -remarks Get an instance of this class by calling [AudioGraph.CreateFileOutputNodeAsync](audiograph_createfileoutputnodeasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.CreateAudioFileOutputNodeResult +-api-type: winrt class +--- + + + +# Windows.Media.Audio.CreateAudioFileOutputNodeResult + +## -description +Represents the result of creating an audio file output node. + +## -remarks +Get an instance of this class by calling [AudioGraph.CreateFileOutputNodeAsync](audiograph_createfileoutputnodeasync.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiofileoutputnoderesult_fileoutputnode.md b/windows.media.audio/createaudiofileoutputnoderesult_fileoutputnode.md index ff069862d2..cedce4e5be 100644 --- a/windows.media.audio/createaudiofileoutputnoderesult_fileoutputnode.md +++ b/windows.media.audio/createaudiofileoutputnoderesult_fileoutputnode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioFileOutputNodeResult.FileOutputNode --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioFileOutputNodeResult.FileOutputNode ## -description Gets the audio file output node. ## -property-value An object representing the audio file output node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioFileOutputNodeResult.FileOutputNode +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioFileOutputNodeResult.FileOutputNode + +## -description +Gets the audio file output node. + +## -property-value +An object representing the audio file output node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiofileoutputnoderesult_status.md b/windows.media.audio/createaudiofileoutputnoderesult_status.md index c77cfa2719..878044939c 100644 --- a/windows.media.audio/createaudiofileoutputnoderesult_status.md +++ b/windows.media.audio/createaudiofileoutputnoderesult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioFileOutputNodeResult.Status --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioFileOutputNodeResult.Status ## -description Gets the status of audio file output node creation. ## -property-value An enumeration value indicating node creation status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioFileOutputNodeResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioFileOutputNodeResult.Status + +## -description +Gets the status of audio file output node creation. + +## -property-value +An enumeration value indicating node creation status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiographresult.md b/windows.media.audio/createaudiographresult.md index 7006b24912..a817c4d464 100644 --- a/windows.media.audio/createaudiographresult.md +++ b/windows.media.audio/createaudiographresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.CreateAudioGraphResult --api-type: winrt class ---- # Windows.Media.Audio.CreateAudioGraphResult ## -description Represents the result of creating an audio graph. ## -remarks Get an instance of this class by calling [AudioGraph.CreateAsync](audiograph_createasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.CreateAudioGraphResult +-api-type: winrt class +--- + + + +# Windows.Media.Audio.CreateAudioGraphResult + +## -description +Represents the result of creating an audio graph. + +## -remarks +Get an instance of this class by calling [AudioGraph.CreateAsync](audiograph_createasync.md). + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiographresult_graph.md b/windows.media.audio/createaudiographresult_graph.md index b531df0090..cec4b15ced 100644 --- a/windows.media.audio/createaudiographresult_graph.md +++ b/windows.media.audio/createaudiographresult_graph.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioGraphResult.Graph --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioGraphResult.Graph ## -description Gets the audio graph object. ## -property-value An object indicating the audio graph. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioGraphResult.Graph +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioGraphResult.Graph + +## -description +Gets the audio graph object. + +## -property-value +An object indicating the audio graph. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/createaudiographresult_status.md b/windows.media.audio/createaudiographresult_status.md index ccb2b44233..771734b776 100644 --- a/windows.media.audio/createaudiographresult_status.md +++ b/windows.media.audio/createaudiographresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.CreateAudioGraphResult.Status --api-type: winrt property ---- # Windows.Media.Audio.CreateAudioGraphResult.Status ## -description Gets the status of audio graph creation. ## -property-value An enumeration value indicating audio graph creation status. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.CreateAudioGraphResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Audio.CreateAudioGraphResult.Status + +## -description +Gets the status of audio graph creation. + +## -property-value +An enumeration value indicating audio graph creation status. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/echoeffectdefinition.md b/windows.media.audio/echoeffectdefinition.md index ff330339c1..3108a6d556 100644 --- a/windows.media.audio/echoeffectdefinition.md +++ b/windows.media.audio/echoeffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.EchoEffectDefinition --api-type: winrt class ---- # Windows.Media.Audio.EchoEffectDefinition ## -description Represents an echo effect definition supported by the audio graph. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.EchoEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Audio.EchoEffectDefinition + +## -description +Represents an echo effect definition supported by the audio graph. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/echoeffectdefinition_activatableclassid.md b/windows.media.audio/echoeffectdefinition_activatableclassid.md index 62e12c02f9..2687e193f4 100644 --- a/windows.media.audio/echoeffectdefinition_activatableclassid.md +++ b/windows.media.audio/echoeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EchoEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Audio.EchoEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID for the echo effect definition object. ## -property-value The activatable class ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EchoEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EchoEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID for the echo effect definition object. + +## -property-value +The activatable class ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/echoeffectdefinition_delay.md b/windows.media.audio/echoeffectdefinition_delay.md index a038d52c5e..0968e9e174 100644 --- a/windows.media.audio/echoeffectdefinition_delay.md +++ b/windows.media.audio/echoeffectdefinition_delay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EchoEffectDefinition.Delay --api-type: winrt property ---- # Windows.Media.Audio.EchoEffectDefinition.Delay ## -description Gets or sets the delay supported by the echo effect definition. ## -property-value A value indicating the delay. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EchoEffectDefinition.Delay +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EchoEffectDefinition.Delay + +## -description +Gets or sets the delay supported by the echo effect definition. + +## -property-value +A value indicating the delay. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/echoeffectdefinition_echoeffectdefinition_2086735898.md b/windows.media.audio/echoeffectdefinition_echoeffectdefinition_2086735898.md index f7c233b95e..2e7e6cf21b 100644 --- a/windows.media.audio/echoeffectdefinition_echoeffectdefinition_2086735898.md +++ b/windows.media.audio/echoeffectdefinition_echoeffectdefinition_2086735898.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.EchoEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) --api-type: winrt method ---- # Windows.Media.Audio.EchoEffectDefinition.EchoEffectDefinition ## -description Creates an [EchoEffectDefinition](echoeffectdefinition.md) object. ## -parameters ### -param audioGraph The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.EchoEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.EchoEffectDefinition.EchoEffectDefinition + +## -description +Creates an [EchoEffectDefinition](echoeffectdefinition.md) object. + +## -parameters +### -param audioGraph +The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/echoeffectdefinition_feedback.md b/windows.media.audio/echoeffectdefinition_feedback.md index 67512881c2..e2c59a5c9a 100644 --- a/windows.media.audio/echoeffectdefinition_feedback.md +++ b/windows.media.audio/echoeffectdefinition_feedback.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EchoEffectDefinition.Feedback --api-type: winrt property ---- # Windows.Media.Audio.EchoEffectDefinition.Feedback ## -description Gets or sets the feedback included in the echo effect definition. ## -property-value A feedback value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EchoEffectDefinition.Feedback +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EchoEffectDefinition.Feedback + +## -description +Gets or sets the feedback included in the echo effect definition. + +## -property-value +A feedback value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/echoeffectdefinition_properties.md b/windows.media.audio/echoeffectdefinition_properties.md index afce98f161..79e86f07fd 100644 --- a/windows.media.audio/echoeffectdefinition_properties.md +++ b/windows.media.audio/echoeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EchoEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Audio.EchoEffectDefinition.Properties ## -description Gets or sets the properties supported by the echo effect definition. ## -property-value The set of properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EchoEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EchoEffectDefinition.Properties + +## -description +Gets or sets the properties supported by the echo effect definition. + +## -property-value +The set of properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/echoeffectdefinition_wetdrymix.md b/windows.media.audio/echoeffectdefinition_wetdrymix.md index 9b46b68e09..e88d753532 100644 --- a/windows.media.audio/echoeffectdefinition_wetdrymix.md +++ b/windows.media.audio/echoeffectdefinition_wetdrymix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EchoEffectDefinition.WetDryMix --api-type: winrt property ---- # Windows.Media.Audio.EchoEffectDefinition.WetDryMix ## -description Gets or sets the wet-dry audio voice mix for the echo effect definition. ## -property-value A value indicating the wet-dry audio voice mix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EchoEffectDefinition.WetDryMix +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EchoEffectDefinition.WetDryMix + +## -description +Gets or sets the wet-dry audio voice mix for the echo effect definition. + +## -property-value +A value indicating the wet-dry audio voice mix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizerband.md b/windows.media.audio/equalizerband.md index 6f5d0acea0..8b2682dce5 100644 --- a/windows.media.audio/equalizerband.md +++ b/windows.media.audio/equalizerband.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.EqualizerBand --api-type: winrt class ---- # Windows.Media.Audio.EqualizerBand ## -description Represents an equalizer band for the equalizer effect. ## -remarks Get an instance of this class by accessing the [EqualizerEffectDefinition.Bands](equalizereffectdefinition_bands.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.EqualizerBand +-api-type: winrt class +--- + + + +# Windows.Media.Audio.EqualizerBand + +## -description +Represents an equalizer band for the equalizer effect. + +## -remarks +Get an instance of this class by accessing the [EqualizerEffectDefinition.Bands](equalizereffectdefinition_bands.md) property. + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizerband_bandwidth.md b/windows.media.audio/equalizerband_bandwidth.md index c94b695182..f6b25ec175 100644 --- a/windows.media.audio/equalizerband_bandwidth.md +++ b/windows.media.audio/equalizerband_bandwidth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EqualizerBand.Bandwidth --api-type: winrt property ---- # Windows.Media.Audio.EqualizerBand.Bandwidth ## -description Gets or sets the bandwidth for the equalizer band. ## -property-value A bandwidth value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EqualizerBand.Bandwidth +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EqualizerBand.Bandwidth + +## -description +Gets or sets the bandwidth for the equalizer band. + +## -property-value +A bandwidth value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizerband_frequencycenter.md b/windows.media.audio/equalizerband_frequencycenter.md index d9915944f2..d25b54b75e 100644 --- a/windows.media.audio/equalizerband_frequencycenter.md +++ b/windows.media.audio/equalizerband_frequencycenter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EqualizerBand.FrequencyCenter --api-type: winrt property ---- # Windows.Media.Audio.EqualizerBand.FrequencyCenter ## -description Gets or sets the frequency center for the equalizer band. ## -property-value A value indicating the frequency center. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EqualizerBand.FrequencyCenter +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EqualizerBand.FrequencyCenter + +## -description +Gets or sets the frequency center for the equalizer band. + +## -property-value +A value indicating the frequency center. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizerband_gain.md b/windows.media.audio/equalizerband_gain.md index cd3fd7dd91..37ea16f797 100644 --- a/windows.media.audio/equalizerband_gain.md +++ b/windows.media.audio/equalizerband_gain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EqualizerBand.Gain --api-type: winrt property ---- # Windows.Media.Audio.EqualizerBand.Gain ## -description Gets or sets the gain for the equalizer band. ## -property-value A value indicating the gain. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EqualizerBand.Gain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EqualizerBand.Gain + +## -description +Gets or sets the gain for the equalizer band. + +## -property-value +A value indicating the gain. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizereffectdefinition.md b/windows.media.audio/equalizereffectdefinition.md index 7f58ec519c..38facfc139 100644 --- a/windows.media.audio/equalizereffectdefinition.md +++ b/windows.media.audio/equalizereffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.EqualizerEffectDefinition --api-type: winrt class ---- # Windows.Media.Audio.EqualizerEffectDefinition ## -description Represents an equalizer effect definition supported by the audio graph. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.EqualizerEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Audio.EqualizerEffectDefinition + +## -description +Represents an equalizer effect definition supported by the audio graph. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/equalizereffectdefinition_activatableclassid.md b/windows.media.audio/equalizereffectdefinition_activatableclassid.md index 65ef145187..276cb0a1ef 100644 --- a/windows.media.audio/equalizereffectdefinition_activatableclassid.md +++ b/windows.media.audio/equalizereffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EqualizerEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Audio.EqualizerEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID for the equalizer effect definition object. ## -property-value The activatable class ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EqualizerEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EqualizerEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID for the equalizer effect definition object. + +## -property-value +The activatable class ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizereffectdefinition_bands.md b/windows.media.audio/equalizereffectdefinition_bands.md index af4fcb2a93..984f1f0701 100644 --- a/windows.media.audio/equalizereffectdefinition_bands.md +++ b/windows.media.audio/equalizereffectdefinition_bands.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EqualizerEffectDefinition.Bands --api-type: winrt property ---- # Windows.Media.Audio.EqualizerEffectDefinition.Bands ## -description Gets the bands included in the equalizer effect definition. ## -property-value A collection of objects indicating the equalizer bands. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EqualizerEffectDefinition.Bands +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EqualizerEffectDefinition.Bands + +## -description +Gets the bands included in the equalizer effect definition. + +## -property-value +A collection of objects indicating the equalizer bands. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizereffectdefinition_equalizereffectdefinition_2086735898.md b/windows.media.audio/equalizereffectdefinition_equalizereffectdefinition_2086735898.md index 244dee29bf..aedcdd922b 100644 --- a/windows.media.audio/equalizereffectdefinition_equalizereffectdefinition_2086735898.md +++ b/windows.media.audio/equalizereffectdefinition_equalizereffectdefinition_2086735898.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.EqualizerEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) --api-type: winrt method ---- # Windows.Media.Audio.EqualizerEffectDefinition.EqualizerEffectDefinition ## -description Initializes a new instance of the [EqualizerEffectDefinition](equalizereffectdefinition.md) class. ## -parameters ### -param audioGraph The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.EqualizerEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.EqualizerEffectDefinition.EqualizerEffectDefinition + +## -description +Initializes a new instance of the [EqualizerEffectDefinition](equalizereffectdefinition.md) class. + +## -parameters +### -param audioGraph +The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/equalizereffectdefinition_properties.md b/windows.media.audio/equalizereffectdefinition_properties.md index 874e2cb742..8563fd709f 100644 --- a/windows.media.audio/equalizereffectdefinition_properties.md +++ b/windows.media.audio/equalizereffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.EqualizerEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Audio.EqualizerEffectDefinition.Properties ## -description Gets the properties supported by the equalizer effect definition. ## -property-value The set of properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.EqualizerEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.EqualizerEffectDefinition.Properties + +## -description +Gets the properties supported by the equalizer effect definition. + +## -property-value +The set of properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/frameinputnodequantumstartedeventargs.md b/windows.media.audio/frameinputnodequantumstartedeventargs.md index f0c8b6c450..db5c5b96b6 100644 --- a/windows.media.audio/frameinputnodequantumstartedeventargs.md +++ b/windows.media.audio/frameinputnodequantumstartedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs --api-type: winrt class ---- # Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs ## -description Provides data for the [AudioFrameInputNode::QuantumStarted](audioframeinputnode_quantumstarted.md) event. This event is raised when the audio graph containing the audio frame input node is ready to begin processing a new quantum of data. ## -remarks Get an instance of this class by handling the [AudioFrameInputNode.QuantumStarted](audioframeinputnode_quantumstarted.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs + +## -description +Provides data for the [AudioFrameInputNode::QuantumStarted](audioframeinputnode_quantumstarted.md) event. This event is raised when the audio graph containing the audio frame input node is ready to begin processing a new quantum of data. + +## -remarks +Get an instance of this class by handling the [AudioFrameInputNode.QuantumStarted](audioframeinputnode_quantumstarted.md) event. + +## -examples + +## -see-also diff --git a/windows.media.audio/frameinputnodequantumstartedeventargs_requiredsamples.md b/windows.media.audio/frameinputnodequantumstartedeventargs_requiredsamples.md index 6a62265397..0c124c62cc 100644 --- a/windows.media.audio/frameinputnodequantumstartedeventargs_requiredsamples.md +++ b/windows.media.audio/frameinputnodequantumstartedeventargs_requiredsamples.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs.RequiredSamples --api-type: winrt property ---- # Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs.RequiredSamples ## -description Gets the number of samples that the audio graph requires to fill the quantum with data. ## -property-value The number of samples that the audio graph requires to fill the quantum with data. ## -remarks Pass an [AudioFrame](audioframecompletedeventargs.md) into the [AddFrame](audioframeinputnode_addframe.md) method to provide the required audio samples. It is recommended that you only submit the number of samples requested by the audio graph. Submitting extra samples can result in latency in the audio graph. If the amount of data currently in the node is more than enough to fill one quantum, **RequiredSamples** will be 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs.RequiredSamples +-api-type: winrt property +--- + + + +# Windows.Media.Audio.FrameInputNodeQuantumStartedEventArgs.RequiredSamples + +## -description +Gets the number of samples that the audio graph requires to fill the quantum with data. + +## -property-value +The number of samples that the audio graph requires to fill the quantum with data. + +## -remarks +Pass an [AudioFrame](audioframecompletedeventargs.md) into the [AddFrame](audioframeinputnode_addframe.md) method to provide the required audio samples. It is recommended that you only submit the number of samples requested by the audio graph. Submitting extra samples can result in latency in the audio graph. + +If the amount of data currently in the node is more than enough to fill one quantum, **RequiredSamples** will be 0. + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudioinputnode2_emitter.md b/windows.media.audio/iaudioinputnode2_emitter.md index ae124e61df..b45c8ac4d6 100644 --- a/windows.media.audio/iaudioinputnode2_emitter.md +++ b/windows.media.audio/iaudioinputnode2_emitter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.IAudioInputNode2.Emitter --api-type: winrt property ---- # Windows.Media.Audio.IAudioInputNode2.Emitter ## -description Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the audio input node audio is emitted when spatial audio processing is used. ## -property-value The emitter for the audio input node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioInputNode2.Emitter +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioInputNode2.Emitter + +## -description +Gets the [AudioNodeEmitter](audionodeemitter.md) that describes the position and other physical characteristics of the emitter from which the audio input node audio is emitted when spatial audio processing is used. + +## -property-value +The emitter for the audio input node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudioinputnode_addoutgoingconnection_702981438.md b/windows.media.audio/iaudioinputnode_addoutgoingconnection_702981438.md index ef339e00a8..3ef9e19952 100644 --- a/windows.media.audio/iaudioinputnode_addoutgoingconnection_702981438.md +++ b/windows.media.audio/iaudioinputnode_addoutgoingconnection_702981438.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) --api-type: winrt method ---- # Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection ## -description Adds an outgoing connection with gain to the audio input node. ## -parameters ### -param destination The destination node for the connection. ### -param gain A value indicating the gain associated with the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode)](iaudioinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection with gain to the audio input node. + +## -parameters +### -param destination +The destination node for the connection. + +### -param gain +A value indicating the gain associated with the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode)](iaudioinputnode_addoutgoingconnection_877485530.md) \ No newline at end of file diff --git a/windows.media.audio/iaudioinputnode_addoutgoingconnection_877485530.md b/windows.media.audio/iaudioinputnode_addoutgoingconnection_877485530.md index d18ff53061..93d3045a10 100644 --- a/windows.media.audio/iaudioinputnode_addoutgoingconnection_877485530.md +++ b/windows.media.audio/iaudioinputnode_addoutgoingconnection_877485530.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection ## -description Adds an outgoing connection to the audio input node. ## -parameters ### -param destination The destination node for the connection. ## -remarks ## -examples ## -see-also [AddOutgoingConnection(IAudioNode, Double)](iaudioinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioInputNode.AddOutgoingConnection + +## -description +Adds an outgoing connection to the audio input node. + +## -parameters +### -param destination +The destination node for the connection. + +## -remarks + +## -examples + +## -see-also +[AddOutgoingConnection(IAudioNode, Double)](iaudioinputnode_addoutgoingconnection_702981438.md) \ No newline at end of file diff --git a/windows.media.audio/iaudioinputnode_outgoingconnections.md b/windows.media.audio/iaudioinputnode_outgoingconnections.md index 07e89f8424..1002f10223 100644 --- a/windows.media.audio/iaudioinputnode_outgoingconnections.md +++ b/windows.media.audio/iaudioinputnode_outgoingconnections.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.IAudioInputNode.OutgoingConnections --api-type: winrt property ---- # Windows.Media.Audio.IAudioInputNode.OutgoingConnections ## -description Gets outgoing connections for the audio input node. ## -property-value A collection of audio graph connection objects representing the outgoing connections. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioInputNode.OutgoingConnections +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioInputNode.OutgoingConnections + +## -description +Gets outgoing connections for the audio input node. + +## -property-value +A collection of audio graph connection objects representing the outgoing connections. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudioinputnode_removeoutgoingconnection.md b/windows.media.audio/iaudioinputnode_removeoutgoingconnection.md index adf22cb492..684ce66240 100644 --- a/windows.media.audio/iaudioinputnode_removeoutgoingconnection.md +++ b/windows.media.audio/iaudioinputnode_removeoutgoingconnection.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.IAudioInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) --api-type: winrt method ---- # Windows.Media.Audio.IAudioInputNode.RemoveOutgoingConnection ## -description Removes an outgoing connection from the audio input node. ## -parameters ### -param destination The destination node for the connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioInputNode.RemoveOutgoingConnection(Windows.Media.Audio.IAudioNode) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioInputNode.RemoveOutgoingConnection + +## -description +Removes an outgoing connection from the audio input node. + +## -parameters +### -param destination +The destination node for the connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_consumeinput.md b/windows.media.audio/iaudionode_consumeinput.md index a63269de85..645d48d899 100644 --- a/windows.media.audio/iaudionode_consumeinput.md +++ b/windows.media.audio/iaudionode_consumeinput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.IAudioNode.ConsumeInput --api-type: winrt property ---- # Windows.Media.Audio.IAudioNode.ConsumeInput ## -description Gets or sets a value indicating if the audio node consumes input. ## -property-value True if the audio node consumes input, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioNode.ConsumeInput +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioNode.ConsumeInput + +## -description +Gets or sets a value indicating if the audio node consumes input. + +## -property-value +True if the audio node consumes input, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_disableeffectsbydefinition.md b/windows.media.audio/iaudionode_disableeffectsbydefinition.md index d9a6029579..2d8442a045 100644 --- a/windows.media.audio/iaudionode_disableeffectsbydefinition.md +++ b/windows.media.audio/iaudionode_disableeffectsbydefinition.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.IAudioNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.IAudioNode.DisableEffectsByDefinition ## -description Disables all effects in the [EffectDefinitions](iaudionode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to disable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioNode.DisableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioNode.DisableEffectsByDefinition + +## -description +Disables all effects in the [EffectDefinitions](iaudionode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to disable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_effectdefinitions.md b/windows.media.audio/iaudionode_effectdefinitions.md index c3761e8195..2c7bfe62ac 100644 --- a/windows.media.audio/iaudionode_effectdefinitions.md +++ b/windows.media.audio/iaudionode_effectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Audio.IAudioNode.EffectDefinitions --api-type: winrt property ---- # Windows.Media.Audio.IAudioNode.EffectDefinitions ## -description Gets the list of effect definitions for the audio node. ## -property-value The list of effect definitions for the node. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioNode.EffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioNode.EffectDefinitions + +## -description +Gets the list of effect definitions for the audio node. + +## -property-value +The list of effect definitions for the node. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/iaudionode_enableeffectsbydefinition.md b/windows.media.audio/iaudionode_enableeffectsbydefinition.md index 827e128eb0..e8f6418dc9 100644 --- a/windows.media.audio/iaudionode_enableeffectsbydefinition.md +++ b/windows.media.audio/iaudionode_enableeffectsbydefinition.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.IAudioNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Audio.IAudioNode.EnableEffectsByDefinition ## -description Enables all effects in the [EffectDefinitions](iaudionode_effectdefinitions.md) list with the specified effect definition. ## -parameters ### -param definition The effect definition of the effects to enable. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioNode.EnableEffectsByDefinition(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioNode.EnableEffectsByDefinition + +## -description +Enables all effects in the [EffectDefinitions](iaudionode_effectdefinitions.md) list with the specified effect definition. + +## -parameters +### -param definition +The effect definition of the effects to enable. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_encodingproperties.md b/windows.media.audio/iaudionode_encodingproperties.md index 67fd8c00ae..19d2f05dad 100644 --- a/windows.media.audio/iaudionode_encodingproperties.md +++ b/windows.media.audio/iaudionode_encodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.IAudioNode.EncodingProperties --api-type: winrt property ---- # Windows.Media.Audio.IAudioNode.EncodingProperties ## -description Gets the encoding properties for the audio node. ## -property-value The encoding properties for the node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioNode.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioNode.EncodingProperties + +## -description +Gets the encoding properties for the audio node. + +## -property-value +The encoding properties for the node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_outgoinggain.md b/windows.media.audio/iaudionode_outgoinggain.md index 3dd3d1227a..e777dbfaa5 100644 --- a/windows.media.audio/iaudionode_outgoinggain.md +++ b/windows.media.audio/iaudionode_outgoinggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.IAudioNode.OutgoingGain --api-type: winrt property ---- # Windows.Media.Audio.IAudioNode.OutgoingGain ## -description Gets or sets the outgoing gain for the audio node. ## -property-value The outgoing gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioNode.OutgoingGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioNode.OutgoingGain + +## -description +Gets or sets the outgoing gain for the audio node. + +## -property-value +The outgoing gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_reset.md b/windows.media.audio/iaudionode_reset.md index c86197926f..0f066c5f42 100644 --- a/windows.media.audio/iaudionode_reset.md +++ b/windows.media.audio/iaudionode_reset.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.IAudioNode.Reset --api-type: winrt method ---- # Windows.Media.Audio.IAudioNode.Reset ## -description Resets the audio node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioNode.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioNode.Reset + +## -description +Resets the audio node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_start.md b/windows.media.audio/iaudionode_start.md index ddd347df73..44e6b7e8f3 100644 --- a/windows.media.audio/iaudionode_start.md +++ b/windows.media.audio/iaudionode_start.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.IAudioNode.Start --api-type: winrt method ---- # Windows.Media.Audio.IAudioNode.Start ## -description Starts the audio node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioNode.Start +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioNode.Start + +## -description +Starts the audio node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionode_stop.md b/windows.media.audio/iaudionode_stop.md index 3c73196172..5bdb72959f 100644 --- a/windows.media.audio/iaudionode_stop.md +++ b/windows.media.audio/iaudionode_stop.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Audio.IAudioNode.Stop --api-type: winrt method ---- # Windows.Media.Audio.IAudioNode.Stop ## -description Stops the audio node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.IAudioNode.Stop +-api-type: winrt method +--- + + + +# Windows.Media.Audio.IAudioNode.Stop + +## -description +Stops the audio node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/iaudionodewithlistener_listener.md b/windows.media.audio/iaudionodewithlistener_listener.md index bb713ea82e..41cab06b32 100644 --- a/windows.media.audio/iaudionodewithlistener_listener.md +++ b/windows.media.audio/iaudionodewithlistener_listener.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.IAudioNodeWithListener.Listener --api-type: winrt property ---- # Windows.Media.Audio.IAudioNodeWithListener.Listener ## -description Gets or sets the [AudioNodeListener](audionodelistener.md) that describes the position and other characteristics of the listener from which the node's audio is heard when spatial audio processing is used. ## -property-value The listener for the audio node. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.IAudioNodeWithListener.Listener +-api-type: winrt property +--- + + + +# Windows.Media.Audio.IAudioNodeWithListener.Listener + +## -description +Gets or sets the [AudioNodeListener](audionodelistener.md) that describes the position and other characteristics of the listener from which the node's audio is heard when spatial audio processing is used. + +## -property-value +The listener for the audio node. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/limitereffectdefinition.md b/windows.media.audio/limitereffectdefinition.md index ed0a533cf4..33ae14a0ee 100644 --- a/windows.media.audio/limitereffectdefinition.md +++ b/windows.media.audio/limitereffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.LimiterEffectDefinition --api-type: winrt class ---- # Windows.Media.Audio.LimiterEffectDefinition ## -description Represents a limiter effect definition supported by the audio graph. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.LimiterEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Audio.LimiterEffectDefinition + +## -description +Represents a limiter effect definition supported by the audio graph. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/limitereffectdefinition_activatableclassid.md b/windows.media.audio/limitereffectdefinition_activatableclassid.md index 56123ba1dc..8b7f8b25fb 100644 --- a/windows.media.audio/limitereffectdefinition_activatableclassid.md +++ b/windows.media.audio/limitereffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.LimiterEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Audio.LimiterEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID for the limiter effect definition object. ## -property-value The activatable class ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.LimiterEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Audio.LimiterEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID for the limiter effect definition object. + +## -property-value +The activatable class ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/limitereffectdefinition_limitereffectdefinition_2086735898.md b/windows.media.audio/limitereffectdefinition_limitereffectdefinition_2086735898.md index 31e11c41cd..a6ab7e8b4f 100644 --- a/windows.media.audio/limitereffectdefinition_limitereffectdefinition_2086735898.md +++ b/windows.media.audio/limitereffectdefinition_limitereffectdefinition_2086735898.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.LimiterEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) --api-type: winrt method ---- # Windows.Media.Audio.LimiterEffectDefinition.LimiterEffectDefinition ## -description Initializes a new instance of the [LimiterEffectDefinition](limitereffectdefinition.md) class. ## -parameters ### -param audioGraph The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.LimiterEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.LimiterEffectDefinition.LimiterEffectDefinition + +## -description +Initializes a new instance of the [LimiterEffectDefinition](limitereffectdefinition.md) class. + +## -parameters +### -param audioGraph +The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/limitereffectdefinition_loudness.md b/windows.media.audio/limitereffectdefinition_loudness.md index 809c6550be..32e4bc82fb 100644 --- a/windows.media.audio/limitereffectdefinition_loudness.md +++ b/windows.media.audio/limitereffectdefinition_loudness.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.LimiterEffectDefinition.Loudness --api-type: winrt property ---- # Windows.Media.Audio.LimiterEffectDefinition.Loudness ## -description Gets or sets the loudness included in the limiter effect definition. ## -property-value A value indicating the loudness. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.LimiterEffectDefinition.Loudness +-api-type: winrt property +--- + + + +# Windows.Media.Audio.LimiterEffectDefinition.Loudness + +## -description +Gets or sets the loudness included in the limiter effect definition. + +## -property-value +A value indicating the loudness. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/limitereffectdefinition_properties.md b/windows.media.audio/limitereffectdefinition_properties.md index f41b7a9647..10f33513d4 100644 --- a/windows.media.audio/limitereffectdefinition_properties.md +++ b/windows.media.audio/limitereffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.LimiterEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Audio.LimiterEffectDefinition.Properties ## -description Gets the properties supported by the limiter effect definition. ## -property-value The set of properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.LimiterEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.LimiterEffectDefinition.Properties + +## -description +Gets the properties supported by the limiter effect definition. + +## -property-value +The set of properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/limitereffectdefinition_release.md b/windows.media.audio/limitereffectdefinition_release.md index 286b16200f..b063c0e429 100644 --- a/windows.media.audio/limitereffectdefinition_release.md +++ b/windows.media.audio/limitereffectdefinition_release.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.LimiterEffectDefinition.Release --api-type: winrt property ---- # Windows.Media.Audio.LimiterEffectDefinition.Release ## -description Gets or sets the release included in the limiter effect definition. ## -property-value The release value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.LimiterEffectDefinition.Release +-api-type: winrt property +--- + + + +# Windows.Media.Audio.LimiterEffectDefinition.Release + +## -description +Gets or sets the release included in the limiter effect definition. + +## -property-value +The release value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition.md b/windows.media.audio/reverbeffectdefinition.md index ac607cec47..6b491b3984 100644 --- a/windows.media.audio/reverbeffectdefinition.md +++ b/windows.media.audio/reverbeffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Audio.ReverbEffectDefinition --api-type: winrt class ---- # Windows.Media.Audio.ReverbEffectDefinition ## -description Represents a reverberation effect definition supported by the audio graph. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Audio.ReverbEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition + +## -description +Represents a reverberation effect definition supported by the audio graph. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.audio/reverbeffectdefinition_activatableclassid.md b/windows.media.audio/reverbeffectdefinition_activatableclassid.md index 4af69003b4..09b62050d6 100644 --- a/windows.media.audio/reverbeffectdefinition_activatableclassid.md +++ b/windows.media.audio/reverbeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID for the reverberation effect definition object. ## -property-value The activatable class ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID for the reverberation effect definition object. + +## -property-value +The activatable class ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_decaytime.md b/windows.media.audio/reverbeffectdefinition_decaytime.md index f1ff609f2e..848c5e2ee2 100644 --- a/windows.media.audio/reverbeffectdefinition_decaytime.md +++ b/windows.media.audio/reverbeffectdefinition_decaytime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.DecayTime --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.DecayTime ## -description Gets or sets the decay time supported by the reverberation effect definition. ## -property-value The decay time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.DecayTime +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.DecayTime + +## -description +Gets or sets the decay time supported by the reverberation effect definition. + +## -property-value +The decay time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_density.md b/windows.media.audio/reverbeffectdefinition_density.md index e7d6249624..f8d64b6ac3 100644 --- a/windows.media.audio/reverbeffectdefinition_density.md +++ b/windows.media.audio/reverbeffectdefinition_density.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.Density --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.Density ## -description Gets or sets the density included in the reverberation effect definition. ## -property-value The density value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.Density +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.Density + +## -description +Gets or sets the density included in the reverberation effect definition. + +## -property-value +The density value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_disablelatefield.md b/windows.media.audio/reverbeffectdefinition_disablelatefield.md index 090cce1571..920f91629b 100644 --- a/windows.media.audio/reverbeffectdefinition_disablelatefield.md +++ b/windows.media.audio/reverbeffectdefinition_disablelatefield.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.DisableLateField --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.DisableLateField ## -description Gets or sets a value indicating if the reverberation effect disables late fields. ## -property-value True if the reverberation effect disables late fields, and false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.DisableLateField +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.DisableLateField + +## -description +Gets or sets a value indicating if the reverberation effect disables late fields. + +## -property-value +True if the reverberation effect disables late fields, and false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_earlydiffusion.md b/windows.media.audio/reverbeffectdefinition_earlydiffusion.md index 201b5de06c..a4c9a9b44f 100644 --- a/windows.media.audio/reverbeffectdefinition_earlydiffusion.md +++ b/windows.media.audio/reverbeffectdefinition_earlydiffusion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.EarlyDiffusion --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.EarlyDiffusion ## -description Gets or sets the early diffusion value for the reverberation effect definition. ## -property-value The early diffusion value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.EarlyDiffusion +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.EarlyDiffusion + +## -description +Gets or sets the early diffusion value for the reverberation effect definition. + +## -property-value +The early diffusion value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_higheqcutoff.md b/windows.media.audio/reverbeffectdefinition_higheqcutoff.md index 38790d4c33..f61cd8145b 100644 --- a/windows.media.audio/reverbeffectdefinition_higheqcutoff.md +++ b/windows.media.audio/reverbeffectdefinition_higheqcutoff.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.HighEQCutoff --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.HighEQCutoff ## -description Gets or sets the high equalization cutoff included in the reverberation effect definition. ## -property-value The high equalization cutoff value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.HighEQCutoff +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.HighEQCutoff + +## -description +Gets or sets the high equalization cutoff included in the reverberation effect definition. + +## -property-value +The high equalization cutoff value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_higheqgain.md b/windows.media.audio/reverbeffectdefinition_higheqgain.md index 94984a789c..cd152246e8 100644 --- a/windows.media.audio/reverbeffectdefinition_higheqgain.md +++ b/windows.media.audio/reverbeffectdefinition_higheqgain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.HighEQGain --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.HighEQGain ## -description Gets or sets the high equalization gain included in the reverberation effect definition. ## -property-value The high equalization gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.HighEQGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.HighEQGain + +## -description +Gets or sets the high equalization gain included in the reverberation effect definition. + +## -property-value +The high equalization gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_latediffusion.md b/windows.media.audio/reverbeffectdefinition_latediffusion.md index 04efe91c5a..4806ae7f18 100644 --- a/windows.media.audio/reverbeffectdefinition_latediffusion.md +++ b/windows.media.audio/reverbeffectdefinition_latediffusion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.LateDiffusion --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.LateDiffusion ## -description Gets or sets the late diffusion included in the reverberation effect definition. ## -property-value The late diffusion value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.LateDiffusion +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.LateDiffusion + +## -description +Gets or sets the late diffusion included in the reverberation effect definition. + +## -property-value +The late diffusion value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_loweqcutoff.md b/windows.media.audio/reverbeffectdefinition_loweqcutoff.md index 8a341fab9a..f5e085b0a8 100644 --- a/windows.media.audio/reverbeffectdefinition_loweqcutoff.md +++ b/windows.media.audio/reverbeffectdefinition_loweqcutoff.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.LowEQCutoff --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.LowEQCutoff ## -description Gets or sets the low equalization cutoff included in the reverberation effect definition. ## -property-value The low equalization cutoff value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.LowEQCutoff +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.LowEQCutoff + +## -description +Gets or sets the low equalization cutoff included in the reverberation effect definition. + +## -property-value +The low equalization cutoff value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_loweqgain.md b/windows.media.audio/reverbeffectdefinition_loweqgain.md index a691eab1ff..37b563cea4 100644 --- a/windows.media.audio/reverbeffectdefinition_loweqgain.md +++ b/windows.media.audio/reverbeffectdefinition_loweqgain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.LowEQGain --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.LowEQGain ## -description Gets or sets the low equalization gain included in the reverberation effect definition. ## -property-value The low equalization gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.LowEQGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.LowEQGain + +## -description +Gets or sets the low equalization gain included in the reverberation effect definition. + +## -property-value +The low equalization gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_positionleft.md b/windows.media.audio/reverbeffectdefinition_positionleft.md index f5ceb3aa3c..d1823b756b 100644 --- a/windows.media.audio/reverbeffectdefinition_positionleft.md +++ b/windows.media.audio/reverbeffectdefinition_positionleft.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionLeft --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.PositionLeft ## -description Gets or sets the position left included in the reverberation effect definition. ## -property-value The position left value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionLeft +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.PositionLeft + +## -description +Gets or sets the position left included in the reverberation effect definition. + +## -property-value +The position left value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_positionmatrixleft.md b/windows.media.audio/reverbeffectdefinition_positionmatrixleft.md index 6cb3914e43..0affdc7d45 100644 --- a/windows.media.audio/reverbeffectdefinition_positionmatrixleft.md +++ b/windows.media.audio/reverbeffectdefinition_positionmatrixleft.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixLeft --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixLeft ## -description Gets or sets the matrix position left included in the reverberation effect definition. ## -property-value The matrix position left value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixLeft +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixLeft + +## -description +Gets or sets the matrix position left included in the reverberation effect definition. + +## -property-value +The matrix position left value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_positionmatrixright.md b/windows.media.audio/reverbeffectdefinition_positionmatrixright.md index 57b4178e5d..e9b54c49ae 100644 --- a/windows.media.audio/reverbeffectdefinition_positionmatrixright.md +++ b/windows.media.audio/reverbeffectdefinition_positionmatrixright.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixRight --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixRight ## -description Gets or sets the matrix position right included in the reverberation effect definition. ## -property-value The matrix position right value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixRight +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.PositionMatrixRight + +## -description +Gets or sets the matrix position right included in the reverberation effect definition. + +## -property-value +The matrix position right value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_positionright.md b/windows.media.audio/reverbeffectdefinition_positionright.md index 18b7ebb9b7..1a2d9e6280 100644 --- a/windows.media.audio/reverbeffectdefinition_positionright.md +++ b/windows.media.audio/reverbeffectdefinition_positionright.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionRight --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.PositionRight ## -description Gets or sets the position right included in the reverberation effect definition. ## -property-value The position right value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.PositionRight +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.PositionRight + +## -description +Gets or sets the position right included in the reverberation effect definition. + +## -property-value +The position right value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_properties.md b/windows.media.audio/reverbeffectdefinition_properties.md index 1689d6f500..7f99efc404 100644 --- a/windows.media.audio/reverbeffectdefinition_properties.md +++ b/windows.media.audio/reverbeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.Properties ## -description Gets the properties supported by the reverberation effect definition. ## -property-value The set of properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.Properties + +## -description +Gets the properties supported by the reverberation effect definition. + +## -property-value +The set of properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_reardelay.md b/windows.media.audio/reverbeffectdefinition_reardelay.md index 553516cad9..cedda47e54 100644 --- a/windows.media.audio/reverbeffectdefinition_reardelay.md +++ b/windows.media.audio/reverbeffectdefinition_reardelay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RearDelay --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.RearDelay ## -description Gets or sets the rear delay included in the reverberation effect definition. ## -property-value The rear delay value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RearDelay +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.RearDelay + +## -description +Gets or sets the rear delay included in the reverberation effect definition. + +## -property-value +The rear delay value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_reflectionsdelay.md b/windows.media.audio/reverbeffectdefinition_reflectionsdelay.md index 0538ca8b97..e50a66aa0c 100644 --- a/windows.media.audio/reverbeffectdefinition_reflectionsdelay.md +++ b/windows.media.audio/reverbeffectdefinition_reflectionsdelay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReflectionsDelay --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.ReflectionsDelay ## -description Gets or sets the reflections delay included in the reverberation effect definition. ## -property-value The reflections delay value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReflectionsDelay +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.ReflectionsDelay + +## -description +Gets or sets the reflections delay included in the reverberation effect definition. + +## -property-value +The reflections delay value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_reflectionsgain.md b/windows.media.audio/reverbeffectdefinition_reflectionsgain.md index 5a17206756..00eeebad44 100644 --- a/windows.media.audio/reverbeffectdefinition_reflectionsgain.md +++ b/windows.media.audio/reverbeffectdefinition_reflectionsgain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReflectionsGain --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.ReflectionsGain ## -description Gets or sets the reflections gain included in the reverberation effect definition. ## -property-value The reflections gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReflectionsGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.ReflectionsGain + +## -description +Gets or sets the reflections gain included in the reverberation effect definition. + +## -property-value +The reflections gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_reverbdelay.md b/windows.media.audio/reverbeffectdefinition_reverbdelay.md index 40c4ef2669..d8e8865d87 100644 --- a/windows.media.audio/reverbeffectdefinition_reverbdelay.md +++ b/windows.media.audio/reverbeffectdefinition_reverbdelay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReverbDelay --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.ReverbDelay ## -description Gets or sets the reverberation delay included in the reverberation effect definition. ## -property-value The reverberation delay value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReverbDelay +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.ReverbDelay + +## -description +Gets or sets the reverberation delay included in the reverberation effect definition. + +## -property-value +The reverberation delay value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_reverbeffectdefinition_2086735898.md b/windows.media.audio/reverbeffectdefinition_reverbeffectdefinition_2086735898.md index 6343707d95..f2f239b894 100644 --- a/windows.media.audio/reverbeffectdefinition_reverbeffectdefinition_2086735898.md +++ b/windows.media.audio/reverbeffectdefinition_reverbeffectdefinition_2086735898.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Audio.ReverbEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) --api-type: winrt method ---- # Windows.Media.Audio.ReverbEffectDefinition.ReverbEffectDefinition ## -description Initializes a new instance of the [ReverbffectDefinition](reverbeffectdefinition.md) class. ## -parameters ### -param audioGraph The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Audio.ReverbEffectDefinition.#ctor(Windows.Media.Audio.AudioGraph) +-api-type: winrt method +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.ReverbEffectDefinition + +## -description +Initializes a new instance of the [ReverbffectDefinition](reverbeffectdefinition.md) class. + +## -parameters +### -param audioGraph +The [AudioGraph](audiograph.md) with which the effect will be used. Using effects outside of the audio graph it was created with is not supported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_reverbgain.md b/windows.media.audio/reverbeffectdefinition_reverbgain.md index 22a81b903d..594efe607e 100644 --- a/windows.media.audio/reverbeffectdefinition_reverbgain.md +++ b/windows.media.audio/reverbeffectdefinition_reverbgain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReverbGain --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.ReverbGain ## -description Gets or sets the reverberation gain included in the reverberation effect definition. ## -property-value The reverberation gain value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.ReverbGain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.ReverbGain + +## -description +Gets or sets the reverberation gain included in the reverberation effect definition. + +## -property-value +The reverberation gain value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_roomfilterfreq.md b/windows.media.audio/reverbeffectdefinition_roomfilterfreq.md index 34d0a993bc..335ffd8721 100644 --- a/windows.media.audio/reverbeffectdefinition_roomfilterfreq.md +++ b/windows.media.audio/reverbeffectdefinition_roomfilterfreq.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomFilterFreq --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.RoomFilterFreq ## -description Gets or sets the room filter frequency included in the reverberation effect definition. ## -property-value The room filter frequency value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomFilterFreq +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.RoomFilterFreq + +## -description +Gets or sets the room filter frequency included in the reverberation effect definition. + +## -property-value +The room filter frequency value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_roomfilterhf.md b/windows.media.audio/reverbeffectdefinition_roomfilterhf.md index afefc28192..b2bb5b2bdc 100644 --- a/windows.media.audio/reverbeffectdefinition_roomfilterhf.md +++ b/windows.media.audio/reverbeffectdefinition_roomfilterhf.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomFilterHF --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.RoomFilterHF ## -description Gets or sets the room filter high frequency included in the reverberation effect definition. ## -property-value The room filter high frequency value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomFilterHF +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.RoomFilterHF + +## -description +Gets or sets the room filter high frequency included in the reverberation effect definition. + +## -property-value +The room filter high frequency value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_roomfiltermain.md b/windows.media.audio/reverbeffectdefinition_roomfiltermain.md index 03e1905457..748a855fe5 100644 --- a/windows.media.audio/reverbeffectdefinition_roomfiltermain.md +++ b/windows.media.audio/reverbeffectdefinition_roomfiltermain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomFilterMain --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.RoomFilterMain ## -description Gets or sets the main room filter included in the reverberation effect definition. ## -property-value The main room filter value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomFilterMain +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.RoomFilterMain + +## -description +Gets or sets the main room filter included in the reverberation effect definition. + +## -property-value +The main room filter value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_roomsize.md b/windows.media.audio/reverbeffectdefinition_roomsize.md index 27a8b5b65a..45eb0c789e 100644 --- a/windows.media.audio/reverbeffectdefinition_roomsize.md +++ b/windows.media.audio/reverbeffectdefinition_roomsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomSize --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.RoomSize ## -description Gets or sets the room size included in the reverberation effect definition. ## -property-value A value indicating the room size. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.RoomSize +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.RoomSize + +## -description +Gets or sets the room size included in the reverberation effect definition. + +## -property-value +A value indicating the room size. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.audio/reverbeffectdefinition_wetdrymix.md b/windows.media.audio/reverbeffectdefinition_wetdrymix.md index 451ca58873..5d6fc2d45f 100644 --- a/windows.media.audio/reverbeffectdefinition_wetdrymix.md +++ b/windows.media.audio/reverbeffectdefinition_wetdrymix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Audio.ReverbEffectDefinition.WetDryMix --api-type: winrt property ---- # Windows.Media.Audio.ReverbEffectDefinition.WetDryMix ## -description Gets or sets the wet-dry audio voice mix for the reverberation effect definition. ## -property-value The wet-dry audio voice mix. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Audio.ReverbEffectDefinition.WetDryMix +-api-type: winrt property +--- + + + +# Windows.Media.Audio.ReverbEffectDefinition.WetDryMix + +## -description +Gets or sets the wet-dry audio voice mix for the reverberation effect definition. + +## -property-value +The wet-dry audio voice mix. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotocapturedeventargs.md b/windows.media.capture.core/variablephotocapturedeventargs.md index 93b26d6d95..c8e3a54d4b 100644 --- a/windows.media.capture.core/variablephotocapturedeventargs.md +++ b/windows.media.capture.core/variablephotocapturedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs ## -description Provides data for the [PhotoCaptured](variablephotosequencecapture_photocaptured.md) event. ## -remarks Handle the [VariablePhotoSequenceCapture.PhotoCaptured](variablephotosequencecapture_photocaptured.md) event to obtain an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs + +## -description +Provides data for the [PhotoCaptured](variablephotosequencecapture_photocaptured.md) event. + +## -remarks +Handle the [VariablePhotoSequenceCapture.PhotoCaptured](variablephotosequencecapture_photocaptured.md) event to obtain an instance of this class. + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotocapturedeventargs_capturedframecontrolvalues.md b/windows.media.capture.core/variablephotocapturedeventargs_capturedframecontrolvalues.md index bdeca025e4..ea18b9ced5 100644 --- a/windows.media.capture.core/variablephotocapturedeventargs_capturedframecontrolvalues.md +++ b/windows.media.capture.core/variablephotocapturedeventargs_capturedframecontrolvalues.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CapturedFrameControlValues --api-type: winrt property ---- # Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CapturedFrameControlValues ## -description Gets a [CapturedFrameControlValues](variablephotocapturedeventargs_capturedframecontrolvalues.md) object that indicates the capture settings used for the associated frame in a variable photo sequence. ## -property-value A [CapturedFrameControlValues](variablephotocapturedeventargs_capturedframecontrolvalues.md) object that indicates the capture settings used for the associated frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CapturedFrameControlValues +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CapturedFrameControlValues + +## -description +Gets a [CapturedFrameControlValues](variablephotocapturedeventargs_capturedframecontrolvalues.md) object that indicates the capture settings used for the associated frame in a variable photo sequence. + +## -property-value +A [CapturedFrameControlValues](variablephotocapturedeventargs_capturedframecontrolvalues.md) object that indicates the capture settings used for the associated frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotocapturedeventargs_capturetimeoffset.md b/windows.media.capture.core/variablephotocapturedeventargs_capturetimeoffset.md index 8cfc17e929..09ae86352a 100644 --- a/windows.media.capture.core/variablephotocapturedeventargs_capturetimeoffset.md +++ b/windows.media.capture.core/variablephotocapturedeventargs_capturetimeoffset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CaptureTimeOffset --api-type: winrt property ---- # Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CaptureTimeOffset ## -description Gets the time offset of the capture of the associated frame in a variable photo sequence. ## -property-value The time offset of the capture of the associated frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CaptureTimeOffset +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.CaptureTimeOffset + +## -description +Gets the time offset of the capture of the associated frame in a variable photo sequence. + +## -property-value +The time offset of the capture of the associated frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotocapturedeventargs_frame.md b/windows.media.capture.core/variablephotocapturedeventargs_frame.md index 20b979ab11..9f155aa817 100644 --- a/windows.media.capture.core/variablephotocapturedeventargs_frame.md +++ b/windows.media.capture.core/variablephotocapturedeventargs_frame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.Frame --api-type: winrt property ---- # Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.Frame ## -description Gets a [CapturedFrame](variablephotocapturedeventargs_capturedframecontrolvalues.md) object representing a captured frame of a variable photo sequence. ## -property-value A [CapturedFrame](variablephotocapturedeventargs_capturedframecontrolvalues.md) object representing a captured frame of a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.Frame + +## -description +Gets a [CapturedFrame](variablephotocapturedeventargs_capturedframecontrolvalues.md) object representing a captured frame of a variable photo sequence. + +## -property-value +A [CapturedFrame](variablephotocapturedeventargs_capturedframecontrolvalues.md) object representing a captured frame of a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotocapturedeventargs_usedframecontrollerindex.md b/windows.media.capture.core/variablephotocapturedeventargs_usedframecontrollerindex.md index d04f4fd9d2..5c05720fba 100644 --- a/windows.media.capture.core/variablephotocapturedeventargs_usedframecontrollerindex.md +++ b/windows.media.capture.core/variablephotocapturedeventargs_usedframecontrollerindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.UsedFrameControllerIndex --api-type: winrt property ---- # Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.UsedFrameControllerIndex ## -description Gets an index value that indicates which element of the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) vector was used to specify the requested control values for the associated frame of a variable photo sequence. ## -property-value An index value that indicates which element of the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) vector was used to specify the requested control values for the associated frame of a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.UsedFrameControllerIndex +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Core.VariablePhotoCapturedEventArgs.UsedFrameControllerIndex + +## -description +Gets an index value that indicates which element of the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) vector was used to specify the requested control values for the associated frame of a variable photo sequence. + +## -property-value +An index value that indicates which element of the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) vector was used to specify the requested control values for the associated frame of a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotosequencecapture.md b/windows.media.capture.core/variablephotosequencecapture.md index 484d54f969..7dbf09e08c 100644 --- a/windows.media.capture.core/variablephotosequencecapture.md +++ b/windows.media.capture.core/variablephotosequencecapture.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Capture.Core.VariablePhotoSequenceCapture --api-type: winrt class ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture ## -description Provides methods and events that enable the capture of variable photo sequences. ## -remarks Call the [MediaCapture.PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md) method to obtain an instance of this class. After starting a variable photo sequence capture, you must stop the variable photo sequence capture by calling [StopAsync](variablephotosequencecapture_stopasync.md) before your app attempts to record video with the [MediaCapture](../windows.media.capture/mediacapture.md) object. For how-to guidance for using **VariablePhotoSequenceCapture**, see [Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence). ## -examples ## -see-also [Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Core.VariablePhotoSequenceCapture +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture + +## -description +Provides methods and events that enable the capture of variable photo sequences. + +## -remarks +Call the [MediaCapture.PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md) method to obtain an instance of this class. + +After starting a variable photo sequence capture, you must stop the variable photo sequence capture by calling [StopAsync](variablephotosequencecapture_stopasync.md) before your app attempts to record video with the [MediaCapture](../windows.media.capture/mediacapture.md) object. + +For how-to guidance for using **VariablePhotoSequenceCapture**, see [Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence). + +## -examples + +## -see-also +[Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence) \ No newline at end of file diff --git a/windows.media.capture.core/variablephotosequencecapture_finishasync_1182664592.md b/windows.media.capture.core/variablephotosequencecapture_finishasync_1182664592.md index 98322eec17..1ba92bc461 100644 --- a/windows.media.capture.core/variablephotosequencecapture_finishasync_1182664592.md +++ b/windows.media.capture.core/variablephotosequencecapture_finishasync_1182664592.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.FinishAsync --api-type: winrt method ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture.FinishAsync ## -description Asynchronously releases the [VariablePhotoSequenceCapture](variablephotosequencecapture.md) object and resources used by the capture operation. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.FinishAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture.FinishAsync + +## -description +Asynchronously releases the [VariablePhotoSequenceCapture](variablephotosequencecapture.md) object and resources used by the capture operation. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotosequencecapture_photocaptured.md b/windows.media.capture.core/variablephotosequencecapture_photocaptured.md index aae362d179..ef4c6cd1f6 100644 --- a/windows.media.capture.core/variablephotosequencecapture_photocaptured.md +++ b/windows.media.capture.core/variablephotosequencecapture_photocaptured.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.PhotoCaptured --api-type: winrt event ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture.PhotoCaptured ## -description Occurs when a frame of a variable photo sequence is captured. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.PhotoCaptured +-api-type: winrt event +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture.PhotoCaptured + +## -description +Occurs when a frame of a variable photo sequence is captured. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotosequencecapture_startasync_1931900819.md b/windows.media.capture.core/variablephotosequencecapture_startasync_1931900819.md index a9594b6ce6..c5947b9802 100644 --- a/windows.media.capture.core/variablephotosequencecapture_startasync_1931900819.md +++ b/windows.media.capture.core/variablephotosequencecapture_startasync_1931900819.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StartAsync --api-type: winrt method ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StartAsync ## -description Starts the capturing of variable photo sequence frames. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StartAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StartAsync + +## -description +Starts the capturing of variable photo sequence frames. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotosequencecapture_stopasync_1648475005.md b/windows.media.capture.core/variablephotosequencecapture_stopasync_1648475005.md index 27cfb114c0..d2812da7f9 100644 --- a/windows.media.capture.core/variablephotosequencecapture_stopasync_1648475005.md +++ b/windows.media.capture.core/variablephotosequencecapture_stopasync_1648475005.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StopAsync --api-type: winrt method ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StopAsync ## -description Stops the capturing of variable photo sequence frames. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture.StopAsync + +## -description +Stops the capturing of variable photo sequence frames. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotosequencecapture_stopped.md b/windows.media.capture.core/variablephotosequencecapture_stopped.md index f58088ec01..64f6497bcd 100644 --- a/windows.media.capture.core/variablephotosequencecapture_stopped.md +++ b/windows.media.capture.core/variablephotosequencecapture_stopped.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.Stopped --api-type: winrt event ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture.Stopped ## -description Occurs when the [VariablePhotoSequenceCapture](variablephotosequencecapture.md) object stops capturing frames for a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.Stopped +-api-type: winrt event +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture.Stopped + +## -description +Occurs when the [VariablePhotoSequenceCapture](variablephotosequencecapture.md) object stops capturing frames for a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.core/variablephotosequencecapture_updatesettingsasync_2112945852.md b/windows.media.capture.core/variablephotosequencecapture_updatesettingsasync_2112945852.md index 1abf8d6558..e6370e46d7 100644 --- a/windows.media.capture.core/variablephotosequencecapture_updatesettingsasync_2112945852.md +++ b/windows.media.capture.core/variablephotosequencecapture_updatesettingsasync_2112945852.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.UpdateSettingsAsync --api-type: winrt method ---- # Windows.Media.Capture.Core.VariablePhotoSequenceCapture.UpdateSettingsAsync ## -description Updates the frame control values of the variable photo sequence. ## -returns An asynchronous action. ## -remarks This method allows you to efficiently perform multiple variable photo sequence captures with different sets of frame controller values. An instance of [VariablePhotoSequenceController](../windows.media.devices.core/variablephotosequencecontroller.md) is initially obtained with a call to [MediaCapture.PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md). Frame controller values for each frame are registered by appending a [FrameController](variablephotocapturedeventargs_usedframecontrollerindex.md) to the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection. After making an initial variable photo sequence capture, you can change the values of the properties of the frame controllers in the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection and then call **UpdateSettingsAsync** to have the system register the new frame controller values with the driver. This method has the following restrictions: + This method can't be called while a variable photo sequence capture is in progress. Attempting to call this method between a call to [VariablePhotoSequence.StartAsync](variablephotosequencecapture_startasync.md) and the subsequent call to [VariablePhotoSequence.StopAsync](variablephotosequencecapture_stopasync.md) will result in an invalid request error. + This method can't be called after the variable photo sequence capture has been deinitialized with a call to [VariablePhotoSequence.FinishAsync](variablephotosequencecapture_finishasync.md). Doing so will result in an invalid request error. After calling [FinishAsync](variablephotosequencecapture_finishasync.md), you must call [PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md) again before calling **UpdateSettingsAsync**. + The number of frame controllers must be the same for each variable photo sequence capture separated by calls to **UpdateSettingsAsync**. If you want to capture variable photo sequences with different numbers of frames, you must call [FinishAsync](variablephotosequencecapture_finishasync.md) and then call [PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md) again to reinitialize the photo sequence capture. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Core.VariablePhotoSequenceCapture.UpdateSettingsAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Core.VariablePhotoSequenceCapture.UpdateSettingsAsync + +## -description +Updates the frame control values of the variable photo sequence. + +## -returns +An asynchronous action. + +## -remarks +This method allows you to efficiently perform multiple variable photo sequence captures with different sets of frame controller values. An instance of [VariablePhotoSequenceController](../windows.media.devices.core/variablephotosequencecontroller.md) is initially obtained with a call to [MediaCapture.PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md). Frame controller values for each frame are registered by appending a [FrameController](variablephotocapturedeventargs_usedframecontrollerindex.md) to the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection. After making an initial variable photo sequence capture, you can change the values of the properties of the frame controllers in the [DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection and then call **UpdateSettingsAsync** to have the system register the new frame controller values with the driver. + +This method has the following restrictions: + + ++ This method can't be called while a variable photo sequence capture is in progress. Attempting to call this method between a call to [VariablePhotoSequence.StartAsync](variablephotosequencecapture_startasync.md) and the subsequent call to [VariablePhotoSequence.StopAsync](variablephotosequencecapture_stopasync.md) will result in an invalid request error. ++ This method can't be called after the variable photo sequence capture has been deinitialized with a call to [VariablePhotoSequence.FinishAsync](variablephotosequencecapture_finishasync.md). Doing so will result in an invalid request error. After calling [FinishAsync](variablephotosequencecapture_finishasync.md), you must call [PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md) again before calling **UpdateSettingsAsync**. ++ The number of frame controllers must be the same for each variable photo sequence capture separated by calls to **UpdateSettingsAsync**. If you want to capture variable photo sequences with different numbers of frames, you must call [FinishAsync](variablephotosequencecapture_finishasync.md) and then call [PrepareVariablePhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync.md) again to reinitialize the photo sequence capture. + + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/buffermediaframe.md b/windows.media.capture.frames/buffermediaframe.md index 6e49a8f706..177194fd9b 100644 --- a/windows.media.capture.frames/buffermediaframe.md +++ b/windows.media.capture.frames/buffermediaframe.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Capture.Frames.BufferMediaFrame --api-type: winrt class ---- # Windows.Media.Capture.Frames.BufferMediaFrame ## -description Represents a frame from a [MediaFrameSource](mediaframesource.md) that provides data in an [IBuffer](../windows.storage.streams/ibuffer.md). ## -remarks Get an instance of this class by accessing the [BufferMediaFrame](buffermediaframe.md) property of a [MediaFrameReference](mediaframereference.md) object that was obtained from a media frame source. A **BufferMediaFrame** represents the 1D buffer. If the underlying sample returned by the pipeline contains non-consecutive data, the system uses [IMFMediaBuffer::Lock](XREF:TODO:mf.imfmediabuffer_lock) to copy the 2D buffer into the 1D buffer. For this reason, it is recommended that you use [BufferMediaFrame](buffermediaframe.md) for arbitrary buffers, such as skeleton or body tracking data, but that you use [VideoMediaFrame](videomediaframe.md) for 2D buffers to avoid extra copy operations. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.BufferMediaFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.BufferMediaFrame + +## -description +Represents a frame from a [MediaFrameSource](mediaframesource.md) that provides data in an [IBuffer](../windows.storage.streams/ibuffer.md). + +## -remarks +Get an instance of this class by accessing the [BufferMediaFrame](buffermediaframe.md) property of a [MediaFrameReference](mediaframereference.md) object that was obtained from a media frame source. + +A **BufferMediaFrame** represents the 1D buffer. If the underlying sample returned by the pipeline contains non-consecutive data, the system uses [IMFMediaBuffer::Lock](XREF:TODO:mf.imfmediabuffer_lock) to copy the 2D buffer into the 1D buffer. For this reason, it is recommended that you use [BufferMediaFrame](buffermediaframe.md) for arbitrary buffers, such as skeleton or body tracking data, but that you use [VideoMediaFrame](videomediaframe.md) for 2D buffers to avoid extra copy operations. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/buffermediaframe_buffer.md b/windows.media.capture.frames/buffermediaframe_buffer.md index 1fb8244cac..51ff35748f 100644 --- a/windows.media.capture.frames/buffermediaframe_buffer.md +++ b/windows.media.capture.frames/buffermediaframe_buffer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.BufferMediaFrame.Buffer --api-type: winrt property ---- # Windows.Media.Capture.Frames.BufferMediaFrame.Buffer ## -description Gets the buffer that contains the data for the [BufferMediaFrame](buffermediaframe.md). ## -property-value The buffer that contains the data for the [BufferMediaFrame](buffermediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.BufferMediaFrame.Buffer +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.BufferMediaFrame.Buffer + +## -description +Gets the buffer that contains the data for the [BufferMediaFrame](buffermediaframe.md). + +## -property-value +The buffer that contains the data for the [BufferMediaFrame](buffermediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/buffermediaframe_framereference.md b/windows.media.capture.frames/buffermediaframe_framereference.md index c6b4ed83b6..ee7381d4e0 100644 --- a/windows.media.capture.frames/buffermediaframe_framereference.md +++ b/windows.media.capture.frames/buffermediaframe_framereference.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.BufferMediaFrame.FrameReference --api-type: winrt property ---- # Windows.Media.Capture.Frames.BufferMediaFrame.FrameReference ## -description Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [BufferMediaFrame](buffermediaframe.md), which provides access to format information and other properties of the media frame. ## -property-value The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [BufferMediaFrame](buffermediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.BufferMediaFrame.FrameReference +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.BufferMediaFrame.FrameReference + +## -description +Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [BufferMediaFrame](buffermediaframe.md), which provides access to format information and other properties of the media frame. + +## -property-value +The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [BufferMediaFrame](buffermediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/depthmediaframe.md b/windows.media.capture.frames/depthmediaframe.md index bb1b0f43fe..6130eb178d 100644 --- a/windows.media.capture.frames/depthmediaframe.md +++ b/windows.media.capture.frames/depthmediaframe.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.DepthMediaFrame --api-type: winrt class ---- # Windows.Media.Capture.Frames.DepthMediaFrame ## -description Represents a [VideoMediaFrame](videomediaframe.md) that contains depth video data. ## -remarks Get an instance of this class by accessing the [DepthMediaFrame](depthmediaframe.md) property of the [VideoMediaFrame](videomediaframe.md) class. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.DepthMediaFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame + +## -description +Represents a [VideoMediaFrame](videomediaframe.md) that contains depth video data. + +## -remarks +Get an instance of this class by accessing the [DepthMediaFrame](depthmediaframe.md) property of the [VideoMediaFrame](videomediaframe.md) class. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/depthmediaframe_depthformat.md b/windows.media.capture.frames/depthmediaframe_depthformat.md index dd21895b6e..b16cb3f605 100644 --- a/windows.media.capture.frames/depthmediaframe_depthformat.md +++ b/windows.media.capture.frames/depthmediaframe_depthformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.DepthFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.DepthMediaFrame.DepthFormat ## -description Gets an object that describes the format of the depth data in the [DepthMediaFrame](depthmediaframe.md). ## -property-value An object that describes the format of the depth data in the [DepthMediaFrame](depthmediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.DepthFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame.DepthFormat + +## -description +Gets an object that describes the format of the depth data in the [DepthMediaFrame](depthmediaframe.md). + +## -property-value +An object that describes the format of the depth data in the [DepthMediaFrame](depthmediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/depthmediaframe_framereference.md b/windows.media.capture.frames/depthmediaframe_framereference.md index 4e3fc3fa3c..57e5c52353 100644 --- a/windows.media.capture.frames/depthmediaframe_framereference.md +++ b/windows.media.capture.frames/depthmediaframe_framereference.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.FrameReference --api-type: winrt property ---- # Windows.Media.Capture.Frames.DepthMediaFrame.FrameReference ## -description Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [DepthMediaFrame](depthmediaframe.md), which provides access to format information and other properties of the media frame. ## -property-value The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [DepthMediaFrame](depthmediaframe.md) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.FrameReference +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame.FrameReference + +## -description +Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [DepthMediaFrame](depthmediaframe.md), which provides access to format information and other properties of the media frame. + +## -property-value +The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [DepthMediaFrame](depthmediaframe.md) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper_1923171226.md b/windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper_1923171226.md index 9340b9ae25..da75d58a6d 100644 --- a/windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper_1923171226.md +++ b/windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper_1923171226.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Capture.Frames.DepthMediaFrame.TryCreateCoordinateMapper(Windows.Media.Devices.Core.CameraIntrinsics,Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- # Windows.Media.Capture.Frames.DepthMediaFrame.TryCreateCoordinateMapper ## -description Attempts to create a [DepthCorrelatedCoordinateMapper](../windows.media.devices.core/depthcorrelatedcoordinatemapper.md) for the [DepthMediaFrame](depthmediaframe.md). This object provides methods for mapping pixel coordinates from a [MediaFrameSource](mediaframesource.md) camera to the coordinate system of a different **MediaFrameSource** or to 3D space. ## -parameters ### -param cameraIntrinsics An object that describes the distortion model of the **MediaFrameSource** camera for which coordinates will be mapped using the [DepthMediaFrame](depthmediaframe.md) data. ### -param coordinateSystem An object representing the spatial coordinate system of the camera for which coordinates will be mapped using the [DepthMediaFrame](depthmediaframe.md) data. ## -returns A [DepthCorrelatedCoordinateMapper](../windows.media.devices.core/depthcorrelatedcoordinatemapper.md) if the operation was successful; otherwise, null. ## -remarks The [DepthCorrelatedCoordinateMapper](../windows.media.devices.core/depthcorrelatedcoordinatemapper.md) returned by this method will use depth data from the [DepthMediaFrame](depthmediaframe.md) to map coordinates from one media frame or [MediaFrameSource](mediaframesource.md) to the coordinate system of another media frame or **MediaFrameSource**. The parameters to this method specify the camera intrinsics and coordinate system of the original coordinates to be mapped. Get static camera intrinsics for a **MediaFrameSource** by calling [TryGetCameraIntrinsics](mediaframesource_trygetcameraintrinsics.md). Get the static coordinate system for a **MediaFrameSource** by accessing the [CoordinateSystem](mediaframesourceinfo_coordinatesystem.md) property of the [MediaFrameSourceInfo](mediaframesourceinfo.md) associated with the frame source. Get dynamic camera instrinsics by accessing [CameraIntrinsics](videomediaframe_cameraintrinsics.md) property of a [VideoMediaFrame](videomediaframe.md). Get the dynamic coordinate system from a [MediaFrameReference](mediaframereference.md) with the [CoordinateSystem](mediaframereference_coordinatesystem.md) property. You specify the camera intrinsics and coordinate system of the target frame or frame source, to which the source points will be mapped, when you call the mapping methods of the **DepthCorrelatedCoordinateMapper**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.DepthMediaFrame.TryCreateCoordinateMapper(Windows.Media.Devices.Core.CameraIntrinsics,Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame.TryCreateCoordinateMapper + +## -description +Attempts to create a [DepthCorrelatedCoordinateMapper](../windows.media.devices.core/depthcorrelatedcoordinatemapper.md) for the [DepthMediaFrame](depthmediaframe.md). This object provides methods for mapping pixel coordinates from a [MediaFrameSource](mediaframesource.md) camera to the coordinate system of a different **MediaFrameSource** or to 3D space. + +## -parameters +### -param cameraIntrinsics +An object that describes the distortion model of the **MediaFrameSource** camera for which coordinates will be mapped using the [DepthMediaFrame](depthmediaframe.md) data. + +### -param coordinateSystem +An object representing the spatial coordinate system of the camera for which coordinates will be mapped using the [DepthMediaFrame](depthmediaframe.md) data. + +## -returns +A [DepthCorrelatedCoordinateMapper](../windows.media.devices.core/depthcorrelatedcoordinatemapper.md) if the operation was successful; otherwise, null. + +## -remarks +The [DepthCorrelatedCoordinateMapper](../windows.media.devices.core/depthcorrelatedcoordinatemapper.md) returned by this method will use depth data from the [DepthMediaFrame](depthmediaframe.md) to map coordinates from one media frame or [MediaFrameSource](mediaframesource.md) to the coordinate system of another media frame or **MediaFrameSource**. The parameters to this method specify the camera intrinsics and coordinate system of the original coordinates to be mapped. + +Get static camera intrinsics for a **MediaFrameSource** by calling [TryGetCameraIntrinsics](mediaframesource_trygetcameraintrinsics.md). Get the static coordinate system for a **MediaFrameSource** by accessing the [CoordinateSystem](mediaframesourceinfo_coordinatesystem.md) property of the [MediaFrameSourceInfo](mediaframesourceinfo.md) associated with the frame source. Get dynamic camera instrinsics by accessing [CameraIntrinsics](videomediaframe_cameraintrinsics.md) property of a [VideoMediaFrame](videomediaframe.md). Get the dynamic coordinate system from a [MediaFrameReference](mediaframereference.md) with the [CoordinateSystem](mediaframereference_coordinatesystem.md) property. + +You specify the camera intrinsics and coordinate system of the target frame or frame source, to which the source points will be mapped, when you call the mapping methods of the **DepthCorrelatedCoordinateMapper**. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/depthmediaframe_videomediaframe.md b/windows.media.capture.frames/depthmediaframe_videomediaframe.md index 4bdf3ba1f3..6b62084160 100644 --- a/windows.media.capture.frames/depthmediaframe_videomediaframe.md +++ b/windows.media.capture.frames/depthmediaframe_videomediaframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.VideoMediaFrame --api-type: winrt property ---- # Windows.Media.Capture.Frames.DepthMediaFrame.VideoMediaFrame ## -description Gets the [VideoMediaFrame](videomediaframe.md) associated with the [DepthMediaFrame](depthmediaframe.md). ## -property-value The [VideoMediaFrame](videomediaframe.md) associated with the [DepthMediaFrame](depthmediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.VideoMediaFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame.VideoMediaFrame + +## -description +Gets the [VideoMediaFrame](videomediaframe.md) associated with the [DepthMediaFrame](depthmediaframe.md). + +## -property-value +The [VideoMediaFrame](videomediaframe.md) associated with the [DepthMediaFrame](depthmediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/depthmediaframeformat.md b/windows.media.capture.frames/depthmediaframeformat.md index 710eb781e8..331187f2c6 100644 --- a/windows.media.capture.frames/depthmediaframeformat.md +++ b/windows.media.capture.frames/depthmediaframeformat.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.DepthMediaFrameFormat --api-type: winrt class ---- # Windows.Media.Capture.Frames.DepthMediaFrameFormat ## -description Describes the format of a [DepthMediaFrame](depthmediaframe.md). ## -remarks Get an instance of this class by accessing the [DepthFormat](depthmediaframe_depthformat.md) property of a [DepthMediaFrame](depthmediaframe.md) object. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.DepthMediaFrameFormat +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrameFormat + +## -description +Describes the format of a [DepthMediaFrame](depthmediaframe.md). + +## -remarks +Get an instance of this class by accessing the [DepthFormat](depthmediaframe_depthformat.md) property of a [DepthMediaFrame](depthmediaframe.md) object. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/depthmediaframeformat_depthscaleinmeters.md b/windows.media.capture.frames/depthmediaframeformat_depthscaleinmeters.md index 225d06266f..b6ad66a719 100644 --- a/windows.media.capture.frames/depthmediaframeformat_depthscaleinmeters.md +++ b/windows.media.capture.frames/depthmediaframeformat_depthscaleinmeters.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.DepthMediaFrameFormat.DepthScaleInMeters --api-type: winrt property ---- # Windows.Media.Capture.Frames.DepthMediaFrameFormat.DepthScaleInMeters ## -description Gets the scale of the depth values in a [DepthMediaFrame](depthmediaframe.md), in meters. ## -property-value The scale of the depth values in a [DepthMediaFrame](depthmediaframe.md), in meters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrameFormat.DepthScaleInMeters +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrameFormat.DepthScaleInMeters + +## -description +Gets the scale of the depth values in a [DepthMediaFrame](depthmediaframe.md), in meters. + +## -property-value +The scale of the depth values in a [DepthMediaFrame](depthmediaframe.md), in meters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/depthmediaframeformat_videoformat.md b/windows.media.capture.frames/depthmediaframeformat_videoformat.md index 8bef018e47..3f0a03870e 100644 --- a/windows.media.capture.frames/depthmediaframeformat_videoformat.md +++ b/windows.media.capture.frames/depthmediaframeformat_videoformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.DepthMediaFrameFormat.VideoFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.DepthMediaFrameFormat.VideoFormat ## -description Gets the [VideoMediaFrameFormat](videomediaframeformat.md) object that describes the non-depth-specific format of a [DepthMediaFrame](depthmediaframe.md). ## -property-value The [VideoMediaFrameFormat](videomediaframeformat.md) object that describes the non-depth-specific format of a [DepthMediaFrame](depthmediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrameFormat.VideoFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrameFormat.VideoFormat + +## -description +Gets the [VideoMediaFrameFormat](videomediaframeformat.md) object that describes the non-depth-specific format of a [DepthMediaFrame](depthmediaframe.md). + +## -property-value +The [VideoMediaFrameFormat](videomediaframeformat.md) object that describes the non-depth-specific format of a [DepthMediaFrame](depthmediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/infraredmediaframe.md b/windows.media.capture.frames/infraredmediaframe.md index 5da59a03f8..024bc78bda 100644 --- a/windows.media.capture.frames/infraredmediaframe.md +++ b/windows.media.capture.frames/infraredmediaframe.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.InfraredMediaFrame --api-type: winrt class ---- # Windows.Media.Capture.Frames.InfraredMediaFrame ## -description Represents a [VideoMediaFrame](videomediaframe.md) that contains infrared video data. ## -remarks Get an instance of this class by accessing the [InfraredMediaFrame](infraredmediaframe.md) property of the [VideoMediaFrame](videomediaframe.md) class. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.InfraredMediaFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.InfraredMediaFrame + +## -description +Represents a [VideoMediaFrame](videomediaframe.md) that contains infrared video data. + +## -remarks +Get an instance of this class by accessing the [InfraredMediaFrame](infraredmediaframe.md) property of the [VideoMediaFrame](videomediaframe.md) class. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/infraredmediaframe_framereference.md b/windows.media.capture.frames/infraredmediaframe_framereference.md index 1d9dfe3ed0..6290548f08 100644 --- a/windows.media.capture.frames/infraredmediaframe_framereference.md +++ b/windows.media.capture.frames/infraredmediaframe_framereference.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.InfraredMediaFrame.FrameReference --api-type: winrt property ---- # Windows.Media.Capture.Frames.InfraredMediaFrame.FrameReference ## -description Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [InfraredMediaFrame](infraredmediaframe.md), which provides access to format information and other properties of the media frame. ## -property-value The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [InfraredMediaFrame](infraredmediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.InfraredMediaFrame.FrameReference +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.InfraredMediaFrame.FrameReference + +## -description +Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [InfraredMediaFrame](infraredmediaframe.md), which provides access to format information and other properties of the media frame. + +## -property-value +The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [InfraredMediaFrame](infraredmediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/infraredmediaframe_isilluminated.md b/windows.media.capture.frames/infraredmediaframe_isilluminated.md index 56f650f21f..faa5b6e389 100644 --- a/windows.media.capture.frames/infraredmediaframe_isilluminated.md +++ b/windows.media.capture.frames/infraredmediaframe_isilluminated.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.InfraredMediaFrame.IsIlluminated --api-type: winrt property ---- # Windows.Media.Capture.Frames.InfraredMediaFrame.IsIlluminated ## -description Gets a value specifying whether the infrared media frame is illuminated. ## -property-value True if the infrared media frame is illuminated; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.InfraredMediaFrame.IsIlluminated +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.InfraredMediaFrame.IsIlluminated + +## -description +Gets a value specifying whether the infrared media frame is illuminated. + +## -property-value +True if the infrared media frame is illuminated; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/infraredmediaframe_videomediaframe.md b/windows.media.capture.frames/infraredmediaframe_videomediaframe.md index 24447d332b..5e5a30afcc 100644 --- a/windows.media.capture.frames/infraredmediaframe_videomediaframe.md +++ b/windows.media.capture.frames/infraredmediaframe_videomediaframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.InfraredMediaFrame.VideoMediaFrame --api-type: winrt property ---- # Windows.Media.Capture.Frames.InfraredMediaFrame.VideoMediaFrame ## -description Gets the [VideoMediaFrame](videomediaframe.md) associated with the [InfraredMediaFrame](infraredmediaframe.md). ## -property-value The [VideoMediaFrame](videomediaframe.md) associated with the [InfraredMediaFrame](infraredmediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.InfraredMediaFrame.VideoMediaFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.InfraredMediaFrame.VideoMediaFrame + +## -description +Gets the [VideoMediaFrame](videomediaframe.md) associated with the [InfraredMediaFrame](infraredmediaframe.md). + +## -property-value +The [VideoMediaFrame](videomediaframe.md) associated with the [InfraredMediaFrame](infraredmediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframearrivedeventargs.md b/windows.media.capture.frames/mediaframearrivedeventargs.md index 95347114a2..a70dccdba9 100644 --- a/windows.media.capture.frames/mediaframearrivedeventargs.md +++ b/windows.media.capture.frames/mediaframearrivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs ## -description Provides data for the [MediaFrameReader.FrameArrived](mediaframereader_framearrived.md) event. ## -remarks Get an instance of this class by handling the [MediaFrameReader.FrameArrived](mediaframereader_framearrived.md) event. In the event handler, cast the sender as a [MediaFrameReader](mediaframereader.md) and call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the frame source, if one is available. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs + +## -description +Provides data for the [MediaFrameReader.FrameArrived](mediaframereader_framearrived.md) event. + +## -remarks +Get an instance of this class by handling the [MediaFrameReader.FrameArrived](mediaframereader_framearrived.md) event. In the event handler, cast the sender as a [MediaFrameReader](mediaframereader.md) and call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the frame source, if one is available. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframeformat.md b/windows.media.capture.frames/mediaframeformat.md index 39a7bb2e4f..5eabf0da59 100644 --- a/windows.media.capture.frames/mediaframeformat.md +++ b/windows.media.capture.frames/mediaframeformat.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameFormat --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameFormat ## -description Describes the format of a media frame obtained from a [MediaFrameSource](mediaframesource.md) and represented by a [MediaFrameReference](mediaframereference.md). ## -remarks The [MediaFrameSource](mediaframesource.md) class uses this object to specify the current format of the media frames it generates. Get the current format of a media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. Set the current format of a media frame source by calling [SetFormatAsync](mediaframesource_setformatasync.md). Get the format of a media frame represented by a [MediaFrameReference](mediaframereference.md) by accessing the [Format](mediaframereference_format.md) property. Get the format of a video frame represented by a [VideoMediaFrame](videomediaframe.md) by accessing the [VideoFormat](depthmediaframeformat_videoformat.md) property and then using the returned object's [MediaFrameFormat](mediaframeformat.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameFormat +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameFormat + +## -description +Describes the format of a media frame obtained from a [MediaFrameSource](mediaframesource.md) and represented by a [MediaFrameReference](mediaframereference.md). + +## -remarks +The [MediaFrameSource](mediaframesource.md) class uses this object to specify the current format of the media frames it generates. Get the current format of a media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. Set the current format of a media frame source by calling [SetFormatAsync](mediaframesource_setformatasync.md). + +Get the format of a media frame represented by a [MediaFrameReference](mediaframereference.md) by accessing the [Format](mediaframereference_format.md) property. + +Get the format of a video frame represented by a [VideoMediaFrame](videomediaframe.md) by accessing the [VideoFormat](depthmediaframeformat_videoformat.md) property and then using the returned object's [MediaFrameFormat](mediaframeformat.md) property. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframeformat_framerate.md b/windows.media.capture.frames/mediaframeformat_framerate.md index fd086cf6a1..c0e44cae5a 100644 --- a/windows.media.capture.frames/mediaframeformat_framerate.md +++ b/windows.media.capture.frames/mediaframeformat_framerate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.FrameRate --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameFormat.FrameRate ## -description Gets the frame rate of the media frame. ## -property-value The frame rate, in frames per second. ## -remarks The frame rate is expressed as a ratio. For example, if the frame rate is 30 frames per second (fps), the ratio is 30/1. If the frame rate is 29.97 fps, the ratio is 30,000/1001. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.FrameRate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameFormat.FrameRate + +## -description +Gets the frame rate of the media frame. + +## -property-value +The frame rate, in frames per second. + +## -remarks +The frame rate is expressed as a ratio. For example, if the frame rate is 30 frames per second (fps), the ratio is 30/1. If the frame rate is 29.97 fps, the ratio is 30,000/1001. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframeformat_majortype.md b/windows.media.capture.frames/mediaframeformat_majortype.md index 4aa562ebf1..abc2444e8f 100644 --- a/windows.media.capture.frames/mediaframeformat_majortype.md +++ b/windows.media.capture.frames/mediaframeformat_majortype.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.MajorType --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameFormat.MajorType ## -description Gets a string identifying the major type of a media frame. ## -property-value A string identifying the major type of a media frame. ## -remarks The value of this property is one of the following strings:
"audio"The frame contains audio data.
"video"The frame contains video data, which may represent color, depth, infrared, or other content.
"perception"The frame contains perception data such as skeletal or facial data.
## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.MajorType +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameFormat.MajorType + +## -description +Gets a string identifying the major type of a media frame. + +## -property-value +A string identifying the major type of a media frame. + +## -remarks +The value of this property is one of the following strings: + + + +
"audio"The frame contains audio data.
"video"The frame contains video data, which may represent color, depth, infrared, or other content.
"perception"The frame contains perception data such as skeletal or facial data.
+ +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframeformat_properties.md b/windows.media.capture.frames/mediaframeformat_properties.md index ede0b2922d..13b85a7c66 100644 --- a/windows.media.capture.frames/mediaframeformat_properties.md +++ b/windows.media.capture.frames/mediaframeformat_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.Properties --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameFormat.Properties ## -description Gets a map of properties for the frame format. ## -property-value A map of properties for the frame format. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameFormat.Properties + +## -description +Gets a map of properties for the frame format. + +## -property-value +A map of properties for the frame format. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframeformat_subtype.md b/windows.media.capture.frames/mediaframeformat_subtype.md index a0293012cb..fbf074d501 100644 --- a/windows.media.capture.frames/mediaframeformat_subtype.md +++ b/windows.media.capture.frames/mediaframeformat_subtype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.Subtype --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameFormat.Subtype ## -description Gets a string identifying the subtype of a media frame. ## -property-value A string identifying the subtype of a media frame. ## -remarks The value of this property is one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.Subtype +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameFormat.Subtype + +## -description +Gets a string identifying the subtype of a media frame. + +## -property-value +A string identifying the subtype of a media frame. + +## -remarks +The value of this property is one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframeformat_videoformat.md b/windows.media.capture.frames/mediaframeformat_videoformat.md index 012f081fad..1c59c38298 100644 --- a/windows.media.capture.frames/mediaframeformat_videoformat.md +++ b/windows.media.capture.frames/mediaframeformat_videoformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.VideoFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameFormat.VideoFormat ## -description Gets an object describing the image format of a video media frame. ## -property-value An object describing the image format of a video media frame. ## -remarks If a media frame does not contain video data, such as a [BufferMediaFrame](buffermediaframe.md), this property is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameFormat.VideoFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameFormat.VideoFormat + +## -description +Gets an object describing the image format of a video media frame. + +## -property-value +An object describing the image format of a video media frame. + +## -remarks +If a media frame does not contain video data, such as a [BufferMediaFrame](buffermediaframe.md), this property is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereader.md b/windows.media.capture.frames/mediaframereader.md index 11830624fc..179172ffb0 100644 --- a/windows.media.capture.frames/mediaframereader.md +++ b/windows.media.capture.frames/mediaframereader.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameReader --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameReader ## -description Provides access to frames from a [MediaFrameSource](mediaframesource.md) and notification when a new frame arrives. ## -remarks Get an instance of this class by calling [CreateFrameReaderAsync](../windows.media.capture/mediacapture_createframereaderasync.md) on a [MediaCapture](http://msdn.microsoft.com/library/1361e82a-202f-40f7-9239-56f00dfca54b) object that has been initialized to use the desired media frame source. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameReader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader + +## -description +Provides access to frames from a [MediaFrameSource](mediaframesource.md) and notification when a new frame arrives. + +## -remarks +Get an instance of this class by calling [CreateFrameReaderAsync](../windows.media.capture/mediacapture_createframereaderasync.md) on a [MediaCapture](http://msdn.microsoft.com/library/1361e82a-202f-40f7-9239-56f00dfca54b) object that has been initialized to use the desired media frame source. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframereader_close_811482585.md b/windows.media.capture.frames/mediaframereader_close_811482585.md index 60c9966496..753e8f1571 100644 --- a/windows.media.capture.frames/mediaframereader_close_811482585.md +++ b/windows.media.capture.frames/mediaframereader_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.Close --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameReader.Close ## -description Disposes of the object and associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReader](mediaframereader.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.Close + +## -description +Disposes of the object and associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReader](mediaframereader.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereader_framearrived.md b/windows.media.capture.frames/mediaframereader_framearrived.md index 6097cc2b39..3622cf7368 100644 --- a/windows.media.capture.frames/mediaframereader_framearrived.md +++ b/windows.media.capture.frames/mediaframereader_framearrived.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived --api-type: winrt event ---- # Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived ## -description Occurs when a new frame arrives from the media frame source associated with the [MediaFrameReader](mediaframereader.md). ## -remarks In the handler for the **FrameArrived** event, call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived + +## -description +Occurs when a new frame arrives from the media frame source associated with the [MediaFrameReader](mediaframereader.md). + +## -remarks +In the handler for the **FrameArrived** event, call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereader_startasync_1931900819.md b/windows.media.capture.frames/mediaframereader_startasync_1931900819.md index a602967660..0c8435c9a5 100644 --- a/windows.media.capture.frames/mediaframereader_startasync_1931900819.md +++ b/windows.media.capture.frames/mediaframereader_startasync_1931900819.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.StartAsync --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameReader.StartAsync ## -description Asynchronously starts the reading of frames from a [MediaFrameSource](mediaframesource.md). ## -returns An asynchronous operation that returns a [MediaFrameReaderStartStatus](mediaframereaderstartstatus.md) on completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.StartAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.StartAsync + +## -description +Asynchronously starts the reading of frames from a [MediaFrameSource](mediaframesource.md). + +## -returns +An asynchronous operation that returns a [MediaFrameReaderStartStatus](mediaframereaderstartstatus.md) on completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereader_stopasync_1648475005.md b/windows.media.capture.frames/mediaframereader_stopasync_1648475005.md index ca33c35268..3e3a6e0a25 100644 --- a/windows.media.capture.frames/mediaframereader_stopasync_1648475005.md +++ b/windows.media.capture.frames/mediaframereader_stopasync_1648475005.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.StopAsync --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameReader.StopAsync ## -description Asynchronously stops the reading of frames from a [MediaFrameSource](mediaframesource.md). ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.StopAsync + +## -description +Asynchronously stops the reading of frames from a [MediaFrameSource](mediaframesource.md). + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereader_tryacquirelatestframe_612769713.md b/windows.media.capture.frames/mediaframereader_tryacquirelatestframe_612769713.md index 548d42d2b1..7badaa9ac0 100644 --- a/windows.media.capture.frames/mediaframereader_tryacquirelatestframe_612769713.md +++ b/windows.media.capture.frames/mediaframereader_tryacquirelatestframe_612769713.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.TryAcquireLatestFrame --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameReader.TryAcquireLatestFrame ## -description Attempts to obtain a [MediaFrameReference](mediaframereference.md) object representing the latest frame from the [MediaFrameSource](mediaframesource.md). ## -returns A [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. ## -remarks Each [MediaFrameReader](mediaframereader.md) maintains a circular buffer of [MediaFrameReference](mediaframereference.md) objects obtained from **TryAcquireLatestFrame**. After all of the **MediaFrameReference** objects in the buffer have been used, subsequent calls to **TryAcquireLatestFrame** will cause the system to call [Close](mediaframereference_close.md) (or **Dispose** in C#) on the oldest buffer object in order to reuse it. Once the object has been disposed, you can no longer use it to access the frame data. For this reason, you should not store the **MediaFrameReference** object longer than you actually need to process the frame. If your app scenario requires you to keep a reference to the data for longer, you should use one of the APIs provided to get the underlying data. These methods include: + [BufferMediaFrame.Buffer](buffermediaframe_buffer.md) + [VideoMediaFrame.SoftwareBitmap](videomediaframe_softwarebitmap.md) + [VideoMediaFrame.GetVideoFrame](videomediaframe_getvideoframe.md) + [VideoMediaFrame.CameraIntrinsics](videomediaframe_cameraintrinsics.md) It is the responsibility of the app to call [Close](mediaframereference_close.md) (or **Dispose**) on the objects returned by these APIs when they are no longer being used. > [!IMPORTANT] > If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameReader.TryAcquireLatestFrame +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.TryAcquireLatestFrame + +## -description +Attempts to obtain a [MediaFrameReference](mediaframereference.md) object representing the latest frame from the [MediaFrameSource](mediaframesource.md). + +## -returns +A [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. + +## -remarks +Each [MediaFrameReader](mediaframereader.md) maintains a circular buffer of [MediaFrameReference](mediaframereference.md) objects obtained from **TryAcquireLatestFrame**. After all of the **MediaFrameReference** objects in the buffer have been used, subsequent calls to **TryAcquireLatestFrame** will cause the system to call [Close](mediaframereference_close.md) (or **Dispose** in C#) on the oldest buffer object in order to reuse it. Once the object has been disposed, you can no longer use it to access the frame data. For this reason, you should not store the **MediaFrameReference** object longer than you actually need to process the frame. If your app scenario requires you to keep a reference to the data for longer, you should use one of the APIs provided to get the underlying data. These methods include: + + ++ [BufferMediaFrame.Buffer](buffermediaframe_buffer.md) ++ [VideoMediaFrame.SoftwareBitmap](videomediaframe_softwarebitmap.md) ++ [VideoMediaFrame.GetVideoFrame](videomediaframe_getvideoframe.md) ++ [VideoMediaFrame.CameraIntrinsics](videomediaframe_cameraintrinsics.md) +It is the responsibility of the app to call [Close](mediaframereference_close.md) (or **Dispose**) on the objects returned by these APIs when they are no longer being used. + +> [!IMPORTANT] +> If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference.md b/windows.media.capture.frames/mediaframereference.md index 0c4b09c610..29fe184db1 100644 --- a/windows.media.capture.frames/mediaframereference.md +++ b/windows.media.capture.frames/mediaframereference.md @@ -1,3 +1,35 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameReference --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameReference ## -description A wrapper class that represents a frame obtained from a [MediaFrameSource](mediaframesource.md). Use the properties of this class to access the specific frame type provided by the source, such as a [VideoMediaFrame](videomediaframe.md) or [BufferMediaFrame](buffermediaframe.md). ## -remarks To get an instance of [MediaFrameReference](mediaframereference.md) from a media frame source, create a [MediaFrameReader](mediaframereader.md) by calling [CreateFrameReaderAsync](../windows.media.capture/mediacapture_createframereaderasync.md) on a [MediaCapture](http://msdn.microsoft.com/library/1361e82a-202f-40f7-9239-56f00dfca54b) object that has been initialized to use the desired media frame source. After the frame reader has been started by calling [StartAsync](mediaframereader_startasync.md), call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. Each [MediaFrameReader](mediaframereader.md) maintains a circular buffer of **MediaFrameReference** objects obtained from [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md). After all of the **MediaFrameReference** objects in the buffer have been used, subsequent calls to **TryAcquireLatestFrame** will cause the system to call [Close](mediaframereference_close.md) (or **Dispose** in C#) on the oldest buffer object in order to reuse it. Once the object has been disposed, you can no longer use it to access the frame data. For this reason, you should not store the **MediaFrameReference** object longer than you actually need to process the frame. If your app scenario requires you to keep a reference to the data for longer, you should use one of the APIs provided to get the underlying data. These methods include: + [BufferMediaFrame.Buffer](buffermediaframe_buffer.md) + [VideoMediaFrame.SoftwareBitmap](videomediaframe_softwarebitmap.md) + [VideoMediaFrame.GetVideoFrame](videomediaframe_getvideoframe.md) + [VideoMediaFrame.CameraIntrinsics](videomediaframe_cameraintrinsics.md) It is the responsibility of the app to call [Close](mediaframereference_close.md) (or **Dispose**) on the objects returned by these APIs when they are no longer being used. > [!IMPORTANT] > If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameReference +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference + +## -description +A wrapper class that represents a frame obtained from a [MediaFrameSource](mediaframesource.md). Use the properties of this class to access the specific frame type provided by the source, such as a [VideoMediaFrame](videomediaframe.md) or [BufferMediaFrame](buffermediaframe.md). + +## -remarks +To get an instance of [MediaFrameReference](mediaframereference.md) from a media frame source, create a [MediaFrameReader](mediaframereader.md) by calling [CreateFrameReaderAsync](../windows.media.capture/mediacapture_createframereaderasync.md) on a [MediaCapture](http://msdn.microsoft.com/library/1361e82a-202f-40f7-9239-56f00dfca54b) object that has been initialized to use the desired media frame source. After the frame reader has been started by calling [StartAsync](mediaframereader_startasync.md), call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. + +Each [MediaFrameReader](mediaframereader.md) maintains a circular buffer of **MediaFrameReference** objects obtained from [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md). After all of the **MediaFrameReference** objects in the buffer have been used, subsequent calls to **TryAcquireLatestFrame** will cause the system to call [Close](mediaframereference_close.md) (or **Dispose** in C#) on the oldest buffer object in order to reuse it. Once the object has been disposed, you can no longer use it to access the frame data. For this reason, you should not store the **MediaFrameReference** object longer than you actually need to process the frame. If your app scenario requires you to keep a reference to the data for longer, you should use one of the APIs provided to get the underlying data. These methods include: + + ++ [BufferMediaFrame.Buffer](buffermediaframe_buffer.md) ++ [VideoMediaFrame.SoftwareBitmap](videomediaframe_softwarebitmap.md) ++ [VideoMediaFrame.GetVideoFrame](videomediaframe_getvideoframe.md) ++ [VideoMediaFrame.CameraIntrinsics](videomediaframe_cameraintrinsics.md) +It is the responsibility of the app to call [Close](mediaframereference_close.md) (or **Dispose**) on the objects returned by these APIs when they are no longer being used. + +> [!IMPORTANT] +> If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframereference_buffermediaframe.md b/windows.media.capture.frames/mediaframereference_buffermediaframe.md index 632dac7013..e200f9b4db 100644 --- a/windows.media.capture.frames/mediaframereference_buffermediaframe.md +++ b/windows.media.capture.frames/mediaframereference_buffermediaframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.BufferMediaFrame --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.BufferMediaFrame ## -description Gets the [BufferMediaFrame](buffermediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md), if that is the type of frame represented. ## -property-value The [BufferMediaFrame](buffermediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md). ## -remarks If the frame reference wraps a different type of frame, such as a [VideoMediaFrame](videomediaframe.md), the object returned by this property is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.BufferMediaFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.BufferMediaFrame + +## -description +Gets the [BufferMediaFrame](buffermediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md), if that is the type of frame represented. + +## -property-value +The [BufferMediaFrame](buffermediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md). + +## -remarks +If the frame reference wraps a different type of frame, such as a [VideoMediaFrame](videomediaframe.md), the object returned by this property is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_close_811482585.md b/windows.media.capture.frames/mediaframereference_close_811482585.md index 2ffee0590f..91ed503008 100644 --- a/windows.media.capture.frames/mediaframereference_close_811482585.md +++ b/windows.media.capture.frames/mediaframereference_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameReference.Close --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameReference.Close ## -description Disposes of the object and associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReference](mediaframereference.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameReference.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.Close + +## -description +Disposes of the object and associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReference](mediaframereference.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_coordinatesystem.md b/windows.media.capture.frames/mediaframereference_coordinatesystem.md index f618e5d9c7..1c97ad3df8 100644 --- a/windows.media.capture.frames/mediaframereference_coordinatesystem.md +++ b/windows.media.capture.frames/mediaframereference_coordinatesystem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.CoordinateSystem --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.CoordinateSystem ## -description Gets the spatial coordinate system for the referenced media frame, if one is defined. ## -property-value The spatial coordinate system for the referenced media frame. ## -remarks If no spatial coordinate system is defined for the referenced media frame, the returned [SpatialCoordinateSystem](../windows.perception.spatial/spatialcoordinatesystem.md) object is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.CoordinateSystem +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.CoordinateSystem + +## -description +Gets the spatial coordinate system for the referenced media frame, if one is defined. + +## -property-value +The spatial coordinate system for the referenced media frame. + +## -remarks +If no spatial coordinate system is defined for the referenced media frame, the returned [SpatialCoordinateSystem](../windows.perception.spatial/spatialcoordinatesystem.md) object is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_duration.md b/windows.media.capture.frames/mediaframereference_duration.md index 320437654b..e6570e860c 100644 --- a/windows.media.capture.frames/mediaframereference_duration.md +++ b/windows.media.capture.frames/mediaframereference_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.Duration --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.Duration ## -description Gets the duration of the referenced media frame. ## -property-value The duration of the referenced media frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.Duration + +## -description +Gets the duration of the referenced media frame. + +## -property-value +The duration of the referenced media frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_format.md b/windows.media.capture.frames/mediaframereference_format.md index 4e8913b744..c5051919ad 100644 --- a/windows.media.capture.frames/mediaframereference_format.md +++ b/windows.media.capture.frames/mediaframereference_format.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.Format --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.Format ## -description Gets the format of the reference media frame. ## -property-value The format of the reference media frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.Format +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.Format + +## -description +Gets the format of the reference media frame. + +## -property-value +The format of the reference media frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_properties.md b/windows.media.capture.frames/mediaframereference_properties.md index cc5a428b46..2e564a1a44 100644 --- a/windows.media.capture.frames/mediaframereference_properties.md +++ b/windows.media.capture.frames/mediaframereference_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.Properties --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.Properties ## -description Gets a map of properties for the referenced frame. ## -property-value A map of properties for the referenced frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.Properties + +## -description +Gets a map of properties for the referenced frame. + +## -property-value +A map of properties for the referenced frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_sourcekind.md b/windows.media.capture.frames/mediaframereference_sourcekind.md index 03bc4f4626..9d1e9aa9f9 100644 --- a/windows.media.capture.frames/mediaframereference_sourcekind.md +++ b/windows.media.capture.frames/mediaframereference_sourcekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.SourceKind --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.SourceKind ## -description Gets the type of [MediaFrameSource](mediaframesource.md) from which the referenced frame originated, such as a color, infrared, or custom source. ## -property-value The type of media frame source from which the referenced frame originated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.SourceKind +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.SourceKind + +## -description +Gets the type of [MediaFrameSource](mediaframesource.md) from which the referenced frame originated, such as a color, infrared, or custom source. + +## -property-value +The type of media frame source from which the referenced frame originated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_systemrelativetime.md b/windows.media.capture.frames/mediaframereference_systemrelativetime.md index 232149d0cb..3690d6c560 100644 --- a/windows.media.capture.frames/mediaframereference_systemrelativetime.md +++ b/windows.media.capture.frames/mediaframereference_systemrelativetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.SystemRelativeTime --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.SystemRelativeTime ## -description Gets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. ## -property-value A timestamp relative to the system. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.SystemRelativeTime +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.SystemRelativeTime + +## -description +Gets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. + +## -property-value +A timestamp relative to the system. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframereference_videomediaframe.md b/windows.media.capture.frames/mediaframereference_videomediaframe.md index b0a80bdd43..437b0c26ba 100644 --- a/windows.media.capture.frames/mediaframereference_videomediaframe.md +++ b/windows.media.capture.frames/mediaframereference_videomediaframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.VideoMediaFrame --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameReference.VideoMediaFrame ## -description Gets the [VideoMediaFrame](videomediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md), if that is the type of frame represented. ## -property-value The [VideoMediaFrame](videomediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md). ## -remarks If the frame reference wraps a different type of frame, such as a [BufferMediaFrame](buffermediaframe.md), the object returned by this property is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReference.VideoMediaFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReference.VideoMediaFrame + +## -description +Gets the [VideoMediaFrame](videomediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md), if that is the type of frame represented. + +## -property-value +The [VideoMediaFrame](videomediaframe.md) wrapped by the [MediaFrameReference](mediaframereference.md). + +## -remarks +If the frame reference wraps a different type of frame, such as a [BufferMediaFrame](buffermediaframe.md), the object returned by this property is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource.md b/windows.media.capture.frames/mediaframesource.md index 982ba2b127..b223fd120f 100644 --- a/windows.media.capture.frames/mediaframesource.md +++ b/windows.media.capture.frames/mediaframesource.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameSource --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameSource ## -description Represents a source of media frames, such as a color or infrared camera. ## -remarks To get an instance of **MediaFrameSource**, you must first initialize the [MediaCapture](../windows.media.capture/mediacapture.md) object with a [MediaFrameSourceGroup](mediaframesourcegroup.md) that includes your desired media frame source. You do this by setting the [SourceGroup](../windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md) of the [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) object you pass into [MediaCapture.InitializeAsync](../windows.media.capture/mediacapture_initializeasync.md). Next, use the [MediaFrameSourceInfo.Id](mediaframesourceinfo_id.md) property associated with the desired frame source as the key in the **MediaCapture** object's [FrameSources](../windows.media.capture/mediacapture_framesources.md) dictionary to get an instance of the **MediaFrameSource** object. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameSource +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource + +## -description +Represents a source of media frames, such as a color or infrared camera. + +## -remarks +To get an instance of **MediaFrameSource**, you must first initialize the [MediaCapture](../windows.media.capture/mediacapture.md) object with a [MediaFrameSourceGroup](mediaframesourcegroup.md) that includes your desired media frame source. You do this by setting the [SourceGroup](../windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md) of the [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) object you pass into [MediaCapture.InitializeAsync](../windows.media.capture/mediacapture_initializeasync.md). Next, use the [MediaFrameSourceInfo.Id](mediaframesourceinfo_id.md) property associated with the desired frame source as the key in the **MediaCapture** object's [FrameSources](../windows.media.capture/mediacapture_framesources.md) dictionary to get an instance of the **MediaFrameSource** object. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframesource_controller.md b/windows.media.capture.frames/mediaframesource_controller.md index be87ac501b..2d53fef348 100644 --- a/windows.media.capture.frames/mediaframesource_controller.md +++ b/windows.media.capture.frames/mediaframesource_controller.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.Controller --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSource.Controller ## -description Gets the [MediaFrameSourceController](mediaframesourcecontroller.md) for the [MediaFrameSource](mediaframesource.md). ## -property-value The [MediaFrameSourceController](mediaframesourcecontroller.md) for the media frame source. ## -remarks The [MediaFrameSourceController](mediaframesourcecontroller.md) object allows you to get and set properties of a media frame source and to get a [VideoDeviceController](../windows.media.devices/videodevicecontroller.md), which provides camera controls such as exposure, focus, and zoom. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.Controller +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.Controller + +## -description +Gets the [MediaFrameSourceController](mediaframesourcecontroller.md) for the [MediaFrameSource](mediaframesource.md). + +## -property-value +The [MediaFrameSourceController](mediaframesourcecontroller.md) for the media frame source. + +## -remarks +The [MediaFrameSourceController](mediaframesourcecontroller.md) object allows you to get and set properties of a media frame source and to get a [VideoDeviceController](../windows.media.devices/videodevicecontroller.md), which provides camera controls such as exposure, focus, and zoom. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource_currentformat.md b/windows.media.capture.frames/mediaframesource_currentformat.md index d5bd65bd79..d1ffafb993 100644 --- a/windows.media.capture.frames/mediaframesource_currentformat.md +++ b/windows.media.capture.frames/mediaframesource_currentformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.CurrentFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSource.CurrentFormat ## -description Gets a value indicating the current frame format of the [MediaFrameSource](mediaframesource.md). ## -property-value A value indicating the current frame format of the media frame source. ## -remarks To be notified when the current frame format of the media frame source changes, handle the [FormatChanged](mediaframesource_formatchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.CurrentFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.CurrentFormat + +## -description +Gets a value indicating the current frame format of the [MediaFrameSource](mediaframesource.md). + +## -property-value +A value indicating the current frame format of the media frame source. + +## -remarks +To be notified when the current frame format of the media frame source changes, handle the [FormatChanged](mediaframesource_formatchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource_formatchanged.md b/windows.media.capture.frames/mediaframesource_formatchanged.md index bf767a8f53..c3aa9e66db 100644 --- a/windows.media.capture.frames/mediaframesource_formatchanged.md +++ b/windows.media.capture.frames/mediaframesource_formatchanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.Frames.MediaFrameSource.FormatChanged --api-type: winrt event ---- # Windows.Media.Capture.Frames.MediaFrameSource.FormatChanged ## -description Occurs when the current frame format of the [MediaFrameSource](mediaframesource.md) changes. ## -remarks Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.Frames.MediaFrameSource.FormatChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.FormatChanged + +## -description +Occurs when the current frame format of the [MediaFrameSource](mediaframesource.md) changes. + +## -remarks +Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource_info.md b/windows.media.capture.frames/mediaframesource_info.md index c9036cf256..99ec380e76 100644 --- a/windows.media.capture.frames/mediaframesource_info.md +++ b/windows.media.capture.frames/mediaframesource_info.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.Info --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSource.Info ## -description Gets the [MediaFrameSourceInfo](mediaframesourceinfo.md) object that provides information about the [MediaFrameSource](mediaframesource.md). ## -property-value The [MediaFrameSourceInfo](mediaframesourceinfo.md) object that provides information about the media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.Info +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.Info + +## -description +Gets the [MediaFrameSourceInfo](mediaframesourceinfo.md) object that provides information about the [MediaFrameSource](mediaframesource.md). + +## -property-value +The [MediaFrameSourceInfo](mediaframesourceinfo.md) object that provides information about the media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md b/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md index e4c9b1e95f..1e253a3fdc 100644 --- a/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md +++ b/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSource.SetFormatAsync(Windows.Media.Capture.Frames.MediaFrameFormat) --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSource.SetFormatAsync ## -description Asynchronously sets the frame format of the [MediaFrameSource](mediaframesource.md). ## -parameters ### -param format The new frame format for the media frame source. ## -returns An asynchronous action. ## -remarks Get the list of supported frame formats for a media frame source by accessing the [SupportedFormats](mediaframesource_supportedformats.md) property. Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSource.SetFormatAsync(Windows.Media.Capture.Frames.MediaFrameFormat) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.SetFormatAsync + +## -description +Asynchronously sets the frame format of the [MediaFrameSource](mediaframesource.md). + +## -parameters +### -param format +The new frame format for the media frame source. + +## -returns +An asynchronous action. + +## -remarks +Get the list of supported frame formats for a media frame source by accessing the [SupportedFormats](mediaframesource_supportedformats.md) property. + +Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource_supportedformats.md b/windows.media.capture.frames/mediaframesource_supportedformats.md index 8391b03dc1..6faf61a5df 100644 --- a/windows.media.capture.frames/mediaframesource_supportedformats.md +++ b/windows.media.capture.frames/mediaframesource_supportedformats.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.SupportedFormats --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSource.SupportedFormats ## -description Gets a read-only list of [MediaFrameFormat](mediaframeformat.md) objects representing the frame formats supported by the [MediaFrameSource](mediaframesource.md). ## -property-value A read-only list of frame formats supported by the media frame source. ## -remarks Get the list of supported frame formats for a media frame source by accessing the [SupportedFormats](mediaframesource_supportedformats.md) property. Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. Set the current frame format by calling [SetFormatAsync](mediaframesource_setformatasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSource.SupportedFormats +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.SupportedFormats + +## -description +Gets a read-only list of [MediaFrameFormat](mediaframeformat.md) objects representing the frame formats supported by the [MediaFrameSource](mediaframesource.md). + +## -property-value +A read-only list of frame formats supported by the media frame source. + +## -remarks +Get the list of supported frame formats for a media frame source by accessing the [SupportedFormats](mediaframesource_supportedformats.md) property. + +Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. Set the current frame format by calling [SetFormatAsync](mediaframesource_setformatasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesource_trygetcameraintrinsics_1850716602.md b/windows.media.capture.frames/mediaframesource_trygetcameraintrinsics_1850716602.md index 3c774b3d99..5d9c460ac9 100644 --- a/windows.media.capture.frames/mediaframesource_trygetcameraintrinsics_1850716602.md +++ b/windows.media.capture.frames/mediaframesource_trygetcameraintrinsics_1850716602.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSource.TryGetCameraIntrinsics(Windows.Media.Capture.Frames.MediaFrameFormat) --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSource.TryGetCameraIntrinsics ## -description Attempts to retrieve the media frame source's camera intrinsics, which describe a camera's distortion model, for the specified [MediaFrameFormat](mediaframeformat.md). ## -parameters ### -param format The media frame format for which the camera intrinsics should be retrieved. ## -returns An object representing the camera intrinsics for the frame source, if they can be retrieved; otherwise, null. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSource.TryGetCameraIntrinsics(Windows.Media.Capture.Frames.MediaFrameFormat) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSource.TryGetCameraIntrinsics + +## -description +Attempts to retrieve the media frame source's camera intrinsics, which describe a camera's distortion model, for the specified [MediaFrameFormat](mediaframeformat.md). + +## -parameters +### -param format +The media frame format for which the camera intrinsics should be retrieved. + +## -returns +An object representing the camera intrinsics for the frame source, if they can be retrieved; otherwise, null. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcecontroller.md b/windows.media.capture.frames/mediaframesourcecontroller.md index d6e46107ea..8ed3ac6228 100644 --- a/windows.media.capture.frames/mediaframesourcecontroller.md +++ b/windows.media.capture.frames/mediaframesourcecontroller.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceController --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameSourceController ## -description Allows you to get and set properties of a [MediaFrameSource](mediaframesource.md) and to get a [VideoDeviceController](../windows.media.devices/videodevicecontroller.md), which provides camera controls such as exposure, focus, and zoom. ## -remarks Get an instance of the [MediaFrameSourceController](mediaframesourcecontroller.md) class by accessing the [Controller](mediaframesource_controller.md) property of a [MediaFrameSource](mediaframesource.md). For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceController +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController + +## -description +Allows you to get and set properties of a [MediaFrameSource](mediaframesource.md) and to get a [VideoDeviceController](../windows.media.devices/videodevicecontroller.md), which provides camera controls such as exposure, focus, and zoom. + +## -remarks +Get an instance of the [MediaFrameSourceController](mediaframesourcecontroller.md) class by accessing the [Controller](mediaframesource_controller.md) property of a [MediaFrameSource](mediaframesource.md). + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md b/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md index ed9900519b..8ce559e5be 100644 --- a/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md +++ b/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync(System.String) --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync ## -description Asynchronously gets an object that contains the value of a [MediaFrameSource](mediaframesource.md) property, if the property value is successfully retrieved, and describes the result status of the get operation. ## -parameters ### -param propertyId The identifier of the media frame source property to be retrieved. ## -returns An asynchronous operation that returns a [MediaFrameSourceGetPropertyResult](mediaframesourcegetpropertyresult.md) upon completion. ## -remarks To set the value of a media frame source property, use [SetPropertyAsync](mediaframesourcecontroller_setpropertyasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync + +## -description +Asynchronously gets an object that contains the value of a [MediaFrameSource](mediaframesource.md) property, if the property value is successfully retrieved, and describes the result status of the get operation. + +## -parameters +### -param propertyId +The identifier of the media frame source property to be retrieved. + +## -returns +An asynchronous operation that returns a [MediaFrameSourceGetPropertyResult](mediaframesourcegetpropertyresult.md) upon completion. + +## -remarks +To set the value of a media frame source property, use [SetPropertyAsync](mediaframesourcecontroller_setpropertyasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcecontroller_setpropertyasync_419187035.md b/windows.media.capture.frames/mediaframesourcecontroller_setpropertyasync_419187035.md index ff57880a13..10a507e441 100644 --- a/windows.media.capture.frames/mediaframesourcecontroller_setpropertyasync_419187035.md +++ b/windows.media.capture.frames/mediaframesourcecontroller_setpropertyasync_419187035.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.SetPropertyAsync(System.String,System.Object) --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSourceController.SetPropertyAsync ## -description Asynchronously sets the value of a [MediaFrameSource](mediaframesource.md) property and returns a [MediaFrameSourceSetPropertyStatus](mediaframesourcesetpropertystatus.md) object describing the result status of the set operation. ## -parameters ### -param propertyId The identifier of the media frame source property to be set. ### -param propertyValue The value of the media frame source property to be set. ## -returns An asynchronous operation that returns a [MediaFrameSourceSetPropertyStatus](mediaframesourcesetpropertystatus.md) upon completion. ## -remarks To get the value of a media frame source property, use [GetPropertyAsync](mediaframesourcecontroller_getpropertyasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.SetPropertyAsync(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController.SetPropertyAsync + +## -description +Asynchronously sets the value of a [MediaFrameSource](mediaframesource.md) property and returns a [MediaFrameSourceSetPropertyStatus](mediaframesourcesetpropertystatus.md) object describing the result status of the set operation. + +## -parameters +### -param propertyId +The identifier of the media frame source property to be set. + +### -param propertyValue +The value of the media frame source property to be set. + +## -returns +An asynchronous operation that returns a [MediaFrameSourceSetPropertyStatus](mediaframesourcesetpropertystatus.md) upon completion. + +## -remarks +To get the value of a media frame source property, use [GetPropertyAsync](mediaframesourcecontroller_getpropertyasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcecontroller_videodevicecontroller.md b/windows.media.capture.frames/mediaframesourcecontroller_videodevicecontroller.md index 12ae4bd6e0..9c764825fa 100644 --- a/windows.media.capture.frames/mediaframesourcecontroller_videodevicecontroller.md +++ b/windows.media.capture.frames/mediaframesourcecontroller_videodevicecontroller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceController.VideoDeviceController --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceController.VideoDeviceController ## -description Gets a [VideoDeviceController](../windows.media.devices/videodevicecontroller.md) for a [MediaFrameSource](mediaframesource.md), which provides camera controls such as exposure, focus, and zoom. ## -property-value A [VideoDeviceController](../windows.media.devices/videodevicecontroller.md) for the media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceController.VideoDeviceController +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController.VideoDeviceController + +## -description +Gets a [VideoDeviceController](../windows.media.devices/videodevicecontroller.md) for a [MediaFrameSource](mediaframesource.md), which provides camera controls such as exposure, focus, and zoom. + +## -property-value +A [VideoDeviceController](../windows.media.devices/videodevicecontroller.md) for the media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegetpropertyresult.md b/windows.media.capture.frames/mediaframesourcegetpropertyresult.md index a3c668ad01..e97be18377 100644 --- a/windows.media.capture.frames/mediaframesourcegetpropertyresult.md +++ b/windows.media.capture.frames/mediaframesourcegetpropertyresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult ## -description Represents the value of a [MediaFrameSource](mediaframesource.md) property, if it was successfully retrieved, and the result status of the get operation. ## -remarks Get an instance of **MediaFrameSourceGetPropertyResult** by calling [MediaFrameSourceController.GetPropertyAsync](mediaframesourcecontroller_getpropertyasync.md). Check the value of the [Status](mediaframesourcegetpropertyresult_status.md) property to determine if the get operation was successful. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult + +## -description +Represents the value of a [MediaFrameSource](mediaframesource.md) property, if it was successfully retrieved, and the result status of the get operation. + +## -remarks +Get an instance of **MediaFrameSourceGetPropertyResult** by calling [MediaFrameSourceController.GetPropertyAsync](mediaframesourcecontroller_getpropertyasync.md). Check the value of the [Status](mediaframesourcegetpropertyresult_status.md) property to determine if the get operation was successful. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegetpropertyresult_status.md b/windows.media.capture.frames/mediaframesourcegetpropertyresult_status.md index 35c7bffea0..c913ec3b00 100644 --- a/windows.media.capture.frames/mediaframesourcegetpropertyresult_status.md +++ b/windows.media.capture.frames/mediaframesourcegetpropertyresult_status.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Status --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Status ## -description Gets a value describing the result status of the get operation that attempted to retrieve the [MediaFrameSource](mediaframesource.md) property value. ## -property-value A value describing the result status of the get operation ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Status + +## -description +Gets a value describing the result status of the get operation that attempted to retrieve the [MediaFrameSource](mediaframesource.md) property value. + +## -property-value +A value describing the result status of the get operation + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegetpropertyresult_value.md b/windows.media.capture.frames/mediaframesourcegetpropertyresult_value.md index 1861dc1cea..a3fb6fecda 100644 --- a/windows.media.capture.frames/mediaframesourcegetpropertyresult_value.md +++ b/windows.media.capture.frames/mediaframesourcegetpropertyresult_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Value --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Value ## -description Gets an object containing the value of a [MediaFrameSource](mediaframesource.md) property, if the value was successfully retreived. ## -property-value An object containing the value of a media frame source property. ## -remarks If the value of the Status property is anything other than [Success](mediaframesourcegetpropertystatus.md), then this property is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Value +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGetPropertyResult.Value + +## -description +Gets an object containing the value of a [MediaFrameSource](mediaframesource.md) property, if the value was successfully retreived. + +## -property-value +An object containing the value of a media frame source property. + +## -remarks +If the value of the Status property is anything other than [Success](mediaframesourcegetpropertystatus.md), then this property is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegroup.md b/windows.media.capture.frames/mediaframesourcegroup.md index 9fdcc2d434..e1a3cedfcd 100644 --- a/windows.media.capture.frames/mediaframesourcegroup.md +++ b/windows.media.capture.frames/mediaframesourcegroup.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceGroup --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup ## -description Represents a group of media frame sources that can be used simultaneously by a [MediaCapture](../windows.media.capture/mediacapture.md). ## -remarks Get an instance of this class by calling [FindAllAsync](mediaframesourcegroup_findallasync.md) and selecting an instance from the returned list. If you know the unique identifier of a media frame source group, you can get an instance of this class by calling [FromIdAsync](mediaframesourcegroup_fromidasync.md). Initialize a [MediaCapture](../windows.media.capture/mediacapture.md) object to use the selected **MediaFrameSourceGroup** by assigning the group to the [SourceGroup](../windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md) property of a [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) object, and then passing that settings object into [InitializeAsync](../windows.media.capture/mediacapture_initializeasync.md). For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceGroup +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup + +## -description +Represents a group of media frame sources that can be used simultaneously by a [MediaCapture](../windows.media.capture/mediacapture.md). + +## -remarks +Get an instance of this class by calling [FindAllAsync](mediaframesourcegroup_findallasync.md) and selecting an instance from the returned list. If you know the unique identifier of a media frame source group, you can get an instance of this class by calling [FromIdAsync](mediaframesourcegroup_fromidasync.md). + +Initialize a [MediaCapture](../windows.media.capture/mediacapture.md) object to use the selected **MediaFrameSourceGroup** by assigning the group to the [SourceGroup](../windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md) property of a [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) object, and then passing that settings object into [InitializeAsync](../windows.media.capture/mediacapture_initializeasync.md). + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframesourcegroup_displayname.md b/windows.media.capture.frames/mediaframesourcegroup_displayname.md index 257b0d71fc..963c64f0e7 100644 --- a/windows.media.capture.frames/mediaframesourcegroup_displayname.md +++ b/windows.media.capture.frames/mediaframesourcegroup_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGroup.DisplayName --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup.DisplayName ## -description Gets the human-readable name for the media frame source group. ## -property-value The human-readable name for the media frame source group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGroup.DisplayName +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup.DisplayName + +## -description +Gets the human-readable name for the media frame source group. + +## -property-value +The human-readable name for the media frame source group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegroup_findallasync_326280522.md b/windows.media.capture.frames/mediaframesourcegroup_findallasync_326280522.md index e782380211..9aeb08f158 100644 --- a/windows.media.capture.frames/mediaframesourcegroup_findallasync_326280522.md +++ b/windows.media.capture.frames/mediaframesourcegroup_findallasync_326280522.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceGroup.FindAllAsync --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup.FindAllAsync ## -description Asynchronously retrieves a list of the available media frame source groups on the current device. ## -returns An asynchronous operation that returns a list of [MediaFrameSourceGroup](mediaframesourcegroup.md) objects upon completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceGroup.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup.FindAllAsync + +## -description +Asynchronously retrieves a list of the available media frame source groups on the current device. + +## -returns +An asynchronous operation that returns a list of [MediaFrameSourceGroup](mediaframesourcegroup.md) objects upon completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegroup_fromidasync_1322863552.md b/windows.media.capture.frames/mediaframesourcegroup_fromidasync_1322863552.md index 6f1ea95efa..86d608f046 100644 --- a/windows.media.capture.frames/mediaframesourcegroup_fromidasync_1322863552.md +++ b/windows.media.capture.frames/mediaframesourcegroup_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceGroup.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup.FromIdAsync ## -description Asynchronously gets the media frame source group with the specified ID. ## -parameters ### -param id The unique identifier of a media frame source group. ## -returns An asynchronous operation that returns a [MediaFrameSourceGroup](mediaframesourcegroup.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceGroup.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup.FromIdAsync + +## -description +Asynchronously gets the media frame source group with the specified ID. + +## -parameters +### -param id +The unique identifier of a media frame source group. + +## -returns +An asynchronous operation that returns a [MediaFrameSourceGroup](mediaframesourcegroup.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegroup_getdeviceselector_838466080.md b/windows.media.capture.frames/mediaframesourcegroup_getdeviceselector_838466080.md index 079e5f33d4..83793812f0 100644 --- a/windows.media.capture.frames/mediaframesourcegroup_getdeviceselector_838466080.md +++ b/windows.media.capture.frames/mediaframesourcegroup_getdeviceselector_838466080.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceGroup.GetDeviceSelector --api-type: winrt method ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup.GetDeviceSelector ## -description Gets a device selector string that can be used to initialize a [DeviceWatcher](../windows.devices.enumeration/devicewatcher.md), which allows you receive notifications when the set of available media frame source groups changes. ## -returns The device selector string for a media frame source group. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceGroup.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup.GetDeviceSelector + +## -description +Gets a device selector string that can be used to initialize a [DeviceWatcher](../windows.devices.enumeration/devicewatcher.md), which allows you receive notifications when the set of available media frame source groups changes. + +## -returns +The device selector string for a media frame source group. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegroup_id.md b/windows.media.capture.frames/mediaframesourcegroup_id.md index b72ff03385..e85062b6bc 100644 --- a/windows.media.capture.frames/mediaframesourcegroup_id.md +++ b/windows.media.capture.frames/mediaframesourcegroup_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGroup.Id --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup.Id ## -description Gets a unique identifier for the media frame source group. ## -property-value A unique identifier for the media frame source group. ## -remarks Use this identifier when calling [FromIdAsync](mediaframesourcegroup_fromidasync.md) to retrieve a specific media frame source group. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGroup.Id +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup.Id + +## -description +Gets a unique identifier for the media frame source group. + +## -property-value +A unique identifier for the media frame source group. + +## -remarks +Use this identifier when calling [FromIdAsync](mediaframesourcegroup_fromidasync.md) to retrieve a specific media frame source group. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourcegroup_sourceinfos.md b/windows.media.capture.frames/mediaframesourcegroup_sourceinfos.md index 481a211ea1..d673bc99df 100644 --- a/windows.media.capture.frames/mediaframesourcegroup_sourceinfos.md +++ b/windows.media.capture.frames/mediaframesourcegroup_sourceinfos.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGroup.SourceInfos --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceGroup.SourceInfos ## -description Gets a list of [MediaFrameSourceInfo](mediaframesourceinfo.md) objects that describe each media frame source in the group. ## -property-value An asynchronous action that returns a list of [MediaFrameSourceInfo](mediaframesourceinfo.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceGroup.SourceInfos +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceGroup.SourceInfos + +## -description +Gets a list of [MediaFrameSourceInfo](mediaframesourceinfo.md) objects that describe each media frame source in the group. + +## -property-value +An asynchronous action that returns a list of [MediaFrameSourceInfo](mediaframesourceinfo.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo.md b/windows.media.capture.frames/mediaframesourceinfo.md index d5f22784ec..f8b5366570 100644 --- a/windows.media.capture.frames/mediaframesourceinfo.md +++ b/windows.media.capture.frames/mediaframesourceinfo.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceInfo --api-type: winrt class ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo ## -description Provides information about a [MediaFrameSource](mediaframesource.md). ## -remarks Get an instance of this class by accessing the [Info](mediaframesource_info.md) property of a [MediaFrameSource](mediaframesource.md) object or by accessing the [SourceInfos](mediaframesourcegroup_sourceinfos.md) property of a [MediaFrameSourceGroup](mediaframesourcegroup.md) object which represents a group of media frame sources.. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameSourceInfo +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo + +## -description +Provides information about a [MediaFrameSource](mediaframesource.md). + +## -remarks +Get an instance of this class by accessing the [Info](mediaframesource_info.md) property of a [MediaFrameSource](mediaframesource.md) object or by accessing the [SourceInfos](mediaframesourcegroup_sourceinfos.md) property of a [MediaFrameSourceGroup](mediaframesourcegroup.md) object which represents a group of media frame sources.. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframesourceinfo_coordinatesystem.md b/windows.media.capture.frames/mediaframesourceinfo_coordinatesystem.md index 210addd698..4b5a0c22f6 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_coordinatesystem.md +++ b/windows.media.capture.frames/mediaframesourceinfo_coordinatesystem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.CoordinateSystem --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.CoordinateSystem ## -description Gets an object representing the spatial coordinate system in which the data from a [MediaFrameSource](mediaframesource.md) is expressed. ## -property-value An object representing the spatial coordinate system of the media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.CoordinateSystem +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.CoordinateSystem + +## -description +Gets an object representing the spatial coordinate system in which the data from a [MediaFrameSource](mediaframesource.md) is expressed. + +## -property-value +An object representing the spatial coordinate system of the media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo_deviceinformation.md b/windows.media.capture.frames/mediaframesourceinfo_deviceinformation.md index 1ca6e55869..9af2f1628c 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_deviceinformation.md +++ b/windows.media.capture.frames/mediaframesourceinfo_deviceinformation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.DeviceInformation --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.DeviceInformation ## -description Gets a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object that can be used to access properties of a [MediaFrameSource](mediaframesource.md) device. ## -property-value A [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing a media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.DeviceInformation +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.DeviceInformation + +## -description +Gets a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object that can be used to access properties of a [MediaFrameSource](mediaframesource.md) device. + +## -property-value +A [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing a media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo_id.md b/windows.media.capture.frames/mediaframesourceinfo_id.md index 7fe8b9b5b3..986f4df0c0 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_id.md +++ b/windows.media.capture.frames/mediaframesourceinfo_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.Id --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.Id ## -description Gets the unique identifier for a [MediaFrameSource](mediaframesource.md). Use this identifier as the key when getting a **MediaFrameSource** instance from [MediaCapture.FrameSources](../windows.media.capture/mediacapture_framesources.md) dictionary. ## -property-value The unique identifier for a media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.Id +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.Id + +## -description +Gets the unique identifier for a [MediaFrameSource](mediaframesource.md). Use this identifier as the key when getting a **MediaFrameSource** instance from [MediaCapture.FrameSources](../windows.media.capture/mediacapture_framesources.md) dictionary. + +## -property-value +The unique identifier for a media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo_mediastreamtype.md b/windows.media.capture.frames/mediaframesourceinfo_mediastreamtype.md index 882dfb4359..3676255059 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_mediastreamtype.md +++ b/windows.media.capture.frames/mediaframesourceinfo_mediastreamtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.MediaStreamType --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.MediaStreamType ## -description Gets a value indicating the stream type of a [MediaFrameSource](mediaframesource.md), such as photo, video, or audio. ## -property-value A value indicating the stream type of a media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.MediaStreamType +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.MediaStreamType + +## -description +Gets a value indicating the stream type of a [MediaFrameSource](mediaframesource.md), such as photo, video, or audio. + +## -property-value +A value indicating the stream type of a media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo_properties.md b/windows.media.capture.frames/mediaframesourceinfo_properties.md index 61af9b36b3..470146e2f5 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_properties.md +++ b/windows.media.capture.frames/mediaframesourceinfo_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.Properties --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.Properties ## -description Gets a read-only map of properties for a [MediaFrameSource](mediaframesource.md). ## -property-value A read-only map of properties for a media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.Properties + +## -description +Gets a read-only map of properties for a [MediaFrameSource](mediaframesource.md). + +## -property-value +A read-only map of properties for a media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo_sourcegroup.md b/windows.media.capture.frames/mediaframesourceinfo_sourcegroup.md index a1593bb56c..3812546f94 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_sourcegroup.md +++ b/windows.media.capture.frames/mediaframesourceinfo_sourcegroup.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceGroup --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceGroup ## -description Gets the [MediaFrameSourceGroup](mediaframesourcegroup.md) to which a [MediaFrameSource](mediaframesource.md) belongs. ## -property-value The group to which a media frame source belongs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceGroup +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceGroup + +## -description +Gets the [MediaFrameSourceGroup](mediaframesourcegroup.md) to which a [MediaFrameSource](mediaframesource.md) belongs. + +## -property-value +The group to which a media frame source belongs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/mediaframesourceinfo_sourcekind.md b/windows.media.capture.frames/mediaframesourceinfo_sourcekind.md index f9a0a3864c..b7e4d1d7be 100644 --- a/windows.media.capture.frames/mediaframesourceinfo_sourcekind.md +++ b/windows.media.capture.frames/mediaframesourceinfo_sourcekind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceKind --api-type: winrt property ---- # Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceKind ## -description Gets a value indicating the kind of media frames generated by a [MediaFrameSource](mediaframesource.md), such as color, depth, or infrared. ## -property-value A value indicating the kind of media frames generated by a media frame source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceKind +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceInfo.SourceKind + +## -description +Gets a value indicating the kind of media frames generated by a [MediaFrameSource](mediaframesource.md), such as color, depth, or infrared. + +## -property-value +A value indicating the kind of media frames generated by a media frame source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe.md b/windows.media.capture.frames/videomediaframe.md index 121ac80414..9c8e1a334e 100644 --- a/windows.media.capture.frames/videomediaframe.md +++ b/windows.media.capture.frames/videomediaframe.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.Media.Capture.Frames.VideoMediaFrame --api-type: winrt class ---- # Windows.Media.Capture.Frames.VideoMediaFrame ## -description Represents a frame from a [MediaFrameSource](mediaframesource.md) that provides data in an video frame represented by a [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) or [SoftwareBitmap](videomediaframe_softwarebitmap.md). ## -remarks Get an instance of this class by accessing the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md) object that was obtained from a media frame source. > [!IMPORTANT] > If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.VideoMediaFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame + +## -description +Represents a frame from a [MediaFrameSource](mediaframesource.md) that provides data in an video frame represented by a [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) or [SoftwareBitmap](videomediaframe_softwarebitmap.md). + +## -remarks +Get an instance of this class by accessing the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md) object that was obtained from a media frame source. + + + +> [!IMPORTANT] +> If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/videomediaframe_cameraintrinsics.md b/windows.media.capture.frames/videomediaframe_cameraintrinsics.md index 81511acaac..a45cad484e 100644 --- a/windows.media.capture.frames/videomediaframe_cameraintrinsics.md +++ b/windows.media.capture.frames/videomediaframe_cameraintrinsics.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.CameraIntrinsics --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.CameraIntrinsics ## -description Gets an object that describes the distortion model of the camera that generated the [VideoMediaFrame](videomediaframe.md). ## -property-value An object that describes the distortion model of the camera that generated the [VideoMediaFrame](videomediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.CameraIntrinsics +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.CameraIntrinsics + +## -description +Gets an object that describes the distortion model of the camera that generated the [VideoMediaFrame](videomediaframe.md). + +## -property-value +An object that describes the distortion model of the camera that generated the [VideoMediaFrame](videomediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_depthmediaframe.md b/windows.media.capture.frames/videomediaframe_depthmediaframe.md index bc4bb0a7b5..a282e5986c 100644 --- a/windows.media.capture.frames/videomediaframe_depthmediaframe.md +++ b/windows.media.capture.frames/videomediaframe_depthmediaframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.DepthMediaFrame --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.DepthMediaFrame ## -description Gets a [DepthMediaFrame](depthmediaframe.md) containing depth data for the [VideoMediaFrame](videomediaframe.md), if the frame contains depth data. ## -property-value A [DepthMediaFrame](depthmediaframe.md) containing depth data. ## -remarks If the [MediaFrameSource](mediaframesource.md) that generated the [VideoMediaFrame](depthmediaframe_videomediaframe.md) does not produce depth data, this object is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.DepthMediaFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.DepthMediaFrame + +## -description +Gets a [DepthMediaFrame](depthmediaframe.md) containing depth data for the [VideoMediaFrame](videomediaframe.md), if the frame contains depth data. + +## -property-value +A [DepthMediaFrame](depthmediaframe.md) containing depth data. + +## -remarks +If the [MediaFrameSource](mediaframesource.md) that generated the [VideoMediaFrame](depthmediaframe_videomediaframe.md) does not produce depth data, this object is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_direct3dsurface.md b/windows.media.capture.frames/videomediaframe_direct3dsurface.md index f40a921b2f..1a0841ff80 100644 --- a/windows.media.capture.frames/videomediaframe_direct3dsurface.md +++ b/windows.media.capture.frames/videomediaframe_direct3dsurface.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.Direct3DSurface --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.Direct3DSurface ## -description Gets an [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). ## -property-value An [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). ## -remarks If you initialize a [MediaCapture](../windows.media.capture/mediacapture.md) object to use CPU memory for captured frames by setting the [MemoryPreference](../windows.media.capture/mediacaptureinitializationsettings_memorypreference.md) property of the [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) to [Cpu](../windows.media.capture/mediacapturememorypreference.md), the Direct3DSurface property of a received [VideoMediaFrame](videomediaframe.md) will be null and the [SoftwareBitmap](videomediaframe_softwarebitmap.md) property will be non-null and contain the image data from the frame. Setting the memory preference to [Auto](../windows.media.capture/mediacapturememorypreference.md) allows the system to choose the optimal memory location for the current device. If the system chooses to use GPU memory, the [SoftwareBitmap](videomediaframe_softwarebitmap.md) property will be null and the **Direct3DSurface** property will contain the frame's image data.. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.Direct3DSurface +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.Direct3DSurface + +## -description +Gets an [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). + +## -property-value +An [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). + +## -remarks +If you initialize a [MediaCapture](../windows.media.capture/mediacapture.md) object to use CPU memory for captured frames by setting the [MemoryPreference](../windows.media.capture/mediacaptureinitializationsettings_memorypreference.md) property of the [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) to [Cpu](../windows.media.capture/mediacapturememorypreference.md), the Direct3DSurface property of a received [VideoMediaFrame](videomediaframe.md) will be null and the [SoftwareBitmap](videomediaframe_softwarebitmap.md) property will be non-null and contain the image data from the frame. Setting the memory preference to [Auto](../windows.media.capture/mediacapturememorypreference.md) allows the system to choose the optimal memory location for the current device. If the system chooses to use GPU memory, the [SoftwareBitmap](videomediaframe_softwarebitmap.md) property will be null and the **Direct3DSurface** property will contain the frame's image data.. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_framereference.md b/windows.media.capture.frames/videomediaframe_framereference.md index ba6f9ab470..8cc4e58a74 100644 --- a/windows.media.capture.frames/videomediaframe_framereference.md +++ b/windows.media.capture.frames/videomediaframe_framereference.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.FrameReference --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.FrameReference ## -description Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [VideoMediaFrame](videomediaframe.md), which provides access to format information and other properties of the media frame. ## -property-value The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [VideoMediaFrame](videomediaframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.FrameReference +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.FrameReference + +## -description +Gets the [MediaFrameReference](mediaframereference.md) wrapper object associated with the [VideoMediaFrame](videomediaframe.md), which provides access to format information and other properties of the media frame. + +## -property-value +The [MediaFrameReference](mediaframereference.md) wrapper object associated with the [VideoMediaFrame](videomediaframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_getvideoframe_824740069.md b/windows.media.capture.frames/videomediaframe_getvideoframe_824740069.md index f0df6c99c9..c033ce13e3 100644 --- a/windows.media.capture.frames/videomediaframe_getvideoframe_824740069.md +++ b/windows.media.capture.frames/videomediaframe_getvideoframe_824740069.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.Frames.VideoMediaFrame.GetVideoFrame --api-type: winrt method ---- # Windows.Media.Capture.Frames.VideoMediaFrame.GetVideoFrame ## -description Creates a copy of the [VideoMediaFrame](videomediaframe.md) as a [VideoFrame](videomediaframe_getvideoframe.md) object. ## -returns The [VideoFrame](videomediaframe_getvideoframe.md) containing a copy of the [VideoMediaFrame](videomediaframe.md) image data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.Frames.VideoMediaFrame.GetVideoFrame +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.GetVideoFrame + +## -description +Creates a copy of the [VideoMediaFrame](videomediaframe.md) as a [VideoFrame](videomediaframe_getvideoframe.md) object. + +## -returns +The [VideoFrame](videomediaframe_getvideoframe.md) containing a copy of the [VideoMediaFrame](videomediaframe.md) image data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_infraredmediaframe.md b/windows.media.capture.frames/videomediaframe_infraredmediaframe.md index aad0fc6e63..77e3e4440a 100644 --- a/windows.media.capture.frames/videomediaframe_infraredmediaframe.md +++ b/windows.media.capture.frames/videomediaframe_infraredmediaframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.InfraredMediaFrame --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.InfraredMediaFrame ## -description Gets an [InfraredMediaFrame](infraredmediaframe.md) containing depth data for the [VideoMediaFrame](videomediaframe.md), if the frame contains infrared data. ## -property-value A [InfraredMediaFrame](infraredmediaframe.md) containing infrared data. ## -remarks If the [MediaFrameSource](mediaframesource.md) that generated the [VideoMediaFrame](depthmediaframe_videomediaframe.md) does not produce infrared data, this object is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.InfraredMediaFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.InfraredMediaFrame + +## -description +Gets an [InfraredMediaFrame](infraredmediaframe.md) containing depth data for the [VideoMediaFrame](videomediaframe.md), if the frame contains infrared data. + +## -property-value +A [InfraredMediaFrame](infraredmediaframe.md) containing infrared data. + +## -remarks +If the [MediaFrameSource](mediaframesource.md) that generated the [VideoMediaFrame](depthmediaframe_videomediaframe.md) does not produce infrared data, this object is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_softwarebitmap.md b/windows.media.capture.frames/videomediaframe_softwarebitmap.md index 300644b36e..4c3a792afb 100644 --- a/windows.media.capture.frames/videomediaframe_softwarebitmap.md +++ b/windows.media.capture.frames/videomediaframe_softwarebitmap.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.SoftwareBitmap --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.SoftwareBitmap ## -description Gets a [SoftwareBitmap](videomediaframe_softwarebitmap.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). ## -property-value A [SoftwareBitmap](videomediaframe_softwarebitmap.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). ## -remarks Initialize a [MediaCapture](../windows.media.capture/mediacapture.md) object to use CPU memory for captured frames by setting the [MemoryPreference](../windows.media.capture/mediacaptureinitializationsettings_memorypreference.md) property of the [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) to [Cpu](../windows.media.capture/mediacapturememorypreference.md). Doing this guarantees that the **SoftwareBitmap** property of a received [VideoMediaFrame](videomediaframe.md) will be non-null and contain the image data from the frame. Setting the memory preference to [Auto](../windows.media.capture/mediacapturememorypreference.md) allows the system to choose the optimal memory location for the current device. If the system chooses to use GPU memory, the **SoftwareBitmap** property will be null and the [Direct3DSurface](videomediaframe_direct3dsurface.md) property should be used instead. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.SoftwareBitmap +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.SoftwareBitmap + +## -description +Gets a [SoftwareBitmap](videomediaframe_softwarebitmap.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). + +## -property-value +A [SoftwareBitmap](videomediaframe_softwarebitmap.md) object containing the image data for the [VideoMediaFrame](videomediaframe.md). + +## -remarks +Initialize a [MediaCapture](../windows.media.capture/mediacapture.md) object to use CPU memory for captured frames by setting the [MemoryPreference](../windows.media.capture/mediacaptureinitializationsettings_memorypreference.md) property of the [MediaCaptureInitializationSettings](../windows.media.capture/mediacaptureinitializationsettings.md) to [Cpu](../windows.media.capture/mediacapturememorypreference.md). Doing this guarantees that the **SoftwareBitmap** property of a received [VideoMediaFrame](videomediaframe.md) will be non-null and contain the image data from the frame. Setting the memory preference to [Auto](../windows.media.capture/mediacapturememorypreference.md) allows the system to choose the optimal memory location for the current device. If the system chooses to use GPU memory, the **SoftwareBitmap** property will be null and the [Direct3DSurface](videomediaframe_direct3dsurface.md) property should be used instead. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframe_videoformat.md b/windows.media.capture.frames/videomediaframe_videoformat.md index 64d36a0f97..8cb19b955b 100644 --- a/windows.media.capture.frames/videomediaframe_videoformat.md +++ b/windows.media.capture.frames/videomediaframe_videoformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.VideoFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrame.VideoFormat ## -description Gets an object describing the format of the [VideoMediaFrame](videomediaframe.md) image data. ## -property-value An object describing the format of the [VideoMediaFrame](videomediaframe.md) image data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrame.VideoFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrame.VideoFormat + +## -description +Gets an object describing the format of the [VideoMediaFrame](videomediaframe.md) image data. + +## -property-value +An object describing the format of the [VideoMediaFrame](videomediaframe.md) image data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframeformat.md b/windows.media.capture.frames/videomediaframeformat.md index 9c95039d0b..c0eabe6853 100644 --- a/windows.media.capture.frames/videomediaframeformat.md +++ b/windows.media.capture.frames/videomediaframeformat.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.Frames.VideoMediaFrameFormat --api-type: winrt class ---- # Windows.Media.Capture.Frames.VideoMediaFrameFormat ## -description Describes the image format of a [VideoMediaFrame](videomediaframe.md). ## -remarks Get an instance of this class by accessing the [MediaFrameFormat.VideoFormat](mediaframeformat_videoformat.md), [VideoMediaFrame.VideoFormat](videomediaframe_videoformat.md), or [DepthMediaFrame.VideoFormat](depthmediaframeformat_videoformat.md) property. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.Frames.VideoMediaFrameFormat +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrameFormat + +## -description +Describes the image format of a [VideoMediaFrame](videomediaframe.md). + +## -remarks +Get an instance of this class by accessing the [MediaFrameFormat.VideoFormat](mediaframeformat_videoformat.md), [VideoMediaFrame.VideoFormat](videomediaframe_videoformat.md), or [DepthMediaFrame.VideoFormat](depthmediaframeformat_videoformat.md) property. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/videomediaframeformat_depthformat.md b/windows.media.capture.frames/videomediaframeformat_depthformat.md index c1363f7f8a..40cb103b63 100644 --- a/windows.media.capture.frames/videomediaframeformat_depthformat.md +++ b/windows.media.capture.frames/videomediaframeformat_depthformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.DepthFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrameFormat.DepthFormat ## -description Gets an object that describes the format of the depth data in a video media frame, if the frame contains depth data. ## -property-value An object that describes the format of the depth data in a video media frame. ## -remarks If the video media frame does not contain depth data, this property is null. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.DepthFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrameFormat.DepthFormat + +## -description +Gets an object that describes the format of the depth data in a video media frame, if the frame contains depth data. + +## -property-value +An object that describes the format of the depth data in a video media frame. + +## -remarks +If the video media frame does not contain depth data, this property is null. + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframeformat_height.md b/windows.media.capture.frames/videomediaframeformat_height.md index 27fab51bbb..0fbce2e1d3 100644 --- a/windows.media.capture.frames/videomediaframeformat_height.md +++ b/windows.media.capture.frames/videomediaframeformat_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.Height --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrameFormat.Height ## -description Gets the height of the video media frame, in pixels. ## -property-value The height of the video media frame, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.Height +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrameFormat.Height + +## -description +Gets the height of the video media frame, in pixels. + +## -property-value +The height of the video media frame, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframeformat_mediaframeformat.md b/windows.media.capture.frames/videomediaframeformat_mediaframeformat.md index c5ee83e447..435ed35e9a 100644 --- a/windows.media.capture.frames/videomediaframeformat_mediaframeformat.md +++ b/windows.media.capture.frames/videomediaframeformat_mediaframeformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.MediaFrameFormat --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrameFormat.MediaFrameFormat ## -description Gets an object that provides information about the format of the media frame that is not specific to video frames. ## -property-value An object that provides information about the format of the media frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.MediaFrameFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrameFormat.MediaFrameFormat + +## -description +Gets an object that provides information about the format of the media frame that is not specific to video frames. + +## -property-value +An object that provides information about the format of the media frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture.frames/videomediaframeformat_width.md b/windows.media.capture.frames/videomediaframeformat_width.md index 1af9a866e6..36e2a2c03f 100644 --- a/windows.media.capture.frames/videomediaframeformat_width.md +++ b/windows.media.capture.frames/videomediaframeformat_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.Width --api-type: winrt property ---- # Windows.Media.Capture.Frames.VideoMediaFrameFormat.Width ## -description Gets the width of the video media frame, in pixels. ## -property-value The width of the video media frame, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.Frames.VideoMediaFrameFormat.Width +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.VideoMediaFrameFormat.Width + +## -description +Gets the width of the video media frame, in pixels. + +## -property-value +The width of the video media frame, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedcapturedphoto.md b/windows.media.capture/advancedcapturedphoto.md index 13263709b2..7b6e61291c 100644 --- a/windows.media.capture/advancedcapturedphoto.md +++ b/windows.media.capture/advancedcapturedphoto.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.AdvancedCapturedPhoto --api-type: winrt class ---- # Windows.Media.Capture.AdvancedCapturedPhoto ## -description Represents a photo captured using system-provided computational photography techniques provided by the [AdvancedPhotoCapture](advancedphotocapture.md) class. ## -remarks Get an instance of this class by calling [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md). For how-to guidance for using [AdvancedPhotoCapture](advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). ## -examples ## -see-also [MediaCapture](mediacapture.md), [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.AdvancedCapturedPhoto +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AdvancedCapturedPhoto + +## -description +Represents a photo captured using system-provided computational photography techniques provided by the [AdvancedPhotoCapture](advancedphotocapture.md) class. + +## -remarks +Get an instance of this class by calling [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md). + +For how-to guidance for using [AdvancedPhotoCapture](advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +## -examples + +## -see-also +[MediaCapture](mediacapture.md), [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file diff --git a/windows.media.capture/advancedcapturedphoto_context.md b/windows.media.capture/advancedcapturedphoto_context.md index 07dc027863..81e7880d54 100644 --- a/windows.media.capture/advancedcapturedphoto_context.md +++ b/windows.media.capture/advancedcapturedphoto_context.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.Context --api-type: winrt property ---- # Windows.Media.Capture.AdvancedCapturedPhoto.Context ## -description Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to [AdvancedPhotoCapture.CaptureAsync(Object)](advancedphotocapture_captureasync_651770772.md). ## -property-value The app-defined context object associated with the advanced photo capture operation. ## -remarks One overload of [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md) allows you to provide an app-defined object that conveys context information. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.Context +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AdvancedCapturedPhoto.Context + +## -description +Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to [AdvancedPhotoCapture.CaptureAsync(Object)](advancedphotocapture_captureasync_651770772.md). + +## -property-value +The app-defined context object associated with the advanced photo capture operation. + +## -remarks +One overload of [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md) allows you to provide an app-defined object that conveys context information. + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedcapturedphoto_frame.md b/windows.media.capture/advancedcapturedphoto_frame.md index a8941aa9a9..ffb41ee86f 100644 --- a/windows.media.capture/advancedcapturedphoto_frame.md +++ b/windows.media.capture/advancedcapturedphoto_frame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.Frame --api-type: winrt property ---- # Windows.Media.Capture.AdvancedCapturedPhoto.Frame ## -description Gets the captured frame containing the result of the advanced photo capture. ## -property-value The captured frame containing the result of the advanced photo capture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AdvancedCapturedPhoto.Frame + +## -description +Gets the captured frame containing the result of the advanced photo capture. + +## -property-value +The captured frame containing the result of the advanced photo capture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedcapturedphoto_frameboundsrelativetoreferencephoto.md b/windows.media.capture/advancedcapturedphoto_frameboundsrelativetoreferencephoto.md index 15a14d4b7e..1e34d2e53e 100644 --- a/windows.media.capture/advancedcapturedphoto_frameboundsrelativetoreferencephoto.md +++ b/windows.media.capture/advancedcapturedphoto_frameboundsrelativetoreferencephoto.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.FrameBoundsRelativeToReferencePhoto --api-type: winrt property ---- # Windows.Media.Capture.AdvancedCapturedPhoto.FrameBoundsRelativeToReferencePhoto ## -description Gets a reference to a [Rect](../windows.foundation/rect.md) that expresses the dimensions of the [Frame](advancedcapturedphoto_frame.md) generated by the advanced photo capture operation, relative to the reference photo passed into the [OptionalReferencePhotoCaptured](advancedphotocapture_optionalreferencephotocaptured.md) event. ## -property-value A reference to a [Rect](../windows.foundation/rect.md) that expresses the frame bounds of the captured frame relative to a reference photo. ## -remarks Due to the image processing involved, a frame captured with [AdvancedPhotoCapture](advancedphotocapture.md) may be smaller than the preview photo that is passed into the [OptionalReferencePhotoCaptured](advancedphotocapture_optionalreferencephotocaptured.md) event. This property allows you to crop the preview frame so that it matches the dimensions of the processed frame. > [!NOTE] > Not all capture devices support providing a reference photo for advanced photo capture or determining the dimensions of the reference photo, so this property may be null. Be sure to check for a null reference before using the value of this property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.FrameBoundsRelativeToReferencePhoto +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AdvancedCapturedPhoto.FrameBoundsRelativeToReferencePhoto + +## -description +Gets a reference to a [Rect](../windows.foundation/rect.md) that expresses the dimensions of the [Frame](advancedcapturedphoto_frame.md) generated by the advanced photo capture operation, relative to the reference photo passed into the [OptionalReferencePhotoCaptured](advancedphotocapture_optionalreferencephotocaptured.md) event. + +## -property-value +A reference to a [Rect](../windows.foundation/rect.md) that expresses the frame bounds of the captured frame relative to a reference photo. + +## -remarks +Due to the image processing involved, a frame captured with [AdvancedPhotoCapture](advancedphotocapture.md) may be smaller than the preview photo that is passed into the [OptionalReferencePhotoCaptured](advancedphotocapture_optionalreferencephotocaptured.md) event. This property allows you to crop the preview frame so that it matches the dimensions of the processed frame. + + + +> [!NOTE] +> Not all capture devices support providing a reference photo for advanced photo capture or determining the dimensions of the reference photo, so this property may be null. Be sure to check for a null reference before using the value of this property. + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedcapturedphoto_mode.md b/windows.media.capture/advancedcapturedphoto_mode.md index c273a03c92..496daba718 100644 --- a/windows.media.capture/advancedcapturedphoto_mode.md +++ b/windows.media.capture/advancedcapturedphoto_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.Mode --api-type: winrt property ---- # Windows.Media.Capture.AdvancedCapturedPhoto.Mode ## -description Gets a value indicating the advanced capture mode with which the photo was captured. ## -property-value A value indicating the advanced capture mode with which the photo was captured. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AdvancedCapturedPhoto.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AdvancedCapturedPhoto.Mode + +## -description +Gets a value indicating the advanced capture mode with which the photo was captured. + +## -property-value +A value indicating the advanced capture mode with which the photo was captured. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedphotocapture.md b/windows.media.capture/advancedphotocapture.md index 6dd8dd0996..b64e930623 100644 --- a/windows.media.capture/advancedphotocapture.md +++ b/windows.media.capture/advancedphotocapture.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.AdvancedPhotoCapture --api-type: winrt class ---- # Windows.Media.Capture.AdvancedPhotoCapture ## -description Provides methods for capturing photos using system-provided computational photography techniques. ## -remarks Get an instance of this class by calling [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md). For how-to guidance for using **AdvancedPhotoCapture**, see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). ## -examples ## -see-also [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture), [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.AdvancedPhotoCapture +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AdvancedPhotoCapture + +## -description +Provides methods for capturing photos using system-provided computational photography techniques. + +## -remarks +Get an instance of this class by calling [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md). + +For how-to guidance for using **AdvancedPhotoCapture**, see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +## -examples + +## -see-also +[High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture), [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md) \ No newline at end of file diff --git a/windows.media.capture/advancedphotocapture_allphotoscaptured.md b/windows.media.capture/advancedphotocapture_allphotoscaptured.md index 5b4c5d83a3..0e200c3eff 100644 --- a/windows.media.capture/advancedphotocapture_allphotoscaptured.md +++ b/windows.media.capture/advancedphotocapture_allphotoscaptured.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.AdvancedPhotoCapture.AllPhotosCaptured --api-type: winrt event ---- # Windows.Media.Capture.AdvancedPhotoCapture.AllPhotosCaptured ## -description Occurs when all of the frames required for the advanced photo capture have been captured. ## -remarks An advanced photo capture operation may require that multiple frames be captured and processed to produce the resulting image. This event notifies you when the source frames have been captured, which allows you to initiate another advanced photo capture as soon as the capture device is available, instead of waiting for the call to [CaptureAsync](advancedphotocapture_captureasync.md) to complete, which is raised only after the image processing of the captured frames is finished. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.AdvancedPhotoCapture.AllPhotosCaptured +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AdvancedPhotoCapture.AllPhotosCaptured + +## -description +Occurs when all of the frames required for the advanced photo capture have been captured. + +## -remarks +An advanced photo capture operation may require that multiple frames be captured and processed to produce the resulting image. This event notifies you when the source frames have been captured, which allows you to initiate another advanced photo capture as soon as the capture device is available, instead of waiting for the call to [CaptureAsync](advancedphotocapture_captureasync.md) to complete, which is raised only after the image processing of the captured frames is finished. + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedphotocapture_captureasync_2078018041.md b/windows.media.capture/advancedphotocapture_captureasync_2078018041.md index a5652c8577..c059080d37 100644 --- a/windows.media.capture/advancedphotocapture_captureasync_2078018041.md +++ b/windows.media.capture/advancedphotocapture_captureasync_2078018041.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync --api-type: winrt method ---- # Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync ## -description Asynchronously performs an advanced photo capture. ## -returns An asynchronous operation that returns an [AdvancedCapturedPhoto](advancedcapturedphoto.md) upon successful completion. ## -remarks [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md) must be called before calling **CaptureAsync**. Concurrently recording video and photo capture using [AdvancedPhotoCapture](advancedphotocapture.md) is not supported. ## -examples ## -see-also [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md), [CaptureAsync(Object)](advancedphotocapture_captureasync_651770772.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync + +## -description +Asynchronously performs an advanced photo capture. + +## -returns +An asynchronous operation that returns an [AdvancedCapturedPhoto](advancedcapturedphoto.md) upon successful completion. + +## -remarks +[MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md) must be called before calling **CaptureAsync**. + +Concurrently recording video and photo capture using [AdvancedPhotoCapture](advancedphotocapture.md) is not supported. + +## -examples + +## -see-also +[MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md), [CaptureAsync(Object)](advancedphotocapture_captureasync_651770772.md) \ No newline at end of file diff --git a/windows.media.capture/advancedphotocapture_captureasync_651770772.md b/windows.media.capture/advancedphotocapture_captureasync_651770772.md index 0ddacf516d..6e794aa701 100644 --- a/windows.media.capture/advancedphotocapture_captureasync_651770772.md +++ b/windows.media.capture/advancedphotocapture_captureasync_651770772.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync(System.Object) --api-type: winrt method ---- # Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync ## -description Asynchronously performs an advanced photo capture passing the provided app-defined context object to the result of the operation. ## -parameters ### -param context An app-defined context object that passes context information to the result of the operation. ## -returns An asynchronous operation that returns an [AdvancedCapturedPhoto](advancedcapturedphoto.md) upon successful completion. ## -remarks [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md) must be called before calling **CaptureAsync**. Concurrently recording video and photo capture using [AdvancedPhotoCapture](advancedphotocapture.md) is not supported. ## -examples ## -see-also [MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md), [CaptureAsync](advancedphotocapture_captureasync_2078018041.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync(System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AdvancedPhotoCapture.CaptureAsync + +## -description +Asynchronously performs an advanced photo capture passing the provided app-defined context object to the result of the operation. + +## -parameters +### -param context +An app-defined context object that passes context information to the result of the operation. + +## -returns +An asynchronous operation that returns an [AdvancedCapturedPhoto](advancedcapturedphoto.md) upon successful completion. + +## -remarks +[MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md) must be called before calling **CaptureAsync**. + +Concurrently recording video and photo capture using [AdvancedPhotoCapture](advancedphotocapture.md) is not supported. + +## -examples + +## -see-also +[MediaCapture.PrepareAdvancedPhotoCaptureAsync](mediacapture_prepareadvancedphotocaptureasync.md), [CaptureAsync](advancedphotocapture_captureasync_2078018041.md) \ No newline at end of file diff --git a/windows.media.capture/advancedphotocapture_finishasync_1182664592.md b/windows.media.capture/advancedphotocapture_finishasync_1182664592.md index 3482c7da78..7488254a76 100644 --- a/windows.media.capture/advancedphotocapture_finishasync_1182664592.md +++ b/windows.media.capture/advancedphotocapture_finishasync_1182664592.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.AdvancedPhotoCapture.FinishAsync --api-type: winrt method ---- # Windows.Media.Capture.AdvancedPhotoCapture.FinishAsync ## -description Asynchronously releases the [AdvancedPhotoCapture](advancedphotocapture.md) object and resources used by the advanced photo capture operation. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.AdvancedPhotoCapture.FinishAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AdvancedPhotoCapture.FinishAsync + +## -description +Asynchronously releases the [AdvancedPhotoCapture](advancedphotocapture.md) object and resources used by the advanced photo capture operation. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/advancedphotocapture_optionalreferencephotocaptured.md b/windows.media.capture/advancedphotocapture_optionalreferencephotocaptured.md index 6057cc7411..54b8dea8bc 100644 --- a/windows.media.capture/advancedphotocapture_optionalreferencephotocaptured.md +++ b/windows.media.capture/advancedphotocapture_optionalreferencephotocaptured.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.AdvancedPhotoCapture.OptionalReferencePhotoCaptured --api-type: winrt event ---- # Windows.Media.Capture.AdvancedPhotoCapture.OptionalReferencePhotoCaptured ## -description Raised when a reference photo for the advanced photo operation has been captured, on devices that support this feature. ## -remarks Some devices support returning a reference photo from the capture operation that can be consumed by the calling app before all image frames for the operation have been captured or processed. On devices that do not support returning a reference photo, this event is never raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.AdvancedPhotoCapture.OptionalReferencePhotoCaptured +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AdvancedPhotoCapture.OptionalReferencePhotoCaptured + +## -description +Raised when a reference photo for the advanced photo operation has been captured, on devices that support this feature. + +## -remarks +Some devices support returning a reference photo from the capture operation that can be consumed by the calling app before all image frames for the operation have been captured or processed. On devices that do not support returning a reference photo, this event is never raised. + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapture.md b/windows.media.capture/appcapture.md index 4c22cfe235..b6348745ca 100644 --- a/windows.media.capture/appcapture.md +++ b/windows.media.capture/appcapture.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.AppCapture --api-type: winrt class ---- # Windows.Media.Capture.AppCapture ## -description Provides information about the app capture feature. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.AppCapture +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCapture + +## -description +Provides information about the app capture feature. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapture_capturingchanged.md b/windows.media.capture/appcapture_capturingchanged.md index 97b85d250e..241d60e08a 100644 --- a/windows.media.capture/appcapture_capturingchanged.md +++ b/windows.media.capture/appcapture_capturingchanged.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.Capture.AppCapture.CapturingChanged --api-type: winrt event ---- # Windows.Media.Capture.AppCapture.CapturingChanged ## -description Raised when the capturing status changes. ## -remarks > [!WARNING] > You must unregister the handler for this event went your app is suspended. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.AppCapture.CapturingChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCapture.CapturingChanged + +## -description +Raised when the capturing status changes. + +## -remarks +> [!WARNING] +> You must unregister the handler for this event went your app is suspended. + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapture_getforcurrentview_1363600702.md b/windows.media.capture/appcapture_getforcurrentview_1363600702.md index 2e8ccc59ea..fdffe2d4e2 100644 --- a/windows.media.capture/appcapture_getforcurrentview_1363600702.md +++ b/windows.media.capture/appcapture_getforcurrentview_1363600702.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.AppCapture.GetForCurrentView --api-type: winrt method ---- # Windows.Media.Capture.AppCapture.GetForCurrentView ## -description Gets the instance of this class for the current view. ## -returns The instance for the current view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.AppCapture.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCapture.GetForCurrentView + +## -description +Gets the instance of this class for the current view. + +## -returns +The instance for the current view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapture_iscapturingaudio.md b/windows.media.capture/appcapture_iscapturingaudio.md index 0003d98cfd..370d36ba18 100644 --- a/windows.media.capture/appcapture_iscapturingaudio.md +++ b/windows.media.capture/appcapture_iscapturingaudio.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.AppCapture.IsCapturingAudio --api-type: winrt property ---- # Windows.Media.Capture.AppCapture.IsCapturingAudio ## -description Gets a value indicating whether another app is currently capturing audio. ## -property-value True if another app is currently capturing audio; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCapture.IsCapturingAudio +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCapture.IsCapturingAudio + +## -description +Gets a value indicating whether another app is currently capturing audio. + +## -property-value +True if another app is currently capturing audio; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapture_iscapturingvideo.md b/windows.media.capture/appcapture_iscapturingvideo.md index 0ebb0261dc..6c6d8731e9 100644 --- a/windows.media.capture/appcapture_iscapturingvideo.md +++ b/windows.media.capture/appcapture_iscapturingvideo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.AppCapture.IsCapturingVideo --api-type: winrt property ---- # Windows.Media.Capture.AppCapture.IsCapturingVideo ## -description Gets a value indicating whether another app is currently capturing video. ## -property-value True if another app is currently capturing video; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCapture.IsCapturingVideo +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCapture.IsCapturingVideo + +## -description +Gets a value indicating whether another app is currently capturing video. + +## -property-value +True if another app is currently capturing video; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys.md b/windows.media.capture/appcapturealternateshortcutkeys.md index aa9fc330d0..da46f1a138 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys.md +++ b/windows.media.capture/appcapturealternateshortcutkeys.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.AppCaptureAlternateShortcutKeys --api-type: winrt class ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys ## -description Defines alternate shortcut keys for app capture. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks Get an instance of this class with the [AlternateShortcutKeys](appcapturesettings_alternateshortcutkeys.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.AppCaptureAlternateShortcutKeys +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys + +## -description +Defines alternate shortcut keys for app capture. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks +Get an instance of this class with the [AlternateShortcutKeys](appcapturesettings_alternateshortcutkeys.md) property. + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md index 9791abd8f2..b0eb59d7f6 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKey ## -description Gets or sets the save historical video shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The save historical video shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKey + +## -description +Gets or sets the save historical video shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The save historical video shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md index ef9dcbf10e..2ee30f9b75 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKeyModifiers ## -description Gets or sets the save historical video shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The save historical video shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.SaveHistoricalVideoKeyModifiers + +## -description +Gets or sets the save historical video shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The save historical video shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md index 37fcea6e17..4a00db87d9 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey ## -description Gets or sets the take screenshot shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The take screenshot shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey + +## -description +Gets or sets the take screenshot shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The take screenshot shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md index abdfeba522..7c2a19ef8f 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKeyModifiers ## -description Gets or sets the take screenshot shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The take screenshot shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKeyModifiers + +## -description +Gets or sets the take screenshot shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The take screenshot shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md index 848af32155..160396b291 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKey ## -description Gets or sets the toggle broadcast shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle broadcast shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKey + +## -description +Gets or sets the toggle broadcast shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle broadcast shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md index c943400c5b..a0768a7f08 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKeyModifiers ## -description Gets or sets the toggle broadcast shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle broadcast shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleBroadcastKeyModifiers + +## -description +Gets or sets the toggle broadcast shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle broadcast shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md index 8bdfa3c9f9..c315a368d0 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKey ## -description Gets or sets the toggle camera capture shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle camera capture shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKey + +## -description +Gets or sets the toggle camera capture shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle camera capture shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md index d56f9bbf14..491f67e880 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKeyModifiers ## -description Gets or sets the toggle camera capture shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle camera capture shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleCameraCaptureKeyModifiers + +## -description +Gets or sets the toggle camera capture shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle camera capture shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md index 0305c225b5..ad990c7ef9 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKey ## -description Gets or sets the toggle game bar shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle game bar shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKey + +## -description +Gets or sets the toggle game bar shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle game bar shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md index 7bf19fa9fd..22be90525f 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKeyModifiers ## -description Gets or sets the toggle game bar shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle game bar shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleGameBarKeyModifiers + +## -description +Gets or sets the toggle game bar shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle game bar shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md index ee753a8ea0..10b039dd88 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKey ## -description Gets or sets the toggle microphone capture shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle microphone capture shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKey + +## -description +Gets or sets the toggle microphone capture shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle microphone capture shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md index fb6551999d..358acaa1a1 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKeyModifiers ## -description Gets or sets the toggle microphone capture shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle microphone capture shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleMicrophoneCaptureKeyModifiers + +## -description +Gets or sets the toggle microphone capture shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle microphone capture shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md index a0bc8fb42d..6d6272ad08 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKey ## -description Gets or sets the toggle recording indicator shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle recoding indicator shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKey + +## -description +Gets or sets the toggle recording indicator shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle recoding indicator shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md index 92dfca043c..29efb80f71 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKeyModifiers ## -description Gets or sets the toggle recording indicator shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle recording indicator shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingIndicatorKeyModifiers + +## -description +Gets or sets the toggle recording indicator shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle recording indicator shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md index 07bded4236..fd15b3ee89 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKey --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKey ## -description Gets or sets the toggle recording shortcut key. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle recording shortcut key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKey + +## -description +Gets or sets the toggle recording shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle recording shortcut key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md index 45162c176d..dbf3d4dcf4 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKeyModifiers --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKeyModifiers ## -description Gets or sets the toggle recording shortcut key modifiers. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The toggle recording shortcut key modifiers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKeyModifiers +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.ToggleRecordingKeyModifiers + +## -description +Gets or sets the toggle recording shortcut key modifiers. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The toggle recording shortcut key modifiers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturemanager.md b/windows.media.capture/appcapturemanager.md index 987f25d099..e8a96655f6 100644 --- a/windows.media.capture/appcapturemanager.md +++ b/windows.media.capture/appcapturemanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.AppCaptureManager --api-type: winrt class ---- # Windows.Media.Capture.AppCaptureManager ## -description Provides access to app capture settings. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.AppCaptureManager +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureManager + +## -description +Provides access to app capture settings. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturemanager_applysettings_1739846005.md b/windows.media.capture/appcapturemanager_applysettings_1739846005.md index f24787bef8..b8524cd73a 100644 --- a/windows.media.capture/appcapturemanager_applysettings_1739846005.md +++ b/windows.media.capture/appcapturemanager_applysettings_1739846005.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.AppCaptureManager.ApplySettings(Windows.Media.Capture.AppCaptureSettings) --api-type: winrt method ---- # Windows.Media.Capture.AppCaptureManager.ApplySettings ## -description Applies app capture settings. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -parameters ### -param appCaptureSettings The settings to apply. ## -remarks ## -examples ## -see-also ## -capabilities appCaptureSettings \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.AppCaptureManager.ApplySettings(Windows.Media.Capture.AppCaptureSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureManager.ApplySettings + +## -description +Applies app capture settings. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -parameters +### -param appCaptureSettings +The settings to apply. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md b/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md index acb1e1e2ad..938f24d102 100644 --- a/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md +++ b/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Capture.AppCaptureManager.GetCurrentSettings --api-type: winrt method ---- # Windows.Media.Capture.AppCaptureManager.GetCurrentSettings ## -description Gets the current app capture settings. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -returns The current app capture settings. ## -remarks ## -examples ## -see-also ## -capabilities appCaptureSettings \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.AppCaptureManager.GetCurrentSettings +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureManager.GetCurrentSettings + +## -description +Gets the current app capture settings. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -returns +The current app capture settings. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings.md b/windows.media.capture/appcapturesettings.md index c3bd2d527f..9e0d625fea 100644 --- a/windows.media.capture/appcapturesettings.md +++ b/windows.media.capture/appcapturesettings.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.AppCaptureSettings --api-type: winrt class ---- # Windows.Media.Capture.AppCaptureSettings ## -description Represents app capture settings. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.AppCaptureSettings +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureSettings + +## -description +Represents app capture settings. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_alternateshortcutkeys.md b/windows.media.capture/appcapturesettings_alternateshortcutkeys.md index 3e2aca68a0..72f7af80e7 100644 --- a/windows.media.capture/appcapturesettings_alternateshortcutkeys.md +++ b/windows.media.capture/appcapturesettings_alternateshortcutkeys.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.AlternateShortcutKeys --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.AlternateShortcutKeys ## -description Gets the alternate shortcut key settings. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The alternate shortcut key settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.AlternateShortcutKeys +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.AlternateShortcutKeys + +## -description +Gets the alternate shortcut key settings. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The alternate shortcut key settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md b/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md index f45aedc050..974bfca4c7 100644 --- a/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md +++ b/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.AppCaptureDestinationFolder --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.AppCaptureDestinationFolder ## -description Gets or sets the app capture destination folder. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The app capture destination folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.AppCaptureDestinationFolder +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.AppCaptureDestinationFolder + +## -description +Gets or sets the app capture destination folder. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The app capture destination folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_audioencodingbitrate.md b/windows.media.capture/appcapturesettings_audioencodingbitrate.md index 6cd8758b83..3b3d15fbde 100644 --- a/windows.media.capture/appcapturesettings_audioencodingbitrate.md +++ b/windows.media.capture/appcapturesettings_audioencodingbitrate.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.AudioEncodingBitrate --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.AudioEncodingBitrate ## -description Gets or sets the audio encoding bitrate. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The audio encoding bitrate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.AudioEncodingBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.AudioEncodingBitrate + +## -description +Gets or sets the audio encoding bitrate. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The audio encoding bitrate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md b/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md index 45ae03bb07..bd305435f1 100644 --- a/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md +++ b/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingBitrate --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingBitrate ## -description Gets or sets the custom video encoding bitrate. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The custom video encoding bitrate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingBitrate + +## -description +Gets or sets the custom video encoding bitrate. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The custom video encoding bitrate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_customvideoencodingheight.md b/windows.media.capture/appcapturesettings_customvideoencodingheight.md index cf3b2a0155..2a57bf3842 100644 --- a/windows.media.capture/appcapturesettings_customvideoencodingheight.md +++ b/windows.media.capture/appcapturesettings_customvideoencodingheight.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingHeight --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingHeight ## -description Gets or sets the custom video encoding height. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The custom video encoding height. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingHeight +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingHeight + +## -description +Gets or sets the custom video encoding height. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The custom video encoding height. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_customvideoencodingwidth.md b/windows.media.capture/appcapturesettings_customvideoencodingwidth.md index efda24b252..0a675413e3 100644 --- a/windows.media.capture/appcapturesettings_customvideoencodingwidth.md +++ b/windows.media.capture/appcapturesettings_customvideoencodingwidth.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingWidth --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingWidth ## -description Gets the custom video encoding width. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The custom video encoding width. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingWidth +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.CustomVideoEncodingWidth + +## -description +Gets the custom video encoding width. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The custom video encoding width. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_hashardwareencoder.md b/windows.media.capture/appcapturesettings_hashardwareencoder.md index 9d924b773d..2e8539f1ed 100644 --- a/windows.media.capture/appcapturesettings_hashardwareencoder.md +++ b/windows.media.capture/appcapturesettings_hashardwareencoder.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.HasHardwareEncoder --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.HasHardwareEncoder ## -description Gets a value indicating if the device has a hardware encoder. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if the device has a hardware encoder; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.HasHardwareEncoder +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.HasHardwareEncoder + +## -description +Gets a value indicating if the device has a hardware encoder. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if the device has a hardware encoder; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_historicalbufferlength.md b/windows.media.capture/appcapturesettings_historicalbufferlength.md index 1bde13179f..3a1e0ba698 100644 --- a/windows.media.capture/appcapturesettings_historicalbufferlength.md +++ b/windows.media.capture/appcapturesettings_historicalbufferlength.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLength --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLength ## -description Gets or sets the historical buffer length. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The historical buffer length. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLength +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLength + +## -description +Gets or sets the historical buffer length. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The historical buffer length. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md b/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md index 31cc666722..a87dcb91a0 100644 --- a/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md +++ b/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLengthUnit --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLengthUnit ## -description Gets or sets the units of the historical buffer length. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The units of the historical buffer length. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLengthUnit +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.HistoricalBufferLengthUnit + +## -description +Gets or sets the units of the historical buffer length. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The units of the historical buffer length. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_isappcaptureenabled.md b/windows.media.capture/appcapturesettings_isappcaptureenabled.md index 577a29d4b2..1f7cd4e36b 100644 --- a/windows.media.capture/appcapturesettings_isappcaptureenabled.md +++ b/windows.media.capture/appcapturesettings_isappcaptureenabled.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsAppCaptureEnabled --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsAppCaptureEnabled ## -description Gets or sets a value indicating if app capture is enabled. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if app capture is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsAppCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsAppCaptureEnabled + +## -description +Gets or sets a value indicating if app capture is enabled. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if app capture is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md b/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md index 8e03044574..eaf8a353cb 100644 --- a/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md +++ b/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsAudioCaptureEnabled --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsAudioCaptureEnabled ## -description Gets or sets a value indicating whether audio capture is enabled. ## -property-value True if audio capture is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsAudioCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsAudioCaptureEnabled + +## -description +Gets or sets a value indicating whether audio capture is enabled. + +## -property-value +True if audio capture is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_iscpuconstrained.md b/windows.media.capture/appcapturesettings_iscpuconstrained.md index 2401a47b9f..891b9cee39 100644 --- a/windows.media.capture/appcapturesettings_iscpuconstrained.md +++ b/windows.media.capture/appcapturesettings_iscpuconstrained.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsCpuConstrained --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsCpuConstrained ## -description Gets a value indicating if app capture is CPU-constrained. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if app capture is CPU-constrained; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsCpuConstrained +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsCpuConstrained + +## -description +Gets a value indicating if app capture is CPU-constrained. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if app capture is CPU-constrained; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_isdisabledbypolicy.md b/windows.media.capture/appcapturesettings_isdisabledbypolicy.md index 8adc7f46dd..6ea9005495 100644 --- a/windows.media.capture/appcapturesettings_isdisabledbypolicy.md +++ b/windows.media.capture/appcapturesettings_isdisabledbypolicy.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsDisabledByPolicy --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsDisabledByPolicy ## -description Gets a value indicating if app capture is disabled by policy. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if app capture is disabled by policy; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsDisabledByPolicy +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsDisabledByPolicy + +## -description +Gets a value indicating if app capture is disabled by policy. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if app capture is disabled by policy; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_isgpuconstrained.md b/windows.media.capture/appcapturesettings_isgpuconstrained.md index a133e4e5ee..3aeaeecd30 100644 --- a/windows.media.capture/appcapturesettings_isgpuconstrained.md +++ b/windows.media.capture/appcapturesettings_isgpuconstrained.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsGpuConstrained --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsGpuConstrained ## -description Gets a value indicating if app capture is GPU-constrained. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if app capture is GPU-constrained; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsGpuConstrained +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsGpuConstrained + +## -description +Gets a value indicating if app capture is GPU-constrained. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if app capture is GPU-constrained; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md b/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md index ea40c9a8f7..dd021aaed9 100644 --- a/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md +++ b/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureEnabled --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureEnabled ## -description Gets or sets a value indicating if historical capture is enabled. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if historical capture is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureEnabled + +## -description +Gets or sets a value indicating if historical capture is enabled. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if historical capture is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md b/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md index a03cb75f99..7cb69bd203 100644 --- a/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md +++ b/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnBatteryAllowed --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnBatteryAllowed ## -description Gets or sets a value indicating whether historical capture is allowed while the device is on battery power. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if historical capture is allowed while the device is on battery power; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnBatteryAllowed +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnBatteryAllowed + +## -description +Gets or sets a value indicating whether historical capture is allowed while the device is on battery power. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if historical capture is allowed while the device is on battery power; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md b/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md index c33f3777b5..8beac81884 100644 --- a/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md +++ b/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnWirelessDisplayAllowed --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnWirelessDisplayAllowed ## -description Gets or sets a value indicating whether historical capture is allowed on wireless displays. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if historical capture is allowed on wireless displays; otherwise, true. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnWirelessDisplayAllowed +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsHistoricalCaptureOnWirelessDisplayAllowed + +## -description +Gets or sets a value indicating whether historical capture is allowed on wireless displays. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if historical capture is allowed on wireless displays; otherwise, true. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_ismemoryconstrained.md b/windows.media.capture/appcapturesettings_ismemoryconstrained.md index bd2b7ebf9b..a6a8292dff 100644 --- a/windows.media.capture/appcapturesettings_ismemoryconstrained.md +++ b/windows.media.capture/appcapturesettings_ismemoryconstrained.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsMemoryConstrained --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsMemoryConstrained ## -description Gets a value indicating whether the device is memory-constrained. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if the device is memory-constrained; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsMemoryConstrained +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsMemoryConstrained + +## -description +Gets a value indicating whether the device is memory-constrained. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if the device is memory-constrained; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md index 0ff9db7bf5..3f1accb16d 100644 --- a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md +++ b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabled --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabled ## -description Gets or sets a value indicating if microphone capture is enabled. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if microphone capture is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabled + +## -description +Gets or sets a value indicating if microphone capture is enabled. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if microphone capture is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md index 219163b104..c02c2f7d3c 100644 --- a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md +++ b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabledByDefault --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabledByDefault ## -description Gets or sets a value indicating if microphone capture is enabled by default. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value True if microphone capture is enabled by default; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabledByDefault +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsMicrophoneCaptureEnabledByDefault + +## -description +Gets or sets a value indicating if microphone capture is enabled by default. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +True if microphone capture is enabled by default; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_maximumrecordlength.md b/windows.media.capture/appcapturesettings_maximumrecordlength.md index cab075dcb6..631a4cfd1e 100644 --- a/windows.media.capture/appcapturesettings_maximumrecordlength.md +++ b/windows.media.capture/appcapturesettings_maximumrecordlength.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.MaximumRecordLength --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.MaximumRecordLength ## -description Gets or sets the maximum recording length. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The maximum recording length. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.MaximumRecordLength +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.MaximumRecordLength + +## -description +Gets or sets the maximum recording length. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The maximum recording length. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_microphonegain.md b/windows.media.capture/appcapturesettings_microphonegain.md index da21fc2e59..a29e63fc72 100644 --- a/windows.media.capture/appcapturesettings_microphonegain.md +++ b/windows.media.capture/appcapturesettings_microphonegain.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.MicrophoneGain --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.MicrophoneGain ## -description Gets or sets a value specifying the gain applied to the microphone audio. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The gain applied to the microphone audio. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.MicrophoneGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.MicrophoneGain + +## -description +Gets or sets a value specifying the gain applied to the microphone audio. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The gain applied to the microphone audio. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md b/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md index 18a4294e4b..129efbb036 100644 --- a/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md +++ b/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.ScreenshotDestinationFolder --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.ScreenshotDestinationFolder ## -description Gets or sets the screenshot destination folder. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The screenshot destination folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.ScreenshotDestinationFolder +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.ScreenshotDestinationFolder + +## -description +Gets or sets the screenshot destination folder. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The screenshot destination folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_systemaudiogain.md b/windows.media.capture/appcapturesettings_systemaudiogain.md index ce4a4d0ccc..22990b694b 100644 --- a/windows.media.capture/appcapturesettings_systemaudiogain.md +++ b/windows.media.capture/appcapturesettings_systemaudiogain.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.SystemAudioGain --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.SystemAudioGain ## -description Gets or sets a value specifying the gain applied to the system audio. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The gain applied to the system audio. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.SystemAudioGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.SystemAudioGain + +## -description +Gets or sets a value specifying the gain applied to the system audio. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The gain applied to the system audio. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_videoencodingbitratemode.md b/windows.media.capture/appcapturesettings_videoencodingbitratemode.md index e07cd92d60..f443d0f3db 100644 --- a/windows.media.capture/appcapturesettings_videoencodingbitratemode.md +++ b/windows.media.capture/appcapturesettings_videoencodingbitratemode.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.VideoEncodingBitrateMode --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.VideoEncodingBitrateMode ## -description Gets or sets the video encoding bitrate. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The video encoding bitrate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.VideoEncodingBitrateMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.VideoEncodingBitrateMode + +## -description +Gets or sets the video encoding bitrate. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The video encoding bitrate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_videoencodingframeratemode.md b/windows.media.capture/appcapturesettings_videoencodingframeratemode.md index c5c9862e8e..34736714b4 100644 --- a/windows.media.capture/appcapturesettings_videoencodingframeratemode.md +++ b/windows.media.capture/appcapturesettings_videoencodingframeratemode.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.VideoEncodingFrameRateMode --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.VideoEncodingFrameRateMode ## -description Gets or sets a value indicating the video encoding frame rate mode. > [!NOTE] > This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. ## -property-value The video encoding frame rate mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.VideoEncodingFrameRateMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.VideoEncodingFrameRateMode + +## -description +Gets or sets a value indicating the video encoding frame rate mode. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The video encoding frame rate mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md b/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md index e49ca13f2a..084e10bf2d 100644 --- a/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md +++ b/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.AppCaptureSettings.VideoEncodingResolutionMode --api-type: winrt property ---- # Windows.Media.Capture.AppCaptureSettings.VideoEncodingResolutionMode ## -description Gets or sets the video encoding resolution mode. ## -property-value The video encoding resolution mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.VideoEncodingResolutionMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.VideoEncodingResolutionMode + +## -description +Gets or sets the video encoding resolution mode. + +## -property-value +The video encoding resolution mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/cameracaptureui_cameracaptureui_1221375020.md b/windows.media.capture/cameracaptureui_cameracaptureui_1221375020.md index 89c6258a13..5c9ab1be66 100644 --- a/windows.media.capture/cameracaptureui_cameracaptureui_1221375020.md +++ b/windows.media.capture/cameracaptureui_cameracaptureui_1221375020.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Capture.CameraCaptureUI.#ctor --api-type: winrt method ---- # Windows.Media.Capture.CameraCaptureUI.CameraCaptureUI ## -description Create a new [CameraCaptureUI](cameracaptureui.md) object. ## -remarks After you create a new [CameraCaptureUI](cameracaptureui.md) object, you may want to set the [PhotoSettings](cameracaptureui_photosettings.md) or [VideoSettings](cameracaptureui_videosettings.md) property of the object before calling [CaptureFileAsync](cameracaptureui_capturefileasync.md). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CameraCaptureUI.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CameraCaptureUI.CameraCaptureUI + +## -description +Create a new [CameraCaptureUI](cameracaptureui.md) object. + +## -remarks +After you create a new [CameraCaptureUI](cameracaptureui.md) object, you may want to set the [PhotoSettings](cameracaptureui_photosettings.md) or [VideoSettings](cameracaptureui_videosettings.md) property of the object before calling [CaptureFileAsync](cameracaptureui_capturefileasync.md). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureui_capturefileasync_1903527183.md b/windows.media.capture/cameracaptureui_capturefileasync_1903527183.md index 2decacf71f..28eb3e27ed 100644 --- a/windows.media.capture/cameracaptureui_capturefileasync_1903527183.md +++ b/windows.media.capture/cameracaptureui_capturefileasync_1903527183.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Capture.CameraCaptureUI.CaptureFileAsync(Windows.Media.Capture.CameraCaptureUIMode) --api-type: winrt method ---- # Windows.Media.Capture.CameraCaptureUI.CaptureFileAsync ## -description Launches the [CameraCaptureUI](cameracaptureui.md) user interface. ## -parameters ### -param mode Specifies whether the user interface that will be shown allows the user to capture a photo, capture a video, or capture both photos and videos. ## -returns When this operation completes, a [StorageFile](../windows.storage/storagefile.md) object is returned. ## -remarks Call [CaptureFileAsync](cameracaptureui_capturefileasync.md) to launch the UI. The user has control over when to start the capture. When the asynchronous operation completes, a [StorageFile](../windows.storage/storagefile.md) object is returned. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CameraCaptureUI.CaptureFileAsync(Windows.Media.Capture.CameraCaptureUIMode) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CameraCaptureUI.CaptureFileAsync + +## -description +Launches the [CameraCaptureUI](cameracaptureui.md) user interface. + +## -parameters +### -param mode +Specifies whether the user interface that will be shown allows the user to capture a photo, capture a video, or capture both photos and videos. + +## -returns +When this operation completes, a [StorageFile](../windows.storage/storagefile.md) object is returned. + +## -remarks +Call [CaptureFileAsync](cameracaptureui_capturefileasync.md) to launch the UI. The user has control over when to start the capture. When the asynchronous operation completes, a [StorageFile](../windows.storage/storagefile.md) object is returned. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureui_photosettings.md b/windows.media.capture/cameracaptureui_photosettings.md index dd66d82cce..9c745efdfd 100644 --- a/windows.media.capture/cameracaptureui_photosettings.md +++ b/windows.media.capture/cameracaptureui_photosettings.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUI.PhotoSettings --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUI.PhotoSettings ## -description Provides settings for capturing photos. The settings include aspect ratio, image size, format, resolution, and whether or not cropping is allowed by the user interface (UI). ## -property-value An object containing settings for capturing photos. ## -remarks For information on the available photo capture settings, see [CameraCaptureUIPhotoCaptureSettings](cameracaptureuiphotocapturesettings.md). ## -examples ## -see-also [CameraCaptureUIPhotoCaptureSettings](cameracaptureuiphotocapturesettings.md) ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUI.PhotoSettings +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUI.PhotoSettings + +## -description +Provides settings for capturing photos. The settings include aspect ratio, image size, format, resolution, and whether or not cropping is allowed by the user interface (UI). + +## -property-value +An object containing settings for capturing photos. + +## -remarks +For information on the available photo capture settings, see [CameraCaptureUIPhotoCaptureSettings](cameracaptureuiphotocapturesettings.md). + +## -examples + +## -see-also +[CameraCaptureUIPhotoCaptureSettings](cameracaptureuiphotocapturesettings.md) + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureui_videosettings.md b/windows.media.capture/cameracaptureui_videosettings.md index 54a777d298..448b26a5eb 100644 --- a/windows.media.capture/cameracaptureui_videosettings.md +++ b/windows.media.capture/cameracaptureui_videosettings.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUI.VideoSettings --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUI.VideoSettings ## -description Provides settings for capturing videos. The settings include format, maximum resolution, maximum duration, and whether or not to allow trimming. ## -property-value An object that provides settings for capturing videos. ## -remarks For information on the available video capture settings, see [CameraCaptureUIVideoCaptureSettings](cameracaptureuivideocapturesettings.md). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUI.VideoSettings +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUI.VideoSettings + +## -description +Provides settings for capturing videos. The settings include format, maximum resolution, maximum duration, and whether or not to allow trimming. + +## -property-value +An object that provides settings for capturing videos. + +## -remarks +For information on the available video capture settings, see [CameraCaptureUIVideoCaptureSettings](cameracaptureuivideocapturesettings.md). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuiphotocapturesettings_allowcropping.md b/windows.media.capture/cameracaptureuiphotocapturesettings_allowcropping.md index a9bb8c638c..1e82f64bc4 100644 --- a/windows.media.capture/cameracaptureuiphotocapturesettings_allowcropping.md +++ b/windows.media.capture/cameracaptureuiphotocapturesettings_allowcropping.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.AllowCropping --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.AllowCropping ## -description Determines whether photo cropping will be enabled in the user interface for capture a photo. ## -property-value True, if photo cropping will be enabled; otherwise, false. ## -remarks Imaging cropping in the **CameraCaptureUI** is not supported for devices in the Mobile device family. The value of the **AllowCropping** property is ignored when your app is running on these devices. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.AllowCropping +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.AllowCropping + +## -description +Determines whether photo cropping will be enabled in the user interface for capture a photo. + +## -property-value +True, if photo cropping will be enabled; otherwise, false. + +## -remarks +Imaging cropping in the **CameraCaptureUI** is not supported for devices in the Mobile device family. The value of the **AllowCropping** property is ignored when your app is running on these devices. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuiphotocapturesettings_croppedaspectratio.md b/windows.media.capture/cameracaptureuiphotocapturesettings_croppedaspectratio.md index 662805f578..c35c11eaac 100644 --- a/windows.media.capture/cameracaptureuiphotocapturesettings_croppedaspectratio.md +++ b/windows.media.capture/cameracaptureuiphotocapturesettings_croppedaspectratio.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedAspectRatio --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedAspectRatio ## -description The aspect ratio of the captured photo. ## -property-value The aspect ratio of the captured photo. If zero, the aspect ratio is not enforced. ## -remarks Imaging cropping in the [CameraCaptureUI](cameracaptureui.md) is not supported for devices in the Mobile device family. The value of the **CroppedAspectRatio** property is ignored when your app is running on these devices. If a non-zero value is provided, the user interface will force the user to crop the photo to the specified aspect ratio. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedAspectRatio +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedAspectRatio + +## -description +The aspect ratio of the captured photo. + +## -property-value +The aspect ratio of the captured photo. If zero, the aspect ratio is not enforced. + +## -remarks +Imaging cropping in the [CameraCaptureUI](cameracaptureui.md) is not supported for devices in the Mobile device family. The value of the **CroppedAspectRatio** property is ignored when your app is running on these devices. + +If a non-zero value is provided, the user interface will force the user to crop the photo to the specified aspect ratio. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuiphotocapturesettings_croppedsizeinpixels.md b/windows.media.capture/cameracaptureuiphotocapturesettings_croppedsizeinpixels.md index d21cda23dd..cedec9406c 100644 --- a/windows.media.capture/cameracaptureuiphotocapturesettings_croppedsizeinpixels.md +++ b/windows.media.capture/cameracaptureuiphotocapturesettings_croppedsizeinpixels.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedSizeInPixels --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedSizeInPixels ## -description The exact size in pixels of the captured photo. ## -property-value The size of the captured photo. ## -remarks Imaging cropping in the [CameraCaptureUI](cameracaptureui.md) is not supported for devices in the Mobile device family. The value of the **CroppedSizeInPixels** property is ignored when your app is running on these devices. If size is provided, the user interface for cropping photos will force the user to crop the photo to the specified size. If a size is specified that is larger than any available resolution, then the captured photo will be scaled to a large enough size first. Setting this property requires that the [MaxResolution](cameracaptureuiphotocapturesettings_maxresolution.md) property is set to **HighestAvailable** and the [AllowCropping](cameracaptureuiphotocapturesettings_allowcropping.md) property is set to True. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedSizeInPixels +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.CroppedSizeInPixels + +## -description +The exact size in pixels of the captured photo. + +## -property-value +The size of the captured photo. + +## -remarks +Imaging cropping in the [CameraCaptureUI](cameracaptureui.md) is not supported for devices in the Mobile device family. The value of the **CroppedSizeInPixels** property is ignored when your app is running on these devices. + +If size is provided, the user interface for cropping photos will force the user to crop the photo to the specified size. + +If a size is specified that is larger than any available resolution, then the captured photo will be scaled to a large enough size first. + +Setting this property requires that the [MaxResolution](cameracaptureuiphotocapturesettings_maxresolution.md) property is set to **HighestAvailable** and the [AllowCropping](cameracaptureuiphotocapturesettings_allowcropping.md) property is set to True. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuiphotocapturesettings_format.md b/windows.media.capture/cameracaptureuiphotocapturesettings_format.md index e0ff70e6d9..a1d72fae37 100644 --- a/windows.media.capture/cameracaptureuiphotocapturesettings_format.md +++ b/windows.media.capture/cameracaptureuiphotocapturesettings_format.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.Format --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.Format ## -description Determines the format that captured photos will be stored in. ## -property-value A value that indicates the format for captured photos. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.Format +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.Format + +## -description +Determines the format that captured photos will be stored in. + +## -property-value +A value that indicates the format for captured photos. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuiphotocapturesettings_maxresolution.md b/windows.media.capture/cameracaptureuiphotocapturesettings_maxresolution.md index e2c61f72ea..ee39759b4b 100644 --- a/windows.media.capture/cameracaptureuiphotocapturesettings_maxresolution.md +++ b/windows.media.capture/cameracaptureuiphotocapturesettings_maxresolution.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.MaxResolution --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.MaxResolution ## -description Determines the maximum resolution the user will be able to select. ## -property-value A value that indicates the maximum resolution the user will be able to select. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.MaxResolution +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings.MaxResolution + +## -description +Determines the maximum resolution the user will be able to select. + +## -property-value +A value that indicates the maximum resolution the user will be able to select. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuivideocapturesettings_allowtrimming.md b/windows.media.capture/cameracaptureuivideocapturesettings_allowtrimming.md index 3182337ef5..6e76606904 100644 --- a/windows.media.capture/cameracaptureuivideocapturesettings_allowtrimming.md +++ b/windows.media.capture/cameracaptureuivideocapturesettings_allowtrimming.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.AllowTrimming --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.AllowTrimming ## -description Determines whether or not the video trimming user interface will be enabled. ## -property-value True, if the user will be allowed to trim videos; otherwise, false. ## -remarks Video trimming in the **CameraCaptureUI** is not supported for devices in the Mobile device family. The value of the **AllowTrimming** property is ignored when your app is running on these devices. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.AllowTrimming +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.AllowTrimming + +## -description +Determines whether or not the video trimming user interface will be enabled. + +## -property-value +True, if the user will be allowed to trim videos; otherwise, false. + +## -remarks +Video trimming in the **CameraCaptureUI** is not supported for devices in the Mobile device family. The value of the **AllowTrimming** property is ignored when your app is running on these devices. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuivideocapturesettings_format.md b/windows.media.capture/cameracaptureuivideocapturesettings_format.md index 6ab7c93b91..67acfd1d0b 100644 --- a/windows.media.capture/cameracaptureuivideocapturesettings_format.md +++ b/windows.media.capture/cameracaptureuivideocapturesettings_format.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.Format --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.Format ## -description Determines the format for storing captured videos. ## -property-value A value indicating the format for storing captured videos. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.Format +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.Format + +## -description +Determines the format for storing captured videos. + +## -property-value +A value indicating the format for storing captured videos. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuivideocapturesettings_maxdurationinseconds.md b/windows.media.capture/cameracaptureuivideocapturesettings_maxdurationinseconds.md index e6e7038d38..6bf333a93a 100644 --- a/windows.media.capture/cameracaptureuivideocapturesettings_maxdurationinseconds.md +++ b/windows.media.capture/cameracaptureuivideocapturesettings_maxdurationinseconds.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxDurationInSeconds --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxDurationInSeconds ## -description Determines the maximum duration of a video. ## -property-value The maximum duration of a video. If this property is set to zero, no maximum duration is enforced. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxDurationInSeconds +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxDurationInSeconds + +## -description +Determines the maximum duration of a video. + +## -property-value +The maximum duration of a video. If this property is set to zero, no maximum duration is enforced. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameracaptureuivideocapturesettings_maxresolution.md b/windows.media.capture/cameracaptureuivideocapturesettings_maxresolution.md index ec4ebb909d..ae4b423df7 100644 --- a/windows.media.capture/cameracaptureuivideocapturesettings_maxresolution.md +++ b/windows.media.capture/cameracaptureuivideocapturesettings_maxresolution.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxResolution --api-type: winrt property ---- # Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxResolution ## -description Determines the maximum resolution that the user can select. ## -property-value The maximum resolution that the user can select. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxResolution +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings.MaxResolution + +## -description +Determines the maximum resolution that the user can select. + +## -property-value +The maximum resolution that the user can select. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/cameraoptionsui_show_30375942.md b/windows.media.capture/cameraoptionsui_show_30375942.md index 93ac73dd21..de81c412ba 100644 --- a/windows.media.capture/cameraoptionsui_show_30375942.md +++ b/windows.media.capture/cameraoptionsui_show_30375942.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Capture.CameraOptionsUI.Show(Windows.Media.Capture.MediaCapture) --api-type: winrt method ---- # Windows.Media.Capture.CameraOptionsUI.Show ## -description Displays a UI that contains options for the capture of photos, audio recordings and videos. ## -parameters ### -param mediaCapture The [MediaCapture](mediacapture.md) object that provides methods for the capture of photos, audio recordings and videos. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CameraOptionsUI.Show(Windows.Media.Capture.MediaCapture) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CameraOptionsUI.Show + +## -description +Displays a UI that contains options for the capture of photos, audio recordings and videos. + +## -parameters +### -param mediaCapture +The [MediaCapture](mediacapture.md) object that provides methods for the capture of photos, audio recordings and videos. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/capturedframe.md b/windows.media.capture/capturedframe.md index ac32f7abf1..8c655287e8 100644 --- a/windows.media.capture/capturedframe.md +++ b/windows.media.capture/capturedframe.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.CapturedFrame --api-type: winrt class ---- # Windows.Media.Capture.CapturedFrame ## -description Represents a captured video frame. ## -remarks ## -examples ## -see-also [IRandomAccessStreamWithContentType](../windows.storage.streams/irandomaccessstreamwithcontenttype.md), [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md), [IClosable](../windows.foundation/iclosable.md), [IInputStream](../windows.storage.streams/iinputstream.md), [IOutputStream](../windows.storage.streams/ioutputstream.md), [IContentTypeProvider](../windows.storage.streams/icontenttypeprovider.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.CapturedFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.CapturedFrame + +## -description +Represents a captured video frame. + +## -remarks + +## -examples + +## -see-also +[IRandomAccessStreamWithContentType](../windows.storage.streams/irandomaccessstreamwithcontenttype.md), [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md), [IClosable](../windows.foundation/iclosable.md), [IInputStream](../windows.storage.streams/iinputstream.md), [IOutputStream](../windows.storage.streams/ioutputstream.md), [IContentTypeProvider](../windows.storage.streams/icontenttypeprovider.md) \ No newline at end of file diff --git a/windows.media.capture/capturedframe_canread.md b/windows.media.capture/capturedframe_canread.md index f652f038b1..1200d66e7f 100644 --- a/windows.media.capture/capturedframe_canread.md +++ b/windows.media.capture/capturedframe_canread.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.CanRead --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.CanRead ## -description Gets a value that indicates if the captured frame can be read from. ## -property-value **true** if the captured frame can be read from; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.CanRead +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.CanRead + +## -description +Gets a value that indicates if the captured frame can be read from. + +## -property-value +**true** if the captured frame can be read from; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_canwrite.md b/windows.media.capture/capturedframe_canwrite.md index 643135961d..94e020a1d8 100644 --- a/windows.media.capture/capturedframe_canwrite.md +++ b/windows.media.capture/capturedframe_canwrite.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.CanWrite --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.CanWrite ## -description Gets a value that indicates if the captured frame can be written to. ## -property-value **true** if the captured frame can be written to; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.CanWrite +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.CanWrite + +## -description +Gets a value that indicates if the captured frame can be written to. + +## -property-value +**true** if the captured frame can be written to; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_clonestream_242904981.md b/windows.media.capture/capturedframe_clonestream_242904981.md index 02a0defef0..0054349b90 100644 --- a/windows.media.capture/capturedframe_clonestream_242904981.md +++ b/windows.media.capture/capturedframe_clonestream_242904981.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.CloneStream --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.CloneStream ## -description Creates a copy of the stream. ## -returns The clone of the strem. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.CloneStream +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.CloneStream + +## -description +Creates a copy of the stream. + +## -returns +The clone of the strem. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_close_811482585.md b/windows.media.capture/capturedframe_close_811482585.md index fe1a0fe956..3d45b3ab7a 100644 --- a/windows.media.capture/capturedframe_close_811482585.md +++ b/windows.media.capture/capturedframe_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.Close --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.Close ## -description Closes the captured framed object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.Close + +## -description +Closes the captured framed object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_contenttype.md b/windows.media.capture/capturedframe_contenttype.md index 527c763444..c185a757e0 100644 --- a/windows.media.capture/capturedframe_contenttype.md +++ b/windows.media.capture/capturedframe_contenttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.ContentType --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.ContentType ## -description Gets the content type of the captured frame. ## -property-value The content type of the captured frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.ContentType +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.ContentType + +## -description +Gets the content type of the captured frame. + +## -property-value +The content type of the captured frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_flushasync_491532439.md b/windows.media.capture/capturedframe_flushasync_491532439.md index 96280ee46b..2e69508cf3 100644 --- a/windows.media.capture/capturedframe_flushasync_491532439.md +++ b/windows.media.capture/capturedframe_flushasync_491532439.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.FlushAsync --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.FlushAsync ## -description Asynchronously commits and flushes all of the data of the [CapturedFrame](capturedframe.md). ## -returns When this method completes, a boolean value is returned which specifies **true** if the operation completed successfully; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.FlushAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.FlushAsync + +## -description +Asynchronously commits and flushes all of the data of the [CapturedFrame](capturedframe.md). + +## -returns +When this method completes, a boolean value is returned which specifies **true** if the operation completed successfully; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_getinputstreamat_1916887525.md b/windows.media.capture/capturedframe_getinputstreamat_1916887525.md index 1221319893..c121ba2a44 100644 --- a/windows.media.capture/capturedframe_getinputstreamat_1916887525.md +++ b/windows.media.capture/capturedframe_getinputstreamat_1916887525.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.GetInputStreamAt(System.UInt64) --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.GetInputStreamAt ## -description Gets the input stream at the specified position. ## -parameters ### -param position The position in the input stream. ## -returns The input stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.GetInputStreamAt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.GetInputStreamAt + +## -description +Gets the input stream at the specified position. + +## -parameters +### -param position +The position in the input stream. + +## -returns +The input stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_getoutputstreamat_379282997.md b/windows.media.capture/capturedframe_getoutputstreamat_379282997.md index 6a9f834552..b59ab33c45 100644 --- a/windows.media.capture/capturedframe_getoutputstreamat_379282997.md +++ b/windows.media.capture/capturedframe_getoutputstreamat_379282997.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.GetOutputStreamAt(System.UInt64) --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.GetOutputStreamAt ## -description Gets the output stream at the specified position. ## -parameters ### -param position The position in the output stream. ## -returns The output stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.GetOutputStreamAt(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.GetOutputStreamAt + +## -description +Gets the output stream at the specified position. + +## -parameters +### -param position +The position in the output stream. + +## -returns +The output stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_height.md b/windows.media.capture/capturedframe_height.md index b072aa8318..15053d9114 100644 --- a/windows.media.capture/capturedframe_height.md +++ b/windows.media.capture/capturedframe_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.Height --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.Height ## -description Gets the height of the captured frame ## -property-value The height of the frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.Height +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.Height + +## -description +Gets the height of the captured frame + +## -property-value +The height of the frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_position.md b/windows.media.capture/capturedframe_position.md index 880149aab0..39762011a4 100644 --- a/windows.media.capture/capturedframe_position.md +++ b/windows.media.capture/capturedframe_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.Position --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.Position ## -description Gets the position of the captured frame. ## -property-value The position of the captured frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.Position +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.Position + +## -description +Gets the position of the captured frame. + +## -property-value +The position of the captured frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_readasync_1012630619.md b/windows.media.capture/capturedframe_readasync_1012630619.md index 4cd66738f5..a4f0a0b3ff 100644 --- a/windows.media.capture/capturedframe_readasync_1012630619.md +++ b/windows.media.capture/capturedframe_readasync_1012630619.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.ReadAsync(Windows.Storage.Streams.IBuffer,System.UInt32,Windows.Storage.Streams.InputStreamOptions) --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.ReadAsync ## -description Returns an asynchronous byte reader object. ## -parameters ### -param buffer The buffer into which the asynchronous read operation places the bytes that are read. ### -param count The number of bytes to read that is less than or equal to the [Capacity](http://msdn.microsoft.com/library/79f2f46c-3cf5-4926-8e62-6b578550f9a8) value. ### -param options Specifies the type of the asynchronous read operation. ## -returns The asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.ReadAsync(Windows.Storage.Streams.IBuffer,System.UInt32,Windows.Storage.Streams.InputStreamOptions) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.ReadAsync + +## -description +Returns an asynchronous byte reader object. + +## -parameters +### -param buffer +The buffer into which the asynchronous read operation places the bytes that are read. + +### -param count +The number of bytes to read that is less than or equal to the [Capacity](http://msdn.microsoft.com/library/79f2f46c-3cf5-4926-8e62-6b578550f9a8) value. + +### -param options +Specifies the type of the asynchronous read operation. + +## -returns +The asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_seek_1797934981.md b/windows.media.capture/capturedframe_seek_1797934981.md index 433996b008..64d600437b 100644 --- a/windows.media.capture/capturedframe_seek_1797934981.md +++ b/windows.media.capture/capturedframe_seek_1797934981.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.Seek(System.UInt64) --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.Seek ## -description Seeks the stream to the specified position. ## -parameters ### -param position The position in the stream to seek too. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.Seek(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.Seek + +## -description +Seeks the stream to the specified position. + +## -parameters +### -param position +The position in the stream to seek too. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_size.md b/windows.media.capture/capturedframe_size.md index 318d88ee8a..bd31453853 100644 --- a/windows.media.capture/capturedframe_size.md +++ b/windows.media.capture/capturedframe_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.Size --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.Size ## -description Gets the size of the captured frame in bytes. ## -property-value The size of the captured frame in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.Size +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.Size + +## -description +Gets the size of the captured frame in bytes. + +## -property-value +The size of the captured frame in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_softwarebitmap.md b/windows.media.capture/capturedframe_softwarebitmap.md index 65f68d1ad2..07ceefbac7 100644 --- a/windows.media.capture/capturedframe_softwarebitmap.md +++ b/windows.media.capture/capturedframe_softwarebitmap.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.SoftwareBitmap --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.SoftwareBitmap ## -description Gets a [SoftwareBitmap](capturedframe_softwarebitmap.md) object representing the captured frame. ## -property-value A [SoftwareBitmap](capturedframe_softwarebitmap.md) object representing the captured frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.SoftwareBitmap +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.SoftwareBitmap + +## -description +Gets a [SoftwareBitmap](capturedframe_softwarebitmap.md) object representing the captured frame. + +## -property-value +A [SoftwareBitmap](capturedframe_softwarebitmap.md) object representing the captured frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_width.md b/windows.media.capture/capturedframe_width.md index 3af9a2213e..304b63d7b9 100644 --- a/windows.media.capture/capturedframe_width.md +++ b/windows.media.capture/capturedframe_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrame.Width --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrame.Width ## -description Gets the width of the captured frame. ## -property-value The width of the captured frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrame.Width +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrame.Width + +## -description +Gets the width of the captured frame. + +## -property-value +The width of the captured frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframe_writeasync_897036872.md b/windows.media.capture/capturedframe_writeasync_897036872.md index 0bdc34b2cc..44aa1314a2 100644 --- a/windows.media.capture/capturedframe_writeasync_897036872.md +++ b/windows.media.capture/capturedframe_writeasync_897036872.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.CapturedFrame.WriteAsync(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Media.Capture.CapturedFrame.WriteAsync ## -description Asynchronously writes the specified data to the stream. ## -parameters ### -param buffer The data to write to the stream. ## -returns Represents an asynchronous operation that returns a result and reports progress. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.CapturedFrame.WriteAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.CapturedFrame.WriteAsync + +## -description +Asynchronously writes the specified data to the stream. + +## -parameters +### -param buffer +The data to write to the stream. + +## -returns +Represents an asynchronous operation that returns a result and reports progress. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues.md b/windows.media.capture/capturedframecontrolvalues.md index 5cb182885a..5e5cb3f9cd 100644 --- a/windows.media.capture/capturedframecontrolvalues.md +++ b/windows.media.capture/capturedframecontrolvalues.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.CapturedFrameControlValues --api-type: winrt class ---- # Windows.Media.Capture.CapturedFrameControlValues ## -description Provides information about the capture device settings that were used for a frame in a variable photo sequence. ## -remarks Get an instance of this class by handling the [VariablePhotoCaptured](../windows.media.capture.core/variablephotocapturedeventargs.md) event and then accessing the [VariablePhotoCapturedEventArgs.CapturedFrameControlValues](../windows.media.capture.core/variablephotocapturedeventargs_capturedframecontrolvalues.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.CapturedFrameControlValues +-api-type: winrt class +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues + +## -description +Provides information about the capture device settings that were used for a frame in a variable photo sequence. + +## -remarks +Get an instance of this class by handling the [VariablePhotoCaptured](../windows.media.capture.core/variablephotocapturedeventargs.md) event and then accessing the [VariablePhotoCapturedEventArgs.CapturedFrameControlValues](../windows.media.capture.core/variablephotocapturedeventargs_capturedframecontrolvalues.md) property. + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_exposure.md b/windows.media.capture/capturedframecontrolvalues_exposure.md index 36ba155a96..0c154736db 100644 --- a/windows.media.capture/capturedframecontrolvalues_exposure.md +++ b/windows.media.capture/capturedframecontrolvalues_exposure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.Exposure --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.Exposure ## -description Gets the exposure time used for a frame in a variable photo sequence. ## -property-value Gets the exposure time used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.Exposure +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.Exposure + +## -description +Gets the exposure time used for a frame in a variable photo sequence. + +## -property-value +Gets the exposure time used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_exposurecompensation.md b/windows.media.capture/capturedframecontrolvalues_exposurecompensation.md index addffc2ed4..59d903215c 100644 --- a/windows.media.capture/capturedframecontrolvalues_exposurecompensation.md +++ b/windows.media.capture/capturedframecontrolvalues_exposurecompensation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.ExposureCompensation --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.ExposureCompensation ## -description Gets the exposure compensation value used for a frame in a variable photo sequence. ## -property-value The exposure compensation value used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.ExposureCompensation +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.ExposureCompensation + +## -description +Gets the exposure compensation value used for a frame in a variable photo sequence. + +## -property-value +The exposure compensation value used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_flashed.md b/windows.media.capture/capturedframecontrolvalues_flashed.md index bd89eac82e..efc6547b5b 100644 --- a/windows.media.capture/capturedframecontrolvalues_flashed.md +++ b/windows.media.capture/capturedframecontrolvalues_flashed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.Flashed --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.Flashed ## -description Gets a value indicating if the flash was used for a frame in a variable photo sequence. ## -property-value A value indicating if the flash was used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.Flashed +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.Flashed + +## -description +Gets a value indicating if the flash was used for a frame in a variable photo sequence. + +## -property-value +A value indicating if the flash was used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_flashpowerpercent.md b/windows.media.capture/capturedframecontrolvalues_flashpowerpercent.md index 07c0012492..5d69fd76fe 100644 --- a/windows.media.capture/capturedframecontrolvalues_flashpowerpercent.md +++ b/windows.media.capture/capturedframecontrolvalues_flashpowerpercent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.FlashPowerPercent --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.FlashPowerPercent ## -description Gets the flash power used for a frame in a variable photo sequence. ## -property-value The flash power used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.FlashPowerPercent +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.FlashPowerPercent + +## -description +Gets the flash power used for a frame in a variable photo sequence. + +## -property-value +The flash power used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_focus.md b/windows.media.capture/capturedframecontrolvalues_focus.md index 35dee579a4..ec79de5fca 100644 --- a/windows.media.capture/capturedframecontrolvalues_focus.md +++ b/windows.media.capture/capturedframecontrolvalues_focus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.Focus --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.Focus ## -description Gets the focus lens position used for a frame in a variable photo sequence. ## -property-value The focus lens position used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.Focus +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.Focus + +## -description +Gets the focus lens position used for a frame in a variable photo sequence. + +## -property-value +The focus lens position used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_focusstate.md b/windows.media.capture/capturedframecontrolvalues_focusstate.md index 65d8a17a5a..6f4dade34b 100644 --- a/windows.media.capture/capturedframecontrolvalues_focusstate.md +++ b/windows.media.capture/capturedframecontrolvalues_focusstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.FocusState --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.FocusState ## -description Gets the focus state for a frame in a variable photo sequence. ## -property-value The focus state for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.FocusState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.FocusState + +## -description +Gets the focus state for a frame in a variable photo sequence. + +## -property-value +The focus state for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_isoanaloggain.md b/windows.media.capture/capturedframecontrolvalues_isoanaloggain.md index 98613834c2..0c4b4c31b8 100644 --- a/windows.media.capture/capturedframecontrolvalues_isoanaloggain.md +++ b/windows.media.capture/capturedframecontrolvalues_isoanaloggain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.IsoAnalogGain --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.IsoAnalogGain ## -description Gets the ISO analog gain used for a frame in a variable photo sequence. ## -property-value The ISO analog gain used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.IsoAnalogGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.IsoAnalogGain + +## -description +Gets the ISO analog gain used for a frame in a variable photo sequence. + +## -property-value +The ISO analog gain used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_isodigitalgain.md b/windows.media.capture/capturedframecontrolvalues_isodigitalgain.md index c021a59cff..9a463ae282 100644 --- a/windows.media.capture/capturedframecontrolvalues_isodigitalgain.md +++ b/windows.media.capture/capturedframecontrolvalues_isodigitalgain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.IsoDigitalGain --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.IsoDigitalGain ## -description Gets the ISO digital gain used for a frame in a variable photo sequence. ## -property-value The ISO digital gain used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.IsoDigitalGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.IsoDigitalGain + +## -description +Gets the ISO digital gain used for a frame in a variable photo sequence. + +## -property-value +The ISO digital gain used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_isospeed.md b/windows.media.capture/capturedframecontrolvalues_isospeed.md index 16ef538bbc..7d3283adf1 100644 --- a/windows.media.capture/capturedframecontrolvalues_isospeed.md +++ b/windows.media.capture/capturedframecontrolvalues_isospeed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.IsoSpeed --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.IsoSpeed ## -description Gets the ISO speed used for a frame in a variable photo sequence. ## -property-value The ISO speed used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.IsoSpeed +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.IsoSpeed + +## -description +Gets the ISO speed used for a frame in a variable photo sequence. + +## -property-value +The ISO speed used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_scenemode.md b/windows.media.capture/capturedframecontrolvalues_scenemode.md index fcb97c49b6..2f60b164d5 100644 --- a/windows.media.capture/capturedframecontrolvalues_scenemode.md +++ b/windows.media.capture/capturedframecontrolvalues_scenemode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.SceneMode --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.SceneMode ## -description Gets the scene mode used for a frame in a variable photo sequence. ## -property-value The scene mode used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.SceneMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.SceneMode + +## -description +Gets the scene mode used for a frame in a variable photo sequence. + +## -property-value +The scene mode used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_sensorframerate.md b/windows.media.capture/capturedframecontrolvalues_sensorframerate.md index 9e38b5307f..acdf6089be 100644 --- a/windows.media.capture/capturedframecontrolvalues_sensorframerate.md +++ b/windows.media.capture/capturedframecontrolvalues_sensorframerate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.SensorFrameRate --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.SensorFrameRate ## -description Gets the sensor frame rate used for a frame in a variable photo sequence. ## -property-value The sensor frame rate used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.SensorFrameRate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.SensorFrameRate + +## -description +Gets the sensor frame rate used for a frame in a variable photo sequence. + +## -property-value +The sensor frame rate used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_whitebalance.md b/windows.media.capture/capturedframecontrolvalues_whitebalance.md index ab7e316dc1..fa5ba44510 100644 --- a/windows.media.capture/capturedframecontrolvalues_whitebalance.md +++ b/windows.media.capture/capturedframecontrolvalues_whitebalance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.WhiteBalance --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.WhiteBalance ## -description Gets the white balance setting used for a frame in a variable photo sequence. ## -property-value The white balance setting used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.WhiteBalance +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.WhiteBalance + +## -description +Gets the white balance setting used for a frame in a variable photo sequence. + +## -property-value +The white balance setting used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_whitebalancegain.md b/windows.media.capture/capturedframecontrolvalues_whitebalancegain.md index 197ffd2a92..c797b611cd 100644 --- a/windows.media.capture/capturedframecontrolvalues_whitebalancegain.md +++ b/windows.media.capture/capturedframecontrolvalues_whitebalancegain.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.WhiteBalanceGain --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.WhiteBalanceGain ## -description Gets the white balance gain used for a frame in a variable photo sequence. ## -property-value The white balance gain used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.WhiteBalanceGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.WhiteBalanceGain + +## -description +Gets the white balance gain used for a frame in a variable photo sequence. + +## -property-value +The white balance gain used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedframecontrolvalues_zoomfactor.md b/windows.media.capture/capturedframecontrolvalues_zoomfactor.md index c787f95e0d..e73ba0230e 100644 --- a/windows.media.capture/capturedframecontrolvalues_zoomfactor.md +++ b/windows.media.capture/capturedframecontrolvalues_zoomfactor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedFrameControlValues.ZoomFactor --api-type: winrt property ---- # Windows.Media.Capture.CapturedFrameControlValues.ZoomFactor ## -description Gets the zoom factor used for a frame in a variable photo sequence. ## -property-value The zoom factor used for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedFrameControlValues.ZoomFactor +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedFrameControlValues.ZoomFactor + +## -description +Gets the zoom factor used for a frame in a variable photo sequence. + +## -property-value +The zoom factor used for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedphoto.md b/windows.media.capture/capturedphoto.md index acf057fc57..4b32640e81 100644 --- a/windows.media.capture/capturedphoto.md +++ b/windows.media.capture/capturedphoto.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Capture.CapturedPhoto --api-type: winrt class ---- # Windows.Media.Capture.CapturedPhoto ## -description Represents a photo taken from a capture device such as a webcam attached. ## -remarks Get an instance of this class by calling [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md). For how-to guidance for using **LowLagPhotoCapture**, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.CapturedPhoto +-api-type: winrt class +--- + + + +# Windows.Media.Capture.CapturedPhoto + +## -description +Represents a photo taken from a capture device such as a webcam attached. + +## -remarks +Get an instance of this class by calling [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md). For how-to guidance for using **LowLagPhotoCapture**, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md) \ No newline at end of file diff --git a/windows.media.capture/capturedphoto_frame.md b/windows.media.capture/capturedphoto_frame.md index 0919bfcafc..95df011294 100644 --- a/windows.media.capture/capturedphoto_frame.md +++ b/windows.media.capture/capturedphoto_frame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.CapturedPhoto.Frame --api-type: winrt property ---- # Windows.Media.Capture.CapturedPhoto.Frame ## -description Gets the photo data, represented as [CapturedFrame](capturedframe.md) object, associated with the [CapturedPhoto](capturedphoto.md) object. ## -property-value The captured frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedPhoto.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedPhoto.Frame + +## -description +Gets the photo data, represented as [CapturedFrame](capturedframe.md) object, associated with the [CapturedPhoto](capturedphoto.md) object. + +## -property-value +The captured frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/capturedphoto_thumbnail.md b/windows.media.capture/capturedphoto_thumbnail.md index ff8f7089d1..844e3a68e2 100644 --- a/windows.media.capture/capturedphoto_thumbnail.md +++ b/windows.media.capture/capturedphoto_thumbnail.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Capture.CapturedPhoto.Thumbnail --api-type: winrt property ---- # Windows.Media.Capture.CapturedPhoto.Thumbnail ## -description Represents a thumbnail image of the capture photo. ## -property-value The thumbnail image. ## -remarks ## -examples ## -see-also [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [LowLagPhotoControl.ThumbnailEnabled](../windows.media.devices/lowlagphotocontrol_thumbnailenabled.md), [LowLagPhotoControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotocontrol_desiredthumbnailsize.md), [LowLagPhotoControl.ThumbnailFormat](../windows.media.devices/lowlagphotocontrol_thumbnailformat.md), [LowLagPhotoSequenceControl.ThumbnailEnabled](../windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md), [ LowLagPhotoSequenceControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md), [LowLagPhotoSequenceControl.ThumbnailFormat](../windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.CapturedPhoto.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Capture.CapturedPhoto.Thumbnail + +## -description +Represents a thumbnail image of the capture photo. + +## -property-value +The thumbnail image. + +## -remarks + + +## -examples + +## -see-also +[MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [LowLagPhotoControl.ThumbnailEnabled](../windows.media.devices/lowlagphotocontrol_thumbnailenabled.md), [LowLagPhotoControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotocontrol_desiredthumbnailsize.md), [LowLagPhotoControl.ThumbnailFormat](../windows.media.devices/lowlagphotocontrol_thumbnailformat.md), [LowLagPhotoSequenceControl.ThumbnailEnabled](../windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md), [ LowLagPhotoSequenceControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md), [LowLagPhotoSequenceControl.ThumbnailFormat](../windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagmediarecording.md b/windows.media.capture/lowlagmediarecording.md index a1de8ea3ad..1fd6f6b266 100644 --- a/windows.media.capture/lowlagmediarecording.md +++ b/windows.media.capture/lowlagmediarecording.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Media.Capture.LowLagMediaRecording --api-type: winrt class ---- # Windows.Media.Capture.LowLagMediaRecording ## -description Provides methods for taking a low lag media recording. ## -remarks Use the following methods on the [MediaCapture](mediacapture.md) class to initialize the recording, which must be called before [StartAsync](lowlagmediarecording_startasync.md): [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), and [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md). These are asynchronous methods which return a [LowLagMediaRecording](lowlagmediarecording.md) object when they are finished. [StopAsync](lowlagmediarecording_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagmediarecording_startasync.md). [FinishAsync](lowlagmediarecording_finishasync.md) stops the media recording operation and releases the [LowLagMediaRecording](lowlagmediarecording.md) object and resources used by the media recording operation. If you want to restart the recording after calling [FinishAsync](lowlagmediarecording_finishasync.md), you will need to call one of the **PrepareLowLagRecord** methods to initialize a new [LowLagMediaRecording](lowlagmediarecording.md) object. If the media type is changed or an effect is added, you must call [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), or [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md) to create a new [LowLagMediaRecording](lowlagmediarecording.md) object. For how-to guidance for using **LowLagMediaCapture** to capture video, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.LowLagMediaRecording +-api-type: winrt class +--- + + + +# Windows.Media.Capture.LowLagMediaRecording + +## -description +Provides methods for taking a low lag media recording. + +## -remarks +Use the following methods on the [MediaCapture](mediacapture.md) class to initialize the recording, which must be called before [StartAsync](lowlagmediarecording_startasync.md): [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), and [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md). These are asynchronous methods which return a [LowLagMediaRecording](lowlagmediarecording.md) object when they are finished. + +[StopAsync](lowlagmediarecording_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagmediarecording_startasync.md). + +[FinishAsync](lowlagmediarecording_finishasync.md) stops the media recording operation and releases the [LowLagMediaRecording](lowlagmediarecording.md) object and resources used by the media recording operation. If you want to restart the recording after calling [FinishAsync](lowlagmediarecording_finishasync.md), you will need to call one of the **PrepareLowLagRecord** methods to initialize a new [LowLagMediaRecording](lowlagmediarecording.md) object. + +If the media type is changed or an effect is added, you must call [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), or [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md) to create a new [LowLagMediaRecording](lowlagmediarecording.md) object. + +For how-to guidance for using **LowLagMediaCapture** to capture video, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagmediarecording_finishasync_1182664592.md b/windows.media.capture/lowlagmediarecording_finishasync_1182664592.md index 8a04a21ee9..ccff1672d3 100644 --- a/windows.media.capture/lowlagmediarecording_finishasync_1182664592.md +++ b/windows.media.capture/lowlagmediarecording_finishasync_1182664592.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.FinishAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.FinishAsync ## -description Asynchronously releases the [LowLagMediaRecording](lowlagmediarecording.md) object and resources used by the media recording operation. ## -returns Object that is used to control the asynchronous operation. ## -remarks [FinishAsync](lowlagmediarecording_finishasync.md) stops the media recording operation and releases the [LowLagMediaRecording](lowlagmediarecording.md) object and resources used by the media recording operation. If you want to restart the recording after calling [FinishAsync](lowlagmediarecording_finishasync.md), you will need to call one of the **PrepareLowLagRecord** methods to initialize a new [LowLagMediaRecording](lowlagmediarecording.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.FinishAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.FinishAsync + +## -description +Asynchronously releases the [LowLagMediaRecording](lowlagmediarecording.md) object and resources used by the media recording operation. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks +[FinishAsync](lowlagmediarecording_finishasync.md) stops the media recording operation and releases the [LowLagMediaRecording](lowlagmediarecording.md) object and resources used by the media recording operation. If you want to restart the recording after calling [FinishAsync](lowlagmediarecording_finishasync.md), you will need to call one of the **PrepareLowLagRecord** methods to initialize a new [LowLagMediaRecording](lowlagmediarecording.md) object. + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagmediarecording_pauseasync_622665789.md b/windows.media.capture/lowlagmediarecording_pauseasync_622665789.md index 3770392614..696867c6f9 100644 --- a/windows.media.capture/lowlagmediarecording_pauseasync_622665789.md +++ b/windows.media.capture/lowlagmediarecording_pauseasync_622665789.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.PauseAsync(Windows.Media.Devices.MediaCapturePauseBehavior) --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.PauseAsync ## -description Pauses an ongoing low lag media record operation. ## -parameters ### -param behavior A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.PauseAsync(Windows.Media.Devices.MediaCapturePauseBehavior) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.PauseAsync + +## -description +Pauses an ongoing low lag media record operation. + +## -parameters +### -param behavior +A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagmediarecording_pausewithresultasync_1100916153.md b/windows.media.capture/lowlagmediarecording_pausewithresultasync_1100916153.md index 4436aa1890..9ad23f6384 100644 --- a/windows.media.capture/lowlagmediarecording_pausewithresultasync_1100916153.md +++ b/windows.media.capture/lowlagmediarecording_pausewithresultasync_1100916153.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.PauseWithResultAsync(Windows.Media.Devices.MediaCapturePauseBehavior) --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.PauseWithResultAsync ## -description Pauses an ongoing low lag media record operation and provides a [MediaCapturePauseResult](mediacapturepauseresult.md) that can be used to help the user align the camera with the last captured frame when resuming recording. ## -parameters ### -param behavior A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. ## -returns An asynchronous action that returns a [MediaCapturePauseResult](mediacapturepauseresult.md) upon completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.PauseWithResultAsync(Windows.Media.Devices.MediaCapturePauseBehavior) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.PauseWithResultAsync + +## -description +Pauses an ongoing low lag media record operation and provides a [MediaCapturePauseResult](mediacapturepauseresult.md) that can be used to help the user align the camera with the last captured frame when resuming recording. + +## -parameters +### -param behavior +A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. + +## -returns +An asynchronous action that returns a [MediaCapturePauseResult](mediacapturepauseresult.md) upon completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagmediarecording_resumeasync_801976564.md b/windows.media.capture/lowlagmediarecording_resumeasync_801976564.md index 80a0870779..ccf1978eab 100644 --- a/windows.media.capture/lowlagmediarecording_resumeasync_801976564.md +++ b/windows.media.capture/lowlagmediarecording_resumeasync_801976564.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.ResumeAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.ResumeAsync ## -description Resumes a paused low lag recording operation. ## -returns An asynchronous action. ## -remarks Pause a low lag media recording operation by calling [PauseAsync](lowlagmediarecording_pauseasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.ResumeAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.ResumeAsync + +## -description +Resumes a paused low lag recording operation. + +## -returns +An asynchronous action. + +## -remarks +Pause a low lag media recording operation by calling [PauseAsync](lowlagmediarecording_pauseasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagmediarecording_startasync_1931900819.md b/windows.media.capture/lowlagmediarecording_startasync_1931900819.md index 5c0db32965..62ad359907 100644 --- a/windows.media.capture/lowlagmediarecording_startasync_1931900819.md +++ b/windows.media.capture/lowlagmediarecording_startasync_1931900819.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.StartAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.StartAsync ## -description Asynchronously starts the low lag media recording. ## -returns Object that is used to control the asynchronous operation. ## -remarks Before calling [StartAsync](lowlagmediarecording_startasync.md), you must initialize the [LowLagMediaRecording](lowlagmediarecording.md) object by calling one of the prepare method on [MediaCapture](mediacapture.md): [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), and [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md). ## -examples ## -see-also [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.StartAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.StartAsync + +## -description +Asynchronously starts the low lag media recording. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks +Before calling [StartAsync](lowlagmediarecording_startasync.md), you must initialize the [LowLagMediaRecording](lowlagmediarecording.md) object by calling one of the prepare method on [MediaCapture](mediacapture.md): [PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), and [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md). + +## -examples + +## -see-also +[PrepareLowLagRecordToStreamAsync](mediacapture_preparelowlagrecordtostreamasync.md), [PrepareLowLagRecordToStorageFileAsync](mediacapture_preparelowlagrecordtostoragefileasync.md), [PrepareLowLagRecordToCustomSinkAsync](mediacapture_preparelowlagrecordtocustomsinkasync.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagmediarecording_stopasync_1648475005.md b/windows.media.capture/lowlagmediarecording_stopasync_1648475005.md index 9a61b9ea10..4084f81af8 100644 --- a/windows.media.capture/lowlagmediarecording_stopasync_1648475005.md +++ b/windows.media.capture/lowlagmediarecording_stopasync_1648475005.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.StopAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.StopAsync ## -description Asynchronously stops the low lag media recording. ## -returns Object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.StopAsync + +## -description +Asynchronously stops the low lag media recording. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagmediarecording_stopwithresultasync_1406226363.md b/windows.media.capture/lowlagmediarecording_stopwithresultasync_1406226363.md index 50fdc41f7d..5ac619319e 100644 --- a/windows.media.capture/lowlagmediarecording_stopwithresultasync_1406226363.md +++ b/windows.media.capture/lowlagmediarecording_stopwithresultasync_1406226363.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.LowLagMediaRecording.StopWithResultAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagMediaRecording.StopWithResultAsync ## -description Asynchronously stops the low lag media recording and provides a [MediaCaptureStopResult](mediacapturestopresult.md) that can be used to help the user align the camera with the last captured frame when restarting recording. ## -returns An asynchronous action that returns a [MediaCaptureStopResult](mediacapturestopresult.md) upon completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagMediaRecording.StopWithResultAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagMediaRecording.StopWithResultAsync + +## -description +Asynchronously stops the low lag media recording and provides a [MediaCaptureStopResult](mediacapturestopresult.md) that can be used to help the user align the camera with the last captured frame when restarting recording. + +## -returns +An asynchronous action that returns a [MediaCaptureStopResult](mediacapturestopresult.md) upon completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagphotocapture.md b/windows.media.capture/lowlagphotocapture.md index f87a361a94..39ae476d59 100644 --- a/windows.media.capture/lowlagphotocapture.md +++ b/windows.media.capture/lowlagphotocapture.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Media.Capture.LowLagPhotoCapture --api-type: winrt class ---- # Windows.Media.Capture.LowLagPhotoCapture ## -description Provides methods for taking a low shutter lag photo. ## -remarks Use [MediaCapture.PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) to initialize the capture. This is an asynchronous calls which returns a [LowLagPhotoCapture](lowlagphotocapture.md) object when it is finished. This must be called before [CaptureAsync](lowlagphotocapture_captureasync.md). [FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo capture operation and releases the [LowLagPhotoCapture](lowlagphotocapture.md) object and resources used by the capture photo operation. After starting a low lag photo capture, you must stop the photo capture by calling [FinishAsync](lowlagmediarecording_finishasync.md) before your app attempts to record video with the [MediaCapture](mediacapture.md) object. If the media type is changed or an effect is added, you must call [MediaCapture.PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) to create a new [LowLagPhotoCapture](lowlagphotocapture.md) object. For how-to guidance for using **LowLagPhotoCapture** to capture photos, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [MediaCapture.PrepareLowLagPhotoCapture](mediacapture_preparelowlagphotocaptureasync.md), [CapturedPhoto](capturedphoto.md), [LowLagPhotoControl](../windows.media.devices/lowlagphotocontrol.md), [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.LowLagPhotoCapture +-api-type: winrt class +--- + + + +# Windows.Media.Capture.LowLagPhotoCapture + +## -description +Provides methods for taking a low shutter lag photo. + +## -remarks +Use [MediaCapture.PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) to initialize the capture. This is an asynchronous calls which returns a [LowLagPhotoCapture](lowlagphotocapture.md) object when it is finished. This must be called before [CaptureAsync](lowlagphotocapture_captureasync.md). + +[FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo capture operation and releases the [LowLagPhotoCapture](lowlagphotocapture.md) object and resources used by the capture photo operation. After starting a low lag photo capture, you must stop the photo capture by calling [FinishAsync](lowlagmediarecording_finishasync.md) before your app attempts to record video with the [MediaCapture](mediacapture.md) object. + +If the media type is changed or an effect is added, you must call [MediaCapture.PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) to create a new [LowLagPhotoCapture](lowlagphotocapture.md) object. + +For how-to guidance for using **LowLagPhotoCapture** to capture photos, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + + + +## -examples + +## -see-also +[Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [MediaCapture.PrepareLowLagPhotoCapture](mediacapture_preparelowlagphotocaptureasync.md), [CapturedPhoto](capturedphoto.md), [LowLagPhotoControl](../windows.media.devices/lowlagphotocontrol.md), [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagphotocapture_captureasync_2078018041.md b/windows.media.capture/lowlagphotocapture_captureasync_2078018041.md index b635458726..816fc10a0e 100644 --- a/windows.media.capture/lowlagphotocapture_captureasync_2078018041.md +++ b/windows.media.capture/lowlagphotocapture_captureasync_2078018041.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.LowLagPhotoCapture.CaptureAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagPhotoCapture.CaptureAsync ## -description Asynchronously captures a low shutter lag photo. ## -returns When this method completes, a [CapturedPhoto](capturedphoto.md) object is returned which contains the captured photo. ## -remarks [MediaCapture.PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) must be called before [CaptureAsync](lowlagphotocapture_captureasync.md). When this asynchronous method completes, a [CapturedPhoto](capturedphoto.md) object is returned which contains the captured photo. ## -examples ## -see-also [PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagPhotoCapture.CaptureAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagPhotoCapture.CaptureAsync + +## -description +Asynchronously captures a low shutter lag photo. + +## -returns +When this method completes, a [CapturedPhoto](capturedphoto.md) object is returned which contains the captured photo. + +## -remarks +[MediaCapture.PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) must be called before [CaptureAsync](lowlagphotocapture_captureasync.md). + +When this asynchronous method completes, a [CapturedPhoto](capturedphoto.md) object is returned which contains the captured photo. + +## -examples + +## -see-also +[PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md b/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md index 9c20eedeb6..be68dae0d9 100644 --- a/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md +++ b/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.Media.Capture.LowLagPhotoCapture.FinishAsync --api-type: winrt method ---- - - - -# Windows.Media.Capture.LowLagPhotoCapture.FinishAsync - -## -description -Asynchronously releases the [LowLagPhotoCapture](lowlagphotocapture.md) object and resources used by the capture photo operation. - -## -returns -Object that is used to control the asynchronous operation. - -## -remarks - -## -examples -Here is an example that shows how to setup and take low lag photos. It displays the captured photo and thumbnail in [Image](XREF:TODO:wwa.Image_object) objects. The XAML creates a simple UI with a two [Image](XREF:TODO:wwa.Image_object) objects and some [Button](../windows.ui.xaml.controls/button.md) objects to interact with the [MediaCapture](mediacapture.md) element. In code, there is a method to initialize the [MediaCapture](mediacapture.md) object, a method to initialize the [LowLagPhotoCapture](lowlagphotocapture.md) object, a method to take the photo and display it, and a method to shutdown the [LowLagPhotoCapture](lowlagphotocapture.md). - - - -[!code-xml[MediaCaptureLowLagXAML](../windows.media.capture/code/MediaCapture/csharp/MainPage.xaml#SnippetMediaCaptureLowLagXAML)] - -[!code-cs[MediaCaptureLowLagPhotoCaptureCode](../windows.media.capture/code/MediaCapture/csharp/MainPage.xaml.cs#SnippetMediaCaptureLowLagPhotoCaptureCode)] - -## -see-also +--- +-api-id: M:Windows.Media.Capture.LowLagPhotoCapture.FinishAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagPhotoCapture.FinishAsync + +## -description +Asynchronously releases the [LowLagPhotoCapture](lowlagphotocapture.md) object and resources used by the capture photo operation. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks + +## -examples +Here is an example that shows how to setup and take low lag photos. It displays the captured photo and thumbnail in [Image](XREF:TODO:wwa.Image_object) objects. The XAML creates a simple UI with a two [Image](XREF:TODO:wwa.Image_object) objects and some [Button](../windows.ui.xaml.controls/button.md) objects to interact with the [MediaCapture](mediacapture.md) element. In code, there is a method to initialize the [MediaCapture](mediacapture.md) object, a method to initialize the [LowLagPhotoCapture](lowlagphotocapture.md) object, a method to take the photo and display it, and a method to shutdown the [LowLagPhotoCapture](lowlagphotocapture.md). + + + +[!code-xml[MediaCaptureLowLagXAML](../windows.media.capture/code/MediaCapture/csharp/MainPage.xaml#SnippetMediaCaptureLowLagXAML)] + +[!code-cs[MediaCaptureLowLagPhotoCaptureCode](../windows.media.capture/code/MediaCapture/csharp/MainPage.xaml.cs#SnippetMediaCaptureLowLagPhotoCaptureCode)] + +## -see-also diff --git a/windows.media.capture/lowlagphotosequencecapture.md b/windows.media.capture/lowlagphotosequencecapture.md index 6398458981..0ceb0746d0 100644 --- a/windows.media.capture/lowlagphotosequencecapture.md +++ b/windows.media.capture/lowlagphotosequencecapture.md @@ -1,3 +1,49 @@ ---- -api-id: T:Windows.Media.Capture.LowLagPhotoSequenceCapture --api-type: winrt class ---- # Windows.Media.Capture.LowLagPhotoSequenceCapture ## -description Provides methods for taking a rapid sequence of low shutter lag photos. ## -remarks Photo sequence mode takes a rapid sequence of photos. A key scenario for photo sequence is getting photos in the past, that is prior to when the user takes a photo. If you want to take a sequence of photos that each have different settings, such as exposure or flash, use [VariablePhotoSequenceCapture](../windows.media.capture.core/variablephotosequencecapture.md). You can access the [LowLagPhotoSequenceControl](../windows.media.devices/lowlagphotosequencecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](mediacapture_videodevicecontroller.md). [LowLagPhotoSequenceControl](../windows.media.devices/lowlagphotosequencecontrol.md) is used to manage settings related to the photo sequence session. You can find out if the device supports photo sequence mode by checking [LowLagPhotoSequenceControl.Supported](../windows.media.devices/lowlagphotosequencecontrol_supported.md). Use [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize the photo sequence capture. This is an asynchronous call which returns a [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object when it is finished. This must be called before [StartAsync](lowlagphotosequencecapture_startasync.md). To start capturing photos, call [StartAsync](lowlagphotosequencecapture_startasync.md). The app will continue to receive photos from the device until the operation is stopped. [StopAsync](lowlagphotosequencecapture_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagphotosequencecapture_startasync.md). Add a handler to the [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event in order to get the captured photos in the sequence. [PhotoCapturedEventArgs](photocapturedeventargs.md) provides the data for the captured frames. [PhotoCapturedEventArgs.Frame](photocapturedeventargs_frame.md) contains the captured photo and [PhotoCapturedEventArgs.Thumbnail](photocapturedeventargs_thumbnail.md) contains the thumbnail. [FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo sequence capture operation and releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence operation. If you want to restart the photo sequence operation after calling [FinishAsync](lowlagphotosequencecapture_finishasync.md), you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize a new [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object. If the media type is changed or an effect is added, you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to create a new [LowLagPhotoCapture](lowlagphotocapture.md) object. [LowLagPhotoSequenceControl.GetCurrentFrameRate](../windows.media.devices/lowlagphotosequencecontrol_getcurrentframerate.md) specifies the frame rate at which the photos are taken. [PhotoCapturedEventArgs.CaptureTimeOffset](photocapturedeventargs_capturetimeoffset.md) can be used to tell whether a frame was in the future, greater than 0, or in the past, less than 0. If the app wants to limit how many frames it gets per second, it can use [LowLagPhotoSequenceControl.PhotosPerSecondLimit](../windows.media.devices/lowlagphotosequencecontrol_photospersecondlimit.md). This can be useful in situations where the sensor on the device can handle 30fps, but the app only needs 4fps. To enable thumbnails, set [LowLagPhotoSequenceControl.ThumbnailEnabled](../windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md) to **true**. You can set the desired thumbnail size through [LowLagPhotoSequenceControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md) and set the thumbnail format through [LowLagPhotoSequenceControl.ThumbnailFormat](../windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md). The number of past photos cannot be more than [LowLagPhotoSequenceControl.MaxPastPhotos](../windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md), which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: [LowLagPhotoSequenceControl.PastPhotoLimit](../windows.media.devices/lowlagphotosequencecontrol_pastphotolimit.md), [LowLagPhotoSequenceControl.MaxPastPhotos](../windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md), or the current number of available past photos. ## -examples ## -see-also [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md), [LowLagPhotoSequenceControl](../windows.media.devices/lowlagphotosequencecontrol.md), [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [LowLagPhotoCapture](lowlagphotocapture.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.LowLagPhotoSequenceCapture +-api-type: winrt class +--- + + + +# Windows.Media.Capture.LowLagPhotoSequenceCapture + +## -description +Provides methods for taking a rapid sequence of low shutter lag photos. + +## -remarks +Photo sequence mode takes a rapid sequence of photos. A key scenario for photo sequence is getting photos in the past, that is prior to when the user takes a photo. If you want to take a sequence of photos that each have different settings, such as exposure or flash, use [VariablePhotoSequenceCapture](../windows.media.capture.core/variablephotosequencecapture.md). + +You can access the [LowLagPhotoSequenceControl](../windows.media.devices/lowlagphotosequencecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](mediacapture_videodevicecontroller.md). [LowLagPhotoSequenceControl](../windows.media.devices/lowlagphotosequencecontrol.md) is used to manage settings related to the photo sequence session. + +You can find out if the device supports photo sequence mode by checking [LowLagPhotoSequenceControl.Supported](../windows.media.devices/lowlagphotosequencecontrol_supported.md). + +Use [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize the photo sequence capture. This is an asynchronous call which returns a [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object when it is finished. This must be called before [StartAsync](lowlagphotosequencecapture_startasync.md). + +To start capturing photos, call [StartAsync](lowlagphotosequencecapture_startasync.md). The app will continue to receive photos from the device until the operation is stopped. + +[StopAsync](lowlagphotosequencecapture_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagphotosequencecapture_startasync.md). + +Add a handler to the [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event in order to get the captured photos in the sequence. [PhotoCapturedEventArgs](photocapturedeventargs.md) provides the data for the captured frames. [PhotoCapturedEventArgs.Frame](photocapturedeventargs_frame.md) contains the captured photo and [PhotoCapturedEventArgs.Thumbnail](photocapturedeventargs_thumbnail.md) contains the thumbnail. + +[FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo sequence capture operation and releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence operation. If you want to restart the photo sequence operation after calling [FinishAsync](lowlagphotosequencecapture_finishasync.md), you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize a new [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object. + +If the media type is changed or an effect is added, you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to create a new [LowLagPhotoCapture](lowlagphotocapture.md) object. + +[LowLagPhotoSequenceControl.GetCurrentFrameRate](../windows.media.devices/lowlagphotosequencecontrol_getcurrentframerate.md) specifies the frame rate at which the photos are taken. + +[PhotoCapturedEventArgs.CaptureTimeOffset](photocapturedeventargs_capturetimeoffset.md) can be used to tell whether a frame was in the future, greater than 0, or in the past, less than 0. + +If the app wants to limit how many frames it gets per second, it can use [LowLagPhotoSequenceControl.PhotosPerSecondLimit](../windows.media.devices/lowlagphotosequencecontrol_photospersecondlimit.md). This can be useful in situations where the sensor on the device can handle 30fps, but the app only needs 4fps. + +To enable thumbnails, set [LowLagPhotoSequenceControl.ThumbnailEnabled](../windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md) to **true**. + +You can set the desired thumbnail size through [LowLagPhotoSequenceControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md) and set the thumbnail format through [LowLagPhotoSequenceControl.ThumbnailFormat](../windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md). + +The number of past photos cannot be more than [LowLagPhotoSequenceControl.MaxPastPhotos](../windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md), which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: [LowLagPhotoSequenceControl.PastPhotoLimit](../windows.media.devices/lowlagphotosequencecontrol_pastphotolimit.md), [LowLagPhotoSequenceControl.MaxPastPhotos](../windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md), or the current number of available past photos. + +## -examples + +## -see-also +[MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md), [LowLagPhotoSequenceControl](../windows.media.devices/lowlagphotosequencecontrol.md), [MediaControl.VideoDeviceController](mediacapture_videodevicecontroller.md), [LowLagPhotoCapture](lowlagphotocapture.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagphotosequencecapture_finishasync_1182664592.md b/windows.media.capture/lowlagphotosequencecapture_finishasync_1182664592.md index d36bea7fcc..dc8efa4448 100644 --- a/windows.media.capture/lowlagphotosequencecapture_finishasync_1182664592.md +++ b/windows.media.capture/lowlagphotosequencecapture_finishasync_1182664592.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Capture.LowLagPhotoSequenceCapture.FinishAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagPhotoSequenceCapture.FinishAsync ## -description Asynchronously releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence capture operation. ## -returns Object that is used to control the asynchronous operation. ## -remarks [FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo sequence capture operation and releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence operation. If you want to restart the photo sequence operation after calling [FinishAsync](lowlagphotosequencecapture_finishasync.md), you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize a new [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object. [StopAsync](lowlagphotosequencecapture_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagphotosequencecapture_startasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagPhotoSequenceCapture.FinishAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagPhotoSequenceCapture.FinishAsync + +## -description +Asynchronously releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence capture operation. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks +[FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo sequence capture operation and releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence operation. If you want to restart the photo sequence operation after calling [FinishAsync](lowlagphotosequencecapture_finishasync.md), you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize a new [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object. + +[StopAsync](lowlagphotosequencecapture_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagphotosequencecapture_startasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagphotosequencecapture_photocaptured.md b/windows.media.capture/lowlagphotosequencecapture_photocaptured.md index 3298d6fbff..367f7b3b08 100644 --- a/windows.media.capture/lowlagphotosequencecapture_photocaptured.md +++ b/windows.media.capture/lowlagphotosequencecapture_photocaptured.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.LowLagPhotoSequenceCapture.PhotoCaptured --api-type: winrt event ---- # Windows.Media.Capture.LowLagPhotoSequenceCapture.PhotoCaptured ## -description Occurs when a photo has been captured. ## -remarks Add an handler to the [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event in order to get the captured photos in the sequence. [PhotoCapturedEventArgs](photocapturedeventargs.md) provides the data for the captured frames. [PhotoCapturedEventArgs.Frame](photocapturedeventargs_frame.md) contains the captured photo and [PhotoCapturedEventArgs.Thumbnail](photocapturedeventargs_thumbnail.md) contains the thumbnail. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.LowLagPhotoSequenceCapture.PhotoCaptured +-api-type: winrt event +--- + + + +# Windows.Media.Capture.LowLagPhotoSequenceCapture.PhotoCaptured + +## -description +Occurs when a photo has been captured. + +## -remarks +Add an handler to the [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event in order to get the captured photos in the sequence. [PhotoCapturedEventArgs](photocapturedeventargs.md) provides the data for the captured frames. [PhotoCapturedEventArgs.Frame](photocapturedeventargs_frame.md) contains the captured photo and [PhotoCapturedEventArgs.Thumbnail](photocapturedeventargs_thumbnail.md) contains the thumbnail. + +## -examples + +## -see-also diff --git a/windows.media.capture/lowlagphotosequencecapture_startasync_1931900819.md b/windows.media.capture/lowlagphotosequencecapture_startasync_1931900819.md index b524082d5e..e975e02318 100644 --- a/windows.media.capture/lowlagphotosequencecapture_startasync_1931900819.md +++ b/windows.media.capture/lowlagphotosequencecapture_startasync_1931900819.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.LowLagPhotoSequenceCapture.StartAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagPhotoSequenceCapture.StartAsync ## -description Asynchronously starts capturing photos. ## -returns Object that is used to control the asynchronous operation. ## -remarks [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) must be called before [StartAsync](lowlagphotosequencecapture_startasync.md). Add a handler to the [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event in order to get the captured photos in the sequence. [PhotoCapturedEventArgs](photocapturedeventargs.md) provides the data for the captured frames. [PhotoCapturedEventArgs.Frame](photocapturedeventargs_frame.md) contains the captured photo and [PhotoCapturedEventArgs.Thumbnail](photocapturedeventargs_thumbnail.md) contains the thumbnail. ## -examples ## -see-also [PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagPhotoSequenceCapture.StartAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagPhotoSequenceCapture.StartAsync + +## -description +Asynchronously starts capturing photos. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks +[MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) must be called before [StartAsync](lowlagphotosequencecapture_startasync.md). + +Add a handler to the [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event in order to get the captured photos in the sequence. [PhotoCapturedEventArgs](photocapturedeventargs.md) provides the data for the captured frames. [PhotoCapturedEventArgs.Frame](photocapturedeventargs_frame.md) contains the captured photo and [PhotoCapturedEventArgs.Thumbnail](photocapturedeventargs_thumbnail.md) contains the thumbnail. + +## -examples + +## -see-also +[PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) \ No newline at end of file diff --git a/windows.media.capture/lowlagphotosequencecapture_stopasync_1648475005.md b/windows.media.capture/lowlagphotosequencecapture_stopasync_1648475005.md index af1b53bd1e..83256cd6fb 100644 --- a/windows.media.capture/lowlagphotosequencecapture_stopasync_1648475005.md +++ b/windows.media.capture/lowlagphotosequencecapture_stopasync_1648475005.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Capture.LowLagPhotoSequenceCapture.StopAsync --api-type: winrt method ---- # Windows.Media.Capture.LowLagPhotoSequenceCapture.StopAsync ## -description Asynchronously stops capturing photos. ## -returns Object that is used to control the asynchronous operation. ## -remarks [StopAsync](lowlagphotosequencecapture_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagphotosequencecapture_startasync.md). [FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo sequence capture operation and releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence operation. If you want to restart the photo sequence operation after calling [FinishAsync](lowlagphotosequencecapture_finishasync.md), you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize a new [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.LowLagPhotoSequenceCapture.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.LowLagPhotoSequenceCapture.StopAsync + +## -description +Asynchronously stops capturing photos. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks +[StopAsync](lowlagphotosequencecapture_stopasync.md) stops the operation, which can be restarted with [StartAsync](lowlagphotosequencecapture_startasync.md). + +[FinishAsync](lowlagphotosequencecapture_finishasync.md) stops the photo sequence capture operation and releases the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object and resources used by the photo sequence operation. If you want to restart the photo sequence operation after calling [FinishAsync](lowlagphotosequencecapture_finishasync.md), you must call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize a new [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_addaudioeffectasync_182168147.md b/windows.media.capture/mediacapture_addaudioeffectasync_182168147.md index d11d7ac9fe..ff8d707433 100644 --- a/windows.media.capture/mediacapture_addaudioeffectasync_182168147.md +++ b/windows.media.capture/mediacapture_addaudioeffectasync_182168147.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.AddAudioEffectAsync(Windows.Media.Effects.IAudioEffectDefinition) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.AddAudioEffectAsync ## -description Adds an audio effect to the capture pipeline. ## -parameters ### -param definition The object containing the definition of the effect to be added. ## -returns An asynchronous operation that returns an [IMediaExtension](../windows.media/imediaextension.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.AddAudioEffectAsync(Windows.Media.Effects.IAudioEffectDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.AddAudioEffectAsync + +## -description +Adds an audio effect to the capture pipeline. + +## -parameters +### -param definition +The object containing the definition of the effect to be added. + +## -returns +An asynchronous operation that returns an [IMediaExtension](../windows.media/imediaextension.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_addeffectasync_262788603.md b/windows.media.capture/mediacapture_addeffectasync_262788603.md index a5d782fe4f..93f54bcb4b 100644 --- a/windows.media.capture/mediacapture_addeffectasync_262788603.md +++ b/windows.media.capture/mediacapture_addeffectasync_262788603.md @@ -1,3 +1,37 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.AddEffectAsync(Windows.Media.Capture.MediaStreamType,System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.AddEffectAsync ## -description Adds an audio or video effect. ## -parameters ### -param mediaStreamType Specifies the streams to which the effect will be applied. ### -param effectActivationID The class identifier of the activatable runtime class that implements the effect. The runtime class must implement the [IMediaExtension](../windows.media/imediaextension.md) interface. ### -param effectSettings Configuration parameters for the effect. ## -returns Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks As of Windows 10, this method is deprecated. Use [AddAudioEffectAsync](mediacapture_addaudioeffectasync.md) or [AddVideoEffectAsync](mediacapture_addvideoeffectasync.md) instead. For how-to guidance on adding effects to the camera capture and preview streams, see [Effects for video capture](http://msdn.microsoft.com/library/e0189423-1df3-4052-ab2e-846ea18254c4). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.AddEffectAsync(Windows.Media.Capture.MediaStreamType,System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.AddEffectAsync + +## -description +Adds an audio or video effect. + +## -parameters +### -param mediaStreamType +Specifies the streams to which the effect will be applied. + +### -param effectActivationID +The class identifier of the activatable runtime class that implements the effect. The runtime class must implement the [IMediaExtension](../windows.media/imediaextension.md) interface. + +### -param effectSettings +Configuration parameters for the effect. + +## -returns +Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +As of Windows 10, this method is deprecated. Use [AddAudioEffectAsync](mediacapture_addaudioeffectasync.md) or [AddVideoEffectAsync](mediacapture_addvideoeffectasync.md) instead. For how-to guidance on adding effects to the camera capture and preview streams, see [Effects for video capture](http://msdn.microsoft.com/library/e0189423-1df3-4052-ab2e-846ea18254c4). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_addvideoeffectasync_1410216019.md b/windows.media.capture/mediacapture_addvideoeffectasync_1410216019.md index 1857f11bd7..3a1a77db7b 100644 --- a/windows.media.capture/mediacapture_addvideoeffectasync_1410216019.md +++ b/windows.media.capture/mediacapture_addvideoeffectasync_1410216019.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.AddVideoEffectAsync(Windows.Media.Effects.IVideoEffectDefinition,Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.AddVideoEffectAsync ## -description Adds a video effect to the capture pipeline. ## -parameters ### -param definition The object containing the definition of the effect to be added. ### -param mediaStreamType Specifies the streams to which the effect will be applied. ## -returns An asynchronous operation that returns an [IMediaExtension](../windows.media/imediaextension.md) upon successful completion. ## -remarks For how-to guidance on adding effects to the camera capture and preview streams, see [Effects for video capture](http://msdn.microsoft.com/library/e0189423-1df3-4052-ab2e-846ea18254c4). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.AddVideoEffectAsync(Windows.Media.Effects.IVideoEffectDefinition,Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.AddVideoEffectAsync + +## -description +Adds a video effect to the capture pipeline. + +## -parameters +### -param definition +The object containing the definition of the effect to be added. + +### -param mediaStreamType +Specifies the streams to which the effect will be applied. + +## -returns +An asynchronous operation that returns an [IMediaExtension](../windows.media/imediaextension.md) upon successful completion. + +## -remarks +For how-to guidance on adding effects to the camera capture and preview streams, see [Effects for video capture](http://msdn.microsoft.com/library/e0189423-1df3-4052-ab2e-846ea18254c4). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_audiodevicecontroller.md b/windows.media.capture/mediacapture_audiodevicecontroller.md index e4ef1f7be2..28fe194ea7 100644 --- a/windows.media.capture/mediacapture_audiodevicecontroller.md +++ b/windows.media.capture/mediacapture_audiodevicecontroller.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapture.AudioDeviceController --api-type: winrt property ---- # Windows.Media.Capture.MediaCapture.AudioDeviceController ## -description Gets an object that controls settings for the microphone. ## -property-value An [AudioDeviceController](../windows.media.devices/audiodevicecontroller.md) object that controls settings for the microphone. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapture.AudioDeviceController +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapture.AudioDeviceController + +## -description +Gets an object that controls settings for the microphone. + +## -property-value +An [AudioDeviceController](../windows.media.devices/audiodevicecontroller.md) object that controls settings for the microphone. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_camerastreamstate.md b/windows.media.capture/mediacapture_camerastreamstate.md index 369627a469..0906facd31 100644 --- a/windows.media.capture/mediacapture_camerastreamstate.md +++ b/windows.media.capture/mediacapture_camerastreamstate.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapture.CameraStreamState --api-type: winrt property ---- # Windows.Media.Capture.MediaCapture.CameraStreamState ## -description Gets the current stream state of the camera stream. ## -property-value The current stream state of the camera stream. ## -remarks The state of the camera stream will change when recording is paused or resumed, when the system drops frames for privacy reasons, or when the camera stream is lost. To be notified when the camera stream state changes, handle the [CameraStreamStateChanged](mediacapture_camerastreamstatechanged.md) event. ## -examples ## -see-also [CameraStreamState](../windows.media.devices/camerastreamstate.md), [CameraStreamStateChanged](mediacapture_camerastreamstatechanged.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapture.CameraStreamState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapture.CameraStreamState + +## -description +Gets the current stream state of the camera stream. + +## -property-value +The current stream state of the camera stream. + +## -remarks +The state of the camera stream will change when recording is paused or resumed, when the system drops frames for privacy reasons, or when the camera stream is lost. To be notified when the camera stream state changes, handle the [CameraStreamStateChanged](mediacapture_camerastreamstatechanged.md) event. + +## -examples + +## -see-also +[CameraStreamState](../windows.media.devices/camerastreamstate.md), [CameraStreamStateChanged](mediacapture_camerastreamstatechanged.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_camerastreamstatechanged.md b/windows.media.capture/mediacapture_camerastreamstatechanged.md index 2e7753daf7..5835d8af86 100644 --- a/windows.media.capture/mediacapture_camerastreamstatechanged.md +++ b/windows.media.capture/mediacapture_camerastreamstatechanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.MediaCapture.CameraStreamStateChanged --api-type: winrt event ---- # Windows.Media.Capture.MediaCapture.CameraStreamStateChanged ## -description Occurs when the state of the camera stream changes. ## -remarks The state of the camera stream will change when recording is paused or resumed, when the system drops frames for privacy reasons, or when the camera stream is lost. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.MediaCapture.CameraStreamStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.CameraStreamStateChanged + +## -description +Occurs when the state of the camera stream changes. + +## -remarks +The state of the camera stream will change when recording is paused or resumed, when the system drops frames for privacy reasons, or when the camera stream is lost. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_capturephototostoragefileasync_2032368279.md b/windows.media.capture/mediacapture_capturephototostoragefileasync_2032368279.md index ee5d58129a..ba78505718 100644 --- a/windows.media.capture/mediacapture_capturephototostoragefileasync_2032368279.md +++ b/windows.media.capture/mediacapture_capturephototostoragefileasync_2032368279.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.CapturePhotoToStorageFileAsync(Windows.Media.MediaProperties.ImageEncodingProperties,Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.CapturePhotoToStorageFileAsync ## -description Captures a photo to a storage file. ## -parameters ### -param type The encoding properties for the output image. ### -param file The storage file where the image is saved. ## -returns Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks For how-to guidance on capturing a photo to a storage file, see Basic [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.CapturePhotoToStorageFileAsync(Windows.Media.MediaProperties.ImageEncodingProperties,Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.CapturePhotoToStorageFileAsync + +## -description +Captures a photo to a storage file. + +## -parameters +### -param type +The encoding properties for the output image. + +### -param file +The storage file where the image is saved. + +## -returns +Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +For how-to guidance on capturing a photo to a storage file, see Basic [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_capturephototostreamasync_1237404614.md b/windows.media.capture/mediacapture_capturephototostreamasync_1237404614.md index dd43c5fc82..3245585aaa 100644 --- a/windows.media.capture/mediacapture_capturephototostreamasync_1237404614.md +++ b/windows.media.capture/mediacapture_capturephototostreamasync_1237404614.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.CapturePhotoToStreamAsync(Windows.Media.MediaProperties.ImageEncodingProperties,Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.CapturePhotoToStreamAsync ## -description Captures a photo to a random-access stream. ## -parameters ### -param type The encoding properties for the output image. ### -param stream The stream where the image data is written. ## -returns Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.CapturePhotoToStreamAsync(Windows.Media.MediaProperties.ImageEncodingProperties,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.CapturePhotoToStreamAsync + +## -description +Captures a photo to a random-access stream. + +## -parameters +### -param type +The encoding properties for the output image. + +### -param stream +The stream where the image data is written. + +## -returns +Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_cleareffectsasync_1917921726.md b/windows.media.capture/mediacapture_cleareffectsasync_1917921726.md index b5dc31a480..26dbf8d0ab 100644 --- a/windows.media.capture/mediacapture_cleareffectsasync_1917921726.md +++ b/windows.media.capture/mediacapture_cleareffectsasync_1917921726.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.ClearEffectsAsync(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.ClearEffectsAsync ## -description Removes all audio and video effects from a stream. ## -parameters ### -param mediaStreamType The stream from which to remove the effects. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.ClearEffectsAsync(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.ClearEffectsAsync + +## -description +Removes all audio and video effects from a stream. + +## -parameters +### -param mediaStreamType +The stream from which to remove the effects. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_close_811482585.md b/windows.media.capture/mediacapture_close_811482585.md index 75b51c7dd5..a56d5c2b43 100644 --- a/windows.media.capture/mediacapture_close_811482585.md +++ b/windows.media.capture/mediacapture_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.Close --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.Close ## -description Closes the media capture object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.Close + +## -description +Closes the media capture object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_createframereaderasync_1014922223.md b/windows.media.capture/mediacapture_createframereaderasync_1014922223.md index 70471d6893..39093c1eb9 100644 --- a/windows.media.capture/mediacapture_createframereaderasync_1014922223.md +++ b/windows.media.capture/mediacapture_createframereaderasync_1014922223.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource,System.String,Windows.Graphics.Imaging.BitmapSize) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync ## -description Creates a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) that is used to acquire frames with the specified media encoding subtype and size from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). ## -parameters ### -param inputSource The media frame source from which the reader will acquire frames. ### -param outputSubtype A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. ### -param outputSize An object specifying the requested size for the frames acquired by the frame reader. ## -returns An asynchronous operation that returns a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) on completion. ## -remarks ## -examples ## -see-also [CreateFrameReaderAsync(MediaFrameSource)](mediacapture_createframereaderasync_823585061.md), [CreateFrameReaderAsync(MediaFrameSource, String)](mediacapture_createframereaderasync_2112545947.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource,System.String,Windows.Graphics.Imaging.BitmapSize) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync + +## -description +Creates a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) that is used to acquire frames with the specified media encoding subtype and size from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). + +## -parameters +### -param inputSource +The media frame source from which the reader will acquire frames. + +### -param outputSubtype +A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. + +### -param outputSize +An object specifying the requested size for the frames acquired by the frame reader. + +## -returns +An asynchronous operation that returns a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) on completion. + +## -remarks + +## -examples + +## -see-also +[CreateFrameReaderAsync(MediaFrameSource)](mediacapture_createframereaderasync_823585061.md), [CreateFrameReaderAsync(MediaFrameSource, String)](mediacapture_createframereaderasync_2112545947.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_createframereaderasync_2112545947.md b/windows.media.capture/mediacapture_createframereaderasync_2112545947.md index 99c001073b..c81ef73535 100644 --- a/windows.media.capture/mediacapture_createframereaderasync_2112545947.md +++ b/windows.media.capture/mediacapture_createframereaderasync_2112545947.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource,System.String) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync ## -description Creates a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) that is used to acquire frames with the specified media encoding subtype from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). ## -parameters ### -param inputSource The media frame source from which the reader will acquire frames. ### -param outputSubtype A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. ## -returns An asynchronous operation that returns a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) on completion. ## -remarks ## -examples ## -see-also [CreateFrameReaderAsync(MediaFrameSource)](mediacapture_createframereaderasync_823585061.md), [CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)](mediacapture_createframereaderasync_1014922223.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync + +## -description +Creates a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) that is used to acquire frames with the specified media encoding subtype from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). + +## -parameters +### -param inputSource +The media frame source from which the reader will acquire frames. + +### -param outputSubtype +A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. + +## -returns +An asynchronous operation that returns a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) on completion. + +## -remarks + +## -examples + +## -see-also +[CreateFrameReaderAsync(MediaFrameSource)](mediacapture_createframereaderasync_823585061.md), [CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)](mediacapture_createframereaderasync_1014922223.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_createframereaderasync_823585061.md b/windows.media.capture/mediacapture_createframereaderasync_823585061.md index f59f11a457..b725c64ded 100644 --- a/windows.media.capture/mediacapture_createframereaderasync_823585061.md +++ b/windows.media.capture/mediacapture_createframereaderasync_823585061.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync ## -description Creates a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) that is used to acquire frames from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). ## -parameters ### -param inputSource The media frame source from which the reader will acquire frames. ## -returns An asynchronous operation that returns a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) on completion. ## -remarks ## -examples ## -see-also [CreateFrameReaderAsync(MediaFrameSource, String)](mediacapture_createframereaderasync_2112545947.md), [CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)](mediacapture_createframereaderasync_1014922223.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.CreateFrameReaderAsync + +## -description +Creates a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) that is used to acquire frames from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). + +## -parameters +### -param inputSource +The media frame source from which the reader will acquire frames. + +## -returns +An asynchronous operation that returns a [MediaFrameReader](../windows.media.capture.frames/mediaframereader.md) on completion. + +## -remarks + +## -examples + +## -see-also +[CreateFrameReaderAsync(MediaFrameSource, String)](mediacapture_createframereaderasync_2112545947.md), [CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)](mediacapture_createframereaderasync_1014922223.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_failed.md b/windows.media.capture/mediacapture_failed.md index a8fb54aa71..635e059668 100644 --- a/windows.media.capture/mediacapture_failed.md +++ b/windows.media.capture/mediacapture_failed.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Media.Capture.MediaCapture.Failed --api-type: winrt event ---- # Windows.Media.Capture.MediaCapture.Failed ## -description Raised when an error occurs during media capture. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.MediaCapture.Failed +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.Failed + +## -description +Raised when an error occurs during media capture. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_findallvideoprofiles_690787568.md b/windows.media.capture/mediacapture_findallvideoprofiles_690787568.md index 651e8eef4a..e49a07b7f9 100644 --- a/windows.media.capture/mediacapture_findallvideoprofiles_690787568.md +++ b/windows.media.capture/mediacapture_findallvideoprofiles_690787568.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.FindAllVideoProfiles(System.String) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.FindAllVideoProfiles ## -description Retrieves the list of all video profiles supported by the specified video capture device. ## -parameters ### -param videoDeviceId The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -returns The list of video profiles supported by the specified video capture device. ## -remarks Before calling this method, call [IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that the capture device supports video profiles. Use [FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md) to request profiles with specific functionality using one of the [KnownVideoProfile](knownvideoprofile.md) values. For how-to guidance for working with camera profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). ## -examples ## -see-also [FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md), [FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.FindAllVideoProfiles(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.FindAllVideoProfiles + +## -description +Retrieves the list of all video profiles supported by the specified video capture device. + +## -parameters +### -param videoDeviceId +The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -returns +The list of video profiles supported by the specified video capture device. + +## -remarks +Before calling this method, call [IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that the capture device supports video profiles. + +Use [FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md) to request profiles with specific functionality using one of the [KnownVideoProfile](knownvideoprofile.md) values. + +For how-to guidance for working with camera profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). + +## -examples + +## -see-also +[FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md), [FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_findconcurrentprofiles_834250833.md b/windows.media.capture/mediacapture_findconcurrentprofiles_834250833.md index 63e28f3802..9ddbcc1310 100644 --- a/windows.media.capture/mediacapture_findconcurrentprofiles_834250833.md +++ b/windows.media.capture/mediacapture_findconcurrentprofiles_834250833.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.FindConcurrentProfiles(System.String) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.FindConcurrentProfiles ## -description Retrieves the list of video profiles supported by the specified video capture device that can be used while another profile is used on a different capture device. ## -parameters ### -param videoDeviceId The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -returns The list of video profiles supported by the specified video capture device that support concurrency. ## -remarks Before calling this method, call [IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that the capture device supports video profiles. This method supports the scenario where you capture video from two capture devices at the same time, such as a device's front camera and rear camera. Call the [GetConcurrency](mediacapturevideoprofile_getconcurrency.md) method of one of the [MediaCaptureVideoProfile](mediacapturevideoprofile.md) objects in the returned list to get a list of profiles that can be used concurrently with that profile. For how-to guidance for working with camera profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). ## -examples ## -see-also [MediaCaptureVideoProfile::GetConcurrency](mediacapturevideoprofile_getconcurrency.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.FindConcurrentProfiles(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.FindConcurrentProfiles + +## -description +Retrieves the list of video profiles supported by the specified video capture device that can be used while another profile is used on a different capture device. + +## -parameters +### -param videoDeviceId +The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -returns +The list of video profiles supported by the specified video capture device that support concurrency. + +## -remarks +Before calling this method, call [IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that the capture device supports video profiles. + +This method supports the scenario where you capture video from two capture devices at the same time, such as a device's front camera and rear camera. Call the [GetConcurrency](mediacapturevideoprofile_getconcurrency.md) method of one of the [MediaCaptureVideoProfile](mediacapturevideoprofile.md) objects in the returned list to get a list of profiles that can be used concurrently with that profile. + +For how-to guidance for working with camera profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). + +## -examples + +## -see-also +[MediaCaptureVideoProfile::GetConcurrency](mediacapturevideoprofile_getconcurrency.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_findknownvideoprofiles_875917242.md b/windows.media.capture/mediacapture_findknownvideoprofiles_875917242.md index ce30a9f90b..82b2ad68bc 100644 --- a/windows.media.capture/mediacapture_findknownvideoprofiles_875917242.md +++ b/windows.media.capture/mediacapture_findknownvideoprofiles_875917242.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.FindKnownVideoProfiles(System.String,Windows.Media.Capture.KnownVideoProfile) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.FindKnownVideoProfiles ## -description Retrieves the list of all video profiles supported by the specified video capture device that match the specified [KnownVideoProfile](knownvideoprofile.md) value. ## -parameters ### -param videoDeviceId The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ### -param name A value specifying one of the profile names known by the system. ## -returns The list of video profiles supported by the specified video capture device that match the specified known profile name. ## -remarks Before calling this method, call [IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that the capture device supports video profiles. This method allows you to request profiles with specific functionality by using one of the [KnownVideoProfile](knownvideoprofile.md) values. Some hardware may support additional profiles that do not correspond to any of the known profile names. Use [FindAllVideoProfiles](mediacapture_findallvideoprofiles.md) to retrieve all video profiles supported by the video capture device. For how-to guidance for working with camera profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). ## -examples ## -see-also [KnownVideoProfile](knownvideoprofile.md), [FindAllVideoProfiles](mediacapture_findallvideoprofiles.md), [FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.FindKnownVideoProfiles(System.String,Windows.Media.Capture.KnownVideoProfile) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.FindKnownVideoProfiles + +## -description +Retrieves the list of all video profiles supported by the specified video capture device that match the specified [KnownVideoProfile](knownvideoprofile.md) value. + +## -parameters +### -param videoDeviceId +The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +### -param name +A value specifying one of the profile names known by the system. + +## -returns +The list of video profiles supported by the specified video capture device that match the specified known profile name. + +## -remarks +Before calling this method, call [IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that the capture device supports video profiles. + +This method allows you to request profiles with specific functionality by using one of the [KnownVideoProfile](knownvideoprofile.md) values. Some hardware may support additional profiles that do not correspond to any of the known profile names. Use [FindAllVideoProfiles](mediacapture_findallvideoprofiles.md) to retrieve all video profiles supported by the video capture device. + +For how-to guidance for working with camera profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). + +## -examples + +## -see-also +[KnownVideoProfile](knownvideoprofile.md), [FindAllVideoProfiles](mediacapture_findallvideoprofiles.md), [FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_focuschanged.md b/windows.media.capture/mediacapture_focuschanged.md index 7bbab53a22..cbecc90181 100644 --- a/windows.media.capture/mediacapture_focuschanged.md +++ b/windows.media.capture/mediacapture_focuschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Capture.MediaCapture.FocusChanged --api-type: winrt event ---- # Windows.Media.Capture.MediaCapture.FocusChanged ## -description Occurs when the capture device changes focus. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.MediaCapture.FocusChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.FocusChanged + +## -description +Occurs when the capture device changes focus. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_framesources.md b/windows.media.capture/mediacapture_framesources.md index d416c8a67e..b809cbd400 100644 --- a/windows.media.capture/mediacapture_framesources.md +++ b/windows.media.capture/mediacapture_framesources.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapture.FrameSources --api-type: winrt property ---- # Windows.Media.Capture.MediaCapture.FrameSources ## -description Gets a read-only dictionary of [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) objects that can be used simultaneously to acquire media frames. ## -property-value A read-only dictionary of [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) objects that can be used simultaneously to acquire media frames. ## -remarks Initialize a [MediaCapture](mediacapturememorypreference.md) object to use media frame sources by setting the [SourceGroup](mediacaptureinitializationsettings_sourcegroup.md) property of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object to a [MediaFrameSourceGroup](../windows.media.capture.frames/mediaframesourcegroup.md) returned by [FindAllAsync](../windows.media.capture.frames/mediaframesourcegroup_findallasync.md) and then calling [MediaCapture.InitializeAsync](mediacapture_initializeasync.md). The key for each entry in the dictionary is the [Id](../windows.media.capture.frames/mediaframesourceinfo_id.md) property of the [MediaFrameSourceInfo](../windows.media.capture.frames/mediaframesourceinfo.md) associated with each frame source in the group. For more information on using frame sources, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapture.FrameSources +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapture.FrameSources + +## -description +Gets a read-only dictionary of [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) objects that can be used simultaneously to acquire media frames. + +## -property-value +A read-only dictionary of [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) objects that can be used simultaneously to acquire media frames. + +## -remarks +Initialize a [MediaCapture](mediacapturememorypreference.md) object to use media frame sources by setting the [SourceGroup](mediacaptureinitializationsettings_sourcegroup.md) property of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object to a [MediaFrameSourceGroup](../windows.media.capture.frames/mediaframesourcegroup.md) returned by [FindAllAsync](../windows.media.capture.frames/mediaframesourcegroup_findallasync.md) and then calling [MediaCapture.InitializeAsync](mediacapture_initializeasync.md). The key for each entry in the dictionary is the [Id](../windows.media.capture.frames/mediaframesourceinfo_id.md) property of the [MediaFrameSourceInfo](../windows.media.capture.frames/mediaframesourceinfo.md) associated with each frame source in the group. + +For more information on using frame sources, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_getencoderproperty_769455038.md b/windows.media.capture/mediacapture_getencoderproperty_769455038.md index d1702fb32b..767f4e9f34 100644 --- a/windows.media.capture/mediacapture_getencoderproperty_769455038.md +++ b/windows.media.capture/mediacapture_getencoderproperty_769455038.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.GetEncoderProperty(Windows.Media.Capture.MediaStreamType,System.Guid) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.GetEncoderProperty ## -description Gets the value of an encoding property. ## -parameters ### -param mediaStreamType Specifies the stream to query for the encoding property. ### -param propertyId The encoding property to retrieve. ## -returns Returns the value of the encoding property. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.GetEncoderProperty(Windows.Media.Capture.MediaStreamType,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.GetEncoderProperty + +## -description +Gets the value of an encoding property. + +## -parameters +### -param mediaStreamType +Specifies the stream to query for the encoding property. + +### -param propertyId +The encoding property to retrieve. + +## -returns +Returns the value of the encoding property. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_getpreviewframeasync_211909276.md b/windows.media.capture/mediacapture_getpreviewframeasync_211909276.md index c75070dbd7..ad806900cb 100644 --- a/windows.media.capture/mediacapture_getpreviewframeasync_211909276.md +++ b/windows.media.capture/mediacapture_getpreviewframeasync_211909276.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync ## -description Gets a preview frame from the capture device. ## -returns An asynchronous operation that returns a [VideoFrame](../windows.media/videoframe.md) on successful completion. ## -remarks This method returns the preview frame in the current format of the capture device without copying or converting the frame. To get the preview frame in another format, use the [GetPreviewFrameAsync(VideoFrame)](mediacapture_getpreviewframeasync_440877418.md) overload and pass in a [VideoFrame](mediacapture_getpreviewframeasync_440877418.md) with your desired format. For how-to guidance on preview frames, see [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame). ## -examples ## -see-also [GetPreviewFrameAsync(VideoFrame)](mediacapture_getpreviewframeasync_440877418.md), [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync + +## -description +Gets a preview frame from the capture device. + +## -returns +An asynchronous operation that returns a [VideoFrame](../windows.media/videoframe.md) on successful completion. + +## -remarks +This method returns the preview frame in the current format of the capture device without copying or converting the frame. To get the preview frame in another format, use the [GetPreviewFrameAsync(VideoFrame)](mediacapture_getpreviewframeasync_440877418.md) overload and pass in a [VideoFrame](mediacapture_getpreviewframeasync_440877418.md) with your desired format. + +For how-to guidance on preview frames, see [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame). + +## -examples + +## -see-also +[GetPreviewFrameAsync(VideoFrame)](mediacapture_getpreviewframeasync_440877418.md), [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_getpreviewframeasync_440877418.md b/windows.media.capture/mediacapture_getpreviewframeasync_440877418.md index 75a00b2166..342db1eed1 100644 --- a/windows.media.capture/mediacapture_getpreviewframeasync_440877418.md +++ b/windows.media.capture/mediacapture_getpreviewframeasync_440877418.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync(Windows.Media.VideoFrame) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync ## -description Gets a preview frame from the capture device, copied into the provided destination [VideoFrame](../windows.media/videoframe.md) and converted into the destination frame's format. ## -parameters ### -param destination The video frame into which the preview frame will be copied. ## -returns An asynchronous operation that returns a [VideoFrame](../windows.media/videoframe.md) on successful completion. ## -remarks To get a preview frame without going through a copy or conversion operation, use the no argument overload of [GetPreviewFrameAsync](mediacapture_getpreviewframeasync_440877418.md). For how-to guidance on preview frames, see [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame). ## -examples ## -see-also [GetPreviewFrameAsync](mediacapture_getpreviewframeasync_211909276.md), [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync(Windows.Media.VideoFrame) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.GetPreviewFrameAsync + +## -description +Gets a preview frame from the capture device, copied into the provided destination [VideoFrame](../windows.media/videoframe.md) and converted into the destination frame's format. + +## -parameters +### -param destination +The video frame into which the preview frame will be copied. + +## -returns +An asynchronous operation that returns a [VideoFrame](../windows.media/videoframe.md) on successful completion. + +## -remarks +To get a preview frame without going through a copy or conversion operation, use the no argument overload of [GetPreviewFrameAsync](mediacapture_getpreviewframeasync_440877418.md). + +For how-to guidance on preview frames, see [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame). + +## -examples + +## -see-also +[GetPreviewFrameAsync](mediacapture_getpreviewframeasync_211909276.md), [Get a preview frame](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/get-a-preview-frame) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_getpreviewmirroring_1161627250.md b/windows.media.capture/mediacapture_getpreviewmirroring_1161627250.md index 4630db64f7..d42bc13d8b 100644 --- a/windows.media.capture/mediacapture_getpreviewmirroring_1161627250.md +++ b/windows.media.capture/mediacapture_getpreviewmirroring_1161627250.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewMirroring --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.GetPreviewMirroring ## -description Queries whether the video stream is mirrored horizontally. ## -returns True if mirroring is enabled; false otherwise. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewMirroring +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.GetPreviewMirroring + +## -description +Queries whether the video stream is mirrored horizontally. + +## -returns +True if mirroring is enabled; false otherwise. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_getpreviewrotation_43831766.md b/windows.media.capture/mediacapture_getpreviewrotation_43831766.md index 232a149934..c451106a48 100644 --- a/windows.media.capture/mediacapture_getpreviewrotation_43831766.md +++ b/windows.media.capture/mediacapture_getpreviewrotation_43831766.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewRotation --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.GetPreviewRotation ## -description Gets the rotation of the video preview stream. ## -returns The amount by which the video preview stream is rotated. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.GetPreviewRotation +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.GetPreviewRotation + +## -description +Gets the rotation of the video preview stream. + +## -returns +The amount by which the video preview stream is rotated. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_getrecordrotation_965341046.md b/windows.media.capture/mediacapture_getrecordrotation_965341046.md index 4d2a29b2c9..ccc822323b 100644 --- a/windows.media.capture/mediacapture_getrecordrotation_965341046.md +++ b/windows.media.capture/mediacapture_getrecordrotation_965341046.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.GetRecordRotation --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.GetRecordRotation ## -description Gets the rotation of the recorded video. ## -returns The amount by which the recorded video is rotated. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.GetRecordRotation +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.GetRecordRotation + +## -description +Gets the rotation of the recorded video. + +## -returns +The amount by which the recorded video is rotated. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_initializeasync_315323248.md b/windows.media.capture/mediacapture_initializeasync_315323248.md index 5a8a01a07d..3df4ee867a 100644 --- a/windows.media.capture/mediacapture_initializeasync_315323248.md +++ b/windows.media.capture/mediacapture_initializeasync_315323248.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.InitializeAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.InitializeAsync ## -description Initializes the [MediaCapture](mediacapture.md) object, using default settings. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks [InitializeAsync](mediacapture_initializeasync_315323248.md) will launch a consent prompt to get the user's permission for the app to access the microphone or camera. [InitializeAsync](mediacapture_initializeasync_315323248.md) should be called from the main UI thread of your app. In apps that use C# or C++, the first use of the [MediaCapture](mediacapture.md) object to call [InitializeAsync](mediacapture_initializeasync.md) should be on the STA thread. Calls from an MTA thread may result in undefined behavior. For how-to guidance on initializing and shutting down the **MediaCapture** object, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [InitializeAsync(MediaCaptureInitializationSettings)](mediacapture_initializeasync_837464435.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.InitializeAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.InitializeAsync + +## -description +Initializes the [MediaCapture](mediacapture.md) object, using default settings. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +[InitializeAsync](mediacapture_initializeasync_315323248.md) will launch a consent prompt to get the user's permission for the app to access the microphone or camera. [InitializeAsync](mediacapture_initializeasync_315323248.md) should be called from the main UI thread of your app. In apps that use C# or C++, the first use of the [MediaCapture](mediacapture.md) object to call [InitializeAsync](mediacapture_initializeasync.md) should be on the STA thread. Calls from an MTA thread may result in undefined behavior. + +For how-to guidance on initializing and shutting down the **MediaCapture** object, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[InitializeAsync(MediaCaptureInitializationSettings)](mediacapture_initializeasync_837464435.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_initializeasync_837464435.md b/windows.media.capture/mediacapture_initializeasync_837464435.md index 6e81a88857..583636e552 100644 --- a/windows.media.capture/mediacapture_initializeasync_837464435.md +++ b/windows.media.capture/mediacapture_initializeasync_837464435.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.InitializeAsync(Windows.Media.Capture.MediaCaptureInitializationSettings) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.InitializeAsync ## -description Initializes the [MediaCapture](mediacapture.md) object. ## -parameters ### -param mediaCaptureInitializationSettings The initialization settings. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks [InitializeAsync](mediacapture_initializeasync_837464435.md) will launch a consent prompt to get the user's permission for the app to access the microphone or camera. [InitializeAsync](mediacapture_initializeasync_837464435.md) should be called from the main UI thread of your app. In apps that use C# or C++, the first use of the [MediaCapture](mediacapture.md) object to call [InitializeAsync](mediacapture_initializeasync.md) should be on the STA thread. Calls from an MTA thread may result in undefined behavior. For how-to guidance on initializing and shutting down the **MediaCapture** object, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [InitializeAsync](mediacapture_initializeasync_315323248.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.InitializeAsync(Windows.Media.Capture.MediaCaptureInitializationSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.InitializeAsync + +## -description +Initializes the [MediaCapture](mediacapture.md) object. + +## -parameters +### -param mediaCaptureInitializationSettings +The initialization settings. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +[InitializeAsync](mediacapture_initializeasync_837464435.md) will launch a consent prompt to get the user's permission for the app to access the microphone or camera. [InitializeAsync](mediacapture_initializeasync_837464435.md) should be called from the main UI thread of your app. In apps that use C# or C++, the first use of the [MediaCapture](mediacapture.md) object to call [InitializeAsync](mediacapture_initializeasync.md) should be on the STA thread. Calls from an MTA thread may result in undefined behavior. + +For how-to guidance on initializing and shutting down the **MediaCapture** object, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[InitializeAsync](mediacapture_initializeasync_315323248.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_isvideoprofilesupported_190014579.md b/windows.media.capture/mediacapture_isvideoprofilesupported_190014579.md index ca57f58dd9..f4229029b4 100644 --- a/windows.media.capture/mediacapture_isvideoprofilesupported_190014579.md +++ b/windows.media.capture/mediacapture_isvideoprofilesupported_190014579.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.IsVideoProfileSupported(System.String) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.IsVideoProfileSupported ## -description Gets a boolean value indicating whether video profiles are supported by the specified video capture device. ## -parameters ### -param videoDeviceId The identifier of the video device for which supported video profile support is queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). ## -returns True if video profiles are supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.IsVideoProfileSupported(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.IsVideoProfileSupported + +## -description +Gets a boolean value indicating whether video profiles are supported by the specified video capture device. + +## -parameters +### -param videoDeviceId +The identifier of the video device for which supported video profile support is queried. For information on getting the video device ID, see [DeviceInformation::FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md). + +## -returns +True if video profiles are supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_mediacapture_1221375020.md b/windows.media.capture/mediacapture_mediacapture_1221375020.md index 5e8def82b9..deef9cf1fb 100644 --- a/windows.media.capture/mediacapture_mediacapture_1221375020.md +++ b/windows.media.capture/mediacapture_mediacapture_1221375020.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.#ctor --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.MediaCapture ## -description Creates a new instance of the [MediaCapture](mediacapture.md) object. ## -remarks You must call [InitializeAsync](mediacapture_initializeasync_315323248.md) before using the **MediaCapture** object. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.MediaCapture + +## -description +Creates a new instance of the [MediaCapture](mediacapture.md) object. + +## -remarks +You must call [InitializeAsync](mediacapture_initializeasync_315323248.md) before using the **MediaCapture** object. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_mediacapturesettings.md b/windows.media.capture/mediacapture_mediacapturesettings.md index 457bf13091..e3d2b33d5a 100644 --- a/windows.media.capture/mediacapture_mediacapturesettings.md +++ b/windows.media.capture/mediacapture_mediacapturesettings.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapture.MediaCaptureSettings --api-type: winrt property ---- # Windows.Media.Capture.MediaCapture.MediaCaptureSettings ## -description Gets the configuration settings for the [MediaCapture](mediacapture.md) object. ## -property-value A [MediaCaptureSettings](mediacapturesettings.md) object that contains the settings. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapture.MediaCaptureSettings +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapture.MediaCaptureSettings + +## -description +Gets the configuration settings for the [MediaCapture](mediacapture.md) object. + +## -property-value +A [MediaCaptureSettings](mediacapturesettings.md) object that contains the settings. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_pauserecordasync_1650376226.md b/windows.media.capture/mediacapture_pauserecordasync_1650376226.md index 2fb159c0f0..4d993f1f5d 100644 --- a/windows.media.capture/mediacapture_pauserecordasync_1650376226.md +++ b/windows.media.capture/mediacapture_pauserecordasync_1650376226.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PauseRecordAsync(Windows.Media.Devices.MediaCapturePauseBehavior) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PauseRecordAsync ## -description Pauses an ongoing record operation. ## -parameters ### -param behavior A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. ## -returns An asynchronous action. ## -remarks Resume recording by calling [ResumeRecordAsync](mediacapture_resumerecordasync.md). ## -examples ## -see-also [ResumeRecordAsync](mediacapture_resumerecordasync.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PauseRecordAsync(Windows.Media.Devices.MediaCapturePauseBehavior) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PauseRecordAsync + +## -description +Pauses an ongoing record operation. + +## -parameters +### -param behavior +A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. + +## -returns +An asynchronous action. + +## -remarks +Resume recording by calling [ResumeRecordAsync](mediacapture_resumerecordasync.md). + +## -examples + +## -see-also +[ResumeRecordAsync](mediacapture_resumerecordasync.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_pauserecordwithresultasync_97197073.md b/windows.media.capture/mediacapture_pauserecordwithresultasync_97197073.md index bd6ef87637..21a93b5ac7 100644 --- a/windows.media.capture/mediacapture_pauserecordwithresultasync_97197073.md +++ b/windows.media.capture/mediacapture_pauserecordwithresultasync_97197073.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PauseRecordWithResultAsync(Windows.Media.Devices.MediaCapturePauseBehavior) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PauseRecordWithResultAsync ## -description Pauses an ongoing media record operation and provides a [MediaCapturePauseResult](mediacapturepauseresult.md) that can be used to help the user align the camera with the last captured frame when resuming recording. ## -parameters ### -param behavior A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. ## -returns An asynchronous action that returns a [MediaCapturePauseResult](mediacapturepauseresult.md) upon completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PauseRecordWithResultAsync(Windows.Media.Devices.MediaCapturePauseBehavior) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PauseRecordWithResultAsync + +## -description +Pauses an ongoing media record operation and provides a [MediaCapturePauseResult](mediacapturepauseresult.md) that can be used to help the user align the camera with the last captured frame when resuming recording. + +## -parameters +### -param behavior +A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. + +## -returns +An asynchronous action that returns a [MediaCapturePauseResult](mediacapturepauseresult.md) upon completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_photoconfirmationcaptured.md b/windows.media.capture/mediacapture_photoconfirmationcaptured.md index 0f0ec0d575..0ebc17cca2 100644 --- a/windows.media.capture/mediacapture_photoconfirmationcaptured.md +++ b/windows.media.capture/mediacapture_photoconfirmationcaptured.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.MediaCapture.PhotoConfirmationCaptured --api-type: winrt event ---- # Windows.Media.Capture.MediaCapture.PhotoConfirmationCaptured ## -description Occurs when a photo confirmation frame is captured. ## -remarks The [CapturedFrame](capturedframe.md) object passed to this event contains raw pixel data and therefore must be manually copied into the pixel buffer of a bitmap. For information on how to do this, see the Remarks section of the [Frame](photoconfirmationcapturedeventargs_frame.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.MediaCapture.PhotoConfirmationCaptured +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.PhotoConfirmationCaptured + +## -description +Occurs when a photo confirmation frame is captured. + +## -remarks +The [CapturedFrame](capturedframe.md) object passed to this event contains raw pixel data and therefore must be manually copied into the pixel buffer of a bitmap. For information on how to do this, see the Remarks section of the [Frame](photoconfirmationcapturedeventargs_frame.md) property. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_prepareadvancedphotocaptureasync_1274714827.md b/windows.media.capture/mediacapture_prepareadvancedphotocaptureasync_1274714827.md index bcc8d3c58d..22695f28bb 100644 --- a/windows.media.capture/mediacapture_prepareadvancedphotocaptureasync_1274714827.md +++ b/windows.media.capture/mediacapture_prepareadvancedphotocaptureasync_1274714827.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareAdvancedPhotoCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareAdvancedPhotoCaptureAsync ## -description Initializes the advanced photo capture and provides the [AdvancedPhotoCapture](advancedphotocapture.md) object used to manage the recording. ## -parameters ### -param encodingProperties The encoding properties used for the resulting image. ## -returns An asynchronous operation that returns an [AdvancedPhotoCapture](advancedphotocapture.md) object on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareAdvancedPhotoCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareAdvancedPhotoCaptureAsync + +## -description +Initializes the advanced photo capture and provides the [AdvancedPhotoCapture](advancedphotocapture.md) object used to manage the recording. + +## -parameters +### -param encodingProperties +The encoding properties used for the resulting image. + +## -returns +An asynchronous operation that returns an [AdvancedPhotoCapture](advancedphotocapture.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_preparelowlagphotocaptureasync_1426375994.md b/windows.media.capture/mediacapture_preparelowlagphotocaptureasync_1426375994.md index 868532d05f..571b47dac9 100644 --- a/windows.media.capture/mediacapture_preparelowlagphotocaptureasync_1426375994.md +++ b/windows.media.capture/mediacapture_preparelowlagphotocaptureasync_1426375994.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoCaptureAsync ## -description Initializes the low shutter lag photo capture and provides the [LowLagPhotoCapture](lowlagphotocapture.md) object used to manage the recording. ## -parameters ### -param type The encoding profile used for the image. ## -returns When this method completes, a [LowLagPhotoCapture](lowlagphotocapture.md) object is returned which can be used to start the photo capture. ## -remarks Use [PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) to initialize the capture. This is an asynchronous calls which returns a [LowLagPhotoCapture](lowlagphotocapture.md) object when it is finished, which is used to start the actual photo capture by calling [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md). [PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) must be called before [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md). For how-to guidance on using [LowLagPhotoCapture](lowlagphotocapture.md) to capture a photo, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [LowLagPhotoCapture](lowlagphotocapture.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoCaptureAsync + +## -description +Initializes the low shutter lag photo capture and provides the [LowLagPhotoCapture](lowlagphotocapture.md) object used to manage the recording. + +## -parameters +### -param type +The encoding profile used for the image. + +## -returns +When this method completes, a [LowLagPhotoCapture](lowlagphotocapture.md) object is returned which can be used to start the photo capture. + +## -remarks +Use [PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) to initialize the capture. This is an asynchronous calls which returns a [LowLagPhotoCapture](lowlagphotocapture.md) object when it is finished, which is used to start the actual photo capture by calling [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md). + +[PrepareLowLagPhotoCaptureAsync](mediacapture_preparelowlagphotocaptureasync.md) must be called before [LowLagPhotoCapture.CaptureAsync](lowlagphotocapture_captureasync.md). + +For how-to guidance on using [LowLagPhotoCapture](lowlagphotocapture.md) to capture a photo, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [LowLagPhotoCapture](lowlagphotocapture.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_preparelowlagphotosequencecaptureasync_2130225421.md b/windows.media.capture/mediacapture_preparelowlagphotosequencecaptureasync_2130225421.md index deb3d64e5c..461ae8696c 100644 --- a/windows.media.capture/mediacapture_preparelowlagphotosequencecaptureasync_2130225421.md +++ b/windows.media.capture/mediacapture_preparelowlagphotosequencecaptureasync_2130225421.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync ## -description Initializes the low shutter lag photo sequence capture and provides the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object used to manage the recording. ## -parameters ### -param type The encoding profile used for the image. ## -returns When this method completes, a [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object is returned which can be used to start the photo sequence capture. ## -remarks Use [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize the photo sequence capture. This is an asynchronous call which returns a [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object when it is finished, which is used start the photo sequence capture by calling [LowLagPhotoSequenceCapture.StartAsync](lowlagphotosequencecapture_startasync.md). [PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) must be called before [LowLagPhotoSequenceCapture.StartAsync](lowlagphotosequencecapture_startasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync + +## -description +Initializes the low shutter lag photo sequence capture and provides the [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object used to manage the recording. + +## -parameters +### -param type +The encoding profile used for the image. + +## -returns +When this method completes, a [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object is returned which can be used to start the photo sequence capture. + +## -remarks +Use [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) to initialize the photo sequence capture. This is an asynchronous call which returns a [LowLagPhotoSequenceCapture](lowlagphotosequencecapture.md) object when it is finished, which is used start the photo sequence capture by calling [LowLagPhotoSequenceCapture.StartAsync](lowlagphotosequencecapture_startasync.md). + +[PrepareLowLagPhotoSequenceCaptureAsync](mediacapture_preparelowlagphotosequencecaptureasync.md) must be called before [LowLagPhotoSequenceCapture.StartAsync](lowlagphotosequencecapture_startasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_1787918353.md b/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_1787918353.md index 5902f63072..e98f3b5c45 100644 --- a/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_1787918353.md +++ b/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_1787918353.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Media.IMediaExtension) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync ## -description Initializes the low lag recording using the specified custom sink to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the capture. ## -parameters ### -param encodingProfile The encoding profile to use for the recording. ### -param customMediaSink The media extension for the custom media sink. ## -returns When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. ## -remarks ## -examples ## -see-also [PrepareLowLagRecordToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)](mediacapture_preparelowlagrecordtocustomsinkasync_823836881.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Media.IMediaExtension) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync + +## -description +Initializes the low lag recording using the specified custom sink to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the capture. + +## -parameters +### -param encodingProfile +The encoding profile to use for the recording. + +### -param customMediaSink +The media extension for the custom media sink. + +## -returns +When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. + +## -remarks + +## -examples + +## -see-also +[PrepareLowLagRecordToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)](mediacapture_preparelowlagrecordtocustomsinkasync_823836881.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_823836881.md b/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_823836881.md index d1bfe4d08a..f275bc497a 100644 --- a/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_823836881.md +++ b/windows.media.capture/mediacapture_preparelowlagrecordtocustomsinkasync_823836881.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync ## -description Initializes the low lag recording using the specified custom sink to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the recording. ## -parameters ### -param encodingProfile The encoding profile to use for the recording. ### -param customSinkActivationId The activatable class ID of the media extension for the custom media sink. ### -param customSinkSettings Contains properties of the media extension. ## -returns When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. ## -remarks ## -examples ## -see-also [PrepareLowLagRecordToCustomSinkAsync(MediaEncodingProfile, IMediaExtension)](mediacapture_preparelowlagrecordtocustomsinkasync_1787918353.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToCustomSinkAsync + +## -description +Initializes the low lag recording using the specified custom sink to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the recording. + +## -parameters +### -param encodingProfile +The encoding profile to use for the recording. + +### -param customSinkActivationId +The activatable class ID of the media extension for the custom media sink. + +### -param customSinkSettings +Contains properties of the media extension. + +## -returns +When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. + +## -remarks + +## -examples + +## -see-also +[PrepareLowLagRecordToCustomSinkAsync(MediaEncodingProfile, IMediaExtension)](mediacapture_preparelowlagrecordtocustomsinkasync_1787918353.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_preparelowlagrecordtostoragefileasync_1085563722.md b/windows.media.capture/mediacapture_preparelowlagrecordtostoragefileasync_1085563722.md index b40367c599..402599515e 100644 --- a/windows.media.capture/mediacapture_preparelowlagrecordtostoragefileasync_1085563722.md +++ b/windows.media.capture/mediacapture_preparelowlagrecordtostoragefileasync_1085563722.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStorageFileAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStorageFileAsync ## -description Initializes the low lag recording using the specified file to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the recording. ## -parameters ### -param encodingProfile The encoding profile for the recording. ### -param file The storage file where the image is saved. ## -returns When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStorageFileAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStorageFileAsync + +## -description +Initializes the low lag recording using the specified file to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the recording. + +## -parameters +### -param encodingProfile +The encoding profile for the recording. + +### -param file +The storage file where the image is saved. + +## -returns +When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_preparelowlagrecordtostreamasync_1450185294.md b/windows.media.capture/mediacapture_preparelowlagrecordtostreamasync_1450185294.md index 9f8dbd3dad..b7ac02aedd 100644 --- a/windows.media.capture/mediacapture_preparelowlagrecordtostreamasync_1450185294.md +++ b/windows.media.capture/mediacapture_preparelowlagrecordtostreamasync_1450185294.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStreamAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStreamAsync ## -description Initializes the low lag recording using the specified random-access stream to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the recording. ## -parameters ### -param encodingProfile The encoding profile for the recording. ### -param stream The stream where the image data is written. ## -returns When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStreamAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareLowLagRecordToStreamAsync + +## -description +Initializes the low lag recording using the specified random-access stream to store the recording. This method provides the [LowLagMediaRecording](lowlagmediarecording.md) object used to managed the recording. + +## -parameters +### -param encodingProfile +The encoding profile for the recording. + +### -param stream +The stream where the image data is written. + +## -returns +When this method completes, a [LowLagMediaRecording](lowlagmediarecording.md) object is returned which can be used to start the photo capture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync_262453199.md b/windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync_262453199.md index e149d62af4..ffa3ce18a8 100644 --- a/windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync_262453199.md +++ b/windows.media.capture/mediacapture_preparevariablephotosequencecaptureasync_262453199.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.PrepareVariablePhotoSequenceCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.PrepareVariablePhotoSequenceCaptureAsync ## -description Initializes the variable photo sequence capture and provides the [VariablePhotoSequenceCapture](../windows.media.capture.core/variablephotosequencecapture.md) object used to manage the recording. ## -parameters ### -param type The encoding profile used for the image. ## -returns When this method completes, a [VariablePhotoSequenceCapture](../windows.media.capture.core/variablephotosequencecapture.md) object is returned which can be used to start the photo sequence capture. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.PrepareVariablePhotoSequenceCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.PrepareVariablePhotoSequenceCaptureAsync + +## -description +Initializes the variable photo sequence capture and provides the [VariablePhotoSequenceCapture](../windows.media.capture.core/variablephotosequencecapture.md) object used to manage the recording. + +## -parameters +### -param type +The encoding profile used for the image. + +## -returns +When this method completes, a [VariablePhotoSequenceCapture](../windows.media.capture.core/variablephotosequencecapture.md) object is returned which can be used to start the photo sequence capture. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_recordlimitationexceeded.md b/windows.media.capture/mediacapture_recordlimitationexceeded.md index 7c8ac42f26..f3ea1515ea 100644 --- a/windows.media.capture/mediacapture_recordlimitationexceeded.md +++ b/windows.media.capture/mediacapture_recordlimitationexceeded.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Media.Capture.MediaCapture.RecordLimitationExceeded --api-type: winrt event ---- # Windows.Media.Capture.MediaCapture.RecordLimitationExceeded ## -description Occurs when the record limit is exceeded. ## -remarks If an app receives a [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) event, it is expected to finalize the file it is recording. If it does not finalize, the capture engine will stop sending samples to the file that the app was recording to. In the current release, the record limit is three hours. ## -examples ## -see-also [StartRecordToStorageFileAsync](mediacapture_startrecordtostoragefileasync.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.MediaCapture.RecordLimitationExceeded +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.RecordLimitationExceeded + +## -description +Occurs when the record limit is exceeded. + +## -remarks +If an app receives a [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) event, it is expected to finalize the file it is recording. If it does not finalize, the capture engine will stop sending samples to the file that the app was recording to. + +In the current release, the record limit is three hours. + +## -examples + +## -see-also +[StartRecordToStorageFileAsync](mediacapture_startrecordtostoragefileasync.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_removeeffectasync_962990086.md b/windows.media.capture/mediacapture_removeeffectasync_962990086.md index 4d1aaaf39f..bbb9dea13b 100644 --- a/windows.media.capture/mediacapture_removeeffectasync_962990086.md +++ b/windows.media.capture/mediacapture_removeeffectasync_962990086.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.RemoveEffectAsync(Windows.Media.IMediaExtension) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.RemoveEffectAsync ## -description Removes the specified effect from the capture pipeline. ## -parameters ### -param effect The effect to remove from the capture pipeline. ## -returns Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks Pass the effect instance returned by [AddVideoEffectAsync](mediacapture_addvideoeffectasync.md) or [AddAudioEffectAsync](mediacapture_addaudioeffectasync.md) into this method to remove the effect from the pipeline. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.RemoveEffectAsync(Windows.Media.IMediaExtension) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.RemoveEffectAsync + +## -description +Removes the specified effect from the capture pipeline. + +## -parameters +### -param effect +The effect to remove from the capture pipeline. + +## -returns +Returns an [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +Pass the effect instance returned by [AddVideoEffectAsync](mediacapture_addvideoeffectasync.md) or [AddAudioEffectAsync](mediacapture_addaudioeffectasync.md) into this method to remove the effect from the pipeline. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_resumerecordasync_654128650.md b/windows.media.capture/mediacapture_resumerecordasync_654128650.md index 7066bceec1..423ccdf99d 100644 --- a/windows.media.capture/mediacapture_resumerecordasync_654128650.md +++ b/windows.media.capture/mediacapture_resumerecordasync_654128650.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.ResumeRecordAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.ResumeRecordAsync ## -description Resumes a paused recording operation. ## -returns An asynchronous operation. ## -remarks Pause recording by calling [PauseRecordAsync](mediacapture_pauserecordasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.ResumeRecordAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.ResumeRecordAsync + +## -description +Resumes a paused recording operation. + +## -returns +An asynchronous operation. + +## -remarks +Pause recording by calling [PauseRecordAsync](mediacapture_pauserecordasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_setencoderproperty_1595136570.md b/windows.media.capture/mediacapture_setencoderproperty_1595136570.md index 7f49d1ff9f..284b2d2752 100644 --- a/windows.media.capture/mediacapture_setencoderproperty_1595136570.md +++ b/windows.media.capture/mediacapture_setencoderproperty_1595136570.md @@ -1,3 +1,44 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.SetEncoderProperty(Windows.Media.Capture.MediaStreamType,System.Guid,System.Object) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.SetEncoderProperty ## -description Sets an encoding property. ## -parameters ### -param mediaStreamType The type of media data the stream represents, such as video or audio. ### -param propertyId The encoding property to set. ### -param propertyValue The new value of the encoding property. ## -remarks You can only call [SetEncoderProperty](mediacapture_setencoderproperty.md) with *mediaStreamType* equal to [MediaStreamType.Audio](mediastreamtype.md), if the encoder property is applied to only the audio encoder in the record sink. The preview sink does not allow you to set an encoding profile with compressed audio. For non-H.264 cameras, when you call [SetEncoderProperty](mediacapture_setencoderproperty.md) before recording or previewing has started, the property is stored locally. When you start recording, the property is applied to the encoder at the time of encoder initialization. To configure static encoding properties, you must call [SetEncoderProperty](mediacapture_setencoderproperty.md) before recording or previewing starts. Before recording or previewing starts, [GetEncoderProperty](mediacapture_getencoderproperty.md) will return the value of the property stored locally. If the camera is a H.264 camera and the stream that [SetEncoderProperty](mediacapture_setencoderproperty.md) is called on is of type [MediaStreamType.VideoRecord](mediastreamtype.md), then the property is applied directly to the camera. This is true both before and after recording has started. For non-H.264 cameras, when you call [SetEncoderProperty](mediacapture_setencoderproperty.md) after you get the record or preview started completion callback, the property is set directly on the encoder and is therefore used to configure dynamic encoding properties. If you call [SetEncoderProperty](mediacapture_setencoderproperty.md) after you issue a call to start recording or previewing and before you get the record or preview started completion callback, you will receive an **MF_E_INVALIDREQUEST** error since the property cannot be applied to static nor dynamic settings. To rotate the preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](XREF:TODO:mf.mf_mt_video_rotation). For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.SetEncoderProperty(Windows.Media.Capture.MediaStreamType,System.Guid,System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.SetEncoderProperty + +## -description +Sets an encoding property. + +## -parameters +### -param mediaStreamType +The type of media data the stream represents, such as video or audio. + +### -param propertyId +The encoding property to set. + +### -param propertyValue +The new value of the encoding property. + +## -remarks +You can only call [SetEncoderProperty](mediacapture_setencoderproperty.md) with *mediaStreamType* equal to [MediaStreamType.Audio](mediastreamtype.md), if the encoder property is applied to only the audio encoder in the record sink. The preview sink does not allow you to set an encoding profile with compressed audio. + +For non-H.264 cameras, when you call [SetEncoderProperty](mediacapture_setencoderproperty.md) before recording or previewing has started, the property is stored locally. When you start recording, the property is applied to the encoder at the time of encoder initialization. To configure static encoding properties, you must call [SetEncoderProperty](mediacapture_setencoderproperty.md) before recording or previewing starts. Before recording or previewing starts, [GetEncoderProperty](mediacapture_getencoderproperty.md) will return the value of the property stored locally. + +If the camera is a H.264 camera and the stream that [SetEncoderProperty](mediacapture_setencoderproperty.md) is called on is of type [MediaStreamType.VideoRecord](mediastreamtype.md), then the property is applied directly to the camera. This is true both before and after recording has started. + +For non-H.264 cameras, when you call [SetEncoderProperty](mediacapture_setencoderproperty.md) after you get the record or preview started completion callback, the property is set directly on the encoder and is therefore used to configure dynamic encoding properties. + +If you call [SetEncoderProperty](mediacapture_setencoderproperty.md) after you issue a call to start recording or previewing and before you get the record or preview started completion callback, you will receive an **MF_E_INVALIDREQUEST** error since the property cannot be applied to static nor dynamic settings. + +To rotate the preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](XREF:TODO:mf.mf_mt_video_rotation). For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md b/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md index 5534fd0d23..bec5dbe9d6 100644 --- a/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md +++ b/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.SetEncodingPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties,Windows.Media.MediaProperties.MediaPropertySet) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.SetEncodingPropertiesAsync ## -description Asynchronously sets the media encoding properties. ## -parameters ### -param mediaStreamType The type of media data the stream represents, such as video or audio. ### -param mediaEncodingProperties The properties for the media encoding. ### -param encoderProperties The properties for the encoder. ## -returns Object that is used to control the asynchronous operation. ## -remarks This method sets the encoding properties of the encoder that processes the data before it’s passed on to a [CaptureElement](../windows.ui.xaml.controls/captureelement.md) to be displayed, written out to a [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) or [StorageFile](../windows.storage/storagefile.md), or delivered to a custom media sink. This method does not change the configuration of the source of the data, which is the camera device. It is possible to set the encoding properties to a resolution that is not natively supported by the camera. In this case, the **MediaCapture** pipeline will use an encoder to perform the conversion to the requested format. Note that this conversion does consume system resources and can result in poor performance or even errors, especially on devices that with limited or no graphics acceleration. For typical scenarios, it is recommended that you choose a resolution supported by the camera that is closest to your desired resolution. You can get a list of a capture device's supported resolutions by calling [VideoDeviceController.GetAvailableMediaStreamProperties](../windows.media.devices/videodevicecontroller_getavailablemediastreamproperties.md). For more information, see [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) and the [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252). To rotate the record or preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](XREF:TODO:mf.mf_mt_video_rotation) to add metadata to the stream. Note that this rotation is performed by the consumer of the stream, such as the **CaptureElement** or a video player app, while the actual pixels in the stream still retain their original orientation. For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). To modify the properties of the capture device, use [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). ## -examples ## -see-also [GetAvailableMediaStreamProperties](../windows.media.devices/videodevicecontroller_getavailablemediastreamproperties.md), [SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md), [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties), [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture), [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.SetEncodingPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties,Windows.Media.MediaProperties.MediaPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.SetEncodingPropertiesAsync + +## -description +Asynchronously sets the media encoding properties. + +## -parameters +### -param mediaStreamType +The type of media data the stream represents, such as video or audio. + +### -param mediaEncodingProperties +The properties for the media encoding. + +### -param encoderProperties +The properties for the encoder. + +## -returns +Object that is used to control the asynchronous operation. + +## -remarks +This method sets the encoding properties of the encoder that processes the data before it’s passed on to a [CaptureElement](../windows.ui.xaml.controls/captureelement.md) to be displayed, written out to a [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) or [StorageFile](../windows.storage/storagefile.md), or delivered to a custom media sink. This method does not change the configuration of the source of the data, which is the camera device. It is possible to set the encoding properties to a resolution that is not natively supported by the camera. In this case, the **MediaCapture** pipeline will use an encoder to perform the conversion to the requested format. Note that this conversion does consume system resources and can result in poor performance or even errors, especially on devices that with limited or no graphics acceleration. For typical scenarios, it is recommended that you choose a resolution supported by the camera that is closest to your desired resolution. You can get a list of a capture device's supported resolutions by calling [VideoDeviceController.GetAvailableMediaStreamProperties](../windows.media.devices/videodevicecontroller_getavailablemediastreamproperties.md). For more information, see [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) and the [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252). + +To rotate the record or preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](XREF:TODO:mf.mf_mt_video_rotation) to add metadata to the stream. Note that this rotation is performed by the consumer of the stream, such as the **CaptureElement** or a video player app, while the actual pixels in the stream still retain their original orientation. For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). + +To modify the properties of the capture device, use [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). + +## -examples + +## -see-also +[GetAvailableMediaStreamProperties](../windows.media.devices/videodevicecontroller_getavailablemediastreamproperties.md), [SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md), [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties), [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture), [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md b/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md index 00d8aad214..ddf4ed547d 100644 --- a/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md +++ b/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md @@ -1,3 +1,35 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.SetPreviewMirroring(System.Boolean) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.SetPreviewMirroring ## -description Enables or disables horizontal mirroring of the video preview stream. This is not the preferred method for mirroring. See the Remarks section below for details. ## -parameters ### -param value True to enable mirroring; false to disable mirroring. ## -remarks Horizontal mirroring is useful for video conferencing or video chat applications, because the users typically want to see a reflected image of themselves. The non-mirrored view can look strange, because we are used to seeing ourselves in a mirror. To mirror the preview video, apps should instead use the following method. Windows app using JavaScript should use the [msHorizontalMirror](XREF:TODO:ie.HTMLVideoElement_msHorizontalMirror) property of the [video](XREF:TODO:wwa.HTMLVideoObject) object. Windows Store app using C++, C#, or Visual Basic should use the [FlowDirection](../windows.ui.xaml/flowdirection.md) property on the [CaptureElement](../windows.ui.xaml.controls/captureelement.md). [SetPreviewMirroring](mediacapture_setpreviewmirroring.md) can potentially be used as a performance optimization on some devices For how-to guidance on handling orientation and mirroring when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.SetPreviewMirroring(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.SetPreviewMirroring + +## -description +Enables or disables horizontal mirroring of the video preview stream. This is not the preferred method for mirroring. See the Remarks section below for details. + +## -parameters +### -param value +True to enable mirroring; false to disable mirroring. + + +## -remarks +Horizontal mirroring is useful for video conferencing or video chat applications, because the users typically want to see a reflected image of themselves. The non-mirrored view can look strange, because we are used to seeing ourselves in a mirror. + +To mirror the preview video, apps should instead use the following method. Windows app using JavaScript should use the [msHorizontalMirror](XREF:TODO:ie.HTMLVideoElement_msHorizontalMirror) property of the [video](XREF:TODO:wwa.HTMLVideoObject) object. Windows Store app using C++, C#, or Visual Basic should use the [FlowDirection](../windows.ui.xaml/flowdirection.md) property on the [CaptureElement](../windows.ui.xaml.controls/captureelement.md). + +[SetPreviewMirroring](mediacapture_setpreviewmirroring.md) can potentially be used as a performance optimization on some devices + +For how-to guidance on handling orientation and mirroring when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_setpreviewrotation_1883663361.md b/windows.media.capture/mediacapture_setpreviewrotation_1883663361.md index 2da9fd643c..4db619d7be 100644 --- a/windows.media.capture/mediacapture_setpreviewrotation_1883663361.md +++ b/windows.media.capture/mediacapture_setpreviewrotation_1883663361.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.SetPreviewRotation(Windows.Media.Capture.VideoRotation) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.SetPreviewRotation ## -description Rotates the video preview stream. ## -parameters ### -param value The amount by which to rotate the video. ## -remarks For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.SetPreviewRotation(Windows.Media.Capture.VideoRotation) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.SetPreviewRotation + +## -description +Rotates the video preview stream. + +## -parameters +### -param value +The amount by which to rotate the video. + +## -remarks +For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_setrecordrotation_1333498107.md b/windows.media.capture/mediacapture_setrecordrotation_1333498107.md index 6b52f8ec53..089139de92 100644 --- a/windows.media.capture/mediacapture_setrecordrotation_1333498107.md +++ b/windows.media.capture/mediacapture_setrecordrotation_1333498107.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.SetRecordRotation(Windows.Media.Capture.VideoRotation) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.SetRecordRotation ## -description Rotates the recorded video. ## -parameters ### -param value The amount by which to rotate the video. ## -remarks For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.SetRecordRotation(Windows.Media.Capture.VideoRotation) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.SetRecordRotation + +## -description +Rotates the recorded video. + +## -parameters +### -param value +The amount by which to rotate the video. + +## -remarks +For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startpreviewasync_2139900609.md b/windows.media.capture/mediacapture_startpreviewasync_2139900609.md index 863a852954..fc231ad426 100644 --- a/windows.media.capture/mediacapture_startpreviewasync_2139900609.md +++ b/windows.media.capture/mediacapture_startpreviewasync_2139900609.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartPreviewAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartPreviewAsync ## -description Starts preview. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartPreviewAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartPreviewAsync + +## -description +Starts preview. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md b/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md index 25c830b0e3..d4c4bbd8fe 100644 --- a/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md +++ b/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Media.IMediaExtension) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync ## -description Starts sending a preview stream to a custom media sink using the specified encoding profile. ## -parameters ### -param encodingProfile The encoding profile to use for the recording. ### -param customMediaSink The media extension for the custom media sink. ## -returns An object that is used to control the asynchronous operation. ## -remarks When you call **StartPreviewToCustomSinkAsync**, the system will call the custom sink’s [IMFMediaTypeHandler::IsMediaTypeSupported](XREF:TODO:mf.imfmediatypehandler_ismediatypesupported) method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from **IsMediaTypeSupported** when this check is made, then the preview stream will use the native media type instead of the type specified by the *encodingProfile* parameter. ## -examples ## -see-also [StartPreviewToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)](mediacapture_startpreviewtocustomsinkasync_319661254.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Media.IMediaExtension) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync + +## -description +Starts sending a preview stream to a custom media sink using the specified encoding profile. + +## -parameters +### -param encodingProfile +The encoding profile to use for the recording. + +### -param customMediaSink +The media extension for the custom media sink. + +## -returns +An object that is used to control the asynchronous operation. + +## -remarks +When you call **StartPreviewToCustomSinkAsync**, the system will call the custom sink’s [IMFMediaTypeHandler::IsMediaTypeSupported](XREF:TODO:mf.imfmediatypehandler_ismediatypesupported) method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from **IsMediaTypeSupported** when this check is made, then the preview stream will use the native media type instead of the type specified by the *encodingProfile* parameter. + +## -examples + +## -see-also +[StartPreviewToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)](mediacapture_startpreviewtocustomsinkasync_319661254.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_319661254.md b/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_319661254.md index 3d2d878662..42a19dcc58 100644 --- a/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_319661254.md +++ b/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_319661254.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync ## -description Starts sending a preview stream to a custom media sink using the specified encoding profile and sink settings. ## -parameters ### -param encodingProfile The encoding profile to use for the recording. ### -param customSinkActivationId The activatable class ID of the media extension for the custom media sink. ### -param customSinkSettings Contains properties of the media extension. ## -returns An object that is used to control the asynchronous operation. ## -remarks When you call **StartPreviewToCustomSinkAsync**, the system will call the custom sink’s [IMFMediaTypeHandler::IsMediaTypeSupported](XREF:TODO:mf.imfmediatypehandler_ismediatypesupported) method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from **IsMediaTypeSupported** when this check is made, then the preview stream will use the native media type instead of the type specified by the *encodingProfile* parameter. ## -examples ## -see-also [StartPreviewToCustomSinkAsync(MediaEncodingProfile, IMediaExtension)](mediacapture_startpreviewtocustomsinkasync_1216748550.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartPreviewToCustomSinkAsync + +## -description +Starts sending a preview stream to a custom media sink using the specified encoding profile and sink settings. + +## -parameters +### -param encodingProfile +The encoding profile to use for the recording. + +### -param customSinkActivationId +The activatable class ID of the media extension for the custom media sink. + +### -param customSinkSettings +Contains properties of the media extension. + +## -returns +An object that is used to control the asynchronous operation. + +## -remarks +When you call **StartPreviewToCustomSinkAsync**, the system will call the custom sink’s [IMFMediaTypeHandler::IsMediaTypeSupported](XREF:TODO:mf.imfmediatypehandler_ismediatypesupported) method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from **IsMediaTypeSupported** when this check is made, then the preview stream will use the native media type instead of the type specified by the *encodingProfile* parameter. + +## -examples + +## -see-also +[StartPreviewToCustomSinkAsync(MediaEncodingProfile, IMediaExtension)](mediacapture_startpreviewtocustomsinkasync_1216748550.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startrecordtocustomsinkasync_1216713323.md b/windows.media.capture/mediacapture_startrecordtocustomsinkasync_1216713323.md index 370f278feb..01d8cf2bee 100644 --- a/windows.media.capture/mediacapture_startrecordtocustomsinkasync_1216713323.md +++ b/windows.media.capture/mediacapture_startrecordtocustomsinkasync_1216713323.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Media.IMediaExtension) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync ## -description Start recording to a custom media sink using the specified encoding profile. ## -parameters ### -param encodingProfile The encoding profile to use for the recording. ### -param customMediaSink The media extension for the custom media sink. ## -returns An object that is used to control the asynchronous operation. ## -remarks A [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) event is raised if the record limit is exceeded. In the current release, record limit is three hours. ## -examples ## -see-also [StartRecordToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)](mediacapture_startrecordtocustomsinkasync_319695531.md), [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Media.IMediaExtension) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync + +## -description +Start recording to a custom media sink using the specified encoding profile. + +## -parameters +### -param encodingProfile +The encoding profile to use for the recording. + +### -param customMediaSink +The media extension for the custom media sink. + +## -returns +An object that is used to control the asynchronous operation. + +## -remarks +A [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) event is raised if the record limit is exceeded. In the current release, record limit is three hours. + +## -examples + +## -see-also +[StartRecordToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)](mediacapture_startrecordtocustomsinkasync_319695531.md), [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startrecordtocustomsinkasync_319695531.md b/windows.media.capture/mediacapture_startrecordtocustomsinkasync_319695531.md index 0f86ba49e6..bb87ddde51 100644 --- a/windows.media.capture/mediacapture_startrecordtocustomsinkasync_319695531.md +++ b/windows.media.capture/mediacapture_startrecordtocustomsinkasync_319695531.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync ## -description Start recording to a custom media sink using the specified encoding profile and sink settings. ## -parameters ### -param encodingProfile The encoding profile to use for the recording. ### -param customSinkActivationId The activatable class ID of the media extension for the custom media sink. ### -param customSinkSettings Contains properties of the media extension. ## -returns An object that is used to control the asynchronous operation. ## -remarks A [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) event is raised if the record limit is exceeded. In the current release, the record limit is three hours. ## -examples ## -see-also [StartRecordToCustomSinkAsync(MediaEncodingProfile, IMediaExtension)](mediacapture_startrecordtocustomsinkasync_1216713323.md), [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync(Windows.Media.MediaProperties.MediaEncodingProfile,System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartRecordToCustomSinkAsync + +## -description +Start recording to a custom media sink using the specified encoding profile and sink settings. + +## -parameters +### -param encodingProfile +The encoding profile to use for the recording. + +### -param customSinkActivationId +The activatable class ID of the media extension for the custom media sink. + +### -param customSinkSettings +Contains properties of the media extension. + +## -returns +An object that is used to control the asynchronous operation. + +## -remarks +A [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) event is raised if the record limit is exceeded. In the current release, the record limit is three hours. + +## -examples + +## -see-also +[StartRecordToCustomSinkAsync(MediaEncodingProfile, IMediaExtension)](mediacapture_startrecordtocustomsinkasync_1216713323.md), [RecordLimitationExceeded](mediacapture_recordlimitationexceeded.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startrecordtostoragefileasync_1923577468.md b/windows.media.capture/mediacapture_startrecordtostoragefileasync_1923577468.md index 0f0d075344..00bde45ea5 100644 --- a/windows.media.capture/mediacapture_startrecordtostoragefileasync_1923577468.md +++ b/windows.media.capture/mediacapture_startrecordtostoragefileasync_1923577468.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToStorageFileAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartRecordToStorageFileAsync ## -description Starts recording asynchronously to a storage file. ## -parameters ### -param encodingProfile The encoding profile for the recording. ### -param file The storage file where the image is saved. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks For how-to guidance on recording to a file, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToStorageFileAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartRecordToStorageFileAsync + +## -description +Starts recording asynchronously to a storage file. + +## -parameters +### -param encodingProfile +The encoding profile for the recording. + +### -param file +The storage file where the image is saved. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +For how-to guidance on recording to a file, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_startrecordtostreamasync_1774985461.md b/windows.media.capture/mediacapture_startrecordtostreamasync_1774985461.md index 4d4b5beeec..29f0cd753d 100644 --- a/windows.media.capture/mediacapture_startrecordtostreamasync_1774985461.md +++ b/windows.media.capture/mediacapture_startrecordtostreamasync_1774985461.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToStreamAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StartRecordToStreamAsync ## -description Starts recording to a random-access stream. ## -parameters ### -param encodingProfile The encoding profile for the recording. ### -param stream The stream where the image data is written. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks For how-to guidance on recording to a file, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StartRecordToStreamAsync(Windows.Media.MediaProperties.MediaEncodingProfile,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StartRecordToStreamAsync + +## -description +Starts recording to a random-access stream. + +## -parameters +### -param encodingProfile +The encoding profile for the recording. + +### -param stream +The stream where the image data is written. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +For how-to guidance on recording to a file, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_stoppreviewasync_543989764.md b/windows.media.capture/mediacapture_stoppreviewasync_543989764.md index 2ceec555ff..bae469f68d 100644 --- a/windows.media.capture/mediacapture_stoppreviewasync_543989764.md +++ b/windows.media.capture/mediacapture_stoppreviewasync_543989764.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StopPreviewAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StopPreviewAsync ## -description Stops preview. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StopPreviewAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StopPreviewAsync + +## -description +Stops preview. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_stoprecordasync_247267352.md b/windows.media.capture/mediacapture_stoprecordasync_247267352.md index ff9e4cc533..000975d1ed 100644 --- a/windows.media.capture/mediacapture_stoprecordasync_247267352.md +++ b/windows.media.capture/mediacapture_stoprecordasync_247267352.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StopRecordAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StopRecordAsync ## -description Stops recording. ## -returns Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks Before playing back a video, the [RandomAccessStream](../windows.storage.streams/randomaccessstream.md) should be closed when [StopRecordAsync](mediacapture_stoprecordasync.md) completes. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StopRecordAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StopRecordAsync + +## -description +Stops recording. + +## -returns +Returns a [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +Before playing back a video, the [RandomAccessStream](../windows.storage.streams/randomaccessstream.md) should be closed when [StopRecordAsync](mediacapture_stoprecordasync.md) completes. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapture_stoprecordwithresultasync_871240631.md b/windows.media.capture/mediacapture_stoprecordwithresultasync_871240631.md index 100d298bb9..3b1de73b3e 100644 --- a/windows.media.capture/mediacapture_stoprecordwithresultasync_871240631.md +++ b/windows.media.capture/mediacapture_stoprecordwithresultasync_871240631.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapture.StopRecordWithResultAsync --api-type: winrt method ---- # Windows.Media.Capture.MediaCapture.StopRecordWithResultAsync ## -description Asynchronously stops the media recording and provides a [MediaCaptureStopResult](mediacapturestopresult.md) that can be used to help the user align the camera with the last captured frame when restarting recording. ## -returns An asynchronous action that returns a [MediaCaptureStopResult](mediacapturestopresult.md) upon completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapture.StopRecordWithResultAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.StopRecordWithResultAsync + +## -description +Asynchronously stops the media recording and provides a [MediaCaptureStopResult](mediacapturestopresult.md) that can be used to help the user align the camera with the last captured frame when restarting recording. + +## -returns +An asynchronous action that returns a [MediaCaptureStopResult](mediacapturestopresult.md) upon completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_thermalstatus.md b/windows.media.capture/mediacapture_thermalstatus.md index 666fd43584..d162838529 100644 --- a/windows.media.capture/mediacapture_thermalstatus.md +++ b/windows.media.capture/mediacapture_thermalstatus.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapture.ThermalStatus --api-type: winrt property ---- # Windows.Media.Capture.MediaCapture.ThermalStatus ## -description Gets a value that indicates the current thermal status of the capture device. ## -property-value A value that indicates the current thermal status of the capture device. ## -remarks Media capture scenarios that are extremely processor-intensive, such as high-resolution, high-frame rate, and real-time image processing can cause the capture hardware to overheat. On devices where the camera driver supports reporting of thermal status, you can check the **ThermalStatus** property to get the current thermal status of the capture device. You can also subscribe to the [ThermalStatusChanged](mediacapture_thermalstatuschanged.md) event to receive a notification when the thermal status changes. If the thermal status is [Overheated](mediacapturethermalstatus.md) , you should stop the current capture session and save any captured media. Once the thermal status has returned to normal, you can begin capturing again. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapture.ThermalStatus +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapture.ThermalStatus + +## -description +Gets a value that indicates the current thermal status of the capture device. + +## -property-value +A value that indicates the current thermal status of the capture device. + +## -remarks +Media capture scenarios that are extremely processor-intensive, such as high-resolution, high-frame rate, and real-time image processing can cause the capture hardware to overheat. On devices where the camera driver supports reporting of thermal status, you can check the **ThermalStatus** property to get the current thermal status of the capture device. You can also subscribe to the [ThermalStatusChanged](mediacapture_thermalstatuschanged.md) event to receive a notification when the thermal status changes. If the thermal status is [Overheated](mediacapturethermalstatus.md) , you should stop the current capture session and save any captured media. Once the thermal status has returned to normal, you can begin capturing again. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_thermalstatuschanged.md b/windows.media.capture/mediacapture_thermalstatuschanged.md index 82eddcb261..480a167daf 100644 --- a/windows.media.capture/mediacapture_thermalstatuschanged.md +++ b/windows.media.capture/mediacapture_thermalstatuschanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Capture.MediaCapture.ThermalStatusChanged --api-type: winrt event ---- # Windows.Media.Capture.MediaCapture.ThermalStatusChanged ## -description Occurs when the thermal status of the capture device changes. ## -remarks Media capture scenarios that are extremely processor-intensive, such as high-resolution, high-frame rate, and real-time image processing can cause the capture hardware to overheat. On devices where the camera driver supports reporting of thermal status, you can check the [MediaCaptureThermalStatus](mediacapture_mediacapturethermalstatus.md) property to get the current thermal status of the capture device. You can also subscribe to the [ThermalStatusChanged](mediacapture_thermalstatuschanged.md) event to receive a notification when the thermal status changes. If the thermal status is [Overheated](mediacapturethermalstatus.md) , you should stop the current capture session and save any captured media. Once the thermal status has returned to normal, you can begin capturing again. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.MediaCapture.ThermalStatusChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.ThermalStatusChanged + +## -description +Occurs when the thermal status of the capture device changes. + +## -remarks +Media capture scenarios that are extremely processor-intensive, such as high-resolution, high-frame rate, and real-time image processing can cause the capture hardware to overheat. On devices where the camera driver supports reporting of thermal status, you can check the [MediaCaptureThermalStatus](mediacapture_mediacapturethermalstatus.md) property to get the current thermal status of the capture device. You can also subscribe to the [ThermalStatusChanged](mediacapture_thermalstatuschanged.md) event to receive a notification when the thermal status changes. If the thermal status is [Overheated](mediacapturethermalstatus.md) , you should stop the current capture session and save any captured media. Once the thermal status has returned to normal, you can begin capturing again. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapture_videodevicecontroller.md b/windows.media.capture/mediacapture_videodevicecontroller.md index 7a23cb9ffd..1c0b482bbf 100644 --- a/windows.media.capture/mediacapture_videodevicecontroller.md +++ b/windows.media.capture/mediacapture_videodevicecontroller.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapture.VideoDeviceController --api-type: winrt property ---- # Windows.Media.Capture.MediaCapture.VideoDeviceController ## -description Gets an object that controls settings for the video camera. ## -property-value A [VideoDeviceController](../windows.media.devices/videodevicecontroller.md) object. ## -remarks Some drivers may require that the camera device preview to be in a running state before it can determine which controls are supported by the [VideoDeviceController](mediacapture_videodevicecontroller.md). If you check whether a certain control is supported by the [VideoDeviceController](mediacapture_videodevicecontroller.md) before the preview stream is running, the control may be described as unsupported even though it is supported by the video device. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapture.VideoDeviceController +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapture.VideoDeviceController + +## -description +Gets an object that controls settings for the video camera. + +## -property-value +A [VideoDeviceController](../windows.media.devices/videodevicecontroller.md) object. + +## -remarks +Some drivers may require that the camera device preview to be in a running state before it can determine which controls are supported by the [VideoDeviceController](mediacapture_videodevicecontroller.md). If you check whether a certain control is supported by the [VideoDeviceController](mediacapture_videodevicecontroller.md) before the preview stream is running, the control may be described as unsupported even though it is supported by the video device. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturefailedeventargs_code.md b/windows.media.capture/mediacapturefailedeventargs_code.md index 9504f7a3c4..c98e672933 100644 --- a/windows.media.capture/mediacapturefailedeventargs_code.md +++ b/windows.media.capture/mediacapturefailedeventargs_code.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureFailedEventArgs.Code --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureFailedEventArgs.Code ## -description The error code of the error that caused the event. ## -property-value The error code. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureFailedEventArgs.Code +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureFailedEventArgs.Code + +## -description +The error code of the error that caused the event. + +## -property-value +The error code. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturefailedeventargs_message.md b/windows.media.capture/mediacapturefailedeventargs_message.md index a3384b6468..d9af05d681 100644 --- a/windows.media.capture/mediacapturefailedeventargs_message.md +++ b/windows.media.capture/mediacapturefailedeventargs_message.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureFailedEventArgs.Message --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureFailedEventArgs.Message ## -description A message string for the error. ## -property-value The message string. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureFailedEventArgs.Message +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureFailedEventArgs.Message + +## -description +A message string for the error. + +## -property-value +The message string. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturefocuschangedeventargs.md b/windows.media.capture/mediacapturefocuschangedeventargs.md index 245cadfdd8..4d338b253c 100644 --- a/windows.media.capture/mediacapturefocuschangedeventargs.md +++ b/windows.media.capture/mediacapturefocuschangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.MediaCaptureFocusChangedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.MediaCaptureFocusChangedEventArgs ## -description Provides data for the [FocusChanged](mediacapture_focuschanged.md) event. ## -remarks Handle the [MediaCapture.FocusChanged](mediacapture_focuschanged.md) event to obtain an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.MediaCaptureFocusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.MediaCaptureFocusChangedEventArgs + +## -description +Provides data for the [FocusChanged](mediacapture_focuschanged.md) event. + +## -remarks +Handle the [MediaCapture.FocusChanged](mediacapture_focuschanged.md) event to obtain an instance of this class. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturefocuschangedeventargs_focusstate.md b/windows.media.capture/mediacapturefocuschangedeventargs_focusstate.md index 4b8e83d1d4..357316b3e8 100644 --- a/windows.media.capture/mediacapturefocuschangedeventargs_focusstate.md +++ b/windows.media.capture/mediacapturefocuschangedeventargs_focusstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureFocusChangedEventArgs.FocusState --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureFocusChangedEventArgs.FocusState ## -description Gets the current focus state of the capture device. ## -property-value The current focus state of the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureFocusChangedEventArgs.FocusState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureFocusChangedEventArgs.FocusState + +## -description +Gets the current focus state of the capture device. + +## -property-value +The current focus state of the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_audiodeviceid.md b/windows.media.capture/mediacaptureinitializationsettings_audiodeviceid.md index c907b09ed9..c988762c7c 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_audiodeviceid.md +++ b/windows.media.capture/mediacaptureinitializationsettings_audiodeviceid.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AudioDeviceId --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.AudioDeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. ## -remarks This method may return a NULL pointer if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AudioDeviceId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.AudioDeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. + +## -remarks +This method may return a NULL pointer if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_audioprocessing.md b/windows.media.capture/mediacaptureinitializationsettings_audioprocessing.md index 068b6fa05f..96e7079ac8 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_audioprocessing.md +++ b/windows.media.capture/mediacaptureinitializationsettings_audioprocessing.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AudioProcessing --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.AudioProcessing ## -description Gets or sets a value that specifies the audio processing mode. ## -property-value The audio processing mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AudioProcessing +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.AudioProcessing + +## -description +Gets or sets a value that specifies the audio processing mode. + +## -property-value +The audio processing mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_audiosource.md b/windows.media.capture/mediacaptureinitializationsettings_audiosource.md index 2f965a75b4..9d5b9adbe6 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_audiosource.md +++ b/windows.media.capture/mediacaptureinitializationsettings_audiosource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AudioSource --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.AudioSource ## -description Gets or sets the audio source for the capture operation. ## -property-value The audio source for the capture operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AudioSource +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.AudioSource + +## -description +Gets or sets the audio source for the capture operation. + +## -property-value +The audio source for the capture operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_mediacaptureinitializationsettings_1221375020.md b/windows.media.capture/mediacaptureinitializationsettings_mediacaptureinitializationsettings_1221375020.md index f9718310e5..78fc7afeae 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_mediacaptureinitializationsettings_1221375020.md +++ b/windows.media.capture/mediacaptureinitializationsettings_mediacaptureinitializationsettings_1221375020.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Capture.MediaCaptureInitializationSettings.#ctor --api-type: winrt method ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.MediaCaptureInitializationSettings ## -description Creates a new instance of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings_mediacaptureinitializationsettings.md) object. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCaptureInitializationSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.MediaCaptureInitializationSettings + +## -description +Creates a new instance of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings_mediacaptureinitializationsettings.md) object. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_mediacategory.md b/windows.media.capture/mediacaptureinitializationsettings_mediacategory.md index be6ba13add..07de2df3cb 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_mediacategory.md +++ b/windows.media.capture/mediacaptureinitializationsettings_mediacategory.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.MediaCategory --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.MediaCategory ## -description Gets or set the media category. ## -property-value The media category. ## -remarks If you set the **MediaCategory** property, the media capture pipeline will attempt to optimize for the specified scenario. For example, if you set the value to [Speech](mediacategory.md), audio processing such as echo cancellation and noise suppression may be enabled. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.MediaCategory +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.MediaCategory + +## -description +Gets or set the media category. + +## -property-value +The media category. + +## -remarks +If you set the **MediaCategory** property, the media capture pipeline will attempt to optimize for the specified scenario. For example, if you set the value to [Speech](mediacategory.md), audio processing such as echo cancellation and noise suppression may be enabled. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_memorypreference.md b/windows.media.capture/mediacaptureinitializationsettings_memorypreference.md index a26bb5fde9..70c26caecc 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_memorypreference.md +++ b/windows.media.capture/mediacaptureinitializationsettings_memorypreference.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.MemoryPreference --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.MemoryPreference ## -description Gets or sets an object specifying the preferred memory location for storing frames acquired from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) used by the [MediaCapture](mediacapture.md). ## -property-value An object specifying preferred the memory location for storing frames acquired from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). ## -remarks The [MediaCapture](mediacapture.md) object may store the image data of a [VideoMediaFrame](../windows.media.capture.frames/videomediaframe.md) acquired from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) in either CPU or GPU memory. When **MemoryPreference** is set to [Cpu](mediacapturememorypreference.md), CPU memory is used and therefore the [SoftwareBitmap](../windows.media.capture.frames/videomediaframe_softwarebitmap.md) property of acquired [VideoMediaFrame](../windows.media.capture.frames/videomediaframe.md) objects will be non-null and contain the image data for the frame. When [Auto](mediacapturememorypreference.md) is specified, the system will dynamically choose the optimal memory location for the current device. If the system chooses to use GPU memory, the [Direct3DSurface](../windows.media.capture.frames/videomediaframe_direct3dsurface.md) property of acquired [VideoMediaFrame](../windows.media.capture.frames/videomediaframe.md) objects will be non-null and contain the image data for the frame. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.MemoryPreference +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.MemoryPreference + +## -description +Gets or sets an object specifying the preferred memory location for storing frames acquired from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) used by the [MediaCapture](mediacapture.md). + +## -property-value +An object specifying preferred the memory location for storing frames acquired from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md). + +## -remarks +The [MediaCapture](mediacapture.md) object may store the image data of a [VideoMediaFrame](../windows.media.capture.frames/videomediaframe.md) acquired from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) in either CPU or GPU memory. When **MemoryPreference** is set to [Cpu](mediacapturememorypreference.md), CPU memory is used and therefore the [SoftwareBitmap](../windows.media.capture.frames/videomediaframe_softwarebitmap.md) property of acquired [VideoMediaFrame](../windows.media.capture.frames/videomediaframe.md) objects will be non-null and contain the image data for the frame. When [Auto](mediacapturememorypreference.md) is specified, the system will dynamically choose the optimal memory location for the current device. If the system chooses to use GPU memory, the [Direct3DSurface](../windows.media.capture.frames/videomediaframe_direct3dsurface.md) property of acquired [VideoMediaFrame](../windows.media.capture.frames/videomediaframe.md) objects will be non-null and contain the image data for the frame. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_photocapturesource.md b/windows.media.capture/mediacaptureinitializationsettings_photocapturesource.md index aff618757d..c5535ee7cc 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_photocapturesource.md +++ b/windows.media.capture/mediacaptureinitializationsettings_photocapturesource.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoCaptureSource --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoCaptureSource ## -description Gets or sets the stream that is used for photo capture. ## -property-value The stream that is used for photo capture. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoCaptureSource +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoCaptureSource + +## -description +Gets or sets the stream that is used for photo capture. + +## -property-value +The stream that is used for photo capture. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_photomediadescription.md b/windows.media.capture/mediacaptureinitializationsettings_photomediadescription.md index cc726980b1..fed1eef47f 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_photomediadescription.md +++ b/windows.media.capture/mediacaptureinitializationsettings_photomediadescription.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoMediaDescription --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoMediaDescription ## -description Gets or sets the media description for photo capture. ## -property-value The media description for photo capture. ## -remarks An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, one [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). The way the system uses the **PhotoMediaDescription** property depends on the value of the [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) property. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and you set [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) to a value in the video profile's [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md) list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and the value of [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) is not set, then the system will use the first entry in the video profile's [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md) list as the media description. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the value you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) is used, but no optimization hints are sent to the capture device. Also, if the value you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. + If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) and reverts to the legacy behavior before the video profile APIs were introduced. ## -examples ## -see-also [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoMediaDescription +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.PhotoMediaDescription + +## -description +Gets or sets the media description for photo capture. + +## -property-value +The media description for photo capture. + +## -remarks +An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, one [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). + +The way the system uses the **PhotoMediaDescription** property depends on the value of the [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) property. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and you set [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) to a value in the video profile's [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md) list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and the value of [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) is not set, then the system will use the first entry in the video profile's [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md) list as the media description. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the value you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) is used, but no optimization hints are sent to the capture device. Also, if the value you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. ++ If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) and reverts to the legacy behavior before the video profile APIs were introduced. + + +## -examples + +## -see-also +[PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_previewmediadescription.md b/windows.media.capture/mediacaptureinitializationsettings_previewmediadescription.md index e258c5bca9..5ece03295e 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_previewmediadescription.md +++ b/windows.media.capture/mediacaptureinitializationsettings_previewmediadescription.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.PreviewMediaDescription --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.PreviewMediaDescription ## -description Gets or sets the media description for preview video. ## -property-value The media description for preview video. ## -remarks An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, one [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). The way the system uses the **PreviewMediaDescription** property depends on the value of the [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) property. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and you set [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) to a value in the video profile's [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md) list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and the value of [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) is not set, then the system will use the first entry in the video profile's [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md) list as the media description. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the value you provide for [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) is used, but no optimization hints are sent to the capture device. Also, if the value you provide for [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. + If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) and reverts to the legacy behavior before these APIs were introduced. ## -examples ## -see-also [PhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.PreviewMediaDescription +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.PreviewMediaDescription + +## -description +Gets or sets the media description for preview video. + +## -property-value +The media description for preview video. + +## -remarks +An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, one [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). + +The way the system uses the **PreviewMediaDescription** property depends on the value of the [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) property. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and you set [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) to a value in the video profile's [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md) list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and the value of [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) is not set, then the system will use the first entry in the video profile's [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md) list as the media description. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the value you provide for [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) is used, but no optimization hints are sent to the capture device. Also, if the value you provide for [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. ++ If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) and reverts to the legacy behavior before these APIs were introduced. + + +## -examples + +## -see-also +[PhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_recordmediadescription.md b/windows.media.capture/mediacaptureinitializationsettings_recordmediadescription.md index fe65d9e641..f24101d2a0 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_recordmediadescription.md +++ b/windows.media.capture/mediacaptureinitializationsettings_recordmediadescription.md @@ -1,3 +1,31 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.RecordMediaDescription --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.RecordMediaDescription ## -description Gets or sets the media description for video recording. ## -property-value The media description for video capture. ## -remarks An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, one [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). The way the system uses the **RecordMediaDescription** property depends on the value of the [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) property. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and you set [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) to a value in the video profile's [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and the value of [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) is not set, then the system will use the first entry in the video profile's [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list as the media description. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the value you provide for [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) is used, but no optimization hints are sent to the capture device. Also, if the value you provide for [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. + If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) and reverts to the legacy behavior before these APIs were introduced. ## -examples ## -see-also [PhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.RecordMediaDescription +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.RecordMediaDescription + +## -description +Gets or sets the media description for video recording. + +## -property-value +The media description for video capture. + +## -remarks +An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, one [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). + +The way the system uses the **RecordMediaDescription** property depends on the value of the [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) property. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and you set [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) to a value in the video profile's [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a non-null value and the value of [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) is not set, then the system will use the first entry in the video profile's [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list as the media description. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the value you provide for [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) is used, but no optimization hints are sent to the capture device. Also, if the value you provide for [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. ++ If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) and reverts to the legacy behavior before these APIs were introduced. + + +## -examples + +## -see-also +[PhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_sharingmode.md b/windows.media.capture/mediacaptureinitializationsettings_sharingmode.md index f80b8ed697..0a6f95172c 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_sharingmode.md +++ b/windows.media.capture/mediacaptureinitializationsettings_sharingmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.SharingMode --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.SharingMode ## -description Gets or sets an object that specifies the sharing mode for the [MediaCapture](mediacapture.md). ## -property-value An object that specifies the sharing mode for the [MediaCapture](mediacapture.md). ## -remarks Multiple apps can simultaneously acquire frames from the same [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md), but only a single app can acquire exclusive control of and modify the settings for the frame source. Set **SharingMode** to [ExclusiveControl](mediacapturesharingmode.md) if you need to adjust the configuration of any of the frame sources included the requested [SourceGroup](mediacaptureinitializationsettings_sourcegroup.md). However, this means that the call to [InitializeAsync](mediacapture_initializeasync.md) will fail if another app already has exclusive control of one of the frame sources in the group. If you only need to acquire frames without modifying the configuration, set **SharingMode** to [SharedReadOnly](mediacapturesharingmode.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.SharingMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.SharingMode + +## -description +Gets or sets an object that specifies the sharing mode for the [MediaCapture](mediacapture.md). + +## -property-value +An object that specifies the sharing mode for the [MediaCapture](mediacapture.md). + +## -remarks +Multiple apps can simultaneously acquire frames from the same [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md), but only a single app can acquire exclusive control of and modify the settings for the frame source. Set **SharingMode** to [ExclusiveControl](mediacapturesharingmode.md) if you need to adjust the configuration of any of the frame sources included the requested [SourceGroup](mediacaptureinitializationsettings_sourcegroup.md). However, this means that the call to [InitializeAsync](mediacapture_initializeasync.md) will fail if another app already has exclusive control of one of the frame sources in the group. If you only need to acquire frames without modifying the configuration, set **SharingMode** to [SharedReadOnly](mediacapturesharingmode.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md b/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md index 2152f10c36..523004e3fe 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md +++ b/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.SourceGroup --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.SourceGroup ## -description Gets or sets the [MediaFrameSourceGroup](XREF:TODO:a23582f7-27c5-46bc-9767-4e2bfc57be3e.mediaframesourcegroup) with which the [MediaCapture](mediacapture.md) should be initialized. This property defines a set of media frame sources that can be used simultaneously. ## -property-value The [MediaFrameSourceGroup](../windows.media.capture.frames/mediaframesourcegroup.md) with which the [MediaCapture](mediacapture.md) should be initialized. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.SourceGroup +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.SourceGroup + +## -description +Gets or sets the [MediaFrameSourceGroup](XREF:TODO:a23582f7-27c5-46bc-9767-4e2bfc57be3e.mediaframesourcegroup) with which the [MediaCapture](mediacapture.md) should be initialized. This property defines a set of media frame sources that can be used simultaneously. + +## -property-value +The [MediaFrameSourceGroup](../windows.media.capture.frames/mediaframesourcegroup.md) with which the [MediaCapture](mediacapture.md) should be initialized. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_streamingcapturemode.md b/windows.media.capture/mediacaptureinitializationsettings_streamingcapturemode.md index 76fc41be6a..0de67c803f 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_streamingcapturemode.md +++ b/windows.media.capture/mediacaptureinitializationsettings_streamingcapturemode.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.StreamingCaptureMode --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.StreamingCaptureMode ## -description Gets or sets the streaming mode. ## -property-value The streaming mode. ## -remarks Use this property to choose between audio capture, video capture, or combined audio and video capture. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.StreamingCaptureMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.StreamingCaptureMode + +## -description +Gets or sets the streaming mode. + +## -property-value +The streaming mode. + +## -remarks +Use this property to choose between audio capture, video capture, or combined audio and video capture. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_videodeviceid.md b/windows.media.capture/mediacaptureinitializationsettings_videodeviceid.md index b9a958cd59..3703c3031d 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_videodeviceid.md +++ b/windows.media.capture/mediacaptureinitializationsettings_videodeviceid.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.VideoDeviceId --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.VideoDeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. ## -remarks This method may return a NULL pointer if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.VideoDeviceId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.VideoDeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. + +## -remarks +This method may return a NULL pointer if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacaptureinitializationsettings_videoprofile.md b/windows.media.capture/mediacaptureinitializationsettings_videoprofile.md index 6b668e688d..fe74c4ad8c 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_videoprofile.md +++ b/windows.media.capture/mediacaptureinitializationsettings_videoprofile.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.VideoProfile --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.VideoProfile ## -description Gets or sets the video profile which provides hints to the driver to allow it to optimize for different capture scenarios. ## -property-value The video profile. ## -remarks Video profiles provide a simple way to configure the video capture device with a group of settings that are guaranteed to work with a particular capture device and are optimized for your desired capture scenario. There is a set of known video profiles that the system provides for common scenarios, such as capturing high-quality photos during video capture or video conferencing. To get a list of the known video profiles for a given video device, use [MediaCapture::FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md). Some hardware vendors may expose other video profiles that you can get by calling [MediaCapture::FindAllVideoProfiles](mediacapture_findallvideoprofiles.md). For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). The value you use for this property determines how the system handles the values for other properties of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md). + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a valid [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object, the system will use the driver hints associated with the profile and will use the media description values you specify for the [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) properties. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a valid [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object and you don't set either the [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), or [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) properties, the system will use the driver hints associated with the profile and use the first (0 index) entry in the profile's [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md)[SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) lists as the media description for the respective properties. + If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the values you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) are used, but no optimization hints are sent to the capture device. Also, if the value you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. + If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) and reverts to the legacy behavior before the video profile APIs were introduced. Before using video profiles, you should check the value returned by [MediaCapture::IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that video profiles are supported by the capture device. For how-to guidance on using video profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.VideoProfile +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.VideoProfile + +## -description +Gets or sets the video profile which provides hints to the driver to allow it to optimize for different capture scenarios. + +## -property-value +The video profile. + +## -remarks +Video profiles provide a simple way to configure the video capture device with a group of settings that are guaranteed to work with a particular capture device and are optimized for your desired capture scenario. There is a set of known video profiles that the system provides for common scenarios, such as capturing high-quality photos during video capture or video conferencing. To get a list of the known video profiles for a given video device, use [MediaCapture::FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md). Some hardware vendors may expose other video profiles that you can get by calling [MediaCapture::FindAllVideoProfiles](mediacapture_findallvideoprofiles.md). For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). + +The value you use for this property determines how the system handles the values for other properties of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md). ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a valid [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object, the system will use the driver hints associated with the profile and will use the media description values you specify for the [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) properties. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to a valid [MediaCaptureVideoProfile](mediacapturevideoprofile.md) object and you don't set either the [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), or [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) properties, the system will use the driver hints associated with the profile and use the first (0 index) entry in the profile's [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md)[SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) lists as the media description for the respective properties. ++ If you set [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) to null, the values you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) are used, but no optimization hints are sent to the capture device. Also, if the value you provide for [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) does not match an existing video profile, errors or glitches may occur when capture is started. ++ If the value of [VideoProfile](mediacaptureinitializationsettings_videoprofile.md) is not set at all - not even to null - then the system ignores the value of [PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) and reverts to the legacy behavior before the video profile APIs were introduced. + + +Before using video profiles, you should check the value returned by [MediaCapture::IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that video profiles are supported by the capture device. + +For how-to guidance on using video profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacaptureinitializationsettings_videosource.md b/windows.media.capture/mediacaptureinitializationsettings_videosource.md index f022814fe4..b30e397db4 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_videosource.md +++ b/windows.media.capture/mediacaptureinitializationsettings_videosource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.VideoSource --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureInitializationSettings.VideoSource ## -description Gets or sets the video source for the capture operation. ## -property-value The video source for the capture operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.VideoSource +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.VideoSource + +## -description +Gets or sets the video source for the capture operation. + +## -property-value +The video source for the capture operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturepauseresult.md b/windows.media.capture/mediacapturepauseresult.md index f1c6f2a584..bc678025e1 100644 --- a/windows.media.capture/mediacapturepauseresult.md +++ b/windows.media.capture/mediacapturepauseresult.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.MediaCapturePauseResult --api-type: winrt class ---- # Windows.Media.Capture.MediaCapturePauseResult ## -description Provides the last frame captured and the recorded duration of a media capture operation that has been paused. ## -remarks Get an instance of this class by calling [PauseRecordWithResultAsync](mediacapture_pauserecordwithresultasync.md). For how-to guidance for pausing and resuming while recording video, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [PauseRecordWithResultAsync](mediacapture_pauserecordwithresultasync.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.MediaCapturePauseResult +-api-type: winrt class +--- + + + +# Windows.Media.Capture.MediaCapturePauseResult + +## -description +Provides the last frame captured and the recorded duration of a media capture operation that has been paused. + +## -remarks +Get an instance of this class by calling [PauseRecordWithResultAsync](mediacapture_pauserecordwithresultasync.md). + +For how-to guidance for pausing and resuming while recording video, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [PauseRecordWithResultAsync](mediacapture_pauserecordwithresultasync.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) \ No newline at end of file diff --git a/windows.media.capture/mediacapturepauseresult_close_811482585.md b/windows.media.capture/mediacapturepauseresult_close_811482585.md index cf02e409d5..9b8afbf9ee 100644 --- a/windows.media.capture/mediacapturepauseresult_close_811482585.md +++ b/windows.media.capture/mediacapturepauseresult_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Capture.MediaCapturePauseResult.Close --api-type: winrt method ---- # Windows.Media.Capture.MediaCapturePauseResult.Close ## -description Closes the object and disposes of associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaCapturePauseResult](mediacapturepauseresult.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCapturePauseResult.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapturePauseResult.Close + +## -description +Closes the object and disposes of associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaCapturePauseResult](mediacapturepauseresult.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturepauseresult_lastframe.md b/windows.media.capture/mediacapturepauseresult_lastframe.md index cfb0919d7f..e208ae6083 100644 --- a/windows.media.capture/mediacapturepauseresult_lastframe.md +++ b/windows.media.capture/mediacapturepauseresult_lastframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapturePauseResult.LastFrame --api-type: winrt property ---- # Windows.Media.Capture.MediaCapturePauseResult.LastFrame ## -description Gets a [VideoFrame](mediacapture_getpreviewframeasync_440877418.md) representing the last frame captured before the capture operation was paused. ## -property-value The last frame captured before the capture operation was paused. ## -remarks You can display the frame semi-transparently over the capture preview to help the user to align the camera with the last captured frame before they resume capturing. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapturePauseResult.LastFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapturePauseResult.LastFrame + +## -description +Gets a [VideoFrame](mediacapture_getpreviewframeasync_440877418.md) representing the last frame captured before the capture operation was paused. + +## -property-value +The last frame captured before the capture operation was paused. + +## -remarks +You can display the frame semi-transparently over the capture preview to help the user to align the camera with the last captured frame before they resume capturing. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturepauseresult_recordduration.md b/windows.media.capture/mediacapturepauseresult_recordduration.md index d8e54ac4f1..18bc47aa19 100644 --- a/windows.media.capture/mediacapturepauseresult_recordduration.md +++ b/windows.media.capture/mediacapturepauseresult_recordduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCapturePauseResult.RecordDuration --api-type: winrt property ---- # Windows.Media.Capture.MediaCapturePauseResult.RecordDuration ## -description Gets the duration of the media captured before the capture operation was paused. ## -property-value The duration of the media captured before the capture operation was paused. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCapturePauseResult.RecordDuration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCapturePauseResult.RecordDuration + +## -description +Gets the duration of the media captured before the capture operation was paused. + +## -property-value +The duration of the media captured before the capture operation was paused. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_audiodeviceid.md b/windows.media.capture/mediacapturesettings_audiodeviceid.md index a1f0e33af7..0f32ad4976 100644 --- a/windows.media.capture/mediacapturesettings_audiodeviceid.md +++ b/windows.media.capture/mediacapturesettings_audiodeviceid.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.AudioDeviceId --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.AudioDeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. ## -remarks This method may return null if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.AudioDeviceId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.AudioDeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the microphone. + +## -remarks +This method may return null if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturesettings_audioprocessing.md b/windows.media.capture/mediacapturesettings_audioprocessing.md index 54d57fb21f..552b9deebc 100644 --- a/windows.media.capture/mediacapturesettings_audioprocessing.md +++ b/windows.media.capture/mediacapturesettings_audioprocessing.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.AudioProcessing --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.AudioProcessing ## -description Gets the audio processing mode. ## -property-value The audio processing mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.AudioProcessing +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.AudioProcessing + +## -description +Gets the audio processing mode. + +## -property-value +The audio processing mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_camerasoundrequiredforregion.md b/windows.media.capture/mediacapturesettings_camerasoundrequiredforregion.md index 91514675c4..f6b96b081d 100644 --- a/windows.media.capture/mediacapturesettings_camerasoundrequiredforregion.md +++ b/windows.media.capture/mediacapturesettings_camerasoundrequiredforregion.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.CameraSoundRequiredForRegion --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.CameraSoundRequiredForRegion ## -description Gets a value that indicates if the device’s region requires that a sound be played when a photo or video is captured. ## -property-value **true** if the device’s region requires that a sound be played when a photo or video is captured; otherwise, **false**. An app may play a sound during photo or video capture even if it is not required by the device’s region. ## -remarks App developers can use this information to determine if they should suppress playing a sound when the device takes a picture since the operating system will play a sound if it is required by the device's region. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.CameraSoundRequiredForRegion +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.CameraSoundRequiredForRegion + +## -description +Gets a value that indicates if the device’s region requires that a sound be played when a photo or video is captured. + +## -property-value +**true** if the device’s region requires that a sound be played when a photo or video is captured; otherwise, **false**. An app may play a sound during photo or video capture even if it is not required by the device’s region. + +## -remarks +App developers can use this information to determine if they should suppress playing a sound when the device takes a picture since the operating system will play a sound if it is required by the device's region. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_concurrentrecordandphotosequencesupported.md b/windows.media.capture/mediacapturesettings_concurrentrecordandphotosequencesupported.md index ffc9a14bc1..4c3a2859f8 100644 --- a/windows.media.capture/mediacapturesettings_concurrentrecordandphotosequencesupported.md +++ b/windows.media.capture/mediacapturesettings_concurrentrecordandphotosequencesupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSequenceSupported --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSequenceSupported ## -description Gets a value that indicates if the capture device supports recording video and taking a photo sequence at the same time. ## -property-value **true** if the capture device supports concurrently recording video and capturing a photo sequence; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSequenceSupported +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSequenceSupported + +## -description +Gets a value that indicates if the capture device supports recording video and taking a photo sequence at the same time. + +## -property-value +**true** if the capture device supports concurrently recording video and capturing a photo sequence; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_concurrentrecordandphotosupported.md b/windows.media.capture/mediacapturesettings_concurrentrecordandphotosupported.md index d725a5f108..93e8018557 100644 --- a/windows.media.capture/mediacapturesettings_concurrentrecordandphotosupported.md +++ b/windows.media.capture/mediacapturesettings_concurrentrecordandphotosupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSupported --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSupported ## -description Gets a value that indicates if the capture device supports recording video and taking a photo at the same time. ## -property-value **true** if the capture device supports concurrently recording video and capturing a photo; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSupported +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.ConcurrentRecordAndPhotoSupported + +## -description +Gets a value that indicates if the capture device supports recording video and taking a photo at the same time. + +## -property-value +**true** if the capture device supports concurrently recording video and capturing a photo; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_horizontal35mmequivalentfocallength.md b/windows.media.capture/mediacapturesettings_horizontal35mmequivalentfocallength.md index 870dae4269..c8394a5f5b 100644 --- a/windows.media.capture/mediacapturesettings_horizontal35mmequivalentfocallength.md +++ b/windows.media.capture/mediacapturesettings_horizontal35mmequivalentfocallength.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.Horizontal35mmEquivalentFocalLength --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.Horizontal35mmEquivalentFocalLength ## -description Gets the horizontal 35mm equivalent focal length of the camera lens on the capture device. ## -property-value The horizontal 35mm equivalent focal length of the camera lens. ## -remarks The value of [Horizontal35mmEquivalentFocalLength](mediacapturesettings_horizontal35mmequivalentfocallength.md) is for the current preview resolution and may change each time the resolution is changed using [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.Horizontal35mmEquivalentFocalLength +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.Horizontal35mmEquivalentFocalLength + +## -description +Gets the horizontal 35mm equivalent focal length of the camera lens on the capture device. + +## -property-value +The horizontal 35mm equivalent focal length of the camera lens. + +## -remarks +The value of [Horizontal35mmEquivalentFocalLength](mediacapturesettings_horizontal35mmequivalentfocallength.md) is for the current preview resolution and may change each time the resolution is changed using [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_mediacategory.md b/windows.media.capture/mediacapturesettings_mediacategory.md index 6dfb45fe8c..a42712f473 100644 --- a/windows.media.capture/mediacapturesettings_mediacategory.md +++ b/windows.media.capture/mediacapturesettings_mediacategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.MediaCategory --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.MediaCategory ## -description Gets the media category of the media. ## -property-value The media category ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.MediaCategory +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.MediaCategory + +## -description +Gets the media category of the media. + +## -property-value +The media category + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_photocapturesource.md b/windows.media.capture/mediacapturesettings_photocapturesource.md index 9fbde4b8a1..52f5f3a2c1 100644 --- a/windows.media.capture/mediacapturesettings_photocapturesource.md +++ b/windows.media.capture/mediacapturesettings_photocapturesource.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.PhotoCaptureSource --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.PhotoCaptureSource ## -description Gets the stream that is used for photo capture. ## -property-value The stream that is used for photo capture. ## -remarks ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.PhotoCaptureSource +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.PhotoCaptureSource + +## -description +Gets the stream that is used for photo capture. + +## -property-value +The stream that is used for photo capture. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturesettings_pitchoffsetdegrees.md b/windows.media.capture/mediacapturesettings_pitchoffsetdegrees.md index f05bc657e0..fb611c9eaa 100644 --- a/windows.media.capture/mediacapturesettings_pitchoffsetdegrees.md +++ b/windows.media.capture/mediacapturesettings_pitchoffsetdegrees.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.PitchOffsetDegrees --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.PitchOffsetDegrees ## -description Gets the pitch offset of the camera in degrees. ## -property-value The pitch offset in degrees. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.PitchOffsetDegrees +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.PitchOffsetDegrees + +## -description +Gets the pitch offset of the camera in degrees. + +## -property-value +The pitch offset in degrees. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_streamingcapturemode.md b/windows.media.capture/mediacapturesettings_streamingcapturemode.md index e7b85b09ee..d43555066c 100644 --- a/windows.media.capture/mediacapturesettings_streamingcapturemode.md +++ b/windows.media.capture/mediacapturesettings_streamingcapturemode.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.StreamingCaptureMode --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.StreamingCaptureMode ## -description Gets the streaming mode. ## -property-value The streaming mode. ## -remarks This property indicates whether audio capture, video capture, or both are enabled. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.StreamingCaptureMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.StreamingCaptureMode + +## -description +Gets the streaming mode. + +## -property-value +The streaming mode. + +## -remarks +This property indicates whether audio capture, video capture, or both are enabled. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturesettings_vertical35mmequivalentfocallength.md b/windows.media.capture/mediacapturesettings_vertical35mmequivalentfocallength.md index da2a404253..d79f124de1 100644 --- a/windows.media.capture/mediacapturesettings_vertical35mmequivalentfocallength.md +++ b/windows.media.capture/mediacapturesettings_vertical35mmequivalentfocallength.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.Vertical35mmEquivalentFocalLength --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.Vertical35mmEquivalentFocalLength ## -description Gets the vertical 35mm equivalent focal length of the camera lens on the capture device. ## -property-value The vertical 35mm equivalent focal length of the camera lens. ## -remarks The value of [Vertical35mmEquivalentFocalLength](mediacapturesettings_vertical35mmequivalentfocallength.md) is for the current preview resolution and may change each time the resolution is changed using [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.Vertical35mmEquivalentFocalLength +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.Vertical35mmEquivalentFocalLength + +## -description +Gets the vertical 35mm equivalent focal length of the camera lens on the capture device. + +## -property-value +The vertical 35mm equivalent focal length of the camera lens. + +## -remarks +The value of [Vertical35mmEquivalentFocalLength](mediacapturesettings_vertical35mmequivalentfocallength.md) is for the current preview resolution and may change each time the resolution is changed using [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_videodevicecharacteristic.md b/windows.media.capture/mediacapturesettings_videodevicecharacteristic.md index 500aa3d736..82e9bcb31d 100644 --- a/windows.media.capture/mediacapturesettings_videodevicecharacteristic.md +++ b/windows.media.capture/mediacapturesettings_videodevicecharacteristic.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.VideoDeviceCharacteristic --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.VideoDeviceCharacteristic ## -description Gets a value that indicates which video streams are independent of each other. ## -property-value A value of [VideoDeviceCharacteristic](videodevicecharacteristic.md) that indicates which video streams are independent pf each other. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.VideoDeviceCharacteristic +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.VideoDeviceCharacteristic + +## -description +Gets a value that indicates which video streams are independent of each other. + +## -property-value +A value of [VideoDeviceCharacteristic](videodevicecharacteristic.md) that indicates which video streams are independent pf each other. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturesettings_videodeviceid.md b/windows.media.capture/mediacapturesettings_videodeviceid.md index c7172ef0e8..18053b95a7 100644 --- a/windows.media.capture/mediacapturesettings_videodeviceid.md +++ b/windows.media.capture/mediacapturesettings_videodeviceid.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureSettings.VideoDeviceId --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureSettings.VideoDeviceId ## -description Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. ## -property-value The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. ## -remarks This method may return null if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. ## -examples ## -see-also ## -capabilities webcam, microphone \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureSettings.VideoDeviceId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureSettings.VideoDeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the video camera. + +## -remarks +This method may return null if the device doesn't support this functionality. For more information, see the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) class. + +## -examples + +## -see-also + + +## -capabilities +webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/mediacapturestopresult.md b/windows.media.capture/mediacapturestopresult.md index dc85c3d470..605059fd69 100644 --- a/windows.media.capture/mediacapturestopresult.md +++ b/windows.media.capture/mediacapturestopresult.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Capture.MediaCaptureStopResult --api-type: winrt class ---- # Windows.Media.Capture.MediaCaptureStopResult ## -description Provides the last frame captured and the recorded duration of a media capture operation that has been stopped. ## -remarks Get an instance of this class by calling [StopRecordWithResultAsync](mediacapture_stoprecordwithresultasync.md). For how-to guidance for handling the result of a paused or stopped video recording, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.MediaCaptureStopResult +-api-type: winrt class +--- + + + +# Windows.Media.Capture.MediaCaptureStopResult + +## -description +Provides the last frame captured and the recorded duration of a media capture operation that has been stopped. + +## -remarks +Get an instance of this class by calling [StopRecordWithResultAsync](mediacapture_stoprecordwithresultasync.md). + +For how-to guidance for handling the result of a paused or stopped video recording, see [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture) \ No newline at end of file diff --git a/windows.media.capture/mediacapturestopresult_close_811482585.md b/windows.media.capture/mediacapturestopresult_close_811482585.md index 80767aa7f7..f5d447087e 100644 --- a/windows.media.capture/mediacapturestopresult_close_811482585.md +++ b/windows.media.capture/mediacapturestopresult_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Capture.MediaCaptureStopResult.Close --api-type: winrt method ---- # Windows.Media.Capture.MediaCaptureStopResult.Close ## -description Closes the object and disposes of associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaCaptureStopResult](mediacapturestopresult.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCaptureStopResult.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCaptureStopResult.Close + +## -description +Closes the object and disposes of associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaCaptureStopResult](mediacapturestopresult.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturestopresult_lastframe.md b/windows.media.capture/mediacapturestopresult_lastframe.md index 41e7ae35a3..3f83d636e0 100644 --- a/windows.media.capture/mediacapturestopresult_lastframe.md +++ b/windows.media.capture/mediacapturestopresult_lastframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureStopResult.LastFrame --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureStopResult.LastFrame ## -description Gets a [VideoFrame](mediacapture_getpreviewframeasync_440877418.md) representing the last frame captured before the capture operation was stopped. ## -property-value The last frame captured before the capture operation was stopped. ## -remarks You can display the frame semi-transparently over the capture preview to help the user to align the camera with the last captured frame before they begin capturing again. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureStopResult.LastFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureStopResult.LastFrame + +## -description +Gets a [VideoFrame](mediacapture_getpreviewframeasync_440877418.md) representing the last frame captured before the capture operation was stopped. + +## -property-value +The last frame captured before the capture operation was stopped. + +## -remarks +You can display the frame semi-transparently over the capture preview to help the user to align the camera with the last captured frame before they begin capturing again. + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturestopresult_recordduration.md b/windows.media.capture/mediacapturestopresult_recordduration.md index 7c4ffad99f..0bf7877ef8 100644 --- a/windows.media.capture/mediacapturestopresult_recordduration.md +++ b/windows.media.capture/mediacapturestopresult_recordduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureStopResult.RecordDuration --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureStopResult.RecordDuration ## -description Gets the duration of the media captured before the capture operation was stopped. ## -property-value The duration of the media captured before the capture operation was stopped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureStopResult.RecordDuration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureStopResult.RecordDuration + +## -description +Gets the duration of the media captured before the capture operation was stopped. + +## -property-value +The duration of the media captured before the capture operation was stopped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofile.md b/windows.media.capture/mediacapturevideoprofile.md index 344ec4a3fa..7a83a6bf74 100644 --- a/windows.media.capture/mediacapturevideoprofile.md +++ b/windows.media.capture/mediacapturevideoprofile.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Media.Capture.MediaCaptureVideoProfile --api-type: winrt class ---- # Windows.Media.Capture.MediaCaptureVideoProfile ## -description Represents a video profile that indicates a configuration supported by the video capture device. ## -remarks Video profiles provide a simple way to configure the video capture device with a group of settings that are guaranteed to work with a particular capture device and are optimized for your desired capture scenario. There is a set of known video profiles that the system provides for common scenarios, such as capturing high-quality photos or video, capturing a photo sequence, or video conferencing. To get a list of the known video profiles for a given video device, use [MediaCapture::FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md). Some hardware vendors may expose other video profiles that you can get by calling [MediaCapture::FindAllVideoProfiles](mediacapture_findallvideoprofiles.md). A video profile exposes three lists of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects, [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md), and [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md). Each item in these lists is a group of settings that are supported for the corresponding operation. For example, a single video profile may support recording 720p video at 30 fps with HDR video support and also support recording 1080p video at 30 fps without HDR video support. In this case, each of these would be represented by a [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object in the [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list of the video profile. You configure the capture device to use a particular video profile by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings::VideoProfile](mediacaptureinitializationsettings_videoprofile.md). Before using video profiles, you should check the value returned by [MediaCapture::IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that video profiles are supported by the capture device. For how-to guidance for working with video profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). ## -examples ## -see-also [FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md), [FindAllVideoProfiles](mediacapture_findallvideoprofiles.md), [FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md), [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.MediaCaptureVideoProfile +-api-type: winrt class +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile + +## -description +Represents a video profile that indicates a configuration supported by the video capture device. + +## -remarks +Video profiles provide a simple way to configure the video capture device with a group of settings that are guaranteed to work with a particular capture device and are optimized for your desired capture scenario. There is a set of known video profiles that the system provides for common scenarios, such as capturing high-quality photos or video, capturing a photo sequence, or video conferencing. To get a list of the known video profiles for a given video device, use [MediaCapture::FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md). Some hardware vendors may expose other video profiles that you can get by calling [MediaCapture::FindAllVideoProfiles](mediacapture_findallvideoprofiles.md). + +A video profile exposes three lists of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects, [SupportedPhotoMediaDescription](mediacapturevideoprofile_supportedphotomediadescription.md), [SupportedPreviewMediaDescription](mediacapturevideoprofile_supportedpreviewmediadescription.md), and [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md). Each item in these lists is a group of settings that are supported for the corresponding operation. For example, a single video profile may support recording 720p video at 30 fps with HDR video support and also support recording 1080p video at 30 fps without HDR video support. In this case, each of these would be represented by a [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object in the [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list of the video profile. + +You configure the capture device to use a particular video profile by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings::VideoProfile](mediacaptureinitializationsettings_videoprofile.md). + +Before using video profiles, you should check the value returned by [MediaCapture::IsVideoProfileSupported](mediacapture_isvideoprofilesupported.md) to make sure that video profiles are supported by the capture device. + +For how-to guidance for working with video profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). + +## -examples + +## -see-also +[FindKnownVideoProfiles](mediacapture_findknownvideoprofiles.md), [FindAllVideoProfiles](mediacapture_findallvideoprofiles.md), [FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md), [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file diff --git a/windows.media.capture/mediacapturevideoprofile_getconcurrency_2045494455.md b/windows.media.capture/mediacapturevideoprofile_getconcurrency_2045494455.md index 9172c32201..bff752d9fc 100644 --- a/windows.media.capture/mediacapturevideoprofile_getconcurrency_2045494455.md +++ b/windows.media.capture/mediacapturevideoprofile_getconcurrency_2045494455.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Capture.MediaCaptureVideoProfile.GetConcurrency --api-type: winrt method ---- # Windows.Media.Capture.MediaCaptureVideoProfile.GetConcurrency ## -description Gets the list of [MediaCaptureVideoProfile](mediacapturevideoprofile.md) objects that can be used concurrently with this video profile. ## -returns The list of [MediaCaptureVideoProfile](mediacapturevideoprofile.md) objects that can be used concurrently with this video profile. ## -remarks You can get a list of video profiles that support concurrency by calling [MediaCapture::FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md). ## -examples ## -see-also [MediaCapture::FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.MediaCaptureVideoProfile.GetConcurrency +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile.GetConcurrency + +## -description +Gets the list of [MediaCaptureVideoProfile](mediacapturevideoprofile.md) objects that can be used concurrently with this video profile. + +## -returns +The list of [MediaCaptureVideoProfile](mediacapturevideoprofile.md) objects that can be used concurrently with this video profile. + +## -remarks +You can get a list of video profiles that support concurrency by calling [MediaCapture::FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md). + +## -examples + +## -see-also +[MediaCapture::FindConcurrentProfiles](mediacapture_findconcurrentprofiles.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapturevideoprofile_id.md b/windows.media.capture/mediacapturevideoprofile_id.md index 77632507a9..065fee5e16 100644 --- a/windows.media.capture/mediacapturevideoprofile_id.md +++ b/windows.media.capture/mediacapturevideoprofile_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.Id --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfile.Id ## -description Gets the unique identifier of the video profile. ## -property-value The unique identifier of the video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.Id +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile.Id + +## -description +Gets the unique identifier of the video profile. + +## -property-value +The unique identifier of the video profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofile_supportedphotomediadescription.md b/windows.media.capture/mediacapturevideoprofile_supportedphotomediadescription.md index bda21d2c30..ae1e341cab 100644 --- a/windows.media.capture/mediacapturevideoprofile_supportedphotomediadescription.md +++ b/windows.media.capture/mediacapturevideoprofile_supportedphotomediadescription.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPhotoMediaDescription --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPhotoMediaDescription ## -description Gets a list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for photo capture. ## -property-value A list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for photo capture. ## -remarks You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) for photo capture by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description value you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md). ## -examples ## -see-also [MediaCaptureInitializationSettings::PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), [MediaCaptureInitializationSettings::PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPhotoMediaDescription +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPhotoMediaDescription + +## -description +Gets a list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for photo capture. + +## -property-value +A list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for photo capture. + +## -remarks +You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) for photo capture by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description value you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md). + +## -examples + +## -see-also +[MediaCaptureInitializationSettings::PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), [MediaCaptureInitializationSettings::PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapturevideoprofile_supportedpreviewmediadescription.md b/windows.media.capture/mediacapturevideoprofile_supportedpreviewmediadescription.md index be718972c7..32f27d901c 100644 --- a/windows.media.capture/mediacapturevideoprofile_supportedpreviewmediadescription.md +++ b/windows.media.capture/mediacapturevideoprofile_supportedpreviewmediadescription.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPreviewMediaDescription --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPreviewMediaDescription ## -description Gets a list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video preview. ## -property-value A list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video preview. ## -remarks You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) for photo capture by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description value you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md). ## -examples ## -see-also [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md), [MediaCaptureInitializationSettings::PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPreviewMediaDescription +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile.SupportedPreviewMediaDescription + +## -description +Gets a list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video preview. + +## -property-value +A list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video preview. + +## -remarks +You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) for photo capture by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description value you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md). + +## -examples + +## -see-also +[MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md), [MediaCaptureInitializationSettings::PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapturevideoprofile_supportedrecordmediadescription.md b/windows.media.capture/mediacapturevideoprofile_supportedrecordmediadescription.md index c357e78666..7ac770b50f 100644 --- a/windows.media.capture/mediacapturevideoprofile_supportedrecordmediadescription.md +++ b/windows.media.capture/mediacapturevideoprofile_supportedrecordmediadescription.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.SupportedRecordMediaDescription --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfile.SupportedRecordMediaDescription ## -description Gets a list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video recording. ## -property-value A list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video recording. ## -remarks You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) for photo capture by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description value you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md). ## -examples ## -see-also [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md), [MediaCaptureInitializationSettings::RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.SupportedRecordMediaDescription +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile.SupportedRecordMediaDescription + +## -description +Gets a list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video recording. + +## -property-value +A list of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) objects that represent supported video device settings for video recording. + +## -remarks +You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) for photo capture by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description value you use when configuring the device is compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md). + +## -examples + +## -see-also +[MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md), [MediaCaptureInitializationSettings::RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md) \ No newline at end of file diff --git a/windows.media.capture/mediacapturevideoprofile_videodeviceid.md b/windows.media.capture/mediacapturevideoprofile_videodeviceid.md index 22fa3004a2..bbf9e93861 100644 --- a/windows.media.capture/mediacapturevideoprofile_videodeviceid.md +++ b/windows.media.capture/mediacapturevideoprofile_videodeviceid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.VideoDeviceId --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfile.VideoDeviceId ## -description Gets the device ID of the video device associated with the video profile. ## -property-value The device ID of the video device associated with the video profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfile.VideoDeviceId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfile.VideoDeviceId + +## -description +Gets the device ID of the video device associated with the video profile. + +## -property-value +The device ID of the video device associated with the video profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofilemediadescription.md b/windows.media.capture/mediacapturevideoprofilemediadescription.md index 8537745751..847df9aa08 100644 --- a/windows.media.capture/mediacapturevideoprofilemediadescription.md +++ b/windows.media.capture/mediacapturevideoprofilemediadescription.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription --api-type: winrt class ---- # Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription ## -description Represents a description of media that is supported by a video profile. ## -remarks An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, a single video profile may support recording 720p video at 30 fps with HDR video support and also support recording 1080p video at 30 fps without HDR video support. In this case, each of these would be represented by a [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object in the [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list of the video profile. Each profile contains separate lists of media descriptions for photo capture, preview, and video recording. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description values you use when configuring the device are compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [MediaCaptureInitializationSettings.PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [MediaCaptureInitializationSettings.RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md). For how-to guidance for working with video profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). ## -examples ## -see-also [MediaCaptureVideoProfile](mediacapturevideoprofile.md), [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription +-api-type: winrt class +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription + +## -description +Represents a description of media that is supported by a video profile. + +## -remarks +An instance of [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) defines a group of capture settings that are supported by a video profile. For example, a single video profile may support recording 720p video at 30 fps with HDR video support and also support recording 1080p video at 30 fps without HDR video support. In this case, each of these would be represented by a [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) object in the [SupportedRecordMediaDescription](mediacapturevideoprofile_supportedrecordmediadescription.md) list of the video profile. Each profile contains separate lists of media descriptions for photo capture, preview, and video recording. For more information on video profiles, see [MediaCaptureVideoProfile](mediacapturevideoprofile.md). + +You configure the capture device to use a particular [MediaCaptureVideoProfileMediaDescription](mediacapturevideoprofilemediadescription.md) by using the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object. It is important that the video profile media description values you use when configuring the device are compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), see [MediaCaptureInitializationSettings.PhotoMediaDescription](mediacaptureinitializationsettings_photomediadescription.md), [MediaCaptureInitializationSettings.PreviewMediaDescription](mediacaptureinitializationsettings_previewmediadescription.md), and [MediaCaptureInitializationSettings.RecordMediaDescription](mediacaptureinitializationsettings_recordmediadescription.md). + +For how-to guidance for working with video profiles, see [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles). + +## -examples + +## -see-also +[MediaCaptureVideoProfile](mediacapturevideoprofile.md), [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md), [Discover and select camera capabilities with camera profiles](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-profiles) \ No newline at end of file diff --git a/windows.media.capture/mediacapturevideoprofilemediadescription_framerate.md b/windows.media.capture/mediacapturevideoprofilemediadescription_framerate.md index 7fced16a54..e86f56ed1f 100644 --- a/windows.media.capture/mediacapturevideoprofilemediadescription_framerate.md +++ b/windows.media.capture/mediacapturevideoprofilemediadescription_framerate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.FrameRate --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.FrameRate ## -description Gets the frame rate of the media description. ## -property-value The frame rate of the media description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.FrameRate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.FrameRate + +## -description +Gets the frame rate of the media description. + +## -property-value +The frame rate of the media description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofilemediadescription_height.md b/windows.media.capture/mediacapturevideoprofilemediadescription_height.md index 2b6f0036c7..723e981c0f 100644 --- a/windows.media.capture/mediacapturevideoprofilemediadescription_height.md +++ b/windows.media.capture/mediacapturevideoprofilemediadescription_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Height --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Height ## -description Gets the height of the media description. ## -property-value The height of the media description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Height +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Height + +## -description +Gets the height of the media description. + +## -property-value +The height of the media description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofilemediadescription_ishdrvideosupported.md b/windows.media.capture/mediacapturevideoprofilemediadescription_ishdrvideosupported.md index 0d124cc863..4c12ce99db 100644 --- a/windows.media.capture/mediacapturevideoprofilemediadescription_ishdrvideosupported.md +++ b/windows.media.capture/mediacapturevideoprofilemediadescription_ishdrvideosupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsHdrVideoSupported --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsHdrVideoSupported ## -description Gets a value indicating if the media description includes HDR video support. ## -property-value True if HDR video is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsHdrVideoSupported +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsHdrVideoSupported + +## -description +Gets a value indicating if the media description includes HDR video support. + +## -property-value +True if HDR video is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofilemediadescription_isvariablephotosequencesupported.md b/windows.media.capture/mediacapturevideoprofilemediadescription_isvariablephotosequencesupported.md index 150c4c2a2b..5ec35cc8ba 100644 --- a/windows.media.capture/mediacapturevideoprofilemediadescription_isvariablephotosequencesupported.md +++ b/windows.media.capture/mediacapturevideoprofilemediadescription_isvariablephotosequencesupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsVariablePhotoSequenceSupported --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsVariablePhotoSequenceSupported ## -description Gets a value indicating if the media description includes variable photo sequence support. ## -property-value True if variable photo sequence is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsVariablePhotoSequenceSupported +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.IsVariablePhotoSequenceSupported + +## -description +Gets a value indicating if the media description includes variable photo sequence support. + +## -property-value +True if variable photo sequence is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/mediacapturevideoprofilemediadescription_width.md b/windows.media.capture/mediacapturevideoprofilemediadescription_width.md index 85358c3d52..66eda2112c 100644 --- a/windows.media.capture/mediacapturevideoprofilemediadescription_width.md +++ b/windows.media.capture/mediacapturevideoprofilemediadescription_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Width --api-type: winrt property ---- # Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Width ## -description Gets the height of the media description. ## -property-value The height of the media description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Width +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureVideoProfileMediaDescription.Width + +## -description +Gets the height of the media description. + +## -property-value +The height of the media description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/optionalreferencephotocapturedeventargs.md b/windows.media.capture/optionalreferencephotocapturedeventargs.md index afa0145a29..c59c7ffea4 100644 --- a/windows.media.capture/optionalreferencephotocapturedeventargs.md +++ b/windows.media.capture/optionalreferencephotocapturedeventargs.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs ## -description Provides data for the [AdvancedPhotoCapture.OptionalReferencePhotoCaptured](optionalreferencephotocapturedeventargs.md) event. ## -remarks Get an instance of this class by handling the [AdvancedPhotoCapture.OptionalReferencePhotoCaptured](optionalreferencephotocapturedeventargs.md) event. Some devices support returning a reference photo from the capture operation that can be consumed by the calling app before all image frames for the operation have been captured or processed. On devices that do not support returning a reference photo, this event is never raised. For how-to guidance for using [AdvancedPhotoCapture](advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). ## -examples ## -see-also [AdvancedPhotoCapture](advancedphotocapture.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs + +## -description +Provides data for the [AdvancedPhotoCapture.OptionalReferencePhotoCaptured](optionalreferencephotocapturedeventargs.md) event. + +## -remarks +Get an instance of this class by handling the [AdvancedPhotoCapture.OptionalReferencePhotoCaptured](optionalreferencephotocapturedeventargs.md) event. + +Some devices support returning a reference photo from the capture operation that can be consumed by the calling app before all image frames for the operation have been captured or processed. On devices that do not support returning a reference photo, this event is never raised. + +For how-to guidance for using [AdvancedPhotoCapture](advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +## -examples + +## -see-also +[AdvancedPhotoCapture](advancedphotocapture.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file diff --git a/windows.media.capture/optionalreferencephotocapturedeventargs_context.md b/windows.media.capture/optionalreferencephotocapturedeventargs_context.md index 04af612c33..c62859fd11 100644 --- a/windows.media.capture/optionalreferencephotocapturedeventargs_context.md +++ b/windows.media.capture/optionalreferencephotocapturedeventargs_context.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Context --api-type: winrt property ---- # Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Context ## -description Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to [AdvancedPhotoCapture.CaptureAsync(Object)](advancedphotocapture_captureasync_651770772.md). ## -property-value The app-defined context object associated with the advanced photo capture operation. ## -remarks One overload of [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md) allows you to provide an app-defined object that conveys context information. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Context +-api-type: winrt property +--- + + + +# Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Context + +## -description +Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to [AdvancedPhotoCapture.CaptureAsync(Object)](advancedphotocapture_captureasync_651770772.md). + +## -property-value +The app-defined context object associated with the advanced photo capture operation. + +## -remarks +One overload of [AdvancedPhotoCapture.CaptureAsync](advancedphotocapture_captureasync.md) allows you to provide an app-defined object that conveys context information. + +## -examples + +## -see-also diff --git a/windows.media.capture/optionalreferencephotocapturedeventargs_frame.md b/windows.media.capture/optionalreferencephotocapturedeventargs_frame.md index 7eaa16e8d2..84aadf0988 100644 --- a/windows.media.capture/optionalreferencephotocapturedeventargs_frame.md +++ b/windows.media.capture/optionalreferencephotocapturedeventargs_frame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Frame --api-type: winrt property ---- # Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Frame ## -description Gets the captured frame containing the reference photo from the advanced photo capture. ## -property-value The captured frame containing the reference photo. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.OptionalReferencePhotoCapturedEventArgs.Frame + +## -description +Gets the captured frame containing the reference photo from the advanced photo capture. + +## -property-value +The captured frame containing the reference photo. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/photocapturedeventargs.md b/windows.media.capture/photocapturedeventargs.md index d196c78e24..63130f45a6 100644 --- a/windows.media.capture/photocapturedeventargs.md +++ b/windows.media.capture/photocapturedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.PhotoCapturedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.PhotoCapturedEventArgs ## -description Provides data for the photo sequence [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event. ## -remarks [Frame](photocapturedeventargs_frame.md) is the captured image associated with this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.PhotoCapturedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.PhotoCapturedEventArgs + +## -description +Provides data for the photo sequence [PhotoCaptured](lowlagphotosequencecapture_photocaptured.md) event. + +## -remarks +[Frame](photocapturedeventargs_frame.md) is the captured image associated with this event. + +## -examples + +## -see-also diff --git a/windows.media.capture/photocapturedeventargs_capturetimeoffset.md b/windows.media.capture/photocapturedeventargs_capturetimeoffset.md index 5e931ba857..0f751009d5 100644 --- a/windows.media.capture/photocapturedeventargs_capturetimeoffset.md +++ b/windows.media.capture/photocapturedeventargs_capturetimeoffset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.PhotoCapturedEventArgs.CaptureTimeOffset --api-type: winrt property ---- # Windows.Media.Capture.PhotoCapturedEventArgs.CaptureTimeOffset ## -description Gets a value that indicates time offset in the photo sequence. ## -property-value The ## -remarks A negative value indicates the image was taken prior to the start of the photo sequence, while a positive value indicates the image occurred after the photo sequence was started. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.PhotoCapturedEventArgs.CaptureTimeOffset +-api-type: winrt property +--- + + + +# Windows.Media.Capture.PhotoCapturedEventArgs.CaptureTimeOffset + +## -description +Gets a value that indicates time offset in the photo sequence. + +## -property-value +The + +## -remarks +A negative value indicates the image was taken prior to the start of the photo sequence, while a positive value indicates the image occurred after the photo sequence was started. + +## -examples + +## -see-also diff --git a/windows.media.capture/photocapturedeventargs_frame.md b/windows.media.capture/photocapturedeventargs_frame.md index 2eb934c34c..447af00487 100644 --- a/windows.media.capture/photocapturedeventargs_frame.md +++ b/windows.media.capture/photocapturedeventargs_frame.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.PhotoCapturedEventArgs.Frame --api-type: winrt property ---- # Windows.Media.Capture.PhotoCapturedEventArgs.Frame ## -description Gets the captured image associated with the event. ## -property-value The captured image. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.PhotoCapturedEventArgs.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.PhotoCapturedEventArgs.Frame + +## -description +Gets the captured image associated with the event. + +## -property-value +The captured image. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/photocapturedeventargs_thumbnail.md b/windows.media.capture/photocapturedeventargs_thumbnail.md index 9c45576791..03e46a0877 100644 --- a/windows.media.capture/photocapturedeventargs_thumbnail.md +++ b/windows.media.capture/photocapturedeventargs_thumbnail.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.PhotoCapturedEventArgs.Thumbnail --api-type: winrt property ---- # Windows.Media.Capture.PhotoCapturedEventArgs.Thumbnail ## -description Gets a thumbnail version of the captured image associated with the event. ## -property-value The thumbnail image. ## -remarks ## -examples ## -see-also [LowLagPhotoSequenceControl.ThumbnailEnabled](../windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md), [ LowLagPhotoSequenceControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md), [LowLagPhotoSequenceControl.ThumbnailFormat](../windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.PhotoCapturedEventArgs.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Capture.PhotoCapturedEventArgs.Thumbnail + +## -description +Gets a thumbnail version of the captured image associated with the event. + +## -property-value +The thumbnail image. + +## -remarks + +## -examples + +## -see-also +[LowLagPhotoSequenceControl.ThumbnailEnabled](../windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md), [ LowLagPhotoSequenceControl.DesiredThumbnailSize](../windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md), [LowLagPhotoSequenceControl.ThumbnailFormat](../windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md) \ No newline at end of file diff --git a/windows.media.capture/photoconfirmationcapturedeventargs.md b/windows.media.capture/photoconfirmationcapturedeventargs.md index cc3b7dd739..6a21ab8f07 100644 --- a/windows.media.capture/photoconfirmationcapturedeventargs.md +++ b/windows.media.capture/photoconfirmationcapturedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.PhotoConfirmationCapturedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.PhotoConfirmationCapturedEventArgs ## -description Provides data for the [PhotoConfirmationCaptured](mediacapture_photoconfirmationcaptured.md) event. ## -remarks Handle the [MediaCapture.PhotoConfirmationCaptured](mediacapture_photoconfirmationcaptured.md) event to get an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.PhotoConfirmationCapturedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.PhotoConfirmationCapturedEventArgs + +## -description +Provides data for the [PhotoConfirmationCaptured](mediacapture_photoconfirmationcaptured.md) event. + +## -remarks +Handle the [MediaCapture.PhotoConfirmationCaptured](mediacapture_photoconfirmationcaptured.md) event to get an instance of this class. + +## -examples + +## -see-also diff --git a/windows.media.capture/photoconfirmationcapturedeventargs_capturetimeoffset.md b/windows.media.capture/photoconfirmationcapturedeventargs_capturetimeoffset.md index 063d7b3417..8ea1200303 100644 --- a/windows.media.capture/photoconfirmationcapturedeventargs_capturetimeoffset.md +++ b/windows.media.capture/photoconfirmationcapturedeventargs_capturetimeoffset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.CaptureTimeOffset --api-type: winrt property ---- # Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.CaptureTimeOffset ## -description Gets the time offset from when capture began to the capture of the frame associated with the event. ## -property-value The time offset from when capture began to the capture of the frame associated with the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.CaptureTimeOffset +-api-type: winrt property +--- + + + +# Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.CaptureTimeOffset + +## -description +Gets the time offset from when capture began to the capture of the frame associated with the event. + +## -property-value +The time offset from when capture began to the capture of the frame associated with the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/photoconfirmationcapturedeventargs_frame.md b/windows.media.capture/photoconfirmationcapturedeventargs_frame.md index e8736c312b..0d74e92711 100644 --- a/windows.media.capture/photoconfirmationcapturedeventargs_frame.md +++ b/windows.media.capture/photoconfirmationcapturedeventargs_frame.md @@ -1,46 +1,46 @@ ---- --api-id: P:Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.Frame --api-type: winrt property ---- - - - -# Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.Frame - -## -description -Gets the captured frame. - -## -property-value -The captured frame. - -## -remarks -The data returned in the Frame property is raw pixel data. In other words, it does not include an image file format header. Because of this, you can't pass the captured frame's stream to the bitmap's [SetSourceAsync](../windows.ui.xaml.media.imaging/bitmapsource_setsourceasync.md) method directly. Instead, you must copy the pixel data manually into the bitmap's pixel buffer. The following code snippets show you how to copy the image data and provide a helper class that performs the operation. - -First, you need to enable photo confirmation and hook up the [PhotoConfirmationCaptured](mediacapture_photoconfirmationcaptured.md) event. - - - - - -[!code-cs[EnablePhotoConfirmation](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetEnablePhotoConfirmation)] - - - - - -[!code-cs[PhotoConfirmationCaptured](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetPhotoConfirmationCaptured)] - - - -The following code snippet shows the helper class that defines the extension methods for the copying captured frame data into the writeable bitmap's pixel data stream. The class provides synchronous and asynchronous methods and overloads that allow you to specify a copy buffer size or use a default size. - -[!code-cs[StreamExtenstions](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetStreamExtenstions)] - -## -examples - -## -see-also - - - +--- +-api-id: P:Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.PhotoConfirmationCapturedEventArgs.Frame + +## -description +Gets the captured frame. + +## -property-value +The captured frame. + +## -remarks +The data returned in the Frame property is raw pixel data. In other words, it does not include an image file format header. Because of this, you can't pass the captured frame's stream to the bitmap's [SetSourceAsync](../windows.ui.xaml.media.imaging/bitmapsource_setsourceasync.md) method directly. Instead, you must copy the pixel data manually into the bitmap's pixel buffer. The following code snippets show you how to copy the image data and provide a helper class that performs the operation. + +First, you need to enable photo confirmation and hook up the [PhotoConfirmationCaptured](mediacapture_photoconfirmationcaptured.md) event. + + + + + +[!code-cs[EnablePhotoConfirmation](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetEnablePhotoConfirmation)] + + + + + +[!code-cs[PhotoConfirmationCaptured](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetPhotoConfirmationCaptured)] + + + +The following code snippet shows the helper class that defines the extension methods for the copying captured frame data into the writeable bitmap's pixel data stream. The class provides synchronous and asynchronous methods and overloads that allow you to specify a copy buffer size or use a default size. + +[!code-cs[StreamExtenstions](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetStreamExtenstions)] + +## -examples + +## -see-also + + + diff --git a/windows.media.capture/screencapture.md b/windows.media.capture/screencapture.md index ea6b92e18e..6ae72f55c0 100644 --- a/windows.media.capture/screencapture.md +++ b/windows.media.capture/screencapture.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Capture.ScreenCapture --api-type: winrt class ---- # Windows.Media.Capture.ScreenCapture ## -description Enables an app to capture audio and video of the contents being displayed on the device. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.ScreenCapture +-api-type: winrt class +--- + + + +# Windows.Media.Capture.ScreenCapture + +## -description +Enables an app to capture audio and video of the contents being displayed on the device. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +## -examples + +## -see-also diff --git a/windows.media.capture/screencapture_audiosource.md b/windows.media.capture/screencapture_audiosource.md index 0ac4483b26..b39254e074 100644 --- a/windows.media.capture/screencapture_audiosource.md +++ b/windows.media.capture/screencapture_audiosource.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.ScreenCapture.AudioSource --api-type: winrt property ---- # Windows.Media.Capture.ScreenCapture.AudioSource ## -description Gets the audio source used for screen capture. ## -property-value The audio source used for screen capture. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. Use this property to set the [AudioSource](mediacaptureinitializationsettings_audiosource.md) property of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object that you use to initialize a [MediaCapture](mediacapture.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.ScreenCapture.AudioSource +-api-type: winrt property +--- + + + +# Windows.Media.Capture.ScreenCapture.AudioSource + +## -description +Gets the audio source used for screen capture. + +## -property-value +The audio source used for screen capture. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +Use this property to set the [AudioSource](mediacaptureinitializationsettings_audiosource.md) property of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object that you use to initialize a [MediaCapture](mediacapture.md) object. + +## -examples + +## -see-also diff --git a/windows.media.capture/screencapture_getforcurrentview_1363600702.md b/windows.media.capture/screencapture_getforcurrentview_1363600702.md index 167490c482..7669aff410 100644 --- a/windows.media.capture/screencapture_getforcurrentview_1363600702.md +++ b/windows.media.capture/screencapture_getforcurrentview_1363600702.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Capture.ScreenCapture.GetForCurrentView --api-type: winrt method ---- # Windows.Media.Capture.ScreenCapture.GetForCurrentView ## -description Gets the [ScreenCapture](screencapture.md) object associated with the app's current view. ## -returns The [ScreenCapture](screencapture.md) object associated with the app's current view. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. Use this method to obtain an instance of the [ScreenCapture](screencapture.md) class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Capture.ScreenCapture.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Media.Capture.ScreenCapture.GetForCurrentView + +## -description +Gets the [ScreenCapture](screencapture.md) object associated with the app's current view. + +## -returns +The [ScreenCapture](screencapture.md) object associated with the app's current view. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +Use this method to obtain an instance of the [ScreenCapture](screencapture.md) class. + +## -examples + +## -see-also diff --git a/windows.media.capture/screencapture_isaudiosuspended.md b/windows.media.capture/screencapture_isaudiosuspended.md index 3d6c122e70..ed719a5a1b 100644 --- a/windows.media.capture/screencapture_isaudiosuspended.md +++ b/windows.media.capture/screencapture_isaudiosuspended.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.ScreenCapture.IsAudioSuspended --api-type: winrt property ---- # Windows.Media.Capture.ScreenCapture.IsAudioSuspended ## -description Gets whether the screen capture of audio is currently suspended. ## -property-value Whether the screen capture audio is currently suspended. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. The recording of audio during screen capture is suspended when protected audio content, such as content protected by DRM, is played. You can check this property before beginning a screen capture and you can also handle the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event to be notified if audio is suspended while you are recording. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.ScreenCapture.IsAudioSuspended +-api-type: winrt property +--- + + + +# Windows.Media.Capture.ScreenCapture.IsAudioSuspended + +## -description +Gets whether the screen capture of audio is currently suspended. + +## -property-value +Whether the screen capture audio is currently suspended. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +The recording of audio during screen capture is suspended when protected audio content, such as content protected by DRM, is played. You can check this property before beginning a screen capture and you can also handle the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event to be notified if audio is suspended while you are recording. + +## -examples + +## -see-also diff --git a/windows.media.capture/screencapture_isvideosuspended.md b/windows.media.capture/screencapture_isvideosuspended.md index 4acc1835ab..4a941f5adb 100644 --- a/windows.media.capture/screencapture_isvideosuspended.md +++ b/windows.media.capture/screencapture_isvideosuspended.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.ScreenCapture.IsVideoSuspended --api-type: winrt property ---- # Windows.Media.Capture.ScreenCapture.IsVideoSuspended ## -description Gets whether the screen capture of video is currently suspended. ## -property-value Whether the screen capture of video is currently suspended. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. The recording of video during screen capture is suspended when protected content, such as an incoming phone call notification, is displayed on the screen. You can check this property before beginning a screen capture and you can also handle the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event to be notified if video is suspended while you are recording. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.ScreenCapture.IsVideoSuspended +-api-type: winrt property +--- + + + +# Windows.Media.Capture.ScreenCapture.IsVideoSuspended + +## -description +Gets whether the screen capture of video is currently suspended. + +## -property-value +Whether the screen capture of video is currently suspended. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +The recording of video during screen capture is suspended when protected content, such as an incoming phone call notification, is displayed on the screen. You can check this property before beginning a screen capture and you can also handle the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event to be notified if video is suspended while you are recording. + +## -examples + +## -see-also diff --git a/windows.media.capture/screencapture_sourcesuspensionchanged.md b/windows.media.capture/screencapture_sourcesuspensionchanged.md index 03704826f6..c028259093 100644 --- a/windows.media.capture/screencapture_sourcesuspensionchanged.md +++ b/windows.media.capture/screencapture_sourcesuspensionchanged.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Media.Capture.ScreenCapture.SourceSuspensionChanged --api-type: winrt event ---- # Windows.Media.Capture.ScreenCapture.SourceSuspensionChanged ## -description Raised when the suspension of screen captured audio or video changes. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. The capture of audio or video will be suspended when protected content is being played or displayed. You can use [IsAudioSuspended](screencapture_isaudiosuspended.md) or [IsVideoSuspended](screencapture_isvideosuspended.md) to determine whether audio or video is currently suspended. Handle this event to be notified when the suspension of audio or video changes. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Capture.ScreenCapture.SourceSuspensionChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.ScreenCapture.SourceSuspensionChanged + +## -description +Raised when the suspension of screen captured audio or video changes. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +The capture of audio or video will be suspended when protected content is being played or displayed. You can use [IsAudioSuspended](screencapture_isaudiosuspended.md) or [IsVideoSuspended](screencapture_isvideosuspended.md) to determine whether audio or video is currently suspended. Handle this event to be notified when the suspension of audio or video changes. + +## -examples + +## -see-also diff --git a/windows.media.capture/screencapture_videosource.md b/windows.media.capture/screencapture_videosource.md index c999305acf..4c45233eae 100644 --- a/windows.media.capture/screencapture_videosource.md +++ b/windows.media.capture/screencapture_videosource.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Capture.ScreenCapture.VideoSource --api-type: winrt property ---- # Windows.Media.Capture.ScreenCapture.VideoSource ## -description Gets the video source used for screen capture. ## -property-value The video source used for screen capture. ## -remarks > [!IMPORTANT] > The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. Use this property to set the [VideoSource](mediacaptureinitializationsettings_videosource.md) property of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object that you use to initialize a [MediaCapture](mediacapture.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.ScreenCapture.VideoSource +-api-type: winrt property +--- + + + +# Windows.Media.Capture.ScreenCapture.VideoSource + +## -description +Gets the video source used for screen capture. + +## -property-value +The video source used for screen capture. + +## -remarks +> [!IMPORTANT] +> The **ScreenCapture** feature is only supported for mobile devices running Windows Phone 8.1. This API is not supported on Windows 10. + +Use this property to set the [VideoSource](mediacaptureinitializationsettings_videosource.md) property of the [MediaCaptureInitializationSettings](mediacaptureinitializationsettings.md) object that you use to initialize a [MediaCapture](mediacapture.md) object. + +## -examples + +## -see-also diff --git a/windows.media.capture/sourcesuspensionchangedeventargs.md b/windows.media.capture/sourcesuspensionchangedeventargs.md index c901648abf..57e1eaa4af 100644 --- a/windows.media.capture/sourcesuspensionchangedeventargs.md +++ b/windows.media.capture/sourcesuspensionchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.SourceSuspensionChangedEventArgs --api-type: winrt class ---- # Windows.Media.Capture.SourceSuspensionChangedEventArgs ## -description Provides information about a [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event which is triggered when the capture of audio or video is suspended or resumed. ## -remarks Handle the [ScreenCapture.SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event to obtain an instance of this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.SourceSuspensionChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.SourceSuspensionChangedEventArgs + +## -description +Provides information about a [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event which is triggered when the capture of audio or video is suspended or resumed. + +## -remarks +Handle the [ScreenCapture.SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event to obtain an instance of this class. + +## -examples + +## -see-also diff --git a/windows.media.capture/sourcesuspensionchangedeventargs_isaudiosuspended.md b/windows.media.capture/sourcesuspensionchangedeventargs_isaudiosuspended.md index eb89c34fba..1d4f01352c 100644 --- a/windows.media.capture/sourcesuspensionchangedeventargs_isaudiosuspended.md +++ b/windows.media.capture/sourcesuspensionchangedeventargs_isaudiosuspended.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsAudioSuspended --api-type: winrt property ---- # Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsAudioSuspended ## -description Gets whether the screen capture of audio is currently suspended. ## -property-value Whether the screen capture of audio is currently suspended. ## -remarks The recording of audio during screen capture is suspended when protected audio content, such as content protected by DRM, is played. You can also check the [IsAudioSuspended](screencapture_isaudiosuspended.md) property to determine if audio capture is suspended outside of the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsAudioSuspended +-api-type: winrt property +--- + + + +# Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsAudioSuspended + +## -description +Gets whether the screen capture of audio is currently suspended. + +## -property-value +Whether the screen capture of audio is currently suspended. + +## -remarks +The recording of audio during screen capture is suspended when protected audio content, such as content protected by DRM, is played. You can also check the [IsAudioSuspended](screencapture_isaudiosuspended.md) property to determine if audio capture is suspended outside of the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event handler. + +## -examples + +## -see-also diff --git a/windows.media.capture/sourcesuspensionchangedeventargs_isvideosuspended.md b/windows.media.capture/sourcesuspensionchangedeventargs_isvideosuspended.md index 8e9d69103d..63af371c27 100644 --- a/windows.media.capture/sourcesuspensionchangedeventargs_isvideosuspended.md +++ b/windows.media.capture/sourcesuspensionchangedeventargs_isvideosuspended.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsVideoSuspended --api-type: winrt property ---- # Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsVideoSuspended ## -description Gets whether the screen capture of audio is currently suspended. ## -property-value Whether the screen capture of audio is currently suspended. ## -remarks The recording of video during screen capture is suspended when protected visual content, such as an incoming call notification, is displayed. You can also check the [IsVideoSuspended](screencapture_isvideosuspended.md) property to determine if video capture is suspended outside of the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event handler. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsVideoSuspended +-api-type: winrt property +--- + + + +# Windows.Media.Capture.SourceSuspensionChangedEventArgs.IsVideoSuspended + +## -description +Gets whether the screen capture of audio is currently suspended. + +## -property-value +Whether the screen capture of audio is currently suspended. + +## -remarks +The recording of video during screen capture is suspended when protected visual content, such as an incoming call notification, is displayed. You can also check the [IsVideoSuspended](screencapture_isvideosuspended.md) property to determine if video capture is suspended outside of the [SourceSuspensionChanged](screencapture_sourcesuspensionchanged.md) event handler. + +## -examples + +## -see-also diff --git a/windows.media.capture/videostreamconfiguration.md b/windows.media.capture/videostreamconfiguration.md index 65fc206707..444093d2ca 100644 --- a/windows.media.capture/videostreamconfiguration.md +++ b/windows.media.capture/videostreamconfiguration.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Capture.VideoStreamConfiguration --api-type: winrt class ---- # Windows.Media.Capture.VideoStreamConfiguration ## -description Represents a set of input and output [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) for a video stream ## -remarks This is a helper class that enables the bundling of two [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md), one for input and one for output, to represent a single video stream configuration. Get an instance of this class by calling [VideoStabilizationEffect.GetRecommendedStreamConfiguration](../windows.media.core/videostabilizationeffect_getrecommendedstreamconfiguration.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Capture.VideoStreamConfiguration +-api-type: winrt class +--- + + + +# Windows.Media.Capture.VideoStreamConfiguration + +## -description +Represents a set of input and output [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) for a video stream + +## -remarks +This is a helper class that enables the bundling of two [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md), one for input and one for output, to represent a single video stream configuration. Get an instance of this class by calling [VideoStabilizationEffect.GetRecommendedStreamConfiguration](../windows.media.core/videostabilizationeffect_getrecommendedstreamconfiguration.md). + +## -examples + +## -see-also diff --git a/windows.media.capture/videostreamconfiguration_inputproperties.md b/windows.media.capture/videostreamconfiguration_inputproperties.md index 8402bbfdd1..227405be60 100644 --- a/windows.media.capture/videostreamconfiguration_inputproperties.md +++ b/windows.media.capture/videostreamconfiguration_inputproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.VideoStreamConfiguration.InputProperties --api-type: winrt property ---- # Windows.Media.Capture.VideoStreamConfiguration.InputProperties ## -description Gets a [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream input configuration. ## -property-value A [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream input configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.VideoStreamConfiguration.InputProperties +-api-type: winrt property +--- + + + +# Windows.Media.Capture.VideoStreamConfiguration.InputProperties + +## -description +Gets a [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream input configuration. + +## -property-value +A [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream input configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.capture/videostreamconfiguration_outputproperties.md b/windows.media.capture/videostreamconfiguration_outputproperties.md index 77555e6ef9..9850e5e01d 100644 --- a/windows.media.capture/videostreamconfiguration_outputproperties.md +++ b/windows.media.capture/videostreamconfiguration_outputproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Capture.VideoStreamConfiguration.OutputProperties --api-type: winrt property ---- # Windows.Media.Capture.VideoStreamConfiguration.OutputProperties ## -description Gets a [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream output configuration. ## -property-value A [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream output configuration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Capture.VideoStreamConfiguration.OutputProperties +-api-type: winrt property +--- + + + +# Windows.Media.Capture.VideoStreamConfiguration.OutputProperties + +## -description +Gets a [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream output configuration. + +## -property-value +A [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) object representing an video stream output configuration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection.md b/windows.media.casting/castingconnection.md index 085d49085e..7bb9ce9662 100644 --- a/windows.media.casting/castingconnection.md +++ b/windows.media.casting/castingconnection.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Casting.CastingConnection --api-type: winrt class ---- # Windows.Media.Casting.CastingConnection ## -description Represents a connection with a casting device. ## -remarks Get an instance of this class by calling [CreateCastingConnection](castingdevice_createcastingconnection.md). ## -examples ## -see-also [ICastingConnection](icastingconnection.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingConnection +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingConnection + +## -description +Represents a connection with a casting device. + +## -remarks +Get an instance of this class by calling [CreateCastingConnection](castingdevice_createcastingconnection.md). + +## -examples + +## -see-also +[ICastingConnection](icastingconnection.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.casting/castingconnection_close_811482585.md b/windows.media.casting/castingconnection_close_811482585.md index aca59f1f22..8c867616d9 100644 --- a/windows.media.casting/castingconnection_close_811482585.md +++ b/windows.media.casting/castingconnection_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Casting.CastingConnection.Close --api-type: winrt method ---- # Windows.Media.Casting.CastingConnection.Close ## -description Closes the casting connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingConnection.Close +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingConnection.Close + +## -description +Closes the casting connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_device.md b/windows.media.casting/castingconnection_device.md index 36b1adfcbc..12674b6a8a 100644 --- a/windows.media.casting/castingconnection_device.md +++ b/windows.media.casting/castingconnection_device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingConnection.Device --api-type: winrt property ---- # Windows.Media.Casting.CastingConnection.Device ## -description Gets the casting device with which a connection has been made. ## -property-value The casting device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingConnection.Device +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingConnection.Device + +## -description +Gets the casting device with which a connection has been made. + +## -property-value +The casting device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_disconnectasync_1697095933.md b/windows.media.casting/castingconnection_disconnectasync_1697095933.md index d0be5f7f75..140e0cf287 100644 --- a/windows.media.casting/castingconnection_disconnectasync_1697095933.md +++ b/windows.media.casting/castingconnection_disconnectasync_1697095933.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Casting.CastingConnection.DisconnectAsync --api-type: winrt method ---- # Windows.Media.Casting.CastingConnection.DisconnectAsync ## -description Terminates a casting connection. The content that was rendering remotely returns to the local element that you retrieved the casting source from. ## -returns The status of the termination. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingConnection.DisconnectAsync +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingConnection.DisconnectAsync + +## -description +Terminates a casting connection. The content that was rendering remotely returns to the local element that you retrieved the casting source from. + +## -returns +The status of the termination. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_erroroccurred.md b/windows.media.casting/castingconnection_erroroccurred.md index 2b273cde20..1c988b7d5c 100644 --- a/windows.media.casting/castingconnection_erroroccurred.md +++ b/windows.media.casting/castingconnection_erroroccurred.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Casting.CastingConnection.ErrorOccurred --api-type: winrt event ---- # Windows.Media.Casting.CastingConnection.ErrorOccurred ## -description Indicates an error occurred while attempting to make a casting connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Casting.CastingConnection.ErrorOccurred +-api-type: winrt event +--- + + + +# Windows.Media.Casting.CastingConnection.ErrorOccurred + +## -description +Indicates an error occurred while attempting to make a casting connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_requeststartcastingasync_640445836.md b/windows.media.casting/castingconnection_requeststartcastingasync_640445836.md index 2b456ab887..f5eb99087a 100644 --- a/windows.media.casting/castingconnection_requeststartcastingasync_640445836.md +++ b/windows.media.casting/castingconnection_requeststartcastingasync_640445836.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Casting.CastingConnection.RequestStartCastingAsync(Windows.Media.Casting.CastingSource) --api-type: winrt method ---- # Windows.Media.Casting.CastingConnection.RequestStartCastingAsync ## -description Starts the process of casting to a casting device. When called, this method pairs the c sting device, if necessary, and verifies access to the casting device with the user. If the user denies the app access to the device, casting fails. Otherwise, a connection is established, and content is sent to the device. During this time, the connection state changes to connecting, then to connected. If a casting source is set, the state changes to rendering once playback begins. ## -parameters ### -param value The content to be casted. ## -returns The status of the casting connection request. ## -remarks This method must be called from the UI thread or an exception will be thrown. To dispatch the call to the UI thread from another thread, you can use [CoreDispatcher.RunAsync](../windows.ui.core/coredispatcher_runasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingConnection.RequestStartCastingAsync(Windows.Media.Casting.CastingSource) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingConnection.RequestStartCastingAsync + +## -description +Starts the process of casting to a casting device. When called, this method pairs the c sting device, if necessary, and verifies access to the casting device with the user. If the user denies the app access to the device, casting fails. Otherwise, a connection is established, and content is sent to the device. During this time, the connection state changes to connecting, then to connected. If a casting source is set, the state changes to rendering once playback begins. + +## -parameters +### -param value +The content to be casted. + +## -returns +The status of the casting connection request. + +## -remarks +This method must be called from the UI thread or an exception will be thrown. To dispatch the call to the UI thread from another thread, you can use [CoreDispatcher.RunAsync](../windows.ui.core/coredispatcher_runasync.md). + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_source.md b/windows.media.casting/castingconnection_source.md index 5132fbfd48..825aafc748 100644 --- a/windows.media.casting/castingconnection_source.md +++ b/windows.media.casting/castingconnection_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingConnection.Source --api-type: winrt property ---- # Windows.Media.Casting.CastingConnection.Source ## -description Gets and sets the content source that is being casted through the connection to the casting device. The content can be set and changed at any time and doing so does not disconnect the connection. ## -property-value The content source that is being casted to the casting device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingConnection.Source +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingConnection.Source + +## -description +Gets and sets the content source that is being casted through the connection to the casting device. The content can be set and changed at any time and doing so does not disconnect the connection. + +## -property-value +The content source that is being casted to the casting device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_state.md b/windows.media.casting/castingconnection_state.md index 415c2f75d0..d93fa82f5b 100644 --- a/windows.media.casting/castingconnection_state.md +++ b/windows.media.casting/castingconnection_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingConnection.State --api-type: winrt property ---- # Windows.Media.Casting.CastingConnection.State ## -description Gets the current state of the connection. ## -property-value The current state of the connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingConnection.State +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingConnection.State + +## -description +Gets the current state of the connection. + +## -property-value +The current state of the connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnection_statechanged.md b/windows.media.casting/castingconnection_statechanged.md index 88103bf100..b4b1168c72 100644 --- a/windows.media.casting/castingconnection_statechanged.md +++ b/windows.media.casting/castingconnection_statechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Casting.CastingConnection.StateChanged --api-type: winrt event ---- # Windows.Media.Casting.CastingConnection.StateChanged ## -description Indicates a change in the [State](castingconnection_state.md) property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Casting.CastingConnection.StateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Casting.CastingConnection.StateChanged + +## -description +Indicates a change in the [State](castingconnection_state.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnectionerroroccurredeventargs.md b/windows.media.casting/castingconnectionerroroccurredeventargs.md index 9790e9c03c..6a87bf1402 100644 --- a/windows.media.casting/castingconnectionerroroccurredeventargs.md +++ b/windows.media.casting/castingconnectionerroroccurredeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs --api-type: winrt class ---- # Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs ## -description Represents arguments for the [ErrorOccurred](castingconnection_erroroccurred.md) event from the [CastingConnection](castingconnection.md) ## -remarks Get an instance of this class by handling the [ErrorOccurred](castingconnection_erroroccurred.md) event . ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs + +## -description +Represents arguments for the [ErrorOccurred](castingconnection_erroroccurred.md) event from the [CastingConnection](castingconnection.md) + +## -remarks +Get an instance of this class by handling the [ErrorOccurred](castingconnection_erroroccurred.md) event . + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnectionerroroccurredeventargs_errorstatus.md b/windows.media.casting/castingconnectionerroroccurredeventargs_errorstatus.md index 48d6c2e902..520ad5c142 100644 --- a/windows.media.casting/castingconnectionerroroccurredeventargs_errorstatus.md +++ b/windows.media.casting/castingconnectionerroroccurredeventargs_errorstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.ErrorStatus --api-type: winrt property ---- # Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.ErrorStatus ## -description Gets the particular error that triggered the casting error event, [ErrorOccurred](castingconnection_erroroccurred.md). ## -property-value The the error status when starting or ending a casting connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.ErrorStatus +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.ErrorStatus + +## -description +Gets the particular error that triggered the casting error event, [ErrorOccurred](castingconnection_erroroccurred.md). + +## -property-value +The the error status when starting or ending a casting connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingconnectionerroroccurredeventargs_message.md b/windows.media.casting/castingconnectionerroroccurredeventargs_message.md index d2280af0fd..9d8d14c4fb 100644 --- a/windows.media.casting/castingconnectionerroroccurredeventargs_message.md +++ b/windows.media.casting/castingconnectionerroroccurredeventargs_message.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.Message --api-type: winrt property ---- # Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.Message ## -description Gets human-readable message to accompany the error status code, [ErrorStatus](castingconnectionerroroccurredeventargs_errorstatus.md). ## -property-value The human-readable message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.Message +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingConnectionErrorOccurredEventArgs.Message + +## -description +Gets human-readable message to accompany the error status code, [ErrorStatus](castingconnectionerroroccurredeventargs_errorstatus.md). + +## -property-value +The human-readable message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice.md b/windows.media.casting/castingdevice.md index ebd524042d..6d17cd8f9f 100644 --- a/windows.media.casting/castingdevice.md +++ b/windows.media.casting/castingdevice.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Casting.CastingDevice --api-type: winrt class ---- # Windows.Media.Casting.CastingDevice ## -description Represents a physical device that is capable of supporting casting connections and rendering media content sent to it. ## -remarks Get an instance of this class by accessing the [ICastingConnection.Device](icastingconnection_device.md) or [VastingDeviceSelectedEventArgs.SelectedCastingDevice](castingdeviceselectedeventargs_selectedcastingdevice.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingDevice +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingDevice + +## -description +Represents a physical device that is capable of supporting casting connections and rendering media content sent to it. + +## -remarks +Get an instance of this class by accessing the [ICastingConnection.Device](icastingconnection_device.md) or [VastingDeviceSelectedEventArgs.SelectedCastingDevice](castingdeviceselectedeventargs_selectedcastingdevice.md) property. + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_createcastingconnection_475464068.md b/windows.media.casting/castingdevice_createcastingconnection_475464068.md index 959052e136..3babca3e3f 100644 --- a/windows.media.casting/castingdevice_createcastingconnection_475464068.md +++ b/windows.media.casting/castingdevice_createcastingconnection_475464068.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevice.CreateCastingConnection --api-type: winrt method ---- # Windows.Media.Casting.CastingDevice.CreateCastingConnection ## -description Creates a new [CastingConnection](castingconnection.md) object. This method does not establish a connection to the casting device. ## -returns The object that represents the casting connection. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevice.CreateCastingConnection +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevice.CreateCastingConnection + +## -description +Creates a new [CastingConnection](castingconnection.md) object. This method does not establish a connection to the casting device. + +## -returns +The object that represents the casting connection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_deviceinfosupportscastingasync_938969852.md b/windows.media.casting/castingdevice_deviceinfosupportscastingasync_938969852.md index 47a25a08db..586fdcdc64 100644 --- a/windows.media.casting/castingdevice_deviceinfosupportscastingasync_938969852.md +++ b/windows.media.casting/castingdevice_deviceinfosupportscastingasync_938969852.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevice.DeviceInfoSupportsCastingAsync(Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- # Windows.Media.Casting.CastingDevice.DeviceInfoSupportsCastingAsync ## -description Indicates whether the given device (a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object) supports casting. ## -parameters ### -param device The device you want to know about. ## -returns True if the device supports casting; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevice.DeviceInfoSupportsCastingAsync(Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevice.DeviceInfoSupportsCastingAsync + +## -description +Indicates whether the given device (a [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object) supports casting. + +## -parameters +### -param device +The device you want to know about. + +## -returns +True if the device supports casting; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_friendlyname.md b/windows.media.casting/castingdevice_friendlyname.md index 380ebf1b6f..15f25f0b4d 100644 --- a/windows.media.casting/castingdevice_friendlyname.md +++ b/windows.media.casting/castingdevice_friendlyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevice.FriendlyName --api-type: winrt property ---- # Windows.Media.Casting.CastingDevice.FriendlyName ## -description A human-readable name for the device, retrieved from the device itself. ## -property-value The human-readable name for the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevice.FriendlyName +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevice.FriendlyName + +## -description +A human-readable name for the device, retrieved from the device itself. + +## -property-value +The human-readable name for the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_fromidasync_1322863552.md b/windows.media.casting/castingdevice_fromidasync_1322863552.md index 33a4f41f4a..3824d09571 100644 --- a/windows.media.casting/castingdevice_fromidasync_1322863552.md +++ b/windows.media.casting/castingdevice_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Media.Casting.CastingDevice.FromIdAsync ## -description Gets a [CastingDevice](castingdevice.md) object for a given a device ID (acquired from a query using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs). ## -parameters ### -param value The device ID. ## -returns The object representing the casting device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevice.FromIdAsync + +## -description +Gets a [CastingDevice](castingdevice.md) object for a given a device ID (acquired from a query using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs). + +## -parameters +### -param value +The device ID. + +## -returns +The object representing the casting device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_getdeviceselector_752356039.md b/windows.media.casting/castingdevice_getdeviceselector_752356039.md index 2cd47315ae..4736578595 100644 --- a/windows.media.casting/castingdevice_getdeviceselector_752356039.md +++ b/windows.media.casting/castingdevice_getdeviceselector_752356039.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevice.GetDeviceSelector(Windows.Media.Casting.CastingPlaybackTypes) --api-type: winrt method ---- # Windows.Media.Casting.CastingDevice.GetDeviceSelector ## -description Gets an AQS filter string to be used with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs for a given [CastingPlaybackTypes](castingplaybacktypes.md). ## -parameters ### -param type The casting playback type. ## -returns The AQS filter string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevice.GetDeviceSelector(Windows.Media.Casting.CastingPlaybackTypes) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevice.GetDeviceSelector + +## -description +Gets an AQS filter string to be used with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs for a given [CastingPlaybackTypes](castingplaybacktypes.md). + +## -parameters +### -param type +The casting playback type. + +## -returns +The AQS filter string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_getdeviceselectorfromcastingsourceasync_401766148.md b/windows.media.casting/castingdevice_getdeviceselectorfromcastingsourceasync_401766148.md index 9d1540517c..acdc653040 100644 --- a/windows.media.casting/castingdevice_getdeviceselectorfromcastingsourceasync_401766148.md +++ b/windows.media.casting/castingdevice_getdeviceselectorfromcastingsourceasync_401766148.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevice.GetDeviceSelectorFromCastingSourceAsync(Windows.Media.Casting.CastingSource) --api-type: winrt method ---- # Windows.Media.Casting.CastingDevice.GetDeviceSelectorFromCastingSourceAsync ## -description Gets an AQS filter string to be used with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs for a given [CastingSource](castingsource.md). ## -parameters ### -param castingSource The casting source. ## -returns The AQS filter string. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevice.GetDeviceSelectorFromCastingSourceAsync(Windows.Media.Casting.CastingSource) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevice.GetDeviceSelectorFromCastingSourceAsync + +## -description +Gets an AQS filter string to be used with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs for a given [CastingSource](castingsource.md). + +## -parameters +### -param castingSource +The casting source. + +## -returns +The AQS filter string. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_getsupportedcastingplaybacktypesasync_885447385.md b/windows.media.casting/castingdevice_getsupportedcastingplaybacktypesasync_885447385.md index 25a1b77660..b1770dc863 100644 --- a/windows.media.casting/castingdevice_getsupportedcastingplaybacktypesasync_885447385.md +++ b/windows.media.casting/castingdevice_getsupportedcastingplaybacktypesasync_885447385.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevice.GetSupportedCastingPlaybackTypesAsync --api-type: winrt method ---- # Windows.Media.Casting.CastingDevice.GetSupportedCastingPlaybackTypesAsync ## -description Gets the media types supported by the device. containing ## -returns The media types, [CastingPlaybackTypes](castingplaybacktypes.md), supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevice.GetSupportedCastingPlaybackTypesAsync +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevice.GetSupportedCastingPlaybackTypesAsync + +## -description +Gets the media types supported by the device. containing + +## -returns +The media types, [CastingPlaybackTypes](castingplaybacktypes.md), supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_icon.md b/windows.media.casting/castingdevice_icon.md index 6b36a00792..e3acf3d84f 100644 --- a/windows.media.casting/castingdevice_icon.md +++ b/windows.media.casting/castingdevice_icon.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevice.Icon --api-type: winrt property ---- # Windows.Media.Casting.CastingDevice.Icon ## -description An icon representing the device. ## -property-value The icon. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevice.Icon +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevice.Icon + +## -description +An icon representing the device. + +## -property-value +The icon. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevice_id.md b/windows.media.casting/castingdevice_id.md index 2c8b50e144..3420269b7b 100644 --- a/windows.media.casting/castingdevice_id.md +++ b/windows.media.casting/castingdevice_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevice.Id --api-type: winrt property ---- # Windows.Media.Casting.CastingDevice.Id ## -description The device ID. This is the same ID used with Windows.Devices.Enumeration APIs. ## -property-value The device's ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevice.Id +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevice.Id + +## -description +The device ID. This is the same ID used with Windows.Devices.Enumeration APIs. + +## -property-value +The device's ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker.md b/windows.media.casting/castingdevicepicker.md index 31cf921d62..5f2c68d7c4 100644 --- a/windows.media.casting/castingdevicepicker.md +++ b/windows.media.casting/castingdevicepicker.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Casting.CastingDevicePicker --api-type: winrt class ---- # Windows.Media.Casting.CastingDevicePicker ## -description Represents a device picker that contains a list of casting devices for the user to choose from. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingDevicePicker +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingDevicePicker + +## -description +Represents a device picker that contains a list of casting devices for the user to choose from. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_appearance.md b/windows.media.casting/castingdevicepicker_appearance.md index bad8274b58..60350a1bca 100644 --- a/windows.media.casting/castingdevicepicker_appearance.md +++ b/windows.media.casting/castingdevicepicker_appearance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevicePicker.Appearance --api-type: winrt property ---- # Windows.Media.Casting.CastingDevicePicker.Appearance ## -description Gets the colors of the picker UI. ## -property-value The appearance details of the picker UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevicePicker.Appearance +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevicePicker.Appearance + +## -description +Gets the colors of the picker UI. + +## -property-value +The appearance details of the picker UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_castingdevicepicker_1221375020.md b/windows.media.casting/castingdevicepicker_castingdevicepicker_1221375020.md index 4f3527946a..510f6cce39 100644 --- a/windows.media.casting/castingdevicepicker_castingdevicepicker_1221375020.md +++ b/windows.media.casting/castingdevicepicker_castingdevicepicker_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevicePicker.#ctor --api-type: winrt method ---- # Windows.Media.Casting.CastingDevicePicker.CastingDevicePicker ## -description Creates a [CastingDevicePicker](castingdevicepicker.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevicePicker.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevicePicker.CastingDevicePicker + +## -description +Creates a [CastingDevicePicker](castingdevicepicker.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_castingdevicepickerdismissed.md b/windows.media.casting/castingdevicepicker_castingdevicepickerdismissed.md index 4446d74d81..54f6c040ce 100644 --- a/windows.media.casting/castingdevicepicker_castingdevicepickerdismissed.md +++ b/windows.media.casting/castingdevicepicker_castingdevicepickerdismissed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Casting.CastingDevicePicker.CastingDevicePickerDismissed --api-type: winrt event ---- # Windows.Media.Casting.CastingDevicePicker.CastingDevicePickerDismissed ## -description Indicates that the user has dismissed the picker UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Casting.CastingDevicePicker.CastingDevicePickerDismissed +-api-type: winrt event +--- + + + +# Windows.Media.Casting.CastingDevicePicker.CastingDevicePickerDismissed + +## -description +Indicates that the user has dismissed the picker UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_castingdeviceselected.md b/windows.media.casting/castingdevicepicker_castingdeviceselected.md index 5a0f361e7d..e88ae5cb74 100644 --- a/windows.media.casting/castingdevicepicker_castingdeviceselected.md +++ b/windows.media.casting/castingdevicepicker_castingdeviceselected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Casting.CastingDevicePicker.CastingDeviceSelected --api-type: winrt event ---- # Windows.Media.Casting.CastingDevicePicker.CastingDeviceSelected ## -description Indicates that the user has selected a device from the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Casting.CastingDevicePicker.CastingDeviceSelected +-api-type: winrt event +--- + + + +# Windows.Media.Casting.CastingDevicePicker.CastingDeviceSelected + +## -description +Indicates that the user has selected a device from the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_filter.md b/windows.media.casting/castingdevicepicker_filter.md index 17132115b5..8c5fb34f4a 100644 --- a/windows.media.casting/castingdevicepicker_filter.md +++ b/windows.media.casting/castingdevicepicker_filter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevicePicker.Filter --api-type: winrt property ---- # Windows.Media.Casting.CastingDevicePicker.Filter ## -description Gets the filter information for which devices to show in the picker. ## -property-value The filter information. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevicePicker.Filter +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevicePicker.Filter + +## -description +Gets the filter information for which devices to show in the picker. + +## -property-value +The filter information. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_hide_1985563870.md b/windows.media.casting/castingdevicepicker_hide_1985563870.md index a9304c6145..64fddc7ad8 100644 --- a/windows.media.casting/castingdevicepicker_hide_1985563870.md +++ b/windows.media.casting/castingdevicepicker_hide_1985563870.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevicePicker.Hide --api-type: winrt method ---- # Windows.Media.Casting.CastingDevicePicker.Hide ## -description Hides the device picker UI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevicePicker.Hide +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevicePicker.Hide + +## -description +Hides the device picker UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepicker_show_8680471.md b/windows.media.casting/castingdevicepicker_show_8680471.md index 912e34aa77..74b0f08bc1 100644 --- a/windows.media.casting/castingdevicepicker_show_8680471.md +++ b/windows.media.casting/castingdevicepicker_show_8680471.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevicePicker.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.Media.Casting.CastingDevicePicker.Show ## -description Shows the casting device picker UI, which flies out from the specified edge of the provided rectangle. ## -parameters ### -param selection The rectangle from which the picker should fly out. ### -param preferredPlacement The edge of the rectangle from which the picker should fly out. ## -remarks ## -examples ## -see-also [Show(Rect)](castingdevicepicker_show_97155545.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevicePicker.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevicePicker.Show + +## -description +Shows the casting device picker UI, which flies out from the specified edge of the provided rectangle. + +## -parameters +### -param selection +The rectangle from which the picker should fly out. + +### -param preferredPlacement +The edge of the rectangle from which the picker should fly out. + +## -remarks + +## -examples + +## -see-also +[Show(Rect)](castingdevicepicker_show_97155545.md) \ No newline at end of file diff --git a/windows.media.casting/castingdevicepicker_show_97155545.md b/windows.media.casting/castingdevicepicker_show_97155545.md index be74bc3ac6..466989870b 100644 --- a/windows.media.casting/castingdevicepicker_show_97155545.md +++ b/windows.media.casting/castingdevicepicker_show_97155545.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Casting.CastingDevicePicker.Show(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Media.Casting.CastingDevicePicker.Show ## -description Shows the casting device picker UI, which flies out from an edge of the provided rectangle. ## -parameters ### -param selection The rectangle from which the picker UI should fly out. ## -remarks ## -examples ## -see-also [Show(Rect, Placement)](castingdevicepicker_show_8680471.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Casting.CastingDevicePicker.Show(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Media.Casting.CastingDevicePicker.Show + +## -description +Shows the casting device picker UI, which flies out from an edge of the provided rectangle. + +## -parameters +### -param selection +The rectangle from which the picker UI should fly out. + +## -remarks + +## -examples + +## -see-also +[Show(Rect, Placement)](castingdevicepicker_show_8680471.md) \ No newline at end of file diff --git a/windows.media.casting/castingdevicepickerfilter.md b/windows.media.casting/castingdevicepickerfilter.md index 9118234272..4286215ff1 100644 --- a/windows.media.casting/castingdevicepickerfilter.md +++ b/windows.media.casting/castingdevicepickerfilter.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Casting.CastingDevicePickerFilter --api-type: winrt class ---- # Windows.Media.Casting.CastingDevicePickerFilter ## -description Represents the filter used to determine which devices to show in a casting device picker UI. The filter parameters are OR-ed together to build the resulting filter. In other words, if [SupportsAudio](castingdevicepickerfilter_supportsaudio.md) and [SupportsVideo](castingdevicepickerfilter_supportsvideo.md) are both true, the picker will display Audio-only devices, video-only devices, and audio/video devices. ## -remarks Get an instance of this class by accessing the [CastingDevicePicker.Filter](castingdevicepicker_filter.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingDevicePickerFilter +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingDevicePickerFilter + +## -description +Represents the filter used to determine which devices to show in a casting device picker UI. The filter parameters are OR-ed together to build the resulting filter. In other words, if [SupportsAudio](castingdevicepickerfilter_supportsaudio.md) and [SupportsVideo](castingdevicepickerfilter_supportsvideo.md) are both true, the picker will display Audio-only devices, video-only devices, and audio/video devices. + +## -remarks +Get an instance of this class by accessing the [CastingDevicePicker.Filter](castingdevicepicker_filter.md) property. + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepickerfilter_supportedcastingsources.md b/windows.media.casting/castingdevicepickerfilter_supportedcastingsources.md index ec6585c3b7..dffaf1d469 100644 --- a/windows.media.casting/castingdevicepickerfilter_supportedcastingsources.md +++ b/windows.media.casting/castingdevicepickerfilter_supportedcastingsources.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportedCastingSources --api-type: winrt property ---- # Windows.Media.Casting.CastingDevicePickerFilter.SupportedCastingSources ## -description Gets the casting sources supported. ## -property-value The list of supported casting sources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportedCastingSources +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevicePickerFilter.SupportedCastingSources + +## -description +Gets the casting sources supported. + +## -property-value +The list of supported casting sources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepickerfilter_supportsaudio.md b/windows.media.casting/castingdevicepickerfilter_supportsaudio.md index 25dfad2576..fdcb63a3ea 100644 --- a/windows.media.casting/castingdevicepickerfilter_supportsaudio.md +++ b/windows.media.casting/castingdevicepickerfilter_supportsaudio.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportsAudio --api-type: winrt property ---- # Windows.Media.Casting.CastingDevicePickerFilter.SupportsAudio ## -description Gets and sets whether the devices in the device picker should support audio playback. ## -property-value If true, the picker will show audio-capable casting devices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportsAudio +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevicePickerFilter.SupportsAudio + +## -description +Gets and sets whether the devices in the device picker should support audio playback. + +## -property-value +If true, the picker will show audio-capable casting devices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepickerfilter_supportspictures.md b/windows.media.casting/castingdevicepickerfilter_supportspictures.md index cb9176e66b..c4534a0e48 100644 --- a/windows.media.casting/castingdevicepickerfilter_supportspictures.md +++ b/windows.media.casting/castingdevicepickerfilter_supportspictures.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportsPictures --api-type: winrt property ---- # Windows.Media.Casting.CastingDevicePickerFilter.SupportsPictures ## -description Gets and sets whether the devices in the device picker should support rending still images. ## -property-value If true, the picker will show casting devices capable of rendering still images. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportsPictures +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevicePickerFilter.SupportsPictures + +## -description +Gets and sets whether the devices in the device picker should support rending still images. + +## -property-value +If true, the picker will show casting devices capable of rendering still images. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdevicepickerfilter_supportsvideo.md b/windows.media.casting/castingdevicepickerfilter_supportsvideo.md index 03a72ea048..43a050ce4c 100644 --- a/windows.media.casting/castingdevicepickerfilter_supportsvideo.md +++ b/windows.media.casting/castingdevicepickerfilter_supportsvideo.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportsVideo --api-type: winrt property ---- # Windows.Media.Casting.CastingDevicePickerFilter.SupportsVideo ## -description Gets and sets whether the devices in the device picker should support video playback. ## -property-value If true, the picker will show video-capable casting devices. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDevicePickerFilter.SupportsVideo +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDevicePickerFilter.SupportsVideo + +## -description +Gets and sets whether the devices in the device picker should support video playback. + +## -property-value +If true, the picker will show video-capable casting devices. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdeviceselectedeventargs.md b/windows.media.casting/castingdeviceselectedeventargs.md index 2ab2673cdb..cc02154cc7 100644 --- a/windows.media.casting/castingdeviceselectedeventargs.md +++ b/windows.media.casting/castingdeviceselectedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Casting.CastingDeviceSelectedEventArgs --api-type: winrt class ---- # Windows.Media.Casting.CastingDeviceSelectedEventArgs ## -description Represents the event arguments for the [CastingDeviceSelected](castingdevicepicker_castingdeviceselected.md) event on the [CastingDevicePicker](castingdevicepicker.md) object. ## -remarks Get an instance of this class by handling the [CastingDeviceSelected](castingdevicepicker_castingdeviceselected.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingDeviceSelectedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingDeviceSelectedEventArgs + +## -description +Represents the event arguments for the [CastingDeviceSelected](castingdevicepicker_castingdeviceselected.md) event on the [CastingDevicePicker](castingdevicepicker.md) object. + +## -remarks +Get an instance of this class by handling the [CastingDeviceSelected](castingdevicepicker_castingdeviceselected.md) event. + +## -examples + +## -see-also diff --git a/windows.media.casting/castingdeviceselectedeventargs_selectedcastingdevice.md b/windows.media.casting/castingdeviceselectedeventargs_selectedcastingdevice.md index cafebe569e..a34dfd81b5 100644 --- a/windows.media.casting/castingdeviceselectedeventargs_selectedcastingdevice.md +++ b/windows.media.casting/castingdeviceselectedeventargs_selectedcastingdevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingDeviceSelectedEventArgs.SelectedCastingDevice --api-type: winrt property ---- # Windows.Media.Casting.CastingDeviceSelectedEventArgs.SelectedCastingDevice ## -description Represents the [CastingDevice](castingdevice.md) that has been selected by the user in a casting device picker. ## -property-value The casting device that the user has selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingDeviceSelectedEventArgs.SelectedCastingDevice +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingDeviceSelectedEventArgs.SelectedCastingDevice + +## -description +Represents the [CastingDevice](castingdevice.md) that has been selected by the user in a casting device picker. + +## -property-value +The casting device that the user has selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.casting/castingsource.md b/windows.media.casting/castingsource.md index aff702dab9..62c04f0177 100644 --- a/windows.media.casting/castingsource.md +++ b/windows.media.casting/castingsource.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Casting.CastingSource --api-type: winrt class ---- # Windows.Media.Casting.CastingSource ## -description Represents the media content that can be sent to another device. ## -remarks You can obtain this object from a [MediaPlayer](../windows.media.playback/mediaplayer.md), [Image](../windows.ui.xaml.controls/image.md), or HTML Tag by calling the respective [GetAsCastingSource](../windows.media.playback/mediaplayer_getascastingsource.md) method. In the current release, apps should use **MediaPlayer** and [MediaPlayerElement](../windows.ui.xaml.controls/mediaplayerelement.md) for media playback, but the legacy [MediaElement](../windows.ui.xaml.controls/mediaelement.md) control also provides a [GetAsCastingSource](../windows.ui.xaml.controls/mediaelement_getascastingsource.md) method. ## -examples ## -see-also [Image.GetAsCastingSource](../windows.ui.xaml.controls/image_getascastingsource.md), [MediaElement.GetAsCastingSource](../windows.ui.xaml.controls/mediaelement_getascastingsource.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Casting.CastingSource +-api-type: winrt class +--- + + + +# Windows.Media.Casting.CastingSource + +## -description +Represents the media content that can be sent to another device. + +## -remarks +You can obtain this object from a [MediaPlayer](../windows.media.playback/mediaplayer.md), [Image](../windows.ui.xaml.controls/image.md), or HTML Tag by calling the respective [GetAsCastingSource](../windows.media.playback/mediaplayer_getascastingsource.md) method. In the current release, apps should use **MediaPlayer** and [MediaPlayerElement](../windows.ui.xaml.controls/mediaplayerelement.md) for media playback, but the legacy [MediaElement](../windows.ui.xaml.controls/mediaelement.md) control also provides a [GetAsCastingSource](../windows.ui.xaml.controls/mediaelement_getascastingsource.md) method. + +## -examples + +## -see-also +[Image.GetAsCastingSource](../windows.ui.xaml.controls/image_getascastingsource.md), [MediaElement.GetAsCastingSource](../windows.ui.xaml.controls/mediaelement_getascastingsource.md) \ No newline at end of file diff --git a/windows.media.casting/castingsource_preferredsourceuri.md b/windows.media.casting/castingsource_preferredsourceuri.md index 680261f230..9815691fe7 100644 --- a/windows.media.casting/castingsource_preferredsourceuri.md +++ b/windows.media.casting/castingsource_preferredsourceuri.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Casting.CastingSource.PreferredSourceUri --api-type: winrt property ---- # Windows.Media.Casting.CastingSource.PreferredSourceUri ## -description Gets or sets an alternative URI for the content for use with DLNA ByRef. ## -property-value The alternative URI for the content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Casting.CastingSource.PreferredSourceUri +-api-type: winrt property +--- + + + +# Windows.Media.Casting.CastingSource.PreferredSourceUri + +## -description +Gets or sets an alternative URI for the content for use with DLNA ByRef. + +## -property-value +The alternative URI for the content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties.md b/windows.media.closedcaptioning/closedcaptionproperties.md index da29d656ec..1ea1abcc9a 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties.md +++ b/windows.media.closedcaptioning/closedcaptionproperties.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.ClosedCaptioning.ClosedCaptionProperties --api-type: winrt class ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties ## -description Exposes properties for retrieving the closed caption formatting settings that the user can set through the system's closed captioning settings page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.ClosedCaptioning.ClosedCaptionProperties +-api-type: winrt class +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties + +## -description +Exposes properties for retrieving the closed caption formatting settings that the user can set through the system's closed captioning settings page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_backgroundcolor.md b/windows.media.closedcaptioning/closedcaptionproperties_backgroundcolor.md index c7e61e27ef..21d1ad10f5 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_backgroundcolor.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_backgroundcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundColor --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundColor ## -description Gets the background color of lines of closed caption text. ## -property-value The background color of lines of closed caption text. ## -remarks This property represents the color behind the character glyphs within individual lines of text. The background of the entire closed caption region can be determined with the [RegionColor](closedcaptionproperties_regioncolor.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundColor +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundColor + +## -description +Gets the background color of lines of closed caption text. + +## -property-value +The background color of lines of closed caption text. + +## -remarks +This property represents the color behind the character glyphs within individual lines of text. The background of the entire closed caption region can be determined with the [RegionColor](closedcaptionproperties_regioncolor.md) property. + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_backgroundopacity.md b/windows.media.closedcaptioning/closedcaptionproperties_backgroundopacity.md index d535e5eb49..2c204ee65c 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_backgroundopacity.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_backgroundopacity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundOpacity --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundOpacity ## -description Gets the background opacity of lines of closed caption text. ## -property-value The background opacity of lines of closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundOpacity +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.BackgroundOpacity + +## -description +Gets the background opacity of lines of closed caption text. + +## -property-value +The background opacity of lines of closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_computedbackgroundcolor.md b/windows.media.closedcaptioning/closedcaptionproperties_computedbackgroundcolor.md index 9a77d13b5c..7fc3b0215d 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_computedbackgroundcolor.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_computedbackgroundcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedBackgroundColor --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedBackgroundColor ## -description Gets the computed background color of lines of closed caption text. ## -property-value The computed background color of lines of closed caption text. ## -remarks This property gets the background color computed by the system for optimal contrast. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedBackgroundColor +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedBackgroundColor + +## -description +Gets the computed background color of lines of closed caption text. + +## -property-value +The computed background color of lines of closed caption text. + +## -remarks +This property gets the background color computed by the system for optimal contrast. + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_computedfontcolor.md b/windows.media.closedcaptioning/closedcaptionproperties_computedfontcolor.md index 0968b7b24c..c4b6f5d2d5 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_computedfontcolor.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_computedfontcolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedFontColor --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedFontColor ## -description Gets the computed font color for closed caption text. ## -property-value The computed font color for closed caption text. ## -remarks This property gets the font color computed by the system for optimal contrast. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedFontColor +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedFontColor + +## -description +Gets the computed font color for closed caption text. + +## -property-value +The computed font color for closed caption text. + +## -remarks +This property gets the font color computed by the system for optimal contrast. + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_computedregioncolor.md b/windows.media.closedcaptioning/closedcaptionproperties_computedregioncolor.md index d5ad61f418..6b73b41c9d 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_computedregioncolor.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_computedregioncolor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedRegionColor --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedRegionColor ## -description Gets the computed region color for closed caption text. ## -property-value The computed region color for closed caption text. ## -remarks This property gets the region color computed by the system for optimal contrast. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedRegionColor +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.ComputedRegionColor + +## -description +Gets the computed region color for closed caption text. + +## -property-value +The computed region color for closed caption text. + +## -remarks +This property gets the region color computed by the system for optimal contrast. + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_fontcolor.md b/windows.media.closedcaptioning/closedcaptionproperties_fontcolor.md index 78970225ef..686432e7e3 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_fontcolor.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_fontcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontColor --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontColor ## -description Gets the font color for closed caption text. ## -property-value The font color for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontColor +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontColor + +## -description +Gets the font color for closed caption text. + +## -property-value +The font color for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_fonteffect.md b/windows.media.closedcaptioning/closedcaptionproperties_fonteffect.md index e1299c4054..00c0af6fe5 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_fonteffect.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_fonteffect.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontEffect --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontEffect ## -description Gets the font effect for closed caption text. ## -property-value The font effect for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontEffect +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontEffect + +## -description +Gets the font effect for closed caption text. + +## -property-value +The font effect for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_fontopacity.md b/windows.media.closedcaptioning/closedcaptionproperties_fontopacity.md index d0c87b83d5..d7bc7ba3eb 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_fontopacity.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_fontopacity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontOpacity --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontOpacity ## -description Gets the font opacity for closed caption text. ## -property-value The font opacity for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontOpacity +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontOpacity + +## -description +Gets the font opacity for closed caption text. + +## -property-value +The font opacity for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_fontsize.md b/windows.media.closedcaptioning/closedcaptionproperties_fontsize.md index 5d520c76e3..a8fafa26b9 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_fontsize.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_fontsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontSize --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontSize ## -description Gets the font size for closed caption text. ## -property-value The font size for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontSize +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontSize + +## -description +Gets the font size for closed caption text. + +## -property-value +The font size for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_fontstyle.md b/windows.media.closedcaptioning/closedcaptionproperties_fontstyle.md index 37d0d66dbf..7bf4a87cda 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_fontstyle.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_fontstyle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontStyle --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontStyle ## -description Gets the font style for closed caption text. ## -property-value The font style for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontStyle +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.FontStyle + +## -description +Gets the font style for closed caption text. + +## -property-value +The font style for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_regioncolor.md b/windows.media.closedcaptioning/closedcaptionproperties_regioncolor.md index ca482ce97c..fd4e00bb0b 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_regioncolor.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_regioncolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionColor --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionColor ## -description Gets the region color for closed caption text. ## -property-value The region color for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionColor +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionColor + +## -description +Gets the region color for closed caption text. + +## -property-value +The region color for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.closedcaptioning/closedcaptionproperties_regionopacity.md b/windows.media.closedcaptioning/closedcaptionproperties_regionopacity.md index 682df55373..f5b18eae9e 100644 --- a/windows.media.closedcaptioning/closedcaptionproperties_regionopacity.md +++ b/windows.media.closedcaptioning/closedcaptionproperties_regionopacity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionOpacity --api-type: winrt property ---- # Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionOpacity ## -description Gets the region opacity for closed caption text. ## -property-value The region opacity for closed caption text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionOpacity +-api-type: winrt property +--- + + + +# Windows.Media.ClosedCaptioning.ClosedCaptionProperties.RegionOpacity + +## -description +Gets the region opacity for closed caption text. + +## -property-value +The region opacity for closed caption text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy.md b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy.md index 30b04a2234..cad057a097 100644 --- a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy.md +++ b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy --api-type: winrt class ---- # Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy ## -description Contains information used to filter an app's content catalog. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy +-api-type: winrt class +--- + + + +# Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy + +## -description +Contains information used to filter an app's content catalog. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_geographicregion.md b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_geographicregion.md index 4dfa2a94dc..713cec3d3c 100644 --- a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_geographicregion.md +++ b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_geographicregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.GeographicRegion --api-type: winrt property ---- # Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.GeographicRegion ## -description Gets the region of the user's content restrictions. ## -property-value A [String](https://msdn.microsoft.com/library/system.string.aspx), representing the geographic region. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.GeographicRegion +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.GeographicRegion + +## -description +Gets the region of the user's content restrictions. + +## -property-value +A [String](https://msdn.microsoft.com/library/system.string.aspx), representing the geographic region. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_maxbrowsableagerating.md b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_maxbrowsableagerating.md index 0afe572b96..4b650c6996 100644 --- a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_maxbrowsableagerating.md +++ b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_maxbrowsableagerating.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.MaxBrowsableAgeRating --api-type: winrt property ---- # Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.MaxBrowsableAgeRating ## -description Gets the maximum allowed age rating level to show in a content catalog. No content rated above this level should be displayed. For example, if the **MaxBrowsableAgeRating** is 13, MPAA:R rated movies should not be displayed. ## -property-value An integer, that represents an age. ## -remarks If user doesn’t have any content restrictions enforced by Family Safety, the return value is NULL. The app is still expected to call [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) for every piece of content a user is trying to use. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.MaxBrowsableAgeRating +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.MaxBrowsableAgeRating + +## -description +Gets the maximum allowed age rating level to show in a content catalog. No content rated above this level should be displayed. For example, if the **MaxBrowsableAgeRating** is 13, MPAA:R rated movies should not be displayed. + +## -property-value +An integer, that represents an age. + +## -remarks +If user doesn’t have any content restrictions enforced by Family Safety, the return value is NULL. The app is still expected to call [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) for every piece of content a user is trying to use. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_preferredagerating.md b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_preferredagerating.md index 38ccdc1760..f26adffce2 100644 --- a/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_preferredagerating.md +++ b/windows.media.contentrestrictions/contentrestrictionsbrowsepolicy_preferredagerating.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.PreferredAgeRating --api-type: winrt property ---- # Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.PreferredAgeRating ## -description Gets the maximum allowed rating level for content consumption. ## -property-value An integer that represents the rating level. ## -remarks Apps may choose to tailor their content catalog based on this value. For example, an app may show more movies appropriate for young children to a user whose preferred rating is 6, even though the user’s maximum allowed browse rating may be 12. If user doesn’t have any content restrictions enforced by Family Safety the return value is NULL. The app is still expected to call [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) for every piece of content a user is trying to use. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.PreferredAgeRating +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.ContentRestrictionsBrowsePolicy.PreferredAgeRating + +## -description +Gets the maximum allowed rating level for content consumption. + +## -property-value +An integer that represents the rating level. + +## -remarks +Apps may choose to tailor their content catalog based on this value. For example, an app may show more movies appropriate for young children to a user whose preferred rating is 6, even though the user’s maximum allowed browse rating may be 12. + +If user doesn’t have any content restrictions enforced by Family Safety the return value is NULL. The app is still expected to call [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) for every piece of content a user is trying to use. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentdescription.md b/windows.media.contentrestrictions/ratedcontentdescription.md index 415a7d90ba..260fc86763 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription.md +++ b/windows.media.contentrestrictions/ratedcontentdescription.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.ContentRestrictions.RatedContentDescription --api-type: winrt class ---- # Windows.Media.ContentRestrictions.RatedContentDescription ## -description Contains information about a piece of content. An app creates a **RatedContentDescription** object, for each piece of content to be used in the [GetRestrictionLevelAsync](ratedcontentrestrictions_getrestrictionlevelasync.md) and [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) methods. ## -remarks If a piece of content doesn't have a 3rd-party rating, nor a Store age rating, the app must pass NULL as the rating. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.ContentRestrictions.RatedContentDescription +-api-type: winrt class +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription + +## -description +Contains information about a piece of content. An app creates a **RatedContentDescription** object, for each piece of content to be used in the [GetRestrictionLevelAsync](ratedcontentrestrictions_getrestrictionlevelasync.md) and [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) methods. + +## -remarks +If a piece of content doesn't have a 3rd-party rating, nor a Store age rating, the app must pass NULL as the rating. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentdescription_category.md b/windows.media.contentrestrictions/ratedcontentdescription_category.md index 2b3a4ffc54..7261ae989c 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_category.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_category.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Category --api-type: winrt property ---- # Windows.Media.ContentRestrictions.RatedContentDescription.Category ## -description Specifies the type of a piece of content, defined by [RatedContentCategory](ratedcontentcategory.md). ## -property-value Specifies the type of a piece of content, defined by [RatedContentCategory](ratedcontentcategory.md). ## -remarks Returns E_INVALIDARG, if an invalid value is provided. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Category +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.Category + +## -description +Specifies the type of a piece of content, defined by [RatedContentCategory](ratedcontentcategory.md). + +## -property-value +Specifies the type of a piece of content, defined by [RatedContentCategory](ratedcontentcategory.md). + +## -remarks +Returns E_INVALIDARG, if an invalid value is provided. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentdescription_id.md b/windows.media.contentrestrictions/ratedcontentdescription_id.md index 74dd02201e..17d5d186d6 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_id.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_id.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Id --api-type: winrt property ---- # Windows.Media.ContentRestrictions.RatedContentDescription.Id ## -description The unique content ID of a piece of content, in the app's content catalog. ## -property-value The ID of the content as a string. ## -remarks The ID must be a length between 1 and 100 characters, and can't be empty or contain only spaces. Returns E_INVALIDARG, if an invalid value is provided. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Id +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.Id + +## -description +The unique content ID of a piece of content, in the app's content catalog. + +## -property-value +The ID of the content as a string. + +## -remarks +The ID must be a length between 1 and 100 characters, and can't be empty or contain only spaces. + +Returns E_INVALIDARG, if an invalid value is provided. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentdescription_image.md b/windows.media.contentrestrictions/ratedcontentdescription_image.md index 3f4da656fb..c1fd41f544 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_image.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_image.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Image --api-type: winrt property ---- # Windows.Media.ContentRestrictions.RatedContentDescription.Image ## -description The thumbnail image associated with the content. ## -property-value An image associated with the content. ## -remarks Accepted image formats are JPEG, BMP, and PNG. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Image +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.Image + +## -description +The thumbnail image associated with the content. + +## -property-value +An image associated with the content. + +## -remarks +Accepted image formats are JPEG, BMP, and PNG. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentdescription_ratedcontentdescription_655575580.md b/windows.media.contentrestrictions/ratedcontentdescription_ratedcontentdescription_655575580.md index 0abef775b3..d58128e22c 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_ratedcontentdescription_655575580.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_ratedcontentdescription_655575580.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.ContentRestrictions.RatedContentDescription.#ctor(System.String,System.String,Windows.Media.ContentRestrictions.RatedContentCategory) --api-type: winrt method ---- # Windows.Media.ContentRestrictions.RatedContentDescription.RatedContentDescription ## -description Initializes a new instance of the **RatedContentDescription** class. ## -parameters ### -param id The ID of the content, as specified by the app developer. ### -param title The title of the content. ### -param category Specifies the type of a piece of content, defined by [RatedContentCategory](ratedcontentcategory.md). ## -remarks Returns E_INVALIDARG, if an invalid value is provided. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.ContentRestrictions.RatedContentDescription.#ctor(System.String,System.String,Windows.Media.ContentRestrictions.RatedContentCategory) +-api-type: winrt method +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.RatedContentDescription + +## -description +Initializes a new instance of the **RatedContentDescription** class. + +## -parameters +### -param id +The ID of the content, as specified by the app developer. + +### -param title +The title of the content. + +### -param category +Specifies the type of a piece of content, defined by [RatedContentCategory](ratedcontentcategory.md). + +## -remarks +Returns E_INVALIDARG, if an invalid value is provided. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentdescription_ratings.md b/windows.media.contentrestrictions/ratedcontentdescription_ratings.md index 7dc05c1e12..931e5e66b8 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_ratings.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_ratings.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Ratings --api-type: winrt property ---- # Windows.Media.ContentRestrictions.RatedContentDescription.Ratings ## -description Provides all existing third-party and Windows Store age ratings for a piece of content. ## -property-value Specifies the age rating, for a piece of content. ## -remarks If a piece of content doesn’t have neither a third-party rating nor a Store age rating, the app must pass NULL as the rating. If NULL rating is provided, the [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. Family Safety uses the [ContentRestrictionBrowsePolicy.GeographicRegion](contentrestrictionsbrowsepolicy_geographicregion.md) and [RatedContentDescription.Category](ratedcontentdescription_category.md) properties, to determine the appropriate rating system for a piece of content. If contain a rating value in this rating system, then it’s used as the content rating. If don’t contain value in this rating system, the Store age rating value is used. If it’s not available, the content is considered Not rated, for the Family Safety content settings region, and [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. For more info, see [Using content ratings](XREF:TODO:m_media.using_content_ratings). ## -examples ## -see-also [Using content ratings](XREF:TODO:m_media.using_content_ratings), [Store age ratings](XREF:TODO:m_media.store_age_ratings) \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Ratings +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.Ratings + +## -description +Provides all existing third-party and Windows Store age ratings for a piece of content. + + + +## -property-value +Specifies the age rating, for a piece of content. + +## -remarks +If a piece of content doesn’t have neither a third-party rating nor a Store age rating, the app must pass NULL as the rating. If NULL rating is provided, the [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. + +Family Safety uses the [ContentRestrictionBrowsePolicy.GeographicRegion](contentrestrictionsbrowsepolicy_geographicregion.md) and [RatedContentDescription.Category](ratedcontentdescription_category.md) properties, to determine the appropriate rating system for a piece of content. If contain a rating value in this rating system, then it’s used as the content rating. If don’t contain value in this rating system, the Store age rating value is used. If it’s not available, the content is considered Not rated, for the Family Safety content settings region, and [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. For more info, see [Using content ratings](XREF:TODO:m_media.using_content_ratings). + +## -examples + +## -see-also +[Using content ratings](XREF:TODO:m_media.using_content_ratings), [Store age ratings](XREF:TODO:m_media.store_age_ratings) \ No newline at end of file diff --git a/windows.media.contentrestrictions/ratedcontentdescription_title.md b/windows.media.contentrestrictions/ratedcontentdescription_title.md index 625beb790b..9158f324f5 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_title.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_title.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Title --api-type: winrt property ---- # Windows.Media.ContentRestrictions.RatedContentDescription.Title ## -description The display title of a piece of content. ## -property-value The title of the content as a string. Read/Write. ## -remarks The ID must be a length between 1 and 100 characters, and can't be empty or contain only spaces. Returns E_INVALIDARG, if an invalid value is provided. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Title +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.Title + +## -description +The display title of a piece of content. + +## -property-value +The title of the content as a string. Read/Write. + +## -remarks +The ID must be a length between 1 and 100 characters, and can't be empty or contain only spaces. + +Returns E_INVALIDARG, if an invalid value is provided. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions.md b/windows.media.contentrestrictions/ratedcontentrestrictions.md index bd6b39b6df..2f8c541d50 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.ContentRestrictions.RatedContentRestrictions --api-type: winrt class ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions ## -description Contains all behavior and functionality related to a user's Family Safety content settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.ContentRestrictions.RatedContentRestrictions +-api-type: winrt class +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions + +## -description +Contains all behavior and functionality related to a user's Family Safety content settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions_getbrowsepolicyasync_869444388.md b/windows.media.contentrestrictions/ratedcontentrestrictions_getbrowsepolicyasync_869444388.md index 0a1dfb92d5..bcb8831d5a 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions_getbrowsepolicyasync_869444388.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions_getbrowsepolicyasync_869444388.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.GetBrowsePolicyAsync --api-type: winrt method ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions.GetBrowsePolicyAsync ## -description Gets information that is used filter an app's content catalog. ## -returns Returns a [ContentRestrictionsBrowsePolicy](contentrestrictionsbrowsepolicy.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.GetBrowsePolicyAsync +-api-type: winrt method +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions.GetBrowsePolicyAsync + +## -description +Gets information that is used filter an app's content catalog. + +## -returns +Returns a [ContentRestrictionsBrowsePolicy](contentrestrictionsbrowsepolicy.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions_getrestrictionlevelasync_1038888445.md b/windows.media.contentrestrictions/ratedcontentrestrictions_getrestrictionlevelasync_1038888445.md index b79f31a06d..88473ee559 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions_getrestrictionlevelasync_1038888445.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions_getrestrictionlevelasync_1038888445.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.GetRestrictionLevelAsync(Windows.Media.ContentRestrictions.RatedContentDescription) --api-type: winrt method ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions.GetRestrictionLevelAsync ## -description Gets the policy that applies to a piece of content, for content browsing and consumption. ## -parameters ### -param RatedContentDescription The rated content info. ## -returns This method returns these values: + **Allow**– The content can be shown in the app's catalog, and is allowed for consumption by [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md). + **Block**– The content can be shown in the app’s catalog, but it’s consumption is not allowed by [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md). + **Hide**– The content can’t be shown in the catalog, since its rating is higher than [MaxBrowsableAgeRating](contentrestrictionsbrowsepolicy_maxbrowsableagerating.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.GetRestrictionLevelAsync(Windows.Media.ContentRestrictions.RatedContentDescription) +-api-type: winrt method +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions.GetRestrictionLevelAsync + +## -description +Gets the policy that applies to a piece of content, for content browsing and consumption. + +## -parameters +### -param RatedContentDescription +The rated content info. + +## -returns + +This method returns these values: + ++ **Allow**– The content can be shown in the app's catalog, and is allowed for consumption by [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md). ++ **Block**– The content can be shown in the app’s catalog, but it’s consumption is not allowed by [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md). ++ **Hide**– The content can’t be shown in the catalog, since its rating is higher than [MaxBrowsableAgeRating](contentrestrictionsbrowsepolicy_maxbrowsableagerating.md). + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_1221375020.md b/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_1221375020.md index 06ede4a34a..181e4ef0e6 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_1221375020.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.#ctor --api-type: winrt method ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions.RatedContentRestrictions ## -description Initializes a new instance of the **RatedContentRestrictions** class. ## -remarks ## -examples ## -see-also [RatedContentRestrictions(UInt32)](ratedcontentrestrictions_ratedcontentrestrictions_885572907.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions.RatedContentRestrictions + +## -description +Initializes a new instance of the **RatedContentRestrictions** class. + +## -remarks + +## -examples + +## -see-also +[RatedContentRestrictions(UInt32)](ratedcontentrestrictions_ratedcontentrestrictions_885572907.md) \ No newline at end of file diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_885572907.md b/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_885572907.md index 1cc89eec76..291fdcc44b 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_885572907.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions_ratedcontentrestrictions_885572907.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.#ctor(System.UInt32) --api-type: winrt method ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions.RatedContentRestrictions ## -description Initializes a new instance of the **RatedContentRestrictions** class, with the specified age rating the app uses, to restrict content usage. ## -parameters ### -param maxAgeRating The max age rating. ## -remarks Restrictions are enforced based on the minimum user’s overall Family Safety age rating (expressed by [PreferredAgeRating](contentrestrictionsbrowsepolicy_preferredagerating.md)), and the app-specific age rating value used in this constructor. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions.RatedContentRestrictions + +## -description +Initializes a new instance of the **RatedContentRestrictions** class, with the specified age rating the app uses, to restrict content usage. + +## -parameters +### -param maxAgeRating +The max age rating. + +## -remarks +Restrictions are enforced based on the minimum user’s overall Family Safety age rating (expressed by [PreferredAgeRating](contentrestrictionsbrowsepolicy_preferredagerating.md)), and the app-specific age rating value used in this constructor. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions_requestcontentaccessasync_637668410.md b/windows.media.contentrestrictions/ratedcontentrestrictions_requestcontentaccessasync_637668410.md index 9bd7755cbb..d477deca7b 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions_requestcontentaccessasync_637668410.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions_requestcontentaccessasync_637668410.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.RequestContentAccessAsync(Windows.Media.ContentRestrictions.RatedContentDescription) --api-type: winrt method ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions.RequestContentAccessAsync ## -description Determines whether the user is allowed to consume a piece of content. ## -parameters ### -param RatedContentDescription The rated content info. ## -returns Returns true, if the user can consume the content. Otherwise, returns false. ## -remarks If the content is not allowed, this method will display a **Content blocked by Family Safety** dialog with options to request a parental override. Apps are expected to take no action if this method returns false. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.ContentRestrictions.RatedContentRestrictions.RequestContentAccessAsync(Windows.Media.ContentRestrictions.RatedContentDescription) +-api-type: winrt method +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions.RequestContentAccessAsync + +## -description +Determines whether the user is allowed to consume a piece of content. + +## -parameters +### -param RatedContentDescription +The rated content info. + +## -returns +Returns true, if the user can consume the content. Otherwise, returns false. + +## -remarks +If the content is not allowed, this method will display a **Content blocked by Family Safety** dialog with options to request a parental override. Apps are expected to take no action if this method returns false. + +## -examples + +## -see-also diff --git a/windows.media.contentrestrictions/ratedcontentrestrictions_restrictionschanged.md b/windows.media.contentrestrictions/ratedcontentrestrictions_restrictionschanged.md index 1ec88b5994..8b66fd907d 100644 --- a/windows.media.contentrestrictions/ratedcontentrestrictions_restrictionschanged.md +++ b/windows.media.contentrestrictions/ratedcontentrestrictions_restrictionschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.ContentRestrictions.RatedContentRestrictions.RestrictionsChanged --api-type: winrt event ---- # Windows.Media.ContentRestrictions.RatedContentRestrictions.RestrictionsChanged ## -description An event handler to notify apps when there are changes to the user's content settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.ContentRestrictions.RatedContentRestrictions.RestrictionsChanged +-api-type: winrt event +--- + + + +# Windows.Media.ContentRestrictions.RatedContentRestrictions.RestrictionsChanged + +## -description +An event handler to notify apps when there are changes to the user's content settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiostreamdescriptor.md b/windows.media.core/audiostreamdescriptor.md index ee714d7b27..75014793b1 100644 --- a/windows.media.core/audiostreamdescriptor.md +++ b/windows.media.core/audiostreamdescriptor.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.AudioStreamDescriptor --api-type: winrt class ---- # Windows.Media.Core.AudioStreamDescriptor ## -description Defines an audio media stream. ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [IMediaStreamDescriptor](imediastreamdescriptor.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.AudioStreamDescriptor +-api-type: winrt class +--- + + + +# Windows.Media.Core.AudioStreamDescriptor + +## -description +Defines an audio media stream. + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[IMediaStreamDescriptor](imediastreamdescriptor.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/audiostreamdescriptor_audiostreamdescriptor_1644654608.md b/windows.media.core/audiostreamdescriptor_audiostreamdescriptor_1644654608.md index 4efd198701..039a3a927f 100644 --- a/windows.media.core/audiostreamdescriptor_audiostreamdescriptor_1644654608.md +++ b/windows.media.core/audiostreamdescriptor_audiostreamdescriptor_1644654608.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.AudioStreamDescriptor.#ctor(Windows.Media.MediaProperties.AudioEncodingProperties) --api-type: winrt method ---- # Windows.Media.Core.AudioStreamDescriptor.AudioStreamDescriptor ## -description Creates an instance of [AudioStreamDescriptor](audiostreamdescriptor.md) class using the specified [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md). ## -parameters ### -param encodingProperties The encoding properties for the audio stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.AudioStreamDescriptor.#ctor(Windows.Media.MediaProperties.AudioEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.AudioStreamDescriptor + +## -description +Creates an instance of [AudioStreamDescriptor](audiostreamdescriptor.md) class using the specified [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md). + +## -parameters +### -param encodingProperties +The encoding properties for the audio stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiostreamdescriptor_encodingproperties.md b/windows.media.core/audiostreamdescriptor_encodingproperties.md index ee9895e909..74ba495619 100644 --- a/windows.media.core/audiostreamdescriptor_encodingproperties.md +++ b/windows.media.core/audiostreamdescriptor_encodingproperties.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Core.AudioStreamDescriptor.EncodingProperties --api-type: winrt property ---- # Windows.Media.Core.AudioStreamDescriptor.EncodingProperties ## -description The encoding properties of the stream. ## -property-value Describes the format of the audio stream. ## -remarks The application can change the encoding properties of the audio stream descriptor at any time. If the media pipeline cannot handle the new encoding properties, the [MediaStreamSource](mediastreamsource.md) will raise the [Closed](mediastreamsource_closed.md) event which provides information regarding the error. ## -examples ## -see-also [AudioEncodingProperties](../windows.media.mediaproperties/imediaencodingproperties.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.EncodingProperties + +## -description +The encoding properties of the stream. + +## -property-value +Describes the format of the audio stream. + +## -remarks +The application can change the encoding properties of the audio stream descriptor at any time. + +If the media pipeline cannot handle the new encoding properties, the [MediaStreamSource](mediastreamsource.md) will raise the [Closed](mediastreamsource_closed.md) event which provides information regarding the error. + +## -examples + +## -see-also +[AudioEncodingProperties](../windows.media.mediaproperties/imediaencodingproperties.md) \ No newline at end of file diff --git a/windows.media.core/audiostreamdescriptor_isselected.md b/windows.media.core/audiostreamdescriptor_isselected.md index 58d1250f35..465ded1c9e 100644 --- a/windows.media.core/audiostreamdescriptor_isselected.md +++ b/windows.media.core/audiostreamdescriptor_isselected.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.AudioStreamDescriptor.IsSelected --api-type: winrt property ---- # Windows.Media.Core.AudioStreamDescriptor.IsSelected ## -description Specifies whether the stream is currently in use by the [MediaStreamSource](mediastreamsource.md). ## -property-value **true** if the stream is currently in use by the [MediaStreamSource](mediastreamsource.md); otherwise, **false**. ## -remarks [IsSelected](audiostreamdescriptor_isselected.md) is **true** if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the [MediaStreamSource](mediastreamsource.md). Otherwise, the value is **false**. The [MediaStreamSource](mediastreamsource.md) only raises the [SampleRequested](mediastreamsource_samplerequested.md) event for streams which are selected. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.IsSelected +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.IsSelected + +## -description +Specifies whether the stream is currently in use by the [MediaStreamSource](mediastreamsource.md). + +## -property-value +**true** if the stream is currently in use by the [MediaStreamSource](mediastreamsource.md); otherwise, **false**. + +## -remarks +[IsSelected](audiostreamdescriptor_isselected.md) is **true** if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the [MediaStreamSource](mediastreamsource.md). Otherwise, the value is **false**. + +The [MediaStreamSource](mediastreamsource.md) only raises the [SampleRequested](mediastreamsource_samplerequested.md) event for streams which are selected. + +## -examples + +## -see-also diff --git a/windows.media.core/audiostreamdescriptor_language.md b/windows.media.core/audiostreamdescriptor_language.md index a793a4be9d..a2c84f6c5d 100644 --- a/windows.media.core/audiostreamdescriptor_language.md +++ b/windows.media.core/audiostreamdescriptor_language.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Core.AudioStreamDescriptor.Language --api-type: winrt property ---- # Windows.Media.Core.AudioStreamDescriptor.Language ## -description Gets or sets the RFC-1766 language code for the stream. ## -property-value The RFC-1766 language code for the stream. ## -remarks The initial value is an empty string. The language is specified using a RFC-1766 language code, for example, “en-US”. For more info on RFC-1766 language tags, see the [RFC-1766 specification](http://go.microsoft.com/fwlink/p/?LinkID=324766). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.Language + +## -description +Gets or sets the RFC-1766 language code for the stream. + +## -property-value +The RFC-1766 language code for the stream. + +## -remarks +The initial value is an empty string. + +The language is specified using a RFC-1766 language code, for example, “en-US”. + +For more info on RFC-1766 language tags, see the [RFC-1766 specification](http://go.microsoft.com/fwlink/p/?LinkID=324766). + +## -examples + +## -see-also diff --git a/windows.media.core/audiostreamdescriptor_leadingencoderpadding.md b/windows.media.core/audiostreamdescriptor_leadingencoderpadding.md index 69cfe37020..833393d256 100644 --- a/windows.media.core/audiostreamdescriptor_leadingencoderpadding.md +++ b/windows.media.core/audiostreamdescriptor_leadingencoderpadding.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioStreamDescriptor.LeadingEncoderPadding --api-type: winrt property ---- # Windows.Media.Core.AudioStreamDescriptor.LeadingEncoderPadding ## -description Gets or sets the number of samples inserted at the beginning of the audio stream by the encoder as padding. Use this property to explicitly set the padding size the system will use to implement gapless playback for the audio stream. ## -property-value The number of samples inserted at the beginning of the audio stream by the encoder as padding. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.LeadingEncoderPadding +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.LeadingEncoderPadding + +## -description +Gets or sets the number of samples inserted at the beginning of the audio stream by the encoder as padding. Use this property to explicitly set the padding size the system will use to implement gapless playback for the audio stream. + +## -property-value +The number of samples inserted at the beginning of the audio stream by the encoder as padding. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiostreamdescriptor_name.md b/windows.media.core/audiostreamdescriptor_name.md index e1e7a1ab48..f787e29bb9 100644 --- a/windows.media.core/audiostreamdescriptor_name.md +++ b/windows.media.core/audiostreamdescriptor_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.AudioStreamDescriptor.Name --api-type: winrt property ---- # Windows.Media.Core.AudioStreamDescriptor.Name ## -description Gets or sets the name of the stream. ## -property-value The name of the stream. ## -remarks The initial value is an empty string. The name is a free-form human readable string that describes the stream, for example, “English soundtrack”. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.Name + +## -description +Gets or sets the name of the stream. + +## -property-value +The name of the stream. + +## -remarks +The initial value is an empty string. + +The name is a free-form human readable string that describes the stream, for example, “English soundtrack”. + +## -examples + +## -see-also diff --git a/windows.media.core/audiostreamdescriptor_trailingencoderpadding.md b/windows.media.core/audiostreamdescriptor_trailingencoderpadding.md index bcb2a6c95f..128185bbdc 100644 --- a/windows.media.core/audiostreamdescriptor_trailingencoderpadding.md +++ b/windows.media.core/audiostreamdescriptor_trailingencoderpadding.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioStreamDescriptor.TrailingEncoderPadding --api-type: winrt property ---- # Windows.Media.Core.AudioStreamDescriptor.TrailingEncoderPadding ## -description Gets or sets the number of samples inserted at the end of the audio stream by the encoder as padding. Use this property to explicitly set the padding size the system will use to implement gapless playback for the audio stream. ## -property-value The number of samples inserted at the end of the audio stream by the encoder as padding. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.TrailingEncoderPadding +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.TrailingEncoderPadding + +## -description +Gets or sets the number of samples inserted at the end of the audio stream by the encoder as padding. Use this property to explicitly set the padding size the system will use to implement gapless playback for the audio stream. + +## -property-value +The number of samples inserted at the end of the audio stream by the encoder as padding. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack.md b/windows.media.core/audiotrack.md index b8d6a39859..0fbccd0c68 100644 --- a/windows.media.core/audiotrack.md +++ b/windows.media.core/audiotrack.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.AudioTrack --api-type: winrt class ---- # Windows.Media.Core.AudioTrack ## -description Represents an audio track. ## -remarks Get an instance of this class by calling [MediaPlaybackAudioTrackList.GetAt](../windows.media.playback/mediaplaybackaudiotracklist_getat.md). ## -examples ## -see-also [IMediaTrack](imediatrack.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.AudioTrack +-api-type: winrt class +--- + + + +# Windows.Media.Core.AudioTrack + +## -description +Represents an audio track. + +## -remarks +Get an instance of this class by calling [MediaPlaybackAudioTrackList.GetAt](../windows.media.playback/mediaplaybackaudiotracklist_getat.md). + +## -examples + +## -see-also +[IMediaTrack](imediatrack.md) \ No newline at end of file diff --git a/windows.media.core/audiotrack_getencodingproperties_1326279402.md b/windows.media.core/audiotrack_getencodingproperties_1326279402.md index 79fc40cd61..aed157fb1b 100644 --- a/windows.media.core/audiotrack_getencodingproperties_1326279402.md +++ b/windows.media.core/audiotrack_getencodingproperties_1326279402.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Core.AudioTrack.GetEncodingProperties --api-type: winrt method ---- # Windows.Media.Core.AudioTrack.GetEncodingProperties ## -description Gets the audio encoding properties for an [AudioTrack](audiotrack.md). ## -returns The audio encoding properties of the [AudioTrack](audiotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.AudioTrack.GetEncodingProperties +-api-type: winrt method +--- + + + +# Windows.Media.Core.AudioTrack.GetEncodingProperties + +## -description +Gets the audio encoding properties for an [AudioTrack](audiotrack.md). + +## -returns +The audio encoding properties of the [AudioTrack](audiotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_id.md b/windows.media.core/audiotrack_id.md index 5cb4fd4230..11eba77989 100644 --- a/windows.media.core/audiotrack_id.md +++ b/windows.media.core/audiotrack_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.Id --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.Id ## -description Gets or sets the identifier for the audio track. ## -property-value The identifier for the audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.Id + +## -description +Gets or sets the identifier for the audio track. + +## -property-value +The identifier for the audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_label.md b/windows.media.core/audiotrack_label.md index 19c4c7687a..2dccc45d1a 100644 --- a/windows.media.core/audiotrack_label.md +++ b/windows.media.core/audiotrack_label.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.Label --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.Label ## -description Gets or sets the label for the audio track. ## -property-value The label for the audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.Label + +## -description +Gets or sets the label for the audio track. + +## -property-value +The label for the audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_language.md b/windows.media.core/audiotrack_language.md index cebfd1ba8e..44c552296c 100644 --- a/windows.media.core/audiotrack_language.md +++ b/windows.media.core/audiotrack_language.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.Language --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.Language ## -description Gets or sets a string indicating the language of the audio track. ## -property-value A string indicating the language of the audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.Language + +## -description +Gets or sets a string indicating the language of the audio track. + +## -property-value +A string indicating the language of the audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_name.md b/windows.media.core/audiotrack_name.md index c1983745fe..43add64cbd 100644 --- a/windows.media.core/audiotrack_name.md +++ b/windows.media.core/audiotrack_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.Name --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.Name ## -description Gets the name of the [AudioTrack](audiotrack.md). ## -property-value The name of the [AudioTrack](audiotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.Name + +## -description +Gets the name of the [AudioTrack](audiotrack.md). + +## -property-value +The name of the [AudioTrack](audiotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_openfailed.md b/windows.media.core/audiotrack_openfailed.md index d7c1806cea..7b6f12205b 100644 --- a/windows.media.core/audiotrack_openfailed.md +++ b/windows.media.core/audiotrack_openfailed.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Core.AudioTrack.OpenFailed --api-type: winrt event ---- # Windows.Media.Core.AudioTrack.OpenFailed ## -description Occurs when an [AudioTrack](audiotrack.md) fails to open. ## -remarks Register for the **OpenFailed** event for an [AudioTrack](audiotrack.md) from within the [AudioTracksChanged](../windows.media.playback/mediaplaybackitem_audiotrackschanged.md) event handler for a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md), which is raised whenever an audio track is added to the item. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.AudioTrack.OpenFailed +-api-type: winrt event +--- + + + +# Windows.Media.Core.AudioTrack.OpenFailed + +## -description +Occurs when an [AudioTrack](audiotrack.md) fails to open. + +## -remarks +Register for the **OpenFailed** event for an [AudioTrack](audiotrack.md) from within the [AudioTracksChanged](../windows.media.playback/mediaplaybackitem_audiotrackschanged.md) event handler for a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md), which is raised whenever an audio track is added to the item. + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_playbackitem.md b/windows.media.core/audiotrack_playbackitem.md index e0bc399e65..9f98c04360 100644 --- a/windows.media.core/audiotrack_playbackitem.md +++ b/windows.media.core/audiotrack_playbackitem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.PlaybackItem --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.PlaybackItem ## -description Gets the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [AudioTrack](audiotrack.md). ## -property-value The [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [AudioTrack](audiotrack.md). ## -remarks An [AudioTrack](audiotrack.md) is contained by a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) when it is in the item's [AudioTracks](../windows.media.playback/mediaplaybackitem_audiotracks.md) collection. Use the **PlaybackItem** property to get a reference to the **MediaPlaybackItem** that contains the **AudioTrack**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.PlaybackItem +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.PlaybackItem + +## -description +Gets the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [AudioTrack](audiotrack.md). + +## -property-value +The [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [AudioTrack](audiotrack.md). + +## -remarks +An [AudioTrack](audiotrack.md) is contained by a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) when it is in the item's [AudioTracks](../windows.media.playback/mediaplaybackitem_audiotracks.md) collection. Use the **PlaybackItem** property to get a reference to the **MediaPlaybackItem** that contains the **AudioTrack**. + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_supportinfo.md b/windows.media.core/audiotrack_supportinfo.md index 96a240ac35..e8d56994e0 100644 --- a/windows.media.core/audiotrack_supportinfo.md +++ b/windows.media.core/audiotrack_supportinfo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.SupportInfo --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.SupportInfo ## -description Gets support information for the [AudioTrack](audiotrack.md). This information includes the status of the audio decoder, information about any audio degradation applied by the decoder, and the status of the [MediaSource](mediasource.md) with which the audio track is associated. ## -property-value The support information for the [AudioTrack](audiotrack.md). ## -remarks If a failure occurs when an [AudioTrack](audiotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](audiotrack_openfailed.md) event and checking the **SupportInfo** property of the **AudioTrack** passed into the event as the sender. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.SupportInfo +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.SupportInfo + +## -description +Gets support information for the [AudioTrack](audiotrack.md). This information includes the status of the audio decoder, information about any audio degradation applied by the decoder, and the status of the [MediaSource](mediasource.md) with which the audio track is associated. + +## -property-value +The support information for the [AudioTrack](audiotrack.md). + +## -remarks +If a failure occurs when an [AudioTrack](audiotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](audiotrack_openfailed.md) event and checking the **SupportInfo** property of the **AudioTrack** passed into the event as the sender. + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrack_trackkind.md b/windows.media.core/audiotrack_trackkind.md index 90dd4c222b..b01e94f539 100644 --- a/windows.media.core/audiotrack_trackkind.md +++ b/windows.media.core/audiotrack_trackkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrack.TrackKind --api-type: winrt property ---- # Windows.Media.Core.AudioTrack.TrackKind ## -description Gets a value indicating the type of data the track contains. For [AudioTrack](audiotrack.md) objects, this value is always [MediaTrackKind::Audio](mediatrackkind.md). ## -property-value A value indicating the type of data the track contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrack.TrackKind +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrack.TrackKind + +## -description +Gets a value indicating the type of data the track contains. For [AudioTrack](audiotrack.md) objects, this value is always [MediaTrackKind::Audio](mediatrackkind.md). + +## -property-value +A value indicating the type of data the track contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrackopenfailedeventargs.md b/windows.media.core/audiotrackopenfailedeventargs.md index ad43dfb1fd..cc6894ada1 100644 --- a/windows.media.core/audiotrackopenfailedeventargs.md +++ b/windows.media.core/audiotrackopenfailedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.AudioTrackOpenFailedEventArgs --api-type: winrt class ---- # Windows.Media.Core.AudioTrackOpenFailedEventArgs ## -description Provides data for the [OpenFailed](audiotrack_openfailed.md) event of an [AudioTrack](audiotrack.md). ## -remarks Get an instance of this class by handling the [OpenFailed](audiotrack_openfailed.md) event of an [AudioTrack](audiotrack.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.AudioTrackOpenFailedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.AudioTrackOpenFailedEventArgs + +## -description +Provides data for the [OpenFailed](audiotrack_openfailed.md) event of an [AudioTrack](audiotrack.md). + +## -remarks +Get an instance of this class by handling the [OpenFailed](audiotrack_openfailed.md) event of an [AudioTrack](audiotrack.md). + +## -examples + +## -see-also diff --git a/windows.media.core/audiotrackopenfailedeventargs_extendederror.md b/windows.media.core/audiotrackopenfailedeventargs_extendederror.md index 5fde26a746..cdc0c640b5 100644 --- a/windows.media.core/audiotrackopenfailedeventargs_extendederror.md +++ b/windows.media.core/audiotrackopenfailedeventargs_extendederror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrackOpenFailedEventArgs.ExtendedError --api-type: winrt property ---- # Windows.Media.Core.AudioTrackOpenFailedEventArgs.ExtendedError ## -description Gets the extended error code for an error that occurs when opening an [AudioTrack](audiotrack.md). ## -property-value The extended error code for an error that occurs when opening an [AudioTrack](audiotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrackOpenFailedEventArgs.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrackOpenFailedEventArgs.ExtendedError + +## -description +Gets the extended error code for an error that occurs when opening an [AudioTrack](audiotrack.md). + +## -property-value +The extended error code for an error that occurs when opening an [AudioTrack](audiotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotracksupportinfo.md b/windows.media.core/audiotracksupportinfo.md index 6bafc5b57a..ed9645d988 100644 --- a/windows.media.core/audiotracksupportinfo.md +++ b/windows.media.core/audiotracksupportinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.AudioTrackSupportInfo --api-type: winrt class ---- # Windows.Media.Core.AudioTrackSupportInfo ## -description Provides support information for an [AudioTrack](audiotrack.md). This information includes the status of the audio decoder, information about any audio degradation applied by the decoder, and the status of the [MediaSource](mediasource.md) with which the audio track is associated. ## -remarks If a failure occurs when an [AudioTrack](audiotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](audiotrack_openfailed.md) event and checking the [SupportInfo](audiotrack_supportinfo.md) property of the **AudioTrack** passed into the event as the sender. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.AudioTrackSupportInfo +-api-type: winrt class +--- + + + +# Windows.Media.Core.AudioTrackSupportInfo + +## -description +Provides support information for an [AudioTrack](audiotrack.md). This information includes the status of the audio decoder, information about any audio degradation applied by the decoder, and the status of the [MediaSource](mediasource.md) with which the audio track is associated. + +## -remarks +If a failure occurs when an [AudioTrack](audiotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](audiotrack_openfailed.md) event and checking the [SupportInfo](audiotrack_supportinfo.md) property of the **AudioTrack** passed into the event as the sender. + +## -examples + +## -see-also diff --git a/windows.media.core/audiotracksupportinfo_decoderstatus.md b/windows.media.core/audiotracksupportinfo_decoderstatus.md index 6a99d3fe1b..e9d3f8d0ef 100644 --- a/windows.media.core/audiotracksupportinfo_decoderstatus.md +++ b/windows.media.core/audiotracksupportinfo_decoderstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrackSupportInfo.DecoderStatus --api-type: winrt property ---- # Windows.Media.Core.AudioTrackSupportInfo.DecoderStatus ## -description Gets the status of the audio decoder that is decoding the [AudioTrack](audiotrack.md), including whether the encoding for the audio track is fully or partially supported and whether the decoder will degrade the audio. ## -property-value The status of the audio decoder that is decoding the [AudioTrack](audiotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrackSupportInfo.DecoderStatus +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrackSupportInfo.DecoderStatus + +## -description +Gets the status of the audio decoder that is decoding the [AudioTrack](audiotrack.md), including whether the encoding for the audio track is fully or partially supported and whether the decoder will degrade the audio. + +## -property-value +The status of the audio decoder that is decoding the [AudioTrack](audiotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotracksupportinfo_degradation.md b/windows.media.core/audiotracksupportinfo_degradation.md index b2b6ecbdc1..98f1596edb 100644 --- a/windows.media.core/audiotracksupportinfo_degradation.md +++ b/windows.media.core/audiotracksupportinfo_degradation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrackSupportInfo.Degradation --api-type: winrt property ---- # Windows.Media.Core.AudioTrackSupportInfo.Degradation ## -description Gets a value indicating the type of degradation, if any, that is applied to the [AudioTrack](audiotrack.md) by the audio decoder. ## -property-value The type of degradation, if any, that is applied to the [AudioTrack](audiotrack.md) by the audio decoder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrackSupportInfo.Degradation +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrackSupportInfo.Degradation + +## -description +Gets a value indicating the type of degradation, if any, that is applied to the [AudioTrack](audiotrack.md) by the audio decoder. + +## -property-value +The type of degradation, if any, that is applied to the [AudioTrack](audiotrack.md) by the audio decoder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotracksupportinfo_degradationreason.md b/windows.media.core/audiotracksupportinfo_degradationreason.md index 6cd7a7a220..e64ade83ff 100644 --- a/windows.media.core/audiotracksupportinfo_degradationreason.md +++ b/windows.media.core/audiotracksupportinfo_degradationreason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrackSupportInfo.DegradationReason --api-type: winrt property ---- # Windows.Media.Core.AudioTrackSupportInfo.DegradationReason ## -description Gets a value indicating the reason that the audio decoder is degrading the [AudioTrack](audiotrackopenfailedeventargs.md), if the audio is degraded. ## -property-value The reason that the audio decoder is degrading the **AudioTrack**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrackSupportInfo.DegradationReason +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrackSupportInfo.DegradationReason + +## -description +Gets a value indicating the reason that the audio decoder is degrading the [AudioTrack](audiotrackopenfailedeventargs.md), if the audio is degraded. + +## -property-value +The reason that the audio decoder is degrading the **AudioTrack**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/audiotracksupportinfo_mediasourcestatus.md b/windows.media.core/audiotracksupportinfo_mediasourcestatus.md index 22525be212..6acdb1b94c 100644 --- a/windows.media.core/audiotracksupportinfo_mediasourcestatus.md +++ b/windows.media.core/audiotracksupportinfo_mediasourcestatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.AudioTrackSupportInfo.MediaSourceStatus --api-type: winrt property ---- # Windows.Media.Core.AudioTrackSupportInfo.MediaSourceStatus ## -description Gets the status of the [MediaSource](mediasource.md) with which the [AudioTrack](audiotrack.md) is associated. ## -property-value The status of the [MediaSource](mediasource.md) with which the [AudioTrack](audiotrack.md) is associated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.AudioTrackSupportInfo.MediaSourceStatus +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioTrackSupportInfo.MediaSourceStatus + +## -description +Gets the status of the [MediaSource](mediasource.md) with which the [AudioTrack](audiotrack.md) is associated. + +## -property-value +The status of the [MediaSource](mediasource.md) with which the [AudioTrack](audiotrack.md) is associated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/datacue.md b/windows.media.core/datacue.md index b9c79c5175..2d55d6e8e8 100644 --- a/windows.media.core/datacue.md +++ b/windows.media.core/datacue.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.DataCue --api-type: winrt class ---- # Windows.Media.Core.DataCue ## -description Represents a data cue that can be included in a [TimedMetadataTrack](timedmetadatatrack.md). ## -remarks A **DataCue** can be added to a [TimedMetadataTrack](timedmetadatatrack.md) with the [AddCue](timedmetadatatrack_addcue.md) method. When the cue's start time is reached, the [CueEntered](timedmetadatatrack_cueentered.md) event is raised and you can use the [MediaCueEventArgs](mediacueeventargs.md) passed into the handler to get a copy of the **DataCue**. The [Data](datacue_data.md) property of **DataCue** is an [IBuffer](../windows.storage.streams/ibuffer.md) that can contain any type of data. If you want to display text when the cue is encountered, the [TimedTextCue](timedtextcue.md) class is provided for this scenario. ## -examples ## -see-also [IDataCue](idatacue.md), [IMediaCue](imediacue.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.DataCue +-api-type: winrt class +--- + + + +# Windows.Media.Core.DataCue + +## -description +Represents a data cue that can be included in a [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks +A **DataCue** can be added to a [TimedMetadataTrack](timedmetadatatrack.md) with the [AddCue](timedmetadatatrack_addcue.md) method. When the cue's start time is reached, the [CueEntered](timedmetadatatrack_cueentered.md) event is raised and you can use the [MediaCueEventArgs](mediacueeventargs.md) passed into the handler to get a copy of the **DataCue**. The [Data](datacue_data.md) property of **DataCue** is an [IBuffer](../windows.storage.streams/ibuffer.md) that can contain any type of data. If you want to display text when the cue is encountered, the [TimedTextCue](timedtextcue.md) class is provided for this scenario. + +## -examples + +## -see-also +[IDataCue](idatacue.md), [IMediaCue](imediacue.md) \ No newline at end of file diff --git a/windows.media.core/datacue_data.md b/windows.media.core/datacue_data.md index 0b4b3afe7b..5f0b308814 100644 --- a/windows.media.core/datacue_data.md +++ b/windows.media.core/datacue_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.DataCue.Data --api-type: winrt property ---- # Windows.Media.Core.DataCue.Data ## -description Gets the data associated with the cue. ## -property-value The data associated with the cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.DataCue.Data +-api-type: winrt property +--- + + + +# Windows.Media.Core.DataCue.Data + +## -description +Gets the data associated with the cue. + +## -property-value +The data associated with the cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/datacue_datacue_1221375020.md b/windows.media.core/datacue_datacue_1221375020.md index b5d4cc7aaf..024a31bb44 100644 --- a/windows.media.core/datacue_datacue_1221375020.md +++ b/windows.media.core/datacue_datacue_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.DataCue.#ctor --api-type: winrt method ---- # Windows.Media.Core.DataCue.DataCue ## -description Initializes a new instance of the [DataCue](datacue.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.DataCue.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.DataCue.DataCue + +## -description +Initializes a new instance of the [DataCue](datacue.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/datacue_duration.md b/windows.media.core/datacue_duration.md index c570070c75..d067ec2ede 100644 --- a/windows.media.core/datacue_duration.md +++ b/windows.media.core/datacue_duration.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.DataCue.Duration --api-type: winrt property ---- # Windows.Media.Core.DataCue.Duration ## -description Gets or sets the duration of the cue. ## -property-value The duration of the cue. ## -remarks At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.DataCue.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.DataCue.Duration + +## -description +Gets or sets the duration of the cue. + +## -property-value +The duration of the cue. + +## -remarks +At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.media.core/datacue_id.md b/windows.media.core/datacue_id.md index 71a2b0b55b..5d627cd2d1 100644 --- a/windows.media.core/datacue_id.md +++ b/windows.media.core/datacue_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.DataCue.Id --api-type: winrt property ---- # Windows.Media.Core.DataCue.Id ## -description Gets the identifier for the timed metadata track. ## -property-value The identifier for the timed metadata track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.DataCue.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.DataCue.Id + +## -description +Gets the identifier for the timed metadata track. + +## -property-value +The identifier for the timed metadata track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/datacue_starttime.md b/windows.media.core/datacue_starttime.md index f872b3efa3..df31de4959 100644 --- a/windows.media.core/datacue_starttime.md +++ b/windows.media.core/datacue_starttime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.DataCue.StartTime --api-type: winrt property ---- # Windows.Media.Core.DataCue.StartTime ## -description Gets the start time of the cue. ## -property-value The start time of the cue. ## -remarks When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.DataCue.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.DataCue.StartTime + +## -description +Gets the start time of the cue. + +## -property-value +The start time of the cue. + +## -remarks +When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectedeventargs.md b/windows.media.core/facedetectedeventargs.md index d43af130cb..5ac7d11212 100644 --- a/windows.media.core/facedetectedeventargs.md +++ b/windows.media.core/facedetectedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.FaceDetectedEventArgs --api-type: winrt class ---- # Windows.Media.Core.FaceDetectedEventArgs ## -description Provides data for the [FaceDetected](facedetectioneffect_facedetected.md) event. ## -remarks Get an instance of this class by handling the [FaceDetected](facedetectioneffect_facedetected.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.FaceDetectedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.FaceDetectedEventArgs + +## -description +Provides data for the [FaceDetected](facedetectioneffect_facedetected.md) event. + +## -remarks +Get an instance of this class by handling the [FaceDetected](facedetectioneffect_facedetected.md) event. + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectedeventargs_resultframe.md b/windows.media.core/facedetectedeventargs_resultframe.md index 3dab68c0c7..08f402126f 100644 --- a/windows.media.core/facedetectedeventargs_resultframe.md +++ b/windows.media.core/facedetectedeventargs_resultframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectedEventArgs.ResultFrame --api-type: winrt property ---- # Windows.Media.Core.FaceDetectedEventArgs.ResultFrame ## -description Gets the [FaceDetectionEffectFrame](facedetectioneffectframe.md) associated with a [FaceDetected](facedetectioneffect_facedetected.md) event. ## -property-value The [FaceDetectionEffectFrame](facedetectioneffectframe.md) associated with a [FaceDetected](facedetectioneffect_facedetected.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectedEventArgs.ResultFrame +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectedEventArgs.ResultFrame + +## -description +Gets the [FaceDetectionEffectFrame](facedetectioneffectframe.md) associated with a [FaceDetected](facedetectioneffect_facedetected.md) event. + +## -property-value +The [FaceDetectionEffectFrame](facedetectioneffectframe.md) associated with a [FaceDetected](facedetectioneffect_facedetected.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffect.md b/windows.media.core/facedetectioneffect.md index 3f75857266..e1631d7762 100644 --- a/windows.media.core/facedetectioneffect.md +++ b/windows.media.core/facedetectioneffect.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.FaceDetectionEffect --api-type: winrt class ---- # Windows.Media.Core.FaceDetectionEffect ## -description Represents an effect that attempts to detect faces in a video stream. ## -remarks Get an instance of this class by passing a [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object into [AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). ## -examples ## -see-also [IMediaExtension](../windows.media/imediaextension.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.FaceDetectionEffect +-api-type: winrt class +--- + + + +# Windows.Media.Core.FaceDetectionEffect + +## -description +Represents an effect that attempts to detect faces in a video stream. + +## -remarks +Get an instance of this class by passing a [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object into [AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). + +## -examples + +## -see-also +[IMediaExtension](../windows.media/imediaextension.md) \ No newline at end of file diff --git a/windows.media.core/facedetectioneffect_desireddetectioninterval.md b/windows.media.core/facedetectioneffect_desireddetectioninterval.md index f08a95a19e..fdb2ec617c 100644 --- a/windows.media.core/facedetectioneffect_desireddetectioninterval.md +++ b/windows.media.core/facedetectioneffect_desireddetectioninterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffect.DesiredDetectionInterval --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffect.DesiredDetectionInterval ## -description Gets or sets the time span for which face detection should be performed. ## -property-value The time span for which face detection should be performed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffect.DesiredDetectionInterval +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffect.DesiredDetectionInterval + +## -description +Gets or sets the time span for which face detection should be performed. + +## -property-value +The time span for which face detection should be performed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffect_enabled.md b/windows.media.core/facedetectioneffect_enabled.md index ad3e9c9856..de3ee7df72 100644 --- a/windows.media.core/facedetectioneffect_enabled.md +++ b/windows.media.core/facedetectioneffect_enabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffect.Enabled --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffect.Enabled ## -description Gets or sets a value indicating whether face detection is enabled. ## -property-value True if face detection is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffect.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffect.Enabled + +## -description +Gets or sets a value indicating whether face detection is enabled. + +## -property-value +True if face detection is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffect_facedetected.md b/windows.media.core/facedetectioneffect_facedetected.md index 7fedc7fffd..af4bf68135 100644 --- a/windows.media.core/facedetectioneffect_facedetected.md +++ b/windows.media.core/facedetectioneffect_facedetected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.FaceDetectionEffect.FaceDetected --api-type: winrt event ---- # Windows.Media.Core.FaceDetectionEffect.FaceDetected ## -description Occurs when a face is detected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.FaceDetectionEffect.FaceDetected +-api-type: winrt event +--- + + + +# Windows.Media.Core.FaceDetectionEffect.FaceDetected + +## -description +Occurs when a face is detected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffect_setproperties_518979560.md b/windows.media.core/facedetectioneffect_setproperties_518979560.md index 177a083e73..7c84daaf82 100644 --- a/windows.media.core/facedetectioneffect_setproperties_518979560.md +++ b/windows.media.core/facedetectioneffect_setproperties_518979560.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.FaceDetectionEffect.SetProperties(Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Core.FaceDetectionEffect.SetProperties ## -description Sets properties on the [IMediaExtension](../windows.media/imediaextension.md). ## -parameters ### -param configuration The property set. ## -remarks This method is inherited from the [IMediaExtension](../windows.media/imediaextension.md) interface and is not intended to be used from your code. Instead, set the properties of the [FaceDetectionEffect](facedetectioneffect.md) directly. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.FaceDetectionEffect.SetProperties(Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Core.FaceDetectionEffect.SetProperties + +## -description +Sets properties on the [IMediaExtension](../windows.media/imediaextension.md). + +## -parameters +### -param configuration +The property set. + +## -remarks +This method is inherited from the [IMediaExtension](../windows.media/imediaextension.md) interface and is not intended to be used from your code. Instead, set the properties of the [FaceDetectionEffect](facedetectioneffect.md) directly. + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectdefinition.md b/windows.media.core/facedetectioneffectdefinition.md index ad7b21a821..f32691c1f3 100644 --- a/windows.media.core/facedetectioneffectdefinition.md +++ b/windows.media.core/facedetectioneffectdefinition.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.FaceDetectionEffectDefinition --api-type: winrt class ---- # Windows.Media.Core.FaceDetectionEffectDefinition ## -description Represents the definition of a face detection video effect. ## -remarks Get an instance of the [FaceDetectionEffect](facedetectioneffect.md) class by passing a [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object into [AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). ## -examples ## -see-also [IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md), [FaceDetectionEffect](facedetectioneffect.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.FaceDetectionEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Core.FaceDetectionEffectDefinition + +## -description +Represents the definition of a face detection video effect. + +## -remarks +Get an instance of the [FaceDetectionEffect](facedetectioneffect.md) class by passing a [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object into [AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). + +## -examples + +## -see-also +[IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md), [FaceDetectionEffect](facedetectioneffect.md) \ No newline at end of file diff --git a/windows.media.core/facedetectioneffectdefinition_activatableclassid.md b/windows.media.core/facedetectioneffectdefinition_activatableclassid.md index 4900516112..4a62e5f229 100644 --- a/windows.media.core/facedetectioneffectdefinition_activatableclassid.md +++ b/windows.media.core/facedetectioneffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectDefinition.ActivatableClassId ## -description Gets a string containing the activatable class ID of the face detection effect definition. ## -property-value The activatable class ID of the face detection effect definition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectDefinition.ActivatableClassId + +## -description +Gets a string containing the activatable class ID of the face detection effect definition. + +## -property-value +The activatable class ID of the face detection effect definition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectdefinition_detectionmode.md b/windows.media.core/facedetectioneffectdefinition_detectionmode.md index 86510952c7..8427e89781 100644 --- a/windows.media.core/facedetectioneffectdefinition_detectionmode.md +++ b/windows.media.core/facedetectioneffectdefinition_detectionmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.DetectionMode --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectDefinition.DetectionMode ## -description Gets or sets a value that prioritizes the speed of face detection and the quality of detection results. ## -property-value A value that prioritizes the speed of face detection and the quality of detection results. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.DetectionMode +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectDefinition.DetectionMode + +## -description +Gets or sets a value that prioritizes the speed of face detection and the quality of detection results. + +## -property-value +A value that prioritizes the speed of face detection and the quality of detection results. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectdefinition_facedetectioneffectdefinition_1221375020.md b/windows.media.core/facedetectioneffectdefinition_facedetectioneffectdefinition_1221375020.md index f0b0a609a5..a0d37ad351 100644 --- a/windows.media.core/facedetectioneffectdefinition_facedetectioneffectdefinition_1221375020.md +++ b/windows.media.core/facedetectioneffectdefinition_facedetectioneffectdefinition_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.FaceDetectionEffectDefinition.#ctor --api-type: winrt method ---- # Windows.Media.Core.FaceDetectionEffectDefinition.FaceDetectionEffectDefinition ## -description Initializes a new instance of the [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.FaceDetectionEffectDefinition.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.FaceDetectionEffectDefinition.FaceDetectionEffectDefinition + +## -description +Initializes a new instance of the [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectdefinition_properties.md b/windows.media.core/facedetectioneffectdefinition_properties.md index f000c415aa..7b6ef5e53c 100644 --- a/windows.media.core/facedetectioneffectdefinition_properties.md +++ b/windows.media.core/facedetectioneffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectDefinition.Properties ## -description Gets the set of properties for configuring the [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object. ## -property-value The set of properties for configuring the [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectDefinition.Properties + +## -description +Gets the set of properties for configuring the [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object. + +## -property-value +The set of properties for configuring the [FaceDetectionEffectDefinition](facedetectioneffectdefinition.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectdefinition_synchronousdetectionenabled.md b/windows.media.core/facedetectioneffectdefinition_synchronousdetectionenabled.md index c397268bfb..9dccf58964 100644 --- a/windows.media.core/facedetectioneffectdefinition_synchronousdetectionenabled.md +++ b/windows.media.core/facedetectioneffectdefinition_synchronousdetectionenabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.SynchronousDetectionEnabled --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectDefinition.SynchronousDetectionEnabled ## -description Gets or sets a value indicating whether synchronous face detection is enabled. ## -property-value True if synchronous face detection is enabled; otherwise, false. ## -remarks When synchronous detection is enabled, the system will delay the return of a video frame until the face detection operation for the frame is complete. When the frames do arrive, the timestamp of the [FaceDetectionEffectFrame](facedetectioneffectframe.md) will match the timestamp of the associated [VideoFrame](../windows.media/videoframe.md). When synchronous detection is disabled, the timestamp of the [FaceDetectionEffectFrame](facedetectioneffectframe.md) will typically be slightly later than the associated[VideoFrame](../windows.media/videoframe.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectDefinition.SynchronousDetectionEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectDefinition.SynchronousDetectionEnabled + +## -description +Gets or sets a value indicating whether synchronous face detection is enabled. + +## -property-value +True if synchronous face detection is enabled; otherwise, false. + +## -remarks +When synchronous detection is enabled, the system will delay the return of a video frame until the face detection operation for the frame is complete. When the frames do arrive, the timestamp of the [FaceDetectionEffectFrame](facedetectioneffectframe.md) will match the timestamp of the associated [VideoFrame](../windows.media/videoframe.md). When synchronous detection is disabled, the timestamp of the [FaceDetectionEffectFrame](facedetectioneffectframe.md) will typically be slightly later than the associated[VideoFrame](../windows.media/videoframe.md). + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe.md b/windows.media.core/facedetectioneffectframe.md index 85b267a472..d69e941092 100644 --- a/windows.media.core/facedetectioneffectframe.md +++ b/windows.media.core/facedetectioneffectframe.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.FaceDetectionEffectFrame --api-type: winrt class ---- # Windows.Media.Core.FaceDetectionEffectFrame ## -description Represents a video frame that includes a list of faces detected by the [FaceDetectionEffect](facedetectioneffect.md). ## -remarks Get an instance of this class by accessing the [FaceDetectedEventArgs.ResultFrame](facedetectedeventargs_resultframe.md). ## -examples ## -see-also [IMediaFrame](../windows.media/imediaframe.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.FaceDetectionEffectFrame +-api-type: winrt class +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame + +## -description +Represents a video frame that includes a list of faces detected by the [FaceDetectionEffect](facedetectioneffect.md). + +## -remarks +Get an instance of this class by accessing the [FaceDetectedEventArgs.ResultFrame](facedetectedeventargs_resultframe.md). + +## -examples + +## -see-also +[IMediaFrame](../windows.media/imediaframe.md), [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.core/facedetectioneffectframe_close_811482585.md b/windows.media.core/facedetectioneffectframe_close_811482585.md index 6427c0c671..9112732139 100644 --- a/windows.media.core/facedetectioneffectframe_close_811482585.md +++ b/windows.media.core/facedetectioneffectframe_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.FaceDetectionEffectFrame.Close --api-type: winrt method ---- # Windows.Media.Core.FaceDetectionEffectFrame.Close ## -description Disposes of the object and associated resources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.FaceDetectionEffectFrame.Close +-api-type: winrt method +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.Close + +## -description +Disposes of the object and associated resources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_detectedfaces.md b/windows.media.core/facedetectioneffectframe_detectedfaces.md index 09da88ab6d..af3a65d6d0 100644 --- a/windows.media.core/facedetectioneffectframe_detectedfaces.md +++ b/windows.media.core/facedetectioneffectframe_detectedfaces.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.DetectedFaces --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.DetectedFaces ## -description Gets the list of objects representing the faces detected in the frame. ## -property-value The list of objects representing the faces detected in the frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.DetectedFaces +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.DetectedFaces + +## -description +Gets the list of objects representing the faces detected in the frame. + +## -property-value +The list of objects representing the faces detected in the frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_duration.md b/windows.media.core/facedetectioneffectframe_duration.md index 192993a399..8a01c58565 100644 --- a/windows.media.core/facedetectioneffectframe_duration.md +++ b/windows.media.core/facedetectioneffectframe_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.Duration --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.Duration ## -description Gets or sets the duration of the face detection effect frame. ## -property-value The duration of the face detection effect frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.Duration + +## -description +Gets or sets the duration of the face detection effect frame. + +## -property-value +The duration of the face detection effect frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_extendedproperties.md b/windows.media.core/facedetectioneffectframe_extendedproperties.md index 379d68b51b..a7f69992f4 100644 --- a/windows.media.core/facedetectioneffectframe_extendedproperties.md +++ b/windows.media.core/facedetectioneffectframe_extendedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.ExtendedProperties --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.ExtendedProperties ## -description Gets the extended property set which enables getting and setting properties on the media frame. ## -property-value The extended properties map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.ExtendedProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.ExtendedProperties + +## -description +Gets the extended property set which enables getting and setting properties on the media frame. + +## -property-value +The extended properties map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_isdiscontinuous.md b/windows.media.core/facedetectioneffectframe_isdiscontinuous.md index c443eb9f5b..5f7f5498c9 100644 --- a/windows.media.core/facedetectioneffectframe_isdiscontinuous.md +++ b/windows.media.core/facedetectioneffectframe_isdiscontinuous.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.IsDiscontinuous --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.IsDiscontinuous ## -description Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream. ## -property-value True if the video frame is the first frame after a gap in the stream; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.IsDiscontinuous +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.IsDiscontinuous + +## -description +Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream. + +## -property-value +True if the video frame is the first frame after a gap in the stream; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_isreadonly.md b/windows.media.core/facedetectioneffectframe_isreadonly.md index 4408d7cb34..d843bf4581 100644 --- a/windows.media.core/facedetectioneffectframe_isreadonly.md +++ b/windows.media.core/facedetectioneffectframe_isreadonly.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.IsReadOnly --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.IsReadOnly ## -description Gets a value indicating whether the frame is read-only. ## -property-value True if the frame is read-only; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.IsReadOnly +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.IsReadOnly + +## -description +Gets a value indicating whether the frame is read-only. + +## -property-value +True if the frame is read-only; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_relativetime.md b/windows.media.core/facedetectioneffectframe_relativetime.md index 1c4eb57315..ea6248df56 100644 --- a/windows.media.core/facedetectioneffectframe_relativetime.md +++ b/windows.media.core/facedetectioneffectframe_relativetime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.RelativeTime --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.RelativeTime ## -description Gets or sets the relative time of the frame within the video stream. ## -property-value The relative time of the frame within the video stream. ## -remarks Use [SystemRelativeTime](facedetectioneffectframe_systemrelativetime.md) to get a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.RelativeTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.RelativeTime + +## -description +Gets or sets the relative time of the frame within the video stream. + +## -property-value +The relative time of the frame within the video stream. + +## -remarks +Use [SystemRelativeTime](facedetectioneffectframe_systemrelativetime.md) to get a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_systemrelativetime.md b/windows.media.core/facedetectioneffectframe_systemrelativetime.md index 92b8d43b61..431f183e1f 100644 --- a/windows.media.core/facedetectioneffectframe_systemrelativetime.md +++ b/windows.media.core/facedetectioneffectframe_systemrelativetime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.SystemRelativeTime --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.SystemRelativeTime ## -description Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. ## -property-value A timestamp relative to the system. ## -remarks Use [RelativeTime](facedetectioneffectframe_relativetime.md) to get a timestamp that is relative to the video stream. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.SystemRelativeTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.SystemRelativeTime + +## -description +Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. + +## -property-value +A timestamp relative to the system. + +## -remarks +Use [RelativeTime](facedetectioneffectframe_relativetime.md) to get a timestamp that is relative to the video stream. + +## -examples + +## -see-also diff --git a/windows.media.core/facedetectioneffectframe_type.md b/windows.media.core/facedetectioneffectframe_type.md index ffbdeaec5a..7c5dc8e212 100644 --- a/windows.media.core/facedetectioneffectframe_type.md +++ b/windows.media.core/facedetectioneffectframe_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.Type --api-type: winrt property ---- # Windows.Media.Core.FaceDetectionEffectFrame.Type ## -description Gets a string indicating the type of data the frame contains. ## -property-value A string indicating the type of data the frame contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.FaceDetectionEffectFrame.Type +-api-type: winrt property +--- + + + +# Windows.Media.Core.FaceDetectionEffectFrame.Type + +## -description +Gets a string indicating the type of data the frame contains. + +## -property-value +A string indicating the type of data the frame contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/highdynamicrangecontrol.md b/windows.media.core/highdynamicrangecontrol.md index 5eb4a5da02..0db4ec1004 100644 --- a/windows.media.core/highdynamicrangecontrol.md +++ b/windows.media.core/highdynamicrangecontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.HighDynamicRangeControl --api-type: winrt class ---- # Windows.Media.Core.HighDynamicRangeControl ## -description Provides the ability to enable and disable High Dynamic Range (HDR) analysis for the [SceneAnalysisEffect](sceneanalysiseffect.md). ## -remarks Get an instance of this class by accessing the [SceneAnalysisEffect.HighDynamicRangeAnalyzer](sceneanalysiseffect_highdynamicrangeanalyzer.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.HighDynamicRangeControl +-api-type: winrt class +--- + + + +# Windows.Media.Core.HighDynamicRangeControl + +## -description +Provides the ability to enable and disable High Dynamic Range (HDR) analysis for the [SceneAnalysisEffect](sceneanalysiseffect.md). + +## -remarks +Get an instance of this class by accessing the [SceneAnalysisEffect.HighDynamicRangeAnalyzer](sceneanalysiseffect_highdynamicrangeanalyzer.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/highdynamicrangecontrol_enabled.md b/windows.media.core/highdynamicrangecontrol_enabled.md index 9d57478b1a..a27c92e434 100644 --- a/windows.media.core/highdynamicrangecontrol_enabled.md +++ b/windows.media.core/highdynamicrangecontrol_enabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.HighDynamicRangeControl.Enabled --api-type: winrt property ---- # Windows.Media.Core.HighDynamicRangeControl.Enabled ## -description Gets or sets a value that specifies whether High Dynamic Range (HDR) analysis is enabled for the [SceneAnalysisEffect](sceneanalysiseffect.md). ## -property-value True if HDR analysis is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.HighDynamicRangeControl.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.HighDynamicRangeControl.Enabled + +## -description +Gets or sets a value that specifies whether High Dynamic Range (HDR) analysis is enabled for the [SceneAnalysisEffect](sceneanalysiseffect.md). + +## -property-value +True if HDR analysis is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/highdynamicrangeoutput.md b/windows.media.core/highdynamicrangeoutput.md index 035a2df00f..4572db98da 100644 --- a/windows.media.core/highdynamicrangeoutput.md +++ b/windows.media.core/highdynamicrangeoutput.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.HighDynamicRangeOutput --api-type: winrt class ---- # Windows.Media.Core.HighDynamicRangeOutput ## -description Provides the results of a High Dynamic Range (HDR) analysis operation from the [SceneAnalysisEffect](sceneanalysiseffect.md). ## -remarks Get an instance of this class by accessing the [SceneAnalysisEffectFrame.HighDynamicRange](sceneanalysiseffectframe_highdynamicrange.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.HighDynamicRangeOutput +-api-type: winrt class +--- + + + +# Windows.Media.Core.HighDynamicRangeOutput + +## -description +Provides the results of a High Dynamic Range (HDR) analysis operation from the [SceneAnalysisEffect](sceneanalysiseffect.md). + +## -remarks +Get an instance of this class by accessing the [SceneAnalysisEffectFrame.HighDynamicRange](sceneanalysiseffectframe_highdynamicrange.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/highdynamicrangeoutput_certainty.md b/windows.media.core/highdynamicrangeoutput_certainty.md index 5142af32ac..253f058100 100644 --- a/windows.media.core/highdynamicrangeoutput_certainty.md +++ b/windows.media.core/highdynamicrangeoutput_certainty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.HighDynamicRangeOutput.Certainty --api-type: winrt property ---- # Windows.Media.Core.HighDynamicRangeOutput.Certainty ## -description Gets a value indicating the certainty of the results of the HDR analysis. ## -property-value A value indicating the certainty of the results of the HDR analysis where 1 is full certainty and 0 is no certainty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.HighDynamicRangeOutput.Certainty +-api-type: winrt property +--- + + + +# Windows.Media.Core.HighDynamicRangeOutput.Certainty + +## -description +Gets a value indicating the certainty of the results of the HDR analysis. + +## -property-value +A value indicating the certainty of the results of the HDR analysis where 1 is full certainty and 0 is no certainty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/highdynamicrangeoutput_framecontrollers.md b/windows.media.core/highdynamicrangeoutput_framecontrollers.md index 40ceaba419..e3d537e67d 100644 --- a/windows.media.core/highdynamicrangeoutput_framecontrollers.md +++ b/windows.media.core/highdynamicrangeoutput_framecontrollers.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.HighDynamicRangeOutput.FrameControllers --api-type: winrt property ---- # Windows.Media.Core.HighDynamicRangeOutput.FrameControllers ## -description Gets a set of [FrameController](highdynamicrangeoutput_framecontrollers.md) objects representing the suggested frame controllers settings for capturing a variable photo sequence with the High Dynamic Range (HDR) technique. ## -property-value A set of [FrameController](highdynamicrangeoutput_framecontrollers.md) objects representing the suggested frame controllers settings. ## -remarks The frame controller list can be assigned to the [VariablePhotoSequenceController.DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection to enable the HDR capture technique with suggested settings from the analysis. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.HighDynamicRangeOutput.FrameControllers +-api-type: winrt property +--- + + + +# Windows.Media.Core.HighDynamicRangeOutput.FrameControllers + +## -description +Gets a set of [FrameController](highdynamicrangeoutput_framecontrollers.md) objects representing the suggested frame controllers settings for capturing a variable photo sequence with the High Dynamic Range (HDR) technique. + +## -property-value +A set of [FrameController](highdynamicrangeoutput_framecontrollers.md) objects representing the suggested frame controllers settings. + +## -remarks +The frame controller list can be assigned to the [VariablePhotoSequenceController.DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection to enable the HDR capture technique with suggested settings from the analysis. + +## -examples + +## -see-also diff --git a/windows.media.core/imediacue_duration.md b/windows.media.core/imediacue_duration.md index 42e8fab741..bd1f6bae42 100644 --- a/windows.media.core/imediacue_duration.md +++ b/windows.media.core/imediacue_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaCue.Duration --api-type: winrt property ---- # Windows.Media.Core.IMediaCue.Duration ## -description Gets or sets the duration of the media cue. ## -property-value The duration of the media cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaCue.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaCue.Duration + +## -description +Gets or sets the duration of the media cue. + +## -property-value +The duration of the media cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/imediacue_id.md b/windows.media.core/imediacue_id.md index 9f587cc45c..889e10e433 100644 --- a/windows.media.core/imediacue_id.md +++ b/windows.media.core/imediacue_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaCue.Id --api-type: winrt property ---- # Windows.Media.Core.IMediaCue.Id ## -description Gets or sets the identifier for the media cue. ## -property-value The identifier for the media cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaCue.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaCue.Id + +## -description +Gets or sets the identifier for the media cue. + +## -property-value +The identifier for the media cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/imediacue_starttime.md b/windows.media.core/imediacue_starttime.md index 2e49ecd2a9..de5280f6d8 100644 --- a/windows.media.core/imediacue_starttime.md +++ b/windows.media.core/imediacue_starttime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaCue.StartTime --api-type: winrt property ---- # Windows.Media.Core.IMediaCue.StartTime ## -description Gets or sets the start time of the media cue. ## -property-value The start time of the media cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaCue.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaCue.StartTime + +## -description +Gets or sets the start time of the media cue. + +## -property-value +The start time of the media cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/imediastreamdescriptor_isselected.md b/windows.media.core/imediastreamdescriptor_isselected.md index f03b3f5016..3ce5d8f56c 100644 --- a/windows.media.core/imediastreamdescriptor_isselected.md +++ b/windows.media.core/imediastreamdescriptor_isselected.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.IMediaStreamDescriptor.IsSelected --api-type: winrt property ---- # Windows.Media.Core.IMediaStreamDescriptor.IsSelected ## -description Specifies whether the stream is currently in use by the [MediaStreamSource](mediastreamsource.md). ## -property-value **true** if the stream is currently in use by the [MediaStreamSource](mediastreamsource.md); otherwise, **false**. ## -remarks [IsSelected](imediastreamdescriptor_isselected.md) is **true** if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the [MediaStreamSource](mediastreamsource.md). Otherwise, the value is **false**. The [MediaStreamSource](mediastreamsource.md) only raises the [SampleRequested](mediastreamsource_samplerequested.md) event for streams which are selected. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaStreamDescriptor.IsSelected +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaStreamDescriptor.IsSelected + +## -description +Specifies whether the stream is currently in use by the [MediaStreamSource](mediastreamsource.md). + +## -property-value +**true** if the stream is currently in use by the [MediaStreamSource](mediastreamsource.md); otherwise, **false**. + +## -remarks +[IsSelected](imediastreamdescriptor_isselected.md) is **true** if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the [MediaStreamSource](mediastreamsource.md). Otherwise, the value is **false**. + +The [MediaStreamSource](mediastreamsource.md) only raises the [SampleRequested](mediastreamsource_samplerequested.md) event for streams which are selected. + +## -examples + +## -see-also diff --git a/windows.media.core/imediastreamdescriptor_language.md b/windows.media.core/imediastreamdescriptor_language.md index b866f16a62..5d29f4930e 100644 --- a/windows.media.core/imediastreamdescriptor_language.md +++ b/windows.media.core/imediastreamdescriptor_language.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.IMediaStreamDescriptor.Language --api-type: winrt property ---- # Windows.Media.Core.IMediaStreamDescriptor.Language ## -description Gets or sets the RFC-1766 language code for the stream. ## -property-value The RFC-1766 language code for the stream. ## -remarks The initial value is an empty string. The language is specified using a RFC-1766 language code, for example, “en-US”. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaStreamDescriptor.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaStreamDescriptor.Language + +## -description +Gets or sets the RFC-1766 language code for the stream. + +## -property-value +The RFC-1766 language code for the stream. + +## -remarks +The initial value is an empty string. + +The language is specified using a RFC-1766 language code, for example, “en-US”. + +## -examples + +## -see-also diff --git a/windows.media.core/imediastreamdescriptor_name.md b/windows.media.core/imediastreamdescriptor_name.md index ec915bfa94..52920bfffa 100644 --- a/windows.media.core/imediastreamdescriptor_name.md +++ b/windows.media.core/imediastreamdescriptor_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.IMediaStreamDescriptor.Name --api-type: winrt property ---- # Windows.Media.Core.IMediaStreamDescriptor.Name ## -description Gets or sets the name of the stream. ## -property-value The name of the stream. ## -remarks The initial value is an empty string. The name is a free-form human readable string that describes the stream, for example, “English soundtrack”. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaStreamDescriptor.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaStreamDescriptor.Name + +## -description +Gets or sets the name of the stream. + +## -property-value +The name of the stream. + +## -remarks +The initial value is an empty string. + +The name is a free-form human readable string that describes the stream, for example, “English soundtrack”. + +## -examples + +## -see-also diff --git a/windows.media.core/imediatrack_id.md b/windows.media.core/imediatrack_id.md index b2590ea4ad..e228167edd 100644 --- a/windows.media.core/imediatrack_id.md +++ b/windows.media.core/imediatrack_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaTrack.Id --api-type: winrt property ---- # Windows.Media.Core.IMediaTrack.Id ## -description Gets the identifier of the media track. ## -property-value The identifier of the media track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaTrack.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaTrack.Id + +## -description +Gets the identifier of the media track. + +## -property-value +The identifier of the media track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/imediatrack_label.md b/windows.media.core/imediatrack_label.md index cea2c7db38..4d8bd09c5d 100644 --- a/windows.media.core/imediatrack_label.md +++ b/windows.media.core/imediatrack_label.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaTrack.Label --api-type: winrt property ---- # Windows.Media.Core.IMediaTrack.Label ## -description Gets or sets the label for the media track. ## -property-value The label for the media track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaTrack.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaTrack.Label + +## -description +Gets or sets the label for the media track. + +## -property-value +The label for the media track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/imediatrack_language.md b/windows.media.core/imediatrack_language.md index 02417eb988..df6fafc021 100644 --- a/windows.media.core/imediatrack_language.md +++ b/windows.media.core/imediatrack_language.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaTrack.Language --api-type: winrt property ---- # Windows.Media.Core.IMediaTrack.Language ## -description Gets or sets a string indicating the language of the media track. ## -property-value A string indicating the language of the media track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaTrack.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaTrack.Language + +## -description +Gets or sets a string indicating the language of the media track. + +## -property-value +A string indicating the language of the media track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/imediatrack_trackkind.md b/windows.media.core/imediatrack_trackkind.md index 547d1304de..7370bde95b 100644 --- a/windows.media.core/imediatrack_trackkind.md +++ b/windows.media.core/imediatrack_trackkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.IMediaTrack.TrackKind --api-type: winrt property ---- # Windows.Media.Core.IMediaTrack.TrackKind ## -description Gets a value indicating the type of data the track contains. ## -property-value A value indicating the type of data the track contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.IMediaTrack.TrackKind +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaTrack.TrackKind + +## -description +Gets a value indicating the type of data the track contains. + +## -property-value +A value indicating the type of data the track contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/isingleselectmediatracklist_selectedindex.md b/windows.media.core/isingleselectmediatracklist_selectedindex.md index dd7a0e0294..2e7c4f1584 100644 --- a/windows.media.core/isingleselectmediatracklist_selectedindex.md +++ b/windows.media.core/isingleselectmediatracklist_selectedindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndex --api-type: winrt property ---- # Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndex ## -description Gets or set the currently selected media track in the list. ## -property-value The currently selected media track in the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndex +-api-type: winrt property +--- + + + +# Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndex + +## -description +Gets or set the currently selected media track in the list. + +## -property-value +The currently selected media track in the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/isingleselectmediatracklist_selectedindexchanged.md b/windows.media.core/isingleselectmediatracklist_selectedindexchanged.md index 73607490f2..6566a9f64d 100644 --- a/windows.media.core/isingleselectmediatracklist_selectedindexchanged.md +++ b/windows.media.core/isingleselectmediatracklist_selectedindexchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndexChanged --api-type: winrt event ---- # Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndexChanged ## -description Occurs when the [SelectedIndex](isingleselectmediatracklist_selectedindex.md) property changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndexChanged +-api-type: winrt event +--- + + + +# Windows.Media.Core.ISingleSelectMediaTrackList.SelectedIndexChanged + +## -description +Occurs when the [SelectedIndex](isingleselectmediatracklist_selectedindex.md) property changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabinder.md b/windows.media.core/mediabinder.md index a341a5a44d..213ad882c8 100644 --- a/windows.media.core/mediabinder.md +++ b/windows.media.core/mediabinder.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaBinder --api-type: winrt class ---- # Windows.Media.Core.MediaBinder ## -description Enables deferred binding of media content associated with a [MediaSource](mediasource.md). Use this class for media content that you don't want to bind to a **MediaSource** object until a media player is about to actually play the content. A typical scenario for this is playing content that requires payment when it is accessed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaBinder +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaBinder + +## -description +Enables deferred binding of media content associated with a [MediaSource](mediasource.md). + +Use this class for media content that you don't want to bind to a **MediaSource** object until a media player is about to actually play the content. A typical scenario for this is playing content that requires payment when it is accessed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabinder_binding.md b/windows.media.core/mediabinder_binding.md index f9f1a2e13b..1c899fa774 100644 --- a/windows.media.core/mediabinder_binding.md +++ b/windows.media.core/mediabinder_binding.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MediaBinder.Binding --api-type: winrt event ---- # Windows.Media.Core.MediaBinder.Binding ## -description Occurs when a media player is ready for the media content to be bound to a [MediaSource](mediasource.md). Use the handler for this to set the media content for the source by calling [SetStream](mediabindingeventargs_setstream.md), [SetStreamReference](mediabindingeventargs_setstreamreference.md), or [SetUri](mediabindingeventargs_seturi.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaBinder.Binding +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaBinder.Binding + +## -description +Occurs when a media player is ready for the media content to be bound to a [MediaSource](mediasource.md). Use the handler for this to set the media content for the source by calling [SetStream](mediabindingeventargs_setstream.md), [SetStreamReference](mediabindingeventargs_setstreamreference.md), or [SetUri](mediabindingeventargs_seturi.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabinder_mediabinder_1221375020.md b/windows.media.core/mediabinder_mediabinder_1221375020.md index bc4e049b59..b90fcd25c1 100644 --- a/windows.media.core/mediabinder_mediabinder_1221375020.md +++ b/windows.media.core/mediabinder_mediabinder_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MediaBinder.#ctor --api-type: winrt method ---- # Windows.Media.Core.MediaBinder.MediaBinder ## -description Initializes a new instance of the [MediaBinder](mediabinder.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaBinder.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBinder.MediaBinder + +## -description +Initializes a new instance of the [MediaBinder](mediabinder.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabinder_source.md b/windows.media.core/mediabinder_source.md index 84cbaa4a50..0ded0536a1 100644 --- a/windows.media.core/mediabinder_source.md +++ b/windows.media.core/mediabinder_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaBinder.Source --api-type: winrt property ---- # Windows.Media.Core.MediaBinder.Source ## -description Gets the [MediaSource](mediasource.md) object associated with the [MediaBinder](mediabinder.md). ## -property-value The [MediaSource](mediasource.md) object associated with the [MediaBinder](mediabinder.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaBinder.Source +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaBinder.Source + +## -description +Gets the [MediaSource](mediasource.md) object associated with the [MediaBinder](mediabinder.md). + +## -property-value +The [MediaSource](mediasource.md) object associated with the [MediaBinder](mediabinder.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabinder_token.md b/windows.media.core/mediabinder_token.md index cc86f82b01..3ef6337408 100644 --- a/windows.media.core/mediabinder_token.md +++ b/windows.media.core/mediabinder_token.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaBinder.Token --api-type: winrt property ---- # Windows.Media.Core.MediaBinder.Token ## -description Gets or sets an app-specified string that is used to identify the media content that the app should bind when the [Binding](mediabinder_binding.md) event is raised. ## -property-value An app-specified string that is used to identify the specific media content that the app should bind. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaBinder.Token +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaBinder.Token + +## -description +Gets or sets an app-specified string that is used to identify the media content that the app should bind when the [Binding](mediabinder_binding.md) event is raised. + +## -property-value +An app-specified string that is used to identify the specific media content that the app should bind. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs.md b/windows.media.core/mediabindingeventargs.md index 3f08e8b3cd..a747df03d8 100644 --- a/windows.media.core/mediabindingeventargs.md +++ b/windows.media.core/mediabindingeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.MediaBindingEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaBindingEventArgs ## -description Provides data for the [Binding](mediabinder_binding.md) event and methods for binding media content to the associated [MediaSource](mediasource.md). ## -remarks Get an instance of this class by handling the [Binding](mediabinder_binding.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaBindingEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaBindingEventArgs + +## -description +Provides data for the [Binding](mediabinder_binding.md) event and methods for binding media content to the associated [MediaSource](mediasource.md). + +## -remarks +Get an instance of this class by handling the [Binding](mediabinder_binding.md) event. + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs_canceled.md b/windows.media.core/mediabindingeventargs_canceled.md index e6b258f09e..f8611d1c3c 100644 --- a/windows.media.core/mediabindingeventargs_canceled.md +++ b/windows.media.core/mediabindingeventargs_canceled.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MediaBindingEventArgs.Canceled --api-type: winrt event ---- # Windows.Media.Core.MediaBindingEventArgs.Canceled ## -description Occurs when the binding operation is cancelled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaBindingEventArgs.Canceled +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.Canceled + +## -description +Occurs when the binding operation is cancelled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs_getdeferral_254836512.md b/windows.media.core/mediabindingeventargs_getdeferral_254836512.md index c169392e7d..8d71ddca28 100644 --- a/windows.media.core/mediabindingeventargs_getdeferral_254836512.md +++ b/windows.media.core/mediabindingeventargs_getdeferral_254836512.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Core.MediaBindingEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Core.MediaBindingEventArgs.GetDeferral ## -description Informs the system that the app might continue to perform work after the [Binding](mediabinder_binding.md) event handler returns. ## -returns The requested deferral. ## -remarks Since retrieving and binding the media content may take a significant amount of time, this should typically be performed asynchronously. Requesting a deferral lets the system know that your app is continuing to perform asynchronous work after the [Binding](mediabinder_binding.md) event handler has returned. Call the [Complete](../windows.foundation/deferral_complete.md) method when your binding operation is finished. Subscribe to the [Canceled](mediabindingeventargs_canceled.md) event to be alerted by the system if the binding operation should be canceled. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.GetDeferral + +## -description +Informs the system that the app might continue to perform work after the [Binding](mediabinder_binding.md) event handler returns. + +## -returns +The requested deferral. + +## -remarks +Since retrieving and binding the media content may take a significant amount of time, this should typically be performed asynchronously. Requesting a deferral lets the system know that your app is continuing to perform asynchronous work after the [Binding](mediabinder_binding.md) event handler has returned. Call the [Complete](../windows.foundation/deferral_complete.md) method when your binding operation is finished. + +Subscribe to the [Canceled](mediabindingeventargs_canceled.md) event to be alerted by the system if the binding operation should be canceled. + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs_mediabinder.md b/windows.media.core/mediabindingeventargs_mediabinder.md index f10445d1b5..a5d153af11 100644 --- a/windows.media.core/mediabindingeventargs_mediabinder.md +++ b/windows.media.core/mediabindingeventargs_mediabinder.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaBindingEventArgs.MediaBinder --api-type: winrt property ---- # Windows.Media.Core.MediaBindingEventArgs.MediaBinder ## -description Gets the [MediaBinder](mediabinder.md) associated with the binding event. ## -property-value The [MediaBinder](mediabinder.md) associated with the binding event. ## -remarks Use the [Token](mediabinder_token.md) property of the **MediaBinder** to determine what media content should be bound. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaBindingEventArgs.MediaBinder +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.MediaBinder + +## -description +Gets the [MediaBinder](mediabinder.md) associated with the binding event. + +## -property-value +The [MediaBinder](mediabinder.md) associated with the binding event. + +## -remarks +Use the [Token](mediabinder_token.md) property of the **MediaBinder** to determine what media content should be bound. + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs_setstream_1882746634.md b/windows.media.core/mediabindingeventargs_setstream_1882746634.md index 8a474d726d..2872793e29 100644 --- a/windows.media.core/mediabindingeventargs_setstream_1882746634.md +++ b/windows.media.core/mediabindingeventargs_setstream_1882746634.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStream(Windows.Storage.Streams.IRandomAccessStream,System.String) --api-type: winrt method ---- # Windows.Media.Core.MediaBindingEventArgs.SetStream ## -description Sets the media content to be bound to the [MediaSource](mediasource.md). ## -parameters ### -param stream A stream containing the media content. ### -param contentType A string specifying the content type of the media content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStream(Windows.Storage.Streams.IRandomAccessStream,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.SetStream + +## -description +Sets the media content to be bound to the [MediaSource](mediasource.md). + +## -parameters +### -param stream +A stream containing the media content. + +### -param contentType +A string specifying the content type of the media content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md b/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md index 6a8665aa22..ecdafd6016 100644 --- a/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md +++ b/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStreamReference(Windows.Storage.Streams.IRandomAccessStreamReference,System.String) --api-type: winrt method ---- # Windows.Media.Core.MediaBindingEventArgs.SetStreamReference ## -description Sets the media content to be bound to the [MediaSource](mediasource.md). ## -parameters ### -param stream A stream reference containing the media content to be bound. ### -param contentType A string specifying the content type of the media content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStreamReference(Windows.Storage.Streams.IRandomAccessStreamReference,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.SetStreamReference + +## -description +Sets the media content to be bound to the [MediaSource](mediasource.md). + +## -parameters +### -param stream +A stream reference containing the media content to be bound. + +### -param contentType +A string specifying the content type of the media content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediabindingeventargs_seturi_1576665843.md b/windows.media.core/mediabindingeventargs_seturi_1576665843.md index bba893c511..cf80693f22 100644 --- a/windows.media.core/mediabindingeventargs_seturi_1576665843.md +++ b/windows.media.core/mediabindingeventargs_seturi_1576665843.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetUri(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.Media.Core.MediaBindingEventArgs.SetUri ## -description Sets the URI of the media content to be bound to the [MediaSource](mediasource.md). ## -parameters ### -param uri The URI of the media content to be bound. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetUri(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.SetUri + +## -description +Sets the URI of the media content to be bound to the [MediaSource](mediasource.md). + +## -parameters +### -param uri +The URI of the media content to be bound. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediacueeventargs.md b/windows.media.core/mediacueeventargs.md index d3c456bd92..88eeeece94 100644 --- a/windows.media.core/mediacueeventargs.md +++ b/windows.media.core/mediacueeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaCueEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaCueEventArgs ## -description Provides data for the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) and [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) events. ## -remarks Get an instance of this class by handling the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) or [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) events. ## -examples ## -see-also [IMediaCueEventArgs](imediacueeventargs.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaCueEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaCueEventArgs + +## -description +Provides data for the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) and [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) events. + +## -remarks +Get an instance of this class by handling the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) or [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) events. + +## -examples + +## -see-also +[IMediaCueEventArgs](imediacueeventargs.md) \ No newline at end of file diff --git a/windows.media.core/mediacueeventargs_cue.md b/windows.media.core/mediacueeventargs_cue.md index 5556813c1f..214cdefc5a 100644 --- a/windows.media.core/mediacueeventargs_cue.md +++ b/windows.media.core/mediacueeventargs_cue.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaCueEventArgs.Cue --api-type: winrt property ---- # Windows.Media.Core.MediaCueEventArgs.Cue ## -description Gets the cue that triggered the event. ## -property-value The cue that triggered the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaCueEventArgs.Cue +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaCueEventArgs.Cue + +## -description +Gets the cue that triggered the event. + +## -property-value +The cue that triggered the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource.md b/windows.media.core/mediasource.md index f0266c742b..023735faa3 100644 --- a/windows.media.core/mediasource.md +++ b/windows.media.core/mediasource.md @@ -1,3 +1,33 @@ ---- -api-id: T:Windows.Media.Core.MediaSource --api-type: winrt class ---- # Windows.Media.Core.MediaSource ## -description Represents a media source. Provides a common way to reference media from different sources and exposes a common model for accessing media data regardless of the underlying media format. ## -remarks Using one of the factory methods, you can create an instance of [MediaSource](mediasource.md) from many different media source representations, including: + [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md) + [MediaStreamSource](mediastreamsource.md) + [MseStreamSource](msestreamsource.md) + [IStorageFile](../windows.storage/istoragefile.md) + [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) + [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) + [Uri](../windows.foundation/uri.md) After getting a [MediaSource](mediasource.md) instance, create a new [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) wrapping the media source and pass the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) to one of the media playback objects, such as [MediaPlayer](../windows.media.playback/mediaplayer.md) or [MediaElement](../windows.ui.xaml.controls/mediaelement.md). For how-to guidance for using **MediaSource** to play back media, see [Media items, playlists, and tracks](http://www.thecrocodile.com/event/1265083-pere-ubu-coed-jail-songs-seattle/). ## -examples ## -see-also [Media items, playlists, and tracks](http://www.thecrocodile.com/event/1265083-pere-ubu-coed-jail-songs-seattle/), [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaSource +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaSource + +## -description +Represents a media source. Provides a common way to reference media from different sources and exposes a common model for accessing media data regardless of the underlying media format. + +## -remarks +Using one of the factory methods, you can create an instance of [MediaSource](mediasource.md) from many different media source representations, including: ++ [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md) ++ [MediaStreamSource](mediastreamsource.md) ++ [MseStreamSource](msestreamsource.md) ++ [IStorageFile](../windows.storage/istoragefile.md) ++ [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) ++ [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) ++ [Uri](../windows.foundation/uri.md) + + +After getting a [MediaSource](mediasource.md) instance, create a new [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) wrapping the media source and pass the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) to one of the media playback objects, such as [MediaPlayer](../windows.media.playback/mediaplayer.md) or [MediaElement](../windows.ui.xaml.controls/mediaelement.md). + +For how-to guidance for using **MediaSource** to play back media, see [Media items, playlists, and tracks](http://www.thecrocodile.com/event/1265083-pere-ubu-coed-jail-songs-seattle/). + +## -examples + +## -see-also +[Media items, playlists, and tracks](http://www.thecrocodile.com/event/1265083-pere-ubu-coed-jail-songs-seattle/), [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) \ No newline at end of file diff --git a/windows.media.core/mediasource_close_811482585.md b/windows.media.core/mediasource_close_811482585.md index 6b71cb1389..bad4a7a7ae 100644 --- a/windows.media.core/mediasource_close_811482585.md +++ b/windows.media.core/mediasource_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.Close --api-type: winrt method ---- # Windows.Media.Core.MediaSource.Close ## -description Closes the [MediaSource](mediasource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.Close +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.Close + +## -description +Closes the [MediaSource](mediasource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfromadaptivemediasource_72177825.md b/windows.media.core/mediasource_createfromadaptivemediasource_72177825.md index fedb8bb971..38e531b19d 100644 --- a/windows.media.core/mediasource_createfromadaptivemediasource_72177825.md +++ b/windows.media.core/mediasource_createfromadaptivemediasource_72177825.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromAdaptiveMediaSource(Windows.Media.Streaming.Adaptive.AdaptiveMediaSource) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromAdaptiveMediaSource ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md). ## -parameters ### -param mediaSource The [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md) from which the [MediaSource](mediasource.md) is created. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromAdaptiveMediaSource(Windows.Media.Streaming.Adaptive.AdaptiveMediaSource) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromAdaptiveMediaSource + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md). + +## -parameters +### -param mediaSource +The [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md) from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfromimediasource_54024762.md b/windows.media.core/mediasource_createfromimediasource_54024762.md index a6d6965cf2..50c1e73598 100644 --- a/windows.media.core/mediasource_createfromimediasource_54024762.md +++ b/windows.media.core/mediasource_createfromimediasource_54024762.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromIMediaSource(Windows.Media.Core.IMediaSource) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromIMediaSource ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [IMediaSource](imediasource.md). ## -parameters ### -param mediaSource The [IMediaSource](imediasource.md) from which the [MediaSource](mediasource.md) is created. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromIMediaSource(Windows.Media.Core.IMediaSource) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromIMediaSource + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [IMediaSource](imediasource.md). + +## -parameters +### -param mediaSource +The [IMediaSource](imediasource.md) from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfrommediabinder_1288152866.md b/windows.media.core/mediasource_createfrommediabinder_1288152866.md index 1650336b72..436eab7c4a 100644 --- a/windows.media.core/mediasource_createfrommediabinder_1288152866.md +++ b/windows.media.core/mediasource_createfrommediabinder_1288152866.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromMediaBinder(Windows.Media.Core.MediaBinder) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromMediaBinder ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [MediaBinder](mediabinder.md). ## -parameters ### -param binder The [MediaBinder](mediabinder.md) with which the **MediaSource** is associated. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromMediaBinder(Windows.Media.Core.MediaBinder) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromMediaBinder + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [MediaBinder](mediabinder.md). + +## -parameters +### -param binder +The [MediaBinder](mediabinder.md) with which the **MediaSource** is associated. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfrommediastreamsource_1520732304.md b/windows.media.core/mediasource_createfrommediastreamsource_1520732304.md index dd9fb01539..1d536c1ff7 100644 --- a/windows.media.core/mediasource_createfrommediastreamsource_1520732304.md +++ b/windows.media.core/mediasource_createfrommediastreamsource_1520732304.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromMediaStreamSource(Windows.Media.Core.MediaStreamSource) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromMediaStreamSource ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [MediaStreamSource](mediastreamsource.md). ## -parameters ### -param mediaSource The [MediaStreamSource](mediastreamsource.md) from which the [MediaSource](mediasource.md) is created. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromMediaStreamSource(Windows.Media.Core.MediaStreamSource) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromMediaStreamSource + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [MediaStreamSource](mediastreamsource.md). + +## -parameters +### -param mediaSource +The [MediaStreamSource](mediastreamsource.md) from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfrommsestreamsource_164371092.md b/windows.media.core/mediasource_createfrommsestreamsource_164371092.md index a9fc750de6..968e37d604 100644 --- a/windows.media.core/mediasource_createfrommsestreamsource_164371092.md +++ b/windows.media.core/mediasource_createfrommsestreamsource_164371092.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromMseStreamSource(Windows.Media.Core.MseStreamSource) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromMseStreamSource ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [MseStreamSource](msestreamsource.md). ## -parameters ### -param mediaSource The [MediaStreamSource](mediastreamsource.md) from which the [MediaSource](mediasource.md) is created. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromMseStreamSource(Windows.Media.Core.MseStreamSource) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromMseStreamSource + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [MseStreamSource](msestreamsource.md). + +## -parameters +### -param mediaSource +The [MediaStreamSource](mediastreamsource.md) from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfromstoragefile_1157602132.md b/windows.media.core/mediasource_createfromstoragefile_1157602132.md index 1168edf8b6..b7a7c98d2b 100644 --- a/windows.media.core/mediasource_createfromstoragefile_1157602132.md +++ b/windows.media.core/mediasource_createfromstoragefile_1157602132.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromStorageFile(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromStorageFile ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [IStorageFile](../windows.storage/istoragefile.md). ## -parameters ### -param file The [IStorageFile](../windows.storage/istoragefile.md) from which the [MediaSource](mediasource.md) is created. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromStorageFile(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromStorageFile + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [IStorageFile](../windows.storage/istoragefile.md). + +## -parameters +### -param file +The [IStorageFile](../windows.storage/istoragefile.md) from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfromstream_983868770.md b/windows.media.core/mediasource_createfromstream_983868770.md index 33463745bb..7e1e42a9c7 100644 --- a/windows.media.core/mediasource_createfromstream_983868770.md +++ b/windows.media.core/mediasource_createfromstream_983868770.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromStream(Windows.Storage.Streams.IRandomAccessStream,System.String) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromStream ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md). ## -parameters ### -param stream The stream from which the [MediaSource](mediasource.md) is created. ### -param contentType The MIME type of the contents of the stream. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromStream(Windows.Storage.Streams.IRandomAccessStream,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromStream + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md). + +## -parameters +### -param stream +The stream from which the [MediaSource](mediasource.md) is created. + +### -param contentType +The MIME type of the contents of the stream. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfromstreamreference_1167212796.md b/windows.media.core/mediasource_createfromstreamreference_1167212796.md index f2dc46e7a4..f2eba75048 100644 --- a/windows.media.core/mediasource_createfromstreamreference_1167212796.md +++ b/windows.media.core/mediasource_createfromstreamreference_1167212796.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromStreamReference(Windows.Storage.Streams.IRandomAccessStreamReference,System.String) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromStreamReference ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md). ## -parameters ### -param stream The stream reference from which the [MediaSource](mediasource.md) is created. ### -param contentType The MIME type of the contents of the stream. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromStreamReference(Windows.Storage.Streams.IRandomAccessStreamReference,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromStreamReference + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md). + +## -parameters +### -param stream +The stream reference from which the [MediaSource](mediasource.md) is created. + +### -param contentType +The MIME type of the contents of the stream. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_createfromuri_407037831.md b/windows.media.core/mediasource_createfromuri_407037831.md index 7de0b6719a..1f6b1bfd00 100644 --- a/windows.media.core/mediasource_createfromuri_407037831.md +++ b/windows.media.core/mediasource_createfromuri_407037831.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.CreateFromUri(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.Media.Core.MediaSource.CreateFromUri ## -description Creates an instance of [MediaSource](mediasource.md) from the provided [Uri](../windows.foundation/uri.md). ## -parameters ### -param uri The URI from which the [MediaSource](mediasource.md) is created. ## -returns The new media source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromUri(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromUri + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [Uri](../windows.foundation/uri.md). + +## -parameters +### -param uri +The URI from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_customproperties.md b/windows.media.core/mediasource_customproperties.md index 173c615a47..df495f4a45 100644 --- a/windows.media.core/mediasource_customproperties.md +++ b/windows.media.core/mediasource_customproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSource.CustomProperties --api-type: winrt property ---- # Windows.Media.Core.MediaSource.CustomProperties ## -description Gets a set of properties that can be used to associate app-specific data with a [MediaSource](mediasource.md). ## -property-value A set of properties that can be used to associate app-specific data with a [MediaSource](mediasource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSource.CustomProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.CustomProperties + +## -description +Gets a set of properties that can be used to associate app-specific data with a [MediaSource](mediasource.md). + +## -property-value +A set of properties that can be used to associate app-specific data with a [MediaSource](mediasource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_duration.md b/windows.media.core/mediasource_duration.md index c5ee5efb85..4698a1ff4e 100644 --- a/windows.media.core/mediasource_duration.md +++ b/windows.media.core/mediasource_duration.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaSource.Duration --api-type: winrt property ---- # Windows.Media.Core.MediaSource.Duration ## -description Gets the duration of the content in the [MediaSource](mediasource.md). ## -property-value The duration of the content in the [MediaSource](mediasource.md). ## -remarks Adaptive sources can support multiple periods or discontinuities that contribute to the overall presentation timeline. The **Duration** property represents this complete presentation timeline. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSource.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.Duration + +## -description +Gets the duration of the content in the [MediaSource](mediasource.md). + +## -property-value +The duration of the content in the [MediaSource](mediasource.md). + +## -remarks +Adaptive sources can support multiple periods or discontinuities that contribute to the overall presentation timeline. The **Duration** property represents this complete presentation timeline. + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_externaltimedmetadatatracks.md b/windows.media.core/mediasource_externaltimedmetadatatracks.md index eafa7fa7e8..4128df50fd 100644 --- a/windows.media.core/mediasource_externaltimedmetadatatracks.md +++ b/windows.media.core/mediasource_externaltimedmetadatatracks.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaSource.ExternalTimedMetadataTracks --api-type: winrt property ---- # Windows.Media.Core.MediaSource.ExternalTimedMetadataTracks ## -description A collection of external timed metadata tracks associated with the [MediaSource](mediasource.md). ## -property-value The collection of external timed metadata tracks. ## -remarks You can generate [TimedMetadataTrack](timedmetadatatrack.md) objects in code and add them to this collection directly, or you can create a [TimedTextSource](timedtextsource.md) from a URL or stream and use the [ExternalTimedTextSources](mediasource_externaltimedtextsources.md) property to populate the collection. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSource.ExternalTimedMetadataTracks +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.ExternalTimedMetadataTracks + +## -description +A collection of external timed metadata tracks associated with the [MediaSource](mediasource.md). + +## -property-value +The collection of external timed metadata tracks. + +## -remarks +You can generate [TimedMetadataTrack](timedmetadatatrack.md) objects in code and add them to this collection directly, or you can create a [TimedTextSource](timedtextsource.md) from a URL or stream and use the [ExternalTimedTextSources](mediasource_externaltimedtextsources.md) property to populate the collection. + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_externaltimedtextsources.md b/windows.media.core/mediasource_externaltimedtextsources.md index 9432716ef1..96c205bb3a 100644 --- a/windows.media.core/mediasource_externaltimedtextsources.md +++ b/windows.media.core/mediasource_externaltimedtextsources.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.MediaSource.ExternalTimedTextSources --api-type: winrt property ---- # Windows.Media.Core.MediaSource.ExternalTimedTextSources ## -description A collection of external timed text sources associated with the [MediaSource](mediasource.md). ## -property-value The collection of external timed text sources. ## -remarks You can create a [TimedTextSource](timedtextsource.md) from a URL or stream and then set this property to populate the [ExternalTimedMetadataTracks](mediasource_externaltimedmetadatatracks.md) collection, or you can generate [TimedMetadataTrack](timedmetadatatrack.md) objects in code and add them to tthe [ExternalTimedMetadataTracks](mediasource_externaltimedmetadatatracks.md) collection directly. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSource.ExternalTimedTextSources +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.ExternalTimedTextSources + +## -description +A collection of external timed text sources associated with the [MediaSource](mediasource.md). + +## -property-value +The collection of external timed text sources. + +## -remarks +You can create a [TimedTextSource](timedtextsource.md) from a URL or stream and then set this property to populate the [ExternalTimedMetadataTracks](mediasource_externaltimedmetadatatracks.md) collection, or you can generate [TimedMetadataTrack](timedmetadatatrack.md) objects in code and add them to tthe [ExternalTimedMetadataTracks](mediasource_externaltimedmetadatatracks.md) collection directly. + + + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_isopen.md b/windows.media.core/mediasource_isopen.md index bf5bead2dd..002819bc8b 100644 --- a/windows.media.core/mediasource_isopen.md +++ b/windows.media.core/mediasource_isopen.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSource.IsOpen --api-type: winrt property ---- # Windows.Media.Core.MediaSource.IsOpen ## -description Gets a value indicating whether the media source is currently open. ## -property-value True if the media source is open; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSource.IsOpen +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.IsOpen + +## -description +Gets a value indicating whether the media source is currently open. + +## -property-value +True if the media source is open; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_openoperationcompleted.md b/windows.media.core/mediasource_openoperationcompleted.md index 88a03433ba..14768807d4 100644 --- a/windows.media.core/mediasource_openoperationcompleted.md +++ b/windows.media.core/mediasource_openoperationcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MediaSource.OpenOperationCompleted --api-type: winrt event ---- # Windows.Media.Core.MediaSource.OpenOperationCompleted ## -description Occurs when a [MediaSource](mediasource.md) open operation completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaSource.OpenOperationCompleted +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaSource.OpenOperationCompleted + +## -description +Occurs when a [MediaSource](mediasource.md) open operation completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_reset_1636126115.md b/windows.media.core/mediasource_reset_1636126115.md index e12b9a25bc..88da385d6e 100644 --- a/windows.media.core/mediasource_reset_1636126115.md +++ b/windows.media.core/mediasource_reset_1636126115.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Core.MediaSource.Reset --api-type: winrt method ---- # Windows.Media.Core.MediaSource.Reset ## -description Resets the internal state of the [MediaSource](mediasource.md). ## -remarks After **Reset** is called, the **MediaSource** will be reopened the next time it is used. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaSource.Reset +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.Reset + +## -description +Resets the internal state of the [MediaSource](mediasource.md). + +## -remarks +After **Reset** is called, the **MediaSource** will be reopened the next time it is used. + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_state.md b/windows.media.core/mediasource_state.md index 1d4d34b3a6..e21d9c283a 100644 --- a/windows.media.core/mediasource_state.md +++ b/windows.media.core/mediasource_state.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSource.State --api-type: winrt property ---- # Windows.Media.Core.MediaSource.State ## -description Gets the current state of the [MediaSource](mediasource.md). ## -property-value The current state of the [MediaSource](mediasource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSource.State +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.State + +## -description +Gets the current state of the [MediaSource](mediasource.md). + +## -property-value +The current state of the [MediaSource](mediasource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasource_statechanged.md b/windows.media.core/mediasource_statechanged.md index b31bf4fa6d..8b54ddf46f 100644 --- a/windows.media.core/mediasource_statechanged.md +++ b/windows.media.core/mediasource_statechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MediaSource.StateChanged --api-type: winrt event ---- # Windows.Media.Core.MediaSource.StateChanged ## -description Occurs when the current state of the [MediaSource](mediasource.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaSource.StateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaSource.StateChanged + +## -description +Occurs when the current state of the [MediaSource](mediasource.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourceerror.md b/windows.media.core/mediasourceerror.md index c0ab1562a2..fe84eaf6f9 100644 --- a/windows.media.core/mediasourceerror.md +++ b/windows.media.core/mediasourceerror.md @@ -1,3 +1,24 @@ ---- -api-id: T:Windows.Media.Core.MediaSourceError --api-type: winrt class ---- # Windows.Media.Core.MediaSourceError ## -description Represents an error that occurred with a [MediaSource](mediasource.md). ## -remarks Get an instance of this class by accessing one of the following properties: + [MediaSourceOpenCompletedEventArgs.Error](mediasourceopencompletedeventargs_error.md) + [TimedMetadataTrackErrorEventArgs.Error](timedmetadatatrackerroreventargs_error.md) + [TimedTextSourceResolveResultEventArgs.Error](timedtextsourceresolveresulteventargs_error.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaSourceError +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaSourceError + +## -description +Represents an error that occurred with a [MediaSource](mediasource.md). + +## -remarks +Get an instance of this class by accessing one of the following properties: ++ [MediaSourceOpenCompletedEventArgs.Error](mediasourceopencompletedeventargs_error.md) ++ [TimedMetadataTrackErrorEventArgs.Error](timedmetadatatrackerroreventargs_error.md) ++ [TimedTextSourceResolveResultEventArgs.Error](timedtextsourceresolveresulteventargs_error.md) + + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourceerror_extendederror.md b/windows.media.core/mediasourceerror_extendederror.md index 6a67d984a3..5aacf5155e 100644 --- a/windows.media.core/mediasourceerror_extendederror.md +++ b/windows.media.core/mediasourceerror_extendederror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSourceError.ExtendedError --api-type: winrt property ---- # Windows.Media.Core.MediaSourceError.ExtendedError ## -description Gets the extended error code for the [MediaSourceError](mediasourceerror.md). ## -property-value The extended error code for the [MediaSourceError](mediasourceerror.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSourceError.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSourceError.ExtendedError + +## -description +Gets the extended error code for the [MediaSourceError](mediasourceerror.md). + +## -property-value +The extended error code for the [MediaSourceError](mediasourceerror.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourceopenoperationcompletedeventargs.md b/windows.media.core/mediasourceopenoperationcompletedeventargs.md index 1131de0eec..f4024b7eef 100644 --- a/windows.media.core/mediasourceopenoperationcompletedeventargs.md +++ b/windows.media.core/mediasourceopenoperationcompletedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs ## -description Provides data for the [MediaSource.MediaSourceOpenOperationCompleted](mediasourceopenoperationcompletedeventargs.md) event. ## -remarks Get an instance of this class by handling the [MediaSource.MediaSourceOpenOperationCompleted](mediasourceopenoperationcompletedeventargs.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs + +## -description +Provides data for the [MediaSource.MediaSourceOpenOperationCompleted](mediasourceopenoperationcompletedeventargs.md) event. + +## -remarks +Get an instance of this class by handling the [MediaSource.MediaSourceOpenOperationCompleted](mediasourceopenoperationcompletedeventargs.md) event. + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourceopenoperationcompletedeventargs_error.md b/windows.media.core/mediasourceopenoperationcompletedeventargs_error.md index 0fcec34d2a..8a4cde7754 100644 --- a/windows.media.core/mediasourceopenoperationcompletedeventargs_error.md +++ b/windows.media.core/mediasourceopenoperationcompletedeventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs.Error --api-type: winrt property ---- # Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs.Error ## -description Represents the error that occurred while asynchronously opening the [MediaSource](mediasource.md). ## -property-value The error that occurred while asynchronously opening the [MediaSource](mediasource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSourceOpenOperationCompletedEventArgs.Error + +## -description +Represents the error that occurred while asynchronously opening the [MediaSource](mediasource.md). + +## -property-value +The error that occurred while asynchronously opening the [MediaSource](mediasource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourcestatechangedeventargs.md b/windows.media.core/mediasourcestatechangedeventargs.md index e48f126ea7..526b6040aa 100644 --- a/windows.media.core/mediasourcestatechangedeventargs.md +++ b/windows.media.core/mediasourcestatechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.MediaSourceStateChangedEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaSourceStateChangedEventArgs ## -description Provides data for the [StateChanged](mediasource_statechanged.md) event of a [MediaSource](mediasource.md) object. ## -remarks Get an instance of this class by handling the [StateChanged](mediasource_statechanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaSourceStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaSourceStateChangedEventArgs + +## -description +Provides data for the [StateChanged](mediasource_statechanged.md) event of a [MediaSource](mediasource.md) object. + +## -remarks +Get an instance of this class by handling the [StateChanged](mediasource_statechanged.md) event. + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourcestatechangedeventargs_newstate.md b/windows.media.core/mediasourcestatechangedeventargs_newstate.md index 51b6651379..9f0fe48d17 100644 --- a/windows.media.core/mediasourcestatechangedeventargs_newstate.md +++ b/windows.media.core/mediasourcestatechangedeventargs_newstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSourceStateChangedEventArgs.NewState --api-type: winrt property ---- # Windows.Media.Core.MediaSourceStateChangedEventArgs.NewState ## -description Gets the new current state of the [MediaSource](mediasource.md). ## -property-value The new current state of the [MediaSource](mediasource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSourceStateChangedEventArgs.NewState +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSourceStateChangedEventArgs.NewState + +## -description +Gets the new current state of the [MediaSource](mediasource.md). + +## -property-value +The new current state of the [MediaSource](mediasource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediasourcestatechangedeventargs_oldstate.md b/windows.media.core/mediasourcestatechangedeventargs_oldstate.md index 9df1fcb804..2667452a1a 100644 --- a/windows.media.core/mediasourcestatechangedeventargs_oldstate.md +++ b/windows.media.core/mediasourcestatechangedeventargs_oldstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaSourceStateChangedEventArgs.OldState --api-type: winrt property ---- # Windows.Media.Core.MediaSourceStateChangedEventArgs.OldState ## -description Gets the previous state of the [MediaSource](mediasource.md) before the state changed. ## -property-value The previous state of the [MediaSource](mediasource.md) before the state changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaSourceStateChangedEventArgs.OldState +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSourceStateChangedEventArgs.OldState + +## -description +Gets the previous state of the [MediaSource](mediasource.md) before the state changed. + +## -property-value +The previous state of the [MediaSource](mediasource.md) before the state changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample.md b/windows.media.core/mediastreamsample.md index c6f528318d..00f033c745 100644 --- a/windows.media.core/mediastreamsample.md +++ b/windows.media.core/mediastreamsample.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSample --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSample ## -description Represents a media sample used by the [MediaStreamSource](mediastreamsource.md). ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSample +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSample + +## -description +Represents a media sample used by the [MediaStreamSource](mediastreamsource.md). + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsample_buffer.md b/windows.media.core/mediastreamsample_buffer.md index b6195f5441..e052c5ebb6 100644 --- a/windows.media.core/mediastreamsample_buffer.md +++ b/windows.media.core/mediastreamsample_buffer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.Buffer --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.Buffer ## -description Gets the buffer which encapsulates the [MediaStreamSample](mediastreamsample.md) data. ## -property-value The buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.Buffer +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.Buffer + +## -description +Gets the buffer which encapsulates the [MediaStreamSample](mediastreamsample.md) data. + +## -property-value +The buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_createfrombuffer_2007854167.md b/windows.media.core/mediastreamsample_createfrombuffer_2007854167.md index 16c1ea47dc..08732c11a7 100644 --- a/windows.media.core/mediastreamsample_createfrombuffer_2007854167.md +++ b/windows.media.core/mediastreamsample_createfrombuffer_2007854167.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSample.CreateFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSample.CreateFromBuffer ## -description Creates a [MediaStreamSample](mediastreamsample.md) from an [IBuffer](http://msdn.microsoft.com/library/6c3bde9b-d354-48f8-b7f6-517df14202c0). ## -parameters ### -param buffer The buffer that contains the media data used to create the [MediaStreamSample](mediastreamsample.md). ### -param timestamp The presentation time of this sample. ## -returns The sample created from the data in *buffer*. ## -remarks For certain formats, the decode time and the presentation time of a [MediaStreamSample](mediastreamsample.md) are different. The decode time can be accessed through the [DecodeTimestamp](mediastreamsample_decodetimestamp.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSample.CreateFromBuffer(Windows.Storage.Streams.IBuffer,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSample.CreateFromBuffer + +## -description +Creates a [MediaStreamSample](mediastreamsample.md) from an [IBuffer](http://msdn.microsoft.com/library/6c3bde9b-d354-48f8-b7f6-517df14202c0). + +## -parameters +### -param buffer +The buffer that contains the media data used to create the [MediaStreamSample](mediastreamsample.md). + +### -param timestamp +The presentation time of this sample. + +## -returns +The sample created from the data in *buffer*. + +## -remarks +For certain formats, the decode time and the presentation time of a [MediaStreamSample](mediastreamsample.md) are different. The decode time can be accessed through the [DecodeTimestamp](mediastreamsample_decodetimestamp.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_createfromstreamasync_1994257310.md b/windows.media.core/mediastreamsample_createfromstreamasync_1994257310.md index 9a355a877a..5817ebbf5d 100644 --- a/windows.media.core/mediastreamsample_createfromstreamasync_1994257310.md +++ b/windows.media.core/mediastreamsample_createfromstreamasync_1994257310.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSample.CreateFromStreamAsync(Windows.Storage.Streams.IInputStream,System.UInt32,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSample.CreateFromStreamAsync ## -description Asynchronously creates a [MediaStreamSample](mediastreamsample.md) from an [IInputStream](http://msdn.microsoft.com/library/44519d2c-f6c1-4e20-8c84-3c538e1a4bee). ## -parameters ### -param stream The stream that contains the media data used to create the [MediaStreamSample](mediastreamsample.md). ### -param count The length of the data in the sample. This is the number of bytes that will be read from *stream*. ### -param timestamp The presentation time of this [MediaStreamSample](mediastreamsample.md). ## -returns When this method completes, it returns the new file as a [MediaStreamSample](mediastreamsample.md). ## -remarks For certain formats, the decode time and the presentation time of a [MediaStreamSample](mediastreamsample.md) are different. The decode time can be accessed through the [DecodeTimestamp](mediastreamsample_decodetimestamp.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSample.CreateFromStreamAsync(Windows.Storage.Streams.IInputStream,System.UInt32,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSample.CreateFromStreamAsync + +## -description +Asynchronously creates a [MediaStreamSample](mediastreamsample.md) from an [IInputStream](http://msdn.microsoft.com/library/44519d2c-f6c1-4e20-8c84-3c538e1a4bee). + +## -parameters +### -param stream +The stream that contains the media data used to create the [MediaStreamSample](mediastreamsample.md). + +### -param count +The length of the data in the sample. This is the number of bytes that will be read from *stream*. + +### -param timestamp +The presentation time of this [MediaStreamSample](mediastreamsample.md). + +## -returns +When this method completes, it returns the new file as a [MediaStreamSample](mediastreamsample.md). + +## -remarks +For certain formats, the decode time and the presentation time of a [MediaStreamSample](mediastreamsample.md) are different. The decode time can be accessed through the [DecodeTimestamp](mediastreamsample_decodetimestamp.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_decodetimestamp.md b/windows.media.core/mediastreamsample_decodetimestamp.md index 81f0302cb0..33b7744ab9 100644 --- a/windows.media.core/mediastreamsample_decodetimestamp.md +++ b/windows.media.core/mediastreamsample_decodetimestamp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.DecodeTimestamp --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.DecodeTimestamp ## -description Gets and sets the decode timestamp for this [MediaStreamSample](mediastreamsample.md). ## -property-value The decode timestamp. ## -remarks The default value of [DecodeTimestamp](mediastreamsample_decodetimestamp.md) is the same value as the [Timestamp](mediastreamsample_timestamp.md) property on the [MediaStreamSample](mediastreamsample.md) object. Certain media formats may require the [DecodeTimestamp](mediastreamsample_decodetimestamp.md) property to be assigned a value that is different from the presentation timestamp given by the [Timestamp](mediastreamsample_timestamp.md) property, but for most formats the two properties will be the same. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.DecodeTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.DecodeTimestamp + +## -description +Gets and sets the decode timestamp for this [MediaStreamSample](mediastreamsample.md). + +## -property-value +The decode timestamp. + +## -remarks +The default value of [DecodeTimestamp](mediastreamsample_decodetimestamp.md) is the same value as the [Timestamp](mediastreamsample_timestamp.md) property on the [MediaStreamSample](mediastreamsample.md) object. Certain media formats may require the [DecodeTimestamp](mediastreamsample_decodetimestamp.md) property to be assigned a value that is different from the presentation timestamp given by the [Timestamp](mediastreamsample_timestamp.md) property, but for most formats the two properties will be the same. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_discontinuous.md b/windows.media.core/mediastreamsample_discontinuous.md index dcf798dbad..ee04c0281d 100644 --- a/windows.media.core/mediastreamsample_discontinuous.md +++ b/windows.media.core/mediastreamsample_discontinuous.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.Discontinuous --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.Discontinuous ## -description Gets or sets a value to indicate that the previous [MediaStreamSample](mediastreamsample.md) in the sequence is missing. ## -property-value **true** if the previous [MediaStreamSample](mediastreamsample.md) in the sequence is missing; otherwise, **false**. The default value is **false**. ## -remarks Applications should set this property to **true** when the previous [MediaStreamSample](mediastreamsample.md) in the sequence is missing. An example of a situation when this can occur is when samples are received over a lossy network connection. The default value is **false**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.Discontinuous +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.Discontinuous + +## -description +Gets or sets a value to indicate that the previous [MediaStreamSample](mediastreamsample.md) in the sequence is missing. + +## -property-value +**true** if the previous [MediaStreamSample](mediastreamsample.md) in the sequence is missing; otherwise, **false**. The default value is **false**. + +## -remarks +Applications should set this property to **true** when the previous [MediaStreamSample](mediastreamsample.md) in the sequence is missing. An example of a situation when this can occur is when samples are received over a lossy network connection. The default value is **false**. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_duration.md b/windows.media.core/mediastreamsample_duration.md index 715e4fde93..813eef5af7 100644 --- a/windows.media.core/mediastreamsample_duration.md +++ b/windows.media.core/mediastreamsample_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.Duration --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.Duration ## -description Gets the duration of the sample. ## -property-value The duration of the sample. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.Duration + +## -description +Gets the duration of the sample. + +## -property-value +The duration of the sample. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_extendedproperties.md b/windows.media.core/mediastreamsample_extendedproperties.md index ada16a7adc..60a2fe42ef 100644 --- a/windows.media.core/mediastreamsample_extendedproperties.md +++ b/windows.media.core/mediastreamsample_extendedproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.ExtendedProperties --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.ExtendedProperties ## -description Gets the extended property set which enables getting and setting properties on the [MediaStreamSample](mediastreamsample.md). ## -property-value The extended properties map. ## -remarks The [ExtendedProperties](mediastreamsample_extendedproperties.md) is used for less common properties which are not directly accessible on the [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object. The properties are accessed through their GUID values. For example, the video stride property is accessed through the GUID value “0x644b4e48, 0x1e02, 0x4516, 0xb0, 0xeb, 0xc0, 0x1c, 0xa9, 0xd4, 0x9a, 0xc6”, which is the GUID for [MF_MT_DEFAULT_STRIDE](XREF:TODO:mf.mf_mt_default_stride_attribute). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.ExtendedProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.ExtendedProperties + +## -description +Gets the extended property set which enables getting and setting properties on the [MediaStreamSample](mediastreamsample.md). + +## -property-value +The extended properties map. + +## -remarks +The [ExtendedProperties](mediastreamsample_extendedproperties.md) is used for less common properties which are not directly accessible on the [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object. The properties are accessed through their GUID values. For example, the video stride property is accessed through the GUID value “0x644b4e48, 0x1e02, 0x4516, 0xb0, 0xeb, 0xc0, 0x1c, 0xa9, 0xd4, 0x9a, 0xc6”, which is the GUID for [MF_MT_DEFAULT_STRIDE](XREF:TODO:mf.mf_mt_default_stride_attribute). + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_keyframe.md b/windows.media.core/mediastreamsample_keyframe.md index 13169981d0..5cc15820f3 100644 --- a/windows.media.core/mediastreamsample_keyframe.md +++ b/windows.media.core/mediastreamsample_keyframe.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.KeyFrame --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.KeyFrame ## -description Gets or sets a value that indicates the [MediaStreamSample](mediastreamsample.md) contains a keyframe. ## -property-value **true** if the [MediaStreamSample](mediastreamsample.md) contains a frame that can be decoded independently from other frames; otherwise, **false**. The default value is **false**. ## -remarks This flag should be set to **true** when the [MediaStreamSample](mediastreamsample.md) contains an audio or video frame which can be independently decoded from other frames. Such frames are sometimes referred to as cleanpoints, I-frames, IDR-frames or key frames. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.KeyFrame +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.KeyFrame + +## -description +Gets or sets a value that indicates the [MediaStreamSample](mediastreamsample.md) contains a keyframe. + +## -property-value +**true** if the [MediaStreamSample](mediastreamsample.md) contains a frame that can be decoded independently from other frames; otherwise, **false**. The default value is **false**. + +## -remarks +This flag should be set to **true** when the [MediaStreamSample](mediastreamsample.md) contains an audio or video frame which can be independently decoded from other frames. Such frames are sometimes referred to as cleanpoints, I-frames, IDR-frames or key frames. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_processed.md b/windows.media.core/mediastreamsample_processed.md index c9bb30617b..12685b648f 100644 --- a/windows.media.core/mediastreamsample_processed.md +++ b/windows.media.core/mediastreamsample_processed.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSample.Processed --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSample.Processed ## -description Occurs when the MediaStreamSample has been processed by the media pipeline. ## -remarks When this event has been raised, it is safe to reuse the [IBuffer](http://msdn.microsoft.com/library/6c3bde9b-d354-48f8-b7f6-517df14202c0) from this [MediaStreamSample](mediastreamsample.md) in a new [MediaStreamSample](mediastreamsample.md). This allows an application to have a pool of buffers which are reused across multiple [MediaStreamSample](mediastreamsample.md) objects, rather than allocating a new buffer for each new [MediaStreamSample](mediastreamsample.md). The event is informational. Applications are not required to have a handler for this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSample.Processed +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSample.Processed + +## -description +Occurs when the MediaStreamSample has been processed by the media pipeline. + +## -remarks +When this event has been raised, it is safe to reuse the [IBuffer](http://msdn.microsoft.com/library/6c3bde9b-d354-48f8-b7f6-517df14202c0) from this [MediaStreamSample](mediastreamsample.md) in a new [MediaStreamSample](mediastreamsample.md). This allows an application to have a pool of buffers which are reused across multiple [MediaStreamSample](mediastreamsample.md) objects, rather than allocating a new buffer for each new [MediaStreamSample](mediastreamsample.md). + +The event is informational. Applications are not required to have a handler for this event. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_protection.md b/windows.media.core/mediastreamsample_protection.md index a5d500eac2..7415585a01 100644 --- a/windows.media.core/mediastreamsample_protection.md +++ b/windows.media.core/mediastreamsample_protection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.Protection --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.Protection ## -description Gets a [MediaStreamSampleProtectionProperties](mediastreamsampleprotectionproperties.md) object, which is used for getting and setting properties that are specific to the Digital Rights Management (DRM) protection of the [MediaStreamSample](mediastreamsample.md). ## -property-value A collection of properties that are specific to the Digital Rights Management (DRM) protection of the [MediaStreamSample](mediastreamsample.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.Protection +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.Protection + +## -description +Gets a [MediaStreamSampleProtectionProperties](mediastreamsampleprotectionproperties.md) object, which is used for getting and setting properties that are specific to the Digital Rights Management (DRM) protection of the [MediaStreamSample](mediastreamsample.md). + +## -property-value +A collection of properties that are specific to the Digital Rights Management (DRM) protection of the [MediaStreamSample](mediastreamsample.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsample_timestamp.md b/windows.media.core/mediastreamsample_timestamp.md index 0b0ead0c32..7916ad30dd 100644 --- a/windows.media.core/mediastreamsample_timestamp.md +++ b/windows.media.core/mediastreamsample_timestamp.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSample.Timestamp --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSample.Timestamp ## -description Gets the time at which a sample should be rendered. This is also referred to as the presentation time. ## -property-value The time at which the [MediaStreamSample](mediastreamsample.md) should be rendered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSample.Timestamp +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSample.Timestamp + +## -description +Gets the time at which a sample should be rendered. This is also referred to as the presentation time. + +## -property-value +The time at which the [MediaStreamSample](mediastreamsample.md) should be rendered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset.md b/windows.media.core/mediastreamsamplepropertyset.md index 6b6aaf1389..d8a0417840 100644 --- a/windows.media.core/mediastreamsamplepropertyset.md +++ b/windows.media.core/mediastreamsamplepropertyset.md @@ -1,3 +1,30 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSamplePropertySet --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSamplePropertySet ## -description Contains properties for the [MediaStreamSample](mediastreamsample.md). ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. ### Enumerating the collection in C# or Microsoft Visual Basic You can iterate through a [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object in C# or Microsoft Visual Basic. In many cases, such as using **foreach** syntax, the compiler does this casting for you and you won't need to cast to `IEnumerable` explicitly. If you do need to cast explicitly, for example if you want to call [GetEnumerator](XREF:TODO:M:System.Collections.Generic.IEnumerable`1.GetEnumerator), cast the collection object to [IEnumerable<T>](XREF:TODO:T:System.Collections.Generic.IEnumerable`1) with a [KeyValuePair](XREF:TODO:T:System.Collections.Generic.KeyValuePair`2) of [Guid](https://msdn.microsoft.com/library/system.guid.aspx) and [Object](https://msdn.microsoft.com/library/system.object.aspx) as the constraint. ## -examples ## -see-also [IMap(Guid, Object)](../windows.foundation.collections/imap_2.md), [IIterable(IKeyValuePair)](../windows.foundation.collections/iiterable_1.md), [ExtendedProperties](mediastreamsample_extendedproperties.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSamplePropertySet +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet + +## -description +Contains properties for the [MediaStreamSample](mediastreamsample.md). + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. + + + +### Enumerating the collection in C# or Microsoft Visual Basic + +You can iterate through a [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object in C# or Microsoft Visual Basic. In many cases, such as using **foreach** syntax, the compiler does this casting for you and you won't need to cast to `IEnumerable` explicitly. If you do need to cast explicitly, for example if you want to call [GetEnumerator](XREF:TODO:M:System.Collections.Generic.IEnumerable`1.GetEnumerator), cast the collection object to [IEnumerable<T>](XREF:TODO:T:System.Collections.Generic.IEnumerable`1) with a [KeyValuePair](XREF:TODO:T:System.Collections.Generic.KeyValuePair`2) of [Guid](https://msdn.microsoft.com/library/system.guid.aspx) and [Object](https://msdn.microsoft.com/library/system.object.aspx) as the constraint. + + + + +## -examples + +## -see-also +[IMap(Guid, Object)](../windows.foundation.collections/imap_2.md), [IIterable(IKeyValuePair)](../windows.foundation.collections/iiterable_1.md), [ExtendedProperties](mediastreamsample_extendedproperties.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsamplepropertyset_clear_556466.md b/windows.media.core/mediastreamsamplepropertyset_clear_556466.md index 547624b4d4..d3bf2a3d5c 100644 --- a/windows.media.core/mediastreamsamplepropertyset_clear_556466.md +++ b/windows.media.core/mediastreamsamplepropertyset_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Clear --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.Clear ## -description Removes all items from the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Clear +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.Clear + +## -description +Removes all items from the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_first_1920739956.md b/windows.media.core/mediastreamsamplepropertyset_first_1920739956.md index adee46bc33..9a8270439f 100644 --- a/windows.media.core/mediastreamsamplepropertyset_first_1920739956.md +++ b/windows.media.core/mediastreamsamplepropertyset_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.First --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.First ## -description Returns an iterator to enumerate the items in the property set. ## -returns The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.First +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.First + +## -description +Returns an iterator to enumerate the items in the property set. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_getview_37498667.md b/windows.media.core/mediastreamsamplepropertyset_getview_37498667.md index 1d6dbc3a17..e7ac7bfc6c 100644 --- a/windows.media.core/mediastreamsamplepropertyset_getview_37498667.md +++ b/windows.media.core/mediastreamsamplepropertyset_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.GetView --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.GetView ## -description Gets an immutable view of the property set. ## -returns The immutable view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.GetView +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.GetView + +## -description +Gets an immutable view of the property set. + +## -returns +The immutable view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_haskey_379600142.md b/windows.media.core/mediastreamsamplepropertyset_haskey_379600142.md index dab7f9c665..b2b4eb421a 100644 --- a/windows.media.core/mediastreamsamplepropertyset_haskey_379600142.md +++ b/windows.media.core/mediastreamsamplepropertyset_haskey_379600142.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.HasKey(System.Guid) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.HasKey ## -description Indicates if the specified key exists in the property set. ## -parameters ### -param key The key to check. ## -returns **true** if the key exists; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.HasKey(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.HasKey + +## -description +Indicates if the specified key exists in the property set. + +## -parameters +### -param key +The key to check. + +## -returns +**true** if the key exists; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_insert_1901569558.md b/windows.media.core/mediastreamsamplepropertyset_insert_1901569558.md index 0307b5923d..de128d8c7d 100644 --- a/windows.media.core/mediastreamsamplepropertyset_insert_1901569558.md +++ b/windows.media.core/mediastreamsamplepropertyset_insert_1901569558.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Insert(System.Guid,System.Object) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.Insert ## -description Adds the specified key and value to the property set. ## -parameters ### -param key The key to add. ### -param value The value of the key. ## -returns **True** if the method replaces a value that already exists for the *key*; **false** if this is a new key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Insert(System.Guid,System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.Insert + +## -description +Adds the specified key and value to the property set. + +## -parameters +### -param key +The key to add. + +### -param value +The value of the key. + +## -returns +**True** if the method replaces a value that already exists for the *key*; **false** if this is a new key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_lookup_631550550.md b/windows.media.core/mediastreamsamplepropertyset_lookup_631550550.md index 1d2b5cec6e..ada7fc35c7 100644 --- a/windows.media.core/mediastreamsamplepropertyset_lookup_631550550.md +++ b/windows.media.core/mediastreamsamplepropertyset_lookup_631550550.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Lookup(System.Guid) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.Lookup ## -description Retrieves the value for the specified key. ## -parameters ### -param key The key to retrieve the value for. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Lookup(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.Lookup + +## -description +Retrieves the value for the specified key. + +## -parameters +### -param key +The key to retrieve the value for. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_remove_1452452583.md b/windows.media.core/mediastreamsamplepropertyset_remove_1452452583.md index 9792e82325..df0d0dff93 100644 --- a/windows.media.core/mediastreamsamplepropertyset_remove_1452452583.md +++ b/windows.media.core/mediastreamsamplepropertyset_remove_1452452583.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Remove(System.Guid) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSamplePropertySet.Remove ## -description Removes an item from the property set. ## -parameters ### -param key The key to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSamplePropertySet.Remove(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.Remove + +## -description +Removes an item from the property set. + +## -parameters +### -param key +The key to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsamplepropertyset_size.md b/windows.media.core/mediastreamsamplepropertyset_size.md index 92c43582ea..7dba1cecea 100644 --- a/windows.media.core/mediastreamsamplepropertyset_size.md +++ b/windows.media.core/mediastreamsamplepropertyset_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSamplePropertySet.Size --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSamplePropertySet.Size ## -description Gets the number of items contained in the property set. ## -property-value The number of items in the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSamplePropertySet.Size +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSamplePropertySet.Size + +## -description +Gets the number of items contained in the property set. + +## -property-value +The number of items in the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsampleprotectionproperties.md b/windows.media.core/mediastreamsampleprotectionproperties.md index ba0f503485..63fdc54d95 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties.md +++ b/windows.media.core/mediastreamsampleprotectionproperties.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSampleProtectionProperties --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties ## -description Represents a collection properties that are specific to the Digital Rights Management (DRM) protection of the [MediaStreamSample](mediastreamsample.md). ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSampleProtectionProperties +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties + +## -description +Represents a collection properties that are specific to the Digital Rights Management (DRM) protection of the [MediaStreamSample](mediastreamsample.md). + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsampleprotectionproperties_getinitializationvector_1717187346.md b/windows.media.core/mediastreamsampleprotectionproperties_getinitializationvector_1717187346.md index 5945edf154..14bb7b82c9 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties_getinitializationvector_1717187346.md +++ b/windows.media.core/mediastreamsampleprotectionproperties_getinitializationvector_1717187346.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.GetInitializationVector(System.Byte[]@) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties.GetInitializationVector ## -description Gets the Digital Rights Management (DRM) initialization vector from the [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param value The initialization vector. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.GetInitializationVector(System.Byte[]@) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties.GetInitializationVector + +## -description +Gets the Digital Rights Management (DRM) initialization vector from the [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param value +The initialization vector. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsampleprotectionproperties_getkeyidentifier_1357166420.md b/windows.media.core/mediastreamsampleprotectionproperties_getkeyidentifier_1357166420.md index 32ece5ff26..a479c3a27a 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties_getkeyidentifier_1357166420.md +++ b/windows.media.core/mediastreamsampleprotectionproperties_getkeyidentifier_1357166420.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.GetKeyIdentifier(System.Byte[]@) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties.GetKeyIdentifier ## -description Gets the Digital Rights Management (DRM) key identifier from the [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param value Receives the key identifier used to decrypt the data. ## -remarks This method is used with encrypted [MediaStreamSample](mediastreamsample.md) objects that belonging to a protection scheme that uses multiple keys. The key identifier allows the decryptor to know which key to use to decrypt the data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.GetKeyIdentifier(System.Byte[]@) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties.GetKeyIdentifier + +## -description +Gets the Digital Rights Management (DRM) key identifier from the [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param value +Receives the key identifier used to decrypt the data. + +## -remarks +This method is used with encrypted [MediaStreamSample](mediastreamsample.md) objects that belonging to a protection scheme that uses multiple keys. The key identifier allows the decryptor to know which key to use to decrypt the data. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsampleprotectionproperties_getsubsamplemapping_67029317.md b/windows.media.core/mediastreamsampleprotectionproperties_getsubsamplemapping_67029317.md index a6da8feda5..e831281b44 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties_getsubsamplemapping_67029317.md +++ b/windows.media.core/mediastreamsampleprotectionproperties_getsubsamplemapping_67029317.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.GetSubSampleMapping(System.Byte[]@) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties.GetSubSampleMapping ## -description Gets the Digital Rights Management (DRM) sub-sample mapping from the [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param value Receives the sub-sample mapping. ## -remarks The sub-sample mapping is used when only portions of the data contained in the [MediaStreamSample](mediastreamsample.md) is encrypted. The sub-sample mapping specifies which parts are encrypted and which are in the clear. The syntax of the sub-sample mapping data is specific to each individual Digital Rights Management (DRM) protection scheme. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.GetSubSampleMapping(System.Byte[]@) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties.GetSubSampleMapping + +## -description +Gets the Digital Rights Management (DRM) sub-sample mapping from the [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param value +Receives the sub-sample mapping. + +## -remarks +The sub-sample mapping is used when only portions of the data contained in the [MediaStreamSample](mediastreamsample.md) is encrypted. The sub-sample mapping specifies which parts are encrypted and which are in the clear. The syntax of the sub-sample mapping data is specific to each individual Digital Rights Management (DRM) protection scheme. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsampleprotectionproperties_setinitializationvector_1557103043.md b/windows.media.core/mediastreamsampleprotectionproperties_setinitializationvector_1557103043.md index 5ecc55aec5..b1af483f8c 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties_setinitializationvector_1557103043.md +++ b/windows.media.core/mediastreamsampleprotectionproperties_setinitializationvector_1557103043.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.SetInitializationVector(System.Byte[]) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties.SetInitializationVector ## -description Sets the Digital Rights Management (DRM) initialization vector for the [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param value The value to set the Digital Rights Management (DRM) initialization vector to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.SetInitializationVector(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties.SetInitializationVector + +## -description +Sets the Digital Rights Management (DRM) initialization vector for the [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param value +The value to set the Digital Rights Management (DRM) initialization vector to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsampleprotectionproperties_setkeyidentifier_1460162432.md b/windows.media.core/mediastreamsampleprotectionproperties_setkeyidentifier_1460162432.md index 0dc9a0b2e6..e8be7ee079 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties_setkeyidentifier_1460162432.md +++ b/windows.media.core/mediastreamsampleprotectionproperties_setkeyidentifier_1460162432.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.SetKeyIdentifier(System.Byte[]) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties.SetKeyIdentifier ## -description Sets the Digital Rights Management (DRM) key identifier for the [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param value The value to set the Digital Rights Management (DRM) key identifier to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.SetKeyIdentifier(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties.SetKeyIdentifier + +## -description +Sets the Digital Rights Management (DRM) key identifier for the [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param value +The value to set the Digital Rights Management (DRM) key identifier to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsampleprotectionproperties_setsubsamplemapping_456351841.md b/windows.media.core/mediastreamsampleprotectionproperties_setsubsamplemapping_456351841.md index 66214a5140..35d83bc88e 100644 --- a/windows.media.core/mediastreamsampleprotectionproperties_setsubsamplemapping_456351841.md +++ b/windows.media.core/mediastreamsampleprotectionproperties_setsubsamplemapping_456351841.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.SetSubSampleMapping(System.Byte[]) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSampleProtectionProperties.SetSubSampleMapping ## -description Sets the Digital Rights Management (DRM) sub-sample mapping for the [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param value The value to set the Digital Rights Management (DRM) sub-sample mapping to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSampleProtectionProperties.SetSubSampleMapping(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSampleProtectionProperties.SetSubSampleMapping + +## -description +Sets the Digital Rights Management (DRM) sub-sample mapping for the [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param value +The value to set the Digital Rights Management (DRM) sub-sample mapping to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource.md b/windows.media.core/mediastreamsource.md index 1f2e8417f5..a036fc4d21 100644 --- a/windows.media.core/mediastreamsource.md +++ b/windows.media.core/mediastreamsource.md @@ -1,3 +1,56 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSource --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSource ## -description Represents a media source that delivers media samples directly to the media pipeline. ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. [MediaStreamSource](mediastreamsource.md) is a new generic media source for Windows Store app which is introduced in Windows 8.1. [MediaStreamSource](mediastreamsource.md) allows apps to send compressed or uncompressed audio and video samples to the media pipeline for playback, transcoding, and streaming. Media samples can be dynamically generated by the app, or de-multiplexed from a stream or files. This flexibility enables apps to more easily extend platform support for new media formats or solve complex problems, such as adaptive streaming. The [MediaStreamSource](mediastreamsource.md)API are very similar to the Microsoft SilverlightAPI of the same name. [MediaStreamSource](mediastreamsource.md) can be used with [audio](XREF:TODO:wwa.HTMLAudioObject) and [video](XREF:TODO:wwa.HTMLVideoObject) objects in Windows app using JavaScript, [MediaElement](../windows.ui.xaml.controls/mediaelement.md) objects in Windows Store app using C++, C#, or Visual Basic, and the [MediaTranscoder](../windows.media.transcoding/mediatranscoder.md). The [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) demonstrates how to use the [MediaStreamSource](mediastreamsource.md).Here are some of the main [MediaStreamSource](mediastreamsource.md)API. The order outlines the basic flow of how [MediaStreamSource](mediastreamsource.md) functions. You'll notice that the [MediaStreamSource](mediastreamsource.md) sends request objects to the app through event arguments. These request objects enable the app to interact with the [MediaStreamSource](mediastreamsource.md) and pass data back to it.
APIDescription
[MediaStreamSource](mediastreamsource.md)Represents a media source that delivers media samples directly to the media pipeline. [MediaStreamSource](mediastreamsource.md) consumes [MediaStreamSample](mediastreamsample.md) objects that are provided by the application.
[MediaStreamSample](mediastreamsample.md)Represents a media sample used by the [MediaStreamSource](mediastreamsource.md).
[MediaStreamSource.Starting](mediastreamsource_starting.md) (event)The [MediaStreamSource](mediastreamsource.md) uses this event to notify the app that it is ready to start processing media data.
[MediaStreamSourceStartingRequest](mediastreamsourcestartingrequest.md)Represents a request from the [MediaStreamSource](mediastreamsource.md) that it is ready to start processing media data. Apps should reply as soon as possible to this request by calling [SetActualStartPosition](mediastreamsourcestartingrequest_setactualstartposition.md) on the request. If an app needs to delay the [MediaStreamSource](mediastreamsource.md) from processing data, it can get an asynchronous deferral from [MediaStreamSourceStartingRequest.GetDeferral](mediastreamsourcestartingrequest_getdeferral.md). When the app is ready for the [MediaStreamSource](mediastreamsource.md) to start, it calls [Complete](mediastreamsourcestartingrequestdeferral_complete.md) on the deferral object. The starting request is accessed through the [MediaStreamSourceStartingEventArgs](mediastreamsourcestartingeventargs.md) that are passed to the [MediaStreamSource.Starting](mediastreamsource_starting.md) event handler.
[MediaStreamSource.SampleRequested](mediastreamsource_samplerequested.md) (event)The [MediaStreamSource](mediastreamsource.md) uses this event to notify the app that it is ready for a [MediaStreamSample](mediastreamsample.md). Apps are required to register a handler for this event.
[MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md)Represents a request from the [MediaStreamSource](mediastreamsource.md) for a new media sample. Setting the [Sample](mediastreamsourcesamplerequest_sample.md) property to the new [MediaStreamSample](mediastreamsample.md) triggers the [MediaStreamSource](mediastreamsource.md) to retrieve the media sample and continue processing the media data. Apps should reply as soon as possible to this request. If an app needs time before sending the [MediaStreamSample](mediastreamsample.md), it can get an asynchronous deferral from [MediaStreamSourceSampleRequest.GetDeferral](mediastreamsourcesamplerequest_getdeferral.md). When the app is finished with the deferral, it calls [Complete](mediastreamsourcesamplerequestdeferral_complete.md) on the deferral object. The sample request is accessed through the [MediaStreamSourceSampleRequestedEventArgs](mediastreamsourcesamplerequestedeventargs.md) that are passed to the [MediaStreamSource.SampleRequest](mediastreamsource_samplerequested.md) event handler. The app indicates it has reached the end of the stream by responding to a [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) without providing a [MediaStreamSample](mediastreamsample.md), or by assigning the [MediaStreamSourceSampleRequest.Sample](mediastreamsourcesamplerequest_sample.md) property to **null**.
[MediaStreamSource.Closed](mediastreamsource_closed.md) (event)The [MediaStreamSource](mediastreamsource.md) uses this event to notify the app that it has shut down.
[MediaStreamSourceClosedRequest](mediastreamsourceclosedrequest.md)Represents a request from the [MediaStreamSource](mediastreamsource.md) that it has closed. The close request is accessed through the [MediaStreamSourceClosedEventArgs](mediastreamsourceclosedeventargs.md) that are passed to the [MediaStreamSource.Closed](mediastreamsource_closed.md) event handler.
[MediaElement.SetMediaStreamSource](../windows.ui.xaml.controls/mediaelement_setmediastreamsource.md)Sets the source of the [MediaElement](../windows.ui.xaml.controls/mediaelement.md) to a [MediaStreamSource](mediastreamsource.md).
## -examples ## -see-also [IMediaSource](imediasource.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSource +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSource + +## -description +Represents a media source that delivers media samples directly to the media pipeline. + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +[MediaStreamSource](mediastreamsource.md) is a new generic media source for Windows Store app which is introduced in Windows 8.1. [MediaStreamSource](mediastreamsource.md) allows apps to send compressed or uncompressed audio and video samples to the media pipeline for playback, transcoding, and streaming. Media samples can be dynamically generated by the app, or de-multiplexed from a stream or files. This flexibility enables apps to more easily extend platform support for new media formats or solve complex problems, such as adaptive streaming. + +The [MediaStreamSource](mediastreamsource.md)API are very similar to the Microsoft SilverlightAPI of the same name. + +[MediaStreamSource](mediastreamsource.md) can be used with [audio](XREF:TODO:wwa.HTMLAudioObject) and [video](XREF:TODO:wwa.HTMLVideoObject) objects in Windows app using JavaScript, [MediaElement](../windows.ui.xaml.controls/mediaelement.md) objects in Windows Store app using C++, C#, or Visual Basic, and the [MediaTranscoder](../windows.media.transcoding/mediatranscoder.md). + + The [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) demonstrates how to use the [MediaStreamSource](mediastreamsource.md).Here are some of the main [MediaStreamSource](mediastreamsource.md)API. The order outlines the basic flow of how [MediaStreamSource](mediastreamsource.md) functions. You'll notice that the [MediaStreamSource](mediastreamsource.md) sends request objects to the app through event arguments. These request objects enable the app to interact with the [MediaStreamSource](mediastreamsource.md) and pass data back to it. + + + + + + + + + + + + +
APIDescription
[MediaStreamSource](mediastreamsource.md)Represents a media source that delivers media samples directly to the media pipeline. [MediaStreamSource](mediastreamsource.md) consumes [MediaStreamSample](mediastreamsample.md) objects that are provided by the application.
[MediaStreamSample](mediastreamsample.md)Represents a media sample used by the [MediaStreamSource](mediastreamsource.md).
[MediaStreamSource.Starting](mediastreamsource_starting.md) (event)The [MediaStreamSource](mediastreamsource.md) uses this event to notify the app that it is ready to start processing media data.
[MediaStreamSourceStartingRequest](mediastreamsourcestartingrequest.md)Represents a request from the [MediaStreamSource](mediastreamsource.md) that it is ready to start processing media data. + +Apps should reply as soon as possible to this request by calling [SetActualStartPosition](mediastreamsourcestartingrequest_setactualstartposition.md) on the request. If an app needs to delay the [MediaStreamSource](mediastreamsource.md) from processing data, it can get an asynchronous deferral from [MediaStreamSourceStartingRequest.GetDeferral](mediastreamsourcestartingrequest_getdeferral.md). When the app is ready for the [MediaStreamSource](mediastreamsource.md) to start, it calls [Complete](mediastreamsourcestartingrequestdeferral_complete.md) on the deferral object. + +The starting request is accessed through the [MediaStreamSourceStartingEventArgs](mediastreamsourcestartingeventargs.md) that are passed to the [MediaStreamSource.Starting](mediastreamsource_starting.md) event handler.
[MediaStreamSource.SampleRequested](mediastreamsource_samplerequested.md) (event)The [MediaStreamSource](mediastreamsource.md) uses this event to notify the app that it is ready for a [MediaStreamSample](mediastreamsample.md). + +Apps are required to register a handler for this event.
[MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md)Represents a request from the [MediaStreamSource](mediastreamsource.md) for a new media sample. Setting the [Sample](mediastreamsourcesamplerequest_sample.md) property to the new [MediaStreamSample](mediastreamsample.md) triggers the [MediaStreamSource](mediastreamsource.md) to retrieve the media sample and continue processing the media data. + +Apps should reply as soon as possible to this request. If an app needs time before sending the [MediaStreamSample](mediastreamsample.md), it can get an asynchronous deferral from [MediaStreamSourceSampleRequest.GetDeferral](mediastreamsourcesamplerequest_getdeferral.md). When the app is finished with the deferral, it calls [Complete](mediastreamsourcesamplerequestdeferral_complete.md) on the deferral object. + +The sample request is accessed through the [MediaStreamSourceSampleRequestedEventArgs](mediastreamsourcesamplerequestedeventargs.md) that are passed to the [MediaStreamSource.SampleRequest](mediastreamsource_samplerequested.md) event handler. + +The app indicates it has reached the end of the stream by responding to a [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) without providing a [MediaStreamSample](mediastreamsample.md), or by assigning the [MediaStreamSourceSampleRequest.Sample](mediastreamsourcesamplerequest_sample.md) property to **null**.
[MediaStreamSource.Closed](mediastreamsource_closed.md) (event)The [MediaStreamSource](mediastreamsource.md) uses this event to notify the app that it has shut down.
[MediaStreamSourceClosedRequest](mediastreamsourceclosedrequest.md)Represents a request from the [MediaStreamSource](mediastreamsource.md) that it has closed. + +The close request is accessed through the [MediaStreamSourceClosedEventArgs](mediastreamsourceclosedeventargs.md) that are passed to the [MediaStreamSource.Closed](mediastreamsource_closed.md) event handler.
[MediaElement.SetMediaStreamSource](../windows.ui.xaml.controls/mediaelement_setmediastreamsource.md)Sets the source of the [MediaElement](../windows.ui.xaml.controls/mediaelement.md) to a [MediaStreamSource](mediastreamsource.md).
+ +## -examples + +## -see-also +[IMediaSource](imediasource.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_addprotectionkey_1265554490.md b/windows.media.core/mediastreamsource_addprotectionkey_1265554490.md index 943f968a18..69e4b0a333 100644 --- a/windows.media.core/mediastreamsource_addprotectionkey_1265554490.md +++ b/windows.media.core/mediastreamsource_addprotectionkey_1265554490.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSource.AddProtectionKey(Windows.Media.Core.IMediaStreamDescriptor,System.Byte[],System.Byte[]) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSource.AddProtectionKey ## -description Adds a Digital Rights Management (DRM) protection key which is used by the [MediaProtectionManager](mediastreamsource_mediaprotectionmanager.md) to encrypt and decrypt the specified stream. ## -parameters ### -param streamDescriptor The stream the key is used to encrypt and decrypt. ### -param keyIdentifier The key used to encrypt and decrypt the stream. ### -param licenseData The Digital Rights Management (DRM) licence for the media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSource.AddProtectionKey(Windows.Media.Core.IMediaStreamDescriptor,System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSource.AddProtectionKey + +## -description +Adds a Digital Rights Management (DRM) protection key which is used by the [MediaProtectionManager](mediastreamsource_mediaprotectionmanager.md) to encrypt and decrypt the specified stream. + +## -parameters +### -param streamDescriptor +The stream the key is used to encrypt and decrypt. + +### -param keyIdentifier +The key used to encrypt and decrypt the stream. + +### -param licenseData +The Digital Rights Management (DRM) licence for the media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_addstreamdescriptor_503977765.md b/windows.media.core/mediastreamsource_addstreamdescriptor_503977765.md index b749a96534..9f5dfe94bc 100644 --- a/windows.media.core/mediastreamsource_addstreamdescriptor_503977765.md +++ b/windows.media.core/mediastreamsource_addstreamdescriptor_503977765.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSource.AddStreamDescriptor(Windows.Media.Core.IMediaStreamDescriptor) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSource.AddStreamDescriptor ## -description Adds a new stream descriptor to the [MediaStreamSource](mediastreamsource.md). ## -parameters ### -param descriptor The descriptor to add. ## -remarks This method can only be invoked when the [MediaStreamSource](mediastreamsource.md) is not yet in use by the media pipeline, for example by a [video](XREF:TODO:wwa.HTMLVideoObject) object, a [MediaElement](../windows.ui.xaml.controls/mediaelement.md), or a [MediaTranscoder](../windows.media.transcoding/mediatranscoder.md). It is possible to invoke this method multiple times. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSource.AddStreamDescriptor(Windows.Media.Core.IMediaStreamDescriptor) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSource.AddStreamDescriptor + +## -description +Adds a new stream descriptor to the [MediaStreamSource](mediastreamsource.md). + +## -parameters +### -param descriptor +The descriptor to add. + +## -remarks +This method can only be invoked when the [MediaStreamSource](mediastreamsource.md) is not yet in use by the media pipeline, for example by a [video](XREF:TODO:wwa.HTMLVideoObject) object, a [MediaElement](../windows.ui.xaml.controls/mediaelement.md), or a [MediaTranscoder](../windows.media.transcoding/mediatranscoder.md). + +It is possible to invoke this method multiple times. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_buffertime.md b/windows.media.core/mediastreamsource_buffertime.md index 7f652e72b0..e02312e74b 100644 --- a/windows.media.core/mediastreamsource_buffertime.md +++ b/windows.media.core/mediastreamsource_buffertime.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.BufferTime --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.BufferTime ## -description Gets or sets the amount of data that is buffered by the [MediaStreamSource](mediastreamsource.md). ## -property-value The duration of the buffer which corresponds to the number of [MediaStreamSamples](mediastreamsample.md) the [MediaStreamSource](mediastreamsource.md) requests. The default value is 3 seconds. ## -remarks The [MediaStreamSource](mediastreamsource.md) will request a number of [MediaStreamSamples](mediastreamsample.md) in advance. The amount is controlled by the [BufferTime](mediastreamsource_buffertime.md) property. The default value is 3 seconds. Requesting [MediaStreamSamples](mediastreamsample.md) in advance helps prevent glitches that would otherwise occur if the application does not deliver [MediaStreamSamples](mediastreamsample.md) on time. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.BufferTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.BufferTime + +## -description +Gets or sets the amount of data that is buffered by the [MediaStreamSource](mediastreamsource.md). + +## -property-value +The duration of the buffer which corresponds to the number of [MediaStreamSamples](mediastreamsample.md) the [MediaStreamSource](mediastreamsource.md) requests. The default value is 3 seconds. + +## -remarks +The [MediaStreamSource](mediastreamsource.md) will request a number of [MediaStreamSamples](mediastreamsample.md) in advance. The amount is controlled by the [BufferTime](mediastreamsource_buffertime.md) property. The default value is 3 seconds. + +Requesting [MediaStreamSamples](mediastreamsample.md) in advance helps prevent glitches that would otherwise occur if the application does not deliver [MediaStreamSamples](mediastreamsample.md) on time. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_canseek.md b/windows.media.core/mediastreamsource_canseek.md index 2ae4e90a5e..389d03b3a9 100644 --- a/windows.media.core/mediastreamsource_canseek.md +++ b/windows.media.core/mediastreamsource_canseek.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.CanSeek --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.CanSeek ## -description Gets or sets whether or not the application supports changing its position in the media time-line. ## -property-value **true** if the application supports changing its position in the media time-line; otherwise, **false**. The default value is **false**. ## -remarks Setting the [CanSeek](mediastreamsource_canseek.md) property to **true** implies that the application is able to handle a [Starting](mediastreamsource_starting.md) event that specifies a start offset other than the current position. The default value is **false**. Applications are allowed to change the value of this property at any time. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.CanSeek +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.CanSeek + +## -description +Gets or sets whether or not the application supports changing its position in the media time-line. + +## -property-value +**true** if the application supports changing its position in the media time-line; otherwise, **false**. The default value is **false**. + +## -remarks +Setting the [CanSeek](mediastreamsource_canseek.md) property to **true** implies that the application is able to handle a [Starting](mediastreamsource_starting.md) event that specifies a start offset other than the current position. + +The default value is **false**. + +Applications are allowed to change the value of this property at any time. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_closed.md b/windows.media.core/mediastreamsource_closed.md index 46e748e282..fef6396be3 100644 --- a/windows.media.core/mediastreamsource_closed.md +++ b/windows.media.core/mediastreamsource_closed.md @@ -1,3 +1,25 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSource.Closed --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSource.Closed ## -description Occurs when the [MediaStreamSource](mediastreamsource.md) is shutting down. ## -remarks If the [MediaStreamSource](mediastreamsource.md) is shutting down due to an error, the [Reason](mediastreamsourceclosedrequest_reason.md) property on the [MediaStreamSourceClosedRequest](mediastreamsourceclosedrequest.md) object, which can be obtained from [MediaStreamSourceClosedEventArgs](mediastreamsourceclosedeventargs.md), provides information about the nature of the error. Upon receiving this event, the application should remove all of its event handlers from the [MediaStreamSource](mediastreamsource.md) object, and refrain from further use of this instance of the [MediaStreamSource](mediastreamsource.md) object. Applications are not required to have a handler for this event. ## -examples ## -see-also [MediaStreamSourceClosedEventArgs](mediastreamsourceclosedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSource.Closed +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSource.Closed + +## -description +Occurs when the [MediaStreamSource](mediastreamsource.md) is shutting down. + +## -remarks +If the [MediaStreamSource](mediastreamsource.md) is shutting down due to an error, the [Reason](mediastreamsourceclosedrequest_reason.md) property on the [MediaStreamSourceClosedRequest](mediastreamsourceclosedrequest.md) object, which can be obtained from [MediaStreamSourceClosedEventArgs](mediastreamsourceclosedeventargs.md), provides information about the nature of the error. + +Upon receiving this event, the application should remove all of its event handlers from the [MediaStreamSource](mediastreamsource.md) object, and refrain from further use of this instance of the [MediaStreamSource](mediastreamsource.md) object. + +Applications are not required to have a handler for this event. + +## -examples + +## -see-also +[MediaStreamSourceClosedEventArgs](mediastreamsourceclosedeventargs.md) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_duration.md b/windows.media.core/mediastreamsource_duration.md index 4c5c543640..718a2a73e1 100644 --- a/windows.media.core/mediastreamsource_duration.md +++ b/windows.media.core/mediastreamsource_duration.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.Duration --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.Duration ## -description Gets or sets the duration of the media time-line. ## -property-value The duration of the media time-line. The default value is 0. ## -remarks Applications that support seeking and set [CanSeek](mediastreamsource_canseek.md) to **true** must also assign a value to the [Duration](mediastreamsource_duration.md) property. The default value is 0, which means that the duration is unspecified. Live media or media that is being generated in real-time might have a [Duration](mediastreamsource_duration.md) value of 0, since the actual duration is unknown. Applications are allowed to change the value of this property at any time. For example, after a live broadcast has ended, the [Duration](mediastreamsource_duration.md) value can be updated from 0 to the actual length of the live broadcast. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.Duration + +## -description +Gets or sets the duration of the media time-line. + +## -property-value +The duration of the media time-line. The default value is 0. + +## -remarks +Applications that support seeking and set [CanSeek](mediastreamsource_canseek.md) to **true** must also assign a value to the [Duration](mediastreamsource_duration.md) property. + +The default value is 0, which means that the duration is unspecified. Live media or media that is being generated in real-time might have a [Duration](mediastreamsource_duration.md) value of 0, since the actual duration is unknown. + +Applications are allowed to change the value of this property at any time. For example, after a live broadcast has ended, the [Duration](mediastreamsource_duration.md) value can be updated from 0 to the actual length of the live broadcast. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_mediaprotectionmanager.md b/windows.media.core/mediastreamsource_mediaprotectionmanager.md index 848d04077d..aa1b415322 100644 --- a/windows.media.core/mediastreamsource_mediaprotectionmanager.md +++ b/windows.media.core/mediastreamsource_mediaprotectionmanager.md @@ -1,3 +1,34 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.MediaProtectionManager --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.MediaProtectionManager ## -description Gets or sets the Digital Rights Management (DRM)[MediaProtectionManager](../windows.media.protection/mediaprotectionmanager.md) used to protect the media. ## -property-value The media protection manager. ## -remarks If any of the streams are protected, the application must set the [MediaProtectionManager](mediastreamsource_mediaprotectionmanager.md) property on the [MediaStreamSource](mediastreamsource.md). The [MediaStreamSource](mediastreamsource.md) requires that the following properties be present in the PropertySet object returned by [MediaProtectionManager.Properties](../windows.media.protection/mediaprotectionmanager_properties.md): + [Windows.Media.Protection.MediaProtectionSystemId](../windows.media.protection/mediaprotectionmanager_properties.md) + [Windows.Media.Protection.MediaProtectionSystemIdMapping ](../windows.media.protection/mediaprotectionmanager_properties.md) [MediaStreamSource](mediastreamsource.md) will use the value of the following optional property when initializing the content protection system: + [Windows.Media.Protection.MediaProtectionSystemContext](../windows.media.protection/mediaprotectionmanager_properties.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.MediaProtectionManager +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.MediaProtectionManager + +## -description +Gets or sets the Digital Rights Management (DRM)[MediaProtectionManager](../windows.media.protection/mediaprotectionmanager.md) used to protect the media. + +## -property-value +The media protection manager. + +## -remarks +If any of the streams are protected, the application must set the [MediaProtectionManager](mediastreamsource_mediaprotectionmanager.md) property on the [MediaStreamSource](mediastreamsource.md). + +The [MediaStreamSource](mediastreamsource.md) requires that the following properties be present in the PropertySet object returned by [MediaProtectionManager.Properties](../windows.media.protection/mediaprotectionmanager_properties.md): ++ [Windows.Media.Protection.MediaProtectionSystemId](../windows.media.protection/mediaprotectionmanager_properties.md) ++ [Windows.Media.Protection.MediaProtectionSystemIdMapping + +](../windows.media.protection/mediaprotectionmanager_properties.md) +[MediaStreamSource](mediastreamsource.md) will use the value of the following optional property when initializing the content protection system: ++ [Windows.Media.Protection.MediaProtectionSystemContext](../windows.media.protection/mediaprotectionmanager_properties.md) + + + + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_mediastreamsource_1712288544.md b/windows.media.core/mediastreamsource_mediastreamsource_1712288544.md index e58f7d4509..97923df8e5 100644 --- a/windows.media.core/mediastreamsource_mediastreamsource_1712288544.md +++ b/windows.media.core/mediastreamsource_mediastreamsource_1712288544.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSource.#ctor(Windows.Media.Core.IMediaStreamDescriptor) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSource.MediaStreamSource ## -description Creates an instance of [MediaStreamSource](mediastreamsource.md) from the specified [IMediaStreamDescriptor](imediastreamdescriptor.md). ## -parameters ### -param descriptor The [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) to create the [MediaStreamSource](mediastreamsource.md) from. ## -remarks This constructor creates a [MediaStreamSource](mediastreamsource.md) using a single [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) object. If the [MediaStreamSource](mediastreamsource.md) needs descriptors, the [MediaStreamSource](mediastreamsource_mediastreamsource_998833464.md) constructor overload which takes two descriptor can be used. It is possible to add additional descriptors to a [MediaStreamSource](mediastreamsource.md) after it has been created, by invoking the [AddStreamDescriptor](mediastreamsource_addstreamdescriptor.md) method. ## -examples ## -see-also [MediaStreamSource(IMediaStreamDescriptor, IMediaStreamDescriptor)](mediastreamsource_mediastreamsource_998833464.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSource.#ctor(Windows.Media.Core.IMediaStreamDescriptor) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSource.MediaStreamSource + +## -description +Creates an instance of [MediaStreamSource](mediastreamsource.md) from the specified [IMediaStreamDescriptor](imediastreamdescriptor.md). + +## -parameters +### -param descriptor +The [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) to create the [MediaStreamSource](mediastreamsource.md) from. + +## -remarks +This constructor creates a [MediaStreamSource](mediastreamsource.md) using a single [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) object. If the [MediaStreamSource](mediastreamsource.md) needs descriptors, the [MediaStreamSource](mediastreamsource_mediastreamsource_998833464.md) constructor overload which takes two descriptor can be used. + +It is possible to add additional descriptors to a [MediaStreamSource](mediastreamsource.md) after it has been created, by invoking the [AddStreamDescriptor](mediastreamsource_addstreamdescriptor.md) method. + +## -examples + +## -see-also +[MediaStreamSource(IMediaStreamDescriptor, IMediaStreamDescriptor)](mediastreamsource_mediastreamsource_998833464.md) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_mediastreamsource_998833464.md b/windows.media.core/mediastreamsource_mediastreamsource_998833464.md index 4fd9bbdc4f..193f1ea83a 100644 --- a/windows.media.core/mediastreamsource_mediastreamsource_998833464.md +++ b/windows.media.core/mediastreamsource_mediastreamsource_998833464.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSource.#ctor(Windows.Media.Core.IMediaStreamDescriptor,Windows.Media.Core.IMediaStreamDescriptor) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSource.MediaStreamSource ## -description Creates an instance of [MediaStreamSource](mediastreamsource.md) from two [IMediaStreamDescriptor](imediastreamdescriptor.md) objects. ## -parameters ### -param descriptor The first [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) to create the [MediaStreamSource](mediastreamsource.md) from. ### -param descriptor2 The second [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) to create the [MediaStreamSource](mediastreamsource.md) from. ## -remarks This constructor creates a [MediaStreamSource](mediastreamsource.md) using a two [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) objects. If the [MediaStreamSource](mediastreamsource.md) needs only on descriptor, the [MediaStreamSource](mediastreamsource_mediastreamsource_1712288544.md) constructor overload which takes two descriptor can be used. It is possible to add additional descriptors to a [MediaStreamSource](mediastreamsource.md) after it has been created, by invoking the [AddStreamDescriptor](mediastreamsource_addstreamdescriptor.md) method. ## -examples ## -see-also [MediaStreamSource(IMediaStreamDescriptor)](mediastreamsource_mediastreamsource_1712288544.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSource.#ctor(Windows.Media.Core.IMediaStreamDescriptor,Windows.Media.Core.IMediaStreamDescriptor) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSource.MediaStreamSource + +## -description +Creates an instance of [MediaStreamSource](mediastreamsource.md) from two [IMediaStreamDescriptor](imediastreamdescriptor.md) objects. + +## -parameters +### -param descriptor +The first [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) to create the [MediaStreamSource](mediastreamsource.md) from. + +### -param descriptor2 +The second [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) to create the [MediaStreamSource](mediastreamsource.md) from. + +## -remarks +This constructor creates a [MediaStreamSource](mediastreamsource.md) using a two [AudioStreamDescriptor](audiostreamdescriptor.md) or [VideoStreamDescriptor](videostreamdescriptor.md) objects. If the [MediaStreamSource](mediastreamsource.md) needs only on descriptor, the [MediaStreamSource](mediastreamsource_mediastreamsource_1712288544.md) constructor overload which takes two descriptor can be used. + +It is possible to add additional descriptors to a [MediaStreamSource](mediastreamsource.md) after it has been created, by invoking the [AddStreamDescriptor](mediastreamsource_addstreamdescriptor.md) method. + +## -examples + +## -see-also +[MediaStreamSource(IMediaStreamDescriptor)](mediastreamsource_mediastreamsource_1712288544.md) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_musicproperties.md b/windows.media.core/mediastreamsource_musicproperties.md index b7981b14b8..d554514032 100644 --- a/windows.media.core/mediastreamsource_musicproperties.md +++ b/windows.media.core/mediastreamsource_musicproperties.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.MusicProperties --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.MusicProperties ## -description Gets the music properties which are used for music-related metadata. ## -property-value The music properties. ## -remarks [MusicProperties](mediastreamsource_musicproperties.md) is a music-oriented view of the [MediaStreamSource](mediastreamsource.md) properties. Applications are allowed to modify the properties of [MusicProperties](mediastreamsource_musicproperties.md) at any time. Applications should be aware that there is overlap with [VideoProperties](mediastreamsource_videoproperties.md). A change to the [MusicProperties](mediastreamsource_musicproperties.md) may modify a similar property in the [VideoProperties](mediastreamsource_videoproperties.md), and vice versa. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.MusicProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.MusicProperties + +## -description +Gets the music properties which are used for music-related metadata. + +## -property-value +The music properties. + +## -remarks +[MusicProperties](mediastreamsource_musicproperties.md) is a music-oriented view of the [MediaStreamSource](mediastreamsource.md) properties. + +Applications are allowed to modify the properties of [MusicProperties](mediastreamsource_musicproperties.md) at any time. + +Applications should be aware that there is overlap with [VideoProperties](mediastreamsource_videoproperties.md). A change to the [MusicProperties](mediastreamsource_musicproperties.md) may modify a similar property in the [VideoProperties](mediastreamsource_videoproperties.md), and vice versa. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_notifyerror_645943664.md b/windows.media.core/mediastreamsource_notifyerror_645943664.md index 2ef70bf6f6..1caf0e5250 100644 --- a/windows.media.core/mediastreamsource_notifyerror_645943664.md +++ b/windows.media.core/mediastreamsource_notifyerror_645943664.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSource.NotifyError(Windows.Media.Core.MediaStreamSourceErrorStatus) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSource.NotifyError ## -description Notifies the [MediaStreamSource](mediastreamsource.md) that an error has occurred which is preventing the application from continuing to deliver data to the [MediaStreamSource](mediastreamsource.md). ## -parameters ### -param errorStatus The cause of the error. ## -remarks The application should invoke this method when it has encountered an unrecoverable error, for example, loss of the network connection to a media server or an out-of-memory condition. The [MediaStreamSource](mediastreamsource.md) will raise the [Closed](mediastreamsource_closed.md) event when this method is invoked. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSource.NotifyError(Windows.Media.Core.MediaStreamSourceErrorStatus) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSource.NotifyError + +## -description +Notifies the [MediaStreamSource](mediastreamsource.md) that an error has occurred which is preventing the application from continuing to deliver data to the [MediaStreamSource](mediastreamsource.md). + +## -parameters +### -param errorStatus +The cause of the error. + +## -remarks +The application should invoke this method when it has encountered an unrecoverable error, for example, loss of the network connection to a media server or an out-of-memory condition. + +The [MediaStreamSource](mediastreamsource.md) will raise the [Closed](mediastreamsource_closed.md) event when this method is invoked. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_paused.md b/windows.media.core/mediastreamsource_paused.md index 182c5800e2..7074c2731e 100644 --- a/windows.media.core/mediastreamsource_paused.md +++ b/windows.media.core/mediastreamsource_paused.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSource.Paused --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSource.Paused ## -description Occurs when the [MediaStreamSource](mediastreamsource.md) is paused and stops requesting [MediaStreamSample](mediastreamsample.md) objects for an unspecified period of time, but is expected to resume requesting [MediaStreamSample](mediastreamsample.md) objects from the current position. ## -remarks This event might be raised by the user pressing a “Pause” button in the UI. When the user decides to resume playback, it is likely that the [Starting](mediastreamsource_starting.md) event will indicate that the [MediaStreamSample](mediastreamsample.md) objects should continue to be delivered from the current position. The [Paused](mediastreamsource_paused.md) event serves as a hint to the application that the next [Starting](mediastreamsource_starting.md) event will specify the current position. The event is informational. Applications are not required to have a handler for this event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSource.Paused +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSource.Paused + +## -description +Occurs when the [MediaStreamSource](mediastreamsource.md) is paused and stops requesting [MediaStreamSample](mediastreamsample.md) objects for an unspecified period of time, but is expected to resume requesting [MediaStreamSample](mediastreamsample.md) objects from the current position. + +## -remarks +This event might be raised by the user pressing a “Pause” button in the UI. When the user decides to resume playback, it is likely that the [Starting](mediastreamsource_starting.md) event will indicate that the [MediaStreamSample](mediastreamsample.md) objects should continue to be delivered from the current position. The [Paused](mediastreamsource_paused.md) event serves as a hint to the application that the next [Starting](mediastreamsource_starting.md) event will specify the current position. + +The event is informational. Applications are not required to have a handler for this event. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_samplerendered.md b/windows.media.core/mediastreamsource_samplerendered.md index 23ac7bdb2c..24987a7637 100644 --- a/windows.media.core/mediastreamsource_samplerendered.md +++ b/windows.media.core/mediastreamsource_samplerendered.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSource.SampleRendered --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSource.SampleRendered ## -description Occurs when a sample from the [MediaStreamSource](mediastreamsource.md) is rendered. ## -remarks Use this event to determine if there is a lag in the rendering of a sample, in which case you may decide to switch to a lower-bandwidth stream. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSource.SampleRendered +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSource.SampleRendered + +## -description +Occurs when a sample from the [MediaStreamSource](mediastreamsource.md) is rendered. + +## -remarks +Use this event to determine if there is a lag in the rendering of a sample, in which case you may decide to switch to a lower-bandwidth stream. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_samplerequested.md b/windows.media.core/mediastreamsource_samplerequested.md index 068e5a241a..e9ff35b395 100644 --- a/windows.media.core/mediastreamsource_samplerequested.md +++ b/windows.media.core/mediastreamsource_samplerequested.md @@ -1,3 +1,25 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSource.SampleRequested --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSource.SampleRequested ## -description Occurs when the [MediaStreamSource](mediastreamsource.md) request a [MediaStreamSample](mediastreamsample.md) for a specified stream. ## -remarks Upon receiving this event, the application should assign a [MediaStreamSample](mediastreamsample.md) for the requested stream to the [Sample](mediastreamsourcesamplerequest_sample.md) property of the [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object. If the application is temporarily unable to deliver the [MediaStreamSample](mediastreamsample.md), it should obtain the [MediaStreamSourceSampleRequestDeferral](mediastreamsourcesamplerequestdeferral.md) object and invoke [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) on a regular basis until it assigns a [MediaStreamSample](mediastreamsample.md) to the [Sample](mediastreamsourcesamplerequest_sample.md) property and calls [Complete](mediastreamsourcesamplerequestdeferral_complete.md) on the [MediaStreamSourceSampleRequestDeferral](mediastreamsourcesamplerequestdeferral.md) object. The recommended interval between each invocation of [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) is 500 milliseconds. If the specified stream does not have any more samples, the application should leave the [Sample](mediastreamsourcesamplerequest_sample.md) property unassigned or set it to **null**. ## -examples ## -see-also [MediaStreamSourceSampleRequestedEventArgs](mediastreamsourcesamplerequestedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSource.SampleRequested +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSource.SampleRequested + +## -description +Occurs when the [MediaStreamSource](mediastreamsource.md) request a [MediaStreamSample](mediastreamsample.md) for a specified stream. + +## -remarks +Upon receiving this event, the application should assign a [MediaStreamSample](mediastreamsample.md) for the requested stream to the [Sample](mediastreamsourcesamplerequest_sample.md) property of the [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object. + +If the application is temporarily unable to deliver the [MediaStreamSample](mediastreamsample.md), it should obtain the [MediaStreamSourceSampleRequestDeferral](mediastreamsourcesamplerequestdeferral.md) object and invoke [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) on a regular basis until it assigns a [MediaStreamSample](mediastreamsample.md) to the [Sample](mediastreamsourcesamplerequest_sample.md) property and calls [Complete](mediastreamsourcesamplerequestdeferral_complete.md) on the [MediaStreamSourceSampleRequestDeferral](mediastreamsourcesamplerequestdeferral.md) object. The recommended interval between each invocation of [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) is 500 milliseconds. + +If the specified stream does not have any more samples, the application should leave the [Sample](mediastreamsourcesamplerequest_sample.md) property unassigned or set it to **null**. + +## -examples + +## -see-also +[MediaStreamSourceSampleRequestedEventArgs](mediastreamsourcesamplerequestedeventargs.md) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_setbufferedrange_149711772.md b/windows.media.core/mediastreamsource_setbufferedrange_149711772.md index d300b04d7d..97934fd033 100644 --- a/windows.media.core/mediastreamsource_setbufferedrange_149711772.md +++ b/windows.media.core/mediastreamsource_setbufferedrange_149711772.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSource.SetBufferedRange(Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSource.SetBufferedRange ## -description Sets the range of data that the application is currently buffering. ## -parameters ### -param startOffset The smallest time stamp of a [MediaStreamSample](mediastreamsample.md) buffered by the application. ### -param endOffset The largest time stamp of a [MediaStreamSample](mediastreamsample.md) buffered by the application. ## -remarks Applications that use the network to stream or download the data for [MediaStreamSamples](mediastreamsample.md) should invoke [SetBufferedRange](mediastreamsource_setbufferedrange.md) to specify what portion of the time-line is currently buffered. If the buffered range extends from 0 to the value of [Duration](mediastreamsource_duration.md), and [Duration](mediastreamsource_duration.md) is non-zero, the operating system may allow the network hardware to enter a power saving mode. By default, the buffered range is assumed to be empty when the [CanSeek](mediastreamsource_canseek.md) property is **false** or when the [Duration](mediastreamsource_duration.md) property is 0. If [CanSeek](mediastreamsource_canseek.md) is **true**, the buffered range default is 0 to [Duration](mediastreamsource_duration.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSource.SetBufferedRange(Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSource.SetBufferedRange + +## -description +Sets the range of data that the application is currently buffering. + +## -parameters +### -param startOffset +The smallest time stamp of a [MediaStreamSample](mediastreamsample.md) buffered by the application. + +### -param endOffset +The largest time stamp of a [MediaStreamSample](mediastreamsample.md) buffered by the application. + +## -remarks +Applications that use the network to stream or download the data for [MediaStreamSamples](mediastreamsample.md) should invoke [SetBufferedRange](mediastreamsource_setbufferedrange.md) to specify what portion of the time-line is currently buffered. If the buffered range extends from 0 to the value of [Duration](mediastreamsource_duration.md), and [Duration](mediastreamsource_duration.md) is non-zero, the operating system may allow the network hardware to enter a power saving mode. + +By default, the buffered range is assumed to be empty when the [CanSeek](mediastreamsource_canseek.md) property is **false** or when the [Duration](mediastreamsource_duration.md) property is 0. If [CanSeek](mediastreamsource_canseek.md) is **true**, the buffered range default is 0 to [Duration](mediastreamsource_duration.md) + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_starting.md b/windows.media.core/mediastreamsource_starting.md index 0d8b91772f..f271be7f97 100644 --- a/windows.media.core/mediastreamsource_starting.md +++ b/windows.media.core/mediastreamsource_starting.md @@ -1,3 +1,27 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSource.Starting --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSource.Starting ## -description Occurs when the [MediaStreamSource](mediastreamsource.md) is ready to start requesting [MediaStreamSample](mediastreamsample.md) objects. The event can specify a position in the media time-line from which the first [MediaStreamSample](mediastreamsample.md) should be delivered. ## -remarks The [MediaStreamSource](mediastreamsource.md) raises this event before it starts requesting [MediaStreamSamples](mediastreamsample.md) for the first time. It also raises the event when it resumes requesting [MediaStreamSamples](mediastreamsample.md) after a [Paused](mediastreamsource_paused.md) event has occurred. Upon receiving this event, the application must invoke the [SetActualStartPosition](mediastreamsourcestartingrequest_setactualstartposition.md) method on the [MediaStreamSourceStartingRequest](mediastreamsourcestartingrequest.md) object to specify the actual position in the time-line from which [MediaStreamSample](mediastreamsample.md) objects will be retrieved. This event cancels any [SampleRequested](mediastreamsource_samplerequested.md) events the application has not delivered the requested [MediaStreamSample](mediastreamsample.md) for. However, application must still invoke the [Complete](mediastreamsourcesamplerequestdeferral_complete.md) method on the [MediaStreamSourceSampleRequestDeferral](mediastreamsourcesamplerequestdeferral.md) object for any previous [SampleRequested](mediastreamsource_samplerequested.md) events. Applications are only required to have a handler for the [Starting](mediastreamsource_starting.md) event if [MediaStreamSource.CanSeek](mediastreamsource_canseek.md) is set to **true** and they support seeking. ## -examples ## -see-also [MediaStreamSourceStartingEventArgs](mediastreamsourcestartingeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSource.Starting +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSource.Starting + +## -description +Occurs when the [MediaStreamSource](mediastreamsource.md) is ready to start requesting [MediaStreamSample](mediastreamsample.md) objects. The event can specify a position in the media time-line from which the first [MediaStreamSample](mediastreamsample.md) should be delivered. + +## -remarks +The [MediaStreamSource](mediastreamsource.md) raises this event before it starts requesting [MediaStreamSamples](mediastreamsample.md) for the first time. It also raises the event when it resumes requesting [MediaStreamSamples](mediastreamsample.md) after a [Paused](mediastreamsource_paused.md) event has occurred. + +Upon receiving this event, the application must invoke the [SetActualStartPosition](mediastreamsourcestartingrequest_setactualstartposition.md) method on the [MediaStreamSourceStartingRequest](mediastreamsourcestartingrequest.md) object to specify the actual position in the time-line from which [MediaStreamSample](mediastreamsample.md) objects will be retrieved. + +This event cancels any [SampleRequested](mediastreamsource_samplerequested.md) events the application has not delivered the requested [MediaStreamSample](mediastreamsample.md) for. However, application must still invoke the [Complete](mediastreamsourcesamplerequestdeferral_complete.md) method on the [MediaStreamSourceSampleRequestDeferral](mediastreamsourcesamplerequestdeferral.md) object for any previous [SampleRequested](mediastreamsource_samplerequested.md) events. + +Applications are only required to have a handler for the [Starting](mediastreamsource_starting.md) event if [MediaStreamSource.CanSeek](mediastreamsource_canseek.md) is set to **true** and they support seeking. + +## -examples + +## -see-also +[MediaStreamSourceStartingEventArgs](mediastreamsourcestartingeventargs.md) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_switchstreamsrequested.md b/windows.media.core/mediastreamsource_switchstreamsrequested.md index dec46c0db4..cde0ee3b1c 100644 --- a/windows.media.core/mediastreamsource_switchstreamsrequested.md +++ b/windows.media.core/mediastreamsource_switchstreamsrequested.md @@ -1,3 +1,23 @@ ---- -api-id: E:Windows.Media.Core.MediaStreamSource.SwitchStreamsRequested --api-type: winrt event ---- # Windows.Media.Core.MediaStreamSource.SwitchStreamsRequested ## -description Occurs when the [MediaStreamSource](mediastreamsource.md) will stop requesting [MediaStreamSample](mediastreamsample.md) objects for a certain stream and will start requesting [MediaStreamSample](mediastreamsample.md) objects from a different stream instead. ## -remarks This event can be raised when there are multiple audio stream descriptors or multiple video stream descriptors. Normally, only one audio stream and one video stream will be selected at any given time. This event is raised when the currently selected audio or video stream is replaced by a different stream. The event is informational. Applications are not required to have a handler for this event. ## -examples ## -see-also [MediaStreamSourceSwitchStreamsRequestedEventArgs](mediastreamsourceswitchstreamsrequestedeventargs.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MediaStreamSource.SwitchStreamsRequested +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaStreamSource.SwitchStreamsRequested + +## -description +Occurs when the [MediaStreamSource](mediastreamsource.md) will stop requesting [MediaStreamSample](mediastreamsample.md) objects for a certain stream and will start requesting [MediaStreamSample](mediastreamsample.md) objects from a different stream instead. + +## -remarks +This event can be raised when there are multiple audio stream descriptors or multiple video stream descriptors. Normally, only one audio stream and one video stream will be selected at any given time. This event is raised when the currently selected audio or video stream is replaced by a different stream. + +The event is informational. Applications are not required to have a handler for this event. + +## -examples + +## -see-also +[MediaStreamSourceSwitchStreamsRequestedEventArgs](mediastreamsourceswitchstreamsrequestedeventargs.md) \ No newline at end of file diff --git a/windows.media.core/mediastreamsource_thumbnail.md b/windows.media.core/mediastreamsource_thumbnail.md index d253ea73f6..49df03cc72 100644 --- a/windows.media.core/mediastreamsource_thumbnail.md +++ b/windows.media.core/mediastreamsource_thumbnail.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.Thumbnail --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.Thumbnail ## -description Gets or sets the thumbnail which is a reference to a stream for a video thumbnail image or music album art. ## -property-value The reference to the thumbnail stream. ## -remarks The stream is treated as a video thumbnail if the [MediaStreamSource](mediastreamsource.md) has at least one video stream; otherwise, the stream is treated as music album art. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.Thumbnail + +## -description +Gets or sets the thumbnail which is a reference to a stream for a video thumbnail image or music album art. + +## -property-value +The reference to the thumbnail stream. + +## -remarks +The stream is treated as a video thumbnail if the [MediaStreamSource](mediastreamsource.md) has at least one video stream; otherwise, the stream is treated as music album art. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsource_videoproperties.md b/windows.media.core/mediastreamsource_videoproperties.md index 89c2a90a30..0fb1e0cef2 100644 --- a/windows.media.core/mediastreamsource_videoproperties.md +++ b/windows.media.core/mediastreamsource_videoproperties.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSource.VideoProperties --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSource.VideoProperties ## -description Gets the video properties which are used for video related metadata. ## -property-value The video properties. ## -remarks [VideoProperties](mediastreamsource_videoproperties.md) is a video-oriented view of the [MediaStreamSource](mediastreamsource.md) properties. Applications are allowed to modify the properties of [VideoProperties](mediastreamsource_videoproperties.md) at any time. Applications should be aware that there is overlap with [MusicProperties](mediastreamsource_musicproperties.md). A change to the [VideoProperties](mediastreamsource_videoproperties.md) may modify a similar property in the [MusicProperties](mediastreamsource_musicproperties.md) property, and vice versa. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.VideoProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.VideoProperties + +## -description +Gets the video properties which are used for video related metadata. + +## -property-value +The video properties. + +## -remarks +[VideoProperties](mediastreamsource_videoproperties.md) is a video-oriented view of the [MediaStreamSource](mediastreamsource.md) properties. + +Applications are allowed to modify the properties of [VideoProperties](mediastreamsource_videoproperties.md) at any time. + +Applications should be aware that there is overlap with [MusicProperties](mediastreamsource_musicproperties.md). A change to the [VideoProperties](mediastreamsource_videoproperties.md) may modify a similar property in the [MusicProperties](mediastreamsource_musicproperties.md) property, and vice versa. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceclosedeventargs.md b/windows.media.core/mediastreamsourceclosedeventargs.md index dba61cfdab..baa6876a6b 100644 --- a/windows.media.core/mediastreamsourceclosedeventargs.md +++ b/windows.media.core/mediastreamsourceclosedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceClosedEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceClosedEventArgs ## -description Provides data for the [MediaStreamSource.Closed](mediastreamsource_closed.md) event. ## -remarks This object is not instantiated directly, it is created by the [MediaStreamSource.Closed](mediastreamsource_closed.md) event. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceClosedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceClosedEventArgs + +## -description +Provides data for the [MediaStreamSource.Closed](mediastreamsource_closed.md) event. + +## -remarks +This object is not instantiated directly, it is created by the [MediaStreamSource.Closed](mediastreamsource_closed.md) event. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Universal Windows app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourceclosedeventargs_request.md b/windows.media.core/mediastreamsourceclosedeventargs_request.md index 391f10d53d..6d07385c33 100644 --- a/windows.media.core/mediastreamsourceclosedeventargs_request.md +++ b/windows.media.core/mediastreamsourceclosedeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceClosedEventArgs.Request --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceClosedEventArgs.Request ## -description Gets the object that represents the notification that the [MediaStreamSource](mediastreamsource.md) has been closed. ## -property-value Provides information regarding why the [MediaStreamSource](mediastreamsource.md) was closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceClosedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceClosedEventArgs.Request + +## -description +Gets the object that represents the notification that the [MediaStreamSource](mediastreamsource.md) has been closed. + +## -property-value +Provides information regarding why the [MediaStreamSource](mediastreamsource.md) was closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceclosedrequest.md b/windows.media.core/mediastreamsourceclosedrequest.md index ff942bc9c1..a16928e15a 100644 --- a/windows.media.core/mediastreamsourceclosedrequest.md +++ b/windows.media.core/mediastreamsourceclosedrequest.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceClosedRequest --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceClosedRequest ## -description Represents an object to be used by the [MediaStreamSource.closed](mediastreamsource_closed.md) event to provide information to the application. ## -remarks The [Reason](mediastreamsourceclosedreason.md) property provides information regrading why the [MediaStreamSource](mediastreamsource.md) was closed. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceClosedRequest +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceClosedRequest + +## -description +Represents an object to be used by the [MediaStreamSource.closed](mediastreamsource_closed.md) event to provide information to the application. + +## -remarks +The [Reason](mediastreamsourceclosedreason.md) property provides information regrading why the [MediaStreamSource](mediastreamsource.md) was closed. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourceclosedrequest_reason.md b/windows.media.core/mediastreamsourceclosedrequest_reason.md index f52966baf5..0472386866 100644 --- a/windows.media.core/mediastreamsourceclosedrequest_reason.md +++ b/windows.media.core/mediastreamsourceclosedrequest_reason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceClosedRequest.Reason --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceClosedRequest.Reason ## -description Gets the reason why the media stream source was closed. ## -property-value The reason why the media stream source was closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceClosedRequest.Reason +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceClosedRequest.Reason + +## -description +Gets the reason why the media stream source was closed. + +## -property-value +The reason why the media stream source was closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerenderedeventargs.md b/windows.media.core/mediastreamsourcesamplerenderedeventargs.md index feda9fd2b5..23cac79913 100644 --- a/windows.media.core/mediastreamsourcesamplerenderedeventargs.md +++ b/windows.media.core/mediastreamsourcesamplerenderedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs ## -description Provides data for the [MediaStreamSource.SampleRendered](mediastreamsource_samplerendered.md) event, which occurs when a sample from a [MediaStreamSource](mediastreamsource.md) is rendered. Use [SampleLag](mediastreamsourcesamplerenderedeventargs_samplelag.md) property to determine if there is a lag in the rendering of a sample, in which case you may decide to switch to a lower-bandwidth stream. ## -remarks Get an instance of this class by handling the [MediaStreamSource.SampleRendered](mediastreamsource_samplerendered.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs + +## -description +Provides data for the [MediaStreamSource.SampleRendered](mediastreamsource_samplerendered.md) event, which occurs when a sample from a [MediaStreamSource](mediastreamsource.md) is rendered. Use [SampleLag](mediastreamsourcesamplerenderedeventargs_samplelag.md) property to determine if there is a lag in the rendering of a sample, in which case you may decide to switch to a lower-bandwidth stream. + +## -remarks +Get an instance of this class by handling the [MediaStreamSource.SampleRendered](mediastreamsource_samplerendered.md) event. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerenderedeventargs_samplelag.md b/windows.media.core/mediastreamsourcesamplerenderedeventargs_samplelag.md index 57d2eefa4d..efc0ba4b78 100644 --- a/windows.media.core/mediastreamsourcesamplerenderedeventargs_samplelag.md +++ b/windows.media.core/mediastreamsourcesamplerenderedeventargs_samplelag.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs.SampleLag --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs.SampleLag ## -description Gets a time span representing the lag with which a sample was rendered. ## -property-value The lag with which a sample was rendered. ## -remarks If the value of this property is greater than 0, then the sample was rendered late. In this case, depending on the size of the lag, you may choose to switch to a lower bandwidth stream in order to reduce lag. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs.SampleLag +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRenderedEventArgs.SampleLag + +## -description +Gets a time span representing the lag with which a sample was rendered. + +## -property-value +The lag with which a sample was rendered. + +## -remarks +If the value of this property is greater than 0, then the sample was rendered late. In this case, depending on the size of the lag, you may choose to switch to a lower bandwidth stream in order to reduce lag. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerequest.md b/windows.media.core/mediastreamsourcesamplerequest.md index 6ffabfe527..432a84741c 100644 --- a/windows.media.core/mediastreamsourcesamplerequest.md +++ b/windows.media.core/mediastreamsourcesamplerequest.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSampleRequest --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSampleRequest ## -description Represents an object to be used by the [MediaStreamSource.SampleRequest](mediastreamsource_samplerequested.md) event to provide information to the application. ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSampleRequest +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequest + +## -description +Represents an object to be used by the [MediaStreamSource.SampleRequest](mediastreamsource_samplerequested.md) event to provide information to the application. + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourcesamplerequest_getdeferral_254836512.md b/windows.media.core/mediastreamsourcesamplerequest_getdeferral_254836512.md index c27645ed1e..f15482f31b 100644 --- a/windows.media.core/mediastreamsourcesamplerequest_getdeferral_254836512.md +++ b/windows.media.core/mediastreamsourcesamplerequest_getdeferral_254836512.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceSampleRequest.GetDeferral --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceSampleRequest.GetDeferral ## -description Defers assigning a [MediaStreamSample](mediastreamsample.md) to [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object. ## -returns The deferral. ## -remarks You can use a deferral when you want to make an asynchronous call to retrieve the [MediaStreamSample](mediastreamsample.md). The [MediaStreamSource](mediastreamsource.md) will then wait for you to supply the [MediaStreamSample](mediastreamsample.md) until you mark the deferral as complete. To create a deferral, call the [GetDeferral](mediastreamsourcesamplerequest_getdeferral.md) method to instruct the [MediaStreamSource](mediastreamsource.md) to wait for the [MediaStreamSample](mediastreamsample.md). After you have assigned the [MediaStreamSample](mediastreamsample.md) to the [Sample](mediastreamsourcesamplerequest_sample.md) property of the [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object, call the [MediaStreamSourceSampleRequestDeferral.Complete](mediastreamsourcesamplerequestdeferral_complete.md) method to end the deferral. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceSampleRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequest.GetDeferral + +## -description +Defers assigning a [MediaStreamSample](mediastreamsample.md) to [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object. + +## -returns +The deferral. + +## -remarks +You can use a deferral when you want to make an asynchronous call to retrieve the [MediaStreamSample](mediastreamsample.md). The [MediaStreamSource](mediastreamsource.md) will then wait for you to supply the [MediaStreamSample](mediastreamsample.md) until you mark the deferral as complete. + +To create a deferral, call the [GetDeferral](mediastreamsourcesamplerequest_getdeferral.md) method to instruct the [MediaStreamSource](mediastreamsource.md) to wait for the [MediaStreamSample](mediastreamsample.md). After you have assigned the [MediaStreamSample](mediastreamsample.md) to the [Sample](mediastreamsourcesamplerequest_sample.md) property of the [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object, call the [MediaStreamSourceSampleRequestDeferral.Complete](mediastreamsourcesamplerequestdeferral_complete.md) method to end the deferral. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerequest_reportsampleprogress_2045860101.md b/windows.media.core/mediastreamsourcesamplerequest_reportsampleprogress_2045860101.md index 3e691e7e84..10b1ec92c0 100644 --- a/windows.media.core/mediastreamsourcesamplerequest_reportsampleprogress_2045860101.md +++ b/windows.media.core/mediastreamsourcesamplerequest_reportsampleprogress_2045860101.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceSampleRequest.ReportSampleProgress(System.UInt32) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceSampleRequest.ReportSampleProgress ## -description Provides a status update to the [MediaStreamSource](mediastreamsource.md) while the application is temporarily unable to deliver a requested [MediaStreamSample](mediastreamsample.md). ## -parameters ### -param progress A value between 0 to 100 that indicates the progress towards being able to deliver the requested [MediaStreamSample](mediastreamsample.md). ## -remarks The application should invoke this method when it is unable to immediately to deliver the [MediaStreamSample](mediastreamsample.md), which is accomplished by assigning it to the [Sample](mediastreamsourcesamplerequest_sample.md) property. The application should continue to invoke [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) on a regular basis until it is able to deliver the requested [MediaStreamSample](mediastreamsample.md). The recommended interval between each invocation of [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) is 500 milliseconds. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceSampleRequest.ReportSampleProgress(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequest.ReportSampleProgress + +## -description +Provides a status update to the [MediaStreamSource](mediastreamsource.md) while the application is temporarily unable to deliver a requested [MediaStreamSample](mediastreamsample.md). + +## -parameters +### -param progress +A value between 0 to 100 that indicates the progress towards being able to deliver the requested [MediaStreamSample](mediastreamsample.md). + +## -remarks +The application should invoke this method when it is unable to immediately to deliver the [MediaStreamSample](mediastreamsample.md), which is accomplished by assigning it to the [Sample](mediastreamsourcesamplerequest_sample.md) property. The application should continue to invoke [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) on a regular basis until it is able to deliver the requested [MediaStreamSample](mediastreamsample.md). + +The recommended interval between each invocation of [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) is 500 milliseconds. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerequest_sample.md b/windows.media.core/mediastreamsourcesamplerequest_sample.md index 57c2506442..83f1ff4d74 100644 --- a/windows.media.core/mediastreamsourcesamplerequest_sample.md +++ b/windows.media.core/mediastreamsourcesamplerequest_sample.md @@ -1,3 +1,33 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSampleRequest.Sample --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSampleRequest.Sample ## -description Sets the [MediaStreamSample](mediastreamsample.md) requested by the [MediaStreamSource](mediastreamsource.md). Applications deliver a [MediaStreamSample](mediastreamsample.md) to the [MediaStreamSource](mediastreamsource.md) by assigning a value to this property. ## -property-value The sample which is delivered to the [MediaStreamSource](mediastreamsource.md) when this property is set. The default value is **null**. ## -remarks The initial value of this property is **null**. The application should allocate a [MediaStreamSample](mediastreamsample.md) and deliver it to the [MediaStreamSource](mediastreamsource.md) by assigning the [MediaStreamSample](mediastreamsample.md) to this property. If there are no more [MediaStreamSamples](mediastreamsample.md) to deliver to the stream identified by the [StreamDescriptor](mediastreamsourcesamplerequest_streamdescriptor.md) property because the end of the stream has been reached, then the application should set the [Sample](mediastreamsourcesamplerequest_sample.md) property to **null**. If the application needs to perform an asynchronous operation to retrieve the [MediaStreamSample](mediastreamsample.md), it should invoke the [GetDeferral](mediastreamsourcesamplerequest_getdeferral.md) method to indicate that the assignment of the [Sample](mediastreamsourcesamplerequest_sample.md) property has been deferred. If a [MediaStreamSample](mediastreamsample.md) is not currently available, for example, because it has not yet been downloaded from a server, the application should call [GetDeferral](mediastreamsourcesamplerequest_getdeferral.md) and also call [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) on as the necessary data is being downloaded. The recommended interval between each invocation of [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) is 500 milliseconds. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSampleRequest.Sample +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequest.Sample + +## -description +Sets the [MediaStreamSample](mediastreamsample.md) requested by the [MediaStreamSource](mediastreamsource.md). Applications deliver a [MediaStreamSample](mediastreamsample.md) to the [MediaStreamSource](mediastreamsource.md) by assigning a value to this property. + +## -property-value +The sample which is delivered to the [MediaStreamSource](mediastreamsource.md) when this property is set. The default value is **null**. + +## -remarks +The initial value of this property is **null**. + +The application should allocate a [MediaStreamSample](mediastreamsample.md) and deliver it to the [MediaStreamSource](mediastreamsource.md) by assigning the [MediaStreamSample](mediastreamsample.md) to this property. + +If there are no more [MediaStreamSamples](mediastreamsample.md) to deliver to the stream identified by the [StreamDescriptor](mediastreamsourcesamplerequest_streamdescriptor.md) property because the end of the stream has been reached, then the application should set the [Sample](mediastreamsourcesamplerequest_sample.md) property to **null**. + +If the application needs to perform an asynchronous operation to retrieve the [MediaStreamSample](mediastreamsample.md), it should invoke the [GetDeferral](mediastreamsourcesamplerequest_getdeferral.md) method to indicate that the assignment of the [Sample](mediastreamsourcesamplerequest_sample.md) property has been deferred. + +If a [MediaStreamSample](mediastreamsample.md) is not currently available, for example, because it has not yet been downloaded from a server, the application should call [GetDeferral](mediastreamsourcesamplerequest_getdeferral.md) and also call [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) on as the necessary data is being downloaded. + +The recommended interval between each invocation of [ReportSampleProgress](mediastreamsourcesamplerequest_reportsampleprogress.md) is 500 milliseconds. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerequest_streamdescriptor.md b/windows.media.core/mediastreamsourcesamplerequest_streamdescriptor.md index 5235eb101d..1e0f85437a 100644 --- a/windows.media.core/mediastreamsourcesamplerequest_streamdescriptor.md +++ b/windows.media.core/mediastreamsourcesamplerequest_streamdescriptor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSampleRequest.StreamDescriptor --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSampleRequest.StreamDescriptor ## -description Gets the [IMediaStreamDescriptor](imediastreamdescriptor.md) interface of the stream for which a [MediaStreamSample](mediastreamsample.md) is being requested. ## -property-value The stream for which the [MediaStreamSample](mediastreamsample.md) is being requested. ## -remarks The [Sample](mediastreamsourcesamplerequest_sample.md) property of the [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object should be assigned a [MediaStreamSample](mediastreamsample.md) belonging to the stream identified by the [StreamDescriptor](mediastreamsourcesamplerequest_streamdescriptor.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSampleRequest.StreamDescriptor +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequest.StreamDescriptor + +## -description +Gets the [IMediaStreamDescriptor](imediastreamdescriptor.md) interface of the stream for which a [MediaStreamSample](mediastreamsample.md) is being requested. + +## -property-value +The stream for which the [MediaStreamSample](mediastreamsample.md) is being requested. + +## -remarks +The [Sample](mediastreamsourcesamplerequest_sample.md) property of the [MediaStreamSourceSampleRequest](mediastreamsourcesamplerequest.md) object should be assigned a [MediaStreamSample](mediastreamsample.md) belonging to the stream identified by the [StreamDescriptor](mediastreamsourcesamplerequest_streamdescriptor.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerequestdeferral.md b/windows.media.core/mediastreamsourcesamplerequestdeferral.md index 2a02639825..6af852de0e 100644 --- a/windows.media.core/mediastreamsourcesamplerequestdeferral.md +++ b/windows.media.core/mediastreamsourcesamplerequestdeferral.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSampleRequestDeferral --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSampleRequestDeferral ## -description Provides a way for the application to asynchronously report that it has completed retrieving the [MediaStreamSample](mediastreamsample.md). ## -remarks You can use a deferral to retrieve the [MediaStreamSample](mediastreamsample.md) asynchronously. The [MediaStreamSource](mediastreamsource.md) will wait until you mark the deferral as complete. To create a deferral, call [MediaStreamSourceSampleRequest.GetDeferral](mediastreamsourcesamplerequest_getdeferral.md). This will instruct the [MediaStreamSource](mediastreamsource.md) to wait for the [MediaStreamSample](mediastreamsample.md). After you have assigned the [MediaStreamSample](mediastreamsample.md) to the [MediaStreamSourceSampleRequest.Sample](mediastreamsourcesamplerequest_sample.md) property, call the [Complete](mediastreamsourcesamplerequestdeferral_complete.md) method to end the deferral. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSampleRequestDeferral +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequestDeferral + +## -description +Provides a way for the application to asynchronously report that it has completed retrieving the [MediaStreamSample](mediastreamsample.md). + +## -remarks +You can use a deferral to retrieve the [MediaStreamSample](mediastreamsample.md) asynchronously. The [MediaStreamSource](mediastreamsource.md) will wait until you mark the deferral as complete. + +To create a deferral, call [MediaStreamSourceSampleRequest.GetDeferral](mediastreamsourcesamplerequest_getdeferral.md). This will instruct the [MediaStreamSource](mediastreamsource.md) to wait for the [MediaStreamSample](mediastreamsample.md). After you have assigned the [MediaStreamSample](mediastreamsample.md) to the [MediaStreamSourceSampleRequest.Sample](mediastreamsourcesamplerequest_sample.md) property, call the [Complete](mediastreamsourcesamplerequestdeferral_complete.md) method to end the deferral. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourcesamplerequestdeferral_complete_1807836922.md b/windows.media.core/mediastreamsourcesamplerequestdeferral_complete_1807836922.md index 577f67fd52..667679a5d5 100644 --- a/windows.media.core/mediastreamsourcesamplerequestdeferral_complete_1807836922.md +++ b/windows.media.core/mediastreamsourcesamplerequestdeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceSampleRequestDeferral.Complete --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceSampleRequestDeferral.Complete ## -description Reports that the application has completed retrieving the [MediaStreamSample](mediastreamsample.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceSampleRequestDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequestDeferral.Complete + +## -description +Reports that the application has completed retrieving the [MediaStreamSample](mediastreamsample.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcesamplerequestedeventargs.md b/windows.media.core/mediastreamsourcesamplerequestedeventargs.md index 8f2783e126..469f31b504 100644 --- a/windows.media.core/mediastreamsourcesamplerequestedeventargs.md +++ b/windows.media.core/mediastreamsourcesamplerequestedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs ## -description Provides the data for the [SampleRequested](mediastreamsource_samplerequested.md) event. ## -remarks This object is not instantiated directly, it is created by the [MediaStreamSource.SampleRequest](mediastreamsource_samplerequested.md) event. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs + +## -description +Provides the data for the [SampleRequested](mediastreamsource_samplerequested.md) event. + +## -remarks +This object is not instantiated directly, it is created by the [MediaStreamSource.SampleRequest](mediastreamsource_samplerequested.md) event. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourcesamplerequestedeventargs_request.md b/windows.media.core/mediastreamsourcesamplerequestedeventargs_request.md index 5cc905e027..4f6e6d2a48 100644 --- a/windows.media.core/mediastreamsourcesamplerequestedeventargs_request.md +++ b/windows.media.core/mediastreamsourcesamplerequestedeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs.Request --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs.Request ## -description Gets the object that represents the request for a [MediaStreamSample](mediastreamsample.md). ## -property-value Provides information regrading the request for a [MediaStreamSample](mediastreamsample.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSampleRequestedEventArgs.Request + +## -description +Gets the object that represents the request for a [MediaStreamSample](mediastreamsample.md). + +## -property-value +Provides information regrading the request for a [MediaStreamSample](mediastreamsample.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcestartingeventargs.md b/windows.media.core/mediastreamsourcestartingeventargs.md index 5914e605d3..df79767dfc 100644 --- a/windows.media.core/mediastreamsourcestartingeventargs.md +++ b/windows.media.core/mediastreamsourcestartingeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceStartingEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceStartingEventArgs ## -description Provides data for the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. ## -remarks This object is not instantiated directly, it is created by the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceStartingEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingEventArgs + +## -description +Provides data for the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. + +## -remarks +This object is not instantiated directly, it is created by the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourcestartingeventargs_request.md b/windows.media.core/mediastreamsourcestartingeventargs_request.md index 0d7e4b3b77..68cc4ca8b1 100644 --- a/windows.media.core/mediastreamsourcestartingeventargs_request.md +++ b/windows.media.core/mediastreamsourcestartingeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceStartingEventArgs.Request --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceStartingEventArgs.Request ## -description Gets the object that represents the request to start accumulating [MediaStreamSample](mediastreamsample.md) data. ## -property-value Provides information regrading the request to start accumulating [MediaStreamSample](mediastreamsample.md) data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceStartingEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingEventArgs.Request + +## -description +Gets the object that represents the request to start accumulating [MediaStreamSample](mediastreamsample.md) data. + +## -property-value +Provides information regrading the request to start accumulating [MediaStreamSample](mediastreamsample.md) data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcestartingrequest.md b/windows.media.core/mediastreamsourcestartingrequest.md index 5c30010430..48f21df9f1 100644 --- a/windows.media.core/mediastreamsourcestartingrequest.md +++ b/windows.media.core/mediastreamsourcestartingrequest.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceStartingRequest --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceStartingRequest ## -description Represents a request from the [MediaStreamSource.Starting](mediastreamsource_starting.md) event for the application to start accumulating [MediaStreamSample](mediastreamsample.md) objects from a specific position in the media. ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceStartingRequest +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingRequest + +## -description +Represents a request from the [MediaStreamSource.Starting](mediastreamsource_starting.md) event for the application to start accumulating [MediaStreamSample](mediastreamsample.md) objects from a specific position in the media. + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourcestartingrequest_getdeferral_254836512.md b/windows.media.core/mediastreamsourcestartingrequest_getdeferral_254836512.md index c0071358fc..feece67d7b 100644 --- a/windows.media.core/mediastreamsourcestartingrequest_getdeferral_254836512.md +++ b/windows.media.core/mediastreamsourcestartingrequest_getdeferral_254836512.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceStartingRequest.GetDeferral --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceStartingRequest.GetDeferral ## -description Defers completing the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. ## -returns The deferral. ## -remarks You can use a deferral when you want to make an asynchronous call in response to the [Starting](mediastreamsource_starting.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. To create a deferral, call the [GetDeferral](mediastreamsourcestartingrequest_getdeferral.md) method to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourcestartingrequestdeferral_complete.md) method to end the deferral. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceStartingRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingRequest.GetDeferral + +## -description +Defers completing the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. + +## -returns +The deferral. + +## -remarks +You can use a deferral when you want to make an asynchronous call in response to the [Starting](mediastreamsource_starting.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. + +To create a deferral, call the [GetDeferral](mediastreamsourcestartingrequest_getdeferral.md) method to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourcestartingrequestdeferral_complete.md) method to end the deferral. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcestartingrequest_setactualstartposition_661405035.md b/windows.media.core/mediastreamsourcestartingrequest_setactualstartposition_661405035.md index 0363c9321a..d8c4b901f9 100644 --- a/windows.media.core/mediastreamsourcestartingrequest_setactualstartposition_661405035.md +++ b/windows.media.core/mediastreamsourcestartingrequest_setactualstartposition_661405035.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceStartingRequest.SetActualStartPosition(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceStartingRequest.SetActualStartPosition ## -description Specifies the starting position in the media time-line for subsequent [MediaStreamSamples](mediastreamsample.md) that will be delivered to the [MediaStreamSource](mediastreamsource.md). ## -parameters ### -param position The actual starting point in the media time-line chosen by the application. ## -remarks The application should choose the value of *position* such that the values of the [Timestamp](mediastreamsample_timestamp.md) property of the [MediaStreamSample](mediastreamsample.md) objects will be greater than or equal to position, for all currently selected streams. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceStartingRequest.SetActualStartPosition(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingRequest.SetActualStartPosition + +## -description +Specifies the starting position in the media time-line for subsequent [MediaStreamSamples](mediastreamsample.md) that will be delivered to the [MediaStreamSource](mediastreamsource.md). + +## -parameters +### -param position +The actual starting point in the media time-line chosen by the application. + +## -remarks +The application should choose the value of *position* such that the values of the [Timestamp](mediastreamsample_timestamp.md) property of the [MediaStreamSample](mediastreamsample.md) objects will be greater than or equal to position, for all currently selected streams. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcestartingrequest_startposition.md b/windows.media.core/mediastreamsourcestartingrequest_startposition.md index 235ccdeb40..f489e06c20 100644 --- a/windows.media.core/mediastreamsourcestartingrequest_startposition.md +++ b/windows.media.core/mediastreamsourcestartingrequest_startposition.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceStartingRequest.StartPosition --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceStartingRequest.StartPosition ## -description Specifies a reference to a [TimeSpan](http://msdn.microsoft.com/library/fbc6ecc2-6372-4b15-9532-3cd68a72e7b4) object which represents a time position in the media time-line from which the application should return [MediaStreamSample](mediastreamsample.md) objects. ## -property-value A reference that points to a [TimeSpan](http://msdn.microsoft.com/library/fbc6ecc2-6372-4b15-9532-3cd68a72e7b4) which specifies the position in the media time-line to start sending [MediaStreamSample](mediastreamsample.md) objects. If the reference is **null**, the application should continue to return [MediaStreamSample](mediastreamsample.md) objects from the current position. ## -remarks If *StartPosition* is not **null**, then the [TimeSpan](http://msdn.microsoft.com/library/fbc6ecc2-6372-4b15-9532-3cd68a72e7b4) specifies the position in the media time-line from which the application should deliver [MediaStreamSamples](mediastreamsample.md). If the reference is **null**, the application is not supposed to change its position and it should then continue to return [MediaStreamSamples](mediastreamsample.md) from the current position. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceStartingRequest.StartPosition +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingRequest.StartPosition + +## -description +Specifies a reference to a [TimeSpan](http://msdn.microsoft.com/library/fbc6ecc2-6372-4b15-9532-3cd68a72e7b4) object which represents a time position in the media time-line from which the application should return [MediaStreamSample](mediastreamsample.md) objects. + +## -property-value +A reference that points to a [TimeSpan](http://msdn.microsoft.com/library/fbc6ecc2-6372-4b15-9532-3cd68a72e7b4) which specifies the position in the media time-line to start sending [MediaStreamSample](mediastreamsample.md) objects. If the reference is **null**, the application should continue to return [MediaStreamSample](mediastreamsample.md) objects from the current position. + +## -remarks +If *StartPosition* is not **null**, then the [TimeSpan](http://msdn.microsoft.com/library/fbc6ecc2-6372-4b15-9532-3cd68a72e7b4) specifies the position in the media time-line from which the application should deliver [MediaStreamSamples](mediastreamsample.md). If the reference is **null**, the application is not supposed to change its position and it should then continue to return [MediaStreamSamples](mediastreamsample.md) from the current position. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourcestartingrequestdeferral.md b/windows.media.core/mediastreamsourcestartingrequestdeferral.md index c57247662f..6ddec32b58 100644 --- a/windows.media.core/mediastreamsourcestartingrequestdeferral.md +++ b/windows.media.core/mediastreamsourcestartingrequestdeferral.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceStartingRequestDeferral --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceStartingRequestDeferral ## -description Provides a way for the application to asynchronously report that it has completed processing the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. ## -remarks You can use a deferral when you want to make an asynchronous call in response to the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. To create a deferral, call the [GetDeferral](mediastreamsourcestartingrequest_getdeferral.md) method on the [MediaStreamSourceStartingRequest](mediastreamsourcestartingrequest.md) object to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourcestartingrequestdeferral_complete.md) method to end the deferral. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceStartingRequestDeferral +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingRequestDeferral + +## -description +Provides a way for the application to asynchronously report that it has completed processing the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. + +## -remarks +You can use a deferral when you want to make an asynchronous call in response to the [MediaStreamSource.Starting](mediastreamsource_starting.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. + +To create a deferral, call the [GetDeferral](mediastreamsourcestartingrequest_getdeferral.md) method on the [MediaStreamSourceStartingRequest](mediastreamsourcestartingrequest.md) object to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourcestartingrequestdeferral_complete.md) method to end the deferral. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourcestartingrequestdeferral_complete_1807836922.md b/windows.media.core/mediastreamsourcestartingrequestdeferral_complete_1807836922.md index 435ec5d35b..d5b696410f 100644 --- a/windows.media.core/mediastreamsourcestartingrequestdeferral_complete_1807836922.md +++ b/windows.media.core/mediastreamsourcestartingrequestdeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceStartingRequestDeferral.Complete --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceStartingRequestDeferral.Complete ## -description Reports that the application has completed processing the Starting event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceStartingRequestDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceStartingRequestDeferral.Complete + +## -description +Reports that the application has completed processing the Starting event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequest.md b/windows.media.core/mediastreamsourceswitchstreamsrequest.md index 8099b2ce6a..90d7c67eb3 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequest.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequest.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest ## -description Represents an object to be used by the [MediaStreamSource.SwitchStreamsRequest](mediastreamsource_switchstreamsrequested.md) event to provide information to the application. ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest + +## -description +Represents an object to be used by the [MediaStreamSource.SwitchStreamsRequest](mediastreamsource_switchstreamsrequested.md) event to provide information to the application. + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequest_getdeferral_254836512.md b/windows.media.core/mediastreamsourceswitchstreamsrequest_getdeferral_254836512.md index ce300851a9..9c1d72d601 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequest_getdeferral_254836512.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequest_getdeferral_254836512.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.GetDeferral --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.GetDeferral ## -description Defers completing the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. ## -returns The deferral. ## -remarks You can use a deferral when you want to make an asynchronous call in response to the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. To create a deferral, call the [GetDeferral](mediastreamsourceswitchstreamsrequest_getdeferral.md) method to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourceswitchstreamsrequestdeferral_complete.md) method to end the deferral. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.GetDeferral + +## -description +Defers completing the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. + +## -returns +The deferral. + +## -remarks +You can use a deferral when you want to make an asynchronous call in response to the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. + +To create a deferral, call the [GetDeferral](mediastreamsourceswitchstreamsrequest_getdeferral.md) method to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourceswitchstreamsrequestdeferral_complete.md) method to end the deferral. + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequest_newstreamdescriptor.md b/windows.media.core/mediastreamsourceswitchstreamsrequest_newstreamdescriptor.md index f4f4c50fe6..3a16323676 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequest_newstreamdescriptor.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequest_newstreamdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.NewStreamDescriptor --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.NewStreamDescriptor ## -description Gets the stream descriptor for the stream that is now selected by the [MediaStreamSource](mediastreamsource.md). ## -property-value The selected stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.NewStreamDescriptor +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.NewStreamDescriptor + +## -description +Gets the stream descriptor for the stream that is now selected by the [MediaStreamSource](mediastreamsource.md). + +## -property-value +The selected stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequest_oldstreamdescriptor.md b/windows.media.core/mediastreamsourceswitchstreamsrequest_oldstreamdescriptor.md index 799207f9b1..cd0d21a3a5 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequest_oldstreamdescriptor.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequest_oldstreamdescriptor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.OldStreamDescriptor --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.OldStreamDescriptor ## -description Gets the stream descriptor for the stream which is no longer selected by the [MediaStreamSource](mediastreamsource.md). ## -property-value The previously selected stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.OldStreamDescriptor +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequest.OldStreamDescriptor + +## -description +Gets the stream descriptor for the stream which is no longer selected by the [MediaStreamSource](mediastreamsource.md). + +## -property-value +The previously selected stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral.md b/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral.md index bde8325fc5..ddea29b0fe 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral ## -description Provides a way for the application to asynchronously report that it has completed the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. ## -remarks You can use a deferral when you want to make an asynchronous call in response to the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. To create a deferral, call the [GetDeferral](mediastreamsourceswitchstreamsrequest_getdeferral.md) method on the [MediaStreamSourceSwitchStreamsRequest](mediastreamsourceswitchstreamsrequestdeferral.md) object to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourceswitchstreamsrequestdeferral_complete.md) method to end the deferral. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral + +## -description +Provides a way for the application to asynchronously report that it has completed the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. + +## -remarks +You can use a deferral when you want to make an asynchronous call in response to the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. For example, if you need to establish a HTTP connection or open a file for reading. The [MediaStreamSource](mediastreamsource.md) will then wait for you to mark the deferral as complete before it begins raising the [SampleRequested](mediastreamsource_samplerequested.md) event. + +To create a deferral, call the [GetDeferral](mediastreamsourceswitchstreamsrequest_getdeferral.md) method on the [MediaStreamSourceSwitchStreamsRequest](mediastreamsourceswitchstreamsrequestdeferral.md) object to instruct the [MediaStreamSource](mediastreamsource.md) to wait for your asynchronous call to complete. When you are ready to start receiving [SampleRequested](mediastreamsource_samplerequested.md) events, call the [Complete](mediastreamsourceswitchstreamsrequestdeferral_complete.md) method to end the deferral. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral_complete_1807836922.md b/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral_complete_1807836922.md index a92d90d87a..cbcf85a8ce 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral_complete_1807836922.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequestdeferral_complete_1807836922.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral.Complete --api-type: winrt method ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral.Complete ## -description Reports that the application has completed processing the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestDeferral.Complete + +## -description +Reports that the application has completed processing the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs.md b/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs.md index 67e63e26ea..c6f3a833cd 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs --api-type: winrt class ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs ## -description Provides data for the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. ## -remarks This object is not instantiated directly, it is created by the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs + +## -description +Provides data for the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. + +## -remarks +This object is not instantiated directly, it is created by the [MediaStreamSource.SwitchStreamsRequested](mediastreamsource_switchstreamsrequested.md) event. + +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs_request.md b/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs_request.md index c2cfb44853..993cad9859 100644 --- a/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs_request.md +++ b/windows.media.core/mediastreamsourceswitchstreamsrequestedeventargs_request.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs.Request --api-type: winrt property ---- # Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs.Request ## -description Gets the object that represents the request to switch the streams. ## -property-value Provides information regrading the request to switch the streams. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSourceSwitchStreamsRequestedEventArgs.Request + +## -description +Gets the object that represents the request to switch the streams. + +## -property-value +Provides information regrading the request to switch the streams. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer.md b/windows.media.core/msesourcebuffer.md index 35ee84058d..32a97092e4 100644 --- a/windows.media.core/msesourcebuffer.md +++ b/windows.media.core/msesourcebuffer.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.MseSourceBuffer --api-type: winrt class ---- # Windows.Media.Core.MseSourceBuffer ## -description Represents a media source extensions (MSE) source buffer. ## -remarks Get an instance of this class by calling [AddSourceBuffer](msestreamsource_addsourcebuffer.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MseSourceBuffer +-api-type: winrt class +--- + + + +# Windows.Media.Core.MseSourceBuffer + +## -description +Represents a media source extensions (MSE) source buffer. + +## -remarks +Get an instance of this class by calling [AddSourceBuffer](msestreamsource_addsourcebuffer.md). + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_abort_1514193616.md b/windows.media.core/msesourcebuffer_abort_1514193616.md index 1ba62326a8..bd141394e2 100644 --- a/windows.media.core/msesourcebuffer_abort_1514193616.md +++ b/windows.media.core/msesourcebuffer_abort_1514193616.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MseSourceBuffer.Abort --api-type: winrt method ---- # Windows.Media.Core.MseSourceBuffer.Abort ## -description Aborts media source extensions (MSE) source buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseSourceBuffer.Abort +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseSourceBuffer.Abort + +## -description +Aborts media source extensions (MSE) source buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_aborted.md b/windows.media.core/msesourcebuffer_aborted.md index 24686ca801..69452b1c41 100644 --- a/windows.media.core/msesourcebuffer_aborted.md +++ b/windows.media.core/msesourcebuffer_aborted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBuffer.Aborted --api-type: winrt event ---- # Windows.Media.Core.MseSourceBuffer.Aborted ## -description Occurs when the [MseSourceBuffer](msesourcebuffer.md) is aborted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBuffer.Aborted +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBuffer.Aborted + +## -description +Occurs when the [MseSourceBuffer](msesourcebuffer.md) is aborted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_appendbuffer_1376449415.md b/windows.media.core/msesourcebuffer_appendbuffer_1376449415.md index 5e803930f3..6b4d1c81ea 100644 --- a/windows.media.core/msesourcebuffer_appendbuffer_1376449415.md +++ b/windows.media.core/msesourcebuffer_appendbuffer_1376449415.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MseSourceBuffer.AppendBuffer(Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- # Windows.Media.Core.MseSourceBuffer.AppendBuffer ## -description Appends a buffer to the [MseSourceBuffer](msesourcebuffer.md) object. ## -parameters ### -param buffer The buffer to append. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseSourceBuffer.AppendBuffer(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseSourceBuffer.AppendBuffer + +## -description +Appends a buffer to the [MseSourceBuffer](msesourcebuffer.md) object. + +## -parameters +### -param buffer +The buffer to append. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_appendstream_1212292824.md b/windows.media.core/msesourcebuffer_appendstream_1212292824.md index 19697a2ff3..46c663cf0f 100644 --- a/windows.media.core/msesourcebuffer_appendstream_1212292824.md +++ b/windows.media.core/msesourcebuffer_appendstream_1212292824.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Core.MseSourceBuffer.AppendStream(Windows.Storage.Streams.IInputStream,System.UInt64) --api-type: winrt method ---- # Windows.Media.Core.MseSourceBuffer.AppendStream ## -description Appends a stream to the [MseSourceBuffer](msesourcebuffer.md) object. ## -parameters ### -param stream The stream to append. ### -param maxSize The maximum size of the stream. ## -remarks ## -examples ## -see-also [AppendStream(IInputStream)](msesourcebuffer_appendstream_1948581086.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseSourceBuffer.AppendStream(Windows.Storage.Streams.IInputStream,System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseSourceBuffer.AppendStream + +## -description +Appends a stream to the [MseSourceBuffer](msesourcebuffer.md) object. + +## -parameters +### -param stream +The stream to append. + +### -param maxSize +The maximum size of the stream. + +## -remarks + +## -examples + +## -see-also +[AppendStream(IInputStream)](msesourcebuffer_appendstream_1948581086.md) \ No newline at end of file diff --git a/windows.media.core/msesourcebuffer_appendstream_1948581086.md b/windows.media.core/msesourcebuffer_appendstream_1948581086.md index 2c35d52de3..ecf591ca59 100644 --- a/windows.media.core/msesourcebuffer_appendstream_1948581086.md +++ b/windows.media.core/msesourcebuffer_appendstream_1948581086.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.MseSourceBuffer.AppendStream(Windows.Storage.Streams.IInputStream) --api-type: winrt method ---- # Windows.Media.Core.MseSourceBuffer.AppendStream ## -description Appends a stream to the [MseSourceBuffer](msesourcebuffer.md) object. ## -parameters ### -param stream The stream to append. ## -remarks ## -examples ## -see-also [AppendStream(IInputStream, UInt64)](msesourcebuffer_appendstream_1212292824.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseSourceBuffer.AppendStream(Windows.Storage.Streams.IInputStream) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseSourceBuffer.AppendStream + +## -description +Appends a stream to the [MseSourceBuffer](msesourcebuffer.md) object. + +## -parameters +### -param stream +The stream to append. + +## -remarks + +## -examples + +## -see-also +[AppendStream(IInputStream, UInt64)](msesourcebuffer_appendstream_1212292824.md) \ No newline at end of file diff --git a/windows.media.core/msesourcebuffer_appendwindowend.md b/windows.media.core/msesourcebuffer_appendwindowend.md index b24beec3fd..8878304215 100644 --- a/windows.media.core/msesourcebuffer_appendwindowend.md +++ b/windows.media.core/msesourcebuffer_appendwindowend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBuffer.AppendWindowEnd --api-type: winrt property ---- # Windows.Media.Core.MseSourceBuffer.AppendWindowEnd ## -description Gets and sets the append-window-end interval. ## -property-value The interval value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBuffer.AppendWindowEnd +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBuffer.AppendWindowEnd + +## -description +Gets and sets the append-window-end interval. + +## -property-value +The interval value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_appendwindowstart.md b/windows.media.core/msesourcebuffer_appendwindowstart.md index 1458134532..d0069bc748 100644 --- a/windows.media.core/msesourcebuffer_appendwindowstart.md +++ b/windows.media.core/msesourcebuffer_appendwindowstart.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBuffer.AppendWindowStart --api-type: winrt property ---- # Windows.Media.Core.MseSourceBuffer.AppendWindowStart ## -description Gets and sets the append-window-start interval. ## -property-value The interval value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBuffer.AppendWindowStart +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBuffer.AppendWindowStart + +## -description +Gets and sets the append-window-start interval. + +## -property-value +The interval value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_buffered.md b/windows.media.core/msesourcebuffer_buffered.md index f73307b4d2..fbd5130d18 100644 --- a/windows.media.core/msesourcebuffer_buffered.md +++ b/windows.media.core/msesourcebuffer_buffered.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBuffer.Buffered --api-type: winrt property ---- # Windows.Media.Core.MseSourceBuffer.Buffered ## -description Gets how the [MseSourceBuffer](msesourcebuffer.md) object is buffered. ## -property-value The buffered value in terms of a [MseTimeRange](msetimerange.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBuffer.Buffered +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBuffer.Buffered + +## -description +Gets how the [MseSourceBuffer](msesourcebuffer.md) object is buffered. + +## -property-value +The buffered value in terms of a [MseTimeRange](msetimerange.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_erroroccurred.md b/windows.media.core/msesourcebuffer_erroroccurred.md index 0de7ecb083..d81d5da204 100644 --- a/windows.media.core/msesourcebuffer_erroroccurred.md +++ b/windows.media.core/msesourcebuffer_erroroccurred.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBuffer.ErrorOccurred --api-type: winrt event ---- # Windows.Media.Core.MseSourceBuffer.ErrorOccurred ## -description Occurs when the [MseSourceBuffer](msesourcebuffer.md) has an error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBuffer.ErrorOccurred +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBuffer.ErrorOccurred + +## -description +Occurs when the [MseSourceBuffer](msesourcebuffer.md) has an error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_isupdating.md b/windows.media.core/msesourcebuffer_isupdating.md index ab1f497ec6..aaa7d0ab54 100644 --- a/windows.media.core/msesourcebuffer_isupdating.md +++ b/windows.media.core/msesourcebuffer_isupdating.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBuffer.IsUpdating --api-type: winrt property ---- # Windows.Media.Core.MseSourceBuffer.IsUpdating ## -description Gets a value indicating whether the buffer is updating. ## -property-value True if the buffer is updating; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBuffer.IsUpdating +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBuffer.IsUpdating + +## -description +Gets a value indicating whether the buffer is updating. + +## -property-value +True if the buffer is updating; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_mode.md b/windows.media.core/msesourcebuffer_mode.md index cfbb1566f6..182370e87c 100644 --- a/windows.media.core/msesourcebuffer_mode.md +++ b/windows.media.core/msesourcebuffer_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBuffer.Mode --api-type: winrt property ---- # Windows.Media.Core.MseSourceBuffer.Mode ## -description Gets and sets how the [MseSourceBuffer](msesourcebuffer.md) object appends a buffer. ## -property-value A [MseAppendMode](mseappendmode.md)-typed value that specifies how [MseSourceBuffer](msesourcebuffer.md) appends a buffer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBuffer.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBuffer.Mode + +## -description +Gets and sets how the [MseSourceBuffer](msesourcebuffer.md) object appends a buffer. + +## -property-value +A [MseAppendMode](mseappendmode.md)-typed value that specifies how [MseSourceBuffer](msesourcebuffer.md) appends a buffer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_remove_793520635.md b/windows.media.core/msesourcebuffer_remove_793520635.md index abbf55a6cb..2113883237 100644 --- a/windows.media.core/msesourcebuffer_remove_793520635.md +++ b/windows.media.core/msesourcebuffer_remove_793520635.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MseSourceBuffer.Remove(Windows.Foundation.TimeSpan,Windows.Foundation.IReference{Windows.Foundation.TimeSpan}) --api-type: winrt method ---- # Windows.Media.Core.MseSourceBuffer.Remove ## -description Removes media for the specified time range. ## -parameters ### -param start The start of the time range to remove. ### -param end The end of the time range to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseSourceBuffer.Remove(Windows.Foundation.TimeSpan,Windows.Foundation.IReference{Windows.Foundation.TimeSpan}) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseSourceBuffer.Remove + +## -description +Removes media for the specified time range. + +## -parameters +### -param start +The start of the time range to remove. + +### -param end +The end of the time range to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_timestampoffset.md b/windows.media.core/msesourcebuffer_timestampoffset.md index ed3a449707..6652b725a6 100644 --- a/windows.media.core/msesourcebuffer_timestampoffset.md +++ b/windows.media.core/msesourcebuffer_timestampoffset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBuffer.TimestampOffset --api-type: winrt property ---- # Windows.Media.Core.MseSourceBuffer.TimestampOffset ## -description Gets and sets the timestamp offset into the [MseSourceBuffer](msesourcebuffer.md) object. ## -property-value The timestamp offset value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBuffer.TimestampOffset +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBuffer.TimestampOffset + +## -description +Gets and sets the timestamp offset into the [MseSourceBuffer](msesourcebuffer.md) object. + +## -property-value +The timestamp offset value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_updated.md b/windows.media.core/msesourcebuffer_updated.md index 4e5f7ea3d0..384f0e3843 100644 --- a/windows.media.core/msesourcebuffer_updated.md +++ b/windows.media.core/msesourcebuffer_updated.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBuffer.Updated --api-type: winrt event ---- # Windows.Media.Core.MseSourceBuffer.Updated ## -description Occurs when the [MseSourceBuffer](msesourcebuffer.md) is updated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBuffer.Updated +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBuffer.Updated + +## -description +Occurs when the [MseSourceBuffer](msesourcebuffer.md) is updated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_updateended.md b/windows.media.core/msesourcebuffer_updateended.md index cd24fe3817..4026c7d64c 100644 --- a/windows.media.core/msesourcebuffer_updateended.md +++ b/windows.media.core/msesourcebuffer_updateended.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBuffer.UpdateEnded --api-type: winrt event ---- # Windows.Media.Core.MseSourceBuffer.UpdateEnded ## -description Occurs when the [MseSourceBuffer](msesourcebuffer.md) update has ended. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBuffer.UpdateEnded +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBuffer.UpdateEnded + +## -description +Occurs when the [MseSourceBuffer](msesourcebuffer.md) update has ended. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebuffer_updatestarting.md b/windows.media.core/msesourcebuffer_updatestarting.md index b67cd67e7e..8e60e66921 100644 --- a/windows.media.core/msesourcebuffer_updatestarting.md +++ b/windows.media.core/msesourcebuffer_updatestarting.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBuffer.UpdateStarting --api-type: winrt event ---- # Windows.Media.Core.MseSourceBuffer.UpdateStarting ## -description Occurs when the [MseSourceBuffer](msesourcebuffer.md) update is starting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBuffer.UpdateStarting +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBuffer.UpdateStarting + +## -description +Occurs when the [MseSourceBuffer](msesourcebuffer.md) update is starting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebufferlist.md b/windows.media.core/msesourcebufferlist.md index e5deb30fa0..38d9d312a1 100644 --- a/windows.media.core/msesourcebufferlist.md +++ b/windows.media.core/msesourcebufferlist.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.MseSourceBufferList --api-type: winrt class ---- # Windows.Media.Core.MseSourceBufferList ## -description Represents a list of media source extensions (MSE) source buffers. ## -remarks Get an instance of this class by accessing the [ActiveSourceBuffers](msestreamsource_activesourcebuffers.md) or [SourceBuffers](msestreamsource_sourcebuffers.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MseSourceBufferList +-api-type: winrt class +--- + + + +# Windows.Media.Core.MseSourceBufferList + +## -description +Represents a list of media source extensions (MSE) source buffers. + +## -remarks +Get an instance of this class by accessing the [ActiveSourceBuffers](msestreamsource_activesourcebuffers.md) or [SourceBuffers](msestreamsource_sourcebuffers.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebufferlist_buffers.md b/windows.media.core/msesourcebufferlist_buffers.md index 08011b676f..bfb7fe0f72 100644 --- a/windows.media.core/msesourcebufferlist_buffers.md +++ b/windows.media.core/msesourcebufferlist_buffers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseSourceBufferList.Buffers --api-type: winrt property ---- # Windows.Media.Core.MseSourceBufferList.Buffers ## -description Gets the list of [MseSourceBuffer](msesourcebuffer.md) objects. ## -property-value The list of [MseSourceBuffer](msesourcebuffer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseSourceBufferList.Buffers +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseSourceBufferList.Buffers + +## -description +Gets the list of [MseSourceBuffer](msesourcebuffer.md) objects. + +## -property-value +The list of [MseSourceBuffer](msesourcebuffer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebufferlist_sourcebufferadded.md b/windows.media.core/msesourcebufferlist_sourcebufferadded.md index df9db86ad1..17a2432629 100644 --- a/windows.media.core/msesourcebufferlist_sourcebufferadded.md +++ b/windows.media.core/msesourcebufferlist_sourcebufferadded.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBufferList.SourceBufferAdded --api-type: winrt event ---- # Windows.Media.Core.MseSourceBufferList.SourceBufferAdded ## -description Occurs when a [MseSourceBuffer](msesourcebuffer.md) object is added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBufferList.SourceBufferAdded +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBufferList.SourceBufferAdded + +## -description +Occurs when a [MseSourceBuffer](msesourcebuffer.md) object is added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msesourcebufferlist_sourcebufferremoved.md b/windows.media.core/msesourcebufferlist_sourcebufferremoved.md index a4843c822c..a383f276d6 100644 --- a/windows.media.core/msesourcebufferlist_sourcebufferremoved.md +++ b/windows.media.core/msesourcebufferlist_sourcebufferremoved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseSourceBufferList.SourceBufferRemoved --api-type: winrt event ---- # Windows.Media.Core.MseSourceBufferList.SourceBufferRemoved ## -description Occurs when a [MseSourceBuffer](msesourcebuffer.md) object is removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseSourceBufferList.SourceBufferRemoved +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseSourceBufferList.SourceBufferRemoved + +## -description +Occurs when a [MseSourceBuffer](msesourcebuffer.md) object is removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource.md b/windows.media.core/msestreamsource.md index 69050cd13d..b1ba8e46d7 100644 --- a/windows.media.core/msestreamsource.md +++ b/windows.media.core/msestreamsource.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.MseStreamSource --api-type: winrt class ---- # Windows.Media.Core.MseStreamSource ## -description Represents a media source extensions (MSE) stream source. ## -remarks ## -examples ## -see-also [IMediaSource](imediasource.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.MseStreamSource +-api-type: winrt class +--- + + + +# Windows.Media.Core.MseStreamSource + +## -description +Represents a media source extensions (MSE) stream source. + +## -remarks + + +## -examples + +## -see-also +[IMediaSource](imediasource.md) \ No newline at end of file diff --git a/windows.media.core/msestreamsource_activesourcebuffers.md b/windows.media.core/msestreamsource_activesourcebuffers.md index c5ac678302..07c083b3d9 100644 --- a/windows.media.core/msestreamsource_activesourcebuffers.md +++ b/windows.media.core/msestreamsource_activesourcebuffers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseStreamSource.ActiveSourceBuffers --api-type: winrt property ---- # Windows.Media.Core.MseStreamSource.ActiveSourceBuffers ## -description Gets the list of media source extensions (MSE) source buffers that are active on the stream source. ## -property-value The list of MSE source buffers that are active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseStreamSource.ActiveSourceBuffers +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseStreamSource.ActiveSourceBuffers + +## -description +Gets the list of media source extensions (MSE) source buffers that are active on the stream source. + +## -property-value +The list of MSE source buffers that are active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_addsourcebuffer_362600906.md b/windows.media.core/msestreamsource_addsourcebuffer_362600906.md index acac030e4d..5891961b9f 100644 --- a/windows.media.core/msestreamsource_addsourcebuffer_362600906.md +++ b/windows.media.core/msestreamsource_addsourcebuffer_362600906.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MseStreamSource.AddSourceBuffer(System.String) --api-type: winrt method ---- # Windows.Media.Core.MseStreamSource.AddSourceBuffer ## -description Adds a source buffer to the stream source. ## -parameters ### -param mimeType A string that describes the source buffer's MIME type. ## -returns The [MseSourceBuffer](msesourcebuffer.md) object for the source buffer added. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseStreamSource.AddSourceBuffer(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseStreamSource.AddSourceBuffer + +## -description +Adds a source buffer to the stream source. + +## -parameters +### -param mimeType +A string that describes the source buffer's MIME type. + +## -returns +The [MseSourceBuffer](msesourcebuffer.md) object for the source buffer added. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_closed.md b/windows.media.core/msestreamsource_closed.md index 4aabdec369..1292c04589 100644 --- a/windows.media.core/msestreamsource_closed.md +++ b/windows.media.core/msestreamsource_closed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseStreamSource.Closed --api-type: winrt event ---- # Windows.Media.Core.MseStreamSource.Closed ## -description Occurs when the [MseStreamSource](msestreamsource.md) is closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseStreamSource.Closed +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseStreamSource.Closed + +## -description +Occurs when the [MseStreamSource](msestreamsource.md) is closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_duration.md b/windows.media.core/msestreamsource_duration.md index ff1aa92dc1..3ee9e2241a 100644 --- a/windows.media.core/msestreamsource_duration.md +++ b/windows.media.core/msestreamsource_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseStreamSource.Duration --api-type: winrt property ---- # Windows.Media.Core.MseStreamSource.Duration ## -description Gets and sets the duration of the stream source. ## -property-value The duration of the stream source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseStreamSource.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseStreamSource.Duration + +## -description +Gets and sets the duration of the stream source. + +## -property-value +The duration of the stream source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_ended.md b/windows.media.core/msestreamsource_ended.md index 5ce69f26fb..361eee4afa 100644 --- a/windows.media.core/msestreamsource_ended.md +++ b/windows.media.core/msestreamsource_ended.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseStreamSource.Ended --api-type: winrt event ---- # Windows.Media.Core.MseStreamSource.Ended ## -description Occurs when the [MseStreamSource](msestreamsource.md) is ended. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseStreamSource.Ended +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseStreamSource.Ended + +## -description +Occurs when the [MseStreamSource](msestreamsource.md) is ended. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_endofstream_1698240389.md b/windows.media.core/msestreamsource_endofstream_1698240389.md index 56dfe5dd5f..e2ac1dac59 100644 --- a/windows.media.core/msestreamsource_endofstream_1698240389.md +++ b/windows.media.core/msestreamsource_endofstream_1698240389.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MseStreamSource.EndOfStream(Windows.Media.Core.MseEndOfStreamStatus) --api-type: winrt method ---- # Windows.Media.Core.MseStreamSource.EndOfStream ## -description Specifies the status at the end of stream. ## -parameters ### -param status A [MseEndOfStreamStatus](mseendofstreamstatus.md)-typed value that specifies the status at the end of stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseStreamSource.EndOfStream(Windows.Media.Core.MseEndOfStreamStatus) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseStreamSource.EndOfStream + +## -description +Specifies the status at the end of stream. + +## -parameters +### -param status +A [MseEndOfStreamStatus](mseendofstreamstatus.md)-typed value that specifies the status at the end of stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_iscontenttypesupported_639585181.md b/windows.media.core/msestreamsource_iscontenttypesupported_639585181.md index 2182e8d3ad..9e99506570 100644 --- a/windows.media.core/msestreamsource_iscontenttypesupported_639585181.md +++ b/windows.media.core/msestreamsource_iscontenttypesupported_639585181.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Core.MseStreamSource.IsContentTypeSupported(System.String) --api-type: winrt method ---- # Windows.Media.Core.MseStreamSource.IsContentTypeSupported ## -description Specifies whether a content type is supported. ## -parameters ### -param contentType A string that describes the content type. ## -returns **true** if the content type specified by *contentType* is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseStreamSource.IsContentTypeSupported(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseStreamSource.IsContentTypeSupported + +## -description +Specifies whether a content type is supported. + +## -parameters +### -param contentType +A string that describes the content type. + +## -returns +**true** if the content type specified by *contentType* is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_msestreamsource_1221375020.md b/windows.media.core/msestreamsource_msestreamsource_1221375020.md index ed043326c0..63458f0863 100644 --- a/windows.media.core/msestreamsource_msestreamsource_1221375020.md +++ b/windows.media.core/msestreamsource_msestreamsource_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.MseStreamSource.#ctor --api-type: winrt method ---- # Windows.Media.Core.MseStreamSource.MseStreamSource ## -description Instantiates a new instance of an uninitialized [MseStreamSource](msestreamsource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseStreamSource.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseStreamSource.MseStreamSource + +## -description +Instantiates a new instance of an uninitialized [MseStreamSource](msestreamsource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_opened.md b/windows.media.core/msestreamsource_opened.md index 1c4fdafacf..999eee35d4 100644 --- a/windows.media.core/msestreamsource_opened.md +++ b/windows.media.core/msestreamsource_opened.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.MseStreamSource.Opened --api-type: winrt event ---- # Windows.Media.Core.MseStreamSource.Opened ## -description Occurs when the [MseStreamSource](msestreamsource.md) is opened. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.MseStreamSource.Opened +-api-type: winrt event +--- + + + +# Windows.Media.Core.MseStreamSource.Opened + +## -description +Occurs when the [MseStreamSource](msestreamsource.md) is opened. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_readystate.md b/windows.media.core/msestreamsource_readystate.md index 9a80c34c84..72544d312e 100644 --- a/windows.media.core/msestreamsource_readystate.md +++ b/windows.media.core/msestreamsource_readystate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseStreamSource.ReadyState --api-type: winrt property ---- # Windows.Media.Core.MseStreamSource.ReadyState ## -description Gets a value that specifies the ready state of the [MseStreamSource](msestreamsource.md). ## -property-value A [MseReadyState](msereadystate.md)-typed value that specifies the ready state of the [MseStreamSource](msestreamsource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseStreamSource.ReadyState +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseStreamSource.ReadyState + +## -description +Gets a value that specifies the ready state of the [MseStreamSource](msestreamsource.md). + +## -property-value +A [MseReadyState](msereadystate.md)-typed value that specifies the ready state of the [MseStreamSource](msestreamsource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_removesourcebuffer_212338239.md b/windows.media.core/msestreamsource_removesourcebuffer_212338239.md index 819a978cd8..109368a39a 100644 --- a/windows.media.core/msestreamsource_removesourcebuffer_212338239.md +++ b/windows.media.core/msestreamsource_removesourcebuffer_212338239.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.MseStreamSource.RemoveSourceBuffer(Windows.Media.Core.MseSourceBuffer) --api-type: winrt method ---- # Windows.Media.Core.MseStreamSource.RemoveSourceBuffer ## -description Removes a source buffer from the stream source. ## -parameters ### -param buffer The [MseSourceBuffer](msesourcebuffer.md) object for the source buffer removed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.MseStreamSource.RemoveSourceBuffer(Windows.Media.Core.MseSourceBuffer) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MseStreamSource.RemoveSourceBuffer + +## -description +Removes a source buffer from the stream source. + +## -parameters +### -param buffer +The [MseSourceBuffer](msesourcebuffer.md) object for the source buffer removed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/msestreamsource_sourcebuffers.md b/windows.media.core/msestreamsource_sourcebuffers.md index c08f119c2e..8ba92c16f4 100644 --- a/windows.media.core/msestreamsource_sourcebuffers.md +++ b/windows.media.core/msestreamsource_sourcebuffers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.MseStreamSource.SourceBuffers --api-type: winrt property ---- # Windows.Media.Core.MseStreamSource.SourceBuffers ## -description Gets the list of media source extensions (MSE) source buffers on the stream source. ## -property-value The list of MSE source buffers. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.MseStreamSource.SourceBuffers +-api-type: winrt property +--- + + + +# Windows.Media.Core.MseStreamSource.SourceBuffers + +## -description +Gets the list of media source extensions (MSE) source buffers on the stream source. + +## -property-value +The list of MSE source buffers. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffect.md b/windows.media.core/sceneanalysiseffect.md index 5a4fcffc23..7df1e86c31 100644 --- a/windows.media.core/sceneanalysiseffect.md +++ b/windows.media.core/sceneanalysiseffect.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Media.Core.SceneAnalysisEffect --api-type: winrt class ---- # Windows.Media.Core.SceneAnalysisEffect ## -description Represents an effect that analyzes video frames to determine if any of the supported variable photo sequence capture techniques may produce a higher-quality captured image. ## -remarks Get an instance of this class by passing a [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) object into [MediaCapture.AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). Just like other effects, the scene analyzer effect is added to the capture pipeline by calling [AddEffectAsync](../windows.media.capture/mediacapture_addeffectasync.md). After capture is started, the [SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event is raised. In the handler for this event, you can get access to the output object that indicates the likelihood that a particular technique will improve the captured image. The output object also provides a set of [FrameController](highdynamicrangeoutput_framecontrollers.md) objects with recommended settings that can be assigned directly to the [VariablePhotoSequenceController.DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection to enable the capture technique. In the current release, the only analyzer supported is the High Dynamic Range (HDR) analyzer. For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). ## -examples ## -see-also [IMediaExtension](../windows.media/imediaextension.md), [VariablePhotoSequenceController](../windows.media.devices.core/variablephotosequencecontroller.md), [MediaCapture.AddEffectAsync](../windows.media.capture/mediacapture_addeffectasync.md), [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.SceneAnalysisEffect +-api-type: winrt class +--- + + + +# Windows.Media.Core.SceneAnalysisEffect + +## -description +Represents an effect that analyzes video frames to determine if any of the supported variable photo sequence capture techniques may produce a higher-quality captured image. + +## -remarks +Get an instance of this class by passing a [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) object into [MediaCapture.AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). + +Just like other effects, the scene analyzer effect is added to the capture pipeline by calling [AddEffectAsync](../windows.media.capture/mediacapture_addeffectasync.md). After capture is started, the [SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event is raised. In the handler for this event, you can get access to the output object that indicates the likelihood that a particular technique will improve the captured image. The output object also provides a set of [FrameController](highdynamicrangeoutput_framecontrollers.md) objects with recommended settings that can be assigned directly to the [VariablePhotoSequenceController.DesiredFrameControllers](../windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md) collection to enable the capture technique. + +In the current release, the only analyzer supported is the High Dynamic Range (HDR) analyzer. + +For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). + +## -examples + +## -see-also +[IMediaExtension](../windows.media/imediaextension.md), [VariablePhotoSequenceController](../windows.media.devices.core/variablephotosequencecontroller.md), [MediaCapture.AddEffectAsync](../windows.media.capture/mediacapture_addeffectasync.md), [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file diff --git a/windows.media.core/sceneanalysiseffect_desiredanalysisinterval.md b/windows.media.core/sceneanalysiseffect_desiredanalysisinterval.md index da93204fea..d20d3a2a1e 100644 --- a/windows.media.core/sceneanalysiseffect_desiredanalysisinterval.md +++ b/windows.media.core/sceneanalysiseffect_desiredanalysisinterval.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffect.DesiredAnalysisInterval --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffect.DesiredAnalysisInterval ## -description Gets or sets the duration of the time window during which video frames are analyzed. ## -property-value The duration of the time window during which video frames are analyzed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffect.DesiredAnalysisInterval +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffect.DesiredAnalysisInterval + +## -description +Gets or sets the duration of the time window during which video frames are analyzed. + +## -property-value +The duration of the time window during which video frames are analyzed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffect_highdynamicrangeanalyzer.md b/windows.media.core/sceneanalysiseffect_highdynamicrangeanalyzer.md index f51771e6f5..d14ee05cce 100644 --- a/windows.media.core/sceneanalysiseffect_highdynamicrangeanalyzer.md +++ b/windows.media.core/sceneanalysiseffect_highdynamicrangeanalyzer.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffect.HighDynamicRangeAnalyzer --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffect.HighDynamicRangeAnalyzer ## -description Gets or sets a [HighDynamicRangeControl](highdynamicrangecontrol.md) object that is used to enable or disable High Dynamic Range (HDR) analysis. ## -property-value A [HighDynamicRangeControl](highdynamicrangecontrol.md) object that is used to enable or disable High Dynamic Range (HDR) analysis. ## -remarks ## -examples ## -see-also [HighDynamicRangeControl](highdynamicrangecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffect.HighDynamicRangeAnalyzer +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffect.HighDynamicRangeAnalyzer + +## -description +Gets or sets a [HighDynamicRangeControl](highdynamicrangecontrol.md) object that is used to enable or disable High Dynamic Range (HDR) analysis. + +## -property-value +A [HighDynamicRangeControl](highdynamicrangecontrol.md) object that is used to enable or disable High Dynamic Range (HDR) analysis. + +## -remarks + +## -examples + +## -see-also +[HighDynamicRangeControl](highdynamicrangecontrol.md) \ No newline at end of file diff --git a/windows.media.core/sceneanalysiseffect_sceneanalyzed.md b/windows.media.core/sceneanalysiseffect_sceneanalyzed.md index a237e3bdab..a23b95c0e3 100644 --- a/windows.media.core/sceneanalysiseffect_sceneanalyzed.md +++ b/windows.media.core/sceneanalysiseffect_sceneanalyzed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.SceneAnalysisEffect.SceneAnalyzed --api-type: winrt event ---- # Windows.Media.Core.SceneAnalysisEffect.SceneAnalyzed ## -description Raised when the scene analysis is complete. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.SceneAnalysisEffect.SceneAnalyzed +-api-type: winrt event +--- + + + +# Windows.Media.Core.SceneAnalysisEffect.SceneAnalyzed + +## -description +Raised when the scene analysis is complete. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffect_setproperties_518979560.md b/windows.media.core/sceneanalysiseffect_setproperties_518979560.md index 4ba1e32682..7ec7ec3e96 100644 --- a/windows.media.core/sceneanalysiseffect_setproperties_518979560.md +++ b/windows.media.core/sceneanalysiseffect_setproperties_518979560.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.SceneAnalysisEffect.SetProperties(Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Core.SceneAnalysisEffect.SetProperties ## -description Sets properties on the [IMediaExtension](../windows.media/imediaextension.md). ## -parameters ### -param configuration The property set. ## -remarks This method is inherited from the [IMediaExtension](../windows.media/imediaextension.md) interface and is not intended to be used from your code. Instead, set the properties of the [SceneAnalysisEffect](sceneanalysiseffect.md) directly. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.SceneAnalysisEffect.SetProperties(Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Core.SceneAnalysisEffect.SetProperties + +## -description +Sets properties on the [IMediaExtension](../windows.media/imediaextension.md). + +## -parameters +### -param configuration +The property set. + +## -remarks +This method is inherited from the [IMediaExtension](../windows.media/imediaextension.md) interface and is not intended to be used from your code. Instead, set the properties of the [SceneAnalysisEffect](sceneanalysiseffect.md) directly. + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectdefinition.md b/windows.media.core/sceneanalysiseffectdefinition.md index 7b0ee0afe9..64a7d20182 100644 --- a/windows.media.core/sceneanalysiseffectdefinition.md +++ b/windows.media.core/sceneanalysiseffectdefinition.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.SceneAnalysisEffectDefinition --api-type: winrt class ---- # Windows.Media.Core.SceneAnalysisEffectDefinition ## -description Represents the definition of a scene analysis video effect. ## -remarks Get an instance of the [SceneAnalysisEffect](sceneanalysiseffect.md) class by passing a **SceneAnalysisEffectDefinition** object into [MediaCapture.AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). ## -examples ## -see-also [IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md), [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.SceneAnalysisEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Core.SceneAnalysisEffectDefinition + +## -description +Represents the definition of a scene analysis video effect. + +## -remarks +Get an instance of the [SceneAnalysisEffect](sceneanalysiseffect.md) class by passing a **SceneAnalysisEffectDefinition** object into [MediaCapture.AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md). + +For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). + +## -examples + +## -see-also +[IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md), [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file diff --git a/windows.media.core/sceneanalysiseffectdefinition_activatableclassid.md b/windows.media.core/sceneanalysiseffectdefinition_activatableclassid.md index 7a2ab7589d..d4f24549b0 100644 --- a/windows.media.core/sceneanalysiseffectdefinition_activatableclassid.md +++ b/windows.media.core/sceneanalysiseffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectDefinition.ActivatableClassId ## -description Gets a string containing the activatable class ID of the scene analysis effect definition. ## -property-value The activatable class ID of the scene analysis effect definition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectDefinition.ActivatableClassId + +## -description +Gets a string containing the activatable class ID of the scene analysis effect definition. + +## -property-value +The activatable class ID of the scene analysis effect definition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectdefinition_properties.md b/windows.media.core/sceneanalysiseffectdefinition_properties.md index 833fbf9993..a5d33d30d1 100644 --- a/windows.media.core/sceneanalysiseffectdefinition_properties.md +++ b/windows.media.core/sceneanalysiseffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectDefinition.Properties ## -description Gets the set of properties for configuring the [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) object. ## -property-value The set of properties for configuring the [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectDefinition.Properties + +## -description +Gets the set of properties for configuring the [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) object. + +## -property-value +The set of properties for configuring the [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectdefinition_sceneanalysiseffectdefinition_1221375020.md b/windows.media.core/sceneanalysiseffectdefinition_sceneanalysiseffectdefinition_1221375020.md index 1b6492ca67..d1d7aac3f6 100644 --- a/windows.media.core/sceneanalysiseffectdefinition_sceneanalysiseffectdefinition_1221375020.md +++ b/windows.media.core/sceneanalysiseffectdefinition_sceneanalysiseffectdefinition_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.SceneAnalysisEffectDefinition.#ctor --api-type: winrt method ---- # Windows.Media.Core.SceneAnalysisEffectDefinition.SceneAnalysisEffectDefinition ## -description Initializes a new instance of the [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.SceneAnalysisEffectDefinition.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.SceneAnalysisEffectDefinition.SceneAnalysisEffectDefinition + +## -description +Initializes a new instance of the [SceneAnalysisEffectDefinition](sceneanalysiseffectdefinition.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe.md b/windows.media.core/sceneanalysiseffectframe.md index 591867c6ef..8ca10fdbcd 100644 --- a/windows.media.core/sceneanalysiseffectframe.md +++ b/windows.media.core/sceneanalysiseffectframe.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.SceneAnalysisEffectFrame --api-type: winrt class ---- # Windows.Media.Core.SceneAnalysisEffectFrame ## -description Represents a video frame that includes the results of the scene analysis operation. ## -remarks Get an instance of this class by handling the [SceneAnalysisEffect.SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event. For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). ## -examples ## -see-also [IMediaFrame](../windows.media/imediaframe.md), [IClosable](../windows.foundation/iclosable.md), [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.SceneAnalysisEffectFrame +-api-type: winrt class +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame + +## -description +Represents a video frame that includes the results of the scene analysis operation. + +## -remarks +Get an instance of this class by handling the [SceneAnalysisEffect.SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event. + +For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). + +## -examples + +## -see-also +[IMediaFrame](../windows.media/imediaframe.md), [IClosable](../windows.foundation/iclosable.md), [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file diff --git a/windows.media.core/sceneanalysiseffectframe_close_811482585.md b/windows.media.core/sceneanalysiseffectframe_close_811482585.md index 80eab28e3b..1abbfdf4af 100644 --- a/windows.media.core/sceneanalysiseffectframe_close_811482585.md +++ b/windows.media.core/sceneanalysiseffectframe_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.SceneAnalysisEffectFrame.Close --api-type: winrt method ---- # Windows.Media.Core.SceneAnalysisEffectFrame.Close ## -description Disposes of the object and associated resources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.SceneAnalysisEffectFrame.Close +-api-type: winrt method +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.Close + +## -description +Disposes of the object and associated resources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_duration.md b/windows.media.core/sceneanalysiseffectframe_duration.md index 172d7b23e7..8bfb04a25b 100644 --- a/windows.media.core/sceneanalysiseffectframe_duration.md +++ b/windows.media.core/sceneanalysiseffectframe_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.Duration --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.Duration ## -description Gets or sets the duration of the scene analysis effect frame. ## -property-value The duration of the scene analysis effect frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.Duration + +## -description +Gets or sets the duration of the scene analysis effect frame. + +## -property-value +The duration of the scene analysis effect frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_extendedproperties.md b/windows.media.core/sceneanalysiseffectframe_extendedproperties.md index 4414ed721c..3616c338b5 100644 --- a/windows.media.core/sceneanalysiseffectframe_extendedproperties.md +++ b/windows.media.core/sceneanalysiseffectframe_extendedproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.ExtendedProperties --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.ExtendedProperties ## -description Gets the extended property set which enables getting and setting properties on the media frame. ## -property-value The extended properties map. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.ExtendedProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.ExtendedProperties + +## -description +Gets the extended property set which enables getting and setting properties on the media frame. + +## -property-value +The extended properties map. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_framecontrolvalues.md b/windows.media.core/sceneanalysiseffectframe_framecontrolvalues.md index 671e2950dc..dc80a24d5c 100644 --- a/windows.media.core/sceneanalysiseffectframe_framecontrolvalues.md +++ b/windows.media.core/sceneanalysiseffectframe_framecontrolvalues.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.FrameControlValues --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.FrameControlValues ## -description Gets a [CapturedFrameControlValues](../windows.media.capture/capturedframecontrolvalues.md) object that indicates the capture settings used for the frame. ## -property-value A [CapturedFrameControlValues](../windows.media.capture/capturedframecontrolvalues.md) object that indicates the capture settings used for the frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.FrameControlValues +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.FrameControlValues + +## -description +Gets a [CapturedFrameControlValues](../windows.media.capture/capturedframecontrolvalues.md) object that indicates the capture settings used for the frame. + +## -property-value +A [CapturedFrameControlValues](../windows.media.capture/capturedframecontrolvalues.md) object that indicates the capture settings used for the frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_highdynamicrange.md b/windows.media.core/sceneanalysiseffectframe_highdynamicrange.md index a40fb30e0b..26b435ca29 100644 --- a/windows.media.core/sceneanalysiseffectframe_highdynamicrange.md +++ b/windows.media.core/sceneanalysiseffectframe_highdynamicrange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.HighDynamicRange --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.HighDynamicRange ## -description Gets a [HighDynamicRangeOutput](highdynamicrangeoutput.md) object that provides recommended FrameController objects and a value indicating the certainty of the HDR analysis. ## -property-value A [HighDynamicRangeOutput](highdynamicrangeoutput.md) object that provides the results of the HDR analysis. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.HighDynamicRange +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.HighDynamicRange + +## -description +Gets a [HighDynamicRangeOutput](highdynamicrangeoutput.md) object that provides recommended FrameController objects and a value indicating the certainty of the HDR analysis. + +## -property-value +A [HighDynamicRangeOutput](highdynamicrangeoutput.md) object that provides the results of the HDR analysis. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_isdiscontinuous.md b/windows.media.core/sceneanalysiseffectframe_isdiscontinuous.md index 4d70c72089..4db4b3521a 100644 --- a/windows.media.core/sceneanalysiseffectframe_isdiscontinuous.md +++ b/windows.media.core/sceneanalysiseffectframe_isdiscontinuous.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.IsDiscontinuous --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.IsDiscontinuous ## -description Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream. ## -property-value True if the video frame is the first frame after a gap in the stream; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.IsDiscontinuous +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.IsDiscontinuous + +## -description +Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream. + +## -property-value +True if the video frame is the first frame after a gap in the stream; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_isreadonly.md b/windows.media.core/sceneanalysiseffectframe_isreadonly.md index 8c57a71477..86f2d5e118 100644 --- a/windows.media.core/sceneanalysiseffectframe_isreadonly.md +++ b/windows.media.core/sceneanalysiseffectframe_isreadonly.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.IsReadOnly --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.IsReadOnly ## -description Gets a value indicating whether the frame is read-only. ## -property-value True if the frame is read-only; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.IsReadOnly +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.IsReadOnly + +## -description +Gets a value indicating whether the frame is read-only. + +## -property-value +True if the frame is read-only; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_relativetime.md b/windows.media.core/sceneanalysiseffectframe_relativetime.md index 894c97b5b1..34320d7eb1 100644 --- a/windows.media.core/sceneanalysiseffectframe_relativetime.md +++ b/windows.media.core/sceneanalysiseffectframe_relativetime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.RelativeTime --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.RelativeTime ## -description Gets or sets the relative time of the frame within the video stream. ## -property-value The relative time of the frame within the video stream. ## -remarks Use [SystemRelativeTime](sceneanalysiseffectframe_systemrelativetime.md) to get a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.RelativeTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.RelativeTime + +## -description +Gets or sets the relative time of the frame within the video stream. + +## -property-value +The relative time of the frame within the video stream. + +## -remarks +Use [SystemRelativeTime](sceneanalysiseffectframe_systemrelativetime.md) to get a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_systemrelativetime.md b/windows.media.core/sceneanalysiseffectframe_systemrelativetime.md index ed071fb780..c14cb56529 100644 --- a/windows.media.core/sceneanalysiseffectframe_systemrelativetime.md +++ b/windows.media.core/sceneanalysiseffectframe_systemrelativetime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.SystemRelativeTime --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.SystemRelativeTime ## -description Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. ## -property-value A timestamp relative to the system. ## -remarks Use [RelativeTime](sceneanalysiseffectframe_relativetime.md) to get a timestamp that is relative to the video stream. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.SystemRelativeTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.SystemRelativeTime + +## -description +Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device. + +## -property-value +A timestamp relative to the system. + +## -remarks +Use [RelativeTime](sceneanalysiseffectframe_relativetime.md) to get a timestamp that is relative to the video stream. + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalysiseffectframe_type.md b/windows.media.core/sceneanalysiseffectframe_type.md index bfc4a448ed..084ff5a8ba 100644 --- a/windows.media.core/sceneanalysiseffectframe_type.md +++ b/windows.media.core/sceneanalysiseffectframe_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.Type --api-type: winrt property ---- # Windows.Media.Core.SceneAnalysisEffectFrame.Type ## -description Gets a string indicating the type of data the frame contains. ## -property-value A string indicating the type of data the frame contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.Type +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.Type + +## -description +Gets a string indicating the type of data the frame contains. + +## -property-value +A string indicating the type of data the frame contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/sceneanalyzedeventargs.md b/windows.media.core/sceneanalyzedeventargs.md index d5923cb9e8..f037fc051a 100644 --- a/windows.media.core/sceneanalyzedeventargs.md +++ b/windows.media.core/sceneanalyzedeventargs.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.SceneAnalyzedEventArgs --api-type: winrt class ---- # Windows.Media.Core.SceneAnalyzedEventArgs ## -description Provides data for the [SceneAnalysisEffect.SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event. ## -remarks Get an instance of this class by handling the [SceneAnalysisEffect.SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event. For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). ## -examples ## -see-also [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.SceneAnalyzedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.SceneAnalyzedEventArgs + +## -description +Provides data for the [SceneAnalysisEffect.SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event. + +## -remarks +Get an instance of this class by handling the [SceneAnalysisEffect.SceneAnalyzed](sceneanalysiseffect_sceneanalyzed.md) event. + +For how-to guidance on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). + +## -examples + +## -see-also +[Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file diff --git a/windows.media.core/sceneanalyzedeventargs_resultframe.md b/windows.media.core/sceneanalyzedeventargs_resultframe.md index 5f5cb1ec4b..91ec83295f 100644 --- a/windows.media.core/sceneanalyzedeventargs_resultframe.md +++ b/windows.media.core/sceneanalyzedeventargs_resultframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.SceneAnalyzedEventArgs.ResultFrame --api-type: winrt property ---- # Windows.Media.Core.SceneAnalyzedEventArgs.ResultFrame ## -description Gets the result frame from the scene analysis operation. ## -property-value The result frame from the scene analysis operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.SceneAnalyzedEventArgs.ResultFrame +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalyzedEventArgs.ResultFrame + +## -description +Gets the result frame from the scene analysis operation. + +## -property-value +The result frame from the scene analysis operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack.md b/windows.media.core/timedmetadatatrack.md index efd53b4f80..a7821d48b9 100644 --- a/windows.media.core/timedmetadatatrack.md +++ b/windows.media.core/timedmetadatatrack.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.TimedMetadataTrack --api-type: winrt class ---- # Windows.Media.Core.TimedMetadataTrack ## -description Represents a timed metadata track. The track contains a list of [IMediaCue](imediacue.md) objects and raises events at the beginning and end of the time window of each cue. ## -remarks For how-to guidance for working with timed metadata tracks, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [ITimedMediaTrack](itimedmediatrack.md), [IMediaTrack](imediatrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedMetadataTrack +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedMetadataTrack + +## -description +Represents a timed metadata track. The track contains a list of [IMediaCue](imediacue.md) objects and raises events at the beginning and end of the time window of each cue. + +## -remarks +For how-to guidance for working with timed metadata tracks, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[ITimedMediaTrack](itimedmediatrack.md), [IMediaTrack](imediatrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.core/timedmetadatatrack_activecues.md b/windows.media.core/timedmetadatatrack_activecues.md index 4c718ecb78..f5b52827a1 100644 --- a/windows.media.core/timedmetadatatrack_activecues.md +++ b/windows.media.core/timedmetadatatrack_activecues.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.ActiveCues --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.ActiveCues ## -description Gets the list of media cues in the [TimedMetadataTrack](timedmetadatatrack.md) that are currently active. A cue is considered active after its [StartTime](imediacue_starttime.md) has been reached until its [Duration](imediacue_duration.md) has been exceeded. ## -property-value The list of media cues in the [TimedMetadataTrack](timedmetadatatrack.md) that are currently active. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.ActiveCues +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.ActiveCues + +## -description +Gets the list of media cues in the [TimedMetadataTrack](timedmetadatatrack.md) that are currently active. A cue is considered active after its [StartTime](imediacue_starttime.md) has been reached until its [Duration](imediacue_duration.md) has been exceeded. + +## -property-value +The list of media cues in the [TimedMetadataTrack](timedmetadatatrack.md) that are currently active. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_addcue_1989081881.md b/windows.media.core/timedmetadatatrack_addcue_1989081881.md index c95cc69470..1f27d62733 100644 --- a/windows.media.core/timedmetadatatrack_addcue_1989081881.md +++ b/windows.media.core/timedmetadatatrack_addcue_1989081881.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.TimedMetadataTrack.AddCue(Windows.Media.Core.IMediaCue) --api-type: winrt method ---- # Windows.Media.Core.TimedMetadataTrack.AddCue ## -description Adds the specified media cue to the [TimedMetadataTrack](timedmetadatatrack.md). ## -parameters ### -param cue The media cue to add. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedMetadataTrack.AddCue(Windows.Media.Core.IMediaCue) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedMetadataTrack.AddCue + +## -description +Adds the specified media cue to the [TimedMetadataTrack](timedmetadatatrack.md). + +## -parameters +### -param cue +The media cue to add. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_cueentered.md b/windows.media.core/timedmetadatatrack_cueentered.md index 986f0857a4..da65edc183 100644 --- a/windows.media.core/timedmetadatatrack_cueentered.md +++ b/windows.media.core/timedmetadatatrack_cueentered.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.TimedMetadataTrack.CueEntered --api-type: winrt event ---- # Windows.Media.Core.TimedMetadataTrack.CueEntered ## -description Occurs when a media time window of a media cue is entered. The time window is defined by the [StartTime](imediacue_starttime.md) and [Duration](imediacue_duration.md) of the cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.TimedMetadataTrack.CueEntered +-api-type: winrt event +--- + + + +# Windows.Media.Core.TimedMetadataTrack.CueEntered + +## -description +Occurs when a media time window of a media cue is entered. The time window is defined by the [StartTime](imediacue_starttime.md) and [Duration](imediacue_duration.md) of the cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_cueexited.md b/windows.media.core/timedmetadatatrack_cueexited.md index 46cd5fae01..74de91dbfc 100644 --- a/windows.media.core/timedmetadatatrack_cueexited.md +++ b/windows.media.core/timedmetadatatrack_cueexited.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.TimedMetadataTrack.CueExited --api-type: winrt event ---- # Windows.Media.Core.TimedMetadataTrack.CueExited ## -description Occurs when a media time window of a media cue is exited. The time window is defined by the [StartTime](imediacue_starttime.md) and [Duration](imediacue_duration.md) of the cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.TimedMetadataTrack.CueExited +-api-type: winrt event +--- + + + +# Windows.Media.Core.TimedMetadataTrack.CueExited + +## -description +Occurs when a media time window of a media cue is exited. The time window is defined by the [StartTime](imediacue_starttime.md) and [Duration](imediacue_duration.md) of the cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_cues.md b/windows.media.core/timedmetadatatrack_cues.md index 17166860f2..6d4382e336 100644 --- a/windows.media.core/timedmetadatatrack_cues.md +++ b/windows.media.core/timedmetadatatrack_cues.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.Cues --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.Cues ## -description Gets a read-only list of the media cues in the [TimedMetadataTrack](timedmetadatatrack.md). ## -property-value A read-only list of the media cues in the timed metadata track. ## -remarks Add cues to the list by calling [AddCue](timedmetadatatrack_addcue.md). The cues in the list are sorted in chronological order by the value of the [StartTime](imediacue_starttime.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.Cues +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.Cues + +## -description +Gets a read-only list of the media cues in the [TimedMetadataTrack](timedmetadatatrack.md). + +## -property-value +A read-only list of the media cues in the timed metadata track. + +## -remarks +Add cues to the list by calling [AddCue](timedmetadatatrack_addcue.md). + +The cues in the list are sorted in chronological order by the value of the [StartTime](imediacue_starttime.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_dispatchtype.md b/windows.media.core/timedmetadatatrack_dispatchtype.md index 960b34739f..22f0e8776d 100644 --- a/windows.media.core/timedmetadatatrack_dispatchtype.md +++ b/windows.media.core/timedmetadatatrack_dispatchtype.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.DispatchType --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.DispatchType ## -description Gets the custom string value containing routing information for cues. ## -property-value The custom string value containing routing information for cues. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.DispatchType +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.DispatchType + +## -description +Gets the custom string value containing routing information for cues. + +## -property-value +The custom string value containing routing information for cues. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_id.md b/windows.media.core/timedmetadatatrack_id.md index 9001752e25..821a031c27 100644 --- a/windows.media.core/timedmetadatatrack_id.md +++ b/windows.media.core/timedmetadatatrack_id.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.Id --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.Id ## -description Gets the identifier for the timed metadata track. ## -property-value The identifier for the track. ## -remarks You can specify a value for the **Id** property in the [TimedMetadataTrack constructor](timedmetadatatrack_timedmetadatatrack.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.Id + +## -description +Gets the identifier for the timed metadata track. + +## -property-value +The identifier for the track. + +## -remarks +You can specify a value for the **Id** property in the [TimedMetadataTrack constructor](timedmetadatatrack_timedmetadatatrack.md). + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_label.md b/windows.media.core/timedmetadatatrack_label.md index 57e93d105f..ba88185483 100644 --- a/windows.media.core/timedmetadatatrack_label.md +++ b/windows.media.core/timedmetadatatrack_label.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.Label --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.Label ## -description Gets or sets the label for the timed metadata track. ## -property-value The label for the timed metadata track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.Label + +## -description +Gets or sets the label for the timed metadata track. + +## -property-value +The label for the timed metadata track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_language.md b/windows.media.core/timedmetadatatrack_language.md index 200d2fa703..e429a2dceb 100644 --- a/windows.media.core/timedmetadatatrack_language.md +++ b/windows.media.core/timedmetadatatrack_language.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.Language --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.Language ## -description Gets a string indicating the language of the timed metadata track. ## -property-value A string indicating the language of the timed metadata track. ## -remarks You can specify a value for the **Language** property in the [TimedMetadataTrack constructor](timedmetadatatrack_timedmetadatatrack.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.Language + +## -description +Gets a string indicating the language of the timed metadata track. + +## -property-value +A string indicating the language of the timed metadata track. + +## -remarks +You can specify a value for the **Language** property in the [TimedMetadataTrack constructor](timedmetadatatrack_timedmetadatatrack.md). + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_name.md b/windows.media.core/timedmetadatatrack_name.md index 5941ebda8a..98e54ceb2c 100644 --- a/windows.media.core/timedmetadatatrack_name.md +++ b/windows.media.core/timedmetadatatrack_name.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.Name --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.Name ## -description Gets the name of the [TimedMetadataTrack](timedmetadatatrack.md). ## -property-value The name of the [TimedMetadataTrack](timedmetadatatrack.md). ## -remarks The **Name** property can be used in your UI to identify the metadata track to the user. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.Name + +## -description +Gets the name of the [TimedMetadataTrack](timedmetadatatrack.md). + +## -property-value +The name of the [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks +The **Name** property can be used in your UI to identify the metadata track to the user. + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_playbackitem.md b/windows.media.core/timedmetadatatrack_playbackitem.md index b94776b9b6..953b4a9076 100644 --- a/windows.media.core/timedmetadatatrack_playbackitem.md +++ b/windows.media.core/timedmetadatatrack_playbackitem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.PlaybackItem --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.PlaybackItem ## -description Gets the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [TimedMetadataTrack](timedmetadatatrack.md). ## -property-value The [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [TimedMetadataTrack](timedmetadatatrack.md). ## -remarks A [TimedMetadataTrack](timedmetadatatrack.md) is contained by a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) when it is in the item's [TimedMetadataTracks](../windows.media.playback/mediaplaybackitem_timedmetadatatracks.md) collection. Use the **PlaybackItem** property to get a reference to the **MediaPlaybackItem** that contains the **TimedMetadataTrack**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.PlaybackItem +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.PlaybackItem + +## -description +Gets the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [TimedMetadataTrack](timedmetadatatrack.md). + +## -property-value +The [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks +A [TimedMetadataTrack](timedmetadatatrack.md) is contained by a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) when it is in the item's [TimedMetadataTracks](../windows.media.playback/mediaplaybackitem_timedmetadatatracks.md) collection. Use the **PlaybackItem** property to get a reference to the **MediaPlaybackItem** that contains the **TimedMetadataTrack**. + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_removecue_1017075201.md b/windows.media.core/timedmetadatatrack_removecue_1017075201.md index f013a92ba1..51eb216a64 100644 --- a/windows.media.core/timedmetadatatrack_removecue_1017075201.md +++ b/windows.media.core/timedmetadatatrack_removecue_1017075201.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.TimedMetadataTrack.RemoveCue(Windows.Media.Core.IMediaCue) --api-type: winrt method ---- # Windows.Media.Core.TimedMetadataTrack.RemoveCue ## -description Removes the specified media cue from the [TimedMetadataTrack](timedmetadatatrack.md). ## -parameters ### -param cue The media cue to remove. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedMetadataTrack.RemoveCue(Windows.Media.Core.IMediaCue) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedMetadataTrack.RemoveCue + +## -description +Removes the specified media cue from the [TimedMetadataTrack](timedmetadatatrack.md). + +## -parameters +### -param cue +The media cue to remove. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_timedmetadatakind.md b/windows.media.core/timedmetadatatrack_timedmetadatakind.md index e75ca023d1..e7bd0f454b 100644 --- a/windows.media.core/timedmetadatatrack_timedmetadatakind.md +++ b/windows.media.core/timedmetadatatrack_timedmetadatakind.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.TimedMetadataKind --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.TimedMetadataKind ## -description Gets a value indicating the kind of metadata contained in the track. ## -property-value A value indicating the kind of metadata contained in the track. ## -remarks You can specify a value for the **TimedMetadataKind** property in the [TimedMetadataTrack constructor](timedmetadatatrack_timedmetadatatrack.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.TimedMetadataKind +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.TimedMetadataKind + +## -description +Gets a value indicating the kind of metadata contained in the track. + +## -property-value +A value indicating the kind of metadata contained in the track. + +## -remarks +You can specify a value for the **TimedMetadataKind** property in the [TimedMetadataTrack constructor](timedmetadatatrack_timedmetadatatrack.md). + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_timedmetadatatrack_2131229248.md b/windows.media.core/timedmetadatatrack_timedmetadatatrack_2131229248.md index 6acfe0014e..fae61be75a 100644 --- a/windows.media.core/timedmetadatatrack_timedmetadatatrack_2131229248.md +++ b/windows.media.core/timedmetadatatrack_timedmetadatatrack_2131229248.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.TimedMetadataTrack.#ctor(System.String,System.String,Windows.Media.Core.TimedMetadataKind) --api-type: winrt method ---- # Windows.Media.Core.TimedMetadataTrack.TimedMetadataTrack ## -description Initializes a new instance of the [TimedMetadataTrack](timedmetadatatrack.md) class. ## -parameters ### -param id An identifier for the new timed metadata track. ### -param language A string indicating the language of the new timed metadata track. ### -param kind A value indicating the kind of metadata contained in the new track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedMetadataTrack.#ctor(System.String,System.String,Windows.Media.Core.TimedMetadataKind) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedMetadataTrack.TimedMetadataTrack + +## -description +Initializes a new instance of the [TimedMetadataTrack](timedmetadatatrack.md) class. + +## -parameters +### -param id +An identifier for the new timed metadata track. + +### -param language +A string indicating the language of the new timed metadata track. + +### -param kind +A value indicating the kind of metadata contained in the new track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_trackfailed.md b/windows.media.core/timedmetadatatrack_trackfailed.md index 3c55132959..ebb574e362 100644 --- a/windows.media.core/timedmetadatatrack_trackfailed.md +++ b/windows.media.core/timedmetadatatrack_trackfailed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.TimedMetadataTrack.TrackFailed --api-type: winrt event ---- # Windows.Media.Core.TimedMetadataTrack.TrackFailed ## -description Raised when an error occurs with the [TimedMetadataTrack](timedmetadatatrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.TimedMetadataTrack.TrackFailed +-api-type: winrt event +--- + + + +# Windows.Media.Core.TimedMetadataTrack.TrackFailed + +## -description +Raised when an error occurs with the [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrack_trackkind.md b/windows.media.core/timedmetadatatrack_trackkind.md index 14618af774..eee4ab2a59 100644 --- a/windows.media.core/timedmetadatatrack_trackkind.md +++ b/windows.media.core/timedmetadatatrack_trackkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrack.TrackKind --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrack.TrackKind ## -description Gets a value specifying the type of the media track. For [TimedMetadataTrack](timedmetadatatrack.md) this value will always be [MediaTrackKind::TimedMetadata](mediatrackkind.md). ## -property-value A value specifying the type of the media track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrack.TrackKind +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrack.TrackKind + +## -description +Gets a value specifying the type of the media track. For [TimedMetadataTrack](timedmetadatatrack.md) this value will always be [MediaTrackKind::TimedMetadata](mediatrackkind.md). + +## -property-value +A value specifying the type of the media track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrackerror.md b/windows.media.core/timedmetadatatrackerror.md index e24f170a22..c4f0380b07 100644 --- a/windows.media.core/timedmetadatatrackerror.md +++ b/windows.media.core/timedmetadatatrackerror.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.TimedMetadataTrackError --api-type: winrt class ---- # Windows.Media.Core.TimedMetadataTrackError ## -description Provides information about an error that occurred with a timed metadata track. ## -remarks Get an instance of this class by accessing the [TimedMetadataTrackErrorEventArgs.Error](timedmetadatatrackerroreventargs_error.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedMetadataTrackError +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedMetadataTrackError + +## -description +Provides information about an error that occurred with a timed metadata track. + +## -remarks +Get an instance of this class by accessing the [TimedMetadataTrackErrorEventArgs.Error](timedmetadatatrackerroreventargs_error.md) property. + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrackerror_errorcode.md b/windows.media.core/timedmetadatatrackerror_errorcode.md index 813f1fa674..58ebdaeabb 100644 --- a/windows.media.core/timedmetadatatrackerror_errorcode.md +++ b/windows.media.core/timedmetadatatrackerror_errorcode.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrackError.ErrorCode --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrackError.ErrorCode ## -description Gets the error code associated with the timed metadata track error. ## -property-value The error code associated with the timed metadata track error. ## -remarks This value provides high-level information about the error that occurred with the timed metadata track. To get the low-level exception associated with the error, call [TimedMetadataTrackError.Propagate](timedmetadatatrackerror_propagate.md) which will cause the underlying exception to be raised. ## -examples ## -see-also [TimedMetadataTrackError::Propagate](timedmetadatatrackerror_propagate.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrackError.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrackError.ErrorCode + +## -description +Gets the error code associated with the timed metadata track error. + +## -property-value +The error code associated with the timed metadata track error. + +## -remarks +This value provides high-level information about the error that occurred with the timed metadata track. To get the low-level exception associated with the error, call [TimedMetadataTrackError.Propagate](timedmetadatatrackerror_propagate.md) which will cause the underlying exception to be raised. + +## -examples + +## -see-also +[TimedMetadataTrackError::Propagate](timedmetadatatrackerror_propagate.md) \ No newline at end of file diff --git a/windows.media.core/timedmetadatatrackerror_extendederror.md b/windows.media.core/timedmetadatatrackerror_extendederror.md index f57108f14c..44307916f4 100644 --- a/windows.media.core/timedmetadatatrackerror_extendederror.md +++ b/windows.media.core/timedmetadatatrackerror_extendederror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrackError.ExtendedError --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrackError.ExtendedError ## -description Gets the extended error code for the [TimedMetadataTrackError](timedmetadatatrackerror.md). ## -property-value The extended error code for the [TimedMetadataTrackError](timedmetadatatrackerror.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrackError.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrackError.ExtendedError + +## -description +Gets the extended error code for the [TimedMetadataTrackError](timedmetadatatrackerror.md). + +## -property-value +The extended error code for the [TimedMetadataTrackError](timedmetadatatrackerror.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrackfailedeventargs.md b/windows.media.core/timedmetadatatrackfailedeventargs.md index 2b15c7495b..f4ad18b6dc 100644 --- a/windows.media.core/timedmetadatatrackfailedeventargs.md +++ b/windows.media.core/timedmetadatatrackfailedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.TimedMetadataTrackFailedEventArgs --api-type: winrt class ---- # Windows.Media.Core.TimedMetadataTrackFailedEventArgs ## -description Provides data for the [TimedMetadataTrack.TrackFailed](timedmetadatatrack_trackfailed.md) event. ## -remarks Get an instance of this class by handling the [TimedMetadataTrack.TrackFailed](timedmetadatatrack_trackfailed.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedMetadataTrackFailedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedMetadataTrackFailedEventArgs + +## -description +Provides data for the [TimedMetadataTrack.TrackFailed](timedmetadatatrack_trackfailed.md) event. + +## -remarks +Get an instance of this class by handling the [TimedMetadataTrack.TrackFailed](timedmetadatatrack_trackfailed.md) event. + +## -examples + +## -see-also diff --git a/windows.media.core/timedmetadatatrackfailedeventargs_error.md b/windows.media.core/timedmetadatatrackfailedeventargs_error.md index 8135e3f95c..205fdb43ad 100644 --- a/windows.media.core/timedmetadatatrackfailedeventargs_error.md +++ b/windows.media.core/timedmetadatatrackfailedeventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedMetadataTrackFailedEventArgs.Error --api-type: winrt property ---- # Windows.Media.Core.TimedMetadataTrackFailedEventArgs.Error ## -description Gets an object representing the error that occurred with the timed metadata track. ## -property-value An object representing the error that occurred with the timed metadata track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedMetadataTrackFailedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedMetadataTrackFailedEventArgs.Error + +## -description +Gets an object representing the error that occurred with the timed metadata track. + +## -property-value +An object representing the error that occurred with the timed metadata track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue.md b/windows.media.core/timedtextcue.md index 8aa201b2a8..28fc893ff2 100644 --- a/windows.media.core/timedtextcue.md +++ b/windows.media.core/timedtextcue.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.TimedTextCue --api-type: winrt class ---- # Windows.Media.Core.TimedTextCue ## -description Represents a text cue in a [TimedMetadataTrack](timedmetadatatrack.md). ## -remarks After creating a **TimeTextCue**, you can add it to a [TimedMetadataTrack](timedmetadatatrack.md) by calling [AddCue](timedmetadatatrack_addcue.md). ## -examples ## -see-also [ITimedTextCue](itimedtextcue.md), [IMediaCue](imediacue.md), [TimedMetadataTrack](timedmetadatatrack.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextCue +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextCue + +## -description +Represents a text cue in a [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks +After creating a **TimeTextCue**, you can add it to a [TimedMetadataTrack](timedmetadatatrack.md) by calling [AddCue](timedmetadatatrack_addcue.md). + +## -examples + +## -see-also +[ITimedTextCue](itimedtextcue.md), [IMediaCue](imediacue.md), [TimedMetadataTrack](timedmetadatatrack.md) \ No newline at end of file diff --git a/windows.media.core/timedtextcue_cueregion.md b/windows.media.core/timedtextcue_cueregion.md index ffca230eaf..63536959ab 100644 --- a/windows.media.core/timedtextcue_cueregion.md +++ b/windows.media.core/timedtextcue_cueregion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextCue.CueRegion --api-type: winrt property ---- # Windows.Media.Core.TimedTextCue.CueRegion ## -description Gets or sets the [TimedTextRegion](timedtextregion.md) of the cue, which defines the style of the rendering area for the cue. ## -property-value The [TimedTextRegion](timedtextregion.md) of the cue ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextCue.CueRegion +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextCue.CueRegion + +## -description +Gets or sets the [TimedTextRegion](timedtextregion.md) of the cue, which defines the style of the rendering area for the cue. + +## -property-value +The [TimedTextRegion](timedtextregion.md) of the cue + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue_cuestyle.md b/windows.media.core/timedtextcue_cuestyle.md index 59db39544e..bbec57eef3 100644 --- a/windows.media.core/timedtextcue_cuestyle.md +++ b/windows.media.core/timedtextcue_cuestyle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextCue.CueStyle --api-type: winrt property ---- # Windows.Media.Core.TimedTextCue.CueStyle ## -description Gets or sets the [TimedTextStyle](timedtextstyle.md) of the cue, which defines the style of the rendered text. ## -property-value The [TimedTextStyle](timedtextstyle.md) of the cue ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextCue.CueStyle +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextCue.CueStyle + +## -description +Gets or sets the [TimedTextStyle](timedtextstyle.md) of the cue, which defines the style of the rendered text. + +## -property-value +The [TimedTextStyle](timedtextstyle.md) of the cue + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue_duration.md b/windows.media.core/timedtextcue_duration.md index 892bfe7bb8..26f7cedff1 100644 --- a/windows.media.core/timedtextcue_duration.md +++ b/windows.media.core/timedtextcue_duration.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextCue.Duration --api-type: winrt property ---- # Windows.Media.Core.TimedTextCue.Duration ## -description Gets or sets the duration of the cue. ## -property-value The duration of the cue. ## -remarks At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextCue.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextCue.Duration + +## -description +Gets or sets the duration of the cue. + +## -property-value +The duration of the cue. + +## -remarks +At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue_id.md b/windows.media.core/timedtextcue_id.md index 6d443f1178..b5cdb6209f 100644 --- a/windows.media.core/timedtextcue_id.md +++ b/windows.media.core/timedtextcue_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextCue.Id --api-type: winrt property ---- # Windows.Media.Core.TimedTextCue.Id ## -description Gets or sets an identifier for the cue. ## -property-value An identifier for the cue. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextCue.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextCue.Id + +## -description +Gets or sets an identifier for the cue. + +## -property-value +An identifier for the cue. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue_lines.md b/windows.media.core/timedtextcue_lines.md index 40536c05b9..7652c8d6ed 100644 --- a/windows.media.core/timedtextcue_lines.md +++ b/windows.media.core/timedtextcue_lines.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextCue.Lines --api-type: winrt property ---- # Windows.Media.Core.TimedTextCue.Lines ## -description Gets the collection of [TimedTextLine](timedtextline.md) objects that convey the text of the cue. ## -property-value A collection of [TimedTextLine](timedtextline.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextCue.Lines +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextCue.Lines + +## -description +Gets the collection of [TimedTextLine](timedtextline.md) objects that convey the text of the cue. + +## -property-value +A collection of [TimedTextLine](timedtextline.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue_starttime.md b/windows.media.core/timedtextcue_starttime.md index a419753cf7..1cbc4daa3a 100644 --- a/windows.media.core/timedtextcue_starttime.md +++ b/windows.media.core/timedtextcue_starttime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextCue.StartTime --api-type: winrt property ---- # Windows.Media.Core.TimedTextCue.StartTime ## -description Gets the start time of the cue. ## -property-value The start time of the cue. ## -remarks When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextCue.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextCue.StartTime + +## -description +Gets the start time of the cue. + +## -property-value +The start time of the cue. + +## -remarks +When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextcue_timedtextcue_1221375020.md b/windows.media.core/timedtextcue_timedtextcue_1221375020.md index 49d238f2db..80f4adf4a6 100644 --- a/windows.media.core/timedtextcue_timedtextcue_1221375020.md +++ b/windows.media.core/timedtextcue_timedtextcue_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.TimedTextCue.#ctor --api-type: winrt method ---- # Windows.Media.Core.TimedTextCue.TimedTextCue ## -description Initializes a new instance of the [TimedTextCue](timedtextcue.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextCue.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextCue.TimedTextCue + +## -description +Initializes a new instance of the [TimedTextCue](timedtextcue.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextline.md b/windows.media.core/timedtextline.md index 9f2a7f6204..9c994f8e5f 100644 --- a/windows.media.core/timedtextline.md +++ b/windows.media.core/timedtextline.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.TimedTextLine --api-type: winrt class ---- # Windows.Media.Core.TimedTextLine ## -description Represents a line of text that is displayed with a [TimedTextCue](timedtextcue.md). ## -remarks ## -examples ## -see-also [ITimedTextLine](itimedtextline.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextLine +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextLine + +## -description +Represents a line of text that is displayed with a [TimedTextCue](timedtextcue.md). + +## -remarks + +## -examples + +## -see-also +[ITimedTextLine](itimedtextline.md) \ No newline at end of file diff --git a/windows.media.core/timedtextline_subformats.md b/windows.media.core/timedtextline_subformats.md index 51444648da..17f53fee7d 100644 --- a/windows.media.core/timedtextline_subformats.md +++ b/windows.media.core/timedtextline_subformats.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextLine.Subformats --api-type: winrt property ---- # Windows.Media.Core.TimedTextLine.Subformats ## -description Gets a list of [TimedTextSubformat](timedtextsubformat.md) objects that provide formatting for substrings within the [TimedTextLine](timedtextlinealignment.md). ## -property-value A list of [TimedTextSubformat](timedtextsubformat.md) objects that provide formatting for substrings within the timed text line. ## -remarks ## -examples ## -see-also [TimedTextSubformat](timedtextsubformat.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextLine.Subformats +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextLine.Subformats + +## -description +Gets a list of [TimedTextSubformat](timedtextsubformat.md) objects that provide formatting for substrings within the [TimedTextLine](timedtextlinealignment.md). + +## -property-value +A list of [TimedTextSubformat](timedtextsubformat.md) objects that provide formatting for substrings within the timed text line. + +## -remarks + +## -examples + +## -see-also +[TimedTextSubformat](timedtextsubformat.md) \ No newline at end of file diff --git a/windows.media.core/timedtextline_text.md b/windows.media.core/timedtextline_text.md index 22515e4f46..6b17cabe73 100644 --- a/windows.media.core/timedtextline_text.md +++ b/windows.media.core/timedtextline_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextLine.Text --api-type: winrt property ---- # Windows.Media.Core.TimedTextLine.Text ## -description Gets or sets the text content of the [TimedTextLine](timedtextlinealignment.md). ## -property-value The text content of the [TimedTextLine](timedtextlinealignment.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextLine.Text +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextLine.Text + +## -description +Gets or sets the text content of the [TimedTextLine](timedtextlinealignment.md). + +## -property-value +The text content of the [TimedTextLine](timedtextlinealignment.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextline_timedtextline_1221375020.md b/windows.media.core/timedtextline_timedtextline_1221375020.md index cc238d65be..ceafb0fc7a 100644 --- a/windows.media.core/timedtextline_timedtextline_1221375020.md +++ b/windows.media.core/timedtextline_timedtextline_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.TimedTextLine.#ctor --api-type: winrt method ---- # Windows.Media.Core.TimedTextLine.TimedTextLine ## -description Initializes a new instance of the [TimedTextLine](timedtextline.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextLine.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextLine.TimedTextLine + +## -description +Initializes a new instance of the [TimedTextLine](timedtextline.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion.md b/windows.media.core/timedtextregion.md index 36cdec9d24..e6f245ef74 100644 --- a/windows.media.core/timedtextregion.md +++ b/windows.media.core/timedtextregion.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.TimedTextRegion --api-type: winrt class ---- # Windows.Media.Core.TimedTextRegion ## -description Exposes properties for customizing the appearance of the rendering area of a [TimedTextCue](timedtextcue.md). ## -remarks ## -examples ## -see-also [ITimedTextRegion](itimedtextregion.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextRegion +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextRegion + +## -description +Exposes properties for customizing the appearance of the rendering area of a [TimedTextCue](timedtextcue.md). + +## -remarks + +## -examples + +## -see-also +[ITimedTextRegion](itimedtextregion.md) \ No newline at end of file diff --git a/windows.media.core/timedtextregion_background.md b/windows.media.core/timedtextregion_background.md index 5b1ae054f2..5b0ffb05fa 100644 --- a/windows.media.core/timedtextregion_background.md +++ b/windows.media.core/timedtextregion_background.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.Background --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.Background ## -description Gets or sets the background color of the [TimedTextRegion](timedtextregion.md). ## -property-value The background color of the [TimedTextRegion](timedtextregion.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.Background +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.Background + +## -description +Gets or sets the background color of the [TimedTextRegion](timedtextregion.md). + +## -property-value +The background color of the [TimedTextRegion](timedtextregion.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_displayalignment.md b/windows.media.core/timedtextregion_displayalignment.md index 69abfa3960..d32cfb4414 100644 --- a/windows.media.core/timedtextregion_displayalignment.md +++ b/windows.media.core/timedtextregion_displayalignment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.DisplayAlignment --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.DisplayAlignment ## -description Gets or sets the display alignment of the [TimedTextRegion](timedtextregion.md). ## -property-value The display alignment of the [TimedTextRegion](timedtextregion.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.DisplayAlignment +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.DisplayAlignment + +## -description +Gets or sets the display alignment of the [TimedTextRegion](timedtextregion.md). + +## -property-value +The display alignment of the [TimedTextRegion](timedtextregion.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_extent.md b/windows.media.core/timedtextregion_extent.md index 0af5bcf56a..20446f6072 100644 --- a/windows.media.core/timedtextregion_extent.md +++ b/windows.media.core/timedtextregion_extent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.Extent --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.Extent ## -description Gets or sets the extent of the [TimedTextRegion](timedtextregion.md), which is the rendered size of the region either in pixels or in percentage of available space. ## -property-value The extent of the [TimedTextRegion](timedtextregion.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.Extent +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.Extent + +## -description +Gets or sets the extent of the [TimedTextRegion](timedtextregion.md), which is the rendered size of the region either in pixels or in percentage of available space. + +## -property-value +The extent of the [TimedTextRegion](timedtextregion.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_isoverflowclipped.md b/windows.media.core/timedtextregion_isoverflowclipped.md index 91bddad312..f4befbd600 100644 --- a/windows.media.core/timedtextregion_isoverflowclipped.md +++ b/windows.media.core/timedtextregion_isoverflowclipped.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.IsOverflowClipped --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.IsOverflowClipped ## -description Gets or sets a value indicating whether text overflowing the region is clipped. ## -property-value True if overflowing text is clipped; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.IsOverflowClipped +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.IsOverflowClipped + +## -description +Gets or sets a value indicating whether text overflowing the region is clipped. + +## -property-value +True if overflowing text is clipped; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_lineheight.md b/windows.media.core/timedtextregion_lineheight.md index 94a8088c98..11513e724a 100644 --- a/windows.media.core/timedtextregion_lineheight.md +++ b/windows.media.core/timedtextregion_lineheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.LineHeight --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.LineHeight ## -description Gets or sets a value that indicates the height of each line of content. ## -property-value A value that indicates the height of each line of content. ## -remarks ## -examples ## -see-also [TimedTextDouble](timedtextdouble.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.LineHeight +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.LineHeight + +## -description +Gets or sets a value that indicates the height of each line of content. + +## -property-value +A value that indicates the height of each line of content. + +## -remarks + +## -examples + +## -see-also +[TimedTextDouble](timedtextdouble.md) \ No newline at end of file diff --git a/windows.media.core/timedtextregion_name.md b/windows.media.core/timedtextregion_name.md index f4b61da4bd..0019a74d55 100644 --- a/windows.media.core/timedtextregion_name.md +++ b/windows.media.core/timedtextregion_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.Name --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.Name ## -description Gets or sets a string representing the name of the [TimedTextRegion](timedtextregion.md). ## -property-value The name of the [TimedTextRegion](timedtextregion.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.Name + +## -description +Gets or sets a string representing the name of the [TimedTextRegion](timedtextregion.md). + +## -property-value +The name of the [TimedTextRegion](timedtextregion.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_padding.md b/windows.media.core/timedtextregion_padding.md index 995850ac98..afba17fd37 100644 --- a/windows.media.core/timedtextregion_padding.md +++ b/windows.media.core/timedtextregion_padding.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.Padding --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.Padding ## -description Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a [TimedTextRegion](timedtextregion.md). ## -property-value A value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a [TimedTextRegion](timedtextregion.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.Padding +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.Padding + +## -description +Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a [TimedTextRegion](timedtextregion.md). + +## -property-value +A value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a [TimedTextRegion](timedtextregion.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_position.md b/windows.media.core/timedtextregion_position.md index d571b8d4b2..1fa3984025 100644 --- a/windows.media.core/timedtextregion_position.md +++ b/windows.media.core/timedtextregion_position.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.Position --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.Position ## -description Gets or sets the position of the [TimedTextRegion](timedtextregion.md), relative to the top left corner of the video frame. ## -property-value The position of the [TimedTextRegion](timedtextregion.md) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.Position +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.Position + +## -description +Gets or sets the position of the [TimedTextRegion](timedtextregion.md), relative to the top left corner of the video frame. + +## -property-value +The position of the [TimedTextRegion](timedtextregion.md) + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_scrollmode.md b/windows.media.core/timedtextregion_scrollmode.md index 1e7cfc049c..5199974f53 100644 --- a/windows.media.core/timedtextregion_scrollmode.md +++ b/windows.media.core/timedtextregion_scrollmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.ScrollMode --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.ScrollMode ## -description Gets a value indicating the method in which lines of text scroll through the region. ## -property-value A value indicating the method in which lines of text scroll through the region. ## -remarks ## -examples ## -see-also [TimedTextScrollMode](timedtextscrollmode.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.ScrollMode +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.ScrollMode + +## -description +Gets a value indicating the method in which lines of text scroll through the region. + +## -property-value +A value indicating the method in which lines of text scroll through the region. + +## -remarks + +## -examples + +## -see-also +[TimedTextScrollMode](timedtextscrollmode.md) \ No newline at end of file diff --git a/windows.media.core/timedtextregion_textwrapping.md b/windows.media.core/timedtextregion_textwrapping.md index 208975f071..abfa0735de 100644 --- a/windows.media.core/timedtextregion_textwrapping.md +++ b/windows.media.core/timedtextregion_textwrapping.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.TextWrapping --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.TextWrapping ## -description Gets or sets a value indicating whether text wraps when it reaches the edge of the [TimedTextRegion](timedtextregion.md). ## -property-value A value indicating whether text wraps when it reaches the edge of the region. ## -remarks ## -examples ## -see-also [TimedTextWrapping](timedtextwrapping.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.TextWrapping +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.TextWrapping + +## -description +Gets or sets a value indicating whether text wraps when it reaches the edge of the [TimedTextRegion](timedtextregion.md). + +## -property-value +A value indicating whether text wraps when it reaches the edge of the region. + +## -remarks + +## -examples + +## -see-also +[TimedTextWrapping](timedtextwrapping.md) \ No newline at end of file diff --git a/windows.media.core/timedtextregion_timedtextregion_1221375020.md b/windows.media.core/timedtextregion_timedtextregion_1221375020.md index cf01d189b1..840fe2307b 100644 --- a/windows.media.core/timedtextregion_timedtextregion_1221375020.md +++ b/windows.media.core/timedtextregion_timedtextregion_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.TimedTextRegion.#ctor --api-type: winrt method ---- # Windows.Media.Core.TimedTextRegion.TimedTextRegion ## -description Initializes a new instance of the [TimedTextRegion](timedtextregion.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextRegion.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextRegion.TimedTextRegion + +## -description +Initializes a new instance of the [TimedTextRegion](timedtextregion.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextregion_writingmode.md b/windows.media.core/timedtextregion_writingmode.md index 9fc091b169..949e2384fc 100644 --- a/windows.media.core/timedtextregion_writingmode.md +++ b/windows.media.core/timedtextregion_writingmode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.WritingMode --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.WritingMode ## -description Gets or sets a value indicating the direction that text flows within the [TimedTextRegion](timedtextregion.md). ## -property-value A value indicating the direction that text flows within the region. ## -remarks ## -examples ## -see-also [TimedTextWritingMode](timedtextwritingmode.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.WritingMode +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.WritingMode + +## -description +Gets or sets a value indicating the direction that text flows within the [TimedTextRegion](timedtextregion.md). + +## -property-value +A value indicating the direction that text flows within the region. + +## -remarks + +## -examples + +## -see-also +[TimedTextWritingMode](timedtextwritingmode.md) \ No newline at end of file diff --git a/windows.media.core/timedtextregion_zindex.md b/windows.media.core/timedtextregion_zindex.md index 3df0969462..574f574fa4 100644 --- a/windows.media.core/timedtextregion_zindex.md +++ b/windows.media.core/timedtextregion_zindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextRegion.ZIndex --api-type: winrt property ---- # Windows.Media.Core.TimedTextRegion.ZIndex ## -description Gets or sets the Z-order of the [TimedTextRegion](timedtextregion.md), relative to other active regions on the screen, in case they overlap. ## -property-value The Z-order of the [TimedTextRegion](timedtextregion.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextRegion.ZIndex +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextRegion.ZIndex + +## -description +Gets or sets the Z-order of the [TimedTextRegion](timedtextregion.md), relative to other active regions on the screen, in case they overlap. + +## -property-value +The Z-order of the [TimedTextRegion](timedtextregion.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextsource.md b/windows.media.core/timedtextsource.md index cb8a8e0695..c36cd6a7dd 100644 --- a/windows.media.core/timedtextsource.md +++ b/windows.media.core/timedtextsource.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.TimedTextSource --api-type: winrt class ---- # Windows.Media.Core.TimedTextSource ## -description Represents a source of timed text data. ## -remarks Get an instance of **TimedTextSource** from one of the factory methods, [CreateFromStream](timedtextsource_createfromstream.md) or [CreateFromUri](timedtextsource_createfromuri.md). After obtaining an instance, you can use it to set the [MediaSource.ExternalTimedTextSources](mediasource_externaltimedtextsources.md) property of a [MediaSource](mediasource.md) object to initialize its [ExternalTimedMetadataTracks](mediasource_externaltimedmetadatatracks.md) collection. For how-to guidance for working with external timed text sources, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [ITimedTextSource](itimedtextsource.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextSource +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextSource + +## -description +Represents a source of timed text data. + +## -remarks +Get an instance of **TimedTextSource** from one of the factory methods, [CreateFromStream](timedtextsource_createfromstream.md) or [CreateFromUri](timedtextsource_createfromuri.md). After obtaining an instance, you can use it to set the [MediaSource.ExternalTimedTextSources](mediasource_externaltimedtextsources.md) property of a [MediaSource](mediasource.md) object to initialize its [ExternalTimedMetadataTracks](mediasource_externaltimedmetadatatracks.md) collection. + +For how-to guidance for working with external timed text sources, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[ITimedTextSource](itimedtextsource.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.core/timedtextsource_createfromstream_1985521886.md b/windows.media.core/timedtextsource_createfromstream_1985521886.md index bcc309ccc0..6856c4ca51 100644 --- a/windows.media.core/timedtextsource_createfromstream_1985521886.md +++ b/windows.media.core/timedtextsource_createfromstream_1985521886.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Core.TimedTextSource.CreateFromStream(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Media.Core.TimedTextSource.CreateFromStream ## -description Creates a new instance of [TimedTextSource](timedtextsource.md) from the provided stream. ## -parameters ### -param stream The stream from which the timed text source is created. ## -returns The new timed text source. ## -remarks ## -examples ## -see-also [CreateFromStream(IRandomAccessStream, String)](timedtextsource_createfromstream_983868770.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromStream(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromStream + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) from the provided stream. + +## -parameters +### -param stream +The stream from which the timed text source is created. + +## -returns +The new timed text source. + +## -remarks + +## -examples + +## -see-also +[CreateFromStream(IRandomAccessStream, String)](timedtextsource_createfromstream_983868770.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsource_createfromstream_983868770.md b/windows.media.core/timedtextsource_createfromstream_983868770.md index c34c6b271c..8fea053f51 100644 --- a/windows.media.core/timedtextsource_createfromstream_983868770.md +++ b/windows.media.core/timedtextsource_createfromstream_983868770.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Core.TimedTextSource.CreateFromStream(Windows.Storage.Streams.IRandomAccessStream,System.String) --api-type: winrt method ---- # Windows.Media.Core.TimedTextSource.CreateFromStream ## -description Creates a new instance of [TimedTextSource](timedtextsource.md) with the specified default language from the provided stream. ## -parameters ### -param stream The stream from which the timed text source is created. ### -param defaultLanguage A string specifying the default language for the timed text source. ## -returns The new timed text source. ## -remarks ## -examples ## -see-also [CreateFromStream(IRandomAccessStream)](timedtextsource_createfromstream_1985521886.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromStream(Windows.Storage.Streams.IRandomAccessStream,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromStream + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) with the specified default language from the provided stream. + +## -parameters +### -param stream +The stream from which the timed text source is created. + +### -param defaultLanguage +A string specifying the default language for the timed text source. + +## -returns +The new timed text source. + +## -remarks + +## -examples + +## -see-also +[CreateFromStream(IRandomAccessStream)](timedtextsource_createfromstream_1985521886.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsource_createfromuri_1421797945.md b/windows.media.core/timedtextsource_createfromuri_1421797945.md index 9a0397d1b6..58ad14868a 100644 --- a/windows.media.core/timedtextsource_createfromuri_1421797945.md +++ b/windows.media.core/timedtextsource_createfromuri_1421797945.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Core.TimedTextSource.CreateFromUri(Windows.Foundation.Uri,System.String) --api-type: winrt method ---- # Windows.Media.Core.TimedTextSource.CreateFromUri ## -description Creates a new instance of [TimedTextSource](timedtextsource.md) with the specified default language from the provided URI. ## -parameters ### -param uri The URI from which the timed text source is created. ### -param defaultLanguage A string specifying the default language for the timed text source. ## -returns The new timed text source. ## -remarks ## -examples ## -see-also [CreateFromUri(Uri)](timedtextsource_createfromuri_407037831.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromUri(Windows.Foundation.Uri,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromUri + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) with the specified default language from the provided URI. + +## -parameters +### -param uri +The URI from which the timed text source is created. + +### -param defaultLanguage +A string specifying the default language for the timed text source. + +## -returns +The new timed text source. + +## -remarks + +## -examples + +## -see-also +[CreateFromUri(Uri)](timedtextsource_createfromuri_407037831.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsource_createfromuri_407037831.md b/windows.media.core/timedtextsource_createfromuri_407037831.md index ae977fb643..dc87883c7a 100644 --- a/windows.media.core/timedtextsource_createfromuri_407037831.md +++ b/windows.media.core/timedtextsource_createfromuri_407037831.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Core.TimedTextSource.CreateFromUri(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.Media.Core.TimedTextSource.CreateFromUri ## -description Creates a new instance of [TimedTextSource](timedtextsource.md) from the provided URI. ## -parameters ### -param uri The URI from which the timed text source is created. ## -returns The new timed text source. ## -remarks ## -examples ## -see-also [CreateFromUri(Uri, String)](timedtextsource_createfromuri_1421797945.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromUri(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromUri + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) from the provided URI. + +## -parameters +### -param uri +The URI from which the timed text source is created. + +## -returns +The new timed text source. + +## -remarks + +## -examples + +## -see-also +[CreateFromUri(Uri, String)](timedtextsource_createfromuri_1421797945.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsource_resolved.md b/windows.media.core/timedtextsource_resolved.md index 2c8bff744b..43fcf1c4c0 100644 --- a/windows.media.core/timedtextsource_resolved.md +++ b/windows.media.core/timedtextsource_resolved.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.TimedTextSource.Resolved --api-type: winrt event ---- # Windows.Media.Core.TimedTextSource.Resolved ## -description Occurs when the [TimedTextSource](timedtextsource.md) is resolved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.TimedTextSource.Resolved +-api-type: winrt event +--- + + + +# Windows.Media.Core.TimedTextSource.Resolved + +## -description +Occurs when the [TimedTextSource](timedtextsource.md) is resolved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextsourceresolveresulteventargs.md b/windows.media.core/timedtextsourceresolveresulteventargs.md index b3379e481f..831dcdc269 100644 --- a/windows.media.core/timedtextsourceresolveresulteventargs.md +++ b/windows.media.core/timedtextsourceresolveresulteventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.TimedTextSourceResolveResultEventArgs --api-type: winrt class ---- # Windows.Media.Core.TimedTextSourceResolveResultEventArgs ## -description Provides data for the [TimedTextSource.Resolved](timedtextsource_resolved.md) event. ## -remarks Get an instance of this class by handling the [TimedTextSource.Resolved](timedtextsource_resolved.md) event. ## -examples ## -see-also [ITimedTextSourceResolveResultEventArgs](itimedtextsourceresolveresulteventargs.md), [TimedTextSource](timedtextsource.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextSourceResolveResultEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextSourceResolveResultEventArgs + +## -description +Provides data for the [TimedTextSource.Resolved](timedtextsource_resolved.md) event. + +## -remarks +Get an instance of this class by handling the [TimedTextSource.Resolved](timedtextsource_resolved.md) event. + +## -examples + +## -see-also +[ITimedTextSourceResolveResultEventArgs](itimedtextsourceresolveresulteventargs.md), [TimedTextSource](timedtextsource.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsourceresolveresulteventargs_error.md b/windows.media.core/timedtextsourceresolveresulteventargs_error.md index 4308710d4b..7368ce02e9 100644 --- a/windows.media.core/timedtextsourceresolveresulteventargs_error.md +++ b/windows.media.core/timedtextsourceresolveresulteventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Error --api-type: winrt property ---- # Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Error ## -description Gets an object representing the asynchronous error that occurred when the [TimedTextSource](timedtextsource.md) was resolved. ## -property-value An object representing the asynchronous error that occurred when the [TimedTextSource](timedtextsource.md) was resolved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Error + +## -description +Gets an object representing the asynchronous error that occurred when the [TimedTextSource](timedtextsource.md) was resolved. + +## -property-value +An object representing the asynchronous error that occurred when the [TimedTextSource](timedtextsource.md) was resolved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextsourceresolveresulteventargs_tracks.md b/windows.media.core/timedtextsourceresolveresulteventargs_tracks.md index c0bdecf7b8..703ac10d04 100644 --- a/windows.media.core/timedtextsourceresolveresulteventargs_tracks.md +++ b/windows.media.core/timedtextsourceresolveresulteventargs_tracks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Tracks --api-type: winrt property ---- # Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Tracks ## -description Gets the list of [TimedMetadataTrack](timedmetadatatrack.md) objects resulting from resolving the [TimedTextSource](timedtextsource.md). ## -property-value The list of [TimedMetadataTrack](timedmetadatatrack.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Tracks +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextSourceResolveResultEventArgs.Tracks + +## -description +Gets the list of [TimedMetadataTrack](timedmetadatatrack.md) objects resulting from resolving the [TimedTextSource](timedtextsource.md). + +## -property-value +The list of [TimedMetadataTrack](timedmetadatatrack.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle.md b/windows.media.core/timedtextstyle.md index e312bad6f0..e245c42455 100644 --- a/windows.media.core/timedtextstyle.md +++ b/windows.media.core/timedtextstyle.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.TimedTextStyle --api-type: winrt class ---- # Windows.Media.Core.TimedTextStyle ## -description Defines the style of the rendered text in a [TimedTextCue](timedtextcue.md). You can set the style of a substring within a [TimedTextLine](timedtextline.md) by using the [Subformats](timedtextline_subformats.md) property. ## -remarks ## -examples ## -see-also [ITimedTextStyle](itimedtextstyle.md), [TimedTextLine](timedtextline.md), [TimedTextLine::Subformats](timedtextline_subformats.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextStyle +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextStyle + +## -description +Defines the style of the rendered text in a [TimedTextCue](timedtextcue.md). You can set the style of a substring within a [TimedTextLine](timedtextline.md) by using the [Subformats](timedtextline_subformats.md) property. + +## -remarks + +## -examples + +## -see-also +[ITimedTextStyle](itimedtextstyle.md), [TimedTextLine](timedtextline.md), [TimedTextLine::Subformats](timedtextline_subformats.md) \ No newline at end of file diff --git a/windows.media.core/timedtextstyle_background.md b/windows.media.core/timedtextstyle_background.md index cc113746bb..e28c01cf2a 100644 --- a/windows.media.core/timedtextstyle_background.md +++ b/windows.media.core/timedtextstyle_background.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.Background --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.Background ## -description Gets or sets the background color of timed text. ## -property-value The background color of timed text. ## -remarks This **TimedTextStyle.Background** color is rendered behind character glyphs or spaces in timed text content. The [TimedTextRegion.Background](timedtextregion_background.md) color sets the color of the background of the container in which the timed text lines are rendered. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.Background +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.Background + +## -description +Gets or sets the background color of timed text. + +## -property-value +The background color of timed text. + +## -remarks +This **TimedTextStyle.Background** color is rendered behind character glyphs or spaces in timed text content. The [TimedTextRegion.Background](timedtextregion_background.md) color sets the color of the background of the container in which the timed text lines are rendered. + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_flowdirection.md b/windows.media.core/timedtextstyle_flowdirection.md index b8b5617d86..7f0917a189 100644 --- a/windows.media.core/timedtextstyle_flowdirection.md +++ b/windows.media.core/timedtextstyle_flowdirection.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.FlowDirection --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.FlowDirection ## -description Gets or sets a value indicating the direction that timed text is flowed. ## -property-value A value indicating the direction that the timed text is flows. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.FlowDirection +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.FlowDirection + +## -description +Gets or sets a value indicating the direction that timed text is flowed. + +## -property-value +A value indicating the direction that the timed text is flows. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_fontfamily.md b/windows.media.core/timedtextstyle_fontfamily.md index 7baebbcad9..64ed85feea 100644 --- a/windows.media.core/timedtextstyle_fontfamily.md +++ b/windows.media.core/timedtextstyle_fontfamily.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.FontFamily --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.FontFamily ## -description Gets or sets the font family of timed text. ## -property-value The font family of timed text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.FontFamily +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.FontFamily + +## -description +Gets or sets the font family of timed text. + +## -property-value +The font family of timed text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_fontsize.md b/windows.media.core/timedtextstyle_fontsize.md index 942ab3f8a9..d64a59263b 100644 --- a/windows.media.core/timedtextstyle_fontsize.md +++ b/windows.media.core/timedtextstyle_fontsize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.FontSize --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.FontSize ## -description Gets or sets the font size of timed text. ## -property-value The font size of timed text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.FontSize +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.FontSize + +## -description +Gets or sets the font size of timed text. + +## -property-value +The font size of timed text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_fontweight.md b/windows.media.core/timedtextstyle_fontweight.md index 4f41e5ad5c..0bb3b07798 100644 --- a/windows.media.core/timedtextstyle_fontweight.md +++ b/windows.media.core/timedtextstyle_fontweight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.FontWeight --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.FontWeight ## -description Gets or sets the weight of timed text. ## -property-value The weight of timed text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.FontWeight +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.FontWeight + +## -description +Gets or sets the weight of timed text. + +## -property-value +The weight of timed text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_foreground.md b/windows.media.core/timedtextstyle_foreground.md index 49e2eb1590..4b4137bacd 100644 --- a/windows.media.core/timedtextstyle_foreground.md +++ b/windows.media.core/timedtextstyle_foreground.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.Foreground --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.Foreground ## -description Gets or sets the color of the timed text glyphs. ## -property-value The color of the timed text glyphs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.Foreground +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.Foreground + +## -description +Gets or sets the color of the timed text glyphs. + +## -property-value +The color of the timed text glyphs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_isbackgroundalwaysshown.md b/windows.media.core/timedtextstyle_isbackgroundalwaysshown.md index 3cd6693231..c474177af6 100644 --- a/windows.media.core/timedtextstyle_isbackgroundalwaysshown.md +++ b/windows.media.core/timedtextstyle_isbackgroundalwaysshown.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.IsBackgroundAlwaysShown --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.IsBackgroundAlwaysShown ## -description Gets or sets a value indicating if the background color stays visible when no text is being displayed. ## -property-value A value indicating if the background color stays visible when no text is being displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.IsBackgroundAlwaysShown +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.IsBackgroundAlwaysShown + +## -description +Gets or sets a value indicating if the background color stays visible when no text is being displayed. + +## -property-value +A value indicating if the background color stays visible when no text is being displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_linealignment.md b/windows.media.core/timedtextstyle_linealignment.md index 7b41b1bf6e..cc5abf66d0 100644 --- a/windows.media.core/timedtextstyle_linealignment.md +++ b/windows.media.core/timedtextstyle_linealignment.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.LineAlignment --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.LineAlignment ## -description Gets or sets the alignment of timed text lines. ## -property-value The alignment of timed text lines. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.LineAlignment +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.LineAlignment + +## -description +Gets or sets the alignment of timed text lines. + +## -property-value +The alignment of timed text lines. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_name.md b/windows.media.core/timedtextstyle_name.md index a76f440380..10a910a724 100644 --- a/windows.media.core/timedtextstyle_name.md +++ b/windows.media.core/timedtextstyle_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.Name --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.Name ## -description Gets or sets the name of the timed text style. ## -property-value The name of the timed text style. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.Name + +## -description +Gets or sets the name of the timed text style. + +## -property-value +The name of the timed text style. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_outlinecolor.md b/windows.media.core/timedtextstyle_outlinecolor.md index 5d6955177e..d6a7241a0e 100644 --- a/windows.media.core/timedtextstyle_outlinecolor.md +++ b/windows.media.core/timedtextstyle_outlinecolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.OutlineColor --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.OutlineColor ## -description Gets or sets the outline color of timed text. ## -property-value The outline color of timed text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.OutlineColor +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.OutlineColor + +## -description +Gets or sets the outline color of timed text. + +## -property-value +The outline color of timed text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_outlineradius.md b/windows.media.core/timedtextstyle_outlineradius.md index d486d1df77..ba7ad58b3f 100644 --- a/windows.media.core/timedtextstyle_outlineradius.md +++ b/windows.media.core/timedtextstyle_outlineradius.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.OutlineRadius --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.OutlineRadius ## -description Gets or sets the radius of the blur applied to outline of the timed text. ## -property-value The radius of the blur applied to outline of the timed text. ## -remarks A value of zero results in no blurring of the text outline. Set the thickness of the outline with [OutlineThickness](timedtextstyle_outlinethickness.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.OutlineRadius +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.OutlineRadius + +## -description +Gets or sets the radius of the blur applied to outline of the timed text. + +## -property-value +The radius of the blur applied to outline of the timed text. + +## -remarks +A value of zero results in no blurring of the text outline. Set the thickness of the outline with [OutlineThickness](timedtextstyle_outlinethickness.md). + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_outlinethickness.md b/windows.media.core/timedtextstyle_outlinethickness.md index ab26d53c5e..528ac3701a 100644 --- a/windows.media.core/timedtextstyle_outlinethickness.md +++ b/windows.media.core/timedtextstyle_outlinethickness.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextStyle.OutlineThickness --api-type: winrt property ---- # Windows.Media.Core.TimedTextStyle.OutlineThickness ## -description Gets or sets the thickness of the outline of the timed text. ## -property-value The thickness of the outline of the timed text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.OutlineThickness +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.OutlineThickness + +## -description +Gets or sets the thickness of the outline of the timed text. + +## -property-value +The thickness of the outline of the timed text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextstyle_timedtextstyle_1221375020.md b/windows.media.core/timedtextstyle_timedtextstyle_1221375020.md index 64683254b1..9f9b221489 100644 --- a/windows.media.core/timedtextstyle_timedtextstyle_1221375020.md +++ b/windows.media.core/timedtextstyle_timedtextstyle_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.TimedTextStyle.#ctor --api-type: winrt method ---- # Windows.Media.Core.TimedTextStyle.TimedTextStyle ## -description Initializes a new instance of the [TimedTextStyle](timedtextstyle.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextStyle.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextStyle.TimedTextStyle + +## -description +Initializes a new instance of the [TimedTextStyle](timedtextstyle.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextsubformat.md b/windows.media.core/timedtextsubformat.md index eb1c517019..0fe92ce03e 100644 --- a/windows.media.core/timedtextsubformat.md +++ b/windows.media.core/timedtextsubformat.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.TimedTextSubformat --api-type: winrt class ---- # Windows.Media.Core.TimedTextSubformat ## -description Defines a [TimedTextStyle](timedtextstyle.md) for a substring in a [TimedTextLine](timedtextline.md). of the cue, which defines the style of the rendered text. ## -remarks ## -examples ## -see-also [ITimedTextSubformat](itimedtextsubformat.md), [TimedTextLine](timedtextline.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.TimedTextSubformat +-api-type: winrt class +--- + + + +# Windows.Media.Core.TimedTextSubformat + +## -description +Defines a [TimedTextStyle](timedtextstyle.md) for a substring in a [TimedTextLine](timedtextline.md). of the cue, which defines the style of the rendered text. + +## -remarks + +## -examples + +## -see-also +[ITimedTextSubformat](itimedtextsubformat.md), [TimedTextLine](timedtextline.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsubformat_length.md b/windows.media.core/timedtextsubformat_length.md index e1dabeaf5b..33985fa1fc 100644 --- a/windows.media.core/timedtextsubformat_length.md +++ b/windows.media.core/timedtextsubformat_length.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextSubformat.Length --api-type: winrt property ---- # Windows.Media.Core.TimedTextSubformat.Length ## -description Gets or sets the length of the substring to which the [SubformatStyle](timedtextsubformat_subformatstyle.md) applies. ## -property-value The length of the substring to which the formatting style applies. ## -remarks ## -examples ## -see-also [SubformatStyle](timedtextsubformat_subformatstyle.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextSubformat.Length +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextSubformat.Length + +## -description +Gets or sets the length of the substring to which the [SubformatStyle](timedtextsubformat_subformatstyle.md) applies. + +## -property-value +The length of the substring to which the formatting style applies. + +## -remarks + +## -examples + +## -see-also +[SubformatStyle](timedtextsubformat_subformatstyle.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsubformat_startindex.md b/windows.media.core/timedtextsubformat_startindex.md index 44465f6934..a7714a5c68 100644 --- a/windows.media.core/timedtextsubformat_startindex.md +++ b/windows.media.core/timedtextsubformat_startindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.TimedTextSubformat.StartIndex --api-type: winrt property ---- # Windows.Media.Core.TimedTextSubformat.StartIndex ## -description Gets or sets the staring index of the substring to which the [SubformatStyle](timedtextsubformat_subformatstyle.md) applies. ## -property-value The starting index of the substring to which the formatting style applies. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextSubformat.StartIndex +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextSubformat.StartIndex + +## -description +Gets or sets the staring index of the substring to which the [SubformatStyle](timedtextsubformat_subformatstyle.md) applies. + +## -property-value +The starting index of the substring to which the formatting style applies. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/timedtextsubformat_subformatstyle.md b/windows.media.core/timedtextsubformat_subformatstyle.md index 2d75515d3a..c4c782e090 100644 --- a/windows.media.core/timedtextsubformat_subformatstyle.md +++ b/windows.media.core/timedtextsubformat_subformatstyle.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.TimedTextSubformat.SubformatStyle --api-type: winrt property ---- # Windows.Media.Core.TimedTextSubformat.SubformatStyle ## -description Gets or sets the [TimedTextStyle](timedtextstyle.md) object that conveys the formatting of a substring in a [TimedTextLine](timedtextline.md). ## -property-value The object that conveys the formatting of a substring in a [TimedTextLine](timedtextline.md). ## -remarks ## -examples ## -see-also [TimedTextStyle](timedtextstyle.md), [TimedTextLine](timedtextline.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.TimedTextSubformat.SubformatStyle +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextSubformat.SubformatStyle + +## -description +Gets or sets the [TimedTextStyle](timedtextstyle.md) object that conveys the formatting of a substring in a [TimedTextLine](timedtextline.md). + +## -property-value +The object that conveys the formatting of a substring in a [TimedTextLine](timedtextline.md). + +## -remarks + +## -examples + +## -see-also +[TimedTextStyle](timedtextstyle.md), [TimedTextLine](timedtextline.md) \ No newline at end of file diff --git a/windows.media.core/timedtextsubformat_timedtextsubformat_1221375020.md b/windows.media.core/timedtextsubformat_timedtextsubformat_1221375020.md index f21ddfd619..6a82ca675e 100644 --- a/windows.media.core/timedtextsubformat_timedtextsubformat_1221375020.md +++ b/windows.media.core/timedtextsubformat_timedtextsubformat_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.TimedTextSubformat.#ctor --api-type: winrt method ---- # Windows.Media.Core.TimedTextSubformat.TimedTextSubformat ## -description Initializes a new instance of the [TimedTextSubformat](timedtextsubformat.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.TimedTextSubformat.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSubformat.TimedTextSubformat + +## -description +Initializes a new instance of the [TimedTextSubformat](timedtextsubformat.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffect.md b/windows.media.core/videostabilizationeffect.md index 61a9bbfba9..b8c22c0c62 100644 --- a/windows.media.core/videostabilizationeffect.md +++ b/windows.media.core/videostabilizationeffect.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.VideoStabilizationEffect --api-type: winrt class ---- # Windows.Media.Core.VideoStabilizationEffect ## -description Represents an effect that stabilizes a video stream. ## -remarks Get an instance of this class by passing a [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) object into [MediaCapture.AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md) or [MediaTranscoder.AddVideoEffect](../windows.media.transcoding/mediatranscoder_addvideoeffect.md). For how-to guidance for using the **VideoStabilizationEffect**, see [Effects for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/effects-for-video-capture). ## -examples ## -see-also [IMediaExtension](../windows.media/imediaextension.md), [Effects for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/effects-for-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoStabilizationEffect +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoStabilizationEffect + +## -description +Represents an effect that stabilizes a video stream. + +## -remarks +Get an instance of this class by passing a [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) object into [MediaCapture.AddVideoEffectAsync](../windows.media.capture/mediacapture_addvideoeffectasync.md) or [MediaTranscoder.AddVideoEffect](../windows.media.transcoding/mediatranscoder_addvideoeffect.md). + +For how-to guidance for using the **VideoStabilizationEffect**, see [Effects for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/effects-for-video-capture). + +## -examples + +## -see-also +[IMediaExtension](../windows.media/imediaextension.md), [Effects for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/effects-for-video-capture) \ No newline at end of file diff --git a/windows.media.core/videostabilizationeffect_enabled.md b/windows.media.core/videostabilizationeffect_enabled.md index 583d5be83c..df5b5a8d19 100644 --- a/windows.media.core/videostabilizationeffect_enabled.md +++ b/windows.media.core/videostabilizationeffect_enabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoStabilizationEffect.Enabled --api-type: winrt property ---- # Windows.Media.Core.VideoStabilizationEffect.Enabled ## -description Gets or sets a value indicating whether video stabilization is enabled. ## -property-value True if video stabilization is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStabilizationEffect.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStabilizationEffect.Enabled + +## -description +Gets or sets a value indicating whether video stabilization is enabled. + +## -property-value +True if video stabilization is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffect_enabledchanged.md b/windows.media.core/videostabilizationeffect_enabledchanged.md index 7ad0697a5e..19731720f4 100644 --- a/windows.media.core/videostabilizationeffect_enabledchanged.md +++ b/windows.media.core/videostabilizationeffect_enabledchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Core.VideoStabilizationEffect.EnabledChanged --api-type: winrt event ---- # Windows.Media.Core.VideoStabilizationEffect.EnabledChanged ## -description Occurs when the value of the [VideoStabilizationEffect::Enabled](videostabilizationeffect_enabled.md) property changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.VideoStabilizationEffect.EnabledChanged +-api-type: winrt event +--- + + + +# Windows.Media.Core.VideoStabilizationEffect.EnabledChanged + +## -description +Occurs when the value of the [VideoStabilizationEffect::Enabled](videostabilizationeffect_enabled.md) property changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffect_getrecommendedstreamconfiguration_282764984.md b/windows.media.core/videostabilizationeffect_getrecommendedstreamconfiguration_282764984.md index e9b95a7d80..06801a45b3 100644 --- a/windows.media.core/videostabilizationeffect_getrecommendedstreamconfiguration_282764984.md +++ b/windows.media.core/videostabilizationeffect_getrecommendedstreamconfiguration_282764984.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Core.VideoStabilizationEffect.GetRecommendedStreamConfiguration(Windows.Media.Devices.VideoDeviceController,Windows.Media.MediaProperties.VideoEncodingProperties) --api-type: winrt method ---- # Windows.Media.Core.VideoStabilizationEffect.GetRecommendedStreamConfiguration ## -description Gets the recommended video stream configuration for video stabilization, given the specified video device controller and encoding properties. ## -parameters ### -param controller The video device controller. ### -param desiredProperties The encoding properties. ## -returns An object representing the optimal video stream configuration for video stabilization. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.VideoStabilizationEffect.GetRecommendedStreamConfiguration(Windows.Media.Devices.VideoDeviceController,Windows.Media.MediaProperties.VideoEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Core.VideoStabilizationEffect.GetRecommendedStreamConfiguration + +## -description +Gets the recommended video stream configuration for video stabilization, given the specified video device controller and encoding properties. + +## -parameters +### -param controller +The video device controller. + +### -param desiredProperties +The encoding properties. + +## -returns +An object representing the optimal video stream configuration for video stabilization. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffect_setproperties_518979560.md b/windows.media.core/videostabilizationeffect_setproperties_518979560.md index e0fa97ed37..ddd99c5f64 100644 --- a/windows.media.core/videostabilizationeffect_setproperties_518979560.md +++ b/windows.media.core/videostabilizationeffect_setproperties_518979560.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Core.VideoStabilizationEffect.SetProperties(Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Core.VideoStabilizationEffect.SetProperties ## -description Sets properties on the [IMediaExtension](../windows.media/imediaextension.md). ## -parameters ### -param configuration The property set. ## -remarks This method is inherited from the [IMediaExtension](../windows.media/imediaextension.md) interface and is not intended to be used from your code. Instead, set the properties of the [VideoStabilizationEffect](videostabilizationeffect.md) directly. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.VideoStabilizationEffect.SetProperties(Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Core.VideoStabilizationEffect.SetProperties + +## -description +Sets properties on the [IMediaExtension](../windows.media/imediaextension.md). + +## -parameters +### -param configuration +The property set. + +## -remarks +This method is inherited from the [IMediaExtension](../windows.media/imediaextension.md) interface and is not intended to be used from your code. Instead, set the properties of the [VideoStabilizationEffect](videostabilizationeffect.md) directly. + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffectdefinition.md b/windows.media.core/videostabilizationeffectdefinition.md index b476de4825..6240c4200a 100644 --- a/windows.media.core/videostabilizationeffectdefinition.md +++ b/windows.media.core/videostabilizationeffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.VideoStabilizationEffectDefinition --api-type: winrt class ---- # Windows.Media.Core.VideoStabilizationEffectDefinition ## -description Represents the definition of a video stabilization effect. ## -remarks ## -examples ## -see-also [IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoStabilizationEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoStabilizationEffectDefinition + +## -description +Represents the definition of a video stabilization effect. + +## -remarks + +## -examples + +## -see-also +[IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.core/videostabilizationeffectdefinition_activatableclassid.md b/windows.media.core/videostabilizationeffectdefinition_activatableclassid.md index eed3d0f2cf..a95e5a15dd 100644 --- a/windows.media.core/videostabilizationeffectdefinition_activatableclassid.md +++ b/windows.media.core/videostabilizationeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoStabilizationEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Core.VideoStabilizationEffectDefinition.ActivatableClassId ## -description Gets a string containing the activatable class ID of the video stabilization effect definition. ## -property-value The activatable class ID of the video stabilization detection effect definition ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStabilizationEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStabilizationEffectDefinition.ActivatableClassId + +## -description +Gets a string containing the activatable class ID of the video stabilization effect definition. + +## -property-value +The activatable class ID of the video stabilization detection effect definition + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffectdefinition_properties.md b/windows.media.core/videostabilizationeffectdefinition_properties.md index 60d3a11bea..a9d683808a 100644 --- a/windows.media.core/videostabilizationeffectdefinition_properties.md +++ b/windows.media.core/videostabilizationeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoStabilizationEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Core.VideoStabilizationEffectDefinition.Properties ## -description Gets the set of properties for configuring the [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) object. ## -property-value The set of properties for configuring the [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStabilizationEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStabilizationEffectDefinition.Properties + +## -description +Gets the set of properties for configuring the [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) object. + +## -property-value +The set of properties for configuring the [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffectdefinition_videostabilizationeffectdefinition_1221375020.md b/windows.media.core/videostabilizationeffectdefinition_videostabilizationeffectdefinition_1221375020.md index c304a5ea89..d0f07ec819 100644 --- a/windows.media.core/videostabilizationeffectdefinition_videostabilizationeffectdefinition_1221375020.md +++ b/windows.media.core/videostabilizationeffectdefinition_videostabilizationeffectdefinition_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Core.VideoStabilizationEffectDefinition.#ctor --api-type: winrt method ---- # Windows.Media.Core.VideoStabilizationEffectDefinition.VideoStabilizationEffectDefinition ## -description Initializes a new instance of the [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.VideoStabilizationEffectDefinition.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.VideoStabilizationEffectDefinition.VideoStabilizationEffectDefinition + +## -description +Initializes a new instance of the [VideoStabilizationEffectDefinition](videostabilizationeffectdefinition.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostabilizationeffectenabledchangedeventargs.md b/windows.media.core/videostabilizationeffectenabledchangedeventargs.md index f4663b322e..1204a700e9 100644 --- a/windows.media.core/videostabilizationeffectenabledchangedeventargs.md +++ b/windows.media.core/videostabilizationeffectenabledchangedeventargs.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs --api-type: winrt class ---- # Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs ## -description Provides data for the [VideoStabilizationEffect.EnabledChanged](videostabilizationeffect_enabledchanged.md) event. ## -remarks Get an instance of this by handling the [VideoStabilizationEffect.EnabledChanged](videostabilizationeffect_enabledchanged.md) event. ## -examples ## -see-also [VideoStabilizationEffect.EnabledChanged](videostabilizationeffect_enabledchanged.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs + +## -description +Provides data for the [VideoStabilizationEffect.EnabledChanged](videostabilizationeffect_enabledchanged.md) event. + +## -remarks +Get an instance of this by handling the [VideoStabilizationEffect.EnabledChanged](videostabilizationeffect_enabledchanged.md) event. + +## -examples + +## -see-also +[VideoStabilizationEffect.EnabledChanged](videostabilizationeffect_enabledchanged.md) \ No newline at end of file diff --git a/windows.media.core/videostabilizationeffectenabledchangedeventargs_reason.md b/windows.media.core/videostabilizationeffectenabledchangedeventargs_reason.md index 033cbdba5d..b3927147a5 100644 --- a/windows.media.core/videostabilizationeffectenabledchangedeventargs_reason.md +++ b/windows.media.core/videostabilizationeffectenabledchangedeventargs_reason.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs.Reason --api-type: winrt property ---- # Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs.Reason ## -description Gets a value indicating the reason why the [VideoStabilizationEffect::Enabled](videostabilizationeffect_enabled.md) property changed. ## -property-value A value indicating the reason why the [VideoStabilizationEffect::Enabled](videostabilizationeffect_enabled.md) property changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStabilizationEffectEnabledChangedEventArgs.Reason + +## -description +Gets a value indicating the reason why the [VideoStabilizationEffect::Enabled](videostabilizationeffect_enabled.md) property changed. + +## -property-value +A value indicating the reason why the [VideoStabilizationEffect::Enabled](videostabilizationeffect_enabled.md) property changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videostreamdescriptor.md b/windows.media.core/videostreamdescriptor.md index ceffcf9880..ce6616d8d1 100644 --- a/windows.media.core/videostreamdescriptor.md +++ b/windows.media.core/videostreamdescriptor.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Core.VideoStreamDescriptor --api-type: winrt class ---- # Windows.Media.Core.VideoStreamDescriptor ## -description Defines an video media stream. ## -remarks See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. ## -examples ## -see-also [IMediaStreamDescriptor](imediastreamdescriptor.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoStreamDescriptor +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoStreamDescriptor + +## -description +Defines an video media stream. + +## -remarks +See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) for an example of using Media Stream Source in a Windows Store app. + +## -examples + +## -see-also +[IMediaStreamDescriptor](imediastreamdescriptor.md), [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) \ No newline at end of file diff --git a/windows.media.core/videostreamdescriptor_encodingproperties.md b/windows.media.core/videostreamdescriptor_encodingproperties.md index 14f52e4f72..ee4bb0441e 100644 --- a/windows.media.core/videostreamdescriptor_encodingproperties.md +++ b/windows.media.core/videostreamdescriptor_encodingproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.VideoStreamDescriptor.EncodingProperties --api-type: winrt property ---- # Windows.Media.Core.VideoStreamDescriptor.EncodingProperties ## -description Gets the encoding properties on the video stream. ## -property-value The encoding properties on the video stream. ## -remarks If the media pipeline cannot handle the new encoding properties, the [MediaStreamSource](mediastreamsource.md) will raise the [Closed](mediastreamsource_closed.md) event which provides information regarding the error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStreamDescriptor.EncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStreamDescriptor.EncodingProperties + +## -description +Gets the encoding properties on the video stream. + +## -property-value +The encoding properties on the video stream. + +## -remarks +If the media pipeline cannot handle the new encoding properties, the [MediaStreamSource](mediastreamsource.md) will raise the [Closed](mediastreamsource_closed.md) event which provides information regarding the error. + +## -examples + +## -see-also diff --git a/windows.media.core/videostreamdescriptor_isselected.md b/windows.media.core/videostreamdescriptor_isselected.md index a4930adfe8..39ad5b3abd 100644 --- a/windows.media.core/videostreamdescriptor_isselected.md +++ b/windows.media.core/videostreamdescriptor_isselected.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.VideoStreamDescriptor.IsSelected --api-type: winrt property ---- # Windows.Media.Core.VideoStreamDescriptor.IsSelected ## -description Specifies whether the stream is currently in use by the [MediaStreamSource](mediastreamsource.md). ## -property-value **true** if the stream is currently in use by the [MediaStreamSource](mediastreamsource.md); otherwise, **false**. ## -remarks [IsSelected](videostreamdescriptor_isselected.md) is **true** if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the [MediaStreamSource](mediastreamsource.md). Otherwise, the value is **false**. The [MediaStreamSource](mediastreamsource.md) only raises the [SampleRequested](mediastreamsource_samplerequested.md) event for streams which are selected. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStreamDescriptor.IsSelected +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStreamDescriptor.IsSelected + +## -description +Specifies whether the stream is currently in use by the [MediaStreamSource](mediastreamsource.md). + +## -property-value +**true** if the stream is currently in use by the [MediaStreamSource](mediastreamsource.md); otherwise, **false**. + +## -remarks +[IsSelected](videostreamdescriptor_isselected.md) is **true** if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the [MediaStreamSource](mediastreamsource.md). Otherwise, the value is **false**. + +The [MediaStreamSource](mediastreamsource.md) only raises the [SampleRequested](mediastreamsource_samplerequested.md) event for streams which are selected. + +## -examples + +## -see-also diff --git a/windows.media.core/videostreamdescriptor_language.md b/windows.media.core/videostreamdescriptor_language.md index 0e0fb326c5..71d78d7582 100644 --- a/windows.media.core/videostreamdescriptor_language.md +++ b/windows.media.core/videostreamdescriptor_language.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.VideoStreamDescriptor.Language --api-type: winrt property ---- # Windows.Media.Core.VideoStreamDescriptor.Language ## -description Gets or sets the RFC-1766 language code for the stream. ## -property-value The RFC-1766 language code for the stream. ## -remarks The initial value is an empty string. The language is specified using a RFC-1766 language code, for example, “en-US”. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStreamDescriptor.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStreamDescriptor.Language + +## -description +Gets or sets the RFC-1766 language code for the stream. + +## -property-value +The RFC-1766 language code for the stream. + +## -remarks +The initial value is an empty string. + +The language is specified using a RFC-1766 language code, for example, “en-US”. + +## -examples + +## -see-also diff --git a/windows.media.core/videostreamdescriptor_name.md b/windows.media.core/videostreamdescriptor_name.md index 184669681e..7dc430bf38 100644 --- a/windows.media.core/videostreamdescriptor_name.md +++ b/windows.media.core/videostreamdescriptor_name.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Core.VideoStreamDescriptor.Name --api-type: winrt property ---- # Windows.Media.Core.VideoStreamDescriptor.Name ## -description Gets or sets the name of the stream. ## -property-value The name of the stream. ## -remarks The initial value is an empty string. The name is a free-form human readable string that describes the stream, for example, “English soundtrack”. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoStreamDescriptor.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStreamDescriptor.Name + +## -description +Gets or sets the name of the stream. + +## -property-value +The name of the stream. + +## -remarks +The initial value is an empty string. + +The name is a free-form human readable string that describes the stream, for example, “English soundtrack”. + +## -examples + +## -see-also diff --git a/windows.media.core/videostreamdescriptor_videostreamdescriptor_1148948100.md b/windows.media.core/videostreamdescriptor_videostreamdescriptor_1148948100.md index 734c141b7c..8788e4688f 100644 --- a/windows.media.core/videostreamdescriptor_videostreamdescriptor_1148948100.md +++ b/windows.media.core/videostreamdescriptor_videostreamdescriptor_1148948100.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Core.VideoStreamDescriptor.#ctor(Windows.Media.MediaProperties.VideoEncodingProperties) --api-type: winrt method ---- # Windows.Media.Core.VideoStreamDescriptor.VideoStreamDescriptor ## -description Creates an instance of the [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) class using the specified video encoding. ## -parameters ### -param encodingProperties The encoding properties for the video stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.VideoStreamDescriptor.#ctor(Windows.Media.MediaProperties.VideoEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Core.VideoStreamDescriptor.VideoStreamDescriptor + +## -description +Creates an instance of the [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) class using the specified video encoding. + +## -parameters +### -param encodingProperties +The encoding properties for the video stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack.md b/windows.media.core/videotrack.md index 53ec695695..04d8e20433 100644 --- a/windows.media.core/videotrack.md +++ b/windows.media.core/videotrack.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Core.VideoTrack --api-type: winrt class ---- # Windows.Media.Core.VideoTrack ## -description Represents a video track. ## -remarks Get an instance of this class by calling [MediaPlaybackVideoTrackList.GetAt](../windows.media.playback/mediaplaybackvideotracklist_getat.md). For how-to guidance for working with **VideoTrack** objects, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [IMediaTrack](imediatrack.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoTrack +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoTrack + +## -description +Represents a video track. + +## -remarks +Get an instance of this class by calling [MediaPlaybackVideoTrackList.GetAt](../windows.media.playback/mediaplaybackvideotracklist_getat.md). + +For how-to guidance for working with **VideoTrack** objects, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[IMediaTrack](imediatrack.md) \ No newline at end of file diff --git a/windows.media.core/videotrack_getencodingproperties_1326279402.md b/windows.media.core/videotrack_getencodingproperties_1326279402.md index 662c5aa9a9..c9eb5f5667 100644 --- a/windows.media.core/videotrack_getencodingproperties_1326279402.md +++ b/windows.media.core/videotrack_getencodingproperties_1326279402.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Core.VideoTrack.GetEncodingProperties --api-type: winrt method ---- # Windows.Media.Core.VideoTrack.GetEncodingProperties ## -description Gets the encoding properties for the [VideoTrack](videotrack.md). ## -returns The encoding properties for the [VideoTrack](videotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Core.VideoTrack.GetEncodingProperties +-api-type: winrt method +--- + + + +# Windows.Media.Core.VideoTrack.GetEncodingProperties + +## -description +Gets the encoding properties for the [VideoTrack](videotrack.md). + +## -returns +The encoding properties for the [VideoTrack](videotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_id.md b/windows.media.core/videotrack_id.md index 06cac97c47..597e214b0d 100644 --- a/windows.media.core/videotrack_id.md +++ b/windows.media.core/videotrack_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.Id --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.Id ## -description Gets or sets the identifier for the video track. ## -property-value The identifier for the video track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.Id + +## -description +Gets or sets the identifier for the video track. + +## -property-value +The identifier for the video track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_label.md b/windows.media.core/videotrack_label.md index f2bfe59f51..4acdd3937a 100644 --- a/windows.media.core/videotrack_label.md +++ b/windows.media.core/videotrack_label.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.Label --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.Label ## -description Gets or sets the label for the video track. ## -property-value The label for the video track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.Label + +## -description +Gets or sets the label for the video track. + +## -property-value +The label for the video track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_language.md b/windows.media.core/videotrack_language.md index 0ee92e1785..a7abb88dc7 100644 --- a/windows.media.core/videotrack_language.md +++ b/windows.media.core/videotrack_language.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.Language --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.Language ## -description Gets or sets a string indicating the language of the video track. ## -property-value A string indicating the language of the video track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.Language +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.Language + +## -description +Gets or sets a string indicating the language of the video track. + +## -property-value +A string indicating the language of the video track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_name.md b/windows.media.core/videotrack_name.md index 8120117e6b..e7abeb7d45 100644 --- a/windows.media.core/videotrack_name.md +++ b/windows.media.core/videotrack_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.Name --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.Name ## -description Gets the name of the [VideoTrack](videotrack.md). ## -property-value The name of the [VideoTrack](videotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.Name +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.Name + +## -description +Gets the name of the [VideoTrack](videotrack.md). + +## -property-value +The name of the [VideoTrack](videotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_openfailed.md b/windows.media.core/videotrack_openfailed.md index d5183cdd24..5de4b6f296 100644 --- a/windows.media.core/videotrack_openfailed.md +++ b/windows.media.core/videotrack_openfailed.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Core.VideoTrack.OpenFailed --api-type: winrt event ---- # Windows.Media.Core.VideoTrack.OpenFailed ## -description Occurs when a [VideoTrack](videotrack.md) fails to open. ## -remarks Register for the **OpenFailed** event for a [VideoTrack](videotrack.md) from within the [VideoTracksChanged](../windows.media.playback/mediaplaybackitem_videotrackschanged.md) event handler for a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md), which is raised whenever a video track is added to the item. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Core.VideoTrack.OpenFailed +-api-type: winrt event +--- + + + +# Windows.Media.Core.VideoTrack.OpenFailed + +## -description +Occurs when a [VideoTrack](videotrack.md) fails to open. + +## -remarks +Register for the **OpenFailed** event for a [VideoTrack](videotrack.md) from within the [VideoTracksChanged](../windows.media.playback/mediaplaybackitem_videotrackschanged.md) event handler for a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md), which is raised whenever a video track is added to the item. + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_playbackitem.md b/windows.media.core/videotrack_playbackitem.md index ffb48bee76..97f240164e 100644 --- a/windows.media.core/videotrack_playbackitem.md +++ b/windows.media.core/videotrack_playbackitem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.PlaybackItem --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.PlaybackItem ## -description Gets the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [VideoTrack](videotrack.md). ## -property-value The [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [VideoTrack](videotrack.md). ## -remarks A [VideoTrack](videotrack.md) is contained by a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) when it is in the item's [VideoTracks](../windows.media.playback/mediaplaybackitem_videotracks.md) collection. Use the **PlaybackItem** property to get a reference to the **MediaPlaybackItem** that contains the **VideoTrack**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.PlaybackItem +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.PlaybackItem + +## -description +Gets the [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [VideoTrack](videotrack.md). + +## -property-value +The [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) containing the [VideoTrack](videotrack.md). + +## -remarks +A [VideoTrack](videotrack.md) is contained by a [MediaPlaybackItem](../windows.media.playback/mediaplaybackitem.md) when it is in the item's [VideoTracks](../windows.media.playback/mediaplaybackitem_videotracks.md) collection. Use the **PlaybackItem** property to get a reference to the **MediaPlaybackItem** that contains the **VideoTrack**. + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_supportinfo.md b/windows.media.core/videotrack_supportinfo.md index d3c3ade433..63b0ec2acb 100644 --- a/windows.media.core/videotrack_supportinfo.md +++ b/windows.media.core/videotrack_supportinfo.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.SupportInfo --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.SupportInfo ## -description Gets support information for the [VideoTrack](videotrack.md). This information includes the status of the video decoder, information about any audio degradation applied by the decoder, and the status of the [MediaSource](mediasource.md) with which the video track is associated. ## -property-value The support information for the [VideoTrack](videotrack.md). ## -remarks If a failure occurs when a [VideoTrack](videotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](videotrack_openfailed.md) event and checking the **SupportInfo** property of the **VideoTrack** passed into the event as the sender. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.SupportInfo +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.SupportInfo + +## -description +Gets support information for the [VideoTrack](videotrack.md). This information includes the status of the video decoder, information about any audio degradation applied by the decoder, and the status of the [MediaSource](mediasource.md) with which the video track is associated. + +## -property-value +The support information for the [VideoTrack](videotrack.md). + +## -remarks +If a failure occurs when a [VideoTrack](videotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](videotrack_openfailed.md) event and checking the **SupportInfo** property of the **VideoTrack** passed into the event as the sender. + +## -examples + +## -see-also diff --git a/windows.media.core/videotrack_trackkind.md b/windows.media.core/videotrack_trackkind.md index 722a358943..b66ad14af4 100644 --- a/windows.media.core/videotrack_trackkind.md +++ b/windows.media.core/videotrack_trackkind.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrack.TrackKind --api-type: winrt property ---- # Windows.Media.Core.VideoTrack.TrackKind ## -description Gets a value indicating the type of data the track contains. For [VideoTrack](videotrack.md) objects, this value is always [MediaTrackKind::Video](mediatrackkind.md). ## -property-value A value indicating the type of data the track contains. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrack.TrackKind +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrack.TrackKind + +## -description +Gets a value indicating the type of data the track contains. For [VideoTrack](videotrack.md) objects, this value is always [MediaTrackKind::Video](mediatrackkind.md). + +## -property-value +A value indicating the type of data the track contains. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotrackopenfailedeventargs.md b/windows.media.core/videotrackopenfailedeventargs.md index 266864327a..28d8d62c59 100644 --- a/windows.media.core/videotrackopenfailedeventargs.md +++ b/windows.media.core/videotrackopenfailedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.VideoTrackOpenFailedEventArgs --api-type: winrt class ---- # Windows.Media.Core.VideoTrackOpenFailedEventArgs ## -description Provides data for the [OpenFailed](videotrack_openfailed.md) event of a [VideoTrack](videotrack.md). ## -remarks Get an instance of this class by handling the [OpenFailed](videotrack_openfailed.md) event of a [VideoTrack](videotrack.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoTrackOpenFailedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoTrackOpenFailedEventArgs + +## -description +Provides data for the [OpenFailed](videotrack_openfailed.md) event of a [VideoTrack](videotrack.md). + +## -remarks +Get an instance of this class by handling the [OpenFailed](videotrack_openfailed.md) event of a [VideoTrack](videotrack.md). + +## -examples + +## -see-also diff --git a/windows.media.core/videotrackopenfailedeventargs_extendederror.md b/windows.media.core/videotrackopenfailedeventargs_extendederror.md index 7f9156e50a..75e1b42c55 100644 --- a/windows.media.core/videotrackopenfailedeventargs_extendederror.md +++ b/windows.media.core/videotrackopenfailedeventargs_extendederror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrackOpenFailedEventArgs.ExtendedError --api-type: winrt property ---- # Windows.Media.Core.VideoTrackOpenFailedEventArgs.ExtendedError ## -description Gets the extended error code for an error that occurs when opening a [VideoTrack](videotrack.md). ## -property-value The extended error code for an error that occurs when opening a [VideoTrack](videotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrackOpenFailedEventArgs.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrackOpenFailedEventArgs.ExtendedError + +## -description +Gets the extended error code for an error that occurs when opening a [VideoTrack](videotrack.md). + +## -property-value +The extended error code for an error that occurs when opening a [VideoTrack](videotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotracksupportinfo.md b/windows.media.core/videotracksupportinfo.md index dcfcf8182d..392fa7d100 100644 --- a/windows.media.core/videotracksupportinfo.md +++ b/windows.media.core/videotracksupportinfo.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Core.VideoTrackSupportInfo --api-type: winrt class ---- # Windows.Media.Core.VideoTrackSupportInfo ## -description Provides support information for a [VideoTrack](videotrack.md). This information includes the status of the video decoder and the status of the [MediaSource](mediasource.md) with which the video track is associated. ## -remarks If a failure occurs when a [VideoTrack](videotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](videotrack_openfailed.md) event and checking the [SupportInfo](videotrack_supportinfo.md) property of the **VideoTrack** passed into the event as the sender. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Core.VideoTrackSupportInfo +-api-type: winrt class +--- + + + +# Windows.Media.Core.VideoTrackSupportInfo + +## -description +Provides support information for a [VideoTrack](videotrack.md). This information includes the status of the video decoder and the status of the [MediaSource](mediasource.md) with which the video track is associated. + +## -remarks +If a failure occurs when a [VideoTrack](videotrack.md) is opened, you can get detailed status and failure information by handling the [OpenFailed](videotrack_openfailed.md) event and checking the [SupportInfo](videotrack_supportinfo.md) property of the **VideoTrack** passed into the event as the sender. + +## -examples + +## -see-also diff --git a/windows.media.core/videotracksupportinfo_decoderstatus.md b/windows.media.core/videotracksupportinfo_decoderstatus.md index 5c1669e819..d06535142a 100644 --- a/windows.media.core/videotracksupportinfo_decoderstatus.md +++ b/windows.media.core/videotracksupportinfo_decoderstatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrackSupportInfo.DecoderStatus --api-type: winrt property ---- # Windows.Media.Core.VideoTrackSupportInfo.DecoderStatus ## -description Gets the status of the video decoder that is decoding the [VideoTrack](videotrack.md), including whether the encoding for the video track is fully or partially supported. ## -property-value The status of the audio decoder that is decoding the [VideoTrack](videotrack.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrackSupportInfo.DecoderStatus +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrackSupportInfo.DecoderStatus + +## -description +Gets the status of the video decoder that is decoding the [VideoTrack](videotrack.md), including whether the encoding for the video track is fully or partially supported. + +## -property-value +The status of the audio decoder that is decoding the [VideoTrack](videotrack.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.core/videotracksupportinfo_mediasourcestatus.md b/windows.media.core/videotracksupportinfo_mediasourcestatus.md index be5ac3e072..eb0646cced 100644 --- a/windows.media.core/videotracksupportinfo_mediasourcestatus.md +++ b/windows.media.core/videotracksupportinfo_mediasourcestatus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Core.VideoTrackSupportInfo.MediaSourceStatus --api-type: winrt property ---- # Windows.Media.Core.VideoTrackSupportInfo.MediaSourceStatus ## -description Gets the status of the [MediaSource](mediasource.md) with which the [VideoTrack](videotrack.md) is associated. ## -property-value The status of the [MediaSource](mediasource.md) with which the [VideoTrack](videotrack.md) is associated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Core.VideoTrackSupportInfo.MediaSourceStatus +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoTrackSupportInfo.MediaSourceStatus + +## -description +Gets the status of the [MediaSource](mediasource.md) with which the [VideoTrack](videotrack.md) is associated. + +## -property-value +The status of the [MediaSource](mediasource.md) with which the [VideoTrack](videotrack.md) is associated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics.md b/windows.media.devices.core/cameraintrinsics.md index 765c25de25..2c8cb21ce9 100644 --- a/windows.media.devices.core/cameraintrinsics.md +++ b/windows.media.devices.core/cameraintrinsics.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Devices.Core.CameraIntrinsics --api-type: winrt class ---- # Windows.Media.Devices.Core.CameraIntrinsics ## -description Represents the intrinsics that describe the camera distortion model. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.CameraIntrinsics +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics + +## -description +Represents the intrinsics that describe the camera distortion model. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_distortpoint_18351951.md b/windows.media.devices.core/cameraintrinsics_distortpoint_18351951.md index 93de253593..a089c514bc 100644 --- a/windows.media.devices.core/cameraintrinsics_distortpoint_18351951.md +++ b/windows.media.devices.core/cameraintrinsics_distortpoint_18351951.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.DistortPoint(Windows.Foundation.Point) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.DistortPoint ## -description Applies the distortion model of the camera to an undistorted point so that the resulting point's location is distorted as if it were captured by the camera's lens. ## -parameters ### -param input The point to undestort. ## -returns An undistorted point. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.DistortPoint(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.DistortPoint + +## -description +Applies the distortion model of the camera to an undistorted point so that the resulting point's location is distorted as if it were captured by the camera's lens. + +## -parameters +### -param input +The point to undestort. + +## -returns +An undistorted point. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_distortpoints_88187186.md b/windows.media.devices.core/cameraintrinsics_distortpoints_88187186.md index 9362a2c52c..11e023a0fb 100644 --- a/windows.media.devices.core/cameraintrinsics_distortpoints_88187186.md +++ b/windows.media.devices.core/cameraintrinsics_distortpoints_88187186.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.DistortPoints(Windows.Foundation.Point[],Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.DistortPoints ## -description Applies the distortion model of the camera to an array of undistorted points so that the resulting points' locations are distorted as if they were captured by the camera's lens. ## -parameters ### -param inputs The array of points to undestort. ### -param results An array of undistorted points. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.DistortPoints(Windows.Foundation.Point[],Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.DistortPoints + +## -description +Applies the distortion model of the camera to an array of undistorted points so that the resulting points' locations are distorted as if they were captured by the camera's lens. + +## -parameters +### -param inputs +The array of points to undestort. + +### -param results +An array of undistorted points. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_focallength.md b/windows.media.devices.core/cameraintrinsics_focallength.md index ababab7051..2d31091209 100644 --- a/windows.media.devices.core/cameraintrinsics_focallength.md +++ b/windows.media.devices.core/cameraintrinsics_focallength.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.FocalLength --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.FocalLength ## -description Gets the focal length of the camera. ## -property-value The focal length of the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.FocalLength +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.FocalLength + +## -description +Gets the focal length of the camera. + +## -property-value +The focal length of the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_imageheight.md b/windows.media.devices.core/cameraintrinsics_imageheight.md index 2a7ccaa7a4..9cb64df9a7 100644 --- a/windows.media.devices.core/cameraintrinsics_imageheight.md +++ b/windows.media.devices.core/cameraintrinsics_imageheight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.ImageHeight --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.ImageHeight ## -description Gets the image height of the camera, in pixels. ## -property-value The image height of the camera, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.ImageHeight +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.ImageHeight + +## -description +Gets the image height of the camera, in pixels. + +## -property-value +The image height of the camera, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_imagewidth.md b/windows.media.devices.core/cameraintrinsics_imagewidth.md index 48929caf0e..738bfb0a70 100644 --- a/windows.media.devices.core/cameraintrinsics_imagewidth.md +++ b/windows.media.devices.core/cameraintrinsics_imagewidth.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.ImageWidth --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.ImageWidth ## -description Gets the image width of the camera, in pixels. ## -property-value The image width of the camera, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.ImageWidth +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.ImageWidth + +## -description +Gets the image width of the camera, in pixels. + +## -property-value +The image width of the camera, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_principalpoint.md b/windows.media.devices.core/cameraintrinsics_principalpoint.md index f73c348035..7d55a87315 100644 --- a/windows.media.devices.core/cameraintrinsics_principalpoint.md +++ b/windows.media.devices.core/cameraintrinsics_principalpoint.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.PrincipalPoint --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.PrincipalPoint ## -description Gets the principal point of the camera. ## -property-value The principal point of the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.PrincipalPoint +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.PrincipalPoint + +## -description +Gets the principal point of the camera. + +## -property-value +The principal point of the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_projectmanyontoframe_706628651.md b/windows.media.devices.core/cameraintrinsics_projectmanyontoframe_706628651.md index 099df711b2..585bacafa1 100644 --- a/windows.media.devices.core/cameraintrinsics_projectmanyontoframe_706628651.md +++ b/windows.media.devices.core/cameraintrinsics_projectmanyontoframe_706628651.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.ProjectManyOntoFrame(Windows.Foundation.Numerics.Vector3[],Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.ProjectManyOntoFrame ## -description Projects an array of camera space points into screen space pixel coordinates. ## -parameters ### -param coordinates The array of camera space points to project into screen space. ### -param results The array of screen space pixel coordinates. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.ProjectManyOntoFrame(Windows.Foundation.Numerics.Vector3[],Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.ProjectManyOntoFrame + +## -description +Projects an array of camera space points into screen space pixel coordinates. + +## -parameters +### -param coordinates +The array of camera space points to project into screen space. + +### -param results +The array of screen space pixel coordinates. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_projectontoframe_368534707.md b/windows.media.devices.core/cameraintrinsics_projectontoframe_368534707.md index 6f3a81c6fa..25a5273d26 100644 --- a/windows.media.devices.core/cameraintrinsics_projectontoframe_368534707.md +++ b/windows.media.devices.core/cameraintrinsics_projectontoframe_368534707.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.ProjectOntoFrame(Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.ProjectOntoFrame ## -description Projects a camera space point into screen space pixel coordinates. ## -parameters ### -param coordinate The camera space point to project into screen space. ## -returns The screen space pixel coordinates. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.ProjectOntoFrame(Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.ProjectOntoFrame + +## -description +Projects a camera space point into screen space pixel coordinates. + +## -parameters +### -param coordinate +The camera space point to project into screen space. + +## -returns +The screen space pixel coordinates. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_radialdistortion.md b/windows.media.devices.core/cameraintrinsics_radialdistortion.md index 7ad76f534e..0424b5a55e 100644 --- a/windows.media.devices.core/cameraintrinsics_radialdistortion.md +++ b/windows.media.devices.core/cameraintrinsics_radialdistortion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.RadialDistortion --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.RadialDistortion ## -description Gets the radial distortion coefficient of the camera. ## -property-value The radial distortion coefficient of the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.RadialDistortion +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.RadialDistortion + +## -description +Gets the radial distortion coefficient of the camera. + +## -property-value +The radial distortion coefficient of the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_tangentialdistortion.md b/windows.media.devices.core/cameraintrinsics_tangentialdistortion.md index 6266f630d2..c78366f04e 100644 --- a/windows.media.devices.core/cameraintrinsics_tangentialdistortion.md +++ b/windows.media.devices.core/cameraintrinsics_tangentialdistortion.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.TangentialDistortion --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.TangentialDistortion ## -description Gets the tangential distortion coefficient of the camera. ## -property-value The tangential distortion coefficient of the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.TangentialDistortion +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.TangentialDistortion + +## -description +Gets the tangential distortion coefficient of the camera. + +## -property-value +The tangential distortion coefficient of the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_undistortedprojectiontransform.md b/windows.media.devices.core/cameraintrinsics_undistortedprojectiontransform.md index ed86f86160..72aa5ba911 100644 --- a/windows.media.devices.core/cameraintrinsics_undistortedprojectiontransform.md +++ b/windows.media.devices.core/cameraintrinsics_undistortedprojectiontransform.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.UndistortedProjectionTransform --api-type: winrt property ---- # Windows.Media.Devices.Core.CameraIntrinsics.UndistortedProjectionTransform ## -description Gets a matrix that transforms a point to compensate for the distortion model of the camera, resulting in an undistorted point. ## -property-value A matrix that transforms a point to compensate for the distortion model of the camera. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.CameraIntrinsics.UndistortedProjectionTransform +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.UndistortedProjectionTransform + +## -description +Gets a matrix that transforms a point to compensate for the distortion model of the camera, resulting in an undistorted point. + +## -property-value +A matrix that transforms a point to compensate for the distortion model of the camera. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_undistortpoint_2080601284.md b/windows.media.devices.core/cameraintrinsics_undistortpoint_2080601284.md index fcc7827771..3ef8aa8576 100644 --- a/windows.media.devices.core/cameraintrinsics_undistortpoint_2080601284.md +++ b/windows.media.devices.core/cameraintrinsics_undistortpoint_2080601284.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoint(Windows.Foundation.Point) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoint ## -description Transforms a point to compensate for the distortion model of the camera, resulting in an undistorted point. ## -parameters ### -param input The point to undistort. ## -returns An undistorted point. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoint(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoint + +## -description +Transforms a point to compensate for the distortion model of the camera, resulting in an undistorted point. + +## -parameters +### -param input +The point to undistort. + +## -returns +An undistorted point. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_undistortpoints_505390269.md b/windows.media.devices.core/cameraintrinsics_undistortpoints_505390269.md index 7cc5463e3b..6533f844a5 100644 --- a/windows.media.devices.core/cameraintrinsics_undistortpoints_505390269.md +++ b/windows.media.devices.core/cameraintrinsics_undistortpoints_505390269.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoints(Windows.Foundation.Point[],Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoints ## -description Transforms an array of points to compensate for the distortion model of the camera, resulting in an array of undistorted points. ## -parameters ### -param inputs The array of points to undistort. ### -param results An array of undistorted points. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoints(Windows.Foundation.Point[],Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.UndistortPoints + +## -description +Transforms an array of points to compensate for the distortion model of the camera, resulting in an array of undistorted points. + +## -parameters +### -param inputs +The array of points to undistort. + +### -param results +An array of undistorted points. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_unprojectatunitdepth_1064040166.md b/windows.media.devices.core/cameraintrinsics_unprojectatunitdepth_1064040166.md index fb0c3b13fd..84787976d2 100644 --- a/windows.media.devices.core/cameraintrinsics_unprojectatunitdepth_1064040166.md +++ b/windows.media.devices.core/cameraintrinsics_unprojectatunitdepth_1064040166.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UnprojectAtUnitDepth(Windows.Foundation.Point) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.UnprojectAtUnitDepth ## -description Unprojects pixel coordinates into a camera space ray from the camera origin, expressed as a X, Y coordinates on the plane at Z = 1.0. ## -parameters ### -param pixelCoordinate The pixel coordinates to unproject into camera space. ## -returns The X, Y coordinates of the unprojected pixel on the plane at Z = 1.0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UnprojectAtUnitDepth(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.UnprojectAtUnitDepth + +## -description +Unprojects pixel coordinates into a camera space ray from the camera origin, expressed as a X, Y coordinates on the plane at Z = 1.0. + +## -parameters +### -param pixelCoordinate +The pixel coordinates to unproject into camera space. + +## -returns +The X, Y coordinates of the unprojected pixel on the plane at Z = 1.0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/cameraintrinsics_unprojectpixelsatunitdepth_1708320502.md b/windows.media.devices.core/cameraintrinsics_unprojectpixelsatunitdepth_1708320502.md index 0c3c6bf7a2..4360d24b66 100644 --- a/windows.media.devices.core/cameraintrinsics_unprojectpixelsatunitdepth_1708320502.md +++ b/windows.media.devices.core/cameraintrinsics_unprojectpixelsatunitdepth_1708320502.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UnprojectPixelsAtUnitDepth(Windows.Foundation.Point[],Windows.Foundation.Numerics.Vector2[]) --api-type: winrt method ---- # Windows.Media.Devices.Core.CameraIntrinsics.UnprojectPixelsAtUnitDepth ## -description Unprojects an array pixel coordinates into a camera space rays from the camera origin, expressed as a X, Y coordinates on the plane at Z = 1.0. ## -parameters ### -param pixelCoordinates The array of pixel coordinates to unproject into camera space. ### -param results The array of X, Y coordinates of the unprojected pixels on the plane at Z = 1.0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.CameraIntrinsics.UnprojectPixelsAtUnitDepth(Windows.Foundation.Point[],Windows.Foundation.Numerics.Vector2[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.CameraIntrinsics.UnprojectPixelsAtUnitDepth + +## -description +Unprojects an array pixel coordinates into a camera space rays from the camera origin, expressed as a X, Y coordinates on the plane at Z = 1.0. + +## -parameters +### -param pixelCoordinates +The array of pixel coordinates to unproject into camera space. + +### -param results +The array of X, Y coordinates of the unprojected pixels on the plane at Z = 1.0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/depthcorrelatedcoordinatemapper.md b/windows.media.devices.core/depthcorrelatedcoordinatemapper.md index 547a0be146..4538d7f1be 100644 --- a/windows.media.devices.core/depthcorrelatedcoordinatemapper.md +++ b/windows.media.devices.core/depthcorrelatedcoordinatemapper.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper --api-type: winrt class ---- # Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper ## -description Maps 2D points in a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to 3D space or to a frame from a different **MediaFrameSource** using data from a [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md). ## -remarks Get an instance of this class by calling the [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md) of a [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper + +## -description +Maps 2D points in a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to 3D space or to a frame from a different **MediaFrameSource** using data from a [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md). + +## -remarks +Get an instance of this class by calling the [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md) of a [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md) \ No newline at end of file diff --git a/windows.media.devices.core/depthcorrelatedcoordinatemapper_close_811482585.md b/windows.media.devices.core/depthcorrelatedcoordinatemapper_close_811482585.md index cb5fdc07fd..a0fbfde7c0 100644 --- a/windows.media.devices.core/depthcorrelatedcoordinatemapper_close_811482585.md +++ b/windows.media.devices.core/depthcorrelatedcoordinatemapper_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.Close --api-type: winrt method ---- # Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.Close ## -description Disposes of the object and associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [DepthCorrelatedCoordinateMapper](depthcorrelatedcoordinatemapper.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.Close +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.Close + +## -description +Disposes of the object and associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [DepthCorrelatedCoordinateMapper](depthcorrelatedcoordinatemapper.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoint_1078540697.md b/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoint_1078540697.md index 12f46c9380..c188c3fbf9 100644 --- a/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoint_1078540697.md +++ b/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoint_1078540697.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoint(Windows.Foundation.Point,Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Media.Devices.Core.CameraIntrinsics) --api-type: winrt method ---- # Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoint ## -description Maps a point from one [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to another, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). ## -parameters ### -param sourcePoint The source point to be mapped to the coordinate system of a different media frame source, which is specified in the *targetCoordinateSystem* parameter. ### -param targetCoordinateSystem The coordinate system of the target media frame source to which the point is mapped. ### -param targetCameraIntrinsics The camera intrinsics describing the projection and distortion models of the media frame source to which the point is mapped. ## -returns A mapped point. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoint(Windows.Foundation.Point,Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Media.Devices.Core.CameraIntrinsics) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoint + +## -description +Maps a point from one [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to another, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). + +## -parameters +### -param sourcePoint +The source point to be mapped to the coordinate system of a different media frame source, which is specified in the *targetCoordinateSystem* parameter. + +### -param targetCoordinateSystem +The coordinate system of the target media frame source to which the point is mapped. + +### -param targetCameraIntrinsics +The camera intrinsics describing the projection and distortion models of the media frame source to which the point is mapped. + +## -returns +A mapped point. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoints_790874304.md b/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoints_790874304.md index 880e8d890c..e19ba47f79 100644 --- a/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoints_790874304.md +++ b/windows.media.devices.core/depthcorrelatedcoordinatemapper_mappoints_790874304.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoints(Windows.Foundation.Point[],Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Media.Devices.Core.CameraIntrinsics,Windows.Foundation.Point[]) --api-type: winrt method ---- # Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoints ## -description Maps an array of points from one [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to another, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). ## -parameters ### -param sourcePoints An array of source points to be mapped to the coordinate system of a different media frame source, which is specified in the *targetCoordinateSystem* parameter. ### -param targetCoordinateSystem The coordinate system of the target media frame source to which the points are mapped. ### -param targetCameraIntrinsics The camera intrinsics describing the projection and distortion models of the media frame source to which the points are mapped. ### -param results An array mapped points. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoints(Windows.Foundation.Point[],Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Media.Devices.Core.CameraIntrinsics,Windows.Foundation.Point[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.MapPoints + +## -description +Maps an array of points from one [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to another, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). + +## -parameters +### -param sourcePoints +An array of source points to be mapped to the coordinate system of a different media frame source, which is specified in the *targetCoordinateSystem* parameter. + +### -param targetCoordinateSystem +The coordinate system of the target media frame source to which the points are mapped. + +### -param targetCameraIntrinsics +The camera intrinsics describing the projection and distortion models of the media frame source to which the points are mapped. + +### -param results +An array mapped points. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoint_1220498323.md b/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoint_1220498323.md index c7923c55d7..4dd30a6c17 100644 --- a/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoint_1220498323.md +++ b/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoint_1220498323.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoint(Windows.Foundation.Point,Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- # Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoint ## -description Unprojects a 2D point from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to a point in 3D space, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). ## -parameters ### -param sourcePoint The 2D source point within the [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to map. ### -param targetCoordinateSystem The coordinate system to which the point is unprojected. ## -returns An point in 3D space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoint(Windows.Foundation.Point,Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoint + +## -description +Unprojects a 2D point from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to a point in 3D space, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). + +## -parameters +### -param sourcePoint +The 2D source point within the [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to map. + +### -param targetCoordinateSystem +The coordinate system to which the point is unprojected. + +## -returns +An point in 3D space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoints_524028040.md b/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoints_524028040.md index 60c5ca194d..c8eee7e684 100644 --- a/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoints_524028040.md +++ b/windows.media.devices.core/depthcorrelatedcoordinatemapper_unprojectpoints_524028040.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoints(Windows.Foundation.Point[],Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3[]) --api-type: winrt method ---- # Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoints ## -description Unprojects an array of 2D points from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to a point in 3D space, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). ## -parameters ### -param sourcePoints The array of 2D source points within the [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to map. ### -param targetCoordinateSystem The coordinate system to which the points are unprojected. ### -param results An array of points in 3D space. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoints(Windows.Foundation.Point[],Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper.UnprojectPoints + +## -description +Unprojects an array of 2D points from a [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to a point in 3D space, using depth information from the [DepthMediaFrame](../windows.media.capture.frames/depthmediaframe.md) from which the coordinate mapper was created with a call to [TryCreateCoordinateMapper](../windows.media.capture.frames/depthmediaframe_trycreatecoordinatemapper.md). + +## -parameters +### -param sourcePoints +The array of 2D source points within the [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) to map. + +### -param targetCoordinateSystem +The coordinate system to which the points are unprojected. + +### -param results +An array of points in 3D space. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities.md b/windows.media.devices.core/framecontrolcapabilities.md index d086378bc3..e3891fbb79 100644 --- a/windows.media.devices.core/framecontrolcapabilities.md +++ b/windows.media.devices.core/framecontrolcapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameControlCapabilities --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameControlCapabilities ## -description Provides information about the variable photo sequence capabilities of the capture device. ## -remarks Get an instance of this class by accessing the [FrameCapabilities](variablephotosequencecontroller_framecapabilities.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameControlCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities + +## -description +Provides information about the variable photo sequence capabilities of the capture device. + +## -remarks +Get an instance of this class by accessing the [FrameCapabilities](variablephotosequencecontroller_framecapabilities.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities_exposure.md b/windows.media.devices.core/framecontrolcapabilities_exposure.md index 0c2cacad30..1d1d2afe6f 100644 --- a/windows.media.devices.core/framecontrolcapabilities_exposure.md +++ b/windows.media.devices.core/framecontrolcapabilities_exposure.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.Exposure --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameControlCapabilities.Exposure ## -description Gets the exposure capabilities of the capture device for variable photo sequences. ## -property-value The exposure capabilities of the capture device for variable photo sequences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.Exposure +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities.Exposure + +## -description +Gets the exposure capabilities of the capture device for variable photo sequences. + +## -property-value +The exposure capabilities of the capture device for variable photo sequences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities_exposurecompensation.md b/windows.media.devices.core/framecontrolcapabilities_exposurecompensation.md index ce02b7afc3..6d19992a99 100644 --- a/windows.media.devices.core/framecontrolcapabilities_exposurecompensation.md +++ b/windows.media.devices.core/framecontrolcapabilities_exposurecompensation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.ExposureCompensation --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameControlCapabilities.ExposureCompensation ## -description Gets the exposure compensation capabilities of the capture device for variable photo sequences. ## -property-value The exposure capabilities of the capture device for variable photo sequences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.ExposureCompensation +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities.ExposureCompensation + +## -description +Gets the exposure compensation capabilities of the capture device for variable photo sequences. + +## -property-value +The exposure capabilities of the capture device for variable photo sequences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities_flash.md b/windows.media.devices.core/framecontrolcapabilities_flash.md index a3a1a3b99f..b153babbd2 100644 --- a/windows.media.devices.core/framecontrolcapabilities_flash.md +++ b/windows.media.devices.core/framecontrolcapabilities_flash.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.Flash --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameControlCapabilities.Flash ## -description Gets the flash capabilities of the capture device for variable photo sequences. ## -property-value The flash capabilities of the capture device for variable photo sequences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.Flash +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities.Flash + +## -description +Gets the flash capabilities of the capture device for variable photo sequences. + +## -property-value +The flash capabilities of the capture device for variable photo sequences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities_focus.md b/windows.media.devices.core/framecontrolcapabilities_focus.md index 2edbb8dfa7..d9a35f5ca2 100644 --- a/windows.media.devices.core/framecontrolcapabilities_focus.md +++ b/windows.media.devices.core/framecontrolcapabilities_focus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.Focus --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameControlCapabilities.Focus ## -description Gets the focus capabilities of the capture device for variable photo sequences. ## -property-value The focus capabilities of the capture device for variable photo sequences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.Focus +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities.Focus + +## -description +Gets the focus capabilities of the capture device for variable photo sequences. + +## -property-value +The focus capabilities of the capture device for variable photo sequences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities_isospeed.md b/windows.media.devices.core/framecontrolcapabilities_isospeed.md index 3a03a97f23..849a438f91 100644 --- a/windows.media.devices.core/framecontrolcapabilities_isospeed.md +++ b/windows.media.devices.core/framecontrolcapabilities_isospeed.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.IsoSpeed --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameControlCapabilities.IsoSpeed ## -description Gets the ISO speed capabilities of the capture device for variable photo sequences. ## -property-value The ISO speed capabilities of the capture device for variable photo sequences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.IsoSpeed +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities.IsoSpeed + +## -description +Gets the ISO speed capabilities of the capture device for variable photo sequences. + +## -property-value +The ISO speed capabilities of the capture device for variable photo sequences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontrolcapabilities_photoconfirmationsupported.md b/windows.media.devices.core/framecontrolcapabilities_photoconfirmationsupported.md index 168264a0b3..20524599b8 100644 --- a/windows.media.devices.core/framecontrolcapabilities_photoconfirmationsupported.md +++ b/windows.media.devices.core/framecontrolcapabilities_photoconfirmationsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.PhotoConfirmationSupported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameControlCapabilities.PhotoConfirmationSupported ## -description Gets whether the capture device supports photo confirmation for variable photo sequences. ## -property-value Whether the capture device supports photo confirmation for variable photo sequences. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameControlCapabilities.PhotoConfirmationSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameControlCapabilities.PhotoConfirmationSupported + +## -description +Gets whether the capture device supports photo confirmation for variable photo sequences. + +## -property-value +Whether the capture device supports photo confirmation for variable photo sequences. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller.md b/windows.media.devices.core/framecontroller.md index f7ea73491b..a023c83353 100644 --- a/windows.media.devices.core/framecontroller.md +++ b/windows.media.devices.core/framecontroller.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameController --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameController ## -description Represents the settings for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameController +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameController + +## -description +Represents the settings for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_exposurecompensationcontrol.md b/windows.media.devices.core/framecontroller_exposurecompensationcontrol.md index 3ea5e82bfc..c840c004d4 100644 --- a/windows.media.devices.core/framecontroller_exposurecompensationcontrol.md +++ b/windows.media.devices.core/framecontroller_exposurecompensationcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameController.ExposureCompensationControl --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameController.ExposureCompensationControl ## -description Gets the exposure compensation settings for a frame in a variable photo sequence. ## -property-value The exposure compensation settings for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameController.ExposureCompensationControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameController.ExposureCompensationControl + +## -description +Gets the exposure compensation settings for a frame in a variable photo sequence. + +## -property-value +The exposure compensation settings for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_exposurecontrol.md b/windows.media.devices.core/framecontroller_exposurecontrol.md index c6c1dced0e..53bf12db1e 100644 --- a/windows.media.devices.core/framecontroller_exposurecontrol.md +++ b/windows.media.devices.core/framecontroller_exposurecontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameController.ExposureControl --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameController.ExposureControl ## -description Gets the exposure settings for a frame in a variable photo sequence. ## -property-value The exposure settings for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameController.ExposureControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameController.ExposureControl + +## -description +Gets the exposure settings for a frame in a variable photo sequence. + +## -property-value +The exposure settings for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_flashcontrol.md b/windows.media.devices.core/framecontroller_flashcontrol.md index b661c20449..c4a1075e9f 100644 --- a/windows.media.devices.core/framecontroller_flashcontrol.md +++ b/windows.media.devices.core/framecontroller_flashcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameController.FlashControl --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameController.FlashControl ## -description Gets the flash settings for a frame in a variable photo sequence. ## -property-value The flash settings for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameController.FlashControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameController.FlashControl + +## -description +Gets the flash settings for a frame in a variable photo sequence. + +## -property-value +The flash settings for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_focuscontrol.md b/windows.media.devices.core/framecontroller_focuscontrol.md index 2781eb8969..233544fdca 100644 --- a/windows.media.devices.core/framecontroller_focuscontrol.md +++ b/windows.media.devices.core/framecontroller_focuscontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameController.FocusControl --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameController.FocusControl ## -description Gets the focus settings for a frame in a variable photo sequence. ## -property-value The focus settings for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameController.FocusControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameController.FocusControl + +## -description +Gets the focus settings for a frame in a variable photo sequence. + +## -property-value +The focus settings for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_framecontroller_1221375020.md b/windows.media.devices.core/framecontroller_framecontroller_1221375020.md index 6ba540c208..0461853770 100644 --- a/windows.media.devices.core/framecontroller_framecontroller_1221375020.md +++ b/windows.media.devices.core/framecontroller_framecontroller_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.Core.FrameController.#ctor --api-type: winrt method ---- # Windows.Media.Devices.Core.FrameController.FrameController ## -description Initializes a new instance of the [FrameController](framecontroller.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.FrameController.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.FrameController.FrameController + +## -description +Initializes a new instance of the [FrameController](framecontroller.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_isospeedcontrol.md b/windows.media.devices.core/framecontroller_isospeedcontrol.md index c465945251..d1c08f3608 100644 --- a/windows.media.devices.core/framecontroller_isospeedcontrol.md +++ b/windows.media.devices.core/framecontroller_isospeedcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameController.IsoSpeedControl --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameController.IsoSpeedControl ## -description Gets the ISO speed settings for a frame in a variable photo sequence. ## -property-value The ISO speed settings for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameController.IsoSpeedControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameController.IsoSpeedControl + +## -description +Gets the ISO speed settings for a frame in a variable photo sequence. + +## -property-value +The ISO speed settings for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framecontroller_photoconfirmationenabled.md b/windows.media.devices.core/framecontroller_photoconfirmationenabled.md index 01d787bd39..79dd360252 100644 --- a/windows.media.devices.core/framecontroller_photoconfirmationenabled.md +++ b/windows.media.devices.core/framecontroller_photoconfirmationenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameController.PhotoConfirmationEnabled --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameController.PhotoConfirmationEnabled ## -description Gets or sets whether photo confirmation is enabled for a frame in a variable photo sequence. ## -property-value Whether photo confirmation is enabled for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameController.PhotoConfirmationEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameController.PhotoConfirmationEnabled + +## -description +Gets or sets whether photo confirmation is enabled for a frame in a variable photo sequence. + +## -property-value +Whether photo confirmation is enabled for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecapabilities.md b/windows.media.devices.core/frameexposurecapabilities.md index d7dd0f9da6..4f09d0943b 100644 --- a/windows.media.devices.core/frameexposurecapabilities.md +++ b/windows.media.devices.core/frameexposurecapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameExposureCapabilities --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameExposureCapabilities ## -description Provides information about the exposure time capabilities of the capture device for frames in a variable photo sequences. ## -remarks Get an instance of this class by accessing the [Exposure](framecontrolcapabilities_exposure.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameExposureCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameExposureCapabilities + +## -description +Provides information about the exposure time capabilities of the capture device for frames in a variable photo sequences. + +## -remarks +Get an instance of this class by accessing the [Exposure](framecontrolcapabilities_exposure.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecapabilities_max.md b/windows.media.devices.core/frameexposurecapabilities_max.md index cf09a1e17d..870d1a7663 100644 --- a/windows.media.devices.core/frameexposurecapabilities_max.md +++ b/windows.media.devices.core/frameexposurecapabilities_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Max --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCapabilities.Max ## -description Gets the maximum exposure time supported by the capture device. ## -property-value The maximum exposure time supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCapabilities.Max + +## -description +Gets the maximum exposure time supported by the capture device. + +## -property-value +The maximum exposure time supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecapabilities_min.md b/windows.media.devices.core/frameexposurecapabilities_min.md index 90e239de09..88e685861d 100644 --- a/windows.media.devices.core/frameexposurecapabilities_min.md +++ b/windows.media.devices.core/frameexposurecapabilities_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Min --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCapabilities.Min ## -description Gets the minimum exposure time supported by the capture device. ## -property-value Gets the minimum exposure time supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCapabilities.Min + +## -description +Gets the minimum exposure time supported by the capture device. + +## -property-value +Gets the minimum exposure time supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecapabilities_step.md b/windows.media.devices.core/frameexposurecapabilities_step.md index 69c00eb7e6..6676c66ec6 100644 --- a/windows.media.devices.core/frameexposurecapabilities_step.md +++ b/windows.media.devices.core/frameexposurecapabilities_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Step --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCapabilities.Step ## -description Gets the smallest exposure time increment supported by the capture device. ## -property-value Gets the smallest exposure time increment supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCapabilities.Step + +## -description +Gets the smallest exposure time increment supported by the capture device. + +## -property-value +Gets the smallest exposure time increment supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecapabilities_supported.md b/windows.media.devices.core/frameexposurecapabilities_supported.md index 39c8368d5b..c6f5e1ab39 100644 --- a/windows.media.devices.core/frameexposurecapabilities_supported.md +++ b/windows.media.devices.core/frameexposurecapabilities_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Supported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCapabilities.Supported ## -description Gets a value that indicates if the capture device supports the exposure control for variable photo sequences. ## -property-value True if the capture device supports the exposure control; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCapabilities.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCapabilities.Supported + +## -description +Gets a value that indicates if the capture device supports the exposure control for variable photo sequences. + +## -property-value +True if the capture device supports the exposure control; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcapabilities.md b/windows.media.devices.core/frameexposurecompensationcapabilities.md index 6597fea74e..6618a95824 100644 --- a/windows.media.devices.core/frameexposurecompensationcapabilities.md +++ b/windows.media.devices.core/frameexposurecompensationcapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameExposureCompensationCapabilities ## -description Provides information about the exposure compensation capabilities of the capture device for frames in a variable photo sequences. ## -remarks Get an instance of this class by accessing the [ExposureCompensation](framecontrolcapabilities_exposurecompensation.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationCapabilities + +## -description +Provides information about the exposure compensation capabilities of the capture device for frames in a variable photo sequences. + +## -remarks +Get an instance of this class by accessing the [ExposureCompensation](framecontrolcapabilities_exposurecompensation.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcapabilities_max.md b/windows.media.devices.core/frameexposurecompensationcapabilities_max.md index e89dfed673..e62215caeb 100644 --- a/windows.media.devices.core/frameexposurecompensationcapabilities_max.md +++ b/windows.media.devices.core/frameexposurecompensationcapabilities_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Max --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Max ## -description Gets the maximum exposure compensation supported by the capture device. ## -property-value The maximum exposure compensation supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Max + +## -description +Gets the maximum exposure compensation supported by the capture device. + +## -property-value +The maximum exposure compensation supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcapabilities_min.md b/windows.media.devices.core/frameexposurecompensationcapabilities_min.md index 3458303a9b..29cf3f7402 100644 --- a/windows.media.devices.core/frameexposurecompensationcapabilities_min.md +++ b/windows.media.devices.core/frameexposurecompensationcapabilities_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Min --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Min ## -description Gets the minimum exposure compensation supported by the capture device. ## -property-value The minimum exposure compensation supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Min + +## -description +Gets the minimum exposure compensation supported by the capture device. + +## -property-value +The minimum exposure compensation supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcapabilities_step.md b/windows.media.devices.core/frameexposurecompensationcapabilities_step.md index 75a81bcc85..6b1b55c8fb 100644 --- a/windows.media.devices.core/frameexposurecompensationcapabilities_step.md +++ b/windows.media.devices.core/frameexposurecompensationcapabilities_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Step --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Step ## -description Gets the smallest exposure time compensation increment supported by the capture device. ## -property-value The smallest exposure time compensation increment supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Step + +## -description +Gets the smallest exposure time compensation increment supported by the capture device. + +## -property-value +The smallest exposure time compensation increment supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcapabilities_supported.md b/windows.media.devices.core/frameexposurecompensationcapabilities_supported.md index 451a27023a..8f13da6773 100644 --- a/windows.media.devices.core/frameexposurecompensationcapabilities_supported.md +++ b/windows.media.devices.core/frameexposurecompensationcapabilities_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Supported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Supported ## -description Gets a value that indicates if the capture device supports the frame exposure compensation control for frames in a variable photo sequence. ## -property-value True if the capture device supports the frame exposure control; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationCapabilities.Supported + +## -description +Gets a value that indicates if the capture device supports the frame exposure compensation control for frames in a variable photo sequence. + +## -property-value +True if the capture device supports the frame exposure control; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcontrol.md b/windows.media.devices.core/frameexposurecompensationcontrol.md index fb7b825ee1..179ffaaa0a 100644 --- a/windows.media.devices.core/frameexposurecompensationcontrol.md +++ b/windows.media.devices.core/frameexposurecompensationcontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameExposureCompensationControl --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameExposureCompensationControl ## -description Represents the exposure compensation settings for a frame in a variable photo sequence. ## -remarks Get an instance of this class by accessing the [ExposureCompensation](framecontrolcapabilities_exposurecompensation.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameExposureCompensationControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationControl + +## -description +Represents the exposure compensation settings for a frame in a variable photo sequence. + +## -remarks +Get an instance of this class by accessing the [ExposureCompensation](framecontrolcapabilities_exposurecompensation.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecompensationcontrol_value.md b/windows.media.devices.core/frameexposurecompensationcontrol_value.md index c9a796633d..7bacda78b6 100644 --- a/windows.media.devices.core/frameexposurecompensationcontrol_value.md +++ b/windows.media.devices.core/frameexposurecompensationcontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationControl.Value --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureCompensationControl.Value ## -description Gets or sets the exposure compensation time for a frame in a variable photo sequence. ## -property-value The exposure compensation time for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureCompensationControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureCompensationControl.Value + +## -description +Gets or sets the exposure compensation time for a frame in a variable photo sequence. + +## -property-value +The exposure compensation time for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecontrol.md b/windows.media.devices.core/frameexposurecontrol.md index c77285b3bf..438a236bf8 100644 --- a/windows.media.devices.core/frameexposurecontrol.md +++ b/windows.media.devices.core/frameexposurecontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameExposureControl --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameExposureControl ## -description Represents the exposure time settings for a frame in a variable photo sequence. ## -remarks Get an instance of this class by accessing the [ExposureControl](framecontroller_exposurecontrol.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameExposureControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameExposureControl + +## -description +Represents the exposure time settings for a frame in a variable photo sequence. + +## -remarks +Get an instance of this class by accessing the [ExposureControl](framecontroller_exposurecontrol.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecontrol_auto.md b/windows.media.devices.core/frameexposurecontrol_auto.md index 3098ee11c5..b30de02913 100644 --- a/windows.media.devices.core/frameexposurecontrol_auto.md +++ b/windows.media.devices.core/frameexposurecontrol_auto.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureControl.Auto --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureControl.Auto ## -description Gets or sets a value indicating whether auto exposure is enabled for a frame in a variable photo sequence. ## -property-value A value indicating whether auto exposure is enabled for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureControl.Auto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureControl.Auto + +## -description +Gets or sets a value indicating whether auto exposure is enabled for a frame in a variable photo sequence. + +## -property-value +A value indicating whether auto exposure is enabled for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameexposurecontrol_value.md b/windows.media.devices.core/frameexposurecontrol_value.md index b53664efdf..2508751225 100644 --- a/windows.media.devices.core/frameexposurecontrol_value.md +++ b/windows.media.devices.core/frameexposurecontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameExposureControl.Value --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameExposureControl.Value ## -description Gets or sets the exposure time for a frame in a variable photo sequence. ## -property-value The exposure time for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameExposureControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameExposureControl.Value + +## -description +Gets or sets the exposure time for a frame in a variable photo sequence. + +## -property-value +The exposure time for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcapabilities.md b/windows.media.devices.core/frameflashcapabilities.md index 96da69e04d..abede78bd4 100644 --- a/windows.media.devices.core/frameflashcapabilities.md +++ b/windows.media.devices.core/frameflashcapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameFlashCapabilities --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameFlashCapabilities ## -description Provides information about the flash capabilities of the capture device for frames in a variable photo sequences. ## -remarks Get an instance of this class by accessing the [FrameControlCapabilities.Flash](framecontrolcapabilities_flash.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameFlashCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameFlashCapabilities + +## -description +Provides information about the flash capabilities of the capture device for frames in a variable photo sequences. + +## -remarks +Get an instance of this class by accessing the [FrameControlCapabilities.Flash](framecontrolcapabilities_flash.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcapabilities_powersupported.md b/windows.media.devices.core/frameflashcapabilities_powersupported.md index baae7c4cfc..78d04c6024 100644 --- a/windows.media.devices.core/frameflashcapabilities_powersupported.md +++ b/windows.media.devices.core/frameflashcapabilities_powersupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashCapabilities.PowerSupported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashCapabilities.PowerSupported ## -description Gets a value indicating whether flash power is supported for frames in a variable photo sequences. ## -property-value True if flash power is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashCapabilities.PowerSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashCapabilities.PowerSupported + +## -description +Gets a value indicating whether flash power is supported for frames in a variable photo sequences. + +## -property-value +True if flash power is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcapabilities_redeyereductionsupported.md b/windows.media.devices.core/frameflashcapabilities_redeyereductionsupported.md index 62183ac92a..79a98b95d9 100644 --- a/windows.media.devices.core/frameflashcapabilities_redeyereductionsupported.md +++ b/windows.media.devices.core/frameflashcapabilities_redeyereductionsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashCapabilities.RedEyeReductionSupported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashCapabilities.RedEyeReductionSupported ## -description Gets a value indicating whether red eye reduction is supported for frames in a variable photo sequences. ## -property-value True if red eye reduction is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashCapabilities.RedEyeReductionSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashCapabilities.RedEyeReductionSupported + +## -description +Gets a value indicating whether red eye reduction is supported for frames in a variable photo sequences. + +## -property-value +True if red eye reduction is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcapabilities_supported.md b/windows.media.devices.core/frameflashcapabilities_supported.md index 1318bf3636..9922158f23 100644 --- a/windows.media.devices.core/frameflashcapabilities_supported.md +++ b/windows.media.devices.core/frameflashcapabilities_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashCapabilities.Supported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashCapabilities.Supported ## -description Gets a value that indicates if the capture device supports the flash control for frames in a variable photo sequence. ## -property-value True if the capture device supports the flash control; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashCapabilities.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashCapabilities.Supported + +## -description +Gets a value that indicates if the capture device supports the flash control for frames in a variable photo sequence. + +## -property-value +True if the capture device supports the flash control; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcontrol.md b/windows.media.devices.core/frameflashcontrol.md index 30f3d7511b..e440512cf8 100644 --- a/windows.media.devices.core/frameflashcontrol.md +++ b/windows.media.devices.core/frameflashcontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameFlashControl --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameFlashControl ## -description Represents the flash settings for a frame in a variable photo sequence. ## -remarks Get an instance of this class by accessing the [FrameController.FlashControl](framecontroller_flashcontrol.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameFlashControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameFlashControl + +## -description +Represents the flash settings for a frame in a variable photo sequence. + +## -remarks +Get an instance of this class by accessing the [FrameController.FlashControl](framecontroller_flashcontrol.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcontrol_auto.md b/windows.media.devices.core/frameflashcontrol_auto.md index 6445f9fa01..2ad40b7126 100644 --- a/windows.media.devices.core/frameflashcontrol_auto.md +++ b/windows.media.devices.core/frameflashcontrol_auto.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashControl.Auto --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashControl.Auto ## -description Gets or sets a value indicating whether flash settings are automatically set for a frame in a variable photo sequence. ## -property-value True if the flash settings are automatically set for a frame in a variable photo sequence; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashControl.Auto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashControl.Auto + +## -description +Gets or sets a value indicating whether flash settings are automatically set for a frame in a variable photo sequence. + +## -property-value +True if the flash settings are automatically set for a frame in a variable photo sequence; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcontrol_mode.md b/windows.media.devices.core/frameflashcontrol_mode.md index 16f7b6f0bd..203180ccfd 100644 --- a/windows.media.devices.core/frameflashcontrol_mode.md +++ b/windows.media.devices.core/frameflashcontrol_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashControl.Mode --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashControl.Mode ## -description Gets or sets the flash mode for a frame in a variable photo sequence. ## -property-value The flash mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashControl.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashControl.Mode + +## -description +Gets or sets the flash mode for a frame in a variable photo sequence. + +## -property-value +The flash mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcontrol_powerpercent.md b/windows.media.devices.core/frameflashcontrol_powerpercent.md index 5229809193..ee3fe85353 100644 --- a/windows.media.devices.core/frameflashcontrol_powerpercent.md +++ b/windows.media.devices.core/frameflashcontrol_powerpercent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashControl.PowerPercent --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashControl.PowerPercent ## -description Gets or sets the flash power for a frame in a variable photo sequence. ## -property-value The flash power percentage, from 0 to 100, for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashControl.PowerPercent +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashControl.PowerPercent + +## -description +Gets or sets the flash power for a frame in a variable photo sequence. + +## -property-value +The flash power percentage, from 0 to 100, for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameflashcontrol_redeyereduction.md b/windows.media.devices.core/frameflashcontrol_redeyereduction.md index 9fd3b89c08..15a7f3171f 100644 --- a/windows.media.devices.core/frameflashcontrol_redeyereduction.md +++ b/windows.media.devices.core/frameflashcontrol_redeyereduction.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFlashControl.RedEyeReduction --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFlashControl.RedEyeReduction ## -description Gets or sets a value indicating if red eye reduction is enabled for a frame in a variable photo sequence. ## -property-value True if red eye reduction is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFlashControl.RedEyeReduction +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFlashControl.RedEyeReduction + +## -description +Gets or sets a value indicating if red eye reduction is enabled for a frame in a variable photo sequence. + +## -property-value +True if red eye reduction is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscapabilities.md b/windows.media.devices.core/framefocuscapabilities.md index a96932d6a3..8463b1a549 100644 --- a/windows.media.devices.core/framefocuscapabilities.md +++ b/windows.media.devices.core/framefocuscapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameFocusCapabilities --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameFocusCapabilities ## -description Provides information about the focus capabilities of the capture device for frames in a variable photo sequences. ## -remarks Get an instance of this class by accessing the [Focus](framecontrolcapabilities_focus.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameFocusCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameFocusCapabilities + +## -description +Provides information about the focus capabilities of the capture device for frames in a variable photo sequences. + +## -remarks +Get an instance of this class by accessing the [Focus](framecontrolcapabilities_focus.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscapabilities_max.md b/windows.media.devices.core/framefocuscapabilities_max.md index 47ce0e5936..42a0a0864f 100644 --- a/windows.media.devices.core/framefocuscapabilities_max.md +++ b/windows.media.devices.core/framefocuscapabilities_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Max --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFocusCapabilities.Max ## -description Gets the maximum focus length supported by the capture device for a frame in a variable photo sequence, specified in millimeters. ## -property-value The maximum focus length supported by the capture device for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFocusCapabilities.Max + +## -description +Gets the maximum focus length supported by the capture device for a frame in a variable photo sequence, specified in millimeters. + +## -property-value +The maximum focus length supported by the capture device for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscapabilities_min.md b/windows.media.devices.core/framefocuscapabilities_min.md index 25dabc7fa7..b4deecc4f8 100644 --- a/windows.media.devices.core/framefocuscapabilities_min.md +++ b/windows.media.devices.core/framefocuscapabilities_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Min --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFocusCapabilities.Min ## -description Gets the minimum focus length supported by the capture device for a frame in a variable photo sequence, specified in millimeters. ## -property-value The minimum focus length supported by the capture device for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFocusCapabilities.Min + +## -description +Gets the minimum focus length supported by the capture device for a frame in a variable photo sequence, specified in millimeters. + +## -property-value +The minimum focus length supported by the capture device for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscapabilities_step.md b/windows.media.devices.core/framefocuscapabilities_step.md index 51c823532b..12fa3f2e58 100644 --- a/windows.media.devices.core/framefocuscapabilities_step.md +++ b/windows.media.devices.core/framefocuscapabilities_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Step --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFocusCapabilities.Step ## -description Gets the smallest focus increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters. ## -property-value The smallest focus increment supported by the capture device for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFocusCapabilities.Step + +## -description +Gets the smallest focus increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters. + +## -property-value +The smallest focus increment supported by the capture device for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscapabilities_supported.md b/windows.media.devices.core/framefocuscapabilities_supported.md index 27a2adcb04..5be11e9757 100644 --- a/windows.media.devices.core/framefocuscapabilities_supported.md +++ b/windows.media.devices.core/framefocuscapabilities_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Supported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFocusCapabilities.Supported ## -description Gets a value that indicates if the capture device supports the focus control for frames in a variable photo sequence. ## -property-value True if the capture device supports the focus control; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFocusCapabilities.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFocusCapabilities.Supported + +## -description +Gets a value that indicates if the capture device supports the focus control for frames in a variable photo sequence. + +## -property-value +True if the capture device supports the focus control; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscontrol.md b/windows.media.devices.core/framefocuscontrol.md index 3e270233e8..054d62fb9d 100644 --- a/windows.media.devices.core/framefocuscontrol.md +++ b/windows.media.devices.core/framefocuscontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameFocusControl --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameFocusControl ## -description Represents the focus settings for a frame in a variable photo sequence. ## -remarks Get an instance of this class by accessing the [FocusControl](framecontroller_focuscontrol.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameFocusControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameFocusControl + +## -description +Represents the focus settings for a frame in a variable photo sequence. + +## -remarks +Get an instance of this class by accessing the [FocusControl](framecontroller_focuscontrol.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/framefocuscontrol_value.md b/windows.media.devices.core/framefocuscontrol_value.md index 7369ba0286..29d800a896 100644 --- a/windows.media.devices.core/framefocuscontrol_value.md +++ b/windows.media.devices.core/framefocuscontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameFocusControl.Value --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameFocusControl.Value ## -description Gets or sets the focus value for a frame in a variable photo sequence. ## -property-value The focus value for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameFocusControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameFocusControl.Value + +## -description +Gets or sets the focus value for a frame in a variable photo sequence. + +## -property-value +The focus value for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcapabilities.md b/windows.media.devices.core/frameisospeedcapabilities.md index 110022ca4e..d2527ffbd4 100644 --- a/windows.media.devices.core/frameisospeedcapabilities.md +++ b/windows.media.devices.core/frameisospeedcapabilities.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameIsoSpeedCapabilities ## -description Provides information about the ISO speed capabilities of the capture device for frames in a variable photo sequences. ## -remarks Get an instance of this class by accessing the [IsoSpeed](framecontrolcapabilities_isospeed.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedCapabilities + +## -description +Provides information about the ISO speed capabilities of the capture device for frames in a variable photo sequences. + +## -remarks +Get an instance of this class by accessing the [IsoSpeed](framecontrolcapabilities_isospeed.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcapabilities_max.md b/windows.media.devices.core/frameisospeedcapabilities_max.md index f18229af5c..915b210935 100644 --- a/windows.media.devices.core/frameisospeedcapabilities_max.md +++ b/windows.media.devices.core/frameisospeedcapabilities_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Max --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Max ## -description Gets the maximum ISO speed supported by the capture device for a frame in a variable photo sequence. ## -property-value The maximum ISO speed supported by the capture device for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Max + +## -description +Gets the maximum ISO speed supported by the capture device for a frame in a variable photo sequence. + +## -property-value +The maximum ISO speed supported by the capture device for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcapabilities_min.md b/windows.media.devices.core/frameisospeedcapabilities_min.md index 3bf40cc287..bb133dfa9b 100644 --- a/windows.media.devices.core/frameisospeedcapabilities_min.md +++ b/windows.media.devices.core/frameisospeedcapabilities_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Min --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Min ## -description The minimum ISO speed supported by the capture device for a frame in a variable photo sequence. ## -property-value The minimum ISO speed supported by the capture device for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Min + +## -description +The minimum ISO speed supported by the capture device for a frame in a variable photo sequence. + +## -property-value +The minimum ISO speed supported by the capture device for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcapabilities_step.md b/windows.media.devices.core/frameisospeedcapabilities_step.md index d020363548..9e8cbfcf57 100644 --- a/windows.media.devices.core/frameisospeedcapabilities_step.md +++ b/windows.media.devices.core/frameisospeedcapabilities_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Step --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Step ## -description Gets the smallest ISO speed increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters. ## -property-value The smallest ISO speed increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Step + +## -description +Gets the smallest ISO speed increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters. + +## -property-value +The smallest ISO speed increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcapabilities_supported.md b/windows.media.devices.core/frameisospeedcapabilities_supported.md index 2f844d9b66..66621a039f 100644 --- a/windows.media.devices.core/frameisospeedcapabilities_supported.md +++ b/windows.media.devices.core/frameisospeedcapabilities_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Supported --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Supported ## -description Gets a value that indicates if the capture device supports the ISO speed control for frames in a variable photo sequence. ## -property-value True if the capture device supports the ISO speed control; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedCapabilities.Supported + +## -description +Gets a value that indicates if the capture device supports the ISO speed control for frames in a variable photo sequence. + +## -property-value +True if the capture device supports the ISO speed control; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcontrol.md b/windows.media.devices.core/frameisospeedcontrol.md index 899f8e810d..2737a5c7cc 100644 --- a/windows.media.devices.core/frameisospeedcontrol.md +++ b/windows.media.devices.core/frameisospeedcontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.Core.FrameIsoSpeedControl --api-type: winrt class ---- # Windows.Media.Devices.Core.FrameIsoSpeedControl ## -description Represents the ISO speed settings for a frame in a variable photo sequence. ## -remarks Get an instance of this class by accessing the [IsoSpeedControl](framecontroller_isospeedcontrol.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.FrameIsoSpeedControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedControl + +## -description +Represents the ISO speed settings for a frame in a variable photo sequence. + +## -remarks +Get an instance of this class by accessing the [IsoSpeedControl](framecontroller_isospeedcontrol.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcontrol_auto.md b/windows.media.devices.core/frameisospeedcontrol_auto.md index b33b085597..e03a7999ef 100644 --- a/windows.media.devices.core/frameisospeedcontrol_auto.md +++ b/windows.media.devices.core/frameisospeedcontrol_auto.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedControl.Auto --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameIsoSpeedControl.Auto ## -description Gets or sets a value indicating whether ISO speed is automatically set for a frame in a variable photo sequence. ## -property-value True if the ISO speed is automatically set for a frame in a variable photo sequence; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedControl.Auto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedControl.Auto + +## -description +Gets or sets a value indicating whether ISO speed is automatically set for a frame in a variable photo sequence. + +## -property-value +True if the ISO speed is automatically set for a frame in a variable photo sequence; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/frameisospeedcontrol_value.md b/windows.media.devices.core/frameisospeedcontrol_value.md index 83e3cf73e9..c992f1a46c 100644 --- a/windows.media.devices.core/frameisospeedcontrol_value.md +++ b/windows.media.devices.core/frameisospeedcontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedControl.Value --api-type: winrt property ---- # Windows.Media.Devices.Core.FrameIsoSpeedControl.Value ## -description Gets or sets the ISO speed for a frame in a variable photo sequence. ## -property-value The ISO speed for a frame in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.FrameIsoSpeedControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.FrameIsoSpeedControl.Value + +## -description +Gets or sets the ISO speed for a frame in a variable photo sequence. + +## -property-value +The ISO speed for a frame in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller.md b/windows.media.devices.core/variablephotosequencecontroller.md index 067c6a6739..038a9a19b1 100644 --- a/windows.media.devices.core/variablephotosequencecontroller.md +++ b/windows.media.devices.core/variablephotosequencecontroller.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.Core.VariablePhotoSequenceController --api-type: winrt class ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController ## -description Represents the settings for a variable photo sequence. ## -remarks Get an instance of this class by accessing the [VariablePhotoSequenceController](../windows.media.devices/videodevicecontroller_variablephotosequencecontroller.md) property. For how-to guidance on capturing variable photo sequences, see [Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence). ## -examples ## -see-also [Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.Core.VariablePhotoSequenceController +-api-type: winrt class +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController + +## -description +Represents the settings for a variable photo sequence. + +## -remarks +Get an instance of this class by accessing the [VariablePhotoSequenceController](../windows.media.devices/videodevicecontroller_variablephotosequencecontroller.md) property. + +For how-to guidance on capturing variable photo sequences, see [Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence). + +## -examples + +## -see-also +[Capture a photo sequence with VariablePhotoSequence](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence) \ No newline at end of file diff --git a/windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md b/windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md index 8014f47473..1b53ee2850 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md +++ b/windows.media.devices.core/variablephotosequencecontroller_desiredframecontrollers.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.DesiredFrameControllers --api-type: winrt property ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.DesiredFrameControllers ## -description Gets the list of [FrameController](framecontroller.md) objects that determine the settings for each frame in a variable photo sequence. ## -property-value The list of [FrameController](framecontroller.md) objects that determine the settings for each frame in a variable photo sequence. ## -remarks The maximum number of frame controllers that can be used at a time is 18. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.DesiredFrameControllers +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.DesiredFrameControllers + +## -description +Gets the list of [FrameController](framecontroller.md) objects that determine the settings for each frame in a variable photo sequence. + +## -property-value +The list of [FrameController](framecontroller.md) objects that determine the settings for each frame in a variable photo sequence. + +## -remarks +The maximum number of frame controllers that can be used at a time is 18. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller_framecapabilities.md b/windows.media.devices.core/variablephotosequencecontroller_framecapabilities.md index 077ffbece4..6e5b642a28 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_framecapabilities.md +++ b/windows.media.devices.core/variablephotosequencecontroller_framecapabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.FrameCapabilities --api-type: winrt property ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.FrameCapabilities ## -description Gets a [FrameControlCapabilities](framecontrolcapabilities.md) object that provides information about the variable photo sequence capabilities of the capture device. ## -property-value A [FrameControlCapabilities](framecontrolcapabilities.md) object that provides information about the variable photo sequence capabilities of the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.FrameCapabilities +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.FrameCapabilities + +## -description +Gets a [FrameControlCapabilities](framecontrolcapabilities.md) object that provides information about the variable photo sequence capabilities of the capture device. + +## -property-value +A [FrameControlCapabilities](framecontrolcapabilities.md) object that provides information about the variable photo sequence capabilities of the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller_getcurrentframerate_279282429.md b/windows.media.devices.core/variablephotosequencecontroller_getcurrentframerate_279282429.md index 7333a39598..d0568b9490 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_getcurrentframerate_279282429.md +++ b/windows.media.devices.core/variablephotosequencecontroller_getcurrentframerate_279282429.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.Core.VariablePhotoSequenceController.GetCurrentFrameRate --api-type: winrt method ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.GetCurrentFrameRate ## -description Gets the current frame rate at which pictures can be taken in a variable photo sequence. ## -returns The current frame rate at which pictures can be taken in a variable photo sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.VariablePhotoSequenceController.GetCurrentFrameRate +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.GetCurrentFrameRate + +## -description +Gets the current frame rate at which pictures can be taken in a variable photo sequence. + +## -returns +The current frame rate at which pictures can be taken in a variable photo sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller_gethighestconcurrentframerate_1293632752.md b/windows.media.devices.core/variablephotosequencecontroller_gethighestconcurrentframerate_1293632752.md index 8080034c08..ebe316e924 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_gethighestconcurrentframerate_1293632752.md +++ b/windows.media.devices.core/variablephotosequencecontroller_gethighestconcurrentframerate_1293632752.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.Core.VariablePhotoSequenceController.GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties) --api-type: winrt method ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.GetHighestConcurrentFrameRate ## -description Gets the highest frame rate supported when video and a variable photo sequence are being captured concurrently. ## -parameters ### -param captureProperties The media encoding properties. ## -returns The highest supported concurrent frame rate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.Core.VariablePhotoSequenceController.GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.GetHighestConcurrentFrameRate + +## -description +Gets the highest frame rate supported when video and a variable photo sequence are being captured concurrently. + +## -parameters +### -param captureProperties +The media encoding properties. + +## -returns +The highest supported concurrent frame rate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller_maxphotospersecond.md b/windows.media.devices.core/variablephotosequencecontroller_maxphotospersecond.md index 2b924edbe5..5063e713d7 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_maxphotospersecond.md +++ b/windows.media.devices.core/variablephotosequencecontroller_maxphotospersecond.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.MaxPhotosPerSecond --api-type: winrt property ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.MaxPhotosPerSecond ## -description Gets the maximum number of photos that can be taken per second in a variable photo sequence. ## -property-value The maximum number of photos that can be taken per second in a variable photo sequence. ## -remarks To set the frame rate of a variable photo sequence, use [PhotosPerSecondLimit](variablephotosequencecontroller_photospersecondlimit.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.MaxPhotosPerSecond +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.MaxPhotosPerSecond + +## -description +Gets the maximum number of photos that can be taken per second in a variable photo sequence. + +## -property-value +The maximum number of photos that can be taken per second in a variable photo sequence. + +## -remarks +To set the frame rate of a variable photo sequence, use [PhotosPerSecondLimit](variablephotosequencecontroller_photospersecondlimit.md). + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller_photospersecondlimit.md b/windows.media.devices.core/variablephotosequencecontroller_photospersecondlimit.md index 674f631a23..c3e317cd9b 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_photospersecondlimit.md +++ b/windows.media.devices.core/variablephotosequencecontroller_photospersecondlimit.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.PhotosPerSecondLimit --api-type: winrt property ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.PhotosPerSecondLimit ## -description Gets or sets the number of photos that are taken per second in a variable photo sequence. ## -property-value The number of photos that are taken per second in a variable photo sequence. ## -remarks To determine the maximum number of photos per second supported by the capture device, check the [MaxPhotosPerSecond](variablephotosequencecontroller_maxphotospersecond.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.PhotosPerSecondLimit +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.PhotosPerSecondLimit + +## -description +Gets or sets the number of photos that are taken per second in a variable photo sequence. + +## -property-value +The number of photos that are taken per second in a variable photo sequence. + +## -remarks +To determine the maximum number of photos per second supported by the capture device, check the [MaxPhotosPerSecond](variablephotosequencecontroller_maxphotospersecond.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices.core/variablephotosequencecontroller_supported.md b/windows.media.devices.core/variablephotosequencecontroller_supported.md index 45bc2d1fe4..faaa883d79 100644 --- a/windows.media.devices.core/variablephotosequencecontroller_supported.md +++ b/windows.media.devices.core/variablephotosequencecontroller_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.Supported --api-type: winrt property ---- # Windows.Media.Devices.Core.VariablePhotoSequenceController.Supported ## -description Gets a value that indicates whether variable photo sequences are supported by the capture device. ## -property-value A value that indicates whether variable photo sequences are supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.Core.VariablePhotoSequenceController.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.Core.VariablePhotoSequenceController.Supported + +## -description +Gets a value that indicates whether variable photo sequences are supported by the capture device. + +## -property-value +A value that indicates whether variable photo sequences are supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/advancedphotocapturesettings.md b/windows.media.devices/advancedphotocapturesettings.md index 76dc504a42..df3cec254e 100644 --- a/windows.media.devices/advancedphotocapturesettings.md +++ b/windows.media.devices/advancedphotocapturesettings.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.AdvancedPhotoCaptureSettings --api-type: winrt class ---- # Windows.Media.Devices.AdvancedPhotoCaptureSettings ## -description Represents settings for an [AdvancedPhotoControl](advancedphotocontrol.md) object. ## -remarks Use this class to configure an instance of the [AdvancedPhotoControl](advancedphotocontrol.md) class by passing it into the [AdvancedPhotoControl.Configure](advancedphotocontrol_configure.md) method. For how-to guidance on using [AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). ## -examples ## -see-also [AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.AdvancedPhotoCaptureSettings +-api-type: winrt class +--- + + + +# Windows.Media.Devices.AdvancedPhotoCaptureSettings + +## -description +Represents settings for an [AdvancedPhotoControl](advancedphotocontrol.md) object. + +## -remarks +Use this class to configure an instance of the [AdvancedPhotoControl](advancedphotocontrol.md) class by passing it into the [AdvancedPhotoControl.Configure](advancedphotocontrol_configure.md) method. + +For how-to guidance on using [AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +## -examples + +## -see-also +[AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file diff --git a/windows.media.devices/advancedphotocapturesettings_advancedphotocapturesettings_1221375020.md b/windows.media.devices/advancedphotocapturesettings_advancedphotocapturesettings_1221375020.md index 02eefc6068..541dfb4fd9 100644 --- a/windows.media.devices/advancedphotocapturesettings_advancedphotocapturesettings_1221375020.md +++ b/windows.media.devices/advancedphotocapturesettings_advancedphotocapturesettings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.AdvancedPhotoCaptureSettings.#ctor --api-type: winrt method ---- # Windows.Media.Devices.AdvancedPhotoCaptureSettings.AdvancedPhotoCaptureSettings ## -description Initializes a new instance of the [AdvancedPhotoCaptureSettings](advancedphotocapturesettings.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.AdvancedPhotoCaptureSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AdvancedPhotoCaptureSettings.AdvancedPhotoCaptureSettings + +## -description +Initializes a new instance of the [AdvancedPhotoCaptureSettings](advancedphotocapturesettings.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/advancedphotocapturesettings_mode.md b/windows.media.devices/advancedphotocapturesettings_mode.md index 9b0ff3b012..48edb57e58 100644 --- a/windows.media.devices/advancedphotocapturesettings_mode.md +++ b/windows.media.devices/advancedphotocapturesettings_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.AdvancedPhotoCaptureSettings.Mode --api-type: winrt property ---- # Windows.Media.Devices.AdvancedPhotoCaptureSettings.Mode ## -description Gets or sets the advanced capture mode for which an [AdvancedPhotoControl](advancedphotocontrol.md) will be configured. ## -property-value The advanced capture mode for which an [AdvancedPhotoControl](advancedphotocontrol.md) will be configured. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.AdvancedPhotoCaptureSettings.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AdvancedPhotoCaptureSettings.Mode + +## -description +Gets or sets the advanced capture mode for which an [AdvancedPhotoControl](advancedphotocontrol.md) will be configured. + +## -property-value +The advanced capture mode for which an [AdvancedPhotoControl](advancedphotocontrol.md) will be configured. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/advancedphotocontrol.md b/windows.media.devices/advancedphotocontrol.md index 19eb18584c..894db8cb3a 100644 --- a/windows.media.devices/advancedphotocontrol.md +++ b/windows.media.devices/advancedphotocontrol.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.AdvancedPhotoControl --api-type: winrt class ---- # Windows.Media.Devices.AdvancedPhotoControl ## -description Provides functionality for controlling the advanced photo capture behavior on a capture device. ## -remarks Get an instance of this class by accessing the [VideoDeviceController.AdvancedPhotoControl](videodevicecontroller_advancedphotocontrol.md) property. For how-to guidance on using [AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). ## -examples ## -see-also [AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.AdvancedPhotoControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.AdvancedPhotoControl + +## -description +Provides functionality for controlling the advanced photo capture behavior on a capture device. + +## -remarks +Get an instance of this class by accessing the [VideoDeviceController.AdvancedPhotoControl](videodevicecontroller_advancedphotocontrol.md) property. + +For how-to guidance on using [AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), see [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +## -examples + +## -see-also +[AdvancedPhotoCapture](../windows.media.capture/advancedphotocapture.md), [High dynamic range (HDR) and low-light photo capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture) \ No newline at end of file diff --git a/windows.media.devices/advancedphotocontrol_configure_232907878.md b/windows.media.devices/advancedphotocontrol_configure_232907878.md index 943c811c82..0384d58396 100644 --- a/windows.media.devices/advancedphotocontrol_configure_232907878.md +++ b/windows.media.devices/advancedphotocontrol_configure_232907878.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Devices.AdvancedPhotoControl.Configure(Windows.Media.Devices.AdvancedPhotoCaptureSettings) --api-type: winrt method ---- # Windows.Media.Devices.AdvancedPhotoControl.Configure ## -description Configures the [AdvancedPhotoControl](advancedphotocontrol.md) object with the specified settings. ## -parameters ### -param settings The object defining the configuration settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.AdvancedPhotoControl.Configure(Windows.Media.Devices.AdvancedPhotoCaptureSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AdvancedPhotoControl.Configure + +## -description +Configures the [AdvancedPhotoControl](advancedphotocontrol.md) object with the specified settings. + +## -parameters +### -param settings +The object defining the configuration settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/advancedphotocontrol_mode.md b/windows.media.devices/advancedphotocontrol_mode.md index 684ad49db5..b847482ab3 100644 --- a/windows.media.devices/advancedphotocontrol_mode.md +++ b/windows.media.devices/advancedphotocontrol_mode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.AdvancedPhotoControl.Mode --api-type: winrt property ---- # Windows.Media.Devices.AdvancedPhotoControl.Mode ## -description Gets the current advanced capture mode of the [AdvancedPhotoControl](advancedphotocontrol.md). ## -property-value The current advanced capture mode of the [AdvancedPhotoControl](advancedphotocontrol.md). ## -remarks Set the advanced capture mode of the [AdvancedPhotoControl](advancedphotocontrol.md) by calling the [Configure](advancedphotocontrol_configure.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.AdvancedPhotoControl.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AdvancedPhotoControl.Mode + +## -description +Gets the current advanced capture mode of the [AdvancedPhotoControl](advancedphotocontrol.md). + +## -property-value +The current advanced capture mode of the [AdvancedPhotoControl](advancedphotocontrol.md). + +## -remarks +Set the advanced capture mode of the [AdvancedPhotoControl](advancedphotocontrol.md) by calling the [Configure](advancedphotocontrol_configure.md) method. + +## -examples + +## -see-also diff --git a/windows.media.devices/advancedphotocontrol_supported.md b/windows.media.devices/advancedphotocontrol_supported.md index 7462c8fde5..1c67396eea 100644 --- a/windows.media.devices/advancedphotocontrol_supported.md +++ b/windows.media.devices/advancedphotocontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.AdvancedPhotoControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.AdvancedPhotoControl.Supported ## -description Gets a value indicating whether the [AdvancedPhotoControl](advancedphotocontrol.md) is supported on the current capture device. ## -property-value True if the [AdvancedPhotoControl](advancedphotocontrol.md) is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.AdvancedPhotoControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AdvancedPhotoControl.Supported + +## -description +Gets a value indicating whether the [AdvancedPhotoControl](advancedphotocontrol.md) is supported on the current capture device. + +## -property-value +True if the [AdvancedPhotoControl](advancedphotocontrol.md) is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/advancedphotocontrol_supportedmodes.md b/windows.media.devices/advancedphotocontrol_supportedmodes.md index 6527175083..52b3829f7c 100644 --- a/windows.media.devices/advancedphotocontrol_supportedmodes.md +++ b/windows.media.devices/advancedphotocontrol_supportedmodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.AdvancedPhotoControl.SupportedModes --api-type: winrt property ---- # Windows.Media.Devices.AdvancedPhotoControl.SupportedModes ## -description Gets a list of the advanced capture modes supported by the current capture device. ## -property-value A list of the advanced capture modes supported by the current capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.AdvancedPhotoControl.SupportedModes +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AdvancedPhotoControl.SupportedModes + +## -description +Gets a list of the advanced capture modes supported by the current capture device. + +## -property-value +A list of the advanced capture modes supported by the current capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/audiodevicecontroller_getavailablemediastreamproperties_946867392.md b/windows.media.devices/audiodevicecontroller_getavailablemediastreamproperties_946867392.md index 4b4cd9af64..bf03219786 100644 --- a/windows.media.devices/audiodevicecontroller_getavailablemediastreamproperties_946867392.md +++ b/windows.media.devices/audiodevicecontroller_getavailablemediastreamproperties_946867392.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.AudioDeviceController.GetAvailableMediaStreamProperties(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Devices.AudioDeviceController.GetAvailableMediaStreamProperties ## -description Gets a list of the supported encoding properties for the device. ## -parameters ### -param mediaStreamType The type of media stream for which to get the properties. ## -returns A list of the supported encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.AudioDeviceController.GetAvailableMediaStreamProperties(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceController.GetAvailableMediaStreamProperties + +## -description +Gets a list of the supported encoding properties for the device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to get the properties. + +## -returns +A list of the supported encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/audiodevicecontroller_getmediastreamproperties_978288466.md b/windows.media.devices/audiodevicecontroller_getmediastreamproperties_978288466.md index 04074420a5..544f10a6c4 100644 --- a/windows.media.devices/audiodevicecontroller_getmediastreamproperties_978288466.md +++ b/windows.media.devices/audiodevicecontroller_getmediastreamproperties_978288466.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.AudioDeviceController.GetMediaStreamProperties(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Devices.AudioDeviceController.GetMediaStreamProperties ## -description Gets the encoding properties for the specified media stream type for the device. ## -parameters ### -param mediaStreamType The type of media stream for which to get the properties. ## -returns The encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.AudioDeviceController.GetMediaStreamProperties(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceController.GetMediaStreamProperties + +## -description +Gets the encoding properties for the specified media stream type for the device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to get the properties. + +## -returns +The encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/audiodevicecontroller_muted.md b/windows.media.devices/audiodevicecontroller_muted.md index d20fe414d4..0ee537abff 100644 --- a/windows.media.devices/audiodevicecontroller_muted.md +++ b/windows.media.devices/audiodevicecontroller_muted.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.AudioDeviceController.Muted --api-type: winrt property ---- # Windows.Media.Devices.AudioDeviceController.Muted ## -description Mutes or unmutes the microphone. ## -property-value True if the microphone is muted; false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.AudioDeviceController.Muted +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceController.Muted + +## -description +Mutes or unmutes the microphone. + +## -property-value +True if the microphone is muted; false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/audiodevicecontroller_setmediastreampropertiesasync_835261048.md b/windows.media.devices/audiodevicecontroller_setmediastreampropertiesasync_835261048.md index 14aa52d993..c2b0d126ac 100644 --- a/windows.media.devices/audiodevicecontroller_setmediastreampropertiesasync_835261048.md +++ b/windows.media.devices/audiodevicecontroller_setmediastreampropertiesasync_835261048.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.AudioDeviceController.SetMediaStreamPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties) --api-type: winrt method ---- # Windows.Media.Devices.AudioDeviceController.SetMediaStreamPropertiesAsync ## -description Sets the encoding properties asynchronously for the specified media stream type for the device. ## -parameters ### -param mediaStreamType The type of media stream for which to set the properties. ### -param mediaEncodingProperties The encoding properties to set. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.AudioDeviceController.SetMediaStreamPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceController.SetMediaStreamPropertiesAsync + +## -description +Sets the encoding properties asynchronously for the specified media stream type for the device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to set the properties. + +### -param mediaEncodingProperties +The encoding properties to set. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/audiodevicecontroller_volumepercent.md b/windows.media.devices/audiodevicecontroller_volumepercent.md index 9be1e13349..a4e70f113d 100644 --- a/windows.media.devices/audiodevicecontroller_volumepercent.md +++ b/windows.media.devices/audiodevicecontroller_volumepercent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.AudioDeviceController.VolumePercent --api-type: winrt property ---- # Windows.Media.Devices.AudioDeviceController.VolumePercent ## -description Gets or sets the volume of the microphone. ## -property-value The volume of the microphone. The value ranges from 0.0 (silent) to 100.0 (full volume). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.AudioDeviceController.VolumePercent +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceController.VolumePercent + +## -description +Gets or sets the volume of the microphone. + +## -property-value +The volume of the microphone. The value ranges from 0.0 (silent) to 100.0 (full volume). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_answerrequested.md b/windows.media.devices/callcontrol_answerrequested.md index 0d4adf6da4..d613d36a5a 100644 --- a/windows.media.devices/callcontrol_answerrequested.md +++ b/windows.media.devices/callcontrol_answerrequested.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.Devices.CallControl.AnswerRequested --api-type: winrt event ---- # Windows.Media.Devices.CallControl.AnswerRequested ## -description Occurs when the device receives a request to answer a call. ## -remarks This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **AnswerRequested**. ## -examples ## -see-also [CallControlEventHandler](callcontroleventhandler.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.CallControl.AnswerRequested +-api-type: winrt event +--- + + + +# Windows.Media.Devices.CallControl.AnswerRequested + +## -description +Occurs when the device receives a request to answer a call. + +## -remarks +This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **AnswerRequested**. + +## -examples + +## -see-also +[CallControlEventHandler](callcontroleventhandler.md) \ No newline at end of file diff --git a/windows.media.devices/callcontrol_audiotransferrequested.md b/windows.media.devices/callcontrol_audiotransferrequested.md index 3e900a91bf..ccc4ba2b32 100644 --- a/windows.media.devices/callcontrol_audiotransferrequested.md +++ b/windows.media.devices/callcontrol_audiotransferrequested.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.Devices.CallControl.AudioTransferRequested --api-type: winrt event ---- # Windows.Media.Devices.CallControl.AudioTransferRequested ## -description Occurs when the device receives a request for an audio transfer. ## -remarks This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **AudioTransferRequested**. ## -examples ## -see-also [CallControlEventHandler](callcontroleventhandler.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.CallControl.AudioTransferRequested +-api-type: winrt event +--- + + + +# Windows.Media.Devices.CallControl.AudioTransferRequested + +## -description +Occurs when the device receives a request for an audio transfer. + +## -remarks +This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **AudioTransferRequested**. + +## -examples + +## -see-also +[CallControlEventHandler](callcontroleventhandler.md) \ No newline at end of file diff --git a/windows.media.devices/callcontrol_dialrequested.md b/windows.media.devices/callcontrol_dialrequested.md index 463c53ea66..e03af7d360 100644 --- a/windows.media.devices/callcontrol_dialrequested.md +++ b/windows.media.devices/callcontrol_dialrequested.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.Devices.CallControl.DialRequested --api-type: winrt event ---- # Windows.Media.Devices.CallControl.DialRequested ## -description Occurs when a number is dialed from the device. ## -remarks This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **DialRequested**. ## -examples ## -see-also [DialRequestedEventHandler](dialrequestedeventhandler.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.CallControl.DialRequested +-api-type: winrt event +--- + + + +# Windows.Media.Devices.CallControl.DialRequested + +## -description +Occurs when a number is dialed from the device. + +## -remarks +This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **DialRequested**. + +## -examples + +## -see-also +[DialRequestedEventHandler](dialrequestedeventhandler.md) \ No newline at end of file diff --git a/windows.media.devices/callcontrol_endcall_107216039.md b/windows.media.devices/callcontrol_endcall_107216039.md index e4012f5b58..e34473fd2b 100644 --- a/windows.media.devices/callcontrol_endcall_107216039.md +++ b/windows.media.devices/callcontrol_endcall_107216039.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Devices.CallControl.EndCall(System.UInt64) --api-type: winrt method ---- # Windows.Media.Devices.CallControl.EndCall ## -description Ends the specified call. ## -parameters ### -param callToken The unique identifier of the specified call. ## -remarks After this method is called, the *callToken* of the specified call is no longer valid. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.CallControl.EndCall(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.CallControl.EndCall + +## -description +Ends the specified call. + +## -parameters +### -param callToken +The unique identifier of the specified call. + +## -remarks +After this method is called, the *callToken* of the specified call is no longer valid. + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_fromid_114571398.md b/windows.media.devices/callcontrol_fromid_114571398.md index d08f869a60..d9848cfcb5 100644 --- a/windows.media.devices/callcontrol_fromid_114571398.md +++ b/windows.media.devices/callcontrol_fromid_114571398.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.CallControl.FromId(System.String) --api-type: winrt method ---- # Windows.Media.Devices.CallControl.FromId ## -description Returns a [CallControl](callcontrol.md) class that represents the audio communications device specified by the [DeviceInformation ID](../windows.devices.enumeration/deviceinformation_id.md) being passed. ## -parameters ### -param deviceId The [DeviceInformation ID](../windows.devices.enumeration/deviceinformation_id.md) of the specified audio communications device. ## -returns A class that represents the specified audio communications device. ## -remarks This method may return a NULL pointer if the device doesn't support this functionality. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.CallControl.FromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.CallControl.FromId + +## -description +Returns a [CallControl](callcontrol.md) class that represents the audio communications device specified by the [DeviceInformation ID](../windows.devices.enumeration/deviceinformation_id.md) being passed. + +## -parameters +### -param deviceId +The [DeviceInformation ID](../windows.devices.enumeration/deviceinformation_id.md) of the specified audio communications device. + +## -returns +A class that represents the specified audio communications device. + +## -remarks +This method may return a NULL pointer if the device doesn't support this functionality. + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_getdefault_846721868.md b/windows.media.devices/callcontrol_getdefault_846721868.md index f5058d8ae6..3822e6729b 100644 --- a/windows.media.devices/callcontrol_getdefault_846721868.md +++ b/windows.media.devices/callcontrol_getdefault_846721868.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Devices.CallControl.GetDefault --api-type: winrt method ---- # Windows.Media.Devices.CallControl.GetDefault ## -description Returns a [CallControl](callcontrol.md) class that represents the default audio communications device. ## -returns A class that represents the default audio communications device. ## -remarks This method may return a NULL pointer if the device doesn't support this functionality. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.CallControl.GetDefault +-api-type: winrt method +--- + + + +# Windows.Media.Devices.CallControl.GetDefault + +## -description +Returns a [CallControl](callcontrol.md) class that represents the default audio communications device. + +## -returns +A class that represents the default audio communications device. + +## -remarks +This method may return a NULL pointer if the device doesn't support this functionality. + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_hanguprequested.md b/windows.media.devices/callcontrol_hanguprequested.md index 97b7698d22..5660d05a88 100644 --- a/windows.media.devices/callcontrol_hanguprequested.md +++ b/windows.media.devices/callcontrol_hanguprequested.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Devices.CallControl.HangUpRequested --api-type: winrt event ---- # Windows.Media.Devices.CallControl.HangUpRequested ## -description Occurs when the device receives a request to hang up a call. ## -remarks This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **HangUpRequested**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.CallControl.HangUpRequested +-api-type: winrt event +--- + + + +# Windows.Media.Devices.CallControl.HangUpRequested + +## -description +Occurs when the device receives a request to hang up a call. + +## -remarks +This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **HangUpRequested**. + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_hasringer.md b/windows.media.devices/callcontrol_hasringer.md index 0bf7f5bdfc..5d92792f4c 100644 --- a/windows.media.devices/callcontrol_hasringer.md +++ b/windows.media.devices/callcontrol_hasringer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.CallControl.HasRinger --api-type: winrt property ---- # Windows.Media.Devices.CallControl.HasRinger ## -description Indicates whether the telephony device has a built-in ringer. ## -property-value A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that is **True** if the telephony device has a ringer, and **False** if it does not. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.CallControl.HasRinger +-api-type: winrt property +--- + + + +# Windows.Media.Devices.CallControl.HasRinger + +## -description +Indicates whether the telephony device has a built-in ringer. + +## -property-value +A [Boolean](https://msdn.microsoft.com/library/system.boolean.aspx) value that is **True** if the telephony device has a ringer, and **False** if it does not. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_indicateactivecall_1650660673.md b/windows.media.devices/callcontrol_indicateactivecall_1650660673.md index 3813936768..4d39971d56 100644 --- a/windows.media.devices/callcontrol_indicateactivecall_1650660673.md +++ b/windows.media.devices/callcontrol_indicateactivecall_1650660673.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Devices.CallControl.IndicateActiveCall(System.UInt64) --api-type: winrt method ---- # Windows.Media.Devices.CallControl.IndicateActiveCall ## -description Indicates that the specified call is now active. ## -parameters ### -param callToken The unique identifier of the specified call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.CallControl.IndicateActiveCall(System.UInt64) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.CallControl.IndicateActiveCall + +## -description +Indicates that the specified call is now active. + +## -parameters +### -param callToken +The unique identifier of the specified call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_indicatenewincomingcall_485379044.md b/windows.media.devices/callcontrol_indicatenewincomingcall_485379044.md index 4004d2ad4b..32618ad0d3 100644 --- a/windows.media.devices/callcontrol_indicatenewincomingcall_485379044.md +++ b/windows.media.devices/callcontrol_indicatenewincomingcall_485379044.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.CallControl.IndicateNewIncomingCall(System.Boolean,System.String) --api-type: winrt method ---- # Windows.Media.Devices.CallControl.IndicateNewIncomingCall ## -description Informs the device that there is an incoming call. ## -parameters ### -param enableRinger Specifies whether the device should activate its built-in ringer. ### -param callerId A numeric string that specifies the incoming caller ID. This parameter can be null, and often is for many VoIP calls. ## -returns A call token that uniquely identifies this call. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.CallControl.IndicateNewIncomingCall(System.Boolean,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.CallControl.IndicateNewIncomingCall + +## -description +Informs the device that there is an incoming call. + +## -parameters +### -param enableRinger +Specifies whether the device should activate its built-in ringer. + +### -param callerId +A numeric string that specifies the incoming caller ID. This parameter can be null, and often is for many VoIP calls. + +## -returns +A call token that uniquely identifies this call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_indicatenewoutgoingcall_390393868.md b/windows.media.devices/callcontrol_indicatenewoutgoingcall_390393868.md index 105d654ca5..9f65e71260 100644 --- a/windows.media.devices/callcontrol_indicatenewoutgoingcall_390393868.md +++ b/windows.media.devices/callcontrol_indicatenewoutgoingcall_390393868.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Devices.CallControl.IndicateNewOutgoingCall --api-type: winrt method ---- # Windows.Media.Devices.CallControl.IndicateNewOutgoingCall ## -description Updates device indicators to indicate an outgoing call. ## -returns A call token that uniquely identifies this call. ## -remarks An application should call this method only after the dialing connection is actually initiated, and not before. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.CallControl.IndicateNewOutgoingCall +-api-type: winrt method +--- + + + +# Windows.Media.Devices.CallControl.IndicateNewOutgoingCall + +## -description +Updates device indicators to indicate an outgoing call. + +## -returns +A call token that uniquely identifies this call. + +## -remarks +An application should call this method only after the dialing connection is actually initiated, and not before. + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_keypadpressed.md b/windows.media.devices/callcontrol_keypadpressed.md index d8ce592534..fdbd9cf58c 100644 --- a/windows.media.devices/callcontrol_keypadpressed.md +++ b/windows.media.devices/callcontrol_keypadpressed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Devices.CallControl.KeypadPressed --api-type: winrt event ---- # Windows.Media.Devices.CallControl.KeypadPressed ## -description Occurs when a keypad button on the device has been pressed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.CallControl.KeypadPressed +-api-type: winrt event +--- + + + +# Windows.Media.Devices.CallControl.KeypadPressed + +## -description +Occurs when a keypad button on the device has been pressed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/callcontrol_redialrequested.md b/windows.media.devices/callcontrol_redialrequested.md index 8f1b692dbc..f632bbd1a4 100644 --- a/windows.media.devices/callcontrol_redialrequested.md +++ b/windows.media.devices/callcontrol_redialrequested.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.Devices.CallControl.RedialRequested --api-type: winrt event ---- # Windows.Media.Devices.CallControl.RedialRequested ## -description Occurs when the device receives a request to redial. ## -remarks This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **RedialRequested**. ## -examples ## -see-also [How to manage calls on the default Bluetooth communications device](http://go.microsoft.com/fwlink/p/?linkid=241435), [RedialRequestedEventHandler](redialrequestedeventhandler.md) \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.CallControl.RedialRequested +-api-type: winrt event +--- + + + +# Windows.Media.Devices.CallControl.RedialRequested + +## -description +Occurs when the device receives a request to redial. + +## -remarks +This class provides access to events that can be monitored and used for modifying the behavior of your telephony-aware app. The following JavaScript code snippet shows how to add event listeners to the **CallControl** class, and then to respond to one of the events, **RedialRequested**. + +## -examples + +## -see-also +[How to manage calls on the default Bluetooth communications device](http://go.microsoft.com/fwlink/p/?linkid=241435), [RedialRequestedEventHandler](redialrequestedeventhandler.md) \ No newline at end of file diff --git a/windows.media.devices/defaultaudiocapturedevicechangedeventargs_id.md b/windows.media.devices/defaultaudiocapturedevicechangedeventargs_id.md index 1bcd71b467..8ebc204593 100644 --- a/windows.media.devices/defaultaudiocapturedevicechangedeventargs_id.md +++ b/windows.media.devices/defaultaudiocapturedevicechangedeventargs_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Id --api-type: winrt property ---- # Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Id ## -description Gets the ID of the newly selected audio capture device that caused the change event. ## -property-value ID of the newly selected audio capture device that caused the change event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Id +-api-type: winrt property +--- + + + +# Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Id + +## -description +Gets the ID of the newly selected audio capture device that caused the change event. + +## -property-value +ID of the newly selected audio capture device that caused the change event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/defaultaudiocapturedevicechangedeventargs_role.md b/windows.media.devices/defaultaudiocapturedevicechangedeventargs_role.md index f0abbc50ef..d2f4ec7518 100644 --- a/windows.media.devices/defaultaudiocapturedevicechangedeventargs_role.md +++ b/windows.media.devices/defaultaudiocapturedevicechangedeventargs_role.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Role --api-type: winrt property ---- # Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Role ## -description Gets the role of the newly selected audio capture device that caused the change event. ## -property-value The role of the newly selected audio capture device that caused the change event. ## -remarks ## -examples ## -see-also [AudioDeviceRole](audiodevicerole.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Role +-api-type: winrt property +--- + + + +# Windows.Media.Devices.DefaultAudioCaptureDeviceChangedEventArgs.Role + +## -description +Gets the role of the newly selected audio capture device that caused the change event. + +## -property-value +The role of the newly selected audio capture device that caused the change event. + +## -remarks + +## -examples + +## -see-also +[AudioDeviceRole](audiodevicerole.md) \ No newline at end of file diff --git a/windows.media.devices/defaultaudiorenderdevicechangedeventargs_id.md b/windows.media.devices/defaultaudiorenderdevicechangedeventargs_id.md index ca53c65afd..eb340a96fe 100644 --- a/windows.media.devices/defaultaudiorenderdevicechangedeventargs_id.md +++ b/windows.media.devices/defaultaudiorenderdevicechangedeventargs_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Id --api-type: winrt property ---- # Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Id ## -description Gets the ID of the newly selected default audio render device that caused the change event. ## -property-value ID of the newly selected default audio render device that caused the change event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Id +-api-type: winrt property +--- + + + +# Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Id + +## -description +Gets the ID of the newly selected default audio render device that caused the change event. + +## -property-value +ID of the newly selected default audio render device that caused the change event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/defaultaudiorenderdevicechangedeventargs_role.md b/windows.media.devices/defaultaudiorenderdevicechangedeventargs_role.md index 85a0dc44bb..ffd807ffd0 100644 --- a/windows.media.devices/defaultaudiorenderdevicechangedeventargs_role.md +++ b/windows.media.devices/defaultaudiorenderdevicechangedeventargs_role.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Role --api-type: winrt property ---- # Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Role ## -description Gets the role of the newly selected default audio render device that caused the change event. ## -property-value The role of the newly selected default audio render device that caused the change event. ## -remarks ## -examples ## -see-also [AudioDeviceRole](audiodevicerole.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Role +-api-type: winrt property +--- + + + +# Windows.Media.Devices.DefaultAudioRenderDeviceChangedEventArgs.Role + +## -description +Gets the role of the newly selected default audio render device that caused the change event. + +## -property-value +The role of the newly selected default audio render device that caused the change event. + +## -remarks + +## -examples + +## -see-also +[AudioDeviceRole](audiodevicerole.md) \ No newline at end of file diff --git a/windows.media.devices/dialrequestedeventargs_contact.md b/windows.media.devices/dialrequestedeventargs_contact.md index 2a104086f3..6eb404ca45 100644 --- a/windows.media.devices/dialrequestedeventargs_contact.md +++ b/windows.media.devices/dialrequestedeventargs_contact.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.DialRequestedEventArgs.Contact --api-type: winrt property ---- # Windows.Media.Devices.DialRequestedEventArgs.Contact ## -description Returns the contact that was dialed. ## -property-value The contact. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.DialRequestedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.Media.Devices.DialRequestedEventArgs.Contact + +## -description +Returns the contact that was dialed. + +## -property-value +The contact. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/dialrequestedeventargs_handled_1519539088.md b/windows.media.devices/dialrequestedeventargs_handled_1519539088.md index d5f2bd8d25..31e71a83b5 100644 --- a/windows.media.devices/dialrequestedeventargs_handled_1519539088.md +++ b/windows.media.devices/dialrequestedeventargs_handled_1519539088.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.DialRequestedEventArgs.Handled --api-type: winrt method ---- # Windows.Media.Devices.DialRequestedEventArgs.Handled ## -description Indicates that the [DialRequested](callcontrol_dialrequested.md) event has been handled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.DialRequestedEventArgs.Handled +-api-type: winrt method +--- + + + +# Windows.Media.Devices.DialRequestedEventArgs.Handled + +## -description +Indicates that the [DialRequested](callcontrol_dialrequested.md) event has been handled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecompensationcontrol.md b/windows.media.devices/exposurecompensationcontrol.md index 22fdd0cbe4..d4a29ce4d7 100644 --- a/windows.media.devices/exposurecompensationcontrol.md +++ b/windows.media.devices/exposurecompensationcontrol.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Media.Devices.ExposureCompensationControl --api-type: winrt class ---- # Windows.Media.Devices.ExposureCompensationControl ## -description Provides functionality for modifying exposure levels of captured photos. ## -remarks [ExposureCompensationControl](exposurecompensationcontrol.md) enables apps to modify exposure levels of captured photos. You can find out if a device supports this control by checking [ExposureCompensationControl.Supported](exposurecompensationcontrol_supported.md). You can access the [ExposureCompensationControl](exposurecompensationcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). For how-to guidance for using the **ExposureCompensationControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.ExposureCompensationControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ExposureCompensationControl + +## -description +Provides functionality for modifying exposure levels of captured photos. + +## -remarks +[ExposureCompensationControl](exposurecompensationcontrol.md) enables apps to modify exposure levels of captured photos. + +You can find out if a device supports this control by checking [ExposureCompensationControl.Supported](exposurecompensationcontrol_supported.md). + +You can access the [ExposureCompensationControl](exposurecompensationcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +For how-to guidance for using the **ExposureCompensationControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/exposurecompensationcontrol_max.md b/windows.media.devices/exposurecompensationcontrol_max.md index ee5d1b11bd..21e72a02b4 100644 --- a/windows.media.devices/exposurecompensationcontrol_max.md +++ b/windows.media.devices/exposurecompensationcontrol_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureCompensationControl.Max --api-type: winrt property ---- # Windows.Media.Devices.ExposureCompensationControl.Max ## -description Gets the maximum exposure time. ## -property-value The maximum exposure time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureCompensationControl.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureCompensationControl.Max + +## -description +Gets the maximum exposure time. + +## -property-value +The maximum exposure time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecompensationcontrol_min.md b/windows.media.devices/exposurecompensationcontrol_min.md index 314fa0c7ef..19e58f0f84 100644 --- a/windows.media.devices/exposurecompensationcontrol_min.md +++ b/windows.media.devices/exposurecompensationcontrol_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureCompensationControl.Min --api-type: winrt property ---- # Windows.Media.Devices.ExposureCompensationControl.Min ## -description Gets the minimum exposure time. ## -property-value The minimum exposure time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureCompensationControl.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureCompensationControl.Min + +## -description +Gets the minimum exposure time. + +## -property-value +The minimum exposure time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecompensationcontrol_setvalueasync_1046046665.md b/windows.media.devices/exposurecompensationcontrol_setvalueasync_1046046665.md index e311d7166d..85f7f8a7c7 100644 --- a/windows.media.devices/exposurecompensationcontrol_setvalueasync_1046046665.md +++ b/windows.media.devices/exposurecompensationcontrol_setvalueasync_1046046665.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Devices.ExposureCompensationControl.SetValueAsync(System.Single) --api-type: winrt method ---- # Windows.Media.Devices.ExposureCompensationControl.SetValueAsync ## -description Asynchronously sets the exposure compensation. ## -parameters ### -param value The exposure compensation level to set the [Value](exposurecompensationcontrol_value.md) property to. The minimum and maximum values are specified by [Min](exposurecompensationcontrol_min.md) and [Max](exposurecompensationcontrol_max.md). ## -returns The object that is used to control the asynchronous operation. ## -remarks The supplied value must be between [Min](exposurecompensationcontrol_min.md) and [Max](exposurecompensationcontrol_max.md), inclusive, in increments of [Step](exposurecompensationcontrol_step.md). If you supply an arbitrary value that does not meet these requirements, the value will not be rounded. Instead, an exception will be thrown. ## -examples ## -see-also [ExposureCompensationControl.Value](exposurecompensationcontrol_value.md), [Min](exposurecompensationcontrol_min.md), [Max](exposurecompensationcontrol_max.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.ExposureCompensationControl.SetValueAsync(System.Single) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.ExposureCompensationControl.SetValueAsync + +## -description +Asynchronously sets the exposure compensation. + +## -parameters +### -param value +The exposure compensation level to set the [Value](exposurecompensationcontrol_value.md) property to. The minimum and maximum values are specified by [Min](exposurecompensationcontrol_min.md) and [Max](exposurecompensationcontrol_max.md). + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks +The supplied value must be between [Min](exposurecompensationcontrol_min.md) and [Max](exposurecompensationcontrol_max.md), inclusive, in increments of [Step](exposurecompensationcontrol_step.md). If you supply an arbitrary value that does not meet these requirements, the value will not be rounded. Instead, an exception will be thrown. + +## -examples + +## -see-also +[ExposureCompensationControl.Value](exposurecompensationcontrol_value.md), [Min](exposurecompensationcontrol_min.md), [Max](exposurecompensationcontrol_max.md) \ No newline at end of file diff --git a/windows.media.devices/exposurecompensationcontrol_step.md b/windows.media.devices/exposurecompensationcontrol_step.md index 9fde16dacb..2bbe8f0a0e 100644 --- a/windows.media.devices/exposurecompensationcontrol_step.md +++ b/windows.media.devices/exposurecompensationcontrol_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureCompensationControl.Step --api-type: winrt property ---- # Windows.Media.Devices.ExposureCompensationControl.Step ## -description Gets the smallest exposure compensation increment supported by the capture device. ## -property-value The smallest exposure compensation increment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureCompensationControl.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureCompensationControl.Step + +## -description +Gets the smallest exposure compensation increment supported by the capture device. + +## -property-value +The smallest exposure compensation increment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecompensationcontrol_supported.md b/windows.media.devices/exposurecompensationcontrol_supported.md index dd7177719a..9a2fc74673 100644 --- a/windows.media.devices/exposurecompensationcontrol_supported.md +++ b/windows.media.devices/exposurecompensationcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureCompensationControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.ExposureCompensationControl.Supported ## -description Gets a value that specifies if the capture device supports the exposure compensation control. ## -property-value **true** if the exposure compensation control is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureCompensationControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureCompensationControl.Supported + +## -description +Gets a value that specifies if the capture device supports the exposure compensation control. + +## -property-value +**true** if the exposure compensation control is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecompensationcontrol_value.md b/windows.media.devices/exposurecompensationcontrol_value.md index 42be180fd1..cb84799e05 100644 --- a/windows.media.devices/exposurecompensationcontrol_value.md +++ b/windows.media.devices/exposurecompensationcontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureCompensationControl.Value --api-type: winrt property ---- # Windows.Media.Devices.ExposureCompensationControl.Value ## -description Gets the exposure compensation level. ## -property-value The exposure time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureCompensationControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureCompensationControl.Value + +## -description +Gets the exposure compensation level. + +## -property-value +The exposure time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol.md b/windows.media.devices/exposurecontrol.md index 14f24bd02e..0051ac411a 100644 --- a/windows.media.devices/exposurecontrol.md +++ b/windows.media.devices/exposurecontrol.md @@ -1,3 +1,31 @@ ---- -api-id: T:Windows.Media.Devices.ExposureControl --api-type: winrt class ---- # Windows.Media.Devices.ExposureControl ## -description Provides functionality for controlling the exposure settings on a capture device. ## -remarks The [ExposureControl](exposurecontrol.md) gives apps additional control over the exposure settings on a device. To set an exposure value, call [SetValueAsync](exposurecontrol_setvalueasync.md). To turn auto exposure on, call [SetAutoAsync](exposurecontrol_setautoasync.md). You can find out if a device supports this control by checking [ExposureControl.Supported](exposurecontrol_supported.md). If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the exposure value. You can access the [ExposureControl](exposurecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). For how-to guidance for using the **ExposureControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.ExposureControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ExposureControl + +## -description +Provides functionality for controlling the exposure settings on a capture device. + +## -remarks +The [ExposureControl](exposurecontrol.md) gives apps additional control over the exposure settings on a device. + +To set an exposure value, call [SetValueAsync](exposurecontrol_setvalueasync.md). To turn auto exposure on, call [SetAutoAsync](exposurecontrol_setautoasync.md). + +You can find out if a device supports this control by checking [ExposureControl.Supported](exposurecontrol_supported.md). + +If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the exposure value. + +You can access the [ExposureControl](exposurecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +For how-to guidance for using the **ExposureControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/exposurecontrol_auto.md b/windows.media.devices/exposurecontrol_auto.md index 5029858880..dfc6c59703 100644 --- a/windows.media.devices/exposurecontrol_auto.md +++ b/windows.media.devices/exposurecontrol_auto.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.ExposureControl.Auto --api-type: winrt property ---- # Windows.Media.Devices.ExposureControl.Auto ## -description Gets a value that indicates if auto exposure is enabled. ## -property-value **true** if auto exposure is enabled; otherwise, **false**. ## -remarks Automatic exposure mode is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on automatic exposure. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Auto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Auto + +## -description +Gets a value that indicates if auto exposure is enabled. + +## -property-value +**true** if auto exposure is enabled; otherwise, **false**. + +## -remarks +Automatic exposure mode is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on automatic exposure. + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol_max.md b/windows.media.devices/exposurecontrol_max.md index 1532135cb9..3d58d5fced 100644 --- a/windows.media.devices/exposurecontrol_max.md +++ b/windows.media.devices/exposurecontrol_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureControl.Max --api-type: winrt property ---- # Windows.Media.Devices.ExposureControl.Max ## -description Gets the maximum exposure time. ## -property-value The maximum exposure time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Max + +## -description +Gets the maximum exposure time. + +## -property-value +The maximum exposure time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol_min.md b/windows.media.devices/exposurecontrol_min.md index 701f87076b..a570ac2bab 100644 --- a/windows.media.devices/exposurecontrol_min.md +++ b/windows.media.devices/exposurecontrol_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureControl.Min --api-type: winrt property ---- # Windows.Media.Devices.ExposureControl.Min ## -description Gets the minimum exposure time. ## -property-value The minimum exposure time. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Min + +## -description +Gets the minimum exposure time. + +## -property-value +The minimum exposure time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol_setautoasync_1168787363.md b/windows.media.devices/exposurecontrol_setautoasync_1168787363.md index 71ba7aeda4..dfc63aac5f 100644 --- a/windows.media.devices/exposurecontrol_setautoasync_1168787363.md +++ b/windows.media.devices/exposurecontrol_setautoasync_1168787363.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.ExposureControl.SetAutoAsync(System.Boolean) --api-type: winrt method ---- # Windows.Media.Devices.ExposureControl.SetAutoAsync ## -description Asynchronously enables or disable auto exposure. ## -parameters ### -param value Specifies whether or not to enable or disable auto exposure. ## -returns The object that is used to control the asynchronous operation. ## -remarks Automatic exposure adjustment is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on automatic exposure mode. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.ExposureControl.SetAutoAsync(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.ExposureControl.SetAutoAsync + +## -description +Asynchronously enables or disable auto exposure. + +## -parameters +### -param value +Specifies whether or not to enable or disable auto exposure. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks +Automatic exposure adjustment is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on automatic exposure mode. + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol_setvalueasync_1247308686.md b/windows.media.devices/exposurecontrol_setvalueasync_1247308686.md index e04ca1359f..618cf51641 100644 --- a/windows.media.devices/exposurecontrol_setvalueasync_1247308686.md +++ b/windows.media.devices/exposurecontrol_setvalueasync_1247308686.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.ExposureControl.SetValueAsync(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Devices.ExposureControl.SetValueAsync ## -description Asynchronously sets the exposure time. ## -parameters ### -param shutterDuration The exposure time to set the [Value](exposurecontrol_value.md) property to. The minimum and maximum values are specified by [Min](exposurecontrol_min.md) and [Max](exposurecontrol_max.md). ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [ExposureControl.Value](exposurecontrol_value.md), [Min](exposurecontrol_min.md), [Max](exposurecontrol_max.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.ExposureControl.SetValueAsync(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.ExposureControl.SetValueAsync + +## -description +Asynchronously sets the exposure time. + +## -parameters +### -param shutterDuration +The exposure time to set the [Value](exposurecontrol_value.md) property to. The minimum and maximum values are specified by [Min](exposurecontrol_min.md) and [Max](exposurecontrol_max.md). + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[ExposureControl.Value](exposurecontrol_value.md), [Min](exposurecontrol_min.md), [Max](exposurecontrol_max.md) \ No newline at end of file diff --git a/windows.media.devices/exposurecontrol_step.md b/windows.media.devices/exposurecontrol_step.md index a89d5ac013..1fae4b7393 100644 --- a/windows.media.devices/exposurecontrol_step.md +++ b/windows.media.devices/exposurecontrol_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposureControl.Step --api-type: winrt property ---- # Windows.Media.Devices.ExposureControl.Step ## -description Gets the smallest exposure time increment supported by the capture device. ## -property-value The smallest exposure time increment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Step + +## -description +Gets the smallest exposure time increment supported by the capture device. + +## -property-value +The smallest exposure time increment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol_supported.md b/windows.media.devices/exposurecontrol_supported.md index 294acb4115..27bc8fa9a4 100644 --- a/windows.media.devices/exposurecontrol_supported.md +++ b/windows.media.devices/exposurecontrol_supported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.ExposureControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.ExposureControl.Supported ## -description Gets a value that specifies if the capture device supports the exposure control. ## -property-value **true** if the exposure control is supported; otherwise, **false**. ## -remarks If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the exposure value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Supported + +## -description +Gets a value that specifies if the capture device supports the exposure control. + +## -property-value +**true** if the exposure control is supported; otherwise, **false**. + +## -remarks +If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the exposure value. + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurecontrol_value.md b/windows.media.devices/exposurecontrol_value.md index f377a00ab3..c50d513ff3 100644 --- a/windows.media.devices/exposurecontrol_value.md +++ b/windows.media.devices/exposurecontrol_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.ExposureControl.Value --api-type: winrt property ---- # Windows.Media.Devices.ExposureControl.Value ## -description Gets the exposure time. ## -property-value The exposure time. ## -remarks To set an exposure value, call [SetValueAsync](exposurecontrol_setvalueasync.md) specifying a value between the [Min](exposurecontrol_min.md) and [Max](exposurecontrol_max.md) exposure values. To turn auto exposure on, call [SetAutoAsync](exposurecontrol_setautoasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Value + +## -description +Gets the exposure time. + +## -property-value +The exposure time. + +## -remarks +To set an exposure value, call [SetValueAsync](exposurecontrol_setvalueasync.md) specifying a value between the [Min](exposurecontrol_min.md) and [Max](exposurecontrol_max.md) exposure values. To turn auto exposure on, call [SetAutoAsync](exposurecontrol_setautoasync.md). + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurepriorityvideocontrol.md b/windows.media.devices/exposurepriorityvideocontrol.md index 734ee52e39..263de29bb0 100644 --- a/windows.media.devices/exposurepriorityvideocontrol.md +++ b/windows.media.devices/exposurepriorityvideocontrol.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.ExposurePriorityVideoControl --api-type: winrt class ---- # Windows.Media.Devices.ExposurePriorityVideoControl ## -description When supported, allows an app to specify whether the camera driver can dynamically adjust the frame rate of video capture in order to improve video quality in low-light conditions. ## -remarks When the [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is enabled, the driver may adjust the frame rate in order to compensate for low-light conditions. Apps that require a constant frame rate should disable this control. For how-to guidance for using manual video capture controls, see [Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture). ## -examples ## -see-also [Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.ExposurePriorityVideoControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ExposurePriorityVideoControl + +## -description +When supported, allows an app to specify whether the camera driver can dynamically adjust the frame rate of video capture in order to improve video quality in low-light conditions. + +## -remarks +When the [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is enabled, the driver may adjust the frame rate in order to compensate for low-light conditions. Apps that require a constant frame rate should disable this control. + +For how-to guidance for using manual video capture controls, see [Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture). + +## -examples + +## -see-also +[Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture) \ No newline at end of file diff --git a/windows.media.devices/exposurepriorityvideocontrol_enabled.md b/windows.media.devices/exposurepriorityvideocontrol_enabled.md index be0b4a9b2f..ed04bd6807 100644 --- a/windows.media.devices/exposurepriorityvideocontrol_enabled.md +++ b/windows.media.devices/exposurepriorityvideocontrol_enabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposurePriorityVideoControl.Enabled --api-type: winrt property ---- # Windows.Media.Devices.ExposurePriorityVideoControl.Enabled ## -description Gets or sets a value that specifies if [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is enabled. ## -property-value True if [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposurePriorityVideoControl.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposurePriorityVideoControl.Enabled + +## -description +Gets or sets a value that specifies if [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is enabled. + +## -property-value +True if [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/exposurepriorityvideocontrol_supported.md b/windows.media.devices/exposurepriorityvideocontrol_supported.md index 3013328384..d35bc18be3 100644 --- a/windows.media.devices/exposurepriorityvideocontrol_supported.md +++ b/windows.media.devices/exposurepriorityvideocontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ExposurePriorityVideoControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.ExposurePriorityVideoControl.Supported ## -description Gets or sets a value that specifies if [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is supported on the current device. ## -property-value True if the [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ExposurePriorityVideoControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposurePriorityVideoControl.Supported + +## -description +Gets or sets a value that specifies if [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is supported on the current device. + +## -property-value +True if the [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol.md b/windows.media.devices/flashcontrol.md index 1f7f02ae70..862ada8528 100644 --- a/windows.media.devices/flashcontrol.md +++ b/windows.media.devices/flashcontrol.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Media.Devices.FlashControl --api-type: winrt class ---- # Windows.Media.Devices.FlashControl ## -description Provides functionality for controlling the flash settings on a capture device. ## -remarks The [FlashControl](flashcontrol.md) enable apps to manage the flash on a device. This can be used in a photo app to handle low-light conditions or for [RedEyeReduction](flashcontrol_redeyereduction.md). You can find out if a device supports this control by checking [FlashControl.Supported](flashcontrol_supported.md). You can access the [FlashControl](flashcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). For how-to guidance for using the **FlashControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.FlashControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.FlashControl + +## -description +Provides functionality for controlling the flash settings on a capture device. + +## -remarks +The [FlashControl](flashcontrol.md) enable apps to manage the flash on a device. This can be used in a photo app to handle low-light conditions or for [RedEyeReduction](flashcontrol_redeyereduction.md). + +You can find out if a device supports this control by checking [FlashControl.Supported](flashcontrol_supported.md). + +You can access the [FlashControl](flashcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +For how-to guidance for using the **FlashControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/flashcontrol_assistantlightenabled.md b/windows.media.devices/flashcontrol_assistantlightenabled.md index d33cd54e21..fe55948e2c 100644 --- a/windows.media.devices/flashcontrol_assistantlightenabled.md +++ b/windows.media.devices/flashcontrol_assistantlightenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.AssistantLightEnabled --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.AssistantLightEnabled ## -description Gets or sets a value indicating whether focus assist light is enabled on the capture device. ## -property-value A value indicating whether focus assist light is enabled on the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.AssistantLightEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.AssistantLightEnabled + +## -description +Gets or sets a value indicating whether focus assist light is enabled on the capture device. + +## -property-value +A value indicating whether focus assist light is enabled on the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_assistantlightsupported.md b/windows.media.devices/flashcontrol_assistantlightsupported.md index 0228f15050..cc57254a29 100644 --- a/windows.media.devices/flashcontrol_assistantlightsupported.md +++ b/windows.media.devices/flashcontrol_assistantlightsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.AssistantLightSupported --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.AssistantLightSupported ## -description Gets a value indicating whether focus assist light is supported by the capture device. ## -property-value A value indicating whether focus assist light is supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.AssistantLightSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.AssistantLightSupported + +## -description +Gets a value indicating whether focus assist light is supported by the capture device. + +## -property-value +A value indicating whether focus assist light is supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_auto.md b/windows.media.devices/flashcontrol_auto.md index 6afbcb8eb7..8491455ae5 100644 --- a/windows.media.devices/flashcontrol_auto.md +++ b/windows.media.devices/flashcontrol_auto.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.Auto --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.Auto ## -description Gets or sets a value that specifies if flash is automatically set. ## -property-value **true** if auto flash is set; otherwise, **false**. ## -remarks You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.Auto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.Auto + +## -description +Gets or sets a value that specifies if flash is automatically set. + +## -property-value +**true** if auto flash is set; otherwise, **false**. + +## -remarks +You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_enabled.md b/windows.media.devices/flashcontrol_enabled.md index b58e59f404..2bc39da545 100644 --- a/windows.media.devices/flashcontrol_enabled.md +++ b/windows.media.devices/flashcontrol_enabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.Enabled --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.Enabled ## -description Gets a value that specifies if the flash on the capture device is enabled or disabled. ## -property-value **true** if the flash is enabled; otherwise, **false**. ## -remarks You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.Enabled + +## -description +Gets a value that specifies if the flash on the capture device is enabled or disabled. + +## -property-value +**true** if the flash is enabled; otherwise, **false**. + +## -remarks +You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_powerpercent.md b/windows.media.devices/flashcontrol_powerpercent.md index 76ec5d9a5b..f43ac82f2c 100644 --- a/windows.media.devices/flashcontrol_powerpercent.md +++ b/windows.media.devices/flashcontrol_powerpercent.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.PowerPercent --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.PowerPercent ## -description Gets or sets the intensity of the flash. ## -property-value The power percent the torch LED is set to. ## -remarks You should check the value of the [FlashControl](flashcontrol.md) object's [PowerSupported](flashcontrol_powersupported.md) property before attempting to access this property. If [PowerSupported](flashcontrol_powersupported.md) is false, attempting to access this property will throw an exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.PowerPercent +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.PowerPercent + +## -description +Gets or sets the intensity of the flash. + +## -property-value +The power percent the torch LED is set to. + +## -remarks +You should check the value of the [FlashControl](flashcontrol.md) object's [PowerSupported](flashcontrol_powersupported.md) property before attempting to access this property. If [PowerSupported](flashcontrol_powersupported.md) is false, attempting to access this property will throw an exception. + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_powersupported.md b/windows.media.devices/flashcontrol_powersupported.md index 6ac03f0b9b..50195c0738 100644 --- a/windows.media.devices/flashcontrol_powersupported.md +++ b/windows.media.devices/flashcontrol_powersupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.PowerSupported --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.PowerSupported ## -description Gets a value that specifics if the device allows the torch LED power settings to be changed. ## -property-value **true** if the device allows the torch LED power settings to be changed; otherwise, **false**. ## -remarks You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.PowerSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.PowerSupported + +## -description +Gets a value that specifics if the device allows the torch LED power settings to be changed. + +## -property-value +**true** if the device allows the torch LED power settings to be changed; otherwise, **false**. + +## -remarks +You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_redeyereduction.md b/windows.media.devices/flashcontrol_redeyereduction.md index 3fc7ab9bdc..1e94a9fc92 100644 --- a/windows.media.devices/flashcontrol_redeyereduction.md +++ b/windows.media.devices/flashcontrol_redeyereduction.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.RedEyeReduction --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.RedEyeReduction ## -description Gets a value that specifies if the red eye reduction is enabled or disabled. ## -property-value **true** if red eye reduction is enabled; otherwise, **false**. ## -remarks You should check the value of the [FlashControl](flashcontrol.md) object's [RedEyeReductionSupported](flashcontrol_redeyereductionsupported.md) property before attempting to access this property. If [RedEyeReductionSupported](flashcontrol_redeyereductionsupported.md) is false, attempting to access this property will throw an exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.RedEyeReduction +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.RedEyeReduction + +## -description +Gets a value that specifies if the red eye reduction is enabled or disabled. + +## -property-value +**true** if red eye reduction is enabled; otherwise, **false**. + +## -remarks +You should check the value of the [FlashControl](flashcontrol.md) object's [RedEyeReductionSupported](flashcontrol_redeyereductionsupported.md) property before attempting to access this property. If [RedEyeReductionSupported](flashcontrol_redeyereductionsupported.md) is false, attempting to access this property will throw an exception. + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_redeyereductionsupported.md b/windows.media.devices/flashcontrol_redeyereductionsupported.md index 9eb50c670c..332c3ff31c 100644 --- a/windows.media.devices/flashcontrol_redeyereductionsupported.md +++ b/windows.media.devices/flashcontrol_redeyereductionsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.RedEyeReductionSupported --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.RedEyeReductionSupported ## -description Gets a value that specifies if the capture device supports red eye reduction. ## -property-value **true** if the capture device supports red eye reduction; otherwise, **false**. ## -remarks You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.RedEyeReductionSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.RedEyeReductionSupported + +## -description +Gets a value that specifies if the capture device supports red eye reduction. + +## -property-value +**true** if the capture device supports red eye reduction; otherwise, **false**. + +## -remarks +You should check the value of the [FlashControl](flashcontrol.md) object's [Supported](flashcontrol_supported.md) property before attempting to access this property. If [Supported](flashcontrol_supported.md) is false, attempting to access this property will throw an exception. + +## -examples + +## -see-also diff --git a/windows.media.devices/flashcontrol_supported.md b/windows.media.devices/flashcontrol_supported.md index 10f2135539..76d5089c1e 100644 --- a/windows.media.devices/flashcontrol_supported.md +++ b/windows.media.devices/flashcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FlashControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.FlashControl.Supported ## -description Gets a value that specifies if the capture device supports the flash control. ## -property-value **true** if the capture device supports the [FlashControl](flashcontrol.md); otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FlashControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FlashControl.Supported + +## -description +Gets a value that specifies if the capture device supports the flash control. + +## -property-value +**true** if the capture device supports the [FlashControl](flashcontrol.md); otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol.md b/windows.media.devices/focuscontrol.md index a9cb0d87cf..806194d209 100644 --- a/windows.media.devices/focuscontrol.md +++ b/windows.media.devices/focuscontrol.md @@ -1,3 +1,31 @@ ---- -api-id: T:Windows.Media.Devices.FocusControl --api-type: winrt class ---- # Windows.Media.Devices.FocusControl ## -description Provides functionality for controlling the focus settings on a capture device. ## -remarks You can find out if a device supports this control by checking [FocusControl.Supported](focuscontrol_supported.md). If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the focus value. You can access the [FocusControl](focuscontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). The [FocusControl](focuscontrol.md) gives apps additional control over the focus settings on a device. You can use one of the [FocusPreset](focuspreset.md) values by calling [SetPresetAsync](focuscontrol_setpresetasync.md). Or call [SetValueAsync](focuscontrol_setvalueasync.md) to set a specific [Value](focuscontrol_value.md) between the [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.FocusControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.FocusControl + +## -description +Provides functionality for controlling the focus settings on a capture device. + +## -remarks +You can find out if a device supports this control by checking [FocusControl.Supported](focuscontrol_supported.md). + +If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the focus value. + +You can access the [FocusControl](focuscontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +The [FocusControl](focuscontrol.md) gives apps additional control over the focus settings on a device. + +You can use one of the [FocusPreset](focuspreset.md) values by calling [SetPresetAsync](focuscontrol_setpresetasync.md). Or call [SetValueAsync](focuscontrol_setvalueasync.md) to set a specific [Value](focuscontrol_value.md) between the [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). + +For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/focuscontrol_configure_1968380006.md b/windows.media.devices/focuscontrol_configure_1968380006.md index 2337d4c03e..0f6e9ae0fb 100644 --- a/windows.media.devices/focuscontrol_configure_1968380006.md +++ b/windows.media.devices/focuscontrol_configure_1968380006.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.Configure(Windows.Media.Devices.FocusSettings) --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.Configure ## -description Configures the [FocusControl](focuscontrol.md) object with values specified in the provided [FocusSettings](focussettings.md) object. ## -parameters ### -param settings The focus settings to use to configure the [FocusControl](focuscontrol.md) object. ## -remarks Autofocus mode, enabled by using the [FocusMode.Continuous](focusmode.md) value in the [FocusSettings](focussettings.md) object supplied to this method, is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on continuous autofocus. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.Configure(Windows.Media.Devices.FocusSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.Configure + +## -description +Configures the [FocusControl](focuscontrol.md) object with values specified in the provided [FocusSettings](focussettings.md) object. + +## -parameters +### -param settings +The focus settings to use to configure the [FocusControl](focuscontrol.md) object. + +## -remarks +Autofocus mode, enabled by using the [FocusMode.Continuous](focusmode.md) value in the [FocusSettings](focussettings.md) object supplied to this method, is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on continuous autofocus. + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_focusasync_1413167028.md b/windows.media.devices/focuscontrol_focusasync_1413167028.md index 706ae078ab..344e0b5090 100644 --- a/windows.media.devices/focuscontrol_focusasync_1413167028.md +++ b/windows.media.devices/focuscontrol_focusasync_1413167028.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.FocusAsync --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.FocusAsync ## -description Asynchronously focuses the device. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.FocusAsync +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.FocusAsync + +## -description +Asynchronously focuses the device. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_focuschangedsupported.md b/windows.media.devices/focuscontrol_focuschangedsupported.md index c35f794743..74b222548d 100644 --- a/windows.media.devices/focuscontrol_focuschangedsupported.md +++ b/windows.media.devices/focuscontrol_focuschangedsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.FocusChangedSupported --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.FocusChangedSupported ## -description Gets a value that specifics if the capture device supports the [FocusChanged](../windows.media.capture/mediacapture_focuschanged.md) event. ## -property-value **true** if the focus changed event is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.FocusChangedSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.FocusChangedSupported + +## -description +Gets a value that specifics if the capture device supports the [FocusChanged](../windows.media.capture/mediacapture_focuschanged.md) event. + +## -property-value +**true** if the focus changed event is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_focusstate.md b/windows.media.devices/focuscontrol_focusstate.md index 79fa6f2b3c..f6f14b5d1e 100644 --- a/windows.media.devices/focuscontrol_focusstate.md +++ b/windows.media.devices/focuscontrol_focusstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.FocusState --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.FocusState ## -description Gets a [MediaCaptureFocusState](mediacapturefocusstate.md) value indicating the current focus state of the capture device. ## -property-value A value indicating the current focus state of the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.FocusState +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.FocusState + +## -description +Gets a [MediaCaptureFocusState](mediacapturefocusstate.md) value indicating the current focus state of the capture device. + +## -property-value +A value indicating the current focus state of the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_lockasync_1653754659.md b/windows.media.devices/focuscontrol_lockasync_1653754659.md index 935812c8ac..07273a5ece 100644 --- a/windows.media.devices/focuscontrol_lockasync_1653754659.md +++ b/windows.media.devices/focuscontrol_lockasync_1653754659.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.LockAsync --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.LockAsync ## -description Locks the capture device's focus. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.LockAsync +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.LockAsync + +## -description +Locks the capture device's focus. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_max.md b/windows.media.devices/focuscontrol_max.md index 07600c23bb..1c7a45d3f8 100644 --- a/windows.media.devices/focuscontrol_max.md +++ b/windows.media.devices/focuscontrol_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Max --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Max ## -description Gets the maximum focus length. ## -property-value The maximum focus. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Max + +## -description +Gets the maximum focus length. + +## -property-value +The maximum focus. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_min.md b/windows.media.devices/focuscontrol_min.md index 100b76c55e..cab9d5384f 100644 --- a/windows.media.devices/focuscontrol_min.md +++ b/windows.media.devices/focuscontrol_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Min --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Min ## -description Gets the minimum focus length. ## -property-value The minimum focus length. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Min + +## -description +Gets the minimum focus length. + +## -property-value +The minimum focus length. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_mode.md b/windows.media.devices/focuscontrol_mode.md index a0f6d832c3..759e881ff0 100644 --- a/windows.media.devices/focuscontrol_mode.md +++ b/windows.media.devices/focuscontrol_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Mode --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Mode ## -description Gets the capture device's current focus mode. ## -property-value The capture device's current focus mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Mode + +## -description +Gets the capture device's current focus mode. + +## -property-value +The capture device's current focus mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_preset.md b/windows.media.devices/focuscontrol_preset.md index 587d6286d1..54b9afd42b 100644 --- a/windows.media.devices/focuscontrol_preset.md +++ b/windows.media.devices/focuscontrol_preset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Preset --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Preset ## -description Gets the focus preset. ## -property-value The focus preset. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Preset +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Preset + +## -description +Gets the focus preset. + +## -property-value +The focus preset. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_setpresetasync_183048954.md b/windows.media.devices/focuscontrol_setpresetasync_183048954.md index 5991e0da0b..9cf04ff986 100644 --- a/windows.media.devices/focuscontrol_setpresetasync_183048954.md +++ b/windows.media.devices/focuscontrol_setpresetasync_183048954.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.SetPresetAsync(Windows.Media.Devices.FocusPreset) --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.SetPresetAsync ## -description Asynchronously sets the focus [Preset](focuscontrol_preset.md). ## -parameters ### -param preset The focus preset to set the [Preset](focuscontrol_preset.md) property to. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [SetPresetAsync(FocusPreset, Boolean)](focuscontrol_setpresetasync_393728766.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.SetPresetAsync(Windows.Media.Devices.FocusPreset) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.SetPresetAsync + +## -description +Asynchronously sets the focus [Preset](focuscontrol_preset.md). + +## -parameters +### -param preset +The focus preset to set the [Preset](focuscontrol_preset.md) property to. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[SetPresetAsync(FocusPreset, Boolean)](focuscontrol_setpresetasync_393728766.md) \ No newline at end of file diff --git a/windows.media.devices/focuscontrol_setpresetasync_393728766.md b/windows.media.devices/focuscontrol_setpresetasync_393728766.md index 7be541045e..6abb2dca6c 100644 --- a/windows.media.devices/focuscontrol_setpresetasync_393728766.md +++ b/windows.media.devices/focuscontrol_setpresetasync_393728766.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.SetPresetAsync(Windows.Media.Devices.FocusPreset,System.Boolean) --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.SetPresetAsync ## -description Asynchronously sets the focus [Preset](focuscontrol_preset.md), specifying if the operation must complete before the device is focused. ## -parameters ### -param preset The focus preset to set the [Preset](focuscontrol_preset.md) property to. ### -param completeBeforeFocus Specifies if the asynchronous operation must complete before the device is focused. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [SetPresetAsync(FocusPreset)](focuscontrol_setpresetasync_183048954.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.SetPresetAsync(Windows.Media.Devices.FocusPreset,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.SetPresetAsync + +## -description +Asynchronously sets the focus [Preset](focuscontrol_preset.md), specifying if the operation must complete before the device is focused. + +## -parameters +### -param preset +The focus preset to set the [Preset](focuscontrol_preset.md) property to. + +### -param completeBeforeFocus +Specifies if the asynchronous operation must complete before the device is focused. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[SetPresetAsync(FocusPreset)](focuscontrol_setpresetasync_183048954.md) \ No newline at end of file diff --git a/windows.media.devices/focuscontrol_setvalueasync_2096210171.md b/windows.media.devices/focuscontrol_setvalueasync_2096210171.md index 7716b24c40..2dd0b4770b 100644 --- a/windows.media.devices/focuscontrol_setvalueasync_2096210171.md +++ b/windows.media.devices/focuscontrol_setvalueasync_2096210171.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.SetValueAsync(System.UInt32) --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.SetValueAsync ## -description Asynchronously sets the focus [Value](whitebalancecontrol_value.md). ## -parameters ### -param focus The value to set the focus to. The minimum and maximum values are specified by [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [Min](focuscontrol_min.md), [Max](focuscontrol_max.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.SetValueAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.SetValueAsync + +## -description +Asynchronously sets the focus [Value](whitebalancecontrol_value.md). + +## -parameters +### -param focus +The value to set the focus to. The minimum and maximum values are specified by [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[Min](focuscontrol_min.md), [Max](focuscontrol_max.md) \ No newline at end of file diff --git a/windows.media.devices/focuscontrol_step.md b/windows.media.devices/focuscontrol_step.md index 6f16d1184d..803c3bca55 100644 --- a/windows.media.devices/focuscontrol_step.md +++ b/windows.media.devices/focuscontrol_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Step --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Step ## -description Gets the smallest focus increment supported by the capture device. ## -property-value The smallest focus increment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Step + +## -description +Gets the smallest focus increment supported by the capture device. + +## -property-value +The smallest focus increment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_supported.md b/windows.media.devices/focuscontrol_supported.md index a56663000f..e2c544fd60 100644 --- a/windows.media.devices/focuscontrol_supported.md +++ b/windows.media.devices/focuscontrol_supported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Supported ## -description Gets a value that specifies if the capture device supports the focus control. ## -property-value **true** if the capture device supports the [FocusControl](focuscontrol.md); otherwise, **false**. ## -remarks If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the focus value. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Supported + +## -description +Gets a value that specifies if the capture device supports the focus control. + +## -property-value +**true** if the capture device supports the [FocusControl](focuscontrol.md); otherwise, **false**. + +## -remarks +If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the focus value. + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_supportedfocusdistances.md b/windows.media.devices/focuscontrol_supportedfocusdistances.md index 8126e19cfa..8544bacaf9 100644 --- a/windows.media.devices/focuscontrol_supportedfocusdistances.md +++ b/windows.media.devices/focuscontrol_supportedfocusdistances.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.SupportedFocusDistances --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.SupportedFocusDistances ## -description Gets a list of values indicating the manual focus distances that are supported by the capture device. ## -property-value A list of values indicating the manual focus distances that are supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.SupportedFocusDistances +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.SupportedFocusDistances + +## -description +Gets a list of values indicating the manual focus distances that are supported by the capture device. + +## -property-value +A list of values indicating the manual focus distances that are supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_supportedfocusmodes.md b/windows.media.devices/focuscontrol_supportedfocusmodes.md index ff1201142e..d32a8814f2 100644 --- a/windows.media.devices/focuscontrol_supportedfocusmodes.md +++ b/windows.media.devices/focuscontrol_supportedfocusmodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.SupportedFocusModes --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.SupportedFocusModes ## -description Gets a list of values indicating the focus modes that are supported by the capture device. ## -property-value A list of values indicating the focus modes that are supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.SupportedFocusModes +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.SupportedFocusModes + +## -description +Gets a list of values indicating the focus modes that are supported by the capture device. + +## -property-value +A list of values indicating the focus modes that are supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_supportedfocusranges.md b/windows.media.devices/focuscontrol_supportedfocusranges.md index e8b64b29d7..8b39d75248 100644 --- a/windows.media.devices/focuscontrol_supportedfocusranges.md +++ b/windows.media.devices/focuscontrol_supportedfocusranges.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.SupportedFocusRanges --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.SupportedFocusRanges ## -description Gets a list of values indicating the auto focus ranges that are supported by the capture device. ## -property-value A list of values indicating the auto focus ranges that are supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.SupportedFocusRanges +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.SupportedFocusRanges + +## -description +Gets a list of values indicating the auto focus ranges that are supported by the capture device. + +## -property-value +A list of values indicating the auto focus ranges that are supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_supportedpresets.md b/windows.media.devices/focuscontrol_supportedpresets.md index 6fdca8e560..cac86f30b8 100644 --- a/windows.media.devices/focuscontrol_supportedpresets.md +++ b/windows.media.devices/focuscontrol_supportedpresets.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.SupportedPresets --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.SupportedPresets ## -description Gets the focus presets that the capture device supports. ## -property-value The supported focus presets. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.SupportedPresets +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.SupportedPresets + +## -description +Gets the focus presets that the capture device supports. + +## -property-value +The supported focus presets. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_unlockasync_1509852231.md b/windows.media.devices/focuscontrol_unlockasync_1509852231.md index aac4f506cd..b9081810a9 100644 --- a/windows.media.devices/focuscontrol_unlockasync_1509852231.md +++ b/windows.media.devices/focuscontrol_unlockasync_1509852231.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.FocusControl.UnlockAsync --api-type: winrt method ---- # Windows.Media.Devices.FocusControl.UnlockAsync ## -description Unlocks the capture device's focus if it has previously been locked with a call to [LockAsync](focuscontrol_lockasync.md). ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusControl.UnlockAsync +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusControl.UnlockAsync + +## -description +Unlocks the capture device's focus if it has previously been locked with a call to [LockAsync](focuscontrol_lockasync.md). + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol_value.md b/windows.media.devices/focuscontrol_value.md index e2176e30c3..3be85ac232 100644 --- a/windows.media.devices/focuscontrol_value.md +++ b/windows.media.devices/focuscontrol_value.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.Value --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.Value ## -description Gets the current value that the focus is set to. ## -property-value The value that the focus is set to. The minimum and maximum values for the focus are specified by [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). ## -remarks To set a focus value, call [SetValueAsync](focuscontrol_setvalueasync.md) specifying a value between the [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md) focus values. ## -examples ## -see-also [FocusControl.Value](exposurecontrol_value.md), [Min](focuscontrol_min.md), [Max](focuscontrol_max.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Value + +## -description +Gets the current value that the focus is set to. + +## -property-value +The value that the focus is set to. The minimum and maximum values for the focus are specified by [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). + +## -remarks +To set a focus value, call [SetValueAsync](focuscontrol_setvalueasync.md) specifying a value between the [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md) focus values. + +## -examples + +## -see-also +[FocusControl.Value](exposurecontrol_value.md), [Min](focuscontrol_min.md), [Max](focuscontrol_max.md) \ No newline at end of file diff --git a/windows.media.devices/focuscontrol_waitforfocussupported.md b/windows.media.devices/focuscontrol_waitforfocussupported.md index 21573fc3cc..c82bc1c8c1 100644 --- a/windows.media.devices/focuscontrol_waitforfocussupported.md +++ b/windows.media.devices/focuscontrol_waitforfocussupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusControl.WaitForFocusSupported --api-type: winrt property ---- # Windows.Media.Devices.FocusControl.WaitForFocusSupported ## -description Gets a value that indicates whether [WaitForFocus](focussettings_waitforfocus.md) is supported by the capture device. ## -property-value A value indicating whether [WaitForFocus](focussettings_waitforfocus.md) is supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusControl.WaitForFocusSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.WaitForFocusSupported + +## -description +Gets a value that indicates whether [WaitForFocus](focussettings_waitforfocus.md) is supported by the capture device. + +## -property-value +A value indicating whether [WaitForFocus](focussettings_waitforfocus.md) is supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings.md b/windows.media.devices/focussettings.md index 6f2efb2398..668034d760 100644 --- a/windows.media.devices/focussettings.md +++ b/windows.media.devices/focussettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Devices.FocusSettings --api-type: winrt class ---- # Windows.Media.Devices.FocusSettings ## -description Represents settings for a [FocusControl](focuscontrol.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.FocusSettings +-api-type: winrt class +--- + + + +# Windows.Media.Devices.FocusSettings + +## -description +Represents settings for a [FocusControl](focuscontrol.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_autofocusrange.md b/windows.media.devices/focussettings_autofocusrange.md index 06d4ee8428..a736d1b0c3 100644 --- a/windows.media.devices/focussettings_autofocusrange.md +++ b/windows.media.devices/focussettings_autofocusrange.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusSettings.AutoFocusRange --api-type: winrt property ---- # Windows.Media.Devices.FocusSettings.AutoFocusRange ## -description Gets or sets a value indicating the auto focus range setting. ## -property-value A value indicating the auto focus range setting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusSettings.AutoFocusRange +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusSettings.AutoFocusRange + +## -description +Gets or sets a value indicating the auto focus range setting. + +## -property-value +A value indicating the auto focus range setting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_disabledriverfallback.md b/windows.media.devices/focussettings_disabledriverfallback.md index bf27739a35..02a5452845 100644 --- a/windows.media.devices/focussettings_disabledriverfallback.md +++ b/windows.media.devices/focussettings_disabledriverfallback.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FocusSettings.DisableDriverFallback --api-type: winrt property ---- # Windows.Media.Devices.FocusSettings.DisableDriverFallback ## -description Gets or sets a value that indicates to the driver if it should disable determining a focus position when the focus search fails. ## -property-value **true** if the driver should not determine a focus position if the focus search fails. **false** if the driver should determine a focus position if the focus search fails. ## -remarks This property only impacts autofocus (single autofocus and continuous autofocus). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusSettings.DisableDriverFallback +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusSettings.DisableDriverFallback + +## -description +Gets or sets a value that indicates to the driver if it should disable determining a focus position when the focus search fails. + +## -property-value +**true** if the driver should not determine a focus position if the focus search fails. **false** if the driver should determine a focus position if the focus search fails. + +## -remarks +This property only impacts autofocus (single autofocus and continuous autofocus). + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_distance.md b/windows.media.devices/focussettings_distance.md index b9027f70ef..ea77a3ab07 100644 --- a/windows.media.devices/focussettings_distance.md +++ b/windows.media.devices/focussettings_distance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusSettings.Distance --api-type: winrt property ---- # Windows.Media.Devices.FocusSettings.Distance ## -description Gets or sets a value indicating the manual focus distance setting. ## -property-value A value indicating the manual focus distance setting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusSettings.Distance +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusSettings.Distance + +## -description +Gets or sets a value indicating the manual focus distance setting. + +## -property-value +A value indicating the manual focus distance setting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_focussettings_1221375020.md b/windows.media.devices/focussettings_focussettings_1221375020.md index d3deb71032..16c5e030c2 100644 --- a/windows.media.devices/focussettings_focussettings_1221375020.md +++ b/windows.media.devices/focussettings_focussettings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.FocusSettings.#ctor --api-type: winrt method ---- # Windows.Media.Devices.FocusSettings.FocusSettings ## -description Initializes a new instance of the [FocusSettings](focussettings.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.FocusSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Devices.FocusSettings.FocusSettings + +## -description +Initializes a new instance of the [FocusSettings](focussettings.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_mode.md b/windows.media.devices/focussettings_mode.md index fa8d01e2a8..6a30137aeb 100644 --- a/windows.media.devices/focussettings_mode.md +++ b/windows.media.devices/focussettings_mode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.FocusSettings.Mode --api-type: winrt property ---- # Windows.Media.Devices.FocusSettings.Mode ## -description Gets or sets a value indicating the focus mode setting. ## -property-value A value indicating the focus mode setting. ## -remarks Autofocus mode, enabled by using the [FocusMode.Continuous](focusmode.md) value, is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on continuous autofocus. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusSettings.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusSettings.Mode + +## -description +Gets or sets a value indicating the focus mode setting. + +## -property-value +A value indicating the focus mode setting. + +## -remarks +Autofocus mode, enabled by using the [FocusMode.Continuous](focusmode.md) value, is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on continuous autofocus. + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_value.md b/windows.media.devices/focussettings_value.md index ab6c3c1a25..fcdc245e2d 100644 --- a/windows.media.devices/focussettings_value.md +++ b/windows.media.devices/focussettings_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusSettings.Value --api-type: winrt property ---- # Windows.Media.Devices.FocusSettings.Value ## -description Gets or sets the focus value setting. ## -property-value The focus value setting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusSettings.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusSettings.Value + +## -description +Gets or sets the focus value setting. + +## -property-value +The focus value setting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/focussettings_waitforfocus.md b/windows.media.devices/focussettings_waitforfocus.md index 0d94bfa784..2d830b0054 100644 --- a/windows.media.devices/focussettings_waitforfocus.md +++ b/windows.media.devices/focussettings_waitforfocus.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.FocusSettings.WaitForFocus --api-type: winrt property ---- # Windows.Media.Devices.FocusSettings.WaitForFocus ## -description Gets or sets a value indicating whether the capture device should wait for focus before capturing. ## -property-value A value indicating whether the capture device should wait for focus before capturing. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.FocusSettings.WaitForFocus +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusSettings.WaitForFocus + +## -description +Gets or sets a value indicating whether the capture device should wait for focus before capturing. + +## -property-value +A value indicating whether the capture device should wait for focus before capturing. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/hdrvideocontrol.md b/windows.media.devices/hdrvideocontrol.md index bd2fa9b5a2..4d2ce8236b 100644 --- a/windows.media.devices/hdrvideocontrol.md +++ b/windows.media.devices/hdrvideocontrol.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.HdrVideoControl --api-type: winrt class ---- # Windows.Media.Devices.HdrVideoControl ## -description When supported, allows an app to enable High Dynamic Range (HDR) video recording on the capture device. ## -remarks Get an instance of this class by accessing the [VideoDeviceController.HdrVideoControl](videodevicecontroller_hdrvideocontrol.md) property. For how-to guidance for using manual video capture controls, see [Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture). ## -examples ## -see-also [Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.HdrVideoControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.HdrVideoControl + +## -description +When supported, allows an app to enable High Dynamic Range (HDR) video recording on the capture device. + +## -remarks +Get an instance of this class by accessing the [VideoDeviceController.HdrVideoControl](videodevicecontroller_hdrvideocontrol.md) property. + +For how-to guidance for using manual video capture controls, see [Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture). + +## -examples + +## -see-also +[Manual camera controls for video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture) \ No newline at end of file diff --git a/windows.media.devices/hdrvideocontrol_mode.md b/windows.media.devices/hdrvideocontrol_mode.md index c2f59aafc5..6f04b529a0 100644 --- a/windows.media.devices/hdrvideocontrol_mode.md +++ b/windows.media.devices/hdrvideocontrol_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.HdrVideoControl.Mode --api-type: winrt property ---- # Windows.Media.Devices.HdrVideoControl.Mode ## -description Gets or sets a value indicating the current High Dynamic Range (HDR) video recording mode of the capture device. ## -property-value The current High Dynamic Range (HDR) video recording mode of the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.HdrVideoControl.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.HdrVideoControl.Mode + +## -description +Gets or sets a value indicating the current High Dynamic Range (HDR) video recording mode of the capture device. + +## -property-value +The current High Dynamic Range (HDR) video recording mode of the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/hdrvideocontrol_supported.md b/windows.media.devices/hdrvideocontrol_supported.md index 5f47e2ab94..2adc0186f1 100644 --- a/windows.media.devices/hdrvideocontrol_supported.md +++ b/windows.media.devices/hdrvideocontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.HdrVideoControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.HdrVideoControl.Supported ## -description Gets a value that indicates if the capture device supports the [HdrVideoControl](hdrvideocontrol.md). ## -property-value True if the [HdrVideoControl](hdrvideocontrol.md) is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.HdrVideoControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.HdrVideoControl.Supported + +## -description +Gets a value that indicates if the capture device supports the [HdrVideoControl](hdrvideocontrol.md). + +## -property-value +True if the [HdrVideoControl](hdrvideocontrol.md) is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/hdrvideocontrol_supportedmodes.md b/windows.media.devices/hdrvideocontrol_supportedmodes.md index 96393817b5..49380cbb86 100644 --- a/windows.media.devices/hdrvideocontrol_supportedmodes.md +++ b/windows.media.devices/hdrvideocontrol_supportedmodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.HdrVideoControl.SupportedModes --api-type: winrt property ---- # Windows.Media.Devices.HdrVideoControl.SupportedModes ## -description Gets the list of [HdrVideoMode](hdrvideomode.md) values indicating the modes supported by the capture device. ## -property-value The list of supported [HdrVideoMode](hdrvideomode.md) values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.HdrVideoControl.SupportedModes +-api-type: winrt property +--- + + + +# Windows.Media.Devices.HdrVideoControl.SupportedModes + +## -description +Gets the list of [HdrVideoMode](hdrvideomode.md) values indicating the modes supported by the capture device. + +## -property-value +The list of supported [HdrVideoMode](hdrvideomode.md) values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/idefaultaudiodevicechangedeventargs_id.md b/windows.media.devices/idefaultaudiodevicechangedeventargs_id.md index 5518aff175..715ad03e91 100644 --- a/windows.media.devices/idefaultaudiodevicechangedeventargs_id.md +++ b/windows.media.devices/idefaultaudiodevicechangedeventargs_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Id --api-type: winrt property ---- # Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Id ## -description Gets the ID of the newly selected audio device that raised the device change event. ## -property-value ID of the newly selected audio device that raised the device change event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Id +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Id + +## -description +Gets the ID of the newly selected audio device that raised the device change event. + +## -property-value +ID of the newly selected audio device that raised the device change event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/idefaultaudiodevicechangedeventargs_role.md b/windows.media.devices/idefaultaudiodevicechangedeventargs_role.md index 520fbf7a17..522c185a02 100644 --- a/windows.media.devices/idefaultaudiodevicechangedeventargs_role.md +++ b/windows.media.devices/idefaultaudiodevicechangedeventargs_role.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Role --api-type: winrt property ---- # Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Role ## -description Gets the role of the newly selected audio device that raised the device change event. ## -property-value The role of the newly selected audio device that raised the device change event. ## -remarks ## -examples ## -see-also [AudioDeviceRole](audiodevicerole.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Role +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs.Role + +## -description +Gets the role of the newly selected audio device that raised the device change event. + +## -property-value +The role of the newly selected audio device that raised the device change event. + +## -remarks + +## -examples + +## -see-also +[AudioDeviceRole](audiodevicerole.md) \ No newline at end of file diff --git a/windows.media.devices/imediadevicecontroller_getavailablemediastreamproperties.md b/windows.media.devices/imediadevicecontroller_getavailablemediastreamproperties.md index 37c06d2f1e..9760572dc2 100644 --- a/windows.media.devices/imediadevicecontroller_getavailablemediastreamproperties.md +++ b/windows.media.devices/imediadevicecontroller_getavailablemediastreamproperties.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.IMediaDeviceController.GetAvailableMediaStreamProperties(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Devices.IMediaDeviceController.GetAvailableMediaStreamProperties ## -description Gets a list of the supported encoding properties for the device. ## -parameters ### -param mediaStreamType The type of media stream for which to get the properties. ## -returns A list of the supported encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.IMediaDeviceController.GetAvailableMediaStreamProperties(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.IMediaDeviceController.GetAvailableMediaStreamProperties + +## -description +Gets a list of the supported encoding properties for the device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to get the properties. + +## -returns +A list of the supported encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/imediadevicecontroller_getmediastreamproperties.md b/windows.media.devices/imediadevicecontroller_getmediastreamproperties.md index cb6370e55a..102e7a90fd 100644 --- a/windows.media.devices/imediadevicecontroller_getmediastreamproperties.md +++ b/windows.media.devices/imediadevicecontroller_getmediastreamproperties.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.IMediaDeviceController.GetMediaStreamProperties(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Devices.IMediaDeviceController.GetMediaStreamProperties ## -description Gets the encoding properties for the specified media stream type for the device. ## -parameters ### -param mediaStreamType The type of media stream for which to get the properties. ## -returns The encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.IMediaDeviceController.GetMediaStreamProperties(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.IMediaDeviceController.GetMediaStreamProperties + +## -description +Gets the encoding properties for the specified media stream type for the device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to get the properties. + +## -returns +The encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/imediadevicecontroller_setmediastreampropertiesasync.md b/windows.media.devices/imediadevicecontroller_setmediastreampropertiesasync.md index a230a7bf8b..fcd1804c3c 100644 --- a/windows.media.devices/imediadevicecontroller_setmediastreampropertiesasync.md +++ b/windows.media.devices/imediadevicecontroller_setmediastreampropertiesasync.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.IMediaDeviceController.SetMediaStreamPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties) --api-type: winrt method ---- # Windows.Media.Devices.IMediaDeviceController.SetMediaStreamPropertiesAsync ## -description Sets the encoding properties asynchronously for the specified media stream type for the device. ## -parameters ### -param mediaStreamType The type of media stream for which to set the properties. ### -param mediaEncodingProperties The encoding properties to set. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.IMediaDeviceController.SetMediaStreamPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.IMediaDeviceController.SetMediaStreamPropertiesAsync + +## -description +Sets the encoding properties asynchronously for the specified media stream type for the device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to set the properties. + +### -param mediaEncodingProperties +The encoding properties to set. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol.md b/windows.media.devices/isospeedcontrol.md index 8f3d3c2f83..100867fc33 100644 --- a/windows.media.devices/isospeedcontrol.md +++ b/windows.media.devices/isospeedcontrol.md @@ -1,3 +1,31 @@ ---- -api-id: T:Windows.Media.Devices.IsoSpeedControl --api-type: winrt class ---- # Windows.Media.Devices.IsoSpeedControl ## -description Provides functionality for controlling the ISO film speed settings on a capture device. ## -remarks You can find out if a device supports this control by checking [IsoSpeedControl.Supported](isospeedcontrol_supported.md). You can access the [IsoSpeedControl](isospeedcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). The [IsoSpeedControl](isospeedcontrol.md) enables apps to manage the ISO speed settings on a device. For example, in low-light conditions, apps may prefer higher noise level in return for higher overall brightness. The ISO speed control lets apps adjust tradeoffs such as this. Use [SetPresetAsync](isospeedcontrol_setpresetasync.md) to set the ISO level to one of the [IsoSpeedPreset](isospeedpreset.md) values. [SupportedPresets](isospeedcontrol_supportedpresets.md) lists the preset values that are support on the device. For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.IsoSpeedControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.IsoSpeedControl + +## -description +Provides functionality for controlling the ISO film speed settings on a capture device. + +## -remarks +You can find out if a device supports this control by checking [IsoSpeedControl.Supported](isospeedcontrol_supported.md). + +You can access the [IsoSpeedControl](isospeedcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +The [IsoSpeedControl](isospeedcontrol.md) enables apps to manage the ISO speed settings on a device. For example, in low-light conditions, apps may prefer higher noise level in return for higher overall brightness. The ISO speed control lets apps adjust tradeoffs such as this. + +Use [SetPresetAsync](isospeedcontrol_setpresetasync.md) to set the ISO level to one of the [IsoSpeedPreset](isospeedpreset.md) values. + +[SupportedPresets](isospeedcontrol_supportedpresets.md) lists the preset values that are support on the device. + +For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/isospeedcontrol_auto.md b/windows.media.devices/isospeedcontrol_auto.md index ab1db8e47b..8fca72effd 100644 --- a/windows.media.devices/isospeedcontrol_auto.md +++ b/windows.media.devices/isospeedcontrol_auto.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Auto --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Auto ## -description Gets a value indicating whether auto ISO speed is enabled. ## -property-value A value indicating whether auto ISO speed is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Auto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Auto + +## -description +Gets a value indicating whether auto ISO speed is enabled. + +## -property-value +A value indicating whether auto ISO speed is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_max.md b/windows.media.devices/isospeedcontrol_max.md index f53e413e15..ac5fd236bb 100644 --- a/windows.media.devices/isospeedcontrol_max.md +++ b/windows.media.devices/isospeedcontrol_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Max --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Max ## -description Gets the maximum ISO speed supported by the capture device. ## -property-value The maximum ISO speed supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Max + +## -description +Gets the maximum ISO speed supported by the capture device. + +## -property-value +The maximum ISO speed supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_min.md b/windows.media.devices/isospeedcontrol_min.md index b0f822a687..a71b4020ad 100644 --- a/windows.media.devices/isospeedcontrol_min.md +++ b/windows.media.devices/isospeedcontrol_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Min --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Min ## -description Gets the minimum ISO speed supported by the capture device. ## -property-value The minimum ISO speed supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Min + +## -description +Gets the minimum ISO speed supported by the capture device. + +## -property-value +The minimum ISO speed supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_preset.md b/windows.media.devices/isospeedcontrol_preset.md index 0e2e4b60ff..68a07c74f9 100644 --- a/windows.media.devices/isospeedcontrol_preset.md +++ b/windows.media.devices/isospeedcontrol_preset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Preset --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Preset ## -description Gets the ISO film speed preset. ## -property-value The ISO speed preset. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Preset +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Preset + +## -description +Gets the ISO film speed preset. + +## -property-value +The ISO speed preset. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_setautoasync_1264919457.md b/windows.media.devices/isospeedcontrol_setautoasync_1264919457.md index b773f1825d..a4cd4c6326 100644 --- a/windows.media.devices/isospeedcontrol_setautoasync_1264919457.md +++ b/windows.media.devices/isospeedcontrol_setautoasync_1264919457.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.IsoSpeedControl.SetAutoAsync --api-type: winrt method ---- # Windows.Media.Devices.IsoSpeedControl.SetAutoAsync ## -description Sets the ISO speed to automatic. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.IsoSpeedControl.SetAutoAsync +-api-type: winrt method +--- + + + +# Windows.Media.Devices.IsoSpeedControl.SetAutoAsync + +## -description +Sets the ISO speed to automatic. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_setpresetasync_1340401685.md b/windows.media.devices/isospeedcontrol_setpresetasync_1340401685.md index 2565997b5a..cd8bb63fc3 100644 --- a/windows.media.devices/isospeedcontrol_setpresetasync_1340401685.md +++ b/windows.media.devices/isospeedcontrol_setpresetasync_1340401685.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.IsoSpeedControl.SetPresetAsync(Windows.Media.Devices.IsoSpeedPreset) --api-type: winrt method ---- # Windows.Media.Devices.IsoSpeedControl.SetPresetAsync ## -description Asynchronously sets the ISO film speed [Preset](isospeedcontrol_preset.md). ## -parameters ### -param preset The ISO preset value to set the [Preset](isospeedcontrol_preset.md) property to. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.IsoSpeedControl.SetPresetAsync(Windows.Media.Devices.IsoSpeedPreset) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.IsoSpeedControl.SetPresetAsync + +## -description +Asynchronously sets the ISO film speed [Preset](isospeedcontrol_preset.md). + +## -parameters +### -param preset +The ISO preset value to set the [Preset](isospeedcontrol_preset.md) property to. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_setvalueasync_2096210171.md b/windows.media.devices/isospeedcontrol_setvalueasync_2096210171.md index 674002d378..caf8155174 100644 --- a/windows.media.devices/isospeedcontrol_setvalueasync_2096210171.md +++ b/windows.media.devices/isospeedcontrol_setvalueasync_2096210171.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.IsoSpeedControl.SetValueAsync(System.UInt32) --api-type: winrt method ---- # Windows.Media.Devices.IsoSpeedControl.SetValueAsync ## -description Sets the ISO speed value. ## -parameters ### -param isoSpeed The ISO speed value. ## -returns An asynchronous action. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.IsoSpeedControl.SetValueAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.IsoSpeedControl.SetValueAsync + +## -description +Sets the ISO speed value. + +## -parameters +### -param isoSpeed +The ISO speed value. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_step.md b/windows.media.devices/isospeedcontrol_step.md index 356fd02d57..c6bd7e40b9 100644 --- a/windows.media.devices/isospeedcontrol_step.md +++ b/windows.media.devices/isospeedcontrol_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Step --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Step ## -description Gets the smallest ISO speed increment supported by the capture device. ## -property-value The smallest ISO speed increment supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Step + +## -description +Gets the smallest ISO speed increment supported by the capture device. + +## -property-value +The smallest ISO speed increment supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_supported.md b/windows.media.devices/isospeedcontrol_supported.md index 079cde300d..b4dd6cdce5 100644 --- a/windows.media.devices/isospeedcontrol_supported.md +++ b/windows.media.devices/isospeedcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Supported ## -description Gets a value the specifies if the capture device supports the ISO speed control. ## -property-value **true** if the ISO control is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Supported + +## -description +Gets a value the specifies if the capture device supports the ISO speed control. + +## -property-value +**true** if the ISO control is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_supportedpresets.md b/windows.media.devices/isospeedcontrol_supportedpresets.md index f3d8ad75d7..4a17220883 100644 --- a/windows.media.devices/isospeedcontrol_supportedpresets.md +++ b/windows.media.devices/isospeedcontrol_supportedpresets.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.SupportedPresets --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.SupportedPresets ## -description Gets the ISO presets that the capture device supports. ## -property-value The supported ISO presets. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.SupportedPresets +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.SupportedPresets + +## -description +Gets the ISO presets that the capture device supports. + +## -property-value +The supported ISO presets. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/isospeedcontrol_value.md b/windows.media.devices/isospeedcontrol_value.md index 5e88f286af..e504d0eb37 100644 --- a/windows.media.devices/isospeedcontrol_value.md +++ b/windows.media.devices/isospeedcontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.IsoSpeedControl.Value --api-type: winrt property ---- # Windows.Media.Devices.IsoSpeedControl.Value ## -description Gets the current ISO speed value. ## -property-value The current ISO speed value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.IsoSpeedControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.IsoSpeedControl.Value + +## -description +Gets the current ISO speed value. + +## -property-value +The current ISO speed value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/keypadpressedeventargs_telephonykey.md b/windows.media.devices/keypadpressedeventargs_telephonykey.md index 79def9d71f..5a5a13779f 100644 --- a/windows.media.devices/keypadpressedeventargs_telephonykey.md +++ b/windows.media.devices/keypadpressedeventargs_telephonykey.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.KeypadPressedEventArgs.TelephonyKey --api-type: winrt property ---- # Windows.Media.Devices.KeypadPressedEventArgs.TelephonyKey ## -description Returns the value of the keypad button on the device that was pressed. ## -property-value The key. One of the values of the [TelephonyKey](telephonykey.md) enumeration. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.KeypadPressedEventArgs.TelephonyKey +-api-type: winrt property +--- + + + +# Windows.Media.Devices.KeypadPressedEventArgs.TelephonyKey + +## -description +Returns the value of the keypad button on the device that was pressed. + +## -property-value +The key. One of the values of the [TelephonyKey](telephonykey.md) enumeration. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotocontrol.md b/windows.media.devices/lowlagphotocontrol.md index 3377700be5..efb073b522 100644 --- a/windows.media.devices/lowlagphotocontrol.md +++ b/windows.media.devices/lowlagphotocontrol.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Media.Devices.LowLagPhotoControl --api-type: winrt class ---- # Windows.Media.Devices.LowLagPhotoControl ## -description Provides functionality for managing the low shutter lag photo capture mode on the capture device. ## -remarks You can access the [LowLagPhotoControl](lowlagphotocontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). Thumbnails are supported for a low shutter lag single photos and photo sequences. To enable thumbnails, set [ThumbnailEnabled](lowlagphotocontrol_thumbnailenabled.md) to **true**. You can set the desired thumbnail size through [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md) and set the thumbnail format through [ThumbnailFormat](lowlagphotocontrol_thumbnailformat.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.LowLagPhotoControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.LowLagPhotoControl + +## -description +Provides functionality for managing the low shutter lag photo capture mode on the capture device. + +## -remarks +You can access the [LowLagPhotoControl](lowlagphotocontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +Thumbnails are supported for a low shutter lag single photos and photo sequences. + +To enable thumbnails, set [ThumbnailEnabled](lowlagphotocontrol_thumbnailenabled.md) to **true**. + +You can set the desired thumbnail size through [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md) and set the thumbnail format through [ThumbnailFormat](lowlagphotocontrol_thumbnailformat.md). + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotocontrol_desiredthumbnailsize.md b/windows.media.devices/lowlagphotocontrol_desiredthumbnailsize.md index c67ef3498c..39195a5587 100644 --- a/windows.media.devices/lowlagphotocontrol_desiredthumbnailsize.md +++ b/windows.media.devices/lowlagphotocontrol_desiredthumbnailsize.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoControl.DesiredThumbnailSize --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoControl.DesiredThumbnailSize ## -description Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height. ## -property-value The desired thumbnail size. ## -remarks The actual dimension of the thumbnail is not guaranteed to be the value specified by [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md), but the system will attempt to create thumbnails as close as possible to this value. ## -examples ## -see-also [ThumbnailEnabled](lowlagphotocontrol_thumbnailenabled.md), [ThumbnailFormat](lowlagphotocontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoControl.DesiredThumbnailSize +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoControl.DesiredThumbnailSize + +## -description +Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height. + +## -property-value +The desired thumbnail size. + +## -remarks +The actual dimension of the thumbnail is not guaranteed to be the value specified by [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md), but the system will attempt to create thumbnails as close as possible to this value. + +## -examples + +## -see-also +[ThumbnailEnabled](lowlagphotocontrol_thumbnailenabled.md), [ThumbnailFormat](lowlagphotocontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotocontrol_getcurrentframerate_279282429.md b/windows.media.devices/lowlagphotocontrol_getcurrentframerate_279282429.md index 7c5a226261..4d90124555 100644 --- a/windows.media.devices/lowlagphotocontrol_getcurrentframerate_279282429.md +++ b/windows.media.devices/lowlagphotocontrol_getcurrentframerate_279282429.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.LowLagPhotoControl.GetCurrentFrameRate --api-type: winrt method ---- # Windows.Media.Devices.LowLagPhotoControl.GetCurrentFrameRate ## -description Gets the current frame rate at which pictures can be taken. ## -returns The current frame rate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.LowLagPhotoControl.GetCurrentFrameRate +-api-type: winrt method +--- + + + +# Windows.Media.Devices.LowLagPhotoControl.GetCurrentFrameRate + +## -description +Gets the current frame rate at which pictures can be taken. + +## -returns +The current frame rate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotocontrol_gethighestconcurrentframerate_1293632752.md b/windows.media.devices/lowlagphotocontrol_gethighestconcurrentframerate_1293632752.md index 3543288301..d2fdf7ca29 100644 --- a/windows.media.devices/lowlagphotocontrol_gethighestconcurrentframerate_1293632752.md +++ b/windows.media.devices/lowlagphotocontrol_gethighestconcurrentframerate_1293632752.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.LowLagPhotoControl.GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties) --api-type: winrt method ---- # Windows.Media.Devices.LowLagPhotoControl.GetHighestConcurrentFrameRate ## -description Gets the highest frame rate supported when video and photos are being captured concurrently. ## -parameters ### -param captureProperties The media encoding properties. ## -returns The highest concurrent frames per second. ## -remarks The [ConcurrentRecordAndPhotoSupported](../windows.media.capture/mediacapturesettings_concurrentrecordandphotosupported.md) property on the [MediaCapture](../windows.media.capture/mediacapture.md) class specifies if the capture device supports capturing videos and photos at the same time. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.LowLagPhotoControl.GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.LowLagPhotoControl.GetHighestConcurrentFrameRate + +## -description +Gets the highest frame rate supported when video and photos are being captured concurrently. + +## -parameters +### -param captureProperties +The media encoding properties. + +## -returns +The highest concurrent frames per second. + +## -remarks +The [ConcurrentRecordAndPhotoSupported](../windows.media.capture/mediacapturesettings_concurrentrecordandphotosupported.md) property on the [MediaCapture](../windows.media.capture/mediacapture.md) class specifies if the capture device supports capturing videos and photos at the same time. + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md b/windows.media.devices/lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md index 8fddd258fd..1ed18dee4d 100644 --- a/windows.media.devices/lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md +++ b/windows.media.devices/lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoControl.HardwareAcceleratedThumbnailSupported --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoControl.HardwareAcceleratedThumbnailSupported ## -description Gets a value that specifies if hardware acceleration is supported for thumbnails. ## -property-value **true** if hardware acceleration for thumbnails is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoControl.HardwareAcceleratedThumbnailSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoControl.HardwareAcceleratedThumbnailSupported + +## -description +Gets a value that specifies if hardware acceleration is supported for thumbnails. + +## -property-value +**true** if hardware acceleration for thumbnails is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotocontrol_thumbnailenabled.md b/windows.media.devices/lowlagphotocontrol_thumbnailenabled.md index 5ef8af2edf..472d821f7f 100644 --- a/windows.media.devices/lowlagphotocontrol_thumbnailenabled.md +++ b/windows.media.devices/lowlagphotocontrol_thumbnailenabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoControl.ThumbnailEnabled --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoControl.ThumbnailEnabled ## -description Gets a value that enables and disables thumbnail support. ## -property-value **true** if thumbnails are enabled; otherwise, **false**. ## -remarks ## -examples ## -see-also [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md), [ThumbnailFormat](lowlagphotocontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoControl.ThumbnailEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoControl.ThumbnailEnabled + +## -description +Gets a value that enables and disables thumbnail support. + +## -property-value +**true** if thumbnails are enabled; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md), [ThumbnailFormat](lowlagphotocontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotocontrol_thumbnailformat.md b/windows.media.devices/lowlagphotocontrol_thumbnailformat.md index ed0b15028d..341c90a4d9 100644 --- a/windows.media.devices/lowlagphotocontrol_thumbnailformat.md +++ b/windows.media.devices/lowlagphotocontrol_thumbnailformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoControl.ThumbnailFormat --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoControl.ThumbnailFormat ## -description Gets or sets the media format for the thumbnails. ## -property-value The media format for the thumbnails. ## -remarks ## -examples ## -see-also [ThumbnailEnabled](lowlagphotocontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md), [HardwareAcceleratedThumbnailSupported](lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoControl.ThumbnailFormat +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoControl.ThumbnailFormat + +## -description +Gets or sets the media format for the thumbnails. + +## -property-value +The media format for the thumbnails. + +## -remarks + +## -examples + +## -see-also +[ThumbnailEnabled](lowlagphotocontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotocontrol_desiredthumbnailsize.md), [HardwareAcceleratedThumbnailSupported](lowlagphotocontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotosequencecontrol.md b/windows.media.devices/lowlagphotosequencecontrol.md index 481d5cc7a6..ce12d80f03 100644 --- a/windows.media.devices/lowlagphotosequencecontrol.md +++ b/windows.media.devices/lowlagphotosequencecontrol.md @@ -1,3 +1,41 @@ ---- -api-id: T:Windows.Media.Devices.LowLagPhotoSequenceControl --api-type: winrt class ---- # Windows.Media.Devices.LowLagPhotoSequenceControl ## -description Provides functionality for managing the low shutter lag photo sequence mode on the capture device. ## -remarks Photo sequence mode takes a rapid sequence of photos. A key scenario for photo sequence is getting photos in the past, that is prior to when the user takes a photo. You can access the [LowLagPhotoSequenceControl](lowlagphotosequencecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). You can find out if the device supports photo sequence mode by checking [LowLagPhotoSequenceControl.Supported](lowlagphotosequencecontrol_supported.md). To initiate photo sequence mode, call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparelowlagphotosequencecaptureasync.md). To start capturing photos, call [StartAsync](../windows.media.capture/lowlagphotosequencecapture_startasync.md). To stop capturing photos, call [StopAsync](../windows.media.capture/lowlagphotosequencecapture_stopasync.md). The app will continue to receive photos from the device until the operation is stopped. [GetCurrentFrameRate](lowlagphotosequencecontrol_getcurrentframerate.md) specifies the frame rate at which the photos are taken. [PhotoCapturedEventArgs.CaptureTimeOffset](../windows.media.capture/photocapturedeventargs_capturetimeoffset.md) can be used to tell whether a frame was in the future, greater than 0, or in the past, less than 0. If the app wants to limit how many frames it gets per second, it can use [LowLagPhotoSequence.PhotosPerSecondLimit](lowlagphotosequencecontrol_photospersecondlimit.md). This can be useful in situations where the sensor on the device can handle 30fps, but the app only needs 4fps. Thumbnails are supported for a low shutter lag single photos and photo sequences. To enable thumbnails, set [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md) to **true**. You can set the desired thumbnail size through [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md) and set the thumbnail format through [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md). The number of past photos cannot be more than [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: [PastPhotoLimit](lowlagphotosequencecontrol_pastphotolimit.md), [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), or the current number of available past photos. ## -examples ## -see-also [LowLagPhotoSequenceCapture](../windows.media.capture/lowlagphotosequencecapture.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.LowLagPhotoSequenceControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl + +## -description +Provides functionality for managing the low shutter lag photo sequence mode on the capture device. + +## -remarks +Photo sequence mode takes a rapid sequence of photos. A key scenario for photo sequence is getting photos in the past, that is prior to when the user takes a photo. + +You can access the [LowLagPhotoSequenceControl](lowlagphotosequencecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +You can find out if the device supports photo sequence mode by checking [LowLagPhotoSequenceControl.Supported](lowlagphotosequencecontrol_supported.md). + +To initiate photo sequence mode, call [MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync](../windows.media.capture/mediacapture_preparelowlagphotosequencecaptureasync.md). To start capturing photos, call [StartAsync](../windows.media.capture/lowlagphotosequencecapture_startasync.md). To stop capturing photos, call [StopAsync](../windows.media.capture/lowlagphotosequencecapture_stopasync.md). The app will continue to receive photos from the device until the operation is stopped. + +[GetCurrentFrameRate](lowlagphotosequencecontrol_getcurrentframerate.md) specifies the frame rate at which the photos are taken. + +[PhotoCapturedEventArgs.CaptureTimeOffset](../windows.media.capture/photocapturedeventargs_capturetimeoffset.md) can be used to tell whether a frame was in the future, greater than 0, or in the past, less than 0. + +If the app wants to limit how many frames it gets per second, it can use [LowLagPhotoSequence.PhotosPerSecondLimit](lowlagphotosequencecontrol_photospersecondlimit.md). This can be useful in situations where the sensor on the device can handle 30fps, but the app only needs 4fps. + +Thumbnails are supported for a low shutter lag single photos and photo sequences. + +To enable thumbnails, set [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md) to **true**. + +You can set the desired thumbnail size through [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md) and set the thumbnail format through [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md). + +The number of past photos cannot be more than [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: [PastPhotoLimit](lowlagphotosequencecontrol_pastphotolimit.md), [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), or the current number of available past photos. + +## -examples + +## -see-also +[LowLagPhotoSequenceCapture](../windows.media.capture/lowlagphotosequencecapture.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md b/windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md index 3be63b8a31..8d4f401a71 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md +++ b/windows.media.devices/lowlagphotosequencecontrol_desiredthumbnailsize.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.DesiredThumbnailSize --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.DesiredThumbnailSize ## -description Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height. ## -property-value The desired thumbnail size. ## -remarks ## -examples ## -see-also [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.DesiredThumbnailSize +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.DesiredThumbnailSize + +## -description +Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height. + +## -property-value +The desired thumbnail size. + +## -remarks + +## -examples + +## -see-also +[ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotosequencecontrol_getcurrentframerate_279282429.md b/windows.media.devices/lowlagphotosequencecontrol_getcurrentframerate_279282429.md index 2a5237453c..827c00cb90 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_getcurrentframerate_279282429.md +++ b/windows.media.devices/lowlagphotosequencecontrol_getcurrentframerate_279282429.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.LowLagPhotoSequenceControl.GetCurrentFrameRate --api-type: winrt method ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.GetCurrentFrameRate ## -description Gets the current frame rate at which pictures can be taken. ## -returns The current frame rate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.LowLagPhotoSequenceControl.GetCurrentFrameRate +-api-type: winrt method +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.GetCurrentFrameRate + +## -description +Gets the current frame rate at which pictures can be taken. + +## -returns +The current frame rate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_gethighestconcurrentframerate_1293632752.md b/windows.media.devices/lowlagphotosequencecontrol_gethighestconcurrentframerate_1293632752.md index d847059b08..0a96583fcf 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_gethighestconcurrentframerate_1293632752.md +++ b/windows.media.devices/lowlagphotosequencecontrol_gethighestconcurrentframerate_1293632752.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.LowLagPhotoSequenceControl.GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties) --api-type: winrt method ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.GetHighestConcurrentFrameRate ## -description Gets the highest frame rate supported when video and photos sequences are being captured concurrently. ## -parameters ### -param captureProperties The media encoding properties. ## -returns The highest concurrent frames per second. ## -remarks The [ConcurrentRecordAndPhotoSequenceSupported](../windows.media.capture/mediacapturesettings_concurrentrecordandphotosequencesupported.md) property on the [MediaCapture](../windows.media.capture/mediacapture.md) class specifies if the capture device supports capturing videos and photo sequences at the same time. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.LowLagPhotoSequenceControl.GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.GetHighestConcurrentFrameRate + +## -description +Gets the highest frame rate supported when video and photos sequences are being captured concurrently. + +## -parameters +### -param captureProperties +The media encoding properties. + +## -returns +The highest concurrent frames per second. + +## -remarks +The [ConcurrentRecordAndPhotoSequenceSupported](../windows.media.capture/mediacapturesettings_concurrentrecordandphotosequencesupported.md) property on the [MediaCapture](../windows.media.capture/mediacapture.md) class specifies if the capture device supports capturing videos and photo sequences at the same time. + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md b/windows.media.devices/lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md index 24c3622d6e..b0eed84a69 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md +++ b/windows.media.devices/lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.HardwareAcceleratedThumbnailSupported --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.HardwareAcceleratedThumbnailSupported ## -description Gets a value that specifies if hardware acceleration is supported for thumbnails in photo sequence mode. ## -property-value **true** if hardware acceleration is supported for thumbnails in photo sequence mode; otherwise, **false**. ## -remarks ## -examples ## -see-also [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md), [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.HardwareAcceleratedThumbnailSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.HardwareAcceleratedThumbnailSupported + +## -description +Gets a value that specifies if hardware acceleration is supported for thumbnails in photo sequence mode. + +## -property-value +**true** if hardware acceleration is supported for thumbnails in photo sequence mode; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also +[ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md), [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md b/windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md index e9796e32fc..3916a15598 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md +++ b/windows.media.devices/lowlagphotosequencecontrol_maxpastphotos.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPastPhotos --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPastPhotos ## -description Gets the maximum number of past photos that can be stored. ## -property-value The maximum number of past photos. ## -remarks The [PastPhotoLimit](lowlagphotosequencecontrol_pastphotolimit.md) sets the actual number of past photos that are stored. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPastPhotos +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPastPhotos + +## -description +Gets the maximum number of past photos that can be stored. + +## -property-value +The maximum number of past photos. + +## -remarks +The [PastPhotoLimit](lowlagphotosequencecontrol_pastphotolimit.md) sets the actual number of past photos that are stored. + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_maxphotospersecond.md b/windows.media.devices/lowlagphotosequencecontrol_maxphotospersecond.md index 8c770fc074..5f41924b1b 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_maxphotospersecond.md +++ b/windows.media.devices/lowlagphotosequencecontrol_maxphotospersecond.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPhotosPerSecond --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPhotosPerSecond ## -description Gets the maximum number of photos that can be taken per second. ## -property-value The maximum number of photos per second. ## -remarks The [PhotosPerSecondLimit](lowlagphotosequencecontrol_photospersecondlimit.md) sets the actual frame rate that photos are taken. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPhotosPerSecond +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.MaxPhotosPerSecond + +## -description +Gets the maximum number of photos that can be taken per second. + +## -property-value +The maximum number of photos per second. + +## -remarks +The [PhotosPerSecondLimit](lowlagphotosequencecontrol_photospersecondlimit.md) sets the actual frame rate that photos are taken. + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_pastphotolimit.md b/windows.media.devices/lowlagphotosequencecontrol_pastphotolimit.md index ab5973f3ff..e222379102 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_pastphotolimit.md +++ b/windows.media.devices/lowlagphotosequencecontrol_pastphotolimit.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.PastPhotoLimit --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.PastPhotoLimit ## -description Gets or sets a value that specifies the number of past photos to store. ## -property-value The number of past photos to store. To determine the maximum number of past photos that can be stored, check the [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md) property. ## -remarks To determine the maximum number of past photos that can be stored, check the [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md) property. The actual number of past photos cannot be more than [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: [PastPhotoLimit](lowlagphotosequencecontrol_pastphotolimit.md), [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), or the current number of available past photos. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.PastPhotoLimit +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.PastPhotoLimit + +## -description +Gets or sets a value that specifies the number of past photos to store. + +## -property-value +The number of past photos to store. To determine the maximum number of past photos that can be stored, check the [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md) property. + +## -remarks +To determine the maximum number of past photos that can be stored, check the [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md) property. + +The actual number of past photos cannot be more than [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: [PastPhotoLimit](lowlagphotosequencecontrol_pastphotolimit.md), [MaxPastPhotos](lowlagphotosequencecontrol_maxpastphotos.md), or the current number of available past photos. + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_photospersecondlimit.md b/windows.media.devices/lowlagphotosequencecontrol_photospersecondlimit.md index d921115c25..2a49fe9a95 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_photospersecondlimit.md +++ b/windows.media.devices/lowlagphotosequencecontrol_photospersecondlimit.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.PhotosPerSecondLimit --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.PhotosPerSecondLimit ## -description Gets or sets the number of photos that are taken per second. ## -property-value The number of photos taken per second. ## -remarks To determine the maximum number photos per second supported by capture device, check the [MaxPhotosPerSecond](lowlagphotosequencecontrol_maxphotospersecond.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.PhotosPerSecondLimit +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.PhotosPerSecondLimit + +## -description +Gets or sets the number of photos that are taken per second. + +## -property-value +The number of photos taken per second. + +## -remarks +To determine the maximum number photos per second supported by capture device, check the [MaxPhotosPerSecond](lowlagphotosequencecontrol_maxphotospersecond.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_supported.md b/windows.media.devices/lowlagphotosequencecontrol_supported.md index 4b4e069bcc..c501bf0c50 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_supported.md +++ b/windows.media.devices/lowlagphotosequencecontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.Supported ## -description Gets a value that specifies if the capture device supports low shutter lag photo sequence mode. ## -property-value **true** if photo sequence mode is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.Supported + +## -description +Gets a value that specifies if the capture device supports low shutter lag photo sequence mode. + +## -property-value +**true** if photo sequence mode is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md b/windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md index c3b818c769..851b5173bd 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md +++ b/windows.media.devices/lowlagphotosequencecontrol_thumbnailenabled.md @@ -1,3 +1,30 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailEnabled --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailEnabled ## -description Gets a value that enables and disables thumbnail support in photo sequence mode. ## -property-value **true** if thumbnails are enabled; otherwise, **false**. ## -remarks Thumbnails are supported for a low shutter lag single photos and photo sequences. To enable thumbnails, set [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md) to **true**. You can set the desired thumbnail size through [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md) and set the thumbnail format through [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md). ## -examples ## -see-also [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md), [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailEnabled + +## -description +Gets a value that enables and disables thumbnail support in photo sequence mode. + +## -property-value +**true** if thumbnails are enabled; otherwise, **false**. + +## -remarks +Thumbnails are supported for a low shutter lag single photos and photo sequences. + +To enable thumbnails, set [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md) to **true**. + +You can set the desired thumbnail size through [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md) and set the thumbnail format through [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md). + + + +## -examples + +## -see-also +[ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md), [ThumbnailFormat](lowlagphotosequencecontrol_thumbnailformat.md), [HardwareAcceleratedThumbnailSupported](lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file diff --git a/windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md b/windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md index 36b3e6ebdb..fa9496acce 100644 --- a/windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md +++ b/windows.media.devices/lowlagphotosequencecontrol_thumbnailformat.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailFormat --api-type: winrt property ---- # Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailFormat ## -description Gets or sets the media format for the thumbnails. ## -property-value The media format for the thumbnails. ## -remarks ## -examples ## -see-also [ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md), [HardwareAcceleratedThumbnailSupported](lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailFormat +-api-type: winrt property +--- + + + +# Windows.Media.Devices.LowLagPhotoSequenceControl.ThumbnailFormat + +## -description +Gets or sets the media format for the thumbnails. + +## -property-value +The media format for the thumbnails. + +## -remarks + +## -examples + +## -see-also +[ThumbnailEnabled](lowlagphotosequencecontrol_thumbnailenabled.md), [DesiredThumbnailSize](lowlagphotosequencecontrol_desiredthumbnailsize.md), [HardwareAcceleratedThumbnailSupported](lowlagphotosequencecontrol_hardwareacceleratedthumbnailsupported.md) \ No newline at end of file diff --git a/windows.media.devices/mediadevice_defaultaudiocapturedevicechanged.md b/windows.media.devices/mediadevice_defaultaudiocapturedevicechanged.md index f39f81cda6..df772590d4 100644 --- a/windows.media.devices/mediadevice_defaultaudiocapturedevicechanged.md +++ b/windows.media.devices/mediadevice_defaultaudiocapturedevicechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Devices.MediaDevice.DefaultAudioCaptureDeviceChanged --api-type: winrt event ---- # Windows.Media.Devices.MediaDevice.DefaultAudioCaptureDeviceChanged ## -description Raised when the default audio capture device is changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.MediaDevice.DefaultAudioCaptureDeviceChanged +-api-type: winrt event +--- + + + +# Windows.Media.Devices.MediaDevice.DefaultAudioCaptureDeviceChanged + +## -description +Raised when the default audio capture device is changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevice_defaultaudiorenderdevicechanged.md b/windows.media.devices/mediadevice_defaultaudiorenderdevicechanged.md index a6b896f0ca..3388d19402 100644 --- a/windows.media.devices/mediadevice_defaultaudiorenderdevicechanged.md +++ b/windows.media.devices/mediadevice_defaultaudiorenderdevicechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Devices.MediaDevice.DefaultAudioRenderDeviceChanged --api-type: winrt event ---- # Windows.Media.Devices.MediaDevice.DefaultAudioRenderDeviceChanged ## -description Raised when the default audio render device is changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Devices.MediaDevice.DefaultAudioRenderDeviceChanged +-api-type: winrt event +--- + + + +# Windows.Media.Devices.MediaDevice.DefaultAudioRenderDeviceChanged + +## -description +Raised when the default audio render device is changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevice_getaudiocaptureselector_829052994.md b/windows.media.devices/mediadevice_getaudiocaptureselector_829052994.md index d6efc5d8aa..5681c252b8 100644 --- a/windows.media.devices/mediadevice_getaudiocaptureselector_829052994.md +++ b/windows.media.devices/mediadevice_getaudiocaptureselector_829052994.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.MediaDevice.GetAudioCaptureSelector --api-type: winrt method ---- # Windows.Media.Devices.MediaDevice.GetAudioCaptureSelector ## -description Returns the identifier string of a device for capturing audio. ## -returns The identifier string of the audio capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDevice.GetAudioCaptureSelector +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDevice.GetAudioCaptureSelector + +## -description +Returns the identifier string of a device for capturing audio. + +## -returns +The identifier string of the audio capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevice_getaudiorenderselector_1223331501.md b/windows.media.devices/mediadevice_getaudiorenderselector_1223331501.md index 6ee89a2665..0560b914e0 100644 --- a/windows.media.devices/mediadevice_getaudiorenderselector_1223331501.md +++ b/windows.media.devices/mediadevice_getaudiorenderselector_1223331501.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.MediaDevice.GetAudioRenderSelector --api-type: winrt method ---- # Windows.Media.Devices.MediaDevice.GetAudioRenderSelector ## -description Returns the identifier string of a device for rendering audio. ## -returns The identifier string of the audio rendering device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDevice.GetAudioRenderSelector +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDevice.GetAudioRenderSelector + +## -description +Returns the identifier string of a device for rendering audio. + +## -returns +The identifier string of the audio rendering device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevice_getdefaultaudiocaptureid_14449156.md b/windows.media.devices/mediadevice_getdefaultaudiocaptureid_14449156.md index f6c286c75d..f45cff848a 100644 --- a/windows.media.devices/mediadevice_getdefaultaudiocaptureid_14449156.md +++ b/windows.media.devices/mediadevice_getdefaultaudiocaptureid_14449156.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.MediaDevice.GetDefaultAudioCaptureId(Windows.Media.Devices.AudioDeviceRole) --api-type: winrt method ---- # Windows.Media.Devices.MediaDevice.GetDefaultAudioCaptureId ## -description Returns the identifier string of the default device for capturing audio in the specified role. ## -parameters ### -param role The specified audio device role (console, media, or communications). ## -returns The identifier string of the default device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDevice.GetDefaultAudioCaptureId(Windows.Media.Devices.AudioDeviceRole) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDevice.GetDefaultAudioCaptureId + +## -description +Returns the identifier string of the default device for capturing audio in the specified role. + +## -parameters +### -param role +The specified audio device role (console, media, or communications). + +## -returns +The identifier string of the default device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevice_getdefaultaudiorenderid_1952019825.md b/windows.media.devices/mediadevice_getdefaultaudiorenderid_1952019825.md index 498c519c01..38a0c7240c 100644 --- a/windows.media.devices/mediadevice_getdefaultaudiorenderid_1952019825.md +++ b/windows.media.devices/mediadevice_getdefaultaudiorenderid_1952019825.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.MediaDevice.GetDefaultAudioRenderId(Windows.Media.Devices.AudioDeviceRole) --api-type: winrt method ---- # Windows.Media.Devices.MediaDevice.GetDefaultAudioRenderId ## -description Returns the identifier string of the default device for rendering audio in the specified role. ## -parameters ### -param role The specified audio device role (console, media, or communications). ## -returns The identifier string of the default device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDevice.GetDefaultAudioRenderId(Windows.Media.Devices.AudioDeviceRole) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDevice.GetDefaultAudioRenderId + +## -description +Returns the identifier string of the default device for rendering audio in the specified role. + +## -parameters +### -param role +The specified audio device role (console, media, or communications). + +## -returns +The identifier string of the default device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevice_getvideocaptureselector_313102142.md b/windows.media.devices/mediadevice_getvideocaptureselector_313102142.md index e82e4d2380..260378b0f0 100644 --- a/windows.media.devices/mediadevice_getvideocaptureselector_313102142.md +++ b/windows.media.devices/mediadevice_getvideocaptureselector_313102142.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.MediaDevice.GetVideoCaptureSelector --api-type: winrt method ---- # Windows.Media.Devices.MediaDevice.GetVideoCaptureSelector ## -description Returns the identifier string of a device for capturing video. ## -returns The identifier string of the video capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDevice.GetVideoCaptureSelector +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDevice.GetVideoCaptureSelector + +## -description +Returns the identifier string of a device for capturing video. + +## -returns +The identifier string of the video capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrol_capabilities.md b/windows.media.devices/mediadevicecontrol_capabilities.md index 6f91807a4b..a616d0e1a9 100644 --- a/windows.media.devices/mediadevicecontrol_capabilities.md +++ b/windows.media.devices/mediadevicecontrol_capabilities.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControl.Capabilities --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControl.Capabilities ## -description Gets the capabilities of the camera for this camera setting. ## -property-value The capabilities, including the supported range of values, the default value, and the step size. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControl.Capabilities +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControl.Capabilities + +## -description +Gets the capabilities of the camera for this camera setting. + +## -property-value +The capabilities, including the supported range of values, the default value, and the step size. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrol_trygetauto_1184642289.md b/windows.media.devices/mediadevicecontrol_trygetauto_1184642289.md index ae3a6201e7..708d8fbe31 100644 --- a/windows.media.devices/mediadevicecontrol_trygetauto_1184642289.md +++ b/windows.media.devices/mediadevicecontrol_trygetauto_1184642289.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.MediaDeviceControl.TryGetAuto(System.Boolean@) --api-type: winrt method ---- # Windows.Media.Devices.MediaDeviceControl.TryGetAuto ## -description Indicates whether automatic adjustment of the camera setting is enabled. ## -parameters ### -param value True if automatic adjustment is enabled; false otherwise. ## -returns Returns true if the method succeeds, or false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDeviceControl.TryGetAuto(System.Boolean@) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDeviceControl.TryGetAuto + +## -description +Indicates whether automatic adjustment of the camera setting is enabled. + + + + +## -parameters +### -param value +True if automatic adjustment is enabled; false otherwise. + +## -returns +Returns true if the method succeeds, or false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrol_trygetvalue_587676813.md b/windows.media.devices/mediadevicecontrol_trygetvalue_587676813.md index 3a64ad09de..b76929720e 100644 --- a/windows.media.devices/mediadevicecontrol_trygetvalue_587676813.md +++ b/windows.media.devices/mediadevicecontrol_trygetvalue_587676813.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.MediaDeviceControl.TryGetValue(System.Double@) --api-type: winrt method ---- # Windows.Media.Devices.MediaDeviceControl.TryGetValue ## -description Gets the value of the camera setting. ## -parameters ### -param value The current value of the setting. The units depend on the setting. ## -returns Returns true if the method succeeds, or false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDeviceControl.TryGetValue(System.Double@) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDeviceControl.TryGetValue + +## -description +Gets the value of the camera setting. + +## -parameters +### -param value +The current value of the setting. The units depend on the setting. + +## -returns +Returns true if the method succeeds, or false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrol_trysetauto_1813835221.md b/windows.media.devices/mediadevicecontrol_trysetauto_1813835221.md index 43799763aa..94be6d2592 100644 --- a/windows.media.devices/mediadevicecontrol_trysetauto_1813835221.md +++ b/windows.media.devices/mediadevicecontrol_trysetauto_1813835221.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.MediaDeviceControl.TrySetAuto(System.Boolean) --api-type: winrt method ---- # Windows.Media.Devices.MediaDeviceControl.TrySetAuto ## -description Enables or disables automatic adjustment of the camera setting. ## -parameters ### -param value True to enable automatic adjustment; or false to disable automatic adjustment. If false, call [TrySetValue](mediadevicecontrol_trysetvalue.md) to adjust the setting. ## -returns Returns true if the method succeeds, or false otherwise. ## -remarks Depending on the setting and the camera model, the camera might not support automatic adjustment. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDeviceControl.TrySetAuto(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDeviceControl.TrySetAuto + +## -description +Enables or disables automatic adjustment of the camera setting. + +## -parameters +### -param value +True to enable automatic adjustment; or false to disable automatic adjustment. If false, call [TrySetValue](mediadevicecontrol_trysetvalue.md) to adjust the setting. + +## -returns +Returns true if the method succeeds, or false otherwise. + +## -remarks +Depending on the setting and the camera model, the camera might not support automatic adjustment. + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrol_trysetvalue_1874772851.md b/windows.media.devices/mediadevicecontrol_trysetvalue_1874772851.md index 0d962a7b37..767c3602af 100644 --- a/windows.media.devices/mediadevicecontrol_trysetvalue_1874772851.md +++ b/windows.media.devices/mediadevicecontrol_trysetvalue_1874772851.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Devices.MediaDeviceControl.TrySetValue(System.Double) --api-type: winrt method ---- # Windows.Media.Devices.MediaDeviceControl.TrySetValue ## -description Sets the camera setting. ## -parameters ### -param value The new value of the camera setting. The units depend on the setting. ## -returns Returns true if the method succeeds, or false otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.MediaDeviceControl.TrySetValue(System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.MediaDeviceControl.TrySetValue + +## -description +Sets the camera setting. + +## -parameters +### -param value +The new value of the camera setting. The units depend on the setting. + +## -returns +Returns true if the method succeeds, or false otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrolcapabilities_automodesupported.md b/windows.media.devices/mediadevicecontrolcapabilities_automodesupported.md index 807fe95b0f..7ad7145664 100644 --- a/windows.media.devices/mediadevicecontrolcapabilities_automodesupported.md +++ b/windows.media.devices/mediadevicecontrolcapabilities_automodesupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.AutoModeSupported --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControlCapabilities.AutoModeSupported ## -description Queries whether the camera supports automatic adjustment of the setting. ## -property-value True if the camera supports automatic adjustment of the setting; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.AutoModeSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControlCapabilities.AutoModeSupported + +## -description +Queries whether the camera supports automatic adjustment of the setting. + +## -property-value +True if the camera supports automatic adjustment of the setting; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrolcapabilities_default.md b/windows.media.devices/mediadevicecontrolcapabilities_default.md index 3806751e0b..f0a191235a 100644 --- a/windows.media.devices/mediadevicecontrolcapabilities_default.md +++ b/windows.media.devices/mediadevicecontrolcapabilities_default.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Default --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControlCapabilities.Default ## -description Gets the default value of the camera setting. ## -property-value The default value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Default +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControlCapabilities.Default + +## -description +Gets the default value of the camera setting. + +## -property-value +The default value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrolcapabilities_max.md b/windows.media.devices/mediadevicecontrolcapabilities_max.md index 35d1294299..e8f9083f96 100644 --- a/windows.media.devices/mediadevicecontrolcapabilities_max.md +++ b/windows.media.devices/mediadevicecontrolcapabilities_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Max --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControlCapabilities.Max ## -description Sets the maximum value of the camera setting. ## -property-value The maximum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControlCapabilities.Max + +## -description +Sets the maximum value of the camera setting. + +## -property-value +The maximum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrolcapabilities_min.md b/windows.media.devices/mediadevicecontrolcapabilities_min.md index c56215f768..229a6362cc 100644 --- a/windows.media.devices/mediadevicecontrolcapabilities_min.md +++ b/windows.media.devices/mediadevicecontrolcapabilities_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Min --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControlCapabilities.Min ## -description Gets the minimum value of the camera setting. ## -property-value The minimum value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControlCapabilities.Min + +## -description +Gets the minimum value of the camera setting. + +## -property-value +The minimum value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrolcapabilities_step.md b/windows.media.devices/mediadevicecontrolcapabilities_step.md index 9fe056c744..f6dc06f0c9 100644 --- a/windows.media.devices/mediadevicecontrolcapabilities_step.md +++ b/windows.media.devices/mediadevicecontrolcapabilities_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Step --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControlCapabilities.Step ## -description Ges the step size for the setting. The step size is the smallest increment by which the property can change. ## -property-value The step size. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControlCapabilities.Step + +## -description +Ges the step size for the setting. The step size is the smallest increment by which the property can change. + +## -property-value +The step size. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/mediadevicecontrolcapabilities_supported.md b/windows.media.devices/mediadevicecontrolcapabilities_supported.md index 0e30995617..c84fec441f 100644 --- a/windows.media.devices/mediadevicecontrolcapabilities_supported.md +++ b/windows.media.devices/mediadevicecontrolcapabilities_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Supported --api-type: winrt property ---- # Windows.Media.Devices.MediaDeviceControlCapabilities.Supported ## -description Indicates whether the camera supports this camera setting. ## -property-value True if the camera supports the setting; otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.MediaDeviceControlCapabilities.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.MediaDeviceControlCapabilities.Supported + +## -description +Indicates whether the camera supports this camera setting. + +## -property-value +True if the camera supports the setting; otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/opticalimagestabilizationcontrol.md b/windows.media.devices/opticalimagestabilizationcontrol.md index 6a5c57278c..0bfe34989f 100644 --- a/windows.media.devices/opticalimagestabilizationcontrol.md +++ b/windows.media.devices/opticalimagestabilizationcontrol.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.OpticalImageStabilizationControl --api-type: winrt class ---- # Windows.Media.Devices.OpticalImageStabilizationControl ## -description When supported, allows an app to enable optical image stabilization on the capture device. ## -remarks Get an instance of this class by accessing the [VideoDeviceController.OpticalImageStabilizationControl](videodevicecontroller_opticalimagestabilizationcontrol.md) property. For how-to guidance for using the **OpticalImageStabilizationControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.OpticalImageStabilizationControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.OpticalImageStabilizationControl + +## -description +When supported, allows an app to enable optical image stabilization on the capture device. + +## -remarks +Get an instance of this class by accessing the [VideoDeviceController.OpticalImageStabilizationControl](videodevicecontroller_opticalimagestabilizationcontrol.md) property. + +For how-to guidance for using the **OpticalImageStabilizationControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/opticalimagestabilizationcontrol_mode.md b/windows.media.devices/opticalimagestabilizationcontrol_mode.md index 3e17c71a87..b4b218fe64 100644 --- a/windows.media.devices/opticalimagestabilizationcontrol_mode.md +++ b/windows.media.devices/opticalimagestabilizationcontrol_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.OpticalImageStabilizationControl.Mode --api-type: winrt property ---- # Windows.Media.Devices.OpticalImageStabilizationControl.Mode ## -description Gets or sets a value indicating the current optical image stabilization mode of the capture device. ## -property-value The current optical image stabilization mode of the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.OpticalImageStabilizationControl.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.OpticalImageStabilizationControl.Mode + +## -description +Gets or sets a value indicating the current optical image stabilization mode of the capture device. + +## -property-value +The current optical image stabilization mode of the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/opticalimagestabilizationcontrol_supported.md b/windows.media.devices/opticalimagestabilizationcontrol_supported.md index 32d6d3bfe6..1b0d36b78c 100644 --- a/windows.media.devices/opticalimagestabilizationcontrol_supported.md +++ b/windows.media.devices/opticalimagestabilizationcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.OpticalImageStabilizationControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.OpticalImageStabilizationControl.Supported ## -description Gets a value that indicates if the capture device supports the [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md). ## -property-value True if the [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md) is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.OpticalImageStabilizationControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.OpticalImageStabilizationControl.Supported + +## -description +Gets a value that indicates if the capture device supports the [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md). + +## -property-value +True if the [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md) is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/opticalimagestabilizationcontrol_supportedmodes.md b/windows.media.devices/opticalimagestabilizationcontrol_supportedmodes.md index 90fa048c36..6117453e00 100644 --- a/windows.media.devices/opticalimagestabilizationcontrol_supportedmodes.md +++ b/windows.media.devices/opticalimagestabilizationcontrol_supportedmodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.OpticalImageStabilizationControl.SupportedModes --api-type: winrt property ---- # Windows.Media.Devices.OpticalImageStabilizationControl.SupportedModes ## -description Gets the list of [OpticalImageStabilizationMode](opticalimagestabilizationmode.md) values indicating the modes supported by the capture device. ## -property-value The list of supported [OpticalImageStabilizationMode](opticalimagestabilizationmode.md) values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.OpticalImageStabilizationControl.SupportedModes +-api-type: winrt property +--- + + + +# Windows.Media.Devices.OpticalImageStabilizationControl.SupportedModes + +## -description +Gets the list of [OpticalImageStabilizationMode](opticalimagestabilizationmode.md) values indicating the modes supported by the capture device. + +## -property-value +The list of supported [OpticalImageStabilizationMode](opticalimagestabilizationmode.md) values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/photoconfirmationcontrol.md b/windows.media.devices/photoconfirmationcontrol.md index cace219c4a..211b2077e3 100644 --- a/windows.media.devices/photoconfirmationcontrol.md +++ b/windows.media.devices/photoconfirmationcontrol.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Devices.PhotoConfirmationControl --api-type: winrt class ---- # Windows.Media.Devices.PhotoConfirmationControl ## -description Provides functionality for controlling the photo confirmation settings on a capture device. ## -remarks Get an instance of this class by accessing the [VideoDeviceController.PhotoConfirmationControl](videodevicecontroller_photoconfirmationcontrol.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.PhotoConfirmationControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.PhotoConfirmationControl + +## -description +Provides functionality for controlling the photo confirmation settings on a capture device. + +## -remarks +Get an instance of this class by accessing the [VideoDeviceController.PhotoConfirmationControl](videodevicecontroller_photoconfirmationcontrol.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices/photoconfirmationcontrol_enabled.md b/windows.media.devices/photoconfirmationcontrol_enabled.md index 422370110e..6918def4fe 100644 --- a/windows.media.devices/photoconfirmationcontrol_enabled.md +++ b/windows.media.devices/photoconfirmationcontrol_enabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.PhotoConfirmationControl.Enabled --api-type: winrt property ---- # Windows.Media.Devices.PhotoConfirmationControl.Enabled ## -description Gets or sets a value indicating whether photo confirmation is enabled. ## -property-value A value indicating whether photo confirmation is enabled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.PhotoConfirmationControl.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.PhotoConfirmationControl.Enabled + +## -description +Gets or sets a value indicating whether photo confirmation is enabled. + +## -property-value +A value indicating whether photo confirmation is enabled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/photoconfirmationcontrol_pixelformat.md b/windows.media.devices/photoconfirmationcontrol_pixelformat.md index 410edbad86..c7eaff635e 100644 --- a/windows.media.devices/photoconfirmationcontrol_pixelformat.md +++ b/windows.media.devices/photoconfirmationcontrol_pixelformat.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.PhotoConfirmationControl.PixelFormat --api-type: winrt property ---- # Windows.Media.Devices.PhotoConfirmationControl.PixelFormat ## -description Gets or sets the desired pixel format for photo confirmation frames. ## -property-value The desired pixel format for photo confirmation frames. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.PhotoConfirmationControl.PixelFormat +-api-type: winrt property +--- + + + +# Windows.Media.Devices.PhotoConfirmationControl.PixelFormat + +## -description +Gets or sets the desired pixel format for photo confirmation frames. + +## -property-value +The desired pixel format for photo confirmation frames. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/photoconfirmationcontrol_supported.md b/windows.media.devices/photoconfirmationcontrol_supported.md index a900f97791..110ecb5fd2 100644 --- a/windows.media.devices/photoconfirmationcontrol_supported.md +++ b/windows.media.devices/photoconfirmationcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.PhotoConfirmationControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.PhotoConfirmationControl.Supported ## -description Gets a value indicating whether photo confirmation is supported by the capture device. ## -property-value A value indicating whether photo confirmation is supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.PhotoConfirmationControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.PhotoConfirmationControl.Supported + +## -description +Gets a value indicating whether photo confirmation is supported by the capture device. + +## -property-value +A value indicating whether photo confirmation is supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/redialrequestedeventargs_handled_1519539088.md b/windows.media.devices/redialrequestedeventargs_handled_1519539088.md index 8941630c77..6811c4856b 100644 --- a/windows.media.devices/redialrequestedeventargs_handled_1519539088.md +++ b/windows.media.devices/redialrequestedeventargs_handled_1519539088.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.RedialRequestedEventArgs.Handled --api-type: winrt method ---- # Windows.Media.Devices.RedialRequestedEventArgs.Handled ## -description Indicates that the [RedialRequested](callcontrol_redialrequested.md) event has been handled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.RedialRequestedEventArgs.Handled +-api-type: winrt method +--- + + + +# Windows.Media.Devices.RedialRequestedEventArgs.Handled + +## -description +Indicates that the [RedialRequested](callcontrol_redialrequested.md) event has been handled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest.md b/windows.media.devices/regionofinterest.md index e87d8d16b9..6f029d561f 100644 --- a/windows.media.devices/regionofinterest.md +++ b/windows.media.devices/regionofinterest.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.RegionOfInterest --api-type: winrt class ---- # Windows.Media.Devices.RegionOfInterest ## -description Represents a region of interest which is a rectangular region on the image which is used for functions such as focus and exposure. ## -remarks Get an instance of this class by accessing the [RegionOfInterest](regionofinterest_regionofinterest.md) property. The region of interest specifies the rectangular area of preview that functions such as focus and exposure are computed over. This enables scenarios such as tap to focus. ## -examples ## -see-also [RegionsOfInterest](regionsofinterestcontrol.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.RegionOfInterest +-api-type: winrt class +--- + + + +# Windows.Media.Devices.RegionOfInterest + +## -description +Represents a region of interest which is a rectangular region on the image which is used for functions such as focus and exposure. + +## -remarks +Get an instance of this class by accessing the [RegionOfInterest](regionofinterest_regionofinterest.md) property. + +The region of interest specifies the rectangular area of preview that functions such as focus and exposure are computed over. This enables scenarios such as tap to focus. + +## -examples + +## -see-also +[RegionsOfInterest](regionsofinterestcontrol.md) \ No newline at end of file diff --git a/windows.media.devices/regionofinterest_autoexposureenabled.md b/windows.media.devices/regionofinterest_autoexposureenabled.md index a43c1206fc..613218b0f9 100644 --- a/windows.media.devices/regionofinterest_autoexposureenabled.md +++ b/windows.media.devices/regionofinterest_autoexposureenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.AutoExposureEnabled --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.AutoExposureEnabled ## -description Gets or sets a value that specifies if auto exposure is enabled. ## -property-value **true** if auto exposure is enabled; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.AutoExposureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.AutoExposureEnabled + +## -description +Gets or sets a value that specifies if auto exposure is enabled. + +## -property-value +**true** if auto exposure is enabled; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_autofocusenabled.md b/windows.media.devices/regionofinterest_autofocusenabled.md index eda9c11fec..a500ff9c79 100644 --- a/windows.media.devices/regionofinterest_autofocusenabled.md +++ b/windows.media.devices/regionofinterest_autofocusenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.AutoFocusEnabled --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.AutoFocusEnabled ## -description Gets or sets a value that specifies if auto focus is enabled. ## -property-value **true** if auto focus is enabled; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.AutoFocusEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.AutoFocusEnabled + +## -description +Gets or sets a value that specifies if auto focus is enabled. + +## -property-value +**true** if auto focus is enabled; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_autowhitebalanceenabled.md b/windows.media.devices/regionofinterest_autowhitebalanceenabled.md index 573f52d040..7887bb75c0 100644 --- a/windows.media.devices/regionofinterest_autowhitebalanceenabled.md +++ b/windows.media.devices/regionofinterest_autowhitebalanceenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.AutoWhiteBalanceEnabled --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.AutoWhiteBalanceEnabled ## -description Gets or sets a value that specifies if auto white balance is enabled. ## -property-value **true** if auto white balance; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.AutoWhiteBalanceEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.AutoWhiteBalanceEnabled + +## -description +Gets or sets a value that specifies if auto white balance is enabled. + +## -property-value +**true** if auto white balance; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_bounds.md b/windows.media.devices/regionofinterest_bounds.md index b4e9fce782..1d2c0e1e50 100644 --- a/windows.media.devices/regionofinterest_bounds.md +++ b/windows.media.devices/regionofinterest_bounds.md @@ -1,3 +1,27 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.Bounds --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.Bounds ## -description Gets or sets the rectangle that defines the region of focus. ## -property-value The rectangle that defines the region of focus. ## -remarks To specify a point with non-normalized coordinates, meaning the [BoundsNormalized](regionofinterest_boundsnormalized.md) property is not set or set to FALSE, you should specify a rectangle with width of 1 and height of 1. To specify a point with normalized coordinates, meaning [BoundsNormalized](regionofinterest_boundsnormalized.md) is set to TRUE, you should specify a rectangle with width of FLT_EPSILON and height of FLT_EPSILON. If the region of interest specified by the developer is smaller than what is supported by the hardware, the driver will default to the smallest supported rectangle possible that fully contains the specified region. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.Bounds +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.Bounds + +## -description +Gets or sets the rectangle that defines the region of focus. + +## -property-value +The rectangle that defines the region of focus. + +## -remarks +To specify a point with non-normalized coordinates, meaning the [BoundsNormalized](regionofinterest_boundsnormalized.md) property is not set or set to FALSE, you should specify a rectangle with width of 1 and height of 1. + +To specify a point with normalized coordinates, meaning [BoundsNormalized](regionofinterest_boundsnormalized.md) is set to TRUE, you should specify a rectangle with width of FLT_EPSILON and height of FLT_EPSILON. + +If the region of interest specified by the developer is smaller than what is supported by the hardware, the driver will default to the smallest supported rectangle possible that fully contains the specified region. + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_boundsnormalized.md b/windows.media.devices/regionofinterest_boundsnormalized.md index 22a0b7407b..6b087e4805 100644 --- a/windows.media.devices/regionofinterest_boundsnormalized.md +++ b/windows.media.devices/regionofinterest_boundsnormalized.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.BoundsNormalized --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.BoundsNormalized ## -description Gets or sets a value indicating whether the [Bounds](regionofinterest_bounds.md) Rect is in pixels or is mapped to a range of 0 to 1.0. ## -property-value A value indicating whether the [Bounds](regionofinterest_bounds.md) Rect is in pixels or is mapped to a range of 0 to 1.0. ## -remarks For information on how this property affects the bounds of the region of interest, see the [Bounds](regionofinterest_bounds.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.BoundsNormalized +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.BoundsNormalized + +## -description +Gets or sets a value indicating whether the [Bounds](regionofinterest_bounds.md) Rect is in pixels or is mapped to a range of 0 to 1.0. + +## -property-value +A value indicating whether the [Bounds](regionofinterest_bounds.md) Rect is in pixels or is mapped to a range of 0 to 1.0. + +## -remarks +For information on how this property affects the bounds of the region of interest, see the [Bounds](regionofinterest_bounds.md) property. + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_regionofinterest_1221375020.md b/windows.media.devices/regionofinterest_regionofinterest_1221375020.md index 37e8af613e..e311bbc523 100644 --- a/windows.media.devices/regionofinterest_regionofinterest_1221375020.md +++ b/windows.media.devices/regionofinterest_regionofinterest_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.RegionOfInterest.#ctor --api-type: winrt method ---- # Windows.Media.Devices.RegionOfInterest.RegionOfInterest ## -description Creates a new instance of the [RegionOfInterest](regionofinterest.md) control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.RegionOfInterest.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Devices.RegionOfInterest.RegionOfInterest + +## -description +Creates a new instance of the [RegionOfInterest](regionofinterest.md) control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_type.md b/windows.media.devices/regionofinterest_type.md index 541f0e1e6c..0a2fa84c0e 100644 --- a/windows.media.devices/regionofinterest_type.md +++ b/windows.media.devices/regionofinterest_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.Type --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.Type ## -description Gets or sets the type of region represented by the [RegionOfInterest](regionofinterest.md) object. ## -property-value The type of region represented by the [RegionOfInterest](regionofinterest.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.Type +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.Type + +## -description +Gets or sets the type of region represented by the [RegionOfInterest](regionofinterest.md) object. + +## -property-value +The type of region represented by the [RegionOfInterest](regionofinterest.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionofinterest_weight.md b/windows.media.devices/regionofinterest_weight.md index 9040608d8b..8789fac95c 100644 --- a/windows.media.devices/regionofinterest_weight.md +++ b/windows.media.devices/regionofinterest_weight.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionOfInterest.Weight --api-type: winrt property ---- # Windows.Media.Devices.RegionOfInterest.Weight ## -description Gets or sets the weight of the region of interest. ## -property-value Gets or sets the weight of the region of interest which is a value from 0-100. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionOfInterest.Weight +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionOfInterest.Weight + +## -description +Gets or sets the weight of the region of interest. + +## -property-value +Gets or sets the weight of the region of interest which is a value from 0-100. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionsofinterestcontrol.md b/windows.media.devices/regionsofinterestcontrol.md index f5b126afe8..28fd2c57d5 100644 --- a/windows.media.devices/regionsofinterestcontrol.md +++ b/windows.media.devices/regionsofinterestcontrol.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Devices.RegionsOfInterestControl --api-type: winrt class ---- # Windows.Media.Devices.RegionsOfInterestControl ## -description Provides functionality to mange the regions of interest on a device. ## -remarks The region of interest specifies the rectangular area of preview that functions such as focus and exposure are computed over. This enables scenarios such as tap to focus. You can access the [RegionsOfInterestControl](regionsofinterestcontrol.md) for the capture device through the [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). For how-to guidance for using the **RegionOfInterest** object, see [Effects for analyzing camera frames](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). ## -examples ## -see-also [RegionOfInterest](regionofinterest.md), [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Effects for analyzing camera frames](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.RegionsOfInterestControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl + +## -description +Provides functionality to mange the regions of interest on a device. + +## -remarks +The region of interest specifies the rectangular area of preview that functions such as focus and exposure are computed over. This enables scenarios such as tap to focus. + +You can access the [RegionsOfInterestControl](regionsofinterestcontrol.md) for the capture device through the [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +For how-to guidance for using the **RegionOfInterest** object, see [Effects for analyzing camera frames](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). + +## -examples + +## -see-also +[RegionOfInterest](regionofinterest.md), [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Effects for analyzing camera frames](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture) \ No newline at end of file diff --git a/windows.media.devices/regionsofinterestcontrol_autoexposuresupported.md b/windows.media.devices/regionsofinterestcontrol_autoexposuresupported.md index 8d468747ad..b02065ff74 100644 --- a/windows.media.devices/regionsofinterestcontrol_autoexposuresupported.md +++ b/windows.media.devices/regionsofinterestcontrol_autoexposuresupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionsOfInterestControl.AutoExposureSupported --api-type: winrt property ---- # Windows.Media.Devices.RegionsOfInterestControl.AutoExposureSupported ## -description Gets a value that specifies if auto exposure is supported on the capture device. ## -property-value **true** if auto exposure is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionsOfInterestControl.AutoExposureSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.AutoExposureSupported + +## -description +Gets a value that specifies if auto exposure is supported on the capture device. + +## -property-value +**true** if auto exposure is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionsofinterestcontrol_autofocussupported.md b/windows.media.devices/regionsofinterestcontrol_autofocussupported.md index 406972a61d..6ace8c9dd4 100644 --- a/windows.media.devices/regionsofinterestcontrol_autofocussupported.md +++ b/windows.media.devices/regionsofinterestcontrol_autofocussupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionsOfInterestControl.AutoFocusSupported --api-type: winrt property ---- # Windows.Media.Devices.RegionsOfInterestControl.AutoFocusSupported ## -description Gets a value that specifies if auto focus is supported on the capture device. ## -property-value **true** if auto focus is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionsOfInterestControl.AutoFocusSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.AutoFocusSupported + +## -description +Gets a value that specifies if auto focus is supported on the capture device. + +## -property-value +**true** if auto focus is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionsofinterestcontrol_autowhitebalancesupported.md b/windows.media.devices/regionsofinterestcontrol_autowhitebalancesupported.md index 34cbe8a297..f7c59da965 100644 --- a/windows.media.devices/regionsofinterestcontrol_autowhitebalancesupported.md +++ b/windows.media.devices/regionsofinterestcontrol_autowhitebalancesupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionsOfInterestControl.AutoWhiteBalanceSupported --api-type: winrt property ---- # Windows.Media.Devices.RegionsOfInterestControl.AutoWhiteBalanceSupported ## -description Gets a value that specifies if auto white balance is supported on the capture device. ## -property-value **true** if auto white balance is supported; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionsOfInterestControl.AutoWhiteBalanceSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.AutoWhiteBalanceSupported + +## -description +Gets a value that specifies if auto white balance is supported on the capture device. + +## -property-value +**true** if auto white balance is supported; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionsofinterestcontrol_clearregionsasync_692756633.md b/windows.media.devices/regionsofinterestcontrol_clearregionsasync_692756633.md index 554078e70d..b56f45b1cb 100644 --- a/windows.media.devices/regionsofinterestcontrol_clearregionsasync_692756633.md +++ b/windows.media.devices/regionsofinterestcontrol_clearregionsasync_692756633.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Devices.RegionsOfInterestControl.ClearRegionsAsync --api-type: winrt method ---- # Windows.Media.Devices.RegionsOfInterestControl.ClearRegionsAsync ## -description Asynchronously clears the regions of interests. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.RegionsOfInterestControl.ClearRegionsAsync +-api-type: winrt method +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.ClearRegionsAsync + +## -description +Asynchronously clears the regions of interests. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionsofinterestcontrol_maxregions.md b/windows.media.devices/regionsofinterestcontrol_maxregions.md index d0abe02c50..e96a3252b7 100644 --- a/windows.media.devices/regionsofinterestcontrol_maxregions.md +++ b/windows.media.devices/regionsofinterestcontrol_maxregions.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.RegionsOfInterestControl.MaxRegions --api-type: winrt property ---- # Windows.Media.Devices.RegionsOfInterestControl.MaxRegions ## -description Gets the maximum number of regions of interest that can be specified. ## -property-value The maximum number of regions of interest. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.RegionsOfInterestControl.MaxRegions +-api-type: winrt property +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.MaxRegions + +## -description +Gets the maximum number of regions of interest that can be specified. + +## -property-value +The maximum number of regions of interest. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/regionsofinterestcontrol_setregionsasync_745185679.md b/windows.media.devices/regionsofinterestcontrol_setregionsasync_745185679.md index 20a522caf8..fdf5ec159b 100644 --- a/windows.media.devices/regionsofinterestcontrol_setregionsasync_745185679.md +++ b/windows.media.devices/regionsofinterestcontrol_setregionsasync_745185679.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync(Windows.Foundation.Collections.IIterable{Windows.Media.Devices.RegionOfInterest}) --api-type: winrt method ---- # Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync ## -description Asynchronously sets the regions of interest. ## -parameters ### -param regions The regions of interest. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [SetRegionsAsync(IIterable(RegionOfInterest), Boolean)](regionsofinterestcontrol_setregionsasync_838101385.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync(Windows.Foundation.Collections.IIterable{Windows.Media.Devices.RegionOfInterest}) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync + +## -description +Asynchronously sets the regions of interest. + +## -parameters +### -param regions +The regions of interest. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[SetRegionsAsync(IIterable(RegionOfInterest), Boolean)](regionsofinterestcontrol_setregionsasync_838101385.md) \ No newline at end of file diff --git a/windows.media.devices/regionsofinterestcontrol_setregionsasync_838101385.md b/windows.media.devices/regionsofinterestcontrol_setregionsasync_838101385.md index 2267d83ce0..5eead43eef 100644 --- a/windows.media.devices/regionsofinterestcontrol_setregionsasync_838101385.md +++ b/windows.media.devices/regionsofinterestcontrol_setregionsasync_838101385.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync(Windows.Foundation.Collections.IIterable{Windows.Media.Devices.RegionOfInterest},System.Boolean) --api-type: winrt method ---- # Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync ## -description Asynchronously sets the regions of interest and specifies if the values should be locked. ## -parameters ### -param regions The regions of interests. ### -param lockValues Specifies if the values should be locked. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [SetRegionsAsync(IIterable(RegionOfInterest))](regionsofinterestcontrol_setregionsasync_745185679.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync(Windows.Foundation.Collections.IIterable{Windows.Media.Devices.RegionOfInterest},System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.RegionsOfInterestControl.SetRegionsAsync + +## -description +Asynchronously sets the regions of interest and specifies if the values should be locked. + +## -parameters +### -param regions +The regions of interests. + +### -param lockValues +Specifies if the values should be locked. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[SetRegionsAsync(IIterable(RegionOfInterest))](regionsofinterestcontrol_setregionsasync_745185679.md) \ No newline at end of file diff --git a/windows.media.devices/scenemodecontrol.md b/windows.media.devices/scenemodecontrol.md index cbaa2155ce..fd07457997 100644 --- a/windows.media.devices/scenemodecontrol.md +++ b/windows.media.devices/scenemodecontrol.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Devices.SceneModeControl --api-type: winrt class ---- # Windows.Media.Devices.SceneModeControl ## -description Provides functionality for controlling the scene mode settings on a capture device. ## -remarks The [SceneModeControl ](scenemodecontrol.md) enables apps to tune the post-processing of captured frames to better match the scene being recorded. The [SupportedModes](scenemodecontrol_supportedmodes.md) enumeration specifies the modes, such as [Snow](capturescenemode.md), [Night](capturescenemode.md), and [Sport](capturescenemode.md), that are supported by the device. To select a mode, call [SceneModeControl.SetValueAsync](scenemodecontrol_setvalueasync.md). You can access the [SceneModeControl ](scenemodecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). ## -examples ## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.SceneModeControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.SceneModeControl + +## -description +Provides functionality for controlling the scene mode settings on a capture device. + +## -remarks +The [SceneModeControl ](scenemodecontrol.md) enables apps to tune the post-processing of captured frames to better match the scene being recorded. The [SupportedModes](scenemodecontrol_supportedmodes.md) enumeration specifies the modes, such as [Snow](capturescenemode.md), [Night](capturescenemode.md), and [Sport](capturescenemode.md), that are supported by the device. + +To select a mode, call [SceneModeControl.SetValueAsync](scenemodecontrol_setvalueasync.md). + +You can access the [SceneModeControl ](scenemodecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +## -examples + +## -see-also +[MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md) \ No newline at end of file diff --git a/windows.media.devices/scenemodecontrol_setvalueasync_1270895798.md b/windows.media.devices/scenemodecontrol_setvalueasync_1270895798.md index bd950f0e18..309070a1bf 100644 --- a/windows.media.devices/scenemodecontrol_setvalueasync_1270895798.md +++ b/windows.media.devices/scenemodecontrol_setvalueasync_1270895798.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.SceneModeControl.SetValueAsync(Windows.Media.Devices.CaptureSceneMode) --api-type: winrt method ---- # Windows.Media.Devices.SceneModeControl.SetValueAsync ## -description Asynchronously sets the color temperature [Value](whitebalancecontrol_value.md). ## -parameters ### -param sceneMode The scene mode to set the [Value](scenemodecontrol_value.md) property to. ## -returns The object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also [SceneModeControl.Value](scenemodecontrol_value.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.SceneModeControl.SetValueAsync(Windows.Media.Devices.CaptureSceneMode) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.SceneModeControl.SetValueAsync + +## -description +Asynchronously sets the color temperature [Value](whitebalancecontrol_value.md). + +## -parameters +### -param sceneMode +The scene mode to set the [Value](scenemodecontrol_value.md) property to. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also +[SceneModeControl.Value](scenemodecontrol_value.md) \ No newline at end of file diff --git a/windows.media.devices/scenemodecontrol_supportedmodes.md b/windows.media.devices/scenemodecontrol_supportedmodes.md index 4fce74478e..1aeb0c0cac 100644 --- a/windows.media.devices/scenemodecontrol_supportedmodes.md +++ b/windows.media.devices/scenemodecontrol_supportedmodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.SceneModeControl.SupportedModes --api-type: winrt property ---- # Windows.Media.Devices.SceneModeControl.SupportedModes ## -description Gets the scene modes supported on the capture device. ## -property-value The supported scene modes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.SceneModeControl.SupportedModes +-api-type: winrt property +--- + + + +# Windows.Media.Devices.SceneModeControl.SupportedModes + +## -description +Gets the scene modes supported on the capture device. + +## -property-value +The supported scene modes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/scenemodecontrol_value.md b/windows.media.devices/scenemodecontrol_value.md index 8491a88830..1956055dbf 100644 --- a/windows.media.devices/scenemodecontrol_value.md +++ b/windows.media.devices/scenemodecontrol_value.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.Devices.SceneModeControl.Value --api-type: winrt property ---- # Windows.Media.Devices.SceneModeControl.Value ## -description Gets the current scene mod ethe capture device is set to. ## -property-value The scene mode. ## -remarks To set this property, call [SetValueAsync](scenemodecontrol_setvalueasync.md). ## -examples ## -see-also [SetValueAsync](scenemodecontrol_setvalueasync.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.SceneModeControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.SceneModeControl.Value + +## -description +Gets the current scene mod ethe capture device is set to. + +## -property-value +The scene mode. + +## -remarks +To set this property, call [SetValueAsync](scenemodecontrol_setvalueasync.md). + +## -examples + +## -see-also +[SetValueAsync](scenemodecontrol_setvalueasync.md) \ No newline at end of file diff --git a/windows.media.devices/torchcontrol.md b/windows.media.devices/torchcontrol.md index aff20b7589..86e69286a3 100644 --- a/windows.media.devices/torchcontrol.md +++ b/windows.media.devices/torchcontrol.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Media.Devices.TorchControl --api-type: winrt class ---- # Windows.Media.Devices.TorchControl ## -description Provides functionality for controlling the torch LED settings on a capture device. ## -remarks The [TorchControl](torchcontrol.md) enables apps to manage the torch LED on a device. This can used in capture apps or in non-capture app to do things like brighten a room. You can find out if a device supports this control by checking [TorchControl.Supported](torchcontrol_supported.md). You can access the [TorchControl](torchcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). For how-to guidance for using the **TorchControl**, see [Camera-independent Flashlight](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-independent-flashlight). ## -examples ## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.TorchControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.TorchControl + +## -description +Provides functionality for controlling the torch LED settings on a capture device. + +## -remarks +The [TorchControl](torchcontrol.md) enables apps to manage the torch LED on a device. This can used in capture apps or in non-capture app to do things like brighten a room. + +You can find out if a device supports this control by checking [TorchControl.Supported](torchcontrol_supported.md). + +You can access the [TorchControl](torchcontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +For how-to guidance for using the **TorchControl**, see [Camera-independent Flashlight](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera-independent-flashlight). + +## -examples + +## -see-also +[MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md) \ No newline at end of file diff --git a/windows.media.devices/torchcontrol_enabled.md b/windows.media.devices/torchcontrol_enabled.md index f7463b1464..64f177ac8d 100644 --- a/windows.media.devices/torchcontrol_enabled.md +++ b/windows.media.devices/torchcontrol_enabled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.TorchControl.Enabled --api-type: winrt property ---- # Windows.Media.Devices.TorchControl.Enabled ## -description Gets or sets a value that enables and disables the torch LED on the device. ## -property-value **true** if the torch LED is enabled; otherwise, **false**. ## -remarks On some devices the torch will not emit light, even if **Enabled** is set to true, unless the device has a preview stream running and is actively capturing video. The recommended order of operations is to turn on the video preview, then turn on the torch by setting **Enabled** to true, and then initiate video capture. On some devices the torch will light up after the preview is started. On other devices, the torch may not light up until video capture is started. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.TorchControl.Enabled +-api-type: winrt property +--- + + + +# Windows.Media.Devices.TorchControl.Enabled + +## -description +Gets or sets a value that enables and disables the torch LED on the device. + +## -property-value +**true** if the torch LED is enabled; otherwise, **false**. + +## -remarks +On some devices the torch will not emit light, even if **Enabled** is set to true, unless the device has a preview stream running and is actively capturing video. The recommended order of operations is to turn on the video preview, then turn on the torch by setting **Enabled** to true, and then initiate video capture. On some devices the torch will light up after the preview is started. On other devices, the torch may not light up until video capture is started. + +## -examples + +## -see-also diff --git a/windows.media.devices/torchcontrol_powerpercent.md b/windows.media.devices/torchcontrol_powerpercent.md index 61d9762b39..7f45375db2 100644 --- a/windows.media.devices/torchcontrol_powerpercent.md +++ b/windows.media.devices/torchcontrol_powerpercent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.TorchControl.PowerPercent --api-type: winrt property ---- # Windows.Media.Devices.TorchControl.PowerPercent ## -description Gets or sets the intensity of the torch LED. ## -property-value The power percent the torch LED is set to. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.TorchControl.PowerPercent +-api-type: winrt property +--- + + + +# Windows.Media.Devices.TorchControl.PowerPercent + +## -description +Gets or sets the intensity of the torch LED. + +## -property-value +The power percent the torch LED is set to. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/torchcontrol_powersupported.md b/windows.media.devices/torchcontrol_powersupported.md index dc5d5a708c..0d80e9a635 100644 --- a/windows.media.devices/torchcontrol_powersupported.md +++ b/windows.media.devices/torchcontrol_powersupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.TorchControl.PowerSupported --api-type: winrt property ---- # Windows.Media.Devices.TorchControl.PowerSupported ## -description Gets a value that specifics if the device allows the torch LED power settings to be changed. ## -property-value **true** if the power settings can be modified; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.TorchControl.PowerSupported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.TorchControl.PowerSupported + +## -description +Gets a value that specifics if the device allows the torch LED power settings to be changed. + +## -property-value +**true** if the power settings can be modified; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/torchcontrol_supported.md b/windows.media.devices/torchcontrol_supported.md index f0940680bb..a0fa06cd2c 100644 --- a/windows.media.devices/torchcontrol_supported.md +++ b/windows.media.devices/torchcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.TorchControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.TorchControl.Supported ## -description Gets a value that specifies if the capture device supports the torch control. ## -property-value **true** if the capture device supports the torch control; otherwise, **false**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.TorchControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.TorchControl.Supported + +## -description +Gets a value that specifies if the capture device supports the torch control. + +## -property-value +**true** if the capture device supports the torch control; otherwise, **false**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_advancedphotocontrol.md b/windows.media.devices/videodevicecontroller_advancedphotocontrol.md index b9b7d56772..f4eed320f0 100644 --- a/windows.media.devices/videodevicecontroller_advancedphotocontrol.md +++ b/windows.media.devices/videodevicecontroller_advancedphotocontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.AdvancedPhotoControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.AdvancedPhotoControl ## -description Gets the advanced photo capture control for this video device. ## -property-value The advanced photo capture control ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.AdvancedPhotoControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.AdvancedPhotoControl + +## -description +Gets the advanced photo capture control for this video device. + +## -property-value +The advanced photo capture control + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_backlightcompensation.md b/windows.media.devices/videodevicecontroller_backlightcompensation.md index fb6f4b9d83..9595666786 100644 --- a/windows.media.devices/videodevicecontroller_backlightcompensation.md +++ b/windows.media.devices/videodevicecontroller_backlightcompensation.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.BacklightCompensation --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.BacklightCompensation ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the whether back-light compensation is enabled on the camera. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the back-light compensation. ## -remarks If the value is 1, back-light compensation is enabled. If the value is 0, back-light compensation is disabled. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.BacklightCompensation +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.BacklightCompensation + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the whether back-light compensation is enabled on the camera. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the back-light compensation. + +## -remarks +If the value is 1, back-light compensation is enabled. If the value is 0, back-light compensation is disabled. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_brightness.md b/windows.media.devices/videodevicecontroller_brightness.md index 388195ceab..6f1fbfa25e 100644 --- a/windows.media.devices/videodevicecontroller_brightness.md +++ b/windows.media.devices/videodevicecontroller_brightness.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Brightness --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Brightness ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the brightness level on the camera. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the brightness. ## -remarks For NTSC sources, brightness is expressed in IRE units multiplied by 100. For non-NTSC sources, the units are arbitrary, with 0 representing blanking and 10000 representing pure white. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Brightness +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Brightness + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the brightness level on the camera. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the brightness. + +## -remarks +For NTSC sources, brightness is expressed in IRE units multiplied by 100. For non-NTSC sources, the units are arbitrary, with 0 representing blanking and 10000 representing pure white. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_contrast.md b/windows.media.devices/videodevicecontroller_contrast.md index ce0f6802a8..f763677151 100644 --- a/windows.media.devices/videodevicecontroller_contrast.md +++ b/windows.media.devices/videodevicecontroller_contrast.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Contrast --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Contrast ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the contrast level on the camera. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the contrast. ## -remarks Contrast is specified as a gain factor multiplied by 100. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Contrast +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Contrast + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the contrast level on the camera. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the contrast. + +## -remarks +Contrast is specified as a gain factor multiplied by 100. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_desiredoptimization.md b/windows.media.devices/videodevicecontroller_desiredoptimization.md index 06fd9718e4..10645088e4 100644 --- a/windows.media.devices/videodevicecontroller_desiredoptimization.md +++ b/windows.media.devices/videodevicecontroller_desiredoptimization.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.DesiredOptimization --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.DesiredOptimization ## -description Gets or sets a value that indicates the optimizations the capture device should use to prioritize high quality picture, low latency, or low power consumption during video capture. ## -property-value A value that indicates the optimizations the capture device should use. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.DesiredOptimization +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.DesiredOptimization + +## -description +Gets or sets a value that indicates the optimizations the capture device should use to prioritize high quality picture, low latency, or low power consumption during video capture. + +## -property-value +A value that indicates the optimizations the capture device should use. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_exposure.md b/windows.media.devices/videodevicecontroller_exposure.md index 7f70f6d106..edf068c2b9 100644 --- a/windows.media.devices/videodevicecontroller_exposure.md +++ b/windows.media.devices/videodevicecontroller_exposure.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Exposure --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Exposure ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's exposure time. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the exposure time. ## -remarks Exposure is specified in log base 2 seconds. For values less than zero, the exposure time is 1/(2n) seconds. For values of zero and above, the exposure time is 2n seconds. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Exposure +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Exposure + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's exposure time. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the exposure time. + +## -remarks +Exposure is specified in log base 2 seconds. For values less than zero, the exposure time is 1/(2n) seconds. For values of zero and above, the exposure time is 2n seconds. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_exposurecompensationcontrol.md b/windows.media.devices/videodevicecontroller_exposurecompensationcontrol.md index 87667101c2..287688caed 100644 --- a/windows.media.devices/videodevicecontroller_exposurecompensationcontrol.md +++ b/windows.media.devices/videodevicecontroller_exposurecompensationcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.ExposureCompensationControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.ExposureCompensationControl ## -description Gets the exposure compensation control for this video device. ## -property-value The exposure compensation control ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.ExposureCompensationControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.ExposureCompensationControl + +## -description +Gets the exposure compensation control for this video device. + +## -property-value +The exposure compensation control + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_exposurecontrol.md b/windows.media.devices/videodevicecontroller_exposurecontrol.md index 546b45ee13..196b38736a 100644 --- a/windows.media.devices/videodevicecontroller_exposurecontrol.md +++ b/windows.media.devices/videodevicecontroller_exposurecontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.ExposureControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.ExposureControl ## -description Gets the exposure control for this video device. ## -property-value The exposure control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.ExposureControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.ExposureControl + +## -description +Gets the exposure control for this video device. + +## -property-value +The exposure control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_exposurepriorityvideocontrol.md b/windows.media.devices/videodevicecontroller_exposurepriorityvideocontrol.md index be11f0469c..f0737d8510 100644 --- a/windows.media.devices/videodevicecontroller_exposurepriorityvideocontrol.md +++ b/windows.media.devices/videodevicecontroller_exposurepriorityvideocontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.ExposurePriorityVideoControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.ExposurePriorityVideoControl ## -description Gets the [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -property-value The [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.ExposurePriorityVideoControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.ExposurePriorityVideoControl + +## -description +Gets the [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -property-value +The [ExposurePriorityVideoControl](exposurepriorityvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_flashcontrol.md b/windows.media.devices/videodevicecontroller_flashcontrol.md index 2ea3d28492..33ac0f9395 100644 --- a/windows.media.devices/videodevicecontroller_flashcontrol.md +++ b/windows.media.devices/videodevicecontroller_flashcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.FlashControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.FlashControl ## -description Gets the flash control for this video device. ## -property-value The flash control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.FlashControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.FlashControl + +## -description +Gets the flash control for this video device. + +## -property-value +The flash control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_focus.md b/windows.media.devices/videodevicecontroller_focus.md index a51f059e83..f714cd9de5 100644 --- a/windows.media.devices/videodevicecontroller_focus.md +++ b/windows.media.devices/videodevicecontroller_focus.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Focus --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Focus ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's focus setting. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the focus. ## -remarks Focus is specified in millimeters. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Focus +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Focus + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's focus setting. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the focus. + +## -remarks +Focus is specified in millimeters. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_focuscontrol.md b/windows.media.devices/videodevicecontroller_focuscontrol.md index d6e6c535c8..61a30bdbdc 100644 --- a/windows.media.devices/videodevicecontroller_focuscontrol.md +++ b/windows.media.devices/videodevicecontroller_focuscontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.FocusControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.FocusControl ## -description Gets the focus control for this video device. ## -property-value The focus control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.FocusControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.FocusControl + +## -description +Gets the focus control for this video device. + +## -property-value +The focus control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_getavailablemediastreamproperties_946867392.md b/windows.media.devices/videodevicecontroller_getavailablemediastreamproperties_946867392.md index 00b9ef9a6b..168240a330 100644 --- a/windows.media.devices/videodevicecontroller_getavailablemediastreamproperties_946867392.md +++ b/windows.media.devices/videodevicecontroller_getavailablemediastreamproperties_946867392.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.GetAvailableMediaStreamProperties(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.GetAvailableMediaStreamProperties ## -description Gets a list of the supported encoding properties for the video device. ## -parameters ### -param mediaStreamType The type of media stream for which to get the properties. ## -returns A list of the supported encoding properties. ## -remarks The encoding properties returned from this method can either be of type [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) or [ImageEncodingProperties](../windows.media.mediaproperties/imageencodingproperties.md), regardless of the stream type you specify. For this reason, you must check the type of each returned [IMediaEncodingProperties](../windows.media.mediaproperties/imediaencodingproperties.md) object and cast to the appropriate type before accessing the properties of the object. The article [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) provides the complete code for a helper class that handles all necessary type-checking and casting for you. ## -examples ## -see-also [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.GetAvailableMediaStreamProperties(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.GetAvailableMediaStreamProperties + +## -description +Gets a list of the supported encoding properties for the video device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to get the properties. + +## -returns +A list of the supported encoding properties. + +## -remarks +The encoding properties returned from this method can either be of type [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) or [ImageEncodingProperties](../windows.media.mediaproperties/imageencodingproperties.md), regardless of the stream type you specify. For this reason, you must check the type of each returned [IMediaEncodingProperties](../windows.media.mediaproperties/imediaencodingproperties.md) object and cast to the appropriate type before accessing the properties of the object. The article [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) provides the complete code for a helper class that handles all necessary type-checking and casting for you. + +## -examples + +## -see-also +[Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md b/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md index 258b2f77db..fbc2d358a2 100644 --- a/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md +++ b/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.GetDeviceProperty(System.String) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.GetDeviceProperty ## -description Gets a property on the camera. You can use this method to query properties that are specific to a particular camera. ## -parameters ### -param propertyId The property identifier. ## -returns The property value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.GetDeviceProperty(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.GetDeviceProperty + +## -description +Gets a property on the camera. You can use this method to query properties that are specific to a particular camera. + +## -parameters +### -param propertyId +The property identifier. + + +## -returns +The property value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_getmediastreamproperties_978288466.md b/windows.media.devices/videodevicecontroller_getmediastreamproperties_978288466.md index e768b363aa..1a34173130 100644 --- a/windows.media.devices/videodevicecontroller_getmediastreamproperties_978288466.md +++ b/windows.media.devices/videodevicecontroller_getmediastreamproperties_978288466.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.GetMediaStreamProperties(Windows.Media.Capture.MediaStreamType) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.GetMediaStreamProperties ## -description Gets the encoding properties for the specified media stream type for the video device. ## -parameters ### -param mediaStreamType The type of media stream for which to get the properties. ## -returns The encoding properties. ## -remarks The encoding properties returned from this method can either be of type [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) or [ImageEncodingProperties](../windows.media.mediaproperties/imageencodingproperties.md), regardless of the stream type you specify. For this reason, you must check the type of each returned [IMediaEncodingProperties](../windows.media.mediaproperties/imediaencodingproperties.md) object and cast to the appropriate type before accessing the properties of the object. The article [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) provides the complete code for a helper class that handles all necessary type-checking and casting for you. ## -examples ## -see-also [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties), [Camera resolution sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624252) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.GetMediaStreamProperties(Windows.Media.Capture.MediaStreamType) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.GetMediaStreamProperties + +## -description +Gets the encoding properties for the specified media stream type for the video device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to get the properties. + +## -returns +The encoding properties. + +## -remarks +The encoding properties returned from this method can either be of type [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) or [ImageEncodingProperties](../windows.media.mediaproperties/imageencodingproperties.md), regardless of the stream type you specify. For this reason, you must check the type of each returned [IMediaEncodingProperties](../windows.media.mediaproperties/imediaencodingproperties.md) object and cast to the appropriate type before accessing the properties of the object. The article [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) provides the complete code for a helper class that handles all necessary type-checking and casting for you. + +## -examples + +## -see-also +[Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties), [Camera resolution sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624252) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_hdrvideocontrol.md b/windows.media.devices/videodevicecontroller_hdrvideocontrol.md index 42610a7c76..578016a550 100644 --- a/windows.media.devices/videodevicecontroller_hdrvideocontrol.md +++ b/windows.media.devices/videodevicecontroller_hdrvideocontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.HdrVideoControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.HdrVideoControl ## -description Gets the [HdrVideoControl](hdrvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -property-value The [HdrVideoControl](hdrvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.HdrVideoControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.HdrVideoControl + +## -description +Gets the [HdrVideoControl](hdrvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -property-value +The [HdrVideoControl](hdrvideocontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_hue.md b/windows.media.devices/videodevicecontroller_hue.md index 30d109c733..108d048290 100644 --- a/windows.media.devices/videodevicecontroller_hue.md +++ b/windows.media.devices/videodevicecontroller_hue.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Hue --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Hue ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's hue setting. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the hue. ## -remarks Hue is specified in degrees multiplied by 100. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Hue +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Hue + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's hue setting. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the hue. + +## -remarks +Hue is specified in degrees multiplied by 100. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_isospeedcontrol.md b/windows.media.devices/videodevicecontroller_isospeedcontrol.md index 2ef041bf2f..2fed4cb2f8 100644 --- a/windows.media.devices/videodevicecontroller_isospeedcontrol.md +++ b/windows.media.devices/videodevicecontroller_isospeedcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.IsoSpeedControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.IsoSpeedControl ## -description Gets the ISO film speed control for this video device. ## -property-value The ISO film speed control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.IsoSpeedControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.IsoSpeedControl + +## -description +Gets the ISO film speed control for this video device. + +## -property-value +The ISO film speed control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_lowlagphoto.md b/windows.media.devices/videodevicecontroller_lowlagphoto.md index f4a5299709..e7c3c06786 100644 --- a/windows.media.devices/videodevicecontroller_lowlagphoto.md +++ b/windows.media.devices/videodevicecontroller_lowlagphoto.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.LowLagPhoto --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.LowLagPhoto ## -description Gets the low shutter lag photo control for this video device. ## -property-value The low shutter lag photo control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.LowLagPhoto +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.LowLagPhoto + +## -description +Gets the low shutter lag photo control for this video device. + +## -property-value +The low shutter lag photo control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_lowlagphotosequence.md b/windows.media.devices/videodevicecontroller_lowlagphotosequence.md index 1be3b30cb6..db2015f56e 100644 --- a/windows.media.devices/videodevicecontroller_lowlagphotosequence.md +++ b/windows.media.devices/videodevicecontroller_lowlagphotosequence.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.LowLagPhotoSequence --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.LowLagPhotoSequence ## -description Gets the low shutter lag photo sequence control for this video device. ## -property-value The photo sequence control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.LowLagPhotoSequence +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.LowLagPhotoSequence + +## -description +Gets the low shutter lag photo sequence control for this video device. + +## -property-value +The photo sequence control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_opticalimagestabilizationcontrol.md b/windows.media.devices/videodevicecontroller_opticalimagestabilizationcontrol.md index d9d7d1d9d2..ce1f53a160 100644 --- a/windows.media.devices/videodevicecontroller_opticalimagestabilizationcontrol.md +++ b/windows.media.devices/videodevicecontroller_opticalimagestabilizationcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.OpticalImageStabilizationControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.OpticalImageStabilizationControl ## -description Gets the [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -property-value The [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.OpticalImageStabilizationControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.OpticalImageStabilizationControl + +## -description +Gets the [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -property-value +The [OpticalImageStabilizationControl](opticalimagestabilizationcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_pan.md b/windows.media.devices/videodevicecontroller_pan.md index 193f9ecfc8..08d1ebc217 100644 --- a/windows.media.devices/videodevicecontroller_pan.md +++ b/windows.media.devices/videodevicecontroller_pan.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Pan --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Pan ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's pan setting. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the pan. ## -remarks Pan is rotation around the base of the camera (the camera's Y axis). Pan is specified in degrees. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Pan +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Pan + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's pan setting. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the pan. + +## -remarks +Pan is rotation around the base of the camera (the camera's Y axis). Pan is specified in degrees. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_photoconfirmationcontrol.md b/windows.media.devices/videodevicecontroller_photoconfirmationcontrol.md index f852f44671..35283d6a0b 100644 --- a/windows.media.devices/videodevicecontroller_photoconfirmationcontrol.md +++ b/windows.media.devices/videodevicecontroller_photoconfirmationcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.PhotoConfirmationControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.PhotoConfirmationControl ## -description Gets the photo confirmation control for this video device. ## -property-value The photo confirmation control for this video device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.PhotoConfirmationControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.PhotoConfirmationControl + +## -description +Gets the photo confirmation control for this video device. + +## -property-value +The photo confirmation control for this video device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_primaryuse.md b/windows.media.devices/videodevicecontroller_primaryuse.md index dc52f38e1a..a22cd8a24b 100644 --- a/windows.media.devices/videodevicecontroller_primaryuse.md +++ b/windows.media.devices/videodevicecontroller_primaryuse.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.PrimaryUse --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.PrimaryUse ## -description Gets or sets the primary use for the device. ## -property-value The primary use for the device. ## -remarks This property enables device to make optimization based on the intended use for the device. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.PrimaryUse +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.PrimaryUse + +## -description +Gets or sets the primary use for the device. + +## -property-value +The primary use for the device. + +## -remarks +This property enables device to make optimization based on the intended use for the device. + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_regionsofinterestcontrol.md b/windows.media.devices/videodevicecontroller_regionsofinterestcontrol.md index 146ae46854..f3eb1f2a94 100644 --- a/windows.media.devices/videodevicecontroller_regionsofinterestcontrol.md +++ b/windows.media.devices/videodevicecontroller_regionsofinterestcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.RegionsOfInterestControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.RegionsOfInterestControl ## -description Gets the regions of interest control for this video device. ## -property-value The regions of interest control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.RegionsOfInterestControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.RegionsOfInterestControl + +## -description +Gets the regions of interest control for this video device. + +## -property-value +The regions of interest control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_roll.md b/windows.media.devices/videodevicecontroller_roll.md index c830d9fd8f..6566c87744 100644 --- a/windows.media.devices/videodevicecontroller_roll.md +++ b/windows.media.devices/videodevicecontroller_roll.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Roll --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Roll ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's roll setting. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the roll. ## -remarks Roll is rotation around the camera's image-viewing axis. Roll is specified in degrees. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Roll +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Roll + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's roll setting. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the roll. + +## -remarks +Roll is rotation around the camera's image-viewing axis. Roll is specified in degrees. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_scenemodecontrol.md b/windows.media.devices/videodevicecontroller_scenemodecontrol.md index 3016b4e90b..4764137fbb 100644 --- a/windows.media.devices/videodevicecontroller_scenemodecontrol.md +++ b/windows.media.devices/videodevicecontroller_scenemodecontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.SceneModeControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.SceneModeControl ## -description Gets the scene mode control for this video device. ## -property-value The scene mode control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.SceneModeControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.SceneModeControl + +## -description +Gets the scene mode control for this video device. + +## -property-value +The scene mode control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md b/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md index 90a8b9f8ca..f485acfc6d 100644 --- a/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md +++ b/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.SetDeviceProperty(System.String,System.Object) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.SetDeviceProperty ## -description Sets a property on the device. You can use this method to set properties that are specific to a particular device. ## -parameters ### -param propertyId The property identifier. ### -param propertyValue The new value of the property. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.SetDeviceProperty(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.SetDeviceProperty + +## -description +Sets a property on the device. You can use this method to set properties that are specific to a particular device. + +## -parameters +### -param propertyId +The property identifier. + + +### -param propertyValue +The new value of the property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_setmediastreampropertiesasync_835261048.md b/windows.media.devices/videodevicecontroller_setmediastreampropertiesasync_835261048.md index 1d4f50bde0..51a24e8305 100644 --- a/windows.media.devices/videodevicecontroller_setmediastreampropertiesasync_835261048.md +++ b/windows.media.devices/videodevicecontroller_setmediastreampropertiesasync_835261048.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.SetMediaStreamPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.SetMediaStreamPropertiesAsync ## -description Sets the encoding properties asynchronously for the specified media stream type for the video device. ## -parameters ### -param mediaStreamType The type of media stream for which to set the properties. ### -param mediaEncodingProperties The encoding properties to set. ## -returns An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. ## -remarks This method sets the properties on the media source, which is the video capture device. This is unlike [MediaCapture.SetEncodingPropertiesAsync](../windows.media.capture/mediacapture_setencodingpropertiesasync.md), which changes the properties of the media encoding. For this reason, with **SetMediaStreamPropertiesAsync** you can only set properties and values that are supported natively by the capture device. Get a list of a capture device's supported resolutions, frame rates, and other properties by calling [GetAvailableMediaStreamProperties](videodevicecontroller_getavailablemediastreamproperties.md). The benefit of setting the capture device properties instead of the media encoding is that the device only needs to generate enough data for the specified resolution, which can provide better performance than capturing at a high resolution and then downscaling at another point in the media capture pipeline. For more information, see [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) and the [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252). ## -examples ## -see-also [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties), [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.SetMediaStreamPropertiesAsync(Windows.Media.Capture.MediaStreamType,Windows.Media.MediaProperties.IMediaEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.SetMediaStreamPropertiesAsync + +## -description +Sets the encoding properties asynchronously for the specified media stream type for the video device. + +## -parameters +### -param mediaStreamType +The type of media stream for which to set the properties. + +### -param mediaEncodingProperties +The encoding properties to set. + +## -returns +An [IAsyncAction](../windows.foundation/iasyncaction.md) object that is used to control the asynchronous operation. + +## -remarks +This method sets the properties on the media source, which is the video capture device. This is unlike [MediaCapture.SetEncodingPropertiesAsync](../windows.media.capture/mediacapture_setencodingpropertiesasync.md), which changes the properties of the media encoding. For this reason, with **SetMediaStreamPropertiesAsync** you can only set properties and values that are supported natively by the capture device. Get a list of a capture device's supported resolutions, frame rates, and other properties by calling [GetAvailableMediaStreamProperties](videodevicecontroller_getavailablemediastreamproperties.md). The benefit of setting the capture device properties instead of the media encoding is that the device only needs to generate enough data for the specified resolution, which can provide better performance than capturing at a high resolution and then downscaling at another point in the media capture pipeline. For more information, see [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) and the [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252). + +## -examples + +## -see-also +[Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties), [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_tilt.md b/windows.media.devices/videodevicecontroller_tilt.md index f64dbc13ea..c6f8e42191 100644 --- a/windows.media.devices/videodevicecontroller_tilt.md +++ b/windows.media.devices/videodevicecontroller_tilt.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Tilt --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Tilt ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's tilt setting. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the tilt. ## -remarks Tilt points the camera's imaging plane up or down. Tilt is specified in degrees. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Tilt +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Tilt + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's tilt setting. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the tilt. + +## -remarks +Tilt points the camera's imaging plane up or down. Tilt is specified in degrees. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_torchcontrol.md b/windows.media.devices/videodevicecontroller_torchcontrol.md index 2edbc7e5cc..97044093e3 100644 --- a/windows.media.devices/videodevicecontroller_torchcontrol.md +++ b/windows.media.devices/videodevicecontroller_torchcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.TorchControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.TorchControl ## -description Gets the torch control for this video device. ## -property-value The torch control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.TorchControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.TorchControl + +## -description +Gets the torch control for this video device. + +## -property-value +The torch control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_trygetpowerlinefrequency_749793993.md b/windows.media.devices/videodevicecontroller_trygetpowerlinefrequency_749793993.md index b85b4bfa44..8f503f4555 100644 --- a/windows.media.devices/videodevicecontroller_trygetpowerlinefrequency_749793993.md +++ b/windows.media.devices/videodevicecontroller_trygetpowerlinefrequency_749793993.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.TryGetPowerlineFrequency(Windows.Media.Capture.PowerlineFrequency@) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.TryGetPowerlineFrequency ## -description Gets the local power line frequency. ## -parameters ### -param value The power line frequency. ## -returns Returns true if the method succeeded, or false otherwise. ## -remarks You can use this method if the camera supports anti-flicker processing for fluorescent lights. For how-to guidance for handling powerline frequency, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.TryGetPowerlineFrequency(Windows.Media.Capture.PowerlineFrequency@) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.TryGetPowerlineFrequency + +## -description +Gets the local power line frequency. + +## -parameters +### -param value +The power line frequency. + +## -returns +Returns true if the method succeeded, or false otherwise. + +## -remarks +You can use this method if the camera supports anti-flicker processing for fluorescent lights. + +For how-to guidance for handling powerline frequency, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_trysetpowerlinefrequency_830909544.md b/windows.media.devices/videodevicecontroller_trysetpowerlinefrequency_830909544.md index 548196f994..be8a5c3f8b 100644 --- a/windows.media.devices/videodevicecontroller_trysetpowerlinefrequency_830909544.md +++ b/windows.media.devices/videodevicecontroller_trysetpowerlinefrequency_830909544.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Devices.VideoDeviceController.TrySetPowerlineFrequency(Windows.Media.Capture.PowerlineFrequency) --api-type: winrt method ---- # Windows.Media.Devices.VideoDeviceController.TrySetPowerlineFrequency ## -description Sets the local power line frequency. ## -parameters ### -param value The power line frequency. ## -returns Returns true if the method succeeded, or false otherwise. ## -remarks You can use this method if the camera supports anti-flicker processing for fluorescent lights. For how-to guidance for handling powerline frequency, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.TrySetPowerlineFrequency(Windows.Media.Capture.PowerlineFrequency) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.TrySetPowerlineFrequency + +## -description +Sets the local power line frequency. + +## -parameters +### -param value +The power line frequency. + +## -returns +Returns true if the method succeeded, or false otherwise. + +## -remarks +You can use this method if the camera supports anti-flicker processing for fluorescent lights. + +For how-to guidance for handling powerline frequency, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_variablephotosequencecontroller.md b/windows.media.devices/videodevicecontroller_variablephotosequencecontroller.md index 3bab8ec755..1485f001b3 100644 --- a/windows.media.devices/videodevicecontroller_variablephotosequencecontroller.md +++ b/windows.media.devices/videodevicecontroller_variablephotosequencecontroller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.VariablePhotoSequenceController --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.VariablePhotoSequenceController ## -description Gets the [VariablePhotoSequenceController](videodevicecontroller_variablephotosequencecontroller.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -property-value The [VariablePhotoSequenceController](videodevicecontroller_variablephotosequencecontroller.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.VariablePhotoSequenceController +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.VariablePhotoSequenceController + +## -description +Gets the [VariablePhotoSequenceController](videodevicecontroller_variablephotosequencecontroller.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -property-value +The [VariablePhotoSequenceController](videodevicecontroller_variablephotosequencecontroller.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_whitebalance.md b/windows.media.devices/videodevicecontroller_whitebalance.md index a0ac928431..81f4ca8f9f 100644 --- a/windows.media.devices/videodevicecontroller_whitebalance.md +++ b/windows.media.devices/videodevicecontroller_whitebalance.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.WhiteBalance --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.WhiteBalance ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the white balance on the camera. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the white balance. ## -remarks White balance is specified as a color temperature in degrees Kelvin. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.WhiteBalance +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.WhiteBalance + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the white balance on the camera. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the white balance. + +## -remarks +White balance is specified as a color temperature in degrees Kelvin. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_whitebalancecontrol.md b/windows.media.devices/videodevicecontroller_whitebalancecontrol.md index cf74f5a933..e323bf33bf 100644 --- a/windows.media.devices/videodevicecontroller_whitebalancecontrol.md +++ b/windows.media.devices/videodevicecontroller_whitebalancecontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.WhiteBalanceControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.WhiteBalanceControl ## -description Gets the white balance control for this video device. ## -property-value The white balance control. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.WhiteBalanceControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.WhiteBalanceControl + +## -description +Gets the white balance control for this video device. + +## -property-value +The white balance control. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/videodevicecontroller_zoom.md b/windows.media.devices/videodevicecontroller_zoom.md index c98bf1d966..31deebf659 100644 --- a/windows.media.devices/videodevicecontroller_zoom.md +++ b/windows.media.devices/videodevicecontroller_zoom.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.Zoom --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.Zoom ## -description Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's zoom setting. ## -property-value A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the zoom. ## -remarks Zoom is specified in millimeters. For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). ## -examples ## -see-also [MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Zoom +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Zoom + +## -description +Gets a [MediaDeviceControl](mediadevicecontrol.md) object that can be used to get or set the camera's zoom setting. + +## -property-value +A [MediaDeviceControl](mediadevicecontrol.md) object that provides methods to get and set the zoom. + +## -remarks +Zoom is specified in millimeters. + +For more information on getting or setting this value, see [MediaDeviceControl](mediadevicecontrol.md). + +## -examples + +## -see-also +[MediaDeviceControl](mediadevicecontrol.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_zoomcontrol.md b/windows.media.devices/videodevicecontroller_zoomcontrol.md index db6a953fe0..d27bb5d737 100644 --- a/windows.media.devices/videodevicecontroller_zoomcontrol.md +++ b/windows.media.devices/videodevicecontroller_zoomcontrol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.VideoDeviceController.ZoomControl --api-type: winrt property ---- # Windows.Media.Devices.VideoDeviceController.ZoomControl ## -description Gets the [ZoomControl](zoomcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -property-value The [ZoomControl](zoomcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.ZoomControl +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.ZoomControl + +## -description +Gets the [ZoomControl](zoomcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -property-value +The [ZoomControl](zoomcontrol.md) associated with the [VideoDeviceController](videodevicecontroller.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol.md b/windows.media.devices/whitebalancecontrol.md index f909891a26..bb0e001f06 100644 --- a/windows.media.devices/whitebalancecontrol.md +++ b/windows.media.devices/whitebalancecontrol.md @@ -1,3 +1,31 @@ ---- -api-id: T:Windows.Media.Devices.WhiteBalanceControl --api-type: winrt class ---- # Windows.Media.Devices.WhiteBalanceControl ## -description Provides functionality for controlling the white balance settings on a capture device. ## -remarks The [WhiteBalanceControl](whitebalancecontrol.md) gives apps additional control over the white balance settings on a device. You can use one of the [ColorTemperaturePreset](colortemperaturepreset.md) values by calling [SetPresetAsync](whitebalancecontrol_setpresetasync.md). Or call [SetValueAsync](whitebalancecontrol_setvalueasync.md) to set a specific [Value](whitebalancecontrol_value.md) between the [Min](whitebalancecontrol_min.md) and [Max ](whitebalancecontrol_max.md). You can find out if a device supports this control by checking [WhiteBalanceControl.Supported](whitebalancecontrol_supported.md). If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the value for the white balance color temperature. You can access the [WhiteBalanceControl](whitebalancecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). White balance is specified as a color temperature in degrees Kelvin. For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). ## -examples ## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.WhiteBalanceControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.WhiteBalanceControl + +## -description +Provides functionality for controlling the white balance settings on a capture device. + +## -remarks +The [WhiteBalanceControl](whitebalancecontrol.md) gives apps additional control over the white balance settings on a device. You can use one of the [ColorTemperaturePreset](colortemperaturepreset.md) values by calling [SetPresetAsync](whitebalancecontrol_setpresetasync.md). Or call [SetValueAsync](whitebalancecontrol_setvalueasync.md) to set a specific [Value](whitebalancecontrol_value.md) between the [Min](whitebalancecontrol_min.md) and [Max ](whitebalancecontrol_max.md). + +You can find out if a device supports this control by checking [WhiteBalanceControl.Supported](whitebalancecontrol_supported.md). + +If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the value for the white balance color temperature. + +You can access the [WhiteBalanceControl](whitebalancecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +White balance is specified as a color temperature in degrees Kelvin. + +For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also +[MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/whitebalancecontrol_max.md b/windows.media.devices/whitebalancecontrol_max.md index 83f93477af..e29d16c016 100644 --- a/windows.media.devices/whitebalancecontrol_max.md +++ b/windows.media.devices/whitebalancecontrol_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.WhiteBalanceControl.Max --api-type: winrt property ---- # Windows.Media.Devices.WhiteBalanceControl.Max ## -description Gets the maximum white balance value. ## -property-value The maximum white balance value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Max + +## -description +Gets the maximum white balance value. + +## -property-value +The maximum white balance value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_min.md b/windows.media.devices/whitebalancecontrol_min.md index 4064e13d0d..d276466310 100644 --- a/windows.media.devices/whitebalancecontrol_min.md +++ b/windows.media.devices/whitebalancecontrol_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.WhiteBalanceControl.Min --api-type: winrt property ---- # Windows.Media.Devices.WhiteBalanceControl.Min ## -description Gets the minimum white balance value. ## -property-value The minimum white balance value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Min + +## -description +Gets the minimum white balance value. + +## -property-value +The minimum white balance value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_preset.md b/windows.media.devices/whitebalancecontrol_preset.md index f276fd79cf..a95b5a5a31 100644 --- a/windows.media.devices/whitebalancecontrol_preset.md +++ b/windows.media.devices/whitebalancecontrol_preset.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.WhiteBalanceControl.Preset --api-type: winrt property ---- # Windows.Media.Devices.WhiteBalanceControl.Preset ## -description Gets the color temperature preset. ## -property-value The color temperature preset. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Preset +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Preset + +## -description +Gets the color temperature preset. + +## -property-value +The color temperature preset. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_setpresetasync_1724838565.md b/windows.media.devices/whitebalancecontrol_setpresetasync_1724838565.md index bf49fefaf8..0085248a28 100644 --- a/windows.media.devices/whitebalancecontrol_setpresetasync_1724838565.md +++ b/windows.media.devices/whitebalancecontrol_setpresetasync_1724838565.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Devices.WhiteBalanceControl.SetPresetAsync(Windows.Media.Devices.ColorTemperaturePreset) --api-type: winrt method ---- # Windows.Media.Devices.WhiteBalanceControl.SetPresetAsync ## -description Asynchronously sets the color temperature [Preset](whitebalancecontrol_preset.md). ## -parameters ### -param preset The color temperate preset to set the [Preset](whitebalancecontrol_preset.md) property to. ## -returns The object that is used to control the asynchronous operation. ## -remarks Adjusting the white balance is only supported while the preview stream is running. Check to make sure that the preview stream is running before setting the white balance value or preset. The [ColorTemperaturePreset.Auto](colortemperaturepreset.md) preset value instructs the system to automatically adjust the white balance level. For some scenarios, such as capturing a photo sequence where the white balance levels should be the same for each frame, you may want to lock the control to the current automatic value. To do this, call [SetPresetAsync](whitebalancecontrol_setpresetasync.md) and specify the **Manual** preset and do not set a value on the control using [SetValueAsync](whitebalancecontrol_setvalueasync.md). This will cause the device to lock the current value. Do not attempt to read the current control value and then pass the returned value into [SetValueAsync](whitebalancecontrol_setvalueasync.md) because this value is not guaranteed to be correct. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.WhiteBalanceControl.SetPresetAsync(Windows.Media.Devices.ColorTemperaturePreset) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.SetPresetAsync + +## -description +Asynchronously sets the color temperature [Preset](whitebalancecontrol_preset.md). + +## -parameters +### -param preset +The color temperate preset to set the [Preset](whitebalancecontrol_preset.md) property to. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks +Adjusting the white balance is only supported while the preview stream is running. Check to make sure that the preview stream is running before setting the white balance value or preset. + +The [ColorTemperaturePreset.Auto](colortemperaturepreset.md) preset value instructs the system to automatically adjust the white balance level. For some scenarios, such as capturing a photo sequence where the white balance levels should be the same for each frame, you may want to lock the control to the current automatic value. To do this, call [SetPresetAsync](whitebalancecontrol_setpresetasync.md) and specify the **Manual** preset and do not set a value on the control using [SetValueAsync](whitebalancecontrol_setvalueasync.md). This will cause the device to lock the current value. Do not attempt to read the current control value and then pass the returned value into [SetValueAsync](whitebalancecontrol_setvalueasync.md) because this value is not guaranteed to be correct. + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_setvalueasync_2096210171.md b/windows.media.devices/whitebalancecontrol_setvalueasync_2096210171.md index ef3096b985..8e23ac04c8 100644 --- a/windows.media.devices/whitebalancecontrol_setvalueasync_2096210171.md +++ b/windows.media.devices/whitebalancecontrol_setvalueasync_2096210171.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Devices.WhiteBalanceControl.SetValueAsync(System.UInt32) --api-type: winrt method ---- # Windows.Media.Devices.WhiteBalanceControl.SetValueAsync ## -description Asynchronously sets the color temperature [Value](whitebalancecontrol_value.md). ## -parameters ### -param temperature The temperature value to set the [Value](whitebalancecontrol_value.md) property to. ## -returns The object that is used to control the asynchronous operation. ## -remarks White balance is specified as a color temperature in degrees Kelvin. Adjusting the white balance is only supported while the preview stream is running. Check to make sure that the preview stream is running before setting the white balance value or preset. The [ColorTemperaturePreset.Auto](colortemperaturepreset.md) preset value instructs the system to automatically adjust the white balance level. For some scenarios, such as capturing a photo sequence where the white balance levels should be the same for each frame, you may want to lock the control to the current automatic value. To do this, call [SetPresetAsync](whitebalancecontrol_setpresetasync.md) and specify the **Manual** preset and do not set a value on the control using [SetValueAsync](whitebalancecontrol_setvalueasync.md). This will cause the device to lock the current value. Do not attempt to read the current control value and then pass the returned value into [SetValueAsync](whitebalancecontrol_setvalueasync.md) because this value is not guaranteed to be correct. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.WhiteBalanceControl.SetValueAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.SetValueAsync + +## -description +Asynchronously sets the color temperature [Value](whitebalancecontrol_value.md). + +## -parameters +### -param temperature +The temperature value to set the [Value](whitebalancecontrol_value.md) property to. + +## -returns +The object that is used to control the asynchronous operation. + +## -remarks +White balance is specified as a color temperature in degrees Kelvin. + +Adjusting the white balance is only supported while the preview stream is running. Check to make sure that the preview stream is running before setting the white balance value or preset. + +The [ColorTemperaturePreset.Auto](colortemperaturepreset.md) preset value instructs the system to automatically adjust the white balance level. For some scenarios, such as capturing a photo sequence where the white balance levels should be the same for each frame, you may want to lock the control to the current automatic value. To do this, call [SetPresetAsync](whitebalancecontrol_setpresetasync.md) and specify the **Manual** preset and do not set a value on the control using [SetValueAsync](whitebalancecontrol_setvalueasync.md). This will cause the device to lock the current value. Do not attempt to read the current control value and then pass the returned value into [SetValueAsync](whitebalancecontrol_setvalueasync.md) because this value is not guaranteed to be correct. + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_step.md b/windows.media.devices/whitebalancecontrol_step.md index 29d27a549e..b75bf938dd 100644 --- a/windows.media.devices/whitebalancecontrol_step.md +++ b/windows.media.devices/whitebalancecontrol_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.WhiteBalanceControl.Step --api-type: winrt property ---- # Windows.Media.Devices.WhiteBalanceControl.Step ## -description Gets the step value. ## -property-value The step value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Step + +## -description +Gets the step value. + +## -property-value +The step value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_supported.md b/windows.media.devices/whitebalancecontrol_supported.md index 5b6e76f583..4bb1b70763 100644 --- a/windows.media.devices/whitebalancecontrol_supported.md +++ b/windows.media.devices/whitebalancecontrol_supported.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.WhiteBalanceControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.WhiteBalanceControl.Supported ## -description Gets a value that specifies if the capture device supports the white balance control. ## -property-value **true** if the capture device supports the white balance control; otherwise, **false**. ## -remarks If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the white balance color temperature. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Supported + +## -description +Gets a value that specifies if the capture device supports the white balance control. + +## -property-value +**true** if the capture device supports the white balance control; otherwise, **false**. + +## -remarks +If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the white balance color temperature. + +## -examples + +## -see-also diff --git a/windows.media.devices/whitebalancecontrol_value.md b/windows.media.devices/whitebalancecontrol_value.md index ee46da655f..7d7de09bac 100644 --- a/windows.media.devices/whitebalancecontrol_value.md +++ b/windows.media.devices/whitebalancecontrol_value.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.WhiteBalanceControl.Value --api-type: winrt property ---- # Windows.Media.Devices.WhiteBalanceControl.Value ## -description Gets the color temperature value. ## -property-value The color temperature value. ## -remarks White balance is specified as a color temperature in degrees Kelvin. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Value + +## -description +Gets the color temperature value. + +## -property-value +The color temperature value. + +## -remarks +White balance is specified as a color temperature in degrees Kelvin. + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol.md b/windows.media.devices/zoomcontrol.md index 4991977622..2e9b2f0f2c 100644 --- a/windows.media.devices/zoomcontrol.md +++ b/windows.media.devices/zoomcontrol.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Devices.ZoomControl --api-type: winrt class ---- # Windows.Media.Devices.ZoomControl ## -description Provides functionality for controlling the zoom settings on a capture device. ## -remarks For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). Get an instance of this class by accessing the [ZoomControl](videodevicecontroller_zoomcontrol.md) property. ## -examples ## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.ZoomControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ZoomControl + +## -description +Provides functionality for controlling the zoom settings on a capture device. + +## -remarks +For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +Get an instance of this class by accessing the [ZoomControl](videodevicecontroller_zoomcontrol.md) property. + +## -examples + +## -see-also +[Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/zoomcontrol_configure_1205629206.md b/windows.media.devices/zoomcontrol_configure_1205629206.md index f0a999ddb6..a759b470af 100644 --- a/windows.media.devices/zoomcontrol_configure_1205629206.md +++ b/windows.media.devices/zoomcontrol_configure_1205629206.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Devices.ZoomControl.Configure(Windows.Media.Devices.ZoomSettings) --api-type: winrt method ---- # Windows.Media.Devices.ZoomControl.Configure ## -description Configures the zoom control with the provided zoom settings. ## -parameters ### -param settings The zoom settings. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.ZoomControl.Configure(Windows.Media.Devices.ZoomSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.ZoomControl.Configure + +## -description +Configures the zoom control with the provided zoom settings. + +## -parameters +### -param settings +The zoom settings. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_max.md b/windows.media.devices/zoomcontrol_max.md index f16fdc6f4d..b7a441d9a1 100644 --- a/windows.media.devices/zoomcontrol_max.md +++ b/windows.media.devices/zoomcontrol_max.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.Max --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.Max ## -description Gets the maximum zoom value supported by the capture device. ## -property-value The maximum zoom value supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.Max +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.Max + +## -description +Gets the maximum zoom value supported by the capture device. + +## -property-value +The maximum zoom value supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_min.md b/windows.media.devices/zoomcontrol_min.md index 0a8ed4136a..1e590c0355 100644 --- a/windows.media.devices/zoomcontrol_min.md +++ b/windows.media.devices/zoomcontrol_min.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.Min --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.Min ## -description Gets the minimum zoom value supported by the capture device. ## -property-value The minimum zoom value supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.Min +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.Min + +## -description +Gets the minimum zoom value supported by the capture device. + +## -property-value +The minimum zoom value supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_mode.md b/windows.media.devices/zoomcontrol_mode.md index 4d18a831a2..e3d04b2d49 100644 --- a/windows.media.devices/zoomcontrol_mode.md +++ b/windows.media.devices/zoomcontrol_mode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.Mode --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.Mode ## -description Gets a value indicating the current zoom transition mode. ## -property-value A value indicating the current zoom transition mode. ## -remarks Set the zoom transition mode by creating an instance of the [ZoomSettings](zoomsettings.md) class and passing it into the [Configure](focuscontrol_configure.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.Mode + +## -description +Gets a value indicating the current zoom transition mode. + +## -property-value +A value indicating the current zoom transition mode. + +## -remarks +Set the zoom transition mode by creating an instance of the [ZoomSettings](zoomsettings.md) class and passing it into the [Configure](focuscontrol_configure.md) method. + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_step.md b/windows.media.devices/zoomcontrol_step.md index 45d4d6cddd..323662a7b0 100644 --- a/windows.media.devices/zoomcontrol_step.md +++ b/windows.media.devices/zoomcontrol_step.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.Step --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.Step ## -description Gets the smallest zoom value increment supported by the capture device. ## -property-value The smallest zoom value increment supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.Step +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.Step + +## -description +Gets the smallest zoom value increment supported by the capture device. + +## -property-value +The smallest zoom value increment supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_supported.md b/windows.media.devices/zoomcontrol_supported.md index ba42a71ad2..86ba854e18 100644 --- a/windows.media.devices/zoomcontrol_supported.md +++ b/windows.media.devices/zoomcontrol_supported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.Supported --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.Supported ## -description Gets a value indicating whether zoom control is supported by the capture device. ## -property-value A value indicating whether zoom control is supported by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.Supported + +## -description +Gets a value indicating whether zoom control is supported by the capture device. + +## -property-value +A value indicating whether zoom control is supported by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_supportedmodes.md b/windows.media.devices/zoomcontrol_supportedmodes.md index b73a5bc7c0..8ed744234a 100644 --- a/windows.media.devices/zoomcontrol_supportedmodes.md +++ b/windows.media.devices/zoomcontrol_supportedmodes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.SupportedModes --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.SupportedModes ## -description Gets the list of [ZoomTransitionMode](zoomtransitionmode.md) values indicating the modes supported by the capture device. ## -property-value The list of supported [ZoomTransitionMode](zoomtransitionmode.md) values. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.SupportedModes +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.SupportedModes + +## -description +Gets the list of [ZoomTransitionMode](zoomtransitionmode.md) values indicating the modes supported by the capture device. + +## -property-value +The list of supported [ZoomTransitionMode](zoomtransitionmode.md) values. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomcontrol_value.md b/windows.media.devices/zoomcontrol_value.md index 75b6275ff3..485a061ca6 100644 --- a/windows.media.devices/zoomcontrol_value.md +++ b/windows.media.devices/zoomcontrol_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomControl.Value --api-type: winrt property ---- # Windows.Media.Devices.ZoomControl.Value ## -description Gets or sets the zoom value to be used by the capture device. ## -property-value The zoom value to be used by the capture device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomControl.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomControl.Value + +## -description +Gets or sets the zoom value to be used by the capture device. + +## -property-value +The zoom value to be used by the capture device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomsettings.md b/windows.media.devices/zoomsettings.md index d66b322b7d..b088ad39a4 100644 --- a/windows.media.devices/zoomsettings.md +++ b/windows.media.devices/zoomsettings.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Devices.ZoomSettings --api-type: winrt class ---- # Windows.Media.Devices.ZoomSettings ## -description Represents zoom settings that can be applied to the [ZoomControl](zoomcontrol.md) by calling the [Configure](zoomcontrol_configure.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Devices.ZoomSettings +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ZoomSettings + +## -description +Represents zoom settings that can be applied to the [ZoomControl](zoomcontrol.md) by calling the [Configure](zoomcontrol_configure.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomsettings_mode.md b/windows.media.devices/zoomsettings_mode.md index 71ff41e583..55cfabe159 100644 --- a/windows.media.devices/zoomsettings_mode.md +++ b/windows.media.devices/zoomsettings_mode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomSettings.Mode --api-type: winrt property ---- # Windows.Media.Devices.ZoomSettings.Mode ## -description Gets or sets a [ZoomTransitionMode](zoomtransitionmode.md) value indicating how the capture device should transition to the new zoom value specified with the [Value](zoomsettings_value.md) property. ## -property-value A value indicating how the capture device should transition to the new zoom value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomSettings.Mode +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomSettings.Mode + +## -description +Gets or sets a [ZoomTransitionMode](zoomtransitionmode.md) value indicating how the capture device should transition to the new zoom value specified with the [Value](zoomsettings_value.md) property. + +## -property-value +A value indicating how the capture device should transition to the new zoom value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomsettings_value.md b/windows.media.devices/zoomsettings_value.md index c1628c54ba..a4a7da1508 100644 --- a/windows.media.devices/zoomsettings_value.md +++ b/windows.media.devices/zoomsettings_value.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Devices.ZoomSettings.Value --api-type: winrt property ---- # Windows.Media.Devices.ZoomSettings.Value ## -description Gets or sets the zoom value to which the [ZoomControl](zoomcontrol.md) will transition. ## -property-value The zoom value to which the [ZoomControl](zoomcontrol.md) will transition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Devices.ZoomSettings.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ZoomSettings.Value + +## -description +Gets or sets the zoom value to which the [ZoomControl](zoomcontrol.md) will transition. + +## -property-value +The zoom value to which the [ZoomControl](zoomcontrol.md) will transition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.devices/zoomsettings_zoomsettings_1221375020.md b/windows.media.devices/zoomsettings_zoomsettings_1221375020.md index 0a1f2b8cb2..6359c59f88 100644 --- a/windows.media.devices/zoomsettings_zoomsettings_1221375020.md +++ b/windows.media.devices/zoomsettings_zoomsettings_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Devices.ZoomSettings.#ctor --api-type: winrt method ---- # Windows.Media.Devices.ZoomSettings.ZoomSettings ## -description Initializes a new instance of the [ZoomSettings](zoomsettings.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Devices.ZoomSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Devices.ZoomSettings.ZoomSettings + +## -description +Initializes a new instance of the [ZoomSettings](zoomsettings.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialapp.md b/windows.media.dialprotocol/dialapp.md index 77c5f44b6d..4d1b90f756 100644 --- a/windows.media.dialprotocol/dialapp.md +++ b/windows.media.dialprotocol/dialapp.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialApp --api-type: winrt class ---- # Windows.Media.DialProtocol.DialApp ## -description Represents a DIAL application running on a remote device. ## -remarks Get an instance of this class by accessing the [GetDialApp](dialdevice_getdialapp.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialApp +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialApp + +## -description +Represents a DIAL application running on a remote device. + +## -remarks +Get an instance of this class by accessing the [GetDialApp](dialdevice_getdialapp.md) property. + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialapp_appname.md b/windows.media.dialprotocol/dialapp_appname.md index 16b66e5ad6..4784b7c6f1 100644 --- a/windows.media.dialprotocol/dialapp_appname.md +++ b/windows.media.dialprotocol/dialapp_appname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialApp.AppName --api-type: winrt property ---- # Windows.Media.DialProtocol.DialApp.AppName ## -description Gets the applications registered DIAL name. ## -property-value The DIAL name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialApp.AppName +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialApp.AppName + +## -description +Gets the applications registered DIAL name. + +## -property-value +The DIAL name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialapp_getappstateasync_2130355982.md b/windows.media.dialprotocol/dialapp_getappstateasync_2130355982.md index 146fb84bcc..d4c1f2e5ce 100644 --- a/windows.media.dialprotocol/dialapp_getappstateasync_2130355982.md +++ b/windows.media.dialprotocol/dialapp_getappstateasync_2130355982.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialApp.GetAppStateAsync --api-type: winrt method ---- # Windows.Media.DialProtocol.DialApp.GetAppStateAsync ## -description Gets the current status of the application on the remote device. ## -returns The app status, a value from [DialAppStateDetails](dialappstatedetails.md). ## -remarks ## -examples ## -see-also [DialAppStateDetails](dialappstatedetails.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialApp.GetAppStateAsync +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialApp.GetAppStateAsync + +## -description +Gets the current status of the application on the remote device. + +## -returns +The app status, a value from [DialAppStateDetails](dialappstatedetails.md). + +## -remarks + +## -examples + +## -see-also +[DialAppStateDetails](dialappstatedetails.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialapp_requestlaunchasync_452612891.md b/windows.media.dialprotocol/dialapp_requestlaunchasync_452612891.md index 2012c9cf7f..742bf45281 100644 --- a/windows.media.dialprotocol/dialapp_requestlaunchasync_452612891.md +++ b/windows.media.dialprotocol/dialapp_requestlaunchasync_452612891.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialApp.RequestLaunchAsync(System.String) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialApp.RequestLaunchAsync ## -description Initiates the launching of the app on the remote device. When this method is called, the [DialDevice](dialdevice.md) is paired if necessary, the user is prompted to allow access to the device, connection is established, app existence is validated on the device, and finally the application is launched with the provided argument. ## -parameters ### -param appArgument Optional. ## -returns Indicates the result of attempting to launch the app. ## -remarks This method must be called from the UI thread or an exception will be thrown. To dispatch the call to the UI thread from another thread, you can use [CoreDispatcher.RunAsync](../windows.ui.core/coredispatcher_runasync.md). ## -examples ## -see-also [DialAppLaunchResult](dialapplaunchresult.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialApp.RequestLaunchAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialApp.RequestLaunchAsync + +## -description +Initiates the launching of the app on the remote device. When this method is called, the [DialDevice](dialdevice.md) is paired if necessary, the user is prompted to allow access to the device, connection is established, app existence is validated on the device, and finally the application is launched with the provided argument. + +## -parameters +### -param appArgument +Optional. + +## -returns +Indicates the result of attempting to launch the app. + +## -remarks +This method must be called from the UI thread or an exception will be thrown. To dispatch the call to the UI thread from another thread, you can use [CoreDispatcher.RunAsync](../windows.ui.core/coredispatcher_runasync.md). + +## -examples + +## -see-also +[DialAppLaunchResult](dialapplaunchresult.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialapp_stopasync_1648475005.md b/windows.media.dialprotocol/dialapp_stopasync_1648475005.md index 135e6f3f59..88002fbfe3 100644 --- a/windows.media.dialprotocol/dialapp_stopasync_1648475005.md +++ b/windows.media.dialprotocol/dialapp_stopasync_1648475005.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialApp.StopAsync --api-type: winrt method ---- # Windows.Media.DialProtocol.DialApp.StopAsync ## -description Stops the app on the remote device, if the remote device supports this functionality. ## -returns The result of sending the request to stop the app. ## -remarks ## -examples ## -see-also [DialAppStopResult](dialappstopresult.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialApp.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialApp.StopAsync + +## -description +Stops the app on the remote device, if the remote device supports this functionality. + +## -returns +The result of sending the request to stop the app. + +## -remarks + +## -examples + +## -see-also +[DialAppStopResult](dialappstopresult.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialappstatedetails.md b/windows.media.dialprotocol/dialappstatedetails.md index 3a413f086b..1c732243cf 100644 --- a/windows.media.dialprotocol/dialappstatedetails.md +++ b/windows.media.dialprotocol/dialappstatedetails.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialAppStateDetails --api-type: winrt class ---- # Windows.Media.DialProtocol.DialAppStateDetails ## -description Represents the state of the DIAL app. ## -remarks This object is returned when [GetAppStateAsync](dialapp_getappstateasync.md) is called on a DIAL app. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialAppStateDetails +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialAppStateDetails + +## -description +Represents the state of the DIAL app. + +## -remarks +This object is returned when [GetAppStateAsync](dialapp_getappstateasync.md) is called on a DIAL app. + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialappstatedetails_fullxml.md b/windows.media.dialprotocol/dialappstatedetails_fullxml.md index 0525e60aef..ca875236c3 100644 --- a/windows.media.dialprotocol/dialappstatedetails_fullxml.md +++ b/windows.media.dialprotocol/dialappstatedetails_fullxml.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialAppStateDetails.FullXml --api-type: winrt property ---- # Windows.Media.DialProtocol.DialAppStateDetails.FullXml ## -description Gets the entire XML response that is provided by the app when state of the app was requested. ## -property-value The full XML response. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialAppStateDetails.FullXml +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialAppStateDetails.FullXml + +## -description +Gets the entire XML response that is provided by the app when state of the app was requested. + +## -property-value +The full XML response. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialappstatedetails_state.md b/windows.media.dialprotocol/dialappstatedetails_state.md index 99b63b476d..cb68492fb4 100644 --- a/windows.media.dialprotocol/dialappstatedetails_state.md +++ b/windows.media.dialprotocol/dialappstatedetails_state.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialAppStateDetails.State --api-type: winrt property ---- # Windows.Media.DialProtocol.DialAppStateDetails.State ## -description Gets the state of the application at the time the [GetAppStateAsync](dialapp_getappstateasync.md) was completed. ## -property-value The app state. ## -remarks ## -examples ## -see-also [DialAppState](dialappstate.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialAppStateDetails.State +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialAppStateDetails.State + +## -description +Gets the state of the application at the time the [GetAppStateAsync](dialapp_getappstateasync.md) was completed. + +## -property-value +The app state. + +## -remarks + +## -examples + +## -see-also +[DialAppState](dialappstate.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialdevice.md b/windows.media.dialprotocol/dialdevice.md index d61f501b80..3ce73c1bd4 100644 --- a/windows.media.dialprotocol/dialdevice.md +++ b/windows.media.dialprotocol/dialdevice.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialDevice --api-type: winrt class ---- # Windows.Media.DialProtocol.DialDevice ## -description Represents the remote device capable of running DIAL apps. ## -remarks Get an instance of this class by handling the [DialDeviceSelected](dialdevicepicker_dialdeviceselected.md) event and accessing the [DialDeviceSelectedEventArgs.SelectedDialDevice](dialdeviceselectedeventargs_selecteddialdevice.md) or by handling the [DisconnectButtonClicked](dialdevicepicker_disconnectbuttonclicked.md) handler and accessing the [DialDisconnectButtonClickedEventArgs.Device](dialdisconnectbuttonclickedeventargs_device.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialDevice +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialDevice + +## -description +Represents the remote device capable of running DIAL apps. + +## -remarks +Get an instance of this class by handling the [DialDeviceSelected](dialdevicepicker_dialdeviceselected.md) event and accessing the [DialDeviceSelectedEventArgs.SelectedDialDevice](dialdeviceselectedeventargs_selecteddialdevice.md) or by handling the [DisconnectButtonClicked](dialdevicepicker_disconnectbuttonclicked.md) handler and accessing the [DialDisconnectButtonClickedEventArgs.Device](dialdisconnectbuttonclickedeventargs_device.md) property. + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_deviceinfosupportsdialasync_736891362.md b/windows.media.dialprotocol/dialdevice_deviceinfosupportsdialasync_736891362.md index 7bce60c7a7..5326dc40bf 100644 --- a/windows.media.dialprotocol/dialdevice_deviceinfosupportsdialasync_736891362.md +++ b/windows.media.dialprotocol/dialdevice_deviceinfosupportsdialasync_736891362.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevice.DeviceInfoSupportsDialAsync(Windows.Devices.Enumeration.DeviceInformation) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevice.DeviceInfoSupportsDialAsync ## -description Indicates whether or not the device supports launching DIAL apps. ## -parameters ### -param device The device you want to get information for. ## -returns True if app launching is supported; false, otherwise. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevice.DeviceInfoSupportsDialAsync(Windows.Devices.Enumeration.DeviceInformation) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevice.DeviceInfoSupportsDialAsync + +## -description +Indicates whether or not the device supports launching DIAL apps. + +## -parameters +### -param device +The device you want to get information for. + +## -returns +True if app launching is supported; false, otherwise. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_friendlyname.md b/windows.media.dialprotocol/dialdevice_friendlyname.md index ae9ea9e673..c9f38eeadf 100644 --- a/windows.media.dialprotocol/dialdevice_friendlyname.md +++ b/windows.media.dialprotocol/dialdevice_friendlyname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDevice.FriendlyName --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDevice.FriendlyName ## -description Gets the friendly name for the DIAL device. ## -property-value The friendly name for the DIAL device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDevice.FriendlyName +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDevice.FriendlyName + +## -description +Gets the friendly name for the DIAL device. + +## -property-value +The friendly name for the DIAL device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_fromidasync_1322863552.md b/windows.media.dialprotocol/dialdevice_fromidasync_1322863552.md index 694905cf16..32cd8d410f 100644 --- a/windows.media.dialprotocol/dialdevice_fromidasync_1322863552.md +++ b/windows.media.dialprotocol/dialdevice_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevice.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevice.FromIdAsync ## -description Returns a [DialDevice](dialdevice.md) object for a given a device ID (acquired from a query using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs). ## -parameters ### -param value The ID of the device you want a [DialDevice](dialdevice.md) object for. ## -returns The [DialDevice](dialdevice.md) object for the given device ID. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevice.FromIdAsync + +## -description +Returns a [DialDevice](dialdevice.md) object for a given a device ID (acquired from a query using the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs). + +## -parameters +### -param value +The ID of the device you want a [DialDevice](dialdevice.md) object for. + +## -returns +The [DialDevice](dialdevice.md) object for the given device ID. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_getdeviceselector_1752695616.md b/windows.media.dialprotocol/dialdevice_getdeviceselector_1752695616.md index e4a9298038..d49b12386a 100644 --- a/windows.media.dialprotocol/dialdevice_getdeviceselector_1752695616.md +++ b/windows.media.dialprotocol/dialdevice_getdeviceselector_1752695616.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevice.GetDeviceSelector(System.String) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevice.GetDeviceSelector ## -description Returns an AQS filter string to be used with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs (such as the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) API) for a given Dial app. ## -parameters ### -param appName The name of the app. ## -returns The AQS filter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevice.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevice.GetDeviceSelector + +## -description +Returns an AQS filter string to be used with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs (such as the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) API) for a given Dial app. + +## -parameters +### -param appName +The name of the app. + +## -returns +The AQS filter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_getdialapp_1997105867.md b/windows.media.dialprotocol/dialdevice_getdialapp_1997105867.md index 11f3f99185..93c189bda6 100644 --- a/windows.media.dialprotocol/dialdevice_getdialapp_1997105867.md +++ b/windows.media.dialprotocol/dialdevice_getdialapp_1997105867.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevice.GetDialApp(System.String) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevice.GetDialApp ## -description Creates a new [DialApp](dialapp.md) object. This method does not establish a connection to the device or validate that the app exists. That is done when any function is called on the resulting [DialApp](dialapp.md) object. ## -parameters ### -param appName The name of the app. This becomes the [AppName](dialapp_appname.md) property of the new object. ## -returns The [DialApp](dialapp.md) object for the app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevice.GetDialApp(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevice.GetDialApp + +## -description +Creates a new [DialApp](dialapp.md) object. This method does not establish a connection to the device or validate that the app exists. That is done when any function is called on the resulting [DialApp](dialapp.md) object. + +## -parameters +### -param appName +The name of the app. This becomes the [AppName](dialapp_appname.md) property of the new object. + +## -returns +The [DialApp](dialapp.md) object for the app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_id.md b/windows.media.dialprotocol/dialdevice_id.md index 5380db0f32..52c32fc98f 100644 --- a/windows.media.dialprotocol/dialdevice_id.md +++ b/windows.media.dialprotocol/dialdevice_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDevice.Id --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDevice.Id ## -description Gets the remote device's ID. You can use this ID with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs as well. ## -property-value The ID of the remote device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDevice.Id +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDevice.Id + +## -description +Gets the remote device's ID. You can use this ID with the [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) APIs as well. + +## -property-value +The ID of the remote device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevice_thumbnail.md b/windows.media.dialprotocol/dialdevice_thumbnail.md index 4260d000c0..c2d25ccd98 100644 --- a/windows.media.dialprotocol/dialdevice_thumbnail.md +++ b/windows.media.dialprotocol/dialdevice_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDevice.Thumbnail --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDevice.Thumbnail ## -description Gets a stream containing the thumbnail image for the DIAL device. ## -property-value A stream containing the thumbnail image for the DIAL device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDevice.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDevice.Thumbnail + +## -description +Gets a stream containing the thumbnail image for the DIAL device. + +## -property-value +A stream containing the thumbnail image for the DIAL device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker.md b/windows.media.dialprotocol/dialdevicepicker.md index fe59201628..5e9deff0d8 100644 --- a/windows.media.dialprotocol/dialdevicepicker.md +++ b/windows.media.dialprotocol/dialdevicepicker.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialDevicePicker --api-type: winrt class ---- # Windows.Media.DialProtocol.DialDevicePicker ## -description Represents a picker flyout that contains a list of remote devices for the user to choose from. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialDevicePicker +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker + +## -description +Represents a picker flyout that contains a list of remote devices for the user to choose from. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_appearance.md b/windows.media.dialprotocol/dialdevicepicker_appearance.md index 33d6401bb5..85efb7c903 100644 --- a/windows.media.dialprotocol/dialdevicepicker_appearance.md +++ b/windows.media.dialprotocol/dialdevicepicker_appearance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDevicePicker.Appearance --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDevicePicker.Appearance ## -description Used to change the colors of the picker. ## -property-value The color of the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDevicePicker.Appearance +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.Appearance + +## -description +Used to change the colors of the picker. + +## -property-value +The color of the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_dialdevicepicker_1221375020.md b/windows.media.dialprotocol/dialdevicepicker_dialdevicepicker_1221375020.md index dac2fe8b28..3d87648c75 100644 --- a/windows.media.dialprotocol/dialdevicepicker_dialdevicepicker_1221375020.md +++ b/windows.media.dialprotocol/dialdevicepicker_dialdevicepicker_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.#ctor --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.DialDevicePicker ## -description Creates a new [DialDevicePicker](dialdevicepicker.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.DialDevicePicker + +## -description +Creates a new [DialDevicePicker](dialdevicepicker.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_dialdevicepickerdismissed.md b/windows.media.dialprotocol/dialdevicepicker_dialdevicepickerdismissed.md index 654da6ca3f..14494a8490 100644 --- a/windows.media.dialprotocol/dialdevicepicker_dialdevicepickerdismissed.md +++ b/windows.media.dialprotocol/dialdevicepicker_dialdevicepickerdismissed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.DialProtocol.DialDevicePicker.DialDevicePickerDismissed --api-type: winrt event ---- # Windows.Media.DialProtocol.DialDevicePicker.DialDevicePickerDismissed ## -description Indicates that the device picker was light dismissed, which means that the user clicked or touched anywhere other than the picker UI, and so the picker will be closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.DialProtocol.DialDevicePicker.DialDevicePickerDismissed +-api-type: winrt event +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.DialDevicePickerDismissed + +## -description +Indicates that the device picker was light dismissed, which means that the user clicked or touched anywhere other than the picker UI, and so the picker will be closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_dialdeviceselected.md b/windows.media.dialprotocol/dialdevicepicker_dialdeviceselected.md index 7c1bb74d9e..4eef23423c 100644 --- a/windows.media.dialprotocol/dialdevicepicker_dialdeviceselected.md +++ b/windows.media.dialprotocol/dialdevicepicker_dialdeviceselected.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.DialProtocol.DialDevicePicker.DialDeviceSelected --api-type: winrt event ---- # Windows.Media.DialProtocol.DialDevicePicker.DialDeviceSelected ## -description Indicates that the user selected a device from the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.DialProtocol.DialDevicePicker.DialDeviceSelected +-api-type: winrt event +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.DialDeviceSelected + +## -description +Indicates that the user selected a device from the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_disconnectbuttonclicked.md b/windows.media.dialprotocol/dialdevicepicker_disconnectbuttonclicked.md index aa0a57f6f5..3bbd54a187 100644 --- a/windows.media.dialprotocol/dialdevicepicker_disconnectbuttonclicked.md +++ b/windows.media.dialprotocol/dialdevicepicker_disconnectbuttonclicked.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.DialProtocol.DialDevicePicker.DisconnectButtonClicked --api-type: winrt event ---- # Windows.Media.DialProtocol.DialDevicePicker.DisconnectButtonClicked ## -description Indicates that the user clicked on the disconnect button in the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.DialProtocol.DialDevicePicker.DisconnectButtonClicked +-api-type: winrt event +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.DisconnectButtonClicked + +## -description +Indicates that the user clicked on the disconnect button in the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_filter.md b/windows.media.dialprotocol/dialdevicepicker_filter.md index 8b06184ca8..1273c389e8 100644 --- a/windows.media.dialprotocol/dialdevicepicker_filter.md +++ b/windows.media.dialprotocol/dialdevicepicker_filter.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDevicePicker.Filter --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDevicePicker.Filter ## -description Gets the filter used to choose what devices to show in the picker. ## -property-value The dial device picker filter. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDevicePicker.Filter +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.Filter + +## -description +Gets the filter used to choose what devices to show in the picker. + +## -property-value +The dial device picker filter. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_hide_1985563870.md b/windows.media.dialprotocol/dialdevicepicker_hide_1985563870.md index 37e825c13b..073580e33a 100644 --- a/windows.media.dialprotocol/dialdevicepicker_hide_1985563870.md +++ b/windows.media.dialprotocol/dialdevicepicker_hide_1985563870.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.Hide --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.Hide ## -description Hides the picker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.Hide +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.Hide + +## -description +Hides the picker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1105265034.md b/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1105265034.md index de236679e3..59a94563e9 100644 --- a/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1105265034.md +++ b/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1105265034.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync(Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync ## -description Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event. ## -parameters ### -param selection The rectangle from which to show the picker. ### -param preferredPlacement The edge of the rectangle from which to show the picker. ## -returns The [DialDevice](dialdevice.md) object selected. ## -remarks ## -examples ## -see-also [PickSingleDialDeviceAsync(Rect)](dialdevicepicker_picksingledialdeviceasync_1152322632.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync + +## -description +Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event. + +## -parameters +### -param selection +The rectangle from which to show the picker. + +### -param preferredPlacement +The edge of the rectangle from which to show the picker. + +## -returns +The [DialDevice](dialdevice.md) object selected. + +## -remarks + +## -examples + +## -see-also +[PickSingleDialDeviceAsync(Rect)](dialdevicepicker_picksingledialdeviceasync_1152322632.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1152322632.md b/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1152322632.md index 7cda14c96a..025883e8c0 100644 --- a/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1152322632.md +++ b/windows.media.dialprotocol/dialdevicepicker_picksingledialdeviceasync_1152322632.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync ## -description Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event. ## -parameters ### -param selection The rectangle from which to show the picker. ## -returns The device the user selected from the picker. ## -remarks ## -examples ## -see-also [PickSingleDialDeviceAsync(Rect, Placement)](dialdevicepicker_picksingledialdeviceasync_1105265034.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.PickSingleDialDeviceAsync + +## -description +Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event. + +## -parameters +### -param selection +The rectangle from which to show the picker. + +## -returns +The device the user selected from the picker. + +## -remarks + +## -examples + +## -see-also +[PickSingleDialDeviceAsync(Rect, Placement)](dialdevicepicker_picksingledialdeviceasync_1105265034.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialdevicepicker_setdisplaystatus_1004360736.md b/windows.media.dialprotocol/dialdevicepicker_setdisplaystatus_1004360736.md index 0d7b5264d1..e0df01f777 100644 --- a/windows.media.dialprotocol/dialdevicepicker_setdisplaystatus_1004360736.md +++ b/windows.media.dialprotocol/dialdevicepicker_setdisplaystatus_1004360736.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.SetDisplayStatus(Windows.Media.DialProtocol.DialDevice,Windows.Media.DialProtocol.DialDeviceDisplayStatus) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.SetDisplayStatus ## -description Updates the picker UI to reflect the status fo a given remote device. ## -parameters ### -param device The remote device whose status you want to display. ### -param status The status you want displayed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.SetDisplayStatus(Windows.Media.DialProtocol.DialDevice,Windows.Media.DialProtocol.DialDeviceDisplayStatus) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.SetDisplayStatus + +## -description +Updates the picker UI to reflect the status fo a given remote device. + +## -parameters +### -param device +The remote device whose status you want to display. + +### -param status +The status you want displayed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepicker_show_8680471.md b/windows.media.dialprotocol/dialdevicepicker_show_8680471.md index 9fed8c502f..3ef9842994 100644 --- a/windows.media.dialprotocol/dialdevicepicker_show_8680471.md +++ b/windows.media.dialprotocol/dialdevicepicker_show_8680471.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.Show ## -description Displays the picker to the user. When called, the picker flies out from the specified edge of the provided rectangle. ## -parameters ### -param selection The rectangle from which you want the picker to show. ### -param preferredPlacement The edge from which you want the picker to show. ## -remarks ## -examples ## -see-also [Show(Rect)](dialdevicepicker_show_97155545.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.Show + +## -description +Displays the picker to the user. When called, the picker flies out from the specified edge of the provided rectangle. + +## -parameters +### -param selection +The rectangle from which you want the picker to show. + +### -param preferredPlacement +The edge from which you want the picker to show. + +## -remarks + +## -examples + +## -see-also +[Show(Rect)](dialdevicepicker_show_97155545.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialdevicepicker_show_97155545.md b/windows.media.dialprotocol/dialdevicepicker_show_97155545.md index 32f5a2c93d..666b387874 100644 --- a/windows.media.dialprotocol/dialdevicepicker_show_97155545.md +++ b/windows.media.dialprotocol/dialdevicepicker_show_97155545.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.DialProtocol.DialDevicePicker.Show(Windows.Foundation.Rect) --api-type: winrt method ---- # Windows.Media.DialProtocol.DialDevicePicker.Show ## -description Displays the picker to the user. When called, the picker flies out from an edge of the provided rectangle. ## -parameters ### -param selection The rectangle from which you want the picker to show. ## -remarks ## -examples ## -see-also [Show(Rect, Placement)](dialdevicepicker_show_8680471.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.DialProtocol.DialDevicePicker.Show(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialDevicePicker.Show + +## -description +Displays the picker to the user. When called, the picker flies out from an edge of the provided rectangle. + +## -parameters +### -param selection +The rectangle from which you want the picker to show. + +## -remarks + +## -examples + +## -see-also +[Show(Rect, Placement)](dialdevicepicker_show_8680471.md) \ No newline at end of file diff --git a/windows.media.dialprotocol/dialdevicepickerfilter.md b/windows.media.dialprotocol/dialdevicepickerfilter.md index cd1bef78c4..9a15196efd 100644 --- a/windows.media.dialprotocol/dialdevicepickerfilter.md +++ b/windows.media.dialprotocol/dialdevicepickerfilter.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialDevicePickerFilter --api-type: winrt class ---- # Windows.Media.DialProtocol.DialDevicePickerFilter ## -description Represents the filter used to determine which devices to show in a [DialDevicePicker](dialdevicepicker.md). The filter parameters are OR-ed together to build the resulting filter. ## -remarks This class is received by accessing the [DialDevicePicker.Filter](dialdevicepicker_filter.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialDevicePickerFilter +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialDevicePickerFilter + +## -description +Represents the filter used to determine which devices to show in a [DialDevicePicker](dialdevicepicker.md). The filter parameters are OR-ed together to build the resulting filter. + +## -remarks +This class is received by accessing the [DialDevicePicker.Filter](dialdevicepicker_filter.md) property. + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdevicepickerfilter_supportedappnames.md b/windows.media.dialprotocol/dialdevicepickerfilter_supportedappnames.md index ea75c3e4e0..c2305cfbf0 100644 --- a/windows.media.dialprotocol/dialdevicepickerfilter_supportedappnames.md +++ b/windows.media.dialprotocol/dialdevicepickerfilter_supportedappnames.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDevicePickerFilter.SupportedAppNames --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDevicePickerFilter.SupportedAppNames ## -description Gets a list of DIAL apps supported by the remote devices. Defaults to an empty list (no filter). You can add one or more app names and filter the devices list to those that can launch one the supported apps. ## -property-value The list of supported apps. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDevicePickerFilter.SupportedAppNames +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDevicePickerFilter.SupportedAppNames + +## -description +Gets a list of DIAL apps supported by the remote devices. Defaults to an empty list (no filter). You can add one or more app names and filter the devices list to those that can launch one the supported apps. + +## -property-value +The list of supported apps. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdeviceselectedeventargs.md b/windows.media.dialprotocol/dialdeviceselectedeventargs.md index e83c24181a..2867f23260 100644 --- a/windows.media.dialprotocol/dialdeviceselectedeventargs.md +++ b/windows.media.dialprotocol/dialdeviceselectedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialDeviceSelectedEventArgs --api-type: winrt class ---- # Windows.Media.DialProtocol.DialDeviceSelectedEventArgs ## -description Represents the event arguments for the [DialDeviceSelected](dialdevicepicker_dialdeviceselected.md) event on the [DialDevicePicker](dialdevicepicker.md) object. ## -remarks Get an instance of this class by accessing the [DialDeviceSelected](dialdevicepicker_dialdeviceselected.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialDeviceSelectedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialDeviceSelectedEventArgs + +## -description +Represents the event arguments for the [DialDeviceSelected](dialdevicepicker_dialdeviceselected.md) event on the [DialDevicePicker](dialdevicepicker.md) object. + +## -remarks +Get an instance of this class by accessing the [DialDeviceSelected](dialdevicepicker_dialdeviceselected.md) event. + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdeviceselectedeventargs_selecteddialdevice.md b/windows.media.dialprotocol/dialdeviceselectedeventargs_selecteddialdevice.md index b8edfc168f..da7ff42629 100644 --- a/windows.media.dialprotocol/dialdeviceselectedeventargs_selecteddialdevice.md +++ b/windows.media.dialprotocol/dialdeviceselectedeventargs_selecteddialdevice.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDeviceSelectedEventArgs.SelectedDialDevice --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDeviceSelectedEventArgs.SelectedDialDevice ## -description Gets the [DialDevice](dialdevice.md) object that represents the remote device that has been selected by the user in a [DialDevicePicker](dialdevicepicker.md). ## -property-value The remote device that the user selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDeviceSelectedEventArgs.SelectedDialDevice +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDeviceSelectedEventArgs.SelectedDialDevice + +## -description +Gets the [DialDevice](dialdevice.md) object that represents the remote device that has been selected by the user in a [DialDevicePicker](dialdevicepicker.md). + +## -property-value +The remote device that the user selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs.md b/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs.md index 33eaf56e7a..333b76f4a0 100644 --- a/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs.md +++ b/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs --api-type: winrt class ---- # Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs ## -description Represents the event arguments for the [DisconnectButtonClicked](dialdevicepicker_disconnectbuttonclicked.md) event on the [DialDevicePicker](dialdevicepicker.md) object. ## -remarks Get an instance of this class by accessing the [DisconnectButtonClicked](dialdevicepicker_disconnectbuttonclicked.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs + +## -description +Represents the event arguments for the [DisconnectButtonClicked](dialdevicepicker_disconnectbuttonclicked.md) event on the [DialDevicePicker](dialdevicepicker.md) object. + +## -remarks +Get an instance of this class by accessing the [DisconnectButtonClicked](dialdevicepicker_disconnectbuttonclicked.md) event. + +## -examples + +## -see-also diff --git a/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs_device.md b/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs_device.md index 6801e4f2ad..be57ac9027 100644 --- a/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs_device.md +++ b/windows.media.dialprotocol/dialdisconnectbuttonclickedeventargs_device.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs.Device --api-type: winrt property ---- # Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs.Device ## -description Gets the [DialDevice](dialdevice.md) object that represents the remote device that the user wants to disconnect. ## -property-value The device object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs.Device +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialDisconnectButtonClickedEventArgs.Device + +## -description +Gets the [DialDevice](dialdevice.md) object that represents the remote device that the user wants to disconnect. + +## -property-value +The device object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack.md b/windows.media.editing/backgroundaudiotrack.md index ec3bcc6a6d..13342b9fce 100644 --- a/windows.media.editing/backgroundaudiotrack.md +++ b/windows.media.editing/backgroundaudiotrack.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Editing.BackgroundAudioTrack --api-type: winrt class ---- # Windows.Media.Editing.BackgroundAudioTrack ## -description Represents a single audio track for accompanying a video clip. ## -remarks Add background audio tracks to a composition by adding them to a [MediaComposition](mediacomposition.md) object's [BackgroundAudioTracks](mediacomposition_backgroundaudiotracks.md) collection. For how-to guidance on adding media editing to your app, see [Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing). ## -examples ## -see-also [Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing) \ No newline at end of file +--- +-api-id: T:Windows.Media.Editing.BackgroundAudioTrack +-api-type: winrt class +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack + +## -description +Represents a single audio track for accompanying a video clip. + +## -remarks +Add background audio tracks to a composition by adding them to a [MediaComposition](mediacomposition.md) object's [BackgroundAudioTracks](mediacomposition_backgroundaudiotracks.md) collection. + +For how-to guidance on adding media editing to your app, see [Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing). + +## -examples + +## -see-also +[Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing) \ No newline at end of file diff --git a/windows.media.editing/backgroundaudiotrack_audioeffectdefinitions.md b/windows.media.editing/backgroundaudiotrack_audioeffectdefinitions.md index b93f39f453..5352924099 100644 --- a/windows.media.editing/backgroundaudiotrack_audioeffectdefinitions.md +++ b/windows.media.editing/backgroundaudiotrack_audioeffectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.AudioEffectDefinitions --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.AudioEffectDefinitions ## -description Gets the list of audio effect definitions for processing the background audio track. ## -property-value The list of audio effect definitions for processing the background audio track. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.AudioEffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.AudioEffectDefinitions + +## -description +Gets the list of audio effect definitions for processing the background audio track. + +## -property-value +The list of audio effect definitions for processing the background audio track. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.editing/backgroundaudiotrack_clone_766852569.md b/windows.media.editing/backgroundaudiotrack_clone_766852569.md index a37f2591a1..f245ea6d41 100644 --- a/windows.media.editing/backgroundaudiotrack_clone_766852569.md +++ b/windows.media.editing/backgroundaudiotrack_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.BackgroundAudioTrack.Clone --api-type: winrt method ---- # Windows.Media.Editing.BackgroundAudioTrack.Clone ## -description Creates a [BackgroundAudioTrack](backgroundaudiotrack.md) object that is identical to this instance. ## -returns A [BackgroundAudioTrack](backgroundaudiotrack.md) object that is a copy of this instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.BackgroundAudioTrack.Clone +-api-type: winrt method +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.Clone + +## -description +Creates a [BackgroundAudioTrack](backgroundaudiotrack.md) object that is identical to this instance. + +## -returns +A [BackgroundAudioTrack](backgroundaudiotrack.md) object that is a copy of this instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_createfromembeddedaudiotrack_1182466099.md b/windows.media.editing/backgroundaudiotrack_createfromembeddedaudiotrack_1182466099.md index 25c432fb41..8f42d863a3 100644 --- a/windows.media.editing/backgroundaudiotrack_createfromembeddedaudiotrack_1182466099.md +++ b/windows.media.editing/backgroundaudiotrack_createfromembeddedaudiotrack_1182466099.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Editing.BackgroundAudioTrack.CreateFromEmbeddedAudioTrack(Windows.Media.Editing.EmbeddedAudioTrack) --api-type: winrt method ---- # Windows.Media.Editing.BackgroundAudioTrack.CreateFromEmbeddedAudioTrack ## -description Creates a background audio track object with audio content copied from an embedded audio track object. ## -parameters ### -param embeddedAudioTrack An embedded audio track to use as the source audio for the background audio track. ## -returns A new background audio track object containing audio content copied from the embedded audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.BackgroundAudioTrack.CreateFromEmbeddedAudioTrack(Windows.Media.Editing.EmbeddedAudioTrack) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.CreateFromEmbeddedAudioTrack + +## -description +Creates a background audio track object with audio content copied from an embedded audio track object. + +## -parameters +### -param embeddedAudioTrack +An embedded audio track to use as the source audio for the background audio track. + +## -returns +A new background audio track object containing audio content copied from the embedded audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_createfromfileasync_691414423.md b/windows.media.editing/backgroundaudiotrack_createfromfileasync_691414423.md index a876b486fe..72acf29df6 100644 --- a/windows.media.editing/backgroundaudiotrack_createfromfileasync_691414423.md +++ b/windows.media.editing/backgroundaudiotrack_createfromfileasync_691414423.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Editing.BackgroundAudioTrack.CreateFromFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Editing.BackgroundAudioTrack.CreateFromFileAsync ## -description Creates a background audio track from an audio file. ## -parameters ### -param file A [StorageFile](../windows.storage/storagefile.md) object representing the source audio file. ## -returns A new background audio track object containing the contents of the audio file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.BackgroundAudioTrack.CreateFromFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.CreateFromFileAsync + +## -description +Creates a background audio track from an audio file. + +## -parameters +### -param file +A [StorageFile](../windows.storage/storagefile.md) object representing the source audio file. + +## -returns +A new background audio track object containing the contents of the audio file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_delay.md b/windows.media.editing/backgroundaudiotrack_delay.md index b3ad3c35ff..4e2b81b22b 100644 --- a/windows.media.editing/backgroundaudiotrack_delay.md +++ b/windows.media.editing/backgroundaudiotrack_delay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.Delay --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.Delay ## -description Specifies how long to wait before starting background audio playback. ## -property-value The length of time between the start of video playback and the start of background audio playback. This value can be negative to start background audio before video playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.Delay +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.Delay + +## -description +Specifies how long to wait before starting background audio playback. + +## -property-value +The length of time between the start of video playback and the start of background audio playback. This value can be negative to start background audio before video playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_getaudioencodingproperties_362290840.md b/windows.media.editing/backgroundaudiotrack_getaudioencodingproperties_362290840.md index 2b22201781..b8e046fc97 100644 --- a/windows.media.editing/backgroundaudiotrack_getaudioencodingproperties_362290840.md +++ b/windows.media.editing/backgroundaudiotrack_getaudioencodingproperties_362290840.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.BackgroundAudioTrack.GetAudioEncodingProperties --api-type: winrt method ---- # Windows.Media.Editing.BackgroundAudioTrack.GetAudioEncodingProperties ## -description Gets the [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the background audio track. ## -returns The [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the background audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.BackgroundAudioTrack.GetAudioEncodingProperties +-api-type: winrt method +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.GetAudioEncodingProperties + +## -description +Gets the [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the background audio track. + +## -returns +The [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the background audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_originalduration.md b/windows.media.editing/backgroundaudiotrack_originalduration.md index 54b0f756d6..72999dab34 100644 --- a/windows.media.editing/backgroundaudiotrack_originalduration.md +++ b/windows.media.editing/backgroundaudiotrack_originalduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.OriginalDuration --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.OriginalDuration ## -description Original playback time of the background audio track, without the effects of the [TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) and [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md) properties. ## -property-value The original duration of the background audio track is equal to [TrimmedDuration](backgroundaudiotrack_trimmedduration.md) + [TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) + [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.OriginalDuration +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.OriginalDuration + +## -description +Original playback time of the background audio track, without the effects of the [TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) and [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md) properties. + +## -property-value +The original duration of the background audio track is equal to [TrimmedDuration](backgroundaudiotrack_trimmedduration.md) + [TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) + [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_trimmedduration.md b/windows.media.editing/backgroundaudiotrack_trimmedduration.md index 74b83ed5fe..b0969f067f 100644 --- a/windows.media.editing/backgroundaudiotrack_trimmedduration.md +++ b/windows.media.editing/backgroundaudiotrack_trimmedduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.TrimmedDuration --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.TrimmedDuration ## -description Duration of the background audio track with [TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) and [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md) applied to playback. ## -property-value The trimmed duration of the background audio track is equal to [OriginalDuration](backgroundaudiotrack_originalduration.md) - ([TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) + [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md)). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.TrimmedDuration +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.TrimmedDuration + +## -description +Duration of the background audio track with [TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) and [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md) applied to playback. + +## -property-value +The trimmed duration of the background audio track is equal to [OriginalDuration](backgroundaudiotrack_originalduration.md) - ([TrimTimeFromStart](backgroundaudiotrack_trimtimefromstart.md) + [TrimTimeFromEnd](backgroundaudiotrack_trimtimefromend.md)). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_trimtimefromend.md b/windows.media.editing/backgroundaudiotrack_trimtimefromend.md index e96070b1b7..f43b01c049 100644 --- a/windows.media.editing/backgroundaudiotrack_trimtimefromend.md +++ b/windows.media.editing/backgroundaudiotrack_trimtimefromend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromEnd --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromEnd ## -description The amount of time to trim from the end of the background audio track. ## -property-value The trim time must be greater than or equal to 0 and less than the length of the background audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromEnd +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromEnd + +## -description +The amount of time to trim from the end of the background audio track. + +## -property-value +The trim time must be greater than or equal to 0 and less than the length of the background audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_trimtimefromstart.md b/windows.media.editing/backgroundaudiotrack_trimtimefromstart.md index 1d4217612e..c8c72cff60 100644 --- a/windows.media.editing/backgroundaudiotrack_trimtimefromstart.md +++ b/windows.media.editing/backgroundaudiotrack_trimtimefromstart.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromStart --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromStart ## -description The amount of time to trim from the beginning of the background audio track. ## -property-value The trim time must be greater than or equal to 0 and less than the length of the background audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromStart +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.TrimTimeFromStart + +## -description +The amount of time to trim from the beginning of the background audio track. + +## -property-value +The trim time must be greater than or equal to 0 and less than the length of the background audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_userdata.md b/windows.media.editing/backgroundaudiotrack_userdata.md index 31716be25d..0c3a22d31b 100644 --- a/windows.media.editing/backgroundaudiotrack_userdata.md +++ b/windows.media.editing/backgroundaudiotrack_userdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.UserData --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.UserData ## -description An associative collection for storing custom properties associated with the background audio track. ## -property-value The values stored in the [IMap](../windows.foundation.collections/imap_2.md) must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a description of the background audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.UserData +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.UserData + +## -description +An associative collection for storing custom properties associated with the background audio track. + +## -property-value +The values stored in the [IMap](../windows.foundation.collections/imap_2.md) must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a description of the background audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/backgroundaudiotrack_volume.md b/windows.media.editing/backgroundaudiotrack_volume.md index 095e379d30..bf455fb102 100644 --- a/windows.media.editing/backgroundaudiotrack_volume.md +++ b/windows.media.editing/backgroundaudiotrack_volume.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.BackgroundAudioTrack.Volume --api-type: winrt property ---- # Windows.Media.Editing.BackgroundAudioTrack.Volume ## -description Gets or sets the volume of the background audio track. ## -property-value A value between 0 and 1 represents a reduction in the volume level of the background audio track where 0 is silence and 1 is normal volume. A value greater than 1 represents a boost in the volume of the background audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.BackgroundAudioTrack.Volume +-api-type: winrt property +--- + + + +# Windows.Media.Editing.BackgroundAudioTrack.Volume + +## -description +Gets or sets the volume of the background audio track. + +## -property-value +A value between 0 and 1 represents a reduction in the volume level of the background audio track where 0 is silence and 1 is normal volume. A value greater than 1 represents a boost in the volume of the background audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/embeddedaudiotrack.md b/windows.media.editing/embeddedaudiotrack.md index 0aaa982a78..091209233b 100644 --- a/windows.media.editing/embeddedaudiotrack.md +++ b/windows.media.editing/embeddedaudiotrack.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Editing.EmbeddedAudioTrack --api-type: winrt class ---- # Windows.Media.Editing.EmbeddedAudioTrack ## -description Represents an audio track embedded in the media clip. ## -remarks Get an instance of this class by accessing the [MediaClip.EmbeddedAudioTracks](mediaclip_embeddedaudiotracks.md) property. ## -examples ## -see-also [MediaClip::EmbeddedAudioTracks](mediaclip_embeddedaudiotracks.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Editing.EmbeddedAudioTrack +-api-type: winrt class +--- + + + +# Windows.Media.Editing.EmbeddedAudioTrack + +## -description +Represents an audio track embedded in the media clip. + +## -remarks +Get an instance of this class by accessing the [MediaClip.EmbeddedAudioTracks](mediaclip_embeddedaudiotracks.md) property. + +## -examples + +## -see-also +[MediaClip::EmbeddedAudioTracks](mediaclip_embeddedaudiotracks.md) \ No newline at end of file diff --git a/windows.media.editing/embeddedaudiotrack_getaudioencodingproperties_362290840.md b/windows.media.editing/embeddedaudiotrack_getaudioencodingproperties_362290840.md index 1717ea7c63..e80c05435d 100644 --- a/windows.media.editing/embeddedaudiotrack_getaudioencodingproperties_362290840.md +++ b/windows.media.editing/embeddedaudiotrack_getaudioencodingproperties_362290840.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.EmbeddedAudioTrack.GetAudioEncodingProperties --api-type: winrt method ---- # Windows.Media.Editing.EmbeddedAudioTrack.GetAudioEncodingProperties ## -description Gets the [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the embedded audio track. ## -returns The [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the embedded audio track. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.EmbeddedAudioTrack.GetAudioEncodingProperties +-api-type: winrt method +--- + + + +# Windows.Media.Editing.EmbeddedAudioTrack.GetAudioEncodingProperties + +## -description +Gets the [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the embedded audio track. + +## -returns +The [AudioEncodingProperties](../windows.media.mediaproperties/audioencodingproperties.md) for the embedded audio track. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip.md b/windows.media.editing/mediaclip.md index 65f533449b..cc67b00a7f 100644 --- a/windows.media.editing/mediaclip.md +++ b/windows.media.editing/mediaclip.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Editing.MediaClip --api-type: winrt class ---- # Windows.Media.Editing.MediaClip ## -description Represents a single media object. ## -remarks Add media clips to a composition by adding them to a [MediaComposition](mediacomposition.md) object's [Clips](mediacomposition_clips.md) collection. For how-to guidance on adding media editing to your app, see [Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing). ## -examples ## -see-also [Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing) \ No newline at end of file +--- +-api-id: T:Windows.Media.Editing.MediaClip +-api-type: winrt class +--- + + + +# Windows.Media.Editing.MediaClip + +## -description +Represents a single media object. + +## -remarks +Add media clips to a composition by adding them to a [MediaComposition](mediacomposition.md) object's [Clips](mediacomposition_clips.md) collection. + +For how-to guidance on adding media editing to your app, see [Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing). + +## -examples + +## -see-also +[Media compositions and editing](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-compositions-and-editing) \ No newline at end of file diff --git a/windows.media.editing/mediaclip_audioeffectdefinitions.md b/windows.media.editing/mediaclip_audioeffectdefinitions.md index e35ff839d8..c8fa4530f1 100644 --- a/windows.media.editing/mediaclip_audioeffectdefinitions.md +++ b/windows.media.editing/mediaclip_audioeffectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.AudioEffectDefinitions --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.AudioEffectDefinitions ## -description Gets the list of audio effect definitions for processing the media clip. ## -property-value The list of audio effect definitions for processing the media clip. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.AudioEffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.AudioEffectDefinitions + +## -description +Gets the list of audio effect definitions for processing the media clip. + +## -property-value +The list of audio effect definitions for processing the media clip. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](../windows.media.effects/iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.editing/mediaclip_clone_766852569.md b/windows.media.editing/mediaclip_clone_766852569.md index 552f8a309a..88719a6fa5 100644 --- a/windows.media.editing/mediaclip_clone_766852569.md +++ b/windows.media.editing/mediaclip_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.MediaClip.Clone --api-type: winrt method ---- # Windows.Media.Editing.MediaClip.Clone ## -description Creates a [MediaClip](mediaclip.md) object that is identical to this instance. ## -returns A [MediaClip](mediaclip.md) object that is a copy of this instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaClip.Clone +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaClip.Clone + +## -description +Creates a [MediaClip](mediaclip.md) object that is identical to this instance. + +## -returns +A [MediaClip](mediaclip.md) object that is a copy of this instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_createfromcolor_319460630.md b/windows.media.editing/mediaclip_createfromcolor_319460630.md index b8288f9b11..ad0a41518c 100644 --- a/windows.media.editing/mediaclip_createfromcolor_319460630.md +++ b/windows.media.editing/mediaclip_createfromcolor_319460630.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Editing.MediaClip.CreateFromColor(Windows.UI.Color,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Editing.MediaClip.CreateFromColor ## -description Creates a solid color video clip that displays a single color for a specified length of time. Solid color video clips are typically used to create an explicit gap between video segments. ## -parameters ### -param color The color to display in the video clip. ### -param originalDuration How long to display the color in the video clip. ## -returns A new media clip object containing the color-based video clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaClip.CreateFromColor(Windows.UI.Color,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaClip.CreateFromColor + +## -description +Creates a solid color video clip that displays a single color for a specified length of time. Solid color video clips are typically used to create an explicit gap between video segments. + +## -parameters +### -param color +The color to display in the video clip. + +### -param originalDuration +How long to display the color in the video clip. + +## -returns +A new media clip object containing the color-based video clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_createfromfileasync_691414423.md b/windows.media.editing/mediaclip_createfromfileasync_691414423.md index 6320e0ff3b..45cc159d1d 100644 --- a/windows.media.editing/mediaclip_createfromfileasync_691414423.md +++ b/windows.media.editing/mediaclip_createfromfileasync_691414423.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Editing.MediaClip.CreateFromFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Editing.MediaClip.CreateFromFileAsync ## -description Creates a video clip from a video file. ## -parameters ### -param file A [StorageFile](../windows.storage/storagefile.md) object representing the source video file. ## -returns A new media clip object containing a video clip of the video file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaClip.CreateFromFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaClip.CreateFromFileAsync + +## -description +Creates a video clip from a video file. + +## -parameters +### -param file +A [StorageFile](../windows.storage/storagefile.md) object representing the source video file. + +## -returns +A new media clip object containing a video clip of the video file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_createfromimagefileasync_1851608400.md b/windows.media.editing/mediaclip_createfromimagefileasync_1851608400.md index 5ff6e05de0..e86b7844a2 100644 --- a/windows.media.editing/mediaclip_createfromimagefileasync_1851608400.md +++ b/windows.media.editing/mediaclip_createfromimagefileasync_1851608400.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Editing.MediaClip.CreateFromImageFileAsync(Windows.Storage.IStorageFile,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Editing.MediaClip.CreateFromImageFileAsync ## -description Creates a video clip that displays a single image for a specified length of time. ## -parameters ### -param file A [StorageFile](../windows.storage/storagefile.md) object representing the source image file. ### -param originalDuration How long to display the image in the video clip. ## -returns A new media clip object containing the image-based video clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaClip.CreateFromImageFileAsync(Windows.Storage.IStorageFile,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaClip.CreateFromImageFileAsync + +## -description +Creates a video clip that displays a single image for a specified length of time. + +## -parameters +### -param file +A [StorageFile](../windows.storage/storagefile.md) object representing the source image file. + +### -param originalDuration +How long to display the image in the video clip. + +## -returns +A new media clip object containing the image-based video clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_createfromsurface_1982131637.md b/windows.media.editing/mediaclip_createfromsurface_1982131637.md index eb23dd2182..37f76c6309 100644 --- a/windows.media.editing/mediaclip_createfromsurface_1982131637.md +++ b/windows.media.editing/mediaclip_createfromsurface_1982131637.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Editing.MediaClip.CreateFromSurface(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Editing.MediaClip.CreateFromSurface ## -description Creates a video clip from a Microsoft Direct3D surface. ## -parameters ### -param surface The Microsoft Direct3D surface. ### -param originalDuration The initial duration of the created video clip. ## -returns A new media clip object containing the video clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaClip.CreateFromSurface(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaClip.CreateFromSurface + +## -description +Creates a video clip from a Microsoft Direct3D surface. + +## -parameters +### -param surface +The Microsoft Direct3D surface. + +### -param originalDuration +The initial duration of the created video clip. + +## -returns +A new media clip object containing the video clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_embeddedaudiotracks.md b/windows.media.editing/mediaclip_embeddedaudiotracks.md index 182e76c504..b3d5109cf5 100644 --- a/windows.media.editing/mediaclip_embeddedaudiotracks.md +++ b/windows.media.editing/mediaclip_embeddedaudiotracks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.EmbeddedAudioTracks --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.EmbeddedAudioTracks ## -description The list of embedded audio tracks in this media clip. ## -property-value Each member in the list is an [EmbeddedAudioTrack](embeddedaudiotrack.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.EmbeddedAudioTracks +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.EmbeddedAudioTracks + +## -description +The list of embedded audio tracks in this media clip. + +## -property-value +Each member in the list is an [EmbeddedAudioTrack](embeddedaudiotrack.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_endtimeincomposition.md b/windows.media.editing/mediaclip_endtimeincomposition.md index 5710815218..b29fac9fab 100644 --- a/windows.media.editing/mediaclip_endtimeincomposition.md +++ b/windows.media.editing/mediaclip_endtimeincomposition.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.EndTimeInComposition --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.EndTimeInComposition ## -description The time when the media clip stops playing within a [MediaComposition](mediacomposition.md). ## -property-value Time is measured relative to the beginning of the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.EndTimeInComposition +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.EndTimeInComposition + +## -description +The time when the media clip stops playing within a [MediaComposition](mediacomposition.md). + +## -property-value +Time is measured relative to the beginning of the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_getvideoencodingproperties_201005063.md b/windows.media.editing/mediaclip_getvideoencodingproperties_201005063.md index e98aa77334..6d7f2478f5 100644 --- a/windows.media.editing/mediaclip_getvideoencodingproperties_201005063.md +++ b/windows.media.editing/mediaclip_getvideoencodingproperties_201005063.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.MediaClip.GetVideoEncodingProperties --api-type: winrt method ---- # Windows.Media.Editing.MediaClip.GetVideoEncodingProperties ## -description Gets the [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) for the media clip. ## -returns The [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) for the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaClip.GetVideoEncodingProperties +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaClip.GetVideoEncodingProperties + +## -description +Gets the [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) for the media clip. + +## -returns +The [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) for the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_originalduration.md b/windows.media.editing/mediaclip_originalduration.md index 2b261368e9..5173f2478c 100644 --- a/windows.media.editing/mediaclip_originalduration.md +++ b/windows.media.editing/mediaclip_originalduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.OriginalDuration --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.OriginalDuration ## -description Original playback time of the media clip, without the effects of [TrimTimeFromStart](mediaclip_trimtimefromstart.md) and [TrimTimeFromEnd](mediaclip_trimtimefromend.md) properties. ## -property-value The original duration of the media clip is equal to [TrimmedDuration](mediaclip_trimmedduration.md) + [TrimTimeFromStart](mediaclip_trimtimefromstart.md) + [TrimTimeFromEnd](mediaclip_trimtimefromend.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.OriginalDuration +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.OriginalDuration + +## -description +Original playback time of the media clip, without the effects of [TrimTimeFromStart](mediaclip_trimtimefromstart.md) and [TrimTimeFromEnd](mediaclip_trimtimefromend.md) properties. + +## -property-value +The original duration of the media clip is equal to [TrimmedDuration](mediaclip_trimmedduration.md) + [TrimTimeFromStart](mediaclip_trimtimefromstart.md) + [TrimTimeFromEnd](mediaclip_trimtimefromend.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_selectedembeddedaudiotrackindex.md b/windows.media.editing/mediaclip_selectedembeddedaudiotrackindex.md index 2e7d13a3b0..f5bc270e00 100644 --- a/windows.media.editing/mediaclip_selectedembeddedaudiotrackindex.md +++ b/windows.media.editing/mediaclip_selectedembeddedaudiotrackindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.SelectedEmbeddedAudioTrackIndex --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.SelectedEmbeddedAudioTrackIndex ## -description The index of the audio track within the media clip that is used for playback. ## -property-value The default value of 0 selects the first audio track within the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.SelectedEmbeddedAudioTrackIndex +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.SelectedEmbeddedAudioTrackIndex + +## -description +The index of the audio track within the media clip that is used for playback. + +## -property-value +The default value of 0 selects the first audio track within the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_starttimeincomposition.md b/windows.media.editing/mediaclip_starttimeincomposition.md index b29013faa7..0865d15667 100644 --- a/windows.media.editing/mediaclip_starttimeincomposition.md +++ b/windows.media.editing/mediaclip_starttimeincomposition.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.StartTimeInComposition --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.StartTimeInComposition ## -description The time when the media clip starts playing within a [MediaComposition](mediacomposition.md). ## -property-value Time is measured relative to the beginning of the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.StartTimeInComposition +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.StartTimeInComposition + +## -description +The time when the media clip starts playing within a [MediaComposition](mediacomposition.md). + +## -property-value +Time is measured relative to the beginning of the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_trimmedduration.md b/windows.media.editing/mediaclip_trimmedduration.md index fef5754afb..9fa6a47cfc 100644 --- a/windows.media.editing/mediaclip_trimmedduration.md +++ b/windows.media.editing/mediaclip_trimmedduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.TrimmedDuration --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.TrimmedDuration ## -description Duration of the media clip with [TrimTimeFromStart](mediaclip_trimtimefromstart.md) and [TrimTimeFromEnd](mediaclip_trimtimefromend.md) applied to playback. ## -property-value The trimmed duration of the media clip is equal to [OriginalDuration](mediaclip_originalduration.md) - ([TrimTimeFromStart](mediaclip_trimtimefromstart.md) + [TrimTimeFromEnd](mediaclip_trimtimefromend.md)). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.TrimmedDuration +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.TrimmedDuration + +## -description +Duration of the media clip with [TrimTimeFromStart](mediaclip_trimtimefromstart.md) and [TrimTimeFromEnd](mediaclip_trimtimefromend.md) applied to playback. + +## -property-value +The trimmed duration of the media clip is equal to [OriginalDuration](mediaclip_originalduration.md) - ([TrimTimeFromStart](mediaclip_trimtimefromstart.md) + [TrimTimeFromEnd](mediaclip_trimtimefromend.md)). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_trimtimefromend.md b/windows.media.editing/mediaclip_trimtimefromend.md index 55d8878e79..537344ecf8 100644 --- a/windows.media.editing/mediaclip_trimtimefromend.md +++ b/windows.media.editing/mediaclip_trimtimefromend.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.TrimTimeFromEnd --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.TrimTimeFromEnd ## -description The amount of time to trim from the end of the media clip. ## -property-value The trim time must be greater than or equal to 0 and less than the length of the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.TrimTimeFromEnd +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.TrimTimeFromEnd + +## -description +The amount of time to trim from the end of the media clip. + +## -property-value +The trim time must be greater than or equal to 0 and less than the length of the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_trimtimefromstart.md b/windows.media.editing/mediaclip_trimtimefromstart.md index fc4d93615d..95e81ca03a 100644 --- a/windows.media.editing/mediaclip_trimtimefromstart.md +++ b/windows.media.editing/mediaclip_trimtimefromstart.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.TrimTimeFromStart --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.TrimTimeFromStart ## -description The amount of time to trim from the beginning of the media clip. ## -property-value The trim time must be greater than or equal to 0 and less than the length of the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.TrimTimeFromStart +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.TrimTimeFromStart + +## -description +The amount of time to trim from the beginning of the media clip. + +## -property-value +The trim time must be greater than or equal to 0 and less than the length of the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_userdata.md b/windows.media.editing/mediaclip_userdata.md index d365df820e..b75ab5faab 100644 --- a/windows.media.editing/mediaclip_userdata.md +++ b/windows.media.editing/mediaclip_userdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.UserData --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.UserData ## -description An associative collection for storing custom properties associated with the media clip. ## -property-value The values stored in the [IMap](../windows.foundation.collections/imap_2.md) must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a clip name, an application-related clip identifier, or a clip description. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.UserData +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.UserData + +## -description +An associative collection for storing custom properties associated with the media clip. + +## -property-value +The values stored in the [IMap](../windows.foundation.collections/imap_2.md) must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a clip name, an application-related clip identifier, or a clip description. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaclip_videoeffectdefinitions.md b/windows.media.editing/mediaclip_videoeffectdefinitions.md index 8e1d011baf..3a02532614 100644 --- a/windows.media.editing/mediaclip_videoeffectdefinitions.md +++ b/windows.media.editing/mediaclip_videoeffectdefinitions.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.VideoEffectDefinitions --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.VideoEffectDefinitions ## -description Gets the list of video effect definitions for processing the media clip. ## -property-value The list of video effect definitions for processing the media clip. ## -remarks ## -examples ## -see-also [IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md) \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.VideoEffectDefinitions +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.VideoEffectDefinitions + +## -description +Gets the list of video effect definitions for processing the media clip. + +## -property-value +The list of video effect definitions for processing the media clip. + +## -remarks + +## -examples + +## -see-also +[IVideoEffectDefinition](../windows.media.effects/ivideoeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.editing/mediaclip_volume.md b/windows.media.editing/mediaclip_volume.md index 0a985b169d..d5dff9136e 100644 --- a/windows.media.editing/mediaclip_volume.md +++ b/windows.media.editing/mediaclip_volume.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaClip.Volume --api-type: winrt property ---- # Windows.Media.Editing.MediaClip.Volume ## -description Gets or sets the volume of the media clip. ## -property-value A value between 0 and 1 represents a reduction in the volume level of the media clip where 0 is silence and 1 is normal volume. A value greater than 1 represents a boost in the volume of the media clip. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaClip.Volume +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaClip.Volume + +## -description +Gets or sets the volume of the media clip. + +## -property-value +A value between 0 and 1 represents a reduction in the volume level of the media clip where 0 is silence and 1 is normal volume. A value greater than 1 represents a boost in the volume of the media clip. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition.md b/windows.media.editing/mediacomposition.md index 4203294c1d..8b25e068d0 100644 --- a/windows.media.editing/mediacomposition.md +++ b/windows.media.editing/mediacomposition.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Editing.MediaComposition --api-type: winrt class ---- # Windows.Media.Editing.MediaComposition ## -description Represents a collection of media clips and background audio tracks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Editing.MediaComposition +-api-type: winrt class +--- + + + +# Windows.Media.Editing.MediaComposition + +## -description +Represents a collection of media clips and background audio tracks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_backgroundaudiotracks.md b/windows.media.editing/mediacomposition_backgroundaudiotracks.md index 581fc26c8c..8b058e6808 100644 --- a/windows.media.editing/mediacomposition_backgroundaudiotracks.md +++ b/windows.media.editing/mediacomposition_backgroundaudiotracks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaComposition.BackgroundAudioTracks --api-type: winrt property ---- # Windows.Media.Editing.MediaComposition.BackgroundAudioTracks ## -description A collection of background audio tracks for playback in the media composition. ## -property-value The collection of [BackgroundAudioTrack](backgroundaudiotrack.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaComposition.BackgroundAudioTracks +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaComposition.BackgroundAudioTracks + +## -description +A collection of background audio tracks for playback in the media composition. + +## -property-value +The collection of [BackgroundAudioTrack](backgroundaudiotrack.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_clips.md b/windows.media.editing/mediacomposition_clips.md index b354232d8c..783596d155 100644 --- a/windows.media.editing/mediacomposition_clips.md +++ b/windows.media.editing/mediacomposition_clips.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaComposition.Clips --api-type: winrt property ---- # Windows.Media.Editing.MediaComposition.Clips ## -description A collection of media clips for playback in the media composition. ## -property-value The collection of [MediaClip](mediaclip.md) objects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaComposition.Clips +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaComposition.Clips + +## -description +A collection of media clips for playback in the media composition. + +## -property-value +The collection of [MediaClip](mediaclip.md) objects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_clone_766852569.md b/windows.media.editing/mediacomposition_clone_766852569.md index 01c637abcb..f90aee7db2 100644 --- a/windows.media.editing/mediacomposition_clone_766852569.md +++ b/windows.media.editing/mediacomposition_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.Clone --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.Clone ## -description Creates a [MediaComposition](mediacomposition.md) object that is identical to this instance. ## -returns A [MediaComposition](mediacomposition.md) object that is a copy of this instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.Clone +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.Clone + +## -description +Creates a [MediaComposition](mediacomposition.md) object that is identical to this instance. + +## -returns +A [MediaComposition](mediacomposition.md) object that is a copy of this instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_createdefaultencodingprofile_1452792791.md b/windows.media.editing/mediacomposition_createdefaultencodingprofile_1452792791.md index c4800d84df..4cdacc141f 100644 --- a/windows.media.editing/mediacomposition_createdefaultencodingprofile_1452792791.md +++ b/windows.media.editing/mediacomposition_createdefaultencodingprofile_1452792791.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.CreateDefaultEncodingProfile --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.CreateDefaultEncodingProfile ## -description Create a new default media encoding profile which can be modified if necessary. ## -returns The newly created [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.CreateDefaultEncodingProfile +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.CreateDefaultEncodingProfile + +## -description +Create a new default media encoding profile which can be modified if necessary. + +## -returns +The newly created [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_duration.md b/windows.media.editing/mediacomposition_duration.md index 3e66c79f30..dab51dc164 100644 --- a/windows.media.editing/mediacomposition_duration.md +++ b/windows.media.editing/mediacomposition_duration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaComposition.Duration --api-type: winrt property ---- # Windows.Media.Editing.MediaComposition.Duration ## -description The total playback time of the media composition. ## -property-value The sum of the trimmed durations of all media clips in the composition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaComposition.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaComposition.Duration + +## -description +The total playback time of the media composition. + +## -property-value +The sum of the trimmed durations of all media clips in the composition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_generatemediastreamsource_1045644852.md b/windows.media.editing/mediacomposition_generatemediastreamsource_1045644852.md index 1c22ee4f1a..c9446806d5 100644 --- a/windows.media.editing/mediacomposition_generatemediastreamsource_1045644852.md +++ b/windows.media.editing/mediacomposition_generatemediastreamsource_1045644852.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource(Windows.Media.MediaProperties.MediaEncodingProfile) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource ## -description Creates a new [MediaStreamSource](../windows.media.core/mediastreamsource.md) using the specified [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md). ## -parameters ### -param encodingProfile The [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md) used to specify the encoding properties of the new [MediaStreamSource](../windows.media.core/mediastreamsource.md). ## -returns The newly created [MediaStreamSource](../windows.media.core/mediastreamsource.md). ## -remarks ## -examples ## -see-also [GenerateMediaStreamSource](mediacomposition_generatemediastreamsource_2042910705.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource(Windows.Media.MediaProperties.MediaEncodingProfile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource + +## -description +Creates a new [MediaStreamSource](../windows.media.core/mediastreamsource.md) using the specified [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md). + +## -parameters +### -param encodingProfile +The [MediaEncodingProfile](../windows.media.mediaproperties/mediaencodingprofile.md) used to specify the encoding properties of the new [MediaStreamSource](../windows.media.core/mediastreamsource.md). + +## -returns +The newly created [MediaStreamSource](../windows.media.core/mediastreamsource.md). + +## -remarks + +## -examples + +## -see-also +[GenerateMediaStreamSource](mediacomposition_generatemediastreamsource_2042910705.md) \ No newline at end of file diff --git a/windows.media.editing/mediacomposition_generatemediastreamsource_2042910705.md b/windows.media.editing/mediacomposition_generatemediastreamsource_2042910705.md index c83024f783..716eebce0b 100644 --- a/windows.media.editing/mediacomposition_generatemediastreamsource_2042910705.md +++ b/windows.media.editing/mediacomposition_generatemediastreamsource_2042910705.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource ## -description Creates a new [MediaStreamSource](../windows.media.core/mediastreamsource.md). ## -returns The newly created [MediaStreamSource](../windows.media.core/mediastreamsource.md). ## -remarks ## -examples ## -see-also [GenerateMediaStreamSource(MediaEncodingProfile)](mediacomposition_generatemediastreamsource_1045644852.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.GenerateMediaStreamSource + +## -description +Creates a new [MediaStreamSource](../windows.media.core/mediastreamsource.md). + +## -returns +The newly created [MediaStreamSource](../windows.media.core/mediastreamsource.md). + +## -remarks + +## -examples + +## -see-also +[GenerateMediaStreamSource(MediaEncodingProfile)](mediacomposition_generatemediastreamsource_1045644852.md) \ No newline at end of file diff --git a/windows.media.editing/mediacomposition_generatepreviewmediastreamsource_1062600190.md b/windows.media.editing/mediacomposition_generatepreviewmediastreamsource_1062600190.md index a70baf66d6..97a6317128 100644 --- a/windows.media.editing/mediacomposition_generatepreviewmediastreamsource_1062600190.md +++ b/windows.media.editing/mediacomposition_generatepreviewmediastreamsource_1062600190.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.GeneratePreviewMediaStreamSource(System.Int32,System.Int32) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.GeneratePreviewMediaStreamSource ## -description Creates a new [MediaStreamSource](../windows.media.core/mediastreamsource.md) used to preview the edited media. ## -parameters ### -param scaledWidth The width of the preview media. ### -param scaledHeight The height of the preview media. ## -returns The new [MediaStreamSource](../windows.media.core/mediastreamsource.md) used to preview the edited media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.GeneratePreviewMediaStreamSource(System.Int32,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.GeneratePreviewMediaStreamSource + +## -description +Creates a new [MediaStreamSource](../windows.media.core/mediastreamsource.md) used to preview the edited media. + +## -parameters +### -param scaledWidth +The width of the preview media. + +### -param scaledHeight +The height of the preview media. + +## -returns +The new [MediaStreamSource](../windows.media.core/mediastreamsource.md) used to preview the edited media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_getthumbnailasync_1694609403.md b/windows.media.editing/mediacomposition_getthumbnailasync_1694609403.md index e766fd25a0..18706aa2ab 100644 --- a/windows.media.editing/mediacomposition_getthumbnailasync_1694609403.md +++ b/windows.media.editing/mediacomposition_getthumbnailasync_1694609403.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.GetThumbnailAsync(Windows.Foundation.TimeSpan,System.Int32,System.Int32,Windows.Media.Editing.VideoFramePrecision) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.GetThumbnailAsync ## -description Asynchronously gets an image stream that represents a thumbnail of the media composition. ## -parameters ### -param timeFromStart Specifies the point in the timeline of the [MediaComposition](mediacomposition.md) from which to render the thumbnail, offset from the start of the [MediaComposition](mediacomposition.md). ### -param scaledWidth Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. ### -param scaledHeight Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. ### -param framePrecision Specifies the frame precision algorithm to use when retrieving the thumbnail. ## -returns An image stream representing resulting thumbnail. ## -remarks If *scaledWidth* and *scaledHeight* are both set, the aspect ratio of the original [MediaComposition](mediacomposition.md) is ignored, and your values can alter the aspect ratio. If either *scaledWidth* or *scaledHeight* but not both is specified, the value you provide controls that dimension but the aspect ratio is preserved (the other dimension is calculated based on factoring the original aspect ratio of the [MediaComposition](mediacomposition.md)). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.GetThumbnailAsync(Windows.Foundation.TimeSpan,System.Int32,System.Int32,Windows.Media.Editing.VideoFramePrecision) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.GetThumbnailAsync + +## -description +Asynchronously gets an image stream that represents a thumbnail of the media composition. + +## -parameters +### -param timeFromStart +Specifies the point in the timeline of the [MediaComposition](mediacomposition.md) from which to render the thumbnail, offset from the start of the [MediaComposition](mediacomposition.md). + +### -param scaledWidth +Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. + +### -param scaledHeight +Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. + +### -param framePrecision +Specifies the frame precision algorithm to use when retrieving the thumbnail. + +## -returns +An image stream representing resulting thumbnail. + +## -remarks +If *scaledWidth* and *scaledHeight* are both set, the aspect ratio of the original [MediaComposition](mediacomposition.md) is ignored, and your values can alter the aspect ratio. + +If either *scaledWidth* or *scaledHeight* but not both is specified, the value you provide controls that dimension but the aspect ratio is preserved (the other dimension is calculated based on factoring the original aspect ratio of the [MediaComposition](mediacomposition.md)). + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_getthumbnailsasync_1189062213.md b/windows.media.editing/mediacomposition_getthumbnailsasync_1189062213.md index 45c5e916f3..3dba7adbee 100644 --- a/windows.media.editing/mediacomposition_getthumbnailsasync_1189062213.md +++ b/windows.media.editing/mediacomposition_getthumbnailsasync_1189062213.md @@ -1,3 +1,38 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.GetThumbnailsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.TimeSpan},System.Int32,System.Int32,Windows.Media.Editing.VideoFramePrecision) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.GetThumbnailsAsync ## -description Asynchronously gets a vector view of thumbnails of the media composition. ## -parameters ### -param timesFromStart Specifies the points in the timeline of the [MediaComposition](mediacomposition.md) from which to render the thumbnails, offset from the start of the [MediaComposition](mediacomposition.md). ### -param scaledWidth Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. ### -param scaledHeight Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. ### -param framePrecision Specifies the frame precision algorithm to use when retrieving the thumbnails. ## -returns A vector view on the resulting thumbnails. ## -remarks If *scaledWidth* and *scaledHeight* are both set, the aspect ratio of the original [MediaComposition](mediacomposition.md) is ignored, and your values can alter the aspect ratio. If either *scaledWidth* or *scaledHeight* but not both is specified, the value you provide controls that dimension but the aspect ratio is preserved (the other dimension is calculated based on factoring the original aspect ratio of the [MediaComposition](mediacomposition.md)). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.GetThumbnailsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.TimeSpan},System.Int32,System.Int32,Windows.Media.Editing.VideoFramePrecision) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.GetThumbnailsAsync + +## -description +Asynchronously gets a vector view of thumbnails of the media composition. + +## -parameters +### -param timesFromStart +Specifies the points in the timeline of the [MediaComposition](mediacomposition.md) from which to render the thumbnails, offset from the start of the [MediaComposition](mediacomposition.md). + +### -param scaledWidth +Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. + +### -param scaledHeight +Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. + +### -param framePrecision +Specifies the frame precision algorithm to use when retrieving the thumbnails. + +## -returns +A vector view on the resulting thumbnails. + +## -remarks +If *scaledWidth* and *scaledHeight* are both set, the aspect ratio of the original [MediaComposition](mediacomposition.md) is ignored, and your values can alter the aspect ratio. + +If either *scaledWidth* or *scaledHeight* but not both is specified, the value you provide controls that dimension but the aspect ratio is preserved (the other dimension is calculated based on factoring the original aspect ratio of the [MediaComposition](mediacomposition.md)). + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_loadasync_1582010589.md b/windows.media.editing/mediacomposition_loadasync_1582010589.md index b51b1090b3..e3562ad350 100644 --- a/windows.media.editing/mediacomposition_loadasync_1582010589.md +++ b/windows.media.editing/mediacomposition_loadasync_1582010589.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.LoadAsync(Windows.Storage.StorageFile) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.LoadAsync ## -description Asynchronously loads a [MediaComposition](mediacomposition.md) from a [StorageFile](../windows.storage/storagefile.md). ## -parameters ### -param file The file from which to load the [MediaComposition](mediacomposition.md). ## -returns An async operation which can be used to track the success or failure of the operation. ## -remarks This method allows you to load a composition from an XML file you saved with a previous call to [SaveAsync](mediacomposition_saveasync.md). Once you have loaded the composition, you can make changes to the composition and either save it again or render it to a video file by calling [RenderToFileAsync](mediacomposition_rendertofileasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.LoadAsync(Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.LoadAsync + +## -description +Asynchronously loads a [MediaComposition](mediacomposition.md) from a [StorageFile](../windows.storage/storagefile.md). + +## -parameters +### -param file +The file from which to load the [MediaComposition](mediacomposition.md). + +## -returns +An async operation which can be used to track the success or failure of the operation. + +## -remarks +This method allows you to load a composition from an XML file you saved with a previous call to [SaveAsync](mediacomposition_saveasync.md). Once you have loaded the composition, you can make changes to the composition and either save it again or render it to a video file by calling [RenderToFileAsync](mediacomposition_rendertofileasync.md). + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_mediacomposition_1221375020.md b/windows.media.editing/mediacomposition_mediacomposition_1221375020.md index 71a9238894..1a5ff6ee18 100644 --- a/windows.media.editing/mediacomposition_mediacomposition_1221375020.md +++ b/windows.media.editing/mediacomposition_mediacomposition_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.#ctor --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.MediaComposition ## -description Initializes a new instance of the [MediaComposition](mediacomposition.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.MediaComposition + +## -description +Initializes a new instance of the [MediaComposition](mediacomposition.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_overlaylayers.md b/windows.media.editing/mediacomposition_overlaylayers.md index 9b7872855a..cd9c542e36 100644 --- a/windows.media.editing/mediacomposition_overlaylayers.md +++ b/windows.media.editing/mediacomposition_overlaylayers.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaComposition.OverlayLayers --api-type: winrt property ---- # Windows.Media.Editing.MediaComposition.OverlayLayers ## -description Gets the list of overlay layers for the media composition. ## -property-value The list of overlay layers for the media composition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaComposition.OverlayLayers +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaComposition.OverlayLayers + +## -description +Gets the list of overlay layers for the media composition. + +## -property-value +The list of overlay layers for the media composition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_rendertofileasync_1125216263.md b/windows.media.editing/mediacomposition_rendertofileasync_1125216263.md index d1fe42067d..5697626b62 100644 --- a/windows.media.editing/mediacomposition_rendertofileasync_1125216263.md +++ b/windows.media.editing/mediacomposition_rendertofileasync_1125216263.md @@ -1,3 +1,31 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.RenderToFileAsync(Windows.Storage.IStorageFile,Windows.Media.Editing.MediaTrimmingPreference) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.RenderToFileAsync ## -description Asynchronously renders the [MediaComposition](mediacomposition.md) to a specified file using the indicated media trimming preference. ## -parameters ### -param destination The file to which this [MediaComposition](mediacomposition.md) is rendered. ### -param trimmingPreference Specifies whether to be fast or precise when trimming the media. ## -returns An async operation which can be used to track the success or failure of the operation. ## -remarks This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use [SaveAsync](mediacomposition_saveasync.md). ## -examples ## -see-also [RenderToFileAsync(IStorageFile)](mediacomposition_rendertofileasync_1970129585.md), [RenderToFileAsync(IStorageFile, MediaTrimmingPreference, MediaEncodingProfile)](mediacomposition_rendertofileasync_1565341453.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.RenderToFileAsync(Windows.Storage.IStorageFile,Windows.Media.Editing.MediaTrimmingPreference) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.RenderToFileAsync + +## -description +Asynchronously renders the [MediaComposition](mediacomposition.md) to a specified file using the indicated media trimming preference. + +## -parameters +### -param destination +The file to which this [MediaComposition](mediacomposition.md) is rendered. + +### -param trimmingPreference +Specifies whether to be fast or precise when trimming the media. + +## -returns +An async operation which can be used to track the success or failure of the operation. + +## -remarks +This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use [SaveAsync](mediacomposition_saveasync.md). + +## -examples + +## -see-also +[RenderToFileAsync(IStorageFile)](mediacomposition_rendertofileasync_1970129585.md), [RenderToFileAsync(IStorageFile, MediaTrimmingPreference, MediaEncodingProfile)](mediacomposition_rendertofileasync_1565341453.md) \ No newline at end of file diff --git a/windows.media.editing/mediacomposition_rendertofileasync_1565341453.md b/windows.media.editing/mediacomposition_rendertofileasync_1565341453.md index cc2abc9574..3453e70d75 100644 --- a/windows.media.editing/mediacomposition_rendertofileasync_1565341453.md +++ b/windows.media.editing/mediacomposition_rendertofileasync_1565341453.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.RenderToFileAsync(Windows.Storage.IStorageFile,Windows.Media.Editing.MediaTrimmingPreference,Windows.Media.MediaProperties.MediaEncodingProfile) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.RenderToFileAsync ## -description Asynchronously renders the [MediaComposition](mediacomposition.md) to a specified file using the indicated media trimming preference and encoding profile. ## -parameters ### -param destination The file to which this [MediaComposition](mediacomposition.md) is rendered. ### -param trimmingPreference Specifies whether to be fast or precise when trimming the media. ### -param encodingProfile Specifies the encoding profile to use for rendering the media. ## -returns An async operation which can be used to track the success or failure of the operation. ## -remarks This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use [SaveAsync](mediacomposition_saveasync.md). ## -examples ## -see-also [RenderToFileAsync(IStorageFile)](mediacomposition_rendertofileasync_1970129585.md), [RenderToFileAsync(IStorageFile, MediaTrimmingPreference)](mediacomposition_rendertofileasync_1125216263.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.RenderToFileAsync(Windows.Storage.IStorageFile,Windows.Media.Editing.MediaTrimmingPreference,Windows.Media.MediaProperties.MediaEncodingProfile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.RenderToFileAsync + +## -description +Asynchronously renders the [MediaComposition](mediacomposition.md) to a specified file using the indicated media trimming preference and encoding profile. + +## -parameters +### -param destination +The file to which this [MediaComposition](mediacomposition.md) is rendered. + +### -param trimmingPreference +Specifies whether to be fast or precise when trimming the media. + +### -param encodingProfile +Specifies the encoding profile to use for rendering the media. + +## -returns +An async operation which can be used to track the success or failure of the operation. + +## -remarks +This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use [SaveAsync](mediacomposition_saveasync.md). + +## -examples + +## -see-also +[RenderToFileAsync(IStorageFile)](mediacomposition_rendertofileasync_1970129585.md), [RenderToFileAsync(IStorageFile, MediaTrimmingPreference)](mediacomposition_rendertofileasync_1125216263.md) \ No newline at end of file diff --git a/windows.media.editing/mediacomposition_rendertofileasync_1970129585.md b/windows.media.editing/mediacomposition_rendertofileasync_1970129585.md index f20cfa7f81..d25c0b16e8 100644 --- a/windows.media.editing/mediacomposition_rendertofileasync_1970129585.md +++ b/windows.media.editing/mediacomposition_rendertofileasync_1970129585.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.RenderToFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.RenderToFileAsync ## -description Asynchronously renders the [MediaComposition](mediacomposition.md) to the specified file. ## -parameters ### -param destination The file to which this [MediaComposition](mediacomposition.md) is rendered. ## -returns An async operation which can be used to track the success or failure of the operation. ## -remarks This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use [SaveAsync](mediacomposition_saveasync.md). ## -examples ## -see-also [RenderToFileAsync(IStorageFile, MediaTrimmingPreference)](mediacomposition_rendertofileasync_1125216263.md), [RenderToFileAsync(IStorageFile, MediaTrimmingPreference, MediaEncodingProfile)](mediacomposition_rendertofileasync_1565341453.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.RenderToFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.RenderToFileAsync + +## -description +Asynchronously renders the [MediaComposition](mediacomposition.md) to the specified file. + +## -parameters +### -param destination +The file to which this [MediaComposition](mediacomposition.md) is rendered. + +## -returns +An async operation which can be used to track the success or failure of the operation. + +## -remarks +This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use [SaveAsync](mediacomposition_saveasync.md). + +## -examples + +## -see-also +[RenderToFileAsync(IStorageFile, MediaTrimmingPreference)](mediacomposition_rendertofileasync_1125216263.md), [RenderToFileAsync(IStorageFile, MediaTrimmingPreference, MediaEncodingProfile)](mediacomposition_rendertofileasync_1565341453.md) \ No newline at end of file diff --git a/windows.media.editing/mediacomposition_saveasync_389603876.md b/windows.media.editing/mediacomposition_saveasync_389603876.md index 4459c97d01..d1b48b554c 100644 --- a/windows.media.editing/mediacomposition_saveasync_389603876.md +++ b/windows.media.editing/mediacomposition_saveasync_389603876.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Editing.MediaComposition.SaveAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Editing.MediaComposition.SaveAsync ## -description Asynchronously serializes the [MediaComposition](mediacomposition.md) to disk so that it can be loaded and modified in the future. ## -parameters ### -param file The file to which the [MediaComposition](mediacomposition.md) is saved. ## -returns An async action which can be used to track the success or failure of the operation. ## -remarks This method saves the composition as an XML file containing metadata about the composition such as the source media files, arrangement of clips, overlays, and effects applied to the composition. A new media composition can be created from the saved XML file by calling [LoadAsync](mediacomposition_loadasync.md). To render a media composition as a video file so that it can be played back by standard media players, use the [RenderToFileAsync](mediacomposition_rendertofileasync.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaComposition.SaveAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaComposition.SaveAsync + +## -description +Asynchronously serializes the [MediaComposition](mediacomposition.md) to disk so that it can be loaded and modified in the future. + +## -parameters +### -param file +The file to which the [MediaComposition](mediacomposition.md) is saved. + +## -returns +An async action which can be used to track the success or failure of the operation. + +## -remarks +This method saves the composition as an XML file containing metadata about the composition such as the source media files, arrangement of clips, overlays, and effects applied to the composition. A new media composition can be created from the saved XML file by calling [LoadAsync](mediacomposition_loadasync.md). + +To render a media composition as a video file so that it can be played back by standard media players, use the [RenderToFileAsync](mediacomposition_rendertofileasync.md) method. + +## -examples + +## -see-also diff --git a/windows.media.editing/mediacomposition_userdata.md b/windows.media.editing/mediacomposition_userdata.md index 615f1ab544..9b8c1da032 100644 --- a/windows.media.editing/mediacomposition_userdata.md +++ b/windows.media.editing/mediacomposition_userdata.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaComposition.UserData --api-type: winrt property ---- # Windows.Media.Editing.MediaComposition.UserData ## -description An associative collection for storing custom properties associated with the media composition. ## -property-value The values stored in the [IMap](../windows.foundation.collections/imap_2.md) must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a description of the media composition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaComposition.UserData +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaComposition.UserData + +## -description +An associative collection for storing custom properties associated with the media composition. + +## -property-value +The values stored in the [IMap](../windows.foundation.collections/imap_2.md) must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a description of the media composition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay.md b/windows.media.editing/mediaoverlay.md index f86184177e..b67774d3a8 100644 --- a/windows.media.editing/mediaoverlay.md +++ b/windows.media.editing/mediaoverlay.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Editing.MediaOverlay --api-type: winrt class ---- # Windows.Media.Editing.MediaOverlay ## -description Represents an overlay that can be used in a media composition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Editing.MediaOverlay +-api-type: winrt class +--- + + + +# Windows.Media.Editing.MediaOverlay + +## -description +Represents an overlay that can be used in a media composition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay_audioenabled.md b/windows.media.editing/mediaoverlay_audioenabled.md index 96a18d2b5f..fe1b230d96 100644 --- a/windows.media.editing/mediaoverlay_audioenabled.md +++ b/windows.media.editing/mediaoverlay_audioenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlay.AudioEnabled --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlay.AudioEnabled ## -description Gets or sets a value indicating whether audio is enabled for the [MediaOverlay](mediaoverlay.md). ## -property-value True if audio is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlay.AudioEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlay.AudioEnabled + +## -description +Gets or sets a value indicating whether audio is enabled for the [MediaOverlay](mediaoverlay.md). + +## -property-value +True if audio is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay_clip.md b/windows.media.editing/mediaoverlay_clip.md index d0ec33c11a..acd7cf928f 100644 --- a/windows.media.editing/mediaoverlay_clip.md +++ b/windows.media.editing/mediaoverlay_clip.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlay.Clip --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlay.Clip ## -description Gets the media clip to be used for the overlay. ## -property-value The media clip to be used for the overlay. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlay.Clip +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlay.Clip + +## -description +Gets the media clip to be used for the overlay. + +## -property-value +The media clip to be used for the overlay. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay_clone_766852569.md b/windows.media.editing/mediaoverlay_clone_766852569.md index 5d567d1408..9367b1a633 100644 --- a/windows.media.editing/mediaoverlay_clone_766852569.md +++ b/windows.media.editing/mediaoverlay_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.MediaOverlay.Clone --api-type: winrt method ---- # Windows.Media.Editing.MediaOverlay.Clone ## -description Creates a [MediaOverlay](mediaoverlay.md) object that is identical to this instance. ## -returns A [MediaOverlay](mediaoverlay.md) object that is a copy of this instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaOverlay.Clone +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaOverlay.Clone + +## -description +Creates a [MediaOverlay](mediaoverlay.md) object that is identical to this instance. + +## -returns +A [MediaOverlay](mediaoverlay.md) object that is a copy of this instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay_delay.md b/windows.media.editing/mediaoverlay_delay.md index 57cd570d7d..4037f2ba60 100644 --- a/windows.media.editing/mediaoverlay_delay.md +++ b/windows.media.editing/mediaoverlay_delay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlay.Delay --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlay.Delay ## -description Gets or sets the time span from the start of the clip after which the media overlay should be rendered. ## -property-value The time span from the start of the clip after which the media overlay should be rendered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlay.Delay +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlay.Delay + +## -description +Gets or sets the time span from the start of the clip after which the media overlay should be rendered. + +## -property-value +The time span from the start of the clip after which the media overlay should be rendered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay_mediaoverlay_611005311.md b/windows.media.editing/mediaoverlay_mediaoverlay_611005311.md index 1af1f80a42..d853662712 100644 --- a/windows.media.editing/mediaoverlay_mediaoverlay_611005311.md +++ b/windows.media.editing/mediaoverlay_mediaoverlay_611005311.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Editing.MediaOverlay.#ctor(Windows.Media.Editing.MediaClip) --api-type: winrt method ---- # Windows.Media.Editing.MediaOverlay.MediaOverlay ## -description Initializes a new instance of the [MediaOverlay](mediaoverlay.md) class. ## -parameters ### -param clip The media clip to be used for the overlay. ## -remarks ## -examples ## -see-also [MediaOverlay(MediaClip, Rect, Double)](mediaoverlay_mediaoverlay_979486019.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaOverlay.#ctor(Windows.Media.Editing.MediaClip) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaOverlay.MediaOverlay + +## -description +Initializes a new instance of the [MediaOverlay](mediaoverlay.md) class. + +## -parameters +### -param clip +The media clip to be used for the overlay. + +## -remarks + +## -examples + +## -see-also +[MediaOverlay(MediaClip, Rect, Double)](mediaoverlay_mediaoverlay_979486019.md) \ No newline at end of file diff --git a/windows.media.editing/mediaoverlay_mediaoverlay_979486019.md b/windows.media.editing/mediaoverlay_mediaoverlay_979486019.md index 63b72ec127..238ca1dbb8 100644 --- a/windows.media.editing/mediaoverlay_mediaoverlay_979486019.md +++ b/windows.media.editing/mediaoverlay_mediaoverlay_979486019.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Editing.MediaOverlay.#ctor(Windows.Media.Editing.MediaClip,Windows.Foundation.Rect,System.Double) --api-type: winrt method ---- # Windows.Media.Editing.MediaOverlay.MediaOverlay ## -description Initializes a new instance of the [MediaOverlay](mediaoverlay.md) class. ## -parameters ### -param clip The media clip to be used for the overlay. ### -param position The position of the overlay. ### -param opacity The opacity of the overlay, in the range of 0.0 to 1.0, where 0.0 is completely transparent and 1.0 is completely opaque. ## -remarks ## -examples ## -see-also [MediaOverlay(MediaClip)](mediaoverlay_mediaoverlay_611005311.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaOverlay.#ctor(Windows.Media.Editing.MediaClip,Windows.Foundation.Rect,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaOverlay.MediaOverlay + +## -description +Initializes a new instance of the [MediaOverlay](mediaoverlay.md) class. + +## -parameters +### -param clip +The media clip to be used for the overlay. + +### -param position +The position of the overlay. + +### -param opacity +The opacity of the overlay, in the range of 0.0 to 1.0, where 0.0 is completely transparent and 1.0 is completely opaque. + +## -remarks + +## -examples + +## -see-also +[MediaOverlay(MediaClip)](mediaoverlay_mediaoverlay_611005311.md) \ No newline at end of file diff --git a/windows.media.editing/mediaoverlay_opacity.md b/windows.media.editing/mediaoverlay_opacity.md index d479ba7f3f..d5e852bc61 100644 --- a/windows.media.editing/mediaoverlay_opacity.md +++ b/windows.media.editing/mediaoverlay_opacity.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlay.Opacity --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlay.Opacity ## -description Gets the opacity of the overlay. ## -property-value The opacity of the overlay, in the range of 0.0 to 1.0, where 0.0 is completely transparent and 1.0 is completely opaque. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlay.Opacity +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlay.Opacity + +## -description +Gets the opacity of the overlay. + +## -property-value +The opacity of the overlay, in the range of 0.0 to 1.0, where 0.0 is completely transparent and 1.0 is completely opaque. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlay_position.md b/windows.media.editing/mediaoverlay_position.md index d3132727f8..e12f47e387 100644 --- a/windows.media.editing/mediaoverlay_position.md +++ b/windows.media.editing/mediaoverlay_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlay.Position --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlay.Position ## -description Gets the position of the overlay. ## -property-value The position of the overlay. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlay.Position +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlay.Position + +## -description +Gets the position of the overlay. + +## -property-value +The position of the overlay. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlaylayer.md b/windows.media.editing/mediaoverlaylayer.md index 6186c837b7..763ebcb557 100644 --- a/windows.media.editing/mediaoverlaylayer.md +++ b/windows.media.editing/mediaoverlaylayer.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Editing.MediaOverlayLayer --api-type: winrt class ---- # Windows.Media.Editing.MediaOverlayLayer ## -description Represents a layer of a media overlay. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Editing.MediaOverlayLayer +-api-type: winrt class +--- + + + +# Windows.Media.Editing.MediaOverlayLayer + +## -description +Represents a layer of a media overlay. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlaylayer_clone_766852569.md b/windows.media.editing/mediaoverlaylayer_clone_766852569.md index 41c6d9ea54..290b426e5c 100644 --- a/windows.media.editing/mediaoverlaylayer_clone_766852569.md +++ b/windows.media.editing/mediaoverlaylayer_clone_766852569.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Editing.MediaOverlayLayer.Clone --api-type: winrt method ---- # Windows.Media.Editing.MediaOverlayLayer.Clone ## -description Creates a [MediaOverlayLayer](mediaoverlaylayer.md) object that is identical to this instance. ## -returns A [MediaOverlayLayer](mediaoverlaylayer.md) object that is a copy of this instance. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaOverlayLayer.Clone +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaOverlayLayer.Clone + +## -description +Creates a [MediaOverlayLayer](mediaoverlaylayer.md) object that is identical to this instance. + +## -returns +A [MediaOverlayLayer](mediaoverlaylayer.md) object that is a copy of this instance. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlaylayer_customcompositordefinition.md b/windows.media.editing/mediaoverlaylayer_customcompositordefinition.md index 31c6ae73f8..7ccfad4d0f 100644 --- a/windows.media.editing/mediaoverlaylayer_customcompositordefinition.md +++ b/windows.media.editing/mediaoverlaylayer_customcompositordefinition.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlayLayer.CustomCompositorDefinition --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlayLayer.CustomCompositorDefinition ## -description Gets the definition of the custom compositor associated with the media overlay layer, if there is one. ## -property-value The definition of the custom compositor associated with the media overlay layer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlayLayer.CustomCompositorDefinition +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlayLayer.CustomCompositorDefinition + +## -description +Gets the definition of the custom compositor associated with the media overlay layer, if there is one. + +## -property-value +The definition of the custom compositor associated with the media overlay layer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_1221375020.md b/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_1221375020.md index 5e0c1f627a..533273b506 100644 --- a/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_1221375020.md +++ b/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_1221375020.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Editing.MediaOverlayLayer.#ctor --api-type: winrt method ---- # Windows.Media.Editing.MediaOverlayLayer.MediaOverlayLayer ## -description Initializes a new instance of the [MediaOverlayLayer](mediaoverlaylayer.md) class. ## -remarks ## -examples ## -see-also [MediaOverlayLayer(IVideoCompositorDefinition)](mediaoverlaylayer_mediaoverlaylayer_467788921.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaOverlayLayer.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaOverlayLayer.MediaOverlayLayer + +## -description +Initializes a new instance of the [MediaOverlayLayer](mediaoverlaylayer.md) class. + +## -remarks + +## -examples + +## -see-also +[MediaOverlayLayer(IVideoCompositorDefinition)](mediaoverlaylayer_mediaoverlaylayer_467788921.md) \ No newline at end of file diff --git a/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_467788921.md b/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_467788921.md index 3956ca3313..42fbfb07ca 100644 --- a/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_467788921.md +++ b/windows.media.editing/mediaoverlaylayer_mediaoverlaylayer_467788921.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Editing.MediaOverlayLayer.#ctor(Windows.Media.Effects.IVideoCompositorDefinition) --api-type: winrt method ---- # Windows.Media.Editing.MediaOverlayLayer.MediaOverlayLayer ## -description Initializes a new instance of the [MediaOverlayLayer](mediaoverlaylayer.md) class. ## -parameters ### -param compositorDefinition The definition of the custom compositor associated with the media overlay layer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Editing.MediaOverlayLayer.#ctor(Windows.Media.Effects.IVideoCompositorDefinition) +-api-type: winrt method +--- + + + +# Windows.Media.Editing.MediaOverlayLayer.MediaOverlayLayer + +## -description +Initializes a new instance of the [MediaOverlayLayer](mediaoverlaylayer.md) class. + +## -parameters +### -param compositorDefinition +The definition of the custom compositor associated with the media overlay layer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.editing/mediaoverlaylayer_overlays.md b/windows.media.editing/mediaoverlaylayer_overlays.md index 125eacd313..e9dd490978 100644 --- a/windows.media.editing/mediaoverlaylayer_overlays.md +++ b/windows.media.editing/mediaoverlaylayer_overlays.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Editing.MediaOverlayLayer.Overlays --api-type: winrt property ---- # Windows.Media.Editing.MediaOverlayLayer.Overlays ## -description Gets the list of overlays for this media overlay layer. ## -property-value The list of overlays for this media overlay layer. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Editing.MediaOverlayLayer.Overlays +-api-type: winrt property +--- + + + +# Windows.Media.Editing.MediaOverlayLayer.Overlays + +## -description +Gets the list of overlays for this media overlay layer. + +## -property-value +The list of overlays for this media overlay layer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audiocaptureeffectsmanager.md b/windows.media.effects/audiocaptureeffectsmanager.md index e63789b7ad..8c2e4d2e89 100644 --- a/windows.media.effects/audiocaptureeffectsmanager.md +++ b/windows.media.effects/audiocaptureeffectsmanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Effects.AudioCaptureEffectsManager --api-type: winrt class ---- # Windows.Media.Effects.AudioCaptureEffectsManager ## -description Represent an audio capture effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode. ## -remarks To create an instance of [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md), call [AudioEffectsManager.CreateAudioCaptureEffectsManager](audioeffectsmanager_createaudiocaptureeffectsmanager.md). See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. ## -examples ## -see-also [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.AudioCaptureEffectsManager +-api-type: winrt class +--- + + + +# Windows.Media.Effects.AudioCaptureEffectsManager + +## -description +Represent an audio capture effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode. + +## -remarks +To create an instance of [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md), call [AudioEffectsManager.CreateAudioCaptureEffectsManager](audioeffectsmanager_createaudiocaptureeffectsmanager.md). + +See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. + +## -examples + +## -see-also +[Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file diff --git a/windows.media.effects/audiocaptureeffectsmanager_audiocaptureeffectschanged.md b/windows.media.effects/audiocaptureeffectsmanager_audiocaptureeffectschanged.md index 444e23af74..5ff09cf508 100644 --- a/windows.media.effects/audiocaptureeffectsmanager_audiocaptureeffectschanged.md +++ b/windows.media.effects/audiocaptureeffectsmanager_audiocaptureeffectschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Effects.AudioCaptureEffectsManager.AudioCaptureEffectsChanged --api-type: winrt event ---- # Windows.Media.Effects.AudioCaptureEffectsManager.AudioCaptureEffectsChanged ## -description Occurs when audio process chain changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Effects.AudioCaptureEffectsManager.AudioCaptureEffectsChanged +-api-type: winrt event +--- + + + +# Windows.Media.Effects.AudioCaptureEffectsManager.AudioCaptureEffectsChanged + +## -description +Occurs when audio process chain changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audiocaptureeffectsmanager_getaudiocaptureeffects_1705960470.md b/windows.media.effects/audiocaptureeffectsmanager_getaudiocaptureeffects_1705960470.md index d765da75cd..1ae428349d 100644 --- a/windows.media.effects/audiocaptureeffectsmanager_getaudiocaptureeffects_1705960470.md +++ b/windows.media.effects/audiocaptureeffectsmanager_getaudiocaptureeffects_1705960470.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Effects.AudioCaptureEffectsManager.GetAudioCaptureEffects --api-type: winrt method ---- # Windows.Media.Effects.AudioCaptureEffectsManager.GetAudioCaptureEffects ## -description Gets the list of audio effects on the device. ## -returns The list of audio effects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioCaptureEffectsManager.GetAudioCaptureEffects +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioCaptureEffectsManager.GetAudioCaptureEffects + +## -description +Gets the list of audio effects on the device. + +## -returns +The list of audio effects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audioeffect.md b/windows.media.effects/audioeffect.md index 0d7eee077c..aad80b4d78 100644 --- a/windows.media.effects/audioeffect.md +++ b/windows.media.effects/audioeffect.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Effects.AudioEffect --api-type: winrt class ---- # Windows.Media.Effects.AudioEffect ## -description Represents an audio effect. ## -remarks The [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md) and [AudioRenderEffectsManager](audiorendereffectsmanager.md) classes can be used to discovery the audio processing chain on a device. See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. ## -examples ## -see-also [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md), [AudioRenderEffectsManager](audiorendereffectsmanager.md), [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.AudioEffect +-api-type: winrt class +--- + + + +# Windows.Media.Effects.AudioEffect + +## -description +Represents an audio effect. + +## -remarks +The [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md) and [AudioRenderEffectsManager](audiorendereffectsmanager.md) classes can be used to discovery the audio processing chain on a device. + +See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. + +## -examples + +## -see-also +[AudioCaptureEffectsManager](audiocaptureeffectsmanager.md), [AudioRenderEffectsManager](audiorendereffectsmanager.md), [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file diff --git a/windows.media.effects/audioeffect_audioeffecttype.md b/windows.media.effects/audioeffect_audioeffecttype.md index a35ee99fac..77d11e81f5 100644 --- a/windows.media.effects/audioeffect_audioeffecttype.md +++ b/windows.media.effects/audioeffect_audioeffecttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.AudioEffect.AudioEffectType --api-type: winrt property ---- # Windows.Media.Effects.AudioEffect.AudioEffectType ## -description Gets the type of the audio effect. ## -property-value The type of the audio effect ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.AudioEffect.AudioEffectType +-api-type: winrt property +--- + + + +# Windows.Media.Effects.AudioEffect.AudioEffectType + +## -description +Gets the type of the audio effect. + +## -property-value +The type of the audio effect + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audioeffectdefinition.md b/windows.media.effects/audioeffectdefinition.md index 0cd3cfe0b1..0fa77f637f 100644 --- a/windows.media.effects/audioeffectdefinition.md +++ b/windows.media.effects/audioeffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Effects.AudioEffectDefinition --api-type: winrt class ---- # Windows.Media.Effects.AudioEffectDefinition ## -description Represents an audio effect definition. ## -remarks ## -examples ## -see-also [IAudioEffectDefinition](iaudioeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.AudioEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Effects.AudioEffectDefinition + +## -description +Represents an audio effect definition. + +## -remarks + +## -examples + +## -see-also +[IAudioEffectDefinition](iaudioeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.effects/audioeffectdefinition_activatableclassid.md b/windows.media.effects/audioeffectdefinition_activatableclassid.md index 1752c91bbb..57cf318e11 100644 --- a/windows.media.effects/audioeffectdefinition_activatableclassid.md +++ b/windows.media.effects/audioeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.AudioEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.AudioEffectDefinition.ActivatableClassId ## -description The activatable class ID of the audio effect definition. ## -property-value The activatable class ID of the audio effect definition, such as "AudioClipEffect". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.AudioEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.AudioEffectDefinition.ActivatableClassId + +## -description +The activatable class ID of the audio effect definition. + +## -property-value +The activatable class ID of the audio effect definition, such as "AudioClipEffect". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audioeffectdefinition_audioeffectdefinition_1860087994.md b/windows.media.effects/audioeffectdefinition_audioeffectdefinition_1860087994.md index 395ed8ca94..c57d30ef22 100644 --- a/windows.media.effects/audioeffectdefinition_audioeffectdefinition_1860087994.md +++ b/windows.media.effects/audioeffectdefinition_audioeffectdefinition_1860087994.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Effects.AudioEffectDefinition.#ctor(System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Effects.AudioEffectDefinition.AudioEffectDefinition ## -description Creates a new [AudioEffectDefinition](audioeffectdefinition.md) object with the specified activatable class ID, configuring the object with the specified settings. ## -parameters ### -param activatableClassId The activatable class ID of the audio effect definition. ### -param props Configuration properties for the specified audio effect definition. ## -remarks ## -examples ## -see-also [AudioEffectDefinition(String)](audioeffectdefinition_audioeffectdefinition_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioEffectDefinition.#ctor(System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioEffectDefinition.AudioEffectDefinition + +## -description +Creates a new [AudioEffectDefinition](audioeffectdefinition.md) object with the specified activatable class ID, configuring the object with the specified settings. + +## -parameters +### -param activatableClassId +The activatable class ID of the audio effect definition. + +### -param props +Configuration properties for the specified audio effect definition. + +## -remarks + +## -examples + +## -see-also +[AudioEffectDefinition(String)](audioeffectdefinition_audioeffectdefinition_290278668.md) \ No newline at end of file diff --git a/windows.media.effects/audioeffectdefinition_audioeffectdefinition_290278668.md b/windows.media.effects/audioeffectdefinition_audioeffectdefinition_290278668.md index e175ae7459..dad5047610 100644 --- a/windows.media.effects/audioeffectdefinition_audioeffectdefinition_290278668.md +++ b/windows.media.effects/audioeffectdefinition_audioeffectdefinition_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Effects.AudioEffectDefinition.#ctor(System.String) --api-type: winrt method ---- # Windows.Media.Effects.AudioEffectDefinition.AudioEffectDefinition ## -description Creates a new [AudioEffectDefinition](audioeffectdefinition.md) object with the specified activatable class ID. ## -parameters ### -param activatableClassId The activatable class ID of the audio effect definition. ## -remarks ## -examples ## -see-also [AudioEffectDefinition(String, IPropertySet)](audioeffectdefinition_audioeffectdefinition_1860087994.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioEffectDefinition.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioEffectDefinition.AudioEffectDefinition + +## -description +Creates a new [AudioEffectDefinition](audioeffectdefinition.md) object with the specified activatable class ID. + +## -parameters +### -param activatableClassId +The activatable class ID of the audio effect definition. + +## -remarks + +## -examples + +## -see-also +[AudioEffectDefinition(String, IPropertySet)](audioeffectdefinition_audioeffectdefinition_1860087994.md) \ No newline at end of file diff --git a/windows.media.effects/audioeffectdefinition_properties.md b/windows.media.effects/audioeffectdefinition_properties.md index c34778fa0c..e2ee3e75ac 100644 --- a/windows.media.effects/audioeffectdefinition_properties.md +++ b/windows.media.effects/audioeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.AudioEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.AudioEffectDefinition.Properties ## -description The set of properties for configuring an [AudioEffectDefinition](audioeffectdefinition.md) object. ## -property-value The set of properties for the audio effect definition, represented as tuples. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.AudioEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.AudioEffectDefinition.Properties + +## -description +The set of properties for configuring an [AudioEffectDefinition](audioeffectdefinition.md) object. + +## -property-value +The set of properties for the audio effect definition, represented as tuples. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audioeffectsmanager.md b/windows.media.effects/audioeffectsmanager.md index 10a0e11729..ffb92bc149 100644 --- a/windows.media.effects/audioeffectsmanager.md +++ b/windows.media.effects/audioeffectsmanager.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Effects.AudioEffectsManager --api-type: winrt class ---- # Windows.Media.Effects.AudioEffectsManager ## -description Provides functionality for creating audio capture and render effects manager objects. ## -remarks See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. ## -examples ## -see-also [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md), [AudioRenderEffectsManager](audiorendereffectsmanager.md), [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.AudioEffectsManager +-api-type: winrt class +--- + + + +# Windows.Media.Effects.AudioEffectsManager + +## -description +Provides functionality for creating audio capture and render effects manager objects. + +## -remarks +See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. + +## -examples + +## -see-also +[AudioCaptureEffectsManager](audiocaptureeffectsmanager.md), [AudioRenderEffectsManager](audiorendereffectsmanager.md), [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file diff --git a/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md b/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md index 4ad7e309dc..9299a99a19 100644 --- a/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md +++ b/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager(System.String,Windows.Media.Capture.MediaCategory) --api-type: winrt method ---- # Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager ## -description Creates a [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md) object for the specified device for a specific media category. ## -parameters ### -param deviceId The device id. ### -param category The media category. ## -returns The new audio capture effects manager. ## -remarks ## -examples ## -see-also [CreateAudioCaptureEffectsManager(String, MediaCategory, AudioProcessing)](audioeffectsmanager_createaudiocaptureeffectsmanager_547631086.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager(System.String,Windows.Media.Capture.MediaCategory) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager + +## -description +Creates a [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md) object for the specified device for a specific media category. + +## -parameters +### -param deviceId +The device id. + +### -param category +The media category. + +## -returns +The new audio capture effects manager. + +## -remarks + +## -examples + +## -see-also +[CreateAudioCaptureEffectsManager(String, MediaCategory, AudioProcessing)](audioeffectsmanager_createaudiocaptureeffectsmanager_547631086.md) \ No newline at end of file diff --git a/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_547631086.md b/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_547631086.md index cccd9e96dd..d19170cbf5 100644 --- a/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_547631086.md +++ b/windows.media.effects/audioeffectsmanager_createaudiocaptureeffectsmanager_547631086.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager(System.String,Windows.Media.Capture.MediaCategory,Windows.Media.AudioProcessing) --api-type: winrt method ---- # Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager ## -description Creates a [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md) object for the specified device for a specific media category and audio processing mode. ## -parameters ### -param deviceId The device id. ### -param category The media category. ### -param mode The audio processing mode. ## -returns The new audio capture effects manager. ## -remarks ## -examples ## -see-also [CreateAudioCaptureEffectsManager(String, MediaCategory)](audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager(System.String,Windows.Media.Capture.MediaCategory,Windows.Media.AudioProcessing) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioEffectsManager.CreateAudioCaptureEffectsManager + +## -description +Creates a [AudioCaptureEffectsManager](audiocaptureeffectsmanager.md) object for the specified device for a specific media category and audio processing mode. + +## -parameters +### -param deviceId +The device id. + +### -param category +The media category. + +### -param mode +The audio processing mode. + +## -returns +The new audio capture effects manager. + +## -remarks + +## -examples + +## -see-also +[CreateAudioCaptureEffectsManager(String, MediaCategory)](audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md) \ No newline at end of file diff --git a/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1253909866.md b/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1253909866.md index 1a7cdc9bdc..20b87248e9 100644 --- a/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1253909866.md +++ b/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1253909866.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager(System.String,Windows.Media.Render.AudioRenderCategory,Windows.Media.AudioProcessing) --api-type: winrt method ---- # Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager ## -description Creates a [AudioRenderEffectsManager](audiorendereffectsmanager.md) object for the specified device for a specific media category. ## -parameters ### -param deviceId The device id. ### -param category The audio render category. ### -param mode The audio precessing mode. ## -returns The new audio render effects manager. ## -remarks ## -examples ## -see-also [CreateAudioRenderEffectsManager(String, AudioRenderCategory)](audioeffectsmanager_createaudiorendereffectsmanager_1473939434.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager(System.String,Windows.Media.Render.AudioRenderCategory,Windows.Media.AudioProcessing) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager + +## -description +Creates a [AudioRenderEffectsManager](audiorendereffectsmanager.md) object for the specified device for a specific media category. + +## -parameters +### -param deviceId +The device id. + +### -param category +The audio render category. + +### -param mode +The audio precessing mode. + +## -returns +The new audio render effects manager. + +## -remarks + +## -examples + +## -see-also +[CreateAudioRenderEffectsManager(String, AudioRenderCategory)](audioeffectsmanager_createaudiorendereffectsmanager_1473939434.md) \ No newline at end of file diff --git a/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1473939434.md b/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1473939434.md index 07e23f89a8..2a223c9e39 100644 --- a/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1473939434.md +++ b/windows.media.effects/audioeffectsmanager_createaudiorendereffectsmanager_1473939434.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager(System.String,Windows.Media.Render.AudioRenderCategory) --api-type: winrt method ---- # Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager ## -description Creates a [AudioRenderEffectsManager](audiorendereffectsmanager.md) object for the specified device for a specific media category and audio processing mode. ## -parameters ### -param deviceId The device id. ### -param category The audio render category. ## -returns The new audio render effects manager. ## -remarks ## -examples ## -see-also [CreateAudioRenderEffectsManager(String, AudioRenderCategory, AudioProcessing)](audioeffectsmanager_createaudiorendereffectsmanager_1253909866.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager(System.String,Windows.Media.Render.AudioRenderCategory) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioEffectsManager.CreateAudioRenderEffectsManager + +## -description +Creates a [AudioRenderEffectsManager](audiorendereffectsmanager.md) object for the specified device for a specific media category and audio processing mode. + +## -parameters +### -param deviceId +The device id. + +### -param category +The audio render category. + +## -returns +The new audio render effects manager. + +## -remarks + +## -examples + +## -see-also +[CreateAudioRenderEffectsManager(String, AudioRenderCategory, AudioProcessing)](audioeffectsmanager_createaudiorendereffectsmanager_1253909866.md) \ No newline at end of file diff --git a/windows.media.effects/audiorendereffectsmanager.md b/windows.media.effects/audiorendereffectsmanager.md index ef24171ab9..48518d084e 100644 --- a/windows.media.effects/audiorendereffectsmanager.md +++ b/windows.media.effects/audiorendereffectsmanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Effects.AudioRenderEffectsManager --api-type: winrt class ---- # Windows.Media.Effects.AudioRenderEffectsManager ## -description Represent an audio render effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode. ## -remarks To create an instance of [AudioRenderEffectsManager](audiorendereffectsmanager.md), call [AudioEffectsManager.CreateAudioRenderEffectsManager](audioeffectsmanager_createaudiorendereffectsmanager.md). See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. ## -examples ## -see-also [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.AudioRenderEffectsManager +-api-type: winrt class +--- + + + +# Windows.Media.Effects.AudioRenderEffectsManager + +## -description +Represent an audio render effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode. + +## -remarks +To create an instance of [AudioRenderEffectsManager](audiorendereffectsmanager.md), call [AudioEffectsManager.CreateAudioRenderEffectsManager](audioeffectsmanager_createaudiorendereffectsmanager.md). + +See the [Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) for an example of how to query and monitor audio effects on render and capture audio devices. + +## -examples + +## -see-also +[Audio effects discovery sample](http://go.microsoft.com/fwlink/p/?LinkID=309019) \ No newline at end of file diff --git a/windows.media.effects/audiorendereffectsmanager_audiorendereffectschanged.md b/windows.media.effects/audiorendereffectsmanager_audiorendereffectschanged.md index 2950d42255..da716fc502 100644 --- a/windows.media.effects/audiorendereffectsmanager_audiorendereffectschanged.md +++ b/windows.media.effects/audiorendereffectsmanager_audiorendereffectschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Effects.AudioRenderEffectsManager.AudioRenderEffectsChanged --api-type: winrt event ---- # Windows.Media.Effects.AudioRenderEffectsManager.AudioRenderEffectsChanged ## -description Occurs when audio process chain changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Effects.AudioRenderEffectsManager.AudioRenderEffectsChanged +-api-type: winrt event +--- + + + +# Windows.Media.Effects.AudioRenderEffectsManager.AudioRenderEffectsChanged + +## -description +Occurs when audio process chain changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audiorendereffectsmanager_effectsprovidersettingslabel.md b/windows.media.effects/audiorendereffectsmanager_effectsprovidersettingslabel.md index fabaab17cf..a089256d83 100644 --- a/windows.media.effects/audiorendereffectsmanager_effectsprovidersettingslabel.md +++ b/windows.media.effects/audiorendereffectsmanager_effectsprovidersettingslabel.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderSettingsLabel --api-type: winrt property ---- # Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderSettingsLabel ## -description Gets the label that is associated with this audio effects provider setting. ## -property-value The string to use as the label for the audio effects provider setting. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderSettingsLabel +-api-type: winrt property +--- + + + +# Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderSettingsLabel + +## -description +Gets the label that is associated with this audio effects provider setting. + +## -property-value +The string to use as the label for the audio effects provider setting. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audiorendereffectsmanager_effectsproviderthumbnail.md b/windows.media.effects/audiorendereffectsmanager_effectsproviderthumbnail.md index 6c03318a0e..ac5f620f03 100644 --- a/windows.media.effects/audiorendereffectsmanager_effectsproviderthumbnail.md +++ b/windows.media.effects/audiorendereffectsmanager_effectsproviderthumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderThumbnail --api-type: winrt property ---- # Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderThumbnail ## -description Gets the thumbnail image that is associated with this audio effects provider. ## -property-value The thumbnail image for the audio effects provider. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderThumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Effects.AudioRenderEffectsManager.EffectsProviderThumbnail + +## -description +Gets the thumbnail image that is associated with this audio effects provider. + +## -property-value +The thumbnail image for the audio effects provider. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audiorendereffectsmanager_getaudiorendereffects_1397434667.md b/windows.media.effects/audiorendereffectsmanager_getaudiorendereffects_1397434667.md index 22f3a172e8..5b86afc2dd 100644 --- a/windows.media.effects/audiorendereffectsmanager_getaudiorendereffects_1397434667.md +++ b/windows.media.effects/audiorendereffectsmanager_getaudiorendereffects_1397434667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Effects.AudioRenderEffectsManager.GetAudioRenderEffects --api-type: winrt method ---- # Windows.Media.Effects.AudioRenderEffectsManager.GetAudioRenderEffects ## -description Gets the list of audio effects on the device. ## -returns The list of audio effects. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioRenderEffectsManager.GetAudioRenderEffects +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioRenderEffectsManager.GetAudioRenderEffects + +## -description +Gets the list of audio effects on the device. + +## -returns +The list of audio effects. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/audiorendereffectsmanager_showsettingsui_1864483038.md b/windows.media.effects/audiorendereffectsmanager_showsettingsui_1864483038.md index 39c7049f7c..8583fb8555 100644 --- a/windows.media.effects/audiorendereffectsmanager_showsettingsui_1864483038.md +++ b/windows.media.effects/audiorendereffectsmanager_showsettingsui_1864483038.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Effects.AudioRenderEffectsManager.ShowSettingsUI --api-type: winrt method ---- # Windows.Media.Effects.AudioRenderEffectsManager.ShowSettingsUI ## -description Displays the audio effect settings page. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.AudioRenderEffectsManager.ShowSettingsUI +-api-type: winrt method +--- + + + +# Windows.Media.Effects.AudioRenderEffectsManager.ShowSettingsUI + +## -description +Displays the audio effect settings page. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/compositevideoframecontext.md b/windows.media.effects/compositevideoframecontext.md index 9dc035710b..5a00a5d898 100644 --- a/windows.media.effects/compositevideoframecontext.md +++ b/windows.media.effects/compositevideoframecontext.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Effects.CompositeVideoFrameContext --api-type: winrt class ---- # Windows.Media.Effects.CompositeVideoFrameContext ## -description Provides context for performing a custom overlay operation within the [CompositeFrame](ivideocompositor_compositeframe.md) method. ## -remarks To retrieve an instance of this class, implement the [CompositeFrame](ivideocompositor_compositeframe.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.CompositeVideoFrameContext +-api-type: winrt class +--- + + + +# Windows.Media.Effects.CompositeVideoFrameContext + +## -description +Provides context for performing a custom overlay operation within the [CompositeFrame](ivideocompositor_compositeframe.md) method. + +## -remarks +To retrieve an instance of this class, implement the [CompositeFrame](ivideocompositor_compositeframe.md) method. + +## -examples + +## -see-also diff --git a/windows.media.effects/compositevideoframecontext_backgroundframe.md b/windows.media.effects/compositevideoframecontext_backgroundframe.md index 414d90919c..464330ce0a 100644 --- a/windows.media.effects/compositevideoframecontext_backgroundframe.md +++ b/windows.media.effects/compositevideoframecontext_backgroundframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.CompositeVideoFrameContext.BackgroundFrame --api-type: winrt property ---- # Windows.Media.Effects.CompositeVideoFrameContext.BackgroundFrame ## -description Gets the background frame for an overlay operation. ## -property-value The background frame for an overlay operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.CompositeVideoFrameContext.BackgroundFrame +-api-type: winrt property +--- + + + +# Windows.Media.Effects.CompositeVideoFrameContext.BackgroundFrame + +## -description +Gets the background frame for an overlay operation. + +## -property-value +The background frame for an overlay operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/compositevideoframecontext_getoverlayforsurface_2132748166.md b/windows.media.effects/compositevideoframecontext_getoverlayforsurface_2132748166.md index 8ea89ac715..aeb8586121 100644 --- a/windows.media.effects/compositevideoframecontext_getoverlayforsurface_2132748166.md +++ b/windows.media.effects/compositevideoframecontext_getoverlayforsurface_2132748166.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Effects.CompositeVideoFrameContext.GetOverlayForSurface(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) --api-type: winrt method ---- # Windows.Media.Effects.CompositeVideoFrameContext.GetOverlayForSurface ## -description Gets a [MediaOverlay](../windows.media.editing/mediaoverlay.md) object for the provided Direct3D surface. ## -parameters ### -param surfaceToOverlay The Direct3D surface. ## -returns The created [MediaOverlay](../windows.media.editing/mediaoverlay.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.CompositeVideoFrameContext.GetOverlayForSurface(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.CompositeVideoFrameContext.GetOverlayForSurface + +## -description +Gets a [MediaOverlay](../windows.media.editing/mediaoverlay.md) object for the provided Direct3D surface. + +## -parameters +### -param surfaceToOverlay +The Direct3D surface. + +## -returns +The created [MediaOverlay](../windows.media.editing/mediaoverlay.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/compositevideoframecontext_outputframe.md b/windows.media.effects/compositevideoframecontext_outputframe.md index 84c71d6aa6..82704f62bc 100644 --- a/windows.media.effects/compositevideoframecontext_outputframe.md +++ b/windows.media.effects/compositevideoframecontext_outputframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.CompositeVideoFrameContext.OutputFrame --api-type: winrt property ---- # Windows.Media.Effects.CompositeVideoFrameContext.OutputFrame ## -description Gets the output frame for an overlay operation. ## -property-value The output frame for an overlay operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.CompositeVideoFrameContext.OutputFrame +-api-type: winrt property +--- + + + +# Windows.Media.Effects.CompositeVideoFrameContext.OutputFrame + +## -description +Gets the output frame for an overlay operation. + +## -property-value +The output frame for an overlay operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/compositevideoframecontext_surfacestooverlay.md b/windows.media.effects/compositevideoframecontext_surfacestooverlay.md index ce3ada8379..867624d5de 100644 --- a/windows.media.effects/compositevideoframecontext_surfacestooverlay.md +++ b/windows.media.effects/compositevideoframecontext_surfacestooverlay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.CompositeVideoFrameContext.SurfacesToOverlay --api-type: winrt property ---- # Windows.Media.Effects.CompositeVideoFrameContext.SurfacesToOverlay ## -description Gets the list of Direct3D surfaces to be used in an overlay operation. ## -property-value The list of Direct3D surfaces to be used in an overlay operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.CompositeVideoFrameContext.SurfacesToOverlay +-api-type: winrt property +--- + + + +# Windows.Media.Effects.CompositeVideoFrameContext.SurfacesToOverlay + +## -description +Gets the list of Direct3D surfaces to be used in an overlay operation. + +## -property-value +The list of Direct3D surfaces to be used in an overlay operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/iaudioeffectdefinition_activatableclassid.md b/windows.media.effects/iaudioeffectdefinition_activatableclassid.md index 301412bb0a..3b5e6bab90 100644 --- a/windows.media.effects/iaudioeffectdefinition_activatableclassid.md +++ b/windows.media.effects/iaudioeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IAudioEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.IAudioEffectDefinition.ActivatableClassId ## -description The activatable class ID of the audio effect definition. ## -property-value The activatable class ID of the audio effect definition, such as "AudioClipEffect". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IAudioEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IAudioEffectDefinition.ActivatableClassId + +## -description +The activatable class ID of the audio effect definition. + +## -property-value +The activatable class ID of the audio effect definition, such as "AudioClipEffect". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/iaudioeffectdefinition_properties.md b/windows.media.effects/iaudioeffectdefinition_properties.md index 3b3f9c1b1c..566b395e09 100644 --- a/windows.media.effects/iaudioeffectdefinition_properties.md +++ b/windows.media.effects/iaudioeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IAudioEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.IAudioEffectDefinition.Properties ## -description The set of properties for configuring an [AudioEffectDefinition](audioeffectdefinition.md) object. ## -property-value The set of properties for the audio effect definition, represented as tuples. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IAudioEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IAudioEffectDefinition.Properties + +## -description +The set of properties for configuring an [AudioEffectDefinition](audioeffectdefinition.md) object. + +## -property-value +The set of properties for the audio effect definition, represented as tuples. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicaudioeffect_close.md b/windows.media.effects/ibasicaudioeffect_close.md index 1e3ef37422..b4e4b61548 100644 --- a/windows.media.effects/ibasicaudioeffect_close.md +++ b/windows.media.effects/ibasicaudioeffect_close.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IBasicAudioEffect.Close(Windows.Media.Effects.MediaEffectClosedReason) --api-type: winrt method ---- # Windows.Media.Effects.IBasicAudioEffect.Close ## -description Called when the audio effect should close and clean up allocated resources. ## -parameters ### -param reason The reason the effect was closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicAudioEffect.Close(Windows.Media.Effects.MediaEffectClosedReason) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicAudioEffect.Close + +## -description +Called when the audio effect should close and clean up allocated resources. + +## -parameters +### -param reason +The reason the effect was closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicaudioeffect_discardqueuedframes.md b/windows.media.effects/ibasicaudioeffect_discardqueuedframes.md index 60d5fa88f6..52eb5791fc 100644 --- a/windows.media.effects/ibasicaudioeffect_discardqueuedframes.md +++ b/windows.media.effects/ibasicaudioeffect_discardqueuedframes.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Effects.IBasicAudioEffect.DiscardQueuedFrames --api-type: winrt method ---- # Windows.Media.Effects.IBasicAudioEffect.DiscardQueuedFrames ## -description Called to allow audio effect implementations optionally discard any stored state related to samples that have already been received. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicAudioEffect.DiscardQueuedFrames +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicAudioEffect.DiscardQueuedFrames + +## -description +Called to allow audio effect implementations optionally discard any stored state related to samples that have already been received. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicaudioeffect_processframe.md b/windows.media.effects/ibasicaudioeffect_processframe.md index 52aff865d6..ebe59855b1 100644 --- a/windows.media.effects/ibasicaudioeffect_processframe.md +++ b/windows.media.effects/ibasicaudioeffect_processframe.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IBasicAudioEffect.ProcessFrame(Windows.Media.Effects.ProcessAudioFrameContext) --api-type: winrt method ---- # Windows.Media.Effects.IBasicAudioEffect.ProcessFrame ## -description Called when samples are available for processing by a custom audio effect. ## -parameters ### -param context The context object that provides the input and output frames for the process operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicAudioEffect.ProcessFrame(Windows.Media.Effects.ProcessAudioFrameContext) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicAudioEffect.ProcessFrame + +## -description +Called when samples are available for processing by a custom audio effect. + +## -parameters +### -param context +The context object that provides the input and output frames for the process operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicaudioeffect_setencodingproperties.md b/windows.media.effects/ibasicaudioeffect_setencodingproperties.md index dae1176453..c555d8b646 100644 --- a/windows.media.effects/ibasicaudioeffect_setencodingproperties.md +++ b/windows.media.effects/ibasicaudioeffect_setencodingproperties.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IBasicAudioEffect.SetEncodingProperties(Windows.Media.MediaProperties.AudioEncodingProperties) --api-type: winrt method ---- # Windows.Media.Effects.IBasicAudioEffect.SetEncodingProperties ## -description Called to set the encoding properties of a custom audio effect. ## -parameters ### -param encodingProperties The encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicAudioEffect.SetEncodingProperties(Windows.Media.MediaProperties.AudioEncodingProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicAudioEffect.SetEncodingProperties + +## -description +Called to set the encoding properties of a custom audio effect. + +## -parameters +### -param encodingProperties +The encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicaudioeffect_supportedencodingproperties.md b/windows.media.effects/ibasicaudioeffect_supportedencodingproperties.md index e790a8c7f4..4c4a890519 100644 --- a/windows.media.effects/ibasicaudioeffect_supportedencodingproperties.md +++ b/windows.media.effects/ibasicaudioeffect_supportedencodingproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IBasicAudioEffect.SupportedEncodingProperties --api-type: winrt property ---- # Windows.Media.Effects.IBasicAudioEffect.SupportedEncodingProperties ## -description Gets the encoding properties supported by the custom audio effect. ## -property-value A list of supported encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IBasicAudioEffect.SupportedEncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IBasicAudioEffect.SupportedEncodingProperties + +## -description +Gets the encoding properties supported by the custom audio effect. + +## -property-value +A list of supported encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicaudioeffect_useinputframeforoutput.md b/windows.media.effects/ibasicaudioeffect_useinputframeforoutput.md index 768ed838d5..f604f50295 100644 --- a/windows.media.effects/ibasicaudioeffect_useinputframeforoutput.md +++ b/windows.media.effects/ibasicaudioeffect_useinputframeforoutput.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IBasicAudioEffect.UseInputFrameForOutput --api-type: winrt property ---- # Windows.Media.Effects.IBasicAudioEffect.UseInputFrameForOutput ## -description Gets a value that indicates whether the input frame is used for the output of the audio effect. ## -property-value True if the input frame is used for output; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IBasicAudioEffect.UseInputFrameForOutput +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IBasicAudioEffect.UseInputFrameForOutput + +## -description +Gets a value that indicates whether the input frame is used for the output of the audio effect. + +## -property-value +True if the input frame is used for output; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_close.md b/windows.media.effects/ibasicvideoeffect_close.md index 01aa8088e6..3dbb32fcfc 100644 --- a/windows.media.effects/ibasicvideoeffect_close.md +++ b/windows.media.effects/ibasicvideoeffect_close.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IBasicVideoEffect.Close(Windows.Media.Effects.MediaEffectClosedReason) --api-type: winrt method ---- # Windows.Media.Effects.IBasicVideoEffect.Close ## -description Called when the video effect should close and clean up allocated resources. ## -parameters ### -param reason The reason the effect was closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicVideoEffect.Close(Windows.Media.Effects.MediaEffectClosedReason) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.Close + +## -description +Called when the video effect should close and clean up allocated resources. + +## -parameters +### -param reason +The reason the effect was closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_discardqueuedframes.md b/windows.media.effects/ibasicvideoeffect_discardqueuedframes.md index 9562d7235f..33f250ee00 100644 --- a/windows.media.effects/ibasicvideoeffect_discardqueuedframes.md +++ b/windows.media.effects/ibasicvideoeffect_discardqueuedframes.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Effects.IBasicVideoEffect.DiscardQueuedFrames --api-type: winrt method ---- # Windows.Media.Effects.IBasicVideoEffect.DiscardQueuedFrames ## -description Called to allow video effect implementations optionally discard any stored state related to frames that have already been received. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicVideoEffect.DiscardQueuedFrames +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.DiscardQueuedFrames + +## -description +Called to allow video effect implementations optionally discard any stored state related to frames that have already been received. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_isreadonly.md b/windows.media.effects/ibasicvideoeffect_isreadonly.md index 96fb718b9f..5eb2ddb135 100644 --- a/windows.media.effects/ibasicvideoeffect_isreadonly.md +++ b/windows.media.effects/ibasicvideoeffect_isreadonly.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Effects.IBasicVideoEffect.IsReadOnly --api-type: winrt property ---- # Windows.Media.Effects.IBasicVideoEffect.IsReadOnly ## -description Gets a value indicating whether the video effect will modify the contents of the input frame. ## -property-value True, if the effect will not modify the input frame; otherwise, false. ## -remarks When [IBasicVideoEffect.IsReadOnly](ibasicvideoeffect_isreadonly.md) is set to true, the system automatically copies the frame data directly from the input frame to the output frame before [ProcessFrame](ibasicvideoeffect_processframe.md) is called. This allows an effect that analyzes the input data, but does not modify it, to skip the creation of the output frame data. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IBasicVideoEffect.IsReadOnly +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.IsReadOnly + +## -description +Gets a value indicating whether the video effect will modify the contents of the input frame. + +## -property-value +True, if the effect will not modify the input frame; otherwise, false. + +## -remarks +When [IBasicVideoEffect.IsReadOnly](ibasicvideoeffect_isreadonly.md) is set to true, the system automatically copies the frame data directly from the input frame to the output frame before [ProcessFrame](ibasicvideoeffect_processframe.md) is called. This allows an effect that analyzes the input data, but does not modify it, to skip the creation of the output frame data. + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_processframe.md b/windows.media.effects/ibasicvideoeffect_processframe.md index 9764a5af58..e73dcbe599 100644 --- a/windows.media.effects/ibasicvideoeffect_processframe.md +++ b/windows.media.effects/ibasicvideoeffect_processframe.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IBasicVideoEffect.ProcessFrame(Windows.Media.Effects.ProcessVideoFrameContext) --api-type: winrt method ---- # Windows.Media.Effects.IBasicVideoEffect.ProcessFrame ## -description Called when frames are available for processing by a custom video effect. ## -parameters ### -param context The context object that provides the input and output frames for the process operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicVideoEffect.ProcessFrame(Windows.Media.Effects.ProcessVideoFrameContext) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.ProcessFrame + +## -description +Called when frames are available for processing by a custom video effect. + +## -parameters +### -param context +The context object that provides the input and output frames for the process operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_setencodingproperties.md b/windows.media.effects/ibasicvideoeffect_setencodingproperties.md index 9a1d4fb1f1..8c27da9ef7 100644 --- a/windows.media.effects/ibasicvideoeffect_setencodingproperties.md +++ b/windows.media.effects/ibasicvideoeffect_setencodingproperties.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Effects.IBasicVideoEffect.SetEncodingProperties(Windows.Media.MediaProperties.VideoEncodingProperties,Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice) --api-type: winrt method ---- # Windows.Media.Effects.IBasicVideoEffect.SetEncodingProperties ## -description Called to set the encoding properties of a custom video effect. ## -parameters ### -param encodingProperties The encoding properties. ### -param device The Microsoft Direct3D device that can be used to create resources based on the media format described by the encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IBasicVideoEffect.SetEncodingProperties(Windows.Media.MediaProperties.VideoEncodingProperties,Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.SetEncodingProperties + +## -description +Called to set the encoding properties of a custom video effect. + +## -parameters +### -param encodingProperties +The encoding properties. + +### -param device +The Microsoft Direct3D device that can be used to create resources based on the media format described by the encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_supportedencodingproperties.md b/windows.media.effects/ibasicvideoeffect_supportedencodingproperties.md index 4bc5a3a1b2..e60902d547 100644 --- a/windows.media.effects/ibasicvideoeffect_supportedencodingproperties.md +++ b/windows.media.effects/ibasicvideoeffect_supportedencodingproperties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Effects.IBasicVideoEffect.SupportedEncodingProperties --api-type: winrt property ---- # Windows.Media.Effects.IBasicVideoEffect.SupportedEncodingProperties ## -description Gets the encoding properties supported by the custom video effect. ## -property-value A list of supported encoding properties. ## -remarks If you return an empty list of [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) objects from **SupportedEncodingProperties**, the system will default to ARGB32 encoding. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IBasicVideoEffect.SupportedEncodingProperties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.SupportedEncodingProperties + +## -description +Gets the encoding properties supported by the custom video effect. + +## -property-value +A list of supported encoding properties. + +## -remarks +If you return an empty list of [VideoEncodingProperties](../windows.media.mediaproperties/videoencodingproperties.md) objects from **SupportedEncodingProperties**, the system will default to ARGB32 encoding. + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_supportedmemorytypes.md b/windows.media.effects/ibasicvideoeffect_supportedmemorytypes.md index 389592ae85..7561eea731 100644 --- a/windows.media.effects/ibasicvideoeffect_supportedmemorytypes.md +++ b/windows.media.effects/ibasicvideoeffect_supportedmemorytypes.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Effects.IBasicVideoEffect.SupportedMemoryTypes --api-type: winrt property ---- # Windows.Media.Effects.IBasicVideoEffect.SupportedMemoryTypes ## -description Gets a value that indicates whether the custom video effect supports the use of GPU memory or CPU memory. ## -property-value A value that indicates the custom video effect's supported memory types. ## -remarks If you specify [MediaMemoryTypes.GpuAndCpu](mediamemorytypes.md) when setting the memory type for your effect, the system will use either GPU or system memory, whichever is more efficient for the pipeline. When using this value, you must check in the [ProcessFrame](ibasicvideoeffect_processframe.md) method to see whether the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) passed into the method contains data and then process the frame accordingly. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IBasicVideoEffect.SupportedMemoryTypes +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.SupportedMemoryTypes + +## -description +Gets a value that indicates whether the custom video effect supports the use of GPU memory or CPU memory. + +## -property-value +A value that indicates the custom video effect's supported memory types. + +## -remarks +If you specify [MediaMemoryTypes.GpuAndCpu](mediamemorytypes.md) when setting the memory type for your effect, the system will use either GPU or system memory, whichever is more efficient for the pipeline. When using this value, you must check in the [ProcessFrame](ibasicvideoeffect_processframe.md) method to see whether the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [IDirect3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) passed into the method contains data and then process the frame accordingly. + +## -examples + +## -see-also diff --git a/windows.media.effects/ibasicvideoeffect_timeindependent.md b/windows.media.effects/ibasicvideoeffect_timeindependent.md index 5494afdc27..7e2ae03b91 100644 --- a/windows.media.effects/ibasicvideoeffect_timeindependent.md +++ b/windows.media.effects/ibasicvideoeffect_timeindependent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IBasicVideoEffect.TimeIndependent --api-type: winrt property ---- # Windows.Media.Effects.IBasicVideoEffect.TimeIndependent ## -description Gets a value that indicates whether the custom video effect is time independent. ## -property-value True, if the video effect is time independent; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IBasicVideoEffect.TimeIndependent +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IBasicVideoEffect.TimeIndependent + +## -description +Gets a value that indicates whether the custom video effect is time independent. + +## -property-value +True, if the video effect is time independent; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositor_close.md b/windows.media.effects/ivideocompositor_close.md index 3e54987e2b..be8e61ce92 100644 --- a/windows.media.effects/ivideocompositor_close.md +++ b/windows.media.effects/ivideocompositor_close.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IVideoCompositor.Close(Windows.Media.Effects.MediaEffectClosedReason) --api-type: winrt method ---- # Windows.Media.Effects.IVideoCompositor.Close ## -description Called when the video compositor should close and clean up allocated resources. ## -parameters ### -param reason The reason the compositor was closed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IVideoCompositor.Close(Windows.Media.Effects.MediaEffectClosedReason) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IVideoCompositor.Close + +## -description +Called when the video compositor should close and clean up allocated resources. + +## -parameters +### -param reason +The reason the compositor was closed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositor_compositeframe.md b/windows.media.effects/ivideocompositor_compositeframe.md index 7b3cbf9a8f..ffccac694c 100644 --- a/windows.media.effects/ivideocompositor_compositeframe.md +++ b/windows.media.effects/ivideocompositor_compositeframe.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Effects.IVideoCompositor.CompositeFrame(Windows.Media.Effects.CompositeVideoFrameContext) --api-type: winrt method ---- # Windows.Media.Effects.IVideoCompositor.CompositeFrame ## -description Called when frames are available for composition by a custom video compositor. ## -parameters ### -param context The context object that provides the input and output frames for the composition operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IVideoCompositor.CompositeFrame(Windows.Media.Effects.CompositeVideoFrameContext) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IVideoCompositor.CompositeFrame + +## -description +Called when frames are available for composition by a custom video compositor. + +## -parameters +### -param context +The context object that provides the input and output frames for the composition operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositor_discardqueuedframes.md b/windows.media.effects/ivideocompositor_discardqueuedframes.md index dfb7f931c6..f7c50d598d 100644 --- a/windows.media.effects/ivideocompositor_discardqueuedframes.md +++ b/windows.media.effects/ivideocompositor_discardqueuedframes.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Effects.IVideoCompositor.DiscardQueuedFrames --api-type: winrt method ---- # Windows.Media.Effects.IVideoCompositor.DiscardQueuedFrames ## -description Called to allow video compositor implementations optionally discard any stored state related to frames that have already been received. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IVideoCompositor.DiscardQueuedFrames +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IVideoCompositor.DiscardQueuedFrames + +## -description +Called to allow video compositor implementations optionally discard any stored state related to frames that have already been received. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositor_setencodingproperties.md b/windows.media.effects/ivideocompositor_setencodingproperties.md index abde08944c..cda4ca4d2a 100644 --- a/windows.media.effects/ivideocompositor_setencodingproperties.md +++ b/windows.media.effects/ivideocompositor_setencodingproperties.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Effects.IVideoCompositor.SetEncodingProperties(Windows.Media.MediaProperties.VideoEncodingProperties,Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice) --api-type: winrt method ---- # Windows.Media.Effects.IVideoCompositor.SetEncodingProperties ## -description Called to set the encoding properties of a custom video compositor. ## -parameters ### -param backgroundProperties The encoding properties. ### -param device The Microsoft Direct3D device that can be used to create resources based on the media format described by the encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.IVideoCompositor.SetEncodingProperties(Windows.Media.MediaProperties.VideoEncodingProperties,Windows.Graphics.DirectX.Direct3D11.IDirect3DDevice) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.IVideoCompositor.SetEncodingProperties + +## -description +Called to set the encoding properties of a custom video compositor. + +## -parameters +### -param backgroundProperties +The encoding properties. + +### -param device +The Microsoft Direct3D device that can be used to create resources based on the media format described by the encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositor_timeindependent.md b/windows.media.effects/ivideocompositor_timeindependent.md index 0ee45aec88..d236af8ed4 100644 --- a/windows.media.effects/ivideocompositor_timeindependent.md +++ b/windows.media.effects/ivideocompositor_timeindependent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IVideoCompositor.TimeIndependent --api-type: winrt property ---- # Windows.Media.Effects.IVideoCompositor.TimeIndependent ## -description Gets a value that indicates whether the custom video effect is time independent. ## -property-value True, if the video effect is time independent; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IVideoCompositor.TimeIndependent +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IVideoCompositor.TimeIndependent + +## -description +Gets a value that indicates whether the custom video effect is time independent. + +## -property-value +True, if the video effect is time independent; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositordefinition_activatableclassid.md b/windows.media.effects/ivideocompositordefinition_activatableclassid.md index ffefa9f8b9..b844744031 100644 --- a/windows.media.effects/ivideocompositordefinition_activatableclassid.md +++ b/windows.media.effects/ivideocompositordefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IVideoCompositorDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.IVideoCompositorDefinition.ActivatableClassId ## -description Gets the activatable class ID of the video compositor. ## -property-value The activatable class ID of the video compositor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IVideoCompositorDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IVideoCompositorDefinition.ActivatableClassId + +## -description +Gets the activatable class ID of the video compositor. + +## -property-value +The activatable class ID of the video compositor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideocompositordefinition_properties.md b/windows.media.effects/ivideocompositordefinition_properties.md index b844824776..30669cec0f 100644 --- a/windows.media.effects/ivideocompositordefinition_properties.md +++ b/windows.media.effects/ivideocompositordefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IVideoCompositorDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.IVideoCompositorDefinition.Properties ## -description Gets the set of properties for configuring the video compositor object. ## -property-value The set of properties for configuring the video compositor object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IVideoCompositorDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IVideoCompositorDefinition.Properties + +## -description +Gets the set of properties for configuring the video compositor object. + +## -property-value +The set of properties for configuring the video compositor object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideoeffectdefinition_activatableclassid.md b/windows.media.effects/ivideoeffectdefinition_activatableclassid.md index cbdfe0a13a..d9b6d774ed 100644 --- a/windows.media.effects/ivideoeffectdefinition_activatableclassid.md +++ b/windows.media.effects/ivideoeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IVideoEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.IVideoEffectDefinition.ActivatableClassId ## -description The activatable class ID of the video effect definition. ## -property-value The activatable class ID of the video effect definition, such as "Windows.Media.VideoStabilizationEffect". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IVideoEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IVideoEffectDefinition.ActivatableClassId + +## -description +The activatable class ID of the video effect definition. + +## -property-value +The activatable class ID of the video effect definition, such as "Windows.Media.VideoStabilizationEffect". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/ivideoeffectdefinition_properties.md b/windows.media.effects/ivideoeffectdefinition_properties.md index 338bbb6175..671be23f14 100644 --- a/windows.media.effects/ivideoeffectdefinition_properties.md +++ b/windows.media.effects/ivideoeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.IVideoEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.IVideoEffectDefinition.Properties ## -description The set of properties for configuring the [VideoEffectDefinition](videoeffectdefinition.md) object. ## -property-value The set of properties for the video effect definition, represented as tuples. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.IVideoEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.IVideoEffectDefinition.Properties + +## -description +The set of properties for configuring the [VideoEffectDefinition](videoeffectdefinition.md) object. + +## -property-value +The set of properties for the video effect definition, represented as tuples. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/processaudioframecontext.md b/windows.media.effects/processaudioframecontext.md index bcf10c7e81..641dd92149 100644 --- a/windows.media.effects/processaudioframecontext.md +++ b/windows.media.effects/processaudioframecontext.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Effects.ProcessAudioFrameContext --api-type: winrt class ---- # Windows.Media.Effects.ProcessAudioFrameContext ## -description Provides context for performing a custom audio effect operation within the [ProcessFrame](ibasicaudioeffect_processframe.md) method. ## -remarks To retrieve an instance of this class, implement the [ProcessFrame](ibasicaudioeffect_processframe.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.ProcessAudioFrameContext +-api-type: winrt class +--- + + + +# Windows.Media.Effects.ProcessAudioFrameContext + +## -description +Provides context for performing a custom audio effect operation within the [ProcessFrame](ibasicaudioeffect_processframe.md) method. + +## -remarks +To retrieve an instance of this class, implement the [ProcessFrame](ibasicaudioeffect_processframe.md) method. + +## -examples + +## -see-also diff --git a/windows.media.effects/processaudioframecontext_inputframe.md b/windows.media.effects/processaudioframecontext_inputframe.md index 294f829694..8dde6e267e 100644 --- a/windows.media.effects/processaudioframecontext_inputframe.md +++ b/windows.media.effects/processaudioframecontext_inputframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.ProcessAudioFrameContext.InputFrame --api-type: winrt property ---- # Windows.Media.Effects.ProcessAudioFrameContext.InputFrame ## -description Gets the input frame for an audio effect operation. ## -property-value The input frame for an audio effect operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.ProcessAudioFrameContext.InputFrame +-api-type: winrt property +--- + + + +# Windows.Media.Effects.ProcessAudioFrameContext.InputFrame + +## -description +Gets the input frame for an audio effect operation. + +## -property-value +The input frame for an audio effect operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/processaudioframecontext_outputframe.md b/windows.media.effects/processaudioframecontext_outputframe.md index 820f458136..f149398e30 100644 --- a/windows.media.effects/processaudioframecontext_outputframe.md +++ b/windows.media.effects/processaudioframecontext_outputframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.ProcessAudioFrameContext.OutputFrame --api-type: winrt property ---- # Windows.Media.Effects.ProcessAudioFrameContext.OutputFrame ## -description Gets the output frame for an audio effect operation. ## -property-value The output frame for an audio effect operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.ProcessAudioFrameContext.OutputFrame +-api-type: winrt property +--- + + + +# Windows.Media.Effects.ProcessAudioFrameContext.OutputFrame + +## -description +Gets the output frame for an audio effect operation. + +## -property-value +The output frame for an audio effect operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/processvideoframecontext.md b/windows.media.effects/processvideoframecontext.md index bebe6da1b9..f6b6f45030 100644 --- a/windows.media.effects/processvideoframecontext.md +++ b/windows.media.effects/processvideoframecontext.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Effects.ProcessVideoFrameContext --api-type: winrt class ---- # Windows.Media.Effects.ProcessVideoFrameContext ## -description Provides context for performing a custom video effect operation within the [ProcessFrame](ibasicvideoeffect_processframe.md) method. ## -remarks To retrieve an instance of this class, implement the [ProcessFrame](ibasicaudioeffect_processframe.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.ProcessVideoFrameContext +-api-type: winrt class +--- + + + +# Windows.Media.Effects.ProcessVideoFrameContext + +## -description +Provides context for performing a custom video effect operation within the [ProcessFrame](ibasicvideoeffect_processframe.md) method. + +## -remarks +To retrieve an instance of this class, implement the [ProcessFrame](ibasicaudioeffect_processframe.md) method. + +## -examples + +## -see-also diff --git a/windows.media.effects/processvideoframecontext_inputframe.md b/windows.media.effects/processvideoframecontext_inputframe.md index 2d9b290bb7..20a8ea76e7 100644 --- a/windows.media.effects/processvideoframecontext_inputframe.md +++ b/windows.media.effects/processvideoframecontext_inputframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.ProcessVideoFrameContext.InputFrame --api-type: winrt property ---- # Windows.Media.Effects.ProcessVideoFrameContext.InputFrame ## -description Gets the input frame for a video effect operation. ## -property-value The input frame for a video effect operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.ProcessVideoFrameContext.InputFrame +-api-type: winrt property +--- + + + +# Windows.Media.Effects.ProcessVideoFrameContext.InputFrame + +## -description +Gets the input frame for a video effect operation. + +## -property-value +The input frame for a video effect operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/processvideoframecontext_outputframe.md b/windows.media.effects/processvideoframecontext_outputframe.md index a6bb4c115d..533db295d3 100644 --- a/windows.media.effects/processvideoframecontext_outputframe.md +++ b/windows.media.effects/processvideoframecontext_outputframe.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.ProcessVideoFrameContext.OutputFrame --api-type: winrt property ---- # Windows.Media.Effects.ProcessVideoFrameContext.OutputFrame ## -description Gets the output frame for a video effect operation. ## -property-value The output frame for a video effect operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.ProcessVideoFrameContext.OutputFrame +-api-type: winrt property +--- + + + +# Windows.Media.Effects.ProcessVideoFrameContext.OutputFrame + +## -description +Gets the output frame for a video effect operation. + +## -property-value +The output frame for a video effect operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/slowmotioneffectdefinition.md b/windows.media.effects/slowmotioneffectdefinition.md index 17d9a7de49..658dbe0e56 100644 --- a/windows.media.effects/slowmotioneffectdefinition.md +++ b/windows.media.effects/slowmotioneffectdefinition.md @@ -1,3 +1,22 @@ ---- -api-id: T:Windows.Media.Effects.SlowMotionEffectDefinition --api-type: winrt class ---- # Windows.Media.Effects.SlowMotionEffectDefinition ## -description Represents a slow motion effect definition. ## -remarks > [!IMPORTANT] > Using [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) will only affect video. It is not to be used as an audio effect. ## -examples ## -see-also [IVideoEffectDefinition](ivideoeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.SlowMotionEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Effects.SlowMotionEffectDefinition + +## -description +Represents a slow motion effect definition. + +## -remarks +> [!IMPORTANT] +> Using [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) will only affect video. It is not to be used as an audio effect. + +## -examples + +## -see-also +[IVideoEffectDefinition](ivideoeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.effects/slowmotioneffectdefinition_activatableclassid.md b/windows.media.effects/slowmotioneffectdefinition_activatableclassid.md index 8b23a440fd..a84afaa11e 100644 --- a/windows.media.effects/slowmotioneffectdefinition_activatableclassid.md +++ b/windows.media.effects/slowmotioneffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.SlowMotionEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.SlowMotionEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID of the slow motion effect definition. ## -property-value The identifier of the runtime class in the operating system, such as "Windows.Media.Effects.SlowMotionEffectDefinition". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.SlowMotionEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.SlowMotionEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID of the slow motion effect definition. + +## -property-value +The identifier of the runtime class in the operating system, such as "Windows.Media.Effects.SlowMotionEffectDefinition". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/slowmotioneffectdefinition_properties.md b/windows.media.effects/slowmotioneffectdefinition_properties.md index baa91ae8b1..3ba1e3e688 100644 --- a/windows.media.effects/slowmotioneffectdefinition_properties.md +++ b/windows.media.effects/slowmotioneffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.SlowMotionEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.SlowMotionEffectDefinition.Properties ## -description Gets the set of properties for configuring the [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) object. ## -property-value The set of properties for configuring the [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.SlowMotionEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.SlowMotionEffectDefinition.Properties + +## -description +Gets the set of properties for configuring the [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) object. + +## -property-value +The set of properties for configuring the [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/slowmotioneffectdefinition_slowmotioneffectdefinition_1221375020.md b/windows.media.effects/slowmotioneffectdefinition_slowmotioneffectdefinition_1221375020.md index 1e46a9b646..c6c0b023c1 100644 --- a/windows.media.effects/slowmotioneffectdefinition_slowmotioneffectdefinition_1221375020.md +++ b/windows.media.effects/slowmotioneffectdefinition_slowmotioneffectdefinition_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Effects.SlowMotionEffectDefinition.#ctor --api-type: winrt method ---- # Windows.Media.Effects.SlowMotionEffectDefinition.SlowMotionEffectDefinition ## -description Creates and initializes a new instance of the [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.SlowMotionEffectDefinition.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Effects.SlowMotionEffectDefinition.SlowMotionEffectDefinition + +## -description +Creates and initializes a new instance of the [SlowMotionEffectDefinition](slowmotioneffectdefinition.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/slowmotioneffectdefinition_timestretchrate.md b/windows.media.effects/slowmotioneffectdefinition_timestretchrate.md index a093d2fdba..ad67d78075 100644 --- a/windows.media.effects/slowmotioneffectdefinition_timestretchrate.md +++ b/windows.media.effects/slowmotioneffectdefinition_timestretchrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.SlowMotionEffectDefinition.TimeStretchRate --api-type: winrt property ---- # Windows.Media.Effects.SlowMotionEffectDefinition.TimeStretchRate ## -description Gets or sets the current time stretch rate. ## -property-value The current time stretch rate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.SlowMotionEffectDefinition.TimeStretchRate +-api-type: winrt property +--- + + + +# Windows.Media.Effects.SlowMotionEffectDefinition.TimeStretchRate + +## -description +Gets or sets the current time stretch rate. + +## -property-value +The current time stretch rate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videocompositordefinition.md b/windows.media.effects/videocompositordefinition.md index cf76b8c463..70758d32cf 100644 --- a/windows.media.effects/videocompositordefinition.md +++ b/windows.media.effects/videocompositordefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Effects.VideoCompositorDefinition --api-type: winrt class ---- # Windows.Media.Effects.VideoCompositorDefinition ## -description Represents the definition of a custom video compositor. ## -remarks ## -examples ## -see-also [IVideoCompositorDefinition](ivideocompositordefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.VideoCompositorDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Effects.VideoCompositorDefinition + +## -description +Represents the definition of a custom video compositor. + +## -remarks + +## -examples + +## -see-also +[IVideoCompositorDefinition](ivideocompositordefinition.md) \ No newline at end of file diff --git a/windows.media.effects/videocompositordefinition_activatableclassid.md b/windows.media.effects/videocompositordefinition_activatableclassid.md index 390904fef2..7745be3e56 100644 --- a/windows.media.effects/videocompositordefinition_activatableclassid.md +++ b/windows.media.effects/videocompositordefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoCompositorDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.VideoCompositorDefinition.ActivatableClassId ## -description Gets the activatable class ID of the video compositor. ## -property-value The activatable class ID of the video compositor. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoCompositorDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoCompositorDefinition.ActivatableClassId + +## -description +Gets the activatable class ID of the video compositor. + +## -property-value +The activatable class ID of the video compositor. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videocompositordefinition_properties.md b/windows.media.effects/videocompositordefinition_properties.md index c6391dea89..5bcc7f1438 100644 --- a/windows.media.effects/videocompositordefinition_properties.md +++ b/windows.media.effects/videocompositordefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoCompositorDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.VideoCompositorDefinition.Properties ## -description Gets the set of properties for configuring the video compositor object. ## -property-value The set of properties for configuring the video compositor object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoCompositorDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoCompositorDefinition.Properties + +## -description +Gets the set of properties for configuring the video compositor object. + +## -property-value +The set of properties for configuring the video compositor object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videocompositordefinition_videocompositordefinition_1860087994.md b/windows.media.effects/videocompositordefinition_videocompositordefinition_1860087994.md index 9b4a1c915f..6f79bf12c7 100644 --- a/windows.media.effects/videocompositordefinition_videocompositordefinition_1860087994.md +++ b/windows.media.effects/videocompositordefinition_videocompositordefinition_1860087994.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Effects.VideoCompositorDefinition.#ctor(System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Effects.VideoCompositorDefinition.VideoCompositorDefinition ## -description Initializes a new instance of the [VideoCompositorDefinition](videocompositordefinition.md) class. ## -parameters ### -param activatableClassId The activatable class ID of the video compositor. ### -param props The set of properties for configuring the video compositor object. ## -remarks ## -examples ## -see-also [VideoCompositorDefinition(String)](videocompositordefinition_videocompositordefinition_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.VideoCompositorDefinition.#ctor(System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.VideoCompositorDefinition.VideoCompositorDefinition + +## -description +Initializes a new instance of the [VideoCompositorDefinition](videocompositordefinition.md) class. + +## -parameters +### -param activatableClassId +The activatable class ID of the video compositor. + +### -param props +The set of properties for configuring the video compositor object. + +## -remarks + +## -examples + +## -see-also +[VideoCompositorDefinition(String)](videocompositordefinition_videocompositordefinition_290278668.md) \ No newline at end of file diff --git a/windows.media.effects/videocompositordefinition_videocompositordefinition_290278668.md b/windows.media.effects/videocompositordefinition_videocompositordefinition_290278668.md index d5b5888a4c..b3ce534349 100644 --- a/windows.media.effects/videocompositordefinition_videocompositordefinition_290278668.md +++ b/windows.media.effects/videocompositordefinition_videocompositordefinition_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Effects.VideoCompositorDefinition.#ctor(System.String) --api-type: winrt method ---- # Windows.Media.Effects.VideoCompositorDefinition.VideoCompositorDefinition ## -description Initializes a new instance of the [VideoCompositorDefinition](videocompositordefinition.md) class. ## -parameters ### -param activatableClassId The activatable class ID of the video compositor. ## -remarks ## -examples ## -see-also [VideoCompositorDefinition(String, IPropertySet)](videocompositordefinition_videocompositordefinition_1860087994.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.VideoCompositorDefinition.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.VideoCompositorDefinition.VideoCompositorDefinition + +## -description +Initializes a new instance of the [VideoCompositorDefinition](videocompositordefinition.md) class. + +## -parameters +### -param activatableClassId +The activatable class ID of the video compositor. + +## -remarks + +## -examples + +## -see-also +[VideoCompositorDefinition(String, IPropertySet)](videocompositordefinition_videocompositordefinition_1860087994.md) \ No newline at end of file diff --git a/windows.media.effects/videoeffectdefinition.md b/windows.media.effects/videoeffectdefinition.md index eed0d9b40f..899b95a09e 100644 --- a/windows.media.effects/videoeffectdefinition.md +++ b/windows.media.effects/videoeffectdefinition.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Effects.VideoEffectDefinition --api-type: winrt class ---- # Windows.Media.Effects.VideoEffectDefinition ## -description Represents a video effect definition. ## -remarks ## -examples ## -see-also [IVideoEffectDefinition](ivideoeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.VideoEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Effects.VideoEffectDefinition + +## -description +Represents a video effect definition. + +## -remarks + +## -examples + +## -see-also +[IVideoEffectDefinition](ivideoeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.effects/videoeffectdefinition_activatableclassid.md b/windows.media.effects/videoeffectdefinition_activatableclassid.md index ceba9d3410..cc6d3137f0 100644 --- a/windows.media.effects/videoeffectdefinition_activatableclassid.md +++ b/windows.media.effects/videoeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.VideoEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID of the video effect definition. ## -property-value The activatable class ID of the video effect definition, such as "Windows.Media.VideoStabilizationEffect". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID of the video effect definition. + +## -property-value +The activatable class ID of the video effect definition, such as "Windows.Media.VideoStabilizationEffect". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videoeffectdefinition_properties.md b/windows.media.effects/videoeffectdefinition_properties.md index f6c65ca307..ad996ae756 100644 --- a/windows.media.effects/videoeffectdefinition_properties.md +++ b/windows.media.effects/videoeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.VideoEffectDefinition.Properties ## -description Gets the set of properties for configuring the [VideoEffectDefinition](videoeffectdefinition.md) object. ## -property-value The set of properties for the video effect definition, represented as tuples. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoEffectDefinition.Properties + +## -description +Gets the set of properties for configuring the [VideoEffectDefinition](videoeffectdefinition.md) object. + +## -property-value +The set of properties for the video effect definition, represented as tuples. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videoeffectdefinition_videoeffectdefinition_1860087994.md b/windows.media.effects/videoeffectdefinition_videoeffectdefinition_1860087994.md index fdb8fb629c..f960ee9af9 100644 --- a/windows.media.effects/videoeffectdefinition_videoeffectdefinition_1860087994.md +++ b/windows.media.effects/videoeffectdefinition_videoeffectdefinition_1860087994.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Effects.VideoEffectDefinition.#ctor(System.String,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Effects.VideoEffectDefinition.VideoEffectDefinition ## -description Creates a new [VideoEffectDefinition](videoeffectdefinition.md) object with the specified activatable class ID, configuring the object with the specified settings. ## -parameters ### -param activatableClassId The activatable class ID of the video effect definition. ### -param props Configuration properties for the specified video effect definition. ## -remarks ## -examples ## -see-also [VideoEffectDefinition(String)](videoeffectdefinition_videoeffectdefinition_290278668.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.VideoEffectDefinition.#ctor(System.String,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.VideoEffectDefinition.VideoEffectDefinition + +## -description +Creates a new [VideoEffectDefinition](videoeffectdefinition.md) object with the specified activatable class ID, configuring the object with the specified settings. + +## -parameters +### -param activatableClassId +The activatable class ID of the video effect definition. + +### -param props +Configuration properties for the specified video effect definition. + +## -remarks + +## -examples + +## -see-also +[VideoEffectDefinition(String)](videoeffectdefinition_videoeffectdefinition_290278668.md) \ No newline at end of file diff --git a/windows.media.effects/videoeffectdefinition_videoeffectdefinition_290278668.md b/windows.media.effects/videoeffectdefinition_videoeffectdefinition_290278668.md index 1f42b55cc1..799aa9892e 100644 --- a/windows.media.effects/videoeffectdefinition_videoeffectdefinition_290278668.md +++ b/windows.media.effects/videoeffectdefinition_videoeffectdefinition_290278668.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Effects.VideoEffectDefinition.#ctor(System.String) --api-type: winrt method ---- # Windows.Media.Effects.VideoEffectDefinition.VideoEffectDefinition ## -description Creates a new [VideoEffectDefinition](videoeffectdefinition.md) object with the specified activatable class ID. ## -parameters ### -param activatableClassId The activatable class ID of the video effect definition. ## -remarks ## -examples ## -see-also [VideoEffectDefinition(String, IPropertySet)](videoeffectdefinition_videoeffectdefinition_1860087994.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.VideoEffectDefinition.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Effects.VideoEffectDefinition.VideoEffectDefinition + +## -description +Creates a new [VideoEffectDefinition](videoeffectdefinition.md) object with the specified activatable class ID. + +## -parameters +### -param activatableClassId +The activatable class ID of the video effect definition. + +## -remarks + +## -examples + +## -see-also +[VideoEffectDefinition(String, IPropertySet)](videoeffectdefinition_videoeffectdefinition_1860087994.md) \ No newline at end of file diff --git a/windows.media.effects/videotransformeffectdefinition.md b/windows.media.effects/videotransformeffectdefinition.md index 400a6b3424..7a6af1d0f8 100644 --- a/windows.media.effects/videotransformeffectdefinition.md +++ b/windows.media.effects/videotransformeffectdefinition.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Effects.VideoTransformEffectDefinition --api-type: winrt class ---- # Windows.Media.Effects.VideoTransformEffectDefinition ## -description Represents the definition of a video transform effect. ## -remarks Use this class to add transformation effects to a video stream. Supported effects include rotation, mirroring, source clipping, destination mapping, and setting a padding color for areas in the frame that are not filled with input video. ## -examples ## -see-also [IVideoEffectDefinition](ivideoeffectdefinition.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Effects.VideoTransformEffectDefinition +-api-type: winrt class +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition + +## -description +Represents the definition of a video transform effect. + +## -remarks +Use this class to add transformation effects to a video stream. Supported effects include rotation, mirroring, source clipping, destination mapping, and setting a padding color for areas in the frame that are not filled with input video. + +## -examples + +## -see-also +[IVideoEffectDefinition](ivideoeffectdefinition.md) \ No newline at end of file diff --git a/windows.media.effects/videotransformeffectdefinition_activatableclassid.md b/windows.media.effects/videotransformeffectdefinition_activatableclassid.md index 63071764a8..60cd0cc874 100644 --- a/windows.media.effects/videotransformeffectdefinition_activatableclassid.md +++ b/windows.media.effects/videotransformeffectdefinition_activatableclassid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.ActivatableClassId --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.ActivatableClassId ## -description Gets the activatable class ID of the video transform effect definition. ## -property-value The activatable class ID of the video transform effect definition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.ActivatableClassId +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.ActivatableClassId + +## -description +Gets the activatable class ID of the video transform effect definition. + +## -property-value +The activatable class ID of the video transform effect definition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_croprectangle.md b/windows.media.effects/videotransformeffectdefinition_croprectangle.md index e514b31706..532e9c5ea1 100644 --- a/windows.media.effects/videotransformeffectdefinition_croprectangle.md +++ b/windows.media.effects/videotransformeffectdefinition_croprectangle.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.CropRectangle --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.CropRectangle ## -description Gets or sets the rectangle within which the video will be cropped, specified in pixels. ## -property-value The rectangle within which the video will be cropped ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.CropRectangle +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.CropRectangle + +## -description +Gets or sets the rectangle within which the video will be cropped, specified in pixels. + +## -property-value +The rectangle within which the video will be cropped + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_mirror.md b/windows.media.effects/videotransformeffectdefinition_mirror.md index cebfcf4475..e52744a4a8 100644 --- a/windows.media.effects/videotransformeffectdefinition_mirror.md +++ b/windows.media.effects/videotransformeffectdefinition_mirror.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.Mirror --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.Mirror ## -description Gets or sets the direction in which the video will be mirrored. ## -property-value The direction in which the video will be mirrored. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.Mirror +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.Mirror + +## -description +Gets or sets the direction in which the video will be mirrored. + +## -property-value +The direction in which the video will be mirrored. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_outputsize.md b/windows.media.effects/videotransformeffectdefinition_outputsize.md index 6c130a3e32..4dc3679407 100644 --- a/windows.media.effects/videotransformeffectdefinition_outputsize.md +++ b/windows.media.effects/videotransformeffectdefinition_outputsize.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.OutputSize --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.OutputSize ## -description Gets or sets the output size of the video, in pixels. ## -property-value The output size of the video, in pixels. ## -remarks When video is scaled using this property, the aspect ratio of the video is preserved. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.OutputSize +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.OutputSize + +## -description +Gets or sets the output size of the video, in pixels. + +## -property-value +The output size of the video, in pixels. + +## -remarks +When video is scaled using this property, the aspect ratio of the video is preserved. + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_paddingcolor.md b/windows.media.effects/videotransformeffectdefinition_paddingcolor.md index abb707379b..61d99f2039 100644 --- a/windows.media.effects/videotransformeffectdefinition_paddingcolor.md +++ b/windows.media.effects/videotransformeffectdefinition_paddingcolor.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.PaddingColor --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.PaddingColor ## -description Gets or sets the color that will be used to fill pixels in the frame that are not filled with video, such as when video is letterboxed. ## -property-value The color that will be used to fill pixels in the frame that are not filled with video ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.PaddingColor +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.PaddingColor + +## -description +Gets or sets the color that will be used to fill pixels in the frame that are not filled with video, such as when video is letterboxed. + +## -property-value +The color that will be used to fill pixels in the frame that are not filled with video + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_processingalgorithm.md b/windows.media.effects/videotransformeffectdefinition_processingalgorithm.md index c30f4002d1..b61468d507 100644 --- a/windows.media.effects/videotransformeffectdefinition_processingalgorithm.md +++ b/windows.media.effects/videotransformeffectdefinition_processingalgorithm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.ProcessingAlgorithm --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.ProcessingAlgorithm ## -description Gets or sets the media processing algorithm that is used for the video transform. ## -property-value The media processing algorithm that is used for the video transform. ## -remarks Set this value to [MrfCrf444](../windows.media.transcoding/mediavideoprocessingalgorithm.md) to cause the video transform to use a high-quality resampler so that all operations are done using 4:4:4 sampling for the highest video quality. The algorithm applies to all transform properties except for [PaddingColor](videotransformeffectdefinition_paddingcolor.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.ProcessingAlgorithm +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.ProcessingAlgorithm + +## -description +Gets or sets the media processing algorithm that is used for the video transform. + +## -property-value +The media processing algorithm that is used for the video transform. + +## -remarks +Set this value to [MrfCrf444](../windows.media.transcoding/mediavideoprocessingalgorithm.md) to cause the video transform to use a high-quality resampler so that all operations are done using 4:4:4 sampling for the highest video quality. The algorithm applies to all transform properties except for [PaddingColor](videotransformeffectdefinition_paddingcolor.md). + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_properties.md b/windows.media.effects/videotransformeffectdefinition_properties.md index a0473ac9bf..8b1736561d 100644 --- a/windows.media.effects/videotransformeffectdefinition_properties.md +++ b/windows.media.effects/videotransformeffectdefinition_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.Properties --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.Properties ## -description Gets the set of properties for configuring the [VideoTransformEffectDefinition](videotransformeffectdefinition.md) object. ## -property-value The set of properties for configuring the [VideoTransformEffectDefinition](videotransformeffectdefinition.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.Properties + +## -description +Gets the set of properties for configuring the [VideoTransformEffectDefinition](videotransformeffectdefinition.md) object. + +## -property-value +The set of properties for configuring the [VideoTransformEffectDefinition](videotransformeffectdefinition.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_rotation.md b/windows.media.effects/videotransformeffectdefinition_rotation.md index e2f5ffbf40..bbbb427137 100644 --- a/windows.media.effects/videotransformeffectdefinition_rotation.md +++ b/windows.media.effects/videotransformeffectdefinition_rotation.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.Rotation --api-type: winrt property ---- # Windows.Media.Effects.VideoTransformEffectDefinition.Rotation ## -description Gets or sets the angle and direction in which the video will be rotated. ## -property-value The angle and direction in which the video will be rotated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Effects.VideoTransformEffectDefinition.Rotation +-api-type: winrt property +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.Rotation + +## -description +Gets or sets the angle and direction in which the video will be rotated. + +## -property-value +The angle and direction in which the video will be rotated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.effects/videotransformeffectdefinition_videotransformeffectdefinition_1221375020.md b/windows.media.effects/videotransformeffectdefinition_videotransformeffectdefinition_1221375020.md index 779c5b7853..871d935bef 100644 --- a/windows.media.effects/videotransformeffectdefinition_videotransformeffectdefinition_1221375020.md +++ b/windows.media.effects/videotransformeffectdefinition_videotransformeffectdefinition_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Effects.VideoTransformEffectDefinition.#ctor --api-type: winrt method ---- # Windows.Media.Effects.VideoTransformEffectDefinition.VideoTransformEffectDefinition ## -description Initializes a new instance of the [VideoTransformEffectDefinition](videotransformeffectdefinition.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Effects.VideoTransformEffectDefinition.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Effects.VideoTransformEffectDefinition.VideoTransformEffectDefinition + +## -description +Initializes a new instance of the [VideoTransformEffectDefinition](videotransformeffectdefinition.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/detectedface.md b/windows.media.faceanalysis/detectedface.md index b090ce7371..97ab971fef 100644 --- a/windows.media.faceanalysis/detectedface.md +++ b/windows.media.faceanalysis/detectedface.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.FaceAnalysis.DetectedFace --api-type: winrt class ---- # Windows.Media.FaceAnalysis.DetectedFace ## -description Represents a face that was detected in a [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or a [VideoFrame](../windows.media/videoframe.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.FaceAnalysis.DetectedFace +-api-type: winrt class +--- + + + +# Windows.Media.FaceAnalysis.DetectedFace + +## -description +Represents a face that was detected in a [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or a [VideoFrame](../windows.media/videoframe.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/detectedface_facebox.md b/windows.media.faceanalysis/detectedface_facebox.md index 4727abc857..f5eb0b1a61 100644 --- a/windows.media.faceanalysis/detectedface_facebox.md +++ b/windows.media.faceanalysis/detectedface_facebox.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.DetectedFace.FaceBox --api-type: winrt property ---- # Windows.Media.FaceAnalysis.DetectedFace.FaceBox ## -description Gets the bounds the detected face occupies in the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [VideoFrame](../windows.media/videoframe.md). ## -property-value The bounds of the detected face. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.DetectedFace.FaceBox +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.DetectedFace.FaceBox + +## -description +Gets the bounds the detected face occupies in the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [VideoFrame](../windows.media/videoframe.md). + +## -property-value +The bounds of the detected face. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facedetector.md b/windows.media.faceanalysis/facedetector.md index 6cf8033128..237268eb67 100644 --- a/windows.media.faceanalysis/facedetector.md +++ b/windows.media.faceanalysis/facedetector.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.FaceAnalysis.FaceDetector --api-type: winrt class ---- # Windows.Media.FaceAnalysis.FaceDetector ## -description Detects faces in a [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md). ## -remarks ## -examples ## -see-also [Basic face detection sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620512) \ No newline at end of file +--- +-api-id: T:Windows.Media.FaceAnalysis.FaceDetector +-api-type: winrt class +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector + +## -description +Detects faces in a [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md). + +## -remarks + +## -examples + +## -see-also +[Basic face detection sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620512) \ No newline at end of file diff --git a/windows.media.faceanalysis/facedetector_createasync_616540418.md b/windows.media.faceanalysis/facedetector_createasync_616540418.md index fda7a75836..7ae1dac463 100644 --- a/windows.media.faceanalysis/facedetector_createasync_616540418.md +++ b/windows.media.faceanalysis/facedetector_createasync_616540418.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceDetector.CreateAsync --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceDetector.CreateAsync ## -description Creates a new instance of the [FaceDetector](facedetector.md) class. ## -returns An asynchronous operation that returns a [FaceDetector](facedetector.md) instance upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceDetector.CreateAsync +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.CreateAsync + +## -description +Creates a new instance of the [FaceDetector](facedetector.md) class. + +## -returns +An asynchronous operation that returns a [FaceDetector](facedetector.md) instance upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facedetector_detectfacesasync_1738906219.md b/windows.media.faceanalysis/facedetector_detectfacesasync_1738906219.md index c2906f99d3..37569522e2 100644 --- a/windows.media.faceanalysis/facedetector_detectfacesasync_1738906219.md +++ b/windows.media.faceanalysis/facedetector_detectfacesasync_1738906219.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync ## -description Asynchronously detects faces in the provided [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md). ## -parameters ### -param image The image data to be processed for face detection. ## -returns An asynchronous operation that returns a list of [DetectedFace](detectedface.md) objects upon successful completion. ## -remarks The provided [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) must be in a supported pixel format for this method and its overloads. Use [GetSupportedBitmapPixelFormats](facedetector_getsupportedbitmappixelformats.md) to retrieve a list of supported pixel formats for the current device. Use [IsBitmapPixelFormatSupported](facedetector_isbitmappixelformatsupported.md) to test whether a given pixel format is supported. ## -examples ## -see-also [DetectFacesAsync(SoftwareBitmap, BitmapBounds)](facedetector_detectfacesasync_194268695.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync + +## -description +Asynchronously detects faces in the provided [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md). + +## -parameters +### -param image +The image data to be processed for face detection. + +## -returns +An asynchronous operation that returns a list of [DetectedFace](detectedface.md) objects upon successful completion. + +## -remarks +The provided [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) must be in a supported pixel format for this method and its overloads. Use [GetSupportedBitmapPixelFormats](facedetector_getsupportedbitmappixelformats.md) to retrieve a list of supported pixel formats for the current device. Use [IsBitmapPixelFormatSupported](facedetector_isbitmappixelformatsupported.md) to test whether a given pixel format is supported. + +## -examples + +## -see-also +[DetectFacesAsync(SoftwareBitmap, BitmapBounds)](facedetector_detectfacesasync_194268695.md) \ No newline at end of file diff --git a/windows.media.faceanalysis/facedetector_detectfacesasync_194268695.md b/windows.media.faceanalysis/facedetector_detectfacesasync_194268695.md index 1fdac46a9e..5541818559 100644 --- a/windows.media.faceanalysis/facedetector_detectfacesasync_194268695.md +++ b/windows.media.faceanalysis/facedetector_detectfacesasync_194268695.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Graphics.Imaging.BitmapBounds) --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync ## -description Asynchronously detects faces in the provided [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) within the specified search area. ## -parameters ### -param image The image data to be processed for face detection. ### -param searchArea The bounds within the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) in which face detection will be performed. ## -returns An asynchronous operation that returns a list of [DetectedFace](detectedface.md) objects upon successful completion. ## -remarks ## -examples ## -see-also [DetectFacesAsync(SoftwareBitmap)](facedetector_detectfacesasync_1738906219.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync(Windows.Graphics.Imaging.SoftwareBitmap,Windows.Graphics.Imaging.BitmapBounds) +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.DetectFacesAsync + +## -description +Asynchronously detects faces in the provided [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) within the specified search area. + +## -parameters +### -param image +The image data to be processed for face detection. + +### -param searchArea +The bounds within the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) in which face detection will be performed. + +## -returns +An asynchronous operation that returns a list of [DetectedFace](detectedface.md) objects upon successful completion. + +## -remarks + +## -examples + +## -see-also +[DetectFacesAsync(SoftwareBitmap)](facedetector_detectfacesasync_1738906219.md) \ No newline at end of file diff --git a/windows.media.faceanalysis/facedetector_getsupportedbitmappixelformats_1649246406.md b/windows.media.faceanalysis/facedetector_getsupportedbitmappixelformats_1649246406.md index 8d7b0958c0..7e93674759 100644 --- a/windows.media.faceanalysis/facedetector_getsupportedbitmappixelformats_1649246406.md +++ b/windows.media.faceanalysis/facedetector_getsupportedbitmappixelformats_1649246406.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceDetector.GetSupportedBitmapPixelFormats --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceDetector.GetSupportedBitmapPixelFormats ## -description Returns a list of the bitmap pixels formats supported by the [FaceDetector](facedetector.md) on the current device. ## -returns A list of the bitmap pixels formats supported by the [FaceDetector](facedetector.md) on the current device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceDetector.GetSupportedBitmapPixelFormats +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.GetSupportedBitmapPixelFormats + +## -description +Returns a list of the bitmap pixels formats supported by the [FaceDetector](facedetector.md) on the current device. + +## -returns +A list of the bitmap pixels formats supported by the [FaceDetector](facedetector.md) on the current device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facedetector_isbitmappixelformatsupported_1650024551.md b/windows.media.faceanalysis/facedetector_isbitmappixelformatsupported_1650024551.md index a90ede9962..47abdd1cb0 100644 --- a/windows.media.faceanalysis/facedetector_isbitmappixelformatsupported_1650024551.md +++ b/windows.media.faceanalysis/facedetector_isbitmappixelformatsupported_1650024551.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceDetector.IsBitmapPixelFormatSupported(Windows.Graphics.Imaging.BitmapPixelFormat) --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceDetector.IsBitmapPixelFormatSupported ## -description Queries whether the specified bitmap pixel format is supported by the [FaceDetector](facedetector.md) on the current device. ## -parameters ### -param bitmapPixelFormat The bitmap pixel format for which support is queried. ## -returns True if the specified bitmap pixel format is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceDetector.IsBitmapPixelFormatSupported(Windows.Graphics.Imaging.BitmapPixelFormat) +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.IsBitmapPixelFormatSupported + +## -description +Queries whether the specified bitmap pixel format is supported by the [FaceDetector](facedetector.md) on the current device. + +## -parameters +### -param bitmapPixelFormat +The bitmap pixel format for which support is queried. + +## -returns +True if the specified bitmap pixel format is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facedetector_issupported.md b/windows.media.faceanalysis/facedetector_issupported.md index 40fc0c7a81..83ebd8d82e 100644 --- a/windows.media.faceanalysis/facedetector_issupported.md +++ b/windows.media.faceanalysis/facedetector_issupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.FaceDetector.IsSupported --api-type: winrt property ---- # Windows.Media.FaceAnalysis.FaceDetector.IsSupported ## -description Gets a value indicating whether the [FaceDetector](facedetector.md) class is supported on the current device. ## -property-value True if [FaceDetector](facedetector.md); otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.FaceDetector.IsSupported +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.IsSupported + +## -description +Gets a value indicating whether the [FaceDetector](facedetector.md) class is supported on the current device. + +## -property-value +True if [FaceDetector](facedetector.md); otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facedetector_maxdetectablefacesize.md b/windows.media.faceanalysis/facedetector_maxdetectablefacesize.md index 836d5a12a1..6b7ff3e059 100644 --- a/windows.media.faceanalysis/facedetector_maxdetectablefacesize.md +++ b/windows.media.faceanalysis/facedetector_maxdetectablefacesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.FaceDetector.MaxDetectableFaceSize --api-type: winrt property ---- # Windows.Media.FaceAnalysis.FaceDetector.MaxDetectableFaceSize ## -description Gets or sets the maximum detectable face size, in pixels. ## -property-value The maximum detectable face size, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.FaceDetector.MaxDetectableFaceSize +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.MaxDetectableFaceSize + +## -description +Gets or sets the maximum detectable face size, in pixels. + +## -property-value +The maximum detectable face size, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facedetector_mindetectablefacesize.md b/windows.media.faceanalysis/facedetector_mindetectablefacesize.md index e1fe5dbc03..63dbc06fa8 100644 --- a/windows.media.faceanalysis/facedetector_mindetectablefacesize.md +++ b/windows.media.faceanalysis/facedetector_mindetectablefacesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.FaceDetector.MinDetectableFaceSize --api-type: winrt property ---- # Windows.Media.FaceAnalysis.FaceDetector.MinDetectableFaceSize ## -description Gets or sets the minimum detectable face size, in pixels. ## -property-value The minimum detectable face size, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.FaceDetector.MinDetectableFaceSize +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.FaceDetector.MinDetectableFaceSize + +## -description +Gets or sets the minimum detectable face size, in pixels. + +## -property-value +The minimum detectable face size, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker.md b/windows.media.faceanalysis/facetracker.md index a83dfc388d..47f7247157 100644 --- a/windows.media.faceanalysis/facetracker.md +++ b/windows.media.faceanalysis/facetracker.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.FaceAnalysis.FaceTracker --api-type: winrt class ---- # Windows.Media.FaceAnalysis.FaceTracker ## -description Detects faces in [VideoFrame](../windows.media/videoframe.md) objects and tracks faces across subsequent video frames. ## -remarks ## -examples ## -see-also [Basic face tracking sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620513) \ No newline at end of file +--- +-api-id: T:Windows.Media.FaceAnalysis.FaceTracker +-api-type: winrt class +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker + +## -description +Detects faces in [VideoFrame](../windows.media/videoframe.md) objects and tracks faces across subsequent video frames. + +## -remarks + +## -examples + +## -see-also +[Basic face tracking sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620513) \ No newline at end of file diff --git a/windows.media.faceanalysis/facetracker_createasync_616540418.md b/windows.media.faceanalysis/facetracker_createasync_616540418.md index 91480b297c..3d74f8f413 100644 --- a/windows.media.faceanalysis/facetracker_createasync_616540418.md +++ b/windows.media.faceanalysis/facetracker_createasync_616540418.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceTracker.CreateAsync --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceTracker.CreateAsync ## -description Creates a new instance of the [FaceTracker](facetracker.md) class. ## -returns An asynchronous operation that returns a [FaceTracker](facetracker.md) instance upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceTracker.CreateAsync +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.CreateAsync + +## -description +Creates a new instance of the [FaceTracker](facetracker.md) class. + +## -returns +An asynchronous operation that returns a [FaceTracker](facetracker.md) instance upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker_getsupportedbitmappixelformats_1649246406.md b/windows.media.faceanalysis/facetracker_getsupportedbitmappixelformats_1649246406.md index c25b31b30f..0c386f4251 100644 --- a/windows.media.faceanalysis/facetracker_getsupportedbitmappixelformats_1649246406.md +++ b/windows.media.faceanalysis/facetracker_getsupportedbitmappixelformats_1649246406.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceTracker.GetSupportedBitmapPixelFormats --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceTracker.GetSupportedBitmapPixelFormats ## -description Returns a list of the bitmap pixels formats supported by the [FaceTracker](facetracker.md) on the current device. ## -returns A list of the bitmap pixels formats supported by the [FaceTracker](facetracker.md) on the current device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceTracker.GetSupportedBitmapPixelFormats +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.GetSupportedBitmapPixelFormats + +## -description +Returns a list of the bitmap pixels formats supported by the [FaceTracker](facetracker.md) on the current device. + +## -returns +A list of the bitmap pixels formats supported by the [FaceTracker](facetracker.md) on the current device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker_isbitmappixelformatsupported_1650024551.md b/windows.media.faceanalysis/facetracker_isbitmappixelformatsupported_1650024551.md index 489ba9de9f..65b96c3fb0 100644 --- a/windows.media.faceanalysis/facetracker_isbitmappixelformatsupported_1650024551.md +++ b/windows.media.faceanalysis/facetracker_isbitmappixelformatsupported_1650024551.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceTracker.IsBitmapPixelFormatSupported(Windows.Graphics.Imaging.BitmapPixelFormat) --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceTracker.IsBitmapPixelFormatSupported ## -description Queries whether the specified bitmap pixel format is supported by the [FaceTracker](facetracker.md) on the current device. ## -parameters ### -param bitmapPixelFormat The bitmap pixel format for which support is queried. ## -returns True if the specified bitmap pixel format is supported; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceTracker.IsBitmapPixelFormatSupported(Windows.Graphics.Imaging.BitmapPixelFormat) +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.IsBitmapPixelFormatSupported + +## -description +Queries whether the specified bitmap pixel format is supported by the [FaceTracker](facetracker.md) on the current device. + +## -parameters +### -param bitmapPixelFormat +The bitmap pixel format for which support is queried. + +## -returns +True if the specified bitmap pixel format is supported; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker_issupported.md b/windows.media.faceanalysis/facetracker_issupported.md index f3b546fb15..9601586f7a 100644 --- a/windows.media.faceanalysis/facetracker_issupported.md +++ b/windows.media.faceanalysis/facetracker_issupported.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.FaceTracker.IsSupported --api-type: winrt property ---- # Windows.Media.FaceAnalysis.FaceTracker.IsSupported ## -description Gets a value indicating whether the [FaceTracker](facetracker.md) class is supported on the current device. ## -property-value True if [FaceTracker](facetracker.md); otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.FaceTracker.IsSupported +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.IsSupported + +## -description +Gets a value indicating whether the [FaceTracker](facetracker.md) class is supported on the current device. + +## -property-value +True if [FaceTracker](facetracker.md); otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker_maxdetectablefacesize.md b/windows.media.faceanalysis/facetracker_maxdetectablefacesize.md index 20ee14dd28..1058f44224 100644 --- a/windows.media.faceanalysis/facetracker_maxdetectablefacesize.md +++ b/windows.media.faceanalysis/facetracker_maxdetectablefacesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.FaceTracker.MaxDetectableFaceSize --api-type: winrt property ---- # Windows.Media.FaceAnalysis.FaceTracker.MaxDetectableFaceSize ## -description Gets or sets the maximum detectable face size, in pixels. ## -property-value The maximum detectable face size, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.FaceTracker.MaxDetectableFaceSize +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.MaxDetectableFaceSize + +## -description +Gets or sets the maximum detectable face size, in pixels. + +## -property-value +The maximum detectable face size, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker_mindetectablefacesize.md b/windows.media.faceanalysis/facetracker_mindetectablefacesize.md index 5b34a3b6fc..b64c0df6e4 100644 --- a/windows.media.faceanalysis/facetracker_mindetectablefacesize.md +++ b/windows.media.faceanalysis/facetracker_mindetectablefacesize.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.FaceAnalysis.FaceTracker.MinDetectableFaceSize --api-type: winrt property ---- # Windows.Media.FaceAnalysis.FaceTracker.MinDetectableFaceSize ## -description Gets or sets the minimum detectable face size, in pixels. ## -property-value The minimum detectable face size, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.FaceAnalysis.FaceTracker.MinDetectableFaceSize +-api-type: winrt property +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.MinDetectableFaceSize + +## -description +Gets or sets the minimum detectable face size, in pixels. + +## -property-value +The minimum detectable face size, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.faceanalysis/facetracker_processnextframeasync_1701395250.md b/windows.media.faceanalysis/facetracker_processnextframeasync_1701395250.md index 174d13e6d0..13f30c5917 100644 --- a/windows.media.faceanalysis/facetracker_processnextframeasync_1701395250.md +++ b/windows.media.faceanalysis/facetracker_processnextframeasync_1701395250.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.FaceAnalysis.FaceTracker.ProcessNextFrameAsync(Windows.Media.VideoFrame) --api-type: winrt method ---- # Windows.Media.FaceAnalysis.FaceTracker.ProcessNextFrameAsync ## -description Asynchronously processes a [VideoFrame](../windows.media/videoframe.md) for face detection. ## -parameters ### -param videoFrame The [VideoFrame](../windows.media/videoframe.md) in which faces are detected or tracked. ## -returns An asynchronous operation that returns a list of [DetectedFace](detectedface.md) objects upon successful completion. ## -remarks The provided [SoftwareBitmap](../windows.media/videoframe_softwarebitmap.md) must be in a supported pixel format. Use [GetSupportedBitmapPixelFormats](facetracker_getsupportedbitmappixelformats.md) to retrieve a list of supported pixel formats for the current device. Use [IsBitmapPixelFormatSupported](facetracker_isbitmappixelformatsupported.md) to test whether a given pixel format is supported. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.FaceAnalysis.FaceTracker.ProcessNextFrameAsync(Windows.Media.VideoFrame) +-api-type: winrt method +--- + + + +# Windows.Media.FaceAnalysis.FaceTracker.ProcessNextFrameAsync + +## -description +Asynchronously processes a [VideoFrame](../windows.media/videoframe.md) for face detection. + +## -parameters +### -param videoFrame +The [VideoFrame](../windows.media/videoframe.md) in which faces are detected or tracked. + +## -returns +An asynchronous operation that returns a list of [DetectedFace](detectedface.md) objects upon successful completion. + +## -remarks +The provided [SoftwareBitmap](../windows.media/videoframe_softwarebitmap.md) must be in a supported pixel format. Use [GetSupportedBitmapPixelFormats](facetracker_getsupportedbitmappixelformats.md) to retrieve a list of supported pixel formats for the current device. Use [IsBitmapPixelFormatSupported](facetracker_isbitmappixelformatsupported.md) to test whether a given pixel format is supported. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult.md index 88076e66df..7574bc1f71 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult --api-type: winrt class ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult ## -description Represents the result of a operation that deletes imported media items from the source. ## -remarks Get an instance of this class by calling [PhotoImportOperation.ContinueDeletingImportedItemsFromSourceAsync](photoimportoperation_continuedeletingimporteditemsfromsourceasync.md) or [PhotoImportItemsResult.DeleteImportedItemsFromSourceAsync](photoimportimportitemsresult_deleteimporteditemsfromsourceasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult + +## -description +Represents the result of a operation that deletes imported media items from the source. + +## -remarks +Get an instance of this class by calling [PhotoImportOperation.ContinueDeletingImportedItemsFromSourceAsync](photoimportoperation_continuedeletingimporteditemsfromsourceasync.md) or [PhotoImportItemsResult.DeleteImportedItemsFromSourceAsync](photoimportimportitemsresult_deleteimporteditemsfromsourceasync.md). + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_deleteditems.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_deleteditems.md index 60e62cdde8..28e89fd6ca 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_deleteditems.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_deleteditems.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.DeletedItems --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.DeletedItems ## -description Gets a list of items that were deleted from the source. ## -property-value A list of items that were deleted from the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.DeletedItems +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.DeletedItems + +## -description +Gets a list of items that were deleted from the source. + +## -property-value +A list of items that were deleted from the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_hassucceeded.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_hassucceeded.md index f626762b12..fe038984d6 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_hassucceeded.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_hassucceeded.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.HasSucceeded --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.HasSucceeded ## -description Gets a value indicating whether the delete operation has succeeded. ## -property-value True if the delete operation has succeeded; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.HasSucceeded +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.HasSucceeded + +## -description +Gets a value indicating whether the delete operation has succeeded. + +## -property-value +True if the delete operation has succeeded; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photoscount.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photoscount.md index d56111776c..d993a7f44e 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photoscount.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosCount ## -description Gets the number of photos deleted in the operation. ## -property-value The number of photos deleted in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosCount + +## -description +Gets the number of photos deleted in the operation. + +## -property-value +The number of photos deleted in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photossizeinbytes.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photossizeinbytes.md index 181ea66470..c1238d0916 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photossizeinbytes.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_photossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosSizeInBytes ## -description Gets the size of the deleted photos, in bytes. ## -property-value The size of the deleted photos, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.PhotosSizeInBytes + +## -description +Gets the size of the deleted photos, in bytes. + +## -property-value +The size of the deleted photos, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_session.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_session.md index e402b91df8..a47509c004 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_session.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.Session --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.Session ## -description Gets the photo import session associated with the delete operation. ## -property-value The photo import session associated with the delete operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.Session +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.Session + +## -description +Gets the photo import session associated with the delete operation. + +## -property-value +The photo import session associated with the delete operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingscount.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingscount.md index 9da70ecf20..a11e8557ad 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingscount.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsCount ## -description Gets the number of sibling files deleted in the operation. ## -property-value The number of sibling files deleted in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsCount + +## -description +Gets the number of sibling files deleted in the operation. + +## -property-value +The number of sibling files deleted in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingssizeinbytes.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingssizeinbytes.md index 563d5e848b..5ad3f59493 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingssizeinbytes.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_siblingssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsSizeInBytes ## -description Gets the size of the deleted sibling files, in bytes. ## -property-value The size of the deleted sibling files, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SiblingsSizeInBytes + +## -description +Gets the size of the deleted sibling files, in bytes. + +## -property-value +The size of the deleted sibling files, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarscount.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarscount.md index b0c4d4ceb5..a6c989e6f6 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarscount.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsCount ## -description Gets the number of sidecar files deleted in the operation. ## -property-value The number of sidecar files deleted in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsCount + +## -description +Gets the number of sidecar files deleted in the operation. + +## -property-value +The number of sidecar files deleted in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarssizeinbytes.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarssizeinbytes.md index 60ec2c4624..7c72d5dd4a 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarssizeinbytes.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_sidecarssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsSizeInBytes ## -description Gets the size of the deleted sidecar files, in bytes. ## -property-value The size of the deleted sidecar files, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.SidecarsSizeInBytes + +## -description +Gets the size of the deleted sidecar files, in bytes. + +## -property-value +The size of the deleted sidecar files, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalcount.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalcount.md index 61b9078e3d..3583ea53d6 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalcount.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalCount ## -description Gets the total number of items deleted in the operation. ## -property-value The total number of items deleted in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalCount + +## -description +Gets the total number of items deleted in the operation. + +## -property-value +The total number of items deleted in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalsizeinbytes.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalsizeinbytes.md index a60d1d0cfe..5d19ea51b3 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalsizeinbytes.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_totalsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalSizeInBytes ## -description Gets the total size of the all deleted items, in bytes. ## -property-value The total size of the all deleted items, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.TotalSizeInBytes + +## -description +Gets the total size of the all deleted items, in bytes. + +## -property-value +The total size of the all deleted items, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videoscount.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videoscount.md index 0aa6707d23..23e30f80c4 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videoscount.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosCount ## -description Gets the number of videos deleted in the operation. ## -property-value The number of videos deleted in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosCount + +## -description +Gets the number of videos deleted in the operation. + +## -property-value +The number of videos deleted in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videossizeinbytes.md b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videossizeinbytes.md index feececaf86..75f29d2530 100644 --- a/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videossizeinbytes.md +++ b/windows.media.import/photoimportdeleteimporteditemsfromsourceresult_videossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosSizeInBytes ## -description Gets the size of the deleted videos, in bytes. ## -property-value The size of the deleted videos, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportDeleteImportedItemsFromSourceResult.VideosSizeInBytes + +## -description +Gets the size of the deleted videos, in bytes. + +## -property-value +The size of the deleted videos, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult.md b/windows.media.import/photoimportfinditemsresult.md index 18cd812114..e263f041c3 100644 --- a/windows.media.import/photoimportfinditemsresult.md +++ b/windows.media.import/photoimportfinditemsresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportFindItemsResult --api-type: winrt class ---- # Windows.Media.Import.PhotoImportFindItemsResult ## -description Represents the result of a operation that finds media items on a source. ## -remarks Get an instance of this class by calling [PhotoImportSession.FindItemsAsync](photoimportsession_finditemsasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportFindItemsResult +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult + +## -description +Represents the result of a operation that finds media items on a source. + +## -remarks +Get an instance of this class by calling [PhotoImportSession.FindItemsAsync](photoimportsession_finditemsasync.md). + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_founditems.md b/windows.media.import/photoimportfinditemsresult_founditems.md index 078b8a8970..108ea58667 100644 --- a/windows.media.import/photoimportfinditemsresult_founditems.md +++ b/windows.media.import/photoimportfinditemsresult_founditems.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.FoundItems --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.FoundItems ## -description Gets a list of items that were found on the source. ## -property-value A list of items that were found on the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.FoundItems +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.FoundItems + +## -description +Gets a list of items that were found on the source. + +## -property-value +A list of items that were found on the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_hassucceeded.md b/windows.media.import/photoimportfinditemsresult_hassucceeded.md index f45d9567ee..db88d77f7f 100644 --- a/windows.media.import/photoimportfinditemsresult_hassucceeded.md +++ b/windows.media.import/photoimportfinditemsresult_hassucceeded.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.HasSucceeded --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.HasSucceeded ## -description Gets a value indicating whether the find operation has succeeded. ## -property-value True if the find operation has succeeded; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.HasSucceeded +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.HasSucceeded + +## -description +Gets a value indicating whether the find operation has succeeded. + +## -property-value +True if the find operation has succeeded; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_importitemsasync_357096682.md b/windows.media.import/photoimportfinditemsresult_importitemsasync_357096682.md index 20c3984822..1d1177480c 100644 --- a/windows.media.import/photoimportfinditemsresult_importitemsasync_357096682.md +++ b/windows.media.import/photoimportfinditemsresult_importitemsasync_357096682.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.ImportItemsAsync --api-type: winrt method ---- # Windows.Media.Import.PhotoImportFindItemsResult.ImportItemsAsync ## -description Asynchronously imports the selected items from the source. ## -returns An asynchronous operation that returns a [PhotoImportImportItemsResult](photoimportimportitemsresult.md) on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.ImportItemsAsync +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.ImportItemsAsync + +## -description +Asynchronously imports the selected items from the source. + +## -returns +An asynchronous operation that returns a [PhotoImportImportItemsResult](photoimportimportitemsresult.md) on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_importmode.md b/windows.media.import/photoimportfinditemsresult_importmode.md index e03f9cfcca..fc4edabe3f 100644 --- a/windows.media.import/photoimportfinditemsresult_importmode.md +++ b/windows.media.import/photoimportfinditemsresult_importmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.ImportMode --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.ImportMode ## -description Gets the photo import mode that determines which types of files are included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -property-value The photo import mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.ImportMode +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.ImportMode + +## -description +Gets the photo import mode that determines which types of files are included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -property-value +The photo import mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_itemimported.md b/windows.media.import/photoimportfinditemsresult_itemimported.md index 02bd5b45e2..4fd604d624 100644 --- a/windows.media.import/photoimportfinditemsresult_itemimported.md +++ b/windows.media.import/photoimportfinditemsresult_itemimported.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Import.PhotoImportFindItemsResult.ItemImported --api-type: winrt event ---- # Windows.Media.Import.PhotoImportFindItemsResult.ItemImported ## -description Occurs when an item is imported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Import.PhotoImportFindItemsResult.ItemImported +-api-type: winrt event +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.ItemImported + +## -description +Occurs when an item is imported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_photoscount.md b/windows.media.import/photoimportfinditemsresult_photoscount.md index 450cb0e975..e5b91cef02 100644 --- a/windows.media.import/photoimportfinditemsresult_photoscount.md +++ b/windows.media.import/photoimportfinditemsresult_photoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.PhotosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.PhotosCount ## -description Gets the number of photos found on the source. ## -property-value The number of photos found on the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.PhotosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.PhotosCount + +## -description +Gets the number of photos found on the source. + +## -property-value +The number of photos found on the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_photossizeinbytes.md b/windows.media.import/photoimportfinditemsresult_photossizeinbytes.md index 211e0baf3a..2a48bf45fd 100644 --- a/windows.media.import/photoimportfinditemsresult_photossizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_photossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.PhotosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.PhotosSizeInBytes ## -description Gets the size of the photos found on the source, in bytes. ## -property-value The size of the found photos, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.PhotosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.PhotosSizeInBytes + +## -description +Gets the size of the photos found on the source, in bytes. + +## -property-value +The size of the found photos, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectall_1125513670.md b/windows.media.import/photoimportfinditemsresult_selectall_1125513670.md index 3ed548eaa4..31a61d5e70 100644 --- a/windows.media.import/photoimportfinditemsresult_selectall_1125513670.md +++ b/windows.media.import/photoimportfinditemsresult_selectall_1125513670.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SelectAll --api-type: winrt method ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectAll ## -description Selects all items found on the source to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SelectAll +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectAll + +## -description +Selects all items found on the source to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedphotoscount.md b/windows.media.import/photoimportfinditemsresult_selectedphotoscount.md index 0253e7bec7..714e3913e1 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedphotoscount.md +++ b/windows.media.import/photoimportfinditemsresult_selectedphotoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosCount ## -description Gets the number of photos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -property-value The number of photos that are currently selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosCount + +## -description +Gets the number of photos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -property-value +The number of photos that are currently selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedphotossizeinbytes.md b/windows.media.import/photoimportfinditemsresult_selectedphotossizeinbytes.md index 53b04a88a9..20e880ae4f 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedphotossizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_selectedphotossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosSizeInBytes ## -description Gets the size of the photos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. ## -property-value The size of the photos that are currently selected, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedPhotosSizeInBytes + +## -description +Gets the size of the photos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. + +## -property-value +The size of the photos that are currently selected, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedsiblingscount.md b/windows.media.import/photoimportfinditemsresult_selectedsiblingscount.md index bba046bd09..d6036af030 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedsiblingscount.md +++ b/windows.media.import/photoimportfinditemsresult_selectedsiblingscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsCount ## -description Gets the number of sibling files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -property-value The number of sibling files that are currently selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsCount + +## -description +Gets the number of sibling files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -property-value +The number of sibling files that are currently selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedsiblingssizeinbytes.md b/windows.media.import/photoimportfinditemsresult_selectedsiblingssizeinbytes.md index 7f9ad3cf18..1849b00195 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedsiblingssizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_selectedsiblingssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsSizeInBytes ## -description Gets the size of the sibling files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. ## -property-value The size of the sibling files that are currently selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedSiblingsSizeInBytes + +## -description +Gets the size of the sibling files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. + +## -property-value +The size of the sibling files that are currently selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedsidecarscount.md b/windows.media.import/photoimportfinditemsresult_selectedsidecarscount.md index a1b7231a14..4c0d96cc49 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedsidecarscount.md +++ b/windows.media.import/photoimportfinditemsresult_selectedsidecarscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsCount ## -description Gets the number of sidecar files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -property-value The number of sidecar files that are currently selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsCount + +## -description +Gets the number of sidecar files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -property-value +The number of sidecar files that are currently selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedsidecarssizeinbytes.md b/windows.media.import/photoimportfinditemsresult_selectedsidecarssizeinbytes.md index aa9e5b171d..92d6b638c9 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedsidecarssizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_selectedsidecarssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsSizeInBytes ## -description Gets the size of the sidecar files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. ## -property-value The size of the sidecar files that are currently selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedSidecarsSizeInBytes + +## -description +Gets the size of the sidecar files that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. + +## -property-value +The size of the sidecar files that are currently selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedtotalcount.md b/windows.media.import/photoimportfinditemsresult_selectedtotalcount.md index 217e939f7c..3660ad965c 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedtotalcount.md +++ b/windows.media.import/photoimportfinditemsresult_selectedtotalcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalCount ## -description Gets the total number of items that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -property-value The total number of items that are currently selected ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalCount + +## -description +Gets the total number of items that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -property-value +The total number of items that are currently selected + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedtotalsizeinbytes.md b/windows.media.import/photoimportfinditemsresult_selectedtotalsizeinbytes.md index b9b9b63855..8650be006d 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedtotalsizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_selectedtotalsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalSizeInBytes ## -description Gets the total size of the all items that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. ## -property-value The total size of the all items that are currently selected, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedTotalSizeInBytes + +## -description +Gets the total size of the all items that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. + +## -property-value +The total size of the all items that are currently selected, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedvideoscount.md b/windows.media.import/photoimportfinditemsresult_selectedvideoscount.md index 4a284c7d97..91d03a9351 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedvideoscount.md +++ b/windows.media.import/photoimportfinditemsresult_selectedvideoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosCount ## -description Gets the number of videos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -property-value The number of videos that are currently selected. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosCount + +## -description +Gets the number of videos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -property-value +The number of videos that are currently selected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectedvideossizeinbytes.md b/windows.media.import/photoimportfinditemsresult_selectedvideossizeinbytes.md index 6a5f180579..434389926c 100644 --- a/windows.media.import/photoimportfinditemsresult_selectedvideossizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_selectedvideossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosSizeInBytes ## -description Gets the size of the videos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. ## -property-value The size of the videos that are currently selected, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectedVideosSizeInBytes + +## -description +Gets the size of the videos that are currently selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation, in bytes. + +## -property-value +The size of the videos that are currently selected, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectionchanged.md b/windows.media.import/photoimportfinditemsresult_selectionchanged.md index 4f294c882a..9b2e12ca24 100644 --- a/windows.media.import/photoimportfinditemsresult_selectionchanged.md +++ b/windows.media.import/photoimportfinditemsresult_selectionchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Import.PhotoImportFindItemsResult.SelectionChanged --api-type: winrt event ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectionChanged ## -description Occurs when the set of items selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Import.PhotoImportFindItemsResult.SelectionChanged +-api-type: winrt event +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectionChanged + +## -description +Occurs when the set of items selected to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectnewasync_706667921.md b/windows.media.import/photoimportfinditemsresult_selectnewasync_706667921.md index dd8ecf49b2..111afe1d51 100644 --- a/windows.media.import/photoimportfinditemsresult_selectnewasync_706667921.md +++ b/windows.media.import/photoimportfinditemsresult_selectnewasync_706667921.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SelectNewAsync --api-type: winrt method ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectNewAsync ## -description Selects all new items found on the source to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -returns An asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SelectNewAsync +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectNewAsync + +## -description +Selects all new items found on the source to be included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -returns +An asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_selectnone_1058918109.md b/windows.media.import/photoimportfinditemsresult_selectnone_1058918109.md index bfe0f852da..ce916cd16b 100644 --- a/windows.media.import/photoimportfinditemsresult_selectnone_1058918109.md +++ b/windows.media.import/photoimportfinditemsresult_selectnone_1058918109.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SelectNone --api-type: winrt method ---- # Windows.Media.Import.PhotoImportFindItemsResult.SelectNone ## -description Deselects all items found on the source, preventing them from being included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SelectNone +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SelectNone + +## -description +Deselects all items found on the source, preventing them from being included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_session.md b/windows.media.import/photoimportfinditemsresult_session.md index 877593a56b..c551d2e520 100644 --- a/windows.media.import/photoimportfinditemsresult_session.md +++ b/windows.media.import/photoimportfinditemsresult_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.Session --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.Session ## -description Gets the photo import session associated with the find operation. ## -property-value The photo import session associated with the find operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.Session +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.Session + +## -description +Gets the photo import session associated with the find operation. + +## -property-value +The photo import session associated with the find operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_setimportmode_1963382727.md b/windows.media.import/photoimportfinditemsresult_setimportmode_1963382727.md index 23e6ae2014..5b78d489af 100644 --- a/windows.media.import/photoimportfinditemsresult_setimportmode_1963382727.md +++ b/windows.media.import/photoimportfinditemsresult_setimportmode_1963382727.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SetImportMode(Windows.Media.Import.PhotoImportImportMode) --api-type: winrt method ---- # Windows.Media.Import.PhotoImportFindItemsResult.SetImportMode ## -description Sets the photo import mode that determines which types of files are included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. ## -parameters ### -param value The photo import mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.SetImportMode(Windows.Media.Import.PhotoImportImportMode) +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SetImportMode + +## -description +Sets the photo import mode that determines which types of files are included in the [ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) operation. + +## -parameters +### -param value +The photo import mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_siblingscount.md b/windows.media.import/photoimportfinditemsresult_siblingscount.md index 793ad7bc8e..1e8333fb4c 100644 --- a/windows.media.import/photoimportfinditemsresult_siblingscount.md +++ b/windows.media.import/photoimportfinditemsresult_siblingscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SiblingsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SiblingsCount ## -description Gets the number of sibling files found on the source. ## -property-value The number of sibling files found on the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SiblingsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SiblingsCount + +## -description +Gets the number of sibling files found on the source. + +## -property-value +The number of sibling files found on the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_siblingssizeinbytes.md b/windows.media.import/photoimportfinditemsresult_siblingssizeinbytes.md index 309dc6b230..6797246282 100644 --- a/windows.media.import/photoimportfinditemsresult_siblingssizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_siblingssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SiblingsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SiblingsSizeInBytes ## -description Gets the size of the found sibling files, in bytes. ## -property-value The size of the found sibling files, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SiblingsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SiblingsSizeInBytes + +## -description +Gets the size of the found sibling files, in bytes. + +## -property-value +The size of the found sibling files, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_sidecarscount.md b/windows.media.import/photoimportfinditemsresult_sidecarscount.md index ca114dbf84..0a3522710d 100644 --- a/windows.media.import/photoimportfinditemsresult_sidecarscount.md +++ b/windows.media.import/photoimportfinditemsresult_sidecarscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SidecarsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SidecarsCount ## -description Gets the number of sidecar files found on the source. ## -property-value The number of sidecar files found on the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SidecarsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SidecarsCount + +## -description +Gets the number of sidecar files found on the source. + +## -property-value +The number of sidecar files found on the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_sidecarssizeinbytes.md b/windows.media.import/photoimportfinditemsresult_sidecarssizeinbytes.md index d1bdda6bd3..8c681efe6d 100644 --- a/windows.media.import/photoimportfinditemsresult_sidecarssizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_sidecarssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SidecarsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.SidecarsSizeInBytes ## -description Gets the size of the found sidecar files, in bytes. ## -property-value The size of the found sidecar files, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.SidecarsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.SidecarsSizeInBytes + +## -description +Gets the size of the found sidecar files, in bytes. + +## -property-value +The size of the found sidecar files, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_totalcount.md b/windows.media.import/photoimportfinditemsresult_totalcount.md index ab76310030..19eb0ebd83 100644 --- a/windows.media.import/photoimportfinditemsresult_totalcount.md +++ b/windows.media.import/photoimportfinditemsresult_totalcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.TotalCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.TotalCount ## -description Gets the total number of items found on the source. ## -property-value The total number of items found on the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.TotalCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.TotalCount + +## -description +Gets the total number of items found on the source. + +## -property-value +The total number of items found on the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_totalsizeinbytes.md b/windows.media.import/photoimportfinditemsresult_totalsizeinbytes.md index 397029b08c..b68eb2c357 100644 --- a/windows.media.import/photoimportfinditemsresult_totalsizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_totalsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.TotalSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.TotalSizeInBytes ## -description Gets the total size of all items found on the source, in bytes. ## -property-value The total size of all items found on the source, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.TotalSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.TotalSizeInBytes + +## -description +Gets the total size of all items found on the source, in bytes. + +## -property-value +The total size of all items found on the source, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_videoscount.md b/windows.media.import/photoimportfinditemsresult_videoscount.md index c1401ad9aa..8b9c603edf 100644 --- a/windows.media.import/photoimportfinditemsresult_videoscount.md +++ b/windows.media.import/photoimportfinditemsresult_videoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.VideosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.VideosCount ## -description Gets the number of videos found on the source. ## -property-value The number of videos found on the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.VideosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.VideosCount + +## -description +Gets the number of videos found on the source. + +## -property-value +The number of videos found on the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_videossizeinbytes.md b/windows.media.import/photoimportfinditemsresult_videossizeinbytes.md index f534bd6177..cf0e27b740 100644 --- a/windows.media.import/photoimportfinditemsresult_videossizeinbytes.md +++ b/windows.media.import/photoimportfinditemsresult_videossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.VideosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportFindItemsResult.VideosSizeInBytes ## -description Gets the size of the videos found on the source, in bytes. ## -property-value The size of the found videos, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportFindItemsResult.VideosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.VideosSizeInBytes + +## -description +Gets the size of the videos found on the source, in bytes. + +## -property-value +The size of the found videos, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult.md b/windows.media.import/photoimportimportitemsresult.md index 9f5e97f0ff..2d5159f5f0 100644 --- a/windows.media.import/photoimportimportitemsresult.md +++ b/windows.media.import/photoimportimportitemsresult.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportImportItemsResult --api-type: winrt class ---- # Windows.Media.Import.PhotoImportImportItemsResult ## -description Represents the result of a operation that imports media items from the source. ## -remarks Get an instance of this class by calling [PhotoImportFindItemsResult.ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) or [PhotoImportOperation.ContinueImportingItemsAsync](photoimportoperation_continueimportingitemsasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportImportItemsResult +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult + +## -description +Represents the result of a operation that imports media items from the source. + +## -remarks +Get an instance of this class by calling [PhotoImportFindItemsResult.ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) or [PhotoImportOperation.ContinueImportingItemsAsync](photoimportoperation_continueimportingitemsasync.md). + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_deleteimporteditemsfromsourceasync_1949343605.md b/windows.media.import/photoimportimportitemsresult_deleteimporteditemsfromsourceasync_1949343605.md index f78f720422..22c5a351b2 100644 --- a/windows.media.import/photoimportimportitemsresult_deleteimporteditemsfromsourceasync_1949343605.md +++ b/windows.media.import/photoimportimportitemsresult_deleteimporteditemsfromsourceasync_1949343605.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportImportItemsResult.DeleteImportedItemsFromSourceAsync --api-type: winrt method ---- # Windows.Media.Import.PhotoImportImportItemsResult.DeleteImportedItemsFromSourceAsync ## -description Asynchronously deletes the items that were imported from the source. ## -returns An asynchronous operation that returns a [PhotoImportDeleteImportedItemsFromSourceResult](photoimportdeleteimporteditemsfromsourceresult.md) on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportImportItemsResult.DeleteImportedItemsFromSourceAsync +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.DeleteImportedItemsFromSourceAsync + +## -description +Asynchronously deletes the items that were imported from the source. + +## -returns +An asynchronous operation that returns a [PhotoImportDeleteImportedItemsFromSourceResult](photoimportdeleteimporteditemsfromsourceresult.md) on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_hassucceeded.md b/windows.media.import/photoimportimportitemsresult_hassucceeded.md index f6582426d0..f1dab56551 100644 --- a/windows.media.import/photoimportimportitemsresult_hassucceeded.md +++ b/windows.media.import/photoimportimportitemsresult_hassucceeded.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.HasSucceeded --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.HasSucceeded ## -description Gets a value indicating whether the import operation has succeeded. ## -property-value True if the import operation has succeeded; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.HasSucceeded +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.HasSucceeded + +## -description +Gets a value indicating whether the import operation has succeeded. + +## -property-value +True if the import operation has succeeded; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_importeditems.md b/windows.media.import/photoimportimportitemsresult_importeditems.md index a8aba98d29..44bc536607 100644 --- a/windows.media.import/photoimportimportitemsresult_importeditems.md +++ b/windows.media.import/photoimportimportitemsresult_importeditems.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.ImportedItems --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.ImportedItems ## -description Gets a list of items that were imported from the source. ## -property-value A list of items that were imported from the source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.ImportedItems +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.ImportedItems + +## -description +Gets a list of items that were imported from the source. + +## -property-value +A list of items that were imported from the source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_photoscount.md b/windows.media.import/photoimportimportitemsresult_photoscount.md index 7591302f93..dd320655e5 100644 --- a/windows.media.import/photoimportimportitemsresult_photoscount.md +++ b/windows.media.import/photoimportimportitemsresult_photoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.PhotosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.PhotosCount ## -description Gets the number of photos imported in the operation. ## -property-value The number of photos imported in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.PhotosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.PhotosCount + +## -description +Gets the number of photos imported in the operation. + +## -property-value +The number of photos imported in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_photossizeinbytes.md b/windows.media.import/photoimportimportitemsresult_photossizeinbytes.md index 3900d95603..d8875eb9fe 100644 --- a/windows.media.import/photoimportimportitemsresult_photossizeinbytes.md +++ b/windows.media.import/photoimportimportitemsresult_photossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.PhotosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.PhotosSizeInBytes ## -description Gets the size of the imported photos, in bytes. ## -property-value The size of the imported photos, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.PhotosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.PhotosSizeInBytes + +## -description +Gets the size of the imported photos, in bytes. + +## -property-value +The size of the imported photos, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_session.md b/windows.media.import/photoimportimportitemsresult_session.md index 2f4424cbd6..c2f0c73d40 100644 --- a/windows.media.import/photoimportimportitemsresult_session.md +++ b/windows.media.import/photoimportimportitemsresult_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.Session --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.Session ## -description Gets the photo import session associated with the import operation. ## -property-value The photo import session associated with the import operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.Session +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.Session + +## -description +Gets the photo import session associated with the import operation. + +## -property-value +The photo import session associated with the import operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_siblingscount.md b/windows.media.import/photoimportimportitemsresult_siblingscount.md index 802b15499d..1a1457657a 100644 --- a/windows.media.import/photoimportimportitemsresult_siblingscount.md +++ b/windows.media.import/photoimportimportitemsresult_siblingscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SiblingsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.SiblingsCount ## -description Gets the number of sibling files imported in the operation. ## -property-value The number of sibling files imported in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SiblingsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.SiblingsCount + +## -description +Gets the number of sibling files imported in the operation. + +## -property-value +The number of sibling files imported in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_siblingssizeinbytes.md b/windows.media.import/photoimportimportitemsresult_siblingssizeinbytes.md index 51980ce074..7c4a29a88f 100644 --- a/windows.media.import/photoimportimportitemsresult_siblingssizeinbytes.md +++ b/windows.media.import/photoimportimportitemsresult_siblingssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SiblingsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.SiblingsSizeInBytes ## -description Gets the size of the imported sidecar files, in bytes. ## -property-value The size of the imported sidecar files, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SiblingsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.SiblingsSizeInBytes + +## -description +Gets the size of the imported sidecar files, in bytes. + +## -property-value +The size of the imported sidecar files, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_sidecarscount.md b/windows.media.import/photoimportimportitemsresult_sidecarscount.md index 24600ee82f..f6013f9fe7 100644 --- a/windows.media.import/photoimportimportitemsresult_sidecarscount.md +++ b/windows.media.import/photoimportimportitemsresult_sidecarscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SidecarsCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.SidecarsCount ## -description Gets the number of sidecar files imported in the operation. ## -property-value The number of sidecar files imported in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SidecarsCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.SidecarsCount + +## -description +Gets the number of sidecar files imported in the operation. + +## -property-value +The number of sidecar files imported in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_sidecarssizeinbytes.md b/windows.media.import/photoimportimportitemsresult_sidecarssizeinbytes.md index ffd3ecf065..b50a09f992 100644 --- a/windows.media.import/photoimportimportitemsresult_sidecarssizeinbytes.md +++ b/windows.media.import/photoimportimportitemsresult_sidecarssizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SidecarsSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.SidecarsSizeInBytes ## -description Gets the size of the imported sidecar files, in bytes. ## -property-value The size of the imported sidecar files, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.SidecarsSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.SidecarsSizeInBytes + +## -description +Gets the size of the imported sidecar files, in bytes. + +## -property-value +The size of the imported sidecar files, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_totalcount.md b/windows.media.import/photoimportimportitemsresult_totalcount.md index 529f598f8e..0c91bc1abb 100644 --- a/windows.media.import/photoimportimportitemsresult_totalcount.md +++ b/windows.media.import/photoimportimportitemsresult_totalcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.TotalCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.TotalCount ## -description Gets the total number of items imported in the operation. ## -property-value The total number of items imported in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.TotalCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.TotalCount + +## -description +Gets the total number of items imported in the operation. + +## -property-value +The total number of items imported in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_totalsizeinbytes.md b/windows.media.import/photoimportimportitemsresult_totalsizeinbytes.md index 9350b3c033..4d66f1edc7 100644 --- a/windows.media.import/photoimportimportitemsresult_totalsizeinbytes.md +++ b/windows.media.import/photoimportimportitemsresult_totalsizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.TotalSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.TotalSizeInBytes ## -description Gets the total size of the all imported items, in bytes. ## -property-value The total size of the all imported items, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.TotalSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.TotalSizeInBytes + +## -description +Gets the total size of the all imported items, in bytes. + +## -property-value +The total size of the all imported items, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_videoscount.md b/windows.media.import/photoimportimportitemsresult_videoscount.md index dbe2921402..9ec122490c 100644 --- a/windows.media.import/photoimportimportitemsresult_videoscount.md +++ b/windows.media.import/photoimportimportitemsresult_videoscount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.VideosCount --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.VideosCount ## -description Gets the number of videos imported in the operation. ## -property-value The number of videos imported in the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.VideosCount +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.VideosCount + +## -description +Gets the number of videos imported in the operation. + +## -property-value +The number of videos imported in the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportimportitemsresult_videossizeinbytes.md b/windows.media.import/photoimportimportitemsresult_videossizeinbytes.md index dd297aba1e..a2aa435a68 100644 --- a/windows.media.import/photoimportimportitemsresult_videossizeinbytes.md +++ b/windows.media.import/photoimportimportitemsresult_videossizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.VideosSizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportImportItemsResult.VideosSizeInBytes ## -description Gets the size of the imported videos, in bytes. ## -property-value The size of the imported videos, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportImportItemsResult.VideosSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportImportItemsResult.VideosSizeInBytes + +## -description +Gets the size of the imported videos, in bytes. + +## -property-value +The size of the imported videos, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem.md b/windows.media.import/photoimportitem.md index ba3db58f0c..61273a531d 100644 --- a/windows.media.import/photoimportitem.md +++ b/windows.media.import/photoimportitem.md @@ -1,3 +1,29 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportItem --api-type: winrt class ---- # Windows.Media.Import.PhotoImportItem ## -description Represents an media item that has been imported from a source. ## -remarks Get an instance of this class by calling one of the following methods. + [PhotoImportSession.FindItemsAsync](photoimportsession_finditemsasync.md) + [PhotoImportFindItemsResult.ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) + [DeleteImportedItemsFromSourceAsync](photoimportimportitemsresult_deleteimporteditemsfromsourceasync.md) Or, handle the [PhotoImportFindItemsResult.ItemImported](photoimportfinditemsresult_itemimported.md) event. For how-to guidance for adding media import to your app, see [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device). ## -examples ## -see-also [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device) \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportItem +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportItem + +## -description +Represents an media item that has been imported from a source. + +## -remarks +Get an instance of this class by calling one of the following methods. + + ++ [PhotoImportSession.FindItemsAsync](photoimportsession_finditemsasync.md) ++ [PhotoImportFindItemsResult.ImportItemsAsync](photoimportfinditemsresult_importitemsasync.md) ++ [DeleteImportedItemsFromSourceAsync](photoimportimportitemsresult_deleteimporteditemsfromsourceasync.md) +Or, handle the [PhotoImportFindItemsResult.ItemImported](photoimportfinditemsresult_itemimported.md) event. + +For how-to guidance for adding media import to your app, see [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device). + +## -examples + +## -see-also +[Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device) \ No newline at end of file diff --git a/windows.media.import/photoimportitem_contenttype.md b/windows.media.import/photoimportitem_contenttype.md index 10f1ba79fe..91aebaab0d 100644 --- a/windows.media.import/photoimportitem_contenttype.md +++ b/windows.media.import/photoimportitem_contenttype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.ContentType --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.ContentType ## -description Gets the content type of the imported item. ## -property-value The content type of the imported item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.ContentType +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.ContentType + +## -description +Gets the content type of the imported item. + +## -property-value +The content type of the imported item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_date.md b/windows.media.import/photoimportitem_date.md index c844103b4c..e03e074458 100644 --- a/windows.media.import/photoimportitem_date.md +++ b/windows.media.import/photoimportitem_date.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.Date --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.Date ## -description Gets the creation date of the imported item. ## -property-value The creation date of the imported item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.Date +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.Date + +## -description +Gets the creation date of the imported item. + +## -property-value +The creation date of the imported item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_deletedfilenames.md b/windows.media.import/photoimportitem_deletedfilenames.md index 48b64113e6..086f122ccf 100644 --- a/windows.media.import/photoimportitem_deletedfilenames.md +++ b/windows.media.import/photoimportitem_deletedfilenames.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.DeletedFileNames --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.DeletedFileNames ## -description Gets a list of the names of files associated with this item that were deleted. ## -property-value A list of the names of files associated with this item that were deleted. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.DeletedFileNames +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.DeletedFileNames + +## -description +Gets a list of the names of files associated with this item that were deleted. + +## -property-value +A list of the names of files associated with this item that were deleted. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_importedfilenames.md b/windows.media.import/photoimportitem_importedfilenames.md index 91704ed0b6..23f5cecb54 100644 --- a/windows.media.import/photoimportitem_importedfilenames.md +++ b/windows.media.import/photoimportitem_importedfilenames.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.ImportedFileNames --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.ImportedFileNames ## -description Gets a list of the names of files associated with this item that were imported. ## -property-value A list of the names of files associated with this item that were imported. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.ImportedFileNames +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.ImportedFileNames + +## -description +Gets a list of the names of files associated with this item that were imported. + +## -property-value +A list of the names of files associated with this item that were imported. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_isselected.md b/windows.media.import/photoimportitem_isselected.md index 90d26cb1ea..57cc7daac3 100644 --- a/windows.media.import/photoimportitem_isselected.md +++ b/windows.media.import/photoimportitem_isselected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.IsSelected --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.IsSelected ## -description Gets a value indicating whether the item is currently selected for import. ## -property-value True if the item is currently selected; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.IsSelected +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.IsSelected + +## -description +Gets a value indicating whether the item is currently selected for import. + +## -property-value +True if the item is currently selected; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_itemkey.md b/windows.media.import/photoimportitem_itemkey.md index d9c492e1cf..7f3c6180fe 100644 --- a/windows.media.import/photoimportitem_itemkey.md +++ b/windows.media.import/photoimportitem_itemkey.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.ItemKey --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.ItemKey ## -description Gets the key used to identify the item. ## -property-value The key used to identify the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.ItemKey +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.ItemKey + +## -description +Gets the key used to identify the item. + +## -property-value +The key used to identify the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_name.md b/windows.media.import/photoimportitem_name.md index f0239a8b14..a8ebbd7ade 100644 --- a/windows.media.import/photoimportitem_name.md +++ b/windows.media.import/photoimportitem_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.Name --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.Name ## -description Gets the name of the item. ## -property-value The name of the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.Name +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.Name + +## -description +Gets the name of the item. + +## -property-value +The name of the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_sibling.md b/windows.media.import/photoimportitem_sibling.md index 50916dcc70..0a41bf64c6 100644 --- a/windows.media.import/photoimportitem_sibling.md +++ b/windows.media.import/photoimportitem_sibling.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.Sibling --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.Sibling ## -description Gets the sibling file associated with the item, if one exists. ## -property-value The sibling file associated with the item ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.Sibling +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.Sibling + +## -description +Gets the sibling file associated with the item, if one exists. + +## -property-value +The sibling file associated with the item + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_sidecars.md b/windows.media.import/photoimportitem_sidecars.md index 8fa27470bb..9c6011bfae 100644 --- a/windows.media.import/photoimportitem_sidecars.md +++ b/windows.media.import/photoimportitem_sidecars.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.Sidecars --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.Sidecars ## -description Gets the list of sidecar files associated with the item, if any exists. ## -property-value The list of sidecar files associated with the item ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.Sidecars +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.Sidecars + +## -description +Gets the list of sidecar files associated with the item, if any exists. + +## -property-value +The list of sidecar files associated with the item + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_sizeinbytes.md b/windows.media.import/photoimportitem_sizeinbytes.md index e389c1f9e5..3a8841dc90 100644 --- a/windows.media.import/photoimportitem_sizeinbytes.md +++ b/windows.media.import/photoimportitem_sizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.SizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.SizeInBytes ## -description Gets the size of the item, in bytes. ## -property-value The size of the item, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.SizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.SizeInBytes + +## -description +Gets the size of the item, in bytes. + +## -property-value +The size of the item, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_thumbnail.md b/windows.media.import/photoimportitem_thumbnail.md index 7172e31159..eb9fe83301 100644 --- a/windows.media.import/photoimportitem_thumbnail.md +++ b/windows.media.import/photoimportitem_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.Thumbnail --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.Thumbnail ## -description Gets a random access stream containing the thumbnail image associated with the item. ## -property-value A random access stream containing the thumbnail image associated with the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.Thumbnail + +## -description +Gets a random access stream containing the thumbnail image associated with the item. + +## -property-value +A random access stream containing the thumbnail image associated with the item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitem_videosegments.md b/windows.media.import/photoimportitem_videosegments.md index dff6c98aa3..c503e4c65c 100644 --- a/windows.media.import/photoimportitem_videosegments.md +++ b/windows.media.import/photoimportitem_videosegments.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItem.VideoSegments --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItem.VideoSegments ## -description Gets the list of video segments associated with the item. ## -property-value The list of video segments associated with the item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItem.VideoSegments +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItem.VideoSegments + +## -description +Gets the list of video segments associated with the item. + +## -property-value +The list of video segments associated with the item. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitemimportedeventargs.md b/windows.media.import/photoimportitemimportedeventargs.md index fafe735bcc..0498b1ba29 100644 --- a/windows.media.import/photoimportitemimportedeventargs.md +++ b/windows.media.import/photoimportitemimportedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportItemImportedEventArgs --api-type: winrt class ---- # Windows.Media.Import.PhotoImportItemImportedEventArgs ## -description Provides data for the [PhotoImportFindItemsResult.ItemImported](photoimportfinditemsresult_itemimported.md) event. ## -remarks Get an instance of this class by handling the [PhotoImportFindItemsResult.ItemImported](photoimportfinditemsresult_itemimported.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportItemImportedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportItemImportedEventArgs + +## -description +Provides data for the [PhotoImportFindItemsResult.ItemImported](photoimportfinditemsresult_itemimported.md) event. + +## -remarks +Get an instance of this class by handling the [PhotoImportFindItemsResult.ItemImported](photoimportfinditemsresult_itemimported.md) event. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportitemimportedeventargs_importeditem.md b/windows.media.import/photoimportitemimportedeventargs_importeditem.md index 6f43b6c3ad..15a96b1a8e 100644 --- a/windows.media.import/photoimportitemimportedeventargs_importeditem.md +++ b/windows.media.import/photoimportitemimportedeventargs_importeditem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportItemImportedEventArgs.ImportedItem --api-type: winrt property ---- # Windows.Media.Import.PhotoImportItemImportedEventArgs.ImportedItem ## -description Gets the imported item associated with the [PhotoImportFindItemsResult::ItemImported](photoimportfinditemsresult_itemimported.md) event. ## -property-value The imported item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportItemImportedEventArgs.ImportedItem +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportItemImportedEventArgs.ImportedItem + +## -description +Gets the imported item associated with the [PhotoImportFindItemsResult::ItemImported](photoimportfinditemsresult_itemimported.md) event. + +## -property-value +The imported item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportmanager.md b/windows.media.import/photoimportmanager.md index 98a84093b9..0b2f7d51a9 100644 --- a/windows.media.import/photoimportmanager.md +++ b/windows.media.import/photoimportmanager.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportManager --api-type: winrt class ---- # Windows.Media.Import.PhotoImportManager ## -description Provides APIs for determining if photo import is supported on the current device, finding sources from which to import photos, and getting references to any pending photo import operations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportManager +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportManager + +## -description +Provides APIs for determining if photo import is supported on the current device, finding sources from which to import photos, and getting references to any pending photo import operations. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportmanager_findallsourcesasync_1269005394.md b/windows.media.import/photoimportmanager_findallsourcesasync_1269005394.md index 0ebbdf06fd..9701fb1ce8 100644 --- a/windows.media.import/photoimportmanager_findallsourcesasync_1269005394.md +++ b/windows.media.import/photoimportmanager_findallsourcesasync_1269005394.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportManager.FindAllSourcesAsync --api-type: winrt method ---- # Windows.Media.Import.PhotoImportManager.FindAllSourcesAsync ## -description Finds all currently available sources from which photos can be imported. ## -returns An asynchronous operation that returns a list of available sources on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportManager.FindAllSourcesAsync +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportManager.FindAllSourcesAsync + +## -description +Finds all currently available sources from which photos can be imported. + +## -returns +An asynchronous operation that returns a list of available sources on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportmanager_getpendingoperations_1715149755.md b/windows.media.import/photoimportmanager_getpendingoperations_1715149755.md index 5814d9e5d6..9d9061d3a1 100644 --- a/windows.media.import/photoimportmanager_getpendingoperations_1715149755.md +++ b/windows.media.import/photoimportmanager_getpendingoperations_1715149755.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportManager.GetPendingOperations --api-type: winrt method ---- # Windows.Media.Import.PhotoImportManager.GetPendingOperations ## -description Gets the list of all pending photo import operations. ## -returns The list of all pending photo operations. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportManager.GetPendingOperations +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportManager.GetPendingOperations + +## -description +Gets the list of all pending photo import operations. + +## -returns +The list of all pending photo operations. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportmanager_issupportedasync_2134939103.md b/windows.media.import/photoimportmanager_issupportedasync_2134939103.md index 8944802731..95b8d94967 100644 --- a/windows.media.import/photoimportmanager_issupportedasync_2134939103.md +++ b/windows.media.import/photoimportmanager_issupportedasync_2134939103.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportManager.IsSupportedAsync --api-type: winrt method ---- # Windows.Media.Import.PhotoImportManager.IsSupportedAsync ## -description Gets a value indicating if photo import is supported on the current device. ## -returns An asynchronous operation that returns true if photo import is supported. Otherwise, returns false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportManager.IsSupportedAsync +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportManager.IsSupportedAsync + +## -description +Gets a value indicating if photo import is supported on the current device. + +## -returns +An asynchronous operation that returns true if photo import is supported. Otherwise, returns false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportoperation.md b/windows.media.import/photoimportoperation.md index 519a5627c1..cb63176489 100644 --- a/windows.media.import/photoimportoperation.md +++ b/windows.media.import/photoimportoperation.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportOperation --api-type: winrt class ---- # Windows.Media.Import.PhotoImportOperation ## -description Represents an in-progress photo import operation. ## -remarks Get an instance of this class by calling [PhotoImportManager.GetPendingOperations](photoimportmanager_getpendingoperations.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportOperation +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportOperation + +## -description +Represents an in-progress photo import operation. + +## -remarks +Get an instance of this class by calling [PhotoImportManager.GetPendingOperations](photoimportmanager_getpendingoperations.md). + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportoperation_continuedeletingimporteditemsfromsourceasync.md b/windows.media.import/photoimportoperation_continuedeletingimporteditemsfromsourceasync.md index 354b76455f..9c0548c5c1 100644 --- a/windows.media.import/photoimportoperation_continuedeletingimporteditemsfromsourceasync.md +++ b/windows.media.import/photoimportoperation_continuedeletingimporteditemsfromsourceasync.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportOperation.ContinueDeletingImportedItemsFromSourceAsync --api-type: winrt property ---- # Windows.Media.Import.PhotoImportOperation.ContinueDeletingImportedItemsFromSourceAsync ## -description Causes in-progress delete from source operations to continue. ## -property-value An asynchronous operation that returns a [PhotoImportDeleteImportedItemsFromSourceResult](photoimportdeleteimporteditemsfromsourceresult.md) object on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportOperation.ContinueDeletingImportedItemsFromSourceAsync +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportOperation.ContinueDeletingImportedItemsFromSourceAsync + +## -description +Causes in-progress delete from source operations to continue. + +## -property-value +An asynchronous operation that returns a [PhotoImportDeleteImportedItemsFromSourceResult](photoimportdeleteimporteditemsfromsourceresult.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportoperation_continuefindingitemsasync.md b/windows.media.import/photoimportoperation_continuefindingitemsasync.md index 835975aa7d..002ddb978e 100644 --- a/windows.media.import/photoimportoperation_continuefindingitemsasync.md +++ b/windows.media.import/photoimportoperation_continuefindingitemsasync.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportOperation.ContinueFindingItemsAsync --api-type: winrt property ---- # Windows.Media.Import.PhotoImportOperation.ContinueFindingItemsAsync ## -description Causes in-progress find operations to continue. ## -property-value An asynchronous operation that returns a [PhotoImportFindItemsResult](photoimportfinditemsresult.md) object on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportOperation.ContinueFindingItemsAsync +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportOperation.ContinueFindingItemsAsync + +## -description +Causes in-progress find operations to continue. + +## -property-value +An asynchronous operation that returns a [PhotoImportFindItemsResult](photoimportfinditemsresult.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportoperation_continueimportingitemsasync.md b/windows.media.import/photoimportoperation_continueimportingitemsasync.md index 721b8c3cbc..8d5846bb6b 100644 --- a/windows.media.import/photoimportoperation_continueimportingitemsasync.md +++ b/windows.media.import/photoimportoperation_continueimportingitemsasync.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportOperation.ContinueImportingItemsAsync --api-type: winrt property ---- # Windows.Media.Import.PhotoImportOperation.ContinueImportingItemsAsync ## -description Causes in-progress import items operations to continue. ## -property-value An asynchronous operation that returns a [PhotoImportImportItemsResult](photoimportimportitemsresult.md) object on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportOperation.ContinueImportingItemsAsync +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportOperation.ContinueImportingItemsAsync + +## -description +Causes in-progress import items operations to continue. + +## -property-value +An asynchronous operation that returns a [PhotoImportImportItemsResult](photoimportimportitemsresult.md) object on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportoperation_session.md b/windows.media.import/photoimportoperation_session.md index 914751a9b5..0331d90365 100644 --- a/windows.media.import/photoimportoperation_session.md +++ b/windows.media.import/photoimportoperation_session.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportOperation.Session --api-type: winrt property ---- # Windows.Media.Import.PhotoImportOperation.Session ## -description Gets the photo import session associated with the operation. ## -property-value The photo import session associated with the operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportOperation.Session +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportOperation.Session + +## -description +Gets the photo import session associated with the operation. + +## -property-value +The photo import session associated with the operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportoperation_stage.md b/windows.media.import/photoimportoperation_stage.md index cf67d9b8d7..b9b7676645 100644 --- a/windows.media.import/photoimportoperation_stage.md +++ b/windows.media.import/photoimportoperation_stage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportOperation.Stage --api-type: winrt property ---- # Windows.Media.Import.PhotoImportOperation.Stage ## -description Gets the current stage of the in-progress operation. ## -property-value The current stage of the in-progress operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportOperation.Stage +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportOperation.Stage + +## -description +Gets the current stage of the in-progress operation. + +## -property-value +The current stage of the in-progress operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportselectionchangedeventargs.md b/windows.media.import/photoimportselectionchangedeventargs.md index ee128415c9..2077854c5b 100644 --- a/windows.media.import/photoimportselectionchangedeventargs.md +++ b/windows.media.import/photoimportselectionchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportSelectionChangedEventArgs --api-type: winrt class ---- # Windows.Media.Import.PhotoImportSelectionChangedEventArgs ## -description Provides data for the [PhotoImportFindItemsResult::SelectionChanged](photoimportfinditemsresult_selectionchanged.md) event. ## -remarks Get an instance of this class by handling the [PhotoImportFindItemsResult::SelectionChanged](photoimportfinditemsresult_selectionchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportSelectionChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportSelectionChangedEventArgs + +## -description +Provides data for the [PhotoImportFindItemsResult::SelectionChanged](photoimportfinditemsresult_selectionchanged.md) event. + +## -remarks +Get an instance of this class by handling the [PhotoImportFindItemsResult::SelectionChanged](photoimportfinditemsresult_selectionchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportselectionchangedeventargs_isselectionempty.md b/windows.media.import/photoimportselectionchangedeventargs_isselectionempty.md index 1b36f4d067..932057a5d5 100644 --- a/windows.media.import/photoimportselectionchangedeventargs_isselectionempty.md +++ b/windows.media.import/photoimportselectionchangedeventargs_isselectionempty.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSelectionChangedEventArgs.IsSelectionEmpty --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSelectionChangedEventArgs.IsSelectionEmpty ## -description Gets a value indicating whether no items are selected after the selection has changed. ## -property-value True if no items are selected; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSelectionChangedEventArgs.IsSelectionEmpty +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSelectionChangedEventArgs.IsSelectionEmpty + +## -description +Gets a value indicating whether no items are selected after the selection has changed. + +## -property-value +True if no items are selected; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession.md b/windows.media.import/photoimportsession.md index d3ae8530f2..61ee43e9a7 100644 --- a/windows.media.import/photoimportsession.md +++ b/windows.media.import/photoimportsession.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportSession --api-type: winrt class ---- # Windows.Media.Import.PhotoImportSession ## -description Represents a photo import session with a photo import source. ## -remarks Get an instance of this class by accessing the [PhotoImportOperation.Session](photoimportoperation_session.md) property or by calling [PhotoImportSource.CreateImportSession](photoimportsource_createimportsession.md). For how-to guidance for adding media import to your app, see [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device) \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportSession +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportSession + +## -description +Represents a photo import session with a photo import source. + +## -remarks +Get an instance of this class by accessing the [PhotoImportOperation.Session](photoimportoperation_session.md) property or by calling [PhotoImportSource.CreateImportSession](photoimportsource_createimportsession.md). + +For how-to guidance for adding media import to your app, see [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Import media from a device](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/import-media-from-a-device) \ No newline at end of file diff --git a/windows.media.import/photoimportsession_appendsessiondatetodestinationfolder.md b/windows.media.import/photoimportsession_appendsessiondatetodestinationfolder.md index 342ff52718..946639e60e 100644 --- a/windows.media.import/photoimportsession_appendsessiondatetodestinationfolder.md +++ b/windows.media.import/photoimportsession_appendsessiondatetodestinationfolder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSession.AppendSessionDateToDestinationFolder --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSession.AppendSessionDateToDestinationFolder ## -description Gets or sets a value specifying whether the session date should be appended to the destination folder name. ## -property-value True if the session date should be appended to the folder name; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.AppendSessionDateToDestinationFolder +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.AppendSessionDateToDestinationFolder + +## -description +Gets or sets a value specifying whether the session date should be appended to the destination folder name. + +## -property-value +True if the session date should be appended to the folder name; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_close_811482585.md b/windows.media.import/photoimportsession_close_811482585.md index 42bbf52fed..e4e13365df 100644 --- a/windows.media.import/photoimportsession_close_811482585.md +++ b/windows.media.import/photoimportsession_close_811482585.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportSession.Close --api-type: winrt method ---- # Windows.Media.Import.PhotoImportSession.Close ## -description Closes the photo import session and releases associated resources. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportSession.Close +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportSession.Close + +## -description +Closes the photo import session and releases associated resources. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_destinationfilenameprefix.md b/windows.media.import/photoimportsession_destinationfilenameprefix.md index ee49c08291..7a1f6845cd 100644 --- a/windows.media.import/photoimportsession_destinationfilenameprefix.md +++ b/windows.media.import/photoimportsession_destinationfilenameprefix.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSession.DestinationFileNamePrefix --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSession.DestinationFileNamePrefix ## -description Gets or sets the prefix for the destination file name. ## -property-value The prefix for the destination file name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.DestinationFileNamePrefix +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.DestinationFileNamePrefix + +## -description +Gets or sets the prefix for the destination file name. + +## -property-value +The prefix for the destination file name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_destinationfolder.md b/windows.media.import/photoimportsession_destinationfolder.md index ec8382fa2c..8370d5c6aa 100644 --- a/windows.media.import/photoimportsession_destinationfolder.md +++ b/windows.media.import/photoimportsession_destinationfolder.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSession.DestinationFolder --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSession.DestinationFolder ## -description Gets or sets the destination folder for the photo import session. ## -property-value The destination folder for the photo import session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.DestinationFolder +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.DestinationFolder + +## -description +Gets or sets the destination folder for the photo import session. + +## -property-value +The destination folder for the photo import session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_finditemsasync_1686050162.md b/windows.media.import/photoimportsession_finditemsasync_1686050162.md index 6489d62484..ce664b1c45 100644 --- a/windows.media.import/photoimportsession_finditemsasync_1686050162.md +++ b/windows.media.import/photoimportsession_finditemsasync_1686050162.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportSession.FindItemsAsync(Windows.Media.Import.PhotoImportContentTypeFilter,Windows.Media.Import.PhotoImportItemSelectionMode) --api-type: winrt method ---- # Windows.Media.Import.PhotoImportSession.FindItemsAsync ## -description Asynchronously finds items on the source device that are available for import. ## -parameters ### -param contentTypeFilter A value indicating whether the find operation includes images, videos, or both in the results. ### -param itemSelectionMode A value indicating whether all items, no items, or only new items in the results are initially marked as selected. ## -returns An asynchronous operation that returns a [PhotoImportFindItemsResult](photoimportfinditemsresult.md) on successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportSession.FindItemsAsync(Windows.Media.Import.PhotoImportContentTypeFilter,Windows.Media.Import.PhotoImportItemSelectionMode) +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportSession.FindItemsAsync + +## -description +Asynchronously finds items on the source device that are available for import. + +## -parameters +### -param contentTypeFilter +A value indicating whether the find operation includes images, videos, or both in the results. + +### -param itemSelectionMode +A value indicating whether all items, no items, or only new items in the results are initially marked as selected. + +## -returns +An asynchronous operation that returns a [PhotoImportFindItemsResult](photoimportfinditemsresult.md) on successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_sessionid.md b/windows.media.import/photoimportsession_sessionid.md index e0d825e088..b5c18cfebd 100644 --- a/windows.media.import/photoimportsession_sessionid.md +++ b/windows.media.import/photoimportsession_sessionid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSession.SessionId --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSession.SessionId ## -description Gets a unique identifier for the import session. ## -property-value A unique identifier for the import session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.SessionId +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.SessionId + +## -description +Gets a unique identifier for the import session. + +## -property-value +A unique identifier for the import session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_source.md b/windows.media.import/photoimportsession_source.md index c9551d1c5a..b8a1e2c9f7 100644 --- a/windows.media.import/photoimportsession_source.md +++ b/windows.media.import/photoimportsession_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSession.Source --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSession.Source ## -description Gets an object representing the source device associated with the photo import session. ## -property-value An object representing the source device associated with the photo import session. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.Source +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.Source + +## -description +Gets an object representing the source device associated with the photo import session. + +## -property-value +An object representing the source device associated with the photo import session. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsession_subfoldercreationmode.md b/windows.media.import/photoimportsession_subfoldercreationmode.md index a21ac13696..961dfd8a1f 100644 --- a/windows.media.import/photoimportsession_subfoldercreationmode.md +++ b/windows.media.import/photoimportsession_subfoldercreationmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSession.SubfolderCreationMode --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSession.SubfolderCreationMode ## -description Gets or sets a value indicating the method used for naming subfolders within the destination folder. ## -property-value A value indicating method used for naming subfolders within the destination folder. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.SubfolderCreationMode +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.SubfolderCreationMode + +## -description +Gets or sets a value indicating the method used for naming subfolders within the destination folder. + +## -property-value +A value indicating method used for naming subfolders within the destination folder. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsidecar.md b/windows.media.import/photoimportsidecar.md index 387c1a4727..b608faede2 100644 --- a/windows.media.import/photoimportsidecar.md +++ b/windows.media.import/photoimportsidecar.md @@ -1,3 +1,28 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportSidecar --api-type: winrt class ---- # Windows.Media.Import.PhotoImportSidecar ## -description Represents a sidecar file or a sibling file to a [PhotoImportItem](photoimportitem.md). ## -remarks Get an instance of this class by accessing the [PhotoImportItem::Sibling](photoimportvideosegment_sibling.md) property or the [PhotoImportItem::Sidecars](photoimportitem_sidecars.md) property. A Sidecar is a file that is not a JPEG nor a RAW file, nor a LRV file in the item is a video, that shares the same base-name as the main file it refers to, but with a different file extension. Sidecars can contain additional metadata (.XMP), a thumbnail (.THM), an audio annotation (.WAV) or possibly any other additional data, such as for example a GPS track alongside a video file, in the form of a text file containing NMEA sentences. As an example, a JPEG file named DSC_0001.JPG might have a DSC_0001.WAV audio annotation. The correlation can be done on the path + base name. The timestamps of sidecars may be similar or identical to the timestamp of the main files, however, in case of .XMP sidecars (metadata) and possibly others, it is conceivable that the sidecar has been edited, say to rate the image, at a later point in time. There may be more than one sidecar for any given file, for example a thumbnail, an audio annotation, and an XMP metadata sidecar, all attached to the same file. For photos, a sibling is the RAW file associated with a matching JPEG file produced by digital cameras set to RAW+JPEG shooting mode, where the camera produces two distinct files for every picture taken. The Windows.Media.Import APIs considers the JPEG file to be the main item of the pair, and the RAW to be the sibling. For video, a sibling is a low-resolution version of the main video, for example .mp4 + .lrv pairs. The Windows.Media.Import APIs considers the .MP4 to be the main item of the pair, and the low-resolution version to be the sibling. There can be at most one sibling attached to a given importable item. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportSidecar +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportSidecar + +## -description +Represents a sidecar file or a sibling file to a [PhotoImportItem](photoimportitem.md). + +## -remarks +Get an instance of this class by accessing the [PhotoImportItem::Sibling](photoimportvideosegment_sibling.md) property or the [PhotoImportItem::Sidecars](photoimportitem_sidecars.md) property. + +A Sidecar is a file that is not a JPEG nor a RAW file, nor a LRV file in the item is a video, that shares the same base-name as the main file it refers to, but with a different file extension. Sidecars can contain additional metadata (.XMP), a thumbnail (.THM), an audio annotation (.WAV) or possibly any other additional data, such as for example a GPS track alongside a video file, in the form of a text file containing NMEA sentences. As an example, a JPEG file named DSC_0001.JPG might have a DSC_0001.WAV audio annotation. The correlation can be done on the path + base name. The timestamps of sidecars may be similar or identical to the timestamp of the main files, however, in case of .XMP sidecars (metadata) and possibly others, it is conceivable that the sidecar has been edited, say to rate the image, at a later point in time. There may be more than one sidecar for any given file, for example a thumbnail, an audio annotation, and an XMP metadata sidecar, all attached to the same file. + +For photos, a sibling is the RAW file associated with a matching JPEG file produced by digital cameras set to RAW+JPEG shooting mode, where the camera produces two distinct files for every picture taken. The Windows.Media.Import APIs considers the JPEG file to be the main item of the pair, and the RAW to be the sibling. + +For video, a sibling is a low-resolution version of the main video, for example .mp4 + .lrv pairs. The Windows.Media.Import APIs considers the .MP4 to be the main item of the pair, and the low-resolution version to be the sibling. + +There can be at most one sibling attached to a given importable item. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsidecar_date.md b/windows.media.import/photoimportsidecar_date.md index e2e92cfb2b..4b8901aaee 100644 --- a/windows.media.import/photoimportsidecar_date.md +++ b/windows.media.import/photoimportsidecar_date.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSidecar.Date --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSidecar.Date ## -description Gets the date of the sidecar or sibling file. ## -property-value The date of the sidecar or sibling file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSidecar.Date +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSidecar.Date + +## -description +Gets the date of the sidecar or sibling file. + +## -property-value +The date of the sidecar or sibling file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsidecar_name.md b/windows.media.import/photoimportsidecar_name.md index e7a28acee4..900f5a8186 100644 --- a/windows.media.import/photoimportsidecar_name.md +++ b/windows.media.import/photoimportsidecar_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSidecar.Name --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSidecar.Name ## -description Gets the name of the sidecar or sibling file. ## -property-value The name of the sidecar or sibling file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSidecar.Name +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSidecar.Name + +## -description +Gets the name of the sidecar or sibling file. + +## -property-value +The name of the sidecar or sibling file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsidecar_sizeinbytes.md b/windows.media.import/photoimportsidecar_sizeinbytes.md index e80331e680..1f67bb6ae3 100644 --- a/windows.media.import/photoimportsidecar_sizeinbytes.md +++ b/windows.media.import/photoimportsidecar_sizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSidecar.SizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSidecar.SizeInBytes ## -description Gets the size of the sidecar or sibling file, in bytes. ## -property-value The size of the sidecar or sibling file, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSidecar.SizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSidecar.SizeInBytes + +## -description +Gets the size of the sidecar or sibling file, in bytes. + +## -property-value +The size of the sidecar or sibling file, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource.md b/windows.media.import/photoimportsource.md index 1f595356e7..6b7bcfa8cc 100644 --- a/windows.media.import/photoimportsource.md +++ b/windows.media.import/photoimportsource.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportSource --api-type: winrt class ---- # Windows.Media.Import.PhotoImportSource ## -description Represents the source device for a photo import session. ## -remarks Get an instance of this class by accessing the [PhotoImportSession.Source](photoimportsession_source.md) property or by calling [PhotoImportSource.FromIdAsync](photoimportsource_fromidasync.md) or [PhotoImportSource.FromFolderAsync](photoimportsource_fromfolderasync.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportSource +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportSource + +## -description +Represents the source device for a photo import session. + +## -remarks +Get an instance of this class by accessing the [PhotoImportSession.Source](photoimportsession_source.md) property or by calling [PhotoImportSource.FromIdAsync](photoimportsource_fromidasync.md) or [PhotoImportSource.FromFolderAsync](photoimportsource_fromfolderasync.md). + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_batterylevelpercent.md b/windows.media.import/photoimportsource_batterylevelpercent.md index 810cbe6158..cf0e1ba707 100644 --- a/windows.media.import/photoimportsource_batterylevelpercent.md +++ b/windows.media.import/photoimportsource_batterylevelpercent.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.BatteryLevelPercent --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.BatteryLevelPercent ## -description The battery level of the source device. ## -property-value A value from 0 to 100 that indicates the power level of the device battery, with 0 being none, and 100 being fully charged. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.BatteryLevelPercent +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.BatteryLevelPercent + +## -description +The battery level of the source device. + +## -property-value +A value from 0 to 100 that indicates the power level of the device battery, with 0 being none, and 100 being fully charged. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_connectionprotocol.md b/windows.media.import/photoimportsource_connectionprotocol.md index 9421b4738a..0f6feb63b3 100644 --- a/windows.media.import/photoimportsource_connectionprotocol.md +++ b/windows.media.import/photoimportsource_connectionprotocol.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.ConnectionProtocol --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.ConnectionProtocol ## -description Gets the connection protocol that is being used to communicate with the source device. ## -property-value The connection protocol that is being used to communicate with the source device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.ConnectionProtocol +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.ConnectionProtocol + +## -description +Gets the connection protocol that is being used to communicate with the source device. + +## -property-value +The connection protocol that is being used to communicate with the source device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_connectiontransport.md b/windows.media.import/photoimportsource_connectiontransport.md index 1f43d05bc5..da4602202a 100644 --- a/windows.media.import/photoimportsource_connectiontransport.md +++ b/windows.media.import/photoimportsource_connectiontransport.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.ConnectionTransport --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.ConnectionTransport ## -description Gets a value indicating the transport mechanism that is being used for importing items from the source device. ## -property-value A value indicating the transport mechanism that is being used for importing items from the source device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.ConnectionTransport +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.ConnectionTransport + +## -description +Gets a value indicating the transport mechanism that is being used for importing items from the source device. + +## -property-value +A value indicating the transport mechanism that is being used for importing items from the source device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_createimportsession_1938274523.md b/windows.media.import/photoimportsource_createimportsession_1938274523.md index fda95a250d..cb6679b750 100644 --- a/windows.media.import/photoimportsource_createimportsession_1938274523.md +++ b/windows.media.import/photoimportsource_createimportsession_1938274523.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportSource.CreateImportSession --api-type: winrt method ---- # Windows.Media.Import.PhotoImportSource.CreateImportSession ## -description Creates a new photo import session. ## -returns The new [PhotoImportSession](photoimportsession.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportSource.CreateImportSession +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportSource.CreateImportSession + +## -description +Creates a new photo import session. + +## -returns +The new [PhotoImportSession](photoimportsession.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_datetime.md b/windows.media.import/photoimportsource_datetime.md index bbe0be92b9..f3c51486fe 100644 --- a/windows.media.import/photoimportsource_datetime.md +++ b/windows.media.import/photoimportsource_datetime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.DateTime --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.DateTime ## -description Gets the current date and time on the device. ## -property-value The current date and time on the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.DateTime +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.DateTime + +## -description +Gets the current date and time on the device. + +## -property-value +The current date and time on the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_description.md b/windows.media.import/photoimportsource_description.md index 35db0c9981..0f85d75d56 100644 --- a/windows.media.import/photoimportsource_description.md +++ b/windows.media.import/photoimportsource_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.Description --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.Description ## -description Gets a human-readable description of the source device. ## -property-value A human-readable description of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.Description +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.Description + +## -description +Gets a human-readable description of the source device. + +## -property-value +A human-readable description of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_displayname.md b/windows.media.import/photoimportsource_displayname.md index cadb8d8c0c..dd7b4bba3a 100644 --- a/windows.media.import/photoimportsource_displayname.md +++ b/windows.media.import/photoimportsource_displayname.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.DisplayName --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.DisplayName ## -description Gets the human-readable display name for the source device. ## -property-value The human-readable display name for the source device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.DisplayName +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.DisplayName + +## -description +Gets the human-readable display name for the source device. + +## -property-value +The human-readable display name for the source device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_fromfolderasync_1787212244.md b/windows.media.import/photoimportsource_fromfolderasync_1787212244.md index 061def6016..c00c3000f2 100644 --- a/windows.media.import/photoimportsource_fromfolderasync_1787212244.md +++ b/windows.media.import/photoimportsource_fromfolderasync_1787212244.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportSource.FromFolderAsync(Windows.Storage.IStorageFolder) --api-type: winrt method ---- # Windows.Media.Import.PhotoImportSource.FromFolderAsync ## -description Creates a new instance of [PhotoImportSource](photoimportsource.md) from the specified root folder. ## -parameters ### -param sourceRootFolder The root folder from which the photo import source is created. ## -returns An asynchronous operation that returns a [PhotoImportSource](photoimportsource.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportSource.FromFolderAsync(Windows.Storage.IStorageFolder) +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportSource.FromFolderAsync + +## -description +Creates a new instance of [PhotoImportSource](photoimportsource.md) from the specified root folder. + +## -parameters +### -param sourceRootFolder +The root folder from which the photo import source is created. + +## -returns +An asynchronous operation that returns a [PhotoImportSource](photoimportsource.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_fromidasync_1322863552.md b/windows.media.import/photoimportsource_fromidasync_1322863552.md index 1b9d7c1adc..684bca8e7d 100644 --- a/windows.media.import/photoimportsource_fromidasync_1322863552.md +++ b/windows.media.import/photoimportsource_fromidasync_1322863552.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportSource.FromIdAsync(System.String) --api-type: winrt method ---- # Windows.Media.Import.PhotoImportSource.FromIdAsync ## -description Creates a new instance of [PhotoImportSource](photoimportsource.md) from the specified device ID. ## -parameters ### -param sourceId The root folder from which the photo import source is created. ## -returns An asynchronous operation that returns a [PhotoImportSource](photoimportsource.md) upon successful completion. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportSource.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportSource.FromIdAsync + +## -description +Creates a new instance of [PhotoImportSource](photoimportsource.md) from the specified device ID. + +## -parameters +### -param sourceId +The root folder from which the photo import source is created. + +## -returns +An asynchronous operation that returns a [PhotoImportSource](photoimportsource.md) upon successful completion. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_id.md b/windows.media.import/photoimportsource_id.md index 9454e3ae85..2ca7e5ea6f 100644 --- a/windows.media.import/photoimportsource_id.md +++ b/windows.media.import/photoimportsource_id.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.Id --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.Id ## -description Gets a unique 16-byte identifier that is common across multiple transports supported by the device. ## -property-value A unique 16-byte identifier that is common across multiple transports supported by the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.Id +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.Id + +## -description +Gets a unique 16-byte identifier that is common across multiple transports supported by the device. + +## -property-value +A unique 16-byte identifier that is common across multiple transports supported by the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_islocked.md b/windows.media.import/photoimportsource_islocked.md index f9330b31d2..b931681ce4 100644 --- a/windows.media.import/photoimportsource_islocked.md +++ b/windows.media.import/photoimportsource_islocked.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.IsLocked --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.IsLocked ## -description Gets a value indicating if the source device is locked. ## -property-value True if the source device is locked; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.IsLocked +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.IsLocked + +## -description +Gets a value indicating if the source device is locked. + +## -property-value +True if the source device is locked; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_ismassstorage.md b/windows.media.import/photoimportsource_ismassstorage.md index 34f0f42a4e..9a336277f2 100644 --- a/windows.media.import/photoimportsource_ismassstorage.md +++ b/windows.media.import/photoimportsource_ismassstorage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.IsMassStorage --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.IsMassStorage ## -description Gets a value indicating if the source device is a mass storage device. ## -property-value True if the source device is a mass storage device; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.IsMassStorage +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.IsMassStorage + +## -description +Gets a value indicating if the source device is a mass storage device. + +## -property-value +True if the source device is a mass storage device; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_manufacturer.md b/windows.media.import/photoimportsource_manufacturer.md index d9f8df63ca..57992e1bdb 100644 --- a/windows.media.import/photoimportsource_manufacturer.md +++ b/windows.media.import/photoimportsource_manufacturer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.Manufacturer --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.Manufacturer ## -description Gets the source device's human-readable manufacturer name. ## -property-value The source device's human-readable manufacturer name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.Manufacturer +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.Manufacturer + +## -description +Gets the source device's human-readable manufacturer name. + +## -property-value +The source device's human-readable manufacturer name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_model.md b/windows.media.import/photoimportsource_model.md index 02e3b5dbde..8c845b4422 100644 --- a/windows.media.import/photoimportsource_model.md +++ b/windows.media.import/photoimportsource_model.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.Model --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.Model ## -description Gets the device model name. ## -property-value The device model name. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.Model +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.Model + +## -description +Gets the device model name. + +## -property-value +The device model name. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_powersource.md b/windows.media.import/photoimportsource_powersource.md index 9c60cbc6f4..f001cda5da 100644 --- a/windows.media.import/photoimportsource_powersource.md +++ b/windows.media.import/photoimportsource_powersource.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.PowerSource --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.PowerSource ## -description Gets a value indicating the type of power source being used by the source device, if it is known. ## -property-value A value indicating the type of power source being used by the source device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.PowerSource +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.PowerSource + +## -description +Gets a value indicating the type of power source being used by the source device, if it is known. + +## -property-value +A value indicating the type of power source being used by the source device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_serialnumber.md b/windows.media.import/photoimportsource_serialnumber.md index f6d59a5a47..bb51082707 100644 --- a/windows.media.import/photoimportsource_serialnumber.md +++ b/windows.media.import/photoimportsource_serialnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.SerialNumber --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.SerialNumber ## -description Gets the serial number of the device. ## -property-value The serial number of the device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.SerialNumber +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.SerialNumber + +## -description +Gets the serial number of the device. + +## -property-value +The serial number of the device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_storagemedia.md b/windows.media.import/photoimportsource_storagemedia.md index 91a0a7af38..55f243d31e 100644 --- a/windows.media.import/photoimportsource_storagemedia.md +++ b/windows.media.import/photoimportsource_storagemedia.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.StorageMedia --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.StorageMedia ## -description Gets a list of objects representing the different storage media exposed by the source device. ## -property-value A list of objects representing the different storage media exposed by the source device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.StorageMedia +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.StorageMedia + +## -description +Gets a list of objects representing the different storage media exposed by the source device. + +## -property-value +A list of objects representing the different storage media exposed by the source device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_thumbnail.md b/windows.media.import/photoimportsource_thumbnail.md index 823b276441..cda6ed8f4b 100644 --- a/windows.media.import/photoimportsource_thumbnail.md +++ b/windows.media.import/photoimportsource_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.Thumbnail --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.Thumbnail ## -description Gets a reference to a stream containing the thumbnail image for the source device. ## -property-value A reference to a stream containing the thumbnail image for the source device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.Thumbnail + +## -description +Gets a reference to a stream containing the thumbnail image for the source device. + +## -property-value +A reference to a stream containing the thumbnail image for the source device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportsource_type.md b/windows.media.import/photoimportsource_type.md index f60cceebf4..1676561c3b 100644 --- a/windows.media.import/photoimportsource_type.md +++ b/windows.media.import/photoimportsource_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportSource.Type --api-type: winrt property ---- # Windows.Media.Import.PhotoImportSource.Type ## -description Gets a value indicating the type of the source device. ## -property-value A value indicating the type of the storage device. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportSource.Type +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSource.Type + +## -description +Gets a value indicating the type of the source device. + +## -property-value +A value indicating the type of the storage device. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium.md b/windows.media.import/photoimportstoragemedium.md index d0dad154af..f0bdb6f424 100644 --- a/windows.media.import/photoimportstoragemedium.md +++ b/windows.media.import/photoimportstoragemedium.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportStorageMedium --api-type: winrt class ---- # Windows.Media.Import.PhotoImportStorageMedium ## -description Represents a storage medium exposed by a photo import source device. ## -remarks Get an instance of this class by accessing the [PhotoImportSource.StorageMedia](photoimportsource_storagemedia.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportStorageMedium +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium + +## -description +Represents a storage medium exposed by a photo import source device. + +## -remarks +Get an instance of this class by accessing the [PhotoImportSource.StorageMedia](photoimportsource_storagemedia.md) property. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_availablespaceinbytes.md b/windows.media.import/photoimportstoragemedium_availablespaceinbytes.md index a24691094e..7d5fe2aaf7 100644 --- a/windows.media.import/photoimportstoragemedium_availablespaceinbytes.md +++ b/windows.media.import/photoimportstoragemedium_availablespaceinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.AvailableSpaceInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.AvailableSpaceInBytes ## -description Gets the available space on the storage medium, in bytes. ## -property-value The available space on the storage medium, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.AvailableSpaceInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.AvailableSpaceInBytes + +## -description +Gets the available space on the storage medium, in bytes. + +## -property-value +The available space on the storage medium, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_capacityinbytes.md b/windows.media.import/photoimportstoragemedium_capacityinbytes.md index b5e7ae277f..bd56eb45a7 100644 --- a/windows.media.import/photoimportstoragemedium_capacityinbytes.md +++ b/windows.media.import/photoimportstoragemedium_capacityinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.CapacityInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.CapacityInBytes ## -description Gets the capacity of the storage media, in bytes. ## -property-value The capacity of the storage media, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.CapacityInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.CapacityInBytes + +## -description +Gets the capacity of the storage media, in bytes. + +## -property-value +The capacity of the storage media, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_description.md b/windows.media.import/photoimportstoragemedium_description.md index 0f7e205483..4625a154e7 100644 --- a/windows.media.import/photoimportstoragemedium_description.md +++ b/windows.media.import/photoimportstoragemedium_description.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.Description --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.Description ## -description Gets a description of the storage medium. ## -property-value A description of the storage medium. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.Description +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.Description + +## -description +Gets a description of the storage medium. + +## -property-value +A description of the storage medium. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_name.md b/windows.media.import/photoimportstoragemedium_name.md index f2615ae616..8ce6a6c5f2 100644 --- a/windows.media.import/photoimportstoragemedium_name.md +++ b/windows.media.import/photoimportstoragemedium_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.Name --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.Name ## -description Gets the name of the storage medium. ## -property-value The name of the storage medium. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.Name +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.Name + +## -description +Gets the name of the storage medium. + +## -property-value +The name of the storage medium. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_refresh_839939657.md b/windows.media.import/photoimportstoragemedium_refresh_839939657.md index c9f85878f2..accd76a766 100644 --- a/windows.media.import/photoimportstoragemedium_refresh_839939657.md +++ b/windows.media.import/photoimportstoragemedium_refresh_839939657.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Import.PhotoImportStorageMedium.Refresh --api-type: winrt method ---- # Windows.Media.Import.PhotoImportStorageMedium.Refresh ## -description Refreshes the information about the storage medium. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Import.PhotoImportStorageMedium.Refresh +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.Refresh + +## -description +Refreshes the information about the storage medium. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_serialnumber.md b/windows.media.import/photoimportstoragemedium_serialnumber.md index 5131bcf968..9740af0273 100644 --- a/windows.media.import/photoimportstoragemedium_serialnumber.md +++ b/windows.media.import/photoimportstoragemedium_serialnumber.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.SerialNumber --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.SerialNumber ## -description Gets the serial number of the storage medium. ## -property-value The serial number of the storage medium. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.SerialNumber +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.SerialNumber + +## -description +Gets the serial number of the storage medium. + +## -property-value +The serial number of the storage medium. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_storagemediumtype.md b/windows.media.import/photoimportstoragemedium_storagemediumtype.md index a869609bfe..970bec63e4 100644 --- a/windows.media.import/photoimportstoragemedium_storagemediumtype.md +++ b/windows.media.import/photoimportstoragemedium_storagemediumtype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.StorageMediumType --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.StorageMediumType ## -description Gets the type of the storage medium. ## -property-value The type of the storage medium. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.StorageMediumType +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.StorageMediumType + +## -description +Gets the type of the storage medium. + +## -property-value +The type of the storage medium. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportstoragemedium_supportedaccessmode.md b/windows.media.import/photoimportstoragemedium_supportedaccessmode.md index 295b089f94..c9b86dd0a2 100644 --- a/windows.media.import/photoimportstoragemedium_supportedaccessmode.md +++ b/windows.media.import/photoimportstoragemedium_supportedaccessmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportStorageMedium.SupportedAccessMode --api-type: winrt property ---- # Windows.Media.Import.PhotoImportStorageMedium.SupportedAccessMode ## -description Gets a value indicating the access modes supported by the storage medium. ## -property-value A value indicating the access modes supported by the storage medium. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportStorageMedium.SupportedAccessMode +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportStorageMedium.SupportedAccessMode + +## -description +Gets a value indicating the access modes supported by the storage medium. + +## -property-value +A value indicating the access modes supported by the storage medium. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportvideosegment.md b/windows.media.import/photoimportvideosegment.md index dba58d2a43..3f3c27dd72 100644 --- a/windows.media.import/photoimportvideosegment.md +++ b/windows.media.import/photoimportvideosegment.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Import.PhotoImportVideoSegment --api-type: winrt class ---- # Windows.Media.Import.PhotoImportVideoSegment ## -description Represents an imported video segment. ## -remarks Video segments are produced by some video recorders that split long video files in multiple segments. The reasons might be file format limitations, file size limitations on the storage media file system, or some inherited arbitrary convention, such as the 20mn standard duration of a 35mm movie reel. The naming of the main (“first”) segment and the subsequent (“continuation”) segments depends on the video recorder. The correlation between the segments can be made on based on the full path + the video type + the last four digits, looking for digits in the first four characters to decide which one it the main file. The last continuation is typically smaller than the main file, and the timestamps may also reflect the chronological sequence. Video segments can have siblings. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Import.PhotoImportVideoSegment +-api-type: winrt class +--- + + + +# Windows.Media.Import.PhotoImportVideoSegment + +## -description +Represents an imported video segment. + +## -remarks +Video segments are produced by some video recorders that split long video files in multiple segments. The reasons might be file format limitations, file size limitations on the storage media file system, or some inherited arbitrary convention, such as the 20mn standard duration of a 35mm movie reel. The naming of the main (“first”) segment and the subsequent (“continuation”) segments depends on the video recorder. The correlation between the segments can be made on based on the full path + the video type + the last four digits, looking for digits in the first four characters to decide which one it the main file. The last continuation is typically smaller than the main file, and the timestamps may also reflect the chronological sequence. Video segments can have siblings. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportvideosegment_date.md b/windows.media.import/photoimportvideosegment_date.md index 33258573a3..4491685d46 100644 --- a/windows.media.import/photoimportvideosegment_date.md +++ b/windows.media.import/photoimportvideosegment_date.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Date --api-type: winrt property ---- # Windows.Media.Import.PhotoImportVideoSegment.Date ## -description Gets the date of the imported video segment. ## -property-value The date of the imported video segment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Date +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportVideoSegment.Date + +## -description +Gets the date of the imported video segment. + +## -property-value +The date of the imported video segment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportvideosegment_name.md b/windows.media.import/photoimportvideosegment_name.md index b9cb64de31..6f7c254e00 100644 --- a/windows.media.import/photoimportvideosegment_name.md +++ b/windows.media.import/photoimportvideosegment_name.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Name --api-type: winrt property ---- # Windows.Media.Import.PhotoImportVideoSegment.Name ## -description Gets the name of the imported video segment. ## -property-value The name of the imported video segment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Name +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportVideoSegment.Name + +## -description +Gets the name of the imported video segment. + +## -property-value +The name of the imported video segment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportvideosegment_sibling.md b/windows.media.import/photoimportvideosegment_sibling.md index 9596fa4be3..752e9cea42 100644 --- a/windows.media.import/photoimportvideosegment_sibling.md +++ b/windows.media.import/photoimportvideosegment_sibling.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Sibling --api-type: winrt property ---- # Windows.Media.Import.PhotoImportVideoSegment.Sibling ## -description Gets the sibling file associated with the imported video segment. ## -property-value The sibling file associated with the imported video segment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Sibling +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportVideoSegment.Sibling + +## -description +Gets the sibling file associated with the imported video segment. + +## -property-value +The sibling file associated with the imported video segment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportvideosegment_sidecars.md b/windows.media.import/photoimportvideosegment_sidecars.md index fdd722a706..08d438a1a3 100644 --- a/windows.media.import/photoimportvideosegment_sidecars.md +++ b/windows.media.import/photoimportvideosegment_sidecars.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Sidecars --api-type: winrt property ---- # Windows.Media.Import.PhotoImportVideoSegment.Sidecars ## -description Gets the sidecar file associated with the imported video segment. ## -property-value The sidecar file associated with the imported video segment. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportVideoSegment.Sidecars +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportVideoSegment.Sidecars + +## -description +Gets the sidecar file associated with the imported video segment. + +## -property-value +The sidecar file associated with the imported video segment. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportvideosegment_sizeinbytes.md b/windows.media.import/photoimportvideosegment_sizeinbytes.md index 25fa1e5d6d..bd2df8c405 100644 --- a/windows.media.import/photoimportvideosegment_sizeinbytes.md +++ b/windows.media.import/photoimportvideosegment_sizeinbytes.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Import.PhotoImportVideoSegment.SizeInBytes --api-type: winrt property ---- # Windows.Media.Import.PhotoImportVideoSegment.SizeInBytes ## -description Gets the size of the imported video segment, in bytes. ## -property-value The size of the imported video segment, in bytes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Import.PhotoImportVideoSegment.SizeInBytes +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportVideoSegment.SizeInBytes + +## -description +Gets the size of the imported video segment, in bytes. + +## -property-value +The size of the imported video segment, in bytes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_audioencodingproperties_1221375020.md b/windows.media.mediaproperties/audioencodingproperties_audioencodingproperties_1221375020.md index 99334443c8..6b4bae65d9 100644 --- a/windows.media.mediaproperties/audioencodingproperties_audioencodingproperties_1221375020.md +++ b/windows.media.mediaproperties/audioencodingproperties_audioencodingproperties_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.#ctor --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.AudioEncodingProperties ## -description Creates a new instance of the [AudioEncodingProperties](audioencodingproperties.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.AudioEncodingProperties + +## -description +Creates a new instance of the [AudioEncodingProperties](audioencodingproperties.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_bitrate.md b/windows.media.mediaproperties/audioencodingproperties_bitrate.md index c94d84e253..3ca2fd3b2f 100644 --- a/windows.media.mediaproperties/audioencodingproperties_bitrate.md +++ b/windows.media.mediaproperties/audioencodingproperties_bitrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Bitrate --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.Bitrate ## -description Gets or sets the audio bit rate. ## -property-value The average bit rate of the audio stream, in bits per second. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Bitrate +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.Bitrate + +## -description +Gets or sets the audio bit rate. + +## -property-value +The average bit rate of the audio stream, in bits per second. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_bitspersample.md b/windows.media.mediaproperties/audioencodingproperties_bitspersample.md index 908c070243..669b27573d 100644 --- a/windows.media.mediaproperties/audioencodingproperties_bitspersample.md +++ b/windows.media.mediaproperties/audioencodingproperties_bitspersample.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.BitsPerSample --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.BitsPerSample ## -description Gets or sets the number of bits per audio sample. ## -property-value The number of bits per audio sample. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.BitsPerSample +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.BitsPerSample + +## -description +Gets or sets the number of bits per audio sample. + +## -property-value +The number of bits per audio sample. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_channelcount.md b/windows.media.mediaproperties/audioencodingproperties_channelcount.md index 21efe59112..6853c90256 100644 --- a/windows.media.mediaproperties/audioencodingproperties_channelcount.md +++ b/windows.media.mediaproperties/audioencodingproperties_channelcount.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.ChannelCount --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.ChannelCount ## -description Gets or sets the number of audio channels. ## -property-value The number of audio channels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.ChannelCount +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.ChannelCount + +## -description +Gets or sets the number of audio channels. + +## -property-value +The number of audio channels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_createaac_667362189.md b/windows.media.mediaproperties/audioencodingproperties_createaac_667362189.md index 93ef828570..ff74a1f7fc 100644 --- a/windows.media.mediaproperties/audioencodingproperties_createaac_667362189.md +++ b/windows.media.mediaproperties/audioencodingproperties_createaac_667362189.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateAac(System.UInt32,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.CreateAac ## -description Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Advanced Audio Coding (AAC) audio. ## -parameters ### -param sampleRate The audio sampling rate. ### -param channelCount The number of audio channels. ### -param bitrate The audio bit rate. ## -returns The audio encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateAac(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreateAac + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Advanced Audio Coding (AAC) audio. + +## -parameters +### -param sampleRate +The audio sampling rate. + +### -param channelCount +The number of audio channels. + +### -param bitrate +The audio bit rate. + +## -returns +The audio encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_createaacadts_870973278.md b/windows.media.mediaproperties/audioencodingproperties_createaacadts_870973278.md index e0774af37f..c259250254 100644 --- a/windows.media.mediaproperties/audioencodingproperties_createaacadts_870973278.md +++ b/windows.media.mediaproperties/audioencodingproperties_createaacadts_870973278.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateAacAdts(System.UInt32,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.CreateAacAdts ## -description Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. ## -parameters ### -param sampleRate The audio sampling rate. ### -param channelCount The number of audio channels. ### -param bitrate The audio bit rate. ## -returns The audio encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateAacAdts(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreateAacAdts + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. + +## -parameters +### -param sampleRate +The audio sampling rate. + +### -param channelCount +The number of audio channels. + +### -param bitrate +The audio bit rate. + +## -returns +The audio encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_createmp3_946859991.md b/windows.media.mediaproperties/audioencodingproperties_createmp3_946859991.md index bf35439ac6..6d9460a79c 100644 --- a/windows.media.mediaproperties/audioencodingproperties_createmp3_946859991.md +++ b/windows.media.mediaproperties/audioencodingproperties_createmp3_946859991.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateMp3(System.UInt32,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.CreateMp3 ## -description Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for MPEG Audio Layer-3 (MP3) audio. ## -parameters ### -param sampleRate The audio sampling rate. ### -param channelCount The number of audio channels. ### -param bitrate The audio bit rate. ## -returns The audio encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateMp3(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreateMp3 + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for MPEG Audio Layer-3 (MP3) audio. + +## -parameters +### -param sampleRate +The audio sampling rate. + +### -param channelCount +The number of audio channels. + +### -param bitrate +The audio bit rate. + +## -returns +The audio encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_createpcm_1138648522.md b/windows.media.mediaproperties/audioencodingproperties_createpcm_1138648522.md index b3aeac9212..40772393d9 100644 --- a/windows.media.mediaproperties/audioencodingproperties_createpcm_1138648522.md +++ b/windows.media.mediaproperties/audioencodingproperties_createpcm_1138648522.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreatePcm(System.UInt32,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.CreatePcm ## -description Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Pulse Code Modulation (PCM) audio. ## -parameters ### -param sampleRate The audio sampling rate. ### -param channelCount The number of audio channels. ### -param bitsPerSample The audio bit depth. ## -returns The audio encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreatePcm(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreatePcm + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Pulse Code Modulation (PCM) audio. + +## -parameters +### -param sampleRate +The audio sampling rate. + +### -param channelCount +The number of audio channels. + +### -param bitsPerSample +The audio bit depth. + +## -returns +The audio encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_createwma_1370772921.md b/windows.media.mediaproperties/audioencodingproperties_createwma_1370772921.md index 326681a9c3..6c143bb939 100644 --- a/windows.media.mediaproperties/audioencodingproperties_createwma_1370772921.md +++ b/windows.media.mediaproperties/audioencodingproperties_createwma_1370772921.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateWma(System.UInt32,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.CreateWma ## -description Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Windows Media Audio (WMA). ## -parameters ### -param sampleRate The audio sampling rate. ### -param channelCount The number of audio channels. ### -param bitrate The audio bit rate. ## -returns The audio encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateWma(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreateWma + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Windows Media Audio (WMA). + +## -parameters +### -param sampleRate +The audio sampling rate. + +### -param channelCount +The number of audio channels. + +### -param bitrate +The audio bit rate. + +## -returns +The audio encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_getformatuserdata_1710152786.md b/windows.media.mediaproperties/audioencodingproperties_getformatuserdata_1710152786.md index 7ea2fc2597..4b093d5ad8 100644 --- a/windows.media.mediaproperties/audioencodingproperties_getformatuserdata_1710152786.md +++ b/windows.media.mediaproperties/audioencodingproperties_getformatuserdata_1710152786.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.GetFormatUserData(System.Byte[]@) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.GetFormatUserData ## -description Gets the media format user data. ## -parameters ### -param value Receives the media format data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.GetFormatUserData(System.Byte[]@) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.GetFormatUserData + +## -description +Gets the media format user data. + +## -parameters +### -param value +Receives the media format data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_properties.md b/windows.media.mediaproperties/audioencodingproperties_properties.md index fa436f3d9b..643c9ec7ae 100644 --- a/windows.media.mediaproperties/audioencodingproperties_properties.md +++ b/windows.media.mediaproperties/audioencodingproperties_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Properties --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.Properties ## -description Gets additional format properties for the audio stream. ## -property-value A property set that contains format properties. ## -remarks For information on working with a property set collection, see [PropertySet](../windows.foundation.collections/propertyset.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Properties +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.Properties + +## -description +Gets additional format properties for the audio stream. + +## -property-value +A property set that contains format properties. + +## -remarks +For information on working with a property set collection, see [PropertySet](../windows.foundation.collections/propertyset.md). + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_samplerate.md b/windows.media.mediaproperties/audioencodingproperties_samplerate.md index 7161e0c876..9558fead66 100644 --- a/windows.media.mediaproperties/audioencodingproperties_samplerate.md +++ b/windows.media.mediaproperties/audioencodingproperties_samplerate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.SampleRate --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.SampleRate ## -description Gets or sets audio sampling rate. ## -property-value The number of audio samples per second. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.SampleRate +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.SampleRate + +## -description +Gets or sets audio sampling rate. + +## -property-value +The number of audio samples per second. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_setformatuserdata_1623528230.md b/windows.media.mediaproperties/audioencodingproperties_setformatuserdata_1623528230.md index e147d2c863..954e8dd568 100644 --- a/windows.media.mediaproperties/audioencodingproperties_setformatuserdata_1623528230.md +++ b/windows.media.mediaproperties/audioencodingproperties_setformatuserdata_1623528230.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.SetFormatUserData(System.Byte[]) --api-type: winrt method ---- # Windows.Media.MediaProperties.AudioEncodingProperties.SetFormatUserData ## -description Sets the media format user data. ## -parameters ### -param value The media data to set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.SetFormatUserData(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.SetFormatUserData + +## -description +Sets the media format user data. + +## -parameters +### -param value +The media data to set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_subtype.md b/windows.media.mediaproperties/audioencodingproperties_subtype.md index dbe6a4ffa7..e3679f559b 100644 --- a/windows.media.mediaproperties/audioencodingproperties_subtype.md +++ b/windows.media.mediaproperties/audioencodingproperties_subtype.md @@ -1,3 +1,50 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Subtype --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.Subtype ## -description Gets or sets the subtype of the format. ## -property-value The subtype. ## -remarks The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table.
ValueDescription
"AAC"Advanced Audio Coding (AAC). The stream can contain either raw AAC data or AAC data in an Audio Data Transport Stream (ADTS) stream.
"AC3"Dolby Digital audio (AC-3).
"AACADTS"Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format.
"AACHDCP"AAC in High-Bandwidth Digital Content Protection (HDCP) format.
"AC3"Dolby AC3
"AC3SPDIF"Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF).
"AC3HDCP"Dolby AC-3 in High-Bandwidth Digital Content Protection (HDCP) format.
"ADTS"Audio Data Transport Stream
"ALAC"Apple Lossless Audio Codec
"AMRNB"Adaptive Multi-Rate audio codec (AMR-NB)
"AWRWB"Adaptive Multi-Rate Wideband audio codec (AMR-WB)
"DTS"Digital Theater Systems (DTS)
"EAC3"Dolby Digital Plus audio (E-AC-3).
"FLAC"Free Lossless Audio Codec
"Float"Uncompressed 32-bit float PCM audio.
"MP3"MPEG Audio Layer-3 (MP3).
"MPEG"MPEG-1 audio payload.
"OPUS"Opus
"PCM"Uncompressed 16-bit PCM audio.
"WMA8"Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec.
"WMA9"Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec.
"Vorbis"Vorbis codec
> [!WARNING] > The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Subtype +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.Subtype + +## -description +Gets or sets the subtype of the format. + +## -property-value +The subtype. + +## -remarks +The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table. + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
"AAC"Advanced Audio Coding (AAC). The stream can contain either raw AAC data or AAC data in an Audio Data Transport Stream (ADTS) stream.
"AC3"Dolby Digital audio (AC-3).
"AACADTS"Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format.
"AACHDCP"AAC in High-Bandwidth Digital Content Protection (HDCP) format.
"AC3"Dolby AC3
"AC3SPDIF"Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF).
"AC3HDCP"Dolby AC-3 in High-Bandwidth Digital Content Protection (HDCP) format.
"ADTS"Audio Data Transport Stream
"ALAC"Apple Lossless Audio Codec
"AMRNB"Adaptive Multi-Rate audio codec (AMR-NB)
"AWRWB"Adaptive Multi-Rate Wideband audio codec (AMR-WB)
"DTS"Digital Theater Systems (DTS)
"EAC3"Dolby Digital Plus audio (E-AC-3).
"FLAC"Free Lossless Audio Codec
"Float"Uncompressed 32-bit float PCM audio.
"MP3"MPEG Audio Layer-3 (MP3).
"MPEG"MPEG-1 audio payload.
"OPUS"Opus
"PCM"Uncompressed 16-bit PCM audio.
"WMA8"Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec.
"WMA9"Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec.
"Vorbis"Vorbis codec
+ +> [!WARNING] +> The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/audioencodingproperties_type.md b/windows.media.mediaproperties/audioencodingproperties_type.md index 9123995005..d74c597f1f 100644 --- a/windows.media.mediaproperties/audioencodingproperties_type.md +++ b/windows.media.mediaproperties/audioencodingproperties_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Type --api-type: winrt property ---- # Windows.Media.MediaProperties.AudioEncodingProperties.Type ## -description Gets the format type. ## -property-value The format type. For audio streams, the format type is "Audio". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.Type +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.Type + +## -description +Gets the format type. + +## -property-value +The format type. For audio streams, the format type is "Audio". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/containerencodingproperties_containerencodingproperties_1221375020.md b/windows.media.mediaproperties/containerencodingproperties_containerencodingproperties_1221375020.md index 60e44da48e..dcd41a92f1 100644 --- a/windows.media.mediaproperties/containerencodingproperties_containerencodingproperties_1221375020.md +++ b/windows.media.mediaproperties/containerencodingproperties_containerencodingproperties_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.ContainerEncodingProperties.#ctor --api-type: winrt method ---- # Windows.Media.MediaProperties.ContainerEncodingProperties.ContainerEncodingProperties ## -description Creates a new instance of the [ContainerEncodingProperties](containerencodingproperties.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ContainerEncodingProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ContainerEncodingProperties.ContainerEncodingProperties + +## -description +Creates a new instance of the [ContainerEncodingProperties](containerencodingproperties.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/containerencodingproperties_properties.md b/windows.media.mediaproperties/containerencodingproperties_properties.md index e4bf858b1a..8eeb18dcfc 100644 --- a/windows.media.mediaproperties/containerencodingproperties_properties.md +++ b/windows.media.mediaproperties/containerencodingproperties_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.ContainerEncodingProperties.Properties --api-type: winrt property ---- # Windows.Media.MediaProperties.ContainerEncodingProperties.Properties ## -description Gets additional format properties for the media container. ## -property-value A property set that contains format properties. ## -remarks For information on working with a property set collection, see [PropertySet](../windows.foundation.collections/propertyset.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ContainerEncodingProperties.Properties +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ContainerEncodingProperties.Properties + +## -description +Gets additional format properties for the media container. + +## -property-value +A property set that contains format properties. + +## -remarks +For information on working with a property set collection, see [PropertySet](../windows.foundation.collections/propertyset.md). + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/containerencodingproperties_subtype.md b/windows.media.mediaproperties/containerencodingproperties_subtype.md index 7c34d41431..efa2d3a990 100644 --- a/windows.media.mediaproperties/containerencodingproperties_subtype.md +++ b/windows.media.mediaproperties/containerencodingproperties_subtype.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Media.MediaProperties.ContainerEncodingProperties.Subtype --api-type: winrt property ---- # Windows.Media.MediaProperties.ContainerEncodingProperties.Subtype ## -description Gets or sets the subtype of the media container. ## -property-value The subtype. ## -remarks The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table.
ValueDescription
"3GP"3GP file.
"AC3"AC-3 audio.
"ADTS"Audio Data Transport Stream (ADTS) stream.
"MP3"MPEG Audio Layer-3 (MP3).
"MPEG2PS"MPEG-2 program stream.
"MPEG2TS"MPEG-2 transport stream.
"MPEG4"MP4 file container.
> [!WARNING] > The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imediaencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ContainerEncodingProperties.Subtype +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ContainerEncodingProperties.Subtype + +## -description +Gets or sets the subtype of the media container. + +## -property-value +The subtype. + +## -remarks +The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table. + + + + + + + + +
ValueDescription
"3GP"3GP file.
"AC3"AC-3 audio.
"ADTS"Audio Data Transport Stream (ADTS) stream.
"MP3"MPEG Audio Layer-3 (MP3).
"MPEG2PS"MPEG-2 program stream.
"MPEG2TS"MPEG-2 transport stream.
"MPEG4"MP4 file container.
+ +> [!WARNING] +> The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imediaencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/containerencodingproperties_type.md b/windows.media.mediaproperties/containerencodingproperties_type.md index 84e2023081..545cce587c 100644 --- a/windows.media.mediaproperties/containerencodingproperties_type.md +++ b/windows.media.mediaproperties/containerencodingproperties_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.ContainerEncodingProperties.Type --api-type: winrt property ---- # Windows.Media.MediaProperties.ContainerEncodingProperties.Type ## -description Gets the format type. ## -property-value The format type. For media containers, the format type is "Container". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ContainerEncodingProperties.Type +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ContainerEncodingProperties.Type + +## -description +Gets the format type. + +## -property-value +The format type. For media containers, the format type is "Container". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids.md b/windows.media.mediaproperties/h264profileids.md index e4fff3d6bb..099c493b3d 100644 --- a/windows.media.mediaproperties/h264profileids.md +++ b/windows.media.mediaproperties/h264profileids.md @@ -1,25 +1,25 @@ ---- --api-id: T:Windows.Media.MediaProperties.H264ProfileIds --api-type: winrt class ---- - - - -# Windows.Media.MediaProperties.H264ProfileIds - -## -description -Provides properties for getting H.264 profile ids. - -## -remarks -You can set the value of [VideoEncodingProperties.ProfileId](videoencodingproperties_profileid.md) to one of the profile ids provided by this class. - -## -examples -Here is some code that creates an instance of the [VideoEncodingProperties](videoencodingproperties.md) class using [CreateH264](videoencodingproperties_createh264.md) and sets the [ProfileId](videoencodingproperties_profileid.md) to the H.264 high profile. - - - -[!code-cs[VideoPropertiesH264ProfileID](../windows.media.mediaproperties/code/MediaProperties/csharp/MainPage.xaml.cs#SnippetVideoPropertiesH264ProfileID)] - -## -see-also +--- +-api-id: T:Windows.Media.MediaProperties.H264ProfileIds +-api-type: winrt class +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds + +## -description +Provides properties for getting H.264 profile ids. + +## -remarks +You can set the value of [VideoEncodingProperties.ProfileId](videoencodingproperties_profileid.md) to one of the profile ids provided by this class. + +## -examples +Here is some code that creates an instance of the [VideoEncodingProperties](videoencodingproperties.md) class using [CreateH264](videoencodingproperties_createh264.md) and sets the [ProfileId](videoencodingproperties_profileid.md) to the H.264 high profile. + + + +[!code-cs[VideoPropertiesH264ProfileID](../windows.media.mediaproperties/code/MediaProperties/csharp/MainPage.xaml.cs#SnippetVideoPropertiesH264ProfileID)] + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_baseline.md b/windows.media.mediaproperties/h264profileids_baseline.md index bc80552d8c..39e3361053 100644 --- a/windows.media.mediaproperties/h264profileids_baseline.md +++ b/windows.media.mediaproperties/h264profileids_baseline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.Baseline --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.Baseline ## -description Gets the H.264 baseline profile. ## -property-value The baseline profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.Baseline +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.Baseline + +## -description +Gets the H.264 baseline profile. + +## -property-value +The baseline profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_constrainedbaseline.md b/windows.media.mediaproperties/h264profileids_constrainedbaseline.md index a67562f668..ffca91c59a 100644 --- a/windows.media.mediaproperties/h264profileids_constrainedbaseline.md +++ b/windows.media.mediaproperties/h264profileids_constrainedbaseline.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.ConstrainedBaseline --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.ConstrainedBaseline ## -description Gets the H.264 constrained baseline profile. ## -property-value The constrained baseline profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.ConstrainedBaseline +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.ConstrainedBaseline + +## -description +Gets the H.264 constrained baseline profile. + +## -property-value +The constrained baseline profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_extended.md b/windows.media.mediaproperties/h264profileids_extended.md index 6d067691a9..ac87825d19 100644 --- a/windows.media.mediaproperties/h264profileids_extended.md +++ b/windows.media.mediaproperties/h264profileids_extended.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.Extended --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.Extended ## -description Gets the H.264 extended profile. ## -property-value The extended profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.Extended +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.Extended + +## -description +Gets the H.264 extended profile. + +## -property-value +The extended profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_high.md b/windows.media.mediaproperties/h264profileids_high.md index 2dc766a07e..b4c21535ae 100644 --- a/windows.media.mediaproperties/h264profileids_high.md +++ b/windows.media.mediaproperties/h264profileids_high.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.High ## -description Gets the H.264 high profile. ## -property-value The high profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.High + +## -description +Gets the H.264 high profile. + +## -property-value +The high profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_high10.md b/windows.media.mediaproperties/h264profileids_high10.md index 883bc58ea0..2f448af794 100644 --- a/windows.media.mediaproperties/h264profileids_high10.md +++ b/windows.media.mediaproperties/h264profileids_high10.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High10 --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.High10 ## -description Gets the H.264 high 10 profile. ## -property-value The high 10 profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High10 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.High10 + +## -description +Gets the H.264 high 10 profile. + +## -property-value +The high 10 profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_high422.md b/windows.media.mediaproperties/h264profileids_high422.md index ac215647f4..296ec4bb33 100644 --- a/windows.media.mediaproperties/h264profileids_high422.md +++ b/windows.media.mediaproperties/h264profileids_high422.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High422 --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.High422 ## -description Gets the H.264 high 4:2:2 profile. ## -property-value The high 4:2:2 profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High422 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.High422 + +## -description +Gets the H.264 high 4:2:2 profile. + +## -property-value +The high 4:2:2 profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_high444.md b/windows.media.mediaproperties/h264profileids_high444.md index d85b95507d..73fcd1d69f 100644 --- a/windows.media.mediaproperties/h264profileids_high444.md +++ b/windows.media.mediaproperties/h264profileids_high444.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High444 --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.High444 ## -description Gets the H.264 high 4:4:4 profile. ## -property-value The high 4:4:4 profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.High444 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.High444 + +## -description +Gets the H.264 high 4:4:4 profile. + +## -property-value +The high 4:4:4 profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_main.md b/windows.media.mediaproperties/h264profileids_main.md index f021780c3c..6162698e21 100644 --- a/windows.media.mediaproperties/h264profileids_main.md +++ b/windows.media.mediaproperties/h264profileids_main.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.Main --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.Main ## -description Gets the H.264 main profile. ## -property-value Gets the main profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.Main +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.Main + +## -description +Gets the H.264 main profile. + +## -property-value +Gets the main profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_multiviewhigh.md b/windows.media.mediaproperties/h264profileids_multiviewhigh.md index 09325d2a2b..31db1a1325 100644 --- a/windows.media.mediaproperties/h264profileids_multiviewhigh.md +++ b/windows.media.mediaproperties/h264profileids_multiviewhigh.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.MultiviewHigh --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.MultiviewHigh ## -description Gets the H.264 multiview profile. ## -property-value The multiview profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.MultiviewHigh +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.MultiviewHigh + +## -description +Gets the H.264 multiview profile. + +## -property-value +The multiview profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/h264profileids_stereohigh.md b/windows.media.mediaproperties/h264profileids_stereohigh.md index 8e34867e94..cbb78f0a2e 100644 --- a/windows.media.mediaproperties/h264profileids_stereohigh.md +++ b/windows.media.mediaproperties/h264profileids_stereohigh.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.H264ProfileIds.StereoHigh --api-type: winrt property ---- # Windows.Media.MediaProperties.H264ProfileIds.StereoHigh ## -description Gets the H.264 stereo high profile. ## -property-value The stereo high profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.H264ProfileIds.StereoHigh +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.H264ProfileIds.StereoHigh + +## -description +Gets the H.264 stereo high profile. + +## -property-value +The stereo high profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_createbmp_678887406.md b/windows.media.mediaproperties/imageencodingproperties_createbmp_678887406.md index e16d06bc11..e45cba99bc 100644 --- a/windows.media.mediaproperties/imageencodingproperties_createbmp_678887406.md +++ b/windows.media.mediaproperties/imageencodingproperties_createbmp_678887406.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateBmp --api-type: winrt method ---- # Windows.Media.MediaProperties.ImageEncodingProperties.CreateBmp ## -description Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a BMP image. ## -returns The image encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateBmp +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.CreateBmp + +## -description +Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a BMP image. + +## -returns +The image encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_createjpeg_1680038701.md b/windows.media.mediaproperties/imageencodingproperties_createjpeg_1680038701.md index 8f74f475d3..b6f43bf5ed 100644 --- a/windows.media.mediaproperties/imageencodingproperties_createjpeg_1680038701.md +++ b/windows.media.mediaproperties/imageencodingproperties_createjpeg_1680038701.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpeg --api-type: winrt method ---- # Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpeg ## -description Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a JPEG image. ## -returns The properties for the image stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpeg +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpeg + +## -description +Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a JPEG image. + +## -returns +The properties for the image stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_createjpegxr_57707140.md b/windows.media.mediaproperties/imageencodingproperties_createjpegxr_57707140.md index f995d4518b..1787489f64 100644 --- a/windows.media.mediaproperties/imageencodingproperties_createjpegxr_57707140.md +++ b/windows.media.mediaproperties/imageencodingproperties_createjpegxr_57707140.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpegXR --api-type: winrt method ---- # Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpegXR ## -description Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a JPEG XR image. ## -returns The properties for the image stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpegXR +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.CreateJpegXR + +## -description +Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a JPEG XR image. + +## -returns +The properties for the image stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_createpng_980169443.md b/windows.media.mediaproperties/imageencodingproperties_createpng_980169443.md index 21bef9d88a..a2056f6821 100644 --- a/windows.media.mediaproperties/imageencodingproperties_createpng_980169443.md +++ b/windows.media.mediaproperties/imageencodingproperties_createpng_980169443.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreatePng --api-type: winrt method ---- # Windows.Media.MediaProperties.ImageEncodingProperties.CreatePng ## -description Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a PNG image. ## -returns The properties for the image stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreatePng +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.CreatePng + +## -description +Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for a PNG image. + +## -returns +The properties for the image stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_createuncompressed_2041531452.md b/windows.media.mediaproperties/imageencodingproperties_createuncompressed_2041531452.md index 8ebd824e62..2e96845e07 100644 --- a/windows.media.mediaproperties/imageencodingproperties_createuncompressed_2041531452.md +++ b/windows.media.mediaproperties/imageencodingproperties_createuncompressed_2041531452.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateUncompressed(Windows.Media.MediaProperties.MediaPixelFormat) --api-type: winrt method ---- # Windows.Media.MediaProperties.ImageEncodingProperties.CreateUncompressed ## -description Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for an uncompressed image. ## -parameters ### -param format The media pixel format. ## -returns The image encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.CreateUncompressed(Windows.Media.MediaProperties.MediaPixelFormat) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.CreateUncompressed + +## -description +Creates an instance of [ImageEncodingProperties](imageencodingproperties.md) for an uncompressed image. + +## -parameters +### -param format +The media pixel format. + +## -returns +The image encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_height.md b/windows.media.mediaproperties/imageencodingproperties_height.md index 915f40f361..08d7b04870 100644 --- a/windows.media.mediaproperties/imageencodingproperties_height.md +++ b/windows.media.mediaproperties/imageencodingproperties_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Height --api-type: winrt property ---- # Windows.Media.MediaProperties.ImageEncodingProperties.Height ## -description Gets or sets the image height. ## -property-value The height of the image, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Height +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.Height + +## -description +Gets or sets the image height. + +## -property-value +The height of the image, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_imageencodingproperties_1221375020.md b/windows.media.mediaproperties/imageencodingproperties_imageencodingproperties_1221375020.md index 96548b8a36..50d415cc31 100644 --- a/windows.media.mediaproperties/imageencodingproperties_imageencodingproperties_1221375020.md +++ b/windows.media.mediaproperties/imageencodingproperties_imageencodingproperties_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.#ctor --api-type: winrt method ---- # Windows.Media.MediaProperties.ImageEncodingProperties.ImageEncodingProperties ## -description Creates a new instance of the [ImageEncodingProperties](imageencodingproperties.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.ImageEncodingProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.ImageEncodingProperties + +## -description +Creates a new instance of the [ImageEncodingProperties](imageencodingproperties.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_properties.md b/windows.media.mediaproperties/imageencodingproperties_properties.md index 696d183f4d..a228a05bd4 100644 --- a/windows.media.mediaproperties/imageencodingproperties_properties.md +++ b/windows.media.mediaproperties/imageencodingproperties_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Properties --api-type: winrt property ---- # Windows.Media.MediaProperties.ImageEncodingProperties.Properties ## -description Gets additional format properties for the image stream. ## -property-value A property set that contains format properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Properties +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.Properties + +## -description +Gets additional format properties for the image stream. + +## -property-value +A property set that contains format properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_subtype.md b/windows.media.mediaproperties/imageencodingproperties_subtype.md index af2e7ed26a..c587f86b23 100644 --- a/windows.media.mediaproperties/imageencodingproperties_subtype.md +++ b/windows.media.mediaproperties/imageencodingproperties_subtype.md @@ -1,3 +1,35 @@ ---- -api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Subtype --api-type: winrt property ---- # Windows.Media.MediaProperties.ImageEncodingProperties.Subtype ## -description Gets or sets the subtype of the format. ## -property-value The subtype. ## -remarks The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table.
ValueDescription
"BMP"Bitmap image.
"ICO"ICO image.
"GIF"GIF image.
"JPEG"JPEG image.
"PNG"PNG image.
"TIFF"TIFF image.
"WMP"JPEG-XR or HD Photo image.
> [!WARNING] > The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Subtype +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.Subtype + +## -description +Gets or sets the subtype of the format. + +## -property-value +The subtype. + +## -remarks +The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table. + + + + + + + + +
ValueDescription
"BMP"Bitmap image.
"ICO"ICO image.
"GIF"GIF image.
"JPEG"JPEG image.
"PNG"PNG image.
"TIFF"TIFF image.
"WMP"JPEG-XR or HD Photo image.
+ +> [!WARNING] +> The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_type.md b/windows.media.mediaproperties/imageencodingproperties_type.md index 99074f43c3..b15379e0ce 100644 --- a/windows.media.mediaproperties/imageencodingproperties_type.md +++ b/windows.media.mediaproperties/imageencodingproperties_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Type --api-type: winrt property ---- # Windows.Media.MediaProperties.ImageEncodingProperties.Type ## -description Gets the format type. ## -property-value The format type. For image streams, the format type is "Image". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Type +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.Type + +## -description +Gets the format type. + +## -property-value +The format type. For image streams, the format type is "Image". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imageencodingproperties_width.md b/windows.media.mediaproperties/imageencodingproperties_width.md index 2549785f30..a0369fda45 100644 --- a/windows.media.mediaproperties/imageencodingproperties_width.md +++ b/windows.media.mediaproperties/imageencodingproperties_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Width --api-type: winrt property ---- # Windows.Media.MediaProperties.ImageEncodingProperties.Width ## -description Gets or sets the image width. ## -property-value The width of the image, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.ImageEncodingProperties.Width +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.ImageEncodingProperties.Width + +## -description +Gets or sets the image width. + +## -property-value +The width of the image, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imediaencodingproperties_properties.md b/windows.media.mediaproperties/imediaencodingproperties_properties.md index 78bc6d1703..68b491fbaf 100644 --- a/windows.media.mediaproperties/imediaencodingproperties_properties.md +++ b/windows.media.mediaproperties/imediaencodingproperties_properties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.IMediaEncodingProperties.Properties --api-type: winrt property ---- # Windows.Media.MediaProperties.IMediaEncodingProperties.Properties ## -description Gets additional format properties. ## -property-value A property set that contains format properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.IMediaEncodingProperties.Properties +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.IMediaEncodingProperties.Properties + +## -description +Gets additional format properties. + +## -property-value +A property set that contains format properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imediaencodingproperties_subtype.md b/windows.media.mediaproperties/imediaencodingproperties_subtype.md index d1f276b65e..0178a1d699 100644 --- a/windows.media.mediaproperties/imediaencodingproperties_subtype.md +++ b/windows.media.mediaproperties/imediaencodingproperties_subtype.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Media.MediaProperties.IMediaEncodingProperties.Subtype --api-type: winrt property ---- # Windows.Media.MediaProperties.IMediaEncodingProperties.Subtype ## -description Gets or sets the subtype of the format. ## -property-value The subtype. ## -remarks The subtype gives a more specific description of the format than the [Type](imediaencodingproperties_type.md) property. Possible values depend on the class that implements the method. For more information, see the following topics: + [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md) + [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md) + [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md) + [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md) ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.IMediaEncodingProperties.Subtype +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.IMediaEncodingProperties.Subtype + +## -description +Gets or sets the subtype of the format. + +## -property-value +The subtype. + +## -remarks +The subtype gives a more specific description of the format than the [Type](imediaencodingproperties_type.md) property. Possible values depend on the class that implements the method. For more information, see the following topics: ++ [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md) ++ [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md) ++ [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md) ++ [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md) + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/imediaencodingproperties_type.md b/windows.media.mediaproperties/imediaencodingproperties_type.md index 94bb2936f4..d12ef5e4db 100644 --- a/windows.media.mediaproperties/imediaencodingproperties_type.md +++ b/windows.media.mediaproperties/imediaencodingproperties_type.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Media.MediaProperties.IMediaEncodingProperties.Type --api-type: winrt property ---- # Windows.Media.MediaProperties.IMediaEncodingProperties.Type ## -description Gets the format type. ## -property-value The format type. The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table.
ValueDescription
"Audio"Audio stream. To get details of the audio format, use [AudioEncodingProperties](audioencodingproperties.md).
"Container"Media container.
"Image"Still image data. To get details of the image format, use [ImageEncodingProperties](imageencodingproperties.md).
"Video"Video stream. To get details of the video format, use [VideoEncodingProperties](videoencodingproperties.md).
## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.IMediaEncodingProperties.Type +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.IMediaEncodingProperties.Type + +## -description +Gets the format type. + +## -property-value +The format type. The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table. + + + + + +
ValueDescription
"Audio"Audio stream. To get details of the audio format, use [AudioEncodingProperties](audioencodingproperties.md).
"Container"Media container.
"Image"Still image data. To get details of the image format, use [ImageEncodingProperties](imageencodingproperties.md).
"Video"Video stream. To get details of the video format, use [VideoEncodingProperties](videoencodingproperties.md).
+ +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_audio.md b/windows.media.mediaproperties/mediaencodingprofile_audio.md index 14e246b551..6d27c48b75 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_audio.md +++ b/windows.media.mediaproperties/mediaencodingprofile_audio.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingProfile.Audio --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingProfile.Audio ## -description Gets or sets the encoding properties for the audio stream. ## -property-value The encoding properties of the audio stream. If the profile does not contain an audio stream, the value is **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingProfile.Audio +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.Audio + +## -description +Gets or sets the encoding properties for the audio stream. + +## -property-value +The encoding properties of the audio stream. If the profile does not contain an audio stream, the value is **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_container.md b/windows.media.mediaproperties/mediaencodingprofile_container.md index 554b41c33e..a57b3182cb 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_container.md +++ b/windows.media.mediaproperties/mediaencodingprofile_container.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingProfile.Container --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingProfile.Container ## -description Gets or sets the properties of the media container. ## -property-value The properties of the media container. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingProfile.Container +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.Container + +## -description +Gets or sets the properties of the media container. + +## -property-value +The properties of the media container. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createavi_2030750117.md b/windows.media.mediaproperties/mediaencodingprofile_createavi_2030750117.md index 59a8c2234d..e92942f003 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createavi_2030750117.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createavi_2030750117.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateAvi(Windows.Media.MediaProperties.VideoEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateAvi ## -description Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for AVI. ## -parameters ### -param quality The video quality. ## -returns The media encoding profile. ## -remarks The encoding quality **Auto** is a special preset that fills in the proper settings based on the current camera settings. Settings that are manually modified are ignored. For example, if you create a preset profile using one the static create methods, such as [CreateM4a](mediaencodingprofile_createm4a.md), and specify **Auto** as the encoding quality, any changes you make to the properties will be overwritten with values based on the current camera settings. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateAvi(Windows.Media.MediaProperties.VideoEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateAvi + +## -description +Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for AVI. + +## -parameters +### -param quality +The video quality. + +## -returns +The media encoding profile. + +## -remarks +The encoding quality **Auto** is a special preset that fills in the proper settings based on the current camera settings. Settings that are manually modified are ignored. For example, if you create a preset profile using one the static create methods, such as [CreateM4a](mediaencodingprofile_createm4a.md), and specify **Auto** as the encoding quality, any changes you make to the properties will be overwritten with values based on the current camera settings. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createfromfileasync_691414423.md b/windows.media.mediaproperties/mediaencodingprofile_createfromfileasync_691414423.md index 90fe21344d..bc1266801a 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createfromfileasync_691414423.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createfromfileasync_691414423.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromFileAsync ## -description Creates an encoding profile from an existing media file. ## -parameters ### -param file The media file from which to create the profile. ## -returns An object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromFileAsync + +## -description +Creates an encoding profile from an existing media file. + +## -parameters +### -param file +The media file from which to create the profile. + +## -returns +An object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createfromstreamasync_211017202.md b/windows.media.mediaproperties/mediaencodingprofile_createfromstreamasync_211017202.md index b3d288d5ac..1df6d92162 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createfromstreamasync_211017202.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createfromstreamasync_211017202.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromStreamAsync(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromStreamAsync ## -description Creates an encoding profile from a stream that contains media data. ## -parameters ### -param stream The media stream from which to create the profile. ## -returns An object that is used to control the asynchronous operation. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromStreamAsync(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateFromStreamAsync + +## -description +Creates an encoding profile from a stream that contains media data. + +## -parameters +### -param stream +The media stream from which to create the profile. + +## -returns +An object that is used to control the asynchronous operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createm4a_1230065862.md b/windows.media.mediaproperties/mediaencodingprofile_createm4a_1230065862.md index ad6bb219fc..3b2e200865 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createm4a_1230065862.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createm4a_1230065862.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateM4a(Windows.Media.MediaProperties.AudioEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateM4a ## -description Creates an encoding profile for AAC audio. ## -parameters ### -param quality Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. ## -returns Returns a media encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateM4a(Windows.Media.MediaProperties.AudioEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateM4a + +## -description +Creates an encoding profile for AAC audio. + +## -parameters +### -param quality +Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. + +## -returns +Returns a media encoding profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createmp3_1449480444.md b/windows.media.mediaproperties/mediaencodingprofile_createmp3_1449480444.md index 6783326e7e..cbd8d7218b 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createmp3_1449480444.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createmp3_1449480444.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp3(Windows.Media.MediaProperties.AudioEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp3 ## -description Creates an encoding profile for MP3 (MPEG-1 layer 3) audio. ## -parameters ### -param quality Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. ## -returns Returns a media encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp3(Windows.Media.MediaProperties.AudioEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp3 + +## -description +Creates an encoding profile for MP3 (MPEG-1 layer 3) audio. + +## -parameters +### -param quality +Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. + +## -returns +Returns a media encoding profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createmp4_660407800.md b/windows.media.mediaproperties/mediaencodingprofile_createmp4_660407800.md index 94e4677e52..8237831d75 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createmp4_660407800.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createmp4_660407800.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp4(Windows.Media.MediaProperties.VideoEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp4 ## -description Creates an encoding profile for H.264 video. ## -parameters ### -param quality Specifies the video resolution of the profile. ## -returns Returns a media encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp4(Windows.Media.MediaProperties.VideoEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateMp4 + +## -description +Creates an encoding profile for H.264 video. + +## -parameters +### -param quality +Specifies the video resolution of the profile. + +## -returns +Returns a media encoding profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createwav_1267537239.md b/windows.media.mediaproperties/mediaencodingprofile_createwav_1267537239.md index 905518fff0..c0086e94b5 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createwav_1267537239.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createwav_1267537239.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateWav(Windows.Media.MediaProperties.AudioEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateWav ## -description Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for WAV ## -parameters ### -param quality The audio encoding quality. ## -returns The media encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateWav(Windows.Media.MediaProperties.AudioEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateWav + +## -description +Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for WAV + +## -parameters +### -param quality +The audio encoding quality. + +## -returns +The media encoding profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createwma_1069476500.md b/windows.media.mediaproperties/mediaencodingprofile_createwma_1069476500.md index f67e5ee592..bc44e8b07c 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createwma_1069476500.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createwma_1069476500.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateWma(Windows.Media.MediaProperties.AudioEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateWma ## -description Creates an encoding profile for Windows Media Audio (WMA). ## -parameters ### -param quality Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. ## -returns Returns a media encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateWma(Windows.Media.MediaProperties.AudioEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateWma + +## -description +Creates an encoding profile for Windows Media Audio (WMA). + +## -parameters +### -param quality +Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. + +## -returns +Returns a media encoding profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_createwmv_1317453732.md b/windows.media.mediaproperties/mediaencodingprofile_createwmv_1317453732.md index d31fc9ee15..1c7fe12208 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_createwmv_1317453732.md +++ b/windows.media.mediaproperties/mediaencodingprofile_createwmv_1317453732.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateWmv(Windows.Media.MediaProperties.VideoEncodingQuality) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.CreateWmv ## -description Creates an encoding profile for Windows Media Video (WMV). ## -parameters ### -param quality Specifies the video resolution of the profile. ## -returns Returns a media encoding profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateWmv(Windows.Media.MediaProperties.VideoEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateWmv + +## -description +Creates an encoding profile for Windows Media Video (WMV). + +## -parameters +### -param quality +Specifies the video resolution of the profile. + +## -returns +Returns a media encoding profile. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_mediaencodingprofile_1221375020.md b/windows.media.mediaproperties/mediaencodingprofile_mediaencodingprofile_1221375020.md index 59d53a65cd..0d9926c0b8 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_mediaencodingprofile_1221375020.md +++ b/windows.media.mediaproperties/mediaencodingprofile_mediaencodingprofile_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.#ctor --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaEncodingProfile.MediaEncodingProfile ## -description Creates a new instance of the [MediaEncodingProfile](mediaencodingprofile.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.MediaEncodingProfile + +## -description +Creates a new instance of the [MediaEncodingProfile](mediaencodingprofile.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingprofile_video.md b/windows.media.mediaproperties/mediaencodingprofile_video.md index fb50886b57..06f7a730a9 100644 --- a/windows.media.mediaproperties/mediaencodingprofile_video.md +++ b/windows.media.mediaproperties/mediaencodingprofile_video.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingProfile.Video --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingProfile.Video ## -description Gets or sets the encoding properties for the video stream. ## -property-value The encoding properties of the video stream. If the profile does not contain a video stream, the value is **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingProfile.Video +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.Video + +## -description +Gets or sets the encoding properties for the video stream. + +## -property-value +The encoding properties of the video stream. If the profile does not contain a video stream, the value is **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes.md b/windows.media.mediaproperties/mediaencodingsubtypes.md index 446b89f071..2665fb840f 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Media.MediaProperties.MediaEncodingSubtypes --api-type: winrt class ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes ## -description Provides properties for getting the standard names for media subtypes. ## -remarks [MediaEncodingSubtypes](mediaencodingsubtypes.md) provides names for media subtypes which can be used to set [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imediaencodingproperties_subtype.md). > [!WARNING] > The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imediaencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. For how-to guidance for setting the encoding properties for media, see [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties). ## -examples ## -see-also [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) \ No newline at end of file +--- +-api-id: T:Windows.Media.MediaProperties.MediaEncodingSubtypes +-api-type: winrt class +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes + +## -description +Provides properties for getting the standard names for media subtypes. + +## -remarks +[MediaEncodingSubtypes](mediaencodingsubtypes.md) provides names for media subtypes which can be used to set [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imediaencodingproperties_subtype.md). + +> [!WARNING] +> The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imediaencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. + +For how-to guidance for setting the encoding properties for media, see [Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties). + +## -examples + +## -see-also +[Set media encoding properties for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) \ No newline at end of file diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_aac.md b/windows.media.mediaproperties/mediaencodingsubtypes_aac.md index 88b59dc343..98078c6744 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_aac.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_aac.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Aac --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Aac ## -description Gets the name for Advanced Audio Coding (AAC). ## -property-value The name for AAC. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Aac +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Aac + +## -description +Gets the name for Advanced Audio Coding (AAC). + +## -property-value +The name for AAC. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_aacadts.md b/windows.media.mediaproperties/mediaencodingsubtypes_aacadts.md index 90eb55ea9b..185e715455 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_aacadts.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_aacadts.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.AacAdts --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.AacAdts ## -description Gets the name for Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. ## -property-value The name for AAC ADTS. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.AacAdts +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.AacAdts + +## -description +Gets the name for Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. + +## -property-value +The name for AAC ADTS. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_ac3.md b/windows.media.mediaproperties/mediaencodingsubtypes_ac3.md index 4f24e59bf9..439caa4111 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_ac3.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_ac3.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Ac3 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Ac3 ## -description Gets the name for Dolby Digital audio (AC-3). ## -property-value The name for AC-3. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Ac3 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Ac3 + +## -description +Gets the name for Dolby Digital audio (AC-3). + +## -property-value +The name for AC-3. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_amrnb.md b/windows.media.mediaproperties/mediaencodingsubtypes_amrnb.md index 7b617db008..fd91156aaa 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_amrnb.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_amrnb.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrNb --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrNb ## -description Gets the name for Adaptive Multi-Rate (AmrNb). ## -property-value The name of AMR-NB. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrNb +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrNb + +## -description +Gets the name for Adaptive Multi-Rate (AmrNb). + +## -property-value +The name of AMR-NB. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_amrwb.md b/windows.media.mediaproperties/mediaencodingsubtypes_amrwb.md index 8b239a3f4a..fbb1c27597 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_amrwb.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_amrwb.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrWb --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrWb ## -description Gets the name for Adaptive Multi-Rate Wideband. ## -property-value The name for AMR-WB ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrWb +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.AmrWb + +## -description +Gets the name for Adaptive Multi-Rate Wideband. + +## -property-value +The name for AMR-WB + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_argb32.md b/windows.media.mediaproperties/mediaencodingsubtypes_argb32.md index 3ec718ce27..70dcdd5f5e 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_argb32.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_argb32.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Argb32 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Argb32 ## -description Gets the name for RGB 32 with alpha channel. ## -property-value The name for AGB32. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Argb32 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Argb32 + +## -description +Gets the name for RGB 32 with alpha channel. + +## -property-value +The name for AGB32. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_asf.md b/windows.media.mediaproperties/mediaencodingsubtypes_asf.md index 50a35f5b98..9b8d6541d7 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_asf.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_asf.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Asf --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Asf ## -description Gets the name for Advanced Systems Format (ASF). ## -property-value The name for ASF. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Asf +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Asf + +## -description +Gets the name for Advanced Systems Format (ASF). + +## -property-value +The name for ASF. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_avi.md b/windows.media.mediaproperties/mediaencodingsubtypes_avi.md index 10cf0ef2ef..d17cdc4126 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_avi.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_avi.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Avi --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Avi ## -description Gets the name for Audio Video Interleave (AVI). ## -property-value The name for AVI. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Avi +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Avi + +## -description +Gets the name for Audio Video Interleave (AVI). + +## -property-value +The name for AVI. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_bgra8.md b/windows.media.mediaproperties/mediaencodingsubtypes_bgra8.md index 1dfa1b55dc..d86c7f561c 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_bgra8.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_bgra8.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Bgra8 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Bgra8 ## -description Gets the name for BGRA8. ## -property-value The name for BGRA8. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Bgra8 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Bgra8 + +## -description +Gets the name for BGRA8. + +## -property-value +The name for BGRA8. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_bmp.md b/windows.media.mediaproperties/mediaencodingsubtypes_bmp.md index b6763d9400..d13c397dd9 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_bmp.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_bmp.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Bmp --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Bmp ## -description Gets the name for BMP file format. ## -property-value The name from BMP. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Bmp +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Bmp + +## -description +Gets the name for BMP file format. + +## -property-value +The name from BMP. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_eac3.md b/windows.media.mediaproperties/mediaencodingsubtypes_eac3.md index ffc58aae65..15499abd50 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_eac3.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_eac3.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Eac3 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Eac3 ## -description Gets the name Dolby Digital Plus (E-AC-3). ## -property-value Gets the name for E-AC-3. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Eac3 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Eac3 + +## -description +Gets the name Dolby Digital Plus (E-AC-3). + +## -property-value +Gets the name for E-AC-3. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_float.md b/windows.media.mediaproperties/mediaencodingsubtypes_float.md index 3e313d3545..6e477b32f1 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_float.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_float.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Float --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Float ## -description Gets the name for Uncompressed IEEE floating-point audio. ## -property-value Gets the name for float. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Float +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Float + +## -description +Gets the name for Uncompressed IEEE floating-point audio. + +## -property-value +Gets the name for float. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_gif.md b/windows.media.mediaproperties/mediaencodingsubtypes_gif.md index 985d05f1ec..c69ccb5bdd 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_gif.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_gif.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Gif --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Gif ## -description Gets the name for Graphics Interchange Format (GIF). ## -property-value Gets the name for GIF. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Gif +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Gif + +## -description +Gets the name for Graphics Interchange Format (GIF). + +## -property-value +Gets the name for GIF. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_h263.md b/windows.media.mediaproperties/mediaencodingsubtypes_h263.md index 21b3773684..f9c78c9342 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_h263.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_h263.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.H263 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.H263 ## -description Gets the name for H.263. ## -property-value The name for H.263. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.H263 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.H263 + +## -description +Gets the name for H.263. + +## -property-value +The name for H.263. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_h264.md b/windows.media.mediaproperties/mediaencodingsubtypes_h264.md index 32a3eb7806..d79fddf19f 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_h264.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_h264.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.H264 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.H264 ## -description The name for H.264. ## -property-value The name for H.264. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.H264 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.H264 + +## -description +The name for H.264. + +## -property-value +The name for H.264. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_h264es.md b/windows.media.mediaproperties/mediaencodingsubtypes_h264es.md index 589b68e4a1..b09b494512 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_h264es.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_h264es.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.H264Es --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.H264Es ## -description Get the name for H.264Es. ## -property-value The name for H.264Es. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.H264Es +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.H264Es + +## -description +Get the name for H.264Es. + +## -property-value +The name for H.264Es. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_hevc.md b/windows.media.mediaproperties/mediaencodingsubtypes_hevc.md index 19b7ead1ee..7d5401e303 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_hevc.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_hevc.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Hevc --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Hevc ## -description Gets the name for High Efficiency Video Coding (HEVC). ## -property-value The name for HEVC. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Hevc +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Hevc + +## -description +Gets the name for High Efficiency Video Coding (HEVC). + +## -property-value +The name for HEVC. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_hevces.md b/windows.media.mediaproperties/mediaencodingsubtypes_hevces.md index 5ed04741e2..bcb48a6ad7 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_hevces.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_hevces.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.HevcEs --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.HevcEs ## -description Gets the name for HEVCES. ## -property-value The name for HEVCES. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.HevcEs +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.HevcEs + +## -description +Gets the name for HEVCES. + +## -property-value +The name for HEVCES. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_iyuv.md b/windows.media.mediaproperties/mediaencodingsubtypes_iyuv.md index f7bfd855f8..7707772365 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_iyuv.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_iyuv.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Iyuv --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Iyuv ## -description Gets the name for IYUV. ## -property-value The name for IYUV. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Iyuv +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Iyuv + +## -description +Gets the name for IYUV. + +## -property-value +The name for IYUV. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_jpeg.md b/windows.media.mediaproperties/mediaencodingsubtypes_jpeg.md index f683469ece..ae0f823963 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_jpeg.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_jpeg.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Jpeg --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Jpeg ## -description Gets the name for JPEG. ## -property-value The name for JPEG. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Jpeg +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Jpeg + +## -description +Gets the name for JPEG. + +## -property-value +The name for JPEG. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_jpegxr.md b/windows.media.mediaproperties/mediaencodingsubtypes_jpegxr.md index 55d53a9d15..48376e84ec 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_jpegxr.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_jpegxr.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.JpegXr --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.JpegXr ## -description Gets the name for JPEG-XR. ## -property-value The name for JPEG-XR. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.JpegXr +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.JpegXr + +## -description +Gets the name for JPEG-XR. + +## -property-value +The name for JPEG-XR. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_mjpg.md b/windows.media.mediaproperties/mediaencodingsubtypes_mjpg.md index 9977848af2..449d326505 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_mjpg.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_mjpg.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mjpg --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Mjpg ## -description Gets the name for Motion JPEG (MJPG). ## -property-value The name for MJPG. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mjpg +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Mjpg + +## -description +Gets the name for Motion JPEG (MJPG). + +## -property-value +The name for MJPG. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_mp3.md b/windows.media.mediaproperties/mediaencodingsubtypes_mp3.md index 3e12ad72d1..67384d3465 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_mp3.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_mp3.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mp3 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Mp3 ## -description Gete the name for MPEG Audio Layer-3 (MP3). ## -property-value The name for MP3. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mp3 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Mp3 + +## -description +Gete the name for MPEG Audio Layer-3 (MP3). + +## -property-value +The name for MP3. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg.md b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg.md index 8551dc2e6e..e34d3ece78 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg ## -description Gets the name for MPEG. ## -property-value The name for MPEG. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg + +## -description +Gets the name for MPEG. + +## -property-value +The name for MPEG. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg1.md b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg1.md index 01860aed39..1fa8a747f1 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg1.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg1.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg1 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg1 ## -description Gets the name for MPEG-1. ## -property-value The name for MPEG-1. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg1 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg1 + +## -description +Gets the name for MPEG-1. + +## -property-value +The name for MPEG-1. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg2.md b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg2.md index cfab9644c1..ea1022d6a1 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg2.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg2.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg2 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg2 ## -description Gets the name for MPEG-2. ## -property-value The name for MPEG-2. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg2 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg2 + +## -description +Gets the name for MPEG-2. + +## -property-value +The name for MPEG-2. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg4.md b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg4.md index ffeda9b394..024696cc70 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_mpeg4.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_mpeg4.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg4 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg4 ## -description Gets the name for MPEG-4. ## -property-value The name for MPEG-4. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg4 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Mpeg4 + +## -description +Gets the name for MPEG-4. + +## -property-value +The name for MPEG-4. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_nv12.md b/windows.media.mediaproperties/mediaencodingsubtypes_nv12.md index 1c1edba4e8..e462384084 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_nv12.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_nv12.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Nv12 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Nv12 ## -description Gets the name for NV12. ## -property-value The name for NV12. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Nv12 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Nv12 + +## -description +Gets the name for NV12. + +## -property-value +The name for NV12. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_pcm.md b/windows.media.mediaproperties/mediaencodingsubtypes_pcm.md index 40a140e1ec..cbfe9c416c 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_pcm.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_pcm.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Pcm --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Pcm ## -description Gets the name for PCM. ## -property-value The name for PCM. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Pcm +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Pcm + +## -description +Gets the name for PCM. + +## -property-value +The name for PCM. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_png.md b/windows.media.mediaproperties/mediaencodingsubtypes_png.md index 4bc6dede8d..2ee3552a90 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_png.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_png.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Png --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Png ## -description Gets the name for Portable Network Graphics (PNG). ## -property-value Gets the name for PNG. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Png +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Png + +## -description +Gets the name for Portable Network Graphics (PNG). + +## -property-value +Gets the name for PNG. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_rgb24.md b/windows.media.mediaproperties/mediaencodingsubtypes_rgb24.md index 785c4e0e3c..4c23308b06 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_rgb24.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_rgb24.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb24 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb24 ## -description Gets the name RGB 24. ## -property-value The name for RGB 24. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb24 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb24 + +## -description +Gets the name RGB 24. + +## -property-value +The name for RGB 24. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_rgb32.md b/windows.media.mediaproperties/mediaencodingsubtypes_rgb32.md index cf74423de5..fdec9efefe 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_rgb32.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_rgb32.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb32 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb32 ## -description Gets the name for RGB 32. ## -property-value The name for RGB 32. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb32 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Rgb32 + +## -description +Gets the name for RGB 32. + +## -property-value +The name for RGB 32. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_tiff.md b/windows.media.mediaproperties/mediaencodingsubtypes_tiff.md index c73180e513..adaee4fa83 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_tiff.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_tiff.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Tiff --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Tiff ## -description Gets the name for TIFF. ## -property-value The name for TIFF. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Tiff +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Tiff + +## -description +Gets the name for TIFF. + +## -property-value +The name for TIFF. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_wave.md b/windows.media.mediaproperties/mediaencodingsubtypes_wave.md index 2951d6aa8b..5fec827b31 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_wave.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_wave.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wave --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Wave ## -description Gets the name for Waveform Audio File (WAVE). ## -property-value The name for WAVE. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wave +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Wave + +## -description +Gets the name for Waveform Audio File (WAVE). + +## -property-value +The name for WAVE. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_wma8.md b/windows.media.mediaproperties/mediaencodingsubtypes_wma8.md index 75e1b1e519..ad39cebf1a 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_wma8.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_wma8.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma8 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma8 ## -description Gets the name for Windows Media Audio 8. ## -property-value Gets the name for WMA 8. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma8 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma8 + +## -description +Gets the name for Windows Media Audio 8. + +## -property-value +Gets the name for WMA 8. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_wma9.md b/windows.media.mediaproperties/mediaencodingsubtypes_wma9.md index 10e55e4b28..beb1b5afdb 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_wma9.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_wma9.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma9 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma9 ## -description Gets the name for Windows Media Audio 8. ## -property-value The name for WMA 9. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma9 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Wma9 + +## -description +Gets the name for Windows Media Audio 8. + +## -property-value +The name for WMA 9. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_wmv3.md b/windows.media.mediaproperties/mediaencodingsubtypes_wmv3.md index 3d458c9633..cd4310bda0 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_wmv3.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_wmv3.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wmv3 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Wmv3 ## -description Gets the name for Windows Media Video 9. ## -property-value Gets the name for WMV3. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wmv3 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Wmv3 + +## -description +Gets the name for Windows Media Video 9. + +## -property-value +Gets the name for WMV3. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_wvc1.md b/windows.media.mediaproperties/mediaencodingsubtypes_wvc1.md index de3272dce1..372baeaed9 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_wvc1.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_wvc1.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wvc1 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Wvc1 ## -description Gets the name for Windows Media Video 9 Advanced Profile. ## -property-value Gets the name for WVC1. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Wvc1 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Wvc1 + +## -description +Gets the name for Windows Media Video 9 Advanced Profile. + +## -property-value +Gets the name for WVC1. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_yuy2.md b/windows.media.mediaproperties/mediaencodingsubtypes_yuy2.md index 245d7fb34a..e3efaec866 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_yuy2.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_yuy2.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Yuy2 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Yuy2 ## -description Gets the name for YUY2. ## -property-value The name for YUY2. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Yuy2 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Yuy2 + +## -description +Gets the name for YUY2. + +## -property-value +The name for YUY2. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_yv12.md b/windows.media.mediaproperties/mediaencodingsubtypes_yv12.md index a81c5a3e3d..627cf3f9b7 100644 --- a/windows.media.mediaproperties/mediaencodingsubtypes_yv12.md +++ b/windows.media.mediaproperties/mediaencodingsubtypes_yv12.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Yv12 --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaEncodingSubtypes.Yv12 ## -description Gets the name for YV12. ## -property-value The name for YV12. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Yv12 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Yv12 + +## -description +Gets the name for YV12. + +## -property-value +The name for YV12. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_clear_556466.md b/windows.media.mediaproperties/mediapropertyset_clear_556466.md index c008d047f5..ce4212ed52 100644 --- a/windows.media.mediaproperties/mediapropertyset_clear_556466.md +++ b/windows.media.mediaproperties/mediapropertyset_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Clear --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.Clear ## -description Removes all items from the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Clear +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.Clear + +## -description +Removes all items from the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_first_1920739956.md b/windows.media.mediaproperties/mediapropertyset_first_1920739956.md index e19e55f112..36b64538c3 100644 --- a/windows.media.mediaproperties/mediapropertyset_first_1920739956.md +++ b/windows.media.mediaproperties/mediapropertyset_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.First --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.First ## -description Returns an iterator to enumerate the items in the property set. ## -returns The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.First +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.First + +## -description +Returns an iterator to enumerate the items in the property set. + +## -returns +The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_getview_37498667.md b/windows.media.mediaproperties/mediapropertyset_getview_37498667.md index 7370c297ee..340e5cdae8 100644 --- a/windows.media.mediaproperties/mediapropertyset_getview_37498667.md +++ b/windows.media.mediaproperties/mediapropertyset_getview_37498667.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.GetView --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.GetView ## -description Returns an immutable view of the property set. ## -returns The immutable view. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.GetView +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.GetView + +## -description +Returns an immutable view of the property set. + +## -returns +The immutable view. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_haskey_379600142.md b/windows.media.mediaproperties/mediapropertyset_haskey_379600142.md index 2877ee591b..723e05c211 100644 --- a/windows.media.mediaproperties/mediapropertyset_haskey_379600142.md +++ b/windows.media.mediaproperties/mediapropertyset_haskey_379600142.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.HasKey(System.Guid) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.HasKey ## -description Indicates whether the property set has an item with the specified key. ## -parameters ### -param key The key. ## -returns True if the property set has an item with the specified key; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.HasKey(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.HasKey + +## -description +Indicates whether the property set has an item with the specified key. + +## -parameters +### -param key +The key. + +## -returns +True if the property set has an item with the specified key; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_insert_1901569558.md b/windows.media.mediaproperties/mediapropertyset_insert_1901569558.md index d1ef6019fd..38a37e1bce 100644 --- a/windows.media.mediaproperties/mediapropertyset_insert_1901569558.md +++ b/windows.media.mediaproperties/mediapropertyset_insert_1901569558.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Insert(System.Guid,System.Object) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.Insert ## -description Adds an item to the property set. ## -parameters ### -param key The key of the item to insert. ### -param value The value of the item to insert. ## -returns True if the method replaced a value that already existed for the key; false if this is a new key. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Insert(System.Guid,System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.Insert + +## -description +Adds an item to the property set. + +## -parameters +### -param key +The key of the item to insert. + +### -param value +The value of the item to insert. + +## -returns +True if the method replaced a value that already existed for the key; false if this is a new key. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_lookup_631550550.md b/windows.media.mediaproperties/mediapropertyset_lookup_631550550.md index b385547c97..07068361f1 100644 --- a/windows.media.mediaproperties/mediapropertyset_lookup_631550550.md +++ b/windows.media.mediaproperties/mediapropertyset_lookup_631550550.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Lookup(System.Guid) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.Lookup ## -description Retrieves the value for the specified key. ## -parameters ### -param key The key. ## -returns The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Lookup(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.Lookup + +## -description +Retrieves the value for the specified key. + +## -parameters +### -param key +The key. + +## -returns +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_mediapropertyset_1221375020.md b/windows.media.mediaproperties/mediapropertyset_mediapropertyset_1221375020.md index ef75694003..f89bc37969 100644 --- a/windows.media.mediaproperties/mediapropertyset_mediapropertyset_1221375020.md +++ b/windows.media.mediaproperties/mediapropertyset_mediapropertyset_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.#ctor --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.MediaPropertySet ## -description Creates an instance for [MediaPropertySet](mediapropertyset.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.MediaPropertySet + +## -description +Creates an instance for [MediaPropertySet](mediapropertyset.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_remove_1452452583.md b/windows.media.mediaproperties/mediapropertyset_remove_1452452583.md index 6a787fa854..8d610b51f8 100644 --- a/windows.media.mediaproperties/mediapropertyset_remove_1452452583.md +++ b/windows.media.mediaproperties/mediapropertyset_remove_1452452583.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Remove(System.Guid) --api-type: winrt method ---- # Windows.Media.MediaProperties.MediaPropertySet.Remove ## -description Removes an item from the property set. ## -parameters ### -param key The key of the item to remove. ## -remarks For the C# and Microsoft Visual Basic version of the **Remove(Guid)** method, see [Remove](mediapropertyset_remove_2.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.MediaPropertySet.Remove(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.Remove + +## -description +Removes an item from the property set. + +## -parameters +### -param key +The key of the item to remove. + +## -remarks +For the C# and Microsoft Visual Basic version of the **Remove(Guid)** method, see [Remove](mediapropertyset_remove_2.md). + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediapropertyset_size.md b/windows.media.mediaproperties/mediapropertyset_size.md index 35fad21ccc..9acca731f7 100644 --- a/windows.media.mediaproperties/mediapropertyset_size.md +++ b/windows.media.mediaproperties/mediapropertyset_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaPropertySet.Size --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaPropertySet.Size ## -description Gets the number of items contained in the property set. ## -property-value The number of items in the property set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaPropertySet.Size +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaPropertySet.Size + +## -description +Gets the number of items contained in the property set. + +## -property-value +The number of items in the property set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaratio_denominator.md b/windows.media.mediaproperties/mediaratio_denominator.md index 42f17c9bbd..474affade1 100644 --- a/windows.media.mediaproperties/mediaratio_denominator.md +++ b/windows.media.mediaproperties/mediaratio_denominator.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaRatio.Denominator --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaRatio.Denominator ## -description The denominator of the MediaRatio. ## -property-value The denominator value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaRatio.Denominator +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaRatio.Denominator + +## -description +The denominator of the MediaRatio. + +## -property-value +The denominator value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mediaratio_numerator.md b/windows.media.mediaproperties/mediaratio_numerator.md index 5b89451b42..4b74f4fde1 100644 --- a/windows.media.mediaproperties/mediaratio_numerator.md +++ b/windows.media.mediaproperties/mediaratio_numerator.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.MediaRatio.Numerator --api-type: winrt property ---- # Windows.Media.MediaProperties.MediaRatio.Numerator ## -description The numerator of the MediaRatio. ## -property-value The numerator value. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.MediaRatio.Numerator +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaRatio.Numerator + +## -description +The numerator of the MediaRatio. + +## -property-value +The numerator value. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mpeg2profileids.md b/windows.media.mediaproperties/mpeg2profileids.md index 76c63cdc8f..8b94b158ed 100644 --- a/windows.media.mediaproperties/mpeg2profileids.md +++ b/windows.media.mediaproperties/mpeg2profileids.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.MediaProperties.Mpeg2ProfileIds --api-type: winrt class ---- # Windows.Media.MediaProperties.Mpeg2ProfileIds ## -description Provides properties for getting MPEG-2 profile ids. ## -remarks You can set the value of [VideoEncodingProperties.ProfileId](videoencodingproperties_profileid.md) to one of the profile ids provided by this class. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.MediaProperties.Mpeg2ProfileIds +-api-type: winrt class +--- + + + +# Windows.Media.MediaProperties.Mpeg2ProfileIds + +## -description +Provides properties for getting MPEG-2 profile ids. + +## -remarks +You can set the value of [VideoEncodingProperties.ProfileId](videoencodingproperties_profileid.md) to one of the profile ids provided by this class. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mpeg2profileids_high.md b/windows.media.mediaproperties/mpeg2profileids_high.md index 813d4400a5..1b51a6aebe 100644 --- a/windows.media.mediaproperties/mpeg2profileids_high.md +++ b/windows.media.mediaproperties/mpeg2profileids_high.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.High --api-type: winrt property ---- # Windows.Media.MediaProperties.Mpeg2ProfileIds.High ## -description Gets the MPEG-2 high profile. ## -property-value The MPEG-2 high profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.High +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.Mpeg2ProfileIds.High + +## -description +Gets the MPEG-2 high profile. + +## -property-value +The MPEG-2 high profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mpeg2profileids_main.md b/windows.media.mediaproperties/mpeg2profileids_main.md index 18af43e33a..f504c9dc64 100644 --- a/windows.media.mediaproperties/mpeg2profileids_main.md +++ b/windows.media.mediaproperties/mpeg2profileids_main.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.Main --api-type: winrt property ---- # Windows.Media.MediaProperties.Mpeg2ProfileIds.Main ## -description Gets the MPEG-2 main profile. ## -property-value The MPEG-2 main profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.Main +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.Mpeg2ProfileIds.Main + +## -description +Gets the MPEG-2 main profile. + +## -property-value +The MPEG-2 main profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mpeg2profileids_signalnoiseratioscalable.md b/windows.media.mediaproperties/mpeg2profileids_signalnoiseratioscalable.md index e63e3bb7df..d812756216 100644 --- a/windows.media.mediaproperties/mpeg2profileids_signalnoiseratioscalable.md +++ b/windows.media.mediaproperties/mpeg2profileids_signalnoiseratioscalable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.SignalNoiseRatioScalable --api-type: winrt property ---- # Windows.Media.MediaProperties.Mpeg2ProfileIds.SignalNoiseRatioScalable ## -description Gets the MPEG-2 signal to noise ratio scalable profile. ## -property-value The MPEG-2 signal to noise ratio scalable profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.SignalNoiseRatioScalable +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.Mpeg2ProfileIds.SignalNoiseRatioScalable + +## -description +Gets the MPEG-2 signal to noise ratio scalable profile. + +## -property-value +The MPEG-2 signal to noise ratio scalable profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mpeg2profileids_simple.md b/windows.media.mediaproperties/mpeg2profileids_simple.md index 4929bf97f9..48891f4ede 100644 --- a/windows.media.mediaproperties/mpeg2profileids_simple.md +++ b/windows.media.mediaproperties/mpeg2profileids_simple.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.Simple --api-type: winrt property ---- # Windows.Media.MediaProperties.Mpeg2ProfileIds.Simple ## -description Gets the MPEG-2 simple profile. ## -property-value The MPEG-2 simple profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.Simple +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.Mpeg2ProfileIds.Simple + +## -description +Gets the MPEG-2 simple profile. + +## -property-value +The MPEG-2 simple profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/mpeg2profileids_spatiallyscalable.md b/windows.media.mediaproperties/mpeg2profileids_spatiallyscalable.md index 181f146ce9..dd507bf636 100644 --- a/windows.media.mediaproperties/mpeg2profileids_spatiallyscalable.md +++ b/windows.media.mediaproperties/mpeg2profileids_spatiallyscalable.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.SpatiallyScalable --api-type: winrt property ---- # Windows.Media.MediaProperties.Mpeg2ProfileIds.SpatiallyScalable ## -description Gets the MPEG-2 spatially scalable profile. ## -property-value The MPEG-2 spatially scalable profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.Mpeg2ProfileIds.SpatiallyScalable +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.Mpeg2ProfileIds.SpatiallyScalable + +## -description +Gets the MPEG-2 spatially scalable profile. + +## -property-value +The MPEG-2 spatially scalable profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_bitrate.md b/windows.media.mediaproperties/videoencodingproperties_bitrate.md index e4e77c6996..3a29acde49 100644 --- a/windows.media.mediaproperties/videoencodingproperties_bitrate.md +++ b/windows.media.mediaproperties/videoencodingproperties_bitrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Bitrate --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.Bitrate ## -description Gets or sets the video bit rate. ## -property-value The average bit rate of the video stream, in bits per second. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Bitrate +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.Bitrate + +## -description +Gets or sets the video bit rate. + +## -property-value +The average bit rate of the video stream, in bits per second. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md b/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md index 3060a1f3bc..06b633fe6a 100644 --- a/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md +++ b/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 --api-type: winrt method ---- # Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 ## -description Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a H.263 video. ## -returns The video encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 + +## -description +Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a H.263 video. + +## -returns +The video encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_creatempeg2_1881310423.md b/windows.media.mediaproperties/videoencodingproperties_creatempeg2_1881310423.md index f839ef5543..2a107f0621 100644 --- a/windows.media.mediaproperties/videoencodingproperties_creatempeg2_1881310423.md +++ b/windows.media.mediaproperties/videoencodingproperties_creatempeg2_1881310423.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateMpeg2 --api-type: winrt method ---- # Windows.Media.MediaProperties.VideoEncodingProperties.CreateMpeg2 ## -description Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a MPEG-2 video. ## -returns The video encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateMpeg2 +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.CreateMpeg2 + +## -description +Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a MPEG-2 video. + +## -returns +The video encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_createuncompressed_754748975.md b/windows.media.mediaproperties/videoencodingproperties_createuncompressed_754748975.md index 6c5baa3399..6ce0da2bb3 100644 --- a/windows.media.mediaproperties/videoencodingproperties_createuncompressed_754748975.md +++ b/windows.media.mediaproperties/videoencodingproperties_createuncompressed_754748975.md @@ -1,3 +1,32 @@ ---- -api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateUncompressed(System.String,System.UInt32,System.UInt32) --api-type: winrt method ---- # Windows.Media.MediaProperties.VideoEncodingProperties.CreateUncompressed ## -description Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a uncompressed video. ## -parameters ### -param subtype The media subtype of the format. ### -param width The video image width. ### -param height The video image height. ## -returns The video encoding properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateUncompressed(System.String,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.CreateUncompressed + +## -description +Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a uncompressed video. + +## -parameters +### -param subtype +The media subtype of the format. + +### -param width +The video image width. + +### -param height +The video image height. + +## -returns +The video encoding properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_framerate.md b/windows.media.mediaproperties/videoencodingproperties_framerate.md index d33f549cf7..edf9b6c5e4 100644 --- a/windows.media.mediaproperties/videoencodingproperties_framerate.md +++ b/windows.media.mediaproperties/videoencodingproperties_framerate.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.FrameRate --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.FrameRate ## -description Gets or sets the video frame rate. ## -property-value The frame rate, in frames per second. The frame rate is expressed as a ratio. For example, if the frame rate is 30 frames per second (fps), the ratio is 30/1. If the frame rate is 29.97 fps, the ratio is 30,000/1001. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.FrameRate +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.FrameRate + +## -description +Gets or sets the video frame rate. + +## -property-value +The frame rate, in frames per second. + +The frame rate is expressed as a ratio. For example, if the frame rate is 30 frames per second (fps), the ratio is 30/1. If the frame rate is 29.97 fps, the ratio is 30,000/1001. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_getformatuserdata_1710152786.md b/windows.media.mediaproperties/videoencodingproperties_getformatuserdata_1710152786.md index c0bc973270..ffe0d27122 100644 --- a/windows.media.mediaproperties/videoencodingproperties_getformatuserdata_1710152786.md +++ b/windows.media.mediaproperties/videoencodingproperties_getformatuserdata_1710152786.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.GetFormatUserData(System.Byte[]@) --api-type: winrt method ---- # Windows.Media.MediaProperties.VideoEncodingProperties.GetFormatUserData ## -description Gets the media format user data. ## -parameters ### -param value Receives the media format data. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.GetFormatUserData(System.Byte[]@) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.GetFormatUserData + +## -description +Gets the media format user data. + +## -parameters +### -param value +Receives the media format data. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_height.md b/windows.media.mediaproperties/videoencodingproperties_height.md index f4b3c3cebd..1932c36d7e 100644 --- a/windows.media.mediaproperties/videoencodingproperties_height.md +++ b/windows.media.mediaproperties/videoencodingproperties_height.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Height --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.Height ## -description Gets or sets the video image height. ## -property-value The height of the video image, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Height +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.Height + +## -description +Gets or sets the video image height. + +## -property-value +The height of the video image, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_pixelaspectratio.md b/windows.media.mediaproperties/videoencodingproperties_pixelaspectratio.md index a913c18d7f..cb33f53377 100644 --- a/windows.media.mediaproperties/videoencodingproperties_pixelaspectratio.md +++ b/windows.media.mediaproperties/videoencodingproperties_pixelaspectratio.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.PixelAspectRatio --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.PixelAspectRatio ## -description Gets or sets the pixel aspect ratio. ## -property-value The pixel aspect ratio. ## -remarks The pixel aspect ratio describes the shape of the pixels in the displayed video image. For square pixels, the pixel aspect ratio is 1:1. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.PixelAspectRatio +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.PixelAspectRatio + +## -description +Gets or sets the pixel aspect ratio. + +## -property-value +The pixel aspect ratio. + +## -remarks +The pixel aspect ratio describes the shape of the pixels in the displayed video image. For square pixels, the pixel aspect ratio is 1:1. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_profileid.md b/windows.media.mediaproperties/videoencodingproperties_profileid.md index 5f097a0b08..373deb29e0 100644 --- a/windows.media.mediaproperties/videoencodingproperties_profileid.md +++ b/windows.media.mediaproperties/videoencodingproperties_profileid.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.ProfileId --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.ProfileId ## -description Gets or sets the media format profile. ## -property-value The media format profile. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.ProfileId +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.ProfileId + +## -description +Gets or sets the media format profile. + +## -property-value +The media format profile. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_properties.md b/windows.media.mediaproperties/videoencodingproperties_properties.md index 314a5a525c..c701d13acc 100644 --- a/windows.media.mediaproperties/videoencodingproperties_properties.md +++ b/windows.media.mediaproperties/videoencodingproperties_properties.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Properties --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.Properties ## -description Gets additional format properties for the video stream. ## -property-value A property set that contains format properties. ## -remarks For information on working with a property set collection, see [PropertySet](../windows.foundation.collections/propertyset.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Properties +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.Properties + +## -description +Gets additional format properties for the video stream. + +## -property-value +A property set that contains format properties. + +## -remarks +For information on working with a property set collection, see [PropertySet](../windows.foundation.collections/propertyset.md). + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_setformatuserdata_1623528230.md b/windows.media.mediaproperties/videoencodingproperties_setformatuserdata_1623528230.md index 7dfaafd9e2..7271efaf52 100644 --- a/windows.media.mediaproperties/videoencodingproperties_setformatuserdata_1623528230.md +++ b/windows.media.mediaproperties/videoencodingproperties_setformatuserdata_1623528230.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.SetFormatUserData(System.Byte[]) --api-type: winrt method ---- # Windows.Media.MediaProperties.VideoEncodingProperties.SetFormatUserData ## -description Sets the media format user data. ## -parameters ### -param value The media data to set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.SetFormatUserData(System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.SetFormatUserData + +## -description +Sets the media format user data. + +## -parameters +### -param value +The media data to set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_stereoscopicvideopackingmode.md b/windows.media.mediaproperties/videoencodingproperties_stereoscopicvideopackingmode.md index d9d9652408..d7dd56be0a 100644 --- a/windows.media.mediaproperties/videoencodingproperties_stereoscopicvideopackingmode.md +++ b/windows.media.mediaproperties/videoencodingproperties_stereoscopicvideopackingmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.StereoscopicVideoPackingMode --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.StereoscopicVideoPackingMode ## -description Gets a value indicating the stereoscopic video packing mode of the video stream. ## -property-value The stereoscopic video packing mode of the video stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.StereoscopicVideoPackingMode +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.StereoscopicVideoPackingMode + +## -description +Gets a value indicating the stereoscopic video packing mode of the video stream. + +## -property-value +The stereoscopic video packing mode of the video stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_subtype.md b/windows.media.mediaproperties/videoencodingproperties_subtype.md index 4f15d4f744..4d4c4597be 100644 --- a/windows.media.mediaproperties/videoencodingproperties_subtype.md +++ b/windows.media.mediaproperties/videoencodingproperties_subtype.md @@ -1,3 +1,50 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Subtype --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.Subtype ## -description Gets or sets the subtype of the format. ## -property-value The subtype. ## -remarks The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table.
ValueDescription
"ARGB32"RGB, 32 bpp with alpha channel.
"BGRA8"BGRA, 32 bpp with alpha channel.
"D16"16-bit z-buffer depth
"H263"H.263 video
"H264"H.264 video
"H264ES"H.264 elementary stream
"HEVC"HEVC video
"HEVCES"HEVT elementary stream
"IYUV"YUV 8 bpp 4:2:0
"L8"8-bit luminance only.
"L16"16-bit luminance only.
"MJPG"Motion jpeg
"NV12"YUV 8 bpp 4:2:0
"MPEG1"MPEG-1 video
"MPEG2"MPEG-2 video
"RGB24"RGB, 24 bpp
"RGB32"RGB, 32 bpp
"WMV3"Windows Media Video 9 codec
"WVC1"SMPTE 421M ("VC-1") codec
"VP9"VP9 video
"YUY2"YUV 8 bpp 4:2:2
"YV12"YUV 8 bpp 4:2:0
> [!WARNING] > The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Subtype +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.Subtype + +## -description +Gets or sets the subtype of the format. + +## -property-value +The subtype. + +## -remarks +The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table. + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
"ARGB32"RGB, 32 bpp with alpha channel.
"BGRA8"BGRA, 32 bpp with alpha channel.
"D16"16-bit z-buffer depth
"H263"H.263 video
"H264"H.264 video
"H264ES"H.264 elementary stream
"HEVC"HEVC video
"HEVCES"HEVT elementary stream
"IYUV"YUV 8 bpp 4:2:0
"L8"8-bit luminance only.
"L16"16-bit luminance only.
"MJPG"Motion jpeg
"NV12"YUV 8 bpp 4:2:0
"MPEG1"MPEG-1 video
"MPEG2"MPEG-2 video
"RGB24"RGB, 24 bpp
"RGB32"RGB, 32 bpp
"WMV3"Windows Media Video 9 codec
"WVC1"SMPTE 421M ("VC-1") codec
"VP9"VP9 video
"YUY2"YUV 8 bpp 4:2:2
"YV12"YUV 8 bpp 4:2:0
+ +> [!WARNING] +> The string values returned by the [MediaEncodingSubtypes](mediaencodingsubtypes.md) properties may not use the same letter casing as [AudioEncodingProperties.Subtype](audioencodingproperties_subtype.md), [VideoEncodingProperties.Subtype](videoencodingproperties_subtype.md), [ContainerEncodingProperties.Subtype](containerencodingproperties_subtype.md), and [ImageEncodingProperties.Subtype](imageencodingproperties_subtype.md). For this reason, if you compare the values, you should use a case-insensitive comparison or use hardcoded strings that match the casing returned by the encoding properties. + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_type.md b/windows.media.mediaproperties/videoencodingproperties_type.md index 4795a0e159..fd634fe5e8 100644 --- a/windows.media.mediaproperties/videoencodingproperties_type.md +++ b/windows.media.mediaproperties/videoencodingproperties_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Type --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.Type ## -description Gets the format type. ## -property-value The format type. For video streams, the format type is "Video". ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Type +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.Type + +## -description +Gets the format type. + +## -property-value +The format type. For video streams, the format type is "Video". + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_videoencodingproperties_1221375020.md b/windows.media.mediaproperties/videoencodingproperties_videoencodingproperties_1221375020.md index 35392dae56..7a1b99d4ce 100644 --- a/windows.media.mediaproperties/videoencodingproperties_videoencodingproperties_1221375020.md +++ b/windows.media.mediaproperties/videoencodingproperties_videoencodingproperties_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.#ctor --api-type: winrt method ---- # Windows.Media.MediaProperties.VideoEncodingProperties.VideoEncodingProperties ## -description Creates a new instance of the [VideoEncodingProperties](videoencodingproperties.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.VideoEncodingProperties + +## -description +Creates a new instance of the [VideoEncodingProperties](videoencodingproperties.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.mediaproperties/videoencodingproperties_width.md b/windows.media.mediaproperties/videoencodingproperties_width.md index b2d787de5f..c026b8dfa4 100644 --- a/windows.media.mediaproperties/videoencodingproperties_width.md +++ b/windows.media.mediaproperties/videoencodingproperties_width.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Width --api-type: winrt property ---- # Windows.Media.MediaProperties.VideoEncodingProperties.Width ## -description Gets or sets the video image width. ## -property-value The width of the video image, in pixels. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.Width +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.Width + +## -description +Gets or sets the video image width. + +## -property-value +The width of the video image, in pixels. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine.md b/windows.media.ocr/ocrengine.md index 8d6f3ccc81..d90b2b5711 100644 --- a/windows.media.ocr/ocrengine.md +++ b/windows.media.ocr/ocrengine.md @@ -1,3 +1,26 @@ ---- -api-id: T:Windows.Media.Ocr.OcrEngine --api-type: winrt class ---- # Windows.Media.Ocr.OcrEngine ## -description Provides optical character recognition (OCR) functionality. ## -remarks To use the OCR capabilities of the **OcrEngine** class in your app, call the [RecognizeAsync](ocrengine_recognizeasync.md) method. When you call the **RecognizeAsync** method of the **OcrEngine** class, the method returns an [OcrResult](ocrresult.md) object, which contains the recognized text and its size and position. The result is split into lines, and the lines are split into words. + The [OcrResult](ocrresult.md) contains a collection of [OcrLine](ocrline.md) objects, which you access through the [Lines](ocrresult_lines.md) property of the **OcrResult**. + Each [OcrLine](ocrline.md) object contains a collection of [OcrWord](ocrword.md) objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. + Each [OcrWord](ocrword.md) object specifies the text, size, and position information of the word in the image. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Ocr.OcrEngine +-api-type: winrt class +--- + + + +# Windows.Media.Ocr.OcrEngine + +## -description +Provides optical character recognition (OCR) functionality. + +## -remarks +To use the OCR capabilities of the **OcrEngine** class in your app, call the [RecognizeAsync](ocrengine_recognizeasync.md) method. When you call the **RecognizeAsync** method of the **OcrEngine** class, the method returns an [OcrResult](ocrresult.md) object, which contains the recognized text and its size and position. The result is split into lines, and the lines are split into words. + + ++ The [OcrResult](ocrresult.md) contains a collection of [OcrLine](ocrline.md) objects, which you access through the [Lines](ocrresult_lines.md) property of the **OcrResult**. ++ Each [OcrLine](ocrline.md) object contains a collection of [OcrWord](ocrword.md) objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. ++ Each [OcrWord](ocrword.md) object specifies the text, size, and position information of the word in the image. + + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_availablerecognizerlanguages.md b/windows.media.ocr/ocrengine_availablerecognizerlanguages.md index 3b27b38283..f855ecf4b6 100644 --- a/windows.media.ocr/ocrengine_availablerecognizerlanguages.md +++ b/windows.media.ocr/ocrengine_availablerecognizerlanguages.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Ocr.OcrEngine.AvailableRecognizerLanguages --api-type: winrt property ---- # Windows.Media.Ocr.OcrEngine.AvailableRecognizerLanguages ## -description Returns a collection of all available OCR languages on the device. ## -property-value A collection of all available OCR languages on the device. > [!NOTE] > A language pack must be installed on the device to be used. A user can install new OCR language packs through the Settings app. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrEngine.AvailableRecognizerLanguages +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrEngine.AvailableRecognizerLanguages + +## -description +Returns a collection of all available OCR languages on the device. + +## -property-value +A collection of all available OCR languages on the device. + +> [!NOTE] +> A language pack must be installed on the device to be used. A user can install new OCR language packs through the Settings app. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_islanguagesupported_1877973836.md b/windows.media.ocr/ocrengine_islanguagesupported_1877973836.md index 9b293d2a83..531bc8f0ce 100644 --- a/windows.media.ocr/ocrengine_islanguagesupported_1877973836.md +++ b/windows.media.ocr/ocrengine_islanguagesupported_1877973836.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Ocr.OcrEngine.IsLanguageSupported(Windows.Globalization.Language) --api-type: winrt method ---- # Windows.Media.Ocr.OcrEngine.IsLanguageSupported ## -description Returns true if a specified language can be resolved to any of the available OCR languages. See [language matching](http://go.microsoft.com/fwlink/?LinkId=534536) for a further explanation of language resolving. ## -parameters ### -param language The language being used for text recognition. ## -returns TRUE, if the specified language can be resolved to any of the available OCR languages; otherwise, FALSE. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Ocr.OcrEngine.IsLanguageSupported(Windows.Globalization.Language) +-api-type: winrt method +--- + + + +# Windows.Media.Ocr.OcrEngine.IsLanguageSupported + +## -description +Returns true if a specified language can be resolved to any of the available OCR languages. See [language matching](http://go.microsoft.com/fwlink/?LinkId=534536) for a further explanation of language resolving. + +## -parameters +### -param language +The language being used for text recognition. + +## -returns +TRUE, if the specified language can be resolved to any of the available OCR languages; otherwise, FALSE. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_maximagedimension.md b/windows.media.ocr/ocrengine_maximagedimension.md index bf067b34cb..dc7bb4824a 100644 --- a/windows.media.ocr/ocrengine_maximagedimension.md +++ b/windows.media.ocr/ocrengine_maximagedimension.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Ocr.OcrEngine.MaxImageDimension --api-type: winrt property ---- # Windows.Media.Ocr.OcrEngine.MaxImageDimension ## -description Gets the maximum image pixel dimensions supported by the OCR engine. ## -property-value The maximum image pixel dimensions supported by the OCR engine. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrEngine.MaxImageDimension +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrEngine.MaxImageDimension + +## -description +Gets the maximum image pixel dimensions supported by the OCR engine. + +## -property-value +The maximum image pixel dimensions supported by the OCR engine. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_recognizeasync_614325911.md b/windows.media.ocr/ocrengine_recognizeasync_614325911.md index 77c20e7929..21a41a7fa4 100644 --- a/windows.media.ocr/ocrengine_recognizeasync_614325911.md +++ b/windows.media.ocr/ocrengine_recognizeasync_614325911.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Ocr.OcrEngine.RecognizeAsync(Windows.Graphics.Imaging.SoftwareBitmap) --api-type: winrt method ---- # Windows.Media.Ocr.OcrEngine.RecognizeAsync ## -description Scans the specified image for text in the language specified by the [RecognizerLanguage](ocrengine_recognizerlanguage.md) property. ## -parameters ### -param bitmap Represents an uncompressed bitmap. ## -returns The result of the OCR that was initiated by the [OcrEngine](ocrengine.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Ocr.OcrEngine.RecognizeAsync(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.Media.Ocr.OcrEngine.RecognizeAsync + +## -description +Scans the specified image for text in the language specified by the [RecognizerLanguage](ocrengine_recognizerlanguage.md) property. + +## -parameters +### -param bitmap +Represents an uncompressed bitmap. + +## -returns +The result of the OCR that was initiated by the [OcrEngine](ocrengine.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_recognizerlanguage.md b/windows.media.ocr/ocrengine_recognizerlanguage.md index 0b49058766..77dd209f9a 100644 --- a/windows.media.ocr/ocrengine_recognizerlanguage.md +++ b/windows.media.ocr/ocrengine_recognizerlanguage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Ocr.OcrEngine.RecognizerLanguage --api-type: winrt property ---- # Windows.Media.Ocr.OcrEngine.RecognizerLanguage ## -description Gets the language being used for text recognition. ## -property-value The language being used for text recognition. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrEngine.RecognizerLanguage +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrEngine.RecognizerLanguage + +## -description +Gets the language being used for text recognition. + +## -property-value +The language being used for text recognition. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_trycreatefromlanguage_692673902.md b/windows.media.ocr/ocrengine_trycreatefromlanguage_692673902.md index 1a899654fd..9d3284e227 100644 --- a/windows.media.ocr/ocrengine_trycreatefromlanguage_692673902.md +++ b/windows.media.ocr/ocrengine_trycreatefromlanguage_692673902.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Ocr.OcrEngine.TryCreateFromLanguage(Windows.Globalization.Language) --api-type: winrt method ---- # Windows.Media.Ocr.OcrEngine.TryCreateFromLanguage ## -description Creates a new instance of the [OcrEngine](ocrengine.md) class. ## -parameters ### -param language The language being used for text recognition. ## -returns If the specified language can be resolved to any of the OCR languages available on the device, returns new instance of **OcrEngine** class, otherwise returns **null**. See [language matching](http://go.microsoft.com/fwlink/?LinkId=534536) for a further explanation of language resolving. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Ocr.OcrEngine.TryCreateFromLanguage(Windows.Globalization.Language) +-api-type: winrt method +--- + + + +# Windows.Media.Ocr.OcrEngine.TryCreateFromLanguage + +## -description +Creates a new instance of the [OcrEngine](ocrengine.md) class. + +## -parameters +### -param language +The language being used for text recognition. + +## -returns +If the specified language can be resolved to any of the OCR languages available on the device, returns new instance of **OcrEngine** class, otherwise returns **null**. See [language matching](http://go.microsoft.com/fwlink/?LinkId=534536) for a further explanation of language resolving. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrengine_trycreatefromuserprofilelanguages_789329720.md b/windows.media.ocr/ocrengine_trycreatefromuserprofilelanguages_789329720.md index a26bae49e1..c1b49951f4 100644 --- a/windows.media.ocr/ocrengine_trycreatefromuserprofilelanguages_789329720.md +++ b/windows.media.ocr/ocrengine_trycreatefromuserprofilelanguages_789329720.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Ocr.OcrEngine.TryCreateFromUserProfileLanguages --api-type: winrt method ---- # Windows.Media.Ocr.OcrEngine.TryCreateFromUserProfileLanguages ## -description Creates a new instance of the [OcrEngine](ocrengine.md) class. ## -returns If any language from **GlobalizationPreferences.Languages** can be resolved to any of the available OCR languages returns new instance of **OcrEngine** class, otherwise returns **null**. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Ocr.OcrEngine.TryCreateFromUserProfileLanguages +-api-type: winrt method +--- + + + +# Windows.Media.Ocr.OcrEngine.TryCreateFromUserProfileLanguages + +## -description +Creates a new instance of the [OcrEngine](ocrengine.md) class. + +## -returns +If any language from **GlobalizationPreferences.Languages** can be resolved to any of the available OCR languages returns new instance of **OcrEngine** class, otherwise returns **null**. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrline.md b/windows.media.ocr/ocrline.md index e2d9090633..8e1d8d7736 100644 --- a/windows.media.ocr/ocrline.md +++ b/windows.media.ocr/ocrline.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Ocr.OcrLine --api-type: winrt class ---- # Windows.Media.Ocr.OcrLine ## -description Represents a single line of text recognized by the OCR engine and returned as part of the [OcrResult](ocrresult.md). ## -remarks When you call the [RecognizeAsync](ocrengine_recognizeasync.md) method of the [OcrEngine](ocrengine.md) class, the method returns an [OcrResult](ocrresult.md) object. The **OcrResult** contains a collection of **OcrLine** objects, which you access through the [Lines](ocrresult_lines.md) property of the **OcrResult**. Each **OcrLine** object contains a collection of [OcrWord](ocrword.md) objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Ocr.OcrLine +-api-type: winrt class +--- + + + +# Windows.Media.Ocr.OcrLine + +## -description +Represents a single line of text recognized by the OCR engine and returned as part of the [OcrResult](ocrresult.md). + +## -remarks +When you call the [RecognizeAsync](ocrengine_recognizeasync.md) method of the [OcrEngine](ocrengine.md) class, the method returns an [OcrResult](ocrresult.md) object. The **OcrResult** contains a collection of **OcrLine** objects, which you access through the [Lines](ocrresult_lines.md) property of the **OcrResult**. Each **OcrLine** object contains a collection of [OcrWord](ocrword.md) objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrline_text.md b/windows.media.ocr/ocrline_text.md index a043a42871..5e2b18a0c5 100644 --- a/windows.media.ocr/ocrline_text.md +++ b/windows.media.ocr/ocrline_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Ocr.OcrLine.Text --api-type: winrt property ---- # Windows.Media.Ocr.OcrLine.Text ## -description Gets the text of the recognized line. ## -property-value The text of the recognized line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrLine.Text +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrLine.Text + +## -description +Gets the text of the recognized line. + +## -property-value +The text of the recognized line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrline_words.md b/windows.media.ocr/ocrline_words.md index 3fc4d7f13f..ca0556e100 100644 --- a/windows.media.ocr/ocrline_words.md +++ b/windows.media.ocr/ocrline_words.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Ocr.OcrLine.Words --api-type: winrt property ---- # Windows.Media.Ocr.OcrLine.Words ## -description Gets the collection of [OcrWord](ocrword.md) objects that represents the words detected in the current line of text by the [RecognizeAsync](ocrengine_recognizeasync.md) method. ## -property-value The collection of [OcrWord](ocrword.md) objects that represents the words detected in the current line of text by the [RecognizeAsync](ocrengine_recognizeasync.md) method. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrLine.Words +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrLine.Words + +## -description +Gets the collection of [OcrWord](ocrword.md) objects that represents the words detected in the current line of text by the [RecognizeAsync](ocrengine_recognizeasync.md) method. + +## -property-value +The collection of [OcrWord](ocrword.md) objects that represents the words detected in the current line of text by the [RecognizeAsync](ocrengine_recognizeasync.md) method. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrresult_lines.md b/windows.media.ocr/ocrresult_lines.md index 939075d839..2b43d90ee3 100644 --- a/windows.media.ocr/ocrresult_lines.md +++ b/windows.media.ocr/ocrresult_lines.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Ocr.OcrResult.Lines --api-type: winrt property ---- # Windows.Media.Ocr.OcrResult.Lines ## -description Gets the collection of [OcrLine](ocrline.md) objects that represents the lines of text detected in the image by the [RecognizeAsync](ocrengine_recognizeasync.md) method. ## -property-value The collection of [OcrLine](ocrline.md) objects that represents the lines of text detected in the image by the [RecognizeAsync](ocrengine_recognizeasync.md) method. ## -remarks When you call the [RecognizeAsync](ocrengine_recognizeasync.md) method of the [OcrEngine](ocrengine.md) class, the method returns an [OcrResult](ocrresult.md) object. The **OcrResult** contains a collection of [OcrLine](ocrline.md) objects, which you access through the **Lines** property of the **OcrResult**. Each **OcrLine** object contains a collection of [OcrWord](ocrword.md) objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrResult.Lines +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrResult.Lines + +## -description +Gets the collection of [OcrLine](ocrline.md) objects that represents the lines of text detected in the image by the [RecognizeAsync](ocrengine_recognizeasync.md) method. + +## -property-value +The collection of [OcrLine](ocrline.md) objects that represents the lines of text detected in the image by the [RecognizeAsync](ocrengine_recognizeasync.md) method. + +## -remarks +When you call the [RecognizeAsync](ocrengine_recognizeasync.md) method of the [OcrEngine](ocrengine.md) class, the method returns an [OcrResult](ocrresult.md) object. The **OcrResult** contains a collection of [OcrLine](ocrline.md) objects, which you access through the **Lines** property of the **OcrResult**. Each **OcrLine** object contains a collection of [OcrWord](ocrword.md) objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrresult_text.md b/windows.media.ocr/ocrresult_text.md index c889d1598c..e528202ad4 100644 --- a/windows.media.ocr/ocrresult_text.md +++ b/windows.media.ocr/ocrresult_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Ocr.OcrResult.Text --api-type: winrt property ---- # Windows.Media.Ocr.OcrResult.Text ## -description Gets the recognized text. ## -property-value The recognized text. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrResult.Text +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrResult.Text + +## -description +Gets the recognized text. + +## -property-value +The recognized text. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrresult_textangle.md b/windows.media.ocr/ocrresult_textangle.md index ec2a452a79..1094bbfacf 100644 --- a/windows.media.ocr/ocrresult_textangle.md +++ b/windows.media.ocr/ocrresult_textangle.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Ocr.OcrResult.TextAngle --api-type: winrt property ---- # Windows.Media.Ocr.OcrResult.TextAngle ## -description Gets the clockwise rotation of the recognized text, in degrees, around the center of the image. ## -property-value The clockwise rotation of the recognized text, in degrees, around the center of the image. If the angle of the text can't be detected, the value of this property is **null**. If the image contains text at different angles, only part of the text will be recognized correctly. ## -remarks Use the **TextAngle** property to overlay recognition results correctly on the original image. If the value of the **TextAngle** property is not null or 0 (zero), then to overlay the recognized text correctly on the original image, you either have to rotate the original image by the detected angle in a counter-clockwise direction, or rotate the recognized text by the detected angle in a clockwise direction. Example of text angle in an image ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrResult.TextAngle +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrResult.TextAngle + +## -description +Gets the clockwise rotation of the recognized text, in degrees, around the center of the image. + +## -property-value +The clockwise rotation of the recognized text, in degrees, around the center of the image. If the angle of the text can't be detected, the value of this property is **null**. If the image contains text at different angles, only part of the text will be recognized correctly. + +## -remarks +Use the **TextAngle** property to overlay recognition results correctly on the original image. If the value of the **TextAngle** property is not null or 0 (zero), then to overlay the recognized text correctly on the original image, you either have to rotate the original image by the detected angle in a counter-clockwise direction, or rotate the recognized text by the detected angle in a clockwise direction. + +Example of text angle in an image + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrword.md b/windows.media.ocr/ocrword.md index ac66390fa6..6ba1b84309 100644 --- a/windows.media.ocr/ocrword.md +++ b/windows.media.ocr/ocrword.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Ocr.OcrWord --api-type: winrt class ---- # Windows.Media.Ocr.OcrWord ## -description Represents a single word in a line of text recognized by the OCR engine and returned as part of the [OcrLine](ocrline.md). ## -remarks When you call the [RecognizeAsync](ocrengine_recognizeasync.md) method of the [OcrEngine](ocrengine.md) class, the method returns an [OcrResult](ocrresult.md) object. The **OcrResult** contains a collection of [OcrLine](ocrline.md) objects, which you access through the [Lines](ocrresult_lines.md) property of the **OcrResult**. Each **OcrLine** object contains a collection of **OcrWord** objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Ocr.OcrWord +-api-type: winrt class +--- + + + +# Windows.Media.Ocr.OcrWord + +## -description +Represents a single word in a line of text recognized by the OCR engine and returned as part of the [OcrLine](ocrline.md). + +## -remarks +When you call the [RecognizeAsync](ocrengine_recognizeasync.md) method of the [OcrEngine](ocrengine.md) class, the method returns an [OcrResult](ocrresult.md) object. The **OcrResult** contains a collection of [OcrLine](ocrline.md) objects, which you access through the [Lines](ocrresult_lines.md) property of the **OcrResult**. Each **OcrLine** object contains a collection of **OcrWord** objects, which you access through the [Words](ocrline_words.md) property of each **OcrLine**. + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrword_boundingrect.md b/windows.media.ocr/ocrword_boundingrect.md index 52e1249a6a..bc9dfeb450 100644 --- a/windows.media.ocr/ocrword_boundingrect.md +++ b/windows.media.ocr/ocrword_boundingrect.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Ocr.OcrWord.BoundingRect --api-type: winrt property ---- # Windows.Media.Ocr.OcrWord.BoundingRect ## -description Gets the position and size in pixels of the recognized word from the top left corner of image when the value of [TextAngle](ocrresult_textangle.md) property is 0 (zero). ## -property-value The position and size in pixels of the recognized word from the top left corner of image when the value of [TextAngle](ocrresult_textangle.md) property is 0 (zero). ## -remarks When the value of the [TextAngle](ocrresult_textangle.md) property is not null, the values of the Left and Top properties of BoundingBox are calculated from the rotated image. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrWord.BoundingRect +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrWord.BoundingRect + +## -description +Gets the position and size in pixels of the recognized word from the top left corner of image when the value of [TextAngle](ocrresult_textangle.md) property is 0 (zero). + +## -property-value +The position and size in pixels of the recognized word from the top left corner of image when the value of [TextAngle](ocrresult_textangle.md) property is 0 (zero). + +## -remarks +When the value of the [TextAngle](ocrresult_textangle.md) property is not null, the values of the Left and Top properties of BoundingBox are calculated from the rotated image. + +## -examples + +## -see-also diff --git a/windows.media.ocr/ocrword_text.md b/windows.media.ocr/ocrword_text.md index 11efa4a60c..8673bb9549 100644 --- a/windows.media.ocr/ocrword_text.md +++ b/windows.media.ocr/ocrword_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Ocr.OcrWord.Text --api-type: winrt property ---- # Windows.Media.Ocr.OcrWord.Text ## -description Gets the text of the recognized word. ## -property-value The text of the recognized word. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Ocr.OcrWord.Text +-api-type: winrt property +--- + + + +# Windows.Media.Ocr.OcrWord.Text + +## -description +Gets the text of the recognized word. + +## -property-value +The text of the recognized word. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer.md b/windows.media.playback/backgroundmediaplayer.md index b9230104d6..af3d2d7d43 100644 --- a/windows.media.playback/backgroundmediaplayer.md +++ b/windows.media.playback/backgroundmediaplayer.md @@ -1,3 +1,21 @@ ---- -api-id: T:Windows.Media.Playback.BackgroundMediaPlayer --api-type: winrt class ---- # Windows.Media.Playback.BackgroundMediaPlayer ## -description Provides access to the media player while it is running in the background. ## -remarks Starting with Windows 10, version 1607, apps should use the [MediaPlayer](mediaplayer.md) for media playback. This object allows you to play media in the background seamlessly, using a single process. For information on using **MediaPlayer**, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer). For information on playing media in the background with **MediaPlayer**, see [Play media in the background](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/background-audio). For information on the legacy, two-process background playback model, which is still supported for backwards compatibility, see [Legacy background media playback](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/legacy-background-media-playback). ## -examples ## -see-also [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer), [Play media in the background](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/background-audio), [Legacy background media playback](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/legacy-background-media-playback) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.BackgroundMediaPlayer +-api-type: winrt class +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer + +## -description +Provides access to the media player while it is running in the background. + +## -remarks +Starting with Windows 10, version 1607, apps should use the [MediaPlayer](mediaplayer.md) for media playback. This object allows you to play media in the background seamlessly, using a single process. For information on using **MediaPlayer**, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer). For information on playing media in the background with **MediaPlayer**, see [Play media in the background](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/background-audio). For information on the legacy, two-process background playback model, which is still supported for backwards compatibility, see [Legacy background media playback](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/legacy-background-media-playback). + +## -examples + +## -see-also +[Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer), [Play media in the background](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/background-audio), [Legacy background media playback](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/legacy-background-media-playback) \ No newline at end of file diff --git a/windows.media.playback/backgroundmediaplayer_current.md b/windows.media.playback/backgroundmediaplayer_current.md index a8f1b4a104..234228dea7 100644 --- a/windows.media.playback/backgroundmediaplayer_current.md +++ b/windows.media.playback/backgroundmediaplayer_current.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.BackgroundMediaPlayer.Current --api-type: winrt property ---- # Windows.Media.Playback.BackgroundMediaPlayer.Current ## -description Gets the current instance of the background media player. ## -property-value The current instance of the background media player. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.BackgroundMediaPlayer.Current +-api-type: winrt property +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.Current + +## -description +Gets the current instance of the background media player. + +## -property-value +The current instance of the background media player. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer_ismediaplaying_1592636239.md b/windows.media.playback/backgroundmediaplayer_ismediaplaying_1592636239.md index e738f3fbac..f6fdd832b9 100644 --- a/windows.media.playback/backgroundmediaplayer_ismediaplaying_1592636239.md +++ b/windows.media.playback/backgroundmediaplayer_ismediaplaying_1592636239.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.IsMediaPlaying --api-type: winrt method ---- # Windows.Media.Playback.BackgroundMediaPlayer.IsMediaPlaying ## -description Returns a Boolean value indicating if other media is currently playing on the device. ## -returns Boolean value indicating if other media is currently playing on the device. ## -remarks If this value is true, you may want to prompt the user to see if they would prefer to continue to listen to the other media source. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.IsMediaPlaying +-api-type: winrt method +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.IsMediaPlaying + +## -description +Returns a Boolean value indicating if other media is currently playing on the device. + +## -returns +Boolean value indicating if other media is currently playing on the device. + +## -remarks +If this value is true, you may want to prompt the user to see if they would prefer to continue to listen to the other media source. + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer_messagereceivedfrombackground.md b/windows.media.playback/backgroundmediaplayer_messagereceivedfrombackground.md index 3d0e648932..a2be0976da 100644 --- a/windows.media.playback/backgroundmediaplayer_messagereceivedfrombackground.md +++ b/windows.media.playback/backgroundmediaplayer_messagereceivedfrombackground.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromBackground --api-type: winrt event ---- # Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromBackground ## -description Occurs when a message is received from the background task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromBackground +-api-type: winrt event +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromBackground + +## -description +Occurs when a message is received from the background task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer_messagereceivedfromforeground.md b/windows.media.playback/backgroundmediaplayer_messagereceivedfromforeground.md index c35e3c0d33..a385b1e801 100644 --- a/windows.media.playback/backgroundmediaplayer_messagereceivedfromforeground.md +++ b/windows.media.playback/backgroundmediaplayer_messagereceivedfromforeground.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromForeground --api-type: winrt event ---- # Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromForeground ## -description Occurs when a message is received from the foreground task. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromForeground +-api-type: winrt event +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.MessageReceivedFromForeground + +## -description +Occurs when a message is received from the foreground task. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer_sendmessagetobackground_986453043.md b/windows.media.playback/backgroundmediaplayer_sendmessagetobackground_986453043.md index 60603173bc..74fe6a164d 100644 --- a/windows.media.playback/backgroundmediaplayer_sendmessagetobackground_986453043.md +++ b/windows.media.playback/backgroundmediaplayer_sendmessagetobackground_986453043.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToBackground(Windows.Foundation.Collections.ValueSet) --api-type: winrt method ---- # Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToBackground ## -description Sends a message to the background media player. ## -parameters ### -param value Set of values representing the message. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToBackground(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToBackground + +## -description +Sends a message to the background media player. + +## -parameters +### -param value +Set of values representing the message. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer_sendmessagetoforeground_577822813.md b/windows.media.playback/backgroundmediaplayer_sendmessagetoforeground_577822813.md index 32ee56cc12..484f109ab0 100644 --- a/windows.media.playback/backgroundmediaplayer_sendmessagetoforeground_577822813.md +++ b/windows.media.playback/backgroundmediaplayer_sendmessagetoforeground_577822813.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToForeground(Windows.Foundation.Collections.ValueSet) --api-type: winrt method ---- # Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToForeground ## -description Sends a message to the foreground task. ## -parameters ### -param value Set of values representing the message. ## -remarks Apps should only call **SendMessageToForeground** while the foreground app is running. Attempting to call this method while the foreground app is not running will throw an exception. An app is responsible for communicating the foreground app state to the background process. This can be done using app lifecycle events, state values kept in local storage, and messages between processes. Calls to **SendMessageToForeground** should always be made within a **try** block so that the exception thrown can be caught if the system is unable to send the message. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToForeground(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.SendMessageToForeground + +## -description +Sends a message to the foreground task. + +## -parameters +### -param value +Set of values representing the message. + +## -remarks +Apps should only call **SendMessageToForeground** while the foreground app is running. Attempting to call this method while the foreground app is not running will throw an exception. An app is responsible for communicating the foreground app state to the background process. This can be done using app lifecycle events, state values kept in local storage, and messages between processes. + +Calls to **SendMessageToForeground** should always be made within a **try** block so that the exception thrown can be caught if the system is unable to send the message. + +## -examples + +## -see-also diff --git a/windows.media.playback/backgroundmediaplayer_shutdown_1170656041.md b/windows.media.playback/backgroundmediaplayer_shutdown_1170656041.md index 36c4d59974..dd67fd1991 100644 --- a/windows.media.playback/backgroundmediaplayer_shutdown_1170656041.md +++ b/windows.media.playback/backgroundmediaplayer_shutdown_1170656041.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.Shutdown --api-type: winrt method ---- # Windows.Media.Playback.BackgroundMediaPlayer.Shutdown ## -description Shuts down the current background media player. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.BackgroundMediaPlayer.Shutdown +-api-type: winrt method +--- + + + +# Windows.Media.Playback.BackgroundMediaPlayer.Shutdown + +## -description +Shuts down the current background media player. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/currentmediaplaybackitemchangedeventargs.md b/windows.media.playback/currentmediaplaybackitemchangedeventargs.md index 68ca2131c8..7fb9f89bec 100644 --- a/windows.media.playback/currentmediaplaybackitemchangedeventargs.md +++ b/windows.media.playback/currentmediaplaybackitemchangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs ## -description Provides data for the [MediaPlaybackList::CurrentItemChanged](mediaplaybacklist_currentitemchanged.md) event. ## -remarks Get an instance of this class by handling the [MediaPlaybackList.CurrentItemChanged](mediaplaybacklist_currentitemchanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs + +## -description +Provides data for the [MediaPlaybackList::CurrentItemChanged](mediaplaybacklist_currentitemchanged.md) event. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackList.CurrentItemChanged](mediaplaybacklist_currentitemchanged.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/currentmediaplaybackitemchangedeventargs_newitem.md b/windows.media.playback/currentmediaplaybackitemchangedeventargs_newitem.md index 4a114f4a29..02848a23ba 100644 --- a/windows.media.playback/currentmediaplaybackitemchangedeventargs_newitem.md +++ b/windows.media.playback/currentmediaplaybackitemchangedeventargs_newitem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.NewItem --api-type: winrt property ---- # Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.NewItem ## -description Gets the new current [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The new current [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.NewItem +-api-type: winrt property +--- + + + +# Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.NewItem + +## -description +Gets the new current [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The new current [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/currentmediaplaybackitemchangedeventargs_olditem.md b/windows.media.playback/currentmediaplaybackitemchangedeventargs_olditem.md index 72a1de42f4..a923dc042d 100644 --- a/windows.media.playback/currentmediaplaybackitemchangedeventargs_olditem.md +++ b/windows.media.playback/currentmediaplaybackitemchangedeventargs_olditem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.OldItem --api-type: winrt property ---- # Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.OldItem ## -description Gets the previous current [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The previous current [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.OldItem +-api-type: winrt property +--- + + + +# Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.OldItem + +## -description +Gets the previous current [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The previous current [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/imediaengineplaybacksource_currentitem.md b/windows.media.playback/imediaengineplaybacksource_currentitem.md index 06dc156c15..3241b63726 100644 --- a/windows.media.playback/imediaengineplaybacksource_currentitem.md +++ b/windows.media.playback/imediaengineplaybacksource_currentitem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.IMediaEnginePlaybackSource.CurrentItem --api-type: winrt property ---- # Windows.Media.Playback.IMediaEnginePlaybackSource.CurrentItem ## -description Gets the current playing [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The current playing [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.IMediaEnginePlaybackSource.CurrentItem +-api-type: winrt property +--- + + + +# Windows.Media.Playback.IMediaEnginePlaybackSource.CurrentItem + +## -description +Gets the current playing [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The current playing [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/imediaengineplaybacksource_setplaybacksource.md b/windows.media.playback/imediaengineplaybacksource_setplaybacksource.md index 34351eb822..8d84425df7 100644 --- a/windows.media.playback/imediaengineplaybacksource_setplaybacksource.md +++ b/windows.media.playback/imediaengineplaybacksource_setplaybacksource.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.IMediaEnginePlaybackSource.SetPlaybackSource(Windows.Media.Playback.IMediaPlaybackSource) --api-type: winrt method ---- # Windows.Media.Playback.IMediaEnginePlaybackSource.SetPlaybackSource ## -description Sets the media playback source. ## -parameters ### -param source The media playback source. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.IMediaEnginePlaybackSource.SetPlaybackSource(Windows.Media.Playback.IMediaPlaybackSource) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.IMediaEnginePlaybackSource.SetPlaybackSource + +## -description +Sets the media playback source. + +## -parameters +### -param source +The media playback source. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreak.md b/windows.media.playback/mediabreak.md index 0b963df143..33ec69d627 100644 --- a/windows.media.playback/mediabreak.md +++ b/windows.media.playback/mediabreak.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreak --api-type: winrt class ---- # Windows.Media.Playback.MediaBreak ## -description Represents a set of one or more [MediaPlaybackItem](mediaplaybackitem.md) objects that are played before, after, or at specified points during the playback of another [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks Get a reference to the currently playing **MediaBreak** using the constructor or by accessing the [CurrentBreak](mediabreakmanager_currentbreak.md) property of the [MediaBreakManager](mediabreakmanager.md). When a media break begins playing, you can get a reference to the associated **MediaBreak** object by handling the [BreakStarted](mediabreakmanager_breakstarted.md) event and accessing the [MediaBreak](mediabreakendedeventargs_mediabreak.md) property of the [MediaBreakStartedEventArgs](mediabreakstartedeventargs.md) passed into the handler. Get or set a pre-roll or post-roll media break for a media item by accessing the [PrerollBreak](mediabreakschedule_prerollbreak.md) or [PostrollBreak](mediabreakschedule_postrollbreak.md) property of the [MediaBreakSchedule](mediabreakschedule.md) object associated with a [MediaPlaybackItem](mediaplaybackitem.md). For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). ## -examples ## -see-also [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreak +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreak + +## -description +Represents a set of one or more [MediaPlaybackItem](mediaplaybackitem.md) objects that are played before, after, or at specified points during the playback of another [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +Get a reference to the currently playing **MediaBreak** using the constructor or by accessing the [CurrentBreak](mediabreakmanager_currentbreak.md) property of the [MediaBreakManager](mediabreakmanager.md). When a media break begins playing, you can get a reference to the associated **MediaBreak** object by handling the [BreakStarted](mediabreakmanager_breakstarted.md) event and accessing the [MediaBreak](mediabreakendedeventargs_mediabreak.md) property of the [MediaBreakStartedEventArgs](mediabreakstartedeventargs.md) passed into the handler. + +Get or set a pre-roll or post-roll media break for a media item by accessing the [PrerollBreak](mediabreakschedule_prerollbreak.md) or [PostrollBreak](mediabreakschedule_postrollbreak.md) property of the [MediaBreakSchedule](mediabreakschedule.md) object associated with a [MediaPlaybackItem](mediaplaybackitem.md). + +For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). + +## -examples + +## -see-also +[Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks) \ No newline at end of file diff --git a/windows.media.playback/mediabreak_canstart.md b/windows.media.playback/mediabreak_canstart.md index d78b68459e..50e75b1ef5 100644 --- a/windows.media.playback/mediabreak_canstart.md +++ b/windows.media.playback/mediabreak_canstart.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreak.CanStart --api-type: winrt property ---- # Windows.Media.Playback.MediaBreak.CanStart ## -description Gets or sets a value indicating whether the [MediaBreak](mediabreak.md) can be played. ## -property-value True if the [MediaBreak](mediabreak.md) can be played; otherwise false. ## -remarks You can set **CanStart** to false in the handler for the [BreakEnded](mediabreakmanager_breakended.md) event to make sure that a break that has already played isn't played again. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreak.CanStart +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreak.CanStart + +## -description +Gets or sets a value indicating whether the [MediaBreak](mediabreak.md) can be played. + +## -property-value +True if the [MediaBreak](mediabreak.md) can be played; otherwise false. + +## -remarks +You can set **CanStart** to false in the handler for the [BreakEnded](mediabreakmanager_breakended.md) event to make sure that a break that has already played isn't played again. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreak_customproperties.md b/windows.media.playback/mediabreak_customproperties.md index 0c24919323..fad5d05cb2 100644 --- a/windows.media.playback/mediabreak_customproperties.md +++ b/windows.media.playback/mediabreak_customproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreak.CustomProperties --api-type: winrt property ---- # Windows.Media.Playback.MediaBreak.CustomProperties ## -description Gets a map of key/value pairs that allow you to associate custom data with a [MediaBreak](mediabreak.md). ## -property-value A map of key/value pairs that allow you to associate custom data with a [MediaBreak](mediabreak.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreak.CustomProperties +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreak.CustomProperties + +## -description +Gets a map of key/value pairs that allow you to associate custom data with a [MediaBreak](mediabreak.md). + +## -property-value +A map of key/value pairs that allow you to associate custom data with a [MediaBreak](mediabreak.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreak_insertionmethod.md b/windows.media.playback/mediabreak_insertionmethod.md index 08ad59d5ca..0bbe314a67 100644 --- a/windows.media.playback/mediabreak_insertionmethod.md +++ b/windows.media.playback/mediabreak_insertionmethod.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Media.Playback.MediaBreak.InsertionMethod --api-type: winrt property ---- - - - -# Windows.Media.Playback.MediaBreak.InsertionMethod - -## -description -Gets a value indicating whether the media break will interrupt the main content, causing the main content to pause while it is played, or if it will replace the main content. - -## -property-value -A value indicating whether the media break will interrupt the main contentTBD - -## -remarks -Typical implementations will use [MediaBreakInsertionMethod.Interrupt](mediabreakinsertionmethod.md) for on-demand content and use [MediaBreakInsertionMethod.Replace](mediabreakinsertionmethod.md) for live content. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Playback.MediaBreak.InsertionMethod +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreak.InsertionMethod + +## -description +Gets a value indicating whether the media break will interrupt the main content, causing the main content to pause while it is played, or if it will replace the main content. + +## -property-value +A value indicating whether the media break will interrupt the main contentTBD + +## -remarks +Typical implementations will use [MediaBreakInsertionMethod.Interrupt](mediabreakinsertionmethod.md) for on-demand content and use [MediaBreakInsertionMethod.Replace](mediabreakinsertionmethod.md) for live content. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreak_mediabreak_1958137875.md b/windows.media.playback/mediabreak_mediabreak_1958137875.md index 9a00acb9f6..e21bc9ae61 100644 --- a/windows.media.playback/mediabreak_mediabreak_1958137875.md +++ b/windows.media.playback/mediabreak_mediabreak_1958137875.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Playback.MediaBreak.#ctor(Windows.Media.Playback.MediaBreakInsertionMethod) --api-type: winrt method ---- # Windows.Media.Playback.MediaBreak.MediaBreak ## -description Initializes a new instance of the [MediaBreak](mediabreak.md) class with the specified insertion method. ## -parameters ### -param insertionMethod A value indicating whether the media break will pause the currently playing media content. ## -remarks ## -examples ## -see-also [MediaBreak(MediaBreakInsertionMethod, TimeSpan)](mediabreak_mediabreak_504519435.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaBreak.#ctor(Windows.Media.Playback.MediaBreakInsertionMethod) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaBreak.MediaBreak + +## -description +Initializes a new instance of the [MediaBreak](mediabreak.md) class with the specified insertion method. + +## -parameters +### -param insertionMethod +A value indicating whether the media break will pause the currently playing media content. + +## -remarks + +## -examples + +## -see-also +[MediaBreak(MediaBreakInsertionMethod, TimeSpan)](mediabreak_mediabreak_504519435.md) \ No newline at end of file diff --git a/windows.media.playback/mediabreak_mediabreak_504519435.md b/windows.media.playback/mediabreak_mediabreak_504519435.md index 091b1361c4..0ea5bf820b 100644 --- a/windows.media.playback/mediabreak_mediabreak_504519435.md +++ b/windows.media.playback/mediabreak_mediabreak_504519435.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Playback.MediaBreak.#ctor(Windows.Media.Playback.MediaBreakInsertionMethod,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Playback.MediaBreak.MediaBreak ## -description Initializes a new instance of the [MediaBreak](mediabreak.md) class with the specified insertion method and presentation position. ## -parameters ### -param insertionMethod A value indicating whether the media break will pause the currently playing media content. ### -param presentationPosition The position within the playback of a [MediaPlaybackItem](mediaplaybackitem.md) at which the [MediaBreak](mediabreak.md) will be played. ## -remarks ## -examples ## -see-also [MediaBreak(MediaBreakInsertionMethod)](mediabreak_mediabreak_1958137875.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaBreak.#ctor(Windows.Media.Playback.MediaBreakInsertionMethod,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaBreak.MediaBreak + +## -description +Initializes a new instance of the [MediaBreak](mediabreak.md) class with the specified insertion method and presentation position. + +## -parameters +### -param insertionMethod +A value indicating whether the media break will pause the currently playing media content. + +### -param presentationPosition +The position within the playback of a [MediaPlaybackItem](mediaplaybackitem.md) at which the [MediaBreak](mediabreak.md) will be played. + +## -remarks + +## -examples + +## -see-also +[MediaBreak(MediaBreakInsertionMethod)](mediabreak_mediabreak_1958137875.md) \ No newline at end of file diff --git a/windows.media.playback/mediabreak_playbacklist.md b/windows.media.playback/mediabreak_playbacklist.md index 01a0d13215..4f036984d6 100644 --- a/windows.media.playback/mediabreak_playbacklist.md +++ b/windows.media.playback/mediabreak_playbacklist.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreak.PlaybackList --api-type: winrt property ---- # Windows.Media.Playback.MediaBreak.PlaybackList ## -description Gets the [MediaPlaybackList](mediaplaybacklist.md) containing the [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played as part of the [MediaBreak](mediabreak.md). ## -property-value The [MediaPlaybackList](mediaplaybacklist.md) containing the [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played as part of the [MediaBreak](mediabreak.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreak.PlaybackList +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreak.PlaybackList + +## -description +Gets the [MediaPlaybackList](mediaplaybacklist.md) containing the [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played as part of the [MediaBreak](mediabreak.md). + +## -property-value +The [MediaPlaybackList](mediaplaybacklist.md) containing the [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played as part of the [MediaBreak](mediabreak.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreak_presentationposition.md b/windows.media.playback/mediabreak_presentationposition.md index 1614d1d72e..baf45fa6e4 100644 --- a/windows.media.playback/mediabreak_presentationposition.md +++ b/windows.media.playback/mediabreak_presentationposition.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreak.PresentationPosition --api-type: winrt property ---- # Windows.Media.Playback.MediaBreak.PresentationPosition ## -description Gets the position within the playback of a [MediaPlaybackItem](mediaplaybackitem.md) at which the [MediaBreak](mediabreak.md) will be played. ## -property-value The position within the playback of a [MediaPlaybackItem](mediaplaybackitem.md) that the [MediaBreak](mediabreak.md) will be played. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreak.PresentationPosition +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreak.PresentationPosition + +## -description +Gets the position within the playback of a [MediaPlaybackItem](mediaplaybackitem.md) at which the [MediaBreak](mediabreak.md) will be played. + +## -property-value +The position within the playback of a [MediaPlaybackItem](mediaplaybackitem.md) that the [MediaBreak](mediabreak.md) will be played. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakendedeventargs.md b/windows.media.playback/mediabreakendedeventargs.md index e68ca64319..54c6ded300 100644 --- a/windows.media.playback/mediabreakendedeventargs.md +++ b/windows.media.playback/mediabreakendedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreakEndedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaBreakEndedEventArgs ## -description Provides data for the [MediaBreakManager.BreakEnded](mediabreakmanager_breakended.md) event, which occurs when the playback of a [MediaBreak](mediabreak.md) has ended. ## -remarks Get an instance of this class by handling the [MediaBreakManager.BreakEnded](mediabreakmanager_breakended.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreakEndedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreakEndedEventArgs + +## -description +Provides data for the [MediaBreakManager.BreakEnded](mediabreakmanager_breakended.md) event, which occurs when the playback of a [MediaBreak](mediabreak.md) has ended. + +## -remarks +Get an instance of this class by handling the [MediaBreakManager.BreakEnded](mediabreakmanager_breakended.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakendedeventargs_mediabreak.md b/windows.media.playback/mediabreakendedeventargs_mediabreak.md index 7a087f4c90..61e9b84916 100644 --- a/windows.media.playback/mediabreakendedeventargs_mediabreak.md +++ b/windows.media.playback/mediabreakendedeventargs_mediabreak.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakEndedEventArgs.MediaBreak --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakEndedEventArgs.MediaBreak ## -description Gets the [MediaBreak](mediabreak.md) for which playback has ended. ## -property-value The [MediaBreak](mediabreak.md) for which playback has ended. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakEndedEventArgs.MediaBreak +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakEndedEventArgs.MediaBreak + +## -description +Gets the [MediaBreak](mediabreak.md) for which playback has ended. + +## -property-value +The [MediaBreak](mediabreak.md) for which playback has ended. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager.md b/windows.media.playback/mediabreakmanager.md index 7e2781bd7e..63490a6dab 100644 --- a/windows.media.playback/mediabreakmanager.md +++ b/windows.media.playback/mediabreakmanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreakManager --api-type: winrt class ---- # Windows.Media.Playback.MediaBreakManager ## -description Provides information about and control over the [MediaBreak](mediabreak.md) objects associated with a [MediaPlayer](mediaplayer.md). This class provides events for when a media break starts playback, ends playback, is skipped, or is seeked over. You can also use this class to determine the currently playing [MediaBreak](mediabreak.md) or to start or skip playback of a [MediaBreak](mediabreak.md). ## -remarks Get an instance of this class by accessing the [MediaPlayer.BreakManager](mediaplayer_breakmanager.md) property. For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). ## -examples ## -see-also [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks), [MediaPlayer.BreakManager](mediaplayer_breakmanager.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreakManager +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreakManager + +## -description +Provides information about and control over the [MediaBreak](mediabreak.md) objects associated with a [MediaPlayer](mediaplayer.md). This class provides events for when a media break starts playback, ends playback, is skipped, or is seeked over. You can also use this class to determine the currently playing [MediaBreak](mediabreak.md) or to start or skip playback of a [MediaBreak](mediabreak.md). + +## -remarks +Get an instance of this class by accessing the [MediaPlayer.BreakManager](mediaplayer_breakmanager.md) property. + +For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). + +## -examples + +## -see-also +[Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks), [MediaPlayer.BreakManager](mediaplayer_breakmanager.md) \ No newline at end of file diff --git a/windows.media.playback/mediabreakmanager_breakended.md b/windows.media.playback/mediabreakmanager_breakended.md index 8b2c98a305..f950be48c2 100644 --- a/windows.media.playback/mediabreakmanager_breakended.md +++ b/windows.media.playback/mediabreakmanager_breakended.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaBreakManager.BreakEnded --api-type: winrt event ---- # Windows.Media.Playback.MediaBreakManager.BreakEnded ## -description Occurs when a [MediaBreak](mediabreak.md) ends playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaBreakManager.BreakEnded +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaBreakManager.BreakEnded + +## -description +Occurs when a [MediaBreak](mediabreak.md) ends playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_breakskipped.md b/windows.media.playback/mediabreakmanager_breakskipped.md index bb5a297ff6..670985cca2 100644 --- a/windows.media.playback/mediabreakmanager_breakskipped.md +++ b/windows.media.playback/mediabreakmanager_breakskipped.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Playback.MediaBreakManager.BreakSkipped --api-type: winrt event ---- # Windows.Media.Playback.MediaBreakManager.BreakSkipped ## -description Occurs when a [MediaBreak](mediabreak.md) is skipped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaBreakManager.BreakSkipped +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaBreakManager.BreakSkipped + +## -description +Occurs when a [MediaBreak](mediabreak.md) is skipped. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_breaksseekedover.md b/windows.media.playback/mediabreakmanager_breaksseekedover.md index 4be5df3996..4540b2af1c 100644 --- a/windows.media.playback/mediabreakmanager_breaksseekedover.md +++ b/windows.media.playback/mediabreakmanager_breaksseekedover.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaBreakManager.BreaksSeekedOver --api-type: winrt event ---- # Windows.Media.Playback.MediaBreakManager.BreaksSeekedOver ## -description Occurs when the user seeks the media playback position past one or more pending media breaks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaBreakManager.BreaksSeekedOver +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaBreakManager.BreaksSeekedOver + +## -description +Occurs when the user seeks the media playback position past one or more pending media breaks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_breakstarted.md b/windows.media.playback/mediabreakmanager_breakstarted.md index 38e5189734..e56959137c 100644 --- a/windows.media.playback/mediabreakmanager_breakstarted.md +++ b/windows.media.playback/mediabreakmanager_breakstarted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaBreakManager.BreakStarted --api-type: winrt event ---- # Windows.Media.Playback.MediaBreakManager.BreakStarted ## -description Occurs when playback of a [MediaBreak](mediabreak.md) starts. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaBreakManager.BreakStarted +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaBreakManager.BreakStarted + +## -description +Occurs when playback of a [MediaBreak](mediabreak.md) starts. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_currentbreak.md b/windows.media.playback/mediabreakmanager_currentbreak.md index 16b890ef67..5fe7a1076b 100644 --- a/windows.media.playback/mediabreakmanager_currentbreak.md +++ b/windows.media.playback/mediabreakmanager_currentbreak.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakManager.CurrentBreak --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakManager.CurrentBreak ## -description Gets the [MediaBreak](mediabreak.md) that is currently being played by the [MediaPlayer](mediaplayer.md). ## -property-value The [MediaBreak](mediabreak.md) that is currently being played by the [MediaPlayer](mediaplayer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakManager.CurrentBreak +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakManager.CurrentBreak + +## -description +Gets the [MediaBreak](mediabreak.md) that is currently being played by the [MediaPlayer](mediaplayer.md). + +## -property-value +The [MediaBreak](mediabreak.md) that is currently being played by the [MediaPlayer](mediaplayer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_playbacksession.md b/windows.media.playback/mediabreakmanager_playbacksession.md index e1cc9de669..692ecffb96 100644 --- a/windows.media.playback/mediabreakmanager_playbacksession.md +++ b/windows.media.playback/mediabreakmanager_playbacksession.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakManager.PlaybackSession --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakManager.PlaybackSession ## -description Gets the [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaBreakManager](mediabreakmanager.md). ## -property-value The [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaBreakManager](mediabreakmanager.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakManager.PlaybackSession +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakManager.PlaybackSession + +## -description +Gets the [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaBreakManager](mediabreakmanager.md). + +## -property-value +The [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaBreakManager](mediabreakmanager.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_playbreak_767123580.md b/windows.media.playback/mediabreakmanager_playbreak_767123580.md index 9dde564a70..e9f1360bae 100644 --- a/windows.media.playback/mediabreakmanager_playbreak_767123580.md +++ b/windows.media.playback/mediabreakmanager_playbreak_767123580.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaBreakManager.PlayBreak(Windows.Media.Playback.MediaBreak) --api-type: winrt method ---- # Windows.Media.Playback.MediaBreakManager.PlayBreak ## -description Directs the [MediaPlayer](mediaplayer.md) to begin playing the specified [MediaBreak](mediabreak.md) immediately. ## -parameters ### -param value The [MediaBreak](mediabreak.md) to be played. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaBreakManager.PlayBreak(Windows.Media.Playback.MediaBreak) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaBreakManager.PlayBreak + +## -description +Directs the [MediaPlayer](mediaplayer.md) to begin playing the specified [MediaBreak](mediabreak.md) immediately. + +## -parameters +### -param value +The [MediaBreak](mediabreak.md) to be played. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakmanager_skipcurrentbreak_659521455.md b/windows.media.playback/mediabreakmanager_skipcurrentbreak_659521455.md index 5094cfec10..5760edf1cb 100644 --- a/windows.media.playback/mediabreakmanager_skipcurrentbreak_659521455.md +++ b/windows.media.playback/mediabreakmanager_skipcurrentbreak_659521455.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaBreakManager.SkipCurrentBreak --api-type: winrt method ---- # Windows.Media.Playback.MediaBreakManager.SkipCurrentBreak ## -description Directs the [MediaPlayer](mediaplayer.md) to skip over the current [MediaBreak](mediabreak.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaBreakManager.SkipCurrentBreak +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaBreakManager.SkipCurrentBreak + +## -description +Directs the [MediaPlayer](mediaplayer.md) to skip over the current [MediaBreak](mediabreak.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule.md b/windows.media.playback/mediabreakschedule.md index 875d2b2f7a..b2c771e17d 100644 --- a/windows.media.playback/mediabreakschedule.md +++ b/windows.media.playback/mediabreakschedule.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreakSchedule --api-type: winrt class ---- # Windows.Media.Playback.MediaBreakSchedule ## -description Represents a set of [MediaBreak](mediabreak.md) objects associated with a [MediaPlaybackItem](mediaplaybackitem.md) and the positions within the playback of the item that the media breaks are played. ## -remarks Get the media break schedule for a media item by accessing the [BreakSchedule](mediaplaybackitem_breakschedule.md) property of the [MediaPlaybackItem](mediaplaybackitem.md) object. For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). ## -examples ## -see-also [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreakSchedule +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreakSchedule + +## -description +Represents a set of [MediaBreak](mediabreak.md) objects associated with a [MediaPlaybackItem](mediaplaybackitem.md) and the positions within the playback of the item that the media breaks are played. + +## -remarks +Get the media break schedule for a media item by accessing the [BreakSchedule](mediaplaybackitem_breakschedule.md) property of the [MediaPlaybackItem](mediaplaybackitem.md) object. + +For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). + +## -examples + +## -see-also +[Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks) \ No newline at end of file diff --git a/windows.media.playback/mediabreakschedule_insertmidrollbreak_1567865726.md b/windows.media.playback/mediabreakschedule_insertmidrollbreak_1567865726.md index 312b810d1e..440e146e4c 100644 --- a/windows.media.playback/mediabreakschedule_insertmidrollbreak_1567865726.md +++ b/windows.media.playback/mediabreakschedule_insertmidrollbreak_1567865726.md @@ -1,3 +1,28 @@ ---- -api-id: M:Windows.Media.Playback.MediaBreakSchedule.InsertMidrollBreak(Windows.Media.Playback.MediaBreak) --api-type: winrt method ---- # Windows.Media.Playback.MediaBreakSchedule.InsertMidrollBreak ## -description Adds a [MediaBreak](mediabreak.md) to the schedule that will be played at a point during the playback of the [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. ## -parameters ### -param mediaBreak The [MediaBreak](mediabreak.md) to add to the schedule. ## -remarks Remove a midroll break by calling [RemoveMidrollBreak](mediabreakschedule_removemidrollbreak.md). Access the current list of midroll media breaks in the schedule with the [MidrollBreaks](mediabreakschedule_midrollbreaks.md) property. If you want a **MediaBreak** to be played before the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PrerollBreak](mediabreakschedule_prerollbreak.md) property. If you want a **MediaBreak** to be played after the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PostrollBreak](mediabreakschedule_postrollbreak.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaBreakSchedule.InsertMidrollBreak(Windows.Media.Playback.MediaBreak) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.InsertMidrollBreak + +## -description +Adds a [MediaBreak](mediabreak.md) to the schedule that will be played at a point during the playback of the [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. + +## -parameters +### -param mediaBreak +The [MediaBreak](mediabreak.md) to add to the schedule. + +## -remarks +Remove a midroll break by calling [RemoveMidrollBreak](mediabreakschedule_removemidrollbreak.md). + +Access the current list of midroll media breaks in the schedule with the [MidrollBreaks](mediabreakschedule_midrollbreaks.md) property. + +If you want a **MediaBreak** to be played before the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PrerollBreak](mediabreakschedule_prerollbreak.md) property. If you want a **MediaBreak** to be played after the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PostrollBreak](mediabreakschedule_postrollbreak.md) property. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule_midrollbreaks.md b/windows.media.playback/mediabreakschedule_midrollbreaks.md index dba06771cb..d637ca0b34 100644 --- a/windows.media.playback/mediabreakschedule_midrollbreaks.md +++ b/windows.media.playback/mediabreakschedule_midrollbreaks.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSchedule.MidrollBreaks --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSchedule.MidrollBreaks ## -description Gets the schedule's current list of [MediaBreak](mediabreak.md) objects that will be played at a point during the playback of the [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. ## -property-value The schedule's current list of [MediaBreak](mediabreak.md) objects that will be played at a position within the playback of the [MediaPlaybackItem](mediaplaybackitem.md) with which the schedule is associated. ## -remarks To add a [MediaBreak](mediabreak.md) to the **MidrollBreaks** list, use [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSchedule.MidrollBreaks +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.MidrollBreaks + +## -description +Gets the schedule's current list of [MediaBreak](mediabreak.md) objects that will be played at a point during the playback of the [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. + +## -property-value +The schedule's current list of [MediaBreak](mediabreak.md) objects that will be played at a position within the playback of the [MediaPlaybackItem](mediaplaybackitem.md) with which the schedule is associated. + +## -remarks +To add a [MediaBreak](mediabreak.md) to the **MidrollBreaks** list, use [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule_playbackitem.md b/windows.media.playback/mediabreakschedule_playbackitem.md index 4e40cbdfa6..978a5319c4 100644 --- a/windows.media.playback/mediabreakschedule_playbackitem.md +++ b/windows.media.playback/mediabreakschedule_playbackitem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSchedule.PlaybackItem --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSchedule.PlaybackItem ## -description Gets the [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. ## -property-value The [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSchedule.PlaybackItem +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.PlaybackItem + +## -description +Gets the [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. + +## -property-value +The [MediaPlaybackItem](mediaplaybackitem.md) with which the [MediaBreakSchedule](mediabreakschedule.md) is associated. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule_postrollbreak.md b/windows.media.playback/mediabreakschedule_postrollbreak.md index 25125ccef3..6d56c2828f 100644 --- a/windows.media.playback/mediabreakschedule_postrollbreak.md +++ b/windows.media.playback/mediabreakschedule_postrollbreak.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSchedule.PostrollBreak --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSchedule.PostrollBreak ## -description Gets or sets the [MediaBreak](mediabreak.md) to be played after the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. ## -property-value The [MediaBreak](mediabreak.md) to be played after the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. ## -remarks If you want a **MediaBreak** to be played before the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PrerollBreak](mediabreakschedule_prerollbreak.md) property. If you want a **MediaBreak** to play at a point during the playback of the associated **MediaPlaybackItem**, use the [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSchedule.PostrollBreak +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.PostrollBreak + +## -description +Gets or sets the [MediaBreak](mediabreak.md) to be played after the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. + +## -property-value +The [MediaBreak](mediabreak.md) to be played after the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. + +## -remarks +If you want a **MediaBreak** to be played before the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PrerollBreak](mediabreakschedule_prerollbreak.md) property. If you want a **MediaBreak** to play at a point during the playback of the associated **MediaPlaybackItem**, use the [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md) method. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule_prerollbreak.md b/windows.media.playback/mediabreakschedule_prerollbreak.md index e98e215f01..e71a4d92af 100644 --- a/windows.media.playback/mediabreakschedule_prerollbreak.md +++ b/windows.media.playback/mediabreakschedule_prerollbreak.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSchedule.PrerollBreak --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSchedule.PrerollBreak ## -description Gets or sets the [MediaBreak](mediabreak.md) to be played before the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. ## -property-value The [MediaBreak](mediabreak.md) to be played before the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. ## -remarks If you want a **MediaBreak** to be played after the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PostrollBreak](mediabreakschedule_postrollbreak.md) property. If you want a **MediaBreak** to play at a point during the playback of the associated **MediaPlaybackItem**, use the [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md) method. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSchedule.PrerollBreak +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.PrerollBreak + +## -description +Gets or sets the [MediaBreak](mediabreak.md) to be played before the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. + +## -property-value +The [MediaBreak](mediabreak.md) to be played before the [MediaPlaybackItem](mediaplaybackitem.md) associated with the [MediaBreakSchedule](mediabreakschedule.md) plays. + +## -remarks +If you want a **MediaBreak** to be played after the associated [MediaPlaybackItem](mediaplaybackitem.md) plays, assign it to the [PostrollBreak](mediabreakschedule_postrollbreak.md) property. If you want a **MediaBreak** to play at a point during the playback of the associated **MediaPlaybackItem**, use the [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md) method. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule_removemidrollbreak_1073766102.md b/windows.media.playback/mediabreakschedule_removemidrollbreak_1073766102.md index fb59e8fbdb..adcb013bc4 100644 --- a/windows.media.playback/mediabreakschedule_removemidrollbreak_1073766102.md +++ b/windows.media.playback/mediabreakschedule_removemidrollbreak_1073766102.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaBreakSchedule.RemoveMidrollBreak(Windows.Media.Playback.MediaBreak) --api-type: winrt method ---- # Windows.Media.Playback.MediaBreakSchedule.RemoveMidrollBreak ## -description Removes a midroll [MediaBreak](mediabreak.md) from the [MediaBreakSchedule](mediabreakschedule.md). ## -parameters ### -param mediaBreak The [MediaBreak](mediabreak.md) to remove from the schedule. ## -remarks Add a midroll media break by calling [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md). Access the current list of midroll media breaks in the schedule with the [MidrollBreaks](mediabreakschedule_midrollbreaks.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaBreakSchedule.RemoveMidrollBreak(Windows.Media.Playback.MediaBreak) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.RemoveMidrollBreak + +## -description +Removes a midroll [MediaBreak](mediabreak.md) from the [MediaBreakSchedule](mediabreakschedule.md). + +## -parameters +### -param mediaBreak +The [MediaBreak](mediabreak.md) to remove from the schedule. + +## -remarks +Add a midroll media break by calling [InsertMidrollBreak](mediabreakschedule_insertmidrollbreak.md). + +Access the current list of midroll media breaks in the schedule with the [MidrollBreaks](mediabreakschedule_midrollbreaks.md) property. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakschedule_schedulechanged.md b/windows.media.playback/mediabreakschedule_schedulechanged.md index 986ea4f42f..63207dfb36 100644 --- a/windows.media.playback/mediabreakschedule_schedulechanged.md +++ b/windows.media.playback/mediabreakschedule_schedulechanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Playback.MediaBreakSchedule.ScheduleChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaBreakSchedule.ScheduleChanged ## -description Occurs when the [MediaBreakSchedule](mediabreakschedule.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaBreakSchedule.ScheduleChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaBreakSchedule.ScheduleChanged + +## -description +Occurs when the [MediaBreakSchedule](mediabreakschedule.md) changes. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakseekedovereventargs.md b/windows.media.playback/mediabreakseekedovereventargs.md index 0422903495..f74697206e 100644 --- a/windows.media.playback/mediabreakseekedovereventargs.md +++ b/windows.media.playback/mediabreakseekedovereventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreakSeekedOverEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaBreakSeekedOverEventArgs ## -description Provides data for the [MediaBreakManager.BreaksSeekedOver](mediabreakmanager_breaksseekedover.md) event, which occurs when the user seeks the media playback position past one or more pending media breaks. ## -remarks Get an instance of this class by handling the [MediaBreakManager.BreaksSeekedOver](mediabreakmanager_breaksseekedover.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreakSeekedOverEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreakSeekedOverEventArgs + +## -description +Provides data for the [MediaBreakManager.BreaksSeekedOver](mediabreakmanager_breaksseekedover.md) event, which occurs when the user seeks the media playback position past one or more pending media breaks. + +## -remarks +Get an instance of this class by handling the [MediaBreakManager.BreaksSeekedOver](mediabreakmanager_breaksseekedover.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakseekedovereventargs_newposition.md b/windows.media.playback/mediabreakseekedovereventargs_newposition.md index a326caa423..4f8ce69990 100644 --- a/windows.media.playback/mediabreakseekedovereventargs_newposition.md +++ b/windows.media.playback/mediabreakseekedovereventargs_newposition.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSeekedOverEventArgs.NewPosition --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSeekedOverEventArgs.NewPosition ## -description Gets the new current position within the [MediaPlaybackItem](mediaplaybackitem.md) after the seek operation has completed. ## -property-value The new current position within the [MediaPlaybackItem](mediaplaybackitem.md) after the seek operation has completed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSeekedOverEventArgs.NewPosition +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSeekedOverEventArgs.NewPosition + +## -description +Gets the new current position within the [MediaPlaybackItem](mediaplaybackitem.md) after the seek operation has completed. + +## -property-value +The new current position within the [MediaPlaybackItem](mediaplaybackitem.md) after the seek operation has completed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakseekedovereventargs_oldposition.md b/windows.media.playback/mediabreakseekedovereventargs_oldposition.md index 5a624fc1df..f3a4bc2c4c 100644 --- a/windows.media.playback/mediabreakseekedovereventargs_oldposition.md +++ b/windows.media.playback/mediabreakseekedovereventargs_oldposition.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSeekedOverEventArgs.OldPosition --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSeekedOverEventArgs.OldPosition ## -description Gets the previous position within the [MediaPlaybackItem](mediaplaybackitem.md) before the seek operation started. ## -property-value The previous position within the [MediaPlaybackItem](mediaplaybackitem.md) before the seek operation started. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSeekedOverEventArgs.OldPosition +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSeekedOverEventArgs.OldPosition + +## -description +Gets the previous position within the [MediaPlaybackItem](mediaplaybackitem.md) before the seek operation started. + +## -property-value +The previous position within the [MediaPlaybackItem](mediaplaybackitem.md) before the seek operation started. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakseekedovereventargs_seekedoverbreaks.md b/windows.media.playback/mediabreakseekedovereventargs_seekedoverbreaks.md index ad2faad38e..d579be40c9 100644 --- a/windows.media.playback/mediabreakseekedovereventargs_seekedoverbreaks.md +++ b/windows.media.playback/mediabreakseekedovereventargs_seekedoverbreaks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSeekedOverEventArgs.SeekedOverBreaks --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSeekedOverEventArgs.SeekedOverBreaks ## -description Gets the list of [MediaBreak](mediabreak.md) objects that were seeked over, meaning that they were scheduled to play between the [OldPosition](mediabreakseekedovereventargs_oldposition.md) and [NewPosition](mediabreakseekedovereventargs_newposition.md) of the seek operation. ## -property-value The list of [MediaBreak](mediabreak.md) objects that were seeked over. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSeekedOverEventArgs.SeekedOverBreaks +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSeekedOverEventArgs.SeekedOverBreaks + +## -description +Gets the list of [MediaBreak](mediabreak.md) objects that were seeked over, meaning that they were scheduled to play between the [OldPosition](mediabreakseekedovereventargs_oldposition.md) and [NewPosition](mediabreakseekedovereventargs_newposition.md) of the seek operation. + +## -property-value +The list of [MediaBreak](mediabreak.md) objects that were seeked over. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakskippedeventargs.md b/windows.media.playback/mediabreakskippedeventargs.md index ef48276fe6..e712be4fea 100644 --- a/windows.media.playback/mediabreakskippedeventargs.md +++ b/windows.media.playback/mediabreakskippedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreakSkippedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaBreakSkippedEventArgs ## -description Provides data for the [MediaBreakManager.BreakSkipped](mediabreakmanager_breakskipped.md) event, which occurs when the playback of a [MediaBreak](mediabreak.md) is skipped. ## -remarks Get an instance of this class by handling the [MediaBreakManager.BreakSkipped](mediabreakmanager_breakskipped.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreakSkippedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreakSkippedEventArgs + +## -description +Provides data for the [MediaBreakManager.BreakSkipped](mediabreakmanager_breakskipped.md) event, which occurs when the playback of a [MediaBreak](mediabreak.md) is skipped. + +## -remarks +Get an instance of this class by handling the [MediaBreakManager.BreakSkipped](mediabreakmanager_breakskipped.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakskippedeventargs_mediabreak.md b/windows.media.playback/mediabreakskippedeventargs_mediabreak.md index e82cbe5b9a..3f52c527b3 100644 --- a/windows.media.playback/mediabreakskippedeventargs_mediabreak.md +++ b/windows.media.playback/mediabreakskippedeventargs_mediabreak.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakSkippedEventArgs.MediaBreak --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakSkippedEventArgs.MediaBreak ## -description Gets the [MediaBreak](mediabreak.md) that was skipped. ## -property-value The [MediaBreak](mediabreak.md) that was skipped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakSkippedEventArgs.MediaBreak +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakSkippedEventArgs.MediaBreak + +## -description +Gets the [MediaBreak](mediabreak.md) that was skipped. + +## -property-value +The [MediaBreak](mediabreak.md) that was skipped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakstartedeventargs.md b/windows.media.playback/mediabreakstartedeventargs.md index 76945e6cb8..fb5b326aad 100644 --- a/windows.media.playback/mediabreakstartedeventargs.md +++ b/windows.media.playback/mediabreakstartedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaBreakStartedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaBreakStartedEventArgs ## -description Provides data for the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event, which occurs when the playback of a [MediaBreak](mediabreak.md) starts. ## -remarks Get an instance of this class by handling the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaBreakStartedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaBreakStartedEventArgs + +## -description +Provides data for the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event, which occurs when the playback of a [MediaBreak](mediabreak.md) starts. + +## -remarks +Get an instance of this class by handling the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediabreakstartedeventargs_mediabreak.md b/windows.media.playback/mediabreakstartedeventargs_mediabreak.md index f4677d97b2..0206ade941 100644 --- a/windows.media.playback/mediabreakstartedeventargs_mediabreak.md +++ b/windows.media.playback/mediabreakstartedeventargs_mediabreak.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaBreakStartedEventArgs.MediaBreak --api-type: winrt property ---- # Windows.Media.Playback.MediaBreakStartedEventArgs.MediaBreak ## -description Gets the [MediaBreak](mediabreak.md) that triggered the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event. ## -property-value The [MediaBreak](mediabreak.md) that triggered the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaBreakStartedEventArgs.MediaBreak +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaBreakStartedEventArgs.MediaBreak + +## -description +Gets the [MediaBreak](mediabreak.md) that triggered the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event. + +## -property-value +The [MediaBreak](mediabreak.md) that triggered the [MediaBreakManager.BreakStarted](mediabreakmanager_breakstarted.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaitemdisplayproperties.md b/windows.media.playback/mediaitemdisplayproperties.md index 8ffae1e734..a1a6e91e5a 100644 --- a/windows.media.playback/mediaitemdisplayproperties.md +++ b/windows.media.playback/mediaitemdisplayproperties.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaItemDisplayProperties --api-type: winrt class ---- # Windows.Media.Playback.MediaItemDisplayProperties ## -description Defines a set of metadata for a [MediaPlaybackItem](mediaplaybackitem.md) that is displayed in the System Media Transport Controls while the item is playing. ## -remarks Get an instance of the **MediaItemDisplayProperties** class by calling [GetDisplayProperties](mediaplaybackitem_getdisplayproperties.md) on an initialized [MediaPlaybackItem](mediaplaybackitem.md) object. Update the display properties for the playback item by setting the properties of the retrieved **MediaItemDisplayProperties** object and then calling [ApplyDisplayProperties](mediaplaybackitem_applydisplayproperties.md). For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). ## -examples ## -see-also [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaItemDisplayProperties +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaItemDisplayProperties + +## -description +Defines a set of metadata for a [MediaPlaybackItem](mediaplaybackitem.md) that is displayed in the System Media Transport Controls while the item is playing. + +## -remarks +Get an instance of the **MediaItemDisplayProperties** class by calling [GetDisplayProperties](mediaplaybackitem_getdisplayproperties.md) on an initialized [MediaPlaybackItem](mediaplaybackitem.md) object. Update the display properties for the playback item by setting the properties of the retrieved **MediaItemDisplayProperties** object and then calling [ApplyDisplayProperties](mediaplaybackitem_applydisplayproperties.md). + +For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). + +## -examples + +## -see-also +[Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols) \ No newline at end of file diff --git a/windows.media.playback/mediaitemdisplayproperties_clearall_1180497524.md b/windows.media.playback/mediaitemdisplayproperties_clearall_1180497524.md index 2b9b65633a..4145479158 100644 --- a/windows.media.playback/mediaitemdisplayproperties_clearall_1180497524.md +++ b/windows.media.playback/mediaitemdisplayproperties_clearall_1180497524.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaItemDisplayProperties.ClearAll --api-type: winrt method ---- # Windows.Media.Playback.MediaItemDisplayProperties.ClearAll ## -description Clears the values of all media item display properties. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaItemDisplayProperties.ClearAll +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaItemDisplayProperties.ClearAll + +## -description +Clears the values of all media item display properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaitemdisplayproperties_musicproperties.md b/windows.media.playback/mediaitemdisplayproperties_musicproperties.md index 3df364b0ee..130b8be5c9 100644 --- a/windows.media.playback/mediaitemdisplayproperties_musicproperties.md +++ b/windows.media.playback/mediaitemdisplayproperties_musicproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.MusicProperties --api-type: winrt property ---- # Windows.Media.Playback.MediaItemDisplayProperties.MusicProperties ## -description Gets the metadata for a music item that will be displayed by the System Media Transport Controls when the item is played. ## -property-value The display metadata for a music item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.MusicProperties +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaItemDisplayProperties.MusicProperties + +## -description +Gets the metadata for a music item that will be displayed by the System Media Transport Controls when the item is played. + +## -property-value +The display metadata for a music item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaitemdisplayproperties_thumbnail.md b/windows.media.playback/mediaitemdisplayproperties_thumbnail.md index 24e44ab094..2856349316 100644 --- a/windows.media.playback/mediaitemdisplayproperties_thumbnail.md +++ b/windows.media.playback/mediaitemdisplayproperties_thumbnail.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.Thumbnail --api-type: winrt property ---- # Windows.Media.Playback.MediaItemDisplayProperties.Thumbnail ## -description Gets or sets the thumbnail image for a [MediaPlaybackItem](mediaplaybackitem.md) that will be displayed by the System Media Transport Controls when the item is played. ## -property-value A stream containing the thumbnail image data for a [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.Thumbnail +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaItemDisplayProperties.Thumbnail + +## -description +Gets or sets the thumbnail image for a [MediaPlaybackItem](mediaplaybackitem.md) that will be displayed by the System Media Transport Controls when the item is played. + +## -property-value +A stream containing the thumbnail image data for a [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaitemdisplayproperties_type.md b/windows.media.playback/mediaitemdisplayproperties_type.md index 16ed8f637a..e9ccf8166f 100644 --- a/windows.media.playback/mediaitemdisplayproperties_type.md +++ b/windows.media.playback/mediaitemdisplayproperties_type.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.Type --api-type: winrt property ---- # Windows.Media.Playback.MediaItemDisplayProperties.Type ## -description Gets or sets a value indicating the type of media that is represented by the [MediaPlaybackItem](mediaplaybackitem.md), such as audio or video. ## -property-value A value indicating the type of media that is represented by the [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.Type +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaItemDisplayProperties.Type + +## -description +Gets or sets a value indicating the type of media that is represented by the [MediaPlaybackItem](mediaplaybackitem.md), such as audio or video. + +## -property-value +A value indicating the type of media that is represented by the [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaitemdisplayproperties_videoproperties.md b/windows.media.playback/mediaitemdisplayproperties_videoproperties.md index 4470d97ee2..da3bb3dd2e 100644 --- a/windows.media.playback/mediaitemdisplayproperties_videoproperties.md +++ b/windows.media.playback/mediaitemdisplayproperties_videoproperties.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.VideoProperties --api-type: winrt property ---- # Windows.Media.Playback.MediaItemDisplayProperties.VideoProperties ## -description Gets the metadata for a video item that will be displayed by the System Media Transport Controls when the item is played. ## -property-value The display metadata for a video item. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaItemDisplayProperties.VideoProperties +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaItemDisplayProperties.VideoProperties + +## -description +Gets the metadata for a video item that will be displayed by the System Media Transport Controls when the item is played. + +## -property-value +The display metadata for a video item. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist.md b/windows.media.playback/mediaplaybackaudiotracklist.md index 64c48dc4f2..b6d5fe53f8 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist.md +++ b/windows.media.playback/mediaplaybackaudiotracklist.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackAudioTrackList --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList ## -description Represents a read-only list of [AudioTrack](../windows.media.core/audiotrack.md) objects, of which a single track can be selected at one time. ## -remarks Get an instance of this class by accessing the [AudioTracks](mediaplaybackitem_audiotracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [AudioTracksChanged](mediaplaybackitem_audiotrackschanged.md) event. This class provides access to the list of [AudioTrack](../windows.media.core/audiotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemResolved](mediaplaybacklist_itemresolved.md) event is raised, you can select one of the audio tracks in the track list for playback. Note that this class does not represent a playlist of audio tracks that are played sequentially. To play a sequential list of tracks, use [MediaPlaybackList](mediaplaybacklist.md). For how-to guidance for working with the audio tracks of a media item, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [IVectorView(AudioTrack)](../windows.foundation.collections/ivectorview_1.md), [IIterable(AudioTrack)](../windows.foundation.collections/iiterable_1.md), [ISingleSelectMediaTrackList](../windows.media.core/isingleselectmediatracklist.md), [AudioTrack](../windows.media.core/audiotrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackAudioTrackList +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList + +## -description +Represents a read-only list of [AudioTrack](../windows.media.core/audiotrack.md) objects, of which a single track can be selected at one time. + +## -remarks +Get an instance of this class by accessing the [AudioTracks](mediaplaybackitem_audiotracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [AudioTracksChanged](mediaplaybackitem_audiotrackschanged.md) event. + +This class provides access to the list of [AudioTrack](../windows.media.core/audiotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemResolved](mediaplaybacklist_itemresolved.md) event is raised, you can select one of the audio tracks in the track list for playback. + +Note that this class does not represent a playlist of audio tracks that are played sequentially. To play a sequential list of tracks, use [MediaPlaybackList](mediaplaybacklist.md). + +For how-to guidance for working with the audio tracks of a media item, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[IVectorView(AudioTrack)](../windows.foundation.collections/ivectorview_1.md), [IIterable(AudioTrack)](../windows.foundation.collections/iiterable_1.md), [ISingleSelectMediaTrackList](../windows.media.core/isingleselectmediatracklist.md), [AudioTrack](../windows.media.core/audiotrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackaudiotracklist_first_1920739956.md b/windows.media.playback/mediaplaybackaudiotracklist_first_1920739956.md index 7caacc91a6..5d75eae3d5 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_first_1920739956.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.First --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.First ## -description Returns an iterator that iterates over the items in the collection. ## -returns The iterator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.First +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.First + +## -description +Returns an iterator that iterates over the items in the collection. + +## -returns +The iterator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist_getat_496709656.md b/windows.media.playback/mediaplaybackaudiotracklist_getat_496709656.md index 992524cf75..889c12a6d6 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_getat_496709656.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.GetAt ## -description Returns the audio track at the specified index. ## -parameters ### -param index The zero-based index of the audio track. ## -returns The audio track at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.GetAt + +## -description +Returns the audio track at the specified index. + +## -parameters +### -param index +The zero-based index of the audio track. + +## -returns +The audio track at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist_getmany_1748039312.md b/windows.media.playback/mediaplaybackaudiotracklist_getmany_1748039312.md index 4aa7595717..b24bbd563b 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_getmany_1748039312.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_getmany_1748039312.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.GetMany(System.UInt32,Windows.Media.Core.AudioTrack[]) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.GetMany ## -description Retrieves the audio tracks that start at the specified index in the list. ## -parameters ### -param startIndex The zero-based index of the start of the audio tracks in the list. ### -param items The audio tracks that start at *startIndex* in the list. ## -returns The number of audio tracks retrieved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.GetMany(System.UInt32,Windows.Media.Core.AudioTrack[]) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.GetMany + +## -description +Retrieves the audio tracks that start at the specified index in the list. + +## -parameters +### -param startIndex +The zero-based index of the start of the audio tracks in the list. + +### -param items +The audio tracks that start at *startIndex* in the list. + +## -returns +The number of audio tracks retrieved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist_indexof_957740942.md b/windows.media.playback/mediaplaybackaudiotracklist_indexof_957740942.md index 0e12255c83..cc732b9ad1 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_indexof_957740942.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_indexof_957740942.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.IndexOf(Windows.Media.Core.AudioTrack,System.UInt32@) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.IndexOf ## -description Retrieves the index of a specified audio track in the list. ## -parameters ### -param value The audio track to find in the vector view. ### -param index If the audio track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. ## -returns True if the audio track is found; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackAudioTrackList.IndexOf(Windows.Media.Core.AudioTrack,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.IndexOf + +## -description +Retrieves the index of a specified audio track in the list. + +## -parameters +### -param value +The audio track to find in the vector view. + +### -param index +If the audio track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. + +## -returns +True if the audio track is found; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist_selectedindex.md b/windows.media.playback/mediaplaybackaudiotracklist_selectedindex.md index 538f1e5afe..e289357947 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_selectedindex.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_selectedindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndex --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndex ## -description Gets or sets the index of the currently selected audio track in the list. ## -property-value The index of the currently selected audio track in the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndex +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndex + +## -description +Gets or sets the index of the currently selected audio track in the list. + +## -property-value +The index of the currently selected audio track in the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist_selectedindexchanged.md b/windows.media.playback/mediaplaybackaudiotracklist_selectedindexchanged.md index 97703d82e7..b9bf2b94ef 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_selectedindexchanged.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_selectedindexchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndexChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndexChanged ## -description Occurs when the index of the currently selected audio track changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndexChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.SelectedIndexChanged + +## -description +Occurs when the index of the currently selected audio track changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackaudiotracklist_size.md b/windows.media.playback/mediaplaybackaudiotracklist_size.md index ffca60d02a..dbb8984d0c 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist_size.md +++ b/windows.media.playback/mediaplaybackaudiotracklist_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackAudioTrackList.Size --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackAudioTrackList.Size ## -description Gets the number of audio tracks in the list. ## -property-value The number of audio tracks in the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackAudioTrackList.Size +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackAudioTrackList.Size + +## -description +Gets the number of audio tracks in the list. + +## -property-value +The number of audio tracks in the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager.md b/windows.media.playback/mediaplaybackcommandmanager.md index 28267a2676..2b46e8ecbd 100644 --- a/windows.media.playback/mediaplaybackcommandmanager.md +++ b/windows.media.playback/mediaplaybackcommandmanager.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManager --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManager ## -description Specifies the behavior of and receives events from the System Media Transport Controls. Use this class to customize the interaction between a [MediaPlayer](mediaplayer.md) and the System Media Transport Controls. ## -remarks Get an instance of the **MediaPlaybackCommandManager** by accessing the [CommandManager](mediaplayer_commandmanager.md) property of a [MediaPlayer](mediaplayer.md) object. For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). ## -examples ## -see-also [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManager +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager + +## -description +Specifies the behavior of and receives events from the System Media Transport Controls. Use this class to customize the interaction between a [MediaPlayer](mediaplayer.md) and the System Media Transport Controls. + +## -remarks +Get an instance of the **MediaPlaybackCommandManager** by accessing the [CommandManager](mediaplayer_commandmanager.md) property of a [MediaPlayer](mediaplayer.md) object. + +For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). + +## -examples + +## -see-also +[Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodebehavior.md b/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodebehavior.md index 7362254511..7b6b530b1a 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodebehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodebehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeBehavior ## -description Gets an object that defines the behavior when the **Auto-repeat** control in the System Media Transport Controls is toggled. ## -property-value An object that defines the behavior when the **Auto-repeat** control is toggled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeBehavior + +## -description +Gets an object that defines the behavior when the **Auto-repeat** control in the System Media Transport Controls is toggled. + +## -property-value +An object that defines the behavior when the **Auto-repeat** control is toggled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodereceived.md b/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodereceived.md index 1ceb917e36..cecd008c17 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodereceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_autorepeatmodereceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeReceived ## -description Occurs when the command manager receives a command from the **Auto-repeat** control of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.AutoRepeatModeReceived + +## -description +Occurs when the command manager receives a command from the **Auto-repeat** control of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_fastforwardbehavior.md b/windows.media.playback/mediaplaybackcommandmanager_fastforwardbehavior.md index d74dfa42dc..5beb9ebd8f 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_fastforwardbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_fastforwardbehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardBehavior ## -description Gets an object that defines the behavior when the **Fast-forward** button in the System Media Transport Controls is tapped. ## -property-value An object that defines the behavior when the **Fast-forward** button is tapped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardBehavior + +## -description +Gets an object that defines the behavior when the **Fast-forward** button in the System Media Transport Controls is tapped. + +## -property-value +An object that defines the behavior when the **Fast-forward** button is tapped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_fastforwardreceived.md b/windows.media.playback/mediaplaybackcommandmanager_fastforwardreceived.md index c588d60394..4a2a1116a7 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_fastforwardreceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_fastforwardreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardReceived ## -description Occurs when the command manager receives a command from the **Fast-forward** button of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.FastForwardReceived + +## -description +Occurs when the command manager receives a command from the **Fast-forward** button of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_isenabled.md b/windows.media.playback/mediaplaybackcommandmanager_isenabled.md index cb70795327..43e81a9495 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_isenabled.md +++ b/windows.media.playback/mediaplaybackcommandmanager_isenabled.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.IsEnabled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.IsEnabled ## -description Gets or sets a value indicating whether the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) is enabled. ## -property-value True if the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) is enabled; otherwise, false. ## -remarks If your app scenario requires manual control of the System Media Transport Controls you can disable the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) and using the events and properties of the [SystemMediaTransportControls](mediaplayer_systemmediatransportcontrols.md) directly. > [!NOTE] > If you disable the **MediaPlaybackCommandManager** by setting **IsEnabled** to false, it will break the link between the [MediaPlayer](mediaplayer.md) the [TransportControls](../windows.ui.xaml.controls/mediaplayerelement_transportcontrols.md) provided by the [MediaPlayerElement](../windows.ui.xaml.controls/mediaplayerelement.md), so the built-in transport controls will no longer automatically control the playback of the player. Instead, you must implement your own controls to control the **MediaPlayer**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.IsEnabled + +## -description +Gets or sets a value indicating whether the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) is enabled. + +## -property-value +True if the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) is enabled; otherwise, false. + +## -remarks +If your app scenario requires manual control of the System Media Transport Controls you can disable the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) and using the events and properties of the [SystemMediaTransportControls](mediaplayer_systemmediatransportcontrols.md) directly. + +> [!NOTE] +> If you disable the **MediaPlaybackCommandManager** by setting **IsEnabled** to false, it will break the link between the [MediaPlayer](mediaplayer.md) the [TransportControls](../windows.ui.xaml.controls/mediaplayerelement_transportcontrols.md) provided by the [MediaPlayerElement](../windows.ui.xaml.controls/mediaplayerelement.md), so the built-in transport controls will no longer automatically control the playback of the player. Instead, you must implement your own controls to control the **MediaPlayer**. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_mediaplayer.md b/windows.media.playback/mediaplaybackcommandmanager_mediaplayer.md index de572334f3..8c34b71560 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_mediaplayer.md +++ b/windows.media.playback/mediaplaybackcommandmanager_mediaplayer.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.MediaPlayer --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.MediaPlayer ## -description Gets the [MediaPlayer](mediaplayer.md) instance associated with the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md). ## -property-value The [MediaPlayer](mediaplayer.md) instance associated with the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md). ## -remarks You get an instance of the **MediaPlaybackCommandManager** by accessing the [CommandManager](mediaplayer_commandmanager.md) property of a [MediaPlayer](mediaplayer.md) object. This property gives you a reference to the media player from which the command manager was obtained. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.MediaPlayer +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.MediaPlayer + +## -description +Gets the [MediaPlayer](mediaplayer.md) instance associated with the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md). + +## -property-value +The [MediaPlayer](mediaplayer.md) instance associated with the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md). + +## -remarks +You get an instance of the **MediaPlaybackCommandManager** by accessing the [CommandManager](mediaplayer_commandmanager.md) property of a [MediaPlayer](mediaplayer.md) object. This property gives you a reference to the media player from which the command manager was obtained. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_nextbehavior.md b/windows.media.playback/mediaplaybackcommandmanager_nextbehavior.md index b465b72175..fb736c0fe7 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_nextbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_nextbehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.NextBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.NextBehavior ## -description Gets an object that defines the behavior when the **Next** button in the System Media Transport Controls is tapped. ## -property-value An object that defines the behavior when the **Next** button is tapped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.NextBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.NextBehavior + +## -description +Gets an object that defines the behavior when the **Next** button in the System Media Transport Controls is tapped. + +## -property-value +An object that defines the behavior when the **Next** button is tapped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_nextreceived.md b/windows.media.playback/mediaplaybackcommandmanager_nextreceived.md index 896458a2e2..0f8f639d02 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_nextreceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_nextreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.NextReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.NextReceived ## -description Occurs when the command manager receives a command from the **Next** button of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.NextReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.NextReceived + +## -description +Occurs when the command manager receives a command from the **Next** button of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_pausebehavior.md b/windows.media.playback/mediaplaybackcommandmanager_pausebehavior.md index 0145946eac..b86603824e 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_pausebehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_pausebehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PauseBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PauseBehavior ## -description Gets an object that defines the behavior when the **Pause** button in the System Media Transport Controls is tapped. ## -property-value An object that defines the behavior when the **Pause** button is tapped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PauseBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PauseBehavior + +## -description +Gets an object that defines the behavior when the **Pause** button in the System Media Transport Controls is tapped. + +## -property-value +An object that defines the behavior when the **Pause** button is tapped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_pausereceived.md b/windows.media.playback/mediaplaybackcommandmanager_pausereceived.md index 37f2ece3af..1e8b5bd9cc 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_pausereceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_pausereceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PauseReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PauseReceived ## -description Occurs when the command manager receives a command from the **Pause** button of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PauseReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PauseReceived + +## -description +Occurs when the command manager receives a command from the **Pause** button of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_playbehavior.md b/windows.media.playback/mediaplaybackcommandmanager_playbehavior.md index 34e7f030d0..3f1547c64a 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_playbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_playbehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PlayBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PlayBehavior ## -description Gets an object that defines the behavior when the **Play** button in the System Media Transport Controls is tapped. ## -property-value An object that defines the behavior when the **Pause** button is tapped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PlayBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PlayBehavior + +## -description +Gets an object that defines the behavior when the **Play** button in the System Media Transport Controls is tapped. + +## -property-value +An object that defines the behavior when the **Pause** button is tapped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_playreceived.md b/windows.media.playback/mediaplaybackcommandmanager_playreceived.md index 782aa87dc1..db0a9dc399 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_playreceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_playreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PlayReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PlayReceived ## -description Occurs when the command manager receives a command from the **Play** control of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PlayReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PlayReceived + +## -description +Occurs when the command manager receives a command from the **Play** control of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_positionbehavior.md b/windows.media.playback/mediaplaybackcommandmanager_positionbehavior.md index 50dfc457c9..9e7326949b 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_positionbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_positionbehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PositionBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PositionBehavior ## -description Gets an object that defines the behavior when the playback position control in the System Media Transport Controls is moved. ## -property-value An object that defines the behavior when the playback position control is moved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PositionBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PositionBehavior + +## -description +Gets an object that defines the behavior when the playback position control in the System Media Transport Controls is moved. + +## -property-value +An object that defines the behavior when the playback position control is moved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_positionreceived.md b/windows.media.playback/mediaplaybackcommandmanager_positionreceived.md index 35eb11ccf2..66480619eb 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_positionreceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_positionreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PositionReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PositionReceived ## -description Occurs when the command manager receives a command changing the current playback position from the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PositionReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PositionReceived + +## -description +Occurs when the command manager receives a command changing the current playback position from the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_previousbehavior.md b/windows.media.playback/mediaplaybackcommandmanager_previousbehavior.md index bc0a70a3e2..f51d14484c 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_previousbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_previousbehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PreviousBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PreviousBehavior ## -description Gets an object that defines the behavior when the **Previous** button in the System Media Transport Controls is tapped. ## -property-value An object that defines the behavior when the **Previous** button is tapped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.PreviousBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PreviousBehavior + +## -description +Gets an object that defines the behavior when the **Previous** button in the System Media Transport Controls is tapped. + +## -property-value +An object that defines the behavior when the **Previous** button is tapped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_previousreceived.md b/windows.media.playback/mediaplaybackcommandmanager_previousreceived.md index 834a1c7134..6a2e57213a 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_previousreceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_previousreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PreviousReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.PreviousReceived ## -description Occurs when the command manager receives a command from the **Previous** button of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.PreviousReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.PreviousReceived + +## -description +Occurs when the command manager receives a command from the **Previous** button of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_ratebehavior.md b/windows.media.playback/mediaplaybackcommandmanager_ratebehavior.md index a8d0b9065d..f779a9b543 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_ratebehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_ratebehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.RateBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.RateBehavior ## -description Gets an object that defines the behavior when the playback rate is changed using the System Media Transport Controls. ## -property-value An object that defines the behavior when the playback rate is changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.RateBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.RateBehavior + +## -description +Gets an object that defines the behavior when the playback rate is changed using the System Media Transport Controls. + +## -property-value +An object that defines the behavior when the playback rate is changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_ratereceived.md b/windows.media.playback/mediaplaybackcommandmanager_ratereceived.md index bedfaefc06..acee3decf6 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_ratereceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_ratereceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.RateReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.RateReceived ## -description Occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.RateReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.RateReceived + +## -description +Occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_rewindbehavior.md b/windows.media.playback/mediaplaybackcommandmanager_rewindbehavior.md index a4c3bbafc8..a5aaa8c45e 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_rewindbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_rewindbehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.RewindBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.RewindBehavior ## -description Gets an object that defines the behavior when the **Rewind** button in the System Media Transport Controls is tapped. ## -property-value An object that defines the behavior when the **Rewind** button is tapped. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.RewindBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.RewindBehavior + +## -description +Gets an object that defines the behavior when the **Rewind** button in the System Media Transport Controls is tapped. + +## -property-value +An object that defines the behavior when the **Rewind** button is tapped. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_rewindreceived.md b/windows.media.playback/mediaplaybackcommandmanager_rewindreceived.md index 3235155e94..defe6134d5 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_rewindreceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_rewindreceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.RewindReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.RewindReceived ## -description Occurs when the command manager receives a command from the **Rewind** button of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.RewindReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.RewindReceived + +## -description +Occurs when the command manager receives a command from the **Rewind** button of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_shufflebehavior.md b/windows.media.playback/mediaplaybackcommandmanager_shufflebehavior.md index 9479d40826..055aef9fdf 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_shufflebehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanager_shufflebehavior.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleBehavior --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleBehavior ## -description Gets an object that defines the behavior when the **Shuffle** button in the System Media Transport Controls is toggled. ## -property-value An object that defines the behavior when the **Shuffle** button is toggled. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleBehavior +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleBehavior + +## -description +Gets an object that defines the behavior when the **Shuffle** button in the System Media Transport Controls is toggled. + +## -property-value +An object that defines the behavior when the **Shuffle** button is toggled. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanager_shufflereceived.md b/windows.media.playback/mediaplaybackcommandmanager_shufflereceived.md index 4c06fa6e8a..a58827b89e 100644 --- a/windows.media.playback/mediaplaybackcommandmanager_shufflereceived.md +++ b/windows.media.playback/mediaplaybackcommandmanager_shufflereceived.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleReceived --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleReceived ## -description Occurs when the command manager receives a command from the **Shuffle** control of the System Media Transport Controls. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleReceived +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManager.ShuffleReceived + +## -description +Occurs when the command manager receives a command from the **Shuffle** control of the System Media Transport Controls. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs.md index 1ce6f9024d..864e427181 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.AutoRepeatModeReceived](mediaplaybackcommandmanager_autorepeatmodereceived.md) event, which occurs when the command manager receives a command from the **Auto-repeat** control of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.AutoRepeatModeReceived](mediaplaybackcommandmanager_autorepeatmodereceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.AutoRepeatModeReceived](mediaplaybackcommandmanager_autorepeatmodereceived.md) event, which occurs when the command manager receives a command from the **Auto-repeat** control of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.AutoRepeatModeReceived](mediaplaybackcommandmanager_autorepeatmodereceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_autorepeatmode.md b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_autorepeatmode.md index 9391daacd0..9b05e52da7 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_autorepeatmode.md +++ b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_autorepeatmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.AutoRepeatMode --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.AutoRepeatMode ## -description Gets a value indicating the current auto-repeat mode. ## -property-value A value indicating the current auto-repeat mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.AutoRepeatMode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.AutoRepeatMode + +## -description +Gets a value indicating the current auto-repeat mode. + +## -property-value +A value indicating the current auto-repeat mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_getdeferral_254836512.md index 0cc04921ac..173c2292a6 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Auto-repeat** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Auto-repeat** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_handled.md index ffc8adcc16..d6bc1c73ec 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerautorepeatmodereceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [AutoRepeatModeReceived](mediaplaybackcommandmanager_autorepeatmodereceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Auto-repeat** command that initiated the event. If this property is false, the system will perform the default action based on the current [AutoRepeatModeBehavior](mediaplaybackcommandmanager_autorepeatmodebehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [AutoRepeatModeReceived](mediaplaybackcommandmanager_autorepeatmodereceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Auto-repeat** command that initiated the event. If this property is false, the system will perform the default action based on the current [AutoRepeatModeBehavior](mediaplaybackcommandmanager_autorepeatmodebehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior.md b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior.md index c737b4fae2..b5144b59be 100644 --- a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior.md +++ b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior ## -description For use with a [MediaPlaybackCommandManager](mediaplaybackcommandmanagercommandbehavior.md) object, this class allows you to enable and disable System Media Transport Controls commands and allows you to respond to changes in the enabled state of a command. ## -remarks Get an instance of this class by accessing one of the behavior properties of a [MediaPlaybackCommandManager](mediaplaybackcommandmanagercommandbehavior.md) object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior + +## -description +For use with a [MediaPlaybackCommandManager](mediaplaybackcommandmanagercommandbehavior.md) object, this class allows you to enable and disable System Media Transport Controls commands and allows you to respond to changes in the enabled state of a command. + +## -remarks +Get an instance of this class by accessing one of the behavior properties of a [MediaPlaybackCommandManager](mediaplaybackcommandmanagercommandbehavior.md) object. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_commandmanager.md b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_commandmanager.md index 5c1b498055..5e39b24be3 100644 --- a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_commandmanager.md +++ b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_commandmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.CommandManager --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.CommandManager ## -description Gets the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) associated with the behavior. ## -property-value The command manager associated with the behavior. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.CommandManager +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.CommandManager + +## -description +Gets the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) associated with the behavior. + +## -property-value +The command manager associated with the behavior. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_enablingrule.md b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_enablingrule.md index e24c02e313..183f4a0139 100644 --- a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_enablingrule.md +++ b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_enablingrule.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.EnablingRule --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.EnablingRule ## -description Gets or sets a value indicating whether a System Media Transport Controls command should always be enabled, should never be enabled, or if the system should automatically determine whether the command is enabled. ## -property-value A value defining the rule for enabling a System Media Transport Controls command. ## -remarks Use this property to override the default behavior for a System Media Transport Controls command managed by a [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md). If a [MediaPlayer](mediaplayer.md) has no remaining items to play, the System Media Transport Controls will disable the **Next** button. If your app uses the **Next** button to trigger some other action, such as switching to a different playlist of media items, you can set the **EnablingRule** for the [NextBehavior](mediaplaybackcommandmanager_nextbehavior.md) to [Always](mediacommandenablingrule.md) to ensure that the **Next** button is always enabled. Or, if a **MediaPlayer** has remaining items to play, the System Media Transport Controls will enable the **Next** button by default. If your app requires some user action before playing the next media item, you can set the **EnablingRule** for the [NextBehavior](mediaplaybackcommandmanager_nextbehavior.md) to [Never](mediacommandenablingrule.md) to disable the **Next** button. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.EnablingRule +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.EnablingRule + +## -description +Gets or sets a value indicating whether a System Media Transport Controls command should always be enabled, should never be enabled, or if the system should automatically determine whether the command is enabled. + +## -property-value +A value defining the rule for enabling a System Media Transport Controls command. + +## -remarks +Use this property to override the default behavior for a System Media Transport Controls command managed by a [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md). If a [MediaPlayer](mediaplayer.md) has no remaining items to play, the System Media Transport Controls will disable the **Next** button. If your app uses the **Next** button to trigger some other action, such as switching to a different playlist of media items, you can set the **EnablingRule** for the [NextBehavior](mediaplaybackcommandmanager_nextbehavior.md) to [Always](mediacommandenablingrule.md) to ensure that the **Next** button is always enabled. Or, if a **MediaPlayer** has remaining items to play, the System Media Transport Controls will enable the **Next** button by default. If your app requires some user action before playing the next media item, you can set the **EnablingRule** for the [NextBehavior](mediaplaybackcommandmanager_nextbehavior.md) to [Never](mediacommandenablingrule.md) to disable the **Next** button. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabled.md b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabled.md index e7b31c288a..2d37cfc49b 100644 --- a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabled.md +++ b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabled ## -description Gets a value indicating whether a System Media Transport Controls command is currently enabled. ## -property-value True if the command is currently enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabled + +## -description +Gets a value indicating whether a System Media Transport Controls command is currently enabled. + +## -property-value +True if the command is currently enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabledchanged.md b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabledchanged.md index 4432e670b3..ef42b2fa5d 100644 --- a/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabledchanged.md +++ b/windows.media.playback/mediaplaybackcommandmanagercommandbehavior_isenabledchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabledChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabledChanged ## -description Occurs when the enabled state of a System Media Transport Controls command changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabledChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerCommandBehavior.IsEnabledChanged + +## -description +Occurs when the enabled state of a System Media Transport Controls command changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs.md index f318872bc4..0c7fd23d98 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.FastForwardReceived](mediaplaybackcommandmanager_fastforwardreceived.md) event, which occurs when the command manager receives a command from the **Fast-forward** button of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.FastForwardReceived](mediaplaybackcommandmanager_fastforwardreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.FastForwardReceived](mediaplaybackcommandmanager_fastforwardreceived.md) event, which occurs when the command manager receives a command from the **Fast-forward** button of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.FastForwardReceived](mediaplaybackcommandmanager_fastforwardreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_getdeferral_254836512.md index 90de997448..365dff40e2 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Fast-forward** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Fast-forward** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_handled.md index ca44a76d8a..6978f79bf5 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerfastforwardreceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [FastForwardReceived](mediaplaybackcommandmanager_fastforwardreceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Fast-forward** command that initiated the event. If this property is false, the system will perform the default action based on the current [FastForwardBehavior](mediaplaybackcommandmanager_fastforwardbehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerFastForwardReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [FastForwardReceived](mediaplaybackcommandmanager_fastforwardreceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Fast-forward** command that initiated the event. If this property is false, the system will perform the default action based on the current [FastForwardBehavior](mediaplaybackcommandmanager_fastforwardbehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs.md index d25b6142a1..a0517ccc68 100644 --- a/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.NextReceived](mediaplaybackcommandmanager_nextreceived.md) event, which occurs when the command manager receives a command from the **Next** button of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.NextReceived](mediaplaybackcommandmanager_nextreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.NextReceived](mediaplaybackcommandmanager_nextreceived.md) event, which occurs when the command manager receives a command from the **Next** button of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.NextReceived](mediaplaybackcommandmanager_nextreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_getdeferral_254836512.md index 16cb54e551..d6993a6ae3 100644 --- a/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Next** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Next** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_handled.md index 6149a0bb4c..6d96605291 100644 --- a/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagernextreceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [NextReceived](mediaplaybackcommandmanager_nextreceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Next** command that initiated the event. If this property is false, the system will perform the default action based on the current [NextBehavior](mediaplaybackcommandmanager_nextbehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerNextReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [NextReceived](mediaplaybackcommandmanager_nextreceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Next** command that initiated the event. If this property is false, the system will perform the default action based on the current [NextBehavior](mediaplaybackcommandmanager_nextbehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs.md index 80d9f1f61f..0d8a33f69e 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.PauseReceived](mediaplaybackcommandmanager_pausereceived.md) event, which occurs when the command manager receives a command from the **Pause** button of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.PauseReceived](mediaplaybackcommandmanager_pausereceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.PauseReceived](mediaplaybackcommandmanager_pausereceived.md) event, which occurs when the command manager receives a command from the **Pause** button of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.PauseReceived](mediaplaybackcommandmanager_pausereceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_getdeferral_254836512.md index 799b036231..c811100bfa 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Pause** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Pause** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_handled.md index 035977aa65..e449ced4cc 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpausereceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [PauseReceived](mediaplaybackcommandmanager_pausereceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Pause** command that initiated the event. If this property is false, the system will perform the default action based on the current [PauseBehavior](mediaplaybackcommandmanager_pausebehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPauseReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [PauseReceived](mediaplaybackcommandmanager_pausereceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Pause** command that initiated the event. If this property is false, the system will perform the default action based on the current [PauseBehavior](mediaplaybackcommandmanager_pausebehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs.md index 00e07786ef..4633298f36 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.PlayReceived](mediaplaybackcommandmanager_playreceived.md) event, which occurs when the command manager receives a command from the **Play** button of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.PlayReceived](mediaplaybackcommandmanager_playreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.PlayReceived](mediaplaybackcommandmanager_playreceived.md) event, which occurs when the command manager receives a command from the **Play** button of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.PlayReceived](mediaplaybackcommandmanager_playreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_getdeferral_254836512.md index 9f55888719..02bb576a93 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Play** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Play** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_handled.md index 213d16cdee..96a0a99f85 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerplayreceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [PlayReceived](mediaplaybackcommandmanager_playreceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Play** command that initiated the event. If this property is false, the system will perform the default action based on the current [PlayBehavior](mediaplaybackcommandmanager_playbehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPlayReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [PlayReceived](mediaplaybackcommandmanager_playreceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Play** command that initiated the event. If this property is false, the system will perform the default action based on the current [PlayBehavior](mediaplaybackcommandmanager_playbehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs.md index dd9f9c5de7..ace73ac87d 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.PositionReceived](mediaplaybackcommandmanager_positionreceived.md) event, which occurs when the command manager receives a command changing the current position from the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.PlayReceived](mediaplaybackcommandmanager_playreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.PositionReceived](mediaplaybackcommandmanager_positionreceived.md) event, which occurs when the command manager receives a command changing the current position from the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.PlayReceived](mediaplaybackcommandmanager_playreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_getdeferral_254836512.md index 7afea2999a..d41db42469 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the change position command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the change position command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_handled.md index d3cfc07fcf..233dd5fdf4 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [PositionReceived](mediaplaybackcommandmanager_positionreceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the change position command that initiated the event. If this property is false, the system will perform the default action based on the current [PositionBehavior](mediaplaybackcommandmanager_positionbehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [PositionReceived](mediaplaybackcommandmanager_positionreceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the change position command that initiated the event. If this property is false, the system will perform the default action based on the current [PositionBehavior](mediaplaybackcommandmanager_positionbehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_position.md b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_position.md index 912f4571a1..8e27531d4a 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_position.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpositionreceivedeventargs_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Position --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Position ## -description Gets a value indicating the current playback position. ## -property-value A value indicating the current playback position. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPositionReceivedEventArgs.Position + +## -description +Gets a value indicating the current playback position. + +## -property-value +A value indicating the current playback position. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs.md index 40248cbc65..9808223f1e 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.PreviousReceived](mediaplaybackcommandmanager_previousreceived.md) event, which occurs when the command manager receives a command from the **Play** button of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.PreviousReceived](mediaplaybackcommandmanager_previousreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.PreviousReceived](mediaplaybackcommandmanager_previousreceived.md) event, which occurs when the command manager receives a command from the **Play** button of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.PreviousReceived](mediaplaybackcommandmanager_previousreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_getdeferral_254836512.md index 8bb4be4348..2a1c0a61e3 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Previous** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Previous** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_handled.md index 0acdbcff1c..68185ed978 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerpreviousreceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [PreviousReceived](mediaplaybackcommandmanager_previousreceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Previous** command that initiated the event. If this property is false, the system will perform the default action based on the current [PreviousBehavior](mediaplaybackcommandmanager_previousbehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerPreviousReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [PreviousReceived](mediaplaybackcommandmanager_previousreceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Previous** command that initiated the event. If this property is false, the system will perform the default action based on the current [PreviousBehavior](mediaplaybackcommandmanager_previousbehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs.md index 2e2d1e5543..ec700b0500 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.RateReceived](mediaplaybackcommandmanager_ratereceived.md) event, which occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.RateReceived](mediaplaybackcommandmanager_ratereceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.RateReceived](mediaplaybackcommandmanager_ratereceived.md) event, which occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.RateReceived](mediaplaybackcommandmanager_ratereceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_getdeferral_254836512.md index d7ffadbc30..4e700fafd6 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the change rate command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the change rate command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_handled.md index 5f63137431..83047ca274 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [RateReceived](mediaplaybackcommandmanager_ratereceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the change rate command that initiated the event. If this property is false, the system will perform the default action based on the current [RateBehavior](mediaplaybackcommandmanager_ratebehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [RateReceived](mediaplaybackcommandmanager_ratereceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the change rate command that initiated the event. If this property is false, the system will perform the default action based on the current [RateBehavior](mediaplaybackcommandmanager_ratebehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_playbackrate.md b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_playbackrate.md index c27ac1fe33..afb9bf37fc 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_playbackrate.md +++ b/windows.media.playback/mediaplaybackcommandmanagerratereceivedeventargs_playbackrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.PlaybackRate --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.PlaybackRate ## -description Gets a value indicating the current playback rate. ## -property-value A value indicating the current playback rate. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.PlaybackRate +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRateReceivedEventArgs.PlaybackRate + +## -description +Gets a value indicating the current playback rate. + +## -property-value +A value indicating the current playback rate. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs.md index 8388ca51e4..094c6efd1e 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs ## -description Provides data or the [MediaPlaybackCommandManager.RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event, which occurs when the command manager receives a command from the **Rewind** button of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs + +## -description +Provides data or the [MediaPlaybackCommandManager.RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event, which occurs when the command manager receives a command from the **Rewind** button of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_getdeferral_254836512.md index 07b7eb90d7..72e93e3e58 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Rewind** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Rewind** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_handled.md index 9445cc3862..6fc97b0145 100644 --- a/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagerrewindreceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Rewind** command that initiated the event. If this property is false, the system will perform the default action based on the current [RewindBehavior](mediaplaybackcommandmanager_rewindbehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerRewindReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Rewind** command that initiated the event. If this property is false, the system will perform the default action based on the current [RewindBehavior](mediaplaybackcommandmanager_rewindbehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs.md b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs.md index 68f9c77b02..da30507a7f 100644 --- a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs.md +++ b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs ## -description Provides data or the [ShuffleReceived](mediaplaybackcommandmanager_shufflereceived.md) event, which occurs when the command manager receives a command from the **Shuffle** control of the System Media Transport Controls. ## -remarks Get an instance of this class by handling the [MediaPlaybackCommandManager.RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs + +## -description +Provides data or the [ShuffleReceived](mediaplaybackcommandmanager_shufflereceived.md) event, which occurs when the command manager receives a command from the **Shuffle** control of the System Media Transport Controls. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackCommandManager.RewindReceived](mediaplaybackcommandmanager_rewindreceived.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_getdeferral_254836512.md b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_getdeferral_254836512.md index bdbad89952..1a1f548aff 100644 --- a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_getdeferral_254836512.md +++ b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_getdeferral_254836512.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.GetDeferral --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.GetDeferral ## -description Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Shuffle** command. ## -returns The deferral object. ## -remarks Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.GetDeferral + +## -description +Gets a [Deferral](../windows.foundation/deferral.md) object that causes the system to wait for you to perform asynchronous operations, such as creating a new [MediaPlaybackItem](mediaplaybackitem.md) from a network source, before it continues processing the **Shuffle** command. + +## -returns +The deferral object. + +## -remarks +Call [Complete](../windows.foundation/deferral_complete.md) when your asynchronous operations are complete to signal the system to continue. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_handled.md b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_handled.md index a5578de40c..f4e1901c79 100644 --- a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_handled.md +++ b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_handled.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.Handled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.Handled ## -description Gets or sets a value indicating whether the [ShuffleReceived](mediaplaybackcommandmanager_shufflereceived.md) event has been handled. ## -property-value True if the event has been handled; otherwise, false. ## -remarks If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Shuffle** command that initiated the event. If this property is false, the system will perform the default action based on the current [ShuffleBehavior](mediaplaybackcommandmanager_shufflebehavior.md) setting. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the [ShuffleReceived](mediaplaybackcommandmanager_shufflereceived.md) event has been handled. + +## -property-value +True if the event has been handled; otherwise, false. + +## -remarks +If you mark the event as handled by setting this property to true, the System Media Transport Controls will not take any action for the **Shuffle** command that initiated the event. If this property is false, the system will perform the default action based on the current [ShuffleBehavior](mediaplaybackcommandmanager_shufflebehavior.md) setting. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_isshufflerequested.md b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_isshufflerequested.md index a1bb1c18c8..01a6db9187 100644 --- a/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_isshufflerequested.md +++ b/windows.media.playback/mediaplaybackcommandmanagershufflereceivedeventargs_isshufflerequested.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.IsShuffleRequested --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.IsShuffleRequested ## -description Gets a value indicating whether shuffle mode is requested. ## -property-value True if shuffle mode is requested; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.IsShuffleRequested +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackCommandManagerShuffleReceivedEventArgs.IsShuffleRequested + +## -description +Gets a value indicating whether shuffle mode is requested. + +## -property-value +True if shuffle mode is requested; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem.md b/windows.media.playback/mediaplaybackitem.md index 5dc35a2684..d387427283 100644 --- a/windows.media.playback/mediaplaybackitem.md +++ b/windows.media.playback/mediaplaybackitem.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackItem --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackItem ## -description Represents a media item that can be played back. This class acts as a wrapper around a [MediaSource](../windows.media.core/mediasource.md) that exposes the audio tracks, video tracks, and timed metadata tracks included in the media source. ## -remarks A **MediaPlaybackItem** can be passed directly to a player such as [MediaPlayer](mediaplayer.md) or [MediaElement](../windows.ui.xaml.controls/mediaelement.md). Or, you can pass the player a list of multiple media playback items using the [MediaPlaybackList](mediaplaybacklist.md) class. For how-to guidance for working with media items, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [IMediaPlaybackSource](imediaplaybacksource.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackItem +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackItem + +## -description +Represents a media item that can be played back. This class acts as a wrapper around a [MediaSource](../windows.media.core/mediasource.md) that exposes the audio tracks, video tracks, and timed metadata tracks included in the media source. + +## -remarks +A **MediaPlaybackItem** can be passed directly to a player such as [MediaPlayer](mediaplayer.md) or [MediaElement](../windows.ui.xaml.controls/mediaelement.md). Or, you can pass the player a list of multiple media playback items using the [MediaPlaybackList](mediaplaybacklist.md) class. + +For how-to guidance for working with media items, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[IMediaPlaybackSource](imediaplaybacksource.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackitem_applydisplayproperties_1634192028.md b/windows.media.playback/mediaplaybackitem_applydisplayproperties_1634192028.md index 27a2592345..f0a46d2fb6 100644 --- a/windows.media.playback/mediaplaybackitem_applydisplayproperties_1634192028.md +++ b/windows.media.playback/mediaplaybackitem_applydisplayproperties_1634192028.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackItem.ApplyDisplayProperties(Windows.Media.Playback.MediaItemDisplayProperties) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackItem.ApplyDisplayProperties ## -description Updates the display properties for the [MediaPlaybackItem](mediaplaybackitem.md). These properties are used by the System Media Transport Controls to display information about the currently playing media item. ## -parameters ### -param value The display properties to apply to the [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks Get the display properties for a [MediaPlaybackItem](mediaplaybackitem.md) by calling [GetDisplayProperties](mediaplaybackitem_getdisplayproperties.md). For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackItem.ApplyDisplayProperties(Windows.Media.Playback.MediaItemDisplayProperties) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.ApplyDisplayProperties + +## -description +Updates the display properties for the [MediaPlaybackItem](mediaplaybackitem.md). These properties are used by the System Media Transport Controls to display information about the currently playing media item. + +## -parameters +### -param value +The display properties to apply to the [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +Get the display properties for a [MediaPlaybackItem](mediaplaybackitem.md) by calling [GetDisplayProperties](mediaplaybackitem_getdisplayproperties.md). + +For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_audiotracks.md b/windows.media.playback/mediaplaybackitem_audiotracks.md index 51f4db3a48..b0c29ca02e 100644 --- a/windows.media.playback/mediaplaybackitem_audiotracks.md +++ b/windows.media.playback/mediaplaybackitem_audiotracks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.AudioTracks --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.AudioTracks ## -description Gets a read-only list of audio tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The read-only list of audio tracks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.AudioTracks +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.AudioTracks + +## -description +Gets a read-only list of audio tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The read-only list of audio tracks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_audiotrackschanged.md b/windows.media.playback/mediaplaybackitem_audiotrackschanged.md index f6cb60c359..b2045666fe 100644 --- a/windows.media.playback/mediaplaybackitem_audiotrackschanged.md +++ b/windows.media.playback/mediaplaybackitem_audiotrackschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackItem.AudioTracksChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackItem.AudioTracksChanged ## -description Occurs when the list of audio tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackItem.AudioTracksChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.AudioTracksChanged + +## -description +Occurs when the list of audio tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_breakschedule.md b/windows.media.playback/mediaplaybackitem_breakschedule.md index 09517a51d2..628f14223b 100644 --- a/windows.media.playback/mediaplaybackitem_breakschedule.md +++ b/windows.media.playback/mediaplaybackitem_breakschedule.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.BreakSchedule --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.BreakSchedule ## -description Gets the [MediaBreakSchedule](mediabreakschedule.md) defining the schedule of media breaks for the [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The [MediaBreakSchedule](mediabreakschedule.md) defining the schedule of media breaks for the [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks The **MediaBreakSchedule** object allows you to specify [MediaBreak](mediabreak.md) objects that should be played before the **MediaPlaybackItem** is played, after the item is played, or at scheduled positions within the item's playback. For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). ## -examples ## -see-also [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks) \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.BreakSchedule +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.BreakSchedule + +## -description +Gets the [MediaBreakSchedule](mediabreakschedule.md) defining the schedule of media breaks for the [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The [MediaBreakSchedule](mediabreakschedule.md) defining the schedule of media breaks for the [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +The **MediaBreakSchedule** object allows you to specify [MediaBreak](mediabreak.md) objects that should be played before the **MediaPlaybackItem** is played, after the item is played, or at scheduled positions within the item's playback. + +For how-to guidance for working with media breaks, see [Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks). + +## -examples + +## -see-also +[Create, schedule, and manage media breaks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/create-schedule-and-manage-media-breaks) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackitem_canskip.md b/windows.media.playback/mediaplaybackitem_canskip.md index c4f1f53977..8de60e5001 100644 --- a/windows.media.playback/mediaplaybackitem_canskip.md +++ b/windows.media.playback/mediaplaybackitem_canskip.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.CanSkip --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.CanSkip ## -description Gets or sets a value indicating whether the [MediaPlaybackItem](mediaplaybackitem.md) can be skipped. ## -property-value True if the [MediaPlaybackItem](mediaplaybackitem.md) can be skipped; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.CanSkip +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.CanSkip + +## -description +Gets or sets a value indicating whether the [MediaPlaybackItem](mediaplaybackitem.md) can be skipped. + +## -property-value +True if the [MediaPlaybackItem](mediaplaybackitem.md) can be skipped; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_durationlimit.md b/windows.media.playback/mediaplaybackitem_durationlimit.md index f5e0af032b..94a2aec7a6 100644 --- a/windows.media.playback/mediaplaybackitem_durationlimit.md +++ b/windows.media.playback/mediaplaybackitem_durationlimit.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.DurationLimit --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.DurationLimit ## -description Gets the maximum playback duration of the [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The maximum playback duration of the [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks Set this value by using the [MediaPlaybackItem(MediaSource, TimeSpan, TimeSpan)](mediaplaybackitem_mediaplaybackitem_342236482.md) constructor to ensure that the [MediaPlaybackItem](mediaplaybackitem.md) will be played for no longer than the specified duration. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.DurationLimit +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.DurationLimit + +## -description +Gets the maximum playback duration of the [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The maximum playback duration of the [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +Set this value by using the [MediaPlaybackItem(MediaSource, TimeSpan, TimeSpan)](mediaplaybackitem_mediaplaybackitem_342236482.md) constructor to ensure that the [MediaPlaybackItem](mediaplaybackitem.md) will be played for no longer than the specified duration. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_findfrommediasource_340340129.md b/windows.media.playback/mediaplaybackitem_findfrommediasource_340340129.md index 9e6bcb811c..fd49d55dce 100644 --- a/windows.media.playback/mediaplaybackitem_findfrommediasource_340340129.md +++ b/windows.media.playback/mediaplaybackitem_findfrommediasource_340340129.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackItem.FindFromMediaSource(Windows.Media.Core.MediaSource) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackItem.FindFromMediaSource ## -description Retrieves the [MediaPlaybackItem](mediaplaybackitem.md) associated with the provided [MediaSource](../windows.media.core/mediasource.md). ## -parameters ### -param source The [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). ## -returns The [MediaPlaybackItem](mediaplaybackitem.md) associated with the provided [MediaSource](../windows.media.core/mediasource.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackItem.FindFromMediaSource(Windows.Media.Core.MediaSource) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.FindFromMediaSource + +## -description +Retrieves the [MediaPlaybackItem](mediaplaybackitem.md) associated with the provided [MediaSource](../windows.media.core/mediasource.md). + +## -parameters +### -param source +The [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). + +## -returns +The [MediaPlaybackItem](mediaplaybackitem.md) associated with the provided [MediaSource](../windows.media.core/mediasource.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_getdisplayproperties_103236454.md b/windows.media.playback/mediaplaybackitem_getdisplayproperties_103236454.md index 0d44cccf40..73664da3da 100644 --- a/windows.media.playback/mediaplaybackitem_getdisplayproperties_103236454.md +++ b/windows.media.playback/mediaplaybackitem_getdisplayproperties_103236454.md @@ -1,3 +1,25 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackItem.GetDisplayProperties --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackItem.GetDisplayProperties ## -description Gets the display properties for a [MediaPlaybackItem](mediaplaybackitem.md). ## -returns The display properties for a [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks To modify the display properties for a [MediaPlaybackItem](mediaplaybackitem.md), retrieve the properties by calling **GetDisplayProperties**, update the data in the [MediaItemDisplayProperties](mediaitemdisplayproperties.md), then call [ApplyDisplayProperties](mediaplaybackitem_applydisplayproperties.md). For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackItem.GetDisplayProperties +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.GetDisplayProperties + +## -description +Gets the display properties for a [MediaPlaybackItem](mediaplaybackitem.md). + +## -returns +The display properties for a [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +To modify the display properties for a [MediaPlaybackItem](mediaplaybackitem.md), retrieve the properties by calling **GetDisplayProperties**, update the data in the [MediaItemDisplayProperties](mediaitemdisplayproperties.md), then call [ApplyDisplayProperties](mediaplaybackitem_applydisplayproperties.md). + +For how-to guidance for integrating with the SMTC, see [Integrate with the System Media Transport Controls](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/integrate-with-systemmediatransportcontrols). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1053881486.md b/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1053881486.md index bb23350889..25bb8c0e56 100644 --- a/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1053881486.md +++ b/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1053881486.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackItem.#ctor(Windows.Media.Core.MediaSource,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackItem.MediaPlaybackItem ## -description Initializes a new instance of the [MediaPlaybackItem](mediaplaybackitem.md) class with a [StartTime](mediaplaybackitem_starttime.md) value indicating the position within the item where playback should begin. ## -parameters ### -param source The media source from which the [MediaPlaybackItem](mediaplaybackitem.md) is created. ### -param startTime The position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. ## -remarks ## -examples ## -see-also [MediaPlaybackItem(MediaSource, TimeSpan, TimeSpan)](mediaplaybackitem_mediaplaybackitem_342236482.md), [MediaPlaybackItem(MediaSource)](mediaplaybackitem_mediaplaybackitem_1416920982.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackItem.#ctor(Windows.Media.Core.MediaSource,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.MediaPlaybackItem + +## -description +Initializes a new instance of the [MediaPlaybackItem](mediaplaybackitem.md) class with a [StartTime](mediaplaybackitem_starttime.md) value indicating the position within the item where playback should begin. + +## -parameters +### -param source +The media source from which the [MediaPlaybackItem](mediaplaybackitem.md) is created. + +### -param startTime +The position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. + +## -remarks + +## -examples + +## -see-also +[MediaPlaybackItem(MediaSource, TimeSpan, TimeSpan)](mediaplaybackitem_mediaplaybackitem_342236482.md), [MediaPlaybackItem(MediaSource)](mediaplaybackitem_mediaplaybackitem_1416920982.md) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1416920982.md b/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1416920982.md index 99f9d2f58e..cce66e5594 100644 --- a/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1416920982.md +++ b/windows.media.playback/mediaplaybackitem_mediaplaybackitem_1416920982.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackItem.#ctor(Windows.Media.Core.MediaSource) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackItem.MediaPlaybackItem ## -description Initializes a new instance of the [MediaPlaybackItem](mediaplaybackitem.md) class. ## -parameters ### -param source The media source from which the [MediaPlaybackItem](mediaplaybackitem.md) is created. ## -remarks A [MediaSource](../windows.media.core/mediasource.md) can only be used by a single **MediaPlaybackItem**. If you attempt to create a second **MediaPlaybackItem** from the same **MediaSource**, the constructor will fail with an MF_E_UNEXPECTED error. In C# this error is projected as a **System.Exception**. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackItem.#ctor(Windows.Media.Core.MediaSource) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.MediaPlaybackItem + +## -description +Initializes a new instance of the [MediaPlaybackItem](mediaplaybackitem.md) class. + +## -parameters +### -param source +The media source from which the [MediaPlaybackItem](mediaplaybackitem.md) is created. + +## -remarks +A [MediaSource](../windows.media.core/mediasource.md) can only be used by a single **MediaPlaybackItem**. If you attempt to create a second **MediaPlaybackItem** from the same **MediaSource**, the constructor will fail with an MF_E_UNEXPECTED error. In C# this error is projected as a **System.Exception**. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_mediaplaybackitem_342236482.md b/windows.media.playback/mediaplaybackitem_mediaplaybackitem_342236482.md index 3f1fc81e20..19ce9d6de9 100644 --- a/windows.media.playback/mediaplaybackitem_mediaplaybackitem_342236482.md +++ b/windows.media.playback/mediaplaybackitem_mediaplaybackitem_342236482.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackItem.#ctor(Windows.Media.Core.MediaSource,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackItem.MediaPlaybackItem ## -description Initializes a new instance of the [MediaPlaybackItem](mediaplaybackitem.md) class with a [StartTime](mediaplaybackitem_starttime.md) value indicating the position within the item where playback should begin and a [DurationLimit](mediaplaybackitem_durationlimit.md) value specifying the maximum playback duration of the item. ## -parameters ### -param source The media source from which the [MediaPlaybackItem](mediaplaybackitem.md) is created. ### -param startTime The position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. ### -param durationLimit The maximum playback duration of the [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also [MediaPlaybackItem(MediaSource, TimeSpan)](mediaplaybackitem_mediaplaybackitem_1053881486.md), [MediaPlaybackItem(MediaSource)](mediaplaybackitem_mediaplaybackitem_1416920982.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackItem.#ctor(Windows.Media.Core.MediaSource,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.MediaPlaybackItem + +## -description +Initializes a new instance of the [MediaPlaybackItem](mediaplaybackitem.md) class with a [StartTime](mediaplaybackitem_starttime.md) value indicating the position within the item where playback should begin and a [DurationLimit](mediaplaybackitem_durationlimit.md) value specifying the maximum playback duration of the item. + +## -parameters +### -param source +The media source from which the [MediaPlaybackItem](mediaplaybackitem.md) is created. + +### -param startTime +The position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. + +### -param durationLimit +The maximum playback duration of the [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also +[MediaPlaybackItem(MediaSource, TimeSpan)](mediaplaybackitem_mediaplaybackitem_1053881486.md), [MediaPlaybackItem(MediaSource)](mediaplaybackitem_mediaplaybackitem_1416920982.md) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackitem_source.md b/windows.media.playback/mediaplaybackitem_source.md index b94a40809b..c084cda3fa 100644 --- a/windows.media.playback/mediaplaybackitem_source.md +++ b/windows.media.playback/mediaplaybackitem_source.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.Source --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.Source ## -description Gets the [MediaSource](../windows.media.core/mediasource.md) object associated with the [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The [MediaSource](../windows.media.core/mediasource.md) object associated with the [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.Source +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.Source + +## -description +Gets the [MediaSource](../windows.media.core/mediasource.md) object associated with the [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The [MediaSource](../windows.media.core/mediasource.md) object associated with the [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_starttime.md b/windows.media.playback/mediaplaybackitem_starttime.md index 4b5292b906..05a01d236c 100644 --- a/windows.media.playback/mediaplaybackitem_starttime.md +++ b/windows.media.playback/mediaplaybackitem_starttime.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.StartTime --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.StartTime ## -description Gets the position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. ## -property-value The position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. ## -remarks Set this value by using the [MediaPlaybackItem(MediaSource, TimeSpan)](mediaplaybackitem_mediaplaybackitem_1053881486.md) or [MediaPlaybackItem(MediaSource, TimeSpan, TimeSpan)](mediaplaybackitem_mediaplaybackitem_342236482.md) constructor to specify that playback of the [MediaPlaybackItem](mediaplaybackitem.md) should begin at a position other than the start of the item. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.StartTime + +## -description +Gets the position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. + +## -property-value +The position within the [MediaPlaybackItem](mediaplaybackitem.md) where playback should begin. + +## -remarks +Set this value by using the [MediaPlaybackItem(MediaSource, TimeSpan)](mediaplaybackitem_mediaplaybackitem_1053881486.md) or [MediaPlaybackItem(MediaSource, TimeSpan, TimeSpan)](mediaplaybackitem_mediaplaybackitem_342236482.md) constructor to specify that playback of the [MediaPlaybackItem](mediaplaybackitem.md) should begin at a position other than the start of the item. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_timedmetadatatracks.md b/windows.media.playback/mediaplaybackitem_timedmetadatatracks.md index cb20cd3ac9..ab115ba608 100644 --- a/windows.media.playback/mediaplaybackitem_timedmetadatatracks.md +++ b/windows.media.playback/mediaplaybackitem_timedmetadatatracks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracks --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracks ## -description Gets a read-only list of timed metadata tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The read-only list of timed metadata tracks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracks +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracks + +## -description +Gets a read-only list of timed metadata tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The read-only list of timed metadata tracks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_timedmetadatatrackschanged.md b/windows.media.playback/mediaplaybackitem_timedmetadatatrackschanged.md index 4bfbfead22..ac802d4d6c 100644 --- a/windows.media.playback/mediaplaybackitem_timedmetadatatrackschanged.md +++ b/windows.media.playback/mediaplaybackitem_timedmetadatatrackschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracksChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracksChanged ## -description Occurs when the list of timed metadata tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracksChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.TimedMetadataTracksChanged + +## -description +Occurs when the list of timed metadata tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_videotracks.md b/windows.media.playback/mediaplaybackitem_videotracks.md index a6f3b37b90..1e450d2c76 100644 --- a/windows.media.playback/mediaplaybackitem_videotracks.md +++ b/windows.media.playback/mediaplaybackitem_videotracks.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItem.VideoTracks --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItem.VideoTracks ## -description Gets a read-only list of video tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The read-only list of video tracks. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.VideoTracks +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.VideoTracks + +## -description +Gets a read-only list of video tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The read-only list of video tracks. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitem_videotrackschanged.md b/windows.media.playback/mediaplaybackitem_videotrackschanged.md index d0b24c3763..a245883cbd 100644 --- a/windows.media.playback/mediaplaybackitem_videotrackschanged.md +++ b/windows.media.playback/mediaplaybackitem_videotrackschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackItem.VideoTracksChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackItem.VideoTracksChanged ## -description Occurs when the list of video tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackItem.VideoTracksChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.VideoTracksChanged + +## -description +Occurs when the list of video tracks in the [MediaSource](../windows.media.core/mediasource.md) associated with the [MediaPlaybackItem](mediaplaybackitem.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemerror.md b/windows.media.playback/mediaplaybackitemerror.md index a37c522dc5..ce20852185 100644 --- a/windows.media.playback/mediaplaybackitemerror.md +++ b/windows.media.playback/mediaplaybackitemerror.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackItemError --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackItemError ## -description Represents an error that occurred trying to resolve a [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks The [ErrorCode](mediaplaybackitemerror_errorcode.md) property provides high-level information about the error that occurred resolving the playback item. The [Propagate](mediaplaybackitemerror_propagate.md) method propagates the underlying exception that caused the error. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackItemError +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackItemError + +## -description +Represents an error that occurred trying to resolve a [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +The [ErrorCode](mediaplaybackitemerror_errorcode.md) property provides high-level information about the error that occurred resolving the playback item. The [Propagate](mediaplaybackitemerror_propagate.md) method propagates the underlying exception that caused the error. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemerror_errorcode.md b/windows.media.playback/mediaplaybackitemerror_errorcode.md index 2ea305adf0..e90e09a180 100644 --- a/windows.media.playback/mediaplaybackitemerror_errorcode.md +++ b/windows.media.playback/mediaplaybackitemerror_errorcode.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItemError.ErrorCode --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItemError.ErrorCode ## -description Gets the error code associated with the playback item error. ## -property-value The error code associated with the playback item error. ## -remarks This value provides high-level information about the error that occurred resolving the playback item. To get the low-level exception associated with the error, call [MediaPlaybackItemError.Propagate](mediaplaybackitemerror_propagate.md) which will cause the underlying exception to be raised. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItemError.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItemError.ErrorCode + +## -description +Gets the error code associated with the playback item error. + +## -property-value +The error code associated with the playback item error. + +## -remarks +This value provides high-level information about the error that occurred resolving the playback item. To get the low-level exception associated with the error, call [MediaPlaybackItemError.Propagate](mediaplaybackitemerror_propagate.md) which will cause the underlying exception to be raised. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemerror_extendederror.md b/windows.media.playback/mediaplaybackitemerror_extendederror.md index 1862942cfe..e54701ba36 100644 --- a/windows.media.playback/mediaplaybackitemerror_extendederror.md +++ b/windows.media.playback/mediaplaybackitemerror_extendederror.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItemError.ExtendedError --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItemError.ExtendedError ## -description Gets the extended error code for the [MediaPlaybackItem](mediaplaybackitem.md) error. ## -property-value The error code. ## -remarks Get high-level information about the error that occurred resolving the playback item by checking the [ErrorCode](mediaplaybackitemerror_errorcode.md) property. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItemError.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItemError.ExtendedError + +## -description +Gets the extended error code for the [MediaPlaybackItem](mediaplaybackitem.md) error. + +## -property-value +The error code. + +## -remarks +Get high-level information about the error that occurred resolving the playback item by checking the [ErrorCode](mediaplaybackitemerror_errorcode.md) property. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemfailedeventargs.md b/windows.media.playback/mediaplaybackitemfailedeventargs.md index f4b14045f5..c044d46d8f 100644 --- a/windows.media.playback/mediaplaybackitemfailedeventargs.md +++ b/windows.media.playback/mediaplaybackitemfailedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackItemFailedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackItemFailedEventArgs ## -description Provides data for the [MediaPlaybackList.ItemFailed](mediaplaybacklist_itemfailed.md) event. ## -remarks Get an instance of this class by handling the [MediaPlaybackList.ItemFailed](mediaplaybacklist_itemfailed.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackItemFailedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackItemFailedEventArgs + +## -description +Provides data for the [MediaPlaybackList.ItemFailed](mediaplaybacklist_itemfailed.md) event. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackList.ItemFailed](mediaplaybacklist_itemfailed.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemfailedeventargs_error.md b/windows.media.playback/mediaplaybackitemfailedeventargs_error.md index 0ee2b94ffc..fd14e81de6 100644 --- a/windows.media.playback/mediaplaybackitemfailedeventargs_error.md +++ b/windows.media.playback/mediaplaybackitemfailedeventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Error --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Error ## -description Gets a wrapper object for the [MediaPlaybackItem](mediaplaybackitem.md) error that provides high-level information about the cause of the error. ## -property-value A wrapper object for the [MediaPlaybackItem](mediaplaybackitem.md) error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Error + +## -description +Gets a wrapper object for the [MediaPlaybackItem](mediaplaybackitem.md) error that provides high-level information about the cause of the error. + +## -property-value +A wrapper object for the [MediaPlaybackItem](mediaplaybackitem.md) error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemfailedeventargs_item.md b/windows.media.playback/mediaplaybackitemfailedeventargs_item.md index 2a109a506f..94fc2955db 100644 --- a/windows.media.playback/mediaplaybackitemfailedeventargs_item.md +++ b/windows.media.playback/mediaplaybackitemfailedeventargs_item.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Item --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Item ## -description Gets the [MediaPlaybackItem](mediaplaybackitem.md) associated with the error. ## -property-value The [MediaPlaybackItem](mediaplaybackitem.md) associated with the error. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Item +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItemFailedEventArgs.Item + +## -description +Gets the [MediaPlaybackItem](mediaplaybackitem.md) associated with the error. + +## -property-value +The [MediaPlaybackItem](mediaplaybackitem.md) associated with the error. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemopenedeventargs.md b/windows.media.playback/mediaplaybackitemopenedeventargs.md index 67111a6cac..4f59f8abba 100644 --- a/windows.media.playback/mediaplaybackitemopenedeventargs.md +++ b/windows.media.playback/mediaplaybackitemopenedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs ## -description Provides data for the [MediaPlaybackList::ItemOpened](mediaplaybacklist_itemopened.md) event. ## -remarks Get an instance of this class by handling the [MediaPlaybackList.ItemOpened](mediaplaybacklist_itemopened.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs + +## -description +Provides data for the [MediaPlaybackList::ItemOpened](mediaplaybacklist_itemopened.md) event. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackList.ItemOpened](mediaplaybacklist_itemopened.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackitemopenedeventargs_item.md b/windows.media.playback/mediaplaybackitemopenedeventargs_item.md index ff4a9246ff..52ae117ba4 100644 --- a/windows.media.playback/mediaplaybackitemopenedeventargs_item.md +++ b/windows.media.playback/mediaplaybackitemopenedeventargs_item.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs.Item --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs.Item ## -description Gets the [MediaPlaybackItem](mediaplaybackitem.md) that was successfully opened. ## -property-value The [MediaPlaybackItem](mediaplaybackitem.md) that was successfully opened. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs.Item +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItemOpenedEventArgs.Item + +## -description +Gets the [MediaPlaybackItem](mediaplaybackitem.md) that was successfully opened. + +## -property-value +The [MediaPlaybackItem](mediaplaybackitem.md) that was successfully opened. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist.md b/windows.media.playback/mediaplaybacklist.md index 57967c602d..a5cc504cb5 100644 --- a/windows.media.playback/mediaplaybacklist.md +++ b/windows.media.playback/mediaplaybacklist.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackList --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackList ## -description Represents a list of [MediaPlaybackItem](mediaplaybackitem.md) objects that can be played back. Provides methods for switching the currently playing item and enabling looping and shuffling. ## -remarks Items in a [MediaPlaybackList](mediaplaybacklist.md) are rendered using gapless playback. The system will use provided metadata in MP3 or AAC encoded files to determine the delay or padding compensation needed for gapless playback. If the MP3 or AAC encoded files don't provide this metadata, then the system determines the delay or padding heuristically. For lossless formats, such as PCM, FLAC, or ALAC, the system takes no action because these encoders don't introduce delay or padding. For how-to guidance for working with media items, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [IMediaPlaybackSource](imediaplaybacksource.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackList +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackList + +## -description +Represents a list of [MediaPlaybackItem](mediaplaybackitem.md) objects that can be played back. Provides methods for switching the currently playing item and enabling looping and shuffling. + +## -remarks +Items in a [MediaPlaybackList](mediaplaybacklist.md) are rendered using gapless playback. The system will use provided metadata in MP3 or AAC encoded files to determine the delay or padding compensation needed for gapless playback. If the MP3 or AAC encoded files don't provide this metadata, then the system determines the delay or padding heuristically. For lossless formats, such as PCM, FLAC, or ALAC, the system takes no action because these encoders don't introduce delay or padding. + +For how-to guidance for working with media items, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[IMediaPlaybackSource](imediaplaybacksource.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybacklist_autorepeatenabled.md b/windows.media.playback/mediaplaybacklist_autorepeatenabled.md index 9dca6b5db3..709a9873ba 100644 --- a/windows.media.playback/mediaplaybacklist_autorepeatenabled.md +++ b/windows.media.playback/mediaplaybacklist_autorepeatenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.AutoRepeatEnabled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.AutoRepeatEnabled ## -description Gets or sets a value indicating whether the playback list will loop when the end of the list is reached. ## -property-value True if auto-repeat is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.AutoRepeatEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.AutoRepeatEnabled + +## -description +Gets or sets a value indicating whether the playback list will loop when the end of the list is reached. + +## -property-value +True if auto-repeat is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_currentitem.md b/windows.media.playback/mediaplaybacklist_currentitem.md index b67fdc2fdb..a0b5f02523 100644 --- a/windows.media.playback/mediaplaybacklist_currentitem.md +++ b/windows.media.playback/mediaplaybacklist_currentitem.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.CurrentItem --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.CurrentItem ## -description Gets the currently playing [MediaPlaybackItem](mediaplaybackitem.md). ## -property-value The currently playing [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.CurrentItem +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.CurrentItem + +## -description +Gets the currently playing [MediaPlaybackItem](mediaplaybackitem.md). + +## -property-value +The currently playing [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_currentitemchanged.md b/windows.media.playback/mediaplaybacklist_currentitemchanged.md index c57bc419ff..e12e039896 100644 --- a/windows.media.playback/mediaplaybacklist_currentitemchanged.md +++ b/windows.media.playback/mediaplaybacklist_currentitemchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackList.CurrentItemChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackList.CurrentItemChanged ## -description Occurs when the currently playing [MediaPlaybackItem](mediaplaybackitem.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackList.CurrentItemChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackList.CurrentItemChanged + +## -description +Occurs when the currently playing [MediaPlaybackItem](mediaplaybackitem.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_currentitemindex.md b/windows.media.playback/mediaplaybacklist_currentitemindex.md index a221e165d0..5b8329cd53 100644 --- a/windows.media.playback/mediaplaybacklist_currentitemindex.md +++ b/windows.media.playback/mediaplaybacklist_currentitemindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.CurrentItemIndex --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.CurrentItemIndex ## -description Gets the index of the current item in the[MediaPlaybackList](mediaplaybacklist.md). ## -property-value The index of the current item in the[MediaPlaybackList](mediaplaybacklist.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.CurrentItemIndex +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.CurrentItemIndex + +## -description +Gets the index of the current item in the[MediaPlaybackList](mediaplaybacklist.md). + +## -property-value +The index of the current item in the[MediaPlaybackList](mediaplaybacklist.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_itemfailed.md b/windows.media.playback/mediaplaybacklist_itemfailed.md index 7e0e622977..90dde65def 100644 --- a/windows.media.playback/mediaplaybacklist_itemfailed.md +++ b/windows.media.playback/mediaplaybacklist_itemfailed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackList.ItemFailed --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackList.ItemFailed ## -description Occurs when an error is encountered with a [MediaPlaybackItem](mediaplaybackitem.md) in the playback list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackList.ItemFailed +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackList.ItemFailed + +## -description +Occurs when an error is encountered with a [MediaPlaybackItem](mediaplaybackitem.md) in the playback list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_itemopened.md b/windows.media.playback/mediaplaybacklist_itemopened.md index 5aaf3dcab0..3158e58fad 100644 --- a/windows.media.playback/mediaplaybacklist_itemopened.md +++ b/windows.media.playback/mediaplaybacklist_itemopened.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackList.ItemOpened --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackList.ItemOpened ## -description Occurs when a [MediaPlaybackItem](mediaplaybackitem.md) in the playback list is successfully opened. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackList.ItemOpened +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackList.ItemOpened + +## -description +Occurs when a [MediaPlaybackItem](mediaplaybackitem.md) in the playback list is successfully opened. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_items.md b/windows.media.playback/mediaplaybacklist_items.md index fc9ed6022e..c4b9ee1676 100644 --- a/windows.media.playback/mediaplaybacklist_items.md +++ b/windows.media.playback/mediaplaybacklist_items.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.Items --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.Items ## -description Gets an [IObservableVector](../windows.foundation.collections/iobservablevector_1.md) representation of the playback list. ## -property-value An [IObservableVector](../windows.foundation.collections/iobservablevector_1.md) representation of the playback list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.Items +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.Items + +## -description +Gets an [IObservableVector](../windows.foundation.collections/iobservablevector_1.md) representation of the playback list. + +## -property-value +An [IObservableVector](../windows.foundation.collections/iobservablevector_1.md) representation of the playback list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_maxprefetchtime.md b/windows.media.playback/mediaplaybacklist_maxprefetchtime.md index e76879eecd..705106c6c3 100644 --- a/windows.media.playback/mediaplaybacklist_maxprefetchtime.md +++ b/windows.media.playback/mediaplaybacklist_maxprefetchtime.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.MaxPrefetchTime --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.MaxPrefetchTime ## -description Gets or sets the maximum time before a [MediaPlaybackItem](mediaplaybackitem.md) in the list is expected to play that the media content associated with the item is retrieved. ## -property-value The maximum time before a [MediaPlaybackItem](mediaplaybackitem.md) in the list is expected to play that the media content associated with the item is retrieved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.MaxPrefetchTime +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.MaxPrefetchTime + +## -description +Gets or sets the maximum time before a [MediaPlaybackItem](mediaplaybackitem.md) in the list is expected to play that the media content associated with the item is retrieved. + +## -property-value +The maximum time before a [MediaPlaybackItem](mediaplaybackitem.md) in the list is expected to play that the media content associated with the item is retrieved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_mediaplaybacklist_1221375020.md b/windows.media.playback/mediaplaybacklist_mediaplaybacklist_1221375020.md index 9399be6183..ace90ddb6b 100644 --- a/windows.media.playback/mediaplaybacklist_mediaplaybacklist_1221375020.md +++ b/windows.media.playback/mediaplaybacklist_mediaplaybacklist_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackList.#ctor --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackList.MediaPlaybackList ## -description Initializes a new instance of the [MediaPlaybackList](mediaplaybacklist.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackList.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackList.MediaPlaybackList + +## -description +Initializes a new instance of the [MediaPlaybackList](mediaplaybacklist.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_movenext_1926573527.md b/windows.media.playback/mediaplaybacklist_movenext_1926573527.md index 987cf29577..578d02d8bf 100644 --- a/windows.media.playback/mediaplaybacklist_movenext_1926573527.md +++ b/windows.media.playback/mediaplaybacklist_movenext_1926573527.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackList.MoveNext --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackList.MoveNext ## -description Changes the current item of the [MediaPlaybackList](mediaplaybacklist.md) to the next item in the list. ## -returns The new current [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks This current item of the [MediaPlaybackList](mediaplaybacklist.md) can't be changed while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackList.MoveNext +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackList.MoveNext + +## -description +Changes the current item of the [MediaPlaybackList](mediaplaybacklist.md) to the next item in the list. + +## -returns +The new current [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +This current item of the [MediaPlaybackList](mediaplaybacklist.md) can't be changed while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_moveprevious_1435851914.md b/windows.media.playback/mediaplaybacklist_moveprevious_1435851914.md index f56d7cd981..c7e7a761e3 100644 --- a/windows.media.playback/mediaplaybacklist_moveprevious_1435851914.md +++ b/windows.media.playback/mediaplaybacklist_moveprevious_1435851914.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackList.MovePrevious --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackList.MovePrevious ## -description Changes the current item of the [MediaPlaybackList](mediaplaybacklist.md) to the previous item in the list. ## -returns The new current [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks This current item of the [MediaPlaybackList](mediaplaybacklist.md) can't be changed while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackList.MovePrevious +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackList.MovePrevious + +## -description +Changes the current item of the [MediaPlaybackList](mediaplaybacklist.md) to the previous item in the list. + +## -returns +The new current [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +This current item of the [MediaPlaybackList](mediaplaybacklist.md) can't be changed while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_moveto_907466992.md b/windows.media.playback/mediaplaybacklist_moveto_907466992.md index 76d0406f37..6ea9b94261 100644 --- a/windows.media.playback/mediaplaybacklist_moveto_907466992.md +++ b/windows.media.playback/mediaplaybacklist_moveto_907466992.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackList.MoveTo(System.UInt32) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackList.MoveTo ## -description Changes the current item of the [MediaPlaybackList](mediaplaybacklist.md) to the item with the specified index. ## -parameters ### -param itemIndex The index of the item to make current. ## -returns The new current [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks This current item of the [MediaPlaybackList](mediaplaybacklist.md) can't be changed while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackList.MoveTo(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackList.MoveTo + +## -description +Changes the current item of the [MediaPlaybackList](mediaplaybacklist.md) to the item with the specified index. + +## -parameters +### -param itemIndex +The index of the item to make current. + +## -returns +The new current [MediaPlaybackItem](mediaplaybackitem.md). + +## -remarks +This current item of the [MediaPlaybackList](mediaplaybacklist.md) can't be changed while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_setshuffleditems_502786703.md b/windows.media.playback/mediaplaybacklist_setshuffleditems_502786703.md index 723c14be38..e1292b29c1 100644 --- a/windows.media.playback/mediaplaybacklist_setshuffleditems_502786703.md +++ b/windows.media.playback/mediaplaybacklist_setshuffleditems_502786703.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackList.SetShuffledItems(Windows.Foundation.Collections.IIterable{Windows.Media.Playback.MediaPlaybackItem}) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackList.SetShuffledItems ## -description Sets the list of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode, in the order in which they will be played. ## -parameters ### -param value The list of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode. ## -remarks Use this method to manage the order in which items are played when [ShuffleEnabled](mediaplaybacklist_shuffleenabled.md) is set to true, replacing the shuffle order generated by the system. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackList.SetShuffledItems(Windows.Foundation.Collections.IIterable{Windows.Media.Playback.MediaPlaybackItem}) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackList.SetShuffledItems + +## -description +Sets the list of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode, in the order in which they will be played. + +## -parameters +### -param value +The list of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode. + +## -remarks +Use this method to manage the order in which items are played when [ShuffleEnabled](mediaplaybacklist_shuffleenabled.md) is set to true, replacing the shuffle order generated by the system. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_shuffleditems.md b/windows.media.playback/mediaplaybacklist_shuffleditems.md index 656fb10698..cd9ec23bdf 100644 --- a/windows.media.playback/mediaplaybacklist_shuffleditems.md +++ b/windows.media.playback/mediaplaybacklist_shuffleditems.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.ShuffledItems --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.ShuffledItems ## -description Gets a read-only list of of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode, in the order in which they will be played. ## -property-value A read-only list of of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode ## -remarks Replace the list of pending shuffled items by calling [SetShuffledItems](mediaplaybacklist_setshuffleditems.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.ShuffledItems +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.ShuffledItems + +## -description +Gets a read-only list of of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode, in the order in which they will be played. + +## -property-value +A read-only list of of [MediaPlaybackItem](mediaplaybackitem.md) objects that will be played in shuffle mode + +## -remarks +Replace the list of pending shuffled items by calling [SetShuffledItems](mediaplaybacklist_setshuffleditems.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_shuffleenabled.md b/windows.media.playback/mediaplaybacklist_shuffleenabled.md index 6f1b5f12b1..aaf61a201c 100644 --- a/windows.media.playback/mediaplaybacklist_shuffleenabled.md +++ b/windows.media.playback/mediaplaybacklist_shuffleenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.ShuffleEnabled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.ShuffleEnabled ## -description Gets or sets a value indicating whether the items in the playback list are played in a random order. ## -property-value True if shuffle is enabled; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.ShuffleEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.ShuffleEnabled + +## -description +Gets or sets a value indicating whether the items in the playback list are played in a random order. + +## -property-value +True if shuffle is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacklist_startingitem.md b/windows.media.playback/mediaplaybacklist_startingitem.md index 5d13c494d1..d468d2d436 100644 --- a/windows.media.playback/mediaplaybacklist_startingitem.md +++ b/windows.media.playback/mediaplaybacklist_startingitem.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackList.StartingItem --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackList.StartingItem ## -description Gets or sets the [MediaPlaybackItem](mediaplaybackitem.md) that will be played first. ## -property-value The [MediaPlaybackItem](mediaplaybackitem.md) that will be played first. ## -remarks The [MediaPlaybackItem](mediaplaybackitem.md) specified for this property is played first regardless of whether [ShuffleEnabled](mediaplaybacklist_shuffleenabled.md) is true. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.StartingItem +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.StartingItem + +## -description +Gets or sets the [MediaPlaybackItem](mediaplaybackitem.md) that will be played first. + +## -property-value +The [MediaPlaybackItem](mediaplaybackitem.md) that will be played first. + +## -remarks +The [MediaPlaybackItem](mediaplaybackitem.md) specified for this property is played first regardless of whether [ShuffleEnabled](mediaplaybacklist_shuffleenabled.md) is true. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession.md b/windows.media.playback/mediaplaybacksession.md index 7ba6d9300c..28eed30338 100644 --- a/windows.media.playback/mediaplaybacksession.md +++ b/windows.media.playback/mediaplaybacksession.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackSession --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackSession ## -description Provides information about the state of the current playback session of a [MediaPlayer](mediaplayer.md) and provides events for responding to changes in playback session state. ## -remarks Get an instance of this class by accessing the [PlaybackSession](mediaplayer_playbacksession.md) property of a [MediaPlayer](mediaplayer_mediaplayer.md) or the [PlaybackSession](mediabreakmanager_playbacksession.md) property of a [MediaBreakManager](mediabreakmanager.md). For how-to guidance for working with **MediaPlayer** and playback sessions, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer). ## -examples ## -see-also [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackSession +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackSession + +## -description +Provides information about the state of the current playback session of a [MediaPlayer](mediaplayer.md) and provides events for responding to changes in playback session state. + +## -remarks +Get an instance of this class by accessing the [PlaybackSession](mediaplayer_playbacksession.md) property of a [MediaPlayer](mediaplayer_mediaplayer.md) or the [PlaybackSession](mediabreakmanager_playbacksession.md) property of a [MediaBreakManager](mediabreakmanager.md). + +For how-to guidance for working with **MediaPlayer** and playback sessions, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer). + +## -examples + +## -see-also +[Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybacksession_bufferingended.md b/windows.media.playback/mediaplaybacksession_bufferingended.md index b481a70ecb..bbb3b4e836 100644 --- a/windows.media.playback/mediaplaybacksession_bufferingended.md +++ b/windows.media.playback/mediaplaybacksession_bufferingended.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferingEnded --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.BufferingEnded ## -description Occurs when buffering ends for the [MediaPlaybackSession](mediaplaybacksession.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferingEnded +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.BufferingEnded + +## -description +Occurs when buffering ends for the [MediaPlaybackSession](mediaplaybacksession.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_bufferingprogress.md b/windows.media.playback/mediaplaybacksession_bufferingprogress.md index b6b420d314..c6de1ee631 100644 --- a/windows.media.playback/mediaplaybacksession_bufferingprogress.md +++ b/windows.media.playback/mediaplaybacksession_bufferingprogress.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.BufferingProgress --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.BufferingProgress ## -description Gets a value that indicates the current buffering progress of a [MediaPlaybackSession](mediaplaybacksession.md). ## -property-value The current buffering progress. The value ranges from 0 to 1.0. Multiply by 100 to obtain a percentage. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.BufferingProgress +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.BufferingProgress + +## -description +Gets a value that indicates the current buffering progress of a [MediaPlaybackSession](mediaplaybacksession.md). + +## -property-value +The current buffering progress. The value ranges from 0 to 1.0. Multiply by 100 to obtain a percentage. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_bufferingprogresschanged.md b/windows.media.playback/mediaplaybacksession_bufferingprogresschanged.md index 081279cefb..1dc323f1e1 100644 --- a/windows.media.playback/mediaplaybacksession_bufferingprogresschanged.md +++ b/windows.media.playback/mediaplaybacksession_bufferingprogresschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferingProgressChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.BufferingProgressChanged ## -description Occurs when the buffering progress for the [MediaPlaybackSession](mediaplaybacksession.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferingProgressChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.BufferingProgressChanged + +## -description +Occurs when the buffering progress for the [MediaPlaybackSession](mediaplaybacksession.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_bufferingstarted.md b/windows.media.playback/mediaplaybacksession_bufferingstarted.md index ae6412b85a..6f15b56d03 100644 --- a/windows.media.playback/mediaplaybacksession_bufferingstarted.md +++ b/windows.media.playback/mediaplaybacksession_bufferingstarted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferingStarted --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.BufferingStarted ## -description Occurs when buffering starts for the [MediaPlaybackSession](mediaplaybacksession.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferingStarted +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.BufferingStarted + +## -description +Occurs when buffering starts for the [MediaPlaybackSession](mediaplaybacksession.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_canpause.md b/windows.media.playback/mediaplaybacksession_canpause.md index c7c0863638..baf7e71027 100644 --- a/windows.media.playback/mediaplaybacksession_canpause.md +++ b/windows.media.playback/mediaplaybacksession_canpause.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.CanPause --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.CanPause ## -description Gets a value that indicates whether media can be paused if the [MediaPlayer.Pause](mediaplayer_pause.md) method is called. ## -property-value True if the media can be paused; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.CanPause +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.CanPause + +## -description +Gets a value that indicates whether media can be paused if the [MediaPlayer.Pause](mediaplayer_pause.md) method is called. + +## -property-value +True if the media can be paused; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_canseek.md b/windows.media.playback/mediaplaybacksession_canseek.md index 3ea9e58f32..5faa84d107 100644 --- a/windows.media.playback/mediaplaybacksession_canseek.md +++ b/windows.media.playback/mediaplaybacksession_canseek.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.CanSeek --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.CanSeek ## -description Gets a value that indicates whether the current playback position of the media can be changed by setting the value of the [MediaPlayer.Position](mediaplayer_position.md) property. ## -property-value True if the current playback position of the media can be changed; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.CanSeek +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.CanSeek + +## -description +Gets a value that indicates whether the current playback position of the media can be changed by setting the value of the [MediaPlayer.Position](mediaplayer_position.md) property. + +## -property-value +True if the current playback position of the media can be changed; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_downloadprogress.md b/windows.media.playback/mediaplaybacksession_downloadprogress.md index 167ccec9ab..b7d90997ef 100644 --- a/windows.media.playback/mediaplaybacksession_downloadprogress.md +++ b/windows.media.playback/mediaplaybacksession_downloadprogress.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.DownloadProgress --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.DownloadProgress ## -description Gets a value indicating the position after the current playback [Position](mediaplaybacksession_position.md) to which downloading has completed and content is buffered. ## -property-value A value indicating the position after the current playback [Position](mediaplaybacksession_position.md) to which downloading has completed and content is buffered. The value ranges from 0 to 1. Multiply by 100 to obtain a percentage. ## -remarks This value is expressed as a value between 0 and 1 where 0 is the beginning of the content and 1 is the entire duration of the content. Your app can assume that content is currently buffered between the current playback position and the position provided by this property. Content before the current playback position may or may not be buffered currently. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.DownloadProgress +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.DownloadProgress + +## -description +Gets a value indicating the position after the current playback [Position](mediaplaybacksession_position.md) to which downloading has completed and content is buffered. + +## -property-value +A value indicating the position after the current playback [Position](mediaplaybacksession_position.md) to which downloading has completed and content is buffered. The value ranges from 0 to 1. Multiply by 100 to obtain a percentage. + +## -remarks +This value is expressed as a value between 0 and 1 where 0 is the beginning of the content and 1 is the entire duration of the content. Your app can assume that content is currently buffered between the current playback position and the position provided by this property. Content before the current playback position may or may not be buffered currently. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_downloadprogresschanged.md b/windows.media.playback/mediaplaybacksession_downloadprogresschanged.md index 841e38f2ac..4f1daa32ca 100644 --- a/windows.media.playback/mediaplaybacksession_downloadprogresschanged.md +++ b/windows.media.playback/mediaplaybacksession_downloadprogresschanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.DownloadProgressChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.DownloadProgressChanged ## -description Occurs when the download progress for a [MediaPlaybackSession](mediaplaybacksession.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.DownloadProgressChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.DownloadProgressChanged + +## -description +Occurs when the download progress for a [MediaPlaybackSession](mediaplaybacksession.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_isprotected.md b/windows.media.playback/mediaplaybacksession_isprotected.md index 38b83f89d3..ea0a946efd 100644 --- a/windows.media.playback/mediaplaybacksession_isprotected.md +++ b/windows.media.playback/mediaplaybacksession_isprotected.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.IsProtected --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.IsProtected ## -description Gets a value that indicates whether the media that is currently playing in the [MediaPlaybackSession](mediaplaybacksession.md) is protected by digital rights management (DRM). ## -property-value True if the currently playing media is protected by DRM; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.IsProtected +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.IsProtected + +## -description +Gets a value that indicates whether the media that is currently playing in the [MediaPlaybackSession](mediaplaybacksession.md) is protected by digital rights management (DRM). + +## -property-value +True if the currently playing media is protected by DRM; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_mediaplayer.md b/windows.media.playback/mediaplaybacksession_mediaplayer.md index 53ac704a51..2afa20aeae 100644 --- a/windows.media.playback/mediaplaybacksession_mediaplayer.md +++ b/windows.media.playback/mediaplaybacksession_mediaplayer.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.MediaPlayer --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.MediaPlayer ## -description Gets the [MediaPlayer](mediaplayer.md) associated with the [MediaPlaybackSession](mediaplaybacksession.md). ## -property-value The [MediaPlayer](mediaplayer.md) associated with the [MediaPlaybackSession](mediaplaybacksession.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.MediaPlayer +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.MediaPlayer + +## -description +Gets the [MediaPlayer](mediaplayer.md) associated with the [MediaPlaybackSession](mediaplaybacksession.md). + +## -property-value +The [MediaPlayer](mediaplayer.md) associated with the [MediaPlaybackSession](mediaplaybacksession.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_naturalduration.md b/windows.media.playback/mediaplaybacksession_naturalduration.md index ff08c8833c..f8e5e4609e 100644 --- a/windows.media.playback/mediaplaybacksession_naturalduration.md +++ b/windows.media.playback/mediaplaybacksession_naturalduration.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.NaturalDuration --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.NaturalDuration ## -description Gets a value indicating the duration of the currently playing media, when being played back at normal speed. ## -property-value The duration of the currently playing media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.NaturalDuration +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.NaturalDuration + +## -description +Gets a value indicating the duration of the currently playing media, when being played back at normal speed. + +## -property-value +The duration of the currently playing media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_naturaldurationchanged.md b/windows.media.playback/mediaplaybacksession_naturaldurationchanged.md index 06e77a4f07..48f1c830e1 100644 --- a/windows.media.playback/mediaplaybacksession_naturaldurationchanged.md +++ b/windows.media.playback/mediaplaybacksession_naturaldurationchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.NaturalDurationChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.NaturalDurationChanged ## -description Occurs when the duration of the currently playing media item changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.NaturalDurationChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.NaturalDurationChanged + +## -description +Occurs when the duration of the currently playing media item changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_naturalvideoheight.md b/windows.media.playback/mediaplaybacksession_naturalvideoheight.md index dd0f55430f..4e2318059a 100644 --- a/windows.media.playback/mediaplaybacksession_naturalvideoheight.md +++ b/windows.media.playback/mediaplaybacksession_naturalvideoheight.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.NaturalVideoHeight --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.NaturalVideoHeight ## -description Gets the height of the video in the currently playing media item. ## -property-value The height of the video in the currently playing media item, in pixels. ## -remarks If the currently playing media item is audio-only, the value of this property is 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.NaturalVideoHeight +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.NaturalVideoHeight + +## -description +Gets the height of the video in the currently playing media item. + +## -property-value +The height of the video in the currently playing media item, in pixels. + +## -remarks +If the currently playing media item is audio-only, the value of this property is 0. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_naturalvideosizechanged.md b/windows.media.playback/mediaplaybacksession_naturalvideosizechanged.md index 5548cd9efa..0c8c74718c 100644 --- a/windows.media.playback/mediaplaybacksession_naturalvideosizechanged.md +++ b/windows.media.playback/mediaplaybacksession_naturalvideosizechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.NaturalVideoSizeChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.NaturalVideoSizeChanged ## -description Occurs when the size of the video in the currently playing media item changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.NaturalVideoSizeChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.NaturalVideoSizeChanged + +## -description +Occurs when the size of the video in the currently playing media item changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_naturalvideowidth.md b/windows.media.playback/mediaplaybacksession_naturalvideowidth.md index f384153a37..564d6cb37e 100644 --- a/windows.media.playback/mediaplaybacksession_naturalvideowidth.md +++ b/windows.media.playback/mediaplaybacksession_naturalvideowidth.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.NaturalVideoWidth --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.NaturalVideoWidth ## -description Gets the width of the video in the currently playing media item. ## -property-value The width of the video in the currently playing media item, in pixels. ## -remarks If the currently playing media item is audio-only, the value of this property is 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.NaturalVideoWidth +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.NaturalVideoWidth + +## -description +Gets the width of the video in the currently playing media item. + +## -property-value +The width of the video in the currently playing media item, in pixels. + +## -remarks +If the currently playing media item is audio-only, the value of this property is 0. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_normalizedsourcerect.md b/windows.media.playback/mediaplaybacksession_normalizedsourcerect.md index b73ef05a52..6b4e7f8df0 100644 --- a/windows.media.playback/mediaplaybacksession_normalizedsourcerect.md +++ b/windows.media.playback/mediaplaybacksession_normalizedsourcerect.md @@ -1,3 +1,29 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.NormalizedSourceRect --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.NormalizedSourceRect ## -description Gets or sets a normalized rectangle within the video source which is rendered by the [MediaPlayer](mediaplayer.md). This enables pan and zoom within video. ## -property-value A normalized rectangle specifying the rectangle within the source video that is rendered by the [MediaPlayer](mediaplayer.md). ## -remarks The **x** and **y** fields of the supplied [Rect](../windows.foundation/rect.md) express the top and left coordinates of the source rectangle. The values for **x** and **y** must be non-negative and less than 1.0. To get a normalized top, left coordinate from pixel values, divide the desired **x** value, in pixels, by the value of the [NaturalVideoWidth](mediaplaybacksession_naturalvideowidth.md) property, and multiply the desired **y** value, in pixels, by the value of the [NaturalVideoHeight](mediaplaybacksession_naturalvideoheight.md) property. The **width** and **height** fields of the supplied [Rect](../windows.foundation/rect.md) must be non-negative. To get normalized width and height values, divide the desired width, in pixels, by the value of the [NaturalVideoWidth](mediaplaybacksession_naturalvideowidth.md) property, and multiply the desired height value, in pixels, by the value of the [NaturalVideoHeight](mediaplaybacksession_naturalvideoheight.md) property. The sum of the **x** value and the **width** value must be less than 1+10-4. The sum of the **y** value and the **height** value must be less than 1+10-4. The default value for this property is (0,0,1,1) which selects the entire source rectangle to be rendered. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.NormalizedSourceRect +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.NormalizedSourceRect + +## -description +Gets or sets a normalized rectangle within the video source which is rendered by the [MediaPlayer](mediaplayer.md). This enables pan and zoom within video. + +## -property-value +A normalized rectangle specifying the rectangle within the source video that is rendered by the [MediaPlayer](mediaplayer.md). + +## -remarks +The **x** and **y** fields of the supplied [Rect](../windows.foundation/rect.md) express the top and left coordinates of the source rectangle. The values for **x** and **y** must be non-negative and less than 1.0. To get a normalized top, left coordinate from pixel values, divide the desired **x** value, in pixels, by the value of the [NaturalVideoWidth](mediaplaybacksession_naturalvideowidth.md) property, and multiply the desired **y** value, in pixels, by the value of the [NaturalVideoHeight](mediaplaybacksession_naturalvideoheight.md) property. + +The **width** and **height** fields of the supplied [Rect](../windows.foundation/rect.md) must be non-negative. To get normalized width and height values, divide the desired width, in pixels, by the value of the [NaturalVideoWidth](mediaplaybacksession_naturalvideowidth.md) property, and multiply the desired height value, in pixels, by the value of the [NaturalVideoHeight](mediaplaybacksession_naturalvideoheight.md) property. + +The sum of the **x** value and the **width** value must be less than 1+10-4. The sum of the **y** value and the **height** value must be less than 1+10-4. + +The default value for this property is (0,0,1,1) which selects the entire source rectangle to be rendered. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_playbackrate.md b/windows.media.playback/mediaplaybacksession_playbackrate.md index 85ec53de63..c20bbba802 100644 --- a/windows.media.playback/mediaplaybacksession_playbackrate.md +++ b/windows.media.playback/mediaplaybacksession_playbackrate.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.PlaybackRate --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.PlaybackRate ## -description Gets or sets a value representing the current playback rate for the [MediaPlaybackSession](mediaplaybacksession.md). ## -property-value The current playback rate for the [MediaPlaybackSession](mediaplaybacksession.md). ## -remarks This value is expressed as a percentage. For example, a value of 1.5 sets the playback rate to 150% of the original. The playback rate can't be set to a value greater than 1.0 while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.PlaybackRate +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.PlaybackRate + +## -description +Gets or sets a value representing the current playback rate for the [MediaPlaybackSession](mediaplaybacksession.md). + +## -property-value +The current playback rate for the [MediaPlaybackSession](mediaplaybacksession.md). + +## -remarks +This value is expressed as a percentage. For example, a value of 1.5 sets the playback rate to 150% of the original. + +The playback rate can't be set to a value greater than 1.0 while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_playbackratechanged.md b/windows.media.playback/mediaplaybacksession_playbackratechanged.md index 6997a908fe..0d56ed1a6b 100644 --- a/windows.media.playback/mediaplaybacksession_playbackratechanged.md +++ b/windows.media.playback/mediaplaybacksession_playbackratechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.PlaybackRateChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.PlaybackRateChanged ## -description Occurs when the current playback rate for the [MediaPlaybackSession](mediaplaybacksession.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.PlaybackRateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.PlaybackRateChanged + +## -description +Occurs when the current playback rate for the [MediaPlaybackSession](mediaplaybacksession.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_playbackstate.md b/windows.media.playback/mediaplaybacksession_playbackstate.md index 5cba760ece..2a347d497d 100644 --- a/windows.media.playback/mediaplaybacksession_playbackstate.md +++ b/windows.media.playback/mediaplaybacksession_playbackstate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.PlaybackState --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.PlaybackState ## -description Gets a value indicating the current playback state of the [MediaPlaybackSession](mediaplaybacksession.md), such as buffering or playing. ## -property-value The current playback state of the [MediaPlaybackSession](mediaplaybacksession.md) ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.PlaybackState +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.PlaybackState + +## -description +Gets a value indicating the current playback state of the [MediaPlaybackSession](mediaplaybacksession.md), such as buffering or playing. + +## -property-value +The current playback state of the [MediaPlaybackSession](mediaplaybacksession.md) + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_playbackstatechanged.md b/windows.media.playback/mediaplaybacksession_playbackstatechanged.md index 555e18fecd..6f5626ff6a 100644 --- a/windows.media.playback/mediaplaybacksession_playbackstatechanged.md +++ b/windows.media.playback/mediaplaybacksession_playbackstatechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.PlaybackStateChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.PlaybackStateChanged ## -description Occurs when the current playback state changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.PlaybackStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.PlaybackStateChanged + +## -description +Occurs when the current playback state changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_position.md b/windows.media.playback/mediaplaybacksession_position.md index 37f25cfaac..d3161faf14 100644 --- a/windows.media.playback/mediaplaybacksession_position.md +++ b/windows.media.playback/mediaplaybacksession_position.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.Position --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.Position ## -description Gets or sets the current playback position within the currently playing media. ## -property-value The current playback position within the currently playing media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.Position +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.Position + +## -description +Gets or sets the current playback position within the currently playing media. + +## -property-value +The current playback position within the currently playing media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_positionchanged.md b/windows.media.playback/mediaplaybacksession_positionchanged.md index 24a5721ca1..b6816052e7 100644 --- a/windows.media.playback/mediaplaybacksession_positionchanged.md +++ b/windows.media.playback/mediaplaybacksession_positionchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.PositionChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.PositionChanged ## -description Occurs when the current playback position within the currently playing media changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.PositionChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.PositionChanged + +## -description +Occurs when the current playback position within the currently playing media changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_seekcompleted.md b/windows.media.playback/mediaplaybacksession_seekcompleted.md index 11e06263f5..bbef98ac6a 100644 --- a/windows.media.playback/mediaplaybacksession_seekcompleted.md +++ b/windows.media.playback/mediaplaybacksession_seekcompleted.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackSession.SeekCompleted --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackSession.SeekCompleted ## -description Occurs when a seek operation for the [MediaPlaybackSession](mediaplaybacksession.md) completes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.SeekCompleted +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.SeekCompleted + +## -description +Occurs when a seek operation for the [MediaPlaybackSession](mediaplaybacksession.md) completes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacksession_stereoscopicvideopackingmode.md b/windows.media.playback/mediaplaybacksession_stereoscopicvideopackingmode.md index de3c924fd1..4c7288c345 100644 --- a/windows.media.playback/mediaplaybacksession_stereoscopicvideopackingmode.md +++ b/windows.media.playback/mediaplaybacksession_stereoscopicvideopackingmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackSession.StereoscopicVideoPackingMode --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackSession.StereoscopicVideoPackingMode ## -description Gets or sets a value specifying the stereoscopic video packing mode for the [MediaPlaybackSession](mediaplaybacksession.md). ## -property-value The stereoscopic video packing mode ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.StereoscopicVideoPackingMode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.StereoscopicVideoPackingMode + +## -description +Gets or sets a value specifying the stereoscopic video packing mode for the [MediaPlaybackSession](mediaplaybacksession.md). + +## -property-value +The stereoscopic video packing mode + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist.md index a4c9cac7a3..5497fd5a7a 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist.md @@ -1,3 +1,23 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList ## -description Represents a read-only list of [TimedMetadataTrack](../windows.media.core/timedmetadatatrack.md) objects. ## -remarks Get an instance of this class by accessing the [TimedMetadataTracks](mediaplaybackitem_timedmetadatatracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [TimedMetadataTracksChanged](mediaplaybackitem_timedmetadatatrackschanged.md) event. For how-to guidance for working with metadata tracks, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [IVectorView(TimedMetadataTrack)](../windows.foundation.collections/ivectorview_1.md), [IIterable(TimedMetadataTrack)](../windows.foundation.collections/iiterable_1.md), [IMediaPlaybackTimedMediaTrackList](imediaplaybacktimedmediatracklist.md), [TimedMetadataTrack](../windows.media.core/timedmetadatatrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList + +## -description +Represents a read-only list of [TimedMetadataTrack](../windows.media.core/timedmetadatatrack.md) objects. + +## -remarks +Get an instance of this class by accessing the [TimedMetadataTracks](mediaplaybackitem_timedmetadatatracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [TimedMetadataTracksChanged](mediaplaybackitem_timedmetadatatrackschanged.md) event. + +For how-to guidance for working with metadata tracks, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[IVectorView(TimedMetadataTrack)](../windows.foundation.collections/ivectorview_1.md), [IIterable(TimedMetadataTrack)](../windows.foundation.collections/iiterable_1.md), [IMediaPlaybackTimedMediaTrackList](imediaplaybacktimedmediatracklist.md), [TimedMetadataTrack](../windows.media.core/timedmetadatatrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_first_1920739956.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_first_1920739956.md index 9d98d9a892..7c6174905d 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_first_1920739956.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.First --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.First ## -description Returns an iterator that iterates over the items in the collection. ## -returns The iterator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.First +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.First + +## -description +Returns an iterator that iterates over the items in the collection. + +## -returns +The iterator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_getat_496709656.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_getat_496709656.md index 401c4bbe20..a9fcbd758c 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_getat_496709656.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetAt ## -description Returns the timed metadata track at the specified index. ## -parameters ### -param index The zero-based index of the timed metadata track. ## -returns The timed metadata track at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetAt + +## -description +Returns the timed metadata track at the specified index. + +## -parameters +### -param index +The zero-based index of the timed metadata track. + +## -returns +The timed metadata track at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_getmany_1945029502.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_getmany_1945029502.md index 8709d54276..ba912ba327 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_getmany_1945029502.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_getmany_1945029502.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetMany(System.UInt32,Windows.Media.Core.TimedMetadataTrack[]) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetMany ## -description Retrieves the timed metadata tracks that start at the specified index in the list. ## -parameters ### -param startIndex The zero-based index of the start of the timed metadata tracks in the list. ### -param items The timed metadata tracks that start at *startIndex* in the list. ## -returns The number of timed metadata tracks retrieved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetMany(System.UInt32,Windows.Media.Core.TimedMetadataTrack[]) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetMany + +## -description +Retrieves the timed metadata tracks that start at the specified index in the list. + +## -parameters +### -param startIndex +The zero-based index of the start of the timed metadata tracks in the list. + +### -param items +The timed metadata tracks that start at *startIndex* in the list. + +## -returns +The number of timed metadata tracks retrieved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_getpresentationmode_1408032402.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_getpresentationmode_1408032402.md index eb59d2bc21..31c7d5c0a3 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_getpresentationmode_1408032402.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_getpresentationmode_1408032402.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetPresentationMode(System.UInt32) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetPresentationMode ## -description Gets the presentation mode of the timed metadata track with the specified index. ## -parameters ### -param index The index of the timed metadata track for which the presentation mode is queried. ## -returns The presentation mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetPresentationMode(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.GetPresentationMode + +## -description +Gets the presentation mode of the timed metadata track with the specified index. + +## -parameters +### -param index +The index of the timed metadata track for which the presentation mode is queried. + +## -returns +The presentation mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_indexof_875488717.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_indexof_875488717.md index 4ff62f43b1..d121ccb68b 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_indexof_875488717.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_indexof_875488717.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.IndexOf(Windows.Media.Core.TimedMetadataTrack,System.UInt32@) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.IndexOf ## -description Retrieves the index of a specified timed metadata track in the list. ## -parameters ### -param value The timed metadata track to find in the vector view. ### -param index If the timed metadata track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. ## -returns True if the timed metadata track is found; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.IndexOf(Windows.Media.Core.TimedMetadataTrack,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.IndexOf + +## -description +Retrieves the index of a specified timed metadata track in the list. + +## -parameters +### -param value +The timed metadata track to find in the vector view. + +### -param index +If the timed metadata track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. + +## -returns +True if the timed metadata track is found; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_presentationmodechanged.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_presentationmodechanged.md index 08d32dbe80..10b19c458e 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_presentationmodechanged.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_presentationmodechanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.PresentationModeChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.PresentationModeChanged ## -description Occurs when the presentation mode of the [MediaPlaybackTimedMetadataTrackList](mediaplaybacktimedmetadatatracklist.md) changes. ## -remarks Change the presentation mode by calling [SetPresentationMode](mediaplaybacktimedmetadatatracklist_setpresentationmode.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.PresentationModeChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.PresentationModeChanged + +## -description +Occurs when the presentation mode of the [MediaPlaybackTimedMetadataTrackList](mediaplaybacktimedmetadatatracklist.md) changes. + +## -remarks +Change the presentation mode by calling [SetPresentationMode](mediaplaybacktimedmetadatatracklist_setpresentationmode.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_setpresentationmode_83974782.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_setpresentationmode_83974782.md index 98e60e06c9..6a149bd787 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_setpresentationmode_83974782.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_setpresentationmode_83974782.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.SetPresentationMode(System.UInt32,Windows.Media.Playback.TimedMetadataTrackPresentationMode) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.SetPresentationMode ## -description Sets the presentation mode of the timed metadata track with the specified index. ## -parameters ### -param index The index of the timed metadata track for which the presentation mode is set. ### -param value The presentation mode to set. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.SetPresentationMode(System.UInt32,Windows.Media.Playback.TimedMetadataTrackPresentationMode) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.SetPresentationMode + +## -description +Sets the presentation mode of the timed metadata track with the specified index. + +## -parameters +### -param index +The index of the timed metadata track for which the presentation mode is set. + +### -param value +The presentation mode to set. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybacktimedmetadatatracklist_size.md b/windows.media.playback/mediaplaybacktimedmetadatatracklist_size.md index b2af4fe463..6211e44916 100644 --- a/windows.media.playback/mediaplaybacktimedmetadatatracklist_size.md +++ b/windows.media.playback/mediaplaybacktimedmetadatatracklist_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.Size --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.Size ## -description Gets the number of timed metadata tracks in the list. ## -property-value the number of timed metadata tracks in the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.Size +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackTimedMetadataTrackList.Size + +## -description +Gets the number of timed metadata tracks in the list. + +## -property-value +the number of timed metadata tracks in the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist.md b/windows.media.playback/mediaplaybackvideotracklist.md index db99c560a2..16ed8afe5b 100644 --- a/windows.media.playback/mediaplaybackvideotracklist.md +++ b/windows.media.playback/mediaplaybackvideotracklist.md @@ -1,3 +1,27 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlaybackVideoTrackList --api-type: winrt class ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList ## -description Represents a read-only list of [VideoTrack](../windows.media.core/videotrack.md) objects, of which a single track can be selected at one time. ## -remarks Get an instance of this class by accessing the [VideoTracks](mediaplaybackitem_videotracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [VideoTracksChanged](mediaplaybackitem_videotrackschanged.md) event. This class provides access to the list of [VideoTrack](../windows.media.core/videotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemResolved](mediaplaybacklist_itemresolved.md) event is raised, you can select one of the video tracks in the track list for playback. Note that this class does not represent a playlist of video tracks that are played sequentially. To play a sequential list of tracks, use [MediaPlaybackList](mediaplaybacklist.md). For how-to guidance for working with the video tracks of a media item, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -examples ## -see-also [IVectorView(VideoTrack)](../windows.foundation.collections/ivectorview_1.md), [IIterable(VideoTrack)](../windows.foundation.collections/iiterable_1.md), [ISingleSelectMediaTrackList](../windows.media.core/isingleselectmediatracklist.md), [VideoTrack](../windows.media.core/videotrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackVideoTrackList +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList + +## -description +Represents a read-only list of [VideoTrack](../windows.media.core/videotrack.md) objects, of which a single track can be selected at one time. + +## -remarks +Get an instance of this class by accessing the [VideoTracks](mediaplaybackitem_videotracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [VideoTracksChanged](mediaplaybackitem_videotrackschanged.md) event. + +This class provides access to the list of [VideoTrack](../windows.media.core/videotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemResolved](mediaplaybacklist_itemresolved.md) event is raised, you can select one of the video tracks in the track list for playback. + +Note that this class does not represent a playlist of video tracks that are played sequentially. To play a sequential list of tracks, use [MediaPlaybackList](mediaplaybacklist.md). + +For how-to guidance for working with the video tracks of a media item, see [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -examples + +## -see-also +[IVectorView(VideoTrack)](../windows.foundation.collections/ivectorview_1.md), [IIterable(VideoTrack)](../windows.foundation.collections/iiterable_1.md), [ISingleSelectMediaTrackList](../windows.media.core/isingleselectmediatracklist.md), [VideoTrack](../windows.media.core/videotrack.md), [Media items, playlists, and tracks](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/media-playback-with-mediasource) \ No newline at end of file diff --git a/windows.media.playback/mediaplaybackvideotracklist_first_1920739956.md b/windows.media.playback/mediaplaybackvideotracklist_first_1920739956.md index 775a71cd50..780433c1a9 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_first_1920739956.md +++ b/windows.media.playback/mediaplaybackvideotracklist_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.First --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.First ## -description Returns an iterator that iterates over the items in the collection. ## -returns The iterator. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.First +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.First + +## -description +Returns an iterator that iterates over the items in the collection. + +## -returns +The iterator. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist_getat_496709656.md b/windows.media.playback/mediaplaybackvideotracklist_getat_496709656.md index a6e04da9fb..abfb8f07a8 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_getat_496709656.md +++ b/windows.media.playback/mediaplaybackvideotracklist_getat_496709656.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.GetAt(System.UInt32) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.GetAt ## -description Returns the video track at the specified index. ## -parameters ### -param index The zero-based index of the video track. ## -returns The video track at the specified index. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.GetAt + +## -description +Returns the video track at the specified index. + +## -parameters +### -param index +The zero-based index of the video track. + +## -returns +The video track at the specified index. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist_getmany_1044970574.md b/windows.media.playback/mediaplaybackvideotracklist_getmany_1044970574.md index 86d8531e97..f87c30b173 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_getmany_1044970574.md +++ b/windows.media.playback/mediaplaybackvideotracklist_getmany_1044970574.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.GetMany(System.UInt32,Windows.Media.Core.VideoTrack[]) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.GetMany ## -description Retrieves the video tracks that start at the specified index in the list. ## -parameters ### -param startIndex The zero-based index of the start of the video tracks in the list. ### -param items The video tracks that start at *startIndex* in the list. ## -returns The number of video tracks retrieved. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.GetMany(System.UInt32,Windows.Media.Core.VideoTrack[]) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.GetMany + +## -description +Retrieves the video tracks that start at the specified index in the list. + +## -parameters +### -param startIndex +The zero-based index of the start of the video tracks in the list. + +### -param items +The video tracks that start at *startIndex* in the list. + +## -returns +The number of video tracks retrieved. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist_indexof_723792218.md b/windows.media.playback/mediaplaybackvideotracklist_indexof_723792218.md index f1600e4878..1ae57b1e20 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_indexof_723792218.md +++ b/windows.media.playback/mediaplaybackvideotracklist_indexof_723792218.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.IndexOf(Windows.Media.Core.VideoTrack,System.UInt32@) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.IndexOf ## -description Retrieves the index of a specified video track in the list. ## -parameters ### -param value The video track to find in the vector view. ### -param index If the video track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. ## -returns True if the video track is found; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackVideoTrackList.IndexOf(Windows.Media.Core.VideoTrack,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.IndexOf + +## -description +Retrieves the index of a specified video track in the list. + +## -parameters +### -param value +The video track to find in the vector view. + +### -param index +If the video track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. + +## -returns +True if the video track is found; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist_selectedindex.md b/windows.media.playback/mediaplaybackvideotracklist_selectedindex.md index bc34e9840c..ee2e2ae35a 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_selectedindex.md +++ b/windows.media.playback/mediaplaybackvideotracklist_selectedindex.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndex --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndex ## -description Gets or sets the index of the currently selected video track in the list. ## -property-value The index of the currently selected video track in the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndex +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndex + +## -description +Gets or sets the index of the currently selected video track in the list. + +## -property-value +The index of the currently selected video track in the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist_selectedindexchanged.md b/windows.media.playback/mediaplaybackvideotracklist_selectedindexchanged.md index 893908a2d9..be021053ba 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_selectedindexchanged.md +++ b/windows.media.playback/mediaplaybackvideotracklist_selectedindexchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndexChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndexChanged ## -description Occurs when the index of the currently selected video track changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndexChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.SelectedIndexChanged + +## -description +Occurs when the index of the currently selected video track changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplaybackvideotracklist_size.md b/windows.media.playback/mediaplaybackvideotracklist_size.md index cd9107e536..8c156e02c4 100644 --- a/windows.media.playback/mediaplaybackvideotracklist_size.md +++ b/windows.media.playback/mediaplaybackvideotracklist_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlaybackVideoTrackList.Size --api-type: winrt property ---- # Windows.Media.Playback.MediaPlaybackVideoTrackList.Size ## -description Gets the number of video tracks in the list. ## -property-value The number of video tracks in the list. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackVideoTrackList.Size +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackVideoTrackList.Size + +## -description +Gets the number of video tracks in the list. + +## -property-value +The number of video tracks in the list. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer.md b/windows.media.playback/mediaplayer.md index d91ce55203..b7ace649cb 100644 --- a/windows.media.playback/mediaplayer.md +++ b/windows.media.playback/mediaplayer.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlayer --api-type: winrt class ---- # Windows.Media.Playback.MediaPlayer ## -description Provides access to media playback functionality such as play, pause, fast-forward, rewind, and volume. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlayer +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlayer + +## -description +Provides access to media playback functionality such as play, pause, fast-forward, rewind, and volume. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_addaudioeffect_1019588069.md b/windows.media.playback/mediaplayer_addaudioeffect_1019588069.md index ff3202bd07..f4f0ef3521 100644 --- a/windows.media.playback/mediaplayer_addaudioeffect_1019588069.md +++ b/windows.media.playback/mediaplayer_addaudioeffect_1019588069.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.AddAudioEffect(System.String,System.Boolean,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.AddAudioEffect ## -description Adds an audio effect to the playback stream of the [MediaPlayer](mediaplayer.md). ## -parameters ### -param activatableClassId The activatable class ID of the audio effect to add to the playback stream. ### -param effectOptional A value indicating whether the effect is optional. ### -param configuration A property set containing configuration settings for the specified audio effect. ## -remarks To remove audio effects from the playback stream, call [RemoveAllEffects](mediaplayer_removealleffects.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.AddAudioEffect(System.String,System.Boolean,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.AddAudioEffect + +## -description +Adds an audio effect to the playback stream of the [MediaPlayer](mediaplayer.md). + +## -parameters +### -param activatableClassId +The activatable class ID of the audio effect to add to the playback stream. + +### -param effectOptional +A value indicating whether the effect is optional. + +### -param configuration +A property set containing configuration settings for the specified audio effect. + +## -remarks +To remove audio effects from the playback stream, call [RemoveAllEffects](mediaplayer_removealleffects.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_addvideoeffect_205953283.md b/windows.media.playback/mediaplayer_addvideoeffect_205953283.md index 527d1da18c..8cb8adf810 100644 --- a/windows.media.playback/mediaplayer_addvideoeffect_205953283.md +++ b/windows.media.playback/mediaplayer_addvideoeffect_205953283.md @@ -1,3 +1,29 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.AddVideoEffect(System.String,System.Boolean,Windows.Foundation.Collections.IPropertySet) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.AddVideoEffect ## -description Applies a video effect to media playback. ## -parameters ### -param activatableClassId The identifier of the effect. ### -param effectOptional Tue if the effect shouldn't block playback when the effect can't be used at run time. False if the effect should block playback when the effect can't be used at run time. ### -param effectConfiguration A property set that transmits property values to the effect specified by *effectID*. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.AddVideoEffect(System.String,System.Boolean,Windows.Foundation.Collections.IPropertySet) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.AddVideoEffect + +## -description +Applies a video effect to media playback. + +## -parameters +### -param activatableClassId +The identifier of the effect. + +### -param effectOptional +Tue if the effect shouldn't block playback when the effect can't be used at run time. False if the effect should block playback when the effect can't be used at run time. + +### -param effectConfiguration +A property set that transmits property values to the effect specified by *effectID*. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_audiobalance.md b/windows.media.playback/mediaplayer_audiobalance.md index 03c6fc7bf5..c510b88169 100644 --- a/windows.media.playback/mediaplayer_audiobalance.md +++ b/windows.media.playback/mediaplayer_audiobalance.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.AudioBalance --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.AudioBalance ## -description Gets or sets a ratio of volume across stereo speakers. ## -property-value The ratio of volume across speakers in the range between -1 and 1. The default value is 0. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.AudioBalance +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.AudioBalance + +## -description +Gets or sets a ratio of volume across stereo speakers. + +## -property-value +The ratio of volume across speakers in the range between -1 and 1. The default value is 0. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_audiocategory.md b/windows.media.playback/mediaplayer_audiocategory.md index 16e6b861ac..c8c24d51a8 100644 --- a/windows.media.playback/mediaplayer_audiocategory.md +++ b/windows.media.playback/mediaplayer_audiocategory.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.AudioCategory --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.AudioCategory ## -description Gets or sets the type of audio that is currently being played. ## -property-value The type of audio that is currently being played. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.AudioCategory +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.AudioCategory + +## -description +Gets or sets the type of audio that is currently being played. + +## -property-value +The type of audio that is currently being played. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_audiodevice.md b/windows.media.playback/mediaplayer_audiodevice.md index 345bea0671..32a9e697ca 100644 --- a/windows.media.playback/mediaplayer_audiodevice.md +++ b/windows.media.playback/mediaplayer_audiodevice.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.AudioDevice --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.AudioDevice ## -description Gets or sets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing audio device used by the [MediaPlayer](mediaplayer.md) to render audio. ## -property-value The [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing audio device used by the [MediaPlayer](mediaplayer.md) to render audio. ## -remarks To enumerate the currently available audio devices, call [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), passing in the device selector string returned from [MediaDevice.GetAudioRenderSelector](../windows.media.devices/mediadevice_getaudiorenderselector.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.AudioDevice +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.AudioDevice + +## -description +Gets or sets the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing audio device used by the [MediaPlayer](mediaplayer.md) to render audio. + +## -property-value +The [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object representing audio device used by the [MediaPlayer](mediaplayer.md) to render audio. + +## -remarks +To enumerate the currently available audio devices, call [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md), passing in the device selector string returned from [MediaDevice.GetAudioRenderSelector](../windows.media.devices/mediadevice_getaudiorenderselector.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_audiodevicetype.md b/windows.media.playback/mediaplayer_audiodevicetype.md index b7b6b57b74..eed5478a87 100644 --- a/windows.media.playback/mediaplayer_audiodevicetype.md +++ b/windows.media.playback/mediaplayer_audiodevicetype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.AudioDeviceType --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.AudioDeviceType ## -description Gets or sets a value that describes the primary usage of the device that is being used to play back audio. ## -property-value The audio device type. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.AudioDeviceType +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.AudioDeviceType + +## -description +Gets or sets a value that describes the primary usage of the device that is being used to play back audio. + +## -property-value +The audio device type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_autoplay.md b/windows.media.playback/mediaplayer_autoplay.md index d46116f40f..99ed2b764a 100644 --- a/windows.media.playback/mediaplayer_autoplay.md +++ b/windows.media.playback/mediaplayer_autoplay.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.AutoPlay --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.AutoPlay ## -description Gets or sets a Boolean value indicating if playback automatically starts after the media is loaded. ## -property-value True is playback start automatically, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.AutoPlay +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.AutoPlay + +## -description +Gets or sets a Boolean value indicating if playback automatically starts after the media is loaded. + +## -property-value +True is playback start automatically, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_breakmanager.md b/windows.media.playback/mediaplayer_breakmanager.md index 2ad5e5f5fe..c98318f01b 100644 --- a/windows.media.playback/mediaplayer_breakmanager.md +++ b/windows.media.playback/mediaplayer_breakmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.BreakManager --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.BreakManager ## -description Gets the [MediaBreakManager](mediabreakmanager.md) associated with the [MediaPlayer](mediaplayer.md), which provides information about and control over media breaks for the player. ## -property-value The [MediaBreakManager](mediabreakmanager.md) associated with the [MediaPlayer](mediaplayer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.BreakManager +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.BreakManager + +## -description +Gets the [MediaBreakManager](mediabreakmanager.md) associated with the [MediaPlayer](mediaplayer.md), which provides information about and control over media breaks for the player. + +## -property-value +The [MediaBreakManager](mediabreakmanager.md) associated with the [MediaPlayer](mediaplayer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_bufferingended.md b/windows.media.playback/mediaplayer_bufferingended.md index a8d0c0302f..2b1b293ac3 100644 --- a/windows.media.playback/mediaplayer_bufferingended.md +++ b/windows.media.playback/mediaplayer_bufferingended.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.BufferingEnded --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.BufferingEnded ## -description Occurs when buffering has finished. > [!NOTE] > **MediaPlayer.BufferingEnded** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.BufferingEnded](mediaplaybacksession_bufferingended.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.BufferingEnded +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.BufferingEnded + +## -description +Occurs when buffering has finished. + +> [!NOTE] +> **MediaPlayer.BufferingEnded** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.BufferingEnded](mediaplaybacksession_bufferingended.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_bufferingprogress.md b/windows.media.playback/mediaplayer_bufferingprogress.md index c1dffb0f65..60dc0ad6f8 100644 --- a/windows.media.playback/mediaplayer_bufferingprogress.md +++ b/windows.media.playback/mediaplayer_bufferingprogress.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.BufferingProgress --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.BufferingProgress ## -description Gets the amount of buffering that is completed for the media content, expressed as a percentage. > [!NOTE] > **MediaPlayer.BufferingProgress** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.BufferingProgress](mediaplaybacksession_bufferingprogress.md) property. ## -property-value The amount of buffering that is completed for the media content. ## -remarks The value ranges from 0 to 1. Multiply by 100 to obtain a percentage. The default value is 0. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.BufferingProgress +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.BufferingProgress + +## -description +Gets the amount of buffering that is completed for the media content, expressed as a percentage. + +> [!NOTE] +> **MediaPlayer.BufferingProgress** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.BufferingProgress](mediaplaybacksession_bufferingprogress.md) property. + +## -property-value +The amount of buffering that is completed for the media content. + +## -remarks +The value ranges from 0 to 1. Multiply by 100 to obtain a percentage. The default value is 0. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_bufferingstarted.md b/windows.media.playback/mediaplayer_bufferingstarted.md index 1aefa97ed2..3698e91fe4 100644 --- a/windows.media.playback/mediaplayer_bufferingstarted.md +++ b/windows.media.playback/mediaplayer_bufferingstarted.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.BufferingStarted --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.BufferingStarted ## -description Occurs when buffering has started. > [!NOTE] > **MediaPlayer.BufferingStarted** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.BufferingStarted](mediaplaybacksession_bufferingstarted.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.BufferingStarted +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.BufferingStarted + +## -description +Occurs when buffering has started. + +> [!NOTE] +> **MediaPlayer.BufferingStarted** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.BufferingStarted](mediaplaybacksession_bufferingstarted.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_canpause.md b/windows.media.playback/mediaplayer_canpause.md index 78832b714d..4f860aebda 100644 --- a/windows.media.playback/mediaplayer_canpause.md +++ b/windows.media.playback/mediaplayer_canpause.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.CanPause --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.CanPause ## -description Gets a Boolean value indicating if the media can be paused. > [!NOTE] > **MediaPlayer.CanPause** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.CanPause](mediaplaybacksession_canpause.md) property. ## -property-value True if the media can be paused, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.CanPause +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.CanPause + +## -description +Gets a Boolean value indicating if the media can be paused. + +> [!NOTE] +> **MediaPlayer.CanPause** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.CanPause](mediaplaybacksession_canpause.md) property. + +## -property-value +True if the media can be paused, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_canseek.md b/windows.media.playback/mediaplayer_canseek.md index 45fd174cea..fa3e3b4b05 100644 --- a/windows.media.playback/mediaplayer_canseek.md +++ b/windows.media.playback/mediaplayer_canseek.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.CanSeek --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.CanSeek ## -description Gets a Boolean value indicating if the media supports seeking to a specific position. > [!NOTE] > **MediaPlayer.CanSeek** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.CanSeek](mediaplaybacksession_canseek.md) property. ## -property-value True if the media supports seeking, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.CanSeek +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.CanSeek + +## -description +Gets a Boolean value indicating if the media supports seeking to a specific position. + +> [!NOTE] +> **MediaPlayer.CanSeek** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.CanSeek](mediaplaybacksession_canseek.md) property. + +## -property-value +True if the media supports seeking, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_close_811482585.md b/windows.media.playback/mediaplayer_close_811482585.md index 54ea3adb8e..f6d8040a46 100644 --- a/windows.media.playback/mediaplayer_close_811482585.md +++ b/windows.media.playback/mediaplayer_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.Close --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.Close ## -description Closes the [MediaPlayer](mediaplayer.md) and disposes of associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaPlayer](mediaplayer.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.Close +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.Close + +## -description +Closes the [MediaPlayer](mediaplayer.md) and disposes of associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaPlayer](mediaplayer.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_commandmanager.md b/windows.media.playback/mediaplayer_commandmanager.md index c540e2de01..33dd74a943 100644 --- a/windows.media.playback/mediaplayer_commandmanager.md +++ b/windows.media.playback/mediaplayer_commandmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.CommandManager --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.CommandManager ## -description Gets the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) associated with the [MediaPlayer](mediaplayer.md), which specifies the behavior of and receives events from the System Media Transport Controls. ## -property-value The [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) associated with the [MediaPlayer](mediaplayer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.CommandManager +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.CommandManager + +## -description +Gets the [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) associated with the [MediaPlayer](mediaplayer.md), which specifies the behavior of and receives events from the System Media Transport Controls. + +## -property-value +The [MediaPlaybackCommandManager](mediaplaybackcommandmanager.md) associated with the [MediaPlayer](mediaplayer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_currentstate.md b/windows.media.playback/mediaplayer_currentstate.md index f6c128c350..729ac4ec56 100644 --- a/windows.media.playback/mediaplayer_currentstate.md +++ b/windows.media.playback/mediaplayer_currentstate.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.CurrentState --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.CurrentState ## -description Gets the current state of media playback. > [!NOTE] > **MediaPlayer.CurrentState** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackState](mediaplaybacksession_playbackstate.md) property. ## -property-value The current state of media playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.CurrentState +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.CurrentState + +## -description +Gets the current state of media playback. + +> [!NOTE] +> **MediaPlayer.CurrentState** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackState](mediaplaybacksession_playbackstate.md) property. + +## -property-value +The current state of media playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_currentstatechanged.md b/windows.media.playback/mediaplayer_currentstatechanged.md index ed9c320893..72592f96b4 100644 --- a/windows.media.playback/mediaplayer_currentstatechanged.md +++ b/windows.media.playback/mediaplayer_currentstatechanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.CurrentStateChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.CurrentStateChanged ## -description Occurs when the state of the media player has changed. > [!NOTE] > **MediaPlayer.CurrentStateChanged** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackStateChanged](mediaplaybacksession_playbackstatechanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.CurrentStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.CurrentStateChanged + +## -description +Occurs when the state of the media player has changed. + +> [!NOTE] +> **MediaPlayer.CurrentStateChanged** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackStateChanged](mediaplaybacksession_playbackstatechanged.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_getascastingsource_1958734275.md b/windows.media.playback/mediaplayer_getascastingsource_1958734275.md index 18af7c1962..748f90ac1d 100644 --- a/windows.media.playback/mediaplayer_getascastingsource_1958734275.md +++ b/windows.media.playback/mediaplayer_getascastingsource_1958734275.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.GetAsCastingSource --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.GetAsCastingSource ## -description Gets a [CastingSource](../windows.media.casting/castingsource.md) representing the [MediaPlayer](mediaplayer.md), which allows it's media to be cast to other devices. ## -returns The casting source. ## -remarks For more information on casting media to remote devices, see [Media casting](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-casting). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.GetAsCastingSource +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.GetAsCastingSource + +## -description +Gets a [CastingSource](../windows.media.casting/castingsource.md) representing the [MediaPlayer](mediaplayer.md), which allows it's media to be cast to other devices. + +## -returns +The casting source. + +## -remarks +For more information on casting media to remote devices, see [Media casting](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-casting). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_getsurface_812026623.md b/windows.media.playback/mediaplayer_getsurface_812026623.md index f6e6563c13..aa6095d8aa 100644 --- a/windows.media.playback/mediaplayer_getsurface_812026623.md +++ b/windows.media.playback/mediaplayer_getsurface_812026623.md @@ -1,3 +1,34 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.GetSurface(Windows.UI.Composition.Compositor) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.GetSurface ## -description Gets a [MediaPlayerSurface](mediaplayersurface.md) object for the [MediaPlayer](mediaplayer.md), which allows you to render the player's contents using a [Compositor](mediaplayersurface_compositor.md) without relying on the XAML framework. ## -parameters ### -param compositor The [Compositor](../windows.ui.composition/compositor.md) with which the returned surface will be used. ## -returns The media player surface. ## -remarks By default, the [CompositionSurface](../windows.ui.composition/icompositionsurface.md) generated by this method will have the dimensions 640x 480, in pixels. To get a different size, call [SetSurfaceSize](mediaplayer_setsurfacesize.md) before calling **GetSurface**. You can obtain multiple surfaces from a single [MediaPlayer](mediaplayer.md) instance by calling [MediaPlayer](mediaplayer.md) multiple times. For more information on using the [Windows.UI.Composition](../windows.ui.composition/windows_ui_composition.md) APIs to render visuals, see [Visual layer](https://msdn.microsoft.com/en-us/windows/uwp/graphics/visual-layer). For how-to guidance for rendering video to a composition surface, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface). ## -examples ## -see-also [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.GetSurface(Windows.UI.Composition.Compositor) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.GetSurface + +## -description +Gets a [MediaPlayerSurface](mediaplayersurface.md) object for the [MediaPlayer](mediaplayer.md), which allows you to render the player's contents using a [Compositor](mediaplayersurface_compositor.md) without relying on the XAML framework. + +## -parameters +### -param compositor +The [Compositor](../windows.ui.composition/compositor.md) with which the returned surface will be used. + +## -returns +The media player surface. + +## -remarks +By default, the [CompositionSurface](../windows.ui.composition/icompositionsurface.md) generated by this method will have the dimensions 640x 480, in pixels. To get a different size, call [SetSurfaceSize](mediaplayer_setsurfacesize.md) before calling **GetSurface**. + +You can obtain multiple surfaces from a single [MediaPlayer](mediaplayer.md) instance by calling [MediaPlayer](mediaplayer.md) multiple times. + +For more information on using the [Windows.UI.Composition](../windows.ui.composition/windows_ui_composition.md) APIs to render visuals, see [Visual layer](https://msdn.microsoft.com/en-us/windows/uwp/graphics/visual-layer). + +For how-to guidance for rendering video to a composition surface, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface). + +## -examples + +## -see-also +[Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface) \ No newline at end of file diff --git a/windows.media.playback/mediaplayer_isloopingenabled.md b/windows.media.playback/mediaplayer_isloopingenabled.md index a5ed802026..e7d5c6374e 100644 --- a/windows.media.playback/mediaplayer_isloopingenabled.md +++ b/windows.media.playback/mediaplayer_isloopingenabled.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.IsLoopingEnabled --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.IsLoopingEnabled ## -description Gets or sets a Boolean value indicating if the media will playback in a repeating loop. ## -property-value True is looping is enabled, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.IsLoopingEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.IsLoopingEnabled + +## -description +Gets or sets a Boolean value indicating if the media will playback in a repeating loop. + +## -property-value +True is looping is enabled, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_ismuted.md b/windows.media.playback/mediaplayer_ismuted.md index 73e44bbb3a..d1f6c2fb91 100644 --- a/windows.media.playback/mediaplayer_ismuted.md +++ b/windows.media.playback/mediaplayer_ismuted.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.IsMuted --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.IsMuted ## -description Gets or sets a Boolean value indicating if the audio is muted. ## -property-value True if the audio is muted, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.IsMuted +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.IsMuted + +## -description +Gets or sets a Boolean value indicating if the audio is muted. + +## -property-value +True if the audio is muted, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_ismutedchanged.md b/windows.media.playback/mediaplayer_ismutedchanged.md index 8c9897f26f..b94908fcef 100644 --- a/windows.media.playback/mediaplayer_ismutedchanged.md +++ b/windows.media.playback/mediaplayer_ismutedchanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.IsMutedChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.IsMutedChanged ## -description Occurs when the current muted status of the [MediaPlayer](mediaplayer.md) changes. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.IsMutedChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.IsMutedChanged + +## -description +Occurs when the current muted status of the [MediaPlayer](mediaplayer.md) changes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_isprotected.md b/windows.media.playback/mediaplayer_isprotected.md index 3920ec5789..4c01a7600d 100644 --- a/windows.media.playback/mediaplayer_isprotected.md +++ b/windows.media.playback/mediaplayer_isprotected.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.IsProtected --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.IsProtected ## -description Gets a Boolean value indicating if the content is protected by a digital rights management system. > [!NOTE] > **MediaPlayer.IsProtected** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [IsProtected](mediaplaybacksession_isprotected.md) property. ## -property-value True if the content is protected, otherwise false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.IsProtected +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.IsProtected + +## -description +Gets a Boolean value indicating if the content is protected by a digital rights management system. + +> [!NOTE] +> **MediaPlayer.IsProtected** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [IsProtected](mediaplaybacksession_isprotected.md) property. + +## -property-value +True if the content is protected, otherwise false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_mediaended.md b/windows.media.playback/mediaplayer_mediaended.md index 05ef674859..dabb4140fa 100644 --- a/windows.media.playback/mediaplayer_mediaended.md +++ b/windows.media.playback/mediaplayer_mediaended.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.MediaEnded --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.MediaEnded ## -description Occurs when the media has finished playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.MediaEnded +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.MediaEnded + +## -description +Occurs when the media has finished playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_mediafailed.md b/windows.media.playback/mediaplayer_mediafailed.md index 9903625ae1..a9dee6df23 100644 --- a/windows.media.playback/mediaplayer_mediafailed.md +++ b/windows.media.playback/mediaplayer_mediafailed.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.MediaFailed --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.MediaFailed ## -description Occurs when an error is encountered. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.MediaFailed +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.MediaFailed + +## -description +Occurs when an error is encountered. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_mediaopened.md b/windows.media.playback/mediaplayer_mediaopened.md index 4125a02a13..5d1a40b8cd 100644 --- a/windows.media.playback/mediaplayer_mediaopened.md +++ b/windows.media.playback/mediaplayer_mediaopened.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.MediaOpened --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.MediaOpened ## -description Occurs when the media is opened. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.MediaOpened +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.MediaOpened + +## -description +Occurs when the media is opened. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_mediaplayer_1221375020.md b/windows.media.playback/mediaplayer_mediaplayer_1221375020.md index 46a530d0d1..9f7d1933bc 100644 --- a/windows.media.playback/mediaplayer_mediaplayer_1221375020.md +++ b/windows.media.playback/mediaplayer_mediaplayer_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.#ctor --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.MediaPlayer ## -description Initializes a new instance of the [MediaPlayer](mediaplayer.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.MediaPlayer + +## -description +Initializes a new instance of the [MediaPlayer](mediaplayer.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_mediaplayerratechanged.md b/windows.media.playback/mediaplayer_mediaplayerratechanged.md index 40b3e19fa2..2cd26c2f10 100644 --- a/windows.media.playback/mediaplayer_mediaplayerratechanged.md +++ b/windows.media.playback/mediaplayer_mediaplayerratechanged.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.MediaPlayerRateChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.MediaPlayerRateChanged ## -description Occurs when the media playback rate has changed. > [!NOTE] > **MediaPlayer.MediaPlayerRateChanged** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackRateChanged](mediaplaybacksession_playbackratechanged.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.MediaPlayerRateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.MediaPlayerRateChanged + +## -description +Occurs when the media playback rate has changed. + +> [!NOTE] +> **MediaPlayer.MediaPlayerRateChanged** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackRateChanged](mediaplaybacksession_playbackratechanged.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_naturalduration.md b/windows.media.playback/mediaplayer_naturalduration.md index 46100e23c1..8e20e8b8f0 100644 --- a/windows.media.playback/mediaplayer_naturalduration.md +++ b/windows.media.playback/mediaplayer_naturalduration.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.NaturalDuration --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.NaturalDuration ## -description Get the actual duration of the media without applying the [PlaybackRate](mediaplayer_playbackrate.md). > [!NOTE] > **MediaPlayer.NaturalDuration** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.NaturalDuration](mediaplaybacksession_naturalduration.md) property. ## -property-value The actual duration of the media without applying the [PlaybackRate](mediaplayer_playbackrate.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.NaturalDuration +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.NaturalDuration + +## -description +Get the actual duration of the media without applying the [PlaybackRate](mediaplayer_playbackrate.md). + +> [!NOTE] +> **MediaPlayer.NaturalDuration** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.NaturalDuration](mediaplaybacksession_naturalduration.md) property. + +## -property-value +The actual duration of the media without applying the [PlaybackRate](mediaplayer_playbackrate.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_pause_1953642114.md b/windows.media.playback/mediaplayer_pause_1953642114.md index 153baa8f6a..e9b4416e35 100644 --- a/windows.media.playback/mediaplayer_pause_1953642114.md +++ b/windows.media.playback/mediaplayer_pause_1953642114.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.Pause --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.Pause ## -description Pauses media playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.Pause +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.Pause + +## -description +Pauses media playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_play_848564459.md b/windows.media.playback/mediaplayer_play_848564459.md index c4b65320eb..623551c5c7 100644 --- a/windows.media.playback/mediaplayer_play_848564459.md +++ b/windows.media.playback/mediaplayer_play_848564459.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.Play --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.Play ## -description Starts media playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.Play +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.Play + +## -description +Starts media playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_playbackmediamarkerreached.md b/windows.media.playback/mediaplayer_playbackmediamarkerreached.md index 331d8fe86f..bac1bd16df 100644 --- a/windows.media.playback/mediaplayer_playbackmediamarkerreached.md +++ b/windows.media.playback/mediaplayer_playbackmediamarkerreached.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkerReached --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkerReached ## -description Occurs when a media marker has been reached during playback. > [!NOTE] > **MediaPlayer.PlaybackMediaMarkerReached** may be altered or unavailable after Windows 10, version 1607. Instead, use [MediaPlaybackItem.TimedMetadataTracks](mediaplaybackitem_timedmetadatatracks.md) to manage data or text cues. For more information, see [Media playback with MediaSource](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkerReached +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkerReached + +## -description +Occurs when a media marker has been reached during playback. + +> [!NOTE] +> **MediaPlayer.PlaybackMediaMarkerReached** may be altered or unavailable after Windows 10, version 1607. Instead, use [MediaPlaybackItem.TimedMetadataTracks](mediaplaybackitem_timedmetadatatracks.md) to manage data or text cues. For more information, see [Media playback with MediaSource](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_playbackmediamarkers.md b/windows.media.playback/mediaplayer_playbackmediamarkers.md index 373eabd2e1..cc3b330265 100644 --- a/windows.media.playback/mediaplayer_playbackmediamarkers.md +++ b/windows.media.playback/mediaplayer_playbackmediamarkers.md @@ -1,3 +1,25 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkers --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkers ## -description Gets the collection of timeline markers for the media. > [!NOTE] > **MediaPlayer.PlaybackMediaMarkers** may be altered or unavailable after Windows 10, version 1607. Instead, use [MediaPlaybackItem.TimedMetadataTracks](mediaplaybackitem_timedmetadatatracks.md) to manage data or text cues. For more information, see [Media playback with MediaSource](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-playback-with-mediasource). ## -property-value The collection of timeline markers for the media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkers +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.PlaybackMediaMarkers + +## -description +Gets the collection of timeline markers for the media. + +> [!NOTE] +> **MediaPlayer.PlaybackMediaMarkers** may be altered or unavailable after Windows 10, version 1607. Instead, use [MediaPlaybackItem.TimedMetadataTracks](mediaplaybackitem_timedmetadatatracks.md) to manage data or text cues. For more information, see [Media playback with MediaSource](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-playback-with-mediasource). + +## -property-value +The collection of timeline markers for the media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_playbackrate.md b/windows.media.playback/mediaplayer_playbackrate.md index 6d88c7b1b9..1a4a3a9589 100644 --- a/windows.media.playback/mediaplayer_playbackrate.md +++ b/windows.media.playback/mediaplayer_playbackrate.md @@ -1,3 +1,28 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.PlaybackRate --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.PlaybackRate ## -description Gets or sets the playback rate, expressed as a percentage. > [!NOTE] > **MediaPlayer.PlaybackRate** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackRate](mediaplaybacksession_playbackrate.md) property. ## -property-value The playback rate, expressed as a percentage. ## -remarks This value is expressed as a percentage. For example, a value of 1.5 sets the playback rate to 150% of the original. The playback rate can't be set to a value greater than 1.0 while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.PlaybackRate +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.PlaybackRate + +## -description +Gets or sets the playback rate, expressed as a percentage. + +> [!NOTE] +> **MediaPlayer.PlaybackRate** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.PlaybackRate](mediaplaybacksession_playbackrate.md) property. + +## -property-value +The playback rate, expressed as a percentage. + +## -remarks +This value is expressed as a percentage. For example, a value of 1.5 sets the playback rate to 150% of the original. + +The playback rate can't be set to a value greater than 1.0 while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_playbacksession.md b/windows.media.playback/mediaplayer_playbacksession.md index ee3bb54bde..d5fa50ce5c 100644 --- a/windows.media.playback/mediaplayer_playbacksession.md +++ b/windows.media.playback/mediaplayer_playbacksession.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.PlaybackSession --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.PlaybackSession ## -description Gets the [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaPlayer](mediaplayer.md), which provides information about the state of the current playback session and provides events for responding to changes in playback session state. ## -property-value The [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaPlayer](mediaplayer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.PlaybackSession +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.PlaybackSession + +## -description +Gets the [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaPlayer](mediaplayer.md), which provides information about the state of the current playback session and provides events for responding to changes in playback session state. + +## -property-value +The [MediaPlaybackSession](mediaplaybacksession.md) associated with the [MediaPlayer](mediaplayer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_position.md b/windows.media.playback/mediaplayer_position.md index 97f614aa6f..6bec154dc3 100644 --- a/windows.media.playback/mediaplayer_position.md +++ b/windows.media.playback/mediaplayer_position.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.Position --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.Position ## -description Gets or sets the playback position within the media. > [!NOTE] > **MediaPlayer.Position** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.Position](mediaplaybacksession_position.md) property. ## -property-value The playback position within the media. ## -remarks The position can't be moved forward while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.Position +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.Position + +## -description +Gets or sets the playback position within the media. + +> [!NOTE] +> **MediaPlayer.Position** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.Position](mediaplaybacksession_position.md) property. + +## -property-value +The playback position within the media. + +## -remarks +The position can't be moved forward while a [MediaPlaybackItem](mediaplaybackitem.md) with [CanSkip](mediaplaybackitem_canskip.md) set to false is playing. Attempting to do so will cause an exception to be thrown. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_protectionmanager.md b/windows.media.playback/mediaplayer_protectionmanager.md index 881f6bcbe2..08f035d645 100644 --- a/windows.media.playback/mediaplayer_protectionmanager.md +++ b/windows.media.playback/mediaplayer_protectionmanager.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.ProtectionManager --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.ProtectionManager ## -description Gets or sets the content protection manager for the media. ## -property-value The content protection manager for the media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.ProtectionManager +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.ProtectionManager + +## -description +Gets or sets the content protection manager for the media. + +## -property-value +The content protection manager for the media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_realtimeplayback.md b/windows.media.playback/mediaplayer_realtimeplayback.md index 6c1110a227..46c92f2f26 100644 --- a/windows.media.playback/mediaplayer_realtimeplayback.md +++ b/windows.media.playback/mediaplayer_realtimeplayback.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.RealTimePlayback --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.RealTimePlayback ## -description Gets or sets a value that configures the [MediaPlayer](mediaplayer.md) for real-time scenarios. ## -property-value True if the [MediaPlayer](mediaplayer.md) is being used for real-time media; otherwise, false. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.RealTimePlayback +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.RealTimePlayback + +## -description +Gets or sets a value that configures the [MediaPlayer](mediaplayer.md) for real-time scenarios. + +## -property-value +True if the [MediaPlayer](mediaplayer.md) is being used for real-time media; otherwise, false. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_removealleffects_674052444.md b/windows.media.playback/mediaplayer_removealleffects_674052444.md index 42348f3772..0dbe9e99e4 100644 --- a/windows.media.playback/mediaplayer_removealleffects_674052444.md +++ b/windows.media.playback/mediaplayer_removealleffects_674052444.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.RemoveAllEffects --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.RemoveAllEffects ## -description Removes all effects from the playback stream of the [MediaPlayer](mediaplayer.md). ## -remarks Add effects to the playback stream by calling [AddAudioEffect](mediaplayer_addaudioeffect.md) or [AddVideoEffect](mediaplayer_addvideoeffect.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.RemoveAllEffects +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.RemoveAllEffects + +## -description +Removes all effects from the playback stream of the [MediaPlayer](mediaplayer.md). + +## -remarks +Add effects to the playback stream by calling [AddAudioEffect](mediaplayer_addaudioeffect.md) or [AddVideoEffect](mediaplayer_addvideoeffect.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_seekcompleted.md b/windows.media.playback/mediaplayer_seekcompleted.md index fdd33310f4..b5489d7324 100644 --- a/windows.media.playback/mediaplayer_seekcompleted.md +++ b/windows.media.playback/mediaplayer_seekcompleted.md @@ -1,3 +1,22 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.SeekCompleted --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.SeekCompleted ## -description Occurs when a seek operation has finished. > [!NOTE] > **MediaPlayer.SeekCompleted** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.SeekCompleted](mediaplaybacksession_seekcompleted.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.SeekCompleted +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.SeekCompleted + +## -description +Occurs when a seek operation has finished. + +> [!NOTE] +> **MediaPlayer.SeekCompleted** may be altered or unavailable after Windows 10, version 1607. Instead, use the [MediaPlayer.PlaybackSession](mediaplayer_playbacksession.md) property to get a [MediaPlaybackSession](mediaplaybacksession.md) object and then use the [MediaPlaybackSession.SeekCompleted](mediaplaybacksession_seekcompleted.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_setfilesource_399212762.md b/windows.media.playback/mediaplayer_setfilesource_399212762.md index 642fcaa7df..396db3325e 100644 --- a/windows.media.playback/mediaplayer_setfilesource_399212762.md +++ b/windows.media.playback/mediaplayer_setfilesource_399212762.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.SetFileSource(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.SetFileSource ## -description Set the media source to a file. > [!NOTE] > **MediaPlayer.SetFileSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. ## -parameters ### -param file The media source file. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.SetFileSource(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.SetFileSource + +## -description +Set the media source to a file. + +> [!NOTE] +> **MediaPlayer.SetFileSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. + +## -parameters +### -param file +The media source file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_setmediasource_1304953100.md b/windows.media.playback/mediaplayer_setmediasource_1304953100.md index 81c1aaff0f..cd11659da5 100644 --- a/windows.media.playback/mediaplayer_setmediasource_1304953100.md +++ b/windows.media.playback/mediaplayer_setmediasource_1304953100.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.SetMediaSource(Windows.Media.Core.IMediaSource) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.SetMediaSource ## -description Sets the media source for playback. > [!NOTE] > **MediaPlayer.SetMediaSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. ## -parameters ### -param source The media source for playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.SetMediaSource(Windows.Media.Core.IMediaSource) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.SetMediaSource + +## -description +Sets the media source for playback. + +> [!NOTE] +> **MediaPlayer.SetMediaSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. + +## -parameters +### -param source +The media source for playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_setstreamsource_128088783.md b/windows.media.playback/mediaplayer_setstreamsource_128088783.md index 20c7daf392..3bc643ee5a 100644 --- a/windows.media.playback/mediaplayer_setstreamsource_128088783.md +++ b/windows.media.playback/mediaplayer_setstreamsource_128088783.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.SetStreamSource(Windows.Storage.Streams.IRandomAccessStream) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.SetStreamSource ## -description Sets the media source to a stream. > [!NOTE] > **MediaPlayer.SetMediaSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. ## -parameters ### -param stream The media source stream. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.SetStreamSource(Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.SetStreamSource + +## -description +Sets the media source to a stream. + +> [!NOTE] +> **MediaPlayer.SetMediaSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. + +## -parameters +### -param stream +The media source stream. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_setsurfacesize_1529588590.md b/windows.media.playback/mediaplayer_setsurfacesize_1529588590.md index 1547d02112..257432d43c 100644 --- a/windows.media.playback/mediaplayer_setsurfacesize_1529588590.md +++ b/windows.media.playback/mediaplayer_setsurfacesize_1529588590.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.SetSurfaceSize(Windows.Foundation.Size) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.SetSurfaceSize ## -description Sets the size of the composition surface returned by [GetSurface](mediaplayer_getsurface.md). ## -parameters ### -param size An object representing the size of the composition surface. ## -remarks The default size for the composition surface returned by [GetSurface](mediaplayer_getsurface.md) is 640x480, in pixels. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.SetSurfaceSize(Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.SetSurfaceSize + +## -description +Sets the size of the composition surface returned by [GetSurface](mediaplayer_getsurface.md). + +## -parameters +### -param size +An object representing the size of the composition surface. + +## -remarks +The default size for the composition surface returned by [GetSurface](mediaplayer_getsurface.md) is 640x480, in pixels. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_seturisource_889711971.md b/windows.media.playback/mediaplayer_seturisource_889711971.md index b439b5200d..ee2ba500fb 100644 --- a/windows.media.playback/mediaplayer_seturisource_889711971.md +++ b/windows.media.playback/mediaplayer_seturisource_889711971.md @@ -1,3 +1,26 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.SetUriSource(Windows.Foundation.Uri) --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.SetUriSource ## -description Sets the path to the media. > [!NOTE] > **MediaPlayer.SetUriSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. ## -parameters ### -param value The path to the media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.SetUriSource(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.SetUriSource + +## -description +Sets the path to the media. + +> [!NOTE] +> **MediaPlayer.SetUriSource** may be altered or unavailable after Windows 10. Use [MediaPlayer.Source](mediaplayer_source.md) instead. + +## -parameters +### -param value +The path to the media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_source.md b/windows.media.playback/mediaplayer_source.md index 4addf632e3..4957d3bea2 100644 --- a/windows.media.playback/mediaplayer_source.md +++ b/windows.media.playback/mediaplayer_source.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.Source --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.Source ## -description Sets the playback source of the media player. ## -property-value The playback source of the media player. ## -remarks The playback source can be a [MediaSource](../windows.media.core/mediasource.md), a [MediaPlaybackItem](mediaplaybackitem.md), or a [MediaPlaybackList](mediaplaybacklist.md), which is a list of [MediaPlaybackItem](mediaplaybackitem.md) objects. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.Source +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.Source + +## -description +Sets the playback source of the media player. + +## -property-value +The playback source of the media player. + +## -remarks +The playback source can be a [MediaSource](../windows.media.core/mediasource.md), a [MediaPlaybackItem](mediaplaybackitem.md), or a [MediaPlaybackList](mediaplaybacklist.md), which is a list of [MediaPlaybackItem](mediaplaybackitem.md) objects. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_sourcechanged.md b/windows.media.playback/mediaplayer_sourcechanged.md index 22c341b801..15d480c7c7 100644 --- a/windows.media.playback/mediaplayer_sourcechanged.md +++ b/windows.media.playback/mediaplayer_sourcechanged.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.SourceChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.SourceChanged ## -description Occurs when the media source for the [MediaPlayer](mediaplayer.md) changes. ## -remarks A typical use of this event is if you are implementing your own transport controls. You can respond to this event by checking to see whether the source is a [MediaSource](../windows.media.core/mediasource.md), [MediaPlaybackItem](mediaplaybackitem.md), or [MediaPlaybackList](mediaplaybacklist.md) and then update your UI accordingly. For example, if the source is a [MediaPlaybackItem](mediaplaybackitem.md), you could subscribe to the list of audio and caption tracks and update the list in your UI so that the user can select the active track. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.SourceChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.SourceChanged + +## -description +Occurs when the media source for the [MediaPlayer](mediaplayer.md) changes. + +## -remarks +A typical use of this event is if you are implementing your own transport controls. You can respond to this event by checking to see whether the source is a [MediaSource](../windows.media.core/mediasource.md), [MediaPlaybackItem](mediaplaybackitem.md), or [MediaPlaybackList](mediaplaybacklist.md) and then update your UI accordingly. For example, if the source is a [MediaPlaybackItem](mediaplaybackitem.md), you could subscribe to the list of audio and caption tracks and update the list in your UI so that the user can select the active track. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_stepbackwardoneframe_284154154.md b/windows.media.playback/mediaplayer_stepbackwardoneframe_284154154.md index dfc1c5c233..8868d80176 100644 --- a/windows.media.playback/mediaplayer_stepbackwardoneframe_284154154.md +++ b/windows.media.playback/mediaplayer_stepbackwardoneframe_284154154.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.StepBackwardOneFrame --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.StepBackwardOneFrame ## -description Causes the [MediaPlayer](mediaplayer.md) to move backward in the current media by one frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.StepBackwardOneFrame +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.StepBackwardOneFrame + +## -description +Causes the [MediaPlayer](mediaplayer.md) to move backward in the current media by one frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_stepforwardoneframe_1294308405.md b/windows.media.playback/mediaplayer_stepforwardoneframe_1294308405.md index 83f9a69003..8010355747 100644 --- a/windows.media.playback/mediaplayer_stepforwardoneframe_1294308405.md +++ b/windows.media.playback/mediaplayer_stepforwardoneframe_1294308405.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayer.StepForwardOneFrame --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayer.StepForwardOneFrame ## -description Causes the [MediaPlayer](mediaplayer.md) to move forward in the current media by one frame. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.StepForwardOneFrame +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.StepForwardOneFrame + +## -description +Causes the [MediaPlayer](mediaplayer.md) to move forward in the current media by one frame. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_stereoscopicvideorendermode.md b/windows.media.playback/mediaplayer_stereoscopicvideorendermode.md index bb705e5aaa..6c449d75a2 100644 --- a/windows.media.playback/mediaplayer_stereoscopicvideorendermode.md +++ b/windows.media.playback/mediaplayer_stereoscopicvideorendermode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.StereoscopicVideoRenderMode --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.StereoscopicVideoRenderMode ## -description Gets or sets a value indicating the current stereoscopic render mode. ## -property-value The current stereoscopic render mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.StereoscopicVideoRenderMode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.StereoscopicVideoRenderMode + +## -description +Gets or sets a value indicating the current stereoscopic render mode. + +## -property-value +The current stereoscopic render mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_systemmediatransportcontrols.md b/windows.media.playback/mediaplayer_systemmediatransportcontrols.md index 024f3cb53d..080489d988 100644 --- a/windows.media.playback/mediaplayer_systemmediatransportcontrols.md +++ b/windows.media.playback/mediaplayer_systemmediatransportcontrols.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.SystemMediaTransportControls --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.SystemMediaTransportControls ## -description Gets an instance of the [SystemMediaTransportControls](mediaplayer_systemmediatransportcontrols.md) class to enable user control of playback of the [MediaPlayer](mediaplayer.md) and to allow the app to show information about the currently playing content in the system UI. ## -property-value An instance of the [SystemMediaTransportControls](../windows.media/systemmediatransportcontrols.md) class. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.SystemMediaTransportControls +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.SystemMediaTransportControls + +## -description +Gets an instance of the [SystemMediaTransportControls](mediaplayer_systemmediatransportcontrols.md) class to enable user control of playback of the [MediaPlayer](mediaplayer.md) and to allow the app to show information about the currently playing content in the system UI. + +## -property-value +An instance of the [SystemMediaTransportControls](../windows.media/systemmediatransportcontrols.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_timelinecontroller.md b/windows.media.playback/mediaplayer_timelinecontroller.md index 891f8dcef2..f6905d976f 100644 --- a/windows.media.playback/mediaplayer_timelinecontroller.md +++ b/windows.media.playback/mediaplayer_timelinecontroller.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.TimelineController --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.TimelineController ## -description Gets or sets the [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). Use this property to manipulate multiple **MediaPlayer** instances with a single timeline control. ## -property-value The [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.TimelineController +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.TimelineController + +## -description +Gets or sets the [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). Use this property to manipulate multiple **MediaPlayer** instances with a single timeline control. + +## -property-value +The [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_timelinecontrollerpositionoffset.md b/windows.media.playback/mediaplayer_timelinecontrollerpositionoffset.md index 6e320cf1ec..187d59eabb 100644 --- a/windows.media.playback/mediaplayer_timelinecontrollerpositionoffset.md +++ b/windows.media.playback/mediaplayer_timelinecontrollerpositionoffset.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.TimelineControllerPositionOffset --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.TimelineControllerPositionOffset ## -description Gets or sets the offset applied to the position of the [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). ## -property-value The offset applied to the position of the [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). ## -remarks A [MediaTimelineController](../windows.media/mediatimelinecontroller.md) can be associated with multiple instances of [MediaPlayer](mediaplayer.md) which could be playing different media sources. This property allows you to offset the actual playback position of the player from the current position of the timeline controller. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.TimelineControllerPositionOffset +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.TimelineControllerPositionOffset + +## -description +Gets or sets the offset applied to the position of the [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). + +## -property-value +The offset applied to the position of the [MediaTimelineController](../windows.media/mediatimelinecontroller.md) associated with the [MediaPlayer](mediaplayer.md). + +## -remarks +A [MediaTimelineController](../windows.media/mediatimelinecontroller.md) can be associated with multiple instances of [MediaPlayer](mediaplayer.md) which could be playing different media sources. This property allows you to offset the actual playback position of the player from the current position of the timeline controller. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_volume.md b/windows.media.playback/mediaplayer_volume.md index e365804141..ef7ec1176b 100644 --- a/windows.media.playback/mediaplayer_volume.md +++ b/windows.media.playback/mediaplayer_volume.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayer.Volume --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayer.Volume ## -description Get or sets the audio volume for media playback. ## -property-value The audio volume for media playback. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.Volume +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.Volume + +## -description +Get or sets the audio volume for media playback. + +## -property-value +The audio volume for media playback. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayer_volumechanged.md b/windows.media.playback/mediaplayer_volumechanged.md index 97bc7dfed5..bafcad15ec 100644 --- a/windows.media.playback/mediaplayer_volumechanged.md +++ b/windows.media.playback/mediaplayer_volumechanged.md @@ -1,3 +1,19 @@ ---- -api-id: E:Windows.Media.Playback.MediaPlayer.VolumeChanged --api-type: winrt event ---- # Windows.Media.Playback.MediaPlayer.VolumeChanged ## -description Occurs when the volume of the audio has changed. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.VolumeChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.VolumeChanged + +## -description +Occurs when the volume of the audio has changed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerdatareceivedeventargs.md b/windows.media.playback/mediaplayerdatareceivedeventargs.md index 32c66778e1..2a85a2583a 100644 --- a/windows.media.playback/mediaplayerdatareceivedeventargs.md +++ b/windows.media.playback/mediaplayerdatareceivedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlayerDataReceivedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlayerDataReceivedEventArgs ## -description Provides data for the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) and [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) events. ## -remarks Get an instance of this class by handling the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) and [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) events. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlayerDataReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlayerDataReceivedEventArgs + +## -description +Provides data for the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) and [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) events. + +## -remarks +Get an instance of this class by handling the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) and [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) events. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerdatareceivedeventargs_data.md b/windows.media.playback/mediaplayerdatareceivedeventargs_data.md index 2674b1d425..c4826fe2bd 100644 --- a/windows.media.playback/mediaplayerdatareceivedeventargs_data.md +++ b/windows.media.playback/mediaplayerdatareceivedeventargs_data.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerDataReceivedEventArgs.Data --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerDataReceivedEventArgs.Data ## -description Gets the data from the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) or [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) event. ## -property-value The data from the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) or [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerDataReceivedEventArgs.Data +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerDataReceivedEventArgs.Data + +## -description +Gets the data from the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) or [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) event. + +## -property-value +The data from the [MessageReceivedFromBackground](backgroundmediaplayer_messagereceivedfrombackground.md) or [MessageReceivedFromForeground](backgroundmediaplayer_messagereceivedfromforeground.md) event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerfailedeventargs.md b/windows.media.playback/mediaplayerfailedeventargs.md index 31c987e6f8..adfca529dc 100644 --- a/windows.media.playback/mediaplayerfailedeventargs.md +++ b/windows.media.playback/mediaplayerfailedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlayerFailedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlayerFailedEventArgs ## -description Provides the data for [MediaFailed](mediaplayer_mediafailed.md) events. ## -remarks Get an instance of this class by handling the [MediaFailed](mediaplayer_mediafailed.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlayerFailedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlayerFailedEventArgs + +## -description +Provides the data for [MediaFailed](mediaplayer_mediafailed.md) events. + +## -remarks +Get an instance of this class by handling the [MediaFailed](mediaplayer_mediafailed.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerfailedeventargs_error.md b/windows.media.playback/mediaplayerfailedeventargs_error.md index 011e6a810e..c8e56afdd0 100644 --- a/windows.media.playback/mediaplayerfailedeventargs_error.md +++ b/windows.media.playback/mediaplayerfailedeventargs_error.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerFailedEventArgs.Error --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerFailedEventArgs.Error ## -description Gets the [MediaPlayerError](mediaplayererror.md) value for the error that triggered the event. ## -property-value The [MediaPlayerError](mediaplayererror.md) value for the error that triggered the event. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerFailedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerFailedEventArgs.Error + +## -description +Gets the [MediaPlayerError](mediaplayererror.md) value for the error that triggered the event. + +## -property-value +The [MediaPlayerError](mediaplayererror.md) value for the error that triggered the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerfailedeventargs_errormessage.md b/windows.media.playback/mediaplayerfailedeventargs_errormessage.md index 067ff01261..2c6fdc40ab 100644 --- a/windows.media.playback/mediaplayerfailedeventargs_errormessage.md +++ b/windows.media.playback/mediaplayerfailedeventargs_errormessage.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerFailedEventArgs.ErrorMessage --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerFailedEventArgs.ErrorMessage ## -description Gets a string describing the error that occurred. ## -property-value String describing the error that occurred. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerFailedEventArgs.ErrorMessage +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerFailedEventArgs.ErrorMessage + +## -description +Gets a string describing the error that occurred. + +## -property-value +String describing the error that occurred. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerfailedeventargs_extendederrorcode.md b/windows.media.playback/mediaplayerfailedeventargs_extendederrorcode.md index 84714fae67..80d88043b8 100644 --- a/windows.media.playback/mediaplayerfailedeventargs_extendederrorcode.md +++ b/windows.media.playback/mediaplayerfailedeventargs_extendederrorcode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerFailedEventArgs.ExtendedErrorCode --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerFailedEventArgs.ExtendedErrorCode ## -description Gets an [HResult](../windows.foundation/hresult.md) that indicates any extra data about the error that occurred. ## -property-value An [HResult](../windows.foundation/hresult.md) that indicates any extra data about the error that occurred. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerFailedEventArgs.ExtendedErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerFailedEventArgs.ExtendedErrorCode + +## -description +Gets an [HResult](../windows.foundation/hresult.md) that indicates any extra data about the error that occurred. + +## -property-value +An [HResult](../windows.foundation/hresult.md) that indicates any extra data about the error that occurred. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerratechangedeventargs.md b/windows.media.playback/mediaplayerratechangedeventargs.md index c8217b103b..53941b76ae 100644 --- a/windows.media.playback/mediaplayerratechangedeventargs.md +++ b/windows.media.playback/mediaplayerratechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlayerRateChangedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.MediaPlayerRateChangedEventArgs ## -description Provides the data for [MediaPlayerRateChanged](mediaplayer_mediaplayerratechanged.md) events. ## -remarks Get an instance of this class by handling the [MediaPlayerRateChanged](mediaplayer_mediaplayerratechanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlayerRateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlayerRateChangedEventArgs + +## -description +Provides the data for [MediaPlayerRateChanged](mediaplayer_mediaplayerratechanged.md) events. + +## -remarks +Get an instance of this class by handling the [MediaPlayerRateChanged](mediaplayer_mediaplayerratechanged.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayerratechangedeventargs_newrate.md b/windows.media.playback/mediaplayerratechangedeventargs_newrate.md index bb4684e930..cc793e0d6f 100644 --- a/windows.media.playback/mediaplayerratechangedeventargs_newrate.md +++ b/windows.media.playback/mediaplayerratechangedeventargs_newrate.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerRateChangedEventArgs.NewRate --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerRateChangedEventArgs.NewRate ## -description Gets the new playback rate for the media. ## -property-value The new playback rate for the media. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerRateChangedEventArgs.NewRate +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerRateChangedEventArgs.NewRate + +## -description +Gets the new playback rate for the media. + +## -property-value +The new playback rate for the media. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayersurface.md b/windows.media.playback/mediaplayersurface.md index 4d6dce6dd2..14ad15ea59 100644 --- a/windows.media.playback/mediaplayersurface.md +++ b/windows.media.playback/mediaplayersurface.md @@ -1,3 +1,25 @@ ---- -api-id: T:Windows.Media.Playback.MediaPlayerSurface --api-type: winrt class ---- # Windows.Media.Playback.MediaPlayerSurface ## -description Provides access to a [ICompositionSurface](../windows.ui.composition/icompositionsurface.md) that is shared between a [MediaPlayer](mediaplayer.md) and a [Compositor](../windows.ui.composition/compositor.md) to enable the rendering of **MediaPlayer** content using the [Windows.UI.Composition](../windows.ui.composition/windows_ui_composition.md) APIs without requiring the use of the XAML framework. ## -remarks Get an instance of this class by calling [MediaPlayer.GetSurface](mediaplayer_getsurface.md). For more information on using the [Windows.UI.Composition](../windows.ui.composition/windows_ui_composition.md) APIs to render visuals, see [Visual layer](https://msdn.microsoft.com/en-us/windows/uwp/graphics/visual-layer). For how-to guidance for rendering video to a composition surface, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface). ## -examples ## -see-also [IClosable](../windows.foundation/iclosable.md), [Visual layer](https://msdn.microsoft.com/en-us/windows/uwp/graphics/visual-layer), [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.MediaPlayerSurface +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlayerSurface + +## -description +Provides access to a [ICompositionSurface](../windows.ui.composition/icompositionsurface.md) that is shared between a [MediaPlayer](mediaplayer.md) and a [Compositor](../windows.ui.composition/compositor.md) to enable the rendering of **MediaPlayer** content using the [Windows.UI.Composition](../windows.ui.composition/windows_ui_composition.md) APIs without requiring the use of the XAML framework. + +## -remarks +Get an instance of this class by calling [MediaPlayer.GetSurface](mediaplayer_getsurface.md). + +For more information on using the [Windows.UI.Composition](../windows.ui.composition/windows_ui_composition.md) APIs to render visuals, see [Visual layer](https://msdn.microsoft.com/en-us/windows/uwp/graphics/visual-layer). + +For how-to guidance for rendering video to a composition surface, see [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface). + +## -examples + +## -see-also +[IClosable](../windows.foundation/iclosable.md), [Visual layer](https://msdn.microsoft.com/en-us/windows/uwp/graphics/visual-layer), [Play audio and video with MediaPlayer](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/play-audio-and-video-with-mediaplayer#use-mediaplayersurface-to-render-video-to-a-windowsuicomposition-surface) \ No newline at end of file diff --git a/windows.media.playback/mediaplayersurface_close_811482585.md b/windows.media.playback/mediaplayersurface_close_811482585.md index f977572f17..bde19f453a 100644 --- a/windows.media.playback/mediaplayersurface_close_811482585.md +++ b/windows.media.playback/mediaplayersurface_close_811482585.md @@ -1,3 +1,20 @@ ---- -api-id: M:Windows.Media.Playback.MediaPlayerSurface.Close --api-type: winrt method ---- # Windows.Media.Playback.MediaPlayerSurface.Close ## -description Closes the [MediaPlayerSurface](mediaplayersurface.md) and disposes of associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaPlayerSurface](mediaplayersurface.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.MediaPlayerSurface.Close +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayerSurface.Close + +## -description +Closes the [MediaPlayerSurface](mediaplayersurface.md) and disposes of associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaPlayerSurface](mediaplayersurface.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayersurface_compositionsurface.md b/windows.media.playback/mediaplayersurface_compositionsurface.md index 0a8cf65aad..bd3a74d086 100644 --- a/windows.media.playback/mediaplayersurface_compositionsurface.md +++ b/windows.media.playback/mediaplayersurface_compositionsurface.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerSurface.CompositionSurface --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerSurface.CompositionSurface ## -description Gets the [ICompositionSurface](../windows.ui.composition/icompositionsurface.md) for rendering [MediaPlayer](mediaplayer.md) content. ## -property-value The [ICompositionSurface](../windows.ui.composition/icompositionsurface.md) for rendering [MediaPlayer](mediaplayer.md) content. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerSurface.CompositionSurface +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerSurface.CompositionSurface + +## -description +Gets the [ICompositionSurface](../windows.ui.composition/icompositionsurface.md) for rendering [MediaPlayer](mediaplayer.md) content. + +## -property-value +The [ICompositionSurface](../windows.ui.composition/icompositionsurface.md) for rendering [MediaPlayer](mediaplayer.md) content. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayersurface_compositor.md b/windows.media.playback/mediaplayersurface_compositor.md index 22b9d61bed..e2fe92048c 100644 --- a/windows.media.playback/mediaplayersurface_compositor.md +++ b/windows.media.playback/mediaplayersurface_compositor.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerSurface.Compositor --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerSurface.Compositor ## -description Gets the [Compositor](../windows.ui.composition/compositor.md) with which the surface will be used. ## -property-value The [Compositor](../windows.ui.composition/compositor.md) with which the surface will be used. ## -remarks Specify the [Compositor](../windows.ui.composition/compositor.md) for the surface by passing it in as an argument to [MediaPlayer.GetSurface](mediaplayer_getsurface.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerSurface.Compositor +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerSurface.Compositor + +## -description +Gets the [Compositor](../windows.ui.composition/compositor.md) with which the surface will be used. + +## -property-value +The [Compositor](../windows.ui.composition/compositor.md) with which the surface will be used. + +## -remarks +Specify the [Compositor](../windows.ui.composition/compositor.md) for the surface by passing it in as an argument to [MediaPlayer.GetSurface](mediaplayer_getsurface.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/mediaplayersurface_mediaplayer.md b/windows.media.playback/mediaplayersurface_mediaplayer.md index 7d2e0e0506..85e39024a6 100644 --- a/windows.media.playback/mediaplayersurface_mediaplayer.md +++ b/windows.media.playback/mediaplayersurface_mediaplayer.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playback.MediaPlayerSurface.MediaPlayer --api-type: winrt property ---- # Windows.Media.Playback.MediaPlayerSurface.MediaPlayer ## -description Gets the [MediaPlayer](mediaplayer.md) associated with the [MediaPlayerSurface](mediaplayersurface.md). ## -property-value The [MediaPlayer](mediaplayer.md) associated with the [MediaPlayerSurface](mediaplayersurface.md). ## -remarks The returned [MediaPlayer](mediaplayer.md) instance is the one on which [GetSurface](mediaplayer_getsurface.md) was called to generate the [MediaPlayerSurface](mediaplayersurface.md). ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.MediaPlayerSurface.MediaPlayer +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayerSurface.MediaPlayer + +## -description +Gets the [MediaPlayer](mediaplayer.md) associated with the [MediaPlayerSurface](mediaplayersurface.md). + +## -property-value +The [MediaPlayer](mediaplayer.md) associated with the [MediaPlayerSurface](mediaplayersurface.md). + +## -remarks +The returned [MediaPlayer](mediaplayer.md) instance is the one on which [GetSurface](mediaplayer_getsurface.md) was called to generate the [MediaPlayerSurface](mediaplayersurface.md). + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarker.md b/windows.media.playback/playbackmediamarker.md index ffe059ed81..5e24eb783f 100644 --- a/windows.media.playback/playbackmediamarker.md +++ b/windows.media.playback/playbackmediamarker.md @@ -1,3 +1,19 @@ ---- -api-id: T:Windows.Media.Playback.PlaybackMediaMarker --api-type: winrt class ---- # Windows.Media.Playback.PlaybackMediaMarker ## -description Represents a marker at specific location in a media stream time-line. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.PlaybackMediaMarker +-api-type: winrt class +--- + + + +# Windows.Media.Playback.PlaybackMediaMarker + +## -description +Represents a marker at specific location in a media stream time-line. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarker_mediamarkertype.md b/windows.media.playback/playbackmediamarker_mediamarkertype.md index 4a8b882414..44c1832959 100644 --- a/windows.media.playback/playbackmediamarker_mediamarkertype.md +++ b/windows.media.playback/playbackmediamarker_mediamarkertype.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.PlaybackMediaMarker.MediaMarkerType --api-type: winrt property ---- # Windows.Media.Playback.PlaybackMediaMarker.MediaMarkerType ## -description Gets the type of the media marker. ## -property-value The type of the media marker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.PlaybackMediaMarker.MediaMarkerType +-api-type: winrt property +--- + + + +# Windows.Media.Playback.PlaybackMediaMarker.MediaMarkerType + +## -description +Gets the type of the media marker. + +## -property-value +The type of the media marker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarker_playbackmediamarker_39915104.md b/windows.media.playback/playbackmediamarker_playbackmediamarker_39915104.md index b442076390..afc1ab8289 100644 --- a/windows.media.playback/playbackmediamarker_playbackmediamarker_39915104.md +++ b/windows.media.playback/playbackmediamarker_playbackmediamarker_39915104.md @@ -1,3 +1,24 @@ ---- -api-id: M:Windows.Media.Playback.PlaybackMediaMarker.#ctor(Windows.Foundation.TimeSpan) --api-type: winrt method ---- # Windows.Media.Playback.PlaybackMediaMarker.PlaybackMediaMarker ## -description Initializes a new instance of the [PlaybackMediaMarker](playbackmediamarker.md) class with the specified offset into the media timeline. ## -parameters ### -param value The media marker's offset into the media timeline. ## -remarks ## -examples ## -see-also [PlaybackMediaMarker(TimeSpan, String, String)](playbackmediamarker_playbackmediamarker_681240416.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.PlaybackMediaMarker.#ctor(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.PlaybackMediaMarker.PlaybackMediaMarker + +## -description +Initializes a new instance of the [PlaybackMediaMarker](playbackmediamarker.md) class with the specified offset into the media timeline. + +## -parameters +### -param value +The media marker's offset into the media timeline. + +## -remarks + +## -examples + +## -see-also +[PlaybackMediaMarker(TimeSpan, String, String)](playbackmediamarker_playbackmediamarker_681240416.md) \ No newline at end of file diff --git a/windows.media.playback/playbackmediamarker_playbackmediamarker_681240416.md b/windows.media.playback/playbackmediamarker_playbackmediamarker_681240416.md index 35c4adb0a0..3441700027 100644 --- a/windows.media.playback/playbackmediamarker_playbackmediamarker_681240416.md +++ b/windows.media.playback/playbackmediamarker_playbackmediamarker_681240416.md @@ -1,3 +1,30 @@ ---- -api-id: M:Windows.Media.Playback.PlaybackMediaMarker.#ctor(Windows.Foundation.TimeSpan,System.String,System.String) --api-type: winrt method ---- # Windows.Media.Playback.PlaybackMediaMarker.PlaybackMediaMarker ## -description Initializes a new instance of the [PlaybackMediaMarker](playbackmediamarker.md) class with the specified offset into the media timeline, type string, and text. ## -parameters ### -param value The media marker's offset into the media timeline. ### -param mediaMarketType The type of the media marker. ### -param text The text of the media marker. ## -remarks ## -examples ## -see-also [PlaybackMediaMarker(TimeSpan)](playbackmediamarker_playbackmediamarker_39915104.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.PlaybackMediaMarker.#ctor(Windows.Foundation.TimeSpan,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.PlaybackMediaMarker.PlaybackMediaMarker + +## -description +Initializes a new instance of the [PlaybackMediaMarker](playbackmediamarker.md) class with the specified offset into the media timeline, type string, and text. + +## -parameters +### -param value +The media marker's offset into the media timeline. + +### -param mediaMarketType +The type of the media marker. + +### -param text +The text of the media marker. + +## -remarks + +## -examples + +## -see-also +[PlaybackMediaMarker(TimeSpan)](playbackmediamarker_playbackmediamarker_39915104.md) \ No newline at end of file diff --git a/windows.media.playback/playbackmediamarker_text.md b/windows.media.playback/playbackmediamarker_text.md index 32563f8458..7894177c6a 100644 --- a/windows.media.playback/playbackmediamarker_text.md +++ b/windows.media.playback/playbackmediamarker_text.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.PlaybackMediaMarker.Text --api-type: winrt property ---- # Windows.Media.Playback.PlaybackMediaMarker.Text ## -description Gets the text associated with the marker. ## -property-value The text associated with the marker. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.PlaybackMediaMarker.Text +-api-type: winrt property +--- + + + +# Windows.Media.Playback.PlaybackMediaMarker.Text + +## -description +Gets the text associated with the marker. + +## -property-value +The text associated with the marker. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarker_time.md b/windows.media.playback/playbackmediamarker_time.md index 9bebdbcc11..0a1495c105 100644 --- a/windows.media.playback/playbackmediamarker_time.md +++ b/windows.media.playback/playbackmediamarker_time.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.PlaybackMediaMarker.Time --api-type: winrt property ---- # Windows.Media.Playback.PlaybackMediaMarker.Time ## -description Gets the offset in the media timeline where the marker occurs. ## -property-value The offset in the media timeline where the marker occurs. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.PlaybackMediaMarker.Time +-api-type: winrt property +--- + + + +# Windows.Media.Playback.PlaybackMediaMarker.Time + +## -description +Gets the offset in the media timeline where the marker occurs. + +## -property-value +The offset in the media timeline where the marker occurs. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarkerreachedeventargs.md b/windows.media.playback/playbackmediamarkerreachedeventargs.md index 920ee3c4d6..103f26fccf 100644 --- a/windows.media.playback/playbackmediamarkerreachedeventargs.md +++ b/windows.media.playback/playbackmediamarkerreachedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs ## -description Provides data for [PlaybackMediaMarkerReached](mediaplayer_playbackmediamarkerreached.md) events. ## -remarks Get an instance of this class by handling the [PlaybackMediaMarkerReached](mediaplayer_playbackmediamarkerreached.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs + +## -description +Provides data for [PlaybackMediaMarkerReached](mediaplayer_playbackmediamarkerreached.md) events. + +## -remarks +Get an instance of this class by handling the [PlaybackMediaMarkerReached](mediaplayer_playbackmediamarkerreached.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarkerreachedeventargs_playbackmediamarker.md b/windows.media.playback/playbackmediamarkerreachedeventargs_playbackmediamarker.md index afd15758b3..a878997ce6 100644 --- a/windows.media.playback/playbackmediamarkerreachedeventargs_playbackmediamarker.md +++ b/windows.media.playback/playbackmediamarkerreachedeventargs_playbackmediamarker.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs.PlaybackMediaMarker --api-type: winrt property ---- # Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs.PlaybackMediaMarker ## -description Gets the [PlaybackMediaMarker](playbackmediamarker.md) that was reached. ## -property-value The [PlaybackMediaMarker](playbackmediamarker.md) that was reached. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs.PlaybackMediaMarker +-api-type: winrt property +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerReachedEventArgs.PlaybackMediaMarker + +## -description +Gets the [PlaybackMediaMarker](playbackmediamarker.md) that was reached. + +## -property-value +The [PlaybackMediaMarker](playbackmediamarker.md) that was reached. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarkersequence.md b/windows.media.playback/playbackmediamarkersequence.md index dfcc04c092..21c9999368 100644 --- a/windows.media.playback/playbackmediamarkersequence.md +++ b/windows.media.playback/playbackmediamarkersequence.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.PlaybackMediaMarkerSequence --api-type: winrt class ---- # Windows.Media.Playback.PlaybackMediaMarkerSequence ## -description An ordered collection of [PlaybackMediaMarker](playbackmediamarker.md) objects. ## -remarks ## -examples ## -see-also [IIterable(PlaybackMediaMarker)](../windows.foundation.collections/iiterable_1.md) \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.PlaybackMediaMarkerSequence +-api-type: winrt class +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerSequence + +## -description +An ordered collection of [PlaybackMediaMarker](playbackmediamarker.md) objects. + +## -remarks + +## -examples + +## -see-also +[IIterable(PlaybackMediaMarker)](../windows.foundation.collections/iiterable_1.md) \ No newline at end of file diff --git a/windows.media.playback/playbackmediamarkersequence_clear_556466.md b/windows.media.playback/playbackmediamarkersequence_clear_556466.md index cad7e08888..b20bef3585 100644 --- a/windows.media.playback/playbackmediamarkersequence_clear_556466.md +++ b/windows.media.playback/playbackmediamarkersequence_clear_556466.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playback.PlaybackMediaMarkerSequence.Clear --api-type: winrt method ---- # Windows.Media.Playback.PlaybackMediaMarkerSequence.Clear ## -description Removes all elements from the sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.PlaybackMediaMarkerSequence.Clear +-api-type: winrt method +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerSequence.Clear + +## -description +Removes all elements from the sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarkersequence_first_1920739956.md b/windows.media.playback/playbackmediamarkersequence_first_1920739956.md index 75084f2bca..f2b30206ca 100644 --- a/windows.media.playback/playbackmediamarkersequence_first_1920739956.md +++ b/windows.media.playback/playbackmediamarkersequence_first_1920739956.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Playback.PlaybackMediaMarkerSequence.First --api-type: winrt method ---- # Windows.Media.Playback.PlaybackMediaMarkerSequence.First ## -description Gets an [IIterator](../windows.foundation.collections/iiterator_1.md) pointing at the first [PlaybackMediaMarker](playbackmediamarker.md) in the sequence. ## -returns Iterator pointing at the first media marker in the sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.PlaybackMediaMarkerSequence.First +-api-type: winrt method +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerSequence.First + +## -description +Gets an [IIterator](../windows.foundation.collections/iiterator_1.md) pointing at the first [PlaybackMediaMarker](playbackmediamarker.md) in the sequence. + +## -returns +Iterator pointing at the first media marker in the sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarkersequence_insert_2118747463.md b/windows.media.playback/playbackmediamarkersequence_insert_2118747463.md index bfcea4244b..b3255dabad 100644 --- a/windows.media.playback/playbackmediamarkersequence_insert_2118747463.md +++ b/windows.media.playback/playbackmediamarkersequence_insert_2118747463.md @@ -1,3 +1,23 @@ ---- -api-id: M:Windows.Media.Playback.PlaybackMediaMarkerSequence.Insert(Windows.Media.Playback.PlaybackMediaMarker) --api-type: winrt method ---- # Windows.Media.Playback.PlaybackMediaMarkerSequence.Insert ## -description Adds a [PlaybackMediaMarker](playbackmediamarker.md) to the sequence in it's ordered position. ## -parameters ### -param value The media marker to insert into the sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playback.PlaybackMediaMarkerSequence.Insert(Windows.Media.Playback.PlaybackMediaMarker) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerSequence.Insert + +## -description +Adds a [PlaybackMediaMarker](playbackmediamarker.md) to the sequence in it's ordered position. + +## -parameters +### -param value +The media marker to insert into the sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/playbackmediamarkersequence_size.md b/windows.media.playback/playbackmediamarkersequence_size.md index 0cca02674c..5f023c7369 100644 --- a/windows.media.playback/playbackmediamarkersequence_size.md +++ b/windows.media.playback/playbackmediamarkersequence_size.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.PlaybackMediaMarkerSequence.Size --api-type: winrt property ---- # Windows.Media.Playback.PlaybackMediaMarkerSequence.Size ## -description Returns the number of items in the sequence. ## -property-value The number of items in the sequence. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.PlaybackMediaMarkerSequence.Size +-api-type: winrt property +--- + + + +# Windows.Media.Playback.PlaybackMediaMarkerSequence.Size + +## -description +Returns the number of items in the sequence. + +## -property-value +The number of items in the sequence. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/timedmetadatapresentationmodechangedeventargs.md b/windows.media.playback/timedmetadatapresentationmodechangedeventargs.md index 7f0b681a55..769bd97a04 100644 --- a/windows.media.playback/timedmetadatapresentationmodechangedeventargs.md +++ b/windows.media.playback/timedmetadatapresentationmodechangedeventargs.md @@ -1,3 +1,20 @@ ---- -api-id: T:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs --api-type: winrt class ---- # Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs ## -description Provides data for the [MediaPlaybackTimedMetadataTrackList.PresentationModeChanged](mediaplaybacktimedmetadatatracklist_presentationmodechanged.md) event. ## -remarks Get an instance of this class by handling the [MediaPlaybackTimedMetadataTrackList.PresentationModeChanged](mediaplaybacktimedmetadatatracklist_presentationmodechanged.md) event. ## -examples ## -see-also \ No newline at end of file +--- +-api-id: T:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs + +## -description +Provides data for the [MediaPlaybackTimedMetadataTrackList.PresentationModeChanged](mediaplaybacktimedmetadatatracklist_presentationmodechanged.md) event. + +## -remarks +Get an instance of this class by handling the [MediaPlaybackTimedMetadataTrackList.PresentationModeChanged](mediaplaybacktimedmetadatatracklist_presentationmodechanged.md) event. + +## -examples + +## -see-also diff --git a/windows.media.playback/timedmetadatapresentationmodechangedeventargs_newpresentationmode.md b/windows.media.playback/timedmetadatapresentationmodechangedeventargs_newpresentationmode.md index 9ff8a31904..4ee3daf0f2 100644 --- a/windows.media.playback/timedmetadatapresentationmodechangedeventargs_newpresentationmode.md +++ b/windows.media.playback/timedmetadatapresentationmodechangedeventargs_newpresentationmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.NewPresentationMode --api-type: winrt property ---- # Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.NewPresentationMode ## -description Gets the new presentation mode. ## -property-value The new presentation mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.NewPresentationMode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.NewPresentationMode + +## -description +Gets the new presentation mode. + +## -property-value +The new presentation mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/timedmetadatapresentationmodechangedeventargs_oldpresentationmode.md b/windows.media.playback/timedmetadatapresentationmodechangedeventargs_oldpresentationmode.md index 2574b71348..21c30df183 100644 --- a/windows.media.playback/timedmetadatapresentationmodechangedeventargs_oldpresentationmode.md +++ b/windows.media.playback/timedmetadatapresentationmodechangedeventargs_oldpresentationmode.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.OldPresentationMode --api-type: winrt property ---- # Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.OldPresentationMode ## -description Gets the old presentation mode. ## -property-value The old presentation mode. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.OldPresentationMode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.OldPresentationMode + +## -description +Gets the old presentation mode. + +## -property-value +The old presentation mode. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playback/timedmetadatapresentationmodechangedeventargs_track.md b/windows.media.playback/timedmetadatapresentationmodechangedeventargs_track.md index 7a3fc7be2a..e2b6ec1697 100644 --- a/windows.media.playback/timedmetadatapresentationmodechangedeventargs_track.md +++ b/windows.media.playback/timedmetadatapresentationmodechangedeventargs_track.md @@ -1,3 +1,22 @@ ---- -api-id: P:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.Track --api-type: winrt property ---- # Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.Track ## -description Gets the [TimedMetadataTrack](timedmetadatatrackpresentationmode.md) associated with the presentation mode change. ## -property-value The [TimedMetadataTrack](timedmetadatatrackpresentationmode.md) associated with the presentation mode change. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: P:Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.Track +-api-type: winrt property +--- + + + +# Windows.Media.Playback.TimedMetadataPresentationModeChangedEventArgs.Track + +## -description +Gets the [TimedMetadataTrack](timedmetadatatrackpresentationmode.md) associated with the presentation mode change. + +## -property-value +The [TimedMetadataTrack](timedmetadatatrackpresentationmode.md) associated with the presentation mode change. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playlists/playlist_files.md b/windows.media.playlists/playlist_files.md index 6a48d57970..4c810b4a0d 100644 --- a/windows.media.playlists/playlist_files.md +++ b/windows.media.playlists/playlist_files.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.Playlists.Playlist.Files --api-type: winrt property ---- # Windows.Media.Playlists.Playlist.Files ## -description The set of media files that make up the playlist. ## -property-value The list of media files that make up the playlist. ## -remarks ## -examples ## -see-also [Playlists sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624039) \ No newline at end of file +--- +-api-id: P:Windows.Media.Playlists.Playlist.Files +-api-type: winrt property +--- + + + +# Windows.Media.Playlists.Playlist.Files + +## -description +The set of media files that make up the playlist. + +## -property-value +The list of media files that make up the playlist. + +## -remarks + +## -examples + +## -see-also +[Playlists sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624039) \ No newline at end of file diff --git a/windows.media.playlists/playlist_loadasync_755031318.md b/windows.media.playlists/playlist_loadasync_755031318.md index fb71686224..61865f77d2 100644 --- a/windows.media.playlists/playlist_loadasync_755031318.md +++ b/windows.media.playlists/playlist_loadasync_755031318.md @@ -1,3 +1,27 @@ ---- -api-id: M:Windows.Media.Playlists.Playlist.LoadAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- # Windows.Media.Playlists.Playlist.LoadAsync ## -description Asynchronously loads files into a playlist. ## -parameters ### -param file Represents the files to load. ## -returns Represents the asynchronous operation for loading the playlist. The [GetResults](../windows.foundation/iasyncoperation_1_getresults.md) method of this [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) object returns the playlist. ## -remarks ## -examples ## -see-also [Playlists sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624039) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playlists.Playlist.LoadAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Playlists.Playlist.LoadAsync + +## -description +Asynchronously loads files into a playlist. + +## -parameters +### -param file +Represents the files to load. + +## -returns +Represents the asynchronous operation for loading the playlist. The [GetResults](../windows.foundation/iasyncoperation_1_getresults.md) method of this [IAsyncOperation](../windows.foundation/iasyncoperation_1.md) object returns the playlist. + +## -remarks + +## -examples + +## -see-also +[Playlists sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624039) \ No newline at end of file diff --git a/windows.media.playlists/playlist_playlist_1221375020.md b/windows.media.playlists/playlist_playlist_1221375020.md index 127f624b6e..0b9d94ec70 100644 --- a/windows.media.playlists/playlist_playlist_1221375020.md +++ b/windows.media.playlists/playlist_playlist_1221375020.md @@ -1,3 +1,19 @@ ---- -api-id: M:Windows.Media.Playlists.Playlist.#ctor --api-type: winrt method ---- # Windows.Media.Playlists.Playlist.Playlist ## -description Creates a new instance of a [Playlist](playlist.md) object. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playlists.Playlist.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Playlists.Playlist.Playlist + +## -description +Creates a new instance of a [Playlist](playlist.md) object. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playlists/playlist_saveasasync_166599488.md b/windows.media.playlists/playlist_saveasasync_166599488.md index 06f24fc88b..b8cb72b6dc 100644 --- a/windows.media.playlists/playlist_saveasasync_166599488.md +++ b/windows.media.playlists/playlist_saveasasync_166599488.md @@ -1,3 +1,33 @@ ---- -api-id: M:Windows.Media.Playlists.Playlist.SaveAsAsync(Windows.Storage.IStorageFolder,System.String,Windows.Storage.NameCollisionOption) --api-type: winrt method ---- # Windows.Media.Playlists.Playlist.SaveAsAsync ## -description Asynchronously saves the playlist to a specified file and folder. ## -parameters ### -param saveLocation The folder in which to save the playlist. ### -param desiredName The name of the playlist to save. ### -param option The action to take if the playlist is saved to an existing file. One of the values of the [NameCollisionOption](../windows.storage/namecollisionoption.md) enumeration. ## -returns Represents the asynchronous operation to save the playlist to a specified file and folder. ## -remarks ## -examples ## -see-also [SaveAsAsync(IStorageFolder, String, NameCollisionOption, PlaylistFormat)](playlist_saveasasync_2017527184.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playlists.Playlist.SaveAsAsync(Windows.Storage.IStorageFolder,System.String,Windows.Storage.NameCollisionOption) +-api-type: winrt method +--- + + + +# Windows.Media.Playlists.Playlist.SaveAsAsync + +## -description +Asynchronously saves the playlist to a specified file and folder. + +## -parameters +### -param saveLocation +The folder in which to save the playlist. + +### -param desiredName +The name of the playlist to save. + +### -param option +The action to take if the playlist is saved to an existing file. One of the values of the [NameCollisionOption](../windows.storage/namecollisionoption.md) enumeration. + +## -returns +Represents the asynchronous operation to save the playlist to a specified file and folder. + +## -remarks + +## -examples + +## -see-also +[SaveAsAsync(IStorageFolder, String, NameCollisionOption, PlaylistFormat)](playlist_saveasasync_2017527184.md) \ No newline at end of file diff --git a/windows.media.playlists/playlist_saveasasync_2017527184.md b/windows.media.playlists/playlist_saveasasync_2017527184.md index 4449476a08..1de84795b7 100644 --- a/windows.media.playlists/playlist_saveasasync_2017527184.md +++ b/windows.media.playlists/playlist_saveasasync_2017527184.md @@ -1,3 +1,36 @@ ---- -api-id: M:Windows.Media.Playlists.Playlist.SaveAsAsync(Windows.Storage.IStorageFolder,System.String,Windows.Storage.NameCollisionOption,Windows.Media.Playlists.PlaylistFormat) --api-type: winrt method ---- # Windows.Media.Playlists.Playlist.SaveAsAsync ## -description Asynchronously saves the playlist to a specified file and folder, in a specified format. ## -parameters ### -param saveLocation The folder in which to save the playlist. ### -param desiredName The name of the playlist to save. ### -param option The action to take if the playlist is saved to an existing file. One of the values of the [NameCollisionOption](../windows.storage/namecollisionoption.md) enumeration. ### -param playlistFormat The playlist format. One of the values of the [PlaylistFormat](playlistformat.md) enumeration. ## -returns Represents the asynchronous operation to save the playlist to a specified file and folder. ## -remarks ## -examples ## -see-also [SaveAsAsync(IStorageFolder, String, NameCollisionOption)](playlist_saveasasync_166599488.md) \ No newline at end of file +--- +-api-id: M:Windows.Media.Playlists.Playlist.SaveAsAsync(Windows.Storage.IStorageFolder,System.String,Windows.Storage.NameCollisionOption,Windows.Media.Playlists.PlaylistFormat) +-api-type: winrt method +--- + + + +# Windows.Media.Playlists.Playlist.SaveAsAsync + +## -description +Asynchronously saves the playlist to a specified file and folder, in a specified format. + +## -parameters +### -param saveLocation +The folder in which to save the playlist. + +### -param desiredName +The name of the playlist to save. + +### -param option +The action to take if the playlist is saved to an existing file. One of the values of the [NameCollisionOption](../windows.storage/namecollisionoption.md) enumeration. + +### -param playlistFormat +The playlist format. One of the values of the [PlaylistFormat](playlistformat.md) enumeration. + +## -returns +Represents the asynchronous operation to save the playlist to a specified file and folder. + +## -remarks + +## -examples + +## -see-also +[SaveAsAsync(IStorageFolder, String, NameCollisionOption)](playlist_saveasasync_166599488.md) \ No newline at end of file diff --git a/windows.media.playlists/playlist_saveasync_2143735121.md b/windows.media.playlists/playlist_saveasync_2143735121.md index fa200748ec..92260534ce 100644 --- a/windows.media.playlists/playlist_saveasync_2143735121.md +++ b/windows.media.playlists/playlist_saveasync_2143735121.md @@ -1,3 +1,22 @@ ---- -api-id: M:Windows.Media.Playlists.Playlist.SaveAsync --api-type: winrt method ---- # Windows.Media.Playlists.Playlist.SaveAsync ## -description Asynchronously saves the playlist. ## -returns Represents the asynchronous action to save the playlist. ## -remarks ## -examples ## -see-also \ No newline at end of file +--- +-api-id: M:Windows.Media.Playlists.Playlist.SaveAsync +-api-type: winrt method +--- + + + +# Windows.Media.Playlists.Playlist.SaveAsync + +## -description +Asynchronously saves the playlist. + +## -returns +Represents the asynchronous action to save the playlist. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.media.playto/currenttimechangerequestedeventargs_time.md b/windows.media.playto/currenttimechangerequestedeventargs_time.md index 6fffdd03a1..e3288daa7a 100644 --- a/windows.media.playto/currenttimechangerequestedeventargs_time.md +++ b/windows.media.playto/currenttimechangerequestedeventargs_time.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.PlayTo.CurrentTimeChangeRequestedEventArgs.Time --api-type: winrt property ---- # Windows.Media.PlayTo.CurrentTimeChangeRequestedEventArgs.Time ## -description Gets the new time that the Play To source audio or video stream has been changed to. ## -property-value The new time that the Play To source audio or video has been changed to. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.CurrentTimeChangeRequestedEventArgs.Time +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.CurrentTimeChangeRequestedEventArgs.Time + +## -description +Gets the new time that the Play To source audio or video stream has been changed to. + +## -property-value +The new time that the Play To source audio or video has been changed to. + +## -remarks + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/mutechangerequestedeventargs_mute.md b/windows.media.playto/mutechangerequestedeventargs_mute.md index bc1a48251a..3f0e5e0b5c 100644 --- a/windows.media.playto/mutechangerequestedeventargs_mute.md +++ b/windows.media.playto/mutechangerequestedeventargs_mute.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.PlayTo.MuteChangeRequestedEventArgs.Mute --api-type: winrt property ---- # Windows.Media.PlayTo.MuteChangeRequestedEventArgs.Mute ## -description Gets a value that indicates whether mute or unmute was requested. ## -property-value True if mute was requested; otherwise false. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.MuteChangeRequestedEventArgs.Mute +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.MuteChangeRequestedEventArgs.Mute + +## -description +Gets a value that indicates whether mute or unmute was requested. + +## -property-value +True if mute was requested; otherwise false. + +## -remarks + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playbackratechangerequestedeventargs_rate.md b/windows.media.playto/playbackratechangerequestedeventargs_rate.md index 3be74af34c..2a1f5319e8 100644 --- a/windows.media.playto/playbackratechangerequestedeventargs_rate.md +++ b/windows.media.playto/playbackratechangerequestedeventargs_rate.md @@ -1,3 +1,23 @@ ---- -api-id: P:Windows.Media.PlayTo.PlaybackRateChangeRequestedEventArgs.Rate --api-type: winrt property ---- # Windows.Media.PlayTo.PlaybackRateChangeRequestedEventArgs.Rate ## -description Gets the new playback rate. ## -property-value The new playback rate. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlaybackRateChangeRequestedEventArgs.Rate +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlaybackRateChangeRequestedEventArgs.Rate + +## -description +Gets the new playback rate. + +## -property-value +The new playback rate. + +## -remarks + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnection_error.md b/windows.media.playto/playtoconnection_error.md index 037444e8e0..93637d3aa0 100644 --- a/windows.media.playto/playtoconnection_error.md +++ b/windows.media.playto/playtoconnection_error.md @@ -1,3 +1,20 @@ ---- -api-id: E:Windows.Media.PlayTo.PlayToConnection.Error --api-type: winrt event ---- # Windows.Media.PlayTo.PlayToConnection.Error ## -description Occurs when an error is encountered for the Play To connection. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: E:Windows.Media.PlayTo.PlayToConnection.Error +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToConnection.Error + +## -description +Occurs when an error is encountered for the Play To connection. + +## -remarks + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnection_state.md b/windows.media.playto/playtoconnection_state.md index 9442e79818..7dcacf26dc 100644 --- a/windows.media.playto/playtoconnection_state.md +++ b/windows.media.playto/playtoconnection_state.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnection.State --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnection.State ## -description Gets the state of the Play To connection. ## -property-value The state of the Play To connection. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnection.State +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnection.State + +## -description +Gets the state of the Play To connection. + +## -property-value +The state of the Play To connection. + +## -remarks + + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnection_statechanged.md b/windows.media.playto/playtoconnection_statechanged.md index c66174ad9a..9a7586b81d 100644 --- a/windows.media.playto/playtoconnection_statechanged.md +++ b/windows.media.playto/playtoconnection_statechanged.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.PlayTo.PlayToConnection.StateChanged --api-type: winrt event ---- # Windows.Media.PlayTo.PlayToConnection.StateChanged ## -description Occurs when the state of the Play To connection has changed. ## -remarks ## -examples ## -see-also [PlayToConnectionStateChangedEventArgs](playtoconnectionstatechangedeventargs.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: E:Windows.Media.PlayTo.PlayToConnection.StateChanged +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToConnection.StateChanged + +## -description +Occurs when the state of the Play To connection has changed. + +## -remarks + + +## -examples + +## -see-also +[PlayToConnectionStateChangedEventArgs](playtoconnectionstatechangedeventargs.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnection_transferred.md b/windows.media.playto/playtoconnection_transferred.md index e812ff55b4..0843364266 100644 --- a/windows.media.playto/playtoconnection_transferred.md +++ b/windows.media.playto/playtoconnection_transferred.md @@ -1,3 +1,21 @@ ---- -api-id: E:Windows.Media.PlayTo.PlayToConnection.Transferred --api-type: winrt event ---- # Windows.Media.PlayTo.PlayToConnection.Transferred ## -description Occurs when the Play To connection is transferred to the next Play To source. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: E:Windows.Media.PlayTo.PlayToConnection.Transferred +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToConnection.Transferred + +## -description +Occurs when the Play To connection is transferred to the next Play To source. + +## -remarks + + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnectionerroreventargs_code.md b/windows.media.playto/playtoconnectionerroreventargs_code.md index 856d49d39a..9eb073c3d4 100644 --- a/windows.media.playto/playtoconnectionerroreventargs_code.md +++ b/windows.media.playto/playtoconnectionerroreventargs_code.md @@ -1,3 +1,26 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Code --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Code ## -description Gets the error code for a Play To connection error. ## -property-value The error code for a Play To connection error. ## -remarks In Windows 8Windows Store app, [Code](playtoconnectionerroreventargs_code.md) is always set to **DeviceError**. In Windows 8.1Windows Store app, [Code](playtoconnectionerroreventargs_code.md) is set to either **DeviceError** or **ProtectedPlaybackFailed**. This enables the app to determine if the failure is related to the media-protection status of the content. The app can continue playing the next item in the playlist or to stop. Apps can also use this new [Code](playtoconnectionerroreventargs_code.md) value to remove all protected music from the playlist. ## -examples ## -see-also [PlayToConnection.Error event](playtoconnection_error.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Code +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Code + +## -description +Gets the error code for a Play To connection error. + +## -property-value +The error code for a Play To connection error. + +## -remarks +In Windows 8Windows Store app, [Code](playtoconnectionerroreventargs_code.md) is always set to **DeviceError**. + +In Windows 8.1Windows Store app, [Code](playtoconnectionerroreventargs_code.md) is set to either **DeviceError** or **ProtectedPlaybackFailed**. This enables the app to determine if the failure is related to the media-protection status of the content. The app can continue playing the next item in the playlist or to stop. Apps can also use this new [Code](playtoconnectionerroreventargs_code.md) value to remove all protected music from the playlist. + +## -examples + +## -see-also +[PlayToConnection.Error event](playtoconnection_error.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnectionerroreventargs_message.md b/windows.media.playto/playtoconnectionerroreventargs_message.md index 79ce055eca..1858546ef2 100644 --- a/windows.media.playto/playtoconnectionerroreventargs_message.md +++ b/windows.media.playto/playtoconnectionerroreventargs_message.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Message --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Message ## -description Gets the error message for a Play To connection error. ## -property-value The error message for a Play To connection error. ## -remarks ## -examples ## -see-also [PlayToConnection.Error event](playtoconnection_error.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Message +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnectionErrorEventArgs.Message + +## -description +Gets the error message for a Play To connection error. + +## -property-value +The error message for a Play To connection error. + +## -remarks + + +## -examples + +## -see-also +[PlayToConnection.Error event](playtoconnection_error.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnectionstatechangedeventargs_currentstate.md b/windows.media.playto/playtoconnectionstatechangedeventargs_currentstate.md index 32de20b898..3400c47e35 100644 --- a/windows.media.playto/playtoconnectionstatechangedeventargs_currentstate.md +++ b/windows.media.playto/playtoconnectionstatechangedeventargs_currentstate.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.CurrentState --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.CurrentState ## -description Gets the current state after the Play To connection state has changed. ## -property-value The current state after the Play To connection state has changed. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.CurrentState +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.CurrentState + +## -description +Gets the current state after the Play To connection state has changed. + +## -property-value +The current state after the Play To connection state has changed. + +## -remarks + + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnectionstatechangedeventargs_previousstate.md b/windows.media.playto/playtoconnectionstatechangedeventargs_previousstate.md index 02d129eb64..f19407d701 100644 --- a/windows.media.playto/playtoconnectionstatechangedeventargs_previousstate.md +++ b/windows.media.playto/playtoconnectionstatechangedeventargs_previousstate.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.PreviousState --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.PreviousState ## -description Gets the previous state before the Play To connection state was changed. ## -property-value The previous state before the Play To connection state was changed. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.PreviousState +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnectionStateChangedEventArgs.PreviousState + +## -description +Gets the previous state before the Play To connection state was changed. + +## -property-value +The previous state before the Play To connection state was changed. + +## -remarks + + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnectiontransferredeventargs_currentsource.md b/windows.media.playto/playtoconnectiontransferredeventargs_currentsource.md index 62819754f3..d26e25dbd4 100644 --- a/windows.media.playto/playtoconnectiontransferredeventargs_currentsource.md +++ b/windows.media.playto/playtoconnectiontransferredeventargs_currentsource.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.CurrentSource --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.CurrentSource ## -description Gets the current Play To source that a connection was transferred to. ## -property-value The current Play To source that a connection was transferred to. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.CurrentSource +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.CurrentSource + +## -description +Gets the current Play To source that a connection was transferred to. + +## -property-value +The current Play To source that a connection was transferred to. + +## -remarks + + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtoconnectiontransferredeventargs_previoussource.md b/windows.media.playto/playtoconnectiontransferredeventargs_previoussource.md index 32acb5a0d3..bb0d90325d 100644 --- a/windows.media.playto/playtoconnectiontransferredeventargs_previoussource.md +++ b/windows.media.playto/playtoconnectiontransferredeventargs_previoussource.md @@ -1,3 +1,24 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.PreviousSource --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.PreviousSource ## -description Gets the previous Play To source that a connection was transferred from. ## -property-value The previous Play To source that a connection was transferred from. ## -remarks ## -examples ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file +--- +-api-id: P:Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.PreviousSource +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToConnectionTransferredEventArgs.PreviousSource + +## -description +Gets the previous Play To source that a connection was transferred from. + +## -property-value +The previous Play To source that a connection was transferred from. + +## -remarks + + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) \ No newline at end of file diff --git a/windows.media.playto/playtomanager_defaultsourceselection.md b/windows.media.playto/playtomanager_defaultsourceselection.md index 4e94daefe3..69056394b2 100644 --- a/windows.media.playto/playtomanager_defaultsourceselection.md +++ b/windows.media.playto/playtomanager_defaultsourceselection.md @@ -1,3 +1,40 @@ ---- -api-id: P:Windows.Media.PlayTo.PlayToManager.DefaultSourceSelection --api-type: winrt property ---- # Windows.Media.PlayTo.PlayToManager.DefaultSourceSelection ## -description Enables or disables the default source selection for Play To. ## -property-value True to enable default source selection; otherwise false. The default is true. ## -remarks An app that contains media elements has Play To enabled by default. If a user invokes the **Devices** charm while running the app and selects a target device to stream media to, Play To will stream the media from the first audio, video, or image element on the current page. You can disable this default behavior by setting the **DefaultSourceSelection** property to **false**.```javascript var ptm = Windows.Media.PlayTo.PlayToManager.getForCurrentView(); ptm.defaultSourceSelection = false; ``` You can exclude individual HTML elements from the default Play To behavior by adding the **-ms-playToDisabled** attribute in your HTML markup.```javascript